From c126367f6ef11d5862b2d74513a48003e77daece Mon Sep 17 00:00:00 2001 From: "docsreference@microsoft.com" Date: Wed, 2 Apr 2025 06:28:31 +0000 Subject: [PATCH 1/2] CI Update Build.Reason:Manual by Sai Cai (BEYONDSOFT CONSULTING INC) Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=516736&view=results --- docs-ref-mapping/reference-previous.yml | 275 + ...sor.MetricsAdvisorAdministrationClient.yml | 1577 + ...ai.metricsadvisor.MetricsAdvisorClient.yml | 690 + ...icsadvisor.MetricsAdvisorKeyCredential.yml | 55 + ...aio.MetricsAdvisorAdministrationClient.yml | 1636 + ...etricsadvisor.aio.MetricsAdvisorClient.yml | 711 + .../azure.ai.metricsadvisor.aio.yml | 8 + ...tricsadvisor.models.AlertQueryTimeMode.yml | 13 + ....ai.metricsadvisor.models.AnomalyAlert.yml | 130 + ...visor.models.AnomalyAlertConfiguration.yml | 155 + ...r.models.AnomalyDetectionConfiguration.yml | 150 + ...dvisor.models.AnomalyDetectorDirection.yml | 13 + ....metricsadvisor.models.AnomalyFeedback.yml | 148 + ....metricsadvisor.models.AnomalyIncident.yml | 187 + ...csadvisor.models.AnomalyIncidentStatus.yml | 14 + ....metricsadvisor.models.AnomalySeverity.yml | 13 + ....ai.metricsadvisor.models.AnomalyValue.yml | 13 + ...AzureApplicationInsightsDataFeedSource.yml | 232 + ...advisor.models.AzureBlobDataFeedSource.yml | 233 + ...sor.models.AzureCosmosDbDataFeedSource.yml | 235 + ...models.AzureDataExplorerDataFeedSource.yml | 236 + ...AzureDataLakeStorageGen2DataFeedSource.yml | 255 + ...or.models.AzureEventHubsDataFeedSource.yml | 224 + ...models.AzureLogAnalyticsDataFeedSource.yml | 254 + ...dvisor.models.AzureTableDataFeedSource.yml | 229 + ...ricsadvisor.models.ChangePointFeedback.yml | 141 + ...metricsadvisor.models.ChangePointValue.yml | 13 + ...dvisor.models.ChangeThresholdCondition.yml | 151 + ....metricsadvisor.models.CommentFeedback.yml | 138 + ...zure.ai.metricsadvisor.models.DataFeed.yml | 229 + ...tricsadvisor.models.DataFeedAccessMode.yml | 11 + ...dvisor.models.DataFeedAutoRollupMethod.yml | 19 + ...etricsadvisor.models.DataFeedDimension.yml | 125 + ...ricsadvisor.models.DataFeedGranularity.yml | 23 + ...advisor.models.DataFeedGranularityType.yml | 21 + ...visor.models.DataFeedIngestionProgress.yml | 127 + ...visor.models.DataFeedIngestionSettings.yml | 37 + ...advisor.models.DataFeedIngestionStatus.yml | 130 + ...i.metricsadvisor.models.DataFeedMetric.yml | 134 + ...s.DataFeedMissingDataPointFillSettings.yml | 25 + ...sadvisor.models.DataFeedRollupSettings.yml | 31 + ...tricsadvisor.models.DataFeedRollupType.yml | 13 + ...i.metricsadvisor.models.DataFeedSchema.yml | 26 + ...i.metricsadvisor.models.DataFeedSource.yml | 123 + ...i.metricsadvisor.models.DataFeedStatus.yml | 11 + ...metricsadvisor.models.DataPointAnomaly.yml | 170 + ...or.models.DatasourceAuthenticationType.yml | 19 + ...icsadvisor.models.DatasourceCredential.yml | 108 + ...dvisor.models.DatasourceCredentialType.yml | 15 + ...models.DatasourceDataLakeGen2SharedKey.yml | 218 + ...els.DatasourceMissingDataPointFillType.yml | 15 + ...isor.models.DatasourceServicePrincipal.yml | 228 + ...s.DatasourceServicePrincipalInKeyVault.yml | 242 + ...r.models.DatasourceSqlConnectionString.yml | 218 + ...i.metricsadvisor.models.DatasourceType.yml | 33 + ...models.DetectionAnomalyFilterCondition.yml | 130 + ...isor.models.DetectionConditionOperator.yml | 14 + ...odels.DetectionIncidentFilterCondition.yml | 125 + ...sadvisor.models.DimensionGroupIdentity.yml | 127 + ...csadvisor.models.EmailNotificationHook.yml | 148 + ...metricsadvisor.models.EnrichmentStatus.yml | 130 + ...csadvisor.models.FeedbackQueryTimeMode.yml | 11 + ....ai.metricsadvisor.models.FeedbackType.yml | 15 + ...sadvisor.models.HardThresholdCondition.yml | 142 + ...etricsadvisor.models.IncidentRootCause.yml | 134 + ...sadvisor.models.InfluxDbDataFeedSource.yml | 236 + ...dvisor.models.MetricAlertConfiguration.yml | 137 + ...or.models.MetricAnomalyAlertConditions.yml | 14 + ...tricAnomalyAlertConfigurationsOperator.yml | 16 + ...advisor.models.MetricAnomalyAlertScope.yml | 25 + ...sor.models.MetricAnomalyAlertScopeType.yml | 13 + ...dels.MetricAnomalyAlertSnoozeCondition.yml | 132 + ...advisor.models.MetricBoundaryCondition.yml | 144 + ...dvisor.models.MetricDetectionCondition.yml | 148 + ...dvisor.models.MetricEnrichedSeriesData.yml | 197 + ...i.metricsadvisor.models.MetricFeedback.yml | 135 + ...metricsadvisor.models.MetricSeriesData.yml | 136 + ...sadvisor.models.MetricSeriesDefinition.yml | 126 + ...ls.MetricSeriesGroupDetectionCondition.yml | 141 + ...s.MetricSingleSeriesDetectionCondition.yml | 141 + ...csadvisor.models.MongoDbDataFeedSource.yml | 228 + ...ricsadvisor.models.MySqlDataFeedSource.yml | 224 + ...metricsadvisor.models.NotificationHook.yml | 143 + ...i.metricsadvisor.models.PeriodFeedback.yml | 133 + ...re.ai.metricsadvisor.models.PeriodType.yml | 11 + ...dvisor.models.PostgreSqlDataFeedSource.yml | 224 + ...i.metricsadvisor.models.SeriesIdentity.yml | 124 + ...etricsadvisor.models.SeverityCondition.yml | 132 + ...advisor.models.SeverityFilterCondition.yml | 140 + ...advisor.models.SmartDetectionCondition.yml | 135 + ...e.ai.metricsadvisor.models.SnoozeScope.yml | 11 + ...advisor.models.SqlServerDataFeedSource.yml | 240 + ...etricsadvisor.models.SuppressCondition.yml | 125 + ...i.metricsadvisor.models.TopNGroupScope.yml | 132 + ...ricsadvisor.models.WebNotificationHook.yml | 166 + .../azure.ai.metricsadvisor.models.yml | 95 + .../azure.ai.metricsadvisor.yml | 12 + .../azure.ai.vision.ConsoleLogger.yml | 23 + .../azure.ai.vision.FileLogger.yml | 26 + .../azure-ai-vision/azure.ai.vision.Frame.yml | 23 + .../azure.ai.vision.FrameFormat.yml | 45 + .../azure.ai.vision.FrameSource.yml | 29 + .../azure.ai.vision.FrameSourceCallback.yml | 21 + .../azure.ai.vision.FrameWriter.yml | 29 + ...re.ai.vision.ImageAnalysisErrorDetails.yml | 42 + ...azure.ai.vision.ImageAnalysisEventArgs.yml | 16 + .../azure.ai.vision.ImageAnalysisOptions.yml | 65 + .../azure.ai.vision.ImageAnalysisResult.yml | 157 + ...e.ai.vision.ImageAnalysisResultDetails.yml | 48 + .../azure.ai.vision.ImageAnalyzer.yml | 46 + .../azure.ai.vision.ImageSourceBuffer.yml | 35 + ...re.ai.vision.ImageSourceBufferCallback.yml | 21 + .../azure.ai.vision.ImageWriter.yml | 38 + .../azure.ai.vision.MemoryLogger.yml | 29 + .../azure.ai.vision.VisionServiceOptions.yml | 30 + .../azure.ai.vision.VisionSource.yml | 31 + .../azure.ai.vision.diagnostics_logging.yml | 8 + ....vision.enums.ImageAnalysisErrorReason.yml | 26 + ...e.ai.vision.enums.ImageAnalysisFeature.yml | 21 + ...vision.enums.ImageAnalysisResultReason.yml | 11 + ....ai.vision.enums.ImageSegmentationMode.yml | 13 + ...re.ai.vision.enums.SessionResultReason.yml | 21 + ...vision.enums.SessionStoppedErrorReason.yml | 27 + ...e.ai.vision.enums.SessionStoppedReason.yml | 15 + .../azure.ai.vision.enums.VisionOption.yml | 6 + .../azure-ai-vision/azure.ai.vision.enums.yml | 13 + .../azure.ai.vision.image_analysis_client.yml | 5 + ...ion.image_analysis_data.ContentCaption.yml | 43 + ....vision.image_analysis_data.ContentTag.yml | 29 + ...vision.image_analysis_data.ContentTags.yml | 107 + ...ion.image_analysis_data.CropSuggestion.yml | 37 + ...on.image_analysis_data.CropSuggestions.yml | 108 + ...sion.image_analysis_data.DenseCaptions.yml | 112 + ...ion.image_analysis_data.DetectedObject.yml | 35 + ...on.image_analysis_data.DetectedObjects.yml | 107 + ...ion.image_analysis_data.DetectedPeople.yml | 107 + ...ion.image_analysis_data.DetectedPerson.yml | 29 + ...ision.image_analysis_data.DetectedText.yml | 16 + ...n.image_analysis_data.DetectedTextLine.yml | 35 + ...n.image_analysis_data.DetectedTextWord.yml | 46 + ...i.vision.image_analysis_data.Rectangle.yml | 34 + ...image_analysis_data.SegmentationResult.yml | 28 + .../azure.ai.vision.image_analysis_data.yml | 21 + .../azure.ai.vision.interop.yml | 4 + ...i.vision.properties.PropertyCollection.yml | 88 + .../azure.ai.vision.properties.yml | 6 + .../azure.ai.vision.version.yml | 4 + ....vision.vision_base_client.EventSignal.yml | 43 + ...on_base_client.SessionStartedEventArgs.yml | 18 + ...on_base_client.SessionStoppedEventArgs.yml | 21 + ...se_client.VisionServiceAdvancedOptions.yml | 12 + ...ision.vision_base_client.VisionSession.yml | 29 + ...ision_base_client.VisionSessionOptions.yml | 15 + .../azure.ai.vision.vision_base_client.yml | 12 + .../azure-ai-vision/azure.ai.vision.yml | 35 + ...insights.ApplicationInsightsDataClient.yml | 43 + ...a_client.ApplicationInsightsDataClient.yml | 43 + ...icationInsightsDataClientConfiguration.yml | 60 + ...ights.application_insights_data_client.yml | 7 + ...plicationinsights.models.Column(class).yml | 133 + ...applicationinsights.models.ErrorDetail.yml | 167 + ...e.applicationinsights.models.ErrorInfo.yml | 154 + ...plicationinsights.models.ErrorResponse.yml | 129 + ...insights.models.ErrorResponseException.yml | 28 + ...e.applicationinsights.models.EventType.yml | 28 + ...pplicationinsights.models.EventsAiInfo.yml | 145 + ...ninsights.models.EventsApplicationInfo.yml | 123 + ...ts.models.EventsAvailabilityResultInfo.yml | 176 + ....models.EventsAvailabilityResultResult.yml | 217 + ...nsights.models.EventsBrowserTimingInfo.yml | 189 + ...ights.models.EventsBrowserTimingResult.yml | 223 + ...cationinsights.models.EventsClientInfo.yml | 174 + ...hts.models.EventsClientPerformanceInfo.yml | 123 + ...icationinsights.models.EventsCloudInfo.yml | 130 + ...ninsights.models.EventsCustomEventInfo.yml | 123 + ...nsights.models.EventsCustomEventResult.yml | 217 + ...insights.models.EventsCustomMetricInfo.yml | 167 + ...sights.models.EventsCustomMetricResult.yml | 217 + ...oninsights.models.EventsDependencyInfo.yml | 181 + ...insights.models.EventsDependencyResult.yml | 217 + ...ninsights.models.EventsExceptionDetail.yml | 159 + ...dels.EventsExceptionDetailsParsedStack.yml | 145 + ...ioninsights.models.EventsExceptionInfo.yml | 233 + ...ninsights.models.EventsExceptionResult.yml | 217 + ...ioninsights.models.EventsOperationInfo.yml | 145 + ...tioninsights.models.EventsPageViewInfo.yml | 145 + ...oninsights.models.EventsPageViewResult.yml | 217 + ...ts.models.EventsPerformanceCounterInfo.yml | 160 + ....models.EventsPerformanceCounterResult.yml | 217 + ...ationinsights.models.EventsRequestInfo.yml | 174 + ...ioninsights.models.EventsRequestResult.yml | 216 + ...pplicationinsights.models.EventsResult.yml | 129 + ...cationinsights.models.EventsResultData.yml | 223 + ...odels.EventsResultDataCustomDimensions.yml | 122 + ...els.EventsResultDataCustomMeasurements.yml | 122 + ...plicationinsights.models.EventsResults.yml | 138 + ...ationinsights.models.EventsSessionInfo.yml | 123 + ...icationinsights.models.EventsTraceInfo.yml | 130 + ...ationinsights.models.EventsTraceResult.yml | 216 + ...licationinsights.models.EventsUserInfo.yml | 138 + ...re.applicationinsights.models.MetricId.yml | 70 + ...tioninsights.models.MetricsAggregation.yml | 18 + ...ninsights.models.MetricsPostBodySchema.yml | 137 + ...models.MetricsPostBodySchemaParameters.yml | 209 + ...plicationinsights.models.MetricsResult.yml | 122 + ...ationinsights.models.MetricsResultInfo.yml | 154 + ...tioninsights.models.MetricsResultsItem.yml | 140 + ...licationinsights.models.MetricsSegment.yml | 38 + ...tioninsights.models.MetricsSegmentInfo.yml | 151 + ...e.applicationinsights.models.QueryBody.yml | 148 + ...pplicationinsights.models.QueryResults.yml | 129 + ...pplicationinsights.models.Table(class).yml | 143 + ...n_insights_data_client_enums.EventType.yml | 28 + ...on_insights_data_client_enums.MetricId.yml | 70 + ...s_data_client_enums.MetricsAggregation.yml | 18 + ...ights_data_client_enums.MetricsSegment.yml | 38 + ...application_insights_data_client_enums.yml | 9 + ...plicationinsights.models.column.Column.yml | 128 + ...zure.applicationinsights.models.column.yml | 6 + ...ationinsights.models.column_py3.Column.yml | 133 + ....applicationinsights.models.column_py3.yml | 6 + ...sights.models.error_detail.ErrorDetail.yml | 153 + ...pplicationinsights.models.error_detail.yml | 6 + ...ts.models.error_detail_py3.ErrorDetail.yml | 167 + ...cationinsights.models.error_detail_py3.yml | 6 + ...oninsights.models.error_info.ErrorInfo.yml | 142 + ....applicationinsights.models.error_info.yml | 6 + ...sights.models.error_info_py3.ErrorInfo.yml | 154 + ...licationinsights.models.error_info_py3.yml | 6 + ...ts.models.error_response.ErrorResponse.yml | 126 + ....error_response.ErrorResponseException.yml | 28 + ...licationinsights.models.error_response.yml | 7 + ...odels.error_response_py3.ErrorResponse.yml | 129 + ...or_response_py3.ErrorResponseException.yml | 28 + ...tioninsights.models.error_response_py3.yml | 7 + ...hts.models.events_ai_info.EventsAiInfo.yml | 135 + ...licationinsights.models.events_ai_info.yml | 6 + ...models.events_ai_info_py3.EventsAiInfo.yml | 145 + ...tioninsights.models.events_ai_info_py3.yml | 6 + ...application_info.EventsApplicationInfo.yml | 120 + ...nsights.models.events_application_info.yml | 6 + ...ication_info_py3.EventsApplicationInfo.yml | 123 + ...hts.models.events_application_info_py3.yml | 6 + ...sult_info.EventsAvailabilityResultInfo.yml | 157 + ...models.events_availability_result_info.yml | 6 + ..._info_py3.EventsAvailabilityResultInfo.yml | 176 + ...ls.events_availability_result_info_py3.yml | 6 + ..._result.EventsAvailabilityResultResult.yml | 187 + ...dels.events_availability_result_result.yml | 6 + ...ult_py3.EventsAvailabilityResultResult.yml | 217 + ....events_availability_result_result_py3.yml | 6 + ...er_timing_info.EventsBrowserTimingInfo.yml | 165 + ...ghts.models.events_browser_timing_info.yml | 6 + ...iming_info_py3.EventsBrowserTimingInfo.yml | 189 + ....models.events_browser_timing_info_py3.yml | 6 + ...iming_result.EventsBrowserTimingResult.yml | 191 + ...ts.models.events_browser_timing_result.yml | 6 + ...g_result_py3.EventsBrowserTimingResult.yml | 223 + ...odels.events_browser_timing_result_py3.yml | 6 + ...ls.events_client_info.EventsClientInfo.yml | 155 + ...tioninsights.models.events_client_info.yml | 6 + ...vents_client_info_py3.EventsClientInfo.yml | 174 + ...insights.models.events_client_info_py3.yml | 6 + ...mance_info.EventsClientPerformanceInfo.yml | 120 + ....models.events_client_performance_info.yml | 6 + ...e_info_py3.EventsClientPerformanceInfo.yml | 123 + ...els.events_client_performance_info_py3.yml | 6 + ...dels.events_cloud_info.EventsCloudInfo.yml | 125 + ...ationinsights.models.events_cloud_info.yml | 6 + ....events_cloud_info_py3.EventsCloudInfo.yml | 130 + ...ninsights.models.events_cloud_info_py3.yml | 6 + ...ustom_event_info.EventsCustomEventInfo.yml | 120 + ...sights.models.events_custom_event_info.yml | 6 + ...m_event_info_py3.EventsCustomEventInfo.yml | 123 + ...ts.models.events_custom_event_info_py3.yml | 6 + ...m_event_result.EventsCustomEventResult.yml | 187 + ...ghts.models.events_custom_event_result.yml | 6 + ...ent_result_py3.EventsCustomEventResult.yml | 217 + ....models.events_custom_event_result_py3.yml | 6 + ...tom_metric_info.EventsCustomMetricInfo.yml | 150 + ...ights.models.events_custom_metric_info.yml | 6 + ...metric_info_py3.EventsCustomMetricInfo.yml | 167 + ...s.models.events_custom_metric_info_py3.yml | 6 + ...metric_result.EventsCustomMetricResult.yml | 187 + ...hts.models.events_custom_metric_result.yml | 6 + ...ic_result_py3.EventsCustomMetricResult.yml | 217 + ...models.events_custom_metric_result_py3.yml | 6 + ...s_dependency_info.EventsDependencyInfo.yml | 160 + ...insights.models.events_dependency_info.yml | 6 + ...pendency_info_py3.EventsDependencyInfo.yml | 181 + ...ghts.models.events_dependency_info_py3.yml | 6 + ...pendency_result.EventsDependencyResult.yml | 187 + ...sights.models.events_dependency_result.yml | 6 + ...ency_result_py3.EventsDependencyResult.yml | 217 + ...ts.models.events_dependency_result_py3.yml | 6 + ...exception_detail.EventsExceptionDetail.yml | 145 + ...nsights.models.events_exception_detail.yml | 6 + ...ption_detail_py3.EventsExceptionDetail.yml | 159 + ...hts.models.events_exception_detail_py3.yml | 6 + ...tack.EventsExceptionDetailsParsedStack.yml | 135 + ....events_exception_details_parsed_stack.yml | 6 + ..._py3.EventsExceptionDetailsParsedStack.yml | 145 + ...nts_exception_details_parsed_stack_py3.yml | 6 + ...nts_exception_info.EventsExceptionInfo.yml | 195 + ...ninsights.models.events_exception_info.yml | 6 + ...exception_info_py3.EventsExceptionInfo.yml | 233 + ...ights.models.events_exception_info_py3.yml | 6 + ...exception_result.EventsExceptionResult.yml | 187 + ...nsights.models.events_exception_result.yml | 6 + ...ption_result_py3.EventsExceptionResult.yml | 217 + ...hts.models.events_exception_result_py3.yml | 6 + ...nts_operation_info.EventsOperationInfo.yml | 135 + ...ninsights.models.events_operation_info.yml | 6 + ...operation_info_py3.EventsOperationInfo.yml | 145 + ...ights.models.events_operation_info_py3.yml | 6 + ...ents_page_view_info.EventsPageViewInfo.yml | 135 + ...ninsights.models.events_page_view_info.yml | 6 + ..._page_view_info_py3.EventsPageViewInfo.yml | 145 + ...ights.models.events_page_view_info_py3.yml | 6 + ..._page_view_result.EventsPageViewResult.yml | 187 + ...nsights.models.events_page_view_result.yml | 6 + ...e_view_result_py3.EventsPageViewResult.yml | 217 + ...hts.models.events_page_view_result_py3.yml | 6 + ...nter_info.EventsPerformanceCounterInfo.yml | 145 + ...models.events_performance_counter_info.yml | 6 + ..._info_py3.EventsPerformanceCounterInfo.yml | 160 + ...ls.events_performance_counter_info_py3.yml | 6 + ..._result.EventsPerformanceCounterResult.yml | 187 + ...dels.events_performance_counter_result.yml | 6 + ...ult_py3.EventsPerformanceCounterResult.yml | 217 + ....events_performance_counter_result_py3.yml | 6 + ....events_request_info.EventsRequestInfo.yml | 155 + ...ioninsights.models.events_request_info.yml | 6 + ...nts_request_info_py3.EventsRequestInfo.yml | 174 + ...nsights.models.events_request_info_py3.yml | 6 + ...nts_request_result.EventsRequestResult.yml | 187 + ...ninsights.models.events_request_result.yml | 6 + ...request_result_py3.EventsRequestResult.yml | 216 + ...ights.models.events_request_result_py3.yml | 6 + ...ghts.models.events_result.EventsResult.yml | 124 + ...plicationinsights.models.events_result.yml | 6 + ...ls.events_result_data.EventsResultData.yml | 196 + ...tioninsights.models.events_result_data.yml | 6 + ...sions.EventsResultDataCustomDimensions.yml | 119 + ...s.events_result_data_custom_dimensions.yml | 6 + ...s_py3.EventsResultDataCustomDimensions.yml | 122 + ...ents_result_data_custom_dimensions_py3.yml | 6 + ...nts.EventsResultDataCustomMeasurements.yml | 119 + ...events_result_data_custom_measurements.yml | 6 + ...py3.EventsResultDataCustomMeasurements.yml | 122 + ...ts_result_data_custom_measurements_py3.yml | 6 + ...vents_result_data_py3.EventsResultData.yml | 223 + ...insights.models.events_result_data_py3.yml | 6 + ....models.events_result_py3.EventsResult.yml | 129 + ...ationinsights.models.events_result_py3.yml | 6 + ...ts.models.events_results.EventsResults.yml | 130 + ...licationinsights.models.events_results.yml | 6 + ...odels.events_results_py3.EventsResults.yml | 138 + ...tioninsights.models.events_results_py3.yml | 6 + ....events_session_info.EventsSessionInfo.yml | 120 + ...ioninsights.models.events_session_info.yml | 6 + ...nts_session_info_py3.EventsSessionInfo.yml | 123 + ...nsights.models.events_session_info_py3.yml | 6 + ...dels.events_trace_info.EventsTraceInfo.yml | 125 + ...ationinsights.models.events_trace_info.yml | 6 + ....events_trace_info_py3.EventsTraceInfo.yml | 130 + ...ninsights.models.events_trace_info_py3.yml | 6 + ....events_trace_result.EventsTraceResult.yml | 187 + ...ioninsights.models.events_trace_result.yml | 6 + ...nts_trace_result_py3.EventsTraceResult.yml | 216 + ...nsights.models.events_trace_result_py3.yml | 6 + ...models.events_user_info.EventsUserInfo.yml | 130 + ...cationinsights.models.events_user_info.yml | 6 + ...ls.events_user_info_py3.EventsUserInfo.yml | 138 + ...oninsights.models.events_user_info_py3.yml | 6 + ...post_body_schema.MetricsPostBodySchema.yml | 132 + ...sights.models.metrics_post_body_schema.yml | 6 + ...meters.MetricsPostBodySchemaParameters.yml | 190 + ...ls.metrics_post_body_schema_parameters.yml | 6 + ...rs_py3.MetricsPostBodySchemaParameters.yml | 209 + ...etrics_post_body_schema_parameters_py3.yml | 6 + ..._body_schema_py3.MetricsPostBodySchema.yml | 137 + ...ts.models.metrics_post_body_schema_py3.yml | 6 + ...ts.models.metrics_result.MetricsResult.yml | 119 + ...licationinsights.models.metrics_result.yml | 6 + ....metrics_result_info.MetricsResultInfo.yml | 142 + ...ioninsights.models.metrics_result_info.yml | 6 + ...rics_result_info_py3.MetricsResultInfo.yml | 154 + ...nsights.models.metrics_result_info_py3.yml | 6 + ...odels.metrics_result_py3.MetricsResult.yml | 122 + ...tioninsights.models.metrics_result_py3.yml | 6 + ...etrics_results_item.MetricsResultsItem.yml | 133 + ...oninsights.models.metrics_results_item.yml | 6 + ...cs_results_item_py3.MetricsResultsItem.yml | 140 + ...sights.models.metrics_results_item_py3.yml | 6 + ...etrics_segment_info.MetricsSegmentInfo.yml | 141 + ...oninsights.models.metrics_segment_info.yml | 6 + ...cs_segment_info_py3.MetricsSegmentInfo.yml | 151 + ...sights.models.metrics_segment_info_py3.yml | 6 + ...oninsights.models.query_body.QueryBody.yml | 141 + ....applicationinsights.models.query_body.yml | 6 + ...sights.models.query_body_py3.QueryBody.yml | 148 + ...licationinsights.models.query_body_py3.yml | 6 + ...ghts.models.query_results.QueryResults.yml | 126 + ...plicationinsights.models.query_results.yml | 6 + ....models.query_results_py3.QueryResults.yml | 129 + ...ationinsights.models.query_results_py3.yml | 6 + ...applicationinsights.models.table.Table.yml | 136 + ...azure.applicationinsights.models.table.yml | 6 + ...icationinsights.models.table_py3.Table.yml | 143 + ...e.applicationinsights.models.table_py3.yml | 6 + .../azure.applicationinsights.models.yml | 158 + ...oninsights.operations.EventsOperations.yml | 258 + ...ninsights.operations.MetricsOperations.yml | 277 + ...ioninsights.operations.QueryOperations.yml | 77 + ...ons.events_operations.EventsOperations.yml | 258 + ...ninsights.operations.events_operations.yml | 6 + ...s.metrics_operations.MetricsOperations.yml | 277 + ...insights.operations.metrics_operations.yml | 6 + ...tions.query_operations.QueryOperations.yml | 77 + ...oninsights.operations.query_operations.yml | 6 + .../azure.applicationinsights.operations.yml | 13 + .../azure.applicationinsights.version.yml | 4 + .../azure.applicationinsights.yml | 13 + ....anomalydetector.AnomalyDetectorClient.yml | 176 + ...tor.AnomalyDetectorClientConfiguration.yml | 62 + ...rvices.anomalydetector.models.APIError.yml | 130 + ...omalydetector.models.APIErrorException.yml | 28 + ...tector.models.ChangePointDetectRequest.yml | 188 + ...ector.models.ChangePointDetectResponse.yml | 151 + ...lydetector.models.EntireDetectResponse.yml | 213 + ...ces.anomalydetector.models.Granularity.yml | 20 + ...malydetector.models.LastDetectResponse.yml | 207 + ...eservices.anomalydetector.models.Point.yml | 133 + ...ervices.anomalydetector.models.Request.yml | 185 + ...gnitiveservices.anomalydetector.models.yml | 16 + ...s.AnomalyDetectorClientOperationsMixin.yml | 137 + ...iveservices.anomalydetector.operations.yml | 7 + ...nitiveservices.anomalydetector.version.yml | 4 + ...zure.cognitiveservices.anomalydetector.yml | 13 + ...ices.knowledge.qnamaker.QnAMakerClient.yml | 53 + ...maker.models.ActiveLearningSettingsDTO.yml | 123 + ...owledge.qnamaker.models.AlterationsDTO.yml | 126 + ...e.qnamaker.models.AnswerSpanRequestDTO.yml | 142 + ....qnamaker.models.AnswerSpanResponseDTO.yml | 145 + ...s.knowledge.qnamaker.models.ContextDTO.yml | 138 + ....knowledge.qnamaker.models.CreateKbDTO.yml | 206 + ...ledge.qnamaker.models.CreateKbInputDTO.yml | 139 + ...ge.qnamaker.models.DeleteKbContentsDTO.yml | 130 + ...wledge.qnamaker.models.EndpointKeysDTO.yml | 153 + ...ge.qnamaker.models.EndpointSettingsDTO.yml | 123 + ...dels.EndpointSettingsDTOActiveLearning.yml | 123 + ...wledge.qnamaker.models.EnvironmentType.yml | 10 + ...knowledge.qnamaker.models.Error(class).yml | 172 + ...nowledge.qnamaker.models.ErrorCodeType.yml | 34 + ...nowledge.qnamaker.models.ErrorResponse.yml | 125 + ...dge.qnamaker.models.ErrorResponseError.yml | 170 + ...qnamaker.models.ErrorResponseException.yml | 28 + ...edge.qnamaker.models.FeedbackRecordDTO.yml | 140 + ...dge.qnamaker.models.FeedbackRecordsDTO.yml | 123 + ...ices.knowledge.qnamaker.models.FileDTO.yml | 135 + ...wledge.qnamaker.models.InnerErrorModel.yml | 138 + ...ledge.qnamaker.models.KnowledgebaseDTO.yml | 191 + ...edge.qnamaker.models.KnowledgebasesDTO.yml | 123 + ....knowledge.qnamaker.models.MetadataDTO.yml | 133 + ...ledge.qnamaker.models.Operation(class).yml | 174 + ...dge.qnamaker.models.OperationStateType.yml | 14 + ...es.knowledge.qnamaker.models.PromptDTO.yml | 153 + ...knowledge.qnamaker.models.PromptDTOQna.yml | 171 + ...vices.knowledge.qnamaker.models.QnADTO.yml | 171 + ...nowledge.qnamaker.models.QnADTOContext.yml | 138 + ...wledge.qnamaker.models.QnADocumentsDTO.yml | 123 + ...wledge.qnamaker.models.QnASearchResult.yml | 176 + ...maker.models.QnASearchResultAnswerSpan.yml | 145 + ...qnamaker.models.QnASearchResultContext.yml | 138 + ...ge.qnamaker.models.QnASearchResultList.yml | 123 + ...wledge.qnamaker.models.QueryContextDTO.yml | 131 + ...ces.knowledge.qnamaker.models.QueryDTO.yml | 207 + ...maker.models.QueryDTOAnswerSpanRequest.yml | 142 + ...wledge.qnamaker.models.QueryDTOContext.yml | 131 + ...knowledge.qnamaker.models.ReplaceKbDTO.yml | 128 + ...els.StrictFiltersCompoundOperationType.yml | 10 + ...ledge.qnamaker.models.UpdateContextDTO.yml | 148 + ...ge.qnamaker.models.UpdateKbContentsDTO.yml | 151 + ...e.qnamaker.models.UpdateKbOperationDTO.yml | 162 + ...namaker.models.UpdateKbOperationDTOAdd.yml | 139 + ...aker.models.UpdateKbOperationDTODelete.yml | 130 + ...aker.models.UpdateKbOperationDTOUpdate.yml | 151 + ...edge.qnamaker.models.UpdateMetadataDTO.yml | 130 + ...knowledge.qnamaker.models.UpdateQnaDTO.yml | 161 + ...ge.qnamaker.models.UpdateQnaDTOContext.yml | 148 + ...e.qnamaker.models.UpdateQnaDTOMetadata.yml | 130 + ....qnamaker.models.UpdateQnaDTOQuestions.yml | 130 + ...dge.qnamaker.models.UpdateQuestionsDTO.yml | 132 + ...dge.qnamaker.models.WordAlterationsDTO.yml | 126 + ...settings_dto.ActiveLearningSettingsDTO.yml | 120 + ...er.models.active_learning_settings_dto.yml | 6 + ...ings_dto_py3.ActiveLearningSettingsDTO.yml | 123 + ...odels.active_learning_settings_dto_py3.yml | 6 + ....models.alterations_dto.AlterationsDTO.yml | 123 + ...wledge.qnamaker.models.alterations_dto.yml | 6 + ...els.alterations_dto_py3.AlterationsDTO.yml | 126 + ...ge.qnamaker.models.alterations_dto_py3.yml | 6 + ..._span_request_dto.AnswerSpanRequestDTO.yml | 134 + ...namaker.models.answer_span_request_dto.yml | 6 + ...n_request_dto_py3.AnswerSpanRequestDTO.yml | 142 + ...ker.models.answer_span_request_dto_py3.yml | 6 + ...pan_response_dto.AnswerSpanResponseDTO.yml | 135 + ...amaker.models.answer_span_response_dto.yml | 6 + ...response_dto_py3.AnswerSpanResponseDTO.yml | 145 + ...er.models.answer_span_response_dto_py3.yml | 6 + ...qnamaker.models.context_dto.ContextDTO.yml | 133 + ....knowledge.qnamaker.models.context_dto.yml | 6 + ...aker.models.context_dto_py3.ContextDTO.yml | 138 + ...wledge.qnamaker.models.context_dto_py3.yml | 6 + ...maker.models.create_kb_dto.CreateKbDTO.yml | 185 + ...nowledge.qnamaker.models.create_kb_dto.yml | 6 + ...r.models.create_kb_dto_py3.CreateKbDTO.yml | 206 + ...edge.qnamaker.models.create_kb_dto_py3.yml | 6 + ...s.create_kb_input_dto.CreateKbInputDTO.yml | 132 + ...ge.qnamaker.models.create_kb_input_dto.yml | 6 + ...eate_kb_input_dto_py3.CreateKbInputDTO.yml | 139 + ...namaker.models.create_kb_input_dto_py3.yml | 6 + ...te_kb_contents_dto.DeleteKbContentsDTO.yml | 125 + ...qnamaker.models.delete_kb_contents_dto.yml | 6 + ...b_contents_dto_py3.DeleteKbContentsDTO.yml | 130 + ...aker.models.delete_kb_contents_dto_py3.yml | 6 + ...dels.endpoint_keys_dto.EndpointKeysDTO.yml | 140 + ...edge.qnamaker.models.endpoint_keys_dto.yml | 6 + ....endpoint_keys_dto_py3.EndpointKeysDTO.yml | 153 + ....qnamaker.models.endpoint_keys_dto_py3.yml | 6 + ...point_settings_dto.EndpointSettingsDTO.yml | 120 + ....qnamaker.models.endpoint_settings_dto.yml | 6 + ...ning.EndpointSettingsDTOActiveLearning.yml | 120 + ....endpoint_settings_dto_active_learning.yml | 6 + ..._py3.EndpointSettingsDTOActiveLearning.yml | 123 + ...point_settings_dto_active_learning_py3.yml | 6 + ...t_settings_dto_py3.EndpointSettingsDTO.yml | 123 + ...maker.models.endpoint_settings_dto_py3.yml | 6 + ....knowledge.qnamaker.models.error.Error.yml | 160 + ...rvices.knowledge.qnamaker.models.error.yml | 6 + ...wledge.qnamaker.models.error_py3.Error.yml | 172 + ...es.knowledge.qnamaker.models.error_py3.yml | 6 + ...er.models.error_response.ErrorResponse.yml | 122 + ....error_response.ErrorResponseException.yml | 28 + ...owledge.qnamaker.models.error_response.yml | 7 + ...rror_response_error.ErrorResponseError.yml | 158 + ...e.qnamaker.models.error_response_error.yml | 6 + ..._response_error_py3.ErrorResponseError.yml | 170 + ...amaker.models.error_response_error_py3.yml | 6 + ...odels.error_response_py3.ErrorResponse.yml | 125 + ...or_response_py3.ErrorResponseException.yml | 28 + ...dge.qnamaker.models.error_response_py3.yml | 7 + ....feedback_record_dto.FeedbackRecordDTO.yml | 132 + ...ge.qnamaker.models.feedback_record_dto.yml | 6 + ...dback_record_dto_py3.FeedbackRecordDTO.yml | 140 + ...namaker.models.feedback_record_dto_py3.yml | 6 + ...eedback_records_dto.FeedbackRecordsDTO.yml | 120 + ...e.qnamaker.models.feedback_records_dto.yml | 6 + ...ack_records_dto_py3.FeedbackRecordsDTO.yml | 123 + ...amaker.models.feedback_records_dto_py3.yml | 6 + ...ledge.qnamaker.models.file_dto.FileDTO.yml | 130 + ...ces.knowledge.qnamaker.models.file_dto.yml | 6 + ...e.qnamaker.models.file_dto_py3.FileDTO.yml | 135 + ...knowledge.qnamaker.models.file_dto_py3.yml | 6 + ...dels.inner_error_model.InnerErrorModel.yml | 133 + ...edge.qnamaker.models.inner_error_model.yml | 6 + ....inner_error_model_py3.InnerErrorModel.yml | 138 + ....qnamaker.models.inner_error_model_py3.yml | 6 + ...els.knowledgebase_dto.KnowledgebaseDTO.yml | 170 + ...edge.qnamaker.models.knowledgebase_dto.yml | 6 + ...knowledgebase_dto_py3.KnowledgebaseDTO.yml | 191 + ....qnamaker.models.knowledgebase_dto_py3.yml | 6 + ...s.knowledgebases_dto.KnowledgebasesDTO.yml | 120 + ...dge.qnamaker.models.knowledgebases_dto.yml | 6 + ...owledgebases_dto_py3.KnowledgebasesDTO.yml | 123 + ...qnamaker.models.knowledgebases_dto_py3.yml | 6 + ...amaker.models.metadata_dto.MetadataDTO.yml | 128 + ...knowledge.qnamaker.models.metadata_dto.yml | 6 + ...er.models.metadata_dto_py3.MetadataDTO.yml | 133 + ...ledge.qnamaker.models.metadata_dto_py3.yml | 6 + ...ge.qnamaker.models.operation.Operation.yml | 157 + ...es.knowledge.qnamaker.models.operation.yml | 6 + ...namaker.models.operation_py3.Operation.yml | 174 + ...nowledge.qnamaker.models.operation_py3.yml | 6 + ...e.qnamaker.models.prompt_dto.PromptDTO.yml | 143 + ...s.knowledge.qnamaker.models.prompt_dto.yml | 6 + ...amaker.models.prompt_dto_py3.PromptDTO.yml | 153 + ...owledge.qnamaker.models.prompt_dto_py3.yml | 6 + ...ker.models.prompt_dto_qna.PromptDTOQna.yml | 155 + ...owledge.qnamaker.models.prompt_dto_qna.yml | 6 + ...models.prompt_dto_qna_py3.PromptDTOQna.yml | 171 + ...dge.qnamaker.models.prompt_dto_qna_py3.yml | 6 + ...dels.qn_adocuments_dto.QnADocumentsDTO.yml | 120 + ...edge.qnamaker.models.qn_adocuments_dto.yml | 6 + ....qn_adocuments_dto_py3.QnADocumentsDTO.yml | 123 + ....qnamaker.models.qn_adocuments_dto_py3.yml | 6 + ...owledge.qnamaker.models.qn_adto.QnADTO.yml | 155 + ...ices.knowledge.qnamaker.models.qn_adto.yml | 6 + ...r.models.qn_adto_context.QnADTOContext.yml | 133 + ...wledge.qnamaker.models.qn_adto_context.yml | 6 + ...dels.qn_adto_context_py3.QnADTOContext.yml | 138 + ...ge.qnamaker.models.qn_adto_context_py3.yml | 6 + ...dge.qnamaker.models.qn_adto_py3.QnADTO.yml | 171 + ....knowledge.qnamaker.models.qn_adto_py3.yml | 6 + ...qn_amaker_client_enums.EnvironmentType.yml | 10 + ...s.qn_amaker_client_enums.ErrorCodeType.yml | 34 + ...amaker_client_enums.OperationStateType.yml | 14 + ...ums.StrictFiltersCompoundOperationType.yml | 10 + ...qnamaker.models.qn_amaker_client_enums.yml | 9 + ...dels.qn_asearch_result.QnASearchResult.yml | 157 + ...edge.qnamaker.models.qn_asearch_result.yml | 6 + ..._answer_span.QnASearchResultAnswerSpan.yml | 135 + ...r.models.qn_asearch_result_answer_span.yml | 6 + ...wer_span_py3.QnASearchResultAnswerSpan.yml | 145 + ...dels.qn_asearch_result_answer_span_py3.yml | 6 + ..._result_context.QnASearchResultContext.yml | 133 + ...maker.models.qn_asearch_result_context.yml | 6 + ...ult_context_py3.QnASearchResultContext.yml | 138 + ...r.models.qn_asearch_result_context_py3.yml | 6 + ...search_result_list.QnASearchResultList.yml | 120 + ...qnamaker.models.qn_asearch_result_list.yml | 6 + ...ch_result_list_py3.QnASearchResultList.yml | 123 + ...aker.models.qn_asearch_result_list_py3.yml | 6 + ....qn_asearch_result_py3.QnASearchResult.yml | 176 + ....qnamaker.models.qn_asearch_result_py3.yml | 6 + ...dels.query_context_dto.QueryContextDTO.yml | 125 + ...edge.qnamaker.models.query_context_dto.yml | 6 + ....query_context_dto_py3.QueryContextDTO.yml | 131 + ....qnamaker.models.query_context_dto_py3.yml | 6 + ...dge.qnamaker.models.query_dto.QueryDTO.yml | 181 + ...es.knowledge.qnamaker.models.query_dto.yml | 6 + ...span_request.QueryDTOAnswerSpanRequest.yml | 134 + ...r.models.query_dto_answer_span_request.yml | 6 + ..._request_py3.QueryDTOAnswerSpanRequest.yml | 142 + ...dels.query_dto_answer_span_request_py3.yml | 6 + ...dels.query_dto_context.QueryDTOContext.yml | 125 + ...edge.qnamaker.models.query_dto_context.yml | 6 + ....query_dto_context_py3.QueryDTOContext.yml | 131 + ....qnamaker.models.query_dto_context_py3.yml | 6 + ...qnamaker.models.query_dto_py3.QueryDTO.yml | 207 + ...nowledge.qnamaker.models.query_dto_py3.yml | 6 + ...ker.models.replace_kb_dto.ReplaceKbDTO.yml | 125 + ...owledge.qnamaker.models.replace_kb_dto.yml | 6 + ...models.replace_kb_dto_py3.ReplaceKbDTO.yml | 128 + ...dge.qnamaker.models.replace_kb_dto_py3.yml | 6 + ...ls.update_context_dto.UpdateContextDTO.yml | 140 + ...dge.qnamaker.models.update_context_dto.yml | 6 + ...pdate_context_dto_py3.UpdateContextDTO.yml | 148 + ...qnamaker.models.update_context_dto_py3.yml | 6 + ...te_kb_contents_dto.UpdateKbContentsDTO.yml | 141 + ...qnamaker.models.update_kb_contents_dto.yml | 6 + ...b_contents_dto_py3.UpdateKbContentsDTO.yml | 151 + ...aker.models.update_kb_contents_dto_py3.yml | 6 + ..._kb_operation_dto.UpdateKbOperationDTO.yml | 150 + ...namaker.models.update_kb_operation_dto.yml | 6 + ...ration_dto_add.UpdateKbOperationDTOAdd.yml | 132 + ...ker.models.update_kb_operation_dto_add.yml | 6 + ...on_dto_add_py3.UpdateKbOperationDTOAdd.yml | 139 + ...models.update_kb_operation_dto_add_py3.yml | 6 + ..._dto_delete.UpdateKbOperationDTODelete.yml | 125 + ....models.update_kb_operation_dto_delete.yml | 6 + ..._delete_py3.UpdateKbOperationDTODelete.yml | 130 + ...els.update_kb_operation_dto_delete_py3.yml | 6 + ...operation_dto_py3.UpdateKbOperationDTO.yml | 162 + ...ker.models.update_kb_operation_dto_py3.yml | 6 + ..._dto_update.UpdateKbOperationDTOUpdate.yml | 141 + ....models.update_kb_operation_dto_update.yml | 6 + ..._update_py3.UpdateKbOperationDTOUpdate.yml | 151 + ...els.update_kb_operation_dto_update_py3.yml | 6 + ....update_metadata_dto.UpdateMetadataDTO.yml | 125 + ...ge.qnamaker.models.update_metadata_dto.yml | 6 + ...ate_metadata_dto_py3.UpdateMetadataDTO.yml | 130 + ...namaker.models.update_metadata_dto_py3.yml | 6 + ...ker.models.update_qna_dto.UpdateQnaDTO.yml | 147 + ...owledge.qnamaker.models.update_qna_dto.yml | 6 + ...te_qna_dto_context.UpdateQnaDTOContext.yml | 140 + ...qnamaker.models.update_qna_dto_context.yml | 6 + ...na_dto_context_py3.UpdateQnaDTOContext.yml | 148 + ...aker.models.update_qna_dto_context_py3.yml | 6 + ..._qna_dto_metadata.UpdateQnaDTOMetadata.yml | 125 + ...namaker.models.update_qna_dto_metadata.yml | 6 + ..._dto_metadata_py3.UpdateQnaDTOMetadata.yml | 130 + ...ker.models.update_qna_dto_metadata_py3.yml | 6 + ...models.update_qna_dto_py3.UpdateQnaDTO.yml | 161 + ...dge.qnamaker.models.update_qna_dto_py3.yml | 6 + ...na_dto_questions.UpdateQnaDTOQuestions.yml | 125 + ...amaker.models.update_qna_dto_questions.yml | 6 + ...to_questions_py3.UpdateQnaDTOQuestions.yml | 130 + ...er.models.update_qna_dto_questions_py3.yml | 6 + ...pdate_questions_dto.UpdateQuestionsDTO.yml | 127 + ...e.qnamaker.models.update_questions_dto.yml | 6 + ...e_questions_dto_py3.UpdateQuestionsDTO.yml | 132 + ...amaker.models.update_questions_dto_py3.yml | 6 + ...ord_alterations_dto.WordAlterationsDTO.yml | 123 + ...e.qnamaker.models.word_alterations_dto.yml | 6 + ...alterations_dto_py3.WordAlterationsDTO.yml | 126 + ...amaker.models.word_alterations_dto_py3.yml | 6 + ...tiveservices.knowledge.qnamaker.models.yml | 161 + ...maker.operations.AlterationsOperations.yml | 164 + ...aker.operations.EndpointKeysOperations.yml | 90 + ....operations.EndpointSettingsOperations.yml | 91 + ...ker.operations.KnowledgebaseOperations.yml | 410 + ....qnamaker.operations.Operations(class).yml | 61 + ...tions_operations.AlterationsOperations.yml | 164 + ...aker.operations.alterations_operations.yml | 6 + ...keys_operations.EndpointKeysOperations.yml | 90 + ...er.operations.endpoint_keys_operations.yml | 6 + ..._operations.EndpointSettingsOperations.yml | 91 + ...perations.endpoint_settings_operations.yml | 6 + ...ase_operations.KnowledgebaseOperations.yml | 410 + ...er.operations.knowledgebase_operations.yml | 6 + ...maker.operations.operations.Operations.yml | 61 + ...owledge.qnamaker.operations.operations.yml | 6 + ...services.knowledge.qnamaker.operations.yml | 17 + ...amaker.qn_amaker_client.QnAMakerClient.yml | 53 + ...ker_client.QnAMakerClientConfiguration.yml | 62 + ...es.knowledge.qnamaker.qn_amaker_client.yml | 7 + ...iveservices.knowledge.qnamaker.version.yml | 4 + ...e.cognitiveservices.knowledge.qnamaker.yml | 13 + ...age.luis.authoring.LUISAuthoringClient.yml | 68 + ...oring.LUISAuthoringClientConfiguration.yml | 62 + ...thoring.models.AppVersionSettingObject.yml | 130 + ...thoring.models.ApplicationCreateObject.yml | 171 + ...thoring.models.ApplicationInfoResponse.yml | 200 + ...horing.models.ApplicationPublishObject.yml | 133 + ....models.ApplicationSettingUpdateObject.yml | 125 + ...s.authoring.models.ApplicationSettings.yml | 137 + ...thoring.models.ApplicationUpdateObject.yml | 130 + ...luis.authoring.models.AvailableCulture.yml | 130 + ...ng.models.AvailablePrebuiltEntityModel.yml | 138 + ...uthoring.models.AzureAccountInfoObject.yml | 141 + ...uis.authoring.models.BatchLabelExample.yml | 134 + ...uage.luis.authoring.models.ChildEntity.yml | 171 + ...ng.models.ChildEntityModelCreateObject.yml | 138 + ...guage.luis.authoring.models.ClosedList.yml | 136 + ...oring.models.ClosedListEntityExtractor.yml | 172 + ...ing.models.ClosedListModelCreateObject.yml | 130 + ...ring.models.ClosedListModelPatchObject.yml | 123 + ...ing.models.ClosedListModelUpdateObject.yml | 130 + ...is.authoring.models.CollaboratorsArray.yml | 123 + ...models.CompositeChildModelCreateObject.yml | 122 + ...horing.models.CompositeEntityExtractor.yml | 172 + ....authoring.models.CompositeEntityModel.yml | 130 + ...s.authoring.models.CustomPrebuiltModel.yml | 180 + ...age.luis.authoring.models.EndpointInfo.yml | 176 + ...thoring.models.EnqueueTrainingResponse.yml | 133 + ...oring.models.EntitiesSuggestionExample.yml | 147 + ....luis.authoring.models.EntityExtractor.yml | 180 + ...uage.luis.authoring.models.EntityLabel.yml | 167 + ...uis.authoring.models.EntityLabelObject.yml | 161 + ...thoring.models.EntityModelCreateObject.yml | 130 + ....luis.authoring.models.EntityModelInfo.yml | 165 + ...thoring.models.EntityModelUpdateObject.yml | 130 + ...luis.authoring.models.EntityPrediction.yml | 158 + ...guage.luis.authoring.models.EntityRole.yml | 130 + ...uthoring.models.EntityRoleCreateObject.yml | 123 + ...uthoring.models.EntityRoleUpdateObject.yml | 123 + ...ge.luis.authoring.models.ErrorResponse.yml | 131 + ...uthoring.models.ErrorResponseException.yml | 28 + ...is.authoring.models.ExampleLabelObject.yml | 142 + ...luis.authoring.models.ExplicitListItem.yml | 130 + ...ng.models.ExplicitListItemCreateObject.yml | 123 + ...ng.models.ExplicitListItemUpdateObject.yml | 123 + ...uis.authoring.models.FeatureInfoObject.yml | 147 + ...uthoring.models.FeaturesResponseObject.yml | 129 + ...thoring.models.HierarchicalChildEntity.yml | 171 + ...els.HierarchicalChildModelUpdateObject.yml | 122 + ...ing.models.HierarchicalEntityExtractor.yml | 172 + ...uis.authoring.models.HierarchicalModel.yml | 147 + ...s.authoring.models.HierarchicalModelV2.yml | 141 + ...luis.authoring.models.IntentClassifier.yml | 174 + ...luis.authoring.models.IntentPrediction.yml | 130 + ...horing.models.IntentsSuggestionExample.yml | 147 + ...guage.luis.authoring.models.JSONEntity.yml | 158 + ...luis.authoring.models.JSONModelFeature.yml | 170 + ...luis.authoring.models.JSONRegexFeature.yml | 138 + ...ge.luis.authoring.models.JSONUtterance.yml | 137 + ...nguage.luis.authoring.models.JsonChild.yml | 141 + ...ing.models.JsonModelFeatureInformation.yml | 134 + ....authoring.models.LabelExampleResponse.yml | 131 + ....luis.authoring.models.LabelTextObject.yml | 130 + ...luis.authoring.models.LabeledUtterance.yml | 169 + ...language.luis.authoring.models.LuisApp.yml | 241 + ...nguage.luis.authoring.models.LuisAppV2.yml | 241 + ...uis.authoring.models.ModelCreateObject.yml | 123 + ...thoring.models.ModelFeatureInformation.yml | 140 + ...nguage.luis.authoring.models.ModelInfo.yml | 159 + ...uis.authoring.models.ModelInfoResponse.yml | 208 + ....authoring.models.ModelTrainingDetails.yml | 155 + ...uis.authoring.models.ModelTrainingInfo.yml | 129 + ...uis.authoring.models.ModelUpdateObject.yml | 123 + ...authoring.models.NDepthEntityExtractor.yml | 186 + ...e.luis.authoring.models.OperationError.yml | 128 + ....luis.authoring.models.OperationStatus.yml | 133 + ...s.authoring.models.OperationStatusType.yml | 10 + ...guage.luis.authoring.models.PatternAny.yml | 134 + ...oring.models.PatternAnyEntityExtractor.yml | 171 + ...ing.models.PatternAnyModelCreateObject.yml | 130 + ...ing.models.PatternAnyModelUpdateObject.yml | 130 + ...is.authoring.models.PatternFeatureInfo.yml | 154 + ...uage.luis.authoring.models.PatternRule.yml | 130 + ...thoring.models.PatternRuleCreateObject.yml | 130 + ....luis.authoring.models.PatternRuleInfo.yml | 138 + ...thoring.models.PatternRuleUpdateObject.yml | 138 + ...ring.models.PersonalAssistantsResponse.yml | 130 + ...authoring.models.PhraseListFeatureInfo.yml | 182 + ...uthoring.models.PhraselistCreateObject.yml | 163 + ...uthoring.models.PhraselistUpdateObject.yml | 179 + ...e.luis.authoring.models.PrebuiltDomain.yml | 153 + ....models.PrebuiltDomainCreateBaseObject.yml | 125 + ...ring.models.PrebuiltDomainCreateObject.yml | 133 + ...is.authoring.models.PrebuiltDomainItem.yml | 135 + ...models.PrebuiltDomainModelCreateObject.yml | 133 + ....authoring.models.PrebuiltDomainObject.yml | 129 + ...e.luis.authoring.models.PrebuiltEntity.yml | 128 + ...thoring.models.PrebuiltEntityExtractor.yml | 165 + ...models.ProductionOrStagingEndpointInfo.yml | 177 + ...ring.models.PublishSettingUpdateObject.yml | 142 + ....luis.authoring.models.PublishSettings.yml | 154 + ...uage.luis.authoring.models.RegexEntity.yml | 135 + ....authoring.models.RegexEntityExtractor.yml | 172 + ...uthoring.models.RegexModelCreateObject.yml | 131 + ...uthoring.models.RegexModelUpdateObject.yml | 131 + ...ge.luis.authoring.models.SubClosedList.yml | 130 + ...authoring.models.SubClosedListResponse.yml | 138 + ...luis.authoring.models.TaskUpdateObject.yml | 123 + ...e.luis.authoring.models.TrainingStatus.yml | 12 + ...e.luis.authoring.models.UserAccessList.yml | 129 + ...luis.authoring.models.UserCollaborator.yml | 123 + ...uage.luis.authoring.models.VersionInfo.yml | 211 + ...horing.models.WordListBaseUpdateObject.yml | 130 + ...e.luis.authoring.models.WordListObject.yml | 130 + ...ervices.language.luis.authoring.models.yml | 118 + ...is.authoring.operations.AppsOperations.yml | 996 + ...ing.operations.AzureAccountsOperations.yml | 222 + ...uthoring.operations.ExamplesOperations.yml | 241 + ...uthoring.operations.FeaturesOperations.yml | 442 + ...s.authoring.operations.ModelOperations.yml | 5629 +++ ...authoring.operations.PatternOperations.yml | 424 + ...uthoring.operations.SettingsOperations.yml | 117 + ...s.authoring.operations.TrainOperations.yml | 129 + ...uthoring.operations.VersionsOperations.yml | 528 + ...ces.language.luis.authoring.operations.yml | 15 + ...rvices.language.luis.authoring.version.yml | 4 + ...nitiveservices.language.luis.authoring.yml | 13 + ...anguage.luis.runtime.LUISRuntimeClient.yml | 36 + ...runtime.LUISRuntimeClientConfiguration.yml | 62 + ...nguage.luis.runtime.models.DynamicList.yml | 135 + ...ces.language.luis.runtime.models.Error.yml | 126 + ...language.luis.runtime.models.ErrorBody.yml | 133 + ...age.luis.runtime.models.ErrorException.yml | 28 + ...age.luis.runtime.models.ExternalEntity.yml | 161 + ...es.language.luis.runtime.models.Intent.yml | 130 + ...anguage.luis.runtime.models.Prediction.yml | 161 + ....luis.runtime.models.PredictionRequest.yml | 152 + ...untime.models.PredictionRequestOptions.yml | 135 + ...luis.runtime.models.PredictionResponse.yml | 133 + ...nguage.luis.runtime.models.RequestList.yml | 140 + ...language.luis.runtime.models.Sentiment.yml | 133 + ...eservices.language.luis.runtime.models.yml | 18 + ...untime.operations.PredictionOperations.yml | 159 + ...vices.language.luis.runtime.operations.yml | 7 + ...services.language.luis.runtime.version.yml | 4 + ...ognitiveservices.language.luis.runtime.yml | 13 + ...ognitiveservices.language.luis.version.yml | 4 + .../azure.cognitiveservices.language.luis.yml | 10 + ...s.language.spellcheck.SpellCheckClient.yml | 481 + ...ellcheck.SpellCheckClientConfiguration.yml | 64 + ....language.spellcheck.models.ActionType.yml | 10 + ...ices.language.spellcheck.models.Answer.yml | 138 + ...vices.language.spellcheck.models.Error.yml | 173 + ...s.language.spellcheck.models.ErrorCode.yml | 18 + ...nguage.spellcheck.models.ErrorResponse.yml | 143 + ...ellcheck.models.ErrorResponseException.yml | 28 + ...anguage.spellcheck.models.ErrorSubCode.yml | 28 + ...s.language.spellcheck.models.ErrorType.yml | 10 + ...anguage.spellcheck.models.Identifiable.yml | 138 + ...rvices.language.spellcheck.models.Mode.yml | 10 + ...es.language.spellcheck.models.Response.yml | 140 + ...anguage.spellcheck.models.ResponseBase.yml | 128 + ....language.spellcheck.models.SpellCheck.yml | 141 + ...spellcheck.models.SpellingFlaggedToken.yml | 156 + ...llcheck.models.SpellingTokenSuggestion.yml | 138 + ...iveservices.language.spellcheck.models.yml | 22 + ...ations.SpellCheckClientOperationsMixin.yml | 453 + ...ervices.language.spellcheck.operations.yml | 7 + ...veservices.language.spellcheck.version.yml | 4 + ....cognitiveservices.language.spellcheck.yml | 13 + ...uage.textanalytics.TextAnalyticsClient.yml | 244 + ....textanalytics.models.DetectedLanguage.yml | 142 + ...extanalytics.models.DocumentStatistics.yml | 133 + ...xtanalytics.models.EntitiesBatchResult.yml | 134 + ...alytics.models.EntitiesBatchResultItem.yml | 142 + ...uage.textanalytics.models.EntityRecord.yml | 183 + ...guage.textanalytics.models.ErrorRecord.yml | 130 + ...age.textanalytics.models.ErrorResponse.yml | 141 + ...nalytics.models.ErrorResponseException.yml | 28 + ...age.textanalytics.models.InternalError.yml | 135 + ...tanalytics.models.KeyPhraseBatchResult.yml | 134 + ...lytics.models.KeyPhraseBatchResultItem.yml | 146 + ...extanalytics.models.LanguageBatchInput.yml | 122 + ...xtanalytics.models.LanguageBatchResult.yml | 134 + ...alytics.models.LanguageBatchResultItem.yml | 140 + ...age.textanalytics.models.LanguageInput.yml | 136 + ...guage.textanalytics.models.MatchRecord.yml | 162 + ...alytics.models.MultiLanguageBatchInput.yml | 122 + ...extanalytics.models.MultiLanguageInput.yml | 139 + ...textanalytics.models.RequestStatistics.yml | 150 + ...tanalytics.models.SentimentBatchResult.yml | 134 + ...lytics.models.SentimentBatchResultItem.yml | 146 + ...els.detected_language.DetectedLanguage.yml | 134 + ...textanalytics.models.detected_language.yml | 6 + ...detected_language_py3.DetectedLanguage.yml | 142 + ...analytics.models.detected_language_py3.yml | 6 + ...document_statistics.DocumentStatistics.yml | 127 + ...xtanalytics.models.document_statistics.yml | 6 + ...ment_statistics_py3.DocumentStatistics.yml | 133 + ...alytics.models.document_statistics_py3.yml | 6 + ...ities_batch_result.EntitiesBatchResult.yml | 134 + ...analytics.models.entities_batch_result.yml | 6 + ...ch_result_item.EntitiesBatchResultItem.yml | 137 + ...tics.models.entities_batch_result_item.yml | 6 + ...esult_item_py3.EntitiesBatchResultItem.yml | 142 + ....models.entities_batch_result_item_py3.yml | 6 + ...s_batch_result_py3.EntitiesBatchResult.yml | 134 + ...ytics.models.entities_batch_result_py3.yml | 6 + ...tics.models.entity_record.EntityRecord.yml | 166 + ...age.textanalytics.models.entity_record.yml | 6 + ....models.entity_record_py3.EntityRecord.yml | 183 + ...textanalytics.models.entity_record_py3.yml | 6 + ...lytics.models.error_record.ErrorRecord.yml | 125 + ...uage.textanalytics.models.error_record.yml | 6 + ...cs.models.error_record_py3.ErrorRecord.yml | 130 + ....textanalytics.models.error_record_py3.yml | 6 + ...cs.models.error_response.ErrorResponse.yml | 131 + ....error_response.ErrorResponseException.yml | 28 + ...ge.textanalytics.models.error_response.yml | 7 + ...odels.error_response_py3.ErrorResponse.yml | 141 + ...or_response_py3.ErrorResponseException.yml | 28 + ...extanalytics.models.error_response_py3.yml | 7 + ...cs.models.internal_error.InternalError.yml | 127 + ...ge.textanalytics.models.internal_error.yml | 6 + ...odels.internal_error_py3.InternalError.yml | 135 + ...extanalytics.models.internal_error_py3.yml | 6 + ...rase_batch_result.KeyPhraseBatchResult.yml | 134 + ...alytics.models.key_phrase_batch_result.yml | 6 + ...h_result_item.KeyPhraseBatchResultItem.yml | 141 + ...cs.models.key_phrase_batch_result_item.yml | 6 + ...sult_item_py3.KeyPhraseBatchResultItem.yml | 146 + ...odels.key_phrase_batch_result_item_py3.yml | 6 + ..._batch_result_py3.KeyPhraseBatchResult.yml | 134 + ...ics.models.key_phrase_batch_result_py3.yml | 6 + ...anguage_batch_input.LanguageBatchInput.yml | 119 + ...tanalytics.models.language_batch_input.yml | 6 + ...age_batch_input_py3.LanguageBatchInput.yml | 122 + ...lytics.models.language_batch_input_py3.yml | 6 + ...guage_batch_result.LanguageBatchResult.yml | 134 + ...analytics.models.language_batch_result.yml | 6 + ...ch_result_item.LanguageBatchResultItem.yml | 132 + ...tics.models.language_batch_result_item.yml | 6 + ...esult_item_py3.LanguageBatchResultItem.yml | 140 + ....models.language_batch_result_item_py3.yml | 6 + ...e_batch_result_py3.LanguageBatchResult.yml | 134 + ...ytics.models.language_batch_result_py3.yml | 6 + ...cs.models.language_input.LanguageInput.yml | 128 + ...ge.textanalytics.models.language_input.yml | 6 + ...odels.language_input_py3.LanguageInput.yml | 136 + ...extanalytics.models.language_input_py3.yml | 6 + ...lytics.models.match_record.MatchRecord.yml | 150 + ...uage.textanalytics.models.match_record.yml | 6 + ...cs.models.match_record_py3.MatchRecord.yml | 162 + ....textanalytics.models.match_record_py3.yml | 6 + ...ge_batch_input.MultiLanguageBatchInput.yml | 119 + ...tics.models.multi_language_batch_input.yml | 6 + ...atch_input_py3.MultiLanguageBatchInput.yml | 122 + ....models.multi_language_batch_input_py3.yml | 6 + ...ulti_language_input.MultiLanguageInput.yml | 131 + ...tanalytics.models.multi_language_input.yml | 6 + ..._language_input_py3.MultiLanguageInput.yml | 139 + ...lytics.models.multi_language_input_py3.yml | 6 + ...s.request_statistics.RequestStatistics.yml | 139 + ...extanalytics.models.request_statistics.yml | 6 + ...quest_statistics_py3.RequestStatistics.yml | 150 + ...nalytics.models.request_statistics_py3.yml | 6 + ...ment_batch_result.SentimentBatchResult.yml | 134 + ...nalytics.models.sentiment_batch_result.yml | 6 + ...h_result_item.SentimentBatchResultItem.yml | 138 + ...ics.models.sentiment_batch_result_item.yml | 6 + ...sult_item_py3.SentimentBatchResultItem.yml | 146 + ...models.sentiment_batch_result_item_py3.yml | 6 + ..._batch_result_py3.SentimentBatchResult.yml | 134 + ...tics.models.sentiment_batch_result_py3.yml | 6 + ...services.language.textanalytics.models.yml | 68 + ...t_analytics_client.TextAnalyticsClient.yml | 244 + ...lient.TextAnalyticsClientConfiguration.yml | 62 + ...ge.textanalytics.text_analytics_client.yml | 7 + ...ervices.language.textanalytics.version.yml | 4 + ...gnitiveservices.language.textanalytics.yml | 12 + ...ces.search.newssearch.NewsSearchClient.yml | 43 + ...wssearch.NewsSearchClientConfiguration.yml | 64 + ...rvices.search.newssearch.models.Answer.yml | 145 + ...vices.search.newssearch.models.Article.yml | 188 + ....search.newssearch.models.CreativeWork.yml | 186 + ...ervices.search.newssearch.models.Error.yml | 173 + ...ces.search.newssearch.models.ErrorCode.yml | 18 + ...search.newssearch.models.ErrorResponse.yml | 147 + ...wssearch.models.ErrorResponseException.yml | 28 + ....search.newssearch.models.ErrorSubCode.yml | 28 + ...ces.search.newssearch.models.Freshness.yml | 12 + ....search.newssearch.models.Identifiable.yml | 138 + ...s.search.newssearch.models.ImageObject.yml | 197 + ...s.search.newssearch.models.MediaObject.yml | 198 + ...services.search.newssearch.models.News.yml | 164 + ...s.search.newssearch.models.NewsArticle.yml | 205 + ...ces.search.newssearch.models.NewsTopic.yml | 181 + ....search.newssearch.models.Organization.yml | 163 + ...ervices.search.newssearch.models.Query.yml | 166 + ...ices.search.newssearch.models.Response.yml | 144 + ....search.newssearch.models.ResponseBase.yml | 128 + ...es.search.newssearch.models.SafeSearch.yml | 12 + ....newssearch.models.SearchResultsAnswer.yml | 153 + ...es.search.newssearch.models.TextFormat.yml | 10 + ...ervices.search.newssearch.models.Thing.yml | 168 + ...earch.newssearch.models.TrendingTopics.yml | 148 + ...s.search.newssearch.models.VideoObject.yml | 220 + ...itiveservices.search.newssearch.models.yml | 32 + ...h.newssearch.operations.NewsOperations.yml | 1607 + ...eservices.search.newssearch.operations.yml | 7 + ...tiveservices.search.newssearch.version.yml | 4 + ...re.cognitiveservices.search.newssearch.yml | 13 + ...search.visualsearch.VisualSearchClient.yml | 43 + ...arch.visualsearch.models.Action(class).yml | 214 + ...rch.visualsearch.models.AggregateOffer.yml | 265 + ...ch.visualsearch.models.AggregateRating.yml | 155 + ...earch.visualsearch.models.CreativeWork.yml | 194 + ...es.search.visualsearch.models.CropArea.yml | 173 + ...es.search.visualsearch.models.Currency.yml | 328 + ...earch.visualsearch.models.Error(class).yml | 173 + ...s.search.visualsearch.models.ErrorCode.yml | 18 + ...arch.visualsearch.models.ErrorResponse.yml | 155 + ...alsearch.models.ErrorResponseException.yml | 28 + ...earch.visualsearch.models.ErrorSubCode.yml | 28 + ...rch.visualsearch.models.Filters(class).yml | 128 + ...isualsearch.models.Identifiable(class).yml | 138 + ...search.visualsearch.models.ImageAction.yml | 220 + ....visualsearch.models.ImageEntityAction.yml | 213 + ...s.search.visualsearch.models.ImageInfo.yml | 170 + ...rch.visualsearch.models.ImageKnowledge.yml | 153 + ....visualsearch.models.ImageModuleAction.yml | 217 + ...search.visualsearch.models.ImageObject.yml | 267 + ...visualsearch.models.ImageRecipesAction.yml | 217 + ...arch.models.ImageRelatedSearchesAction.yml | 217 + ...arch.models.ImageShoppingSourcesAction.yml | 217 + ...es.search.visualsearch.models.ImageTag.yml | 191 + ...rch.visualsearch.models.ImageTagRegion.yml | 137 + ...isualsearch.models.ImagesImageMetadata.yml | 146 + ...earch.visualsearch.models.ImagesModule.yml | 124 + ....visualsearch.models.Intangible(class).yml | 178 + ...h.visualsearch.models.ItemAvailability.yml | 22 + ...h.visualsearch.models.KnowledgeRequest.yml | 128 + ...search.visualsearch.models.MediaObject.yml | 226 + ...lsearch.models.NormalizedQuadrilateral.yml | 207 + ...earch.visualsearch.models.Offer(class).yml | 264 + ...isualsearch.models.Organization(class).yml | 171 + ...arch.visualsearch.models.Person(class).yml | 179 + ...ces.search.visualsearch.models.Point2D.yml | 186 + ...rch.visualsearch.models.PropertiesItem.yml | 138 + ...earch.visualsearch.models.Query(class).yml | 160 + ...arch.visualsearch.models.Rating(class).yml | 154 + ...arch.visualsearch.models.Recipe(class).yml | 211 + ...arch.visualsearch.models.RecipesModule.yml | 124 + ...ualsearch.models.RelatedSearchesModule.yml | 124 + ...ch.visualsearch.models.Response(class).yml | 152 + ...earch.visualsearch.models.ResponseBase.yml | 128 + ....search.visualsearch.models.SafeSearch.yml | 12 + ...ch.visualsearch.models.StructuredValue.yml | 176 + ...earch.visualsearch.models.Thing(class).yml | 178 + ...isualsearch.models.VisualSearchRequest.yml | 137 + ...arch.visualsearch.models.action.Action.yml | 214 + ...ices.search.visualsearch.models.action.yml | 6 + ....visualsearch.models.action_py3.Action.yml | 214 + ....search.visualsearch.models.action_py3.yml | 6 + ....models.aggregate_offer.AggregateOffer.yml | 265 + ...ch.visualsearch.models.aggregate_offer.yml | 6 + ...els.aggregate_offer_py3.AggregateOffer.yml | 265 + ...isualsearch.models.aggregate_offer_py3.yml | 6 + ...odels.aggregate_rating.AggregateRating.yml | 152 + ...h.visualsearch.models.aggregate_rating.yml | 6 + ...s.aggregate_rating_py3.AggregateRating.yml | 155 + ...sualsearch.models.aggregate_rating_py3.yml | 6 + ...arch.models.creative_work.CreativeWork.yml | 194 + ...arch.visualsearch.models.creative_work.yml | 6 + ....models.creative_work_py3.CreativeWork.yml | 194 + ....visualsearch.models.creative_work_py3.yml | 6 + ...visualsearch.models.crop_area.CropArea.yml | 164 + ...s.search.visualsearch.models.crop_area.yml | 6 + ...alsearch.models.crop_area_py3.CropArea.yml | 173 + ...arch.visualsearch.models.crop_area_py3.yml | 6 + ...search.visualsearch.models.error.Error.yml | 168 + ...vices.search.visualsearch.models.error.yml | 6 + ...ch.visualsearch.models.error_py3.Error.yml | 173 + ...s.search.visualsearch.models.error_py3.yml | 6 + ...ch.models.error_response.ErrorResponse.yml | 152 + ....error_response.ErrorResponseException.yml | 28 + ...rch.visualsearch.models.error_response.yml | 7 + ...odels.error_response_py3.ErrorResponse.yml | 155 + ...or_response_py3.ErrorResponseException.yml | 28 + ...visualsearch.models.error_response_py3.yml | 7 + ...ch.visualsearch.models.filters.Filters.yml | 125 + ...ces.search.visualsearch.models.filters.yml | 6 + ...isualsearch.models.filters_py3.Filters.yml | 128 + ...search.visualsearch.models.filters_py3.yml | 6 + ...earch.models.identifiable.Identifiable.yml | 138 + ...earch.visualsearch.models.identifiable.yml | 6 + ...h.models.identifiable_py3.Identifiable.yml | 138 + ...h.visualsearch.models.identifiable_py3.yml | 6 + ...search.models.image_action.ImageAction.yml | 220 + ...earch.visualsearch.models.image_action.yml | 6 + ...ch.models.image_action_py3.ImageAction.yml | 220 + ...h.visualsearch.models.image_action_py3.yml | 6 + ....image_entity_action.ImageEntityAction.yml | 213 + ...isualsearch.models.image_entity_action.yml | 6 + ...ge_entity_action_py3.ImageEntityAction.yml | 213 + ...lsearch.models.image_entity_action_py3.yml | 6 + ...sualsearch.models.image_info.ImageInfo.yml | 162 + ....search.visualsearch.models.image_info.yml | 6 + ...search.models.image_info_py3.ImageInfo.yml | 170 + ...rch.visualsearch.models.image_info_py3.yml | 6 + ....models.image_knowledge.ImageKnowledge.yml | 153 + ...ch.visualsearch.models.image_knowledge.yml | 6 + ...els.image_knowledge_py3.ImageKnowledge.yml | 153 + ...isualsearch.models.image_knowledge_py3.yml | 6 + ....image_module_action.ImageModuleAction.yml | 217 + ...isualsearch.models.image_module_action.yml | 6 + ...ge_module_action_py3.ImageModuleAction.yml | 217 + ...lsearch.models.image_module_action_py3.yml | 6 + ...search.models.image_object.ImageObject.yml | 267 + ...earch.visualsearch.models.image_object.yml | 6 + ...ch.models.image_object_py3.ImageObject.yml | 267 + ...h.visualsearch.models.image_object_py3.yml | 6 + ...mage_recipes_action.ImageRecipesAction.yml | 217 + ...sualsearch.models.image_recipes_action.yml | 6 + ..._recipes_action_py3.ImageRecipesAction.yml | 217 + ...search.models.image_recipes_action_py3.yml | 6 + ...ches_action.ImageRelatedSearchesAction.yml | 217 + ...h.models.image_related_searches_action.yml | 6 + ..._action_py3.ImageRelatedSearchesAction.yml | 217 + ...dels.image_related_searches_action_py3.yml | 6 + ...rces_action.ImageShoppingSourcesAction.yml | 217 + ...h.models.image_shopping_sources_action.yml | 6 + ..._action_py3.ImageShoppingSourcesAction.yml | 217 + ...dels.image_shopping_sources_action_py3.yml | 6 + ...visualsearch.models.image_tag.ImageTag.yml | 191 + ...s.search.visualsearch.models.image_tag.yml | 6 + ...alsearch.models.image_tag_py3.ImageTag.yml | 191 + ...arch.visualsearch.models.image_tag_py3.yml | 6 + ...models.image_tag_region.ImageTagRegion.yml | 132 + ...h.visualsearch.models.image_tag_region.yml | 6 + ...ls.image_tag_region_py3.ImageTagRegion.yml | 137 + ...sualsearch.models.image_tag_region_py3.yml | 6 + ...ges_image_metadata.ImagesImageMetadata.yml | 146 + ...ualsearch.models.images_image_metadata.yml | 6 + ...image_metadata_py3.ImagesImageMetadata.yml | 146 + ...earch.models.images_image_metadata_py3.yml | 6 + ...arch.models.images_module.ImagesModule.yml | 124 + ...arch.visualsearch.models.images_module.yml | 6 + ....models.images_module_py3.ImagesModule.yml | 124 + ....visualsearch.models.images_module_py3.yml | 6 + ...ualsearch.models.intangible.Intangible.yml | 178 + ....search.visualsearch.models.intangible.yml | 6 + ...earch.models.intangible_py3.Intangible.yml | 178 + ...rch.visualsearch.models.intangible_py3.yml | 6 + ...els.knowledge_request.KnowledgeRequest.yml | 125 + ....visualsearch.models.knowledge_request.yml | 6 + ...knowledge_request_py3.KnowledgeRequest.yml | 128 + ...ualsearch.models.knowledge_request_py3.yml | 6 + ...search.models.media_object.MediaObject.yml | 226 + ...earch.visualsearch.models.media_object.yml | 6 + ...ch.models.media_object_py3.MediaObject.yml | 226 + ...h.visualsearch.models.media_object_py3.yml | 6 + ..._quadrilateral.NormalizedQuadrilateral.yml | 197 + ...search.models.normalized_quadrilateral.yml | 6 + ...drilateral_py3.NormalizedQuadrilateral.yml | 207 + ...ch.models.normalized_quadrilateral_py3.yml | 6 + ...search.visualsearch.models.offer.Offer.yml | 264 + ...vices.search.visualsearch.models.offer.yml | 6 + ...ch.visualsearch.models.offer_py3.Offer.yml | 264 + ...s.search.visualsearch.models.offer_py3.yml | 6 + ...earch.models.organization.Organization.yml | 171 + ...earch.visualsearch.models.organization.yml | 6 + ...h.models.organization_py3.Organization.yml | 171 + ...h.visualsearch.models.organization_py3.yml | 6 + ...arch.visualsearch.models.person.Person.yml | 179 + ...ices.search.visualsearch.models.person.yml | 6 + ....visualsearch.models.person_py3.Person.yml | 179 + ....search.visualsearch.models.person_py3.yml | 6 + ...h.visualsearch.models.point2_d.Point2D.yml | 181 + ...es.search.visualsearch.models.point2_d.yml | 6 + ...sualsearch.models.point2_d_py3.Point2D.yml | 186 + ...earch.visualsearch.models.point2_d_py3.yml | 6 + ....models.properties_item.PropertiesItem.yml | 138 + ...ch.visualsearch.models.properties_item.yml | 6 + ...els.properties_item_py3.PropertiesItem.yml | 138 + ...isualsearch.models.properties_item_py3.yml | 6 + ...search.visualsearch.models.query.Query.yml | 157 + ...vices.search.visualsearch.models.query.yml | 6 + ...ch.visualsearch.models.query_py3.Query.yml | 160 + ...s.search.visualsearch.models.query_py3.yml | 6 + ...arch.visualsearch.models.rating.Rating.yml | 151 + ...ices.search.visualsearch.models.rating.yml | 6 + ....visualsearch.models.rating_py3.Rating.yml | 154 + ....search.visualsearch.models.rating_py3.yml | 6 + ...arch.visualsearch.models.recipe.Recipe.yml | 211 + ...ices.search.visualsearch.models.recipe.yml | 6 + ....visualsearch.models.recipe_py3.Recipe.yml | 211 + ....search.visualsearch.models.recipe_py3.yml | 6 + ...ch.models.recipes_module.RecipesModule.yml | 124 + ...rch.visualsearch.models.recipes_module.yml | 6 + ...odels.recipes_module_py3.RecipesModule.yml | 124 + ...visualsearch.models.recipes_module_py3.yml | 6 + ..._searches_module.RelatedSearchesModule.yml | 124 + ...lsearch.models.related_searches_module.yml | 6 + ...rches_module_py3.RelatedSearchesModule.yml | 124 + ...rch.models.related_searches_module_py3.yml | 6 + ....visualsearch.models.response.Response.yml | 152 + ...es.search.visualsearch.models.response.yml | 6 + ...arch.models.response_base.ResponseBase.yml | 128 + ...arch.visualsearch.models.response_base.yml | 6 + ....models.response_base_py3.ResponseBase.yml | 128 + ....visualsearch.models.response_base_py3.yml | 6 + ...ualsearch.models.response_py3.Response.yml | 152 + ...earch.visualsearch.models.response_py3.yml | 6 + ...odels.structured_value.StructuredValue.yml | 176 + ...h.visualsearch.models.structured_value.yml | 6 + ...s.structured_value_py3.StructuredValue.yml | 176 + ...sualsearch.models.structured_value_py3.yml | 6 + ...search.visualsearch.models.thing.Thing.yml | 178 + ...vices.search.visualsearch.models.thing.yml | 6 + ...ch.visualsearch.models.thing_py3.Thing.yml | 178 + ...s.search.visualsearch.models.thing_py3.yml | 6 + ...ls.visual_search_client_enums.Currency.yml | 328 + ...s.visual_search_client_enums.ErrorCode.yml | 18 + ...isual_search_client_enums.ErrorSubCode.yml | 28 + ...l_search_client_enums.ItemAvailability.yml | 22 + ....visual_search_client_enums.SafeSearch.yml | 12 + ...arch.models.visual_search_client_enums.yml | 10 + ...ual_search_request.VisualSearchRequest.yml | 132 + ...ualsearch.models.visual_search_request.yml | 6 + ...search_request_py3.VisualSearchRequest.yml | 137 + ...earch.models.visual_search_request_py3.yml | 6 + ...iveservices.search.visualsearch.models.yml | 138 + ...sualsearch.operations.ImagesOperations.yml | 454 + ...ons.images_operations.ImagesOperations.yml | 454 + ...ualsearch.operations.images_operations.yml | 6 + ...ervices.search.visualsearch.operations.yml | 9 + ...veservices.search.visualsearch.version.yml | 4 + ...isual_search_client.VisualSearchClient.yml | 43 + ...client.VisualSearchClientConfiguration.yml | 64 + ...arch.visualsearch.visual_search_client.yml | 7 + ....cognitiveservices.search.visualsearch.yml | 13 + ...on.computervision.ComputerVisionClient.yml | 1668 + ...sion.ComputerVisionClientConfiguration.yml | 60 + ...vision.computervision.models.AdultInfo.yml | 168 + ...n.computervision.models.AnalyzeResults.yml | 142 + ...ision.computervision.models.Appearance.yml | 126 + ...utervision.models.AreaOfInterestResult.yml | 148 + ...ion.computervision.models.BoundingRect.yml | 145 + ....vision.computervision.models.Category.yml | 137 + ...n.computervision.models.CategoryDetail.yml | 130 + ...computervision.models.CelebritiesModel.yml | 140 + ...vision.computervision.models.ColorInfo.yml | 153 + ...putervision.models.ComputerVisionError.yml | 147 + ...vision.models.ComputerVisionErrorCodes.yml | 14 + ...ion.models.ComputerVisionErrorResponse.yml | 126 + ...s.ComputerVisionErrorResponseException.yml | 28 + ...vision.models.ComputerVisionInnerError.yml | 148 + ...dels.ComputerVisionInnerErrorCodeValue.yml | 44 + ...ervision.models.ComputerVisionOcrError.yml | 142 + ...models.ComputerVisionOcrErrorException.yml | 28 + ...mputervision.models.DescriptionExclude.yml | 10 + ...s.vision.computervision.models.Details.yml | 10 + ...ion.computervision.models.DetectResult.yml | 146 + ...on.computervision.models.DetectedBrand.yml | 134 + ...n.computervision.models.DetectedObject.yml | 154 + ...mputervision.models.DomainModelResults.yml | 145 + ....computervision.models.FaceDescription.yml | 142 + ...on.computervision.models.FaceRectangle.yml | 149 + ...es.vision.computervision.models.Gender.yml | 10 + ...on.computervision.models.ImageAnalysis.yml | 210 + ...ion.computervision.models.ImageCaption.yml | 130 + ...computervision.models.ImageDescription.yml | 152 + ...rvision.models.ImageDescriptionDetails.yml | 132 + ...on.computervision.models.ImageMetadata.yml | 138 + ....vision.computervision.models.ImageTag.yml | 138 + ...vision.computervision.models.ImageType.yml | 133 + ....vision.computervision.models.ImageUrl.yml | 126 + ...n.computervision.models.LandmarksModel.yml | 132 + ...ices.vision.computervision.models.Line.yml | 157 + ...computervision.models.ListModelsResult.yml | 124 + ...computervision.models.ModelDescription.yml | 130 + ....computervision.models.ObjectHierarchy.yml | 144 + ...utervision.models.OcrDetectionLanguage.yml | 152 + ...ion.computervision.models.OcrLanguages.yml | 60 + ...s.vision.computervision.models.OcrLine.yml | 142 + ...vision.computervision.models.OcrRegion.yml | 142 + ...vision.computervision.models.OcrResult.yml | 183 + ...s.vision.computervision.models.OcrWord.yml | 140 + ...utervision.models.OperationStatusCodes.yml | 14 + ...putervision.models.ReadOperationResult.yml | 152 + ...ision.computervision.models.ReadResult.yml | 180 + ...ces.vision.computervision.models.Style.yml | 136 + ...vision.computervision.models.TagResult.yml | 145 + ...els.TextRecognitionResultDimensionUnit.yml | 10 + ...vision.computervision.models.TextStyle.yml | 10 + ...mputervision.models.VisualFeatureTypes.yml | 24 + ...ices.vision.computervision.models.Word.yml | 140 + ...eservices.vision.computervision.models.yml | 61 + ...ns.ComputerVisionClientOperationsMixin.yml | 1639 + ...vices.vision.computervision.operations.yml | 7 + ...services.vision.computervision.version.yml | 4 + ...ognitiveservices.vision.computervision.yml | 13 + ...ontentmoderator.ContentModeratorClient.yml | 72 + ...oderator_client.ContentModeratorClient.yml | 72 + ...nt.ContentModeratorClientConfiguration.yml | 62 + ...tentmoderator.content_moderator_client.yml | 7 + ...ision.contentmoderator.models.APIError.yml | 122 + ...tentmoderator.models.APIErrorException.yml | 28 + ...vision.contentmoderator.models.Address.yml | 130 + ...es.vision.contentmoderator.models.Body.yml | 137 + ...sion.contentmoderator.models.BodyModel.yml | 129 + ...sion.contentmoderator.models.Candidate.yml | 130 + ...contentmoderator.models.Classification.yml | 160 + ...derator.models.ClassificationCategory1.yml | 128 + ...derator.models.ClassificationCategory2.yml | 128 + ...derator.models.ClassificationCategory3.yml | 128 + ...vision.contentmoderator.models.Content.yml | 126 + ...tmoderator.models.CreateReviewBodyItem.yml | 158 + ...odels.CreateReviewBodyItemMetadataItem.yml | 133 + ...ator.models.CreateVideoReviewsBodyItem.yml | 188 + ...CreateVideoReviewsBodyItemMetadataItem.yml | 133 + ...ateVideoReviewsBodyItemVideoFramesItem.yml | 154 + ...ewsBodyItemVideoFramesItemMetadataItem.yml | 134 + ...mVideoFramesItemReviewerResultTagsItem.yml | 134 + ...ntentmoderator.models.DetectedLanguage.yml | 138 + ....contentmoderator.models.DetectedTerms.yml | 149 + ...s.vision.contentmoderator.models.Email.yml | 147 + ...s.vision.contentmoderator.models.Error.yml | 128 + ...ision.contentmoderator.models.Evaluate.yml | 186 + ...es.vision.contentmoderator.models.Face.yml | 145 + ...ion.contentmoderator.models.FoundFaces.yml | 166 + ...s.vision.contentmoderator.models.Frame.yml | 145 + ....vision.contentmoderator.models.Frames.yml | 129 + ...ces.vision.contentmoderator.models.IPA.yml | 137 + ...s.vision.contentmoderator.models.Image.yml | 145 + ...derator.models.ImageAdditionalInfoItem.yml | 130 + ...ision.contentmoderator.models.ImageIds.yml | 145 + ...sion.contentmoderator.models.ImageList.yml | 145 + ...ces.vision.contentmoderator.models.Job.yml | 183 + ...rator.models.JobExecutionReportDetails.yml | 130 + ...s.vision.contentmoderator.models.JobId.yml | 123 + ....contentmoderator.models.JobListResult.yml | 123 + ...n.contentmoderator.models.KeyValuePair.yml | 130 + ...s.vision.contentmoderator.models.Match.yml | 152 + ....contentmoderator.models.MatchResponse.yml | 152 + ...ces.vision.contentmoderator.models.OCR.yml | 166 + ...ces.vision.contentmoderator.models.PII.yml | 146 + ...s.vision.contentmoderator.models.Phone.yml | 140 + ...n.contentmoderator.models.RefreshIndex.yml | 152 + ....vision.contentmoderator.models.Review.yml | 189 + ...ces.vision.contentmoderator.models.SSN.yml | 130 + ....vision.contentmoderator.models.Screen.yml | 187 + ....vision.contentmoderator.models.Status.yml | 138 + ...ces.vision.contentmoderator.models.Tag.yml | 130 + ...ision.contentmoderator.models.TermList.yml | 145 + ...s.vision.contentmoderator.models.Terms.yml | 130 + ...sion.contentmoderator.models.TermsData.yml | 145 + ...on.contentmoderator.models.TermsInList.yml | 123 + ...on.contentmoderator.models.TermsPaging.yml | 145 + ...or.models.TranscriptModerationBodyItem.yml | 133 + ....TranscriptModerationBodyItemTermsItem.yml | 133 + ...entmoderator.models.VideoFrameBodyItem.yml | 147 + ....models.VideoFrameBodyItemMetadataItem.yml | 133 + ...deoFrameBodyItemReviewerResultTagsItem.yml | 133 + ...ervices.vision.contentmoderator.models.yml | 64 + ...r.operations.ImageModerationOperations.yml | 696 + ...ons.ListManagementImageListsOperations.yml | 243 + ...erations.ListManagementImageOperations.yml | 298 + ...ions.ListManagementTermListsOperations.yml | 249 + ...perations.ListManagementTermOperations.yml | 207 + ...moderator.operations.ReviewsOperations.yml | 944 + ...or.operations.TextModerationOperations.yml | 171 + ...n_operations.ImageModerationOperations.yml | 696 + ...operations.image_moderation_operations.yml | 6 + ...ons.ListManagementImageListsOperations.yml | 243 + ...list_management_image_lists_operations.yml | 6 + ...erations.ListManagementImageOperations.yml | 298 + ...tions.list_management_image_operations.yml | 6 + ...ions.ListManagementTermListsOperations.yml | 249 + ....list_management_term_lists_operations.yml | 6 + ...perations.ListManagementTermOperations.yml | 207 + ...ations.list_management_term_operations.yml | 6 + ...s.reviews_operations.ReviewsOperations.yml | 944 + ...oderator.operations.reviews_operations.yml | 6 + ...on_operations.TextModerationOperations.yml | 171 + ....operations.text_moderation_operations.yml | 6 + ...ces.vision.contentmoderator.operations.yml | 21 + ...rvices.vision.contentmoderator.version.yml | 4 + ...nitiveservices.vision.contentmoderator.yml | 13 + ...rediction.CustomVisionPredictionClient.yml | 470 + ...tomVisionPredictionClientConfiguration.yml | 60 + ...omvision.prediction.models.BoundingBox.yml | 147 + ...on.prediction.models.CustomVisionError.yml | 282 + ...ediction.models.CustomVisionErrorCodes.yml | 266 + ...tion.models.CustomVisionErrorException.yml | 28 + ...sion.prediction.models.ImagePrediction.yml | 140 + ...ustomvision.prediction.models.ImageUrl.yml | 126 + ...tomvision.prediction.models.Prediction.yml | 143 + ...customvision.prediction.models.TagType.yml | 12 + ....vision.customvision.prediction.models.yml | 15 + ...mVisionPredictionClientOperationsMixin.yml | 448 + ...ion.customvision.prediction.operations.yml | 7 + ...vision.customvision.prediction.version.yml | 4 + ...ervices.vision.customvision.prediction.yml | 13 + ...on.training.CustomVisionTrainingClient.yml | 2732 ++ ...ustomVisionTrainingClientConfiguration.yml | 60 + ...stomvision.training.models.BoundingBox.yml | 147 + ...ustomvision.training.models.Classifier.yml | 10 + ...n.training.models.CreateProjectOptions.yml | 139 + ...on.training.models.CustomBaseModelInfo.yml | 137 + ...sion.training.models.CustomVisionError.yml | 292 + ...training.models.CustomVisionErrorCodes.yml | 280 + ...ning.models.CustomVisionErrorException.yml | 28 + ...on.customvision.training.models.Domain.yml | 161 + ...ustomvision.training.models.DomainType.yml | 10 + ...on.customvision.training.models.Export.yml | 165 + ...tomvision.training.models.ExportFlavor.yml | 20 + ...mvision.training.models.ExportPlatform.yml | 18 + ...tomvision.training.models.ExportStatus.yml | 12 + ...ion.customvision.training.models.Image.yml | 172 + ...sion.training.models.ImageCreateResult.yml | 143 + ...sion.training.models.ImageCreateStatus.yml | 32 + ...ion.training.models.ImageCreateSummary.yml | 130 + ...n.training.models.ImageFileCreateBatch.yml | 139 + ...n.training.models.ImageFileCreateEntry.yml | 141 + ...ion.training.models.ImageIdCreateBatch.yml | 139 + ...ion.training.models.ImageIdCreateEntry.yml | 135 + ...aining.models.ImageMetadataUpdateEntry.yml | 141 + ...ining.models.ImageMetadataUpdateStatus.yml | 14 + ...ning.models.ImageMetadataUpdateSummary.yml | 126 + ...ision.training.models.ImagePerformance.yml | 163 + ...vision.training.models.ImagePrediction.yml | 140 + ...raining.models.ImageProcessingSettings.yml | 131 + ...stomvision.training.models.ImageRegion.yml | 170 + ...training.models.ImageRegionCreateBatch.yml | 122 + ...training.models.ImageRegionCreateEntry.yml | 162 + ...raining.models.ImageRegionCreateResult.yml | 173 + ...aining.models.ImageRegionCreateSummary.yml | 135 + ...on.training.models.ImageRegionProposal.yml | 129 + ....customvision.training.models.ImageTag.yml | 129 + ...on.training.models.ImageTagCreateBatch.yml | 123 + ...on.training.models.ImageTagCreateEntry.yml | 130 + ....training.models.ImageTagCreateSummary.yml | 134 + ....customvision.training.models.ImageUrl.yml | 126 + ...on.training.models.ImageUrlCreateBatch.yml | 139 + ...on.training.models.ImageUrlCreateEntry.yml | 138 + ...customvision.training.models.Iteration.yml | 222 + ...n.training.models.IterationPerformance.yml | 148 + ...ision.training.models.ModelInformation.yml | 138 + ...n.customvision.training.models.OrderBy.yml | 12 + ...ustomvision.training.models.Prediction.yml | 143 + ....training.models.PredictionQueryResult.yml | 135 + ...ion.training.models.PredictionQueryTag.yml | 135 + ...n.training.models.PredictionQueryToken.yml | 174 + ...n.customvision.training.models.Project.yml | 182 + ...omvision.training.models.ProjectExport.yml | 152 + ...vision.training.models.ProjectSettings.yml | 184 + ...omvision.training.models.ProjectStatus.yml | 12 + ...on.customvision.training.models.Region.yml | 155 + ...mvision.training.models.RegionProposal.yml | 126 + ...on.customvision.training.models.SortBy.yml | 10 + ....training.models.StoredImagePrediction.yml | 168 + ...ing.models.StoredSuggestedTagAndRegion.yml | 182 + ....training.models.SuggestedTagAndRegion.yml | 146 + ...ning.models.SuggestedTagAndRegionQuery.yml | 137 + ...models.SuggestedTagAndRegionQueryToken.yml | 175 + ...ision.customvision.training.models.Tag.yml | 157 + ...customvision.training.models.TagFilter.yml | 136 + ...mvision.training.models.TagPerformance.yml | 148 + ...n.customvision.training.models.TagType.yml | 12 + ...ion.training.models.TrainingParameters.yml | 134 + ...tomvision.training.models.TrainingType.yml | 10 + ...es.vision.customvision.training.models.yml | 73 + ...tomVisionTrainingClientOperationsMixin.yml | 2710 ++ ...ision.customvision.training.operations.yml | 7 + ...s.vision.customvision.training.version.yml | 4 + ...eservices.vision.customvision.training.yml | 13 + ...veservices.vision.customvision.version.yml | 4 + ....cognitiveservices.vision.customvision.yml | 10 + ...gnitiveservices.vision.face.FaceClient.yml | 65 + ...es.vision.face.FaceClientConfiguration.yml | 62 + ...veservices.vision.face.models.APIError.yml | 122 + ...s.vision.face.models.APIErrorException.yml | 28 + ...eservices.vision.face.models.Accessory.yml | 133 + ...vices.vision.face.models.AccessoryType.yml | 12 + ...ision.face.models.ApplySnapshotRequest.yml | 146 + ...nitiveservices.vision.face.models.Blur.yml | 133 + ...eservices.vision.face.models.BlurLevel.yml | 12 + ...services.vision.face.models.Coordinate.yml | 133 + ...rvices.vision.face.models.DetectedFace.yml | 157 + ...ices.vision.face.models.DetectionModel.yml | 12 + ...iveservices.vision.face.models.Emotion.yml | 169 + ...itiveservices.vision.face.models.Error.yml | 128 + ...veservices.vision.face.models.Exposure.yml | 137 + ...vices.vision.face.models.ExposureLevel.yml | 12 + ...s.vision.face.models.FaceAttributeType.yml | 38 + ...ices.vision.face.models.FaceAttributes.yml | 248 + ...vices.vision.face.models.FaceLandmarks.yml | 287 + ...veservices.vision.face.models.FaceList.yml | 160 + ...vices.vision.face.models.FaceRectangle.yml | 151 + ...services.vision.face.models.FacialHair.yml | 135 + ...ision.face.models.FindSimilarMatchMode.yml | 10 + ....vision.face.models.FindSimilarRequest.yml | 200 + ...tiveservices.vision.face.models.Gender.yml | 10 + ...ervices.vision.face.models.GlassesType.yml | 14 + ...rvices.vision.face.models.GroupRequest.yml | 128 + ...ervices.vision.face.models.GroupResult.yml | 137 + ...nitiveservices.vision.face.models.Hair.yml | 143 + ...eservices.vision.face.models.HairColor.yml | 133 + ...vices.vision.face.models.HairColorType.yml | 22 + ...veservices.vision.face.models.HeadPose.yml | 135 + ...s.vision.face.models.IdentifyCandidate.yml | 137 + ...ces.vision.face.models.IdentifyRequest.yml | 178 + ...ices.vision.face.models.IdentifyResult.yml | 139 + ...veservices.vision.face.models.ImageUrl.yml | 126 + ...vices.vision.face.models.LargeFaceList.yml | 155 + ...es.vision.face.models.LargePersonGroup.yml | 155 + ...tiveservices.vision.face.models.Makeup.yml | 134 + ...nitiveservices.vision.face.models.Mask.yml | 135 + ...veservices.vision.face.models.MaskType.yml | 14 + ...es.vision.face.models.MetaDataContract.yml | 148 + ...on.face.models.NameAndUserDataContract.yml | 132 + ...itiveservices.vision.face.models.Noise.yml | 139 + ...services.vision.face.models.NoiseLevel.yml | 12 + ...eservices.vision.face.models.Occlusion.yml | 142 + ...ces.vision.face.models.OperationStatus.yml | 198 + ...vision.face.models.OperationStatusType.yml | 14 + ...vices.vision.face.models.PersistedFace.yml | 141 + ...tiveservices.vision.face.models.Person.yml | 152 + ...ervices.vision.face.models.PersonGroup.yml | 155 + ...sion.face.models.QualityForRecognition.yml | 12 + ...es.vision.face.models.RecognitionModel.yml | 14 + ...ervices.vision.face.models.SimilarFace.yml | 151 + ...veservices.vision.face.models.Snapshot.yml | 196 + ...s.vision.face.models.SnapshotApplyMode.yml | 8 + ....vision.face.models.SnapshotObjectType.yml | 14 + ...vision.face.models.TakeSnapshotRequest.yml | 163 + ...ices.vision.face.models.TrainingStatus.yml | 186 + ....vision.face.models.TrainingStatusType.yml | 14 + ...s.vision.face.models.UpdateFaceRequest.yml | 125 + ...sion.face.models.UpdateSnapshotRequest.yml | 140 + ...on.face.models.VerifyFaceToFaceRequest.yml | 137 + ....face.models.VerifyFaceToPersonRequest.yml | 164 + ...rvices.vision.face.models.VerifyResult.yml | 145 + ...e.cognitiveservices.vision.face.models.yml | 70 + ...ion.face.operations.FaceListOperations.yml | 661 + ....vision.face.operations.FaceOperations.yml | 963 + ...ace.operations.LargeFaceListOperations.yml | 964 + ....operations.LargePersonGroupOperations.yml | 446 + ...tions.LargePersonGroupPersonOperations.yml | 765 + ....face.operations.PersonGroupOperations.yml | 426 + ...operations.PersonGroupPersonOperations.yml | 802 + ...ion.face.operations.SnapshotOperations.yml | 522 + ...gnitiveservices.vision.face.operations.yml | 14 + ....cognitiveservices.vision.face.version.yml | 4 + .../azure.cognitiveservices.vision.face.yml | 13 + .../azure.common.AzureConflictHttpError.yml | 25 + .../azure.common.AzureException.yml | 20 + .../azure.common.AzureHttpError.yml | 25 + ...e.common.AzureMissingResourceHttpError.yml | 25 + .../azure.common.client_factory.yml | 123 + .../azure-common/azure.common.cloud.yml | 17 + .../azure-common/azure.common.credentials.yml | 52 + .../azure-common/azure.common.exceptions.yml | 4 + .../azure-common/azure.common.yml | 15 + .../azure.profiles.DefaultProfile.yml | 28 + .../azure.profiles.KnownProfiles.yml | 23 + .../azure.profiles.ProfileDefinition.yml | 39 + ...tiapiclient.InvalidMultiApiClientError.yml | 21 + ...les.multiapiclient.MultiApiClientMixin.yml | 18 + .../azure.profiles.multiapiclient.yml | 7 + .../azure-common/azure.profiles.yml | 12 + ...traversal.aio.CommunicationRelayClient.yml | 106 + ...ure.communication.networktraversal.aio.yml | 7 + .../azure.communication.networktraversal.yml | 7 + .../azure-cosmos/azure.cosmos.auth.yml | 42 + .../azure-cosmos/azure.cosmos.base.yml | 255 + .../azure.cosmos.consistent_hash_ring.yml | 6 + .../azure-cosmos/azure.cosmos.constants.yml | 5 + ...zure.cosmos.cosmos_client.CosmosClient.yml | 1866 + .../azure.cosmos.cosmos_client.yml | 7 + .../azure.cosmos.default_retry_policy.yml | 6 + .../azure.cosmos.documents.ConnectionMode.yml | 19 + ...zure.cosmos.documents.ConnectionPolicy.yml | 87 + ...zure.cosmos.documents.ConsistencyLevel.yml | 77 + .../azure.cosmos.documents.DataType.yml | 52 + ...azure.cosmos.documents.DatabaseAccount.yml | 62 + .../azure.cosmos.documents.IndexKind.yml | 30 + ...ure.cosmos.documents.IndexingDirective.yml | 31 + .../azure.cosmos.documents.IndexingMode.yml | 56 + .../azure.cosmos.documents.MediaReadMode.yml | 38 + .../azure.cosmos.documents.PartitionKind.yml | 17 + .../azure.cosmos.documents.PermissionMode.yml | 31 + ...re.cosmos.documents.ProxyConfiguration.yml | 17 + ...zure.cosmos.documents.SSLConfiguration.yml | 25 + ...zure.cosmos.documents.TriggerOperation.yml | 45 + .../azure.cosmos.documents.TriggerType.yml | 24 + .../azure.cosmos.documents.Undefined.yml | 8 + .../azure-cosmos/azure.cosmos.documents.yml | 22 + ...cosmos.endpoint_discovery_retry_policy.yml | 6 + .../azure.cosmos.errors.CosmosError.yml | 21 + .../azure.cosmos.errors.HTTPFailure.yml | 32 + .../azure.cosmos.errors.JSONParseFailure.yml | 21 + ...azure.cosmos.errors.UnexpectedDataType.yml | 21 + .../azure-cosmos/azure.cosmos.errors.yml | 10 + ...e.cosmos.execution_context.aggregators.yml | 6 + ...ecution_context.base_execution_context.yml | 6 + ...os.execution_context.document_producer.yml | 6 + ...s.execution_context.endpoint_component.yml | 6 + ...execution_context.execution_dispatcher.yml | 6 + ...ion_context.multi_execution_aggregator.yml | 6 + ...execution_context.query_execution_info.yml | 6 + .../azure.cosmos.execution_context.yml | 13 + .../azure.cosmos.global_endpoint_manager.yml | 6 + ...rtition_resolver.HashPartitionResolver.yml | 68 + .../azure.cosmos.hash_partition_resolver.yml | 7 + ...re.cosmos.http_constants.CookieHeaders.yml | 12 + ...azure.cosmos.http_constants.Delimiters.yml | 15 + ...s.http_constants.HttpContextProperties.yml | 12 + ...p_constants.HttpHeaderPreferenceTokens.yml | 12 + ...zure.cosmos.http_constants.HttpHeaders.yml | 345 + ....http_constants.HttpListenerErrorCodes.yml | 15 + ...zure.cosmos.http_constants.HttpMethods.yml | 27 + ....http_constants.HttpStatusDescriptions.yml | 81 + ...ure.cosmos.http_constants.QueryStrings.yml | 39 + ...ure.cosmos.http_constants.ResourceType.yml | 64 + ...zure.cosmos.http_constants.StatusCodes.yml | 72 + ...e.cosmos.http_constants.SubStatusCodes.yml | 61 + .../azure.cosmos.http_constants.Versions.yml | 18 + .../azure.cosmos.http_constants.yml | 19 + ...s.location_cache.EndpointOperationType.yml | 17 + ...re.cosmos.location_cache.LocationCache.yml | 131 + .../azure.cosmos.location_cache.yml | 11 + .../azure-cosmos/azure.cosmos.murmur_hash.yml | 6 + .../azure-cosmos/azure.cosmos.partition.yml | 6 + ....query_iterable.QueryIterable.Iterator.yml | 14 + ...re.cosmos.query_iterable.QueryIterable.yml | 103 + .../azure.cosmos.query_iterable.yml | 7 + .../azure-cosmos/azure.cosmos.range.Range.yml | 29 + .../azure-cosmos/azure.cosmos.range.yml | 7 + ...tition_resolver.RangePartitionResolver.yml | 57 + .../azure.cosmos.range_partition_resolver.yml | 7 + .../azure.cosmos.request_object.yml | 5 + ....cosmos.resource_throttle_retry_policy.yml | 6 + ...zure.cosmos.retry_options.RetryOptions.yml | 39 + .../azure.cosmos.retry_options.yml | 7 + .../azure.cosmos.retry_utility.yml | 5 + ....cosmos.routing.collection_routing_map.yml | 6 + ...re.cosmos.routing.routing_map_provider.yml | 6 + .../azure.cosmos.routing.routing_range.yml | 6 + .../azure-cosmos/azure.cosmos.routing.yml | 9 + ...re.cosmos.runtime_constants.MediaTypes.yml | 45 + .../azure.cosmos.runtime_constants.yml | 7 + .../azure.cosmos.session.Session.yml | 34 + .../azure.cosmos.session.SessionContainer.yml | 61 + .../azure-cosmos/azure.cosmos.session.yml | 8 + .../azure.cosmos.session_retry_policy.yml | 6 + .../azure.cosmos.synchronized_request.yml | 59 + .../azure-cosmos/azure.cosmos.utils.yml | 5 + ...ector_session_token.VectorSessionToken.yml | 58 + .../azure.cosmos.vector_session_token.yml | 7 + .../azure-cosmos/azure.cosmos.yml | 37 + .../azure.datalake.store.core.AzureDLFile.yml | 169 + ....datalake.store.core.AzureDLFileSystem.yml | 888 + .../azure.datalake.store.core.AzureDLPath.yml | 57 + .../azure.datalake.store.core.yml | 17 + ....datalake.store.enums.ExpiryOptionType.yml | 14 + .../azure.datalake.store.enums.yml | 6 + ....exceptions.DatalakeBadOffsetException.yml | 7 + ...ns.DatalakeIncompleteTransferException.yml | 7 + ...store.exceptions.DatalakeRESTException.yml | 7 + .../azure.datalake.store.exceptions.yml | 8 + ...talake.store.lib.DatalakeRESTInterface.yml | 144 + .../azure.datalake.store.lib.yml | 15 + .../azure.datalake.store.multiprocessor.yml | 51 + ...talake.store.multithread.ADLDownloader.yml | 189 + ...datalake.store.multithread.ADLUploader.yml | 186 + .../azure.datalake.store.multithread.yml | 107 + ...ake.store.retry.ExponentialRetryPolicy.yml | 26 + ...ure.datalake.store.retry.NoRetryPolicy.yml | 11 + ...azure.datalake.store.retry.RetryPolicy.yml | 11 + .../azure.datalake.store.retry.yml | 9 + ...alake.store.transfer.ADLTransferClient.yml | 303 + .../azure.datalake.store.transfer.Chunk.yml | 42 + .../azure.datalake.store.transfer.File.yml | 42 + ...e.datalake.store.transfer.StateManager.yml | 51 + .../azure.datalake.store.transfer.yml | 10 + ....datalake.store.utils.CountUpDownLatch.yml | 21 + .../azure.datalake.store.utils.yml | 204 + .../azure.datalake.store.yml | 15 + ...re.graphrbac.GraphRbacManagementClient.yml | 70 + ...ement_client.GraphRbacManagementClient.yml | 70 + ...GraphRbacManagementClientConfiguration.yml | 69 + ...graphrbac.graph_rbac_management_client.yml | 7 + .../azure.graphrbac.models.ADGroup.yml | 190 + .../azure.graphrbac.models.ADGroupPaged.yml | 71 + ...re.graphrbac.models.AddOwnerParameters.yml | 143 + .../azure.graphrbac.models.AppRole.yml | 178 + ...re.graphrbac.models.Application(class).yml | 447 + ...azure.graphrbac.models.ApplicationBase.yml | 394 + ...bac.models.ApplicationCreateParameters.yml | 409 + ...zure.graphrbac.models.ApplicationPaged.yml | 71 + ...bac.models.ApplicationUpdateParameters.yml | 406 + ....models.CheckGroupMembershipParameters.yml | 145 + ...rbac.models.CheckGroupMembershipResult.yml | 137 + .../azure.graphrbac.models.ConsentType.yml | 10 + ...azure.graphrbac.models.DirectoryObject.yml | 154 + ....graphrbac.models.DirectoryObjectPaged.yml | 71 + .../azure.graphrbac.models.Domain(class).yml | 153 + .../azure.graphrbac.models.DomainPaged.yml | 71 + ....graphrbac.models.GetObjectsParameters.yml | 149 + .../azure.graphrbac.models.GraphError.yml | 130 + ...e.graphrbac.models.GraphErrorException.yml | 28 + ...phrbac.models.GroupAddMemberParameters.yml | 143 + ...graphrbac.models.GroupCreateParameters.yml | 172 + ....models.GroupGetMemberGroupsParameters.yml | 140 + ...zure.graphrbac.models.InformationalUrl.yml | 149 + .../azure.graphrbac.models.KeyCredential.yml | 178 + ...re.graphrbac.models.KeyCredentialPaged.yml | 71 + ....models.KeyCredentialsUpdateParameters.yml | 126 + ...zure.graphrbac.models.OAuth2Permission.yml | 209 + ...graphrbac.models.OAuth2PermissionGrant.yml | 199 + ...rbac.models.OAuth2PermissionGrantPaged.yml | 71 + .../azure.graphrbac.models.OptionalClaim.yml | 144 + .../azure.graphrbac.models.OptionalClaims.yml | 141 + ...re.graphrbac.models.PasswordCredential.yml | 162 + ...aphrbac.models.PasswordCredentialPaged.yml | 71 + ...ls.PasswordCredentialsUpdateParameters.yml | 126 + ...azure.graphrbac.models.PasswordProfile.yml | 145 + ...phrbac.models.PreAuthorizedApplication.yml | 140 + ...dels.PreAuthorizedApplicationExtension.yml | 125 + ...els.PreAuthorizedApplicationPermission.yml | 133 + ...raphrbac.models.RequiredResourceAccess.yml | 159 + .../azure.graphrbac.models.ResourceAccess.yml | 151 + ...zure.graphrbac.models.ServicePrincipal.yml | 326 + ....graphrbac.models.ServicePrincipalBase.yml | 174 + ...odels.ServicePrincipalCreateParameters.yml | 182 + ...ac.models.ServicePrincipalObjectResult.yml | 133 + ...graphrbac.models.ServicePrincipalPaged.yml | 71 + ...odels.ServicePrincipalUpdateParameters.yml | 172 + .../azure.graphrbac.models.SignInName.yml | 146 + .../azure.graphrbac.models.StrPaged.yml | 70 + .../azure.graphrbac.models.User(class).yml | 246 + .../azure.graphrbac.models.UserBase.yml | 178 + ....graphrbac.models.UserCreateParameters.yml | 230 + ...c.models.UserGetMemberGroupsParameters.yml | 140 + .../azure.graphrbac.models.UserPaged.yml | 71 + .../azure.graphrbac.models.UserType.yml | 10 + ....graphrbac.models.UserUpdateParameters.yml | 220 + ...zure.graphrbac.models.ad_group.ADGroup.yml | 175 + .../azure.graphrbac.models.ad_group.yml | 6 + ...bac.models.ad_group_paged.ADGroupPaged.yml | 71 + .../azure.graphrbac.models.ad_group_paged.yml | 6 + ....graphrbac.models.ad_group_py3.ADGroup.yml | 190 + .../azure.graphrbac.models.ad_group_py3.yml | 6 + ...dd_owner_parameters.AddOwnerParameters.yml | 138 + ....graphrbac.models.add_owner_parameters.yml | 6 + ...wner_parameters_py3.AddOwnerParameters.yml | 143 + ...phrbac.models.add_owner_parameters_py3.yml | 6 + ...zure.graphrbac.models.app_role.AppRole.yml | 163 + .../azure.graphrbac.models.app_role.yml | 6 + ....graphrbac.models.app_role_py3.AppRole.yml | 178 + .../azure.graphrbac.models.app_role_py3.yml | 6 + ...aphrbac.models.application.Application.yml | 369 + .../azure.graphrbac.models.application.yml | 6 + ...odels.application_base.ApplicationBase.yml | 325 + ...zure.graphrbac.models.application_base.yml | 6 + ...s.application_base_py3.ApplicationBase.yml | 394 + ....graphrbac.models.application_base_py3.yml | 6 + ...parameters.ApplicationCreateParameters.yml | 336 + ...c.models.application_create_parameters.yml | 6 + ...meters_py3.ApplicationCreateParameters.yml | 409 + ...dels.application_create_parameters_py3.yml | 6 + ...els.application_paged.ApplicationPaged.yml | 71 + ...ure.graphrbac.models.application_paged.yml | 6 + ...bac.models.application_py3.Application.yml | 447 + ...azure.graphrbac.models.application_py3.yml | 6 + ...parameters.ApplicationUpdateParameters.yml | 333 + ...c.models.application_update_parameters.yml | 6 + ...meters_py3.ApplicationUpdateParameters.yml | 406 + ...dels.application_update_parameters_py3.yml | 6 + ...ameters.CheckGroupMembershipParameters.yml | 137 + ...dels.check_group_membership_parameters.yml | 6 + ...ers_py3.CheckGroupMembershipParameters.yml | 145 + ....check_group_membership_parameters_py3.yml | 6 + ...ship_result.CheckGroupMembershipResult.yml | 131 + ...c.models.check_group_membership_result.yml | 6 + ..._result_py3.CheckGroupMembershipResult.yml | 137 + ...dels.check_group_membership_result_py3.yml | 6 + ...odels.directory_object.DirectoryObject.yml | 151 + ...zure.graphrbac.models.directory_object.yml | 6 + ...tory_object_paged.DirectoryObjectPaged.yml | 71 + ...raphrbac.models.directory_object_paged.yml | 6 + ...s.directory_object_py3.DirectoryObject.yml | 154 + ....graphrbac.models.directory_object_py3.yml | 6 + .../azure.graphrbac.models.domain.Domain.yml | 148 + .../azure.graphrbac.models.domain.yml | 6 + ...phrbac.models.domain_paged.DomainPaged.yml | 71 + .../azure.graphrbac.models.domain_paged.yml | 6 + ...ure.graphrbac.models.domain_py3.Domain.yml | 153 + .../azure.graphrbac.models.domain_py3.yml | 6 + ...bjects_parameters.GetObjectsParameters.yml | 139 + ...raphrbac.models.get_objects_parameters.yml | 6 + ...ts_parameters_py3.GetObjectsParameters.yml | 149 + ...rbac.models.get_objects_parameters_py3.yml | 6 + ...raphrbac.models.graph_error.GraphError.yml | 125 + ...models.graph_error.GraphErrorException.yml | 28 + .../azure.graphrbac.models.graph_error.yml | 7 + ...rbac.models.graph_error_py3.GraphError.yml | 130 + ...ls.graph_error_py3.GraphErrorException.yml | 28 + ...azure.graphrbac.models.graph_error_py3.yml | 7 + ...ac_management_client_enums.ConsentType.yml | 10 + ..._rbac_management_client_enums.UserType.yml | 10 + ...els.graph_rbac_management_client_enums.yml | 7 + ...er_parameters.GroupAddMemberParameters.yml | 138 + ...bac.models.group_add_member_parameters.yml | 6 + ...arameters_py3.GroupAddMemberParameters.yml | 143 + ...models.group_add_member_parameters_py3.yml | 6 + ...reate_parameters.GroupCreateParameters.yml | 164 + ...aphrbac.models.group_create_parameters.yml | 6 + ...e_parameters_py3.GroupCreateParameters.yml | 172 + ...bac.models.group_create_parameters_py3.yml | 6 + ...ameters.GroupGetMemberGroupsParameters.yml | 134 + ...els.group_get_member_groups_parameters.yml | 6 + ...ers_py3.GroupGetMemberGroupsParameters.yml | 140 + ...group_get_member_groups_parameters_py3.yml | 6 + ...els.informational_url.InformationalUrl.yml | 139 + ...ure.graphrbac.models.informational_url.yml | 6 + ...informational_url_py3.InformationalUrl.yml | 149 + ...graphrbac.models.informational_url_py3.yml | 6 + ...ac.models.key_credential.KeyCredential.yml | 159 + .../azure.graphrbac.models.key_credential.yml | 6 + ...ey_credential_paged.KeyCredentialPaged.yml | 71 + ....graphrbac.models.key_credential_paged.yml | 6 + ...odels.key_credential_py3.KeyCredential.yml | 178 + ...re.graphrbac.models.key_credential_py3.yml | 6 + ...ameters.KeyCredentialsUpdateParameters.yml | 123 + ...dels.key_credentials_update_parameters.yml | 6 + ...ers_py3.KeyCredentialsUpdateParameters.yml | 126 + ....key_credentials_update_parameters_py3.yml | 6 + ...els.oauth2_permission.OAuth2Permission.yml | 190 + ...ure.graphrbac.models.oauth2_permission.yml | 6 + ...permission_grant.OAuth2PermissionGrant.yml | 177 + ...aphrbac.models.oauth2_permission_grant.yml | 6 + ...grant_paged.OAuth2PermissionGrantPaged.yml | 71 + ...c.models.oauth2_permission_grant_paged.yml | 6 + ...ission_grant_py3.OAuth2PermissionGrant.yml | 199 + ...bac.models.oauth2_permission_grant_py3.yml | 6 + ...oauth2_permission_py3.OAuth2Permission.yml | 209 + ...graphrbac.models.oauth2_permission_py3.yml | 6 + ...ac.models.optional_claim.OptionalClaim.yml | 134 + .../azure.graphrbac.models.optional_claim.yml | 6 + ...odels.optional_claim_py3.OptionalClaim.yml | 144 + ...re.graphrbac.models.optional_claim_py3.yml | 6 + ....models.optional_claims.OptionalClaims.yml | 134 + ...azure.graphrbac.models.optional_claims.yml | 6 + ...els.optional_claims_py3.OptionalClaims.yml | 141 + ...e.graphrbac.models.optional_claims_py3.yml | 6 + ...password_credential.PasswordCredential.yml | 147 + ...e.graphrbac.models.password_credential.yml | 6 + ...edential_paged.PasswordCredentialPaged.yml | 71 + ...hrbac.models.password_credential_paged.yml | 6 + ...word_credential_py3.PasswordCredential.yml | 162 + ...aphrbac.models.password_credential_py3.yml | 6 + ...rs.PasswordCredentialsUpdateParameters.yml | 123 + ...password_credentials_update_parameters.yml | 6 + ...y3.PasswordCredentialsUpdateParameters.yml | 126 + ...word_credentials_update_parameters_py3.yml | 6 + ...odels.password_profile.PasswordProfile.yml | 137 + ...zure.graphrbac.models.password_profile.yml | 6 + ...s.password_profile_py3.PasswordProfile.yml | 145 + ....graphrbac.models.password_profile_py3.yml | 6 + ...d_application.PreAuthorizedApplication.yml | 132 + ...rbac.models.pre_authorized_application.yml | 6 + ...sion.PreAuthorizedApplicationExtension.yml | 122 + ...s.pre_authorized_application_extension.yml | 6 + ..._py3.PreAuthorizedApplicationExtension.yml | 125 + ...e_authorized_application_extension_py3.yml | 6 + ...ion.PreAuthorizedApplicationPermission.yml | 127 + ....pre_authorized_application_permission.yml | 6 + ...py3.PreAuthorizedApplicationPermission.yml | 133 + ..._authorized_application_permission_py3.yml | 6 + ...plication_py3.PreAuthorizedApplication.yml | 140 + ....models.pre_authorized_application_py3.yml | 6 + ...resource_access.RequiredResourceAccess.yml | 151 + ...phrbac.models.required_resource_access.yml | 6 + ...urce_access_py3.RequiredResourceAccess.yml | 159 + ...ac.models.required_resource_access_py3.yml | 6 + ....models.resource_access.ResourceAccess.yml | 143 + ...azure.graphrbac.models.resource_access.yml | 6 + ...els.resource_access_py3.ResourceAccess.yml | 151 + ...e.graphrbac.models.resource_access_py3.yml | 6 + ...els.service_principal.ServicePrincipal.yml | 281 + ...ure.graphrbac.models.service_principal.yml | 6 + ...ce_principal_base.ServicePrincipalBase.yml | 159 + ...raphrbac.models.service_principal_base.yml | 6 + ...rincipal_base_py3.ServicePrincipalBase.yml | 174 + ...rbac.models.service_principal_base_py3.yml | 6 + ...eters.ServicePrincipalCreateParameters.yml | 165 + ...ls.service_principal_create_parameters.yml | 6 + ...s_py3.ServicePrincipalCreateParameters.yml | 182 + ...ervice_principal_create_parameters_py3.yml | 6 + ...ct_result.ServicePrincipalObjectResult.yml | 127 + ...models.service_principal_object_result.yml | 6 + ...esult_py3.ServicePrincipalObjectResult.yml | 133 + ...ls.service_principal_object_result_py3.yml | 6 + ..._principal_paged.ServicePrincipalPaged.yml | 71 + ...aphrbac.models.service_principal_paged.yml | 6 + ...service_principal_py3.ServicePrincipal.yml | 326 + ...graphrbac.models.service_principal_py3.yml | 6 + ...eters.ServicePrincipalUpdateParameters.yml | 157 + ...ls.service_principal_update_parameters.yml | 6 + ...s_py3.ServicePrincipalUpdateParameters.yml | 172 + ...ervice_principal_update_parameters_py3.yml | 6 + ...aphrbac.models.sign_in_name.SignInName.yml | 138 + .../azure.graphrbac.models.sign_in_name.yml | 6 + ...bac.models.sign_in_name_py3.SignInName.yml | 146 + ...zure.graphrbac.models.sign_in_name_py3.yml | 6 + ...re.graphrbac.models.str_paged.StrPaged.yml | 70 + .../azure.graphrbac.models.str_paged.yml | 6 + .../azure.graphrbac.models.user.User.yml | 218 + .../azure.graphrbac.models.user.yml | 6 + ...re.graphrbac.models.user_base.UserBase.yml | 164 + .../azure.graphrbac.models.user_base.yml | 6 + ...raphrbac.models.user_base_py3.UserBase.yml | 178 + .../azure.graphrbac.models.user_base_py3.yml | 6 + ...create_parameters.UserCreateParameters.yml | 202 + ...raphrbac.models.user_create_parameters.yml | 6 + ...te_parameters_py3.UserCreateParameters.yml | 230 + ...rbac.models.user_create_parameters_py3.yml | 6 + ...rameters.UserGetMemberGroupsParameters.yml | 134 + ...dels.user_get_member_groups_parameters.yml | 6 + ...ters_py3.UserGetMemberGroupsParameters.yml | 140 + ....user_get_member_groups_parameters_py3.yml | 6 + ....graphrbac.models.user_paged.UserPaged.yml | 71 + .../azure.graphrbac.models.user_paged.yml | 6 + .../azure.graphrbac.models.user_py3.User.yml | 246 + .../azure.graphrbac.models.user_py3.yml | 6 + ...update_parameters.UserUpdateParameters.yml | 194 + ...raphrbac.models.user_update_parameters.yml | 6 + ...te_parameters_py3.UserUpdateParameters.yml | 220 + ...rbac.models.user_update_parameters_py3.yml | 6 + .../azure.graphrbac.models.yml | 158 + ...rbac.operations.ApplicationsOperations.yml | 526 + ...erations.DeletedApplicationsOperations.yml | 130 + ...graphrbac.operations.DomainsOperations.yml | 96 + ....graphrbac.operations.GroupsOperations.yml | 527 + ...ations.OAuth2PermissionGrantOperations.yml | 138 + ...graphrbac.operations.ObjectsOperations.yml | 67 + ...operations.ServicePrincipalsOperations.yml | 396 + ...rbac.operations.SignedInUserOperations.yml | 86 + ...e.graphrbac.operations.UsersOperations.yml | 264 + ...ions_operations.ApplicationsOperations.yml | 526 + ...bac.operations.applications_operations.yml | 6 + ...erations.DeletedApplicationsOperations.yml | 130 + ...ations.deleted_applications_operations.yml | 6 + ...s.domains_operations.DomainsOperations.yml | 96 + ...raphrbac.operations.domains_operations.yml | 6 + ...ons.groups_operations.GroupsOperations.yml | 527 + ...graphrbac.operations.groups_operations.yml | 6 + ...ations.OAuth2PermissionGrantOperations.yml | 138 + ...ons.oauth2_permission_grant_operations.yml | 6 + ...s.objects_operations.ObjectsOperations.yml | 67 + ...raphrbac.operations.objects_operations.yml | 6 + ...operations.ServicePrincipalsOperations.yml | 396 + ...erations.service_principals_operations.yml | 6 + ...user_operations.SignedInUserOperations.yml | 86 + ...c.operations.signed_in_user_operations.yml | 6 + ...tions.users_operations.UsersOperations.yml | 264 + ....graphrbac.operations.users_operations.yml | 6 + .../azure.graphrbac.operations.yml | 25 + .../azure.graphrbac.version.yml | 4 + .../azure-graphrbac/azure.graphrbac.yml | 13 + .../azure.iot.modelsrepository.ModelError.yml | 20 + ...odelsrepository.ModelsRepositoryClient.yml | 83 + ....iot.modelsrepository.dtmi_conventions.yml | 45 + ...modelsrepository.exceptions.ModelError.yml | 20 + .../azure.iot.modelsrepository.exceptions.yml | 6 + .../azure.iot.modelsrepository.yml | 11 + .../azure.keyvault.AccessToken.yml | 49 + .../azure.keyvault.CertificateId.yml | 243 + .../azure.keyvault.CertificateIssuerId.yml | 239 + .../azure.keyvault.CertificateOperationId.yml | 239 + .../azure.keyvault.HttpBearerChallenge.yml | 44 + .../azure.keyvault.HttpChallenge.yml | 55 + .../azure-keyvault/azure.keyvault.KeyId.yml | 243 + .../azure.keyvault.KeyVaultAuthBase.yml | 19 + .../azure.keyvault.KeyVaultAuthentication.yml | 60 + .../azure.keyvault.KeyVaultClient.yml | 89 + .../azure.keyvault.KeyVaultId.yml | 242 + .../azure.keyvault.SecretId.yml | 243 + .../azure.keyvault.StorageAccountId.yml | 239 + .../azure.keyvault.StorageSasDefinitionId.yml | 243 + ...p_bearer_challenge.HttpBearerChallenge.yml | 44 + .../azure.keyvault.http_bearer_challenge.yml | 6 + ...e.keyvault.http_bearer_challenge_cache.yml | 43 + ....keyvault.http_challenge.HttpChallenge.yml | 55 + .../azure.keyvault.http_challenge.yml | 6 + ...p_message_security.HttpMessageSecurity.yml | 58 + .../azure.keyvault.http_message_security.yml | 13 + ...t.key_vault_authentication.AccessToken.yml | 49 + ..._vault_authentication.KeyVaultAuthBase.yml | 19 + ..._authentication.KeyVaultAuthentication.yml | 60 + ...zure.keyvault.key_vault_authentication.yml | 8 + ...yvault.key_vault_client.KeyVaultClient.yml | 89 + ...ult_client.KeyVaultClientConfiguration.yml | 59 + .../azure.keyvault.key_vault_client.yml | 7 + ...re.keyvault.key_vault_id.CertificateId.yml | 243 + ...vault.key_vault_id.CertificateIssuerId.yml | 239 + ...lt.key_vault_id.CertificateOperationId.yml | 239 + .../azure.keyvault.key_vault_id.KeyId.yml | 243 + ...lt.key_vault_id.KeyVaultCollectionType.yml | 14 + ...azure.keyvault.key_vault_id.KeyVaultId.yml | 242 + ...yvault.key_vault_id.KeyVaultIdentifier.yml | 233 + .../azure.keyvault.key_vault_id.SecretId.yml | 243 + ...keyvault.key_vault_id.StorageAccountId.yml | 239 + ...lt.key_vault_id.StorageSasDefinitionId.yml | 243 + .../azure.keyvault.key_vault_id.yml | 16 + .../azure-keyvault/azure.keyvault.models.yml | 4 + ...re.keyvault.v2016_10_01.KeyVaultClient.yml | 4005 ++ ..._10_01.key_vault_client.KeyVaultClient.yml | 4005 ++ ...ult_client.KeyVaultClientConfiguration.yml | 59 + ....keyvault.v2016_10_01.key_vault_client.yml | 7 + ...vault.v2016_10_01.models.Action(class).yml | 126 + ...keyvault.v2016_10_01.models.ActionType.yml | 10 + ...2016_10_01.models.AdministratorDetails.yml | 145 + ...t.v2016_10_01.models.Attributes(class).yml | 151 + ...ult.v2016_10_01.models.BackupKeyResult.yml | 124 + ....v2016_10_01.models.BackupSecretResult.yml | 124 + ...016_10_01.models.CertificateAttributes.yml | 169 + ...t.v2016_10_01.models.CertificateBundle.yml | 171 + ..._01.models.CertificateCreateParameters.yml | 140 + ..._01.models.CertificateImportParameters.yml | 163 + ...016_10_01.models.CertificateIssuerItem.yml | 130 + ...0_01.models.CertificateIssuerItemPaged.yml | 71 + ....models.CertificateIssuerSetParameters.yml | 150 + ...dels.CertificateIssuerUpdateParameters.yml | 147 + ...ult.v2016_10_01.models.CertificateItem.yml | 145 + ...2016_10_01.models.CertificateItemPaged.yml | 71 + ...0_01.models.CertificateMergeParameters.yml | 145 + ...2016_10_01.models.CertificateOperation.yml | 192 + ...ls.CertificateOperationUpdateParameter.yml | 128 + ...t.v2016_10_01.models.CertificatePolicy.yml | 175 + ..._01.models.CertificateUpdateParameters.yml | 140 + ...ault.v2016_10_01.models.Contact(class).yml | 138 + ...ult.v2016_10_01.models.Contacts(class).yml | 133 + ..._10_01.models.DeletedCertificateBundle.yml | 192 + ...16_10_01.models.DeletedCertificateItem.yml | 172 + ..._01.models.DeletedCertificateItemPaged.yml | 71 + ...lt.v2016_10_01.models.DeletedKeyBundle.yml | 171 + ...ault.v2016_10_01.models.DeletedKeyItem.yml | 171 + ...v2016_10_01.models.DeletedKeyItemPaged.yml | 71 + ...v2016_10_01.models.DeletedSecretBundle.yml | 192 + ...t.v2016_10_01.models.DeletedSecretItem.yml | 176 + ...16_10_01.models.DeletedSecretItemPaged.yml | 71 + ...016_10_01.models.DeletionRecoveryLevel.yml | 14 + ...yvault.v2016_10_01.models.Error(class).yml | 131 + ...lt.v2016_10_01.models.IssuerAttributes.yml | 137 + ...yvault.v2016_10_01.models.IssuerBundle.yml | 157 + ...t.v2016_10_01.models.IssuerCredentials.yml | 130 + ...lt.v2016_10_01.models.IssuerParameters.yml | 134 + ...keyvault.v2016_10_01.models.JsonWebKey.yml | 238 + ...v2016_10_01.models.JsonWebKeyCurveName.yml | 14 + ...1.models.JsonWebKeyEncryptionAlgorithm.yml | 12 + ...v2016_10_01.models.JsonWebKeyOperation.yml | 18 + ...01.models.JsonWebKeySignatureAlgorithm.yml | 28 + ...ault.v2016_10_01.models.JsonWebKeyType.yml | 16 + ...vault.v2016_10_01.models.KeyAttributes.yml | 166 + ....keyvault.v2016_10_01.models.KeyBundle.yml | 149 + ...v2016_10_01.models.KeyCreateParameters.yml | 173 + ...v2016_10_01.models.KeyImportParameters.yml | 148 + ...re.keyvault.v2016_10_01.models.KeyItem.yml | 149 + ...yvault.v2016_10_01.models.KeyItemPaged.yml | 71 + ....v2016_10_01.models.KeyOperationResult.yml | 127 + ...6_10_01.models.KeyOperationsParameters.yml | 136 + ...vault.v2016_10_01.models.KeyProperties.yml | 149 + ...2016_10_01.models.KeyRestoreParameters.yml | 128 + ...t.v2016_10_01.models.KeySignParameters.yml | 143 + ...v2016_10_01.models.KeyUpdateParameters.yml | 139 + ...yvault.v2016_10_01.models.KeyUsageType.yml | 24 + ...vault.v2016_10_01.models.KeyVaultError.yml | 123 + ...16_10_01.models.KeyVaultErrorException.yml | 28 + ...v2016_10_01.models.KeyVerifyParameters.yml | 147 + ...ult.v2016_10_01.models.KeyVerifyResult.yml | 124 + ...ault.v2016_10_01.models.LifetimeAction.yml | 132 + ...v2016_10_01.models.OrganizationDetails.yml | 130 + ...PendingCertificateSigningRequestResult.yml | 126 + ...6_10_01.models.SasDefinitionAttributes.yml | 137 + ...v2016_10_01.models.SasDefinitionBundle.yml | 144 + ...1.models.SasDefinitionCreateParameters.yml | 143 + ...t.v2016_10_01.models.SasDefinitionItem.yml | 136 + ...16_10_01.models.SasDefinitionItemPaged.yml | 71 + ...1.models.SasDefinitionUpdateParameters.yml | 140 + ...lt.v2016_10_01.models.SecretAttributes.yml | 167 + ...yvault.v2016_10_01.models.SecretBundle.yml | 170 + ...keyvault.v2016_10_01.models.SecretItem.yml | 157 + ...ult.v2016_10_01.models.SecretItemPaged.yml | 71 + ...lt.v2016_10_01.models.SecretProperties.yml | 123 + ...6_10_01.models.SecretRestoreParameters.yml | 128 + ...v2016_10_01.models.SecretSetParameters.yml | 148 + ...16_10_01.models.SecretUpdateParameters.yml | 138 + ..._10_01.models.StorageAccountAttributes.yml | 137 + ....models.StorageAccountCreateParameters.yml | 167 + ....v2016_10_01.models.StorageAccountItem.yml | 136 + ...6_10_01.models.StorageAccountItemPaged.yml | 71 + ...s.StorageAccountRegenerteKeyParameters.yml | 126 + ....models.StorageAccountUpdateParameters.yml | 157 + ...vault.v2016_10_01.models.StorageBundle.yml | 154 + ...6_10_01.models.SubjectAlternativeNames.yml | 137 + ...ault.v2016_10_01.models.Trigger(class).yml | 139 + ...10_01.models.X509CertificateProperties.yml | 157 + ...vault.v2016_10_01.models.action.Action.yml | 123 + ...ure.keyvault.v2016_10_01.models.action.yml | 6 + ...t.v2016_10_01.models.action_py3.Action.yml | 126 + ...keyvault.v2016_10_01.models.action_py3.yml | 6 + ...nistrator_details.AdministratorDetails.yml | 135 + ...016_10_01.models.administrator_details.yml | 6 + ...rator_details_py3.AdministratorDetails.yml | 145 + ...10_01.models.administrator_details_py3.yml | 6 + ...016_10_01.models.attributes.Attributes.yml | 144 + ...keyvault.v2016_10_01.models.attributes.yml | 6 + ...10_01.models.attributes_py3.Attributes.yml | 151 + ...ault.v2016_10_01.models.attributes_py3.yml | 6 + ...dels.backup_key_result.BackupKeyResult.yml | 124 + ...t.v2016_10_01.models.backup_key_result.yml | 6 + ....backup_key_result_py3.BackupKeyResult.yml | 124 + ...016_10_01.models.backup_key_result_py3.yml | 6 + ...ackup_secret_result.BackupSecretResult.yml | 124 + ...2016_10_01.models.backup_secret_result.yml | 6 + ...p_secret_result_py3.BackupSecretResult.yml | 124 + ..._10_01.models.backup_secret_result_py3.yml | 6 + ...icate_attributes.CertificateAttributes.yml | 161 + ...16_10_01.models.certificate_attributes.yml | 6 + ...e_attributes_py3.CertificateAttributes.yml | 169 + ...0_01.models.certificate_attributes_py3.yml | 6 + ...s.certificate_bundle.CertificateBundle.yml | 161 + ....v2016_10_01.models.certificate_bundle.yml | 6 + ...rtificate_bundle_py3.CertificateBundle.yml | 171 + ...16_10_01.models.certificate_bundle_py3.yml | 6 + ...parameters.CertificateCreateParameters.yml | 132 + ...1.models.certificate_create_parameters.yml | 6 + ...meters_py3.CertificateCreateParameters.yml | 140 + ...dels.certificate_create_parameters_py3.yml | 6 + ...parameters.CertificateImportParameters.yml | 151 + ...1.models.certificate_import_parameters.yml | 6 + ...meters_py3.CertificateImportParameters.yml | 163 + ...dels.certificate_import_parameters_py3.yml | 6 + ...cate_issuer_item.CertificateIssuerItem.yml | 125 + ...6_10_01.models.certificate_issuer_item.yml | 6 + ..._item_paged.CertificateIssuerItemPaged.yml | 71 + ...1.models.certificate_issuer_item_paged.yml | 6 + ..._issuer_item_py3.CertificateIssuerItem.yml | 130 + ..._01.models.certificate_issuer_item_py3.yml | 6 + ...ameters.CertificateIssuerSetParameters.yml | 140 + ...dels.certificate_issuer_set_parameters.yml | 6 + ...ers_py3.CertificateIssuerSetParameters.yml | 150 + ....certificate_issuer_set_parameters_py3.yml | 6 + ...ters.CertificateIssuerUpdateParameters.yml | 137 + ...s.certificate_issuer_update_parameters.yml | 6 + ..._py3.CertificateIssuerUpdateParameters.yml | 147 + ...rtificate_issuer_update_parameters_py3.yml | 6 + ...odels.certificate_item.CertificateItem.yml | 135 + ...lt.v2016_10_01.models.certificate_item.yml | 6 + ...ficate_item_paged.CertificateItemPaged.yml | 71 + ...16_10_01.models.certificate_item_paged.yml | 6 + ...s.certificate_item_py3.CertificateItem.yml | 145 + ...2016_10_01.models.certificate_item_py3.yml | 6 + ..._parameters.CertificateMergeParameters.yml | 137 + ...01.models.certificate_merge_parameters.yml | 6 + ...ameters_py3.CertificateMergeParameters.yml | 145 + ...odels.certificate_merge_parameters_py3.yml | 6 + ...ificate_operation.CertificateOperation.yml | 173 + ...016_10_01.models.certificate_operation.yml | 6 + ...ate_operation_py3.CertificateOperation.yml | 192 + ...10_01.models.certificate_operation_py3.yml | 6 + ...er.CertificateOperationUpdateParameter.yml | 125 + ...certificate_operation_update_parameter.yml | 6 + ...y3.CertificateOperationUpdateParameter.yml | 128 + ...ificate_operation_update_parameter_py3.yml | 6 + ...s.certificate_policy.CertificatePolicy.yml | 161 + ....v2016_10_01.models.certificate_policy.yml | 6 + ...rtificate_policy_py3.CertificatePolicy.yml | 175 + ...16_10_01.models.certificate_policy_py3.yml | 6 + ...parameters.CertificateUpdateParameters.yml | 132 + ...1.models.certificate_update_parameters.yml | 6 + ...meters_py3.CertificateUpdateParameters.yml | 140 + ...dels.certificate_update_parameters_py3.yml | 6 + ...ult.v2016_10_01.models.contact.Contact.yml | 130 + ...re.keyvault.v2016_10_01.models.contact.yml | 6 + ...v2016_10_01.models.contact_py3.Contact.yml | 138 + ...eyvault.v2016_10_01.models.contact_py3.yml | 6 + ...t.v2016_10_01.models.contacts.Contacts.yml | 130 + ...e.keyvault.v2016_10_01.models.contacts.yml | 6 + ...016_10_01.models.contacts_py3.Contacts.yml | 133 + ...yvault.v2016_10_01.models.contacts_py3.yml | 6 + ...ficate_bundle.DeletedCertificateBundle.yml | 180 + ...0_01.models.deleted_certificate_bundle.yml | 6 + ...te_bundle_py3.DeletedCertificateBundle.yml | 192 + ....models.deleted_certificate_bundle_py3.yml | 6 + ...ertificate_item.DeletedCertificateItem.yml | 160 + ..._10_01.models.deleted_certificate_item.yml | 6 + ...item_paged.DeletedCertificateItemPaged.yml | 71 + ....models.deleted_certificate_item_paged.yml | 6 + ...ficate_item_py3.DeletedCertificateItem.yml | 172 + ...01.models.deleted_certificate_item_py3.yml | 6 + ...ls.deleted_key_bundle.DeletedKeyBundle.yml | 161 + ....v2016_10_01.models.deleted_key_bundle.yml | 6 + ...eleted_key_bundle_py3.DeletedKeyBundle.yml | 171 + ...16_10_01.models.deleted_key_bundle_py3.yml | 6 + ...models.deleted_key_item.DeletedKeyItem.yml | 161 + ...lt.v2016_10_01.models.deleted_key_item.yml | 6 + ...ted_key_item_paged.DeletedKeyItemPaged.yml | 71 + ...16_10_01.models.deleted_key_item_paged.yml | 6 + ...ls.deleted_key_item_py3.DeletedKeyItem.yml | 171 + ...2016_10_01.models.deleted_key_item_py3.yml | 6 + ...eted_secret_bundle.DeletedSecretBundle.yml | 178 + ...016_10_01.models.deleted_secret_bundle.yml | 6 + ..._secret_bundle_py3.DeletedSecretBundle.yml | 192 + ...10_01.models.deleted_secret_bundle_py3.yml | 6 + ....deleted_secret_item.DeletedSecretItem.yml | 164 + ...v2016_10_01.models.deleted_secret_item.yml | 6 + ...cret_item_paged.DeletedSecretItemPaged.yml | 71 + ...10_01.models.deleted_secret_item_paged.yml | 6 + ...eted_secret_item_py3.DeletedSecretItem.yml | 176 + ...6_10_01.models.deleted_secret_item_py3.yml | 6 + ...eyvault.v2016_10_01.models.error.Error.yml | 131 + ...zure.keyvault.v2016_10_01.models.error.yml | 6 + ...ult.v2016_10_01.models.error_py3.Error.yml | 131 + ....keyvault.v2016_10_01.models.error_py3.yml | 6 + ...els.issuer_attributes.IssuerAttributes.yml | 134 + ...t.v2016_10_01.models.issuer_attributes.yml | 6 + ...issuer_attributes_py3.IssuerAttributes.yml | 137 + ...016_10_01.models.issuer_attributes_py3.yml | 6 + ...0_01.models.issuer_bundle.IssuerBundle.yml | 147 + ...vault.v2016_10_01.models.issuer_bundle.yml | 6 + ....models.issuer_bundle_py3.IssuerBundle.yml | 157 + ...t.v2016_10_01.models.issuer_bundle_py3.yml | 6 + ...s.issuer_credentials.IssuerCredentials.yml | 125 + ....v2016_10_01.models.issuer_credentials.yml | 6 + ...suer_credentials_py3.IssuerCredentials.yml | 130 + ...16_10_01.models.issuer_credentials_py3.yml | 6 + ...els.issuer_parameters.IssuerParameters.yml | 129 + ...t.v2016_10_01.models.issuer_parameters.yml | 6 + ...issuer_parameters_py3.IssuerParameters.yml | 134 + ...016_10_01.models.issuer_parameters_py3.yml | 6 + ...6_10_01.models.json_web_key.JsonWebKey.yml | 202 + ...yvault.v2016_10_01.models.json_web_key.yml | 6 + ..._01.models.json_web_key_py3.JsonWebKey.yml | 238 + ...lt.v2016_10_01.models.json_web_key_py3.yml | 6 + ...01.models.key_attributes.KeyAttributes.yml | 159 + ...ault.v2016_10_01.models.key_attributes.yml | 6 + ...odels.key_attributes_py3.KeyAttributes.yml | 166 + ....v2016_10_01.models.key_attributes_py3.yml | 6 + ...2016_10_01.models.key_bundle.KeyBundle.yml | 142 + ...keyvault.v2016_10_01.models.key_bundle.yml | 6 + ..._10_01.models.key_bundle_py3.KeyBundle.yml | 149 + ...ault.v2016_10_01.models.key_bundle_py3.yml | 6 + ..._create_parameters.KeyCreateParameters.yml | 159 + ...016_10_01.models.key_create_parameters.yml | 6 + ...ate_parameters_py3.KeyCreateParameters.yml | 173 + ...10_01.models.key_create_parameters_py3.yml | 6 + ..._import_parameters.KeyImportParameters.yml | 138 + ...016_10_01.models.key_import_parameters.yml | 6 + ...ort_parameters_py3.KeyImportParameters.yml | 148 + ...10_01.models.key_import_parameters_py3.yml | 6 + ...lt.v2016_10_01.models.key_item.KeyItem.yml | 142 + ...e.keyvault.v2016_10_01.models.key_item.yml | 6 + ..._01.models.key_item_paged.KeyItemPaged.yml | 71 + ...ault.v2016_10_01.models.key_item_paged.yml | 6 + ...2016_10_01.models.key_item_py3.KeyItem.yml | 149 + ...yvault.v2016_10_01.models.key_item_py3.yml | 6 + ...ey_operation_result.KeyOperationResult.yml | 127 + ...2016_10_01.models.key_operation_result.yml | 6 + ...peration_result_py3.KeyOperationResult.yml | 127 + ..._10_01.models.key_operation_result_py3.yml | 6 + ...ons_parameters.KeyOperationsParameters.yml | 131 + ...10_01.models.key_operations_parameters.yml | 6 + ...parameters_py3.KeyOperationsParameters.yml | 136 + ...1.models.key_operations_parameters_py3.yml | 6 + ...01.models.key_properties.KeyProperties.yml | 139 + ...ault.v2016_10_01.models.key_properties.yml | 6 + ...odels.key_properties_py3.KeyProperties.yml | 149 + ....v2016_10_01.models.key_properties_py3.yml | 6 + ...estore_parameters.KeyRestoreParameters.yml | 125 + ...16_10_01.models.key_restore_parameters.yml | 6 + ...re_parameters_py3.KeyRestoreParameters.yml | 128 + ...0_01.models.key_restore_parameters_py3.yml | 6 + ....key_sign_parameters.KeySignParameters.yml | 138 + ...v2016_10_01.models.key_sign_parameters.yml | 6 + ..._sign_parameters_py3.KeySignParameters.yml | 143 + ...6_10_01.models.key_sign_parameters_py3.yml | 6 + ..._update_parameters.KeyUpdateParameters.yml | 132 + ...016_10_01.models.key_update_parameters.yml | 6 + ...ate_parameters_py3.KeyUpdateParameters.yml | 139 + ...10_01.models.key_update_parameters_py3.yml | 6 + ...dels.key_vault_client_enums.ActionType.yml | 10 + ...ult_client_enums.DeletionRecoveryLevel.yml | 14 + ...vault_client_enums.JsonWebKeyCurveName.yml | 14 + ...nt_enums.JsonWebKeyEncryptionAlgorithm.yml | 12 + ...vault_client_enums.JsonWebKeyOperation.yml | 18 + ...ent_enums.JsonWebKeySignatureAlgorithm.yml | 28 + ....key_vault_client_enums.JsonWebKeyType.yml | 16 + ...ls.key_vault_client_enums.KeyUsageType.yml | 24 + ...16_10_01.models.key_vault_client_enums.yml | 13 + ...1.models.key_vault_error.KeyVaultError.yml | 123 + ...key_vault_error.KeyVaultErrorException.yml | 28 + ...ult.v2016_10_01.models.key_vault_error.yml | 7 + ...dels.key_vault_error_py3.KeyVaultError.yml | 123 + ...vault_error_py3.KeyVaultErrorException.yml | 28 + ...v2016_10_01.models.key_vault_error_py3.yml | 7 + ..._verify_parameters.KeyVerifyParameters.yml | 140 + ...016_10_01.models.key_verify_parameters.yml | 6 + ...ify_parameters_py3.KeyVerifyParameters.yml | 147 + ...10_01.models.key_verify_parameters_py3.yml | 6 + ...dels.key_verify_result.KeyVerifyResult.yml | 124 + ...t.v2016_10_01.models.key_verify_result.yml | 6 + ....key_verify_result_py3.KeyVerifyResult.yml | 124 + ...016_10_01.models.key_verify_result_py3.yml | 6 + ....models.lifetime_action.LifetimeAction.yml | 127 + ...ult.v2016_10_01.models.lifetime_action.yml | 6 + ...els.lifetime_action_py3.LifetimeAction.yml | 132 + ...v2016_10_01.models.lifetime_action_py3.yml | 6 + ...ganization_details.OrganizationDetails.yml | 125 + ...2016_10_01.models.organization_details.yml | 6 + ...zation_details_py3.OrganizationDetails.yml | 130 + ..._10_01.models.organization_details_py3.yml | 6 + ...PendingCertificateSigningRequestResult.yml | 126 + ...ing_certificate_signing_request_result.yml | 6 + ...PendingCertificateSigningRequestResult.yml | 126 + ...certificate_signing_request_result_py3.yml | 6 + ...ion_attributes.SasDefinitionAttributes.yml | 134 + ...10_01.models.sas_definition_attributes.yml | 6 + ...attributes_py3.SasDefinitionAttributes.yml | 137 + ...1.models.sas_definition_attributes_py3.yml | 6 + ..._definition_bundle.SasDefinitionBundle.yml | 144 + ...016_10_01.models.sas_definition_bundle.yml | 6 + ...inition_bundle_py3.SasDefinitionBundle.yml | 144 + ...10_01.models.sas_definition_bundle_py3.yml | 6 + ...rameters.SasDefinitionCreateParameters.yml | 135 + ...odels.sas_definition_create_parameters.yml | 6 + ...ters_py3.SasDefinitionCreateParameters.yml | 143 + ...s.sas_definition_create_parameters_py3.yml | 6 + ....sas_definition_item.SasDefinitionItem.yml | 136 + ...v2016_10_01.models.sas_definition_item.yml | 6 + ...tion_item_paged.SasDefinitionItemPaged.yml | 71 + ...10_01.models.sas_definition_item_paged.yml | 6 + ..._definition_item_py3.SasDefinitionItem.yml | 136 + ...6_10_01.models.sas_definition_item_py3.yml | 6 + ...rameters.SasDefinitionUpdateParameters.yml | 132 + ...odels.sas_definition_update_parameters.yml | 6 + ...ters_py3.SasDefinitionUpdateParameters.yml | 140 + ...s.sas_definition_update_parameters_py3.yml | 6 + ...els.secret_attributes.SecretAttributes.yml | 159 + ...t.v2016_10_01.models.secret_attributes.yml | 6 + ...secret_attributes_py3.SecretAttributes.yml | 167 + ...016_10_01.models.secret_attributes_py3.yml | 6 + ...0_01.models.secret_bundle.SecretBundle.yml | 158 + ...vault.v2016_10_01.models.secret_bundle.yml | 6 + ....models.secret_bundle_py3.SecretBundle.yml | 170 + ...t.v2016_10_01.models.secret_bundle_py3.yml | 6 + ...16_10_01.models.secret_item.SecretItem.yml | 147 + ...eyvault.v2016_10_01.models.secret_item.yml | 6 + ...dels.secret_item_paged.SecretItemPaged.yml | 71 + ...t.v2016_10_01.models.secret_item_paged.yml | 6 + ...0_01.models.secret_item_py3.SecretItem.yml | 157 + ...ult.v2016_10_01.models.secret_item_py3.yml | 6 + ...els.secret_properties.SecretProperties.yml | 120 + ...t.v2016_10_01.models.secret_properties.yml | 6 + ...secret_properties_py3.SecretProperties.yml | 123 + ...016_10_01.models.secret_properties_py3.yml | 6 + ...ore_parameters.SecretRestoreParameters.yml | 125 + ...10_01.models.secret_restore_parameters.yml | 6 + ...parameters_py3.SecretRestoreParameters.yml | 128 + ...1.models.secret_restore_parameters_py3.yml | 6 + ...ret_set_parameters.SecretSetParameters.yml | 138 + ...016_10_01.models.secret_set_parameters.yml | 6 + ...set_parameters_py3.SecretSetParameters.yml | 148 + ...10_01.models.secret_set_parameters_py3.yml | 6 + ...date_parameters.SecretUpdateParameters.yml | 130 + ..._10_01.models.secret_update_parameters.yml | 6 + ..._parameters_py3.SecretUpdateParameters.yml | 138 + ...01.models.secret_update_parameters_py3.yml | 6 + ...nt_attributes.StorageAccountAttributes.yml | 134 + ...0_01.models.storage_account_attributes.yml | 6 + ...ttributes_py3.StorageAccountAttributes.yml | 137 + ....models.storage_account_attributes_py3.yml | 6 + ...ameters.StorageAccountCreateParameters.yml | 152 + ...dels.storage_account_create_parameters.yml | 6 + ...ers_py3.StorageAccountCreateParameters.yml | 167 + ....storage_account_create_parameters_py3.yml | 6 + ...torage_account_item.StorageAccountItem.yml | 136 + ...2016_10_01.models.storage_account_item.yml | 6 + ...unt_item_paged.StorageAccountItemPaged.yml | 71 + ...0_01.models.storage_account_item_paged.yml | 6 + ...ge_account_item_py3.StorageAccountItem.yml | 136 + ..._10_01.models.storage_account_item_py3.yml | 6 + ...s.StorageAccountRegenerteKeyParameters.yml | 123 + ...orage_account_regenerte_key_parameters.yml | 6 + ...3.StorageAccountRegenerteKeyParameters.yml | 126 + ...e_account_regenerte_key_parameters_py3.yml | 6 + ...ameters.StorageAccountUpdateParameters.yml | 144 + ...dels.storage_account_update_parameters.yml | 6 + ...ers_py3.StorageAccountUpdateParameters.yml | 157 + ....storage_account_update_parameters_py3.yml | 6 + ...01.models.storage_bundle.StorageBundle.yml | 154 + ...ault.v2016_10_01.models.storage_bundle.yml | 6 + ...odels.storage_bundle_py3.StorageBundle.yml | 154 + ....v2016_10_01.models.storage_bundle_py3.yml | 6 + ...ernative_names.SubjectAlternativeNames.yml | 130 + ...10_01.models.subject_alternative_names.yml | 6 + ...tive_names_py3.SubjectAlternativeNames.yml | 137 + ...1.models.subject_alternative_names_py3.yml | 6 + ...ult.v2016_10_01.models.trigger.Trigger.yml | 133 + ...re.keyvault.v2016_10_01.models.trigger.yml | 6 + ...v2016_10_01.models.trigger_py3.Trigger.yml | 139 + ...eyvault.v2016_10_01.models.trigger_py3.yml | 6 + ...e_properties.X509CertificateProperties.yml | 145 + ..._01.models.x509_certificate_properties.yml | 6 + ...operties_py3.X509CertificateProperties.yml | 157 + ...models.x509_certificate_properties_py3.yml | 6 + .../azure.keyvault.v2016_10_01.models.yml | 246 + .../azure.keyvault.v2016_10_01.version.yml | 4 + .../azure.keyvault.v2016_10_01.yml | 12 + .../azure.keyvault.v7_0.KeyVaultClient.yml | 4611 ++ ...t.v7_0.key_vault_client.KeyVaultClient.yml | 4611 ++ ...ult_client.KeyVaultClientConfiguration.yml | 59 + .../azure.keyvault.v7_0.key_vault_client.yml | 7 + ...ure.keyvault.v7_0.models.Action(class).yml | 126 + .../azure.keyvault.v7_0.models.ActionType.yml | 10 + ...vault.v7_0.models.AdministratorDetails.yml | 145 + ...keyvault.v7_0.models.Attributes(class).yml | 151 + ...lt.v7_0.models.BackupCertificateResult.yml | 124 + ...e.keyvault.v7_0.models.BackupKeyResult.yml | 124 + ...eyvault.v7_0.models.BackupSecretResult.yml | 124 + ...yvault.v7_0.models.BackupStorageResult.yml | 124 + ...ault.v7_0.models.CertificateAttributes.yml | 169 + ...keyvault.v7_0.models.CertificateBundle.yml | 171 + ...7_0.models.CertificateCreateParameters.yml | 140 + ...7_0.models.CertificateImportParameters.yml | 163 + ...ault.v7_0.models.CertificateIssuerItem.yml | 130 + ...v7_0.models.CertificateIssuerItemPaged.yml | 71 + ....models.CertificateIssuerSetParameters.yml | 150 + ...dels.CertificateIssuerUpdateParameters.yml | 147 + ...e.keyvault.v7_0.models.CertificateItem.yml | 145 + ...vault.v7_0.models.CertificateItemPaged.yml | 71 + ...v7_0.models.CertificateMergeParameters.yml | 145 + ...vault.v7_0.models.CertificateOperation.yml | 192 + ...ls.CertificateOperationUpdateParameter.yml | 128 + ...keyvault.v7_0.models.CertificatePolicy.yml | 175 + ..._0.models.CertificateRestoreParameters.yml | 128 + ...7_0.models.CertificateUpdateParameters.yml | 140 + ...re.keyvault.v7_0.models.Contact(class).yml | 138 + ...e.keyvault.v7_0.models.Contacts(class).yml | 133 + ...t.v7_0.models.DeletedCertificateBundle.yml | 192 + ...ult.v7_0.models.DeletedCertificateItem.yml | 172 + ...7_0.models.DeletedCertificateItemPaged.yml | 71 + ....keyvault.v7_0.models.DeletedKeyBundle.yml | 171 + ...re.keyvault.v7_0.models.DeletedKeyItem.yml | 171 + ...yvault.v7_0.models.DeletedKeyItemPaged.yml | 71 + ...v7_0.models.DeletedSasDefinitionBundle.yml | 180 + ...t.v7_0.models.DeletedSasDefinitionItem.yml | 159 + ...0.models.DeletedSasDefinitionItemPaged.yml | 71 + ...yvault.v7_0.models.DeletedSecretBundle.yml | 192 + ...keyvault.v7_0.models.DeletedSecretItem.yml | 176 + ...ult.v7_0.models.DeletedSecretItemPaged.yml | 71 + ....v7_0.models.DeletedStorageAccountItem.yml | 159 + ....models.DeletedStorageAccountItemPaged.yml | 71 + ...vault.v7_0.models.DeletedStorageBundle.yml | 175 + ...ault.v7_0.models.DeletionRecoveryLevel.yml | 14 + ...zure.keyvault.v7_0.models.Error(class).yml | 131 + ....keyvault.v7_0.models.IssuerAttributes.yml | 137 + ...zure.keyvault.v7_0.models.IssuerBundle.yml | 157 + ...keyvault.v7_0.models.IssuerCredentials.yml | 130 + ....keyvault.v7_0.models.IssuerParameters.yml | 144 + .../azure.keyvault.v7_0.models.JsonWebKey.yml | 240 + ...yvault.v7_0.models.JsonWebKeyCurveName.yml | 14 + ...0.models.JsonWebKeyEncryptionAlgorithm.yml | 12 + ...yvault.v7_0.models.JsonWebKeyOperation.yml | 18 + ..._0.models.JsonWebKeySignatureAlgorithm.yml | 28 + ...re.keyvault.v7_0.models.JsonWebKeyType.yml | 16 + ...ure.keyvault.v7_0.models.KeyAttributes.yml | 166 + .../azure.keyvault.v7_0.models.KeyBundle.yml | 149 + ...yvault.v7_0.models.KeyCreateParameters.yml | 173 + ...yvault.v7_0.models.KeyImportParameters.yml | 148 + .../azure.keyvault.v7_0.models.KeyItem.yml | 149 + ...zure.keyvault.v7_0.models.KeyItemPaged.yml | 71 + ...eyvault.v7_0.models.KeyOperationResult.yml | 127 + ...lt.v7_0.models.KeyOperationsParameters.yml | 136 + ...ure.keyvault.v7_0.models.KeyProperties.yml | 164 + ...vault.v7_0.models.KeyRestoreParameters.yml | 128 + ...keyvault.v7_0.models.KeySignParameters.yml | 143 + ...yvault.v7_0.models.KeyUpdateParameters.yml | 139 + ...zure.keyvault.v7_0.models.KeyUsageType.yml | 24 + ...ure.keyvault.v7_0.models.KeyVaultError.yml | 123 + ...ult.v7_0.models.KeyVaultErrorException.yml | 28 + ...yvault.v7_0.models.KeyVerifyParameters.yml | 147 + ...e.keyvault.v7_0.models.KeyVerifyResult.yml | 124 + ...re.keyvault.v7_0.models.LifetimeAction.yml | 132 + ...yvault.v7_0.models.OrganizationDetails.yml | 130 + ...PendingCertificateSigningRequestResult.yml | 126 + ...lt.v7_0.models.SasDefinitionAttributes.yml | 154 + ...yvault.v7_0.models.SasDefinitionBundle.yml | 159 + ...0.models.SasDefinitionCreateParameters.yml | 164 + ...keyvault.v7_0.models.SasDefinitionItem.yml | 136 + ...ult.v7_0.models.SasDefinitionItemPaged.yml | 71 + ...0.models.SasDefinitionUpdateParameters.yml | 161 + ...zure.keyvault.v7_0.models.SasTokenType.yml | 10 + ....keyvault.v7_0.models.SecretAttributes.yml | 167 + ...zure.keyvault.v7_0.models.SecretBundle.yml | 170 + .../azure.keyvault.v7_0.models.SecretItem.yml | 157 + ...e.keyvault.v7_0.models.SecretItemPaged.yml | 71 + ....keyvault.v7_0.models.SecretProperties.yml | 123 + ...lt.v7_0.models.SecretRestoreParameters.yml | 128 + ...yvault.v7_0.models.SecretSetParameters.yml | 148 + ...ult.v7_0.models.SecretUpdateParameters.yml | 138 + ...t.v7_0.models.StorageAccountAttributes.yml | 154 + ....models.StorageAccountCreateParameters.yml | 167 + ...eyvault.v7_0.models.StorageAccountItem.yml | 136 + ...lt.v7_0.models.StorageAccountItemPaged.yml | 71 + ...s.StorageAccountRegenerteKeyParameters.yml | 126 + ....models.StorageAccountUpdateParameters.yml | 157 + ...ure.keyvault.v7_0.models.StorageBundle.yml | 154 + ...t.v7_0.models.StorageRestoreParameters.yml | 128 + ...lt.v7_0.models.SubjectAlternativeNames.yml | 137 + ...re.keyvault.v7_0.models.Trigger(class).yml | 139 + ....v7_0.models.X509CertificateProperties.yml | 157 + ...ure.keyvault.v7_0.models.action.Action.yml | 123 + .../azure.keyvault.v7_0.models.action.yml | 6 + ...keyvault.v7_0.models.action_py3.Action.yml | 126 + .../azure.keyvault.v7_0.models.action_py3.yml | 6 + ...nistrator_details.AdministratorDetails.yml | 135 + ...ault.v7_0.models.administrator_details.yml | 6 + ...rator_details_py3.AdministratorDetails.yml | 145 + ....v7_0.models.administrator_details_py3.yml | 6 + ...ault.v7_0.models.attributes.Attributes.yml | 144 + .../azure.keyvault.v7_0.models.attributes.yml | 6 + ....v7_0.models.attributes_py3.Attributes.yml | 151 + ...re.keyvault.v7_0.models.attributes_py3.yml | 6 + ...ificate_result.BackupCertificateResult.yml | 124 + ....v7_0.models.backup_certificate_result.yml | 6 + ...ate_result_py3.BackupCertificateResult.yml | 124 + ...0.models.backup_certificate_result_py3.yml | 6 + ...dels.backup_key_result.BackupKeyResult.yml | 124 + ...keyvault.v7_0.models.backup_key_result.yml | 6 + ....backup_key_result_py3.BackupKeyResult.yml | 124 + ...ault.v7_0.models.backup_key_result_py3.yml | 6 + ...ackup_secret_result.BackupSecretResult.yml | 124 + ...vault.v7_0.models.backup_secret_result.yml | 6 + ...p_secret_result_py3.BackupSecretResult.yml | 124 + ...t.v7_0.models.backup_secret_result_py3.yml | 6 + ...kup_storage_result.BackupStorageResult.yml | 124 + ...ault.v7_0.models.backup_storage_result.yml | 6 + ...storage_result_py3.BackupStorageResult.yml | 124 + ....v7_0.models.backup_storage_result_py3.yml | 6 + ...icate_attributes.CertificateAttributes.yml | 161 + ...ult.v7_0.models.certificate_attributes.yml | 6 + ...e_attributes_py3.CertificateAttributes.yml | 169 + ...v7_0.models.certificate_attributes_py3.yml | 6 + ...s.certificate_bundle.CertificateBundle.yml | 161 + ...eyvault.v7_0.models.certificate_bundle.yml | 6 + ...rtificate_bundle_py3.CertificateBundle.yml | 171 + ...ult.v7_0.models.certificate_bundle_py3.yml | 6 + ...parameters.CertificateCreateParameters.yml | 132 + ...0.models.certificate_create_parameters.yml | 6 + ...meters_py3.CertificateCreateParameters.yml | 140 + ...dels.certificate_create_parameters_py3.yml | 6 + ...parameters.CertificateImportParameters.yml | 151 + ...0.models.certificate_import_parameters.yml | 6 + ...meters_py3.CertificateImportParameters.yml | 163 + ...dels.certificate_import_parameters_py3.yml | 6 + ...cate_issuer_item.CertificateIssuerItem.yml | 125 + ...lt.v7_0.models.certificate_issuer_item.yml | 6 + ..._item_paged.CertificateIssuerItemPaged.yml | 71 + ...0.models.certificate_issuer_item_paged.yml | 6 + ..._issuer_item_py3.CertificateIssuerItem.yml | 130 + ...7_0.models.certificate_issuer_item_py3.yml | 6 + ...ameters.CertificateIssuerSetParameters.yml | 140 + ...dels.certificate_issuer_set_parameters.yml | 6 + ...ers_py3.CertificateIssuerSetParameters.yml | 150 + ....certificate_issuer_set_parameters_py3.yml | 6 + ...ters.CertificateIssuerUpdateParameters.yml | 137 + ...s.certificate_issuer_update_parameters.yml | 6 + ..._py3.CertificateIssuerUpdateParameters.yml | 147 + ...rtificate_issuer_update_parameters_py3.yml | 6 + ...odels.certificate_item.CertificateItem.yml | 135 + ....keyvault.v7_0.models.certificate_item.yml | 6 + ...ficate_item_paged.CertificateItemPaged.yml | 71 + ...ult.v7_0.models.certificate_item_paged.yml | 6 + ...s.certificate_item_py3.CertificateItem.yml | 145 + ...vault.v7_0.models.certificate_item_py3.yml | 6 + ..._parameters.CertificateMergeParameters.yml | 137 + ..._0.models.certificate_merge_parameters.yml | 6 + ...ameters_py3.CertificateMergeParameters.yml | 145 + ...odels.certificate_merge_parameters_py3.yml | 6 + ...ificate_operation.CertificateOperation.yml | 173 + ...ault.v7_0.models.certificate_operation.yml | 6 + ...ate_operation_py3.CertificateOperation.yml | 192 + ....v7_0.models.certificate_operation_py3.yml | 6 + ...er.CertificateOperationUpdateParameter.yml | 125 + ...certificate_operation_update_parameter.yml | 6 + ...y3.CertificateOperationUpdateParameter.yml | 128 + ...ificate_operation_update_parameter_py3.yml | 6 + ...s.certificate_policy.CertificatePolicy.yml | 161 + ...eyvault.v7_0.models.certificate_policy.yml | 6 + ...rtificate_policy_py3.CertificatePolicy.yml | 175 + ...ult.v7_0.models.certificate_policy_py3.yml | 6 + ...arameters.CertificateRestoreParameters.yml | 125 + ....models.certificate_restore_parameters.yml | 6 + ...eters_py3.CertificateRestoreParameters.yml | 128 + ...els.certificate_restore_parameters_py3.yml | 6 + ...parameters.CertificateUpdateParameters.yml | 132 + ...0.models.certificate_update_parameters.yml | 6 + ...meters_py3.CertificateUpdateParameters.yml | 140 + ...dels.certificate_update_parameters_py3.yml | 6 + ...e.keyvault.v7_0.models.contact.Contact.yml | 130 + .../azure.keyvault.v7_0.models.contact.yml | 6 + ...yvault.v7_0.models.contact_py3.Contact.yml | 138 + ...azure.keyvault.v7_0.models.contact_py3.yml | 6 + ...keyvault.v7_0.models.contacts.Contacts.yml | 130 + .../azure.keyvault.v7_0.models.contacts.yml | 6 + ...ault.v7_0.models.contacts_py3.Contacts.yml | 133 + ...zure.keyvault.v7_0.models.contacts_py3.yml | 6 + ...ficate_bundle.DeletedCertificateBundle.yml | 180 + ...v7_0.models.deleted_certificate_bundle.yml | 6 + ...te_bundle_py3.DeletedCertificateBundle.yml | 192 + ....models.deleted_certificate_bundle_py3.yml | 6 + ...ertificate_item.DeletedCertificateItem.yml | 160 + ...t.v7_0.models.deleted_certificate_item.yml | 6 + ...item_paged.DeletedCertificateItemPaged.yml | 71 + ....models.deleted_certificate_item_paged.yml | 6 + ...ficate_item_py3.DeletedCertificateItem.yml | 172 + ..._0.models.deleted_certificate_item_py3.yml | 6 + ...ls.deleted_key_bundle.DeletedKeyBundle.yml | 161 + ...eyvault.v7_0.models.deleted_key_bundle.yml | 6 + ...eleted_key_bundle_py3.DeletedKeyBundle.yml | 171 + ...ult.v7_0.models.deleted_key_bundle_py3.yml | 6 + ...models.deleted_key_item.DeletedKeyItem.yml | 161 + ....keyvault.v7_0.models.deleted_key_item.yml | 6 + ...ted_key_item_paged.DeletedKeyItemPaged.yml | 71 + ...ult.v7_0.models.deleted_key_item_paged.yml | 6 + ...ls.deleted_key_item_py3.DeletedKeyItem.yml | 171 + ...vault.v7_0.models.deleted_key_item_py3.yml | 6 + ...tion_bundle.DeletedSasDefinitionBundle.yml | 177 + ...0.models.deleted_sas_definition_bundle.yml | 6 + ..._bundle_py3.DeletedSasDefinitionBundle.yml | 180 + ...dels.deleted_sas_definition_bundle_py3.yml | 6 + ...finition_item.DeletedSasDefinitionItem.yml | 156 + ...7_0.models.deleted_sas_definition_item.yml | 6 + ...em_paged.DeletedSasDefinitionItemPaged.yml | 71 + ...dels.deleted_sas_definition_item_paged.yml | 6 + ...tion_item_py3.DeletedSasDefinitionItem.yml | 159 + ...models.deleted_sas_definition_item_py3.yml | 6 + ...eted_secret_bundle.DeletedSecretBundle.yml | 178 + ...ault.v7_0.models.deleted_secret_bundle.yml | 6 + ..._secret_bundle_py3.DeletedSecretBundle.yml | 192 + ....v7_0.models.deleted_secret_bundle_py3.yml | 6 + ....deleted_secret_item.DeletedSecretItem.yml | 164 + ...yvault.v7_0.models.deleted_secret_item.yml | 6 + ...cret_item_paged.DeletedSecretItemPaged.yml | 71 + ....v7_0.models.deleted_secret_item_paged.yml | 6 + ...eted_secret_item_py3.DeletedSecretItem.yml | 176 + ...lt.v7_0.models.deleted_secret_item_py3.yml | 6 + ...account_item.DeletedStorageAccountItem.yml | 156 + ..._0.models.deleted_storage_account_item.yml | 6 + ...m_paged.DeletedStorageAccountItemPaged.yml | 71 + ...els.deleted_storage_account_item_paged.yml | 6 + ...unt_item_py3.DeletedStorageAccountItem.yml | 159 + ...odels.deleted_storage_account_item_py3.yml | 6 + ...ed_storage_bundle.DeletedStorageBundle.yml | 172 + ...ult.v7_0.models.deleted_storage_bundle.yml | 6 + ...torage_bundle_py3.DeletedStorageBundle.yml | 175 + ...v7_0.models.deleted_storage_bundle_py3.yml | 6 + ...azure.keyvault.v7_0.models.error.Error.yml | 131 + .../azure.keyvault.v7_0.models.error.yml | 6 + ...e.keyvault.v7_0.models.error_py3.Error.yml | 131 + .../azure.keyvault.v7_0.models.error_py3.yml | 6 + ...els.issuer_attributes.IssuerAttributes.yml | 134 + ...keyvault.v7_0.models.issuer_attributes.yml | 6 + ...issuer_attributes_py3.IssuerAttributes.yml | 137 + ...ault.v7_0.models.issuer_attributes_py3.yml | 6 + ...v7_0.models.issuer_bundle.IssuerBundle.yml | 147 + ...ure.keyvault.v7_0.models.issuer_bundle.yml | 6 + ....models.issuer_bundle_py3.IssuerBundle.yml | 157 + ...keyvault.v7_0.models.issuer_bundle_py3.yml | 6 + ...s.issuer_credentials.IssuerCredentials.yml | 125 + ...eyvault.v7_0.models.issuer_credentials.yml | 6 + ...suer_credentials_py3.IssuerCredentials.yml | 130 + ...ult.v7_0.models.issuer_credentials_py3.yml | 6 + ...els.issuer_parameters.IssuerParameters.yml | 136 + ...keyvault.v7_0.models.issuer_parameters.yml | 6 + ...issuer_parameters_py3.IssuerParameters.yml | 144 + ...ault.v7_0.models.issuer_parameters_py3.yml | 6 + ...lt.v7_0.models.json_web_key.JsonWebKey.yml | 204 + ...zure.keyvault.v7_0.models.json_web_key.yml | 6 + ...7_0.models.json_web_key_py3.JsonWebKey.yml | 240 + ....keyvault.v7_0.models.json_web_key_py3.yml | 6 + ..._0.models.key_attributes.KeyAttributes.yml | 159 + ...re.keyvault.v7_0.models.key_attributes.yml | 6 + ...odels.key_attributes_py3.KeyAttributes.yml | 166 + ...eyvault.v7_0.models.key_attributes_py3.yml | 6 + ...vault.v7_0.models.key_bundle.KeyBundle.yml | 142 + .../azure.keyvault.v7_0.models.key_bundle.yml | 6 + ...t.v7_0.models.key_bundle_py3.KeyBundle.yml | 149 + ...re.keyvault.v7_0.models.key_bundle_py3.yml | 6 + ..._create_parameters.KeyCreateParameters.yml | 159 + ...ault.v7_0.models.key_create_parameters.yml | 6 + ...ate_parameters_py3.KeyCreateParameters.yml | 173 + ....v7_0.models.key_create_parameters_py3.yml | 6 + ..._import_parameters.KeyImportParameters.yml | 138 + ...ault.v7_0.models.key_import_parameters.yml | 6 + ...ort_parameters_py3.KeyImportParameters.yml | 148 + ....v7_0.models.key_import_parameters_py3.yml | 6 + ....keyvault.v7_0.models.key_item.KeyItem.yml | 142 + .../azure.keyvault.v7_0.models.key_item.yml | 6 + ...7_0.models.key_item_paged.KeyItemPaged.yml | 71 + ...re.keyvault.v7_0.models.key_item_paged.yml | 6 + ...vault.v7_0.models.key_item_py3.KeyItem.yml | 149 + ...zure.keyvault.v7_0.models.key_item_py3.yml | 6 + ...ey_operation_result.KeyOperationResult.yml | 127 + ...vault.v7_0.models.key_operation_result.yml | 6 + ...peration_result_py3.KeyOperationResult.yml | 127 + ...t.v7_0.models.key_operation_result_py3.yml | 6 + ...ons_parameters.KeyOperationsParameters.yml | 131 + ....v7_0.models.key_operations_parameters.yml | 6 + ...parameters_py3.KeyOperationsParameters.yml | 136 + ...0.models.key_operations_parameters_py3.yml | 6 + ..._0.models.key_properties.KeyProperties.yml | 152 + ...re.keyvault.v7_0.models.key_properties.yml | 6 + ...odels.key_properties_py3.KeyProperties.yml | 164 + ...eyvault.v7_0.models.key_properties_py3.yml | 6 + ...estore_parameters.KeyRestoreParameters.yml | 125 + ...ult.v7_0.models.key_restore_parameters.yml | 6 + ...re_parameters_py3.KeyRestoreParameters.yml | 128 + ...v7_0.models.key_restore_parameters_py3.yml | 6 + ....key_sign_parameters.KeySignParameters.yml | 138 + ...yvault.v7_0.models.key_sign_parameters.yml | 6 + ..._sign_parameters_py3.KeySignParameters.yml | 143 + ...lt.v7_0.models.key_sign_parameters_py3.yml | 6 + ..._update_parameters.KeyUpdateParameters.yml | 132 + ...ault.v7_0.models.key_update_parameters.yml | 6 + ...ate_parameters_py3.KeyUpdateParameters.yml | 139 + ....v7_0.models.key_update_parameters_py3.yml | 6 + ...dels.key_vault_client_enums.ActionType.yml | 10 + ...ult_client_enums.DeletionRecoveryLevel.yml | 14 + ...vault_client_enums.JsonWebKeyCurveName.yml | 14 + ...nt_enums.JsonWebKeyEncryptionAlgorithm.yml | 12 + ...vault_client_enums.JsonWebKeyOperation.yml | 18 + ...ent_enums.JsonWebKeySignatureAlgorithm.yml | 28 + ....key_vault_client_enums.JsonWebKeyType.yml | 16 + ...ls.key_vault_client_enums.KeyUsageType.yml | 24 + ...ls.key_vault_client_enums.SasTokenType.yml | 10 + ...ult.v7_0.models.key_vault_client_enums.yml | 14 + ...0.models.key_vault_error.KeyVaultError.yml | 123 + ...key_vault_error.KeyVaultErrorException.yml | 28 + ...e.keyvault.v7_0.models.key_vault_error.yml | 7 + ...dels.key_vault_error_py3.KeyVaultError.yml | 123 + ...vault_error_py3.KeyVaultErrorException.yml | 28 + ...yvault.v7_0.models.key_vault_error_py3.yml | 7 + ..._verify_parameters.KeyVerifyParameters.yml | 140 + ...ault.v7_0.models.key_verify_parameters.yml | 6 + ...ify_parameters_py3.KeyVerifyParameters.yml | 147 + ....v7_0.models.key_verify_parameters_py3.yml | 6 + ...dels.key_verify_result.KeyVerifyResult.yml | 124 + ...keyvault.v7_0.models.key_verify_result.yml | 6 + ....key_verify_result_py3.KeyVerifyResult.yml | 124 + ...ault.v7_0.models.key_verify_result_py3.yml | 6 + ....models.lifetime_action.LifetimeAction.yml | 127 + ...e.keyvault.v7_0.models.lifetime_action.yml | 6 + ...els.lifetime_action_py3.LifetimeAction.yml | 132 + ...yvault.v7_0.models.lifetime_action_py3.yml | 6 + ...ganization_details.OrganizationDetails.yml | 125 + ...vault.v7_0.models.organization_details.yml | 6 + ...zation_details_py3.OrganizationDetails.yml | 130 + ...t.v7_0.models.organization_details_py3.yml | 6 + ...PendingCertificateSigningRequestResult.yml | 126 + ...ing_certificate_signing_request_result.yml | 6 + ...PendingCertificateSigningRequestResult.yml | 126 + ...certificate_signing_request_result_py3.yml | 6 + ...ion_attributes.SasDefinitionAttributes.yml | 151 + ....v7_0.models.sas_definition_attributes.yml | 6 + ...attributes_py3.SasDefinitionAttributes.yml | 154 + ...0.models.sas_definition_attributes_py3.yml | 6 + ..._definition_bundle.SasDefinitionBundle.yml | 159 + ...ault.v7_0.models.sas_definition_bundle.yml | 6 + ...inition_bundle_py3.SasDefinitionBundle.yml | 159 + ....v7_0.models.sas_definition_bundle_py3.yml | 6 + ...rameters.SasDefinitionCreateParameters.yml | 152 + ...odels.sas_definition_create_parameters.yml | 6 + ...ters_py3.SasDefinitionCreateParameters.yml | 164 + ...s.sas_definition_create_parameters_py3.yml | 6 + ....sas_definition_item.SasDefinitionItem.yml | 136 + ...yvault.v7_0.models.sas_definition_item.yml | 6 + ...tion_item_paged.SasDefinitionItemPaged.yml | 71 + ....v7_0.models.sas_definition_item_paged.yml | 6 + ..._definition_item_py3.SasDefinitionItem.yml | 136 + ...lt.v7_0.models.sas_definition_item_py3.yml | 6 + ...rameters.SasDefinitionUpdateParameters.yml | 149 + ...odels.sas_definition_update_parameters.yml | 6 + ...ters_py3.SasDefinitionUpdateParameters.yml | 161 + ...s.sas_definition_update_parameters_py3.yml | 6 + ...els.secret_attributes.SecretAttributes.yml | 159 + ...keyvault.v7_0.models.secret_attributes.yml | 6 + ...secret_attributes_py3.SecretAttributes.yml | 167 + ...ault.v7_0.models.secret_attributes_py3.yml | 6 + ...v7_0.models.secret_bundle.SecretBundle.yml | 158 + ...ure.keyvault.v7_0.models.secret_bundle.yml | 6 + ....models.secret_bundle_py3.SecretBundle.yml | 170 + ...keyvault.v7_0.models.secret_bundle_py3.yml | 6 + ...ult.v7_0.models.secret_item.SecretItem.yml | 147 + ...azure.keyvault.v7_0.models.secret_item.yml | 6 + ...dels.secret_item_paged.SecretItemPaged.yml | 71 + ...keyvault.v7_0.models.secret_item_paged.yml | 6 + ...v7_0.models.secret_item_py3.SecretItem.yml | 157 + ...e.keyvault.v7_0.models.secret_item_py3.yml | 6 + ...els.secret_properties.SecretProperties.yml | 120 + ...keyvault.v7_0.models.secret_properties.yml | 6 + ...secret_properties_py3.SecretProperties.yml | 123 + ...ault.v7_0.models.secret_properties_py3.yml | 6 + ...ore_parameters.SecretRestoreParameters.yml | 125 + ....v7_0.models.secret_restore_parameters.yml | 6 + ...parameters_py3.SecretRestoreParameters.yml | 128 + ...0.models.secret_restore_parameters_py3.yml | 6 + ...ret_set_parameters.SecretSetParameters.yml | 138 + ...ault.v7_0.models.secret_set_parameters.yml | 6 + ...set_parameters_py3.SecretSetParameters.yml | 148 + ....v7_0.models.secret_set_parameters_py3.yml | 6 + ...date_parameters.SecretUpdateParameters.yml | 130 + ...t.v7_0.models.secret_update_parameters.yml | 6 + ..._parameters_py3.SecretUpdateParameters.yml | 138 + ..._0.models.secret_update_parameters_py3.yml | 6 + ...nt_attributes.StorageAccountAttributes.yml | 151 + ...v7_0.models.storage_account_attributes.yml | 6 + ...ttributes_py3.StorageAccountAttributes.yml | 154 + ....models.storage_account_attributes_py3.yml | 6 + ...ameters.StorageAccountCreateParameters.yml | 152 + ...dels.storage_account_create_parameters.yml | 6 + ...ers_py3.StorageAccountCreateParameters.yml | 167 + ....storage_account_create_parameters_py3.yml | 6 + ...torage_account_item.StorageAccountItem.yml | 136 + ...vault.v7_0.models.storage_account_item.yml | 6 + ...unt_item_paged.StorageAccountItemPaged.yml | 71 + ...v7_0.models.storage_account_item_paged.yml | 6 + ...ge_account_item_py3.StorageAccountItem.yml | 136 + ...t.v7_0.models.storage_account_item_py3.yml | 6 + ...s.StorageAccountRegenerteKeyParameters.yml | 123 + ...orage_account_regenerte_key_parameters.yml | 6 + ...3.StorageAccountRegenerteKeyParameters.yml | 126 + ...e_account_regenerte_key_parameters_py3.yml | 6 + ...ameters.StorageAccountUpdateParameters.yml | 144 + ...dels.storage_account_update_parameters.yml | 6 + ...ers_py3.StorageAccountUpdateParameters.yml | 157 + ....storage_account_update_parameters_py3.yml | 6 + ..._0.models.storage_bundle.StorageBundle.yml | 154 + ...re.keyvault.v7_0.models.storage_bundle.yml | 6 + ...odels.storage_bundle_py3.StorageBundle.yml | 154 + ...eyvault.v7_0.models.storage_bundle_py3.yml | 6 + ...re_parameters.StorageRestoreParameters.yml | 125 + ...v7_0.models.storage_restore_parameters.yml | 6 + ...arameters_py3.StorageRestoreParameters.yml | 128 + ....models.storage_restore_parameters_py3.yml | 6 + ...ernative_names.SubjectAlternativeNames.yml | 130 + ....v7_0.models.subject_alternative_names.yml | 6 + ...tive_names_py3.SubjectAlternativeNames.yml | 137 + ...0.models.subject_alternative_names_py3.yml | 6 + ...e.keyvault.v7_0.models.trigger.Trigger.yml | 133 + .../azure.keyvault.v7_0.models.trigger.yml | 6 + ...yvault.v7_0.models.trigger_py3.Trigger.yml | 139 + ...azure.keyvault.v7_0.models.trigger_py3.yml | 6 + ...e_properties.X509CertificateProperties.yml | 145 + ...7_0.models.x509_certificate_properties.yml | 6 + ...operties_py3.X509CertificateProperties.yml | 157 + ...models.x509_certificate_properties_py3.yml | 6 + .../azure.keyvault.v7_0.models.yml | 275 + .../azure.keyvault.v7_0.version.yml | 4 + .../azure-keyvault/azure.keyvault.v7_0.yml | 12 + .../azure-keyvault/azure.keyvault.version.yml | 4 + .../azure-keyvault/azure.keyvault.yml | 40 + ...re.loganalytics.LogAnalyticsDataClient.yml | 83 + ...ics_data_client.LogAnalyticsDataClient.yml | 83 + ...nt.LogAnalyticsDataClientConfiguration.yml | 60 + ...loganalytics.log_analytics_data_client.yml | 7 + ...zure.loganalytics.models.Column(class).yml | 133 + .../azure.loganalytics.models.ErrorDetail.yml | 167 + .../azure.loganalytics.models.ErrorInfo.yml | 154 + ...zure.loganalytics.models.ErrorResponse.yml | 129 + ...nalytics.models.ErrorResponseException.yml | 28 + .../azure.loganalytics.models.QueryBody.yml | 146 + ...azure.loganalytics.models.QueryResults.yml | 129 + ...azure.loganalytics.models.Table(class).yml | 143 + ...zure.loganalytics.models.column.Column.yml | 128 + .../azure.loganalytics.models.column.yml | 6 + ....loganalytics.models.column_py3.Column.yml | 133 + .../azure.loganalytics.models.column_py3.yml | 6 + ...lytics.models.error_detail.ErrorDetail.yml | 153 + ...azure.loganalytics.models.error_detail.yml | 6 + ...cs.models.error_detail_py3.ErrorDetail.yml | 167 + ...e.loganalytics.models.error_detail_py3.yml | 6 + ...ganalytics.models.error_info.ErrorInfo.yml | 142 + .../azure.loganalytics.models.error_info.yml | 6 + ...lytics.models.error_info_py3.ErrorInfo.yml | 154 + ...ure.loganalytics.models.error_info_py3.yml | 6 + ...cs.models.error_response.ErrorResponse.yml | 126 + ....error_response.ErrorResponseException.yml | 28 + ...ure.loganalytics.models.error_response.yml | 7 + ...odels.error_response_py3.ErrorResponse.yml | 129 + ...or_response_py3.ErrorResponseException.yml | 28 + ...loganalytics.models.error_response_py3.yml | 7 + ...ganalytics.models.query_body.QueryBody.yml | 139 + .../azure.loganalytics.models.query_body.yml | 6 + ...lytics.models.query_body_py3.QueryBody.yml | 146 + ...ure.loganalytics.models.query_body_py3.yml | 6 + ...tics.models.query_results.QueryResults.yml | 126 + ...zure.loganalytics.models.query_results.yml | 6 + ....models.query_results_py3.QueryResults.yml | 129 + ....loganalytics.models.query_results_py3.yml | 6 + .../azure.loganalytics.models.table.Table.yml | 136 + .../azure.loganalytics.models.table.yml | 6 + ...re.loganalytics.models.table_py3.Table.yml | 143 + .../azure.loganalytics.models.table_py3.yml | 6 + .../azure.loganalytics.models.yml | 29 + .../azure.loganalytics.version.yml | 4 + .../azure-loganalytics/azure.loganalytics.yml | 12 + ...ia.videoanalyzeredge.CertificateSource.yml | 128 + ...redge.CognitiveServicesVisionProcessor.yml | 195 + ...edia.videoanalyzeredge.CredentialsBase.yml | 128 + ...ideoanalyzeredge.DiscoveredOnvifDevice.yml | 168 + ...eredge.DiscoveredOnvifDeviceCollection.yml | 132 + ...e.media.videoanalyzeredge.EndpointBase.yml | 145 + ...deoanalyzeredge.ExtensionProcessorBase.yml | 189 + ...azure.media.videoanalyzeredge.FileSink.yml | 188 + ....media.videoanalyzeredge.GrpcExtension.yml | 215 + ...analyzeredge.GrpcExtensionDataTransfer.yml | 148 + ...yzeredge.GrpcExtensionDataTransferMode.yml | 11 + ...ia.videoanalyzeredge.H264Configuration.yml | 139 + ...re.media.videoanalyzeredge.H264Profile.yml | 15 + ....media.videoanalyzeredge.HttpExtension.yml | 185 + ...ideoanalyzeredge.HttpHeaderCredentials.yml | 150 + ...media.videoanalyzeredge.ImageFormatBmp.yml | 123 + ...edia.videoanalyzeredge.ImageFormatJpeg.yml | 132 + ...media.videoanalyzeredge.ImageFormatPng.yml | 123 + ...ideoanalyzeredge.ImageFormatProperties.yml | 128 + ...media.videoanalyzeredge.ImageFormatRaw.yml | 145 + ...analyzeredge.ImageFormatRawPixelFormat.yml | 29 + ...edia.videoanalyzeredge.ImageProperties.yml | 133 + ...ure.media.videoanalyzeredge.ImageScale.yml | 149 + ...media.videoanalyzeredge.ImageScaleMode.yml | 13 + ...deoanalyzeredge.IotHubDeviceConnection.yml | 149 + ...ia.videoanalyzeredge.IotHubMessageSink.yml | 163 + ....videoanalyzeredge.IotHubMessageSource.yml | 142 + ...ideoanalyzeredge.LineCrossingProcessor.yml | 159 + ...e.media.videoanalyzeredge.LivePipeline.yml | 145 + ...alyzeredge.LivePipelineActivateRequest.yml | 150 + ...deoanalyzeredge.LivePipelineCollection.yml | 143 + ...yzeredge.LivePipelineDeactivateRequest.yml | 150 + ...analyzeredge.LivePipelineDeleteRequest.yml | 150 + ...deoanalyzeredge.LivePipelineGetRequest.yml | 150 + ...eoanalyzeredge.LivePipelineListRequest.yml | 141 + ...deoanalyzeredge.LivePipelineProperties.yml | 183 + ...deoanalyzeredge.LivePipelineSetRequest.yml | 137 + ...nalyzeredge.LivePipelineSetRequestBody.yml | 168 + ...ia.videoanalyzeredge.LivePipelineState.yml | 15 + ...a.videoanalyzeredge.MPEG4Configuration.yml | 135 + ...e.media.videoanalyzeredge.MPEG4Profile.yml | 11 + ...e.media.videoanalyzeredge.MediaProfile.yml | 144 + ...azure.media.videoanalyzeredge.MediaUri.yml | 124 + ....media.videoanalyzeredge.MethodRequest.yml | 149 + ...nalyzeredge.MethodRequestEmptyBodyBase.yml | 157 + ...oanalyzeredge.MotionDetectionProcessor.yml | 194 + ...nalyzeredge.MotionDetectionSensitivity.yml | 13 + ....media.videoanalyzeredge.NamedLineBase.yml | 137 + ...edia.videoanalyzeredge.NamedLineString.yml | 158 + ...dia.videoanalyzeredge.NamedPolygonBase.yml | 137 + ...a.videoanalyzeredge.NamedPolygonString.yml | 152 + ...zure.media.videoanalyzeredge.NodeInput.yml | 147 + ...deoanalyzeredge.ObjectTrackingAccuracy.yml | 16 + ...eoanalyzeredge.ObjectTrackingProcessor.yml | 171 + ...re.media.videoanalyzeredge.OnvifDevice.yml | 150 + ...nalyzeredge.OnvifDeviceDiscoverRequest.yml | 155 + ...ideoanalyzeredge.OnvifDeviceGetRequest.yml | 150 + ...azure.media.videoanalyzeredge.OnvifDns.yml | 141 + ....media.videoanalyzeredge.OnvifHostName.yml | 133 + ....videoanalyzeredge.OnvifSystemDateTime.yml | 149 + ...eoanalyzeredge.OnvifSystemDateTimeType.yml | 12 + ...media.videoanalyzeredge.OutputSelector.yml | 155 + ...deoanalyzeredge.OutputSelectorOperator.yml | 11 + ...deoanalyzeredge.OutputSelectorProperty.yml | 9 + ...videoanalyzeredge.ParameterDeclaration.yml | 167 + ....videoanalyzeredge.ParameterDefinition.yml | 136 + ....media.videoanalyzeredge.ParameterType.yml | 17 + ...a.videoanalyzeredge.PemCertificateList.yml | 133 + ...dia.videoanalyzeredge.PipelineTopology.yml | 149 + ...nalyzeredge.PipelineTopologyCollection.yml | 143 + ...yzeredge.PipelineTopologyDeleteRequest.yml | 150 + ...nalyzeredge.PipelineTopologyGetRequest.yml | 150 + ...alyzeredge.PipelineTopologyListRequest.yml | 141 + ...nalyzeredge.PipelineTopologyProperties.yml | 201 + ...nalyzeredge.PipelineTopologySetRequest.yml | 165 + ...zeredge.PipelineTopologySetRequestBody.yml | 163 + ...ia.videoanalyzeredge.ProcessorNodeBase.yml | 152 + ...re.media.videoanalyzeredge.RateControl.yml | 160 + ....videoanalyzeredge.RemoteDeviceAdapter.yml | 147 + ...yzeredge.RemoteDeviceAdapterCollection.yml | 143 + ...redge.RemoteDeviceAdapterDeleteRequest.yml | 150 + ...yzeredge.RemoteDeviceAdapterGetRequest.yml | 150 + ...zeredge.RemoteDeviceAdapterListRequest.yml | 141 + ...yzeredge.RemoteDeviceAdapterProperties.yml | 154 + ...yzeredge.RemoteDeviceAdapterSetRequest.yml | 150 + ...edge.RemoteDeviceAdapterSetRequestBody.yml | 170 + ...analyzeredge.RemoteDeviceAdapterTarget.yml | 127 + ...ure.media.videoanalyzeredge.RtspSource.yml | 188 + ....media.videoanalyzeredge.RtspTransport.yml | 20 + ...edia.videoanalyzeredge.SamplingOptions.yml | 159 + ....videoanalyzeredge.SignalGateProcessor.yml | 235 + ...e.media.videoanalyzeredge.SinkNodeBase.yml | 151 + ...media.videoanalyzeredge.SourceNodeBase.yml | 137 + ...zeredge.SpatialAnalysisCustomOperation.yml | 139 + ...lyzeredge.SpatialAnalysisOperationBase.yml | 128 + ...edge.SpatialAnalysisOperationEventBase.yml | 140 + ...yzeredge.SpatialAnalysisOperationFocus.yml | 13 + ...eredge.SpatialAnalysisPersonCountEvent.yml | 158 + ...SpatialAnalysisPersonCountEventTrigger.yml | 11 + ...ge.SpatialAnalysisPersonCountOperation.yml | 199 + ...e.SpatialAnalysisPersonCountZoneEvents.yml | 136 + ...dge.SpatialAnalysisPersonDistanceEvent.yml | 175 + ...tialAnalysisPersonDistanceEventTrigger.yml | 11 + ...SpatialAnalysisPersonDistanceOperation.yml | 199 + ...patialAnalysisPersonDistanceZoneEvents.yml | 136 + ...SpatialAnalysisPersonLineCrossingEvent.yml | 139 + ...alAnalysisPersonLineCrossingLineEvents.yml | 136 + ...ialAnalysisPersonLineCrossingOperation.yml | 199 + ...SpatialAnalysisPersonZoneCrossingEvent.yml | 150 + ...ialAnalysisPersonZoneCrossingEventType.yml | 11 + ...ialAnalysisPersonZoneCrossingOperation.yml | 199 + ...alAnalysisPersonZoneCrossingZoneEvents.yml | 136 + ...edge.SpatialAnalysisTypedOperationBase.yml | 193 + ...eoanalyzeredge.SymmetricKeyCredentials.yml | 132 + ...ure.media.videoanalyzeredge.SystemData.yml | 142 + ...re.media.videoanalyzeredge.TlsEndpoint.yml | 174 + ...videoanalyzeredge.TlsValidationOptions.yml | 145 + ...ia.videoanalyzeredge.UnsecuredEndpoint.yml | 142 + ...alyzeredge.UsernamePasswordCredentials.yml | 152 + ...eoanalyzeredge.VideoCreationProperties.yml | 206 + ...analyzeredge.VideoEncoderConfiguration.yml | 175 + ....media.videoanalyzeredge.VideoEncoding.yml | 13 + ...deoanalyzeredge.VideoPublishingOptions.yml | 130 + ...edia.videoanalyzeredge.VideoResolution.yml | 133 + ...zure.media.videoanalyzeredge.VideoSink.yml | 235 + .../azure.media.videoanalyzeredge.yml | 132 + ...mt.agfood.AzureAgFoodPlatformRPService.yml | 50 + ...gfood.aio.AzureAgFoodPlatformRPService.yml | 50 + ...od.aio.operations.ExtensionsOperations.yml | 215 + ...erations.FarmBeatsExtensionsOperations.yml | 102 + ...o.operations.FarmBeatsModelsOperations.yml | 218 + ...ood.aio.operations.LocationsOperations.yml | 57 + ....mgmt.agfood.aio.operations.Operations.yml | 51 + .../azure.mgmt.agfood.aio.operations.yml | 11 + .../azure.mgmt.agfood.aio.yml | 9 + .../azure.mgmt.agfood.models.ActionType.yml | 10 + ...ood.models.CheckNameAvailabilityReason.yml | 11 + ...od.models.CheckNameAvailabilityRequest.yml | 25 + ...d.models.CheckNameAvailabilityResponse.yml | 36 + ...azure.mgmt.agfood.models.CreatedByType.yml | 15 + ...mgmt.agfood.models.DetailedInformation.yml | 48 + ...mgmt.agfood.models.ErrorAdditionalInfo.yml | 20 + .../azure.mgmt.agfood.models.ErrorDetail.yml | 32 + ...azure.mgmt.agfood.models.ErrorResponse.yml | 18 + .../azure.mgmt.agfood.models.Extension.yml | 57 + ...mt.agfood.models.ExtensionListResponse.yml | 27 + .../azure.mgmt.agfood.models.FarmBeats.yml | 63 + ....mgmt.agfood.models.FarmBeatsExtension.yml | 79 + ....models.FarmBeatsExtensionListResponse.yml | 28 + ...mt.agfood.models.FarmBeatsListResponse.yml | 27 + ...ood.models.FarmBeatsUpdateRequestModel.yml | 25 + .../azure.mgmt.agfood.models.Operation.yml | 54 + ...re.mgmt.agfood.models.OperationDisplay.yml | 37 + ...mgmt.agfood.models.OperationListResult.yml | 21 + .../azure.mgmt.agfood.models.Origin.yml | 16 + ...e.mgmt.agfood.models.ProvisioningState.yml | 11 + ...azure.mgmt.agfood.models.ProxyResource.yml | 30 + .../azure.mgmt.agfood.models.Resource.yml | 30 + .../azure.mgmt.agfood.models.SystemData.yml | 61 + ...ure.mgmt.agfood.models.TrackedResource.yml | 49 + ...ure.mgmt.agfood.models.UnitSystemsInfo.yml | 27 + .../azure.mgmt.agfood.models.yml | 33 + ...agfood.operations.ExtensionsOperations.yml | 215 + ...erations.FarmBeatsExtensionsOperations.yml | 102 + ...d.operations.FarmBeatsModelsOperations.yml | 218 + ....agfood.operations.LocationsOperations.yml | 57 + ...zure.mgmt.agfood.operations.Operations.yml | 51 + .../azure.mgmt.agfood.operations.yml | 11 + .../azure-mgmt-agfood/azure.mgmt.agfood.yml | 11 + .../azure.mgmt.app.ContainerAppsAPIClient.yml | 77 + ...re.mgmt.app.aio.ContainerAppsAPIClient.yml | 77 + ....aio.operations.CertificatesOperations.yml | 219 + ...ons.ContainerAppsAuthConfigsOperations.yml | 178 + ...aio.operations.ContainerAppsOperations.yml | 323 + ...ontainerAppsRevisionReplicasOperations.yml | 110 + ...tions.ContainerAppsRevisionsOperations.yml | 206 + ....ContainerAppsSourceControlsOperations.yml | 224 + ...io.operations.DaprComponentsOperations.yml | 178 + ...erations.ManagedEnvironmentsOperations.yml | 258 + ....ManagedEnvironmentsStoragesOperations.yml | 175 + ...ure.mgmt.app.aio.operations.Operations.yml | 51 + .../azure.mgmt.app.aio.operations.yml | 16 + .../azure-mgmt-app/azure.mgmt.app.aio.yml | 9 + .../azure.mgmt.app.models.AccessMode.yml | 11 + ...re.mgmt.app.models.ActiveRevisionsMode.yml | 18 + ....app.models.AllowedAudiencesValidation.yml | 23 + ...zure.mgmt.app.models.AllowedPrincipals.yml | 27 + ...e.mgmt.app.models.AppLogsConfiguration.yml | 27 + .../azure.mgmt.app.models.AppProtocol.yml | 14 + .../azure.mgmt.app.models.AppRegistration.yml | 28 + .../azure.mgmt.app.models.Apple.yml | 39 + ...zure.mgmt.app.models.AppleRegistration.yml | 27 + .../azure.mgmt.app.models.AuthConfig.yml | 103 + ...e.mgmt.app.models.AuthConfigCollection.yml | 28 + .../azure.mgmt.app.models.AuthPlatform.yml | 49 + ...re.mgmt.app.models.AvailableOperations.yml | 31 + ...e.mgmt.app.models.AzureActiveDirectory.yml | 82 + ...t.app.models.AzureActiveDirectoryLogin.yml | 39 + ...odels.AzureActiveDirectoryRegistration.yml | 140 + ....models.AzureActiveDirectoryValidation.yml | 49 + ...azure.mgmt.app.models.AzureCredentials.yml | 44 + ...re.mgmt.app.models.AzureFileProperties.yml | 48 + ...ure.mgmt.app.models.AzureStaticWebApps.yml | 33 + ....models.AzureStaticWebAppsRegistration.yml | 19 + .../azure.mgmt.app.models.BindingType.yml | 11 + .../azure.mgmt.app.models.Certificate.yml | 65 + ....mgmt.app.models.CertificateCollection.yml | 28 + ...azure.mgmt.app.models.CertificatePatch.yml | 20 + ....mgmt.app.models.CertificateProperties.yml | 65 + ...pp.models.CertificateProvisioningState.yml | 17 + ...ure.mgmt.app.models.ClientRegistration.yml | 28 + .../azure.mgmt.app.models.Configuration.yml | 78 + .../azure.mgmt.app.models.Container.yml | 77 + .../azure.mgmt.app.models.ContainerApp.yml | 121 + ...mgmt.app.models.ContainerAppCollection.yml | 28 + ...zure.mgmt.app.models.ContainerAppPatch.yml | 20 + ...zure.mgmt.app.models.ContainerAppProbe.yml | 170 + ...mt.app.models.ContainerAppProbeHttpGet.yml | 67 + ...ontainerAppProbeHttpGetHttpHeadersItem.yml | 29 + ....app.models.ContainerAppProbeTcpSocket.yml | 35 + ...p.models.ContainerAppProvisioningState.yml | 15 + ...ure.mgmt.app.models.ContainerAppSecret.yml | 20 + ...ure.mgmt.app.models.ContainerResources.yml | 34 + ...azure.mgmt.app.models.CookieExpiration.yml | 37 + ....app.models.CookieExpirationConvention.yml | 11 + .../azure.mgmt.app.models.CreatedByType.yml | 15 + .../azure.mgmt.app.models.CustomDomain.yml | 48 + ...pp.models.CustomHostnameAnalysisResult.yml | 113 + ...app.models.CustomOpenIdConnectProvider.yml | 54 + .../azure.mgmt.app.models.CustomScaleRule.yml | 39 + .../azure.mgmt.app.models.Dapr.yml | 51 + .../azure.mgmt.app.models.DaprComponent.yml | 95 + ...mt.app.models.DaprComponentsCollection.yml | 28 + .../azure.mgmt.app.models.DaprMetadata.yml | 41 + ....app.models.DefaultAuthorizationPolicy.yml | 36 + ...e.mgmt.app.models.DefaultErrorResponse.yml | 16 + ...t.app.models.DefaultErrorResponseError.yml | 38 + ...s.DefaultErrorResponseErrorDetailsItem.yml | 24 + ...t.app.models.DnsVerificationTestResult.yml | 13 + ...pp.models.EnvironmentProvisioningState.yml | 27 + .../azure.mgmt.app.models.EnvironmentVar.yml | 40 + .../azure.mgmt.app.models.Facebook.yml | 52 + .../azure.mgmt.app.models.ForwardProxy.yml | 43 + ...mgmt.app.models.ForwardProxyConvention.yml | 13 + .../azure.mgmt.app.models.GitHub.yml | 42 + ...t.app.models.GithubActionConfiguration.yml | 70 + ...azure.mgmt.app.models.GlobalValidation.yml | 70 + .../azure.mgmt.app.models.Google.yml | 55 + .../azure.mgmt.app.models.HttpScaleRule.yml | 27 + .../azure.mgmt.app.models.HttpSettings.yml | 42 + ...ure.mgmt.app.models.HttpSettingsRoutes.yml | 20 + ...zure.mgmt.app.models.IdentityProviders.yml | 93 + .../azure.mgmt.app.models.Ingress.yml | 78 + ...mgmt.app.models.IngressTransportMethod.yml | 13 + .../azure.mgmt.app.models.JwtClaimChecks.yml | 28 + ...t.app.models.LogAnalyticsConfiguration.yml | 27 + .../azure.mgmt.app.models.Login.yml | 73 + .../azure.mgmt.app.models.LoginRoutes.yml | 18 + .../azure.mgmt.app.models.LoginScopes.yml | 19 + ...ure.mgmt.app.models.ManagedEnvironment.yml | 116 + ...gmt.app.models.ManagedEnvironmentPatch.yml | 20 + ...t.app.models.ManagedEnvironmentStorage.yml | 45 + ...ls.ManagedEnvironmentStorageProperties.yml | 19 + ...s.ManagedEnvironmentStoragesCollection.yml | 22 + ...p.models.ManagedEnvironmentsCollection.yml | 28 + ...mgmt.app.models.ManagedServiceIdentity.yml | 72 + ....app.models.ManagedServiceIdentityType.yml | 18 + .../azure.mgmt.app.models.Nonce.yml | 35 + ...p.models.OpenIdConnectClientCredential.yml | 37 + ...re.mgmt.app.models.OpenIdConnectConfig.yml | 59 + ...ure.mgmt.app.models.OpenIdConnectLogin.yml | 28 + ...t.app.models.OpenIdConnectRegistration.yml | 43 + .../azure.mgmt.app.models.OperationDetail.yml | 43 + ...azure.mgmt.app.models.OperationDisplay.yml | 43 + .../azure.mgmt.app.models.ProxyResource.yml | 36 + .../azure.mgmt.app.models.QueueScaleRule.yml | 35 + ...re.mgmt.app.models.RegistryCredentials.yml | 35 + .../azure.mgmt.app.models.RegistryInfo.yml | 35 + .../azure.mgmt.app.models.Replica.yml | 48 + ...zure.mgmt.app.models.ReplicaCollection.yml | 21 + ...azure.mgmt.app.models.ReplicaContainer.yml | 52 + .../azure.mgmt.app.models.Resource.yml | 36 + .../azure.mgmt.app.models.Revision.yml | 83 + ...ure.mgmt.app.models.RevisionCollection.yml | 28 + ...re.mgmt.app.models.RevisionHealthState.yml | 13 + ...t.app.models.RevisionProvisioningState.yml | 17 + .../azure.mgmt.app.models.Scale.yml | 39 + .../azure.mgmt.app.models.ScaleRule.yml | 44 + .../azure.mgmt.app.models.ScaleRuleAuth.yml | 27 + .../azure.mgmt.app.models.Secret.yml | 26 + ...zure.mgmt.app.models.SecretsCollection.yml | 21 + .../azure.mgmt.app.models.SourceControl.yml | 80 + ...gmt.app.models.SourceControlCollection.yml | 28 + ...app.models.SourceControlOperationState.yml | 15 + .../azure.mgmt.app.models.StorageType.yml | 11 + .../azure.mgmt.app.models.SystemData.yml | 73 + .../azure.mgmt.app.models.Template.yml | 36 + .../azure.mgmt.app.models.TrackedResource.yml | 56 + .../azure.mgmt.app.models.TrafficWeight.yml | 37 + .../azure.mgmt.app.models.Twitter.yml | 36 + ...re.mgmt.app.models.TwitterRegistration.yml | 44 + .../azure.mgmt.app.models.Type.yml | 13 + ...p.models.UnauthenticatedClientActionV2.yml | 16 + ...e.mgmt.app.models.UserAssignedIdentity.yml | 20 + ...zure.mgmt.app.models.VnetConfiguration.yml | 101 + .../azure.mgmt.app.models.Volume.yml | 42 + .../azure.mgmt.app.models.VolumeMount.yml | 33 + .../azure-mgmt-app/azure.mgmt.app.models.yml | 131 + ....app.operations.CertificatesOperations.yml | 219 + ...ons.ContainerAppsAuthConfigsOperations.yml | 178 + ...app.operations.ContainerAppsOperations.yml | 323 + ...ontainerAppsRevisionReplicasOperations.yml | 110 + ...tions.ContainerAppsRevisionsOperations.yml | 206 + ....ContainerAppsSourceControlsOperations.yml | 224 + ...pp.operations.DaprComponentsOperations.yml | 178 + ...erations.ManagedEnvironmentsOperations.yml | 258 + ....ManagedEnvironmentsStoragesOperations.yml | 174 + .../azure.mgmt.app.operations.Operations.yml | 51 + .../azure.mgmt.app.operations.yml | 16 + .../azure-mgmt-app/azure.mgmt.app.yml | 11 + ...gmt.azureadb2c.CPIMConfigurationClient.yml | 95 + ...azureadb2c.aio.CPIMConfigurationClient.yml | 95 + .../azure.mgmt.azureadb2c.aio.yml | 7 + .../azure.mgmt.azureadb2c.models.yml | 4 + ..._01_01_preview.CPIMConfigurationClient.yml | 45 + ...01_preview.aio.CPIMConfigurationClient.yml | 45 + ...ew.aio.operations.B2CTenantsOperations.yml | 251 + ...1_01_preview.aio.operations.Operations.yml | 73 + ...b2c.v2019_01_01_preview.aio.operations.yml | 8 + ...gmt.azureadb2c.v2019_01_01_preview.aio.yml | 9 + ...01_preview.models.AsyncOperationStatus.yml | 81 + ...eview.models.AsyncOperationStatusError.yml | 25 + ...19_01_01_preview.models.B2CResourceSKU.yml | 33 + ...1_01_preview.models.B2CResourceSKUName.yml | 13 + ...01_01_preview.models.B2CTenantResource.yml | 80 + ...1_preview.models.B2CTenantResourceList.yml | 16 + ...CTenantResourcePropertiesBillingConfig.yml | 34 + ..._preview.models.B2CTenantUpdateRequest.yml | 43 + ...v2019_01_01_preview.models.BillingType.yml | 16 + ...odels.CheckNameAvailabilityRequestBody.yml | 35 + ...preview.models.CreateTenantRequestBody.yml | 51 + ...dels.CreateTenantRequestBodyProperties.yml | 33 + ..._01_preview.models.ErrorAdditionalInfo.yml | 20 + ...019_01_01_preview.models.ErrorResponse.yml | 33 + ...view.models.NameAvailabilityReasonType.yml | 11 + ...review.models.NameAvailabilityResponse.yml | 38 + ...c.v2019_01_01_preview.models.Operation.yml | 25 + ..._01_01_preview.models.OperationDisplay.yml | 33 + ..._01_preview.models.OperationListResult.yml | 18 + ....v2019_01_01_preview.models.StatusType.yml | 13 + ....azureadb2c.v2019_01_01_preview.models.yml | 27 + ...review.operations.B2CTenantsOperations.yml | 251 + ...19_01_01_preview.operations.Operations.yml | 73 + ...readb2c.v2019_01_01_preview.operations.yml | 8 + ...re.mgmt.azureadb2c.v2019_01_01_preview.yml | 11 + ..._05_01_preview.CPIMConfigurationClient.yml | 39 + ...01_preview.aio.CPIMConfigurationClient.yml | 39 + ...w.aio.operations.GuestUsagesOperations.yml | 217 + ...5_01_preview.aio.operations.Operations.yml | 52 + ...b2c.v2020_05_01_preview.aio.operations.yml | 8 + ...gmt.azureadb2c.v2020_05_01_preview.aio.yml | 9 + ..._01_preview.models.ErrorAdditionalInfo.yml | 20 + ...020_05_01_preview.models.ErrorResponse.yml | 33 + ..._01_preview.models.GuestUsagesResource.yml | 49 + ...preview.models.GuestUsagesResourceList.yml | 16 + ...review.models.GuestUsagesResourcePatch.yml | 18 + ...c.v2020_05_01_preview.models.Operation.yml | 25 + ..._05_01_preview.models.OperationDisplay.yml | 33 + ..._01_preview.models.OperationListResult.yml | 18 + ....azureadb2c.v2020_05_01_preview.models.yml | 14 + ...eview.operations.GuestUsagesOperations.yml | 217 + ...20_05_01_preview.operations.Operations.yml | 52 + ...readb2c.v2020_05_01_preview.operations.yml | 8 + ...re.mgmt.azureadb2c.v2020_05_01_preview.yml | 11 + .../azure.mgmt.azureadb2c.yml | 13 + ...elargeinstance.LargeInstanceMgmtClient.yml | 55 + ...geinstance.aio.LargeInstanceMgmtClient.yml | 55 + ...perations.AzureLargeInstanceOperations.yml | 316 + ...ns.AzureLargeStorageInstanceOperations.yml | 144 + ...argeinstance.aio.operations.Operations.yml | 30 + ...mgmt.azurelargeinstance.aio.operations.yml | 9 + .../azure.mgmt.azurelargeinstance.aio.yml | 9 + ...t.azurelargeinstance.models.ActionType.yml | 10 + ...argeinstance.models.AzureLargeInstance.yml | 66 + ...dels.AzureLargeInstanceForcePowerState.yml | 15 + ...zureLargeInstanceHardwareTypeNamesEnum.yml | 14 + ...ce.models.AzureLargeInstanceListResult.yml | 30 + ...odels.AzureLargeInstancePowerStateEnum.yml | 19 + ...ce.models.AzureLargeInstanceProperties.yml | 92 + ...ureLargeInstanceProvisioningStatesEnum.yml | 23 + ...models.AzureLargeInstanceSizeNamesEnum.yml | 102 + ...ce.models.AzureLargeInstanceTagsUpdate.yml | 19 + ...tance.models.AzureLargeStorageInstance.yml | 67 + ...ls.AzureLargeStorageInstanceListResult.yml | 30 + ...ls.AzureLargeStorageInstanceProperties.yml | 34 + ...ls.AzureLargeStorageInstanceTagsUpdate.yml | 19 + ...zurelargeinstance.models.CreatedByType.yml | 15 + ...re.mgmt.azurelargeinstance.models.Disk.yml | 39 + ...rgeinstance.models.ErrorAdditionalInfo.yml | 20 + ....azurelargeinstance.models.ErrorDetail.yml | 32 + ...zurelargeinstance.models.ErrorResponse.yml | 21 + ...t.azurelargeinstance.models.ForceState.yml | 28 + ...relargeinstance.models.HardwareProfile.yml | 39 + ...mt.azurelargeinstance.models.IpAddress.yml | 18 + ...urelargeinstance.models.NetworkProfile.yml | 26 + ...mt.azurelargeinstance.models.Operation.yml | 55 + ...elargeinstance.models.OperationDisplay.yml | 37 + ...rgeinstance.models.OperationListResult.yml | 23 + ...einstance.models.OperationStatusResult.yml | 89 + ....mgmt.azurelargeinstance.models.Origin.yml | 16 + ...mt.azurelargeinstance.models.OsProfile.yml | 38 + ...largeinstance.models.ProvisioningState.yml | 23 + ...gmt.azurelargeinstance.models.Resource.yml | 36 + ...stance.models.StorageBillingProperties.yml | 27 + ...urelargeinstance.models.StorageProfile.yml | 32 + ...largeinstance.models.StorageProperties.yml | 80 + ...t.azurelargeinstance.models.SystemData.yml | 73 + ...re.mgmt.azurelargeinstance.models.Tags.yml | 18 + ...relargeinstance.models.TrackedResource.yml | 59 + ...gmt.azurelargeinstance.models.Versions.yml | 9 + .../azure.mgmt.azurelargeinstance.models.yml | 45 + ...perations.AzureLargeInstanceOperations.yml | 316 + ...ns.AzureLargeStorageInstanceOperations.yml | 144 + ...urelargeinstance.operations.Operations.yml | 30 + ...ure.mgmt.azurelargeinstance.operations.yml | 9 + .../azure.mgmt.azurelargeinstance.yml | 11 + .../azure.mgmt.batchai.BatchAI.yml | 64 + .../azure.mgmt.batchai.aio.BatchAI.yml | 64 + ...chai.aio.operations.ClustersOperations.yml | 335 + ...i.aio.operations.ExperimentsOperations.yml | 235 + ...i.aio.operations.FileServersOperations.yml | 139 + ....batchai.aio.operations.JobsOperations.yml | 475 + ...mgmt.batchai.aio.operations.Operations.yml | 51 + ...atchai.aio.operations.UsagesOperations.yml | 60 + ...ai.aio.operations.WorkspacesOperations.yml | 260 + .../azure.mgmt.batchai.aio.operations.yml | 13 + .../azure.mgmt.batchai.aio.yml | 9 + ...re.mgmt.batchai.models.AllocationState.yml | 23 + ...mt.batchai.models.AppInsightsReference.yml | 40 + ....mgmt.batchai.models.AutoScaleSettings.yml | 44 + ...ai.models.AzureBlobFileSystemReference.yml | 60 + ...batchai.models.AzureFileShareReference.yml | 67 + ...hai.models.AzureStorageCredentialsInfo.yml | 30 + ...azure.mgmt.batchai.models.BatchAIError.yml | 30 + ...azure.mgmt.batchai.models.CNTKsettings.yml | 71 + .../azure.mgmt.batchai.models.CachingType.yml | 16 + ...ure.mgmt.batchai.models.Caffe2Settings.yml | 35 + ...zure.mgmt.batchai.models.CaffeSettings.yml | 56 + ...re.mgmt.batchai.models.ChainerSettings.yml | 46 + ...ure.mgmt.batchai.models.CloudErrorBody.yml | 37 + .../azure.mgmt.batchai.models.Cluster.yml | 154 + ...batchai.models.ClusterCreateParameters.yml | 89 + ....mgmt.batchai.models.ClusterListResult.yml | 20 + ...batchai.models.ClusterUpdateParameters.yml | 21 + ....models.ClustersListByWorkspaceOptions.yml | 20 + ....mgmt.batchai.models.ContainerSettings.yml | 33 + ....mgmt.batchai.models.CustomMpiSettings.yml | 34 + ...t.batchai.models.CustomToolkitSettings.yml | 17 + .../azure.mgmt.batchai.models.DataDisks.yml | 57 + ...mgmt.batchai.models.DeallocationOption.yml | 28 + ...gmt.batchai.models.EnvironmentVariable.yml | 27 + ...els.EnvironmentVariableWithSecretValue.yml | 41 + ...ure.mgmt.batchai.models.ExecutionState.yml | 41 + .../azure.mgmt.batchai.models.Experiment.yml | 41 + ...mt.batchai.models.ExperimentListResult.yml | 20 + ...dels.ExperimentsListByWorkspaceOptions.yml | 20 + .../azure.mgmt.batchai.models.File.yml | 39 + ...ure.mgmt.batchai.models.FileListResult.yml | 20 + .../azure.mgmt.batchai.models.FileServer.yml | 89 + ...chai.models.FileServerCreateParameters.yml | 49 + ...mt.batchai.models.FileServerListResult.yml | 25 + ...hai.models.FileServerProvisioningState.yml | 32 + ...gmt.batchai.models.FileServerReference.yml | 53 + ...dels.FileServersListByWorkspaceOptions.yml | 20 + .../azure.mgmt.batchai.models.FileType.yml | 11 + ...re.mgmt.batchai.models.HorovodSettings.yml | 46 + ...ure.mgmt.batchai.models.ImageReference.yml | 68 + ...gmt.batchai.models.ImageSourceRegistry.yml | 35 + ...ure.mgmt.batchai.models.InputDirectory.yml | 30 + .../azure.mgmt.batchai.models.Job.yml | 297 + ...ai.models.JobBasePropertiesConstraints.yml | 18 + ...gmt.batchai.models.JobCreateParameters.yml | 195 + ...zure.mgmt.batchai.models.JobListResult.yml | 20 + ...ure.mgmt.batchai.models.JobPreparation.yml | 25 + .../azure.mgmt.batchai.models.JobPriority.yml | 14 + ...atchai.models.JobPropertiesConstraints.yml | 18 + ...chai.models.JobPropertiesExecutionInfo.yml | 43 + ...hai.models.JobsListByExperimentOptions.yml | 20 + ...chai.models.JobsListOutputFilesOptions.yml | 47 + ...batchai.models.KeyVaultSecretReference.yml | 27 + ...e.mgmt.batchai.models.ListUsagesResult.yml | 23 + ...gmt.batchai.models.ManualScaleSettings.yml | 35 + ...zure.mgmt.batchai.models.MountSettings.yml | 36 + ...azure.mgmt.batchai.models.MountVolumes.yml | 50 + ...zure.mgmt.batchai.models.NameValuePair.yml | 24 + .../azure.mgmt.batchai.models.NodeSetup.yml | 48 + ...re.mgmt.batchai.models.NodeStateCounts.yml | 32 + .../azure.mgmt.batchai.models.Operation.yml | 37 + ...e.mgmt.batchai.models.OperationDisplay.yml | 28 + ...gmt.batchai.models.OperationListResult.yml | 21 + ...re.mgmt.batchai.models.OutputDirectory.yml | 52 + ...hai.models.PerformanceCountersSettings.yml | 26 + ...chai.models.PrivateRegistryCredentials.yml | 43 + ....mgmt.batchai.models.ProvisioningState.yml | 24 + ...zure.mgmt.batchai.models.ProxyResource.yml | 24 + ...re.mgmt.batchai.models.PyTorchSettings.yml | 55 + ....batchai.models.RemoteLoginInformation.yml | 24 + ...odels.RemoteLoginInformationListResult.yml | 20 + .../azure.mgmt.batchai.models.Resource.yml | 32 + .../azure.mgmt.batchai.models.ResourceId.yml | 21 + ...zure.mgmt.batchai.models.ScaleSettings.yml | 28 + .../azure.mgmt.batchai.models.SetupTask.yml | 74 + ...e.mgmt.batchai.models.SshConfiguration.yml | 35 + ...mgmt.batchai.models.StorageAccountType.yml | 17 + ...mgmt.batchai.models.TensorFlowSettings.yml | 85 + .../azure.mgmt.batchai.models.ToolType.yml | 23 + ...ai.models.UnmanagedFileSystemReference.yml | 39 + .../azure.mgmt.batchai.models.Usage.yml | 30 + .../azure.mgmt.batchai.models.UsageName.yml | 20 + .../azure.mgmt.batchai.models.UsageUnit.yml | 9 + ...gmt.batchai.models.UserAccountSettings.yml | 38 + ...hai.models.VirtualMachineConfiguration.yml | 18 + .../azure.mgmt.batchai.models.VmPriority.yml | 11 + .../azure.mgmt.batchai.models.Workspace.yml | 49 + ...tchai.models.WorkspaceCreateParameters.yml | 28 + ...gmt.batchai.models.WorkspaceListResult.yml | 20 + ...tchai.models.WorkspaceUpdateParameters.yml | 17 + ...s.WorkspacesListByResourceGroupOptions.yml | 21 + ...t.batchai.models.WorkspacesListOptions.yml | 20 + .../azure.mgmt.batchai.models.yml | 99 + ....batchai.operations.ClustersOperations.yml | 335 + ...tchai.operations.ExperimentsOperations.yml | 236 + ...tchai.operations.FileServersOperations.yml | 140 + ...mgmt.batchai.operations.JobsOperations.yml | 476 + ...ure.mgmt.batchai.operations.Operations.yml | 51 + ...mt.batchai.operations.UsagesOperations.yml | 60 + ...atchai.operations.WorkspacesOperations.yml | 261 + .../azure.mgmt.batchai.operations.yml | 13 + .../azure-mgmt-batchai/azure.mgmt.batchai.yml | 11 + ...dgegateway.DataBoxEdgeManagementClient.yml | 76 + ...ent_client.DataBoxEdgeManagementClient.yml | 76 + ...taBoxEdgeManagementClientConfiguration.yml | 28 + ...ateway.data_box_edge_management_client.yml | 7 + ...e.mgmt.edgegateway.models.ARMBaseModel.yml | 26 + ...re.mgmt.edgegateway.models.AccountType.yml | 10 + ...mgmt.edgegateway.models.Address(class).yml | 63 + ...e.mgmt.edgegateway.models.Alert(class).yml | 57 + ...t.edgegateway.models.AlertErrorDetails.yml | 26 + ...ure.mgmt.edgegateway.models.AlertPaged.yml | 9 + ....mgmt.edgegateway.models.AlertSeverity.yml | 12 + ...teway.models.AsymmetricEncryptedSecret.yml | 40 + ...gegateway.models.Authentication(class).yml | 17 + ....edgegateway.models.AuthenticationType.yml | 10 + ...ateway.models.AzureContainerDataFormat.yml | 12 + ....edgegateway.models.AzureContainerInfo.yml | 44 + ...t.edgegateway.models.BandwidthSchedule.yml | 62 + ...egateway.models.BandwidthSchedulePaged.yml | 9 + ...t.edgegateway.models.ClientAccessRight.yml | 32 + ...dgegateway.models.ClientPermissionType.yml | 12 + ...mgmt.edgegateway.models.ContactDetails.yml | 42 + ...t.edgegateway.models.DataBoxEdgeDevice.yml | 152 + ...y.models.DataBoxEdgeDeviceExtendedInfo.yml | 51 + ...egateway.models.DataBoxEdgeDevicePaged.yml | 9 + ...egateway.models.DataBoxEdgeDevicePatch.yml | 17 + ...gateway.models.DataBoxEdgeDeviceStatus.yml | 18 + ...ure.mgmt.edgegateway.models.DataPolicy.yml | 10 + ...zure.mgmt.edgegateway.models.DayOfWeek.yml | 20 + ...ure.mgmt.edgegateway.models.DeviceType.yml | 8 + ....mgmt.edgegateway.models.DownloadPhase.yml | 14 + ...edgegateway.models.EncryptionAlgorithm.yml | 12 + ...mt.edgegateway.models.FileEventTrigger.yml | 64 + ...mgmt.edgegateway.models.FileSourceInfo.yml | 20 + ...gegateway.models.InstallRebootBehavior.yml | 12 + ....mgmt.edgegateway.models.IoTDeviceInfo.yml | 37 + .../azure.mgmt.edgegateway.models.IoTRole.yml | 82 + ...ure.mgmt.edgegateway.models.Ipv4Config.yml | 26 + ...ure.mgmt.edgegateway.models.Ipv6Config.yml | 26 + ...ure.mgmt.edgegateway.models.Job(class).yml | 106 + ...gmt.edgegateway.models.JobErrorDetails.yml | 26 + ...e.mgmt.edgegateway.models.JobErrorItem.yml | 26 + ...zure.mgmt.edgegateway.models.JobStatus.yml | 20 + .../azure.mgmt.edgegateway.models.JobType.yml | 16 + ...gegateway.models.MetricAggregationType.yml | 20 + ...mgmt.edgegateway.models.MetricCategory.yml | 10 + ...t.edgegateway.models.MetricDimensionV1.yml | 32 + ...gegateway.models.MetricSpecificationV1.yml | 106 + ...ure.mgmt.edgegateway.models.MetricUnit.yml | 22 + ...mt.edgegateway.models.MonitoringStatus.yml | 10 + ....mgmt.edgegateway.models.MountPointMap.yml | 41 + ...mgmt.edgegateway.models.NetworkAdapter.yml | 91 + ...ateway.models.NetworkAdapterDHCPStatus.yml | 10 + ...egateway.models.NetworkAdapterPosition.yml | 25 + ...ateway.models.NetworkAdapterRDMAStatus.yml | 10 + ...dgegateway.models.NetworkAdapterStatus.yml | 10 + ...e.mgmt.edgegateway.models.NetworkGroup.yml | 12 + ...gmt.edgegateway.models.NetworkSettings.yml | 30 + ...mt.edgegateway.models.Operation(class).yml | 39 + ...mt.edgegateway.models.OperationDisplay.yml | 39 + ...mgmt.edgegateway.models.OperationPaged.yml | 9 + ...e.mgmt.edgegateway.models.Order(class).yml | 74 + ...ure.mgmt.edgegateway.models.OrderPaged.yml | 9 + ...ure.mgmt.edgegateway.models.OrderState.yml | 34 + ...re.mgmt.edgegateway.models.OrderStatus.yml | 48 + ...teway.models.PeriodicTimerEventTrigger.yml | 64 + ...gateway.models.PeriodicTimerSourceInfo.yml | 43 + ...e.mgmt.edgegateway.models.PlatformType.yml | 10 + ...mgmt.edgegateway.models.RefreshDetails.yml | 53 + ...re.mgmt.edgegateway.models.Role(class).yml | 40 + ...zure.mgmt.edgegateway.models.RolePaged.yml | 9 + ...e.mgmt.edgegateway.models.RoleSinkInfo.yml | 20 + ...ure.mgmt.edgegateway.models.RoleStatus.yml | 10 + ...zure.mgmt.edgegateway.models.RoleTypes.yml | 14 + ...zure.mgmt.edgegateway.models.SSLStatus.yml | 10 + ...mt.edgegateway.models.SecuritySettings.yml | 46 + ...dgegateway.models.ServiceSpecification.yml | 17 + ...e.mgmt.edgegateway.models.Share(class).yml | 116 + ...edgegateway.models.ShareAccessProtocol.yml | 10 + ...mt.edgegateway.models.ShareAccessRight.yml | 32 + ...gmt.edgegateway.models.ShareAccessType.yml | 12 + ...ure.mgmt.edgegateway.models.SharePaged.yml | 9 + ...re.mgmt.edgegateway.models.ShareStatus.yml | 10 + ...ure.mgmt.edgegateway.models.Sku(class).yml | 28 + .../azure.mgmt.edgegateway.models.SkuName.yml | 10 + .../azure.mgmt.edgegateway.models.SkuTier.yml | 8 + ...ateway.models.StorageAccountCredential.yml | 90 + ...y.models.StorageAccountCredentialPaged.yml | 9 + ...e.mgmt.edgegateway.models.SymmetricKey.yml | 17 + ...zure.mgmt.edgegateway.models.TimeGrain.yml | 22 + ...e.mgmt.edgegateway.models.TrackingInfo.yml | 39 + ...mgmt.edgegateway.models.Trigger(class).yml | 40 + ...e.mgmt.edgegateway.models.TriggerPaged.yml | 9 + ...egateway.models.UpdateDownloadProgress.yml | 41 + ...gegateway.models.UpdateInstallProgress.yml | 26 + ...gmt.edgegateway.models.UpdateOperation.yml | 14 + ...dgegateway.models.UpdateOperationStage.yml | 40 + ....mgmt.edgegateway.models.UpdateSummary.yml | 146 + ...ateway.models.UploadCertificateRequest.yml | 31 + ...teway.models.UploadCertificateResponse.yml | 75 + ...re.mgmt.edgegateway.models.User(class).yml | 46 + ...gmt.edgegateway.models.UserAccessRight.yml | 30 + ...zure.mgmt.edgegateway.models.UserPaged.yml | 9 + ...gmt.edgegateway.models.address.Address.yml | 47 + .../azure.mgmt.edgegateway.models.address.yml | 6 + ...edgegateway.models.address_py3.Address.yml | 63 + ...re.mgmt.edgegateway.models.address_py3.yml | 6 + ...re.mgmt.edgegateway.models.alert.Alert.yml | 57 + .../azure.mgmt.edgegateway.models.alert.yml | 6 + ....alert_error_details.AlertErrorDetails.yml | 26 + ...edgegateway.models.alert_error_details.yml | 6 + ...rt_error_details_py3.AlertErrorDetails.yml | 26 + ...gateway.models.alert_error_details_py3.yml | 6 + ...egateway.models.alert_paged.AlertPaged.yml | 9 + ...re.mgmt.edgegateway.models.alert_paged.yml | 6 + ...gmt.edgegateway.models.alert_py3.Alert.yml | 57 + ...zure.mgmt.edgegateway.models.alert_py3.yml | 6 + ...way.models.arm_base_model.ARMBaseModel.yml | 26 + ...mgmt.edgegateway.models.arm_base_model.yml | 6 + ...models.arm_base_model_py3.ARMBaseModel.yml | 26 + ....edgegateway.models.arm_base_model_py3.yml | 6 + ...ypted_secret.AsymmetricEncryptedSecret.yml | 32 + ...way.models.asymmetric_encrypted_secret.yml | 6 + ...d_secret_py3.AsymmetricEncryptedSecret.yml | 40 + ...models.asymmetric_encrypted_secret_py3.yml | 6 + ...y.models.authentication.Authentication.yml | 14 + ...mgmt.edgegateway.models.authentication.yml | 6 + ...dels.authentication_py3.Authentication.yml | 17 + ....edgegateway.models.authentication_py3.yml | 6 + ...zure_container_info.AzureContainerInfo.yml | 36 + ...dgegateway.models.azure_container_info.yml | 6 + ..._container_info_py3.AzureContainerInfo.yml | 44 + ...ateway.models.azure_container_info_py3.yml | 6 + ...s.bandwidth_schedule.BandwidthSchedule.yml | 53 + ....edgegateway.models.bandwidth_schedule.yml | 6 + ..._schedule_paged.BandwidthSchedulePaged.yml | 9 + ...ateway.models.bandwidth_schedule_paged.yml | 6 + ...ndwidth_schedule_py3.BandwidthSchedule.yml | 62 + ...egateway.models.bandwidth_schedule_py3.yml | 6 + ....client_access_right.ClientAccessRight.yml | 27 + ...edgegateway.models.client_access_right.yml | 6 + ...ent_access_right_py3.ClientAccessRight.yml | 32 + ...gateway.models.client_access_right_py3.yml | 6 + ....models.contact_details.ContactDetails.yml | 32 + ...gmt.edgegateway.models.contact_details.yml | 6 + ...els.contact_details_py3.ContactDetails.yml | 42 + ...edgegateway.models.contact_details_py3.yml | 6 + ...data_box_edge_device.DataBoxEdgeDevice.yml | 133 + ...dgegateway.models.data_box_edge_device.yml | 6 + ...ded_info.DataBoxEdgeDeviceExtendedInfo.yml | 45 + ...els.data_box_edge_device_extended_info.yml | 6 + ...info_py3.DataBoxEdgeDeviceExtendedInfo.yml | 51 + ...data_box_edge_device_extended_info_py3.yml | 6 + ...ge_device_paged.DataBoxEdgeDevicePaged.yml | 9 + ...eway.models.data_box_edge_device_paged.yml | 6 + ...ge_device_patch.DataBoxEdgeDevicePatch.yml | 14 + ...eway.models.data_box_edge_device_patch.yml | 6 + ...evice_patch_py3.DataBoxEdgeDevicePatch.yml | 17 + ....models.data_box_edge_device_patch_py3.yml | 6 + ..._box_edge_device_py3.DataBoxEdgeDevice.yml | 152 + ...ateway.models.data_box_edge_device_py3.yml | 6 + ...ge_management_client_enums.AccountType.yml | 10 + ..._management_client_enums.AlertSeverity.yml | 12 + ...gement_client_enums.AuthenticationType.yml | 10 + ..._client_enums.AzureContainerDataFormat.yml | 12 + ...ment_client_enums.ClientPermissionType.yml | 12 + ...t_client_enums.DataBoxEdgeDeviceStatus.yml | 18 + ...dge_management_client_enums.DataPolicy.yml | 10 + ...edge_management_client_enums.DayOfWeek.yml | 20 + ...dge_management_client_enums.DeviceType.yml | 8 + ..._management_client_enums.DownloadPhase.yml | 14 + ...ement_client_enums.EncryptionAlgorithm.yml | 12 + ...ent_client_enums.InstallRebootBehavior.yml | 12 + ...edge_management_client_enums.JobStatus.yml | 20 + ...x_edge_management_client_enums.JobType.yml | 16 + ...ent_client_enums.MetricAggregationType.yml | 20 + ...management_client_enums.MetricCategory.yml | 10 + ...dge_management_client_enums.MetricUnit.yml | 22 + ...nagement_client_enums.MonitoringStatus.yml | 10 + ..._client_enums.NetworkAdapterDHCPStatus.yml | 10 + ..._client_enums.NetworkAdapterRDMAStatus.yml | 10 + ...ment_client_enums.NetworkAdapterStatus.yml | 10 + ...e_management_client_enums.NetworkGroup.yml | 12 + ...dge_management_client_enums.OrderState.yml | 34 + ...e_management_client_enums.PlatformType.yml | 10 + ...dge_management_client_enums.RoleStatus.yml | 10 + ...edge_management_client_enums.RoleTypes.yml | 14 + ...edge_management_client_enums.SSLStatus.yml | 10 + ...ement_client_enums.ShareAccessProtocol.yml | 10 + ...anagement_client_enums.ShareAccessType.yml | 12 + ...ge_management_client_enums.ShareStatus.yml | 10 + ...x_edge_management_client_enums.SkuName.yml | 10 + ...x_edge_management_client_enums.SkuTier.yml | 8 + ...edge_management_client_enums.TimeGrain.yml | 22 + ...anagement_client_enums.UpdateOperation.yml | 14 + ...ment_client_enums.UpdateOperationStage.yml | 40 + ....data_box_edge_management_client_enums.yml | 40 + ...ls.file_event_trigger.FileEventTrigger.yml | 56 + ....edgegateway.models.file_event_trigger.yml | 6 + ...ile_event_trigger_py3.FileEventTrigger.yml | 64 + ...egateway.models.file_event_trigger_py3.yml | 6 + ...models.file_source_info.FileSourceInfo.yml | 17 + ...mt.edgegateway.models.file_source_info.yml | 6 + ...ls.file_source_info_py3.FileSourceInfo.yml | 20 + ...dgegateway.models.file_source_info_py3.yml | 6 + ...y.models.io_tdevice_info.IoTDeviceInfo.yml | 29 + ...gmt.edgegateway.models.io_tdevice_info.yml | 6 + ...dels.io_tdevice_info_py3.IoTDeviceInfo.yml | 37 + ...edgegateway.models.io_tdevice_info_py3.yml | 6 + ...mt.edgegateway.models.io_trole.IoTRole.yml | 70 + ...azure.mgmt.edgegateway.models.io_trole.yml | 6 + ...dgegateway.models.io_trole_py3.IoTRole.yml | 82 + ...e.mgmt.edgegateway.models.io_trole_py3.yml | 6 + ...egateway.models.ipv4_config.Ipv4Config.yml | 26 + ...re.mgmt.edgegateway.models.ipv4_config.yml | 6 + ...eway.models.ipv4_config_py3.Ipv4Config.yml | 26 + ...gmt.edgegateway.models.ipv4_config_py3.yml | 6 + ...egateway.models.ipv6_config.Ipv6Config.yml | 26 + ...re.mgmt.edgegateway.models.ipv6_config.yml | 6 + ...eway.models.ipv6_config_py3.Ipv6Config.yml | 26 + ...gmt.edgegateway.models.ipv6_config_py3.yml | 6 + .../azure.mgmt.edgegateway.models.job.Job.yml | 103 + .../azure.mgmt.edgegateway.models.job.yml | 6 + ...dels.job_error_details.JobErrorDetails.yml | 26 + ...t.edgegateway.models.job_error_details.yml | 6 + ....job_error_details_py3.JobErrorDetails.yml | 26 + ...gegateway.models.job_error_details_py3.yml | 6 + ...way.models.job_error_item.JobErrorItem.yml | 26 + ...mgmt.edgegateway.models.job_error_item.yml | 6 + ...models.job_error_item_py3.JobErrorItem.yml | 26 + ....edgegateway.models.job_error_item_py3.yml | 6 + ...re.mgmt.edgegateway.models.job_py3.Job.yml | 106 + .../azure.mgmt.edgegateway.models.job_py3.yml | 6 + ....metric_dimension_v1.MetricDimensionV1.yml | 24 + ...edgegateway.models.metric_dimension_v1.yml | 6 + ...ric_dimension_v1_py3.MetricDimensionV1.yml | 32 + ...gateway.models.metric_dimension_v1_py3.yml | 6 + ...specification_v1.MetricSpecificationV1.yml | 80 + ...gateway.models.metric_specification_v1.yml | 6 + ...ification_v1_py3.MetricSpecificationV1.yml | 106 + ...way.models.metric_specification_v1_py3.yml | 6 + ...y.models.mount_point_map.MountPointMap.yml | 38 + ...gmt.edgegateway.models.mount_point_map.yml | 6 + ...dels.mount_point_map_py3.MountPointMap.yml | 41 + ...edgegateway.models.mount_point_map_py3.yml | 6 + ....models.network_adapter.NetworkAdapter.yml | 86 + ...gmt.edgegateway.models.network_adapter.yml | 6 + ...dapter_position.NetworkAdapterPosition.yml | 25 + ...ateway.models.network_adapter_position.yml | 6 + ...er_position_py3.NetworkAdapterPosition.yml | 25 + ...ay.models.network_adapter_position_py3.yml | 6 + ...els.network_adapter_py3.NetworkAdapter.yml | 91 + ...edgegateway.models.network_adapter_py3.yml | 6 + ...odels.network_settings.NetworkSettings.yml | 30 + ...mt.edgegateway.models.network_settings.yml | 6 + ...s.network_settings_py3.NetworkSettings.yml | 30 + ...dgegateway.models.network_settings_py3.yml | 6 + ...edgegateway.models.operation.Operation.yml | 29 + ...zure.mgmt.edgegateway.models.operation.yml | 6 + ...els.operation_display.OperationDisplay.yml | 29 + ...t.edgegateway.models.operation_display.yml | 6 + ...operation_display_py3.OperationDisplay.yml | 39 + ...gegateway.models.operation_display_py3.yml | 6 + ....models.operation_paged.OperationPaged.yml | 9 + ...gmt.edgegateway.models.operation_paged.yml | 6 + ...gateway.models.operation_py3.Operation.yml | 39 + ....mgmt.edgegateway.models.operation_py3.yml | 6 + ...re.mgmt.edgegateway.models.order.Order.yml | 67 + .../azure.mgmt.edgegateway.models.order.yml | 6 + ...egateway.models.order_paged.OrderPaged.yml | 9 + ...re.mgmt.edgegateway.models.order_paged.yml | 6 + ...gmt.edgegateway.models.order_py3.Order.yml | 74 + ...zure.mgmt.edgegateway.models.order_py3.yml | 6 + ...ateway.models.order_status.OrderStatus.yml | 43 + ...e.mgmt.edgegateway.models.order_status.yml | 6 + ...ay.models.order_status_py3.OrderStatus.yml | 48 + ...mt.edgegateway.models.order_status_py3.yml | 6 + ...vent_trigger.PeriodicTimerEventTrigger.yml | 56 + ...ay.models.periodic_timer_event_trigger.yml | 6 + ..._trigger_py3.PeriodicTimerEventTrigger.yml | 64 + ...odels.periodic_timer_event_trigger_py3.yml | 6 + ...er_source_info.PeriodicTimerSourceInfo.yml | 35 + ...eway.models.periodic_timer_source_info.yml | 6 + ...ource_info_py3.PeriodicTimerSourceInfo.yml | 43 + ....models.periodic_timer_source_info_py3.yml | 6 + ....models.refresh_details.RefreshDetails.yml | 43 + ...gmt.edgegateway.models.refresh_details.yml | 6 + ...els.refresh_details_py3.RefreshDetails.yml | 53 + ...edgegateway.models.refresh_details_py3.yml | 6 + ...zure.mgmt.edgegateway.models.role.Role.yml | 40 + .../azure.mgmt.edgegateway.models.role.yml | 6 + ...dgegateway.models.role_paged.RolePaged.yml | 9 + ...ure.mgmt.edgegateway.models.role_paged.yml | 6 + ....mgmt.edgegateway.models.role_py3.Role.yml | 40 + ...azure.mgmt.edgegateway.models.role_py3.yml | 6 + ...way.models.role_sink_info.RoleSinkInfo.yml | 17 + ...mgmt.edgegateway.models.role_sink_info.yml | 6 + ...models.role_sink_info_py3.RoleSinkInfo.yml | 20 + ....edgegateway.models.role_sink_info_py3.yml | 6 + ...els.security_settings.SecuritySettings.yml | 43 + ...t.edgegateway.models.security_settings.yml | 6 + ...security_settings_py3.SecuritySettings.yml | 46 + ...gegateway.models.security_settings_py3.yml | 6 + ...ice_specification.ServiceSpecification.yml | 14 + ...gegateway.models.service_specification.yml | 6 + ...specification_py3.ServiceSpecification.yml | 17 + ...teway.models.service_specification_py3.yml | 6 + ...re.mgmt.edgegateway.models.share.Share.yml | 95 + .../azure.mgmt.edgegateway.models.share.yml | 6 + ...ls.share_access_right.ShareAccessRight.yml | 27 + ....edgegateway.models.share_access_right.yml | 6 + ...hare_access_right_py3.ShareAccessRight.yml | 32 + ...egateway.models.share_access_right_py3.yml | 6 + ...egateway.models.share_paged.SharePaged.yml | 9 + ...re.mgmt.edgegateway.models.share_paged.yml | 6 + ...gmt.edgegateway.models.share_py3.Share.yml | 116 + ...zure.mgmt.edgegateway.models.share_py3.yml | 6 + .../azure.mgmt.edgegateway.models.sku.Sku.yml | 23 + .../azure.mgmt.edgegateway.models.sku.yml | 6 + ...re.mgmt.edgegateway.models.sku_py3.Sku.yml | 28 + .../azure.mgmt.edgegateway.models.sku_py3.yml | 6 + ...nt_credential.StorageAccountCredential.yml | 73 + ...eway.models.storage_account_credential.yml | 6 + ...al_paged.StorageAccountCredentialPaged.yml | 9 + ...odels.storage_account_credential_paged.yml | 6 + ...redential_py3.StorageAccountCredential.yml | 90 + ....models.storage_account_credential_py3.yml | 6 + ...eway.models.symmetric_key.SymmetricKey.yml | 14 + ....mgmt.edgegateway.models.symmetric_key.yml | 6 + ....models.symmetric_key_py3.SymmetricKey.yml | 17 + ...t.edgegateway.models.symmetric_key_py3.yml | 6 + ...eway.models.tracking_info.TrackingInfo.yml | 29 + ....mgmt.edgegateway.models.tracking_info.yml | 6 + ....models.tracking_info_py3.TrackingInfo.yml | 39 + ...t.edgegateway.models.tracking_info_py3.yml | 6 + ...gmt.edgegateway.models.trigger.Trigger.yml | 40 + .../azure.mgmt.edgegateway.models.trigger.yml | 6 + ...eway.models.trigger_paged.TriggerPaged.yml | 9 + ....mgmt.edgegateway.models.trigger_paged.yml | 6 + ...edgegateway.models.trigger_py3.Trigger.yml | 40 + ...re.mgmt.edgegateway.models.trigger_py3.yml | 6 + ...wnload_progress.UpdateDownloadProgress.yml | 41 + ...ateway.models.update_download_progress.yml | 6 + ...ad_progress_py3.UpdateDownloadProgress.yml | 41 + ...ay.models.update_download_progress_py3.yml | 6 + ...install_progress.UpdateInstallProgress.yml | 26 + ...gateway.models.update_install_progress.yml | 6 + ...all_progress_py3.UpdateInstallProgress.yml | 26 + ...way.models.update_install_progress_py3.yml | 6 + ...ay.models.update_summary.UpdateSummary.yml | 135 + ...mgmt.edgegateway.models.update_summary.yml | 6 + ...odels.update_summary_py3.UpdateSummary.yml | 146 + ....edgegateway.models.update_summary_py3.yml | 6 + ...icate_request.UploadCertificateRequest.yml | 25 + ...eway.models.upload_certificate_request.yml | 6 + ...e_request_py3.UploadCertificateRequest.yml | 31 + ....models.upload_certificate_request_py3.yml | 6 + ...ate_response.UploadCertificateResponse.yml | 58 + ...way.models.upload_certificate_response.yml | 6 + ...response_py3.UploadCertificateResponse.yml | 75 + ...models.upload_certificate_response_py3.yml | 6 + ...zure.mgmt.edgegateway.models.user.User.yml | 41 + .../azure.mgmt.edgegateway.models.user.yml | 6 + ...dels.user_access_right.UserAccessRight.yml | 25 + ...t.edgegateway.models.user_access_right.yml | 6 + ....user_access_right_py3.UserAccessRight.yml | 30 + ...gegateway.models.user_access_right_py3.yml | 6 + ...dgegateway.models.user_paged.UserPaged.yml | 9 + ...ure.mgmt.edgegateway.models.user_paged.yml | 6 + ....mgmt.edgegateway.models.user_py3.User.yml | 46 + ...azure.mgmt.edgegateway.models.user_py3.yml | 6 + .../azure.mgmt.edgegateway.models.yml | 223 + ...dgegateway.operations.AlertsOperations.yml | 113 + ...perations.BandwidthSchedulesOperations.yml | 214 + ...gegateway.operations.DevicesOperations.yml | 647 + ....edgegateway.operations.JobsOperations.yml | 74 + ...gegateway.operations.Operations(class).yml | 57 + ....operations.OperationsStatusOperations.yml | 74 + ...dgegateway.operations.OrdersOperations.yml | 197 + ...edgegateway.operations.RolesOperations.yml | 212 + ...dgegateway.operations.SharesOperations.yml | 259 + ...ns.StorageAccountCredentialsOperations.yml | 216 + ...egateway.operations.TriggersOperations.yml | 219 + ...edgegateway.operations.UsersOperations.yml | 221 + ...ons.alerts_operations.AlertsOperations.yml | 113 + ...gegateway.operations.alerts_operations.yml | 6 + ...perations.BandwidthSchedulesOperations.yml | 214 + ...rations.bandwidth_schedules_operations.yml | 6 + ...s.devices_operations.DevicesOperations.yml | 647 + ...egateway.operations.devices_operations.yml | 6 + ...rations.jobs_operations.JobsOperations.yml | 74 + ...edgegateway.operations.jobs_operations.yml | 6 + ...teway.operations.operations.Operations.yml | 57 + ...mgmt.edgegateway.operations.operations.yml | 6 + ..._operations.OperationsStatusOperations.yml | 74 + ...perations.operations_status_operations.yml | 6 + ...ons.orders_operations.OrdersOperations.yml | 197 + ...gegateway.operations.orders_operations.yml | 6 + ...tions.roles_operations.RolesOperations.yml | 212 + ...dgegateway.operations.roles_operations.yml | 6 + ...ons.shares_operations.SharesOperations.yml | 259 + ...gegateway.operations.shares_operations.yml | 6 + ...ns.StorageAccountCredentialsOperations.yml | 216 + ...storage_account_credentials_operations.yml | 6 + ...triggers_operations.TriggersOperations.yml | 219 + ...gateway.operations.triggers_operations.yml | 6 + ...tions.users_operations.UsersOperations.yml | 221 + ...dgegateway.operations.users_operations.yml | 6 + .../azure.mgmt.edgegateway.operations.yml | 31 + .../azure.mgmt.edgegateway.version.yml | 4 + .../azure.mgmt.edgegateway.yml | 13 + .../azure.mgmt.logz.MicrosoftLogz.yml | 72 + .../azure.mgmt.logz.aio.MicrosoftLogz.yml | 72 + ....logz.aio.operations.MonitorOperations.yml | 143 + ...logz.aio.operations.MonitorsOperations.yml | 348 + ...re.mgmt.logz.aio.operations.Operations.yml | 34 + ....aio.operations.SingleSignOnOperations.yml | 167 + ...gz.aio.operations.SubAccountOperations.yml | 452 + ...perations.SubAccountTagRulesOperations.yml | 192 + ...logz.aio.operations.TagRulesOperations.yml | 172 + .../azure.mgmt.logz.aio.operations.yml | 13 + .../azure-mgmt-logz/azure.mgmt.logz.aio.yml | 9 + .../azure.mgmt.logz.models.CreatedByType.yml | 15 + ...e.mgmt.logz.models.ErrorAdditionalInfo.yml | 20 + .../azure.mgmt.logz.models.ErrorDetail.yml | 32 + .../azure.mgmt.logz.models.ErrorResponse.yml | 19 + .../azure.mgmt.logz.models.FilteringTag.yml | 44 + ...re.mgmt.logz.models.IdentityProperties.yml | 32 + ...mt.logz.models.LiftrResourceCategories.yml | 11 + .../azure.mgmt.logz.models.LogRules.yml | 71 + ...e.mgmt.logz.models.LogzMonitorResource.yml | 64 + ...models.LogzMonitorResourceListResponse.yml | 27 + ...ls.LogzMonitorResourceUpdateParameters.yml | 32 + ...logz.models.LogzOrganizationProperties.yml | 42 + ...logz.models.LogzSingleSignOnProperties.yml | 55 + ...t.logz.models.LogzSingleSignOnResource.yml | 36 + ...s.LogzSingleSignOnResourceListResponse.yml | 27 + ....mgmt.logz.models.ManagedIdentityTypes.yml | 11 + ...z.models.MarketplaceSubscriptionStatus.yml | 14 + ...ure.mgmt.logz.models.MonitorProperties.yml | 90 + ...mt.logz.models.MonitorUpdateProperties.yml | 27 + ...ure.mgmt.logz.models.MonitoredResource.yml | 68 + ...z.models.MonitoredResourceListResponse.yml | 27 + ...zure.mgmt.logz.models.MonitoringStatus.yml | 11 + ...re.mgmt.logz.models.MonitoringTagRules.yml | 38 + ....models.MonitoringTagRulesListResponse.yml | 27 + ...gz.models.MonitoringTagRulesProperties.yml | 36 + ...zure.mgmt.logz.models.OperationDisplay.yml | 43 + ...e.mgmt.logz.models.OperationListResult.yml | 27 + ...azure.mgmt.logz.models.OperationResult.yml | 44 + .../azure.mgmt.logz.models.PlanData.yml | 44 + ...ure.mgmt.logz.models.ProvisioningState.yml | 25 + ...re.mgmt.logz.models.SingleSignOnStates.yml | 15 + .../azure.mgmt.logz.models.SystemData.yml | 73 + .../azure.mgmt.logz.models.TagAction.yml | 11 + .../azure.mgmt.logz.models.UserInfo.yml | 43 + .../azure.mgmt.logz.models.UserRole.yml | 13 + ....mgmt.logz.models.UserRoleListResponse.yml | 27 + ...azure.mgmt.logz.models.UserRoleRequest.yml | 18 + ...zure.mgmt.logz.models.UserRoleResponse.yml | 26 + ...re.mgmt.logz.models.VMExtensionPayload.yml | 27 + ...e.mgmt.logz.models.VMHostUpdateRequest.yml | 35 + ...re.mgmt.logz.models.VMHostUpdateStates.yml | 11 + .../azure.mgmt.logz.models.VMResources.yml | 27 + ...mt.logz.models.VMResourcesListResponse.yml | 27 + .../azure.mgmt.logz.models.yml | 50 + ...mgmt.logz.operations.MonitorOperations.yml | 143 + ...gmt.logz.operations.MonitorsOperations.yml | 347 + .../azure.mgmt.logz.operations.Operations.yml | 34 + ...logz.operations.SingleSignOnOperations.yml | 167 + ...t.logz.operations.SubAccountOperations.yml | 452 + ...perations.SubAccountTagRulesOperations.yml | 192 + ...gmt.logz.operations.TagRulesOperations.yml | 172 + .../azure.mgmt.logz.operations.yml | 13 + .../azure-mgmt-logz/azure.mgmt.logz.yml | 11 + ...rkanalytics.NetworkAnalyticsMgmtClient.yml | 60 + ...alytics.aio.NetworkAnalyticsMgmtClient.yml | 60 + ...rations.DataProductsCatalogsOperations.yml | 78 + ....aio.operations.DataProductsOperations.yml | 487 + ...ics.aio.operations.DataTypesOperations.yml | 391 + ...orkanalytics.aio.operations.Operations.yml | 30 + ...e.mgmt.networkanalytics.aio.operations.yml | 10 + .../azure.mgmt.networkanalytics.aio.yml | 9 + ...gmt.networkanalytics.models.AccountSas.yml | 38 + ...etworkanalytics.models.AccountSasToken.yml | 21 + ...gmt.networkanalytics.models.ActionType.yml | 10 + ...re.mgmt.networkanalytics.models.Bypass.yml | 21 + ....models.ConsumptionEndpointsProperties.yml | 36 + ...t.networkanalytics.models.ContainerSaS.yml | 38 + ...workanalytics.models.ContainerSasToken.yml | 21 + ...t.networkanalytics.models.ControlState.yml | 11 + ....networkanalytics.models.CreatedByType.yml | 15 + ...mt.networkanalytics.models.DataProduct.yml | 73 + ...nalytics.models.DataProductInformation.yml | 38 + ...analytics.models.DataProductListResult.yml | 30 + ...nalytics.models.DataProductNetworkAcls.yml | 53 + ...analytics.models.DataProductProperties.yml | 190 + ...workanalytics.models.DataProductUpdate.yml | 36 + ...ics.models.DataProductUpdateProperties.yml | 59 + ...rkanalytics.models.DataProductUserRole.yml | 11 + ...orkanalytics.models.DataProductVersion.yml | 21 + ...rkanalytics.models.DataProductsCatalog.yml | 45 + ...s.models.DataProductsCatalogListResult.yml | 30 + ...s.models.DataProductsCatalogProperties.yml | 32 + ....mgmt.networkanalytics.models.DataType.yml | 45 + ...orkanalytics.models.DataTypeListResult.yml | 30 + ...orkanalytics.models.DataTypeProperties.yml | 65 + ....networkanalytics.models.DataTypeState.yml | 11 + ...networkanalytics.models.DataTypeUpdate.yml | 19 + ...lytics.models.DataTypeUpdateProperties.yml | 46 + ....networkanalytics.models.DefaultAction.yml | 11 + ...kanalytics.models.EncryptionKeyDetails.yml | 38 + ...rkanalytics.models.ErrorAdditionalInfo.yml | 20 + ...mt.networkanalytics.models.ErrorDetail.yml | 32 + ....networkanalytics.models.ErrorResponse.yml | 21 + ...e.mgmt.networkanalytics.models.IPRules.yml | 29 + ...t.networkanalytics.models.KeyVaultInfo.yml | 21 + ...rkanalytics.models.ListRoleAssignments.yml | 30 + ...dels.ManagedResourceGroupConfiguration.yml | 30 + ...nalytics.models.ManagedServiceIdentity.yml | 75 + ...tics.models.ManagedServiceIdentityType.yml | 18 + ...mgmt.networkanalytics.models.Operation.yml | 55 + ...tworkanalytics.models.OperationDisplay.yml | 37 + ...rkanalytics.models.OperationListResult.yml | 23 + ...re.mgmt.networkanalytics.models.Origin.yml | 16 + ...workanalytics.models.ProvisioningState.yml | 21 + ....networkanalytics.models.ProxyResource.yml | 38 + ...kanalytics.models.PublisherInformation.yml | 30 + ....mgmt.networkanalytics.models.Resource.yml | 36 + ...rkanalytics.models.ResourceAccessRules.yml | 29 + ....models.RoleAssignmentCommonProperties.yml | 71 + ...kanalytics.models.RoleAssignmentDetail.yml | 79 + ...gmt.networkanalytics.models.SystemData.yml | 73 + ...etworkanalytics.models.TrackedResource.yml | 59 + ...kanalytics.models.UserAssignedIdentity.yml | 20 + ....mgmt.networkanalytics.models.Versions.yml | 9 + ...orkanalytics.models.VirtualNetworkRule.yml | 38 + .../azure.mgmt.networkanalytics.models.yml | 61 + ...rations.DataProductsCatalogsOperations.yml | 78 + ...tics.operations.DataProductsOperations.yml | 486 + ...alytics.operations.DataTypesOperations.yml | 387 + ...networkanalytics.operations.Operations.yml | 30 + ...azure.mgmt.networkanalytics.operations.yml | 10 + .../azure.mgmt.networkanalytics.yml | 11 + ...bedded.PowerBIEmbeddedManagementClient.yml | 57 + ...ed.aio.PowerBIEmbeddedManagementClient.yml | 57 + ...mbeddedManagementClientOperationsMixin.yml | 18 + ...rations.WorkspaceCollectionsOperations.yml | 274 + ...ed.aio.operations.WorkspacesOperations.yml | 37 + ...re.mgmt.powerbiembedded.aio.operations.yml | 9 + .../azure.mgmt.powerbiembedded.aio.yml | 9 + ...t.powerbiembedded.models.AccessKeyName.yml | 11 + ...e.mgmt.powerbiembedded.models.AzureSku.yml | 34 + ...mt.powerbiembedded.models.AzureSkuName.yml | 9 + ...mt.powerbiembedded.models.AzureSkuTier.yml | 9 + ...powerbiembedded.models.CheckNameReason.yml | 11 + ...owerbiembedded.models.CheckNameRequest.yml | 28 + ...werbiembedded.models.CheckNameResponse.yml | 54 + ...odels.CreateWorkspaceCollectionRequest.yml | 33 + ...re.mgmt.powerbiembedded.models.Display.yml | 104 + ...zure.mgmt.powerbiembedded.models.Error.yml | 35 + ...gmt.powerbiembedded.models.ErrorDetail.yml | 29 + ...dels.MigrateWorkspaceCollectionRequest.yml | 29 + ....mgmt.powerbiembedded.models.Operation.yml | 31 + ...t.powerbiembedded.models.OperationList.yml | 17 + ...odels.UpdateWorkspaceCollectionRequest.yml | 25 + ....mgmt.powerbiembedded.models.Workspace.yml | 43 + ...rbiembedded.models.WorkspaceCollection.yml | 67 + ...ed.models.WorkspaceCollectionAccessKey.yml | 21 + ...d.models.WorkspaceCollectionAccessKeys.yml | 27 + ...mbedded.models.WorkspaceCollectionList.yml | 17 + ...t.powerbiembedded.models.WorkspaceList.yml | 17 + .../azure.mgmt.powerbiembedded.models.yml | 28 + ...mbeddedManagementClientOperationsMixin.yml | 18 + ...rations.WorkspaceCollectionsOperations.yml | 274 + ...bedded.operations.WorkspacesOperations.yml | 37 + .../azure.mgmt.powerbiembedded.operations.yml | 9 + .../azure.mgmt.powerbiembedded.yml | 11 + ...mt.scheduler.SchedulerManagementClient.yml | 44 + ...cheduler.aio.SchedulerManagementClient.yml | 44 + ...io.operations.JobCollectionsOperations.yml | 296 + ...cheduler.aio.operations.JobsOperations.yml | 304 + .../azure.mgmt.scheduler.aio.operations.yml | 8 + .../azure.mgmt.scheduler.aio.yml | 9 + ...t.scheduler.models.BasicAuthentication.yml | 38 + ...eduler.models.ClientCertAuthentication.yml | 64 + .../azure.mgmt.scheduler.models.DayOfWeek.yml | 20 + ...mt.scheduler.models.HttpAuthentication.yml | 27 + ...cheduler.models.HttpAuthenticationType.yml | 15 + ...zure.mgmt.scheduler.models.HttpRequest.yml | 47 + .../azure.mgmt.scheduler.models.JobAction.yml | 67 + ...re.mgmt.scheduler.models.JobActionType.yml | 17 + ...heduler.models.JobCollectionDefinition.yml | 52 + ...heduler.models.JobCollectionListResult.yml | 25 + ...heduler.models.JobCollectionProperties.yml | 35 + ...mt.scheduler.models.JobCollectionQuota.yml | 32 + ...mt.scheduler.models.JobCollectionState.yml | 15 + ...re.mgmt.scheduler.models.JobDefinition.yml | 33 + ...e.mgmt.scheduler.models.JobErrorAction.yml | 59 + ...mt.scheduler.models.JobExecutionStatus.yml | 13 + ....scheduler.models.JobHistoryActionName.yml | 11 + ....scheduler.models.JobHistoryDefinition.yml | 28 + ....models.JobHistoryDefinitionProperties.yml | 51 + ...mgmt.scheduler.models.JobHistoryFilter.yml | 21 + ....scheduler.models.JobHistoryListResult.yml | 25 + ...re.mgmt.scheduler.models.JobListResult.yml | 25 + ...mgmt.scheduler.models.JobMaxRecurrence.yml | 29 + ...re.mgmt.scheduler.models.JobProperties.yml | 51 + ...re.mgmt.scheduler.models.JobRecurrence.yml | 50 + ...scheduler.models.JobRecurrenceSchedule.yml | 53 + ...JobRecurrenceScheduleMonthlyOccurrence.yml | 32 + ...e.mgmt.scheduler.models.JobScheduleDay.yml | 24 + .../azure.mgmt.scheduler.models.JobState.yml | 15 + ...e.mgmt.scheduler.models.JobStateFilter.yml | 21 + .../azure.mgmt.scheduler.models.JobStatus.yml | 39 + ...t.scheduler.models.OAuthAuthentication.yml | 52 + ...t.scheduler.models.RecurrenceFrequency.yml | 18 + ...zure.mgmt.scheduler.models.RetryPolicy.yml | 39 + .../azure.mgmt.scheduler.models.RetryType.yml | 11 + ...eduler.models.ServiceBusAuthentication.yml | 35 + ...er.models.ServiceBusAuthenticationType.yml | 11 + ...ls.ServiceBusBrokeredMessageProperties.yml | 106 + ...gmt.scheduler.models.ServiceBusMessage.yml | 59 + ...cheduler.models.ServiceBusQueueMessage.yml | 66 + ...cheduler.models.ServiceBusTopicMessage.yml | 66 + ...heduler.models.ServiceBusTransportType.yml | 13 + .../azure.mgmt.scheduler.models.Sku.yml | 21 + ...re.mgmt.scheduler.models.SkuDefinition.yml | 15 + ...t.scheduler.models.StorageQueueMessage.yml | 39 + .../azure.mgmt.scheduler.models.yml | 52 + ...er.operations.JobCollectionsOperations.yml | 296 + ...mt.scheduler.operations.JobsOperations.yml | 304 + .../azure.mgmt.scheduler.operations.yml | 8 + .../azure.mgmt.scheduler.patch.yml | 35 + .../azure.mgmt.scheduler.yml | 13 + ...torageimportexport.StorageImportExport.yml | 63 + ...geimportexport.aio.StorageImportExport.yml | 63 + ...aio.operations.BitLockerKeysOperations.yml | 44 + ...rtexport.aio.operations.JobsOperations.yml | 250 + ...ort.aio.operations.LocationsOperations.yml | 57 + ...importexport.aio.operations.Operations.yml | 31 + ...gmt.storageimportexport.aio.operations.yml | 10 + .../azure.mgmt.storageimportexport.aio.yml | 9 + ...orageimportexport.models.CreatedByType.yml | 15 + ...port.models.DeliveryPackageInformation.yml | 52 + ...eimportexport.models.DriveBitLockerKey.yml | 27 + ....storageimportexport.models.DriveState.yml | 21 + ...storageimportexport.models.DriveStatus.yml | 132 + ...eimportexport.models.EncryptionKekType.yml | 11 + ...portexport.models.EncryptionKeyDetails.yml | 44 + ...orageimportexport.models.ErrorResponse.yml | 52 + ...t.models.ErrorResponseErrorDetailsItem.yml | 35 + ...mgmt.storageimportexport.models.Export.yml | 47 + ...export.models.GetBitLockerKeysResponse.yml | 19 + ...ageimportexport.models.IdentityDetails.yml | 38 + ...torageimportexport.models.IdentityType.yml | 13 + ....storageimportexport.models.JobDetails.yml | 227 + ...storageimportexport.models.JobResponse.yml | 63 + ...geimportexport.models.ListJobsResponse.yml | 27 + ...rtexport.models.ListOperationsResponse.yml | 19 + ...mt.storageimportexport.models.Location.yml | 178 + ...eimportexport.models.LocationsResponse.yml | 18 + ...t.storageimportexport.models.Operation.yml | 54 + ...importexport.models.PackageInformation.yml | 52 + ...geimportexport.models.PutJobParameters.yml | 35 + ...orageimportexport.models.ReturnAddress.yml | 99 + ...rageimportexport.models.ReturnShipping.yml | 29 + ...mportexport.models.ShippingInformation.yml | 97 + ....storageimportexport.models.SystemData.yml | 73 + ...mportexport.models.UpdateJobParameters.yml | 118 + .../azure.mgmt.storageimportexport.models.yml | 34 + ...ort.operations.BitLockerKeysOperations.yml | 44 + ...importexport.operations.JobsOperations.yml | 248 + ...texport.operations.LocationsOperations.yml | 57 + ...rageimportexport.operations.Operations.yml | 31 + ...re.mgmt.storageimportexport.operations.yml | 10 + .../azure.mgmt.storageimportexport.yml | 11 + .../azure.mgmt.testbase.TestBase.yml | 107 + .../azure.mgmt.testbase.aio.TestBase.yml | 107 + ...o.operations.AnalysisResultsOperations.yml | 126 + ...e.aio.operations.AvailableOSOperations.yml | 87 + ...operations.BillingHubServiceOperations.yml | 86 + ...io.operations.CustomerEventsOperations.yml | 211 + ...e.aio.operations.EmailEventsOperations.yml | 79 + ...operations.FavoriteProcessesOperations.yml | 200 + ...io.operations.FlightingRingsOperations.yml | 81 + ...ase.aio.operations.OSUpdatesOperations.yml | 97 + ...gmt.testbase.aio.operations.Operations.yml | 31 + ...base.aio.operations.PackagesOperations.yml | 424 + ...testbase.aio.operations.SkusOperations.yml | 31 + ....operations.TestBaseAccountsOperations.yml | 449 + ...e.aio.operations.TestResultsOperations.yml | 248 + ...aio.operations.TestSummariesOperations.yml | 82 + ...ase.aio.operations.TestTypesOperations.yml | 79 + ...estbase.aio.operations.UsageOperations.yml | 52 + .../azure.mgmt.testbase.aio.operations.yml | 22 + .../azure.mgmt.testbase.aio.yml | 9 + .../azure.mgmt.testbase.models.Action.yml | 17 + ...stbase.models.AnalysisResultListResult.yml | 30 + ...gmt.testbase.models.AnalysisResultName.yml | 21 + ...models.AnalysisResultSingletonResource.yml | 56 + ...lysisResultSingletonResourceProperties.yml | 55 + ...gmt.testbase.models.AnalysisResultType.yml | 21 + ...re.mgmt.testbase.models.AnalysisStatus.yml | 21 + ....testbase.models.AvailableOSListResult.yml | 29 + ...mt.testbase.models.AvailableOSResource.yml | 79 + ....models.BillingHubExecutionUsageDetail.yml | 100 + ...odels.BillingHubFreeHourIncrementEntry.yml | 36 + ...s.BillingHubGetFreeHourBalanceResponse.yml | 24 + ...tbase.models.BillingHubGetUsageRequest.yml | 42 + ...base.models.BillingHubGetUsageResponse.yml | 43 + ...testbase.models.BillingHubPackageUsage.yml | 56 + ...e.mgmt.testbase.models.BillingHubUsage.yml | 56 + ...t.testbase.models.BillingHubUsageGroup.yml | 81 + ...els.BillingHubUsageGroupedByUpdateType.yml | 43 + ...ssionResultSingletonResourceProperties.yml | 48 + ...ationResultSingletonResourceProperties.yml | 48 + .../azure.mgmt.testbase.models.Category.yml | 17 + ...ase.models.CheckNameAvailabilityResult.yml | 50 + .../azure.mgmt.testbase.models.Command.yml | 114 + ...azure.mgmt.testbase.models.ContentType.yml | 13 + ...ure.mgmt.testbase.models.CreatedByType.yml | 15 + ...estbase.models.CustomerEventListResult.yml | 29 + ....testbase.models.CustomerEventResource.yml | 46 + ...els.DistributionGroupListReceiverValue.yml | 19 + ...mt.testbase.models.DownloadURLResponse.yml | 20 + ...t.testbase.models.EmailEventListResult.yml | 29 + ...gmt.testbase.models.EmailEventResource.yml | 54 + ...e.mgmt.testbase.models.ErrorDefinition.yml | 28 + ...ure.mgmt.testbase.models.ErrorResponse.yml | 18 + ...e.mgmt.testbase.models.ExecutionStatus.yml | 23 + ...tbase.models.FavoriteProcessListResult.yml | 29 + ...estbase.models.FavoriteProcessResource.yml | 47 + ....testbase.models.FileUploadURLResponse.yml | 22 + ...estbase.models.FlightingRingListResult.yml | 29 + ....testbase.models.FlightingRingResource.yml | 40 + ...base.models.GetFileUploadURLParameters.yml | 18 + .../azure.mgmt.testbase.models.Grade.yml | 15 + ...mgmt.testbase.models.IdentifiedFailure.yml | 50 + ...ssionResultSingletonResourceProperties.yml | 48 + ...ationResultSingletonResourceProperties.yml | 48 + ...tbase.models.NotificationEventReceiver.yml | 27 + ...tbase.models.NotificationReceiverValue.yml | 37 + ...gmt.testbase.models.OSUpdateListResult.yml | 29 + ....mgmt.testbase.models.OSUpdateResource.yml | 94 + ...mt.testbase.models.OSUpdateTestSummary.yml | 133 + ...t.testbase.models.OSUpdatesTestSummary.yml | 77 + .../azure.mgmt.testbase.models.Operation.yml | 42 + ....mgmt.testbase.models.OperationDisplay.yml | 28 + ...mt.testbase.models.OperationListResult.yml | 25 + ...zure.mgmt.testbase.models.OsUpdateType.yml | 11 + ...PackageCheckNameAvailabilityParameters.yml | 46 + ...mgmt.testbase.models.PackageListResult.yml | 29 + ...e.mgmt.testbase.models.PackageResource.yml | 141 + ...stbase.models.PackageRunTestParameters.yml | 68 + ...ure.mgmt.testbase.models.PackageStatus.yml | 25 + ...estbase.models.PackageUpdateParameters.yml | 67 + ...estbase.models.PackageValidationResult.yml | 25 + ...mgmt.testbase.models.ProvisioningState.yml | 21 + ...ure.mgmt.testbase.models.ProxyResource.yml | 25 + .../azure.mgmt.testbase.models.Reason.yml | 11 + ....mgmt.testbase.models.RegressionResult.yml | 64 + ....testbase.models.RegressionTestDetails.yml | 27 + ...mgmt.testbase.models.ReliabilityResult.yml | 105 + ...ilityResultSingletonResourceProperties.yml | 48 + .../azure.mgmt.testbase.models.Resource.yml | 24 + ....testbase.models.ScriptExecutionResult.yml | 69 + ...utionResultSingletonResourceProperties.yml | 48 + ...tbase.models.SubscriptionReceiverValue.yml | 35 + .../azure.mgmt.testbase.models.SystemData.yml | 73 + ...zure.mgmt.testbase.models.TargetOSInfo.yml | 43 + .../azure.mgmt.testbase.models.Test.yml | 63 + ...gmt.testbase.models.TestAnalysisResult.yml | 42 + ...lysisResultSingletonResourceProperties.yml | 48 + ...gmt.testbase.models.TestAnalysisStatus.yml | 15 + ...tbase.models.TestBaseAccountListResult.yml | 29 + ...estbase.models.TestBaseAccountResource.yml | 72 + ...gmt.testbase.models.TestBaseAccountSKU.yml | 61 + ...se.models.TestBaseAccountSKUCapability.yml | 31 + ...se.models.TestBaseAccountSKUListResult.yml | 29 + ...models.TestBaseAccountUpdateParameters.yml | 27 + ...stbase.models.TestBaseAccountUsageData.yml | 64 + ...se.models.TestBaseAccountUsageDataList.yml | 29 + ...stbase.models.TestBaseAccountUsageName.yml | 27 + ...tbase.models.TestResultAnalysisSummary.yml | 50 + ...tResultConsoleLogDownloadURLParameters.yml | 22 + ...t.testbase.models.TestResultListResult.yml | 29 + ...gmt.testbase.models.TestResultResource.yml | 246 + .../azure.mgmt.testbase.models.TestStatus.yml | 23 + ....testbase.models.TestSummaryListResult.yml | 29 + ...mt.testbase.models.TestSummaryResource.yml | 157 + .../azure.mgmt.testbase.models.TestType.yml | 11 + ...gmt.testbase.models.TestTypeListResult.yml | 29 + ....mgmt.testbase.models.TestTypeResource.yml | 37 + .../azure.mgmt.testbase.models.Tier.yml | 9 + ...e.mgmt.testbase.models.TrackedResource.yml | 48 + .../azure.mgmt.testbase.models.Type.yml | 11 + ...estbase.models.UserObjectReceiverValue.yml | 18 + ....mgmt.testbase.models.UtilizationBound.yml | 27 + ....mgmt.testbase.models.UtilizationEntry.yml | 27 + ...mgmt.testbase.models.UtilizationResult.yml | 44 + ...mt.testbase.models.ValidationRunStatus.yml | 15 + .../azure.mgmt.testbase.models.yml | 112 + ...e.operations.AnalysisResultsOperations.yml | 126 + ...tbase.operations.AvailableOSOperations.yml | 87 + ...operations.BillingHubServiceOperations.yml | 86 + ...se.operations.CustomerEventsOperations.yml | 211 + ...tbase.operations.EmailEventsOperations.yml | 79 + ...operations.FavoriteProcessesOperations.yml | 200 + ...se.operations.FlightingRingsOperations.yml | 81 + ...estbase.operations.OSUpdatesOperations.yml | 97 + ...re.mgmt.testbase.operations.Operations.yml | 31 + ...testbase.operations.PackagesOperations.yml | 424 + ...gmt.testbase.operations.SkusOperations.yml | 31 + ....operations.TestBaseAccountsOperations.yml | 449 + ...tbase.operations.TestResultsOperations.yml | 248 + ...ase.operations.TestSummariesOperations.yml | 82 + ...estbase.operations.TestTypesOperations.yml | 79 + ...mt.testbase.operations.UsageOperations.yml | 52 + .../azure.mgmt.testbase.operations.yml | 22 + .../azure.mgmt.testbase.yml | 11 + ...azure.mgmt.videoanalyzer.VideoAnalyzer.yml | 105 + ...e.mgmt.videoanalyzer.aio.VideoAnalyzer.yml | 105 + ...io.operations.AccessPoliciesOperations.yml | 229 + ...r.aio.operations.EdgeModulesOperations.yml | 269 + ...ivePipelineOperationStatusesOperations.yml | 75 + ...aio.operations.LivePipelinesOperations.yml | 349 + ...zer.aio.operations.LocationsOperations.yml | 65 + ....operations.OperationResultsOperations.yml | 76 + ...operations.OperationStatusesOperations.yml | 76 + ...ideoanalyzer.aio.operations.Operations.yml | 53 + ...PipelineJobOperationStatusesOperations.yml | 75 + ....aio.operations.PipelineJobsOperations.yml | 294 + ...perations.PipelineTopologiesOperations.yml | 259 + ...s.PrivateEndpointConnectionsOperations.yml | 175 + ...rations.PrivateLinkResourcesOperations.yml | 100 + ...ideoAnalyzerOperationResultsOperations.yml | 66 + ...deoAnalyzerOperationStatusesOperations.yml | 64 + ...io.operations.VideoAnalyzersOperations.yml | 243 + ...alyzer.aio.operations.VideosOperations.yml | 270 + ...zure.mgmt.videoanalyzer.aio.operations.yml | 23 + .../azure.mgmt.videoanalyzer.aio.yml | 9 + ...deoanalyzer.models.AccessPolicyEccAlgo.yml | 13 + ...ideoanalyzer.models.AccessPolicyEntity.yml | 57 + ...er.models.AccessPolicyEntityCollection.yml | 28 + ....videoanalyzer.models.AccessPolicyRole.yml | 9 + ...deoanalyzer.models.AccessPolicyRsaAlgo.yml | 13 + ...videoanalyzer.models.AccountEncryption.yml | 47 + ...alyzer.models.AccountEncryptionKeyType.yml | 11 + ...e.mgmt.videoanalyzer.models.ActionType.yml | 9 + ...t.videoanalyzer.models.AudioEncoderAac.yml | 32 + ....videoanalyzer.models.AudioEncoderBase.yml | 38 + ...ideoanalyzer.models.AuthenticationBase.yml | 23 + ...videoanalyzer.models.CertificateSource.yml | 23 + ...zer.models.CheckNameAvailabilityReason.yml | 11 + ...er.models.CheckNameAvailabilityRequest.yml | 25 + ...r.models.CheckNameAvailabilityResponse.yml | 36 + ...gmt.videoanalyzer.models.CreatedByType.yml | 15 + ...t.videoanalyzer.models.CredentialsBase.yml | 23 + ....mgmt.videoanalyzer.models.EccTokenKey.yml | 56 + ....videoanalyzer.models.EdgeModuleEntity.yml | 39 + ...yzer.models.EdgeModuleEntityCollection.yml | 28 + ...zer.models.EdgeModuleProvisioningToken.yml | 35 + ...deoanalyzer.models.EncoderCustomPreset.yml | 35 + ...videoanalyzer.models.EncoderPresetBase.yml | 24 + ....videoanalyzer.models.EncoderProcessor.yml | 48 + ...deoanalyzer.models.EncoderSystemPreset.yml | 33 + ...nalyzer.models.EncoderSystemPresetType.yml | 15 + ...ure.mgmt.videoanalyzer.models.Endpoint.yml | 29 + ...mgmt.videoanalyzer.models.EndpointBase.yml | 50 + ...deoanalyzer.models.ErrorAdditionalInfo.yml | 20 + ....mgmt.videoanalyzer.models.ErrorDetail.yml | 32 + ...gmt.videoanalyzer.models.ErrorResponse.yml | 18 + ...nalyzer.models.GroupLevelAccessControl.yml | 22 + ...azure.mgmt.videoanalyzer.models.IotHub.yml | 35 + ...videoanalyzer.models.JwtAuthentication.yml | 64 + ...ideoanalyzer.models.KeyVaultProperties.yml | 36 + .../azure.mgmt.videoanalyzer.models.Kind.yml | 11 + ...yzer.models.ListProvisioningTokenInput.yml | 27 + ...mgmt.videoanalyzer.models.LivePipeline.yml | 105 + ...analyzer.models.LivePipelineCollection.yml | 28 + ...zer.models.LivePipelineOperationStatus.yml | 24 + ...videoanalyzer.models.LivePipelineState.yml | 15 + ...ideoanalyzer.models.LivePipelineUpdate.yml | 105 + ....videoanalyzer.models.LogSpecification.yml | 24 + ...oanalyzer.models.MetricAggregationType.yml | 13 + ...t.videoanalyzer.models.MetricDimension.yml | 24 + ...deoanalyzer.models.MetricSpecification.yml | 73 + ...e.mgmt.videoanalyzer.models.MetricUnit.yml | 13 + ...eoanalyzer.models.NetworkAccessControl.yml | 33 + ...ure.mgmt.videoanalyzer.models.NodeBase.yml | 31 + ...re.mgmt.videoanalyzer.models.NodeInput.yml | 23 + ...re.mgmt.videoanalyzer.models.Operation.yml | 58 + ...deoanalyzer.models.OperationCollection.yml | 17 + ....videoanalyzer.models.OperationDisplay.yml | 39 + ...eoanalyzer.models.ParameterDeclaration.yml | 50 + ...deoanalyzer.models.ParameterDefinition.yml | 28 + ...gmt.videoanalyzer.models.ParameterType.yml | 17 + ...ideoanalyzer.models.PemCertificateList.yml | 27 + ....mgmt.videoanalyzer.models.PipelineJob.yml | 91 + ...oanalyzer.models.PipelineJobCollection.yml | 28 + ....videoanalyzer.models.PipelineJobError.yml | 25 + ...yzer.models.PipelineJobOperationStatus.yml | 24 + ....videoanalyzer.models.PipelineJobState.yml | 15 + ...videoanalyzer.models.PipelineJobUpdate.yml | 91 + ....videoanalyzer.models.PipelineTopology.yml | 69 + ...yzer.models.PipelineTopologyCollection.yml | 28 + ...analyzer.models.PipelineTopologyUpdate.yml | 67 + ...t.videoanalyzer.models.PrivateEndpoint.yml | 16 + ...lyzer.models.PrivateEndpointConnection.yml | 62 + ...ls.PrivateEndpointConnectionListResult.yml | 19 + ...ateEndpointConnectionProvisioningState.yml | 15 + ...PrivateEndpointServiceConnectionStatus.yml | 13 + ...deoanalyzer.models.PrivateLinkResource.yml | 52 + ...r.models.PrivateLinkResourceListResult.yml | 18 + ...dels.PrivateLinkServiceConnectionState.yml | 41 + ...videoanalyzer.models.ProcessorNodeBase.yml | 41 + ...e.mgmt.videoanalyzer.models.Properties.yml | 16 + ...videoanalyzer.models.ProvisioningState.yml | 13 + ...gmt.videoanalyzer.models.ProxyResource.yml | 36 + ...deoanalyzer.models.PublicNetworkAccess.yml | 12 + ...ure.mgmt.videoanalyzer.models.Resource.yml | 36 + ....videoanalyzer.models.ResourceIdentity.yml | 22 + ....mgmt.videoanalyzer.models.RsaTokenKey.yml | 55 + ...e.mgmt.videoanalyzer.models.RtspSource.yml | 61 + ...gmt.videoanalyzer.models.RtspTransport.yml | 20 + ...zer.models.SecureIotDeviceRemoteTunnel.yml | 36 + ...eoanalyzer.models.ServiceSpecification.yml | 20 + ...mgmt.videoanalyzer.models.SinkNodeBase.yml | 41 + .../azure.mgmt.videoanalyzer.models.Sku.yml | 30 + ...zure.mgmt.videoanalyzer.models.SkuName.yml | 11 + ...zure.mgmt.videoanalyzer.models.SkuTier.yml | 9 + ...mt.videoanalyzer.models.SourceNodeBase.yml | 31 + ...mt.videoanalyzer.models.StorageAccount.yml | 42 + ...e.mgmt.videoanalyzer.models.SystemData.yml | 61 + ....videoanalyzer.models.TimeSequenceBase.yml | 23 + ....mgmt.videoanalyzer.models.TlsEndpoint.yml | 69 + ...eoanalyzer.models.TlsValidationOptions.yml | 31 + ...e.mgmt.videoanalyzer.models.TokenClaim.yml | 27 + ...ure.mgmt.videoanalyzer.models.TokenKey.yml | 34 + ...t.videoanalyzer.models.TrackedResource.yml | 55 + ...e.mgmt.videoanalyzer.models.TunnelBase.yml | 23 + ...videoanalyzer.models.UnsecuredEndpoint.yml | 46 + ...zer.models.UserAssignedManagedIdentity.yml | 21 + ...zer.models.UsernamePasswordCredentials.yml | 39 + ...gmt.videoanalyzer.models.VideoAnalyzer.yml | 120 + ...nalyzer.models.VideoAnalyzerCollection.yml | 17 + ...lyzer.models.VideoAnalyzerEndpointType.yml | 9 + ...oanalyzer.models.VideoAnalyzerIdentity.yml | 28 + ...er.models.VideoAnalyzerOperationStatus.yml | 57 + ...ivateEndpointConnectionOperationStatus.yml | 57 + ...deoanalyzer.models.VideoAnalyzerUpdate.yml | 87 + ...gmt.videoanalyzer.models.VideoArchival.yml | 29 + ...videoanalyzer.models.VideoContentToken.yml | 25 + ....videoanalyzer.models.VideoContentUrls.yml | 81 + ...nalyzer.models.VideoCreationProperties.yml | 76 + ....videoanalyzer.models.VideoEncoderBase.yml | 62 + ....videoanalyzer.models.VideoEncoderH264.yml | 56 + ....mgmt.videoanalyzer.models.VideoEntity.yml | 95 + ...oanalyzer.models.VideoEntityCollection.yml | 28 + ...e.mgmt.videoanalyzer.models.VideoFlags.yml | 50 + ...mt.videoanalyzer.models.VideoMediaInfo.yml | 31 + ...oanalyzer.models.VideoPreviewImageUrls.yml | 35 + ...analyzer.models.VideoPublishingOptions.yml | 41 + ...e.mgmt.videoanalyzer.models.VideoScale.yml | 42 + ...mt.videoanalyzer.models.VideoScaleMode.yml | 18 + ...odels.VideoSequenceAbsoluteTimeMarkers.yml | 30 + ...re.mgmt.videoanalyzer.models.VideoSink.yml | 74 + ....mgmt.videoanalyzer.models.VideoSource.yml | 48 + ...re.mgmt.videoanalyzer.models.VideoType.yml | 14 + .../azure.mgmt.videoanalyzer.models.yml | 135 + ...er.operations.AccessPoliciesOperations.yml | 229 + ...lyzer.operations.EdgeModulesOperations.yml | 269 + ...ivePipelineOperationStatusesOperations.yml | 75 + ...zer.operations.LivePipelinesOperations.yml | 349 + ...nalyzer.operations.LocationsOperations.yml | 65 + ....operations.OperationResultsOperations.yml | 76 + ...operations.OperationStatusesOperations.yml | 76 + ...mt.videoanalyzer.operations.Operations.yml | 53 + ...PipelineJobOperationStatusesOperations.yml | 75 + ...yzer.operations.PipelineJobsOperations.yml | 294 + ...perations.PipelineTopologiesOperations.yml | 259 + ...s.PrivateEndpointConnectionsOperations.yml | 175 + ...rations.PrivateLinkResourcesOperations.yml | 100 + ...ideoAnalyzerOperationResultsOperations.yml | 66 + ...deoAnalyzerOperationStatusesOperations.yml | 64 + ...er.operations.VideoAnalyzersOperations.yml | 242 + ...eoanalyzer.operations.VideosOperations.yml | 270 + .../azure.mgmt.videoanalyzer.operations.yml | 23 + .../azure.mgmt.videoanalyzer.yml | 11 + ...gmt.workloadmonitor.WorkloadMonitorAPI.yml | 40 + ...workloadmonitor.aio.WorkloadMonitorAPI.yml | 40 + ...io.operations.HealthMonitorsOperations.yml | 329 + ...kloadmonitor.aio.operations.Operations.yml | 33 + ...re.mgmt.workloadmonitor.aio.operations.yml | 8 + .../azure.mgmt.workloadmonitor.aio.yml | 9 + ...mt.workloadmonitor.models.ErrorDetails.yml | 26 + ...t.workloadmonitor.models.ErrorResponse.yml | 18 + ...kloadmonitor.models.ErrorResponseError.yml | 41 + ...t.workloadmonitor.models.HealthMonitor.yml | 124 + ...rkloadmonitor.models.HealthMonitorList.yml | 27 + ...onitor.models.HealthMonitorStateChange.yml | 107 + ...or.models.HealthMonitorStateChangeList.yml | 28 + ...gmt.workloadmonitor.models.HealthState.yml | 19 + ....mgmt.workloadmonitor.models.Operation.yml | 46 + ...orkloadmonitor.models.OperationDisplay.yml | 46 + ...t.workloadmonitor.models.OperationList.yml | 27 + ...e.mgmt.workloadmonitor.models.Resource.yml | 24 + .../azure.mgmt.workloadmonitor.models.yml | 19 + ...or.operations.HealthMonitorsOperations.yml | 329 + ....workloadmonitor.operations.Operations.yml | 33 + .../azure.mgmt.workloadmonitor.operations.yml | 8 + .../azure.mgmt.workloadmonitor.yml | 11 + ...e.purview.catalog.PurviewCatalogClient.yml | 116 + ...rview.catalog.aio.PurviewCatalogClient.yml | 116 + ...og.aio.operations.CollectionOperations.yml | 792 + ...log.aio.operations.DiscoveryOperations.yml | 272 + ...atalog.aio.operations.EntityOperations.yml | 3117 ++ ...alog.aio.operations.GlossaryOperations.yml | 4767 ++ ...talog.aio.operations.LineageOperations.yml | 401 + ....aio.operations.RelationshipOperations.yml | 274 + ...catalog.aio.operations.TypesOperations.yml | 5787 +++ .../azure.purview.catalog.aio.operations.yml | 13 + .../azure.purview.catalog.aio.yml | 9 + ...atalog.operations.CollectionOperations.yml | 792 + ...catalog.operations.DiscoveryOperations.yml | 272 + ...ew.catalog.operations.EntityOperations.yml | 3115 ++ ....catalog.operations.GlossaryOperations.yml | 4765 ++ ...w.catalog.operations.LineageOperations.yml | 400 + ...alog.operations.RelationshipOperations.yml | 274 + ...iew.catalog.operations.TypesOperations.yml | 5786 +++ .../azure.purview.catalog.operations.yml | 13 + .../azure.purview.catalog.yml | 10 + .../azure.servicemanagement.constants.yml | 4 + ...ement.models.AdditionalUnattendContent.yml | 7 + ...servicemanagement.models.AffinityGroup.yml | 7 + ...ervicemanagement.models.AffinityGroups.yml | 7 + ...ent.models.AsynchronousOperationResult.yml | 10 + ...re.servicemanagement.models.AttachedTo.yml | 7 + ...icemanagement.models.AuthorizationRule.yml | 7 + ...cemanagement.models.AuthorizationRules.yml | 7 + ...management.models.AvailabilityResponse.yml | 7 + ...nt.models.AzureAsyncOperationHttpError.yml | 28 + ...management.models.CaptureRoleAsVMImage.yml | 23 + ...e.servicemanagement.models.Certificate.yml | 7 + ...cemanagement.models.CertificateSetting.yml | 17 + ....servicemanagement.models.Certificates.yml | 7 + ....servicemanagement.models.CloudService.yml | 7 + ...servicemanagement.models.CloudServices.yml | 7 + ...vicemanagement.models.ComponentSetting.yml | 7 + ...icemanagement.models.ComponentSettings.yml | 7 + ...re.servicemanagement.models.Components.yml | 7 + ...emanagement.models.ComputeCapabilities.yml | 7 + ...vicemanagement.models.ConfigurationSet.yml | 7 + ...t.models.ConfigurationSetInputEndpoint.yml | 29 + ....models.ConfigurationSetInputEndpoints.yml | 7 + ...icemanagement.models.ConfigurationSets.yml | 7 + ....servicemanagement.models.CountDetails.yml | 7 + ...management.models.CreateServerResponse.yml | 7 + ...e.servicemanagement.models.Credentials.yml | 7 + .../azure.servicemanagement.models.Data.yml | 7 + ...anagement.models.DataDiskConfiguration.yml | 7 + ...nagement.models.DataDiskConfigurations.yml | 7 + ...emanagement.models.DataVirtualHardDisk.yml | 20 + ...management.models.DataVirtualHardDisks.yml | 7 + ...zure.servicemanagement.models.Database.yml | 7 + ...re.servicemanagement.models.Deployment.yml | 7 + ...e.servicemanagement.models.Deployments.yml | 7 + .../azure.servicemanagement.models.Disk.yml | 7 + .../azure.servicemanagement.models.Disks.yml | 7 + ...ure.servicemanagement.models.DnsServer.yml | 7 + ...re.servicemanagement.models.DomainJoin.yml | 7 + ...zure.servicemanagement.models.EventLog.yml | 7 + ....servicemanagement.models.FirewallRule.yml | 7 + ...vicemanagement.models.HostNameSslState.yml | 7 + ...icemanagement.models.HostNameSslStates.yml | 7 + ...servicemanagement.models.HostedService.yml | 7 + ...agement.models.HostedServiceProperties.yml | 7 + ...ervicemanagement.models.HostedServices.yml | 7 + .../azure.servicemanagement.models.Images.yml | 7 + ...servicemanagement.models.InputEndpoint.yml | 7 + ...ervicemanagement.models.InputEndpoints.yml | 7 + ...vicemanagement.models.InstanceEndpoint.yml | 7 + ...icemanagement.models.InstanceEndpoints.yml | 7 + ...icemanagement.models.IntrinsicSettings.yml | 7 + ...azure.servicemanagement.models.KeyPair.yml | 10 + ...zure.servicemanagement.models.KeyPairs.yml | 7 + ...anagement.models.LinuxConfigurationSet.yml | 19 + ...zure.servicemanagement.models.Listener.yml | 16 + ...ure.servicemanagement.models.Listeners.yml | 7 + ...icemanagement.models.LoadBalancerProbe.yml | 7 + ...zure.servicemanagement.models.Location.yml | 7 + ...ure.servicemanagement.models.Locations.yml | 7 + ...servicemanagement.models.MaxRecurrence.yml | 7 + ...management.models.MetricAvailabilities.yml | 7 + ...cemanagement.models.MetricAvailability.yml | 7 + ...vicemanagement.models.MetricDefinition.yml | 7 + ...icemanagement.models.MetricDefinitions.yml | 7 + ...vicemanagement.models.MetricProperties.yml | 7 + ...ervicemanagement.models.MetricResponse.yml | 7 + ...rvicemanagement.models.MetricResponses.yml | 7 + ...servicemanagement.models.MetricRollups.yml | 7 + ....servicemanagement.models.MetricSample.yml | 7 + ....servicemanagement.models.MetricValues.yml | 7 + ...ment.models.NotificationHubDescription.yml | 7 + ...emanagement.models.OSDiskConfiguration.yml | 7 + ...azure.servicemanagement.models.OSImage.yml | 7 + ...ervicemanagement.models.OSImageDetails.yml | 7 + ...icemanagement.models.OSVirtualHardDisk.yml | 23 + ...rvicemanagement.models.OperatingSystem.yml | 7 + ...agement.models.OperatingSystemFamilies.yml | 7 + ...anagement.models.OperatingSystemFamily.yml | 7 + ...vicemanagement.models.OperatingSystems.yml | 7 + ...ure.servicemanagement.models.Operation.yml | 7 + ...rvicemanagement.models.OperationCaller.yml | 7 + ...ervicemanagement.models.OperationError.yml | 7 + ...rvicemanagement.models.OperationStatus.yml | 7 + .../azure.servicemanagement.models.Passes.yml | 7 + ...gement.models.PersistentVMDowntimeInfo.yml | 7 + ...vicemanagement.models.PersistentVMRole.yml | 7 + ...zure.servicemanagement.models.PublicIP.yml | 9 + ...ure.servicemanagement.models.PublicIPs.yml | 7 + ...ure.servicemanagement.models.PublicKey.yml | 10 + ...re.servicemanagement.models.PublicKeys.yml | 7 + ...e.servicemanagement.models.PublishData.yml | 7 + ...ervicemanagement.models.PublishProfile.yml | 7 + ...vicemanagement.models.QueueDescription.yml | 7 + .../azure.servicemanagement.models.Quota.yml | 7 + ...vicemanagement.models.RelayDescription.yml | 7 + ...emanagement.models.ReplicationProgress.yml | 7 + ...ment.models.ReplicationProgressElement.yml | 7 + ...re.servicemanagement.models.ReservedIP.yml | 7 + ...e.servicemanagement.models.ReservedIPs.yml | 7 + ...zure.servicemanagement.models.Resource.yml | 7 + ...icemanagement.models.ResourceExtension.yml | 7 + ...models.ResourceExtensionParameterValue.yml | 7 + ...odels.ResourceExtensionParameterValues.yml | 7 + ...ment.models.ResourceExtensionReference.yml | 12 + ...ent.models.ResourceExtensionReferences.yml | 7 + ...cemanagement.models.ResourceExtensions.yml | 7 + ...ure.servicemanagement.models.Resources.yml | 7 + .../azure.servicemanagement.models.Role.yml | 7 + ....servicemanagement.models.RoleInstance.yml | 7 + ...vicemanagement.models.RoleInstanceList.yml | 7 + ...zure.servicemanagement.models.RoleList.yml | 7 + ...zure.servicemanagement.models.RoleSize.yml | 7 + ...ure.servicemanagement.models.RoleSizes.yml | 7 + .../azure.servicemanagement.models.SSH.yml | 7 + .../azure.servicemanagement.models.Server.yml | 7 + ...e.servicemanagement.models.ServerQuota.yml | 7 + ...azure.servicemanagement.models.Servers.yml | 7 + ...emanagement.models.ServiceBusNamespace.yml | 7 + ...vicemanagement.models.ServiceBusRegion.yml | 7 + ...vicemanagement.models.ServiceObjective.yml | 7 + .../azure.servicemanagement.models.Site.yml | 7 + .../azure.servicemanagement.models.Sites.yml | 7 + ...gement.models.StorageAccountProperties.yml | 7 + ...ervicemanagement.models.StorageService.yml | 7 + ...cemanagement.models.StorageServiceKeys.yml | 7 + ...rvicemanagement.models.StorageServices.yml | 7 + ...ement.models.StoredCertificateSettings.yml | 7 + .../azure.servicemanagement.models.Subnet.yml | 7 + ...azure.servicemanagement.models.Subnets.yml | 7 + ....servicemanagement.models.Subscription.yml | 7 + ...agement.models.SubscriptionCertificate.yml | 7 + ...gement.models.SubscriptionCertificates.yml | 7 + ...anagement.models.SubscriptionOperation.yml | 7 + ...models.SubscriptionOperationCollection.yml | 7 + ...ent.models.SubscriptionOperationStatus.yml | 7 + ...nagement.models.SubscriptionOperations.yml | 7 + ...servicemanagement.models.Subscriptions.yml | 7 + ...vicemanagement.models.TopicDescription.yml | 7 + ...icemanagement.models.UnattendComponent.yml | 7 + ....servicemanagement.models.UnattendPass.yml | 7 + ...servicemanagement.models.UpgradeStatus.yml | 7 + ...azure.servicemanagement.models.VMImage.yml | 14 + ...zure.servicemanagement.models.VMImages.yml | 7 + .../azure.servicemanagement.models.Values.yml | 7 + ...ure.servicemanagement.models.VirtualIP.yml | 7 + ...re.servicemanagement.models.VirtualIPs.yml | 7 + ...cemanagement.models.VirtualNetworkSite.yml | 7 + ...emanagement.models.VirtualNetworkSites.yml | 7 + ...zure.servicemanagement.models.WebSpace.yml | 7 + ...ure.servicemanagement.models.WebSpaces.yml | 7 + .../azure.servicemanagement.models.WinRM.yml | 11 + ...agement.models.WindowsConfigurationSet.yml | 23 + .../azure.servicemanagement.models.yml | 157 + ...zure.servicemanagement.publishsettings.yml | 22 + ...mentservice.SchedulerManagementService.yml | 333 + ...emanagement.schedulermanagementservice.yml | 6 + ...entservice.ServiceBusManagementService.yml | 441 + ...management.servicebusmanagementservice.yml | 6 + ...vicemanagement.servicemanagementclient.yml | 12 + ...gementservice.ServiceManagementService.yml | 1936 + ...icemanagement.servicemanagementservice.yml | 6 + ...ntservice.SqlDatabaseManagementService.yml | 403 + ...anagement.sqldatabasemanagementservice.yml | 6 + ...gementservice.WebsiteManagementService.yml | 349 + ...icemanagement.websitemanagementservice.yml | 6 + ...ob.appendblobservice.AppendBlobService.yml | 4880 ++ .../azure.storage.blob.appendblobservice.yml | 6 + ...e.blob.baseblobservice.BaseBlobService.yml | 3913 ++ .../azure.storage.blob.baseblobservice.yml | 6 + ...blob.blockblobservice.BlockBlobService.yml | 4996 ++ .../azure.storage.blob.blockblobservice.yml | 6 + ...storage.blob.models.AccountInformation.yml | 23 + ...rage.blob.models.AppendBlockProperties.yml | 24 + ...rage.blob.models.BatchDeleteSubRequest.yml | 99 + ...blob.models.BatchSetBlobTierSubRequest.yml | 38 + ...e.storage.blob.models.BatchSubResponse.yml | 26 + .../azure.storage.blob.models.Blob.yml | 58 + .../azure.storage.blob.models.BlobBlock.yml | 28 + ...zure.storage.blob.models.BlobBlockList.yml | 17 + ...ure.storage.blob.models.BlobBlockState.yml | 21 + ...re.storage.blob.models.BlobPermissions.yml | 94 + .../azure.storage.blob.models.BlobPrefix.yml | 17 + ...ure.storage.blob.models.BlobProperties.yml | 107 + ...zure.storage.blob.models.BlockListType.yml | 23 + .../azure.storage.blob.models.Container.yml | 35 + ...orage.blob.models.ContainerPermissions.yml | 121 + ...torage.blob.models.ContainerProperties.yml | 31 + ...re.storage.blob.models.ContentSettings.yml | 65 + ...ure.storage.blob.models.CopyProperties.yml | 71 + ...b.models.CustomerProvidedEncryptionKey.yml | 55 + ...ure.storage.blob.models.DeleteSnapshot.yml | 18 + .../azure.storage.blob.models.Include.yml | 89 + ...re.storage.blob.models.LeaseProperties.yml | 26 + ...storage.blob.models.PageBlobProperties.yml | 20 + .../azure.storage.blob.models.PageRange.yml | 30 + ...torage.blob.models.PremiumPageBlobTier.yml | 48 + ...azure.storage.blob.models.PublicAccess.yml | 36 + ....storage.blob.models.RehydratePriority.yml | 17 + ...storage.blob.models.ResourceProperties.yml | 39 + ...orage.blob.models.SequenceNumberAction.yml | 25 + ...e.storage.blob.models.StandardBlobTier.yml | 22 + ....storage.blob.models.UserDelegationKey.yml | 45 + .../azure.storage.blob.models.yml | 36 + ...e.blob.pageblobservice.PageBlobService.yml | 5576 +++ .../azure.storage.blob.pageblobservice.yml | 6 + ...esssignature.BlobSharedAccessSignature.yml | 398 + ...ure.storage.blob.sharedaccesssignature.yml | 6 + .../azure-storage-blob/azure.storage.blob.yml | 12 + ...loudstorageaccount.CloudStorageAccount.yml | 197 + ...ure.storage.common.cloudstorageaccount.yml | 6 + ...ure.storage.common.models.AccessPolicy.yml | 84 + ...orage.common.models.AccountPermissions.yml | 140 + .../azure.storage.common.models.CorsRule.yml | 68 + ...ge.common.models.DeleteRetentionPolicy.yml | 28 + ...e.storage.common.models.GeoReplication.yml | 35 + ...re.storage.common.models.ListGenerator.yml | 30 + ...ure.storage.common.models.LocationMode.yml | 21 + .../azure.storage.common.models.Logging.yml | 50 + .../azure.storage.common.models.Metrics.yml | 42 + .../azure.storage.common.models.Protocol.yml | 19 + ...re.storage.common.models.ResourceTypes.yml | 68 + ....storage.common.models.RetentionPolicy.yml | 47 + ...ure.storage.common.models.RetryContext.yml | 42 + ...torage.common.models.ServiceProperties.yml | 37 + ...ure.storage.common.models.ServiceStats.yml | 18 + .../azure.storage.common.models.Services.yml | 64 + ...re.storage.common.models.StaticWebsite.yml | 31 + .../azure.storage.common.models.yml | 22 + ....storage.common.retry.ExponentialRetry.yml | 65 + ...azure.storage.common.retry.LinearRetry.yml | 48 + .../azure.storage.common.retry.yml | 22 + ...daccesssignature.SharedAccessSignature.yml | 125 + ...e.storage.common.sharedaccesssignature.yml | 6 + ...age.common.storageclient.StorageClient.yml | 154 + .../azure.storage.common.storageclient.yml | 6 + ...common.tokencredential.TokenCredential.yml | 47 + .../azure.storage.common.tokencredential.yml | 6 + .../azure.storage.common.yml | 12 + ...e.storage.file.fileservice.FileService.yml | 3066 ++ .../azure.storage.file.fileservice.yml | 6 + ...re.storage.file.models.ContentSettings.yml | 65 + ...ure.storage.file.models.CopyProperties.yml | 71 + ...ure.storage.file.models.DeleteSnapshot.yml | 14 + .../azure.storage.file.models.Directory.yml | 35 + ...torage.file.models.DirectoryProperties.yml | 27 + .../azure.storage.file.models.File.yml | 41 + ...re.storage.file.models.FilePermissions.yml | 79 + ...ure.storage.file.models.FileProperties.yml | 54 + .../azure.storage.file.models.FileRange.yml | 22 + .../azure.storage.file.models.Handle.yml | 68 + ...re.storage.file.models.LeaseProperties.yml | 26 + ...ure.storage.file.models.NTFSAttributes.yml | 109 + ...zure.storage.file.models.SMBProperties.yml | 55 + .../azure.storage.file.models.Share.yml | 45 + ...e.storage.file.models.SharePermissions.yml | 98 + ...re.storage.file.models.ShareProperties.yml | 23 + .../azure.storage.file.models.yml | 21 + ...esssignature.FileSharedAccessSignature.yml | 387 + ...ure.storage.file.sharedaccesssignature.yml | 6 + .../azure-storage-file/azure.storage.file.yml | 9 + .../azure.storage.queue.models.Queue.yml | 23 + ...zure.storage.queue.models.QueueMessage.yml | 57 + ...torage.queue.models.QueueMessageFormat.yml | 128 + ....storage.queue.models.QueuePermissions.yml | 72 + .../azure.storage.queue.models.yml | 9 + ...torage.queue.queueservice.QueueService.yml | 1116 + .../azure.storage.queue.queueservice.yml | 6 + ...sssignature.QueueSharedAccessSignature.yml | 211 + ...re.storage.queue.sharedaccesssignature.yml | 6 + .../azure.storage.queue.yml | 9 + .../azure.synapse.SynapseClient.yml | 46 + ...apse.accesscontrol.AccessControlClient.yml | 35 + ....accesscontrol.aio.AccessControlClient.yml | 35 + ...erations_async.AccessControlOperations.yml | 186 + ...pse.accesscontrol.aio.operations_async.yml | 7 + .../azure.synapse.accesscontrol.aio.yml | 9 + ...pse.accesscontrol.models.ErrorContract.yml | 123 + ...napse.accesscontrol.models.ErrorDetail.yml | 139 + ...pse.accesscontrol.models.ErrorResponse.yml | 146 + ...sscontrol.models.RoleAssignmentDetails.yml | 138 + ...sscontrol.models.RoleAssignmentOptions.yml | 133 + ...accesscontrol.models.RolesListResponse.yml | 134 + ...napse.accesscontrol.models.SynapseRole.yml | 141 + .../azure.synapse.accesscontrol.models.yml | 13 + ...rol.operations.AccessControlOperations.yml | 186 + ...azure.synapse.accesscontrol.operations.yml | 7 + .../azure.synapse.accesscontrol.yml | 11 + .../azure.synapse.aio.SynapseClient.yml | 45 + ....operations_async.MonitoringOperations.yml | 244 + ....operations_async.SparkBatchOperations.yml | 193 + ...perations_async.SparkSessionOperations.yml | 368 + ...perations_async.WorkspaceAclOperations.yml | 85 + .../azure.synapse.aio.operations_async.yml | 10 + .../azure-synapse/azure.synapse.aio.yml | 9 + ...zure.synapse.artifacts.ArtifactsClient.yml | 75 + ....synapse.artifacts.aio.ArtifactsClient.yml | 75 + ...s_async.DataFlowDebugSessionOperations.yml | 172 + ...io.operations_async.DataFlowOperations.yml | 138 + ...aio.operations_async.DatasetOperations.yml | 139 + ...erations_async.LinkedServiceOperations.yml | 141 + ...io.operations_async.NotebookOperations.yml | 155 + ...io.operations_async.PipelineOperations.yml | 191 + ...operations_async.PipelineRunOperations.yml | 140 + ...ons_async.SparkJobDefinitionOperations.yml | 221 + ...o.operations_async.SqlScriptOperations.yml | 139 + ...aio.operations_async.TriggerOperations.yml | 315 + ....operations_async.TriggerRunOperations.yml | 84 + ...synapse.artifacts.aio.operations_async.yml | 17 + .../azure.synapse.artifacts.aio.yml | 9 + ...zure.synapse.artifacts.models.Activity.yml | 170 + ...se.artifacts.models.ActivityDependency.yml | 145 + ...ynapse.artifacts.models.ActivityPolicy.yml | 179 + ...e.synapse.artifacts.models.ActivityRun.yml | 182 + ...facts.models.ActivityRunsQueryResponse.yml | 137 + ...dels.AddDataFlowToDebugSessionResponse.yml | 123 + ...rtifacts.models.AmazonMWSLinkedService.yml | 260 + ...rtifacts.models.AmazonMWSObjectDataset.yml | 203 + ...cts.models.AmazonRedshiftLinkedService.yml | 226 + ...acts.models.AmazonRedshiftTableDataset.yml | 225 + ...artifacts.models.AmazonS3LinkedService.yml | 209 + ...rtifacts.models.AppendVariableActivity.yml | 178 + ....artifacts.models.AvroCompressionCodec.yml | 16 + ...e.synapse.artifacts.models.AvroDataset.yml | 220 + ...tifacts.models.AzureBatchLinkedService.yml | 222 + ...ifacts.models.AzureBlobFSLinkedService.yml | 228 + ...s.models.AzureBlobStorageLinkedService.yml | 254 + ...odels.AzureDataExplorerCommandActivity.yml | 198 + ....models.AzureDataExplorerLinkedService.yml | 215 + ...s.models.AzureDataExplorerTableDataset.yml | 205 + ...ls.AzureDataLakeAnalyticsLinkedService.yml | 244 + ...models.AzureDataLakeStoreLinkedService.yml | 245 + ...ts.models.AzureDatabricksLinkedService.yml | 333 + ...s.models.AzureFileStorageLinkedService.yml | 204 + ...artifacts.models.AzureFunctionActivity.yml | 225 + ...cts.models.AzureFunctionActivityMethod.yml | 21 + ...acts.models.AzureFunctionLinkedService.yml | 194 + ...acts.models.AzureKeyVaultLinkedService.yml | 174 + ...ts.models.AzureKeyVaultSecretReference.yml | 152 + ...s.models.AzureMLBatchExecutionActivity.yml | 226 + ....models.AzureMLExecutePipelineActivity.yml | 244 + ....artifacts.models.AzureMLLinkedService.yml | 236 + ...cts.models.AzureMLServiceLinkedService.yml | 238 + ...s.models.AzureMLUpdateResourceActivity.yml | 210 + ...artifacts.models.AzureMLWebServiceFile.yml | 140 + ...facts.models.AzureMariaDBLinkedService.yml | 194 + ...ifacts.models.AzureMariaDBTableDataset.yml | 203 + ...tifacts.models.AzureMySqlLinkedService.yml | 193 + ...rtifacts.models.AzureMySqlTableDataset.yml | 216 + ...ts.models.AzurePostgreSqlLinkedService.yml | 194 + ...cts.models.AzurePostgreSqlTableDataset.yml | 226 + ...tifacts.models.AzureSearchIndexDataset.yml | 204 + ...ifacts.models.AzureSearchLinkedService.yml | 194 + ...tifacts.models.AzureSqlDWLinkedService.yml | 223 + ...rtifacts.models.AzureSqlDWTableDataset.yml | 225 + ...s.models.AzureSqlDatabaseLinkedService.yml | 223 + ...tifacts.models.AzureSqlMILinkedService.yml | 223 + ...rtifacts.models.AzureSqlMITableDataset.yml | 225 + ....artifacts.models.AzureSqlTableDataset.yml | 224 + ...facts.models.AzureStorageLinkedService.yml | 213 + ...pse.artifacts.models.AzureTableDataset.yml | 205 + ....models.AzureTableStorageLinkedService.yml | 213 + ....artifacts.models.BigDataPoolReference.yml | 138 + ...synapse.artifacts.models.BinaryDataset.yml | 210 + ...rtifacts.models.CassandraLinkedService.yml | 222 + ...artifacts.models.CassandraTableDataset.yml | 216 + ...ynapse.artifacts.models.CellOutputType.yml | 15 + ...re.synapse.artifacts.models.CloudError.yml | 148 + ....CommonDataServiceForAppsEntityDataset.yml | 206 + ....CommonDataServiceForAppsLinkedService.yml | 329 + ...e.artifacts.models.ConcurLinkedService.yml | 233 + ...e.artifacts.models.ConcurObjectDataset.yml | 202 + ...napse.artifacts.models.ControlActivity.yml | 163 + ....synapse.artifacts.models.CopyActivity.yml | 293 + ...zure.synapse.artifacts.models.CopySink.yml | 186 + ...re.synapse.artifacts.models.CopySource.yml | 167 + ...artifacts.models.CosmosDbLinkedService.yml | 214 + ...ls.CosmosDbMongoDbApiCollectionDataset.yml | 205 + ...models.CosmosDbMongoDbApiLinkedService.yml | 185 + ...models.CosmosDbSqlApiCollectionDataset.yml | 204 + ...rtifacts.models.CouchbaseLinkedService.yml | 195 + ...artifacts.models.CouchbaseTableDataset.yml | 202 + ...dels.CreateDataFlowDebugSessionRequest.yml | 161 + ...els.CreateDataFlowDebugSessionResponse.yml | 123 + ...pse.artifacts.models.CreateRunResponse.yml | 126 + ...ynapse.artifacts.models.CustomActivity.yml | 236 + ...s.models.CustomActivityReferenceObject.yml | 131 + ...s.models.CustomDataSourceLinkedService.yml | 171 + ...zure.synapse.artifacts.models.DataFlow.yml | 155 + ...e.artifacts.models.DataFlowComputeType.yml | 13 + ...cts.models.DataFlowDebugCommandRequest.yml | 146 + ...ts.models.DataFlowDebugCommandResponse.yml | 132 + ....artifacts.models.DataFlowDebugPackage.yml | 171 + ...dels.DataFlowDebugPackageDebugSettings.yml | 139 + ...models.DataFlowDebugPreviewDataRequest.yml | 146 + ...acts.models.DataFlowDebugQueryResponse.yml | 124 + ...artifacts.models.DataFlowDebugResource.yml | 134 + ...cts.models.DataFlowDebugResultResponse.yml | 132 + ...ifacts.models.DataFlowDebugSessionInfo.yml | 193 + ....models.DataFlowDebugStatisticsRequest.yml | 146 + ...ynapse.artifacts.models.DataFlowFolder.yml | 124 + ....artifacts.models.DataFlowListResponse.yml | 134 + ...pse.artifacts.models.DataFlowReference.yml | 155 + ...apse.artifacts.models.DataFlowResource.yml | 146 + ....synapse.artifacts.models.DataFlowSink.yml | 141 + ...ynapse.artifacts.models.DataFlowSource.yml | 141 + ...artifacts.models.DataFlowSourceSetting.yml | 140 + ...e.artifacts.models.DataFlowStagingInfo.yml | 131 + ...s.models.DataLakeAnalyticsUSQLActivity.yml | 247 + ...acts.models.DatabricksNotebookActivity.yml | 210 + ...acts.models.DatabricksSparkJarActivity.yml | 208 + ...s.models.DatabricksSparkPythonActivity.yml | 205 + ...azure.synapse.artifacts.models.Dataset.yml | 221 + ...tifacts.models.DatasetBZip2Compression.yml | 134 + ...se.artifacts.models.DatasetCompression.yml | 140 + ...tifacts.models.DatasetCompressionLevel.yml | 11 + ....artifacts.models.DatasetDebugResource.yml | 133 + ...facts.models.DatasetDeflateCompression.yml | 143 + ...synapse.artifacts.models.DatasetFolder.yml | 124 + ...rtifacts.models.DatasetGZipCompression.yml | 143 + ...e.artifacts.models.DatasetListResponse.yml | 134 + ...napse.artifacts.models.DatasetLocation.yml | 159 + ...apse.artifacts.models.DatasetReference.yml | 146 + ...napse.artifacts.models.DatasetResource.yml | 146 + ...ts.models.DatasetZipDeflateCompression.yml | 143 + ...apse.artifacts.models.Db2LinkedService.yml | 247 + ...napse.artifacts.models.Db2TableDataset.yml | 222 + ...ynapse.artifacts.models.DeleteActivity.yml | 226 + ...dels.DeleteDataFlowDebugSessionRequest.yml | 131 + ...s.models.DelimitedTextCompressionCodec.yml | 18 + ....artifacts.models.DelimitedTextDataset.yml | 297 + ...e.artifacts.models.DependencyCondition.yml | 14 + ...cts.models.DocumentDbCollectionDataset.yml | 204 + ...se.artifacts.models.DrillLinkedService.yml | 193 + ...pse.artifacts.models.DrillTableDataset.yml | 222 + ...tifacts.models.DynamicsAXLinkedService.yml | 232 + ...facts.models.DynamicsAXResourceDataset.yml | 205 + ...acts.models.DynamicsAuthenticationType.yml | 19 + ...ifacts.models.DynamicsCrmEntityDataset.yml | 206 + ...ifacts.models.DynamicsCrmLinkedService.yml | 325 + ...rtifacts.models.DynamicsDeploymentType.yml | 17 + ...artifacts.models.DynamicsEntityDataset.yml | 205 + ...artifacts.models.DynamicsLinkedService.yml | 318 + ...DynamicsServicePrincipalCredentialType.yml | 16 + ...e.artifacts.models.EloquaLinkedService.yml | 233 + ...e.artifacts.models.EloquaObjectDataset.yml | 202 + ...dels.EvaluateDataFlowExpressionRequest.yml | 153 + ...tifacts.models.EventSubscriptionStatus.yml | 17 + ...tifacts.models.ExecuteDataFlowActivity.yml | 209 + ...eDataFlowActivityTypePropertiesCompute.yml | 137 + ...tifacts.models.ExecutePipelineActivity.yml | 187 + ...acts.models.ExecuteSSISPackageActivity.yml | 281 + ...pse.artifacts.models.ExecutionActivity.yml | 189 + ...rtifacts.models.ExposureControlRequest.yml | 131 + ...tifacts.models.ExposureControlResponse.yml | 126 + ...re.synapse.artifacts.models.Expression.yml | 138 + ...tifacts.models.FileServerLinkedService.yml | 204 + ...ynapse.artifacts.models.FilterActivity.yml | 178 + ...napse.artifacts.models.ForEachActivity.yml | 196 + ...artifacts.models.FtpAuthenticationType.yml | 11 + ...rtifacts.models.FtpServerLinkedService.yml | 250 + ...e.artifacts.models.GetMetadataActivity.yml | 193 + ...ts.models.GetSsisObjectMetadataRequest.yml | 123 + ...models.GoogleAdWordsAuthenticationType.yml | 14 + ...acts.models.GoogleAdWordsLinkedService.yml | 286 + ...acts.models.GoogleAdWordsObjectDataset.yml | 203 + ...odels.GoogleBigQueryAuthenticationType.yml | 14 + ...cts.models.GoogleBigQueryLinkedService.yml | 294 + ...cts.models.GoogleBigQueryObjectDataset.yml | 226 + ...models.GoogleCloudStorageLinkedService.yml | 213 + ...rtifacts.models.GreenplumLinkedService.yml | 193 + ...artifacts.models.GreenplumTableDataset.yml | 222 + ...tifacts.models.HBaseAuthenticationType.yml | 11 + ...se.artifacts.models.HBaseLinkedService.yml | 274 + ...se.artifacts.models.HBaseObjectDataset.yml | 202 + ...odels.HDInsightActivityDebugInfoOption.yml | 13 + ...artifacts.models.HDInsightHiveActivity.yml | 243 + ...rtifacts.models.HDInsightLinkedService.yml | 240 + ...acts.models.HDInsightMapReduceActivity.yml | 242 + ....models.HDInsightOnDemandLinkedService.yml | 490 + ....artifacts.models.HDInsightPigActivity.yml | 227 + ...rtifacts.models.HDInsightSparkActivity.yml | 251 + ...acts.models.HDInsightStreamingActivity.yml | 277 + ...pse.artifacts.models.HdfsLinkedService.yml | 214 + ....synapse.artifacts.models.HdiNodeTypes.yml | 13 + ...rtifacts.models.HiveAuthenticationType.yml | 15 + ...pse.artifacts.models.HiveLinkedService.yml | 334 + ...pse.artifacts.models.HiveObjectDataset.yml | 222 + ...ynapse.artifacts.models.HiveServerType.yml | 13 + ...cts.models.HiveThriftTransportProtocol.yml | 13 + ...rtifacts.models.HttpAuthenticationType.yml | 17 + ...pse.artifacts.models.HttpLinkedService.yml | 260 + ....artifacts.models.HubspotLinkedService.yml | 240 + ....artifacts.models.HubspotObjectDataset.yml | 202 + ...e.artifacts.models.IfConditionActivity.yml | 200 + ...ifacts.models.ImpalaAuthenticationType.yml | 13 + ...e.artifacts.models.ImpalaLinkedService.yml | 278 + ...e.artifacts.models.ImpalaObjectDataset.yml | 223 + ...artifacts.models.InformixLinkedService.yml | 229 + ....artifacts.models.InformixTableDataset.yml | 204 + ...cts.models.IntegrationRuntimeReference.yml | 148 + ...pse.artifacts.models.JiraLinkedService.yml | 246 + ...pse.artifacts.models.JiraObjectDataset.yml | 202 + ...e.synapse.artifacts.models.JsonDataset.yml | 228 + ...synapse.artifacts.models.LinkedService.yml | 195 + ...acts.models.LinkedServiceDebugResource.yml | 134 + ...facts.models.LinkedServiceListResponse.yml | 134 + ...rtifacts.models.LinkedServiceReference.yml | 146 + ...artifacts.models.LinkedServiceResource.yml | 146 + ...se.artifacts.models.LogStorageSettings.yml | 146 + ...ynapse.artifacts.models.LookupActivity.yml | 204 + ....artifacts.models.MagentoLinkedService.yml | 223 + ....artifacts.models.MagentoObjectDataset.yml | 202 + ...napse.artifacts.models.MappingDataFlow.yml | 179 + ....artifacts.models.MariaDBLinkedService.yml | 193 + ...e.artifacts.models.MariaDBTableDataset.yml | 202 + ....artifacts.models.MarketoLinkedService.yml | 230 + ....artifacts.models.MarketoObjectDataset.yml | 202 + ...ts.models.MicrosoftAccessLinkedService.yml | 229 + ...cts.models.MicrosoftAccessTableDataset.yml | 206 + ...facts.models.MongoDbAuthenticationType.yml | 11 + ...ifacts.models.MongoDbCollectionDataset.yml | 204 + ....artifacts.models.MongoDbLinkedService.yml | 266 + ...acts.models.MongoDbV2CollectionDataset.yml | 205 + ...rtifacts.models.MongoDbV2LinkedService.yml | 183 + ...tifacts.models.MultiplePipelineTrigger.yml | 169 + ...se.artifacts.models.MySqlLinkedService.yml | 191 + ...pse.artifacts.models.MySqlTableDataset.yml | 203 + ....artifacts.models.NetezzaLinkedService.yml | 193 + ...e.artifacts.models.NetezzaTableDataset.yml | 224 + ...zure.synapse.artifacts.models.Notebook.yml | 184 + ....synapse.artifacts.models.NotebookCell.yml | 165 + ...rtifacts.models.NotebookCellOutputItem.yml | 170 + ...se.artifacts.models.NotebookKernelSpec.yml | 143 + ....artifacts.models.NotebookLanguageInfo.yml | 143 + ....artifacts.models.NotebookListResponse.yml | 134 + ...apse.artifacts.models.NotebookMetadata.yml | 141 + ...apse.artifacts.models.NotebookResource.yml | 146 + ...facts.models.NotebookSessionProperties.yml | 155 + ...ODataAadServicePrincipalCredentialType.yml | 11 + ...tifacts.models.ODataAuthenticationType.yml | 17 + ...se.artifacts.models.ODataLinkedService.yml | 293 + ....artifacts.models.ODataResourceDataset.yml | 203 + ...pse.artifacts.models.OdbcLinkedService.yml | 227 + ...apse.artifacts.models.OdbcTableDataset.yml | 203 + ...apse.artifacts.models.Office365Dataset.yml | 216 + ...rtifacts.models.Office365LinkedService.yml | 213 + ...e.artifacts.models.OracleLinkedService.yml | 193 + ...models.OracleServiceCloudLinkedService.yml | 238 + ...models.OracleServiceCloudObjectDataset.yml | 203 + ...se.artifacts.models.OracleTableDataset.yml | 224 + ...e.artifacts.models.OrcCompressionCodec.yml | 12 + ...re.synapse.artifacts.models.OrcDataset.yml | 211 + ...rtifacts.models.ParameterSpecification.yml | 138 + ...synapse.artifacts.models.ParameterType.yml | 21 + ...tifacts.models.ParquetCompressionCodec.yml | 14 + ...ynapse.artifacts.models.ParquetDataset.yml | 211 + ...e.artifacts.models.PaypalLinkedService.yml | 230 + ...e.artifacts.models.PaypalObjectDataset.yml | 202 + ...facts.models.PhoenixAuthenticationType.yml | 13 + ....artifacts.models.PhoenixLinkedService.yml | 289 + ....artifacts.models.PhoenixObjectDataset.yml | 224 + ...ynapse.artifacts.models.PipelineFolder.yml | 124 + ....artifacts.models.PipelineListResponse.yml | 134 + ...pse.artifacts.models.PipelineReference.yml | 145 + ...apse.artifacts.models.PipelineResource.yml | 209 + ...e.synapse.artifacts.models.PipelineRun.yml | 181 + ....artifacts.models.PipelineRunInvokedBy.yml | 130 + ...facts.models.PipelineRunsQueryResponse.yml | 137 + ...se.artifacts.models.PluginCurrentState.yml | 20 + ...tifacts.models.PostgreSqlLinkedService.yml | 191 + ...rtifacts.models.PostgreSqlTableDataset.yml | 223 + ...ifacts.models.PrestoAuthenticationType.yml | 11 + ...e.artifacts.models.PrestoLinkedService.yml | 302 + ...e.artifacts.models.PrestoObjectDataset.yml | 223 + ...els.QueryDataFlowDebugSessionsResponse.yml | 131 + ...tifacts.models.QuickBooksLinkedService.yml | 232 + ...tifacts.models.QuickBooksObjectDataset.yml | 203 + ...models.RedirectIncompatibleRowSettings.yml | 154 + ...rtifacts.models.RelationalTableDataset.yml | 205 + ...ifacts.models.RerunTriggerListResponse.yml | 137 + ....artifacts.models.RerunTriggerResource.yml | 146 + ...acts.models.RerunTumblingWindowTrigger.yml | 198 + ...nTumblingWindowTriggerActionParameters.yml | 149 + ...zure.synapse.artifacts.models.Resource.yml | 151 + ...rtifacts.models.ResponsysLinkedService.yml | 240 + ...rtifacts.models.ResponsysObjectDataset.yml | 203 + ...e.artifacts.models.RestResourceDataset.yml | 246 + ...s.models.RestServiceAuthenticationType.yml | 15 + ...ifacts.models.RestServiceLinkedService.yml | 259 + ...e.artifacts.models.RunFilterParameters.yml | 163 + ...ynapse.artifacts.models.RunQueryFilter.yml | 160 + ...artifacts.models.RunQueryFilterOperand.yml | 39 + ...rtifacts.models.RunQueryFilterOperator.yml | 15 + ...synapse.artifacts.models.RunQueryOrder.yml | 11 + ...napse.artifacts.models.RunQueryOrderBy.yml | 151 + ....artifacts.models.RunQueryOrderByField.yml | 32 + ....artifacts.models.SSISAccessCredential.yml | 141 + ...apse.artifacts.models.SSISChildPackage.yml | 152 + ...tifacts.models.SSISExecutionCredential.yml | 141 + ...rtifacts.models.SSISExecutionParameter.yml | 129 + ...napse.artifacts.models.SSISLogLocation.yml | 160 + ...e.artifacts.models.SSISPackageLocation.yml | 194 + ....artifacts.models.SSISPropertyOverride.yml | 140 + ...tifacts.models.SalesforceLinkedService.yml | 218 + ....SalesforceMarketingCloudLinkedService.yml | 232 + ....SalesforceMarketingCloudObjectDataset.yml | 203 + ...tifacts.models.SalesforceObjectDataset.yml | 205 + ...ls.SalesforceServiceCloudLinkedService.yml | 228 + ...ls.SalesforceServiceCloudObjectDataset.yml | 205 + ...se.artifacts.models.SapBWLinkedService.yml | 225 + ...apse.artifacts.models.SapBwCubeDataset.yml | 195 + ...odels.SapCloudForCustomerLinkedService.yml | 208 + ...els.SapCloudForCustomerResourceDataset.yml | 205 + ...e.artifacts.models.SapEccLinkedService.yml | 207 + ...artifacts.models.SapEccResourceDataset.yml | 205 + ...facts.models.SapHanaAuthenticationType.yml | 11 + ....artifacts.models.SapHanaLinkedService.yml | 225 + ...e.artifacts.models.SapHanaTableDataset.yml | 213 + ...tifacts.models.SapOpenHubLinkedService.yml | 243 + ...rtifacts.models.SapOpenHubTableDataset.yml | 228 + ...artifacts.models.SapTableLinkedService.yml | 335 + ...tifacts.models.SapTableResourceDataset.yml | 205 + ...artifacts.models.SchedulerCurrentState.yml | 12 + ....synapse.artifacts.models.ScriptAction.yml | 152 + ...re.synapse.artifacts.models.SecretBase.yml | 128 + ....synapse.artifacts.models.SecureString.yml | 132 + ...ts.models.ServiceNowAuthenticationType.yml | 11 + ...tifacts.models.ServiceNowLinkedService.yml | 263 + ...tifacts.models.ServiceNowObjectDataset.yml | 203 + ...e.artifacts.models.SetVariableActivity.yml | 178 + ...rtifacts.models.SftpAuthenticationType.yml | 11 + ...tifacts.models.SftpServerLinkedService.yml | 287 + ....artifacts.models.ShopifyLinkedService.yml | 226 + ....artifacts.models.ShopifyObjectDataset.yml | 202 + ...tifacts.models.SparkAuthenticationType.yml | 15 + ...synapse.artifacts.models.SparkBatchJob.yml | 257 + ...tifacts.models.SparkBatchJobResultType.yml | 15 + ...se.artifacts.models.SparkBatchJobState.yml | 182 + ...apse.artifacts.models.SparkErrorSource.yml | 14 + ...se.artifacts.models.SparkJobDefinition.yml | 166 + ...acts.models.SparkJobDefinitionResource.yml | 146 + ...models.SparkJobDefinitionsListResponse.yml | 134 + ...se.artifacts.models.SparkJobProperties.yml | 224 + ....synapse.artifacts.models.SparkJobType.yml | 11 + ...se.artifacts.models.SparkLinkedService.yml | 308 + ...se.artifacts.models.SparkObjectDataset.yml | 222 + ....synapse.artifacts.models.SparkRequest.yml | 207 + ...ynapse.artifacts.models.SparkScheduler.yml | 150 + ...napse.artifacts.models.SparkServerType.yml | 13 + ...pse.artifacts.models.SparkServiceError.yml | 137 + ...se.artifacts.models.SparkServicePlugin.yml | 159 + ...ts.models.SparkThriftTransportProtocol.yml | 13 + ...synapse.artifacts.models.SqlConnection.yml | 146 + ...pse.artifacts.models.SqlConnectionType.yml | 11 + ...ure.synapse.artifacts.models.SqlScript.yml | 155 + ...apse.artifacts.models.SqlScriptContent.yml | 150 + ...pse.artifacts.models.SqlScriptMetadata.yml | 133 + ...pse.artifacts.models.SqlScriptResource.yml | 146 + ...rtifacts.models.SqlScriptsListResponse.yml | 134 + ...rtifacts.models.SqlServerLinkedService.yml | 204 + ...odels.SqlServerStoredProcedureActivity.yml | 198 + ...artifacts.models.SqlServerTableDataset.yml | 224 + ...e.artifacts.models.SquareLinkedService.yml | 239 + ...e.artifacts.models.SquareObjectDataset.yml | 202 + ...odels.SsisObjectMetadataStatusResponse.yml | 145 + ...tifacts.models.SsisPackageLocationType.yml | 13 + ...napse.artifacts.models.StagingSettings.yml | 157 + ...odels.StartDataFlowDebugSessionRequest.yml | 169 + ...dels.StartDataFlowDebugSessionResponse.yml | 123 + ...ifacts.models.StoredProcedureParameter.yml | 138 + ...ts.models.StoredProcedureParameterType.yml | 21 + ...e.synapse.artifacts.models.SubResource.yml | 134 + ...ifacts.models.SubResourceDebugResource.yml | 123 + ...ynapse.artifacts.models.SwitchActivity.yml | 199 + ...re.synapse.artifacts.models.SwitchCase.yml | 131 + ...ifacts.models.SybaseAuthenticationType.yml | 11 + ...e.artifacts.models.SybaseLinkedService.yml | 233 + ...se.artifacts.models.SybaseTableDataset.yml | 203 + ...acts.models.TeradataAuthenticationType.yml | 11 + ...artifacts.models.TeradataLinkedService.yml | 222 + ....artifacts.models.TeradataTableDataset.yml | 213 + ...ynapse.artifacts.models.Transformation.yml | 133 + ...azure.synapse.artifacts.models.Trigger.yml | 166 + ...ls.TriggerDependencyProvisioningStatus.yml | 134 + ...e.artifacts.models.TriggerListResponse.yml | 134 + ...ifacts.models.TriggerPipelineReference.yml | 131 + ...napse.artifacts.models.TriggerResource.yml | 146 + ...re.synapse.artifacts.models.TriggerRun.yml | 166 + ...apse.artifacts.models.TriggerRunStatus.yml | 13 + ...ifacts.models.TriggerRunsQueryResponse.yml | 137 + ...e.artifacts.models.TriggerRuntimeState.yml | 13 + ...els.TriggerSubscriptionOperationStatus.yml | 129 + ...synapse.artifacts.models.UntilActivity.yml | 200 + ....synapse.artifacts.models.UserProperty.yml | 136 + ...se.artifacts.models.ValidationActivity.yml | 222 + ...artifacts.models.VariableSpecification.yml | 138 + ....synapse.artifacts.models.VariableType.yml | 15 + ....artifacts.models.VerticaLinkedService.yml | 193 + ...e.artifacts.models.VerticaTableDataset.yml | 224 + ....synapse.artifacts.models.WaitActivity.yml | 170 + ...e.synapse.artifacts.models.WebActivity.yml | 255 + ...facts.models.WebActivityAuthentication.yml | 159 + ...pse.artifacts.models.WebActivityMethod.yml | 15 + ...acts.models.WebAnonymousAuthentication.yml | 140 + ...artifacts.models.WebAuthenticationType.yml | 13 + ...rtifacts.models.WebBasicAuthentication.yml | 158 + ...els.WebClientCertificateAuthentication.yml | 156 + ...napse.artifacts.models.WebHookActivity.yml | 241 + ...apse.artifacts.models.WebLinkedService.yml | 171 + ....models.WebLinkedServiceTypeProperties.yml | 145 + ...napse.artifacts.models.WebTableDataset.yml | 216 + ...ure.synapse.artifacts.models.Workspace.yml | 195 + ...pse.artifacts.models.WorkspaceIdentity.yml | 140 + ...facts.models.WorkspaceUpdateParameters.yml | 131 + ...pse.artifacts.models.XeroLinkedService.yml | 236 + ...pse.artifacts.models.XeroObjectDataset.yml | 202 + ...pse.artifacts.models.ZohoLinkedService.yml | 223 + ...pse.artifacts.models.ZohoObjectDataset.yml | 202 + .../azure.synapse.artifacts.models.yml | 416 + ...rations.DataFlowDebugSessionOperations.yml | 173 + ...rtifacts.operations.DataFlowOperations.yml | 138 + ...artifacts.operations.DatasetOperations.yml | 139 + ...cts.operations.LinkedServiceOperations.yml | 141 + ...rtifacts.operations.NotebookOperations.yml | 155 + ...rtifacts.operations.PipelineOperations.yml | 191 + ...facts.operations.PipelineRunOperations.yml | 140 + ...perations.SparkJobDefinitionOperations.yml | 221 + ...tifacts.operations.SqlScriptOperations.yml | 139 + ...artifacts.operations.TriggerOperations.yml | 314 + ...ifacts.operations.TriggerRunOperations.yml | 84 + .../azure.synapse.artifacts.operations.yml | 17 + .../azure-synapse/azure.synapse.artifacts.yml | 11 + .../azure.synapse.models.Config.yml | 122 + .../azure.synapse.models.Data.yml | 148 + .../azure.synapse.models.Edge.yml | 128 + .../azure.synapse.models.ErrorDetail.yml | 139 + .../azure.synapse.models.ErrorInformation.yml | 137 + .../azure.synapse.models.ErrorResponse.yml | 146 + ....synapse.models.ErrorResponseException.yml | 47 + .../azure.synapse.models.ErrorSource.yml | 14 + .../azure.synapse.models.Executors.yml | 161 + ...ynapse.models.ExtendedLivyBatchRequest.yml | 214 + ...napse.models.ExtendedLivyBatchResponse.yml | 239 + ...e.models.ExtendedLivyListBatchResponse.yml | 135 + ...models.ExtendedLivyListSessionResponse.yml | 136 + ...apse.models.ExtendedLivySessionRequest.yml | 214 + ...pse.models.ExtendedLivySessionResponse.yml | 239 + ...pse.models.GetAccessControlInfoRequest.yml | 134 + ...napse.models.HistoryServerDataResponse.yml | 122 + ...models.HistoryServerDiagnosticResponse.yml | 123 + ...ls.HistoryServerDiagnosticResponseData.yml | 129 + ...apse.models.HistoryServerGraphResponse.yml | 123 + ....models.HistoryServerGraphResponseData.yml | 135 + ...models.HistoryServerPropertiesResponse.yml | 123 + .../azure.synapse.models.JobResult.yml | 14 + .../azure.synapse.models.JobType.yml | 10 + .../azure.synapse.models.Jobs.yml | 148 + ...napse.models.LivyBatchStateInformation.yml | 174 + .../azure.synapse.models.LivyRequestBase.yml | 200 + ...pse.models.LivySessionStateInformation.yml | 187 + ...dels.LivyStatementCancellationResponse.yml | 122 + ...ure.synapse.models.LivyStatementOutput.yml | 154 + ...ynapse.models.LivyStatementRequestBody.yml | 129 + ...napse.models.LivyStatementResponseBody.yml | 141 + ...apse.models.LivyStatementsResponseBody.yml | 129 + .../azure.synapse.models.Option.yml | 135 + ...zure.synapse.models.PluginCurrentState.yml | 20 + ...e.synapse.models.SchedulerCurrentState.yml | 12 + ...re.synapse.models.SchedulerInformation.yml | 151 + ...dels.SetWorkspaceAdministratorsRequest.yml | 123 + .../azure.synapse.models.SparkJob.yml | 212 + ...ynapse.models.SparkJobListViewResponse.yml | 129 + ...e.models.SparkServicePluginInformation.yml | 161 + .../azure.synapse.models.Stages.yml | 167 + .../azure.synapse.models.Tables.yml | 129 + ....models.WorkspaceAccessControlResponse.yml | 138 + .../azure-synapse/azure.synapse.models.yml | 51 + ...ynapse.operations.MonitoringOperations.yml | 244 + ...ynapse.operations.SparkBatchOperations.yml | 193 + ...apse.operations.SparkSessionOperations.yml | 368 + ...apse.operations.WorkspaceAclOperations.yml | 85 + .../azure.synapse.operations.yml | 10 + .../azure.synapse.spark.SparkClient.yml | 49 + .../azure.synapse.spark.aio.SparkClient.yml | 49 + ....operations_async.SparkBatchOperations.yml | 153 + ...perations_async.SparkSessionOperations.yml | 276 + ...ure.synapse.spark.aio.operations_async.yml | 8 + .../azure-synapse/azure.synapse.spark.aio.yml | 9 + ...ynapse.spark.models.PluginCurrentState.yml | 20 + ...pse.spark.models.SchedulerCurrentState.yml | 12 + ...ure.synapse.spark.models.SparkBatchJob.yml | 257 + ...e.spark.models.SparkBatchJobCollection.yml | 141 + ...apse.spark.models.SparkBatchJobOptions.yml | 225 + ...e.spark.models.SparkBatchJobResultType.yml | 15 + ...ynapse.spark.models.SparkBatchJobState.yml | 182 + ....synapse.spark.models.SparkErrorSource.yml | 14 + ...zure.synapse.spark.models.SparkJobType.yml | 11 + ...zure.synapse.spark.models.SparkRequest.yml | 207 + ...re.synapse.spark.models.SparkScheduler.yml | 150 + ...synapse.spark.models.SparkServiceError.yml | 137 + ...ynapse.spark.models.SparkServicePlugin.yml | 159 + ...zure.synapse.spark.models.SparkSession.yml | 241 + ...se.spark.models.SparkSessionCollection.yml | 140 + ...napse.spark.models.SparkSessionOptions.yml | 224 + ...se.spark.models.SparkSessionResultType.yml | 14 + ...synapse.spark.models.SparkSessionState.yml | 187 + ...re.synapse.spark.models.SparkStatement.yml | 145 + ...odels.SparkStatementCancellationResult.yml | 122 + ....spark.models.SparkStatementCollection.yml | 133 + ...park.models.SparkStatementLanguageType.yml | 14 + ...pse.spark.models.SparkStatementOptions.yml | 131 + ...apse.spark.models.SparkStatementOutput.yml | 159 + .../azure.synapse.spark.models.yml | 31 + ....spark.operations.SparkBatchOperations.yml | 153 + ...park.operations.SparkSessionOperations.yml | 276 + .../azure.synapse.spark.operations.yml | 8 + .../azure-synapse/azure.synapse.spark.yml | 11 + .../azure-synapse/azure.synapse.yml | 14 + previous/docs-ref-autogen/toc.yml | 12942 ++++- xrefmap.yml | 39097 ++++++++++++++++ 5334 files changed, 621312 insertions(+), 4 deletions(-) create mode 100644 docs-ref-mapping/reference-previous.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.MetricsAdvisorClient.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.MetricsAdvisorKeyCredential.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.aio.MetricsAdvisorClient.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.aio.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AlertQueryTimeMode.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyAlert.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyAlertConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyDetectionConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyDetectorDirection.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyFeedback.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyIncident.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyIncidentStatus.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalySeverity.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyValue.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureTableDataFeedSource.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.ChangePointFeedback.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.ChangePointValue.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.ChangeThresholdCondition.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.CommentFeedback.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeed.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedAccessMode.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedAutoRollupMethod.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedDimension.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedGranularity.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedGranularityType.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedIngestionProgress.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedIngestionSettings.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedIngestionStatus.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedMetric.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedMissingDataPointFillSettings.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedRollupSettings.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedRollupType.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedSchema.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedSource.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedStatus.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataPointAnomaly.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceAuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceCredential.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceCredentialType.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceMissingDataPointFillType.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceServicePrincipal.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceType.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DetectionAnomalyFilterCondition.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DetectionConditionOperator.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DetectionIncidentFilterCondition.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DimensionGroupIdentity.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.EmailNotificationHook.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.EnrichmentStatus.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.FeedbackQueryTimeMode.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.FeedbackType.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.HardThresholdCondition.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.IncidentRootCause.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAlertConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAnomalyAlertConditions.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAnomalyAlertConfigurationsOperator.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAnomalyAlertScope.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAnomalyAlertScopeType.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAnomalyAlertSnoozeCondition.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricBoundaryCondition.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricDetectionCondition.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricEnrichedSeriesData.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricFeedback.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricSeriesData.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricSeriesDefinition.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricSeriesGroupDetectionCondition.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricSingleSeriesDetectionCondition.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MongoDbDataFeedSource.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MySqlDataFeedSource.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.NotificationHook.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.PeriodFeedback.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.PeriodType.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SeriesIdentity.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SeverityCondition.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SeverityFilterCondition.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SmartDetectionCondition.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SnoozeScope.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SqlServerDataFeedSource.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SuppressCondition.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.TopNGroupScope.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.WebNotificationHook.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.yml create mode 100644 previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ConsoleLogger.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.FileLogger.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.Frame.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.FrameFormat.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.FrameSource.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.FrameSourceCallback.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.FrameWriter.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalysisErrorDetails.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalysisEventArgs.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalysisOptions.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalysisResult.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalysisResultDetails.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalyzer.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageSourceBuffer.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageSourceBufferCallback.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageWriter.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.MemoryLogger.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.VisionServiceOptions.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.VisionSource.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.diagnostics_logging.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.ImageAnalysisErrorReason.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.ImageAnalysisFeature.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.ImageAnalysisResultReason.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.ImageSegmentationMode.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.SessionResultReason.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.SessionStoppedErrorReason.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.SessionStoppedReason.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.VisionOption.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_client.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.ContentCaption.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.ContentTag.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.ContentTags.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.CropSuggestion.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.CropSuggestions.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DenseCaptions.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedObject.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedObjects.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedPeople.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedPerson.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedText.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedTextLine.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedTextWord.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.Rectangle.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.SegmentationResult.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.interop.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.properties.PropertyCollection.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.properties.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.version.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.EventSignal.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.SessionStartedEventArgs.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.SessionStoppedEventArgs.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.VisionServiceAdvancedOptions.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.VisionSession.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.VisionSessionOptions.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.yml create mode 100644 previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.ApplicationInsightsDataClient.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.application_insights_data_client.ApplicationInsightsDataClient.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.application_insights_data_client.ApplicationInsightsDataClientConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.application_insights_data_client.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.Column(class).yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorDetail.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorResponseException.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventType.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAiInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsApplicationInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAvailabilityResultInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAvailabilityResultResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsBrowserTimingInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsBrowserTimingResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsClientInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsClientPerformanceInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCloudInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomEventInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomEventResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomMetricInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomMetricResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsDependencyInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsDependencyResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionDetail.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionDetailsParsedStack.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsOperationInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPageViewInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPageViewResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPerformanceCounterInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPerformanceCounterResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsRequestInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsRequestResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultData.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultDataCustomDimensions.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultDataCustomMeasurements.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResults.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsSessionInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsTraceInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsTraceResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsUserInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricId.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsAggregation.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsPostBodySchema.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsPostBodySchemaParameters.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsResultInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsResultsItem.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsSegment.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsSegmentInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.QueryBody.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.QueryResults.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.Table(class).yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.application_insights_data_client_enums.EventType.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.application_insights_data_client_enums.MetricId.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.application_insights_data_client_enums.MetricsAggregation.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.application_insights_data_client_enums.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.column.Column.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.column.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.column_py3.Column.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.column_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_detail.ErrorDetail.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_detail.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_detail_py3.ErrorDetail.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_detail_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_info.ErrorInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_info.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_info_py3.ErrorInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response.ErrorResponseException.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response_py3.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response_py3.ErrorResponseException.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_ai_info.EventsAiInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_ai_info.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_ai_info_py3.EventsAiInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_ai_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_application_info.EventsApplicationInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_application_info.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_application_info_py3.EventsApplicationInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_application_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_info.EventsAvailabilityResultInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_info.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_info_py3.EventsAvailabilityResultInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_result.EventsAvailabilityResultResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_result.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_result_py3.EventsAvailabilityResultResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_info.EventsBrowserTimingInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_info.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_info_py3.EventsBrowserTimingInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_result.EventsBrowserTimingResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_result.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_result_py3.EventsBrowserTimingResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_info.EventsClientInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_info.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_info_py3.EventsClientInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_performance_info.EventsClientPerformanceInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_performance_info.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_performance_info_py3.EventsClientPerformanceInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_performance_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_cloud_info.EventsCloudInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_cloud_info.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_cloud_info_py3.EventsCloudInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_cloud_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_info.EventsCustomEventInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_info.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_info_py3.EventsCustomEventInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_result.EventsCustomEventResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_result.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_result_py3.EventsCustomEventResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_info.EventsCustomMetricInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_info.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_info_py3.EventsCustomMetricInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_result.EventsCustomMetricResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_result.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_result_py3.EventsCustomMetricResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_info.EventsDependencyInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_info.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_info_py3.EventsDependencyInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_result.EventsDependencyResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_result.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_result_py3.EventsDependencyResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_detail.EventsExceptionDetail.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_detail.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_detail_py3.EventsExceptionDetail.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_detail_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_details_parsed_stack.EventsExceptionDetailsParsedStack.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_details_parsed_stack.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_details_parsed_stack_py3.EventsExceptionDetailsParsedStack.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_details_parsed_stack_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_info.EventsExceptionInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_info.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_info_py3.EventsExceptionInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_result.EventsExceptionResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_result.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_result_py3.EventsExceptionResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_operation_info.EventsOperationInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_operation_info.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_operation_info_py3.EventsOperationInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_operation_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_info.EventsPageViewInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_info.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_info_py3.EventsPageViewInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_result.EventsPageViewResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_result.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_result_py3.EventsPageViewResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_info.EventsPerformanceCounterInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_info.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_info_py3.EventsPerformanceCounterInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_result.EventsPerformanceCounterResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_result.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_result_py3.EventsPerformanceCounterResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_info.EventsRequestInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_info.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_info_py3.EventsRequestInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_result.EventsRequestResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_result.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_result_py3.EventsRequestResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result.EventsResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data.EventsResultData.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_dimensions.EventsResultDataCustomDimensions.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_dimensions.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_dimensions_py3.EventsResultDataCustomDimensions.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_dimensions_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_measurements.EventsResultDataCustomMeasurements.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_measurements.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_measurements_py3.EventsResultDataCustomMeasurements.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_measurements_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_py3.EventsResultData.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_py3.EventsResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_results.EventsResults.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_results.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_results_py3.EventsResults.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_results_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_session_info.EventsSessionInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_session_info.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_session_info_py3.EventsSessionInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_session_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_info.EventsTraceInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_info.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_info_py3.EventsTraceInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_result.EventsTraceResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_result.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_result_py3.EventsTraceResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_user_info.EventsUserInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_user_info.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_user_info_py3.EventsUserInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_user_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema.MetricsPostBodySchema.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_parameters.MetricsPostBodySchemaParameters.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.MetricsPostBodySchemaParameters.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_py3.MetricsPostBodySchema.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result.MetricsResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_info.MetricsResultInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_info.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_info_py3.MetricsResultInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_py3.MetricsResult.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_results_item.MetricsResultsItem.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_results_item.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_results_item_py3.MetricsResultsItem.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_results_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_segment_info.MetricsSegmentInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_segment_info.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_segment_info_py3.MetricsSegmentInfo.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_segment_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_body.QueryBody.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_body.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_body_py3.QueryBody.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_body_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_results.QueryResults.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_results.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_results_py3.QueryResults.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_results_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.table.Table.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.table.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.table_py3.Table.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.table_py3.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.EventsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.MetricsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.QueryOperations.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.events_operations.EventsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.events_operations.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.metrics_operations.MetricsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.metrics_operations.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.query_operations.QueryOperations.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.query_operations.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.version.yml create mode 100644 previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.AnomalyDetectorClient.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.AnomalyDetectorClientConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.APIError.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.APIErrorException.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.ChangePointDetectRequest.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.ChangePointDetectResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.EntireDetectResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.Granularity.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.LastDetectResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.Point.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.Request.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.operations.AnomalyDetectorClientOperationsMixin.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.version.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.QnAMakerClient.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ActiveLearningSettingsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.AlterationsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanRequestDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanResponseDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ContextDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.CreateKbDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.CreateKbInputDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.DeleteKbContentsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointKeysDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTOActiveLearning.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EnvironmentType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.Error(class).yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorCodeType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseError.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.FileDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.InnerErrorModel.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebaseDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebasesDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.MetadataDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.Operation(class).yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.OperationStateType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.PromptDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.PromptDTOQna.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADTOContext.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADocumentsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultAnswerSpan.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultContext.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultList.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryContextDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOAnswerSpanRequest.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOContext.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ReplaceKbDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.StrictFiltersCompoundOperationType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateContextDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbContentsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOAdd.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTODelete.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOUpdate.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateMetadataDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOContext.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOMetadata.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOQuestions.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQuestionsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.WordAlterationsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto.ActiveLearningSettingsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.ActiveLearningSettingsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto.AlterationsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3.AlterationsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto.AnswerSpanRequestDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.AnswerSpanRequestDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto.AnswerSpanResponseDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.AnswerSpanResponseDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.context_dto.ContextDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.context_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.ContextDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto.CreateKbDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.CreateKbDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto.CreateKbInputDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.CreateKbInputDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto.DeleteKbContentsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.DeleteKbContentsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto.EndpointKeysDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.EndpointKeysDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto.EndpointSettingsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning.EndpointSettingsDTOActiveLearning.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.EndpointSettingsDTOActiveLearning.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.EndpointSettingsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error.Error.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_py3.Error.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponseException.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_error.ErrorResponseError.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_error.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.ErrorResponseError.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponseException.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto.FeedbackRecordDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.FeedbackRecordDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto.FeedbackRecordsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.FeedbackRecordsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.file_dto.FileDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.file_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3.FileDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model.InnerErrorModel.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.InnerErrorModel.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto.KnowledgebaseDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.KnowledgebaseDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto.KnowledgebasesDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.KnowledgebasesDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto.MetadataDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3.MetadataDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.operation.Operation.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.operation.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.Operation.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto.PromptDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.PromptDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna.PromptDTOQna.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.PromptDTOQna.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto.QnADocumentsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.QnADocumentsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto.QnADTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context.QnADTOContext.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.QnADTOContext.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.QnADTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.EnvironmentType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.ErrorCodeType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.OperationStateType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.StrictFiltersCompoundOperationType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result.QnASearchResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span.QnASearchResultAnswerSpan.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.QnASearchResultAnswerSpan.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context.QnASearchResultContext.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.QnASearchResultContext.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list.QnASearchResultList.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.QnASearchResultList.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.QnASearchResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto.QueryContextDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.QueryContextDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto.QueryDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request.QueryDTOAnswerSpanRequest.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.QueryDTOAnswerSpanRequest.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context.QueryDTOContext.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.QueryDTOContext.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.QueryDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto.ReplaceKbDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3.ReplaceKbDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto.UpdateContextDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.UpdateContextDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto.UpdateKbContentsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.UpdateKbContentsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto.UpdateKbOperationDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add.UpdateKbOperationDTOAdd.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.UpdateKbOperationDTOAdd.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete.UpdateKbOperationDTODelete.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.UpdateKbOperationDTODelete.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.UpdateKbOperationDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update.UpdateKbOperationDTOUpdate.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.UpdateKbOperationDTOUpdate.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto.UpdateMetadataDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.UpdateMetadataDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto.UpdateQnaDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context.UpdateQnaDTOContext.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.UpdateQnaDTOContext.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata.UpdateQnaDTOMetadata.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.UpdateQnaDTOMetadata.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.UpdateQnaDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions.UpdateQnaDTOQuestions.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.UpdateQnaDTOQuestions.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto.UpdateQuestionsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.UpdateQuestionsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto.WordAlterationsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3.WordAlterationsDTO.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.AlterationsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.EndpointKeysOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.EndpointSettingsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.KnowledgebaseOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.Operations(class).yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.alterations_operations.AlterationsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.alterations_operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_keys_operations.EndpointKeysOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_keys_operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_settings_operations.EndpointSettingsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_settings_operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations.KnowledgebaseOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.QnAMakerClient.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.QnAMakerClientConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.version.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.LUISAuthoringClient.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.LUISAuthoringClientConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationSettings.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AvailableCulture.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AzureAccountInfoObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ChildEntity.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedList.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EndpointInfo.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityExtractor.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityLabel.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityPrediction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRole.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentClassifier.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentPrediction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONEntity.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONUtterance.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JsonChild.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabelTextObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LuisApp.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LuisAppV2.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelInfo.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.OperationError.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.OperationStatus.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.OperationStatusType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAny.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRule.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PublishSettings.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexEntity.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.SubClosedList.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.TrainingStatus.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.UserAccessList.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.UserCollaborator.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.VersionInfo.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.WordListObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.AzureAccountsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.ExamplesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.FeaturesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.PatternOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.SettingsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.TrainOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.version.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.LUISRuntimeClient.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.LUISRuntimeClientConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.DynamicList.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Error.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.ErrorBody.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.ErrorException.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.ExternalEntity.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Intent.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Prediction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.PredictionRequest.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.PredictionResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.RequestList.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Sentiment.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.operations.PredictionOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.version.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.version.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.SpellCheckClient.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.SpellCheckClientConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ActionType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.Answer.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.Error.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ErrorCode.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ErrorResponseException.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ErrorSubCode.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ErrorType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.Identifiable.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.Mode.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.Response.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ResponseBase.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.SpellCheck.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.SpellingFlaggedToken.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.SpellingTokenSuggestion.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.operations.SpellCheckClientOperationsMixin.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.version.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.TextAnalyticsClient.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.DetectedLanguage.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.DocumentStatistics.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResultItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.EntityRecord.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.ErrorRecord.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.ErrorResponseException.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.InternalError.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResultItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageBatchInput.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageBatchResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageBatchResultItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageInput.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MatchRecord.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MultiLanguageBatchInput.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MultiLanguageInput.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.RequestStatistics.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.SentimentBatchResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.SentimentBatchResultItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.detected_language.DetectedLanguage.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.detected_language.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.detected_language_py3.DetectedLanguage.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.detected_language_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.document_statistics.DocumentStatistics.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.document_statistics.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.DocumentStatistics.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result.EntitiesBatchResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item.EntitiesBatchResultItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3.EntitiesBatchResultItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3.EntitiesBatchResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entity_record.EntityRecord.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entity_record.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entity_record_py3.EntityRecord.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entity_record_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_record.ErrorRecord.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_record.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_record_py3.ErrorRecord.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_record_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponseException.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponseException.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.internal_error.InternalError.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.internal_error.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.internal_error_py3.InternalError.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.internal_error_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result.KeyPhraseBatchResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item.KeyPhraseBatchResultItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3.KeyPhraseBatchResultItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3.KeyPhraseBatchResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_input.LanguageBatchInput.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_input.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.LanguageBatchInput.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result.LanguageBatchResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_item.LanguageBatchResultItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_item.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.LanguageBatchResultItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3.LanguageBatchResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_input.LanguageInput.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_input.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_input_py3.LanguageInput.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_input_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.match_record.MatchRecord.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.match_record.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.match_record_py3.MatchRecord.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.match_record_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input.MultiLanguageBatchInput.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.MultiLanguageBatchInput.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_input.MultiLanguageInput.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_input.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.MultiLanguageInput.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.request_statistics.RequestStatistics.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.request_statistics.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.RequestStatistics.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result.SentimentBatchResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item.SentimentBatchResultItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.SentimentBatchResultItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3.SentimentBatchResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClient.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClientConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.text_analytics_client.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.version.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.NewsSearchClient.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.NewsSearchClientConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Answer.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Article.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.CreativeWork.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Error.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ErrorCode.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ErrorResponseException.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ErrorSubCode.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Freshness.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Identifiable.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ImageObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.MediaObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.News.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.NewsArticle.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.NewsTopic.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Organization.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Query.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Response.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ResponseBase.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.SafeSearch.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.SearchResultsAnswer.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.TextFormat.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Thing.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.TrendingTopics.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.VideoObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.operations.NewsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.version.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.VisualSearchClient.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Action(class).yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.AggregateOffer.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.AggregateRating.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.CreativeWork.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.CropArea.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Currency.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Error(class).yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ErrorCode.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ErrorResponseException.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ErrorSubCode.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Filters(class).yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Identifiable(class).yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageAction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageEntityAction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageInfo.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageKnowledge.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageModuleAction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageRecipesAction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageRelatedSearchesAction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageShoppingSourcesAction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageTag.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageTagRegion.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImagesImageMetadata.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImagesModule.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Intangible(class).yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ItemAvailability.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.KnowledgeRequest.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.MediaObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.NormalizedQuadrilateral.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Offer(class).yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Organization(class).yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Person(class).yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Point2D.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.PropertiesItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Query(class).yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Rating(class).yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Recipe(class).yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.RecipesModule.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.RelatedSearchesModule.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Response(class).yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ResponseBase.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.SafeSearch.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.StructuredValue.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Thing(class).yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.VisualSearchRequest.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.action.Action.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.action.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.action_py3.Action.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.action_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_offer.AggregateOffer.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_offer.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3.AggregateOffer.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_rating.AggregateRating.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_rating.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3.AggregateRating.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.creative_work.CreativeWork.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.creative_work.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.creative_work_py3.CreativeWork.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.creative_work_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.crop_area.CropArea.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.crop_area.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.crop_area_py3.CropArea.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.crop_area_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error.Error.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_py3.Error.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponseException.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponseException.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.filters.Filters.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.filters.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.filters_py3.Filters.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.filters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.identifiable.Identifiable.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.identifiable.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.identifiable_py3.Identifiable.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.identifiable_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_action.ImageAction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_action.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_action_py3.ImageAction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_action_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_entity_action.ImageEntityAction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_entity_action.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3.ImageEntityAction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_info.ImageInfo.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_info.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_info_py3.ImageInfo.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_knowledge.ImageKnowledge.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_knowledge.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3.ImageKnowledge.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_module_action.ImageModuleAction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_module_action.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_module_action_py3.ImageModuleAction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_module_action_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_object.ImageObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_object.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_object_py3.ImageObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_object_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_recipes_action.ImageRecipesAction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_recipes_action.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3.ImageRecipesAction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_related_searches_action.ImageRelatedSearchesAction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_related_searches_action.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3.ImageRelatedSearchesAction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action.ImageShoppingSourcesAction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3.ImageShoppingSourcesAction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag.ImageTag.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_py3.ImageTag.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_region.ImageTagRegion.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_region.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3.ImageTagRegion.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_image_metadata.ImagesImageMetadata.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_image_metadata.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3.ImagesImageMetadata.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_module.ImagesModule.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_module.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_module_py3.ImagesModule.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_module_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.intangible.Intangible.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.intangible.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.intangible_py3.Intangible.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.intangible_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.knowledge_request.KnowledgeRequest.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.knowledge_request.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.KnowledgeRequest.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.media_object.MediaObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.media_object.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.media_object_py3.MediaObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.media_object_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral.NormalizedQuadrilateral.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3.NormalizedQuadrilateral.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.offer.Offer.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.offer.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.offer_py3.Offer.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.offer_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.organization.Organization.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.organization.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.organization_py3.Organization.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.organization_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.person.Person.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.person.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.person_py3.Person.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.person_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.point2_d.Point2D.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.point2_d.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.point2_d_py3.Point2D.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.point2_d_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.properties_item.PropertiesItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.properties_item.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.properties_item_py3.PropertiesItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.properties_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.query.Query.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.query.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.query_py3.Query.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.query_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.rating.Rating.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.rating.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.rating_py3.Rating.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.rating_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipe.Recipe.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipe.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipe_py3.Recipe.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipe_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipes_module.RecipesModule.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipes_module.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipes_module_py3.RecipesModule.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipes_module_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.related_searches_module.RelatedSearchesModule.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.related_searches_module.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3.RelatedSearchesModule.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response.Response.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_base.ResponseBase.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_base.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_base_py3.ResponseBase.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_base_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_py3.Response.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.structured_value.StructuredValue.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.structured_value.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.structured_value_py3.StructuredValue.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.structured_value_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.thing.Thing.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.thing.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.thing_py3.Thing.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.thing_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorCode.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorSubCode.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ItemAvailability.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.SafeSearch.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_request.VisualSearchRequest.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_request.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.VisualSearchRequest.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.operations.ImagesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.operations.images_operations.ImagesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.operations.images_operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.version.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.visual_search_client.VisualSearchClient.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.visual_search_client.VisualSearchClientConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.visual_search_client.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.ComputerVisionClient.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.ComputerVisionClientConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.AdultInfo.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.AnalyzeResults.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Appearance.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.AreaOfInterestResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.BoundingRect.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Category.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.CategoryDetail.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.CelebritiesModel.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ColorInfo.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionError.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorCodes.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerError.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrError.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrErrorException.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DescriptionExclude.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Details.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DetectResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DetectedBrand.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DetectedObject.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DomainModelResults.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.FaceDescription.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.FaceRectangle.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Gender.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageAnalysis.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageCaption.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageDescription.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageDescriptionDetails.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageMetadata.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageTag.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageUrl.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.LandmarksModel.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Line.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ListModelsResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ModelDescription.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ObjectHierarchy.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrLanguages.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrLine.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrRegion.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrWord.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OperationStatusCodes.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ReadOperationResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ReadResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Style.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.TagResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.TextRecognitionResultDimensionUnit.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.TextStyle.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.VisualFeatureTypes.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Word.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.version.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.ContentModeratorClient.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.content_moderator_client.ContentModeratorClient.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.content_moderator_client.ContentModeratorClientConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.content_moderator_client.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.APIError.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.APIErrorException.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Address.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Body.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.BodyModel.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Candidate.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Classification.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory1.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory2.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory3.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Content.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItemMetadataItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemMetadataItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemMetadataItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemReviewerResultTagsItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.DetectedLanguage.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.DetectedTerms.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Email.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Error.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Evaluate.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Face.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.FoundFaces.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Frame.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Frames.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.IPA.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Image.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageAdditionalInfoItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageIds.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageList.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Job.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobExecutionReportDetails.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobId.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobListResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.KeyValuePair.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Match.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.MatchResponse.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.OCR.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.PII.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Phone.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.RefreshIndex.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Review.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.SSN.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Screen.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Status.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Tag.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermList.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Terms.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsData.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsInList.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsPaging.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItemTermsItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemMetadataItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemReviewerResultTagsItem.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ImageModerationOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageListsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ReviewsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.TextModerationOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.ImageModerationOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations.ListManagementImageListsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations.ListManagementImageOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations.ListManagementTermListsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_operations.ListManagementTermOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.ReviewsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.text_moderation_operations.TextModerationOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.text_moderation_operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.version.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClient.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClientConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.BoundingBox.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionError.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.ImagePrediction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.ImageUrl.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.Prediction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.TagType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.operations.CustomVisionPredictionClientOperationsMixin.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.version.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClientConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.BoundingBox.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Classifier.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CreateProjectOptions.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CustomBaseModelInfo.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CustomVisionError.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Domain.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.DomainType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Export.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ExportFlavor.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ExportPlatform.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ExportStatus.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Image.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageCreateResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageCreateStatus.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageCreateSummary.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateBatch.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateEntry.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateBatch.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateEntry.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateEntry.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateStatus.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateSummary.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImagePerformance.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImagePrediction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageProcessingSettings.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegion.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateBatch.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateEntry.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateSummary.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionProposal.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTag.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateBatch.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateEntry.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateSummary.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageUrl.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateBatch.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateEntry.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Iteration.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.IterationPerformance.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ModelInformation.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.OrderBy.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Prediction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryTag.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryToken.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Project.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ProjectExport.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ProjectSettings.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ProjectStatus.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Region.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.RegionProposal.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SortBy.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.StoredImagePrediction.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.StoredSuggestedTagAndRegion.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegion.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQuery.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQueryToken.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Tag.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TagFilter.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TagPerformance.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TagType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TrainingParameters.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TrainingType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.version.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.version.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.FaceClient.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.FaceClientConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.APIError.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.APIErrorException.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Accessory.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.AccessoryType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.ApplySnapshotRequest.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Blur.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.BlurLevel.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Coordinate.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.DetectedFace.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.DetectionModel.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Emotion.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Error.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Exposure.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.ExposureLevel.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceAttributeType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceLandmarks.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceList.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceRectangle.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FacialHair.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FindSimilarMatchMode.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FindSimilarRequest.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Gender.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.GlassesType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.GroupRequest.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.GroupResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Hair.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.HairColor.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.HairColorType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.HeadPose.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.IdentifyCandidate.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.IdentifyRequest.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.IdentifyResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.ImageUrl.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.LargeFaceList.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.LargePersonGroup.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Makeup.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Mask.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.MaskType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.MetaDataContract.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.NameAndUserDataContract.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Noise.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.NoiseLevel.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Occlusion.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.OperationStatus.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.OperationStatusType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.PersistedFace.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Person.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.PersonGroup.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.QualityForRecognition.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.RecognitionModel.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.SimilarFace.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Snapshot.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.SnapshotApplyMode.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.SnapshotObjectType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.TakeSnapshotRequest.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.TrainingStatus.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.TrainingStatusType.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.UpdateFaceRequest.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.UpdateSnapshotRequest.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.VerifyFaceToFaceRequest.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.VerifyFaceToPersonRequest.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.VerifyResult.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.FaceListOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.FaceOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.LargeFaceListOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.LargePersonGroupOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.LargePersonGroupPersonOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.PersonGroupOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.PersonGroupPersonOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.SnapshotOperations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.version.yml create mode 100644 previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.yml create mode 100644 previous/docs-ref-autogen/azure-common/azure.common.AzureConflictHttpError.yml create mode 100644 previous/docs-ref-autogen/azure-common/azure.common.AzureException.yml create mode 100644 previous/docs-ref-autogen/azure-common/azure.common.AzureHttpError.yml create mode 100644 previous/docs-ref-autogen/azure-common/azure.common.AzureMissingResourceHttpError.yml create mode 100644 previous/docs-ref-autogen/azure-common/azure.common.client_factory.yml create mode 100644 previous/docs-ref-autogen/azure-common/azure.common.cloud.yml create mode 100644 previous/docs-ref-autogen/azure-common/azure.common.credentials.yml create mode 100644 previous/docs-ref-autogen/azure-common/azure.common.exceptions.yml create mode 100644 previous/docs-ref-autogen/azure-common/azure.common.yml create mode 100644 previous/docs-ref-autogen/azure-common/azure.profiles.DefaultProfile.yml create mode 100644 previous/docs-ref-autogen/azure-common/azure.profiles.KnownProfiles.yml create mode 100644 previous/docs-ref-autogen/azure-common/azure.profiles.ProfileDefinition.yml create mode 100644 previous/docs-ref-autogen/azure-common/azure.profiles.multiapiclient.InvalidMultiApiClientError.yml create mode 100644 previous/docs-ref-autogen/azure-common/azure.profiles.multiapiclient.MultiApiClientMixin.yml create mode 100644 previous/docs-ref-autogen/azure-common/azure.profiles.multiapiclient.yml create mode 100644 previous/docs-ref-autogen/azure-common/azure.profiles.yml create mode 100644 previous/docs-ref-autogen/azure-communication-networktraversal/azure.communication.networktraversal.aio.CommunicationRelayClient.yml create mode 100644 previous/docs-ref-autogen/azure-communication-networktraversal/azure.communication.networktraversal.aio.yml create mode 100644 previous/docs-ref-autogen/azure-communication-networktraversal/azure.communication.networktraversal.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.auth.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.base.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.consistent_hash_ring.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.constants.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.cosmos_client.CosmosClient.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.cosmos_client.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.default_retry_policy.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.ConnectionMode.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.ConnectionPolicy.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.ConsistencyLevel.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.DataType.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.DatabaseAccount.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.IndexKind.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.IndexingDirective.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.IndexingMode.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.MediaReadMode.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.PartitionKind.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.PermissionMode.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.ProxyConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.SSLConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.TriggerOperation.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.TriggerType.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.Undefined.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.endpoint_discovery_retry_policy.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.errors.CosmosError.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.errors.HTTPFailure.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.errors.JSONParseFailure.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.errors.UnexpectedDataType.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.errors.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.aggregators.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.base_execution_context.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.document_producer.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.endpoint_component.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.execution_dispatcher.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.multi_execution_aggregator.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.query_execution_info.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.global_endpoint_manager.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.hash_partition_resolver.HashPartitionResolver.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.hash_partition_resolver.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.CookieHeaders.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.Delimiters.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpContextProperties.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpHeaderPreferenceTokens.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpHeaders.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpListenerErrorCodes.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpMethods.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpStatusDescriptions.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.QueryStrings.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.ResourceType.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.StatusCodes.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.SubStatusCodes.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.Versions.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.location_cache.EndpointOperationType.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.location_cache.LocationCache.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.location_cache.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.murmur_hash.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.partition.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.query_iterable.QueryIterable.Iterator.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.query_iterable.QueryIterable.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.query_iterable.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.range.Range.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.range.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.range_partition_resolver.RangePartitionResolver.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.range_partition_resolver.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.request_object.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.resource_throttle_retry_policy.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.retry_options.RetryOptions.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.retry_options.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.retry_utility.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.routing.collection_routing_map.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.routing.routing_map_provider.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.routing.routing_range.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.routing.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.runtime_constants.MediaTypes.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.runtime_constants.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.session.Session.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.session.SessionContainer.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.session.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.session_retry_policy.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.synchronized_request.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.utils.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.vector_session_token.VectorSessionToken.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.vector_session_token.yml create mode 100644 previous/docs-ref-autogen/azure-cosmos/azure.cosmos.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.core.AzureDLFile.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.core.AzureDLFileSystem.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.core.AzureDLPath.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.core.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.enums.ExpiryOptionType.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.enums.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.exceptions.DatalakeBadOffsetException.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.exceptions.DatalakeIncompleteTransferException.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.exceptions.DatalakeRESTException.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.exceptions.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.lib.DatalakeRESTInterface.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.lib.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.multiprocessor.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.multithread.ADLDownloader.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.multithread.ADLUploader.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.multithread.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.retry.ExponentialRetryPolicy.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.retry.NoRetryPolicy.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.retry.RetryPolicy.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.retry.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.ADLTransferClient.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.Chunk.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.File.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.StateManager.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.utils.CountUpDownLatch.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.utils.yml create mode 100644 previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.GraphRbacManagementClient.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.graph_rbac_management_client.GraphRbacManagementClient.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.graph_rbac_management_client.GraphRbacManagementClientConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.graph_rbac_management_client.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ADGroup.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ADGroupPaged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.AddOwnerParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.AppRole.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.Application(class).yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationBase.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationPaged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.CheckGroupMembershipParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.CheckGroupMembershipResult.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ConsentType.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.DirectoryObject.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.DirectoryObjectPaged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.Domain(class).yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.DomainPaged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GetObjectsParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GraphError.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GraphErrorException.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupAddMemberParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupGetMemberGroupsParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.InformationalUrl.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.KeyCredential.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.KeyCredentialPaged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.KeyCredentialsUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OAuth2Permission.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OAuth2PermissionGrant.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OAuth2PermissionGrantPaged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OptionalClaim.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OptionalClaims.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordCredential.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordCredentialPaged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordCredentialsUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordProfile.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplication.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplicationExtension.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplicationPermission.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.RequiredResourceAccess.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ResourceAccess.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipal.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalBase.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalObjectResult.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalPaged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.SignInName.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.StrPaged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.User(class).yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserBase.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserGetMemberGroupsParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserPaged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserType.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group.ADGroup.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group_paged.ADGroupPaged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group_paged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group_py3.ADGroup.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.add_owner_parameters.AddOwnerParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.add_owner_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.add_owner_parameters_py3.AddOwnerParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.add_owner_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.app_role.AppRole.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.app_role.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.app_role_py3.AppRole.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.app_role_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application.Application.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_base.ApplicationBase.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_base.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_base_py3.ApplicationBase.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_base_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_create_parameters.ApplicationCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_create_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_create_parameters_py3.ApplicationCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_create_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_paged.ApplicationPaged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_paged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_py3.Application.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_update_parameters.ApplicationUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_update_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_update_parameters_py3.ApplicationUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_update_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_parameters.CheckGroupMembershipParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_parameters_py3.CheckGroupMembershipParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_result.CheckGroupMembershipResult.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_result.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_result_py3.CheckGroupMembershipResult.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object.DirectoryObject.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object_paged.DirectoryObjectPaged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object_paged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object_py3.DirectoryObject.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain.Domain.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain_paged.DomainPaged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain_paged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain_py3.Domain.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.get_objects_parameters.GetObjectsParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.get_objects_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.get_objects_parameters_py3.GetObjectsParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.get_objects_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error.GraphError.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error.GraphErrorException.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error_py3.GraphError.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error_py3.GraphErrorException.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_rbac_management_client_enums.ConsentType.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_rbac_management_client_enums.UserType.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_rbac_management_client_enums.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_add_member_parameters.GroupAddMemberParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_add_member_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_add_member_parameters_py3.GroupAddMemberParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_add_member_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_create_parameters.GroupCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_create_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_create_parameters_py3.GroupCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_create_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_get_member_groups_parameters.GroupGetMemberGroupsParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_get_member_groups_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_get_member_groups_parameters_py3.GroupGetMemberGroupsParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_get_member_groups_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.informational_url.InformationalUrl.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.informational_url.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.informational_url_py3.InformationalUrl.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.informational_url_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential.KeyCredential.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential_paged.KeyCredentialPaged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential_paged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential_py3.KeyCredential.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credentials_update_parameters.KeyCredentialsUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credentials_update_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credentials_update_parameters_py3.KeyCredentialsUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credentials_update_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission.OAuth2Permission.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant.OAuth2PermissionGrant.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant_paged.OAuth2PermissionGrantPaged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant_paged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant_py3.OAuth2PermissionGrant.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_py3.OAuth2Permission.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claim.OptionalClaim.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claim.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claim_py3.OptionalClaim.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claim_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claims.OptionalClaims.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claims.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claims_py3.OptionalClaims.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claims_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential.PasswordCredential.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential_paged.PasswordCredentialPaged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential_paged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential_py3.PasswordCredential.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credentials_update_parameters.PasswordCredentialsUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credentials_update_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credentials_update_parameters_py3.PasswordCredentialsUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credentials_update_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_profile.PasswordProfile.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_profile.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_profile_py3.PasswordProfile.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_profile_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application.PreAuthorizedApplication.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_extension.PreAuthorizedApplicationExtension.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_extension.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_extension_py3.PreAuthorizedApplicationExtension.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_extension_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_permission.PreAuthorizedApplicationPermission.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_permission.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_permission_py3.PreAuthorizedApplicationPermission.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_permission_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_py3.PreAuthorizedApplication.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.required_resource_access.RequiredResourceAccess.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.required_resource_access.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.required_resource_access_py3.RequiredResourceAccess.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.required_resource_access_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.resource_access.ResourceAccess.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.resource_access.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.resource_access_py3.ResourceAccess.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.resource_access_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal.ServicePrincipal.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_base.ServicePrincipalBase.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_base.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_base_py3.ServicePrincipalBase.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_base_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_create_parameters.ServicePrincipalCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_create_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_create_parameters_py3.ServicePrincipalCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_create_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_object_result.ServicePrincipalObjectResult.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_object_result.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_object_result_py3.ServicePrincipalObjectResult.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_object_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_paged.ServicePrincipalPaged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_paged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_py3.ServicePrincipal.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_update_parameters.ServicePrincipalUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_update_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_update_parameters_py3.ServicePrincipalUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_update_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.sign_in_name.SignInName.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.sign_in_name.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.sign_in_name_py3.SignInName.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.sign_in_name_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.str_paged.StrPaged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.str_paged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user.User.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_base.UserBase.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_base.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_base_py3.UserBase.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_base_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_create_parameters.UserCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_create_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_create_parameters_py3.UserCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_create_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_get_member_groups_parameters.UserGetMemberGroupsParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_get_member_groups_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_get_member_groups_parameters_py3.UserGetMemberGroupsParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_get_member_groups_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_paged.UserPaged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_paged.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_py3.User.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_update_parameters.UserUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_update_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_update_parameters_py3.UserUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_update_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.ApplicationsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.DeletedApplicationsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.DomainsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.GroupsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.OAuth2PermissionGrantOperations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.ObjectsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.ServicePrincipalsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.SignedInUserOperations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.UsersOperations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.applications_operations.ApplicationsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.applications_operations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.deleted_applications_operations.DeletedApplicationsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.deleted_applications_operations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.domains_operations.DomainsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.domains_operations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.groups_operations.GroupsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.groups_operations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.oauth2_permission_grant_operations.OAuth2PermissionGrantOperations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.oauth2_permission_grant_operations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.objects_operations.ObjectsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.objects_operations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.service_principals_operations.ServicePrincipalsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.service_principals_operations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.signed_in_user_operations.SignedInUserOperations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.signed_in_user_operations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.users_operations.UsersOperations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.users_operations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.version.yml create mode 100644 previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.yml create mode 100644 previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.ModelError.yml create mode 100644 previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.ModelsRepositoryClient.yml create mode 100644 previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.dtmi_conventions.yml create mode 100644 previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.exceptions.ModelError.yml create mode 100644 previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.exceptions.yml create mode 100644 previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.AccessToken.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.CertificateId.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.CertificateIssuerId.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.CertificateOperationId.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.HttpBearerChallenge.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.HttpChallenge.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.KeyId.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.KeyVaultAuthBase.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.KeyVaultAuthentication.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.KeyVaultClient.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.KeyVaultId.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.SecretId.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.StorageAccountId.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.StorageSasDefinitionId.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_bearer_challenge.HttpBearerChallenge.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_bearer_challenge.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_bearer_challenge_cache.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_challenge.HttpChallenge.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_challenge.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_message_security.HttpMessageSecurity.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_message_security.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_authentication.AccessToken.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_authentication.KeyVaultAuthBase.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_authentication.KeyVaultAuthentication.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_authentication.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_client.KeyVaultClient.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_client.KeyVaultClientConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_client.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.CertificateId.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.CertificateIssuerId.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.CertificateOperationId.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.KeyId.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.KeyVaultCollectionType.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.KeyVaultId.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.KeyVaultIdentifier.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.SecretId.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.StorageAccountId.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.StorageSasDefinitionId.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.models.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.KeyVaultClient.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClientConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.key_vault_client.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Action(class).yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.ActionType.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.AdministratorDetails.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Attributes(class).yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.BackupKeyResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.BackupSecretResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateImportParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerSetParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateMergeParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateOperation.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateOperationUpdateParameter.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificatePolicy.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Contact(class).yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Contacts(class).yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedCertificateBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedCertificateItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedCertificateItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedKeyBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedKeyItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedKeyItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedSecretBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedSecretItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedSecretItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletionRecoveryLevel.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Error(class).yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerCredentials.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKey.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKeyCurveName.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKeyEncryptionAlgorithm.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKeyOperation.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKeySignatureAlgorithm.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKeyType.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyImportParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyOperationResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyOperationsParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyProperties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyRestoreParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeySignParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyUsageType.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyVaultError.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyVaultErrorException.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyVerifyParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyVerifyResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.LifetimeAction.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.OrganizationDetails.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.PendingCertificateSigningRequestResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretProperties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretRestoreParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretSetParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountRegenerteKeyParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SubjectAlternativeNames.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Trigger(class).yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.X509CertificateProperties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.action.Action.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.action.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.action_py3.Action.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.action_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.administrator_details.AdministratorDetails.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.administrator_details.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.administrator_details_py3.AdministratorDetails.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.administrator_details_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.attributes.Attributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.attributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.attributes_py3.Attributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.attributes_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_key_result.BackupKeyResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_key_result.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_key_result_py3.BackupKeyResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_key_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_secret_result.BackupSecretResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_secret_result.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_secret_result_py3.BackupSecretResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_secret_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_attributes.CertificateAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_attributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_attributes_py3.CertificateAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_attributes_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_bundle.CertificateBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_bundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_bundle_py3.CertificateBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_bundle_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_create_parameters.CertificateCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_create_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.CertificateCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_import_parameters.CertificateImportParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_import_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.CertificateImportParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item.CertificateIssuerItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged.CertificateIssuerItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.CertificateIssuerItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item.CertificateItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item_paged.CertificateItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item_paged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item_py3.CertificateItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_merge_parameters.CertificateMergeParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_merge_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.CertificateMergeParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation.CertificateOperation.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_py3.CertificateOperation.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_policy.CertificatePolicy.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_policy.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_policy_py3.CertificatePolicy.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_policy_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_update_parameters.CertificateUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_update_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.CertificateUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contact.Contact.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contact.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contact_py3.Contact.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contact_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contacts.Contacts.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contacts.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contacts_py3.Contacts.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contacts_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_bundle.DeletedCertificateBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_bundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item.DeletedCertificateItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged.DeletedCertificateItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3.DeletedCertificateItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_bundle.DeletedKeyBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_bundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3.DeletedKeyBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item.DeletedKeyItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item_paged.DeletedKeyItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item_paged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item_py3.DeletedKeyItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_bundle.DeletedSecretBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_bundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3.DeletedSecretBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item.DeletedSecretItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item_paged.DeletedSecretItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item_paged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item_py3.DeletedSecretItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.error.Error.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.error.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.error_py3.Error.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.error_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_attributes.IssuerAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_attributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_attributes_py3.IssuerAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_attributes_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_bundle.IssuerBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_bundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_bundle_py3.IssuerBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_bundle_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_credentials.IssuerCredentials.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_credentials.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_credentials_py3.IssuerCredentials.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_credentials_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_parameters.IssuerParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_parameters_py3.IssuerParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.json_web_key.JsonWebKey.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.json_web_key.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.json_web_key_py3.JsonWebKey.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.json_web_key_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_attributes.KeyAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_attributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_attributes_py3.KeyAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_attributes_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_bundle.KeyBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_bundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_bundle_py3.KeyBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_bundle_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_create_parameters.KeyCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_create_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_create_parameters_py3.KeyCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_create_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_import_parameters.KeyImportParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_import_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_import_parameters_py3.KeyImportParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_import_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item.KeyItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item_paged.KeyItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item_paged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item_py3.KeyItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operation_result.KeyOperationResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operation_result.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operation_result_py3.KeyOperationResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operation_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operations_parameters.KeyOperationsParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operations_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operations_parameters_py3.KeyOperationsParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operations_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_properties.KeyProperties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_properties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_properties_py3.KeyProperties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_properties_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_restore_parameters.KeyRestoreParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_restore_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_restore_parameters_py3.KeyRestoreParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_restore_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_sign_parameters.KeySignParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_sign_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_sign_parameters_py3.KeySignParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_sign_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_update_parameters.KeyUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_update_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_update_parameters_py3.KeyUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_update_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.ActionType.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.DeletionRecoveryLevel.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyCurveName.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyEncryptionAlgorithm.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyOperation.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyType.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.KeyUsageType.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultError.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultErrorException.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultError.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultErrorException.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_parameters.KeyVerifyParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_parameters_py3.KeyVerifyParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_result.KeyVerifyResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_result.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_result_py3.KeyVerifyResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.lifetime_action.LifetimeAction.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.lifetime_action.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.lifetime_action_py3.LifetimeAction.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.lifetime_action_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.organization_details.OrganizationDetails.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.organization_details.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.organization_details_py3.OrganizationDetails.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.organization_details_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_attributes.SasDefinitionAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_attributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3.SasDefinitionAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_bundle.SasDefinitionBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_bundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3.SasDefinitionBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_create_parameters.SasDefinitionCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_create_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item.SasDefinitionItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item_paged.SasDefinitionItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item_paged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item_py3.SasDefinitionItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_update_parameters.SasDefinitionUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_update_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_attributes.SecretAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_attributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_attributes_py3.SecretAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_attributes_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_bundle.SecretBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_bundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_bundle_py3.SecretBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_bundle_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item.SecretItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item_paged.SecretItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item_paged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item_py3.SecretItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_properties.SecretProperties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_properties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_properties_py3.SecretProperties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_properties_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_restore_parameters.SecretRestoreParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_restore_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3.SecretRestoreParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_set_parameters.SecretSetParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_set_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.SecretSetParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_update_parameters.SecretUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_update_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.SecretUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_attributes.StorageAccountAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_attributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_attributes_py3.StorageAccountAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_attributes_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_create_parameters.StorageAccountCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_create_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item.StorageAccountItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item_paged.StorageAccountItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item_paged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item_py3.StorageAccountItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_update_parameters.StorageAccountUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_update_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_bundle.StorageBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_bundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_bundle_py3.StorageBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_bundle_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.subject_alternative_names.SubjectAlternativeNames.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.subject_alternative_names.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.SubjectAlternativeNames.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.trigger.Trigger.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.trigger.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.trigger_py3.Trigger.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.trigger_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.x509_certificate_properties.X509CertificateProperties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.x509_certificate_properties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.X509CertificateProperties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.version.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.KeyVaultClient.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.key_vault_client.KeyVaultClient.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.key_vault_client.KeyVaultClientConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.key_vault_client.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Action(class).yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.ActionType.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.AdministratorDetails.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Attributes(class).yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.BackupCertificateResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.BackupKeyResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.BackupSecretResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.BackupStorageResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateImportParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerSetParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateMergeParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateOperation.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateOperationUpdateParameter.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificatePolicy.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateRestoreParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Contact(class).yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Contacts(class).yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedCertificateBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedCertificateItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedCertificateItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedKeyBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedKeyItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedKeyItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSasDefinitionBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSasDefinitionItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSasDefinitionItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSecretBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSecretItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSecretItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedStorageAccountItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedStorageAccountItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedStorageBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletionRecoveryLevel.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Error(class).yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerCredentials.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKey.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKeyCurveName.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKeyEncryptionAlgorithm.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKeyOperation.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKeySignatureAlgorithm.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKeyType.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyImportParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyOperationResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyOperationsParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyProperties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyRestoreParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeySignParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyUsageType.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyVaultError.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyVaultErrorException.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyVerifyParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyVerifyResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.LifetimeAction.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.OrganizationDetails.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.PendingCertificateSigningRequestResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasTokenType.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretProperties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretRestoreParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretSetParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountRegenerteKeyParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageRestoreParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SubjectAlternativeNames.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Trigger(class).yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.X509CertificateProperties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.action.Action.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.action.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.action_py3.Action.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.action_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.administrator_details.AdministratorDetails.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.administrator_details.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.administrator_details_py3.AdministratorDetails.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.administrator_details_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.attributes.Attributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.attributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.attributes_py3.Attributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.attributes_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_certificate_result.BackupCertificateResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_certificate_result.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_certificate_result_py3.BackupCertificateResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_certificate_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_key_result.BackupKeyResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_key_result.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_key_result_py3.BackupKeyResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_key_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_secret_result.BackupSecretResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_secret_result.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_secret_result_py3.BackupSecretResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_secret_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_storage_result.BackupStorageResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_storage_result.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_storage_result_py3.BackupStorageResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_storage_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_attributes.CertificateAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_attributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_attributes_py3.CertificateAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_attributes_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_bundle.CertificateBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_bundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_bundle_py3.CertificateBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_bundle_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_create_parameters.CertificateCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_create_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_create_parameters_py3.CertificateCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_create_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_import_parameters.CertificateImportParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_import_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_import_parameters_py3.CertificateImportParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_import_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item.CertificateIssuerItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item_paged.CertificateIssuerItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item_paged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item_py3.CertificateIssuerItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_set_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_update_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item.CertificateItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item_paged.CertificateItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item_paged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item_py3.CertificateItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_merge_parameters.CertificateMergeParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_merge_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_merge_parameters_py3.CertificateMergeParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_merge_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation.CertificateOperation.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_py3.CertificateOperation.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_update_parameter.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_policy.CertificatePolicy.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_policy.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_policy_py3.CertificatePolicy.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_policy_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_restore_parameters.CertificateRestoreParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_restore_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_restore_parameters_py3.CertificateRestoreParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_restore_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_update_parameters.CertificateUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_update_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_update_parameters_py3.CertificateUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_update_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contact.Contact.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contact.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contact_py3.Contact.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contact_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contacts.Contacts.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contacts.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contacts_py3.Contacts.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contacts_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_bundle.DeletedCertificateBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_bundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_bundle_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item.DeletedCertificateItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item_paged.DeletedCertificateItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item_paged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item_py3.DeletedCertificateItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_bundle.DeletedKeyBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_bundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_bundle_py3.DeletedKeyBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_bundle_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item.DeletedKeyItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item_paged.DeletedKeyItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item_paged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item_py3.DeletedKeyItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_bundle.DeletedSasDefinitionBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_bundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3.DeletedSasDefinitionBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item.DeletedSasDefinitionItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item_paged.DeletedSasDefinitionItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item_paged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item_py3.DeletedSasDefinitionItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_bundle.DeletedSecretBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_bundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_bundle_py3.DeletedSecretBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_bundle_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item.DeletedSecretItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item_paged.DeletedSecretItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item_paged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item_py3.DeletedSecretItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item.DeletedStorageAccountItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item_paged.DeletedStorageAccountItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item_paged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item_py3.DeletedStorageAccountItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_bundle.DeletedStorageBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_bundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_bundle_py3.DeletedStorageBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_bundle_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.error.Error.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.error.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.error_py3.Error.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.error_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_attributes.IssuerAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_attributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_attributes_py3.IssuerAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_attributes_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_bundle.IssuerBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_bundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_bundle_py3.IssuerBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_bundle_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_credentials.IssuerCredentials.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_credentials.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_credentials_py3.IssuerCredentials.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_credentials_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_parameters.IssuerParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_parameters_py3.IssuerParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.json_web_key.JsonWebKey.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.json_web_key.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.json_web_key_py3.JsonWebKey.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.json_web_key_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_attributes.KeyAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_attributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_attributes_py3.KeyAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_attributes_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_bundle.KeyBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_bundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_bundle_py3.KeyBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_bundle_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_create_parameters.KeyCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_create_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_create_parameters_py3.KeyCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_create_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_import_parameters.KeyImportParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_import_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_import_parameters_py3.KeyImportParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_import_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item.KeyItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item_paged.KeyItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item_paged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item_py3.KeyItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operation_result.KeyOperationResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operation_result.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operation_result_py3.KeyOperationResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operation_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operations_parameters.KeyOperationsParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operations_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operations_parameters_py3.KeyOperationsParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operations_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_properties.KeyProperties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_properties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_properties_py3.KeyProperties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_properties_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_restore_parameters.KeyRestoreParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_restore_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_restore_parameters_py3.KeyRestoreParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_restore_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_sign_parameters.KeySignParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_sign_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_sign_parameters_py3.KeySignParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_sign_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_update_parameters.KeyUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_update_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_update_parameters_py3.KeyUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_update_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.ActionType.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.DeletionRecoveryLevel.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyCurveName.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyEncryptionAlgorithm.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyOperation.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyType.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.KeyUsageType.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.SasTokenType.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error.KeyVaultError.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error.KeyVaultErrorException.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultError.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultErrorException.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_parameters.KeyVerifyParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_parameters_py3.KeyVerifyParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_result.KeyVerifyResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_result.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_result_py3.KeyVerifyResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.lifetime_action.LifetimeAction.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.lifetime_action.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.lifetime_action_py3.LifetimeAction.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.lifetime_action_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.organization_details.OrganizationDetails.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.organization_details.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.organization_details_py3.OrganizationDetails.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.organization_details_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.pending_certificate_signing_request_result.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_attributes.SasDefinitionAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_attributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_attributes_py3.SasDefinitionAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_attributes_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_bundle.SasDefinitionBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_bundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_bundle_py3.SasDefinitionBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_bundle_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_create_parameters.SasDefinitionCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_create_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item.SasDefinitionItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item_paged.SasDefinitionItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item_paged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item_py3.SasDefinitionItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_update_parameters.SasDefinitionUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_update_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_attributes.SecretAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_attributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_attributes_py3.SecretAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_attributes_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_bundle.SecretBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_bundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_bundle_py3.SecretBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_bundle_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item.SecretItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item_paged.SecretItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item_paged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item_py3.SecretItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_properties.SecretProperties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_properties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_properties_py3.SecretProperties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_properties_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_restore_parameters.SecretRestoreParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_restore_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_restore_parameters_py3.SecretRestoreParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_restore_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_set_parameters.SecretSetParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_set_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_set_parameters_py3.SecretSetParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_set_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_update_parameters.SecretUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_update_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_update_parameters_py3.SecretUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_update_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_attributes.StorageAccountAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_attributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_attributes_py3.StorageAccountAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_attributes_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_create_parameters.StorageAccountCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_create_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_create_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item.StorageAccountItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item_paged.StorageAccountItemPaged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item_paged.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item_py3.StorageAccountItem.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_update_parameters.StorageAccountUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_update_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_update_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_bundle.StorageBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_bundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_bundle_py3.StorageBundle.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_bundle_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_restore_parameters.StorageRestoreParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_restore_parameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_restore_parameters_py3.StorageRestoreParameters.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_restore_parameters_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.subject_alternative_names.SubjectAlternativeNames.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.subject_alternative_names.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.subject_alternative_names_py3.SubjectAlternativeNames.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.subject_alternative_names_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.trigger.Trigger.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.trigger.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.trigger_py3.Trigger.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.trigger_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.x509_certificate_properties.X509CertificateProperties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.x509_certificate_properties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.x509_certificate_properties_py3.X509CertificateProperties.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.x509_certificate_properties_py3.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.version.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.version.yml create mode 100644 previous/docs-ref-autogen/azure-keyvault/azure.keyvault.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.LogAnalyticsDataClient.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.log_analytics_data_client.LogAnalyticsDataClient.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.log_analytics_data_client.LogAnalyticsDataClientConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.log_analytics_data_client.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.Column(class).yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorDetail.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorInfo.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorResponseException.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.QueryBody.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.QueryResults.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.Table(class).yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.column.Column.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.column.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.column_py3.Column.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.column_py3.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_detail.ErrorDetail.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_detail.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_detail_py3.ErrorDetail.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_detail_py3.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_info.ErrorInfo.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_info.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_info_py3.ErrorInfo.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response.ErrorResponseException.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response_py3.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response_py3.ErrorResponseException.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response_py3.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_body.QueryBody.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_body.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_body_py3.QueryBody.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_body_py3.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_results.QueryResults.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_results.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_results_py3.QueryResults.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_results_py3.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.table.Table.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.table.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.table_py3.Table.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.table_py3.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.version.yml create mode 100644 previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.CertificateSource.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.CognitiveServicesVisionProcessor.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.CredentialsBase.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.DiscoveredOnvifDevice.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.DiscoveredOnvifDeviceCollection.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.EndpointBase.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ExtensionProcessorBase.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.FileSink.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.GrpcExtension.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.GrpcExtensionDataTransfer.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.GrpcExtensionDataTransferMode.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.H264Configuration.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.H264Profile.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.HttpExtension.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.HttpHeaderCredentials.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatBmp.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatJpeg.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatPng.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatProperties.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatRaw.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatRawPixelFormat.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageProperties.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageScale.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageScaleMode.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.IotHubDeviceConnection.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.IotHubMessageSink.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.IotHubMessageSource.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LineCrossingProcessor.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipeline.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineActivateRequest.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineCollection.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineDeactivateRequest.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineDeleteRequest.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineGetRequest.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineListRequest.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineProperties.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineSetRequest.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineSetRequestBody.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineState.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MPEG4Configuration.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MPEG4Profile.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MediaProfile.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MediaUri.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MethodRequest.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MethodRequestEmptyBodyBase.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MotionDetectionProcessor.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MotionDetectionSensitivity.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NamedLineBase.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NamedLineString.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NamedPolygonBase.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NamedPolygonString.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NodeInput.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ObjectTrackingAccuracy.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ObjectTrackingProcessor.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDevice.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDeviceDiscoverRequest.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDeviceGetRequest.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDns.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifHostName.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifSystemDateTime.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifSystemDateTimeType.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OutputSelector.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OutputSelectorOperator.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OutputSelectorProperty.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ParameterDeclaration.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ParameterDefinition.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ParameterType.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PemCertificateList.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopology.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyCollection.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyDeleteRequest.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyGetRequest.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyListRequest.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyProperties.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologySetRequest.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologySetRequestBody.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ProcessorNodeBase.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RateControl.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapter.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterCollection.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterDeleteRequest.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterGetRequest.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterListRequest.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterProperties.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequest.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequestBody.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterTarget.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RtspSource.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RtspTransport.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SamplingOptions.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SignalGateProcessor.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SinkNodeBase.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SourceNodeBase.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisCustomOperation.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisOperationBase.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisOperationEventBase.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisOperationFocus.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEvent.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEventTrigger.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountOperation.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountZoneEvents.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEvent.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEventTrigger.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceOperation.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceZoneEvents.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingEvent.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingLineEvents.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingOperation.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEvent.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEventType.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingOperation.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingZoneEvents.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisTypedOperationBase.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SymmetricKeyCredentials.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SystemData.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.TlsEndpoint.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.TlsValidationOptions.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.UnsecuredEndpoint.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.UsernamePasswordCredentials.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoCreationProperties.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoEncoderConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoEncoding.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoPublishingOptions.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoResolution.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoSink.yml create mode 100644 previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.AzureAgFoodPlatformRPService.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.AzureAgFoodPlatformRPService.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.ExtensionsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.FarmBeatsExtensionsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.FarmBeatsModelsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.LocationsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ActionType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CheckNameAvailabilityReason.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CheckNameAvailabilityRequest.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CheckNameAvailabilityResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CreatedByType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.DetailedInformation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ErrorAdditionalInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ErrorDetail.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.Extension.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ExtensionListResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeats.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsExtension.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsExtensionListResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsListResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsUpdateRequestModel.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.Operation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.OperationDisplay.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.OperationListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.Origin.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ProvisioningState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ProxyResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.Resource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.SystemData.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.TrackedResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.UnitSystemsInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.ExtensionsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.FarmBeatsExtensionsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.FarmBeatsModelsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.LocationsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.ContainerAppsAPIClient.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.ContainerAppsAPIClient.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.CertificatesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsAuthConfigsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsRevisionReplicasOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsRevisionsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsSourceControlsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.DaprComponentsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ManagedEnvironmentsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ManagedEnvironmentsStoragesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AccessMode.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ActiveRevisionsMode.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AllowedAudiencesValidation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AllowedPrincipals.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppLogsConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppProtocol.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppRegistration.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Apple.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppleRegistration.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AuthConfig.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AuthConfigCollection.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AuthPlatform.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AvailableOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectory.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryLogin.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryRegistration.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryValidation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureCredentials.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureFileProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureStaticWebApps.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureStaticWebAppsRegistration.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.BindingType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Certificate.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificateCollection.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificatePatch.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificateProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificateProvisioningState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ClientRegistration.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Configuration.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Container.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerApp.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppCollection.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppPatch.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbe.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbeHttpGet.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbeHttpGetHttpHeadersItem.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbeTcpSocket.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProvisioningState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppSecret.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerResources.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CookieExpiration.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CookieExpirationConvention.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CreatedByType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomDomain.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomHostnameAnalysisResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomOpenIdConnectProvider.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomScaleRule.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Dapr.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DaprComponent.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DaprComponentsCollection.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DaprMetadata.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultAuthorizationPolicy.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultErrorResponseError.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultErrorResponseErrorDetailsItem.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DnsVerificationTestResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.EnvironmentProvisioningState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.EnvironmentVar.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Facebook.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ForwardProxy.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ForwardProxyConvention.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GitHub.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GithubActionConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GlobalValidation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Google.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpScaleRule.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpSettings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpSettingsRoutes.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.IdentityProviders.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Ingress.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.IngressTransportMethod.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.JwtClaimChecks.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LogAnalyticsConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Login.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LoginRoutes.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LoginScopes.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironment.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentPatch.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentStorage.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentStorageProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentStoragesCollection.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentsCollection.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedServiceIdentity.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedServiceIdentityType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Nonce.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectClientCredential.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectConfig.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectLogin.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectRegistration.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OperationDetail.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OperationDisplay.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ProxyResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.QueueScaleRule.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RegistryCredentials.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RegistryInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Replica.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ReplicaCollection.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ReplicaContainer.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Resource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Revision.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RevisionCollection.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RevisionHealthState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RevisionProvisioningState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Scale.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ScaleRule.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ScaleRuleAuth.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Secret.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SecretsCollection.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SourceControl.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SourceControlCollection.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SourceControlOperationState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.StorageType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SystemData.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Template.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TrackedResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TrafficWeight.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Twitter.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TwitterRegistration.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Type.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.UnauthenticatedClientActionV2.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.UserAssignedIdentity.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.VnetConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Volume.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.VolumeMount.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.CertificatesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsAuthConfigsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsRevisionReplicasOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsRevisionsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsSourceControlsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.DaprComponentsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ManagedEnvironmentsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ManagedEnvironmentsStoragesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.CPIMConfigurationClient.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.aio.CPIMConfigurationClient.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.aio.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.models.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.CPIMConfigurationClient.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.aio.CPIMConfigurationClient.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.aio.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatusError.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKU.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKUName.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResourceList.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResourcePropertiesBillingConfig.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantUpdateRequest.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.BillingType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.CheckNameAvailabilityRequestBody.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBody.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBodyProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.ErrorAdditionalInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.NameAvailabilityReasonType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.NameAvailabilityResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.Operation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.OperationDisplay.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.OperationListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.StatusType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.operations.B2CTenantsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.CPIMConfigurationClient.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.aio.CPIMConfigurationClient.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.GuestUsagesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.aio.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.ErrorAdditionalInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResourceList.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResourcePatch.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.Operation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.OperationDisplay.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.OperationListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.operations.GuestUsagesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.LargeInstanceMgmtClient.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.LargeInstanceMgmtClient.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.operations.AzureLargeInstanceOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.operations.AzureLargeStorageInstanceOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ActionType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstance.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceForcePowerState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceHardwareTypeNamesEnum.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstancePowerStateEnum.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProvisioningStatesEnum.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceTagsUpdate.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstance.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceTagsUpdate.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.CreatedByType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Disk.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ErrorAdditionalInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ErrorDetail.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ForceState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.HardwareProfile.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.IpAddress.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.NetworkProfile.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Operation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OperationDisplay.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OperationListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OperationStatusResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Origin.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OsProfile.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ProvisioningState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Resource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageBillingProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageProfile.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.SystemData.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Tags.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.TrackedResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Versions.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.operations.AzureLargeInstanceOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.operations.AzureLargeStorageInstanceOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.BatchAI.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.BatchAI.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.ClustersOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.ExperimentsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.FileServersOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.JobsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.UsagesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.WorkspacesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AllocationState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AppInsightsReference.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AutoScaleSettings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AzureBlobFileSystemReference.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AzureFileShareReference.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AzureStorageCredentialsInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.BatchAIError.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CNTKsettings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CachingType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Caffe2Settings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CaffeSettings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ChainerSettings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CloudErrorBody.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Cluster.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClusterCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClusterListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClusterUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClustersListByWorkspaceOptions.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ContainerSettings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CustomMpiSettings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CustomToolkitSettings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.DataDisks.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.DeallocationOption.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.EnvironmentVariable.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.EnvironmentVariableWithSecretValue.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ExecutionState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Experiment.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ExperimentListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ExperimentsListByWorkspaceOptions.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.File.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServer.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerProvisioningState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerReference.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServersListByWorkspaceOptions.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.HorovodSettings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ImageReference.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ImageSourceRegistry.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.InputDirectory.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Job.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobBasePropertiesConstraints.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobPreparation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobPriority.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobPropertiesConstraints.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobPropertiesExecutionInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobsListByExperimentOptions.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobsListOutputFilesOptions.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.KeyVaultSecretReference.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ListUsagesResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ManualScaleSettings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.MountSettings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.MountVolumes.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.NameValuePair.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.NodeSetup.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.NodeStateCounts.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Operation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.OperationDisplay.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.OperationListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.OutputDirectory.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.PerformanceCountersSettings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.PrivateRegistryCredentials.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ProvisioningState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ProxyResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.PyTorchSettings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.RemoteLoginInformation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.RemoteLoginInformationListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Resource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ResourceId.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ScaleSettings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.SetupTask.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.SshConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.StorageAccountType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.TensorFlowSettings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ToolType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.UnmanagedFileSystemReference.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Usage.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.UsageName.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.UsageUnit.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.UserAccountSettings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.VirtualMachineConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.VmPriority.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Workspace.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspaceCreateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspaceListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspaceUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspacesListByResourceGroupOptions.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspacesListOptions.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.ClustersOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.ExperimentsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.FileServersOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.JobsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.UsagesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.WorkspacesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.DataBoxEdgeManagementClient.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.data_box_edge_management_client.DataBoxEdgeManagementClient.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.data_box_edge_management_client.DataBoxEdgeManagementClientConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.data_box_edge_management_client.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ARMBaseModel.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AccountType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Address(class).yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Alert(class).yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AlertErrorDetails.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AlertPaged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AlertSeverity.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AsymmetricEncryptedSecret.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Authentication(class).yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AzureContainerDataFormat.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AzureContainerInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.BandwidthSchedule.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.BandwidthSchedulePaged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ClientAccessRight.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ClientPermissionType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ContactDetails.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDevice.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDeviceExtendedInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDevicePaged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDevicePatch.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDeviceStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataPolicy.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DayOfWeek.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DeviceType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DownloadPhase.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.EncryptionAlgorithm.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.FileEventTrigger.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.FileSourceInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.InstallRebootBehavior.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.IoTDeviceInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.IoTRole.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Ipv4Config.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Ipv6Config.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Job(class).yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.JobErrorDetails.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.JobErrorItem.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.JobStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.JobType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricAggregationType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricCategory.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricDimensionV1.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricSpecificationV1.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricUnit.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MonitoringStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MountPointMap.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapter.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapterDHCPStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapterPosition.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapterRDMAStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapterStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkGroup.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkSettings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Operation(class).yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OperationDisplay.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OperationPaged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Order(class).yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OrderPaged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OrderState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OrderStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.PeriodicTimerEventTrigger.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.PeriodicTimerSourceInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.PlatformType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RefreshDetails.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Role(class).yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RolePaged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RoleSinkInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RoleStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RoleTypes.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SSLStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SecuritySettings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ServiceSpecification.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Share(class).yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ShareAccessProtocol.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ShareAccessRight.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ShareAccessType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SharePaged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ShareStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Sku(class).yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SkuName.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SkuTier.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.StorageAccountCredential.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.StorageAccountCredentialPaged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SymmetricKey.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.TimeGrain.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.TrackingInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Trigger(class).yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.TriggerPaged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateDownloadProgress.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateInstallProgress.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateOperation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateOperationStage.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateSummary.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UploadCertificateRequest.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UploadCertificateResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.User(class).yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UserAccessRight.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UserPaged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.address.Address.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.address.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.address_py3.Address.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.address_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert.Alert.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_error_details.AlertErrorDetails.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_error_details.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_error_details_py3.AlertErrorDetails.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_error_details_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_paged.AlertPaged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_paged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_py3.Alert.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.arm_base_model.ARMBaseModel.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.arm_base_model.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.arm_base_model_py3.ARMBaseModel.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.arm_base_model_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.asymmetric_encrypted_secret.AsymmetricEncryptedSecret.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.asymmetric_encrypted_secret.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.asymmetric_encrypted_secret_py3.AsymmetricEncryptedSecret.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.asymmetric_encrypted_secret_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.authentication.Authentication.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.authentication.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.authentication_py3.Authentication.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.authentication_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.azure_container_info.AzureContainerInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.azure_container_info.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.azure_container_info_py3.AzureContainerInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.azure_container_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule.BandwidthSchedule.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule_paged.BandwidthSchedulePaged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule_paged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule_py3.BandwidthSchedule.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.client_access_right.ClientAccessRight.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.client_access_right.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.client_access_right_py3.ClientAccessRight.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.client_access_right_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.contact_details.ContactDetails.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.contact_details.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.contact_details_py3.ContactDetails.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.contact_details_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device.DataBoxEdgeDevice.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_extended_info.DataBoxEdgeDeviceExtendedInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_extended_info.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_extended_info_py3.DataBoxEdgeDeviceExtendedInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_extended_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_paged.DataBoxEdgeDevicePaged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_paged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_patch.DataBoxEdgeDevicePatch.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_patch.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_patch_py3.DataBoxEdgeDevicePatch.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_patch_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_py3.DataBoxEdgeDevice.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AccountType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AlertSeverity.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AzureContainerDataFormat.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ClientPermissionType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataBoxEdgeDeviceStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataPolicy.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DayOfWeek.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DeviceType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DownloadPhase.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.EncryptionAlgorithm.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.InstallRebootBehavior.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricAggregationType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricCategory.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricUnit.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MonitoringStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterDHCPStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterRDMAStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkGroup.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.OrderState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.PlatformType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.RoleStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.RoleTypes.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SSLStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareAccessProtocol.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareAccessType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SkuName.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SkuTier.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.TimeGrain.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_event_trigger.FileEventTrigger.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_event_trigger.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_event_trigger_py3.FileEventTrigger.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_event_trigger_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_source_info.FileSourceInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_source_info.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_source_info_py3.FileSourceInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_source_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_tdevice_info.IoTDeviceInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_tdevice_info.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_tdevice_info_py3.IoTDeviceInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_tdevice_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_trole.IoTRole.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_trole.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_trole_py3.IoTRole.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_trole_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv4_config.Ipv4Config.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv4_config.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv4_config_py3.Ipv4Config.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv4_config_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv6_config.Ipv6Config.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv6_config.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv6_config_py3.Ipv6Config.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv6_config_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job.Job.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_details.JobErrorDetails.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_details.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_details_py3.JobErrorDetails.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_details_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_item.JobErrorItem.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_item.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_item_py3.JobErrorItem.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_item_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_py3.Job.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_dimension_v1.MetricDimensionV1.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_dimension_v1.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_dimension_v1_py3.MetricDimensionV1.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_dimension_v1_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_specification_v1.MetricSpecificationV1.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_specification_v1.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_specification_v1_py3.MetricSpecificationV1.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_specification_v1_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.mount_point_map.MountPointMap.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.mount_point_map.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.mount_point_map_py3.MountPointMap.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.mount_point_map_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter.NetworkAdapter.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_position.NetworkAdapterPosition.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_position.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_position_py3.NetworkAdapterPosition.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_position_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_py3.NetworkAdapter.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_settings.NetworkSettings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_settings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_settings_py3.NetworkSettings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_settings_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation.Operation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_display.OperationDisplay.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_display.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_display_py3.OperationDisplay.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_display_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_paged.OperationPaged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_paged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_py3.Operation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order.Order.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_paged.OrderPaged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_paged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_py3.Order.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_status.OrderStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_status.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_status_py3.OrderStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_status_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_event_trigger.PeriodicTimerEventTrigger.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_event_trigger.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_event_trigger_py3.PeriodicTimerEventTrigger.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_event_trigger_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_source_info.PeriodicTimerSourceInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_source_info.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_source_info_py3.PeriodicTimerSourceInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_source_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.refresh_details.RefreshDetails.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.refresh_details.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.refresh_details_py3.RefreshDetails.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.refresh_details_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role.Role.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_paged.RolePaged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_paged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_py3.Role.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_sink_info.RoleSinkInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_sink_info.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_sink_info_py3.RoleSinkInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_sink_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.security_settings.SecuritySettings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.security_settings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.security_settings_py3.SecuritySettings.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.security_settings_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.service_specification.ServiceSpecification.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.service_specification.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.service_specification_py3.ServiceSpecification.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.service_specification_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share.Share.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_access_right.ShareAccessRight.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_access_right.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_access_right_py3.ShareAccessRight.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_access_right_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_paged.SharePaged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_paged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_py3.Share.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.sku.Sku.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.sku.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.sku_py3.Sku.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.sku_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential.StorageAccountCredential.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential_paged.StorageAccountCredentialPaged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential_paged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential_py3.StorageAccountCredential.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.symmetric_key.SymmetricKey.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.symmetric_key.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.symmetric_key_py3.SymmetricKey.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.symmetric_key_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.tracking_info.TrackingInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.tracking_info.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.tracking_info_py3.TrackingInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.tracking_info_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger.Trigger.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger_paged.TriggerPaged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger_paged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger_py3.Trigger.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_download_progress.UpdateDownloadProgress.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_download_progress.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_download_progress_py3.UpdateDownloadProgress.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_download_progress_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_install_progress.UpdateInstallProgress.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_install_progress.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_install_progress_py3.UpdateInstallProgress.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_install_progress_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_summary.UpdateSummary.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_summary.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_summary_py3.UpdateSummary.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_summary_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_request.UploadCertificateRequest.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_request.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_request_py3.UploadCertificateRequest.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_request_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_response.UploadCertificateResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_response.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_response_py3.UploadCertificateResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_response_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user.User.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_access_right.UserAccessRight.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_access_right.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_access_right_py3.UserAccessRight.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_access_right_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_paged.UserPaged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_paged.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_py3.User.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_py3.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.AlertsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.BandwidthSchedulesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.DevicesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.JobsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.Operations(class).yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.OperationsStatusOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.OrdersOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.RolesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.SharesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.StorageAccountCredentialsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.TriggersOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.UsersOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.alerts_operations.AlertsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.alerts_operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.bandwidth_schedules_operations.BandwidthSchedulesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.bandwidth_schedules_operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.devices_operations.DevicesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.devices_operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.jobs_operations.JobsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.jobs_operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.operations_status_operations.OperationsStatusOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.operations_status_operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.orders_operations.OrdersOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.orders_operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.roles_operations.RolesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.roles_operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.shares_operations.SharesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.shares_operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.storage_account_credentials_operations.StorageAccountCredentialsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.storage_account_credentials_operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.triggers_operations.TriggersOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.triggers_operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.users_operations.UsersOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.users_operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.version.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.MicrosoftLogz.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.MicrosoftLogz.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.MonitorOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.MonitorsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SingleSignOnOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SubAccountOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SubAccountTagRulesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.TagRulesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.CreatedByType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ErrorAdditionalInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ErrorDetail.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.FilteringTag.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.IdentityProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LiftrResourceCategories.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogRules.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResourceListResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResourceUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzOrganizationProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnResourceListResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ManagedIdentityTypes.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MarketplaceSubscriptionStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitorProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitorUpdateProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoredResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoredResourceListResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRules.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRulesListResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRulesProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationDisplay.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.PlanData.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ProvisioningState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.SingleSignOnStates.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.SystemData.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.TagAction.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRole.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleListResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleRequest.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMExtensionPayload.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMHostUpdateRequest.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMHostUpdateStates.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMResources.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMResourcesListResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.MonitorOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.MonitorsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SingleSignOnOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SubAccountOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SubAccountTagRulesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.TagRulesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.NetworkAnalyticsMgmtClient.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.NetworkAnalyticsMgmtClient.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.operations.DataProductsCatalogsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.operations.DataProductsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.operations.DataTypesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.AccountSas.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.AccountSasToken.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ActionType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Bypass.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ConsumptionEndpointsProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ContainerSaS.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ContainerSasToken.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ControlState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.CreatedByType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProduct.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductInformation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductNetworkAcls.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductUpdate.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductUpdateProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductUserRole.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductVersion.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductsCatalog.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductsCatalogListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductsCatalogProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeUpdate.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeUpdateProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DefaultAction.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.EncryptionKeyDetails.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ErrorAdditionalInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ErrorDetail.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.IPRules.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.KeyVaultInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ListRoleAssignments.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ManagedResourceGroupConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ManagedServiceIdentity.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ManagedServiceIdentityType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Operation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.OperationDisplay.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.OperationListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Origin.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ProvisioningState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ProxyResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.PublisherInformation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Resource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ResourceAccessRules.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.RoleAssignmentCommonProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.RoleAssignmentDetail.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.SystemData.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.TrackedResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.UserAssignedIdentity.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Versions.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.VirtualNetworkRule.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.operations.DataProductsCatalogsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.operations.DataProductsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.operations.DataTypesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.PowerBIEmbeddedManagementClient.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.PowerBIEmbeddedManagementClient.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.operations.PowerBIEmbeddedManagementClientOperationsMixin.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.operations.WorkspaceCollectionsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.operations.WorkspacesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.AccessKeyName.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.AzureSku.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.AzureSkuName.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.AzureSkuTier.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CheckNameReason.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CheckNameRequest.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CheckNameResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CreateWorkspaceCollectionRequest.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Display.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Error.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.ErrorDetail.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.MigrateWorkspaceCollectionRequest.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Operation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.OperationList.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.UpdateWorkspaceCollectionRequest.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Workspace.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollection.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKey.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKeys.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionList.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceList.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.operations.PowerBIEmbeddedManagementClientOperationsMixin.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.operations.WorkspaceCollectionsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.operations.WorkspacesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.SchedulerManagementClient.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.aio.SchedulerManagementClient.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.aio.operations.JobCollectionsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.aio.operations.JobsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.aio.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.aio.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.BasicAuthentication.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ClientCertAuthentication.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.DayOfWeek.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.HttpAuthentication.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.HttpAuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.HttpRequest.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobAction.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobActionType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionDefinition.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionQuota.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobDefinition.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobErrorAction.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobExecutionStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryActionName.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryDefinition.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryDefinitionProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryFilter.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobMaxRecurrence.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrence.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrenceSchedule.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrenceScheduleMonthlyOccurrence.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobScheduleDay.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobStateFilter.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.OAuthAuthentication.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.RecurrenceFrequency.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.RetryPolicy.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.RetryType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusAuthentication.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusAuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusBrokeredMessageProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusMessage.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusQueueMessage.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusTopicMessage.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusTransportType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.Sku.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.SkuDefinition.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.StorageQueueMessage.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.operations.JobCollectionsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.operations.JobsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.patch.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.StorageImportExport.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.StorageImportExport.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.BitLockerKeysOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.JobsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.LocationsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.CreatedByType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DeliveryPackageInformation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DriveBitLockerKey.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DriveState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DriveStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.EncryptionKekType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.EncryptionKeyDetails.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ErrorResponseErrorDetailsItem.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Export.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.GetBitLockerKeysResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.IdentityDetails.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.IdentityType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.JobDetails.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.JobResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ListJobsResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ListOperationsResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Location.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.LocationsResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Operation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.PackageInformation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.PutJobParameters.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ReturnAddress.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ReturnShipping.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ShippingInformation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.SystemData.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.UpdateJobParameters.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.BitLockerKeysOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.JobsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.LocationsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.TestBase.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.TestBase.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.AnalysisResultsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.AvailableOSOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.BillingHubServiceOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.CustomerEventsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.EmailEventsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.FavoriteProcessesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.FlightingRingsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.OSUpdatesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.PackagesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.SkusOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestBaseAccountsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestResultsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestSummariesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestTypesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.UsageOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Action.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultName.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultSingletonResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultSingletonResourceProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AvailableOSListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AvailableOSResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubExecutionUsageDetail.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubFreeHourIncrementEntry.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetFreeHourBalanceResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetUsageRequest.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetUsageResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubPackageUsage.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsage.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsageGroup.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsageGroupedByUpdateType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CPURegressionResultSingletonResourceProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CPUUtilizationResultSingletonResourceProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Category.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CheckNameAvailabilityResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Command.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ContentType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CreatedByType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CustomerEventListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CustomerEventResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.DistributionGroupListReceiverValue.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.DownloadURLResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.EmailEventListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.EmailEventResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ErrorDefinition.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ExecutionStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FavoriteProcessListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FavoriteProcessResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FileUploadURLResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FlightingRingListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FlightingRingResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.GetFileUploadURLParameters.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Grade.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.IdentifiedFailure.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.MemoryRegressionResultSingletonResourceProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.MemoryUtilizationResultSingletonResourceProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.NotificationEventReceiver.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.NotificationReceiverValue.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateTestSummary.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdatesTestSummary.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Operation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OperationDisplay.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OperationListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OsUpdateType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageCheckNameAvailabilityParameters.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageRunTestParameters.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageValidationResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ProvisioningState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ProxyResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Reason.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.RegressionResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.RegressionTestDetails.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ReliabilityResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ReliabilityResultSingletonResourceProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Resource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ScriptExecutionResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ScriptExecutionResultSingletonResourceProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.SubscriptionReceiverValue.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.SystemData.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TargetOSInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Test.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestAnalysisResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestAnalysisResultSingletonResourceProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestAnalysisStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountSKU.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountSKUCapability.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountSKUListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageData.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageDataList.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageName.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultAnalysisSummary.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultConsoleLogDownloadURLParameters.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestSummaryListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestSummaryResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestTypeListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestTypeResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Tier.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TrackedResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Type.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UserObjectReceiverValue.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationBound.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationEntry.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ValidationRunStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.AnalysisResultsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.AvailableOSOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.BillingHubServiceOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.CustomerEventsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.EmailEventsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.FavoriteProcessesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.FlightingRingsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.OSUpdatesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.PackagesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.SkusOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestBaseAccountsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestResultsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestSummariesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestTypesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.UsageOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.VideoAnalyzer.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.VideoAnalyzer.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.AccessPoliciesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.EdgeModulesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.LivePipelineOperationStatusesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.LivePipelinesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.LocationsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.OperationResultsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.OperationStatusesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.PipelineJobOperationStatusesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.PipelineJobsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.PipelineTopologiesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.PrivateEndpointConnectionsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.PrivateLinkResourcesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzerOperationResultsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzerOperationStatusesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzersOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.VideosOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyEccAlgo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyEntity.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyEntityCollection.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyRole.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyRsaAlgo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccountEncryption.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccountEncryptionKeyType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ActionType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AudioEncoderAac.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AudioEncoderBase.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AuthenticationBase.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CertificateSource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CheckNameAvailabilityReason.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CheckNameAvailabilityRequest.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CheckNameAvailabilityResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CreatedByType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CredentialsBase.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EccTokenKey.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EdgeModuleEntity.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EdgeModuleEntityCollection.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EdgeModuleProvisioningToken.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderCustomPreset.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderPresetBase.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderProcessor.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderSystemPreset.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderSystemPresetType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Endpoint.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EndpointBase.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ErrorAdditionalInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ErrorDetail.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.GroupLevelAccessControl.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.IotHub.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.JwtAuthentication.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.KeyVaultProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Kind.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ListProvisioningTokenInput.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipeline.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineCollection.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineOperationStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineUpdate.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LogSpecification.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.MetricAggregationType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.MetricDimension.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.MetricSpecification.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.MetricUnit.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.NetworkAccessControl.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.NodeBase.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.NodeInput.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Operation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.OperationCollection.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.OperationDisplay.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ParameterDeclaration.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ParameterDefinition.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ParameterType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PemCertificateList.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJob.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobCollection.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobError.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobOperationStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobUpdate.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopology.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopologyCollection.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopologyUpdate.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpoint.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointConnection.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionProvisioningState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointServiceConnectionStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkResourceListResult.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkServiceConnectionState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ProcessorNodeBase.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Properties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ProvisioningState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ProxyResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PublicNetworkAccess.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Resource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ResourceIdentity.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.RsaTokenKey.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.RtspSource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.RtspTransport.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SecureIotDeviceRemoteTunnel.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ServiceSpecification.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SinkNodeBase.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Sku.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SkuName.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SkuTier.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SourceNodeBase.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.StorageAccount.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SystemData.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TimeSequenceBase.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TlsEndpoint.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TlsValidationOptions.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TokenClaim.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TokenKey.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TrackedResource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TunnelBase.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.UnsecuredEndpoint.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.UserAssignedManagedIdentity.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.UsernamePasswordCredentials.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzer.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerCollection.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerEndpointType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerIdentity.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerOperationStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerPrivateEndpointConnectionOperationStatus.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerUpdate.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoArchival.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoContentToken.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoContentUrls.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoCreationProperties.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEncoderBase.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEncoderH264.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEntity.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEntityCollection.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoFlags.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoMediaInfo.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoPreviewImageUrls.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoPublishingOptions.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoScale.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoScaleMode.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoSequenceAbsoluteTimeMarkers.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoSink.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoSource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoType.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.AccessPoliciesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.EdgeModulesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.LivePipelineOperationStatusesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.LivePipelinesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.LocationsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.OperationResultsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.OperationStatusesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.PipelineJobOperationStatusesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.PipelineJobsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.PipelineTopologiesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.PrivateEndpointConnectionsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.PrivateLinkResourcesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.VideoAnalyzerOperationResultsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.VideoAnalyzerOperationStatusesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.VideoAnalyzersOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.VideosOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.WorkloadMonitorAPI.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.WorkloadMonitorAPI.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.operations.HealthMonitorsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorDetails.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorResponseError.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitor.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorList.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorStateChange.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorStateChangeList.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthState.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.Operation.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.OperationDisplay.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.OperationList.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.Resource.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.operations.HealthMonitorsOperations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.operations.Operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.operations.yml create mode 100644 previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.yml create mode 100644 previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.PurviewCatalogClient.yml create mode 100644 previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.PurviewCatalogClient.yml create mode 100644 previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.CollectionOperations.yml create mode 100644 previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.DiscoveryOperations.yml create mode 100644 previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.EntityOperations.yml create mode 100644 previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.GlossaryOperations.yml create mode 100644 previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.LineageOperations.yml create mode 100644 previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.RelationshipOperations.yml create mode 100644 previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.TypesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.yml create mode 100644 previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.yml create mode 100644 previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.CollectionOperations.yml create mode 100644 previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.DiscoveryOperations.yml create mode 100644 previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.EntityOperations.yml create mode 100644 previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.GlossaryOperations.yml create mode 100644 previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.LineageOperations.yml create mode 100644 previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.RelationshipOperations.yml create mode 100644 previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.TypesOperations.yml create mode 100644 previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.yml create mode 100644 previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.constants.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AdditionalUnattendContent.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AffinityGroup.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AffinityGroups.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AsynchronousOperationResult.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AttachedTo.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AuthorizationRule.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AuthorizationRules.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AvailabilityResponse.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AzureAsyncOperationHttpError.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CaptureRoleAsVMImage.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Certificate.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CertificateSetting.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Certificates.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CloudService.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CloudServices.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ComponentSetting.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ComponentSettings.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Components.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ComputeCapabilities.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ConfigurationSet.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ConfigurationSetInputEndpoint.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ConfigurationSetInputEndpoints.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ConfigurationSets.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CountDetails.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CreateServerResponse.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Credentials.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Data.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DataDiskConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DataDiskConfigurations.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DataVirtualHardDisk.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DataVirtualHardDisks.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Database.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Deployment.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Deployments.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Disk.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Disks.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DnsServer.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DomainJoin.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.EventLog.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.FirewallRule.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.HostNameSslState.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.HostNameSslStates.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.HostedService.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.HostedServiceProperties.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.HostedServices.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Images.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.InputEndpoint.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.InputEndpoints.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.InstanceEndpoint.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.InstanceEndpoints.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.IntrinsicSettings.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.KeyPair.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.KeyPairs.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.LinuxConfigurationSet.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Listener.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Listeners.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.LoadBalancerProbe.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Location.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Locations.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MaxRecurrence.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricAvailabilities.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricAvailability.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricDefinition.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricDefinitions.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricProperties.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricResponse.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricResponses.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricRollups.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricSample.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricValues.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.NotificationHubDescription.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OSDiskConfiguration.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OSImage.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OSImageDetails.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OSVirtualHardDisk.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperatingSystem.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperatingSystemFamilies.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperatingSystemFamily.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperatingSystems.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Operation.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperationCaller.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperationError.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperationStatus.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Passes.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PersistentVMDowntimeInfo.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PersistentVMRole.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublicIP.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublicIPs.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublicKey.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublicKeys.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublishData.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublishProfile.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.QueueDescription.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Quota.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RelayDescription.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ReplicationProgress.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ReplicationProgressElement.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ReservedIP.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ReservedIPs.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Resource.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtension.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtensionParameterValue.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtensionParameterValues.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtensionReference.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtensionReferences.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtensions.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Resources.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Role.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RoleInstance.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RoleInstanceList.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RoleList.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RoleSize.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RoleSizes.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SSH.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Server.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ServerQuota.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Servers.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ServiceBusNamespace.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ServiceBusRegion.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ServiceObjective.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Site.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Sites.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.StorageAccountProperties.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.StorageService.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.StorageServiceKeys.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.StorageServices.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.StoredCertificateSettings.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Subnet.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Subnets.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Subscription.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionCertificate.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionCertificates.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionOperation.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionOperationCollection.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionOperationStatus.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionOperations.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Subscriptions.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.TopicDescription.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.UnattendComponent.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.UnattendPass.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.UpgradeStatus.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VMImage.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VMImages.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Values.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VirtualIP.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VirtualIPs.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VirtualNetworkSite.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VirtualNetworkSites.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.WebSpace.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.WebSpaces.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.WinRM.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.WindowsConfigurationSet.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.publishsettings.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.schedulermanagementservice.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.servicebusmanagementservice.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.servicemanagementclient.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.servicemanagementservice.ServiceManagementService.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.servicemanagementservice.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.sqldatabasemanagementservice.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.websitemanagementservice.WebsiteManagementService.yml create mode 100644 previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.websitemanagementservice.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.appendblobservice.AppendBlobService.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.appendblobservice.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.baseblobservice.BaseBlobService.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.baseblobservice.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.blockblobservice.BlockBlobService.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.blockblobservice.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.AccountInformation.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.AppendBlockProperties.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BatchDeleteSubRequest.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BatchSetBlobTierSubRequest.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BatchSubResponse.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.Blob.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobBlock.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobBlockList.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobBlockState.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobPermissions.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobPrefix.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobProperties.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlockListType.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.Container.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.ContainerPermissions.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.ContainerProperties.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.ContentSettings.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.CopyProperties.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.CustomerProvidedEncryptionKey.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.DeleteSnapshot.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.Include.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.LeaseProperties.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.PageBlobProperties.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.PageRange.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.PremiumPageBlobTier.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.PublicAccess.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.RehydratePriority.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.ResourceProperties.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.SequenceNumberAction.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.StandardBlobTier.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.UserDelegationKey.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.pageblobservice.PageBlobService.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.pageblobservice.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.sharedaccesssignature.BlobSharedAccessSignature.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.sharedaccesssignature.yml create mode 100644 previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.cloudstorageaccount.CloudStorageAccount.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.cloudstorageaccount.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.AccessPolicy.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.AccountPermissions.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.CorsRule.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.DeleteRetentionPolicy.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.GeoReplication.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.ListGenerator.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.LocationMode.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.Logging.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.Metrics.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.Protocol.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.ResourceTypes.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.RetentionPolicy.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.RetryContext.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.ServiceProperties.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.ServiceStats.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.Services.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.StaticWebsite.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.retry.ExponentialRetry.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.retry.LinearRetry.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.retry.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.sharedaccesssignature.SharedAccessSignature.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.sharedaccesssignature.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.storageclient.StorageClient.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.storageclient.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.tokencredential.TokenCredential.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.tokencredential.yml create mode 100644 previous/docs-ref-autogen/azure-storage-common/azure.storage.common.yml create mode 100644 previous/docs-ref-autogen/azure-storage-file/azure.storage.file.fileservice.FileService.yml create mode 100644 previous/docs-ref-autogen/azure-storage-file/azure.storage.file.fileservice.yml create mode 100644 previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.ContentSettings.yml create mode 100644 previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.CopyProperties.yml create mode 100644 previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.DeleteSnapshot.yml create mode 100644 previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.Directory.yml create mode 100644 previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.DirectoryProperties.yml create mode 100644 previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.File.yml create mode 100644 previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.FilePermissions.yml create mode 100644 previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.FileProperties.yml create mode 100644 previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.FileRange.yml create mode 100644 previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.Handle.yml create mode 100644 previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.LeaseProperties.yml create mode 100644 previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.NTFSAttributes.yml create mode 100644 previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.SMBProperties.yml create mode 100644 previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.Share.yml create mode 100644 previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.SharePermissions.yml create mode 100644 previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.ShareProperties.yml create mode 100644 previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.yml create mode 100644 previous/docs-ref-autogen/azure-storage-file/azure.storage.file.sharedaccesssignature.FileSharedAccessSignature.yml create mode 100644 previous/docs-ref-autogen/azure-storage-file/azure.storage.file.sharedaccesssignature.yml create mode 100644 previous/docs-ref-autogen/azure-storage-file/azure.storage.file.yml create mode 100644 previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.models.Queue.yml create mode 100644 previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.models.QueueMessage.yml create mode 100644 previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.models.QueueMessageFormat.yml create mode 100644 previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.models.QueuePermissions.yml create mode 100644 previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.models.yml create mode 100644 previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.queueservice.QueueService.yml create mode 100644 previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.queueservice.yml create mode 100644 previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.sharedaccesssignature.QueueSharedAccessSignature.yml create mode 100644 previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.sharedaccesssignature.yml create mode 100644 previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.SynapseClient.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.AccessControlClient.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.AccessControlClient.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.operations_async.AccessControlOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.operations_async.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorContract.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorDetail.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentDetails.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentOptions.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RolesListResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.SynapseRole.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.operations.AccessControlOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.operations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.SynapseClient.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.operations_async.MonitoringOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.operations_async.SparkBatchOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.operations_async.SparkSessionOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.operations_async.WorkspaceAclOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.operations_async.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.ArtifactsClient.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.ArtifactsClient.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.DataFlowDebugSessionOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.DataFlowOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.DatasetOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.LinkedServiceOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.NotebookOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.PipelineOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.PipelineRunOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.SparkJobDefinitionOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.SqlScriptOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.TriggerOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.TriggerRunOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Activity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityDependency.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityPolicy.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRun.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRunsQueryResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonS3LinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AppendVariableActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroCompressionCodec.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBatchLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobStorageLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerCommandActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFileStorageLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionActivityMethod.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultSecretReference.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLBatchExecutionActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLExecutePipelineActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLServiceLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLUpdateResourceActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLWebServiceFile.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchIndexDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMILinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMITableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureStorageLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableStorageLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BigDataPoolReference.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BinaryDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CellOutputType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CloudError.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ControlActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopyActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySink.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySource.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateRunResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivityReferenceObject.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomDataSourceLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlow.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowComputeType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandRequest.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackage.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugQueryResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResource.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResultResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugSessionInfo.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowFolder.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowListResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowReference.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowResource.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSink.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSource.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSourceSetting.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowStagingInfo.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksNotebookActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkJarActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkPythonActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Dataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetBZip2Compression.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetCompression.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetCompressionLevel.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDebugResource.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDeflateCompression.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetFolder.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetGZipCompression.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetListResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetLocation.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetReference.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetResource.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetZipDeflateCompression.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2LinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2TableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextCompressionCodec.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DependencyCondition.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DocumentDbCollectionDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXResourceDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmEntityDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsDeploymentType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsEntityDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsServicePrincipalCredentialType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EventSubscriptionStatus.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutePipelineActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteSSISPackageActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutionActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExposureControlRequest.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExposureControlResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Expression.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileServerLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FilterActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ForEachActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpAuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpServerLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetMetadataActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetSsisObjectMetadataRequest.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsAuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryAuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleCloudStorageLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseAuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightHiveActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightMapReduceActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightOnDemandLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightPigActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightSparkActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightStreamingActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdfsLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdiNodeTypes.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveAuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveServerType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveThriftTransportProtocol.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpAuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IfConditionActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaAuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeReference.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceDebugResource.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceListResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceReference.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceResource.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LogStorageSettings.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LookupActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MappingDataFlow.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbAuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbCollectionDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2CollectionDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2LinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MultiplePipelineTrigger.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Notebook.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCell.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCellOutputItem.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookKernelSpec.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookLanguageInfo.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookListResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookMetadata.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookResource.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookSessionProperties.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataAadServicePrincipalCredentialType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataAuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataResourceDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365Dataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365LinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcCompressionCodec.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParameterSpecification.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParameterType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetCompressionCodec.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixAuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineFolder.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineListResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineReference.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineResource.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRun.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRunInvokedBy.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRunsQueryResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PluginCurrentState.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoAuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RedirectIncompatibleRowSettings.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RelationalTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTriggerListResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTriggerResource.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTumblingWindowTrigger.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTumblingWindowTriggerActionParameters.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Resource.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestResourceDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestServiceAuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestServiceLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunFilterParameters.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilter.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilterOperand.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilterOperator.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrder.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrderBy.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrderByField.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISAccessCredential.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISChildPackage.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISExecutionCredential.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISExecutionParameter.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISLogLocation.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPackageLocation.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPropertyOverride.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBWLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBwCubeDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccResourceDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaAuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableResourceDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SchedulerCurrentState.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptAction.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SecretBase.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SecureString.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowAuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SetVariableActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpAuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpServerLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkAuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJob.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJobResultType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJobState.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkErrorSource.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinition.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinitionResource.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinitionsListResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobProperties.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkRequest.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkScheduler.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServerType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServiceError.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServicePlugin.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkThriftTransportProtocol.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlConnection.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlConnectionType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScript.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptContent.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptMetadata.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptResource.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptsListResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerStoredProcedureActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SsisPackageLocationType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StagingSettings.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoredProcedureParameter.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoredProcedureParameterType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SubResource.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SubResourceDebugResource.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchCase.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseAuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataAuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Transformation.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Trigger.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerListResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerPipelineReference.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerResource.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRun.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRunStatus.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRunsQueryResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRuntimeState.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.UntilActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.UserProperty.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ValidationActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VariableSpecification.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VariableType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WaitActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivityAuthentication.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivityMethod.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebAnonymousAuthentication.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebAuthenticationType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebBasicAuthentication.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebClientCertificateAuthentication.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebHookActivity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebLinkedServiceTypeProperties.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebTableDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Workspace.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceIdentity.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceUpdateParameters.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoLinkedService.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoObjectDataset.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DataFlowDebugSessionOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DataFlowOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DatasetOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.LinkedServiceOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.NotebookOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.PipelineOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.PipelineRunOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.SparkJobDefinitionOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.SqlScriptOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.TriggerOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.TriggerRunOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Config.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Data.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Edge.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorDetail.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorInformation.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorResponseException.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorSource.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Executors.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyBatchRequest.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyBatchResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyListBatchResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyListSessionResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivySessionRequest.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivySessionResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.GetAccessControlInfoRequest.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDataResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDiagnosticResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDiagnosticResponseData.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerGraphResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerGraphResponseData.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerPropertiesResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.JobResult.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.JobType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Jobs.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyBatchStateInformation.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyRequestBase.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivySessionStateInformation.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementCancellationResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementOutput.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementRequestBody.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementResponseBody.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementsResponseBody.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Option.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.PluginCurrentState.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SchedulerCurrentState.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SchedulerInformation.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SetWorkspaceAdministratorsRequest.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkJob.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkJobListViewResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkServicePluginInformation.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Stages.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Tables.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.WorkspaceAccessControlResponse.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.models.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.operations.MonitoringOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.operations.SparkBatchOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.operations.SparkSessionOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.operations.WorkspaceAclOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.operations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.SparkClient.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.SparkClient.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.operations_async.SparkBatchOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.operations_async.SparkSessionOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.operations_async.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.PluginCurrentState.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SchedulerCurrentState.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJob.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobCollection.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobOptions.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobResultType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobState.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkErrorSource.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkJobType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkRequest.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkScheduler.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkServiceError.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkServicePlugin.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSession.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionCollection.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionOptions.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionResultType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionState.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatement.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementCancellationResult.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementCollection.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementLanguageType.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementOptions.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementOutput.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.operations.SparkBatchOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.operations.SparkSessionOperations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.operations.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.yml create mode 100644 previous/docs-ref-autogen/azure-synapse/azure.synapse.yml diff --git a/docs-ref-mapping/reference-previous.yml b/docs-ref-mapping/reference-previous.yml new file mode 100644 index 00000000..0d17b235 --- /dev/null +++ b/docs-ref-mapping/reference-previous.yml @@ -0,0 +1,275 @@ +- name: Reference + landingPageType: Root + expanded: false + items: + - name: AgriFood + href: ~/docs-ref-services/legacy/agrifood.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Agrifood (deprecated) + href: ~/docs-ref-services/legacy/mgmt-agfood-readme.md + children: + - azure.mgmt.agfood + - name: Application Insights + href: ~/docs-ref-services/legacy/application-insights.md + landingPageType: Service + items: + - name: Application Insights - Query (deprecated) + href: ~/docs-ref-services/legacy/applicationinsights-readme.md + children: + - azure.applicationinsights + - name: Azure AD B2C + href: ~/docs-ref-services/legacy/azure-ad-b2c.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Azure AD B2C (deprecated) + href: ~/docs-ref-services/legacy/mgmt-azureadb2c-readme.md + children: + - azure.mgmt.azureadb2c + - name: Batch AI + href: ~/docs-ref-services/legacy/batch-ai.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Batch AI (deprecated) + href: ~/docs-ref-services/legacy/mgmt-batchai-readme.md + children: + - azure.mgmt.batchai + - name: Cognitive Services + href: ~/docs-ref-services/legacy/cognitive-services.md + landingPageType: Service + items: + - name: Azure AI Vision SDK (deprecated) + children: + - azure.ai.vision + landingPageType: Service + - name: Anomaly Detector (deprecated) + href: ~/docs-ref-services/legacy/cognitiveservices-anomalydetector-readme.md + children: + - azure.cognitiveservices.anomalydetector + - name: Question Answering (deprecated) + href: ~/docs-ref-services/legacy/cognitiveservices-knowledge-qnamaker-readme.md + children: + - azure.cognitiveservices.knowledge.qnamaker + - name: Conversational Language Understanding (deprecated) + href: ~/docs-ref-services/legacy/cognitiveservices-language-luis-readme.md + children: + - azure.cognitiveservices.language.luis + - name: Spell Check (deprecated) + href: ~/docs-ref-services/legacy/cognitiveservices-language-spellcheck-readme.md + children: + - azure.cognitiveservices.language.spellcheck + - name: Text Analytics (deprecated) + href: ~/docs-ref-services/legacy/cognitiveservices-language-textanalytics-readme.md + children: + - azure.cognitiveservices.language.textanalytics + - name: Computer Vision (deprecated) + href: ~/docs-ref-services/legacy/cognitiveservices-vision-computervision-readme.md + children: + - azure.cognitiveservices.vision.computervision + - name: Content Safety (deprecated) + href: ~/docs-ref-services/legacy/cognitiveservices-vision-contentmoderator-readme.md + children: + - azure.cognitiveservices.vision.contentmoderator + - name: Custom Vision (deprecated) + href: ~/docs-ref-services/legacy/cognitiveservices-vision-customvision-readme.md + children: + - azure.cognitiveservices.vision.customvision + - name: Communication + href: ~/docs-ref-services/legacy/communication.md + landingPageType: Service + items: + - name: Communication Network Traversal (deprecated) + href: ~/docs-ref-services/legacy/communication-networktraversal-readme.md + children: + - azure.communication.networktraversal + - name: Cosmos DB + href: ~/docs-ref-services/legacy/cosmos-db.md + landingPageType: Service + items: + - name: Cosmos DB + href: ~/docs-ref-services/legacy/cosmos-readme.md + children: + - azure.cosmos + - name: Face + href: ~/docs-ref-services/legacy/face.md + landingPageType: Service + items: + - name: Face (deprecated) + href: ~/docs-ref-services/legacy/cognitiveservices-vision-face-readme.md + children: + - azure.cognitiveservices.vision.face + - name: Graph RBAC + href: ~/docs-ref-services/legacy/graph-rbac.md + landingPageType: Service + items: + - name: Graph RBAC (deprecated) + href: ~/docs-ref-services/legacy/graphrbac-readme.md + children: + - azure.graphrbac + - name: IoT + href: ~/docs-ref-services/legacy/iot.md + landingPageType: Service + items: + - name: Models Repository (deprecated) + href: ~/docs-ref-services/legacy/iot-modelsrepository-readme.md + children: + - azure.iot.modelsrepository + - name: Key Vault + href: ~/docs-ref-services/legacy/key-vault.md + landingPageType: Service + items: + - name: Key Vault + children: + - azure.keyvault + landingPageType: Service + - name: Log Analytics + href: ~/docs-ref-services/legacy/log-analytics.md + landingPageType: Service + items: + - name: Log Analytics - Query (deprecated) + href: ~/docs-ref-services/legacy/loganalytics-readme.md + children: + - azure.loganalytics + - name: Logz + href: ~/docs-ref-services/legacy/logz.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Logz (deprecated) + href: ~/docs-ref-services/legacy/mgmt-logz-readme.md + children: + - azure.mgmt.logz + - name: Metrics Advisor + href: ~/docs-ref-services/legacy/metrics-advisor.md + landingPageType: Service + items: + - name: Metrics Advisor (deprecated) + href: ~/docs-ref-services/legacy/ai-metricsadvisor-readme.md + children: + - azure.ai.metricsadvisor + - name: Network Analytics + href: ~/docs-ref-services/legacy/network-analytics.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Network Analytics (deprecated) + href: ~/docs-ref-services/legacy/mgmt-networkanalytics-readme.md + children: + - azure.mgmt.networkanalytics + - name: News Search + href: ~/docs-ref-services/legacy/news-search.md + landingPageType: Service + items: + - name: News Search (deprecated) + href: ~/docs-ref-services/legacy/cognitiveservices-search-newssearch-readme.md + children: + - azure.cognitiveservices.search.newssearch + - name: Purview + href: ~/docs-ref-services/legacy/purview.md + landingPageType: Service + items: + - name: Purview Catalog (deprecated) + href: ~/docs-ref-services/legacy/purview-catalog-readme.md + children: + - azure.purview.catalog + - name: Scheduler + href: ~/docs-ref-services/legacy/scheduler.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Scheduler (deprecated) + href: ~/docs-ref-services/legacy/mgmt-scheduler-readme.md + children: + - azure.mgmt.scheduler + - name: Stack Edge + href: ~/docs-ref-services/legacy/stack-edge.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Edge Gateway (deprecated) + children: + - azure.mgmt.edgegateway + landingPageType: Service + - name: Storage + href: ~/docs-ref-services/legacy/storage.md + landingPageType: Service + items: + - name: Storage - Blobs + href: ~/docs-ref-services/legacy/storage-blob-readme.md + children: + - azure.storage.blob + - name: Storage - Queues + href: ~/docs-ref-services/legacy/storage-queue-readme.md + children: + - azure.storage.queue + - name: Management + items: + - name: Resource Management - Storage Import/Export (deprecated) + href: ~/docs-ref-services/legacy/mgmt-storageimportexport-readme.md + children: + - azure.mgmt.storageimportexport + - name: Synapse + href: ~/docs-ref-services/legacy/synapse.md + landingPageType: Service + items: + - name: Synapse (deprecated) + href: ~/docs-ref-services/legacy/synapse-readme.md + children: + - azure.synapse + - name: Test Base + href: ~/docs-ref-services/legacy/test-base.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Test Base (deprecated) + href: ~/docs-ref-services/legacy/mgmt-testbase-readme.md + children: + - azure.mgmt.testbase + - name: Video Analyzer + href: ~/docs-ref-services/legacy/video-analyzer.md + landingPageType: Service + items: + - name: Video Analyzer Edge (deprecated) + href: ~/docs-ref-services/legacy/media-videoanalyzer-edge-readme.md + children: + - azure.media.videoanalyzeredge + - name: Visual Search + href: ~/docs-ref-services/legacy/visual-search.md + landingPageType: Service + items: + - name: Visual Search (deprecated) + href: ~/docs-ref-services/legacy/cognitiveservices-search-visualsearch-readme.md + children: + - azure.cognitiveservices.search.visualsearch + - name: Workload Monitor + href: ~/docs-ref-services/legacy/workload-monitor.md + landingPageType: Service + items: + - name: Management + items: + - name: Resource Management - Workload Monitor (deprecated) + href: ~/docs-ref-services/legacy/mgmt-workloadmonitor-readme.md + children: + - azure.mgmt.workloadmonitor + - name: Other + landingPageType: Service + items: + - name: Common (deprecated) + href: ~/docs-ref-services/legacy/common-readme.md + children: + - azure.common + - name: Uncategorized Packages + landingPageType: Service + children: + - '**' diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.yml new file mode 100644 index 00000000..1e501306 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.yml @@ -0,0 +1,1577 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient +name: MetricsAdvisorAdministrationClient +fullName: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient +module: azure.ai.metricsadvisor +summary: MetricsAdvisorAdministrationClient is used to create and manage data feeds. +constructor: + syntax: 'MetricsAdvisorAdministrationClient(endpoint: str, credential: MetricsAdvisorKeyCredential + | TokenCredential, **kwargs: Any)' + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and hostname, + + for example: [https://](https://)``.cognitiveservices.azure.com).' + isRequired: true + types: + - + - name: credential + description: 'An instance of ~azure.ai.metricsadvisor.MetricsAdvisorKeyCredential. + + which requires both subscription key and API key. Or an object which can provide + an access + + token for the Metrics Advisor service, such as a credential from ' + isRequired: true + types: + - + - +examples: +- "Authenticate MetricsAdvisorAdministrationClient with a MetricsAdvisorKeyCredential\n\n\n\n````python\n\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\n service_endpoint\ + \ = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key = os.getenv(\"\ + METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"METRICS_ADVISOR_API_KEY\"\ + )\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\ + \n ````\n" +methods: +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.close + name: close + summary: Close the + session. + signature: close() -> None +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.create_alert_configuration + name: create_alert_configuration + summary: Create an anomaly alert configuration. + signature: 'create_alert_configuration(name: str, metric_alert_configurations: List[MetricAlertConfiguration], + hook_ids: List[str], **kwargs: Any) -> AnomalyAlertConfiguration' + parameters: + - name: name + description: Name for the anomaly alert configuration. + isRequired: true + types: + - + - name: metric_alert_configurations + description: Anomaly alert configurations. + isRequired: true + types: + - [] + - name: hook_ids + description: Unique hook IDs. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: cross_metrics_operator + description: 'Cross metrics operator should be specified when setting up multiple + metric + + alert configurations. Possible values include: "AND", "OR", "XOR".' + types: + - + - + - name: description + description: Anomaly alert configuration description. + types: + - + return: + description: AnomalyAlertConfiguration + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Create an anomaly alert configuration\n\n\n\n````python\n\ + \n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\ + \ from azure.ai.metricsadvisor.models import (\n MetricAlertConfiguration,\n\ + \ MetricAnomalyAlertScope,\n TopNGroupScope,\n MetricAnomalyAlertConditions,\n\ + \ SeverityCondition,\n MetricBoundaryCondition,\n MetricAnomalyAlertSnoozeCondition,\n\ + \ )\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n detection_configuration_id = os.getenv(\"METRICS_ADVISOR_DETECTION_CONFIGURATION_ID\"\ + )\n hook_id = os.getenv(\"METRICS_ADVISOR_HOOK_ID\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n alert_config = client.create_alert_configuration(\n name=\"\ + my alert config\",\n description=\"alert config description\",\n cross_metrics_operator=\"\ + AND\",\n metric_alert_configurations=[\n MetricAlertConfiguration(\n\ + \ detection_configuration_id=detection_configuration_id,\n \ + \ alert_scope=MetricAnomalyAlertScope(\n scope_type=\"\ + WholeSeries\"\n ),\n alert_conditions=MetricAnomalyAlertConditions(\n\ + \ severity_condition=SeverityCondition(\n \ + \ min_alert_severity=\"Low\",\n max_alert_severity=\"\ + High\"\n )\n )\n ),\n MetricAlertConfiguration(\n\ + \ detection_configuration_id=detection_configuration_id,\n \ + \ alert_scope=MetricAnomalyAlertScope(\n scope_type=\"\ + TopN\",\n top_n_group_in_scope=TopNGroupScope(\n \ + \ top=10,\n period=5,\n \ + \ min_top_count=5\n )\n ),\n alert_conditions=MetricAnomalyAlertConditions(\n\ + \ metric_boundary_condition=MetricBoundaryCondition(\n \ + \ direction=\"Up\",\n upper=50\n \ + \ )\n ),\n alert_snooze_condition=MetricAnomalyAlertSnoozeCondition(\n\ + \ auto_snooze=2,\n snooze_scope=\"Metric\"\ + ,\n only_for_successive=True\n )\n ),\n\ + \ ],\n hook_ids=[hook_id]\n )\n\n return alert_config\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.create_data_feed + name: create_data_feed + summary: Create a new data feed. + signature: 'create_data_feed(name: str, source: AzureApplicationInsightsDataFeedSource + | AzureBlobDataFeedSource | AzureCosmosDbDataFeedSource | AzureDataExplorerDataFeedSource + | AzureTableDataFeedSource | AzureLogAnalyticsDataFeedSource | InfluxDbDataFeedSource + | MySqlDataFeedSource | PostgreSqlDataFeedSource | SqlServerDataFeedSource | MongoDbDataFeedSource + | AzureDataLakeStorageGen2DataFeedSource | AzureEventHubsDataFeedSource, granularity: + str | DataFeedGranularityType | DataFeedGranularity, schema: List[str] | DataFeedSchema, + ingestion_settings: datetime | DataFeedIngestionSettings, **kwargs: Any) -> DataFeed' + parameters: + - name: name + description: Name for the data feed. + isRequired: true + types: + - + - name: source + description: The source of the data feed + isRequired: true + types: + - [, + , , + , , + , , + , , + , , + , ] + - name: granularity + description: Granularity type. If using custom granularity, you must instantiate + a DataFeedGranularity. + isRequired: true + types: + - [, , + ] + - name: schema + description: 'Data feed schema. Can be passed as a list of metric names as strings + or as a DataFeedSchema + + object if additional configuration is needed.' + isRequired: true + types: + - [[], ] + - name: ingestion_settings + description: 'The data feed ingestions settings. Can be passed as a datetime to + use for the + + ingestion begin time or as a DataFeedIngestionSettings object if additional + configuration is needed.' + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: admins + description: Data feed administrators. + types: + - [] + - name: data_feed_description + description: Data feed description. + types: + - + - name: missing_data_point_fill_settings + description: The fill missing point type and value. + types: + - + - name: rollup_settings + description: The rollup settings. + types: + - + - name: viewers + description: Data feed viewers. + types: + - [] + - name: access_mode + description: 'Data feed access mode. Possible values include: + + "Private", "Public". Default value: "Private".' + types: + - + - + - name: action_link_template + description: action link for alert. + types: + - + return: + description: DataFeed + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Create a data feed\n\n\ + \n\n````python\n\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential,\ + \ MetricsAdvisorAdministrationClient\n from azure.ai.metricsadvisor.models import\ + \ (\n SqlServerDataFeedSource,\n DataFeedSchema,\n DataFeedMetric,\n\ + \ DataFeedDimension,\n DataFeedRollupSettings,\n DataFeedMissingDataPointFillSettings,\n\ + \ )\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n sql_server_connection_string = os.getenv(\"METRICS_ADVISOR_SQL_SERVER_CONNECTION_STRING\"\ + )\n query = os.getenv(\"METRICS_ADVISOR_SQL_SERVER_QUERY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n data_feed = client.create_data_feed(\n name=\"My data\ + \ feed\",\n source=SqlServerDataFeedSource(\n connection_string=sql_server_connection_string,\n\ + \ query=query,\n ),\n granularity=\"Daily\",\n schema=DataFeedSchema(\n\ + \ metrics=[\n DataFeedMetric(name=\"cost\", display_name=\"\ + Cost\"),\n DataFeedMetric(name=\"revenue\", display_name=\"Revenue\"\ + )\n ],\n dimensions=[\n DataFeedDimension(name=\"\ + category\", display_name=\"Category\"),\n DataFeedDimension(name=\"\ + region\", display_name=\"region\")\n ],\n timestamp_column=\"\ + Timestamp\"\n ),\n ingestion_settings=datetime.datetime(2019, 10,\ + \ 1),\n data_feed_description=\"cost/revenue data feed\",\n rollup_settings=DataFeedRollupSettings(\n\ + \ rollup_type=\"AutoRollup\",\n rollup_method=\"Sum\",\n \ + \ rollup_identification_value=\"__CUSTOM_SUM__\"\n ),\n missing_data_point_fill_settings=DataFeedMissingDataPointFillSettings(\n\ + \ fill_type=\"SmartFilling\"\n ),\n access_mode=\"Private\"\ + \n )\n\n return data_feed\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.create_datasource_credential + name: create_datasource_credential + summary: Create a new datasource credential. + signature: 'create_datasource_credential(datasource_credential: DatasourceSqlConnectionString + | DatasourceDataLakeGen2SharedKey | DatasourceServicePrincipal | DatasourceServicePrincipalInKeyVault, + **kwargs: Any) -> DatasourceSqlConnectionString | DatasourceDataLakeGen2SharedKey + | DatasourceServicePrincipal | DatasourceServicePrincipalInKeyVault' + parameters: + - name: datasource_credential + description: The datasource credential to create + isRequired: true + types: + - [, + , , + ] + return: + description: The created datasource credential + types: + - [, + , , + ] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Create a datasource credential\n\n\n\n````python\n\ + \n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\ + \ from azure.ai.metricsadvisor.models import DatasourceSqlConnectionString\n\ + \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n connection_string = os.getenv(\"SQL_SERVER_CONNECTION_STRING\"\ + )\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\ + \n credential = client.create_datasource_credential(\n datasource_credential=DatasourceSqlConnectionString(\n\ + \ name=\"sql datasource credential\",\n connection_string=connection_string,\n\ + \ description=\"my datasource credential\",\n )\n )\n\n return\ + \ credential\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.create_detection_configuration + name: create_detection_configuration + summary: Create anomaly detection configuration. + signature: 'create_detection_configuration(name: str, metric_id: str, whole_series_detection_condition: + MetricDetectionCondition, **kwargs: Any) -> AnomalyDetectionConfiguration' + parameters: + - name: name + description: The name for the anomaly detection configuration + isRequired: true + types: + - + - name: metric_id + description: Required. metric unique id. + isRequired: true + types: + - + - name: whole_series_detection_condition + description: 'Required. + + Conditions to detect anomalies in all time series of a metric.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: description + description: anomaly detection configuration description. + types: + - + - name: series_group_detection_conditions + description: detection configuration for series group. + types: + - [] + - name: series_detection_conditions + description: detection configuration for specific series. + types: + - [] + return: + description: AnomalyDetectionConfiguration + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Create an anomaly detection configuration\n\n\n\n````python\n\ + \n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\ + \ from azure.ai.metricsadvisor.models import (\n ChangeThresholdCondition,\n\ + \ HardThresholdCondition,\n SmartDetectionCondition,\n SuppressCondition,\n\ + \ MetricDetectionCondition,\n )\n\n service_endpoint = os.getenv(\"\ + METRICS_ADVISOR_ENDPOINT\")\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\"\ + )\n api_key = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n metric_id = os.getenv(\"\ + METRICS_ADVISOR_METRIC_ID\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n change_threshold_condition = ChangeThresholdCondition(\n \ + \ anomaly_detector_direction=\"Both\",\n change_percentage=20,\n \ + \ shift_point=10,\n within_range=True,\n suppress_condition=SuppressCondition(\n\ + \ min_number=5,\n min_ratio=2\n )\n )\n hard_threshold_condition\ + \ = HardThresholdCondition(\n anomaly_detector_direction=\"Up\",\n \ + \ upper_bound=100,\n suppress_condition=SuppressCondition(\n \ + \ min_number=2,\n min_ratio=2\n )\n )\n smart_detection_condition\ + \ = SmartDetectionCondition(\n anomaly_detector_direction=\"Up\",\n \ + \ sensitivity=10,\n suppress_condition=SuppressCondition(\n \ + \ min_number=2,\n min_ratio=2\n )\n )\n\n detection_config\ + \ = client.create_detection_configuration(\n name=\"my_detection_config\"\ + ,\n metric_id=metric_id,\n description=\"anomaly detection config\ + \ for metric\",\n whole_series_detection_condition=MetricDetectionCondition(\n\ + \ condition_operator=\"OR\",\n change_threshold_condition=change_threshold_condition,\n\ + \ hard_threshold_condition=hard_threshold_condition,\n smart_detection_condition=smart_detection_condition\n\ + \ )\n )\n\n return detection_config\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.create_hook + name: create_hook + summary: Create a new email or web hook. + signature: 'create_hook(hook: EmailNotificationHook | WebNotificationHook, **kwargs: + Any) -> NotificationHook | EmailNotificationHook | WebNotificationHook' + parameters: + - name: hook + description: An email or web hook to create + isRequired: true + types: + - [, + ] + return: + description: EmailNotificationHook or WebNotificationHook + types: + - [, + , ] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Create a notification hook\n\ + \n\n\n````python\n\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential,\ + \ MetricsAdvisorAdministrationClient\n from azure.ai.metricsadvisor.models import\ + \ EmailNotificationHook\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n hook = client.create_hook(\n hook=EmailNotificationHook(\n\ + \ name=\"email hook\",\n description=\"my email hook\",\n\ + \ emails_to_alert=[\"alertme@alertme.com\"],\n external_link=\"\ + https://docs.microsoft.com/en-us/azure/cognitive-services/metrics-advisor/how-tos/alerts\"\ + \n )\n )\n\n return hook\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.delete_alert_configuration + name: delete_alert_configuration + summary: Delete an anomaly alert configuration by its ID. + signature: 'delete_alert_configuration(*alert_configuration_id: str, **kwargs: Any) + -> None' + parameters: + - name: alert_configuration_id + description: anomaly alert configuration unique id. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Delete an anomaly alert configuration by its ID\n\n\n\n````python\n\n from azure.core.exceptions import ResourceNotFoundError\n\ + \ from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\ + \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n client.delete_alert_configuration(alert_config_id)\n\n try:\n\ + \ client.get_alert_configuration(alert_config_id)\n except ResourceNotFoundError:\n\ + \ print(\"Alert configuration successfully deleted.\")\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.delete_data_feed + name: delete_data_feed + summary: Delete a data feed by its ID. + signature: 'delete_data_feed(*data_feed_id: str, **kwargs: Any) -> None' + parameters: + - name: data_feed_id + description: The data feed unique id. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Delete a data feed by its ID\n\n\n\n````python\n\n from azure.core.exceptions\ + \ import ResourceNotFoundError\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential,\ + \ MetricsAdvisorAdministrationClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n client.delete_data_feed(data_feed_id)\n\n try:\n client.get_data_feed(data_feed_id)\n\ + \ except ResourceNotFoundError:\n print(\"Data feed successfully deleted.\"\ + )\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.delete_datasource_credential + name: delete_datasource_credential + summary: Delete a datasource credential by its ID. + signature: 'delete_datasource_credential(*credential_id: str, **kwargs: Any) -> + None' + parameters: + - name: credential_id + description: Datasource credential unique ID. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Delete a datasource credential by its ID\n\n\n\n````python\n\ + \n from azure.core.exceptions import ResourceNotFoundError\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\n \ + \ service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n client.delete_datasource_credential(credential_id)\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.delete_detection_configuration + name: delete_detection_configuration + summary: Delete an anomaly detection configuration by its ID. + signature: 'delete_detection_configuration(*detection_configuration_id: str, **kwargs: + Any) -> None' + parameters: + - name: detection_configuration_id + description: anomaly detection configuration unique id. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Delete an anomaly detection configuration by its ID\n\n\n\n````python\n\n from azure.core.exceptions import ResourceNotFoundError\n\ + \ from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\ + \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n client.delete_detection_configuration(detection_config_id)\n\ + \n try:\n client.get_detection_configuration(detection_config_id)\n \ + \ except ResourceNotFoundError:\n print(\"Detection configuration successfully\ + \ deleted.\")\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.delete_hook + name: delete_hook + summary: Delete a web or email hook by its ID. + signature: 'delete_hook(*hook_id: str, **kwargs: Any) -> None' + parameters: + - name: hook_id + description: Hook unique ID. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Delete a hook by its ID\n\n\ + \n\n````python\n\n from azure.core.exceptions import ResourceNotFoundError\n\ + \ from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\ + \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n client.delete_hook(hook_id)\n\n try:\n client.get_hook(hook_id)\n\ + \ except ResourceNotFoundError:\n print(\"Hook successfully deleted.\"\ + )\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.get_alert_configuration + name: get_alert_configuration + summary: Get a single anomaly alert configuration. + signature: 'get_alert_configuration(alert_configuration_id: str, **kwargs: Any) + -> AnomalyAlertConfiguration' + parameters: + - name: alert_configuration_id + description: anomaly alert configuration unique id. + isRequired: true + types: + - + return: + description: AnomalyAlertConfiguration + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Get a single anomaly alert configuration by its ID\n\n\n\n````python\n\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential,\ + \ MetricsAdvisorAdministrationClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n config = client.get_alert_configuration(alert_config_id)\n\n\ + \ print(\"Alert config ID: {}\".format(config.id))\n print(\"Alert config\ + \ name: {}\".format(config.name))\n print(\"Description: {}\".format(config.description))\n\ + \ print(\"Ids of hooks associated with alert: {}\".format(config.hook_ids))\n\ + \ print(\"Use {} operator for multiple alert conditions\\n\".format(config.cross_metrics_operator))\n\ + \n print(\"Alert uses detection configuration ID: {}\".format(\n config.metric_alert_configurations[0].detection_configuration_id\n\ + \ ))\n print(\"Alert scope type: {}\".format(config.metric_alert_configurations[0].alert_scope.scope_type))\n\ + \ print(\"Alert severity condition: min- {}, max- {}\".format(\n config.metric_alert_configurations[0].alert_conditions.severity_condition.min_alert_severity,\n\ + \ config.metric_alert_configurations[0].alert_conditions.severity_condition.max_alert_severity,\n\ + \ ))\n print(\"\\nAlert uses detection configuration ID: {}\".format(\n \ + \ config.metric_alert_configurations[1].detection_configuration_id\n ))\n\ + \ print(\"Alert scope type: {}\".format(config.metric_alert_configurations[1].alert_scope.scope_type))\n\ + \ print(\"Top N: {}\".format(config.metric_alert_configurations[1].alert_scope.top_n_group_in_scope.top))\n\ + \ print(\"Point count used to look back: {}\".format(\n config.metric_alert_configurations[1].alert_scope.top_n_group_in_scope.period\n\ + \ ))\n print(\"Min top count: {}\".format(\n config.metric_alert_configurations[1].alert_scope.top_n_group_in_scope.min_top_count\n\ + \ ))\n print(\"Alert metric boundary condition direction: {}, upper bound:\ + \ {}\".format(\n config.metric_alert_configurations[1].alert_conditions.metric_boundary_condition.direction,\n\ + \ config.metric_alert_configurations[1].alert_conditions.metric_boundary_condition.upper,\n\ + \ ))\n print(\"Alert snooze condition, snooze point count: {}\".format(\n\ + \ config.metric_alert_configurations[1].alert_snooze_condition.auto_snooze,\n\ + \ ))\n print(\"Alert snooze scope: {}\".format(\n config.metric_alert_configurations[1].alert_snooze_condition.snooze_scope,\n\ + \ ))\n print(\"Snooze only for successive anomalies?: {}\".format(\n \ + \ config.metric_alert_configurations[1].alert_snooze_condition.only_for_successive,\n\ + \ ))\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.get_data_feed + name: get_data_feed + summary: Get a data feed by its id. + signature: 'get_data_feed(data_feed_id: str, **kwargs: Any) -> DataFeed' + parameters: + - name: data_feed_id + description: The data feed unique id. + isRequired: true + types: + - + return: + description: DataFeed + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Get a single data feed by its ID\n\n\n\n````python\n\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\n \ + \ service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n data_feed = client.get_data_feed(data_feed_id)\n\n print(\"\ + ID: {}\".format(data_feed.id))\n print(\"Data feed name: {}\".format(data_feed.name))\n\ + \ print(\"Created time: {}\".format(data_feed.created_time))\n print(\"Status:\ + \ {}\".format(data_feed.status))\n print(\"Source type: {}\".format(data_feed.source.data_source_type))\n\ + \ print(\"Granularity type: {}\".format(data_feed.granularity.granularity_type))\n\ + \ print(\"Data feed metrics: {}\".format([metric.name for metric in data_feed.schema.metrics]))\n\ + \ print(\"Data feed dimensions: {}\".format([dimension.name for dimension in\ + \ data_feed.schema.dimensions]))\n print(\"Data feed timestamp column: {}\"\ + .format(data_feed.schema.timestamp_column))\n print(\"Ingestion data starting\ + \ on: {}\".format(data_feed.ingestion_settings.ingestion_begin_time))\n print(\"\ + Data feed description: {}\".format(data_feed.data_feed_description))\n print(\"\ + Data feed rollup type: {}\".format(data_feed.rollup_settings.rollup_type))\n \ + \ print(\"Data feed rollup method: {}\".format(data_feed.rollup_settings.rollup_method))\n\ + \ print(\"Data feed fill setting: {}\".format(data_feed.missing_data_point_fill_settings.fill_type))\n\ + \ print(\"Data feed access mode: {}\".format(data_feed.access_mode))\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.get_data_feed_ingestion_progress + name: get_data_feed_ingestion_progress + summary: Get last successful data ingestion job timestamp by data feed. + signature: 'get_data_feed_ingestion_progress(data_feed_id: str, **kwargs: Any) -> + DataFeedIngestionProgress' + parameters: + - name: data_feed_id + description: The data feed unique id. + isRequired: true + types: + - + return: + description: 'DataFeedIngestionProgress, containing *latest_success_timestamp* + + and *latest_active_timestamp*' + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Get the progress of data feed ingestion\n\n\n\n````python\n\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\n \ + \ service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n data_feed_id = os.getenv(\"METRICS_ADVISOR_DATA_FEED_ID\"\ + )\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\ + \n progress = client.get_data_feed_ingestion_progress(data_feed_id)\n\n print(\"\ + Lastest active timestamp: {}\".format(progress.latest_active_timestamp))\n print(\"\ + Latest successful timestamp: {}\".format(progress.latest_success_timestamp))\n\ + \n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.get_datasource_credential + name: get_datasource_credential + summary: Get a datasource credential + signature: 'get_datasource_credential(credential_id: str, **kwargs: Any) -> DatasourceSqlConnectionString + | DatasourceDataLakeGen2SharedKey | DatasourceServicePrincipal | DatasourceServicePrincipalInKeyVault' + parameters: + - name: credential_id + description: Data source credential entity unique ID. + isRequired: true + types: + - + return: + description: The datasource credential + types: + - [, + , , + , ] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Get a datasource credential by its ID\n\n\n\n````python\n\ + \n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\ + \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n credential = client.get_datasource_credential(credential_id)\n\ + \n print(\"Credential type: {}\".format(credential.credential_type))\n print(\"\ + Credential name: {}\".format(credential.name))\n print(\"Description: {}\".format(credential.description))\n\ + \n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.get_detection_configuration + name: get_detection_configuration + summary: Get a single anomaly detection configuration. + signature: 'get_detection_configuration(detection_configuration_id: str, **kwargs: + Any) -> AnomalyDetectionConfiguration' + parameters: + - name: detection_configuration_id + description: anomaly detection configuration unique id. + isRequired: true + types: + - + return: + description: AnomalyDetectionConfiguration + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Get a single anomaly detection configuration by its ID\n\n\n\n````python\n\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential,\ + \ MetricsAdvisorAdministrationClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n config = client.get_detection_configuration(detection_config_id)\n\ + \n print(\"Detection config name: {}\".format(config.name))\n print(\"Description:\ + \ {}\".format(config.description))\n print(\"Metric ID: {}\".format(config.metric_id))\n\ + \n print(\"\\nDetection conditions specified for configuration...\")\n print(\"\ + \\nWhole Series Detection Conditions:\\n\")\n conditions = config.whole_series_detection_condition\n\ + \n print(\"Use {} operator for multiple detection conditions\".format(conditions.condition_operator))\n\ + \n print(\"Smart Detection Condition:\")\n print(\"- Sensitivity: {}\".format(conditions.smart_detection_condition.sensitivity))\n\ + \ print(\"- Detection direction: {}\".format(conditions.smart_detection_condition.anomaly_detector_direction))\n\ + \ print(\"- Suppress conditions: minimum number: {}; minimum ratio: {}\".format(\n\ + \ conditions.smart_detection_condition.suppress_condition.min_number,\n\ + \ conditions.smart_detection_condition.suppress_condition.min_ratio\n \ + \ ))\n\n print(\"Hard Threshold Condition:\")\n print(\"- Lower bound: {}\"\ + .format(conditions.hard_threshold_condition.lower_bound))\n print(\"- Upper\ + \ bound: {}\".format(conditions.hard_threshold_condition.upper_bound))\n print(\"\ + - Detection direction: {}\".format(conditions.smart_detection_condition.anomaly_detector_direction))\n\ + \ print(\"- Suppress conditions: minimum number: {}; minimum ratio: {}\".format(\n\ + \ conditions.smart_detection_condition.suppress_condition.min_number,\n\ + \ conditions.smart_detection_condition.suppress_condition.min_ratio\n \ + \ ))\n\n print(\"Change Threshold Condition:\")\n print(\"- Change percentage:\ + \ {}\".format(conditions.change_threshold_condition.change_percentage))\n print(\"\ + - Shift point: {}\".format(conditions.change_threshold_condition.shift_point))\n\ + \ print(\"- Detect anomaly if within range: {}\".format(conditions.change_threshold_condition.within_range))\n\ + \ print(\"- Detection direction: {}\".format(conditions.smart_detection_condition.anomaly_detector_direction))\n\ + \ print(\"- Suppress conditions: minimum number: {}; minimum ratio: {}\".format(\n\ + \ conditions.smart_detection_condition.suppress_condition.min_number,\n\ + \ conditions.smart_detection_condition.suppress_condition.min_ratio\n \ + \ ))\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.get_hook + name: get_hook + summary: Get a web or email hook by its id. + signature: 'get_hook(hook_id: str, **kwargs: Any) -> NotificationHook | EmailNotificationHook + | WebNotificationHook' + parameters: + - name: hook_id + description: Hook unique ID. + isRequired: true + types: + - + return: + description: EmailNotificationHook or WebNotificationHook + types: + - [, + , ] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Get a notification hook by its ID\n\n\n\n````python\n\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\n \ + \ service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n hook = client.get_hook(hook_id)\n\n print(\"Hook name: {}\"\ + .format(hook.name))\n print(\"Description: {}\".format(hook.description))\n\ + \ print(\"Emails to alert: {}\".format(hook.emails_to_alert))\n print(\"External\ + \ link: {}\".format(hook.external_link))\n print(\"Admins: {}\".format(hook.admins))\n\ + \n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.list_alert_configurations + name: list_alert_configurations + summary: Query all anomaly alert configurations for specific anomaly detection configuration. + signature: 'list_alert_configurations(detection_configuration_id: str, **kwargs: + Any) -> ItemPaged[AnomalyAlertConfiguration]' + parameters: + - name: detection_configuration_id + description: anomaly detection configuration unique id. + isRequired: true + types: + - + return: + description: Pageable of AnomalyAlertConfiguration + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "List all anomaly alert configurations for specific anomaly detection configuration\n\n\n\n````python\n\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential,\ + \ MetricsAdvisorAdministrationClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n detection_configuration_id = os.getenv(\"\ + METRICS_ADVISOR_DETECTION_CONFIGURATION_ID\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n configs = client.list_alert_configurations(detection_configuration_id)\n\ + \ for config in configs:\n print(\"Alert config name: {}\".format(config.name))\n\ + \ print(\"Alert description: {}\".format(config.description))\n print(\"\ + Ids of hooks associated with alert: {}\\n\".format(config.hook_ids))\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.list_data_feed_ingestion_status + name: list_data_feed_ingestion_status + summary: Get data ingestion status by data feed. + signature: 'list_data_feed_ingestion_status(data_feed_id: str, start_time: str | + datetime, end_time: str | datetime, **kwargs: Any) -> ItemPaged[DataFeedIngestionStatus]' + parameters: + - name: data_feed_id + description: The data feed unique id. + isRequired: true + types: + - + - name: start_time + description: Required. the start point of time range to query data ingestion status. + isRequired: true + types: + - [, ] + - name: end_time + description: Required. the end point of time range to query data ingestion status. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: skip + types: + - + return: + description: Pageable of DataFeedIngestionStatus + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "List the data feed ingestion statuses by data feed ID\n\n\n\n````python\n\ + \n import datetime\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential,\ + \ MetricsAdvisorAdministrationClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n data_feed_id = os.getenv(\"METRICS_ADVISOR_DATA_FEED_ID\"\ + )\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\ + \n ingestion_status = client.list_data_feed_ingestion_status(\n data_feed_id,\n\ + \ datetime.datetime(2020, 9, 20),\n datetime.datetime(2020, 9, 25)\n\ + \ )\n for status in ingestion_status:\n print(\"Timestamp: {}\".format(status.timestamp))\n\ + \ print(\"Status: {}\".format(status.status))\n print(\"Message: {}\\\ + n\".format(status.message))\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.list_data_feeds + name: list_data_feeds + summary: List all data feeds. + signature: 'list_data_feeds(**kwargs: Any) -> ItemPaged[DataFeed]' + keywordOnlyParameters: + - name: data_feed_name + description: filter data feed by its name. + types: + - + - name: data_source_type + description: filter data feed by its source type. + types: + - + - + - name: granularity_type + description: filter data feed by its granularity. + types: + - + - + - name: status + description: filter data feed by its status. + types: + - + - + - name: creator + description: filter data feed by its creator. + types: + - + - name: skip + types: + - + return: + description: Pageable of DataFeed + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "List data feeds under an account.\n\n\n\n````python\n\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\n \ + \ service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n data_feeds = client.list_data_feeds()\n\n for feed in data_feeds:\n\ + \ print(\"Data feed name: {}\".format(feed.name))\n print(\"ID: {}\"\ + .format(feed.id))\n print(\"Created time: {}\".format(feed.created_time))\n\ + \ print(\"Status: {}\".format(feed.status))\n print(\"Source type:\ + \ {}\".format(feed.source.data_source_type))\n print(\"Granularity type:\ + \ {}\".format(feed.granularity.granularity_type))\n\n print(\"\\nFeed metrics:\"\ + )\n for metric in feed.schema.metrics:\n print(metric.name)\n\n\ + \ print(\"\\nFeed dimensions:\")\n for dimension in feed.schema.dimensions:\n\ + \ print(dimension.name)\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.list_datasource_credentials + name: list_datasource_credentials + summary: List all credential entities. + signature: 'list_datasource_credentials(**kwargs: Any) -> ItemPaged[DatasourceCredential]' + keywordOnlyParameters: + - name: skip + description: for paging, skipped number. + types: + - + return: + description: Pageable containing datasource credential + types: + - [[, + , , + , ]] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "List all of the datasource credentials under the account\n\n\n\n````python\n\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential,\ + \ MetricsAdvisorAdministrationClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n credentials = client.list_datasource_credentials()\n for credential\ + \ in credentials:\n print(\"Credential type: {}\".format(credential.credential_type))\n\ + \ print(\"Credential name: {}\".format(credential.name))\n print(\"\ + Description: {}\\n\".format(credential.description))\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.list_detection_configurations + name: list_detection_configurations + summary: Query all anomaly detection configurations for specific metric. + signature: 'list_detection_configurations(metric_id: str, **kwargs: Any) -> ItemPaged[AnomalyDetectionConfiguration]' + parameters: + - name: metric_id + description: metric unique id. + isRequired: true + types: + - + return: + description: Pageable of AnomalyDetectionConfiguration + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "List all anomaly detection configurations for a specific metric\n\n\n\n````python\n\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential,\ + \ MetricsAdvisorAdministrationClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n metric_id = os.getenv(\"METRICS_ADVISOR_METRIC_ID\"\ + )\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\ + \n configs = client.list_detection_configurations(metric_id=metric_id)\n for\ + \ config in configs:\n print(\"Detection config name: {}\".format(config.name))\n\ + \ print(\"Description: {}\".format(config.description))\n print(\"\ + Metric ID: {}\\n\".format(config.metric_id))\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.list_hooks + name: list_hooks + summary: List all hooks. + signature: 'list_hooks(**kwargs: Any) -> ItemPaged[NotificationHook | EmailNotificationHook + | WebNotificationHook]' + keywordOnlyParameters: + - name: hook_name + description: filter hook by its name. + types: + - + - name: skip + types: + - + return: + description: Pageable containing EmailNotificationHook and WebNotificationHook + types: + - [[, + , ]] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "List all of the notification hooks under the account\n\n\n\n````python\n\ + \n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\ + \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n hooks = client.list_hooks()\n for hook in hooks:\n print(\"\ + Hook type: {}\".format(hook.hook_type))\n print(\"Hook name: {}\".format(hook.name))\n\ + \ print(\"Description: {}\\n\".format(hook.description))\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.refresh_data_feed_ingestion + name: refresh_data_feed_ingestion + summary: Refreshes data ingestion by data feed to backfill data. + signature: 'refresh_data_feed_ingestion(data_feed_id: str, start_time: str | datetime, + end_time: str | datetime, **kwargs: Any) -> None' + parameters: + - name: data_feed_id + description: The data feed unique id. + isRequired: true + types: + - + - name: start_time + description: The start point of time range to refresh data ingestion. + isRequired: true + types: + - [, ] + - name: end_time + description: The end point of time range to refresh data ingestion. + isRequired: true + types: + - [, ] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Refresh data feed ingestion over a period of time\n\n\n\n````python\n\ + \n import datetime\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential,\ + \ MetricsAdvisorAdministrationClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n data_feed_id = os.getenv(\"METRICS_ADVISOR_DATA_FEED_ID\"\ + )\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\ + \n client.refresh_data_feed_ingestion(\n data_feed_id,\n datetime.datetime(2020,\ + \ 9, 20),\n datetime.datetime(2020, 9, 25)\n )\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.update_alert_configuration + name: update_alert_configuration + summary: 'Update anomaly alerting configuration. Either pass the entire AnomalyAlertConfiguration + object + + with the chosen updates or the ID to your alert configuration with updates passed + via keyword arguments. + + If you pass both the AnomalyAlertConfiguration object and keyword arguments, the + keyword arguments + + will take precedence.' + signature: 'update_alert_configuration(alert_configuration: str | AnomalyAlertConfiguration, + **kwargs: Any) -> AnomalyAlertConfiguration' + parameters: + - name: alert_configuration + description: AnomalyAlertConfiguration object or the ID to the alert configuration. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: name + description: Name for the anomaly alert configuration. + types: + - + - name: metric_alert_configurations + description: Anomaly alert configurations. + types: + - [] + - name: hook_ids + description: Unique hook IDs. + types: + - [] + - name: cross_metrics_operator + description: 'Cross metrics operator should be specified when setting up multiple + metric + + alert configurations. Possible values include: "AND", "OR", "XOR".' + types: + - + - + - name: description + description: Anomaly alert configuration description. + types: + - + return: + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Update an existing anomaly alert configuration\n\n\n\n````python\n\ + \n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\ + \ from azure.ai.metricsadvisor.models import (\n MetricAlertConfiguration,\n\ + \ MetricAnomalyAlertScope,\n MetricAnomalyAlertConditions,\n \ + \ MetricBoundaryCondition\n )\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n detection_configuration_id = os.getenv(\"\ + METRICS_ADVISOR_DETECTION_CONFIGURATION_ID\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n alert_config.name = \"updated config name\"\n additional_alert\ + \ = MetricAlertConfiguration(\n detection_configuration_id=detection_configuration_id,\n\ + \ alert_scope=MetricAnomalyAlertScope(\n scope_type=\"SeriesGroup\"\ + ,\n series_group_in_scope={'region': 'Shenzhen'}\n ),\n \ + \ alert_conditions=MetricAnomalyAlertConditions(\n metric_boundary_condition=MetricBoundaryCondition(\n\ + \ direction=\"Down\",\n lower=5\n )\n \ + \ )\n )\n alert_config.metric_alert_configurations.append(additional_alert)\n\ + \n updated = client.update_alert_configuration(\n alert_config,\n \ + \ cross_metrics_operator=\"OR\",\n description=\"updated alert config\"\ + \n )\n\n print(\"Updated alert name: {}\".format(updated.name))\n print(\"\ + Updated alert description: {}\".format(updated.description))\n print(\"Updated\ + \ cross metrics operator: {}\".format(updated.cross_metrics_operator))\n print(\"\ + Updated alert condition configuration scope type: {}\".format(\n updated.metric_alert_configurations[2].alert_scope.scope_type\n\ + \ ))\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.update_data_feed + name: update_data_feed + summary: 'Update a data feed. Either pass the entire DataFeed object with the chosen + updates + + or the ID to your data feed with updates passed via keyword arguments. If you + pass both + + the DataFeed object and keyword arguments, the keyword arguments will take precedence.' + signature: 'update_data_feed(data_feed: str | DataFeed, **kwargs: Any) -> DataFeed' + parameters: + - name: data_feed + description: The data feed with updates or the data feed ID. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: name + description: The name to update the data feed. + types: + - + - name: timestamp_column + description: User-defined timestamp column name. + types: + - + - name: ingestion_begin_time + description: Ingestion start time. + types: + - + - name: data_source_request_concurrency + description: 'The max concurrency of data ingestion queries against + + user data source. Zero (0) means no limitation.' + types: + - + - name: ingestion_retry_delay + description: The min retry interval for failed data ingestion tasks, in seconds. + types: + - + - name: ingestion_start_offset + description: 'The time that the beginning of data ingestion task will delay + + for every data slice according to this offset, in seconds.' + types: + - + - name: stop_retry_after + description: 'Stop retry data ingestion after the data slice first + + schedule time in seconds.' + types: + - + - name: rollup_identification_value + description: 'The identification value for the row of calculated + + all-up value.' + types: + - + - name: rollup_type + description: 'Mark if the data feed needs rollup. Possible values include: "NoRollup", + + "AutoRollup", "AlreadyRollup". Default value: "AutoRollup".' + types: + - + - + - name: auto_rollup_group_by_column_names + description: Roll up columns. + types: + - [] + - name: rollup_method + description: 'Roll up method. Possible values include: "None", "Sum", "Max", "Min", + + "Avg", "Count".' + types: + - + - + - name: fill_type + description: 'The type of fill missing point for anomaly detection. Possible + + values include: "SmartFilling", "PreviousValue", "CustomValue", "NoFilling". + Default value: + + "SmartFilling".' + types: + - + - + - name: custom_fill_value + description: 'The value of fill missing point for anomaly detection + + if "CustomValue" fill type is specified.' + types: + - + - name: admins + description: Data feed administrators. + types: + - [] + - name: data_feed_description + description: Data feed description. + types: + - + - name: viewers + description: Data feed viewers. + types: + - [] + - name: access_mode + description: 'Data feed access mode. Possible values include: + + "Private", "Public". Default value: "Private".' + types: + - + - + - name: action_link_template + description: action link for alert. + types: + - + - name: status + description: 'Data feed status. Possible values include: "Active", "Paused".' + types: + - + - + - name: source + description: The source of the data feed for update + types: + - [, + , , + , , + , , + , , + , , + , ] + return: + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Update an existing data feed\n\n\n\n````python\n\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\n \ + \ service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n # update data feed on the data feed itself or by using available\ + \ keyword arguments\n data_feed.name = \"updated name\"\n data_feed.data_feed_description\ + \ = \"updated description for data feed\"\n\n updated = client.update_data_feed(\n\ + \ data_feed,\n access_mode=\"Public\",\n fill_type=\"CustomValue\"\ + ,\n custom_fill_value=1\n )\n print(\"Updated name: {}\".format(updated.name))\n\ + \ print(\"Updated description: {}\".format(updated.data_feed_description))\n\ + \ print(\"Updated access mode: {}\".format(updated.access_mode))\n print(\"\ + Updated fill setting, value: {}, {}\".format(\n updated.missing_data_point_fill_settings.fill_type,\n\ + \ updated.missing_data_point_fill_settings.custom_fill_value,\n ))\n\n\ + \ ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.update_datasource_credential + name: update_datasource_credential + summary: Update a datasource credential. + signature: 'update_datasource_credential(datasource_credential: DatasourceCredential, + **kwargs: Any) -> DatasourceCredential' + parameters: + - name: datasource_credential + description: The new datasource credential object + isRequired: true + types: + - [, + , , + ] + return: + description: The updated DataSourceCredential. + types: + - [, + , , + ] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Update an existing datasource credential\n\n\n\n````python\n\ + \n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\ + \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n datasource_credential.description = \"updated description\"\n\ + \n updated = client.update_datasource_credential(datasource_credential)\n \ + \ print(\"Credential type: {}\".format(updated.credential_type))\n print(\"\ + Credential name: {}\".format(updated.name))\n print(\"Description: {}\\n\".format(updated.description))\n\ + \n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.update_detection_configuration + name: update_detection_configuration + summary: 'Update anomaly metric detection configuration. Either pass the entire + AnomalyDetectionConfiguration object + + with the chosen updates or the ID to your detection configuration with updates + passed via keyword arguments. + + If you pass both the AnomalyDetectionConfiguration object and keyword arguments, + the keyword arguments + + will take precedence.' + signature: 'update_detection_configuration(detection_configuration: str | AnomalyDetectionConfiguration, + **kwargs: Any) -> AnomalyDetectionConfiguration' + parameters: + - name: detection_configuration + description: 'AnomalyDetectionConfiguration object or the ID to the detection + + configuration.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: name + description: The name for the anomaly detection configuration + types: + - + - name: metric_id + description: metric unique id. + types: + - + - name: whole_series_detection_condition + description: 'Required. + + Conditions to detect anomalies in all time series of a metric.' + types: + - + - name: description + description: anomaly detection configuration description. + types: + - + - name: series_group_detection_conditions + description: detection configuration for series group. + types: + - [] + - name: series_detection_conditions + description: detection configuration for specific series. + types: + - [] + return: + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Update an existing anomaly detection configuration\n\n\n\n````python\n\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential,\ + \ MetricsAdvisorAdministrationClient\n from azure.ai.metricsadvisor.models import\ + \ (\n MetricSeriesGroupDetectionCondition,\n MetricSingleSeriesDetectionCondition,\n\ + \ SmartDetectionCondition,\n SuppressCondition\n )\n\n service_endpoint\ + \ = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key = os.getenv(\"\ + METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"METRICS_ADVISOR_API_KEY\"\ + )\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\ + \n detection_config.name = \"updated config name\"\n detection_config.description\ + \ = \"updated with more detection conditions\"\n smart_detection_condition =\ + \ SmartDetectionCondition(\n anomaly_detector_direction=\"Up\",\n \ + \ sensitivity=10,\n suppress_condition=SuppressCondition(\n min_number=2,\n\ + \ min_ratio=2\n )\n )\n\n updated = client.update_detection_configuration(\n\ + \ detection_config,\n series_group_detection_conditions=[\n \ + \ MetricSeriesGroupDetectionCondition(\n series_group_key={\"\ + region\": \"Seoul\"},\n smart_detection_condition=smart_detection_condition\n\ + \ )\n ],\n series_detection_conditions=[\n MetricSingleSeriesDetectionCondition(\n\ + \ series_key={\"region\": \"Osaka\", \"category\": \"Cell Phones\"\ + },\n smart_detection_condition=smart_detection_condition\n \ + \ )\n ]\n )\n print(\"Updated detection name: {}\".format(updated.name))\n\ + \ print(\"Updated detection description: {}\".format(updated.description))\n\ + \ print(\"Updated detection condition for series group: {}\".format(\n \ + \ updated.series_group_detection_conditions[0].series_group_key\n ))\n print(\"\ + Updated detection condition for series: {}\".format(\n updated.series_detection_conditions[0].series_key\n\ + \ ))\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient.update_hook + name: update_hook + summary: 'Update a hook. Either pass the entire EmailNotificationHook or WebNotificationHook + object with the chosen + + updates, or the ID to your hook configuration with the updates passed via keyword + arguments. + + If you pass both the hook object and keyword arguments, the keyword arguments + will take precedence.' + signature: 'update_hook(hook: str | EmailNotificationHook | WebNotificationHook, + **kwargs: Any) -> NotificationHook | EmailNotificationHook | WebNotificationHook' + parameters: + - name: hook + description: An email or web hook or the ID to the hook. If an ID is passed, you + must pass *hook_type*. + isRequired: true + types: + - [, , + ] + keywordOnlyParameters: + - name: hook_type + description: 'The hook type. Possible values are "Email" or "Web". Must be passed + if only the + + hook ID is provided.' + types: + - + - name: name + description: Hook unique name. + types: + - + - name: description + description: Hook description. + types: + - + - name: external_link + description: Hook external link. + types: + - + - name: emails_to_alert + description: 'Email TO: list. Only should be passed to update EmailNotificationHook.' + types: + - [] + - name: endpoint + description: 'API address, will be called when alert is triggered, only support + + POST method via SSL. Only should be passed to update WebNotificationHook.' + types: + - + - name: username + description: basic authentication. Only should be passed to update WebNotificationHook. + types: + - + - name: password + description: basic authentication. Only should be passed to update WebNotificationHook. + types: + - + - name: certificate_key + description: client certificate. Only should be passed to update WebNotificationHook. + types: + - + - name: certificate_password + description: 'client certificate password. Only should be passed to update + + WebNotificationHook.' + types: + - + return: + description: The updated email or web hook. + types: + - [, + , ] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Update an existing notification hook\n\n\n\n````python\n\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\n \ + \ service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n hook.name = \"updated hook name\"\n hook.description = \"\ + updated hook description\"\n\n client.update_hook(\n hook,\n emails_to_alert=[\"\ + newemail@alertme.com\"]\n )\n updated = client.get_hook(hook.id)\n print(\"\ + Updated name: {}\".format(updated.name))\n print(\"Updated description: {}\"\ + .format(updated.description))\n print(\"Updated emails: {}\".format(updated.emails_to_alert))\n\ + \n ````\n" diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.MetricsAdvisorClient.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.MetricsAdvisorClient.yml new file mode 100644 index 00000000..a1cedd55 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.MetricsAdvisorClient.yml @@ -0,0 +1,690 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.MetricsAdvisorClient +name: MetricsAdvisorClient +fullName: azure.ai.metricsadvisor.MetricsAdvisorClient +module: azure.ai.metricsadvisor +summary: Represents an client that calls restful API of Azure Metrics Advisor service. +constructor: + syntax: 'MetricsAdvisorClient(endpoint: str, credential: MetricsAdvisorKeyCredential + | TokenCredential, **kwargs: Any)' + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and hostname, + + for example: [https://](https://)``.cognitiveservices.azure.com).' + isRequired: true + types: + - + - name: credential + description: 'An instance of ~azure.ai.metricsadvisor.MetricsAdvisorKeyCredential. + + which requires both subscription key and API key. Or an object which can provide + an access + + token for the vault, such as a credential from ' + isRequired: true + types: + - + - +methods: +- uid: azure.ai.metricsadvisor.MetricsAdvisorClient.add_feedback + name: add_feedback + summary: Create a new metric feedback. + signature: 'add_feedback(feedback: AnomalyFeedback | ChangePointFeedback | CommentFeedback + | PeriodFeedback, **kwargs: Any) -> None' + parameters: + - name: feedback + description: metric feedback. + isRequired: true + types: + - + - + - + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Add new feedback.\n\n\n\n````python\n\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential,\ + \ MetricsAdvisorClient\n from azure.ai.metricsadvisor.models import AnomalyFeedback,\ + \ ChangePointFeedback, CommentFeedback, PeriodFeedback\n\n service_endpoint\ + \ = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key = os.getenv(\"\ + METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"METRICS_ADVISOR_API_KEY\"\ + )\n metric_id = os.getenv(\"METRICS_ADVISOR_METRIC_ID\")\n client = MetricsAdvisorClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n anomaly_feedback = AnomalyFeedback(metric_id=metric_id,\n \ + \ dimension_key={\"category\": \"Shoes Handbags\ + \ & Sunglasses\"},\n start_time=datetime.datetime(2021,\ + \ 8, 5),\n end_time=datetime.datetime(2021,\ + \ 8, 7),\n value=\"NotAnomaly\")\n client.add_feedback(anomaly_feedback)\n\ + \n change_point_feedback = ChangePointFeedback(metric_id=metric_id,\n \ + \ dimension_key={\"category\": \"Shoes\ + \ Handbags & Sunglasses\"},\n start_time=datetime.datetime(2021,\ + \ 8, 5),\n end_time=datetime.datetime(2021,\ + \ 8, 7),\n value=\"NotChangePoint\"\ + )\n client.add_feedback(change_point_feedback)\n\n comment_feedback = CommentFeedback(metric_id=metric_id,\n\ + \ dimension_key={\"category\": \"Shoes Handbags\ + \ & Sunglasses\"},\n start_time=datetime.datetime(2021,\ + \ 8, 5),\n end_time=datetime.datetime(2021,\ + \ 8, 7),\n value=\"comment\")\n client.add_feedback(comment_feedback)\n\ + \n period_feedback = PeriodFeedback(metric_id=metric_id,\n \ + \ dimension_key={\"category\": \"Shoes Handbags & Sunglasses\"\ + },\n start_time=datetime.datetime(2021, 8,\ + \ 5),\n end_time=datetime.datetime(2021, 8,\ + \ 7),\n period_type=\"AssignValue\",\n \ + \ value=2)\n client.add_feedback(period_feedback)\n\ + \n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorClient.close + name: close + summary: Close the session. + signature: close() -> None +- uid: azure.ai.metricsadvisor.MetricsAdvisorClient.get_feedback + name: get_feedback + summary: Get a metric feedback by its id. + signature: 'get_feedback(feedback_id: str, **kwargs: Any) -> MetricFeedback | AnomalyFeedback + | ChangePointFeedback | CommentFeedback | PeriodFeedback' + parameters: + - name: feedback_id + description: the id of the feedback. + isRequired: true + types: + - + return: + description: The feedback object + types: + - + - + - + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Get a metric feedback by its id.\n\n\n\n````python\n\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential, MetricsAdvisorClient\n\n service_endpoint\ + \ = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key = os.getenv(\"\ + METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"METRICS_ADVISOR_API_KEY\"\ + )\n feedback_id = os.getenv(\"METRICS_ADVISOR_FEEDBACK_ID\")\n\n client =\ + \ MetricsAdvisorClient(service_endpoint,\n MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n result = client.get_feedback(feedback_id=feedback_id)\n print(\"\ + Type: {}; Id: {}\".format(result.feedback_type, result.id))\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorClient.list_alerts + name: list_alerts + summary: Query alerts under anomaly alert configuration. + signature: 'list_alerts(alert_configuration_id: str, start_time: datetime, end_time: + datetime, time_mode: str | AlertQueryTimeMode, **kwargs: Any) -> ItemPaged[AnomalyAlert]' + parameters: + - name: alert_configuration_id + description: anomaly alert configuration unique id. + isRequired: true + types: + - + - name: start_time + description: start time filter under chosen time mode. + isRequired: true + types: + - + - + - name: end_time + description: end time filter under chosen time mode. + isRequired: true + types: + - + - + - name: time_mode + description: 'time mode. Possible values include: "AnomalyTime", "CreatedTime", + + "ModifiedTime".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: skip + types: + - + return: + description: AnomalyAlerts under anomaly alert configuration. + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Query anomaly detection results.\n\n\n\n````python\n\ + \n import datetime\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential,\ + \ MetricsAdvisorClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n results = client.list_alerts(\n alert_configuration_id=alert_config_id,\n\ + \ start_time=datetime.datetime(2021, 1, 1),\n end_time=datetime.datetime(2021,\ + \ 9, 9),\n time_mode=\"AnomalyTime\",\n )\n\n tolist = []\n for result\ + \ in results:\n tolist.append(result)\n print(\"Alert id: {}\".format(result.id))\n\ + \ print(\"Create time: {}\".format(result.created_time))\n return tolist\n\ + \n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorClient.list_anomalies + name: list_anomalies + summary: Query anomalies under a specific alert or detection configuration. + signature: 'list_anomalies(*, alert_configuration_id: str, alert_id: str, **kwargs: + Any) -> ItemPaged[models.DataPointAnomaly]' + parameters: + - name: start_time + description: start time filter under chosen time mode. + isRequired: true + types: + - + - + - name: end_time + description: end time filter under chosen time mode. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: alert_configuration_id + description: anomaly alert configuration unique id. + types: + - + - name: alert_id + description: alert id. + types: + - + - name: detection_configuration_id + description: anomaly detection configuration unique id. + types: + - + - name: skip + types: + - + - name: filter + types: + - + return: + description: Anomalies under a specific alert or detection configuration. + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.ai.metricsadvisor.MetricsAdvisorClient.list_anomaly_dimension_values + name: list_anomaly_dimension_values + summary: Query dimension values of anomalies. + signature: 'list_anomaly_dimension_values(detection_configuration_id: str, dimension_name: + str, start_time: str | datetime, end_time: str | datetime, **kwargs: Any) -> ItemPaged[str]' + parameters: + - name: detection_configuration_id + description: anomaly detection configuration unique id. + isRequired: true + types: + - + - name: dimension_name + description: dimension to query. + isRequired: true + types: + - + - name: start_time + description: start time filter under chosen time mode. + isRequired: true + types: + - + - + - name: end_time + description: end time filter under chosen time mode. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: skip + types: + - + - name: dimension_filter + description: filter specific dimension name and values. + types: + - [, ] + return: + description: Dimension values of anomalies. + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Query dimension values.\n\ + \n\n\n````python\n\n import datetime\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential, MetricsAdvisorClient\n\n service_endpoint\ + \ = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key = os.getenv(\"\ + METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"METRICS_ADVISOR_API_KEY\"\ + )\n detection_configuration_id = os.getenv(\"METRICS_ADVISOR_DETECTION_CONFIGURATION_ID\"\ + )\n dimension_name = \"region\"\n\n client = MetricsAdvisorClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n results = client.list_anomaly_dimension_values(\n detection_configuration_id=detection_configuration_id,\n\ + \ dimension_name=dimension_name,\n start_time=datetime.datetime(2020,\ + \ 1, 1),\n end_time=datetime.datetime(2020, 10, 21),\n )\n for result\ + \ in results:\n print(str(result))\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorClient.list_feedback + name: list_feedback + summary: List feedback on the given metric. + signature: 'list_feedback(metric_id: str, **kwargs: Any) -> ItemPaged[MetricFeedback + | AnomalyFeedback | ChangePointFeedback | CommentFeedback | PeriodFeedback]' + parameters: + - name: metric_id + description: filter feedbacks by metric id + isRequired: true + types: + - + keywordOnlyParameters: + - name: skip + types: + - + - name: dimension_key + description: filter specific dimension name and values + types: + - [, ] + - name: feedback_type + description: 'filter feedbacks by type. Possible values include: "Anomaly", + + "ChangePoint", "Period", "Comment".' + types: + - + - + - name: start_time + description: start time filter under chosen time mode. + types: + - + - + - name: end_time + description: end time filter under chosen time mode. + types: + - + - + - name: time_mode + description: 'time mode to filter feedback. Possible values include: "MetricTimestamp", + + "FeedbackCreatedTime".' + types: + - + - + return: + description: Pageable list of MetricFeedback + types: + - [ [, + , , + , ]] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "List feedback on the given metric.\n\n\n\n````python\n\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential, MetricsAdvisorClient\n\n service_endpoint\ + \ = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key = os.getenv(\"\ + METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"METRICS_ADVISOR_API_KEY\"\ + )\n metric_id = os.getenv(\"METRICS_ADVISOR_METRIC_ID\")\n\n client = MetricsAdvisorClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n results = client.list_feedback(metric_id=metric_id)\n for\ + \ result in results:\n print(\"Type: {}; Id: {}\".format(result.feedback_type,\ + \ result.id))\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorClient.list_incident_root_causes + name: list_incident_root_causes + summary: Query root cause for incident. + signature: 'list_incident_root_causes(detection_configuration_id: str, incident_id: + str, **kwargs: Any) -> ItemPaged[IncidentRootCause]' + parameters: + - name: detection_configuration_id + description: anomaly detection configuration unique id. + isRequired: true + types: + - + - name: incident_id + description: incident id. + isRequired: true + types: + - + return: + description: Pageable of root cause for incident + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Query incident root causes.\n\ + \n\n\n````python\n\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential,\ + \ MetricsAdvisorClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n detection_configuration_id = os.getenv(\"\ + METRICS_ADVISOR_DETECTION_CONFIGURATION_ID\")\n incident_id = os.getenv(\"METRICS_ADVISOR_INCIDENT_ID\"\ + )\n\n client = MetricsAdvisorClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n results\ + \ = client.list_incident_root_causes(\n detection_configuration_id=detection_configuration_id,\n\ + \ incident_id=incident_id,\n )\n for result in results:\n print(\"\ + Score: {}\".format(result.score))\n print(\"Description: {}\".format(result.description))\n\ + \n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorClient.list_incidents + name: list_incidents + summary: Query incidents under a specific alert or detection configuration. + signature: 'list_incidents(*, alert_configuration_id: str, alert_id: str, **kwargs: + Any) -> ItemPaged[models.AnomalyIncident]' + keywordOnlyParameters: + - name: alert_configuration_id + description: anomaly alerting configuration unique id. + types: + - + - name: alert_id + description: alert id. + types: + - + - name: detection_configuration_id + description: anomaly detection configuration unique id. + types: + - + - name: start_time + description: start time filter under chosen time mode. + types: + - + - + - name: end_time + description: end time filter under chosen time mode. + types: + - + - + - name: skip + types: + - + - name: filter + types: + - + return: + description: AnomalyIncidents under a specific alert or detection configuration. + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.ai.metricsadvisor.MetricsAdvisorClient.list_metric_dimension_values + name: list_metric_dimension_values + summary: List dimension from certain metric. + signature: 'list_metric_dimension_values(metric_id: str, dimension_name: str, **kwargs: + Any) -> ItemPaged[str]' + parameters: + - name: metric_id + description: metric unique id. + isRequired: true + types: + - + - name: dimension_name + description: the dimension name + isRequired: true + types: + - + keywordOnlyParameters: + - name: skip + types: + - + - name: dimension_value_filter + description: dimension value to be filtered. + types: + - + return: + description: Dimension from certain metric. + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Query metric dimension values.\n\n\n\n````python\n\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential, MetricsAdvisorClient\n\n service_endpoint\ + \ = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key = os.getenv(\"\ + METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"METRICS_ADVISOR_API_KEY\"\ + )\n metric_id = os.getenv(\"METRICS_ADVISOR_METRIC_ID\")\n dimension_name\ + \ = \"region\"\n\n client = MetricsAdvisorClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\ + \n results = client.list_metric_dimension_values(\n metric_id=metric_id,\n\ + \ dimension_name=dimension_name,\n )\n for result in results:\n \ + \ print(str(result))\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorClient.list_metric_enriched_series_data + name: list_metric_enriched_series_data + summary: Query series enriched by anomaly detection. + signature: 'list_metric_enriched_series_data(detection_configuration_id: str, series: + List[SeriesIdentity] | List[Dict[str, str]], start_time: str | datetime, end_time: + str | datetime, **kwargs: Any) -> ItemPaged[MetricEnrichedSeriesData]' + parameters: + - name: detection_configuration_id + description: anomaly alerting configuration unique id. + isRequired: true + types: + - + - name: series + description: List of dimensions specified for series. + isRequired: true + types: + - + - [[, ]] + - name: start_time + description: start time filter under chosen time mode. + isRequired: true + types: + - + - + - name: end_time + description: end time filter under chosen time mode. + isRequired: true + types: + - + - + return: + description: Pageable of MetricEnrichedSeriesData + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Query metric enriched series data.\n\n\n\n````python\n\n import datetime\n\ + \ from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorClient\n\ + \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n detection_configuration_id = os.getenv(\"METRICS_ADVISOR_DETECTION_CONFIGURATION_ID\"\ + )\n series_identity = {\"region\": \"Los Angeles\"}\n\n client = MetricsAdvisorClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n results = client.list_metric_enriched_series_data(\n detection_configuration_id=detection_configuration_id,\n\ + \ start_time=datetime.datetime(2020, 9, 1),\n end_time=datetime.datetime(2020,\ + \ 11, 1),\n series=[series_identity]\n )\n for result in results:\n\ + \ print(str(result))\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorClient.list_metric_enrichment_status + name: list_metric_enrichment_status + summary: Query anomaly detection status. + signature: 'list_metric_enrichment_status(metric_id: str, start_time: str | datetime, + end_time: str | datetime, **kwargs: Any) -> ItemPaged[EnrichmentStatus]' + parameters: + - name: metric_id + description: filter feedbacks by metric id. + isRequired: true + types: + - + - name: start_time + description: start time filter under chosen time mode. + isRequired: true + types: + - + - + - name: end_time + description: end time filter under chosen time mode. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: skip + types: + - + return: + description: Anomaly detection status. + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Query metric enrichment status.\n\n\n\n````python\n\n import datetime\n\ + \ from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorClient\n\ + \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n metric_id = os.getenv(\"METRICS_ADVISOR_METRIC_ID\"\ + )\n\n client = MetricsAdvisorClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\n results\ + \ = client.list_metric_enrichment_status(\n metric_id=metric_id,\n \ + \ start_time=datetime.datetime(2020, 1, 1),\n end_time=datetime.datetime(2020,\ + \ 10, 21),\n )\n for result in results:\n print(str(result))\n\n\ + \n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorClient.list_metric_series_data + name: list_metric_series_data + summary: Get time series data from metric. + signature: 'list_metric_series_data(metric_id: str, series_keys: List[Dict[str, + str]], start_time: str | datetime, end_time: str | datetime, **kwargs: Any) -> + ItemPaged[MetricSeriesData]' + parameters: + - name: metric_id + description: metric unique id. + isRequired: true + types: + - + - name: series_keys + description: query specific series. + isRequired: true + types: + - [[, ]] + - name: start_time + description: start time filter under chosen time mode. + isRequired: true + types: + - + - + - name: end_time + description: end time filter under chosen time mode. + isRequired: true + types: + - + - + return: + description: Time series data from metric. + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Query metrics series data.\n\ + \n\n\n````python\n\n import datetime\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential, MetricsAdvisorClient\n\n service_endpoint\ + \ = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key = os.getenv(\"\ + METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"METRICS_ADVISOR_API_KEY\"\ + )\n metric_id = os.getenv(\"METRICS_ADVISOR_METRIC_ID\")\n\n client = MetricsAdvisorClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n results = client.list_metric_series_data(\n metric_id=metric_id,\n\ + \ start_time=datetime.datetime(2020, 1, 1),\n end_time=datetime.datetime(2020,\ + \ 10, 21),\n series_keys=[\n {\"region\": \"Los Angeles\"\ + , \"category\": \"Homemade\"}\n ]\n )\n for result in results:\n\ + \ print(str(result))\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.MetricsAdvisorClient.list_metric_series_definitions + name: list_metric_series_definitions + summary: List series (dimension combinations) from metric. + signature: 'list_metric_series_definitions(metric_id: str, active_since: datetime, + **kwargs: Any) -> ItemPaged[MetricSeriesDefinition]' + parameters: + - name: metric_id + description: metric unique id. + isRequired: true + types: + - + - name: active_since + description: 'Required. query series ingested after this time, the format should + be + + yyyy-MM-ddTHH:mm:ssZ.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: skip + types: + - + - name: dimension_filter + description: filter specific dimension name and values. + types: + - [, []] + return: + description: Series (dimension combinations) from metric. + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Query metric series definitions.\n\n\n\n````python\n\n import datetime\n\ + \ from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorClient\n\ + \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n metric_id = os.getenv(\"METRICS_ADVISOR_METRIC_ID\"\ + )\n\n client = MetricsAdvisorClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\n results\ + \ = client.list_metric_series_definitions(\n metric_id=metric_id,\n\ + \ active_since=datetime.datetime(2020, 1, 1),\n )\n for result\ + \ in results:\n print(str(result))\n\n\n ````\n" diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.MetricsAdvisorKeyCredential.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.MetricsAdvisorKeyCredential.yml new file mode 100644 index 00000000..5322804c --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.MetricsAdvisorKeyCredential.yml @@ -0,0 +1,55 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.MetricsAdvisorKeyCredential +name: MetricsAdvisorKeyCredential +fullName: azure.ai.metricsadvisor.MetricsAdvisorKeyCredential +module: azure.ai.metricsadvisor +summary: Credential type used for authenticating to an Azure Metrics Advisor service. +constructor: + syntax: 'MetricsAdvisorKeyCredential(subscription_key: str, api_key: str)' + parameters: + - name: subscription_key + description: The subscription key + isRequired: true + types: + - + - name: api_key + description: The api key + isRequired: true + types: + - +methods: +- uid: azure.ai.metricsadvisor.MetricsAdvisorKeyCredential.update_key + name: update_key + summary: 'Update the subscription key or the api key. + + + This can be used when you''ve regenerated your service keys and want + + to update long-lived clients.' + signature: 'update_key(**kwargs: Any) -> None' + keywordOnlyParameters: + - name: subscription_key + description: The subscription key + types: + - + - name: api_key + description: The api key + types: + - + exceptions: + - type: ValueError or TypeError +attributes: +- uid: azure.ai.metricsadvisor.MetricsAdvisorKeyCredential.api_key + name: api_key + summary: The value of the api key. + return: + description: The API key + types: + - +- uid: azure.ai.metricsadvisor.MetricsAdvisorKeyCredential.subscription_key + name: subscription_key + summary: The value of the subscription key. + return: + description: The subscription key + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.yml new file mode 100644 index 00000000..a38a78d5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.yml @@ -0,0 +1,1636 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient +name: MetricsAdvisorAdministrationClient +fullName: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient +module: azure.ai.metricsadvisor.aio +summary: MetricsAdvisorAdministrationClient is used to create and manage data feeds. +constructor: + syntax: 'MetricsAdvisorAdministrationClient(endpoint: str, credential: MetricsAdvisorKeyCredential + | AsyncTokenCredential, **kwargs: Any)' + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and hostname, + + for example: [https://](https://)``.cognitiveservices.azure.com).' + isRequired: true + types: + - + - name: credential + description: 'An instance of ~azure.ai.metricsadvisor.MetricsAdvisorKeyCredential. + + which requires both subscription key and API key. Or an object which can provide + an access + + token for the vault, such as a credential from ' + isRequired: true + types: + - + - +examples: +- "Authenticate MetricsAdvisorAdministrationClient with a MetricsAdvisorKeyCredential\n\n\n\n````python\n\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential\n\ + \ from azure.ai.metricsadvisor.aio import MetricsAdvisorAdministrationClient\n\ + \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"METRICS_ADVISOR_API_KEY\"\ + )\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\ + \n ````\n" +methods: +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.close + name: close + summary: Close the + session. + signature: async close() -> None +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.create_alert_configuration + name: create_alert_configuration + summary: Create an anomaly alert configuration. + signature: 'async create_alert_configuration(name: str, metric_alert_configurations: + List[MetricAlertConfiguration], hook_ids: List[str], **kwargs: Any) -> AnomalyAlertConfiguration' + parameters: + - name: name + description: Name for the anomaly alert configuration. + isRequired: true + types: + - + - name: metric_alert_configurations + description: Anomaly alert configurations. + isRequired: true + types: + - [] + - name: hook_ids + description: Unique hook IDs. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: cross_metrics_operator + description: 'Cross metrics operator should be specified when setting up multiple + metric + + alert configurations. Possible values include: "AND", "OR", "XOR".' + types: + - + - + - name: description + description: Anomaly alert configuration description. + types: + - + return: + description: AnomalyAlertConfiguration + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Create an anomaly alert configuration\n\n\n\n````python\n\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential\n from azure.ai.metricsadvisor.aio import\ + \ MetricsAdvisorAdministrationClient\n from azure.ai.metricsadvisor.models import\ + \ (\n MetricAlertConfiguration,\n MetricAnomalyAlertScope,\n \ + \ TopNGroupScope,\n MetricAnomalyAlertConditions,\n SeverityCondition,\n\ + \ MetricBoundaryCondition,\n MetricAnomalyAlertSnoozeCondition,\n\ + \ )\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n detection_configuration_id = os.getenv(\"METRICS_ADVISOR_DETECTION_CONFIGURATION_ID\"\ + )\n hook_id = os.getenv(\"METRICS_ADVISOR_HOOK_ID\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n async with client:\n alert_config = await client.create_alert_configuration(\n\ + \ name=\"my alert config\",\n description=\"alert config description\"\ + ,\n cross_metrics_operator=\"AND\",\n metric_alert_configurations=[\n\ + \ MetricAlertConfiguration(\n detection_configuration_id=detection_configuration_id,\n\ + \ alert_scope=MetricAnomalyAlertScope(\n \ + \ scope_type=\"WholeSeries\"\n ),\n alert_conditions=MetricAnomalyAlertConditions(\n\ + \ severity_condition=SeverityCondition(\n \ + \ min_alert_severity=\"Low\",\n max_alert_severity=\"\ + High\"\n )\n )\n ),\n \ + \ MetricAlertConfiguration(\n detection_configuration_id=detection_configuration_id,\n\ + \ alert_scope=MetricAnomalyAlertScope(\n \ + \ scope_type=\"TopN\",\n top_n_group_in_scope=TopNGroupScope(\n\ + \ top=10,\n period=5,\n \ + \ min_top_count=5\n )\n \ + \ ),\n alert_conditions=MetricAnomalyAlertConditions(\n\ + \ metric_boundary_condition=MetricBoundaryCondition(\n \ + \ direction=\"Up\",\n upper=50\n\ + \ )\n ),\n alert_snooze_condition=MetricAnomalyAlertSnoozeCondition(\n\ + \ auto_snooze=2,\n snooze_scope=\"\ + Metric\",\n only_for_successive=True\n \ + \ )\n ),\n ],\n hook_ids=[hook_id]\n \ + \ )\n\n return alert_config\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.create_data_feed + name: create_data_feed + summary: Create a new data feed. + signature: 'async create_data_feed(name: str, source: AzureApplicationInsightsDataFeedSource + | AzureBlobDataFeedSource | AzureCosmosDbDataFeedSource | AzureDataExplorerDataFeedSource + | AzureTableDataFeedSource | AzureLogAnalyticsDataFeedSource | InfluxDbDataFeedSource + | MySqlDataFeedSource | PostgreSqlDataFeedSource | SqlServerDataFeedSource | MongoDbDataFeedSource + | AzureDataLakeStorageGen2DataFeedSource | AzureEventHubsDataFeedSource, granularity: + str | DataFeedGranularityType | DataFeedGranularity, schema: List[str] | DataFeedSchema, + ingestion_settings: datetime | DataFeedIngestionSettings, **kwargs: Any) -> DataFeed' + parameters: + - name: name + description: Name for the data feed. + isRequired: true + types: + - + - name: source + description: The source of the data feed + isRequired: true + types: + - [, + , , + , , + , , + , , + , , + , ] + - name: granularity + description: Granularity type. If using custom granularity, you must instantiate + a DataFeedGranularity. + isRequired: true + types: + - [, , + ] + - name: schema + description: 'Data feed schema. Can be passed as a list of metric names as strings + or as a DataFeedSchema + + object if additional configuration is needed.' + isRequired: true + types: + - [[], ] + - name: ingestion_settings + description: 'The data feed ingestions settings. Can be passed as a datetime to + use for the + + ingestion begin time or as a DataFeedIngestionSettings object if additional + configuration is needed.' + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: admins + description: Data feed administrators. + types: + - [] + - name: data_feed_description + description: Data feed description. + types: + - + - name: missing_data_point_fill_settings + description: The fill missing point type and value. + types: + - + - name: rollup_settings + description: The rollup settings. + types: + - + - name: viewers + description: Data feed viewers. + types: + - [] + - name: access_mode + description: 'Data feed access mode. Possible values include: + + "Private", "Public". Default value: "Private".' + types: + - + - + - name: action_link_template + description: action link for alert. + types: + - + return: + description: DataFeed + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Create a data feed\n\n\n\n````python\n\ + \n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential\n from\ + \ azure.ai.metricsadvisor.aio import MetricsAdvisorAdministrationClient\n from\ + \ azure.ai.metricsadvisor.models import (\n SqlServerDataFeedSource,\n \ + \ DataFeedSchema,\n DataFeedMetric,\n DataFeedDimension,\n \ + \ DataFeedRollupSettings,\n DataFeedMissingDataPointFillSettings,\n\ + \ )\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n sql_server_connection_string = os.getenv(\"METRICS_ADVISOR_SQL_SERVER_CONNECTION_STRING\"\ + )\n query = os.getenv(\"METRICS_ADVISOR_SQL_SERVER_QUERY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n async with client:\n data_feed = await client.create_data_feed(\n\ + \ name=\"My data feed\",\n source=SqlServerDataFeedSource(\n\ + \ connection_string=sql_server_connection_string,\n \ + \ query=query,\n ),\n granularity=\"Daily\",\n \ + \ schema=DataFeedSchema(\n metrics=[\n DataFeedMetric(name=\"\ + cost\", display_name=\"Cost\"),\n DataFeedMetric(name=\"revenue\"\ + , display_name=\"Revenue\")\n ],\n dimensions=[\n\ + \ DataFeedDimension(name=\"category\", display_name=\"Category\"\ + ),\n DataFeedDimension(name=\"region\", display_name=\"region\"\ + )\n ],\n timestamp_column=\"Timestamp\"\n \ + \ ),\n ingestion_settings=datetime.datetime(2019, 10, 1),\n \ + \ data_feed_description=\"cost/revenue data feed\",\n rollup_settings=DataFeedRollupSettings(\n\ + \ rollup_type=\"AutoRollup\",\n rollup_method=\"Sum\"\ + ,\n rollup_identification_value=\"__CUSTOM_SUM__\"\n ),\n\ + \ missing_data_point_fill_settings=DataFeedMissingDataPointFillSettings(\n\ + \ fill_type=\"SmartFilling\"\n ),\n access_mode=\"\ + Private\"\n )\n\n return data_feed\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.create_datasource_credential + name: create_datasource_credential + summary: Create a new datasource credential. + signature: 'async create_datasource_credential(datasource_credential: DatasourceSqlConnectionString + | DatasourceDataLakeGen2SharedKey | DatasourceServicePrincipal | DatasourceServicePrincipalInKeyVault, + **kwargs: Any) -> DatasourceSqlConnectionString | DatasourceDataLakeGen2SharedKey + | DatasourceServicePrincipal | DatasourceServicePrincipalInKeyVault' + parameters: + - name: datasource_credential + description: The datasource credential to create + isRequired: true + types: + - [, + , , + ] + return: + description: The created datasource credential + types: + - [, + , , + ] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Create a datasource credential\n\n\n\n````python\n\ + \n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\ + \ from azure.ai.metricsadvisor.models import DatasourceSqlConnectionString\n\ + \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n connection_string = os.getenv(\"SQL_SERVER_CONNECTION_STRING\"\ + )\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\ + \n datasource_credential = await client.create_datasource_credential(\n \ + \ datasource_credential=DatasourceSqlConnectionString(\n name=\"sql\ + \ datasource credential\",\n connection_string=connection_string,\n\ + \ description=\"my datasource credential\",\n )\n )\n\n return\ + \ datasource_credential\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.create_detection_configuration + name: create_detection_configuration + summary: Create anomaly detection configuration. + signature: 'async create_detection_configuration(name: str, metric_id: str, whole_series_detection_condition: + MetricDetectionCondition, **kwargs: Any) -> AnomalyDetectionConfiguration' + parameters: + - name: name + description: The name for the anomaly detection configuration + isRequired: true + types: + - + - name: metric_id + description: Required. metric unique id. + isRequired: true + types: + - + - name: whole_series_detection_condition + description: 'Required. + + Conditions to detect anomalies in all time series of a metric.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: description + description: anomaly detection configuration description. + types: + - + - name: series_group_detection_conditions + description: detection configuration for series group. + types: + - [] + - name: series_detection_conditions + description: detection configuration for specific series. + types: + - [] + return: + description: AnomalyDetectionConfiguration + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Create an anomaly detection configuration\n\n\n\n````python\n\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential\n from azure.ai.metricsadvisor.aio import\ + \ MetricsAdvisorAdministrationClient\n from azure.ai.metricsadvisor.models import\ + \ (\n ChangeThresholdCondition,\n HardThresholdCondition,\n \ + \ SmartDetectionCondition,\n SuppressCondition,\n MetricDetectionCondition,\n\ + \ )\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n metric_id = os.getenv(\"METRICS_ADVISOR_METRIC_ID\"\ + )\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\ + \n change_threshold_condition = ChangeThresholdCondition(\n anomaly_detector_direction=\"\ + Both\",\n change_percentage=20,\n shift_point=10,\n within_range=True,\n\ + \ suppress_condition=SuppressCondition(\n min_number=5,\n \ + \ min_ratio=2\n )\n )\n hard_threshold_condition = HardThresholdCondition(\n\ + \ anomaly_detector_direction=\"Up\",\n upper_bound=100,\n suppress_condition=SuppressCondition(\n\ + \ min_number=2,\n min_ratio=2\n )\n )\n smart_detection_condition\ + \ = SmartDetectionCondition(\n anomaly_detector_direction=\"Up\",\n \ + \ sensitivity=10,\n suppress_condition=SuppressCondition(\n \ + \ min_number=2,\n min_ratio=2\n )\n )\n\n async with client:\n\ + \ detection_config = await client.create_detection_configuration(\n \ + \ name=\"my_detection_config\",\n metric_id=metric_id,\n \ + \ description=\"anomaly detection config for metric\",\n whole_series_detection_condition=MetricDetectionCondition(\n\ + \ condition_operator=\"OR\",\n change_threshold_condition=change_threshold_condition,\n\ + \ hard_threshold_condition=hard_threshold_condition,\n \ + \ smart_detection_condition=smart_detection_condition\n )\n \ + \ )\n\n return detection_config\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.create_hook + name: create_hook + summary: Create a new email or web hook. + signature: 'async create_hook(hook: EmailNotificationHook | WebNotificationHook, + **kwargs: Any) -> NotificationHook | EmailNotificationHook | WebNotificationHook' + parameters: + - name: hook + description: An email or web hook to create + isRequired: true + types: + - [, + ] + return: + description: EmailNotificationHook or WebNotificationHook + types: + - [, + , ] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Create a notification hook\n\n\n\n````python\n\ + \n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential\n from\ + \ azure.ai.metricsadvisor.aio import MetricsAdvisorAdministrationClient\n from\ + \ azure.ai.metricsadvisor.models import EmailNotificationHook\n\n service_endpoint\ + \ = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key = os.getenv(\"\ + METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"METRICS_ADVISOR_API_KEY\"\ + )\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\ + \n async with client:\n hook = await client.create_hook(\n hook=EmailNotificationHook(\n\ + \ name=\"email hook\",\n description=\"my email hook\"\ + ,\n emails_to_alert=[\"alertme@alertme.com\"],\n external_link=\"\ + https://docs.microsoft.com/en-us/azure/cognitive-services/metrics-advisor/how-tos/alerts\"\ + \n )\n )\n\n return hook\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.delete_alert_configuration + name: delete_alert_configuration + summary: Delete an anomaly alert configuration by its ID. + signature: 'async delete_alert_configuration(*alert_configuration_id: str, **kwargs: + Any) -> None' + parameters: + - name: alert_configuration_id + description: anomaly alert configuration unique id. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Delete an anomaly alert configuration by its ID\n\n\n\n````python\n\n from azure.core.exceptions\ + \ import ResourceNotFoundError\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential\n\ + \ from azure.ai.metricsadvisor.aio import MetricsAdvisorAdministrationClient\n\ + \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n async with client:\n await client.delete_alert_configuration(alert_config_id)\n\ + \n try:\n await client.get_alert_configuration(alert_config_id)\n\ + \ except ResourceNotFoundError:\n print(\"Alert configuration\ + \ successfully deleted.\")\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.delete_data_feed + name: delete_data_feed + summary: Delete a data feed by its ID. + signature: 'async delete_data_feed(*data_feed_id: str, **kwargs: Any) -> None' + parameters: + - name: data_feed_id + description: The data feed unique id. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Delete a data feed by its ID\n\n\n\n````python\n\ + \n from azure.core.exceptions import ResourceNotFoundError\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential\n from azure.ai.metricsadvisor.aio import\ + \ MetricsAdvisorAdministrationClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n async with client:\n await client.delete_data_feed(data_feed_id)\n\ + \n try:\n await client.get_data_feed(data_feed_id)\n except\ + \ ResourceNotFoundError:\n print(\"Data feed successfully deleted.\"\ + )\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.delete_datasource_credential + name: delete_datasource_credential + summary: 'Delete a datasource credential by its ID. + + + ::param str credential_id: Datasource credential unique ID. + + :return: None + + :rtype: None + + :raises ~azure.core.exceptions.HttpResponseError:' + signature: 'async delete_datasource_credential(*credential_id: str, **kwargs: Any) + -> None' + examples: + - "Delete a datasource credential by its ID\n\n\n\n````python\n\n from azure.core.exceptions import\ + \ ResourceNotFoundError\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential,\ + \ MetricsAdvisorAdministrationClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n await client.delete_datasource_credential(credential_id)\n\n\ + \ ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.delete_detection_configuration + name: delete_detection_configuration + summary: Delete an anomaly detection configuration by its ID. + signature: 'async delete_detection_configuration(*detection_configuration_id: str, + **kwargs: Any) -> None' + parameters: + - name: detection_configuration_id + description: anomaly detection configuration unique id. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Delete an anomaly detection configuration by its ID\n\n\n\n````python\n\n from azure.core.exceptions\ + \ import ResourceNotFoundError\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential\n\ + \ from azure.ai.metricsadvisor.aio import MetricsAdvisorAdministrationClient\n\ + \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n async with client:\n await client.delete_detection_configuration(detection_config_id)\n\ + \n try:\n await client.get_detection_configuration(detection_config_id)\n\ + \ except ResourceNotFoundError:\n print(\"Detection configuration\ + \ successfully deleted.\")\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.delete_hook + name: delete_hook + summary: Delete a web or email hook by its ID. + signature: 'async delete_hook(*hook_id: str, **kwargs: Any) -> None' + parameters: + - name: hook_id + description: Hook unique ID. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Delete a hook by its ID\n\n\n\n````python\n\ + \n from azure.core.exceptions import ResourceNotFoundError\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential\n from azure.ai.metricsadvisor.aio import\ + \ MetricsAdvisorAdministrationClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n async with client:\n await client.delete_hook(hook_id)\n\ + \n try:\n await client.get_hook(hook_id)\n except ResourceNotFoundError:\n\ + \ print(\"Hook successfully deleted.\")\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.get_alert_configuration + name: get_alert_configuration + summary: Get a single anomaly alert configuration. + signature: 'async get_alert_configuration(alert_configuration_id: str, **kwargs: + Any) -> AnomalyAlertConfiguration' + parameters: + - name: alert_configuration_id + description: anomaly alert configuration unique id. + isRequired: true + types: + - + return: + description: AnomalyAlertConfiguration + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Get a single anomaly alert configuration by its ID\n\n\n\n````python\n\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential\n from azure.ai.metricsadvisor.aio import\ + \ MetricsAdvisorAdministrationClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n async with client:\n config = await client.get_alert_configuration(alert_config_id)\n\ + \n print(\"Alert config ID: {}\".format(config.id))\n print(\"Alert\ + \ config name: {}\".format(config.name))\n print(\"Description: {}\".format(config.description))\n\ + \ print(\"Ids of hooks associated with alert: {}\".format(config.hook_ids))\n\ + \ print(\"Use {} operator for multiple alert conditions\\n\".format(config.cross_metrics_operator))\n\ + \n print(\"Alert uses detection configuration ID: {}\".format(\n \ + \ config.metric_alert_configurations[0].detection_configuration_id\n \ + \ ))\n print(\"Alert scope type: {}\".format(config.metric_alert_configurations[0].alert_scope.scope_type))\n\ + \ print(\"Alert severity condition: min- {}, max- {}\".format(\n \ + \ config.metric_alert_configurations[0].alert_conditions.severity_condition.min_alert_severity,\n\ + \ config.metric_alert_configurations[0].alert_conditions.severity_condition.max_alert_severity,\n\ + \ ))\n print(\"\\nAlert uses detection configuration ID: {}\".format(\n\ + \ config.metric_alert_configurations[1].detection_configuration_id\n\ + \ ))\n print(\"Alert scope type: {}\".format(config.metric_alert_configurations[1].alert_scope.scope_type))\n\ + \ print(\"Top N: {}\".format(config.metric_alert_configurations[1].alert_scope.top_n_group_in_scope.top))\n\ + \ print(\"Point count used to look back: {}\".format(\n config.metric_alert_configurations[1].alert_scope.top_n_group_in_scope.period\n\ + \ ))\n print(\"Min top count: {}\".format(\n config.metric_alert_configurations[1].alert_scope.top_n_group_in_scope.min_top_count\n\ + \ ))\n print(\"Alert metric boundary condition direction: {}, upper\ + \ bound: {}\".format(\n config.metric_alert_configurations[1].alert_conditions.metric_boundary_condition.direction,\n\ + \ config.metric_alert_configurations[1].alert_conditions.metric_boundary_condition.upper,\n\ + \ ))\n print(\"Alert snooze condition, snooze point count: {}\".format(\n\ + \ config.metric_alert_configurations[1].alert_snooze_condition.auto_snooze,\n\ + \ ))\n print(\"Alert snooze scope: {}\".format(\n config.metric_alert_configurations[1].alert_snooze_condition.snooze_scope,\n\ + \ ))\n print(\"Snooze only for successive anomalies?: {}\".format(\n\ + \ config.metric_alert_configurations[1].alert_snooze_condition.only_for_successive,\n\ + \ ))\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.get_data_feed + name: get_data_feed + summary: Get a data feed by its id. + signature: 'async get_data_feed(data_feed_id: str, **kwargs: Any) -> DataFeed' + parameters: + - name: data_feed_id + description: The data feed unique id. + isRequired: true + types: + - + return: + description: DataFeed + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Get a data feed by its ID\n\n\n\n````python\n\ + \n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential\n from\ + \ azure.ai.metricsadvisor.aio import MetricsAdvisorAdministrationClient\n\n \ + \ service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n async with client:\n data_feed = await client.get_data_feed(data_feed_id)\n\ + \n print(\"ID: {}\".format(data_feed.id))\n print(\"Data feed name:\ + \ {}\".format(data_feed.name))\n print(\"Created time: {}\".format(data_feed.created_time))\n\ + \ print(\"Status: {}\".format(data_feed.status))\n print(\"Source\ + \ type: {}\".format(data_feed.source.data_source_type))\n print(\"Granularity\ + \ type: {}\".format(data_feed.granularity.granularity_type))\n print(\"\ + Data feed metrics: {}\".format([metric.name for metric in data_feed.schema.metrics]))\n\ + \ print(\"Data feed dimensions: {}\".format([dimension.name for dimension\ + \ in data_feed.schema.dimensions]))\n print(\"Data feed timestamp column:\ + \ {}\".format(data_feed.schema.timestamp_column))\n print(\"Ingestion data\ + \ starting on: {}\".format(data_feed.ingestion_settings.ingestion_begin_time))\n\ + \ print(\"Data feed description: {}\".format(data_feed.data_feed_description))\n\ + \ print(\"Data feed rollup type: {}\".format(data_feed.rollup_settings.rollup_type))\n\ + \ print(\"Data feed rollup method: {}\".format(data_feed.rollup_settings.rollup_method))\n\ + \ print(\"Data feed fill setting: {}\".format(data_feed.missing_data_point_fill_settings.fill_type))\n\ + \ print(\"Data feed access mode: {}\".format(data_feed.access_mode))\n\n\ + \ ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.get_data_feed_ingestion_progress + name: get_data_feed_ingestion_progress + summary: Get last successful data ingestion job timestamp by data feed. + signature: 'async get_data_feed_ingestion_progress(data_feed_id: str, **kwargs: + Any) -> DataFeedIngestionProgress' + parameters: + - name: data_feed_id + description: The data feed unique id. + isRequired: true + types: + - + return: + description: 'DataFeedIngestionProgress, containing *latest_success_timestamp* + + and *latest_active_timestamp*' + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Get the progress of data feed ingestion\n\n\n\n````python\n\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential\n from azure.ai.metricsadvisor.aio import\ + \ MetricsAdvisorAdministrationClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n data_feed_id = os.getenv(\"METRICS_ADVISOR_DATA_FEED_ID\"\ + )\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\ + \n async with client:\n progress = await client.get_data_feed_ingestion_progress(data_feed_id)\n\ + \n print(\"Lastest active timestamp: {}\".format(progress.latest_active_timestamp))\n\ + \ print(\"Latest successful timestamp: {}\".format(progress.latest_success_timestamp))\n\ + \n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.get_datasource_credential + name: get_datasource_credential + summary: Get a datasource credential + signature: 'async get_datasource_credential(credential_id: str, **kwargs: Any) -> + DatasourceSqlConnectionString | DatasourceDataLakeGen2SharedKey | DatasourceServicePrincipal + | DatasourceServicePrincipalInKeyVault' + parameters: + - name: credential_id + description: Datasource credential unique ID. + isRequired: true + types: + - + return: + description: The datasource credential + types: + - [, + , , + , ] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Get a datasource credential by its ID\n\n\n\n````python\n\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\n \ + \ service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n credential = await client.get_datasource_credential(credential_id)\n\ + \n print(\"Credential type: {}\".format(credential.credential_type))\n print(\"\ + Credential name: {}\".format(credential.name))\n print(\"Description: {}\".format(credential.description))\n\ + \n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.get_detection_configuration + name: get_detection_configuration + summary: Get a single anomaly detection configuration. + signature: 'async get_detection_configuration(detection_configuration_id: str, **kwargs: + Any) -> AnomalyDetectionConfiguration' + parameters: + - name: detection_configuration_id + description: anomaly detection configuration unique id. + isRequired: true + types: + - + return: + description: AnomalyDetectionConfiguration + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Get a single anomaly detection configuration by its ID\n\n\n\n````python\n\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential\n from azure.ai.metricsadvisor.aio import\ + \ MetricsAdvisorAdministrationClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n async with client:\n config = await client.get_detection_configuration(detection_config_id)\n\ + \n print(\"Detection config name: {}\".format(config.name))\n print(\"\ + Description: {}\".format(config.description))\n print(\"Metric ID: {}\"\ + .format(config.metric_id))\n\n print(\"\\nDetection conditions specified\ + \ for configuration...\")\n print(\"\\nWhole Series Detection Conditions:\\\ + n\")\n conditions = config.whole_series_detection_condition\n\n print(\"\ + Use {} operator for multiple detection conditions\".format(conditions.condition_operator))\n\ + \n print(\"Smart Detection Condition:\")\n print(\"- Sensitivity:\ + \ {}\".format(conditions.smart_detection_condition.sensitivity))\n print(\"\ + - Detection direction: {}\".format(conditions.smart_detection_condition.anomaly_detector_direction))\n\ + \ print(\"- Suppress conditions: minimum number: {}; minimum ratio: {}\"\ + .format(\n conditions.smart_detection_condition.suppress_condition.min_number,\n\ + \ conditions.smart_detection_condition.suppress_condition.min_ratio\n\ + \ ))\n\n print(\"Hard Threshold Condition:\")\n print(\"- Lower\ + \ bound: {}\".format(conditions.hard_threshold_condition.lower_bound))\n \ + \ print(\"- Upper bound: {}\".format(conditions.hard_threshold_condition.upper_bound))\n\ + \ print(\"- Detection direction: {}\".format(conditions.smart_detection_condition.anomaly_detector_direction))\n\ + \ print(\"- Suppress conditions: minimum number: {}; minimum ratio: {}\"\ + .format(\n conditions.smart_detection_condition.suppress_condition.min_number,\n\ + \ conditions.smart_detection_condition.suppress_condition.min_ratio\n\ + \ ))\n\n print(\"Change Threshold Condition:\")\n print(\"-\ + \ Change percentage: {}\".format(conditions.change_threshold_condition.change_percentage))\n\ + \ print(\"- Shift point: {}\".format(conditions.change_threshold_condition.shift_point))\n\ + \ print(\"- Detect anomaly if within range: {}\".format(conditions.change_threshold_condition.within_range))\n\ + \ print(\"- Detection direction: {}\".format(conditions.smart_detection_condition.anomaly_detector_direction))\n\ + \ print(\"- Suppress conditions: minimum number: {}; minimum ratio: {}\"\ + .format(\n conditions.smart_detection_condition.suppress_condition.min_number,\n\ + \ conditions.smart_detection_condition.suppress_condition.min_ratio\n\ + \ ))\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.get_hook + name: get_hook + summary: Get a web or email hook by its id. + signature: 'async get_hook(hook_id: str, **kwargs: Any) -> NotificationHook | EmailNotificationHook + | WebNotificationHook' + parameters: + - name: hook_id + description: Hook unique ID. + isRequired: true + types: + - + return: + description: EmailNotificationHook or WebNotificationHook + types: + - [, + , ] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Get a notification hook by its ID\n\n\n\ + \n````python\n\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential\n\ + \ from azure.ai.metricsadvisor.aio import MetricsAdvisorAdministrationClient\n\ + \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n async with client:\n hook = await client.get_hook(hook_id)\n\ + \n print(\"Hook name: {}\".format(hook.name))\n print(\"Description:\ + \ {}\".format(hook.description))\n print(\"Emails to alert: {}\".format(hook.emails_to_alert))\n\ + \ print(\"External link: {}\".format(hook.external_link))\n print(\"\ + Admins: {}\".format(hook.admins))\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.list_alert_configurations + name: list_alert_configurations + summary: Query all anomaly alert configurations for specific anomaly detection configuration. + signature: 'list_alert_configurations(detection_configuration_id: str, **kwargs: + Any) -> AsyncItemPaged[AnomalyAlertConfiguration]' + parameters: + - name: detection_configuration_id + description: anomaly detection configuration unique id. + isRequired: true + types: + - + return: + description: Pageable of AnomalyAlertConfiguration + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "List all anomaly alert configurations for specific anomaly detection configuration\n\n\n\n````python\n\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential\n from azure.ai.metricsadvisor.aio import\ + \ MetricsAdvisorAdministrationClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n detection_configuration_id = os.getenv(\"\ + METRICS_ADVISOR_DETECTION_CONFIGURATION_ID\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n async with client:\n configs = client.list_alert_configurations(detection_configuration_id)\n\ + \ async for config in configs:\n print(\"Alert config name: {}\"\ + .format(config.name))\n print(\"Alert description: {}\".format(config.description))\n\ + \ print(\"Ids of hooks associated with alert: {}\\n\".format(config.hook_ids))\n\ + \n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.list_data_feed_ingestion_status + name: list_data_feed_ingestion_status + summary: Get data ingestion status by data feed. + signature: 'list_data_feed_ingestion_status(data_feed_id: str, start_time: str | + datetime, end_time: str | datetime, **kwargs: Any) -> AsyncItemPaged[DataFeedIngestionStatus]' + parameters: + - name: data_feed_id + description: The data feed unique id. + isRequired: true + types: + - + - name: start_time + description: Required. the start point of time range to query data ingestion status. + isRequired: true + types: + - [, ] + - name: end_time + description: Required. the end point of time range to query data ingestion status. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: skip + types: + - + return: + description: Pageable of DataFeedIngestionStatus + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "List the data feed ingestion statuses by data feed ID\n\n\n\n````python\n\n import datetime\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential\n from azure.ai.metricsadvisor.aio import\ + \ MetricsAdvisorAdministrationClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n data_feed_id = os.getenv(\"METRICS_ADVISOR_DATA_FEED_ID\"\ + )\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\ + \n async with client:\n ingestion_status = client.list_data_feed_ingestion_status(\n\ + \ data_feed_id,\n datetime.datetime(2020, 9, 20),\n \ + \ datetime.datetime(2020, 9, 25)\n )\n async for status in ingestion_status:\n\ + \ print(\"Timestamp: {}\".format(status.timestamp))\n print(\"\ + Status: {}\".format(status.status))\n print(\"Message: {}\\n\".format(status.message))\n\ + \n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.list_data_feeds + name: list_data_feeds + summary: List all data feeds. + signature: 'list_data_feeds(**kwargs: Any) -> AsyncItemPaged[DataFeed]' + keywordOnlyParameters: + - name: data_feed_name + description: filter data feed by its name. + types: + - + - name: data_source_type + description: filter data feed by its source type. + types: + - + - + - name: granularity_type + description: filter data feed by its granularity. + types: + - + - + - name: status + description: filter data feed by its status. + types: + - + - + - name: creator + description: filter data feed by its creator. + types: + - + - name: skip + types: + - + return: + description: Pageable of DataFeed + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "List data feeds under an account.\n\n\n\n````python\n\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential\n from azure.ai.metricsadvisor.aio import\ + \ MetricsAdvisorAdministrationClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n async with client:\n data_feeds = client.list_data_feeds()\n\ + \n async for feed in data_feeds:\n print(\"Data feed name: {}\"\ + .format(feed.name))\n print(\"ID: {}\".format(feed.id))\n \ + \ print(\"Created time: {}\".format(feed.created_time))\n print(\"Status:\ + \ {}\".format(feed.status))\n print(\"Source type: {}\".format(feed.source.data_source_type))\n\ + \ print(\"Granularity type: {}\".format(feed.granularity.granularity_type))\n\ + \n print(\"\\nFeed metrics:\")\n for metric in feed.schema.metrics:\n\ + \ print(metric.name)\n\n print(\"\\nFeed dimensions:\"\ + )\n for dimension in feed.schema.dimensions:\n print(dimension.name)\n\ + \n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.list_datasource_credentials + name: list_datasource_credentials + summary: List all datasource credential. + signature: 'list_datasource_credentials(**kwargs: Any) -> AsyncItemPaged[DatasourceSqlConnectionString + | DatasourceDataLakeGen2SharedKey | DatasourceServicePrincipal | DatasourceServicePrincipalInKeyVault]' + keywordOnlyParameters: + - name: skip + description: for paging, skipped number. + types: + - + return: + description: Pageable containing datasource credentials + types: + - [[ , + , , + , ]] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "List all of the datasource credentials under the account\n\n\n\n````python\n\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\n \ + \ service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n credentials = client.list_datasource_credentials()\n async\ + \ for credential in credentials:\n print(\"Credential type: {}\".format(credential.credential_type))\n\ + \ print(\"Credential name: {}\".format(credential.name))\n print(\"\ + Description: {}\\n\".format(credential.description))\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.list_detection_configurations + name: list_detection_configurations + summary: Query all anomaly detection configurations for specific metric. + signature: 'list_detection_configurations(metric_id: str, **kwargs: Any) -> AsyncItemPaged[AnomalyDetectionConfiguration]' + parameters: + - name: metric_id + description: metric unique id. + isRequired: true + types: + - + return: + description: Pageable of AnomalyDetectionConfiguration + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "List all anomaly detection configurations for a specific metric\n\n\n\n````python\n\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential\n from azure.ai.metricsadvisor.aio import\ + \ MetricsAdvisorAdministrationClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n metric_id = os.getenv(\"METRICS_ADVISOR_METRIC_ID\"\ + )\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\ + \n async with client:\n configs = client.list_detection_configurations(metric_id=metric_id)\n\ + \ async for config in configs:\n print(\"Detection config name:\ + \ {}\".format(config.name))\n print(\"Description: {}\".format(config.description))\n\ + \ print(\"Metric ID: {}\\n\".format(config.metric_id))\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.list_hooks + name: list_hooks + summary: List all hooks. + signature: 'list_hooks(**kwargs: Any) -> AsyncItemPaged[NotificationHook | EmailNotificationHook + | WebNotificationHook]' + keywordOnlyParameters: + - name: hook_name + description: filter hook by its name. + types: + - + - name: skip + types: + - + return: + description: Pageable containing EmailNotificationHook and WebNotificationHook + types: + - [[, + , ]] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "List all the notification hooks under an account\n\n\n\n````python\n\n from azure.ai.metricsadvisor import\ + \ MetricsAdvisorKeyCredential\n from azure.ai.metricsadvisor.aio import MetricsAdvisorAdministrationClient\n\ + \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n async with client:\n hooks = client.list_hooks()\n \ + \ async for hook in hooks:\n print(\"Hook type: {}\".format(hook.hook_type))\n\ + \ print(\"Hook name: {}\".format(hook.name))\n print(\"Description:\ + \ {}\\n\".format(hook.description))\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.refresh_data_feed_ingestion + name: refresh_data_feed_ingestion + summary: Refreshes data ingestion by data feed to backfill data. + signature: 'async refresh_data_feed_ingestion(data_feed_id: str, start_time: str + | datetime, end_time: str | datetime, **kwargs: Any) -> None' + parameters: + - name: data_feed_id + description: The data feed unique id. + isRequired: true + types: + - + - name: start_time + description: The start point of time range to refresh data ingestion. + isRequired: true + types: + - [, ] + - name: end_time + description: The end point of time range to refresh data ingestion. + isRequired: true + types: + - [, ] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Refresh data feed ingestion over a period of time\n\n\n\n````python\n\n import datetime\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential\n from azure.ai.metricsadvisor.aio import\ + \ MetricsAdvisorAdministrationClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n data_feed_id = os.getenv(\"METRICS_ADVISOR_DATA_FEED_ID\"\ + )\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\ + \n async with client:\n await client.refresh_data_feed_ingestion(\n \ + \ data_feed_id,\n datetime.datetime(2020, 9, 20),\n \ + \ datetime.datetime(2020, 9, 25)\n )\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.update_alert_configuration + name: update_alert_configuration + summary: 'Update anomaly alerting configuration. Either pass the entire AnomalyAlertConfiguration + object + + with the chosen updates or the ID to your alert configuration with updates passed + via keyword arguments. + + If you pass both the AnomalyAlertConfiguration object and keyword arguments, the + keyword arguments + + will take precedence.' + signature: 'async update_alert_configuration(alert_configuration: str | AnomalyAlertConfiguration, + **kwargs: Any) -> AnomalyAlertConfiguration' + parameters: + - name: alert_configuration + description: AnomalyAlertConfiguration object or the ID to the alert configuration. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: name + description: Name for the anomaly alert configuration. + types: + - + - name: metric_alert_configurations + description: Anomaly alert configurations. + types: + - [] + - name: hook_ids + description: Unique hook IDs. + types: + - [] + - name: cross_metrics_operator + description: 'Cross metrics operator should be specified when setting up multiple + metric + + alert configurations. Possible values include: "AND", "OR", "XOR".' + types: + - + - + - name: description + description: Anomaly alert configuration description. + types: + - + return: + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Update an existing anomaly alert configuration\n\n\n\n````python\n\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential\n from azure.ai.metricsadvisor.aio import\ + \ MetricsAdvisorAdministrationClient\n from azure.ai.metricsadvisor.models import\ + \ (\n MetricAlertConfiguration,\n MetricAnomalyAlertScope,\n \ + \ MetricAnomalyAlertConditions,\n MetricBoundaryCondition\n )\n service_endpoint\ + \ = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key = os.getenv(\"\ + METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"METRICS_ADVISOR_API_KEY\"\ + )\n detection_configuration_id = os.getenv(\"METRICS_ADVISOR_DETECTION_CONFIGURATION_ID\"\ + )\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\ + \n alert_config.name = \"updated config name\"\n additional_alert = MetricAlertConfiguration(\n\ + \ detection_configuration_id=detection_configuration_id,\n alert_scope=MetricAnomalyAlertScope(\n\ + \ scope_type=\"SeriesGroup\",\n series_group_in_scope={'region':\ + \ 'Shenzhen'}\n ),\n alert_conditions=MetricAnomalyAlertConditions(\n\ + \ metric_boundary_condition=MetricBoundaryCondition(\n \ + \ direction=\"Down\",\n lower=5\n )\n )\n )\n\ + \ alert_config.metric_alert_configurations.append(additional_alert)\n\n async\ + \ with client:\n updated = await client.update_alert_configuration(\n \ + \ alert_config,\n cross_metrics_operator=\"OR\",\n \ + \ description=\"updated alert config\"\n )\n print(\"Updated alert\ + \ name: {}\".format(updated.name))\n print(\"Updated alert description:\ + \ {}\".format(updated.description))\n print(\"Updated cross metrics operator:\ + \ {}\".format(updated.cross_metrics_operator))\n print(\"Updated alert condition\ + \ configuration scope type: {}\".format(\n updated.metric_alert_configurations[2].alert_scope.scope_type\n\ + \ ))\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.update_data_feed + name: update_data_feed + summary: 'Update a data feed. Either pass the entire DataFeed object with the chosen + updates + + or the ID to your data feed with updates passed via keyword arguments. If you + pass both + + the DataFeed object and keyword arguments, the keyword arguments will take precedence.' + signature: 'async update_data_feed(data_feed: str | DataFeed, **kwargs: Any) -> + DataFeed' + parameters: + - name: data_feed + description: The data feed with updates or the data feed ID. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: name + description: The name to update the data feed. + types: + - + - name: timestamp_column + description: User-defined timestamp column name. + types: + - + - name: ingestion_begin_time + description: Ingestion start time. + types: + - + - name: data_source_request_concurrency + description: 'The max concurrency of data ingestion queries against + + user data source. Zero (0) means no limitation.' + types: + - + - name: ingestion_retry_delay + description: The min retry interval for failed data ingestion tasks, in seconds. + types: + - + - name: ingestion_start_offset + description: 'The time that the beginning of data ingestion task will delay + + for every data slice according to this offset, in seconds.' + types: + - + - name: stop_retry_after + description: 'Stop retry data ingestion after the data slice first + + schedule time in seconds.' + types: + - + - name: rollup_identification_value + description: 'The identification value for the row of calculated + + all-up value.' + types: + - + - name: rollup_type + description: 'Mark if the data feed needs rollup. Possible values include: "NoRollup", + + "AutoRollup", "AlreadyRollup". Default value: "AutoRollup".' + types: + - + - + - name: auto_rollup_group_by_column_names + description: Roll up columns. + types: + - [] + - name: rollup_method + description: 'Roll up method. Possible values include: "None", "Sum", "Max", "Min", + + "Avg", "Count".' + types: + - + - + - name: fill_type + description: 'The type of fill missing point for anomaly detection. Possible + + values include: "SmartFilling", "PreviousValue", "CustomValue", "NoFilling". + Default value: + + "SmartFilling".' + types: + - + - + - name: custom_fill_value + description: 'The value of fill missing point for anomaly detection + + if "CustomValue" fill type is specified.' + types: + - + - name: admins + description: Data feed administrators. + types: + - [] + - name: data_feed_description + description: Data feed description. + types: + - + - name: viewers + description: Data feed viewers. + types: + - [] + - name: access_mode + description: 'Data feed access mode. Possible values include: + + "Private", "Public". Default value: "Private".' + types: + - + - + - name: action_link_template + description: action link for alert. + types: + - + - name: status + description: 'Data feed status. Possible values include: "Active", "Paused".' + types: + - + - + - name: source + description: The source of the data feed for update + types: + - [, + , , + , , + , , + , , + , , + , ] + return: + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Update an existing data feed\n\n\n\n````python\n\ + \n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential\n from\ + \ azure.ai.metricsadvisor.aio import MetricsAdvisorAdministrationClient\n\n \ + \ service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n # update data feed on the data feed itself or by using available\ + \ keyword arguments\n data_feed.name = \"updated name\"\n data_feed.data_feed_description\ + \ = \"updated description for data feed\"\n\n async with client:\n updated\ + \ = await client.update_data_feed(\n data_feed,\n access_mode=\"\ + Public\",\n fill_type=\"CustomValue\",\n custom_fill_value=1\n\ + \ )\n print(\"Updated name: {}\".format(updated.name))\n print(\"\ + Updated description: {}\".format(updated.data_feed_description))\n print(\"\ + Updated access mode: {}\".format(updated.access_mode))\n print(\"Updated\ + \ fill setting, value: {}, {}\".format(\n updated.missing_data_point_fill_settings.fill_type,\n\ + \ updated.missing_data_point_fill_settings.custom_fill_value,\n \ + \ ))\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.update_datasource_credential + name: update_datasource_credential + summary: Update a credential entity. + signature: 'async update_datasource_credential(datasource_credential: DatasourceSqlConnectionString + | DatasourceDataLakeGen2SharedKey | DatasourceServicePrincipal | DatasourceServicePrincipalInKeyVault, + **kwargs: Any) -> DatasourceSqlConnectionString | DatasourceDataLakeGen2SharedKey + | DatasourceServicePrincipal | DatasourceServicePrincipalInKeyVault' + parameters: + - name: datasource_credential + description: The new datasource credential object + isRequired: true + types: + - [, + , , + ] + return: + description: The updated DataSourceCredential. + types: + - [, + , , + ] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Update an existing datasource credential\n\n\n\n````python\n\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential, MetricsAdvisorAdministrationClient\n\n \ + \ service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n datasource_credential.description = \"updated description\"\n\ + \n updated = await client.update_datasource_credential(datasource_credential)\n\ + \ print(\"Credential type: {}\".format(updated.credential_type))\n print(\"\ + Credential name: {}\".format(updated.name))\n print(\"Description: {}\\n\".format(updated.description))\n\ + \n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.update_detection_configuration + name: update_detection_configuration + summary: 'Update anomaly metric detection configuration. Either pass the entire + AnomalyDetectionConfiguration object + + with the chosen updates or the ID to your detection configuration with updates + passed via keyword arguments. + + If you pass both the AnomalyDetectionConfiguration object and keyword arguments, + the keyword arguments + + will take precedence.' + signature: 'async update_detection_configuration(detection_configuration: str | + AnomalyDetectionConfiguration, **kwargs: Any) -> AnomalyDetectionConfiguration' + parameters: + - name: detection_configuration + description: 'AnomalyDetectionConfiguration object or the ID to the detection + + configuration.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: name + description: The name for the anomaly detection configuration + types: + - + - name: metric_id + description: metric unique id. + types: + - + - name: whole_series_detection_condition + description: 'Required. + + Conditions to detect anomalies in all time series of a metric.' + types: + - + - name: description + description: anomaly detection configuration description. + types: + - + - name: series_group_detection_conditions + description: detection configuration for series group. + types: + - [] + - name: series_detection_conditions + description: detection configuration for specific series. + types: + - [] + return: + description: AnomalyDetectionConfiguration + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Update an existing anomaly detection configuration\n\n\n\n````python\n\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential\n from azure.ai.metricsadvisor.aio import\ + \ MetricsAdvisorAdministrationClient\n from azure.ai.metricsadvisor.models import\ + \ (\n MetricSeriesGroupDetectionCondition,\n MetricSingleSeriesDetectionCondition,\n\ + \ SmartDetectionCondition,\n SuppressCondition\n )\n\n service_endpoint\ + \ = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key = os.getenv(\"\ + METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"METRICS_ADVISOR_API_KEY\"\ + )\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\ + \n detection_config.name = \"updated config name\"\n detection_config.description\ + \ = \"updated with more detection conditions\"\n smart_detection_condition =\ + \ SmartDetectionCondition(\n anomaly_detector_direction=\"Up\",\n \ + \ sensitivity=10,\n suppress_condition=SuppressCondition(\n min_number=2,\n\ + \ min_ratio=2\n )\n )\n\n async with client:\n updated\ + \ = await client.update_detection_configuration(\n detection_config,\n\ + \ series_group_detection_conditions=[\n MetricSeriesGroupDetectionCondition(\n\ + \ series_group_key={\"region\": \"Seoul\"},\n \ + \ smart_detection_condition=smart_detection_condition\n )\n\ + \ ],\n series_detection_conditions=[\n MetricSingleSeriesDetectionCondition(\n\ + \ series_key={\"region\": \"Osaka\", \"category\": \"Cell Phones\"\ + },\n smart_detection_condition=smart_detection_condition\n \ + \ )\n ]\n )\n print(\"Updated detection name:\ + \ {}\".format(updated.name))\n print(\"Updated detection description: {}\"\ + .format(updated.description))\n print(\"Updated detection condition for\ + \ series group: {}\".format(\n updated.series_group_detection_conditions[0].series_group_key\n\ + \ ))\n print(\"Updated detection condition for series: {}\".format(\n\ + \ updated.series_detection_conditions[0].series_key\n ))\n\n\n\ + \ ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient.update_hook + name: update_hook + summary: 'Update a hook. Either pass the entire EmailNotificationHook or WebNotificationHook + object with the + + chosen updates, or the ID to your hook configuration with the updates passed via + keyword arguments. + + If you pass both the hook object and keyword arguments, the keyword arguments + will take precedence.' + signature: 'async update_hook(hook: str | EmailNotificationHook | WebNotificationHook, + **kwargs: Any) -> NotificationHook | EmailNotificationHook | WebNotificationHook' + parameters: + - name: hook + description: An email or web hook or the ID to the hook. If an ID is passed, you + must pass *hook_type*. + isRequired: true + types: + - [, , + ] + keywordOnlyParameters: + - name: hook_type + description: 'The hook type. Possible values are "Email" or "Web". Must be passed + if only the + + hook ID is provided.' + types: + - + - name: name + description: Hook unique name. + types: + - + - name: description + description: Hook description. + types: + - + - name: external_link + description: Hook external link. + types: + - + - name: emails_to_alert + description: 'Email TO: list. Only should be passed to update EmailNotificationHook.' + types: + - [] + - name: endpoint + description: 'API address, will be called when alert is triggered, only support + + POST method via SSL. Only should be passed to update WebNotificationHook.' + types: + - + - name: username + description: basic authentication. Only should be passed to update WebNotificationHook. + types: + - + - name: password + description: basic authentication. Only should be passed to update WebNotificationHook. + types: + - + - name: certificate_key + description: client certificate. Only should be passed to update WebNotificationHook. + types: + - + - name: certificate_password + description: 'client certificate password. Only should be passed to update + + WebNotificationHook.' + types: + - + return: + description: The updated email or web hook. + types: + - [, + , ] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Update an existing notification hook\n\n\n\ + \n````python\n\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential\n\ + \ from azure.ai.metricsadvisor.aio import MetricsAdvisorAdministrationClient\n\ + \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorAdministrationClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n hook.name = \"updated hook name\"\n hook.description = \"\ + updated hook description\"\n\n async with client:\n updated = await client.update_hook(\n\ + \ hook,\n emails_to_alert=[\"newemail@alertme.com\"]\n \ + \ )\n print(\"Updated name: {}\".format(updated.name))\n print(\"\ + Updated description: {}\".format(updated.description))\n print(\"Updated\ + \ emails: {}\".format(updated.emails_to_alert))\n\n ````\n" diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.aio.MetricsAdvisorClient.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.aio.MetricsAdvisorClient.yml new file mode 100644 index 00000000..7c53372c --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.aio.MetricsAdvisorClient.yml @@ -0,0 +1,711 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.aio.MetricsAdvisorClient +name: MetricsAdvisorClient +fullName: azure.ai.metricsadvisor.aio.MetricsAdvisorClient +module: azure.ai.metricsadvisor.aio +summary: Represents an client that calls restful API of Azure Metrics Advisor service. +constructor: + syntax: 'MetricsAdvisorClient(endpoint: str, credential: MetricsAdvisorKeyCredential + | AsyncTokenCredential, **kwargs: Any)' + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and hostname, + + for example: [https://](https://)``.cognitiveservices.azure.com).' + isRequired: true + types: + - + - name: credential + description: 'An instance of ~azure.ai.metricsadvisor.MetricsAdvisorKeyCredential. + + which requires both subscription key and API key. Or an object which can provide + an access + + token for the vault, such as a credential from ' + isRequired: true + types: + - + - +methods: +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorClient.add_feedback + name: add_feedback + summary: Create a new metric feedback. + signature: 'async add_feedback(feedback: AnomalyFeedback | ChangePointFeedback | + CommentFeedback | PeriodFeedback, **kwargs: Any) -> None' + parameters: + - name: feedback + description: metric feedback. + isRequired: true + types: + - + - + - + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Add new feedback.\n\n\n\n````python\n\ + \n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential\n from\ + \ azure.ai.metricsadvisor.aio import MetricsAdvisorClient\n from azure.ai.metricsadvisor.models\ + \ import AnomalyFeedback, ChangePointFeedback, CommentFeedback, PeriodFeedback\n\ + \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n metric_id = os.getenv(\"METRICS_ADVISOR_METRIC_ID\"\ + )\n\n client = MetricsAdvisorClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\n anomaly_feedback\ + \ = AnomalyFeedback(metric_id=metric_id,\n \ + \ dimension_key={\"Dim1\": \"Common Lime\"},\n \ + \ start_time=datetime.datetime(2020, 8, 5),\n \ + \ end_time=datetime.datetime(2020, 8, 7),\n \ + \ value=\"NotAnomaly\")\n await client.add_feedback(anomaly_feedback)\n\ + \n change_point_feedback = ChangePointFeedback(metric_id=metric_id,\n \ + \ dimension_key={\"Dim1\": \"Common Lime\"\ + },\n start_time=datetime.datetime(2020,\ + \ 8, 5),\n end_time=datetime.datetime(2020,\ + \ 8, 7),\n value=\"NotChangePoint\"\ + )\n await client.add_feedback(change_point_feedback)\n\n comment_feedback\ + \ = CommentFeedback(metric_id=metric_id,\n \ + \ dimension_key={\"Dim1\": \"Common Lime\"},\n \ + \ start_time=datetime.datetime(2020, 8, 5),\n \ + \ end_time=datetime.datetime(2020, 8, 7),\n \ + \ value=\"comment\")\n await client.add_feedback(comment_feedback)\n\ + \n period_feedback = PeriodFeedback(metric_id=metric_id,\n \ + \ dimension_key={\"Dim1\": \"Common Lime\"},\n \ + \ start_time=datetime.datetime(2020, 8, 5),\n \ + \ end_time=datetime.datetime(2020, 8, 7),\n \ + \ period_type=\"AssignValue\",\n \ + \ value=2)\n await client.add_feedback(period_feedback)\n\n\ + \ ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorClient.close + name: close + summary: Close the session. + signature: async close() -> None +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorClient.get_feedback + name: get_feedback + summary: Get a metric feedback by its id. + signature: 'async get_feedback(feedback_id: str, **kwargs: Any) -> MetricFeedback + | AnomalyFeedback | ChangePointFeedback | CommentFeedback | PeriodFeedback' + parameters: + - name: feedback_id + description: the id of the feedback. + isRequired: true + types: + - + return: + description: The feedback object + types: + - + - + - + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Get a metric feedback by its id.\n\n\n\n````python\n\n from azure.ai.metricsadvisor import\ + \ MetricsAdvisorKeyCredential\n from azure.ai.metricsadvisor.aio import MetricsAdvisorClient\n\ + \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n feedback_id = os.getenv(\"METRICS_ADVISOR_FEEDBACK_ID\"\ + )\n\n client = MetricsAdvisorClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\n result\ + \ = await client.get_feedback(feedback_id=feedback_id)\n print(\"Type: {}; Id:\ + \ {}\".format(result.feedback_type, result.id))\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorClient.list_alerts + name: list_alerts + summary: Query alerts under anomaly alert configuration. + signature: 'list_alerts(alert_configuration_id: str, start_time: str | datetime, + end_time: str | datetime, time_mode: str | AlertQueryTimeMode, **kwargs: Any) + -> AsyncItemPaged[AnomalyAlert]' + parameters: + - name: alert_configuration_id + description: anomaly alert configuration unique id. + isRequired: true + types: + - + - name: start_time + description: start time filter under chosen time mode. + isRequired: true + types: + - + - + - name: end_time + description: end time filter under chosen time mode. + isRequired: true + types: + - + - + - name: time_mode + description: 'time mode. Possible values include: "AnomalyTime", "CreatedTime", + + "ModifiedTime".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: skip + types: + - + return: + description: AnomalyAlerts under anomaly alert configuration. + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Query anomaly detection results.\n\n\n\n````python\n\n import datetime\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential\n from azure.ai.metricsadvisor.aio import\ + \ MetricsAdvisorClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n\n client = MetricsAdvisorClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n async with client:\n results = client.list_alerts(\n \ + \ alert_configuration_id=alert_config_id,\n start_time=datetime.datetime(2020,\ + \ 1, 1),\n end_time=datetime.datetime(2020, 9, 9),\n time_mode=\"\ + AnomalyTime\",\n )\n tolist = []\n async for result in results:\n\ + \ tolist.append(result)\n print(\"Alert id: {}\".format(result.id))\n\ + \ print(\"Create time: {}\".format(result.created_time))\n return\ + \ tolist\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorClient.list_anomalies + name: list_anomalies + summary: Query anomalies under a specific alert or detection configuration. + signature: 'list_anomalies(*, alert_configuration_id: str, alert_id: str, **kwargs: + Any) -> AsyncItemPaged[models.DataPointAnomaly]' + keywordOnlyParameters: + - name: alert_configuration_id + description: anomaly alert configuration unique id. + types: + - + - name: alert_id + description: alert id. + types: + - + - name: detection_configuration_id + description: anomaly detection configuration unique id. + types: + - + - name: start_time + description: start time filter under chosen time mode. + types: + - + - + - name: end_time + description: end time filter under chosen time mode. + types: + - + - + - name: skip + types: + - + - name: filter + types: + - + return: + description: Anomalies under a specific alert or detection configuration. + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorClient.list_anomaly_dimension_values + name: list_anomaly_dimension_values + summary: Query dimension values of anomalies. + signature: 'list_anomaly_dimension_values(detection_configuration_id: str, dimension_name: + str, start_time: str | datetime, end_time: str | datetime, **kwargs: Any) -> AsyncItemPaged[str]' + parameters: + - name: detection_configuration_id + description: anomaly detection configuration unique id. + isRequired: true + types: + - + - name: dimension_name + description: dimension to query. + isRequired: true + types: + - + - name: start_time + description: start time filter under chosen time mode. + isRequired: true + types: + - + - + - name: end_time + description: end time filter under chosen time mode. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: skip + types: + - + - name: dimension_filter + description: filter specific dimension name and values. + types: + - [, ] + return: + description: Dimension values of anomalies. + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Query dimension values.\n\n\n\n````python\n\ + \n import datetime\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential\n\ + \ from azure.ai.metricsadvisor.aio import MetricsAdvisorClient\n\n service_endpoint\ + \ = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key = os.getenv(\"\ + METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"METRICS_ADVISOR_API_KEY\"\ + )\n detection_configuration_id = os.getenv(\"METRICS_ADVISOR_DETECTION_CONFIGURATION_ID\"\ + )\n dimension_name = \"region\"\n\n client = MetricsAdvisorClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n async with client:\n results = client.list_anomaly_dimension_values(\n\ + \ detection_configuration_id=detection_configuration_id,\n \ + \ dimension_name=dimension_name,\n start_time=datetime.datetime(2020,\ + \ 1, 1),\n end_time=datetime.datetime(2020, 10, 21),\n )\n \ + \ async for result in results:\n print(str(result))\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorClient.list_feedback + name: list_feedback + summary: List feedback on the given metric. + signature: 'list_feedback(metric_id: str, **kwargs: Any) -> AsyncItemPaged[MetricFeedback + | AnomalyFeedback | ChangePointFeedback | CommentFeedback | PeriodFeedback]' + parameters: + - name: metric_id + description: filter feedbacks by metric id + isRequired: true + types: + - + keywordOnlyParameters: + - name: skip + types: + - + - name: dimension_key + description: filter specific dimension name and values + types: + - [, ] + - name: feedback_type + description: 'filter feedbacks by type. Possible values include: "Anomaly", + + "ChangePoint", "Period", "Comment".' + types: + - + - + - name: start_time + description: start time filter under chosen time mode. + types: + - + - + - name: end_time + description: end time filter under chosen time mode. + types: + - + - + - name: time_mode + description: 'time mode to filter feedback. Possible values include: "MetricTimestamp", + + "FeedbackCreatedTime".' + types: + - + - + return: + description: Pageable list of MetricFeedback + types: + - [ [, + , , + , ]] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "List feedback on the given metric.\n\n\n\n````python\n\n from azure.ai.metricsadvisor import\ + \ MetricsAdvisorKeyCredential\n from azure.ai.metricsadvisor.aio import MetricsAdvisorClient\n\ + \n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key\ + \ = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"\ + METRICS_ADVISOR_API_KEY\")\n metric_id = os.getenv(\"METRICS_ADVISOR_METRIC_ID\"\ + )\n\n client = MetricsAdvisorClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\n results\ + \ = client.list_feedback(metric_id=metric_id)\n async for result in results:\n\ + \ print(\"Type: {}; Id: {}\".format(result.feedback_type, result.id))\n\n\ + \ ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorClient.list_incident_root_causes + name: list_incident_root_causes + summary: Query root cause for incident. + signature: 'list_incident_root_causes(detection_configuration_id: str, incident_id: + str, **kwargs: Any) -> AsyncItemPaged[IncidentRootCause]' + parameters: + - name: detection_configuration_id + description: anomaly detection configuration unique id. + isRequired: true + types: + - + - name: incident_id + description: incident id. + isRequired: true + types: + - + return: + description: Pageable of root cause for incident + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Query incident root causes.\n\n\n\n````python\n\ + \n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential\n from\ + \ azure.ai.metricsadvisor.aio import MetricsAdvisorClient\n\n service_endpoint\ + \ = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key = os.getenv(\"\ + METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"METRICS_ADVISOR_API_KEY\"\ + )\n detection_configuration_id = os.getenv(\"METRICS_ADVISOR_DETECTION_CONFIGURATION_ID\"\ + )\n incident_id = os.getenv(\"METRICS_ADVISOR_INCIDENT_ID\")\n\n client =\ + \ MetricsAdvisorClient(service_endpoint,\n MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n async with client:\n results = client.list_incident_root_causes(\n\ + \ detection_configuration_id=detection_configuration_id,\n \ + \ incident_id=incident_id,\n )\n async for result in results:\n \ + \ print(\"Score: {}\".format(result.score))\n print(\"Description:\ + \ {}\".format(result.description))\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorClient.list_incidents + name: list_incidents + summary: Query incidents under a specific alert or detection configuration. + signature: 'list_incidents(*, alert_configuration_id: str, alert_id: str, **kwargs: + Any) -> AsyncItemPaged[models.AnomalyIncident]' + keywordOnlyParameters: + - name: alert_configuration_id + description: anomaly alerting configuration unique id. + types: + - + - name: alert_id + description: alert id. + types: + - + - name: detection_configuration_id + description: anomaly detection configuration unique id. + types: + - + - name: start_time + description: start time filter under chosen time mode. + types: + - + - + - name: end_time + description: end time filter under chosen time mode. + types: + - + - + - name: skip + types: + - + - name: filter + types: + - + return: + description: AnomalyIncidents under a specific alert. + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorClient.list_metric_dimension_values + name: list_metric_dimension_values + summary: List dimension from certain metric. + signature: 'list_metric_dimension_values(metric_id: str, dimension_name: str, **kwargs: + Any) -> AsyncItemPaged[str]' + parameters: + - name: metric_id + description: metric unique id. + isRequired: true + types: + - + - name: dimension_name + description: the dimension name + isRequired: true + types: + - + keywordOnlyParameters: + - name: skip + types: + - + - name: dimension_value_filter + description: dimension value to be filtered. + types: + - + return: + description: Dimension from certain metric. + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Query metric dimension values.\n\n\n\n````python\n\ + \n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential\n from\ + \ azure.ai.metricsadvisor.aio import MetricsAdvisorClient\n\n service_endpoint\ + \ = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key = os.getenv(\"\ + METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"METRICS_ADVISOR_API_KEY\"\ + )\n metric_id = os.getenv(\"METRICS_ADVISOR_METRIC_ID\")\n dimension_name\ + \ = \"region\"\n\n client = MetricsAdvisorClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\ + \n async with client:\n results = client.list_metric_dimension_values(\n\ + \ metric_id=metric_id,\n dimension_name=dimension_name,\n\ + \ )\n async for result in results:\n print(str(result))\n\ + \n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorClient.list_metric_enriched_series_data + name: list_metric_enriched_series_data + summary: Query series enriched by anomaly detection. + signature: 'list_metric_enriched_series_data(detection_configuration_id: str, series: + List[SeriesIdentity] | List[Dict[str, str]], start_time: str | datetime, end_time: + str | datetime, **kwargs: Any) -> AsyncItemPaged[MetricEnrichedSeriesData]' + parameters: + - name: detection_configuration_id + description: anomaly alerting configuration unique id. + isRequired: true + types: + - + - name: series + description: List of dimensions specified for series. + isRequired: true + types: + - + - [[, ]] + - name: start_time + description: start time filter under chosen time mode. + isRequired: true + types: + - + - + - name: end_time + description: end time filter under chosen time mode. + isRequired: true + types: + - + - + return: + description: Pageable of MetricEnrichedSeriesData + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Query metric enriched series data.\n\n\n\n````python\n\n import datetime\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential\n from azure.ai.metricsadvisor.aio import\ + \ MetricsAdvisorClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n detection_configuration_id = os.getenv(\"\ + METRICS_ADVISOR_DETECTION_CONFIGURATION_ID\")\n series_identity = {\"region\"\ + : \"Los Angeles\"}\n\n client = MetricsAdvisorClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\ + \n async with client:\n results = client.list_metric_enriched_series_data(\n\ + \ detection_configuration_id=detection_configuration_id,\n \ + \ start_time=datetime.datetime(2020, 9, 1),\n end_time=datetime.datetime(2020,\ + \ 11, 1),\n series=[series_identity]\n )\n async for result\ + \ in results:\n print(str(result))\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorClient.list_metric_enrichment_status + name: list_metric_enrichment_status + summary: Query anomaly detection status. + signature: 'list_metric_enrichment_status(metric_id: str, start_time: str | datetime, + end_time: str | datetime, **kwargs: Any) -> AsyncItemPaged[EnrichmentStatus]' + parameters: + - name: metric_id + description: filter feedbacks by metric id. + isRequired: true + types: + - + - name: start_time + description: start time filter under chosen time mode. + isRequired: true + types: + - + - + - name: end_time + description: end time filter under chosen time mode. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: skip + types: + - + return: + description: Anomaly detection status. + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Query metric enrichment status.\n\n\n\n````python\n\ + \n import datetime\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential\n\ + \ from azure.ai.metricsadvisor.aio import MetricsAdvisorClient\n\n service_endpoint\ + \ = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key = os.getenv(\"\ + METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"METRICS_ADVISOR_API_KEY\"\ + )\n metric_id = os.getenv(\"METRICS_ADVISOR_METRIC_ID\")\n\n client = MetricsAdvisorClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n async with client:\n results = client.list_metric_enrichment_status(\n\ + \ metric_id=metric_id,\n start_time=datetime.datetime(2020,\ + \ 1, 1),\n end_time=datetime.datetime(2020, 10, 21),\n \ + \ )\n async for result in results:\n print(str(result))\n\n\n\ + \ ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorClient.list_metric_series_data + name: list_metric_series_data + summary: Get time series data from metric. + signature: 'list_metric_series_data(metric_id: str, series_keys: List[Dict[str, + str]], start_time: str | datetime, end_time: str | datetime, **kwargs: Any) -> + AsyncItemPaged[MetricSeriesData]' + parameters: + - name: metric_id + description: metric unique id. + isRequired: true + types: + - + - name: series_keys + description: query specific series. + isRequired: true + types: + - [[, ]] + - name: start_time + description: start time filter under chosen time mode. + isRequired: true + types: + - + - + - name: end_time + description: end time filter under chosen time mode. + isRequired: true + types: + - + - + return: + description: Time series data from metric. + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Query metrics series data.\n\n\n\n````python\n\ + \n import datetime\n from azure.ai.metricsadvisor import MetricsAdvisorKeyCredential\n\ + \ from azure.ai.metricsadvisor.aio import MetricsAdvisorClient\n\n service_endpoint\ + \ = os.getenv(\"METRICS_ADVISOR_ENDPOINT\")\n subscription_key = os.getenv(\"\ + METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key = os.getenv(\"METRICS_ADVISOR_API_KEY\"\ + )\n metric_id = os.getenv(\"METRICS_ADVISOR_METRIC_ID\")\n\n client = MetricsAdvisorClient(service_endpoint,\n\ + \ MetricsAdvisorKeyCredential(subscription_key,\ + \ api_key))\n\n async with client:\n results = client.list_metric_series_data(\n\ + \ metric_id=metric_id,\n start_time=datetime.datetime(2020,\ + \ 1, 1),\n end_time=datetime.datetime(2020, 10, 21),\n \ + \ series_keys=[\n {\"region\": \"Los Angeles\", \"category\"\ + : \"Homemade\"}\n ]\n )\n async for result in results:\n\ + \ print(str(result))\n\n\n ````\n" +- uid: azure.ai.metricsadvisor.aio.MetricsAdvisorClient.list_metric_series_definitions + name: list_metric_series_definitions + summary: List series (dimension combinations) from metric. + signature: 'list_metric_series_definitions(metric_id: str, active_since: datetime, + **kwargs: Any) -> AsyncItemPaged[MetricSeriesDefinition]' + parameters: + - name: metric_id + description: metric unique id. + isRequired: true + types: + - + - name: active_since + description: 'Required. query series ingested after this time, the format should + be + + yyyy-MM-ddTHH:mm:ssZ.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: skip + types: + - + - name: dimension_filter + description: filter specific dimension name and values. + types: + - [, []] + return: + description: Series (dimension combinations) from metric. + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "Query metric series definitions.\n\n\n\n````python\n\n import datetime\n from azure.ai.metricsadvisor\ + \ import MetricsAdvisorKeyCredential\n from azure.ai.metricsadvisor.aio import\ + \ MetricsAdvisorClient\n\n service_endpoint = os.getenv(\"METRICS_ADVISOR_ENDPOINT\"\ + )\n subscription_key = os.getenv(\"METRICS_ADVISOR_SUBSCRIPTION_KEY\")\n api_key\ + \ = os.getenv(\"METRICS_ADVISOR_API_KEY\")\n metric_id = os.getenv(\"METRICS_ADVISOR_METRIC_ID\"\ + )\n\n client = MetricsAdvisorClient(service_endpoint,\n \ + \ MetricsAdvisorKeyCredential(subscription_key, api_key))\n\n async\ + \ with client:\n results = client.list_metric_series_definitions(\n \ + \ metric_id=metric_id,\n active_since=datetime.datetime(2020,\ + \ 1, 1),\n )\n async for result in results:\n print(str(result))\n\ + \n\n ````\n" diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.aio.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.aio.yml new file mode 100644 index 00000000..b37427bc --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.aio.yml @@ -0,0 +1,8 @@ +### YamlMime:PythonPackage +uid: azure.ai.metricsadvisor.aio +name: aio +fullName: azure.ai.metricsadvisor.aio +type: import +classes: +- azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient +- azure.ai.metricsadvisor.aio.MetricsAdvisorClient diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AlertQueryTimeMode.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AlertQueryTimeMode.yml new file mode 100644 index 00000000..994d8905 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AlertQueryTimeMode.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.ai.metricsadvisor.models.AlertQueryTimeMode +name: AlertQueryTimeMode +fullName: azure.ai.metricsadvisor.models.AlertQueryTimeMode +summary: time mode +module: azure.ai.metricsadvisor.models +fields: +- name: ANOMALY_TIME + uid: azure.ai.metricsadvisor.models.AlertQueryTimeMode.ANOMALY_TIME +- name: CREATED_TIME + uid: azure.ai.metricsadvisor.models.AlertQueryTimeMode.CREATED_TIME +- name: MODIFIED_TIME + uid: azure.ai.metricsadvisor.models.AlertQueryTimeMode.MODIFIED_TIME diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyAlert.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyAlert.yml new file mode 100644 index 00000000..90d7372f --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyAlert.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.AnomalyAlert +name: AnomalyAlert +fullName: azure.ai.metricsadvisor.models.AnomalyAlert +module: azure.ai.metricsadvisor.models +constructor: + syntax: AnomalyAlert(**kwargs) +variables: +- description: alert id. + name: id + types: + - +- description: anomaly time. + name: timestamp + types: + - +- description: created time. + name: created_time + types: + - +- description: modified time. + name: modified_time + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.AnomalyAlert.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AnomalyAlert.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AnomalyAlert.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.AnomalyAlert.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AnomalyAlert.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.AnomalyAlert.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AnomalyAlert.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyAlertConfiguration.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyAlertConfiguration.yml new file mode 100644 index 00000000..10979aaa --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyAlertConfiguration.yml @@ -0,0 +1,155 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.AnomalyAlertConfiguration +name: AnomalyAlertConfiguration +fullName: azure.ai.metricsadvisor.models.AnomalyAlertConfiguration +module: azure.ai.metricsadvisor.models +summary: AnomalyAlertConfiguration. +constructor: + syntax: 'AnomalyAlertConfiguration(name: str, metric_alert_configurations: List[MetricAlertConfiguration], + hook_ids: List[str], **kwargs: Any)' + parameters: + - name: name + description: Required. anomaly alert configuration name. + isRequired: true + types: + - + - name: hook_ids + description: Required. hook unique ids. + isRequired: true + types: + - [] + - name: metric_alert_configurations + description: Required. Anomaly alert configurations. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: dimensions_to_split_alert + description: dimensions used to split alert. + types: + - [] +variables: +- description: anomaly alert configuration unique id. + name: id + types: + - +- description: anomaly alert configuration description. + name: description + types: + - +- description: 'cross metrics operator + + should be specified when setting up multiple metric alert configurations. Possible + values + + include: "AND", "OR", "XOR".' + name: cross_metrics_operator + types: + - + - +methods: +- uid: azure.ai.metricsadvisor.models.AnomalyAlertConfiguration.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AnomalyAlertConfiguration.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AnomalyAlertConfiguration.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.AnomalyAlertConfiguration.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AnomalyAlertConfiguration.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.AnomalyAlertConfiguration.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AnomalyAlertConfiguration.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyDetectionConfiguration.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyDetectionConfiguration.yml new file mode 100644 index 00000000..496355a1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyDetectionConfiguration.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.AnomalyDetectionConfiguration +name: AnomalyDetectionConfiguration +fullName: azure.ai.metricsadvisor.models.AnomalyDetectionConfiguration +module: azure.ai.metricsadvisor.models +summary: AnomalyDetectionConfiguration. +constructor: + syntax: 'AnomalyDetectionConfiguration(name: str, metric_id: str, whole_series_detection_condition: + MetricDetectionCondition, **kwargs: Any)' + parameters: + - name: name + description: Required. anomaly detection configuration name. + isRequired: true + types: + - + - name: metric_id + description: Required. metric unique id. + isRequired: true + types: + - + - name: whole_series_detection_condition + description: 'Required. + + Conditions to detect anomalies in all time series of a metric.' + isRequired: true + types: + - +variables: +- description: anomaly detection configuration description. + name: description + types: + - +- description: anomaly detection configuration unique id. + name: id + types: + - +- description: detection configuration for series group. + name: series_group_detection_conditions + types: + - [] +- description: detection configuration for specific series. + name: series_detection_conditions + types: + - [] +methods: +- uid: azure.ai.metricsadvisor.models.AnomalyDetectionConfiguration.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AnomalyDetectionConfiguration.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AnomalyDetectionConfiguration.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.AnomalyDetectionConfiguration.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AnomalyDetectionConfiguration.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.AnomalyDetectionConfiguration.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AnomalyDetectionConfiguration.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyDetectorDirection.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyDetectorDirection.yml new file mode 100644 index 00000000..21f61d57 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyDetectorDirection.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.ai.metricsadvisor.models.AnomalyDetectorDirection +name: AnomalyDetectorDirection +fullName: azure.ai.metricsadvisor.models.AnomalyDetectorDirection +summary: detection direction. +module: azure.ai.metricsadvisor.models +fields: +- name: BOTH + uid: azure.ai.metricsadvisor.models.AnomalyDetectorDirection.BOTH +- name: DOWN + uid: azure.ai.metricsadvisor.models.AnomalyDetectorDirection.DOWN +- name: UP + uid: azure.ai.metricsadvisor.models.AnomalyDetectorDirection.UP diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyFeedback.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyFeedback.yml new file mode 100644 index 00000000..6433a971 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyFeedback.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.AnomalyFeedback +name: AnomalyFeedback +fullName: azure.ai.metricsadvisor.models.AnomalyFeedback +module: azure.ai.metricsadvisor.models +summary: 'AnomalyFeedback. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: AnomalyFeedback(metric_id, dimension_key, start_time, end_time, value, **kwargs) + parameters: + - name: metric_id + description: Required. metric unique id. + isRequired: true + types: + - + - name: dimension_key + description: Required. metric dimension filter. + isRequired: true + types: + - [, ] + - name: start_time + description: Required. the start timestamp of feedback timerange. + isRequired: true + types: + - + - name: end_time + description: 'Required. the end timestamp of feedback timerange, when equals to + startTime + + means only one timestamp.' + isRequired: true + types: + - + - name: value + description: 'Required. Possible values include: "AutoDetect", "Anomaly", "NotAnomaly".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: created_time + description: feedback created time. + types: + - + - name: user_principal + description: user who gives this feedback. + types: + - + - name: anomaly_detection_configuration_id + description: 'the corresponding anomaly detection configuration of + + this feedback.' + types: + - + - name: anomaly_detection_configuration_snapshot + types: + - +variables: +- description: 'Required. feedback type.Constant filled by server. Possible values + + include: "Anomaly", "ChangePoint", "Period", "Comment".' + name: feedback_type + types: + - + - +- description: feedback unique id. + name: id + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.AnomalyFeedback.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.AnomalyFeedback.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.AnomalyFeedback.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.AnomalyFeedback.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.AnomalyFeedback.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.AnomalyFeedback.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.AnomalyFeedback.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.AnomalyFeedback.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.AnomalyFeedback.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.AnomalyFeedback.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.AnomalyFeedback.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyIncident.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyIncident.yml new file mode 100644 index 00000000..375a6419 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyIncident.yml @@ -0,0 +1,187 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.AnomalyIncident +name: AnomalyIncident +fullName: azure.ai.metricsadvisor.models.AnomalyIncident +module: azure.ai.metricsadvisor.models +summary: 'AnomalyIncident. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'AnomalyIncident(*, id: str, start_time: datetime, last_time: datetime, + severity: str | _models.AnomalySeverity, dimension_key: Dict[str, str], **kwargs)' + parameters: + - name: dimension_key + description: dimension specified for series. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: id + description: incident id. Required. + types: + - + - name: start_time + description: incident start time. Required. + types: + - + - name: last_time + description: incident last time. Required. + types: + - + - name: severity + description: 'max severity of latest anomalies in the incident. Required. Known + values + + are: "Low", "Medium", and "High".' + types: + - + - + - name: dimension_key + description: dimension specified for series group. Required. + types: + - [, ] +variables: +- description: metric unique id. Only returned for alerting incident result. + name: metric_id + types: + - +- description: 'anomaly detection configuration unique id. + + Only returned for alerting incident result.' + name: detection_configuration_id + types: + - +- description: incident id. + name: id + types: + - +- description: incident start time. + name: start_time + types: + - +- description: incident last time. + name: last_time + types: + - +- description: 'max severity of latest anomalies in the incident. Possible values + include: + + "Low", "Medium", "High".' + name: severity + types: + - + - +- description: 'incident status + + only return for alerting incident result. Possible values include: "Active", "Resolved".' + name: status + types: + - + - +methods: +- uid: azure.ai.metricsadvisor.models.AnomalyIncident.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AnomalyIncident.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AnomalyIncident.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.AnomalyIncident.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AnomalyIncident.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.AnomalyIncident.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AnomalyIncident.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyIncidentStatus.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyIncidentStatus.yml new file mode 100644 index 00000000..378629f7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyIncidentStatus.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.ai.metricsadvisor.models.AnomalyIncidentStatus +name: AnomalyIncidentStatus +fullName: azure.ai.metricsadvisor.models.AnomalyIncidentStatus +summary: 'incident status + + + only return for alerting incident result.' +module: azure.ai.metricsadvisor.models +fields: +- name: ACTIVE + uid: azure.ai.metricsadvisor.models.AnomalyIncidentStatus.ACTIVE +- name: RESOLVED + uid: azure.ai.metricsadvisor.models.AnomalyIncidentStatus.RESOLVED diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalySeverity.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalySeverity.yml new file mode 100644 index 00000000..489102ad --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalySeverity.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.ai.metricsadvisor.models.AnomalySeverity +name: AnomalySeverity +fullName: azure.ai.metricsadvisor.models.AnomalySeverity +summary: min alert severity. +module: azure.ai.metricsadvisor.models +fields: +- name: HIGH + uid: azure.ai.metricsadvisor.models.AnomalySeverity.HIGH +- name: LOW + uid: azure.ai.metricsadvisor.models.AnomalySeverity.LOW +- name: MEDIUM + uid: azure.ai.metricsadvisor.models.AnomalySeverity.MEDIUM diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyValue.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyValue.yml new file mode 100644 index 00000000..c56e255b --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyValue.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.ai.metricsadvisor.models.AnomalyValue +name: AnomalyValue +fullName: azure.ai.metricsadvisor.models.AnomalyValue +summary: AnomalyValue. +module: azure.ai.metricsadvisor.models +fields: +- name: ANOMALY + uid: azure.ai.metricsadvisor.models.AnomalyValue.ANOMALY +- name: AUTO_DETECT + uid: azure.ai.metricsadvisor.models.AnomalyValue.AUTO_DETECT +- name: NOT_ANOMALY + uid: azure.ai.metricsadvisor.models.AnomalyValue.NOT_ANOMALY diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.yml new file mode 100644 index 00000000..ddd56de7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.yml @@ -0,0 +1,232 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource +name: AzureApplicationInsightsDataFeedSource +fullName: azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource +module: azure.ai.metricsadvisor.models +summary: AzureApplicationInsightsDataFeedSource. +constructor: + syntax: 'AzureApplicationInsightsDataFeedSource(query: str, **kwargs: Any)' + parameters: + - name: query + description: Required. Query. + isRequired: true + types: + - + keywordOnlyParameters: + - name: credential_id + description: The datasource credential id. + types: + - + - name: azure_cloud + description: Azure cloud environment. + types: + - + - name: application_id + description: Azure Application Insights ID. + types: + - + - name: api_key + description: API Key. + types: + - +variables: +- description: 'Required. data source type.Constant filled by server. Possible values + + include: "AzureApplicationInsights", "AzureBlob", "AzureCosmosDB", "AzureDataExplorer", + + "AzureDataLakeStorageGen2", "AzureEventHubs", "AzureLogAnalytics", "AzureTable", + "InfluxDB", + + "MongoDB", "MySql", "PostgreSql", "SqlServer".' + name: data_source_type + types: + - + - +- description: 'authentication type for corresponding data source. Possible values + + include: "Basic", "ManagedIdentity", "AzureSQLConnectionString", "DataLakeGen2SharedKey", + + "ServicePrincipal", "ServicePrincipalInKV". Default is "Basic".' + name: authentication_type + types: + - + - +methods: +- uid: azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +- uid: azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.yml new file mode 100644 index 00000000..104d56ca --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.yml @@ -0,0 +1,233 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.AzureBlobDataFeedSource +name: AzureBlobDataFeedSource +fullName: azure.ai.metricsadvisor.models.AzureBlobDataFeedSource +module: azure.ai.metricsadvisor.models +summary: AzureBlobDataFeedSource. +constructor: + syntax: 'AzureBlobDataFeedSource(container: str, blob_template: str, **kwargs: Any)' + parameters: + - name: container + description: Required. Container. + isRequired: true + types: + - + - name: blob_template + description: Required. Blob Template. + isRequired: true + types: + - + keywordOnlyParameters: + - name: credential_id + description: The datasource credential id. + types: + - + - name: connection_string + description: Azure Blob connection string. + types: + - + - name: msi + description: If using managed identity authentication. + types: + - +variables: +- description: 'Required. data source type.Constant filled by server. Possible values + + include: "AzureApplicationInsights", "AzureBlob", "AzureCosmosDB", "AzureDataExplorer", + + "AzureDataLakeStorageGen2", "AzureEventHubs", "AzureLogAnalytics", "AzureTable", + "InfluxDB", + + "MongoDB", "MySql", "PostgreSql", "SqlServer".' + name: data_source_type + types: + - + - +- description: 'authentication type for corresponding data source. Possible values + + include: "Basic", "ManagedIdentity", "AzureSQLConnectionString", "DataLakeGen2SharedKey", + + "ServicePrincipal", "ServicePrincipalInKV". Default is "Basic".' + name: authentication_type + types: + - + - +methods: +- uid: azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +- uid: azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.yml new file mode 100644 index 00000000..70c230a7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.yml @@ -0,0 +1,235 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource +name: AzureCosmosDbDataFeedSource +fullName: azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource +module: azure.ai.metricsadvisor.models +summary: AzureCosmosDbDataFeedSource. +constructor: + syntax: 'AzureCosmosDbDataFeedSource(sql_query: str, database: str, collection_id: + str, **kwargs: Any)' + parameters: + - name: sql_query + description: Required. Query script. + isRequired: true + types: + - + - name: database + description: Required. Database name. + isRequired: true + types: + - + - name: collection_id + description: Required. Collection id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: credential_id + description: The datasource credential id. + types: + - + - name: connection_string + description: Azure CosmosDB connection string. + types: + - +variables: +- description: 'Required. data source type.Constant filled by server. Possible values + + include: "AzureApplicationInsights", "AzureBlob", "AzureCosmosDB", "AzureDataExplorer", + + "AzureDataLakeStorageGen2", "AzureEventHubs", "AzureLogAnalytics", "AzureTable", + "InfluxDB", + + "MongoDB", "MySql", "PostgreSql", "SqlServer".' + name: data_source_type + types: + - + - +- description: 'authentication type for corresponding data source. Possible values + + include: "Basic", "ManagedIdentity", "AzureSQLConnectionString", "DataLakeGen2SharedKey", + + "ServicePrincipal", "ServicePrincipalInKV". Default is "Basic".' + name: authentication_type + types: + - + - +methods: +- uid: azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +- uid: azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.yml new file mode 100644 index 00000000..5abf5cf5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.yml @@ -0,0 +1,236 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource +name: AzureDataExplorerDataFeedSource +fullName: azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource +module: azure.ai.metricsadvisor.models +summary: AzureDataExplorerDataFeedSource. +constructor: + syntax: 'AzureDataExplorerDataFeedSource(query: str, **kwargs: Any)' + parameters: + - name: query + description: Required. Query script. + isRequired: true + types: + - + keywordOnlyParameters: + - name: credential_id + description: The datasource credential id. + types: + - + - name: connection_string + description: Database connection string. + types: + - + - name: msi + description: If using managed identity authentication. + types: + - + - name: datasource_service_principal_id + description: Datasource service principal unique id. + types: + - + - name: datasource_service_principal_in_kv_id + description: Datasource service principal in key vault unique id. + types: + - +variables: +- description: 'Required. data source type.Constant filled by server. Possible values + + include: "AzureApplicationInsights", "AzureBlob", "AzureCosmosDB", "AzureDataExplorer", + + "AzureDataLakeStorageGen2", "AzureEventHubs", "AzureLogAnalytics", "AzureTable", + "InfluxDB", + + "MongoDB", "MySql", "PostgreSql", "SqlServer".' + name: data_source_type + types: + - + - +- description: 'authentication type for corresponding data source. Possible values + + include: "Basic", "ManagedIdentity", "AzureSQLConnectionString", "DataLakeGen2SharedKey", + + "ServicePrincipal", "ServicePrincipalInKV". Default is "Basic".' + name: authentication_type + types: + - + - +methods: +- uid: azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +- uid: azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.yml new file mode 100644 index 00000000..576cd8a6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.yml @@ -0,0 +1,255 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource +name: AzureDataLakeStorageGen2DataFeedSource +fullName: azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource +module: azure.ai.metricsadvisor.models +summary: AzureDataLakeStorageGen2DataFeedSource. +constructor: + syntax: 'AzureDataLakeStorageGen2DataFeedSource(file_system_name: str, directory_template: + str, file_template: str, **kwargs: Any)' + parameters: + - name: file_system_name + description: Required. File system name (Container). + isRequired: true + types: + - + - name: directory_template + description: Required. Directory template. + isRequired: true + types: + - + - name: file_template + description: Required. File template. + isRequired: true + types: + - + keywordOnlyParameters: + - name: credential_id + description: The datasource credential id. + types: + - + - name: account_name + description: Account name. + types: + - + - name: account_key + description: Account key. + types: + - + - name: msi + description: If using managed identity authentication. + types: + - + - name: datasource_service_principal_id + description: Datasource service principal unique id. + types: + - + - name: datasource_service_principal_in_kv_id + description: Datasource service principal in key vault unique id. + types: + - + - name: datasource_datalake_gen2_shared_key_id + description: Datasource datalake gen2 shared key unique id. + types: + - +variables: +- description: 'Required. data source type.Constant filled by server. Possible values + + include: "AzureApplicationInsights", "AzureBlob", "AzureCosmosDB", "AzureDataExplorer", + + "AzureDataLakeStorageGen2", "AzureEventHubs", "AzureLogAnalytics", "AzureTable", + "InfluxDB", + + "MongoDB", "MySql", "PostgreSql", "SqlServer".' + name: data_source_type + types: + - + - +- description: 'authentication type for corresponding data source. Possible values + + include: "Basic", "ManagedIdentity", "AzureSQLConnectionString", "DataLakeGen2SharedKey", + + "ServicePrincipal", "ServicePrincipalInKV". Default is "Basic".' + name: authentication_type + types: + - + - +methods: +- uid: azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +- uid: azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.yml new file mode 100644 index 00000000..5357039a --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.yml @@ -0,0 +1,224 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource +name: AzureEventHubsDataFeedSource +fullName: azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource +module: azure.ai.metricsadvisor.models +summary: AzureEventHubsDataFeedSource. +constructor: + syntax: 'AzureEventHubsDataFeedSource(consumer_group: str, **kwargs: Any)' + parameters: + - name: consumer_group + description: Required. The consumer group to be used in this data feed. + isRequired: true + types: + - + keywordOnlyParameters: + - name: credential_id + description: The datasource credential id. + types: + - + - name: connection_string + description: The connection string of this Azure Event Hubs. + types: + - +variables: +- description: 'Required. data source type.Constant filled by server. Possible values + + include: "AzureApplicationInsights", "AzureBlob", "AzureCosmosDB", "AzureDataExplorer", + + "AzureDataLakeStorageGen2", "AzureEventHubs", "AzureLogAnalytics", "AzureTable", + "InfluxDB", + + "MongoDB", "MySql", "PostgreSql", "SqlServer".' + name: data_source_type + types: + - + - +- description: 'authentication type for corresponding data source. Possible values + + include: "Basic", "ManagedIdentity", "AzureSQLConnectionString", "DataLakeGen2SharedKey", + + "ServicePrincipal", "ServicePrincipalInKV". Default is "Basic".' + name: authentication_type + types: + - + - +methods: +- uid: azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +- uid: azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.yml new file mode 100644 index 00000000..75036cf9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.yml @@ -0,0 +1,254 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource +name: AzureLogAnalyticsDataFeedSource +fullName: azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource +module: azure.ai.metricsadvisor.models +summary: AzureLogAnalyticsDataFeedSource. +constructor: + syntax: 'AzureLogAnalyticsDataFeedSource(workspace_id: str, query: str, **kwargs: + Any)' + parameters: + - name: workspace_id + description: Required. The workspace id of this Log Analytics. + isRequired: true + types: + - + - name: query + description: 'Required. The KQL (Kusto Query Language) query to fetch data from + this Log + + Analytics.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: credential_id + description: The datasource credential id. + types: + - + - name: tenant_id + description: 'The tenant id of service principal that have access to this Log + + Analytics.' + types: + - + - name: client_id + description: 'The client id of service principal that have access to this Log + + Analytics.' + types: + - + - name: client_secret + description: The client secret of service principal that have access to this Log + Analytics. + types: + - + - name: datasource_service_principal_id + description: Datasource service principal unique id. + types: + - + - name: datasource_service_principal_in_kv_id + description: Datasource service principal in key vault unique id. + types: + - +variables: +- description: 'Required. data source type.Constant filled by server. Possible values + + include: "AzureApplicationInsights", "AzureBlob", "AzureCosmosDB", "AzureDataExplorer", + + "AzureDataLakeStorageGen2", "AzureEventHubs", "AzureLogAnalytics", "AzureTable", + "InfluxDB", + + "MongoDB", "MySql", "PostgreSql", "SqlServer".' + name: data_source_type + types: + - + - +- description: 'authentication type for corresponding data source. Possible values + + include: "Basic", "ManagedIdentity", "AzureSQLConnectionString", "DataLakeGen2SharedKey", + + "ServicePrincipal", "ServicePrincipalInKV". Default is "Basic".' + name: authentication_type + types: + - + - +methods: +- uid: azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +- uid: azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureTableDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureTableDataFeedSource.yml new file mode 100644 index 00000000..68cc7641 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureTableDataFeedSource.yml @@ -0,0 +1,229 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.AzureTableDataFeedSource +name: AzureTableDataFeedSource +fullName: azure.ai.metricsadvisor.models.AzureTableDataFeedSource +module: azure.ai.metricsadvisor.models +summary: AzureTableDataFeedSource. +constructor: + syntax: 'AzureTableDataFeedSource(query: str, table: str, **kwargs: Any)' + parameters: + - name: query + description: Required. Query script. + isRequired: true + types: + - + - name: table + description: Required. Table name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: credential_id + description: The datasource credential id. + types: + - + - name: connection_string + description: Azure Table connection string. + types: + - +variables: +- description: 'Required. data source type.Constant filled by server. Possible values + + include: "AzureApplicationInsights", "AzureBlob", "AzureCosmosDB", "AzureDataExplorer", + + "AzureDataLakeStorageGen2", "AzureEventHubs", "AzureLogAnalytics", "AzureTable", + "InfluxDB", + + "MongoDB", "MySql", "PostgreSql", "SqlServer".' + name: data_source_type + types: + - + - +- description: 'authentication type for corresponding data source. Possible values + + include: "Basic", "ManagedIdentity", "AzureSQLConnectionString", "DataLakeGen2SharedKey", + + "ServicePrincipal", "ServicePrincipalInKV". Default is "Basic".' + name: authentication_type + types: + - + - +methods: +- uid: azure.ai.metricsadvisor.models.AzureTableDataFeedSource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AzureTableDataFeedSource.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.AzureTableDataFeedSource.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.AzureTableDataFeedSource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AzureTableDataFeedSource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.AzureTableDataFeedSource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.AzureTableDataFeedSource.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.AzureTableDataFeedSource.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.AzureTableDataFeedSource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.AzureTableDataFeedSource.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.AzureTableDataFeedSource.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.AzureTableDataFeedSource.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.AzureTableDataFeedSource.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.AzureTableDataFeedSource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.AzureTableDataFeedSource.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.AzureTableDataFeedSource.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.AzureTableDataFeedSource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +- uid: azure.ai.metricsadvisor.models.AzureTableDataFeedSource.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.ChangePointFeedback.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.ChangePointFeedback.yml new file mode 100644 index 00000000..d952e2f1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.ChangePointFeedback.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.ChangePointFeedback +name: ChangePointFeedback +fullName: azure.ai.metricsadvisor.models.ChangePointFeedback +module: azure.ai.metricsadvisor.models +summary: 'ChangePointFeedback. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ChangePointFeedback(metric_id, dimension_key, start_time, end_time, value, + **kwargs) + parameters: + - name: metric_id + description: Required. metric unique id. + isRequired: true + types: + - + - name: dimension_key + description: Required. metric dimension filter. + isRequired: true + types: + - [, ] + - name: start_time + description: Required. the start timestamp of feedback timerange. + isRequired: true + types: + - + - name: end_time + description: 'Required. the end timestamp of feedback timerange, when equals to + startTime + + means only one timestamp.' + isRequired: true + types: + - + - name: value + description: 'Required. Possible values include: "AutoDetect", "ChangePoint", + "NotChangePoint".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: created_time + description: feedback created time. + types: + - + - name: user_principal + description: user who gives this feedback. + types: + - +variables: +- description: 'Required. feedback type.Constant filled by server. Possible values + + include: "Anomaly", "ChangePoint", "Period", "Comment".' + name: feedback_type + types: + - + - +- description: feedback unique id. + name: id + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.ChangePointFeedback.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.ChangePointFeedback.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.ChangePointFeedback.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.ChangePointFeedback.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.ChangePointFeedback.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.ChangePointFeedback.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.ChangePointFeedback.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.ChangePointFeedback.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.ChangePointFeedback.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.ChangePointFeedback.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.ChangePointFeedback.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.ChangePointValue.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.ChangePointValue.yml new file mode 100644 index 00000000..4ebe0a9f --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.ChangePointValue.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.ai.metricsadvisor.models.ChangePointValue +name: ChangePointValue +fullName: azure.ai.metricsadvisor.models.ChangePointValue +summary: ChangePointValue. +module: azure.ai.metricsadvisor.models +fields: +- name: AUTO_DETECT + uid: azure.ai.metricsadvisor.models.ChangePointValue.AUTO_DETECT +- name: CHANGE_POINT + uid: azure.ai.metricsadvisor.models.ChangePointValue.CHANGE_POINT +- name: NOT_CHANGE_POINT + uid: azure.ai.metricsadvisor.models.ChangePointValue.NOT_CHANGE_POINT diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.ChangeThresholdCondition.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.ChangeThresholdCondition.yml new file mode 100644 index 00000000..2765ffa6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.ChangeThresholdCondition.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.ChangeThresholdCondition +name: ChangeThresholdCondition +fullName: azure.ai.metricsadvisor.models.ChangeThresholdCondition +module: azure.ai.metricsadvisor.models +summary: ChangeThresholdCondition. +constructor: + syntax: 'ChangeThresholdCondition(change_percentage: float, shift_point: int, within_range: + bool, anomaly_detector_direction: str | AnomalyDetectorDirection, suppress_condition: + SuppressCondition, **kwargs: Any)' + parameters: + - name: change_percentage + description: "Required. change percentage, value range : [0, +\u221E)." + isRequired: true + types: + - + - name: shift_point + description: "Required. shift point, value range : [1, +\u221E)." + isRequired: true + types: + - + - name: within_range + description: 'Required. if the withinRange = true, detected data is abnormal when + the + + value falls in the range, in this case anomalyDetectorDirection must be Both + + if the withinRange = false, detected data is abnormal when the value falls out + of the range.' + isRequired: true + types: + - + - name: anomaly_detector_direction + description: 'Required. detection direction. Possible values include: + + "Both", "Down", "Up".' + isRequired: true + types: + - + - + - name: suppress_condition + description: Required. + isRequired: true + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.ChangeThresholdCondition.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.ChangeThresholdCondition.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.ChangeThresholdCondition.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.ChangeThresholdCondition.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.ChangeThresholdCondition.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.ChangeThresholdCondition.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.ChangeThresholdCondition.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.CommentFeedback.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.CommentFeedback.yml new file mode 100644 index 00000000..cbbe5d9d --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.CommentFeedback.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.CommentFeedback +name: CommentFeedback +fullName: azure.ai.metricsadvisor.models.CommentFeedback +module: azure.ai.metricsadvisor.models +summary: 'CommentFeedback. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CommentFeedback(metric_id, dimension_key, start_time, end_time, value, **kwargs) + parameters: + - name: metric_id + description: Required. metric unique id. + isRequired: true + types: + - + - name: dimension_key + description: Required. metric dimension filter. + isRequired: true + types: + - [, ] + - name: start_time + description: the start timestamp of feedback timerange. + isRequired: true + types: + - + - name: end_time + description: 'the end timestamp of feedback timerange, when equals to startTime + means only + + one timestamp.' + isRequired: true + types: + - + - name: value + description: Required. the comment string. + isRequired: true + types: + - + keywordOnlyParameters: + - name: created_time + description: feedback created time. + types: + - + - name: user_principal + description: user who gives this feedback. + types: + - +variables: +- description: 'Required. feedback type.Constant filled by server. Possible values + + include: "Anomaly", "ChangePoint", "Period", "Comment".' + name: feedback_type + types: + - + - +- description: feedback unique id. + name: id + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.CommentFeedback.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.CommentFeedback.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.CommentFeedback.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.CommentFeedback.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.CommentFeedback.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.CommentFeedback.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.CommentFeedback.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.CommentFeedback.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.CommentFeedback.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.CommentFeedback.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.CommentFeedback.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeed.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeed.yml new file mode 100644 index 00000000..7e5167d4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeed.yml @@ -0,0 +1,229 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.DataFeed +name: DataFeed +fullName: azure.ai.metricsadvisor.models.DataFeed +module: azure.ai.metricsadvisor.models +summary: Represents a data feed. +constructor: + syntax: 'DataFeed(name: str, source: DataFeedSourceUnion, granularity: DataFeedGranularity, + schema: DataFeedSchema, ingestion_settings: DataFeedIngestionSettings, **kwargs: + Any)' + parameters: + - name: name + description: Data feed name. + isRequired: true + types: + - + - name: schema + description: Data feed schema + isRequired: true + types: + - + - name: source + description: Data feed source. + isRequired: true + types: + - [, + , , + , , + , , + , , + , , + , ] + - name: granularity + description: Granularity of the time series. + isRequired: true + types: + - + - name: ingestion_settings + description: Data feed ingestion settings. + isRequired: true + types: + - +variables: +- description: Data feed created time. + name: created_time + types: + - +- description: Granularity of the time series. + name: granularity + types: + - +- description: Data feed unique id. + name: id + types: + - +- description: Data feed ingestion settings. + name: ingestion_settings + types: + - +- description: Whether the query user is one of data feed administrators or not. + name: is_admin + types: + - +- description: metric name and metric id dict + name: metric_ids + types: + - +- description: Data feed name. + name: name + types: + - +- description: Data feed schema + name: schema + types: + - +- description: Data feed source. + name: source + types: + - [, + , , + , , + , , + , , + , , + , ] +- description: 'Data feed status. Possible values include: "Active", "Paused". + + Default value: "Active".' + name: status + types: + - + - +- description: Data feed administrators. + name: admins + types: + - [] +- description: Data feed description. + name: data_feed_description + types: + - +- description: The fill missing point type and value. + name: missing_data_point_fill_settings + types: + - +- description: The rollup settings. + name: rollup_settings + types: + - +- description: Data feed viewers. + name: viewers + types: + - [] +- description: 'Data feed access mode. Possible values include: + + "Private", "Public". Default value: "Private".' + name: access_mode + types: + - + - +- description: action link for alert. + name: action_link_template + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.DataFeed.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DataFeed.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DataFeed.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.DataFeed.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DataFeed.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.DataFeed.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DataFeed.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedAccessMode.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedAccessMode.yml new file mode 100644 index 00000000..f0b18776 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedAccessMode.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.ai.metricsadvisor.models.DataFeedAccessMode +name: DataFeedAccessMode +fullName: azure.ai.metricsadvisor.models.DataFeedAccessMode +summary: data feed access mode, default is Private. +module: azure.ai.metricsadvisor.models +fields: +- name: PRIVATE + uid: azure.ai.metricsadvisor.models.DataFeedAccessMode.PRIVATE +- name: PUBLIC + uid: azure.ai.metricsadvisor.models.DataFeedAccessMode.PUBLIC diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedAutoRollupMethod.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedAutoRollupMethod.yml new file mode 100644 index 00000000..fca132cb --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedAutoRollupMethod.yml @@ -0,0 +1,19 @@ +### YamlMime:PythonEnum +uid: azure.ai.metricsadvisor.models.DataFeedAutoRollupMethod +name: DataFeedAutoRollupMethod +fullName: azure.ai.metricsadvisor.models.DataFeedAutoRollupMethod +summary: roll up method. +module: azure.ai.metricsadvisor.models +fields: +- name: AVG + uid: azure.ai.metricsadvisor.models.DataFeedAutoRollupMethod.AVG +- name: COUNT + uid: azure.ai.metricsadvisor.models.DataFeedAutoRollupMethod.COUNT +- name: MAX + uid: azure.ai.metricsadvisor.models.DataFeedAutoRollupMethod.MAX +- name: MIN + uid: azure.ai.metricsadvisor.models.DataFeedAutoRollupMethod.MIN +- name: NONE + uid: azure.ai.metricsadvisor.models.DataFeedAutoRollupMethod.NONE +- name: SUM + uid: azure.ai.metricsadvisor.models.DataFeedAutoRollupMethod.SUM diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedDimension.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedDimension.yml new file mode 100644 index 00000000..01f2f13b --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedDimension.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.DataFeedDimension +name: DataFeedDimension +fullName: azure.ai.metricsadvisor.models.DataFeedDimension +module: azure.ai.metricsadvisor.models +summary: DataFeedDimension. +constructor: + syntax: 'DataFeedDimension(name: str, **kwargs: Any)' + parameters: + - name: name + description: Required. dimension name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: display_name + description: dimension display name. + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.DataFeedDimension.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DataFeedDimension.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DataFeedDimension.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.DataFeedDimension.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DataFeedDimension.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.DataFeedDimension.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DataFeedDimension.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedGranularity.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedGranularity.yml new file mode 100644 index 00000000..735c156c --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedGranularity.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.DataFeedGranularity +name: DataFeedGranularity +fullName: azure.ai.metricsadvisor.models.DataFeedGranularity +module: azure.ai.metricsadvisor.models +summary: Data feed granularity +constructor: + syntax: 'DataFeedGranularity(granularity_type: str | DataFeedGranularityType, **kwargs: + Any)' + parameters: + - name: granularity_type + description: 'Granularity of the time series. Possible values include: + + "Yearly", "Monthly", "Weekly", "Daily", "Hourly", "Minutely", "Secondly", "Custom".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: custom_granularity_value + description: Must be populated if granularity_type is "Custom". + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedGranularityType.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedGranularityType.yml new file mode 100644 index 00000000..1e2a6f2a --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedGranularityType.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonEnum +uid: azure.ai.metricsadvisor.models.DataFeedGranularityType +name: DataFeedGranularityType +fullName: azure.ai.metricsadvisor.models.DataFeedGranularityType +summary: granularity of the time series. +module: azure.ai.metricsadvisor.models +fields: +- name: CUSTOM + uid: azure.ai.metricsadvisor.models.DataFeedGranularityType.CUSTOM +- name: DAILY + uid: azure.ai.metricsadvisor.models.DataFeedGranularityType.DAILY +- name: HOURLY + uid: azure.ai.metricsadvisor.models.DataFeedGranularityType.HOURLY +- name: MINUTELY + uid: azure.ai.metricsadvisor.models.DataFeedGranularityType.MINUTELY +- name: MONTHLY + uid: azure.ai.metricsadvisor.models.DataFeedGranularityType.MONTHLY +- name: WEEKLY + uid: azure.ai.metricsadvisor.models.DataFeedGranularityType.WEEKLY +- name: YEARLY + uid: azure.ai.metricsadvisor.models.DataFeedGranularityType.YEARLY diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedIngestionProgress.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedIngestionProgress.yml new file mode 100644 index 00000000..927a0110 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedIngestionProgress.yml @@ -0,0 +1,127 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.DataFeedIngestionProgress +name: DataFeedIngestionProgress +fullName: azure.ai.metricsadvisor.models.DataFeedIngestionProgress +module: azure.ai.metricsadvisor.models +summary: DataFeedIngestionProgress. +constructor: + syntax: DataFeedIngestionProgress(**kwargs) +variables: +- description: 'the timestamp of lastest success ingestion job. + + null indicates not available.' + name: latest_success_timestamp + types: + - +- description: 'the timestamp of lastest ingestion job with status update. + + null indicates not available.' + name: latest_active_timestamp + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.DataFeedIngestionProgress.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DataFeedIngestionProgress.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DataFeedIngestionProgress.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.DataFeedIngestionProgress.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DataFeedIngestionProgress.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.DataFeedIngestionProgress.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DataFeedIngestionProgress.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedIngestionSettings.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedIngestionSettings.yml new file mode 100644 index 00000000..190a62be --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedIngestionSettings.yml @@ -0,0 +1,37 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.DataFeedIngestionSettings +name: DataFeedIngestionSettings +fullName: azure.ai.metricsadvisor.models.DataFeedIngestionSettings +module: azure.ai.metricsadvisor.models +summary: Data feed ingestion settings. +constructor: + syntax: 'DataFeedIngestionSettings(ingestion_begin_time: datetime, **kwargs: Any)' + parameters: + - name: ingestion_begin_time + description: Ingestion start time. + isRequired: true + types: + - + keywordOnlyParameters: + - name: data_source_request_concurrency + description: 'The max concurrency of data ingestion queries against + + user data source. Zero (0) means no limitation.' + types: + - + - name: ingestion_retry_delay + description: The min retry interval for failed data ingestion tasks, in seconds. + types: + - + - name: ingestion_start_offset + description: 'The time that the beginning of data ingestion task will delay + + for every data slice according to this offset, in seconds.' + types: + - + - name: stop_retry_after + description: 'Stop retry data ingestion after the data slice first + + schedule time in seconds.' + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedIngestionStatus.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedIngestionStatus.yml new file mode 100644 index 00000000..a6956779 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedIngestionStatus.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.DataFeedIngestionStatus +name: DataFeedIngestionStatus +fullName: azure.ai.metricsadvisor.models.DataFeedIngestionStatus +module: azure.ai.metricsadvisor.models +summary: 'DataFeedIngestionStatus. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: DataFeedIngestionStatus(**kwargs) +variables: +- description: data slice timestamp. + name: timestamp + types: + - +- description: latest ingestion task status for this data slice. + name: status + types: + - +- description: the trimmed message of last ingestion job. + name: message + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.DataFeedIngestionStatus.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DataFeedIngestionStatus.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DataFeedIngestionStatus.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.DataFeedIngestionStatus.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DataFeedIngestionStatus.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.DataFeedIngestionStatus.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DataFeedIngestionStatus.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedMetric.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedMetric.yml new file mode 100644 index 00000000..55365117 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedMetric.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.DataFeedMetric +name: DataFeedMetric +fullName: azure.ai.metricsadvisor.models.DataFeedMetric +module: azure.ai.metricsadvisor.models +summary: DataFeedMetric. +constructor: + syntax: 'DataFeedMetric(name: str, **kwargs: Any)' + parameters: + - name: name + description: Required. metric name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: display_name + description: metric display name. + types: + - + - name: description + description: metric description. + types: + - +variables: +- description: metric id. + name: id + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.DataFeedMetric.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DataFeedMetric.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DataFeedMetric.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.DataFeedMetric.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DataFeedMetric.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.DataFeedMetric.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DataFeedMetric.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedMissingDataPointFillSettings.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedMissingDataPointFillSettings.yml new file mode 100644 index 00000000..4a90b9da --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedMissingDataPointFillSettings.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.DataFeedMissingDataPointFillSettings +name: DataFeedMissingDataPointFillSettings +fullName: azure.ai.metricsadvisor.models.DataFeedMissingDataPointFillSettings +module: azure.ai.metricsadvisor.models +summary: Data feed missing data point fill settings +constructor: + syntax: DataFeedMissingDataPointFillSettings(**kwargs) + keywordOnlyParameters: + - name: fill_type + description: 'The type of fill missing point for anomaly detection. Possible + + values include: "SmartFilling", "PreviousValue", "CustomValue", "NoFilling". + Default value: + + "SmartFilling".' + types: + - + - + - name: custom_fill_value + description: 'The value of fill missing point for anomaly detection + + if "CustomValue" fill type is specified.' + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedRollupSettings.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedRollupSettings.yml new file mode 100644 index 00000000..74852970 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedRollupSettings.yml @@ -0,0 +1,31 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.DataFeedRollupSettings +name: DataFeedRollupSettings +fullName: azure.ai.metricsadvisor.models.DataFeedRollupSettings +module: azure.ai.metricsadvisor.models +summary: Data feed rollup settings +constructor: + syntax: DataFeedRollupSettings(**kwargs) + keywordOnlyParameters: + - name: rollup_identification_value + description: The identification value for the row of calculated all-up value. + types: + - + - name: rollup_type + description: 'Mark if the data feed needs rollup. Possible values include: "NoRollup", + + "AutoRollup", "AlreadyRollup". Default value: "AutoRollup".' + types: + - + - + - name: auto_rollup_group_by_column_names + description: Roll up columns. + types: + - [] + - name: rollup_method + description: 'Roll up method. Possible values include: "None", "Sum", "Max", "Min", + + "Avg", "Count".' + types: + - + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedRollupType.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedRollupType.yml new file mode 100644 index 00000000..ef9b2e61 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedRollupType.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.ai.metricsadvisor.models.DataFeedRollupType +name: DataFeedRollupType +fullName: azure.ai.metricsadvisor.models.DataFeedRollupType +summary: mark if the data feed need rollup. +module: azure.ai.metricsadvisor.models +fields: +- name: ALREADY_ROLLUP + uid: azure.ai.metricsadvisor.models.DataFeedRollupType.ALREADY_ROLLUP +- name: NEED_ROLLUP + uid: azure.ai.metricsadvisor.models.DataFeedRollupType.NEED_ROLLUP +- name: NO_ROLLUP + uid: azure.ai.metricsadvisor.models.DataFeedRollupType.NO_ROLLUP diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedSchema.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedSchema.yml new file mode 100644 index 00000000..e5957329 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedSchema.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.DataFeedSchema +name: DataFeedSchema +fullName: azure.ai.metricsadvisor.models.DataFeedSchema +module: azure.ai.metricsadvisor.models +summary: Data feed schema +constructor: + syntax: 'DataFeedSchema(metrics: List[DataFeedMetric], **kwargs: Any)' + parameters: + - name: metrics + description: List of metrics. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: dimensions + description: List of dimension. + types: + - [] + - name: timestamp_column + description: 'User-defined timestamp column. + + If timestamp_column is None, start time of every time slice will be used as + default value.' + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedSource.yml new file mode 100644 index 00000000..0c9ff4ad --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedSource.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.DataFeedSource +name: DataFeedSource +fullName: azure.ai.metricsadvisor.models.DataFeedSource +module: azure.ai.metricsadvisor.models +summary: DataFeedSource base class +constructor: + syntax: 'DataFeedSource(data_source_type: str, **kwargs: Any)' + parameters: + - name: data_source_type + description: 'Required. data source type.Constant filled by server. Possible + values + + include: "AzureApplicationInsights", "AzureBlob", "AzureCosmosDB", "AzureDataExplorer", + + "AzureDataLakeStorageGen2", "AzureEventHubs", "AzureLogAnalytics", "AzureTable", + "InfluxDB", + + "MongoDB", "MySql", "PostgreSql", "SqlServer".' + isRequired: true + types: + - + - +variables: +- description: 'Required. data source type.Constant filled by server. Possible values + + include: "AzureApplicationInsights", "AzureBlob", "AzureCosmosDB", "AzureDataExplorer", + + "AzureDataLakeStorageGen2", "AzureEventHubs", "AzureLogAnalytics", "AzureTable", + "InfluxDB", + + "MongoDB", "MySql", "PostgreSql", "SqlServer".' + name: data_source_type + types: + - + - +- description: 'authentication type for corresponding data source. Possible values + + include: "Basic", "ManagedIdentity", "AzureSQLConnectionString", "DataLakeGen2SharedKey", + + "ServicePrincipal", "ServicePrincipalInKV". Default is "Basic".' + name: authentication_type + types: + - + - +- description: The datasource credential id. + name: credential_id + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.DataFeedSource.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.DataFeedSource.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.DataFeedSource.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.DataFeedSource.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.DataFeedSource.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.DataFeedSource.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.DataFeedSource.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.DataFeedSource.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.DataFeedSource.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.DataFeedSource.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.DataFeedSource.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedStatus.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedStatus.yml new file mode 100644 index 00000000..49bc8de0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedStatus.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.ai.metricsadvisor.models.DataFeedStatus +name: DataFeedStatus +fullName: azure.ai.metricsadvisor.models.DataFeedStatus +summary: data feed status. +module: azure.ai.metricsadvisor.models +fields: +- name: ACTIVE + uid: azure.ai.metricsadvisor.models.DataFeedStatus.ACTIVE +- name: PAUSED + uid: azure.ai.metricsadvisor.models.DataFeedStatus.PAUSED diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataPointAnomaly.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataPointAnomaly.yml new file mode 100644 index 00000000..dd249f0c --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataPointAnomaly.yml @@ -0,0 +1,170 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.DataPointAnomaly +name: DataPointAnomaly +fullName: azure.ai.metricsadvisor.models.DataPointAnomaly +module: azure.ai.metricsadvisor.models +summary: 'DataPointAnomaly. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'DataPointAnomaly(*, timestamp: datetime, dimension: Dict[str, str], severity: + str | _models.AnomalySeverity, **kwargs)' + keywordOnlyParameters: + - name: timestamp + description: anomaly time. Required. + types: + - + - name: dimension + description: dimension specified for series. Required. + types: + - [, ] + - name: severity + description: 'anomaly severity. Required. Known values are: "Low", "Medium", and + "High".' + types: + - + - +variables: +- description: metric unique id. Only returned for alerting anomaly result. + name: metric_id + types: + - +- description: 'anomaly detection configuration unique id. + + Only returned for alerting anomaly result.' + name: detection_configuration_id + types: + - +- description: anomaly time. + name: timestamp + types: + - +- description: created time. Only returned for alerting result. + name: created_time + types: + - +- description: modified time. Only returned for alerting result. + name: modified_time + types: + - +- description: dimension specified for series. + name: dimension + types: + - [, ] +- description: 'anomaly severity. Possible values include: "Low", "Medium", "High".' + name: severity + types: + - +- description: 'anomaly status. only returned for alerting anomaly result. Possible + + values include: "Active", "Resolved".' + name: status + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.DataPointAnomaly.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DataPointAnomaly.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DataPointAnomaly.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.DataPointAnomaly.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DataPointAnomaly.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.DataPointAnomaly.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DataPointAnomaly.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceAuthenticationType.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceAuthenticationType.yml new file mode 100644 index 00000000..8c88dc63 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceAuthenticationType.yml @@ -0,0 +1,19 @@ +### YamlMime:PythonEnum +uid: azure.ai.metricsadvisor.models.DatasourceAuthenticationType +name: DatasourceAuthenticationType +fullName: azure.ai.metricsadvisor.models.DatasourceAuthenticationType +summary: authentication type for corresponding data source. +module: azure.ai.metricsadvisor.models +fields: +- name: AZURE_SQL_CONNECTION_STRING + uid: azure.ai.metricsadvisor.models.DatasourceAuthenticationType.AZURE_SQL_CONNECTION_STRING +- name: BASIC + uid: azure.ai.metricsadvisor.models.DatasourceAuthenticationType.BASIC +- name: DATA_LAKE_GEN2_SHARED_KEY + uid: azure.ai.metricsadvisor.models.DatasourceAuthenticationType.DATA_LAKE_GEN2_SHARED_KEY +- name: MANAGED_IDENTITY + uid: azure.ai.metricsadvisor.models.DatasourceAuthenticationType.MANAGED_IDENTITY +- name: SERVICE_PRINCIPAL + uid: azure.ai.metricsadvisor.models.DatasourceAuthenticationType.SERVICE_PRINCIPAL +- name: SERVICE_PRINCIPAL_IN_KV + uid: azure.ai.metricsadvisor.models.DatasourceAuthenticationType.SERVICE_PRINCIPAL_IN_KV diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceCredential.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceCredential.yml new file mode 100644 index 00000000..d1620021 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceCredential.yml @@ -0,0 +1,108 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.DatasourceCredential +name: DatasourceCredential +fullName: azure.ai.metricsadvisor.models.DatasourceCredential +module: azure.ai.metricsadvisor.models +summary: DatasourceCredential base class. +constructor: + syntax: 'DatasourceCredential(name: str, credential_type: str, **kwargs: Any)' + parameters: + - name: credential_type + description: 'Required. Type of data source credential.Constant filled by + + server. Possible values include: "AzureSQLConnectionString", "DataLakeGen2SharedKey", + + "ServicePrincipal", "ServicePrincipalInKV".' + isRequired: true + types: + - + - + - name: name + description: Required. Name of data source credential. + isRequired: true + types: + - + keywordOnlyParameters: + - name: description + description: Description of data source credential. + types: + - +variables: +- description: Unique id of data source credential. + name: id + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.DatasourceCredential.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.DatasourceCredential.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.DatasourceCredential.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.DatasourceCredential.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.DatasourceCredential.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.DatasourceCredential.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.DatasourceCredential.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.DatasourceCredential.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.DatasourceCredential.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.DatasourceCredential.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.DatasourceCredential.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceCredentialType.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceCredentialType.yml new file mode 100644 index 00000000..a0026f5b --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceCredentialType.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.ai.metricsadvisor.models.DatasourceCredentialType +name: DatasourceCredentialType +fullName: azure.ai.metricsadvisor.models.DatasourceCredentialType +summary: Type of data source credential. +module: azure.ai.metricsadvisor.models +fields: +- name: AZURE_SQL_CONNECTION_STRING + uid: azure.ai.metricsadvisor.models.DatasourceCredentialType.AZURE_SQL_CONNECTION_STRING +- name: DATA_LAKE_GEN2_SHARED_KEY + uid: azure.ai.metricsadvisor.models.DatasourceCredentialType.DATA_LAKE_GEN2_SHARED_KEY +- name: SERVICE_PRINCIPAL + uid: azure.ai.metricsadvisor.models.DatasourceCredentialType.SERVICE_PRINCIPAL +- name: SERVICE_PRINCIPAL_IN_KV + uid: azure.ai.metricsadvisor.models.DatasourceCredentialType.SERVICE_PRINCIPAL_IN_KV diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.yml new file mode 100644 index 00000000..a8dd686e --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.yml @@ -0,0 +1,218 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey +name: DatasourceDataLakeGen2SharedKey +fullName: azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey +module: azure.ai.metricsadvisor.models +summary: 'DatasourceDataLakeGen2SharedKey. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DatasourceDataLakeGen2SharedKey(name: str, account_key: str, **kwargs: + Any)' + parameters: + - name: name + description: Required. Name of data source credential. + isRequired: true + types: + - + - name: account_key + description: Required. The account key to access the Azure Data Lake Storage Gen2. + isRequired: true + types: + - + keywordOnlyParameters: + - name: description + description: Description of data source credential. + types: + - +variables: +- description: 'Required. Type of data source credential.Constant filled by + + server. Possible values include: "AzureSQLConnectionString", "DataLakeGen2SharedKey", + + "ServicePrincipal", "ServicePrincipalInKV".' + name: credential_type +- description: Unique id of data source credential. + name: id + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +- uid: azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceMissingDataPointFillType.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceMissingDataPointFillType.yml new file mode 100644 index 00000000..d90c7377 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceMissingDataPointFillType.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.ai.metricsadvisor.models.DatasourceMissingDataPointFillType +name: DatasourceMissingDataPointFillType +fullName: azure.ai.metricsadvisor.models.DatasourceMissingDataPointFillType +summary: the type of fill missing point for anomaly detection. +module: azure.ai.metricsadvisor.models +fields: +- name: CUSTOM_VALUE + uid: azure.ai.metricsadvisor.models.DatasourceMissingDataPointFillType.CUSTOM_VALUE +- name: NO_FILLING + uid: azure.ai.metricsadvisor.models.DatasourceMissingDataPointFillType.NO_FILLING +- name: PREVIOUS_VALUE + uid: azure.ai.metricsadvisor.models.DatasourceMissingDataPointFillType.PREVIOUS_VALUE +- name: SMART_FILLING + uid: azure.ai.metricsadvisor.models.DatasourceMissingDataPointFillType.SMART_FILLING diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceServicePrincipal.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceServicePrincipal.yml new file mode 100644 index 00000000..14d43f06 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceServicePrincipal.yml @@ -0,0 +1,228 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipal +name: DatasourceServicePrincipal +fullName: azure.ai.metricsadvisor.models.DatasourceServicePrincipal +module: azure.ai.metricsadvisor.models +summary: 'DatasourceServicePrincipal. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DatasourceServicePrincipal(name: str, client_id: str, client_secret: str, + tenant_id: str, **kwargs: Any)' + parameters: + - name: name + description: Required. Name of data source credential. + isRequired: true + types: + - + - name: client_id + description: Required. The client id of the service principal. + isRequired: true + types: + - + - name: client_secret + description: Required. The client secret of the service principal. + isRequired: true + types: + - + - name: tenant_id + description: Required. The tenant id of the service principal. + isRequired: true + types: + - + keywordOnlyParameters: + - name: description + description: Description of data source credential. + types: + - +variables: +- description: 'Required. Type of data source credential.Constant filled by + + server. Possible values include: "AzureSQLConnectionString", "DataLakeGen2SharedKey", + + "ServicePrincipal", "ServicePrincipalInKV".' + name: credential_type +- description: Unique id of data source credential. + name: id + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipal.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipal.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipal.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipal.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipal.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipal.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipal.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipal.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipal.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipal.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipal.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipal.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipal.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipal.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipal.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipal.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipal.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipal.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.yml new file mode 100644 index 00000000..5654ddc6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.yml @@ -0,0 +1,242 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault +name: DatasourceServicePrincipalInKeyVault +fullName: azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault +module: azure.ai.metricsadvisor.models +summary: 'DatasourceServicePrincipalInKeyVault. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DatasourceServicePrincipalInKeyVault(name: str, *, key_vault_endpoint: + str, key_vault_client_id: str, key_vault_client_secret: str, service_principal_id_name_in_kv: + str, service_principal_secret_name_in_kv: str, tenant_id: str, **kwargs: Any)' + parameters: + - name: name + description: Required. Name of data source credential. + isRequired: true + types: + - + keywordOnlyParameters: + - name: description + description: Description of data source credential. + types: + - + - name: key_vault_endpoint + description: Required. The Key Vault endpoint that storing the service principal. + types: + - + - name: key_vault_client_id + description: Required. The Client Id to access the Key Vault. + types: + - + - name: key_vault_client_secret + description: Required. The Client Secret to access the Key Vault. + types: + - + - name: service_principal_id_name_in_kv + description: 'Required. The secret name of the service principal''s + + client Id in the Key Vault.' + types: + - + - name: service_principal_secret_name_in_kv + description: 'Required. The secret name of the service + + principal''s client secret in the Key Vault.' + types: + - + - name: tenant_id + description: Required. The tenant id of your service principal. + types: + - +variables: +- description: 'Required. Type of data source credential.Constant filled by + + server. Possible values include: "AzureSQLConnectionString", "DataLakeGen2SharedKey", + + "ServicePrincipal", "ServicePrincipalInKV".' + name: credential_type +- description: Unique id of data source credential. + name: id + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +- uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.yml new file mode 100644 index 00000000..5c26b530 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.yml @@ -0,0 +1,218 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.DatasourceSqlConnectionString +name: DatasourceSqlConnectionString +fullName: azure.ai.metricsadvisor.models.DatasourceSqlConnectionString +module: azure.ai.metricsadvisor.models +summary: 'DatasourceSqlConnectionString. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DatasourceSqlConnectionString(name: str, connection_string: str, **kwargs: + Any)' + parameters: + - name: name + description: Required. Name of data source credential. + isRequired: true + types: + - + - name: connection_string + description: Required. The connection string to access the Azure SQL. + isRequired: true + types: + - + keywordOnlyParameters: + - name: description + description: Description of data source credential. + types: + - +variables: +- description: 'Required. Type of data source credential.Constant filled by + + server. Possible values include: "AzureSQLConnectionString", "DataLakeGen2SharedKey", + + "ServicePrincipal", "ServicePrincipalInKV".' + name: credential_type +- description: Unique id of data source credential. + name: id + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +- uid: azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceType.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceType.yml new file mode 100644 index 00000000..4efa4ed4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceType.yml @@ -0,0 +1,33 @@ +### YamlMime:PythonEnum +uid: azure.ai.metricsadvisor.models.DatasourceType +name: DatasourceType +fullName: azure.ai.metricsadvisor.models.DatasourceType +summary: data source type. +module: azure.ai.metricsadvisor.models +fields: +- name: AZURE_APPLICATION_INSIGHTS + uid: azure.ai.metricsadvisor.models.DatasourceType.AZURE_APPLICATION_INSIGHTS +- name: AZURE_BLOB + uid: azure.ai.metricsadvisor.models.DatasourceType.AZURE_BLOB +- name: AZURE_COSMOS_DB + uid: azure.ai.metricsadvisor.models.DatasourceType.AZURE_COSMOS_DB +- name: AZURE_DATA_EXPLORER + uid: azure.ai.metricsadvisor.models.DatasourceType.AZURE_DATA_EXPLORER +- name: AZURE_DATA_LAKE_STORAGE_GEN2 + uid: azure.ai.metricsadvisor.models.DatasourceType.AZURE_DATA_LAKE_STORAGE_GEN2 +- name: AZURE_EVENT_HUBS + uid: azure.ai.metricsadvisor.models.DatasourceType.AZURE_EVENT_HUBS +- name: AZURE_LOG_ANALYTICS + uid: azure.ai.metricsadvisor.models.DatasourceType.AZURE_LOG_ANALYTICS +- name: AZURE_TABLE + uid: azure.ai.metricsadvisor.models.DatasourceType.AZURE_TABLE +- name: INFLUX_DB + uid: azure.ai.metricsadvisor.models.DatasourceType.INFLUX_DB +- name: MONGO_DB + uid: azure.ai.metricsadvisor.models.DatasourceType.MONGO_DB +- name: MY_SQL + uid: azure.ai.metricsadvisor.models.DatasourceType.MY_SQL +- name: POSTGRE_SQL + uid: azure.ai.metricsadvisor.models.DatasourceType.POSTGRE_SQL +- name: SQL_SERVER + uid: azure.ai.metricsadvisor.models.DatasourceType.SQL_SERVER diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DetectionAnomalyFilterCondition.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DetectionAnomalyFilterCondition.yml new file mode 100644 index 00000000..415f6eed --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DetectionAnomalyFilterCondition.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.DetectionAnomalyFilterCondition +name: DetectionAnomalyFilterCondition +fullName: azure.ai.metricsadvisor.models.DetectionAnomalyFilterCondition +module: azure.ai.metricsadvisor.models +summary: DetectionAnomalyFilterCondition. +constructor: + syntax: DetectionAnomalyFilterCondition(**kwargs) + keywordOnlyParameters: + - name: series_group_key + description: dimension filter. + types: + - [, ] + - name: severity_filter + types: + - +variables: +- description: dimension filter. + name: series_group_key + types: + - [, ] +- name: severity_filter + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.DetectionAnomalyFilterCondition.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DetectionAnomalyFilterCondition.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DetectionAnomalyFilterCondition.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.DetectionAnomalyFilterCondition.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DetectionAnomalyFilterCondition.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.DetectionAnomalyFilterCondition.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DetectionAnomalyFilterCondition.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DetectionConditionOperator.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DetectionConditionOperator.yml new file mode 100644 index 00000000..17dc02bc --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DetectionConditionOperator.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.ai.metricsadvisor.models.DetectionConditionOperator +name: DetectionConditionOperator +fullName: azure.ai.metricsadvisor.models.DetectionConditionOperator +summary: 'condition operator + + + should be specified when combining multiple detection conditions.' +module: azure.ai.metricsadvisor.models +fields: +- name: AND + uid: azure.ai.metricsadvisor.models.DetectionConditionOperator.AND +- name: OR + uid: azure.ai.metricsadvisor.models.DetectionConditionOperator.OR diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DetectionIncidentFilterCondition.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DetectionIncidentFilterCondition.yml new file mode 100644 index 00000000..0f88ce29 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DetectionIncidentFilterCondition.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.DetectionIncidentFilterCondition +name: DetectionIncidentFilterCondition +fullName: azure.ai.metricsadvisor.models.DetectionIncidentFilterCondition +module: azure.ai.metricsadvisor.models +summary: DetectionIncidentFilterCondition. +constructor: + syntax: 'DetectionIncidentFilterCondition(*, dimension_filter: List[_models.DimensionGroupIdentity] + | None = None, **kwargs)' + keywordOnlyParameters: + - name: dimension_filter + description: dimension filter. + types: + - [] +variables: +- description: dimension filter. + name: dimension_filter + types: + - [] +methods: +- uid: azure.ai.metricsadvisor.models.DetectionIncidentFilterCondition.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DetectionIncidentFilterCondition.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DetectionIncidentFilterCondition.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.DetectionIncidentFilterCondition.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DetectionIncidentFilterCondition.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.DetectionIncidentFilterCondition.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DetectionIncidentFilterCondition.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DimensionGroupIdentity.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DimensionGroupIdentity.yml new file mode 100644 index 00000000..cc63e4d9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DimensionGroupIdentity.yml @@ -0,0 +1,127 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.DimensionGroupIdentity +name: DimensionGroupIdentity +fullName: azure.ai.metricsadvisor.models.DimensionGroupIdentity +module: azure.ai.metricsadvisor.models +summary: 'DimensionGroupIdentity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DimensionGroupIdentity(*, dimension: Dict[str, str], **kwargs)' + keywordOnlyParameters: + - name: dimension + description: dimension specified for series group. Required. + types: + - [, ] +variables: +- description: dimension specified for series group. Required. + name: dimension + types: + - [, ] +methods: +- uid: azure.ai.metricsadvisor.models.DimensionGroupIdentity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DimensionGroupIdentity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DimensionGroupIdentity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.DimensionGroupIdentity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.DimensionGroupIdentity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.DimensionGroupIdentity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.DimensionGroupIdentity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.EmailNotificationHook.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.EmailNotificationHook.yml new file mode 100644 index 00000000..f73d49ad --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.EmailNotificationHook.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.EmailNotificationHook +name: EmailNotificationHook +fullName: azure.ai.metricsadvisor.models.EmailNotificationHook +module: azure.ai.metricsadvisor.models +summary: EmailNotificationHook. +constructor: + syntax: 'EmailNotificationHook(name: str, emails_to_alert: List[str], **kwargs: + Any)' + parameters: + - name: name + description: Hook unique name. + isRequired: true + types: + - + - name: emails_to_alert + description: 'Required. Email TO: list.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: description + description: Hook description. + types: + - + - name: external_link + description: Hook external link. + types: + - +variables: +- description: Hook administrators. + name: admins + types: + - [] +- description: Constant filled by server - "Email". + name: hook_type + types: + - +- description: Hook unique id. + name: id + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.EmailNotificationHook.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.EmailNotificationHook.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.EmailNotificationHook.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.EmailNotificationHook.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.EmailNotificationHook.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.EmailNotificationHook.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.EmailNotificationHook.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.EnrichmentStatus.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.EnrichmentStatus.yml new file mode 100644 index 00000000..96d07a02 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.EnrichmentStatus.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.EnrichmentStatus +name: EnrichmentStatus +fullName: azure.ai.metricsadvisor.models.EnrichmentStatus +module: azure.ai.metricsadvisor.models +summary: 'EnrichmentStatus. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: EnrichmentStatus(**kwargs) +variables: +- description: data slice timestamp. + name: timestamp + types: + - +- description: latest enrichment status for this data slice. + name: status + types: + - +- description: the trimmed message describes details of the enrichment status. + name: message + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.EnrichmentStatus.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.EnrichmentStatus.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.EnrichmentStatus.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.EnrichmentStatus.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.EnrichmentStatus.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.EnrichmentStatus.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.EnrichmentStatus.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.FeedbackQueryTimeMode.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.FeedbackQueryTimeMode.yml new file mode 100644 index 00000000..7ee9e706 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.FeedbackQueryTimeMode.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.ai.metricsadvisor.models.FeedbackQueryTimeMode +name: FeedbackQueryTimeMode +fullName: azure.ai.metricsadvisor.models.FeedbackQueryTimeMode +summary: time mode to filter feedback +module: azure.ai.metricsadvisor.models +fields: +- name: FEEDBACK_CREATED_TIME + uid: azure.ai.metricsadvisor.models.FeedbackQueryTimeMode.FEEDBACK_CREATED_TIME +- name: METRIC_TIMESTAMP + uid: azure.ai.metricsadvisor.models.FeedbackQueryTimeMode.METRIC_TIMESTAMP diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.FeedbackType.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.FeedbackType.yml new file mode 100644 index 00000000..145d816b --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.FeedbackType.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.ai.metricsadvisor.models.FeedbackType +name: FeedbackType +fullName: azure.ai.metricsadvisor.models.FeedbackType +summary: feedback type. +module: azure.ai.metricsadvisor.models +fields: +- name: ANOMALY + uid: azure.ai.metricsadvisor.models.FeedbackType.ANOMALY +- name: CHANGE_POINT + uid: azure.ai.metricsadvisor.models.FeedbackType.CHANGE_POINT +- name: COMMENT + uid: azure.ai.metricsadvisor.models.FeedbackType.COMMENT +- name: PERIOD + uid: azure.ai.metricsadvisor.models.FeedbackType.PERIOD diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.HardThresholdCondition.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.HardThresholdCondition.yml new file mode 100644 index 00000000..d31da916 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.HardThresholdCondition.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.HardThresholdCondition +name: HardThresholdCondition +fullName: azure.ai.metricsadvisor.models.HardThresholdCondition +module: azure.ai.metricsadvisor.models +summary: HardThresholdCondition. +constructor: + syntax: 'HardThresholdCondition(anomaly_detector_direction: str | AnomalyDetectorDirection, + suppress_condition: SuppressCondition, **kwargs: Any)' + parameters: + - name: anomaly_detector_direction + description: 'Required. detection direction. Possible values include: + + "Both", "Down", "Up".' + isRequired: true + types: + - + - + - name: suppress_condition + description: Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: lower_bound + description: 'lower bound + + should be specified when anomalyDetectorDirection is Both or Down.' + types: + - + - name: upper_bound + description: 'upper bound + + should be specified when anomalyDetectorDirection is Both or Up.' + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.HardThresholdCondition.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.HardThresholdCondition.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.HardThresholdCondition.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.HardThresholdCondition.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.HardThresholdCondition.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.HardThresholdCondition.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.HardThresholdCondition.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.IncidentRootCause.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.IncidentRootCause.yml new file mode 100644 index 00000000..65de5a18 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.IncidentRootCause.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.IncidentRootCause +name: IncidentRootCause +fullName: azure.ai.metricsadvisor.models.IncidentRootCause +module: azure.ai.metricsadvisor.models +summary: 'Incident Root Cause. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: IncidentRootCause(**kwargs) +variables: +- description: dimension specified for series group. + name: dimension_key + types: + - [, ] +- description: drilling down path from query anomaly to root cause. + name: path + types: + - [] +- description: score. + name: score + types: + - +- description: description. + name: description + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.IncidentRootCause.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.IncidentRootCause.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.IncidentRootCause.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.IncidentRootCause.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.IncidentRootCause.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.IncidentRootCause.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.IncidentRootCause.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.yml new file mode 100644 index 00000000..ec7a97f7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.yml @@ -0,0 +1,236 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.InfluxDbDataFeedSource +name: InfluxDbDataFeedSource +fullName: azure.ai.metricsadvisor.models.InfluxDbDataFeedSource +module: azure.ai.metricsadvisor.models +summary: InfluxDbDataFeedSource. +constructor: + syntax: 'InfluxDbDataFeedSource(query: str, **kwargs: Any)' + parameters: + - name: query + description: Required. Query script. + isRequired: true + types: + - + keywordOnlyParameters: + - name: credential_id + description: The datasource credential id. + types: + - + - name: connection_string + description: InfluxDB connection string. + types: + - + - name: database + description: Database name. + types: + - + - name: user_name + description: Database access user. + types: + - + - name: password + description: Required. Database access password. + types: + - +variables: +- description: 'Required. data source type.Constant filled by server. Possible values + + include: "AzureApplicationInsights", "AzureBlob", "AzureCosmosDB", "AzureDataExplorer", + + "AzureDataLakeStorageGen2", "AzureEventHubs", "AzureLogAnalytics", "AzureTable", + "InfluxDB", + + "MongoDB", "MySql", "PostgreSql", "SqlServer".' + name: data_source_type + types: + - + - +- description: 'authentication type for corresponding data source. Possible values + + include: "Basic", "ManagedIdentity", "AzureSQLConnectionString", "DataLakeGen2SharedKey", + + "ServicePrincipal", "ServicePrincipalInKV". Default is "Basic".' + name: authentication_type + types: + - + - +methods: +- uid: azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +- uid: azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAlertConfiguration.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAlertConfiguration.yml new file mode 100644 index 00000000..4e0e7983 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAlertConfiguration.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.MetricAlertConfiguration +name: MetricAlertConfiguration +fullName: azure.ai.metricsadvisor.models.MetricAlertConfiguration +module: azure.ai.metricsadvisor.models +summary: MetricAlertConfiguration. +constructor: + syntax: 'MetricAlertConfiguration(detection_configuration_id: str, alert_scope: + MetricAnomalyAlertScope, **kwargs: Any)' + parameters: + - name: detection_configuration_id + description: Required. Anomaly detection configuration unique id. + isRequired: true + types: + - + - name: alert_scope + description: Required. Anomaly scope. + isRequired: true + types: + - + keywordOnlyParameters: + - name: negation_operation + description: Negation operation. + types: + - + - name: alert_conditions + types: + - + - name: alert_snooze_condition + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.MetricAlertConfiguration.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.MetricAlertConfiguration.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.MetricAlertConfiguration.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.MetricAlertConfiguration.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.MetricAlertConfiguration.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.MetricAlertConfiguration.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.MetricAlertConfiguration.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAnomalyAlertConditions.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAnomalyAlertConditions.yml new file mode 100644 index 00000000..37dbd9ce --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAnomalyAlertConditions.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.MetricAnomalyAlertConditions +name: MetricAnomalyAlertConditions +fullName: azure.ai.metricsadvisor.models.MetricAnomalyAlertConditions +module: azure.ai.metricsadvisor.models +constructor: + syntax: MetricAnomalyAlertConditions(**kwargs) + keywordOnlyParameters: + - name: metric_boundary_condition + types: + - + - name: severity_condition + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAnomalyAlertConfigurationsOperator.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAnomalyAlertConfigurationsOperator.yml new file mode 100644 index 00000000..a188bfc2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAnomalyAlertConfigurationsOperator.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonEnum +uid: azure.ai.metricsadvisor.models.MetricAnomalyAlertConfigurationsOperator +name: MetricAnomalyAlertConfigurationsOperator +fullName: azure.ai.metricsadvisor.models.MetricAnomalyAlertConfigurationsOperator +summary: 'cross metrics operator + + + should be specified when setting up multiple metric alerting configurations.' +module: azure.ai.metricsadvisor.models +fields: +- name: AND + uid: azure.ai.metricsadvisor.models.MetricAnomalyAlertConfigurationsOperator.AND +- name: OR + uid: azure.ai.metricsadvisor.models.MetricAnomalyAlertConfigurationsOperator.OR +- name: XOR + uid: azure.ai.metricsadvisor.models.MetricAnomalyAlertConfigurationsOperator.XOR diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAnomalyAlertScope.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAnomalyAlertScope.yml new file mode 100644 index 00000000..077ad1f9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAnomalyAlertScope.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.MetricAnomalyAlertScope +name: MetricAnomalyAlertScope +fullName: azure.ai.metricsadvisor.models.MetricAnomalyAlertScope +module: azure.ai.metricsadvisor.models +constructor: + syntax: 'MetricAnomalyAlertScope(scope_type: str | MetricAnomalyAlertScopeType, + **kwargs: Any)' + parameters: + - name: scope_type + description: 'Required. Anomaly scope. Possible values include: "WholeSeries", + + "SeriesGroup", "TopN".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: series_group_in_scope + description: Dimension specified for series group. + types: + - [, ] + - name: top_n_group_in_scope + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAnomalyAlertScopeType.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAnomalyAlertScopeType.yml new file mode 100644 index 00000000..7180545d --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAnomalyAlertScopeType.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.ai.metricsadvisor.models.MetricAnomalyAlertScopeType +name: MetricAnomalyAlertScopeType +fullName: azure.ai.metricsadvisor.models.MetricAnomalyAlertScopeType +summary: Anomaly scope. +module: azure.ai.metricsadvisor.models +fields: +- name: ALL + uid: azure.ai.metricsadvisor.models.MetricAnomalyAlertScopeType.ALL +- name: DIMENSION + uid: azure.ai.metricsadvisor.models.MetricAnomalyAlertScopeType.DIMENSION +- name: TOP_N + uid: azure.ai.metricsadvisor.models.MetricAnomalyAlertScopeType.TOP_N diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAnomalyAlertSnoozeCondition.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAnomalyAlertSnoozeCondition.yml new file mode 100644 index 00000000..c06a25a1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricAnomalyAlertSnoozeCondition.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.MetricAnomalyAlertSnoozeCondition +name: MetricAnomalyAlertSnoozeCondition +fullName: azure.ai.metricsadvisor.models.MetricAnomalyAlertSnoozeCondition +module: azure.ai.metricsadvisor.models +summary: MetricAnomalyAlertSnoozeCondition. +constructor: + syntax: 'MetricAnomalyAlertSnoozeCondition(auto_snooze: int, snooze_scope: str | + SnoozeScope, only_for_successive: bool, **kwargs: Any)' + parameters: + - name: auto_snooze + description: "Required. snooze point count, value range : [0, +\u221E)." + isRequired: true + types: + - + - name: snooze_scope + description: 'Required. snooze scope. Possible values include: "Metric", "Series".' + isRequired: true + types: + - + - + - name: only_for_successive + description: Required. only snooze for successive anomalies. + isRequired: true + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.MetricAnomalyAlertSnoozeCondition.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.MetricAnomalyAlertSnoozeCondition.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.MetricAnomalyAlertSnoozeCondition.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.MetricAnomalyAlertSnoozeCondition.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.MetricAnomalyAlertSnoozeCondition.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.MetricAnomalyAlertSnoozeCondition.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.MetricAnomalyAlertSnoozeCondition.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricBoundaryCondition.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricBoundaryCondition.yml new file mode 100644 index 00000000..c7c55e54 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricBoundaryCondition.yml @@ -0,0 +1,144 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.MetricBoundaryCondition +name: MetricBoundaryCondition +fullName: azure.ai.metricsadvisor.models.MetricBoundaryCondition +module: azure.ai.metricsadvisor.models +summary: MetricBoundaryCondition. +constructor: + syntax: 'MetricBoundaryCondition(direction: str | AnomalyDetectorDirection, **kwargs: + Any)' + parameters: + - name: direction + description: 'Required. value filter direction. Possible values include: "Both", + "Down", + + "Up".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: lower + description: lower bound should be specified when direction is Both or Down. + types: + - + - name: upper + description: upper bound should be specified when direction is Both or Up. + types: + - + - name: companion_metric_id + description: the other metric unique id used for value filter. + types: + - + - name: trigger_for_missing + description: 'trigger alert when the corresponding point is missing in the other + + metric should be specified only when using other metric to filter.' + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.MetricBoundaryCondition.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.MetricBoundaryCondition.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.MetricBoundaryCondition.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.MetricBoundaryCondition.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.MetricBoundaryCondition.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.MetricBoundaryCondition.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.MetricBoundaryCondition.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricDetectionCondition.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricDetectionCondition.yml new file mode 100644 index 00000000..afeae578 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricDetectionCondition.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.MetricDetectionCondition +name: MetricDetectionCondition +fullName: azure.ai.metricsadvisor.models.MetricDetectionCondition +module: azure.ai.metricsadvisor.models +summary: MetricDetectionCondition. +constructor: + syntax: 'MetricDetectionCondition(*, condition_operator: str | _models.DetectionConditionOperator + | None = None, smart_detection_condition: _models.SmartDetectionCondition | None + = None, hard_threshold_condition: _models.HardThresholdCondition | None = None, + change_threshold_condition: _models.ChangeThresholdCondition | None = None, **kwargs)' + keywordOnlyParameters: + - name: condition_operator + description: 'condition operator + + should be specified when combining multiple detection conditions. Possible values + include: + + "AND", "OR".' + types: + - + - + - name: smart_detection_condition + types: + - + - name: hard_threshold_condition + types: + - + - name: change_threshold_condition + types: + - + - name: condition_operator + description: 'condition operator + + + should be specified when combining multiple detection conditions. Known values + are: "AND" and + + "OR".' + - name: smart_detection_condition + - name: hard_threshold_condition + - name: change_threshold_condition +methods: +- uid: azure.ai.metricsadvisor.models.MetricDetectionCondition.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.MetricDetectionCondition.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.MetricDetectionCondition.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.MetricDetectionCondition.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.MetricDetectionCondition.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.MetricDetectionCondition.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.MetricDetectionCondition.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricEnrichedSeriesData.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricEnrichedSeriesData.yml new file mode 100644 index 00000000..9286a944 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricEnrichedSeriesData.yml @@ -0,0 +1,197 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.MetricEnrichedSeriesData +name: MetricEnrichedSeriesData +fullName: azure.ai.metricsadvisor.models.MetricEnrichedSeriesData +module: azure.ai.metricsadvisor.models +summary: 'MetricEnrichedSeriesData. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MetricEnrichedSeriesData(*, timestamps: List[datetime], values: List[float], + is_anomaly: List[bool], periods: List[int], expected_values: List[float], lower_bounds: + List[float], upper_bounds: List[float], series_key: Dict[str, str], **kwargs)' + parameters: + - name: series_key + description: Required. + isRequired: true + types: + - + - name: timestamps + description: Required. timestamps of the series. + isRequired: true + types: + - [] + - name: values + description: Required. values of the series. + isRequired: true + types: + - [] + - name: is_anomaly + description: Required. whether points of the series are anomalies. + isRequired: true + types: + - [] + - name: periods + description: Required. period calculated on each point of the series. + isRequired: true + types: + - [] + - name: expected_values + description: Required. expected values of the series given by smart detector. + isRequired: true + types: + - [] + - name: lower_bounds + description: 'Required. lower boundary list of the series given by smart + + detector.' + isRequired: true + types: + - [] + - name: upper_bounds + description: 'Required. upper boundary list of the series given by smart + + detector.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: timestamps + description: timestamps of the series. Required. + types: + - [] + - name: values + description: values of the series. Required. + types: + - [] + - name: is_anomaly + description: whether points of the series are anomalies. Required. + types: + - [] + - name: periods + description: period calculated on each point of the series. Required. + types: + - [] + - name: expected_values + description: expected values of the series given by smart detector. Required. + types: + - [] + - name: lower_bounds + description: lower boundary list of the series given by smart detector. Required. + types: + - [] + - name: upper_bounds + description: upper boundary list of the series given by smart detector. Required. + types: + - [] + - name: series_key + description: dimension specified for series group. Required. + types: + - [, ] +methods: +- uid: azure.ai.metricsadvisor.models.MetricEnrichedSeriesData.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.MetricEnrichedSeriesData.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.MetricEnrichedSeriesData.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.MetricEnrichedSeriesData.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.MetricEnrichedSeriesData.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.MetricEnrichedSeriesData.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.MetricEnrichedSeriesData.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricFeedback.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricFeedback.yml new file mode 100644 index 00000000..c97e370e --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricFeedback.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.MetricFeedback +name: MetricFeedback +fullName: azure.ai.metricsadvisor.models.MetricFeedback +module: azure.ai.metricsadvisor.models +summary: 'Feedback base class + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: MetricFeedback(feedback_type, metric_id, dimension_key, **kwargs) + parameters: + - name: feedback_type + description: 'Required. feedback type.Constant filled by server. Possible values + + include: "Anomaly", "ChangePoint", "Period", "Comment".' + isRequired: true + types: + - + - + - name: metric_id + description: Required. metric unique id. + isRequired: true + types: + - + - name: dimension_key + description: Required. metric dimension filter. + isRequired: true + types: + - [, ] +variables: +- description: 'Required. feedback type.Constant filled by server. Possible values + + include: "Anomaly", "ChangePoint", "Period", "Comment".' + name: feedback_type + types: + - + - +- description: feedback unique id. + name: id + types: + - +- description: feedback created time. + name: created_time + types: + - +- description: user who gives this feedback. + name: user_principal + types: + - +- description: Required. metric unique id. + name: metric_id + types: + - +- description: Required. metric dimension filter. + name: dimension_key + types: + - [, ] +methods: +- uid: azure.ai.metricsadvisor.models.MetricFeedback.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.MetricFeedback.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.MetricFeedback.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.MetricFeedback.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.MetricFeedback.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.MetricFeedback.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.MetricFeedback.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.MetricFeedback.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.MetricFeedback.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.MetricFeedback.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.MetricFeedback.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricSeriesData.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricSeriesData.yml new file mode 100644 index 00000000..88c846ba --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricSeriesData.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.MetricSeriesData +name: MetricSeriesData +fullName: azure.ai.metricsadvisor.models.MetricSeriesData +module: azure.ai.metricsadvisor.models +summary: MetricSeriesData. +constructor: + syntax: 'MetricSeriesData(*, series_key: Dict[str, str] | None = None, **kwargs)' + keywordOnlyParameters: + - name: series_key + description: dimension specified for series group. + types: + - [, ] +variables: +- description: metric unique id. + name: metric_id + types: + - +- description: dimension name and value pair. + name: series_key + types: + - [, ] +- description: timestamps of the data related to this time series. + name: timestamps + types: + - [] +- description: values of the data related to this time series. + name: values + types: + - [] +methods: +- uid: azure.ai.metricsadvisor.models.MetricSeriesData.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.MetricSeriesData.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.MetricSeriesData.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.MetricSeriesData.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.MetricSeriesData.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.MetricSeriesData.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.MetricSeriesData.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricSeriesDefinition.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricSeriesDefinition.yml new file mode 100644 index 00000000..a70be4c3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricSeriesDefinition.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.MetricSeriesDefinition +name: MetricSeriesDefinition +fullName: azure.ai.metricsadvisor.models.MetricSeriesDefinition +module: azure.ai.metricsadvisor.models +summary: 'MetricSeriesDefinition. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: MetricSeriesDefinition(**kwargs) +variables: +- description: metric unique id. + name: metric_id + types: + - +- description: dimension name and value pair. + name: dimension + types: + - [, ] +methods: +- uid: azure.ai.metricsadvisor.models.MetricSeriesDefinition.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.MetricSeriesDefinition.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.MetricSeriesDefinition.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.MetricSeriesDefinition.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.MetricSeriesDefinition.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.MetricSeriesDefinition.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.MetricSeriesDefinition.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricSeriesGroupDetectionCondition.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricSeriesGroupDetectionCondition.yml new file mode 100644 index 00000000..e754edc6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricSeriesGroupDetectionCondition.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.MetricSeriesGroupDetectionCondition +name: MetricSeriesGroupDetectionCondition +fullName: azure.ai.metricsadvisor.models.MetricSeriesGroupDetectionCondition +module: azure.ai.metricsadvisor.models +summary: MetricSeriesGroupAnomalyDetectionConditions. +constructor: + syntax: 'MetricSeriesGroupDetectionCondition(series_group_key: Dict[str, str], **kwargs: + Any)' + parameters: + - name: series_group_key + description: Required. dimension specified for series group. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: condition_operator + description: 'condition operator + + should be specified when combining multiple detection conditions. Possible values + include: + + "AND", "OR".' + types: + - + - + - name: smart_detection_condition + types: + - + - name: hard_threshold_condition + types: + - + - name: change_threshold_condition + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.MetricSeriesGroupDetectionCondition.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.MetricSeriesGroupDetectionCondition.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.MetricSeriesGroupDetectionCondition.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.MetricSeriesGroupDetectionCondition.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.MetricSeriesGroupDetectionCondition.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.MetricSeriesGroupDetectionCondition.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.MetricSeriesGroupDetectionCondition.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricSingleSeriesDetectionCondition.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricSingleSeriesDetectionCondition.yml new file mode 100644 index 00000000..a4d924df --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricSingleSeriesDetectionCondition.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.MetricSingleSeriesDetectionCondition +name: MetricSingleSeriesDetectionCondition +fullName: azure.ai.metricsadvisor.models.MetricSingleSeriesDetectionCondition +module: azure.ai.metricsadvisor.models +summary: MetricSingleSeriesDetectionCondition. +constructor: + syntax: 'MetricSingleSeriesDetectionCondition(series_key: Dict[str, str], **kwargs: + Any)' + parameters: + - name: series_key + description: Required. dimension specified for series. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: condition_operator + description: 'condition operator + + should be specified when combining multiple detection conditions. Possible values + include: + + "AND", "OR".' + types: + - + - + - name: smart_detection_condition + types: + - + - name: hard_threshold_condition + types: + - + - name: change_threshold_condition + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.MetricSingleSeriesDetectionCondition.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.MetricSingleSeriesDetectionCondition.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.MetricSingleSeriesDetectionCondition.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.MetricSingleSeriesDetectionCondition.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.MetricSingleSeriesDetectionCondition.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.MetricSingleSeriesDetectionCondition.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.MetricSingleSeriesDetectionCondition.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MongoDbDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MongoDbDataFeedSource.yml new file mode 100644 index 00000000..b91b94cb --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MongoDbDataFeedSource.yml @@ -0,0 +1,228 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.MongoDbDataFeedSource +name: MongoDbDataFeedSource +fullName: azure.ai.metricsadvisor.models.MongoDbDataFeedSource +module: azure.ai.metricsadvisor.models +summary: MongoDbDataFeedSource. +constructor: + syntax: 'MongoDbDataFeedSource(command: str, **kwargs: Any)' + parameters: + - name: command + description: Required. Query script. + isRequired: true + types: + - + keywordOnlyParameters: + - name: credential_id + description: The datasource credential id. + types: + - + - name: connection_string + description: MongoDb connection string. + types: + - + - name: database + description: Database name. + types: + - +variables: +- description: 'Required. data source type.Constant filled by server. Possible values + + include: "AzureApplicationInsights", "AzureBlob", "AzureCosmosDB", "AzureDataExplorer", + + "AzureDataLakeStorageGen2", "AzureEventHubs", "AzureLogAnalytics", "AzureTable", + "InfluxDB", + + "MongoDB", "MySql", "PostgreSql", "SqlServer".' + name: data_source_type + types: + - + - +- description: 'authentication type for corresponding data source. Possible values + + include: "Basic", "ManagedIdentity", "AzureSQLConnectionString", "DataLakeGen2SharedKey", + + "ServicePrincipal", "ServicePrincipalInKV". Default is "Basic".' + name: authentication_type + types: + - + - +methods: +- uid: azure.ai.metricsadvisor.models.MongoDbDataFeedSource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.MongoDbDataFeedSource.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.MongoDbDataFeedSource.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.MongoDbDataFeedSource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.MongoDbDataFeedSource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.MongoDbDataFeedSource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.MongoDbDataFeedSource.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.MongoDbDataFeedSource.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.MongoDbDataFeedSource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.MongoDbDataFeedSource.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.MongoDbDataFeedSource.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.MongoDbDataFeedSource.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.MongoDbDataFeedSource.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.MongoDbDataFeedSource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.MongoDbDataFeedSource.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.MongoDbDataFeedSource.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.MongoDbDataFeedSource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +- uid: azure.ai.metricsadvisor.models.MongoDbDataFeedSource.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MySqlDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MySqlDataFeedSource.yml new file mode 100644 index 00000000..ade410c1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MySqlDataFeedSource.yml @@ -0,0 +1,224 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.MySqlDataFeedSource +name: MySqlDataFeedSource +fullName: azure.ai.metricsadvisor.models.MySqlDataFeedSource +module: azure.ai.metricsadvisor.models +summary: MySqlDataFeedSource. +constructor: + syntax: 'MySqlDataFeedSource(query: str, **kwargs: Any)' + parameters: + - name: query + description: Required. Query script. + isRequired: true + types: + - + keywordOnlyParameters: + - name: credential_id + description: The datasource credential id. + types: + - + - name: connection_string + description: Database connection string. + types: + - +variables: +- description: 'Required. data source type.Constant filled by server. Possible values + + include: "AzureApplicationInsights", "AzureBlob", "AzureCosmosDB", "AzureDataExplorer", + + "AzureDataLakeStorageGen2", "AzureEventHubs", "AzureLogAnalytics", "AzureTable", + "InfluxDB", + + "MongoDB", "MySql", "PostgreSql", "SqlServer".' + name: data_source_type + types: + - + - +- description: 'authentication type for corresponding data source. Possible values + + include: "Basic", "ManagedIdentity", "AzureSQLConnectionString", "DataLakeGen2SharedKey", + + "ServicePrincipal", "ServicePrincipalInKV". Default is "Basic".' + name: authentication_type + types: + - + - +methods: +- uid: azure.ai.metricsadvisor.models.MySqlDataFeedSource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.MySqlDataFeedSource.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.MySqlDataFeedSource.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.MySqlDataFeedSource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.MySqlDataFeedSource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.MySqlDataFeedSource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.MySqlDataFeedSource.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.MySqlDataFeedSource.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.MySqlDataFeedSource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.MySqlDataFeedSource.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.MySqlDataFeedSource.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.MySqlDataFeedSource.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.MySqlDataFeedSource.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.MySqlDataFeedSource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.MySqlDataFeedSource.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.MySqlDataFeedSource.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.MySqlDataFeedSource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +- uid: azure.ai.metricsadvisor.models.MySqlDataFeedSource.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.NotificationHook.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.NotificationHook.yml new file mode 100644 index 00000000..6b5f28b2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.NotificationHook.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.NotificationHook +name: NotificationHook +fullName: azure.ai.metricsadvisor.models.NotificationHook +module: azure.ai.metricsadvisor.models +summary: NotificationHook. +constructor: + syntax: NotificationHook(name, **kwargs) + parameters: + - name: name + description: Hook unique name. + isRequired: true + types: + - +variables: +- description: Hook description. + name: description + types: + - +- description: Hook external link. + name: external_link + types: + - +- description: Hook administrators. + name: admins + types: + - [] +- description: 'Constant filled by server. Possible values include: + + "Webhook", "Email".' + name: hook_type + types: + - +- description: Hook unique id. + name: id + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.NotificationHook.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.NotificationHook.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.NotificationHook.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.NotificationHook.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.NotificationHook.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.NotificationHook.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.NotificationHook.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.PeriodFeedback.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.PeriodFeedback.yml new file mode 100644 index 00000000..b43acc00 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.PeriodFeedback.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.PeriodFeedback +name: PeriodFeedback +fullName: azure.ai.metricsadvisor.models.PeriodFeedback +module: azure.ai.metricsadvisor.models +summary: 'PeriodFeedback. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: PeriodFeedback(metric_id, dimension_key, value, period_type, **kwargs) + parameters: + - name: metric_id + description: Required. metric unique id. + isRequired: true + types: + - + - name: dimension_key + description: Required. metric dimension filter. + isRequired: true + types: + - [, ] + - name: value + description: Required. + isRequired: true + types: + - + - name: period_type + description: 'Required. the type of setting period. Possible values include: + + "AutoDetect", "AssignValue".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: created_time + description: feedback created time. + types: + - + - name: user_principal + description: user who gives this feedback. + types: + - +variables: +- description: 'Required. feedback type.Constant filled by server. Possible values + + include: "Anomaly", "ChangePoint", "Period", "Comment".' + name: feedback_type + types: + - + - +- description: feedback unique id. + name: id + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.PeriodFeedback.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.PeriodFeedback.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.PeriodFeedback.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.PeriodFeedback.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.PeriodFeedback.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.PeriodFeedback.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.PeriodFeedback.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.PeriodFeedback.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.PeriodFeedback.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.PeriodFeedback.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.PeriodFeedback.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.PeriodType.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.PeriodType.yml new file mode 100644 index 00000000..4714da53 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.PeriodType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.ai.metricsadvisor.models.PeriodType +name: PeriodType +fullName: azure.ai.metricsadvisor.models.PeriodType +summary: the type of setting period. +module: azure.ai.metricsadvisor.models +fields: +- name: ASSIGN_VALUE + uid: azure.ai.metricsadvisor.models.PeriodType.ASSIGN_VALUE +- name: AUTO_DETECT + uid: azure.ai.metricsadvisor.models.PeriodType.AUTO_DETECT diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.yml new file mode 100644 index 00000000..9a3aebeb --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.yml @@ -0,0 +1,224 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource +name: PostgreSqlDataFeedSource +fullName: azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource +module: azure.ai.metricsadvisor.models +summary: PostgreSqlDataFeedSource. +constructor: + syntax: 'PostgreSqlDataFeedSource(query: str, **kwargs: Any)' + parameters: + - name: query + description: Required. Query script. + isRequired: true + types: + - + keywordOnlyParameters: + - name: credential_id + description: The datasource credential id. + types: + - + - name: connection_string + description: Database connection string. + types: + - +variables: +- description: 'Required. data source type.Constant filled by server. Possible values + + include: "AzureApplicationInsights", "AzureBlob", "AzureCosmosDB", "AzureDataExplorer", + + "AzureDataLakeStorageGen2", "AzureEventHubs", "AzureLogAnalytics", "AzureTable", + "InfluxDB", + + "MongoDB", "MySql", "PostgreSql", "SqlServer".' + name: data_source_type + types: + - + - +- description: 'authentication type for corresponding data source. Possible values + + include: "Basic", "ManagedIdentity", "AzureSQLConnectionString", "DataLakeGen2SharedKey", + + "ServicePrincipal", "ServicePrincipalInKV". Default is "Basic".' + name: authentication_type + types: + - + - +methods: +- uid: azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +- uid: azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SeriesIdentity.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SeriesIdentity.yml new file mode 100644 index 00000000..f023ea2b --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SeriesIdentity.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.SeriesIdentity +name: SeriesIdentity +fullName: azure.ai.metricsadvisor.models.SeriesIdentity +module: azure.ai.metricsadvisor.models +summary: 'SeriesIdentity. + + + All required parameters must be populated in order to send to Azure. + + :keyword dimension: Required. dimension specified for series. + + :paramtype dimension: dict[str, str]' +constructor: + syntax: 'SeriesIdentity(*, dimension: Dict[str, str], **kwargs)' + keywordOnlyParameters: + - name: dimension + isRequired: true +methods: +- uid: azure.ai.metricsadvisor.models.SeriesIdentity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.SeriesIdentity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.SeriesIdentity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.SeriesIdentity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.SeriesIdentity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.SeriesIdentity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.SeriesIdentity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SeverityCondition.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SeverityCondition.yml new file mode 100644 index 00000000..6cef2b98 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SeverityCondition.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.SeverityCondition +name: SeverityCondition +fullName: azure.ai.metricsadvisor.models.SeverityCondition +module: azure.ai.metricsadvisor.models +summary: SeverityCondition. +constructor: + syntax: 'SeverityCondition(min_alert_severity: str | AnomalySeverity, max_alert_severity: + str | AnomalySeverity, **kwargs: Any)' + parameters: + - name: min_alert_severity + description: 'Required. min alert severity. Possible values include: "Low", + + "Medium", "High".' + isRequired: true + types: + - + - + - name: max_alert_severity + description: 'Required. max alert severity. Possible values include: "Low", + + "Medium", "High".' + isRequired: true + types: + - + - +methods: +- uid: azure.ai.metricsadvisor.models.SeverityCondition.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.SeverityCondition.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.SeverityCondition.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.SeverityCondition.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.SeverityCondition.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.SeverityCondition.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.SeverityCondition.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SeverityFilterCondition.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SeverityFilterCondition.yml new file mode 100644 index 00000000..494c2ac0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SeverityFilterCondition.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.SeverityFilterCondition +name: SeverityFilterCondition +fullName: azure.ai.metricsadvisor.models.SeverityFilterCondition +module: azure.ai.metricsadvisor.models +summary: 'SeverityFilterCondition. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SeverityFilterCondition(*, min: str | _models.AnomalySeverity, max: str + | _models.AnomalySeverity, **kwargs)' + keywordOnlyParameters: + - name: min + description: 'min severity. Required. Known values are: "Low", "Medium", and "High".' + types: + - + - + - name: max + description: 'max severity. Required. Known values are: "Low", "Medium", and "High".' + types: + - + - +variables: +- description: 'min severity. Required. Known values are: "Low", "Medium", and "High".' + name: min + types: + - + - +- description: 'max severity. Required. Known values are: "Low", "Medium", and "High".' + name: max + types: + - + - +methods: +- uid: azure.ai.metricsadvisor.models.SeverityFilterCondition.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.SeverityFilterCondition.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.SeverityFilterCondition.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.SeverityFilterCondition.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.SeverityFilterCondition.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.SeverityFilterCondition.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.SeverityFilterCondition.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SmartDetectionCondition.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SmartDetectionCondition.yml new file mode 100644 index 00000000..167c3249 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SmartDetectionCondition.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.SmartDetectionCondition +name: SmartDetectionCondition +fullName: azure.ai.metricsadvisor.models.SmartDetectionCondition +module: azure.ai.metricsadvisor.models +summary: SmartDetectionCondition. +constructor: + syntax: 'SmartDetectionCondition(sensitivity: float, anomaly_detector_direction: + str | AnomalyDetectorDirection, suppress_condition: SuppressCondition, **kwargs: + Any)' + parameters: + - name: sensitivity + description: 'Required. sensitivity, value range : (0, 100].' + isRequired: true + types: + - + - name: anomaly_detector_direction + description: 'Required. detection direction. Possible values include: + + "Both", "Down", "Up".' + isRequired: true + types: + - + - + - name: suppress_condition + description: Required. + isRequired: true + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.SmartDetectionCondition.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.SmartDetectionCondition.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.SmartDetectionCondition.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.SmartDetectionCondition.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.SmartDetectionCondition.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.SmartDetectionCondition.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.SmartDetectionCondition.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SnoozeScope.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SnoozeScope.yml new file mode 100644 index 00000000..f41fdd94 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SnoozeScope.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.ai.metricsadvisor.models.SnoozeScope +name: SnoozeScope +fullName: azure.ai.metricsadvisor.models.SnoozeScope +summary: snooze scope. +module: azure.ai.metricsadvisor.models +fields: +- name: METRIC + uid: azure.ai.metricsadvisor.models.SnoozeScope.METRIC +- name: SERIES + uid: azure.ai.metricsadvisor.models.SnoozeScope.SERIES diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SqlServerDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SqlServerDataFeedSource.yml new file mode 100644 index 00000000..57fa32b6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SqlServerDataFeedSource.yml @@ -0,0 +1,240 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.SqlServerDataFeedSource +name: SqlServerDataFeedSource +fullName: azure.ai.metricsadvisor.models.SqlServerDataFeedSource +module: azure.ai.metricsadvisor.models +summary: SqlServerDataFeedSource. +constructor: + syntax: 'SqlServerDataFeedSource(query: str, **kwargs: Any)' + parameters: + - name: query + description: Required. Query script. + isRequired: true + types: + - + keywordOnlyParameters: + - name: credential_id + description: The datasource credential id. + types: + - + - name: connection_string + description: Database connection string. + types: + - + - name: msi + description: If using managed identity authentication. + types: + - + - name: datasource_service_principal_id + description: Datasource service principal unique id. + types: + - + - name: datasource_service_principal_in_kv_id + description: Datasource service principal in key vault unique id. + types: + - + - name: datasource_sql_connection_string_id + description: Datasource sql connection string unique id. + types: + - +variables: +- description: 'Required. data source type.Constant filled by server. Possible values + + include: "AzureApplicationInsights", "AzureBlob", "AzureCosmosDB", "AzureDataExplorer", + + "AzureDataLakeStorageGen2", "AzureEventHubs", "AzureLogAnalytics", "AzureTable", + "InfluxDB", + + "MongoDB", "MySql", "PostgreSql", "SqlServer".' + name: data_source_type + types: + - + - +- description: 'authentication type for corresponding data source. Possible values + + include: "Basic", "ManagedIdentity", "AzureSQLConnectionString", "DataLakeGen2SharedKey", + + "ServicePrincipal", "ServicePrincipalInKV". Default is "Basic".' + name: authentication_type + types: + - + - +methods: +- uid: azure.ai.metricsadvisor.models.SqlServerDataFeedSource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.SqlServerDataFeedSource.clear + name: clear + signature: clear() -> None. Remove all items from D. +- uid: azure.ai.metricsadvisor.models.SqlServerDataFeedSource.copy + name: copy + signature: copy() -> a shallow copy of D +- uid: azure.ai.metricsadvisor.models.SqlServerDataFeedSource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.SqlServerDataFeedSource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.SqlServerDataFeedSource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.SqlServerDataFeedSource.fromkeys + name: fromkeys + summary: Create a new dictionary with keys from iterable and values set to value. + signature: fromkeys(value=None, /) + positionalOnlyParameters: + - name: iterable + isRequired: true + - name: value + defaultValue: None + parameters: + - name: type + isRequired: true +- uid: azure.ai.metricsadvisor.models.SqlServerDataFeedSource.get + name: get + summary: Return the value for key if key is in the dictionary, else default. + signature: get(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.SqlServerDataFeedSource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.SqlServerDataFeedSource.items + name: items + signature: items() -> a set-like object providing a view on D's items +- uid: azure.ai.metricsadvisor.models.SqlServerDataFeedSource.keys + name: keys + signature: keys() -> a set-like object providing a view on D's keys +- uid: azure.ai.metricsadvisor.models.SqlServerDataFeedSource.pop + name: pop + summary: 'If the key is not found, return the default if given; otherwise, + + raise a KeyError.' + signature: pop(k, [d]) -> v, remove specified key and return the corresponding value. +- uid: azure.ai.metricsadvisor.models.SqlServerDataFeedSource.popitem + name: popitem + summary: 'Remove and return a (key, value) pair as a 2-tuple. + + + Pairs are returned in LIFO (last-in, first-out) order. + + Raises KeyError if the dict is empty.' + signature: popitem() +- uid: azure.ai.metricsadvisor.models.SqlServerDataFeedSource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.SqlServerDataFeedSource.setdefault + name: setdefault + summary: 'Insert key with a value of default if key is not in the dictionary. + + + Return the value for key if key is in the dictionary, else default.' + signature: setdefault(key, default=None, /) + positionalOnlyParameters: + - name: key + isRequired: true + - name: default + defaultValue: None +- uid: azure.ai.metricsadvisor.models.SqlServerDataFeedSource.update + name: update + summary: 'If E is present and has a .keys() method, then does: for k in E: D[k] + = E[k] + + If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = + v + + In either case, this is followed by: for k in F: D[k] = F[k]' + signature: update([E], **F) -> None. Update D from dict/iterable E and F. +- uid: azure.ai.metricsadvisor.models.SqlServerDataFeedSource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +- uid: azure.ai.metricsadvisor.models.SqlServerDataFeedSource.values + name: values + signature: values() -> an object providing a view on D's values diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SuppressCondition.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SuppressCondition.yml new file mode 100644 index 00000000..913ddb82 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SuppressCondition.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.SuppressCondition +name: SuppressCondition +fullName: azure.ai.metricsadvisor.models.SuppressCondition +module: azure.ai.metricsadvisor.models +summary: SuppressCondition. +constructor: + syntax: 'SuppressCondition(min_number: int, min_ratio: float, **kwargs: Any)' + parameters: + - name: min_number + description: "Required. min point number, value range : [1, +\u221E)." + isRequired: true + types: + - + - name: min_ratio + description: 'Required. min point ratio, value range : (0, 100].' + isRequired: true + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.SuppressCondition.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.SuppressCondition.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.SuppressCondition.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.SuppressCondition.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.SuppressCondition.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.SuppressCondition.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.SuppressCondition.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.TopNGroupScope.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.TopNGroupScope.yml new file mode 100644 index 00000000..3526757b --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.TopNGroupScope.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.TopNGroupScope +name: TopNGroupScope +fullName: azure.ai.metricsadvisor.models.TopNGroupScope +module: azure.ai.metricsadvisor.models +summary: TopNGroupScope. +constructor: + syntax: 'TopNGroupScope(top: int, period: int, min_top_count: int, **kwargs: Any)' + parameters: + - name: top + description: "Required. top N, value range : [1, +\u221E)." + isRequired: true + types: + - + - name: period + description: "Required. point count used to look back, value range : [1, +\u221E\ + )." + isRequired: true + types: + - + - name: min_top_count + description: "Required. min count should be in top N, value range : [1, +\u221E\ + )\nshould be less than or equal to period." + isRequired: true + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.TopNGroupScope.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.TopNGroupScope.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.TopNGroupScope.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.TopNGroupScope.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.TopNGroupScope.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.TopNGroupScope.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.TopNGroupScope.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.WebNotificationHook.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.WebNotificationHook.yml new file mode 100644 index 00000000..2497f9f9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.WebNotificationHook.yml @@ -0,0 +1,166 @@ +### YamlMime:PythonClass +uid: azure.ai.metricsadvisor.models.WebNotificationHook +name: WebNotificationHook +fullName: azure.ai.metricsadvisor.models.WebNotificationHook +module: azure.ai.metricsadvisor.models +summary: WebNotificationHook. +constructor: + syntax: 'WebNotificationHook(name: str, endpoint: str, **kwargs: Any)' + parameters: + - name: name + description: Hook unique name. + isRequired: true + types: + - + - name: endpoint + description: 'Required. API address, will be called when alert is triggered, only + support + + POST method via SSL.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: username + description: basic authentication. + types: + - + - name: password + description: basic authentication. + types: + - + - name: certificate_key + description: client certificate. + types: + - + - name: certificate_password + description: client certificate password. + types: + - + - name: description + description: Hook description. + types: + - + - name: external_link + description: Hook external link. + types: + - +variables: +- description: Hook administrators. + name: admins + types: + - [] +- description: Constant filled by server - "Webhook". + name: hook_type + types: + - +- description: Hook unique id. + name: id + types: + - +methods: +- uid: azure.ai.metricsadvisor.models.WebNotificationHook.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.WebNotificationHook.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.WebNotificationHook.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.ai.metricsadvisor.models.WebNotificationHook.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.ai.metricsadvisor.models.WebNotificationHook.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.ai.metricsadvisor.models.WebNotificationHook.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.ai.metricsadvisor.models.WebNotificationHook.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.yml new file mode 100644 index 00000000..5e1b0579 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.yml @@ -0,0 +1,95 @@ +### YamlMime:PythonPackage +uid: azure.ai.metricsadvisor.models +name: models +fullName: azure.ai.metricsadvisor.models +type: import +classes: +- azure.ai.metricsadvisor.models.AnomalyAlert +- azure.ai.metricsadvisor.models.AnomalyAlertConfiguration +- azure.ai.metricsadvisor.models.AnomalyDetectionConfiguration +- azure.ai.metricsadvisor.models.AnomalyFeedback +- azure.ai.metricsadvisor.models.AnomalyIncident +- azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource +- azure.ai.metricsadvisor.models.AzureBlobDataFeedSource +- azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource +- azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource +- azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource +- azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource +- azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource +- azure.ai.metricsadvisor.models.AzureTableDataFeedSource +- azure.ai.metricsadvisor.models.ChangePointFeedback +- azure.ai.metricsadvisor.models.ChangeThresholdCondition +- azure.ai.metricsadvisor.models.CommentFeedback +- azure.ai.metricsadvisor.models.DataFeed +- azure.ai.metricsadvisor.models.DataFeedDimension +- azure.ai.metricsadvisor.models.DataFeedGranularity +- azure.ai.metricsadvisor.models.DataFeedIngestionProgress +- azure.ai.metricsadvisor.models.DataFeedIngestionSettings +- azure.ai.metricsadvisor.models.DataFeedIngestionStatus +- azure.ai.metricsadvisor.models.DataFeedMetric +- azure.ai.metricsadvisor.models.DataFeedMissingDataPointFillSettings +- azure.ai.metricsadvisor.models.DataFeedRollupSettings +- azure.ai.metricsadvisor.models.DataFeedSchema +- azure.ai.metricsadvisor.models.DataFeedSource +- azure.ai.metricsadvisor.models.DataPointAnomaly +- azure.ai.metricsadvisor.models.DatasourceCredential +- azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey +- azure.ai.metricsadvisor.models.DatasourceServicePrincipal +- azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault +- azure.ai.metricsadvisor.models.DatasourceSqlConnectionString +- azure.ai.metricsadvisor.models.DetectionAnomalyFilterCondition +- azure.ai.metricsadvisor.models.DetectionIncidentFilterCondition +- azure.ai.metricsadvisor.models.DimensionGroupIdentity +- azure.ai.metricsadvisor.models.EmailNotificationHook +- azure.ai.metricsadvisor.models.EnrichmentStatus +- azure.ai.metricsadvisor.models.HardThresholdCondition +- azure.ai.metricsadvisor.models.IncidentRootCause +- azure.ai.metricsadvisor.models.InfluxDbDataFeedSource +- azure.ai.metricsadvisor.models.MetricAlertConfiguration +- azure.ai.metricsadvisor.models.MetricAnomalyAlertConditions +- azure.ai.metricsadvisor.models.MetricAnomalyAlertScope +- azure.ai.metricsadvisor.models.MetricAnomalyAlertSnoozeCondition +- azure.ai.metricsadvisor.models.MetricBoundaryCondition +- azure.ai.metricsadvisor.models.MetricDetectionCondition +- azure.ai.metricsadvisor.models.MetricEnrichedSeriesData +- azure.ai.metricsadvisor.models.MetricFeedback +- azure.ai.metricsadvisor.models.MetricSeriesData +- azure.ai.metricsadvisor.models.MetricSeriesDefinition +- azure.ai.metricsadvisor.models.MetricSeriesGroupDetectionCondition +- azure.ai.metricsadvisor.models.MetricSingleSeriesDetectionCondition +- azure.ai.metricsadvisor.models.MongoDbDataFeedSource +- azure.ai.metricsadvisor.models.MySqlDataFeedSource +- azure.ai.metricsadvisor.models.NotificationHook +- azure.ai.metricsadvisor.models.PeriodFeedback +- azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource +- azure.ai.metricsadvisor.models.SeriesIdentity +- azure.ai.metricsadvisor.models.SeverityCondition +- azure.ai.metricsadvisor.models.SeverityFilterCondition +- azure.ai.metricsadvisor.models.SmartDetectionCondition +- azure.ai.metricsadvisor.models.SqlServerDataFeedSource +- azure.ai.metricsadvisor.models.SuppressCondition +- azure.ai.metricsadvisor.models.TopNGroupScope +- azure.ai.metricsadvisor.models.WebNotificationHook +enums: +- azure.ai.metricsadvisor.models.AlertQueryTimeMode +- azure.ai.metricsadvisor.models.AnomalyDetectorDirection +- azure.ai.metricsadvisor.models.AnomalyIncidentStatus +- azure.ai.metricsadvisor.models.AnomalySeverity +- azure.ai.metricsadvisor.models.AnomalyValue +- azure.ai.metricsadvisor.models.ChangePointValue +- azure.ai.metricsadvisor.models.DataFeedAccessMode +- azure.ai.metricsadvisor.models.DataFeedAutoRollupMethod +- azure.ai.metricsadvisor.models.DataFeedGranularityType +- azure.ai.metricsadvisor.models.DataFeedRollupType +- azure.ai.metricsadvisor.models.DataFeedStatus +- azure.ai.metricsadvisor.models.DatasourceAuthenticationType +- azure.ai.metricsadvisor.models.DatasourceCredentialType +- azure.ai.metricsadvisor.models.DatasourceMissingDataPointFillType +- azure.ai.metricsadvisor.models.DatasourceType +- azure.ai.metricsadvisor.models.DetectionConditionOperator +- azure.ai.metricsadvisor.models.FeedbackQueryTimeMode +- azure.ai.metricsadvisor.models.FeedbackType +- azure.ai.metricsadvisor.models.MetricAnomalyAlertConfigurationsOperator +- azure.ai.metricsadvisor.models.MetricAnomalyAlertScopeType +- azure.ai.metricsadvisor.models.PeriodType +- azure.ai.metricsadvisor.models.SnoozeScope diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.yml new file mode 100644 index 00000000..0e58efa8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonPackage +uid: azure.ai.metricsadvisor +name: metricsadvisor +fullName: azure.ai.metricsadvisor +type: rootImport +classes: +- azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient +- azure.ai.metricsadvisor.MetricsAdvisorClient +- azure.ai.metricsadvisor.MetricsAdvisorKeyCredential +packages: +- azure.ai.metricsadvisor.aio +- azure.ai.metricsadvisor.models diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ConsoleLogger.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ConsoleLogger.yml new file mode 100644 index 00000000..c5795e26 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ConsoleLogger.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.ConsoleLogger +name: ConsoleLogger +fullName: azure.ai.vision.ConsoleLogger +module: azure.ai.vision +summary: Represents a process-wide singleton that emits SDK log traces to the console. +constructor: + syntax: ConsoleLogger() +methods: +- uid: azure.ai.vision.ConsoleLogger.start + name: start + summary: 'Starts logging to the console. + + + default. Otherwise they will be written to the standard output (STDOUT).' + signature: 'static start(log_to_stderr: bool = True)' + parameters: + - name: log_to_stderr + defaultValue: 'True' +- uid: azure.ai.vision.ConsoleLogger.stop + name: stop + summary: Stop logging to a the console. + signature: static stop() diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.FileLogger.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.FileLogger.yml new file mode 100644 index 00000000..78bf6d52 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.FileLogger.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.FileLogger +name: FileLogger +fullName: azure.ai.vision.FileLogger +module: azure.ai.vision +summary: Represents a process-wide singleton that emits SDK log traces to a provided + file. +constructor: + syntax: FileLogger() +methods: +- uid: azure.ai.vision.FileLogger.start + name: start + summary: 'Starts logging to a file. + + + to the existing file. Otherwise a new file will be created (this is the default).' + signature: 'static start(file_name: str, append: bool = False)' + parameters: + - name: file_name + isRequired: true + - name: append + defaultValue: 'False' +- uid: azure.ai.vision.FileLogger.stop + name: stop + summary: Stop logging to a file. + signature: static stop() diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.Frame.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.Frame.yml new file mode 100644 index 00000000..937ccbdd --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.Frame.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.Frame +name: Frame +fullName: azure.ai.vision.Frame +module: azure.ai.vision +summary: 'Represents a Frame being passed into or retrieved from the Vision SDK. + + + :param buffer:The memory that contains the frame.' +constructor: + syntax: 'Frame(buffer: bytes, handle: c_void_p | None = None)' + parameters: + - name: buffer + isRequired: true + - name: handle + defaultValue: None +attributes: +- uid: azure.ai.vision.Frame.data + name: data + summary: The data buffer associated with the Frame. +- uid: azure.ai.vision.Frame.properties + name: properties + summary: A collection of properties and their values defined for this Frame. diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.FrameFormat.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.FrameFormat.yml new file mode 100644 index 00000000..04af1ea5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.FrameFormat.yml @@ -0,0 +1,45 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.FrameFormat +name: FrameFormat +fullName: azure.ai.vision.FrameFormat +module: azure.ai.vision +summary: Represents a collection of image format properties (e.g. FOURCC, width, height, + stride, ...) +constructor: + syntax: 'FrameFormat(fourcc: str, bits_per_pixel: int = 0, width: int = 0, height: + int = 0, stride: int = 0)' + parameters: + - name: fourcc + description: Specifies the FOURCC character string. + isRequired: true + - name: bits_per_pixel + description: The image format's bits per pixel (e.g. 8, 16, 24, 32, ...). + defaultValue: '0' + - name: width + description: The image format's pixel width. + defaultValue: '0' + - name: height + description: The image format's pixel height. + defaultValue: '0' + - name: stride + description: The image format's pixel stride. + defaultValue: '0' +attributes: +- uid: azure.ai.vision.FrameFormat.bits_per_pixel + name: bits_per_pixel + summary: Gets the image format's bits per pixel value. +- uid: azure.ai.vision.FrameFormat.fourcc + name: fourcc + summary: Gets the image format's FOURCC value +- uid: azure.ai.vision.FrameFormat.height + name: height + summary: Gets the image format's pixel height. +- uid: azure.ai.vision.FrameFormat.properties + name: properties + summary: A collection of properties and their values defined for this FrameFormat. +- uid: azure.ai.vision.FrameFormat.stride + name: stride + summary: Gets the image format's pixel stride. +- uid: azure.ai.vision.FrameFormat.width + name: width + summary: Gets the image format's pixel width. diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.FrameSource.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.FrameSource.yml new file mode 100644 index 00000000..bec33ad8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.FrameSource.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.FrameSource +name: FrameSource +fullName: azure.ai.vision.FrameSource +module: azure.ai.vision +summary: Represents a source of image frame data, used as input to or output from + Vision AI operations. +constructor: + syntax: 'FrameSource(format: FrameFormat, frame_callback: FrameSourceCallback | + None = None)' + parameters: + - name: format + description: Specifies the frame format + isRequired: true + - name: frame_callback + description: The object containing the callback function for the pulling the frame + data + defaultValue: None +methods: +- uid: azure.ai.vision.FrameSource.close + name: close + summary: Closes the frame source for writing. + signature: close() -> None +attributes: +- uid: azure.ai.vision.FrameSource.frame_writer + name: frame_writer +- uid: azure.ai.vision.FrameSource.properties + name: properties + summary: A collection of properties and their values defined for this FrameSource. diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.FrameSourceCallback.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.FrameSourceCallback.yml new file mode 100644 index 00000000..021e6a7e --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.FrameSourceCallback.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.FrameSourceCallback +name: FrameSourceCallback +fullName: azure.ai.vision.FrameSourceCallback +module: azure.ai.vision +summary: 'An interface that defines callback method used with FrameSource + + + Not fully implemented.' +constructor: + syntax: FrameSourceCallback() +methods: +- uid: azure.ai.vision.FrameSourceCallback.callback + name: callback + summary: This function is called by native side when new data is requested to be + written using FrameWriter + signature: 'callback(frame_writer: FrameWriter) -> None' + parameters: + - name: frame_writer + description: the frame writer object. + isRequired: true diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.FrameWriter.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.FrameWriter.yml new file mode 100644 index 00000000..66b86dc5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.FrameWriter.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.FrameWriter +name: FrameWriter +fullName: azure.ai.vision.FrameWriter +module: azure.ai.vision +summary: Represents the ability to write image frame data, for use as input with Vision + AI scenario operations. +constructor: + syntax: 'FrameWriter(handle: c_void_p)' + parameters: + - name: handle + isRequired: true +methods: +- uid: azure.ai.vision.FrameWriter.write_bytes + name: write_bytes + summary: Writes a single frame of image data to the underlying FrameSource. + signature: 'write_bytes(buffer: bytes)' + parameters: + - name: buffer + description: The data buffer as bytes. + isRequired: true +- uid: azure.ai.vision.FrameWriter.write_frame + name: write_frame + summary: Writes a single frame of image data to the underlying FrameSource. + signature: 'write_frame(frame: Frame)' + parameters: + - name: frame + description: The frame containing the data buffer. + isRequired: true diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalysisErrorDetails.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalysisErrorDetails.yml new file mode 100644 index 00000000..cff5aaed --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalysisErrorDetails.yml @@ -0,0 +1,42 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.ImageAnalysisErrorDetails +name: ImageAnalysisErrorDetails +fullName: azure.ai.vision.ImageAnalysisErrorDetails +module: azure.ai.vision +summary: A representation of an error associated with an image analysis result. +constructor: + syntax: ImageAnalysisErrorDetails() +methods: +- uid: azure.ai.vision.ImageAnalysisErrorDetails.from_result + name: from_result + summary: 'Creates an object that contains additional error information for a failed + ImageAnalysisResult. + + + ImageAnalysisErrorDetail objects can only be created from ImageAnalysisResults + that stopped due to an + + error. This corresponds to a value of ImageAnalysisResultReason.ERROR for ImageAnalysisResult.reason. + + Attempting to create an ImageAnalysisErrorDetails from a result that did not stop + due to an error will + + return None.' + signature: 'static from_result(result: ImageAnalysisResult)' + parameters: + - name: result + description: The result object from a failed image analysis operation. + isRequired: true +attributes: +- uid: azure.ai.vision.ImageAnalysisErrorDetails.error_code + name: error_code + summary: The standardized code for the error. +- uid: azure.ai.vision.ImageAnalysisErrorDetails.message + name: message + summary: The detailed error message. +- uid: azure.ai.vision.ImageAnalysisErrorDetails.properties + name: properties + summary: A collection of advanced properties on the error details. +- uid: azure.ai.vision.ImageAnalysisErrorDetails.reason + name: reason + summary: The category of the error. diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalysisEventArgs.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalysisEventArgs.yml new file mode 100644 index 00000000..36ad783d --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalysisEventArgs.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.ImageAnalysisEventArgs +name: ImageAnalysisEventArgs +fullName: azure.ai.vision.ImageAnalysisEventArgs +module: azure.ai.vision +summary: Represents an asynchronous Image Analysis result payload as an event argument +constructor: + syntax: 'ImageAnalysisEventArgs(handle: c_void_p)' + parameters: + - name: handle + description: Internal handle for result. + isRequired: true +attributes: +- uid: azure.ai.vision.ImageAnalysisEventArgs.result + name: result + summary: The Image Analysis result associated with this event. diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalysisOptions.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalysisOptions.yml new file mode 100644 index 00000000..62d909d6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalysisOptions.yml @@ -0,0 +1,65 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.ImageAnalysisOptions +name: ImageAnalysisOptions +fullName: azure.ai.vision.ImageAnalysisOptions +module: azure.ai.vision +summary: 'Represents the configuration options that control the function of the ImageAnalyzer. + + + If you are doing Image Analysis using the standard model, you must set the + + features property to one or more visual features to analyze. There is no + + default selection for visual features. If you are using a custom model or doing + Image Segmentation, + + you do not need to specify visual features.' +constructor: + syntax: ImageAnalysisOptions() +attributes: +- uid: azure.ai.vision.ImageAnalysisOptions.cropping_aspect_ratios + name: cropping_aspect_ratios + summary: 'Get the list of aspect ratios to be used for cropping. + + This list will be empty if aspect ratios have not been set before. + + An aspect ratio is calculated by dividing the target crop width by the height. + + Supported values are between 0.75 and 1.8 (inclusive).' +- uid: azure.ai.vision.ImageAnalysisOptions.features + name: features + summary: Gets the list of one or more visual features to extract from the image. +- uid: azure.ai.vision.ImageAnalysisOptions.gender_neutral_caption + name: gender_neutral_caption + summary: 'Gets the gender neutrality of the Image Analysis caption result. + + Only relevant when ImageAnalysisFeature.CAPTION is set in the features property. + + The default is False.' +- uid: azure.ai.vision.ImageAnalysisOptions.language + name: language + summary: 'Gets the language that Image Analysis should use in the results. + + The language is in format ISO 639-1, e.g. "en" for English or "fr" for French. + + If this value is not set, the default value is "en" for English. + + See [https://aka.ms/cv-languages](https://aka.ms/cv-languages) for a list of supported + language codes and which + + visual features are supported for each language.' +- uid: azure.ai.vision.ImageAnalysisOptions.model_name + name: model_name + summary: 'Gets the name of the custom-trained model that the Image Analysis Service + uses. + + An empty string indicates that the default (standard) model will be used.' +- uid: azure.ai.vision.ImageAnalysisOptions.model_version + name: model_version + summary: Gets the model version that the Image Analysis Service should use. +- uid: azure.ai.vision.ImageAnalysisOptions.properties + name: properties + summary: A collection of properties used for advanced settings. +- uid: azure.ai.vision.ImageAnalysisOptions.segmentation_mode + name: segmentation_mode + summary: Gets the current segmentation mode. diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalysisResult.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalysisResult.yml new file mode 100644 index 00000000..8f20fe9a --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalysisResult.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.ImageAnalysisResult +name: ImageAnalysisResult +fullName: azure.ai.vision.ImageAnalysisResult +module: azure.ai.vision +summary: 'Represents the outcome of an Image Analysis operation. + + + Always start by checking the value of reason property to determine if the analysis + + operation was successful or not. + + + When an analysis operation is successful, applicable properties in this object + + will be populated based on the selected features (ImageAnalysisOptions.features) + + or custom-trained model (ImageAnalysisOptions.model_name). + + These results are parsed from the service JSON response. + + Other properties will be None. + + + Call ImageAnalysisResultDetails.from_result to get access to additional + + information about the result, such as the raw JSON response. + + + When analysis operation failed, call ImageAnalysisErrorDetails.from_result + + to get access to additional information about the error.' +constructor: + syntax: 'ImageAnalysisResult(handle: c_void_p)' + parameters: + - name: handle + description: Internal handle for image analysis result. + isRequired: true +attributes: +- uid: azure.ai.vision.ImageAnalysisResult.caption + name: caption + summary: 'A generated phrase that describes the content of the analyzed image. + + + This result will only be populated if ImageAnalysisFeature.CAPTION was included + + while setting ImageAnalysisOptions.features.' +- uid: azure.ai.vision.ImageAnalysisResult.crop_suggestions + name: crop_suggestions + summary: 'A list of suggested image crop operations of the analyzed + + image at the desired aspect ratios (if provided) + + + Also knows as SmartCrops. These cropping suggestions preserve as much content + + as possible while achieving the specified aspect ratios (if provided). + + + This result will only be populated if ImageAnalysisFeature.CROP_SUGGESTIONS was + included + + while setting ImageAnalysisOptions.features. + + + Optionally, specify one or more desired cropping aspect ratios by setting + + ImageAnalysisOptions.cropping_aspect_ratios. If cropping_aspect_ratios is not + set, the Service will + + return one crop suggestion with an aspect ratio it sees fit.' +- uid: azure.ai.vision.ImageAnalysisResult.custom_objects + name: custom_objects + summary: 'A list of detected objects from the analyzed image, using the provided + + custom-trained model. + + + This result may be populated if ImageAnalysisOptions.model_name + + was set.' +- uid: azure.ai.vision.ImageAnalysisResult.custom_tags + name: custom_tags + summary: 'A list of content tag detections from the analyzed image, using the provided + + custom-trained model. + + + This result may be populated if ImageAnalysisOptions.model_name + + was set.' +- uid: azure.ai.vision.ImageAnalysisResult.dense_captions + name: dense_captions + summary: 'Gets up to 10 generated phrases, the first describing the content of the + whole image, + + and the others describing the content of different regions of the image. + + + This result will only be populated if ImageAnalysisFeature.DENSE_CAPTIONS was + included + + while setting ImageAnalysisOptions.features.' +- uid: azure.ai.vision.ImageAnalysisResult.image_height + name: image_height + summary: The height, in pixels, of the analyzed image. +- uid: azure.ai.vision.ImageAnalysisResult.image_width + name: image_width + summary: The width, in pixels, of the analyzed image. +- uid: azure.ai.vision.ImageAnalysisResult.model_version + name: model_version + summary: The model version used by the Image Analysis Service to create this result. +- uid: azure.ai.vision.ImageAnalysisResult.objects + name: objects + summary: 'A list of detected objects from the analyzed image. + + + This result will only be populated if ImageAnalysisFeature.OBJECTS was included + + while setting ImageAnalysisOptions.features.' +- uid: azure.ai.vision.ImageAnalysisResult.people + name: people + summary: 'A list of detected people from an analyzed image. + + + This result will only be populated if ImageAnalysisFeature.PEOPLE was included + + while setting ImageAnalysisOptions.features.' +- uid: azure.ai.vision.ImageAnalysisResult.reason + name: reason + summary: A value indicating why this result was generated. +- uid: azure.ai.vision.ImageAnalysisResult.segmentation_result + name: segmentation_result + summary: 'The resulting image segmentation operation. + + + This result will only be populated if ImageAnalysisOptions.segmentation_mode + + was set to either ImageSegmentationMode.BACKGROUND_REMOVAL or + + ImageSegmentationMode.FOREGROUND_MATTING.' +- uid: azure.ai.vision.ImageAnalysisResult.tags + name: tags + summary: 'A list of content tag detections from the analyzed image. + + + This result will only be populated if ImageAnalysisFeature.TAGS was included + + while setting ImageAnalysisOptions.features.' +- uid: azure.ai.vision.ImageAnalysisResult.text + name: text + summary: 'A collection of extracted textual lines and words from an analyzed image. + + + This result will only be populated if ImageAnalysisFeature.TEXT was included + + while setting ImageAnalysisOptions.features.' diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalysisResultDetails.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalysisResultDetails.yml new file mode 100644 index 00000000..5263d043 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalysisResultDetails.yml @@ -0,0 +1,48 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.ImageAnalysisResultDetails +name: ImageAnalysisResultDetails +fullName: azure.ai.vision.ImageAnalysisResultDetails +module: azure.ai.vision +summary: Represents additional information related to an image analysis result. +constructor: + syntax: ImageAnalysisResultDetails() +methods: +- uid: azure.ai.vision.ImageAnalysisResultDetails.from_result + name: from_result + summary: 'Creates an object that contains additional information related to an image + analysis result. + + + This includes the raw JSON response from the service, and other + + details related to the service connection and image source.' + signature: 'static from_result(result: ImageAnalysisResult)' + parameters: + - name: result + description: The result object from an image analysis operation. + isRequired: true +attributes: +- uid: azure.ai.vision.ImageAnalysisResultDetails.connection_url + name: connection_url + summary: 'The full URL used to connect to the Image Analysis service + + to get these results. It includes the query URL parameters.' +- uid: azure.ai.vision.ImageAnalysisResultDetails.image_id + name: image_id + summary: 'The identifier of the analyzed image. This could be the full-path + + image file name, image URL, or an empty string, depending on how the VisionSource + was created. + + It will be an empty string if the image was passed in as a byte array.' +- uid: azure.ai.vision.ImageAnalysisResultDetails.json_result + name: json_result + summary: 'Gets the JSON response payload from the Vision Service that was deserialized + + to create the provided ImageAnalysisResult.' +- uid: azure.ai.vision.ImageAnalysisResultDetails.properties + name: properties + summary: A collection of advanced properties on the result details. +- uid: azure.ai.vision.ImageAnalysisResultDetails.result_id + name: result_id + summary: The unique identifier from the Vision Service, associated with this result. diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalyzer.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalyzer.yml new file mode 100644 index 00000000..9c5fd043 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageAnalyzer.yml @@ -0,0 +1,46 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.ImageAnalyzer +name: ImageAnalyzer +fullName: azure.ai.vision.ImageAnalyzer +module: azure.ai.vision +summary: An object that facilitates Image Analysis operations with the Computer Vision + service +constructor: + syntax: 'ImageAnalyzer(service_options: VisionServiceOptions, vision_source: VisionSource, + analysis_options: ImageAnalysisOptions)' + parameters: + - name: service_options + description: The Vision Service Options used to connect to the service. + isRequired: true + - name: vision_source + description: The Vision Source to use. + isRequired: true + - name: analysis_options + description: The Image Analysis Options to use. + isRequired: true +methods: +- uid: azure.ai.vision.ImageAnalyzer.analyze + name: analyze + summary: 'Performs a single Image Analysis operation using the source provided when + this ImageAnalyzer was created. + + The operation is synchronous, and blocks until the service call completes.' + signature: analyze() -> ImageAnalysisResult + return: + description: The Image Analysis results. +- uid: azure.ai.vision.ImageAnalyzer.analyze_async + name: analyze_async + summary: Begins a single Image Analysis operation against the source provided when + this ImageAnalyzer was created. + signature: async analyze_async() -> ImageAnalysisResult + return: + description: The Image Analysis results. +attributes: +- uid: azure.ai.vision.ImageAnalyzer.analyzed + name: analyzed + summary: 'An event signal that is raised when a new ImageAnalysisResult is available + + (either analysis succeeded or an error occurred)' +- uid: azure.ai.vision.ImageAnalyzer.properties + name: properties + summary: A collection of advanced ImageAnalyzer properties. diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageSourceBuffer.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageSourceBuffer.yml new file mode 100644 index 00000000..a5238bff --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageSourceBuffer.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.ImageSourceBuffer +name: ImageSourceBuffer +fullName: azure.ai.vision.ImageSourceBuffer +module: azure.ai.vision +summary: 'Represents a source of image data, used as input to or output from Vision + AI operations. + + + > [!NOTE] + + > When used with ImageAnalyzer, callback is not supported. Call this constructor + without arguments. + + > + + > Then, using the image_writer property, get access to the ImageWriter object and + write the image data to it. + + >' +constructor: + syntax: 'ImageSourceBuffer(image_callback: ImageSourceBufferCallback | None = None)' + parameters: + - name: image_callback + description: An optional callback function that will be invoked when a new image + is needed. + defaultValue: None +methods: +- uid: azure.ai.vision.ImageSourceBuffer.close + name: close + summary: Closes the image source buffer for writing. + signature: close() -> None +attributes: +- uid: azure.ai.vision.ImageSourceBuffer.image_writer + name: image_writer diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageSourceBufferCallback.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageSourceBufferCallback.yml new file mode 100644 index 00000000..aa4e41aa --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageSourceBufferCallback.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.ImageSourceBufferCallback +name: ImageSourceBufferCallback +fullName: azure.ai.vision.ImageSourceBufferCallback +module: azure.ai.vision +summary: 'An interface that defines callback method used with ImageSourceBuffer. + + + Not implemented.' +constructor: + syntax: ImageSourceBufferCallback() +methods: +- uid: azure.ai.vision.ImageSourceBufferCallback.callback + name: callback + summary: This function is called by native side when new data is requested to be + written using ImageWriter + signature: 'callback(image_writer: ImageWriter) -> None' + parameters: + - name: image_writer + description: the image writer object. + isRequired: true diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageWriter.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageWriter.yml new file mode 100644 index 00000000..b4f0f103 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.ImageWriter.yml @@ -0,0 +1,38 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.ImageWriter +name: ImageWriter +fullName: azure.ai.vision.ImageWriter +module: azure.ai.vision +summary: Represents the ability to write image data, for use as input to Vision AI + operations. +constructor: + syntax: 'ImageWriter(handle: c_void_p)' + parameters: + - name: handle + isRequired: true +methods: +- uid: azure.ai.vision.ImageWriter.write + name: write + summary: 'Writes a single image to the internal buffer. + + + > [!NOTE] + + > When used with ImageAnalyzer, the image needs to be in a format that''s supported + by the Image Analysis service, + + > + + > such as JPEG, PNG or BMP. See full list of supported formats here: [https://aka.ms/ia-input](https://aka.ms/ia-input). + + > + + > The SDK sends the image buffer as-is to the service. It does not do any format + conversion or other modifications. + + >' + signature: 'write(buffer: bytes)' + parameters: + - name: buffer + description: The image buffer as a bytes object. + isRequired: true diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.MemoryLogger.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.MemoryLogger.yml new file mode 100644 index 00000000..ff37966d --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.MemoryLogger.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.MemoryLogger +name: MemoryLogger +fullName: azure.ai.vision.MemoryLogger +module: azure.ai.vision +summary: Represents a process-wide singleton that stores SDK log messages in a memory + buffer. +constructor: + syntax: MemoryLogger() +methods: +- uid: azure.ai.vision.MemoryLogger.dump_to_file + name: dump_to_file + summary: Dumps the internal logging buffer to a given file. + signature: 'static dump_to_file(file_name: str)' + parameters: + - name: file_name + isRequired: true +- uid: azure.ai.vision.MemoryLogger.dump_to_list + name: dump_to_list + summary: Dumps the internal logging buffer to a list of strings. + signature: static dump_to_list() -> list +- uid: azure.ai.vision.MemoryLogger.start + name: start + summary: Starts logging to an internal buffer. + signature: static start() +- uid: azure.ai.vision.MemoryLogger.stop + name: stop + summary: Stop logging to an internal buffer. + signature: static stop() diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.VisionServiceOptions.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.VisionServiceOptions.yml new file mode 100644 index 00000000..f98790a5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.VisionServiceOptions.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.VisionServiceOptions +name: VisionServiceOptions +fullName: azure.ai.vision.VisionServiceOptions +module: azure.ai.vision +summary: 'Represents the configuration options used to connect to a remote Vision + AI Service + + + key securely. For example, using Azure Key Vault. Do not compile the value of your + key into + + your application source code. Fetch it at run-time when needed from a secure location.' +constructor: + syntax: 'VisionServiceOptions(endpoint: str, key: str | None = None)' + parameters: + - name: endpoint + description: The endpoint URL of the Vision Service + isRequired: true + - name: key + description: The Computer Vision key used to authenticate against the Vision Service. + Store your + defaultValue: None +attributes: +- uid: azure.ai.vision.VisionServiceOptions.advanced + name: advanced + summary: Advanced options for the Vision Service. +- uid: azure.ai.vision.VisionServiceOptions.authorization_token + name: authorization_token + summary: The authorization token that will be used for connecting to the service. diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.VisionSource.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.VisionSource.yml new file mode 100644 index 00000000..4eefbd00 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.VisionSource.yml @@ -0,0 +1,31 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.VisionSource +name: VisionSource +fullName: azure.ai.vision.VisionSource +module: azure.ai.vision +summary: Represents a source of vision data, used as input to a Computer Vision operation. +constructor: + syntax: 'VisionSource(filename: str | None = None, url: str | None = None, image_source_buffer: + ImageSourceBuffer | None = None, frame_source: FrameSource | None = None, device_attributes: + str | None = None)' + parameters: + - name: filename + description: Specifies the locally accessible image or video file. + defaultValue: None + - name: url + description: Specifies a publicly accessible image or video URL. + defaultValue: None + - name: image_source_buffer + description: Specifies a source image buffer. + defaultValue: None + - name: frame_source + description: Specifies a frame source. + defaultValue: None + - name: device_attributes + description: A string that specifies the attributes of the device (e.g. "front=true;", + ...). + defaultValue: None +attributes: +- uid: azure.ai.vision.VisionSource.properties + name: properties + summary: A collection of properties and their values defined for this VisionSource. diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.diagnostics_logging.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.diagnostics_logging.yml new file mode 100644 index 00000000..387a7179 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.diagnostics_logging.yml @@ -0,0 +1,8 @@ +### YamlMime:PythonModule +uid: azure.ai.vision.diagnostics_logging +name: diagnostics_logging +fullName: azure.ai.vision.diagnostics_logging +summary: 'Classes that handle Vision SDK logging for troubleshooting purposes. If + you report an issue to Microsoft, + + you may be asked to provide a Vision SDK log.' diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.ImageAnalysisErrorReason.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.ImageAnalysisErrorReason.yml new file mode 100644 index 00000000..809ccd57 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.ImageAnalysisErrorReason.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonEnum +uid: azure.ai.vision.enums.ImageAnalysisErrorReason +name: ImageAnalysisErrorReason +fullName: azure.ai.vision.enums.ImageAnalysisErrorReason +summary: A categorical representation of error classes that can cause an Image Analysis + request to fail. +module: azure.ai.vision.enums +fields: +- name: AUTHENTICATION_FAILURE + uid: azure.ai.vision.enums.ImageAnalysisErrorReason.AUTHENTICATION_FAILURE +- name: BAD_REQUEST + uid: azure.ai.vision.enums.ImageAnalysisErrorReason.BAD_REQUEST +- name: CONNECTION_FAILURE + uid: azure.ai.vision.enums.ImageAnalysisErrorReason.CONNECTION_FAILURE +- name: FORBIDDEN + uid: azure.ai.vision.enums.ImageAnalysisErrorReason.FORBIDDEN +- name: RUNTIME_ERROR + uid: azure.ai.vision.enums.ImageAnalysisErrorReason.RUNTIME_ERROR +- name: SERVICE_ERROR + uid: azure.ai.vision.enums.ImageAnalysisErrorReason.SERVICE_ERROR +- name: SERVICE_TIMEOUT + uid: azure.ai.vision.enums.ImageAnalysisErrorReason.SERVICE_TIMEOUT +- name: SERVICE_UNAVAILABLE + uid: azure.ai.vision.enums.ImageAnalysisErrorReason.SERVICE_UNAVAILABLE +- name: TOO_MANY_REQUESTS + uid: azure.ai.vision.enums.ImageAnalysisErrorReason.TOO_MANY_REQUESTS diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.ImageAnalysisFeature.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.ImageAnalysisFeature.yml new file mode 100644 index 00000000..c197f87d --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.ImageAnalysisFeature.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonEnum +uid: azure.ai.vision.enums.ImageAnalysisFeature +name: ImageAnalysisFeature +fullName: azure.ai.vision.enums.ImageAnalysisFeature +summary: Defines the supported visual features to detect in an image. +module: azure.ai.vision.enums +fields: +- name: CAPTION + uid: azure.ai.vision.enums.ImageAnalysisFeature.CAPTION +- name: CROP_SUGGESTIONS + uid: azure.ai.vision.enums.ImageAnalysisFeature.CROP_SUGGESTIONS +- name: DENSE_CAPTIONS + uid: azure.ai.vision.enums.ImageAnalysisFeature.DENSE_CAPTIONS +- name: OBJECTS + uid: azure.ai.vision.enums.ImageAnalysisFeature.OBJECTS +- name: PEOPLE + uid: azure.ai.vision.enums.ImageAnalysisFeature.PEOPLE +- name: TAGS + uid: azure.ai.vision.enums.ImageAnalysisFeature.TAGS +- name: TEXT + uid: azure.ai.vision.enums.ImageAnalysisFeature.TEXT diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.ImageAnalysisResultReason.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.ImageAnalysisResultReason.yml new file mode 100644 index 00000000..a321c872 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.ImageAnalysisResultReason.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.ai.vision.enums.ImageAnalysisResultReason +name: ImageAnalysisResultReason +fullName: azure.ai.vision.enums.ImageAnalysisResultReason +summary: Represents the reasons why an Image Analysis operation concluded. +module: azure.ai.vision.enums +fields: +- name: ANALYZED + uid: azure.ai.vision.enums.ImageAnalysisResultReason.ANALYZED +- name: ERROR + uid: azure.ai.vision.enums.ImageAnalysisResultReason.ERROR diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.ImageSegmentationMode.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.ImageSegmentationMode.yml new file mode 100644 index 00000000..ede80071 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.ImageSegmentationMode.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.ai.vision.enums.ImageSegmentationMode +name: ImageSegmentationMode +fullName: azure.ai.vision.enums.ImageSegmentationMode +summary: Defines the segmentation mode supported by the Image Analysis service. +module: azure.ai.vision.enums +fields: +- name: BACKGROUND_REMOVAL + uid: azure.ai.vision.enums.ImageSegmentationMode.BACKGROUND_REMOVAL +- name: FOREGROUND_MATTING + uid: azure.ai.vision.enums.ImageSegmentationMode.FOREGROUND_MATTING +- name: NONE + uid: azure.ai.vision.enums.ImageSegmentationMode.NONE diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.SessionResultReason.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.SessionResultReason.yml new file mode 100644 index 00000000..bdf4c29d --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.SessionResultReason.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonEnum +uid: azure.ai.vision.enums.SessionResultReason +name: SessionResultReason +fullName: azure.ai.vision.enums.SessionResultReason +summary: 'Defines reasons why the session stopped erroneously. + + Not used by ImageAnalyzer.' +module: azure.ai.vision.enums +fields: +- name: DETECTED + uid: azure.ai.vision.enums.SessionResultReason.DETECTED +- name: DETECTING + uid: azure.ai.vision.enums.SessionResultReason.DETECTING +- name: NO_MATCH + uid: azure.ai.vision.enums.SessionResultReason.NO_MATCH +- name: RECOGNIZED + uid: azure.ai.vision.enums.SessionResultReason.RECOGNIZED +- name: RECOGNIZING + uid: azure.ai.vision.enums.SessionResultReason.RECOGNIZING +- name: STOPPED + uid: azure.ai.vision.enums.SessionResultReason.STOPPED diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.SessionStoppedErrorReason.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.SessionStoppedErrorReason.yml new file mode 100644 index 00000000..60a85184 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.SessionStoppedErrorReason.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonEnum +uid: azure.ai.vision.enums.SessionStoppedErrorReason +name: SessionStoppedErrorReason +fullName: azure.ai.vision.enums.SessionStoppedErrorReason +summary: 'Defines reasons why the session stopped erroneously. + + Not used by ImageAnalyzer.' +module: azure.ai.vision.enums +fields: +- name: AUTHENTICATION_FAILURE + uid: azure.ai.vision.enums.SessionStoppedErrorReason.AUTHENTICATION_FAILURE +- name: BAD_REQUEST + uid: azure.ai.vision.enums.SessionStoppedErrorReason.BAD_REQUEST +- name: CONNECTION_FAILURE + uid: azure.ai.vision.enums.SessionStoppedErrorReason.CONNECTION_FAILURE +- name: FORBIDDEN + uid: azure.ai.vision.enums.SessionStoppedErrorReason.FORBIDDEN +- name: RUNTIME_ERROR + uid: azure.ai.vision.enums.SessionStoppedErrorReason.RUNTIME_ERROR +- name: SERVICE_ERROR + uid: azure.ai.vision.enums.SessionStoppedErrorReason.SERVICE_ERROR +- name: SERVICE_TIMEOUT + uid: azure.ai.vision.enums.SessionStoppedErrorReason.SERVICE_TIMEOUT +- name: SERVICE_UNAVAILABLE + uid: azure.ai.vision.enums.SessionStoppedErrorReason.SERVICE_UNAVAILABLE +- name: TOO_MANY_REQUESTS + uid: azure.ai.vision.enums.SessionStoppedErrorReason.TOO_MANY_REQUESTS diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.SessionStoppedReason.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.SessionStoppedReason.yml new file mode 100644 index 00000000..6eae633c --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.SessionStoppedReason.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.ai.vision.enums.SessionStoppedReason +name: SessionStoppedReason +fullName: azure.ai.vision.enums.SessionStoppedReason +summary: 'Defines the reason why the session stopped. + + Not used by ImageAnalyzer.' +module: azure.ai.vision.enums +fields: +- name: ERROR + uid: azure.ai.vision.enums.SessionStoppedReason.ERROR +- name: NO_MORE_DATA + uid: azure.ai.vision.enums.SessionStoppedReason.NO_MORE_DATA +- name: STOP_REQUESTED + uid: azure.ai.vision.enums.SessionStoppedReason.STOP_REQUESTED diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.VisionOption.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.VisionOption.yml new file mode 100644 index 00000000..f308f97a --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.VisionOption.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonEnum +uid: azure.ai.vision.enums.VisionOption +name: VisionOption +fullName: azure.ai.vision.enums.VisionOption +summary: Defines the vision options base class. Not Implemented. +module: azure.ai.vision.enums diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.yml new file mode 100644 index 00000000..d5f691e2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.enums.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonModule +uid: azure.ai.vision.enums +name: enums +fullName: azure.ai.vision.enums +enums: +- azure.ai.vision.enums.ImageAnalysisErrorReason +- azure.ai.vision.enums.ImageAnalysisFeature +- azure.ai.vision.enums.ImageAnalysisResultReason +- azure.ai.vision.enums.ImageSegmentationMode +- azure.ai.vision.enums.SessionResultReason +- azure.ai.vision.enums.SessionStoppedErrorReason +- azure.ai.vision.enums.SessionStoppedReason +- azure.ai.vision.enums.VisionOption diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_client.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_client.yml new file mode 100644 index 00000000..667878f1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_client.yml @@ -0,0 +1,5 @@ +### YamlMime:PythonModule +uid: azure.ai.vision.image_analysis_client +name: image_analysis_client +fullName: azure.ai.vision.image_analysis_client +summary: Classes that represents the handling of Image Analysis functionalities. diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.ContentCaption.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.ContentCaption.yml new file mode 100644 index 00000000..5c180365 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.ContentCaption.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.image_analysis_data.ContentCaption +name: ContentCaption +fullName: azure.ai.vision.image_analysis_data.ContentCaption +module: azure.ai.vision.image_analysis_data +summary: Represents a generated phrase that describes the content of the image. +constructor: + syntax: 'ContentCaption(bounding_box: Rectangle, content: str = '''', confidence: + float = 0.0)' + parameters: + - name: bounding_box + isRequired: true + - name: content + - name: confidence + defaultValue: '0.0' +attributes: +- uid: azure.ai.vision.image_analysis_data.ContentCaption.bounding_box + name: bounding_box + summary: 'A rectangular boundary to which the caption applies. + + + Coordinates are are in pixels, with (0,0) being the top-left of the source image. + + For the ImageAnalysisFeature.CAPTION result, this will be the whole image. + + For the ImageAnalysisFeature.DENSE_CAPTIONS results, this will either be the whole + image + + or a region within the image.' + signature: 'bounding_box: Rectangle' +- uid: azure.ai.vision.image_analysis_data.ContentCaption.confidence + name: confidence + summary: 'A score, in the range of 0 to 1, representing the confidence that this + caption is accurate. + + + Confidence scores span the range of 0.0 to 1.0 (inclusive), with higher values + indicating higher probability.' + signature: 'confidence: float = 0.0' +- uid: azure.ai.vision.image_analysis_data.ContentCaption.content + name: content + summary: A generated phrase that describes the content of the image. + signature: 'content: str = ''''' diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.ContentTag.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.ContentTag.yml new file mode 100644 index 00000000..33c4189b --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.ContentTag.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.image_analysis_data.ContentTag +name: ContentTag +fullName: azure.ai.vision.image_analysis_data.ContentTag +module: azure.ai.vision.image_analysis_data +summary: Represent an image tag. A tag can be a recognizable object, living being, + scenery, or actions that appear in the image. +constructor: + syntax: 'ContentTag(name: str = '''', confidence: float = 0.0)' + parameters: + - name: name + - name: confidence + defaultValue: '0.0' +attributes: +- uid: azure.ai.vision.image_analysis_data.ContentTag.confidence + name: confidence + summary: 'A score that represents the likelihood that this detection was accurate. + + + Confidence scores span the range of 0.0 to 1.0 (inclusive), with higher values + indicating higher probability.' + signature: 'confidence: float = 0.0' +- uid: azure.ai.vision.image_analysis_data.ContentTag.name + name: name + summary: 'The name of the tag. + + + Note that you can control the tag language by calling ImageAnalysisOptions.language.' + signature: 'name: str = ''''' diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.ContentTags.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.ContentTags.yml new file mode 100644 index 00000000..fd1f74d7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.ContentTags.yml @@ -0,0 +1,107 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.image_analysis_data.ContentTags +name: ContentTags +fullName: azure.ai.vision.image_analysis_data.ContentTags +module: azure.ai.vision.image_analysis_data +summary: Represents a list of image tags +constructor: + syntax: ContentTags() +methods: +- uid: azure.ai.vision.image_analysis_data.ContentTags.append + name: append + summary: Append object to the end of the list. + signature: append(object, /) + positionalOnlyParameters: + - name: object + isRequired: true +- uid: azure.ai.vision.image_analysis_data.ContentTags.clear + name: clear + summary: Remove all items from list. + signature: clear() +- uid: azure.ai.vision.image_analysis_data.ContentTags.copy + name: copy + summary: Return a shallow copy of the list. + signature: copy() +- uid: azure.ai.vision.image_analysis_data.ContentTags.count + name: count + summary: Return number of occurrences of value. + signature: count(value, /) + positionalOnlyParameters: + - name: value + isRequired: true +- uid: azure.ai.vision.image_analysis_data.ContentTags.extend + name: extend + summary: Extend list by appending elements from the iterable. + signature: extend(iterable, /) + positionalOnlyParameters: + - name: iterable + isRequired: true +- uid: azure.ai.vision.image_analysis_data.ContentTags.index + name: index + summary: 'Return first index of value. + + + Raises ValueError if the value is not present.' + signature: index(value, start=0, stop=9223372036854775807, /) + positionalOnlyParameters: + - name: value + isRequired: true + - name: start + defaultValue: '0' + - name: stop + defaultValue: '9223372036854775807' +- uid: azure.ai.vision.image_analysis_data.ContentTags.insert + name: insert + summary: Insert object before index. + signature: insert(index, object, /) + positionalOnlyParameters: + - name: index + isRequired: true + - name: object + isRequired: true +- uid: azure.ai.vision.image_analysis_data.ContentTags.pop + name: pop + summary: 'Remove and return item at index (default last). + + + Raises IndexError if list is empty or index is out of range.' + signature: pop(index=-1, /) + positionalOnlyParameters: + - name: index + defaultValue: '-1' +- uid: azure.ai.vision.image_analysis_data.ContentTags.remove + name: remove + summary: 'Remove first occurrence of value. + + + Raises ValueError if the value is not present.' + signature: remove(value, /) + positionalOnlyParameters: + - name: value + isRequired: true +- uid: azure.ai.vision.image_analysis_data.ContentTags.reverse + name: reverse + summary: Reverse *IN PLACE*. + signature: reverse() +- uid: azure.ai.vision.image_analysis_data.ContentTags.sort + name: sort + summary: 'Sort the list in ascending order and return None. + + + The sort is in-place (i.e. the list itself is modified) and stable (i.e. the + + order of two equal elements is maintained). + + + If a key function is given, apply it once to each list item and sort them, + + ascending or descending, according to their function values. + + + The reverse flag can be set to sort in descending order.' + signature: sort(*, key=None, reverse=False) + keywordOnlyParameters: + - name: key + isRequired: true + - name: reverse + isRequired: true diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.CropSuggestion.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.CropSuggestion.yml new file mode 100644 index 00000000..8bfbe5c6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.CropSuggestion.yml @@ -0,0 +1,37 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.image_analysis_data.CropSuggestion +name: CropSuggestion +fullName: azure.ai.vision.image_analysis_data.CropSuggestion +module: azure.ai.vision.image_analysis_data +summary: Represents a suggested image cropping that preserves much of the image content. +constructor: + syntax: 'CropSuggestion(bounding_box: Rectangle, aspect_ratio: float = 0.0)' + parameters: + - name: bounding_box + isRequired: true + - name: aspect_ratio + defaultValue: '0.0' +attributes: +- uid: azure.ai.vision.image_analysis_data.CropSuggestion.aspect_ratio + name: aspect_ratio + summary: 'The aspect ratio of this crop suggestion. + + + Aspect ratios are calculated by dividing the width of the cropped region by its + height. + + + You can request particular aspect ratios by calling setting ImageAnalysisOptions.cropping_aspect_ratios. + + + aspect_ratio will be in the range 0.75 to 1.8 (inclusive) if ImageAnalysisOptions.cropping_aspect_ratios + + was called, otherwise it will be in the range 0.5 to 2.0 (inclusive).' + signature: 'aspect_ratio: float = 0.0' +- uid: azure.ai.vision.image_analysis_data.CropSuggestion.bounding_box + name: bounding_box + summary: 'A rectangular boundary of the crop suggestion. + + + Coordinates are are in pixels, with (0,0) being the top-left of the source image.' + signature: 'bounding_box: Rectangle' diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.CropSuggestions.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.CropSuggestions.yml new file mode 100644 index 00000000..f8fe6a8b --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.CropSuggestions.yml @@ -0,0 +1,108 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.image_analysis_data.CropSuggestions +name: CropSuggestions +fullName: azure.ai.vision.image_analysis_data.CropSuggestions +module: azure.ai.vision.image_analysis_data +summary: Represents a list of image crop suggestions that preserve most of the image + content. +constructor: + syntax: CropSuggestions() +methods: +- uid: azure.ai.vision.image_analysis_data.CropSuggestions.append + name: append + summary: Append object to the end of the list. + signature: append(object, /) + positionalOnlyParameters: + - name: object + isRequired: true +- uid: azure.ai.vision.image_analysis_data.CropSuggestions.clear + name: clear + summary: Remove all items from list. + signature: clear() +- uid: azure.ai.vision.image_analysis_data.CropSuggestions.copy + name: copy + summary: Return a shallow copy of the list. + signature: copy() +- uid: azure.ai.vision.image_analysis_data.CropSuggestions.count + name: count + summary: Return number of occurrences of value. + signature: count(value, /) + positionalOnlyParameters: + - name: value + isRequired: true +- uid: azure.ai.vision.image_analysis_data.CropSuggestions.extend + name: extend + summary: Extend list by appending elements from the iterable. + signature: extend(iterable, /) + positionalOnlyParameters: + - name: iterable + isRequired: true +- uid: azure.ai.vision.image_analysis_data.CropSuggestions.index + name: index + summary: 'Return first index of value. + + + Raises ValueError if the value is not present.' + signature: index(value, start=0, stop=9223372036854775807, /) + positionalOnlyParameters: + - name: value + isRequired: true + - name: start + defaultValue: '0' + - name: stop + defaultValue: '9223372036854775807' +- uid: azure.ai.vision.image_analysis_data.CropSuggestions.insert + name: insert + summary: Insert object before index. + signature: insert(index, object, /) + positionalOnlyParameters: + - name: index + isRequired: true + - name: object + isRequired: true +- uid: azure.ai.vision.image_analysis_data.CropSuggestions.pop + name: pop + summary: 'Remove and return item at index (default last). + + + Raises IndexError if list is empty or index is out of range.' + signature: pop(index=-1, /) + positionalOnlyParameters: + - name: index + defaultValue: '-1' +- uid: azure.ai.vision.image_analysis_data.CropSuggestions.remove + name: remove + summary: 'Remove first occurrence of value. + + + Raises ValueError if the value is not present.' + signature: remove(value, /) + positionalOnlyParameters: + - name: value + isRequired: true +- uid: azure.ai.vision.image_analysis_data.CropSuggestions.reverse + name: reverse + summary: Reverse *IN PLACE*. + signature: reverse() +- uid: azure.ai.vision.image_analysis_data.CropSuggestions.sort + name: sort + summary: 'Sort the list in ascending order and return None. + + + The sort is in-place (i.e. the list itself is modified) and stable (i.e. the + + order of two equal elements is maintained). + + + If a key function is given, apply it once to each list item and sort them, + + ascending or descending, according to their function values. + + + The reverse flag can be set to sort in descending order.' + signature: sort(*, key=None, reverse=False) + keywordOnlyParameters: + - name: key + isRequired: true + - name: reverse + isRequired: true diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DenseCaptions.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DenseCaptions.yml new file mode 100644 index 00000000..d3b84794 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DenseCaptions.yml @@ -0,0 +1,112 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.image_analysis_data.DenseCaptions +name: DenseCaptions +fullName: azure.ai.vision.image_analysis_data.DenseCaptions +module: azure.ai.vision.image_analysis_data +summary: 'Represents a list of up to 10 captions for different regions of the image. + + The first caption in the list represents the the whole image, and it is identical + to the result + + returned if you select the option ImageAnalysisFeature.CAPTION.' +constructor: + syntax: DenseCaptions() +methods: +- uid: azure.ai.vision.image_analysis_data.DenseCaptions.append + name: append + summary: Append object to the end of the list. + signature: append(object, /) + positionalOnlyParameters: + - name: object + isRequired: true +- uid: azure.ai.vision.image_analysis_data.DenseCaptions.clear + name: clear + summary: Remove all items from list. + signature: clear() +- uid: azure.ai.vision.image_analysis_data.DenseCaptions.copy + name: copy + summary: Return a shallow copy of the list. + signature: copy() +- uid: azure.ai.vision.image_analysis_data.DenseCaptions.count + name: count + summary: Return number of occurrences of value. + signature: count(value, /) + positionalOnlyParameters: + - name: value + isRequired: true +- uid: azure.ai.vision.image_analysis_data.DenseCaptions.extend + name: extend + summary: Extend list by appending elements from the iterable. + signature: extend(iterable, /) + positionalOnlyParameters: + - name: iterable + isRequired: true +- uid: azure.ai.vision.image_analysis_data.DenseCaptions.index + name: index + summary: 'Return first index of value. + + + Raises ValueError if the value is not present.' + signature: index(value, start=0, stop=9223372036854775807, /) + positionalOnlyParameters: + - name: value + isRequired: true + - name: start + defaultValue: '0' + - name: stop + defaultValue: '9223372036854775807' +- uid: azure.ai.vision.image_analysis_data.DenseCaptions.insert + name: insert + summary: Insert object before index. + signature: insert(index, object, /) + positionalOnlyParameters: + - name: index + isRequired: true + - name: object + isRequired: true +- uid: azure.ai.vision.image_analysis_data.DenseCaptions.pop + name: pop + summary: 'Remove and return item at index (default last). + + + Raises IndexError if list is empty or index is out of range.' + signature: pop(index=-1, /) + positionalOnlyParameters: + - name: index + defaultValue: '-1' +- uid: azure.ai.vision.image_analysis_data.DenseCaptions.remove + name: remove + summary: 'Remove first occurrence of value. + + + Raises ValueError if the value is not present.' + signature: remove(value, /) + positionalOnlyParameters: + - name: value + isRequired: true +- uid: azure.ai.vision.image_analysis_data.DenseCaptions.reverse + name: reverse + summary: Reverse *IN PLACE*. + signature: reverse() +- uid: azure.ai.vision.image_analysis_data.DenseCaptions.sort + name: sort + summary: 'Sort the list in ascending order and return None. + + + The sort is in-place (i.e. the list itself is modified) and stable (i.e. the + + order of two equal elements is maintained). + + + If a key function is given, apply it once to each list item and sort them, + + ascending or descending, according to their function values. + + + The reverse flag can be set to sort in descending order.' + signature: sort(*, key=None, reverse=False) + keywordOnlyParameters: + - name: key + isRequired: true + - name: reverse + isRequired: true diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedObject.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedObject.yml new file mode 100644 index 00000000..d97577cb --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedObject.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.image_analysis_data.DetectedObject +name: DetectedObject +fullName: azure.ai.vision.image_analysis_data.DetectedObject +module: azure.ai.vision.image_analysis_data +summary: Represents a physical object detected in an image. +constructor: + syntax: 'DetectedObject(bounding_box: Rectangle, name: str = '''', confidence: float + = 0.0)' + parameters: + - name: bounding_box + isRequired: true + - name: name + - name: confidence + defaultValue: '0.0' +attributes: +- uid: azure.ai.vision.image_analysis_data.DetectedObject.bounding_box + name: bounding_box + summary: 'A rectangular boundary within which the object was detected. + + + Coordinates are are in pixels, with (0,0) being the top-left of the source image.' + signature: 'bounding_box: Rectangle' +- uid: azure.ai.vision.image_analysis_data.DetectedObject.confidence + name: confidence + summary: 'A score that represents the likelihood that this detection was accurate. + + + Confidence scores span the range of 0.0 to 1.0 (inclusive), with higher values + indicating higher probability.' + signature: 'confidence: float = 0.0' +- uid: azure.ai.vision.image_analysis_data.DetectedObject.name + name: name + summary: A label that briefly describes the detected object. + signature: 'name: str = ''''' diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedObjects.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedObjects.yml new file mode 100644 index 00000000..21604202 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedObjects.yml @@ -0,0 +1,107 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.image_analysis_data.DetectedObjects +name: DetectedObjects +fullName: azure.ai.vision.image_analysis_data.DetectedObjects +module: azure.ai.vision.image_analysis_data +summary: Represents a list of physical object detected in an image. +constructor: + syntax: DetectedObjects() +methods: +- uid: azure.ai.vision.image_analysis_data.DetectedObjects.append + name: append + summary: Append object to the end of the list. + signature: append(object, /) + positionalOnlyParameters: + - name: object + isRequired: true +- uid: azure.ai.vision.image_analysis_data.DetectedObjects.clear + name: clear + summary: Remove all items from list. + signature: clear() +- uid: azure.ai.vision.image_analysis_data.DetectedObjects.copy + name: copy + summary: Return a shallow copy of the list. + signature: copy() +- uid: azure.ai.vision.image_analysis_data.DetectedObjects.count + name: count + summary: Return number of occurrences of value. + signature: count(value, /) + positionalOnlyParameters: + - name: value + isRequired: true +- uid: azure.ai.vision.image_analysis_data.DetectedObjects.extend + name: extend + summary: Extend list by appending elements from the iterable. + signature: extend(iterable, /) + positionalOnlyParameters: + - name: iterable + isRequired: true +- uid: azure.ai.vision.image_analysis_data.DetectedObjects.index + name: index + summary: 'Return first index of value. + + + Raises ValueError if the value is not present.' + signature: index(value, start=0, stop=9223372036854775807, /) + positionalOnlyParameters: + - name: value + isRequired: true + - name: start + defaultValue: '0' + - name: stop + defaultValue: '9223372036854775807' +- uid: azure.ai.vision.image_analysis_data.DetectedObjects.insert + name: insert + summary: Insert object before index. + signature: insert(index, object, /) + positionalOnlyParameters: + - name: index + isRequired: true + - name: object + isRequired: true +- uid: azure.ai.vision.image_analysis_data.DetectedObjects.pop + name: pop + summary: 'Remove and return item at index (default last). + + + Raises IndexError if list is empty or index is out of range.' + signature: pop(index=-1, /) + positionalOnlyParameters: + - name: index + defaultValue: '-1' +- uid: azure.ai.vision.image_analysis_data.DetectedObjects.remove + name: remove + summary: 'Remove first occurrence of value. + + + Raises ValueError if the value is not present.' + signature: remove(value, /) + positionalOnlyParameters: + - name: value + isRequired: true +- uid: azure.ai.vision.image_analysis_data.DetectedObjects.reverse + name: reverse + summary: Reverse *IN PLACE*. + signature: reverse() +- uid: azure.ai.vision.image_analysis_data.DetectedObjects.sort + name: sort + summary: 'Sort the list in ascending order and return None. + + + The sort is in-place (i.e. the list itself is modified) and stable (i.e. the + + order of two equal elements is maintained). + + + If a key function is given, apply it once to each list item and sort them, + + ascending or descending, according to their function values. + + + The reverse flag can be set to sort in descending order.' + signature: sort(*, key=None, reverse=False) + keywordOnlyParameters: + - name: key + isRequired: true + - name: reverse + isRequired: true diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedPeople.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedPeople.yml new file mode 100644 index 00000000..d79fa7ea --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedPeople.yml @@ -0,0 +1,107 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.image_analysis_data.DetectedPeople +name: DetectedPeople +fullName: azure.ai.vision.image_analysis_data.DetectedPeople +module: azure.ai.vision.image_analysis_data +summary: Represents people detected in the image. +constructor: + syntax: DetectedPeople() +methods: +- uid: azure.ai.vision.image_analysis_data.DetectedPeople.append + name: append + summary: Append object to the end of the list. + signature: append(object, /) + positionalOnlyParameters: + - name: object + isRequired: true +- uid: azure.ai.vision.image_analysis_data.DetectedPeople.clear + name: clear + summary: Remove all items from list. + signature: clear() +- uid: azure.ai.vision.image_analysis_data.DetectedPeople.copy + name: copy + summary: Return a shallow copy of the list. + signature: copy() +- uid: azure.ai.vision.image_analysis_data.DetectedPeople.count + name: count + summary: Return number of occurrences of value. + signature: count(value, /) + positionalOnlyParameters: + - name: value + isRequired: true +- uid: azure.ai.vision.image_analysis_data.DetectedPeople.extend + name: extend + summary: Extend list by appending elements from the iterable. + signature: extend(iterable, /) + positionalOnlyParameters: + - name: iterable + isRequired: true +- uid: azure.ai.vision.image_analysis_data.DetectedPeople.index + name: index + summary: 'Return first index of value. + + + Raises ValueError if the value is not present.' + signature: index(value, start=0, stop=9223372036854775807, /) + positionalOnlyParameters: + - name: value + isRequired: true + - name: start + defaultValue: '0' + - name: stop + defaultValue: '9223372036854775807' +- uid: azure.ai.vision.image_analysis_data.DetectedPeople.insert + name: insert + summary: Insert object before index. + signature: insert(index, object, /) + positionalOnlyParameters: + - name: index + isRequired: true + - name: object + isRequired: true +- uid: azure.ai.vision.image_analysis_data.DetectedPeople.pop + name: pop + summary: 'Remove and return item at index (default last). + + + Raises IndexError if list is empty or index is out of range.' + signature: pop(index=-1, /) + positionalOnlyParameters: + - name: index + defaultValue: '-1' +- uid: azure.ai.vision.image_analysis_data.DetectedPeople.remove + name: remove + summary: 'Remove first occurrence of value. + + + Raises ValueError if the value is not present.' + signature: remove(value, /) + positionalOnlyParameters: + - name: value + isRequired: true +- uid: azure.ai.vision.image_analysis_data.DetectedPeople.reverse + name: reverse + summary: Reverse *IN PLACE*. + signature: reverse() +- uid: azure.ai.vision.image_analysis_data.DetectedPeople.sort + name: sort + summary: 'Sort the list in ascending order and return None. + + + The sort is in-place (i.e. the list itself is modified) and stable (i.e. the + + order of two equal elements is maintained). + + + If a key function is given, apply it once to each list item and sort them, + + ascending or descending, according to their function values. + + + The reverse flag can be set to sort in descending order.' + signature: sort(*, key=None, reverse=False) + keywordOnlyParameters: + - name: key + isRequired: true + - name: reverse + isRequired: true diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedPerson.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedPerson.yml new file mode 100644 index 00000000..8300f602 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedPerson.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.image_analysis_data.DetectedPerson +name: DetectedPerson +fullName: azure.ai.vision.image_analysis_data.DetectedPerson +module: azure.ai.vision.image_analysis_data +summary: Represents a person detected in an image. +constructor: + syntax: 'DetectedPerson(bounding_box: Rectangle, confidence: float = 0.0)' + parameters: + - name: bounding_box + isRequired: true + - name: confidence + defaultValue: '0.0' +attributes: +- uid: azure.ai.vision.image_analysis_data.DetectedPerson.bounding_box + name: bounding_box + summary: 'A rectangular boundary within which the person was detected. + + + Coordinates are are in pixels, with (0,0) being the top-left of the source image.' + signature: 'bounding_box: Rectangle' +- uid: azure.ai.vision.image_analysis_data.DetectedPerson.confidence + name: confidence + summary: 'A score that represents the likelihood that this detection was accurate. + + + Confidence scores span the range of 0.0 to 1.0 (inclusive), with higher values + indicating higher probability.' + signature: 'confidence: float = 0.0' diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedText.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedText.yml new file mode 100644 index 00000000..292931bf --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedText.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.image_analysis_data.DetectedText +name: DetectedText +fullName: azure.ai.vision.image_analysis_data.DetectedText +module: azure.ai.vision.image_analysis_data +summary: Represents the text lines detected in an image. +constructor: + syntax: 'DetectedText(lines: List[DetectedTextLine])' + parameters: + - name: lines + isRequired: true +attributes: +- uid: azure.ai.vision.image_analysis_data.DetectedText.lines + name: lines + summary: The full list of all lines of text detected in an image. + signature: 'lines: List[DetectedTextLine]' diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedTextLine.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedTextLine.yml new file mode 100644 index 00000000..445270a4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedTextLine.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.image_analysis_data.DetectedTextLine +name: DetectedTextLine +fullName: azure.ai.vision.image_analysis_data.DetectedTextLine +module: azure.ai.vision.image_analysis_data +summary: Represents a single, contiguous line of text as detected within an image. +constructor: + syntax: 'DetectedTextLine(content: str, bounding_polygon: List[int], words: List[DetectedTextWord])' + parameters: + - name: content + isRequired: true + - name: bounding_polygon + isRequired: true + - name: words + isRequired: true +attributes: +- uid: azure.ai.vision.image_analysis_data.DetectedTextLine.bounding_polygon + name: bounding_polygon + summary: 'A bounding polygon with points that enclose this line of text. + + + These points are polygon vertices, presented in clockwise order from the left + (-180 degrees, inclusive) + + relative to the region''s orientation. Coordinates are are in pixels, with (0,0) + being the top-left of the source image.' + signature: 'bounding_polygon: List[int]' +- uid: azure.ai.vision.image_analysis_data.DetectedTextLine.content + name: content + summary: The text detected in this line. + signature: 'content: str' +- uid: azure.ai.vision.image_analysis_data.DetectedTextLine.words + name: words + summary: A list of detected words associated with this line. + signature: 'words: List[DetectedTextWord]' diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedTextWord.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedTextWord.yml new file mode 100644 index 00000000..6652ba58 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedTextWord.yml @@ -0,0 +1,46 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.image_analysis_data.DetectedTextWord +name: DetectedTextWord +fullName: azure.ai.vision.image_analysis_data.DetectedTextWord +module: azure.ai.vision.image_analysis_data +summary: 'Represents a single word that was detected in an image. + + + Words consist of a contiguous sequence of characters. + + For non-space delimited languages such as Chinese, Japanese, and Korean, each character + is represented as its own word.' +constructor: + syntax: 'DetectedTextWord(content: str, bounding_polygon: List[int], confidence: + float = 0.0)' + parameters: + - name: content + isRequired: true + - name: bounding_polygon + isRequired: true + - name: confidence + defaultValue: '0.0' +attributes: +- uid: azure.ai.vision.image_analysis_data.DetectedTextWord.bounding_polygon + name: bounding_polygon + summary: 'A bounding polygon with points that enclose the word. + + + These points are polygon vertices, presented in clockwise order from the left + (-180 degrees, inclusive) + + relative to the region''s orientation. Coordinates are are in pixels, with (0,0) + being the top-left of the source image.' + signature: 'bounding_polygon: List[int]' +- uid: azure.ai.vision.image_analysis_data.DetectedTextWord.confidence + name: confidence + summary: 'A score that represents the likelihood that this detection was accurate. + + + Confidence scores span the range of 0.0 to 1.0 (inclusive), with higher values + indicating higher probability.' + signature: 'confidence: float = 0.0' +- uid: azure.ai.vision.image_analysis_data.DetectedTextWord.content + name: content + summary: The text detected within the bounds of this word. + signature: 'content: str' diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.Rectangle.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.Rectangle.yml new file mode 100644 index 00000000..033275e8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.Rectangle.yml @@ -0,0 +1,34 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.image_analysis_data.Rectangle +name: Rectangle +fullName: azure.ai.vision.image_analysis_data.Rectangle +module: azure.ai.vision.image_analysis_data +summary: Represents rectangular area inside an image. +constructor: + syntax: 'Rectangle(x: int = 0, y: int = 0, w: int = 0, h: int = 0)' + parameters: + - name: x + defaultValue: '0' + - name: y + defaultValue: '0' + - name: w + defaultValue: '0' + - name: h + defaultValue: '0' +attributes: +- uid: azure.ai.vision.image_analysis_data.Rectangle.h + name: h + summary: Height of the area, in pixels. + signature: 'h: int = 0' +- uid: azure.ai.vision.image_analysis_data.Rectangle.w + name: w + summary: Width of the area, in pixels. + signature: 'w: int = 0' +- uid: azure.ai.vision.image_analysis_data.Rectangle.x + name: x + summary: X-coordinate of the top left point of the area, in pixels. + signature: 'x: int = 0' +- uid: azure.ai.vision.image_analysis_data.Rectangle.y + name: y + summary: Y-coordinate of the top left point of the area, in pixels. + signature: 'y: int = 0' diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.SegmentationResult.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.SegmentationResult.yml new file mode 100644 index 00000000..69d32571 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.SegmentationResult.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.image_analysis_data.SegmentationResult +name: SegmentationResult +fullName: azure.ai.vision.image_analysis_data.SegmentationResult +module: azure.ai.vision.image_analysis_data +summary: Holds a single segmentation result image of PNG format and associated metadata. +constructor: + syntax: 'SegmentationResult(image_height: int = 0, image_width: int = 0, image_buffer: + bytes = '''')' + parameters: + - name: image_height + defaultValue: '0' + - name: image_width + defaultValue: '0' + - name: image_buffer +attributes: +- uid: azure.ai.vision.image_analysis_data.SegmentationResult.image_buffer + name: image_buffer + summary: The result image buffer in PNG format. + signature: 'image_buffer: bytes = ''''' +- uid: azure.ai.vision.image_analysis_data.SegmentationResult.image_height + name: image_height + summary: The image height in pixels. + signature: 'image_height: int = 0' +- uid: azure.ai.vision.image_analysis_data.SegmentationResult.image_width + name: image_width + summary: The image width in pixels. + signature: 'image_width: int = 0' diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.yml new file mode 100644 index 00000000..8f12e4ee --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonModule +uid: azure.ai.vision.image_analysis_data +name: image_analysis_data +fullName: azure.ai.vision.image_analysis_data +summary: Classes that represents the data structures of vision image analysis results. +classes: +- azure.ai.vision.image_analysis_data.ContentCaption +- azure.ai.vision.image_analysis_data.ContentTag +- azure.ai.vision.image_analysis_data.ContentTags +- azure.ai.vision.image_analysis_data.CropSuggestion +- azure.ai.vision.image_analysis_data.CropSuggestions +- azure.ai.vision.image_analysis_data.DenseCaptions +- azure.ai.vision.image_analysis_data.DetectedObject +- azure.ai.vision.image_analysis_data.DetectedObjects +- azure.ai.vision.image_analysis_data.DetectedPeople +- azure.ai.vision.image_analysis_data.DetectedPerson +- azure.ai.vision.image_analysis_data.DetectedText +- azure.ai.vision.image_analysis_data.DetectedTextLine +- azure.ai.vision.image_analysis_data.DetectedTextWord +- azure.ai.vision.image_analysis_data.Rectangle +- azure.ai.vision.image_analysis_data.SegmentationResult diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.interop.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.interop.yml new file mode 100644 index 00000000..ce08d742 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.interop.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.ai.vision.interop +name: interop +fullName: azure.ai.vision.interop diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.properties.PropertyCollection.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.properties.PropertyCollection.yml new file mode 100644 index 00000000..126e36ab --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.properties.PropertyCollection.yml @@ -0,0 +1,88 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.properties.PropertyCollection +name: PropertyCollection +fullName: azure.ai.vision.properties.PropertyCollection +module: azure.ai.vision.properties +summary: Class to get or set a property value from a property collection. +constructor: + syntax: 'PropertyCollection(handle: c_void_p)' + parameters: + - name: handle + isRequired: true +methods: +- uid: azure.ai.vision.properties.PropertyCollection.get_binary_data_property + name: get_binary_data_property + summary: 'Returns a Python "bytes" object created from a native binary buffer. + + Note that data from the native buffer is copied while + + creating the "bytes" object, and the native buffer is freed. + + :param: The name of the property + + :return: A Python bytes object' + signature: 'get_binary_data_property(property_name: str) -> bytes' + parameters: + - name: property_name + isRequired: true +- uid: azure.ai.vision.properties.PropertyCollection.get_property + name: get_property + summary: 'Returns value of a property. + + If the property value is not defined, the specified default value is returned. + + :param property_name: The name of the property. + + :param default_value: The default value which is returned if no value is defined + for the property (empty string by default). + + :return: Value of the property.' + signature: 'get_property(property_name: str, default_value: str = '''') -> str' + parameters: + - name: property_name + isRequired: true + - name: default_value +- uid: azure.ai.vision.properties.PropertyCollection.get_property_by_id + name: get_property_by_id + summary: 'Returns value of a property. + + If the property value is not defined, the specified default value is returned. + + :param property_id: The id of the property. + + :param default_value: The default value which is returned if no value is defined + for the property (empty string by default). + + :return: Value of the property.' + signature: 'get_property_by_id(property_id: VisionOption, default_value: str)' + parameters: + - name: property_id + isRequired: true + - name: default_value + isRequired: true +- uid: azure.ai.vision.properties.PropertyCollection.set_property + name: set_property + summary: 'Set value of a property. + + :param property_name: The id name of the property + + :param value: The value to set' + signature: 'set_property(property_name: str, value: str)' + parameters: + - name: property_name + isRequired: true + - name: value + isRequired: true +- uid: azure.ai.vision.properties.PropertyCollection.set_property_by_id + name: set_property_by_id + summary: 'Set value of a property. + + :param property_id: The id of the property enum + + :param value: The value to set' + signature: 'set_property_by_id(property_id: VisionOption, value: str)' + parameters: + - name: property_id + isRequired: true + - name: value + isRequired: true diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.properties.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.properties.yml new file mode 100644 index 00000000..0cf48f8e --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.properties.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.ai.vision.properties +name: properties +fullName: azure.ai.vision.properties +classes: +- azure.ai.vision.properties.PropertyCollection diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.version.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.version.yml new file mode 100644 index 00000000..e45357f4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.ai.vision.version +name: version +fullName: azure.ai.vision.version diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.EventSignal.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.EventSignal.yml new file mode 100644 index 00000000..cfec9c63 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.EventSignal.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.vision_base_client.EventSignal +name: EventSignal +fullName: azure.ai.vision.vision_base_client.EventSignal +module: azure.ai.vision.vision_base_client +summary: 'Clients can connect to the event signal to receive events, or disconnect + from + + the event signal to stop receiving events. + + + Constructor for internal use.' +constructor: + syntax: EventSignal(obj, connection_changed_callback) + parameters: + - name: obj + isRequired: true + - name: connection_changed_callback + isRequired: true +methods: +- uid: azure.ai.vision.vision_base_client.EventSignal.connect + name: connect + summary: 'Connects given callback function to the event signal, to be invoked when + the + + event is signalled.' + signature: 'connect(callback: Callable)' + parameters: + - name: callback + isRequired: true +- uid: azure.ai.vision.vision_base_client.EventSignal.disconnect_all + name: disconnect_all + summary: Disconnects all registered callbacks. + signature: disconnect_all() +- uid: azure.ai.vision.vision_base_client.EventSignal.is_connected + name: is_connected + signature: is_connected() -> bool +- uid: azure.ai.vision.vision_base_client.EventSignal.signal + name: signal + signature: signal(payload) + parameters: + - name: payload + isRequired: true diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.SessionStartedEventArgs.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.SessionStartedEventArgs.yml new file mode 100644 index 00000000..c85b3f30 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.SessionStartedEventArgs.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.vision_base_client.SessionStartedEventArgs +name: SessionStartedEventArgs +fullName: azure.ai.vision.vision_base_client.SessionStartedEventArgs +module: azure.ai.vision.vision_base_client +summary: 'Represents an event indicating vision session start. + + + Constructor for internal use.' +constructor: + syntax: 'SessionStartedEventArgs(handle: c_void_p)' + parameters: + - name: handle + isRequired: true +attributes: +- uid: azure.ai.vision.vision_base_client.SessionStartedEventArgs.session_id + name: session_id + summary: Gets the unique id for the Session from which this SessionResult originated. diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.SessionStoppedEventArgs.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.SessionStoppedEventArgs.yml new file mode 100644 index 00000000..80b6b35e --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.SessionStoppedEventArgs.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.vision_base_client.SessionStoppedEventArgs +name: SessionStoppedEventArgs +fullName: azure.ai.vision.vision_base_client.SessionStoppedEventArgs +module: azure.ai.vision.vision_base_client +summary: 'Represents an event indicating vision session stop. + + + Constructor for internal use.' +constructor: + syntax: 'SessionStoppedEventArgs(handle: c_void_p)' + parameters: + - name: handle + isRequired: true +attributes: +- uid: azure.ai.vision.vision_base_client.SessionStoppedEventArgs.reason + name: reason + summary: Gets the SessionStoppedReason for generation of this result. +- uid: azure.ai.vision.vision_base_client.SessionStoppedEventArgs.session_id + name: session_id + summary: Gets the unique id for the Session from which this SessionResult originated. diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.VisionServiceAdvancedOptions.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.VisionServiceAdvancedOptions.yml new file mode 100644 index 00000000..294a39d0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.VisionServiceAdvancedOptions.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.vision_base_client.VisionServiceAdvancedOptions +name: VisionServiceAdvancedOptions +fullName: azure.ai.vision.vision_base_client.VisionServiceAdvancedOptions +module: azure.ai.vision.vision_base_client +summary: Represents advanced options on the Vision Service. +constructor: + syntax: VisionServiceAdvancedOptions() +attributes: +- uid: azure.ai.vision.vision_base_client.VisionServiceAdvancedOptions.properties + name: properties + summary: A collection of properties and their values defined for this VisionServiceAdvancedOptions. diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.VisionSession.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.VisionSession.yml new file mode 100644 index 00000000..dc9def37 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.VisionSession.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.vision_base_client.VisionSession +name: VisionSession +fullName: azure.ai.vision.vision_base_client.VisionSession +module: azure.ai.vision.vision_base_client +summary: 'Represents the service configuration options and parameters used to connect + to network attached + + AI inferencing technologies over IP based protocols.' +constructor: + syntax: 'VisionSession(service_options: VisionServiceOptions, input: VisionSource, + options: VisionSessionOptions | None = None)' + parameters: + - name: service_options + description: The vision service options. + isRequired: true + - name: input + description: The vision source. + isRequired: true + - name: options + description: The vision session options. + defaultValue: None +attributes: +- uid: azure.ai.vision.vision_base_client.VisionSession.properties + name: properties + summary: A collection of properties and their values defined for this VisionSource. +- uid: azure.ai.vision.vision_base_client.VisionSession.session_id + name: session_id + summary: The authorization token that will be used for connecting to the service. diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.VisionSessionOptions.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.VisionSessionOptions.yml new file mode 100644 index 00000000..f8af664d --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.VisionSessionOptions.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonClass +uid: azure.ai.vision.vision_base_client.VisionSessionOptions +name: VisionSessionOptions +fullName: azure.ai.vision.vision_base_client.VisionSessionOptions +module: azure.ai.vision.vision_base_client +summary: 'Represents the options used to initialize a VisionSession instance. + + + TBD: Define options setter properties' +constructor: + syntax: VisionSessionOptions() +attributes: +- uid: azure.ai.vision.vision_base_client.VisionSessionOptions.properties + name: properties + summary: A collection of properties and their values defined for this. diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.yml new file mode 100644 index 00000000..bb183164 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.vision_base_client.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonModule +uid: azure.ai.vision.vision_base_client +name: vision_base_client +fullName: azure.ai.vision.vision_base_client +summary: Classes that handles vision base functionalities for the various recognizers/analyzers. +classes: +- azure.ai.vision.vision_base_client.EventSignal +- azure.ai.vision.vision_base_client.SessionStartedEventArgs +- azure.ai.vision.vision_base_client.SessionStoppedEventArgs +- azure.ai.vision.vision_base_client.VisionServiceAdvancedOptions +- azure.ai.vision.vision_base_client.VisionSession +- azure.ai.vision.vision_base_client.VisionSessionOptions diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.yml new file mode 100644 index 00000000..e8c75151 --- /dev/null +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonPackage +uid: azure.ai.vision +name: vision +fullName: azure.ai.vision +summary: Azure AI Vision SDK for Python +type: rootImport +classes: +- azure.ai.vision.ConsoleLogger +- azure.ai.vision.FileLogger +- azure.ai.vision.Frame +- azure.ai.vision.FrameFormat +- azure.ai.vision.FrameSource +- azure.ai.vision.FrameSourceCallback +- azure.ai.vision.FrameWriter +- azure.ai.vision.ImageAnalysisErrorDetails +- azure.ai.vision.ImageAnalysisEventArgs +- azure.ai.vision.ImageAnalysisOptions +- azure.ai.vision.ImageAnalysisResult +- azure.ai.vision.ImageAnalysisResultDetails +- azure.ai.vision.ImageAnalyzer +- azure.ai.vision.ImageSourceBuffer +- azure.ai.vision.ImageSourceBufferCallback +- azure.ai.vision.ImageWriter +- azure.ai.vision.MemoryLogger +- azure.ai.vision.VisionServiceOptions +- azure.ai.vision.VisionSource +modules: +- azure.ai.vision.diagnostics_logging +- azure.ai.vision.enums +- azure.ai.vision.image_analysis_client +- azure.ai.vision.image_analysis_data +- azure.ai.vision.interop +- azure.ai.vision.properties +- azure.ai.vision.version +- azure.ai.vision.vision_base_client diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.ApplicationInsightsDataClient.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.ApplicationInsightsDataClient.yml new file mode 100644 index 00000000..3274a1dd --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.ApplicationInsightsDataClient.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.ApplicationInsightsDataClient +name: ApplicationInsightsDataClient +fullName: azure.applicationinsights.ApplicationInsightsDataClient +module: azure.applicationinsights +summary: Composite Swagger for Application Insights Data Client +constructor: + syntax: ApplicationInsightsDataClient(credentials, base_url=None) + parameters: + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +- description: Metrics operations + name: metrics + types: + - +- description: Events operations + name: events + types: + - +- description: Query operations + name: query + types: + - +methods: +- uid: azure.applicationinsights.ApplicationInsightsDataClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.application_insights_data_client.ApplicationInsightsDataClient.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.application_insights_data_client.ApplicationInsightsDataClient.yml new file mode 100644 index 00000000..fa37b4b3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.application_insights_data_client.ApplicationInsightsDataClient.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.application_insights_data_client.ApplicationInsightsDataClient +name: ApplicationInsightsDataClient +fullName: azure.applicationinsights.application_insights_data_client.ApplicationInsightsDataClient +module: azure.applicationinsights.application_insights_data_client +summary: Composite Swagger for Application Insights Data Client +constructor: + syntax: ApplicationInsightsDataClient(credentials, base_url=None) + parameters: + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +- description: Metrics operations + name: metrics + types: + - +- description: Events operations + name: events + types: + - +- description: Query operations + name: query + types: + - +methods: +- uid: azure.applicationinsights.application_insights_data_client.ApplicationInsightsDataClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.application_insights_data_client.ApplicationInsightsDataClientConfiguration.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.application_insights_data_client.ApplicationInsightsDataClientConfiguration.yml new file mode 100644 index 00000000..939b40c7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.application_insights_data_client.ApplicationInsightsDataClientConfiguration.yml @@ -0,0 +1,60 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.application_insights_data_client.ApplicationInsightsDataClientConfiguration +name: ApplicationInsightsDataClientConfiguration +fullName: azure.applicationinsights.application_insights_data_client.ApplicationInsightsDataClientConfiguration +module: azure.applicationinsights.application_insights_data_client +summary: 'Configuration for ApplicationInsightsDataClient + + Note that all parameters used to create this instance are saved as instance + + attributes.' +constructor: + syntax: ApplicationInsightsDataClientConfiguration(credentials, base_url=None) + parameters: + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - +methods: +- uid: azure.applicationinsights.application_insights_data_client.ApplicationInsightsDataClientConfiguration.add_user_agent + name: add_user_agent + summary: Add value to current user agent with a space. + signature: 'add_user_agent(value: str) -> None' + parameters: + - name: value + description: value to add to user agent. + isRequired: true + types: + - +- uid: azure.applicationinsights.application_insights_data_client.ApplicationInsightsDataClientConfiguration.load + name: load + signature: load(filepath) + parameters: + - name: filepath + isRequired: true +- uid: azure.applicationinsights.application_insights_data_client.ApplicationInsightsDataClientConfiguration.save + name: save + summary: Save current configuration to file. + signature: save(filepath) + parameters: + - name: filepath + description: Path to file where settings will be saved. + isRequired: true + types: + - + exceptions: + - type: ValueError if supplied filepath cannot be written to. +attributes: +- uid: azure.applicationinsights.application_insights_data_client.ApplicationInsightsDataClientConfiguration.enable_http_logger + name: enable_http_logger +- uid: azure.applicationinsights.application_insights_data_client.ApplicationInsightsDataClientConfiguration.user_agent + name: user_agent + summary: The current user agent value. diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.application_insights_data_client.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.application_insights_data_client.yml new file mode 100644 index 00000000..03a77675 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.application_insights_data_client.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.application_insights_data_client +name: application_insights_data_client +fullName: azure.applicationinsights.application_insights_data_client +classes: +- azure.applicationinsights.application_insights_data_client.ApplicationInsightsDataClient +- azure.applicationinsights.application_insights_data_client.ApplicationInsightsDataClientConfiguration diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.Column(class).yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.Column(class).yml new file mode 100644 index 00000000..ee2e263a --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.Column(class).yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.Column +name: Column +fullName: azure.applicationinsights.models.Column +module: azure.applicationinsights.models +summary: 'A table column. + + + A column in a table.' +constructor: + syntax: 'Column(*, name: str = None, type: str = None, **kwargs)' + parameters: + - name: name + description: The name of this column. + isRequired: true + types: + - + - name: type + description: The data type of this column. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: type + isRequired: true +methods: +- uid: azure.applicationinsights.models.Column.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.Column.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.Column.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.Column.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.Column.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.Column.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.Column.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorDetail.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorDetail.yml new file mode 100644 index 00000000..4ac33432 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorDetail.yml @@ -0,0 +1,167 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.ErrorDetail +name: ErrorDetail +fullName: azure.applicationinsights.models.ErrorDetail +module: azure.applicationinsights.models +summary: 'Error details. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ErrorDetail(*, code: str, message: str, target: str = None, value: str + = None, resources=None, additional_properties=None, **kwargs)' + parameters: + - name: code + description: Required. The error's code. + isRequired: true + types: + - + - name: message + description: Required. A human readable error message. + isRequired: true + types: + - + - name: target + description: 'Indicates which property in the request is responsible for + + the error.' + isRequired: true + types: + - + - name: value + description: 'Indicates which value in ''target'' is responsible for the + + error.' + isRequired: true + types: + - + - name: resources + description: 'Indicates resources which were responsible for the + + error.' + isRequired: true + types: + - [] + - name: additional_properties + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true + - name: target + isRequired: true + - name: value + isRequired: true + - name: resources + isRequired: true + - name: additional_properties + isRequired: true +methods: +- uid: azure.applicationinsights.models.ErrorDetail.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.ErrorDetail.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.ErrorDetail.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.ErrorDetail.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.ErrorDetail.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.ErrorDetail.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.ErrorDetail.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorInfo.yml new file mode 100644 index 00000000..ffb3cb6f --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorInfo.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.ErrorInfo +name: ErrorInfo +fullName: azure.applicationinsights.models.ErrorInfo +module: azure.applicationinsights.models +summary: 'The code and message for an error. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ErrorInfo(*, code: str, message: str, details=None, innererror=None, additional_properties=None, + **kwargs)' + parameters: + - name: code + description: Required. A machine readable error code. + isRequired: true + types: + - + - name: message + description: Required. A human readable error message. + isRequired: true + types: + - + - name: details + description: error details. + isRequired: true + types: + - [] + - name: innererror + description: Inner error details if they exist. + isRequired: true + types: + - + - name: additional_properties + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true + - name: details + isRequired: true + - name: innererror + isRequired: true + - name: additional_properties + isRequired: true +methods: +- uid: azure.applicationinsights.models.ErrorInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.ErrorInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.ErrorInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.ErrorInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.ErrorInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.ErrorInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.ErrorInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorResponse.yml new file mode 100644 index 00000000..1577e2eb --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorResponse.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.ErrorResponse +name: ErrorResponse +fullName: azure.applicationinsights.models.ErrorResponse +module: azure.applicationinsights.models +summary: 'Error details. + + + Contains details when the response code indicates an error. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ErrorResponse(*, error, **kwargs) + parameters: + - name: error + description: Required. The error details. + isRequired: true + types: + - + keywordOnlyParameters: + - name: error + isRequired: true +methods: +- uid: azure.applicationinsights.models.ErrorResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.ErrorResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.ErrorResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.ErrorResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.ErrorResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.ErrorResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.ErrorResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorResponseException.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorResponseException.yml new file mode 100644 index 00000000..de7ffc14 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorResponseException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.ErrorResponseException +name: ErrorResponseException +fullName: azure.applicationinsights.models.ErrorResponseException +module: azure.applicationinsights.models +summary: 'Server responded with exception of type: ''ErrorResponse''.' +constructor: + syntax: ErrorResponseException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.applicationinsights.models.ErrorResponseException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.applicationinsights.models.ErrorResponseException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.applicationinsights.models.ErrorResponseException.args + name: args diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventType.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventType.yml new file mode 100644 index 00000000..4435b847 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventType.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonEnum +uid: azure.applicationinsights.models.EventType +name: EventType +fullName: azure.applicationinsights.models.EventType +module: azure.applicationinsights.models +fields: +- name: all + uid: azure.applicationinsights.models.EventType.all +- name: availability_results + uid: azure.applicationinsights.models.EventType.availability_results +- name: browser_timings + uid: azure.applicationinsights.models.EventType.browser_timings +- name: custom_events + uid: azure.applicationinsights.models.EventType.custom_events +- name: custom_metrics + uid: azure.applicationinsights.models.EventType.custom_metrics +- name: dependencies + uid: azure.applicationinsights.models.EventType.dependencies +- name: exceptions + uid: azure.applicationinsights.models.EventType.exceptions +- name: page_views + uid: azure.applicationinsights.models.EventType.page_views +- name: performance_counters + uid: azure.applicationinsights.models.EventType.performance_counters +- name: requests + uid: azure.applicationinsights.models.EventType.requests +- name: traces + uid: azure.applicationinsights.models.EventType.traces diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAiInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAiInfo.yml new file mode 100644 index 00000000..b091d92b --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAiInfo.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsAiInfo +name: EventsAiInfo +fullName: azure.applicationinsights.models.EventsAiInfo +module: azure.applicationinsights.models +summary: AI related application info for an event result. +constructor: + syntax: 'EventsAiInfo(*, i_key: str = None, app_name: str = None, app_id: str = + None, sdk_version: str = None, **kwargs)' + parameters: + - name: i_key + description: iKey of the app + isRequired: true + types: + - + - name: app_name + description: Name of the application + isRequired: true + types: + - + - name: app_id + description: ID of the application + isRequired: true + types: + - + - name: sdk_version + description: SDK version of the application + isRequired: true + types: + - + keywordOnlyParameters: + - name: i_key + isRequired: true + - name: app_name + isRequired: true + - name: app_id + isRequired: true + - name: sdk_version + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsAiInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsAiInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsAiInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsAiInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsAiInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsAiInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsAiInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsApplicationInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsApplicationInfo.yml new file mode 100644 index 00000000..34f0021e --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsApplicationInfo.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsApplicationInfo +name: EventsApplicationInfo +fullName: azure.applicationinsights.models.EventsApplicationInfo +module: azure.applicationinsights.models +summary: Application info for an event result. +constructor: + syntax: 'EventsApplicationInfo(*, version: str = None, **kwargs)' + parameters: + - name: version + description: Version of the application + isRequired: true + types: + - + keywordOnlyParameters: + - name: version + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsApplicationInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsApplicationInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsApplicationInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsApplicationInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsApplicationInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsApplicationInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsApplicationInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAvailabilityResultInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAvailabilityResultInfo.yml new file mode 100644 index 00000000..953380bf --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAvailabilityResultInfo.yml @@ -0,0 +1,176 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsAvailabilityResultInfo +name: EventsAvailabilityResultInfo +fullName: azure.applicationinsights.models.EventsAvailabilityResultInfo +module: azure.applicationinsights.models +summary: The availability result info. +constructor: + syntax: 'EventsAvailabilityResultInfo(*, name: str = None, success: str = None, + duration: int = None, performance_bucket: str = None, message: str = None, location: + str = None, id: str = None, size: str = None, **kwargs)' + parameters: + - name: name + description: The name of the availability result + isRequired: true + types: + - + - name: success + description: Indicates if the availability result was successful + isRequired: true + types: + - + - name: duration + description: The duration of the availability result + isRequired: true + types: + - + - name: performance_bucket + description: 'The performance bucket of the availability + + result' + isRequired: true + types: + - + - name: message + description: The message of the availability result + isRequired: true + types: + - + - name: location + description: The location of the availability result + isRequired: true + types: + - + - name: id + description: The ID of the availability result + isRequired: true + types: + - + - name: size + description: The size of the availability result + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: success + isRequired: true + - name: duration + isRequired: true + - name: performance_bucket + isRequired: true + - name: message + isRequired: true + - name: location + isRequired: true + - name: id + isRequired: true + - name: size + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsAvailabilityResultInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsAvailabilityResultInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsAvailabilityResultInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsAvailabilityResultInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsAvailabilityResultInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsAvailabilityResultInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsAvailabilityResultInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAvailabilityResultResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAvailabilityResultResult.yml new file mode 100644 index 00000000..f463b309 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAvailabilityResultResult.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsAvailabilityResultResult +name: EventsAvailabilityResultResult +fullName: azure.applicationinsights.models.EventsAvailabilityResultResult +module: azure.applicationinsights.models +summary: 'An availability result result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EventsAvailabilityResultResult(*, id: str = None, count: int = None, timestamp=None, + custom_dimensions=None, custom_measurements=None, operation=None, session=None, + user=None, cloud=None, ai=None, application=None, client=None, availability_result=None, + **kwargs)' + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: availability_result + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: count + isRequired: true + - name: timestamp + isRequired: true + - name: custom_dimensions + isRequired: true + - name: custom_measurements + isRequired: true + - name: operation + isRequired: true + - name: session + isRequired: true + - name: user + isRequired: true + - name: cloud + isRequired: true + - name: ai + isRequired: true + - name: application + isRequired: true + - name: client + isRequired: true + - name: availability_result + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsAvailabilityResultResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsAvailabilityResultResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsAvailabilityResultResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsAvailabilityResultResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsAvailabilityResultResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsAvailabilityResultResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsAvailabilityResultResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsBrowserTimingInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsBrowserTimingInfo.yml new file mode 100644 index 00000000..6f088e82 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsBrowserTimingInfo.yml @@ -0,0 +1,189 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsBrowserTimingInfo +name: EventsBrowserTimingInfo +fullName: azure.applicationinsights.models.EventsBrowserTimingInfo +module: azure.applicationinsights.models +summary: The browser timing information. +constructor: + syntax: 'EventsBrowserTimingInfo(*, url_path: str = None, url_host: str = None, + name: str = None, url: str = None, total_duration: int = None, performance_bucket: + str = None, network_duration: int = None, send_duration: int = None, receive_duration: + int = None, processing_duration: int = None, **kwargs)' + parameters: + - name: url_path + description: The path of the URL + isRequired: true + types: + - + - name: url_host + description: The host of the URL + isRequired: true + types: + - + - name: name + description: The name of the page + isRequired: true + types: + - + - name: url + description: The url of the page + isRequired: true + types: + - + - name: total_duration + description: The total duration of the load + isRequired: true + types: + - + - name: performance_bucket + description: The performance bucket of the load + isRequired: true + types: + - + - name: network_duration + description: The network duration of the load + isRequired: true + types: + - + - name: send_duration + description: The send duration of the load + isRequired: true + types: + - + - name: receive_duration + description: The receive duration of the load + isRequired: true + types: + - + - name: processing_duration + description: The processing duration of the load + isRequired: true + types: + - + keywordOnlyParameters: + - name: url_path + isRequired: true + - name: url_host + isRequired: true + - name: name + isRequired: true + - name: url + isRequired: true + - name: total_duration + isRequired: true + - name: performance_bucket + isRequired: true + - name: network_duration + isRequired: true + - name: send_duration + isRequired: true + - name: receive_duration + isRequired: true + - name: processing_duration + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsBrowserTimingInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsBrowserTimingInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsBrowserTimingInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsBrowserTimingInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsBrowserTimingInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsBrowserTimingInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsBrowserTimingInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsBrowserTimingResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsBrowserTimingResult.yml new file mode 100644 index 00000000..20651efc --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsBrowserTimingResult.yml @@ -0,0 +1,223 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsBrowserTimingResult +name: EventsBrowserTimingResult +fullName: azure.applicationinsights.models.EventsBrowserTimingResult +module: azure.applicationinsights.models +summary: 'A browser timing result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EventsBrowserTimingResult(*, id: str = None, count: int = None, timestamp=None, + custom_dimensions=None, custom_measurements=None, operation=None, session=None, + user=None, cloud=None, ai=None, application=None, client=None, browser_timing=None, + client_performance=None, **kwargs)' + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: browser_timing + isRequired: true + types: + - + - name: client_performance + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: count + isRequired: true + - name: timestamp + isRequired: true + - name: custom_dimensions + isRequired: true + - name: custom_measurements + isRequired: true + - name: operation + isRequired: true + - name: session + isRequired: true + - name: user + isRequired: true + - name: cloud + isRequired: true + - name: ai + isRequired: true + - name: application + isRequired: true + - name: client + isRequired: true + - name: browser_timing + isRequired: true + - name: client_performance + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsBrowserTimingResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsBrowserTimingResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsBrowserTimingResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsBrowserTimingResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsBrowserTimingResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsBrowserTimingResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsBrowserTimingResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsClientInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsClientInfo.yml new file mode 100644 index 00000000..478528ad --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsClientInfo.yml @@ -0,0 +1,174 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsClientInfo +name: EventsClientInfo +fullName: azure.applicationinsights.models.EventsClientInfo +module: azure.applicationinsights.models +summary: Client info for an event result. +constructor: + syntax: 'EventsClientInfo(*, model: str = None, os: str = None, type: str = None, + browser: str = None, ip: str = None, city: str = None, state_or_province: str + = None, country_or_region: str = None, **kwargs)' + parameters: + - name: model + description: Model of the client + isRequired: true + types: + - + - name: os + description: Operating system of the client + isRequired: true + types: + - + - name: type + description: Type of the client + isRequired: true + types: + - + - name: browser + description: Browser of the client + isRequired: true + types: + - + - name: ip + description: IP address of the client + isRequired: true + types: + - + - name: city + description: City of the client + isRequired: true + types: + - + - name: state_or_province + description: State or province of the client + isRequired: true + types: + - + - name: country_or_region + description: Country or region of the client + isRequired: true + types: + - + keywordOnlyParameters: + - name: model + isRequired: true + - name: os + isRequired: true + - name: type + isRequired: true + - name: browser + isRequired: true + - name: ip + isRequired: true + - name: city + isRequired: true + - name: state_or_province + isRequired: true + - name: country_or_region + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsClientInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsClientInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsClientInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsClientInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsClientInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsClientInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsClientInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsClientPerformanceInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsClientPerformanceInfo.yml new file mode 100644 index 00000000..c849007f --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsClientPerformanceInfo.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsClientPerformanceInfo +name: EventsClientPerformanceInfo +fullName: azure.applicationinsights.models.EventsClientPerformanceInfo +module: azure.applicationinsights.models +summary: Client performance information. +constructor: + syntax: 'EventsClientPerformanceInfo(*, name: str = None, **kwargs)' + parameters: + - name: name + description: The name of the client performance + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsClientPerformanceInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsClientPerformanceInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsClientPerformanceInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsClientPerformanceInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsClientPerformanceInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsClientPerformanceInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsClientPerformanceInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCloudInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCloudInfo.yml new file mode 100644 index 00000000..4fd11580 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCloudInfo.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsCloudInfo +name: EventsCloudInfo +fullName: azure.applicationinsights.models.EventsCloudInfo +module: azure.applicationinsights.models +summary: Cloud info for an event result. +constructor: + syntax: 'EventsCloudInfo(*, role_name: str = None, role_instance: str = None, **kwargs)' + parameters: + - name: role_name + description: Role name of the cloud + isRequired: true + types: + - + - name: role_instance + description: Role instance of the cloud + isRequired: true + types: + - + keywordOnlyParameters: + - name: role_name + isRequired: true + - name: role_instance + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsCloudInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsCloudInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsCloudInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsCloudInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsCloudInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsCloudInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsCloudInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomEventInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomEventInfo.yml new file mode 100644 index 00000000..0706e916 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomEventInfo.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsCustomEventInfo +name: EventsCustomEventInfo +fullName: azure.applicationinsights.models.EventsCustomEventInfo +module: azure.applicationinsights.models +summary: The custom event information. +constructor: + syntax: 'EventsCustomEventInfo(*, name: str = None, **kwargs)' + parameters: + - name: name + description: The name of the custom event + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsCustomEventInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsCustomEventInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsCustomEventInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsCustomEventInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsCustomEventInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsCustomEventInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsCustomEventInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomEventResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomEventResult.yml new file mode 100644 index 00000000..4768a7a7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomEventResult.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsCustomEventResult +name: EventsCustomEventResult +fullName: azure.applicationinsights.models.EventsCustomEventResult +module: azure.applicationinsights.models +summary: 'A custom event result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EventsCustomEventResult(*, id: str = None, count: int = None, timestamp=None, + custom_dimensions=None, custom_measurements=None, operation=None, session=None, + user=None, cloud=None, ai=None, application=None, client=None, custom_event=None, + **kwargs)' + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: custom_event + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: count + isRequired: true + - name: timestamp + isRequired: true + - name: custom_dimensions + isRequired: true + - name: custom_measurements + isRequired: true + - name: operation + isRequired: true + - name: session + isRequired: true + - name: user + isRequired: true + - name: cloud + isRequired: true + - name: ai + isRequired: true + - name: application + isRequired: true + - name: client + isRequired: true + - name: custom_event + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsCustomEventResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsCustomEventResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsCustomEventResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsCustomEventResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsCustomEventResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsCustomEventResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsCustomEventResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomMetricInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomMetricInfo.yml new file mode 100644 index 00000000..b1dfcf15 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomMetricInfo.yml @@ -0,0 +1,167 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsCustomMetricInfo +name: EventsCustomMetricInfo +fullName: azure.applicationinsights.models.EventsCustomMetricInfo +module: azure.applicationinsights.models +summary: The custom metric info. +constructor: + syntax: 'EventsCustomMetricInfo(*, name: str = None, value: float = None, value_sum: + float = None, value_count: int = None, value_min: float = None, value_max: float + = None, value_std_dev: float = None, **kwargs)' + parameters: + - name: name + description: The name of the custom metric + isRequired: true + types: + - + - name: value + description: The value of the custom metric + isRequired: true + types: + - + - name: value_sum + description: The sum of the custom metric + isRequired: true + types: + - + - name: value_count + description: The count of the custom metric + isRequired: true + types: + - + - name: value_min + description: The minimum value of the custom metric + isRequired: true + types: + - + - name: value_max + description: The maximum value of the custom metric + isRequired: true + types: + - + - name: value_std_dev + description: The standard deviation of the custom metric + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: value + isRequired: true + - name: value_sum + isRequired: true + - name: value_count + isRequired: true + - name: value_min + isRequired: true + - name: value_max + isRequired: true + - name: value_std_dev + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsCustomMetricInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsCustomMetricInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsCustomMetricInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsCustomMetricInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsCustomMetricInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsCustomMetricInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsCustomMetricInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomMetricResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomMetricResult.yml new file mode 100644 index 00000000..215427eb --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomMetricResult.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsCustomMetricResult +name: EventsCustomMetricResult +fullName: azure.applicationinsights.models.EventsCustomMetricResult +module: azure.applicationinsights.models +summary: 'A custom metric result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EventsCustomMetricResult(*, id: str = None, count: int = None, timestamp=None, + custom_dimensions=None, custom_measurements=None, operation=None, session=None, + user=None, cloud=None, ai=None, application=None, client=None, custom_metric=None, + **kwargs)' + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: custom_metric + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: count + isRequired: true + - name: timestamp + isRequired: true + - name: custom_dimensions + isRequired: true + - name: custom_measurements + isRequired: true + - name: operation + isRequired: true + - name: session + isRequired: true + - name: user + isRequired: true + - name: cloud + isRequired: true + - name: ai + isRequired: true + - name: application + isRequired: true + - name: client + isRequired: true + - name: custom_metric + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsCustomMetricResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsCustomMetricResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsCustomMetricResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsCustomMetricResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsCustomMetricResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsCustomMetricResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsCustomMetricResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsDependencyInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsDependencyInfo.yml new file mode 100644 index 00000000..0c028a35 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsDependencyInfo.yml @@ -0,0 +1,181 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsDependencyInfo +name: EventsDependencyInfo +fullName: azure.applicationinsights.models.EventsDependencyInfo +module: azure.applicationinsights.models +summary: The dependency info. +constructor: + syntax: 'EventsDependencyInfo(*, target: str = None, data: str = None, success: + str = None, duration: int = None, performance_bucket: str = None, result_code: + str = None, type: str = None, name: str = None, id: str = None, **kwargs)' + parameters: + - name: target + description: The target of the dependency + isRequired: true + types: + - + - name: data + description: The data of the dependency + isRequired: true + types: + - + - name: success + description: Indicates if the dependency was successful + isRequired: true + types: + - + - name: duration + description: The duration of the dependency + isRequired: true + types: + - + - name: performance_bucket + description: The performance bucket of the dependency + isRequired: true + types: + - + - name: result_code + description: The result code of the dependency + isRequired: true + types: + - + - name: type + description: The type of the dependency + isRequired: true + types: + - + - name: name + description: The name of the dependency + isRequired: true + types: + - + - name: id + description: The ID of the dependency + isRequired: true + types: + - + keywordOnlyParameters: + - name: target + isRequired: true + - name: data + isRequired: true + - name: success + isRequired: true + - name: duration + isRequired: true + - name: performance_bucket + isRequired: true + - name: result_code + isRequired: true + - name: type + isRequired: true + - name: name + isRequired: true + - name: id + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsDependencyInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsDependencyInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsDependencyInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsDependencyInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsDependencyInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsDependencyInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsDependencyInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsDependencyResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsDependencyResult.yml new file mode 100644 index 00000000..6c68c537 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsDependencyResult.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsDependencyResult +name: EventsDependencyResult +fullName: azure.applicationinsights.models.EventsDependencyResult +module: azure.applicationinsights.models +summary: 'A dependency result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EventsDependencyResult(*, id: str = None, count: int = None, timestamp=None, + custom_dimensions=None, custom_measurements=None, operation=None, session=None, + user=None, cloud=None, ai=None, application=None, client=None, dependency=None, + **kwargs)' + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: dependency + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: count + isRequired: true + - name: timestamp + isRequired: true + - name: custom_dimensions + isRequired: true + - name: custom_measurements + isRequired: true + - name: operation + isRequired: true + - name: session + isRequired: true + - name: user + isRequired: true + - name: cloud + isRequired: true + - name: ai + isRequired: true + - name: application + isRequired: true + - name: client + isRequired: true + - name: dependency + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsDependencyResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsDependencyResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsDependencyResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsDependencyResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsDependencyResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsDependencyResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsDependencyResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionDetail.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionDetail.yml new file mode 100644 index 00000000..1bee4e28 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionDetail.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsExceptionDetail +name: EventsExceptionDetail +fullName: azure.applicationinsights.models.EventsExceptionDetail +module: azure.applicationinsights.models +summary: Exception details. +constructor: + syntax: 'EventsExceptionDetail(*, severity_level: str = None, outer_id: str = None, + message: str = None, type: str = None, id: str = None, parsed_stack=None, **kwargs)' + parameters: + - name: severity_level + description: The severity level of the exception detail + isRequired: true + types: + - + - name: outer_id + description: The outer ID of the exception detail + isRequired: true + types: + - + - name: message + description: The message of the exception detail + isRequired: true + types: + - + - name: type + description: The type of the exception detail + isRequired: true + types: + - + - name: id + description: The ID of the exception detail + isRequired: true + types: + - + - name: parsed_stack + description: The parsed stack + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: severity_level + isRequired: true + - name: outer_id + isRequired: true + - name: message + isRequired: true + - name: type + isRequired: true + - name: id + isRequired: true + - name: parsed_stack + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsExceptionDetail.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsExceptionDetail.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsExceptionDetail.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsExceptionDetail.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsExceptionDetail.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsExceptionDetail.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsExceptionDetail.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionDetailsParsedStack.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionDetailsParsedStack.yml new file mode 100644 index 00000000..e0924e82 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionDetailsParsedStack.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsExceptionDetailsParsedStack +name: EventsExceptionDetailsParsedStack +fullName: azure.applicationinsights.models.EventsExceptionDetailsParsedStack +module: azure.applicationinsights.models +summary: A parsed stack entry. +constructor: + syntax: 'EventsExceptionDetailsParsedStack(*, assembly: str = None, method: str + = None, level: int = None, line: int = None, **kwargs)' + parameters: + - name: assembly + description: The assembly of the stack entry + isRequired: true + types: + - + - name: method + description: The method of the stack entry + isRequired: true + types: + - + - name: level + description: The level of the stack entry + isRequired: true + types: + - + - name: line + description: The line of the stack entry + isRequired: true + types: + - + keywordOnlyParameters: + - name: assembly + isRequired: true + - name: method + isRequired: true + - name: level + isRequired: true + - name: line + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsExceptionDetailsParsedStack.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsExceptionDetailsParsedStack.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsExceptionDetailsParsedStack.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsExceptionDetailsParsedStack.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsExceptionDetailsParsedStack.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsExceptionDetailsParsedStack.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsExceptionDetailsParsedStack.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionInfo.yml new file mode 100644 index 00000000..b8ea8f5e --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionInfo.yml @@ -0,0 +1,233 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsExceptionInfo +name: EventsExceptionInfo +fullName: azure.applicationinsights.models.EventsExceptionInfo +module: azure.applicationinsights.models +summary: The exception info. +constructor: + syntax: 'EventsExceptionInfo(*, severity_level: int = None, problem_id: str = None, + handled_at: str = None, assembly: str = None, method: str = None, message: str + = None, type: str = None, outer_type: str = None, outer_method: str = None, outer_assembly: + str = None, outer_message: str = None, innermost_type: str = None, innermost_message: + str = None, innermost_method: str = None, innermost_assembly: str = None, details=None, + **kwargs)' + parameters: + - name: severity_level + description: The severity level of the exception + isRequired: true + types: + - + - name: problem_id + description: The problem ID of the exception + isRequired: true + types: + - + - name: handled_at + description: Indicates where the exception was handled at + isRequired: true + types: + - + - name: assembly + description: The assembly which threw the exception + isRequired: true + types: + - + - name: method + description: The method that threw the exception + isRequired: true + types: + - + - name: message + description: The message of the exception + isRequired: true + types: + - + - name: type + description: The type of the exception + isRequired: true + types: + - + - name: outer_type + description: The outer type of the exception + isRequired: true + types: + - + - name: outer_method + description: The outer method of the exception + isRequired: true + types: + - + - name: outer_assembly + description: The outer assmebly of the exception + isRequired: true + types: + - + - name: outer_message + description: The outer message of the exception + isRequired: true + types: + - + - name: innermost_type + description: The inner most type of the exception + isRequired: true + types: + - + - name: innermost_message + description: The inner most message of the exception + isRequired: true + types: + - + - name: innermost_method + description: The inner most method of the exception + isRequired: true + types: + - + - name: innermost_assembly + description: The inner most assembly of the exception + isRequired: true + types: + - + - name: details + description: The details of the exception + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: severity_level + isRequired: true + - name: problem_id + isRequired: true + - name: handled_at + isRequired: true + - name: assembly + isRequired: true + - name: method + isRequired: true + - name: message + isRequired: true + - name: type + isRequired: true + - name: outer_type + isRequired: true + - name: outer_method + isRequired: true + - name: outer_assembly + isRequired: true + - name: outer_message + isRequired: true + - name: innermost_type + isRequired: true + - name: innermost_message + isRequired: true + - name: innermost_method + isRequired: true + - name: innermost_assembly + isRequired: true + - name: details + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsExceptionInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsExceptionInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsExceptionInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsExceptionInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsExceptionInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsExceptionInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsExceptionInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionResult.yml new file mode 100644 index 00000000..c4fca189 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionResult.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsExceptionResult +name: EventsExceptionResult +fullName: azure.applicationinsights.models.EventsExceptionResult +module: azure.applicationinsights.models +summary: 'An exception result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EventsExceptionResult(*, id: str = None, count: int = None, timestamp=None, + custom_dimensions=None, custom_measurements=None, operation=None, session=None, + user=None, cloud=None, ai=None, application=None, client=None, exception=None, + **kwargs)' + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: exception + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: count + isRequired: true + - name: timestamp + isRequired: true + - name: custom_dimensions + isRequired: true + - name: custom_measurements + isRequired: true + - name: operation + isRequired: true + - name: session + isRequired: true + - name: user + isRequired: true + - name: cloud + isRequired: true + - name: ai + isRequired: true + - name: application + isRequired: true + - name: client + isRequired: true + - name: exception + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsExceptionResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsExceptionResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsExceptionResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsExceptionResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsExceptionResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsExceptionResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsExceptionResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsOperationInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsOperationInfo.yml new file mode 100644 index 00000000..31d0010a --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsOperationInfo.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsOperationInfo +name: EventsOperationInfo +fullName: azure.applicationinsights.models.EventsOperationInfo +module: azure.applicationinsights.models +summary: Operation info for an event result. +constructor: + syntax: 'EventsOperationInfo(*, name: str = None, id: str = None, parent_id: str + = None, synthetic_source: str = None, **kwargs)' + parameters: + - name: name + description: Name of the operation + isRequired: true + types: + - + - name: id + description: ID of the operation + isRequired: true + types: + - + - name: parent_id + description: Parent ID of the operation + isRequired: true + types: + - + - name: synthetic_source + description: Synthetic source of the operation + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: id + isRequired: true + - name: parent_id + isRequired: true + - name: synthetic_source + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsOperationInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsOperationInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsOperationInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsOperationInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsOperationInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsOperationInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsOperationInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPageViewInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPageViewInfo.yml new file mode 100644 index 00000000..5f70b587 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPageViewInfo.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsPageViewInfo +name: EventsPageViewInfo +fullName: azure.applicationinsights.models.EventsPageViewInfo +module: azure.applicationinsights.models +summary: The page view information. +constructor: + syntax: 'EventsPageViewInfo(*, name: str = None, url: str = None, duration: str + = None, performance_bucket: str = None, **kwargs)' + parameters: + - name: name + description: The name of the page + isRequired: true + types: + - + - name: url + description: The URL of the page + isRequired: true + types: + - + - name: duration + description: The duration of the page view + isRequired: true + types: + - + - name: performance_bucket + description: The performance bucket of the page view + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: url + isRequired: true + - name: duration + isRequired: true + - name: performance_bucket + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsPageViewInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsPageViewInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsPageViewInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsPageViewInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsPageViewInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsPageViewInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsPageViewInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPageViewResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPageViewResult.yml new file mode 100644 index 00000000..eae45b09 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPageViewResult.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsPageViewResult +name: EventsPageViewResult +fullName: azure.applicationinsights.models.EventsPageViewResult +module: azure.applicationinsights.models +summary: 'A page view result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EventsPageViewResult(*, id: str = None, count: int = None, timestamp=None, + custom_dimensions=None, custom_measurements=None, operation=None, session=None, + user=None, cloud=None, ai=None, application=None, client=None, page_view=None, + **kwargs)' + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: page_view + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: count + isRequired: true + - name: timestamp + isRequired: true + - name: custom_dimensions + isRequired: true + - name: custom_measurements + isRequired: true + - name: operation + isRequired: true + - name: session + isRequired: true + - name: user + isRequired: true + - name: cloud + isRequired: true + - name: ai + isRequired: true + - name: application + isRequired: true + - name: client + isRequired: true + - name: page_view + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsPageViewResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsPageViewResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsPageViewResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsPageViewResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsPageViewResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsPageViewResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsPageViewResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPerformanceCounterInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPerformanceCounterInfo.yml new file mode 100644 index 00000000..ffffd9ed --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPerformanceCounterInfo.yml @@ -0,0 +1,160 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsPerformanceCounterInfo +name: EventsPerformanceCounterInfo +fullName: azure.applicationinsights.models.EventsPerformanceCounterInfo +module: azure.applicationinsights.models +summary: The performance counter info. +constructor: + syntax: 'EventsPerformanceCounterInfo(*, value: float = None, name: str = None, + category: str = None, counter: str = None, instance_name: str = None, instance: + str = None, **kwargs)' + parameters: + - name: value + description: The value of the performance counter + isRequired: true + types: + - + - name: name + description: The name of the performance counter + isRequired: true + types: + - + - name: category + description: The category of the performance counter + isRequired: true + types: + - + - name: counter + description: The counter of the performance counter + isRequired: true + types: + - + - name: instance_name + description: The instance name of the performance counter + isRequired: true + types: + - + - name: instance + description: The instance of the performance counter + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: name + isRequired: true + - name: category + isRequired: true + - name: counter + isRequired: true + - name: instance_name + isRequired: true + - name: instance + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsPerformanceCounterInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsPerformanceCounterInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsPerformanceCounterInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsPerformanceCounterInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsPerformanceCounterInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsPerformanceCounterInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsPerformanceCounterInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPerformanceCounterResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPerformanceCounterResult.yml new file mode 100644 index 00000000..1d4c34f0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPerformanceCounterResult.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsPerformanceCounterResult +name: EventsPerformanceCounterResult +fullName: azure.applicationinsights.models.EventsPerformanceCounterResult +module: azure.applicationinsights.models +summary: 'A performance counter result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EventsPerformanceCounterResult(*, id: str = None, count: int = None, timestamp=None, + custom_dimensions=None, custom_measurements=None, operation=None, session=None, + user=None, cloud=None, ai=None, application=None, client=None, performance_counter=None, + **kwargs)' + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: performance_counter + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: count + isRequired: true + - name: timestamp + isRequired: true + - name: custom_dimensions + isRequired: true + - name: custom_measurements + isRequired: true + - name: operation + isRequired: true + - name: session + isRequired: true + - name: user + isRequired: true + - name: cloud + isRequired: true + - name: ai + isRequired: true + - name: application + isRequired: true + - name: client + isRequired: true + - name: performance_counter + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsPerformanceCounterResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsPerformanceCounterResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsPerformanceCounterResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsPerformanceCounterResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsPerformanceCounterResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsPerformanceCounterResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsPerformanceCounterResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsRequestInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsRequestInfo.yml new file mode 100644 index 00000000..e601176d --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsRequestInfo.yml @@ -0,0 +1,174 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsRequestInfo +name: EventsRequestInfo +fullName: azure.applicationinsights.models.EventsRequestInfo +module: azure.applicationinsights.models +summary: The request info. +constructor: + syntax: 'EventsRequestInfo(*, name: str = None, url: str = None, success: str = + None, duration: float = None, performance_bucket: str = None, result_code: str + = None, source: str = None, id: str = None, **kwargs)' + parameters: + - name: name + description: The name of the request + isRequired: true + types: + - + - name: url + description: The URL of the request + isRequired: true + types: + - + - name: success + description: Indicates if the request was successful + isRequired: true + types: + - + - name: duration + description: The duration of the request + isRequired: true + types: + - + - name: performance_bucket + description: The performance bucket of the request + isRequired: true + types: + - + - name: result_code + description: The result code of the request + isRequired: true + types: + - + - name: source + description: The source of the request + isRequired: true + types: + - + - name: id + description: The ID of the request + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: url + isRequired: true + - name: success + isRequired: true + - name: duration + isRequired: true + - name: performance_bucket + isRequired: true + - name: result_code + isRequired: true + - name: source + isRequired: true + - name: id + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsRequestInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsRequestInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsRequestInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsRequestInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsRequestInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsRequestInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsRequestInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsRequestResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsRequestResult.yml new file mode 100644 index 00000000..e98a4a75 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsRequestResult.yml @@ -0,0 +1,216 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsRequestResult +name: EventsRequestResult +fullName: azure.applicationinsights.models.EventsRequestResult +module: azure.applicationinsights.models +summary: 'A request result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EventsRequestResult(*, id: str = None, count: int = None, timestamp=None, + custom_dimensions=None, custom_measurements=None, operation=None, session=None, + user=None, cloud=None, ai=None, application=None, client=None, request=None, **kwargs)' + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: request + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: count + isRequired: true + - name: timestamp + isRequired: true + - name: custom_dimensions + isRequired: true + - name: custom_measurements + isRequired: true + - name: operation + isRequired: true + - name: session + isRequired: true + - name: user + isRequired: true + - name: cloud + isRequired: true + - name: ai + isRequired: true + - name: application + isRequired: true + - name: client + isRequired: true + - name: request + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsRequestResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsRequestResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsRequestResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsRequestResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsRequestResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsRequestResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsRequestResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResult.yml new file mode 100644 index 00000000..97c6d3b2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResult.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsResult +name: EventsResult +fullName: azure.applicationinsights.models.EventsResult +module: azure.applicationinsights.models +summary: An event query result. +constructor: + syntax: EventsResult(*, aimessages=None, value=None, **kwargs) + parameters: + - name: aimessages + description: OData messages for this response. + isRequired: true + types: + - [] + - name: value + isRequired: true + types: + - + keywordOnlyParameters: + - name: aimessages + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultData.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultData.yml new file mode 100644 index 00000000..f31e6ef8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultData.yml @@ -0,0 +1,223 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsResultData +name: EventsResultData +fullName: azure.applicationinsights.models.EventsResultData +module: azure.applicationinsights.models +summary: 'Events query result data. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: EventsTraceResult, EventsCustomEventResult, + + EventsPageViewResult, EventsBrowserTimingResult, EventsRequestResult, + + EventsDependencyResult, EventsExceptionResult, + + EventsAvailabilityResultResult, EventsPerformanceCounterResult, + + EventsCustomMetricResult + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EventsResultData(*, id: str = None, count: int = None, timestamp=None, + custom_dimensions=None, custom_measurements=None, operation=None, session=None, + user=None, cloud=None, ai=None, application=None, client=None, **kwargs)' + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: count + isRequired: true + - name: timestamp + isRequired: true + - name: custom_dimensions + isRequired: true + - name: custom_measurements + isRequired: true + - name: operation + isRequired: true + - name: session + isRequired: true + - name: user + isRequired: true + - name: cloud + isRequired: true + - name: ai + isRequired: true + - name: application + isRequired: true + - name: client + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsResultData.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsResultData.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsResultData.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsResultData.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsResultData.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsResultData.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsResultData.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultDataCustomDimensions.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultDataCustomDimensions.yml new file mode 100644 index 00000000..db5c39e3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultDataCustomDimensions.yml @@ -0,0 +1,122 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsResultDataCustomDimensions +name: EventsResultDataCustomDimensions +fullName: azure.applicationinsights.models.EventsResultDataCustomDimensions +module: azure.applicationinsights.models +summary: Custom dimensions of the event. +constructor: + syntax: EventsResultDataCustomDimensions(*, additional_properties=None, **kwargs) + parameters: + - name: additional_properties + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsResultDataCustomDimensions.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsResultDataCustomDimensions.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsResultDataCustomDimensions.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsResultDataCustomDimensions.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsResultDataCustomDimensions.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsResultDataCustomDimensions.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsResultDataCustomDimensions.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultDataCustomMeasurements.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultDataCustomMeasurements.yml new file mode 100644 index 00000000..7c6e43ef --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultDataCustomMeasurements.yml @@ -0,0 +1,122 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsResultDataCustomMeasurements +name: EventsResultDataCustomMeasurements +fullName: azure.applicationinsights.models.EventsResultDataCustomMeasurements +module: azure.applicationinsights.models +summary: Custom measurements of the event. +constructor: + syntax: EventsResultDataCustomMeasurements(*, additional_properties=None, **kwargs) + parameters: + - name: additional_properties + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsResultDataCustomMeasurements.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsResultDataCustomMeasurements.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsResultDataCustomMeasurements.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsResultDataCustomMeasurements.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsResultDataCustomMeasurements.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsResultDataCustomMeasurements.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsResultDataCustomMeasurements.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResults.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResults.yml new file mode 100644 index 00000000..c3b4cd9c --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResults.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsResults +name: EventsResults +fullName: azure.applicationinsights.models.EventsResults +module: azure.applicationinsights.models +summary: An events query result. +constructor: + syntax: 'EventsResults(*, odatacontext: str = None, aimessages=None, value=None, + **kwargs)' + parameters: + - name: odatacontext + description: OData context metadata endpoint for this response + isRequired: true + types: + - + - name: aimessages + description: OData messages for this response. + isRequired: true + types: + - [] + - name: value + description: Contents of the events query result. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: odatacontext + isRequired: true + - name: aimessages + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsResults.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsResults.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsResults.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsResults.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsResults.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsResults.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsResults.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsSessionInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsSessionInfo.yml new file mode 100644 index 00000000..401e9878 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsSessionInfo.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsSessionInfo +name: EventsSessionInfo +fullName: azure.applicationinsights.models.EventsSessionInfo +module: azure.applicationinsights.models +summary: Session info for an event result. +constructor: + syntax: 'EventsSessionInfo(*, id: str = None, **kwargs)' + parameters: + - name: id + description: ID of the session + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsSessionInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsSessionInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsSessionInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsSessionInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsSessionInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsSessionInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsSessionInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsTraceInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsTraceInfo.yml new file mode 100644 index 00000000..3f1100ea --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsTraceInfo.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsTraceInfo +name: EventsTraceInfo +fullName: azure.applicationinsights.models.EventsTraceInfo +module: azure.applicationinsights.models +summary: The trace information. +constructor: + syntax: 'EventsTraceInfo(*, message: str = None, severity_level: int = None, **kwargs)' + parameters: + - name: message + description: The trace message + isRequired: true + types: + - + - name: severity_level + description: The trace severity level + isRequired: true + types: + - + keywordOnlyParameters: + - name: message + isRequired: true + - name: severity_level + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsTraceInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsTraceInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsTraceInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsTraceInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsTraceInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsTraceInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsTraceInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsTraceResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsTraceResult.yml new file mode 100644 index 00000000..44c63c28 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsTraceResult.yml @@ -0,0 +1,216 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsTraceResult +name: EventsTraceResult +fullName: azure.applicationinsights.models.EventsTraceResult +module: azure.applicationinsights.models +summary: 'A trace result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EventsTraceResult(*, id: str = None, count: int = None, timestamp=None, + custom_dimensions=None, custom_measurements=None, operation=None, session=None, + user=None, cloud=None, ai=None, application=None, client=None, trace=None, **kwargs)' + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: trace + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: count + isRequired: true + - name: timestamp + isRequired: true + - name: custom_dimensions + isRequired: true + - name: custom_measurements + isRequired: true + - name: operation + isRequired: true + - name: session + isRequired: true + - name: user + isRequired: true + - name: cloud + isRequired: true + - name: ai + isRequired: true + - name: application + isRequired: true + - name: client + isRequired: true + - name: trace + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsTraceResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsTraceResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsTraceResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsTraceResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsTraceResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsTraceResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsTraceResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsUserInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsUserInfo.yml new file mode 100644 index 00000000..e5e12e3a --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsUserInfo.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.EventsUserInfo +name: EventsUserInfo +fullName: azure.applicationinsights.models.EventsUserInfo +module: azure.applicationinsights.models +summary: User info for an event result. +constructor: + syntax: 'EventsUserInfo(*, id: str = None, account_id: str = None, authenticated_id: + str = None, **kwargs)' + parameters: + - name: id + description: ID of the user + isRequired: true + types: + - + - name: account_id + description: Account ID of the user + isRequired: true + types: + - + - name: authenticated_id + description: Authenticated ID of the user + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: account_id + isRequired: true + - name: authenticated_id + isRequired: true +methods: +- uid: azure.applicationinsights.models.EventsUserInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsUserInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsUserInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.EventsUserInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.EventsUserInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.EventsUserInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.EventsUserInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricId.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricId.yml new file mode 100644 index 00000000..b31bad08 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricId.yml @@ -0,0 +1,70 @@ +### YamlMime:PythonEnum +uid: azure.applicationinsights.models.MetricId +name: MetricId +fullName: azure.applicationinsights.models.MetricId +module: azure.applicationinsights.models +fields: +- name: availability_resultsavailability_percentage + uid: azure.applicationinsights.models.MetricId.availability_resultsavailability_percentage +- name: availability_resultsduration + uid: azure.applicationinsights.models.MetricId.availability_resultsduration +- name: billingtelemetry_count + uid: azure.applicationinsights.models.MetricId.billingtelemetry_count +- name: clientnetwork_duration + uid: azure.applicationinsights.models.MetricId.clientnetwork_duration +- name: clientprocessing_duration + uid: azure.applicationinsights.models.MetricId.clientprocessing_duration +- name: clientreceive_duration + uid: azure.applicationinsights.models.MetricId.clientreceive_duration +- name: clientsend_duration + uid: azure.applicationinsights.models.MetricId.clientsend_duration +- name: clienttotal_duration + uid: azure.applicationinsights.models.MetricId.clienttotal_duration +- name: custom_eventscount + uid: azure.applicationinsights.models.MetricId.custom_eventscount +- name: dependenciescount + uid: azure.applicationinsights.models.MetricId.dependenciescount +- name: dependenciesduration + uid: azure.applicationinsights.models.MetricId.dependenciesduration +- name: dependenciesfailed + uid: azure.applicationinsights.models.MetricId.dependenciesfailed +- name: exceptionsbrowser + uid: azure.applicationinsights.models.MetricId.exceptionsbrowser +- name: exceptionscount + uid: azure.applicationinsights.models.MetricId.exceptionscount +- name: exceptionsserver + uid: azure.applicationinsights.models.MetricId.exceptionsserver +- name: page_viewscount + uid: azure.applicationinsights.models.MetricId.page_viewscount +- name: page_viewsduration + uid: azure.applicationinsights.models.MetricId.page_viewsduration +- name: performance_countersexceptions_per_second + uid: azure.applicationinsights.models.MetricId.performance_countersexceptions_per_second +- name: performance_countersmemory_available_bytes + uid: azure.applicationinsights.models.MetricId.performance_countersmemory_available_bytes +- name: performance_countersprocess_cpu_percentage + uid: azure.applicationinsights.models.MetricId.performance_countersprocess_cpu_percentage +- name: performance_countersprocess_io_bytes_per_second + uid: azure.applicationinsights.models.MetricId.performance_countersprocess_io_bytes_per_second +- name: performance_countersprocess_private_bytes + uid: azure.applicationinsights.models.MetricId.performance_countersprocess_private_bytes +- name: performance_countersprocessor_cpu_percentage + uid: azure.applicationinsights.models.MetricId.performance_countersprocessor_cpu_percentage +- name: performance_countersrequest_execution_time + uid: azure.applicationinsights.models.MetricId.performance_countersrequest_execution_time +- name: performance_countersrequests_in_queue + uid: azure.applicationinsights.models.MetricId.performance_countersrequests_in_queue +- name: performance_countersrequests_per_second + uid: azure.applicationinsights.models.MetricId.performance_countersrequests_per_second +- name: requestscount + uid: azure.applicationinsights.models.MetricId.requestscount +- name: requestsduration + uid: azure.applicationinsights.models.MetricId.requestsduration +- name: requestsfailed + uid: azure.applicationinsights.models.MetricId.requestsfailed +- name: sessionscount + uid: azure.applicationinsights.models.MetricId.sessionscount +- name: usersauthenticated + uid: azure.applicationinsights.models.MetricId.usersauthenticated +- name: userscount + uid: azure.applicationinsights.models.MetricId.userscount diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsAggregation.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsAggregation.yml new file mode 100644 index 00000000..af4159ee --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsAggregation.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonEnum +uid: azure.applicationinsights.models.MetricsAggregation +name: MetricsAggregation +fullName: azure.applicationinsights.models.MetricsAggregation +module: azure.applicationinsights.models +fields: +- name: avg + uid: azure.applicationinsights.models.MetricsAggregation.avg +- name: count + uid: azure.applicationinsights.models.MetricsAggregation.count +- name: max + uid: azure.applicationinsights.models.MetricsAggregation.max +- name: min + uid: azure.applicationinsights.models.MetricsAggregation.min +- name: sum + uid: azure.applicationinsights.models.MetricsAggregation.sum +- name: unique + uid: azure.applicationinsights.models.MetricsAggregation.unique diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsPostBodySchema.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsPostBodySchema.yml new file mode 100644 index 00000000..805ef449 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsPostBodySchema.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.MetricsPostBodySchema +name: MetricsPostBodySchema +fullName: azure.applicationinsights.models.MetricsPostBodySchema +module: azure.applicationinsights.models +summary: 'A metric request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MetricsPostBodySchema(*, id: str, parameters, **kwargs)' + parameters: + - name: id + description: 'Required. An identifier for this query. Must be unique within + + the post body of the request. This identifier will be the ''id'' property + + of the response object representing this query.' + isRequired: true + types: + - + - name: parameters + description: Required. The parameters for a single metrics query + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: parameters + isRequired: true +methods: +- uid: azure.applicationinsights.models.MetricsPostBodySchema.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.MetricsPostBodySchema.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.MetricsPostBodySchema.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.MetricsPostBodySchema.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.MetricsPostBodySchema.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.MetricsPostBodySchema.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.MetricsPostBodySchema.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsPostBodySchemaParameters.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsPostBodySchemaParameters.yml new file mode 100644 index 00000000..1863c916 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsPostBodySchemaParameters.yml @@ -0,0 +1,209 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.MetricsPostBodySchemaParameters +name: MetricsPostBodySchemaParameters +fullName: azure.applicationinsights.models.MetricsPostBodySchemaParameters +module: azure.applicationinsights.models +summary: 'The parameters for a single metrics query. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MetricsPostBodySchemaParameters(*, metric_id, timespan: str = None, aggregation=None, + interval=None, segment=None, top: int = None, orderby: str = None, filter: str + = None, **kwargs)' + parameters: + - name: metric_id + description: 'Required. Possible values include: ''requests/count'', + + ''requests/duration'', ''requests/failed'', ''users/count'', + + ''users/authenticated'', ''pageViews/count'', ''pageViews/duration'', + + ''client/processingDuration'', ''client/receiveDuration'', + + ''client/networkDuration'', ''client/sendDuration'', ''client/totalDuration'', + + ''dependencies/count'', ''dependencies/failed'', ''dependencies/duration'', + + ''exceptions/count'', ''exceptions/browser'', ''exceptions/server'', + + ''sessions/count'', ''performanceCounters/requestExecutionTime'', + + ''performanceCounters/requestsPerSecond'', + + ''performanceCounters/requestsInQueue'', + + ''performanceCounters/memoryAvailableBytes'', + + ''performanceCounters/exceptionsPerSecond'', + + ''performanceCounters/processCpuPercentage'', + + ''performanceCounters/processIOBytesPerSecond'', + + ''performanceCounters/processPrivateBytes'', + + ''performanceCounters/processorCpuPercentage'', + + ''availabilityResults/availabilityPercentage'', + + ''availabilityResults/duration'', ''billing/telemetryCount'', + + ''customEvents/count''' + isRequired: true + types: + - + - + - name: timespan + isRequired: true + types: + - + - name: aggregation + isRequired: true + types: + - [ + - ] + - name: interval + isRequired: true + types: + - + - name: segment + isRequired: true + types: + - [ + - ] + - name: top + isRequired: true + types: + - + - name: orderby + isRequired: true + types: + - + - name: filter + isRequired: true + types: + - + keywordOnlyParameters: + - name: metric_id + isRequired: true + - name: timespan + isRequired: true + - name: aggregation + isRequired: true + - name: interval + isRequired: true + - name: segment + isRequired: true + - name: top + isRequired: true + - name: orderby + isRequired: true + - name: filter + isRequired: true +methods: +- uid: azure.applicationinsights.models.MetricsPostBodySchemaParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.MetricsPostBodySchemaParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.MetricsPostBodySchemaParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.MetricsPostBodySchemaParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.MetricsPostBodySchemaParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.MetricsPostBodySchemaParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.MetricsPostBodySchemaParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsResult.yml new file mode 100644 index 00000000..cfe902d5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsResult.yml @@ -0,0 +1,122 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.MetricsResult +name: MetricsResult +fullName: azure.applicationinsights.models.MetricsResult +module: azure.applicationinsights.models +summary: A metric result. +constructor: + syntax: MetricsResult(*, value=None, **kwargs) + parameters: + - name: value + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true +methods: +- uid: azure.applicationinsights.models.MetricsResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.MetricsResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.MetricsResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.MetricsResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.MetricsResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.MetricsResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.MetricsResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsResultInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsResultInfo.yml new file mode 100644 index 00000000..43c2b4d5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsResultInfo.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.MetricsResultInfo +name: MetricsResultInfo +fullName: azure.applicationinsights.models.MetricsResultInfo +module: azure.applicationinsights.models +summary: A metric result data. +constructor: + syntax: MetricsResultInfo(*, additional_properties=None, start=None, end=None, interval=None, + segments=None, **kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: start + description: Start time of the metric. + isRequired: true + types: + - + - name: end + description: Start time of the metric. + isRequired: true + types: + - + - name: interval + description: The interval used to segment the metric data. + isRequired: true + types: + - + - name: segments + description: Segmented metric data (if segmented). + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: start + isRequired: true + - name: end + isRequired: true + - name: interval + isRequired: true + - name: segments + isRequired: true +methods: +- uid: azure.applicationinsights.models.MetricsResultInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.MetricsResultInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.MetricsResultInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.MetricsResultInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.MetricsResultInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.MetricsResultInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.MetricsResultInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsResultsItem.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsResultsItem.yml new file mode 100644 index 00000000..9e2e7539 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsResultsItem.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.MetricsResultsItem +name: MetricsResultsItem +fullName: azure.applicationinsights.models.MetricsResultsItem +module: azure.applicationinsights.models +summary: 'MetricsResultsItem. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MetricsResultsItem(*, id: str, status: int, body, **kwargs)' + parameters: + - name: id + description: Required. The specified ID for this metric. + isRequired: true + types: + - + - name: status + description: Required. The HTTP status code of this metric query. + isRequired: true + types: + - + - name: body + description: Required. The results of this metric query. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: status + isRequired: true + - name: body + isRequired: true +methods: +- uid: azure.applicationinsights.models.MetricsResultsItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.MetricsResultsItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.MetricsResultsItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.MetricsResultsItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.MetricsResultsItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.MetricsResultsItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.MetricsResultsItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsSegment.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsSegment.yml new file mode 100644 index 00000000..9c24e606 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsSegment.yml @@ -0,0 +1,38 @@ +### YamlMime:PythonEnum +uid: azure.applicationinsights.models.MetricsSegment +name: MetricsSegment +fullName: azure.applicationinsights.models.MetricsSegment +module: azure.applicationinsights.models +fields: +- name: application_build + uid: azure.applicationinsights.models.MetricsSegment.application_build +- name: application_version + uid: azure.applicationinsights.models.MetricsSegment.application_version +- name: authenticated_or_anonymous_traffic + uid: azure.applicationinsights.models.MetricsSegment.authenticated_or_anonymous_traffic +- name: browser + uid: azure.applicationinsights.models.MetricsSegment.browser +- name: browser_version + uid: azure.applicationinsights.models.MetricsSegment.browser_version +- name: city + uid: azure.applicationinsights.models.MetricsSegment.city +- name: cloud_role_name + uid: azure.applicationinsights.models.MetricsSegment.cloud_role_name +- name: cloud_service_name + uid: azure.applicationinsights.models.MetricsSegment.cloud_service_name +- name: continent + uid: azure.applicationinsights.models.MetricsSegment.continent +- name: country_or_region + uid: azure.applicationinsights.models.MetricsSegment.country_or_region +- name: deployment_id + uid: azure.applicationinsights.models.MetricsSegment.deployment_id +- name: deployment_unit + uid: azure.applicationinsights.models.MetricsSegment.deployment_unit +- name: device_type + uid: azure.applicationinsights.models.MetricsSegment.device_type +- name: environment + uid: azure.applicationinsights.models.MetricsSegment.environment +- name: hosting_location + uid: azure.applicationinsights.models.MetricsSegment.hosting_location +- name: instance_name + uid: azure.applicationinsights.models.MetricsSegment.instance_name diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsSegmentInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsSegmentInfo.yml new file mode 100644 index 00000000..07fa2074 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsSegmentInfo.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.MetricsSegmentInfo +name: MetricsSegmentInfo +fullName: azure.applicationinsights.models.MetricsSegmentInfo +module: azure.applicationinsights.models +summary: A metric segment. +constructor: + syntax: MetricsSegmentInfo(*, additional_properties=None, start=None, end=None, + segments=None, **kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: start + description: 'Start time of the metric segment (only when an interval was + + specified).' + isRequired: true + types: + - + - name: end + description: 'Start time of the metric segment (only when an interval was + + specified).' + isRequired: true + types: + - + - name: segments + description: Segmented metric data (if further segmented). + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: start + isRequired: true + - name: end + isRequired: true + - name: segments + isRequired: true +methods: +- uid: azure.applicationinsights.models.MetricsSegmentInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.MetricsSegmentInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.MetricsSegmentInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.MetricsSegmentInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.MetricsSegmentInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.MetricsSegmentInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.MetricsSegmentInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.QueryBody.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.QueryBody.yml new file mode 100644 index 00000000..3e411e95 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.QueryBody.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.QueryBody +name: QueryBody +fullName: azure.applicationinsights.models.QueryBody +module: azure.applicationinsights.models +summary: 'The Analytics query. Learn more about the [Analytics query + + syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/). + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'QueryBody(*, query: str, timespan: str = None, applications=None, **kwargs)' + parameters: + - name: query + description: Required. The query to execute. + isRequired: true + types: + - + - name: timespan + description: 'Optional. The timespan over which to query data. This is + + an ISO8601 time period value. This timespan is applied in addition to any + + that are specified in the query expression.' + isRequired: true + types: + - + - name: applications + description: 'A list of Application IDs for cross-application + + queries.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: query + isRequired: true + - name: timespan + isRequired: true + - name: applications + isRequired: true +methods: +- uid: azure.applicationinsights.models.QueryBody.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.QueryBody.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.QueryBody.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.QueryBody.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.QueryBody.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.QueryBody.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.QueryBody.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.QueryResults.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.QueryResults.yml new file mode 100644 index 00000000..3085c84f --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.QueryResults.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.QueryResults +name: QueryResults +fullName: azure.applicationinsights.models.QueryResults +module: azure.applicationinsights.models +summary: 'A query response. + + + Contains the tables, columns & rows resulting from a query. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: QueryResults(*, tables, **kwargs) + parameters: + - name: tables + description: Required. The list of tables, columns and rows. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: tables + isRequired: true +methods: +- uid: azure.applicationinsights.models.QueryResults.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.QueryResults.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.QueryResults.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.QueryResults.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.QueryResults.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.QueryResults.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.QueryResults.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.Table(class).yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.Table(class).yml new file mode 100644 index 00000000..0b003512 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.Table(class).yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.Table +name: Table +fullName: azure.applicationinsights.models.Table +module: azure.applicationinsights.models +summary: 'A query response table. + + + Contains the columns and rows for one table in a query response. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Table(*, name: str, columns, rows, **kwargs)' + parameters: + - name: name + description: Required. The name of the table. + isRequired: true + types: + - + - name: columns + description: Required. The list of columns in this table. + isRequired: true + types: + - [] + - name: rows + description: Required. The resulting rows from this query. + isRequired: true + types: + - [[]] + keywordOnlyParameters: + - name: name + isRequired: true + - name: columns + isRequired: true + - name: rows + isRequired: true +methods: +- uid: azure.applicationinsights.models.Table.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.Table.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.Table.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.Table.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.Table.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.Table.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.Table.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.application_insights_data_client_enums.EventType.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.application_insights_data_client_enums.EventType.yml new file mode 100644 index 00000000..a1a01252 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.application_insights_data_client_enums.EventType.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonEnum +uid: azure.applicationinsights.models.application_insights_data_client_enums.EventType +name: EventType +fullName: azure.applicationinsights.models.application_insights_data_client_enums.EventType +module: azure.applicationinsights.models.application_insights_data_client_enums +fields: +- name: all + uid: azure.applicationinsights.models.application_insights_data_client_enums.EventType.all +- name: availability_results + uid: azure.applicationinsights.models.application_insights_data_client_enums.EventType.availability_results +- name: browser_timings + uid: azure.applicationinsights.models.application_insights_data_client_enums.EventType.browser_timings +- name: custom_events + uid: azure.applicationinsights.models.application_insights_data_client_enums.EventType.custom_events +- name: custom_metrics + uid: azure.applicationinsights.models.application_insights_data_client_enums.EventType.custom_metrics +- name: dependencies + uid: azure.applicationinsights.models.application_insights_data_client_enums.EventType.dependencies +- name: exceptions + uid: azure.applicationinsights.models.application_insights_data_client_enums.EventType.exceptions +- name: page_views + uid: azure.applicationinsights.models.application_insights_data_client_enums.EventType.page_views +- name: performance_counters + uid: azure.applicationinsights.models.application_insights_data_client_enums.EventType.performance_counters +- name: requests + uid: azure.applicationinsights.models.application_insights_data_client_enums.EventType.requests +- name: traces + uid: azure.applicationinsights.models.application_insights_data_client_enums.EventType.traces diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.application_insights_data_client_enums.MetricId.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.application_insights_data_client_enums.MetricId.yml new file mode 100644 index 00000000..3743fd4e --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.application_insights_data_client_enums.MetricId.yml @@ -0,0 +1,70 @@ +### YamlMime:PythonEnum +uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId +name: MetricId +fullName: azure.applicationinsights.models.application_insights_data_client_enums.MetricId +module: azure.applicationinsights.models.application_insights_data_client_enums +fields: +- name: availability_resultsavailability_percentage + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.availability_resultsavailability_percentage +- name: availability_resultsduration + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.availability_resultsduration +- name: billingtelemetry_count + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.billingtelemetry_count +- name: clientnetwork_duration + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.clientnetwork_duration +- name: clientprocessing_duration + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.clientprocessing_duration +- name: clientreceive_duration + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.clientreceive_duration +- name: clientsend_duration + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.clientsend_duration +- name: clienttotal_duration + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.clienttotal_duration +- name: custom_eventscount + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.custom_eventscount +- name: dependenciescount + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.dependenciescount +- name: dependenciesduration + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.dependenciesduration +- name: dependenciesfailed + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.dependenciesfailed +- name: exceptionsbrowser + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.exceptionsbrowser +- name: exceptionscount + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.exceptionscount +- name: exceptionsserver + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.exceptionsserver +- name: page_viewscount + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.page_viewscount +- name: page_viewsduration + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.page_viewsduration +- name: performance_countersexceptions_per_second + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.performance_countersexceptions_per_second +- name: performance_countersmemory_available_bytes + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.performance_countersmemory_available_bytes +- name: performance_countersprocess_cpu_percentage + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.performance_countersprocess_cpu_percentage +- name: performance_countersprocess_io_bytes_per_second + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.performance_countersprocess_io_bytes_per_second +- name: performance_countersprocess_private_bytes + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.performance_countersprocess_private_bytes +- name: performance_countersprocessor_cpu_percentage + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.performance_countersprocessor_cpu_percentage +- name: performance_countersrequest_execution_time + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.performance_countersrequest_execution_time +- name: performance_countersrequests_in_queue + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.performance_countersrequests_in_queue +- name: performance_countersrequests_per_second + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.performance_countersrequests_per_second +- name: requestscount + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.requestscount +- name: requestsduration + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.requestsduration +- name: requestsfailed + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.requestsfailed +- name: sessionscount + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.sessionscount +- name: usersauthenticated + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.usersauthenticated +- name: userscount + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId.userscount diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.application_insights_data_client_enums.MetricsAggregation.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.application_insights_data_client_enums.MetricsAggregation.yml new file mode 100644 index 00000000..95af3b40 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.application_insights_data_client_enums.MetricsAggregation.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonEnum +uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsAggregation +name: MetricsAggregation +fullName: azure.applicationinsights.models.application_insights_data_client_enums.MetricsAggregation +module: azure.applicationinsights.models.application_insights_data_client_enums +fields: +- name: avg + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsAggregation.avg +- name: count + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsAggregation.count +- name: max + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsAggregation.max +- name: min + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsAggregation.min +- name: sum + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsAggregation.sum +- name: unique + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsAggregation.unique diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment.yml new file mode 100644 index 00000000..14745250 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment.yml @@ -0,0 +1,38 @@ +### YamlMime:PythonEnum +uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment +name: MetricsSegment +fullName: azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment +module: azure.applicationinsights.models.application_insights_data_client_enums +fields: +- name: application_build + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment.application_build +- name: application_version + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment.application_version +- name: authenticated_or_anonymous_traffic + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment.authenticated_or_anonymous_traffic +- name: browser + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment.browser +- name: browser_version + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment.browser_version +- name: city + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment.city +- name: cloud_role_name + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment.cloud_role_name +- name: cloud_service_name + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment.cloud_service_name +- name: continent + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment.continent +- name: country_or_region + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment.country_or_region +- name: deployment_id + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment.deployment_id +- name: deployment_unit + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment.deployment_unit +- name: device_type + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment.device_type +- name: environment + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment.environment +- name: hosting_location + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment.hosting_location +- name: instance_name + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment.instance_name diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.application_insights_data_client_enums.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.application_insights_data_client_enums.yml new file mode 100644 index 00000000..5c83e223 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.application_insights_data_client_enums.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.application_insights_data_client_enums +name: application_insights_data_client_enums +fullName: azure.applicationinsights.models.application_insights_data_client_enums +enums: +- azure.applicationinsights.models.application_insights_data_client_enums.EventType +- azure.applicationinsights.models.application_insights_data_client_enums.MetricId +- azure.applicationinsights.models.application_insights_data_client_enums.MetricsAggregation +- azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.column.Column.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.column.Column.yml new file mode 100644 index 00000000..b8e20677 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.column.Column.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.column.Column +name: Column +fullName: azure.applicationinsights.models.column.Column +module: azure.applicationinsights.models.column +summary: 'A table column. + + + A column in a table.' +constructor: + syntax: Column(**kwargs) + parameters: + - name: name + description: The name of this column. + isRequired: true + types: + - + - name: type + description: The data type of this column. + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.column.Column.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.column.Column.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.column.Column.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.column.Column.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.column.Column.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.column.Column.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.column.Column.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.column.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.column.yml new file mode 100644 index 00000000..52072383 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.column.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.column +name: column +fullName: azure.applicationinsights.models.column +classes: +- azure.applicationinsights.models.column.Column diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.column_py3.Column.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.column_py3.Column.yml new file mode 100644 index 00000000..9bcf9b2e --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.column_py3.Column.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.column_py3.Column +name: Column +fullName: azure.applicationinsights.models.column_py3.Column +module: azure.applicationinsights.models.column_py3 +summary: 'A table column. + + + A column in a table.' +constructor: + syntax: 'Column(*, name: str = None, type: str = None, **kwargs)' + parameters: + - name: name + description: The name of this column. + isRequired: true + types: + - + - name: type + description: The data type of this column. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: type + isRequired: true +methods: +- uid: azure.applicationinsights.models.column_py3.Column.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.column_py3.Column.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.column_py3.Column.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.column_py3.Column.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.column_py3.Column.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.column_py3.Column.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.column_py3.Column.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.column_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.column_py3.yml new file mode 100644 index 00000000..c58df9d9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.column_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.column_py3 +name: column_py3 +fullName: azure.applicationinsights.models.column_py3 +classes: +- azure.applicationinsights.models.column_py3.Column diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_detail.ErrorDetail.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_detail.ErrorDetail.yml new file mode 100644 index 00000000..f39fb7af --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_detail.ErrorDetail.yml @@ -0,0 +1,153 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.error_detail.ErrorDetail +name: ErrorDetail +fullName: azure.applicationinsights.models.error_detail.ErrorDetail +module: azure.applicationinsights.models.error_detail +summary: 'Error details. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ErrorDetail(**kwargs) + parameters: + - name: code + description: Required. The error's code. + isRequired: true + types: + - + - name: message + description: Required. A human readable error message. + isRequired: true + types: + - + - name: target + description: 'Indicates which property in the request is responsible for + + the error.' + isRequired: true + types: + - + - name: value + description: 'Indicates which value in ''target'' is responsible for the + + error.' + isRequired: true + types: + - + - name: resources + description: 'Indicates resources which were responsible for the + + error.' + isRequired: true + types: + - [] + - name: additional_properties + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.error_detail.ErrorDetail.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.error_detail.ErrorDetail.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.error_detail.ErrorDetail.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.error_detail.ErrorDetail.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.error_detail.ErrorDetail.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.error_detail.ErrorDetail.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.error_detail.ErrorDetail.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_detail.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_detail.yml new file mode 100644 index 00000000..e1c5a133 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_detail.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.error_detail +name: error_detail +fullName: azure.applicationinsights.models.error_detail +classes: +- azure.applicationinsights.models.error_detail.ErrorDetail diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_detail_py3.ErrorDetail.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_detail_py3.ErrorDetail.yml new file mode 100644 index 00000000..7598816b --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_detail_py3.ErrorDetail.yml @@ -0,0 +1,167 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.error_detail_py3.ErrorDetail +name: ErrorDetail +fullName: azure.applicationinsights.models.error_detail_py3.ErrorDetail +module: azure.applicationinsights.models.error_detail_py3 +summary: 'Error details. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ErrorDetail(*, code: str, message: str, target: str = None, value: str + = None, resources=None, additional_properties=None, **kwargs)' + parameters: + - name: code + description: Required. The error's code. + isRequired: true + types: + - + - name: message + description: Required. A human readable error message. + isRequired: true + types: + - + - name: target + description: 'Indicates which property in the request is responsible for + + the error.' + isRequired: true + types: + - + - name: value + description: 'Indicates which value in ''target'' is responsible for the + + error.' + isRequired: true + types: + - + - name: resources + description: 'Indicates resources which were responsible for the + + error.' + isRequired: true + types: + - [] + - name: additional_properties + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true + - name: target + isRequired: true + - name: value + isRequired: true + - name: resources + isRequired: true + - name: additional_properties + isRequired: true +methods: +- uid: azure.applicationinsights.models.error_detail_py3.ErrorDetail.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.error_detail_py3.ErrorDetail.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.error_detail_py3.ErrorDetail.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.error_detail_py3.ErrorDetail.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.error_detail_py3.ErrorDetail.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.error_detail_py3.ErrorDetail.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.error_detail_py3.ErrorDetail.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_detail_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_detail_py3.yml new file mode 100644 index 00000000..f29d1293 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_detail_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.error_detail_py3 +name: error_detail_py3 +fullName: azure.applicationinsights.models.error_detail_py3 +classes: +- azure.applicationinsights.models.error_detail_py3.ErrorDetail diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_info.ErrorInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_info.ErrorInfo.yml new file mode 100644 index 00000000..1779f6a8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_info.ErrorInfo.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.error_info.ErrorInfo +name: ErrorInfo +fullName: azure.applicationinsights.models.error_info.ErrorInfo +module: azure.applicationinsights.models.error_info +summary: 'The code and message for an error. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ErrorInfo(**kwargs) + parameters: + - name: code + description: Required. A machine readable error code. + isRequired: true + types: + - + - name: message + description: Required. A human readable error message. + isRequired: true + types: + - + - name: details + description: error details. + isRequired: true + types: + - [] + - name: innererror + description: Inner error details if they exist. + isRequired: true + types: + - + - name: additional_properties + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.error_info.ErrorInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.error_info.ErrorInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.error_info.ErrorInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.error_info.ErrorInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.error_info.ErrorInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.error_info.ErrorInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.error_info.ErrorInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_info.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_info.yml new file mode 100644 index 00000000..16c8c841 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.error_info +name: error_info +fullName: azure.applicationinsights.models.error_info +classes: +- azure.applicationinsights.models.error_info.ErrorInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_info_py3.ErrorInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_info_py3.ErrorInfo.yml new file mode 100644 index 00000000..d3151a7e --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_info_py3.ErrorInfo.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.error_info_py3.ErrorInfo +name: ErrorInfo +fullName: azure.applicationinsights.models.error_info_py3.ErrorInfo +module: azure.applicationinsights.models.error_info_py3 +summary: 'The code and message for an error. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ErrorInfo(*, code: str, message: str, details=None, innererror=None, additional_properties=None, + **kwargs)' + parameters: + - name: code + description: Required. A machine readable error code. + isRequired: true + types: + - + - name: message + description: Required. A human readable error message. + isRequired: true + types: + - + - name: details + description: error details. + isRequired: true + types: + - [] + - name: innererror + description: Inner error details if they exist. + isRequired: true + types: + - + - name: additional_properties + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true + - name: details + isRequired: true + - name: innererror + isRequired: true + - name: additional_properties + isRequired: true +methods: +- uid: azure.applicationinsights.models.error_info_py3.ErrorInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.error_info_py3.ErrorInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.error_info_py3.ErrorInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.error_info_py3.ErrorInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.error_info_py3.ErrorInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.error_info_py3.ErrorInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.error_info_py3.ErrorInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_info_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_info_py3.yml new file mode 100644 index 00000000..d8c74ba1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.error_info_py3 +name: error_info_py3 +fullName: azure.applicationinsights.models.error_info_py3 +classes: +- azure.applicationinsights.models.error_info_py3.ErrorInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response.ErrorResponse.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response.ErrorResponse.yml new file mode 100644 index 00000000..22b62358 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response.ErrorResponse.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.error_response.ErrorResponse +name: ErrorResponse +fullName: azure.applicationinsights.models.error_response.ErrorResponse +module: azure.applicationinsights.models.error_response +summary: 'Error details. + + + Contains details when the response code indicates an error. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ErrorResponse(**kwargs) + parameters: + - name: error + description: Required. The error details. + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.error_response.ErrorResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.error_response.ErrorResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.error_response.ErrorResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.error_response.ErrorResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.error_response.ErrorResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.error_response.ErrorResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.error_response.ErrorResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response.ErrorResponseException.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response.ErrorResponseException.yml new file mode 100644 index 00000000..45eea6b6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response.ErrorResponseException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.error_response.ErrorResponseException +name: ErrorResponseException +fullName: azure.applicationinsights.models.error_response.ErrorResponseException +module: azure.applicationinsights.models.error_response +summary: 'Server responded with exception of type: ''ErrorResponse''.' +constructor: + syntax: ErrorResponseException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.applicationinsights.models.error_response.ErrorResponseException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.applicationinsights.models.error_response.ErrorResponseException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.applicationinsights.models.error_response.ErrorResponseException.args + name: args diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response.yml new file mode 100644 index 00000000..cf87a0eb --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.error_response +name: error_response +fullName: azure.applicationinsights.models.error_response +classes: +- azure.applicationinsights.models.error_response.ErrorResponse +- azure.applicationinsights.models.error_response.ErrorResponseException diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response_py3.ErrorResponse.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response_py3.ErrorResponse.yml new file mode 100644 index 00000000..d82fecef --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response_py3.ErrorResponse.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.error_response_py3.ErrorResponse +name: ErrorResponse +fullName: azure.applicationinsights.models.error_response_py3.ErrorResponse +module: azure.applicationinsights.models.error_response_py3 +summary: 'Error details. + + + Contains details when the response code indicates an error. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ErrorResponse(*, error, **kwargs) + parameters: + - name: error + description: Required. The error details. + isRequired: true + types: + - + keywordOnlyParameters: + - name: error + isRequired: true +methods: +- uid: azure.applicationinsights.models.error_response_py3.ErrorResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.error_response_py3.ErrorResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.error_response_py3.ErrorResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.error_response_py3.ErrorResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.error_response_py3.ErrorResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.error_response_py3.ErrorResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.error_response_py3.ErrorResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response_py3.ErrorResponseException.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response_py3.ErrorResponseException.yml new file mode 100644 index 00000000..cde41580 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response_py3.ErrorResponseException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.error_response_py3.ErrorResponseException +name: ErrorResponseException +fullName: azure.applicationinsights.models.error_response_py3.ErrorResponseException +module: azure.applicationinsights.models.error_response_py3 +summary: 'Server responded with exception of type: ''ErrorResponse''.' +constructor: + syntax: ErrorResponseException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.applicationinsights.models.error_response_py3.ErrorResponseException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.applicationinsights.models.error_response_py3.ErrorResponseException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.applicationinsights.models.error_response_py3.ErrorResponseException.args + name: args diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response_py3.yml new file mode 100644 index 00000000..efd91b4a --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_response_py3.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.error_response_py3 +name: error_response_py3 +fullName: azure.applicationinsights.models.error_response_py3 +classes: +- azure.applicationinsights.models.error_response_py3.ErrorResponse +- azure.applicationinsights.models.error_response_py3.ErrorResponseException diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_ai_info.EventsAiInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_ai_info.EventsAiInfo.yml new file mode 100644 index 00000000..b08105e9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_ai_info.EventsAiInfo.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_ai_info.EventsAiInfo +name: EventsAiInfo +fullName: azure.applicationinsights.models.events_ai_info.EventsAiInfo +module: azure.applicationinsights.models.events_ai_info +summary: AI related application info for an event result. +constructor: + syntax: EventsAiInfo(**kwargs) + parameters: + - name: i_key + description: iKey of the app + isRequired: true + types: + - + - name: app_name + description: Name of the application + isRequired: true + types: + - + - name: app_id + description: ID of the application + isRequired: true + types: + - + - name: sdk_version + description: SDK version of the application + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_ai_info.EventsAiInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_ai_info.EventsAiInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_ai_info.EventsAiInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_ai_info.EventsAiInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_ai_info.EventsAiInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_ai_info.EventsAiInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_ai_info.EventsAiInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_ai_info.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_ai_info.yml new file mode 100644 index 00000000..7a8f26ea --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_ai_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_ai_info +name: events_ai_info +fullName: azure.applicationinsights.models.events_ai_info +classes: +- azure.applicationinsights.models.events_ai_info.EventsAiInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_ai_info_py3.EventsAiInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_ai_info_py3.EventsAiInfo.yml new file mode 100644 index 00000000..77296a71 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_ai_info_py3.EventsAiInfo.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_ai_info_py3.EventsAiInfo +name: EventsAiInfo +fullName: azure.applicationinsights.models.events_ai_info_py3.EventsAiInfo +module: azure.applicationinsights.models.events_ai_info_py3 +summary: AI related application info for an event result. +constructor: + syntax: 'EventsAiInfo(*, i_key: str = None, app_name: str = None, app_id: str = + None, sdk_version: str = None, **kwargs)' + parameters: + - name: i_key + description: iKey of the app + isRequired: true + types: + - + - name: app_name + description: Name of the application + isRequired: true + types: + - + - name: app_id + description: ID of the application + isRequired: true + types: + - + - name: sdk_version + description: SDK version of the application + isRequired: true + types: + - + keywordOnlyParameters: + - name: i_key + isRequired: true + - name: app_name + isRequired: true + - name: app_id + isRequired: true + - name: sdk_version + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_ai_info_py3.EventsAiInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_ai_info_py3.EventsAiInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_ai_info_py3.EventsAiInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_ai_info_py3.EventsAiInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_ai_info_py3.EventsAiInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_ai_info_py3.EventsAiInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_ai_info_py3.EventsAiInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_ai_info_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_ai_info_py3.yml new file mode 100644 index 00000000..cc439477 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_ai_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_ai_info_py3 +name: events_ai_info_py3 +fullName: azure.applicationinsights.models.events_ai_info_py3 +classes: +- azure.applicationinsights.models.events_ai_info_py3.EventsAiInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_application_info.EventsApplicationInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_application_info.EventsApplicationInfo.yml new file mode 100644 index 00000000..639284db --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_application_info.EventsApplicationInfo.yml @@ -0,0 +1,120 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_application_info.EventsApplicationInfo +name: EventsApplicationInfo +fullName: azure.applicationinsights.models.events_application_info.EventsApplicationInfo +module: azure.applicationinsights.models.events_application_info +summary: Application info for an event result. +constructor: + syntax: EventsApplicationInfo(**kwargs) + parameters: + - name: version + description: Version of the application + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_application_info.EventsApplicationInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_application_info.EventsApplicationInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_application_info.EventsApplicationInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_application_info.EventsApplicationInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_application_info.EventsApplicationInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_application_info.EventsApplicationInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_application_info.EventsApplicationInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_application_info.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_application_info.yml new file mode 100644 index 00000000..a2132efd --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_application_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_application_info +name: events_application_info +fullName: azure.applicationinsights.models.events_application_info +classes: +- azure.applicationinsights.models.events_application_info.EventsApplicationInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_application_info_py3.EventsApplicationInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_application_info_py3.EventsApplicationInfo.yml new file mode 100644 index 00000000..ff395d00 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_application_info_py3.EventsApplicationInfo.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_application_info_py3.EventsApplicationInfo +name: EventsApplicationInfo +fullName: azure.applicationinsights.models.events_application_info_py3.EventsApplicationInfo +module: azure.applicationinsights.models.events_application_info_py3 +summary: Application info for an event result. +constructor: + syntax: 'EventsApplicationInfo(*, version: str = None, **kwargs)' + parameters: + - name: version + description: Version of the application + isRequired: true + types: + - + keywordOnlyParameters: + - name: version + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_application_info_py3.EventsApplicationInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_application_info_py3.EventsApplicationInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_application_info_py3.EventsApplicationInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_application_info_py3.EventsApplicationInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_application_info_py3.EventsApplicationInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_application_info_py3.EventsApplicationInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_application_info_py3.EventsApplicationInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_application_info_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_application_info_py3.yml new file mode 100644 index 00000000..48fb40d3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_application_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_application_info_py3 +name: events_application_info_py3 +fullName: azure.applicationinsights.models.events_application_info_py3 +classes: +- azure.applicationinsights.models.events_application_info_py3.EventsApplicationInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_info.EventsAvailabilityResultInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_info.EventsAvailabilityResultInfo.yml new file mode 100644 index 00000000..c324eaaf --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_info.EventsAvailabilityResultInfo.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_availability_result_info.EventsAvailabilityResultInfo +name: EventsAvailabilityResultInfo +fullName: azure.applicationinsights.models.events_availability_result_info.EventsAvailabilityResultInfo +module: azure.applicationinsights.models.events_availability_result_info +summary: The availability result info. +constructor: + syntax: EventsAvailabilityResultInfo(**kwargs) + parameters: + - name: name + description: The name of the availability result + isRequired: true + types: + - + - name: success + description: Indicates if the availability result was successful + isRequired: true + types: + - + - name: duration + description: The duration of the availability result + isRequired: true + types: + - + - name: performance_bucket + description: 'The performance bucket of the availability + + result' + isRequired: true + types: + - + - name: message + description: The message of the availability result + isRequired: true + types: + - + - name: location + description: The location of the availability result + isRequired: true + types: + - + - name: id + description: The ID of the availability result + isRequired: true + types: + - + - name: size + description: The size of the availability result + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_availability_result_info.EventsAvailabilityResultInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_availability_result_info.EventsAvailabilityResultInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_availability_result_info.EventsAvailabilityResultInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_availability_result_info.EventsAvailabilityResultInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_availability_result_info.EventsAvailabilityResultInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_availability_result_info.EventsAvailabilityResultInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_availability_result_info.EventsAvailabilityResultInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_info.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_info.yml new file mode 100644 index 00000000..4ef19c64 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_availability_result_info +name: events_availability_result_info +fullName: azure.applicationinsights.models.events_availability_result_info +classes: +- azure.applicationinsights.models.events_availability_result_info.EventsAvailabilityResultInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_info_py3.EventsAvailabilityResultInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_info_py3.EventsAvailabilityResultInfo.yml new file mode 100644 index 00000000..39daf41a --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_info_py3.EventsAvailabilityResultInfo.yml @@ -0,0 +1,176 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_availability_result_info_py3.EventsAvailabilityResultInfo +name: EventsAvailabilityResultInfo +fullName: azure.applicationinsights.models.events_availability_result_info_py3.EventsAvailabilityResultInfo +module: azure.applicationinsights.models.events_availability_result_info_py3 +summary: The availability result info. +constructor: + syntax: 'EventsAvailabilityResultInfo(*, name: str = None, success: str = None, + duration: int = None, performance_bucket: str = None, message: str = None, location: + str = None, id: str = None, size: str = None, **kwargs)' + parameters: + - name: name + description: The name of the availability result + isRequired: true + types: + - + - name: success + description: Indicates if the availability result was successful + isRequired: true + types: + - + - name: duration + description: The duration of the availability result + isRequired: true + types: + - + - name: performance_bucket + description: 'The performance bucket of the availability + + result' + isRequired: true + types: + - + - name: message + description: The message of the availability result + isRequired: true + types: + - + - name: location + description: The location of the availability result + isRequired: true + types: + - + - name: id + description: The ID of the availability result + isRequired: true + types: + - + - name: size + description: The size of the availability result + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: success + isRequired: true + - name: duration + isRequired: true + - name: performance_bucket + isRequired: true + - name: message + isRequired: true + - name: location + isRequired: true + - name: id + isRequired: true + - name: size + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_availability_result_info_py3.EventsAvailabilityResultInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_availability_result_info_py3.EventsAvailabilityResultInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_availability_result_info_py3.EventsAvailabilityResultInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_availability_result_info_py3.EventsAvailabilityResultInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_availability_result_info_py3.EventsAvailabilityResultInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_availability_result_info_py3.EventsAvailabilityResultInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_availability_result_info_py3.EventsAvailabilityResultInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_info_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_info_py3.yml new file mode 100644 index 00000000..9e2e7abf --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_availability_result_info_py3 +name: events_availability_result_info_py3 +fullName: azure.applicationinsights.models.events_availability_result_info_py3 +classes: +- azure.applicationinsights.models.events_availability_result_info_py3.EventsAvailabilityResultInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_result.EventsAvailabilityResultResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_result.EventsAvailabilityResultResult.yml new file mode 100644 index 00000000..b20ccc6f --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_result.EventsAvailabilityResultResult.yml @@ -0,0 +1,187 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_availability_result_result.EventsAvailabilityResultResult +name: EventsAvailabilityResultResult +fullName: azure.applicationinsights.models.events_availability_result_result.EventsAvailabilityResultResult +module: azure.applicationinsights.models.events_availability_result_result +summary: 'An availability result result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: EventsAvailabilityResultResult(**kwargs) + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: availability_result + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_availability_result_result.EventsAvailabilityResultResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_availability_result_result.EventsAvailabilityResultResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_availability_result_result.EventsAvailabilityResultResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_availability_result_result.EventsAvailabilityResultResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_availability_result_result.EventsAvailabilityResultResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_availability_result_result.EventsAvailabilityResultResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_availability_result_result.EventsAvailabilityResultResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_result.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_result.yml new file mode 100644 index 00000000..b0f0b8f5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_availability_result_result +name: events_availability_result_result +fullName: azure.applicationinsights.models.events_availability_result_result +classes: +- azure.applicationinsights.models.events_availability_result_result.EventsAvailabilityResultResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_result_py3.EventsAvailabilityResultResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_result_py3.EventsAvailabilityResultResult.yml new file mode 100644 index 00000000..dd8fe7cb --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_result_py3.EventsAvailabilityResultResult.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_availability_result_result_py3.EventsAvailabilityResultResult +name: EventsAvailabilityResultResult +fullName: azure.applicationinsights.models.events_availability_result_result_py3.EventsAvailabilityResultResult +module: azure.applicationinsights.models.events_availability_result_result_py3 +summary: 'An availability result result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EventsAvailabilityResultResult(*, id: str = None, count: int = None, timestamp=None, + custom_dimensions=None, custom_measurements=None, operation=None, session=None, + user=None, cloud=None, ai=None, application=None, client=None, availability_result=None, + **kwargs)' + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: availability_result + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: count + isRequired: true + - name: timestamp + isRequired: true + - name: custom_dimensions + isRequired: true + - name: custom_measurements + isRequired: true + - name: operation + isRequired: true + - name: session + isRequired: true + - name: user + isRequired: true + - name: cloud + isRequired: true + - name: ai + isRequired: true + - name: application + isRequired: true + - name: client + isRequired: true + - name: availability_result + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_availability_result_result_py3.EventsAvailabilityResultResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_availability_result_result_py3.EventsAvailabilityResultResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_availability_result_result_py3.EventsAvailabilityResultResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_availability_result_result_py3.EventsAvailabilityResultResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_availability_result_result_py3.EventsAvailabilityResultResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_availability_result_result_py3.EventsAvailabilityResultResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_availability_result_result_py3.EventsAvailabilityResultResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_result_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_result_py3.yml new file mode 100644 index 00000000..53f827f6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_availability_result_result_py3 +name: events_availability_result_result_py3 +fullName: azure.applicationinsights.models.events_availability_result_result_py3 +classes: +- azure.applicationinsights.models.events_availability_result_result_py3.EventsAvailabilityResultResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_info.EventsBrowserTimingInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_info.EventsBrowserTimingInfo.yml new file mode 100644 index 00000000..4d0b5b38 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_info.EventsBrowserTimingInfo.yml @@ -0,0 +1,165 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_browser_timing_info.EventsBrowserTimingInfo +name: EventsBrowserTimingInfo +fullName: azure.applicationinsights.models.events_browser_timing_info.EventsBrowserTimingInfo +module: azure.applicationinsights.models.events_browser_timing_info +summary: The browser timing information. +constructor: + syntax: EventsBrowserTimingInfo(**kwargs) + parameters: + - name: url_path + description: The path of the URL + isRequired: true + types: + - + - name: url_host + description: The host of the URL + isRequired: true + types: + - + - name: name + description: The name of the page + isRequired: true + types: + - + - name: url + description: The url of the page + isRequired: true + types: + - + - name: total_duration + description: The total duration of the load + isRequired: true + types: + - + - name: performance_bucket + description: The performance bucket of the load + isRequired: true + types: + - + - name: network_duration + description: The network duration of the load + isRequired: true + types: + - + - name: send_duration + description: The send duration of the load + isRequired: true + types: + - + - name: receive_duration + description: The receive duration of the load + isRequired: true + types: + - + - name: processing_duration + description: The processing duration of the load + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_browser_timing_info.EventsBrowserTimingInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_browser_timing_info.EventsBrowserTimingInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_browser_timing_info.EventsBrowserTimingInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_browser_timing_info.EventsBrowserTimingInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_browser_timing_info.EventsBrowserTimingInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_browser_timing_info.EventsBrowserTimingInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_browser_timing_info.EventsBrowserTimingInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_info.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_info.yml new file mode 100644 index 00000000..de975ed6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_browser_timing_info +name: events_browser_timing_info +fullName: azure.applicationinsights.models.events_browser_timing_info +classes: +- azure.applicationinsights.models.events_browser_timing_info.EventsBrowserTimingInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_info_py3.EventsBrowserTimingInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_info_py3.EventsBrowserTimingInfo.yml new file mode 100644 index 00000000..885b501d --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_info_py3.EventsBrowserTimingInfo.yml @@ -0,0 +1,189 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_browser_timing_info_py3.EventsBrowserTimingInfo +name: EventsBrowserTimingInfo +fullName: azure.applicationinsights.models.events_browser_timing_info_py3.EventsBrowserTimingInfo +module: azure.applicationinsights.models.events_browser_timing_info_py3 +summary: The browser timing information. +constructor: + syntax: 'EventsBrowserTimingInfo(*, url_path: str = None, url_host: str = None, + name: str = None, url: str = None, total_duration: int = None, performance_bucket: + str = None, network_duration: int = None, send_duration: int = None, receive_duration: + int = None, processing_duration: int = None, **kwargs)' + parameters: + - name: url_path + description: The path of the URL + isRequired: true + types: + - + - name: url_host + description: The host of the URL + isRequired: true + types: + - + - name: name + description: The name of the page + isRequired: true + types: + - + - name: url + description: The url of the page + isRequired: true + types: + - + - name: total_duration + description: The total duration of the load + isRequired: true + types: + - + - name: performance_bucket + description: The performance bucket of the load + isRequired: true + types: + - + - name: network_duration + description: The network duration of the load + isRequired: true + types: + - + - name: send_duration + description: The send duration of the load + isRequired: true + types: + - + - name: receive_duration + description: The receive duration of the load + isRequired: true + types: + - + - name: processing_duration + description: The processing duration of the load + isRequired: true + types: + - + keywordOnlyParameters: + - name: url_path + isRequired: true + - name: url_host + isRequired: true + - name: name + isRequired: true + - name: url + isRequired: true + - name: total_duration + isRequired: true + - name: performance_bucket + isRequired: true + - name: network_duration + isRequired: true + - name: send_duration + isRequired: true + - name: receive_duration + isRequired: true + - name: processing_duration + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_browser_timing_info_py3.EventsBrowserTimingInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_browser_timing_info_py3.EventsBrowserTimingInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_browser_timing_info_py3.EventsBrowserTimingInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_browser_timing_info_py3.EventsBrowserTimingInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_browser_timing_info_py3.EventsBrowserTimingInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_browser_timing_info_py3.EventsBrowserTimingInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_browser_timing_info_py3.EventsBrowserTimingInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_info_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_info_py3.yml new file mode 100644 index 00000000..5cd4481e --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_browser_timing_info_py3 +name: events_browser_timing_info_py3 +fullName: azure.applicationinsights.models.events_browser_timing_info_py3 +classes: +- azure.applicationinsights.models.events_browser_timing_info_py3.EventsBrowserTimingInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_result.EventsBrowserTimingResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_result.EventsBrowserTimingResult.yml new file mode 100644 index 00000000..67d96f06 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_result.EventsBrowserTimingResult.yml @@ -0,0 +1,191 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_browser_timing_result.EventsBrowserTimingResult +name: EventsBrowserTimingResult +fullName: azure.applicationinsights.models.events_browser_timing_result.EventsBrowserTimingResult +module: azure.applicationinsights.models.events_browser_timing_result +summary: 'A browser timing result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: EventsBrowserTimingResult(**kwargs) + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: browser_timing + isRequired: true + types: + - + - name: client_performance + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_browser_timing_result.EventsBrowserTimingResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_browser_timing_result.EventsBrowserTimingResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_browser_timing_result.EventsBrowserTimingResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_browser_timing_result.EventsBrowserTimingResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_browser_timing_result.EventsBrowserTimingResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_browser_timing_result.EventsBrowserTimingResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_browser_timing_result.EventsBrowserTimingResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_result.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_result.yml new file mode 100644 index 00000000..4d7243bb --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_browser_timing_result +name: events_browser_timing_result +fullName: azure.applicationinsights.models.events_browser_timing_result +classes: +- azure.applicationinsights.models.events_browser_timing_result.EventsBrowserTimingResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_result_py3.EventsBrowserTimingResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_result_py3.EventsBrowserTimingResult.yml new file mode 100644 index 00000000..796bb353 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_result_py3.EventsBrowserTimingResult.yml @@ -0,0 +1,223 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_browser_timing_result_py3.EventsBrowserTimingResult +name: EventsBrowserTimingResult +fullName: azure.applicationinsights.models.events_browser_timing_result_py3.EventsBrowserTimingResult +module: azure.applicationinsights.models.events_browser_timing_result_py3 +summary: 'A browser timing result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EventsBrowserTimingResult(*, id: str = None, count: int = None, timestamp=None, + custom_dimensions=None, custom_measurements=None, operation=None, session=None, + user=None, cloud=None, ai=None, application=None, client=None, browser_timing=None, + client_performance=None, **kwargs)' + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: browser_timing + isRequired: true + types: + - + - name: client_performance + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: count + isRequired: true + - name: timestamp + isRequired: true + - name: custom_dimensions + isRequired: true + - name: custom_measurements + isRequired: true + - name: operation + isRequired: true + - name: session + isRequired: true + - name: user + isRequired: true + - name: cloud + isRequired: true + - name: ai + isRequired: true + - name: application + isRequired: true + - name: client + isRequired: true + - name: browser_timing + isRequired: true + - name: client_performance + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_browser_timing_result_py3.EventsBrowserTimingResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_browser_timing_result_py3.EventsBrowserTimingResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_browser_timing_result_py3.EventsBrowserTimingResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_browser_timing_result_py3.EventsBrowserTimingResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_browser_timing_result_py3.EventsBrowserTimingResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_browser_timing_result_py3.EventsBrowserTimingResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_browser_timing_result_py3.EventsBrowserTimingResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_result_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_result_py3.yml new file mode 100644 index 00000000..d7e9c377 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_browser_timing_result_py3 +name: events_browser_timing_result_py3 +fullName: azure.applicationinsights.models.events_browser_timing_result_py3 +classes: +- azure.applicationinsights.models.events_browser_timing_result_py3.EventsBrowserTimingResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_info.EventsClientInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_info.EventsClientInfo.yml new file mode 100644 index 00000000..2040a710 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_info.EventsClientInfo.yml @@ -0,0 +1,155 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_client_info.EventsClientInfo +name: EventsClientInfo +fullName: azure.applicationinsights.models.events_client_info.EventsClientInfo +module: azure.applicationinsights.models.events_client_info +summary: Client info for an event result. +constructor: + syntax: EventsClientInfo(**kwargs) + parameters: + - name: model + description: Model of the client + isRequired: true + types: + - + - name: os + description: Operating system of the client + isRequired: true + types: + - + - name: type + description: Type of the client + isRequired: true + types: + - + - name: browser + description: Browser of the client + isRequired: true + types: + - + - name: ip + description: IP address of the client + isRequired: true + types: + - + - name: city + description: City of the client + isRequired: true + types: + - + - name: state_or_province + description: State or province of the client + isRequired: true + types: + - + - name: country_or_region + description: Country or region of the client + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_client_info.EventsClientInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_client_info.EventsClientInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_client_info.EventsClientInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_client_info.EventsClientInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_client_info.EventsClientInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_client_info.EventsClientInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_client_info.EventsClientInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_info.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_info.yml new file mode 100644 index 00000000..0bef94f6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_client_info +name: events_client_info +fullName: azure.applicationinsights.models.events_client_info +classes: +- azure.applicationinsights.models.events_client_info.EventsClientInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_info_py3.EventsClientInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_info_py3.EventsClientInfo.yml new file mode 100644 index 00000000..76f8b706 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_info_py3.EventsClientInfo.yml @@ -0,0 +1,174 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_client_info_py3.EventsClientInfo +name: EventsClientInfo +fullName: azure.applicationinsights.models.events_client_info_py3.EventsClientInfo +module: azure.applicationinsights.models.events_client_info_py3 +summary: Client info for an event result. +constructor: + syntax: 'EventsClientInfo(*, model: str = None, os: str = None, type: str = None, + browser: str = None, ip: str = None, city: str = None, state_or_province: str + = None, country_or_region: str = None, **kwargs)' + parameters: + - name: model + description: Model of the client + isRequired: true + types: + - + - name: os + description: Operating system of the client + isRequired: true + types: + - + - name: type + description: Type of the client + isRequired: true + types: + - + - name: browser + description: Browser of the client + isRequired: true + types: + - + - name: ip + description: IP address of the client + isRequired: true + types: + - + - name: city + description: City of the client + isRequired: true + types: + - + - name: state_or_province + description: State or province of the client + isRequired: true + types: + - + - name: country_or_region + description: Country or region of the client + isRequired: true + types: + - + keywordOnlyParameters: + - name: model + isRequired: true + - name: os + isRequired: true + - name: type + isRequired: true + - name: browser + isRequired: true + - name: ip + isRequired: true + - name: city + isRequired: true + - name: state_or_province + isRequired: true + - name: country_or_region + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_client_info_py3.EventsClientInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_client_info_py3.EventsClientInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_client_info_py3.EventsClientInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_client_info_py3.EventsClientInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_client_info_py3.EventsClientInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_client_info_py3.EventsClientInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_client_info_py3.EventsClientInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_info_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_info_py3.yml new file mode 100644 index 00000000..a7c4ac3d --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_client_info_py3 +name: events_client_info_py3 +fullName: azure.applicationinsights.models.events_client_info_py3 +classes: +- azure.applicationinsights.models.events_client_info_py3.EventsClientInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_performance_info.EventsClientPerformanceInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_performance_info.EventsClientPerformanceInfo.yml new file mode 100644 index 00000000..8f231c31 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_performance_info.EventsClientPerformanceInfo.yml @@ -0,0 +1,120 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_client_performance_info.EventsClientPerformanceInfo +name: EventsClientPerformanceInfo +fullName: azure.applicationinsights.models.events_client_performance_info.EventsClientPerformanceInfo +module: azure.applicationinsights.models.events_client_performance_info +summary: Client performance information. +constructor: + syntax: EventsClientPerformanceInfo(**kwargs) + parameters: + - name: name + description: The name of the client performance + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_client_performance_info.EventsClientPerformanceInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_client_performance_info.EventsClientPerformanceInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_client_performance_info.EventsClientPerformanceInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_client_performance_info.EventsClientPerformanceInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_client_performance_info.EventsClientPerformanceInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_client_performance_info.EventsClientPerformanceInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_client_performance_info.EventsClientPerformanceInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_performance_info.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_performance_info.yml new file mode 100644 index 00000000..5f7470a7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_performance_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_client_performance_info +name: events_client_performance_info +fullName: azure.applicationinsights.models.events_client_performance_info +classes: +- azure.applicationinsights.models.events_client_performance_info.EventsClientPerformanceInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_performance_info_py3.EventsClientPerformanceInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_performance_info_py3.EventsClientPerformanceInfo.yml new file mode 100644 index 00000000..288a30d9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_performance_info_py3.EventsClientPerformanceInfo.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_client_performance_info_py3.EventsClientPerformanceInfo +name: EventsClientPerformanceInfo +fullName: azure.applicationinsights.models.events_client_performance_info_py3.EventsClientPerformanceInfo +module: azure.applicationinsights.models.events_client_performance_info_py3 +summary: Client performance information. +constructor: + syntax: 'EventsClientPerformanceInfo(*, name: str = None, **kwargs)' + parameters: + - name: name + description: The name of the client performance + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_client_performance_info_py3.EventsClientPerformanceInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_client_performance_info_py3.EventsClientPerformanceInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_client_performance_info_py3.EventsClientPerformanceInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_client_performance_info_py3.EventsClientPerformanceInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_client_performance_info_py3.EventsClientPerformanceInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_client_performance_info_py3.EventsClientPerformanceInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_client_performance_info_py3.EventsClientPerformanceInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_performance_info_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_performance_info_py3.yml new file mode 100644 index 00000000..389fd731 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_performance_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_client_performance_info_py3 +name: events_client_performance_info_py3 +fullName: azure.applicationinsights.models.events_client_performance_info_py3 +classes: +- azure.applicationinsights.models.events_client_performance_info_py3.EventsClientPerformanceInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_cloud_info.EventsCloudInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_cloud_info.EventsCloudInfo.yml new file mode 100644 index 00000000..4d066ad2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_cloud_info.EventsCloudInfo.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_cloud_info.EventsCloudInfo +name: EventsCloudInfo +fullName: azure.applicationinsights.models.events_cloud_info.EventsCloudInfo +module: azure.applicationinsights.models.events_cloud_info +summary: Cloud info for an event result. +constructor: + syntax: EventsCloudInfo(**kwargs) + parameters: + - name: role_name + description: Role name of the cloud + isRequired: true + types: + - + - name: role_instance + description: Role instance of the cloud + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_cloud_info.EventsCloudInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_cloud_info.EventsCloudInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_cloud_info.EventsCloudInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_cloud_info.EventsCloudInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_cloud_info.EventsCloudInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_cloud_info.EventsCloudInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_cloud_info.EventsCloudInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_cloud_info.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_cloud_info.yml new file mode 100644 index 00000000..d8227dcd --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_cloud_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_cloud_info +name: events_cloud_info +fullName: azure.applicationinsights.models.events_cloud_info +classes: +- azure.applicationinsights.models.events_cloud_info.EventsCloudInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_cloud_info_py3.EventsCloudInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_cloud_info_py3.EventsCloudInfo.yml new file mode 100644 index 00000000..b1ffe28f --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_cloud_info_py3.EventsCloudInfo.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_cloud_info_py3.EventsCloudInfo +name: EventsCloudInfo +fullName: azure.applicationinsights.models.events_cloud_info_py3.EventsCloudInfo +module: azure.applicationinsights.models.events_cloud_info_py3 +summary: Cloud info for an event result. +constructor: + syntax: 'EventsCloudInfo(*, role_name: str = None, role_instance: str = None, **kwargs)' + parameters: + - name: role_name + description: Role name of the cloud + isRequired: true + types: + - + - name: role_instance + description: Role instance of the cloud + isRequired: true + types: + - + keywordOnlyParameters: + - name: role_name + isRequired: true + - name: role_instance + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_cloud_info_py3.EventsCloudInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_cloud_info_py3.EventsCloudInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_cloud_info_py3.EventsCloudInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_cloud_info_py3.EventsCloudInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_cloud_info_py3.EventsCloudInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_cloud_info_py3.EventsCloudInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_cloud_info_py3.EventsCloudInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_cloud_info_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_cloud_info_py3.yml new file mode 100644 index 00000000..d6ed2367 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_cloud_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_cloud_info_py3 +name: events_cloud_info_py3 +fullName: azure.applicationinsights.models.events_cloud_info_py3 +classes: +- azure.applicationinsights.models.events_cloud_info_py3.EventsCloudInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_info.EventsCustomEventInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_info.EventsCustomEventInfo.yml new file mode 100644 index 00000000..b6505cb8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_info.EventsCustomEventInfo.yml @@ -0,0 +1,120 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_custom_event_info.EventsCustomEventInfo +name: EventsCustomEventInfo +fullName: azure.applicationinsights.models.events_custom_event_info.EventsCustomEventInfo +module: azure.applicationinsights.models.events_custom_event_info +summary: The custom event information. +constructor: + syntax: EventsCustomEventInfo(**kwargs) + parameters: + - name: name + description: The name of the custom event + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_custom_event_info.EventsCustomEventInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_custom_event_info.EventsCustomEventInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_custom_event_info.EventsCustomEventInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_custom_event_info.EventsCustomEventInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_custom_event_info.EventsCustomEventInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_custom_event_info.EventsCustomEventInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_custom_event_info.EventsCustomEventInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_info.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_info.yml new file mode 100644 index 00000000..042bd521 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_custom_event_info +name: events_custom_event_info +fullName: azure.applicationinsights.models.events_custom_event_info +classes: +- azure.applicationinsights.models.events_custom_event_info.EventsCustomEventInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_info_py3.EventsCustomEventInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_info_py3.EventsCustomEventInfo.yml new file mode 100644 index 00000000..2454b216 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_info_py3.EventsCustomEventInfo.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_custom_event_info_py3.EventsCustomEventInfo +name: EventsCustomEventInfo +fullName: azure.applicationinsights.models.events_custom_event_info_py3.EventsCustomEventInfo +module: azure.applicationinsights.models.events_custom_event_info_py3 +summary: The custom event information. +constructor: + syntax: 'EventsCustomEventInfo(*, name: str = None, **kwargs)' + parameters: + - name: name + description: The name of the custom event + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_custom_event_info_py3.EventsCustomEventInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_custom_event_info_py3.EventsCustomEventInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_custom_event_info_py3.EventsCustomEventInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_custom_event_info_py3.EventsCustomEventInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_custom_event_info_py3.EventsCustomEventInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_custom_event_info_py3.EventsCustomEventInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_custom_event_info_py3.EventsCustomEventInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_info_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_info_py3.yml new file mode 100644 index 00000000..e99961a3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_custom_event_info_py3 +name: events_custom_event_info_py3 +fullName: azure.applicationinsights.models.events_custom_event_info_py3 +classes: +- azure.applicationinsights.models.events_custom_event_info_py3.EventsCustomEventInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_result.EventsCustomEventResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_result.EventsCustomEventResult.yml new file mode 100644 index 00000000..f95b43dd --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_result.EventsCustomEventResult.yml @@ -0,0 +1,187 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_custom_event_result.EventsCustomEventResult +name: EventsCustomEventResult +fullName: azure.applicationinsights.models.events_custom_event_result.EventsCustomEventResult +module: azure.applicationinsights.models.events_custom_event_result +summary: 'A custom event result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: EventsCustomEventResult(**kwargs) + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: custom_event + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_custom_event_result.EventsCustomEventResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_custom_event_result.EventsCustomEventResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_custom_event_result.EventsCustomEventResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_custom_event_result.EventsCustomEventResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_custom_event_result.EventsCustomEventResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_custom_event_result.EventsCustomEventResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_custom_event_result.EventsCustomEventResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_result.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_result.yml new file mode 100644 index 00000000..a5d2d5e9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_custom_event_result +name: events_custom_event_result +fullName: azure.applicationinsights.models.events_custom_event_result +classes: +- azure.applicationinsights.models.events_custom_event_result.EventsCustomEventResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_result_py3.EventsCustomEventResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_result_py3.EventsCustomEventResult.yml new file mode 100644 index 00000000..4d1e0ea7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_result_py3.EventsCustomEventResult.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_custom_event_result_py3.EventsCustomEventResult +name: EventsCustomEventResult +fullName: azure.applicationinsights.models.events_custom_event_result_py3.EventsCustomEventResult +module: azure.applicationinsights.models.events_custom_event_result_py3 +summary: 'A custom event result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EventsCustomEventResult(*, id: str = None, count: int = None, timestamp=None, + custom_dimensions=None, custom_measurements=None, operation=None, session=None, + user=None, cloud=None, ai=None, application=None, client=None, custom_event=None, + **kwargs)' + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: custom_event + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: count + isRequired: true + - name: timestamp + isRequired: true + - name: custom_dimensions + isRequired: true + - name: custom_measurements + isRequired: true + - name: operation + isRequired: true + - name: session + isRequired: true + - name: user + isRequired: true + - name: cloud + isRequired: true + - name: ai + isRequired: true + - name: application + isRequired: true + - name: client + isRequired: true + - name: custom_event + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_custom_event_result_py3.EventsCustomEventResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_custom_event_result_py3.EventsCustomEventResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_custom_event_result_py3.EventsCustomEventResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_custom_event_result_py3.EventsCustomEventResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_custom_event_result_py3.EventsCustomEventResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_custom_event_result_py3.EventsCustomEventResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_custom_event_result_py3.EventsCustomEventResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_result_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_result_py3.yml new file mode 100644 index 00000000..0e6b7208 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_custom_event_result_py3 +name: events_custom_event_result_py3 +fullName: azure.applicationinsights.models.events_custom_event_result_py3 +classes: +- azure.applicationinsights.models.events_custom_event_result_py3.EventsCustomEventResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_info.EventsCustomMetricInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_info.EventsCustomMetricInfo.yml new file mode 100644 index 00000000..f8c2d110 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_info.EventsCustomMetricInfo.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_custom_metric_info.EventsCustomMetricInfo +name: EventsCustomMetricInfo +fullName: azure.applicationinsights.models.events_custom_metric_info.EventsCustomMetricInfo +module: azure.applicationinsights.models.events_custom_metric_info +summary: The custom metric info. +constructor: + syntax: EventsCustomMetricInfo(**kwargs) + parameters: + - name: name + description: The name of the custom metric + isRequired: true + types: + - + - name: value + description: The value of the custom metric + isRequired: true + types: + - + - name: value_sum + description: The sum of the custom metric + isRequired: true + types: + - + - name: value_count + description: The count of the custom metric + isRequired: true + types: + - + - name: value_min + description: The minimum value of the custom metric + isRequired: true + types: + - + - name: value_max + description: The maximum value of the custom metric + isRequired: true + types: + - + - name: value_std_dev + description: The standard deviation of the custom metric + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_custom_metric_info.EventsCustomMetricInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_custom_metric_info.EventsCustomMetricInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_custom_metric_info.EventsCustomMetricInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_custom_metric_info.EventsCustomMetricInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_custom_metric_info.EventsCustomMetricInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_custom_metric_info.EventsCustomMetricInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_custom_metric_info.EventsCustomMetricInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_info.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_info.yml new file mode 100644 index 00000000..955c1638 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_custom_metric_info +name: events_custom_metric_info +fullName: azure.applicationinsights.models.events_custom_metric_info +classes: +- azure.applicationinsights.models.events_custom_metric_info.EventsCustomMetricInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_info_py3.EventsCustomMetricInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_info_py3.EventsCustomMetricInfo.yml new file mode 100644 index 00000000..20b3b6b0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_info_py3.EventsCustomMetricInfo.yml @@ -0,0 +1,167 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_custom_metric_info_py3.EventsCustomMetricInfo +name: EventsCustomMetricInfo +fullName: azure.applicationinsights.models.events_custom_metric_info_py3.EventsCustomMetricInfo +module: azure.applicationinsights.models.events_custom_metric_info_py3 +summary: The custom metric info. +constructor: + syntax: 'EventsCustomMetricInfo(*, name: str = None, value: float = None, value_sum: + float = None, value_count: int = None, value_min: float = None, value_max: float + = None, value_std_dev: float = None, **kwargs)' + parameters: + - name: name + description: The name of the custom metric + isRequired: true + types: + - + - name: value + description: The value of the custom metric + isRequired: true + types: + - + - name: value_sum + description: The sum of the custom metric + isRequired: true + types: + - + - name: value_count + description: The count of the custom metric + isRequired: true + types: + - + - name: value_min + description: The minimum value of the custom metric + isRequired: true + types: + - + - name: value_max + description: The maximum value of the custom metric + isRequired: true + types: + - + - name: value_std_dev + description: The standard deviation of the custom metric + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: value + isRequired: true + - name: value_sum + isRequired: true + - name: value_count + isRequired: true + - name: value_min + isRequired: true + - name: value_max + isRequired: true + - name: value_std_dev + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_custom_metric_info_py3.EventsCustomMetricInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_custom_metric_info_py3.EventsCustomMetricInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_custom_metric_info_py3.EventsCustomMetricInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_custom_metric_info_py3.EventsCustomMetricInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_custom_metric_info_py3.EventsCustomMetricInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_custom_metric_info_py3.EventsCustomMetricInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_custom_metric_info_py3.EventsCustomMetricInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_info_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_info_py3.yml new file mode 100644 index 00000000..e834bf5c --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_custom_metric_info_py3 +name: events_custom_metric_info_py3 +fullName: azure.applicationinsights.models.events_custom_metric_info_py3 +classes: +- azure.applicationinsights.models.events_custom_metric_info_py3.EventsCustomMetricInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_result.EventsCustomMetricResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_result.EventsCustomMetricResult.yml new file mode 100644 index 00000000..799462f1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_result.EventsCustomMetricResult.yml @@ -0,0 +1,187 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_custom_metric_result.EventsCustomMetricResult +name: EventsCustomMetricResult +fullName: azure.applicationinsights.models.events_custom_metric_result.EventsCustomMetricResult +module: azure.applicationinsights.models.events_custom_metric_result +summary: 'A custom metric result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: EventsCustomMetricResult(**kwargs) + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: custom_metric + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_custom_metric_result.EventsCustomMetricResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_custom_metric_result.EventsCustomMetricResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_custom_metric_result.EventsCustomMetricResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_custom_metric_result.EventsCustomMetricResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_custom_metric_result.EventsCustomMetricResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_custom_metric_result.EventsCustomMetricResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_custom_metric_result.EventsCustomMetricResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_result.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_result.yml new file mode 100644 index 00000000..477dfb91 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_custom_metric_result +name: events_custom_metric_result +fullName: azure.applicationinsights.models.events_custom_metric_result +classes: +- azure.applicationinsights.models.events_custom_metric_result.EventsCustomMetricResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_result_py3.EventsCustomMetricResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_result_py3.EventsCustomMetricResult.yml new file mode 100644 index 00000000..aa57acc4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_result_py3.EventsCustomMetricResult.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_custom_metric_result_py3.EventsCustomMetricResult +name: EventsCustomMetricResult +fullName: azure.applicationinsights.models.events_custom_metric_result_py3.EventsCustomMetricResult +module: azure.applicationinsights.models.events_custom_metric_result_py3 +summary: 'A custom metric result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EventsCustomMetricResult(*, id: str = None, count: int = None, timestamp=None, + custom_dimensions=None, custom_measurements=None, operation=None, session=None, + user=None, cloud=None, ai=None, application=None, client=None, custom_metric=None, + **kwargs)' + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: custom_metric + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: count + isRequired: true + - name: timestamp + isRequired: true + - name: custom_dimensions + isRequired: true + - name: custom_measurements + isRequired: true + - name: operation + isRequired: true + - name: session + isRequired: true + - name: user + isRequired: true + - name: cloud + isRequired: true + - name: ai + isRequired: true + - name: application + isRequired: true + - name: client + isRequired: true + - name: custom_metric + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_custom_metric_result_py3.EventsCustomMetricResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_custom_metric_result_py3.EventsCustomMetricResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_custom_metric_result_py3.EventsCustomMetricResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_custom_metric_result_py3.EventsCustomMetricResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_custom_metric_result_py3.EventsCustomMetricResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_custom_metric_result_py3.EventsCustomMetricResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_custom_metric_result_py3.EventsCustomMetricResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_result_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_result_py3.yml new file mode 100644 index 00000000..de8af44a --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_custom_metric_result_py3 +name: events_custom_metric_result_py3 +fullName: azure.applicationinsights.models.events_custom_metric_result_py3 +classes: +- azure.applicationinsights.models.events_custom_metric_result_py3.EventsCustomMetricResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_info.EventsDependencyInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_info.EventsDependencyInfo.yml new file mode 100644 index 00000000..27bdb059 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_info.EventsDependencyInfo.yml @@ -0,0 +1,160 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_dependency_info.EventsDependencyInfo +name: EventsDependencyInfo +fullName: azure.applicationinsights.models.events_dependency_info.EventsDependencyInfo +module: azure.applicationinsights.models.events_dependency_info +summary: The dependency info. +constructor: + syntax: EventsDependencyInfo(**kwargs) + parameters: + - name: target + description: The target of the dependency + isRequired: true + types: + - + - name: data + description: The data of the dependency + isRequired: true + types: + - + - name: success + description: Indicates if the dependency was successful + isRequired: true + types: + - + - name: duration + description: The duration of the dependency + isRequired: true + types: + - + - name: performance_bucket + description: The performance bucket of the dependency + isRequired: true + types: + - + - name: result_code + description: The result code of the dependency + isRequired: true + types: + - + - name: type + description: The type of the dependency + isRequired: true + types: + - + - name: name + description: The name of the dependency + isRequired: true + types: + - + - name: id + description: The ID of the dependency + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_dependency_info.EventsDependencyInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_dependency_info.EventsDependencyInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_dependency_info.EventsDependencyInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_dependency_info.EventsDependencyInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_dependency_info.EventsDependencyInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_dependency_info.EventsDependencyInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_dependency_info.EventsDependencyInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_info.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_info.yml new file mode 100644 index 00000000..932f465b --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_dependency_info +name: events_dependency_info +fullName: azure.applicationinsights.models.events_dependency_info +classes: +- azure.applicationinsights.models.events_dependency_info.EventsDependencyInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_info_py3.EventsDependencyInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_info_py3.EventsDependencyInfo.yml new file mode 100644 index 00000000..986c979c --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_info_py3.EventsDependencyInfo.yml @@ -0,0 +1,181 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_dependency_info_py3.EventsDependencyInfo +name: EventsDependencyInfo +fullName: azure.applicationinsights.models.events_dependency_info_py3.EventsDependencyInfo +module: azure.applicationinsights.models.events_dependency_info_py3 +summary: The dependency info. +constructor: + syntax: 'EventsDependencyInfo(*, target: str = None, data: str = None, success: + str = None, duration: int = None, performance_bucket: str = None, result_code: + str = None, type: str = None, name: str = None, id: str = None, **kwargs)' + parameters: + - name: target + description: The target of the dependency + isRequired: true + types: + - + - name: data + description: The data of the dependency + isRequired: true + types: + - + - name: success + description: Indicates if the dependency was successful + isRequired: true + types: + - + - name: duration + description: The duration of the dependency + isRequired: true + types: + - + - name: performance_bucket + description: The performance bucket of the dependency + isRequired: true + types: + - + - name: result_code + description: The result code of the dependency + isRequired: true + types: + - + - name: type + description: The type of the dependency + isRequired: true + types: + - + - name: name + description: The name of the dependency + isRequired: true + types: + - + - name: id + description: The ID of the dependency + isRequired: true + types: + - + keywordOnlyParameters: + - name: target + isRequired: true + - name: data + isRequired: true + - name: success + isRequired: true + - name: duration + isRequired: true + - name: performance_bucket + isRequired: true + - name: result_code + isRequired: true + - name: type + isRequired: true + - name: name + isRequired: true + - name: id + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_dependency_info_py3.EventsDependencyInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_dependency_info_py3.EventsDependencyInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_dependency_info_py3.EventsDependencyInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_dependency_info_py3.EventsDependencyInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_dependency_info_py3.EventsDependencyInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_dependency_info_py3.EventsDependencyInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_dependency_info_py3.EventsDependencyInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_info_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_info_py3.yml new file mode 100644 index 00000000..c3358f86 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_dependency_info_py3 +name: events_dependency_info_py3 +fullName: azure.applicationinsights.models.events_dependency_info_py3 +classes: +- azure.applicationinsights.models.events_dependency_info_py3.EventsDependencyInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_result.EventsDependencyResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_result.EventsDependencyResult.yml new file mode 100644 index 00000000..876cf6cc --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_result.EventsDependencyResult.yml @@ -0,0 +1,187 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_dependency_result.EventsDependencyResult +name: EventsDependencyResult +fullName: azure.applicationinsights.models.events_dependency_result.EventsDependencyResult +module: azure.applicationinsights.models.events_dependency_result +summary: 'A dependency result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: EventsDependencyResult(**kwargs) + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: dependency + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_dependency_result.EventsDependencyResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_dependency_result.EventsDependencyResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_dependency_result.EventsDependencyResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_dependency_result.EventsDependencyResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_dependency_result.EventsDependencyResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_dependency_result.EventsDependencyResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_dependency_result.EventsDependencyResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_result.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_result.yml new file mode 100644 index 00000000..4d3e5cdd --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_dependency_result +name: events_dependency_result +fullName: azure.applicationinsights.models.events_dependency_result +classes: +- azure.applicationinsights.models.events_dependency_result.EventsDependencyResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_result_py3.EventsDependencyResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_result_py3.EventsDependencyResult.yml new file mode 100644 index 00000000..a666351a --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_result_py3.EventsDependencyResult.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_dependency_result_py3.EventsDependencyResult +name: EventsDependencyResult +fullName: azure.applicationinsights.models.events_dependency_result_py3.EventsDependencyResult +module: azure.applicationinsights.models.events_dependency_result_py3 +summary: 'A dependency result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EventsDependencyResult(*, id: str = None, count: int = None, timestamp=None, + custom_dimensions=None, custom_measurements=None, operation=None, session=None, + user=None, cloud=None, ai=None, application=None, client=None, dependency=None, + **kwargs)' + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: dependency + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: count + isRequired: true + - name: timestamp + isRequired: true + - name: custom_dimensions + isRequired: true + - name: custom_measurements + isRequired: true + - name: operation + isRequired: true + - name: session + isRequired: true + - name: user + isRequired: true + - name: cloud + isRequired: true + - name: ai + isRequired: true + - name: application + isRequired: true + - name: client + isRequired: true + - name: dependency + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_dependency_result_py3.EventsDependencyResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_dependency_result_py3.EventsDependencyResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_dependency_result_py3.EventsDependencyResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_dependency_result_py3.EventsDependencyResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_dependency_result_py3.EventsDependencyResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_dependency_result_py3.EventsDependencyResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_dependency_result_py3.EventsDependencyResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_result_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_result_py3.yml new file mode 100644 index 00000000..a9129f5d --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_dependency_result_py3 +name: events_dependency_result_py3 +fullName: azure.applicationinsights.models.events_dependency_result_py3 +classes: +- azure.applicationinsights.models.events_dependency_result_py3.EventsDependencyResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_detail.EventsExceptionDetail.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_detail.EventsExceptionDetail.yml new file mode 100644 index 00000000..eafcdd76 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_detail.EventsExceptionDetail.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_exception_detail.EventsExceptionDetail +name: EventsExceptionDetail +fullName: azure.applicationinsights.models.events_exception_detail.EventsExceptionDetail +module: azure.applicationinsights.models.events_exception_detail +summary: Exception details. +constructor: + syntax: EventsExceptionDetail(**kwargs) + parameters: + - name: severity_level + description: The severity level of the exception detail + isRequired: true + types: + - + - name: outer_id + description: The outer ID of the exception detail + isRequired: true + types: + - + - name: message + description: The message of the exception detail + isRequired: true + types: + - + - name: type + description: The type of the exception detail + isRequired: true + types: + - + - name: id + description: The ID of the exception detail + isRequired: true + types: + - + - name: parsed_stack + description: The parsed stack + isRequired: true + types: + - [] +methods: +- uid: azure.applicationinsights.models.events_exception_detail.EventsExceptionDetail.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_exception_detail.EventsExceptionDetail.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_exception_detail.EventsExceptionDetail.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_exception_detail.EventsExceptionDetail.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_exception_detail.EventsExceptionDetail.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_exception_detail.EventsExceptionDetail.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_exception_detail.EventsExceptionDetail.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_detail.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_detail.yml new file mode 100644 index 00000000..08dd305f --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_detail.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_exception_detail +name: events_exception_detail +fullName: azure.applicationinsights.models.events_exception_detail +classes: +- azure.applicationinsights.models.events_exception_detail.EventsExceptionDetail diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_detail_py3.EventsExceptionDetail.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_detail_py3.EventsExceptionDetail.yml new file mode 100644 index 00000000..dc640770 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_detail_py3.EventsExceptionDetail.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_exception_detail_py3.EventsExceptionDetail +name: EventsExceptionDetail +fullName: azure.applicationinsights.models.events_exception_detail_py3.EventsExceptionDetail +module: azure.applicationinsights.models.events_exception_detail_py3 +summary: Exception details. +constructor: + syntax: 'EventsExceptionDetail(*, severity_level: str = None, outer_id: str = None, + message: str = None, type: str = None, id: str = None, parsed_stack=None, **kwargs)' + parameters: + - name: severity_level + description: The severity level of the exception detail + isRequired: true + types: + - + - name: outer_id + description: The outer ID of the exception detail + isRequired: true + types: + - + - name: message + description: The message of the exception detail + isRequired: true + types: + - + - name: type + description: The type of the exception detail + isRequired: true + types: + - + - name: id + description: The ID of the exception detail + isRequired: true + types: + - + - name: parsed_stack + description: The parsed stack + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: severity_level + isRequired: true + - name: outer_id + isRequired: true + - name: message + isRequired: true + - name: type + isRequired: true + - name: id + isRequired: true + - name: parsed_stack + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_exception_detail_py3.EventsExceptionDetail.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_exception_detail_py3.EventsExceptionDetail.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_exception_detail_py3.EventsExceptionDetail.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_exception_detail_py3.EventsExceptionDetail.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_exception_detail_py3.EventsExceptionDetail.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_exception_detail_py3.EventsExceptionDetail.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_exception_detail_py3.EventsExceptionDetail.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_detail_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_detail_py3.yml new file mode 100644 index 00000000..1346ebbe --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_detail_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_exception_detail_py3 +name: events_exception_detail_py3 +fullName: azure.applicationinsights.models.events_exception_detail_py3 +classes: +- azure.applicationinsights.models.events_exception_detail_py3.EventsExceptionDetail diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_details_parsed_stack.EventsExceptionDetailsParsedStack.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_details_parsed_stack.EventsExceptionDetailsParsedStack.yml new file mode 100644 index 00000000..29beba8a --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_details_parsed_stack.EventsExceptionDetailsParsedStack.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_exception_details_parsed_stack.EventsExceptionDetailsParsedStack +name: EventsExceptionDetailsParsedStack +fullName: azure.applicationinsights.models.events_exception_details_parsed_stack.EventsExceptionDetailsParsedStack +module: azure.applicationinsights.models.events_exception_details_parsed_stack +summary: A parsed stack entry. +constructor: + syntax: EventsExceptionDetailsParsedStack(**kwargs) + parameters: + - name: assembly + description: The assembly of the stack entry + isRequired: true + types: + - + - name: method + description: The method of the stack entry + isRequired: true + types: + - + - name: level + description: The level of the stack entry + isRequired: true + types: + - + - name: line + description: The line of the stack entry + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_exception_details_parsed_stack.EventsExceptionDetailsParsedStack.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_exception_details_parsed_stack.EventsExceptionDetailsParsedStack.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_exception_details_parsed_stack.EventsExceptionDetailsParsedStack.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_exception_details_parsed_stack.EventsExceptionDetailsParsedStack.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_exception_details_parsed_stack.EventsExceptionDetailsParsedStack.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_exception_details_parsed_stack.EventsExceptionDetailsParsedStack.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_exception_details_parsed_stack.EventsExceptionDetailsParsedStack.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_details_parsed_stack.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_details_parsed_stack.yml new file mode 100644 index 00000000..9beef2f7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_details_parsed_stack.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_exception_details_parsed_stack +name: events_exception_details_parsed_stack +fullName: azure.applicationinsights.models.events_exception_details_parsed_stack +classes: +- azure.applicationinsights.models.events_exception_details_parsed_stack.EventsExceptionDetailsParsedStack diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_details_parsed_stack_py3.EventsExceptionDetailsParsedStack.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_details_parsed_stack_py3.EventsExceptionDetailsParsedStack.yml new file mode 100644 index 00000000..b5bc52b1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_details_parsed_stack_py3.EventsExceptionDetailsParsedStack.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_exception_details_parsed_stack_py3.EventsExceptionDetailsParsedStack +name: EventsExceptionDetailsParsedStack +fullName: azure.applicationinsights.models.events_exception_details_parsed_stack_py3.EventsExceptionDetailsParsedStack +module: azure.applicationinsights.models.events_exception_details_parsed_stack_py3 +summary: A parsed stack entry. +constructor: + syntax: 'EventsExceptionDetailsParsedStack(*, assembly: str = None, method: str + = None, level: int = None, line: int = None, **kwargs)' + parameters: + - name: assembly + description: The assembly of the stack entry + isRequired: true + types: + - + - name: method + description: The method of the stack entry + isRequired: true + types: + - + - name: level + description: The level of the stack entry + isRequired: true + types: + - + - name: line + description: The line of the stack entry + isRequired: true + types: + - + keywordOnlyParameters: + - name: assembly + isRequired: true + - name: method + isRequired: true + - name: level + isRequired: true + - name: line + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_exception_details_parsed_stack_py3.EventsExceptionDetailsParsedStack.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_exception_details_parsed_stack_py3.EventsExceptionDetailsParsedStack.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_exception_details_parsed_stack_py3.EventsExceptionDetailsParsedStack.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_exception_details_parsed_stack_py3.EventsExceptionDetailsParsedStack.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_exception_details_parsed_stack_py3.EventsExceptionDetailsParsedStack.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_exception_details_parsed_stack_py3.EventsExceptionDetailsParsedStack.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_exception_details_parsed_stack_py3.EventsExceptionDetailsParsedStack.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_details_parsed_stack_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_details_parsed_stack_py3.yml new file mode 100644 index 00000000..2b610d2f --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_details_parsed_stack_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_exception_details_parsed_stack_py3 +name: events_exception_details_parsed_stack_py3 +fullName: azure.applicationinsights.models.events_exception_details_parsed_stack_py3 +classes: +- azure.applicationinsights.models.events_exception_details_parsed_stack_py3.EventsExceptionDetailsParsedStack diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_info.EventsExceptionInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_info.EventsExceptionInfo.yml new file mode 100644 index 00000000..528e064c --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_info.EventsExceptionInfo.yml @@ -0,0 +1,195 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_exception_info.EventsExceptionInfo +name: EventsExceptionInfo +fullName: azure.applicationinsights.models.events_exception_info.EventsExceptionInfo +module: azure.applicationinsights.models.events_exception_info +summary: The exception info. +constructor: + syntax: EventsExceptionInfo(**kwargs) + parameters: + - name: severity_level + description: The severity level of the exception + isRequired: true + types: + - + - name: problem_id + description: The problem ID of the exception + isRequired: true + types: + - + - name: handled_at + description: Indicates where the exception was handled at + isRequired: true + types: + - + - name: assembly + description: The assembly which threw the exception + isRequired: true + types: + - + - name: method + description: The method that threw the exception + isRequired: true + types: + - + - name: message + description: The message of the exception + isRequired: true + types: + - + - name: type + description: The type of the exception + isRequired: true + types: + - + - name: outer_type + description: The outer type of the exception + isRequired: true + types: + - + - name: outer_method + description: The outer method of the exception + isRequired: true + types: + - + - name: outer_assembly + description: The outer assmebly of the exception + isRequired: true + types: + - + - name: outer_message + description: The outer message of the exception + isRequired: true + types: + - + - name: innermost_type + description: The inner most type of the exception + isRequired: true + types: + - + - name: innermost_message + description: The inner most message of the exception + isRequired: true + types: + - + - name: innermost_method + description: The inner most method of the exception + isRequired: true + types: + - + - name: innermost_assembly + description: The inner most assembly of the exception + isRequired: true + types: + - + - name: details + description: The details of the exception + isRequired: true + types: + - [] +methods: +- uid: azure.applicationinsights.models.events_exception_info.EventsExceptionInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_exception_info.EventsExceptionInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_exception_info.EventsExceptionInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_exception_info.EventsExceptionInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_exception_info.EventsExceptionInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_exception_info.EventsExceptionInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_exception_info.EventsExceptionInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_info.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_info.yml new file mode 100644 index 00000000..13a6469b --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_exception_info +name: events_exception_info +fullName: azure.applicationinsights.models.events_exception_info +classes: +- azure.applicationinsights.models.events_exception_info.EventsExceptionInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_info_py3.EventsExceptionInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_info_py3.EventsExceptionInfo.yml new file mode 100644 index 00000000..fc620c6c --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_info_py3.EventsExceptionInfo.yml @@ -0,0 +1,233 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_exception_info_py3.EventsExceptionInfo +name: EventsExceptionInfo +fullName: azure.applicationinsights.models.events_exception_info_py3.EventsExceptionInfo +module: azure.applicationinsights.models.events_exception_info_py3 +summary: The exception info. +constructor: + syntax: 'EventsExceptionInfo(*, severity_level: int = None, problem_id: str = None, + handled_at: str = None, assembly: str = None, method: str = None, message: str + = None, type: str = None, outer_type: str = None, outer_method: str = None, outer_assembly: + str = None, outer_message: str = None, innermost_type: str = None, innermost_message: + str = None, innermost_method: str = None, innermost_assembly: str = None, details=None, + **kwargs)' + parameters: + - name: severity_level + description: The severity level of the exception + isRequired: true + types: + - + - name: problem_id + description: The problem ID of the exception + isRequired: true + types: + - + - name: handled_at + description: Indicates where the exception was handled at + isRequired: true + types: + - + - name: assembly + description: The assembly which threw the exception + isRequired: true + types: + - + - name: method + description: The method that threw the exception + isRequired: true + types: + - + - name: message + description: The message of the exception + isRequired: true + types: + - + - name: type + description: The type of the exception + isRequired: true + types: + - + - name: outer_type + description: The outer type of the exception + isRequired: true + types: + - + - name: outer_method + description: The outer method of the exception + isRequired: true + types: + - + - name: outer_assembly + description: The outer assmebly of the exception + isRequired: true + types: + - + - name: outer_message + description: The outer message of the exception + isRequired: true + types: + - + - name: innermost_type + description: The inner most type of the exception + isRequired: true + types: + - + - name: innermost_message + description: The inner most message of the exception + isRequired: true + types: + - + - name: innermost_method + description: The inner most method of the exception + isRequired: true + types: + - + - name: innermost_assembly + description: The inner most assembly of the exception + isRequired: true + types: + - + - name: details + description: The details of the exception + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: severity_level + isRequired: true + - name: problem_id + isRequired: true + - name: handled_at + isRequired: true + - name: assembly + isRequired: true + - name: method + isRequired: true + - name: message + isRequired: true + - name: type + isRequired: true + - name: outer_type + isRequired: true + - name: outer_method + isRequired: true + - name: outer_assembly + isRequired: true + - name: outer_message + isRequired: true + - name: innermost_type + isRequired: true + - name: innermost_message + isRequired: true + - name: innermost_method + isRequired: true + - name: innermost_assembly + isRequired: true + - name: details + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_exception_info_py3.EventsExceptionInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_exception_info_py3.EventsExceptionInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_exception_info_py3.EventsExceptionInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_exception_info_py3.EventsExceptionInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_exception_info_py3.EventsExceptionInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_exception_info_py3.EventsExceptionInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_exception_info_py3.EventsExceptionInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_info_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_info_py3.yml new file mode 100644 index 00000000..4cc70ee5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_exception_info_py3 +name: events_exception_info_py3 +fullName: azure.applicationinsights.models.events_exception_info_py3 +classes: +- azure.applicationinsights.models.events_exception_info_py3.EventsExceptionInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_result.EventsExceptionResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_result.EventsExceptionResult.yml new file mode 100644 index 00000000..11a346b0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_result.EventsExceptionResult.yml @@ -0,0 +1,187 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_exception_result.EventsExceptionResult +name: EventsExceptionResult +fullName: azure.applicationinsights.models.events_exception_result.EventsExceptionResult +module: azure.applicationinsights.models.events_exception_result +summary: 'An exception result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: EventsExceptionResult(**kwargs) + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: exception + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_exception_result.EventsExceptionResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_exception_result.EventsExceptionResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_exception_result.EventsExceptionResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_exception_result.EventsExceptionResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_exception_result.EventsExceptionResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_exception_result.EventsExceptionResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_exception_result.EventsExceptionResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_result.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_result.yml new file mode 100644 index 00000000..337b9f44 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_exception_result +name: events_exception_result +fullName: azure.applicationinsights.models.events_exception_result +classes: +- azure.applicationinsights.models.events_exception_result.EventsExceptionResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_result_py3.EventsExceptionResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_result_py3.EventsExceptionResult.yml new file mode 100644 index 00000000..e8560ad2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_result_py3.EventsExceptionResult.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_exception_result_py3.EventsExceptionResult +name: EventsExceptionResult +fullName: azure.applicationinsights.models.events_exception_result_py3.EventsExceptionResult +module: azure.applicationinsights.models.events_exception_result_py3 +summary: 'An exception result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EventsExceptionResult(*, id: str = None, count: int = None, timestamp=None, + custom_dimensions=None, custom_measurements=None, operation=None, session=None, + user=None, cloud=None, ai=None, application=None, client=None, exception=None, + **kwargs)' + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: exception + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: count + isRequired: true + - name: timestamp + isRequired: true + - name: custom_dimensions + isRequired: true + - name: custom_measurements + isRequired: true + - name: operation + isRequired: true + - name: session + isRequired: true + - name: user + isRequired: true + - name: cloud + isRequired: true + - name: ai + isRequired: true + - name: application + isRequired: true + - name: client + isRequired: true + - name: exception + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_exception_result_py3.EventsExceptionResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_exception_result_py3.EventsExceptionResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_exception_result_py3.EventsExceptionResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_exception_result_py3.EventsExceptionResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_exception_result_py3.EventsExceptionResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_exception_result_py3.EventsExceptionResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_exception_result_py3.EventsExceptionResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_result_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_result_py3.yml new file mode 100644 index 00000000..7b0e98ad --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_exception_result_py3 +name: events_exception_result_py3 +fullName: azure.applicationinsights.models.events_exception_result_py3 +classes: +- azure.applicationinsights.models.events_exception_result_py3.EventsExceptionResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_operation_info.EventsOperationInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_operation_info.EventsOperationInfo.yml new file mode 100644 index 00000000..6ff59b76 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_operation_info.EventsOperationInfo.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_operation_info.EventsOperationInfo +name: EventsOperationInfo +fullName: azure.applicationinsights.models.events_operation_info.EventsOperationInfo +module: azure.applicationinsights.models.events_operation_info +summary: Operation info for an event result. +constructor: + syntax: EventsOperationInfo(**kwargs) + parameters: + - name: name + description: Name of the operation + isRequired: true + types: + - + - name: id + description: ID of the operation + isRequired: true + types: + - + - name: parent_id + description: Parent ID of the operation + isRequired: true + types: + - + - name: synthetic_source + description: Synthetic source of the operation + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_operation_info.EventsOperationInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_operation_info.EventsOperationInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_operation_info.EventsOperationInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_operation_info.EventsOperationInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_operation_info.EventsOperationInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_operation_info.EventsOperationInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_operation_info.EventsOperationInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_operation_info.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_operation_info.yml new file mode 100644 index 00000000..197d08d4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_operation_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_operation_info +name: events_operation_info +fullName: azure.applicationinsights.models.events_operation_info +classes: +- azure.applicationinsights.models.events_operation_info.EventsOperationInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_operation_info_py3.EventsOperationInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_operation_info_py3.EventsOperationInfo.yml new file mode 100644 index 00000000..7e96d3af --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_operation_info_py3.EventsOperationInfo.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_operation_info_py3.EventsOperationInfo +name: EventsOperationInfo +fullName: azure.applicationinsights.models.events_operation_info_py3.EventsOperationInfo +module: azure.applicationinsights.models.events_operation_info_py3 +summary: Operation info for an event result. +constructor: + syntax: 'EventsOperationInfo(*, name: str = None, id: str = None, parent_id: str + = None, synthetic_source: str = None, **kwargs)' + parameters: + - name: name + description: Name of the operation + isRequired: true + types: + - + - name: id + description: ID of the operation + isRequired: true + types: + - + - name: parent_id + description: Parent ID of the operation + isRequired: true + types: + - + - name: synthetic_source + description: Synthetic source of the operation + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: id + isRequired: true + - name: parent_id + isRequired: true + - name: synthetic_source + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_operation_info_py3.EventsOperationInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_operation_info_py3.EventsOperationInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_operation_info_py3.EventsOperationInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_operation_info_py3.EventsOperationInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_operation_info_py3.EventsOperationInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_operation_info_py3.EventsOperationInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_operation_info_py3.EventsOperationInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_operation_info_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_operation_info_py3.yml new file mode 100644 index 00000000..ebc719e5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_operation_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_operation_info_py3 +name: events_operation_info_py3 +fullName: azure.applicationinsights.models.events_operation_info_py3 +classes: +- azure.applicationinsights.models.events_operation_info_py3.EventsOperationInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_info.EventsPageViewInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_info.EventsPageViewInfo.yml new file mode 100644 index 00000000..e61848bd --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_info.EventsPageViewInfo.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_page_view_info.EventsPageViewInfo +name: EventsPageViewInfo +fullName: azure.applicationinsights.models.events_page_view_info.EventsPageViewInfo +module: azure.applicationinsights.models.events_page_view_info +summary: The page view information. +constructor: + syntax: EventsPageViewInfo(**kwargs) + parameters: + - name: name + description: The name of the page + isRequired: true + types: + - + - name: url + description: The URL of the page + isRequired: true + types: + - + - name: duration + description: The duration of the page view + isRequired: true + types: + - + - name: performance_bucket + description: The performance bucket of the page view + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_page_view_info.EventsPageViewInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_page_view_info.EventsPageViewInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_page_view_info.EventsPageViewInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_page_view_info.EventsPageViewInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_page_view_info.EventsPageViewInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_page_view_info.EventsPageViewInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_page_view_info.EventsPageViewInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_info.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_info.yml new file mode 100644 index 00000000..f231e4e3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_page_view_info +name: events_page_view_info +fullName: azure.applicationinsights.models.events_page_view_info +classes: +- azure.applicationinsights.models.events_page_view_info.EventsPageViewInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_info_py3.EventsPageViewInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_info_py3.EventsPageViewInfo.yml new file mode 100644 index 00000000..366eb4a7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_info_py3.EventsPageViewInfo.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_page_view_info_py3.EventsPageViewInfo +name: EventsPageViewInfo +fullName: azure.applicationinsights.models.events_page_view_info_py3.EventsPageViewInfo +module: azure.applicationinsights.models.events_page_view_info_py3 +summary: The page view information. +constructor: + syntax: 'EventsPageViewInfo(*, name: str = None, url: str = None, duration: str + = None, performance_bucket: str = None, **kwargs)' + parameters: + - name: name + description: The name of the page + isRequired: true + types: + - + - name: url + description: The URL of the page + isRequired: true + types: + - + - name: duration + description: The duration of the page view + isRequired: true + types: + - + - name: performance_bucket + description: The performance bucket of the page view + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: url + isRequired: true + - name: duration + isRequired: true + - name: performance_bucket + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_page_view_info_py3.EventsPageViewInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_page_view_info_py3.EventsPageViewInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_page_view_info_py3.EventsPageViewInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_page_view_info_py3.EventsPageViewInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_page_view_info_py3.EventsPageViewInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_page_view_info_py3.EventsPageViewInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_page_view_info_py3.EventsPageViewInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_info_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_info_py3.yml new file mode 100644 index 00000000..8c2cdd58 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_page_view_info_py3 +name: events_page_view_info_py3 +fullName: azure.applicationinsights.models.events_page_view_info_py3 +classes: +- azure.applicationinsights.models.events_page_view_info_py3.EventsPageViewInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_result.EventsPageViewResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_result.EventsPageViewResult.yml new file mode 100644 index 00000000..44f6f6e1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_result.EventsPageViewResult.yml @@ -0,0 +1,187 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_page_view_result.EventsPageViewResult +name: EventsPageViewResult +fullName: azure.applicationinsights.models.events_page_view_result.EventsPageViewResult +module: azure.applicationinsights.models.events_page_view_result +summary: 'A page view result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: EventsPageViewResult(**kwargs) + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: page_view + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_page_view_result.EventsPageViewResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_page_view_result.EventsPageViewResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_page_view_result.EventsPageViewResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_page_view_result.EventsPageViewResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_page_view_result.EventsPageViewResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_page_view_result.EventsPageViewResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_page_view_result.EventsPageViewResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_result.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_result.yml new file mode 100644 index 00000000..4013d283 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_page_view_result +name: events_page_view_result +fullName: azure.applicationinsights.models.events_page_view_result +classes: +- azure.applicationinsights.models.events_page_view_result.EventsPageViewResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_result_py3.EventsPageViewResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_result_py3.EventsPageViewResult.yml new file mode 100644 index 00000000..3d9dd076 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_result_py3.EventsPageViewResult.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_page_view_result_py3.EventsPageViewResult +name: EventsPageViewResult +fullName: azure.applicationinsights.models.events_page_view_result_py3.EventsPageViewResult +module: azure.applicationinsights.models.events_page_view_result_py3 +summary: 'A page view result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EventsPageViewResult(*, id: str = None, count: int = None, timestamp=None, + custom_dimensions=None, custom_measurements=None, operation=None, session=None, + user=None, cloud=None, ai=None, application=None, client=None, page_view=None, + **kwargs)' + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: page_view + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: count + isRequired: true + - name: timestamp + isRequired: true + - name: custom_dimensions + isRequired: true + - name: custom_measurements + isRequired: true + - name: operation + isRequired: true + - name: session + isRequired: true + - name: user + isRequired: true + - name: cloud + isRequired: true + - name: ai + isRequired: true + - name: application + isRequired: true + - name: client + isRequired: true + - name: page_view + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_page_view_result_py3.EventsPageViewResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_page_view_result_py3.EventsPageViewResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_page_view_result_py3.EventsPageViewResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_page_view_result_py3.EventsPageViewResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_page_view_result_py3.EventsPageViewResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_page_view_result_py3.EventsPageViewResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_page_view_result_py3.EventsPageViewResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_result_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_result_py3.yml new file mode 100644 index 00000000..3a7e0357 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_page_view_result_py3 +name: events_page_view_result_py3 +fullName: azure.applicationinsights.models.events_page_view_result_py3 +classes: +- azure.applicationinsights.models.events_page_view_result_py3.EventsPageViewResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_info.EventsPerformanceCounterInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_info.EventsPerformanceCounterInfo.yml new file mode 100644 index 00000000..7e0e470b --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_info.EventsPerformanceCounterInfo.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_performance_counter_info.EventsPerformanceCounterInfo +name: EventsPerformanceCounterInfo +fullName: azure.applicationinsights.models.events_performance_counter_info.EventsPerformanceCounterInfo +module: azure.applicationinsights.models.events_performance_counter_info +summary: The performance counter info. +constructor: + syntax: EventsPerformanceCounterInfo(**kwargs) + parameters: + - name: value + description: The value of the performance counter + isRequired: true + types: + - + - name: name + description: The name of the performance counter + isRequired: true + types: + - + - name: category + description: The category of the performance counter + isRequired: true + types: + - + - name: counter + description: The counter of the performance counter + isRequired: true + types: + - + - name: instance_name + description: The instance name of the performance counter + isRequired: true + types: + - + - name: instance + description: The instance of the performance counter + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_performance_counter_info.EventsPerformanceCounterInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_performance_counter_info.EventsPerformanceCounterInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_performance_counter_info.EventsPerformanceCounterInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_performance_counter_info.EventsPerformanceCounterInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_performance_counter_info.EventsPerformanceCounterInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_performance_counter_info.EventsPerformanceCounterInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_performance_counter_info.EventsPerformanceCounterInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_info.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_info.yml new file mode 100644 index 00000000..ad7901cb --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_performance_counter_info +name: events_performance_counter_info +fullName: azure.applicationinsights.models.events_performance_counter_info +classes: +- azure.applicationinsights.models.events_performance_counter_info.EventsPerformanceCounterInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_info_py3.EventsPerformanceCounterInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_info_py3.EventsPerformanceCounterInfo.yml new file mode 100644 index 00000000..f8d4db35 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_info_py3.EventsPerformanceCounterInfo.yml @@ -0,0 +1,160 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_performance_counter_info_py3.EventsPerformanceCounterInfo +name: EventsPerformanceCounterInfo +fullName: azure.applicationinsights.models.events_performance_counter_info_py3.EventsPerformanceCounterInfo +module: azure.applicationinsights.models.events_performance_counter_info_py3 +summary: The performance counter info. +constructor: + syntax: 'EventsPerformanceCounterInfo(*, value: float = None, name: str = None, + category: str = None, counter: str = None, instance_name: str = None, instance: + str = None, **kwargs)' + parameters: + - name: value + description: The value of the performance counter + isRequired: true + types: + - + - name: name + description: The name of the performance counter + isRequired: true + types: + - + - name: category + description: The category of the performance counter + isRequired: true + types: + - + - name: counter + description: The counter of the performance counter + isRequired: true + types: + - + - name: instance_name + description: The instance name of the performance counter + isRequired: true + types: + - + - name: instance + description: The instance of the performance counter + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: name + isRequired: true + - name: category + isRequired: true + - name: counter + isRequired: true + - name: instance_name + isRequired: true + - name: instance + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_performance_counter_info_py3.EventsPerformanceCounterInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_performance_counter_info_py3.EventsPerformanceCounterInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_performance_counter_info_py3.EventsPerformanceCounterInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_performance_counter_info_py3.EventsPerformanceCounterInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_performance_counter_info_py3.EventsPerformanceCounterInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_performance_counter_info_py3.EventsPerformanceCounterInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_performance_counter_info_py3.EventsPerformanceCounterInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_info_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_info_py3.yml new file mode 100644 index 00000000..6041ff77 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_performance_counter_info_py3 +name: events_performance_counter_info_py3 +fullName: azure.applicationinsights.models.events_performance_counter_info_py3 +classes: +- azure.applicationinsights.models.events_performance_counter_info_py3.EventsPerformanceCounterInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_result.EventsPerformanceCounterResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_result.EventsPerformanceCounterResult.yml new file mode 100644 index 00000000..874e8268 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_result.EventsPerformanceCounterResult.yml @@ -0,0 +1,187 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_performance_counter_result.EventsPerformanceCounterResult +name: EventsPerformanceCounterResult +fullName: azure.applicationinsights.models.events_performance_counter_result.EventsPerformanceCounterResult +module: azure.applicationinsights.models.events_performance_counter_result +summary: 'A performance counter result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: EventsPerformanceCounterResult(**kwargs) + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: performance_counter + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_performance_counter_result.EventsPerformanceCounterResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_performance_counter_result.EventsPerformanceCounterResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_performance_counter_result.EventsPerformanceCounterResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_performance_counter_result.EventsPerformanceCounterResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_performance_counter_result.EventsPerformanceCounterResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_performance_counter_result.EventsPerformanceCounterResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_performance_counter_result.EventsPerformanceCounterResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_result.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_result.yml new file mode 100644 index 00000000..0427cf88 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_performance_counter_result +name: events_performance_counter_result +fullName: azure.applicationinsights.models.events_performance_counter_result +classes: +- azure.applicationinsights.models.events_performance_counter_result.EventsPerformanceCounterResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_result_py3.EventsPerformanceCounterResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_result_py3.EventsPerformanceCounterResult.yml new file mode 100644 index 00000000..694c7e32 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_result_py3.EventsPerformanceCounterResult.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_performance_counter_result_py3.EventsPerformanceCounterResult +name: EventsPerformanceCounterResult +fullName: azure.applicationinsights.models.events_performance_counter_result_py3.EventsPerformanceCounterResult +module: azure.applicationinsights.models.events_performance_counter_result_py3 +summary: 'A performance counter result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EventsPerformanceCounterResult(*, id: str = None, count: int = None, timestamp=None, + custom_dimensions=None, custom_measurements=None, operation=None, session=None, + user=None, cloud=None, ai=None, application=None, client=None, performance_counter=None, + **kwargs)' + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: performance_counter + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: count + isRequired: true + - name: timestamp + isRequired: true + - name: custom_dimensions + isRequired: true + - name: custom_measurements + isRequired: true + - name: operation + isRequired: true + - name: session + isRequired: true + - name: user + isRequired: true + - name: cloud + isRequired: true + - name: ai + isRequired: true + - name: application + isRequired: true + - name: client + isRequired: true + - name: performance_counter + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_performance_counter_result_py3.EventsPerformanceCounterResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_performance_counter_result_py3.EventsPerformanceCounterResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_performance_counter_result_py3.EventsPerformanceCounterResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_performance_counter_result_py3.EventsPerformanceCounterResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_performance_counter_result_py3.EventsPerformanceCounterResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_performance_counter_result_py3.EventsPerformanceCounterResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_performance_counter_result_py3.EventsPerformanceCounterResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_result_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_result_py3.yml new file mode 100644 index 00000000..69cf6a82 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_performance_counter_result_py3 +name: events_performance_counter_result_py3 +fullName: azure.applicationinsights.models.events_performance_counter_result_py3 +classes: +- azure.applicationinsights.models.events_performance_counter_result_py3.EventsPerformanceCounterResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_info.EventsRequestInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_info.EventsRequestInfo.yml new file mode 100644 index 00000000..2ef84eae --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_info.EventsRequestInfo.yml @@ -0,0 +1,155 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_request_info.EventsRequestInfo +name: EventsRequestInfo +fullName: azure.applicationinsights.models.events_request_info.EventsRequestInfo +module: azure.applicationinsights.models.events_request_info +summary: The request info. +constructor: + syntax: EventsRequestInfo(**kwargs) + parameters: + - name: name + description: The name of the request + isRequired: true + types: + - + - name: url + description: The URL of the request + isRequired: true + types: + - + - name: success + description: Indicates if the request was successful + isRequired: true + types: + - + - name: duration + description: The duration of the request + isRequired: true + types: + - + - name: performance_bucket + description: The performance bucket of the request + isRequired: true + types: + - + - name: result_code + description: The result code of the request + isRequired: true + types: + - + - name: source + description: The source of the request + isRequired: true + types: + - + - name: id + description: The ID of the request + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_request_info.EventsRequestInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_request_info.EventsRequestInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_request_info.EventsRequestInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_request_info.EventsRequestInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_request_info.EventsRequestInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_request_info.EventsRequestInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_request_info.EventsRequestInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_info.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_info.yml new file mode 100644 index 00000000..deb124da --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_request_info +name: events_request_info +fullName: azure.applicationinsights.models.events_request_info +classes: +- azure.applicationinsights.models.events_request_info.EventsRequestInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_info_py3.EventsRequestInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_info_py3.EventsRequestInfo.yml new file mode 100644 index 00000000..e57159c9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_info_py3.EventsRequestInfo.yml @@ -0,0 +1,174 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_request_info_py3.EventsRequestInfo +name: EventsRequestInfo +fullName: azure.applicationinsights.models.events_request_info_py3.EventsRequestInfo +module: azure.applicationinsights.models.events_request_info_py3 +summary: The request info. +constructor: + syntax: 'EventsRequestInfo(*, name: str = None, url: str = None, success: str = + None, duration: float = None, performance_bucket: str = None, result_code: str + = None, source: str = None, id: str = None, **kwargs)' + parameters: + - name: name + description: The name of the request + isRequired: true + types: + - + - name: url + description: The URL of the request + isRequired: true + types: + - + - name: success + description: Indicates if the request was successful + isRequired: true + types: + - + - name: duration + description: The duration of the request + isRequired: true + types: + - + - name: performance_bucket + description: The performance bucket of the request + isRequired: true + types: + - + - name: result_code + description: The result code of the request + isRequired: true + types: + - + - name: source + description: The source of the request + isRequired: true + types: + - + - name: id + description: The ID of the request + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: url + isRequired: true + - name: success + isRequired: true + - name: duration + isRequired: true + - name: performance_bucket + isRequired: true + - name: result_code + isRequired: true + - name: source + isRequired: true + - name: id + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_request_info_py3.EventsRequestInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_request_info_py3.EventsRequestInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_request_info_py3.EventsRequestInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_request_info_py3.EventsRequestInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_request_info_py3.EventsRequestInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_request_info_py3.EventsRequestInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_request_info_py3.EventsRequestInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_info_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_info_py3.yml new file mode 100644 index 00000000..9e938cb2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_request_info_py3 +name: events_request_info_py3 +fullName: azure.applicationinsights.models.events_request_info_py3 +classes: +- azure.applicationinsights.models.events_request_info_py3.EventsRequestInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_result.EventsRequestResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_result.EventsRequestResult.yml new file mode 100644 index 00000000..8afb7db0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_result.EventsRequestResult.yml @@ -0,0 +1,187 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_request_result.EventsRequestResult +name: EventsRequestResult +fullName: azure.applicationinsights.models.events_request_result.EventsRequestResult +module: azure.applicationinsights.models.events_request_result +summary: 'A request result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: EventsRequestResult(**kwargs) + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: request + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_request_result.EventsRequestResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_request_result.EventsRequestResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_request_result.EventsRequestResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_request_result.EventsRequestResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_request_result.EventsRequestResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_request_result.EventsRequestResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_request_result.EventsRequestResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_result.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_result.yml new file mode 100644 index 00000000..2d21a524 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_request_result +name: events_request_result +fullName: azure.applicationinsights.models.events_request_result +classes: +- azure.applicationinsights.models.events_request_result.EventsRequestResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_result_py3.EventsRequestResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_result_py3.EventsRequestResult.yml new file mode 100644 index 00000000..5ebc41f6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_result_py3.EventsRequestResult.yml @@ -0,0 +1,216 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_request_result_py3.EventsRequestResult +name: EventsRequestResult +fullName: azure.applicationinsights.models.events_request_result_py3.EventsRequestResult +module: azure.applicationinsights.models.events_request_result_py3 +summary: 'A request result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EventsRequestResult(*, id: str = None, count: int = None, timestamp=None, + custom_dimensions=None, custom_measurements=None, operation=None, session=None, + user=None, cloud=None, ai=None, application=None, client=None, request=None, **kwargs)' + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: request + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: count + isRequired: true + - name: timestamp + isRequired: true + - name: custom_dimensions + isRequired: true + - name: custom_measurements + isRequired: true + - name: operation + isRequired: true + - name: session + isRequired: true + - name: user + isRequired: true + - name: cloud + isRequired: true + - name: ai + isRequired: true + - name: application + isRequired: true + - name: client + isRequired: true + - name: request + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_request_result_py3.EventsRequestResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_request_result_py3.EventsRequestResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_request_result_py3.EventsRequestResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_request_result_py3.EventsRequestResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_request_result_py3.EventsRequestResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_request_result_py3.EventsRequestResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_request_result_py3.EventsRequestResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_result_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_result_py3.yml new file mode 100644 index 00000000..7d26e3b2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_request_result_py3 +name: events_request_result_py3 +fullName: azure.applicationinsights.models.events_request_result_py3 +classes: +- azure.applicationinsights.models.events_request_result_py3.EventsRequestResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result.EventsResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result.EventsResult.yml new file mode 100644 index 00000000..e4a258a9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result.EventsResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_result.EventsResult +name: EventsResult +fullName: azure.applicationinsights.models.events_result.EventsResult +module: azure.applicationinsights.models.events_result +summary: An event query result. +constructor: + syntax: EventsResult(**kwargs) + parameters: + - name: aimessages + description: OData messages for this response. + isRequired: true + types: + - [] + - name: value + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_result.EventsResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_result.EventsResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_result.EventsResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_result.EventsResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_result.EventsResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_result.EventsResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_result.EventsResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result.yml new file mode 100644 index 00000000..c96e9342 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_result +name: events_result +fullName: azure.applicationinsights.models.events_result +classes: +- azure.applicationinsights.models.events_result.EventsResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data.EventsResultData.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data.EventsResultData.yml new file mode 100644 index 00000000..3de85616 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data.EventsResultData.yml @@ -0,0 +1,196 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_result_data.EventsResultData +name: EventsResultData +fullName: azure.applicationinsights.models.events_result_data.EventsResultData +module: azure.applicationinsights.models.events_result_data +summary: 'Events query result data. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: EventsTraceResult, EventsCustomEventResult, + + EventsPageViewResult, EventsBrowserTimingResult, EventsRequestResult, + + EventsDependencyResult, EventsExceptionResult, + + EventsAvailabilityResultResult, EventsPerformanceCounterResult, + + EventsCustomMetricResult + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: EventsResultData(**kwargs) + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_result_data.EventsResultData.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_result_data.EventsResultData.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_result_data.EventsResultData.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_result_data.EventsResultData.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_result_data.EventsResultData.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_result_data.EventsResultData.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_result_data.EventsResultData.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data.yml new file mode 100644 index 00000000..6dca2ce6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_result_data +name: events_result_data +fullName: azure.applicationinsights.models.events_result_data +classes: +- azure.applicationinsights.models.events_result_data.EventsResultData diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_dimensions.EventsResultDataCustomDimensions.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_dimensions.EventsResultDataCustomDimensions.yml new file mode 100644 index 00000000..ec4dc077 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_dimensions.EventsResultDataCustomDimensions.yml @@ -0,0 +1,119 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_result_data_custom_dimensions.EventsResultDataCustomDimensions +name: EventsResultDataCustomDimensions +fullName: azure.applicationinsights.models.events_result_data_custom_dimensions.EventsResultDataCustomDimensions +module: azure.applicationinsights.models.events_result_data_custom_dimensions +summary: Custom dimensions of the event. +constructor: + syntax: EventsResultDataCustomDimensions(**kwargs) + parameters: + - name: additional_properties + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_result_data_custom_dimensions.EventsResultDataCustomDimensions.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_result_data_custom_dimensions.EventsResultDataCustomDimensions.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_result_data_custom_dimensions.EventsResultDataCustomDimensions.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_result_data_custom_dimensions.EventsResultDataCustomDimensions.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_result_data_custom_dimensions.EventsResultDataCustomDimensions.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_result_data_custom_dimensions.EventsResultDataCustomDimensions.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_result_data_custom_dimensions.EventsResultDataCustomDimensions.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_dimensions.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_dimensions.yml new file mode 100644 index 00000000..794a4317 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_dimensions.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_result_data_custom_dimensions +name: events_result_data_custom_dimensions +fullName: azure.applicationinsights.models.events_result_data_custom_dimensions +classes: +- azure.applicationinsights.models.events_result_data_custom_dimensions.EventsResultDataCustomDimensions diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_dimensions_py3.EventsResultDataCustomDimensions.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_dimensions_py3.EventsResultDataCustomDimensions.yml new file mode 100644 index 00000000..f34c6fa8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_dimensions_py3.EventsResultDataCustomDimensions.yml @@ -0,0 +1,122 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_result_data_custom_dimensions_py3.EventsResultDataCustomDimensions +name: EventsResultDataCustomDimensions +fullName: azure.applicationinsights.models.events_result_data_custom_dimensions_py3.EventsResultDataCustomDimensions +module: azure.applicationinsights.models.events_result_data_custom_dimensions_py3 +summary: Custom dimensions of the event. +constructor: + syntax: EventsResultDataCustomDimensions(*, additional_properties=None, **kwargs) + parameters: + - name: additional_properties + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_result_data_custom_dimensions_py3.EventsResultDataCustomDimensions.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_result_data_custom_dimensions_py3.EventsResultDataCustomDimensions.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_result_data_custom_dimensions_py3.EventsResultDataCustomDimensions.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_result_data_custom_dimensions_py3.EventsResultDataCustomDimensions.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_result_data_custom_dimensions_py3.EventsResultDataCustomDimensions.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_result_data_custom_dimensions_py3.EventsResultDataCustomDimensions.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_result_data_custom_dimensions_py3.EventsResultDataCustomDimensions.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_dimensions_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_dimensions_py3.yml new file mode 100644 index 00000000..5ced9cd0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_dimensions_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_result_data_custom_dimensions_py3 +name: events_result_data_custom_dimensions_py3 +fullName: azure.applicationinsights.models.events_result_data_custom_dimensions_py3 +classes: +- azure.applicationinsights.models.events_result_data_custom_dimensions_py3.EventsResultDataCustomDimensions diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_measurements.EventsResultDataCustomMeasurements.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_measurements.EventsResultDataCustomMeasurements.yml new file mode 100644 index 00000000..db8cab6f --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_measurements.EventsResultDataCustomMeasurements.yml @@ -0,0 +1,119 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_result_data_custom_measurements.EventsResultDataCustomMeasurements +name: EventsResultDataCustomMeasurements +fullName: azure.applicationinsights.models.events_result_data_custom_measurements.EventsResultDataCustomMeasurements +module: azure.applicationinsights.models.events_result_data_custom_measurements +summary: Custom measurements of the event. +constructor: + syntax: EventsResultDataCustomMeasurements(**kwargs) + parameters: + - name: additional_properties + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_result_data_custom_measurements.EventsResultDataCustomMeasurements.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_result_data_custom_measurements.EventsResultDataCustomMeasurements.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_result_data_custom_measurements.EventsResultDataCustomMeasurements.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_result_data_custom_measurements.EventsResultDataCustomMeasurements.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_result_data_custom_measurements.EventsResultDataCustomMeasurements.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_result_data_custom_measurements.EventsResultDataCustomMeasurements.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_result_data_custom_measurements.EventsResultDataCustomMeasurements.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_measurements.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_measurements.yml new file mode 100644 index 00000000..2b639df4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_measurements.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_result_data_custom_measurements +name: events_result_data_custom_measurements +fullName: azure.applicationinsights.models.events_result_data_custom_measurements +classes: +- azure.applicationinsights.models.events_result_data_custom_measurements.EventsResultDataCustomMeasurements diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_measurements_py3.EventsResultDataCustomMeasurements.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_measurements_py3.EventsResultDataCustomMeasurements.yml new file mode 100644 index 00000000..2cdcc964 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_measurements_py3.EventsResultDataCustomMeasurements.yml @@ -0,0 +1,122 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_result_data_custom_measurements_py3.EventsResultDataCustomMeasurements +name: EventsResultDataCustomMeasurements +fullName: azure.applicationinsights.models.events_result_data_custom_measurements_py3.EventsResultDataCustomMeasurements +module: azure.applicationinsights.models.events_result_data_custom_measurements_py3 +summary: Custom measurements of the event. +constructor: + syntax: EventsResultDataCustomMeasurements(*, additional_properties=None, **kwargs) + parameters: + - name: additional_properties + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_result_data_custom_measurements_py3.EventsResultDataCustomMeasurements.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_result_data_custom_measurements_py3.EventsResultDataCustomMeasurements.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_result_data_custom_measurements_py3.EventsResultDataCustomMeasurements.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_result_data_custom_measurements_py3.EventsResultDataCustomMeasurements.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_result_data_custom_measurements_py3.EventsResultDataCustomMeasurements.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_result_data_custom_measurements_py3.EventsResultDataCustomMeasurements.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_result_data_custom_measurements_py3.EventsResultDataCustomMeasurements.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_measurements_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_measurements_py3.yml new file mode 100644 index 00000000..668e0acc --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_measurements_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_result_data_custom_measurements_py3 +name: events_result_data_custom_measurements_py3 +fullName: azure.applicationinsights.models.events_result_data_custom_measurements_py3 +classes: +- azure.applicationinsights.models.events_result_data_custom_measurements_py3.EventsResultDataCustomMeasurements diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_py3.EventsResultData.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_py3.EventsResultData.yml new file mode 100644 index 00000000..2d3a1612 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_py3.EventsResultData.yml @@ -0,0 +1,223 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_result_data_py3.EventsResultData +name: EventsResultData +fullName: azure.applicationinsights.models.events_result_data_py3.EventsResultData +module: azure.applicationinsights.models.events_result_data_py3 +summary: 'Events query result data. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: EventsTraceResult, EventsCustomEventResult, + + EventsPageViewResult, EventsBrowserTimingResult, EventsRequestResult, + + EventsDependencyResult, EventsExceptionResult, + + EventsAvailabilityResultResult, EventsPerformanceCounterResult, + + EventsCustomMetricResult + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EventsResultData(*, id: str = None, count: int = None, timestamp=None, + custom_dimensions=None, custom_measurements=None, operation=None, session=None, + user=None, cloud=None, ai=None, application=None, client=None, **kwargs)' + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: count + isRequired: true + - name: timestamp + isRequired: true + - name: custom_dimensions + isRequired: true + - name: custom_measurements + isRequired: true + - name: operation + isRequired: true + - name: session + isRequired: true + - name: user + isRequired: true + - name: cloud + isRequired: true + - name: ai + isRequired: true + - name: application + isRequired: true + - name: client + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_result_data_py3.EventsResultData.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_result_data_py3.EventsResultData.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_result_data_py3.EventsResultData.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_result_data_py3.EventsResultData.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_result_data_py3.EventsResultData.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_result_data_py3.EventsResultData.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_result_data_py3.EventsResultData.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_py3.yml new file mode 100644 index 00000000..c1bfdf02 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_result_data_py3 +name: events_result_data_py3 +fullName: azure.applicationinsights.models.events_result_data_py3 +classes: +- azure.applicationinsights.models.events_result_data_py3.EventsResultData diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_py3.EventsResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_py3.EventsResult.yml new file mode 100644 index 00000000..6d9888b0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_py3.EventsResult.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_result_py3.EventsResult +name: EventsResult +fullName: azure.applicationinsights.models.events_result_py3.EventsResult +module: azure.applicationinsights.models.events_result_py3 +summary: An event query result. +constructor: + syntax: EventsResult(*, aimessages=None, value=None, **kwargs) + parameters: + - name: aimessages + description: OData messages for this response. + isRequired: true + types: + - [] + - name: value + isRequired: true + types: + - + keywordOnlyParameters: + - name: aimessages + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_result_py3.EventsResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_result_py3.EventsResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_result_py3.EventsResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_result_py3.EventsResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_result_py3.EventsResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_result_py3.EventsResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_result_py3.EventsResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_py3.yml new file mode 100644 index 00000000..7e41affd --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_result_py3 +name: events_result_py3 +fullName: azure.applicationinsights.models.events_result_py3 +classes: +- azure.applicationinsights.models.events_result_py3.EventsResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_results.EventsResults.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_results.EventsResults.yml new file mode 100644 index 00000000..d0e338b3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_results.EventsResults.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_results.EventsResults +name: EventsResults +fullName: azure.applicationinsights.models.events_results.EventsResults +module: azure.applicationinsights.models.events_results +summary: An events query result. +constructor: + syntax: EventsResults(**kwargs) + parameters: + - name: odatacontext + description: OData context metadata endpoint for this response + isRequired: true + types: + - + - name: aimessages + description: OData messages for this response. + isRequired: true + types: + - [] + - name: value + description: Contents of the events query result. + isRequired: true + types: + - [] +methods: +- uid: azure.applicationinsights.models.events_results.EventsResults.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_results.EventsResults.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_results.EventsResults.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_results.EventsResults.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_results.EventsResults.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_results.EventsResults.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_results.EventsResults.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_results.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_results.yml new file mode 100644 index 00000000..383d93e4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_results.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_results +name: events_results +fullName: azure.applicationinsights.models.events_results +classes: +- azure.applicationinsights.models.events_results.EventsResults diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_results_py3.EventsResults.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_results_py3.EventsResults.yml new file mode 100644 index 00000000..51f87467 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_results_py3.EventsResults.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_results_py3.EventsResults +name: EventsResults +fullName: azure.applicationinsights.models.events_results_py3.EventsResults +module: azure.applicationinsights.models.events_results_py3 +summary: An events query result. +constructor: + syntax: 'EventsResults(*, odatacontext: str = None, aimessages=None, value=None, + **kwargs)' + parameters: + - name: odatacontext + description: OData context metadata endpoint for this response + isRequired: true + types: + - + - name: aimessages + description: OData messages for this response. + isRequired: true + types: + - [] + - name: value + description: Contents of the events query result. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: odatacontext + isRequired: true + - name: aimessages + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_results_py3.EventsResults.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_results_py3.EventsResults.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_results_py3.EventsResults.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_results_py3.EventsResults.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_results_py3.EventsResults.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_results_py3.EventsResults.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_results_py3.EventsResults.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_results_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_results_py3.yml new file mode 100644 index 00000000..82a31f86 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_results_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_results_py3 +name: events_results_py3 +fullName: azure.applicationinsights.models.events_results_py3 +classes: +- azure.applicationinsights.models.events_results_py3.EventsResults diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_session_info.EventsSessionInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_session_info.EventsSessionInfo.yml new file mode 100644 index 00000000..2c36804b --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_session_info.EventsSessionInfo.yml @@ -0,0 +1,120 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_session_info.EventsSessionInfo +name: EventsSessionInfo +fullName: azure.applicationinsights.models.events_session_info.EventsSessionInfo +module: azure.applicationinsights.models.events_session_info +summary: Session info for an event result. +constructor: + syntax: EventsSessionInfo(**kwargs) + parameters: + - name: id + description: ID of the session + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_session_info.EventsSessionInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_session_info.EventsSessionInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_session_info.EventsSessionInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_session_info.EventsSessionInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_session_info.EventsSessionInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_session_info.EventsSessionInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_session_info.EventsSessionInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_session_info.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_session_info.yml new file mode 100644 index 00000000..a0399379 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_session_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_session_info +name: events_session_info +fullName: azure.applicationinsights.models.events_session_info +classes: +- azure.applicationinsights.models.events_session_info.EventsSessionInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_session_info_py3.EventsSessionInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_session_info_py3.EventsSessionInfo.yml new file mode 100644 index 00000000..919fe90c --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_session_info_py3.EventsSessionInfo.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_session_info_py3.EventsSessionInfo +name: EventsSessionInfo +fullName: azure.applicationinsights.models.events_session_info_py3.EventsSessionInfo +module: azure.applicationinsights.models.events_session_info_py3 +summary: Session info for an event result. +constructor: + syntax: 'EventsSessionInfo(*, id: str = None, **kwargs)' + parameters: + - name: id + description: ID of the session + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_session_info_py3.EventsSessionInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_session_info_py3.EventsSessionInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_session_info_py3.EventsSessionInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_session_info_py3.EventsSessionInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_session_info_py3.EventsSessionInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_session_info_py3.EventsSessionInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_session_info_py3.EventsSessionInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_session_info_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_session_info_py3.yml new file mode 100644 index 00000000..5dfae255 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_session_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_session_info_py3 +name: events_session_info_py3 +fullName: azure.applicationinsights.models.events_session_info_py3 +classes: +- azure.applicationinsights.models.events_session_info_py3.EventsSessionInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_info.EventsTraceInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_info.EventsTraceInfo.yml new file mode 100644 index 00000000..d2f3d31a --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_info.EventsTraceInfo.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_trace_info.EventsTraceInfo +name: EventsTraceInfo +fullName: azure.applicationinsights.models.events_trace_info.EventsTraceInfo +module: azure.applicationinsights.models.events_trace_info +summary: The trace information. +constructor: + syntax: EventsTraceInfo(**kwargs) + parameters: + - name: message + description: The trace message + isRequired: true + types: + - + - name: severity_level + description: The trace severity level + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_trace_info.EventsTraceInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_trace_info.EventsTraceInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_trace_info.EventsTraceInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_trace_info.EventsTraceInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_trace_info.EventsTraceInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_trace_info.EventsTraceInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_trace_info.EventsTraceInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_info.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_info.yml new file mode 100644 index 00000000..9d8d8fd7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_trace_info +name: events_trace_info +fullName: azure.applicationinsights.models.events_trace_info +classes: +- azure.applicationinsights.models.events_trace_info.EventsTraceInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_info_py3.EventsTraceInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_info_py3.EventsTraceInfo.yml new file mode 100644 index 00000000..5e605fd6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_info_py3.EventsTraceInfo.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_trace_info_py3.EventsTraceInfo +name: EventsTraceInfo +fullName: azure.applicationinsights.models.events_trace_info_py3.EventsTraceInfo +module: azure.applicationinsights.models.events_trace_info_py3 +summary: The trace information. +constructor: + syntax: 'EventsTraceInfo(*, message: str = None, severity_level: int = None, **kwargs)' + parameters: + - name: message + description: The trace message + isRequired: true + types: + - + - name: severity_level + description: The trace severity level + isRequired: true + types: + - + keywordOnlyParameters: + - name: message + isRequired: true + - name: severity_level + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_trace_info_py3.EventsTraceInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_trace_info_py3.EventsTraceInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_trace_info_py3.EventsTraceInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_trace_info_py3.EventsTraceInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_trace_info_py3.EventsTraceInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_trace_info_py3.EventsTraceInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_trace_info_py3.EventsTraceInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_info_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_info_py3.yml new file mode 100644 index 00000000..665a9245 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_trace_info_py3 +name: events_trace_info_py3 +fullName: azure.applicationinsights.models.events_trace_info_py3 +classes: +- azure.applicationinsights.models.events_trace_info_py3.EventsTraceInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_result.EventsTraceResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_result.EventsTraceResult.yml new file mode 100644 index 00000000..ee0bdfef --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_result.EventsTraceResult.yml @@ -0,0 +1,187 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_trace_result.EventsTraceResult +name: EventsTraceResult +fullName: azure.applicationinsights.models.events_trace_result.EventsTraceResult +module: azure.applicationinsights.models.events_trace_result +summary: 'A trace result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: EventsTraceResult(**kwargs) + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: trace + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_trace_result.EventsTraceResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_trace_result.EventsTraceResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_trace_result.EventsTraceResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_trace_result.EventsTraceResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_trace_result.EventsTraceResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_trace_result.EventsTraceResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_trace_result.EventsTraceResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_result.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_result.yml new file mode 100644 index 00000000..b7117e6c --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_trace_result +name: events_trace_result +fullName: azure.applicationinsights.models.events_trace_result +classes: +- azure.applicationinsights.models.events_trace_result.EventsTraceResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_result_py3.EventsTraceResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_result_py3.EventsTraceResult.yml new file mode 100644 index 00000000..dbd72bd7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_result_py3.EventsTraceResult.yml @@ -0,0 +1,216 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_trace_result_py3.EventsTraceResult +name: EventsTraceResult +fullName: azure.applicationinsights.models.events_trace_result_py3.EventsTraceResult +module: azure.applicationinsights.models.events_trace_result_py3 +summary: 'A trace result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EventsTraceResult(*, id: str = None, count: int = None, timestamp=None, + custom_dimensions=None, custom_measurements=None, operation=None, session=None, + user=None, cloud=None, ai=None, application=None, client=None, trace=None, **kwargs)' + parameters: + - name: id + description: The unique ID for this event. + isRequired: true + types: + - + - name: count + description: Count of the event + isRequired: true + types: + - + - name: timestamp + description: Timestamp of the event + isRequired: true + types: + - + - name: custom_dimensions + description: Custom dimensions of the event + isRequired: true + types: + - + - name: custom_measurements + description: Custom measurements of the event + isRequired: true + types: + - + - name: operation + description: Operation info of the event + isRequired: true + types: + - + - name: session + description: Session info of the event + isRequired: true + types: + - + - name: user + description: User info of the event + isRequired: true + types: + - + - name: cloud + description: Cloud info of the event + isRequired: true + types: + - + - name: ai + description: AI info of the event + isRequired: true + types: + - + - name: application + description: Application info of the event + isRequired: true + types: + - + - name: client + description: Client info of the event + isRequired: true + types: + - + - name: type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: trace + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: count + isRequired: true + - name: timestamp + isRequired: true + - name: custom_dimensions + isRequired: true + - name: custom_measurements + isRequired: true + - name: operation + isRequired: true + - name: session + isRequired: true + - name: user + isRequired: true + - name: cloud + isRequired: true + - name: ai + isRequired: true + - name: application + isRequired: true + - name: client + isRequired: true + - name: trace + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_trace_result_py3.EventsTraceResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_trace_result_py3.EventsTraceResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_trace_result_py3.EventsTraceResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_trace_result_py3.EventsTraceResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_trace_result_py3.EventsTraceResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_trace_result_py3.EventsTraceResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_trace_result_py3.EventsTraceResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_result_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_result_py3.yml new file mode 100644 index 00000000..fa3773b3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_trace_result_py3 +name: events_trace_result_py3 +fullName: azure.applicationinsights.models.events_trace_result_py3 +classes: +- azure.applicationinsights.models.events_trace_result_py3.EventsTraceResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_user_info.EventsUserInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_user_info.EventsUserInfo.yml new file mode 100644 index 00000000..4bbfec28 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_user_info.EventsUserInfo.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_user_info.EventsUserInfo +name: EventsUserInfo +fullName: azure.applicationinsights.models.events_user_info.EventsUserInfo +module: azure.applicationinsights.models.events_user_info +summary: User info for an event result. +constructor: + syntax: EventsUserInfo(**kwargs) + parameters: + - name: id + description: ID of the user + isRequired: true + types: + - + - name: account_id + description: Account ID of the user + isRequired: true + types: + - + - name: authenticated_id + description: Authenticated ID of the user + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.events_user_info.EventsUserInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_user_info.EventsUserInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_user_info.EventsUserInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_user_info.EventsUserInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_user_info.EventsUserInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_user_info.EventsUserInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_user_info.EventsUserInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_user_info.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_user_info.yml new file mode 100644 index 00000000..afac66a2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_user_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_user_info +name: events_user_info +fullName: azure.applicationinsights.models.events_user_info +classes: +- azure.applicationinsights.models.events_user_info.EventsUserInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_user_info_py3.EventsUserInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_user_info_py3.EventsUserInfo.yml new file mode 100644 index 00000000..6efdeb31 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_user_info_py3.EventsUserInfo.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.events_user_info_py3.EventsUserInfo +name: EventsUserInfo +fullName: azure.applicationinsights.models.events_user_info_py3.EventsUserInfo +module: azure.applicationinsights.models.events_user_info_py3 +summary: User info for an event result. +constructor: + syntax: 'EventsUserInfo(*, id: str = None, account_id: str = None, authenticated_id: + str = None, **kwargs)' + parameters: + - name: id + description: ID of the user + isRequired: true + types: + - + - name: account_id + description: Account ID of the user + isRequired: true + types: + - + - name: authenticated_id + description: Authenticated ID of the user + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: account_id + isRequired: true + - name: authenticated_id + isRequired: true +methods: +- uid: azure.applicationinsights.models.events_user_info_py3.EventsUserInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_user_info_py3.EventsUserInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_user_info_py3.EventsUserInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.events_user_info_py3.EventsUserInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.events_user_info_py3.EventsUserInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.events_user_info_py3.EventsUserInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.events_user_info_py3.EventsUserInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_user_info_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_user_info_py3.yml new file mode 100644 index 00000000..e38b6c90 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_user_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.events_user_info_py3 +name: events_user_info_py3 +fullName: azure.applicationinsights.models.events_user_info_py3 +classes: +- azure.applicationinsights.models.events_user_info_py3.EventsUserInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema.MetricsPostBodySchema.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema.MetricsPostBodySchema.yml new file mode 100644 index 00000000..4d84a94f --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema.MetricsPostBodySchema.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.metrics_post_body_schema.MetricsPostBodySchema +name: MetricsPostBodySchema +fullName: azure.applicationinsights.models.metrics_post_body_schema.MetricsPostBodySchema +module: azure.applicationinsights.models.metrics_post_body_schema +summary: 'A metric request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: MetricsPostBodySchema(**kwargs) + parameters: + - name: id + description: 'Required. An identifier for this query. Must be unique within + + the post body of the request. This identifier will be the ''id'' property + + of the response object representing this query.' + isRequired: true + types: + - + - name: parameters + description: Required. The parameters for a single metrics query + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.metrics_post_body_schema.MetricsPostBodySchema.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_post_body_schema.MetricsPostBodySchema.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_post_body_schema.MetricsPostBodySchema.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.metrics_post_body_schema.MetricsPostBodySchema.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_post_body_schema.MetricsPostBodySchema.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.metrics_post_body_schema.MetricsPostBodySchema.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_post_body_schema.MetricsPostBodySchema.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema.yml new file mode 100644 index 00000000..1fb50b76 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.metrics_post_body_schema +name: metrics_post_body_schema +fullName: azure.applicationinsights.models.metrics_post_body_schema +classes: +- azure.applicationinsights.models.metrics_post_body_schema.MetricsPostBodySchema diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_parameters.MetricsPostBodySchemaParameters.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_parameters.MetricsPostBodySchemaParameters.yml new file mode 100644 index 00000000..1983929e --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_parameters.MetricsPostBodySchemaParameters.yml @@ -0,0 +1,190 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.metrics_post_body_schema_parameters.MetricsPostBodySchemaParameters +name: MetricsPostBodySchemaParameters +fullName: azure.applicationinsights.models.metrics_post_body_schema_parameters.MetricsPostBodySchemaParameters +module: azure.applicationinsights.models.metrics_post_body_schema_parameters +summary: 'The parameters for a single metrics query. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: MetricsPostBodySchemaParameters(**kwargs) + parameters: + - name: metric_id + description: 'Required. Possible values include: ''requests/count'', + + ''requests/duration'', ''requests/failed'', ''users/count'', + + ''users/authenticated'', ''pageViews/count'', ''pageViews/duration'', + + ''client/processingDuration'', ''client/receiveDuration'', + + ''client/networkDuration'', ''client/sendDuration'', ''client/totalDuration'', + + ''dependencies/count'', ''dependencies/failed'', ''dependencies/duration'', + + ''exceptions/count'', ''exceptions/browser'', ''exceptions/server'', + + ''sessions/count'', ''performanceCounters/requestExecutionTime'', + + ''performanceCounters/requestsPerSecond'', + + ''performanceCounters/requestsInQueue'', + + ''performanceCounters/memoryAvailableBytes'', + + ''performanceCounters/exceptionsPerSecond'', + + ''performanceCounters/processCpuPercentage'', + + ''performanceCounters/processIOBytesPerSecond'', + + ''performanceCounters/processPrivateBytes'', + + ''performanceCounters/processorCpuPercentage'', + + ''availabilityResults/availabilityPercentage'', + + ''availabilityResults/duration'', ''billing/telemetryCount'', + + ''customEvents/count''' + isRequired: true + types: + - + - + - name: timespan + isRequired: true + types: + - + - name: aggregation + isRequired: true + types: + - [ + - ] + - name: interval + isRequired: true + types: + - + - name: segment + isRequired: true + types: + - [ + - ] + - name: top + isRequired: true + types: + - + - name: orderby + isRequired: true + types: + - + - name: filter + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.metrics_post_body_schema_parameters.MetricsPostBodySchemaParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_post_body_schema_parameters.MetricsPostBodySchemaParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_post_body_schema_parameters.MetricsPostBodySchemaParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.metrics_post_body_schema_parameters.MetricsPostBodySchemaParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_post_body_schema_parameters.MetricsPostBodySchemaParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.metrics_post_body_schema_parameters.MetricsPostBodySchemaParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_post_body_schema_parameters.MetricsPostBodySchemaParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_parameters.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_parameters.yml new file mode 100644 index 00000000..424fabdb --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.metrics_post_body_schema_parameters +name: metrics_post_body_schema_parameters +fullName: azure.applicationinsights.models.metrics_post_body_schema_parameters +classes: +- azure.applicationinsights.models.metrics_post_body_schema_parameters.MetricsPostBodySchemaParameters diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.MetricsPostBodySchemaParameters.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.MetricsPostBodySchemaParameters.yml new file mode 100644 index 00000000..a3df8f3d --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.MetricsPostBodySchemaParameters.yml @@ -0,0 +1,209 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.MetricsPostBodySchemaParameters +name: MetricsPostBodySchemaParameters +fullName: azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.MetricsPostBodySchemaParameters +module: azure.applicationinsights.models.metrics_post_body_schema_parameters_py3 +summary: 'The parameters for a single metrics query. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MetricsPostBodySchemaParameters(*, metric_id, timespan: str = None, aggregation=None, + interval=None, segment=None, top: int = None, orderby: str = None, filter: str + = None, **kwargs)' + parameters: + - name: metric_id + description: 'Required. Possible values include: ''requests/count'', + + ''requests/duration'', ''requests/failed'', ''users/count'', + + ''users/authenticated'', ''pageViews/count'', ''pageViews/duration'', + + ''client/processingDuration'', ''client/receiveDuration'', + + ''client/networkDuration'', ''client/sendDuration'', ''client/totalDuration'', + + ''dependencies/count'', ''dependencies/failed'', ''dependencies/duration'', + + ''exceptions/count'', ''exceptions/browser'', ''exceptions/server'', + + ''sessions/count'', ''performanceCounters/requestExecutionTime'', + + ''performanceCounters/requestsPerSecond'', + + ''performanceCounters/requestsInQueue'', + + ''performanceCounters/memoryAvailableBytes'', + + ''performanceCounters/exceptionsPerSecond'', + + ''performanceCounters/processCpuPercentage'', + + ''performanceCounters/processIOBytesPerSecond'', + + ''performanceCounters/processPrivateBytes'', + + ''performanceCounters/processorCpuPercentage'', + + ''availabilityResults/availabilityPercentage'', + + ''availabilityResults/duration'', ''billing/telemetryCount'', + + ''customEvents/count''' + isRequired: true + types: + - + - + - name: timespan + isRequired: true + types: + - + - name: aggregation + isRequired: true + types: + - [ + - ] + - name: interval + isRequired: true + types: + - + - name: segment + isRequired: true + types: + - [ + - ] + - name: top + isRequired: true + types: + - + - name: orderby + isRequired: true + types: + - + - name: filter + isRequired: true + types: + - + keywordOnlyParameters: + - name: metric_id + isRequired: true + - name: timespan + isRequired: true + - name: aggregation + isRequired: true + - name: interval + isRequired: true + - name: segment + isRequired: true + - name: top + isRequired: true + - name: orderby + isRequired: true + - name: filter + isRequired: true +methods: +- uid: azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.MetricsPostBodySchemaParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.MetricsPostBodySchemaParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.MetricsPostBodySchemaParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.MetricsPostBodySchemaParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.MetricsPostBodySchemaParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.MetricsPostBodySchemaParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.MetricsPostBodySchemaParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.yml new file mode 100644 index 00000000..d5b21f13 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.metrics_post_body_schema_parameters_py3 +name: metrics_post_body_schema_parameters_py3 +fullName: azure.applicationinsights.models.metrics_post_body_schema_parameters_py3 +classes: +- azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.MetricsPostBodySchemaParameters diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_py3.MetricsPostBodySchema.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_py3.MetricsPostBodySchema.yml new file mode 100644 index 00000000..939fffd7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_py3.MetricsPostBodySchema.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.metrics_post_body_schema_py3.MetricsPostBodySchema +name: MetricsPostBodySchema +fullName: azure.applicationinsights.models.metrics_post_body_schema_py3.MetricsPostBodySchema +module: azure.applicationinsights.models.metrics_post_body_schema_py3 +summary: 'A metric request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MetricsPostBodySchema(*, id: str, parameters, **kwargs)' + parameters: + - name: id + description: 'Required. An identifier for this query. Must be unique within + + the post body of the request. This identifier will be the ''id'' property + + of the response object representing this query.' + isRequired: true + types: + - + - name: parameters + description: Required. The parameters for a single metrics query + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: parameters + isRequired: true +methods: +- uid: azure.applicationinsights.models.metrics_post_body_schema_py3.MetricsPostBodySchema.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_post_body_schema_py3.MetricsPostBodySchema.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_post_body_schema_py3.MetricsPostBodySchema.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.metrics_post_body_schema_py3.MetricsPostBodySchema.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_post_body_schema_py3.MetricsPostBodySchema.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.metrics_post_body_schema_py3.MetricsPostBodySchema.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_post_body_schema_py3.MetricsPostBodySchema.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_py3.yml new file mode 100644 index 00000000..06ca6edb --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.metrics_post_body_schema_py3 +name: metrics_post_body_schema_py3 +fullName: azure.applicationinsights.models.metrics_post_body_schema_py3 +classes: +- azure.applicationinsights.models.metrics_post_body_schema_py3.MetricsPostBodySchema diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result.MetricsResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result.MetricsResult.yml new file mode 100644 index 00000000..614d65e5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result.MetricsResult.yml @@ -0,0 +1,119 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.metrics_result.MetricsResult +name: MetricsResult +fullName: azure.applicationinsights.models.metrics_result.MetricsResult +module: azure.applicationinsights.models.metrics_result +summary: A metric result. +constructor: + syntax: MetricsResult(**kwargs) + parameters: + - name: value + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.metrics_result.MetricsResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_result.MetricsResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_result.MetricsResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.metrics_result.MetricsResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_result.MetricsResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.metrics_result.MetricsResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_result.MetricsResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result.yml new file mode 100644 index 00000000..2bbd54b2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.metrics_result +name: metrics_result +fullName: azure.applicationinsights.models.metrics_result +classes: +- azure.applicationinsights.models.metrics_result.MetricsResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_info.MetricsResultInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_info.MetricsResultInfo.yml new file mode 100644 index 00000000..5ebf0b43 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_info.MetricsResultInfo.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.metrics_result_info.MetricsResultInfo +name: MetricsResultInfo +fullName: azure.applicationinsights.models.metrics_result_info.MetricsResultInfo +module: azure.applicationinsights.models.metrics_result_info +summary: A metric result data. +constructor: + syntax: MetricsResultInfo(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: start + description: Start time of the metric. + isRequired: true + types: + - + - name: end + description: Start time of the metric. + isRequired: true + types: + - + - name: interval + description: The interval used to segment the metric data. + isRequired: true + types: + - + - name: segments + description: Segmented metric data (if segmented). + isRequired: true + types: + - [] +methods: +- uid: azure.applicationinsights.models.metrics_result_info.MetricsResultInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_result_info.MetricsResultInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_result_info.MetricsResultInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.metrics_result_info.MetricsResultInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_result_info.MetricsResultInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.metrics_result_info.MetricsResultInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_result_info.MetricsResultInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_info.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_info.yml new file mode 100644 index 00000000..60df398f --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.metrics_result_info +name: metrics_result_info +fullName: azure.applicationinsights.models.metrics_result_info +classes: +- azure.applicationinsights.models.metrics_result_info.MetricsResultInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_info_py3.MetricsResultInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_info_py3.MetricsResultInfo.yml new file mode 100644 index 00000000..37b36ed7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_info_py3.MetricsResultInfo.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.metrics_result_info_py3.MetricsResultInfo +name: MetricsResultInfo +fullName: azure.applicationinsights.models.metrics_result_info_py3.MetricsResultInfo +module: azure.applicationinsights.models.metrics_result_info_py3 +summary: A metric result data. +constructor: + syntax: MetricsResultInfo(*, additional_properties=None, start=None, end=None, interval=None, + segments=None, **kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: start + description: Start time of the metric. + isRequired: true + types: + - + - name: end + description: Start time of the metric. + isRequired: true + types: + - + - name: interval + description: The interval used to segment the metric data. + isRequired: true + types: + - + - name: segments + description: Segmented metric data (if segmented). + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: start + isRequired: true + - name: end + isRequired: true + - name: interval + isRequired: true + - name: segments + isRequired: true +methods: +- uid: azure.applicationinsights.models.metrics_result_info_py3.MetricsResultInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_result_info_py3.MetricsResultInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_result_info_py3.MetricsResultInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.metrics_result_info_py3.MetricsResultInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_result_info_py3.MetricsResultInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.metrics_result_info_py3.MetricsResultInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_result_info_py3.MetricsResultInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_info_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_info_py3.yml new file mode 100644 index 00000000..633ade65 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.metrics_result_info_py3 +name: metrics_result_info_py3 +fullName: azure.applicationinsights.models.metrics_result_info_py3 +classes: +- azure.applicationinsights.models.metrics_result_info_py3.MetricsResultInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_py3.MetricsResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_py3.MetricsResult.yml new file mode 100644 index 00000000..278ad3e0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_py3.MetricsResult.yml @@ -0,0 +1,122 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.metrics_result_py3.MetricsResult +name: MetricsResult +fullName: azure.applicationinsights.models.metrics_result_py3.MetricsResult +module: azure.applicationinsights.models.metrics_result_py3 +summary: A metric result. +constructor: + syntax: MetricsResult(*, value=None, **kwargs) + parameters: + - name: value + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true +methods: +- uid: azure.applicationinsights.models.metrics_result_py3.MetricsResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_result_py3.MetricsResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_result_py3.MetricsResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.metrics_result_py3.MetricsResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_result_py3.MetricsResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.metrics_result_py3.MetricsResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_result_py3.MetricsResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_py3.yml new file mode 100644 index 00000000..15ac59e5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.metrics_result_py3 +name: metrics_result_py3 +fullName: azure.applicationinsights.models.metrics_result_py3 +classes: +- azure.applicationinsights.models.metrics_result_py3.MetricsResult diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_results_item.MetricsResultsItem.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_results_item.MetricsResultsItem.yml new file mode 100644 index 00000000..b796a8c7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_results_item.MetricsResultsItem.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.metrics_results_item.MetricsResultsItem +name: MetricsResultsItem +fullName: azure.applicationinsights.models.metrics_results_item.MetricsResultsItem +module: azure.applicationinsights.models.metrics_results_item +summary: 'MetricsResultsItem. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: MetricsResultsItem(**kwargs) + parameters: + - name: id + description: Required. The specified ID for this metric. + isRequired: true + types: + - + - name: status + description: Required. The HTTP status code of this metric query. + isRequired: true + types: + - + - name: body + description: Required. The results of this metric query. + isRequired: true + types: + - +methods: +- uid: azure.applicationinsights.models.metrics_results_item.MetricsResultsItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_results_item.MetricsResultsItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_results_item.MetricsResultsItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.metrics_results_item.MetricsResultsItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_results_item.MetricsResultsItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.metrics_results_item.MetricsResultsItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_results_item.MetricsResultsItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_results_item.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_results_item.yml new file mode 100644 index 00000000..dc9921d1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_results_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.metrics_results_item +name: metrics_results_item +fullName: azure.applicationinsights.models.metrics_results_item +classes: +- azure.applicationinsights.models.metrics_results_item.MetricsResultsItem diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_results_item_py3.MetricsResultsItem.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_results_item_py3.MetricsResultsItem.yml new file mode 100644 index 00000000..e5617521 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_results_item_py3.MetricsResultsItem.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.metrics_results_item_py3.MetricsResultsItem +name: MetricsResultsItem +fullName: azure.applicationinsights.models.metrics_results_item_py3.MetricsResultsItem +module: azure.applicationinsights.models.metrics_results_item_py3 +summary: 'MetricsResultsItem. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MetricsResultsItem(*, id: str, status: int, body, **kwargs)' + parameters: + - name: id + description: Required. The specified ID for this metric. + isRequired: true + types: + - + - name: status + description: Required. The HTTP status code of this metric query. + isRequired: true + types: + - + - name: body + description: Required. The results of this metric query. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: status + isRequired: true + - name: body + isRequired: true +methods: +- uid: azure.applicationinsights.models.metrics_results_item_py3.MetricsResultsItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_results_item_py3.MetricsResultsItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_results_item_py3.MetricsResultsItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.metrics_results_item_py3.MetricsResultsItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_results_item_py3.MetricsResultsItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.metrics_results_item_py3.MetricsResultsItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_results_item_py3.MetricsResultsItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_results_item_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_results_item_py3.yml new file mode 100644 index 00000000..13c6ba32 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_results_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.metrics_results_item_py3 +name: metrics_results_item_py3 +fullName: azure.applicationinsights.models.metrics_results_item_py3 +classes: +- azure.applicationinsights.models.metrics_results_item_py3.MetricsResultsItem diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_segment_info.MetricsSegmentInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_segment_info.MetricsSegmentInfo.yml new file mode 100644 index 00000000..509efb56 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_segment_info.MetricsSegmentInfo.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.metrics_segment_info.MetricsSegmentInfo +name: MetricsSegmentInfo +fullName: azure.applicationinsights.models.metrics_segment_info.MetricsSegmentInfo +module: azure.applicationinsights.models.metrics_segment_info +summary: A metric segment. +constructor: + syntax: MetricsSegmentInfo(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: start + description: 'Start time of the metric segment (only when an interval was + + specified).' + isRequired: true + types: + - + - name: end + description: 'Start time of the metric segment (only when an interval was + + specified).' + isRequired: true + types: + - + - name: segments + description: Segmented metric data (if further segmented). + isRequired: true + types: + - [] +methods: +- uid: azure.applicationinsights.models.metrics_segment_info.MetricsSegmentInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_segment_info.MetricsSegmentInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_segment_info.MetricsSegmentInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.metrics_segment_info.MetricsSegmentInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_segment_info.MetricsSegmentInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.metrics_segment_info.MetricsSegmentInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_segment_info.MetricsSegmentInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_segment_info.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_segment_info.yml new file mode 100644 index 00000000..40d20d64 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_segment_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.metrics_segment_info +name: metrics_segment_info +fullName: azure.applicationinsights.models.metrics_segment_info +classes: +- azure.applicationinsights.models.metrics_segment_info.MetricsSegmentInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_segment_info_py3.MetricsSegmentInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_segment_info_py3.MetricsSegmentInfo.yml new file mode 100644 index 00000000..36f49a32 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_segment_info_py3.MetricsSegmentInfo.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.metrics_segment_info_py3.MetricsSegmentInfo +name: MetricsSegmentInfo +fullName: azure.applicationinsights.models.metrics_segment_info_py3.MetricsSegmentInfo +module: azure.applicationinsights.models.metrics_segment_info_py3 +summary: A metric segment. +constructor: + syntax: MetricsSegmentInfo(*, additional_properties=None, start=None, end=None, + segments=None, **kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: start + description: 'Start time of the metric segment (only when an interval was + + specified).' + isRequired: true + types: + - + - name: end + description: 'Start time of the metric segment (only when an interval was + + specified).' + isRequired: true + types: + - + - name: segments + description: Segmented metric data (if further segmented). + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: start + isRequired: true + - name: end + isRequired: true + - name: segments + isRequired: true +methods: +- uid: azure.applicationinsights.models.metrics_segment_info_py3.MetricsSegmentInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_segment_info_py3.MetricsSegmentInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_segment_info_py3.MetricsSegmentInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.metrics_segment_info_py3.MetricsSegmentInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.metrics_segment_info_py3.MetricsSegmentInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.metrics_segment_info_py3.MetricsSegmentInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.metrics_segment_info_py3.MetricsSegmentInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_segment_info_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_segment_info_py3.yml new file mode 100644 index 00000000..88f1f143 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_segment_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.metrics_segment_info_py3 +name: metrics_segment_info_py3 +fullName: azure.applicationinsights.models.metrics_segment_info_py3 +classes: +- azure.applicationinsights.models.metrics_segment_info_py3.MetricsSegmentInfo diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_body.QueryBody.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_body.QueryBody.yml new file mode 100644 index 00000000..75c5bbae --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_body.QueryBody.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.query_body.QueryBody +name: QueryBody +fullName: azure.applicationinsights.models.query_body.QueryBody +module: azure.applicationinsights.models.query_body +summary: 'The Analytics query. Learn more about the [Analytics query + + syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/). + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: QueryBody(**kwargs) + parameters: + - name: query + description: Required. The query to execute. + isRequired: true + types: + - + - name: timespan + description: 'Optional. The timespan over which to query data. This is + + an ISO8601 time period value. This timespan is applied in addition to any + + that are specified in the query expression.' + isRequired: true + types: + - + - name: applications + description: 'A list of Application IDs for cross-application + + queries.' + isRequired: true + types: + - [] +methods: +- uid: azure.applicationinsights.models.query_body.QueryBody.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.query_body.QueryBody.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.query_body.QueryBody.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.query_body.QueryBody.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.query_body.QueryBody.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.query_body.QueryBody.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.query_body.QueryBody.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_body.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_body.yml new file mode 100644 index 00000000..ecc5ff62 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_body.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.query_body +name: query_body +fullName: azure.applicationinsights.models.query_body +classes: +- azure.applicationinsights.models.query_body.QueryBody diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_body_py3.QueryBody.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_body_py3.QueryBody.yml new file mode 100644 index 00000000..4f825a4d --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_body_py3.QueryBody.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.query_body_py3.QueryBody +name: QueryBody +fullName: azure.applicationinsights.models.query_body_py3.QueryBody +module: azure.applicationinsights.models.query_body_py3 +summary: 'The Analytics query. Learn more about the [Analytics query + + syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/). + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'QueryBody(*, query: str, timespan: str = None, applications=None, **kwargs)' + parameters: + - name: query + description: Required. The query to execute. + isRequired: true + types: + - + - name: timespan + description: 'Optional. The timespan over which to query data. This is + + an ISO8601 time period value. This timespan is applied in addition to any + + that are specified in the query expression.' + isRequired: true + types: + - + - name: applications + description: 'A list of Application IDs for cross-application + + queries.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: query + isRequired: true + - name: timespan + isRequired: true + - name: applications + isRequired: true +methods: +- uid: azure.applicationinsights.models.query_body_py3.QueryBody.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.query_body_py3.QueryBody.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.query_body_py3.QueryBody.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.query_body_py3.QueryBody.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.query_body_py3.QueryBody.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.query_body_py3.QueryBody.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.query_body_py3.QueryBody.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_body_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_body_py3.yml new file mode 100644 index 00000000..6b5a1554 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_body_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.query_body_py3 +name: query_body_py3 +fullName: azure.applicationinsights.models.query_body_py3 +classes: +- azure.applicationinsights.models.query_body_py3.QueryBody diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_results.QueryResults.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_results.QueryResults.yml new file mode 100644 index 00000000..a7e9ccd0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_results.QueryResults.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.query_results.QueryResults +name: QueryResults +fullName: azure.applicationinsights.models.query_results.QueryResults +module: azure.applicationinsights.models.query_results +summary: 'A query response. + + + Contains the tables, columns & rows resulting from a query. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: QueryResults(**kwargs) + parameters: + - name: tables + description: Required. The list of tables, columns and rows. + isRequired: true + types: + - [] +methods: +- uid: azure.applicationinsights.models.query_results.QueryResults.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.query_results.QueryResults.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.query_results.QueryResults.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.query_results.QueryResults.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.query_results.QueryResults.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.query_results.QueryResults.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.query_results.QueryResults.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_results.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_results.yml new file mode 100644 index 00000000..acee5279 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_results.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.query_results +name: query_results +fullName: azure.applicationinsights.models.query_results +classes: +- azure.applicationinsights.models.query_results.QueryResults diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_results_py3.QueryResults.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_results_py3.QueryResults.yml new file mode 100644 index 00000000..6bb29a63 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_results_py3.QueryResults.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.query_results_py3.QueryResults +name: QueryResults +fullName: azure.applicationinsights.models.query_results_py3.QueryResults +module: azure.applicationinsights.models.query_results_py3 +summary: 'A query response. + + + Contains the tables, columns & rows resulting from a query. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: QueryResults(*, tables, **kwargs) + parameters: + - name: tables + description: Required. The list of tables, columns and rows. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: tables + isRequired: true +methods: +- uid: azure.applicationinsights.models.query_results_py3.QueryResults.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.query_results_py3.QueryResults.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.query_results_py3.QueryResults.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.query_results_py3.QueryResults.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.query_results_py3.QueryResults.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.query_results_py3.QueryResults.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.query_results_py3.QueryResults.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_results_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_results_py3.yml new file mode 100644 index 00000000..6fff369e --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_results_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.query_results_py3 +name: query_results_py3 +fullName: azure.applicationinsights.models.query_results_py3 +classes: +- azure.applicationinsights.models.query_results_py3.QueryResults diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.table.Table.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.table.Table.yml new file mode 100644 index 00000000..f0647740 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.table.Table.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.table.Table +name: Table +fullName: azure.applicationinsights.models.table.Table +module: azure.applicationinsights.models.table +summary: 'A query response table. + + + Contains the columns and rows for one table in a query response. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Table(**kwargs) + parameters: + - name: name + description: Required. The name of the table. + isRequired: true + types: + - + - name: columns + description: Required. The list of columns in this table. + isRequired: true + types: + - [] + - name: rows + description: Required. The resulting rows from this query. + isRequired: true + types: + - [[]] +methods: +- uid: azure.applicationinsights.models.table.Table.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.table.Table.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.table.Table.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.table.Table.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.table.Table.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.table.Table.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.table.Table.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.table.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.table.yml new file mode 100644 index 00000000..ab7f739c --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.table.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.table +name: table +fullName: azure.applicationinsights.models.table +classes: +- azure.applicationinsights.models.table.Table diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.table_py3.Table.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.table_py3.Table.yml new file mode 100644 index 00000000..eafaf465 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.table_py3.Table.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.models.table_py3.Table +name: Table +fullName: azure.applicationinsights.models.table_py3.Table +module: azure.applicationinsights.models.table_py3 +summary: 'A query response table. + + + Contains the columns and rows for one table in a query response. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Table(*, name: str, columns, rows, **kwargs)' + parameters: + - name: name + description: Required. The name of the table. + isRequired: true + types: + - + - name: columns + description: Required. The list of columns in this table. + isRequired: true + types: + - [] + - name: rows + description: Required. The resulting rows from this query. + isRequired: true + types: + - [[]] + keywordOnlyParameters: + - name: name + isRequired: true + - name: columns + isRequired: true + - name: rows + isRequired: true +methods: +- uid: azure.applicationinsights.models.table_py3.Table.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.table_py3.Table.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.table_py3.Table.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.applicationinsights.models.table_py3.Table.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.applicationinsights.models.table_py3.Table.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.applicationinsights.models.table_py3.Table.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.applicationinsights.models.table_py3.Table.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.table_py3.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.table_py3.yml new file mode 100644 index 00000000..d3f601f6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.table_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.models.table_py3 +name: table_py3 +fullName: azure.applicationinsights.models.table_py3 +classes: +- azure.applicationinsights.models.table_py3.Table diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.yml new file mode 100644 index 00000000..5e9fdcf2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.yml @@ -0,0 +1,158 @@ +### YamlMime:PythonPackage +uid: azure.applicationinsights.models +name: models +fullName: azure.applicationinsights.models +type: import +classes: +- azure.applicationinsights.models.Column +- azure.applicationinsights.models.ErrorDetail +- azure.applicationinsights.models.ErrorInfo +- azure.applicationinsights.models.ErrorResponse +- azure.applicationinsights.models.ErrorResponseException +- azure.applicationinsights.models.EventsAiInfo +- azure.applicationinsights.models.EventsApplicationInfo +- azure.applicationinsights.models.EventsAvailabilityResultInfo +- azure.applicationinsights.models.EventsAvailabilityResultResult +- azure.applicationinsights.models.EventsBrowserTimingInfo +- azure.applicationinsights.models.EventsBrowserTimingResult +- azure.applicationinsights.models.EventsClientInfo +- azure.applicationinsights.models.EventsClientPerformanceInfo +- azure.applicationinsights.models.EventsCloudInfo +- azure.applicationinsights.models.EventsCustomEventInfo +- azure.applicationinsights.models.EventsCustomEventResult +- azure.applicationinsights.models.EventsCustomMetricInfo +- azure.applicationinsights.models.EventsCustomMetricResult +- azure.applicationinsights.models.EventsDependencyInfo +- azure.applicationinsights.models.EventsDependencyResult +- azure.applicationinsights.models.EventsExceptionDetail +- azure.applicationinsights.models.EventsExceptionDetailsParsedStack +- azure.applicationinsights.models.EventsExceptionInfo +- azure.applicationinsights.models.EventsExceptionResult +- azure.applicationinsights.models.EventsOperationInfo +- azure.applicationinsights.models.EventsPageViewInfo +- azure.applicationinsights.models.EventsPageViewResult +- azure.applicationinsights.models.EventsPerformanceCounterInfo +- azure.applicationinsights.models.EventsPerformanceCounterResult +- azure.applicationinsights.models.EventsRequestInfo +- azure.applicationinsights.models.EventsRequestResult +- azure.applicationinsights.models.EventsResult +- azure.applicationinsights.models.EventsResultData +- azure.applicationinsights.models.EventsResultDataCustomDimensions +- azure.applicationinsights.models.EventsResultDataCustomMeasurements +- azure.applicationinsights.models.EventsResults +- azure.applicationinsights.models.EventsSessionInfo +- azure.applicationinsights.models.EventsTraceInfo +- azure.applicationinsights.models.EventsTraceResult +- azure.applicationinsights.models.EventsUserInfo +- azure.applicationinsights.models.MetricsPostBodySchema +- azure.applicationinsights.models.MetricsPostBodySchemaParameters +- azure.applicationinsights.models.MetricsResult +- azure.applicationinsights.models.MetricsResultInfo +- azure.applicationinsights.models.MetricsResultsItem +- azure.applicationinsights.models.MetricsSegmentInfo +- azure.applicationinsights.models.QueryBody +- azure.applicationinsights.models.QueryResults +- azure.applicationinsights.models.Table +modules: +- azure.applicationinsights.models.application_insights_data_client_enums +- azure.applicationinsights.models.column +- azure.applicationinsights.models.column_py3 +- azure.applicationinsights.models.error_detail +- azure.applicationinsights.models.error_detail_py3 +- azure.applicationinsights.models.error_info +- azure.applicationinsights.models.error_info_py3 +- azure.applicationinsights.models.error_response +- azure.applicationinsights.models.error_response_py3 +- azure.applicationinsights.models.events_ai_info +- azure.applicationinsights.models.events_ai_info_py3 +- azure.applicationinsights.models.events_application_info +- azure.applicationinsights.models.events_application_info_py3 +- azure.applicationinsights.models.events_availability_result_info +- azure.applicationinsights.models.events_availability_result_info_py3 +- azure.applicationinsights.models.events_availability_result_result +- azure.applicationinsights.models.events_availability_result_result_py3 +- azure.applicationinsights.models.events_browser_timing_info +- azure.applicationinsights.models.events_browser_timing_info_py3 +- azure.applicationinsights.models.events_browser_timing_result +- azure.applicationinsights.models.events_browser_timing_result_py3 +- azure.applicationinsights.models.events_client_info +- azure.applicationinsights.models.events_client_info_py3 +- azure.applicationinsights.models.events_client_performance_info +- azure.applicationinsights.models.events_client_performance_info_py3 +- azure.applicationinsights.models.events_cloud_info +- azure.applicationinsights.models.events_cloud_info_py3 +- azure.applicationinsights.models.events_custom_event_info +- azure.applicationinsights.models.events_custom_event_info_py3 +- azure.applicationinsights.models.events_custom_event_result +- azure.applicationinsights.models.events_custom_event_result_py3 +- azure.applicationinsights.models.events_custom_metric_info +- azure.applicationinsights.models.events_custom_metric_info_py3 +- azure.applicationinsights.models.events_custom_metric_result +- azure.applicationinsights.models.events_custom_metric_result_py3 +- azure.applicationinsights.models.events_dependency_info +- azure.applicationinsights.models.events_dependency_info_py3 +- azure.applicationinsights.models.events_dependency_result +- azure.applicationinsights.models.events_dependency_result_py3 +- azure.applicationinsights.models.events_exception_detail +- azure.applicationinsights.models.events_exception_detail_py3 +- azure.applicationinsights.models.events_exception_details_parsed_stack +- azure.applicationinsights.models.events_exception_details_parsed_stack_py3 +- azure.applicationinsights.models.events_exception_info +- azure.applicationinsights.models.events_exception_info_py3 +- azure.applicationinsights.models.events_exception_result +- azure.applicationinsights.models.events_exception_result_py3 +- azure.applicationinsights.models.events_operation_info +- azure.applicationinsights.models.events_operation_info_py3 +- azure.applicationinsights.models.events_page_view_info +- azure.applicationinsights.models.events_page_view_info_py3 +- azure.applicationinsights.models.events_page_view_result +- azure.applicationinsights.models.events_page_view_result_py3 +- azure.applicationinsights.models.events_performance_counter_info +- azure.applicationinsights.models.events_performance_counter_info_py3 +- azure.applicationinsights.models.events_performance_counter_result +- azure.applicationinsights.models.events_performance_counter_result_py3 +- azure.applicationinsights.models.events_request_info +- azure.applicationinsights.models.events_request_info_py3 +- azure.applicationinsights.models.events_request_result +- azure.applicationinsights.models.events_request_result_py3 +- azure.applicationinsights.models.events_result +- azure.applicationinsights.models.events_result_data +- azure.applicationinsights.models.events_result_data_custom_dimensions +- azure.applicationinsights.models.events_result_data_custom_dimensions_py3 +- azure.applicationinsights.models.events_result_data_custom_measurements +- azure.applicationinsights.models.events_result_data_custom_measurements_py3 +- azure.applicationinsights.models.events_result_data_py3 +- azure.applicationinsights.models.events_result_py3 +- azure.applicationinsights.models.events_results +- azure.applicationinsights.models.events_results_py3 +- azure.applicationinsights.models.events_session_info +- azure.applicationinsights.models.events_session_info_py3 +- azure.applicationinsights.models.events_trace_info +- azure.applicationinsights.models.events_trace_info_py3 +- azure.applicationinsights.models.events_trace_result +- azure.applicationinsights.models.events_trace_result_py3 +- azure.applicationinsights.models.events_user_info +- azure.applicationinsights.models.events_user_info_py3 +- azure.applicationinsights.models.metrics_post_body_schema +- azure.applicationinsights.models.metrics_post_body_schema_parameters +- azure.applicationinsights.models.metrics_post_body_schema_parameters_py3 +- azure.applicationinsights.models.metrics_post_body_schema_py3 +- azure.applicationinsights.models.metrics_result +- azure.applicationinsights.models.metrics_result_info +- azure.applicationinsights.models.metrics_result_info_py3 +- azure.applicationinsights.models.metrics_result_py3 +- azure.applicationinsights.models.metrics_results_item +- azure.applicationinsights.models.metrics_results_item_py3 +- azure.applicationinsights.models.metrics_segment_info +- azure.applicationinsights.models.metrics_segment_info_py3 +- azure.applicationinsights.models.query_body +- azure.applicationinsights.models.query_body_py3 +- azure.applicationinsights.models.query_results +- azure.applicationinsights.models.query_results_py3 +- azure.applicationinsights.models.table +- azure.applicationinsights.models.table_py3 +enums: +- azure.applicationinsights.models.EventType +- azure.applicationinsights.models.MetricId +- azure.applicationinsights.models.MetricsAggregation +- azure.applicationinsights.models.MetricsSegment diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.EventsOperations.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.EventsOperations.yml new file mode 100644 index 00000000..56eabbb3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.EventsOperations.yml @@ -0,0 +1,258 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.operations.EventsOperations +name: EventsOperations +fullName: azure.applicationinsights.operations.EventsOperations +module: azure.applicationinsights.operations +summary: EventsOperations operations. +constructor: + syntax: EventsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.applicationinsights.operations.EventsOperations.get + name: get + summary: 'Get an event. + + + Gets the data for a single event.' + signature: get(app_id, event_type, event_id, timespan=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: 'ID of the application. This is Application ID from the + + API Access settings blade in the Azure portal.' + isRequired: true + types: + - + - name: event_type + description: 'The type of events to query; either a standard + + event type (*traces*, *customEvents*, *pageViews*, *requests*, + + *dependencies*, *exceptions*, *availabilityResults*) or *$all* to + + query across all event types. Possible values include: ''$all'', + + ''traces'', ''customEvents'', ''pageViews'', ''browserTimings'', ''requests'', + + ''dependencies'', ''exceptions'', ''availabilityResults'', + + ''performanceCounters'', ''customMetrics''' + isRequired: true + types: + - + - + - name: event_id + description: ID of event. + isRequired: true + types: + - + - name: timespan + description: 'Optional. The timespan over which to retrieve events. + + This is an ISO8601 time period value. This timespan is applied in + + addition to any that are specified in the Odata expression.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: EventsResults or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.applicationinsights.models.ErrorResponseException +- uid: azure.applicationinsights.operations.EventsOperations.get_by_type + name: get_by_type + summary: 'Execute OData query. + + + Executes an OData query for events.' + signature: get_by_type(app_id, event_type, timespan=None, filter=None, search=None, + orderby=None, select=None, skip=None, top=None, format=None, count=None, apply=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: 'ID of the application. This is Application ID from the + + API Access settings blade in the Azure portal.' + isRequired: true + types: + - + - name: event_type + description: 'The type of events to query; either a standard + + event type (*traces*, *customEvents*, *pageViews*, *requests*, + + *dependencies*, *exceptions*, *availabilityResults*) or *$all* to + + query across all event types. Possible values include: ''$all'', + + ''traces'', ''customEvents'', ''pageViews'', ''browserTimings'', ''requests'', + + ''dependencies'', ''exceptions'', ''availabilityResults'', + + ''performanceCounters'', ''customMetrics''' + isRequired: true + types: + - + - + - name: timespan + description: 'Optional. The timespan over which to retrieve events. + + This is an ISO8601 time period value. This timespan is applied in + + addition to any that are specified in the Odata expression.' + defaultValue: None + types: + - + - name: filter + description: An expression used to filter the returned events + defaultValue: None + types: + - + - name: search + description: 'A free-text search expression to match for whether a + + particular event should be returned' + defaultValue: None + types: + - + - name: orderby + description: 'A comma-separated list of properties with "asc" + + (the default) or "desc" to control the order of returned events' + defaultValue: None + types: + - + - name: select + description: 'Limits the properties to just those requested on each + + returned event' + defaultValue: None + types: + - + - name: skip + description: The number of items to skip over before returning events + defaultValue: None + types: + - + - name: top + description: The number of events to return + defaultValue: None + types: + - + - name: format + description: Format for the returned events + defaultValue: None + types: + - + - name: count + description: 'Request a count of matching items included with the + + returned events' + defaultValue: None + types: + - + - name: apply + description: An expression used for aggregation over returned events + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: EventsResults or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.applicationinsights.models.ErrorResponseException +- uid: azure.applicationinsights.operations.EventsOperations.get_odata_metadata + name: get_odata_metadata + summary: 'Get OData metadata. + + + Gets OData EDMX metadata describing the event data model.' + signature: get_odata_metadata(app_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: 'ID of the application. This is Application ID from the + + API Access settings blade in the Azure portal.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: object or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.applicationinsights.models.ErrorResponseException +attributes: +- uid: azure.applicationinsights.operations.EventsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.MetricsOperations.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.MetricsOperations.yml new file mode 100644 index 00000000..de1bec87 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.MetricsOperations.yml @@ -0,0 +1,277 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.operations.MetricsOperations +name: MetricsOperations +fullName: azure.applicationinsights.operations.MetricsOperations +module: azure.applicationinsights.operations +summary: MetricsOperations operations. +constructor: + syntax: MetricsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.applicationinsights.operations.MetricsOperations.get + name: get + summary: 'Retrieve metric data. + + + Gets metric values for a single metric.' + signature: get(app_id, metric_id, timespan=None, interval=None, aggregation=None, + segment=None, top=None, orderby=None, filter=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: app_id + description: 'ID of the application. This is Application ID from the + + API Access settings blade in the Azure portal.' + isRequired: true + types: + - + - name: metric_id + description: 'ID of the metric. This is either a standard AI + + metric, or an application-specific custom metric. Possible values + + include: ''requests/count'', ''requests/duration'', ''requests/failed'', + + ''users/count'', ''users/authenticated'', ''pageViews/count'', + + ''pageViews/duration'', ''client/processingDuration'', + + ''client/receiveDuration'', ''client/networkDuration'', + + ''client/sendDuration'', ''client/totalDuration'', ''dependencies/count'', + + ''dependencies/failed'', ''dependencies/duration'', ''exceptions/count'', + + ''exceptions/browser'', ''exceptions/server'', ''sessions/count'', + + ''performanceCounters/requestExecutionTime'', + + ''performanceCounters/requestsPerSecond'', + + ''performanceCounters/requestsInQueue'', + + ''performanceCounters/memoryAvailableBytes'', + + ''performanceCounters/exceptionsPerSecond'', + + ''performanceCounters/processCpuPercentage'', + + ''performanceCounters/processIOBytesPerSecond'', + + ''performanceCounters/processPrivateBytes'', + + ''performanceCounters/processorCpuPercentage'', + + ''availabilityResults/availabilityPercentage'', + + ''availabilityResults/duration'', ''billing/telemetryCount'', + + ''customEvents/count''' + isRequired: true + types: + - + - + - name: timespan + description: 'The timespan over which to retrieve metric values. + + This is an ISO8601 time period value. If timespan is omitted, a + + default time range of *PT12H* ("last 12 hours") is used. The actual + + timespan that is queried may be adjusted by the server based. In all + + cases, the actual time span used for the query is included in the + + response.' + defaultValue: None + types: + - + - name: interval + description: 'The time interval to use when retrieving metric + + values. This is an ISO8601 duration. If interval is omitted, the + + metric value is aggregated across the entire timespan. If interval is + + supplied, the server may adjust the interval to a more appropriate + + size based on the timespan used for the query. In all cases, the + + actual interval used for the query is included in the response.' + defaultValue: None + types: + - + - name: aggregation + description: 'The aggregation to use when computing the metric + + values. To retrieve more than one aggregation at a time, separate them + + with a comma. If no aggregation is specified, then the default + + aggregation for the metric is used.' + defaultValue: None + types: + - [ + - ] + - name: segment + description: 'The name of the dimension to segment the metric values + + by. This dimension must be applicable to the metric you are + + retrieving. To segment by more than one dimension at a time, separate + + them with a comma (,). In this case, the metric data will be segmented + + in the order the dimensions are listed in the parameter.' + defaultValue: None + types: + - [ + - ] + - name: top + description: 'The number of segments to return. This value is only + + valid when segment is specified.' + defaultValue: None + types: + - + - name: orderby + description: 'The aggregation function and direction to sort the + + segments by. This value is only valid when segment is specified.' + defaultValue: None + types: + - + - name: filter + description: 'An expression used to filter the results. This value + + should be a valid OData filter expression where the keys of each + + clause should be applicable dimensions for the metric you are + + retrieving.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: MetricsResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.applicationinsights.models.ErrorResponseException +- uid: azure.applicationinsights.operations.MetricsOperations.get_metadata + name: get_metadata + summary: 'Retrieve metric metatadata. + + + Gets metadata describing the available metrics.' + signature: get_metadata(app_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: 'ID of the application. This is Application ID from the + + API Access settings blade in the Azure portal.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: object or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.applicationinsights.models.ErrorResponseException +- uid: azure.applicationinsights.operations.MetricsOperations.get_multiple + name: get_multiple + summary: 'Retrieve metric data. + + + Gets metric values for multiple metrics.' + signature: get_multiple(app_id, body, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: 'ID of the application. This is Application ID from the + + API Access settings blade in the Azure portal.' + isRequired: true + types: + - + - name: body + description: The batched metrics query. + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.applicationinsights.models.ErrorResponseException +attributes: +- uid: azure.applicationinsights.operations.MetricsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.QueryOperations.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.QueryOperations.yml new file mode 100644 index 00000000..07180f4d --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.QueryOperations.yml @@ -0,0 +1,77 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.operations.QueryOperations +name: QueryOperations +fullName: azure.applicationinsights.operations.QueryOperations +module: azure.applicationinsights.operations +summary: QueryOperations operations. +constructor: + syntax: QueryOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.applicationinsights.operations.QueryOperations.execute + name: execute + summary: 'Execute an Analytics query. + + + Executes an Analytics query for data. + + + [Here](https://dev.applicationinsights.io/documentation/Using-the-API/Query) + + is an example for using POST with an Analytics query.' + signature: execute(app_id, body, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: 'ID of the application. This is Application ID from the + + API Access settings blade in the Azure portal.' + isRequired: true + types: + - + - name: body + description: 'The Analytics query. Learn more about the [Analytics + + query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/).' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: QueryResults or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.applicationinsights.models.ErrorResponseException +attributes: +- uid: azure.applicationinsights.operations.QueryOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.events_operations.EventsOperations.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.events_operations.EventsOperations.yml new file mode 100644 index 00000000..7e893f2f --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.events_operations.EventsOperations.yml @@ -0,0 +1,258 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.operations.events_operations.EventsOperations +name: EventsOperations +fullName: azure.applicationinsights.operations.events_operations.EventsOperations +module: azure.applicationinsights.operations.events_operations +summary: EventsOperations operations. +constructor: + syntax: EventsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.applicationinsights.operations.events_operations.EventsOperations.get + name: get + summary: 'Get an event. + + + Gets the data for a single event.' + signature: get(app_id, event_type, event_id, timespan=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: 'ID of the application. This is Application ID from the + + API Access settings blade in the Azure portal.' + isRequired: true + types: + - + - name: event_type + description: 'The type of events to query; either a standard + + event type (*traces*, *customEvents*, *pageViews*, *requests*, + + *dependencies*, *exceptions*, *availabilityResults*) or *$all* to + + query across all event types. Possible values include: ''$all'', + + ''traces'', ''customEvents'', ''pageViews'', ''browserTimings'', ''requests'', + + ''dependencies'', ''exceptions'', ''availabilityResults'', + + ''performanceCounters'', ''customMetrics''' + isRequired: true + types: + - + - + - name: event_id + description: ID of event. + isRequired: true + types: + - + - name: timespan + description: 'Optional. The timespan over which to retrieve events. + + This is an ISO8601 time period value. This timespan is applied in + + addition to any that are specified in the Odata expression.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: EventsResults or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.applicationinsights.models.ErrorResponseException +- uid: azure.applicationinsights.operations.events_operations.EventsOperations.get_by_type + name: get_by_type + summary: 'Execute OData query. + + + Executes an OData query for events.' + signature: get_by_type(app_id, event_type, timespan=None, filter=None, search=None, + orderby=None, select=None, skip=None, top=None, format=None, count=None, apply=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: 'ID of the application. This is Application ID from the + + API Access settings blade in the Azure portal.' + isRequired: true + types: + - + - name: event_type + description: 'The type of events to query; either a standard + + event type (*traces*, *customEvents*, *pageViews*, *requests*, + + *dependencies*, *exceptions*, *availabilityResults*) or *$all* to + + query across all event types. Possible values include: ''$all'', + + ''traces'', ''customEvents'', ''pageViews'', ''browserTimings'', ''requests'', + + ''dependencies'', ''exceptions'', ''availabilityResults'', + + ''performanceCounters'', ''customMetrics''' + isRequired: true + types: + - + - + - name: timespan + description: 'Optional. The timespan over which to retrieve events. + + This is an ISO8601 time period value. This timespan is applied in + + addition to any that are specified in the Odata expression.' + defaultValue: None + types: + - + - name: filter + description: An expression used to filter the returned events + defaultValue: None + types: + - + - name: search + description: 'A free-text search expression to match for whether a + + particular event should be returned' + defaultValue: None + types: + - + - name: orderby + description: 'A comma-separated list of properties with "asc" + + (the default) or "desc" to control the order of returned events' + defaultValue: None + types: + - + - name: select + description: 'Limits the properties to just those requested on each + + returned event' + defaultValue: None + types: + - + - name: skip + description: The number of items to skip over before returning events + defaultValue: None + types: + - + - name: top + description: The number of events to return + defaultValue: None + types: + - + - name: format + description: Format for the returned events + defaultValue: None + types: + - + - name: count + description: 'Request a count of matching items included with the + + returned events' + defaultValue: None + types: + - + - name: apply + description: An expression used for aggregation over returned events + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: EventsResults or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.applicationinsights.models.ErrorResponseException +- uid: azure.applicationinsights.operations.events_operations.EventsOperations.get_odata_metadata + name: get_odata_metadata + summary: 'Get OData metadata. + + + Gets OData EDMX metadata describing the event data model.' + signature: get_odata_metadata(app_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: 'ID of the application. This is Application ID from the + + API Access settings blade in the Azure portal.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: object or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.applicationinsights.models.ErrorResponseException +attributes: +- uid: azure.applicationinsights.operations.events_operations.EventsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.events_operations.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.events_operations.yml new file mode 100644 index 00000000..c4e00e8e --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.events_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.operations.events_operations +name: events_operations +fullName: azure.applicationinsights.operations.events_operations +classes: +- azure.applicationinsights.operations.events_operations.EventsOperations diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.metrics_operations.MetricsOperations.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.metrics_operations.MetricsOperations.yml new file mode 100644 index 00000000..806578cf --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.metrics_operations.MetricsOperations.yml @@ -0,0 +1,277 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.operations.metrics_operations.MetricsOperations +name: MetricsOperations +fullName: azure.applicationinsights.operations.metrics_operations.MetricsOperations +module: azure.applicationinsights.operations.metrics_operations +summary: MetricsOperations operations. +constructor: + syntax: MetricsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.applicationinsights.operations.metrics_operations.MetricsOperations.get + name: get + summary: 'Retrieve metric data. + + + Gets metric values for a single metric.' + signature: get(app_id, metric_id, timespan=None, interval=None, aggregation=None, + segment=None, top=None, orderby=None, filter=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: app_id + description: 'ID of the application. This is Application ID from the + + API Access settings blade in the Azure portal.' + isRequired: true + types: + - + - name: metric_id + description: 'ID of the metric. This is either a standard AI + + metric, or an application-specific custom metric. Possible values + + include: ''requests/count'', ''requests/duration'', ''requests/failed'', + + ''users/count'', ''users/authenticated'', ''pageViews/count'', + + ''pageViews/duration'', ''client/processingDuration'', + + ''client/receiveDuration'', ''client/networkDuration'', + + ''client/sendDuration'', ''client/totalDuration'', ''dependencies/count'', + + ''dependencies/failed'', ''dependencies/duration'', ''exceptions/count'', + + ''exceptions/browser'', ''exceptions/server'', ''sessions/count'', + + ''performanceCounters/requestExecutionTime'', + + ''performanceCounters/requestsPerSecond'', + + ''performanceCounters/requestsInQueue'', + + ''performanceCounters/memoryAvailableBytes'', + + ''performanceCounters/exceptionsPerSecond'', + + ''performanceCounters/processCpuPercentage'', + + ''performanceCounters/processIOBytesPerSecond'', + + ''performanceCounters/processPrivateBytes'', + + ''performanceCounters/processorCpuPercentage'', + + ''availabilityResults/availabilityPercentage'', + + ''availabilityResults/duration'', ''billing/telemetryCount'', + + ''customEvents/count''' + isRequired: true + types: + - + - + - name: timespan + description: 'The timespan over which to retrieve metric values. + + This is an ISO8601 time period value. If timespan is omitted, a + + default time range of *PT12H* ("last 12 hours") is used. The actual + + timespan that is queried may be adjusted by the server based. In all + + cases, the actual time span used for the query is included in the + + response.' + defaultValue: None + types: + - + - name: interval + description: 'The time interval to use when retrieving metric + + values. This is an ISO8601 duration. If interval is omitted, the + + metric value is aggregated across the entire timespan. If interval is + + supplied, the server may adjust the interval to a more appropriate + + size based on the timespan used for the query. In all cases, the + + actual interval used for the query is included in the response.' + defaultValue: None + types: + - + - name: aggregation + description: 'The aggregation to use when computing the metric + + values. To retrieve more than one aggregation at a time, separate them + + with a comma. If no aggregation is specified, then the default + + aggregation for the metric is used.' + defaultValue: None + types: + - [ + - ] + - name: segment + description: 'The name of the dimension to segment the metric values + + by. This dimension must be applicable to the metric you are + + retrieving. To segment by more than one dimension at a time, separate + + them with a comma (,). In this case, the metric data will be segmented + + in the order the dimensions are listed in the parameter.' + defaultValue: None + types: + - [ + - ] + - name: top + description: 'The number of segments to return. This value is only + + valid when segment is specified.' + defaultValue: None + types: + - + - name: orderby + description: 'The aggregation function and direction to sort the + + segments by. This value is only valid when segment is specified.' + defaultValue: None + types: + - + - name: filter + description: 'An expression used to filter the results. This value + + should be a valid OData filter expression where the keys of each + + clause should be applicable dimensions for the metric you are + + retrieving.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: MetricsResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.applicationinsights.models.ErrorResponseException +- uid: azure.applicationinsights.operations.metrics_operations.MetricsOperations.get_metadata + name: get_metadata + summary: 'Retrieve metric metatadata. + + + Gets metadata describing the available metrics.' + signature: get_metadata(app_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: 'ID of the application. This is Application ID from the + + API Access settings blade in the Azure portal.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: object or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.applicationinsights.models.ErrorResponseException +- uid: azure.applicationinsights.operations.metrics_operations.MetricsOperations.get_multiple + name: get_multiple + summary: 'Retrieve metric data. + + + Gets metric values for multiple metrics.' + signature: get_multiple(app_id, body, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: 'ID of the application. This is Application ID from the + + API Access settings blade in the Azure portal.' + isRequired: true + types: + - + - name: body + description: The batched metrics query. + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.applicationinsights.models.ErrorResponseException +attributes: +- uid: azure.applicationinsights.operations.metrics_operations.MetricsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.metrics_operations.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.metrics_operations.yml new file mode 100644 index 00000000..e596f464 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.metrics_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.operations.metrics_operations +name: metrics_operations +fullName: azure.applicationinsights.operations.metrics_operations +classes: +- azure.applicationinsights.operations.metrics_operations.MetricsOperations diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.query_operations.QueryOperations.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.query_operations.QueryOperations.yml new file mode 100644 index 00000000..18349a39 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.query_operations.QueryOperations.yml @@ -0,0 +1,77 @@ +### YamlMime:PythonClass +uid: azure.applicationinsights.operations.query_operations.QueryOperations +name: QueryOperations +fullName: azure.applicationinsights.operations.query_operations.QueryOperations +module: azure.applicationinsights.operations.query_operations +summary: QueryOperations operations. +constructor: + syntax: QueryOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.applicationinsights.operations.query_operations.QueryOperations.execute + name: execute + summary: 'Execute an Analytics query. + + + Executes an Analytics query for data. + + + [Here](https://dev.applicationinsights.io/documentation/Using-the-API/Query) + + is an example for using POST with an Analytics query.' + signature: execute(app_id, body, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: 'ID of the application. This is Application ID from the + + API Access settings blade in the Azure portal.' + isRequired: true + types: + - + - name: body + description: 'The Analytics query. Learn more about the [Analytics + + query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/).' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: QueryResults or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.applicationinsights.models.ErrorResponseException +attributes: +- uid: azure.applicationinsights.operations.query_operations.QueryOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.query_operations.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.query_operations.yml new file mode 100644 index 00000000..8d3eeafc --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.query_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.operations.query_operations +name: query_operations +fullName: azure.applicationinsights.operations.query_operations +classes: +- azure.applicationinsights.operations.query_operations.QueryOperations diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.yml new file mode 100644 index 00000000..d956f78a --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.operations.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.applicationinsights.operations +name: operations +fullName: azure.applicationinsights.operations +type: import +classes: +- azure.applicationinsights.operations.EventsOperations +- azure.applicationinsights.operations.MetricsOperations +- azure.applicationinsights.operations.QueryOperations +modules: +- azure.applicationinsights.operations.events_operations +- azure.applicationinsights.operations.metrics_operations +- azure.applicationinsights.operations.query_operations diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.version.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.version.yml new file mode 100644 index 00000000..ca0e8558 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.applicationinsights.version +name: version +fullName: azure.applicationinsights.version diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.yml new file mode 100644 index 00000000..1b7966f4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.applicationinsights +name: applicationinsights +fullName: azure.applicationinsights +type: rootImport +classes: +- azure.applicationinsights.ApplicationInsightsDataClient +packages: +- azure.applicationinsights.models +- azure.applicationinsights.operations +modules: +- azure.applicationinsights.application_insights_data_client +- azure.applicationinsights.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.AnomalyDetectorClient.yml b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.AnomalyDetectorClient.yml new file mode 100644 index 00000000..43cba4fe --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.AnomalyDetectorClient.yml @@ -0,0 +1,176 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.anomalydetector.AnomalyDetectorClient +name: AnomalyDetectorClient +fullName: azure.cognitiveservices.anomalydetector.AnomalyDetectorClient +module: azure.cognitiveservices.anomalydetector +summary: The Anomaly Detector API detects anomalies automatically in time series data. + It supports two kinds of mode, one is for stateless using, another is for stateful + using. In stateless mode, there are three functionalities. Entire Detect is for + detecting the whole series with model trained by the time series, Last Detect is + detecting last point with model trained by points before. ChangePoint Detect is + for detecting trend changes in time series. In stateful mode, user can store time + series, the stored time series will be used for detection anomalies. Under this + mode, user can still use the above three functionalities by only giving a time range + without preparing time series in client side. Besides the above three functionalities, + stateful model also provide group based detection and labeling service. By leveraging + labeling service user can provide labels for each detection result, these labels + will be used for retuning or regenerating detection models. Inconsistency detection + is a kind of group based detection, this detection will find inconsistency ones + in a set of time series. By using anomaly detector service, business customers can + discover incidents and establish a logic flow for root cause analysis. +constructor: + syntax: AnomalyDetectorClient(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and + + hostname, for example: [https://westus2.api.cognitive.microsoft.com](https://westus2.api.cognitive.microsoft.com)).' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +methods: +- uid: azure.cognitiveservices.anomalydetector.AnomalyDetectorClient.change_point_detect + name: change_point_detect + summary: 'Detect change point for the entire series. + + + Evaluate change point score of every series point.' + signature: change_point_detect(body, custom_headers=None, raw=False, **operation_config) + parameters: + - name: body + description: 'Time series points and granularity is needed. Advanced + + model parameters can also be set in the request if needed.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ChangePointDetectResponse or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.anomalydetector.models.APIErrorException +- uid: azure.cognitiveservices.anomalydetector.AnomalyDetectorClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None +- uid: azure.cognitiveservices.anomalydetector.AnomalyDetectorClient.entire_detect + name: entire_detect + summary: 'Detect anomalies for the entire series in batch. + + + This operation generates a model using an entire series, each point is + + detected with the same model. With this method, points before and after + + a certain point are used to determine whether it is an anomaly. The + + entire detection can give user an overall status of the time series.' + signature: entire_detect(body, custom_headers=None, raw=False, **operation_config) + parameters: + - name: body + description: 'Time series points and period if needed. Advanced model + + parameters can also be set in the request.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: EntireDetectResponse or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.anomalydetector.models.APIErrorException +- uid: azure.cognitiveservices.anomalydetector.AnomalyDetectorClient.last_detect + name: last_detect + summary: 'Detect anomaly status of the latest point in time series. + + + This operation generates a model using points before the latest one. + + With this method, only historical points are used to determine whether + + the target point is an anomaly. The latest point detecting operation + + matches the scenario of real-time monitoring of business metrics.' + signature: last_detect(body, custom_headers=None, raw=False, **operation_config) + parameters: + - name: body + description: 'Time series points and period if needed. Advanced model + + parameters can also be set in the request.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: LastDetectResponse or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.anomalydetector.models.APIErrorException diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.AnomalyDetectorClientConfiguration.yml b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.AnomalyDetectorClientConfiguration.yml new file mode 100644 index 00000000..84a6fc38 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.AnomalyDetectorClientConfiguration.yml @@ -0,0 +1,62 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.anomalydetector.AnomalyDetectorClientConfiguration +name: AnomalyDetectorClientConfiguration +fullName: azure.cognitiveservices.anomalydetector.AnomalyDetectorClientConfiguration +module: azure.cognitiveservices.anomalydetector +summary: 'Configuration for AnomalyDetectorClient + + Note that all parameters used to create this instance are saved as instance + + attributes.' +constructor: + syntax: AnomalyDetectorClientConfiguration(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and + + hostname, for example: [https://westus2.api.cognitive.microsoft.com](https://westus2.api.cognitive.microsoft.com)).' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.anomalydetector.AnomalyDetectorClientConfiguration.add_user_agent + name: add_user_agent + summary: Add value to current user agent with a space. + signature: 'add_user_agent(value: str) -> None' + parameters: + - name: value + description: value to add to user agent. + isRequired: true + types: + - +- uid: azure.cognitiveservices.anomalydetector.AnomalyDetectorClientConfiguration.load + name: load + signature: load(filepath) + parameters: + - name: filepath + isRequired: true +- uid: azure.cognitiveservices.anomalydetector.AnomalyDetectorClientConfiguration.save + name: save + summary: Save current configuration to file. + signature: save(filepath) + parameters: + - name: filepath + description: Path to file where settings will be saved. + isRequired: true + types: + - + exceptions: + - type: ValueError if supplied filepath cannot be written to. +attributes: +- uid: azure.cognitiveservices.anomalydetector.AnomalyDetectorClientConfiguration.enable_http_logger + name: enable_http_logger +- uid: azure.cognitiveservices.anomalydetector.AnomalyDetectorClientConfiguration.user_agent + name: user_agent + summary: The current user agent value. diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.APIError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.APIError.yml new file mode 100644 index 00000000..444eb945 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.APIError.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.anomalydetector.models.APIError +name: APIError +fullName: azure.cognitiveservices.anomalydetector.models.APIError +module: azure.cognitiveservices.anomalydetector.models +summary: Error information returned by the API. +constructor: + syntax: 'APIError(*, code=None, message: str = None, **kwargs)' + parameters: + - name: code + description: The error code. + isRequired: true + types: + - + - name: message + description: A message explaining the error reported by the service. + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true +methods: +- uid: azure.cognitiveservices.anomalydetector.models.APIError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.anomalydetector.models.APIError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.anomalydetector.models.APIError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.anomalydetector.models.APIError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.anomalydetector.models.APIError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.anomalydetector.models.APIError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.anomalydetector.models.APIError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.APIErrorException.yml b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.APIErrorException.yml new file mode 100644 index 00000000..f1beb28a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.APIErrorException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.anomalydetector.models.APIErrorException +name: APIErrorException +fullName: azure.cognitiveservices.anomalydetector.models.APIErrorException +module: azure.cognitiveservices.anomalydetector.models +summary: 'Server responded with exception of type: ''APIError''.' +constructor: + syntax: APIErrorException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.cognitiveservices.anomalydetector.models.APIErrorException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cognitiveservices.anomalydetector.models.APIErrorException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cognitiveservices.anomalydetector.models.APIErrorException.args + name: args diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.ChangePointDetectRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.ChangePointDetectRequest.yml new file mode 100644 index 00000000..655db035 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.ChangePointDetectRequest.yml @@ -0,0 +1,188 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.anomalydetector.models.ChangePointDetectRequest +name: ChangePointDetectRequest +fullName: azure.cognitiveservices.anomalydetector.models.ChangePointDetectRequest +module: azure.cognitiveservices.anomalydetector.models +summary: 'ChangePointDetectRequest. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ChangePointDetectRequest(*, series, granularity, custom_interval: int = + None, period: int = None, stable_trend_window: int = None, threshold: float = + None, **kwargs)' + parameters: + - name: series + description: 'Required. Time series data points. Points should be sorted + + by timestamp in ascending order to match the change point detection + + result.' + isRequired: true + types: + - [] + - name: granularity + description: 'Required. Can only be one of yearly, monthly, weekly, + + daily, hourly, minutely or secondly. Granularity is used for verify + + whether input series is valid. Possible values include: ''yearly'', + + ''monthly'', ''weekly'', ''daily'', ''hourly'', ''minutely'', ''secondly''' + isRequired: true + types: + - + - + - name: custom_interval + description: 'Custom Interval is used to set non-standard time + + interval, for example, if the series is 5 minutes, request can be set as + + {"granularity":"minutely", "customInterval":5}.' + isRequired: true + types: + - + - name: period + description: 'Optional argument, periodic value of a time series. If the + + value is null or does not present, the API will determine the period + + automatically.' + isRequired: true + types: + - + - name: stable_trend_window + description: 'Optional argument, advanced model parameter, a + + default stableTrendWindow will be used in detection.' + isRequired: true + types: + - + - name: threshold + description: 'Optional argument, advanced model parameter, between + + 0.0-1.0, the lower the value is, the larger the trend error will be which + + means less change point will be accepted.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: series + isRequired: true + - name: granularity + isRequired: true + - name: custom_interval + isRequired: true + - name: period + isRequired: true + - name: stable_trend_window + isRequired: true + - name: threshold + isRequired: true +methods: +- uid: azure.cognitiveservices.anomalydetector.models.ChangePointDetectRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.anomalydetector.models.ChangePointDetectRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.anomalydetector.models.ChangePointDetectRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.anomalydetector.models.ChangePointDetectRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.anomalydetector.models.ChangePointDetectRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.anomalydetector.models.ChangePointDetectRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.anomalydetector.models.ChangePointDetectRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.ChangePointDetectResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.ChangePointDetectResponse.yml new file mode 100644 index 00000000..5800c41a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.ChangePointDetectResponse.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.anomalydetector.models.ChangePointDetectResponse +name: ChangePointDetectResponse +fullName: azure.cognitiveservices.anomalydetector.models.ChangePointDetectResponse +module: azure.cognitiveservices.anomalydetector.models +summary: 'ChangePointDetectResponse. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ChangePointDetectResponse(*, period: int, is_change_point, confidence_scores, + **kwargs)' + parameters: + - name: period + description: 'Required. Frequency extracted from the series, zero means + + no recurrent pattern has been found.' + isRequired: true + types: + - + - name: is_change_point + description: 'Required. isChangePoint contains change point + + properties for each input point. True means an anomaly either negative or + + positive has been detected. The index of the array is consistent with the + + input series.' + isRequired: true + types: + - [] + - name: confidence_scores + description: 'Required. the change point confidence of each + + point' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: period + isRequired: true + - name: is_change_point + isRequired: true + - name: confidence_scores + isRequired: true +methods: +- uid: azure.cognitiveservices.anomalydetector.models.ChangePointDetectResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.anomalydetector.models.ChangePointDetectResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.anomalydetector.models.ChangePointDetectResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.anomalydetector.models.ChangePointDetectResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.anomalydetector.models.ChangePointDetectResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.anomalydetector.models.ChangePointDetectResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.anomalydetector.models.ChangePointDetectResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.EntireDetectResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.EntireDetectResponse.yml new file mode 100644 index 00000000..469180b8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.EntireDetectResponse.yml @@ -0,0 +1,213 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.anomalydetector.models.EntireDetectResponse +name: EntireDetectResponse +fullName: azure.cognitiveservices.anomalydetector.models.EntireDetectResponse +module: azure.cognitiveservices.anomalydetector.models +summary: 'EntireDetectResponse. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EntireDetectResponse(*, period: int, expected_values, upper_margins, lower_margins, + is_anomaly, is_negative_anomaly, is_positive_anomaly, **kwargs)' + parameters: + - name: period + description: 'Required. Frequency extracted from the series, zero means + + no recurrent pattern has been found.' + isRequired: true + types: + - + - name: expected_values + description: 'Required. ExpectedValues contain expected value + + for each input point. The index of the array is consistent with the input + + series.' + isRequired: true + types: + - [] + - name: upper_margins + description: 'Required. UpperMargins contain upper margin of each + + input point. UpperMargin is used to calculate upperBoundary, which equals + + to expectedValue + (100 - marginScale)*upperMargin. Anomalies in response + + can be filtered by upperBoundary and lowerBoundary. By adjusting + + marginScale value, less significant anomalies can be filtered in client + + side. The index of the array is consistent with the input series.' + isRequired: true + types: + - [] + - name: lower_margins + description: 'Required. LowerMargins contain lower margin of each + + input point. LowerMargin is used to calculate lowerBoundary, which equals + + to expectedValue - (100 - marginScale)*lowerMargin. Points between the + + boundary can be marked as normal ones in client side. The index of the + + array is consistent with the input series.' + isRequired: true + types: + - [] + - name: is_anomaly + description: 'Required. IsAnomaly contains anomaly properties for + + each input point. True means an anomaly either negative or positive has + + been detected. The index of the array is consistent with the input series.' + isRequired: true + types: + - [] + - name: is_negative_anomaly + description: 'Required. IsNegativeAnomaly contains anomaly + + status in negative direction for each input point. True means a negative + + anomaly has been detected. A negative anomaly means the point is detected + + as an anomaly and its real value is smaller than the expected one. The + + index of the array is consistent with the input series.' + isRequired: true + types: + - [] + - name: is_positive_anomaly + description: 'Required. IsPositiveAnomaly contain anomaly + + status in positive direction for each input point. True means a positive + + anomaly has been detected. A positive anomaly means the point is detected + + as an anomaly and its real value is larger than the expected one. The + + index of the array is consistent with the input series.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: period + isRequired: true + - name: expected_values + isRequired: true + - name: upper_margins + isRequired: true + - name: lower_margins + isRequired: true + - name: is_anomaly + isRequired: true + - name: is_negative_anomaly + isRequired: true + - name: is_positive_anomaly + isRequired: true +methods: +- uid: azure.cognitiveservices.anomalydetector.models.EntireDetectResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.anomalydetector.models.EntireDetectResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.anomalydetector.models.EntireDetectResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.anomalydetector.models.EntireDetectResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.anomalydetector.models.EntireDetectResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.anomalydetector.models.EntireDetectResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.anomalydetector.models.EntireDetectResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.Granularity.yml b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.Granularity.yml new file mode 100644 index 00000000..2ec45768 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.Granularity.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.anomalydetector.models.Granularity +name: Granularity +fullName: azure.cognitiveservices.anomalydetector.models.Granularity +module: azure.cognitiveservices.anomalydetector.models +fields: +- name: daily + uid: azure.cognitiveservices.anomalydetector.models.Granularity.daily +- name: hourly + uid: azure.cognitiveservices.anomalydetector.models.Granularity.hourly +- name: minutely + uid: azure.cognitiveservices.anomalydetector.models.Granularity.minutely +- name: monthly + uid: azure.cognitiveservices.anomalydetector.models.Granularity.monthly +- name: secondly + uid: azure.cognitiveservices.anomalydetector.models.Granularity.secondly +- name: weekly + uid: azure.cognitiveservices.anomalydetector.models.Granularity.weekly +- name: yearly + uid: azure.cognitiveservices.anomalydetector.models.Granularity.yearly diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.LastDetectResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.LastDetectResponse.yml new file mode 100644 index 00000000..77ac4984 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.LastDetectResponse.yml @@ -0,0 +1,207 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.anomalydetector.models.LastDetectResponse +name: LastDetectResponse +fullName: azure.cognitiveservices.anomalydetector.models.LastDetectResponse +module: azure.cognitiveservices.anomalydetector.models +summary: 'LastDetectResponse. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'LastDetectResponse(*, period: int, suggested_window: int, expected_value: + float, upper_margin: float, lower_margin: float, is_anomaly: bool, is_negative_anomaly: + bool, is_positive_anomaly: bool, **kwargs)' + parameters: + - name: period + description: 'Required. Frequency extracted from the series, zero means + + no recurrent pattern has been found.' + isRequired: true + types: + - + - name: suggested_window + description: 'Required. Suggested input series points needed + + for detecting the latest point.' + isRequired: true + types: + - + - name: expected_value + description: Required. Expected value of the latest point. + isRequired: true + types: + - + - name: upper_margin + description: 'Required. Upper margin of the latest point. + + UpperMargin is used to calculate upperBoundary, which equals to + + expectedValue + (100 - marginScale)*upperMargin. If the value of latest + + point is between upperBoundary and lowerBoundary, it should be treated as + + normal value. By adjusting marginScale value, anomaly status of latest + + point can be changed.' + isRequired: true + types: + - + - name: lower_margin + description: 'Required. Lower margin of the latest point. + + LowerMargin is used to calculate lowerBoundary, which equals to + + expectedValue - (100 - marginScale)*lowerMargin.' + isRequired: true + types: + - + - name: is_anomaly + description: 'Required. Anomaly status of the latest point, true + + means the latest point is an anomaly either in negative direction or + + positive direction.' + isRequired: true + types: + - + - name: is_negative_anomaly + description: 'Required. Anomaly status in negative direction + + of the latest point. True means the latest point is an anomaly and its + + real value is smaller than the expected one.' + isRequired: true + types: + - + - name: is_positive_anomaly + description: 'Required. Anomaly status in positive direction + + of the latest point. True means the latest point is an anomaly and its + + real value is larger than the expected one.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: period + isRequired: true + - name: suggested_window + isRequired: true + - name: expected_value + isRequired: true + - name: upper_margin + isRequired: true + - name: lower_margin + isRequired: true + - name: is_anomaly + isRequired: true + - name: is_negative_anomaly + isRequired: true + - name: is_positive_anomaly + isRequired: true +methods: +- uid: azure.cognitiveservices.anomalydetector.models.LastDetectResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.anomalydetector.models.LastDetectResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.anomalydetector.models.LastDetectResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.anomalydetector.models.LastDetectResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.anomalydetector.models.LastDetectResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.anomalydetector.models.LastDetectResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.anomalydetector.models.LastDetectResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.Point.yml b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.Point.yml new file mode 100644 index 00000000..58ed4827 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.Point.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.anomalydetector.models.Point +name: Point +fullName: azure.cognitiveservices.anomalydetector.models.Point +module: azure.cognitiveservices.anomalydetector.models +summary: 'Point. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Point(*, timestamp, value: float, **kwargs)' + parameters: + - name: timestamp + description: Required. Timestamp of a data point (ISO8601 format). + isRequired: true + types: + - + - name: value + description: Required. The measurement of that point, should be float. + isRequired: true + types: + - + keywordOnlyParameters: + - name: timestamp + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.cognitiveservices.anomalydetector.models.Point.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.anomalydetector.models.Point.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.anomalydetector.models.Point.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.anomalydetector.models.Point.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.anomalydetector.models.Point.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.anomalydetector.models.Point.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.anomalydetector.models.Point.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.Request.yml b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.Request.yml new file mode 100644 index 00000000..f286c1a2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.Request.yml @@ -0,0 +1,185 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.anomalydetector.models.Request +name: Request +fullName: azure.cognitiveservices.anomalydetector.models.Request +module: azure.cognitiveservices.anomalydetector.models +summary: 'Request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Request(*, series, granularity, custom_interval: int = None, period: int + = None, max_anomaly_ratio: float = None, sensitivity: int = None, **kwargs)' + parameters: + - name: series + description: 'Required. Time series data points. Points should be sorted + + by timestamp in ascending order to match the anomaly detection result. If + + the data is not sorted correctly or there is duplicated timestamp, the API + + will not work. In such case, an error message will be returned.' + isRequired: true + types: + - [] + - name: granularity + description: 'Required. Possible values include: ''yearly'', + + ''monthly'', ''weekly'', ''daily'', ''hourly'', ''minutely'', ''secondly''' + isRequired: true + types: + - + - + - name: custom_interval + description: 'Custom Interval is used to set non-standard time + + interval, for example, if the series is 5 minutes, request can be set as + + {"granularity":"minutely", "customInterval":5}.' + isRequired: true + types: + - + - name: period + description: 'Optional argument, periodic value of a time series. If the + + value is null or does not present, the API will determine the period + + automatically.' + isRequired: true + types: + - + - name: max_anomaly_ratio + description: 'Optional argument, advanced model parameter, max + + anomaly ratio in a time series.' + isRequired: true + types: + - + - name: sensitivity + description: 'Optional argument, advanced model parameter, between + + 0-99, the lower the value is, the larger the margin value will be which + + means less anomalies will be accepted.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: series + isRequired: true + - name: granularity + isRequired: true + - name: custom_interval + isRequired: true + - name: period + isRequired: true + - name: max_anomaly_ratio + isRequired: true + - name: sensitivity + isRequired: true +methods: +- uid: azure.cognitiveservices.anomalydetector.models.Request.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.anomalydetector.models.Request.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.anomalydetector.models.Request.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.anomalydetector.models.Request.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.anomalydetector.models.Request.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.anomalydetector.models.Request.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.anomalydetector.models.Request.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.yml b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.yml new file mode 100644 index 00000000..6bc2c952 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.anomalydetector.models +name: models +fullName: azure.cognitiveservices.anomalydetector.models +type: import +classes: +- azure.cognitiveservices.anomalydetector.models.APIError +- azure.cognitiveservices.anomalydetector.models.APIErrorException +- azure.cognitiveservices.anomalydetector.models.ChangePointDetectRequest +- azure.cognitiveservices.anomalydetector.models.ChangePointDetectResponse +- azure.cognitiveservices.anomalydetector.models.EntireDetectResponse +- azure.cognitiveservices.anomalydetector.models.LastDetectResponse +- azure.cognitiveservices.anomalydetector.models.Point +- azure.cognitiveservices.anomalydetector.models.Request +enums: +- azure.cognitiveservices.anomalydetector.models.Granularity diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.operations.AnomalyDetectorClientOperationsMixin.yml b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.operations.AnomalyDetectorClientOperationsMixin.yml new file mode 100644 index 00000000..73c04d32 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.operations.AnomalyDetectorClientOperationsMixin.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.anomalydetector.operations.AnomalyDetectorClientOperationsMixin +name: AnomalyDetectorClientOperationsMixin +fullName: azure.cognitiveservices.anomalydetector.operations.AnomalyDetectorClientOperationsMixin +module: azure.cognitiveservices.anomalydetector.operations +constructor: + syntax: AnomalyDetectorClientOperationsMixin() +methods: +- uid: azure.cognitiveservices.anomalydetector.operations.AnomalyDetectorClientOperationsMixin.change_point_detect + name: change_point_detect + summary: 'Detect change point for the entire series. + + + Evaluate change point score of every series point.' + signature: change_point_detect(body, custom_headers=None, raw=False, **operation_config) + parameters: + - name: body + description: 'Time series points and granularity is needed. Advanced + + model parameters can also be set in the request if needed.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ChangePointDetectResponse or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.anomalydetector.models.APIErrorException +- uid: azure.cognitiveservices.anomalydetector.operations.AnomalyDetectorClientOperationsMixin.entire_detect + name: entire_detect + summary: 'Detect anomalies for the entire series in batch. + + + This operation generates a model using an entire series, each point is + + detected with the same model. With this method, points before and after + + a certain point are used to determine whether it is an anomaly. The + + entire detection can give user an overall status of the time series.' + signature: entire_detect(body, custom_headers=None, raw=False, **operation_config) + parameters: + - name: body + description: 'Time series points and period if needed. Advanced model + + parameters can also be set in the request.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: EntireDetectResponse or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.anomalydetector.models.APIErrorException +- uid: azure.cognitiveservices.anomalydetector.operations.AnomalyDetectorClientOperationsMixin.last_detect + name: last_detect + summary: 'Detect anomaly status of the latest point in time series. + + + This operation generates a model using points before the latest one. + + With this method, only historical points are used to determine whether + + the target point is an anomaly. The latest point detecting operation + + matches the scenario of real-time monitoring of business metrics.' + signature: last_detect(body, custom_headers=None, raw=False, **operation_config) + parameters: + - name: body + description: 'Time series points and period if needed. Advanced model + + parameters can also be set in the request.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: LastDetectResponse or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.anomalydetector.models.APIErrorException diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.operations.yml new file mode 100644 index 00000000..54728367 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.operations.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.anomalydetector.operations +name: operations +fullName: azure.cognitiveservices.anomalydetector.operations +type: import +classes: +- azure.cognitiveservices.anomalydetector.operations.AnomalyDetectorClientOperationsMixin diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.version.yml b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.version.yml new file mode 100644 index 00000000..ccabf63a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.anomalydetector.version +name: version +fullName: azure.cognitiveservices.anomalydetector.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.yml b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.yml new file mode 100644 index 00000000..02dc6b00 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.anomalydetector +name: anomalydetector +fullName: azure.cognitiveservices.anomalydetector +type: rootImport +classes: +- azure.cognitiveservices.anomalydetector.AnomalyDetectorClient +- azure.cognitiveservices.anomalydetector.AnomalyDetectorClientConfiguration +packages: +- azure.cognitiveservices.anomalydetector.models +- azure.cognitiveservices.anomalydetector.operations +modules: +- azure.cognitiveservices.anomalydetector.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.QnAMakerClient.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.QnAMakerClient.yml new file mode 100644 index 00000000..a4130380 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.QnAMakerClient.yml @@ -0,0 +1,53 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.QnAMakerClient +name: QnAMakerClient +fullName: azure.cognitiveservices.knowledge.qnamaker.QnAMakerClient +module: azure.cognitiveservices.knowledge.qnamaker +summary: An API for QnAMaker Service +constructor: + syntax: QnAMakerClient(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoint (e.g., [https:/](https:/)/< + + qnamaker-resource-name >.api.cognitiveservices.azure.com).' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +- description: EndpointSettings operations + name: endpoint_settings + types: + - +- description: EndpointKeys operations + name: endpoint_keys + types: + - +- description: Alterations operations + name: alterations + types: + - +- description: Knowledgebase operations + name: knowledgebase + types: + - +- description: Operations operations + name: operations + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.QnAMakerClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ActiveLearningSettingsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ActiveLearningSettingsDTO.yml new file mode 100644 index 00000000..2d8883e7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ActiveLearningSettingsDTO.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.ActiveLearningSettingsDTO +name: ActiveLearningSettingsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.ActiveLearningSettingsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: Active Learning settings of the endpoint. +constructor: + syntax: 'ActiveLearningSettingsDTO(*, enable: str = None, **kwargs)' + parameters: + - name: enable + description: True/False string providing Active Learning + isRequired: true + types: + - + keywordOnlyParameters: + - name: enable + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ActiveLearningSettingsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ActiveLearningSettingsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ActiveLearningSettingsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ActiveLearningSettingsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ActiveLearningSettingsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ActiveLearningSettingsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ActiveLearningSettingsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.AlterationsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.AlterationsDTO.yml new file mode 100644 index 00000000..a8519f27 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.AlterationsDTO.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.AlterationsDTO +name: AlterationsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.AlterationsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: 'Collection of words that are synonyms. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: AlterationsDTO(*, alterations, **kwargs) + parameters: + - name: alterations + description: Required. Words that are synonymous with each other. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: alterations + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.AlterationsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.AlterationsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.AlterationsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.AlterationsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.AlterationsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.AlterationsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.AlterationsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanRequestDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanRequestDTO.yml new file mode 100644 index 00000000..07c86585 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanRequestDTO.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanRequestDTO +name: AnswerSpanRequestDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanRequestDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: To configure Answer span prediction feature. +constructor: + syntax: 'AnswerSpanRequestDTO(*, enable: bool = None, score_threshold: float = None, + top_answers_with_span: int = None, **kwargs)' + parameters: + - name: enable + description: Enable or Disable Answer Span prediction. + isRequired: true + types: + - + - name: score_threshold + description: 'Minimum threshold score required to include an + + answer span.' + isRequired: true + types: + - + - name: top_answers_with_span + description: 'Number of Top answers to be considered for + + span prediction.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: enable + isRequired: true + - name: score_threshold + isRequired: true + - name: top_answers_with_span + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanRequestDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanRequestDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanRequestDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanRequestDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanRequestDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanRequestDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanRequestDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanResponseDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanResponseDTO.yml new file mode 100644 index 00000000..f3205137 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanResponseDTO.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanResponseDTO +name: AnswerSpanResponseDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanResponseDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: Answer span object of QnA. +constructor: + syntax: 'AnswerSpanResponseDTO(*, text: str = None, score: float = None, start_index: + int = None, end_index: int = None, **kwargs)' + parameters: + - name: text + description: Predicted text of answer span. + isRequired: true + types: + - + - name: score + description: Predicted score of answer span. + isRequired: true + types: + - + - name: start_index + description: Start index of answer span in answer. + isRequired: true + types: + - + - name: end_index + description: End index of answer span in answer. + isRequired: true + types: + - + keywordOnlyParameters: + - name: text + isRequired: true + - name: score + isRequired: true + - name: start_index + isRequired: true + - name: end_index + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanResponseDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanResponseDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanResponseDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanResponseDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanResponseDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanResponseDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanResponseDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ContextDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ContextDTO.yml new file mode 100644 index 00000000..130505a2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ContextDTO.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.ContextDTO +name: ContextDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.ContextDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: Context associated with Qna. +constructor: + syntax: 'ContextDTO(*, is_context_only: bool = None, prompts=None, **kwargs)' + parameters: + - name: is_context_only + description: 'To mark if a prompt is relevant only with a + + previous question or not. + + true - Do not include this QnA as search result for queries without + + context + + false - ignores context and includes this QnA in search result' + isRequired: true + types: + - + - name: prompts + description: List of prompts associated with the answer. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: is_context_only + isRequired: true + - name: prompts + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ContextDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ContextDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ContextDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ContextDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ContextDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ContextDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ContextDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.CreateKbDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.CreateKbDTO.yml new file mode 100644 index 00000000..5e078dc0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.CreateKbDTO.yml @@ -0,0 +1,206 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.CreateKbDTO +name: CreateKbDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.CreateKbDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: 'Post body schema for CreateKb operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CreateKbDTO(*, name: str, qna_list=None, urls=None, files=None, enable_hierarchical_extraction: + bool = None, default_answer_used_for_extraction: str = None, language: str = None, + enable_multiple_languages: bool = None, default_answer: str = None, **kwargs)' + parameters: + - name: name + description: Required. Friendly name for the knowledgebase. + isRequired: true + types: + - + - name: qna_list + description: 'List of Q-A (QnADTO) to be added to the knowledgebase. + + Q-A Ids are assigned by the service and should be omitted.' + isRequired: true + types: + - [] + - name: urls + description: List of URLs to be used for extracting Q-A. + isRequired: true + types: + - [] + - name: files + description: List of files from which to Extract Q-A. + isRequired: true + types: + - [] + - name: enable_hierarchical_extraction + description: 'Enable hierarchical extraction of + + Q-A from files and urls. Value to be considered False if this field is not + + present.' + isRequired: true + types: + - + - name: default_answer_used_for_extraction + description: 'Text string to be used as the + + answer in any Q-A which has no extracted answer from the document but has + + a hierarchy. Required when EnableHierarchicalExtraction field is set to + + True.' + isRequired: true + types: + - + - name: language + description: 'Language of the knowledgebase. Please find the list of + + supported languages here.' + isRequired: true + types: + - + - name: enable_multiple_languages + description: 'Set to true to enable creating KBs in + + different languages for the same resource.' + isRequired: true + types: + - + - name: default_answer + description: 'Default answer sent to user if no good match is + + found in the KB.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: qna_list + isRequired: true + - name: urls + isRequired: true + - name: files + isRequired: true + - name: enable_hierarchical_extraction + isRequired: true + - name: default_answer_used_for_extraction + isRequired: true + - name: language + isRequired: true + - name: enable_multiple_languages + isRequired: true + - name: default_answer + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.CreateKbDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.CreateKbDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.CreateKbDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.CreateKbDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.CreateKbDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.CreateKbDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.CreateKbDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.CreateKbInputDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.CreateKbInputDTO.yml new file mode 100644 index 00000000..f8c0bd09 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.CreateKbInputDTO.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.CreateKbInputDTO +name: CreateKbInputDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.CreateKbInputDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: Input to create KB. +constructor: + syntax: CreateKbInputDTO(*, qna_list=None, urls=None, files=None, **kwargs) + parameters: + - name: qna_list + description: 'List of QNA to be added to the index. Ids are generated + + by the service and should be omitted.' + isRequired: true + types: + - [] + - name: urls + description: List of URLs to be added to knowledgebase. + isRequired: true + types: + - [] + - name: files + description: List of files to be added to knowledgebase. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: qna_list + isRequired: true + - name: urls + isRequired: true + - name: files + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.CreateKbInputDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.CreateKbInputDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.CreateKbInputDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.CreateKbInputDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.CreateKbInputDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.CreateKbInputDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.CreateKbInputDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.DeleteKbContentsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.DeleteKbContentsDTO.yml new file mode 100644 index 00000000..42a42691 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.DeleteKbContentsDTO.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.DeleteKbContentsDTO +name: DeleteKbContentsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.DeleteKbContentsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: PATCH body schema of Delete Operation in UpdateKb. +constructor: + syntax: DeleteKbContentsDTO(*, ids=None, sources=None, **kwargs) + parameters: + - name: ids + description: List of Qna Ids to be deleted + isRequired: true + types: + - [] + - name: sources + description: List of sources to be deleted from knowledgebase. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: ids + isRequired: true + - name: sources + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.DeleteKbContentsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.DeleteKbContentsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.DeleteKbContentsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.DeleteKbContentsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.DeleteKbContentsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.DeleteKbContentsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.DeleteKbContentsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointKeysDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointKeysDTO.yml new file mode 100644 index 00000000..f3463f6e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointKeysDTO.yml @@ -0,0 +1,153 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointKeysDTO +name: EndpointKeysDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.EndpointKeysDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: Schema for EndpointKeys generate/refresh operations. +constructor: + syntax: 'EndpointKeysDTO(*, primary_endpoint_key: str = None, secondary_endpoint_key: + str = None, installed_version: str = None, last_stable_version: str = None, language: + str = None, **kwargs)' + parameters: + - name: primary_endpoint_key + description: Primary Access Key. + isRequired: true + types: + - + - name: secondary_endpoint_key + description: Secondary Access Key. + isRequired: true + types: + - + - name: installed_version + description: Current version of runtime. + isRequired: true + types: + - + - name: last_stable_version + description: Latest version of runtime. + isRequired: true + types: + - + - name: language + description: Language setting of runtime. + isRequired: true + types: + - + keywordOnlyParameters: + - name: primary_endpoint_key + isRequired: true + - name: secondary_endpoint_key + isRequired: true + - name: installed_version + isRequired: true + - name: last_stable_version + isRequired: true + - name: language + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointKeysDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointKeysDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointKeysDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointKeysDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointKeysDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointKeysDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointKeysDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTO.yml new file mode 100644 index 00000000..36aa348e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTO.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTO +name: EndpointSettingsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: Endpoint settings. +constructor: + syntax: EndpointSettingsDTO(*, active_learning=None, **kwargs) + parameters: + - name: active_learning + description: Active Learning settings of the endpoint. + isRequired: true + types: + - + keywordOnlyParameters: + - name: active_learning + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTOActiveLearning.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTOActiveLearning.yml new file mode 100644 index 00000000..c666ed6b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTOActiveLearning.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTOActiveLearning +name: EndpointSettingsDTOActiveLearning +fullName: azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTOActiveLearning +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: Active Learning settings of the endpoint. +constructor: + syntax: 'EndpointSettingsDTOActiveLearning(*, enable: str = None, **kwargs)' + parameters: + - name: enable + description: True/False string providing Active Learning + isRequired: true + types: + - + keywordOnlyParameters: + - name: enable + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTOActiveLearning.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTOActiveLearning.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTOActiveLearning.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTOActiveLearning.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTOActiveLearning.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTOActiveLearning.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTOActiveLearning.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EnvironmentType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EnvironmentType.yml new file mode 100644 index 00000000..e4b6cc54 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EnvironmentType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.knowledge.qnamaker.models.EnvironmentType +name: EnvironmentType +fullName: azure.cognitiveservices.knowledge.qnamaker.models.EnvironmentType +module: azure.cognitiveservices.knowledge.qnamaker.models +fields: +- name: prod + uid: azure.cognitiveservices.knowledge.qnamaker.models.EnvironmentType.prod +- name: test + uid: azure.cognitiveservices.knowledge.qnamaker.models.EnvironmentType.test diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.Error(class).yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.Error(class).yml new file mode 100644 index 00000000..989d4ddb --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.Error(class).yml @@ -0,0 +1,172 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.Error +name: Error +fullName: azure.cognitiveservices.knowledge.qnamaker.models.Error +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: 'The error object. As per Microsoft One API guidelines - + + [https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses](https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Error(*, code, message: str = None, target: str = None, details=None, inner_error=None, + **kwargs)' + parameters: + - name: code + description: 'Required. One of a server-defined set of error codes. + + Possible values include: ''BadArgument'', ''Forbidden'', ''NotFound'', + + ''KbNotFound'', ''Unauthorized'', ''Unspecified'', ''EndpointKeysError'', + + ''QuotaExceeded'', ''QnaRuntimeError'', ''SKULimitExceeded'', + + ''OperationNotFound'', ''ServiceError'', ''ValidationFailure'', + + ''ExtractionFailure''' + isRequired: true + types: + - + - + - name: message + description: A human-readable representation of the error. + isRequired: true + types: + - + - name: target + description: The target of the error. + isRequired: true + types: + - + - name: details + description: 'An array of details about specific errors that led to this + + reported error.' + isRequired: true + types: + - [] + - name: inner_error + description: 'An object containing more specific information than + + the current object about the error.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true + - name: target + isRequired: true + - name: details + isRequired: true + - name: inner_error + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.Error.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.Error.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.Error.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.Error.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.Error.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.Error.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.Error.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorCodeType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorCodeType.yml new file mode 100644 index 00000000..148d2d4f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorCodeType.yml @@ -0,0 +1,34 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorCodeType +name: ErrorCodeType +fullName: azure.cognitiveservices.knowledge.qnamaker.models.ErrorCodeType +module: azure.cognitiveservices.knowledge.qnamaker.models +fields: +- name: bad_argument + uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorCodeType.bad_argument +- name: endpoint_keys_error + uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorCodeType.endpoint_keys_error +- name: extraction_failure + uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorCodeType.extraction_failure +- name: forbidden + uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorCodeType.forbidden +- name: kb_not_found + uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorCodeType.kb_not_found +- name: not_found + uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorCodeType.not_found +- name: operation_not_found + uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorCodeType.operation_not_found +- name: qna_runtime_error + uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorCodeType.qna_runtime_error +- name: quota_exceeded + uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorCodeType.quota_exceeded +- name: service_error + uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorCodeType.service_error +- name: sku_limit_exceeded + uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorCodeType.sku_limit_exceeded +- name: unauthorized + uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorCodeType.unauthorized +- name: unspecified + uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorCodeType.unspecified +- name: validation_failure + uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorCodeType.validation_failure diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponse.yml new file mode 100644 index 00000000..b437a9dc --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponse.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponse +name: ErrorResponse +fullName: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponse +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: 'Error response. As per Microsoft One API guidelines - + + [https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses](https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).' +constructor: + syntax: ErrorResponse(*, error=None, **kwargs) + parameters: + - name: error + description: The error object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: error + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseError.yml new file mode 100644 index 00000000..3abf9467 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseError.yml @@ -0,0 +1,170 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseError +name: ErrorResponseError +fullName: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseError +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: 'The error object. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ErrorResponseError(*, code, message: str = None, target: str = None, details=None, + inner_error=None, **kwargs)' + parameters: + - name: code + description: 'Required. One of a server-defined set of error codes. + + Possible values include: ''BadArgument'', ''Forbidden'', ''NotFound'', + + ''KbNotFound'', ''Unauthorized'', ''Unspecified'', ''EndpointKeysError'', + + ''QuotaExceeded'', ''QnaRuntimeError'', ''SKULimitExceeded'', + + ''OperationNotFound'', ''ServiceError'', ''ValidationFailure'', + + ''ExtractionFailure''' + isRequired: true + types: + - + - + - name: message + description: A human-readable representation of the error. + isRequired: true + types: + - + - name: target + description: The target of the error. + isRequired: true + types: + - + - name: details + description: 'An array of details about specific errors that led to this + + reported error.' + isRequired: true + types: + - [] + - name: inner_error + description: 'An object containing more specific information than + + the current object about the error.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true + - name: target + isRequired: true + - name: details + isRequired: true + - name: inner_error + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException.yml new file mode 100644 index 00000000..d4ea952f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +name: ErrorResponseException +fullName: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: 'Server responded with exception of type: ''ErrorResponse''.' +constructor: + syntax: ErrorResponseException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException.args + name: args diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordDTO.yml new file mode 100644 index 00000000..b919ae8f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordDTO.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordDTO +name: FeedbackRecordDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: Active learning feedback record. +constructor: + syntax: 'FeedbackRecordDTO(*, user_id: str = None, user_question: str = None, qna_id: + int = None, **kwargs)' + parameters: + - name: user_id + description: Unique identifier for the user. + isRequired: true + types: + - + - name: user_question + description: The suggested question being provided as feedback. + isRequired: true + types: + - + - name: qna_id + description: 'The qnaId for which the suggested question is provided as + + feedback.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: user_id + isRequired: true + - name: user_question + isRequired: true + - name: qna_id + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordsDTO.yml new file mode 100644 index 00000000..56e0ea3c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordsDTO.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordsDTO +name: FeedbackRecordsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: Active learning feedback records. +constructor: + syntax: FeedbackRecordsDTO(*, feedback_records=None, **kwargs) + parameters: + - name: feedback_records + description: List of feedback records. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: feedback_records + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.FileDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.FileDTO.yml new file mode 100644 index 00000000..d2ffdc69 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.FileDTO.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.FileDTO +name: FileDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.FileDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: 'DTO to hold details of uploaded files. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'FileDTO(*, file_name: str, file_uri: str, **kwargs)' + parameters: + - name: file_name + description: 'Required. File name. Supported file types are ".tsv", + + ".pdf", ".txt", ".docx", ".xlsx".' + isRequired: true + types: + - + - name: file_uri + description: Required. Public URI of the file. + isRequired: true + types: + - + keywordOnlyParameters: + - name: file_name + isRequired: true + - name: file_uri + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.FileDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.FileDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.FileDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.FileDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.FileDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.FileDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.FileDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.InnerErrorModel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.InnerErrorModel.yml new file mode 100644 index 00000000..3438abe0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.InnerErrorModel.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.InnerErrorModel +name: InnerErrorModel +fullName: azure.cognitiveservices.knowledge.qnamaker.models.InnerErrorModel +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: 'An object containing more specific information about the error. As per + + Microsoft One API guidelines - + + [https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses](https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).' +constructor: + syntax: 'InnerErrorModel(*, code: str = None, inner_error=None, **kwargs)' + parameters: + - name: code + description: 'A more specific error code than was provided by the + + containing error.' + isRequired: true + types: + - + - name: inner_error + description: 'An object containing more specific information than + + the current object about the error.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: inner_error + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.InnerErrorModel.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.InnerErrorModel.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.InnerErrorModel.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.InnerErrorModel.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.InnerErrorModel.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.InnerErrorModel.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.InnerErrorModel.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebaseDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebaseDTO.yml new file mode 100644 index 00000000..fbcd9cac --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebaseDTO.yml @@ -0,0 +1,191 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebaseDTO +name: KnowledgebaseDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebaseDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: Response schema for CreateKb operation. +constructor: + syntax: 'KnowledgebaseDTO(*, id: str = None, host_name: str = None, last_accessed_timestamp: + str = None, last_changed_timestamp: str = None, last_published_timestamp: str + = None, name: str = None, user_id: str = None, urls=None, sources=None, **kwargs)' + parameters: + - name: id + description: Unique id that identifies a knowledgebase. + isRequired: true + types: + - + - name: host_name + description: URL host name at which the knowledgebase is hosted. + isRequired: true + types: + - + - name: last_accessed_timestamp + description: 'Time stamp at which the knowledgebase was + + last accessed (UTC).' + isRequired: true + types: + - + - name: last_changed_timestamp + description: 'Time stamp at which the knowledgebase was + + last modified (UTC).' + isRequired: true + types: + - + - name: last_published_timestamp + description: 'Time stamp at which the knowledgebase was + + last published (UTC).' + isRequired: true + types: + - + - name: name + description: Friendly name of the knowledgebase. + isRequired: true + types: + - + - name: user_id + description: User who created / owns the knowledgebase. + isRequired: true + types: + - + - name: urls + description: 'URL sources from which Q-A were extracted and added to the + + knowledgebase.' + isRequired: true + types: + - [] + - name: sources + description: 'Custom sources from which Q-A were extracted or explicitly + + added to the knowledgebase.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: host_name + isRequired: true + - name: last_accessed_timestamp + isRequired: true + - name: last_changed_timestamp + isRequired: true + - name: last_published_timestamp + isRequired: true + - name: name + isRequired: true + - name: user_id + isRequired: true + - name: urls + isRequired: true + - name: sources + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebaseDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebaseDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebaseDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebaseDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebaseDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebaseDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebaseDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebasesDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebasesDTO.yml new file mode 100644 index 00000000..3d6ab216 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebasesDTO.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebasesDTO +name: KnowledgebasesDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebasesDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: Collection of knowledgebases owned by a user. +constructor: + syntax: KnowledgebasesDTO(*, knowledgebases=None, **kwargs) + parameters: + - name: knowledgebases + description: Collection of knowledgebase records. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: knowledgebases + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebasesDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebasesDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebasesDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebasesDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebasesDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebasesDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebasesDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.MetadataDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.MetadataDTO.yml new file mode 100644 index 00000000..4a8145db --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.MetadataDTO.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.MetadataDTO +name: MetadataDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.MetadataDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: 'Name - value pair of metadata. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MetadataDTO(*, name: str, value: str, **kwargs)' + parameters: + - name: name + description: Required. Metadata name. + isRequired: true + types: + - + - name: value + description: Required. Metadata value. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.MetadataDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.MetadataDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.MetadataDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.MetadataDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.MetadataDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.MetadataDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.MetadataDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.Operation(class).yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.Operation(class).yml new file mode 100644 index 00000000..37423ab0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.Operation(class).yml @@ -0,0 +1,174 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.Operation +name: Operation +fullName: azure.cognitiveservices.knowledge.qnamaker.models.Operation +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: Record to track long running operation. +constructor: + syntax: 'Operation(*, operation_state=None, created_timestamp: str = None, last_action_timestamp: + str = None, resource_location: str = None, user_id: str = None, operation_id: + str = None, error_response=None, **kwargs)' + parameters: + - name: operation_state + description: 'Operation state. Possible values include: + + ''Failed'', ''NotStarted'', ''Running'', ''Succeeded''' + isRequired: true + types: + - + - + - name: created_timestamp + description: Timestamp when the operation was created. + isRequired: true + types: + - + - name: last_action_timestamp + description: 'Timestamp when the current state was + + entered.' + isRequired: true + types: + - + - name: resource_location + description: 'Relative URI to the target resource location for + + completed resources.' + isRequired: true + types: + - + - name: user_id + description: User Id + isRequired: true + types: + - + - name: operation_id + description: Operation Id. + isRequired: true + types: + - + - name: error_response + description: Error details in case of failures. + isRequired: true + types: + - + keywordOnlyParameters: + - name: operation_state + isRequired: true + - name: created_timestamp + isRequired: true + - name: last_action_timestamp + isRequired: true + - name: resource_location + isRequired: true + - name: user_id + isRequired: true + - name: operation_id + isRequired: true + - name: error_response + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.Operation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.Operation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.Operation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.Operation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.Operation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.Operation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.Operation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.OperationStateType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.OperationStateType.yml new file mode 100644 index 00000000..249e4b45 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.OperationStateType.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.knowledge.qnamaker.models.OperationStateType +name: OperationStateType +fullName: azure.cognitiveservices.knowledge.qnamaker.models.OperationStateType +module: azure.cognitiveservices.knowledge.qnamaker.models +fields: +- name: failed + uid: azure.cognitiveservices.knowledge.qnamaker.models.OperationStateType.failed +- name: not_started + uid: azure.cognitiveservices.knowledge.qnamaker.models.OperationStateType.not_started +- name: running + uid: azure.cognitiveservices.knowledge.qnamaker.models.OperationStateType.running +- name: succeeded + uid: azure.cognitiveservices.knowledge.qnamaker.models.OperationStateType.succeeded diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.PromptDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.PromptDTO.yml new file mode 100644 index 00000000..28aac915 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.PromptDTO.yml @@ -0,0 +1,153 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.PromptDTO +name: PromptDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.PromptDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: Prompt for an answer. +constructor: + syntax: 'PromptDTO(*, display_order: int = None, qna_id: int = None, qna=None, display_text: + str = None, **kwargs)' + parameters: + - name: display_order + description: 'Index of the prompt - used in ordering of the + + prompts' + isRequired: true + types: + - + - name: qna_id + description: 'Qna id corresponding to the prompt - if QnaId is present, + + QnADTO object is ignored.' + isRequired: true + types: + - + - name: qna + description: 'QnADTO - Either QnaId or QnADTO needs to be present in a + + PromptDTO object' + isRequired: true + types: + - + - name: display_text + description: 'Text displayed to represent a follow up question + + prompt' + isRequired: true + types: + - + keywordOnlyParameters: + - name: display_order + isRequired: true + - name: qna_id + isRequired: true + - name: qna + isRequired: true + - name: display_text + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.PromptDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.PromptDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.PromptDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.PromptDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.PromptDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.PromptDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.PromptDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.PromptDTOQna.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.PromptDTOQna.yml new file mode 100644 index 00000000..24ea84f1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.PromptDTOQna.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.PromptDTOQna +name: PromptDTOQna +fullName: azure.cognitiveservices.knowledge.qnamaker.models.PromptDTOQna +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: 'QnADTO - Either QnaId or QnADTO needs to be present in a PromptDTO object. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PromptDTOQna(*, answer: str, questions, id: int = None, source: str = None, + metadata=None, context=None, last_updated_timestamp: str = None, **kwargs)' + parameters: + - name: id + description: Unique id for the Q-A. + isRequired: true + types: + - + - name: answer + description: Required. Answer text + isRequired: true + types: + - + - name: source + description: 'Source from which Q-A was indexed. eg. + + [https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs](https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs)' + isRequired: true + types: + - + - name: questions + description: Required. List of questions associated with the answer. + isRequired: true + types: + - [] + - name: metadata + description: List of metadata associated with the answer. + isRequired: true + types: + - [] + - name: context + description: Context of a QnA + isRequired: true + types: + - + - name: last_updated_timestamp + description: Timestamp when the QnA was last updated. + isRequired: true + types: + - + keywordOnlyParameters: + - name: answer + isRequired: true + - name: questions + isRequired: true + - name: id + isRequired: true + - name: source + isRequired: true + - name: metadata + isRequired: true + - name: context + isRequired: true + - name: last_updated_timestamp + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.PromptDTOQna.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.PromptDTOQna.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.PromptDTOQna.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.PromptDTOQna.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.PromptDTOQna.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.PromptDTOQna.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.PromptDTOQna.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADTO.yml new file mode 100644 index 00000000..e0ca3f07 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADTO.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADTO +name: QnADTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.QnADTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: 'Q-A object. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'QnADTO(*, answer: str, questions, id: int = None, source: str = None, metadata=None, + context=None, last_updated_timestamp: str = None, **kwargs)' + parameters: + - name: id + description: Unique id for the Q-A. + isRequired: true + types: + - + - name: answer + description: Required. Answer text + isRequired: true + types: + - + - name: source + description: 'Source from which Q-A was indexed. eg. + + [https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs](https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs)' + isRequired: true + types: + - + - name: questions + description: Required. List of questions associated with the answer. + isRequired: true + types: + - [] + - name: metadata + description: List of metadata associated with the answer. + isRequired: true + types: + - [] + - name: context + description: Context of a QnA + isRequired: true + types: + - + - name: last_updated_timestamp + description: Timestamp when the QnA was last updated. + isRequired: true + types: + - + keywordOnlyParameters: + - name: answer + isRequired: true + - name: questions + isRequired: true + - name: id + isRequired: true + - name: source + isRequired: true + - name: metadata + isRequired: true + - name: context + isRequired: true + - name: last_updated_timestamp + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADTOContext.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADTOContext.yml new file mode 100644 index 00000000..9f3d485c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADTOContext.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADTOContext +name: QnADTOContext +fullName: azure.cognitiveservices.knowledge.qnamaker.models.QnADTOContext +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: Context of a QnA. +constructor: + syntax: 'QnADTOContext(*, is_context_only: bool = None, prompts=None, **kwargs)' + parameters: + - name: is_context_only + description: 'To mark if a prompt is relevant only with a + + previous question or not. + + true - Do not include this QnA as search result for queries without + + context + + false - ignores context and includes this QnA in search result' + isRequired: true + types: + - + - name: prompts + description: List of prompts associated with the answer. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: is_context_only + isRequired: true + - name: prompts + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADTOContext.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADTOContext.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADTOContext.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADTOContext.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADTOContext.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADTOContext.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADTOContext.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADocumentsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADocumentsDTO.yml new file mode 100644 index 00000000..3f3b0542 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADocumentsDTO.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADocumentsDTO +name: QnADocumentsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.QnADocumentsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: List of QnADTO. +constructor: + syntax: QnADocumentsDTO(*, qna_documents=None, **kwargs) + parameters: + - name: qna_documents + description: List of answers. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: qna_documents + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADocumentsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADocumentsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADocumentsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADocumentsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADocumentsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADocumentsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADocumentsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResult.yml new file mode 100644 index 00000000..da0aac66 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResult.yml @@ -0,0 +1,176 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResult +name: QnASearchResult +fullName: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResult +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: Represents Search Result. +constructor: + syntax: 'QnASearchResult(*, questions=None, answer: str = None, score: float = None, + id: int = None, source: str = None, metadata=None, context=None, answer_span=None, + **kwargs)' + parameters: + - name: questions + description: List of questions. + isRequired: true + types: + - [] + - name: answer + description: Answer. + isRequired: true + types: + - + - name: score + description: Search result score. + isRequired: true + types: + - + - name: id + description: Id of the QnA result. + isRequired: true + types: + - + - name: source + description: Source of QnA result. + isRequired: true + types: + - + - name: metadata + description: List of metadata. + isRequired: true + types: + - [] + - name: context + description: Context object of the QnA + isRequired: true + types: + - + - name: answer_span + description: 'Answer span object of QnA with respect to user''s + + question.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: questions + isRequired: true + - name: answer + isRequired: true + - name: score + isRequired: true + - name: id + isRequired: true + - name: source + isRequired: true + - name: metadata + isRequired: true + - name: context + isRequired: true + - name: answer_span + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultAnswerSpan.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultAnswerSpan.yml new file mode 100644 index 00000000..d8941219 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultAnswerSpan.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultAnswerSpan +name: QnASearchResultAnswerSpan +fullName: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultAnswerSpan +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: Answer span object of QnA with respect to user's question. +constructor: + syntax: 'QnASearchResultAnswerSpan(*, text: str = None, score: float = None, start_index: + int = None, end_index: int = None, **kwargs)' + parameters: + - name: text + description: Predicted text of answer span. + isRequired: true + types: + - + - name: score + description: Predicted score of answer span. + isRequired: true + types: + - + - name: start_index + description: Start index of answer span in answer. + isRequired: true + types: + - + - name: end_index + description: End index of answer span in answer. + isRequired: true + types: + - + keywordOnlyParameters: + - name: text + isRequired: true + - name: score + isRequired: true + - name: start_index + isRequired: true + - name: end_index + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultAnswerSpan.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultAnswerSpan.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultAnswerSpan.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultAnswerSpan.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultAnswerSpan.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultAnswerSpan.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultAnswerSpan.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultContext.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultContext.yml new file mode 100644 index 00000000..ea89b06c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultContext.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultContext +name: QnASearchResultContext +fullName: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultContext +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: Context object of the QnA. +constructor: + syntax: 'QnASearchResultContext(*, is_context_only: bool = None, prompts=None, **kwargs)' + parameters: + - name: is_context_only + description: 'To mark if a prompt is relevant only with a + + previous question or not. + + true - Do not include this QnA as search result for queries without + + context + + false - ignores context and includes this QnA in search result' + isRequired: true + types: + - + - name: prompts + description: List of prompts associated with the answer. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: is_context_only + isRequired: true + - name: prompts + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultContext.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultContext.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultContext.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultContext.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultContext.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultContext.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultContext.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultList.yml new file mode 100644 index 00000000..c64241e9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultList.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultList +name: QnASearchResultList +fullName: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultList +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: Represents List of Question Answers. +constructor: + syntax: QnASearchResultList(*, answers=None, **kwargs) + parameters: + - name: answers + description: Represents Search Result list. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: answers + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultList.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultList.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultList.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultList.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultList.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultList.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultList.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryContextDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryContextDTO.yml new file mode 100644 index 00000000..a165b6c5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryContextDTO.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryContextDTO +name: QueryContextDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.QueryContextDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: Context object with previous QnA's information. +constructor: + syntax: 'QueryContextDTO(*, previous_qna_id: int = None, previous_user_query: str + = None, **kwargs)' + parameters: + - name: previous_qna_id + description: Previous QnA Id - qnaId of the top result. + isRequired: true + types: + - + - name: previous_user_query + description: Previous user query. + isRequired: true + types: + - + keywordOnlyParameters: + - name: previous_qna_id + isRequired: true + - name: previous_user_query + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryContextDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryContextDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryContextDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryContextDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryContextDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryContextDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryContextDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTO.yml new file mode 100644 index 00000000..e8a5e350 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTO.yml @@ -0,0 +1,207 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTO +name: QueryDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: POST body schema to query the knowledgebase. +constructor: + syntax: 'QueryDTO(*, qna_id: str = None, question: str = None, top: int = None, + user_id: str = None, is_test: bool = None, score_threshold: float = None, context=None, + ranker_type: str = None, strict_filters=None, strict_filters_compound_operation_type=None, + answer_span_request=None, **kwargs)' + parameters: + - name: qna_id + description: 'Exact qnaId to fetch from the knowledgebase, this field + + takes priority over question.' + isRequired: true + types: + - + - name: question + description: User question to query against the knowledge base. + isRequired: true + types: + - + - name: top + description: Max number of answers to be returned for the question. + isRequired: true + types: + - + - name: user_id + description: Unique identifier for the user. + isRequired: true + types: + - + - name: is_test + description: Query against the test index. + isRequired: true + types: + - + - name: score_threshold + description: Minimum threshold score for answers. + isRequired: true + types: + - + - name: context + description: Context object with previous QnA's information. + isRequired: true + types: + - + - name: ranker_type + description: 'Optional field. Set to ''QuestionOnly'' for using a + + question only Ranker.' + isRequired: true + types: + - + - name: strict_filters + description: 'Find QnAs that are associated with the given list + + of metadata.' + isRequired: true + types: + - [] + - name: strict_filters_compound_operation_type + description: 'Optional field. Set to ''OR'' + + for using OR operation for strict filters. Possible values include: ''AND'', + + ''OR''' + isRequired: true + types: + - + - + - name: answer_span_request + description: To configure Answer span prediction feature. + isRequired: true + types: + - + keywordOnlyParameters: + - name: qna_id + isRequired: true + - name: question + isRequired: true + - name: top + isRequired: true + - name: user_id + isRequired: true + - name: is_test + isRequired: true + - name: score_threshold + isRequired: true + - name: context + isRequired: true + - name: ranker_type + isRequired: true + - name: strict_filters + isRequired: true + - name: strict_filters_compound_operation_type + isRequired: true + - name: answer_span_request + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOAnswerSpanRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOAnswerSpanRequest.yml new file mode 100644 index 00000000..b78b0705 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOAnswerSpanRequest.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOAnswerSpanRequest +name: QueryDTOAnswerSpanRequest +fullName: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOAnswerSpanRequest +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: To configure Answer span prediction feature. +constructor: + syntax: 'QueryDTOAnswerSpanRequest(*, enable: bool = None, score_threshold: float + = None, top_answers_with_span: int = None, **kwargs)' + parameters: + - name: enable + description: Enable or Disable Answer Span prediction. + isRequired: true + types: + - + - name: score_threshold + description: 'Minimum threshold score required to include an + + answer span.' + isRequired: true + types: + - + - name: top_answers_with_span + description: 'Number of Top answers to be considered for + + span prediction.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: enable + isRequired: true + - name: score_threshold + isRequired: true + - name: top_answers_with_span + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOAnswerSpanRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOAnswerSpanRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOAnswerSpanRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOAnswerSpanRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOAnswerSpanRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOAnswerSpanRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOAnswerSpanRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOContext.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOContext.yml new file mode 100644 index 00000000..3a197123 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOContext.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOContext +name: QueryDTOContext +fullName: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOContext +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: Context object with previous QnA's information. +constructor: + syntax: 'QueryDTOContext(*, previous_qna_id: int = None, previous_user_query: str + = None, **kwargs)' + parameters: + - name: previous_qna_id + description: Previous QnA Id - qnaId of the top result. + isRequired: true + types: + - + - name: previous_user_query + description: Previous user query. + isRequired: true + types: + - + keywordOnlyParameters: + - name: previous_qna_id + isRequired: true + - name: previous_user_query + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOContext.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOContext.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOContext.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOContext.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOContext.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOContext.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOContext.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ReplaceKbDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ReplaceKbDTO.yml new file mode 100644 index 00000000..85faa8eb --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ReplaceKbDTO.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.ReplaceKbDTO +name: ReplaceKbDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.ReplaceKbDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: 'Post body schema for Replace KB operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ReplaceKbDTO(*, qn_alist, **kwargs) + parameters: + - name: qn_alist + description: 'Required. List of Q-A (QnADTO) to be added to the + + knowledgebase. Q-A Ids are assigned by the service and should be omitted.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: qn_alist + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ReplaceKbDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ReplaceKbDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ReplaceKbDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ReplaceKbDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ReplaceKbDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ReplaceKbDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.ReplaceKbDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.StrictFiltersCompoundOperationType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.StrictFiltersCompoundOperationType.yml new file mode 100644 index 00000000..244637f2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.StrictFiltersCompoundOperationType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.knowledge.qnamaker.models.StrictFiltersCompoundOperationType +name: StrictFiltersCompoundOperationType +fullName: azure.cognitiveservices.knowledge.qnamaker.models.StrictFiltersCompoundOperationType +module: azure.cognitiveservices.knowledge.qnamaker.models +fields: +- name: and_enum + uid: azure.cognitiveservices.knowledge.qnamaker.models.StrictFiltersCompoundOperationType.and_enum +- name: or_enum + uid: azure.cognitiveservices.knowledge.qnamaker.models.StrictFiltersCompoundOperationType.or_enum diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateContextDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateContextDTO.yml new file mode 100644 index 00000000..5780d156 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateContextDTO.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateContextDTO +name: UpdateContextDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.UpdateContextDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: Update Body schema to represent context to be updated. +constructor: + syntax: 'UpdateContextDTO(*, prompts_to_delete=None, prompts_to_add=None, is_context_only: + bool = None, **kwargs)' + parameters: + - name: prompts_to_delete + description: 'List of prompts associated with qna to be + + deleted' + isRequired: true + types: + - [] + - name: prompts_to_add + description: List of prompts to be added to the qna. + isRequired: true + types: + - [] + - name: is_context_only + description: 'To mark if a prompt is relevant only with a + + previous question or not. + + true - Do not include this QnA as search result for queries without + + context + + false - ignores context and includes this QnA in search result' + isRequired: true + types: + - + keywordOnlyParameters: + - name: prompts_to_delete + isRequired: true + - name: prompts_to_add + isRequired: true + - name: is_context_only + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateContextDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateContextDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateContextDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateContextDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateContextDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateContextDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateContextDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbContentsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbContentsDTO.yml new file mode 100644 index 00000000..5e06c5ea --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbContentsDTO.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbContentsDTO +name: UpdateKbContentsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbContentsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: PATCH body schema for Update operation in Update Kb. +constructor: + syntax: 'UpdateKbContentsDTO(*, name: str = None, qna_list=None, urls=None, default_answer: + str = None, **kwargs)' + parameters: + - name: name + description: Friendly name for the knowledgebase. + isRequired: true + types: + - + - name: qna_list + description: 'List of Q-A (UpdateQnaDTO) to be added to the + + knowledgebase.' + isRequired: true + types: + - [] + - name: urls + description: 'List of existing URLs to be refreshed. The content will be + + extracted again and re-indexed.' + isRequired: true + types: + - [] + - name: default_answer + description: 'Default answer sent to user if no good match is + + found in the KB.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: qna_list + isRequired: true + - name: urls + isRequired: true + - name: default_answer + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbContentsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbContentsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbContentsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbContentsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbContentsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbContentsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbContentsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTO.yml new file mode 100644 index 00000000..fd79616c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTO.yml @@ -0,0 +1,162 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTO +name: UpdateKbOperationDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: Contains list of QnAs to be updated. +constructor: + syntax: 'UpdateKbOperationDTO(*, add=None, delete=None, update=None, enable_hierarchical_extraction: + bool = None, default_answer_used_for_extraction: str = None, **kwargs)' + parameters: + - name: add + description: An instance of CreateKbInputDTO for add operation + isRequired: true + types: + - + - name: delete + description: An instance of DeleteKbContentsDTO for delete Operation + isRequired: true + types: + - + - name: update + description: An instance of UpdateKbContentsDTO for Update Operation + isRequired: true + types: + - + - name: enable_hierarchical_extraction + description: 'Enable hierarchical extraction of + + Q-A from files and urls. The value set during KB creation will be used if + + this field is not present.' + isRequired: true + types: + - + - name: default_answer_used_for_extraction + description: 'Text string to be used as the + + answer in any Q-A which has no extracted answer from the document but has + + a hierarchy. Required when EnableHierarchicalExtraction field is set to + + True.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: add + isRequired: true + - name: delete + isRequired: true + - name: update + isRequired: true + - name: enable_hierarchical_extraction + isRequired: true + - name: default_answer_used_for_extraction + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOAdd.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOAdd.yml new file mode 100644 index 00000000..1044828d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOAdd.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOAdd +name: UpdateKbOperationDTOAdd +fullName: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOAdd +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: An instance of CreateKbInputDTO for add operation. +constructor: + syntax: UpdateKbOperationDTOAdd(*, qna_list=None, urls=None, files=None, **kwargs) + parameters: + - name: qna_list + description: 'List of QNA to be added to the index. Ids are generated + + by the service and should be omitted.' + isRequired: true + types: + - [] + - name: urls + description: List of URLs to be added to knowledgebase. + isRequired: true + types: + - [] + - name: files + description: List of files to be added to knowledgebase. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: qna_list + isRequired: true + - name: urls + isRequired: true + - name: files + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOAdd.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOAdd.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOAdd.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOAdd.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOAdd.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOAdd.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOAdd.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTODelete.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTODelete.yml new file mode 100644 index 00000000..dd5e3400 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTODelete.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTODelete +name: UpdateKbOperationDTODelete +fullName: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTODelete +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: An instance of DeleteKbContentsDTO for delete Operation. +constructor: + syntax: UpdateKbOperationDTODelete(*, ids=None, sources=None, **kwargs) + parameters: + - name: ids + description: List of Qna Ids to be deleted + isRequired: true + types: + - [] + - name: sources + description: List of sources to be deleted from knowledgebase. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: ids + isRequired: true + - name: sources + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTODelete.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTODelete.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTODelete.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTODelete.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTODelete.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTODelete.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTODelete.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOUpdate.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOUpdate.yml new file mode 100644 index 00000000..2c71be72 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOUpdate.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOUpdate +name: UpdateKbOperationDTOUpdate +fullName: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOUpdate +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: An instance of UpdateKbContentsDTO for Update Operation. +constructor: + syntax: 'UpdateKbOperationDTOUpdate(*, name: str = None, qna_list=None, urls=None, + default_answer: str = None, **kwargs)' + parameters: + - name: name + description: Friendly name for the knowledgebase. + isRequired: true + types: + - + - name: qna_list + description: 'List of Q-A (UpdateQnaDTO) to be added to the + + knowledgebase.' + isRequired: true + types: + - [] + - name: urls + description: 'List of existing URLs to be refreshed. The content will be + + extracted again and re-indexed.' + isRequired: true + types: + - [] + - name: default_answer + description: 'Default answer sent to user if no good match is + + found in the KB.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: qna_list + isRequired: true + - name: urls + isRequired: true + - name: default_answer + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOUpdate.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOUpdate.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOUpdate.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOUpdate.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOUpdate.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOUpdate.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOUpdate.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateMetadataDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateMetadataDTO.yml new file mode 100644 index 00000000..25e36702 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateMetadataDTO.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateMetadataDTO +name: UpdateMetadataDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.UpdateMetadataDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: PATCH Body schema to represent list of Metadata to be updated. +constructor: + syntax: UpdateMetadataDTO(*, delete=None, add=None, **kwargs) + parameters: + - name: delete + description: List of Metadata associated with answer to be deleted + isRequired: true + types: + - [] + - name: add + description: List of metadata associated with answer to be added + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: delete + isRequired: true + - name: add + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateMetadataDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateMetadataDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateMetadataDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateMetadataDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateMetadataDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateMetadataDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateMetadataDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTO.yml new file mode 100644 index 00000000..ce2a7c97 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTO.yml @@ -0,0 +1,161 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTO +name: UpdateQnaDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: PATCH Body schema for Update Qna List. +constructor: + syntax: 'UpdateQnaDTO(*, id: int = None, answer: str = None, source: str = None, + questions=None, metadata=None, context=None, **kwargs)' + parameters: + - name: id + description: Unique id for the Q-A + isRequired: true + types: + - + - name: answer + description: Answer text + isRequired: true + types: + - + - name: source + description: 'Source from which Q-A was indexed. eg. + + [https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs](https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs)' + isRequired: true + types: + - + - name: questions + description: List of questions associated with the answer. + isRequired: true + types: + - + - name: metadata + description: List of metadata associated with the answer to be updated + isRequired: true + types: + - + - name: context + description: Context associated with Qna to be updated. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: answer + isRequired: true + - name: source + isRequired: true + - name: questions + isRequired: true + - name: metadata + isRequired: true + - name: context + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOContext.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOContext.yml new file mode 100644 index 00000000..2a324d8f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOContext.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOContext +name: UpdateQnaDTOContext +fullName: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOContext +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: Context associated with Qna to be updated. +constructor: + syntax: 'UpdateQnaDTOContext(*, prompts_to_delete=None, prompts_to_add=None, is_context_only: + bool = None, **kwargs)' + parameters: + - name: prompts_to_delete + description: 'List of prompts associated with qna to be + + deleted' + isRequired: true + types: + - [] + - name: prompts_to_add + description: List of prompts to be added to the qna. + isRequired: true + types: + - [] + - name: is_context_only + description: 'To mark if a prompt is relevant only with a + + previous question or not. + + true - Do not include this QnA as search result for queries without + + context + + false - ignores context and includes this QnA in search result' + isRequired: true + types: + - + keywordOnlyParameters: + - name: prompts_to_delete + isRequired: true + - name: prompts_to_add + isRequired: true + - name: is_context_only + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOContext.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOContext.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOContext.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOContext.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOContext.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOContext.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOContext.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOMetadata.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOMetadata.yml new file mode 100644 index 00000000..a0e6c188 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOMetadata.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOMetadata +name: UpdateQnaDTOMetadata +fullName: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOMetadata +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: List of metadata associated with the answer to be updated. +constructor: + syntax: UpdateQnaDTOMetadata(*, delete=None, add=None, **kwargs) + parameters: + - name: delete + description: List of Metadata associated with answer to be deleted + isRequired: true + types: + - [] + - name: add + description: List of metadata associated with answer to be added + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: delete + isRequired: true + - name: add + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOMetadata.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOMetadata.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOMetadata.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOMetadata.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOMetadata.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOMetadata.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOMetadata.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOQuestions.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOQuestions.yml new file mode 100644 index 00000000..493bd664 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOQuestions.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOQuestions +name: UpdateQnaDTOQuestions +fullName: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOQuestions +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: List of questions associated with the answer. +constructor: + syntax: UpdateQnaDTOQuestions(*, add=None, delete=None, **kwargs) + parameters: + - name: add + description: List of questions to be added + isRequired: true + types: + - [] + - name: delete + description: List of questions to be deleted. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: add + isRequired: true + - name: delete + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOQuestions.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOQuestions.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOQuestions.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOQuestions.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOQuestions.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOQuestions.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOQuestions.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQuestionsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQuestionsDTO.yml new file mode 100644 index 00000000..e88b0cb6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQuestionsDTO.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQuestionsDTO +name: UpdateQuestionsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQuestionsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: 'PATCH Body schema for Update Kb which contains list of questions to be + + added and deleted.' +constructor: + syntax: UpdateQuestionsDTO(*, add=None, delete=None, **kwargs) + parameters: + - name: add + description: List of questions to be added + isRequired: true + types: + - [] + - name: delete + description: List of questions to be deleted. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: add + isRequired: true + - name: delete + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQuestionsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQuestionsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQuestionsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQuestionsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQuestionsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQuestionsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQuestionsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.WordAlterationsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.WordAlterationsDTO.yml new file mode 100644 index 00000000..7c913e03 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.WordAlterationsDTO.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.WordAlterationsDTO +name: WordAlterationsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.WordAlterationsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models +summary: 'Collection of word alterations. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: WordAlterationsDTO(*, word_alterations, **kwargs) + parameters: + - name: word_alterations + description: Required. Collection of word alterations. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: word_alterations + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.WordAlterationsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.WordAlterationsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.WordAlterationsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.WordAlterationsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.WordAlterationsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.WordAlterationsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.WordAlterationsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto.ActiveLearningSettingsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto.ActiveLearningSettingsDTO.yml new file mode 100644 index 00000000..10d2057d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto.ActiveLearningSettingsDTO.yml @@ -0,0 +1,120 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto.ActiveLearningSettingsDTO +name: ActiveLearningSettingsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto.ActiveLearningSettingsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto +summary: Active Learning settings of the endpoint. +constructor: + syntax: ActiveLearningSettingsDTO(**kwargs) + parameters: + - name: enable + description: True/False string providing Active Learning + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto.ActiveLearningSettingsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto.ActiveLearningSettingsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto.ActiveLearningSettingsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto.ActiveLearningSettingsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto.ActiveLearningSettingsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto.ActiveLearningSettingsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto.ActiveLearningSettingsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto.yml new file mode 100644 index 00000000..b9c741e6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto +name: active_learning_settings_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto.ActiveLearningSettingsDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.ActiveLearningSettingsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.ActiveLearningSettingsDTO.yml new file mode 100644 index 00000000..cce1e3d4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.ActiveLearningSettingsDTO.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.ActiveLearningSettingsDTO +name: ActiveLearningSettingsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.ActiveLearningSettingsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3 +summary: Active Learning settings of the endpoint. +constructor: + syntax: 'ActiveLearningSettingsDTO(*, enable: str = None, **kwargs)' + parameters: + - name: enable + description: True/False string providing Active Learning + isRequired: true + types: + - + keywordOnlyParameters: + - name: enable + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.ActiveLearningSettingsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.ActiveLearningSettingsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.ActiveLearningSettingsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.ActiveLearningSettingsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.ActiveLearningSettingsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.ActiveLearningSettingsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.ActiveLearningSettingsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.yml new file mode 100644 index 00000000..1d8be215 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3 +name: active_learning_settings_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.ActiveLearningSettingsDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto.AlterationsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto.AlterationsDTO.yml new file mode 100644 index 00000000..14dd3530 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto.AlterationsDTO.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto.AlterationsDTO +name: AlterationsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto.AlterationsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto +summary: 'Collection of words that are synonyms. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: AlterationsDTO(**kwargs) + parameters: + - name: alterations + description: Required. Words that are synonymous with each other. + isRequired: true + types: + - [] +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto.AlterationsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto.AlterationsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto.AlterationsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto.AlterationsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto.AlterationsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto.AlterationsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto.AlterationsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto.yml new file mode 100644 index 00000000..4da68bb6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto +name: alterations_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto.AlterationsDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3.AlterationsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3.AlterationsDTO.yml new file mode 100644 index 00000000..fe98dc6c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3.AlterationsDTO.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3.AlterationsDTO +name: AlterationsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3.AlterationsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3 +summary: 'Collection of words that are synonyms. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: AlterationsDTO(*, alterations, **kwargs) + parameters: + - name: alterations + description: Required. Words that are synonymous with each other. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: alterations + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3.AlterationsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3.AlterationsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3.AlterationsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3.AlterationsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3.AlterationsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3.AlterationsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3.AlterationsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3.yml new file mode 100644 index 00000000..579d20da --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3 +name: alterations_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3.AlterationsDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto.AnswerSpanRequestDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto.AnswerSpanRequestDTO.yml new file mode 100644 index 00000000..83b4e9d1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto.AnswerSpanRequestDTO.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto.AnswerSpanRequestDTO +name: AnswerSpanRequestDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto.AnswerSpanRequestDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto +summary: To configure Answer span prediction feature. +constructor: + syntax: AnswerSpanRequestDTO(**kwargs) + parameters: + - name: enable + description: Enable or Disable Answer Span prediction. + isRequired: true + types: + - + - name: score_threshold + description: 'Minimum threshold score required to include an + + answer span.' + isRequired: true + types: + - + - name: top_answers_with_span + description: 'Number of Top answers to be considered for + + span prediction.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto.AnswerSpanRequestDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto.AnswerSpanRequestDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto.AnswerSpanRequestDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto.AnswerSpanRequestDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto.AnswerSpanRequestDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto.AnswerSpanRequestDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto.AnswerSpanRequestDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto.yml new file mode 100644 index 00000000..f4e2e41a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto +name: answer_span_request_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto.AnswerSpanRequestDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.AnswerSpanRequestDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.AnswerSpanRequestDTO.yml new file mode 100644 index 00000000..a484d452 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.AnswerSpanRequestDTO.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.AnswerSpanRequestDTO +name: AnswerSpanRequestDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.AnswerSpanRequestDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3 +summary: To configure Answer span prediction feature. +constructor: + syntax: 'AnswerSpanRequestDTO(*, enable: bool = None, score_threshold: float = None, + top_answers_with_span: int = None, **kwargs)' + parameters: + - name: enable + description: Enable or Disable Answer Span prediction. + isRequired: true + types: + - + - name: score_threshold + description: 'Minimum threshold score required to include an + + answer span.' + isRequired: true + types: + - + - name: top_answers_with_span + description: 'Number of Top answers to be considered for + + span prediction.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: enable + isRequired: true + - name: score_threshold + isRequired: true + - name: top_answers_with_span + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.AnswerSpanRequestDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.AnswerSpanRequestDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.AnswerSpanRequestDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.AnswerSpanRequestDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.AnswerSpanRequestDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.AnswerSpanRequestDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.AnswerSpanRequestDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.yml new file mode 100644 index 00000000..dbdda3c1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3 +name: answer_span_request_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.AnswerSpanRequestDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto.AnswerSpanResponseDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto.AnswerSpanResponseDTO.yml new file mode 100644 index 00000000..ea8f1214 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto.AnswerSpanResponseDTO.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto.AnswerSpanResponseDTO +name: AnswerSpanResponseDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto.AnswerSpanResponseDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto +summary: Answer span object of QnA. +constructor: + syntax: AnswerSpanResponseDTO(**kwargs) + parameters: + - name: text + description: Predicted text of answer span. + isRequired: true + types: + - + - name: score + description: Predicted score of answer span. + isRequired: true + types: + - + - name: start_index + description: Start index of answer span in answer. + isRequired: true + types: + - + - name: end_index + description: End index of answer span in answer. + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto.AnswerSpanResponseDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto.AnswerSpanResponseDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto.AnswerSpanResponseDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto.AnswerSpanResponseDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto.AnswerSpanResponseDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto.AnswerSpanResponseDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto.AnswerSpanResponseDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto.yml new file mode 100644 index 00000000..7deea94d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto +name: answer_span_response_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto.AnswerSpanResponseDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.AnswerSpanResponseDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.AnswerSpanResponseDTO.yml new file mode 100644 index 00000000..d23b51f7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.AnswerSpanResponseDTO.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.AnswerSpanResponseDTO +name: AnswerSpanResponseDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.AnswerSpanResponseDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3 +summary: Answer span object of QnA. +constructor: + syntax: 'AnswerSpanResponseDTO(*, text: str = None, score: float = None, start_index: + int = None, end_index: int = None, **kwargs)' + parameters: + - name: text + description: Predicted text of answer span. + isRequired: true + types: + - + - name: score + description: Predicted score of answer span. + isRequired: true + types: + - + - name: start_index + description: Start index of answer span in answer. + isRequired: true + types: + - + - name: end_index + description: End index of answer span in answer. + isRequired: true + types: + - + keywordOnlyParameters: + - name: text + isRequired: true + - name: score + isRequired: true + - name: start_index + isRequired: true + - name: end_index + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.AnswerSpanResponseDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.AnswerSpanResponseDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.AnswerSpanResponseDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.AnswerSpanResponseDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.AnswerSpanResponseDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.AnswerSpanResponseDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.AnswerSpanResponseDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.yml new file mode 100644 index 00000000..2ade4cbf --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3 +name: answer_span_response_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.AnswerSpanResponseDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.context_dto.ContextDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.context_dto.ContextDTO.yml new file mode 100644 index 00000000..8670d52c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.context_dto.ContextDTO.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.context_dto.ContextDTO +name: ContextDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.context_dto.ContextDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.context_dto +summary: Context associated with Qna. +constructor: + syntax: ContextDTO(**kwargs) + parameters: + - name: is_context_only + description: 'To mark if a prompt is relevant only with a + + previous question or not. + + true - Do not include this QnA as search result for queries without + + context + + false - ignores context and includes this QnA in search result' + isRequired: true + types: + - + - name: prompts + description: List of prompts associated with the answer. + isRequired: true + types: + - [] +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.context_dto.ContextDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.context_dto.ContextDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.context_dto.ContextDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.context_dto.ContextDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.context_dto.ContextDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.context_dto.ContextDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.context_dto.ContextDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.context_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.context_dto.yml new file mode 100644 index 00000000..eda10d8b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.context_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.context_dto +name: context_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.context_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.context_dto.ContextDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.ContextDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.ContextDTO.yml new file mode 100644 index 00000000..ab629b47 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.ContextDTO.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.ContextDTO +name: ContextDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.ContextDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3 +summary: Context associated with Qna. +constructor: + syntax: 'ContextDTO(*, is_context_only: bool = None, prompts=None, **kwargs)' + parameters: + - name: is_context_only + description: 'To mark if a prompt is relevant only with a + + previous question or not. + + true - Do not include this QnA as search result for queries without + + context + + false - ignores context and includes this QnA in search result' + isRequired: true + types: + - + - name: prompts + description: List of prompts associated with the answer. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: is_context_only + isRequired: true + - name: prompts + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.ContextDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.ContextDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.ContextDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.ContextDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.ContextDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.ContextDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.ContextDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.yml new file mode 100644 index 00000000..55ab1363 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3 +name: context_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.ContextDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto.CreateKbDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto.CreateKbDTO.yml new file mode 100644 index 00000000..384c7d15 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto.CreateKbDTO.yml @@ -0,0 +1,185 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto.CreateKbDTO +name: CreateKbDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto.CreateKbDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto +summary: 'Post body schema for CreateKb operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CreateKbDTO(**kwargs) + parameters: + - name: name + description: Required. Friendly name for the knowledgebase. + isRequired: true + types: + - + - name: qna_list + description: 'List of Q-A (QnADTO) to be added to the knowledgebase. + + Q-A Ids are assigned by the service and should be omitted.' + isRequired: true + types: + - [] + - name: urls + description: List of URLs to be used for extracting Q-A. + isRequired: true + types: + - [] + - name: files + description: List of files from which to Extract Q-A. + isRequired: true + types: + - [] + - name: enable_hierarchical_extraction + description: 'Enable hierarchical extraction of + + Q-A from files and urls. Value to be considered False if this field is not + + present.' + isRequired: true + types: + - + - name: default_answer_used_for_extraction + description: 'Text string to be used as the + + answer in any Q-A which has no extracted answer from the document but has + + a hierarchy. Required when EnableHierarchicalExtraction field is set to + + True.' + isRequired: true + types: + - + - name: language + description: 'Language of the knowledgebase. Please find the list of + + supported languages here.' + isRequired: true + types: + - + - name: enable_multiple_languages + description: 'Set to true to enable creating KBs in + + different languages for the same resource.' + isRequired: true + types: + - + - name: default_answer + description: 'Default answer sent to user if no good match is + + found in the KB.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto.CreateKbDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto.CreateKbDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto.CreateKbDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto.CreateKbDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto.CreateKbDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto.CreateKbDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto.CreateKbDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto.yml new file mode 100644 index 00000000..30133e14 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto +name: create_kb_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto.CreateKbDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.CreateKbDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.CreateKbDTO.yml new file mode 100644 index 00000000..7988feac --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.CreateKbDTO.yml @@ -0,0 +1,206 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.CreateKbDTO +name: CreateKbDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.CreateKbDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3 +summary: 'Post body schema for CreateKb operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CreateKbDTO(*, name: str, qna_list=None, urls=None, files=None, enable_hierarchical_extraction: + bool = None, default_answer_used_for_extraction: str = None, language: str = None, + enable_multiple_languages: bool = None, default_answer: str = None, **kwargs)' + parameters: + - name: name + description: Required. Friendly name for the knowledgebase. + isRequired: true + types: + - + - name: qna_list + description: 'List of Q-A (QnADTO) to be added to the knowledgebase. + + Q-A Ids are assigned by the service and should be omitted.' + isRequired: true + types: + - [] + - name: urls + description: List of URLs to be used for extracting Q-A. + isRequired: true + types: + - [] + - name: files + description: List of files from which to Extract Q-A. + isRequired: true + types: + - [] + - name: enable_hierarchical_extraction + description: 'Enable hierarchical extraction of + + Q-A from files and urls. Value to be considered False if this field is not + + present.' + isRequired: true + types: + - + - name: default_answer_used_for_extraction + description: 'Text string to be used as the + + answer in any Q-A which has no extracted answer from the document but has + + a hierarchy. Required when EnableHierarchicalExtraction field is set to + + True.' + isRequired: true + types: + - + - name: language + description: 'Language of the knowledgebase. Please find the list of + + supported languages here.' + isRequired: true + types: + - + - name: enable_multiple_languages + description: 'Set to true to enable creating KBs in + + different languages for the same resource.' + isRequired: true + types: + - + - name: default_answer + description: 'Default answer sent to user if no good match is + + found in the KB.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: qna_list + isRequired: true + - name: urls + isRequired: true + - name: files + isRequired: true + - name: enable_hierarchical_extraction + isRequired: true + - name: default_answer_used_for_extraction + isRequired: true + - name: language + isRequired: true + - name: enable_multiple_languages + isRequired: true + - name: default_answer + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.CreateKbDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.CreateKbDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.CreateKbDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.CreateKbDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.CreateKbDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.CreateKbDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.CreateKbDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.yml new file mode 100644 index 00000000..17473752 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3 +name: create_kb_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.CreateKbDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto.CreateKbInputDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto.CreateKbInputDTO.yml new file mode 100644 index 00000000..eb216e60 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto.CreateKbInputDTO.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto.CreateKbInputDTO +name: CreateKbInputDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto.CreateKbInputDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto +summary: Input to create KB. +constructor: + syntax: CreateKbInputDTO(**kwargs) + parameters: + - name: qna_list + description: 'List of QNA to be added to the index. Ids are generated + + by the service and should be omitted.' + isRequired: true + types: + - [] + - name: urls + description: List of URLs to be added to knowledgebase. + isRequired: true + types: + - [] + - name: files + description: List of files to be added to knowledgebase. + isRequired: true + types: + - [] +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto.CreateKbInputDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto.CreateKbInputDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto.CreateKbInputDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto.CreateKbInputDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto.CreateKbInputDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto.CreateKbInputDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto.CreateKbInputDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto.yml new file mode 100644 index 00000000..2275e167 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto +name: create_kb_input_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto.CreateKbInputDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.CreateKbInputDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.CreateKbInputDTO.yml new file mode 100644 index 00000000..3a704516 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.CreateKbInputDTO.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.CreateKbInputDTO +name: CreateKbInputDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.CreateKbInputDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3 +summary: Input to create KB. +constructor: + syntax: CreateKbInputDTO(*, qna_list=None, urls=None, files=None, **kwargs) + parameters: + - name: qna_list + description: 'List of QNA to be added to the index. Ids are generated + + by the service and should be omitted.' + isRequired: true + types: + - [] + - name: urls + description: List of URLs to be added to knowledgebase. + isRequired: true + types: + - [] + - name: files + description: List of files to be added to knowledgebase. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: qna_list + isRequired: true + - name: urls + isRequired: true + - name: files + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.CreateKbInputDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.CreateKbInputDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.CreateKbInputDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.CreateKbInputDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.CreateKbInputDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.CreateKbInputDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.CreateKbInputDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.yml new file mode 100644 index 00000000..20ecb105 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3 +name: create_kb_input_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.CreateKbInputDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto.DeleteKbContentsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto.DeleteKbContentsDTO.yml new file mode 100644 index 00000000..32aa05e3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto.DeleteKbContentsDTO.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto.DeleteKbContentsDTO +name: DeleteKbContentsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto.DeleteKbContentsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto +summary: PATCH body schema of Delete Operation in UpdateKb. +constructor: + syntax: DeleteKbContentsDTO(**kwargs) + parameters: + - name: ids + description: List of Qna Ids to be deleted + isRequired: true + types: + - [] + - name: sources + description: List of sources to be deleted from knowledgebase. + isRequired: true + types: + - [] +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto.DeleteKbContentsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto.DeleteKbContentsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto.DeleteKbContentsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto.DeleteKbContentsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto.DeleteKbContentsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto.DeleteKbContentsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto.DeleteKbContentsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto.yml new file mode 100644 index 00000000..f7db9ed1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto +name: delete_kb_contents_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto.DeleteKbContentsDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.DeleteKbContentsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.DeleteKbContentsDTO.yml new file mode 100644 index 00000000..525de254 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.DeleteKbContentsDTO.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.DeleteKbContentsDTO +name: DeleteKbContentsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.DeleteKbContentsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3 +summary: PATCH body schema of Delete Operation in UpdateKb. +constructor: + syntax: DeleteKbContentsDTO(*, ids=None, sources=None, **kwargs) + parameters: + - name: ids + description: List of Qna Ids to be deleted + isRequired: true + types: + - [] + - name: sources + description: List of sources to be deleted from knowledgebase. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: ids + isRequired: true + - name: sources + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.DeleteKbContentsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.DeleteKbContentsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.DeleteKbContentsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.DeleteKbContentsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.DeleteKbContentsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.DeleteKbContentsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.DeleteKbContentsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.yml new file mode 100644 index 00000000..8d586e6b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3 +name: delete_kb_contents_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.DeleteKbContentsDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto.EndpointKeysDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto.EndpointKeysDTO.yml new file mode 100644 index 00000000..fce3d2d2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto.EndpointKeysDTO.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto.EndpointKeysDTO +name: EndpointKeysDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto.EndpointKeysDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto +summary: Schema for EndpointKeys generate/refresh operations. +constructor: + syntax: EndpointKeysDTO(**kwargs) + parameters: + - name: primary_endpoint_key + description: Primary Access Key. + isRequired: true + types: + - + - name: secondary_endpoint_key + description: Secondary Access Key. + isRequired: true + types: + - + - name: installed_version + description: Current version of runtime. + isRequired: true + types: + - + - name: last_stable_version + description: Latest version of runtime. + isRequired: true + types: + - + - name: language + description: Language setting of runtime. + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto.EndpointKeysDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto.EndpointKeysDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto.EndpointKeysDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto.EndpointKeysDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto.EndpointKeysDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto.EndpointKeysDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto.EndpointKeysDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto.yml new file mode 100644 index 00000000..dee77fc2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto +name: endpoint_keys_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto.EndpointKeysDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.EndpointKeysDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.EndpointKeysDTO.yml new file mode 100644 index 00000000..cf10b294 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.EndpointKeysDTO.yml @@ -0,0 +1,153 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.EndpointKeysDTO +name: EndpointKeysDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.EndpointKeysDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3 +summary: Schema for EndpointKeys generate/refresh operations. +constructor: + syntax: 'EndpointKeysDTO(*, primary_endpoint_key: str = None, secondary_endpoint_key: + str = None, installed_version: str = None, last_stable_version: str = None, language: + str = None, **kwargs)' + parameters: + - name: primary_endpoint_key + description: Primary Access Key. + isRequired: true + types: + - + - name: secondary_endpoint_key + description: Secondary Access Key. + isRequired: true + types: + - + - name: installed_version + description: Current version of runtime. + isRequired: true + types: + - + - name: last_stable_version + description: Latest version of runtime. + isRequired: true + types: + - + - name: language + description: Language setting of runtime. + isRequired: true + types: + - + keywordOnlyParameters: + - name: primary_endpoint_key + isRequired: true + - name: secondary_endpoint_key + isRequired: true + - name: installed_version + isRequired: true + - name: last_stable_version + isRequired: true + - name: language + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.EndpointKeysDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.EndpointKeysDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.EndpointKeysDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.EndpointKeysDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.EndpointKeysDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.EndpointKeysDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.EndpointKeysDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.yml new file mode 100644 index 00000000..113ab11a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3 +name: endpoint_keys_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.EndpointKeysDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto.EndpointSettingsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto.EndpointSettingsDTO.yml new file mode 100644 index 00000000..9ffccb87 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto.EndpointSettingsDTO.yml @@ -0,0 +1,120 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto.EndpointSettingsDTO +name: EndpointSettingsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto.EndpointSettingsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto +summary: Endpoint settings. +constructor: + syntax: EndpointSettingsDTO(**kwargs) + parameters: + - name: active_learning + description: Active Learning settings of the endpoint. + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto.EndpointSettingsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto.EndpointSettingsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto.EndpointSettingsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto.EndpointSettingsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto.EndpointSettingsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto.EndpointSettingsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto.EndpointSettingsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto.yml new file mode 100644 index 00000000..805470a8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto +name: endpoint_settings_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto.EndpointSettingsDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning.EndpointSettingsDTOActiveLearning.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning.EndpointSettingsDTOActiveLearning.yml new file mode 100644 index 00000000..85e7785d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning.EndpointSettingsDTOActiveLearning.yml @@ -0,0 +1,120 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning.EndpointSettingsDTOActiveLearning +name: EndpointSettingsDTOActiveLearning +fullName: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning.EndpointSettingsDTOActiveLearning +module: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning +summary: Active Learning settings of the endpoint. +constructor: + syntax: EndpointSettingsDTOActiveLearning(**kwargs) + parameters: + - name: enable + description: True/False string providing Active Learning + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning.EndpointSettingsDTOActiveLearning.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning.EndpointSettingsDTOActiveLearning.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning.EndpointSettingsDTOActiveLearning.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning.EndpointSettingsDTOActiveLearning.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning.EndpointSettingsDTOActiveLearning.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning.EndpointSettingsDTOActiveLearning.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning.EndpointSettingsDTOActiveLearning.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning.yml new file mode 100644 index 00000000..541f8b35 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning +name: endpoint_settings_dto_active_learning +fullName: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning.EndpointSettingsDTOActiveLearning diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.EndpointSettingsDTOActiveLearning.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.EndpointSettingsDTOActiveLearning.yml new file mode 100644 index 00000000..39e352e0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.EndpointSettingsDTOActiveLearning.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.EndpointSettingsDTOActiveLearning +name: EndpointSettingsDTOActiveLearning +fullName: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.EndpointSettingsDTOActiveLearning +module: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3 +summary: Active Learning settings of the endpoint. +constructor: + syntax: 'EndpointSettingsDTOActiveLearning(*, enable: str = None, **kwargs)' + parameters: + - name: enable + description: True/False string providing Active Learning + isRequired: true + types: + - + keywordOnlyParameters: + - name: enable + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.EndpointSettingsDTOActiveLearning.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.EndpointSettingsDTOActiveLearning.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.EndpointSettingsDTOActiveLearning.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.EndpointSettingsDTOActiveLearning.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.EndpointSettingsDTOActiveLearning.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.EndpointSettingsDTOActiveLearning.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.EndpointSettingsDTOActiveLearning.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.yml new file mode 100644 index 00000000..bc32b194 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3 +name: endpoint_settings_dto_active_learning_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.EndpointSettingsDTOActiveLearning diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.EndpointSettingsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.EndpointSettingsDTO.yml new file mode 100644 index 00000000..3950f197 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.EndpointSettingsDTO.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.EndpointSettingsDTO +name: EndpointSettingsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.EndpointSettingsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3 +summary: Endpoint settings. +constructor: + syntax: EndpointSettingsDTO(*, active_learning=None, **kwargs) + parameters: + - name: active_learning + description: Active Learning settings of the endpoint. + isRequired: true + types: + - + keywordOnlyParameters: + - name: active_learning + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.EndpointSettingsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.EndpointSettingsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.EndpointSettingsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.EndpointSettingsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.EndpointSettingsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.EndpointSettingsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.EndpointSettingsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.yml new file mode 100644 index 00000000..54953c4a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3 +name: endpoint_settings_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.EndpointSettingsDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error.Error.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error.Error.yml new file mode 100644 index 00000000..a13c89f2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error.Error.yml @@ -0,0 +1,160 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.error.Error +name: Error +fullName: azure.cognitiveservices.knowledge.qnamaker.models.error.Error +module: azure.cognitiveservices.knowledge.qnamaker.models.error +summary: 'The error object. As per Microsoft One API guidelines - + + [https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses](https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Error(**kwargs) + parameters: + - name: code + description: 'Required. One of a server-defined set of error codes. + + Possible values include: ''BadArgument'', ''Forbidden'', ''NotFound'', + + ''KbNotFound'', ''Unauthorized'', ''Unspecified'', ''EndpointKeysError'', + + ''QuotaExceeded'', ''QnaRuntimeError'', ''SKULimitExceeded'', + + ''OperationNotFound'', ''ServiceError'', ''ValidationFailure'', + + ''ExtractionFailure''' + isRequired: true + types: + - + - + - name: message + description: A human-readable representation of the error. + isRequired: true + types: + - + - name: target + description: The target of the error. + isRequired: true + types: + - + - name: details + description: 'An array of details about specific errors that led to this + + reported error.' + isRequired: true + types: + - [] + - name: inner_error + description: 'An object containing more specific information than + + the current object about the error.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error.Error.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error.Error.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error.Error.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error.Error.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error.Error.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error.Error.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error.Error.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error.yml new file mode 100644 index 00000000..79989bab --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.error +name: error +fullName: azure.cognitiveservices.knowledge.qnamaker.models.error +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.error.Error diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_py3.Error.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_py3.Error.yml new file mode 100644 index 00000000..eb5a8dd3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_py3.Error.yml @@ -0,0 +1,172 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.error_py3.Error +name: Error +fullName: azure.cognitiveservices.knowledge.qnamaker.models.error_py3.Error +module: azure.cognitiveservices.knowledge.qnamaker.models.error_py3 +summary: 'The error object. As per Microsoft One API guidelines - + + [https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses](https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses). + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Error(*, code, message: str = None, target: str = None, details=None, inner_error=None, + **kwargs)' + parameters: + - name: code + description: 'Required. One of a server-defined set of error codes. + + Possible values include: ''BadArgument'', ''Forbidden'', ''NotFound'', + + ''KbNotFound'', ''Unauthorized'', ''Unspecified'', ''EndpointKeysError'', + + ''QuotaExceeded'', ''QnaRuntimeError'', ''SKULimitExceeded'', + + ''OperationNotFound'', ''ServiceError'', ''ValidationFailure'', + + ''ExtractionFailure''' + isRequired: true + types: + - + - + - name: message + description: A human-readable representation of the error. + isRequired: true + types: + - + - name: target + description: The target of the error. + isRequired: true + types: + - + - name: details + description: 'An array of details about specific errors that led to this + + reported error.' + isRequired: true + types: + - [] + - name: inner_error + description: 'An object containing more specific information than + + the current object about the error.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true + - name: target + isRequired: true + - name: details + isRequired: true + - name: inner_error + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_py3.Error.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_py3.Error.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_py3.Error.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_py3.Error.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_py3.Error.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_py3.Error.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_py3.Error.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_py3.yml new file mode 100644 index 00000000..fecc2b6b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.error_py3 +name: error_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.error_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.error_py3.Error diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponse.yml new file mode 100644 index 00000000..9814e768 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponse.yml @@ -0,0 +1,122 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponse +name: ErrorResponse +fullName: azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponse +module: azure.cognitiveservices.knowledge.qnamaker.models.error_response +summary: 'Error response. As per Microsoft One API guidelines - + + [https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses](https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).' +constructor: + syntax: ErrorResponse(**kwargs) + parameters: + - name: error + description: The error object. + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponseException.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponseException.yml new file mode 100644 index 00000000..4ef8a911 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponseException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponseException +name: ErrorResponseException +fullName: azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponseException +module: azure.cognitiveservices.knowledge.qnamaker.models.error_response +summary: 'Server responded with exception of type: ''ErrorResponse''.' +constructor: + syntax: ErrorResponseException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponseException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponseException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponseException.args + name: args diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response.yml new file mode 100644 index 00000000..3cd49ca9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response +name: error_response +fullName: azure.cognitiveservices.knowledge.qnamaker.models.error_response +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponse +- azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponseException diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_error.ErrorResponseError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_error.ErrorResponseError.yml new file mode 100644 index 00000000..24743c51 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_error.ErrorResponseError.yml @@ -0,0 +1,158 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error.ErrorResponseError +name: ErrorResponseError +fullName: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error.ErrorResponseError +module: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error +summary: 'The error object. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ErrorResponseError(**kwargs) + parameters: + - name: code + description: 'Required. One of a server-defined set of error codes. + + Possible values include: ''BadArgument'', ''Forbidden'', ''NotFound'', + + ''KbNotFound'', ''Unauthorized'', ''Unspecified'', ''EndpointKeysError'', + + ''QuotaExceeded'', ''QnaRuntimeError'', ''SKULimitExceeded'', + + ''OperationNotFound'', ''ServiceError'', ''ValidationFailure'', + + ''ExtractionFailure''' + isRequired: true + types: + - + - + - name: message + description: A human-readable representation of the error. + isRequired: true + types: + - + - name: target + description: The target of the error. + isRequired: true + types: + - + - name: details + description: 'An array of details about specific errors that led to this + + reported error.' + isRequired: true + types: + - [] + - name: inner_error + description: 'An object containing more specific information than + + the current object about the error.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error.ErrorResponseError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error.ErrorResponseError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error.ErrorResponseError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error.ErrorResponseError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error.ErrorResponseError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error.ErrorResponseError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error.ErrorResponseError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_error.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_error.yml new file mode 100644 index 00000000..d637dbdf --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_error.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error +name: error_response_error +fullName: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.error_response_error.ErrorResponseError diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.ErrorResponseError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.ErrorResponseError.yml new file mode 100644 index 00000000..bf47fb56 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.ErrorResponseError.yml @@ -0,0 +1,170 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.ErrorResponseError +name: ErrorResponseError +fullName: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.ErrorResponseError +module: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3 +summary: 'The error object. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ErrorResponseError(*, code, message: str = None, target: str = None, details=None, + inner_error=None, **kwargs)' + parameters: + - name: code + description: 'Required. One of a server-defined set of error codes. + + Possible values include: ''BadArgument'', ''Forbidden'', ''NotFound'', + + ''KbNotFound'', ''Unauthorized'', ''Unspecified'', ''EndpointKeysError'', + + ''QuotaExceeded'', ''QnaRuntimeError'', ''SKULimitExceeded'', + + ''OperationNotFound'', ''ServiceError'', ''ValidationFailure'', + + ''ExtractionFailure''' + isRequired: true + types: + - + - + - name: message + description: A human-readable representation of the error. + isRequired: true + types: + - + - name: target + description: The target of the error. + isRequired: true + types: + - + - name: details + description: 'An array of details about specific errors that led to this + + reported error.' + isRequired: true + types: + - [] + - name: inner_error + description: 'An object containing more specific information than + + the current object about the error.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true + - name: target + isRequired: true + - name: details + isRequired: true + - name: inner_error + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.ErrorResponseError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.ErrorResponseError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.ErrorResponseError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.ErrorResponseError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.ErrorResponseError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.ErrorResponseError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.ErrorResponseError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.yml new file mode 100644 index 00000000..eb200148 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3 +name: error_response_error_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.ErrorResponseError diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponse.yml new file mode 100644 index 00000000..6af83abc --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponse.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponse +name: ErrorResponse +fullName: azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponse +module: azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3 +summary: 'Error response. As per Microsoft One API guidelines - + + [https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses](https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).' +constructor: + syntax: ErrorResponse(*, error=None, **kwargs) + parameters: + - name: error + description: The error object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: error + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponseException.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponseException.yml new file mode 100644 index 00000000..4b60141e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponseException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponseException +name: ErrorResponseException +fullName: azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponseException +module: azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3 +summary: 'Server responded with exception of type: ''ErrorResponse''.' +constructor: + syntax: ErrorResponseException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponseException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponseException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponseException.args + name: args diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.yml new file mode 100644 index 00000000..4909afaa --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3 +name: error_response_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponse +- azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponseException diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto.FeedbackRecordDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto.FeedbackRecordDTO.yml new file mode 100644 index 00000000..11e7c72e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto.FeedbackRecordDTO.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto.FeedbackRecordDTO +name: FeedbackRecordDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto.FeedbackRecordDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto +summary: Active learning feedback record. +constructor: + syntax: FeedbackRecordDTO(**kwargs) + parameters: + - name: user_id + description: Unique identifier for the user. + isRequired: true + types: + - + - name: user_question + description: The suggested question being provided as feedback. + isRequired: true + types: + - + - name: qna_id + description: 'The qnaId for which the suggested question is provided as + + feedback.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto.FeedbackRecordDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto.FeedbackRecordDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto.FeedbackRecordDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto.FeedbackRecordDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto.FeedbackRecordDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto.FeedbackRecordDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto.FeedbackRecordDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto.yml new file mode 100644 index 00000000..ce66c656 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto +name: feedback_record_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto.FeedbackRecordDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.FeedbackRecordDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.FeedbackRecordDTO.yml new file mode 100644 index 00000000..d73d674b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.FeedbackRecordDTO.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.FeedbackRecordDTO +name: FeedbackRecordDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.FeedbackRecordDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3 +summary: Active learning feedback record. +constructor: + syntax: 'FeedbackRecordDTO(*, user_id: str = None, user_question: str = None, qna_id: + int = None, **kwargs)' + parameters: + - name: user_id + description: Unique identifier for the user. + isRequired: true + types: + - + - name: user_question + description: The suggested question being provided as feedback. + isRequired: true + types: + - + - name: qna_id + description: 'The qnaId for which the suggested question is provided as + + feedback.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: user_id + isRequired: true + - name: user_question + isRequired: true + - name: qna_id + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.FeedbackRecordDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.FeedbackRecordDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.FeedbackRecordDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.FeedbackRecordDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.FeedbackRecordDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.FeedbackRecordDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.FeedbackRecordDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.yml new file mode 100644 index 00000000..514b9168 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3 +name: feedback_record_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.FeedbackRecordDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto.FeedbackRecordsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto.FeedbackRecordsDTO.yml new file mode 100644 index 00000000..03c3612a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto.FeedbackRecordsDTO.yml @@ -0,0 +1,120 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto.FeedbackRecordsDTO +name: FeedbackRecordsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto.FeedbackRecordsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto +summary: Active learning feedback records. +constructor: + syntax: FeedbackRecordsDTO(**kwargs) + parameters: + - name: feedback_records + description: List of feedback records. + isRequired: true + types: + - [] +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto.FeedbackRecordsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto.FeedbackRecordsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto.FeedbackRecordsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto.FeedbackRecordsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto.FeedbackRecordsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto.FeedbackRecordsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto.FeedbackRecordsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto.yml new file mode 100644 index 00000000..f8b1f15d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto +name: feedback_records_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto.FeedbackRecordsDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.FeedbackRecordsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.FeedbackRecordsDTO.yml new file mode 100644 index 00000000..20825963 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.FeedbackRecordsDTO.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.FeedbackRecordsDTO +name: FeedbackRecordsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.FeedbackRecordsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3 +summary: Active learning feedback records. +constructor: + syntax: FeedbackRecordsDTO(*, feedback_records=None, **kwargs) + parameters: + - name: feedback_records + description: List of feedback records. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: feedback_records + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.FeedbackRecordsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.FeedbackRecordsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.FeedbackRecordsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.FeedbackRecordsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.FeedbackRecordsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.FeedbackRecordsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.FeedbackRecordsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.yml new file mode 100644 index 00000000..b437fa39 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3 +name: feedback_records_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.FeedbackRecordsDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.file_dto.FileDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.file_dto.FileDTO.yml new file mode 100644 index 00000000..2773d327 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.file_dto.FileDTO.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.file_dto.FileDTO +name: FileDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.file_dto.FileDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.file_dto +summary: 'DTO to hold details of uploaded files. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: FileDTO(**kwargs) + parameters: + - name: file_name + description: 'Required. File name. Supported file types are ".tsv", + + ".pdf", ".txt", ".docx", ".xlsx".' + isRequired: true + types: + - + - name: file_uri + description: Required. Public URI of the file. + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.file_dto.FileDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.file_dto.FileDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.file_dto.FileDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.file_dto.FileDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.file_dto.FileDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.file_dto.FileDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.file_dto.FileDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.file_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.file_dto.yml new file mode 100644 index 00000000..1e9c19fc --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.file_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.file_dto +name: file_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.file_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.file_dto.FileDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3.FileDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3.FileDTO.yml new file mode 100644 index 00000000..65877711 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3.FileDTO.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3.FileDTO +name: FileDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3.FileDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3 +summary: 'DTO to hold details of uploaded files. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'FileDTO(*, file_name: str, file_uri: str, **kwargs)' + parameters: + - name: file_name + description: 'Required. File name. Supported file types are ".tsv", + + ".pdf", ".txt", ".docx", ".xlsx".' + isRequired: true + types: + - + - name: file_uri + description: Required. Public URI of the file. + isRequired: true + types: + - + keywordOnlyParameters: + - name: file_name + isRequired: true + - name: file_uri + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3.FileDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3.FileDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3.FileDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3.FileDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3.FileDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3.FileDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3.FileDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3.yml new file mode 100644 index 00000000..994bbdc1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3 +name: file_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3.FileDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model.InnerErrorModel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model.InnerErrorModel.yml new file mode 100644 index 00000000..1f3b2fdf --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model.InnerErrorModel.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model.InnerErrorModel +name: InnerErrorModel +fullName: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model.InnerErrorModel +module: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model +summary: 'An object containing more specific information about the error. As per + + Microsoft One API guidelines - + + [https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses](https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).' +constructor: + syntax: InnerErrorModel(**kwargs) + parameters: + - name: code + description: 'A more specific error code than was provided by the + + containing error.' + isRequired: true + types: + - + - name: inner_error + description: 'An object containing more specific information than + + the current object about the error.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model.InnerErrorModel.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model.InnerErrorModel.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model.InnerErrorModel.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model.InnerErrorModel.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model.InnerErrorModel.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model.InnerErrorModel.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model.InnerErrorModel.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model.yml new file mode 100644 index 00000000..71c9edc0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model +name: inner_error_model +fullName: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model.InnerErrorModel diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.InnerErrorModel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.InnerErrorModel.yml new file mode 100644 index 00000000..0426347b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.InnerErrorModel.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.InnerErrorModel +name: InnerErrorModel +fullName: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.InnerErrorModel +module: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3 +summary: 'An object containing more specific information about the error. As per + + Microsoft One API guidelines - + + [https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses](https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).' +constructor: + syntax: 'InnerErrorModel(*, code: str = None, inner_error=None, **kwargs)' + parameters: + - name: code + description: 'A more specific error code than was provided by the + + containing error.' + isRequired: true + types: + - + - name: inner_error + description: 'An object containing more specific information than + + the current object about the error.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: inner_error + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.InnerErrorModel.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.InnerErrorModel.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.InnerErrorModel.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.InnerErrorModel.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.InnerErrorModel.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.InnerErrorModel.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.InnerErrorModel.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.yml new file mode 100644 index 00000000..9dbce223 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3 +name: inner_error_model_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.InnerErrorModel diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto.KnowledgebaseDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto.KnowledgebaseDTO.yml new file mode 100644 index 00000000..5a280be8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto.KnowledgebaseDTO.yml @@ -0,0 +1,170 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto.KnowledgebaseDTO +name: KnowledgebaseDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto.KnowledgebaseDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto +summary: Response schema for CreateKb operation. +constructor: + syntax: KnowledgebaseDTO(**kwargs) + parameters: + - name: id + description: Unique id that identifies a knowledgebase. + isRequired: true + types: + - + - name: host_name + description: URL host name at which the knowledgebase is hosted. + isRequired: true + types: + - + - name: last_accessed_timestamp + description: 'Time stamp at which the knowledgebase was + + last accessed (UTC).' + isRequired: true + types: + - + - name: last_changed_timestamp + description: 'Time stamp at which the knowledgebase was + + last modified (UTC).' + isRequired: true + types: + - + - name: last_published_timestamp + description: 'Time stamp at which the knowledgebase was + + last published (UTC).' + isRequired: true + types: + - + - name: name + description: Friendly name of the knowledgebase. + isRequired: true + types: + - + - name: user_id + description: User who created / owns the knowledgebase. + isRequired: true + types: + - + - name: urls + description: 'URL sources from which Q-A were extracted and added to the + + knowledgebase.' + isRequired: true + types: + - [] + - name: sources + description: 'Custom sources from which Q-A were extracted or explicitly + + added to the knowledgebase.' + isRequired: true + types: + - [] +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto.KnowledgebaseDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto.KnowledgebaseDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto.KnowledgebaseDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto.KnowledgebaseDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto.KnowledgebaseDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto.KnowledgebaseDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto.KnowledgebaseDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto.yml new file mode 100644 index 00000000..f2498af8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto +name: knowledgebase_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto.KnowledgebaseDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.KnowledgebaseDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.KnowledgebaseDTO.yml new file mode 100644 index 00000000..ecb021b5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.KnowledgebaseDTO.yml @@ -0,0 +1,191 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.KnowledgebaseDTO +name: KnowledgebaseDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.KnowledgebaseDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3 +summary: Response schema for CreateKb operation. +constructor: + syntax: 'KnowledgebaseDTO(*, id: str = None, host_name: str = None, last_accessed_timestamp: + str = None, last_changed_timestamp: str = None, last_published_timestamp: str + = None, name: str = None, user_id: str = None, urls=None, sources=None, **kwargs)' + parameters: + - name: id + description: Unique id that identifies a knowledgebase. + isRequired: true + types: + - + - name: host_name + description: URL host name at which the knowledgebase is hosted. + isRequired: true + types: + - + - name: last_accessed_timestamp + description: 'Time stamp at which the knowledgebase was + + last accessed (UTC).' + isRequired: true + types: + - + - name: last_changed_timestamp + description: 'Time stamp at which the knowledgebase was + + last modified (UTC).' + isRequired: true + types: + - + - name: last_published_timestamp + description: 'Time stamp at which the knowledgebase was + + last published (UTC).' + isRequired: true + types: + - + - name: name + description: Friendly name of the knowledgebase. + isRequired: true + types: + - + - name: user_id + description: User who created / owns the knowledgebase. + isRequired: true + types: + - + - name: urls + description: 'URL sources from which Q-A were extracted and added to the + + knowledgebase.' + isRequired: true + types: + - [] + - name: sources + description: 'Custom sources from which Q-A were extracted or explicitly + + added to the knowledgebase.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: host_name + isRequired: true + - name: last_accessed_timestamp + isRequired: true + - name: last_changed_timestamp + isRequired: true + - name: last_published_timestamp + isRequired: true + - name: name + isRequired: true + - name: user_id + isRequired: true + - name: urls + isRequired: true + - name: sources + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.KnowledgebaseDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.KnowledgebaseDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.KnowledgebaseDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.KnowledgebaseDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.KnowledgebaseDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.KnowledgebaseDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.KnowledgebaseDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.yml new file mode 100644 index 00000000..e2ced676 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3 +name: knowledgebase_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.KnowledgebaseDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto.KnowledgebasesDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto.KnowledgebasesDTO.yml new file mode 100644 index 00000000..a5710f3c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto.KnowledgebasesDTO.yml @@ -0,0 +1,120 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto.KnowledgebasesDTO +name: KnowledgebasesDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto.KnowledgebasesDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto +summary: Collection of knowledgebases owned by a user. +constructor: + syntax: KnowledgebasesDTO(**kwargs) + parameters: + - name: knowledgebases + description: Collection of knowledgebase records. + isRequired: true + types: + - [] +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto.KnowledgebasesDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto.KnowledgebasesDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto.KnowledgebasesDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto.KnowledgebasesDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto.KnowledgebasesDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto.KnowledgebasesDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto.KnowledgebasesDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto.yml new file mode 100644 index 00000000..314d8f8e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto +name: knowledgebases_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto.KnowledgebasesDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.KnowledgebasesDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.KnowledgebasesDTO.yml new file mode 100644 index 00000000..7fa08be2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.KnowledgebasesDTO.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.KnowledgebasesDTO +name: KnowledgebasesDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.KnowledgebasesDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3 +summary: Collection of knowledgebases owned by a user. +constructor: + syntax: KnowledgebasesDTO(*, knowledgebases=None, **kwargs) + parameters: + - name: knowledgebases + description: Collection of knowledgebase records. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: knowledgebases + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.KnowledgebasesDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.KnowledgebasesDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.KnowledgebasesDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.KnowledgebasesDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.KnowledgebasesDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.KnowledgebasesDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.KnowledgebasesDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.yml new file mode 100644 index 00000000..72d371d4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3 +name: knowledgebases_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.KnowledgebasesDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto.MetadataDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto.MetadataDTO.yml new file mode 100644 index 00000000..aee4a4ea --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto.MetadataDTO.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto.MetadataDTO +name: MetadataDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto.MetadataDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto +summary: 'Name - value pair of metadata. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: MetadataDTO(**kwargs) + parameters: + - name: name + description: Required. Metadata name. + isRequired: true + types: + - + - name: value + description: Required. Metadata value. + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto.MetadataDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto.MetadataDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto.MetadataDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto.MetadataDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto.MetadataDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto.MetadataDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto.MetadataDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto.yml new file mode 100644 index 00000000..83febd4a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto +name: metadata_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto.MetadataDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3.MetadataDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3.MetadataDTO.yml new file mode 100644 index 00000000..f852d925 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3.MetadataDTO.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3.MetadataDTO +name: MetadataDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3.MetadataDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3 +summary: 'Name - value pair of metadata. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MetadataDTO(*, name: str, value: str, **kwargs)' + parameters: + - name: name + description: Required. Metadata name. + isRequired: true + types: + - + - name: value + description: Required. Metadata value. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3.MetadataDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3.MetadataDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3.MetadataDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3.MetadataDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3.MetadataDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3.MetadataDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3.MetadataDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3.yml new file mode 100644 index 00000000..b131b7a4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3 +name: metadata_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3.MetadataDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.operation.Operation.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.operation.Operation.yml new file mode 100644 index 00000000..7a6e73e2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.operation.Operation.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.operation.Operation +name: Operation +fullName: azure.cognitiveservices.knowledge.qnamaker.models.operation.Operation +module: azure.cognitiveservices.knowledge.qnamaker.models.operation +summary: Record to track long running operation. +constructor: + syntax: Operation(**kwargs) + parameters: + - name: operation_state + description: 'Operation state. Possible values include: + + ''Failed'', ''NotStarted'', ''Running'', ''Succeeded''' + isRequired: true + types: + - + - + - name: created_timestamp + description: Timestamp when the operation was created. + isRequired: true + types: + - + - name: last_action_timestamp + description: 'Timestamp when the current state was + + entered.' + isRequired: true + types: + - + - name: resource_location + description: 'Relative URI to the target resource location for + + completed resources.' + isRequired: true + types: + - + - name: user_id + description: User Id + isRequired: true + types: + - + - name: operation_id + description: Operation Id. + isRequired: true + types: + - + - name: error_response + description: Error details in case of failures. + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.operation.Operation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.operation.Operation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.operation.Operation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.operation.Operation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.operation.Operation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.operation.Operation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.operation.Operation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.operation.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.operation.yml new file mode 100644 index 00000000..10e9eea0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.operation.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.operation +name: operation +fullName: azure.cognitiveservices.knowledge.qnamaker.models.operation +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.operation.Operation diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.Operation.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.Operation.yml new file mode 100644 index 00000000..55883ad7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.Operation.yml @@ -0,0 +1,174 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.Operation +name: Operation +fullName: azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.Operation +module: azure.cognitiveservices.knowledge.qnamaker.models.operation_py3 +summary: Record to track long running operation. +constructor: + syntax: 'Operation(*, operation_state=None, created_timestamp: str = None, last_action_timestamp: + str = None, resource_location: str = None, user_id: str = None, operation_id: + str = None, error_response=None, **kwargs)' + parameters: + - name: operation_state + description: 'Operation state. Possible values include: + + ''Failed'', ''NotStarted'', ''Running'', ''Succeeded''' + isRequired: true + types: + - + - + - name: created_timestamp + description: Timestamp when the operation was created. + isRequired: true + types: + - + - name: last_action_timestamp + description: 'Timestamp when the current state was + + entered.' + isRequired: true + types: + - + - name: resource_location + description: 'Relative URI to the target resource location for + + completed resources.' + isRequired: true + types: + - + - name: user_id + description: User Id + isRequired: true + types: + - + - name: operation_id + description: Operation Id. + isRequired: true + types: + - + - name: error_response + description: Error details in case of failures. + isRequired: true + types: + - + keywordOnlyParameters: + - name: operation_state + isRequired: true + - name: created_timestamp + isRequired: true + - name: last_action_timestamp + isRequired: true + - name: resource_location + isRequired: true + - name: user_id + isRequired: true + - name: operation_id + isRequired: true + - name: error_response + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.Operation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.Operation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.Operation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.Operation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.Operation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.Operation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.Operation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.yml new file mode 100644 index 00000000..1f7515a8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.operation_py3 +name: operation_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.operation_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.Operation diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto.PromptDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto.PromptDTO.yml new file mode 100644 index 00000000..d2802be5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto.PromptDTO.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto.PromptDTO +name: PromptDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto.PromptDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto +summary: Prompt for an answer. +constructor: + syntax: PromptDTO(**kwargs) + parameters: + - name: display_order + description: 'Index of the prompt - used in ordering of the + + prompts' + isRequired: true + types: + - + - name: qna_id + description: 'Qna id corresponding to the prompt - if QnaId is present, + + QnADTO object is ignored.' + isRequired: true + types: + - + - name: qna + description: 'QnADTO - Either QnaId or QnADTO needs to be present in a + + PromptDTO object' + isRequired: true + types: + - + - name: display_text + description: 'Text displayed to represent a follow up question + + prompt' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto.PromptDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto.PromptDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto.PromptDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto.PromptDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto.PromptDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto.PromptDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto.PromptDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto.yml new file mode 100644 index 00000000..a10f45c3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto +name: prompt_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto.PromptDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.PromptDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.PromptDTO.yml new file mode 100644 index 00000000..5e9a0ddb --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.PromptDTO.yml @@ -0,0 +1,153 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.PromptDTO +name: PromptDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.PromptDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3 +summary: Prompt for an answer. +constructor: + syntax: 'PromptDTO(*, display_order: int = None, qna_id: int = None, qna=None, display_text: + str = None, **kwargs)' + parameters: + - name: display_order + description: 'Index of the prompt - used in ordering of the + + prompts' + isRequired: true + types: + - + - name: qna_id + description: 'Qna id corresponding to the prompt - if QnaId is present, + + QnADTO object is ignored.' + isRequired: true + types: + - + - name: qna + description: 'QnADTO - Either QnaId or QnADTO needs to be present in a + + PromptDTO object' + isRequired: true + types: + - + - name: display_text + description: 'Text displayed to represent a follow up question + + prompt' + isRequired: true + types: + - + keywordOnlyParameters: + - name: display_order + isRequired: true + - name: qna_id + isRequired: true + - name: qna + isRequired: true + - name: display_text + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.PromptDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.PromptDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.PromptDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.PromptDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.PromptDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.PromptDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.PromptDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.yml new file mode 100644 index 00000000..07bff56b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3 +name: prompt_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.PromptDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna.PromptDTOQna.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna.PromptDTOQna.yml new file mode 100644 index 00000000..11ef27c1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna.PromptDTOQna.yml @@ -0,0 +1,155 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna.PromptDTOQna +name: PromptDTOQna +fullName: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna.PromptDTOQna +module: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna +summary: 'QnADTO - Either QnaId or QnADTO needs to be present in a PromptDTO object. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: PromptDTOQna(**kwargs) + parameters: + - name: id + description: Unique id for the Q-A. + isRequired: true + types: + - + - name: answer + description: Required. Answer text + isRequired: true + types: + - + - name: source + description: 'Source from which Q-A was indexed. eg. + + [https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs](https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs)' + isRequired: true + types: + - + - name: questions + description: Required. List of questions associated with the answer. + isRequired: true + types: + - [] + - name: metadata + description: List of metadata associated with the answer. + isRequired: true + types: + - [] + - name: context + description: Context of a QnA + isRequired: true + types: + - + - name: last_updated_timestamp + description: Timestamp when the QnA was last updated. + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna.PromptDTOQna.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna.PromptDTOQna.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna.PromptDTOQna.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna.PromptDTOQna.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna.PromptDTOQna.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna.PromptDTOQna.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna.PromptDTOQna.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna.yml new file mode 100644 index 00000000..959003b7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna +name: prompt_dto_qna +fullName: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna.PromptDTOQna diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.PromptDTOQna.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.PromptDTOQna.yml new file mode 100644 index 00000000..fef5f7c6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.PromptDTOQna.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.PromptDTOQna +name: PromptDTOQna +fullName: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.PromptDTOQna +module: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3 +summary: 'QnADTO - Either QnaId or QnADTO needs to be present in a PromptDTO object. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PromptDTOQna(*, answer: str, questions, id: int = None, source: str = None, + metadata=None, context=None, last_updated_timestamp: str = None, **kwargs)' + parameters: + - name: id + description: Unique id for the Q-A. + isRequired: true + types: + - + - name: answer + description: Required. Answer text + isRequired: true + types: + - + - name: source + description: 'Source from which Q-A was indexed. eg. + + [https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs](https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs)' + isRequired: true + types: + - + - name: questions + description: Required. List of questions associated with the answer. + isRequired: true + types: + - [] + - name: metadata + description: List of metadata associated with the answer. + isRequired: true + types: + - [] + - name: context + description: Context of a QnA + isRequired: true + types: + - + - name: last_updated_timestamp + description: Timestamp when the QnA was last updated. + isRequired: true + types: + - + keywordOnlyParameters: + - name: answer + isRequired: true + - name: questions + isRequired: true + - name: id + isRequired: true + - name: source + isRequired: true + - name: metadata + isRequired: true + - name: context + isRequired: true + - name: last_updated_timestamp + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.PromptDTOQna.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.PromptDTOQna.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.PromptDTOQna.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.PromptDTOQna.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.PromptDTOQna.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.PromptDTOQna.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.PromptDTOQna.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.yml new file mode 100644 index 00000000..7f04dd08 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3 +name: prompt_dto_qna_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.PromptDTOQna diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto.QnADocumentsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto.QnADocumentsDTO.yml new file mode 100644 index 00000000..9b1b79d7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto.QnADocumentsDTO.yml @@ -0,0 +1,120 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto.QnADocumentsDTO +name: QnADocumentsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto.QnADocumentsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto +summary: List of QnADTO. +constructor: + syntax: QnADocumentsDTO(**kwargs) + parameters: + - name: qna_documents + description: List of answers. + isRequired: true + types: + - [] +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto.QnADocumentsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto.QnADocumentsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto.QnADocumentsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto.QnADocumentsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto.QnADocumentsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto.QnADocumentsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto.QnADocumentsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto.yml new file mode 100644 index 00000000..c1c8e07a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto +name: qn_adocuments_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto.QnADocumentsDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.QnADocumentsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.QnADocumentsDTO.yml new file mode 100644 index 00000000..71a2c38e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.QnADocumentsDTO.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.QnADocumentsDTO +name: QnADocumentsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.QnADocumentsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3 +summary: List of QnADTO. +constructor: + syntax: QnADocumentsDTO(*, qna_documents=None, **kwargs) + parameters: + - name: qna_documents + description: List of answers. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: qna_documents + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.QnADocumentsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.QnADocumentsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.QnADocumentsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.QnADocumentsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.QnADocumentsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.QnADocumentsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.QnADocumentsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.yml new file mode 100644 index 00000000..32acd960 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3 +name: qn_adocuments_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.QnADocumentsDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto.QnADTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto.QnADTO.yml new file mode 100644 index 00000000..cb440b33 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto.QnADTO.yml @@ -0,0 +1,155 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto.QnADTO +name: QnADTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto.QnADTO +module: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto +summary: 'Q-A object. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: QnADTO(**kwargs) + parameters: + - name: id + description: Unique id for the Q-A. + isRequired: true + types: + - + - name: answer + description: Required. Answer text + isRequired: true + types: + - + - name: source + description: 'Source from which Q-A was indexed. eg. + + [https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs](https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs)' + isRequired: true + types: + - + - name: questions + description: Required. List of questions associated with the answer. + isRequired: true + types: + - [] + - name: metadata + description: List of metadata associated with the answer. + isRequired: true + types: + - [] + - name: context + description: Context of a QnA + isRequired: true + types: + - + - name: last_updated_timestamp + description: Timestamp when the QnA was last updated. + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto.QnADTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto.QnADTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto.QnADTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto.QnADTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto.QnADTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto.QnADTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto.QnADTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto.yml new file mode 100644 index 00000000..883d7f4d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto +name: qn_adto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.qn_adto.QnADTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context.QnADTOContext.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context.QnADTOContext.yml new file mode 100644 index 00000000..d6630f08 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context.QnADTOContext.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context.QnADTOContext +name: QnADTOContext +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context.QnADTOContext +module: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context +summary: Context of a QnA. +constructor: + syntax: QnADTOContext(**kwargs) + parameters: + - name: is_context_only + description: 'To mark if a prompt is relevant only with a + + previous question or not. + + true - Do not include this QnA as search result for queries without + + context + + false - ignores context and includes this QnA in search result' + isRequired: true + types: + - + - name: prompts + description: List of prompts associated with the answer. + isRequired: true + types: + - [] +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context.QnADTOContext.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context.QnADTOContext.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context.QnADTOContext.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context.QnADTOContext.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context.QnADTOContext.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context.QnADTOContext.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context.QnADTOContext.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context.yml new file mode 100644 index 00000000..2693f056 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context +name: qn_adto_context +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context.QnADTOContext diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.QnADTOContext.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.QnADTOContext.yml new file mode 100644 index 00000000..baaf1692 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.QnADTOContext.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.QnADTOContext +name: QnADTOContext +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.QnADTOContext +module: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3 +summary: Context of a QnA. +constructor: + syntax: 'QnADTOContext(*, is_context_only: bool = None, prompts=None, **kwargs)' + parameters: + - name: is_context_only + description: 'To mark if a prompt is relevant only with a + + previous question or not. + + true - Do not include this QnA as search result for queries without + + context + + false - ignores context and includes this QnA in search result' + isRequired: true + types: + - + - name: prompts + description: List of prompts associated with the answer. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: is_context_only + isRequired: true + - name: prompts + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.QnADTOContext.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.QnADTOContext.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.QnADTOContext.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.QnADTOContext.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.QnADTOContext.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.QnADTOContext.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.QnADTOContext.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.yml new file mode 100644 index 00000000..0f6ae2a0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3 +name: qn_adto_context_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.QnADTOContext diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.QnADTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.QnADTO.yml new file mode 100644 index 00000000..58596e22 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.QnADTO.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.QnADTO +name: QnADTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.QnADTO +module: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3 +summary: 'Q-A object. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'QnADTO(*, answer: str, questions, id: int = None, source: str = None, metadata=None, + context=None, last_updated_timestamp: str = None, **kwargs)' + parameters: + - name: id + description: Unique id for the Q-A. + isRequired: true + types: + - + - name: answer + description: Required. Answer text + isRequired: true + types: + - + - name: source + description: 'Source from which Q-A was indexed. eg. + + [https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs](https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs)' + isRequired: true + types: + - + - name: questions + description: Required. List of questions associated with the answer. + isRequired: true + types: + - [] + - name: metadata + description: List of metadata associated with the answer. + isRequired: true + types: + - [] + - name: context + description: Context of a QnA + isRequired: true + types: + - + - name: last_updated_timestamp + description: Timestamp when the QnA was last updated. + isRequired: true + types: + - + keywordOnlyParameters: + - name: answer + isRequired: true + - name: questions + isRequired: true + - name: id + isRequired: true + - name: source + isRequired: true + - name: metadata + isRequired: true + - name: context + isRequired: true + - name: last_updated_timestamp + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.QnADTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.QnADTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.QnADTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.QnADTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.QnADTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.QnADTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.QnADTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.yml new file mode 100644 index 00000000..e83215a1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3 +name: qn_adto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.QnADTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.EnvironmentType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.EnvironmentType.yml new file mode 100644 index 00000000..dde870d6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.EnvironmentType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.EnvironmentType +name: EnvironmentType +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.EnvironmentType +module: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums +fields: +- name: prod + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.EnvironmentType.prod +- name: test + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.EnvironmentType.test diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.ErrorCodeType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.ErrorCodeType.yml new file mode 100644 index 00000000..721df31a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.ErrorCodeType.yml @@ -0,0 +1,34 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.ErrorCodeType +name: ErrorCodeType +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.ErrorCodeType +module: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums +fields: +- name: bad_argument + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.ErrorCodeType.bad_argument +- name: endpoint_keys_error + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.ErrorCodeType.endpoint_keys_error +- name: extraction_failure + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.ErrorCodeType.extraction_failure +- name: forbidden + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.ErrorCodeType.forbidden +- name: kb_not_found + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.ErrorCodeType.kb_not_found +- name: not_found + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.ErrorCodeType.not_found +- name: operation_not_found + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.ErrorCodeType.operation_not_found +- name: qna_runtime_error + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.ErrorCodeType.qna_runtime_error +- name: quota_exceeded + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.ErrorCodeType.quota_exceeded +- name: service_error + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.ErrorCodeType.service_error +- name: sku_limit_exceeded + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.ErrorCodeType.sku_limit_exceeded +- name: unauthorized + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.ErrorCodeType.unauthorized +- name: unspecified + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.ErrorCodeType.unspecified +- name: validation_failure + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.ErrorCodeType.validation_failure diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.OperationStateType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.OperationStateType.yml new file mode 100644 index 00000000..ddb095ee --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.OperationStateType.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.OperationStateType +name: OperationStateType +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.OperationStateType +module: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums +fields: +- name: failed + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.OperationStateType.failed +- name: not_started + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.OperationStateType.not_started +- name: running + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.OperationStateType.running +- name: succeeded + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.OperationStateType.succeeded diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.StrictFiltersCompoundOperationType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.StrictFiltersCompoundOperationType.yml new file mode 100644 index 00000000..d282babf --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.StrictFiltersCompoundOperationType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.StrictFiltersCompoundOperationType +name: StrictFiltersCompoundOperationType +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.StrictFiltersCompoundOperationType +module: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums +fields: +- name: and_enum + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.StrictFiltersCompoundOperationType.and_enum +- name: or_enum + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.StrictFiltersCompoundOperationType.or_enum diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.yml new file mode 100644 index 00000000..2fb132c4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums +name: qn_amaker_client_enums +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums +enums: +- azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.EnvironmentType +- azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.ErrorCodeType +- azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.OperationStateType +- azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.StrictFiltersCompoundOperationType diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result.QnASearchResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result.QnASearchResult.yml new file mode 100644 index 00000000..afc662fe --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result.QnASearchResult.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result.QnASearchResult +name: QnASearchResult +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result.QnASearchResult +module: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result +summary: Represents Search Result. +constructor: + syntax: QnASearchResult(**kwargs) + parameters: + - name: questions + description: List of questions. + isRequired: true + types: + - [] + - name: answer + description: Answer. + isRequired: true + types: + - + - name: score + description: Search result score. + isRequired: true + types: + - + - name: id + description: Id of the QnA result. + isRequired: true + types: + - + - name: source + description: Source of QnA result. + isRequired: true + types: + - + - name: metadata + description: List of metadata. + isRequired: true + types: + - [] + - name: context + description: Context object of the QnA + isRequired: true + types: + - + - name: answer_span + description: 'Answer span object of QnA with respect to user''s + + question.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result.QnASearchResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result.QnASearchResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result.QnASearchResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result.QnASearchResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result.QnASearchResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result.QnASearchResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result.QnASearchResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result.yml new file mode 100644 index 00000000..9c5357ad --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result +name: qn_asearch_result +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result.QnASearchResult diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span.QnASearchResultAnswerSpan.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span.QnASearchResultAnswerSpan.yml new file mode 100644 index 00000000..067813c6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span.QnASearchResultAnswerSpan.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span.QnASearchResultAnswerSpan +name: QnASearchResultAnswerSpan +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span.QnASearchResultAnswerSpan +module: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span +summary: Answer span object of QnA with respect to user's question. +constructor: + syntax: QnASearchResultAnswerSpan(**kwargs) + parameters: + - name: text + description: Predicted text of answer span. + isRequired: true + types: + - + - name: score + description: Predicted score of answer span. + isRequired: true + types: + - + - name: start_index + description: Start index of answer span in answer. + isRequired: true + types: + - + - name: end_index + description: End index of answer span in answer. + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span.QnASearchResultAnswerSpan.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span.QnASearchResultAnswerSpan.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span.QnASearchResultAnswerSpan.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span.QnASearchResultAnswerSpan.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span.QnASearchResultAnswerSpan.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span.QnASearchResultAnswerSpan.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span.QnASearchResultAnswerSpan.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span.yml new file mode 100644 index 00000000..dde0553f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span +name: qn_asearch_result_answer_span +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span.QnASearchResultAnswerSpan diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.QnASearchResultAnswerSpan.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.QnASearchResultAnswerSpan.yml new file mode 100644 index 00000000..973b6bd9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.QnASearchResultAnswerSpan.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.QnASearchResultAnswerSpan +name: QnASearchResultAnswerSpan +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.QnASearchResultAnswerSpan +module: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3 +summary: Answer span object of QnA with respect to user's question. +constructor: + syntax: 'QnASearchResultAnswerSpan(*, text: str = None, score: float = None, start_index: + int = None, end_index: int = None, **kwargs)' + parameters: + - name: text + description: Predicted text of answer span. + isRequired: true + types: + - + - name: score + description: Predicted score of answer span. + isRequired: true + types: + - + - name: start_index + description: Start index of answer span in answer. + isRequired: true + types: + - + - name: end_index + description: End index of answer span in answer. + isRequired: true + types: + - + keywordOnlyParameters: + - name: text + isRequired: true + - name: score + isRequired: true + - name: start_index + isRequired: true + - name: end_index + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.QnASearchResultAnswerSpan.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.QnASearchResultAnswerSpan.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.QnASearchResultAnswerSpan.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.QnASearchResultAnswerSpan.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.QnASearchResultAnswerSpan.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.QnASearchResultAnswerSpan.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.QnASearchResultAnswerSpan.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.yml new file mode 100644 index 00000000..88985182 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3 +name: qn_asearch_result_answer_span_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.QnASearchResultAnswerSpan diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context.QnASearchResultContext.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context.QnASearchResultContext.yml new file mode 100644 index 00000000..752ba2ca --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context.QnASearchResultContext.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context.QnASearchResultContext +name: QnASearchResultContext +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context.QnASearchResultContext +module: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context +summary: Context object of the QnA. +constructor: + syntax: QnASearchResultContext(**kwargs) + parameters: + - name: is_context_only + description: 'To mark if a prompt is relevant only with a + + previous question or not. + + true - Do not include this QnA as search result for queries without + + context + + false - ignores context and includes this QnA in search result' + isRequired: true + types: + - + - name: prompts + description: List of prompts associated with the answer. + isRequired: true + types: + - [] +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context.QnASearchResultContext.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context.QnASearchResultContext.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context.QnASearchResultContext.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context.QnASearchResultContext.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context.QnASearchResultContext.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context.QnASearchResultContext.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context.QnASearchResultContext.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context.yml new file mode 100644 index 00000000..f6f81ece --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context +name: qn_asearch_result_context +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context.QnASearchResultContext diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.QnASearchResultContext.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.QnASearchResultContext.yml new file mode 100644 index 00000000..9295c32f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.QnASearchResultContext.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.QnASearchResultContext +name: QnASearchResultContext +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.QnASearchResultContext +module: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3 +summary: Context object of the QnA. +constructor: + syntax: 'QnASearchResultContext(*, is_context_only: bool = None, prompts=None, **kwargs)' + parameters: + - name: is_context_only + description: 'To mark if a prompt is relevant only with a + + previous question or not. + + true - Do not include this QnA as search result for queries without + + context + + false - ignores context and includes this QnA in search result' + isRequired: true + types: + - + - name: prompts + description: List of prompts associated with the answer. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: is_context_only + isRequired: true + - name: prompts + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.QnASearchResultContext.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.QnASearchResultContext.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.QnASearchResultContext.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.QnASearchResultContext.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.QnASearchResultContext.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.QnASearchResultContext.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.QnASearchResultContext.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.yml new file mode 100644 index 00000000..95ed5059 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3 +name: qn_asearch_result_context_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.QnASearchResultContext diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list.QnASearchResultList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list.QnASearchResultList.yml new file mode 100644 index 00000000..4257b32b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list.QnASearchResultList.yml @@ -0,0 +1,120 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list.QnASearchResultList +name: QnASearchResultList +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list.QnASearchResultList +module: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list +summary: Represents List of Question Answers. +constructor: + syntax: QnASearchResultList(**kwargs) + parameters: + - name: answers + description: Represents Search Result list. + isRequired: true + types: + - [] +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list.QnASearchResultList.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list.QnASearchResultList.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list.QnASearchResultList.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list.QnASearchResultList.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list.QnASearchResultList.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list.QnASearchResultList.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list.QnASearchResultList.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list.yml new file mode 100644 index 00000000..fb1d6bc5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list +name: qn_asearch_result_list +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list.QnASearchResultList diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.QnASearchResultList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.QnASearchResultList.yml new file mode 100644 index 00000000..d054151b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.QnASearchResultList.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.QnASearchResultList +name: QnASearchResultList +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.QnASearchResultList +module: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3 +summary: Represents List of Question Answers. +constructor: + syntax: QnASearchResultList(*, answers=None, **kwargs) + parameters: + - name: answers + description: Represents Search Result list. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: answers + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.QnASearchResultList.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.QnASearchResultList.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.QnASearchResultList.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.QnASearchResultList.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.QnASearchResultList.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.QnASearchResultList.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.QnASearchResultList.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.yml new file mode 100644 index 00000000..d94564be --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3 +name: qn_asearch_result_list_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.QnASearchResultList diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.QnASearchResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.QnASearchResult.yml new file mode 100644 index 00000000..051d5d3b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.QnASearchResult.yml @@ -0,0 +1,176 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.QnASearchResult +name: QnASearchResult +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.QnASearchResult +module: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3 +summary: Represents Search Result. +constructor: + syntax: 'QnASearchResult(*, questions=None, answer: str = None, score: float = None, + id: int = None, source: str = None, metadata=None, context=None, answer_span=None, + **kwargs)' + parameters: + - name: questions + description: List of questions. + isRequired: true + types: + - [] + - name: answer + description: Answer. + isRequired: true + types: + - + - name: score + description: Search result score. + isRequired: true + types: + - + - name: id + description: Id of the QnA result. + isRequired: true + types: + - + - name: source + description: Source of QnA result. + isRequired: true + types: + - + - name: metadata + description: List of metadata. + isRequired: true + types: + - [] + - name: context + description: Context object of the QnA + isRequired: true + types: + - + - name: answer_span + description: 'Answer span object of QnA with respect to user''s + + question.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: questions + isRequired: true + - name: answer + isRequired: true + - name: score + isRequired: true + - name: id + isRequired: true + - name: source + isRequired: true + - name: metadata + isRequired: true + - name: context + isRequired: true + - name: answer_span + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.QnASearchResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.QnASearchResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.QnASearchResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.QnASearchResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.QnASearchResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.QnASearchResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.QnASearchResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.yml new file mode 100644 index 00000000..993b510a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3 +name: qn_asearch_result_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.QnASearchResult diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto.QueryContextDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto.QueryContextDTO.yml new file mode 100644 index 00000000..f7713b8f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto.QueryContextDTO.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto.QueryContextDTO +name: QueryContextDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto.QueryContextDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto +summary: Context object with previous QnA's information. +constructor: + syntax: QueryContextDTO(**kwargs) + parameters: + - name: previous_qna_id + description: Previous QnA Id - qnaId of the top result. + isRequired: true + types: + - + - name: previous_user_query + description: Previous user query. + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto.QueryContextDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto.QueryContextDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto.QueryContextDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto.QueryContextDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto.QueryContextDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto.QueryContextDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto.QueryContextDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto.yml new file mode 100644 index 00000000..6c4084c8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto +name: query_context_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto.QueryContextDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.QueryContextDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.QueryContextDTO.yml new file mode 100644 index 00000000..6b3e9d9f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.QueryContextDTO.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.QueryContextDTO +name: QueryContextDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.QueryContextDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3 +summary: Context object with previous QnA's information. +constructor: + syntax: 'QueryContextDTO(*, previous_qna_id: int = None, previous_user_query: str + = None, **kwargs)' + parameters: + - name: previous_qna_id + description: Previous QnA Id - qnaId of the top result. + isRequired: true + types: + - + - name: previous_user_query + description: Previous user query. + isRequired: true + types: + - + keywordOnlyParameters: + - name: previous_qna_id + isRequired: true + - name: previous_user_query + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.QueryContextDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.QueryContextDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.QueryContextDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.QueryContextDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.QueryContextDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.QueryContextDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.QueryContextDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.yml new file mode 100644 index 00000000..5369d259 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3 +name: query_context_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.QueryContextDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto.QueryDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto.QueryDTO.yml new file mode 100644 index 00000000..12d6b6a5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto.QueryDTO.yml @@ -0,0 +1,181 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto.QueryDTO +name: QueryDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.query_dto.QueryDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.query_dto +summary: POST body schema to query the knowledgebase. +constructor: + syntax: QueryDTO(**kwargs) + parameters: + - name: qna_id + description: 'Exact qnaId to fetch from the knowledgebase, this field + + takes priority over question.' + isRequired: true + types: + - + - name: question + description: User question to query against the knowledge base. + isRequired: true + types: + - + - name: top + description: Max number of answers to be returned for the question. + isRequired: true + types: + - + - name: user_id + description: Unique identifier for the user. + isRequired: true + types: + - + - name: is_test + description: Query against the test index. + isRequired: true + types: + - + - name: score_threshold + description: Minimum threshold score for answers. + isRequired: true + types: + - + - name: context + description: Context object with previous QnA's information. + isRequired: true + types: + - + - name: ranker_type + description: 'Optional field. Set to ''QuestionOnly'' for using a + + question only Ranker.' + isRequired: true + types: + - + - name: strict_filters + description: 'Find QnAs that are associated with the given list + + of metadata.' + isRequired: true + types: + - [] + - name: strict_filters_compound_operation_type + description: 'Optional field. Set to ''OR'' + + for using OR operation for strict filters. Possible values include: ''AND'', + + ''OR''' + isRequired: true + types: + - + - + - name: answer_span_request + description: To configure Answer span prediction feature. + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto.QueryDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto.QueryDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto.QueryDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto.QueryDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto.QueryDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto.QueryDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto.QueryDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto.yml new file mode 100644 index 00000000..02d09101 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto +name: query_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.query_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.query_dto.QueryDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request.QueryDTOAnswerSpanRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request.QueryDTOAnswerSpanRequest.yml new file mode 100644 index 00000000..99fe82f9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request.QueryDTOAnswerSpanRequest.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request.QueryDTOAnswerSpanRequest +name: QueryDTOAnswerSpanRequest +fullName: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request.QueryDTOAnswerSpanRequest +module: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request +summary: To configure Answer span prediction feature. +constructor: + syntax: QueryDTOAnswerSpanRequest(**kwargs) + parameters: + - name: enable + description: Enable or Disable Answer Span prediction. + isRequired: true + types: + - + - name: score_threshold + description: 'Minimum threshold score required to include an + + answer span.' + isRequired: true + types: + - + - name: top_answers_with_span + description: 'Number of Top answers to be considered for + + span prediction.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request.QueryDTOAnswerSpanRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request.QueryDTOAnswerSpanRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request.QueryDTOAnswerSpanRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request.QueryDTOAnswerSpanRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request.QueryDTOAnswerSpanRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request.QueryDTOAnswerSpanRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request.QueryDTOAnswerSpanRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request.yml new file mode 100644 index 00000000..89c54115 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request +name: query_dto_answer_span_request +fullName: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request.QueryDTOAnswerSpanRequest diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.QueryDTOAnswerSpanRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.QueryDTOAnswerSpanRequest.yml new file mode 100644 index 00000000..92b7fb8a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.QueryDTOAnswerSpanRequest.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.QueryDTOAnswerSpanRequest +name: QueryDTOAnswerSpanRequest +fullName: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.QueryDTOAnswerSpanRequest +module: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3 +summary: To configure Answer span prediction feature. +constructor: + syntax: 'QueryDTOAnswerSpanRequest(*, enable: bool = None, score_threshold: float + = None, top_answers_with_span: int = None, **kwargs)' + parameters: + - name: enable + description: Enable or Disable Answer Span prediction. + isRequired: true + types: + - + - name: score_threshold + description: 'Minimum threshold score required to include an + + answer span.' + isRequired: true + types: + - + - name: top_answers_with_span + description: 'Number of Top answers to be considered for + + span prediction.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: enable + isRequired: true + - name: score_threshold + isRequired: true + - name: top_answers_with_span + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.QueryDTOAnswerSpanRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.QueryDTOAnswerSpanRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.QueryDTOAnswerSpanRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.QueryDTOAnswerSpanRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.QueryDTOAnswerSpanRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.QueryDTOAnswerSpanRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.QueryDTOAnswerSpanRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.yml new file mode 100644 index 00000000..49b47428 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3 +name: query_dto_answer_span_request_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.QueryDTOAnswerSpanRequest diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context.QueryDTOContext.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context.QueryDTOContext.yml new file mode 100644 index 00000000..da63b08b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context.QueryDTOContext.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context.QueryDTOContext +name: QueryDTOContext +fullName: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context.QueryDTOContext +module: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context +summary: Context object with previous QnA's information. +constructor: + syntax: QueryDTOContext(**kwargs) + parameters: + - name: previous_qna_id + description: Previous QnA Id - qnaId of the top result. + isRequired: true + types: + - + - name: previous_user_query + description: Previous user query. + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context.QueryDTOContext.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context.QueryDTOContext.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context.QueryDTOContext.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context.QueryDTOContext.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context.QueryDTOContext.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context.QueryDTOContext.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context.QueryDTOContext.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context.yml new file mode 100644 index 00000000..3862c393 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context +name: query_dto_context +fullName: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context.QueryDTOContext diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.QueryDTOContext.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.QueryDTOContext.yml new file mode 100644 index 00000000..e7eebad2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.QueryDTOContext.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.QueryDTOContext +name: QueryDTOContext +fullName: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.QueryDTOContext +module: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3 +summary: Context object with previous QnA's information. +constructor: + syntax: 'QueryDTOContext(*, previous_qna_id: int = None, previous_user_query: str + = None, **kwargs)' + parameters: + - name: previous_qna_id + description: Previous QnA Id - qnaId of the top result. + isRequired: true + types: + - + - name: previous_user_query + description: Previous user query. + isRequired: true + types: + - + keywordOnlyParameters: + - name: previous_qna_id + isRequired: true + - name: previous_user_query + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.QueryDTOContext.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.QueryDTOContext.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.QueryDTOContext.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.QueryDTOContext.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.QueryDTOContext.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.QueryDTOContext.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.QueryDTOContext.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.yml new file mode 100644 index 00000000..6429de33 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3 +name: query_dto_context_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.QueryDTOContext diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.QueryDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.QueryDTO.yml new file mode 100644 index 00000000..57d253ba --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.QueryDTO.yml @@ -0,0 +1,207 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.QueryDTO +name: QueryDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.QueryDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3 +summary: POST body schema to query the knowledgebase. +constructor: + syntax: 'QueryDTO(*, qna_id: str = None, question: str = None, top: int = None, + user_id: str = None, is_test: bool = None, score_threshold: float = None, context=None, + ranker_type: str = None, strict_filters=None, strict_filters_compound_operation_type=None, + answer_span_request=None, **kwargs)' + parameters: + - name: qna_id + description: 'Exact qnaId to fetch from the knowledgebase, this field + + takes priority over question.' + isRequired: true + types: + - + - name: question + description: User question to query against the knowledge base. + isRequired: true + types: + - + - name: top + description: Max number of answers to be returned for the question. + isRequired: true + types: + - + - name: user_id + description: Unique identifier for the user. + isRequired: true + types: + - + - name: is_test + description: Query against the test index. + isRequired: true + types: + - + - name: score_threshold + description: Minimum threshold score for answers. + isRequired: true + types: + - + - name: context + description: Context object with previous QnA's information. + isRequired: true + types: + - + - name: ranker_type + description: 'Optional field. Set to ''QuestionOnly'' for using a + + question only Ranker.' + isRequired: true + types: + - + - name: strict_filters + description: 'Find QnAs that are associated with the given list + + of metadata.' + isRequired: true + types: + - [] + - name: strict_filters_compound_operation_type + description: 'Optional field. Set to ''OR'' + + for using OR operation for strict filters. Possible values include: ''AND'', + + ''OR''' + isRequired: true + types: + - + - + - name: answer_span_request + description: To configure Answer span prediction feature. + isRequired: true + types: + - + keywordOnlyParameters: + - name: qna_id + isRequired: true + - name: question + isRequired: true + - name: top + isRequired: true + - name: user_id + isRequired: true + - name: is_test + isRequired: true + - name: score_threshold + isRequired: true + - name: context + isRequired: true + - name: ranker_type + isRequired: true + - name: strict_filters + isRequired: true + - name: strict_filters_compound_operation_type + isRequired: true + - name: answer_span_request + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.QueryDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.QueryDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.QueryDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.QueryDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.QueryDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.QueryDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.QueryDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.yml new file mode 100644 index 00000000..399fe90d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3 +name: query_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.QueryDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto.ReplaceKbDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto.ReplaceKbDTO.yml new file mode 100644 index 00000000..b54b40e4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto.ReplaceKbDTO.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto.ReplaceKbDTO +name: ReplaceKbDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto.ReplaceKbDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto +summary: 'Post body schema for Replace KB operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ReplaceKbDTO(**kwargs) + parameters: + - name: qn_alist + description: 'Required. List of Q-A (QnADTO) to be added to the + + knowledgebase. Q-A Ids are assigned by the service and should be omitted.' + isRequired: true + types: + - [] +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto.ReplaceKbDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto.ReplaceKbDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto.ReplaceKbDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto.ReplaceKbDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto.ReplaceKbDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto.ReplaceKbDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto.ReplaceKbDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto.yml new file mode 100644 index 00000000..8d9e1f37 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto +name: replace_kb_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto.ReplaceKbDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3.ReplaceKbDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3.ReplaceKbDTO.yml new file mode 100644 index 00000000..5e758e8e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3.ReplaceKbDTO.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3.ReplaceKbDTO +name: ReplaceKbDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3.ReplaceKbDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3 +summary: 'Post body schema for Replace KB operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ReplaceKbDTO(*, qn_alist, **kwargs) + parameters: + - name: qn_alist + description: 'Required. List of Q-A (QnADTO) to be added to the + + knowledgebase. Q-A Ids are assigned by the service and should be omitted.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: qn_alist + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3.ReplaceKbDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3.ReplaceKbDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3.ReplaceKbDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3.ReplaceKbDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3.ReplaceKbDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3.ReplaceKbDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3.ReplaceKbDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3.yml new file mode 100644 index 00000000..2f40ae2e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3 +name: replace_kb_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3.ReplaceKbDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto.UpdateContextDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto.UpdateContextDTO.yml new file mode 100644 index 00000000..e743dfd8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto.UpdateContextDTO.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto.UpdateContextDTO +name: UpdateContextDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto.UpdateContextDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto +summary: Update Body schema to represent context to be updated. +constructor: + syntax: UpdateContextDTO(**kwargs) + parameters: + - name: prompts_to_delete + description: 'List of prompts associated with qna to be + + deleted' + isRequired: true + types: + - [] + - name: prompts_to_add + description: List of prompts to be added to the qna. + isRequired: true + types: + - [] + - name: is_context_only + description: 'To mark if a prompt is relevant only with a + + previous question or not. + + true - Do not include this QnA as search result for queries without + + context + + false - ignores context and includes this QnA in search result' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto.UpdateContextDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto.UpdateContextDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto.UpdateContextDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto.UpdateContextDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto.UpdateContextDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto.UpdateContextDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto.UpdateContextDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto.yml new file mode 100644 index 00000000..77f30163 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto +name: update_context_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto.UpdateContextDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.UpdateContextDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.UpdateContextDTO.yml new file mode 100644 index 00000000..3e861e93 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.UpdateContextDTO.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.UpdateContextDTO +name: UpdateContextDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.UpdateContextDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3 +summary: Update Body schema to represent context to be updated. +constructor: + syntax: 'UpdateContextDTO(*, prompts_to_delete=None, prompts_to_add=None, is_context_only: + bool = None, **kwargs)' + parameters: + - name: prompts_to_delete + description: 'List of prompts associated with qna to be + + deleted' + isRequired: true + types: + - [] + - name: prompts_to_add + description: List of prompts to be added to the qna. + isRequired: true + types: + - [] + - name: is_context_only + description: 'To mark if a prompt is relevant only with a + + previous question or not. + + true - Do not include this QnA as search result for queries without + + context + + false - ignores context and includes this QnA in search result' + isRequired: true + types: + - + keywordOnlyParameters: + - name: prompts_to_delete + isRequired: true + - name: prompts_to_add + isRequired: true + - name: is_context_only + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.UpdateContextDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.UpdateContextDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.UpdateContextDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.UpdateContextDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.UpdateContextDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.UpdateContextDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.UpdateContextDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.yml new file mode 100644 index 00000000..d75370a1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3 +name: update_context_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.UpdateContextDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto.UpdateKbContentsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto.UpdateKbContentsDTO.yml new file mode 100644 index 00000000..05a17164 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto.UpdateKbContentsDTO.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto.UpdateKbContentsDTO +name: UpdateKbContentsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto.UpdateKbContentsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto +summary: PATCH body schema for Update operation in Update Kb. +constructor: + syntax: UpdateKbContentsDTO(**kwargs) + parameters: + - name: name + description: Friendly name for the knowledgebase. + isRequired: true + types: + - + - name: qna_list + description: 'List of Q-A (UpdateQnaDTO) to be added to the + + knowledgebase.' + isRequired: true + types: + - [] + - name: urls + description: 'List of existing URLs to be refreshed. The content will be + + extracted again and re-indexed.' + isRequired: true + types: + - [] + - name: default_answer + description: 'Default answer sent to user if no good match is + + found in the KB.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto.UpdateKbContentsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto.UpdateKbContentsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto.UpdateKbContentsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto.UpdateKbContentsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto.UpdateKbContentsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto.UpdateKbContentsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto.UpdateKbContentsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto.yml new file mode 100644 index 00000000..2ea7b3b9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto +name: update_kb_contents_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto.UpdateKbContentsDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.UpdateKbContentsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.UpdateKbContentsDTO.yml new file mode 100644 index 00000000..56040735 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.UpdateKbContentsDTO.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.UpdateKbContentsDTO +name: UpdateKbContentsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.UpdateKbContentsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3 +summary: PATCH body schema for Update operation in Update Kb. +constructor: + syntax: 'UpdateKbContentsDTO(*, name: str = None, qna_list=None, urls=None, default_answer: + str = None, **kwargs)' + parameters: + - name: name + description: Friendly name for the knowledgebase. + isRequired: true + types: + - + - name: qna_list + description: 'List of Q-A (UpdateQnaDTO) to be added to the + + knowledgebase.' + isRequired: true + types: + - [] + - name: urls + description: 'List of existing URLs to be refreshed. The content will be + + extracted again and re-indexed.' + isRequired: true + types: + - [] + - name: default_answer + description: 'Default answer sent to user if no good match is + + found in the KB.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: qna_list + isRequired: true + - name: urls + isRequired: true + - name: default_answer + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.UpdateKbContentsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.UpdateKbContentsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.UpdateKbContentsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.UpdateKbContentsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.UpdateKbContentsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.UpdateKbContentsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.UpdateKbContentsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.yml new file mode 100644 index 00000000..78e3e7a7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3 +name: update_kb_contents_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.UpdateKbContentsDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto.UpdateKbOperationDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto.UpdateKbOperationDTO.yml new file mode 100644 index 00000000..a8c8b01b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto.UpdateKbOperationDTO.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto.UpdateKbOperationDTO +name: UpdateKbOperationDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto.UpdateKbOperationDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto +summary: Contains list of QnAs to be updated. +constructor: + syntax: UpdateKbOperationDTO(**kwargs) + parameters: + - name: add + description: An instance of CreateKbInputDTO for add operation + isRequired: true + types: + - + - name: delete + description: An instance of DeleteKbContentsDTO for delete Operation + isRequired: true + types: + - + - name: update + description: An instance of UpdateKbContentsDTO for Update Operation + isRequired: true + types: + - + - name: enable_hierarchical_extraction + description: 'Enable hierarchical extraction of + + Q-A from files and urls. The value set during KB creation will be used if + + this field is not present.' + isRequired: true + types: + - + - name: default_answer_used_for_extraction + description: 'Text string to be used as the + + answer in any Q-A which has no extracted answer from the document but has + + a hierarchy. Required when EnableHierarchicalExtraction field is set to + + True.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto.UpdateKbOperationDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto.UpdateKbOperationDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto.UpdateKbOperationDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto.UpdateKbOperationDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto.UpdateKbOperationDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto.UpdateKbOperationDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto.UpdateKbOperationDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto.yml new file mode 100644 index 00000000..88fb3a36 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto +name: update_kb_operation_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto.UpdateKbOperationDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add.UpdateKbOperationDTOAdd.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add.UpdateKbOperationDTOAdd.yml new file mode 100644 index 00000000..80eac8b5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add.UpdateKbOperationDTOAdd.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add.UpdateKbOperationDTOAdd +name: UpdateKbOperationDTOAdd +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add.UpdateKbOperationDTOAdd +module: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add +summary: An instance of CreateKbInputDTO for add operation. +constructor: + syntax: UpdateKbOperationDTOAdd(**kwargs) + parameters: + - name: qna_list + description: 'List of QNA to be added to the index. Ids are generated + + by the service and should be omitted.' + isRequired: true + types: + - [] + - name: urls + description: List of URLs to be added to knowledgebase. + isRequired: true + types: + - [] + - name: files + description: List of files to be added to knowledgebase. + isRequired: true + types: + - [] +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add.UpdateKbOperationDTOAdd.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add.UpdateKbOperationDTOAdd.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add.UpdateKbOperationDTOAdd.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add.UpdateKbOperationDTOAdd.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add.UpdateKbOperationDTOAdd.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add.UpdateKbOperationDTOAdd.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add.UpdateKbOperationDTOAdd.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add.yml new file mode 100644 index 00000000..8756df11 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add +name: update_kb_operation_dto_add +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add.UpdateKbOperationDTOAdd diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.UpdateKbOperationDTOAdd.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.UpdateKbOperationDTOAdd.yml new file mode 100644 index 00000000..e0ab1909 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.UpdateKbOperationDTOAdd.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.UpdateKbOperationDTOAdd +name: UpdateKbOperationDTOAdd +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.UpdateKbOperationDTOAdd +module: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3 +summary: An instance of CreateKbInputDTO for add operation. +constructor: + syntax: UpdateKbOperationDTOAdd(*, qna_list=None, urls=None, files=None, **kwargs) + parameters: + - name: qna_list + description: 'List of QNA to be added to the index. Ids are generated + + by the service and should be omitted.' + isRequired: true + types: + - [] + - name: urls + description: List of URLs to be added to knowledgebase. + isRequired: true + types: + - [] + - name: files + description: List of files to be added to knowledgebase. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: qna_list + isRequired: true + - name: urls + isRequired: true + - name: files + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.UpdateKbOperationDTOAdd.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.UpdateKbOperationDTOAdd.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.UpdateKbOperationDTOAdd.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.UpdateKbOperationDTOAdd.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.UpdateKbOperationDTOAdd.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.UpdateKbOperationDTOAdd.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.UpdateKbOperationDTOAdd.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.yml new file mode 100644 index 00000000..7b6d8fa7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3 +name: update_kb_operation_dto_add_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.UpdateKbOperationDTOAdd diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete.UpdateKbOperationDTODelete.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete.UpdateKbOperationDTODelete.yml new file mode 100644 index 00000000..4f122b98 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete.UpdateKbOperationDTODelete.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete.UpdateKbOperationDTODelete +name: UpdateKbOperationDTODelete +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete.UpdateKbOperationDTODelete +module: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete +summary: An instance of DeleteKbContentsDTO for delete Operation. +constructor: + syntax: UpdateKbOperationDTODelete(**kwargs) + parameters: + - name: ids + description: List of Qna Ids to be deleted + isRequired: true + types: + - [] + - name: sources + description: List of sources to be deleted from knowledgebase. + isRequired: true + types: + - [] +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete.UpdateKbOperationDTODelete.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete.UpdateKbOperationDTODelete.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete.UpdateKbOperationDTODelete.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete.UpdateKbOperationDTODelete.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete.UpdateKbOperationDTODelete.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete.UpdateKbOperationDTODelete.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete.UpdateKbOperationDTODelete.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete.yml new file mode 100644 index 00000000..1ca16b1a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete +name: update_kb_operation_dto_delete +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete.UpdateKbOperationDTODelete diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.UpdateKbOperationDTODelete.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.UpdateKbOperationDTODelete.yml new file mode 100644 index 00000000..a5871242 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.UpdateKbOperationDTODelete.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.UpdateKbOperationDTODelete +name: UpdateKbOperationDTODelete +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.UpdateKbOperationDTODelete +module: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3 +summary: An instance of DeleteKbContentsDTO for delete Operation. +constructor: + syntax: UpdateKbOperationDTODelete(*, ids=None, sources=None, **kwargs) + parameters: + - name: ids + description: List of Qna Ids to be deleted + isRequired: true + types: + - [] + - name: sources + description: List of sources to be deleted from knowledgebase. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: ids + isRequired: true + - name: sources + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.UpdateKbOperationDTODelete.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.UpdateKbOperationDTODelete.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.UpdateKbOperationDTODelete.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.UpdateKbOperationDTODelete.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.UpdateKbOperationDTODelete.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.UpdateKbOperationDTODelete.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.UpdateKbOperationDTODelete.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.yml new file mode 100644 index 00000000..b1e7c576 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3 +name: update_kb_operation_dto_delete_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.UpdateKbOperationDTODelete diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.UpdateKbOperationDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.UpdateKbOperationDTO.yml new file mode 100644 index 00000000..81ce12c9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.UpdateKbOperationDTO.yml @@ -0,0 +1,162 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.UpdateKbOperationDTO +name: UpdateKbOperationDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.UpdateKbOperationDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3 +summary: Contains list of QnAs to be updated. +constructor: + syntax: 'UpdateKbOperationDTO(*, add=None, delete=None, update=None, enable_hierarchical_extraction: + bool = None, default_answer_used_for_extraction: str = None, **kwargs)' + parameters: + - name: add + description: An instance of CreateKbInputDTO for add operation + isRequired: true + types: + - + - name: delete + description: An instance of DeleteKbContentsDTO for delete Operation + isRequired: true + types: + - + - name: update + description: An instance of UpdateKbContentsDTO for Update Operation + isRequired: true + types: + - + - name: enable_hierarchical_extraction + description: 'Enable hierarchical extraction of + + Q-A from files and urls. The value set during KB creation will be used if + + this field is not present.' + isRequired: true + types: + - + - name: default_answer_used_for_extraction + description: 'Text string to be used as the + + answer in any Q-A which has no extracted answer from the document but has + + a hierarchy. Required when EnableHierarchicalExtraction field is set to + + True.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: add + isRequired: true + - name: delete + isRequired: true + - name: update + isRequired: true + - name: enable_hierarchical_extraction + isRequired: true + - name: default_answer_used_for_extraction + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.UpdateKbOperationDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.UpdateKbOperationDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.UpdateKbOperationDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.UpdateKbOperationDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.UpdateKbOperationDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.UpdateKbOperationDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.UpdateKbOperationDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.yml new file mode 100644 index 00000000..80ac405c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3 +name: update_kb_operation_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.UpdateKbOperationDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update.UpdateKbOperationDTOUpdate.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update.UpdateKbOperationDTOUpdate.yml new file mode 100644 index 00000000..a0f440d0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update.UpdateKbOperationDTOUpdate.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update.UpdateKbOperationDTOUpdate +name: UpdateKbOperationDTOUpdate +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update.UpdateKbOperationDTOUpdate +module: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update +summary: An instance of UpdateKbContentsDTO for Update Operation. +constructor: + syntax: UpdateKbOperationDTOUpdate(**kwargs) + parameters: + - name: name + description: Friendly name for the knowledgebase. + isRequired: true + types: + - + - name: qna_list + description: 'List of Q-A (UpdateQnaDTO) to be added to the + + knowledgebase.' + isRequired: true + types: + - [] + - name: urls + description: 'List of existing URLs to be refreshed. The content will be + + extracted again and re-indexed.' + isRequired: true + types: + - [] + - name: default_answer + description: 'Default answer sent to user if no good match is + + found in the KB.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update.UpdateKbOperationDTOUpdate.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update.UpdateKbOperationDTOUpdate.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update.UpdateKbOperationDTOUpdate.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update.UpdateKbOperationDTOUpdate.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update.UpdateKbOperationDTOUpdate.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update.UpdateKbOperationDTOUpdate.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update.UpdateKbOperationDTOUpdate.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update.yml new file mode 100644 index 00000000..c19b3e2f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update +name: update_kb_operation_dto_update +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update.UpdateKbOperationDTOUpdate diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.UpdateKbOperationDTOUpdate.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.UpdateKbOperationDTOUpdate.yml new file mode 100644 index 00000000..8e749e03 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.UpdateKbOperationDTOUpdate.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.UpdateKbOperationDTOUpdate +name: UpdateKbOperationDTOUpdate +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.UpdateKbOperationDTOUpdate +module: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3 +summary: An instance of UpdateKbContentsDTO for Update Operation. +constructor: + syntax: 'UpdateKbOperationDTOUpdate(*, name: str = None, qna_list=None, urls=None, + default_answer: str = None, **kwargs)' + parameters: + - name: name + description: Friendly name for the knowledgebase. + isRequired: true + types: + - + - name: qna_list + description: 'List of Q-A (UpdateQnaDTO) to be added to the + + knowledgebase.' + isRequired: true + types: + - [] + - name: urls + description: 'List of existing URLs to be refreshed. The content will be + + extracted again and re-indexed.' + isRequired: true + types: + - [] + - name: default_answer + description: 'Default answer sent to user if no good match is + + found in the KB.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: qna_list + isRequired: true + - name: urls + isRequired: true + - name: default_answer + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.UpdateKbOperationDTOUpdate.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.UpdateKbOperationDTOUpdate.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.UpdateKbOperationDTOUpdate.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.UpdateKbOperationDTOUpdate.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.UpdateKbOperationDTOUpdate.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.UpdateKbOperationDTOUpdate.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.UpdateKbOperationDTOUpdate.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.yml new file mode 100644 index 00000000..6151a5f1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3 +name: update_kb_operation_dto_update_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.UpdateKbOperationDTOUpdate diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto.UpdateMetadataDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto.UpdateMetadataDTO.yml new file mode 100644 index 00000000..1873c91b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto.UpdateMetadataDTO.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto.UpdateMetadataDTO +name: UpdateMetadataDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto.UpdateMetadataDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto +summary: PATCH Body schema to represent list of Metadata to be updated. +constructor: + syntax: UpdateMetadataDTO(**kwargs) + parameters: + - name: delete + description: List of Metadata associated with answer to be deleted + isRequired: true + types: + - [] + - name: add + description: List of metadata associated with answer to be added + isRequired: true + types: + - [] +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto.UpdateMetadataDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto.UpdateMetadataDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto.UpdateMetadataDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto.UpdateMetadataDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto.UpdateMetadataDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto.UpdateMetadataDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto.UpdateMetadataDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto.yml new file mode 100644 index 00000000..1e5cca49 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto +name: update_metadata_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto.UpdateMetadataDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.UpdateMetadataDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.UpdateMetadataDTO.yml new file mode 100644 index 00000000..524d6e36 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.UpdateMetadataDTO.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.UpdateMetadataDTO +name: UpdateMetadataDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.UpdateMetadataDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3 +summary: PATCH Body schema to represent list of Metadata to be updated. +constructor: + syntax: UpdateMetadataDTO(*, delete=None, add=None, **kwargs) + parameters: + - name: delete + description: List of Metadata associated with answer to be deleted + isRequired: true + types: + - [] + - name: add + description: List of metadata associated with answer to be added + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: delete + isRequired: true + - name: add + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.UpdateMetadataDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.UpdateMetadataDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.UpdateMetadataDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.UpdateMetadataDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.UpdateMetadataDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.UpdateMetadataDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.UpdateMetadataDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.yml new file mode 100644 index 00000000..fe6393bd --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3 +name: update_metadata_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.UpdateMetadataDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto.UpdateQnaDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto.UpdateQnaDTO.yml new file mode 100644 index 00000000..b45f55fd --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto.UpdateQnaDTO.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto.UpdateQnaDTO +name: UpdateQnaDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto.UpdateQnaDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto +summary: PATCH Body schema for Update Qna List. +constructor: + syntax: UpdateQnaDTO(**kwargs) + parameters: + - name: id + description: Unique id for the Q-A + isRequired: true + types: + - + - name: answer + description: Answer text + isRequired: true + types: + - + - name: source + description: 'Source from which Q-A was indexed. eg. + + [https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs](https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs)' + isRequired: true + types: + - + - name: questions + description: List of questions associated with the answer. + isRequired: true + types: + - + - name: metadata + description: List of metadata associated with the answer to be updated + isRequired: true + types: + - + - name: context + description: Context associated with Qna to be updated. + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto.UpdateQnaDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto.UpdateQnaDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto.UpdateQnaDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto.UpdateQnaDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto.UpdateQnaDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto.UpdateQnaDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto.UpdateQnaDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto.yml new file mode 100644 index 00000000..19b8b00e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto +name: update_qna_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto.UpdateQnaDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context.UpdateQnaDTOContext.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context.UpdateQnaDTOContext.yml new file mode 100644 index 00000000..7e0e9d29 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context.UpdateQnaDTOContext.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context.UpdateQnaDTOContext +name: UpdateQnaDTOContext +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context.UpdateQnaDTOContext +module: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context +summary: Context associated with Qna to be updated. +constructor: + syntax: UpdateQnaDTOContext(**kwargs) + parameters: + - name: prompts_to_delete + description: 'List of prompts associated with qna to be + + deleted' + isRequired: true + types: + - [] + - name: prompts_to_add + description: List of prompts to be added to the qna. + isRequired: true + types: + - [] + - name: is_context_only + description: 'To mark if a prompt is relevant only with a + + previous question or not. + + true - Do not include this QnA as search result for queries without + + context + + false - ignores context and includes this QnA in search result' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context.UpdateQnaDTOContext.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context.UpdateQnaDTOContext.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context.UpdateQnaDTOContext.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context.UpdateQnaDTOContext.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context.UpdateQnaDTOContext.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context.UpdateQnaDTOContext.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context.UpdateQnaDTOContext.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context.yml new file mode 100644 index 00000000..9e2fce47 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context +name: update_qna_dto_context +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context.UpdateQnaDTOContext diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.UpdateQnaDTOContext.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.UpdateQnaDTOContext.yml new file mode 100644 index 00000000..258888a1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.UpdateQnaDTOContext.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.UpdateQnaDTOContext +name: UpdateQnaDTOContext +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.UpdateQnaDTOContext +module: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3 +summary: Context associated with Qna to be updated. +constructor: + syntax: 'UpdateQnaDTOContext(*, prompts_to_delete=None, prompts_to_add=None, is_context_only: + bool = None, **kwargs)' + parameters: + - name: prompts_to_delete + description: 'List of prompts associated with qna to be + + deleted' + isRequired: true + types: + - [] + - name: prompts_to_add + description: List of prompts to be added to the qna. + isRequired: true + types: + - [] + - name: is_context_only + description: 'To mark if a prompt is relevant only with a + + previous question or not. + + true - Do not include this QnA as search result for queries without + + context + + false - ignores context and includes this QnA in search result' + isRequired: true + types: + - + keywordOnlyParameters: + - name: prompts_to_delete + isRequired: true + - name: prompts_to_add + isRequired: true + - name: is_context_only + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.UpdateQnaDTOContext.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.UpdateQnaDTOContext.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.UpdateQnaDTOContext.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.UpdateQnaDTOContext.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.UpdateQnaDTOContext.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.UpdateQnaDTOContext.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.UpdateQnaDTOContext.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.yml new file mode 100644 index 00000000..b7e567f4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3 +name: update_qna_dto_context_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.UpdateQnaDTOContext diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata.UpdateQnaDTOMetadata.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata.UpdateQnaDTOMetadata.yml new file mode 100644 index 00000000..90cff581 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata.UpdateQnaDTOMetadata.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata.UpdateQnaDTOMetadata +name: UpdateQnaDTOMetadata +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata.UpdateQnaDTOMetadata +module: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata +summary: List of metadata associated with the answer to be updated. +constructor: + syntax: UpdateQnaDTOMetadata(**kwargs) + parameters: + - name: delete + description: List of Metadata associated with answer to be deleted + isRequired: true + types: + - [] + - name: add + description: List of metadata associated with answer to be added + isRequired: true + types: + - [] +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata.UpdateQnaDTOMetadata.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata.UpdateQnaDTOMetadata.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata.UpdateQnaDTOMetadata.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata.UpdateQnaDTOMetadata.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata.UpdateQnaDTOMetadata.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata.UpdateQnaDTOMetadata.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata.UpdateQnaDTOMetadata.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata.yml new file mode 100644 index 00000000..3eda4f88 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata +name: update_qna_dto_metadata +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata.UpdateQnaDTOMetadata diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.UpdateQnaDTOMetadata.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.UpdateQnaDTOMetadata.yml new file mode 100644 index 00000000..b12a810c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.UpdateQnaDTOMetadata.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.UpdateQnaDTOMetadata +name: UpdateQnaDTOMetadata +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.UpdateQnaDTOMetadata +module: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3 +summary: List of metadata associated with the answer to be updated. +constructor: + syntax: UpdateQnaDTOMetadata(*, delete=None, add=None, **kwargs) + parameters: + - name: delete + description: List of Metadata associated with answer to be deleted + isRequired: true + types: + - [] + - name: add + description: List of metadata associated with answer to be added + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: delete + isRequired: true + - name: add + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.UpdateQnaDTOMetadata.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.UpdateQnaDTOMetadata.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.UpdateQnaDTOMetadata.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.UpdateQnaDTOMetadata.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.UpdateQnaDTOMetadata.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.UpdateQnaDTOMetadata.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.UpdateQnaDTOMetadata.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.yml new file mode 100644 index 00000000..016dd923 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3 +name: update_qna_dto_metadata_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.UpdateQnaDTOMetadata diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.UpdateQnaDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.UpdateQnaDTO.yml new file mode 100644 index 00000000..2152d03b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.UpdateQnaDTO.yml @@ -0,0 +1,161 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.UpdateQnaDTO +name: UpdateQnaDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.UpdateQnaDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3 +summary: PATCH Body schema for Update Qna List. +constructor: + syntax: 'UpdateQnaDTO(*, id: int = None, answer: str = None, source: str = None, + questions=None, metadata=None, context=None, **kwargs)' + parameters: + - name: id + description: Unique id for the Q-A + isRequired: true + types: + - + - name: answer + description: Answer text + isRequired: true + types: + - + - name: source + description: 'Source from which Q-A was indexed. eg. + + [https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs](https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs)' + isRequired: true + types: + - + - name: questions + description: List of questions associated with the answer. + isRequired: true + types: + - + - name: metadata + description: List of metadata associated with the answer to be updated + isRequired: true + types: + - + - name: context + description: Context associated with Qna to be updated. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: answer + isRequired: true + - name: source + isRequired: true + - name: questions + isRequired: true + - name: metadata + isRequired: true + - name: context + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.UpdateQnaDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.UpdateQnaDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.UpdateQnaDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.UpdateQnaDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.UpdateQnaDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.UpdateQnaDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.UpdateQnaDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.yml new file mode 100644 index 00000000..9fc665f6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3 +name: update_qna_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.UpdateQnaDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions.UpdateQnaDTOQuestions.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions.UpdateQnaDTOQuestions.yml new file mode 100644 index 00000000..e0a39220 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions.UpdateQnaDTOQuestions.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions.UpdateQnaDTOQuestions +name: UpdateQnaDTOQuestions +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions.UpdateQnaDTOQuestions +module: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions +summary: List of questions associated with the answer. +constructor: + syntax: UpdateQnaDTOQuestions(**kwargs) + parameters: + - name: add + description: List of questions to be added + isRequired: true + types: + - [] + - name: delete + description: List of questions to be deleted. + isRequired: true + types: + - [] +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions.UpdateQnaDTOQuestions.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions.UpdateQnaDTOQuestions.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions.UpdateQnaDTOQuestions.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions.UpdateQnaDTOQuestions.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions.UpdateQnaDTOQuestions.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions.UpdateQnaDTOQuestions.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions.UpdateQnaDTOQuestions.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions.yml new file mode 100644 index 00000000..367d1d12 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions +name: update_qna_dto_questions +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions.UpdateQnaDTOQuestions diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.UpdateQnaDTOQuestions.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.UpdateQnaDTOQuestions.yml new file mode 100644 index 00000000..f8c40094 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.UpdateQnaDTOQuestions.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.UpdateQnaDTOQuestions +name: UpdateQnaDTOQuestions +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.UpdateQnaDTOQuestions +module: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3 +summary: List of questions associated with the answer. +constructor: + syntax: UpdateQnaDTOQuestions(*, add=None, delete=None, **kwargs) + parameters: + - name: add + description: List of questions to be added + isRequired: true + types: + - [] + - name: delete + description: List of questions to be deleted. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: add + isRequired: true + - name: delete + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.UpdateQnaDTOQuestions.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.UpdateQnaDTOQuestions.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.UpdateQnaDTOQuestions.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.UpdateQnaDTOQuestions.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.UpdateQnaDTOQuestions.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.UpdateQnaDTOQuestions.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.UpdateQnaDTOQuestions.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.yml new file mode 100644 index 00000000..4ed301b7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3 +name: update_qna_dto_questions_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.UpdateQnaDTOQuestions diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto.UpdateQuestionsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto.UpdateQuestionsDTO.yml new file mode 100644 index 00000000..3d806cfa --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto.UpdateQuestionsDTO.yml @@ -0,0 +1,127 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto.UpdateQuestionsDTO +name: UpdateQuestionsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto.UpdateQuestionsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto +summary: 'PATCH Body schema for Update Kb which contains list of questions to be + + added and deleted.' +constructor: + syntax: UpdateQuestionsDTO(**kwargs) + parameters: + - name: add + description: List of questions to be added + isRequired: true + types: + - [] + - name: delete + description: List of questions to be deleted. + isRequired: true + types: + - [] +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto.UpdateQuestionsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto.UpdateQuestionsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto.UpdateQuestionsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto.UpdateQuestionsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto.UpdateQuestionsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto.UpdateQuestionsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto.UpdateQuestionsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto.yml new file mode 100644 index 00000000..188113d8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto +name: update_questions_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto.UpdateQuestionsDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.UpdateQuestionsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.UpdateQuestionsDTO.yml new file mode 100644 index 00000000..66481646 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.UpdateQuestionsDTO.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.UpdateQuestionsDTO +name: UpdateQuestionsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.UpdateQuestionsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3 +summary: 'PATCH Body schema for Update Kb which contains list of questions to be + + added and deleted.' +constructor: + syntax: UpdateQuestionsDTO(*, add=None, delete=None, **kwargs) + parameters: + - name: add + description: List of questions to be added + isRequired: true + types: + - [] + - name: delete + description: List of questions to be deleted. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: add + isRequired: true + - name: delete + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.UpdateQuestionsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.UpdateQuestionsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.UpdateQuestionsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.UpdateQuestionsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.UpdateQuestionsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.UpdateQuestionsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.UpdateQuestionsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.yml new file mode 100644 index 00000000..f6381e47 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3 +name: update_questions_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.UpdateQuestionsDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto.WordAlterationsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto.WordAlterationsDTO.yml new file mode 100644 index 00000000..64082d7c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto.WordAlterationsDTO.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto.WordAlterationsDTO +name: WordAlterationsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto.WordAlterationsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto +summary: 'Collection of word alterations. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: WordAlterationsDTO(**kwargs) + parameters: + - name: word_alterations + description: Required. Collection of word alterations. + isRequired: true + types: + - [] +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto.WordAlterationsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto.WordAlterationsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto.WordAlterationsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto.WordAlterationsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto.WordAlterationsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto.WordAlterationsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto.WordAlterationsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto.yml new file mode 100644 index 00000000..83ae896c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto +name: word_alterations_dto +fullName: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto.WordAlterationsDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3.WordAlterationsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3.WordAlterationsDTO.yml new file mode 100644 index 00000000..1ae07168 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3.WordAlterationsDTO.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3.WordAlterationsDTO +name: WordAlterationsDTO +fullName: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3.WordAlterationsDTO +module: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3 +summary: 'Collection of word alterations. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: WordAlterationsDTO(*, word_alterations, **kwargs) + parameters: + - name: word_alterations + description: Required. Collection of word alterations. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: word_alterations + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3.WordAlterationsDTO.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3.WordAlterationsDTO.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3.WordAlterationsDTO.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3.WordAlterationsDTO.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3.WordAlterationsDTO.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3.WordAlterationsDTO.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3.WordAlterationsDTO.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3.yml new file mode 100644 index 00000000..28c68409 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3 +name: word_alterations_dto_py3 +fullName: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3 +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3.WordAlterationsDTO diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.yml new file mode 100644 index 00000000..ebcfe19f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.yml @@ -0,0 +1,161 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.knowledge.qnamaker.models +name: models +fullName: azure.cognitiveservices.knowledge.qnamaker.models +type: import +classes: +- azure.cognitiveservices.knowledge.qnamaker.models.ActiveLearningSettingsDTO +- azure.cognitiveservices.knowledge.qnamaker.models.AlterationsDTO +- azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanRequestDTO +- azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanResponseDTO +- azure.cognitiveservices.knowledge.qnamaker.models.ContextDTO +- azure.cognitiveservices.knowledge.qnamaker.models.CreateKbDTO +- azure.cognitiveservices.knowledge.qnamaker.models.CreateKbInputDTO +- azure.cognitiveservices.knowledge.qnamaker.models.DeleteKbContentsDTO +- azure.cognitiveservices.knowledge.qnamaker.models.EndpointKeysDTO +- azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTO +- azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTOActiveLearning +- azure.cognitiveservices.knowledge.qnamaker.models.Error +- azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponse +- azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseError +- azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordDTO +- azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordsDTO +- azure.cognitiveservices.knowledge.qnamaker.models.FileDTO +- azure.cognitiveservices.knowledge.qnamaker.models.InnerErrorModel +- azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebaseDTO +- azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebasesDTO +- azure.cognitiveservices.knowledge.qnamaker.models.MetadataDTO +- azure.cognitiveservices.knowledge.qnamaker.models.Operation +- azure.cognitiveservices.knowledge.qnamaker.models.PromptDTO +- azure.cognitiveservices.knowledge.qnamaker.models.PromptDTOQna +- azure.cognitiveservices.knowledge.qnamaker.models.QnADTO +- azure.cognitiveservices.knowledge.qnamaker.models.QnADTOContext +- azure.cognitiveservices.knowledge.qnamaker.models.QnADocumentsDTO +- azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResult +- azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultAnswerSpan +- azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultContext +- azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultList +- azure.cognitiveservices.knowledge.qnamaker.models.QueryContextDTO +- azure.cognitiveservices.knowledge.qnamaker.models.QueryDTO +- azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOAnswerSpanRequest +- azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOContext +- azure.cognitiveservices.knowledge.qnamaker.models.ReplaceKbDTO +- azure.cognitiveservices.knowledge.qnamaker.models.UpdateContextDTO +- azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbContentsDTO +- azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTO +- azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOAdd +- azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTODelete +- azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOUpdate +- azure.cognitiveservices.knowledge.qnamaker.models.UpdateMetadataDTO +- azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTO +- azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOContext +- azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOMetadata +- azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOQuestions +- azure.cognitiveservices.knowledge.qnamaker.models.UpdateQuestionsDTO +- azure.cognitiveservices.knowledge.qnamaker.models.WordAlterationsDTO +modules: +- azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto +- azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto +- azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto +- azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto +- azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.context_dto +- azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto +- azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto +- azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto +- azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto +- azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto +- azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning +- azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.error +- azure.cognitiveservices.knowledge.qnamaker.models.error_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.error_response +- azure.cognitiveservices.knowledge.qnamaker.models.error_response_error +- azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto +- azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto +- azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.file_dto +- azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model +- azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto +- azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto +- azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto +- azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.operation +- azure.cognitiveservices.knowledge.qnamaker.models.operation_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto +- azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna +- azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto +- azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.qn_adto +- azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context +- azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums +- azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result +- azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span +- azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context +- azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list +- azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto +- azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.query_dto +- azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request +- azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context +- azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto +- azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto +- azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto +- azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto +- azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add +- azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete +- azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update +- azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto +- azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto +- azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context +- azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata +- azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions +- azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto +- azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3 +- azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto +- azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3 +enums: +- azure.cognitiveservices.knowledge.qnamaker.models.EnvironmentType +- azure.cognitiveservices.knowledge.qnamaker.models.ErrorCodeType +- azure.cognitiveservices.knowledge.qnamaker.models.OperationStateType +- azure.cognitiveservices.knowledge.qnamaker.models.StrictFiltersCompoundOperationType diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.AlterationsOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.AlterationsOperations.yml new file mode 100644 index 00000000..fc9a922b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.AlterationsOperations.yml @@ -0,0 +1,164 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.operations.AlterationsOperations +name: AlterationsOperations +fullName: azure.cognitiveservices.knowledge.qnamaker.operations.AlterationsOperations +module: azure.cognitiveservices.knowledge.qnamaker.operations +summary: AlterationsOperations operations. +constructor: + syntax: AlterationsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.AlterationsOperations.get + name: get + summary: Download alterations from runtime. + signature: get(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: WordAlterationsDTO or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.AlterationsOperations.get_alterations_for_kb + name: get_alterations_for_kb + summary: Download alterations per Knowledgebase (QnAMaker Managed). + signature: get_alterations_for_kb(kb_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: kb_id + description: Knowledgebase id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: WordAlterationsDTO or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.AlterationsOperations.replace + name: replace + summary: Replace alterations data. + signature: replace(word_alterations, custom_headers=None, raw=False, **operation_config) + parameters: + - name: word_alterations + description: Collection of word alterations. + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.AlterationsOperations.replace_alterations_for_kb + name: replace_alterations_for_kb + summary: Replace alterations data per Knowledgebase (QnAMaker Managed). + signature: replace_alterations_for_kb(kb_id, word_alterations, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: kb_id + description: Knowledgebase id. + isRequired: true + types: + - + - name: word_alterations + description: Collection of word alterations. + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +attributes: +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.AlterationsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.EndpointKeysOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.EndpointKeysOperations.yml new file mode 100644 index 00000000..50fa4ea9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.EndpointKeysOperations.yml @@ -0,0 +1,90 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.operations.EndpointKeysOperations +name: EndpointKeysOperations +fullName: azure.cognitiveservices.knowledge.qnamaker.operations.EndpointKeysOperations +module: azure.cognitiveservices.knowledge.qnamaker.operations +summary: EndpointKeysOperations operations. +constructor: + syntax: EndpointKeysOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.EndpointKeysOperations.get_keys + name: get_keys + summary: Gets endpoint keys for an endpoint. + signature: get_keys(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: EndpointKeysDTO or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.EndpointKeysOperations.refresh_keys + name: refresh_keys + summary: Re-generates an endpoint key. + signature: refresh_keys(key_type, custom_headers=None, raw=False, **operation_config) + parameters: + - name: key_type + description: Type of Key + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: EndpointKeysDTO or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +attributes: +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.EndpointKeysOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.EndpointSettingsOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.EndpointSettingsOperations.yml new file mode 100644 index 00000000..d3f39b20 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.EndpointSettingsOperations.yml @@ -0,0 +1,91 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.operations.EndpointSettingsOperations +name: EndpointSettingsOperations +fullName: azure.cognitiveservices.knowledge.qnamaker.operations.EndpointSettingsOperations +module: azure.cognitiveservices.knowledge.qnamaker.operations +summary: EndpointSettingsOperations operations. +constructor: + syntax: EndpointSettingsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.EndpointSettingsOperations.get_settings + name: get_settings + summary: Gets endpoint settings for an endpoint. + signature: get_settings(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: EndpointSettingsDTO or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.EndpointSettingsOperations.update_settings + name: update_settings + summary: Updates endpoint settings for an endpoint. + signature: update_settings(active_learning=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: active_learning + description: Active Learning settings of the endpoint. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +attributes: +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.EndpointSettingsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.KnowledgebaseOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.KnowledgebaseOperations.yml new file mode 100644 index 00000000..f9f524c0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.KnowledgebaseOperations.yml @@ -0,0 +1,410 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.operations.KnowledgebaseOperations +name: KnowledgebaseOperations +fullName: azure.cognitiveservices.knowledge.qnamaker.operations.KnowledgebaseOperations +module: azure.cognitiveservices.knowledge.qnamaker.operations +summary: KnowledgebaseOperations operations. +constructor: + syntax: KnowledgebaseOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.KnowledgebaseOperations.create + name: create + summary: Asynchronous operation to create a new knowledgebase. + signature: create(create_kb_payload, custom_headers=None, raw=False, **operation_config) + parameters: + - name: create_kb_payload + description: Post body of the request. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Operation or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.KnowledgebaseOperations.delete + name: delete + summary: Deletes the knowledgebase and all its data. + signature: delete(kb_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: kb_id + description: Knowledgebase id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.KnowledgebaseOperations.download + name: download + summary: Download the knowledgebase. + signature: download(kb_id, environment, source=None, changed_since=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: kb_id + description: Knowledgebase id. + isRequired: true + types: + - + - name: environment + description: 'Specifies whether environment is Test or Prod. + + Possible values include: ''Prod'', ''Test''' + isRequired: true + types: + - + - + - name: source + description: The source property filter to apply. + defaultValue: None + types: + - + - name: changed_since + description: 'The last changed status property filter to + + apply.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: QnADocumentsDTO or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.KnowledgebaseOperations.generate_answer + name: generate_answer + summary: GenerateAnswer call to query knowledgebase (QnA Maker Managed). + signature: generate_answer(kb_id, generate_answer_payload, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: kb_id + description: Knowledgebase id. + isRequired: true + types: + - + - name: generate_answer_payload + description: Post body of the request. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: QnASearchResultList or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.KnowledgebaseOperations.get_details + name: get_details + summary: Gets details of a specific knowledgebase. + signature: get_details(kb_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: kb_id + description: Knowledgebase id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KnowledgebaseDTO or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.KnowledgebaseOperations.list_all + name: list_all + summary: Gets all knowledgebases for a user. + signature: list_all(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KnowledgebasesDTO or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.KnowledgebaseOperations.publish + name: publish + summary: 'Publishes all changes in test index of a knowledgebase to its prod + + index.' + signature: publish(kb_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: kb_id + description: Knowledgebase id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.KnowledgebaseOperations.replace + name: replace + summary: Replace knowledgebase contents. + signature: replace(kb_id, qn_alist, custom_headers=None, raw=False, **operation_config) + parameters: + - name: kb_id + description: Knowledgebase id. + isRequired: true + types: + - + - name: qn_alist + description: 'List of Q-A (QnADTO) to be added to the + + knowledgebase. Q-A Ids are assigned by the service and should be + + omitted.' + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.KnowledgebaseOperations.train + name: train + summary: Train call to add suggestions to knowledgebase (QnAMaker Managed). + signature: train(kb_id, feedback_records=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: kb_id + description: Knowledgebase id. + isRequired: true + types: + - + - name: feedback_records + description: List of feedback records. + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.KnowledgebaseOperations.update + name: update + summary: Asynchronous operation to modify a knowledgebase. + signature: update(kb_id, update_kb, custom_headers=None, raw=False, **operation_config) + parameters: + - name: kb_id + description: Knowledgebase id. + isRequired: true + types: + - + - name: update_kb + description: Post body of the request. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Operation or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +attributes: +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.KnowledgebaseOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.Operations(class).yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.Operations(class).yml new file mode 100644 index 00000000..bf9c876a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.Operations(class).yml @@ -0,0 +1,61 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.operations.Operations +name: Operations +fullName: azure.cognitiveservices.knowledge.qnamaker.operations.Operations +module: azure.cognitiveservices.knowledge.qnamaker.operations +summary: Operations operations. +constructor: + syntax: Operations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.Operations.get_details + name: get_details + summary: Gets details of a specific long running operation. + signature: get_details(operation_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: operation_id + description: Operation id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Operation or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +attributes: +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.alterations_operations.AlterationsOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.alterations_operations.AlterationsOperations.yml new file mode 100644 index 00000000..cca65c81 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.alterations_operations.AlterationsOperations.yml @@ -0,0 +1,164 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.operations.alterations_operations.AlterationsOperations +name: AlterationsOperations +fullName: azure.cognitiveservices.knowledge.qnamaker.operations.alterations_operations.AlterationsOperations +module: azure.cognitiveservices.knowledge.qnamaker.operations.alterations_operations +summary: AlterationsOperations operations. +constructor: + syntax: AlterationsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.alterations_operations.AlterationsOperations.get + name: get + summary: Download alterations from runtime. + signature: get(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: WordAlterationsDTO or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.alterations_operations.AlterationsOperations.get_alterations_for_kb + name: get_alterations_for_kb + summary: Download alterations per Knowledgebase (QnAMaker Managed). + signature: get_alterations_for_kb(kb_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: kb_id + description: Knowledgebase id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: WordAlterationsDTO or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.alterations_operations.AlterationsOperations.replace + name: replace + summary: Replace alterations data. + signature: replace(word_alterations, custom_headers=None, raw=False, **operation_config) + parameters: + - name: word_alterations + description: Collection of word alterations. + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.alterations_operations.AlterationsOperations.replace_alterations_for_kb + name: replace_alterations_for_kb + summary: Replace alterations data per Knowledgebase (QnAMaker Managed). + signature: replace_alterations_for_kb(kb_id, word_alterations, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: kb_id + description: Knowledgebase id. + isRequired: true + types: + - + - name: word_alterations + description: Collection of word alterations. + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +attributes: +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.alterations_operations.AlterationsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.alterations_operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.alterations_operations.yml new file mode 100644 index 00000000..5d80d374 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.alterations_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.operations.alterations_operations +name: alterations_operations +fullName: azure.cognitiveservices.knowledge.qnamaker.operations.alterations_operations +classes: +- azure.cognitiveservices.knowledge.qnamaker.operations.alterations_operations.AlterationsOperations diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_keys_operations.EndpointKeysOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_keys_operations.EndpointKeysOperations.yml new file mode 100644 index 00000000..7cac1eb7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_keys_operations.EndpointKeysOperations.yml @@ -0,0 +1,90 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_keys_operations.EndpointKeysOperations +name: EndpointKeysOperations +fullName: azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_keys_operations.EndpointKeysOperations +module: azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_keys_operations +summary: EndpointKeysOperations operations. +constructor: + syntax: EndpointKeysOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_keys_operations.EndpointKeysOperations.get_keys + name: get_keys + summary: Gets endpoint keys for an endpoint. + signature: get_keys(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: EndpointKeysDTO or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_keys_operations.EndpointKeysOperations.refresh_keys + name: refresh_keys + summary: Re-generates an endpoint key. + signature: refresh_keys(key_type, custom_headers=None, raw=False, **operation_config) + parameters: + - name: key_type + description: Type of Key + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: EndpointKeysDTO or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +attributes: +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_keys_operations.EndpointKeysOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_keys_operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_keys_operations.yml new file mode 100644 index 00000000..6db33233 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_keys_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_keys_operations +name: endpoint_keys_operations +fullName: azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_keys_operations +classes: +- azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_keys_operations.EndpointKeysOperations diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_settings_operations.EndpointSettingsOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_settings_operations.EndpointSettingsOperations.yml new file mode 100644 index 00000000..09f36e21 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_settings_operations.EndpointSettingsOperations.yml @@ -0,0 +1,91 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_settings_operations.EndpointSettingsOperations +name: EndpointSettingsOperations +fullName: azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_settings_operations.EndpointSettingsOperations +module: azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_settings_operations +summary: EndpointSettingsOperations operations. +constructor: + syntax: EndpointSettingsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_settings_operations.EndpointSettingsOperations.get_settings + name: get_settings + summary: Gets endpoint settings for an endpoint. + signature: get_settings(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: EndpointSettingsDTO or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_settings_operations.EndpointSettingsOperations.update_settings + name: update_settings + summary: Updates endpoint settings for an endpoint. + signature: update_settings(active_learning=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: active_learning + description: Active Learning settings of the endpoint. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +attributes: +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_settings_operations.EndpointSettingsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_settings_operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_settings_operations.yml new file mode 100644 index 00000000..de42d146 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_settings_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_settings_operations +name: endpoint_settings_operations +fullName: azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_settings_operations +classes: +- azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_settings_operations.EndpointSettingsOperations diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations.KnowledgebaseOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations.KnowledgebaseOperations.yml new file mode 100644 index 00000000..336c7fa6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations.KnowledgebaseOperations.yml @@ -0,0 +1,410 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations.KnowledgebaseOperations +name: KnowledgebaseOperations +fullName: azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations.KnowledgebaseOperations +module: azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations +summary: KnowledgebaseOperations operations. +constructor: + syntax: KnowledgebaseOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations.KnowledgebaseOperations.create + name: create + summary: Asynchronous operation to create a new knowledgebase. + signature: create(create_kb_payload, custom_headers=None, raw=False, **operation_config) + parameters: + - name: create_kb_payload + description: Post body of the request. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Operation or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations.KnowledgebaseOperations.delete + name: delete + summary: Deletes the knowledgebase and all its data. + signature: delete(kb_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: kb_id + description: Knowledgebase id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations.KnowledgebaseOperations.download + name: download + summary: Download the knowledgebase. + signature: download(kb_id, environment, source=None, changed_since=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: kb_id + description: Knowledgebase id. + isRequired: true + types: + - + - name: environment + description: 'Specifies whether environment is Test or Prod. + + Possible values include: ''Prod'', ''Test''' + isRequired: true + types: + - + - + - name: source + description: The source property filter to apply. + defaultValue: None + types: + - + - name: changed_since + description: 'The last changed status property filter to + + apply.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: QnADocumentsDTO or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations.KnowledgebaseOperations.generate_answer + name: generate_answer + summary: GenerateAnswer call to query knowledgebase (QnA Maker Managed). + signature: generate_answer(kb_id, generate_answer_payload, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: kb_id + description: Knowledgebase id. + isRequired: true + types: + - + - name: generate_answer_payload + description: Post body of the request. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: QnASearchResultList or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations.KnowledgebaseOperations.get_details + name: get_details + summary: Gets details of a specific knowledgebase. + signature: get_details(kb_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: kb_id + description: Knowledgebase id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KnowledgebaseDTO or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations.KnowledgebaseOperations.list_all + name: list_all + summary: Gets all knowledgebases for a user. + signature: list_all(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KnowledgebasesDTO or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations.KnowledgebaseOperations.publish + name: publish + summary: 'Publishes all changes in test index of a knowledgebase to its prod + + index.' + signature: publish(kb_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: kb_id + description: Knowledgebase id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations.KnowledgebaseOperations.replace + name: replace + summary: Replace knowledgebase contents. + signature: replace(kb_id, qn_alist, custom_headers=None, raw=False, **operation_config) + parameters: + - name: kb_id + description: Knowledgebase id. + isRequired: true + types: + - + - name: qn_alist + description: 'List of Q-A (QnADTO) to be added to the + + knowledgebase. Q-A Ids are assigned by the service and should be + + omitted.' + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations.KnowledgebaseOperations.train + name: train + summary: Train call to add suggestions to knowledgebase (QnAMaker Managed). + signature: train(kb_id, feedback_records=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: kb_id + description: Knowledgebase id. + isRequired: true + types: + - + - name: feedback_records + description: List of feedback records. + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations.KnowledgebaseOperations.update + name: update + summary: Asynchronous operation to modify a knowledgebase. + signature: update(kb_id, update_kb, custom_headers=None, raw=False, **operation_config) + parameters: + - name: kb_id + description: Knowledgebase id. + isRequired: true + types: + - + - name: update_kb + description: Post body of the request. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Operation or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +attributes: +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations.KnowledgebaseOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations.yml new file mode 100644 index 00000000..61493181 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations +name: knowledgebase_operations +fullName: azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations +classes: +- azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations.KnowledgebaseOperations diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.operations.Operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.operations.Operations.yml new file mode 100644 index 00000000..d1353599 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.operations.Operations.yml @@ -0,0 +1,61 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.operations.operations.Operations +name: Operations +fullName: azure.cognitiveservices.knowledge.qnamaker.operations.operations.Operations +module: azure.cognitiveservices.knowledge.qnamaker.operations.operations +summary: Operations operations. +constructor: + syntax: Operations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.operations.Operations.get_details + name: get_details + summary: Gets details of a specific long running operation. + signature: get_details(operation_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: operation_id + description: Operation id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Operation or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException +attributes: +- uid: azure.cognitiveservices.knowledge.qnamaker.operations.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.operations.yml new file mode 100644 index 00000000..92a923c3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.operations.operations +name: operations +fullName: azure.cognitiveservices.knowledge.qnamaker.operations.operations +classes: +- azure.cognitiveservices.knowledge.qnamaker.operations.operations.Operations diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.yml new file mode 100644 index 00000000..dd8593ee --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.operations.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.knowledge.qnamaker.operations +name: operations +fullName: azure.cognitiveservices.knowledge.qnamaker.operations +type: import +classes: +- azure.cognitiveservices.knowledge.qnamaker.operations.AlterationsOperations +- azure.cognitiveservices.knowledge.qnamaker.operations.EndpointKeysOperations +- azure.cognitiveservices.knowledge.qnamaker.operations.EndpointSettingsOperations +- azure.cognitiveservices.knowledge.qnamaker.operations.KnowledgebaseOperations +- azure.cognitiveservices.knowledge.qnamaker.operations.Operations +modules: +- azure.cognitiveservices.knowledge.qnamaker.operations.alterations_operations +- azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_keys_operations +- azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_settings_operations +- azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations +- azure.cognitiveservices.knowledge.qnamaker.operations.operations diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.QnAMakerClient.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.QnAMakerClient.yml new file mode 100644 index 00000000..714ae483 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.QnAMakerClient.yml @@ -0,0 +1,53 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.QnAMakerClient +name: QnAMakerClient +fullName: azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.QnAMakerClient +module: azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client +summary: An API for QnAMaker Service +constructor: + syntax: QnAMakerClient(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoint (e.g., [https:/](https:/)/< + + qnamaker-resource-name >.api.cognitiveservices.azure.com).' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +- description: EndpointSettings operations + name: endpoint_settings + types: + - +- description: EndpointKeys operations + name: endpoint_keys + types: + - +- description: Alterations operations + name: alterations + types: + - +- description: Knowledgebase operations + name: knowledgebase + types: + - +- description: Operations operations + name: operations + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.QnAMakerClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.QnAMakerClientConfiguration.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.QnAMakerClientConfiguration.yml new file mode 100644 index 00000000..d27bffba --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.QnAMakerClientConfiguration.yml @@ -0,0 +1,62 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.QnAMakerClientConfiguration +name: QnAMakerClientConfiguration +fullName: azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.QnAMakerClientConfiguration +module: azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client +summary: 'Configuration for QnAMakerClient + + Note that all parameters used to create this instance are saved as instance + + attributes.' +constructor: + syntax: QnAMakerClientConfiguration(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoint (e.g., [https:/](https:/)/< + + qnamaker-resource-name >.api.cognitiveservices.azure.com).' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.QnAMakerClientConfiguration.add_user_agent + name: add_user_agent + summary: Add value to current user agent with a space. + signature: 'add_user_agent(value: str) -> None' + parameters: + - name: value + description: value to add to user agent. + isRequired: true + types: + - +- uid: azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.QnAMakerClientConfiguration.load + name: load + signature: load(filepath) + parameters: + - name: filepath + isRequired: true +- uid: azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.QnAMakerClientConfiguration.save + name: save + summary: Save current configuration to file. + signature: save(filepath) + parameters: + - name: filepath + description: Path to file where settings will be saved. + isRequired: true + types: + - + exceptions: + - type: ValueError if supplied filepath cannot be written to. +attributes: +- uid: azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.QnAMakerClientConfiguration.enable_http_logger + name: enable_http_logger +- uid: azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.QnAMakerClientConfiguration.user_agent + name: user_agent + summary: The current user agent value. diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.yml new file mode 100644 index 00000000..c4cef6af --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client +name: qn_amaker_client +fullName: azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client +classes: +- azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.QnAMakerClient +- azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.QnAMakerClientConfiguration diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.version.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.version.yml new file mode 100644 index 00000000..21e70a44 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.knowledge.qnamaker.version +name: version +fullName: azure.cognitiveservices.knowledge.qnamaker.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.yml new file mode 100644 index 00000000..4cb24153 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.knowledge.qnamaker +name: qnamaker +fullName: azure.cognitiveservices.knowledge.qnamaker +type: rootImport +classes: +- azure.cognitiveservices.knowledge.qnamaker.QnAMakerClient +packages: +- azure.cognitiveservices.knowledge.qnamaker.models +- azure.cognitiveservices.knowledge.qnamaker.operations +modules: +- azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client +- azure.cognitiveservices.knowledge.qnamaker.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.LUISAuthoringClient.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.LUISAuthoringClient.yml new file mode 100644 index 00000000..ab03328d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.LUISAuthoringClient.yml @@ -0,0 +1,68 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.LUISAuthoringClient +name: LUISAuthoringClient +fullName: azure.cognitiveservices.language.luis.authoring.LUISAuthoringClient +module: azure.cognitiveservices.language.luis.authoring +constructor: + syntax: LUISAuthoringClient(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and + + hostname, for example: [https://westus.api.cognitive.microsoft.com](https://westus.api.cognitive.microsoft.com)).' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +- description: Features operations + name: features + types: + - +- description: Examples operations + name: examples + types: + - +- description: Model operations + name: model + types: + - +- description: Apps operations + name: apps + types: + - +- description: Versions operations + name: versions + types: + - +- description: Train operations + name: train + types: + - +- description: Pattern operations + name: pattern + types: + - +- description: Settings operations + name: settings + types: + - +- description: AzureAccounts operations + name: azure_accounts + types: + - +methods: +- uid: azure.cognitiveservices.language.luis.authoring.LUISAuthoringClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.LUISAuthoringClientConfiguration.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.LUISAuthoringClientConfiguration.yml new file mode 100644 index 00000000..0c1ca58a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.LUISAuthoringClientConfiguration.yml @@ -0,0 +1,62 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.LUISAuthoringClientConfiguration +name: LUISAuthoringClientConfiguration +fullName: azure.cognitiveservices.language.luis.authoring.LUISAuthoringClientConfiguration +module: azure.cognitiveservices.language.luis.authoring +summary: 'Configuration for LUISAuthoringClient + + Note that all parameters used to create this instance are saved as instance + + attributes.' +constructor: + syntax: LUISAuthoringClientConfiguration(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and + + hostname, for example: [https://westus.api.cognitive.microsoft.com](https://westus.api.cognitive.microsoft.com)).' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.language.luis.authoring.LUISAuthoringClientConfiguration.add_user_agent + name: add_user_agent + summary: Add value to current user agent with a space. + signature: 'add_user_agent(value: str) -> None' + parameters: + - name: value + description: value to add to user agent. + isRequired: true + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.LUISAuthoringClientConfiguration.load + name: load + signature: load(filepath) + parameters: + - name: filepath + isRequired: true +- uid: azure.cognitiveservices.language.luis.authoring.LUISAuthoringClientConfiguration.save + name: save + summary: Save current configuration to file. + signature: save(filepath) + parameters: + - name: filepath + description: Path to file where settings will be saved. + isRequired: true + types: + - + exceptions: + - type: ValueError if supplied filepath cannot be written to. +attributes: +- uid: azure.cognitiveservices.language.luis.authoring.LUISAuthoringClientConfiguration.enable_http_logger + name: enable_http_logger +- uid: azure.cognitiveservices.language.luis.authoring.LUISAuthoringClientConfiguration.user_agent + name: user_agent + summary: The current user agent value. diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject.yml new file mode 100644 index 00000000..f5027cf3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject +name: AppVersionSettingObject +fullName: azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Object model of an application version setting. +constructor: + syntax: 'AppVersionSettingObject(*, name: str = None, value: str = None, **kwargs)' + parameters: + - name: name + description: The application version setting name. + isRequired: true + types: + - + - name: value + description: The application version setting value. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject.yml new file mode 100644 index 00000000..d7e01cf7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject +name: ApplicationCreateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'Properties for creating a new LUIS Application. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ApplicationCreateObject(*, culture: str, name: str, domain: str = None, + description: str = None, initial_version_id: str = None, usage_scenario: str = + None, **kwargs)' + parameters: + - name: culture + description: 'Required. The culture for the new application. It is the + + language that your app understands and speaks. E.g.: "en-us". Note: the + + culture cannot be changed after the app is created.' + isRequired: true + types: + - + - name: domain + description: 'The domain for the new application. Optional. E.g.: Comics.' + isRequired: true + types: + - + - name: description + description: Description of the new application. Optional. + isRequired: true + types: + - + - name: initial_version_id + description: 'The initial version ID. Optional. Default value + + is: "0.1"' + isRequired: true + types: + - + - name: usage_scenario + description: 'Defines the scenario for the new application. + + Optional. E.g.: IoT.' + isRequired: true + types: + - + - name: name + description: Required. The name for the new application. + isRequired: true + types: + - + keywordOnlyParameters: + - name: culture + isRequired: true + - name: name + isRequired: true + - name: domain + isRequired: true + - name: description + isRequired: true + - name: initial_version_id + isRequired: true + - name: usage_scenario + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse.yml new file mode 100644 index 00000000..8f8a12c2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse.yml @@ -0,0 +1,200 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse +name: ApplicationInfoResponse +fullName: azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse +module: azure.cognitiveservices.language.luis.authoring.models +summary: Response containing the Application Info. +constructor: + syntax: 'ApplicationInfoResponse(*, id: str = None, name: str = None, description: + str = None, culture: str = None, usage_scenario: str = None, domain: str = None, + versions_count: int = None, created_date_time: str = None, endpoints=None, endpoint_hits_count: + int = None, active_version: str = None, **kwargs)' + parameters: + - name: id + description: The ID (GUID) of the application. + isRequired: true + types: + - + - name: name + description: The name of the application. + isRequired: true + types: + - + - name: description + description: The description of the application. + isRequired: true + types: + - + - name: culture + description: The culture of the application. For example, "en-us". + isRequired: true + types: + - + - name: usage_scenario + description: 'Defines the scenario for the new application. + + Optional. For example, IoT.' + isRequired: true + types: + - + - name: domain + description: 'The domain for the new application. Optional. For example, + + Comics.' + isRequired: true + types: + - + - name: versions_count + description: Amount of model versions within the application. + isRequired: true + types: + - + - name: created_date_time + description: The version's creation timestamp. + isRequired: true + types: + - + - name: endpoints + description: The Runtime endpoint URL for this model version. + isRequired: true + types: + - + - name: endpoint_hits_count + description: Number of calls made to this endpoint. + isRequired: true + types: + - + - name: active_version + description: The version ID currently marked as active. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: name + isRequired: true + - name: description + isRequired: true + - name: culture + isRequired: true + - name: usage_scenario + isRequired: true + - name: domain + isRequired: true + - name: versions_count + isRequired: true + - name: created_date_time + isRequired: true + - name: endpoints + isRequired: true + - name: endpoint_hits_count + isRequired: true + - name: active_version + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject.yml new file mode 100644 index 00000000..0bb1a4c9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject +name: ApplicationPublishObject +fullName: azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Object model for publishing a specific application version. +constructor: + syntax: 'ApplicationPublishObject(*, version_id: str = None, is_staging: bool = + False, **kwargs)' + parameters: + - name: version_id + description: The version ID to publish. + isRequired: true + types: + - + - name: is_staging + description: 'Indicates if the staging slot should be used, instead + + of the Production one. Default value: False .' + isRequired: true + types: + - + keywordOnlyParameters: + - name: version_id + isRequired: true + - name: is_staging + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject.yml new file mode 100644 index 00000000..e74b08a6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject +name: ApplicationSettingUpdateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Object model for updating an application's settings. +constructor: + syntax: 'ApplicationSettingUpdateObject(*, is_public: bool = None, **kwargs)' + parameters: + - name: is_public + description: 'Setting your application as public allows other people + + to use your application''s endpoint using their own keys.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: is_public + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationSettings.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationSettings.yml new file mode 100644 index 00000000..9197c360 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationSettings.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettings +name: ApplicationSettings +fullName: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettings +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'The application settings. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ApplicationSettings(*, id: str, is_public: bool, **kwargs)' + parameters: + - name: id + description: Required. The application ID. + isRequired: true + types: + - + - name: is_public + description: 'Required. Setting your application as public allows + + other people to use your application''s endpoint using their own keys for + + billing purposes.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: is_public + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettings.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettings.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettings.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettings.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettings.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettings.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettings.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject.yml new file mode 100644 index 00000000..b95b8ac2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject +name: ApplicationUpdateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Object model for updating the name or description of an application. +constructor: + syntax: 'ApplicationUpdateObject(*, name: str = None, description: str = None, **kwargs)' + parameters: + - name: name + description: The application's new name. + isRequired: true + types: + - + - name: description + description: The application's new description. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: description + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AvailableCulture.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AvailableCulture.yml new file mode 100644 index 00000000..61bb9d23 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AvailableCulture.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.AvailableCulture +name: AvailableCulture +fullName: azure.cognitiveservices.language.luis.authoring.models.AvailableCulture +module: azure.cognitiveservices.language.luis.authoring.models +summary: Available culture for using in a new application. +constructor: + syntax: 'AvailableCulture(*, name: str = None, code: str = None, **kwargs)' + parameters: + - name: name + description: The language name. + isRequired: true + types: + - + - name: code + description: The ISO value for the language. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: code + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.AvailableCulture.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.AvailableCulture.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.AvailableCulture.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.AvailableCulture.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.AvailableCulture.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.AvailableCulture.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.AvailableCulture.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel.yml new file mode 100644 index 00000000..76b7efb6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel +name: AvailablePrebuiltEntityModel +fullName: azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel +module: azure.cognitiveservices.language.luis.authoring.models +summary: Available Prebuilt entity model for using in an application. +constructor: + syntax: 'AvailablePrebuiltEntityModel(*, name: str = None, description: str = None, + examples: str = None, **kwargs)' + parameters: + - name: name + description: The entity name. + isRequired: true + types: + - + - name: description + description: The entity description and usage information. + isRequired: true + types: + - + - name: examples + description: Usage examples. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: description + isRequired: true + - name: examples + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AzureAccountInfoObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AzureAccountInfoObject.yml new file mode 100644 index 00000000..78b64276 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AzureAccountInfoObject.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.AzureAccountInfoObject +name: AzureAccountInfoObject +fullName: azure.cognitiveservices.language.luis.authoring.models.AzureAccountInfoObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'Defines the Azure account information object. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureAccountInfoObject(*, azure_subscription_id: str, resource_group: str, + account_name: str, **kwargs)' + parameters: + - name: azure_subscription_id + description: Required. The id for the Azure subscription. + isRequired: true + types: + - + - name: resource_group + description: Required. The Azure resource group name. + isRequired: true + types: + - + - name: account_name + description: Required. The Azure account name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: azure_subscription_id + isRequired: true + - name: resource_group + isRequired: true + - name: account_name + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.AzureAccountInfoObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.AzureAccountInfoObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.AzureAccountInfoObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.AzureAccountInfoObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.AzureAccountInfoObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.AzureAccountInfoObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.AzureAccountInfoObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample.yml new file mode 100644 index 00000000..c185d2e6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample +name: BatchLabelExample +fullName: azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample +module: azure.cognitiveservices.language.luis.authoring.models +summary: Response when adding a batch of labeled example utterances. +constructor: + syntax: 'BatchLabelExample(*, value=None, has_error: bool = None, error=None, **kwargs)' + parameters: + - name: value + isRequired: true + types: + - + - name: has_error + isRequired: true + types: + - + - name: error + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: has_error + isRequired: true + - name: error + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ChildEntity.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ChildEntity.yml new file mode 100644 index 00000000..3396fc45 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ChildEntity.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntity +name: ChildEntity +fullName: azure.cognitiveservices.language.luis.authoring.models.ChildEntity +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'The base child entity type. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ChildEntity(*, id: str, name: str = None, instance_of: str = None, type_id: + int = None, readable_type=None, children=None, **kwargs)' + parameters: + - name: id + description: Required. The ID (GUID) belonging to a child entity. + isRequired: true + types: + - + - name: name + description: The name of a child entity. + isRequired: true + types: + - + - name: instance_of + description: Instance of Model. + isRequired: true + types: + - + - name: type_id + description: The type ID of the Entity Model. + isRequired: true + types: + - + - name: readable_type + description: 'Possible values include: ''Entity Extractor'', ''Child + + Entity Extractor'', ''Hierarchical Entity Extractor'', ''Hierarchical Child + + Entity Extractor'', ''Composite Entity Extractor'', ''List Entity Extractor'', + + ''Prebuilt Entity Extractor'', ''Intent Classifier'', ''Pattern.Any Entity + + Extractor'', ''Closed List Entity Extractor'', ''Regex Entity Extractor''' + isRequired: true + types: + - + - + - name: children + description: List of children + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: name + isRequired: true + - name: instance_of + isRequired: true + - name: type_id + isRequired: true + - name: readable_type + isRequired: true + - name: children + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject.yml new file mode 100644 index 00000000..7d642e15 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject +name: ChildEntityModelCreateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: A child entity extractor create object. +constructor: + syntax: 'ChildEntityModelCreateObject(*, children=None, name: str = None, instance_of: + str = None, **kwargs)' + parameters: + - name: children + description: Child entities. + isRequired: true + types: + - [] + - name: name + description: Entity name. + isRequired: true + types: + - + - name: instance_of + description: The instance of model name + isRequired: true + types: + - + keywordOnlyParameters: + - name: children + isRequired: true + - name: name + isRequired: true + - name: instance_of + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedList.yml new file mode 100644 index 00000000..c3e69c54 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedList.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ClosedList +name: ClosedList +fullName: azure.cognitiveservices.language.luis.authoring.models.ClosedList +module: azure.cognitiveservices.language.luis.authoring.models +summary: Exported Model - A list entity. +constructor: + syntax: 'ClosedList(*, name: str = None, sub_lists=None, roles=None, **kwargs)' + parameters: + - name: name + description: Name of the list entity. + isRequired: true + types: + - + - name: sub_lists + description: Sublists for the list entity. + isRequired: true + types: + - [] + - name: roles + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: name + isRequired: true + - name: sub_lists + isRequired: true + - name: roles + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedList.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedList.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedList.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedList.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedList.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedList.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedList.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor.yml new file mode 100644 index 00000000..d76c6db7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor.yml @@ -0,0 +1,172 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor +name: ClosedListEntityExtractor +fullName: azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'List Entity Extractor. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ClosedListEntityExtractor(*, id: str, readable_type, name: str = None, + type_id: int = None, roles=None, sub_lists=None, **kwargs)' + parameters: + - name: id + description: Required. The ID of the Entity Model. + isRequired: true + types: + - + - name: name + description: Name of the Entity Model. + isRequired: true + types: + - + - name: type_id + description: The type ID of the Entity Model. + isRequired: true + types: + - + - name: readable_type + description: 'Required. Possible values include: ''Entity + + Extractor'', ''Child Entity Extractor'', ''Hierarchical Entity Extractor'', + + ''Hierarchical Child Entity Extractor'', ''Composite Entity Extractor'', ''List + + Entity Extractor'', ''Prebuilt Entity Extractor'', ''Intent Classifier'', + + ''Pattern.Any Entity Extractor'', ''Closed List Entity Extractor'', ''Regex + + Entity Extractor''' + isRequired: true + types: + - + - + - name: roles + isRequired: true + types: + - [] + - name: sub_lists + description: List of sublists. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: readable_type + isRequired: true + - name: name + isRequired: true + - name: type_id + isRequired: true + - name: roles + isRequired: true + - name: sub_lists + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject.yml new file mode 100644 index 00000000..a09b73cb --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject +name: ClosedListModelCreateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Object model for creating a list entity. +constructor: + syntax: 'ClosedListModelCreateObject(*, sub_lists=None, name: str = None, **kwargs)' + parameters: + - name: sub_lists + description: Sublists for the feature. + isRequired: true + types: + - [] + - name: name + description: Name of the list entity. + isRequired: true + types: + - + keywordOnlyParameters: + - name: sub_lists + isRequired: true + - name: name + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject.yml new file mode 100644 index 00000000..72a507fd --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject +name: ClosedListModelPatchObject +fullName: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Object model for adding a batch of sublists to an existing list entity. +constructor: + syntax: ClosedListModelPatchObject(*, sub_lists=None, **kwargs) + parameters: + - name: sub_lists + description: Sublists to add. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: sub_lists + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject.yml new file mode 100644 index 00000000..c3d14a25 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject +name: ClosedListModelUpdateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Object model for updating a list entity. +constructor: + syntax: 'ClosedListModelUpdateObject(*, sub_lists=None, name: str = None, **kwargs)' + parameters: + - name: sub_lists + description: The new sublists for the feature. + isRequired: true + types: + - [] + - name: name + description: The new name of the list entity. + isRequired: true + types: + - + keywordOnlyParameters: + - name: sub_lists + isRequired: true + - name: name + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray.yml new file mode 100644 index 00000000..bb6112e7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray +name: CollaboratorsArray +fullName: azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray +module: azure.cognitiveservices.language.luis.authoring.models +summary: CollaboratorsArray. +constructor: + syntax: CollaboratorsArray(*, emails=None, **kwargs) + parameters: + - name: emails + description: The email address of the users. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: emails + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject.yml new file mode 100644 index 00000000..1940695e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject.yml @@ -0,0 +1,122 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject +name: CompositeChildModelCreateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: CompositeChildModelCreateObject. +constructor: + syntax: 'CompositeChildModelCreateObject(*, name: str = None, **kwargs)' + parameters: + - name: name + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor.yml new file mode 100644 index 00000000..a66394ee --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor.yml @@ -0,0 +1,172 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor +name: CompositeEntityExtractor +fullName: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'A Composite Entity Extractor. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CompositeEntityExtractor(*, id: str, readable_type, name: str = None, type_id: + int = None, roles=None, children=None, **kwargs)' + parameters: + - name: id + description: Required. The ID of the Entity Model. + isRequired: true + types: + - + - name: name + description: Name of the Entity Model. + isRequired: true + types: + - + - name: type_id + description: The type ID of the Entity Model. + isRequired: true + types: + - + - name: readable_type + description: 'Required. Possible values include: ''Entity + + Extractor'', ''Child Entity Extractor'', ''Hierarchical Entity Extractor'', + + ''Hierarchical Child Entity Extractor'', ''Composite Entity Extractor'', ''List + + Entity Extractor'', ''Prebuilt Entity Extractor'', ''Intent Classifier'', + + ''Pattern.Any Entity Extractor'', ''Closed List Entity Extractor'', ''Regex + + Entity Extractor''' + isRequired: true + types: + - + - + - name: roles + isRequired: true + types: + - [] + - name: children + description: List of child entities. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: readable_type + isRequired: true + - name: name + isRequired: true + - name: type_id + isRequired: true + - name: roles + isRequired: true + - name: children + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel.yml new file mode 100644 index 00000000..435775c0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel +name: CompositeEntityModel +fullName: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel +module: azure.cognitiveservices.language.luis.authoring.models +summary: A composite entity extractor. +constructor: + syntax: 'CompositeEntityModel(*, children=None, name: str = None, **kwargs)' + parameters: + - name: children + description: Child entities. + isRequired: true + types: + - [] + - name: name + description: Entity name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: children + isRequired: true + - name: name + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel.yml new file mode 100644 index 00000000..93ff36dd --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel.yml @@ -0,0 +1,180 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel +name: CustomPrebuiltModel +fullName: azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'A Custom Prebuilt model. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CustomPrebuiltModel(*, id: str, readable_type, name: str = None, type_id: + int = None, custom_prebuilt_domain_name: str = None, custom_prebuilt_model_name: + str = None, roles=None, **kwargs)' + parameters: + - name: id + description: Required. The ID of the Entity Model. + isRequired: true + types: + - + - name: name + description: Name of the Entity Model. + isRequired: true + types: + - + - name: type_id + description: The type ID of the Entity Model. + isRequired: true + types: + - + - name: readable_type + description: 'Required. Possible values include: ''Entity + + Extractor'', ''Child Entity Extractor'', ''Hierarchical Entity Extractor'', + + ''Hierarchical Child Entity Extractor'', ''Composite Entity Extractor'', ''List + + Entity Extractor'', ''Prebuilt Entity Extractor'', ''Intent Classifier'', + + ''Pattern.Any Entity Extractor'', ''Closed List Entity Extractor'', ''Regex + + Entity Extractor''' + isRequired: true + types: + - + - + - name: custom_prebuilt_domain_name + description: The domain name. + isRequired: true + types: + - + - name: custom_prebuilt_model_name + description: The intent name or entity name. + isRequired: true + types: + - + - name: roles + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: readable_type + isRequired: true + - name: name + isRequired: true + - name: type_id + isRequired: true + - name: custom_prebuilt_domain_name + isRequired: true + - name: custom_prebuilt_model_name + isRequired: true + - name: roles + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EndpointInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EndpointInfo.yml new file mode 100644 index 00000000..cde60b92 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EndpointInfo.yml @@ -0,0 +1,176 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.EndpointInfo +name: EndpointInfo +fullName: azure.cognitiveservices.language.luis.authoring.models.EndpointInfo +module: azure.cognitiveservices.language.luis.authoring.models +summary: The base class "ProductionOrStagingEndpointInfo" inherits from. +constructor: + syntax: 'EndpointInfo(*, version_id: str = None, is_staging: bool = None, endpoint_url: + str = None, region: str = None, assigned_endpoint_key: str = None, endpoint_region: + str = None, failed_regions: str = None, published_date_time: str = None, **kwargs)' + parameters: + - name: version_id + description: The version ID to publish. + isRequired: true + types: + - + - name: is_staging + description: 'Indicates if the staging slot should be used, instead + + of the Production one.' + isRequired: true + types: + - + - name: endpoint_url + description: The Runtime endpoint URL for this model version. + isRequired: true + types: + - + - name: region + description: The target region that the application is published to. + isRequired: true + types: + - + - name: assigned_endpoint_key + description: The endpoint key. + isRequired: true + types: + - + - name: endpoint_region + description: The endpoint's region. + isRequired: true + types: + - + - name: failed_regions + description: Regions where publishing failed. + isRequired: true + types: + - + - name: published_date_time + description: Timestamp when was last published. + isRequired: true + types: + - + keywordOnlyParameters: + - name: version_id + isRequired: true + - name: is_staging + isRequired: true + - name: endpoint_url + isRequired: true + - name: region + isRequired: true + - name: assigned_endpoint_key + isRequired: true + - name: endpoint_region + isRequired: true + - name: failed_regions + isRequired: true + - name: published_date_time + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.EndpointInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EndpointInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EndpointInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.EndpointInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EndpointInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.EndpointInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EndpointInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse.yml new file mode 100644 index 00000000..3aa90286 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse +name: EnqueueTrainingResponse +fullName: azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse +module: azure.cognitiveservices.language.luis.authoring.models +summary: Response model when requesting to train the model. +constructor: + syntax: 'EnqueueTrainingResponse(*, status_id: int = None, status=None, **kwargs)' + parameters: + - name: status_id + description: The train request status ID. + isRequired: true + types: + - + - name: status + description: 'Possible values include: ''Queued'', ''InProgress'', + + ''UpToDate'', ''Fail'', ''Success''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: status_id + isRequired: true + - name: status + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample.yml new file mode 100644 index 00000000..715ea0a1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample +name: EntitiesSuggestionExample +fullName: azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample +module: azure.cognitiveservices.language.luis.authoring.models +summary: Predicted/suggested entity. +constructor: + syntax: 'EntitiesSuggestionExample(*, text: str = None, tokenized_text=None, intent_predictions=None, + entity_predictions=None, **kwargs)' + parameters: + - name: text + description: 'The utterance. For example, "What''s the weather like in + + seattle?"' + isRequired: true + types: + - + - name: tokenized_text + description: The utterance tokenized. + isRequired: true + types: + - [] + - name: intent_predictions + description: Predicted/suggested intents. + isRequired: true + types: + - [] + - name: entity_predictions + description: Predicted/suggested entities. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: text + isRequired: true + - name: tokenized_text + isRequired: true + - name: intent_predictions + isRequired: true + - name: entity_predictions + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityExtractor.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityExtractor.yml new file mode 100644 index 00000000..5ac12f82 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityExtractor.yml @@ -0,0 +1,180 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.EntityExtractor +name: EntityExtractor +fullName: azure.cognitiveservices.language.luis.authoring.models.EntityExtractor +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'Entity Extractor. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EntityExtractor(*, id: str, readable_type, name: str = None, type_id: int + = None, roles=None, custom_prebuilt_domain_name: str = None, custom_prebuilt_model_name: + str = None, **kwargs)' + parameters: + - name: id + description: Required. The ID of the Entity Model. + isRequired: true + types: + - + - name: name + description: Name of the Entity Model. + isRequired: true + types: + - + - name: type_id + description: The type ID of the Entity Model. + isRequired: true + types: + - + - name: readable_type + description: 'Required. Possible values include: ''Entity + + Extractor'', ''Child Entity Extractor'', ''Hierarchical Entity Extractor'', + + ''Hierarchical Child Entity Extractor'', ''Composite Entity Extractor'', ''List + + Entity Extractor'', ''Prebuilt Entity Extractor'', ''Intent Classifier'', + + ''Pattern.Any Entity Extractor'', ''Closed List Entity Extractor'', ''Regex + + Entity Extractor''' + isRequired: true + types: + - + - + - name: roles + isRequired: true + types: + - [] + - name: custom_prebuilt_domain_name + description: The domain name. + isRequired: true + types: + - + - name: custom_prebuilt_model_name + description: The intent name or entity name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: readable_type + isRequired: true + - name: name + isRequired: true + - name: type_id + isRequired: true + - name: roles + isRequired: true + - name: custom_prebuilt_domain_name + isRequired: true + - name: custom_prebuilt_model_name + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityExtractor.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityExtractor.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityExtractor.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityExtractor.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityExtractor.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityExtractor.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityExtractor.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityLabel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityLabel.yml new file mode 100644 index 00000000..6dd177d0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityLabel.yml @@ -0,0 +1,167 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabel +name: EntityLabel +fullName: azure.cognitiveservices.language.luis.authoring.models.EntityLabel +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'Defines the entity type and position of the extracted entity within the + + example. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EntityLabel(*, entity_name: str, start_token_index: int, end_token_index: + int, role: str = None, role_id: str = None, children=None, **kwargs)' + parameters: + - name: entity_name + description: Required. The entity type. + isRequired: true + types: + - + - name: start_token_index + description: 'Required. The index within the utterance where + + the extracted entity starts.' + isRequired: true + types: + - + - name: end_token_index + description: 'Required. The index within the utterance where the + + extracted entity ends.' + isRequired: true + types: + - + - name: role + description: The role of the predicted entity. + isRequired: true + types: + - + - name: role_id + description: The role id for the predicted entity. + isRequired: true + types: + - + - name: children + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: entity_name + isRequired: true + - name: start_token_index + isRequired: true + - name: end_token_index + isRequired: true + - name: role + isRequired: true + - name: role_id + isRequired: true + - name: children + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabel.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabel.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabel.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabel.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabel.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabel.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabel.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject.yml new file mode 100644 index 00000000..0ff3b77e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject.yml @@ -0,0 +1,161 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject +name: EntityLabelObject +fullName: azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'Defines the entity type and position of the extracted entity within the + + example. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EntityLabelObject(*, entity_name: str, start_char_index: int, end_char_index: + int, role: str = None, children=None, **kwargs)' + parameters: + - name: entity_name + description: Required. The entity type. + isRequired: true + types: + - + - name: start_char_index + description: 'Required. The index within the utterance where + + the extracted entity starts.' + isRequired: true + types: + - + - name: end_char_index + description: 'Required. The index within the utterance where the + + extracted entity ends.' + isRequired: true + types: + - + - name: role + description: The role the entity plays in the utterance. + isRequired: true + types: + - + - name: children + description: The identified entities within the example utterance. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: entity_name + isRequired: true + - name: start_char_index + isRequired: true + - name: end_char_index + isRequired: true + - name: role + isRequired: true + - name: children + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject.yml new file mode 100644 index 00000000..537b7855 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject +name: EntityModelCreateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: An entity extractor create object. +constructor: + syntax: 'EntityModelCreateObject(*, children=None, name: str = None, **kwargs)' + parameters: + - name: children + description: Child entities. + isRequired: true + types: + - [] + - name: name + description: Entity name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: children + isRequired: true + - name: name + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo.yml new file mode 100644 index 00000000..01a87c41 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo.yml @@ -0,0 +1,165 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo +name: EntityModelInfo +fullName: azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'An Entity Extractor model info. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EntityModelInfo(*, id: str, readable_type, name: str = None, type_id: int + = None, roles=None, **kwargs)' + parameters: + - name: id + description: Required. The ID of the Entity Model. + isRequired: true + types: + - + - name: name + description: Name of the Entity Model. + isRequired: true + types: + - + - name: type_id + description: The type ID of the Entity Model. + isRequired: true + types: + - + - name: readable_type + description: 'Required. Possible values include: ''Entity + + Extractor'', ''Child Entity Extractor'', ''Hierarchical Entity Extractor'', + + ''Hierarchical Child Entity Extractor'', ''Composite Entity Extractor'', ''List + + Entity Extractor'', ''Prebuilt Entity Extractor'', ''Intent Classifier'', + + ''Pattern.Any Entity Extractor'', ''Closed List Entity Extractor'', ''Regex + + Entity Extractor''' + isRequired: true + types: + - + - + - name: roles + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: readable_type + isRequired: true + - name: name + isRequired: true + - name: type_id + isRequired: true + - name: roles + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject.yml new file mode 100644 index 00000000..a40f4039 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject +name: EntityModelUpdateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: An entity extractor update object. +constructor: + syntax: 'EntityModelUpdateObject(*, name: str = None, instance_of: str = None, **kwargs)' + parameters: + - name: name + description: Entity name. + isRequired: true + types: + - + - name: instance_of + description: The instance of model name + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: instance_of + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityPrediction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityPrediction.yml new file mode 100644 index 00000000..307eeb26 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityPrediction.yml @@ -0,0 +1,158 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.EntityPrediction +name: EntityPrediction +fullName: azure.cognitiveservices.language.luis.authoring.models.EntityPrediction +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'A suggested entity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EntityPrediction(*, entity_name: str, start_token_index: int, end_token_index: + int, phrase: str, children=None, **kwargs)' + parameters: + - name: entity_name + description: Required. The entity's name + isRequired: true + types: + - + - name: start_token_index + description: 'Required. The index within the utterance where + + the extracted entity starts.' + isRequired: true + types: + - + - name: end_token_index + description: 'Required. The index within the utterance where the + + extracted entity ends.' + isRequired: true + types: + - + - name: phrase + description: Required. The actual token(s) that comprise the entity. + isRequired: true + types: + - + - name: children + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: entity_name + isRequired: true + - name: start_token_index + isRequired: true + - name: end_token_index + isRequired: true + - name: phrase + isRequired: true + - name: children + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityPrediction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityPrediction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityPrediction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityPrediction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityPrediction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityPrediction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityPrediction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRole.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRole.yml new file mode 100644 index 00000000..6f55d72e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRole.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.EntityRole +name: EntityRole +fullName: azure.cognitiveservices.language.luis.authoring.models.EntityRole +module: azure.cognitiveservices.language.luis.authoring.models +summary: Entity extractor role. +constructor: + syntax: 'EntityRole(*, id: str = None, name: str = None, **kwargs)' + parameters: + - name: id + description: The entity role ID. + isRequired: true + types: + - + - name: name + description: The entity role name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: name + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRole.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRole.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRole.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRole.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRole.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRole.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRole.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject.yml new file mode 100644 index 00000000..8caab43c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject +name: EntityRoleCreateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Object model for creating an entity role. +constructor: + syntax: 'EntityRoleCreateObject(*, name: str = None, **kwargs)' + parameters: + - name: name + description: The entity role name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject.yml new file mode 100644 index 00000000..f2669de6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject +name: EntityRoleUpdateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Object model for updating an entity role. +constructor: + syntax: 'EntityRoleUpdateObject(*, name: str = None, **kwargs)' + parameters: + - name: name + description: The entity role name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ErrorResponse.yml new file mode 100644 index 00000000..a8e6dc30 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ErrorResponse.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ErrorResponse +name: ErrorResponse +fullName: azure.cognitiveservices.language.luis.authoring.models.ErrorResponse +module: azure.cognitiveservices.language.luis.authoring.models +summary: Error response when invoking an operation on the API. +constructor: + syntax: 'ErrorResponse(*, additional_properties=None, error_type: str = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: error_type + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: error_type + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ErrorResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ErrorResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ErrorResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ErrorResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ErrorResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ErrorResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ErrorResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException.yml new file mode 100644 index 00000000..6dc6537d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +name: ErrorResponseException +fullName: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'Server responded with exception of type: ''ErrorResponse''.' +constructor: + syntax: ErrorResponseException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException.args + name: args diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject.yml new file mode 100644 index 00000000..0d5c3691 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject +name: ExampleLabelObject +fullName: azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: A labeled example utterance. +constructor: + syntax: 'ExampleLabelObject(*, text: str = None, entity_labels=None, intent_name: + str = None, **kwargs)' + parameters: + - name: text + description: The example utterance. + isRequired: true + types: + - + - name: entity_labels + description: 'The identified entities within the example + + utterance.' + isRequired: true + types: + - [] + - name: intent_name + description: 'The identified intent representing the example + + utterance.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: text + isRequired: true + - name: entity_labels + isRequired: true + - name: intent_name + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem.yml new file mode 100644 index 00000000..5fc18d4a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem +name: ExplicitListItem +fullName: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem +module: azure.cognitiveservices.language.luis.authoring.models +summary: Explicit (exception) list item. +constructor: + syntax: 'ExplicitListItem(*, id: int = None, explicit_list_item: str = None, **kwargs)' + parameters: + - name: id + description: The explicit list item ID. + isRequired: true + types: + - + - name: explicit_list_item + description: The explicit list item value. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: explicit_list_item + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject.yml new file mode 100644 index 00000000..eaa1890b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject +name: ExplicitListItemCreateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Object model for creating an explicit (exception) list item. +constructor: + syntax: 'ExplicitListItemCreateObject(*, explicit_list_item: str = None, **kwargs)' + parameters: + - name: explicit_list_item + description: The explicit list item. + isRequired: true + types: + - + keywordOnlyParameters: + - name: explicit_list_item + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject.yml new file mode 100644 index 00000000..a3823a3f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject +name: ExplicitListItemUpdateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Model object for updating an explicit (exception) list item. +constructor: + syntax: 'ExplicitListItemUpdateObject(*, explicit_list_item: str = None, **kwargs)' + parameters: + - name: explicit_list_item + description: The explicit list item. + isRequired: true + types: + - + keywordOnlyParameters: + - name: explicit_list_item + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject.yml new file mode 100644 index 00000000..b5e7492b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject +name: FeatureInfoObject +fullName: azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: The base class Features-related response objects inherit from. +constructor: + syntax: 'FeatureInfoObject(*, id: int = None, name: str = None, is_active: bool + = None, enabled_for_all_models: bool = None, **kwargs)' + parameters: + - name: id + description: A six-digit ID used for Features. + isRequired: true + types: + - + - name: name + description: The name of the Feature. + isRequired: true + types: + - + - name: is_active + description: Indicates if the feature is enabled. + isRequired: true + types: + - + - name: enabled_for_all_models + description: 'Indicates if the feature is enabled for all + + models in the application.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: name + isRequired: true + - name: is_active + isRequired: true + - name: enabled_for_all_models + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject.yml new file mode 100644 index 00000000..6ca01155 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject +name: FeaturesResponseObject +fullName: azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Model Features, including Patterns and Phraselists. +constructor: + syntax: FeaturesResponseObject(*, phraselist_features=None, pattern_features=None, + **kwargs) + parameters: + - name: phraselist_features + isRequired: true + types: + - [] + - name: pattern_features + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: phraselist_features + isRequired: true + - name: pattern_features + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity.yml new file mode 100644 index 00000000..23b9fdcf --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity +name: HierarchicalChildEntity +fullName: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'A Hierarchical Child Entity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'HierarchicalChildEntity(*, id: str, name: str = None, instance_of: str + = None, type_id: int = None, readable_type=None, children=None, **kwargs)' + parameters: + - name: id + description: Required. The ID (GUID) belonging to a child entity. + isRequired: true + types: + - + - name: name + description: The name of a child entity. + isRequired: true + types: + - + - name: instance_of + description: Instance of Model. + isRequired: true + types: + - + - name: type_id + description: The type ID of the Entity Model. + isRequired: true + types: + - + - name: readable_type + description: 'Possible values include: ''Entity Extractor'', ''Child + + Entity Extractor'', ''Hierarchical Entity Extractor'', ''Hierarchical Child + + Entity Extractor'', ''Composite Entity Extractor'', ''List Entity Extractor'', + + ''Prebuilt Entity Extractor'', ''Intent Classifier'', ''Pattern.Any Entity + + Extractor'', ''Closed List Entity Extractor'', ''Regex Entity Extractor''' + isRequired: true + types: + - + - + - name: children + description: List of children + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: name + isRequired: true + - name: instance_of + isRequired: true + - name: type_id + isRequired: true + - name: readable_type + isRequired: true + - name: children + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject.yml new file mode 100644 index 00000000..2044c18c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject.yml @@ -0,0 +1,122 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject +name: HierarchicalChildModelUpdateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: HierarchicalChildModelUpdateObject. +constructor: + syntax: 'HierarchicalChildModelUpdateObject(*, name: str = None, **kwargs)' + parameters: + - name: name + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor.yml new file mode 100644 index 00000000..563c0d88 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor.yml @@ -0,0 +1,172 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor +name: HierarchicalEntityExtractor +fullName: azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'Hierarchical Entity Extractor. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'HierarchicalEntityExtractor(*, id: str, readable_type, name: str = None, + type_id: int = None, roles=None, children=None, **kwargs)' + parameters: + - name: id + description: Required. The ID of the Entity Model. + isRequired: true + types: + - + - name: name + description: Name of the Entity Model. + isRequired: true + types: + - + - name: type_id + description: The type ID of the Entity Model. + isRequired: true + types: + - + - name: readable_type + description: 'Required. Possible values include: ''Entity + + Extractor'', ''Child Entity Extractor'', ''Hierarchical Entity Extractor'', + + ''Hierarchical Child Entity Extractor'', ''Composite Entity Extractor'', ''List + + Entity Extractor'', ''Prebuilt Entity Extractor'', ''Intent Classifier'', + + ''Pattern.Any Entity Extractor'', ''Closed List Entity Extractor'', ''Regex + + Entity Extractor''' + isRequired: true + types: + - + - + - name: roles + isRequired: true + types: + - [] + - name: children + description: List of child entities. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: readable_type + isRequired: true + - name: name + isRequired: true + - name: type_id + isRequired: true + - name: roles + isRequired: true + - name: children + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel.yml new file mode 100644 index 00000000..c3a3a472 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel +name: HierarchicalModel +fullName: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel +module: azure.cognitiveservices.language.luis.authoring.models +summary: HierarchicalModel. +constructor: + syntax: 'HierarchicalModel(*, name: str = None, children=None, features=None, roles=None, + inherits=None, **kwargs)' + parameters: + - name: name + isRequired: true + types: + - + - name: children + isRequired: true + types: + - [] + - name: features + isRequired: true + types: + - [] + - name: roles + isRequired: true + types: + - [] + - name: inherits + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: children + isRequired: true + - name: features + isRequired: true + - name: roles + isRequired: true + - name: inherits + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2.yml new file mode 100644 index 00000000..0435949b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2 +name: HierarchicalModelV2 +fullName: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2 +module: azure.cognitiveservices.language.luis.authoring.models +summary: HierarchicalModelV2. +constructor: + syntax: 'HierarchicalModelV2(*, name: str = None, children=None, inherits=None, + roles=None, **kwargs)' + parameters: + - name: name + isRequired: true + types: + - + - name: children + isRequired: true + types: + - [] + - name: inherits + isRequired: true + types: + - + - name: roles + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: name + isRequired: true + - name: children + isRequired: true + - name: inherits + isRequired: true + - name: roles + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentClassifier.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentClassifier.yml new file mode 100644 index 00000000..e9585fcd --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentClassifier.yml @@ -0,0 +1,174 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.IntentClassifier +name: IntentClassifier +fullName: azure.cognitiveservices.language.luis.authoring.models.IntentClassifier +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'Intent Classifier. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'IntentClassifier(*, id: str, readable_type, name: str = None, type_id: + int = None, custom_prebuilt_domain_name: str = None, custom_prebuilt_model_name: + str = None, **kwargs)' + parameters: + - name: id + description: Required. The ID of the Entity Model. + isRequired: true + types: + - + - name: name + description: Name of the Entity Model. + isRequired: true + types: + - + - name: type_id + description: The type ID of the Entity Model. + isRequired: true + types: + - + - name: readable_type + description: 'Required. Possible values include: ''Entity + + Extractor'', ''Child Entity Extractor'', ''Hierarchical Entity Extractor'', + + ''Hierarchical Child Entity Extractor'', ''Composite Entity Extractor'', ''List + + Entity Extractor'', ''Prebuilt Entity Extractor'', ''Intent Classifier'', + + ''Pattern.Any Entity Extractor'', ''Closed List Entity Extractor'', ''Regex + + Entity Extractor''' + isRequired: true + types: + - + - + - name: custom_prebuilt_domain_name + description: The domain name. + isRequired: true + types: + - + - name: custom_prebuilt_model_name + description: The intent name or entity name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: readable_type + isRequired: true + - name: name + isRequired: true + - name: type_id + isRequired: true + - name: custom_prebuilt_domain_name + isRequired: true + - name: custom_prebuilt_model_name + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.IntentClassifier.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.IntentClassifier.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.IntentClassifier.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.IntentClassifier.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.IntentClassifier.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.IntentClassifier.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.IntentClassifier.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentPrediction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentPrediction.yml new file mode 100644 index 00000000..0a0813f8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentPrediction.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.IntentPrediction +name: IntentPrediction +fullName: azure.cognitiveservices.language.luis.authoring.models.IntentPrediction +module: azure.cognitiveservices.language.luis.authoring.models +summary: A suggested intent. +constructor: + syntax: 'IntentPrediction(*, name: str = None, score: float = None, **kwargs)' + parameters: + - name: name + description: The intent's name + isRequired: true + types: + - + - name: score + description: The intent's score, based on the prediction model. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: score + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.IntentPrediction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.IntentPrediction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.IntentPrediction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.IntentPrediction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.IntentPrediction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.IntentPrediction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.IntentPrediction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample.yml new file mode 100644 index 00000000..613162e1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample +name: IntentsSuggestionExample +fullName: azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample +module: azure.cognitiveservices.language.luis.authoring.models +summary: Predicted/suggested intent. +constructor: + syntax: 'IntentsSuggestionExample(*, text: str = None, tokenized_text=None, intent_predictions=None, + entity_predictions=None, **kwargs)' + parameters: + - name: text + description: 'The utterance. For example, "What''s the weather like in + + seattle?"' + isRequired: true + types: + - + - name: tokenized_text + description: The tokenized utterance. + isRequired: true + types: + - [] + - name: intent_predictions + description: Predicted/suggested intents. + isRequired: true + types: + - [] + - name: entity_predictions + description: Predicted/suggested entities. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: text + isRequired: true + - name: tokenized_text + isRequired: true + - name: intent_predictions + isRequired: true + - name: entity_predictions + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONEntity.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONEntity.yml new file mode 100644 index 00000000..9ae41a49 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONEntity.yml @@ -0,0 +1,158 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.JSONEntity +name: JSONEntity +fullName: azure.cognitiveservices.language.luis.authoring.models.JSONEntity +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'Exported Model - Extracted Entity from utterance. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'JSONEntity(*, start_pos: int, end_pos: int, entity: str, role: str = None, + children=None, **kwargs)' + parameters: + - name: start_pos + description: 'Required. The index within the utterance where the + + extracted entity starts.' + isRequired: true + types: + - + - name: end_pos + description: 'Required. The index within the utterance where the + + extracted entity ends.' + isRequired: true + types: + - + - name: entity + description: Required. The entity name. + isRequired: true + types: + - + - name: role + description: The role the entity plays in the utterance. + isRequired: true + types: + - + - name: children + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: start_pos + isRequired: true + - name: end_pos + isRequired: true + - name: entity + isRequired: true + - name: role + isRequired: true + - name: children + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONEntity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONEntity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONEntity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONEntity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONEntity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONEntity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONEntity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature.yml new file mode 100644 index 00000000..68f0f995 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature.yml @@ -0,0 +1,170 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature +name: JSONModelFeature +fullName: azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature +module: azure.cognitiveservices.language.luis.authoring.models +summary: Exported Model - Phraselist Model Feature. +constructor: + syntax: 'JSONModelFeature(*, activated: bool = None, name: str = None, words: str + = None, mode: bool = None, enabled_for_all_models: bool = True, **kwargs)' + parameters: + - name: activated + description: Indicates if the feature is enabled. + isRequired: true + types: + - + - name: name + description: The Phraselist name. + isRequired: true + types: + - + - name: words + description: 'List of comma-separated phrases that represent the + + Phraselist.' + isRequired: true + types: + - + - name: mode + description: 'An interchangeable phrase list feature serves as a list of + + synonyms for training. A non-exchangeable phrase list serves as separate + + features for training. So, if your non-interchangeable phrase list + + contains 5 phrases, they will be mapped to 5 separate features. You can + + think of the non-interchangeable phrase list as an additional bag of words + + to add to LUIS existing vocabulary features. It is used as a lexicon + + lookup feature where its value is 1 if the lexicon contains a given word + + or 0 if it doesn''t. Default value is true.' + isRequired: true + types: + - + - name: enabled_for_all_models + description: 'Indicates if the Phraselist is enabled for + + all models in the application. Default value: True .' + isRequired: true + types: + - + keywordOnlyParameters: + - name: activated + isRequired: true + - name: name + isRequired: true + - name: words + isRequired: true + - name: mode + isRequired: true + - name: enabled_for_all_models + defaultValue: 'True' +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature.yml new file mode 100644 index 00000000..a2ff46c2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature +name: JSONRegexFeature +fullName: azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature +module: azure.cognitiveservices.language.luis.authoring.models +summary: Exported Model - A Pattern feature. +constructor: + syntax: 'JSONRegexFeature(*, pattern: str = None, activated: bool = None, name: + str = None, **kwargs)' + parameters: + - name: pattern + description: The Regular Expression to match. + isRequired: true + types: + - + - name: activated + description: Indicates if the Pattern feature is enabled. + isRequired: true + types: + - + - name: name + description: Name of the feature. + isRequired: true + types: + - + keywordOnlyParameters: + - name: pattern + isRequired: true + - name: activated + isRequired: true + - name: name + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONUtterance.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONUtterance.yml new file mode 100644 index 00000000..bb3dd1b3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONUtterance.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.JSONUtterance +name: JSONUtterance +fullName: azure.cognitiveservices.language.luis.authoring.models.JSONUtterance +module: azure.cognitiveservices.language.luis.authoring.models +summary: Exported Model - Utterance that was used to train the model. +constructor: + syntax: 'JSONUtterance(*, text: str = None, intent: str = None, entities=None, **kwargs)' + parameters: + - name: text + description: The utterance. + isRequired: true + types: + - + - name: intent + description: The matched intent. + isRequired: true + types: + - + - name: entities + description: The matched entities. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: text + isRequired: true + - name: intent + isRequired: true + - name: entities + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONUtterance.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONUtterance.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONUtterance.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONUtterance.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONUtterance.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONUtterance.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.JSONUtterance.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JsonChild.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JsonChild.yml new file mode 100644 index 00000000..a2a46367 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JsonChild.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.JsonChild +name: JsonChild +fullName: azure.cognitiveservices.language.luis.authoring.models.JsonChild +module: azure.cognitiveservices.language.luis.authoring.models +summary: JsonChild. +constructor: + syntax: 'JsonChild(*, name: str = None, instance_of: str = None, children=None, + features=None, **kwargs)' + parameters: + - name: name + isRequired: true + types: + - + - name: instance_of + isRequired: true + types: + - + - name: children + isRequired: true + types: + - [] + - name: features + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: name + isRequired: true + - name: instance_of + isRequired: true + - name: children + isRequired: true + - name: features + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.JsonChild.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.JsonChild.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.JsonChild.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.JsonChild.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.JsonChild.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.JsonChild.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.JsonChild.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation.yml new file mode 100644 index 00000000..3e2fb142 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation +name: JsonModelFeatureInformation +fullName: azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'An object containing the model feature information either the model name + or + + feature name.' +constructor: + syntax: 'JsonModelFeatureInformation(*, model_name: str = None, feature_name: str + = None, **kwargs)' + parameters: + - name: model_name + description: The name of the model used. + isRequired: true + types: + - + - name: feature_name + description: The name of the feature used. + isRequired: true + types: + - + keywordOnlyParameters: + - name: model_name + isRequired: true + - name: feature_name + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse.yml new file mode 100644 index 00000000..b779a062 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse +name: LabelExampleResponse +fullName: azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse +module: azure.cognitiveservices.language.luis.authoring.models +summary: Response when adding a labeled example utterance. +constructor: + syntax: 'LabelExampleResponse(*, utterance_text: str = None, example_id: int = None, + **kwargs)' + parameters: + - name: utterance_text + description: The example utterance. + isRequired: true + types: + - + - name: example_id + description: The newly created sample ID. + isRequired: true + types: + - + keywordOnlyParameters: + - name: utterance_text + isRequired: true + - name: example_id + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabelTextObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabelTextObject.yml new file mode 100644 index 00000000..172a65a5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabelTextObject.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.LabelTextObject +name: LabelTextObject +fullName: azure.cognitiveservices.language.luis.authoring.models.LabelTextObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: An object containing the example utterance's text. +constructor: + syntax: 'LabelTextObject(*, id: int = None, text: str = None, **kwargs)' + parameters: + - name: id + description: The ID of the Label. + isRequired: true + types: + - + - name: text + description: The text of the label. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: text + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.LabelTextObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.LabelTextObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.LabelTextObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.LabelTextObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.LabelTextObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.LabelTextObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.LabelTextObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance.yml new file mode 100644 index 00000000..43c8f76b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance.yml @@ -0,0 +1,169 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance +name: LabeledUtterance +fullName: azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance +module: azure.cognitiveservices.language.luis.authoring.models +summary: A prediction and label pair of an example. +constructor: + syntax: 'LabeledUtterance(*, id: int = None, text: str = None, tokenized_text=None, + intent_label: str = None, entity_labels=None, intent_predictions=None, entity_predictions=None, + **kwargs)' + parameters: + - name: id + description: ID of Labeled Utterance. + isRequired: true + types: + - + - name: text + description: 'The utterance. For example, "What''s the weather like in + + seattle?"' + isRequired: true + types: + - + - name: tokenized_text + description: The utterance tokenized. + isRequired: true + types: + - [] + - name: intent_label + description: The intent matching the example. + isRequired: true + types: + - + - name: entity_labels + description: The entities matching the example. + isRequired: true + types: + - [] + - name: intent_predictions + description: List of suggested intents. + isRequired: true + types: + - [] + - name: entity_predictions + description: List of suggested entities. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: text + isRequired: true + - name: tokenized_text + isRequired: true + - name: intent_label + isRequired: true + - name: entity_labels + isRequired: true + - name: intent_predictions + isRequired: true + - name: entity_predictions + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LuisApp.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LuisApp.yml new file mode 100644 index 00000000..1e3e8578 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LuisApp.yml @@ -0,0 +1,241 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.LuisApp +name: LuisApp +fullName: azure.cognitiveservices.language.luis.authoring.models.LuisApp +module: azure.cognitiveservices.language.luis.authoring.models +summary: Exported Model - An exported LUIS Application. +constructor: + syntax: 'LuisApp(*, additional_properties=None, name: str = None, version_id: str + = None, desc: str = None, culture: str = None, intents=None, entities=None, closed_lists=None, + composites=None, hierarchicals=None, pattern_any_entities=None, regex_entities=None, + prebuilt_entities=None, regex_features=None, phraselists=None, patterns=None, + utterances=None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: name + description: The name of the application. + isRequired: true + types: + - + - name: version_id + description: The version ID of the application that was exported. + isRequired: true + types: + - + - name: desc + description: The description of the application. + isRequired: true + types: + - + - name: culture + description: 'The culture of the application. E.g.: en-us.' + isRequired: true + types: + - + - name: intents + description: List of intents. + isRequired: true + types: + - [] + - name: entities + description: List of entities. + isRequired: true + types: + - [] + - name: closed_lists + description: List of list entities. + isRequired: true + types: + - [] + - name: composites + description: List of composite entities. + isRequired: true + types: + - [] + - name: hierarchicals + description: List of hierarchical entities. + isRequired: true + types: + - [] + - name: pattern_any_entities + description: List of Pattern.Any entities. + isRequired: true + types: + - [] + - name: regex_entities + description: List of regular expression entities. + isRequired: true + types: + - [] + - name: prebuilt_entities + description: List of prebuilt entities. + isRequired: true + types: + - [] + - name: regex_features + description: List of pattern features. + isRequired: true + types: + - [] + - name: phraselists + description: List of model features. + isRequired: true + types: + - [] + - name: patterns + description: List of patterns. + isRequired: true + types: + - [] + - name: utterances + description: List of example utterances. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: name + isRequired: true + - name: version_id + isRequired: true + - name: desc + isRequired: true + - name: culture + isRequired: true + - name: intents + isRequired: true + - name: entities + isRequired: true + - name: closed_lists + isRequired: true + - name: composites + isRequired: true + - name: hierarchicals + isRequired: true + - name: pattern_any_entities + isRequired: true + - name: regex_entities + isRequired: true + - name: prebuilt_entities + isRequired: true + - name: regex_features + isRequired: true + - name: phraselists + isRequired: true + - name: patterns + isRequired: true + - name: utterances + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.LuisApp.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.LuisApp.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.LuisApp.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.LuisApp.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.LuisApp.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.LuisApp.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.LuisApp.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LuisAppV2.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LuisAppV2.yml new file mode 100644 index 00000000..4fe07e6b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LuisAppV2.yml @@ -0,0 +1,241 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.LuisAppV2 +name: LuisAppV2 +fullName: azure.cognitiveservices.language.luis.authoring.models.LuisAppV2 +module: azure.cognitiveservices.language.luis.authoring.models +summary: Exported Model - An exported LUIS Application. +constructor: + syntax: 'LuisAppV2(*, additional_properties=None, luis_schema_version: str = None, + name: str = None, version_id: str = None, desc: str = None, culture: str = None, + intents=None, entities=None, closed_lists=None, composites=None, pattern_any_entities=None, + regex_entities=None, prebuilt_entities=None, regex_features=None, model_features=None, + patterns=None, utterances=None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: luis_schema_version + description: Luis schema deserialization version. + isRequired: true + types: + - + - name: name + description: The name of the application. + isRequired: true + types: + - + - name: version_id + description: The version ID of the application that was exported. + isRequired: true + types: + - + - name: desc + description: The description of the application. + isRequired: true + types: + - + - name: culture + description: 'The culture of the application. E.g.: en-us.' + isRequired: true + types: + - + - name: intents + description: List of intents. + isRequired: true + types: + - [] + - name: entities + description: List of entities. + isRequired: true + types: + - [] + - name: closed_lists + description: List of list entities. + isRequired: true + types: + - [] + - name: composites + description: List of composite entities. + isRequired: true + types: + - [] + - name: pattern_any_entities + description: List of Pattern.Any entities. + isRequired: true + types: + - [] + - name: regex_entities + description: List of regular expression entities. + isRequired: true + types: + - [] + - name: prebuilt_entities + description: List of prebuilt entities. + isRequired: true + types: + - [] + - name: regex_features + description: List of pattern features. + isRequired: true + types: + - [] + - name: model_features + description: List of model features. + isRequired: true + types: + - [] + - name: patterns + description: List of patterns. + isRequired: true + types: + - [] + - name: utterances + description: List of example utterances. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: luis_schema_version + isRequired: true + - name: name + isRequired: true + - name: version_id + isRequired: true + - name: desc + isRequired: true + - name: culture + isRequired: true + - name: intents + isRequired: true + - name: entities + isRequired: true + - name: closed_lists + isRequired: true + - name: composites + isRequired: true + - name: pattern_any_entities + isRequired: true + - name: regex_entities + isRequired: true + - name: prebuilt_entities + isRequired: true + - name: regex_features + isRequired: true + - name: model_features + isRequired: true + - name: patterns + isRequired: true + - name: utterances + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.LuisAppV2.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.LuisAppV2.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.LuisAppV2.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.LuisAppV2.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.LuisAppV2.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.LuisAppV2.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.LuisAppV2.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject.yml new file mode 100644 index 00000000..76a210ab --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject +name: ModelCreateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Object model for creating a new entity extractor. +constructor: + syntax: 'ModelCreateObject(*, name: str = None, **kwargs)' + parameters: + - name: name + description: Name of the new entity extractor. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation.yml new file mode 100644 index 00000000..ab28f5be --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation +name: ModelFeatureInformation +fullName: azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'An object containing the model feature information either the model name + or + + feature name.' +constructor: + syntax: 'ModelFeatureInformation(*, model_name: str = None, feature_name: str = + None, is_required: bool = None, **kwargs)' + parameters: + - name: model_name + description: The name of the model used. + isRequired: true + types: + - + - name: feature_name + description: The name of the feature used. + isRequired: true + types: + - + - name: is_required + isRequired: true + types: + - + keywordOnlyParameters: + - name: model_name + isRequired: true + - name: feature_name + isRequired: true + - name: is_required + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelInfo.yml new file mode 100644 index 00000000..68512fc2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelInfo.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfo +name: ModelInfo +fullName: azure.cognitiveservices.language.luis.authoring.models.ModelInfo +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'Base type used in entity types. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ModelInfo(*, id: str, readable_type, name: str = None, type_id: int = None, + **kwargs)' + parameters: + - name: id + description: Required. The ID of the Entity Model. + isRequired: true + types: + - + - name: name + description: Name of the Entity Model. + isRequired: true + types: + - + - name: type_id + description: The type ID of the Entity Model. + isRequired: true + types: + - + - name: readable_type + description: 'Required. Possible values include: ''Entity + + Extractor'', ''Child Entity Extractor'', ''Hierarchical Entity Extractor'', + + ''Hierarchical Child Entity Extractor'', ''Composite Entity Extractor'', ''List + + Entity Extractor'', ''Prebuilt Entity Extractor'', ''Intent Classifier'', + + ''Pattern.Any Entity Extractor'', ''Closed List Entity Extractor'', ''Regex + + Entity Extractor''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: readable_type + isRequired: true + - name: name + isRequired: true + - name: type_id + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse.yml new file mode 100644 index 00000000..537cd057 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse.yml @@ -0,0 +1,208 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse +name: ModelInfoResponse +fullName: azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'An application model info. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ModelInfoResponse(*, id: str, readable_type, name: str = None, type_id: + int = None, roles=None, children=None, sub_lists=None, custom_prebuilt_domain_name: + str = None, custom_prebuilt_model_name: str = None, regex_pattern: str = None, + explicit_list=None, **kwargs)' + parameters: + - name: id + description: Required. The ID of the Entity Model. + isRequired: true + types: + - + - name: name + description: Name of the Entity Model. + isRequired: true + types: + - + - name: type_id + description: The type ID of the Entity Model. + isRequired: true + types: + - + - name: readable_type + description: 'Required. Possible values include: ''Entity + + Extractor'', ''Child Entity Extractor'', ''Hierarchical Entity Extractor'', + + ''Hierarchical Child Entity Extractor'', ''Composite Entity Extractor'', ''List + + Entity Extractor'', ''Prebuilt Entity Extractor'', ''Intent Classifier'', + + ''Pattern.Any Entity Extractor'', ''Closed List Entity Extractor'', ''Regex + + Entity Extractor''' + isRequired: true + types: + - + - + - name: roles + isRequired: true + types: + - [] + - name: children + description: List of child entities. + isRequired: true + types: + - [] + - name: sub_lists + description: List of sublists. + isRequired: true + types: + - [] + - name: custom_prebuilt_domain_name + description: The domain name. + isRequired: true + types: + - + - name: custom_prebuilt_model_name + description: The intent name or entity name. + isRequired: true + types: + - + - name: regex_pattern + description: The Regular Expression entity pattern. + isRequired: true + types: + - + - name: explicit_list + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: readable_type + isRequired: true + - name: name + isRequired: true + - name: type_id + isRequired: true + - name: roles + isRequired: true + - name: children + isRequired: true + - name: sub_lists + isRequired: true + - name: custom_prebuilt_domain_name + isRequired: true + - name: custom_prebuilt_model_name + isRequired: true + - name: regex_pattern + isRequired: true + - name: explicit_list + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails.yml new file mode 100644 index 00000000..fb37ccbe --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails.yml @@ -0,0 +1,155 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails +name: ModelTrainingDetails +fullName: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails +module: azure.cognitiveservices.language.luis.authoring.models +summary: Model Training Details. +constructor: + syntax: 'ModelTrainingDetails(*, status_id: int = None, status=None, example_count: + int = None, training_date_time=None, failure_reason: str = None, **kwargs)' + parameters: + - name: status_id + description: The train request status ID. + isRequired: true + types: + - + - name: status + description: 'Possible values include: ''Queued'', ''InProgress'', + + ''UpToDate'', ''Fail'', ''Success''' + isRequired: true + types: + - + - + - name: example_count + description: The count of examples used to train the model. + isRequired: true + types: + - + - name: training_date_time + description: When the model was trained. + isRequired: true + types: + - + - name: failure_reason + description: Reason for the training failure. + isRequired: true + types: + - + keywordOnlyParameters: + - name: status_id + isRequired: true + - name: status + isRequired: true + - name: example_count + isRequired: true + - name: training_date_time + isRequired: true + - name: failure_reason + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo.yml new file mode 100644 index 00000000..7ee26d59 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo +name: ModelTrainingInfo +fullName: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo +module: azure.cognitiveservices.language.luis.authoring.models +summary: Model Training Info. +constructor: + syntax: 'ModelTrainingInfo(*, model_id: str = None, details=None, **kwargs)' + parameters: + - name: model_id + description: The ID (GUID) of the model. + isRequired: true + types: + - + - name: details + isRequired: true + types: + - + keywordOnlyParameters: + - name: model_id + isRequired: true + - name: details + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject.yml new file mode 100644 index 00000000..ced69ac8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject +name: ModelUpdateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Object model for updating an intent classifier. +constructor: + syntax: 'ModelUpdateObject(*, name: str = None, **kwargs)' + parameters: + - name: name + description: The entity's new name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor.yml new file mode 100644 index 00000000..cd9a1f6c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor.yml @@ -0,0 +1,186 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor +name: NDepthEntityExtractor +fullName: azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'N-Depth Entity Extractor. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'NDepthEntityExtractor(*, id: str, readable_type, name: str = None, type_id: + int = None, roles=None, custom_prebuilt_domain_name: str = None, custom_prebuilt_model_name: + str = None, children=None, **kwargs)' + parameters: + - name: id + description: Required. The ID of the Entity Model. + isRequired: true + types: + - + - name: name + description: Name of the Entity Model. + isRequired: true + types: + - + - name: type_id + description: The type ID of the Entity Model. + isRequired: true + types: + - + - name: readable_type + description: 'Required. Possible values include: ''Entity + + Extractor'', ''Child Entity Extractor'', ''Hierarchical Entity Extractor'', + + ''Hierarchical Child Entity Extractor'', ''Composite Entity Extractor'', ''List + + Entity Extractor'', ''Prebuilt Entity Extractor'', ''Intent Classifier'', + + ''Pattern.Any Entity Extractor'', ''Closed List Entity Extractor'', ''Regex + + Entity Extractor''' + isRequired: true + types: + - + - + - name: roles + isRequired: true + types: + - [] + - name: custom_prebuilt_domain_name + description: The domain name. + isRequired: true + types: + - + - name: custom_prebuilt_model_name + description: The intent name or entity name. + isRequired: true + types: + - + - name: children + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: readable_type + isRequired: true + - name: name + isRequired: true + - name: type_id + isRequired: true + - name: roles + isRequired: true + - name: custom_prebuilt_domain_name + isRequired: true + - name: custom_prebuilt_model_name + isRequired: true + - name: children + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.OperationError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.OperationError.yml new file mode 100644 index 00000000..a989d682 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.OperationError.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.OperationError +name: OperationError +fullName: azure.cognitiveservices.language.luis.authoring.models.OperationError +module: azure.cognitiveservices.language.luis.authoring.models +summary: Operation error details when invoking an operation on the API. +constructor: + syntax: 'OperationError(*, code: str = None, message: str = None, **kwargs)' + parameters: + - name: code + isRequired: true + types: + - + - name: message + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.OperationError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.OperationError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.OperationError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.OperationError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.OperationError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.OperationError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.OperationError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.OperationStatus.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.OperationStatus.yml new file mode 100644 index 00000000..e482dc3b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.OperationStatus.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.OperationStatus +name: OperationStatus +fullName: azure.cognitiveservices.language.luis.authoring.models.OperationStatus +module: azure.cognitiveservices.language.luis.authoring.models +summary: Response of an Operation status. +constructor: + syntax: 'OperationStatus(*, code=None, message: str = None, **kwargs)' + parameters: + - name: code + description: 'Status Code. Possible values include: ''Failed'', ''FAILED'', + + ''Success''' + isRequired: true + types: + - + - + - name: message + description: Status details. + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.OperationStatus.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.OperationStatus.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.OperationStatus.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.OperationStatus.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.OperationStatus.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.OperationStatus.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.OperationStatus.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.OperationStatusType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.OperationStatusType.yml new file mode 100644 index 00000000..ce4accb3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.OperationStatusType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.language.luis.authoring.models.OperationStatusType +name: OperationStatusType +fullName: azure.cognitiveservices.language.luis.authoring.models.OperationStatusType +module: azure.cognitiveservices.language.luis.authoring.models +fields: +- name: failed + uid: azure.cognitiveservices.language.luis.authoring.models.OperationStatusType.failed +- name: success + uid: azure.cognitiveservices.language.luis.authoring.models.OperationStatusType.success diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAny.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAny.yml new file mode 100644 index 00000000..2c79ad05 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAny.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.PatternAny +name: PatternAny +fullName: azure.cognitiveservices.language.luis.authoring.models.PatternAny +module: azure.cognitiveservices.language.luis.authoring.models +summary: Pattern.Any Entity Extractor. +constructor: + syntax: 'PatternAny(*, name: str = None, explicit_list=None, roles=None, **kwargs)' + parameters: + - name: name + isRequired: true + types: + - + - name: explicit_list + isRequired: true + types: + - [] + - name: roles + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: name + isRequired: true + - name: explicit_list + isRequired: true + - name: roles + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAny.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAny.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAny.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAny.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAny.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAny.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAny.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor.yml new file mode 100644 index 00000000..dd0699a6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor +name: PatternAnyEntityExtractor +fullName: azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'Pattern.Any Entity Extractor. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PatternAnyEntityExtractor(*, id: str, readable_type, name: str = None, + type_id: int = None, roles=None, explicit_list=None, **kwargs)' + parameters: + - name: id + description: Required. The ID of the Entity Model. + isRequired: true + types: + - + - name: name + description: Name of the Entity Model. + isRequired: true + types: + - + - name: type_id + description: The type ID of the Entity Model. + isRequired: true + types: + - + - name: readable_type + description: 'Required. Possible values include: ''Entity + + Extractor'', ''Child Entity Extractor'', ''Hierarchical Entity Extractor'', + + ''Hierarchical Child Entity Extractor'', ''Composite Entity Extractor'', ''List + + Entity Extractor'', ''Prebuilt Entity Extractor'', ''Intent Classifier'', + + ''Pattern.Any Entity Extractor'', ''Closed List Entity Extractor'', ''Regex + + Entity Extractor''' + isRequired: true + types: + - + - + - name: roles + isRequired: true + types: + - [] + - name: explicit_list + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: readable_type + isRequired: true + - name: name + isRequired: true + - name: type_id + isRequired: true + - name: roles + isRequired: true + - name: explicit_list + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject.yml new file mode 100644 index 00000000..32b60e22 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject +name: PatternAnyModelCreateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Model object for creating a Pattern.Any entity model. +constructor: + syntax: 'PatternAnyModelCreateObject(*, name: str = None, explicit_list=None, **kwargs)' + parameters: + - name: name + description: The model name. + isRequired: true + types: + - + - name: explicit_list + description: The Pattern.Any explicit list. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: name + isRequired: true + - name: explicit_list + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject.yml new file mode 100644 index 00000000..087b94a3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject +name: PatternAnyModelUpdateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Model object for updating a Pattern.Any entity model. +constructor: + syntax: 'PatternAnyModelUpdateObject(*, name: str = None, explicit_list=None, **kwargs)' + parameters: + - name: name + description: The model name. + isRequired: true + types: + - + - name: explicit_list + description: The Pattern.Any explicit list. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: name + isRequired: true + - name: explicit_list + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo.yml new file mode 100644 index 00000000..002dc8d0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo +name: PatternFeatureInfo +fullName: azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo +module: azure.cognitiveservices.language.luis.authoring.models +summary: Pattern feature. +constructor: + syntax: 'PatternFeatureInfo(*, id: int = None, name: str = None, is_active: bool + = None, enabled_for_all_models: bool = None, pattern: str = None, **kwargs)' + parameters: + - name: id + description: A six-digit ID used for Features. + isRequired: true + types: + - + - name: name + description: The name of the Feature. + isRequired: true + types: + - + - name: is_active + description: Indicates if the feature is enabled. + isRequired: true + types: + - + - name: enabled_for_all_models + description: 'Indicates if the feature is enabled for all + + models in the application.' + isRequired: true + types: + - + - name: pattern + description: The Regular Expression to match. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: name + isRequired: true + - name: is_active + isRequired: true + - name: enabled_for_all_models + isRequired: true + - name: pattern + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRule.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRule.yml new file mode 100644 index 00000000..1c47d692 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRule.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.PatternRule +name: PatternRule +fullName: azure.cognitiveservices.language.luis.authoring.models.PatternRule +module: azure.cognitiveservices.language.luis.authoring.models +summary: Pattern. +constructor: + syntax: 'PatternRule(*, pattern: str = None, intent: str = None, **kwargs)' + parameters: + - name: pattern + description: The pattern text. + isRequired: true + types: + - + - name: intent + description: The intent's name where the pattern belongs to. + isRequired: true + types: + - + keywordOnlyParameters: + - name: pattern + isRequired: true + - name: intent + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRule.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRule.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRule.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRule.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRule.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRule.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRule.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject.yml new file mode 100644 index 00000000..7a629371 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject +name: PatternRuleCreateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Object model for creating a pattern. +constructor: + syntax: 'PatternRuleCreateObject(*, pattern: str = None, intent: str = None, **kwargs)' + parameters: + - name: pattern + description: The pattern text. + isRequired: true + types: + - + - name: intent + description: The intent's name which the pattern belongs to. + isRequired: true + types: + - + keywordOnlyParameters: + - name: pattern + isRequired: true + - name: intent + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo.yml new file mode 100644 index 00000000..12ea6fa5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo +name: PatternRuleInfo +fullName: azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo +module: azure.cognitiveservices.language.luis.authoring.models +summary: Pattern rule. +constructor: + syntax: 'PatternRuleInfo(*, id: str = None, pattern: str = None, intent: str = None, + **kwargs)' + parameters: + - name: id + description: The pattern ID. + isRequired: true + types: + - + - name: pattern + description: The pattern text. + isRequired: true + types: + - + - name: intent + description: The intent's name where the pattern belongs to. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: pattern + isRequired: true + - name: intent + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject.yml new file mode 100644 index 00000000..ce916aa3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject +name: PatternRuleUpdateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Object model for updating a pattern. +constructor: + syntax: 'PatternRuleUpdateObject(*, id: str = None, pattern: str = None, intent: + str = None, **kwargs)' + parameters: + - name: id + description: The pattern ID. + isRequired: true + types: + - + - name: pattern + description: The pattern text. + isRequired: true + types: + - + - name: intent + description: The intent's name which the pattern belongs to. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: pattern + isRequired: true + - name: intent + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse.yml new file mode 100644 index 00000000..b2f7c2ba --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse +name: PersonalAssistantsResponse +fullName: azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'Response containing user''s endpoint keys and the endpoint URLs of the + + prebuilt Cortana applications.' +constructor: + syntax: PersonalAssistantsResponse(*, endpoint_keys=None, endpoint_urls=None, **kwargs) + parameters: + - name: endpoint_keys + isRequired: true + types: + - [] + - name: endpoint_urls + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: endpoint_keys + isRequired: true + - name: endpoint_urls + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo.yml new file mode 100644 index 00000000..aa26200f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo.yml @@ -0,0 +1,182 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo +name: PhraseListFeatureInfo +fullName: azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo +module: azure.cognitiveservices.language.luis.authoring.models +summary: Phraselist Feature. +constructor: + syntax: 'PhraseListFeatureInfo(*, id: int = None, name: str = None, is_active: bool + = None, enabled_for_all_models: bool = None, phrases: str = None, is_exchangeable: + bool = None, **kwargs)' + parameters: + - name: id + description: A six-digit ID used for Features. + isRequired: true + types: + - + - name: name + description: The name of the Feature. + isRequired: true + types: + - + - name: is_active + description: Indicates if the feature is enabled. + isRequired: true + types: + - + - name: enabled_for_all_models + description: 'Indicates if the feature is enabled for all + + models in the application.' + isRequired: true + types: + - + - name: phrases + description: A list of comma-separated values. + isRequired: true + types: + - + - name: is_exchangeable + description: 'An exchangeable phrase list feature are serves as + + single feature to the LUIS underlying training algorithm. It is used as a + + lexicon lookup feature where its value is 1 if the lexicon contains a + + given word or 0 if it doesn''t. Think of an exchangeable as a synonyms + + list. A non-exchangeable phrase list feature has all the phrases in the + + list serve as separate features to the underlying training algorithm. So, + + if you your phrase list feature contains 5 phrases, they will be mapped to + + 5 separate features. You can think of the non-exchangeable phrase list + + feature as an additional bag of words that you are willing to add to LUIS + + existing vocabulary features. Think of a non-exchangeable as set of + + different words. Default value is true.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: name + isRequired: true + - name: is_active + isRequired: true + - name: enabled_for_all_models + isRequired: true + - name: phrases + isRequired: true + - name: is_exchangeable + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject.yml new file mode 100644 index 00000000..d77407b3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject.yml @@ -0,0 +1,163 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject +name: PhraselistCreateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Object model for creating a phraselist model. +constructor: + syntax: 'PhraselistCreateObject(*, phrases: str = None, name: str = None, is_exchangeable: + bool = True, enabled_for_all_models: bool = True, **kwargs)' + parameters: + - name: phrases + description: 'List of comma-separated phrases that represent the + + Phraselist.' + isRequired: true + types: + - + - name: name + description: The Phraselist name. + isRequired: true + types: + - + - name: is_exchangeable + description: 'An interchangeable phrase list feature serves as a + + list of synonyms for training. A non-exchangeable phrase list serves as + + separate features for training. So, if your non-interchangeable phrase + + list contains 5 phrases, they will be mapped to 5 separate features. You + + can think of the non-interchangeable phrase list as an additional bag of + + words to add to LUIS existing vocabulary features. It is used as a lexicon + + lookup feature where its value is 1 if the lexicon contains a given word + + or 0 if it doesn''t. Default value is true. Default value: True .' + isRequired: true + types: + - + - name: enabled_for_all_models + description: 'Indicates if the Phraselist is enabled for + + all models in the application. Default value: True .' + isRequired: true + types: + - + keywordOnlyParameters: + - name: phrases + isRequired: true + - name: name + isRequired: true + - name: is_exchangeable + defaultValue: 'True' + - name: enabled_for_all_models + defaultValue: 'True' +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject.yml new file mode 100644 index 00000000..b305810e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject.yml @@ -0,0 +1,179 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject +name: PhraselistUpdateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Object model for updating a Phraselist. +constructor: + syntax: 'PhraselistUpdateObject(*, phrases: str = None, name: str = None, is_active: + bool = True, is_exchangeable: bool = True, enabled_for_all_models: bool = True, + **kwargs)' + parameters: + - name: phrases + description: 'List of comma-separated phrases that represent the + + Phraselist.' + isRequired: true + types: + - + - name: name + description: The Phraselist name. + isRequired: true + types: + - + - name: is_active + description: 'Indicates if the Phraselist is enabled. Default value: + + True .' + isRequired: true + types: + - + - name: is_exchangeable + description: 'An exchangeable phrase list feature are serves as + + single feature to the LUIS underlying training algorithm. It is used as a + + lexicon lookup feature where its value is 1 if the lexicon contains a + + given word or 0 if it doesn''t. Think of an exchangeable as a synonyms + + list. A non-exchangeable phrase list feature has all the phrases in the + + list serve as separate features to the underlying training algorithm. So, + + if you your phrase list feature contains 5 phrases, they will be mapped to + + 5 separate features. You can think of the non-exchangeable phrase list + + feature as an additional bag of words that you are willing to add to LUIS + + existing vocabulary features. Think of a non-exchangeable as set of + + different words. Default value is true. Default value: True .' + isRequired: true + types: + - + - name: enabled_for_all_models + description: 'Indicates if the Phraselist is enabled for + + all models in the application. Default value: True .' + isRequired: true + types: + - + keywordOnlyParameters: + - name: phrases + isRequired: true + - name: name + isRequired: true + - name: is_active + defaultValue: 'True' + - name: is_exchangeable + defaultValue: 'True' + - name: enabled_for_all_models + defaultValue: 'True' +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain.yml new file mode 100644 index 00000000..bffdbce4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain.yml @@ -0,0 +1,153 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain +name: PrebuiltDomain +fullName: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain +module: azure.cognitiveservices.language.luis.authoring.models +summary: Prebuilt Domain. +constructor: + syntax: 'PrebuiltDomain(*, name: str = None, culture: str = None, description: str + = None, examples: str = None, intents=None, entities=None, **kwargs)' + parameters: + - name: name + isRequired: true + types: + - + - name: culture + isRequired: true + types: + - + - name: description + isRequired: true + types: + - + - name: examples + isRequired: true + types: + - + - name: intents + isRequired: true + types: + - [] + - name: entities + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: name + isRequired: true + - name: culture + isRequired: true + - name: description + isRequired: true + - name: examples + isRequired: true + - name: intents + isRequired: true + - name: entities + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject.yml new file mode 100644 index 00000000..96b8f835 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject +name: PrebuiltDomainCreateBaseObject +fullName: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'A model object containing the name of the custom prebuilt entity and the + + name of the domain to which this model belongs.' +constructor: + syntax: 'PrebuiltDomainCreateBaseObject(*, domain_name: str = None, **kwargs)' + parameters: + - name: domain_name + description: The domain name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: domain_name + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject.yml new file mode 100644 index 00000000..c61ce221 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject +name: PrebuiltDomainCreateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'A prebuilt domain create object containing the name and culture of the + + domain.' +constructor: + syntax: 'PrebuiltDomainCreateObject(*, domain_name: str = None, culture: str = None, + **kwargs)' + parameters: + - name: domain_name + description: The domain name. + isRequired: true + types: + - + - name: culture + description: The culture of the new domain. + isRequired: true + types: + - + keywordOnlyParameters: + - name: domain_name + isRequired: true + - name: culture + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem.yml new file mode 100644 index 00000000..af19f878 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem +name: PrebuiltDomainItem +fullName: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem +module: azure.cognitiveservices.language.luis.authoring.models +summary: PrebuiltDomainItem. +constructor: + syntax: 'PrebuiltDomainItem(*, name: str = None, description: str = None, examples: + str = None, **kwargs)' + parameters: + - name: name + isRequired: true + types: + - + - name: description + isRequired: true + types: + - + - name: examples + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: description + isRequired: true + - name: examples + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject.yml new file mode 100644 index 00000000..46549b6e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject +name: PrebuiltDomainModelCreateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'A model object containing the name of the custom prebuilt intent or entity + + and the name of the domain to which this model belongs.' +constructor: + syntax: 'PrebuiltDomainModelCreateObject(*, domain_name: str = None, model_name: + str = None, **kwargs)' + parameters: + - name: domain_name + description: The domain name. + isRequired: true + types: + - + - name: model_name + description: The intent name or entity name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: domain_name + isRequired: true + - name: model_name + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject.yml new file mode 100644 index 00000000..266f4f52 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject +name: PrebuiltDomainObject +fullName: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: PrebuiltDomainObject. +constructor: + syntax: 'PrebuiltDomainObject(*, domain_name: str = None, model_name: str = None, + **kwargs)' + parameters: + - name: domain_name + isRequired: true + types: + - + - name: model_name + isRequired: true + types: + - + keywordOnlyParameters: + - name: domain_name + isRequired: true + - name: model_name + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity.yml new file mode 100644 index 00000000..44f85c88 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity +name: PrebuiltEntity +fullName: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity +module: azure.cognitiveservices.language.luis.authoring.models +summary: Prebuilt Entity Extractor. +constructor: + syntax: 'PrebuiltEntity(*, name: str = None, roles=None, **kwargs)' + parameters: + - name: name + isRequired: true + types: + - + - name: roles + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: name + isRequired: true + - name: roles + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor.yml new file mode 100644 index 00000000..b1f87234 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor.yml @@ -0,0 +1,165 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor +name: PrebuiltEntityExtractor +fullName: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'Prebuilt Entity Extractor. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PrebuiltEntityExtractor(*, id: str, readable_type, name: str = None, type_id: + int = None, roles=None, **kwargs)' + parameters: + - name: id + description: Required. The ID of the Entity Model. + isRequired: true + types: + - + - name: name + description: Name of the Entity Model. + isRequired: true + types: + - + - name: type_id + description: The type ID of the Entity Model. + isRequired: true + types: + - + - name: readable_type + description: 'Required. Possible values include: ''Entity + + Extractor'', ''Child Entity Extractor'', ''Hierarchical Entity Extractor'', + + ''Hierarchical Child Entity Extractor'', ''Composite Entity Extractor'', ''List + + Entity Extractor'', ''Prebuilt Entity Extractor'', ''Intent Classifier'', + + ''Pattern.Any Entity Extractor'', ''Closed List Entity Extractor'', ''Regex + + Entity Extractor''' + isRequired: true + types: + - + - + - name: roles + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: readable_type + isRequired: true + - name: name + isRequired: true + - name: type_id + isRequired: true + - name: roles + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo.yml new file mode 100644 index 00000000..06e6d847 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo.yml @@ -0,0 +1,177 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo +name: ProductionOrStagingEndpointInfo +fullName: azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo +module: azure.cognitiveservices.language.luis.authoring.models +summary: ProductionOrStagingEndpointInfo. +constructor: + syntax: 'ProductionOrStagingEndpointInfo(*, version_id: str = None, is_staging: + bool = None, endpoint_url: str = None, region: str = None, assigned_endpoint_key: + str = None, endpoint_region: str = None, failed_regions: str = None, published_date_time: + str = None, **kwargs)' + parameters: + - name: version_id + description: The version ID to publish. + isRequired: true + types: + - + - name: is_staging + description: 'Indicates if the staging slot should be used, instead + + of the Production one.' + isRequired: true + types: + - + - name: endpoint_url + description: The Runtime endpoint URL for this model version. + isRequired: true + types: + - + - name: region + description: The target region that the application is published to. + isRequired: true + types: + - + - name: assigned_endpoint_key + description: The endpoint key. + isRequired: true + types: + - + - name: endpoint_region + description: The endpoint's region. + isRequired: true + types: + - + - name: failed_regions + description: Regions where publishing failed. + isRequired: true + types: + - + - name: published_date_time + description: Timestamp when was last published. + isRequired: true + types: + - + keywordOnlyParameters: + - name: version_id + isRequired: true + - name: is_staging + isRequired: true + - name: endpoint_url + isRequired: true + - name: region + isRequired: true + - name: assigned_endpoint_key + isRequired: true + - name: endpoint_region + isRequired: true + - name: failed_regions + isRequired: true + - name: published_date_time + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject.yml new file mode 100644 index 00000000..bc48ff17 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject +name: PublishSettingUpdateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Object model for updating an application's publish settings. +constructor: + syntax: 'PublishSettingUpdateObject(*, sentiment_analysis: bool = None, speech: + bool = None, spell_checker: bool = None, **kwargs)' + parameters: + - name: sentiment_analysis + description: 'Setting sentiment analysis as true returns the + + Sentiment of the input utterance along with the response' + isRequired: true + types: + - + - name: speech + description: Setting speech as public enables speech priming in your app + isRequired: true + types: + - + - name: spell_checker + description: 'Setting spell checker as public enables spell + + checking the input utterance.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: sentiment_analysis + isRequired: true + - name: speech + isRequired: true + - name: spell_checker + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PublishSettings.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PublishSettings.yml new file mode 100644 index 00000000..fdd29944 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PublishSettings.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.PublishSettings +name: PublishSettings +fullName: azure.cognitiveservices.language.luis.authoring.models.PublishSettings +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'The application publish settings. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PublishSettings(*, id: str, is_sentiment_analysis_enabled: bool, is_speech_enabled: + bool, is_spell_checker_enabled: bool, **kwargs)' + parameters: + - name: id + description: Required. The application ID. + isRequired: true + types: + - + - name: is_sentiment_analysis_enabled + description: 'Required. Setting sentiment analysis + + as true returns the sentiment of the input utterance along with the + + response' + isRequired: true + types: + - + - name: is_speech_enabled + description: Required. Enables speech priming in your app + isRequired: true + types: + - + - name: is_spell_checker_enabled + description: 'Required. Enables spell checking of the + + utterance.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: is_sentiment_analysis_enabled + isRequired: true + - name: is_speech_enabled + isRequired: true + - name: is_spell_checker_enabled + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.PublishSettings.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PublishSettings.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PublishSettings.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.PublishSettings.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.PublishSettings.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.PublishSettings.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.PublishSettings.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexEntity.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexEntity.yml new file mode 100644 index 00000000..3fbe6520 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexEntity.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntity +name: RegexEntity +fullName: azure.cognitiveservices.language.luis.authoring.models.RegexEntity +module: azure.cognitiveservices.language.luis.authoring.models +summary: Regular Expression Entity Extractor. +constructor: + syntax: 'RegexEntity(*, name: str = None, regex_pattern: str = None, roles=None, + **kwargs)' + parameters: + - name: name + isRequired: true + types: + - + - name: regex_pattern + isRequired: true + types: + - + - name: roles + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: name + isRequired: true + - name: regex_pattern + isRequired: true + - name: roles + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor.yml new file mode 100644 index 00000000..5abc75c6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor.yml @@ -0,0 +1,172 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor +name: RegexEntityExtractor +fullName: azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'Regular Expression Entity Extractor. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RegexEntityExtractor(*, id: str, readable_type, name: str = None, type_id: + int = None, roles=None, regex_pattern: str = None, **kwargs)' + parameters: + - name: id + description: Required. The ID of the Entity Model. + isRequired: true + types: + - + - name: name + description: Name of the Entity Model. + isRequired: true + types: + - + - name: type_id + description: The type ID of the Entity Model. + isRequired: true + types: + - + - name: readable_type + description: 'Required. Possible values include: ''Entity + + Extractor'', ''Child Entity Extractor'', ''Hierarchical Entity Extractor'', + + ''Hierarchical Child Entity Extractor'', ''Composite Entity Extractor'', ''List + + Entity Extractor'', ''Prebuilt Entity Extractor'', ''Intent Classifier'', + + ''Pattern.Any Entity Extractor'', ''Closed List Entity Extractor'', ''Regex + + Entity Extractor''' + isRequired: true + types: + - + - + - name: roles + isRequired: true + types: + - [] + - name: regex_pattern + description: The Regular Expression entity pattern. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: readable_type + isRequired: true + - name: name + isRequired: true + - name: type_id + isRequired: true + - name: roles + isRequired: true + - name: regex_pattern + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject.yml new file mode 100644 index 00000000..011feae3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject +name: RegexModelCreateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Model object for creating a regular expression entity model. +constructor: + syntax: 'RegexModelCreateObject(*, regex_pattern: str = None, name: str = None, + **kwargs)' + parameters: + - name: regex_pattern + description: The regular expression entity pattern. + isRequired: true + types: + - + - name: name + description: The model name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: regex_pattern + isRequired: true + - name: name + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject.yml new file mode 100644 index 00000000..a34a501c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject +name: RegexModelUpdateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Model object for updating a regular expression entity model. +constructor: + syntax: 'RegexModelUpdateObject(*, regex_pattern: str = None, name: str = None, + **kwargs)' + parameters: + - name: regex_pattern + description: The regular expression entity pattern. + isRequired: true + types: + - + - name: name + description: The model name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: regex_pattern + isRequired: true + - name: name + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.SubClosedList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.SubClosedList.yml new file mode 100644 index 00000000..84053432 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.SubClosedList.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedList +name: SubClosedList +fullName: azure.cognitiveservices.language.luis.authoring.models.SubClosedList +module: azure.cognitiveservices.language.luis.authoring.models +summary: Sublist of items for a list entity. +constructor: + syntax: 'SubClosedList(*, canonical_form: str = None, list=None, **kwargs)' + parameters: + - name: canonical_form + description: The standard form that the list represents. + isRequired: true + types: + - + - name: list + description: List of synonym words. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: canonical_form + isRequired: true + - name: list + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedList.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedList.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedList.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedList.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedList.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedList.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedList.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse.yml new file mode 100644 index 00000000..6a12a7a2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse +name: SubClosedListResponse +fullName: azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse +module: azure.cognitiveservices.language.luis.authoring.models +summary: Sublist of items for a list entity. +constructor: + syntax: 'SubClosedListResponse(*, canonical_form: str = None, list=None, id: int + = None, **kwargs)' + parameters: + - name: canonical_form + description: The standard form that the list represents. + isRequired: true + types: + - + - name: list + description: List of synonym words. + isRequired: true + types: + - [] + - name: id + description: The sublist ID + isRequired: true + types: + - + keywordOnlyParameters: + - name: canonical_form + isRequired: true + - name: list + isRequired: true + - name: id + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject.yml new file mode 100644 index 00000000..220313ed --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject +name: TaskUpdateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Object model for cloning an application's version. +constructor: + syntax: 'TaskUpdateObject(*, version: str = None, **kwargs)' + parameters: + - name: version + description: The new version for the cloned model. + isRequired: true + types: + - + keywordOnlyParameters: + - name: version + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.TrainingStatus.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.TrainingStatus.yml new file mode 100644 index 00000000..a43cc16f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.TrainingStatus.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.language.luis.authoring.models.TrainingStatus +name: TrainingStatus +fullName: azure.cognitiveservices.language.luis.authoring.models.TrainingStatus +module: azure.cognitiveservices.language.luis.authoring.models +fields: +- name: in_progress + uid: azure.cognitiveservices.language.luis.authoring.models.TrainingStatus.in_progress +- name: needs_training + uid: azure.cognitiveservices.language.luis.authoring.models.TrainingStatus.needs_training +- name: trained + uid: azure.cognitiveservices.language.luis.authoring.models.TrainingStatus.trained diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.UserAccessList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.UserAccessList.yml new file mode 100644 index 00000000..60780fed --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.UserAccessList.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.UserAccessList +name: UserAccessList +fullName: azure.cognitiveservices.language.luis.authoring.models.UserAccessList +module: azure.cognitiveservices.language.luis.authoring.models +summary: List of user permissions. +constructor: + syntax: 'UserAccessList(*, owner: str = None, emails=None, **kwargs)' + parameters: + - name: owner + description: The email address of owner of the application. + isRequired: true + types: + - + - name: emails + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: owner + isRequired: true + - name: emails + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.UserAccessList.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.UserAccessList.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.UserAccessList.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.UserAccessList.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.UserAccessList.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.UserAccessList.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.UserAccessList.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.UserCollaborator.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.UserCollaborator.yml new file mode 100644 index 00000000..09f599b0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.UserCollaborator.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.UserCollaborator +name: UserCollaborator +fullName: azure.cognitiveservices.language.luis.authoring.models.UserCollaborator +module: azure.cognitiveservices.language.luis.authoring.models +summary: UserCollaborator. +constructor: + syntax: 'UserCollaborator(*, email: str = None, **kwargs)' + parameters: + - name: email + description: The email address of the user. + isRequired: true + types: + - + keywordOnlyParameters: + - name: email + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.UserCollaborator.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.UserCollaborator.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.UserCollaborator.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.UserCollaborator.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.UserCollaborator.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.UserCollaborator.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.UserCollaborator.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.VersionInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.VersionInfo.yml new file mode 100644 index 00000000..ecbdc3f0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.VersionInfo.yml @@ -0,0 +1,211 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.VersionInfo +name: VersionInfo +fullName: azure.cognitiveservices.language.luis.authoring.models.VersionInfo +module: azure.cognitiveservices.language.luis.authoring.models +summary: 'Object model of an application version. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'VersionInfo(*, version: str, training_status, created_date_time=None, last_modified_date_time=None, + last_trained_date_time=None, last_published_date_time=None, endpoint_url: str + = None, assigned_endpoint_key=None, external_api_keys=None, intents_count: int + = None, entities_count: int = None, endpoint_hits_count: int = None, **kwargs)' + parameters: + - name: version + description: 'Required. The version ID. E.g.: "0.1"' + isRequired: true + types: + - + - name: created_date_time + description: The version's creation timestamp. + isRequired: true + types: + - + - name: last_modified_date_time + description: Timestamp of the last update. + isRequired: true + types: + - + - name: last_trained_date_time + description: 'Timestamp of the last time the model was + + trained.' + isRequired: true + types: + - + - name: last_published_date_time + description: Timestamp when was last published. + isRequired: true + types: + - + - name: endpoint_url + description: The Runtime endpoint URL for this model version. + isRequired: true + types: + - + - name: assigned_endpoint_key + description: The endpoint key. + isRequired: true + types: + - [, ] + - name: external_api_keys + description: External keys. + isRequired: true + types: + - + - name: intents_count + description: Number of intents in this model. + isRequired: true + types: + - + - name: entities_count + description: Number of entities in this model. + isRequired: true + types: + - + - name: endpoint_hits_count + description: Number of calls made to this endpoint. + isRequired: true + types: + - + - name: training_status + description: 'Required. The current training status. Possible + + values include: ''NeedsTraining'', ''InProgress'', ''Trained''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: version + isRequired: true + - name: training_status + isRequired: true + - name: created_date_time + isRequired: true + - name: last_modified_date_time + isRequired: true + - name: last_trained_date_time + isRequired: true + - name: last_published_date_time + isRequired: true + - name: endpoint_url + isRequired: true + - name: assigned_endpoint_key + isRequired: true + - name: external_api_keys + isRequired: true + - name: intents_count + isRequired: true + - name: entities_count + isRequired: true + - name: endpoint_hits_count + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.VersionInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.VersionInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.VersionInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.VersionInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.VersionInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.VersionInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.VersionInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject.yml new file mode 100644 index 00000000..48abccf3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject +name: WordListBaseUpdateObject +fullName: azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Object model for updating one of the list entity's sublists. +constructor: + syntax: 'WordListBaseUpdateObject(*, canonical_form: str = None, list=None, **kwargs)' + parameters: + - name: canonical_form + description: The standard form that the list represents. + isRequired: true + types: + - + - name: list + description: List of synonym words. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: canonical_form + isRequired: true + - name: list + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.WordListObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.WordListObject.yml new file mode 100644 index 00000000..de595c27 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.WordListObject.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.models.WordListObject +name: WordListObject +fullName: azure.cognitiveservices.language.luis.authoring.models.WordListObject +module: azure.cognitiveservices.language.luis.authoring.models +summary: Sublist of items for a list entity. +constructor: + syntax: 'WordListObject(*, canonical_form: str = None, list=None, **kwargs)' + parameters: + - name: canonical_form + description: The standard form that the list represents. + isRequired: true + types: + - + - name: list + description: List of synonym words. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: canonical_form + isRequired: true + - name: list + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.models.WordListObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.WordListObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.WordListObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.authoring.models.WordListObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.authoring.models.WordListObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.authoring.models.WordListObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.authoring.models.WordListObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.yml new file mode 100644 index 00000000..80d4f04c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.yml @@ -0,0 +1,118 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.language.luis.authoring.models +name: models +fullName: azure.cognitiveservices.language.luis.authoring.models +type: import +classes: +- azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject +- azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject +- azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse +- azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject +- azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject +- azure.cognitiveservices.language.luis.authoring.models.ApplicationSettings +- azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject +- azure.cognitiveservices.language.luis.authoring.models.AvailableCulture +- azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel +- azure.cognitiveservices.language.luis.authoring.models.AzureAccountInfoObject +- azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample +- azure.cognitiveservices.language.luis.authoring.models.ChildEntity +- azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject +- azure.cognitiveservices.language.luis.authoring.models.ClosedList +- azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor +- azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject +- azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject +- azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject +- azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray +- azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject +- azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor +- azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel +- azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel +- azure.cognitiveservices.language.luis.authoring.models.EndpointInfo +- azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse +- azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample +- azure.cognitiveservices.language.luis.authoring.models.EntityExtractor +- azure.cognitiveservices.language.luis.authoring.models.EntityLabel +- azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject +- azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject +- azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo +- azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject +- azure.cognitiveservices.language.luis.authoring.models.EntityPrediction +- azure.cognitiveservices.language.luis.authoring.models.EntityRole +- azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject +- azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject +- azure.cognitiveservices.language.luis.authoring.models.ErrorResponse +- azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject +- azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem +- azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject +- azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject +- azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject +- azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject +- azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity +- azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject +- azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor +- azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel +- azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2 +- azure.cognitiveservices.language.luis.authoring.models.IntentClassifier +- azure.cognitiveservices.language.luis.authoring.models.IntentPrediction +- azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample +- azure.cognitiveservices.language.luis.authoring.models.JSONEntity +- azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature +- azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature +- azure.cognitiveservices.language.luis.authoring.models.JSONUtterance +- azure.cognitiveservices.language.luis.authoring.models.JsonChild +- azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation +- azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse +- azure.cognitiveservices.language.luis.authoring.models.LabelTextObject +- azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance +- azure.cognitiveservices.language.luis.authoring.models.LuisApp +- azure.cognitiveservices.language.luis.authoring.models.LuisAppV2 +- azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject +- azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation +- azure.cognitiveservices.language.luis.authoring.models.ModelInfo +- azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse +- azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails +- azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo +- azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject +- azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor +- azure.cognitiveservices.language.luis.authoring.models.OperationError +- azure.cognitiveservices.language.luis.authoring.models.OperationStatus +- azure.cognitiveservices.language.luis.authoring.models.PatternAny +- azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor +- azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject +- azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject +- azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo +- azure.cognitiveservices.language.luis.authoring.models.PatternRule +- azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject +- azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo +- azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject +- azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse +- azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo +- azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject +- azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject +- azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain +- azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject +- azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject +- azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem +- azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject +- azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject +- azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity +- azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor +- azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo +- azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject +- azure.cognitiveservices.language.luis.authoring.models.PublishSettings +- azure.cognitiveservices.language.luis.authoring.models.RegexEntity +- azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor +- azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject +- azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject +- azure.cognitiveservices.language.luis.authoring.models.SubClosedList +- azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse +- azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject +- azure.cognitiveservices.language.luis.authoring.models.UserAccessList +- azure.cognitiveservices.language.luis.authoring.models.UserCollaborator +- azure.cognitiveservices.language.luis.authoring.models.VersionInfo +- azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject +- azure.cognitiveservices.language.luis.authoring.models.WordListObject +enums: +- azure.cognitiveservices.language.luis.authoring.models.OperationStatusType +- azure.cognitiveservices.language.luis.authoring.models.TrainingStatus diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.yml new file mode 100644 index 00000000..a8adc630 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.yml @@ -0,0 +1,996 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations +name: AppsOperations +fullName: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations +module: azure.cognitiveservices.language.luis.authoring.operations +summary: 'AppsOperations operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: AppsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.add + name: add + summary: Creates a new LUIS app. + signature: add(application_create_object, custom_headers=None, raw=False, **operation_config) + parameters: + - name: application_create_object + description: 'An application containing Name, + + Description (optional), Culture, Usage Scenario (optional), Domain + + (optional) and initial version ID (optional) of the application. + + Default value for the version ID is "0.1". Note: the culture cannot be + + changed after the app is created.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.add_custom_prebuilt_domain + name: add_custom_prebuilt_domain + summary: 'Adds a prebuilt domain along with its intent and entity models as a new + + application.' + signature: add_custom_prebuilt_domain(domain_name=None, culture=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: domain_name + description: The domain name. + defaultValue: None + types: + - + - name: culture + description: The culture of the new domain. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.delete + name: delete + summary: Deletes an application. + signature: delete(app_id, force=False, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: force + description: A flag to indicate whether to force an operation. + defaultValue: 'False' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.download_query_logs + name: download_query_logs + summary: Gets the logs of the past month's endpoint queries for the application. + signature: download_query_logs(app_id, custom_headers=None, raw=False, callback=None, + **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: object or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrest.exceptions.HttpOperationError +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.get + name: get + summary: Gets the application info. + signature: get(app_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ApplicationInfoResponse or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.get_publish_settings + name: get_publish_settings + summary: Get the application publish settings including 'UseAllTrainingData'. + signature: get_publish_settings(app_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: PublishSettings or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.get_settings + name: get_settings + summary: Get the application settings including 'UseAllTrainingData'. + signature: get_settings(app_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ApplicationSettings or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.import_lu_format + name: import_lu_format + summary: 'Imports an application to LUIS, the application''s structure is included + + in the request body.' + signature: import_lu_format(luis_app_lu, app_name=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: luis_app_lu + description: A LUIS application structure. + isRequired: true + types: + - + - name: app_name + description: 'The application name to create. If not specified, the + + application name will be read from the imported object. If the + + application name already exists, an error is returned.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.import_method + name: import_method + summary: 'Imports an application to LUIS, the application''s structure is included + + in the request body.' + signature: import_method(luis_app, app_name=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: luis_app + description: A LUIS application structure. + isRequired: true + types: + - + - name: app_name + description: 'The application name to create. If not specified, the + + application name will be read from the imported object. If the + + application name already exists, an error is returned.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.import_v2_app + name: import_v2_app + summary: 'Imports an application to LUIS, the application''s structure is included + + in the request body.' + signature: import_v2_app(luis_app_v2, app_name=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: luis_app_v2 + description: A LUIS application structure. + isRequired: true + types: + - + - name: app_name + description: 'The application name to create. If not specified, the + + application name will be read from the imported object. If the + + application name already exists, an error is returned.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.list + name: list + summary: Lists all of the user's applications. + signature: list(skip=0, take=100, custom_headers=None, raw=False, **operation_config) + parameters: + - name: skip + description: The number of entries to skip. Default value is 0. + defaultValue: '0' + types: + - + - name: take + description: 'The number of entries to return. Maximum page size is + + 500. Default is 100.' + defaultValue: '100' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.list_available_custom_prebuilt_domains + name: list_available_custom_prebuilt_domains + summary: Gets all the available custom prebuilt domains for all cultures. + signature: list_available_custom_prebuilt_domains(custom_headers=None, raw=False, + **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.list_available_custom_prebuilt_domains_for_culture + name: list_available_custom_prebuilt_domains_for_culture + summary: Gets all the available prebuilt domains for a specific culture. + signature: list_available_custom_prebuilt_domains_for_culture(culture, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: culture + description: Culture. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.list_cortana_endpoints + name: list_cortana_endpoints + summary: Gets the endpoint URLs for the prebuilt Cortana applications. + signature: list_cortana_endpoints(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: PersonalAssistantsResponse or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.list_domains + name: list_domains + summary: Gets the available application domains. + signature: list_domains(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.list_endpoints + name: list_endpoints + summary: Returns the available endpoint deployment regions and URLs. + signature: list_endpoints(app_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: dict or ClientRawResponse if raw=true + types: + - [, ] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.list_supported_cultures + name: list_supported_cultures + summary: 'Gets a list of supported cultures. Cultures are equivalent to the + + written language and locale. For example,"en-us" represents the U.S. + + variation of English.' + signature: list_supported_cultures(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.list_usage_scenarios + name: list_usage_scenarios + summary: Gets the application available usage scenarios. + signature: list_usage_scenarios(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.package_published_application_as_gzip + name: package_published_application_as_gzip + summary: 'package - Gets published LUIS application package in binary stream GZip + + format. + + + Packages a published LUIS application as a GZip file to be used in the + + LUIS container.' + signature: package_published_application_as_gzip(app_id, slot_name, custom_headers=None, + raw=False, callback=None, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: slot_name + description: The publishing slot name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: object or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.package_trained_application_as_gzip + name: package_trained_application_as_gzip + summary: 'package - Gets trained LUIS application package in binary stream GZip + + format. + + + Packages trained LUIS application as GZip file to be used in the LUIS + + container.' + signature: package_trained_application_as_gzip(app_id, version_id, custom_headers=None, + raw=False, callback=None, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: object or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.publish + name: publish + summary: Publishes a specific version of the application. + signature: publish(app_id, version_id=None, is_staging=False, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID to publish. + defaultValue: None + types: + - + - name: is_staging + description: 'Indicates if the staging slot should be used, + + instead of the Production one.' + defaultValue: 'False' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: 'ProductionOrStagingEndpointInfo or ClientRawResponse if + + raw=true' + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.update + name: update + summary: Updates the name or description of the application. + signature: update(app_id, name=None, description=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: name + description: The application's new name. + defaultValue: None + types: + - + - name: description + description: The application's new description. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.update_publish_settings + name: update_publish_settings + summary: 'Updates the application publish settings including + + ''UseAllTrainingData''.' + signature: update_publish_settings(app_id, publish_setting_update_object, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: publish_setting_update_object + description: 'An object containing the new + + publish application settings.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.update_settings + name: update_settings + summary: Updates the application settings including 'UseAllTrainingData'. + signature: update_settings(app_id, is_public=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: is_public + description: 'Setting your application as public allows other + + people to use your application''s endpoint using their own keys.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +attributes: +- uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.AzureAccountsOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.AzureAccountsOperations.yml new file mode 100644 index 00000000..c93c646d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.AzureAccountsOperations.yml @@ -0,0 +1,222 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.operations.AzureAccountsOperations +name: AzureAccountsOperations +fullName: azure.cognitiveservices.language.luis.authoring.operations.AzureAccountsOperations +module: azure.cognitiveservices.language.luis.authoring.operations +summary: 'AzureAccountsOperations operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: AzureAccountsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.operations.AzureAccountsOperations.assign_to_app + name: assign_to_app + summary: 'apps - Assign a LUIS Azure account to an application. + + + Assigns an Azure account to the application.' + signature: assign_to_app(app_id, arm_token=None, azure_account_info_object=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: arm_token + description: 'The custom arm token header to use; containing the + + user''s ARM token used to validate azure accounts information.' + defaultValue: None + types: + - + - name: azure_account_info_object + description: 'The Azure account information + + object.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AzureAccountsOperations.get_assigned + name: get_assigned + summary: 'apps - Get LUIS Azure accounts assigned to the application. + + + Gets the LUIS Azure accounts assigned to the application for the user + + using his ARM token.' + signature: get_assigned(app_id, arm_token=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: arm_token + description: 'The custom arm token header to use; containing the + + user''s ARM token used to validate azure accounts information.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AzureAccountsOperations.list_user_luis_accounts + name: list_user_luis_accounts + summary: 'user - Get LUIS Azure accounts. + + + Gets the LUIS Azure accounts for the user using his ARM token.' + signature: list_user_luis_accounts(arm_token=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: arm_token + description: 'The custom arm token header to use; containing the + + user''s ARM token used to validate azure accounts information.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.AzureAccountsOperations.remove_from_app + name: remove_from_app + summary: 'apps - Removes an assigned LUIS Azure account from an application. + + + Removes assigned Azure account from the application.' + signature: remove_from_app(app_id, arm_token=None, azure_account_info_object=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: arm_token + description: 'The custom arm token header to use; containing the + + user''s ARM token used to validate azure accounts information.' + defaultValue: None + types: + - + - name: azure_account_info_object + description: 'The Azure account information + + object.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +attributes: +- uid: azure.cognitiveservices.language.luis.authoring.operations.AzureAccountsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.ExamplesOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.ExamplesOperations.yml new file mode 100644 index 00000000..a54bd07c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.ExamplesOperations.yml @@ -0,0 +1,241 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.operations.ExamplesOperations +name: ExamplesOperations +fullName: azure.cognitiveservices.language.luis.authoring.operations.ExamplesOperations +module: azure.cognitiveservices.language.luis.authoring.operations +summary: 'ExamplesOperations operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: ExamplesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.operations.ExamplesOperations.add + name: add + summary: Adds a labeled example utterance in a version of the application. + signature: add(app_id, version_id, example_label_object, enable_nested_children=False, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: example_label_object + description: 'A labeled example utterance with the + + expected intent and entities.' + isRequired: true + types: + - + - name: enable_nested_children + description: Toggles nested/flat format + defaultValue: 'False' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: LabelExampleResponse or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ExamplesOperations.batch + name: batch + summary: 'Adds a batch of labeled example utterances to a version of the + + application.' + signature: batch(app_id, version_id, example_label_object_array, enable_nested_children=False, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: example_label_object_array + description: Array of example utterances. + isRequired: true + types: + - [] + - name: enable_nested_children + description: Toggles nested/flat format + defaultValue: 'False' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ExamplesOperations.delete + name: delete + summary: 'Deletes the labeled example utterances with the specified ID from a + + version of the application.' + signature: delete(app_id, version_id, example_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: example_id + description: The example ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ExamplesOperations.list + name: list + summary: 'Returns example utterances to be reviewed from a version of the + + application.' + signature: list(app_id, version_id, skip=0, take=100, enable_nested_children=False, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: skip + description: The number of entries to skip. Default value is 0. + defaultValue: '0' + types: + - + - name: take + description: 'The number of entries to return. Maximum page size is + + 500. Default is 100.' + defaultValue: '100' + types: + - + - name: enable_nested_children + description: Toggles nested/flat format + defaultValue: 'False' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +attributes: +- uid: azure.cognitiveservices.language.luis.authoring.operations.ExamplesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.FeaturesOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.FeaturesOperations.yml new file mode 100644 index 00000000..8018f7ba --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.FeaturesOperations.yml @@ -0,0 +1,442 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.operations.FeaturesOperations +name: FeaturesOperations +fullName: azure.cognitiveservices.language.luis.authoring.operations.FeaturesOperations +module: azure.cognitiveservices.language.luis.authoring.operations +summary: 'FeaturesOperations operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: FeaturesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.operations.FeaturesOperations.add_entity_feature + name: add_entity_feature + summary: 'Adds a new feature relation to be used by the entity in a version of + + the application.' + signature: add_entity_feature(app_id, version_id, entity_id, feature_relation_create_object, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity extractor ID. + isRequired: true + types: + - + - name: feature_relation_create_object + description: 'A Feature relation information + + object.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.FeaturesOperations.add_intent_feature + name: add_intent_feature + summary: 'Adds a new feature relation to be used by the intent in a version of + + the application.' + signature: add_intent_feature(app_id, version_id, intent_id, feature_relation_create_object, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: intent_id + description: The intent classifier ID. + isRequired: true + types: + - + - name: feature_relation_create_object + description: 'A Feature relation information + + object.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.FeaturesOperations.add_phrase_list + name: add_phrase_list + summary: Creates a new phraselist feature in a version of the application. + signature: add_phrase_list(app_id, version_id, phraselist_create_object, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: phraselist_create_object + description: 'A Phraselist object containing Name, + + comma-separated Phrases and the isExchangeable boolean. Default value + + for isExchangeable is true.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: int or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.FeaturesOperations.delete_phrase_list + name: delete_phrase_list + summary: Deletes a phraselist feature from a version of the application. + signature: delete_phrase_list(app_id, version_id, phraselist_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: phraselist_id + description: The ID of the feature to be deleted. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.FeaturesOperations.get_phrase_list + name: get_phrase_list + summary: Gets phraselist feature info in a version of the application. + signature: get_phrase_list(app_id, version_id, phraselist_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: phraselist_id + description: The ID of the feature to be retrieved. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: PhraseListFeatureInfo or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.FeaturesOperations.list + name: list + summary: 'Gets all the extraction phraselist and pattern features in a version of + + the application.' + signature: list(app_id, version_id, skip=0, take=100, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: skip + description: The number of entries to skip. Default value is 0. + defaultValue: '0' + types: + - + - name: take + description: 'The number of entries to return. Maximum page size is + + 500. Default is 100.' + defaultValue: '100' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: FeaturesResponseObject or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.FeaturesOperations.list_phrase_lists + name: list_phrase_lists + summary: Gets all the phraselist features in a version of the application. + signature: list_phrase_lists(app_id, version_id, skip=0, take=100, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: skip + description: The number of entries to skip. Default value is 0. + defaultValue: '0' + types: + - + - name: take + description: 'The number of entries to return. Maximum page size is + + 500. Default is 100.' + defaultValue: '100' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.FeaturesOperations.update_phrase_list + name: update_phrase_list + summary: 'Updates the phrases, the state and the name of the phraselist feature + + in a version of the application.' + signature: update_phrase_list(app_id, version_id, phraselist_id, phraselist_update_object=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: phraselist_id + description: The ID of the feature to be updated. + isRequired: true + types: + - + - name: phraselist_update_object + description: 'The new values for: - Just a boolean + + called IsActive, in which case the status of the feature will be + + changed. - Name, Pattern, Mode, and a boolean called IsActive to + + update the feature.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +attributes: +- uid: azure.cognitiveservices.language.luis.authoring.operations.FeaturesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.yml new file mode 100644 index 00000000..8c24d96d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.yml @@ -0,0 +1,5629 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations +name: ModelOperations +fullName: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations +module: azure.cognitiveservices.language.luis.authoring.operations +summary: 'ModelOperations operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: ModelOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.add_closed_list + name: add_closed_list + summary: Adds a list entity model to a version of the application. + signature: add_closed_list(app_id, version_id, sub_lists=None, name=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: sub_lists + description: Sublists for the feature. + defaultValue: None + types: + - [] + - name: name + description: Name of the list entity. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.add_composite_entity_child + name: add_composite_entity_child + summary: 'Creates a single child in an existing composite entity model in a + + version of the application.' + signature: add_composite_entity_child(app_id, version_id, c_entity_id, name=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: c_entity_id + description: The composite entity extractor ID. + isRequired: true + types: + - + - name: name + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.add_custom_prebuilt_domain + name: add_custom_prebuilt_domain + summary: 'Adds a customizable prebuilt domain along with all of its intent and + + entity models in a version of the application.' + signature: add_custom_prebuilt_domain(app_id, version_id, domain_name=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: domain_name + description: The domain name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.add_custom_prebuilt_entity + name: add_custom_prebuilt_entity + summary: Adds a prebuilt entity model to a version of the application. + signature: add_custom_prebuilt_entity(app_id, version_id, domain_name=None, model_name=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: domain_name + description: The domain name. + defaultValue: None + types: + - + - name: model_name + description: The intent name or entity name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.add_custom_prebuilt_intent + name: add_custom_prebuilt_intent + summary: 'Adds a customizable prebuilt intent model to a version of the + + application.' + signature: add_custom_prebuilt_intent(app_id, version_id, domain_name=None, model_name=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: domain_name + description: The domain name. + defaultValue: None + types: + - + - name: model_name + description: The intent name or entity name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.add_entity + name: add_entity + summary: Adds an entity extractor to a version of the application. + signature: add_entity(app_id, version_id, children=None, name=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: children + description: Child entities. + defaultValue: None + types: + - [] + - name: name + description: Entity name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.add_entity_child + name: add_entity_child + summary: 'Creates a single child in an existing entity model hierarchy in a + + version of the application.' + signature: add_entity_child(app_id, version_id, entity_id, child_entity_model_create_object, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity extractor ID. + isRequired: true + types: + - + - name: child_entity_model_create_object + description: 'A model object containing the + + name of the new child model and its children.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.add_explicit_list_item + name: add_explicit_list_item + summary: 'Add a new exception to the explicit list for the Pattern.Any entity in + + a version of the application.' + signature: add_explicit_list_item(app_id, version_id, entity_id, explicit_list_item=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The Pattern.Any entity extractor ID. + isRequired: true + types: + - + - name: explicit_list_item + description: The explicit list item. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: int or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.add_intent + name: add_intent + summary: Adds an intent to a version of the application. + signature: add_intent(app_id, version_id, name=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: name + description: Name of the new entity extractor. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.add_prebuilt + name: add_prebuilt + summary: Adds a list of prebuilt entities to a version of the application. + signature: add_prebuilt(app_id, version_id, prebuilt_extractor_names, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: prebuilt_extractor_names + description: 'An array of prebuilt entity extractor + + names.' + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.add_sub_list + name: add_sub_list + summary: 'Adds a sublist to an existing list entity in a version of the + + application.' + signature: add_sub_list(app_id, version_id, cl_entity_id, canonical_form=None, list=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: cl_entity_id + description: The list entity extractor ID. + isRequired: true + types: + - + - name: canonical_form + description: The standard form that the list represents. + defaultValue: None + types: + - + - name: list + description: List of synonym words. + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: long or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.create_closed_list_entity_role + name: create_closed_list_entity_role + summary: Create a role for a list entity in a version of the application. + signature: create_closed_list_entity_role(app_id, version_id, entity_id, name=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity model ID. + isRequired: true + types: + - + - name: name + description: The entity role name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.create_composite_entity_role + name: create_composite_entity_role + summary: Create a role for a composite entity in a version of the application. + signature: create_composite_entity_role(app_id, version_id, c_entity_id, name=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: c_entity_id + description: The composite entity extractor ID. + isRequired: true + types: + - + - name: name + description: The entity role name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.create_custom_prebuilt_entity_role + name: create_custom_prebuilt_entity_role + summary: Create a role for a prebuilt entity in a version of the application. + signature: create_custom_prebuilt_entity_role(app_id, version_id, entity_id, name=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity model ID. + isRequired: true + types: + - + - name: name + description: The entity role name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.create_entity_role + name: create_entity_role + summary: Create an entity role in a version of the application. + signature: create_entity_role(app_id, version_id, entity_id, name=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity model ID. + isRequired: true + types: + - + - name: name + description: The entity role name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.create_hierarchical_entity_role + name: create_hierarchical_entity_role + summary: 'Create a role for an hierarchical entity in a version of the + + application.' + signature: create_hierarchical_entity_role(app_id, version_id, h_entity_id, name=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: h_entity_id + description: The hierarchical entity extractor ID. + isRequired: true + types: + - + - name: name + description: The entity role name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.create_pattern_any_entity_model + name: create_pattern_any_entity_model + summary: Adds a pattern.any entity extractor to a version of the application. + signature: create_pattern_any_entity_model(app_id, version_id, name=None, explicit_list=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: name + description: The model name. + defaultValue: None + types: + - + - name: explicit_list + description: The Pattern.Any explicit list. + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.create_pattern_any_entity_role + name: create_pattern_any_entity_role + summary: 'Create a role for an Pattern.any entity in a version of the + + application.' + signature: create_pattern_any_entity_role(app_id, version_id, entity_id, name=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity model ID. + isRequired: true + types: + - + - name: name + description: The entity role name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.create_prebuilt_entity_role + name: create_prebuilt_entity_role + summary: Create a role for a prebuilt entity in a version of the application. + signature: create_prebuilt_entity_role(app_id, version_id, entity_id, name=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity model ID. + isRequired: true + types: + - + - name: name + description: The entity role name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.create_regex_entity_model + name: create_regex_entity_model + summary: Adds a regular expression entity model to a version of the application. + signature: create_regex_entity_model(app_id, version_id, regex_pattern=None, name=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: regex_pattern + description: The regular expression entity pattern. + defaultValue: None + types: + - + - name: name + description: The model name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.create_regex_entity_role + name: create_regex_entity_role + summary: 'Create a role for an regular expression entity in a version of the + + application.' + signature: create_regex_entity_role(app_id, version_id, entity_id, name=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity model ID. + isRequired: true + types: + - + - name: name + description: The entity role name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.delete_closed_list + name: delete_closed_list + summary: Deletes a list entity model from a version of the application. + signature: delete_closed_list(app_id, version_id, cl_entity_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: cl_entity_id + description: The list entity model ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.delete_closed_list_entity_role + name: delete_closed_list_entity_role + summary: Delete a role for a given list entity in a version of the application. + signature: delete_closed_list_entity_role(app_id, version_id, entity_id, role_id, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity ID. + isRequired: true + types: + - + - name: role_id + description: The entity role Id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.delete_composite_entity + name: delete_composite_entity + summary: Deletes a composite entity from a version of the application. + signature: delete_composite_entity(app_id, version_id, c_entity_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: c_entity_id + description: The composite entity extractor ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.delete_composite_entity_child + name: delete_composite_entity_child + summary: 'Deletes a composite entity extractor child from a version of the + + application.' + signature: delete_composite_entity_child(app_id, version_id, c_entity_id, c_child_id, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: c_entity_id + description: The composite entity extractor ID. + isRequired: true + types: + - + - name: c_child_id + description: The hierarchical entity extractor child ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.delete_composite_entity_role + name: delete_composite_entity_role + summary: 'Delete a role for a given composite entity in a version of the + + application.' + signature: delete_composite_entity_role(app_id, version_id, c_entity_id, role_id, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: c_entity_id + description: The composite entity extractor ID. + isRequired: true + types: + - + - name: role_id + description: The entity role Id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.delete_custom_entity_role + name: delete_custom_entity_role + summary: 'Delete a role for a given prebuilt entity in a version of the + + application.' + signature: delete_custom_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity ID. + isRequired: true + types: + - + - name: role_id + description: The entity role Id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.delete_custom_prebuilt_domain + name: delete_custom_prebuilt_domain + summary: Deletes a prebuilt domain's models in a version of the application. + signature: delete_custom_prebuilt_domain(app_id, version_id, domain_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: domain_name + description: Domain name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.delete_entity + name: delete_entity + summary: Deletes an entity or a child from a version of the application. + signature: delete_entity(app_id, version_id, entity_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: 'The entity extractor or the child entity extractor + + ID.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.delete_entity_feature + name: delete_entity_feature + summary: 'Deletes a relation from the feature relations used by the entity in a + + version of the application.' + signature: delete_entity_feature(app_id, version_id, entity_id, feature_relation_delete_object, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity extractor ID. + isRequired: true + types: + - + - name: feature_relation_delete_object + description: 'A feature information object + + containing the feature relation to delete.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.delete_entity_role + name: delete_entity_role + summary: Delete an entity role in a version of the application. + signature: delete_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity ID. + isRequired: true + types: + - + - name: role_id + description: The entity role Id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.delete_explicit_list_item + name: delete_explicit_list_item + summary: 'Delete an item from the explicit (exception) list for a Pattern.any + + entity in a version of the application.' + signature: delete_explicit_list_item(app_id, version_id, entity_id, item_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The pattern.any entity id. + isRequired: true + types: + - + - name: item_id + description: The explicit list item which will be deleted. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.delete_hierarchical_entity + name: delete_hierarchical_entity + summary: Deletes a hierarchical entity from a version of the application. + signature: delete_hierarchical_entity(app_id, version_id, h_entity_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: h_entity_id + description: The hierarchical entity extractor ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.delete_hierarchical_entity_child + name: delete_hierarchical_entity_child + summary: 'Deletes a hierarchical entity extractor child in a version of the + + application.' + signature: delete_hierarchical_entity_child(app_id, version_id, h_entity_id, h_child_id, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: h_entity_id + description: The hierarchical entity extractor ID. + isRequired: true + types: + - + - name: h_child_id + description: The hierarchical entity extractor child ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.delete_hierarchical_entity_role + name: delete_hierarchical_entity_role + summary: 'Delete a role for a given hierarchical role in a version of the + + application.' + signature: delete_hierarchical_entity_role(app_id, version_id, h_entity_id, role_id, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: h_entity_id + description: The hierarchical entity extractor ID. + isRequired: true + types: + - + - name: role_id + description: The entity role Id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.delete_intent + name: delete_intent + summary: Deletes an intent from a version of the application. + signature: delete_intent(app_id, version_id, intent_id, delete_utterances=False, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: intent_id + description: The intent classifier ID. + isRequired: true + types: + - + - name: delete_utterances + description: 'If true, deletes the intent''s example + + utterances. If false, moves the example utterances to the None intent. + + The default value is false.' + defaultValue: 'False' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.delete_intent_feature + name: delete_intent_feature + summary: 'Deletes a relation from the feature relations used by the intent in a + + version of the application.' + signature: delete_intent_feature(app_id, version_id, intent_id, feature_relation_delete_object, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: intent_id + description: The intent classifier ID. + isRequired: true + types: + - + - name: feature_relation_delete_object + description: 'A feature information object + + containing the feature relation to delete.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.delete_pattern_any_entity_model + name: delete_pattern_any_entity_model + summary: 'Deletes a Pattern.Any entity extractor from a version of the + + application.' + signature: delete_pattern_any_entity_model(app_id, version_id, entity_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The Pattern.Any entity extractor ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.delete_pattern_any_entity_role + name: delete_pattern_any_entity_role + summary: 'Delete a role for a given Pattern.any entity in a version of the + + application.' + signature: delete_pattern_any_entity_role(app_id, version_id, entity_id, role_id, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity ID. + isRequired: true + types: + - + - name: role_id + description: The entity role Id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.delete_prebuilt + name: delete_prebuilt + summary: Deletes a prebuilt entity extractor from a version of the application. + signature: delete_prebuilt(app_id, version_id, prebuilt_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: prebuilt_id + description: The prebuilt entity extractor ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.delete_prebuilt_entity_role + name: delete_prebuilt_entity_role + summary: Delete a role in a prebuilt entity in a version of the application. + signature: delete_prebuilt_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity ID. + isRequired: true + types: + - + - name: role_id + description: The entity role Id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.delete_regex_entity_model + name: delete_regex_entity_model + summary: Deletes a regular expression entity from a version of the application. + signature: delete_regex_entity_model(app_id, version_id, regex_entity_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: regex_entity_id + description: The regular expression entity extractor ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.delete_regex_entity_role + name: delete_regex_entity_role + summary: 'Delete a role for a given regular expression in a version of the + + application.' + signature: delete_regex_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity ID. + isRequired: true + types: + - + - name: role_id + description: The entity role Id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.delete_sub_list + name: delete_sub_list + summary: 'Deletes a sublist of a specific list entity model from a version of the + + application.' + signature: delete_sub_list(app_id, version_id, cl_entity_id, sub_list_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: cl_entity_id + description: The list entity extractor ID. + isRequired: true + types: + - + - name: sub_list_id + description: The sublist ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.examples_method + name: examples_method + summary: 'Gets the example utterances for the given intent or entity model in a + + version of the application.' + signature: examples_method(app_id, version_id, model_id, skip=0, take=100, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: model_id + description: The ID (GUID) of the model. + isRequired: true + types: + - + - name: skip + description: The number of entries to skip. Default value is 0. + defaultValue: '0' + types: + - + - name: take + description: 'The number of entries to return. Maximum page size is + + 500. Default is 100.' + defaultValue: '100' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.get_closed_list + name: get_closed_list + summary: Gets information about a list entity in a version of the application. + signature: get_closed_list(app_id, version_id, cl_entity_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: cl_entity_id + description: The list model ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ClosedListEntityExtractor or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.get_closed_list_entity_role + name: get_closed_list_entity_role + summary: Get one role for a given list entity in a version of the application. + signature: get_closed_list_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: entity ID. + isRequired: true + types: + - + - name: role_id + description: entity role ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: EntityRole or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.get_composite_entity + name: get_composite_entity + summary: 'Gets information about a composite entity in a version of the + + application.' + signature: get_composite_entity(app_id, version_id, c_entity_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: c_entity_id + description: The composite entity extractor ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CompositeEntityExtractor or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.get_composite_entity_role + name: get_composite_entity_role + summary: 'Get one role for a given composite entity in a version of the + + application.' + signature: get_composite_entity_role(app_id, version_id, c_entity_id, role_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: c_entity_id + description: The composite entity extractor ID. + isRequired: true + types: + - + - name: role_id + description: entity role ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: EntityRole or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.get_custom_entity_role + name: get_custom_entity_role + summary: 'Get one role for a given prebuilt entity in a version of the + + application.' + signature: get_custom_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: entity ID. + isRequired: true + types: + - + - name: role_id + description: entity role ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: EntityRole or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.get_entity + name: get_entity + summary: Gets information about an entity model in a version of the application. + signature: get_entity(app_id, version_id, entity_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity extractor ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: NDepthEntityExtractor or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.get_entity_features + name: get_entity_features + summary: 'Gets the information of the features used by the entity in a version of + + the application.' + signature: get_entity_features(app_id, version_id, entity_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity extractor ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.get_entity_role + name: get_entity_role + summary: Get one role for a given entity in a version of the application. + signature: get_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: entity ID. + isRequired: true + types: + - + - name: role_id + description: entity role ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: EntityRole or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.get_explicit_list + name: get_explicit_list + summary: 'Get the explicit (exception) list of the pattern.any entity in a + + version of the application.' + signature: get_explicit_list(app_id, version_id, entity_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The Pattern.Any entity id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.get_explicit_list_item + name: get_explicit_list_item + summary: 'Get the explicit (exception) list of the pattern.any entity in a + + version of the application.' + signature: get_explicit_list_item(app_id, version_id, entity_id, item_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The Pattern.Any entity Id. + isRequired: true + types: + - + - name: item_id + description: The explicit list item Id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ExplicitListItem or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.get_hierarchical_entity + name: get_hierarchical_entity + summary: 'Gets information about a hierarchical entity in a version of the + + application.' + signature: get_hierarchical_entity(app_id, version_id, h_entity_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: h_entity_id + description: The hierarchical entity extractor ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: HierarchicalEntityExtractor or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.get_hierarchical_entity_child + name: get_hierarchical_entity_child + summary: 'Gets information about the child''s model contained in an hierarchical + + entity child model in a version of the application.' + signature: get_hierarchical_entity_child(app_id, version_id, h_entity_id, h_child_id, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: h_entity_id + description: The hierarchical entity extractor ID. + isRequired: true + types: + - + - name: h_child_id + description: The hierarchical entity extractor child ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: HierarchicalChildEntity or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.get_hierarchical_entity_role + name: get_hierarchical_entity_role + summary: 'Get one role for a given hierarchical entity in a version of the + + application.' + signature: get_hierarchical_entity_role(app_id, version_id, h_entity_id, role_id, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: h_entity_id + description: The hierarchical entity extractor ID. + isRequired: true + types: + - + - name: role_id + description: entity role ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: EntityRole or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.get_intent + name: get_intent + summary: 'Gets information about the intent model in a version of the + + application.' + signature: get_intent(app_id, version_id, intent_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: intent_id + description: The intent classifier ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: IntentClassifier or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.get_intent_features + name: get_intent_features + summary: 'Gets the information of the features used by the intent in a version of + + the application.' + signature: get_intent_features(app_id, version_id, intent_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: intent_id + description: The intent classifier ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.get_pattern_any_entity_info + name: get_pattern_any_entity_info + summary: 'Gets information about the Pattern.Any model in a version of the + + application.' + signature: get_pattern_any_entity_info(app_id, version_id, entity_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity extractor ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: PatternAnyEntityExtractor or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.get_pattern_any_entity_role + name: get_pattern_any_entity_role + summary: 'Get one role for a given Pattern.any entity in a version of the + + application.' + signature: get_pattern_any_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: entity ID. + isRequired: true + types: + - + - name: role_id + description: entity role ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: EntityRole or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.get_prebuilt + name: get_prebuilt + summary: 'Gets information about a prebuilt entity model in a version of the + + application.' + signature: get_prebuilt(app_id, version_id, prebuilt_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: prebuilt_id + description: The prebuilt entity extractor ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: PrebuiltEntityExtractor or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.get_prebuilt_entity_role + name: get_prebuilt_entity_role + summary: 'Get one role for a given prebuilt entity in a version of the + + application.' + signature: get_prebuilt_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: entity ID. + isRequired: true + types: + - + - name: role_id + description: entity role ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: EntityRole or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.get_regex_entity_entity_info + name: get_regex_entity_entity_info + summary: 'Gets information about a regular expression entity in a version of the + + application.' + signature: get_regex_entity_entity_info(app_id, version_id, regex_entity_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: regex_entity_id + description: The regular expression entity model ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: RegexEntityExtractor or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.get_regex_entity_role + name: get_regex_entity_role + summary: 'Get one role for a given regular expression entity in a version of the + + application.' + signature: get_regex_entity_role(app_id, version_id, entity_id, role_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: entity ID. + isRequired: true + types: + - + - name: role_id + description: entity role ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: EntityRole or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.list_closed_list_entity_roles + name: list_closed_list_entity_roles + summary: Get all roles for a list entity in a version of the application. + signature: list_closed_list_entity_roles(app_id, version_id, entity_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: entity Id + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.list_closed_lists + name: list_closed_lists + summary: 'Gets information about all the list entity models in a version of the + + application.' + signature: list_closed_lists(app_id, version_id, skip=0, take=100, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: skip + description: The number of entries to skip. Default value is 0. + defaultValue: '0' + types: + - + - name: take + description: 'The number of entries to return. Maximum page size is + + 500. Default is 100.' + defaultValue: '100' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.list_composite_entities + name: list_composite_entities + summary: 'Gets information about all the composite entity models in a version of + + the application.' + signature: list_composite_entities(app_id, version_id, skip=0, take=100, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: skip + description: The number of entries to skip. Default value is 0. + defaultValue: '0' + types: + - + - name: take + description: 'The number of entries to return. Maximum page size is + + 500. Default is 100.' + defaultValue: '100' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.list_composite_entity_roles + name: list_composite_entity_roles + summary: Get all roles for a composite entity in a version of the application. + signature: list_composite_entity_roles(app_id, version_id, c_entity_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: c_entity_id + description: The composite entity extractor ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.list_custom_prebuilt_entities + name: list_custom_prebuilt_entities + summary: Gets all prebuilt entities used in a version of the application. + signature: list_custom_prebuilt_entities(app_id, version_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.list_custom_prebuilt_entity_roles + name: list_custom_prebuilt_entity_roles + summary: Get all roles for a prebuilt entity in a version of the application. + signature: list_custom_prebuilt_entity_roles(app_id, version_id, entity_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: entity Id + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.list_custom_prebuilt_intents + name: list_custom_prebuilt_intents + summary: 'Gets information about customizable prebuilt intents added to a version + + of the application.' + signature: list_custom_prebuilt_intents(app_id, version_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.list_custom_prebuilt_models + name: list_custom_prebuilt_models + summary: 'Gets all prebuilt intent and entity model information used in a version + + of this application.' + signature: list_custom_prebuilt_models(app_id, version_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.list_entities + name: list_entities + summary: 'Gets information about all the simple entity models in a version of the + + application.' + signature: list_entities(app_id, version_id, skip=0, take=100, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: skip + description: The number of entries to skip. Default value is 0. + defaultValue: '0' + types: + - + - name: take + description: 'The number of entries to return. Maximum page size is + + 500. Default is 100.' + defaultValue: '100' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.list_entity_roles + name: list_entity_roles + summary: Get all roles for an entity in a version of the application. + signature: list_entity_roles(app_id, version_id, entity_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: entity Id + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.list_entity_suggestions + name: list_entity_suggestions + summary: 'Get suggested example utterances that would improve the accuracy of the + + entity model in a version of the application.' + signature: list_entity_suggestions(app_id, version_id, entity_id, take=100, enable_nested_children=False, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The target entity extractor model to enhance. + isRequired: true + types: + - + - name: take + description: 'The number of entries to return. Maximum page size is + + 500. Default is 100.' + defaultValue: '100' + types: + - + - name: enable_nested_children + description: Toggles nested/flat format + defaultValue: 'False' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.list_hierarchical_entities + name: list_hierarchical_entities + summary: 'Gets information about all the hierarchical entity models in a version + + of the application.' + signature: list_hierarchical_entities(app_id, version_id, skip=0, take=100, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: skip + description: The number of entries to skip. Default value is 0. + defaultValue: '0' + types: + - + - name: take + description: 'The number of entries to return. Maximum page size is + + 500. Default is 100.' + defaultValue: '100' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.list_hierarchical_entity_roles + name: list_hierarchical_entity_roles + summary: 'Get all roles for a hierarchical entity in a version of the + + application.' + signature: list_hierarchical_entity_roles(app_id, version_id, h_entity_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: h_entity_id + description: The hierarchical entity extractor ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.list_intent_suggestions + name: list_intent_suggestions + summary: 'Suggests example utterances that would improve the accuracy of the + + intent model in a version of the application.' + signature: list_intent_suggestions(app_id, version_id, intent_id, take=100, enable_nested_children=False, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: intent_id + description: The intent classifier ID. + isRequired: true + types: + - + - name: take + description: 'The number of entries to return. Maximum page size is + + 500. Default is 100.' + defaultValue: '100' + types: + - + - name: enable_nested_children + description: Toggles nested/flat format + defaultValue: 'False' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.list_intents + name: list_intents + summary: 'Gets information about the intent models in a version of the + + application.' + signature: list_intents(app_id, version_id, skip=0, take=100, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: skip + description: The number of entries to skip. Default value is 0. + defaultValue: '0' + types: + - + - name: take + description: 'The number of entries to return. Maximum page size is + + 500. Default is 100.' + defaultValue: '100' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.list_models + name: list_models + summary: 'Gets information about all the intent and entity models in a version of + + the application.' + signature: list_models(app_id, version_id, skip=0, take=100, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: skip + description: The number of entries to skip. Default value is 0. + defaultValue: '0' + types: + - + - name: take + description: 'The number of entries to return. Maximum page size is + + 500. Default is 100.' + defaultValue: '100' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.list_pattern_any_entity_infos + name: list_pattern_any_entity_infos + summary: 'Get information about the Pattern.Any entity models in a version of the + + application.' + signature: list_pattern_any_entity_infos(app_id, version_id, skip=0, take=100, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: skip + description: The number of entries to skip. Default value is 0. + defaultValue: '0' + types: + - + - name: take + description: 'The number of entries to return. Maximum page size is + + 500. Default is 100.' + defaultValue: '100' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.list_pattern_any_entity_roles + name: list_pattern_any_entity_roles + summary: Get all roles for a Pattern.any entity in a version of the application. + signature: list_pattern_any_entity_roles(app_id, version_id, entity_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: entity Id + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.list_prebuilt_entities + name: list_prebuilt_entities + summary: 'Gets all the available prebuilt entities in a version of the + + application.' + signature: list_prebuilt_entities(app_id, version_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.list_prebuilt_entity_roles + name: list_prebuilt_entity_roles + summary: Get a prebuilt entity's roles in a version of the application. + signature: list_prebuilt_entity_roles(app_id, version_id, entity_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: entity Id + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.list_prebuilts + name: list_prebuilts + summary: 'Gets information about all the prebuilt entities in a version of the + + application.' + signature: list_prebuilts(app_id, version_id, skip=0, take=100, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: skip + description: The number of entries to skip. Default value is 0. + defaultValue: '0' + types: + - + - name: take + description: 'The number of entries to return. Maximum page size is + + 500. Default is 100.' + defaultValue: '100' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.list_regex_entity_infos + name: list_regex_entity_infos + summary: 'Gets information about the regular expression entity models in a + + version of the application.' + signature: list_regex_entity_infos(app_id, version_id, skip=0, take=100, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: skip + description: The number of entries to skip. Default value is 0. + defaultValue: '0' + types: + - + - name: take + description: 'The number of entries to return. Maximum page size is + + 500. Default is 100.' + defaultValue: '100' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.list_regex_entity_roles + name: list_regex_entity_roles + summary: 'Get all roles for a regular expression entity in a version of the + + application.' + signature: list_regex_entity_roles(app_id, version_id, entity_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: entity Id + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.patch_closed_list + name: patch_closed_list + summary: 'Adds a batch of sublists to an existing list entity in a version of the + + application.' + signature: patch_closed_list(app_id, version_id, cl_entity_id, sub_lists=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: cl_entity_id + description: The list entity model ID. + isRequired: true + types: + - + - name: sub_lists + description: Sublists to add. + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.replace_entity_features + name: replace_entity_features + summary: 'Updates the information of the features used by the entity in a version + + of the application.' + signature: replace_entity_features(app_id, version_id, entity_id, feature_relations_update_object, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity extractor ID. + isRequired: true + types: + - + - name: feature_relations_update_object + description: 'A list of feature information + + objects containing the new feature relations.' + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.replace_intent_features + name: replace_intent_features + summary: 'Updates the information of the features used by the intent in a version + + of the application.' + signature: replace_intent_features(app_id, version_id, intent_id, feature_relations_update_object, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: intent_id + description: The intent classifier ID. + isRequired: true + types: + - + - name: feature_relations_update_object + description: 'A list of feature information + + objects containing the new feature relations.' + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.update_closed_list + name: update_closed_list + summary: Updates the list entity in a version of the application. + signature: update_closed_list(app_id, version_id, cl_entity_id, sub_lists=None, + name=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: cl_entity_id + description: The list model ID. + isRequired: true + types: + - + - name: sub_lists + description: The new sublists for the feature. + defaultValue: None + types: + - [] + - name: name + description: The new name of the list entity. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.update_closed_list_entity_role + name: update_closed_list_entity_role + summary: Update a role for a given list entity in a version of the application. + signature: update_closed_list_entity_role(app_id, version_id, entity_id, role_id, + name=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity ID. + isRequired: true + types: + - + - name: role_id + description: The entity role ID. + isRequired: true + types: + - + - name: name + description: The entity role name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.update_composite_entity + name: update_composite_entity + summary: Updates a composite entity in a version of the application. + signature: update_composite_entity(app_id, version_id, c_entity_id, children=None, + name=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: c_entity_id + description: The composite entity extractor ID. + isRequired: true + types: + - + - name: children + description: Child entities. + defaultValue: None + types: + - [] + - name: name + description: Entity name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.update_composite_entity_role + name: update_composite_entity_role + summary: 'Update a role for a given composite entity in a version of the + + application.' + signature: update_composite_entity_role(app_id, version_id, c_entity_id, role_id, + name=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: c_entity_id + description: The composite entity extractor ID. + isRequired: true + types: + - + - name: role_id + description: The entity role ID. + isRequired: true + types: + - + - name: name + description: The entity role name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.update_custom_prebuilt_entity_role + name: update_custom_prebuilt_entity_role + summary: 'Update a role for a given prebuilt entity in a version of the + + application.' + signature: update_custom_prebuilt_entity_role(app_id, version_id, entity_id, role_id, + name=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity ID. + isRequired: true + types: + - + - name: role_id + description: The entity role ID. + isRequired: true + types: + - + - name: name + description: The entity role name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.update_entity_child + name: update_entity_child + summary: 'Updates the name of an entity extractor or the name and instanceOf + + model of a child entity extractor.' + signature: update_entity_child(app_id, version_id, entity_id, name=None, instance_of=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: 'The entity extractor or the child entity extractor + + ID.' + isRequired: true + types: + - + - name: name + description: Entity name. + defaultValue: None + types: + - + - name: instance_of + description: The instance of model name + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.update_entity_role + name: update_entity_role + summary: Update a role for a given entity in a version of the application. + signature: update_entity_role(app_id, version_id, entity_id, role_id, name=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity ID. + isRequired: true + types: + - + - name: role_id + description: The entity role ID. + isRequired: true + types: + - + - name: name + description: The entity role name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.update_explicit_list_item + name: update_explicit_list_item + summary: 'Updates an explicit (exception) list item for a Pattern.Any entity in + a + + version of the application.' + signature: update_explicit_list_item(app_id, version_id, entity_id, item_id, explicit_list_item=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The Pattern.Any entity extractor ID. + isRequired: true + types: + - + - name: item_id + description: The explicit list item ID. + isRequired: true + types: + - + - name: explicit_list_item + description: The explicit list item. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.update_hierarchical_entity + name: update_hierarchical_entity + summary: 'Updates the name of a hierarchical entity model in a version of the + + application.' + signature: update_hierarchical_entity(app_id, version_id, h_entity_id, name=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: h_entity_id + description: The hierarchical entity extractor ID. + isRequired: true + types: + - + - name: name + description: The entity's new name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.update_hierarchical_entity_child + name: update_hierarchical_entity_child + summary: 'Renames a single child in an existing hierarchical entity model in a + + version of the application.' + signature: update_hierarchical_entity_child(app_id, version_id, h_entity_id, h_child_id, + name=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: h_entity_id + description: The hierarchical entity extractor ID. + isRequired: true + types: + - + - name: h_child_id + description: The hierarchical entity extractor child ID. + isRequired: true + types: + - + - name: name + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.update_hierarchical_entity_role + name: update_hierarchical_entity_role + summary: 'Update a role for a given hierarchical entity in a version of the + + application.' + signature: update_hierarchical_entity_role(app_id, version_id, h_entity_id, role_id, + name=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: h_entity_id + description: The hierarchical entity extractor ID. + isRequired: true + types: + - + - name: role_id + description: The entity role ID. + isRequired: true + types: + - + - name: name + description: The entity role name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.update_intent + name: update_intent + summary: Updates the name of an intent in a version of the application. + signature: update_intent(app_id, version_id, intent_id, name=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: intent_id + description: The intent classifier ID. + isRequired: true + types: + - + - name: name + description: The entity's new name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.update_pattern_any_entity_model + name: update_pattern_any_entity_model + summary: 'Updates the name and explicit (exception) list of a Pattern.Any entity + + model in a version of the application.' + signature: update_pattern_any_entity_model(app_id, version_id, entity_id, name=None, + explicit_list=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The Pattern.Any entity extractor ID. + isRequired: true + types: + - + - name: name + description: The model name. + defaultValue: None + types: + - + - name: explicit_list + description: The Pattern.Any explicit list. + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.update_pattern_any_entity_role + name: update_pattern_any_entity_role + summary: 'Update a role for a given Pattern.any entity in a version of the + + application.' + signature: update_pattern_any_entity_role(app_id, version_id, entity_id, role_id, + name=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity ID. + isRequired: true + types: + - + - name: role_id + description: The entity role ID. + isRequired: true + types: + - + - name: name + description: The entity role name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.update_prebuilt_entity_role + name: update_prebuilt_entity_role + summary: 'Update a role for a given prebuilt entity in a version of the + + application.' + signature: update_prebuilt_entity_role(app_id, version_id, entity_id, role_id, name=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity ID. + isRequired: true + types: + - + - name: role_id + description: The entity role ID. + isRequired: true + types: + - + - name: name + description: The entity role name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.update_regex_entity_model + name: update_regex_entity_model + summary: Updates the regular expression entity in a version of the application. + signature: update_regex_entity_model(app_id, version_id, regex_entity_id, regex_pattern=None, + name=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: regex_entity_id + description: The regular expression entity extractor ID. + isRequired: true + types: + - + - name: regex_pattern + description: The regular expression entity pattern. + defaultValue: None + types: + - + - name: name + description: The model name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.update_regex_entity_role + name: update_regex_entity_role + summary: 'Update a role for a given regular expression entity in a version of the + + application.' + signature: update_regex_entity_role(app_id, version_id, entity_id, role_id, name=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: entity_id + description: The entity ID. + isRequired: true + types: + - + - name: role_id + description: The entity role ID. + isRequired: true + types: + - + - name: name + description: The entity role name. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.update_sub_list + name: update_sub_list + summary: 'Updates one of the list entity''s sublists in a version of the + + application.' + signature: update_sub_list(app_id, version_id, cl_entity_id, sub_list_id, canonical_form=None, + list=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: cl_entity_id + description: The list entity extractor ID. + isRequired: true + types: + - + - name: sub_list_id + description: The sublist ID. + isRequired: true + types: + - + - name: canonical_form + description: The standard form that the list represents. + defaultValue: None + types: + - + - name: list + description: List of synonym words. + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +attributes: +- uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.PatternOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.PatternOperations.yml new file mode 100644 index 00000000..b98106fe --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.PatternOperations.yml @@ -0,0 +1,424 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.operations.PatternOperations +name: PatternOperations +fullName: azure.cognitiveservices.language.luis.authoring.operations.PatternOperations +module: azure.cognitiveservices.language.luis.authoring.operations +summary: 'PatternOperations operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: PatternOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.operations.PatternOperations.add_pattern + name: add_pattern + summary: Adds a pattern to a version of the application. + signature: add_pattern(app_id, version_id, pattern=None, intent=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: pattern + description: The pattern text. + defaultValue: None + types: + - + - name: intent + description: The intent's name which the pattern belongs to. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: PatternRuleInfo or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.PatternOperations.batch_add_patterns + name: batch_add_patterns + summary: Adds a batch of patterns in a version of the application. + signature: batch_add_patterns(app_id, version_id, patterns, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: patterns + description: A JSON array containing patterns. + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.PatternOperations.delete_pattern + name: delete_pattern + summary: 'Deletes the pattern with the specified ID from a version of the + + application..' + signature: delete_pattern(app_id, version_id, pattern_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: pattern_id + description: The pattern ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.PatternOperations.delete_patterns + name: delete_patterns + summary: Deletes a list of patterns in a version of the application. + signature: delete_patterns(app_id, version_id, pattern_ids, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: pattern_ids + description: The patterns IDs. + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.PatternOperations.list_intent_patterns + name: list_intent_patterns + summary: 'Returns patterns for the specific intent in a version of the + + application.' + signature: list_intent_patterns(app_id, version_id, intent_id, skip=0, take=100, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: intent_id + description: The intent classifier ID. + isRequired: true + types: + - + - name: skip + description: The number of entries to skip. Default value is 0. + defaultValue: '0' + types: + - + - name: take + description: 'The number of entries to return. Maximum page size is + + 500. Default is 100.' + defaultValue: '100' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.PatternOperations.list_patterns + name: list_patterns + summary: Gets patterns in a version of the application. + signature: list_patterns(app_id, version_id, skip=0, take=100, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: skip + description: The number of entries to skip. Default value is 0. + defaultValue: '0' + types: + - + - name: take + description: 'The number of entries to return. Maximum page size is + + 500. Default is 100.' + defaultValue: '100' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.PatternOperations.update_pattern + name: update_pattern + summary: Updates a pattern in a version of the application. + signature: update_pattern(app_id, version_id, pattern_id, pattern, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: pattern_id + description: The pattern ID. + isRequired: true + types: + - + - name: pattern + description: An object representing a pattern. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: PatternRuleInfo or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.PatternOperations.update_patterns + name: update_patterns + summary: Updates patterns in a version of the application. + signature: update_patterns(app_id, version_id, patterns, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: patterns + description: An array represents the patterns. + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +attributes: +- uid: azure.cognitiveservices.language.luis.authoring.operations.PatternOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.SettingsOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.SettingsOperations.yml new file mode 100644 index 00000000..fff56907 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.SettingsOperations.yml @@ -0,0 +1,117 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.operations.SettingsOperations +name: SettingsOperations +fullName: azure.cognitiveservices.language.luis.authoring.operations.SettingsOperations +module: azure.cognitiveservices.language.luis.authoring.operations +summary: 'SettingsOperations operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: SettingsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.operations.SettingsOperations.list + name: list + summary: Gets the settings in a version of the application. + signature: list(app_id, version_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.SettingsOperations.update + name: update + summary: Updates the settings in a version of the application. + signature: update(app_id, version_id, list_of_app_version_setting_object, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: list_of_app_version_setting_object + description: 'A list of the updated + + application version settings.' + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +attributes: +- uid: azure.cognitiveservices.language.luis.authoring.operations.SettingsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.TrainOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.TrainOperations.yml new file mode 100644 index 00000000..3276321a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.TrainOperations.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.operations.TrainOperations +name: TrainOperations +fullName: azure.cognitiveservices.language.luis.authoring.operations.TrainOperations +module: azure.cognitiveservices.language.luis.authoring.operations +summary: 'TrainOperations operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: TrainOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.authoring.operations.TrainOperations.get_status + name: get_status + summary: 'Gets the training status of all models (intents and entities) for the + + specified LUIS app. You must call the train API to train the LUIS app + + before you call this API to get training status. "appID" specifies the + + LUIS app ID. "versionId" specifies the version number of the LUIS app. + + For example, "0.1".' + signature: get_status(app_id, version_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.TrainOperations.train_version + name: train_version + summary: 'Sends a training request for a version of a specified LUIS app. This + + POST request initiates a request asynchronously. To determine whether + + the training request is successful, submit a GET request to get + + training status. Note: The application version is not fully trained + + unless all the models (intents and entities) are trained successfully + + or are up to date. To verify training success, get the training status + + at least once after training is complete.' + signature: train_version(app_id, version_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: EnqueueTrainingResponse or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +attributes: +- uid: azure.cognitiveservices.language.luis.authoring.operations.TrainOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations.yml new file mode 100644 index 00000000..5974143d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations.yml @@ -0,0 +1,528 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations +name: VersionsOperations +fullName: azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations +module: azure.cognitiveservices.language.luis.authoring.operations +summary: 'VersionsOperations operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: VersionsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'Lu format extension. Constant value: "lu".' + name: format +methods: +- uid: azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations.clone + name: clone + summary: Creates a new version from the selected version. + signature: clone(app_id, version_id, version=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: version + description: The new version for the cloned model. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations.delete + name: delete + summary: Deletes an application version. + signature: delete(app_id, version_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations.delete_unlabelled_utterance + name: delete_unlabelled_utterance + summary: Deleted an unlabelled utterance in a version of the application. + signature: delete_unlabelled_utterance(app_id, version_id, utterance, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: utterance + description: The utterance text to delete. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations.export + name: export + summary: Exports a LUIS application to JSON format. + signature: export(app_id, version_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: LuisApp or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations.export_lu_format + name: export_lu_format + summary: Exports a LUIS application to text format. + signature: export_lu_format(app_id, version_id, custom_headers=None, raw=False, + callback=None, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: object or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrest.exceptions.HttpOperationError +- uid: azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations.get + name: get + summary: 'Gets the version information such as date created, last modified date, + + endpoint URL, count of intents and entities, training and publishing + + status.' + signature: get(app_id, version_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: VersionInfo or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations.import_lu_format + name: import_lu_format + summary: Imports a new version into a LUIS application. + signature: import_lu_format(app_id, luis_app_lu, version_id=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: luis_app_lu + description: An LU representing the LUIS application structure. + isRequired: true + types: + - + - name: version_id + description: 'The new versionId to import. If not specified, the + + versionId will be read from the imported object.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations.import_method + name: import_method + summary: Imports a new version into a LUIS application. + signature: import_method(app_id, luis_app, version_id=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: luis_app + description: A LUIS application structure. + isRequired: true + types: + - + - name: version_id + description: 'The new versionId to import. If not specified, the + + versionId will be read from the imported object.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations.import_v2_app + name: import_v2_app + summary: Imports a new version into a LUIS application. + signature: import_v2_app(app_id, luis_app_v2, version_id=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: luis_app_v2 + description: A LUIS application structure. + isRequired: true + types: + - + - name: version_id + description: 'The new versionId to import. If not specified, the + + versionId will be read from the imported object.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations.list + name: list + summary: Gets a list of versions for this application ID. + signature: list(app_id, skip=0, take=100, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: skip + description: The number of entries to skip. Default value is 0. + defaultValue: '0' + types: + - + - name: take + description: 'The number of entries to return. Maximum page size is + + 500. Default is 100.' + defaultValue: '100' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +- uid: azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations.update + name: update + summary: Updates the name or description of the application version. + signature: update(app_id, version_id, version=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The version ID. + isRequired: true + types: + - + - name: version + description: The new version for the cloned model. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException +attributes: +- uid: azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.yml new file mode 100644 index 00000000..4dc1d13c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.operations.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.language.luis.authoring.operations +name: operations +fullName: azure.cognitiveservices.language.luis.authoring.operations +type: import +classes: +- azure.cognitiveservices.language.luis.authoring.operations.AppsOperations +- azure.cognitiveservices.language.luis.authoring.operations.AzureAccountsOperations +- azure.cognitiveservices.language.luis.authoring.operations.ExamplesOperations +- azure.cognitiveservices.language.luis.authoring.operations.FeaturesOperations +- azure.cognitiveservices.language.luis.authoring.operations.ModelOperations +- azure.cognitiveservices.language.luis.authoring.operations.PatternOperations +- azure.cognitiveservices.language.luis.authoring.operations.SettingsOperations +- azure.cognitiveservices.language.luis.authoring.operations.TrainOperations +- azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.version.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.version.yml new file mode 100644 index 00000000..04b5ecde --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.luis.authoring.version +name: version +fullName: azure.cognitiveservices.language.luis.authoring.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.yml new file mode 100644 index 00000000..e2c5db5d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.language.luis.authoring +name: authoring +fullName: azure.cognitiveservices.language.luis.authoring +type: import +classes: +- azure.cognitiveservices.language.luis.authoring.LUISAuthoringClient +- azure.cognitiveservices.language.luis.authoring.LUISAuthoringClientConfiguration +packages: +- azure.cognitiveservices.language.luis.authoring.models +- azure.cognitiveservices.language.luis.authoring.operations +modules: +- azure.cognitiveservices.language.luis.authoring.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.LUISRuntimeClient.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.LUISRuntimeClient.yml new file mode 100644 index 00000000..9e990155 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.LUISRuntimeClient.yml @@ -0,0 +1,36 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.runtime.LUISRuntimeClient +name: LUISRuntimeClient +fullName: azure.cognitiveservices.language.luis.runtime.LUISRuntimeClient +module: azure.cognitiveservices.language.luis.runtime +constructor: + syntax: LUISRuntimeClient(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and + + hostname, for example: [https://westus.api.cognitive.microsoft.com](https://westus.api.cognitive.microsoft.com)).' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +- description: Prediction operations + name: prediction + types: + - +methods: +- uid: azure.cognitiveservices.language.luis.runtime.LUISRuntimeClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.LUISRuntimeClientConfiguration.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.LUISRuntimeClientConfiguration.yml new file mode 100644 index 00000000..79bd5ffe --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.LUISRuntimeClientConfiguration.yml @@ -0,0 +1,62 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.runtime.LUISRuntimeClientConfiguration +name: LUISRuntimeClientConfiguration +fullName: azure.cognitiveservices.language.luis.runtime.LUISRuntimeClientConfiguration +module: azure.cognitiveservices.language.luis.runtime +summary: 'Configuration for LUISRuntimeClient + + Note that all parameters used to create this instance are saved as instance + + attributes.' +constructor: + syntax: LUISRuntimeClientConfiguration(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and + + hostname, for example: [https://westus.api.cognitive.microsoft.com](https://westus.api.cognitive.microsoft.com)).' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.language.luis.runtime.LUISRuntimeClientConfiguration.add_user_agent + name: add_user_agent + summary: Add value to current user agent with a space. + signature: 'add_user_agent(value: str) -> None' + parameters: + - name: value + description: value to add to user agent. + isRequired: true + types: + - +- uid: azure.cognitiveservices.language.luis.runtime.LUISRuntimeClientConfiguration.load + name: load + signature: load(filepath) + parameters: + - name: filepath + isRequired: true +- uid: azure.cognitiveservices.language.luis.runtime.LUISRuntimeClientConfiguration.save + name: save + summary: Save current configuration to file. + signature: save(filepath) + parameters: + - name: filepath + description: Path to file where settings will be saved. + isRequired: true + types: + - + exceptions: + - type: ValueError if supplied filepath cannot be written to. +attributes: +- uid: azure.cognitiveservices.language.luis.runtime.LUISRuntimeClientConfiguration.enable_http_logger + name: enable_http_logger +- uid: azure.cognitiveservices.language.luis.runtime.LUISRuntimeClientConfiguration.user_agent + name: user_agent + summary: The current user agent value. diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.DynamicList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.DynamicList.yml new file mode 100644 index 00000000..3555451f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.DynamicList.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.runtime.models.DynamicList +name: DynamicList +fullName: azure.cognitiveservices.language.luis.runtime.models.DynamicList +module: azure.cognitiveservices.language.luis.runtime.models +summary: 'Defines an extension for a list entity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DynamicList(*, list_entity_name: str, request_lists, **kwargs)' + parameters: + - name: list_entity_name + description: Required. The name of the list entity to extend. + isRequired: true + types: + - + - name: request_lists + description: 'Required. The lists to append on the extended list + + entity.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: list_entity_name + isRequired: true + - name: request_lists + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.runtime.models.DynamicList.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.runtime.models.DynamicList.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.runtime.models.DynamicList.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.runtime.models.DynamicList.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.runtime.models.DynamicList.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.runtime.models.DynamicList.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.runtime.models.DynamicList.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Error.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Error.yml new file mode 100644 index 00000000..57da8f16 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Error.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.runtime.models.Error +name: Error +fullName: azure.cognitiveservices.language.luis.runtime.models.Error +module: azure.cognitiveservices.language.luis.runtime.models +summary: 'Represents the error that occurred. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Error(*, error, **kwargs) + parameters: + - name: error + description: Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: error + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.runtime.models.Error.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.runtime.models.Error.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.runtime.models.Error.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.runtime.models.Error.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.runtime.models.Error.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.runtime.models.Error.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.runtime.models.Error.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.ErrorBody.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.ErrorBody.yml new file mode 100644 index 00000000..42c2718f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.ErrorBody.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.runtime.models.ErrorBody +name: ErrorBody +fullName: azure.cognitiveservices.language.luis.runtime.models.ErrorBody +module: azure.cognitiveservices.language.luis.runtime.models +summary: 'Represents the definition of the error that occurred. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ErrorBody(*, code: str, message: str, **kwargs)' + parameters: + - name: code + description: Required. The error code. + isRequired: true + types: + - + - name: message + description: Required. The error message. + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.runtime.models.ErrorBody.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.runtime.models.ErrorBody.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.runtime.models.ErrorBody.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.runtime.models.ErrorBody.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.runtime.models.ErrorBody.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.runtime.models.ErrorBody.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.runtime.models.ErrorBody.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.ErrorException.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.ErrorException.yml new file mode 100644 index 00000000..d197d806 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.ErrorException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.runtime.models.ErrorException +name: ErrorException +fullName: azure.cognitiveservices.language.luis.runtime.models.ErrorException +module: azure.cognitiveservices.language.luis.runtime.models +summary: 'Server responded with exception of type: ''Error''.' +constructor: + syntax: ErrorException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.runtime.models.ErrorException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cognitiveservices.language.luis.runtime.models.ErrorException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cognitiveservices.language.luis.runtime.models.ErrorException.args + name: args diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.ExternalEntity.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.ExternalEntity.yml new file mode 100644 index 00000000..57915c67 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.ExternalEntity.yml @@ -0,0 +1,161 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.runtime.models.ExternalEntity +name: ExternalEntity +fullName: azure.cognitiveservices.language.luis.runtime.models.ExternalEntity +module: azure.cognitiveservices.language.luis.runtime.models +summary: 'Defines a user predicted entity that extends an already existing one. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ExternalEntity(*, entity_name: str, start_index: int, entity_length: int, + resolution=None, score: float = None, **kwargs)' + parameters: + - name: entity_name + description: Required. The name of the entity to extend. + isRequired: true + types: + - + - name: start_index + description: 'Required. The start character index of the predicted + + entity.' + isRequired: true + types: + - + - name: entity_length + description: Required. The length of the predicted entity. + isRequired: true + types: + - + - name: resolution + description: 'A user supplied custom resolution to return as the + + entity''s prediction.' + isRequired: true + types: + - + - name: score + description: 'A user supplied score to return as the entity''s prediction + + score.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: entity_name + isRequired: true + - name: start_index + isRequired: true + - name: entity_length + isRequired: true + - name: resolution + isRequired: true + - name: score + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.runtime.models.ExternalEntity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.runtime.models.ExternalEntity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.runtime.models.ExternalEntity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.runtime.models.ExternalEntity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.runtime.models.ExternalEntity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.runtime.models.ExternalEntity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.runtime.models.ExternalEntity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Intent.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Intent.yml new file mode 100644 index 00000000..2f4754b2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Intent.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.runtime.models.Intent +name: Intent +fullName: azure.cognitiveservices.language.luis.runtime.models.Intent +module: azure.cognitiveservices.language.luis.runtime.models +summary: Represents an intent prediction. +constructor: + syntax: 'Intent(*, score: float = None, child_app=None, **kwargs)' + parameters: + - name: score + description: The score of the fired intent. + isRequired: true + types: + - + - name: child_app + description: The prediction of the dispatched application. + isRequired: true + types: + - + keywordOnlyParameters: + - name: score + isRequired: true + - name: child_app + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.runtime.models.Intent.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.runtime.models.Intent.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.runtime.models.Intent.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.runtime.models.Intent.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.runtime.models.Intent.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.runtime.models.Intent.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.runtime.models.Intent.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Prediction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Prediction.yml new file mode 100644 index 00000000..95730fb5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Prediction.yml @@ -0,0 +1,161 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.runtime.models.Prediction +name: Prediction +fullName: azure.cognitiveservices.language.luis.runtime.models.Prediction +module: azure.cognitiveservices.language.luis.runtime.models +summary: 'Represents the prediction of a query. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Prediction(*, top_intent: str, intents, entities, altered_query: str = + None, sentiment=None, **kwargs)' + parameters: + - name: altered_query + description: 'The query after spell checking. Only set if spell + + check was enabled and a spelling mistake was found.' + isRequired: true + types: + - + - name: top_intent + description: Required. The name of the top scoring intent. + isRequired: true + types: + - + - name: intents + description: 'Required. A dictionary representing the intents that + + fired.' + isRequired: true + types: + - [, ] + - name: entities + description: 'Required. A dictionary representing the entities that + + fired.' + isRequired: true + types: + - [, ] + - name: sentiment + description: The result of the sentiment analysis. + isRequired: true + types: + - + keywordOnlyParameters: + - name: top_intent + isRequired: true + - name: intents + isRequired: true + - name: entities + isRequired: true + - name: altered_query + isRequired: true + - name: sentiment + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.runtime.models.Prediction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.runtime.models.Prediction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.runtime.models.Prediction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.runtime.models.Prediction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.runtime.models.Prediction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.runtime.models.Prediction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.runtime.models.Prediction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.PredictionRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.PredictionRequest.yml new file mode 100644 index 00000000..c77fb09e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.PredictionRequest.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequest +name: PredictionRequest +fullName: azure.cognitiveservices.language.luis.runtime.models.PredictionRequest +module: azure.cognitiveservices.language.luis.runtime.models +summary: 'Represents the prediction request parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PredictionRequest(*, query: str, options=None, external_entities=None, + dynamic_lists=None, **kwargs)' + parameters: + - name: query + description: Required. The query to predict. + isRequired: true + types: + - + - name: options + description: The custom options defined for this request. + isRequired: true + types: + - + - name: external_entities + description: 'The externally predicted entities for this + + request.' + isRequired: true + types: + - [] + - name: dynamic_lists + description: 'The dynamically created list entities for this + + request.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: query + isRequired: true + - name: options + isRequired: true + - name: external_entities + isRequired: true + - name: dynamic_lists + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions.yml new file mode 100644 index 00000000..1061827f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions +name: PredictionRequestOptions +fullName: azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions +module: azure.cognitiveservices.language.luis.runtime.models +summary: The custom options for the prediction request. +constructor: + syntax: 'PredictionRequestOptions(*, datetime_reference=None, prefer_external_entities: + bool = None, **kwargs)' + parameters: + - name: datetime_reference + description: 'The reference DateTime used for predicting + + datetime entities.' + isRequired: true + types: + - + - name: prefer_external_entities + description: 'Whether to make the external entities + + resolution override the predictions if an overlap occurs.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: datetime_reference + isRequired: true + - name: prefer_external_entities + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.PredictionResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.PredictionResponse.yml new file mode 100644 index 00000000..eb612edc --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.PredictionResponse.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.runtime.models.PredictionResponse +name: PredictionResponse +fullName: azure.cognitiveservices.language.luis.runtime.models.PredictionResponse +module: azure.cognitiveservices.language.luis.runtime.models +summary: 'Represents the prediction response. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PredictionResponse(*, query: str, prediction, **kwargs)' + parameters: + - name: query + description: Required. The query used in the prediction. + isRequired: true + types: + - + - name: prediction + description: Required. The prediction of the requested query. + isRequired: true + types: + - + keywordOnlyParameters: + - name: query + isRequired: true + - name: prediction + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.runtime.models.PredictionResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.RequestList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.RequestList.yml new file mode 100644 index 00000000..a6bc7954 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.RequestList.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.runtime.models.RequestList +name: RequestList +fullName: azure.cognitiveservices.language.luis.runtime.models.RequestList +module: azure.cognitiveservices.language.luis.runtime.models +summary: 'Defines a sub-list to append to an existing list entity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RequestList(*, canonical_form: str, name: str = None, synonyms=None, **kwargs)' + parameters: + - name: name + description: The name of the sub-list. + isRequired: true + types: + - + - name: canonical_form + description: Required. The canonical form of the sub-list. + isRequired: true + types: + - + - name: synonyms + description: The synonyms of the canonical form. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: canonical_form + isRequired: true + - name: name + isRequired: true + - name: synonyms + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.runtime.models.RequestList.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.runtime.models.RequestList.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.runtime.models.RequestList.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.runtime.models.RequestList.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.runtime.models.RequestList.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.runtime.models.RequestList.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.runtime.models.RequestList.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Sentiment.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Sentiment.yml new file mode 100644 index 00000000..ea876468 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Sentiment.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.runtime.models.Sentiment +name: Sentiment +fullName: azure.cognitiveservices.language.luis.runtime.models.Sentiment +module: azure.cognitiveservices.language.luis.runtime.models +summary: 'The result of the sentiment analysis. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Sentiment(*, score: float, label: str = None, **kwargs)' + parameters: + - name: label + description: The label of the sentiment analysis result. + isRequired: true + types: + - + - name: score + description: Required. The sentiment score of the query. + isRequired: true + types: + - + keywordOnlyParameters: + - name: score + isRequired: true + - name: label + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.runtime.models.Sentiment.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.runtime.models.Sentiment.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.runtime.models.Sentiment.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.luis.runtime.models.Sentiment.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.luis.runtime.models.Sentiment.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.luis.runtime.models.Sentiment.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.luis.runtime.models.Sentiment.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.yml new file mode 100644 index 00000000..233713f2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.language.luis.runtime.models +name: models +fullName: azure.cognitiveservices.language.luis.runtime.models +type: import +classes: +- azure.cognitiveservices.language.luis.runtime.models.DynamicList +- azure.cognitiveservices.language.luis.runtime.models.Error +- azure.cognitiveservices.language.luis.runtime.models.ErrorBody +- azure.cognitiveservices.language.luis.runtime.models.ErrorException +- azure.cognitiveservices.language.luis.runtime.models.ExternalEntity +- azure.cognitiveservices.language.luis.runtime.models.Intent +- azure.cognitiveservices.language.luis.runtime.models.Prediction +- azure.cognitiveservices.language.luis.runtime.models.PredictionRequest +- azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions +- azure.cognitiveservices.language.luis.runtime.models.PredictionResponse +- azure.cognitiveservices.language.luis.runtime.models.RequestList +- azure.cognitiveservices.language.luis.runtime.models.Sentiment diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.operations.PredictionOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.operations.PredictionOperations.yml new file mode 100644 index 00000000..091dbf1d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.operations.PredictionOperations.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.luis.runtime.operations.PredictionOperations +name: PredictionOperations +fullName: azure.cognitiveservices.language.luis.runtime.operations.PredictionOperations +module: azure.cognitiveservices.language.luis.runtime.operations +summary: 'PredictionOperations operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: PredictionOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.language.luis.runtime.operations.PredictionOperations.get_slot_prediction + name: get_slot_prediction + summary: Gets the predictions for an application slot. + signature: get_slot_prediction(app_id, slot_name, prediction_request, verbose=None, + show_all_intents=None, log=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: slot_name + description: The application slot name. + isRequired: true + types: + - + - name: prediction_request + description: The prediction request parameters. + isRequired: true + types: + - + - name: verbose + description: 'Indicates whether to get extra metadata for the + + entities predictions or not.' + defaultValue: None + types: + - + - name: show_all_intents + description: 'Indicates whether to return all the intents + + in the response or just the top intent.' + defaultValue: None + types: + - + - name: log + description: Indicates whether to log the endpoint query or not. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: PredictionResponse or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.runtime.models.ErrorException +- uid: azure.cognitiveservices.language.luis.runtime.operations.PredictionOperations.get_version_prediction + name: get_version_prediction + summary: Gets the predictions for an application version. + signature: get_version_prediction(app_id, version_id, prediction_request, verbose=None, + show_all_intents=None, log=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: version_id + description: The application version ID. + isRequired: true + types: + - + - name: prediction_request + description: The prediction request parameters. + isRequired: true + types: + - + - name: verbose + description: 'Indicates whether to get extra metadata for the + + entities predictions or not.' + defaultValue: None + types: + - + - name: show_all_intents + description: 'Indicates whether to return all the intents + + in the response or just the top intent.' + defaultValue: None + types: + - + - name: log + description: Indicates whether to log the endpoint query or not. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: PredictionResponse or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.luis.runtime.models.ErrorException +attributes: +- uid: azure.cognitiveservices.language.luis.runtime.operations.PredictionOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.operations.yml new file mode 100644 index 00000000..105a4c04 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.operations.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.language.luis.runtime.operations +name: operations +fullName: azure.cognitiveservices.language.luis.runtime.operations +type: import +classes: +- azure.cognitiveservices.language.luis.runtime.operations.PredictionOperations diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.version.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.version.yml new file mode 100644 index 00000000..5ff8b722 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.luis.runtime.version +name: version +fullName: azure.cognitiveservices.language.luis.runtime.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.yml new file mode 100644 index 00000000..0ce95245 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.language.luis.runtime +name: runtime +fullName: azure.cognitiveservices.language.luis.runtime +type: import +classes: +- azure.cognitiveservices.language.luis.runtime.LUISRuntimeClient +- azure.cognitiveservices.language.luis.runtime.LUISRuntimeClientConfiguration +packages: +- azure.cognitiveservices.language.luis.runtime.models +- azure.cognitiveservices.language.luis.runtime.operations +modules: +- azure.cognitiveservices.language.luis.runtime.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.version.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.version.yml new file mode 100644 index 00000000..f781288c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.luis.version +name: version +fullName: azure.cognitiveservices.language.luis.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.yml new file mode 100644 index 00000000..c0b88fb0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.language.luis +name: luis +fullName: azure.cognitiveservices.language.luis +type: rootImport +packages: +- azure.cognitiveservices.language.luis.authoring +- azure.cognitiveservices.language.luis.runtime +modules: +- azure.cognitiveservices.language.luis.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.SpellCheckClient.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.SpellCheckClient.yml new file mode 100644 index 00000000..06569a3e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.SpellCheckClient.yml @@ -0,0 +1,481 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.spellcheck.SpellCheckClient +name: SpellCheckClient +fullName: azure.cognitiveservices.language.spellcheck.SpellCheckClient +module: azure.cognitiveservices.language.spellcheck +summary: The Spell Check API - V7 lets you check a text string for spelling and grammar + errors. +constructor: + syntax: SpellCheckClient(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and + + hostname, for example: "[https://westus.api.cognitive.microsoft.com](https://westus.api.cognitive.microsoft.com)", + + "[https://api.cognitive.microsoft.com](https://api.cognitive.microsoft.com)").' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +methods: +- uid: azure.cognitiveservices.language.spellcheck.SpellCheckClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None +- uid: azure.cognitiveservices.language.spellcheck.SpellCheckClient.spell_checker + name: spell_checker + summary: 'The Bing Spell Check API lets you perform contextual grammar and spell + + checking. Bing has developed a web-based spell-checker that leverages + + machine learning and statistical machine translation to dynamically + + train a constantly evolving and highly contextual algorithm. The + + spell-checker is based on a massive corpus of web searches and + + documents.' + signature: spell_checker(text, accept_language=None, pragma=None, user_agent=None, + client_id=None, client_ip=None, location=None, action_type=None, app_name=None, + country_code=None, client_machine_name=None, doc_id=None, market=None, session_id=None, + set_lang=None, user_id=None, mode=None, pre_context_text=None, post_context_text=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: text + description: 'The text string to check for spelling and grammar errors. + + The combined length of the text string, preContextText string, and + + postContextText string may not exceed 10,000 characters. You may + + specify this parameter in the query string of a GET request or in the + + body of a POST request. Because of the query string length limit, + + you''ll typically use a POST request unless you''re checking only short + + strings.' + isRequired: true + types: + - + - name: accept_language + description: 'A comma-delimited list of one or more + + languages to use for user interface strings. The list is in decreasing + + order of preference. For additional information, including expected + + format, see + + [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). + + This header and the setLang query parameter are mutually exclusive; do + + not specify both. If you set this header, you must also specify the cc + + query parameter. Bing will use the first supported language it finds + + from the list, and combine that language with the cc parameter value + + to determine the market to return results for. If the list does not + + include a supported language, Bing will find the closest language and + + market that supports the request, and may use an aggregated or default + + market for the results instead of a specified one. You should use this + + header and the cc query parameter only if you specify multiple + + languages; otherwise, you should use the mkt and setLang query + + parameters. A user interface string is a string that''s used as a label + + in a user interface. There are very few user interface strings in the + + JSON response objects. Any links in the response objects to Bing.com + + properties will apply the specified language.' + defaultValue: None + types: + - + - name: pragma + description: 'By default, Bing returns cached content, if available. + + To prevent Bing from returning cached content, set the Pragma header + + to no-cache (for example, Pragma: no-cache).' + defaultValue: None + types: + - + - name: user_agent + description: 'The user agent originating the request. Bing uses + + the user agent to provide mobile users with an optimized experience. + + Although optional, you are strongly encouraged to always specify this + + header. The user-agent should be the same string that any commonly + + used browser would send. For information about user agents, see [RFC + + 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).' + defaultValue: None + types: + - + - name: client_id + description: 'Bing uses this header to provide users with + + consistent behavior across Bing API calls. Bing often flights new + + features and improvements, and it uses the client ID as a key for + + assigning traffic on different flights. If you do not use the same + + client ID for a user across multiple requests, then Bing may assign + + the user to multiple conflicting flights. Being assigned to multiple + + conflicting flights can lead to an inconsistent user experience. For + + example, if the second request has a different flight assignment than + + the first, the experience may be unexpected. Also, Bing can use the + + client ID to tailor web results to that client ID''s search history, + + providing a richer experience for the user. Bing also uses this header + + to help improve result rankings by analyzing the activity generated by + + a client ID. The relevance improvements help with better quality of + + results delivered by Bing APIs and in turn enables higher + + click-through rates for the API consumer. IMPORTANT: Although + + optional, you should consider this header required. Persisting the + + client ID across multiple requests for the same end user and device + + combination enables 1) the API consumer to receive a consistent user + + experience, and 2) higher click-through rates via better quality of + + results from the Bing APIs. Each user that uses your application on + + the device must have a unique, Bing generated client ID. If you do not + + include this header in the request, Bing generates an ID and returns + + it in the X-MSEdge-ClientID response header. The only time that you + + should NOT include this header in a request is the first time the user + + uses your app on that device. Use the client ID for each Bing API + + request that your app makes for this user on the device. Persist the + + client ID. To persist the ID in a browser app, use a persistent HTTP + + cookie to ensure the ID is used across all sessions. Do not use a + + session cookie. For other apps such as mobile apps, use the device''s + + persistent storage to persist the ID. The next time the user uses your + + app on that device, get the client ID that you persisted. Bing + + responses may or may not include this header. If the response includes + + this header, capture the client ID and use it for all subsequent Bing + + requests for the user on that device. If you include the + + X-MSEdge-ClientID, you must not include cookies in the request.' + defaultValue: None + types: + - + - name: client_ip + description: 'The IPv4 or IPv6 address of the client device. The + + IP address is used to discover the user''s location. Bing uses the + + location information to determine safe search behavior. Although + + optional, you are encouraged to always specify this header and the + + X-Search-Location header. Do not obfuscate the address (for example, + + by changing the last octet to 0). Obfuscating the address results in + + the location not being anywhere near the device''s actual location, + + which may result in Bing serving erroneous results.' + defaultValue: None + types: + - + - name: location + description: 'A semicolon-delimited list of key/value pairs that + + describe the client''s geographical location. Bing uses the location + + information to determine safe search behavior and to return relevant + + local content. Specify the key/value pair as :. The + + following are the keys that you use to specify the user''s location. + + lat (required): The latitude of the client''s location, in degrees. The + + latitude must be greater than or equal to -90.0 and less than or equal + + to +90.0. Negative values indicate southern latitudes and positive + + values indicate northern latitudes. long (required): The longitude of + + the client''s location, in degrees. The longitude must be greater than + + or equal to -180.0 and less than or equal to +180.0. Negative values + + indicate western longitudes and positive values indicate eastern + + longitudes. re (required): The radius, in meters, which specifies the + + horizontal accuracy of the coordinates. Pass the value returned by the + + device''s location service. Typical values might be 22m for GPS/Wi-Fi, + + 380m for cell tower triangulation, and 18,000m for reverse IP lookup. + + ts (optional): The UTC UNIX timestamp of when the client was at the + + location. (The UNIX timestamp is the number of seconds since January + + 1, 1970.) head (optional): The client''s relative heading or direction + + of travel. Specify the direction of travel as degrees from 0 through + + 360, counting clockwise relative to true north. Specify this key only + + if the sp key is nonzero. sp (optional): The horizontal velocity + + (speed), in meters per second, that the client device is traveling. + + alt (optional): The altitude of the client device, in meters. are + + (optional): The radius, in meters, that specifies the vertical + + accuracy of the coordinates. Specify this key only if you specify the + + alt key. Although many of the keys are optional, the more information + + that you provide, the more accurate the location results are. Although + + optional, you are encouraged to always specify the user''s geographical + + location. Providing the location is especially important if the + + client''s IP address does not accurately reflect the user''s physical + + location (for example, if the client uses VPN). For optimal results, + + you should include this header and the X-Search-ClientIP header, but + + at a minimum, you should include this header.' + defaultValue: None + types: + - + - name: action_type + description: "A string that's used by logging to determine\nwhether the request\ + \ is coming from an interactive session or a page\nload. The following are the\ + \ possible values. 1) Edit\u2014The request is\nfrom an interactive session\ + \ 2) Load\u2014The request is from a page load.\nPossible values include: 'Edit',\ + \ 'Load'" + defaultValue: None + types: + - + - + - name: app_name + description: 'The unique name of your app. The name must be known + + by Bing. Do not include this parameter unless you have previously + + contacted Bing to get a unique app name. To get a unique name, contact + + your Bing Business Development manager.' + defaultValue: None + types: + - + - name: country_code + description: "A 2-character country code of the country where\nthe results come\ + \ from. This API supports only the United States\nmarket. If you specify this\ + \ query parameter, it must be set to us. If\nyou set this parameter, you must\ + \ also specify the Accept-Language\nheader. Bing uses the first supported language\ + \ it finds from the\nlanguages list, and combine that language with the country\ + \ code that\nyou specify to determine the market to return results for. If the\n\ + languages list does not include a supported language, Bing finds the\nclosest\ + \ language and market that supports the request, or it may use\nan aggregated\ + \ or default market for the results instead of a specified\none. You should\ + \ use this query parameter and the Accept-Language query\nparameter only if\ + \ you specify multiple languages; otherwise, you\nshould use the mkt and setLang\ + \ query parameters. This parameter and\nthe mkt query parameter are mutually\ + \ exclusive\u2014do not specify both." + defaultValue: None + types: + - + - name: client_machine_name + description: 'A unique name of the device that the + + request is being made from. Generate a unique value for each device + + (the value is unimportant). The service uses the ID to help debug + + issues and improve the quality of corrections.' + defaultValue: None + types: + - + - name: doc_id + description: 'A unique ID that identifies the document that the text + + belongs to. Generate a unique value for each document (the value is + + unimportant). The service uses the ID to help debug issues and improve + + the quality of corrections.' + defaultValue: None + types: + - + - name: market + description: "The market where the results come from. You are\nstrongly encouraged\ + \ to always specify the market, if known. Specifying\nthe market helps Bing\ + \ route the request and return an appropriate and\noptimal response. This parameter\ + \ and the cc query parameter are\nmutually exclusive\u2014do not specify both." + defaultValue: None + types: + - + - name: session_id + description: 'A unique ID that identifies this user session. + + Generate a unique value for each user session (the value is + + unimportant). The service uses the ID to help debug issues and improve + + the quality of corrections' + defaultValue: None + types: + - + - name: set_lang + description: "The language to use for user interface strings.\nSpecify the language\ + \ using the ISO 639-1 2-letter language code. For\nexample, the language code\ + \ for English is EN. The default is EN\n(English). Although optional, you should\ + \ always specify the language.\nTypically, you set setLang to the same language\ + \ specified by mkt\nunless the user wants the user interface strings displayed\ + \ in a\ndifferent language. This parameter and the Accept-Language header are\n\ + mutually exclusive\u2014do not specify both. A user interface string is a\n\ + string that's used as a label in a user interface. There are few user\ninterface\ + \ strings in the JSON response objects. Also, any links to\nBing.com properties\ + \ in the response objects apply the specified\nlanguage." + defaultValue: None + types: + - + - name: user_id + description: 'A unique ID that identifies the user. Generate a + + unique value for each user (the value is unimportant). The service + + uses the ID to help debug issues and improve the quality of + + corrections.' + defaultValue: None + types: + - + - name: mode + description: "The type of spelling and grammar checks to perform. The\nfollowing\ + \ are the possible values (the values are case insensitive).\nThe default is\ + \ Proof. 1) Proof\u2014Finds most spelling and grammar\nmistakes. 2) Spell\u2014\ + Finds most spelling mistakes but does not find some\nof the grammar errors that\ + \ Proof catches (for example, capitalization\nand repeated words). Possible\ + \ values include: 'proof', 'spell'" + defaultValue: None + types: + - + - + - name: pre_context_text + description: 'A string that gives context to the text + + string. For example, the text string petal is valid. However, if you + + set preContextText to bike, the context changes and the text string + + becomes not valid. In this case, the API suggests that you change + + petal to pedal (as in bike pedal). This text is not checked for + + grammar or spelling errors. The combined length of the text string, + + preContextText string, and postContextText string may not exceed + + 10,000 characters. You may specify this parameter in the query string + + of a GET request or in the body of a POST request.' + defaultValue: None + types: + - + - name: post_context_text + description: 'A string that gives context to the text + + string. For example, the text string read is valid. However, if you + + set postContextText to carpet, the context changes and the text string + + becomes not valid. In this case, the API suggests that you change read + + to red (as in red carpet). This text is not checked for grammar or + + spelling errors. The combined length of the text string, + + preContextText string, and postContextText string may not exceed + + 10,000 characters. You may specify this parameter in the query string + + of a GET request or in the body of a POST request.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SpellCheck or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.spellcheck.models.ErrorResponseException diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.SpellCheckClientConfiguration.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.SpellCheckClientConfiguration.yml new file mode 100644 index 00000000..c8d386e0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.SpellCheckClientConfiguration.yml @@ -0,0 +1,64 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.spellcheck.SpellCheckClientConfiguration +name: SpellCheckClientConfiguration +fullName: azure.cognitiveservices.language.spellcheck.SpellCheckClientConfiguration +module: azure.cognitiveservices.language.spellcheck +summary: 'Configuration for SpellCheckClient + + Note that all parameters used to create this instance are saved as instance + + attributes.' +constructor: + syntax: SpellCheckClientConfiguration(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and + + hostname, for example: "[https://westus.api.cognitive.microsoft.com](https://westus.api.cognitive.microsoft.com)", + + "[https://api.cognitive.microsoft.com](https://api.cognitive.microsoft.com)").' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.language.spellcheck.SpellCheckClientConfiguration.add_user_agent + name: add_user_agent + summary: Add value to current user agent with a space. + signature: 'add_user_agent(value: str) -> None' + parameters: + - name: value + description: value to add to user agent. + isRequired: true + types: + - +- uid: azure.cognitiveservices.language.spellcheck.SpellCheckClientConfiguration.load + name: load + signature: load(filepath) + parameters: + - name: filepath + isRequired: true +- uid: azure.cognitiveservices.language.spellcheck.SpellCheckClientConfiguration.save + name: save + summary: Save current configuration to file. + signature: save(filepath) + parameters: + - name: filepath + description: Path to file where settings will be saved. + isRequired: true + types: + - + exceptions: + - type: ValueError if supplied filepath cannot be written to. +attributes: +- uid: azure.cognitiveservices.language.spellcheck.SpellCheckClientConfiguration.enable_http_logger + name: enable_http_logger +- uid: azure.cognitiveservices.language.spellcheck.SpellCheckClientConfiguration.user_agent + name: user_agent + summary: The current user agent value. diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ActionType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ActionType.yml new file mode 100644 index 00000000..35561a31 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ActionType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.language.spellcheck.models.ActionType +name: ActionType +fullName: azure.cognitiveservices.language.spellcheck.models.ActionType +module: azure.cognitiveservices.language.spellcheck.models +fields: +- name: edit + uid: azure.cognitiveservices.language.spellcheck.models.ActionType.edit +- name: load + uid: azure.cognitiveservices.language.spellcheck.models.ActionType.load diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.Answer.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.Answer.yml new file mode 100644 index 00000000..df3a66e9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.Answer.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.spellcheck.models.Answer +name: Answer +fullName: azure.cognitiveservices.language.spellcheck.models.Answer +module: azure.cognitiveservices.language.spellcheck.models +summary: 'Answer. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: SpellCheck + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Answer(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +methods: +- uid: azure.cognitiveservices.language.spellcheck.models.Answer.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.spellcheck.models.Answer.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.spellcheck.models.Answer.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.spellcheck.models.Answer.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.spellcheck.models.Answer.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.spellcheck.models.Answer.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.spellcheck.models.Answer.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.Error.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.Error.yml new file mode 100644 index 00000000..4fc177ff --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.Error.yml @@ -0,0 +1,173 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.spellcheck.models.Error +name: Error +fullName: azure.cognitiveservices.language.spellcheck.models.Error +module: azure.cognitiveservices.language.spellcheck.models +summary: 'Defines the error that occurred. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Error(*, message: str, code=''None'', **kwargs)' + parameters: + - name: code + description: 'Required. The error code that identifies the category of + + error. Possible values include: ''None'', ''ServerError'', ''InvalidRequest'', + + ''RateLimitExceeded'', ''InvalidAuthorization'', ''InsufficientAuthorization''. + + Default value: "None" .' + isRequired: true + types: + - + - + - name: message + description: Required. A description of the error. + isRequired: true + types: + - + keywordOnlyParameters: + - name: message + isRequired: true + - name: code + defaultValue: None +variables: +- description: 'The error code that further helps to identify the error. + + Possible values include: ''UnexpectedError'', ''ResourceError'', + + ''NotImplemented'', ''ParameterMissing'', ''ParameterInvalidValue'', + + ''HttpNotAllowed'', ''Blocked'', ''AuthorizationMissing'', + + ''AuthorizationRedundancy'', ''AuthorizationDisabled'', ''AuthorizationExpired''' + name: sub_code + types: + - + - +- description: 'A description that provides additional information + + about the error.' + name: more_details + types: + - +- description: The parameter in the request that caused the error. + name: parameter + types: + - +- description: The parameter's value in the request that was not valid. + name: value + types: + - +methods: +- uid: azure.cognitiveservices.language.spellcheck.models.Error.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.spellcheck.models.Error.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.spellcheck.models.Error.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.spellcheck.models.Error.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.spellcheck.models.Error.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.spellcheck.models.Error.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.spellcheck.models.Error.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ErrorCode.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ErrorCode.yml new file mode 100644 index 00000000..81296a36 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ErrorCode.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.language.spellcheck.models.ErrorCode +name: ErrorCode +fullName: azure.cognitiveservices.language.spellcheck.models.ErrorCode +module: azure.cognitiveservices.language.spellcheck.models +fields: +- name: insufficient_authorization + uid: azure.cognitiveservices.language.spellcheck.models.ErrorCode.insufficient_authorization +- name: invalid_authorization + uid: azure.cognitiveservices.language.spellcheck.models.ErrorCode.invalid_authorization +- name: invalid_request + uid: azure.cognitiveservices.language.spellcheck.models.ErrorCode.invalid_request +- name: none + uid: azure.cognitiveservices.language.spellcheck.models.ErrorCode.none +- name: rate_limit_exceeded + uid: azure.cognitiveservices.language.spellcheck.models.ErrorCode.rate_limit_exceeded +- name: server_error + uid: azure.cognitiveservices.language.spellcheck.models.ErrorCode.server_error diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ErrorResponse.yml new file mode 100644 index 00000000..cedc5d0a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ErrorResponse.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.spellcheck.models.ErrorResponse +name: ErrorResponse +fullName: azure.cognitiveservices.language.spellcheck.models.ErrorResponse +module: azure.cognitiveservices.language.spellcheck.models +summary: 'The top-level response that represents a failed request. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ErrorResponse(*, errors, **kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: errors + description: 'Required. A list of errors that describe the reasons why + + the request failed.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: errors + isRequired: true +variables: +- description: A String identifier. + name: id + types: + - +methods: +- uid: azure.cognitiveservices.language.spellcheck.models.ErrorResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.spellcheck.models.ErrorResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.spellcheck.models.ErrorResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.spellcheck.models.ErrorResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.spellcheck.models.ErrorResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.spellcheck.models.ErrorResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.spellcheck.models.ErrorResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ErrorResponseException.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ErrorResponseException.yml new file mode 100644 index 00000000..fac01355 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ErrorResponseException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.spellcheck.models.ErrorResponseException +name: ErrorResponseException +fullName: azure.cognitiveservices.language.spellcheck.models.ErrorResponseException +module: azure.cognitiveservices.language.spellcheck.models +summary: 'Server responded with exception of type: ''ErrorResponse''.' +constructor: + syntax: ErrorResponseException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.cognitiveservices.language.spellcheck.models.ErrorResponseException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cognitiveservices.language.spellcheck.models.ErrorResponseException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cognitiveservices.language.spellcheck.models.ErrorResponseException.args + name: args diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ErrorSubCode.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ErrorSubCode.yml new file mode 100644 index 00000000..6941f751 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ErrorSubCode.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.language.spellcheck.models.ErrorSubCode +name: ErrorSubCode +fullName: azure.cognitiveservices.language.spellcheck.models.ErrorSubCode +module: azure.cognitiveservices.language.spellcheck.models +fields: +- name: authorization_disabled + uid: azure.cognitiveservices.language.spellcheck.models.ErrorSubCode.authorization_disabled +- name: authorization_expired + uid: azure.cognitiveservices.language.spellcheck.models.ErrorSubCode.authorization_expired +- name: authorization_missing + uid: azure.cognitiveservices.language.spellcheck.models.ErrorSubCode.authorization_missing +- name: authorization_redundancy + uid: azure.cognitiveservices.language.spellcheck.models.ErrorSubCode.authorization_redundancy +- name: blocked + uid: azure.cognitiveservices.language.spellcheck.models.ErrorSubCode.blocked +- name: http_not_allowed + uid: azure.cognitiveservices.language.spellcheck.models.ErrorSubCode.http_not_allowed +- name: not_implemented + uid: azure.cognitiveservices.language.spellcheck.models.ErrorSubCode.not_implemented +- name: parameter_invalid_value + uid: azure.cognitiveservices.language.spellcheck.models.ErrorSubCode.parameter_invalid_value +- name: parameter_missing + uid: azure.cognitiveservices.language.spellcheck.models.ErrorSubCode.parameter_missing +- name: resource_error + uid: azure.cognitiveservices.language.spellcheck.models.ErrorSubCode.resource_error +- name: unexpected_error + uid: azure.cognitiveservices.language.spellcheck.models.ErrorSubCode.unexpected_error diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ErrorType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ErrorType.yml new file mode 100644 index 00000000..29c7d6c7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ErrorType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.language.spellcheck.models.ErrorType +name: ErrorType +fullName: azure.cognitiveservices.language.spellcheck.models.ErrorType +module: azure.cognitiveservices.language.spellcheck.models +fields: +- name: repeated_token + uid: azure.cognitiveservices.language.spellcheck.models.ErrorType.repeated_token +- name: unknown_token + uid: azure.cognitiveservices.language.spellcheck.models.ErrorType.unknown_token diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.Identifiable.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.Identifiable.yml new file mode 100644 index 00000000..bacad761 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.Identifiable.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.spellcheck.models.Identifiable +name: Identifiable +fullName: azure.cognitiveservices.language.spellcheck.models.Identifiable +module: azure.cognitiveservices.language.spellcheck.models +summary: 'Defines the identity of a resource. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Response + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Identifiable(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +methods: +- uid: azure.cognitiveservices.language.spellcheck.models.Identifiable.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.spellcheck.models.Identifiable.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.spellcheck.models.Identifiable.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.spellcheck.models.Identifiable.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.spellcheck.models.Identifiable.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.spellcheck.models.Identifiable.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.spellcheck.models.Identifiable.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.Mode.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.Mode.yml new file mode 100644 index 00000000..6f95fe8a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.Mode.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.language.spellcheck.models.Mode +name: Mode +fullName: azure.cognitiveservices.language.spellcheck.models.Mode +module: azure.cognitiveservices.language.spellcheck.models +fields: +- name: proof + uid: azure.cognitiveservices.language.spellcheck.models.Mode.proof +- name: spell + uid: azure.cognitiveservices.language.spellcheck.models.Mode.spell diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.Response.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.Response.yml new file mode 100644 index 00000000..08f4a186 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.Response.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.spellcheck.models.Response +name: Response +fullName: azure.cognitiveservices.language.spellcheck.models.Response +module: azure.cognitiveservices.language.spellcheck.models +summary: 'Defines a response. All schemas that could be returned at the root of a + + response should inherit from this. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Answer, ErrorResponse + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Response(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +methods: +- uid: azure.cognitiveservices.language.spellcheck.models.Response.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.spellcheck.models.Response.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.spellcheck.models.Response.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.spellcheck.models.Response.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.spellcheck.models.Response.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.spellcheck.models.Response.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.spellcheck.models.Response.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ResponseBase.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ResponseBase.yml new file mode 100644 index 00000000..b400fdec --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.ResponseBase.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.spellcheck.models.ResponseBase +name: ResponseBase +fullName: azure.cognitiveservices.language.spellcheck.models.ResponseBase +module: azure.cognitiveservices.language.spellcheck.models +summary: 'ResponseBase. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Identifiable + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ResponseBase(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.language.spellcheck.models.ResponseBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.spellcheck.models.ResponseBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.spellcheck.models.ResponseBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.spellcheck.models.ResponseBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.spellcheck.models.ResponseBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.spellcheck.models.ResponseBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.spellcheck.models.ResponseBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.SpellCheck.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.SpellCheck.yml new file mode 100644 index 00000000..547eb545 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.SpellCheck.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.spellcheck.models.SpellCheck +name: SpellCheck +fullName: azure.cognitiveservices.language.spellcheck.models.SpellCheck +module: azure.cognitiveservices.language.spellcheck.models +summary: 'SpellCheck. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: SpellCheck(*, flagged_tokens, **kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: flagged_tokens + description: Required. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: flagged_tokens + isRequired: true +variables: +- description: A String identifier. + name: id + types: + - +methods: +- uid: azure.cognitiveservices.language.spellcheck.models.SpellCheck.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.spellcheck.models.SpellCheck.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.spellcheck.models.SpellCheck.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.spellcheck.models.SpellCheck.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.spellcheck.models.SpellCheck.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.spellcheck.models.SpellCheck.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.spellcheck.models.SpellCheck.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.SpellingFlaggedToken.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.SpellingFlaggedToken.yml new file mode 100644 index 00000000..3f3b23ce --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.SpellingFlaggedToken.yml @@ -0,0 +1,156 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.spellcheck.models.SpellingFlaggedToken +name: SpellingFlaggedToken +fullName: azure.cognitiveservices.language.spellcheck.models.SpellingFlaggedToken +module: azure.cognitiveservices.language.spellcheck.models +summary: 'SpellingFlaggedToken. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SpellingFlaggedToken(*, offset: int, token: str, type=''UnknownToken'', + **kwargs)' + parameters: + - name: offset + description: Required. + isRequired: true + types: + - + - name: token + description: Required. + isRequired: true + types: + - + - name: type + description: 'Required. Possible values include: ''UnknownToken'', + + ''RepeatedToken''. Default value: "UnknownToken" .' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: offset + isRequired: true + - name: token + isRequired: true + - name: type + defaultValue: UnknownToken +variables: +- name: suggestions + types: + - [] +- name: ping_url_suffix + types: + - +methods: +- uid: azure.cognitiveservices.language.spellcheck.models.SpellingFlaggedToken.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.spellcheck.models.SpellingFlaggedToken.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.spellcheck.models.SpellingFlaggedToken.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.spellcheck.models.SpellingFlaggedToken.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.spellcheck.models.SpellingFlaggedToken.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.spellcheck.models.SpellingFlaggedToken.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.spellcheck.models.SpellingFlaggedToken.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.SpellingTokenSuggestion.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.SpellingTokenSuggestion.yml new file mode 100644 index 00000000..0a2e3c45 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.SpellingTokenSuggestion.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.spellcheck.models.SpellingTokenSuggestion +name: SpellingTokenSuggestion +fullName: azure.cognitiveservices.language.spellcheck.models.SpellingTokenSuggestion +module: azure.cognitiveservices.language.spellcheck.models +summary: 'SpellingTokenSuggestion. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SpellingTokenSuggestion(*, suggestion: str, **kwargs)' + parameters: + - name: suggestion + description: Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: suggestion + isRequired: true +variables: +- name: score + types: + - +- name: ping_url_suffix + types: + - +methods: +- uid: azure.cognitiveservices.language.spellcheck.models.SpellingTokenSuggestion.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.spellcheck.models.SpellingTokenSuggestion.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.spellcheck.models.SpellingTokenSuggestion.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.spellcheck.models.SpellingTokenSuggestion.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.spellcheck.models.SpellingTokenSuggestion.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.spellcheck.models.SpellingTokenSuggestion.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.spellcheck.models.SpellingTokenSuggestion.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.yml new file mode 100644 index 00000000..24c51de6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.models.yml @@ -0,0 +1,22 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.language.spellcheck.models +name: models +fullName: azure.cognitiveservices.language.spellcheck.models +type: import +classes: +- azure.cognitiveservices.language.spellcheck.models.Answer +- azure.cognitiveservices.language.spellcheck.models.Error +- azure.cognitiveservices.language.spellcheck.models.ErrorResponse +- azure.cognitiveservices.language.spellcheck.models.ErrorResponseException +- azure.cognitiveservices.language.spellcheck.models.Identifiable +- azure.cognitiveservices.language.spellcheck.models.Response +- azure.cognitiveservices.language.spellcheck.models.ResponseBase +- azure.cognitiveservices.language.spellcheck.models.SpellCheck +- azure.cognitiveservices.language.spellcheck.models.SpellingFlaggedToken +- azure.cognitiveservices.language.spellcheck.models.SpellingTokenSuggestion +enums: +- azure.cognitiveservices.language.spellcheck.models.ActionType +- azure.cognitiveservices.language.spellcheck.models.ErrorCode +- azure.cognitiveservices.language.spellcheck.models.ErrorSubCode +- azure.cognitiveservices.language.spellcheck.models.ErrorType +- azure.cognitiveservices.language.spellcheck.models.Mode diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.operations.SpellCheckClientOperationsMixin.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.operations.SpellCheckClientOperationsMixin.yml new file mode 100644 index 00000000..9e5f6bcc --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.operations.SpellCheckClientOperationsMixin.yml @@ -0,0 +1,453 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.spellcheck.operations.SpellCheckClientOperationsMixin +name: SpellCheckClientOperationsMixin +fullName: azure.cognitiveservices.language.spellcheck.operations.SpellCheckClientOperationsMixin +module: azure.cognitiveservices.language.spellcheck.operations +constructor: + syntax: SpellCheckClientOperationsMixin() +methods: +- uid: azure.cognitiveservices.language.spellcheck.operations.SpellCheckClientOperationsMixin.spell_checker + name: spell_checker + summary: 'The Bing Spell Check API lets you perform contextual grammar and spell + + checking. Bing has developed a web-based spell-checker that leverages + + machine learning and statistical machine translation to dynamically + + train a constantly evolving and highly contextual algorithm. The + + spell-checker is based on a massive corpus of web searches and + + documents.' + signature: spell_checker(text, accept_language=None, pragma=None, user_agent=None, + client_id=None, client_ip=None, location=None, action_type=None, app_name=None, + country_code=None, client_machine_name=None, doc_id=None, market=None, session_id=None, + set_lang=None, user_id=None, mode=None, pre_context_text=None, post_context_text=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: text + description: 'The text string to check for spelling and grammar errors. + + The combined length of the text string, preContextText string, and + + postContextText string may not exceed 10,000 characters. You may + + specify this parameter in the query string of a GET request or in the + + body of a POST request. Because of the query string length limit, + + you''ll typically use a POST request unless you''re checking only short + + strings.' + isRequired: true + types: + - + - name: accept_language + description: 'A comma-delimited list of one or more + + languages to use for user interface strings. The list is in decreasing + + order of preference. For additional information, including expected + + format, see + + [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). + + This header and the setLang query parameter are mutually exclusive; do + + not specify both. If you set this header, you must also specify the cc + + query parameter. Bing will use the first supported language it finds + + from the list, and combine that language with the cc parameter value + + to determine the market to return results for. If the list does not + + include a supported language, Bing will find the closest language and + + market that supports the request, and may use an aggregated or default + + market for the results instead of a specified one. You should use this + + header and the cc query parameter only if you specify multiple + + languages; otherwise, you should use the mkt and setLang query + + parameters. A user interface string is a string that''s used as a label + + in a user interface. There are very few user interface strings in the + + JSON response objects. Any links in the response objects to Bing.com + + properties will apply the specified language.' + defaultValue: None + types: + - + - name: pragma + description: 'By default, Bing returns cached content, if available. + + To prevent Bing from returning cached content, set the Pragma header + + to no-cache (for example, Pragma: no-cache).' + defaultValue: None + types: + - + - name: user_agent + description: 'The user agent originating the request. Bing uses + + the user agent to provide mobile users with an optimized experience. + + Although optional, you are strongly encouraged to always specify this + + header. The user-agent should be the same string that any commonly + + used browser would send. For information about user agents, see [RFC + + 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).' + defaultValue: None + types: + - + - name: client_id + description: 'Bing uses this header to provide users with + + consistent behavior across Bing API calls. Bing often flights new + + features and improvements, and it uses the client ID as a key for + + assigning traffic on different flights. If you do not use the same + + client ID for a user across multiple requests, then Bing may assign + + the user to multiple conflicting flights. Being assigned to multiple + + conflicting flights can lead to an inconsistent user experience. For + + example, if the second request has a different flight assignment than + + the first, the experience may be unexpected. Also, Bing can use the + + client ID to tailor web results to that client ID''s search history, + + providing a richer experience for the user. Bing also uses this header + + to help improve result rankings by analyzing the activity generated by + + a client ID. The relevance improvements help with better quality of + + results delivered by Bing APIs and in turn enables higher + + click-through rates for the API consumer. IMPORTANT: Although + + optional, you should consider this header required. Persisting the + + client ID across multiple requests for the same end user and device + + combination enables 1) the API consumer to receive a consistent user + + experience, and 2) higher click-through rates via better quality of + + results from the Bing APIs. Each user that uses your application on + + the device must have a unique, Bing generated client ID. If you do not + + include this header in the request, Bing generates an ID and returns + + it in the X-MSEdge-ClientID response header. The only time that you + + should NOT include this header in a request is the first time the user + + uses your app on that device. Use the client ID for each Bing API + + request that your app makes for this user on the device. Persist the + + client ID. To persist the ID in a browser app, use a persistent HTTP + + cookie to ensure the ID is used across all sessions. Do not use a + + session cookie. For other apps such as mobile apps, use the device''s + + persistent storage to persist the ID. The next time the user uses your + + app on that device, get the client ID that you persisted. Bing + + responses may or may not include this header. If the response includes + + this header, capture the client ID and use it for all subsequent Bing + + requests for the user on that device. If you include the + + X-MSEdge-ClientID, you must not include cookies in the request.' + defaultValue: None + types: + - + - name: client_ip + description: 'The IPv4 or IPv6 address of the client device. The + + IP address is used to discover the user''s location. Bing uses the + + location information to determine safe search behavior. Although + + optional, you are encouraged to always specify this header and the + + X-Search-Location header. Do not obfuscate the address (for example, + + by changing the last octet to 0). Obfuscating the address results in + + the location not being anywhere near the device''s actual location, + + which may result in Bing serving erroneous results.' + defaultValue: None + types: + - + - name: location + description: 'A semicolon-delimited list of key/value pairs that + + describe the client''s geographical location. Bing uses the location + + information to determine safe search behavior and to return relevant + + local content. Specify the key/value pair as :. The + + following are the keys that you use to specify the user''s location. + + lat (required): The latitude of the client''s location, in degrees. The + + latitude must be greater than or equal to -90.0 and less than or equal + + to +90.0. Negative values indicate southern latitudes and positive + + values indicate northern latitudes. long (required): The longitude of + + the client''s location, in degrees. The longitude must be greater than + + or equal to -180.0 and less than or equal to +180.0. Negative values + + indicate western longitudes and positive values indicate eastern + + longitudes. re (required): The radius, in meters, which specifies the + + horizontal accuracy of the coordinates. Pass the value returned by the + + device''s location service. Typical values might be 22m for GPS/Wi-Fi, + + 380m for cell tower triangulation, and 18,000m for reverse IP lookup. + + ts (optional): The UTC UNIX timestamp of when the client was at the + + location. (The UNIX timestamp is the number of seconds since January + + 1, 1970.) head (optional): The client''s relative heading or direction + + of travel. Specify the direction of travel as degrees from 0 through + + 360, counting clockwise relative to true north. Specify this key only + + if the sp key is nonzero. sp (optional): The horizontal velocity + + (speed), in meters per second, that the client device is traveling. + + alt (optional): The altitude of the client device, in meters. are + + (optional): The radius, in meters, that specifies the vertical + + accuracy of the coordinates. Specify this key only if you specify the + + alt key. Although many of the keys are optional, the more information + + that you provide, the more accurate the location results are. Although + + optional, you are encouraged to always specify the user''s geographical + + location. Providing the location is especially important if the + + client''s IP address does not accurately reflect the user''s physical + + location (for example, if the client uses VPN). For optimal results, + + you should include this header and the X-Search-ClientIP header, but + + at a minimum, you should include this header.' + defaultValue: None + types: + - + - name: action_type + description: "A string that's used by logging to determine\nwhether the request\ + \ is coming from an interactive session or a page\nload. The following are the\ + \ possible values. 1) Edit\u2014The request is\nfrom an interactive session\ + \ 2) Load\u2014The request is from a page load.\nPossible values include: 'Edit',\ + \ 'Load'" + defaultValue: None + types: + - + - + - name: app_name + description: 'The unique name of your app. The name must be known + + by Bing. Do not include this parameter unless you have previously + + contacted Bing to get a unique app name. To get a unique name, contact + + your Bing Business Development manager.' + defaultValue: None + types: + - + - name: country_code + description: "A 2-character country code of the country where\nthe results come\ + \ from. This API supports only the United States\nmarket. If you specify this\ + \ query parameter, it must be set to us. If\nyou set this parameter, you must\ + \ also specify the Accept-Language\nheader. Bing uses the first supported language\ + \ it finds from the\nlanguages list, and combine that language with the country\ + \ code that\nyou specify to determine the market to return results for. If the\n\ + languages list does not include a supported language, Bing finds the\nclosest\ + \ language and market that supports the request, or it may use\nan aggregated\ + \ or default market for the results instead of a specified\none. You should\ + \ use this query parameter and the Accept-Language query\nparameter only if\ + \ you specify multiple languages; otherwise, you\nshould use the mkt and setLang\ + \ query parameters. This parameter and\nthe mkt query parameter are mutually\ + \ exclusive\u2014do not specify both." + defaultValue: None + types: + - + - name: client_machine_name + description: 'A unique name of the device that the + + request is being made from. Generate a unique value for each device + + (the value is unimportant). The service uses the ID to help debug + + issues and improve the quality of corrections.' + defaultValue: None + types: + - + - name: doc_id + description: 'A unique ID that identifies the document that the text + + belongs to. Generate a unique value for each document (the value is + + unimportant). The service uses the ID to help debug issues and improve + + the quality of corrections.' + defaultValue: None + types: + - + - name: market + description: "The market where the results come from. You are\nstrongly encouraged\ + \ to always specify the market, if known. Specifying\nthe market helps Bing\ + \ route the request and return an appropriate and\noptimal response. This parameter\ + \ and the cc query parameter are\nmutually exclusive\u2014do not specify both." + defaultValue: None + types: + - + - name: session_id + description: 'A unique ID that identifies this user session. + + Generate a unique value for each user session (the value is + + unimportant). The service uses the ID to help debug issues and improve + + the quality of corrections' + defaultValue: None + types: + - + - name: set_lang + description: "The language to use for user interface strings.\nSpecify the language\ + \ using the ISO 639-1 2-letter language code. For\nexample, the language code\ + \ for English is EN. The default is EN\n(English). Although optional, you should\ + \ always specify the language.\nTypically, you set setLang to the same language\ + \ specified by mkt\nunless the user wants the user interface strings displayed\ + \ in a\ndifferent language. This parameter and the Accept-Language header are\n\ + mutually exclusive\u2014do not specify both. A user interface string is a\n\ + string that's used as a label in a user interface. There are few user\ninterface\ + \ strings in the JSON response objects. Also, any links to\nBing.com properties\ + \ in the response objects apply the specified\nlanguage." + defaultValue: None + types: + - + - name: user_id + description: 'A unique ID that identifies the user. Generate a + + unique value for each user (the value is unimportant). The service + + uses the ID to help debug issues and improve the quality of + + corrections.' + defaultValue: None + types: + - + - name: mode + description: "The type of spelling and grammar checks to perform. The\nfollowing\ + \ are the possible values (the values are case insensitive).\nThe default is\ + \ Proof. 1) Proof\u2014Finds most spelling and grammar\nmistakes. 2) Spell\u2014\ + Finds most spelling mistakes but does not find some\nof the grammar errors that\ + \ Proof catches (for example, capitalization\nand repeated words). Possible\ + \ values include: 'proof', 'spell'" + defaultValue: None + types: + - + - + - name: pre_context_text + description: 'A string that gives context to the text + + string. For example, the text string petal is valid. However, if you + + set preContextText to bike, the context changes and the text string + + becomes not valid. In this case, the API suggests that you change + + petal to pedal (as in bike pedal). This text is not checked for + + grammar or spelling errors. The combined length of the text string, + + preContextText string, and postContextText string may not exceed + + 10,000 characters. You may specify this parameter in the query string + + of a GET request or in the body of a POST request.' + defaultValue: None + types: + - + - name: post_context_text + description: 'A string that gives context to the text + + string. For example, the text string read is valid. However, if you + + set postContextText to carpet, the context changes and the text string + + becomes not valid. In this case, the API suggests that you change read + + to red (as in red carpet). This text is not checked for grammar or + + spelling errors. The combined length of the text string, + + preContextText string, and postContextText string may not exceed + + 10,000 characters. You may specify this parameter in the query string + + of a GET request or in the body of a POST request.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SpellCheck or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.spellcheck.models.ErrorResponseException diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.operations.yml new file mode 100644 index 00000000..038fa772 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.operations.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.language.spellcheck.operations +name: operations +fullName: azure.cognitiveservices.language.spellcheck.operations +type: import +classes: +- azure.cognitiveservices.language.spellcheck.operations.SpellCheckClientOperationsMixin diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.version.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.version.yml new file mode 100644 index 00000000..1da8cfa8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.spellcheck.version +name: version +fullName: azure.cognitiveservices.language.spellcheck.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.yml new file mode 100644 index 00000000..b79d378b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-spellcheck/azure.cognitiveservices.language.spellcheck.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.language.spellcheck +name: spellcheck +fullName: azure.cognitiveservices.language.spellcheck +type: rootImport +classes: +- azure.cognitiveservices.language.spellcheck.SpellCheckClient +- azure.cognitiveservices.language.spellcheck.SpellCheckClientConfiguration +packages: +- azure.cognitiveservices.language.spellcheck.models +- azure.cognitiveservices.language.spellcheck.operations +modules: +- azure.cognitiveservices.language.spellcheck.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.TextAnalyticsClient.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.TextAnalyticsClient.yml new file mode 100644 index 00000000..0952301c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.TextAnalyticsClient.yml @@ -0,0 +1,244 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.TextAnalyticsClient +name: TextAnalyticsClient +fullName: azure.cognitiveservices.language.textanalytics.TextAnalyticsClient +module: azure.cognitiveservices.language.textanalytics +summary: The Text Analytics API is a suite of text analytics web services built with + best-in-class Microsoft machine learning algorithms. The API can be used to analyze + unstructured text for tasks such as sentiment analysis, key phrase extraction and + language detection. No training data is needed to use this API; just bring your + text data. This API uses advanced natural language processing techniques to deliver + best in class predictions. Further documentation can be found in [https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview](https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview) +constructor: + syntax: TextAnalyticsClient(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and + + hostname, for example: [https://westus.api.cognitive.microsoft.com](https://westus.api.cognitive.microsoft.com)).' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.TextAnalyticsClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None +- uid: azure.cognitiveservices.language.textanalytics.TextAnalyticsClient.detect_language + name: detect_language + summary: 'The API returns the detected language and a numeric score between 0 and + + 1. + + + Scores close to 1 indicate 100% certainty that the identified language + + is true. A total of 120 languages are supported.' + signature: detect_language(show_stats=None, documents=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: show_stats + description: '(optional) if set to true, response will contain + + input and document level statistics.' + defaultValue: None + types: + - + - name: documents + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: LanguageBatchResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.textanalytics.models.ErrorResponseException +- uid: azure.cognitiveservices.language.textanalytics.TextAnalyticsClient.entities + name: entities + summary: 'The API returns a list of recognized entities in a given document. + + + To get even more information on each recognized entity we recommend + + using the Bing Entity Search API by querying for the recognized + + entities names. See the Supported + + languages in Text Analytics API for the list of enabled languages.' + signature: entities(show_stats=None, documents=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: show_stats + description: '(optional) if set to true, response will contain + + input and document level statistics.' + defaultValue: None + types: + - + - name: documents + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: EntitiesBatchResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.textanalytics.models.ErrorResponseException +- uid: azure.cognitiveservices.language.textanalytics.TextAnalyticsClient.key_phrases + name: key_phrases + summary: 'The API returns a list of strings denoting the key talking points in + + the input text. + + + See the Text + + Analytics Documentation for details about the languages that are + + supported by key phrase extraction.' + signature: key_phrases(show_stats=None, documents=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: show_stats + description: '(optional) if set to true, response will contain + + input and document level statistics.' + defaultValue: None + types: + - + - name: documents + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyPhraseBatchResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.textanalytics.models.ErrorResponseException +- uid: azure.cognitiveservices.language.textanalytics.TextAnalyticsClient.sentiment + name: sentiment + summary: 'The API returns a numeric score between 0 and 1. + + + Scores close to 1 indicate positive sentiment, while scores close to 0 + + indicate negative sentiment. A score of 0.5 indicates the lack of + + sentiment (e.g. a factoid statement). See the Text + + Analytics Documentation for details about the languages that are + + supported by sentiment analysis.' + signature: sentiment(show_stats=None, documents=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: show_stats + description: '(optional) if set to true, response will contain + + input and document level statistics.' + defaultValue: None + types: + - + - name: documents + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: object or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrest.exceptions.HttpOperationError diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.DetectedLanguage.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.DetectedLanguage.yml new file mode 100644 index 00000000..32edc585 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.DetectedLanguage.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.DetectedLanguage +name: DetectedLanguage +fullName: azure.cognitiveservices.language.textanalytics.models.DetectedLanguage +module: azure.cognitiveservices.language.textanalytics.models +summary: DetectedLanguage. +constructor: + syntax: 'DetectedLanguage(*, name: str = None, iso6391_name: str = None, score: + float = None, **kwargs)' + parameters: + - name: name + description: Long name of a detected language (e.g. English, French). + isRequired: true + types: + - + - name: iso6391_name + description: 'A two letter representation of the detected language + + according to the ISO 639-1 standard (e.g. en, fr).' + isRequired: true + types: + - + - name: score + description: 'A confidence score between 0 and 1. Scores close to 1 + + indicate 100% certainty that the identified language is true.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: iso6391_name + isRequired: true + - name: score + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.DetectedLanguage.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.DetectedLanguage.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.DetectedLanguage.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.DetectedLanguage.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.DetectedLanguage.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.DetectedLanguage.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.DetectedLanguage.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.DocumentStatistics.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.DocumentStatistics.yml new file mode 100644 index 00000000..d5892ad6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.DocumentStatistics.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.DocumentStatistics +name: DocumentStatistics +fullName: azure.cognitiveservices.language.textanalytics.models.DocumentStatistics +module: azure.cognitiveservices.language.textanalytics.models +summary: DocumentStatistics. +constructor: + syntax: 'DocumentStatistics(*, characters_count: int = None, transactions_count: + int = None, **kwargs)' + parameters: + - name: characters_count + description: 'Number of text elements recognized in the + + document.' + isRequired: true + types: + - + - name: transactions_count + description: Number of transactions for the document. + isRequired: true + types: + - + keywordOnlyParameters: + - name: characters_count + isRequired: true + - name: transactions_count + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.DocumentStatistics.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.DocumentStatistics.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.DocumentStatistics.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.DocumentStatistics.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.DocumentStatistics.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.DocumentStatistics.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.DocumentStatistics.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResult.yml new file mode 100644 index 00000000..06025e31 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResult.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResult +name: EntitiesBatchResult +fullName: azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResult +module: azure.cognitiveservices.language.textanalytics.models +summary: 'EntitiesBatchResult. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: EntitiesBatchResult(**kwargs) +variables: +- description: Response by document + name: documents + types: + - [] +- description: Errors and Warnings by document + name: errors + types: + - [] +- description: '(Optional) if showStats=true was specified in the + + request this field will contain information about the request payload.' + name: statistics + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResultItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResultItem.yml new file mode 100644 index 00000000..0ab86065 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResultItem.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResultItem +name: EntitiesBatchResultItem +fullName: azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResultItem +module: azure.cognitiveservices.language.textanalytics.models +summary: 'EntitiesBatchResultItem. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'EntitiesBatchResultItem(*, id: str = None, statistics=None, **kwargs)' + parameters: + - name: id + description: Unique, non-empty document identifier. + isRequired: true + types: + - + - name: statistics + description: '(Optional) if showStats=true was specified in the + + request this field will contain information about the document payload.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: statistics + isRequired: true +variables: +- description: Recognized entities in the document. + name: entities + types: + - [] +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResultItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResultItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResultItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResultItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResultItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResultItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResultItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.EntityRecord.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.EntityRecord.yml new file mode 100644 index 00000000..31074f89 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.EntityRecord.yml @@ -0,0 +1,183 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.EntityRecord +name: EntityRecord +fullName: azure.cognitiveservices.language.textanalytics.models.EntityRecord +module: azure.cognitiveservices.language.textanalytics.models +summary: 'EntityRecord. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'EntityRecord(*, name: str = None, matches=None, wikipedia_language: str + = None, wikipedia_id: str = None, bing_id: str = None, type: str = None, sub_type: + str = None, **kwargs)' + parameters: + - name: name + description: Entity formal name. + isRequired: true + types: + - + - name: matches + description: List of instances this entity appears in the text. + isRequired: true + types: + - [] + - name: wikipedia_language + description: 'Wikipedia language for which the WikipediaId + + and WikipediaUrl refers to.' + isRequired: true + types: + - + - name: wikipedia_id + description: Wikipedia unique identifier of the recognized entity. + isRequired: true + types: + - + - name: bing_id + description: 'Bing unique identifier of the recognized entity. Use in + + conjunction with the Bing Entity Search API to fetch additional relevant + + information.' + isRequired: true + types: + - + - name: type + description: Entity type from Named Entity Recognition model + isRequired: true + types: + - + - name: sub_type + description: Entity sub type from Named Entity Recognition model + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: matches + isRequired: true + - name: wikipedia_language + isRequired: true + - name: wikipedia_id + isRequired: true + - name: bing_id + isRequired: true + - name: type + isRequired: true + - name: sub_type + isRequired: true +variables: +- description: URL for the entity's Wikipedia page. + name: wikipedia_url + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.EntityRecord.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.EntityRecord.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.EntityRecord.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.EntityRecord.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.EntityRecord.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.EntityRecord.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.EntityRecord.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.ErrorRecord.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.ErrorRecord.yml new file mode 100644 index 00000000..4dde016b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.ErrorRecord.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.ErrorRecord +name: ErrorRecord +fullName: azure.cognitiveservices.language.textanalytics.models.ErrorRecord +module: azure.cognitiveservices.language.textanalytics.models +summary: ErrorRecord. +constructor: + syntax: 'ErrorRecord(*, id: str = None, message: str = None, **kwargs)' + parameters: + - name: id + description: Input document unique identifier the error refers to. + isRequired: true + types: + - + - name: message + description: Error message. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: message + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.ErrorRecord.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.ErrorRecord.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.ErrorRecord.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.ErrorRecord.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.ErrorRecord.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.ErrorRecord.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.ErrorRecord.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.ErrorResponse.yml new file mode 100644 index 00000000..c1b42042 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.ErrorResponse.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.ErrorResponse +name: ErrorResponse +fullName: azure.cognitiveservices.language.textanalytics.models.ErrorResponse +module: azure.cognitiveservices.language.textanalytics.models +summary: ErrorResponse. +constructor: + syntax: 'ErrorResponse(*, code: str = None, message: str = None, target: str = None, + inner_error=None, **kwargs)' + parameters: + - name: code + isRequired: true + types: + - + - name: message + isRequired: true + types: + - + - name: target + isRequired: true + types: + - + - name: inner_error + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true + - name: target + isRequired: true + - name: inner_error + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.ErrorResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.ErrorResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.ErrorResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.ErrorResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.ErrorResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.ErrorResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.ErrorResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.ErrorResponseException.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.ErrorResponseException.yml new file mode 100644 index 00000000..073b39be --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.ErrorResponseException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.ErrorResponseException +name: ErrorResponseException +fullName: azure.cognitiveservices.language.textanalytics.models.ErrorResponseException +module: azure.cognitiveservices.language.textanalytics.models +summary: 'Server responded with exception of type: ''ErrorResponse''.' +constructor: + syntax: ErrorResponseException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.ErrorResponseException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cognitiveservices.language.textanalytics.models.ErrorResponseException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cognitiveservices.language.textanalytics.models.ErrorResponseException.args + name: args diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.InternalError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.InternalError.yml new file mode 100644 index 00000000..fdc654e8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.InternalError.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.InternalError +name: InternalError +fullName: azure.cognitiveservices.language.textanalytics.models.InternalError +module: azure.cognitiveservices.language.textanalytics.models +summary: InternalError. +constructor: + syntax: 'InternalError(*, code: str = None, message: str = None, inner_error=None, + **kwargs)' + parameters: + - name: code + isRequired: true + types: + - + - name: message + isRequired: true + types: + - + - name: inner_error + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true + - name: inner_error + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.InternalError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.InternalError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.InternalError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.InternalError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.InternalError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.InternalError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.InternalError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult.yml new file mode 100644 index 00000000..f20aedff --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult +name: KeyPhraseBatchResult +fullName: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult +module: azure.cognitiveservices.language.textanalytics.models +summary: 'KeyPhraseBatchResult. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyPhraseBatchResult(**kwargs) +variables: +- description: Response by document + name: documents + types: + - [] +- description: Errors and Warnings by document + name: errors + types: + - [] +- description: '=(Optional) if showStats=true was specified in the + + request this field will contain information about the request payload.' + name: statistics + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResultItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResultItem.yml new file mode 100644 index 00000000..307e2316 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResultItem.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResultItem +name: KeyPhraseBatchResultItem +fullName: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResultItem +module: azure.cognitiveservices.language.textanalytics.models +summary: 'KeyPhraseBatchResultItem. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'KeyPhraseBatchResultItem(*, id: str = None, statistics=None, **kwargs)' + parameters: + - name: id + description: Unique, non-empty document identifier. + isRequired: true + types: + - + - name: statistics + description: '(Optional) if showStats=true was specified in the + + request this field will contain information about the document payload.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: statistics + isRequired: true +variables: +- description: 'A list of representative words or phrases. The number + + of key phrases returned is proportional to the number of words in the + + input document.' + name: key_phrases + types: + - [] +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResultItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResultItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResultItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResultItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResultItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResultItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResultItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageBatchInput.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageBatchInput.yml new file mode 100644 index 00000000..41d2c896 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageBatchInput.yml @@ -0,0 +1,122 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchInput +name: LanguageBatchInput +fullName: azure.cognitiveservices.language.textanalytics.models.LanguageBatchInput +module: azure.cognitiveservices.language.textanalytics.models +summary: LanguageBatchInput. +constructor: + syntax: LanguageBatchInput(*, documents=None, **kwargs) + parameters: + - name: documents + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: documents + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchInput.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchInput.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchInput.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchInput.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchInput.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchInput.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchInput.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageBatchResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageBatchResult.yml new file mode 100644 index 00000000..438d7017 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageBatchResult.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchResult +name: LanguageBatchResult +fullName: azure.cognitiveservices.language.textanalytics.models.LanguageBatchResult +module: azure.cognitiveservices.language.textanalytics.models +summary: 'LanguageBatchResult. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: LanguageBatchResult(**kwargs) +variables: +- description: Response by document + name: documents + types: + - [] +- description: Errors and Warnings by document + name: errors + types: + - [] +- description: '(Optional) if showStats=true was specified in the + + request this field will contain information about the request payload.' + name: statistics + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageBatchResultItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageBatchResultItem.yml new file mode 100644 index 00000000..216a623d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageBatchResultItem.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchResultItem +name: LanguageBatchResultItem +fullName: azure.cognitiveservices.language.textanalytics.models.LanguageBatchResultItem +module: azure.cognitiveservices.language.textanalytics.models +summary: LanguageBatchResultItem. +constructor: + syntax: 'LanguageBatchResultItem(*, id: str = None, detected_languages=None, statistics=None, + **kwargs)' + parameters: + - name: id + description: Unique, non-empty document identifier. + isRequired: true + types: + - + - name: detected_languages + description: A list of extracted languages. + isRequired: true + types: + - [] + - name: statistics + description: '(Optional) if showStats=true was specified in the + + request this field will contain information about the document payload.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: detected_languages + isRequired: true + - name: statistics + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchResultItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchResultItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchResultItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchResultItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchResultItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchResultItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchResultItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageInput.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageInput.yml new file mode 100644 index 00000000..b04e716a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageInput.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.LanguageInput +name: LanguageInput +fullName: azure.cognitiveservices.language.textanalytics.models.LanguageInput +module: azure.cognitiveservices.language.textanalytics.models +summary: LanguageInput. +constructor: + syntax: 'LanguageInput(*, country_hint: str = None, id: str = None, text: str = + None, **kwargs)' + parameters: + - name: country_hint + isRequired: true + types: + - + - name: id + description: Unique, non-empty document identifier. + isRequired: true + types: + - + - name: text + isRequired: true + types: + - + keywordOnlyParameters: + - name: country_hint + isRequired: true + - name: id + isRequired: true + - name: text + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageInput.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageInput.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageInput.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageInput.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageInput.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageInput.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.LanguageInput.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MatchRecord.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MatchRecord.yml new file mode 100644 index 00000000..076077c1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MatchRecord.yml @@ -0,0 +1,162 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.MatchRecord +name: MatchRecord +fullName: azure.cognitiveservices.language.textanalytics.models.MatchRecord +module: azure.cognitiveservices.language.textanalytics.models +summary: MatchRecord. +constructor: + syntax: 'MatchRecord(*, wikipedia_score: float = None, entity_type_score: float + = None, text: str = None, offset: int = None, length: int = None, **kwargs)' + parameters: + - name: wikipedia_score + description: '(optional) If a well-known item with Wikipedia + + link is recognized, a decimal number denoting the confidence level of the + + Wikipedia info will be returned.' + isRequired: true + types: + - + - name: entity_type_score + description: '(optional) If an entity type is recognized, a + + decimal number denoting the confidence level of the entity type will be + + returned.' + isRequired: true + types: + - + - name: text + description: Entity text as appears in the request. + isRequired: true + types: + - + - name: offset + description: 'Start position (in Unicode characters) for the entity match + + text.' + isRequired: true + types: + - + - name: length + description: Length (in Unicode characters) for the entity match text. + isRequired: true + types: + - + keywordOnlyParameters: + - name: wikipedia_score + isRequired: true + - name: entity_type_score + isRequired: true + - name: text + isRequired: true + - name: offset + isRequired: true + - name: length + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.MatchRecord.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.MatchRecord.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.MatchRecord.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.MatchRecord.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.MatchRecord.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.MatchRecord.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.MatchRecord.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MultiLanguageBatchInput.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MultiLanguageBatchInput.yml new file mode 100644 index 00000000..db3b54cd --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MultiLanguageBatchInput.yml @@ -0,0 +1,122 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.MultiLanguageBatchInput +name: MultiLanguageBatchInput +fullName: azure.cognitiveservices.language.textanalytics.models.MultiLanguageBatchInput +module: azure.cognitiveservices.language.textanalytics.models +summary: MultiLanguageBatchInput. +constructor: + syntax: MultiLanguageBatchInput(*, documents=None, **kwargs) + parameters: + - name: documents + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: documents + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.MultiLanguageBatchInput.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.MultiLanguageBatchInput.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.MultiLanguageBatchInput.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.MultiLanguageBatchInput.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.MultiLanguageBatchInput.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.MultiLanguageBatchInput.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.MultiLanguageBatchInput.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MultiLanguageInput.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MultiLanguageInput.yml new file mode 100644 index 00000000..9005a8dd --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MultiLanguageInput.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.MultiLanguageInput +name: MultiLanguageInput +fullName: azure.cognitiveservices.language.textanalytics.models.MultiLanguageInput +module: azure.cognitiveservices.language.textanalytics.models +summary: MultiLanguageInput. +constructor: + syntax: 'MultiLanguageInput(*, language: str = None, id: str = None, text: str = + None, **kwargs)' + parameters: + - name: language + description: 'This is the 2 letter ISO 639-1 representation of a + + language. For example, use "en" for English; "es" for Spanish etc.,' + isRequired: true + types: + - + - name: id + description: Unique, non-empty document identifier. + isRequired: true + types: + - + - name: text + isRequired: true + types: + - + keywordOnlyParameters: + - name: language + isRequired: true + - name: id + isRequired: true + - name: text + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.MultiLanguageInput.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.MultiLanguageInput.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.MultiLanguageInput.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.MultiLanguageInput.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.MultiLanguageInput.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.MultiLanguageInput.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.MultiLanguageInput.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.RequestStatistics.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.RequestStatistics.yml new file mode 100644 index 00000000..789dceb5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.RequestStatistics.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.RequestStatistics +name: RequestStatistics +fullName: azure.cognitiveservices.language.textanalytics.models.RequestStatistics +module: azure.cognitiveservices.language.textanalytics.models +summary: RequestStatistics. +constructor: + syntax: 'RequestStatistics(*, documents_count: int = None, valid_documents_count: + int = None, erroneous_documents_count: int = None, transactions_count: int = None, + **kwargs)' + parameters: + - name: documents_count + description: Number of documents submitted in the request. + isRequired: true + types: + - + - name: valid_documents_count + description: 'Number of valid documents. This excludes + + empty, over-size limit or non-supported languages documents.' + isRequired: true + types: + - + - name: erroneous_documents_count + description: 'Number of invalid documents. This + + includes empty, over-size limit or non-supported languages documents.' + isRequired: true + types: + - + - name: transactions_count + description: Number of transactions for the request. + isRequired: true + types: + - + keywordOnlyParameters: + - name: documents_count + isRequired: true + - name: valid_documents_count + isRequired: true + - name: erroneous_documents_count + isRequired: true + - name: transactions_count + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.RequestStatistics.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.RequestStatistics.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.RequestStatistics.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.RequestStatistics.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.RequestStatistics.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.RequestStatistics.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.RequestStatistics.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.SentimentBatchResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.SentimentBatchResult.yml new file mode 100644 index 00000000..19946ad5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.SentimentBatchResult.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.SentimentBatchResult +name: SentimentBatchResult +fullName: azure.cognitiveservices.language.textanalytics.models.SentimentBatchResult +module: azure.cognitiveservices.language.textanalytics.models +summary: 'SentimentBatchResult. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SentimentBatchResult(**kwargs) +variables: +- description: Response by document + name: documents + types: + - [] +- description: Errors and Warnings by document + name: errors + types: + - [] +- description: '(Optional) if showStats=true was specified in the + + request this field will contain information about the request payload.' + name: statistics + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.SentimentBatchResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.SentimentBatchResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.SentimentBatchResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.SentimentBatchResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.SentimentBatchResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.SentimentBatchResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.SentimentBatchResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.SentimentBatchResultItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.SentimentBatchResultItem.yml new file mode 100644 index 00000000..8c646f5e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.SentimentBatchResultItem.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.SentimentBatchResultItem +name: SentimentBatchResultItem +fullName: azure.cognitiveservices.language.textanalytics.models.SentimentBatchResultItem +module: azure.cognitiveservices.language.textanalytics.models +summary: SentimentBatchResultItem. +constructor: + syntax: 'SentimentBatchResultItem(*, id: str = None, score: float = None, statistics=None, + **kwargs)' + parameters: + - name: id + description: Unique, non-empty document identifier. + isRequired: true + types: + - + - name: score + description: 'A decimal number between 0 and 1 denoting the sentiment of + + the document. A score above 0.7 usually refers to a positive document + + while a score below 0.3 normally has a negative connotation. Mid values + + refer to neutral text.' + isRequired: true + types: + - + - name: statistics + description: '(Optional) if showStats=true was specified in the + + request this field will contain information about the document payload.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: score + isRequired: true + - name: statistics + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.SentimentBatchResultItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.SentimentBatchResultItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.SentimentBatchResultItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.SentimentBatchResultItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.SentimentBatchResultItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.SentimentBatchResultItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.SentimentBatchResultItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.detected_language.DetectedLanguage.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.detected_language.DetectedLanguage.yml new file mode 100644 index 00000000..1e1c5691 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.detected_language.DetectedLanguage.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.detected_language.DetectedLanguage +name: DetectedLanguage +fullName: azure.cognitiveservices.language.textanalytics.models.detected_language.DetectedLanguage +module: azure.cognitiveservices.language.textanalytics.models.detected_language +summary: DetectedLanguage. +constructor: + syntax: DetectedLanguage(**kwargs) + parameters: + - name: name + description: Long name of a detected language (e.g. English, French). + isRequired: true + types: + - + - name: iso6391_name + description: 'A two letter representation of the detected language + + according to the ISO 639-1 standard (e.g. en, fr).' + isRequired: true + types: + - + - name: score + description: 'A confidence score between 0 and 1. Scores close to 1 + + indicate 100% certainty that the identified language is true.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.detected_language.DetectedLanguage.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.detected_language.DetectedLanguage.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.detected_language.DetectedLanguage.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.detected_language.DetectedLanguage.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.detected_language.DetectedLanguage.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.detected_language.DetectedLanguage.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.detected_language.DetectedLanguage.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.detected_language.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.detected_language.yml new file mode 100644 index 00000000..73177260 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.detected_language.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.detected_language +name: detected_language +fullName: azure.cognitiveservices.language.textanalytics.models.detected_language +classes: +- azure.cognitiveservices.language.textanalytics.models.detected_language.DetectedLanguage diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.detected_language_py3.DetectedLanguage.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.detected_language_py3.DetectedLanguage.yml new file mode 100644 index 00000000..49f9dfc3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.detected_language_py3.DetectedLanguage.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.detected_language_py3.DetectedLanguage +name: DetectedLanguage +fullName: azure.cognitiveservices.language.textanalytics.models.detected_language_py3.DetectedLanguage +module: azure.cognitiveservices.language.textanalytics.models.detected_language_py3 +summary: DetectedLanguage. +constructor: + syntax: 'DetectedLanguage(*, name: str = None, iso6391_name: str = None, score: + float = None, **kwargs)' + parameters: + - name: name + description: Long name of a detected language (e.g. English, French). + isRequired: true + types: + - + - name: iso6391_name + description: 'A two letter representation of the detected language + + according to the ISO 639-1 standard (e.g. en, fr).' + isRequired: true + types: + - + - name: score + description: 'A confidence score between 0 and 1. Scores close to 1 + + indicate 100% certainty that the identified language is true.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: iso6391_name + isRequired: true + - name: score + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.detected_language_py3.DetectedLanguage.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.detected_language_py3.DetectedLanguage.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.detected_language_py3.DetectedLanguage.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.detected_language_py3.DetectedLanguage.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.detected_language_py3.DetectedLanguage.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.detected_language_py3.DetectedLanguage.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.detected_language_py3.DetectedLanguage.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.detected_language_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.detected_language_py3.yml new file mode 100644 index 00000000..eb1c6799 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.detected_language_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.detected_language_py3 +name: detected_language_py3 +fullName: azure.cognitiveservices.language.textanalytics.models.detected_language_py3 +classes: +- azure.cognitiveservices.language.textanalytics.models.detected_language_py3.DetectedLanguage diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.document_statistics.DocumentStatistics.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.document_statistics.DocumentStatistics.yml new file mode 100644 index 00000000..9dc310df --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.document_statistics.DocumentStatistics.yml @@ -0,0 +1,127 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.document_statistics.DocumentStatistics +name: DocumentStatistics +fullName: azure.cognitiveservices.language.textanalytics.models.document_statistics.DocumentStatistics +module: azure.cognitiveservices.language.textanalytics.models.document_statistics +summary: DocumentStatistics. +constructor: + syntax: DocumentStatistics(**kwargs) + parameters: + - name: characters_count + description: 'Number of text elements recognized in the + + document.' + isRequired: true + types: + - + - name: transactions_count + description: Number of transactions for the document. + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.document_statistics.DocumentStatistics.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.document_statistics.DocumentStatistics.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.document_statistics.DocumentStatistics.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.document_statistics.DocumentStatistics.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.document_statistics.DocumentStatistics.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.document_statistics.DocumentStatistics.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.document_statistics.DocumentStatistics.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.document_statistics.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.document_statistics.yml new file mode 100644 index 00000000..1465d796 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.document_statistics.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.document_statistics +name: document_statistics +fullName: azure.cognitiveservices.language.textanalytics.models.document_statistics +classes: +- azure.cognitiveservices.language.textanalytics.models.document_statistics.DocumentStatistics diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.DocumentStatistics.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.DocumentStatistics.yml new file mode 100644 index 00000000..47d4ecfa --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.DocumentStatistics.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.DocumentStatistics +name: DocumentStatistics +fullName: azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.DocumentStatistics +module: azure.cognitiveservices.language.textanalytics.models.document_statistics_py3 +summary: DocumentStatistics. +constructor: + syntax: 'DocumentStatistics(*, characters_count: int = None, transactions_count: + int = None, **kwargs)' + parameters: + - name: characters_count + description: 'Number of text elements recognized in the + + document.' + isRequired: true + types: + - + - name: transactions_count + description: Number of transactions for the document. + isRequired: true + types: + - + keywordOnlyParameters: + - name: characters_count + isRequired: true + - name: transactions_count + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.DocumentStatistics.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.DocumentStatistics.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.DocumentStatistics.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.DocumentStatistics.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.DocumentStatistics.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.DocumentStatistics.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.DocumentStatistics.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.yml new file mode 100644 index 00000000..f1c51fe0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.document_statistics_py3 +name: document_statistics_py3 +fullName: azure.cognitiveservices.language.textanalytics.models.document_statistics_py3 +classes: +- azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.DocumentStatistics diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result.EntitiesBatchResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result.EntitiesBatchResult.yml new file mode 100644 index 00000000..14b07241 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result.EntitiesBatchResult.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result.EntitiesBatchResult +name: EntitiesBatchResult +fullName: azure.cognitiveservices.language.textanalytics.models.entities_batch_result.EntitiesBatchResult +module: azure.cognitiveservices.language.textanalytics.models.entities_batch_result +summary: 'EntitiesBatchResult. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: EntitiesBatchResult(**kwargs) +variables: +- description: Response by document + name: documents + types: + - [] +- description: Errors and Warnings by document + name: errors + types: + - [] +- description: '(Optional) if showStats=true was specified in the + + request this field will contain information about the request payload.' + name: statistics + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result.EntitiesBatchResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result.EntitiesBatchResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result.EntitiesBatchResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result.EntitiesBatchResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result.EntitiesBatchResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result.EntitiesBatchResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result.EntitiesBatchResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result.yml new file mode 100644 index 00000000..ef199a9d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result +name: entities_batch_result +fullName: azure.cognitiveservices.language.textanalytics.models.entities_batch_result +classes: +- azure.cognitiveservices.language.textanalytics.models.entities_batch_result.EntitiesBatchResult diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item.EntitiesBatchResultItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item.EntitiesBatchResultItem.yml new file mode 100644 index 00000000..8aff789a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item.EntitiesBatchResultItem.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item.EntitiesBatchResultItem +name: EntitiesBatchResultItem +fullName: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item.EntitiesBatchResultItem +module: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item +summary: 'EntitiesBatchResultItem. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: EntitiesBatchResultItem(**kwargs) + parameters: + - name: id + description: Unique, non-empty document identifier. + isRequired: true + types: + - + - name: statistics + description: '(Optional) if showStats=true was specified in the + + request this field will contain information about the document payload.' + isRequired: true + types: + - +variables: +- description: Recognized entities in the document. + name: entities + types: + - [] +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item.EntitiesBatchResultItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item.EntitiesBatchResultItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item.EntitiesBatchResultItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item.EntitiesBatchResultItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item.EntitiesBatchResultItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item.EntitiesBatchResultItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item.EntitiesBatchResultItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item.yml new file mode 100644 index 00000000..0dcbf075 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item +name: entities_batch_result_item +fullName: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item +classes: +- azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item.EntitiesBatchResultItem diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3.EntitiesBatchResultItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3.EntitiesBatchResultItem.yml new file mode 100644 index 00000000..c091fcc5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3.EntitiesBatchResultItem.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3.EntitiesBatchResultItem +name: EntitiesBatchResultItem +fullName: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3.EntitiesBatchResultItem +module: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3 +summary: 'EntitiesBatchResultItem. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'EntitiesBatchResultItem(*, id: str = None, statistics=None, **kwargs)' + parameters: + - name: id + description: Unique, non-empty document identifier. + isRequired: true + types: + - + - name: statistics + description: '(Optional) if showStats=true was specified in the + + request this field will contain information about the document payload.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: statistics + isRequired: true +variables: +- description: Recognized entities in the document. + name: entities + types: + - [] +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3.EntitiesBatchResultItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3.EntitiesBatchResultItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3.EntitiesBatchResultItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3.EntitiesBatchResultItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3.EntitiesBatchResultItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3.EntitiesBatchResultItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3.EntitiesBatchResultItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3.yml new file mode 100644 index 00000000..15764a29 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3 +name: entities_batch_result_item_py3 +fullName: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3 +classes: +- azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3.EntitiesBatchResultItem diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3.EntitiesBatchResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3.EntitiesBatchResult.yml new file mode 100644 index 00000000..85397efc --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3.EntitiesBatchResult.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3.EntitiesBatchResult +name: EntitiesBatchResult +fullName: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3.EntitiesBatchResult +module: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3 +summary: 'EntitiesBatchResult. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: EntitiesBatchResult(**kwargs) +variables: +- description: Response by document + name: documents + types: + - [] +- description: Errors and Warnings by document + name: errors + types: + - [] +- description: '(Optional) if showStats=true was specified in the + + request this field will contain information about the request payload.' + name: statistics + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3.EntitiesBatchResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3.EntitiesBatchResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3.EntitiesBatchResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3.EntitiesBatchResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3.EntitiesBatchResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3.EntitiesBatchResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3.EntitiesBatchResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3.yml new file mode 100644 index 00000000..351d6764 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3 +name: entities_batch_result_py3 +fullName: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3 +classes: +- azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3.EntitiesBatchResult diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entity_record.EntityRecord.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entity_record.EntityRecord.yml new file mode 100644 index 00000000..a511b462 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entity_record.EntityRecord.yml @@ -0,0 +1,166 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.entity_record.EntityRecord +name: EntityRecord +fullName: azure.cognitiveservices.language.textanalytics.models.entity_record.EntityRecord +module: azure.cognitiveservices.language.textanalytics.models.entity_record +summary: 'EntityRecord. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: EntityRecord(**kwargs) + parameters: + - name: name + description: Entity formal name. + isRequired: true + types: + - + - name: matches + description: List of instances this entity appears in the text. + isRequired: true + types: + - [] + - name: wikipedia_language + description: 'Wikipedia language for which the WikipediaId + + and WikipediaUrl refers to.' + isRequired: true + types: + - + - name: wikipedia_id + description: Wikipedia unique identifier of the recognized entity. + isRequired: true + types: + - + - name: bing_id + description: 'Bing unique identifier of the recognized entity. Use in + + conjunction with the Bing Entity Search API to fetch additional relevant + + information.' + isRequired: true + types: + - + - name: type + description: Entity type from Named Entity Recognition model + isRequired: true + types: + - + - name: sub_type + description: Entity sub type from Named Entity Recognition model + isRequired: true + types: + - +variables: +- description: URL for the entity's Wikipedia page. + name: wikipedia_url + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.entity_record.EntityRecord.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.entity_record.EntityRecord.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.entity_record.EntityRecord.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.entity_record.EntityRecord.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.entity_record.EntityRecord.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.entity_record.EntityRecord.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.entity_record.EntityRecord.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entity_record.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entity_record.yml new file mode 100644 index 00000000..1b5a158c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entity_record.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.entity_record +name: entity_record +fullName: azure.cognitiveservices.language.textanalytics.models.entity_record +classes: +- azure.cognitiveservices.language.textanalytics.models.entity_record.EntityRecord diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entity_record_py3.EntityRecord.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entity_record_py3.EntityRecord.yml new file mode 100644 index 00000000..80d133de --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entity_record_py3.EntityRecord.yml @@ -0,0 +1,183 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.entity_record_py3.EntityRecord +name: EntityRecord +fullName: azure.cognitiveservices.language.textanalytics.models.entity_record_py3.EntityRecord +module: azure.cognitiveservices.language.textanalytics.models.entity_record_py3 +summary: 'EntityRecord. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'EntityRecord(*, name: str = None, matches=None, wikipedia_language: str + = None, wikipedia_id: str = None, bing_id: str = None, type: str = None, sub_type: + str = None, **kwargs)' + parameters: + - name: name + description: Entity formal name. + isRequired: true + types: + - + - name: matches + description: List of instances this entity appears in the text. + isRequired: true + types: + - [] + - name: wikipedia_language + description: 'Wikipedia language for which the WikipediaId + + and WikipediaUrl refers to.' + isRequired: true + types: + - + - name: wikipedia_id + description: Wikipedia unique identifier of the recognized entity. + isRequired: true + types: + - + - name: bing_id + description: 'Bing unique identifier of the recognized entity. Use in + + conjunction with the Bing Entity Search API to fetch additional relevant + + information.' + isRequired: true + types: + - + - name: type + description: Entity type from Named Entity Recognition model + isRequired: true + types: + - + - name: sub_type + description: Entity sub type from Named Entity Recognition model + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: matches + isRequired: true + - name: wikipedia_language + isRequired: true + - name: wikipedia_id + isRequired: true + - name: bing_id + isRequired: true + - name: type + isRequired: true + - name: sub_type + isRequired: true +variables: +- description: URL for the entity's Wikipedia page. + name: wikipedia_url + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.entity_record_py3.EntityRecord.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.entity_record_py3.EntityRecord.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.entity_record_py3.EntityRecord.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.entity_record_py3.EntityRecord.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.entity_record_py3.EntityRecord.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.entity_record_py3.EntityRecord.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.entity_record_py3.EntityRecord.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entity_record_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entity_record_py3.yml new file mode 100644 index 00000000..c4782576 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entity_record_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.entity_record_py3 +name: entity_record_py3 +fullName: azure.cognitiveservices.language.textanalytics.models.entity_record_py3 +classes: +- azure.cognitiveservices.language.textanalytics.models.entity_record_py3.EntityRecord diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_record.ErrorRecord.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_record.ErrorRecord.yml new file mode 100644 index 00000000..c3102c88 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_record.ErrorRecord.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.error_record.ErrorRecord +name: ErrorRecord +fullName: azure.cognitiveservices.language.textanalytics.models.error_record.ErrorRecord +module: azure.cognitiveservices.language.textanalytics.models.error_record +summary: ErrorRecord. +constructor: + syntax: ErrorRecord(**kwargs) + parameters: + - name: id + description: Input document unique identifier the error refers to. + isRequired: true + types: + - + - name: message + description: Error message. + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.error_record.ErrorRecord.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.error_record.ErrorRecord.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.error_record.ErrorRecord.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.error_record.ErrorRecord.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.error_record.ErrorRecord.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.error_record.ErrorRecord.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.error_record.ErrorRecord.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_record.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_record.yml new file mode 100644 index 00000000..74be874b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_record.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.error_record +name: error_record +fullName: azure.cognitiveservices.language.textanalytics.models.error_record +classes: +- azure.cognitiveservices.language.textanalytics.models.error_record.ErrorRecord diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_record_py3.ErrorRecord.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_record_py3.ErrorRecord.yml new file mode 100644 index 00000000..17e20459 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_record_py3.ErrorRecord.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.error_record_py3.ErrorRecord +name: ErrorRecord +fullName: azure.cognitiveservices.language.textanalytics.models.error_record_py3.ErrorRecord +module: azure.cognitiveservices.language.textanalytics.models.error_record_py3 +summary: ErrorRecord. +constructor: + syntax: 'ErrorRecord(*, id: str = None, message: str = None, **kwargs)' + parameters: + - name: id + description: Input document unique identifier the error refers to. + isRequired: true + types: + - + - name: message + description: Error message. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: message + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.error_record_py3.ErrorRecord.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.error_record_py3.ErrorRecord.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.error_record_py3.ErrorRecord.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.error_record_py3.ErrorRecord.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.error_record_py3.ErrorRecord.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.error_record_py3.ErrorRecord.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.error_record_py3.ErrorRecord.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_record_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_record_py3.yml new file mode 100644 index 00000000..01634297 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_record_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.error_record_py3 +name: error_record_py3 +fullName: azure.cognitiveservices.language.textanalytics.models.error_record_py3 +classes: +- azure.cognitiveservices.language.textanalytics.models.error_record_py3.ErrorRecord diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponse.yml new file mode 100644 index 00000000..6d035d8f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponse.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponse +name: ErrorResponse +fullName: azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponse +module: azure.cognitiveservices.language.textanalytics.models.error_response +summary: ErrorResponse. +constructor: + syntax: ErrorResponse(**kwargs) + parameters: + - name: code + isRequired: true + types: + - + - name: message + isRequired: true + types: + - + - name: target + isRequired: true + types: + - + - name: inner_error + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponseException.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponseException.yml new file mode 100644 index 00000000..9ff6f7b2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponseException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponseException +name: ErrorResponseException +fullName: azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponseException +module: azure.cognitiveservices.language.textanalytics.models.error_response +summary: 'Server responded with exception of type: ''ErrorResponse''.' +constructor: + syntax: ErrorResponseException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponseException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponseException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponseException.args + name: args diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response.yml new file mode 100644 index 00000000..820b2517 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.error_response +name: error_response +fullName: azure.cognitiveservices.language.textanalytics.models.error_response +classes: +- azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponse +- azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponseException diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponse.yml new file mode 100644 index 00000000..c287c665 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponse.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponse +name: ErrorResponse +fullName: azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponse +module: azure.cognitiveservices.language.textanalytics.models.error_response_py3 +summary: ErrorResponse. +constructor: + syntax: 'ErrorResponse(*, code: str = None, message: str = None, target: str = None, + inner_error=None, **kwargs)' + parameters: + - name: code + isRequired: true + types: + - + - name: message + isRequired: true + types: + - + - name: target + isRequired: true + types: + - + - name: inner_error + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true + - name: target + isRequired: true + - name: inner_error + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponseException.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponseException.yml new file mode 100644 index 00000000..8c3d1acf --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponseException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponseException +name: ErrorResponseException +fullName: azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponseException +module: azure.cognitiveservices.language.textanalytics.models.error_response_py3 +summary: 'Server responded with exception of type: ''ErrorResponse''.' +constructor: + syntax: ErrorResponseException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponseException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponseException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponseException.args + name: args diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response_py3.yml new file mode 100644 index 00000000..d451dbd8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response_py3.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.error_response_py3 +name: error_response_py3 +fullName: azure.cognitiveservices.language.textanalytics.models.error_response_py3 +classes: +- azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponse +- azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponseException diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.internal_error.InternalError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.internal_error.InternalError.yml new file mode 100644 index 00000000..5b45e915 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.internal_error.InternalError.yml @@ -0,0 +1,127 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.internal_error.InternalError +name: InternalError +fullName: azure.cognitiveservices.language.textanalytics.models.internal_error.InternalError +module: azure.cognitiveservices.language.textanalytics.models.internal_error +summary: InternalError. +constructor: + syntax: InternalError(**kwargs) + parameters: + - name: code + isRequired: true + types: + - + - name: message + isRequired: true + types: + - + - name: inner_error + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.internal_error.InternalError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.internal_error.InternalError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.internal_error.InternalError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.internal_error.InternalError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.internal_error.InternalError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.internal_error.InternalError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.internal_error.InternalError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.internal_error.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.internal_error.yml new file mode 100644 index 00000000..84ebc152 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.internal_error.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.internal_error +name: internal_error +fullName: azure.cognitiveservices.language.textanalytics.models.internal_error +classes: +- azure.cognitiveservices.language.textanalytics.models.internal_error.InternalError diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.internal_error_py3.InternalError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.internal_error_py3.InternalError.yml new file mode 100644 index 00000000..c329fb98 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.internal_error_py3.InternalError.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.internal_error_py3.InternalError +name: InternalError +fullName: azure.cognitiveservices.language.textanalytics.models.internal_error_py3.InternalError +module: azure.cognitiveservices.language.textanalytics.models.internal_error_py3 +summary: InternalError. +constructor: + syntax: 'InternalError(*, code: str = None, message: str = None, inner_error=None, + **kwargs)' + parameters: + - name: code + isRequired: true + types: + - + - name: message + isRequired: true + types: + - + - name: inner_error + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true + - name: inner_error + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.internal_error_py3.InternalError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.internal_error_py3.InternalError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.internal_error_py3.InternalError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.internal_error_py3.InternalError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.internal_error_py3.InternalError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.internal_error_py3.InternalError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.internal_error_py3.InternalError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.internal_error_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.internal_error_py3.yml new file mode 100644 index 00000000..2359355d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.internal_error_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.internal_error_py3 +name: internal_error_py3 +fullName: azure.cognitiveservices.language.textanalytics.models.internal_error_py3 +classes: +- azure.cognitiveservices.language.textanalytics.models.internal_error_py3.InternalError diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result.KeyPhraseBatchResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result.KeyPhraseBatchResult.yml new file mode 100644 index 00000000..f19efb7c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result.KeyPhraseBatchResult.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result.KeyPhraseBatchResult +name: KeyPhraseBatchResult +fullName: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result.KeyPhraseBatchResult +module: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result +summary: 'KeyPhraseBatchResult. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyPhraseBatchResult(**kwargs) +variables: +- description: Response by document + name: documents + types: + - [] +- description: Errors and Warnings by document + name: errors + types: + - [] +- description: '=(Optional) if showStats=true was specified in the + + request this field will contain information about the request payload.' + name: statistics + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result.KeyPhraseBatchResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result.KeyPhraseBatchResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result.KeyPhraseBatchResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result.KeyPhraseBatchResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result.KeyPhraseBatchResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result.KeyPhraseBatchResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result.KeyPhraseBatchResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result.yml new file mode 100644 index 00000000..3d53be74 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result +name: key_phrase_batch_result +fullName: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result +classes: +- azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result.KeyPhraseBatchResult diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item.KeyPhraseBatchResultItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item.KeyPhraseBatchResultItem.yml new file mode 100644 index 00000000..cdd326ca --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item.KeyPhraseBatchResultItem.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item.KeyPhraseBatchResultItem +name: KeyPhraseBatchResultItem +fullName: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item.KeyPhraseBatchResultItem +module: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item +summary: 'KeyPhraseBatchResultItem. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyPhraseBatchResultItem(**kwargs) + parameters: + - name: id + description: Unique, non-empty document identifier. + isRequired: true + types: + - + - name: statistics + description: '(Optional) if showStats=true was specified in the + + request this field will contain information about the document payload.' + isRequired: true + types: + - +variables: +- description: 'A list of representative words or phrases. The number + + of key phrases returned is proportional to the number of words in the + + input document.' + name: key_phrases + types: + - [] +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item.KeyPhraseBatchResultItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item.KeyPhraseBatchResultItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item.KeyPhraseBatchResultItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item.KeyPhraseBatchResultItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item.KeyPhraseBatchResultItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item.KeyPhraseBatchResultItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item.KeyPhraseBatchResultItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item.yml new file mode 100644 index 00000000..e657a3ac --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item +name: key_phrase_batch_result_item +fullName: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item +classes: +- azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item.KeyPhraseBatchResultItem diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3.KeyPhraseBatchResultItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3.KeyPhraseBatchResultItem.yml new file mode 100644 index 00000000..ae2092a3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3.KeyPhraseBatchResultItem.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3.KeyPhraseBatchResultItem +name: KeyPhraseBatchResultItem +fullName: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3.KeyPhraseBatchResultItem +module: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3 +summary: 'KeyPhraseBatchResultItem. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'KeyPhraseBatchResultItem(*, id: str = None, statistics=None, **kwargs)' + parameters: + - name: id + description: Unique, non-empty document identifier. + isRequired: true + types: + - + - name: statistics + description: '(Optional) if showStats=true was specified in the + + request this field will contain information about the document payload.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: statistics + isRequired: true +variables: +- description: 'A list of representative words or phrases. The number + + of key phrases returned is proportional to the number of words in the + + input document.' + name: key_phrases + types: + - [] +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3.KeyPhraseBatchResultItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3.KeyPhraseBatchResultItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3.KeyPhraseBatchResultItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3.KeyPhraseBatchResultItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3.KeyPhraseBatchResultItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3.KeyPhraseBatchResultItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3.KeyPhraseBatchResultItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3.yml new file mode 100644 index 00000000..00293f57 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3 +name: key_phrase_batch_result_item_py3 +fullName: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3 +classes: +- azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3.KeyPhraseBatchResultItem diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3.KeyPhraseBatchResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3.KeyPhraseBatchResult.yml new file mode 100644 index 00000000..e24256cf --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3.KeyPhraseBatchResult.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3.KeyPhraseBatchResult +name: KeyPhraseBatchResult +fullName: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3.KeyPhraseBatchResult +module: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3 +summary: 'KeyPhraseBatchResult. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyPhraseBatchResult(**kwargs) +variables: +- description: Response by document + name: documents + types: + - [] +- description: Errors and Warnings by document + name: errors + types: + - [] +- description: '=(Optional) if showStats=true was specified in the + + request this field will contain information about the request payload.' + name: statistics + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3.KeyPhraseBatchResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3.KeyPhraseBatchResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3.KeyPhraseBatchResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3.KeyPhraseBatchResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3.KeyPhraseBatchResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3.KeyPhraseBatchResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3.KeyPhraseBatchResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3.yml new file mode 100644 index 00000000..c54d2b70 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3 +name: key_phrase_batch_result_py3 +fullName: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3 +classes: +- azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3.KeyPhraseBatchResult diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_input.LanguageBatchInput.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_input.LanguageBatchInput.yml new file mode 100644 index 00000000..b3fad111 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_input.LanguageBatchInput.yml @@ -0,0 +1,119 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.language_batch_input.LanguageBatchInput +name: LanguageBatchInput +fullName: azure.cognitiveservices.language.textanalytics.models.language_batch_input.LanguageBatchInput +module: azure.cognitiveservices.language.textanalytics.models.language_batch_input +summary: LanguageBatchInput. +constructor: + syntax: LanguageBatchInput(**kwargs) + parameters: + - name: documents + isRequired: true + types: + - [] +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_input.LanguageBatchInput.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_input.LanguageBatchInput.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_input.LanguageBatchInput.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_input.LanguageBatchInput.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_input.LanguageBatchInput.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_input.LanguageBatchInput.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_input.LanguageBatchInput.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_input.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_input.yml new file mode 100644 index 00000000..95100947 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_input.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.language_batch_input +name: language_batch_input +fullName: azure.cognitiveservices.language.textanalytics.models.language_batch_input +classes: +- azure.cognitiveservices.language.textanalytics.models.language_batch_input.LanguageBatchInput diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.LanguageBatchInput.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.LanguageBatchInput.yml new file mode 100644 index 00000000..eb3a5836 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.LanguageBatchInput.yml @@ -0,0 +1,122 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.LanguageBatchInput +name: LanguageBatchInput +fullName: azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.LanguageBatchInput +module: azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3 +summary: LanguageBatchInput. +constructor: + syntax: LanguageBatchInput(*, documents=None, **kwargs) + parameters: + - name: documents + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: documents + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.LanguageBatchInput.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.LanguageBatchInput.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.LanguageBatchInput.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.LanguageBatchInput.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.LanguageBatchInput.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.LanguageBatchInput.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.LanguageBatchInput.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.yml new file mode 100644 index 00000000..8c16f6b7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3 +name: language_batch_input_py3 +fullName: azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3 +classes: +- azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.LanguageBatchInput diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result.LanguageBatchResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result.LanguageBatchResult.yml new file mode 100644 index 00000000..92d2d092 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result.LanguageBatchResult.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result.LanguageBatchResult +name: LanguageBatchResult +fullName: azure.cognitiveservices.language.textanalytics.models.language_batch_result.LanguageBatchResult +module: azure.cognitiveservices.language.textanalytics.models.language_batch_result +summary: 'LanguageBatchResult. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: LanguageBatchResult(**kwargs) +variables: +- description: Response by document + name: documents + types: + - [] +- description: Errors and Warnings by document + name: errors + types: + - [] +- description: '(Optional) if showStats=true was specified in the + + request this field will contain information about the request payload.' + name: statistics + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result.LanguageBatchResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result.LanguageBatchResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result.LanguageBatchResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result.LanguageBatchResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result.LanguageBatchResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result.LanguageBatchResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result.LanguageBatchResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result.yml new file mode 100644 index 00000000..ecd8d26f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result +name: language_batch_result +fullName: azure.cognitiveservices.language.textanalytics.models.language_batch_result +classes: +- azure.cognitiveservices.language.textanalytics.models.language_batch_result.LanguageBatchResult diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_item.LanguageBatchResultItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_item.LanguageBatchResultItem.yml new file mode 100644 index 00000000..d198ad2a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_item.LanguageBatchResultItem.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item.LanguageBatchResultItem +name: LanguageBatchResultItem +fullName: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item.LanguageBatchResultItem +module: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item +summary: LanguageBatchResultItem. +constructor: + syntax: LanguageBatchResultItem(**kwargs) + parameters: + - name: id + description: Unique, non-empty document identifier. + isRequired: true + types: + - + - name: detected_languages + description: A list of extracted languages. + isRequired: true + types: + - [] + - name: statistics + description: '(Optional) if showStats=true was specified in the + + request this field will contain information about the document payload.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item.LanguageBatchResultItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item.LanguageBatchResultItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item.LanguageBatchResultItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item.LanguageBatchResultItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item.LanguageBatchResultItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item.LanguageBatchResultItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item.LanguageBatchResultItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_item.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_item.yml new file mode 100644 index 00000000..3291a360 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item +name: language_batch_result_item +fullName: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item +classes: +- azure.cognitiveservices.language.textanalytics.models.language_batch_result_item.LanguageBatchResultItem diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.LanguageBatchResultItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.LanguageBatchResultItem.yml new file mode 100644 index 00000000..e124626b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.LanguageBatchResultItem.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.LanguageBatchResultItem +name: LanguageBatchResultItem +fullName: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.LanguageBatchResultItem +module: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3 +summary: LanguageBatchResultItem. +constructor: + syntax: 'LanguageBatchResultItem(*, id: str = None, detected_languages=None, statistics=None, + **kwargs)' + parameters: + - name: id + description: Unique, non-empty document identifier. + isRequired: true + types: + - + - name: detected_languages + description: A list of extracted languages. + isRequired: true + types: + - [] + - name: statistics + description: '(Optional) if showStats=true was specified in the + + request this field will contain information about the document payload.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: detected_languages + isRequired: true + - name: statistics + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.LanguageBatchResultItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.LanguageBatchResultItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.LanguageBatchResultItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.LanguageBatchResultItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.LanguageBatchResultItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.LanguageBatchResultItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.LanguageBatchResultItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.yml new file mode 100644 index 00000000..1fa059a6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3 +name: language_batch_result_item_py3 +fullName: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3 +classes: +- azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.LanguageBatchResultItem diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3.LanguageBatchResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3.LanguageBatchResult.yml new file mode 100644 index 00000000..f32ab8d3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3.LanguageBatchResult.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3.LanguageBatchResult +name: LanguageBatchResult +fullName: azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3.LanguageBatchResult +module: azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3 +summary: 'LanguageBatchResult. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: LanguageBatchResult(**kwargs) +variables: +- description: Response by document + name: documents + types: + - [] +- description: Errors and Warnings by document + name: errors + types: + - [] +- description: '(Optional) if showStats=true was specified in the + + request this field will contain information about the request payload.' + name: statistics + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3.LanguageBatchResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3.LanguageBatchResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3.LanguageBatchResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3.LanguageBatchResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3.LanguageBatchResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3.LanguageBatchResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3.LanguageBatchResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3.yml new file mode 100644 index 00000000..99a93978 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3 +name: language_batch_result_py3 +fullName: azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3 +classes: +- azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3.LanguageBatchResult diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_input.LanguageInput.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_input.LanguageInput.yml new file mode 100644 index 00000000..1156f403 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_input.LanguageInput.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.language_input.LanguageInput +name: LanguageInput +fullName: azure.cognitiveservices.language.textanalytics.models.language_input.LanguageInput +module: azure.cognitiveservices.language.textanalytics.models.language_input +summary: LanguageInput. +constructor: + syntax: LanguageInput(**kwargs) + parameters: + - name: country_hint + isRequired: true + types: + - + - name: id + description: Unique, non-empty document identifier. + isRequired: true + types: + - + - name: text + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.language_input.LanguageInput.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.language_input.LanguageInput.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.language_input.LanguageInput.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.language_input.LanguageInput.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.language_input.LanguageInput.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.language_input.LanguageInput.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.language_input.LanguageInput.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_input.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_input.yml new file mode 100644 index 00000000..e7667d6d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_input.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.language_input +name: language_input +fullName: azure.cognitiveservices.language.textanalytics.models.language_input +classes: +- azure.cognitiveservices.language.textanalytics.models.language_input.LanguageInput diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_input_py3.LanguageInput.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_input_py3.LanguageInput.yml new file mode 100644 index 00000000..dad6c2f5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_input_py3.LanguageInput.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.language_input_py3.LanguageInput +name: LanguageInput +fullName: azure.cognitiveservices.language.textanalytics.models.language_input_py3.LanguageInput +module: azure.cognitiveservices.language.textanalytics.models.language_input_py3 +summary: LanguageInput. +constructor: + syntax: 'LanguageInput(*, country_hint: str = None, id: str = None, text: str = + None, **kwargs)' + parameters: + - name: country_hint + isRequired: true + types: + - + - name: id + description: Unique, non-empty document identifier. + isRequired: true + types: + - + - name: text + isRequired: true + types: + - + keywordOnlyParameters: + - name: country_hint + isRequired: true + - name: id + isRequired: true + - name: text + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.language_input_py3.LanguageInput.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.language_input_py3.LanguageInput.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.language_input_py3.LanguageInput.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.language_input_py3.LanguageInput.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.language_input_py3.LanguageInput.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.language_input_py3.LanguageInput.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.language_input_py3.LanguageInput.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_input_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_input_py3.yml new file mode 100644 index 00000000..a8990383 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_input_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.language_input_py3 +name: language_input_py3 +fullName: azure.cognitiveservices.language.textanalytics.models.language_input_py3 +classes: +- azure.cognitiveservices.language.textanalytics.models.language_input_py3.LanguageInput diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.match_record.MatchRecord.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.match_record.MatchRecord.yml new file mode 100644 index 00000000..bac6cf19 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.match_record.MatchRecord.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.match_record.MatchRecord +name: MatchRecord +fullName: azure.cognitiveservices.language.textanalytics.models.match_record.MatchRecord +module: azure.cognitiveservices.language.textanalytics.models.match_record +summary: MatchRecord. +constructor: + syntax: MatchRecord(**kwargs) + parameters: + - name: wikipedia_score + description: '(optional) If a well-known item with Wikipedia + + link is recognized, a decimal number denoting the confidence level of the + + Wikipedia info will be returned.' + isRequired: true + types: + - + - name: entity_type_score + description: '(optional) If an entity type is recognized, a + + decimal number denoting the confidence level of the entity type will be + + returned.' + isRequired: true + types: + - + - name: text + description: Entity text as appears in the request. + isRequired: true + types: + - + - name: offset + description: 'Start position (in Unicode characters) for the entity match + + text.' + isRequired: true + types: + - + - name: length + description: Length (in Unicode characters) for the entity match text. + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.match_record.MatchRecord.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.match_record.MatchRecord.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.match_record.MatchRecord.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.match_record.MatchRecord.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.match_record.MatchRecord.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.match_record.MatchRecord.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.match_record.MatchRecord.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.match_record.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.match_record.yml new file mode 100644 index 00000000..11766eef --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.match_record.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.match_record +name: match_record +fullName: azure.cognitiveservices.language.textanalytics.models.match_record +classes: +- azure.cognitiveservices.language.textanalytics.models.match_record.MatchRecord diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.match_record_py3.MatchRecord.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.match_record_py3.MatchRecord.yml new file mode 100644 index 00000000..0fa1eff4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.match_record_py3.MatchRecord.yml @@ -0,0 +1,162 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.match_record_py3.MatchRecord +name: MatchRecord +fullName: azure.cognitiveservices.language.textanalytics.models.match_record_py3.MatchRecord +module: azure.cognitiveservices.language.textanalytics.models.match_record_py3 +summary: MatchRecord. +constructor: + syntax: 'MatchRecord(*, wikipedia_score: float = None, entity_type_score: float + = None, text: str = None, offset: int = None, length: int = None, **kwargs)' + parameters: + - name: wikipedia_score + description: '(optional) If a well-known item with Wikipedia + + link is recognized, a decimal number denoting the confidence level of the + + Wikipedia info will be returned.' + isRequired: true + types: + - + - name: entity_type_score + description: '(optional) If an entity type is recognized, a + + decimal number denoting the confidence level of the entity type will be + + returned.' + isRequired: true + types: + - + - name: text + description: Entity text as appears in the request. + isRequired: true + types: + - + - name: offset + description: 'Start position (in Unicode characters) for the entity match + + text.' + isRequired: true + types: + - + - name: length + description: Length (in Unicode characters) for the entity match text. + isRequired: true + types: + - + keywordOnlyParameters: + - name: wikipedia_score + isRequired: true + - name: entity_type_score + isRequired: true + - name: text + isRequired: true + - name: offset + isRequired: true + - name: length + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.match_record_py3.MatchRecord.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.match_record_py3.MatchRecord.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.match_record_py3.MatchRecord.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.match_record_py3.MatchRecord.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.match_record_py3.MatchRecord.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.match_record_py3.MatchRecord.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.match_record_py3.MatchRecord.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.match_record_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.match_record_py3.yml new file mode 100644 index 00000000..75295aea --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.match_record_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.match_record_py3 +name: match_record_py3 +fullName: azure.cognitiveservices.language.textanalytics.models.match_record_py3 +classes: +- azure.cognitiveservices.language.textanalytics.models.match_record_py3.MatchRecord diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input.MultiLanguageBatchInput.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input.MultiLanguageBatchInput.yml new file mode 100644 index 00000000..a219c244 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input.MultiLanguageBatchInput.yml @@ -0,0 +1,119 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input.MultiLanguageBatchInput +name: MultiLanguageBatchInput +fullName: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input.MultiLanguageBatchInput +module: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input +summary: MultiLanguageBatchInput. +constructor: + syntax: MultiLanguageBatchInput(**kwargs) + parameters: + - name: documents + isRequired: true + types: + - [] +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input.MultiLanguageBatchInput.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input.MultiLanguageBatchInput.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input.MultiLanguageBatchInput.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input.MultiLanguageBatchInput.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input.MultiLanguageBatchInput.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input.MultiLanguageBatchInput.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input.MultiLanguageBatchInput.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input.yml new file mode 100644 index 00000000..132b9a4c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input +name: multi_language_batch_input +fullName: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input +classes: +- azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input.MultiLanguageBatchInput diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.MultiLanguageBatchInput.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.MultiLanguageBatchInput.yml new file mode 100644 index 00000000..0ee6b123 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.MultiLanguageBatchInput.yml @@ -0,0 +1,122 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.MultiLanguageBatchInput +name: MultiLanguageBatchInput +fullName: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.MultiLanguageBatchInput +module: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3 +summary: MultiLanguageBatchInput. +constructor: + syntax: MultiLanguageBatchInput(*, documents=None, **kwargs) + parameters: + - name: documents + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: documents + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.MultiLanguageBatchInput.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.MultiLanguageBatchInput.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.MultiLanguageBatchInput.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.MultiLanguageBatchInput.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.MultiLanguageBatchInput.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.MultiLanguageBatchInput.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.MultiLanguageBatchInput.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.yml new file mode 100644 index 00000000..35924117 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3 +name: multi_language_batch_input_py3 +fullName: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3 +classes: +- azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.MultiLanguageBatchInput diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_input.MultiLanguageInput.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_input.MultiLanguageInput.yml new file mode 100644 index 00000000..89aeb45e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_input.MultiLanguageInput.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.multi_language_input.MultiLanguageInput +name: MultiLanguageInput +fullName: azure.cognitiveservices.language.textanalytics.models.multi_language_input.MultiLanguageInput +module: azure.cognitiveservices.language.textanalytics.models.multi_language_input +summary: MultiLanguageInput. +constructor: + syntax: MultiLanguageInput(**kwargs) + parameters: + - name: language + description: 'This is the 2 letter ISO 639-1 representation of a + + language. For example, use "en" for English; "es" for Spanish etc.,' + isRequired: true + types: + - + - name: id + description: Unique, non-empty document identifier. + isRequired: true + types: + - + - name: text + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_input.MultiLanguageInput.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_input.MultiLanguageInput.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_input.MultiLanguageInput.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_input.MultiLanguageInput.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_input.MultiLanguageInput.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_input.MultiLanguageInput.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_input.MultiLanguageInput.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_input.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_input.yml new file mode 100644 index 00000000..67ef7287 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_input.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.multi_language_input +name: multi_language_input +fullName: azure.cognitiveservices.language.textanalytics.models.multi_language_input +classes: +- azure.cognitiveservices.language.textanalytics.models.multi_language_input.MultiLanguageInput diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.MultiLanguageInput.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.MultiLanguageInput.yml new file mode 100644 index 00000000..4a29e8bb --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.MultiLanguageInput.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.MultiLanguageInput +name: MultiLanguageInput +fullName: azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.MultiLanguageInput +module: azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3 +summary: MultiLanguageInput. +constructor: + syntax: 'MultiLanguageInput(*, language: str = None, id: str = None, text: str = + None, **kwargs)' + parameters: + - name: language + description: 'This is the 2 letter ISO 639-1 representation of a + + language. For example, use "en" for English; "es" for Spanish etc.,' + isRequired: true + types: + - + - name: id + description: Unique, non-empty document identifier. + isRequired: true + types: + - + - name: text + isRequired: true + types: + - + keywordOnlyParameters: + - name: language + isRequired: true + - name: id + isRequired: true + - name: text + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.MultiLanguageInput.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.MultiLanguageInput.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.MultiLanguageInput.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.MultiLanguageInput.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.MultiLanguageInput.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.MultiLanguageInput.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.MultiLanguageInput.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.yml new file mode 100644 index 00000000..09bd5626 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3 +name: multi_language_input_py3 +fullName: azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3 +classes: +- azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.MultiLanguageInput diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.request_statistics.RequestStatistics.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.request_statistics.RequestStatistics.yml new file mode 100644 index 00000000..80cf7404 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.request_statistics.RequestStatistics.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.request_statistics.RequestStatistics +name: RequestStatistics +fullName: azure.cognitiveservices.language.textanalytics.models.request_statistics.RequestStatistics +module: azure.cognitiveservices.language.textanalytics.models.request_statistics +summary: RequestStatistics. +constructor: + syntax: RequestStatistics(**kwargs) + parameters: + - name: documents_count + description: Number of documents submitted in the request. + isRequired: true + types: + - + - name: valid_documents_count + description: 'Number of valid documents. This excludes + + empty, over-size limit or non-supported languages documents.' + isRequired: true + types: + - + - name: erroneous_documents_count + description: 'Number of invalid documents. This + + includes empty, over-size limit or non-supported languages documents.' + isRequired: true + types: + - + - name: transactions_count + description: Number of transactions for the request. + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.request_statistics.RequestStatistics.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.request_statistics.RequestStatistics.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.request_statistics.RequestStatistics.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.request_statistics.RequestStatistics.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.request_statistics.RequestStatistics.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.request_statistics.RequestStatistics.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.request_statistics.RequestStatistics.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.request_statistics.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.request_statistics.yml new file mode 100644 index 00000000..26aec752 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.request_statistics.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.request_statistics +name: request_statistics +fullName: azure.cognitiveservices.language.textanalytics.models.request_statistics +classes: +- azure.cognitiveservices.language.textanalytics.models.request_statistics.RequestStatistics diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.RequestStatistics.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.RequestStatistics.yml new file mode 100644 index 00000000..e316eb4c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.RequestStatistics.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.RequestStatistics +name: RequestStatistics +fullName: azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.RequestStatistics +module: azure.cognitiveservices.language.textanalytics.models.request_statistics_py3 +summary: RequestStatistics. +constructor: + syntax: 'RequestStatistics(*, documents_count: int = None, valid_documents_count: + int = None, erroneous_documents_count: int = None, transactions_count: int = None, + **kwargs)' + parameters: + - name: documents_count + description: Number of documents submitted in the request. + isRequired: true + types: + - + - name: valid_documents_count + description: 'Number of valid documents. This excludes + + empty, over-size limit or non-supported languages documents.' + isRequired: true + types: + - + - name: erroneous_documents_count + description: 'Number of invalid documents. This + + includes empty, over-size limit or non-supported languages documents.' + isRequired: true + types: + - + - name: transactions_count + description: Number of transactions for the request. + isRequired: true + types: + - + keywordOnlyParameters: + - name: documents_count + isRequired: true + - name: valid_documents_count + isRequired: true + - name: erroneous_documents_count + isRequired: true + - name: transactions_count + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.RequestStatistics.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.RequestStatistics.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.RequestStatistics.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.RequestStatistics.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.RequestStatistics.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.RequestStatistics.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.RequestStatistics.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.yml new file mode 100644 index 00000000..212a5e19 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.request_statistics_py3 +name: request_statistics_py3 +fullName: azure.cognitiveservices.language.textanalytics.models.request_statistics_py3 +classes: +- azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.RequestStatistics diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result.SentimentBatchResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result.SentimentBatchResult.yml new file mode 100644 index 00000000..f8cc7d6b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result.SentimentBatchResult.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result.SentimentBatchResult +name: SentimentBatchResult +fullName: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result.SentimentBatchResult +module: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result +summary: 'SentimentBatchResult. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SentimentBatchResult(**kwargs) +variables: +- description: Response by document + name: documents + types: + - [] +- description: Errors and Warnings by document + name: errors + types: + - [] +- description: '(Optional) if showStats=true was specified in the + + request this field will contain information about the request payload.' + name: statistics + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result.SentimentBatchResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result.SentimentBatchResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result.SentimentBatchResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result.SentimentBatchResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result.SentimentBatchResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result.SentimentBatchResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result.SentimentBatchResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result.yml new file mode 100644 index 00000000..aa09ba6a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result +name: sentiment_batch_result +fullName: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result +classes: +- azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result.SentimentBatchResult diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item.SentimentBatchResultItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item.SentimentBatchResultItem.yml new file mode 100644 index 00000000..cda0993d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item.SentimentBatchResultItem.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item.SentimentBatchResultItem +name: SentimentBatchResultItem +fullName: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item.SentimentBatchResultItem +module: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item +summary: SentimentBatchResultItem. +constructor: + syntax: SentimentBatchResultItem(**kwargs) + parameters: + - name: id + description: Unique, non-empty document identifier. + isRequired: true + types: + - + - name: score + description: 'A decimal number between 0 and 1 denoting the sentiment of + + the document. A score above 0.7 usually refers to a positive document + + while a score below 0.3 normally has a negative connotation. Mid values + + refer to neutral text.' + isRequired: true + types: + - + - name: statistics + description: '(Optional) if showStats=true was specified in the + + request this field will contain information about the document payload.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item.SentimentBatchResultItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item.SentimentBatchResultItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item.SentimentBatchResultItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item.SentimentBatchResultItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item.SentimentBatchResultItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item.SentimentBatchResultItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item.SentimentBatchResultItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item.yml new file mode 100644 index 00000000..330aeaaf --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item +name: sentiment_batch_result_item +fullName: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item +classes: +- azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item.SentimentBatchResultItem diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.SentimentBatchResultItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.SentimentBatchResultItem.yml new file mode 100644 index 00000000..e129ede6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.SentimentBatchResultItem.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.SentimentBatchResultItem +name: SentimentBatchResultItem +fullName: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.SentimentBatchResultItem +module: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3 +summary: SentimentBatchResultItem. +constructor: + syntax: 'SentimentBatchResultItem(*, id: str = None, score: float = None, statistics=None, + **kwargs)' + parameters: + - name: id + description: Unique, non-empty document identifier. + isRequired: true + types: + - + - name: score + description: 'A decimal number between 0 and 1 denoting the sentiment of + + the document. A score above 0.7 usually refers to a positive document + + while a score below 0.3 normally has a negative connotation. Mid values + + refer to neutral text.' + isRequired: true + types: + - + - name: statistics + description: '(Optional) if showStats=true was specified in the + + request this field will contain information about the document payload.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: score + isRequired: true + - name: statistics + isRequired: true +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.SentimentBatchResultItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.SentimentBatchResultItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.SentimentBatchResultItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.SentimentBatchResultItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.SentimentBatchResultItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.SentimentBatchResultItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.SentimentBatchResultItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.yml new file mode 100644 index 00000000..2a1acee8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3 +name: sentiment_batch_result_item_py3 +fullName: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3 +classes: +- azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.SentimentBatchResultItem diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3.SentimentBatchResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3.SentimentBatchResult.yml new file mode 100644 index 00000000..4daae7a7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3.SentimentBatchResult.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3.SentimentBatchResult +name: SentimentBatchResult +fullName: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3.SentimentBatchResult +module: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3 +summary: 'SentimentBatchResult. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SentimentBatchResult(**kwargs) +variables: +- description: Response by document + name: documents + types: + - [] +- description: Errors and Warnings by document + name: errors + types: + - [] +- description: '(Optional) if showStats=true was specified in the + + request this field will contain information about the request payload.' + name: statistics + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3.SentimentBatchResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3.SentimentBatchResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3.SentimentBatchResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3.SentimentBatchResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3.SentimentBatchResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3.SentimentBatchResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3.SentimentBatchResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3.yml new file mode 100644 index 00000000..90971444 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3 +name: sentiment_batch_result_py3 +fullName: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3 +classes: +- azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3.SentimentBatchResult diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.yml new file mode 100644 index 00000000..dd8df1a2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.yml @@ -0,0 +1,68 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.language.textanalytics.models +name: models +fullName: azure.cognitiveservices.language.textanalytics.models +type: import +classes: +- azure.cognitiveservices.language.textanalytics.models.DetectedLanguage +- azure.cognitiveservices.language.textanalytics.models.DocumentStatistics +- azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResult +- azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResultItem +- azure.cognitiveservices.language.textanalytics.models.EntityRecord +- azure.cognitiveservices.language.textanalytics.models.ErrorRecord +- azure.cognitiveservices.language.textanalytics.models.ErrorResponse +- azure.cognitiveservices.language.textanalytics.models.ErrorResponseException +- azure.cognitiveservices.language.textanalytics.models.InternalError +- azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult +- azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResultItem +- azure.cognitiveservices.language.textanalytics.models.LanguageBatchInput +- azure.cognitiveservices.language.textanalytics.models.LanguageBatchResult +- azure.cognitiveservices.language.textanalytics.models.LanguageBatchResultItem +- azure.cognitiveservices.language.textanalytics.models.LanguageInput +- azure.cognitiveservices.language.textanalytics.models.MatchRecord +- azure.cognitiveservices.language.textanalytics.models.MultiLanguageBatchInput +- azure.cognitiveservices.language.textanalytics.models.MultiLanguageInput +- azure.cognitiveservices.language.textanalytics.models.RequestStatistics +- azure.cognitiveservices.language.textanalytics.models.SentimentBatchResult +- azure.cognitiveservices.language.textanalytics.models.SentimentBatchResultItem +modules: +- azure.cognitiveservices.language.textanalytics.models.detected_language +- azure.cognitiveservices.language.textanalytics.models.detected_language_py3 +- azure.cognitiveservices.language.textanalytics.models.document_statistics +- azure.cognitiveservices.language.textanalytics.models.document_statistics_py3 +- azure.cognitiveservices.language.textanalytics.models.entities_batch_result +- azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item +- azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3 +- azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3 +- azure.cognitiveservices.language.textanalytics.models.entity_record +- azure.cognitiveservices.language.textanalytics.models.entity_record_py3 +- azure.cognitiveservices.language.textanalytics.models.error_record +- azure.cognitiveservices.language.textanalytics.models.error_record_py3 +- azure.cognitiveservices.language.textanalytics.models.error_response +- azure.cognitiveservices.language.textanalytics.models.error_response_py3 +- azure.cognitiveservices.language.textanalytics.models.internal_error +- azure.cognitiveservices.language.textanalytics.models.internal_error_py3 +- azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result +- azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item +- azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3 +- azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3 +- azure.cognitiveservices.language.textanalytics.models.language_batch_input +- azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3 +- azure.cognitiveservices.language.textanalytics.models.language_batch_result +- azure.cognitiveservices.language.textanalytics.models.language_batch_result_item +- azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3 +- azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3 +- azure.cognitiveservices.language.textanalytics.models.language_input +- azure.cognitiveservices.language.textanalytics.models.language_input_py3 +- azure.cognitiveservices.language.textanalytics.models.match_record +- azure.cognitiveservices.language.textanalytics.models.match_record_py3 +- azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input +- azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3 +- azure.cognitiveservices.language.textanalytics.models.multi_language_input +- azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3 +- azure.cognitiveservices.language.textanalytics.models.request_statistics +- azure.cognitiveservices.language.textanalytics.models.request_statistics_py3 +- azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result +- azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item +- azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3 +- azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3 diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClient.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClient.yml new file mode 100644 index 00000000..f21d9b24 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClient.yml @@ -0,0 +1,244 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClient +name: TextAnalyticsClient +fullName: azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClient +module: azure.cognitiveservices.language.textanalytics.text_analytics_client +summary: The Text Analytics API is a suite of text analytics web services built with + best-in-class Microsoft machine learning algorithms. The API can be used to analyze + unstructured text for tasks such as sentiment analysis, key phrase extraction and + language detection. No training data is needed to use this API; just bring your + text data. This API uses advanced natural language processing techniques to deliver + best in class predictions. Further documentation can be found in [https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview](https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview) +constructor: + syntax: TextAnalyticsClient(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and + + hostname, for example: [https://westus.api.cognitive.microsoft.com](https://westus.api.cognitive.microsoft.com)).' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None +- uid: azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClient.detect_language + name: detect_language + summary: 'The API returns the detected language and a numeric score between 0 and + + 1. + + + Scores close to 1 indicate 100% certainty that the identified language + + is true. A total of 120 languages are supported.' + signature: detect_language(show_stats=None, documents=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: show_stats + description: '(optional) if set to true, response will contain + + input and document level statistics.' + defaultValue: None + types: + - + - name: documents + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: LanguageBatchResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.textanalytics.models.ErrorResponseException +- uid: azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClient.entities + name: entities + summary: 'The API returns a list of recognized entities in a given document. + + + To get even more information on each recognized entity we recommend + + using the Bing Entity Search API by querying for the recognized + + entities names. See the Supported + + languages in Text Analytics API for the list of enabled languages.' + signature: entities(show_stats=None, documents=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: show_stats + description: '(optional) if set to true, response will contain + + input and document level statistics.' + defaultValue: None + types: + - + - name: documents + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: EntitiesBatchResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.textanalytics.models.ErrorResponseException +- uid: azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClient.key_phrases + name: key_phrases + summary: 'The API returns a list of strings denoting the key talking points in + + the input text. + + + See the Text + + Analytics Documentation for details about the languages that are + + supported by key phrase extraction.' + signature: key_phrases(show_stats=None, documents=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: show_stats + description: '(optional) if set to true, response will contain + + input and document level statistics.' + defaultValue: None + types: + - + - name: documents + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyPhraseBatchResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.language.textanalytics.models.ErrorResponseException +- uid: azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClient.sentiment + name: sentiment + summary: 'The API returns a numeric score between 0 and 1. + + + Scores close to 1 indicate positive sentiment, while scores close to 0 + + indicate negative sentiment. A score of 0.5 indicates the lack of + + sentiment (e.g. a factoid statement). See the Text + + Analytics Documentation for details about the languages that are + + supported by sentiment analysis.' + signature: sentiment(show_stats=None, documents=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: show_stats + description: '(optional) if set to true, response will contain + + input and document level statistics.' + defaultValue: None + types: + - + - name: documents + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: object or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrest.exceptions.HttpOperationError diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClientConfiguration.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClientConfiguration.yml new file mode 100644 index 00000000..0ff471ed --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClientConfiguration.yml @@ -0,0 +1,62 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClientConfiguration +name: TextAnalyticsClientConfiguration +fullName: azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClientConfiguration +module: azure.cognitiveservices.language.textanalytics.text_analytics_client +summary: 'Configuration for TextAnalyticsClient + + Note that all parameters used to create this instance are saved as instance + + attributes.' +constructor: + syntax: TextAnalyticsClientConfiguration(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and + + hostname, for example: [https://westus.api.cognitive.microsoft.com](https://westus.api.cognitive.microsoft.com)).' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClientConfiguration.add_user_agent + name: add_user_agent + summary: Add value to current user agent with a space. + signature: 'add_user_agent(value: str) -> None' + parameters: + - name: value + description: value to add to user agent. + isRequired: true + types: + - +- uid: azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClientConfiguration.load + name: load + signature: load(filepath) + parameters: + - name: filepath + isRequired: true +- uid: azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClientConfiguration.save + name: save + summary: Save current configuration to file. + signature: save(filepath) + parameters: + - name: filepath + description: Path to file where settings will be saved. + isRequired: true + types: + - + exceptions: + - type: ValueError if supplied filepath cannot be written to. +attributes: +- uid: azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClientConfiguration.enable_http_logger + name: enable_http_logger +- uid: azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClientConfiguration.user_agent + name: user_agent + summary: The current user agent value. diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.text_analytics_client.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.text_analytics_client.yml new file mode 100644 index 00000000..21f8a723 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.text_analytics_client.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.text_analytics_client +name: text_analytics_client +fullName: azure.cognitiveservices.language.textanalytics.text_analytics_client +classes: +- azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClient +- azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClientConfiguration diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.version.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.version.yml new file mode 100644 index 00000000..fdad9e2b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.language.textanalytics.version +name: version +fullName: azure.cognitiveservices.language.textanalytics.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.yml new file mode 100644 index 00000000..518337c2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.language.textanalytics +name: textanalytics +fullName: azure.cognitiveservices.language.textanalytics +type: rootImport +classes: +- azure.cognitiveservices.language.textanalytics.TextAnalyticsClient +packages: +- azure.cognitiveservices.language.textanalytics.models +modules: +- azure.cognitiveservices.language.textanalytics.text_analytics_client +- azure.cognitiveservices.language.textanalytics.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.NewsSearchClient.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.NewsSearchClient.yml new file mode 100644 index 00000000..1dec7823 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.NewsSearchClient.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.newssearch.NewsSearchClient +name: NewsSearchClient +fullName: azure.cognitiveservices.search.newssearch.NewsSearchClient +module: azure.cognitiveservices.search.newssearch +summary: The News Search API lets you send a search query to Bing and get back a list + of news that are relevant to the search query. This section provides technical details + about the query parameters and headers that you use to request news and the JSON + response objects that contain them. For examples that show how to make requests, + see [Searching the web for news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web). +constructor: + syntax: NewsSearchClient(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and + + hostname, for example: "[https://westus.api.cognitive.microsoft.com](https://westus.api.cognitive.microsoft.com)", + + "[https://api.cognitive.microsoft.com](https://api.cognitive.microsoft.com)").' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +- description: News operations + name: news + types: + - +methods: +- uid: azure.cognitiveservices.search.newssearch.NewsSearchClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.NewsSearchClientConfiguration.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.NewsSearchClientConfiguration.yml new file mode 100644 index 00000000..93ea61b9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.NewsSearchClientConfiguration.yml @@ -0,0 +1,64 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.newssearch.NewsSearchClientConfiguration +name: NewsSearchClientConfiguration +fullName: azure.cognitiveservices.search.newssearch.NewsSearchClientConfiguration +module: azure.cognitiveservices.search.newssearch +summary: 'Configuration for NewsSearchClient + + Note that all parameters used to create this instance are saved as instance + + attributes.' +constructor: + syntax: NewsSearchClientConfiguration(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and + + hostname, for example: "[https://westus.api.cognitive.microsoft.com](https://westus.api.cognitive.microsoft.com)", + + "[https://api.cognitive.microsoft.com](https://api.cognitive.microsoft.com)").' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.search.newssearch.NewsSearchClientConfiguration.add_user_agent + name: add_user_agent + summary: Add value to current user agent with a space. + signature: 'add_user_agent(value: str) -> None' + parameters: + - name: value + description: value to add to user agent. + isRequired: true + types: + - +- uid: azure.cognitiveservices.search.newssearch.NewsSearchClientConfiguration.load + name: load + signature: load(filepath) + parameters: + - name: filepath + isRequired: true +- uid: azure.cognitiveservices.search.newssearch.NewsSearchClientConfiguration.save + name: save + summary: Save current configuration to file. + signature: save(filepath) + parameters: + - name: filepath + description: Path to file where settings will be saved. + isRequired: true + types: + - + exceptions: + - type: ValueError if supplied filepath cannot be written to. +attributes: +- uid: azure.cognitiveservices.search.newssearch.NewsSearchClientConfiguration.enable_http_logger + name: enable_http_logger +- uid: azure.cognitiveservices.search.newssearch.NewsSearchClientConfiguration.user_agent + name: user_agent + summary: The current user agent value. diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Answer.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Answer.yml new file mode 100644 index 00000000..5b422485 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Answer.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.newssearch.models.Answer +name: Answer +fullName: azure.cognitiveservices.search.newssearch.models.Answer +module: azure.cognitiveservices.search.newssearch.models +summary: 'Defines an answer. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: SearchResultsAnswer, TrendingTopics + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Answer(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: The URL To Bing's search result for this item. + name: web_search_url + types: + - +- name: follow_up_queries + types: + - [] +methods: +- uid: azure.cognitiveservices.search.newssearch.models.Answer.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.Answer.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.Answer.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.newssearch.models.Answer.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.Answer.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.newssearch.models.Answer.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.Answer.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Article.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Article.yml new file mode 100644 index 00000000..a5469cb6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Article.yml @@ -0,0 +1,188 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.newssearch.models.Article +name: Article +fullName: azure.cognitiveservices.search.newssearch.models.Article +module: azure.cognitiveservices.search.newssearch.models +summary: 'Article. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: NewsArticle + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Article(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: The URL To Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: A video of the item. + name: video + types: + - +- description: The number of words in the text of the Article. + name: word_count + types: + - +methods: +- uid: azure.cognitiveservices.search.newssearch.models.Article.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.Article.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.Article.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.newssearch.models.Article.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.Article.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.newssearch.models.Article.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.Article.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.CreativeWork.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.CreativeWork.yml new file mode 100644 index 00000000..94aab7a5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.CreativeWork.yml @@ -0,0 +1,186 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.newssearch.models.CreativeWork +name: CreativeWork +fullName: azure.cognitiveservices.search.newssearch.models.CreativeWork +module: azure.cognitiveservices.search.newssearch.models +summary: 'The most generic kind of creative work, including books, movies, + + photographs, software programs, etc. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Article, MediaObject + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CreativeWork(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: The URL To Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: A video of the item. + name: video + types: + - +methods: +- uid: azure.cognitiveservices.search.newssearch.models.CreativeWork.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.CreativeWork.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.CreativeWork.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.newssearch.models.CreativeWork.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.CreativeWork.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.newssearch.models.CreativeWork.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.CreativeWork.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Error.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Error.yml new file mode 100644 index 00000000..262c5601 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Error.yml @@ -0,0 +1,173 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.newssearch.models.Error +name: Error +fullName: azure.cognitiveservices.search.newssearch.models.Error +module: azure.cognitiveservices.search.newssearch.models +summary: 'Defines the error that occurred. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Error(*, message: str, code=''None'', **kwargs)' + parameters: + - name: code + description: 'Required. The error code that identifies the category of + + error. Possible values include: ''None'', ''ServerError'', ''InvalidRequest'', + + ''RateLimitExceeded'', ''InvalidAuthorization'', ''InsufficientAuthorization''. + + Default value: "None" .' + isRequired: true + types: + - + - + - name: message + description: Required. A description of the error. + isRequired: true + types: + - + keywordOnlyParameters: + - name: message + isRequired: true + - name: code + defaultValue: None +variables: +- description: 'The error code that further helps to identify the error. + + Possible values include: ''UnexpectedError'', ''ResourceError'', + + ''NotImplemented'', ''ParameterMissing'', ''ParameterInvalidValue'', + + ''HttpNotAllowed'', ''Blocked'', ''AuthorizationMissing'', + + ''AuthorizationRedundancy'', ''AuthorizationDisabled'', ''AuthorizationExpired''' + name: sub_code + types: + - + - +- description: 'A description that provides additional information + + about the error.' + name: more_details + types: + - +- description: The parameter in the request that caused the error. + name: parameter + types: + - +- description: The parameter's value in the request that was not valid. + name: value + types: + - +methods: +- uid: azure.cognitiveservices.search.newssearch.models.Error.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.Error.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.Error.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.newssearch.models.Error.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.Error.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.newssearch.models.Error.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.Error.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ErrorCode.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ErrorCode.yml new file mode 100644 index 00000000..8441b120 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ErrorCode.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.search.newssearch.models.ErrorCode +name: ErrorCode +fullName: azure.cognitiveservices.search.newssearch.models.ErrorCode +module: azure.cognitiveservices.search.newssearch.models +fields: +- name: insufficient_authorization + uid: azure.cognitiveservices.search.newssearch.models.ErrorCode.insufficient_authorization +- name: invalid_authorization + uid: azure.cognitiveservices.search.newssearch.models.ErrorCode.invalid_authorization +- name: invalid_request + uid: azure.cognitiveservices.search.newssearch.models.ErrorCode.invalid_request +- name: none + uid: azure.cognitiveservices.search.newssearch.models.ErrorCode.none +- name: rate_limit_exceeded + uid: azure.cognitiveservices.search.newssearch.models.ErrorCode.rate_limit_exceeded +- name: server_error + uid: azure.cognitiveservices.search.newssearch.models.ErrorCode.server_error diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ErrorResponse.yml new file mode 100644 index 00000000..060ad465 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ErrorResponse.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.newssearch.models.ErrorResponse +name: ErrorResponse +fullName: azure.cognitiveservices.search.newssearch.models.ErrorResponse +module: azure.cognitiveservices.search.newssearch.models +summary: 'The top-level response that represents a failed request. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ErrorResponse(*, errors, **kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: errors + description: 'Required. A list of errors that describe the reasons why + + the request failed.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: errors + isRequired: true +variables: +- description: A String identifier. + name: id + types: + - +- description: The URL To Bing's search result for this item. + name: web_search_url + types: + - +methods: +- uid: azure.cognitiveservices.search.newssearch.models.ErrorResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.ErrorResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.ErrorResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.newssearch.models.ErrorResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.ErrorResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.newssearch.models.ErrorResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.ErrorResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ErrorResponseException.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ErrorResponseException.yml new file mode 100644 index 00000000..832e3929 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ErrorResponseException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.newssearch.models.ErrorResponseException +name: ErrorResponseException +fullName: azure.cognitiveservices.search.newssearch.models.ErrorResponseException +module: azure.cognitiveservices.search.newssearch.models +summary: 'Server responsed with exception of type: ''ErrorResponse''.' +constructor: + syntax: ErrorResponseException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.cognitiveservices.search.newssearch.models.ErrorResponseException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cognitiveservices.search.newssearch.models.ErrorResponseException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cognitiveservices.search.newssearch.models.ErrorResponseException.args + name: args diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ErrorSubCode.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ErrorSubCode.yml new file mode 100644 index 00000000..b2afe438 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ErrorSubCode.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.search.newssearch.models.ErrorSubCode +name: ErrorSubCode +fullName: azure.cognitiveservices.search.newssearch.models.ErrorSubCode +module: azure.cognitiveservices.search.newssearch.models +fields: +- name: authorization_disabled + uid: azure.cognitiveservices.search.newssearch.models.ErrorSubCode.authorization_disabled +- name: authorization_expired + uid: azure.cognitiveservices.search.newssearch.models.ErrorSubCode.authorization_expired +- name: authorization_missing + uid: azure.cognitiveservices.search.newssearch.models.ErrorSubCode.authorization_missing +- name: authorization_redundancy + uid: azure.cognitiveservices.search.newssearch.models.ErrorSubCode.authorization_redundancy +- name: blocked + uid: azure.cognitiveservices.search.newssearch.models.ErrorSubCode.blocked +- name: http_not_allowed + uid: azure.cognitiveservices.search.newssearch.models.ErrorSubCode.http_not_allowed +- name: not_implemented + uid: azure.cognitiveservices.search.newssearch.models.ErrorSubCode.not_implemented +- name: parameter_invalid_value + uid: azure.cognitiveservices.search.newssearch.models.ErrorSubCode.parameter_invalid_value +- name: parameter_missing + uid: azure.cognitiveservices.search.newssearch.models.ErrorSubCode.parameter_missing +- name: resource_error + uid: azure.cognitiveservices.search.newssearch.models.ErrorSubCode.resource_error +- name: unexpected_error + uid: azure.cognitiveservices.search.newssearch.models.ErrorSubCode.unexpected_error diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Freshness.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Freshness.yml new file mode 100644 index 00000000..2230c5c3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Freshness.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.search.newssearch.models.Freshness +name: Freshness +fullName: azure.cognitiveservices.search.newssearch.models.Freshness +module: azure.cognitiveservices.search.newssearch.models +fields: +- name: day + uid: azure.cognitiveservices.search.newssearch.models.Freshness.day +- name: month + uid: azure.cognitiveservices.search.newssearch.models.Freshness.month +- name: week + uid: azure.cognitiveservices.search.newssearch.models.Freshness.week diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Identifiable.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Identifiable.yml new file mode 100644 index 00000000..1aea11a9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Identifiable.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.newssearch.models.Identifiable +name: Identifiable +fullName: azure.cognitiveservices.search.newssearch.models.Identifiable +module: azure.cognitiveservices.search.newssearch.models +summary: 'Defines the identity of a resource. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Response + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Identifiable(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +methods: +- uid: azure.cognitiveservices.search.newssearch.models.Identifiable.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.Identifiable.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.Identifiable.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.newssearch.models.Identifiable.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.Identifiable.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.newssearch.models.Identifiable.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.Identifiable.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ImageObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ImageObject.yml new file mode 100644 index 00000000..1dc3e7b7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ImageObject.yml @@ -0,0 +1,197 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.newssearch.models.ImageObject +name: ImageObject +fullName: azure.cognitiveservices.search.newssearch.models.ImageObject +module: azure.cognitiveservices.search.newssearch.models +summary: 'Defines an image. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageObject(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: The URL To Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: A video of the item. + name: video + types: + - +- description: 'Original URL to retrieve the source (file) for the + + media object (e.g the source URL for the image).' + name: content_url + types: + - +- description: The width of the source media object, in pixels. + name: width + types: + - +- description: The height of the source media object, in pixels. + name: height + types: + - +- description: The URL to a thumbnail of the image + name: thumbnail + types: + - +methods: +- uid: azure.cognitiveservices.search.newssearch.models.ImageObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.ImageObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.ImageObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.newssearch.models.ImageObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.ImageObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.newssearch.models.ImageObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.ImageObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.MediaObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.MediaObject.yml new file mode 100644 index 00000000..7c6339a0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.MediaObject.yml @@ -0,0 +1,198 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.newssearch.models.MediaObject +name: MediaObject +fullName: azure.cognitiveservices.search.newssearch.models.MediaObject +module: azure.cognitiveservices.search.newssearch.models +summary: 'Defines a media object. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: ImageObject, VideoObject + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: MediaObject(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: The URL To Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: A video of the item. + name: video + types: + - +- description: 'Original URL to retrieve the source (file) for the + + media object (e.g the source URL for the image).' + name: content_url + types: + - +- description: The width of the source media object, in pixels. + name: width + types: + - +- description: The height of the source media object, in pixels. + name: height + types: + - +methods: +- uid: azure.cognitiveservices.search.newssearch.models.MediaObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.MediaObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.MediaObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.newssearch.models.MediaObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.MediaObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.newssearch.models.MediaObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.MediaObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.News.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.News.yml new file mode 100644 index 00000000..f205565d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.News.yml @@ -0,0 +1,164 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.newssearch.models.News +name: News +fullName: azure.cognitiveservices.search.newssearch.models.News +module: azure.cognitiveservices.search.newssearch.models +summary: 'Defines a news answer. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: News(*, value, **kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: value + description: 'Required. An array of NewsArticle objects that contain + + information about news articles that are relevant to the query. If there + + are no results to return for the request, the array is empty.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: value + isRequired: true +variables: +- description: A String identifier. + name: id + types: + - +- description: The URL To Bing's search result for this item. + name: web_search_url + types: + - +- name: follow_up_queries + types: + - [] +- description: 'The estimated number of webpages that are + + relevant to the query. Use this number along with the count and offset + + query parameters to page the results.' + name: total_estimated_matches + types: + - +- description: Location of local news + name: location + types: + - +methods: +- uid: azure.cognitiveservices.search.newssearch.models.News.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.News.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.News.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.newssearch.models.News.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.News.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.newssearch.models.News.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.News.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.NewsArticle.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.NewsArticle.yml new file mode 100644 index 00000000..7d544ee5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.NewsArticle.yml @@ -0,0 +1,205 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.newssearch.models.NewsArticle +name: NewsArticle +fullName: azure.cognitiveservices.search.newssearch.models.NewsArticle +module: azure.cognitiveservices.search.newssearch.models +summary: 'Defines a news article. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: NewsArticle(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: The URL To Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: A video of the item. + name: video + types: + - +- description: The number of words in the text of the Article. + name: word_count + types: + - +- description: 'The news category that the article belongs to. For + + example, Sports. If the news category cannot be determined, the article + + does not include this field.' + name: category + types: + - +- description: 'A Boolean value that indicates whether the news article is + + a headline. If true, the article is a headline. The article includes this + + field only for news categories requests that do not specify the category + + query parameter.' + name: headline + types: + - +- description: A list of related news articles. + name: clustered_articles + types: + - [] +methods: +- uid: azure.cognitiveservices.search.newssearch.models.NewsArticle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.NewsArticle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.NewsArticle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.newssearch.models.NewsArticle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.NewsArticle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.newssearch.models.NewsArticle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.NewsArticle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.NewsTopic.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.NewsTopic.yml new file mode 100644 index 00000000..794ff363 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.NewsTopic.yml @@ -0,0 +1,181 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.newssearch.models.NewsTopic +name: NewsTopic +fullName: azure.cognitiveservices.search.newssearch.models.NewsTopic +module: azure.cognitiveservices.search.newssearch.models +summary: 'NewsTopic. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: NewsTopic(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: The URL To Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: 'A Boolean value that indicates whether the topic + + is considered breaking news. If the topic is considered breaking news, the + + value is true.' + name: is_breaking_news + types: + - +- description: A search query term that returns this trending topic. + name: query + types: + - +- description: 'The URL to the Bing News search results for the + + search query term' + name: news_search_url + types: + - +methods: +- uid: azure.cognitiveservices.search.newssearch.models.NewsTopic.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.NewsTopic.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.NewsTopic.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.newssearch.models.NewsTopic.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.NewsTopic.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.newssearch.models.NewsTopic.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.NewsTopic.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Organization.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Organization.yml new file mode 100644 index 00000000..251e6c2c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Organization.yml @@ -0,0 +1,163 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.newssearch.models.Organization +name: Organization +fullName: azure.cognitiveservices.search.newssearch.models.Organization +module: azure.cognitiveservices.search.newssearch.models +summary: 'Defines an organization. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Organization(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: The URL To Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +methods: +- uid: azure.cognitiveservices.search.newssearch.models.Organization.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.Organization.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.Organization.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.newssearch.models.Organization.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.Organization.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.newssearch.models.Organization.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.Organization.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Query.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Query.yml new file mode 100644 index 00000000..98414dec --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Query.yml @@ -0,0 +1,166 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.newssearch.models.Query +name: Query +fullName: azure.cognitiveservices.search.newssearch.models.Query +module: azure.cognitiveservices.search.newssearch.models +summary: 'Defines a search query. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Query(*, text: str, **kwargs)' + parameters: + - name: text + description: 'Required. The query string. Use this string as the query term + + in a new search request.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: text + isRequired: true +variables: +- description: 'The display version of the query term. This version of + + the query term may contain special characters that highlight the search + + term found in the query string. The string contains the highlighting + + characters only if the query enabled hit highlighting' + name: display_text + types: + - +- description: 'The URL that takes the user to the Bing search + + results page for the query.Only related search results include this field.' + name: web_search_url + types: + - +- description: 'The URL that you use to get the results of the related + + search. Before using the URL, you must append query parameters as + + appropriate and include the Ocp-Apim-Subscription-Key header. Use this URL + + if you''re displaying the results in your own user interface. Otherwise, + + use the webSearchUrl URL.' + name: search_link + types: + - +- description: The URL to a thumbnail of a related image. + name: thumbnail + types: + - +methods: +- uid: azure.cognitiveservices.search.newssearch.models.Query.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.Query.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.Query.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.newssearch.models.Query.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.Query.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.newssearch.models.Query.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.Query.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Response.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Response.yml new file mode 100644 index 00000000..ed20c69b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Response.yml @@ -0,0 +1,144 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.newssearch.models.Response +name: Response +fullName: azure.cognitiveservices.search.newssearch.models.Response +module: azure.cognitiveservices.search.newssearch.models +summary: 'Defines a response. All schemas that could be returned at the root of a + + response should inherit from this. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Answer, Thing, ErrorResponse + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Response(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: The URL To Bing's search result for this item. + name: web_search_url + types: + - +methods: +- uid: azure.cognitiveservices.search.newssearch.models.Response.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.Response.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.Response.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.newssearch.models.Response.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.Response.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.newssearch.models.Response.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.Response.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ResponseBase.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ResponseBase.yml new file mode 100644 index 00000000..83ffe451 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.ResponseBase.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.newssearch.models.ResponseBase +name: ResponseBase +fullName: azure.cognitiveservices.search.newssearch.models.ResponseBase +module: azure.cognitiveservices.search.newssearch.models +summary: 'Response base. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Identifiable + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ResponseBase(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.search.newssearch.models.ResponseBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.ResponseBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.ResponseBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.newssearch.models.ResponseBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.ResponseBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.newssearch.models.ResponseBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.ResponseBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.SafeSearch.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.SafeSearch.yml new file mode 100644 index 00000000..e383c9c1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.SafeSearch.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.search.newssearch.models.SafeSearch +name: SafeSearch +fullName: azure.cognitiveservices.search.newssearch.models.SafeSearch +module: azure.cognitiveservices.search.newssearch.models +fields: +- name: moderate + uid: azure.cognitiveservices.search.newssearch.models.SafeSearch.moderate +- name: 'off' + uid: azure.cognitiveservices.search.newssearch.models.SafeSearch.off +- name: strict + uid: azure.cognitiveservices.search.newssearch.models.SafeSearch.strict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.SearchResultsAnswer.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.SearchResultsAnswer.yml new file mode 100644 index 00000000..e4ab0a95 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.SearchResultsAnswer.yml @@ -0,0 +1,153 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.newssearch.models.SearchResultsAnswer +name: SearchResultsAnswer +fullName: azure.cognitiveservices.search.newssearch.models.SearchResultsAnswer +module: azure.cognitiveservices.search.newssearch.models +summary: 'Defines a search result answer. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: News + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: SearchResultsAnswer(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: The URL To Bing's search result for this item. + name: web_search_url + types: + - +- name: follow_up_queries + types: + - [] +- description: 'The estimated number of webpages that are + + relevant to the query. Use this number along with the count and offset + + query parameters to page the results.' + name: total_estimated_matches + types: + - +methods: +- uid: azure.cognitiveservices.search.newssearch.models.SearchResultsAnswer.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.SearchResultsAnswer.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.SearchResultsAnswer.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.newssearch.models.SearchResultsAnswer.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.SearchResultsAnswer.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.newssearch.models.SearchResultsAnswer.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.SearchResultsAnswer.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.TextFormat.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.TextFormat.yml new file mode 100644 index 00000000..ee2810f8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.TextFormat.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.search.newssearch.models.TextFormat +name: TextFormat +fullName: azure.cognitiveservices.search.newssearch.models.TextFormat +module: azure.cognitiveservices.search.newssearch.models +fields: +- name: html + uid: azure.cognitiveservices.search.newssearch.models.TextFormat.html +- name: raw + uid: azure.cognitiveservices.search.newssearch.models.TextFormat.raw diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Thing.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Thing.yml new file mode 100644 index 00000000..d663ede0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.Thing.yml @@ -0,0 +1,168 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.newssearch.models.Thing +name: Thing +fullName: azure.cognitiveservices.search.newssearch.models.Thing +module: azure.cognitiveservices.search.newssearch.models +summary: 'Defines a thing. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: NewsTopic, CreativeWork, Organization + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Thing(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: The URL To Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +methods: +- uid: azure.cognitiveservices.search.newssearch.models.Thing.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.Thing.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.Thing.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.newssearch.models.Thing.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.Thing.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.newssearch.models.Thing.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.Thing.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.TrendingTopics.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.TrendingTopics.yml new file mode 100644 index 00000000..e6826157 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.TrendingTopics.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.newssearch.models.TrendingTopics +name: TrendingTopics +fullName: azure.cognitiveservices.search.newssearch.models.TrendingTopics +module: azure.cognitiveservices.search.newssearch.models +summary: 'TrendingTopics. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: TrendingTopics(*, value, **kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: value + description: Required. A list of trending news topics on Bing + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: value + isRequired: true +variables: +- description: A String identifier. + name: id + types: + - +- description: The URL To Bing's search result for this item. + name: web_search_url + types: + - +- name: follow_up_queries + types: + - [] +methods: +- uid: azure.cognitiveservices.search.newssearch.models.TrendingTopics.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.TrendingTopics.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.TrendingTopics.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.newssearch.models.TrendingTopics.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.TrendingTopics.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.newssearch.models.TrendingTopics.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.TrendingTopics.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.VideoObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.VideoObject.yml new file mode 100644 index 00000000..b3627053 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.VideoObject.yml @@ -0,0 +1,220 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.newssearch.models.VideoObject +name: VideoObject +fullName: azure.cognitiveservices.search.newssearch.models.VideoObject +module: azure.cognitiveservices.search.newssearch.models +summary: 'Defines a video object that is relevant to the query. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: VideoObject(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: The URL To Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: A video of the item. + name: video + types: + - +- description: 'Original URL to retrieve the source (file) for the + + media object (e.g the source URL for the image).' + name: content_url + types: + - +- description: The width of the source media object, in pixels. + name: width + types: + - +- description: The height of the source media object, in pixels. + name: height + types: + - +- name: motion_thumbnail_url + types: + - +- name: motion_thumbnail_id + types: + - +- name: embed_html + types: + - +- name: allow_https_embed + types: + - +- name: view_count + types: + - +- name: thumbnail + types: + - +- name: video_id + types: + - +- name: allow_mobile_embed + types: + - +- name: is_superfresh + types: + - +methods: +- uid: azure.cognitiveservices.search.newssearch.models.VideoObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.VideoObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.VideoObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.newssearch.models.VideoObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.newssearch.models.VideoObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.newssearch.models.VideoObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.newssearch.models.VideoObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.yml new file mode 100644 index 00000000..07252d1f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.models.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.search.newssearch.models +name: models +fullName: azure.cognitiveservices.search.newssearch.models +type: import +classes: +- azure.cognitiveservices.search.newssearch.models.Answer +- azure.cognitiveservices.search.newssearch.models.Article +- azure.cognitiveservices.search.newssearch.models.CreativeWork +- azure.cognitiveservices.search.newssearch.models.Error +- azure.cognitiveservices.search.newssearch.models.ErrorResponse +- azure.cognitiveservices.search.newssearch.models.ErrorResponseException +- azure.cognitiveservices.search.newssearch.models.Identifiable +- azure.cognitiveservices.search.newssearch.models.ImageObject +- azure.cognitiveservices.search.newssearch.models.MediaObject +- azure.cognitiveservices.search.newssearch.models.News +- azure.cognitiveservices.search.newssearch.models.NewsArticle +- azure.cognitiveservices.search.newssearch.models.NewsTopic +- azure.cognitiveservices.search.newssearch.models.Organization +- azure.cognitiveservices.search.newssearch.models.Query +- azure.cognitiveservices.search.newssearch.models.Response +- azure.cognitiveservices.search.newssearch.models.ResponseBase +- azure.cognitiveservices.search.newssearch.models.SearchResultsAnswer +- azure.cognitiveservices.search.newssearch.models.Thing +- azure.cognitiveservices.search.newssearch.models.TrendingTopics +- azure.cognitiveservices.search.newssearch.models.VideoObject +enums: +- azure.cognitiveservices.search.newssearch.models.ErrorCode +- azure.cognitiveservices.search.newssearch.models.ErrorSubCode +- azure.cognitiveservices.search.newssearch.models.Freshness +- azure.cognitiveservices.search.newssearch.models.SafeSearch +- azure.cognitiveservices.search.newssearch.models.TextFormat diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.operations.NewsOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.operations.NewsOperations.yml new file mode 100644 index 00000000..2c5d7837 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.operations.NewsOperations.yml @@ -0,0 +1,1607 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.newssearch.operations.NewsOperations +name: NewsOperations +fullName: azure.cognitiveservices.search.newssearch.operations.NewsOperations +module: azure.cognitiveservices.search.newssearch.operations +summary: 'NewsOperations operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: NewsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'Activate swagger compliance. Constant value: "true".' + name: x_bing_apis_sdk +methods: +- uid: azure.cognitiveservices.search.newssearch.operations.NewsOperations.category + name: category + summary: 'The News Category API lets you search on Bing and get back a list of + + top news articles by category. This section provides technical details + + about the query parameters and headers that you use to request news and + + the JSON response objects that contain them. For examples that show + + how to make requests, see [Searching the web for + + news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).' + signature: category(accept_language=None, user_agent=None, client_id=None, client_ip=None, + location=None, country_code=None, category=None, count=None, headline_count=None, + market=None, offset=None, original_image=None, safe_search=None, set_lang=None, + text_decorations=None, text_format=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: accept_language + description: 'A comma-delimited list of one or more + + languages to use for user interface strings. The list is in decreasing + + order of preference. For additional information, including expected + + format, see + + [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). + + This header and the + + [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang) + + query parameter are mutually exclusive; do not specify both. If you + + set this header, you must also specify the + + [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc) + + query parameter. To determine the market to return results for, Bing + + uses the first supported language it finds from the list and combines + + it with the cc parameter value. If the list does not include a + + supported language, Bing finds the closest language and market that + + supports the request or it uses an aggregated or default market for + + the results. To determine the market that Bing used, see the + + BingAPIs-Market header. Use this header and the cc query parameter + + only if you specify multiple languages. Otherwise, use the + + [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#mkt) + + and + + [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang) + + query parameters. A user interface string is a string that''s used as a + + label in a user interface. There are few user interface strings in the + + JSON response objects. Any links to Bing.com properties in the + + response objects apply the specified language.' + defaultValue: None + types: + - + - name: user_agent + description: 'The user agent originating the request. Bing uses + + the user agent to provide mobile users with an optimized experience. + + Although optional, you are encouraged to always specify this header. + + The user-agent should be the same string that any commonly used + + browser sends. For information about user agents, see [RFC + + 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The + + following are examples of user-agent strings. Windows Phone: + + Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; + + IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 + + (Linux; U; Android 2.3.5; en - us; SCH - I500 Build / GINGERBREAD) + + AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0 Mobile Safari / + + 533.1. iPhone: Mozilla / 5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) + + AppleWebKit / 536.26 (KHTML; like Gecko) Mobile / 10B142 iPhone4; 1 + + BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows NT 6.3; + + WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko. iPad: Mozilla / 5.0 + + (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1 (KHTML, like + + Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53' + defaultValue: None + types: + - + - name: client_id + description: 'Bing uses this header to provide users with + + consistent behavior across Bing API calls. Bing often flights new + + features and improvements, and it uses the client ID as a key for + + assigning traffic on different flights. If you do not use the same + + client ID for a user across multiple requests, then Bing may assign + + the user to multiple conflicting flights. Being assigned to multiple + + conflicting flights can lead to an inconsistent user experience. For + + example, if the second request has a different flight assignment than + + the first, the experience may be unexpected. Also, Bing can use the + + client ID to tailor web results to that client ID''s search history, + + providing a richer experience for the user. Bing also uses this header + + to help improve result rankings by analyzing the activity generated by + + a client ID. The relevance improvements help with better quality of + + results delivered by Bing APIs and in turn enables higher + + click-through rates for the API consumer. IMPORTANT: Although + + optional, you should consider this header required. Persisting the + + client ID across multiple requests for the same end user and device + + combination enables 1) the API consumer to receive a consistent user + + experience, and 2) higher click-through rates via better quality of + + results from the Bing APIs. Each user that uses your application on + + the device must have a unique, Bing generated client ID. If you do not + + include this header in the request, Bing generates an ID and returns + + it in the X-MSEdge-ClientID response header. The only time that you + + should NOT include this header in a request is the first time the user + + uses your app on that device. Use the client ID for each Bing API + + request that your app makes for this user on the device. Persist the + + client ID. To persist the ID in a browser app, use a persistent HTTP + + cookie to ensure the ID is used across all sessions. Do not use a + + session cookie. For other apps such as mobile apps, use the device''s + + persistent storage to persist the ID. The next time the user uses your + + app on that device, get the client ID that you persisted. Bing + + responses may or may not include this header. If the response includes + + this header, capture the client ID and use it for all subsequent Bing + + requests for the user on that device. If you include the + + X-MSEdge-ClientID, you must not include cookies in the request.' + defaultValue: None + types: + - + - name: client_ip + description: 'The IPv4 or IPv6 address of the client device. The + + IP address is used to discover the user''s location. Bing uses the + + location information to determine safe search behavior. Although + + optional, you are encouraged to always specify this header and the + + X-Search-Location header. Do not obfuscate the address (for example, + + by changing the last octet to 0). Obfuscating the address results in + + the location not being anywhere near the device''s actual location, + + which may result in Bing serving erroneous results.' + defaultValue: None + types: + - + - name: location + description: 'A semicolon-delimited list of key/value pairs that + + describe the client''s geographical location. Bing uses the location + + information to determine safe search behavior and to return relevant + + local content. Specify the key/value pair as :. The + + following are the keys that you use to specify the user''s location. + + lat (required): The latitude of the client''s location, in degrees. The + + latitude must be greater than or equal to -90.0 and less than or equal + + to +90.0. Negative values indicate southern latitudes and positive + + values indicate northern latitudes. long (required): The longitude of + + the client''s location, in degrees. The longitude must be greater than + + or equal to -180.0 and less than or equal to +180.0. Negative values + + indicate western longitudes and positive values indicate eastern + + longitudes. re (required): The radius, in meters, which specifies the + + horizontal accuracy of the coordinates. Pass the value returned by the + + device''s location service. Typical values might be 22m for GPS/Wi-Fi, + + 380m for cell tower triangulation, and 18,000m for reverse IP lookup. + + ts (optional): The UTC UNIX timestamp of when the client was at the + + location. (The UNIX timestamp is the number of seconds since January + + 1, 1970.) head (optional): The client''s relative heading or direction + + of travel. Specify the direction of travel as degrees from 0 through + + 360, counting clockwise relative to true north. Specify this key only + + if the sp key is nonzero. sp (optional): The horizontal velocity + + (speed), in meters per second, that the client device is traveling. + + alt (optional): The altitude of the client device, in meters. are + + (optional): The radius, in meters, that specifies the vertical + + accuracy of the coordinates. Specify this key only if you specify the + + alt key. Although many of the keys are optional, the more information + + that you provide, the more accurate the location results are. Although + + optional, you are encouraged to always specify the user''s geographical + + location. Providing the location is especially important if the + + client''s IP address does not accurately reflect the user''s physical + + location (for example, if the client uses VPN). For optimal results, + + you should include this header and the X-MSEdge-ClientIP header, but + + at a minimum, you should include this header.' + defaultValue: None + types: + - + - name: country_code + description: "A 2-character country code of the country where\nthe results come\ + \ from. This API supports only the United States\nmarket. If you specify this\ + \ query parameter, it must be set to us. If\nyou set this parameter, you must\ + \ also specify the Accept-Language\nheader. Bing uses the first supported language\ + \ it finds from the\nlanguages list, and combine that language with the country\ + \ code that\nyou specify to determine the market to return results for. If the\n\ + languages list does not include a supported language, Bing finds the\nclosest\ + \ language and market that supports the request, or it may use\nan aggregated\ + \ or default market for the results instead of a specified\none. You should\ + \ use this query parameter and the Accept-Language query\nparameter only if\ + \ you specify multiple languages; otherwise, you\nshould use the mkt and setLang\ + \ query parameters. This parameter and\nthe mkt query parameter are mutually\ + \ exclusive\u2014do not specify both." + defaultValue: None + types: + - + - name: category + description: 'The category of articles to return. For example, + + Sports articles or Entertainment articles. For a list of possible + + categories, see [News Categories by + + Market](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#categories-by-market). + + Use this parameter only with News Category API. If you do not specify + + this parameter, the response includes both: Headline articles + + typically published in the last 24 hours from any category and + + articles from each parent category (up to four articles). If the + + article is a headline, the article''s headline field is set to true. By + + default, the response includes up to 12 headline articles. To specify + + the number of headline articles to return, set the + + [headlineCount](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#headlineCount) + + query parameter.' + defaultValue: None + types: + - + - name: count + description: 'The number of news articles to return in the response. + + The actual number delivered may be less than requested. The default is + + 10 and the maximum value is 100. The actual number delivered may be + + less than requested.You may use this parameter along with the offset + + parameter to page results. For example, if your user interface + + displays 20 articles per page, set count to 20 and offset to 0 to get + + the first page of results. For each subsequent page, increment offset + + by 20 (for example, 0, 20, 40). It is possible for multiple pages to + + include some overlap in results. If you do not specify the + + [category](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#category) + + parameter, Bing ignores this parameter.' + defaultValue: None + types: + - + - name: headline_count + description: 'The number of headline articles to return in + + the response. The default is 12. Specify this parameter only if you do + + not specify the + + [category](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#category) + + parameter.' + defaultValue: None + types: + - + - name: market + description: "The market where the results come from. Typically, mkt\nis the country\ + \ where the user is making the request from. However, it\ncould be a different\ + \ country if the user is not located in a country\nwhere Bing delivers results.\ + \ The market must be in the form -. For example,\ + \ en-US. The string is case\ninsensitive. For a list of possible market values,\ + \ see [Market\nCodes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes).\n\ + NOTE: If known, you are encouraged to always specify the market.\nSpecifying\ + \ the market helps Bing route the request and return an\nappropriate and optimal\ + \ response. If you specify a market that is not\nlisted in [Market\nCodes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes),\n\ + Bing uses a best fit market code based on an internal mapping that is\nsubject\ + \ to change. This parameter and the\n[cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc)\n\ + query parameter are mutually exclusive\u2014do not specify both." + defaultValue: None + types: + - + - name: offset + description: 'The zero-based offset that indicates the number of news + + to skip before returning news. The default is 0. The offset should be + + less than + + ([totalEstimatedMatches](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#news-totalmatches) + + - count). Use this parameter along with the count parameter to page + + results. For example, if your user interface displays 20 news per + + page, set count to 20 and offset to 0 to get the first page of + + results. For each subsequent page, increment offset by 20 (for + + example, 0, 20, 40). It is possible for multiple pages to include some + + overlap in results. If you do not specify the + + [category](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#category) + + parameter, Bing ignores this parameter.' + defaultValue: None + types: + - + - name: original_image + description: 'A Boolean value that determines whether the + + image''s contentUrl contains a URL that points to a thumbnail of the + + original article''s image or the image itself. If the article includes + + an image, and this parameter is set to true, the image''s contentUrl + + property contains a URL that you may use to download the original + + image from the publisher''s website. Otherwise, if this parameter is + + false, the image''s contentUrl and thumbnailUrl URLs both point to the + + same thumbnail image. Use this parameter only with the News Search API + + or News Category API. Trending Topics API ignore this parameter.' + defaultValue: None + types: + - + - name: safe_search + description: 'Filter news for adult content. The following are + + the possible filter values. Off: Return news articles with adult text, + + images, or videos. Moderate: Return news articles with adult text but + + not adult images or videos. Strict: Do not return news articles with + + adult text, images, or videos. If the request comes from a market that + + Bing''s adult policy requires that safeSearch is set to Strict, Bing + + ignores the safeSearch value and uses Strict. If you use the site: + + query operator, there is the chance that the response may contain + + adult content regardless of what the safeSearch query parameter is set + + to. Use site: only if you are aware of the content on the site and + + your scenario supports the possibility of adult content. Possible + + values include: ''Off'', ''Moderate'', ''Strict''' + defaultValue: None + types: + - + - + - name: set_lang + description: 'The language to use for user interface strings. + + Specify the language using the ISO 639-1 2-letter language code. For + + example, the language code for English is EN. The default is EN + + (English). Although optional, you should always specify the language. + + Typically, you set setLang to the same language specified by mkt + + unless the user wants the user interface strings displayed in a + + different language. This parameter and the + + [Accept-Language](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#acceptlanguage) + + header are mutually exclusive; do not specify both. A user interface + + string is a string that''s used as a label in a user interface. There + + are few user interface strings in the JSON response objects. Also, any + + links to Bing.com properties in the response objects apply the + + specified language.' + defaultValue: None + types: + - + - name: text_decorations + description: 'A Boolean value that determines whether + + display strings contain decoration markers such as hit highlighting + + characters. If true, the strings may include markers. The default is + + false. To specify whether to use Unicode characters or HTML tags as + + the markers, see the + + [textFormat](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#textformat) + + query parameter. For information about hit highlighting, see [Hit + + Highlighting](https://docs.microsoft.com/azure/cognitive-services/bing-news-search/hit-highlighting).' + defaultValue: None + types: + - + - name: text_format + description: "The type of markers to use for text decorations\n(see the textDecorations\ + \ query parameter). Possible values are Raw\u2014Use\nUnicode characters to\ + \ mark content that needs special formatting. The\nUnicode characters are in\ + \ the range E000 through E019. For example,\nBing uses E000 and E001 to mark\ + \ the beginning and end of query terms\nfor hit highlighting. HTML\u2014Use\ + \ HTML tags to mark content that needs\nspecial formatting. For example, use\ + \ tags to highlight query terms\nin display strings. The default is Raw.\ + \ For display strings that\ncontain escapable HTML characters such as <, >,\ + \ and &, if textFormat\nis set to HTML, Bing escapes the characters as appropriate\ + \ (for\nexample, < is escaped to <). Possible values include: 'Raw', 'Html'" + defaultValue: None + types: + - + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: News or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.search.newssearch.models.ErrorResponseException +- uid: azure.cognitiveservices.search.newssearch.operations.NewsOperations.search + name: search + summary: 'The News Search API lets you send a search query to Bing and get back + a + + list of news that are relevant to the search query. This section + + provides technical details about the query parameters and headers that + + you use to request news and the JSON response objects that contain + + them. For examples that show how to make requests, see [Searching the + + web for + + news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).' + signature: search(query, accept_language=None, user_agent=None, client_id=None, + client_ip=None, location=None, country_code=None, count=None, freshness=None, + market=None, offset=None, original_image=None, safe_search=None, set_lang=None, + sort_by=None, text_decorations=None, text_format=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: query + description: 'The user''s search query string. The query string cannot + + be empty. The query string may contain [Bing Advanced + + Operators](http://msdn.microsoft.com/library/ff795620.aspx). For + + example, to limit news to a specific domain, use the + + [site:](http://msdn.microsoft.com/library/ff795613.aspx) operator. Use + + this parameter only with the News Search API. Do not specify this + + parameter when calling the Trending Topics API or News Category API.' + isRequired: true + types: + - + - name: accept_language + description: 'A comma-delimited list of one or more + + languages to use for user interface strings. The list is in decreasing + + order of preference. For additional information, including expected + + format, see + + [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). + + This header and the + + [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang) + + query parameter are mutually exclusive; do not specify both. If you + + set this header, you must also specify the + + [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc) + + query parameter. To determine the market to return results for, Bing + + uses the first supported language it finds from the list and combines + + it with the cc parameter value. If the list does not include a + + supported language, Bing finds the closest language and market that + + supports the request or it uses an aggregated or default market for + + the results. To determine the market that Bing used, see the + + BingAPIs-Market header. Use this header and the cc query parameter + + only if you specify multiple languages. Otherwise, use the + + [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#mkt) + + and + + [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang) + + query parameters. A user interface string is a string that''s used as a + + label in a user interface. There are few user interface strings in the + + JSON response objects. Any links to Bing.com properties in the + + response objects apply the specified language.' + defaultValue: None + types: + - + - name: user_agent + description: 'The user agent originating the request. Bing uses + + the user agent to provide mobile users with an optimized experience. + + Although optional, you are encouraged to always specify this header. + + The user-agent should be the same string that any commonly used + + browser sends. For information about user agents, see [RFC + + 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The + + following are examples of user-agent strings. Windows Phone: + + Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; + + IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 + + (Linux; U; Android 2.3.5; en - us; SCH - I500 Build / GINGERBREAD) + + AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0 Mobile Safari / + + 533.1. iPhone: Mozilla / 5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) + + AppleWebKit / 536.26 (KHTML; like Gecko) Mobile / 10B142 iPhone4; 1 + + BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows NT 6.3; + + WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko. iPad: Mozilla / 5.0 + + (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1 (KHTML, like + + Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53' + defaultValue: None + types: + - + - name: client_id + description: 'Bing uses this header to provide users with + + consistent behavior across Bing API calls. Bing often flights new + + features and improvements, and it uses the client ID as a key for + + assigning traffic on different flights. If you do not use the same + + client ID for a user across multiple requests, then Bing may assign + + the user to multiple conflicting flights. Being assigned to multiple + + conflicting flights can lead to an inconsistent user experience. For + + example, if the second request has a different flight assignment than + + the first, the experience may be unexpected. Also, Bing can use the + + client ID to tailor web results to that client ID''s search history, + + providing a richer experience for the user. Bing also uses this header + + to help improve result rankings by analyzing the activity generated by + + a client ID. The relevance improvements help with better quality of + + results delivered by Bing APIs and in turn enables higher + + click-through rates for the API consumer. IMPORTANT: Although + + optional, you should consider this header required. Persisting the + + client ID across multiple requests for the same end user and device + + combination enables 1) the API consumer to receive a consistent user + + experience, and 2) higher click-through rates via better quality of + + results from the Bing APIs. Each user that uses your application on + + the device must have a unique, Bing generated client ID. If you do not + + include this header in the request, Bing generates an ID and returns + + it in the X-MSEdge-ClientID response header. The only time that you + + should NOT include this header in a request is the first time the user + + uses your app on that device. Use the client ID for each Bing API + + request that your app makes for this user on the device. Persist the + + client ID. To persist the ID in a browser app, use a persistent HTTP + + cookie to ensure the ID is used across all sessions. Do not use a + + session cookie. For other apps such as mobile apps, use the device''s + + persistent storage to persist the ID. The next time the user uses your + + app on that device, get the client ID that you persisted. Bing + + responses may or may not include this header. If the response includes + + this header, capture the client ID and use it for all subsequent Bing + + requests for the user on that device. If you include the + + X-MSEdge-ClientID, you must not include cookies in the request.' + defaultValue: None + types: + - + - name: client_ip + description: 'The IPv4 or IPv6 address of the client device. The + + IP address is used to discover the user''s location. Bing uses the + + location information to determine safe search behavior. Although + + optional, you are encouraged to always specify this header and the + + X-Search-Location header. Do not obfuscate the address (for example, + + by changing the last octet to 0). Obfuscating the address results in + + the location not being anywhere near the device''s actual location, + + which may result in Bing serving erroneous results.' + defaultValue: None + types: + - + - name: location + description: 'A semicolon-delimited list of key/value pairs that + + describe the client''s geographical location. Bing uses the location + + information to determine safe search behavior and to return relevant + + local content. Specify the key/value pair as :. The + + following are the keys that you use to specify the user''s location. + + lat (required): The latitude of the client''s location, in degrees. The + + latitude must be greater than or equal to -90.0 and less than or equal + + to +90.0. Negative values indicate southern latitudes and positive + + values indicate northern latitudes. long (required): The longitude of + + the client''s location, in degrees. The longitude must be greater than + + or equal to -180.0 and less than or equal to +180.0. Negative values + + indicate western longitudes and positive values indicate eastern + + longitudes. re (required): The radius, in meters, which specifies the + + horizontal accuracy of the coordinates. Pass the value returned by the + + device''s location service. Typical values might be 22m for GPS/Wi-Fi, + + 380m for cell tower triangulation, and 18,000m for reverse IP lookup. + + ts (optional): The UTC UNIX timestamp of when the client was at the + + location. (The UNIX timestamp is the number of seconds since January + + 1, 1970.) head (optional): The client''s relative heading or direction + + of travel. Specify the direction of travel as degrees from 0 through + + 360, counting clockwise relative to true north. Specify this key only + + if the sp key is nonzero. sp (optional): The horizontal velocity + + (speed), in meters per second, that the client device is traveling. + + alt (optional): The altitude of the client device, in meters. are + + (optional): The radius, in meters, that specifies the vertical + + accuracy of the coordinates. Specify this key only if you specify the + + alt key. Although many of the keys are optional, the more information + + that you provide, the more accurate the location results are. Although + + optional, you are encouraged to always specify the user''s geographical + + location. Providing the location is especially important if the + + client''s IP address does not accurately reflect the user''s physical + + location (for example, if the client uses VPN). For optimal results, + + you should include this header and the X-MSEdge-ClientIP header, but + + at a minimum, you should include this header.' + defaultValue: None + types: + - + - name: country_code + description: "A 2-character country code of the country where\nthe results come\ + \ from. This API supports only the United States\nmarket. If you specify this\ + \ query parameter, it must be set to us. If\nyou set this parameter, you must\ + \ also specify the Accept-Language\nheader. Bing uses the first supported language\ + \ it finds from the\nlanguages list, and combine that language with the country\ + \ code that\nyou specify to determine the market to return results for. If the\n\ + languages list does not include a supported language, Bing finds the\nclosest\ + \ language and market that supports the request, or it may use\nan aggregated\ + \ or default market for the results instead of a specified\none. You should\ + \ use this query parameter and the Accept-Language query\nparameter only if\ + \ you specify multiple languages; otherwise, you\nshould use the mkt and setLang\ + \ query parameters. This parameter and\nthe mkt query parameter are mutually\ + \ exclusive\u2014do not specify both." + defaultValue: None + types: + - + - name: count + description: 'The number of news articles to return in the response. + + The actual number delivered may be less than requested. The default is + + 10 and the maximum value is 100. The actual number delivered may be + + less than requested.You may use this parameter along with the offset + + parameter to page results. For example, if your user interface + + displays 20 articles per page, set count to 20 and offset to 0 to get + + the first page of results. For each subsequent page, increment offset + + by 20 (for example, 0, 20, 40). It is possible for multiple pages to + + include some overlap in results.' + defaultValue: None + types: + - + - name: freshness + description: 'Filter news by the date and time that Bing + + discovered the news. The following are the possible filter values. + + Day: Return news discovered within the last 24 hours. Week: Return + + news discovered within the last 7 days. Month: Return news discovered + + within the last 30 days. Use this parameter only with the News Search + + API. Do not specify this parameter when calling the News Category API + + or the Trending Topics API. Possible values include: ''Day'', ''Week'', + + ''Month''' + defaultValue: None + types: + - + - + - name: market + description: "The market where the results come from. Typically, mkt\nis the country\ + \ where the user is making the request from. However, it\ncould be a different\ + \ country if the user is not located in a country\nwhere Bing delivers results.\ + \ The market must be in the form -. For example,\ + \ en-US. The string is case\ninsensitive. For a list of possible market values,\ + \ see [Market\nCodes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes).\n\ + NOTE: If known, you are encouraged to always specify the market.\nSpecifying\ + \ the market helps Bing route the request and return an\nappropriate and optimal\ + \ response. If you specify a market that is not\nlisted in [Market\nCodes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes),\n\ + Bing uses a best fit market code based on an internal mapping that is\nsubject\ + \ to change. This parameter and the\n[cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc)\n\ + query parameter are mutually exclusive\u2014do not specify both." + defaultValue: None + types: + - + - name: offset + description: 'The zero-based offset that indicates the number of news + + to skip before returning news. The default is 0. The offset should be + + less than + + ([totalEstimatedMatches](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#news-totalmatches) + + - count). Use this parameter along with the count parameter to page + + results. For example, if your user interface displays 20 news per + + page, set count to 20 and offset to 0 to get the first page of + + results. For each subsequent page, increment offset by 20 (for + + example, 0, 20, 40). It is possible for multiple pages to include some + + overlap in results.' + defaultValue: None + types: + - + - name: original_image + description: 'A Boolean value that determines whether the + + image''s contentUrl contains a URL that points to a thumbnail of the + + original article''s image or the image itself. If the article includes + + an image, and this parameter is set to true, the image''s contentUrl + + property contains a URL that you may use to download the original + + image from the publisher''s website. Otherwise, if this parameter is + + false, the image''s contentUrl and thumbnailUrl URLs both point to the + + same thumbnail image. Use this parameter only with the News Search + + API. Do not specify this parameter when calling the Trending Topics + + API or News Category API.' + defaultValue: None + types: + - + - name: safe_search + description: 'Filter news for adult content. The following are + + the possible filter values. Off: Return news articles with adult text, + + images, or videos. Moderate: Return news articles with adult text but + + not adult images or videos. Strict: Do not return news articles with + + adult text, images, or videos. If the request comes from a market that + + Bing''s adult policy requires that safeSearch is set to Strict, Bing + + ignores the safeSearch value and uses Strict. If you use the site: + + query operator, there is the chance that the response may contain + + adult content regardless of what the safeSearch query parameter is set + + to. Use site: only if you are aware of the content on the site and + + your scenario supports the possibility of adult content. Possible + + values include: ''Off'', ''Moderate'', ''Strict''' + defaultValue: None + types: + - + - + - name: set_lang + description: 'The language to use for user interface strings. + + Specify the language using the ISO 639-1 2-letter language code. For + + example, the language code for English is EN. The default is EN + + (English). Although optional, you should always specify the language. + + Typically, you set setLang to the same language specified by mkt + + unless the user wants the user interface strings displayed in a + + different language. This parameter and the + + [Accept-Language](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#acceptlanguage) + + header are mutually exclusive; do not specify both. A user interface + + string is a string that''s used as a label in a user interface. There + + are few user interface strings in the JSON response objects. Also, any + + links to Bing.com properties in the response objects apply the + + specified language.' + defaultValue: None + types: + - + - name: sort_by + description: 'The order to return the news in. The following are the + + possible case-insensitive values. Date: If the request is through the + + News Search API, the response returns news articles sorted by date + + from the most recent to the oldest. If the request is through the News + + Trending Topics API, the response returns trending topics sorted by + + date from the most recent to the oldest.' + defaultValue: None + types: + - + - name: text_decorations + description: 'A Boolean value that determines whether + + display strings contain decoration markers such as hit highlighting + + characters. If true, the strings may include markers. The default is + + false. To specify whether to use Unicode characters or HTML tags as + + the markers, see the + + [textFormat](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#textformat) + + query parameter. For information about hit highlighting, see [Hit + + Highlighting](https://docs.microsoft.com/azure/cognitive-services/bing-news-search/hit-highlighting).' + defaultValue: None + types: + - + - name: text_format + description: "The type of markers to use for text decorations\n(see the textDecorations\ + \ query parameter). Possible values are Raw\u2014Use\nUnicode characters to\ + \ mark content that needs special formatting. The\nUnicode characters are in\ + \ the range E000 through E019. For example,\nBing uses E000 and E001 to mark\ + \ the beginning and end of query terms\nfor hit highlighting. HTML\u2014Use\ + \ HTML tags to mark content that needs\nspecial formatting. For example, use\ + \ tags to highlight query terms\nin display strings. The default is Raw.\ + \ For display strings that\ncontain escapable HTML characters such as <, >,\ + \ and &, if textFormat\nis set to HTML, Bing escapes the characters as appropriate\ + \ (for\nexample, < is escaped to <). Possible values include: 'Raw', 'Html'" + defaultValue: None + types: + - + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: News or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.search.newssearch.models.ErrorResponseException +- uid: azure.cognitiveservices.search.newssearch.operations.NewsOperations.trending + name: trending + summary: 'The News Trending Topics API lets you search on Bing and get back a + + list of trending news topics that are currently trending on Bing. This + + section provides technical details about the query parameters and + + headers that you use to request news and the JSON response objects that + + contain them. For examples that show how to make requests, see + + [Searching the web for + + news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).' + signature: trending(accept_language=None, user_agent=None, client_id=None, client_ip=None, + location=None, country_code=None, count=None, market=None, offset=None, safe_search=None, + set_lang=None, since=None, sort_by=None, text_decorations=None, text_format=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: accept_language + description: 'A comma-delimited list of one or more + + languages to use for user interface strings. The list is in decreasing + + order of preference. For additional information, including expected + + format, see + + [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). + + This header and the + + [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang) + + query parameter are mutually exclusive; do not specify both. If you + + set this header, you must also specify the + + [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc) + + query parameter. To determine the market to return results for, Bing + + uses the first supported language it finds from the list and combines + + it with the cc parameter value. If the list does not include a + + supported language, Bing finds the closest language and market that + + supports the request or it uses an aggregated or default market for + + the results. To determine the market that Bing used, see the + + BingAPIs-Market header. Use this header and the cc query parameter + + only if you specify multiple languages. Otherwise, use the + + [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#mkt) + + and + + [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang) + + query parameters. A user interface string is a string that''s used as a + + label in a user interface. There are few user interface strings in the + + JSON response objects. Any links to Bing.com properties in the + + response objects apply the specified language.' + defaultValue: None + types: + - + - name: user_agent + description: 'The user agent originating the request. Bing uses + + the user agent to provide mobile users with an optimized experience. + + Although optional, you are encouraged to always specify this header. + + The user-agent should be the same string that any commonly used + + browser sends. For information about user agents, see [RFC + + 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The + + following are examples of user-agent strings. Windows Phone: + + Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; + + IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 + + (Linux; U; Android 2.3.5; en - us; SCH - I500 Build / GINGERBREAD) + + AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0 Mobile Safari / + + 533.1. iPhone: Mozilla / 5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) + + AppleWebKit / 536.26 (KHTML; like Gecko) Mobile / 10B142 iPhone4; 1 + + BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows NT 6.3; + + WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko. iPad: Mozilla / 5.0 + + (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1 (KHTML, like + + Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53' + defaultValue: None + types: + - + - name: client_id + description: 'Bing uses this header to provide users with + + consistent behavior across Bing API calls. Bing often flights new + + features and improvements, and it uses the client ID as a key for + + assigning traffic on different flights. If you do not use the same + + client ID for a user across multiple requests, then Bing may assign + + the user to multiple conflicting flights. Being assigned to multiple + + conflicting flights can lead to an inconsistent user experience. For + + example, if the second request has a different flight assignment than + + the first, the experience may be unexpected. Also, Bing can use the + + client ID to tailor web results to that client ID''s search history, + + providing a richer experience for the user. Bing also uses this header + + to help improve result rankings by analyzing the activity generated by + + a client ID. The relevance improvements help with better quality of + + results delivered by Bing APIs and in turn enables higher + + click-through rates for the API consumer. IMPORTANT: Although + + optional, you should consider this header required. Persisting the + + client ID across multiple requests for the same end user and device + + combination enables 1) the API consumer to receive a consistent user + + experience, and 2) higher click-through rates via better quality of + + results from the Bing APIs. Each user that uses your application on + + the device must have a unique, Bing generated client ID. If you do not + + include this header in the request, Bing generates an ID and returns + + it in the X-MSEdge-ClientID response header. The only time that you + + should NOT include this header in a request is the first time the user + + uses your app on that device. Use the client ID for each Bing API + + request that your app makes for this user on the device. Persist the + + client ID. To persist the ID in a browser app, use a persistent HTTP + + cookie to ensure the ID is used across all sessions. Do not use a + + session cookie. For other apps such as mobile apps, use the device''s + + persistent storage to persist the ID. The next time the user uses your + + app on that device, get the client ID that you persisted. Bing + + responses may or may not include this header. If the response includes + + this header, capture the client ID and use it for all subsequent Bing + + requests for the user on that device. If you include the + + X-MSEdge-ClientID, you must not include cookies in the request.' + defaultValue: None + types: + - + - name: client_ip + description: 'The IPv4 or IPv6 address of the client device. The + + IP address is used to discover the user''s location. Bing uses the + + location information to determine safe search behavior. Although + + optional, you are encouraged to always specify this header and the + + X-Search-Location header. Do not obfuscate the address (for example, + + by changing the last octet to 0). Obfuscating the address results in + + the location not being anywhere near the device''s actual location, + + which may result in Bing serving erroneous results.' + defaultValue: None + types: + - + - name: location + description: 'A semicolon-delimited list of key/value pairs that + + describe the client''s geographical location. Bing uses the location + + information to determine safe search behavior and to return relevant + + local content. Specify the key/value pair as :. The + + following are the keys that you use to specify the user''s location. + + lat (required): The latitude of the client''s location, in degrees. The + + latitude must be greater than or equal to -90.0 and less than or equal + + to +90.0. Negative values indicate southern latitudes and positive + + values indicate northern latitudes. long (required): The longitude of + + the client''s location, in degrees. The longitude must be greater than + + or equal to -180.0 and less than or equal to +180.0. Negative values + + indicate western longitudes and positive values indicate eastern + + longitudes. re (required): The radius, in meters, which specifies the + + horizontal accuracy of the coordinates. Pass the value returned by the + + device''s location service. Typical values might be 22m for GPS/Wi-Fi, + + 380m for cell tower triangulation, and 18,000m for reverse IP lookup. + + ts (optional): The UTC UNIX timestamp of when the client was at the + + location. (The UNIX timestamp is the number of seconds since January + + 1, 1970.) head (optional): The client''s relative heading or direction + + of travel. Specify the direction of travel as degrees from 0 through + + 360, counting clockwise relative to true north. Specify this key only + + if the sp key is nonzero. sp (optional): The horizontal velocity + + (speed), in meters per second, that the client device is traveling. + + alt (optional): The altitude of the client device, in meters. are + + (optional): The radius, in meters, that specifies the vertical + + accuracy of the coordinates. Specify this key only if you specify the + + alt key. Although many of the keys are optional, the more information + + that you provide, the more accurate the location results are. Although + + optional, you are encouraged to always specify the user''s geographical + + location. Providing the location is especially important if the + + client''s IP address does not accurately reflect the user''s physical + + location (for example, if the client uses VPN). For optimal results, + + you should include this header and the X-MSEdge-ClientIP header, but + + at a minimum, you should include this header.' + defaultValue: None + types: + - + - name: country_code + description: "A 2-character country code of the country where\nthe results come\ + \ from. This API supports only the United States\nmarket. If you specify this\ + \ query parameter, it must be set to us. If\nyou set this parameter, you must\ + \ also specify the Accept-Language\nheader. Bing uses the first supported language\ + \ it finds from the\nlanguages list, and combine that language with the country\ + \ code that\nyou specify to determine the market to return results for. If the\n\ + languages list does not include a supported language, Bing finds the\nclosest\ + \ language and market that supports the request, or it may use\nan aggregated\ + \ or default market for the results instead of a specified\none. You should\ + \ use this query parameter and the Accept-Language query\nparameter only if\ + \ you specify multiple languages; otherwise, you\nshould use the mkt and setLang\ + \ query parameters. This parameter and\nthe mkt query parameter are mutually\ + \ exclusive\u2014do not specify both." + defaultValue: None + types: + - + - name: count + description: 'The number of news articles to return in the response. + + The actual number delivered may be less than requested. The default is + + 10 and the maximum value is 100. The actual number delivered may be + + less than requested.You may use this parameter along with the offset + + parameter to page results. For example, if your user interface + + displays 20 articles per page, set count to 20 and offset to 0 to get + + the first page of results. For each subsequent page, increment offset + + by 20 (for example, 0, 20, 40). It is possible for multiple pages to + + include some overlap in results.' + defaultValue: None + types: + - + - name: market + description: "The market where the results come from. Typically, mkt\nis the country\ + \ where the user is making the request from. However, it\ncould be a different\ + \ country if the user is not located in a country\nwhere Bing delivers results.\ + \ The market must be in the form -. For example,\ + \ en-US. The string is case\ninsensitive. For a list of possible market values,\ + \ see [Market\nCodes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes).\n\ + NOTE: If known, you are encouraged to always specify the market.\nSpecifying\ + \ the market helps Bing route the request and return an\nappropriate and optimal\ + \ response. If you specify a market that is not\nlisted in [Market\nCodes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes),\n\ + Bing uses a best fit market code based on an internal mapping that is\nsubject\ + \ to change. This parameter and the\n[cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc)\n\ + query parameter are mutually exclusive\u2014do not specify both." + defaultValue: None + types: + - + - name: offset + description: 'The zero-based offset that indicates the number of news + + to skip before returning news. The default is 0. The offset should be + + less than + + ([totalEstimatedMatches](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#news-totalmatches) + + - count). Use this parameter along with the count parameter to page + + results. For example, if your user interface displays 20 news per + + page, set count to 20 and offset to 0 to get the first page of + + results. For each subsequent page, increment offset by 20 (for + + example, 0, 20, 40). It is possible for multiple pages to include some + + overlap in results.' + defaultValue: None + types: + - + - name: safe_search + description: 'Filter news for adult content. The following are + + the possible filter values. Off: Return news articles with adult text, + + images, or videos. Moderate: Return news articles with adult text but + + not adult images or videos. Strict: Do not return news articles with + + adult text, images, or videos. If the request comes from a market that + + Bing''s adult policy requires that safeSearch is set to Strict, Bing + + ignores the safeSearch value and uses Strict. If you use the site: + + query operator, there is the chance that the response may contain + + adult content regardless of what the safeSearch query parameter is set + + to. Use site: only if you are aware of the content on the site and + + your scenario supports the possibility of adult content. Possible + + values include: ''Off'', ''Moderate'', ''Strict''' + defaultValue: None + types: + - + - + - name: set_lang + description: 'The language to use for user interface strings. + + Specify the language using the ISO 639-1 2-letter language code. For + + example, the language code for English is EN. The default is EN + + (English). Although optional, you should always specify the language. + + Typically, you set setLang to the same language specified by mkt + + unless the user wants the user interface strings displayed in a + + different language. This parameter and the + + [Accept-Language](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#acceptlanguage) + + header are mutually exclusive; do not specify both. A user interface + + string is a string that''s used as a label in a user interface. There + + are few user interface strings in the JSON response objects. Also, any + + links to Bing.com properties in the response objects apply the + + specified language.' + defaultValue: None + types: + - + - name: since + description: 'The Unix epoch time (Unix timestamp) that Bing uses to + + select the trending topics. Bing returns trending topics that it + + discovered on or after the specified date and time, not the date the + + topic was published. To use this parameter, also specify the sortBy + + parameter. Use this parameter only with the News Trending Topics API. + + Do not specify this parameter when calling the News Search API or News + + Category API.' + defaultValue: None + types: + - + - name: sort_by + description: 'The order to return the news in. The following are the + + possible case-insensitive values. Date: If the request is through the + + News Search API, the response returns news articles sorted by date + + from the most recent to the oldest. If the request is through the News + + Trending Topics API, the response returns trending topics sorted by + + date from the most recent to the oldest.' + defaultValue: None + types: + - + - name: text_decorations + description: 'A Boolean value that determines whether + + display strings contain decoration markers such as hit highlighting + + characters. If true, the strings may include markers. The default is + + false. To specify whether to use Unicode characters or HTML tags as + + the markers, see the + + [textFormat](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#textformat) + + query parameter. For information about hit highlighting, see [Hit + + Highlighting](https://docs.microsoft.com/azure/cognitive-services/bing-news-search/hit-highlighting).' + defaultValue: None + types: + - + - name: text_format + description: "The type of markers to use for text decorations\n(see the textDecorations\ + \ query parameter). Possible values are Raw\u2014Use\nUnicode characters to\ + \ mark content that needs special formatting. The\nUnicode characters are in\ + \ the range E000 through E019. For example,\nBing uses E000 and E001 to mark\ + \ the beginning and end of query terms\nfor hit highlighting. HTML\u2014Use\ + \ HTML tags to mark content that needs\nspecial formatting. For example, use\ + \ tags to highlight query terms\nin display strings. The default is Raw.\ + \ For display strings that\ncontain escapable HTML characters such as <, >,\ + \ and &, if textFormat\nis set to HTML, Bing escapes the characters as appropriate\ + \ (for\nexample, < is escaped to <). Possible values include: 'Raw', 'Html'" + defaultValue: None + types: + - + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: TrendingTopics or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.search.newssearch.models.ErrorResponseException +attributes: +- uid: azure.cognitiveservices.search.newssearch.operations.NewsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.operations.yml new file mode 100644 index 00000000..0f438b73 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.operations.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.search.newssearch.operations +name: operations +fullName: azure.cognitiveservices.search.newssearch.operations +type: import +classes: +- azure.cognitiveservices.search.newssearch.operations.NewsOperations diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.version.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.version.yml new file mode 100644 index 00000000..4bbe8b3a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.newssearch.version +name: version +fullName: azure.cognitiveservices.search.newssearch.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.yml new file mode 100644 index 00000000..d4ddb3b6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-newssearch/azure.cognitiveservices.search.newssearch.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.search.newssearch +name: newssearch +fullName: azure.cognitiveservices.search.newssearch +type: rootImport +classes: +- azure.cognitiveservices.search.newssearch.NewsSearchClient +- azure.cognitiveservices.search.newssearch.NewsSearchClientConfiguration +packages: +- azure.cognitiveservices.search.newssearch.models +- azure.cognitiveservices.search.newssearch.operations +modules: +- azure.cognitiveservices.search.newssearch.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.VisualSearchClient.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.VisualSearchClient.yml new file mode 100644 index 00000000..69de36a6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.VisualSearchClient.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.VisualSearchClient +name: VisualSearchClient +fullName: azure.cognitiveservices.search.visualsearch.VisualSearchClient +module: azure.cognitiveservices.search.visualsearch +summary: Visual Search API lets you discover insights about an image such as visually + similar images, shopping sources, and related searches. The API can also perform + text recognition, identify entities (people, places, things), return other topical + content for the user to explore, and more. For more information, see [Visual Search + Overview](https://docs.microsoft.com/azure/cognitive-services/bing-visual-search/overview). +constructor: + syntax: VisualSearchClient(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and + + hostname, for example: "[https://westus.api.cognitive.microsoft.com](https://westus.api.cognitive.microsoft.com)", + + "[https://api.cognitive.microsoft.com](https://api.cognitive.microsoft.com)").' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +- description: Images operations + name: images + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.VisualSearchClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Action(class).yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Action(class).yml new file mode 100644 index 00000000..46cfaf3c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Action(class).yml @@ -0,0 +1,214 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.Action +name: Action +fullName: azure.cognitiveservices.search.visualsearch.models.Action +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines an action. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: ImageAction + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Action(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: The result produced in the action. + name: result + types: + - [] +- description: A display name for the action. + name: display_name + types: + - +- description: 'A Boolean representing whether this result is the top + + action.' + name: is_top_action + types: + - +- description: 'Use this URL to get additional data to determine how to + + take the appropriate action. For example, the serviceUrl might return JSON + + along with an image URL.' + name: service_url + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.Action.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Action.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Action.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.Action.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Action.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.Action.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Action.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.AggregateOffer.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.AggregateOffer.yml new file mode 100644 index 00000000..4289ee53 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.AggregateOffer.yml @@ -0,0 +1,265 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.AggregateOffer +name: AggregateOffer +fullName: azure.cognitiveservices.search.visualsearch.models.AggregateOffer +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines a list of offers from merchants that are related to the image. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: AggregateOffer(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: Seller for this offer. + name: seller + types: + - +- description: The item's price. + name: price + types: + - +- description: 'The monetary currency. For example, USD. Possible + + values include: ''USD'', ''CAD'', ''GBP'', ''EUR'', ''COP'', ''JPY'', ''CNY'', + ''AUD'', + + ''INR'', ''AED'', ''AFN'', ''ALL'', ''AMD'', ''ANG'', ''AOA'', ''ARS'', ''AWG'', + ''AZN'', + + ''BAM'', ''BBD'', ''BDT'', ''BGN'', ''BHD'', ''BIF'', ''BMD'', ''BND'', ''BOB'', + ''BOV'', + + ''BRL'', ''BSD'', ''BTN'', ''BWP'', ''BYR'', ''BZD'', ''CDF'', ''CHE'', ''CHF'', + ''CHW'', + + ''CLF'', ''CLP'', ''COU'', ''CRC'', ''CUC'', ''CUP'', ''CVE'', ''CZK'', ''DJF'', + ''DKK'', + + ''DOP'', ''DZD'', ''EGP'', ''ERN'', ''ETB'', ''FJD'', ''FKP'', ''GEL'', ''GHS'', + ''GIP'', + + ''GMD'', ''GNF'', ''GTQ'', ''GYD'', ''HKD'', ''HNL'', ''HRK'', ''HTG'', ''HUF'', + ''IDR'', + + ''ILS'', ''IQD'', ''IRR'', ''ISK'', ''JMD'', ''JOD'', ''KES'', ''KGS'', ''KHR'', + ''KMF'', + + ''KPW'', ''KRW'', ''KWD'', ''KYD'', ''KZT'', ''LAK'', ''LBP'', ''LKR'', ''LRD'', + ''LSL'', + + ''LYD'', ''MAD'', ''MDL'', ''MGA'', ''MKD'', ''MMK'', ''MNT'', ''MOP'', ''MRO'', + ''MUR'', + + ''MVR'', ''MWK'', ''MXN'', ''MXV'', ''MYR'', ''MZN'', ''NAD'', ''NGN'', ''NIO'', + ''NOK'', + + ''NPR'', ''NZD'', ''OMR'', ''PAB'', ''PEN'', ''PGK'', ''PHP'', ''PKR'', ''PLN'', + ''PYG'', + + ''QAR'', ''RON'', ''RSD'', ''RUB'', ''RWF'', ''SAR'', ''SBD'', ''SCR'', ''SDG'', + ''SEK'', + + ''SGD'', ''SHP'', ''SLL'', ''SOS'', ''SRD'', ''SSP'', ''STD'', ''SYP'', ''SZL'', + ''THB'', + + ''TJS'', ''TMT'', ''TND'', ''TOP'', ''TRY'', ''TTD'', ''TWD'', ''TZS'', ''UAH'', + ''UGX'', + + ''UYU'', ''UZS'', ''VEF'', ''VND'', ''VUV'', ''WST'', ''XAF'', ''XCD'', ''XOF'', + ''XPF'', + + ''YER'', ''ZAR'', ''ZMW''. Default value: "USD" .' + name: price_currency + types: + - + - +- description: 'The item''s availability. The following are the + + possible values: Discontinued, InStock, InStoreOnly, LimitedAvailability, + + OnlineOnly, OutOfStock, PreOrder, SoldOut. Possible values include: + + ''Discontinued'', ''InStock'', ''InStoreOnly'', ''LimitedAvailability'', + + ''OnlineOnly'', ''OutOfStock'', ''PreOrder'', ''SoldOut''' + name: availability + types: + - + - +- description: 'An aggregated rating that indicates how well the + + product has been rated by others.' + name: aggregate_rating + types: + - +- description: 'The last date that the offer was updated. The date is + + in the form YYYY-MM-DD.' + name: last_updated + types: + - +- description: 'A list of offers from merchants that have offerings related + + to the image.' + name: offers + types: + - [] +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.AggregateOffer.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.AggregateOffer.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.AggregateOffer.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.AggregateOffer.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.AggregateOffer.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.AggregateOffer.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.AggregateOffer.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.AggregateRating.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.AggregateRating.yml new file mode 100644 index 00000000..58573db2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.AggregateRating.yml @@ -0,0 +1,155 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.AggregateRating +name: AggregateRating +fullName: azure.cognitiveservices.search.visualsearch.models.AggregateRating +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines the metrics that indicate how well an item was rated by others. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AggregateRating(*, rating_value: float, **kwargs)' + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: rating_value + description: 'Required. The mean (average) rating. The possible + + values are 1.0 through 5.0.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: rating_value + isRequired: true +variables: +- description: Text representation of an item. + name: text + types: + - +- description: 'The highest rated review. The possible values are 1.0 + + through 5.0.' + name: best_rating + types: + - +- description: 'The number of times the recipe has been rated or + + reviewed.' + name: review_count + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.AggregateRating.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.AggregateRating.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.AggregateRating.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.AggregateRating.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.AggregateRating.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.AggregateRating.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.AggregateRating.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.CreativeWork.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.CreativeWork.yml new file mode 100644 index 00000000..443f053d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.CreativeWork.yml @@ -0,0 +1,194 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.CreativeWork +name: CreativeWork +fullName: azure.cognitiveservices.search.visualsearch.models.CreativeWork +module: azure.cognitiveservices.search.visualsearch.models +summary: 'The most generic kind of creative work, including books, movies, + + photographs, software programs, etc. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Action, MediaObject, Recipe + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CreativeWork(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.CreativeWork.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.CreativeWork.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.CreativeWork.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.CreativeWork.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.CreativeWork.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.CreativeWork.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.CreativeWork.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.CropArea.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.CropArea.yml new file mode 100644 index 00000000..5a914ac3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.CropArea.yml @@ -0,0 +1,173 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.CropArea +name: CropArea +fullName: azure.cognitiveservices.search.visualsearch.models.CropArea +module: azure.cognitiveservices.search.visualsearch.models +summary: 'A JSON object consisting of coordinates specifying the four corners of a + + cropped rectangle within the input image. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CropArea(*, top: float, bottom: float, left: float, right: float, **kwargs)' + parameters: + - name: top + description: 'Required. The top coordinate of the region to be cropped. The + + coordinate is a fractional value of the original image''s height and is + + measured from the top edge of the image. Specify the coordinate as a value + + from 0.0 through 1.0.' + isRequired: true + types: + - + - name: bottom + description: 'Required. The bottom coordinate of the region to be + + cropped. The coordinate is a fractional value of the original image''s + + height and is measured from the top edge of the image. Specify the + + coordinate as a value from 0.0 through 1.0.' + isRequired: true + types: + - + - name: left + description: 'Required. The left coordinate of the region to be cropped. + + The coordinate is a fractional value of the original image''s width and is + + measured from the left edge of the image. Specify the coordinate as a + + value from 0.0 through 1.0.' + isRequired: true + types: + - + - name: right + description: 'Required. The right coordinate of the region to be cropped. + + The coordinate is a fractional value of the original image''s width and is + + measured from the left edge of the image. Specify the coordinate as a + + value from 0.0 through 1.0.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: top + isRequired: true + - name: bottom + isRequired: true + - name: left + isRequired: true + - name: right + isRequired: true +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.CropArea.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.CropArea.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.CropArea.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.CropArea.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.CropArea.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.CropArea.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.CropArea.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Currency.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Currency.yml new file mode 100644 index 00000000..f9888f72 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Currency.yml @@ -0,0 +1,328 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.search.visualsearch.models.Currency +name: Currency +fullName: azure.cognitiveservices.search.visualsearch.models.Currency +module: azure.cognitiveservices.search.visualsearch.models +fields: +- name: aed + uid: azure.cognitiveservices.search.visualsearch.models.Currency.aed +- name: afn + uid: azure.cognitiveservices.search.visualsearch.models.Currency.afn +- name: all + uid: azure.cognitiveservices.search.visualsearch.models.Currency.all +- name: amd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.amd +- name: ang + uid: azure.cognitiveservices.search.visualsearch.models.Currency.ang +- name: aoa + uid: azure.cognitiveservices.search.visualsearch.models.Currency.aoa +- name: ars + uid: azure.cognitiveservices.search.visualsearch.models.Currency.ars +- name: aud + uid: azure.cognitiveservices.search.visualsearch.models.Currency.aud +- name: awg + uid: azure.cognitiveservices.search.visualsearch.models.Currency.awg +- name: azn + uid: azure.cognitiveservices.search.visualsearch.models.Currency.azn +- name: bam + uid: azure.cognitiveservices.search.visualsearch.models.Currency.bam +- name: bbd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.bbd +- name: bdt + uid: azure.cognitiveservices.search.visualsearch.models.Currency.bdt +- name: bgn + uid: azure.cognitiveservices.search.visualsearch.models.Currency.bgn +- name: bhd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.bhd +- name: bif + uid: azure.cognitiveservices.search.visualsearch.models.Currency.bif +- name: bmd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.bmd +- name: bnd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.bnd +- name: bob + uid: azure.cognitiveservices.search.visualsearch.models.Currency.bob +- name: bov + uid: azure.cognitiveservices.search.visualsearch.models.Currency.bov +- name: brl + uid: azure.cognitiveservices.search.visualsearch.models.Currency.brl +- name: bsd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.bsd +- name: btn + uid: azure.cognitiveservices.search.visualsearch.models.Currency.btn +- name: bwp + uid: azure.cognitiveservices.search.visualsearch.models.Currency.bwp +- name: byr + uid: azure.cognitiveservices.search.visualsearch.models.Currency.byr +- name: bzd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.bzd +- name: cad + uid: azure.cognitiveservices.search.visualsearch.models.Currency.cad +- name: cdf + uid: azure.cognitiveservices.search.visualsearch.models.Currency.cdf +- name: che + uid: azure.cognitiveservices.search.visualsearch.models.Currency.che +- name: chf + uid: azure.cognitiveservices.search.visualsearch.models.Currency.chf +- name: chw + uid: azure.cognitiveservices.search.visualsearch.models.Currency.chw +- name: clf + uid: azure.cognitiveservices.search.visualsearch.models.Currency.clf +- name: clp + uid: azure.cognitiveservices.search.visualsearch.models.Currency.clp +- name: cny + uid: azure.cognitiveservices.search.visualsearch.models.Currency.cny +- name: cop + uid: azure.cognitiveservices.search.visualsearch.models.Currency.cop +- name: cou + uid: azure.cognitiveservices.search.visualsearch.models.Currency.cou +- name: crc + uid: azure.cognitiveservices.search.visualsearch.models.Currency.crc +- name: cuc + uid: azure.cognitiveservices.search.visualsearch.models.Currency.cuc +- name: cup + uid: azure.cognitiveservices.search.visualsearch.models.Currency.cup +- name: cve + uid: azure.cognitiveservices.search.visualsearch.models.Currency.cve +- name: czk + uid: azure.cognitiveservices.search.visualsearch.models.Currency.czk +- name: djf + uid: azure.cognitiveservices.search.visualsearch.models.Currency.djf +- name: dkk + uid: azure.cognitiveservices.search.visualsearch.models.Currency.dkk +- name: dop + uid: azure.cognitiveservices.search.visualsearch.models.Currency.dop +- name: dzd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.dzd +- name: egp + uid: azure.cognitiveservices.search.visualsearch.models.Currency.egp +- name: ern + uid: azure.cognitiveservices.search.visualsearch.models.Currency.ern +- name: etb + uid: azure.cognitiveservices.search.visualsearch.models.Currency.etb +- name: eur + uid: azure.cognitiveservices.search.visualsearch.models.Currency.eur +- name: fjd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.fjd +- name: fkp + uid: azure.cognitiveservices.search.visualsearch.models.Currency.fkp +- name: gbp + uid: azure.cognitiveservices.search.visualsearch.models.Currency.gbp +- name: gel + uid: azure.cognitiveservices.search.visualsearch.models.Currency.gel +- name: ghs + uid: azure.cognitiveservices.search.visualsearch.models.Currency.ghs +- name: gip + uid: azure.cognitiveservices.search.visualsearch.models.Currency.gip +- name: gmd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.gmd +- name: gnf + uid: azure.cognitiveservices.search.visualsearch.models.Currency.gnf +- name: gtq + uid: azure.cognitiveservices.search.visualsearch.models.Currency.gtq +- name: gyd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.gyd +- name: hkd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.hkd +- name: hnl + uid: azure.cognitiveservices.search.visualsearch.models.Currency.hnl +- name: hrk + uid: azure.cognitiveservices.search.visualsearch.models.Currency.hrk +- name: htg + uid: azure.cognitiveservices.search.visualsearch.models.Currency.htg +- name: huf + uid: azure.cognitiveservices.search.visualsearch.models.Currency.huf +- name: idr + uid: azure.cognitiveservices.search.visualsearch.models.Currency.idr +- name: ils + uid: azure.cognitiveservices.search.visualsearch.models.Currency.ils +- name: inr + uid: azure.cognitiveservices.search.visualsearch.models.Currency.inr +- name: iqd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.iqd +- name: irr + uid: azure.cognitiveservices.search.visualsearch.models.Currency.irr +- name: isk + uid: azure.cognitiveservices.search.visualsearch.models.Currency.isk +- name: jmd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.jmd +- name: jod + uid: azure.cognitiveservices.search.visualsearch.models.Currency.jod +- name: jpy + uid: azure.cognitiveservices.search.visualsearch.models.Currency.jpy +- name: kes + uid: azure.cognitiveservices.search.visualsearch.models.Currency.kes +- name: kgs + uid: azure.cognitiveservices.search.visualsearch.models.Currency.kgs +- name: khr + uid: azure.cognitiveservices.search.visualsearch.models.Currency.khr +- name: kmf + uid: azure.cognitiveservices.search.visualsearch.models.Currency.kmf +- name: kpw + uid: azure.cognitiveservices.search.visualsearch.models.Currency.kpw +- name: krw + uid: azure.cognitiveservices.search.visualsearch.models.Currency.krw +- name: kwd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.kwd +- name: kyd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.kyd +- name: kzt + uid: azure.cognitiveservices.search.visualsearch.models.Currency.kzt +- name: lak + uid: azure.cognitiveservices.search.visualsearch.models.Currency.lak +- name: lbp + uid: azure.cognitiveservices.search.visualsearch.models.Currency.lbp +- name: lkr + uid: azure.cognitiveservices.search.visualsearch.models.Currency.lkr +- name: lrd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.lrd +- name: lsl + uid: azure.cognitiveservices.search.visualsearch.models.Currency.lsl +- name: lyd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.lyd +- name: mad + uid: azure.cognitiveservices.search.visualsearch.models.Currency.mad +- name: mdl + uid: azure.cognitiveservices.search.visualsearch.models.Currency.mdl +- name: mga + uid: azure.cognitiveservices.search.visualsearch.models.Currency.mga +- name: mkd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.mkd +- name: mmk + uid: azure.cognitiveservices.search.visualsearch.models.Currency.mmk +- name: mnt + uid: azure.cognitiveservices.search.visualsearch.models.Currency.mnt +- name: mop + uid: azure.cognitiveservices.search.visualsearch.models.Currency.mop +- name: mro_enum + uid: azure.cognitiveservices.search.visualsearch.models.Currency.mro_enum +- name: mur + uid: azure.cognitiveservices.search.visualsearch.models.Currency.mur +- name: mvr + uid: azure.cognitiveservices.search.visualsearch.models.Currency.mvr +- name: mwk + uid: azure.cognitiveservices.search.visualsearch.models.Currency.mwk +- name: mxn + uid: azure.cognitiveservices.search.visualsearch.models.Currency.mxn +- name: mxv + uid: azure.cognitiveservices.search.visualsearch.models.Currency.mxv +- name: myr + uid: azure.cognitiveservices.search.visualsearch.models.Currency.myr +- name: mzn + uid: azure.cognitiveservices.search.visualsearch.models.Currency.mzn +- name: nad + uid: azure.cognitiveservices.search.visualsearch.models.Currency.nad +- name: ngn + uid: azure.cognitiveservices.search.visualsearch.models.Currency.ngn +- name: nio + uid: azure.cognitiveservices.search.visualsearch.models.Currency.nio +- name: nok + uid: azure.cognitiveservices.search.visualsearch.models.Currency.nok +- name: npr + uid: azure.cognitiveservices.search.visualsearch.models.Currency.npr +- name: nzd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.nzd +- name: omr + uid: azure.cognitiveservices.search.visualsearch.models.Currency.omr +- name: pab + uid: azure.cognitiveservices.search.visualsearch.models.Currency.pab +- name: pen + uid: azure.cognitiveservices.search.visualsearch.models.Currency.pen +- name: pgk + uid: azure.cognitiveservices.search.visualsearch.models.Currency.pgk +- name: php + uid: azure.cognitiveservices.search.visualsearch.models.Currency.php +- name: pkr + uid: azure.cognitiveservices.search.visualsearch.models.Currency.pkr +- name: pln + uid: azure.cognitiveservices.search.visualsearch.models.Currency.pln +- name: pyg + uid: azure.cognitiveservices.search.visualsearch.models.Currency.pyg +- name: qar + uid: azure.cognitiveservices.search.visualsearch.models.Currency.qar +- name: ron + uid: azure.cognitiveservices.search.visualsearch.models.Currency.ron +- name: rsd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.rsd +- name: rub + uid: azure.cognitiveservices.search.visualsearch.models.Currency.rub +- name: rwf + uid: azure.cognitiveservices.search.visualsearch.models.Currency.rwf +- name: sar + uid: azure.cognitiveservices.search.visualsearch.models.Currency.sar +- name: sbd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.sbd +- name: scr + uid: azure.cognitiveservices.search.visualsearch.models.Currency.scr +- name: sdg + uid: azure.cognitiveservices.search.visualsearch.models.Currency.sdg +- name: sek + uid: azure.cognitiveservices.search.visualsearch.models.Currency.sek +- name: sgd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.sgd +- name: shp + uid: azure.cognitiveservices.search.visualsearch.models.Currency.shp +- name: sll + uid: azure.cognitiveservices.search.visualsearch.models.Currency.sll +- name: sos + uid: azure.cognitiveservices.search.visualsearch.models.Currency.sos +- name: srd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.srd +- name: ssp + uid: azure.cognitiveservices.search.visualsearch.models.Currency.ssp +- name: std + uid: azure.cognitiveservices.search.visualsearch.models.Currency.std +- name: syp + uid: azure.cognitiveservices.search.visualsearch.models.Currency.syp +- name: szl + uid: azure.cognitiveservices.search.visualsearch.models.Currency.szl +- name: thb + uid: azure.cognitiveservices.search.visualsearch.models.Currency.thb +- name: tjs + uid: azure.cognitiveservices.search.visualsearch.models.Currency.tjs +- name: tmt + uid: azure.cognitiveservices.search.visualsearch.models.Currency.tmt +- name: tnd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.tnd +- name: top + uid: azure.cognitiveservices.search.visualsearch.models.Currency.top +- name: try_enum + uid: azure.cognitiveservices.search.visualsearch.models.Currency.try_enum +- name: ttd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.ttd +- name: twd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.twd +- name: tzs + uid: azure.cognitiveservices.search.visualsearch.models.Currency.tzs +- name: uah + uid: azure.cognitiveservices.search.visualsearch.models.Currency.uah +- name: ugx + uid: azure.cognitiveservices.search.visualsearch.models.Currency.ugx +- name: usd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.usd +- name: uyu + uid: azure.cognitiveservices.search.visualsearch.models.Currency.uyu +- name: uzs + uid: azure.cognitiveservices.search.visualsearch.models.Currency.uzs +- name: vef + uid: azure.cognitiveservices.search.visualsearch.models.Currency.vef +- name: vnd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.vnd +- name: vuv + uid: azure.cognitiveservices.search.visualsearch.models.Currency.vuv +- name: wst + uid: azure.cognitiveservices.search.visualsearch.models.Currency.wst +- name: xaf + uid: azure.cognitiveservices.search.visualsearch.models.Currency.xaf +- name: xcd + uid: azure.cognitiveservices.search.visualsearch.models.Currency.xcd +- name: xof + uid: azure.cognitiveservices.search.visualsearch.models.Currency.xof +- name: xpf + uid: azure.cognitiveservices.search.visualsearch.models.Currency.xpf +- name: yer + uid: azure.cognitiveservices.search.visualsearch.models.Currency.yer +- name: zar + uid: azure.cognitiveservices.search.visualsearch.models.Currency.zar +- name: zmw + uid: azure.cognitiveservices.search.visualsearch.models.Currency.zmw diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Error(class).yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Error(class).yml new file mode 100644 index 00000000..4807b3a7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Error(class).yml @@ -0,0 +1,173 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.Error +name: Error +fullName: azure.cognitiveservices.search.visualsearch.models.Error +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines the error that occurred. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Error(*, message: str, code=''None'', **kwargs)' + parameters: + - name: code + description: 'Required. The error code that identifies the category of + + error. Possible values include: ''None'', ''ServerError'', ''InvalidRequest'', + + ''RateLimitExceeded'', ''InvalidAuthorization'', ''InsufficientAuthorization''. + + Default value: "None" .' + isRequired: true + types: + - + - + - name: message + description: Required. A description of the error. + isRequired: true + types: + - + keywordOnlyParameters: + - name: message + isRequired: true + - name: code + defaultValue: None +variables: +- description: 'The error code that further helps to identify the error. + + Possible values include: ''UnexpectedError'', ''ResourceError'', + + ''NotImplemented'', ''ParameterMissing'', ''ParameterInvalidValue'', + + ''HttpNotAllowed'', ''Blocked'', ''AuthorizationMissing'', + + ''AuthorizationRedundancy'', ''AuthorizationDisabled'', ''AuthorizationExpired''' + name: sub_code + types: + - + - +- description: 'A description that provides additional information + + about the error.' + name: more_details + types: + - +- description: The parameter in the request that caused the error. + name: parameter + types: + - +- description: The parameter's value in the request that was not valid. + name: value + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.Error.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Error.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Error.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.Error.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Error.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.Error.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Error.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ErrorCode.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ErrorCode.yml new file mode 100644 index 00000000..851d93bf --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ErrorCode.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.search.visualsearch.models.ErrorCode +name: ErrorCode +fullName: azure.cognitiveservices.search.visualsearch.models.ErrorCode +module: azure.cognitiveservices.search.visualsearch.models +fields: +- name: insufficient_authorization + uid: azure.cognitiveservices.search.visualsearch.models.ErrorCode.insufficient_authorization +- name: invalid_authorization + uid: azure.cognitiveservices.search.visualsearch.models.ErrorCode.invalid_authorization +- name: invalid_request + uid: azure.cognitiveservices.search.visualsearch.models.ErrorCode.invalid_request +- name: none + uid: azure.cognitiveservices.search.visualsearch.models.ErrorCode.none +- name: rate_limit_exceeded + uid: azure.cognitiveservices.search.visualsearch.models.ErrorCode.rate_limit_exceeded +- name: server_error + uid: azure.cognitiveservices.search.visualsearch.models.ErrorCode.server_error diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ErrorResponse.yml new file mode 100644 index 00000000..9cd102c6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ErrorResponse.yml @@ -0,0 +1,155 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.ErrorResponse +name: ErrorResponse +fullName: azure.cognitiveservices.search.visualsearch.models.ErrorResponse +module: azure.cognitiveservices.search.visualsearch.models +summary: 'The top-level response that represents a failed request. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ErrorResponse(*, errors, **kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: errors + description: 'Required. A list of errors that describe the reasons why + + the request failed.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: errors + isRequired: true +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.ErrorResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ErrorResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ErrorResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.ErrorResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ErrorResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.ErrorResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ErrorResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ErrorResponseException.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ErrorResponseException.yml new file mode 100644 index 00000000..4ab6f61c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ErrorResponseException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.ErrorResponseException +name: ErrorResponseException +fullName: azure.cognitiveservices.search.visualsearch.models.ErrorResponseException +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Server responsed with exception of type: ''ErrorResponse''.' +constructor: + syntax: ErrorResponseException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.ErrorResponseException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cognitiveservices.search.visualsearch.models.ErrorResponseException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cognitiveservices.search.visualsearch.models.ErrorResponseException.args + name: args diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ErrorSubCode.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ErrorSubCode.yml new file mode 100644 index 00000000..e5d49f58 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ErrorSubCode.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.search.visualsearch.models.ErrorSubCode +name: ErrorSubCode +fullName: azure.cognitiveservices.search.visualsearch.models.ErrorSubCode +module: azure.cognitiveservices.search.visualsearch.models +fields: +- name: authorization_disabled + uid: azure.cognitiveservices.search.visualsearch.models.ErrorSubCode.authorization_disabled +- name: authorization_expired + uid: azure.cognitiveservices.search.visualsearch.models.ErrorSubCode.authorization_expired +- name: authorization_missing + uid: azure.cognitiveservices.search.visualsearch.models.ErrorSubCode.authorization_missing +- name: authorization_redundancy + uid: azure.cognitiveservices.search.visualsearch.models.ErrorSubCode.authorization_redundancy +- name: blocked + uid: azure.cognitiveservices.search.visualsearch.models.ErrorSubCode.blocked +- name: http_not_allowed + uid: azure.cognitiveservices.search.visualsearch.models.ErrorSubCode.http_not_allowed +- name: not_implemented + uid: azure.cognitiveservices.search.visualsearch.models.ErrorSubCode.not_implemented +- name: parameter_invalid_value + uid: azure.cognitiveservices.search.visualsearch.models.ErrorSubCode.parameter_invalid_value +- name: parameter_missing + uid: azure.cognitiveservices.search.visualsearch.models.ErrorSubCode.parameter_missing +- name: resource_error + uid: azure.cognitiveservices.search.visualsearch.models.ErrorSubCode.resource_error +- name: unexpected_error + uid: azure.cognitiveservices.search.visualsearch.models.ErrorSubCode.unexpected_error diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Filters(class).yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Filters(class).yml new file mode 100644 index 00000000..601ef41f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Filters(class).yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.Filters +name: Filters +fullName: azure.cognitiveservices.search.visualsearch.models.Filters +module: azure.cognitiveservices.search.visualsearch.models +summary: 'A key-value object consisting of filters that may be specified to limit + the + + results returned by the API. Current available filters: site.' +constructor: + syntax: 'Filters(*, site: str = None, **kwargs)' + parameters: + - name: site + description: 'The URL of the site to return similar images and similar + + products from. (e.g., "www.bing.com", "bing.com").' + isRequired: true + types: + - + keywordOnlyParameters: + - name: site + isRequired: true +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.Filters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Filters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Filters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.Filters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Filters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.Filters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Filters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Identifiable(class).yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Identifiable(class).yml new file mode 100644 index 00000000..bf741834 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Identifiable(class).yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.Identifiable +name: Identifiable +fullName: azure.cognitiveservices.search.visualsearch.models.Identifiable +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines the identity of a resource. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Response + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Identifiable(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.Identifiable.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Identifiable.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Identifiable.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.Identifiable.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Identifiable.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.Identifiable.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Identifiable.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageAction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageAction.yml new file mode 100644 index 00000000..a65ff45f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageAction.yml @@ -0,0 +1,220 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.ImageAction +name: ImageAction +fullName: azure.cognitiveservices.search.visualsearch.models.ImageAction +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines an image action. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: ImageEntityAction, ImageModuleAction, ImageRecipesAction, + + ImageRelatedSearchesAction, ImageShoppingSourcesAction + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageAction(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: The result produced in the action. + name: result + types: + - [] +- description: A display name for the action. + name: display_name + types: + - +- description: 'A Boolean representing whether this result is the top + + action.' + name: is_top_action + types: + - +- description: 'Use this URL to get additional data to determine how to + + take the appropriate action. For example, the serviceUrl might return JSON + + along with an image URL.' + name: service_url + types: + - +- description: A string representing the type of action. + name: action_type + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.ImageAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImageAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImageAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.ImageAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImageAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.ImageAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImageAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageEntityAction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageEntityAction.yml new file mode 100644 index 00000000..d8a4c5a6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageEntityAction.yml @@ -0,0 +1,213 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.ImageEntityAction +name: ImageEntityAction +fullName: azure.cognitiveservices.search.visualsearch.models.ImageEntityAction +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines an entity action. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageEntityAction(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: The result produced in the action. + name: result + types: + - [] +- description: A display name for the action. + name: display_name + types: + - +- description: 'A Boolean representing whether this result is the top + + action.' + name: is_top_action + types: + - +- description: 'Use this URL to get additional data to determine how to + + take the appropriate action. For example, the serviceUrl might return JSON + + along with an image URL.' + name: service_url + types: + - +- description: A string representing the type of action. + name: action_type + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.ImageEntityAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImageEntityAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImageEntityAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.ImageEntityAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImageEntityAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.ImageEntityAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImageEntityAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageInfo.yml new file mode 100644 index 00000000..6fc288e4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageInfo.yml @@ -0,0 +1,170 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.ImageInfo +name: ImageInfo +fullName: azure.cognitiveservices.search.visualsearch.models.ImageInfo +module: azure.cognitiveservices.search.visualsearch.models +summary: 'A JSON object that identities the image to get insights of . It also + + includes the optional crop area that you use to identify the region of + + interest in the image.' +constructor: + syntax: 'ImageInfo(*, image_insights_token: str = None, url: str = None, crop_area=None, + **kwargs)' + parameters: + - name: image_insights_token + description: 'An image insights token. To get the insights + + token, call one of the Image Search APIs (for example, /images/search). In + + the search results, the + + [Image](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#image) + + object''s + + [imageInsightsToken](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#image-imageinsightstoken) + + field contains the token. The imageInsightsToken and url fields mutually + + exclusive; do not specify both. Do not specify an insights token if the + + request includes the image form data.' + isRequired: true + types: + - + - name: url + description: 'The URL of the input image. The imageInsightsToken and url + + fields are mutually exclusive; do not specify both. Do not specify the URL + + if the request includes the image form data.' + isRequired: true + types: + - + - name: crop_area + description: 'A JSON object consisting of coordinates specifying the + + four corners of a cropped rectangle within the input image. Use the crop + + area to identify the region of interest in the image. You can apply the + + crop area to the images specified using the imageInsightsToken or url + + fields, or an image binary specified in an image form data.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: image_insights_token + isRequired: true + - name: url + isRequired: true + - name: crop_area + isRequired: true +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.ImageInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImageInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImageInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.ImageInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImageInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.ImageInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImageInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageKnowledge.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageKnowledge.yml new file mode 100644 index 00000000..d6b3b618 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageKnowledge.yml @@ -0,0 +1,153 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.ImageKnowledge +name: ImageKnowledge +fullName: azure.cognitiveservices.search.visualsearch.models.ImageKnowledge +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines a visual search API response. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageKnowledge(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: A list of visual search tags. + name: tags + types: + - [] +- description: Image object containing metadata about the requested image. + name: image + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.ImageKnowledge.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImageKnowledge.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImageKnowledge.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.ImageKnowledge.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImageKnowledge.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.ImageKnowledge.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImageKnowledge.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageModuleAction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageModuleAction.yml new file mode 100644 index 00000000..76db6eef --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageModuleAction.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.ImageModuleAction +name: ImageModuleAction +fullName: azure.cognitiveservices.search.visualsearch.models.ImageModuleAction +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines an image list action. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageModuleAction(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: The result produced in the action. + name: result + types: + - [] +- description: A display name for the action. + name: display_name + types: + - +- description: 'A Boolean representing whether this result is the top + + action.' + name: is_top_action + types: + - +- description: 'Use this URL to get additional data to determine how to + + take the appropriate action. For example, the serviceUrl might return JSON + + along with an image URL.' + name: service_url + types: + - +- description: A string representing the type of action. + name: action_type + types: + - +- description: A list of images. + name: data + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.ImageModuleAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImageModuleAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImageModuleAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.ImageModuleAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImageModuleAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.ImageModuleAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImageModuleAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageObject.yml new file mode 100644 index 00000000..8a4a5a0f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageObject.yml @@ -0,0 +1,267 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.ImageObject +name: ImageObject +fullName: azure.cognitiveservices.search.visualsearch.models.ImageObject +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines an image. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageObject(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: 'Original URL to retrieve the source (file) for the + + media object (e.g., the source URL for the image).' + name: content_url + types: + - +- description: URL of the page that hosts the media object. + name: host_page_url + types: + - +- description: 'Size of the media object content. Use format "value + + unit" (e.g., "1024 B").' + name: content_size + types: + - +- description: Encoding format (e.g., png, gif, jpeg, etc). + name: encoding_format + types: + - +- description: 'Display URL of the page that hosts the media + + object.' + name: host_page_display_url + types: + - +- description: The width of the media object, in pixels. + name: width + types: + - +- description: The height of the media object, in pixels. + name: height + types: + - +- description: The URL to a thumbnail of the image. + name: thumbnail + types: + - +- description: 'The token that you use in a subsequent call to + + Visual Search API to get additional information about the image. For + + information about using this token, see the imageInsightsToken field + + inside the knowledgeRequest request parameter.' + name: image_insights_token + types: + - +- description: 'A count of the number of websites where you can + + shop or perform other actions related to the image. For example, if the + + image is of an apple pie, this object includes a count of the number of + + websites where you can buy an apple pie. To indicate the number of offers + + in your UX, include badging such as a shopping cart icon that contains the + + count. When the user clicks on the icon, use imageInsightsToken in a + + subsequent Visual Search API call to get the list of shopping websites.' + name: insights_metadata + types: + - +- description: Unique Id for the image. + name: image_id + types: + - +- description: 'A three-byte hexadecimal number that represents the + + color that dominates the image. Use the color as the temporary background + + in your client until the image is loaded.' + name: accent_color + types: + - +- description: For internal use only. + name: visual_words + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.ImageObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImageObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImageObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.ImageObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImageObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.ImageObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImageObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageRecipesAction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageRecipesAction.yml new file mode 100644 index 00000000..e7ddc8af --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageRecipesAction.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.ImageRecipesAction +name: ImageRecipesAction +fullName: azure.cognitiveservices.search.visualsearch.models.ImageRecipesAction +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines an recipe action. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageRecipesAction(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: The result produced in the action. + name: result + types: + - [] +- description: A display name for the action. + name: display_name + types: + - +- description: 'A Boolean representing whether this result is the top + + action.' + name: is_top_action + types: + - +- description: 'Use this URL to get additional data to determine how to + + take the appropriate action. For example, the serviceUrl might return JSON + + along with an image URL.' + name: service_url + types: + - +- description: A string representing the type of action. + name: action_type + types: + - +- description: A list of recipes related to the image. + name: data + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.ImageRecipesAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImageRecipesAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImageRecipesAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.ImageRecipesAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImageRecipesAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.ImageRecipesAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImageRecipesAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageRelatedSearchesAction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageRelatedSearchesAction.yml new file mode 100644 index 00000000..efa90f6c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageRelatedSearchesAction.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.ImageRelatedSearchesAction +name: ImageRelatedSearchesAction +fullName: azure.cognitiveservices.search.visualsearch.models.ImageRelatedSearchesAction +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines an related search action. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageRelatedSearchesAction(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: The result produced in the action. + name: result + types: + - [] +- description: A display name for the action. + name: display_name + types: + - +- description: 'A Boolean representing whether this result is the top + + action.' + name: is_top_action + types: + - +- description: 'Use this URL to get additional data to determine how to + + take the appropriate action. For example, the serviceUrl might return JSON + + along with an image URL.' + name: service_url + types: + - +- description: A string representing the type of action. + name: action_type + types: + - +- description: A list of queries related to the image. + name: data + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.ImageRelatedSearchesAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImageRelatedSearchesAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImageRelatedSearchesAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.ImageRelatedSearchesAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImageRelatedSearchesAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.ImageRelatedSearchesAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImageRelatedSearchesAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageShoppingSourcesAction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageShoppingSourcesAction.yml new file mode 100644 index 00000000..19b7846d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageShoppingSourcesAction.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.ImageShoppingSourcesAction +name: ImageShoppingSourcesAction +fullName: azure.cognitiveservices.search.visualsearch.models.ImageShoppingSourcesAction +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines a shopping sources action. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageShoppingSourcesAction(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: The result produced in the action. + name: result + types: + - [] +- description: A display name for the action. + name: display_name + types: + - +- description: 'A Boolean representing whether this result is the top + + action.' + name: is_top_action + types: + - +- description: 'Use this URL to get additional data to determine how to + + take the appropriate action. For example, the serviceUrl might return JSON + + along with an image URL.' + name: service_url + types: + - +- description: A string representing the type of action. + name: action_type + types: + - +- description: A list of merchants that offer items related to the image. + name: data + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.ImageShoppingSourcesAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImageShoppingSourcesAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImageShoppingSourcesAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.ImageShoppingSourcesAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImageShoppingSourcesAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.ImageShoppingSourcesAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImageShoppingSourcesAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageTag.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageTag.yml new file mode 100644 index 00000000..2616ce79 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageTag.yml @@ -0,0 +1,191 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.ImageTag +name: ImageTag +fullName: azure.cognitiveservices.search.visualsearch.models.ImageTag +module: azure.cognitiveservices.search.visualsearch.models +summary: 'A visual search tag. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageTag(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: 'Display name for this tag. For the default tag, the + + display name is empty.' + name: display_name + types: + - +- description: 'The bounding box for this tag. For the default tag, + + there is no bounding box.' + name: bounding_box + types: + - +- description: 'Actions within this tag. The order of the items denotes the + + default ranking order of these actions, with the first action being the + + most likely user intent.' + name: actions + types: + - [] +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.ImageTag.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImageTag.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImageTag.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.ImageTag.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImageTag.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.ImageTag.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImageTag.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageTagRegion.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageTagRegion.yml new file mode 100644 index 00000000..fa81fca1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageTagRegion.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.ImageTagRegion +name: ImageTagRegion +fullName: azure.cognitiveservices.search.visualsearch.models.ImageTagRegion +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines an image region relevant to the ImageTag. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageTagRegion(*, query_rectangle, display_rectangle, **kwargs) + parameters: + - name: query_rectangle + description: 'Required. A rectangle that outlines the area of + + interest for this tag.' + isRequired: true + types: + - + - name: display_rectangle + description: 'Required. A recommended rectangle to show to the + + user.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: query_rectangle + isRequired: true + - name: display_rectangle + isRequired: true +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.ImageTagRegion.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImageTagRegion.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImageTagRegion.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.ImageTagRegion.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImageTagRegion.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.ImageTagRegion.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImageTagRegion.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImagesImageMetadata.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImagesImageMetadata.yml new file mode 100644 index 00000000..6744770b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImagesImageMetadata.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.ImagesImageMetadata +name: ImagesImageMetadata +fullName: azure.cognitiveservices.search.visualsearch.models.ImagesImageMetadata +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines a count of the number of websites where you can shop or perform + + other actions related to the image. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: ImagesImageMetadata(**kwargs) +variables: +- description: 'The number of websites that sell the + + products seen in the image.' + name: shopping_sources_count + types: + - +- description: 'The number of websites that offer recipes of + + the food seen in the image.' + name: recipe_sources_count + types: + - +- description: 'A summary of the online offers of products found in + + the image. For example, if the image is of a dress, the offer might + + identify the lowest price and the number of offers found. Only visually + + similar products insights include this field. The offer includes the + + following fields: Name, AggregateRating, OfferCount, and LowPrice.' + name: aggregate_offer + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.ImagesImageMetadata.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImagesImageMetadata.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImagesImageMetadata.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.ImagesImageMetadata.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImagesImageMetadata.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.ImagesImageMetadata.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImagesImageMetadata.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImagesModule.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImagesModule.yml new file mode 100644 index 00000000..f36f52ae --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImagesModule.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.ImagesModule +name: ImagesModule +fullName: azure.cognitiveservices.search.visualsearch.models.ImagesModule +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines a list of images. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: ImagesModule(**kwargs) +variables: +- description: A list of images. + name: value + types: + - [] +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.ImagesModule.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImagesModule.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImagesModule.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.ImagesModule.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ImagesModule.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.ImagesModule.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ImagesModule.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Intangible(class).yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Intangible(class).yml new file mode 100644 index 00000000..d485948c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Intangible(class).yml @@ -0,0 +1,178 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.Intangible +name: Intangible +fullName: azure.cognitiveservices.search.visualsearch.models.Intangible +module: azure.cognitiveservices.search.visualsearch.models +summary: 'A utility class that serves as the umbrella for a number of ''intangible'' + + things such as quantities, structured values, etc. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: StructuredValue + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Intangible(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.Intangible.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Intangible.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Intangible.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.Intangible.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Intangible.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.Intangible.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Intangible.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ItemAvailability.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ItemAvailability.yml new file mode 100644 index 00000000..26c34ecc --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ItemAvailability.yml @@ -0,0 +1,22 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.search.visualsearch.models.ItemAvailability +name: ItemAvailability +fullName: azure.cognitiveservices.search.visualsearch.models.ItemAvailability +module: azure.cognitiveservices.search.visualsearch.models +fields: +- name: discontinued + uid: azure.cognitiveservices.search.visualsearch.models.ItemAvailability.discontinued +- name: in_stock + uid: azure.cognitiveservices.search.visualsearch.models.ItemAvailability.in_stock +- name: in_store_only + uid: azure.cognitiveservices.search.visualsearch.models.ItemAvailability.in_store_only +- name: limited_availability + uid: azure.cognitiveservices.search.visualsearch.models.ItemAvailability.limited_availability +- name: online_only + uid: azure.cognitiveservices.search.visualsearch.models.ItemAvailability.online_only +- name: out_of_stock + uid: azure.cognitiveservices.search.visualsearch.models.ItemAvailability.out_of_stock +- name: pre_order + uid: azure.cognitiveservices.search.visualsearch.models.ItemAvailability.pre_order +- name: sold_out + uid: azure.cognitiveservices.search.visualsearch.models.ItemAvailability.sold_out diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.KnowledgeRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.KnowledgeRequest.yml new file mode 100644 index 00000000..7751db74 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.KnowledgeRequest.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.KnowledgeRequest +name: KnowledgeRequest +fullName: azure.cognitiveservices.search.visualsearch.models.KnowledgeRequest +module: azure.cognitiveservices.search.visualsearch.models +summary: 'A JSON object containing information about the request, such as filters + for + + the resulting actions.' +constructor: + syntax: KnowledgeRequest(*, filters=None, **kwargs) + parameters: + - name: filters + description: 'A key-value object consisting of filters that may be + + specified to limit the results returned by the API.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: filters + isRequired: true +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.KnowledgeRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.KnowledgeRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.KnowledgeRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.KnowledgeRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.KnowledgeRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.KnowledgeRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.KnowledgeRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.MediaObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.MediaObject.yml new file mode 100644 index 00000000..0e924489 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.MediaObject.yml @@ -0,0 +1,226 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.MediaObject +name: MediaObject +fullName: azure.cognitiveservices.search.visualsearch.models.MediaObject +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines a media object. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: ImageObject + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: MediaObject(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: 'Original URL to retrieve the source (file) for the + + media object (e.g., the source URL for the image).' + name: content_url + types: + - +- description: URL of the page that hosts the media object. + name: host_page_url + types: + - +- description: 'Size of the media object content. Use format "value + + unit" (e.g., "1024 B").' + name: content_size + types: + - +- description: Encoding format (e.g., png, gif, jpeg, etc). + name: encoding_format + types: + - +- description: 'Display URL of the page that hosts the media + + object.' + name: host_page_display_url + types: + - +- description: The width of the media object, in pixels. + name: width + types: + - +- description: The height of the media object, in pixels. + name: height + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.MediaObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.MediaObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.MediaObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.MediaObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.MediaObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.MediaObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.MediaObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.NormalizedQuadrilateral.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.NormalizedQuadrilateral.yml new file mode 100644 index 00000000..7ec2bea0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.NormalizedQuadrilateral.yml @@ -0,0 +1,207 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.NormalizedQuadrilateral +name: NormalizedQuadrilateral +fullName: azure.cognitiveservices.search.visualsearch.models.NormalizedQuadrilateral +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines a region of an image. The region is a convex quadrilateral defined + + by coordinates of its top left, top right, bottom left, and bottom right + + points. The coordinates are fractional values of the original image''s width + + and height in the range 0.0 through 1.0. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: NormalizedQuadrilateral(*, top_left, top_right, bottom_right, bottom_left, + **kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: top_left + description: Required. The top left corner coordinate. + isRequired: true + types: + - + - name: top_right + description: Required. The top right corner coordinate. + isRequired: true + types: + - + - name: bottom_right + description: Required. The bottom right corner coordinate. + isRequired: true + types: + - + - name: bottom_left + description: Required. The bottom left corner coordinate. + isRequired: true + types: + - + keywordOnlyParameters: + - name: top_left + isRequired: true + - name: top_right + isRequired: true + - name: bottom_right + isRequired: true + - name: bottom_left + isRequired: true +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.NormalizedQuadrilateral.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.NormalizedQuadrilateral.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.NormalizedQuadrilateral.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.NormalizedQuadrilateral.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.NormalizedQuadrilateral.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.NormalizedQuadrilateral.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.NormalizedQuadrilateral.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Offer(class).yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Offer(class).yml new file mode 100644 index 00000000..3b02cdba --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Offer(class).yml @@ -0,0 +1,264 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.Offer +name: Offer +fullName: azure.cognitiveservices.search.visualsearch.models.Offer +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines a merchant''s offer. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: AggregateOffer + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Offer(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: Seller for this offer. + name: seller + types: + - +- description: The item's price. + name: price + types: + - +- description: 'The monetary currency. For example, USD. Possible + + values include: ''USD'', ''CAD'', ''GBP'', ''EUR'', ''COP'', ''JPY'', ''CNY'', + ''AUD'', + + ''INR'', ''AED'', ''AFN'', ''ALL'', ''AMD'', ''ANG'', ''AOA'', ''ARS'', ''AWG'', + ''AZN'', + + ''BAM'', ''BBD'', ''BDT'', ''BGN'', ''BHD'', ''BIF'', ''BMD'', ''BND'', ''BOB'', + ''BOV'', + + ''BRL'', ''BSD'', ''BTN'', ''BWP'', ''BYR'', ''BZD'', ''CDF'', ''CHE'', ''CHF'', + ''CHW'', + + ''CLF'', ''CLP'', ''COU'', ''CRC'', ''CUC'', ''CUP'', ''CVE'', ''CZK'', ''DJF'', + ''DKK'', + + ''DOP'', ''DZD'', ''EGP'', ''ERN'', ''ETB'', ''FJD'', ''FKP'', ''GEL'', ''GHS'', + ''GIP'', + + ''GMD'', ''GNF'', ''GTQ'', ''GYD'', ''HKD'', ''HNL'', ''HRK'', ''HTG'', ''HUF'', + ''IDR'', + + ''ILS'', ''IQD'', ''IRR'', ''ISK'', ''JMD'', ''JOD'', ''KES'', ''KGS'', ''KHR'', + ''KMF'', + + ''KPW'', ''KRW'', ''KWD'', ''KYD'', ''KZT'', ''LAK'', ''LBP'', ''LKR'', ''LRD'', + ''LSL'', + + ''LYD'', ''MAD'', ''MDL'', ''MGA'', ''MKD'', ''MMK'', ''MNT'', ''MOP'', ''MRO'', + ''MUR'', + + ''MVR'', ''MWK'', ''MXN'', ''MXV'', ''MYR'', ''MZN'', ''NAD'', ''NGN'', ''NIO'', + ''NOK'', + + ''NPR'', ''NZD'', ''OMR'', ''PAB'', ''PEN'', ''PGK'', ''PHP'', ''PKR'', ''PLN'', + ''PYG'', + + ''QAR'', ''RON'', ''RSD'', ''RUB'', ''RWF'', ''SAR'', ''SBD'', ''SCR'', ''SDG'', + ''SEK'', + + ''SGD'', ''SHP'', ''SLL'', ''SOS'', ''SRD'', ''SSP'', ''STD'', ''SYP'', ''SZL'', + ''THB'', + + ''TJS'', ''TMT'', ''TND'', ''TOP'', ''TRY'', ''TTD'', ''TWD'', ''TZS'', ''UAH'', + ''UGX'', + + ''UYU'', ''UZS'', ''VEF'', ''VND'', ''VUV'', ''WST'', ''XAF'', ''XCD'', ''XOF'', + ''XPF'', + + ''YER'', ''ZAR'', ''ZMW''. Default value: "USD" .' + name: price_currency + types: + - + - +- description: 'The item''s availability. The following are the + + possible values: Discontinued, InStock, InStoreOnly, LimitedAvailability, + + OnlineOnly, OutOfStock, PreOrder, SoldOut. Possible values include: + + ''Discontinued'', ''InStock'', ''InStoreOnly'', ''LimitedAvailability'', + + ''OnlineOnly'', ''OutOfStock'', ''PreOrder'', ''SoldOut''' + name: availability + types: + - + - +- description: 'An aggregated rating that indicates how well the + + product has been rated by others.' + name: aggregate_rating + types: + - +- description: 'The last date that the offer was updated. The date is + + in the form YYYY-MM-DD.' + name: last_updated + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.Offer.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Offer.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Offer.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.Offer.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Offer.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.Offer.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Offer.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Organization(class).yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Organization(class).yml new file mode 100644 index 00000000..e7e8cf82 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Organization(class).yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.Organization +name: Organization +fullName: azure.cognitiveservices.search.visualsearch.models.Organization +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines an organization. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Organization(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.Organization.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Organization.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Organization.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.Organization.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Organization.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.Organization.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Organization.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Person(class).yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Person(class).yml new file mode 100644 index 00000000..38a02229 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Person(class).yml @@ -0,0 +1,179 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.Person +name: Person +fullName: azure.cognitiveservices.search.visualsearch.models.Person +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines a person. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Person(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The person's job title. + name: job_title + types: + - +- description: The URL of the person's twitter profile. + name: twitter_profile + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.Person.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Person.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Person.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.Person.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Person.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.Person.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Person.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Point2D.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Point2D.yml new file mode 100644 index 00000000..a022104a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Point2D.yml @@ -0,0 +1,186 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.Point2D +name: Point2D +fullName: azure.cognitiveservices.search.visualsearch.models.Point2D +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines a 2D point with X and Y coordinates. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Point2D(*, x: float, y: float, **kwargs)' + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: x + description: Required. The x-coordinate of the point. + isRequired: true + types: + - + - name: y + description: Required. The y-coordinate of the point. + isRequired: true + types: + - + keywordOnlyParameters: + - name: x + isRequired: true + - name: y + isRequired: true +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.Point2D.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Point2D.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Point2D.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.Point2D.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Point2D.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.Point2D.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Point2D.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.PropertiesItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.PropertiesItem.yml new file mode 100644 index 00000000..b497f4b1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.PropertiesItem.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.PropertiesItem +name: PropertiesItem +fullName: azure.cognitiveservices.search.visualsearch.models.PropertiesItem +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines an item. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Rating + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: PropertiesItem(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: Text representation of an item. + name: text + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.PropertiesItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.PropertiesItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.PropertiesItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.PropertiesItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.PropertiesItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.PropertiesItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.PropertiesItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Query(class).yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Query(class).yml new file mode 100644 index 00000000..7113344e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Query(class).yml @@ -0,0 +1,160 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.Query +name: Query +fullName: azure.cognitiveservices.search.visualsearch.models.Query +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines a search query. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Query(*, text: str, **kwargs)' + parameters: + - name: text + description: 'Required. The query string. Use this string as the query term + + in a new search request.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: text + isRequired: true +variables: +- description: The display version of the query term. + name: display_text + types: + - +- description: 'The URL that takes the user to the Bing search + + results page for the query.' + name: web_search_url + types: + - +- description: 'The URL that you use to get the results of the related + + search. Before using the URL, you must append query parameters as + + appropriate and include the Ocp-Apim-Subscription-Key header. Use this URL + + if you''re displaying the results in your own user interface. Otherwise, + + use the webSearchUrl URL.' + name: search_link + types: + - +- description: The URL to a thumbnail of a related image. + name: thumbnail + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.Query.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Query.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Query.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.Query.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Query.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.Query.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Query.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Rating(class).yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Rating(class).yml new file mode 100644 index 00000000..360f8ffc --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Rating(class).yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.Rating +name: Rating +fullName: azure.cognitiveservices.search.visualsearch.models.Rating +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines a rating. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: AggregateRating + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Rating(*, rating_value: float, **kwargs)' + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: rating_value + description: 'Required. The mean (average) rating. The possible + + values are 1.0 through 5.0.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: rating_value + isRequired: true +variables: +- description: Text representation of an item. + name: text + types: + - +- description: 'The highest rated review. The possible values are 1.0 + + through 5.0.' + name: best_rating + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.Rating.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Rating.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Rating.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.Rating.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Rating.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.Rating.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Rating.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Recipe(class).yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Recipe(class).yml new file mode 100644 index 00000000..c52e210d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Recipe(class).yml @@ -0,0 +1,211 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.Recipe +name: Recipe +fullName: azure.cognitiveservices.search.visualsearch.models.Recipe +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines a cooking recipe. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Recipe(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: 'The amount of time the food takes to cook. For example, + + PT25M. For information about the time format, see + + [http://en.wikipedia.org/wiki/ISO_8601#Durations](http://en.wikipedia.org/wiki/ISO_8601#Durations).' + name: cook_time + types: + - +- description: 'The amount of time required to prepare the ingredients. + + For example, PT15M. For information about the time format, see + + [http://en.wikipedia.org/wiki/ISO_8601#Durations](http://en.wikipedia.org/wiki/ISO_8601#Durations).' + name: prep_time + types: + - +- description: 'The total amount of time it takes to prepare and cook + + the recipe. For example, PT45M. For information about the time format, see + + [http://en.wikipedia.org/wiki/ISO_8601#Durations](http://en.wikipedia.org/wiki/ISO_8601#Durations).' + name: total_time + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.Recipe.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Recipe.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Recipe.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.Recipe.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Recipe.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.Recipe.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Recipe.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.RecipesModule.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.RecipesModule.yml new file mode 100644 index 00000000..22ee8837 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.RecipesModule.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.RecipesModule +name: RecipesModule +fullName: azure.cognitiveservices.search.visualsearch.models.RecipesModule +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines a list of recipes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: RecipesModule(**kwargs) +variables: +- description: A list of recipes. + name: value + types: + - [] +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.RecipesModule.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.RecipesModule.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.RecipesModule.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.RecipesModule.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.RecipesModule.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.RecipesModule.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.RecipesModule.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.RelatedSearchesModule.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.RelatedSearchesModule.yml new file mode 100644 index 00000000..737674fe --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.RelatedSearchesModule.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.RelatedSearchesModule +name: RelatedSearchesModule +fullName: azure.cognitiveservices.search.visualsearch.models.RelatedSearchesModule +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines a list of related searches. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: RelatedSearchesModule(**kwargs) +variables: +- description: A list of related searches. + name: value + types: + - [] +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.RelatedSearchesModule.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.RelatedSearchesModule.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.RelatedSearchesModule.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.RelatedSearchesModule.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.RelatedSearchesModule.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.RelatedSearchesModule.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.RelatedSearchesModule.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Response(class).yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Response(class).yml new file mode 100644 index 00000000..2e47826e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Response(class).yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.Response +name: Response +fullName: azure.cognitiveservices.search.visualsearch.models.Response +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines a response. All schemas that return at the root of the response + + must inherit from this object. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: ImageKnowledge, ErrorResponse, Thing + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Response(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.Response.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Response.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Response.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.Response.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Response.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.Response.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Response.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ResponseBase.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ResponseBase.yml new file mode 100644 index 00000000..b757ad1a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ResponseBase.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.ResponseBase +name: ResponseBase +fullName: azure.cognitiveservices.search.visualsearch.models.ResponseBase +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Response base. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Identifiable + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ResponseBase(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.ResponseBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ResponseBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ResponseBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.ResponseBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.ResponseBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.ResponseBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.ResponseBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.SafeSearch.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.SafeSearch.yml new file mode 100644 index 00000000..eb886998 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.SafeSearch.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.search.visualsearch.models.SafeSearch +name: SafeSearch +fullName: azure.cognitiveservices.search.visualsearch.models.SafeSearch +module: azure.cognitiveservices.search.visualsearch.models +fields: +- name: moderate + uid: azure.cognitiveservices.search.visualsearch.models.SafeSearch.moderate +- name: 'off' + uid: azure.cognitiveservices.search.visualsearch.models.SafeSearch.off +- name: strict + uid: azure.cognitiveservices.search.visualsearch.models.SafeSearch.strict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.StructuredValue.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.StructuredValue.yml new file mode 100644 index 00000000..86c77f2b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.StructuredValue.yml @@ -0,0 +1,176 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.StructuredValue +name: StructuredValue +fullName: azure.cognitiveservices.search.visualsearch.models.StructuredValue +module: azure.cognitiveservices.search.visualsearch.models +summary: 'StructuredValue. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Point2D, NormalizedQuadrilateral + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: StructuredValue(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.StructuredValue.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.StructuredValue.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.StructuredValue.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.StructuredValue.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.StructuredValue.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.StructuredValue.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.StructuredValue.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Thing(class).yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Thing(class).yml new file mode 100644 index 00000000..20805c21 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Thing(class).yml @@ -0,0 +1,178 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.Thing +name: Thing +fullName: azure.cognitiveservices.search.visualsearch.models.Thing +module: azure.cognitiveservices.search.visualsearch.models +summary: 'Defines a thing. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: ImageTag, Organization, Offer, CreativeWork, Person, + + Intangible + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Thing(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.Thing.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Thing.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Thing.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.Thing.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.Thing.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.Thing.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.Thing.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.VisualSearchRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.VisualSearchRequest.yml new file mode 100644 index 00000000..55449699 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.VisualSearchRequest.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.VisualSearchRequest +name: VisualSearchRequest +fullName: azure.cognitiveservices.search.visualsearch.models.VisualSearchRequest +module: azure.cognitiveservices.search.visualsearch.models +summary: 'A JSON object that contains information about the image to get insights + of. + + Specify this object only in a knowledgeRequest form data.' +constructor: + syntax: VisualSearchRequest(*, image_info=None, knowledge_request=None, **kwargs) + parameters: + - name: image_info + description: 'A JSON object that identities the image to get insights + + of.' + isRequired: true + types: + - + - name: knowledge_request + description: 'A JSON object containing information about the + + request, such as filters, or a description.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: image_info + isRequired: true + - name: knowledge_request + isRequired: true +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.VisualSearchRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.VisualSearchRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.VisualSearchRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.VisualSearchRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.VisualSearchRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.VisualSearchRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.VisualSearchRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.action.Action.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.action.Action.yml new file mode 100644 index 00000000..98afa221 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.action.Action.yml @@ -0,0 +1,214 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.action.Action +name: Action +fullName: azure.cognitiveservices.search.visualsearch.models.action.Action +module: azure.cognitiveservices.search.visualsearch.models.action +summary: 'Defines an action. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: ImageAction + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Action(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: The result produced in the action. + name: result + types: + - [] +- description: A display name for the action. + name: display_name + types: + - +- description: 'A Boolean representing whether this result is the top + + action.' + name: is_top_action + types: + - +- description: 'Use this URL to get additional data to determine how to + + take the appropriate action. For example, the serviceUrl might return JSON + + along with an image URL.' + name: service_url + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.action.Action.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.action.Action.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.action.Action.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.action.Action.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.action.Action.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.action.Action.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.action.Action.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.action.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.action.yml new file mode 100644 index 00000000..8120a306 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.action.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.action +name: action +fullName: azure.cognitiveservices.search.visualsearch.models.action +classes: +- azure.cognitiveservices.search.visualsearch.models.action.Action diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.action_py3.Action.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.action_py3.Action.yml new file mode 100644 index 00000000..34d711f7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.action_py3.Action.yml @@ -0,0 +1,214 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.action_py3.Action +name: Action +fullName: azure.cognitiveservices.search.visualsearch.models.action_py3.Action +module: azure.cognitiveservices.search.visualsearch.models.action_py3 +summary: 'Defines an action. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: ImageAction + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Action(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: The result produced in the action. + name: result + types: + - [] +- description: A display name for the action. + name: display_name + types: + - +- description: 'A Boolean representing whether this result is the top + + action.' + name: is_top_action + types: + - +- description: 'Use this URL to get additional data to determine how to + + take the appropriate action. For example, the serviceUrl might return JSON + + along with an image URL.' + name: service_url + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.action_py3.Action.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.action_py3.Action.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.action_py3.Action.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.action_py3.Action.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.action_py3.Action.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.action_py3.Action.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.action_py3.Action.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.action_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.action_py3.yml new file mode 100644 index 00000000..1ec82916 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.action_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.action_py3 +name: action_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.action_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.action_py3.Action diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_offer.AggregateOffer.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_offer.AggregateOffer.yml new file mode 100644 index 00000000..ec4e7e36 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_offer.AggregateOffer.yml @@ -0,0 +1,265 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.aggregate_offer.AggregateOffer +name: AggregateOffer +fullName: azure.cognitiveservices.search.visualsearch.models.aggregate_offer.AggregateOffer +module: azure.cognitiveservices.search.visualsearch.models.aggregate_offer +summary: 'Defines a list of offers from merchants that are related to the image. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: AggregateOffer(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: Seller for this offer. + name: seller + types: + - +- description: The item's price. + name: price + types: + - +- description: 'The monetary currency. For example, USD. Possible + + values include: ''USD'', ''CAD'', ''GBP'', ''EUR'', ''COP'', ''JPY'', ''CNY'', + ''AUD'', + + ''INR'', ''AED'', ''AFN'', ''ALL'', ''AMD'', ''ANG'', ''AOA'', ''ARS'', ''AWG'', + ''AZN'', + + ''BAM'', ''BBD'', ''BDT'', ''BGN'', ''BHD'', ''BIF'', ''BMD'', ''BND'', ''BOB'', + ''BOV'', + + ''BRL'', ''BSD'', ''BTN'', ''BWP'', ''BYR'', ''BZD'', ''CDF'', ''CHE'', ''CHF'', + ''CHW'', + + ''CLF'', ''CLP'', ''COU'', ''CRC'', ''CUC'', ''CUP'', ''CVE'', ''CZK'', ''DJF'', + ''DKK'', + + ''DOP'', ''DZD'', ''EGP'', ''ERN'', ''ETB'', ''FJD'', ''FKP'', ''GEL'', ''GHS'', + ''GIP'', + + ''GMD'', ''GNF'', ''GTQ'', ''GYD'', ''HKD'', ''HNL'', ''HRK'', ''HTG'', ''HUF'', + ''IDR'', + + ''ILS'', ''IQD'', ''IRR'', ''ISK'', ''JMD'', ''JOD'', ''KES'', ''KGS'', ''KHR'', + ''KMF'', + + ''KPW'', ''KRW'', ''KWD'', ''KYD'', ''KZT'', ''LAK'', ''LBP'', ''LKR'', ''LRD'', + ''LSL'', + + ''LYD'', ''MAD'', ''MDL'', ''MGA'', ''MKD'', ''MMK'', ''MNT'', ''MOP'', ''MRO'', + ''MUR'', + + ''MVR'', ''MWK'', ''MXN'', ''MXV'', ''MYR'', ''MZN'', ''NAD'', ''NGN'', ''NIO'', + ''NOK'', + + ''NPR'', ''NZD'', ''OMR'', ''PAB'', ''PEN'', ''PGK'', ''PHP'', ''PKR'', ''PLN'', + ''PYG'', + + ''QAR'', ''RON'', ''RSD'', ''RUB'', ''RWF'', ''SAR'', ''SBD'', ''SCR'', ''SDG'', + ''SEK'', + + ''SGD'', ''SHP'', ''SLL'', ''SOS'', ''SRD'', ''SSP'', ''STD'', ''SYP'', ''SZL'', + ''THB'', + + ''TJS'', ''TMT'', ''TND'', ''TOP'', ''TRY'', ''TTD'', ''TWD'', ''TZS'', ''UAH'', + ''UGX'', + + ''UYU'', ''UZS'', ''VEF'', ''VND'', ''VUV'', ''WST'', ''XAF'', ''XCD'', ''XOF'', + ''XPF'', + + ''YER'', ''ZAR'', ''ZMW''. Default value: "USD" .' + name: price_currency + types: + - + - +- description: 'The item''s availability. The following are the + + possible values: Discontinued, InStock, InStoreOnly, LimitedAvailability, + + OnlineOnly, OutOfStock, PreOrder, SoldOut. Possible values include: + + ''Discontinued'', ''InStock'', ''InStoreOnly'', ''LimitedAvailability'', + + ''OnlineOnly'', ''OutOfStock'', ''PreOrder'', ''SoldOut''' + name: availability + types: + - + - +- description: 'An aggregated rating that indicates how well the + + product has been rated by others.' + name: aggregate_rating + types: + - +- description: 'The last date that the offer was updated. The date is + + in the form YYYY-MM-DD.' + name: last_updated + types: + - +- description: 'A list of offers from merchants that have offerings related + + to the image.' + name: offers + types: + - [] +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_offer.AggregateOffer.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_offer.AggregateOffer.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_offer.AggregateOffer.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_offer.AggregateOffer.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_offer.AggregateOffer.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_offer.AggregateOffer.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_offer.AggregateOffer.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_offer.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_offer.yml new file mode 100644 index 00000000..7c48762b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_offer.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.aggregate_offer +name: aggregate_offer +fullName: azure.cognitiveservices.search.visualsearch.models.aggregate_offer +classes: +- azure.cognitiveservices.search.visualsearch.models.aggregate_offer.AggregateOffer diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3.AggregateOffer.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3.AggregateOffer.yml new file mode 100644 index 00000000..761e0b6f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3.AggregateOffer.yml @@ -0,0 +1,265 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3.AggregateOffer +name: AggregateOffer +fullName: azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3.AggregateOffer +module: azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3 +summary: 'Defines a list of offers from merchants that are related to the image. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: AggregateOffer(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: Seller for this offer. + name: seller + types: + - +- description: The item's price. + name: price + types: + - +- description: 'The monetary currency. For example, USD. Possible + + values include: ''USD'', ''CAD'', ''GBP'', ''EUR'', ''COP'', ''JPY'', ''CNY'', + ''AUD'', + + ''INR'', ''AED'', ''AFN'', ''ALL'', ''AMD'', ''ANG'', ''AOA'', ''ARS'', ''AWG'', + ''AZN'', + + ''BAM'', ''BBD'', ''BDT'', ''BGN'', ''BHD'', ''BIF'', ''BMD'', ''BND'', ''BOB'', + ''BOV'', + + ''BRL'', ''BSD'', ''BTN'', ''BWP'', ''BYR'', ''BZD'', ''CDF'', ''CHE'', ''CHF'', + ''CHW'', + + ''CLF'', ''CLP'', ''COU'', ''CRC'', ''CUC'', ''CUP'', ''CVE'', ''CZK'', ''DJF'', + ''DKK'', + + ''DOP'', ''DZD'', ''EGP'', ''ERN'', ''ETB'', ''FJD'', ''FKP'', ''GEL'', ''GHS'', + ''GIP'', + + ''GMD'', ''GNF'', ''GTQ'', ''GYD'', ''HKD'', ''HNL'', ''HRK'', ''HTG'', ''HUF'', + ''IDR'', + + ''ILS'', ''IQD'', ''IRR'', ''ISK'', ''JMD'', ''JOD'', ''KES'', ''KGS'', ''KHR'', + ''KMF'', + + ''KPW'', ''KRW'', ''KWD'', ''KYD'', ''KZT'', ''LAK'', ''LBP'', ''LKR'', ''LRD'', + ''LSL'', + + ''LYD'', ''MAD'', ''MDL'', ''MGA'', ''MKD'', ''MMK'', ''MNT'', ''MOP'', ''MRO'', + ''MUR'', + + ''MVR'', ''MWK'', ''MXN'', ''MXV'', ''MYR'', ''MZN'', ''NAD'', ''NGN'', ''NIO'', + ''NOK'', + + ''NPR'', ''NZD'', ''OMR'', ''PAB'', ''PEN'', ''PGK'', ''PHP'', ''PKR'', ''PLN'', + ''PYG'', + + ''QAR'', ''RON'', ''RSD'', ''RUB'', ''RWF'', ''SAR'', ''SBD'', ''SCR'', ''SDG'', + ''SEK'', + + ''SGD'', ''SHP'', ''SLL'', ''SOS'', ''SRD'', ''SSP'', ''STD'', ''SYP'', ''SZL'', + ''THB'', + + ''TJS'', ''TMT'', ''TND'', ''TOP'', ''TRY'', ''TTD'', ''TWD'', ''TZS'', ''UAH'', + ''UGX'', + + ''UYU'', ''UZS'', ''VEF'', ''VND'', ''VUV'', ''WST'', ''XAF'', ''XCD'', ''XOF'', + ''XPF'', + + ''YER'', ''ZAR'', ''ZMW''. Default value: "USD" .' + name: price_currency + types: + - + - +- description: 'The item''s availability. The following are the + + possible values: Discontinued, InStock, InStoreOnly, LimitedAvailability, + + OnlineOnly, OutOfStock, PreOrder, SoldOut. Possible values include: + + ''Discontinued'', ''InStock'', ''InStoreOnly'', ''LimitedAvailability'', + + ''OnlineOnly'', ''OutOfStock'', ''PreOrder'', ''SoldOut''' + name: availability + types: + - + - +- description: 'An aggregated rating that indicates how well the + + product has been rated by others.' + name: aggregate_rating + types: + - +- description: 'The last date that the offer was updated. The date is + + in the form YYYY-MM-DD.' + name: last_updated + types: + - +- description: 'A list of offers from merchants that have offerings related + + to the image.' + name: offers + types: + - [] +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3.AggregateOffer.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3.AggregateOffer.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3.AggregateOffer.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3.AggregateOffer.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3.AggregateOffer.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3.AggregateOffer.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3.AggregateOffer.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3.yml new file mode 100644 index 00000000..2b500117 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3 +name: aggregate_offer_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3.AggregateOffer diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_rating.AggregateRating.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_rating.AggregateRating.yml new file mode 100644 index 00000000..361a6085 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_rating.AggregateRating.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.aggregate_rating.AggregateRating +name: AggregateRating +fullName: azure.cognitiveservices.search.visualsearch.models.aggregate_rating.AggregateRating +module: azure.cognitiveservices.search.visualsearch.models.aggregate_rating +summary: 'Defines the metrics that indicate how well an item was rated by others. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: AggregateRating(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: rating_value + description: 'Required. The mean (average) rating. The possible + + values are 1.0 through 5.0.' + isRequired: true + types: + - +variables: +- description: Text representation of an item. + name: text + types: + - +- description: 'The highest rated review. The possible values are 1.0 + + through 5.0.' + name: best_rating + types: + - +- description: 'The number of times the recipe has been rated or + + reviewed.' + name: review_count + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_rating.AggregateRating.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_rating.AggregateRating.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_rating.AggregateRating.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_rating.AggregateRating.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_rating.AggregateRating.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_rating.AggregateRating.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_rating.AggregateRating.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_rating.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_rating.yml new file mode 100644 index 00000000..2d66afd7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_rating.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.aggregate_rating +name: aggregate_rating +fullName: azure.cognitiveservices.search.visualsearch.models.aggregate_rating +classes: +- azure.cognitiveservices.search.visualsearch.models.aggregate_rating.AggregateRating diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3.AggregateRating.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3.AggregateRating.yml new file mode 100644 index 00000000..828ff779 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3.AggregateRating.yml @@ -0,0 +1,155 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3.AggregateRating +name: AggregateRating +fullName: azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3.AggregateRating +module: azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3 +summary: 'Defines the metrics that indicate how well an item was rated by others. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AggregateRating(*, rating_value: float, **kwargs)' + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: rating_value + description: 'Required. The mean (average) rating. The possible + + values are 1.0 through 5.0.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: rating_value + isRequired: true +variables: +- description: Text representation of an item. + name: text + types: + - +- description: 'The highest rated review. The possible values are 1.0 + + through 5.0.' + name: best_rating + types: + - +- description: 'The number of times the recipe has been rated or + + reviewed.' + name: review_count + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3.AggregateRating.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3.AggregateRating.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3.AggregateRating.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3.AggregateRating.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3.AggregateRating.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3.AggregateRating.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3.AggregateRating.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3.yml new file mode 100644 index 00000000..a663fa41 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3 +name: aggregate_rating_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3.AggregateRating diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.creative_work.CreativeWork.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.creative_work.CreativeWork.yml new file mode 100644 index 00000000..c15c741d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.creative_work.CreativeWork.yml @@ -0,0 +1,194 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.creative_work.CreativeWork +name: CreativeWork +fullName: azure.cognitiveservices.search.visualsearch.models.creative_work.CreativeWork +module: azure.cognitiveservices.search.visualsearch.models.creative_work +summary: 'The most generic kind of creative work, including books, movies, + + photographs, software programs, etc. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Action, MediaObject, Recipe + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CreativeWork(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.creative_work.CreativeWork.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.creative_work.CreativeWork.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.creative_work.CreativeWork.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.creative_work.CreativeWork.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.creative_work.CreativeWork.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.creative_work.CreativeWork.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.creative_work.CreativeWork.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.creative_work.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.creative_work.yml new file mode 100644 index 00000000..ba186b5c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.creative_work.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.creative_work +name: creative_work +fullName: azure.cognitiveservices.search.visualsearch.models.creative_work +classes: +- azure.cognitiveservices.search.visualsearch.models.creative_work.CreativeWork diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.creative_work_py3.CreativeWork.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.creative_work_py3.CreativeWork.yml new file mode 100644 index 00000000..190d45a7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.creative_work_py3.CreativeWork.yml @@ -0,0 +1,194 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.creative_work_py3.CreativeWork +name: CreativeWork +fullName: azure.cognitiveservices.search.visualsearch.models.creative_work_py3.CreativeWork +module: azure.cognitiveservices.search.visualsearch.models.creative_work_py3 +summary: 'The most generic kind of creative work, including books, movies, + + photographs, software programs, etc. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Action, MediaObject, Recipe + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CreativeWork(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.creative_work_py3.CreativeWork.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.creative_work_py3.CreativeWork.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.creative_work_py3.CreativeWork.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.creative_work_py3.CreativeWork.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.creative_work_py3.CreativeWork.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.creative_work_py3.CreativeWork.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.creative_work_py3.CreativeWork.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.creative_work_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.creative_work_py3.yml new file mode 100644 index 00000000..2198540a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.creative_work_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.creative_work_py3 +name: creative_work_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.creative_work_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.creative_work_py3.CreativeWork diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.crop_area.CropArea.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.crop_area.CropArea.yml new file mode 100644 index 00000000..7799274d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.crop_area.CropArea.yml @@ -0,0 +1,164 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.crop_area.CropArea +name: CropArea +fullName: azure.cognitiveservices.search.visualsearch.models.crop_area.CropArea +module: azure.cognitiveservices.search.visualsearch.models.crop_area +summary: 'A JSON object consisting of coordinates specifying the four corners of a + + cropped rectangle within the input image. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CropArea(**kwargs) + parameters: + - name: top + description: 'Required. The top coordinate of the region to be cropped. The + + coordinate is a fractional value of the original image''s height and is + + measured from the top edge of the image. Specify the coordinate as a value + + from 0.0 through 1.0.' + isRequired: true + types: + - + - name: bottom + description: 'Required. The bottom coordinate of the region to be + + cropped. The coordinate is a fractional value of the original image''s + + height and is measured from the top edge of the image. Specify the + + coordinate as a value from 0.0 through 1.0.' + isRequired: true + types: + - + - name: left + description: 'Required. The left coordinate of the region to be cropped. + + The coordinate is a fractional value of the original image''s width and is + + measured from the left edge of the image. Specify the coordinate as a + + value from 0.0 through 1.0.' + isRequired: true + types: + - + - name: right + description: 'Required. The right coordinate of the region to be cropped. + + The coordinate is a fractional value of the original image''s width and is + + measured from the left edge of the image. Specify the coordinate as a + + value from 0.0 through 1.0.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.crop_area.CropArea.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.crop_area.CropArea.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.crop_area.CropArea.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.crop_area.CropArea.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.crop_area.CropArea.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.crop_area.CropArea.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.crop_area.CropArea.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.crop_area.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.crop_area.yml new file mode 100644 index 00000000..358c2df9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.crop_area.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.crop_area +name: crop_area +fullName: azure.cognitiveservices.search.visualsearch.models.crop_area +classes: +- azure.cognitiveservices.search.visualsearch.models.crop_area.CropArea diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.crop_area_py3.CropArea.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.crop_area_py3.CropArea.yml new file mode 100644 index 00000000..e1f52b4a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.crop_area_py3.CropArea.yml @@ -0,0 +1,173 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.crop_area_py3.CropArea +name: CropArea +fullName: azure.cognitiveservices.search.visualsearch.models.crop_area_py3.CropArea +module: azure.cognitiveservices.search.visualsearch.models.crop_area_py3 +summary: 'A JSON object consisting of coordinates specifying the four corners of a + + cropped rectangle within the input image. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CropArea(*, top: float, bottom: float, left: float, right: float, **kwargs)' + parameters: + - name: top + description: 'Required. The top coordinate of the region to be cropped. The + + coordinate is a fractional value of the original image''s height and is + + measured from the top edge of the image. Specify the coordinate as a value + + from 0.0 through 1.0.' + isRequired: true + types: + - + - name: bottom + description: 'Required. The bottom coordinate of the region to be + + cropped. The coordinate is a fractional value of the original image''s + + height and is measured from the top edge of the image. Specify the + + coordinate as a value from 0.0 through 1.0.' + isRequired: true + types: + - + - name: left + description: 'Required. The left coordinate of the region to be cropped. + + The coordinate is a fractional value of the original image''s width and is + + measured from the left edge of the image. Specify the coordinate as a + + value from 0.0 through 1.0.' + isRequired: true + types: + - + - name: right + description: 'Required. The right coordinate of the region to be cropped. + + The coordinate is a fractional value of the original image''s width and is + + measured from the left edge of the image. Specify the coordinate as a + + value from 0.0 through 1.0.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: top + isRequired: true + - name: bottom + isRequired: true + - name: left + isRequired: true + - name: right + isRequired: true +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.crop_area_py3.CropArea.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.crop_area_py3.CropArea.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.crop_area_py3.CropArea.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.crop_area_py3.CropArea.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.crop_area_py3.CropArea.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.crop_area_py3.CropArea.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.crop_area_py3.CropArea.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.crop_area_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.crop_area_py3.yml new file mode 100644 index 00000000..2be73caa --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.crop_area_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.crop_area_py3 +name: crop_area_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.crop_area_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.crop_area_py3.CropArea diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error.Error.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error.Error.yml new file mode 100644 index 00000000..68851006 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error.Error.yml @@ -0,0 +1,168 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.error.Error +name: Error +fullName: azure.cognitiveservices.search.visualsearch.models.error.Error +module: azure.cognitiveservices.search.visualsearch.models.error +summary: 'Defines the error that occurred. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Error(**kwargs) + parameters: + - name: code + description: 'Required. The error code that identifies the category of + + error. Possible values include: ''None'', ''ServerError'', ''InvalidRequest'', + + ''RateLimitExceeded'', ''InvalidAuthorization'', ''InsufficientAuthorization''. + + Default value: "None" .' + isRequired: true + types: + - + - + - name: message + description: Required. A description of the error. + isRequired: true + types: + - +variables: +- description: 'The error code that further helps to identify the error. + + Possible values include: ''UnexpectedError'', ''ResourceError'', + + ''NotImplemented'', ''ParameterMissing'', ''ParameterInvalidValue'', + + ''HttpNotAllowed'', ''Blocked'', ''AuthorizationMissing'', + + ''AuthorizationRedundancy'', ''AuthorizationDisabled'', ''AuthorizationExpired''' + name: sub_code + types: + - + - +- description: 'A description that provides additional information + + about the error.' + name: more_details + types: + - +- description: The parameter in the request that caused the error. + name: parameter + types: + - +- description: The parameter's value in the request that was not valid. + name: value + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.error.Error.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.error.Error.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.error.Error.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.error.Error.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.error.Error.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.error.Error.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.error.Error.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error.yml new file mode 100644 index 00000000..e0081f82 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.error +name: error +fullName: azure.cognitiveservices.search.visualsearch.models.error +classes: +- azure.cognitiveservices.search.visualsearch.models.error.Error diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_py3.Error.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_py3.Error.yml new file mode 100644 index 00000000..c62bc01a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_py3.Error.yml @@ -0,0 +1,173 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.error_py3.Error +name: Error +fullName: azure.cognitiveservices.search.visualsearch.models.error_py3.Error +module: azure.cognitiveservices.search.visualsearch.models.error_py3 +summary: 'Defines the error that occurred. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Error(*, message: str, code=''None'', **kwargs)' + parameters: + - name: code + description: 'Required. The error code that identifies the category of + + error. Possible values include: ''None'', ''ServerError'', ''InvalidRequest'', + + ''RateLimitExceeded'', ''InvalidAuthorization'', ''InsufficientAuthorization''. + + Default value: "None" .' + isRequired: true + types: + - + - + - name: message + description: Required. A description of the error. + isRequired: true + types: + - + keywordOnlyParameters: + - name: message + isRequired: true + - name: code + defaultValue: None +variables: +- description: 'The error code that further helps to identify the error. + + Possible values include: ''UnexpectedError'', ''ResourceError'', + + ''NotImplemented'', ''ParameterMissing'', ''ParameterInvalidValue'', + + ''HttpNotAllowed'', ''Blocked'', ''AuthorizationMissing'', + + ''AuthorizationRedundancy'', ''AuthorizationDisabled'', ''AuthorizationExpired''' + name: sub_code + types: + - + - +- description: 'A description that provides additional information + + about the error.' + name: more_details + types: + - +- description: The parameter in the request that caused the error. + name: parameter + types: + - +- description: The parameter's value in the request that was not valid. + name: value + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.error_py3.Error.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.error_py3.Error.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.error_py3.Error.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.error_py3.Error.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.error_py3.Error.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.error_py3.Error.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.error_py3.Error.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_py3.yml new file mode 100644 index 00000000..c1658008 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.error_py3 +name: error_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.error_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.error_py3.Error diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponse.yml new file mode 100644 index 00000000..8056fcdb --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponse.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponse +name: ErrorResponse +fullName: azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponse +module: azure.cognitiveservices.search.visualsearch.models.error_response +summary: 'The top-level response that represents a failed request. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ErrorResponse(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: errors + description: 'Required. A list of errors that describe the reasons why + + the request failed.' + isRequired: true + types: + - [] +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponseException.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponseException.yml new file mode 100644 index 00000000..1e6893ca --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponseException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponseException +name: ErrorResponseException +fullName: azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponseException +module: azure.cognitiveservices.search.visualsearch.models.error_response +summary: 'Server responsed with exception of type: ''ErrorResponse''.' +constructor: + syntax: ErrorResponseException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponseException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponseException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponseException.args + name: args diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response.yml new file mode 100644 index 00000000..7a805c99 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.error_response +name: error_response +fullName: azure.cognitiveservices.search.visualsearch.models.error_response +classes: +- azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponse +- azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponseException diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponse.yml new file mode 100644 index 00000000..0b9c8605 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponse.yml @@ -0,0 +1,155 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponse +name: ErrorResponse +fullName: azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponse +module: azure.cognitiveservices.search.visualsearch.models.error_response_py3 +summary: 'The top-level response that represents a failed request. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ErrorResponse(*, errors, **kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: errors + description: 'Required. A list of errors that describe the reasons why + + the request failed.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: errors + isRequired: true +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponseException.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponseException.yml new file mode 100644 index 00000000..5db5a516 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponseException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponseException +name: ErrorResponseException +fullName: azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponseException +module: azure.cognitiveservices.search.visualsearch.models.error_response_py3 +summary: 'Server responsed with exception of type: ''ErrorResponse''.' +constructor: + syntax: ErrorResponseException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponseException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponseException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponseException.args + name: args diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response_py3.yml new file mode 100644 index 00000000..2aabf310 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.error_response_py3.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.error_response_py3 +name: error_response_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.error_response_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponse +- azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponseException diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.filters.Filters.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.filters.Filters.yml new file mode 100644 index 00000000..a794f304 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.filters.Filters.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.filters.Filters +name: Filters +fullName: azure.cognitiveservices.search.visualsearch.models.filters.Filters +module: azure.cognitiveservices.search.visualsearch.models.filters +summary: 'A key-value object consisting of filters that may be specified to limit + the + + results returned by the API. Current available filters: site.' +constructor: + syntax: Filters(**kwargs) + parameters: + - name: site + description: 'The URL of the site to return similar images and similar + + products from. (e.g., "www.bing.com", "bing.com").' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.filters.Filters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.filters.Filters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.filters.Filters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.filters.Filters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.filters.Filters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.filters.Filters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.filters.Filters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.filters.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.filters.yml new file mode 100644 index 00000000..f1f5e5be --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.filters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.filters +name: filters +fullName: azure.cognitiveservices.search.visualsearch.models.filters +classes: +- azure.cognitiveservices.search.visualsearch.models.filters.Filters diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.filters_py3.Filters.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.filters_py3.Filters.yml new file mode 100644 index 00000000..e6fb1551 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.filters_py3.Filters.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.filters_py3.Filters +name: Filters +fullName: azure.cognitiveservices.search.visualsearch.models.filters_py3.Filters +module: azure.cognitiveservices.search.visualsearch.models.filters_py3 +summary: 'A key-value object consisting of filters that may be specified to limit + the + + results returned by the API. Current available filters: site.' +constructor: + syntax: 'Filters(*, site: str = None, **kwargs)' + parameters: + - name: site + description: 'The URL of the site to return similar images and similar + + products from. (e.g., "www.bing.com", "bing.com").' + isRequired: true + types: + - + keywordOnlyParameters: + - name: site + isRequired: true +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.filters_py3.Filters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.filters_py3.Filters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.filters_py3.Filters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.filters_py3.Filters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.filters_py3.Filters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.filters_py3.Filters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.filters_py3.Filters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.filters_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.filters_py3.yml new file mode 100644 index 00000000..1886db18 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.filters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.filters_py3 +name: filters_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.filters_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.filters_py3.Filters diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.identifiable.Identifiable.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.identifiable.Identifiable.yml new file mode 100644 index 00000000..252d2246 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.identifiable.Identifiable.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.identifiable.Identifiable +name: Identifiable +fullName: azure.cognitiveservices.search.visualsearch.models.identifiable.Identifiable +module: azure.cognitiveservices.search.visualsearch.models.identifiable +summary: 'Defines the identity of a resource. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Response + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Identifiable(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.identifiable.Identifiable.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.identifiable.Identifiable.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.identifiable.Identifiable.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.identifiable.Identifiable.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.identifiable.Identifiable.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.identifiable.Identifiable.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.identifiable.Identifiable.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.identifiable.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.identifiable.yml new file mode 100644 index 00000000..1712e03d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.identifiable.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.identifiable +name: identifiable +fullName: azure.cognitiveservices.search.visualsearch.models.identifiable +classes: +- azure.cognitiveservices.search.visualsearch.models.identifiable.Identifiable diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.identifiable_py3.Identifiable.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.identifiable_py3.Identifiable.yml new file mode 100644 index 00000000..bc6b196e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.identifiable_py3.Identifiable.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.identifiable_py3.Identifiable +name: Identifiable +fullName: azure.cognitiveservices.search.visualsearch.models.identifiable_py3.Identifiable +module: azure.cognitiveservices.search.visualsearch.models.identifiable_py3 +summary: 'Defines the identity of a resource. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Response + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Identifiable(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.identifiable_py3.Identifiable.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.identifiable_py3.Identifiable.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.identifiable_py3.Identifiable.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.identifiable_py3.Identifiable.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.identifiable_py3.Identifiable.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.identifiable_py3.Identifiable.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.identifiable_py3.Identifiable.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.identifiable_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.identifiable_py3.yml new file mode 100644 index 00000000..aeae9acc --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.identifiable_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.identifiable_py3 +name: identifiable_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.identifiable_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.identifiable_py3.Identifiable diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_action.ImageAction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_action.ImageAction.yml new file mode 100644 index 00000000..ccdd8cff --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_action.ImageAction.yml @@ -0,0 +1,220 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.image_action.ImageAction +name: ImageAction +fullName: azure.cognitiveservices.search.visualsearch.models.image_action.ImageAction +module: azure.cognitiveservices.search.visualsearch.models.image_action +summary: 'Defines an image action. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: ImageEntityAction, ImageModuleAction, ImageRecipesAction, + + ImageRelatedSearchesAction, ImageShoppingSourcesAction + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageAction(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: The result produced in the action. + name: result + types: + - [] +- description: A display name for the action. + name: display_name + types: + - +- description: 'A Boolean representing whether this result is the top + + action.' + name: is_top_action + types: + - +- description: 'Use this URL to get additional data to determine how to + + take the appropriate action. For example, the serviceUrl might return JSON + + along with an image URL.' + name: service_url + types: + - +- description: A string representing the type of action. + name: action_type + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.image_action.ImageAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_action.ImageAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_action.ImageAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.image_action.ImageAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_action.ImageAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.image_action.ImageAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_action.ImageAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_action.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_action.yml new file mode 100644 index 00000000..7d5711a7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_action.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.image_action +name: image_action +fullName: azure.cognitiveservices.search.visualsearch.models.image_action +classes: +- azure.cognitiveservices.search.visualsearch.models.image_action.ImageAction diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_action_py3.ImageAction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_action_py3.ImageAction.yml new file mode 100644 index 00000000..8816bb9d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_action_py3.ImageAction.yml @@ -0,0 +1,220 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.image_action_py3.ImageAction +name: ImageAction +fullName: azure.cognitiveservices.search.visualsearch.models.image_action_py3.ImageAction +module: azure.cognitiveservices.search.visualsearch.models.image_action_py3 +summary: 'Defines an image action. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: ImageEntityAction, ImageModuleAction, ImageRecipesAction, + + ImageRelatedSearchesAction, ImageShoppingSourcesAction + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageAction(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: The result produced in the action. + name: result + types: + - [] +- description: A display name for the action. + name: display_name + types: + - +- description: 'A Boolean representing whether this result is the top + + action.' + name: is_top_action + types: + - +- description: 'Use this URL to get additional data to determine how to + + take the appropriate action. For example, the serviceUrl might return JSON + + along with an image URL.' + name: service_url + types: + - +- description: A string representing the type of action. + name: action_type + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.image_action_py3.ImageAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_action_py3.ImageAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_action_py3.ImageAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.image_action_py3.ImageAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_action_py3.ImageAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.image_action_py3.ImageAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_action_py3.ImageAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_action_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_action_py3.yml new file mode 100644 index 00000000..10f677c7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_action_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.image_action_py3 +name: image_action_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.image_action_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.image_action_py3.ImageAction diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_entity_action.ImageEntityAction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_entity_action.ImageEntityAction.yml new file mode 100644 index 00000000..144e480b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_entity_action.ImageEntityAction.yml @@ -0,0 +1,213 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.image_entity_action.ImageEntityAction +name: ImageEntityAction +fullName: azure.cognitiveservices.search.visualsearch.models.image_entity_action.ImageEntityAction +module: azure.cognitiveservices.search.visualsearch.models.image_entity_action +summary: 'Defines an entity action. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageEntityAction(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: The result produced in the action. + name: result + types: + - [] +- description: A display name for the action. + name: display_name + types: + - +- description: 'A Boolean representing whether this result is the top + + action.' + name: is_top_action + types: + - +- description: 'Use this URL to get additional data to determine how to + + take the appropriate action. For example, the serviceUrl might return JSON + + along with an image URL.' + name: service_url + types: + - +- description: A string representing the type of action. + name: action_type + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.image_entity_action.ImageEntityAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_entity_action.ImageEntityAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_entity_action.ImageEntityAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.image_entity_action.ImageEntityAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_entity_action.ImageEntityAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.image_entity_action.ImageEntityAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_entity_action.ImageEntityAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_entity_action.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_entity_action.yml new file mode 100644 index 00000000..5c5e5208 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_entity_action.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.image_entity_action +name: image_entity_action +fullName: azure.cognitiveservices.search.visualsearch.models.image_entity_action +classes: +- azure.cognitiveservices.search.visualsearch.models.image_entity_action.ImageEntityAction diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3.ImageEntityAction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3.ImageEntityAction.yml new file mode 100644 index 00000000..58bc0a24 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3.ImageEntityAction.yml @@ -0,0 +1,213 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3.ImageEntityAction +name: ImageEntityAction +fullName: azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3.ImageEntityAction +module: azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3 +summary: 'Defines an entity action. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageEntityAction(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: The result produced in the action. + name: result + types: + - [] +- description: A display name for the action. + name: display_name + types: + - +- description: 'A Boolean representing whether this result is the top + + action.' + name: is_top_action + types: + - +- description: 'Use this URL to get additional data to determine how to + + take the appropriate action. For example, the serviceUrl might return JSON + + along with an image URL.' + name: service_url + types: + - +- description: A string representing the type of action. + name: action_type + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3.ImageEntityAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3.ImageEntityAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3.ImageEntityAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3.ImageEntityAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3.ImageEntityAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3.ImageEntityAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3.ImageEntityAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3.yml new file mode 100644 index 00000000..99ca45e0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3 +name: image_entity_action_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3.ImageEntityAction diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_info.ImageInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_info.ImageInfo.yml new file mode 100644 index 00000000..d5a9c3c0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_info.ImageInfo.yml @@ -0,0 +1,162 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.image_info.ImageInfo +name: ImageInfo +fullName: azure.cognitiveservices.search.visualsearch.models.image_info.ImageInfo +module: azure.cognitiveservices.search.visualsearch.models.image_info +summary: 'A JSON object that identities the image to get insights of . It also + + includes the optional crop area that you use to identify the region of + + interest in the image.' +constructor: + syntax: ImageInfo(**kwargs) + parameters: + - name: image_insights_token + description: 'An image insights token. To get the insights + + token, call one of the Image Search APIs (for example, /images/search). In + + the search results, the + + [Image](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#image) + + object''s + + [imageInsightsToken](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#image-imageinsightstoken) + + field contains the token. The imageInsightsToken and url fields mutually + + exclusive; do not specify both. Do not specify an insights token if the + + request includes the image form data.' + isRequired: true + types: + - + - name: url + description: 'The URL of the input image. The imageInsightsToken and url + + fields are mutually exclusive; do not specify both. Do not specify the URL + + if the request includes the image form data.' + isRequired: true + types: + - + - name: crop_area + description: 'A JSON object consisting of coordinates specifying the + + four corners of a cropped rectangle within the input image. Use the crop + + area to identify the region of interest in the image. You can apply the + + crop area to the images specified using the imageInsightsToken or url + + fields, or an image binary specified in an image form data.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.image_info.ImageInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_info.ImageInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_info.ImageInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.image_info.ImageInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_info.ImageInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.image_info.ImageInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_info.ImageInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_info.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_info.yml new file mode 100644 index 00000000..ce6fe092 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.image_info +name: image_info +fullName: azure.cognitiveservices.search.visualsearch.models.image_info +classes: +- azure.cognitiveservices.search.visualsearch.models.image_info.ImageInfo diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_info_py3.ImageInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_info_py3.ImageInfo.yml new file mode 100644 index 00000000..a39956e1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_info_py3.ImageInfo.yml @@ -0,0 +1,170 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.image_info_py3.ImageInfo +name: ImageInfo +fullName: azure.cognitiveservices.search.visualsearch.models.image_info_py3.ImageInfo +module: azure.cognitiveservices.search.visualsearch.models.image_info_py3 +summary: 'A JSON object that identities the image to get insights of . It also + + includes the optional crop area that you use to identify the region of + + interest in the image.' +constructor: + syntax: 'ImageInfo(*, image_insights_token: str = None, url: str = None, crop_area=None, + **kwargs)' + parameters: + - name: image_insights_token + description: 'An image insights token. To get the insights + + token, call one of the Image Search APIs (for example, /images/search). In + + the search results, the + + [Image](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#image) + + object''s + + [imageInsightsToken](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-images-api-v7-reference#image-imageinsightstoken) + + field contains the token. The imageInsightsToken and url fields mutually + + exclusive; do not specify both. Do not specify an insights token if the + + request includes the image form data.' + isRequired: true + types: + - + - name: url + description: 'The URL of the input image. The imageInsightsToken and url + + fields are mutually exclusive; do not specify both. Do not specify the URL + + if the request includes the image form data.' + isRequired: true + types: + - + - name: crop_area + description: 'A JSON object consisting of coordinates specifying the + + four corners of a cropped rectangle within the input image. Use the crop + + area to identify the region of interest in the image. You can apply the + + crop area to the images specified using the imageInsightsToken or url + + fields, or an image binary specified in an image form data.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: image_insights_token + isRequired: true + - name: url + isRequired: true + - name: crop_area + isRequired: true +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.image_info_py3.ImageInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_info_py3.ImageInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_info_py3.ImageInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.image_info_py3.ImageInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_info_py3.ImageInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.image_info_py3.ImageInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_info_py3.ImageInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_info_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_info_py3.yml new file mode 100644 index 00000000..36b45441 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.image_info_py3 +name: image_info_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.image_info_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.image_info_py3.ImageInfo diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_knowledge.ImageKnowledge.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_knowledge.ImageKnowledge.yml new file mode 100644 index 00000000..86ae1ad7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_knowledge.ImageKnowledge.yml @@ -0,0 +1,153 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.image_knowledge.ImageKnowledge +name: ImageKnowledge +fullName: azure.cognitiveservices.search.visualsearch.models.image_knowledge.ImageKnowledge +module: azure.cognitiveservices.search.visualsearch.models.image_knowledge +summary: 'Defines a visual search API response. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageKnowledge(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: A list of visual search tags. + name: tags + types: + - [] +- description: Image object containing metadata about the requested image. + name: image + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.image_knowledge.ImageKnowledge.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_knowledge.ImageKnowledge.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_knowledge.ImageKnowledge.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.image_knowledge.ImageKnowledge.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_knowledge.ImageKnowledge.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.image_knowledge.ImageKnowledge.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_knowledge.ImageKnowledge.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_knowledge.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_knowledge.yml new file mode 100644 index 00000000..b2157622 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_knowledge.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.image_knowledge +name: image_knowledge +fullName: azure.cognitiveservices.search.visualsearch.models.image_knowledge +classes: +- azure.cognitiveservices.search.visualsearch.models.image_knowledge.ImageKnowledge diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3.ImageKnowledge.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3.ImageKnowledge.yml new file mode 100644 index 00000000..b5664581 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3.ImageKnowledge.yml @@ -0,0 +1,153 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3.ImageKnowledge +name: ImageKnowledge +fullName: azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3.ImageKnowledge +module: azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3 +summary: 'Defines a visual search API response. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageKnowledge(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: A list of visual search tags. + name: tags + types: + - [] +- description: Image object containing metadata about the requested image. + name: image + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3.ImageKnowledge.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3.ImageKnowledge.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3.ImageKnowledge.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3.ImageKnowledge.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3.ImageKnowledge.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3.ImageKnowledge.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3.ImageKnowledge.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3.yml new file mode 100644 index 00000000..7692fd5c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3 +name: image_knowledge_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3.ImageKnowledge diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_module_action.ImageModuleAction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_module_action.ImageModuleAction.yml new file mode 100644 index 00000000..db050263 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_module_action.ImageModuleAction.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.image_module_action.ImageModuleAction +name: ImageModuleAction +fullName: azure.cognitiveservices.search.visualsearch.models.image_module_action.ImageModuleAction +module: azure.cognitiveservices.search.visualsearch.models.image_module_action +summary: 'Defines an image list action. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageModuleAction(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: The result produced in the action. + name: result + types: + - [] +- description: A display name for the action. + name: display_name + types: + - +- description: 'A Boolean representing whether this result is the top + + action.' + name: is_top_action + types: + - +- description: 'Use this URL to get additional data to determine how to + + take the appropriate action. For example, the serviceUrl might return JSON + + along with an image URL.' + name: service_url + types: + - +- description: A string representing the type of action. + name: action_type + types: + - +- description: A list of images. + name: data + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.image_module_action.ImageModuleAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_module_action.ImageModuleAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_module_action.ImageModuleAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.image_module_action.ImageModuleAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_module_action.ImageModuleAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.image_module_action.ImageModuleAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_module_action.ImageModuleAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_module_action.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_module_action.yml new file mode 100644 index 00000000..91a3acab --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_module_action.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.image_module_action +name: image_module_action +fullName: azure.cognitiveservices.search.visualsearch.models.image_module_action +classes: +- azure.cognitiveservices.search.visualsearch.models.image_module_action.ImageModuleAction diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_module_action_py3.ImageModuleAction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_module_action_py3.ImageModuleAction.yml new file mode 100644 index 00000000..85b9f759 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_module_action_py3.ImageModuleAction.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.image_module_action_py3.ImageModuleAction +name: ImageModuleAction +fullName: azure.cognitiveservices.search.visualsearch.models.image_module_action_py3.ImageModuleAction +module: azure.cognitiveservices.search.visualsearch.models.image_module_action_py3 +summary: 'Defines an image list action. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageModuleAction(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: The result produced in the action. + name: result + types: + - [] +- description: A display name for the action. + name: display_name + types: + - +- description: 'A Boolean representing whether this result is the top + + action.' + name: is_top_action + types: + - +- description: 'Use this URL to get additional data to determine how to + + take the appropriate action. For example, the serviceUrl might return JSON + + along with an image URL.' + name: service_url + types: + - +- description: A string representing the type of action. + name: action_type + types: + - +- description: A list of images. + name: data + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.image_module_action_py3.ImageModuleAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_module_action_py3.ImageModuleAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_module_action_py3.ImageModuleAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.image_module_action_py3.ImageModuleAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_module_action_py3.ImageModuleAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.image_module_action_py3.ImageModuleAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_module_action_py3.ImageModuleAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_module_action_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_module_action_py3.yml new file mode 100644 index 00000000..c6489587 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_module_action_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.image_module_action_py3 +name: image_module_action_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.image_module_action_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.image_module_action_py3.ImageModuleAction diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_object.ImageObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_object.ImageObject.yml new file mode 100644 index 00000000..e5708fbe --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_object.ImageObject.yml @@ -0,0 +1,267 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.image_object.ImageObject +name: ImageObject +fullName: azure.cognitiveservices.search.visualsearch.models.image_object.ImageObject +module: azure.cognitiveservices.search.visualsearch.models.image_object +summary: 'Defines an image. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageObject(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: 'Original URL to retrieve the source (file) for the + + media object (e.g., the source URL for the image).' + name: content_url + types: + - +- description: URL of the page that hosts the media object. + name: host_page_url + types: + - +- description: 'Size of the media object content. Use format "value + + unit" (e.g., "1024 B").' + name: content_size + types: + - +- description: Encoding format (e.g., png, gif, jpeg, etc). + name: encoding_format + types: + - +- description: 'Display URL of the page that hosts the media + + object.' + name: host_page_display_url + types: + - +- description: The width of the media object, in pixels. + name: width + types: + - +- description: The height of the media object, in pixels. + name: height + types: + - +- description: The URL to a thumbnail of the image. + name: thumbnail + types: + - +- description: 'The token that you use in a subsequent call to + + Visual Search API to get additional information about the image. For + + information about using this token, see the imageInsightsToken field + + inside the knowledgeRequest request parameter.' + name: image_insights_token + types: + - +- description: 'A count of the number of websites where you can + + shop or perform other actions related to the image. For example, if the + + image is of an apple pie, this object includes a count of the number of + + websites where you can buy an apple pie. To indicate the number of offers + + in your UX, include badging such as a shopping cart icon that contains the + + count. When the user clicks on the icon, use imageInsightsToken in a + + subsequent Visual Search API call to get the list of shopping websites.' + name: insights_metadata + types: + - +- description: Unique Id for the image. + name: image_id + types: + - +- description: 'A three-byte hexadecimal number that represents the + + color that dominates the image. Use the color as the temporary background + + in your client until the image is loaded.' + name: accent_color + types: + - +- description: For internal use only. + name: visual_words + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.image_object.ImageObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_object.ImageObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_object.ImageObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.image_object.ImageObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_object.ImageObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.image_object.ImageObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_object.ImageObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_object.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_object.yml new file mode 100644 index 00000000..8bcd6123 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_object.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.image_object +name: image_object +fullName: azure.cognitiveservices.search.visualsearch.models.image_object +classes: +- azure.cognitiveservices.search.visualsearch.models.image_object.ImageObject diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_object_py3.ImageObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_object_py3.ImageObject.yml new file mode 100644 index 00000000..e6ceb2d3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_object_py3.ImageObject.yml @@ -0,0 +1,267 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.image_object_py3.ImageObject +name: ImageObject +fullName: azure.cognitiveservices.search.visualsearch.models.image_object_py3.ImageObject +module: azure.cognitiveservices.search.visualsearch.models.image_object_py3 +summary: 'Defines an image. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageObject(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: 'Original URL to retrieve the source (file) for the + + media object (e.g., the source URL for the image).' + name: content_url + types: + - +- description: URL of the page that hosts the media object. + name: host_page_url + types: + - +- description: 'Size of the media object content. Use format "value + + unit" (e.g., "1024 B").' + name: content_size + types: + - +- description: Encoding format (e.g., png, gif, jpeg, etc). + name: encoding_format + types: + - +- description: 'Display URL of the page that hosts the media + + object.' + name: host_page_display_url + types: + - +- description: The width of the media object, in pixels. + name: width + types: + - +- description: The height of the media object, in pixels. + name: height + types: + - +- description: The URL to a thumbnail of the image. + name: thumbnail + types: + - +- description: 'The token that you use in a subsequent call to + + Visual Search API to get additional information about the image. For + + information about using this token, see the imageInsightsToken field + + inside the knowledgeRequest request parameter.' + name: image_insights_token + types: + - +- description: 'A count of the number of websites where you can + + shop or perform other actions related to the image. For example, if the + + image is of an apple pie, this object includes a count of the number of + + websites where you can buy an apple pie. To indicate the number of offers + + in your UX, include badging such as a shopping cart icon that contains the + + count. When the user clicks on the icon, use imageInsightsToken in a + + subsequent Visual Search API call to get the list of shopping websites.' + name: insights_metadata + types: + - +- description: Unique Id for the image. + name: image_id + types: + - +- description: 'A three-byte hexadecimal number that represents the + + color that dominates the image. Use the color as the temporary background + + in your client until the image is loaded.' + name: accent_color + types: + - +- description: For internal use only. + name: visual_words + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.image_object_py3.ImageObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_object_py3.ImageObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_object_py3.ImageObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.image_object_py3.ImageObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_object_py3.ImageObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.image_object_py3.ImageObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_object_py3.ImageObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_object_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_object_py3.yml new file mode 100644 index 00000000..dfe9356e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_object_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.image_object_py3 +name: image_object_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.image_object_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.image_object_py3.ImageObject diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_recipes_action.ImageRecipesAction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_recipes_action.ImageRecipesAction.yml new file mode 100644 index 00000000..27c9735e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_recipes_action.ImageRecipesAction.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.image_recipes_action.ImageRecipesAction +name: ImageRecipesAction +fullName: azure.cognitiveservices.search.visualsearch.models.image_recipes_action.ImageRecipesAction +module: azure.cognitiveservices.search.visualsearch.models.image_recipes_action +summary: 'Defines an recipe action. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageRecipesAction(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: The result produced in the action. + name: result + types: + - [] +- description: A display name for the action. + name: display_name + types: + - +- description: 'A Boolean representing whether this result is the top + + action.' + name: is_top_action + types: + - +- description: 'Use this URL to get additional data to determine how to + + take the appropriate action. For example, the serviceUrl might return JSON + + along with an image URL.' + name: service_url + types: + - +- description: A string representing the type of action. + name: action_type + types: + - +- description: A list of recipes related to the image. + name: data + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.image_recipes_action.ImageRecipesAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_recipes_action.ImageRecipesAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_recipes_action.ImageRecipesAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.image_recipes_action.ImageRecipesAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_recipes_action.ImageRecipesAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.image_recipes_action.ImageRecipesAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_recipes_action.ImageRecipesAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_recipes_action.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_recipes_action.yml new file mode 100644 index 00000000..7b8d5313 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_recipes_action.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.image_recipes_action +name: image_recipes_action +fullName: azure.cognitiveservices.search.visualsearch.models.image_recipes_action +classes: +- azure.cognitiveservices.search.visualsearch.models.image_recipes_action.ImageRecipesAction diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3.ImageRecipesAction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3.ImageRecipesAction.yml new file mode 100644 index 00000000..aeffa187 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3.ImageRecipesAction.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3.ImageRecipesAction +name: ImageRecipesAction +fullName: azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3.ImageRecipesAction +module: azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3 +summary: 'Defines an recipe action. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageRecipesAction(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: The result produced in the action. + name: result + types: + - [] +- description: A display name for the action. + name: display_name + types: + - +- description: 'A Boolean representing whether this result is the top + + action.' + name: is_top_action + types: + - +- description: 'Use this URL to get additional data to determine how to + + take the appropriate action. For example, the serviceUrl might return JSON + + along with an image URL.' + name: service_url + types: + - +- description: A string representing the type of action. + name: action_type + types: + - +- description: A list of recipes related to the image. + name: data + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3.ImageRecipesAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3.ImageRecipesAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3.ImageRecipesAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3.ImageRecipesAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3.ImageRecipesAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3.ImageRecipesAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3.ImageRecipesAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3.yml new file mode 100644 index 00000000..ca8033cf --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3 +name: image_recipes_action_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3.ImageRecipesAction diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_related_searches_action.ImageRelatedSearchesAction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_related_searches_action.ImageRelatedSearchesAction.yml new file mode 100644 index 00000000..1d1e3588 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_related_searches_action.ImageRelatedSearchesAction.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action.ImageRelatedSearchesAction +name: ImageRelatedSearchesAction +fullName: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action.ImageRelatedSearchesAction +module: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action +summary: 'Defines an related search action. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageRelatedSearchesAction(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: The result produced in the action. + name: result + types: + - [] +- description: A display name for the action. + name: display_name + types: + - +- description: 'A Boolean representing whether this result is the top + + action.' + name: is_top_action + types: + - +- description: 'Use this URL to get additional data to determine how to + + take the appropriate action. For example, the serviceUrl might return JSON + + along with an image URL.' + name: service_url + types: + - +- description: A string representing the type of action. + name: action_type + types: + - +- description: A list of queries related to the image. + name: data + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action.ImageRelatedSearchesAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action.ImageRelatedSearchesAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action.ImageRelatedSearchesAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action.ImageRelatedSearchesAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action.ImageRelatedSearchesAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action.ImageRelatedSearchesAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action.ImageRelatedSearchesAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_related_searches_action.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_related_searches_action.yml new file mode 100644 index 00000000..98cfa119 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_related_searches_action.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action +name: image_related_searches_action +fullName: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action +classes: +- azure.cognitiveservices.search.visualsearch.models.image_related_searches_action.ImageRelatedSearchesAction diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3.ImageRelatedSearchesAction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3.ImageRelatedSearchesAction.yml new file mode 100644 index 00000000..528345aa --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3.ImageRelatedSearchesAction.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3.ImageRelatedSearchesAction +name: ImageRelatedSearchesAction +fullName: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3.ImageRelatedSearchesAction +module: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3 +summary: 'Defines an related search action. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageRelatedSearchesAction(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: The result produced in the action. + name: result + types: + - [] +- description: A display name for the action. + name: display_name + types: + - +- description: 'A Boolean representing whether this result is the top + + action.' + name: is_top_action + types: + - +- description: 'Use this URL to get additional data to determine how to + + take the appropriate action. For example, the serviceUrl might return JSON + + along with an image URL.' + name: service_url + types: + - +- description: A string representing the type of action. + name: action_type + types: + - +- description: A list of queries related to the image. + name: data + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3.ImageRelatedSearchesAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3.ImageRelatedSearchesAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3.ImageRelatedSearchesAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3.ImageRelatedSearchesAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3.ImageRelatedSearchesAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3.ImageRelatedSearchesAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3.ImageRelatedSearchesAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3.yml new file mode 100644 index 00000000..e0f35ecf --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3 +name: image_related_searches_action_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3.ImageRelatedSearchesAction diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action.ImageShoppingSourcesAction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action.ImageShoppingSourcesAction.yml new file mode 100644 index 00000000..9d2c4bde --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action.ImageShoppingSourcesAction.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action.ImageShoppingSourcesAction +name: ImageShoppingSourcesAction +fullName: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action.ImageShoppingSourcesAction +module: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action +summary: 'Defines a shopping sources action. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageShoppingSourcesAction(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: The result produced in the action. + name: result + types: + - [] +- description: A display name for the action. + name: display_name + types: + - +- description: 'A Boolean representing whether this result is the top + + action.' + name: is_top_action + types: + - +- description: 'Use this URL to get additional data to determine how to + + take the appropriate action. For example, the serviceUrl might return JSON + + along with an image URL.' + name: service_url + types: + - +- description: A string representing the type of action. + name: action_type + types: + - +- description: A list of merchants that offer items related to the image. + name: data + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action.ImageShoppingSourcesAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action.ImageShoppingSourcesAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action.ImageShoppingSourcesAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action.ImageShoppingSourcesAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action.ImageShoppingSourcesAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action.ImageShoppingSourcesAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action.ImageShoppingSourcesAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action.yml new file mode 100644 index 00000000..74faf506 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action +name: image_shopping_sources_action +fullName: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action +classes: +- azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action.ImageShoppingSourcesAction diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3.ImageShoppingSourcesAction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3.ImageShoppingSourcesAction.yml new file mode 100644 index 00000000..2a05e682 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3.ImageShoppingSourcesAction.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3.ImageShoppingSourcesAction +name: ImageShoppingSourcesAction +fullName: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3.ImageShoppingSourcesAction +module: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3 +summary: 'Defines a shopping sources action. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageShoppingSourcesAction(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: The result produced in the action. + name: result + types: + - [] +- description: A display name for the action. + name: display_name + types: + - +- description: 'A Boolean representing whether this result is the top + + action.' + name: is_top_action + types: + - +- description: 'Use this URL to get additional data to determine how to + + take the appropriate action. For example, the serviceUrl might return JSON + + along with an image URL.' + name: service_url + types: + - +- description: A string representing the type of action. + name: action_type + types: + - +- description: A list of merchants that offer items related to the image. + name: data + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3.ImageShoppingSourcesAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3.ImageShoppingSourcesAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3.ImageShoppingSourcesAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3.ImageShoppingSourcesAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3.ImageShoppingSourcesAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3.ImageShoppingSourcesAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3.ImageShoppingSourcesAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3.yml new file mode 100644 index 00000000..0aad63b5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3 +name: image_shopping_sources_action_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3.ImageShoppingSourcesAction diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag.ImageTag.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag.ImageTag.yml new file mode 100644 index 00000000..81303b47 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag.ImageTag.yml @@ -0,0 +1,191 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.image_tag.ImageTag +name: ImageTag +fullName: azure.cognitiveservices.search.visualsearch.models.image_tag.ImageTag +module: azure.cognitiveservices.search.visualsearch.models.image_tag +summary: 'A visual search tag. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageTag(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: 'Display name for this tag. For the default tag, the + + display name is empty.' + name: display_name + types: + - +- description: 'The bounding box for this tag. For the default tag, + + there is no bounding box.' + name: bounding_box + types: + - +- description: 'Actions within this tag. The order of the items denotes the + + default ranking order of these actions, with the first action being the + + most likely user intent.' + name: actions + types: + - [] +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag.ImageTag.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag.ImageTag.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag.ImageTag.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag.ImageTag.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag.ImageTag.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag.ImageTag.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag.ImageTag.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag.yml new file mode 100644 index 00000000..feba8b62 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.image_tag +name: image_tag +fullName: azure.cognitiveservices.search.visualsearch.models.image_tag +classes: +- azure.cognitiveservices.search.visualsearch.models.image_tag.ImageTag diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_py3.ImageTag.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_py3.ImageTag.yml new file mode 100644 index 00000000..a55284f3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_py3.ImageTag.yml @@ -0,0 +1,191 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.image_tag_py3.ImageTag +name: ImageTag +fullName: azure.cognitiveservices.search.visualsearch.models.image_tag_py3.ImageTag +module: azure.cognitiveservices.search.visualsearch.models.image_tag_py3 +summary: 'A visual search tag. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageTag(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: 'Display name for this tag. For the default tag, the + + display name is empty.' + name: display_name + types: + - +- description: 'The bounding box for this tag. For the default tag, + + there is no bounding box.' + name: bounding_box + types: + - +- description: 'Actions within this tag. The order of the items denotes the + + default ranking order of these actions, with the first action being the + + most likely user intent.' + name: actions + types: + - [] +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag_py3.ImageTag.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag_py3.ImageTag.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag_py3.ImageTag.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag_py3.ImageTag.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag_py3.ImageTag.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag_py3.ImageTag.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag_py3.ImageTag.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_py3.yml new file mode 100644 index 00000000..c5adc1d9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.image_tag_py3 +name: image_tag_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.image_tag_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.image_tag_py3.ImageTag diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_region.ImageTagRegion.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_region.ImageTagRegion.yml new file mode 100644 index 00000000..04a3850f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_region.ImageTagRegion.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.image_tag_region.ImageTagRegion +name: ImageTagRegion +fullName: azure.cognitiveservices.search.visualsearch.models.image_tag_region.ImageTagRegion +module: azure.cognitiveservices.search.visualsearch.models.image_tag_region +summary: 'Defines an image region relevant to the ImageTag. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageTagRegion(**kwargs) + parameters: + - name: query_rectangle + description: 'Required. A rectangle that outlines the area of + + interest for this tag.' + isRequired: true + types: + - + - name: display_rectangle + description: 'Required. A recommended rectangle to show to the + + user.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag_region.ImageTagRegion.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag_region.ImageTagRegion.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag_region.ImageTagRegion.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag_region.ImageTagRegion.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag_region.ImageTagRegion.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag_region.ImageTagRegion.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag_region.ImageTagRegion.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_region.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_region.yml new file mode 100644 index 00000000..bc51b51b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_region.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.image_tag_region +name: image_tag_region +fullName: azure.cognitiveservices.search.visualsearch.models.image_tag_region +classes: +- azure.cognitiveservices.search.visualsearch.models.image_tag_region.ImageTagRegion diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3.ImageTagRegion.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3.ImageTagRegion.yml new file mode 100644 index 00000000..442a5c06 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3.ImageTagRegion.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3.ImageTagRegion +name: ImageTagRegion +fullName: azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3.ImageTagRegion +module: azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3 +summary: 'Defines an image region relevant to the ImageTag. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageTagRegion(*, query_rectangle, display_rectangle, **kwargs) + parameters: + - name: query_rectangle + description: 'Required. A rectangle that outlines the area of + + interest for this tag.' + isRequired: true + types: + - + - name: display_rectangle + description: 'Required. A recommended rectangle to show to the + + user.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: query_rectangle + isRequired: true + - name: display_rectangle + isRequired: true +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3.ImageTagRegion.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3.ImageTagRegion.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3.ImageTagRegion.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3.ImageTagRegion.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3.ImageTagRegion.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3.ImageTagRegion.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3.ImageTagRegion.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3.yml new file mode 100644 index 00000000..5cb9c152 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3 +name: image_tag_region_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3.ImageTagRegion diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_image_metadata.ImagesImageMetadata.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_image_metadata.ImagesImageMetadata.yml new file mode 100644 index 00000000..cc08ec72 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_image_metadata.ImagesImageMetadata.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.images_image_metadata.ImagesImageMetadata +name: ImagesImageMetadata +fullName: azure.cognitiveservices.search.visualsearch.models.images_image_metadata.ImagesImageMetadata +module: azure.cognitiveservices.search.visualsearch.models.images_image_metadata +summary: 'Defines a count of the number of websites where you can shop or perform + + other actions related to the image. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: ImagesImageMetadata(**kwargs) +variables: +- description: 'The number of websites that sell the + + products seen in the image.' + name: shopping_sources_count + types: + - +- description: 'The number of websites that offer recipes of + + the food seen in the image.' + name: recipe_sources_count + types: + - +- description: 'A summary of the online offers of products found in + + the image. For example, if the image is of a dress, the offer might + + identify the lowest price and the number of offers found. Only visually + + similar products insights include this field. The offer includes the + + following fields: Name, AggregateRating, OfferCount, and LowPrice.' + name: aggregate_offer + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.images_image_metadata.ImagesImageMetadata.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.images_image_metadata.ImagesImageMetadata.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.images_image_metadata.ImagesImageMetadata.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.images_image_metadata.ImagesImageMetadata.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.images_image_metadata.ImagesImageMetadata.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.images_image_metadata.ImagesImageMetadata.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.images_image_metadata.ImagesImageMetadata.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_image_metadata.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_image_metadata.yml new file mode 100644 index 00000000..e5936e2a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_image_metadata.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.images_image_metadata +name: images_image_metadata +fullName: azure.cognitiveservices.search.visualsearch.models.images_image_metadata +classes: +- azure.cognitiveservices.search.visualsearch.models.images_image_metadata.ImagesImageMetadata diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3.ImagesImageMetadata.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3.ImagesImageMetadata.yml new file mode 100644 index 00000000..502cb7d7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3.ImagesImageMetadata.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3.ImagesImageMetadata +name: ImagesImageMetadata +fullName: azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3.ImagesImageMetadata +module: azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3 +summary: 'Defines a count of the number of websites where you can shop or perform + + other actions related to the image. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: ImagesImageMetadata(**kwargs) +variables: +- description: 'The number of websites that sell the + + products seen in the image.' + name: shopping_sources_count + types: + - +- description: 'The number of websites that offer recipes of + + the food seen in the image.' + name: recipe_sources_count + types: + - +- description: 'A summary of the online offers of products found in + + the image. For example, if the image is of a dress, the offer might + + identify the lowest price and the number of offers found. Only visually + + similar products insights include this field. The offer includes the + + following fields: Name, AggregateRating, OfferCount, and LowPrice.' + name: aggregate_offer + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3.ImagesImageMetadata.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3.ImagesImageMetadata.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3.ImagesImageMetadata.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3.ImagesImageMetadata.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3.ImagesImageMetadata.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3.ImagesImageMetadata.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3.ImagesImageMetadata.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3.yml new file mode 100644 index 00000000..8c5f8741 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3 +name: images_image_metadata_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3.ImagesImageMetadata diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_module.ImagesModule.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_module.ImagesModule.yml new file mode 100644 index 00000000..8c2bae8f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_module.ImagesModule.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.images_module.ImagesModule +name: ImagesModule +fullName: azure.cognitiveservices.search.visualsearch.models.images_module.ImagesModule +module: azure.cognitiveservices.search.visualsearch.models.images_module +summary: 'Defines a list of images. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: ImagesModule(**kwargs) +variables: +- description: A list of images. + name: value + types: + - [] +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.images_module.ImagesModule.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.images_module.ImagesModule.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.images_module.ImagesModule.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.images_module.ImagesModule.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.images_module.ImagesModule.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.images_module.ImagesModule.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.images_module.ImagesModule.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_module.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_module.yml new file mode 100644 index 00000000..494162be --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_module.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.images_module +name: images_module +fullName: azure.cognitiveservices.search.visualsearch.models.images_module +classes: +- azure.cognitiveservices.search.visualsearch.models.images_module.ImagesModule diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_module_py3.ImagesModule.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_module_py3.ImagesModule.yml new file mode 100644 index 00000000..6dd35f27 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_module_py3.ImagesModule.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.images_module_py3.ImagesModule +name: ImagesModule +fullName: azure.cognitiveservices.search.visualsearch.models.images_module_py3.ImagesModule +module: azure.cognitiveservices.search.visualsearch.models.images_module_py3 +summary: 'Defines a list of images. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: ImagesModule(**kwargs) +variables: +- description: A list of images. + name: value + types: + - [] +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.images_module_py3.ImagesModule.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.images_module_py3.ImagesModule.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.images_module_py3.ImagesModule.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.images_module_py3.ImagesModule.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.images_module_py3.ImagesModule.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.images_module_py3.ImagesModule.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.images_module_py3.ImagesModule.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_module_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_module_py3.yml new file mode 100644 index 00000000..74bc28ed --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.images_module_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.images_module_py3 +name: images_module_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.images_module_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.images_module_py3.ImagesModule diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.intangible.Intangible.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.intangible.Intangible.yml new file mode 100644 index 00000000..597964bc --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.intangible.Intangible.yml @@ -0,0 +1,178 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.intangible.Intangible +name: Intangible +fullName: azure.cognitiveservices.search.visualsearch.models.intangible.Intangible +module: azure.cognitiveservices.search.visualsearch.models.intangible +summary: 'A utility class that serves as the umbrella for a number of ''intangible'' + + things such as quantities, structured values, etc. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: StructuredValue + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Intangible(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.intangible.Intangible.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.intangible.Intangible.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.intangible.Intangible.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.intangible.Intangible.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.intangible.Intangible.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.intangible.Intangible.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.intangible.Intangible.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.intangible.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.intangible.yml new file mode 100644 index 00000000..d29f5636 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.intangible.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.intangible +name: intangible +fullName: azure.cognitiveservices.search.visualsearch.models.intangible +classes: +- azure.cognitiveservices.search.visualsearch.models.intangible.Intangible diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.intangible_py3.Intangible.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.intangible_py3.Intangible.yml new file mode 100644 index 00000000..bc82d035 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.intangible_py3.Intangible.yml @@ -0,0 +1,178 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.intangible_py3.Intangible +name: Intangible +fullName: azure.cognitiveservices.search.visualsearch.models.intangible_py3.Intangible +module: azure.cognitiveservices.search.visualsearch.models.intangible_py3 +summary: 'A utility class that serves as the umbrella for a number of ''intangible'' + + things such as quantities, structured values, etc. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: StructuredValue + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Intangible(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.intangible_py3.Intangible.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.intangible_py3.Intangible.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.intangible_py3.Intangible.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.intangible_py3.Intangible.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.intangible_py3.Intangible.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.intangible_py3.Intangible.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.intangible_py3.Intangible.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.intangible_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.intangible_py3.yml new file mode 100644 index 00000000..37407b1f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.intangible_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.intangible_py3 +name: intangible_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.intangible_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.intangible_py3.Intangible diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.knowledge_request.KnowledgeRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.knowledge_request.KnowledgeRequest.yml new file mode 100644 index 00000000..0e1f7226 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.knowledge_request.KnowledgeRequest.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.knowledge_request.KnowledgeRequest +name: KnowledgeRequest +fullName: azure.cognitiveservices.search.visualsearch.models.knowledge_request.KnowledgeRequest +module: azure.cognitiveservices.search.visualsearch.models.knowledge_request +summary: 'A JSON object containing information about the request, such as filters + for + + the resulting actions.' +constructor: + syntax: KnowledgeRequest(**kwargs) + parameters: + - name: filters + description: 'A key-value object consisting of filters that may be + + specified to limit the results returned by the API.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.knowledge_request.KnowledgeRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.knowledge_request.KnowledgeRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.knowledge_request.KnowledgeRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.knowledge_request.KnowledgeRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.knowledge_request.KnowledgeRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.knowledge_request.KnowledgeRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.knowledge_request.KnowledgeRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.knowledge_request.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.knowledge_request.yml new file mode 100644 index 00000000..ac7dc772 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.knowledge_request.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.knowledge_request +name: knowledge_request +fullName: azure.cognitiveservices.search.visualsearch.models.knowledge_request +classes: +- azure.cognitiveservices.search.visualsearch.models.knowledge_request.KnowledgeRequest diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.KnowledgeRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.KnowledgeRequest.yml new file mode 100644 index 00000000..113ef44d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.KnowledgeRequest.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.KnowledgeRequest +name: KnowledgeRequest +fullName: azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.KnowledgeRequest +module: azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3 +summary: 'A JSON object containing information about the request, such as filters + for + + the resulting actions.' +constructor: + syntax: KnowledgeRequest(*, filters=None, **kwargs) + parameters: + - name: filters + description: 'A key-value object consisting of filters that may be + + specified to limit the results returned by the API.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: filters + isRequired: true +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.KnowledgeRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.KnowledgeRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.KnowledgeRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.KnowledgeRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.KnowledgeRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.KnowledgeRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.KnowledgeRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.yml new file mode 100644 index 00000000..321e9346 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3 +name: knowledge_request_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.KnowledgeRequest diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.media_object.MediaObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.media_object.MediaObject.yml new file mode 100644 index 00000000..f1be946a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.media_object.MediaObject.yml @@ -0,0 +1,226 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.media_object.MediaObject +name: MediaObject +fullName: azure.cognitiveservices.search.visualsearch.models.media_object.MediaObject +module: azure.cognitiveservices.search.visualsearch.models.media_object +summary: 'Defines a media object. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: ImageObject + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: MediaObject(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: 'Original URL to retrieve the source (file) for the + + media object (e.g., the source URL for the image).' + name: content_url + types: + - +- description: URL of the page that hosts the media object. + name: host_page_url + types: + - +- description: 'Size of the media object content. Use format "value + + unit" (e.g., "1024 B").' + name: content_size + types: + - +- description: Encoding format (e.g., png, gif, jpeg, etc). + name: encoding_format + types: + - +- description: 'Display URL of the page that hosts the media + + object.' + name: host_page_display_url + types: + - +- description: The width of the media object, in pixels. + name: width + types: + - +- description: The height of the media object, in pixels. + name: height + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.media_object.MediaObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.media_object.MediaObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.media_object.MediaObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.media_object.MediaObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.media_object.MediaObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.media_object.MediaObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.media_object.MediaObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.media_object.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.media_object.yml new file mode 100644 index 00000000..7346cbef --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.media_object.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.media_object +name: media_object +fullName: azure.cognitiveservices.search.visualsearch.models.media_object +classes: +- azure.cognitiveservices.search.visualsearch.models.media_object.MediaObject diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.media_object_py3.MediaObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.media_object_py3.MediaObject.yml new file mode 100644 index 00000000..cab0c368 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.media_object_py3.MediaObject.yml @@ -0,0 +1,226 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.media_object_py3.MediaObject +name: MediaObject +fullName: azure.cognitiveservices.search.visualsearch.models.media_object_py3.MediaObject +module: azure.cognitiveservices.search.visualsearch.models.media_object_py3 +summary: 'Defines a media object. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: ImageObject + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: MediaObject(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: 'Original URL to retrieve the source (file) for the + + media object (e.g., the source URL for the image).' + name: content_url + types: + - +- description: URL of the page that hosts the media object. + name: host_page_url + types: + - +- description: 'Size of the media object content. Use format "value + + unit" (e.g., "1024 B").' + name: content_size + types: + - +- description: Encoding format (e.g., png, gif, jpeg, etc). + name: encoding_format + types: + - +- description: 'Display URL of the page that hosts the media + + object.' + name: host_page_display_url + types: + - +- description: The width of the media object, in pixels. + name: width + types: + - +- description: The height of the media object, in pixels. + name: height + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.media_object_py3.MediaObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.media_object_py3.MediaObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.media_object_py3.MediaObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.media_object_py3.MediaObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.media_object_py3.MediaObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.media_object_py3.MediaObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.media_object_py3.MediaObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.media_object_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.media_object_py3.yml new file mode 100644 index 00000000..d0dccd12 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.media_object_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.media_object_py3 +name: media_object_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.media_object_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.media_object_py3.MediaObject diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral.NormalizedQuadrilateral.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral.NormalizedQuadrilateral.yml new file mode 100644 index 00000000..d9ce4384 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral.NormalizedQuadrilateral.yml @@ -0,0 +1,197 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral.NormalizedQuadrilateral +name: NormalizedQuadrilateral +fullName: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral.NormalizedQuadrilateral +module: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral +summary: 'Defines a region of an image. The region is a convex quadrilateral defined + + by coordinates of its top left, top right, bottom left, and bottom right + + points. The coordinates are fractional values of the original image''s width + + and height in the range 0.0 through 1.0. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: NormalizedQuadrilateral(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: top_left + description: Required. The top left corner coordinate. + isRequired: true + types: + - + - name: top_right + description: Required. The top right corner coordinate. + isRequired: true + types: + - + - name: bottom_right + description: Required. The bottom right corner coordinate. + isRequired: true + types: + - + - name: bottom_left + description: Required. The bottom left corner coordinate. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral.NormalizedQuadrilateral.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral.NormalizedQuadrilateral.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral.NormalizedQuadrilateral.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral.NormalizedQuadrilateral.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral.NormalizedQuadrilateral.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral.NormalizedQuadrilateral.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral.NormalizedQuadrilateral.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral.yml new file mode 100644 index 00000000..565d3654 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral +name: normalized_quadrilateral +fullName: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral +classes: +- azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral.NormalizedQuadrilateral diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3.NormalizedQuadrilateral.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3.NormalizedQuadrilateral.yml new file mode 100644 index 00000000..b62d38b3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3.NormalizedQuadrilateral.yml @@ -0,0 +1,207 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3.NormalizedQuadrilateral +name: NormalizedQuadrilateral +fullName: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3.NormalizedQuadrilateral +module: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3 +summary: 'Defines a region of an image. The region is a convex quadrilateral defined + + by coordinates of its top left, top right, bottom left, and bottom right + + points. The coordinates are fractional values of the original image''s width + + and height in the range 0.0 through 1.0. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: NormalizedQuadrilateral(*, top_left, top_right, bottom_right, bottom_left, + **kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: top_left + description: Required. The top left corner coordinate. + isRequired: true + types: + - + - name: top_right + description: Required. The top right corner coordinate. + isRequired: true + types: + - + - name: bottom_right + description: Required. The bottom right corner coordinate. + isRequired: true + types: + - + - name: bottom_left + description: Required. The bottom left corner coordinate. + isRequired: true + types: + - + keywordOnlyParameters: + - name: top_left + isRequired: true + - name: top_right + isRequired: true + - name: bottom_right + isRequired: true + - name: bottom_left + isRequired: true +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3.NormalizedQuadrilateral.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3.NormalizedQuadrilateral.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3.NormalizedQuadrilateral.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3.NormalizedQuadrilateral.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3.NormalizedQuadrilateral.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3.NormalizedQuadrilateral.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3.NormalizedQuadrilateral.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3.yml new file mode 100644 index 00000000..b5e68b38 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3 +name: normalized_quadrilateral_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3.NormalizedQuadrilateral diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.offer.Offer.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.offer.Offer.yml new file mode 100644 index 00000000..455637ad --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.offer.Offer.yml @@ -0,0 +1,264 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.offer.Offer +name: Offer +fullName: azure.cognitiveservices.search.visualsearch.models.offer.Offer +module: azure.cognitiveservices.search.visualsearch.models.offer +summary: 'Defines a merchant''s offer. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: AggregateOffer + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Offer(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: Seller for this offer. + name: seller + types: + - +- description: The item's price. + name: price + types: + - +- description: 'The monetary currency. For example, USD. Possible + + values include: ''USD'', ''CAD'', ''GBP'', ''EUR'', ''COP'', ''JPY'', ''CNY'', + ''AUD'', + + ''INR'', ''AED'', ''AFN'', ''ALL'', ''AMD'', ''ANG'', ''AOA'', ''ARS'', ''AWG'', + ''AZN'', + + ''BAM'', ''BBD'', ''BDT'', ''BGN'', ''BHD'', ''BIF'', ''BMD'', ''BND'', ''BOB'', + ''BOV'', + + ''BRL'', ''BSD'', ''BTN'', ''BWP'', ''BYR'', ''BZD'', ''CDF'', ''CHE'', ''CHF'', + ''CHW'', + + ''CLF'', ''CLP'', ''COU'', ''CRC'', ''CUC'', ''CUP'', ''CVE'', ''CZK'', ''DJF'', + ''DKK'', + + ''DOP'', ''DZD'', ''EGP'', ''ERN'', ''ETB'', ''FJD'', ''FKP'', ''GEL'', ''GHS'', + ''GIP'', + + ''GMD'', ''GNF'', ''GTQ'', ''GYD'', ''HKD'', ''HNL'', ''HRK'', ''HTG'', ''HUF'', + ''IDR'', + + ''ILS'', ''IQD'', ''IRR'', ''ISK'', ''JMD'', ''JOD'', ''KES'', ''KGS'', ''KHR'', + ''KMF'', + + ''KPW'', ''KRW'', ''KWD'', ''KYD'', ''KZT'', ''LAK'', ''LBP'', ''LKR'', ''LRD'', + ''LSL'', + + ''LYD'', ''MAD'', ''MDL'', ''MGA'', ''MKD'', ''MMK'', ''MNT'', ''MOP'', ''MRO'', + ''MUR'', + + ''MVR'', ''MWK'', ''MXN'', ''MXV'', ''MYR'', ''MZN'', ''NAD'', ''NGN'', ''NIO'', + ''NOK'', + + ''NPR'', ''NZD'', ''OMR'', ''PAB'', ''PEN'', ''PGK'', ''PHP'', ''PKR'', ''PLN'', + ''PYG'', + + ''QAR'', ''RON'', ''RSD'', ''RUB'', ''RWF'', ''SAR'', ''SBD'', ''SCR'', ''SDG'', + ''SEK'', + + ''SGD'', ''SHP'', ''SLL'', ''SOS'', ''SRD'', ''SSP'', ''STD'', ''SYP'', ''SZL'', + ''THB'', + + ''TJS'', ''TMT'', ''TND'', ''TOP'', ''TRY'', ''TTD'', ''TWD'', ''TZS'', ''UAH'', + ''UGX'', + + ''UYU'', ''UZS'', ''VEF'', ''VND'', ''VUV'', ''WST'', ''XAF'', ''XCD'', ''XOF'', + ''XPF'', + + ''YER'', ''ZAR'', ''ZMW''. Default value: "USD" .' + name: price_currency + types: + - + - +- description: 'The item''s availability. The following are the + + possible values: Discontinued, InStock, InStoreOnly, LimitedAvailability, + + OnlineOnly, OutOfStock, PreOrder, SoldOut. Possible values include: + + ''Discontinued'', ''InStock'', ''InStoreOnly'', ''LimitedAvailability'', + + ''OnlineOnly'', ''OutOfStock'', ''PreOrder'', ''SoldOut''' + name: availability + types: + - + - +- description: 'An aggregated rating that indicates how well the + + product has been rated by others.' + name: aggregate_rating + types: + - +- description: 'The last date that the offer was updated. The date is + + in the form YYYY-MM-DD.' + name: last_updated + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.offer.Offer.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.offer.Offer.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.offer.Offer.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.offer.Offer.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.offer.Offer.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.offer.Offer.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.offer.Offer.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.offer.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.offer.yml new file mode 100644 index 00000000..20f9a797 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.offer.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.offer +name: offer +fullName: azure.cognitiveservices.search.visualsearch.models.offer +classes: +- azure.cognitiveservices.search.visualsearch.models.offer.Offer diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.offer_py3.Offer.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.offer_py3.Offer.yml new file mode 100644 index 00000000..4a3eb775 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.offer_py3.Offer.yml @@ -0,0 +1,264 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.offer_py3.Offer +name: Offer +fullName: azure.cognitiveservices.search.visualsearch.models.offer_py3.Offer +module: azure.cognitiveservices.search.visualsearch.models.offer_py3 +summary: 'Defines a merchant''s offer. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: AggregateOffer + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Offer(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: Seller for this offer. + name: seller + types: + - +- description: The item's price. + name: price + types: + - +- description: 'The monetary currency. For example, USD. Possible + + values include: ''USD'', ''CAD'', ''GBP'', ''EUR'', ''COP'', ''JPY'', ''CNY'', + ''AUD'', + + ''INR'', ''AED'', ''AFN'', ''ALL'', ''AMD'', ''ANG'', ''AOA'', ''ARS'', ''AWG'', + ''AZN'', + + ''BAM'', ''BBD'', ''BDT'', ''BGN'', ''BHD'', ''BIF'', ''BMD'', ''BND'', ''BOB'', + ''BOV'', + + ''BRL'', ''BSD'', ''BTN'', ''BWP'', ''BYR'', ''BZD'', ''CDF'', ''CHE'', ''CHF'', + ''CHW'', + + ''CLF'', ''CLP'', ''COU'', ''CRC'', ''CUC'', ''CUP'', ''CVE'', ''CZK'', ''DJF'', + ''DKK'', + + ''DOP'', ''DZD'', ''EGP'', ''ERN'', ''ETB'', ''FJD'', ''FKP'', ''GEL'', ''GHS'', + ''GIP'', + + ''GMD'', ''GNF'', ''GTQ'', ''GYD'', ''HKD'', ''HNL'', ''HRK'', ''HTG'', ''HUF'', + ''IDR'', + + ''ILS'', ''IQD'', ''IRR'', ''ISK'', ''JMD'', ''JOD'', ''KES'', ''KGS'', ''KHR'', + ''KMF'', + + ''KPW'', ''KRW'', ''KWD'', ''KYD'', ''KZT'', ''LAK'', ''LBP'', ''LKR'', ''LRD'', + ''LSL'', + + ''LYD'', ''MAD'', ''MDL'', ''MGA'', ''MKD'', ''MMK'', ''MNT'', ''MOP'', ''MRO'', + ''MUR'', + + ''MVR'', ''MWK'', ''MXN'', ''MXV'', ''MYR'', ''MZN'', ''NAD'', ''NGN'', ''NIO'', + ''NOK'', + + ''NPR'', ''NZD'', ''OMR'', ''PAB'', ''PEN'', ''PGK'', ''PHP'', ''PKR'', ''PLN'', + ''PYG'', + + ''QAR'', ''RON'', ''RSD'', ''RUB'', ''RWF'', ''SAR'', ''SBD'', ''SCR'', ''SDG'', + ''SEK'', + + ''SGD'', ''SHP'', ''SLL'', ''SOS'', ''SRD'', ''SSP'', ''STD'', ''SYP'', ''SZL'', + ''THB'', + + ''TJS'', ''TMT'', ''TND'', ''TOP'', ''TRY'', ''TTD'', ''TWD'', ''TZS'', ''UAH'', + ''UGX'', + + ''UYU'', ''UZS'', ''VEF'', ''VND'', ''VUV'', ''WST'', ''XAF'', ''XCD'', ''XOF'', + ''XPF'', + + ''YER'', ''ZAR'', ''ZMW''. Default value: "USD" .' + name: price_currency + types: + - + - +- description: 'The item''s availability. The following are the + + possible values: Discontinued, InStock, InStoreOnly, LimitedAvailability, + + OnlineOnly, OutOfStock, PreOrder, SoldOut. Possible values include: + + ''Discontinued'', ''InStock'', ''InStoreOnly'', ''LimitedAvailability'', + + ''OnlineOnly'', ''OutOfStock'', ''PreOrder'', ''SoldOut''' + name: availability + types: + - + - +- description: 'An aggregated rating that indicates how well the + + product has been rated by others.' + name: aggregate_rating + types: + - +- description: 'The last date that the offer was updated. The date is + + in the form YYYY-MM-DD.' + name: last_updated + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.offer_py3.Offer.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.offer_py3.Offer.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.offer_py3.Offer.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.offer_py3.Offer.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.offer_py3.Offer.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.offer_py3.Offer.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.offer_py3.Offer.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.offer_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.offer_py3.yml new file mode 100644 index 00000000..c02688de --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.offer_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.offer_py3 +name: offer_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.offer_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.offer_py3.Offer diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.organization.Organization.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.organization.Organization.yml new file mode 100644 index 00000000..4548d439 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.organization.Organization.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.organization.Organization +name: Organization +fullName: azure.cognitiveservices.search.visualsearch.models.organization.Organization +module: azure.cognitiveservices.search.visualsearch.models.organization +summary: 'Defines an organization. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Organization(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.organization.Organization.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.organization.Organization.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.organization.Organization.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.organization.Organization.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.organization.Organization.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.organization.Organization.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.organization.Organization.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.organization.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.organization.yml new file mode 100644 index 00000000..ddff7857 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.organization.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.organization +name: organization +fullName: azure.cognitiveservices.search.visualsearch.models.organization +classes: +- azure.cognitiveservices.search.visualsearch.models.organization.Organization diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.organization_py3.Organization.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.organization_py3.Organization.yml new file mode 100644 index 00000000..ee839bed --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.organization_py3.Organization.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.organization_py3.Organization +name: Organization +fullName: azure.cognitiveservices.search.visualsearch.models.organization_py3.Organization +module: azure.cognitiveservices.search.visualsearch.models.organization_py3 +summary: 'Defines an organization. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Organization(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.organization_py3.Organization.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.organization_py3.Organization.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.organization_py3.Organization.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.organization_py3.Organization.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.organization_py3.Organization.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.organization_py3.Organization.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.organization_py3.Organization.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.organization_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.organization_py3.yml new file mode 100644 index 00000000..7197c4ca --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.organization_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.organization_py3 +name: organization_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.organization_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.organization_py3.Organization diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.person.Person.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.person.Person.yml new file mode 100644 index 00000000..ba003955 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.person.Person.yml @@ -0,0 +1,179 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.person.Person +name: Person +fullName: azure.cognitiveservices.search.visualsearch.models.person.Person +module: azure.cognitiveservices.search.visualsearch.models.person +summary: 'Defines a person. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Person(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The person's job title. + name: job_title + types: + - +- description: The URL of the person's twitter profile. + name: twitter_profile + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.person.Person.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.person.Person.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.person.Person.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.person.Person.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.person.Person.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.person.Person.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.person.Person.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.person.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.person.yml new file mode 100644 index 00000000..fff56a48 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.person.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.person +name: person +fullName: azure.cognitiveservices.search.visualsearch.models.person +classes: +- azure.cognitiveservices.search.visualsearch.models.person.Person diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.person_py3.Person.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.person_py3.Person.yml new file mode 100644 index 00000000..3639f54f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.person_py3.Person.yml @@ -0,0 +1,179 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.person_py3.Person +name: Person +fullName: azure.cognitiveservices.search.visualsearch.models.person_py3.Person +module: azure.cognitiveservices.search.visualsearch.models.person_py3 +summary: 'Defines a person. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Person(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The person's job title. + name: job_title + types: + - +- description: The URL of the person's twitter profile. + name: twitter_profile + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.person_py3.Person.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.person_py3.Person.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.person_py3.Person.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.person_py3.Person.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.person_py3.Person.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.person_py3.Person.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.person_py3.Person.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.person_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.person_py3.yml new file mode 100644 index 00000000..19faf8c2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.person_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.person_py3 +name: person_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.person_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.person_py3.Person diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.point2_d.Point2D.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.point2_d.Point2D.yml new file mode 100644 index 00000000..3821290c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.point2_d.Point2D.yml @@ -0,0 +1,181 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.point2_d.Point2D +name: Point2D +fullName: azure.cognitiveservices.search.visualsearch.models.point2_d.Point2D +module: azure.cognitiveservices.search.visualsearch.models.point2_d +summary: 'Defines a 2D point with X and Y coordinates. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Point2D(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: x + description: Required. The x-coordinate of the point. + isRequired: true + types: + - + - name: y + description: Required. The y-coordinate of the point. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.point2_d.Point2D.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.point2_d.Point2D.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.point2_d.Point2D.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.point2_d.Point2D.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.point2_d.Point2D.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.point2_d.Point2D.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.point2_d.Point2D.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.point2_d.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.point2_d.yml new file mode 100644 index 00000000..5c8f286b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.point2_d.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.point2_d +name: point2_d +fullName: azure.cognitiveservices.search.visualsearch.models.point2_d +classes: +- azure.cognitiveservices.search.visualsearch.models.point2_d.Point2D diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.point2_d_py3.Point2D.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.point2_d_py3.Point2D.yml new file mode 100644 index 00000000..ba287da0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.point2_d_py3.Point2D.yml @@ -0,0 +1,186 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.point2_d_py3.Point2D +name: Point2D +fullName: azure.cognitiveservices.search.visualsearch.models.point2_d_py3.Point2D +module: azure.cognitiveservices.search.visualsearch.models.point2_d_py3 +summary: 'Defines a 2D point with X and Y coordinates. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Point2D(*, x: float, y: float, **kwargs)' + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: x + description: Required. The x-coordinate of the point. + isRequired: true + types: + - + - name: y + description: Required. The y-coordinate of the point. + isRequired: true + types: + - + keywordOnlyParameters: + - name: x + isRequired: true + - name: y + isRequired: true +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.point2_d_py3.Point2D.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.point2_d_py3.Point2D.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.point2_d_py3.Point2D.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.point2_d_py3.Point2D.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.point2_d_py3.Point2D.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.point2_d_py3.Point2D.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.point2_d_py3.Point2D.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.point2_d_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.point2_d_py3.yml new file mode 100644 index 00000000..5703b421 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.point2_d_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.point2_d_py3 +name: point2_d_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.point2_d_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.point2_d_py3.Point2D diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.properties_item.PropertiesItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.properties_item.PropertiesItem.yml new file mode 100644 index 00000000..8f536c03 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.properties_item.PropertiesItem.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.properties_item.PropertiesItem +name: PropertiesItem +fullName: azure.cognitiveservices.search.visualsearch.models.properties_item.PropertiesItem +module: azure.cognitiveservices.search.visualsearch.models.properties_item +summary: 'Defines an item. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Rating + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: PropertiesItem(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: Text representation of an item. + name: text + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.properties_item.PropertiesItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.properties_item.PropertiesItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.properties_item.PropertiesItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.properties_item.PropertiesItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.properties_item.PropertiesItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.properties_item.PropertiesItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.properties_item.PropertiesItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.properties_item.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.properties_item.yml new file mode 100644 index 00000000..20c92b21 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.properties_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.properties_item +name: properties_item +fullName: azure.cognitiveservices.search.visualsearch.models.properties_item +classes: +- azure.cognitiveservices.search.visualsearch.models.properties_item.PropertiesItem diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.properties_item_py3.PropertiesItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.properties_item_py3.PropertiesItem.yml new file mode 100644 index 00000000..42a738c3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.properties_item_py3.PropertiesItem.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.properties_item_py3.PropertiesItem +name: PropertiesItem +fullName: azure.cognitiveservices.search.visualsearch.models.properties_item_py3.PropertiesItem +module: azure.cognitiveservices.search.visualsearch.models.properties_item_py3 +summary: 'Defines an item. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Rating + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: PropertiesItem(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: Text representation of an item. + name: text + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.properties_item_py3.PropertiesItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.properties_item_py3.PropertiesItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.properties_item_py3.PropertiesItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.properties_item_py3.PropertiesItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.properties_item_py3.PropertiesItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.properties_item_py3.PropertiesItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.properties_item_py3.PropertiesItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.properties_item_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.properties_item_py3.yml new file mode 100644 index 00000000..db7ebf5d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.properties_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.properties_item_py3 +name: properties_item_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.properties_item_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.properties_item_py3.PropertiesItem diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.query.Query.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.query.Query.yml new file mode 100644 index 00000000..3334fc0f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.query.Query.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.query.Query +name: Query +fullName: azure.cognitiveservices.search.visualsearch.models.query.Query +module: azure.cognitiveservices.search.visualsearch.models.query +summary: 'Defines a search query. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Query(**kwargs) + parameters: + - name: text + description: 'Required. The query string. Use this string as the query term + + in a new search request.' + isRequired: true + types: + - +variables: +- description: The display version of the query term. + name: display_text + types: + - +- description: 'The URL that takes the user to the Bing search + + results page for the query.' + name: web_search_url + types: + - +- description: 'The URL that you use to get the results of the related + + search. Before using the URL, you must append query parameters as + + appropriate and include the Ocp-Apim-Subscription-Key header. Use this URL + + if you''re displaying the results in your own user interface. Otherwise, + + use the webSearchUrl URL.' + name: search_link + types: + - +- description: The URL to a thumbnail of a related image. + name: thumbnail + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.query.Query.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.query.Query.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.query.Query.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.query.Query.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.query.Query.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.query.Query.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.query.Query.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.query.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.query.yml new file mode 100644 index 00000000..a05d544d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.query.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.query +name: query +fullName: azure.cognitiveservices.search.visualsearch.models.query +classes: +- azure.cognitiveservices.search.visualsearch.models.query.Query diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.query_py3.Query.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.query_py3.Query.yml new file mode 100644 index 00000000..57508778 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.query_py3.Query.yml @@ -0,0 +1,160 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.query_py3.Query +name: Query +fullName: azure.cognitiveservices.search.visualsearch.models.query_py3.Query +module: azure.cognitiveservices.search.visualsearch.models.query_py3 +summary: 'Defines a search query. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Query(*, text: str, **kwargs)' + parameters: + - name: text + description: 'Required. The query string. Use this string as the query term + + in a new search request.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: text + isRequired: true +variables: +- description: The display version of the query term. + name: display_text + types: + - +- description: 'The URL that takes the user to the Bing search + + results page for the query.' + name: web_search_url + types: + - +- description: 'The URL that you use to get the results of the related + + search. Before using the URL, you must append query parameters as + + appropriate and include the Ocp-Apim-Subscription-Key header. Use this URL + + if you''re displaying the results in your own user interface. Otherwise, + + use the webSearchUrl URL.' + name: search_link + types: + - +- description: The URL to a thumbnail of a related image. + name: thumbnail + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.query_py3.Query.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.query_py3.Query.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.query_py3.Query.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.query_py3.Query.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.query_py3.Query.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.query_py3.Query.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.query_py3.Query.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.query_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.query_py3.yml new file mode 100644 index 00000000..213ed44a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.query_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.query_py3 +name: query_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.query_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.query_py3.Query diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.rating.Rating.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.rating.Rating.yml new file mode 100644 index 00000000..a25a8bc3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.rating.Rating.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.rating.Rating +name: Rating +fullName: azure.cognitiveservices.search.visualsearch.models.rating.Rating +module: azure.cognitiveservices.search.visualsearch.models.rating +summary: 'Defines a rating. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: AggregateRating + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Rating(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: rating_value + description: 'Required. The mean (average) rating. The possible + + values are 1.0 through 5.0.' + isRequired: true + types: + - +variables: +- description: Text representation of an item. + name: text + types: + - +- description: 'The highest rated review. The possible values are 1.0 + + through 5.0.' + name: best_rating + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.rating.Rating.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.rating.Rating.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.rating.Rating.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.rating.Rating.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.rating.Rating.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.rating.Rating.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.rating.Rating.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.rating.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.rating.yml new file mode 100644 index 00000000..aaa4a5a1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.rating.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.rating +name: rating +fullName: azure.cognitiveservices.search.visualsearch.models.rating +classes: +- azure.cognitiveservices.search.visualsearch.models.rating.Rating diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.rating_py3.Rating.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.rating_py3.Rating.yml new file mode 100644 index 00000000..fc341e73 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.rating_py3.Rating.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.rating_py3.Rating +name: Rating +fullName: azure.cognitiveservices.search.visualsearch.models.rating_py3.Rating +module: azure.cognitiveservices.search.visualsearch.models.rating_py3 +summary: 'Defines a rating. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: AggregateRating + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Rating(*, rating_value: float, **kwargs)' + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: rating_value + description: 'Required. The mean (average) rating. The possible + + values are 1.0 through 5.0.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: rating_value + isRequired: true +variables: +- description: Text representation of an item. + name: text + types: + - +- description: 'The highest rated review. The possible values are 1.0 + + through 5.0.' + name: best_rating + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.rating_py3.Rating.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.rating_py3.Rating.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.rating_py3.Rating.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.rating_py3.Rating.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.rating_py3.Rating.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.rating_py3.Rating.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.rating_py3.Rating.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.rating_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.rating_py3.yml new file mode 100644 index 00000000..63b97aba --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.rating_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.rating_py3 +name: rating_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.rating_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.rating_py3.Rating diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipe.Recipe.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipe.Recipe.yml new file mode 100644 index 00000000..32830e5e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipe.Recipe.yml @@ -0,0 +1,211 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.recipe.Recipe +name: Recipe +fullName: azure.cognitiveservices.search.visualsearch.models.recipe.Recipe +module: azure.cognitiveservices.search.visualsearch.models.recipe +summary: 'Defines a cooking recipe. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Recipe(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: 'The amount of time the food takes to cook. For example, + + PT25M. For information about the time format, see + + [http://en.wikipedia.org/wiki/ISO_8601#Durations](http://en.wikipedia.org/wiki/ISO_8601#Durations).' + name: cook_time + types: + - +- description: 'The amount of time required to prepare the ingredients. + + For example, PT15M. For information about the time format, see + + [http://en.wikipedia.org/wiki/ISO_8601#Durations](http://en.wikipedia.org/wiki/ISO_8601#Durations).' + name: prep_time + types: + - +- description: 'The total amount of time it takes to prepare and cook + + the recipe. For example, PT45M. For information about the time format, see + + [http://en.wikipedia.org/wiki/ISO_8601#Durations](http://en.wikipedia.org/wiki/ISO_8601#Durations).' + name: total_time + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.recipe.Recipe.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.recipe.Recipe.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.recipe.Recipe.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.recipe.Recipe.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.recipe.Recipe.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.recipe.Recipe.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.recipe.Recipe.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipe.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipe.yml new file mode 100644 index 00000000..b3d323de --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipe.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.recipe +name: recipe +fullName: azure.cognitiveservices.search.visualsearch.models.recipe +classes: +- azure.cognitiveservices.search.visualsearch.models.recipe.Recipe diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipe_py3.Recipe.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipe_py3.Recipe.yml new file mode 100644 index 00000000..eff41f8a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipe_py3.Recipe.yml @@ -0,0 +1,211 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.recipe_py3.Recipe +name: Recipe +fullName: azure.cognitiveservices.search.visualsearch.models.recipe_py3.Recipe +module: azure.cognitiveservices.search.visualsearch.models.recipe_py3 +summary: 'Defines a cooking recipe. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Recipe(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +- description: The URL to a thumbnail of the item. + name: thumbnail_url + types: + - +- description: The source of the creative work. + name: provider + types: + - [] +- description: The date on which the CreativeWork was published. + name: date_published + types: + - +- description: Text content of this creative work. + name: text + types: + - +- description: 'The amount of time the food takes to cook. For example, + + PT25M. For information about the time format, see + + [http://en.wikipedia.org/wiki/ISO_8601#Durations](http://en.wikipedia.org/wiki/ISO_8601#Durations).' + name: cook_time + types: + - +- description: 'The amount of time required to prepare the ingredients. + + For example, PT15M. For information about the time format, see + + [http://en.wikipedia.org/wiki/ISO_8601#Durations](http://en.wikipedia.org/wiki/ISO_8601#Durations).' + name: prep_time + types: + - +- description: 'The total amount of time it takes to prepare and cook + + the recipe. For example, PT45M. For information about the time format, see + + [http://en.wikipedia.org/wiki/ISO_8601#Durations](http://en.wikipedia.org/wiki/ISO_8601#Durations).' + name: total_time + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.recipe_py3.Recipe.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.recipe_py3.Recipe.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.recipe_py3.Recipe.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.recipe_py3.Recipe.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.recipe_py3.Recipe.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.recipe_py3.Recipe.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.recipe_py3.Recipe.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipe_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipe_py3.yml new file mode 100644 index 00000000..8648707a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipe_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.recipe_py3 +name: recipe_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.recipe_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.recipe_py3.Recipe diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipes_module.RecipesModule.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipes_module.RecipesModule.yml new file mode 100644 index 00000000..b0309f49 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipes_module.RecipesModule.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.recipes_module.RecipesModule +name: RecipesModule +fullName: azure.cognitiveservices.search.visualsearch.models.recipes_module.RecipesModule +module: azure.cognitiveservices.search.visualsearch.models.recipes_module +summary: 'Defines a list of recipes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: RecipesModule(**kwargs) +variables: +- description: A list of recipes. + name: value + types: + - [] +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.recipes_module.RecipesModule.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.recipes_module.RecipesModule.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.recipes_module.RecipesModule.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.recipes_module.RecipesModule.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.recipes_module.RecipesModule.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.recipes_module.RecipesModule.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.recipes_module.RecipesModule.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipes_module.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipes_module.yml new file mode 100644 index 00000000..c937015c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipes_module.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.recipes_module +name: recipes_module +fullName: azure.cognitiveservices.search.visualsearch.models.recipes_module +classes: +- azure.cognitiveservices.search.visualsearch.models.recipes_module.RecipesModule diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipes_module_py3.RecipesModule.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipes_module_py3.RecipesModule.yml new file mode 100644 index 00000000..23a31bc3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipes_module_py3.RecipesModule.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.recipes_module_py3.RecipesModule +name: RecipesModule +fullName: azure.cognitiveservices.search.visualsearch.models.recipes_module_py3.RecipesModule +module: azure.cognitiveservices.search.visualsearch.models.recipes_module_py3 +summary: 'Defines a list of recipes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: RecipesModule(**kwargs) +variables: +- description: A list of recipes. + name: value + types: + - [] +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.recipes_module_py3.RecipesModule.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.recipes_module_py3.RecipesModule.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.recipes_module_py3.RecipesModule.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.recipes_module_py3.RecipesModule.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.recipes_module_py3.RecipesModule.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.recipes_module_py3.RecipesModule.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.recipes_module_py3.RecipesModule.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipes_module_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipes_module_py3.yml new file mode 100644 index 00000000..dd405119 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.recipes_module_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.recipes_module_py3 +name: recipes_module_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.recipes_module_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.recipes_module_py3.RecipesModule diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.related_searches_module.RelatedSearchesModule.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.related_searches_module.RelatedSearchesModule.yml new file mode 100644 index 00000000..a69474fa --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.related_searches_module.RelatedSearchesModule.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.related_searches_module.RelatedSearchesModule +name: RelatedSearchesModule +fullName: azure.cognitiveservices.search.visualsearch.models.related_searches_module.RelatedSearchesModule +module: azure.cognitiveservices.search.visualsearch.models.related_searches_module +summary: 'Defines a list of related searches. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: RelatedSearchesModule(**kwargs) +variables: +- description: A list of related searches. + name: value + types: + - [] +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.related_searches_module.RelatedSearchesModule.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.related_searches_module.RelatedSearchesModule.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.related_searches_module.RelatedSearchesModule.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.related_searches_module.RelatedSearchesModule.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.related_searches_module.RelatedSearchesModule.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.related_searches_module.RelatedSearchesModule.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.related_searches_module.RelatedSearchesModule.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.related_searches_module.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.related_searches_module.yml new file mode 100644 index 00000000..c8556e12 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.related_searches_module.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.related_searches_module +name: related_searches_module +fullName: azure.cognitiveservices.search.visualsearch.models.related_searches_module +classes: +- azure.cognitiveservices.search.visualsearch.models.related_searches_module.RelatedSearchesModule diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3.RelatedSearchesModule.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3.RelatedSearchesModule.yml new file mode 100644 index 00000000..ea005783 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3.RelatedSearchesModule.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3.RelatedSearchesModule +name: RelatedSearchesModule +fullName: azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3.RelatedSearchesModule +module: azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3 +summary: 'Defines a list of related searches. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: RelatedSearchesModule(**kwargs) +variables: +- description: A list of related searches. + name: value + types: + - [] +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3.RelatedSearchesModule.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3.RelatedSearchesModule.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3.RelatedSearchesModule.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3.RelatedSearchesModule.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3.RelatedSearchesModule.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3.RelatedSearchesModule.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3.RelatedSearchesModule.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3.yml new file mode 100644 index 00000000..614123c9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3 +name: related_searches_module_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3.RelatedSearchesModule diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response.Response.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response.Response.yml new file mode 100644 index 00000000..d6eb2b09 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response.Response.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.response.Response +name: Response +fullName: azure.cognitiveservices.search.visualsearch.models.response.Response +module: azure.cognitiveservices.search.visualsearch.models.response +summary: 'Defines a response. All schemas that return at the root of the response + + must inherit from this object. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: ImageKnowledge, ErrorResponse, Thing + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Response(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.response.Response.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.response.Response.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.response.Response.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.response.Response.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.response.Response.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.response.Response.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.response.Response.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response.yml new file mode 100644 index 00000000..e0af46e3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.response +name: response +fullName: azure.cognitiveservices.search.visualsearch.models.response +classes: +- azure.cognitiveservices.search.visualsearch.models.response.Response diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_base.ResponseBase.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_base.ResponseBase.yml new file mode 100644 index 00000000..9bf8a34e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_base.ResponseBase.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.response_base.ResponseBase +name: ResponseBase +fullName: azure.cognitiveservices.search.visualsearch.models.response_base.ResponseBase +module: azure.cognitiveservices.search.visualsearch.models.response_base +summary: 'Response base. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Identifiable + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ResponseBase(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.response_base.ResponseBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.response_base.ResponseBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.response_base.ResponseBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.response_base.ResponseBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.response_base.ResponseBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.response_base.ResponseBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.response_base.ResponseBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_base.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_base.yml new file mode 100644 index 00000000..82388061 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_base.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.response_base +name: response_base +fullName: azure.cognitiveservices.search.visualsearch.models.response_base +classes: +- azure.cognitiveservices.search.visualsearch.models.response_base.ResponseBase diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_base_py3.ResponseBase.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_base_py3.ResponseBase.yml new file mode 100644 index 00000000..a7b7543b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_base_py3.ResponseBase.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.response_base_py3.ResponseBase +name: ResponseBase +fullName: azure.cognitiveservices.search.visualsearch.models.response_base_py3.ResponseBase +module: azure.cognitiveservices.search.visualsearch.models.response_base_py3 +summary: 'Response base. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Identifiable + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ResponseBase(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.response_base_py3.ResponseBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.response_base_py3.ResponseBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.response_base_py3.ResponseBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.response_base_py3.ResponseBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.response_base_py3.ResponseBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.response_base_py3.ResponseBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.response_base_py3.ResponseBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_base_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_base_py3.yml new file mode 100644 index 00000000..cb0a6422 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_base_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.response_base_py3 +name: response_base_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.response_base_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.response_base_py3.ResponseBase diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_py3.Response.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_py3.Response.yml new file mode 100644 index 00000000..7cc62e41 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_py3.Response.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.response_py3.Response +name: Response +fullName: azure.cognitiveservices.search.visualsearch.models.response_py3.Response +module: azure.cognitiveservices.search.visualsearch.models.response_py3 +summary: 'Defines a response. All schemas that return at the root of the response + + must inherit from this object. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: ImageKnowledge, ErrorResponse, Thing + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Response(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.response_py3.Response.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.response_py3.Response.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.response_py3.Response.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.response_py3.Response.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.response_py3.Response.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.response_py3.Response.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.response_py3.Response.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_py3.yml new file mode 100644 index 00000000..d32a5b2a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.response_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.response_py3 +name: response_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.response_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.response_py3.Response diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.structured_value.StructuredValue.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.structured_value.StructuredValue.yml new file mode 100644 index 00000000..18d6e4d1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.structured_value.StructuredValue.yml @@ -0,0 +1,176 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.structured_value.StructuredValue +name: StructuredValue +fullName: azure.cognitiveservices.search.visualsearch.models.structured_value.StructuredValue +module: azure.cognitiveservices.search.visualsearch.models.structured_value +summary: 'StructuredValue. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Point2D, NormalizedQuadrilateral + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: StructuredValue(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.structured_value.StructuredValue.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.structured_value.StructuredValue.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.structured_value.StructuredValue.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.structured_value.StructuredValue.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.structured_value.StructuredValue.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.structured_value.StructuredValue.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.structured_value.StructuredValue.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.structured_value.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.structured_value.yml new file mode 100644 index 00000000..74ebf7b3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.structured_value.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.structured_value +name: structured_value +fullName: azure.cognitiveservices.search.visualsearch.models.structured_value +classes: +- azure.cognitiveservices.search.visualsearch.models.structured_value.StructuredValue diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.structured_value_py3.StructuredValue.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.structured_value_py3.StructuredValue.yml new file mode 100644 index 00000000..2145ea71 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.structured_value_py3.StructuredValue.yml @@ -0,0 +1,176 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.structured_value_py3.StructuredValue +name: StructuredValue +fullName: azure.cognitiveservices.search.visualsearch.models.structured_value_py3.StructuredValue +module: azure.cognitiveservices.search.visualsearch.models.structured_value_py3 +summary: 'StructuredValue. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Point2D, NormalizedQuadrilateral + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: StructuredValue(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.structured_value_py3.StructuredValue.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.structured_value_py3.StructuredValue.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.structured_value_py3.StructuredValue.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.structured_value_py3.StructuredValue.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.structured_value_py3.StructuredValue.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.structured_value_py3.StructuredValue.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.structured_value_py3.StructuredValue.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.structured_value_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.structured_value_py3.yml new file mode 100644 index 00000000..1d83f581 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.structured_value_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.structured_value_py3 +name: structured_value_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.structured_value_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.structured_value_py3.StructuredValue diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.thing.Thing.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.thing.Thing.yml new file mode 100644 index 00000000..1ac7359f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.thing.Thing.yml @@ -0,0 +1,178 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.thing.Thing +name: Thing +fullName: azure.cognitiveservices.search.visualsearch.models.thing.Thing +module: azure.cognitiveservices.search.visualsearch.models.thing +summary: 'Defines a thing. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: ImageTag, Organization, Offer, CreativeWork, Person, + + Intangible + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Thing(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.thing.Thing.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.thing.Thing.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.thing.Thing.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.thing.Thing.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.thing.Thing.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.thing.Thing.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.thing.Thing.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.thing.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.thing.yml new file mode 100644 index 00000000..e27f5f17 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.thing.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.thing +name: thing +fullName: azure.cognitiveservices.search.visualsearch.models.thing +classes: +- azure.cognitiveservices.search.visualsearch.models.thing.Thing diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.thing_py3.Thing.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.thing_py3.Thing.yml new file mode 100644 index 00000000..e9302da9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.thing_py3.Thing.yml @@ -0,0 +1,178 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.thing_py3.Thing +name: Thing +fullName: azure.cognitiveservices.search.visualsearch.models.thing_py3.Thing +module: azure.cognitiveservices.search.visualsearch.models.thing_py3 +summary: 'Defines a thing. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: ImageTag, Organization, Offer, CreativeWork, Person, + + Intangible + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Thing(**kwargs) + parameters: + - name: _type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: A String identifier. + name: id + types: + - +- description: 'The URL that returns this resource. To use the URL, + + append query parameters as appropriate and include the + + Ocp-Apim-Subscription-Key header.' + name: read_link + types: + - +- description: The URL to Bing's search result for this item. + name: web_search_url + types: + - +- description: The name of the thing represented by this object. + name: name + types: + - +- description: 'The URL to get more information about the thing represented by + + this object.' + name: url + types: + - +- description: An image of the item. + name: image + types: + - +- description: A short description of the item. + name: description + types: + - +- description: An alias for the item. + name: alternate_name + types: + - +- description: An ID that uniquely identifies this item. + name: bing_id + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.thing_py3.Thing.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.thing_py3.Thing.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.thing_py3.Thing.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.thing_py3.Thing.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.thing_py3.Thing.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.thing_py3.Thing.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.thing_py3.Thing.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.thing_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.thing_py3.yml new file mode 100644 index 00000000..9104aef3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.thing_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.thing_py3 +name: thing_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.thing_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.thing_py3.Thing diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.yml new file mode 100644 index 00000000..1dd40d0e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.yml @@ -0,0 +1,328 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency +name: Currency +fullName: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency +module: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums +fields: +- name: aed + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.aed +- name: afn + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.afn +- name: all + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.all +- name: amd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.amd +- name: ang + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.ang +- name: aoa + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.aoa +- name: ars + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.ars +- name: aud + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.aud +- name: awg + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.awg +- name: azn + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.azn +- name: bam + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.bam +- name: bbd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.bbd +- name: bdt + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.bdt +- name: bgn + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.bgn +- name: bhd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.bhd +- name: bif + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.bif +- name: bmd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.bmd +- name: bnd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.bnd +- name: bob + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.bob +- name: bov + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.bov +- name: brl + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.brl +- name: bsd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.bsd +- name: btn + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.btn +- name: bwp + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.bwp +- name: byr + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.byr +- name: bzd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.bzd +- name: cad + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.cad +- name: cdf + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.cdf +- name: che + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.che +- name: chf + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.chf +- name: chw + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.chw +- name: clf + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.clf +- name: clp + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.clp +- name: cny + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.cny +- name: cop + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.cop +- name: cou + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.cou +- name: crc + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.crc +- name: cuc + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.cuc +- name: cup + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.cup +- name: cve + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.cve +- name: czk + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.czk +- name: djf + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.djf +- name: dkk + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.dkk +- name: dop + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.dop +- name: dzd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.dzd +- name: egp + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.egp +- name: ern + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.ern +- name: etb + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.etb +- name: eur + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.eur +- name: fjd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.fjd +- name: fkp + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.fkp +- name: gbp + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.gbp +- name: gel + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.gel +- name: ghs + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.ghs +- name: gip + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.gip +- name: gmd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.gmd +- name: gnf + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.gnf +- name: gtq + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.gtq +- name: gyd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.gyd +- name: hkd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.hkd +- name: hnl + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.hnl +- name: hrk + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.hrk +- name: htg + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.htg +- name: huf + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.huf +- name: idr + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.idr +- name: ils + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.ils +- name: inr + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.inr +- name: iqd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.iqd +- name: irr + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.irr +- name: isk + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.isk +- name: jmd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.jmd +- name: jod + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.jod +- name: jpy + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.jpy +- name: kes + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.kes +- name: kgs + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.kgs +- name: khr + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.khr +- name: kmf + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.kmf +- name: kpw + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.kpw +- name: krw + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.krw +- name: kwd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.kwd +- name: kyd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.kyd +- name: kzt + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.kzt +- name: lak + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.lak +- name: lbp + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.lbp +- name: lkr + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.lkr +- name: lrd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.lrd +- name: lsl + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.lsl +- name: lyd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.lyd +- name: mad + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.mad +- name: mdl + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.mdl +- name: mga + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.mga +- name: mkd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.mkd +- name: mmk + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.mmk +- name: mnt + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.mnt +- name: mop + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.mop +- name: mro_enum + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.mro_enum +- name: mur + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.mur +- name: mvr + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.mvr +- name: mwk + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.mwk +- name: mxn + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.mxn +- name: mxv + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.mxv +- name: myr + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.myr +- name: mzn + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.mzn +- name: nad + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.nad +- name: ngn + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.ngn +- name: nio + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.nio +- name: nok + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.nok +- name: npr + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.npr +- name: nzd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.nzd +- name: omr + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.omr +- name: pab + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.pab +- name: pen + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.pen +- name: pgk + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.pgk +- name: php + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.php +- name: pkr + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.pkr +- name: pln + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.pln +- name: pyg + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.pyg +- name: qar + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.qar +- name: ron + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.ron +- name: rsd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.rsd +- name: rub + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.rub +- name: rwf + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.rwf +- name: sar + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.sar +- name: sbd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.sbd +- name: scr + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.scr +- name: sdg + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.sdg +- name: sek + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.sek +- name: sgd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.sgd +- name: shp + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.shp +- name: sll + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.sll +- name: sos + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.sos +- name: srd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.srd +- name: ssp + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.ssp +- name: std + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.std +- name: syp + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.syp +- name: szl + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.szl +- name: thb + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.thb +- name: tjs + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.tjs +- name: tmt + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.tmt +- name: tnd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.tnd +- name: top + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.top +- name: try_enum + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.try_enum +- name: ttd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.ttd +- name: twd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.twd +- name: tzs + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.tzs +- name: uah + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.uah +- name: ugx + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.ugx +- name: usd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.usd +- name: uyu + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.uyu +- name: uzs + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.uzs +- name: vef + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.vef +- name: vnd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.vnd +- name: vuv + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.vuv +- name: wst + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.wst +- name: xaf + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.xaf +- name: xcd + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.xcd +- name: xof + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.xof +- name: xpf + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.xpf +- name: yer + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.yer +- name: zar + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.zar +- name: zmw + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency.zmw diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorCode.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorCode.yml new file mode 100644 index 00000000..ed99d8d2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorCode.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorCode +name: ErrorCode +fullName: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorCode +module: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums +fields: +- name: insufficient_authorization + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorCode.insufficient_authorization +- name: invalid_authorization + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorCode.invalid_authorization +- name: invalid_request + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorCode.invalid_request +- name: none + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorCode.none +- name: rate_limit_exceeded + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorCode.rate_limit_exceeded +- name: server_error + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorCode.server_error diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorSubCode.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorSubCode.yml new file mode 100644 index 00000000..c943e78b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorSubCode.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorSubCode +name: ErrorSubCode +fullName: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorSubCode +module: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums +fields: +- name: authorization_disabled + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorSubCode.authorization_disabled +- name: authorization_expired + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorSubCode.authorization_expired +- name: authorization_missing + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorSubCode.authorization_missing +- name: authorization_redundancy + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorSubCode.authorization_redundancy +- name: blocked + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorSubCode.blocked +- name: http_not_allowed + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorSubCode.http_not_allowed +- name: not_implemented + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorSubCode.not_implemented +- name: parameter_invalid_value + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorSubCode.parameter_invalid_value +- name: parameter_missing + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorSubCode.parameter_missing +- name: resource_error + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorSubCode.resource_error +- name: unexpected_error + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorSubCode.unexpected_error diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ItemAvailability.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ItemAvailability.yml new file mode 100644 index 00000000..75a83d4b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ItemAvailability.yml @@ -0,0 +1,22 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ItemAvailability +name: ItemAvailability +fullName: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ItemAvailability +module: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums +fields: +- name: discontinued + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ItemAvailability.discontinued +- name: in_stock + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ItemAvailability.in_stock +- name: in_store_only + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ItemAvailability.in_store_only +- name: limited_availability + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ItemAvailability.limited_availability +- name: online_only + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ItemAvailability.online_only +- name: out_of_stock + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ItemAvailability.out_of_stock +- name: pre_order + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ItemAvailability.pre_order +- name: sold_out + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ItemAvailability.sold_out diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.SafeSearch.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.SafeSearch.yml new file mode 100644 index 00000000..f34008c4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.SafeSearch.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.SafeSearch +name: SafeSearch +fullName: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.SafeSearch +module: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums +fields: +- name: moderate + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.SafeSearch.moderate +- name: 'off' + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.SafeSearch.off +- name: strict + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.SafeSearch.strict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.yml new file mode 100644 index 00000000..54095ac3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums +name: visual_search_client_enums +fullName: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums +enums: +- azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency +- azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorCode +- azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorSubCode +- azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ItemAvailability +- azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.SafeSearch diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_request.VisualSearchRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_request.VisualSearchRequest.yml new file mode 100644 index 00000000..04386d76 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_request.VisualSearchRequest.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.visual_search_request.VisualSearchRequest +name: VisualSearchRequest +fullName: azure.cognitiveservices.search.visualsearch.models.visual_search_request.VisualSearchRequest +module: azure.cognitiveservices.search.visualsearch.models.visual_search_request +summary: 'A JSON object that contains information about the image to get insights + of. + + Specify this object only in a knowledgeRequest form data.' +constructor: + syntax: VisualSearchRequest(**kwargs) + parameters: + - name: image_info + description: 'A JSON object that identities the image to get insights + + of.' + isRequired: true + types: + - + - name: knowledge_request + description: 'A JSON object containing information about the + + request, such as filters, or a description.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.visual_search_request.VisualSearchRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.visual_search_request.VisualSearchRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.visual_search_request.VisualSearchRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.visual_search_request.VisualSearchRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.visual_search_request.VisualSearchRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.visual_search_request.VisualSearchRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.visual_search_request.VisualSearchRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_request.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_request.yml new file mode 100644 index 00000000..2699f3fa --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_request.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.visual_search_request +name: visual_search_request +fullName: azure.cognitiveservices.search.visualsearch.models.visual_search_request +classes: +- azure.cognitiveservices.search.visualsearch.models.visual_search_request.VisualSearchRequest diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.VisualSearchRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.VisualSearchRequest.yml new file mode 100644 index 00000000..51fbd750 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.VisualSearchRequest.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.VisualSearchRequest +name: VisualSearchRequest +fullName: azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.VisualSearchRequest +module: azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3 +summary: 'A JSON object that contains information about the image to get insights + of. + + Specify this object only in a knowledgeRequest form data.' +constructor: + syntax: VisualSearchRequest(*, image_info=None, knowledge_request=None, **kwargs) + parameters: + - name: image_info + description: 'A JSON object that identities the image to get insights + + of.' + isRequired: true + types: + - + - name: knowledge_request + description: 'A JSON object containing information about the + + request, such as filters, or a description.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: image_info + isRequired: true + - name: knowledge_request + isRequired: true +methods: +- uid: azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.VisualSearchRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.VisualSearchRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.VisualSearchRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.VisualSearchRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.VisualSearchRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.VisualSearchRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.VisualSearchRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.yml new file mode 100644 index 00000000..ae923cbd --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3 +name: visual_search_request_py3 +fullName: azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3 +classes: +- azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.VisualSearchRequest diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.yml new file mode 100644 index 00000000..388b146b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.search.visualsearch.models +name: models +fullName: azure.cognitiveservices.search.visualsearch.models +type: import +classes: +- azure.cognitiveservices.search.visualsearch.models.Action +- azure.cognitiveservices.search.visualsearch.models.AggregateOffer +- azure.cognitiveservices.search.visualsearch.models.AggregateRating +- azure.cognitiveservices.search.visualsearch.models.CreativeWork +- azure.cognitiveservices.search.visualsearch.models.CropArea +- azure.cognitiveservices.search.visualsearch.models.Error +- azure.cognitiveservices.search.visualsearch.models.ErrorResponse +- azure.cognitiveservices.search.visualsearch.models.ErrorResponseException +- azure.cognitiveservices.search.visualsearch.models.Filters +- azure.cognitiveservices.search.visualsearch.models.Identifiable +- azure.cognitiveservices.search.visualsearch.models.ImageAction +- azure.cognitiveservices.search.visualsearch.models.ImageEntityAction +- azure.cognitiveservices.search.visualsearch.models.ImageInfo +- azure.cognitiveservices.search.visualsearch.models.ImageKnowledge +- azure.cognitiveservices.search.visualsearch.models.ImageModuleAction +- azure.cognitiveservices.search.visualsearch.models.ImageObject +- azure.cognitiveservices.search.visualsearch.models.ImageRecipesAction +- azure.cognitiveservices.search.visualsearch.models.ImageRelatedSearchesAction +- azure.cognitiveservices.search.visualsearch.models.ImageShoppingSourcesAction +- azure.cognitiveservices.search.visualsearch.models.ImageTag +- azure.cognitiveservices.search.visualsearch.models.ImageTagRegion +- azure.cognitiveservices.search.visualsearch.models.ImagesImageMetadata +- azure.cognitiveservices.search.visualsearch.models.ImagesModule +- azure.cognitiveservices.search.visualsearch.models.Intangible +- azure.cognitiveservices.search.visualsearch.models.KnowledgeRequest +- azure.cognitiveservices.search.visualsearch.models.MediaObject +- azure.cognitiveservices.search.visualsearch.models.NormalizedQuadrilateral +- azure.cognitiveservices.search.visualsearch.models.Offer +- azure.cognitiveservices.search.visualsearch.models.Organization +- azure.cognitiveservices.search.visualsearch.models.Person +- azure.cognitiveservices.search.visualsearch.models.Point2D +- azure.cognitiveservices.search.visualsearch.models.PropertiesItem +- azure.cognitiveservices.search.visualsearch.models.Query +- azure.cognitiveservices.search.visualsearch.models.Rating +- azure.cognitiveservices.search.visualsearch.models.Recipe +- azure.cognitiveservices.search.visualsearch.models.RecipesModule +- azure.cognitiveservices.search.visualsearch.models.RelatedSearchesModule +- azure.cognitiveservices.search.visualsearch.models.Response +- azure.cognitiveservices.search.visualsearch.models.ResponseBase +- azure.cognitiveservices.search.visualsearch.models.StructuredValue +- azure.cognitiveservices.search.visualsearch.models.Thing +- azure.cognitiveservices.search.visualsearch.models.VisualSearchRequest +modules: +- azure.cognitiveservices.search.visualsearch.models.action +- azure.cognitiveservices.search.visualsearch.models.action_py3 +- azure.cognitiveservices.search.visualsearch.models.aggregate_offer +- azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3 +- azure.cognitiveservices.search.visualsearch.models.aggregate_rating +- azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3 +- azure.cognitiveservices.search.visualsearch.models.creative_work +- azure.cognitiveservices.search.visualsearch.models.creative_work_py3 +- azure.cognitiveservices.search.visualsearch.models.crop_area +- azure.cognitiveservices.search.visualsearch.models.crop_area_py3 +- azure.cognitiveservices.search.visualsearch.models.error +- azure.cognitiveservices.search.visualsearch.models.error_py3 +- azure.cognitiveservices.search.visualsearch.models.error_response +- azure.cognitiveservices.search.visualsearch.models.error_response_py3 +- azure.cognitiveservices.search.visualsearch.models.filters +- azure.cognitiveservices.search.visualsearch.models.filters_py3 +- azure.cognitiveservices.search.visualsearch.models.identifiable +- azure.cognitiveservices.search.visualsearch.models.identifiable_py3 +- azure.cognitiveservices.search.visualsearch.models.image_action +- azure.cognitiveservices.search.visualsearch.models.image_action_py3 +- azure.cognitiveservices.search.visualsearch.models.image_entity_action +- azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3 +- azure.cognitiveservices.search.visualsearch.models.image_info +- azure.cognitiveservices.search.visualsearch.models.image_info_py3 +- azure.cognitiveservices.search.visualsearch.models.image_knowledge +- azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3 +- azure.cognitiveservices.search.visualsearch.models.image_module_action +- azure.cognitiveservices.search.visualsearch.models.image_module_action_py3 +- azure.cognitiveservices.search.visualsearch.models.image_object +- azure.cognitiveservices.search.visualsearch.models.image_object_py3 +- azure.cognitiveservices.search.visualsearch.models.image_recipes_action +- azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3 +- azure.cognitiveservices.search.visualsearch.models.image_related_searches_action +- azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3 +- azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action +- azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3 +- azure.cognitiveservices.search.visualsearch.models.image_tag +- azure.cognitiveservices.search.visualsearch.models.image_tag_py3 +- azure.cognitiveservices.search.visualsearch.models.image_tag_region +- azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3 +- azure.cognitiveservices.search.visualsearch.models.images_image_metadata +- azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3 +- azure.cognitiveservices.search.visualsearch.models.images_module +- azure.cognitiveservices.search.visualsearch.models.images_module_py3 +- azure.cognitiveservices.search.visualsearch.models.intangible +- azure.cognitiveservices.search.visualsearch.models.intangible_py3 +- azure.cognitiveservices.search.visualsearch.models.knowledge_request +- azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3 +- azure.cognitiveservices.search.visualsearch.models.media_object +- azure.cognitiveservices.search.visualsearch.models.media_object_py3 +- azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral +- azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3 +- azure.cognitiveservices.search.visualsearch.models.offer +- azure.cognitiveservices.search.visualsearch.models.offer_py3 +- azure.cognitiveservices.search.visualsearch.models.organization +- azure.cognitiveservices.search.visualsearch.models.organization_py3 +- azure.cognitiveservices.search.visualsearch.models.person +- azure.cognitiveservices.search.visualsearch.models.person_py3 +- azure.cognitiveservices.search.visualsearch.models.point2_d +- azure.cognitiveservices.search.visualsearch.models.point2_d_py3 +- azure.cognitiveservices.search.visualsearch.models.properties_item +- azure.cognitiveservices.search.visualsearch.models.properties_item_py3 +- azure.cognitiveservices.search.visualsearch.models.query +- azure.cognitiveservices.search.visualsearch.models.query_py3 +- azure.cognitiveservices.search.visualsearch.models.rating +- azure.cognitiveservices.search.visualsearch.models.rating_py3 +- azure.cognitiveservices.search.visualsearch.models.recipe +- azure.cognitiveservices.search.visualsearch.models.recipe_py3 +- azure.cognitiveservices.search.visualsearch.models.recipes_module +- azure.cognitiveservices.search.visualsearch.models.recipes_module_py3 +- azure.cognitiveservices.search.visualsearch.models.related_searches_module +- azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3 +- azure.cognitiveservices.search.visualsearch.models.response +- azure.cognitiveservices.search.visualsearch.models.response_base +- azure.cognitiveservices.search.visualsearch.models.response_base_py3 +- azure.cognitiveservices.search.visualsearch.models.response_py3 +- azure.cognitiveservices.search.visualsearch.models.structured_value +- azure.cognitiveservices.search.visualsearch.models.structured_value_py3 +- azure.cognitiveservices.search.visualsearch.models.thing +- azure.cognitiveservices.search.visualsearch.models.thing_py3 +- azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums +- azure.cognitiveservices.search.visualsearch.models.visual_search_request +- azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3 +enums: +- azure.cognitiveservices.search.visualsearch.models.Currency +- azure.cognitiveservices.search.visualsearch.models.ErrorCode +- azure.cognitiveservices.search.visualsearch.models.ErrorSubCode +- azure.cognitiveservices.search.visualsearch.models.ItemAvailability +- azure.cognitiveservices.search.visualsearch.models.SafeSearch diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.operations.ImagesOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.operations.ImagesOperations.yml new file mode 100644 index 00000000..22355cd5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.operations.ImagesOperations.yml @@ -0,0 +1,454 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.operations.ImagesOperations +name: ImagesOperations +fullName: azure.cognitiveservices.search.visualsearch.operations.ImagesOperations +module: azure.cognitiveservices.search.visualsearch.operations +summary: ImagesOperations operations. +constructor: + syntax: ImagesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'Activate swagger compliance. Constant value: "true".' + name: x_bing_apis_sdk +methods: +- uid: azure.cognitiveservices.search.visualsearch.operations.ImagesOperations.visual_search + name: visual_search + summary: 'Visual Search API lets you discover insights about an image such as + + visually similar images, shopping sources, and related searches. The + + API can also perform text recognition, identify entities (people, + + places, things), return other topical content for the user to explore, + + and more. For more information, see [Visual Search + + Overview](https://docs.microsoft.com/azure/cognitive-services/bing-visual-search/overview).' + signature: visual_search(accept_language=None, content_type=None, user_agent=None, + client_id=None, client_ip=None, location=None, market=None, safe_search=None, + set_lang=None, knowledge_request=None, image=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: accept_language + description: 'A comma-delimited list of one or more + + languages to use for user interface strings. The list is in decreasing + + order of preference. For additional information, including expected + + format, see + + [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). + + This header and the + + [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-visual-search-api-v7-reference#setlang) + + query parameter are mutually exclusive; do not specify both. If you + + set this header, you must also specify the + + [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-visual-search-api-v7-reference#cc) + + query parameter. To determine the market to return results for, Bing + + uses the first supported language it finds from the list and combines + + it with the cc parameter value. If the list does not include a + + supported language, Bing finds the closest language and market that + + supports the request or it uses an aggregated or default market for + + the results. To determine the market that Bing used, see the + + BingAPIs-Market header. Use this header and the cc query parameter + + only if you specify multiple languages. Otherwise, use the + + [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-visual-search-api-v7-reference#mkt) + + and + + [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-visual-search-api-v7-reference#setlang) + + query parameters. A user interface string is a string that''s used as a + + label in a user interface. There are few user interface strings in the + + JSON response objects. Any links to Bing.com properties in the + + response objects apply the specified language.' + defaultValue: None + types: + - + - name: content_type + description: 'Must be set to multipart/form-data and include a + + boundary parameter (for example, multipart/form-data; + + boundary=). For more details, see [Content form + + types]( + + [https://docs.microsoft.com/en-us/azure/cognitive-services/bing-visual-search/overview#content-form-types](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-visual-search/overview#content-form-types)).' + defaultValue: None + types: + - + - name: user_agent + description: 'The user agent originating the request. Bing uses + + the user agent to provide mobile users with an optimized experience. + + Although optional, you are encouraged to always specify this header. + + The user-agent should be the same string that any commonly used + + browser sends. For information about user agents, see [RFC + + 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The + + following are examples of user-agent strings. Windows Phone: + + Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; + + IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 + + (Linux; U; Android 2.3.5; en - us; SCH - I500 Build / GINGERBREAD) + + AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0 Mobile Safari / + + 533.1. iPhone: Mozilla / 5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) + + AppleWebKit / 536.26 (KHTML; like Gecko) Mobile / 10B142 iPhone4; 1 + + BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows NT 6.3; + + WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko. iPad: Mozilla / 5.0 + + (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1 (KHTML, like + + Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53.' + defaultValue: None + types: + - + - name: client_id + description: 'Bing uses this header to provide users with + + consistent behavior across Bing API calls. Bing often flights new + + features and improvements, and it uses the client ID as a key for + + assigning traffic on different flights. If you do not use the same + + client ID for a user across multiple requests, then Bing may assign + + the user to multiple conflicting flights. Being assigned to multiple + + conflicting flights can lead to an inconsistent user experience. For + + example, if the second request has a different flight assignment than + + the first, the experience may be unexpected. Also, Bing can use the + + client ID to tailor web results to that client ID''s search history, + + providing a richer experience for the user. Bing also uses this header + + to help improve result rankings by analyzing the activity generated by + + a client ID. The relevance improvements help with better quality of + + results delivered by Bing APIs and in turn enables higher + + click-through rates for the API consumer. IMPORTANT: Although + + optional, you should consider this header required. Persisting the + + client ID across multiple requests for the same end user and device + + combination enables 1) the API consumer to receive a consistent user + + experience, and 2) higher click-through rates via better quality of + + results from the Bing APIs. Each user that uses your application on + + the device must have a unique, Bing generated client ID. If you do not + + include this header in the request, Bing generates an ID and returns + + it in the X-MSEdge-ClientID response header. The only time that you + + should NOT include this header in a request is the first time the user + + uses your app on that device. Use the client ID for each Bing API + + request that your app makes for this user on the device. Persist the + + client ID. To persist the ID in a browser app, use a persistent HTTP + + cookie to ensure the ID is used across all sessions. Do not use a + + session cookie. For other apps such as mobile apps, use the device''s + + persistent storage to persist the ID. The next time the user uses your + + app on that device, get the client ID that you persisted. Bing + + responses may or may not include this header. If the response includes + + this header, capture the client ID and use it for all subsequent Bing + + requests for the user on that device. ATTENTION: You must ensure that + + this Client ID is not linkable to any authenticatable user account + + information. If you include the X-MSEdge-ClientID, you must not + + include cookies in the request.' + defaultValue: None + types: + - + - name: client_ip + description: 'The IPv4 or IPv6 address of the client device. The + + IP address is used to discover the user''s location. Bing uses the + + location information to determine safe search behavior. Although + + optional, you are encouraged to always specify this header and the + + X-Search-Location header. Do not obfuscate the address (for example, + + by changing the last octet to 0). Obfuscating the address results in + + the location not being anywhere near the device''s actual location, + + which may result in Bing serving erroneous results.' + defaultValue: None + types: + - + - name: location + description: 'A semicolon-delimited list of key/value pairs that + + describe the client''s geographical location. Bing uses the location + + information to determine safe search behavior and to return relevant + + local content. Specify the key/value pair as :. The + + following are the keys that you use to specify the user''s location. + + lat (required): The latitude of the client''s location, in degrees. The + + latitude must be greater than or equal to -90.0 and less than or equal + + to +90.0. Negative values indicate southern latitudes and positive + + values indicate northern latitudes. long (required): The longitude of + + the client''s location, in degrees. The longitude must be greater than + + or equal to -180.0 and less than or equal to +180.0. Negative values + + indicate western longitudes and positive values indicate eastern + + longitudes. re (required): The radius, in meters, which specifies the + + horizontal accuracy of the coordinates. Pass the value returned by the + + device''s location service. Typical values might be 22m for GPS/Wi-Fi, + + 380m for cell tower triangulation, and 18,000m for reverse IP lookup. + + ts (optional): The UTC UNIX timestamp of when the client was at the + + location. (The UNIX timestamp is the number of seconds since January + + 1, 1970.) head (optional): The client''s relative heading or direction + + of travel. Specify the direction of travel as degrees from 0 through + + 360, counting clockwise relative to true north. Specify this key only + + if the sp key is nonzero. sp (optional): The horizontal velocity + + (speed), in meters per second, that the client device is traveling. + + alt (optional): The altitude of the client device, in meters. are + + (optional): The radius, in meters, that specifies the vertical + + accuracy of the coordinates. Specify this key only if you specify the + + alt key. Although many of the keys are optional, the more information + + that you provide, the more accurate the location results are. Although + + optional, you are encouraged to always specify the user''s geographical + + location. Providing the location is especially important if the + + client''s IP address does not accurately reflect the user''s physical + + location (for example, if the client uses VPN). For optimal results, + + you should include this header and the X-MSEdge-ClientIP header, but + + at a minimum, you should include this header.' + defaultValue: None + types: + - + - name: market + description: 'The market where the results come from. Typically, mkt + + is the country where the user is making the request from. However, it + + could be a different country if the user is not located in a country + + where Bing delivers results. The market must be in the form -. For example, en-US. The string is case + + insensitive. For a list of possible market values, see [Market + + Codes](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-visual-search/supported-countries-markets). + + NOTE: If known, you are encouraged to always specify the market. + + Specifying the market helps Bing route the request and return an + + appropriate and optimal response. If you specify a market that is not + + listed in [Market + + Codes](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-visual-search/supported-countries-markets), + + Bing uses a best fit market code based on an internal mapping that is + + subject to change.' + defaultValue: None + types: + - + - name: safe_search + description: 'Filter the image results in actions with type + + ''VisualSearch'' for adult content. The following are the possible + + filter values. Off: May return images with adult content. Moderate: Do + + not return images with adult content. Strict: Do not return images + + with adult content. The default is Moderate. If the request comes from + + a market that Bing''s adult policy requires that safeSearch is set to + + Strict, Bing ignores the safeSearch value and uses Strict. If you use + + the site: filter in the knowledge request, there is the chance that + + the response may contain adult content regardless of what the + + safeSearch query parameter is set to. Use site: only if you are aware + + of the content on the site and your scenario supports the possibility + + of adult content. Possible values include: ''Off'', ''Moderate'', ''Strict''' + defaultValue: None + types: + - + - + - name: set_lang + description: 'The language to use for user interface strings. + + Specify the language using the ISO 639-1 2-letter language code. For + + example, the language code for English is EN. The default is EN + + (English). Although optional, you should always specify the language. + + Typically, you set setLang to the same language specified by mkt + + unless the user wants the user interface strings displayed in a + + different language. A user interface string is a string that''s used as + + a label in a user interface. There are few user interface strings in + + the JSON response objects. Also, any links to Bing.com properties in + + the response objects apply the specified language.' + defaultValue: None + types: + - + - name: knowledge_request + description: "The form data is a JSON object that\nidentifies the image using\ + \ an insights token or URL to the image. The\nobject may also include an optional\ + \ crop area that identifies an area\nof interest in the image. The insights\ + \ token and URL are mutually\nexclusive \u2013 do not specify both. You may\ + \ specify knowledgeRequest form\ndata and image form data in the same request\ + \ only if knowledgeRequest\nform data specifies the cropArea field only (it\ + \ must not include an\ninsights token or URL)." + defaultValue: None + types: + - + - name: image + description: 'The form data is an image binary. The + + Content-Disposition header''s name parameter must be set to "image". + + You must specify an image binary if you do not use knowledgeRequest + + form data to specify the image; you may not use both forms to specify + + an image. You may specify knowledgeRequest form data and image form + + data in the same request only if knowledgeRequest form data specifies + + the cropArea field only (it must not include an insights token or + + URL).' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageKnowledge or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.search.visualsearch.models.ErrorResponseException +attributes: +- uid: azure.cognitiveservices.search.visualsearch.operations.ImagesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.operations.images_operations.ImagesOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.operations.images_operations.ImagesOperations.yml new file mode 100644 index 00000000..fb025e03 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.operations.images_operations.ImagesOperations.yml @@ -0,0 +1,454 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.operations.images_operations.ImagesOperations +name: ImagesOperations +fullName: azure.cognitiveservices.search.visualsearch.operations.images_operations.ImagesOperations +module: azure.cognitiveservices.search.visualsearch.operations.images_operations +summary: ImagesOperations operations. +constructor: + syntax: ImagesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'Activate swagger compliance. Constant value: "true".' + name: x_bing_apis_sdk +methods: +- uid: azure.cognitiveservices.search.visualsearch.operations.images_operations.ImagesOperations.visual_search + name: visual_search + summary: 'Visual Search API lets you discover insights about an image such as + + visually similar images, shopping sources, and related searches. The + + API can also perform text recognition, identify entities (people, + + places, things), return other topical content for the user to explore, + + and more. For more information, see [Visual Search + + Overview](https://docs.microsoft.com/azure/cognitive-services/bing-visual-search/overview).' + signature: visual_search(accept_language=None, content_type=None, user_agent=None, + client_id=None, client_ip=None, location=None, market=None, safe_search=None, + set_lang=None, knowledge_request=None, image=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: accept_language + description: 'A comma-delimited list of one or more + + languages to use for user interface strings. The list is in decreasing + + order of preference. For additional information, including expected + + format, see + + [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). + + This header and the + + [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-visual-search-api-v7-reference#setlang) + + query parameter are mutually exclusive; do not specify both. If you + + set this header, you must also specify the + + [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-visual-search-api-v7-reference#cc) + + query parameter. To determine the market to return results for, Bing + + uses the first supported language it finds from the list and combines + + it with the cc parameter value. If the list does not include a + + supported language, Bing finds the closest language and market that + + supports the request or it uses an aggregated or default market for + + the results. To determine the market that Bing used, see the + + BingAPIs-Market header. Use this header and the cc query parameter + + only if you specify multiple languages. Otherwise, use the + + [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-visual-search-api-v7-reference#mkt) + + and + + [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-visual-search-api-v7-reference#setlang) + + query parameters. A user interface string is a string that''s used as a + + label in a user interface. There are few user interface strings in the + + JSON response objects. Any links to Bing.com properties in the + + response objects apply the specified language.' + defaultValue: None + types: + - + - name: content_type + description: 'Must be set to multipart/form-data and include a + + boundary parameter (for example, multipart/form-data; + + boundary=). For more details, see [Content form + + types]( + + [https://docs.microsoft.com/en-us/azure/cognitive-services/bing-visual-search/overview#content-form-types](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-visual-search/overview#content-form-types)).' + defaultValue: None + types: + - + - name: user_agent + description: 'The user agent originating the request. Bing uses + + the user agent to provide mobile users with an optimized experience. + + Although optional, you are encouraged to always specify this header. + + The user-agent should be the same string that any commonly used + + browser sends. For information about user agents, see [RFC + + 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The + + following are examples of user-agent strings. Windows Phone: + + Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; + + IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 + + (Linux; U; Android 2.3.5; en - us; SCH - I500 Build / GINGERBREAD) + + AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0 Mobile Safari / + + 533.1. iPhone: Mozilla / 5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) + + AppleWebKit / 536.26 (KHTML; like Gecko) Mobile / 10B142 iPhone4; 1 + + BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows NT 6.3; + + WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko. iPad: Mozilla / 5.0 + + (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1 (KHTML, like + + Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53.' + defaultValue: None + types: + - + - name: client_id + description: 'Bing uses this header to provide users with + + consistent behavior across Bing API calls. Bing often flights new + + features and improvements, and it uses the client ID as a key for + + assigning traffic on different flights. If you do not use the same + + client ID for a user across multiple requests, then Bing may assign + + the user to multiple conflicting flights. Being assigned to multiple + + conflicting flights can lead to an inconsistent user experience. For + + example, if the second request has a different flight assignment than + + the first, the experience may be unexpected. Also, Bing can use the + + client ID to tailor web results to that client ID''s search history, + + providing a richer experience for the user. Bing also uses this header + + to help improve result rankings by analyzing the activity generated by + + a client ID. The relevance improvements help with better quality of + + results delivered by Bing APIs and in turn enables higher + + click-through rates for the API consumer. IMPORTANT: Although + + optional, you should consider this header required. Persisting the + + client ID across multiple requests for the same end user and device + + combination enables 1) the API consumer to receive a consistent user + + experience, and 2) higher click-through rates via better quality of + + results from the Bing APIs. Each user that uses your application on + + the device must have a unique, Bing generated client ID. If you do not + + include this header in the request, Bing generates an ID and returns + + it in the X-MSEdge-ClientID response header. The only time that you + + should NOT include this header in a request is the first time the user + + uses your app on that device. Use the client ID for each Bing API + + request that your app makes for this user on the device. Persist the + + client ID. To persist the ID in a browser app, use a persistent HTTP + + cookie to ensure the ID is used across all sessions. Do not use a + + session cookie. For other apps such as mobile apps, use the device''s + + persistent storage to persist the ID. The next time the user uses your + + app on that device, get the client ID that you persisted. Bing + + responses may or may not include this header. If the response includes + + this header, capture the client ID and use it for all subsequent Bing + + requests for the user on that device. ATTENTION: You must ensure that + + this Client ID is not linkable to any authenticatable user account + + information. If you include the X-MSEdge-ClientID, you must not + + include cookies in the request.' + defaultValue: None + types: + - + - name: client_ip + description: 'The IPv4 or IPv6 address of the client device. The + + IP address is used to discover the user''s location. Bing uses the + + location information to determine safe search behavior. Although + + optional, you are encouraged to always specify this header and the + + X-Search-Location header. Do not obfuscate the address (for example, + + by changing the last octet to 0). Obfuscating the address results in + + the location not being anywhere near the device''s actual location, + + which may result in Bing serving erroneous results.' + defaultValue: None + types: + - + - name: location + description: 'A semicolon-delimited list of key/value pairs that + + describe the client''s geographical location. Bing uses the location + + information to determine safe search behavior and to return relevant + + local content. Specify the key/value pair as :. The + + following are the keys that you use to specify the user''s location. + + lat (required): The latitude of the client''s location, in degrees. The + + latitude must be greater than or equal to -90.0 and less than or equal + + to +90.0. Negative values indicate southern latitudes and positive + + values indicate northern latitudes. long (required): The longitude of + + the client''s location, in degrees. The longitude must be greater than + + or equal to -180.0 and less than or equal to +180.0. Negative values + + indicate western longitudes and positive values indicate eastern + + longitudes. re (required): The radius, in meters, which specifies the + + horizontal accuracy of the coordinates. Pass the value returned by the + + device''s location service. Typical values might be 22m for GPS/Wi-Fi, + + 380m for cell tower triangulation, and 18,000m for reverse IP lookup. + + ts (optional): The UTC UNIX timestamp of when the client was at the + + location. (The UNIX timestamp is the number of seconds since January + + 1, 1970.) head (optional): The client''s relative heading or direction + + of travel. Specify the direction of travel as degrees from 0 through + + 360, counting clockwise relative to true north. Specify this key only + + if the sp key is nonzero. sp (optional): The horizontal velocity + + (speed), in meters per second, that the client device is traveling. + + alt (optional): The altitude of the client device, in meters. are + + (optional): The radius, in meters, that specifies the vertical + + accuracy of the coordinates. Specify this key only if you specify the + + alt key. Although many of the keys are optional, the more information + + that you provide, the more accurate the location results are. Although + + optional, you are encouraged to always specify the user''s geographical + + location. Providing the location is especially important if the + + client''s IP address does not accurately reflect the user''s physical + + location (for example, if the client uses VPN). For optimal results, + + you should include this header and the X-MSEdge-ClientIP header, but + + at a minimum, you should include this header.' + defaultValue: None + types: + - + - name: market + description: 'The market where the results come from. Typically, mkt + + is the country where the user is making the request from. However, it + + could be a different country if the user is not located in a country + + where Bing delivers results. The market must be in the form -. For example, en-US. The string is case + + insensitive. For a list of possible market values, see [Market + + Codes](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-visual-search/supported-countries-markets). + + NOTE: If known, you are encouraged to always specify the market. + + Specifying the market helps Bing route the request and return an + + appropriate and optimal response. If you specify a market that is not + + listed in [Market + + Codes](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-visual-search/supported-countries-markets), + + Bing uses a best fit market code based on an internal mapping that is + + subject to change.' + defaultValue: None + types: + - + - name: safe_search + description: 'Filter the image results in actions with type + + ''VisualSearch'' for adult content. The following are the possible + + filter values. Off: May return images with adult content. Moderate: Do + + not return images with adult content. Strict: Do not return images + + with adult content. The default is Moderate. If the request comes from + + a market that Bing''s adult policy requires that safeSearch is set to + + Strict, Bing ignores the safeSearch value and uses Strict. If you use + + the site: filter in the knowledge request, there is the chance that + + the response may contain adult content regardless of what the + + safeSearch query parameter is set to. Use site: only if you are aware + + of the content on the site and your scenario supports the possibility + + of adult content. Possible values include: ''Off'', ''Moderate'', ''Strict''' + defaultValue: None + types: + - + - + - name: set_lang + description: 'The language to use for user interface strings. + + Specify the language using the ISO 639-1 2-letter language code. For + + example, the language code for English is EN. The default is EN + + (English). Although optional, you should always specify the language. + + Typically, you set setLang to the same language specified by mkt + + unless the user wants the user interface strings displayed in a + + different language. A user interface string is a string that''s used as + + a label in a user interface. There are few user interface strings in + + the JSON response objects. Also, any links to Bing.com properties in + + the response objects apply the specified language.' + defaultValue: None + types: + - + - name: knowledge_request + description: "The form data is a JSON object that\nidentifies the image using\ + \ an insights token or URL to the image. The\nobject may also include an optional\ + \ crop area that identifies an area\nof interest in the image. The insights\ + \ token and URL are mutually\nexclusive \u2013 do not specify both. You may\ + \ specify knowledgeRequest form\ndata and image form data in the same request\ + \ only if knowledgeRequest\nform data specifies the cropArea field only (it\ + \ must not include an\ninsights token or URL)." + defaultValue: None + types: + - + - name: image + description: 'The form data is an image binary. The + + Content-Disposition header''s name parameter must be set to "image". + + You must specify an image binary if you do not use knowledgeRequest + + form data to specify the image; you may not use both forms to specify + + an image. You may specify knowledgeRequest form data and image form + + data in the same request only if knowledgeRequest form data specifies + + the cropArea field only (it must not include an insights token or + + URL).' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageKnowledge or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.search.visualsearch.models.ErrorResponseException +attributes: +- uid: azure.cognitiveservices.search.visualsearch.operations.images_operations.ImagesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.operations.images_operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.operations.images_operations.yml new file mode 100644 index 00000000..0b4fab9b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.operations.images_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.operations.images_operations +name: images_operations +fullName: azure.cognitiveservices.search.visualsearch.operations.images_operations +classes: +- azure.cognitiveservices.search.visualsearch.operations.images_operations.ImagesOperations diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.operations.yml new file mode 100644 index 00000000..fe8f5762 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.operations.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.search.visualsearch.operations +name: operations +fullName: azure.cognitiveservices.search.visualsearch.operations +type: import +classes: +- azure.cognitiveservices.search.visualsearch.operations.ImagesOperations +modules: +- azure.cognitiveservices.search.visualsearch.operations.images_operations diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.version.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.version.yml new file mode 100644 index 00000000..1abac28b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.version +name: version +fullName: azure.cognitiveservices.search.visualsearch.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.visual_search_client.VisualSearchClient.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.visual_search_client.VisualSearchClient.yml new file mode 100644 index 00000000..06862c00 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.visual_search_client.VisualSearchClient.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.visual_search_client.VisualSearchClient +name: VisualSearchClient +fullName: azure.cognitiveservices.search.visualsearch.visual_search_client.VisualSearchClient +module: azure.cognitiveservices.search.visualsearch.visual_search_client +summary: Visual Search API lets you discover insights about an image such as visually + similar images, shopping sources, and related searches. The API can also perform + text recognition, identify entities (people, places, things), return other topical + content for the user to explore, and more. For more information, see [Visual Search + Overview](https://docs.microsoft.com/azure/cognitive-services/bing-visual-search/overview). +constructor: + syntax: VisualSearchClient(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and + + hostname, for example: "[https://westus.api.cognitive.microsoft.com](https://westus.api.cognitive.microsoft.com)", + + "[https://api.cognitive.microsoft.com](https://api.cognitive.microsoft.com)").' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +- description: Images operations + name: images + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.visual_search_client.VisualSearchClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.visual_search_client.VisualSearchClientConfiguration.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.visual_search_client.VisualSearchClientConfiguration.yml new file mode 100644 index 00000000..729ac882 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.visual_search_client.VisualSearchClientConfiguration.yml @@ -0,0 +1,64 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.search.visualsearch.visual_search_client.VisualSearchClientConfiguration +name: VisualSearchClientConfiguration +fullName: azure.cognitiveservices.search.visualsearch.visual_search_client.VisualSearchClientConfiguration +module: azure.cognitiveservices.search.visualsearch.visual_search_client +summary: 'Configuration for VisualSearchClient + + Note that all parameters used to create this instance are saved as instance + + attributes.' +constructor: + syntax: VisualSearchClientConfiguration(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and + + hostname, for example: "[https://westus.api.cognitive.microsoft.com](https://westus.api.cognitive.microsoft.com)", + + "[https://api.cognitive.microsoft.com](https://api.cognitive.microsoft.com)").' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.search.visualsearch.visual_search_client.VisualSearchClientConfiguration.add_user_agent + name: add_user_agent + summary: Add value to current user agent with a space. + signature: 'add_user_agent(value: str) -> None' + parameters: + - name: value + description: value to add to user agent. + isRequired: true + types: + - +- uid: azure.cognitiveservices.search.visualsearch.visual_search_client.VisualSearchClientConfiguration.load + name: load + signature: load(filepath) + parameters: + - name: filepath + isRequired: true +- uid: azure.cognitiveservices.search.visualsearch.visual_search_client.VisualSearchClientConfiguration.save + name: save + summary: Save current configuration to file. + signature: save(filepath) + parameters: + - name: filepath + description: Path to file where settings will be saved. + isRequired: true + types: + - + exceptions: + - type: ValueError if supplied filepath cannot be written to. +attributes: +- uid: azure.cognitiveservices.search.visualsearch.visual_search_client.VisualSearchClientConfiguration.enable_http_logger + name: enable_http_logger +- uid: azure.cognitiveservices.search.visualsearch.visual_search_client.VisualSearchClientConfiguration.user_agent + name: user_agent + summary: The current user agent value. diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.visual_search_client.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.visual_search_client.yml new file mode 100644 index 00000000..9b802bb3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.visual_search_client.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.search.visualsearch.visual_search_client +name: visual_search_client +fullName: azure.cognitiveservices.search.visualsearch.visual_search_client +classes: +- azure.cognitiveservices.search.visualsearch.visual_search_client.VisualSearchClient +- azure.cognitiveservices.search.visualsearch.visual_search_client.VisualSearchClientConfiguration diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.yml new file mode 100644 index 00000000..1b4c740c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.search.visualsearch +name: visualsearch +fullName: azure.cognitiveservices.search.visualsearch +type: rootImport +classes: +- azure.cognitiveservices.search.visualsearch.VisualSearchClient +packages: +- azure.cognitiveservices.search.visualsearch.models +- azure.cognitiveservices.search.visualsearch.operations +modules: +- azure.cognitiveservices.search.visualsearch.version +- azure.cognitiveservices.search.visualsearch.visual_search_client diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.ComputerVisionClient.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.ComputerVisionClient.yml new file mode 100644 index 00000000..d7eeec35 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.ComputerVisionClient.yml @@ -0,0 +1,1668 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.ComputerVisionClient +name: ComputerVisionClient +fullName: azure.cognitiveservices.vision.computervision.ComputerVisionClient +module: azure.cognitiveservices.vision.computervision +summary: The Computer Vision API provides state-of-the-art algorithms to process images + and return information. For example, it can be used to determine if an image contains + mature content, or it can be used to find all the faces in an image. It also has + other features like estimating dominant and accent colors, categorizing the content + of images, and describing an image with complete English sentences. Additionally, + it can also intelligently generate images thumbnails for displaying large images + effectively. +constructor: + syntax: ComputerVisionClient(endpoint, credentials) + parameters: + - name: endpoint + description: Supported Cognitive Services endpoints. + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +methods: +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClient.analyze_image + name: analyze_image + summary: "This operation extracts a rich set of visual features based on the\nimage\ + \ content.\nTwo input methods are supported \u2013 (1) Uploading an image or (2)\n\ + specifying an image URL. Within your request, there is an optional\nparameter\ + \ to allow you to choose which features to return. By default,\nimage categories\ + \ are returned in the response.\nA successful response will be returned in JSON.\ + \ If the request failed,\nthe response will contain an error code and a message\ + \ to help\nunderstand what went wrong." + signature: analyze_image(url, visual_features=None, details=None, language='en', + description_exclude=None, model_version='latest', custom_headers=None, raw=False, + **operation_config) + parameters: + - name: url + description: Publicly reachable URL of an image. + isRequired: true + types: + - + - name: visual_features + description: 'A string indicating what visual feature types + + to return. Multiple values should be comma-separated. Valid visual + + feature types include: Categories - categorizes image content + + according to a taxonomy defined in documentation. Tags - tags the + + image with a detailed list of words related to the image content. + + Description - describes the image content with a complete English + + sentence. Faces - detects if faces are present. If present, generate + + coordinates, gender and age. ImageType - detects if image is clipart + + or a line drawing. Color - determines the accent color, dominant + + color, and whether an image is black&white. Adult - detects if the + + image is pornographic in nature (depicts nudity or a sex act), or is + + gory (depicts extreme violence or blood). Sexually suggestive content + + (aka racy content) is also detected. Objects - detects various objects + + within an image, including the approximate location. The Objects + + argument is only available in English. Brands - detects various brands + + within an image, including the approximate location. The Brands + + argument is only available in English.' + defaultValue: None + types: + - [ + - ] + - name: details + description: 'A string indicating which domain-specific details to + + return. Multiple values should be comma-separated. Valid visual + + feature types include: Celebrities - identifies celebrities if + + detected in the image, Landmarks - identifies notable landmarks in the + + image.' + defaultValue: None + types: + - [ + - ] + - name: language + description: 'The desired language for output generation. If this + + parameter is not specified, the default value is + + "en".Supported languages:en - English, Default. es - + + Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. + + Possible values include: ''en'', ''es'', ''ja'', ''pt'', ''zh''' + defaultValue: en + types: + - + - name: description_exclude + description: 'Turn off specified domain models when + + generating the description.' + defaultValue: None + types: + - [ + - ] + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageAnalysis or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClient.analyze_image_by_domain + name: analyze_image_by_domain + summary: "This operation recognizes content within an image by applying a\ndomain-specific\ + \ model. The list of domain-specific models that are\nsupported by the Computer\ + \ Vision API can be retrieved using the /models\nGET request. Currently, the API\ + \ provides following domain-specific\nmodels: celebrities, landmarks.\nTwo input\ + \ methods are supported \u2013 (1) Uploading an image or (2)\nspecifying an image\ + \ URL.\nA successful response will be returned in JSON.\nIf the request failed,\ + \ the response will contain an error code and a\nmessage to help understand what\ + \ went wrong." + signature: analyze_image_by_domain(model, url, language='en', model_version='latest', + custom_headers=None, raw=False, **operation_config) + parameters: + - name: model + description: The domain-specific content to recognize. + isRequired: true + types: + - + - name: url + description: Publicly reachable URL of an image. + isRequired: true + types: + - + - name: language + description: 'The desired language for output generation. If this + + parameter is not specified, the default value is + + "en".Supported languages:en - English, Default. es - + + Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. + + Possible values include: ''en'', ''es'', ''ja'', ''pt'', ''zh''' + defaultValue: en + types: + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DomainModelResults or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClient.analyze_image_by_domain_in_stream + name: analyze_image_by_domain_in_stream + summary: "This operation recognizes content within an image by applying a\ndomain-specific\ + \ model. The list of domain-specific models that are\nsupported by the Computer\ + \ Vision API can be retrieved using the /models\nGET request. Currently, the API\ + \ provides following domain-specific\nmodels: celebrities, landmarks.\nTwo input\ + \ methods are supported \u2013 (1) Uploading an image or (2)\nspecifying an image\ + \ URL.\nA successful response will be returned in JSON.\nIf the request failed,\ + \ the response will contain an error code and a\nmessage to help understand what\ + \ went wrong." + signature: analyze_image_by_domain_in_stream(model, image, language='en', model_version='latest', + custom_headers=None, raw=False, callback=None, **operation_config) + parameters: + - name: model + description: The domain-specific content to recognize. + isRequired: true + types: + - + - name: image + description: An image stream. + isRequired: true + types: + - + - name: language + description: 'The desired language for output generation. If this + + parameter is not specified, the default value is + + "en".Supported languages:en - English, Default. es - + + Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. + + Possible values include: ''en'', ''es'', ''ja'', ''pt'', ''zh''' + defaultValue: en + types: + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DomainModelResults or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClient.analyze_image_in_stream + name: analyze_image_in_stream + summary: "This operation extracts a rich set of visual features based on the\nimage\ + \ content.\nTwo input methods are supported \u2013 (1) Uploading an image or (2)\n\ + specifying an image URL. Within your request, there is an optional\nparameter\ + \ to allow you to choose which features to return. By default,\nimage categories\ + \ are returned in the response.\nA successful response will be returned in JSON.\ + \ If the request failed,\nthe response will contain an error code and a message\ + \ to help\nunderstand what went wrong." + signature: analyze_image_in_stream(image, visual_features=None, details=None, language='en', + description_exclude=None, model_version='latest', custom_headers=None, raw=False, + callback=None, **operation_config) + parameters: + - name: image + description: An image stream. + isRequired: true + types: + - + - name: visual_features + description: 'A string indicating what visual feature types + + to return. Multiple values should be comma-separated. Valid visual + + feature types include: Categories - categorizes image content + + according to a taxonomy defined in documentation. Tags - tags the + + image with a detailed list of words related to the image content. + + Description - describes the image content with a complete English + + sentence. Faces - detects if faces are present. If present, generate + + coordinates, gender and age. ImageType - detects if image is clipart + + or a line drawing. Color - determines the accent color, dominant + + color, and whether an image is black&white. Adult - detects if the + + image is pornographic in nature (depicts nudity or a sex act), or is + + gory (depicts extreme violence or blood). Sexually suggestive content + + (aka racy content) is also detected. Objects - detects various objects + + within an image, including the approximate location. The Objects + + argument is only available in English. Brands - detects various brands + + within an image, including the approximate location. The Brands + + argument is only available in English.' + defaultValue: None + types: + - [ + - ] + - name: details + description: 'A string indicating which domain-specific details to + + return. Multiple values should be comma-separated. Valid visual + + feature types include: Celebrities - identifies celebrities if + + detected in the image, Landmarks - identifies notable landmarks in the + + image.' + defaultValue: None + types: + - [ + - ] + - name: language + description: 'The desired language for output generation. If this + + parameter is not specified, the default value is + + "en".Supported languages:en - English, Default. es - + + Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. + + Possible values include: ''en'', ''es'', ''ja'', ''pt'', ''zh''' + defaultValue: en + types: + - + - name: description_exclude + description: 'Turn off specified domain models when + + generating the description.' + defaultValue: None + types: + - [ + - ] + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageAnalysis or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClient.describe_image + name: describe_image + summary: "This operation generates a description of an image in human readable\n\ + language with complete sentences. The description is based on a\ncollection of\ + \ content tags, which are also returned by the operation.\nMore than one description\ + \ can be generated for each image. Descriptions\nare ordered by their confidence\ + \ score. Descriptions may include results\nfrom celebrity and landmark domain\ + \ models, if applicable.\nTwo input methods are supported \u2013 (1) Uploading\ + \ an image or (2)\nspecifying an image URL.\nA successful response will be returned\ + \ in JSON. If the request failed,\nthe response will contain an error code and\ + \ a message to help\nunderstand what went wrong." + signature: describe_image(url, max_candidates=1, language='en', description_exclude=None, + model_version='latest', custom_headers=None, raw=False, **operation_config) + parameters: + - name: url + description: Publicly reachable URL of an image. + isRequired: true + types: + - + - name: max_candidates + description: 'Maximum number of candidate descriptions to be + + returned. The default is 1.' + defaultValue: '1' + types: + - + - name: language + description: 'The desired language for output generation. If this + + parameter is not specified, the default value is + + "en".Supported languages:en - English, Default. es - + + Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. + + Possible values include: ''en'', ''es'', ''ja'', ''pt'', ''zh''' + defaultValue: en + types: + - + - name: description_exclude + description: 'Turn off specified domain models when + + generating the description.' + defaultValue: None + types: + - [ + - ] + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageDescription or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClient.describe_image_in_stream + name: describe_image_in_stream + summary: "This operation generates a description of an image in human readable\n\ + language with complete sentences. The description is based on a\ncollection of\ + \ content tags, which are also returned by the operation.\nMore than one description\ + \ can be generated for each image. Descriptions\nare ordered by their confidence\ + \ score. Descriptions may include results\nfrom celebrity and landmark domain\ + \ models, if applicable.\nTwo input methods are supported \u2013 (1) Uploading\ + \ an image or (2)\nspecifying an image URL.\nA successful response will be returned\ + \ in JSON. If the request failed,\nthe response will contain an error code and\ + \ a message to help\nunderstand what went wrong." + signature: describe_image_in_stream(image, max_candidates=1, language='en', description_exclude=None, + model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config) + parameters: + - name: image + description: An image stream. + isRequired: true + types: + - + - name: max_candidates + description: 'Maximum number of candidate descriptions to be + + returned. The default is 1.' + defaultValue: '1' + types: + - + - name: language + description: 'The desired language for output generation. If this + + parameter is not specified, the default value is + + "en".Supported languages:en - English, Default. es - + + Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. + + Possible values include: ''en'', ''es'', ''ja'', ''pt'', ''zh''' + defaultValue: en + types: + - + - name: description_exclude + description: 'Turn off specified domain models when + + generating the description.' + defaultValue: None + types: + - [ + - ] + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageDescription or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClient.detect_objects + name: detect_objects + summary: "Performs object detection on the specified image.\nTwo input methods are\ + \ supported \u2013 (1) Uploading an image or (2)\nspecifying an image URL.\nA\ + \ successful response will be returned in JSON. If the request failed,\nthe response\ + \ will contain an error code and a message to help\nunderstand what went wrong." + signature: detect_objects(url, model_version='latest', custom_headers=None, raw=False, + **operation_config) + parameters: + - name: url + description: Publicly reachable URL of an image. + isRequired: true + types: + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DetectResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClient.detect_objects_in_stream + name: detect_objects_in_stream + summary: "Performs object detection on the specified image.\nTwo input methods are\ + \ supported \u2013 (1) Uploading an image or (2)\nspecifying an image URL.\nA\ + \ successful response will be returned in JSON. If the request failed,\nthe response\ + \ will contain an error code and a message to help\nunderstand what went wrong." + signature: detect_objects_in_stream(image, model_version='latest', custom_headers=None, + raw=False, callback=None, **operation_config) + parameters: + - name: image + description: An image stream. + isRequired: true + types: + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DetectResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClient.generate_thumbnail + name: generate_thumbnail + summary: 'This operation generates a thumbnail image with the user-specified + + width and height. By default, the service analyzes the image, + + identifies the region of interest (ROI), and generates smart cropping + + coordinates based on the ROI. Smart cropping helps when you specify an + + aspect ratio that differs from that of the input image. + + A successful response contains the thumbnail image binary. If the + + request failed, the response contains an error code and a message to + + help determine what went wrong. + + Upon failure, the error code and an error message are returned. The + + error code could be one of InvalidImageUrl, InvalidImageFormat, + + InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, + + FailedToProcess, Timeout, or InternalServerError.' + signature: generate_thumbnail(width, height, url, smart_cropping=False, model_version='latest', + custom_headers=None, raw=False, callback=None, **operation_config) + parameters: + - name: width + description: 'Width of the thumbnail, in pixels. It must be between 1 + + and 1024. Recommended minimum of 50.' + isRequired: true + types: + - + - name: height + description: 'Height of the thumbnail, in pixels. It must be between + + 1 and 1024. Recommended minimum of 50.' + isRequired: true + types: + - + - name: url + description: Publicly reachable URL of an image. + isRequired: true + types: + - + - name: smart_cropping + description: Boolean flag for enabling smart cropping. + defaultValue: 'False' + types: + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: object or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrest.exceptions.HttpOperationError +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClient.generate_thumbnail_in_stream + name: generate_thumbnail_in_stream + summary: 'This operation generates a thumbnail image with the user-specified + + width and height. By default, the service analyzes the image, + + identifies the region of interest (ROI), and generates smart cropping + + coordinates based on the ROI. Smart cropping helps when you specify an + + aspect ratio that differs from that of the input image. + + A successful response contains the thumbnail image binary. If the + + request failed, the response contains an error code and a message to + + help determine what went wrong. + + Upon failure, the error code and an error message are returned. The + + error code could be one of InvalidImageUrl, InvalidImageFormat, + + InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, + + FailedToProcess, Timeout, or InternalServerError.' + signature: generate_thumbnail_in_stream(width, height, image, smart_cropping=False, + model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config) + parameters: + - name: width + description: 'Width of the thumbnail, in pixels. It must be between 1 + + and 1024. Recommended minimum of 50.' + isRequired: true + types: + - + - name: height + description: 'Height of the thumbnail, in pixels. It must be between + + 1 and 1024. Recommended minimum of 50.' + isRequired: true + types: + - + - name: image + description: An image stream. + isRequired: true + types: + - + - name: smart_cropping + description: Boolean flag for enabling smart cropping. + defaultValue: 'False' + types: + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: object or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrest.exceptions.HttpOperationError +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClient.get_area_of_interest + name: get_area_of_interest + summary: 'This operation returns a bounding box around the most important area of + + the image. + + A successful response will be returned in JSON. If the request failed, + + the response contains an error code and a message to help determine + + what went wrong. + + Upon failure, the error code and an error message are returned. The + + error code could be one of InvalidImageUrl, InvalidImageFormat, + + InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or + + InternalServerError.' + signature: get_area_of_interest(url, model_version='latest', custom_headers=None, + raw=False, **operation_config) + parameters: + - name: url + description: Publicly reachable URL of an image. + isRequired: true + types: + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: AreaOfInterestResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClient.get_area_of_interest_in_stream + name: get_area_of_interest_in_stream + summary: 'This operation returns a bounding box around the most important area of + + the image. + + A successful response will be returned in JSON. If the request failed, + + the response contains an error code and a message to help determine + + what went wrong. + + Upon failure, the error code and an error message are returned. The + + error code could be one of InvalidImageUrl, InvalidImageFormat, + + InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or + + InternalServerError.' + signature: get_area_of_interest_in_stream(image, model_version='latest', custom_headers=None, + raw=False, callback=None, **operation_config) + parameters: + - name: image + description: An image stream. + isRequired: true + types: + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: AreaOfInterestResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClient.get_read_result + name: get_read_result + summary: 'This interface is used for getting OCR results of Read operation. The + + URL to this interface should be retrieved from ''Operation-Location'' + + field returned from Read interface.' + signature: get_read_result(operation_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: operation_id + description: 'Id of read operation returned in the response of + + the ''Read'' interface.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ReadOperationResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrErrorException +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClient.list_models + name: list_models + summary: 'This operation returns the list of domain-specific models that are + + supported by the Computer Vision API. Currently, the API supports + + following domain-specific models: celebrity recognizer, landmark + + recognizer. + + A successful response will be returned in JSON. If the request failed, + + the response will contain an error code and a message to help + + understand what went wrong.' + signature: list_models(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ListModelsResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClient.read + name: read + summary: "Use this interface to get the result of a Read operation, employing the\n\ + state-of-the-art Optical Character Recognition (OCR) algorithms\noptimized for\ + \ text-heavy documents. When you use the Read interface,\nthe response contains\ + \ a field called 'Operation-Location'. The\n'Operation-Location' field contains\ + \ the URL that you must use for your\n'GetReadResult' operation to access OCR\ + \ results.\u200B." + signature: read(url, language=None, pages=None, model_version='latest', reading_order='basic', + custom_headers=None, raw=False, **operation_config) + parameters: + - name: url + description: Publicly reachable URL of an image. + isRequired: true + types: + - + - name: language + description: 'The BCP-47 language code of the text in the document. + + Read supports auto language identification and multi-language + + documents, so only provide a language code if you would like to force + + the document to be processed in that specific language. See + + [https://aka.ms/ocr-languages](https://aka.ms/ocr-languages) for list of supported + languages. Possible + + values include: ''af'', ''ast'', ''bi'', ''br'', ''ca'', ''ceb'', ''ch'', ''co'', + + ''crh'', ''cs'', ''csb'', ''da'', ''de'', ''en'', ''es'', ''et'', ''eu'', ''fi'', + ''fil'', + + ''fj'', ''fr'', ''fur'', ''fy'', ''ga'', ''gd'', ''gil'', ''gl'', ''gv'', ''hni'', + ''hsb'', + + ''ht'', ''hu'', ''ia'', ''id'', ''it'', ''iu'', ''ja'', ''jv'', ''kaa'', ''kac'', + ''kea'', + + ''kha'', ''kl'', ''ko'', ''ku'', ''kw'', ''lb'', ''ms'', ''mww'', ''nap'', ''nl'', + ''no'', + + ''oc'', ''pl'', ''pt'', ''quc'', ''rm'', ''sco'', ''sl'', ''sq'', ''sv'', ''sw'', + ''tet'', + + ''tr'', ''tt'', ''uz'', ''vo'', ''wae'', ''yua'', ''za'', ''zh-Hans'', ''zh-Hant'', + ''zu''' + defaultValue: None + types: + - + - + - name: pages + description: 'Custom page numbers for multi-page documents(PDF/TIFF), + + input the number of the pages you want to get OCR result. For a range + + of pages, use a hyphen. Separate each page or range with a comma.' + defaultValue: None + types: + - [] + - name: model_version + description: 'Optional parameter to specify the version of the + + OCR model used for text extraction. Accepted values are: "latest", + + "latest-preview", "2021-04-12". Defaults to "latest".' + defaultValue: latest + types: + - + - name: reading_order + description: 'Optional parameter to specify which reading + + order algorithm should be applied when ordering the extract text + + elements. Can be either ''basic'' or ''natural''. Will default to ''basic'' + + if not specified' + defaultValue: basic + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrErrorException +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClient.read_in_stream + name: read_in_stream + summary: "Use this interface to get the result of a Read operation, employing the\n\ + state-of-the-art Optical Character Recognition (OCR) algorithms\noptimized for\ + \ text-heavy documents. When you use the Read interface,\nthe response contains\ + \ a field called 'Operation-Location'. The\n'Operation-Location' field contains\ + \ the URL that you must use for your\n'GetReadResult' operation to access OCR\ + \ results.\u200B." + signature: read_in_stream(image, language=None, pages=None, model_version='latest', + reading_order='basic', custom_headers=None, raw=False, callback=None, **operation_config) + parameters: + - name: image + description: An image stream. + isRequired: true + types: + - + - name: language + description: 'The BCP-47 language code of the text in the document. + + Read supports auto language identification and multi-language + + documents, so only provide a language code if you would like to force + + the document to be processed in that specific language. See + + [https://aka.ms/ocr-languages](https://aka.ms/ocr-languages) for list of supported + languages. Possible + + values include: ''af'', ''ast'', ''bi'', ''br'', ''ca'', ''ceb'', ''ch'', ''co'', + + ''crh'', ''cs'', ''csb'', ''da'', ''de'', ''en'', ''es'', ''et'', ''eu'', ''fi'', + ''fil'', + + ''fj'', ''fr'', ''fur'', ''fy'', ''ga'', ''gd'', ''gil'', ''gl'', ''gv'', ''hni'', + ''hsb'', + + ''ht'', ''hu'', ''ia'', ''id'', ''it'', ''iu'', ''ja'', ''jv'', ''kaa'', ''kac'', + ''kea'', + + ''kha'', ''kl'', ''ko'', ''ku'', ''kw'', ''lb'', ''ms'', ''mww'', ''nap'', ''nl'', + ''no'', + + ''oc'', ''pl'', ''pt'', ''quc'', ''rm'', ''sco'', ''sl'', ''sq'', ''sv'', ''sw'', + ''tet'', + + ''tr'', ''tt'', ''uz'', ''vo'', ''wae'', ''yua'', ''za'', ''zh-Hans'', ''zh-Hant'', + ''zu''' + defaultValue: None + types: + - + - + - name: pages + description: 'Custom page numbers for multi-page documents(PDF/TIFF), + + input the number of the pages you want to get OCR result. For a range + + of pages, use a hyphen. Separate each page or range with a comma.' + defaultValue: None + types: + - [] + - name: model_version + description: 'Optional parameter to specify the version of the + + OCR model used for text extraction. Accepted values are: "latest", + + "latest-preview", "2021-04-12". Defaults to "latest".' + defaultValue: latest + types: + - + - name: reading_order + description: 'Optional parameter to specify which reading + + order algorithm should be applied when ordering the extract text + + elements. Can be either ''basic'' or ''natural''. Will default to ''basic'' + + if not specified' + defaultValue: basic + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrErrorException +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClient.recognize_printed_text + name: recognize_printed_text + summary: 'Optical Character Recognition (OCR) detects text in an image and + + extracts the recognized characters into a machine-usable character + + stream. + + Upon success, the OCR results will be returned. + + Upon failure, the error code together with an error message will be + + returned. The error code can be one of InvalidImageUrl, + + InvalidImageFormat, InvalidImageSize, NotSupportedImage, + + NotSupportedLanguage, or InternalServerError.' + signature: recognize_printed_text(url, detect_orientation=True, language='unk', + model_version='latest', custom_headers=None, raw=False, **operation_config) + parameters: + - name: detect_orientation + description: 'Whether detect the text orientation in the + + image. With detectOrientation=true the OCR service tries to detect the + + image orientation and correct it before further processing (e.g. if + + it''s upside-down).' + defaultValue: 'True' + types: + - + - name: url + description: Publicly reachable URL of an image. + isRequired: true + types: + - + - name: language + description: 'The BCP-47 language code of the text to be detected + + in the image. The default value is ''unk''. Possible values include: + + ''unk'', ''zh-Hans'', ''zh-Hant'', ''cs'', ''da'', ''nl'', ''en'', ''fi'', ''fr'', + ''de'', + + ''el'', ''hu'', ''it'', ''ja'', ''ko'', ''nb'', ''pl'', ''pt'', ''ru'', ''es'', + ''sv'', + + ''tr'', ''ar'', ''ro'', ''sr-Cyrl'', ''sr-Latn'', ''sk''' + defaultValue: unk + types: + - + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OcrResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClient.recognize_printed_text_in_stream + name: recognize_printed_text_in_stream + summary: 'Optical Character Recognition (OCR) detects text in an image and + + extracts the recognized characters into a machine-usable character + + stream. + + Upon success, the OCR results will be returned. + + Upon failure, the error code together with an error message will be + + returned. The error code can be one of InvalidImageUrl, + + InvalidImageFormat, InvalidImageSize, NotSupportedImage, + + NotSupportedLanguage, or InternalServerError.' + signature: recognize_printed_text_in_stream(image, detect_orientation=True, language='unk', + model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config) + parameters: + - name: detect_orientation + description: 'Whether detect the text orientation in the + + image. With detectOrientation=true the OCR service tries to detect the + + image orientation and correct it before further processing (e.g. if + + it''s upside-down).' + defaultValue: 'True' + types: + - + - name: image + description: An image stream. + isRequired: true + types: + - + - name: language + description: 'The BCP-47 language code of the text to be detected + + in the image. The default value is ''unk''. Possible values include: + + ''unk'', ''zh-Hans'', ''zh-Hant'', ''cs'', ''da'', ''nl'', ''en'', ''fi'', ''fr'', + ''de'', + + ''el'', ''hu'', ''it'', ''ja'', ''ko'', ''nb'', ''pl'', ''pt'', ''ru'', ''es'', + ''sv'', + + ''tr'', ''ar'', ''ro'', ''sr-Cyrl'', ''sr-Latn'', ''sk''' + defaultValue: unk + types: + - + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OcrResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClient.tag_image + name: tag_image + summary: "This operation generates a list of words, or tags, that are relevant to\n\ + the content of the supplied image. The Computer Vision API can return\ntags based\ + \ on objects, living beings, scenery or actions found in\nimages. Unlike categories,\ + \ tags are not organized according to a\nhierarchical classification system, but\ + \ correspond to image content.\nTags may contain hints to avoid ambiguity or provide\ + \ context, for\nexample the tag \"ascomycete\" may be accompanied by the hint\ + \ \"fungus\".\nTwo input methods are supported \u2013 (1) Uploading an image or\ + \ (2)\nspecifying an image URL.\nA successful response will be returned in JSON.\ + \ If the request failed,\nthe response will contain an error code and a message\ + \ to help\nunderstand what went wrong." + signature: tag_image(url, language='en', model_version='latest', custom_headers=None, + raw=False, **operation_config) + parameters: + - name: url + description: Publicly reachable URL of an image. + isRequired: true + types: + - + - name: language + description: 'The desired language for output generation. If this + + parameter is not specified, the default value is + + "en".Supported languages:en - English, Default. es - + + Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. + + Possible values include: ''en'', ''es'', ''ja'', ''pt'', ''zh''' + defaultValue: en + types: + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: TagResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClient.tag_image_in_stream + name: tag_image_in_stream + summary: "This operation generates a list of words, or tags, that are relevant to\n\ + the content of the supplied image. The Computer Vision API can return\ntags based\ + \ on objects, living beings, scenery or actions found in\nimages. Unlike categories,\ + \ tags are not organized according to a\nhierarchical classification system, but\ + \ correspond to image content.\nTags may contain hints to avoid ambiguity or provide\ + \ context, for\nexample the tag \"ascomycete\" may be accompanied by the hint\ + \ \"fungus\".\nTwo input methods are supported \u2013 (1) Uploading an image or\ + \ (2)\nspecifying an image URL.\nA successful response will be returned in JSON.\ + \ If the request failed,\nthe response will contain an error code and a message\ + \ to help\nunderstand what went wrong." + signature: tag_image_in_stream(image, language='en', model_version='latest', custom_headers=None, + raw=False, callback=None, **operation_config) + parameters: + - name: image + description: An image stream. + isRequired: true + types: + - + - name: language + description: 'The desired language for output generation. If this + + parameter is not specified, the default value is + + "en".Supported languages:en - English, Default. es - + + Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. + + Possible values include: ''en'', ''es'', ''ja'', ''pt'', ''zh''' + defaultValue: en + types: + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: TagResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.ComputerVisionClientConfiguration.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.ComputerVisionClientConfiguration.yml new file mode 100644 index 00000000..55b8925d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.ComputerVisionClientConfiguration.yml @@ -0,0 +1,60 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.ComputerVisionClientConfiguration +name: ComputerVisionClientConfiguration +fullName: azure.cognitiveservices.vision.computervision.ComputerVisionClientConfiguration +module: azure.cognitiveservices.vision.computervision +summary: 'Configuration for ComputerVisionClient + + Note that all parameters used to create this instance are saved as instance + + attributes.' +constructor: + syntax: ComputerVisionClientConfiguration(endpoint, credentials) + parameters: + - name: endpoint + description: Supported Cognitive Services endpoints. + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClientConfiguration.add_user_agent + name: add_user_agent + summary: Add value to current user agent with a space. + signature: 'add_user_agent(value: str) -> None' + parameters: + - name: value + description: value to add to user agent. + isRequired: true + types: + - +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClientConfiguration.load + name: load + signature: load(filepath) + parameters: + - name: filepath + isRequired: true +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClientConfiguration.save + name: save + summary: Save current configuration to file. + signature: save(filepath) + parameters: + - name: filepath + description: Path to file where settings will be saved. + isRequired: true + types: + - + exceptions: + - type: ValueError if supplied filepath cannot be written to. +attributes: +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClientConfiguration.enable_http_logger + name: enable_http_logger +- uid: azure.cognitiveservices.vision.computervision.ComputerVisionClientConfiguration.user_agent + name: user_agent + summary: The current user agent value. diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.AdultInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.AdultInfo.yml new file mode 100644 index 00000000..1765fcba --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.AdultInfo.yml @@ -0,0 +1,168 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.AdultInfo +name: AdultInfo +fullName: azure.cognitiveservices.vision.computervision.models.AdultInfo +module: azure.cognitiveservices.vision.computervision.models +summary: 'An object describing whether the image contains adult-oriented content + + and/or is racy.' +constructor: + syntax: 'AdultInfo(*, is_adult_content: bool = None, is_racy_content: bool = None, + is_gory_content: bool = None, adult_score: float = None, racy_score: float = None, + gore_score: float = None, **kwargs)' + parameters: + - name: is_adult_content + description: 'A value indicating if the image contains + + adult-oriented content.' + isRequired: true + types: + - + - name: is_racy_content + description: A value indicating if the image is racy. + isRequired: true + types: + - + - name: is_gory_content + description: A value indicating if the image is gory. + isRequired: true + types: + - + - name: adult_score + description: 'Score from 0 to 1 that indicates how much the content + + is considered adult-oriented within the image.' + isRequired: true + types: + - + - name: racy_score + description: 'Score from 0 to 1 that indicates how suggestive is the + + image.' + isRequired: true + types: + - + - name: gore_score + description: Score from 0 to 1 that indicates how gory is the image. + isRequired: true + types: + - + keywordOnlyParameters: + - name: is_adult_content + isRequired: true + - name: is_racy_content + isRequired: true + - name: is_gory_content + isRequired: true + - name: adult_score + isRequired: true + - name: racy_score + isRequired: true + - name: gore_score + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.AdultInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.AdultInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.AdultInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.AdultInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.AdultInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.AdultInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.AdultInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.AnalyzeResults.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.AnalyzeResults.yml new file mode 100644 index 00000000..c768869b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.AnalyzeResults.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.AnalyzeResults +name: AnalyzeResults +fullName: azure.cognitiveservices.vision.computervision.models.AnalyzeResults +module: azure.cognitiveservices.vision.computervision.models +summary: 'Analyze batch operation result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AnalyzeResults(*, version: str, model_version: str, read_results, **kwargs)' + parameters: + - name: version + description: Required. Version of schema used for this result. + isRequired: true + types: + - + - name: model_version + description: 'Required. Version of the OCR model used for text + + extraction.' + isRequired: true + types: + - + - name: read_results + description: Required. Text extracted from the input. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: version + isRequired: true + - name: model_version + isRequired: true + - name: read_results + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.AnalyzeResults.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.AnalyzeResults.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.AnalyzeResults.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.AnalyzeResults.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.AnalyzeResults.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.AnalyzeResults.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.AnalyzeResults.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Appearance.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Appearance.yml new file mode 100644 index 00000000..f2c4670d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Appearance.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.Appearance +name: Appearance +fullName: azure.cognitiveservices.vision.computervision.models.Appearance +module: azure.cognitiveservices.vision.computervision.models +summary: 'An object representing the appearance of the text line. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Appearance(*, style, **kwargs) + parameters: + - name: style + description: Required. An object representing the style of the text line. + isRequired: true + types: + - + keywordOnlyParameters: + - name: style + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.Appearance.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.Appearance.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.Appearance.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.Appearance.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.Appearance.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.Appearance.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.Appearance.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.AreaOfInterestResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.AreaOfInterestResult.yml new file mode 100644 index 00000000..a1e97f5b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.AreaOfInterestResult.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.AreaOfInterestResult +name: AreaOfInterestResult +fullName: azure.cognitiveservices.vision.computervision.models.AreaOfInterestResult +module: azure.cognitiveservices.vision.computervision.models +summary: 'Result of AreaOfInterest operation. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'AreaOfInterestResult(*, request_id: str = None, metadata=None, model_version: + str = None, **kwargs)' + parameters: + - name: request_id + description: Id of the REST API request. + isRequired: true + types: + - + - name: metadata + isRequired: true + types: + - + - name: model_version + isRequired: true + types: + - + keywordOnlyParameters: + - name: request_id + isRequired: true + - name: metadata + isRequired: true + - name: model_version + isRequired: true +variables: +- description: 'A bounding box for an area of interest inside an + + image.' + name: area_of_interest + types: + - +methods: +- uid: azure.cognitiveservices.vision.computervision.models.AreaOfInterestResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.AreaOfInterestResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.AreaOfInterestResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.AreaOfInterestResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.AreaOfInterestResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.AreaOfInterestResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.AreaOfInterestResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.BoundingRect.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.BoundingRect.yml new file mode 100644 index 00000000..ab910eac --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.BoundingRect.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.BoundingRect +name: BoundingRect +fullName: azure.cognitiveservices.vision.computervision.models.BoundingRect +module: azure.cognitiveservices.vision.computervision.models +summary: A bounding box for an area inside an image. +constructor: + syntax: 'BoundingRect(*, x: int = None, y: int = None, w: int = None, h: int = None, + **kwargs)' + parameters: + - name: x + description: X-coordinate of the top left point of the area, in pixels. + isRequired: true + types: + - + - name: y + description: Y-coordinate of the top left point of the area, in pixels. + isRequired: true + types: + - + - name: w + description: Width measured from the top-left point of the area, in pixels. + isRequired: true + types: + - + - name: h + description: Height measured from the top-left point of the area, in pixels. + isRequired: true + types: + - + keywordOnlyParameters: + - name: x + isRequired: true + - name: y + isRequired: true + - name: w + isRequired: true + - name: h + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.BoundingRect.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.BoundingRect.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.BoundingRect.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.BoundingRect.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.BoundingRect.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.BoundingRect.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.BoundingRect.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Category.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Category.yml new file mode 100644 index 00000000..61977d3f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Category.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.Category +name: Category +fullName: azure.cognitiveservices.vision.computervision.models.Category +module: azure.cognitiveservices.vision.computervision.models +summary: An object describing identified category. +constructor: + syntax: 'Category(*, name: str = None, score: float = None, detail=None, **kwargs)' + parameters: + - name: name + description: Name of the category. + isRequired: true + types: + - + - name: score + description: Scoring of the category. + isRequired: true + types: + - + - name: detail + description: Details of the identified category. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: score + isRequired: true + - name: detail + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.Category.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.Category.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.Category.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.Category.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.Category.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.Category.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.Category.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.CategoryDetail.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.CategoryDetail.yml new file mode 100644 index 00000000..036fc249 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.CategoryDetail.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.CategoryDetail +name: CategoryDetail +fullName: azure.cognitiveservices.vision.computervision.models.CategoryDetail +module: azure.cognitiveservices.vision.computervision.models +summary: An object describing additional category details. +constructor: + syntax: CategoryDetail(*, celebrities=None, landmarks=None, **kwargs) + parameters: + - name: celebrities + description: An array of celebrities if any identified. + isRequired: true + types: + - [] + - name: landmarks + description: An array of landmarks if any identified. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: celebrities + isRequired: true + - name: landmarks + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.CategoryDetail.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.CategoryDetail.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.CategoryDetail.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.CategoryDetail.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.CategoryDetail.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.CategoryDetail.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.CategoryDetail.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.CelebritiesModel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.CelebritiesModel.yml new file mode 100644 index 00000000..dcef0f01 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.CelebritiesModel.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.CelebritiesModel +name: CelebritiesModel +fullName: azure.cognitiveservices.vision.computervision.models.CelebritiesModel +module: azure.cognitiveservices.vision.computervision.models +summary: An object describing possible celebrity identification. +constructor: + syntax: 'CelebritiesModel(*, name: str = None, confidence: float = None, face_rectangle=None, + **kwargs)' + parameters: + - name: name + description: Name of the celebrity. + isRequired: true + types: + - + - name: confidence + description: 'Confidence level for the celebrity recognition as a + + value ranging from 0 to 1.' + isRequired: true + types: + - + - name: face_rectangle + description: Location of the identified face in the image. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: confidence + isRequired: true + - name: face_rectangle + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.CelebritiesModel.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.CelebritiesModel.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.CelebritiesModel.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.CelebritiesModel.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.CelebritiesModel.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.CelebritiesModel.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.CelebritiesModel.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ColorInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ColorInfo.yml new file mode 100644 index 00000000..149d1ecc --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ColorInfo.yml @@ -0,0 +1,153 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.ColorInfo +name: ColorInfo +fullName: azure.cognitiveservices.vision.computervision.models.ColorInfo +module: azure.cognitiveservices.vision.computervision.models +summary: An object providing additional metadata describing color attributes. +constructor: + syntax: 'ColorInfo(*, dominant_color_foreground: str = None, dominant_color_background: + str = None, dominant_colors=None, accent_color: str = None, is_bw_img: bool = + None, **kwargs)' + parameters: + - name: dominant_color_foreground + description: Possible dominant foreground color. + isRequired: true + types: + - + - name: dominant_color_background + description: Possible dominant background color. + isRequired: true + types: + - + - name: dominant_colors + description: An array of possible dominant colors. + isRequired: true + types: + - [] + - name: accent_color + description: Possible accent color. + isRequired: true + types: + - + - name: is_bw_img + description: A value indicating if the image is black and white. + isRequired: true + types: + - + keywordOnlyParameters: + - name: dominant_color_foreground + isRequired: true + - name: dominant_color_background + isRequired: true + - name: dominant_colors + isRequired: true + - name: accent_color + isRequired: true + - name: is_bw_img + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.ColorInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ColorInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ColorInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.ColorInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ColorInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.ColorInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ColorInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionError.yml new file mode 100644 index 00000000..9ea819d6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionError.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionError +name: ComputerVisionError +fullName: azure.cognitiveservices.vision.computervision.models.ComputerVisionError +module: azure.cognitiveservices.vision.computervision.models +summary: 'The API request error. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ComputerVisionError(*, code, message: str, innererror=None, **kwargs)' + parameters: + - name: code + description: 'Required. The error code. Possible values include: + + ''InvalidRequest'', ''InvalidArgument'', ''InternalServerError'', + + ''ServiceUnavailable''' + isRequired: true + types: + - + - + - name: message + description: 'Required. A message explaining the error reported by the + + service.' + isRequired: true + types: + - + - name: innererror + description: Inner error contains more specific information. + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true + - name: innererror + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorCodes.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorCodes.yml new file mode 100644 index 00000000..5d43d0e4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorCodes.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorCodes +name: ComputerVisionErrorCodes +fullName: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorCodes +module: azure.cognitiveservices.vision.computervision.models +fields: +- name: internal_server_error + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorCodes.internal_server_error +- name: invalid_argument + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorCodes.invalid_argument +- name: invalid_request + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorCodes.invalid_request +- name: service_unavailable + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorCodes.service_unavailable diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponse.yml new file mode 100644 index 00000000..044b72ab --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponse.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponse +name: ComputerVisionErrorResponse +fullName: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponse +module: azure.cognitiveservices.vision.computervision.models +summary: 'The API error response. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ComputerVisionErrorResponse(*, error, **kwargs) + parameters: + - name: error + description: Required. Error contents. + isRequired: true + types: + - + keywordOnlyParameters: + - name: error + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException.yml new file mode 100644 index 00000000..49bc1b20 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +name: ComputerVisionErrorResponseException +fullName: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +module: azure.cognitiveservices.vision.computervision.models +summary: 'Server responded with exception of type: ''ComputerVisionErrorResponse''.' +constructor: + syntax: ComputerVisionErrorResponseException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException.args + name: args diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerError.yml new file mode 100644 index 00000000..ca3c2830 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerError.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerError +name: ComputerVisionInnerError +fullName: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerError +module: azure.cognitiveservices.vision.computervision.models +summary: 'Details about the API request error. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ComputerVisionInnerError(*, code, message: str, **kwargs)' + parameters: + - name: code + description: 'Required. The error code. Possible values include: + + ''InvalidImageFormat'', ''UnsupportedMediaType'', ''InvalidImageUrl'', + + ''NotSupportedFeature'', ''NotSupportedImage'', ''Timeout'', + + ''InternalServerError'', ''InvalidImageSize'', ''BadArgument'', + + ''DetectFaceError'', ''NotSupportedLanguage'', ''InvalidThumbnailSize'', + + ''InvalidDetails'', ''InvalidModel'', ''CancelledRequest'', + + ''NotSupportedVisualFeature'', ''FailedToProcess'', ''Unspecified'', + + ''StorageException''' + isRequired: true + types: + - + - + - name: message + description: Required. Error message. + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue.yml new file mode 100644 index 00000000..6332ef97 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue.yml @@ -0,0 +1,44 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue +name: ComputerVisionInnerErrorCodeValue +fullName: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue +module: azure.cognitiveservices.vision.computervision.models +fields: +- name: bad_argument + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue.bad_argument +- name: cancelled_request + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue.cancelled_request +- name: detect_face_error + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue.detect_face_error +- name: failed_to_process + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue.failed_to_process +- name: internal_server_error + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue.internal_server_error +- name: invalid_details + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue.invalid_details +- name: invalid_image_format + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue.invalid_image_format +- name: invalid_image_size + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue.invalid_image_size +- name: invalid_image_url + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue.invalid_image_url +- name: invalid_model + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue.invalid_model +- name: invalid_thumbnail_size + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue.invalid_thumbnail_size +- name: not_supported_feature + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue.not_supported_feature +- name: not_supported_image + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue.not_supported_image +- name: not_supported_language + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue.not_supported_language +- name: not_supported_visual_feature + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue.not_supported_visual_feature +- name: storage_exception + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue.storage_exception +- name: timeout + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue.timeout +- name: unspecified + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue.unspecified +- name: unsupported_media_type + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue.unsupported_media_type diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrError.yml new file mode 100644 index 00000000..04c780e3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrError.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrError +name: ComputerVisionOcrError +fullName: azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrError +module: azure.cognitiveservices.vision.computervision.models +summary: 'Details about the API request error. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ComputerVisionOcrError(*, code, message: str, request_id: str = None, **kwargs)' + parameters: + - name: code + description: Required. The error code. + isRequired: true + types: + - + - name: message + description: 'Required. A message explaining the error reported by the + + service.' + isRequired: true + types: + - + - name: request_id + description: A unique request identifier. + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true + - name: request_id + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrErrorException.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrErrorException.yml new file mode 100644 index 00000000..0e5d9b86 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrErrorException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrErrorException +name: ComputerVisionOcrErrorException +fullName: azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrErrorException +module: azure.cognitiveservices.vision.computervision.models +summary: 'Server responded with exception of type: ''ComputerVisionOcrError''.' +constructor: + syntax: ComputerVisionOcrErrorException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrErrorException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrErrorException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrErrorException.args + name: args diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DescriptionExclude.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DescriptionExclude.yml new file mode 100644 index 00000000..2637ff52 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DescriptionExclude.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.computervision.models.DescriptionExclude +name: DescriptionExclude +fullName: azure.cognitiveservices.vision.computervision.models.DescriptionExclude +module: azure.cognitiveservices.vision.computervision.models +fields: +- name: celebrities + uid: azure.cognitiveservices.vision.computervision.models.DescriptionExclude.celebrities +- name: landmarks + uid: azure.cognitiveservices.vision.computervision.models.DescriptionExclude.landmarks diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Details.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Details.yml new file mode 100644 index 00000000..ec9f00da --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Details.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.computervision.models.Details +name: Details +fullName: azure.cognitiveservices.vision.computervision.models.Details +module: azure.cognitiveservices.vision.computervision.models +fields: +- name: celebrities + uid: azure.cognitiveservices.vision.computervision.models.Details.celebrities +- name: landmarks + uid: azure.cognitiveservices.vision.computervision.models.Details.landmarks diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DetectResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DetectResult.yml new file mode 100644 index 00000000..a0d24240 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DetectResult.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.DetectResult +name: DetectResult +fullName: azure.cognitiveservices.vision.computervision.models.DetectResult +module: azure.cognitiveservices.vision.computervision.models +summary: 'Result of a DetectImage call. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DetectResult(*, request_id: str = None, metadata=None, model_version: str + = None, **kwargs)' + parameters: + - name: request_id + description: Id of the REST API request. + isRequired: true + types: + - + - name: metadata + isRequired: true + types: + - + - name: model_version + isRequired: true + types: + - + keywordOnlyParameters: + - name: request_id + isRequired: true + - name: metadata + isRequired: true + - name: model_version + isRequired: true +variables: +- description: An array of detected objects. + name: objects + types: + - [] +methods: +- uid: azure.cognitiveservices.vision.computervision.models.DetectResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.DetectResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.DetectResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.DetectResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.DetectResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.DetectResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.DetectResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DetectedBrand.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DetectedBrand.yml new file mode 100644 index 00000000..7bde57cd --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DetectedBrand.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.DetectedBrand +name: DetectedBrand +fullName: azure.cognitiveservices.vision.computervision.models.DetectedBrand +module: azure.cognitiveservices.vision.computervision.models +summary: 'A brand detected in an image. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: DetectedBrand(**kwargs) +variables: +- description: Label for the brand. + name: name + types: + - +- description: 'Confidence score of having observed the brand in the + + image, as a value ranging from 0 to 1.' + name: confidence + types: + - +- description: Approximate location of the detected brand. + name: rectangle + types: + - +methods: +- uid: azure.cognitiveservices.vision.computervision.models.DetectedBrand.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.DetectedBrand.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.DetectedBrand.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.DetectedBrand.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.DetectedBrand.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.DetectedBrand.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.DetectedBrand.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DetectedObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DetectedObject.yml new file mode 100644 index 00000000..d0d3f1e5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DetectedObject.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.DetectedObject +name: DetectedObject +fullName: azure.cognitiveservices.vision.computervision.models.DetectedObject +module: azure.cognitiveservices.vision.computervision.models +summary: 'An object detected in an image. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DetectedObject(*, object_property: str = None, confidence: float = None, + parent=None, **kwargs)' + parameters: + - name: object_property + description: Label for the object. + isRequired: true + types: + - + - name: confidence + description: 'Confidence score of having observed the object in the + + image, as a value ranging from 0 to 1.' + isRequired: true + types: + - + - name: parent + description: 'The parent object, from a taxonomy perspective. + + The parent object is a more generic form of this object. For example, a + + ''bulldog'' would have a parent of ''dog''.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: object_property + isRequired: true + - name: confidence + isRequired: true + - name: parent + isRequired: true +variables: +- description: Approximate location of the detected object. + name: rectangle + types: + - +methods: +- uid: azure.cognitiveservices.vision.computervision.models.DetectedObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.DetectedObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.DetectedObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.DetectedObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.DetectedObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.DetectedObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.DetectedObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DomainModelResults.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DomainModelResults.yml new file mode 100644 index 00000000..241fcc01 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DomainModelResults.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.DomainModelResults +name: DomainModelResults +fullName: azure.cognitiveservices.vision.computervision.models.DomainModelResults +module: azure.cognitiveservices.vision.computervision.models +summary: 'Result of image analysis using a specific domain model including additional + + metadata.' +constructor: + syntax: 'DomainModelResults(*, result=None, request_id: str = None, metadata=None, + model_version: str = None, **kwargs)' + parameters: + - name: result + description: Model-specific response. + isRequired: true + types: + - + - name: request_id + description: Id of the REST API request. + isRequired: true + types: + - + - name: metadata + isRequired: true + types: + - + - name: model_version + isRequired: true + types: + - + keywordOnlyParameters: + - name: result + isRequired: true + - name: request_id + isRequired: true + - name: metadata + isRequired: true + - name: model_version + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.DomainModelResults.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.DomainModelResults.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.DomainModelResults.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.DomainModelResults.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.DomainModelResults.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.DomainModelResults.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.DomainModelResults.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.FaceDescription.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.FaceDescription.yml new file mode 100644 index 00000000..8c98274b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.FaceDescription.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.FaceDescription +name: FaceDescription +fullName: azure.cognitiveservices.vision.computervision.models.FaceDescription +module: azure.cognitiveservices.vision.computervision.models +summary: An object describing a face identified in the image. +constructor: + syntax: 'FaceDescription(*, age: int = None, gender=None, face_rectangle=None, **kwargs)' + parameters: + - name: age + description: Possible age of the face. + isRequired: true + types: + - + - name: gender + description: 'Possible gender of the face. Possible values include: + + ''Male'', ''Female''' + isRequired: true + types: + - + - + - name: face_rectangle + description: 'Rectangle in the image containing the identified + + face.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: age + isRequired: true + - name: gender + isRequired: true + - name: face_rectangle + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.FaceDescription.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.FaceDescription.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.FaceDescription.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.FaceDescription.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.FaceDescription.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.FaceDescription.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.FaceDescription.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.FaceRectangle.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.FaceRectangle.yml new file mode 100644 index 00000000..781c74ae --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.FaceRectangle.yml @@ -0,0 +1,149 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.FaceRectangle +name: FaceRectangle +fullName: azure.cognitiveservices.vision.computervision.models.FaceRectangle +module: azure.cognitiveservices.vision.computervision.models +summary: An object describing face rectangle. +constructor: + syntax: 'FaceRectangle(*, left: int = None, top: int = None, width: int = None, + height: int = None, **kwargs)' + parameters: + - name: left + description: X-coordinate of the top left point of the face, in pixels. + isRequired: true + types: + - + - name: top + description: Y-coordinate of the top left point of the face, in pixels. + isRequired: true + types: + - + - name: width + description: 'Width measured from the top-left point of the face, in + + pixels.' + isRequired: true + types: + - + - name: height + description: 'Height measured from the top-left point of the face, in + + pixels.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: left + isRequired: true + - name: top + isRequired: true + - name: width + isRequired: true + - name: height + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.FaceRectangle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.FaceRectangle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.FaceRectangle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.FaceRectangle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.FaceRectangle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.FaceRectangle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.FaceRectangle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Gender.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Gender.yml new file mode 100644 index 00000000..63f40a61 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Gender.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.computervision.models.Gender +name: Gender +fullName: azure.cognitiveservices.vision.computervision.models.Gender +module: azure.cognitiveservices.vision.computervision.models +fields: +- name: female + uid: azure.cognitiveservices.vision.computervision.models.Gender.female +- name: male + uid: azure.cognitiveservices.vision.computervision.models.Gender.male diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageAnalysis.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageAnalysis.yml new file mode 100644 index 00000000..3ee0587d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageAnalysis.yml @@ -0,0 +1,210 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.ImageAnalysis +name: ImageAnalysis +fullName: azure.cognitiveservices.vision.computervision.models.ImageAnalysis +module: azure.cognitiveservices.vision.computervision.models +summary: Result of AnalyzeImage operation. +constructor: + syntax: 'ImageAnalysis(*, categories=None, adult=None, color=None, image_type=None, + tags=None, description=None, faces=None, objects=None, brands=None, request_id: + str = None, metadata=None, model_version: str = None, **kwargs)' + parameters: + - name: categories + description: An array indicating identified categories. + isRequired: true + types: + - [] + - name: adult + description: 'An object describing whether the image contains + + adult-oriented content and/or is racy.' + isRequired: true + types: + - + - name: color + description: 'An object providing additional metadata describing color + + attributes.' + isRequired: true + types: + - + - name: image_type + description: 'An object providing possible image types and matching + + confidence levels.' + isRequired: true + types: + - + - name: tags + description: A list of tags with confidence level. + isRequired: true + types: + - [] + - name: description + description: 'A collection of content tags, along with a list of + + captions sorted by confidence level, and image metadata.' + isRequired: true + types: + - + - name: faces + description: An array of possible faces within the image. + isRequired: true + types: + - [] + - name: objects + description: 'Array of objects describing what was detected in the + + image.' + isRequired: true + types: + - [] + - name: brands + description: Array of brands detected in the image. + isRequired: true + types: + - [] + - name: request_id + description: Id of the REST API request. + isRequired: true + types: + - + - name: metadata + isRequired: true + types: + - + - name: model_version + isRequired: true + types: + - + keywordOnlyParameters: + - name: categories + isRequired: true + - name: adult + isRequired: true + - name: color + isRequired: true + - name: image_type + isRequired: true + - name: tags + isRequired: true + - name: description + isRequired: true + - name: faces + isRequired: true + - name: objects + isRequired: true + - name: brands + isRequired: true + - name: request_id + isRequired: true + - name: metadata + isRequired: true + - name: model_version + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.ImageAnalysis.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ImageAnalysis.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ImageAnalysis.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.ImageAnalysis.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ImageAnalysis.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.ImageAnalysis.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ImageAnalysis.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageCaption.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageCaption.yml new file mode 100644 index 00000000..18edd59b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageCaption.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.ImageCaption +name: ImageCaption +fullName: azure.cognitiveservices.vision.computervision.models.ImageCaption +module: azure.cognitiveservices.vision.computervision.models +summary: An image caption, i.e. a brief description of what the image depicts. +constructor: + syntax: 'ImageCaption(*, text: str = None, confidence: float = None, **kwargs)' + parameters: + - name: text + description: The text of the caption. + isRequired: true + types: + - + - name: confidence + description: The level of confidence the service has in the caption. + isRequired: true + types: + - + keywordOnlyParameters: + - name: text + isRequired: true + - name: confidence + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.ImageCaption.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ImageCaption.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ImageCaption.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.ImageCaption.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ImageCaption.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.ImageCaption.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ImageCaption.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageDescription.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageDescription.yml new file mode 100644 index 00000000..0387505d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageDescription.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.ImageDescription +name: ImageDescription +fullName: azure.cognitiveservices.vision.computervision.models.ImageDescription +module: azure.cognitiveservices.vision.computervision.models +summary: 'A collection of content tags, along with a list of captions sorted by + + confidence level, and image metadata.' +constructor: + syntax: 'ImageDescription(*, tags=None, captions=None, request_id: str = None, metadata=None, + model_version: str = None, **kwargs)' + parameters: + - name: tags + description: A collection of image tags. + isRequired: true + types: + - [] + - name: captions + description: A list of captions, sorted by confidence level. + isRequired: true + types: + - [] + - name: request_id + description: Id of the REST API request. + isRequired: true + types: + - + - name: metadata + isRequired: true + types: + - + - name: model_version + isRequired: true + types: + - + keywordOnlyParameters: + - name: tags + isRequired: true + - name: captions + isRequired: true + - name: request_id + isRequired: true + - name: metadata + isRequired: true + - name: model_version + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.ImageDescription.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ImageDescription.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ImageDescription.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.ImageDescription.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ImageDescription.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.ImageDescription.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ImageDescription.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageDescriptionDetails.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageDescriptionDetails.yml new file mode 100644 index 00000000..f4a2fe19 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageDescriptionDetails.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.ImageDescriptionDetails +name: ImageDescriptionDetails +fullName: azure.cognitiveservices.vision.computervision.models.ImageDescriptionDetails +module: azure.cognitiveservices.vision.computervision.models +summary: 'A collection of content tags, along with a list of captions sorted by + + confidence level, and image metadata.' +constructor: + syntax: ImageDescriptionDetails(*, tags=None, captions=None, **kwargs) + parameters: + - name: tags + description: A collection of image tags. + isRequired: true + types: + - [] + - name: captions + description: A list of captions, sorted by confidence level. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: tags + isRequired: true + - name: captions + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.ImageDescriptionDetails.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ImageDescriptionDetails.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ImageDescriptionDetails.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.ImageDescriptionDetails.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ImageDescriptionDetails.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.ImageDescriptionDetails.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ImageDescriptionDetails.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageMetadata.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageMetadata.yml new file mode 100644 index 00000000..b8c8e4ec --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageMetadata.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.ImageMetadata +name: ImageMetadata +fullName: azure.cognitiveservices.vision.computervision.models.ImageMetadata +module: azure.cognitiveservices.vision.computervision.models +summary: Image metadata. +constructor: + syntax: 'ImageMetadata(*, width: int = None, height: int = None, format: str = None, + **kwargs)' + parameters: + - name: width + description: Image width, in pixels. + isRequired: true + types: + - + - name: height + description: Image height, in pixels. + isRequired: true + types: + - + - name: format + description: Image format. + isRequired: true + types: + - + keywordOnlyParameters: + - name: width + isRequired: true + - name: height + isRequired: true + - name: format + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.ImageMetadata.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ImageMetadata.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ImageMetadata.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.ImageMetadata.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ImageMetadata.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.ImageMetadata.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ImageMetadata.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageTag.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageTag.yml new file mode 100644 index 00000000..1d069c81 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageTag.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.ImageTag +name: ImageTag +fullName: azure.cognitiveservices.vision.computervision.models.ImageTag +module: azure.cognitiveservices.vision.computervision.models +summary: An entity observation in the image, along with the confidence score. +constructor: + syntax: 'ImageTag(*, name: str = None, confidence: float = None, hint: str = None, + **kwargs)' + parameters: + - name: name + description: Name of the entity. + isRequired: true + types: + - + - name: confidence + description: The level of confidence that the entity was observed. + isRequired: true + types: + - + - name: hint + description: Optional hint/details for this tag. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: confidence + isRequired: true + - name: hint + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.ImageTag.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ImageTag.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ImageTag.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.ImageTag.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ImageTag.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.ImageTag.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ImageTag.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageType.yml new file mode 100644 index 00000000..012c94e3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageType.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.ImageType +name: ImageType +fullName: azure.cognitiveservices.vision.computervision.models.ImageType +module: azure.cognitiveservices.vision.computervision.models +summary: An object providing possible image types and matching confidence levels. +constructor: + syntax: 'ImageType(*, clip_art_type: int = None, line_drawing_type: int = None, + **kwargs)' + parameters: + - name: clip_art_type + description: Confidence level that the image is a clip art. + isRequired: true + types: + - + - name: line_drawing_type + description: 'Confidence level that the image is a line + + drawing.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: clip_art_type + isRequired: true + - name: line_drawing_type + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.ImageType.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ImageType.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ImageType.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.ImageType.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ImageType.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.ImageType.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ImageType.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageUrl.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageUrl.yml new file mode 100644 index 00000000..dbb4c9e3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageUrl.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.ImageUrl +name: ImageUrl +fullName: azure.cognitiveservices.vision.computervision.models.ImageUrl +module: azure.cognitiveservices.vision.computervision.models +summary: 'ImageUrl. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ImageUrl(*, url: str, **kwargs)' + parameters: + - name: url + description: Required. Publicly reachable URL of an image. + isRequired: true + types: + - + keywordOnlyParameters: + - name: url + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.ImageUrl.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ImageUrl.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ImageUrl.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.ImageUrl.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ImageUrl.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.ImageUrl.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ImageUrl.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.LandmarksModel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.LandmarksModel.yml new file mode 100644 index 00000000..0ab3c2df --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.LandmarksModel.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.LandmarksModel +name: LandmarksModel +fullName: azure.cognitiveservices.vision.computervision.models.LandmarksModel +module: azure.cognitiveservices.vision.computervision.models +summary: A landmark recognized in the image. +constructor: + syntax: 'LandmarksModel(*, name: str = None, confidence: float = None, **kwargs)' + parameters: + - name: name + description: Name of the landmark. + isRequired: true + types: + - + - name: confidence + description: 'Confidence level for the landmark recognition as a + + value ranging from 0 to 1.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: confidence + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.LandmarksModel.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.LandmarksModel.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.LandmarksModel.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.LandmarksModel.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.LandmarksModel.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.LandmarksModel.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.LandmarksModel.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Line.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Line.yml new file mode 100644 index 00000000..01c404d6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Line.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.Line +name: Line +fullName: azure.cognitiveservices.vision.computervision.models.Line +module: azure.cognitiveservices.vision.computervision.models +summary: 'An object representing a recognized text line. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Line(*, bounding_box, text: str, words, language: str = None, appearance=None, + **kwargs)' + parameters: + - name: language + description: 'The BCP-47 language code of the recognized text line. + + Only provided where the language of the line differs from the page''s.' + isRequired: true + types: + - + - name: bounding_box + description: Required. Bounding box of a recognized line. + isRequired: true + types: + - [] + - name: appearance + description: Appearance of the text line. + isRequired: true + types: + - + - name: text + description: Required. The text content of the line. + isRequired: true + types: + - + - name: words + description: Required. List of words in the text line. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: bounding_box + isRequired: true + - name: text + isRequired: true + - name: words + isRequired: true + - name: language + isRequired: true + - name: appearance + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.Line.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.Line.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.Line.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.Line.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.Line.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.Line.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.Line.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ListModelsResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ListModelsResult.yml new file mode 100644 index 00000000..99f7faf9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ListModelsResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.ListModelsResult +name: ListModelsResult +fullName: azure.cognitiveservices.vision.computervision.models.ListModelsResult +module: azure.cognitiveservices.vision.computervision.models +summary: 'Result of the List Domain Models operation. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: ListModelsResult(**kwargs) +variables: +- description: An array of supported models. + name: models_property + types: + - [] +methods: +- uid: azure.cognitiveservices.vision.computervision.models.ListModelsResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ListModelsResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ListModelsResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.ListModelsResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ListModelsResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.ListModelsResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ListModelsResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ModelDescription.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ModelDescription.yml new file mode 100644 index 00000000..e1b6bf19 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ModelDescription.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.ModelDescription +name: ModelDescription +fullName: azure.cognitiveservices.vision.computervision.models.ModelDescription +module: azure.cognitiveservices.vision.computervision.models +summary: An object describing supported model by name and categories. +constructor: + syntax: 'ModelDescription(*, name: str = None, categories=None, **kwargs)' + parameters: + - name: name + description: The name of the model. + isRequired: true + types: + - + - name: categories + description: Categories of the model. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: name + isRequired: true + - name: categories + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.ModelDescription.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ModelDescription.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ModelDescription.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.ModelDescription.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ModelDescription.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.ModelDescription.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ModelDescription.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ObjectHierarchy.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ObjectHierarchy.yml new file mode 100644 index 00000000..d681c2c3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ObjectHierarchy.yml @@ -0,0 +1,144 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.ObjectHierarchy +name: ObjectHierarchy +fullName: azure.cognitiveservices.vision.computervision.models.ObjectHierarchy +module: azure.cognitiveservices.vision.computervision.models +summary: An object detected inside an image. +constructor: + syntax: 'ObjectHierarchy(*, object_property: str = None, confidence: float = None, + parent=None, **kwargs)' + parameters: + - name: object_property + description: Label for the object. + isRequired: true + types: + - + - name: confidence + description: 'Confidence score of having observed the object in the + + image, as a value ranging from 0 to 1.' + isRequired: true + types: + - + - name: parent + description: 'The parent object, from a taxonomy perspective. + + The parent object is a more generic form of this object. For example, a + + ''bulldog'' would have a parent of ''dog''.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: object_property + isRequired: true + - name: confidence + isRequired: true + - name: parent + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.ObjectHierarchy.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ObjectHierarchy.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ObjectHierarchy.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.ObjectHierarchy.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ObjectHierarchy.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.ObjectHierarchy.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ObjectHierarchy.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.yml new file mode 100644 index 00000000..241449f3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage +name: OcrDetectionLanguage +fullName: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage +module: azure.cognitiveservices.vision.computervision.models +fields: +- name: af + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.af +- name: ast + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.ast +- name: bi + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.bi +- name: br + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.br +- name: ca + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.ca +- name: ceb + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.ceb +- name: ch + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.ch +- name: co + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.co +- name: crh + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.crh +- name: cs + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.cs +- name: csb + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.csb +- name: da + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.da +- name: de + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.de +- name: en + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.en +- name: es + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.es +- name: et + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.et +- name: eu + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.eu +- name: fi + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.fi +- name: fil + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.fil +- name: fj + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.fj +- name: fr + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.fr +- name: fur + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.fur +- name: fy + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.fy +- name: ga + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.ga +- name: gd + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.gd +- name: gil + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.gil +- name: gl + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.gl +- name: gv + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.gv +- name: hni + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.hni +- name: hsb + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.hsb +- name: ht + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.ht +- name: hu + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.hu +- name: ia + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.ia +- name: id + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.id +- name: it + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.it +- name: iu + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.iu +- name: ja + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.ja +- name: jv + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.jv +- name: kaa + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.kaa +- name: kac + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.kac +- name: kea + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.kea +- name: kha + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.kha +- name: kl + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.kl +- name: ko + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.ko +- name: ku + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.ku +- name: kw + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.kw +- name: lb + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.lb +- name: ms + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.ms +- name: mww + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.mww +- name: nap + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.nap +- name: nl + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.nl +- name: 'no' + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.no +- name: oc + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.oc +- name: pl + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.pl +- name: pt + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.pt +- name: quc + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.quc +- name: rm + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.rm +- name: sco + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.sco +- name: sl + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.sl +- name: sq + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.sq +- name: sv + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.sv +- name: sw + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.sw +- name: tet + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.tet +- name: tr + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.tr +- name: tt + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.tt +- name: uz + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.uz +- name: vo + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.vo +- name: wae + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.wae +- name: yua + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.yua +- name: za + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.za +- name: zh_hans + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.zh_hans +- name: zh_hant + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.zh_hant +- name: zu + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage.zu diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrLanguages.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrLanguages.yml new file mode 100644 index 00000000..ddd391da --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrLanguages.yml @@ -0,0 +1,60 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages +name: OcrLanguages +fullName: azure.cognitiveservices.vision.computervision.models.OcrLanguages +module: azure.cognitiveservices.vision.computervision.models +fields: +- name: ar + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.ar +- name: cs + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.cs +- name: da + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.da +- name: de + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.de +- name: el + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.el +- name: en + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.en +- name: es + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.es +- name: fi + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.fi +- name: fr + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.fr +- name: hu + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.hu +- name: it + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.it +- name: ja + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.ja +- name: ko + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.ko +- name: nb + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.nb +- name: nl + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.nl +- name: pl + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.pl +- name: pt + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.pt +- name: ro + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.ro +- name: ru + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.ru +- name: sk + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.sk +- name: sr_cyrl + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.sr_cyrl +- name: sr_latn + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.sr_latn +- name: sv + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.sv +- name: tr + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.tr +- name: unk + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.unk +- name: zh_hans + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.zh_hans +- name: zh_hant + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages.zh_hant diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrLine.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrLine.yml new file mode 100644 index 00000000..2ebadad8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrLine.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.OcrLine +name: OcrLine +fullName: azure.cognitiveservices.vision.computervision.models.OcrLine +module: azure.cognitiveservices.vision.computervision.models +summary: An object describing a single recognized line of text. +constructor: + syntax: 'OcrLine(*, bounding_box: str = None, words=None, **kwargs)' + parameters: + - name: bounding_box + description: 'Bounding box of a recognized line. The four integers + + represent the x-coordinate of the left edge, the y-coordinate of the top + + edge, width, and height of the bounding box, in the coordinate system of + + the input image, after it has been rotated around its center according to + + the detected text angle (see textAngle property), with the origin at the + + top-left corner, and the y-axis pointing down.' + isRequired: true + types: + - + - name: words + description: 'An array of objects, where each object represents a + + recognized word.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: bounding_box + isRequired: true + - name: words + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.OcrLine.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.OcrLine.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.OcrLine.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.OcrLine.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.OcrLine.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.OcrLine.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.OcrLine.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrRegion.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrRegion.yml new file mode 100644 index 00000000..c013396d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrRegion.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.OcrRegion +name: OcrRegion +fullName: azure.cognitiveservices.vision.computervision.models.OcrRegion +module: azure.cognitiveservices.vision.computervision.models +summary: 'A region consists of multiple lines (e.g. a column of text in a + + multi-column document).' +constructor: + syntax: 'OcrRegion(*, bounding_box: str = None, lines=None, **kwargs)' + parameters: + - name: bounding_box + description: 'Bounding box of a recognized region. The four + + integers represent the x-coordinate of the left edge, the y-coordinate of + + the top edge, width, and height of the bounding box, in the coordinate + + system of the input image, after it has been rotated around its center + + according to the detected text angle (see textAngle property), with the + + origin at the top-left corner, and the y-axis pointing down.' + isRequired: true + types: + - + - name: lines + description: An array of recognized lines of text. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: bounding_box + isRequired: true + - name: lines + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.OcrRegion.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.OcrRegion.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.OcrRegion.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.OcrRegion.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.OcrRegion.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.OcrRegion.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.OcrRegion.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrResult.yml new file mode 100644 index 00000000..ca8e31b9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrResult.yml @@ -0,0 +1,183 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.OcrResult +name: OcrResult +fullName: azure.cognitiveservices.vision.computervision.models.OcrResult +module: azure.cognitiveservices.vision.computervision.models +summary: OcrResult. +constructor: + syntax: 'OcrResult(*, language: str = None, text_angle: float = None, orientation: + str = None, regions=None, model_version: str = None, **kwargs)' + parameters: + - name: language + description: The BCP-47 language code of the text in the image. + isRequired: true + types: + - + - name: text_angle + description: 'The angle, in radians, of the detected text with + + respect to the closest horizontal or vertical direction. After rotating + + the input image clockwise by this angle, the recognized text lines become + + horizontal or vertical. In combination with the orientation property it + + can be used to overlay recognition results correctly on the original + + image, by rotating either the original image or recognition results by a + + suitable angle around the center of the original image. If the angle + + cannot be confidently detected, this property is not present. If the image + + contains text at different angles, only part of the text will be + + recognized correctly.' + isRequired: true + types: + - + - name: orientation + description: 'Orientation of the text recognized in the image, if + + requested. The value (up, down, left, or right) refers to the direction + + that the top of the recognized text is facing, after the image has been + + rotated around its center according to the detected text angle (see + + textAngle property). + + If detection of the orientation was not requested, or no text is detected, + + the value is ''NotDetected''.' + isRequired: true + types: + - + - name: regions + description: 'An array of objects, where each object represents a region + + of recognized text.' + isRequired: true + types: + - [] + - name: model_version + isRequired: true + types: + - + keywordOnlyParameters: + - name: language + isRequired: true + - name: text_angle + isRequired: true + - name: orientation + isRequired: true + - name: regions + isRequired: true + - name: model_version + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.OcrResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.OcrResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.OcrResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.OcrResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.OcrResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.OcrResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.OcrResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrWord.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrWord.yml new file mode 100644 index 00000000..9d54e79f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrWord.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.OcrWord +name: OcrWord +fullName: azure.cognitiveservices.vision.computervision.models.OcrWord +module: azure.cognitiveservices.vision.computervision.models +summary: Information on a recognized word. +constructor: + syntax: 'OcrWord(*, bounding_box: str = None, text: str = None, **kwargs)' + parameters: + - name: bounding_box + description: 'Bounding box of a recognized word. The four integers + + represent the x-coordinate of the left edge, the y-coordinate of the top + + edge, width, and height of the bounding box, in the coordinate system of + + the input image, after it has been rotated around its center according to + + the detected text angle (see textAngle property), with the origin at the + + top-left corner, and the y-axis pointing down.' + isRequired: true + types: + - + - name: text + description: String value of a recognized word. + isRequired: true + types: + - + keywordOnlyParameters: + - name: bounding_box + isRequired: true + - name: text + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.OcrWord.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.OcrWord.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.OcrWord.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.OcrWord.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.OcrWord.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.OcrWord.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.OcrWord.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OperationStatusCodes.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OperationStatusCodes.yml new file mode 100644 index 00000000..34c1636e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OperationStatusCodes.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.computervision.models.OperationStatusCodes +name: OperationStatusCodes +fullName: azure.cognitiveservices.vision.computervision.models.OperationStatusCodes +module: azure.cognitiveservices.vision.computervision.models +fields: +- name: failed + uid: azure.cognitiveservices.vision.computervision.models.OperationStatusCodes.failed +- name: not_started + uid: azure.cognitiveservices.vision.computervision.models.OperationStatusCodes.not_started +- name: running + uid: azure.cognitiveservices.vision.computervision.models.OperationStatusCodes.running +- name: succeeded + uid: azure.cognitiveservices.vision.computervision.models.OperationStatusCodes.succeeded diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ReadOperationResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ReadOperationResult.yml new file mode 100644 index 00000000..ba27f794 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ReadOperationResult.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.ReadOperationResult +name: ReadOperationResult +fullName: azure.cognitiveservices.vision.computervision.models.ReadOperationResult +module: azure.cognitiveservices.vision.computervision.models +summary: OCR result of the read operation. +constructor: + syntax: 'ReadOperationResult(*, status=None, created_date_time: str = None, last_updated_date_time: + str = None, analyze_result=None, **kwargs)' + parameters: + - name: status + description: 'Status of the read operation. Possible values include: + + ''notStarted'', ''running'', ''failed'', ''succeeded''' + isRequired: true + types: + - + - + - name: created_date_time + description: 'Get UTC date time the batch operation was + + submitted.' + isRequired: true + types: + - + - name: last_updated_date_time + description: 'Get last updated UTC date time of this + + batch operation.' + isRequired: true + types: + - + - name: analyze_result + description: Analyze batch operation result. + isRequired: true + types: + - + keywordOnlyParameters: + - name: status + isRequired: true + - name: created_date_time + isRequired: true + - name: last_updated_date_time + isRequired: true + - name: analyze_result + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.ReadOperationResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ReadOperationResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ReadOperationResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.ReadOperationResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ReadOperationResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.ReadOperationResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ReadOperationResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ReadResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ReadResult.yml new file mode 100644 index 00000000..02c3e846 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ReadResult.yml @@ -0,0 +1,180 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.ReadResult +name: ReadResult +fullName: azure.cognitiveservices.vision.computervision.models.ReadResult +module: azure.cognitiveservices.vision.computervision.models +summary: 'Text extracted from a page in the input document. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ReadResult(*, page: int, angle: float, width: float, height: float, unit, + lines, language: str = None, **kwargs)' + parameters: + - name: page + description: Required. The 1-based page number of the recognition result. + isRequired: true + types: + - + - name: language + description: The BCP-47 language code of the recognized text page. + isRequired: true + types: + - + - name: angle + description: 'Required. The orientation of the image in degrees in the + + clockwise direction. Range between [-180, 180).' + isRequired: true + types: + - + - name: width + description: 'Required. The width of the image in pixels or the PDF in + + inches.' + isRequired: true + types: + - + - name: height + description: 'Required. The height of the image in pixels or the PDF in + + inches.' + isRequired: true + types: + - + - name: unit + description: 'Required. The unit used in the Width, Height and BoundingBox. + + For images, the unit is ''pixel''. For PDF, the unit is ''inch''. Possible + + values include: ''pixel'', ''inch''' + isRequired: true + types: + - + - + - name: lines + description: Required. A list of recognized text lines. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: page + isRequired: true + - name: angle + isRequired: true + - name: width + isRequired: true + - name: height + isRequired: true + - name: unit + isRequired: true + - name: lines + isRequired: true + - name: language + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.ReadResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ReadResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ReadResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.ReadResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.ReadResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.ReadResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.ReadResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Style.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Style.yml new file mode 100644 index 00000000..e907d5b7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Style.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.Style +name: Style +fullName: azure.cognitiveservices.vision.computervision.models.Style +module: azure.cognitiveservices.vision.computervision.models +summary: 'An object representing the style of the text line. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Style(*, name, confidence: float, **kwargs)' + parameters: + - name: name + description: 'Required. The text line style name, including handwriting and + + other. Possible values include: ''other'', ''handwriting''' + isRequired: true + types: + - + - + - name: confidence + description: Required. The confidence of text line style. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: confidence + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.Style.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.Style.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.Style.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.Style.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.Style.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.Style.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.Style.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.TagResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.TagResult.yml new file mode 100644 index 00000000..a9867a3e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.TagResult.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.TagResult +name: TagResult +fullName: azure.cognitiveservices.vision.computervision.models.TagResult +module: azure.cognitiveservices.vision.computervision.models +summary: 'The results of a image tag operation, including any tags and image + + metadata.' +constructor: + syntax: 'TagResult(*, tags=None, request_id: str = None, metadata=None, model_version: + str = None, **kwargs)' + parameters: + - name: tags + description: A list of tags with confidence level. + isRequired: true + types: + - [] + - name: request_id + description: Id of the REST API request. + isRequired: true + types: + - + - name: metadata + isRequired: true + types: + - + - name: model_version + isRequired: true + types: + - + keywordOnlyParameters: + - name: tags + isRequired: true + - name: request_id + isRequired: true + - name: metadata + isRequired: true + - name: model_version + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.TagResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.TagResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.TagResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.TagResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.TagResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.TagResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.TagResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.TextRecognitionResultDimensionUnit.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.TextRecognitionResultDimensionUnit.yml new file mode 100644 index 00000000..5a0adc85 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.TextRecognitionResultDimensionUnit.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.computervision.models.TextRecognitionResultDimensionUnit +name: TextRecognitionResultDimensionUnit +fullName: azure.cognitiveservices.vision.computervision.models.TextRecognitionResultDimensionUnit +module: azure.cognitiveservices.vision.computervision.models +fields: +- name: inch + uid: azure.cognitiveservices.vision.computervision.models.TextRecognitionResultDimensionUnit.inch +- name: pixel + uid: azure.cognitiveservices.vision.computervision.models.TextRecognitionResultDimensionUnit.pixel diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.TextStyle.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.TextStyle.yml new file mode 100644 index 00000000..86437d01 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.TextStyle.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.computervision.models.TextStyle +name: TextStyle +fullName: azure.cognitiveservices.vision.computervision.models.TextStyle +module: azure.cognitiveservices.vision.computervision.models +fields: +- name: handwriting + uid: azure.cognitiveservices.vision.computervision.models.TextStyle.handwriting +- name: other + uid: azure.cognitiveservices.vision.computervision.models.TextStyle.other diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.VisualFeatureTypes.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.VisualFeatureTypes.yml new file mode 100644 index 00000000..77556aba --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.VisualFeatureTypes.yml @@ -0,0 +1,24 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.computervision.models.VisualFeatureTypes +name: VisualFeatureTypes +fullName: azure.cognitiveservices.vision.computervision.models.VisualFeatureTypes +module: azure.cognitiveservices.vision.computervision.models +fields: +- name: adult + uid: azure.cognitiveservices.vision.computervision.models.VisualFeatureTypes.adult +- name: brands + uid: azure.cognitiveservices.vision.computervision.models.VisualFeatureTypes.brands +- name: categories + uid: azure.cognitiveservices.vision.computervision.models.VisualFeatureTypes.categories +- name: color + uid: azure.cognitiveservices.vision.computervision.models.VisualFeatureTypes.color +- name: description + uid: azure.cognitiveservices.vision.computervision.models.VisualFeatureTypes.description +- name: faces + uid: azure.cognitiveservices.vision.computervision.models.VisualFeatureTypes.faces +- name: image_type + uid: azure.cognitiveservices.vision.computervision.models.VisualFeatureTypes.image_type +- name: objects + uid: azure.cognitiveservices.vision.computervision.models.VisualFeatureTypes.objects +- name: tags + uid: azure.cognitiveservices.vision.computervision.models.VisualFeatureTypes.tags diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Word.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Word.yml new file mode 100644 index 00000000..62eeacdf --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Word.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.models.Word +name: Word +fullName: azure.cognitiveservices.vision.computervision.models.Word +module: azure.cognitiveservices.vision.computervision.models +summary: 'An object representing a recognized word. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Word(*, bounding_box, text: str, confidence: float, **kwargs)' + parameters: + - name: bounding_box + description: Required. Bounding box of a recognized word. + isRequired: true + types: + - [] + - name: text + description: Required. The text content of the word. + isRequired: true + types: + - + - name: confidence + description: Required. Qualitative confidence measure. + isRequired: true + types: + - + keywordOnlyParameters: + - name: bounding_box + isRequired: true + - name: text + isRequired: true + - name: confidence + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.computervision.models.Word.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.Word.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.Word.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.computervision.models.Word.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.computervision.models.Word.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.computervision.models.Word.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.computervision.models.Word.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.yml new file mode 100644 index 00000000..43f045ee --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.yml @@ -0,0 +1,61 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.vision.computervision.models +name: models +fullName: azure.cognitiveservices.vision.computervision.models +type: import +classes: +- azure.cognitiveservices.vision.computervision.models.AdultInfo +- azure.cognitiveservices.vision.computervision.models.AnalyzeResults +- azure.cognitiveservices.vision.computervision.models.Appearance +- azure.cognitiveservices.vision.computervision.models.AreaOfInterestResult +- azure.cognitiveservices.vision.computervision.models.BoundingRect +- azure.cognitiveservices.vision.computervision.models.Category +- azure.cognitiveservices.vision.computervision.models.CategoryDetail +- azure.cognitiveservices.vision.computervision.models.CelebritiesModel +- azure.cognitiveservices.vision.computervision.models.ColorInfo +- azure.cognitiveservices.vision.computervision.models.ComputerVisionError +- azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponse +- azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerError +- azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrError +- azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrErrorException +- azure.cognitiveservices.vision.computervision.models.DetectResult +- azure.cognitiveservices.vision.computervision.models.DetectedBrand +- azure.cognitiveservices.vision.computervision.models.DetectedObject +- azure.cognitiveservices.vision.computervision.models.DomainModelResults +- azure.cognitiveservices.vision.computervision.models.FaceDescription +- azure.cognitiveservices.vision.computervision.models.FaceRectangle +- azure.cognitiveservices.vision.computervision.models.ImageAnalysis +- azure.cognitiveservices.vision.computervision.models.ImageCaption +- azure.cognitiveservices.vision.computervision.models.ImageDescription +- azure.cognitiveservices.vision.computervision.models.ImageDescriptionDetails +- azure.cognitiveservices.vision.computervision.models.ImageMetadata +- azure.cognitiveservices.vision.computervision.models.ImageTag +- azure.cognitiveservices.vision.computervision.models.ImageType +- azure.cognitiveservices.vision.computervision.models.ImageUrl +- azure.cognitiveservices.vision.computervision.models.LandmarksModel +- azure.cognitiveservices.vision.computervision.models.Line +- azure.cognitiveservices.vision.computervision.models.ListModelsResult +- azure.cognitiveservices.vision.computervision.models.ModelDescription +- azure.cognitiveservices.vision.computervision.models.ObjectHierarchy +- azure.cognitiveservices.vision.computervision.models.OcrLine +- azure.cognitiveservices.vision.computervision.models.OcrRegion +- azure.cognitiveservices.vision.computervision.models.OcrResult +- azure.cognitiveservices.vision.computervision.models.OcrWord +- azure.cognitiveservices.vision.computervision.models.ReadOperationResult +- azure.cognitiveservices.vision.computervision.models.ReadResult +- azure.cognitiveservices.vision.computervision.models.Style +- azure.cognitiveservices.vision.computervision.models.TagResult +- azure.cognitiveservices.vision.computervision.models.Word +enums: +- azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorCodes +- azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue +- azure.cognitiveservices.vision.computervision.models.DescriptionExclude +- azure.cognitiveservices.vision.computervision.models.Details +- azure.cognitiveservices.vision.computervision.models.Gender +- azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage +- azure.cognitiveservices.vision.computervision.models.OcrLanguages +- azure.cognitiveservices.vision.computervision.models.OperationStatusCodes +- azure.cognitiveservices.vision.computervision.models.TextRecognitionResultDimensionUnit +- azure.cognitiveservices.vision.computervision.models.TextStyle +- azure.cognitiveservices.vision.computervision.models.VisualFeatureTypes diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.yml new file mode 100644 index 00000000..54ade9e9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.yml @@ -0,0 +1,1639 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin +name: ComputerVisionClientOperationsMixin +fullName: azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin +module: azure.cognitiveservices.vision.computervision.operations +constructor: + syntax: ComputerVisionClientOperationsMixin() +methods: +- uid: azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.analyze_image + name: analyze_image + summary: "This operation extracts a rich set of visual features based on the\nimage\ + \ content.\nTwo input methods are supported \u2013 (1) Uploading an image or (2)\n\ + specifying an image URL. Within your request, there is an optional\nparameter\ + \ to allow you to choose which features to return. By default,\nimage categories\ + \ are returned in the response.\nA successful response will be returned in JSON.\ + \ If the request failed,\nthe response will contain an error code and a message\ + \ to help\nunderstand what went wrong." + signature: analyze_image(url, visual_features=None, details=None, language='en', + description_exclude=None, model_version='latest', custom_headers=None, raw=False, + **operation_config) + parameters: + - name: url + description: Publicly reachable URL of an image. + isRequired: true + types: + - + - name: visual_features + description: 'A string indicating what visual feature types + + to return. Multiple values should be comma-separated. Valid visual + + feature types include: Categories - categorizes image content + + according to a taxonomy defined in documentation. Tags - tags the + + image with a detailed list of words related to the image content. + + Description - describes the image content with a complete English + + sentence. Faces - detects if faces are present. If present, generate + + coordinates, gender and age. ImageType - detects if image is clipart + + or a line drawing. Color - determines the accent color, dominant + + color, and whether an image is black&white. Adult - detects if the + + image is pornographic in nature (depicts nudity or a sex act), or is + + gory (depicts extreme violence or blood). Sexually suggestive content + + (aka racy content) is also detected. Objects - detects various objects + + within an image, including the approximate location. The Objects + + argument is only available in English. Brands - detects various brands + + within an image, including the approximate location. The Brands + + argument is only available in English.' + defaultValue: None + types: + - [ + - ] + - name: details + description: 'A string indicating which domain-specific details to + + return. Multiple values should be comma-separated. Valid visual + + feature types include: Celebrities - identifies celebrities if + + detected in the image, Landmarks - identifies notable landmarks in the + + image.' + defaultValue: None + types: + - [ + - ] + - name: language + description: 'The desired language for output generation. If this + + parameter is not specified, the default value is + + "en".Supported languages:en - English, Default. es - + + Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. + + Possible values include: ''en'', ''es'', ''ja'', ''pt'', ''zh''' + defaultValue: en + types: + - + - name: description_exclude + description: 'Turn off specified domain models when + + generating the description.' + defaultValue: None + types: + - [ + - ] + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageAnalysis or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.analyze_image_by_domain + name: analyze_image_by_domain + summary: "This operation recognizes content within an image by applying a\ndomain-specific\ + \ model. The list of domain-specific models that are\nsupported by the Computer\ + \ Vision API can be retrieved using the /models\nGET request. Currently, the API\ + \ provides following domain-specific\nmodels: celebrities, landmarks.\nTwo input\ + \ methods are supported \u2013 (1) Uploading an image or (2)\nspecifying an image\ + \ URL.\nA successful response will be returned in JSON.\nIf the request failed,\ + \ the response will contain an error code and a\nmessage to help understand what\ + \ went wrong." + signature: analyze_image_by_domain(model, url, language='en', model_version='latest', + custom_headers=None, raw=False, **operation_config) + parameters: + - name: model + description: The domain-specific content to recognize. + isRequired: true + types: + - + - name: url + description: Publicly reachable URL of an image. + isRequired: true + types: + - + - name: language + description: 'The desired language for output generation. If this + + parameter is not specified, the default value is + + "en".Supported languages:en - English, Default. es - + + Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. + + Possible values include: ''en'', ''es'', ''ja'', ''pt'', ''zh''' + defaultValue: en + types: + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DomainModelResults or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.analyze_image_by_domain_in_stream + name: analyze_image_by_domain_in_stream + summary: "This operation recognizes content within an image by applying a\ndomain-specific\ + \ model. The list of domain-specific models that are\nsupported by the Computer\ + \ Vision API can be retrieved using the /models\nGET request. Currently, the API\ + \ provides following domain-specific\nmodels: celebrities, landmarks.\nTwo input\ + \ methods are supported \u2013 (1) Uploading an image or (2)\nspecifying an image\ + \ URL.\nA successful response will be returned in JSON.\nIf the request failed,\ + \ the response will contain an error code and a\nmessage to help understand what\ + \ went wrong." + signature: analyze_image_by_domain_in_stream(model, image, language='en', model_version='latest', + custom_headers=None, raw=False, callback=None, **operation_config) + parameters: + - name: model + description: The domain-specific content to recognize. + isRequired: true + types: + - + - name: image + description: An image stream. + isRequired: true + types: + - + - name: language + description: 'The desired language for output generation. If this + + parameter is not specified, the default value is + + "en".Supported languages:en - English, Default. es - + + Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. + + Possible values include: ''en'', ''es'', ''ja'', ''pt'', ''zh''' + defaultValue: en + types: + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DomainModelResults or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.analyze_image_in_stream + name: analyze_image_in_stream + summary: "This operation extracts a rich set of visual features based on the\nimage\ + \ content.\nTwo input methods are supported \u2013 (1) Uploading an image or (2)\n\ + specifying an image URL. Within your request, there is an optional\nparameter\ + \ to allow you to choose which features to return. By default,\nimage categories\ + \ are returned in the response.\nA successful response will be returned in JSON.\ + \ If the request failed,\nthe response will contain an error code and a message\ + \ to help\nunderstand what went wrong." + signature: analyze_image_in_stream(image, visual_features=None, details=None, language='en', + description_exclude=None, model_version='latest', custom_headers=None, raw=False, + callback=None, **operation_config) + parameters: + - name: image + description: An image stream. + isRequired: true + types: + - + - name: visual_features + description: 'A string indicating what visual feature types + + to return. Multiple values should be comma-separated. Valid visual + + feature types include: Categories - categorizes image content + + according to a taxonomy defined in documentation. Tags - tags the + + image with a detailed list of words related to the image content. + + Description - describes the image content with a complete English + + sentence. Faces - detects if faces are present. If present, generate + + coordinates, gender and age. ImageType - detects if image is clipart + + or a line drawing. Color - determines the accent color, dominant + + color, and whether an image is black&white. Adult - detects if the + + image is pornographic in nature (depicts nudity or a sex act), or is + + gory (depicts extreme violence or blood). Sexually suggestive content + + (aka racy content) is also detected. Objects - detects various objects + + within an image, including the approximate location. The Objects + + argument is only available in English. Brands - detects various brands + + within an image, including the approximate location. The Brands + + argument is only available in English.' + defaultValue: None + types: + - [ + - ] + - name: details + description: 'A string indicating which domain-specific details to + + return. Multiple values should be comma-separated. Valid visual + + feature types include: Celebrities - identifies celebrities if + + detected in the image, Landmarks - identifies notable landmarks in the + + image.' + defaultValue: None + types: + - [ + - ] + - name: language + description: 'The desired language for output generation. If this + + parameter is not specified, the default value is + + "en".Supported languages:en - English, Default. es - + + Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. + + Possible values include: ''en'', ''es'', ''ja'', ''pt'', ''zh''' + defaultValue: en + types: + - + - name: description_exclude + description: 'Turn off specified domain models when + + generating the description.' + defaultValue: None + types: + - [ + - ] + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageAnalysis or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.describe_image + name: describe_image + summary: "This operation generates a description of an image in human readable\n\ + language with complete sentences. The description is based on a\ncollection of\ + \ content tags, which are also returned by the operation.\nMore than one description\ + \ can be generated for each image. Descriptions\nare ordered by their confidence\ + \ score. Descriptions may include results\nfrom celebrity and landmark domain\ + \ models, if applicable.\nTwo input methods are supported \u2013 (1) Uploading\ + \ an image or (2)\nspecifying an image URL.\nA successful response will be returned\ + \ in JSON. If the request failed,\nthe response will contain an error code and\ + \ a message to help\nunderstand what went wrong." + signature: describe_image(url, max_candidates=1, language='en', description_exclude=None, + model_version='latest', custom_headers=None, raw=False, **operation_config) + parameters: + - name: url + description: Publicly reachable URL of an image. + isRequired: true + types: + - + - name: max_candidates + description: 'Maximum number of candidate descriptions to be + + returned. The default is 1.' + defaultValue: '1' + types: + - + - name: language + description: 'The desired language for output generation. If this + + parameter is not specified, the default value is + + "en".Supported languages:en - English, Default. es - + + Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. + + Possible values include: ''en'', ''es'', ''ja'', ''pt'', ''zh''' + defaultValue: en + types: + - + - name: description_exclude + description: 'Turn off specified domain models when + + generating the description.' + defaultValue: None + types: + - [ + - ] + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageDescription or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.describe_image_in_stream + name: describe_image_in_stream + summary: "This operation generates a description of an image in human readable\n\ + language with complete sentences. The description is based on a\ncollection of\ + \ content tags, which are also returned by the operation.\nMore than one description\ + \ can be generated for each image. Descriptions\nare ordered by their confidence\ + \ score. Descriptions may include results\nfrom celebrity and landmark domain\ + \ models, if applicable.\nTwo input methods are supported \u2013 (1) Uploading\ + \ an image or (2)\nspecifying an image URL.\nA successful response will be returned\ + \ in JSON. If the request failed,\nthe response will contain an error code and\ + \ a message to help\nunderstand what went wrong." + signature: describe_image_in_stream(image, max_candidates=1, language='en', description_exclude=None, + model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config) + parameters: + - name: image + description: An image stream. + isRequired: true + types: + - + - name: max_candidates + description: 'Maximum number of candidate descriptions to be + + returned. The default is 1.' + defaultValue: '1' + types: + - + - name: language + description: 'The desired language for output generation. If this + + parameter is not specified, the default value is + + "en".Supported languages:en - English, Default. es - + + Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. + + Possible values include: ''en'', ''es'', ''ja'', ''pt'', ''zh''' + defaultValue: en + types: + - + - name: description_exclude + description: 'Turn off specified domain models when + + generating the description.' + defaultValue: None + types: + - [ + - ] + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageDescription or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.detect_objects + name: detect_objects + summary: "Performs object detection on the specified image.\nTwo input methods are\ + \ supported \u2013 (1) Uploading an image or (2)\nspecifying an image URL.\nA\ + \ successful response will be returned in JSON. If the request failed,\nthe response\ + \ will contain an error code and a message to help\nunderstand what went wrong." + signature: detect_objects(url, model_version='latest', custom_headers=None, raw=False, + **operation_config) + parameters: + - name: url + description: Publicly reachable URL of an image. + isRequired: true + types: + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DetectResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.detect_objects_in_stream + name: detect_objects_in_stream + summary: "Performs object detection on the specified image.\nTwo input methods are\ + \ supported \u2013 (1) Uploading an image or (2)\nspecifying an image URL.\nA\ + \ successful response will be returned in JSON. If the request failed,\nthe response\ + \ will contain an error code and a message to help\nunderstand what went wrong." + signature: detect_objects_in_stream(image, model_version='latest', custom_headers=None, + raw=False, callback=None, **operation_config) + parameters: + - name: image + description: An image stream. + isRequired: true + types: + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DetectResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.generate_thumbnail + name: generate_thumbnail + summary: 'This operation generates a thumbnail image with the user-specified + + width and height. By default, the service analyzes the image, + + identifies the region of interest (ROI), and generates smart cropping + + coordinates based on the ROI. Smart cropping helps when you specify an + + aspect ratio that differs from that of the input image. + + A successful response contains the thumbnail image binary. If the + + request failed, the response contains an error code and a message to + + help determine what went wrong. + + Upon failure, the error code and an error message are returned. The + + error code could be one of InvalidImageUrl, InvalidImageFormat, + + InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, + + FailedToProcess, Timeout, or InternalServerError.' + signature: generate_thumbnail(width, height, url, smart_cropping=False, model_version='latest', + custom_headers=None, raw=False, callback=None, **operation_config) + parameters: + - name: width + description: 'Width of the thumbnail, in pixels. It must be between 1 + + and 1024. Recommended minimum of 50.' + isRequired: true + types: + - + - name: height + description: 'Height of the thumbnail, in pixels. It must be between + + 1 and 1024. Recommended minimum of 50.' + isRequired: true + types: + - + - name: url + description: Publicly reachable URL of an image. + isRequired: true + types: + - + - name: smart_cropping + description: Boolean flag for enabling smart cropping. + defaultValue: 'False' + types: + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: object or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrest.exceptions.HttpOperationError +- uid: azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.generate_thumbnail_in_stream + name: generate_thumbnail_in_stream + summary: 'This operation generates a thumbnail image with the user-specified + + width and height. By default, the service analyzes the image, + + identifies the region of interest (ROI), and generates smart cropping + + coordinates based on the ROI. Smart cropping helps when you specify an + + aspect ratio that differs from that of the input image. + + A successful response contains the thumbnail image binary. If the + + request failed, the response contains an error code and a message to + + help determine what went wrong. + + Upon failure, the error code and an error message are returned. The + + error code could be one of InvalidImageUrl, InvalidImageFormat, + + InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, + + FailedToProcess, Timeout, or InternalServerError.' + signature: generate_thumbnail_in_stream(width, height, image, smart_cropping=False, + model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config) + parameters: + - name: width + description: 'Width of the thumbnail, in pixels. It must be between 1 + + and 1024. Recommended minimum of 50.' + isRequired: true + types: + - + - name: height + description: 'Height of the thumbnail, in pixels. It must be between + + 1 and 1024. Recommended minimum of 50.' + isRequired: true + types: + - + - name: image + description: An image stream. + isRequired: true + types: + - + - name: smart_cropping + description: Boolean flag for enabling smart cropping. + defaultValue: 'False' + types: + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: object or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrest.exceptions.HttpOperationError +- uid: azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.get_area_of_interest + name: get_area_of_interest + summary: 'This operation returns a bounding box around the most important area of + + the image. + + A successful response will be returned in JSON. If the request failed, + + the response contains an error code and a message to help determine + + what went wrong. + + Upon failure, the error code and an error message are returned. The + + error code could be one of InvalidImageUrl, InvalidImageFormat, + + InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or + + InternalServerError.' + signature: get_area_of_interest(url, model_version='latest', custom_headers=None, + raw=False, **operation_config) + parameters: + - name: url + description: Publicly reachable URL of an image. + isRequired: true + types: + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: AreaOfInterestResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.get_area_of_interest_in_stream + name: get_area_of_interest_in_stream + summary: 'This operation returns a bounding box around the most important area of + + the image. + + A successful response will be returned in JSON. If the request failed, + + the response contains an error code and a message to help determine + + what went wrong. + + Upon failure, the error code and an error message are returned. The + + error code could be one of InvalidImageUrl, InvalidImageFormat, + + InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or + + InternalServerError.' + signature: get_area_of_interest_in_stream(image, model_version='latest', custom_headers=None, + raw=False, callback=None, **operation_config) + parameters: + - name: image + description: An image stream. + isRequired: true + types: + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: AreaOfInterestResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.get_read_result + name: get_read_result + summary: 'This interface is used for getting OCR results of Read operation. The + + URL to this interface should be retrieved from ''Operation-Location'' + + field returned from Read interface.' + signature: get_read_result(operation_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: operation_id + description: 'Id of read operation returned in the response of + + the ''Read'' interface.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ReadOperationResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrErrorException +- uid: azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.list_models + name: list_models + summary: 'This operation returns the list of domain-specific models that are + + supported by the Computer Vision API. Currently, the API supports + + following domain-specific models: celebrity recognizer, landmark + + recognizer. + + A successful response will be returned in JSON. If the request failed, + + the response will contain an error code and a message to help + + understand what went wrong.' + signature: list_models(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ListModelsResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.read + name: read + summary: "Use this interface to get the result of a Read operation, employing the\n\ + state-of-the-art Optical Character Recognition (OCR) algorithms\noptimized for\ + \ text-heavy documents. When you use the Read interface,\nthe response contains\ + \ a field called 'Operation-Location'. The\n'Operation-Location' field contains\ + \ the URL that you must use for your\n'GetReadResult' operation to access OCR\ + \ results.\u200B." + signature: read(url, language=None, pages=None, model_version='latest', reading_order='basic', + custom_headers=None, raw=False, **operation_config) + parameters: + - name: url + description: Publicly reachable URL of an image. + isRequired: true + types: + - + - name: language + description: 'The BCP-47 language code of the text in the document. + + Read supports auto language identification and multi-language + + documents, so only provide a language code if you would like to force + + the document to be processed in that specific language. See + + [https://aka.ms/ocr-languages](https://aka.ms/ocr-languages) for list of supported + languages. Possible + + values include: ''af'', ''ast'', ''bi'', ''br'', ''ca'', ''ceb'', ''ch'', ''co'', + + ''crh'', ''cs'', ''csb'', ''da'', ''de'', ''en'', ''es'', ''et'', ''eu'', ''fi'', + ''fil'', + + ''fj'', ''fr'', ''fur'', ''fy'', ''ga'', ''gd'', ''gil'', ''gl'', ''gv'', ''hni'', + ''hsb'', + + ''ht'', ''hu'', ''ia'', ''id'', ''it'', ''iu'', ''ja'', ''jv'', ''kaa'', ''kac'', + ''kea'', + + ''kha'', ''kl'', ''ko'', ''ku'', ''kw'', ''lb'', ''ms'', ''mww'', ''nap'', ''nl'', + ''no'', + + ''oc'', ''pl'', ''pt'', ''quc'', ''rm'', ''sco'', ''sl'', ''sq'', ''sv'', ''sw'', + ''tet'', + + ''tr'', ''tt'', ''uz'', ''vo'', ''wae'', ''yua'', ''za'', ''zh-Hans'', ''zh-Hant'', + ''zu''' + defaultValue: None + types: + - + - + - name: pages + description: 'Custom page numbers for multi-page documents(PDF/TIFF), + + input the number of the pages you want to get OCR result. For a range + + of pages, use a hyphen. Separate each page or range with a comma.' + defaultValue: None + types: + - [] + - name: model_version + description: 'Optional parameter to specify the version of the + + OCR model used for text extraction. Accepted values are: "latest", + + "latest-preview", "2021-04-12". Defaults to "latest".' + defaultValue: latest + types: + - + - name: reading_order + description: 'Optional parameter to specify which reading + + order algorithm should be applied when ordering the extract text + + elements. Can be either ''basic'' or ''natural''. Will default to ''basic'' + + if not specified' + defaultValue: basic + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrErrorException +- uid: azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.read_in_stream + name: read_in_stream + summary: "Use this interface to get the result of a Read operation, employing the\n\ + state-of-the-art Optical Character Recognition (OCR) algorithms\noptimized for\ + \ text-heavy documents. When you use the Read interface,\nthe response contains\ + \ a field called 'Operation-Location'. The\n'Operation-Location' field contains\ + \ the URL that you must use for your\n'GetReadResult' operation to access OCR\ + \ results.\u200B." + signature: read_in_stream(image, language=None, pages=None, model_version='latest', + reading_order='basic', custom_headers=None, raw=False, callback=None, **operation_config) + parameters: + - name: image + description: An image stream. + isRequired: true + types: + - + - name: language + description: 'The BCP-47 language code of the text in the document. + + Read supports auto language identification and multi-language + + documents, so only provide a language code if you would like to force + + the document to be processed in that specific language. See + + [https://aka.ms/ocr-languages](https://aka.ms/ocr-languages) for list of supported + languages. Possible + + values include: ''af'', ''ast'', ''bi'', ''br'', ''ca'', ''ceb'', ''ch'', ''co'', + + ''crh'', ''cs'', ''csb'', ''da'', ''de'', ''en'', ''es'', ''et'', ''eu'', ''fi'', + ''fil'', + + ''fj'', ''fr'', ''fur'', ''fy'', ''ga'', ''gd'', ''gil'', ''gl'', ''gv'', ''hni'', + ''hsb'', + + ''ht'', ''hu'', ''ia'', ''id'', ''it'', ''iu'', ''ja'', ''jv'', ''kaa'', ''kac'', + ''kea'', + + ''kha'', ''kl'', ''ko'', ''ku'', ''kw'', ''lb'', ''ms'', ''mww'', ''nap'', ''nl'', + ''no'', + + ''oc'', ''pl'', ''pt'', ''quc'', ''rm'', ''sco'', ''sl'', ''sq'', ''sv'', ''sw'', + ''tet'', + + ''tr'', ''tt'', ''uz'', ''vo'', ''wae'', ''yua'', ''za'', ''zh-Hans'', ''zh-Hant'', + ''zu''' + defaultValue: None + types: + - + - + - name: pages + description: 'Custom page numbers for multi-page documents(PDF/TIFF), + + input the number of the pages you want to get OCR result. For a range + + of pages, use a hyphen. Separate each page or range with a comma.' + defaultValue: None + types: + - [] + - name: model_version + description: 'Optional parameter to specify the version of the + + OCR model used for text extraction. Accepted values are: "latest", + + "latest-preview", "2021-04-12". Defaults to "latest".' + defaultValue: latest + types: + - + - name: reading_order + description: 'Optional parameter to specify which reading + + order algorithm should be applied when ordering the extract text + + elements. Can be either ''basic'' or ''natural''. Will default to ''basic'' + + if not specified' + defaultValue: basic + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrErrorException +- uid: azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.recognize_printed_text + name: recognize_printed_text + summary: 'Optical Character Recognition (OCR) detects text in an image and + + extracts the recognized characters into a machine-usable character + + stream. + + Upon success, the OCR results will be returned. + + Upon failure, the error code together with an error message will be + + returned. The error code can be one of InvalidImageUrl, + + InvalidImageFormat, InvalidImageSize, NotSupportedImage, + + NotSupportedLanguage, or InternalServerError.' + signature: recognize_printed_text(url, detect_orientation=True, language='unk', + model_version='latest', custom_headers=None, raw=False, **operation_config) + parameters: + - name: detect_orientation + description: 'Whether detect the text orientation in the + + image. With detectOrientation=true the OCR service tries to detect the + + image orientation and correct it before further processing (e.g. if + + it''s upside-down).' + defaultValue: 'True' + types: + - + - name: url + description: Publicly reachable URL of an image. + isRequired: true + types: + - + - name: language + description: 'The BCP-47 language code of the text to be detected + + in the image. The default value is ''unk''. Possible values include: + + ''unk'', ''zh-Hans'', ''zh-Hant'', ''cs'', ''da'', ''nl'', ''en'', ''fi'', ''fr'', + ''de'', + + ''el'', ''hu'', ''it'', ''ja'', ''ko'', ''nb'', ''pl'', ''pt'', ''ru'', ''es'', + ''sv'', + + ''tr'', ''ar'', ''ro'', ''sr-Cyrl'', ''sr-Latn'', ''sk''' + defaultValue: unk + types: + - + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OcrResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.recognize_printed_text_in_stream + name: recognize_printed_text_in_stream + summary: 'Optical Character Recognition (OCR) detects text in an image and + + extracts the recognized characters into a machine-usable character + + stream. + + Upon success, the OCR results will be returned. + + Upon failure, the error code together with an error message will be + + returned. The error code can be one of InvalidImageUrl, + + InvalidImageFormat, InvalidImageSize, NotSupportedImage, + + NotSupportedLanguage, or InternalServerError.' + signature: recognize_printed_text_in_stream(image, detect_orientation=True, language='unk', + model_version='latest', custom_headers=None, raw=False, callback=None, **operation_config) + parameters: + - name: detect_orientation + description: 'Whether detect the text orientation in the + + image. With detectOrientation=true the OCR service tries to detect the + + image orientation and correct it before further processing (e.g. if + + it''s upside-down).' + defaultValue: 'True' + types: + - + - name: image + description: An image stream. + isRequired: true + types: + - + - name: language + description: 'The BCP-47 language code of the text to be detected + + in the image. The default value is ''unk''. Possible values include: + + ''unk'', ''zh-Hans'', ''zh-Hant'', ''cs'', ''da'', ''nl'', ''en'', ''fi'', ''fr'', + ''de'', + + ''el'', ''hu'', ''it'', ''ja'', ''ko'', ''nb'', ''pl'', ''pt'', ''ru'', ''es'', + ''sv'', + + ''tr'', ''ar'', ''ro'', ''sr-Cyrl'', ''sr-Latn'', ''sk''' + defaultValue: unk + types: + - + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OcrResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.tag_image + name: tag_image + summary: "This operation generates a list of words, or tags, that are relevant to\n\ + the content of the supplied image. The Computer Vision API can return\ntags based\ + \ on objects, living beings, scenery or actions found in\nimages. Unlike categories,\ + \ tags are not organized according to a\nhierarchical classification system, but\ + \ correspond to image content.\nTags may contain hints to avoid ambiguity or provide\ + \ context, for\nexample the tag \"ascomycete\" may be accompanied by the hint\ + \ \"fungus\".\nTwo input methods are supported \u2013 (1) Uploading an image or\ + \ (2)\nspecifying an image URL.\nA successful response will be returned in JSON.\ + \ If the request failed,\nthe response will contain an error code and a message\ + \ to help\nunderstand what went wrong." + signature: tag_image(url, language='en', model_version='latest', custom_headers=None, + raw=False, **operation_config) + parameters: + - name: url + description: Publicly reachable URL of an image. + isRequired: true + types: + - + - name: language + description: 'The desired language for output generation. If this + + parameter is not specified, the default value is + + "en".Supported languages:en - English, Default. es - + + Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. + + Possible values include: ''en'', ''es'', ''ja'', ''pt'', ''zh''' + defaultValue: en + types: + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: TagResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException +- uid: azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin.tag_image_in_stream + name: tag_image_in_stream + summary: "This operation generates a list of words, or tags, that are relevant to\n\ + the content of the supplied image. The Computer Vision API can return\ntags based\ + \ on objects, living beings, scenery or actions found in\nimages. Unlike categories,\ + \ tags are not organized according to a\nhierarchical classification system, but\ + \ correspond to image content.\nTags may contain hints to avoid ambiguity or provide\ + \ context, for\nexample the tag \"ascomycete\" may be accompanied by the hint\ + \ \"fungus\".\nTwo input methods are supported \u2013 (1) Uploading an image or\ + \ (2)\nspecifying an image URL.\nA successful response will be returned in JSON.\ + \ If the request failed,\nthe response will contain an error code and a message\ + \ to help\nunderstand what went wrong." + signature: tag_image_in_stream(image, language='en', model_version='latest', custom_headers=None, + raw=False, callback=None, **operation_config) + parameters: + - name: image + description: An image stream. + isRequired: true + types: + - + - name: language + description: 'The desired language for output generation. If this + + parameter is not specified, the default value is + + "en".Supported languages:en - English, Default. es - + + Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. + + Possible values include: ''en'', ''es'', ''ja'', ''pt'', ''zh''' + defaultValue: en + types: + - + - name: model_version + description: 'Optional parameter to specify the version of the + + AI model. Accepted values are: "latest", "2021-04-01". Defaults to + + "latest".' + defaultValue: latest + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: TagResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.operations.yml new file mode 100644 index 00000000..5a61ee7c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.operations.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.vision.computervision.operations +name: operations +fullName: azure.cognitiveservices.vision.computervision.operations +type: import +classes: +- azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.version.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.version.yml new file mode 100644 index 00000000..40685dc9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.vision.computervision.version +name: version +fullName: azure.cognitiveservices.vision.computervision.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.yml new file mode 100644 index 00000000..a635617e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.vision.computervision +name: computervision +fullName: azure.cognitiveservices.vision.computervision +type: rootImport +classes: +- azure.cognitiveservices.vision.computervision.ComputerVisionClient +- azure.cognitiveservices.vision.computervision.ComputerVisionClientConfiguration +packages: +- azure.cognitiveservices.vision.computervision.models +- azure.cognitiveservices.vision.computervision.operations +modules: +- azure.cognitiveservices.vision.computervision.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.ContentModeratorClient.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.ContentModeratorClient.yml new file mode 100644 index 00000000..a0c2b576 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.ContentModeratorClient.yml @@ -0,0 +1,72 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.ContentModeratorClient +name: ContentModeratorClient +fullName: azure.cognitiveservices.vision.contentmoderator.ContentModeratorClient +module: azure.cognitiveservices.vision.contentmoderator +summary: 'You use the API to scan your content as it is generated. Content Moderator + then processes your content and sends the results along with relevant information + either back to your systems or to the built-in review tool. You can use this information + to take decisions e.g. take it down, send to human judge, etc. + + When using the API, images need to have a minimum of 128 pixels and a maximum file + size of 4MB. + + Text can be at most 1024 characters long. + + If the content passed to the text API or the image API exceeds the size limits, + the API will return an error code that informs about the issue.' +constructor: + syntax: ContentModeratorClient(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and + + hostname, for example: [https://westus.api.cognitive.microsoft.com](https://westus.api.cognitive.microsoft.com)).' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +- description: ImageModeration operations + name: image_moderation + types: + - +- description: TextModeration operations + name: text_moderation + types: + - +- description: ListManagementImageLists operations + name: list_management_image_lists + types: + - +- description: ListManagementTermLists operations + name: list_management_term_lists + types: + - +- description: ListManagementImage operations + name: list_management_image + types: + - +- description: ListManagementTerm operations + name: list_management_term + types: + - +- description: Reviews operations + name: reviews + types: + - +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.ContentModeratorClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.content_moderator_client.ContentModeratorClient.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.content_moderator_client.ContentModeratorClient.yml new file mode 100644 index 00000000..2f345ce9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.content_moderator_client.ContentModeratorClient.yml @@ -0,0 +1,72 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.content_moderator_client.ContentModeratorClient +name: ContentModeratorClient +fullName: azure.cognitiveservices.vision.contentmoderator.content_moderator_client.ContentModeratorClient +module: azure.cognitiveservices.vision.contentmoderator.content_moderator_client +summary: 'You use the API to scan your content as it is generated. Content Moderator + then processes your content and sends the results along with relevant information + either back to your systems or to the built-in review tool. You can use this information + to take decisions e.g. take it down, send to human judge, etc. + + When using the API, images need to have a minimum of 128 pixels and a maximum file + size of 4MB. + + Text can be at most 1024 characters long. + + If the content passed to the text API or the image API exceeds the size limits, + the API will return an error code that informs about the issue.' +constructor: + syntax: ContentModeratorClient(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and + + hostname, for example: [https://westus.api.cognitive.microsoft.com](https://westus.api.cognitive.microsoft.com)).' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +- description: ImageModeration operations + name: image_moderation + types: + - +- description: TextModeration operations + name: text_moderation + types: + - +- description: ListManagementImageLists operations + name: list_management_image_lists + types: + - +- description: ListManagementTermLists operations + name: list_management_term_lists + types: + - +- description: ListManagementImage operations + name: list_management_image + types: + - +- description: ListManagementTerm operations + name: list_management_term + types: + - +- description: Reviews operations + name: reviews + types: + - +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.content_moderator_client.ContentModeratorClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.content_moderator_client.ContentModeratorClientConfiguration.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.content_moderator_client.ContentModeratorClientConfiguration.yml new file mode 100644 index 00000000..bf7bb013 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.content_moderator_client.ContentModeratorClientConfiguration.yml @@ -0,0 +1,62 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.content_moderator_client.ContentModeratorClientConfiguration +name: ContentModeratorClientConfiguration +fullName: azure.cognitiveservices.vision.contentmoderator.content_moderator_client.ContentModeratorClientConfiguration +module: azure.cognitiveservices.vision.contentmoderator.content_moderator_client +summary: 'Configuration for ContentModeratorClient + + Note that all parameters used to create this instance are saved as instance + + attributes.' +constructor: + syntax: ContentModeratorClientConfiguration(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and + + hostname, for example: [https://westus.api.cognitive.microsoft.com](https://westus.api.cognitive.microsoft.com)).' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.content_moderator_client.ContentModeratorClientConfiguration.add_user_agent + name: add_user_agent + summary: Add value to current user agent with a space. + signature: 'add_user_agent(value: str) -> None' + parameters: + - name: value + description: value to add to user agent. + isRequired: true + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.content_moderator_client.ContentModeratorClientConfiguration.load + name: load + signature: load(filepath) + parameters: + - name: filepath + isRequired: true +- uid: azure.cognitiveservices.vision.contentmoderator.content_moderator_client.ContentModeratorClientConfiguration.save + name: save + summary: Save current configuration to file. + signature: save(filepath) + parameters: + - name: filepath + description: Path to file where settings will be saved. + isRequired: true + types: + - + exceptions: + - type: ValueError if supplied filepath cannot be written to. +attributes: +- uid: azure.cognitiveservices.vision.contentmoderator.content_moderator_client.ContentModeratorClientConfiguration.enable_http_logger + name: enable_http_logger +- uid: azure.cognitiveservices.vision.contentmoderator.content_moderator_client.ContentModeratorClientConfiguration.user_agent + name: user_agent + summary: The current user agent value. diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.content_moderator_client.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.content_moderator_client.yml new file mode 100644 index 00000000..5fd0cf09 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.content_moderator_client.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.vision.contentmoderator.content_moderator_client +name: content_moderator_client +fullName: azure.cognitiveservices.vision.contentmoderator.content_moderator_client +classes: +- azure.cognitiveservices.vision.contentmoderator.content_moderator_client.ContentModeratorClient +- azure.cognitiveservices.vision.contentmoderator.content_moderator_client.ContentModeratorClientConfiguration diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.APIError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.APIError.yml new file mode 100644 index 00000000..b838f8eb --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.APIError.yml @@ -0,0 +1,122 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.APIError +name: APIError +fullName: azure.cognitiveservices.vision.contentmoderator.models.APIError +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Error information returned by the API. +constructor: + syntax: APIError(*, error=None, **kwargs) + parameters: + - name: error + isRequired: true + types: + - + keywordOnlyParameters: + - name: error + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.APIError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.APIError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.APIError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.APIError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.APIError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.APIError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.APIError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.APIErrorException.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.APIErrorException.yml new file mode 100644 index 00000000..7e897589 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.APIErrorException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +name: APIErrorException +fullName: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +module: azure.cognitiveservices.vision.contentmoderator.models +summary: 'Server responded with exception of type: ''APIError''.' +constructor: + syntax: APIErrorException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException.args + name: args diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Address.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Address.yml new file mode 100644 index 00000000..60973e93 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Address.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.Address +name: Address +fullName: azure.cognitiveservices.vision.contentmoderator.models.Address +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Address details. +constructor: + syntax: 'Address(*, text: str = None, index: int = None, **kwargs)' + parameters: + - name: text + description: Detected Address. + isRequired: true + types: + - + - name: index + description: Index(Location) of the Address in the input text content. + isRequired: true + types: + - + keywordOnlyParameters: + - name: text + isRequired: true + - name: index + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.Address.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Address.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Address.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Address.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Address.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Address.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Address.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Body.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Body.yml new file mode 100644 index 00000000..1a2688e8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Body.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.Body +name: Body +fullName: azure.cognitiveservices.vision.contentmoderator.models.Body +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Body. +constructor: + syntax: 'Body(*, name: str = None, description: str = None, metadata=None, **kwargs)' + parameters: + - name: name + description: Name of the list. + isRequired: true + types: + - + - name: description + description: Description of the list. + isRequired: true + types: + - + - name: metadata + description: Metadata of the list. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: name + isRequired: true + - name: description + isRequired: true + - name: metadata + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.Body.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Body.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Body.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Body.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Body.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Body.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Body.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.BodyModel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.BodyModel.yml new file mode 100644 index 00000000..3c8ad6e5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.BodyModel.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.BodyModel +name: BodyModel +fullName: azure.cognitiveservices.vision.contentmoderator.models.BodyModel +module: azure.cognitiveservices.vision.contentmoderator.models +summary: BodyModel. +constructor: + syntax: 'BodyModel(*, data_representation: str = ''URL'', value: str = None, **kwargs)' + parameters: + - name: data_representation + description: 'Default value: "URL" .' + isRequired: true + types: + - + - name: value + isRequired: true + types: + - + keywordOnlyParameters: + - name: data_representation + defaultValue: URL + - name: value + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.BodyModel.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.BodyModel.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.BodyModel.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.BodyModel.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.BodyModel.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.BodyModel.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.BodyModel.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Candidate.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Candidate.yml new file mode 100644 index 00000000..bc97f7e4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Candidate.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.Candidate +name: Candidate +fullName: azure.cognitiveservices.vision.contentmoderator.models.Candidate +module: azure.cognitiveservices.vision.contentmoderator.models +summary: OCR candidate text. +constructor: + syntax: 'Candidate(*, text: str = None, confidence: float = None, **kwargs)' + parameters: + - name: text + description: The text found. + isRequired: true + types: + - + - name: confidence + description: The confidence level. + isRequired: true + types: + - + keywordOnlyParameters: + - name: text + isRequired: true + - name: confidence + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.Candidate.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Candidate.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Candidate.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Candidate.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Candidate.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Candidate.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Candidate.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Classification.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Classification.yml new file mode 100644 index 00000000..4b34234d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Classification.yml @@ -0,0 +1,160 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.Classification +name: Classification +fullName: azure.cognitiveservices.vision.contentmoderator.models.Classification +module: azure.cognitiveservices.vision.contentmoderator.models +summary: The classification details of the text. +constructor: + syntax: 'Classification(*, category1=None, category2=None, category3=None, review_recommended: + bool = None, **kwargs)' + parameters: + - name: category1 + description: 'The category1 score details of the text. Click + here for more + + details on category classification.' + isRequired: true + types: + - + - name: category2 + description: 'The category2 score details of the text. Click + here for more + + details on category classification.' + isRequired: true + types: + - + - name: category3 + description: 'The category3 score details of the text. Click + here for more + + details on category classification.' + isRequired: true + types: + - + - name: review_recommended + description: The review recommended flag. + isRequired: true + types: + - + keywordOnlyParameters: + - name: category1 + isRequired: true + - name: category2 + isRequired: true + - name: category3 + isRequired: true + - name: review_recommended + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.Classification.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Classification.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Classification.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Classification.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Classification.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Classification.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Classification.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory1.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory1.yml new file mode 100644 index 00000000..05b9d1f7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory1.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory1 +name: ClassificationCategory1 +fullName: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory1 +module: azure.cognitiveservices.vision.contentmoderator.models +summary: 'The category1 score details of the text. Click + here for more + + details on category classification.' +constructor: + syntax: 'ClassificationCategory1(*, score: float = None, **kwargs)' + parameters: + - name: score + description: The category1 score. + isRequired: true + types: + - + keywordOnlyParameters: + - name: score + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory1.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory1.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory1.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory1.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory1.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory1.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory1.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory2.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory2.yml new file mode 100644 index 00000000..af7365dd --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory2.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory2 +name: ClassificationCategory2 +fullName: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory2 +module: azure.cognitiveservices.vision.contentmoderator.models +summary: 'The category2 score details of the text. Click + here for more + + details on category classification.' +constructor: + syntax: 'ClassificationCategory2(*, score: float = None, **kwargs)' + parameters: + - name: score + description: The category2 score. + isRequired: true + types: + - + keywordOnlyParameters: + - name: score + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory2.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory2.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory2.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory2.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory2.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory2.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory2.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory3.yml new file mode 100644 index 00000000..4124fa1c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory3.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory3 +name: ClassificationCategory3 +fullName: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory3 +module: azure.cognitiveservices.vision.contentmoderator.models +summary: 'The category3 score details of the text. Click + here for more + + details on category classification.' +constructor: + syntax: 'ClassificationCategory3(*, score: float = None, **kwargs)' + parameters: + - name: score + description: The category3 score. + isRequired: true + types: + - + keywordOnlyParameters: + - name: score + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory3.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory3.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory3.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory3.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory3.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory3.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory3.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Content.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Content.yml new file mode 100644 index 00000000..7ec571b4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Content.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.Content +name: Content +fullName: azure.cognitiveservices.vision.contentmoderator.models.Content +module: azure.cognitiveservices.vision.contentmoderator.models +summary: 'Content. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Content(*, content_value: str, **kwargs)' + parameters: + - name: content_value + description: Required. Content to evaluate for a job. + isRequired: true + types: + - + keywordOnlyParameters: + - name: content_value + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.Content.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Content.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Content.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Content.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Content.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Content.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Content.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItem.yml new file mode 100644 index 00000000..446e051a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItem.yml @@ -0,0 +1,158 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItem +name: CreateReviewBodyItem +fullName: azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItem +module: azure.cognitiveservices.vision.contentmoderator.models +summary: 'Schema items of the body. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CreateReviewBodyItem(*, type, content: str, content_id: str, callback_endpoint: + str = None, metadata=None, **kwargs)' + parameters: + - name: type + description: 'Required. Type of the content. Possible values include: + + ''Image'', ''Text''' + isRequired: true + types: + - + - + - name: content + description: Required. Content to review. + isRequired: true + types: + - + - name: content_id + description: Required. Content Identifier. + isRequired: true + types: + - + - name: callback_endpoint + description: Optional CallbackEndpoint. + isRequired: true + types: + - + - name: metadata + description: Optional metadata details. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: type + isRequired: true + - name: content + isRequired: true + - name: content_id + isRequired: true + - name: callback_endpoint + isRequired: true + - name: metadata + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItemMetadataItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItemMetadataItem.yml new file mode 100644 index 00000000..6035e8fe --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItemMetadataItem.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItemMetadataItem +name: CreateReviewBodyItemMetadataItem +fullName: azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItemMetadataItem +module: azure.cognitiveservices.vision.contentmoderator.models +summary: 'CreateReviewBodyItemMetadataItem. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CreateReviewBodyItemMetadataItem(*, key: str, value: str, **kwargs)' + parameters: + - name: key + description: Required. Your key parameter. + isRequired: true + types: + - + - name: value + description: Required. Your value parameter. + isRequired: true + types: + - + keywordOnlyParameters: + - name: key + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItemMetadataItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItemMetadataItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItemMetadataItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItemMetadataItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItemMetadataItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItemMetadataItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItemMetadataItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItem.yml new file mode 100644 index 00000000..87e24502 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItem.yml @@ -0,0 +1,188 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItem +name: CreateVideoReviewsBodyItem +fullName: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItem +module: azure.cognitiveservices.vision.contentmoderator.models +summary: 'Schema items of the body. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CreateVideoReviewsBodyItem(*, content: str, content_id: str, status, video_frames=None, + metadata=None, timescale: int = None, callback_endpoint: str = None, **kwargs)' + parameters: + - name: video_frames + description: Optional metadata details. + isRequired: true + types: + - [] + - name: metadata + description: Optional metadata details. + isRequired: true + types: + - [] + - name: content + description: Required. Video content url to review. + isRequired: true + types: + - + - name: content_id + description: Required. Content Identifier. + isRequired: true + types: + - + - name: status + description: 'Required. Status of the + + video(Complete,Unpublished,Pending). Possible values include: ''Complete'', + + ''Unpublished'', ''Pending''' + isRequired: true + types: + - + - + - name: timescale + description: Timescale of the video. + isRequired: true + types: + - + - name: callback_endpoint + description: Optional CallbackEndpoint. + isRequired: true + types: + - + keywordOnlyParameters: + - name: content + isRequired: true + - name: content_id + isRequired: true + - name: status + isRequired: true + - name: video_frames + isRequired: true + - name: metadata + isRequired: true + - name: timescale + isRequired: true + - name: callback_endpoint + isRequired: true +variables: +- description: 'Required. Type of the content. Default value: "Video" .' + name: type + types: + - +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +attributes: +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItem.type + name: type + signature: type = 'Video' diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemMetadataItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemMetadataItem.yml new file mode 100644 index 00000000..286ecc94 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemMetadataItem.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemMetadataItem +name: CreateVideoReviewsBodyItemMetadataItem +fullName: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemMetadataItem +module: azure.cognitiveservices.vision.contentmoderator.models +summary: 'CreateVideoReviewsBodyItemMetadataItem. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CreateVideoReviewsBodyItemMetadataItem(*, key: str, value: str, **kwargs)' + parameters: + - name: key + description: Required. Your key parameter. + isRequired: true + types: + - + - name: value + description: Required. Your value parameter. + isRequired: true + types: + - + keywordOnlyParameters: + - name: key + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemMetadataItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemMetadataItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemMetadataItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemMetadataItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemMetadataItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemMetadataItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemMetadataItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItem.yml new file mode 100644 index 00000000..713fe9a2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItem.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItem +name: CreateVideoReviewsBodyItemVideoFramesItem +fullName: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItem +module: azure.cognitiveservices.vision.contentmoderator.models +summary: 'CreateVideoReviewsBodyItemVideoFramesItem. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CreateVideoReviewsBodyItemVideoFramesItem(*, id: str, timestamp: int, frame_image: + str, reviewer_result_tags=None, metadata=None, **kwargs)' + parameters: + - name: id + description: Required. Id of the frame. + isRequired: true + types: + - + - name: timestamp + description: Required. Timestamp of the frame. + isRequired: true + types: + - + - name: frame_image + description: Required. Frame image Url. + isRequired: true + types: + - + - name: reviewer_result_tags + isRequired: true + types: + - [] + - name: metadata + description: Optional metadata details. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: timestamp + isRequired: true + - name: frame_image + isRequired: true + - name: reviewer_result_tags + isRequired: true + - name: metadata + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemMetadataItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemMetadataItem.yml new file mode 100644 index 00000000..cbb40ea5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemMetadataItem.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemMetadataItem +name: CreateVideoReviewsBodyItemVideoFramesItemMetadataItem +fullName: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemMetadataItem +module: azure.cognitiveservices.vision.contentmoderator.models +summary: 'CreateVideoReviewsBodyItemVideoFramesItemMetadataItem. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CreateVideoReviewsBodyItemVideoFramesItemMetadataItem(*, key: str, value: + str, **kwargs)' + parameters: + - name: key + description: Required. Your key parameter. + isRequired: true + types: + - + - name: value + description: Required. Your value parameter. + isRequired: true + types: + - + keywordOnlyParameters: + - name: key + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemMetadataItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemMetadataItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemMetadataItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemMetadataItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemMetadataItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemMetadataItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemMetadataItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemReviewerResultTagsItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemReviewerResultTagsItem.yml new file mode 100644 index 00000000..2b090b7b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemReviewerResultTagsItem.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemReviewerResultTagsItem +name: CreateVideoReviewsBodyItemVideoFramesItemReviewerResultTagsItem +fullName: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemReviewerResultTagsItem +module: azure.cognitiveservices.vision.contentmoderator.models +summary: 'CreateVideoReviewsBodyItemVideoFramesItemReviewerResultTagsItem. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CreateVideoReviewsBodyItemVideoFramesItemReviewerResultTagsItem(*, key: + str, value: str, **kwargs)' + parameters: + - name: key + description: Required. Your key parameter. + isRequired: true + types: + - + - name: value + description: Required. Your value parameter. + isRequired: true + types: + - + keywordOnlyParameters: + - name: key + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemReviewerResultTagsItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemReviewerResultTagsItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemReviewerResultTagsItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemReviewerResultTagsItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemReviewerResultTagsItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemReviewerResultTagsItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemReviewerResultTagsItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.DetectedLanguage.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.DetectedLanguage.yml new file mode 100644 index 00000000..01265458 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.DetectedLanguage.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.DetectedLanguage +name: DetectedLanguage +fullName: azure.cognitiveservices.vision.contentmoderator.models.DetectedLanguage +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Detect language result. +constructor: + syntax: 'DetectedLanguage(*, detected_language: str = None, status=None, tracking_id: + str = None, **kwargs)' + parameters: + - name: detected_language + description: The detected language. + isRequired: true + types: + - + - name: status + description: The detect language status + isRequired: true + types: + - + - name: tracking_id + description: The tracking id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: detected_language + isRequired: true + - name: status + isRequired: true + - name: tracking_id + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.DetectedLanguage.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.DetectedLanguage.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.DetectedLanguage.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.DetectedLanguage.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.DetectedLanguage.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.DetectedLanguage.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.DetectedLanguage.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.DetectedTerms.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.DetectedTerms.yml new file mode 100644 index 00000000..7e680983 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.DetectedTerms.yml @@ -0,0 +1,149 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.DetectedTerms +name: DetectedTerms +fullName: azure.cognitiveservices.vision.contentmoderator.models.DetectedTerms +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Detected Terms details. +constructor: + syntax: 'DetectedTerms(*, index: int = None, original_index: int = None, list_id: + int = None, term: str = None, **kwargs)' + parameters: + - name: index + description: 'Index(Location) of the detected profanity term in the input + + text content.' + isRequired: true + types: + - + - name: original_index + description: 'Original Index(Location) of the detected profanity + + term in the input text content.' + isRequired: true + types: + - + - name: list_id + description: Matched Terms list Id. + isRequired: true + types: + - + - name: term + description: Detected profanity term. + isRequired: true + types: + - + keywordOnlyParameters: + - name: index + isRequired: true + - name: original_index + isRequired: true + - name: list_id + isRequired: true + - name: term + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.DetectedTerms.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.DetectedTerms.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.DetectedTerms.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.DetectedTerms.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.DetectedTerms.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.DetectedTerms.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.DetectedTerms.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Email.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Email.yml new file mode 100644 index 00000000..be081c38 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Email.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.Email +name: Email +fullName: azure.cognitiveservices.vision.contentmoderator.models.Email +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Email Address details. +constructor: + syntax: 'Email(*, detected: str = None, sub_type: str = None, text: str = None, + index: int = None, **kwargs)' + parameters: + - name: detected + description: Detected Email Address from the input text content. + isRequired: true + types: + - + - name: sub_type + description: Subtype of the detected Email Address. + isRequired: true + types: + - + - name: text + description: Email Address in the input text content. + isRequired: true + types: + - + - name: index + description: 'Index(Location) of the Email address in the input text + + content.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: detected + isRequired: true + - name: sub_type + isRequired: true + - name: text + isRequired: true + - name: index + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.Email.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Email.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Email.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Email.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Email.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Email.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Email.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Error.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Error.yml new file mode 100644 index 00000000..ec9c4877 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Error.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.Error +name: Error +fullName: azure.cognitiveservices.vision.contentmoderator.models.Error +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Error body. +constructor: + syntax: 'Error(*, code: str = None, message: str = None, **kwargs)' + parameters: + - name: code + isRequired: true + types: + - + - name: message + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.Error.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Error.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Error.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Error.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Error.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Error.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Error.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Evaluate.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Evaluate.yml new file mode 100644 index 00000000..a36f56dd --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Evaluate.yml @@ -0,0 +1,186 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.Evaluate +name: Evaluate +fullName: azure.cognitiveservices.vision.contentmoderator.models.Evaluate +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Evaluate response object. +constructor: + syntax: 'Evaluate(*, cache_id: str = None, result: bool = None, tracking_id: str + = None, adult_classification_score: float = None, is_image_adult_classified: bool + = None, racy_classification_score: float = None, is_image_racy_classified: bool + = None, advanced_info=None, status=None, **kwargs)' + parameters: + - name: cache_id + description: The cache id. + isRequired: true + types: + - + - name: result + description: Evaluate result. + isRequired: true + types: + - + - name: tracking_id + description: The tracking id. + isRequired: true + types: + - + - name: adult_classification_score + description: The adult classification score. + isRequired: true + types: + - + - name: is_image_adult_classified + description: 'Indicates if an image is classified as + + adult.' + isRequired: true + types: + - + - name: racy_classification_score + description: The racy classification score. + isRequired: true + types: + - + - name: is_image_racy_classified + description: 'Indicates if the image is classified as + + racy.' + isRequired: true + types: + - + - name: advanced_info + description: The advanced info. + isRequired: true + types: + - [] + - name: status + description: The evaluate status + isRequired: true + types: + - + keywordOnlyParameters: + - name: cache_id + isRequired: true + - name: result + isRequired: true + - name: tracking_id + isRequired: true + - name: adult_classification_score + isRequired: true + - name: is_image_adult_classified + isRequired: true + - name: racy_classification_score + isRequired: true + - name: is_image_racy_classified + isRequired: true + - name: advanced_info + isRequired: true + - name: status + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.Evaluate.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Evaluate.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Evaluate.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Evaluate.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Evaluate.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Evaluate.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Evaluate.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Face.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Face.yml new file mode 100644 index 00000000..552f244a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Face.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.Face +name: Face +fullName: azure.cognitiveservices.vision.contentmoderator.models.Face +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Coordinates to the found face. +constructor: + syntax: 'Face(*, bottom: int = None, left: int = None, right: int = None, top: int + = None, **kwargs)' + parameters: + - name: bottom + description: The bottom coordinate. + isRequired: true + types: + - + - name: left + description: The left coordinate. + isRequired: true + types: + - + - name: right + description: The right coordinate. + isRequired: true + types: + - + - name: top + description: The top coordinate. + isRequired: true + types: + - + keywordOnlyParameters: + - name: bottom + isRequired: true + - name: left + isRequired: true + - name: right + isRequired: true + - name: top + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.Face.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Face.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Face.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Face.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Face.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Face.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Face.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.FoundFaces.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.FoundFaces.yml new file mode 100644 index 00000000..1e8df060 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.FoundFaces.yml @@ -0,0 +1,166 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.FoundFaces +name: FoundFaces +fullName: azure.cognitiveservices.vision.contentmoderator.models.FoundFaces +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Request object the contains found faces. +constructor: + syntax: 'FoundFaces(*, status=None, tracking_id: str = None, cache_id: str = None, + result: bool = None, count: int = None, advanced_info=None, faces=None, **kwargs)' + parameters: + - name: status + description: The evaluate status + isRequired: true + types: + - + - name: tracking_id + description: The tracking id. + isRequired: true + types: + - + - name: cache_id + description: The cache id. + isRequired: true + types: + - + - name: result + description: True if result was found. + isRequired: true + types: + - + - name: count + description: Number of faces found. + isRequired: true + types: + - + - name: advanced_info + description: The advanced info. + isRequired: true + types: + - [] + - name: faces + description: The list of faces. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: status + isRequired: true + - name: tracking_id + isRequired: true + - name: cache_id + isRequired: true + - name: result + isRequired: true + - name: count + isRequired: true + - name: advanced_info + isRequired: true + - name: faces + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.FoundFaces.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.FoundFaces.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.FoundFaces.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.FoundFaces.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.FoundFaces.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.FoundFaces.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.FoundFaces.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Frame.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Frame.yml new file mode 100644 index 00000000..e25d5f66 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Frame.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.Frame +name: Frame +fullName: azure.cognitiveservices.vision.contentmoderator.models.Frame +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Video frame property details. +constructor: + syntax: 'Frame(*, timestamp: str = None, frame_image: str = None, metadata=None, + reviewer_result_tags=None, **kwargs)' + parameters: + - name: timestamp + description: Timestamp of the frame. + isRequired: true + types: + - + - name: frame_image + description: Frame image. + isRequired: true + types: + - + - name: metadata + description: Array of KeyValue. + isRequired: true + types: + - [] + - name: reviewer_result_tags + description: Reviewer result tags. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: timestamp + isRequired: true + - name: frame_image + isRequired: true + - name: metadata + isRequired: true + - name: reviewer_result_tags + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.Frame.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Frame.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Frame.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Frame.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Frame.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Frame.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Frame.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Frames.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Frames.yml new file mode 100644 index 00000000..2f8e46ea --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Frames.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.Frames +name: Frames +fullName: azure.cognitiveservices.vision.contentmoderator.models.Frames +module: azure.cognitiveservices.vision.contentmoderator.models +summary: The response for a Get Frames request. +constructor: + syntax: 'Frames(*, review_id: str = None, video_frames=None, **kwargs)' + parameters: + - name: review_id + description: Id of the review. + isRequired: true + types: + - + - name: video_frames + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: review_id + isRequired: true + - name: video_frames + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.Frames.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Frames.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Frames.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Frames.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Frames.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Frames.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Frames.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.IPA.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.IPA.yml new file mode 100644 index 00000000..1c2e5efd --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.IPA.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.IPA +name: IPA +fullName: azure.cognitiveservices.vision.contentmoderator.models.IPA +module: azure.cognitiveservices.vision.contentmoderator.models +summary: IP Address details. +constructor: + syntax: 'IPA(*, sub_type: str = None, text: str = None, index: int = None, **kwargs)' + parameters: + - name: sub_type + description: Subtype of the detected IP Address. + isRequired: true + types: + - + - name: text + description: Detected IP Address. + isRequired: true + types: + - + - name: index + description: Index(Location) of the IP Address in the input text content. + isRequired: true + types: + - + keywordOnlyParameters: + - name: sub_type + isRequired: true + - name: text + isRequired: true + - name: index + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.IPA.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.IPA.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.IPA.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.IPA.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.IPA.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.IPA.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.IPA.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Image.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Image.yml new file mode 100644 index 00000000..e89ea15a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Image.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.Image +name: Image +fullName: azure.cognitiveservices.vision.contentmoderator.models.Image +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Image Properties. +constructor: + syntax: 'Image(*, content_id: str = None, additional_info=None, status=None, tracking_id: + str = None, **kwargs)' + parameters: + - name: content_id + description: Content Id. + isRequired: true + types: + - + - name: additional_info + description: Advanced info list. + isRequired: true + types: + - [] + - name: status + description: Status details. + isRequired: true + types: + - + - name: tracking_id + description: Tracking Id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: content_id + isRequired: true + - name: additional_info + isRequired: true + - name: status + isRequired: true + - name: tracking_id + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.Image.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Image.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Image.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Image.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Image.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Image.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Image.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageAdditionalInfoItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageAdditionalInfoItem.yml new file mode 100644 index 00000000..9b2d0b49 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageAdditionalInfoItem.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.ImageAdditionalInfoItem +name: ImageAdditionalInfoItem +fullName: azure.cognitiveservices.vision.contentmoderator.models.ImageAdditionalInfoItem +module: azure.cognitiveservices.vision.contentmoderator.models +summary: ImageAdditionalInfoItem. +constructor: + syntax: 'ImageAdditionalInfoItem(*, key: str = None, value: str = None, **kwargs)' + parameters: + - name: key + description: Key parameter. + isRequired: true + types: + - + - name: value + description: Value parameter. + isRequired: true + types: + - + keywordOnlyParameters: + - name: key + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.ImageAdditionalInfoItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.ImageAdditionalInfoItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.ImageAdditionalInfoItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.ImageAdditionalInfoItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.ImageAdditionalInfoItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.ImageAdditionalInfoItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.ImageAdditionalInfoItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageIds.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageIds.yml new file mode 100644 index 00000000..a59413c8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageIds.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.ImageIds +name: ImageIds +fullName: azure.cognitiveservices.vision.contentmoderator.models.ImageIds +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Image Id properties. +constructor: + syntax: 'ImageIds(*, content_source: str = None, content_ids=None, status=None, + tracking_id: str = None, **kwargs)' + parameters: + - name: content_source + description: Source of the content. + isRequired: true + types: + - + - name: content_ids + description: Id of the contents. + isRequired: true + types: + - [] + - name: status + description: Get Image status. + isRequired: true + types: + - + - name: tracking_id + description: Tracking Id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: content_source + isRequired: true + - name: content_ids + isRequired: true + - name: status + isRequired: true + - name: tracking_id + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.ImageIds.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.ImageIds.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.ImageIds.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.ImageIds.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.ImageIds.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.ImageIds.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.ImageIds.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageList.yml new file mode 100644 index 00000000..b74971ca --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageList.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.ImageList +name: ImageList +fullName: azure.cognitiveservices.vision.contentmoderator.models.ImageList +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Image List Properties. +constructor: + syntax: 'ImageList(*, id: int = None, name: str = None, description: str = None, + metadata=None, **kwargs)' + parameters: + - name: id + description: Image List Id. + isRequired: true + types: + - + - name: name + description: Image List Name. + isRequired: true + types: + - + - name: description + description: Description for image list. + isRequired: true + types: + - + - name: metadata + description: Image List Metadata. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: id + isRequired: true + - name: name + isRequired: true + - name: description + isRequired: true + - name: metadata + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.ImageList.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.ImageList.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.ImageList.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.ImageList.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.ImageList.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.ImageList.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.ImageList.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Job.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Job.yml new file mode 100644 index 00000000..5c755ffe --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Job.yml @@ -0,0 +1,183 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.Job +name: Job +fullName: azure.cognitiveservices.vision.contentmoderator.models.Job +module: azure.cognitiveservices.vision.contentmoderator.models +summary: The Job object. +constructor: + syntax: 'Job(*, id: str = None, team_name: str = None, status: str = None, workflow_id: + str = None, type: str = None, call_back_endpoint: str = None, review_id: str = + None, result_meta_data=None, job_execution_report=None, **kwargs)' + parameters: + - name: id + description: The job id. + isRequired: true + types: + - + - name: team_name + description: The team name associated with the job. + isRequired: true + types: + - + - name: status + description: The status string (). + isRequired: true + types: + - + - name: workflow_id + description: The Id of the workflow. + isRequired: true + types: + - + - name: type + description: Type of the content. + isRequired: true + types: + - + - name: call_back_endpoint + description: The callback endpoint. + isRequired: true + types: + - + - name: review_id + description: Review Id if one is created. + isRequired: true + types: + - + - name: result_meta_data + description: Array of KeyValue pairs. + isRequired: true + types: + - [] + - name: job_execution_report + description: 'Job execution report- Array of KeyValue pairs + + object.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: team_name + isRequired: true + - name: status + isRequired: true + - name: workflow_id + isRequired: true + - name: type + isRequired: true + - name: call_back_endpoint + isRequired: true + - name: review_id + isRequired: true + - name: result_meta_data + isRequired: true + - name: job_execution_report + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.Job.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Job.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Job.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Job.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Job.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Job.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Job.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobExecutionReportDetails.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobExecutionReportDetails.yml new file mode 100644 index 00000000..c48c2aab --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobExecutionReportDetails.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.JobExecutionReportDetails +name: JobExecutionReportDetails +fullName: azure.cognitiveservices.vision.contentmoderator.models.JobExecutionReportDetails +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Job Execution Report Values. +constructor: + syntax: 'JobExecutionReportDetails(*, ts: str = None, msg: str = None, **kwargs)' + parameters: + - name: ts + description: Time details. + isRequired: true + types: + - + - name: msg + description: Message details. + isRequired: true + types: + - + keywordOnlyParameters: + - name: ts + isRequired: true + - name: msg + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.JobExecutionReportDetails.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.JobExecutionReportDetails.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.JobExecutionReportDetails.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.JobExecutionReportDetails.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.JobExecutionReportDetails.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.JobExecutionReportDetails.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.JobExecutionReportDetails.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobId.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobId.yml new file mode 100644 index 00000000..99f7090e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobId.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.JobId +name: JobId +fullName: azure.cognitiveservices.vision.contentmoderator.models.JobId +module: azure.cognitiveservices.vision.contentmoderator.models +summary: JobId. +constructor: + syntax: 'JobId(*, job_id: str = None, **kwargs)' + parameters: + - name: job_id + description: Id of the created job. + isRequired: true + types: + - + keywordOnlyParameters: + - name: job_id + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.JobId.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.JobId.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.JobId.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.JobId.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.JobId.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.JobId.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.JobId.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobListResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobListResult.yml new file mode 100644 index 00000000..7d102e78 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobListResult.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.JobListResult +name: JobListResult +fullName: azure.cognitiveservices.vision.contentmoderator.models.JobListResult +module: azure.cognitiveservices.vision.contentmoderator.models +summary: The list of job ids. +constructor: + syntax: JobListResult(*, value=None, **kwargs) + parameters: + - name: value + description: The job id. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: value + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.JobListResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.JobListResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.JobListResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.JobListResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.JobListResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.JobListResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.JobListResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.KeyValuePair.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.KeyValuePair.yml new file mode 100644 index 00000000..3a5f5afa --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.KeyValuePair.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.KeyValuePair +name: KeyValuePair +fullName: azure.cognitiveservices.vision.contentmoderator.models.KeyValuePair +module: azure.cognitiveservices.vision.contentmoderator.models +summary: The key value pair object properties. +constructor: + syntax: 'KeyValuePair(*, key: str = None, value: str = None, **kwargs)' + parameters: + - name: key + description: The key parameter. + isRequired: true + types: + - + - name: value + description: The value parameter. + isRequired: true + types: + - + keywordOnlyParameters: + - name: key + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.KeyValuePair.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.KeyValuePair.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.KeyValuePair.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.KeyValuePair.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.KeyValuePair.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.KeyValuePair.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.KeyValuePair.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Match.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Match.yml new file mode 100644 index 00000000..45213570 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Match.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.Match +name: Match +fullName: azure.cognitiveservices.vision.contentmoderator.models.Match +module: azure.cognitiveservices.vision.contentmoderator.models +summary: The match details. +constructor: + syntax: 'Match(*, score: float = None, match_id: int = None, source: str = None, + tags=None, label: str = None, **kwargs)' + parameters: + - name: score + description: Confidence score of the image match. + isRequired: true + types: + - + - name: match_id + description: The match id. + isRequired: true + types: + - + - name: source + description: The source. + isRequired: true + types: + - + - name: tags + description: The tags for match details. + isRequired: true + types: + - [] + - name: label + description: The label. + isRequired: true + types: + - + keywordOnlyParameters: + - name: score + isRequired: true + - name: match_id + isRequired: true + - name: source + isRequired: true + - name: tags + isRequired: true + - name: label + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.Match.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Match.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Match.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Match.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Match.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Match.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Match.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.MatchResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.MatchResponse.yml new file mode 100644 index 00000000..2cbbb4c2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.MatchResponse.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.MatchResponse +name: MatchResponse +fullName: azure.cognitiveservices.vision.contentmoderator.models.MatchResponse +module: azure.cognitiveservices.vision.contentmoderator.models +summary: The response for a Match request. +constructor: + syntax: 'MatchResponse(*, tracking_id: str = None, cache_id: str = None, is_match: + bool = None, matches=None, status=None, **kwargs)' + parameters: + - name: tracking_id + description: The tracking id. + isRequired: true + types: + - + - name: cache_id + description: The cache id. + isRequired: true + types: + - + - name: is_match + description: Indicates if there is a match. + isRequired: true + types: + - + - name: matches + description: The match details. + isRequired: true + types: + - [] + - name: status + description: The evaluate status + isRequired: true + types: + - + keywordOnlyParameters: + - name: tracking_id + isRequired: true + - name: cache_id + isRequired: true + - name: is_match + isRequired: true + - name: matches + isRequired: true + - name: status + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.MatchResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.MatchResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.MatchResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.MatchResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.MatchResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.MatchResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.MatchResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.OCR.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.OCR.yml new file mode 100644 index 00000000..8d7d8f6e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.OCR.yml @@ -0,0 +1,166 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.OCR +name: OCR +fullName: azure.cognitiveservices.vision.contentmoderator.models.OCR +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Contains the text found in image for the language specified. +constructor: + syntax: 'OCR(*, status=None, metadata=None, tracking_id: str = None, cache_id: str + = None, language: str = None, text: str = None, candidates=None, **kwargs)' + parameters: + - name: status + description: The evaluate status + isRequired: true + types: + - + - name: metadata + description: Array of KeyValue. + isRequired: true + types: + - [] + - name: tracking_id + description: The tracking id. + isRequired: true + types: + - + - name: cache_id + description: The cache id. + isRequired: true + types: + - + - name: language + description: The ISO 639-3 code. + isRequired: true + types: + - + - name: text + description: The found text. + isRequired: true + types: + - + - name: candidates + description: The list of candidate text. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: status + isRequired: true + - name: metadata + isRequired: true + - name: tracking_id + isRequired: true + - name: cache_id + isRequired: true + - name: language + isRequired: true + - name: text + isRequired: true + - name: candidates + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.OCR.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.OCR.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.OCR.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.OCR.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.OCR.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.OCR.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.OCR.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.PII.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.PII.yml new file mode 100644 index 00000000..39d6c34b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.PII.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.PII +name: PII +fullName: azure.cognitiveservices.vision.contentmoderator.models.PII +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Personal Identifier Information details. +constructor: + syntax: PII(*, email=None, ssn=None, ipa=None, phone=None, address=None, **kwargs) + parameters: + - name: email + isRequired: true + types: + - [] + - name: ssn + isRequired: true + types: + - [] + - name: ipa + isRequired: true + types: + - [] + - name: phone + isRequired: true + types: + - [] + - name: address + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: email + isRequired: true + - name: ssn + isRequired: true + - name: ipa + isRequired: true + - name: phone + isRequired: true + - name: address + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.PII.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.PII.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.PII.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.PII.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.PII.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.PII.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.PII.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Phone.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Phone.yml new file mode 100644 index 00000000..5bba4800 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Phone.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.Phone +name: Phone +fullName: azure.cognitiveservices.vision.contentmoderator.models.Phone +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Phone Property details. +constructor: + syntax: 'Phone(*, country_code: str = None, text: str = None, index: int = None, + **kwargs)' + parameters: + - name: country_code + description: CountryCode of the detected Phone number. + isRequired: true + types: + - + - name: text + description: Detected Phone number. + isRequired: true + types: + - + - name: index + description: 'Index(Location) of the Phone number in the input text + + content.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: country_code + isRequired: true + - name: text + isRequired: true + - name: index + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.Phone.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Phone.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Phone.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Phone.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Phone.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Phone.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Phone.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.RefreshIndex.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.RefreshIndex.yml new file mode 100644 index 00000000..3f286c09 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.RefreshIndex.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.RefreshIndex +name: RefreshIndex +fullName: azure.cognitiveservices.vision.contentmoderator.models.RefreshIndex +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Refresh Index Response. +constructor: + syntax: 'RefreshIndex(*, content_source_id: str = None, is_update_success: bool + = None, advanced_info=None, status=None, tracking_id: str = None, **kwargs)' + parameters: + - name: content_source_id + description: Content source Id. + isRequired: true + types: + - + - name: is_update_success + description: Update success status. + isRequired: true + types: + - + - name: advanced_info + description: Advanced info list. + isRequired: true + types: + - [[, ]] + - name: status + description: Refresh index status. + isRequired: true + types: + - + - name: tracking_id + description: Tracking Id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: content_source_id + isRequired: true + - name: is_update_success + isRequired: true + - name: advanced_info + isRequired: true + - name: status + isRequired: true + - name: tracking_id + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.RefreshIndex.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.RefreshIndex.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.RefreshIndex.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.RefreshIndex.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.RefreshIndex.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.RefreshIndex.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.RefreshIndex.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Review.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Review.yml new file mode 100644 index 00000000..9cd702d1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Review.yml @@ -0,0 +1,189 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.Review +name: Review +fullName: azure.cognitiveservices.vision.contentmoderator.models.Review +module: azure.cognitiveservices.vision.contentmoderator.models +summary: The Review object. +constructor: + syntax: 'Review(*, review_id: str = None, sub_team: str = None, status: str = None, + reviewer_result_tags=None, created_by: str = None, metadata=None, type: str = + None, content: str = None, content_id: str = None, callback_endpoint: str = None, + **kwargs)' + parameters: + - name: review_id + description: Id of the review. + isRequired: true + types: + - + - name: sub_team + description: Name of the subteam. + isRequired: true + types: + - + - name: status + description: The status string (). + isRequired: true + types: + - + - name: reviewer_result_tags + description: Array of KeyValue with Reviewer set Tags. + isRequired: true + types: + - [] + - name: created_by + description: The reviewer name. + isRequired: true + types: + - + - name: metadata + description: Array of KeyValue. + isRequired: true + types: + - [] + - name: type + description: The type of content. + isRequired: true + types: + - + - name: content + description: The content value. + isRequired: true + types: + - + - name: content_id + description: Id of the content. + isRequired: true + types: + - + - name: callback_endpoint + description: The callback endpoint. + isRequired: true + types: + - + keywordOnlyParameters: + - name: review_id + isRequired: true + - name: sub_team + isRequired: true + - name: status + isRequired: true + - name: reviewer_result_tags + isRequired: true + - name: created_by + isRequired: true + - name: metadata + isRequired: true + - name: type + isRequired: true + - name: content + isRequired: true + - name: content_id + isRequired: true + - name: callback_endpoint + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.Review.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Review.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Review.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Review.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Review.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Review.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Review.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.SSN.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.SSN.yml new file mode 100644 index 00000000..855b76e9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.SSN.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.SSN +name: SSN +fullName: azure.cognitiveservices.vision.contentmoderator.models.SSN +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Detected SSN details. +constructor: + syntax: 'SSN(*, text: str = None, index: int = None, **kwargs)' + parameters: + - name: text + description: Detected SSN in the input text content. + isRequired: true + types: + - + - name: index + description: Index(Location) of the SSN in the input text content. + isRequired: true + types: + - + keywordOnlyParameters: + - name: text + isRequired: true + - name: index + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.SSN.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.SSN.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.SSN.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.SSN.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.SSN.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.SSN.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.SSN.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Screen.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Screen.yml new file mode 100644 index 00000000..6f59868f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Screen.yml @@ -0,0 +1,187 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.Screen +name: Screen +fullName: azure.cognitiveservices.vision.contentmoderator.models.Screen +module: azure.cognitiveservices.vision.contentmoderator.models +summary: The response for a Screen text request. +constructor: + syntax: 'Screen(*, original_text: str = None, normalized_text: str = None, auto_corrected_text: + str = None, misrepresentation=None, classification=None, status=None, pii=None, + language: str = None, terms=None, tracking_id: str = None, **kwargs)' + parameters: + - name: original_text + description: The original text. + isRequired: true + types: + - + - name: normalized_text + description: The normalized text. + isRequired: true + types: + - + - name: auto_corrected_text + description: The autocorrected text + isRequired: true + types: + - + - name: misrepresentation + description: The misrepresentation text. + isRequired: true + types: + - [] + - name: classification + description: The classification details of the text. + isRequired: true + types: + - + - name: status + description: The evaluate status. + isRequired: true + types: + - + - name: pii + description: Personal Identifier Information details. + isRequired: true + types: + - + - name: language + description: Language of the input text content. + isRequired: true + types: + - + - name: terms + isRequired: true + types: + - [] + - name: tracking_id + description: Unique Content Moderator transaction Id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: original_text + isRequired: true + - name: normalized_text + isRequired: true + - name: auto_corrected_text + isRequired: true + - name: misrepresentation + isRequired: true + - name: classification + isRequired: true + - name: status + isRequired: true + - name: pii + isRequired: true + - name: language + isRequired: true + - name: terms + isRequired: true + - name: tracking_id + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.Screen.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Screen.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Screen.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Screen.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Screen.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Screen.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Screen.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Status.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Status.yml new file mode 100644 index 00000000..ce20b8e1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Status.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.Status +name: Status +fullName: azure.cognitiveservices.vision.contentmoderator.models.Status +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Status properties. +constructor: + syntax: 'Status(*, code: int = None, description: str = None, exception: str = None, + **kwargs)' + parameters: + - name: code + description: Status code. + isRequired: true + types: + - + - name: description + description: Status description. + isRequired: true + types: + - + - name: exception + description: Exception status. + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: description + isRequired: true + - name: exception + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.Status.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Status.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Status.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Status.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Status.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Status.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Status.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Tag.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Tag.yml new file mode 100644 index 00000000..e8b9ee16 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Tag.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.Tag +name: Tag +fullName: azure.cognitiveservices.vision.contentmoderator.models.Tag +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Tag details. +constructor: + syntax: 'Tag(*, key: str = None, value: str = None, **kwargs)' + parameters: + - name: key + description: The key parameter. + isRequired: true + types: + - + - name: value + description: The value parameter. + isRequired: true + types: + - + keywordOnlyParameters: + - name: key + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.Tag.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Tag.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Tag.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Tag.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Tag.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Tag.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Tag.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermList.yml new file mode 100644 index 00000000..d6b3f1ac --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermList.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.TermList +name: TermList +fullName: azure.cognitiveservices.vision.contentmoderator.models.TermList +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Term List Properties. +constructor: + syntax: 'TermList(*, id: int = None, name: str = None, description: str = None, + metadata=None, **kwargs)' + parameters: + - name: id + description: Term list Id. + isRequired: true + types: + - + - name: name + description: Term list name. + isRequired: true + types: + - + - name: description + description: Description for term list. + isRequired: true + types: + - + - name: metadata + description: Term list metadata. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: id + isRequired: true + - name: name + isRequired: true + - name: description + isRequired: true + - name: metadata + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermList.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermList.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermList.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermList.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermList.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermList.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermList.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Terms.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Terms.yml new file mode 100644 index 00000000..106e1fdd --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Terms.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.Terms +name: Terms +fullName: azure.cognitiveservices.vision.contentmoderator.models.Terms +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Terms properties. +constructor: + syntax: Terms(*, data=None, paging=None, **kwargs) + parameters: + - name: data + description: Term data details. + isRequired: true + types: + - + - name: paging + description: Paging details. + isRequired: true + types: + - + keywordOnlyParameters: + - name: data + isRequired: true + - name: paging + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.Terms.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Terms.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Terms.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Terms.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.Terms.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.Terms.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.Terms.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsData.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsData.yml new file mode 100644 index 00000000..f9ec68a0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsData.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.TermsData +name: TermsData +fullName: azure.cognitiveservices.vision.contentmoderator.models.TermsData +module: azure.cognitiveservices.vision.contentmoderator.models +summary: All term Id response properties. +constructor: + syntax: 'TermsData(*, language: str = None, terms=None, status=None, tracking_id: + str = None, **kwargs)' + parameters: + - name: language + description: Language of the terms. + isRequired: true + types: + - + - name: terms + description: List of terms. + isRequired: true + types: + - [] + - name: status + description: Term Status. + isRequired: true + types: + - + - name: tracking_id + description: Tracking Id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: language + isRequired: true + - name: terms + isRequired: true + - name: status + isRequired: true + - name: tracking_id + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermsData.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermsData.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermsData.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermsData.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermsData.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermsData.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermsData.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsInList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsInList.yml new file mode 100644 index 00000000..b82a2567 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsInList.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.TermsInList +name: TermsInList +fullName: azure.cognitiveservices.vision.contentmoderator.models.TermsInList +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Terms in list Id passed. +constructor: + syntax: 'TermsInList(*, term: str = None, **kwargs)' + parameters: + - name: term + description: Added term details. + isRequired: true + types: + - + keywordOnlyParameters: + - name: term + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermsInList.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermsInList.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermsInList.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermsInList.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermsInList.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermsInList.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermsInList.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsPaging.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsPaging.yml new file mode 100644 index 00000000..aa5cfdea --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsPaging.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.TermsPaging +name: TermsPaging +fullName: azure.cognitiveservices.vision.contentmoderator.models.TermsPaging +module: azure.cognitiveservices.vision.contentmoderator.models +summary: Paging details. +constructor: + syntax: 'TermsPaging(*, total: int = None, limit: int = None, offset: int = None, + returned: int = None, **kwargs)' + parameters: + - name: total + description: Total details. + isRequired: true + types: + - + - name: limit + description: Limit details. + isRequired: true + types: + - + - name: offset + description: Offset details. + isRequired: true + types: + - + - name: returned + description: Returned text details. + isRequired: true + types: + - + keywordOnlyParameters: + - name: total + isRequired: true + - name: limit + isRequired: true + - name: offset + isRequired: true + - name: returned + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermsPaging.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermsPaging.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermsPaging.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermsPaging.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermsPaging.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermsPaging.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.TermsPaging.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItem.yml new file mode 100644 index 00000000..e468d480 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItem.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItem +name: TranscriptModerationBodyItem +fullName: azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItem +module: azure.cognitiveservices.vision.contentmoderator.models +summary: 'Schema items of the body. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TranscriptModerationBodyItem(*, timestamp: str, terms, **kwargs)' + parameters: + - name: timestamp + description: Required. Timestamp of the image. + isRequired: true + types: + - + - name: terms + description: Required. Optional metadata details. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: timestamp + isRequired: true + - name: terms + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItemTermsItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItemTermsItem.yml new file mode 100644 index 00000000..1e6c897f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItemTermsItem.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItemTermsItem +name: TranscriptModerationBodyItemTermsItem +fullName: azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItemTermsItem +module: azure.cognitiveservices.vision.contentmoderator.models +summary: 'TranscriptModerationBodyItemTermsItem. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TranscriptModerationBodyItemTermsItem(*, index: int, term: str, **kwargs)' + parameters: + - name: index + description: Required. Index of the word + isRequired: true + types: + - + - name: term + description: Required. Detected word. + isRequired: true + types: + - + keywordOnlyParameters: + - name: index + isRequired: true + - name: term + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItemTermsItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItemTermsItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItemTermsItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItemTermsItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItemTermsItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItemTermsItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItemTermsItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItem.yml new file mode 100644 index 00000000..8c5a7789 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItem.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItem +name: VideoFrameBodyItem +fullName: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItem +module: azure.cognitiveservices.vision.contentmoderator.models +summary: 'Schema items of the body. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'VideoFrameBodyItem(*, timestamp: str, frame_image: str, reviewer_result_tags=None, + metadata=None, **kwargs)' + parameters: + - name: timestamp + description: Required. Timestamp of the frame. + isRequired: true + types: + - + - name: frame_image + description: Required. Content to review. + isRequired: true + types: + - + - name: reviewer_result_tags + isRequired: true + types: + - [] + - name: metadata + description: Optional metadata details. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: timestamp + isRequired: true + - name: frame_image + isRequired: true + - name: reviewer_result_tags + isRequired: true + - name: metadata + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemMetadataItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemMetadataItem.yml new file mode 100644 index 00000000..9e5f1236 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemMetadataItem.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemMetadataItem +name: VideoFrameBodyItemMetadataItem +fullName: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemMetadataItem +module: azure.cognitiveservices.vision.contentmoderator.models +summary: 'VideoFrameBodyItemMetadataItem. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'VideoFrameBodyItemMetadataItem(*, key: str, value: str, **kwargs)' + parameters: + - name: key + description: Required. Your key parameter. + isRequired: true + types: + - + - name: value + description: Required. Your value parameter. + isRequired: true + types: + - + keywordOnlyParameters: + - name: key + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemMetadataItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemMetadataItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemMetadataItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemMetadataItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemMetadataItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemMetadataItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemMetadataItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemReviewerResultTagsItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemReviewerResultTagsItem.yml new file mode 100644 index 00000000..0a01822a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemReviewerResultTagsItem.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemReviewerResultTagsItem +name: VideoFrameBodyItemReviewerResultTagsItem +fullName: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemReviewerResultTagsItem +module: azure.cognitiveservices.vision.contentmoderator.models +summary: 'VideoFrameBodyItemReviewerResultTagsItem. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'VideoFrameBodyItemReviewerResultTagsItem(*, key: str, value: str, **kwargs)' + parameters: + - name: key + description: Required. Your key parameter. + isRequired: true + types: + - + - name: value + description: Required. Your value parameter. + isRequired: true + types: + - + keywordOnlyParameters: + - name: key + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemReviewerResultTagsItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemReviewerResultTagsItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemReviewerResultTagsItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemReviewerResultTagsItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemReviewerResultTagsItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemReviewerResultTagsItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemReviewerResultTagsItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.yml new file mode 100644 index 00000000..060f7b68 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.yml @@ -0,0 +1,64 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.vision.contentmoderator.models +name: models +fullName: azure.cognitiveservices.vision.contentmoderator.models +type: import +classes: +- azure.cognitiveservices.vision.contentmoderator.models.APIError +- azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- azure.cognitiveservices.vision.contentmoderator.models.Address +- azure.cognitiveservices.vision.contentmoderator.models.Body +- azure.cognitiveservices.vision.contentmoderator.models.BodyModel +- azure.cognitiveservices.vision.contentmoderator.models.Candidate +- azure.cognitiveservices.vision.contentmoderator.models.Classification +- azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory1 +- azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory2 +- azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory3 +- azure.cognitiveservices.vision.contentmoderator.models.Content +- azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItem +- azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItemMetadataItem +- azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItem +- azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemMetadataItem +- azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItem +- azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemMetadataItem +- azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemReviewerResultTagsItem +- azure.cognitiveservices.vision.contentmoderator.models.DetectedLanguage +- azure.cognitiveservices.vision.contentmoderator.models.DetectedTerms +- azure.cognitiveservices.vision.contentmoderator.models.Email +- azure.cognitiveservices.vision.contentmoderator.models.Error +- azure.cognitiveservices.vision.contentmoderator.models.Evaluate +- azure.cognitiveservices.vision.contentmoderator.models.Face +- azure.cognitiveservices.vision.contentmoderator.models.FoundFaces +- azure.cognitiveservices.vision.contentmoderator.models.Frame +- azure.cognitiveservices.vision.contentmoderator.models.Frames +- azure.cognitiveservices.vision.contentmoderator.models.IPA +- azure.cognitiveservices.vision.contentmoderator.models.Image +- azure.cognitiveservices.vision.contentmoderator.models.ImageAdditionalInfoItem +- azure.cognitiveservices.vision.contentmoderator.models.ImageIds +- azure.cognitiveservices.vision.contentmoderator.models.ImageList +- azure.cognitiveservices.vision.contentmoderator.models.Job +- azure.cognitiveservices.vision.contentmoderator.models.JobExecutionReportDetails +- azure.cognitiveservices.vision.contentmoderator.models.JobId +- azure.cognitiveservices.vision.contentmoderator.models.JobListResult +- azure.cognitiveservices.vision.contentmoderator.models.KeyValuePair +- azure.cognitiveservices.vision.contentmoderator.models.Match +- azure.cognitiveservices.vision.contentmoderator.models.MatchResponse +- azure.cognitiveservices.vision.contentmoderator.models.OCR +- azure.cognitiveservices.vision.contentmoderator.models.PII +- azure.cognitiveservices.vision.contentmoderator.models.Phone +- azure.cognitiveservices.vision.contentmoderator.models.RefreshIndex +- azure.cognitiveservices.vision.contentmoderator.models.Review +- azure.cognitiveservices.vision.contentmoderator.models.SSN +- azure.cognitiveservices.vision.contentmoderator.models.Screen +- azure.cognitiveservices.vision.contentmoderator.models.Status +- azure.cognitiveservices.vision.contentmoderator.models.Tag +- azure.cognitiveservices.vision.contentmoderator.models.TermList +- azure.cognitiveservices.vision.contentmoderator.models.Terms +- azure.cognitiveservices.vision.contentmoderator.models.TermsData +- azure.cognitiveservices.vision.contentmoderator.models.TermsInList +- azure.cognitiveservices.vision.contentmoderator.models.TermsPaging +- azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItem +- azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItemTermsItem +- azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItem +- azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemMetadataItem +- azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemReviewerResultTagsItem diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ImageModerationOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ImageModerationOperations.yml new file mode 100644 index 00000000..0cc70239 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ImageModerationOperations.yml @@ -0,0 +1,696 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.operations.ImageModerationOperations +name: ImageModerationOperations +fullName: azure.cognitiveservices.vision.contentmoderator.operations.ImageModerationOperations +module: azure.cognitiveservices.vision.contentmoderator.operations +summary: ImageModerationOperations operations. +constructor: + syntax: ImageModerationOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ImageModerationOperations.evaluate_file_input + name: evaluate_file_input + summary: Returns probabilities of the image containing racy or adult content. + signature: evaluate_file_input(image_stream, cache_image=None, custom_headers=None, + raw=False, callback=None, **operation_config) + parameters: + - name: image_stream + description: The image file. + isRequired: true + types: + - + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Evaluate or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ImageModerationOperations.evaluate_method + name: evaluate_method + summary: Returns probabilities of the image containing racy or adult content. + signature: evaluate_method(cache_image=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Evaluate or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ImageModerationOperations.evaluate_url_input + name: evaluate_url_input + summary: Returns probabilities of the image containing racy or adult content. + signature: evaluate_url_input(content_type, cache_image=None, data_representation='URL', + value=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: data_representation + defaultValue: URL + types: + - + - name: value + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Evaluate or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ImageModerationOperations.find_faces + name: find_faces + summary: Returns the list of faces found. + signature: find_faces(cache_image=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: FoundFaces or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ImageModerationOperations.find_faces_file_input + name: find_faces_file_input + summary: Returns the list of faces found. + signature: find_faces_file_input(image_stream, cache_image=None, custom_headers=None, + raw=False, callback=None, **operation_config) + parameters: + - name: image_stream + description: The image file. + isRequired: true + types: + - + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: FoundFaces or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ImageModerationOperations.find_faces_url_input + name: find_faces_url_input + summary: Returns the list of faces found. + signature: find_faces_url_input(content_type, cache_image=None, data_representation='URL', + value=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: data_representation + defaultValue: URL + types: + - + - name: value + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: FoundFaces or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ImageModerationOperations.match_file_input + name: match_file_input + summary: 'Fuzzily match an image against one of your custom Image Lists. You can + + create and manage your custom image lists using this + + API. + + Returns ID and tags of matching image.
+ +
+ + Note: Refresh Index must be run on the corresponding Image List before + + additions and removals are reflected in the response.' + signature: match_file_input(image_stream, list_id=None, cache_image=None, custom_headers=None, + raw=False, callback=None, **operation_config) + parameters: + - name: image_stream + description: The image file. + isRequired: true + types: + - + - name: list_id + description: The list Id. + defaultValue: None + types: + - + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: MatchResponse or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ImageModerationOperations.match_method + name: match_method + summary: 'Fuzzily match an image against one of your custom Image Lists. You can + + create and manage your custom image lists using this + + API. + + Returns ID and tags of matching image.
+ +
+ + Note: Refresh Index must be run on the corresponding Image List before + + additions and removals are reflected in the response.' + signature: match_method(list_id=None, cache_image=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: list_id + description: The list Id. + defaultValue: None + types: + - + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: MatchResponse or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ImageModerationOperations.match_url_input + name: match_url_input + summary: 'Fuzzily match an image against one of your custom Image Lists. You can + + create and manage your custom image lists using this + + API. + + Returns ID and tags of matching image.
+ +
+ + Note: Refresh Index must be run on the corresponding Image List before + + additions and removals are reflected in the response.' + signature: match_url_input(content_type, list_id=None, cache_image=None, data_representation='URL', + value=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: list_id + description: The list Id. + defaultValue: None + types: + - + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: data_representation + defaultValue: URL + types: + - + - name: value + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: MatchResponse or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ImageModerationOperations.ocr_file_input + name: ocr_file_input + summary: 'Returns any text found in the image for the language specified. If no + + language is specified in input then the detection defaults to English.' + signature: ocr_file_input(language, image_stream, cache_image=None, enhanced=False, + custom_headers=None, raw=False, callback=None, **operation_config) + parameters: + - name: language + description: Language of the terms. + isRequired: true + types: + - + - name: image_stream + description: The image file. + isRequired: true + types: + - + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: enhanced + description: 'When set to True, the image goes through additional + + processing to come with additional candidates. + + image/tiff is not supported when enhanced is set to true + + Note: This impacts the response time.' + defaultValue: 'False' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OCR or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ImageModerationOperations.ocr_method + name: ocr_method + summary: 'Returns any text found in the image for the language specified. If no + + language is specified in input then the detection defaults to English.' + signature: ocr_method(language, cache_image=None, enhanced=False, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: language + description: Language of the terms. + isRequired: true + types: + - + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: enhanced + description: 'When set to True, the image goes through additional + + processing to come with additional candidates. + + image/tiff is not supported when enhanced is set to true + + Note: This impacts the response time.' + defaultValue: 'False' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OCR or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ImageModerationOperations.ocr_url_input + name: ocr_url_input + summary: 'Returns any text found in the image for the language specified. If no + + language is specified in input then the detection defaults to English.' + signature: ocr_url_input(language, content_type, cache_image=None, enhanced=False, + data_representation='URL', value=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: language + description: Language of the terms. + isRequired: true + types: + - + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: enhanced + description: 'When set to True, the image goes through additional + + processing to come with additional candidates. + + image/tiff is not supported when enhanced is set to true + + Note: This impacts the response time.' + defaultValue: 'False' + types: + - + - name: data_representation + defaultValue: URL + types: + - + - name: value + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OCR or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +attributes: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ImageModerationOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageListsOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageListsOperations.yml new file mode 100644 index 00000000..64d9041f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageListsOperations.yml @@ -0,0 +1,243 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageListsOperations +name: ListManagementImageListsOperations +fullName: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageListsOperations +module: azure.cognitiveservices.vision.contentmoderator.operations +summary: ListManagementImageListsOperations operations. +constructor: + syntax: ListManagementImageListsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageListsOperations.create + name: create + summary: Creates an image list. + signature: create(content_type, body, custom_headers=None, raw=False, **operation_config) + parameters: + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: body + description: Schema of the body. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageList or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageListsOperations.delete + name: delete + summary: Deletes image list with the list Id equal to list Id passed. + signature: delete(list_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageListsOperations.get_all_image_lists + name: get_all_image_lists + summary: Gets all the Image Lists. + signature: get_all_image_lists(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageListsOperations.get_details + name: get_details + summary: 'Returns the details of the image list with list Id equal to list Id + + passed.' + signature: get_details(list_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageList or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageListsOperations.refresh_index_method + name: refresh_index_method + summary: Refreshes the index of the list with list Id equal to list Id passed. + signature: refresh_index_method(list_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: RefreshIndex or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageListsOperations.update + name: update + summary: Updates an image list with list Id equal to list Id passed. + signature: update(list_id, content_type, body, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: body + description: Schema of the body. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageList or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +attributes: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageListsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageOperations.yml new file mode 100644 index 00000000..d3c9f018 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageOperations.yml @@ -0,0 +1,298 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageOperations +name: ListManagementImageOperations +fullName: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageOperations +module: azure.cognitiveservices.vision.contentmoderator.operations +summary: ListManagementImageOperations operations. +constructor: + syntax: ListManagementImageOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageOperations.add_image + name: add_image + summary: Add an image to the list with list Id equal to list Id passed. + signature: add_image(list_id, tag=None, label=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: tag + description: Tag for the image. + defaultValue: None + types: + - + - name: label + description: The image label. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Image or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageOperations.add_image_file_input + name: add_image_file_input + summary: Add an image to the list with list Id equal to list Id passed. + signature: add_image_file_input(list_id, image_stream, tag=None, label=None, custom_headers=None, + raw=False, callback=None, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: image_stream + description: The image file. + isRequired: true + types: + - + - name: tag + description: Tag for the image. + defaultValue: None + types: + - + - name: label + description: The image label. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Image or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageOperations.add_image_url_input + name: add_image_url_input + summary: Add an image to the list with list Id equal to list Id passed. + signature: add_image_url_input(list_id, content_type, tag=None, label=None, data_representation='URL', + value=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: tag + description: Tag for the image. + defaultValue: None + types: + - + - name: label + description: The image label. + defaultValue: None + types: + - + - name: data_representation + defaultValue: URL + types: + - + - name: value + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Image or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageOperations.delete_all_images + name: delete_all_images + summary: Deletes all images from the list with list Id equal to list Id passed. + signature: delete_all_images(list_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageOperations.delete_image + name: delete_image + summary: Deletes an image from the list with list Id and image Id passed. + signature: delete_image(list_id, image_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: image_id + description: Id of the image. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageOperations.get_all_image_ids + name: get_all_image_ids + summary: Gets all image Ids from the list with list Id equal to list Id passed. + signature: get_all_image_ids(list_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageIds or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +attributes: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations.yml new file mode 100644 index 00000000..f87bee69 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations.yml @@ -0,0 +1,249 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations +name: ListManagementTermListsOperations +fullName: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations +module: azure.cognitiveservices.vision.contentmoderator.operations +summary: ListManagementTermListsOperations operations. +constructor: + syntax: ListManagementTermListsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations.create + name: create + summary: Creates a Term List. + signature: create(content_type, body, custom_headers=None, raw=False, **operation_config) + parameters: + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: body + description: Schema of the body. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: TermList or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations.delete + name: delete + summary: Deletes term list with the list Id equal to list Id passed. + signature: delete(list_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations.get_all_term_lists + name: get_all_term_lists + summary: gets all the Term Lists. + signature: get_all_term_lists(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations.get_details + name: get_details + summary: 'Returns list Id details of the term list with list Id equal to list Id + + passed.' + signature: get_details(list_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: TermList or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations.refresh_index_method + name: refresh_index_method + summary: Refreshes the index of the list with list Id equal to list ID passed. + signature: refresh_index_method(list_id, language, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: language + description: Language of the terms. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: RefreshIndex or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations.update + name: update + summary: Updates an Term List. + signature: update(list_id, content_type, body, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: body + description: Schema of the body. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: TermList or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +attributes: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermOperations.yml new file mode 100644 index 00000000..52cb9679 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermOperations.yml @@ -0,0 +1,207 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermOperations +name: ListManagementTermOperations +fullName: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermOperations +module: azure.cognitiveservices.vision.contentmoderator.operations +summary: ListManagementTermOperations operations. +constructor: + syntax: ListManagementTermOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermOperations.add_term + name: add_term + summary: Add a term to the term list with list Id equal to list Id passed. + signature: add_term(list_id, term, language, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: term + description: Term to be deleted + isRequired: true + types: + - + - name: language + description: Language of the terms. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: object or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermOperations.delete_all_terms + name: delete_all_terms + summary: 'Deletes all terms from the list with list Id equal to the list Id + + passed.' + signature: delete_all_terms(list_id, language, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: language + description: Language of the terms. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermOperations.delete_term + name: delete_term + summary: Deletes a term from the list with list Id equal to the list Id passed. + signature: delete_term(list_id, term, language, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: term + description: Term to be deleted + isRequired: true + types: + - + - name: language + description: Language of the terms. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermOperations.get_all_terms + name: get_all_terms + summary: Gets all terms from the list with list Id equal to the list Id passed. + signature: get_all_terms(list_id, language, offset=None, limit=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: language + description: Language of the terms. + isRequired: true + types: + - + - name: offset + description: The pagination start index. + defaultValue: None + types: + - + - name: limit + description: The max limit. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Terms or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +attributes: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ReviewsOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ReviewsOperations.yml new file mode 100644 index 00000000..b6582b78 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.ReviewsOperations.yml @@ -0,0 +1,944 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.operations.ReviewsOperations +name: ReviewsOperations +fullName: azure.cognitiveservices.vision.contentmoderator.operations.ReviewsOperations +module: azure.cognitiveservices.vision.contentmoderator.operations +summary: ReviewsOperations operations. +constructor: + syntax: ReviewsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The content type. Constant value: "text/plain".' + name: content_type +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ReviewsOperations.add_video_frame + name: add_video_frame + summary: 'The reviews created would show up for Reviewers on your team. As + + Reviewers complete reviewing, results of the Review would be POSTED + + (i.e. HTTP POST) on the specified CallBackEndpoint. + +

CallBack Schemas

+ +

Review Completion CallBack Sample

+ +

+ + {
+ + "ReviewId": "",
+ + "ModifiedOn": "2016-10-11T22:36:32.9934851Z",
+ + "ModifiedBy": "",
+ + "CallBackType": "Review",
+ + "ContentId": "",
+ + "Metadata": {
+ + "adultscore": "0.xxx",
+ + "a": "False",
+ + "racyscore": "0.xxx",
+ + "r": "True"
+ + },
+ + "ReviewerResultTags": {
+ + "a": "False",
+ + "r": "True"
+ + }
+ + }
+ +

.' + signature: add_video_frame(team_name, review_id, timescale=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: team_name + description: Your team name. + isRequired: true + types: + - + - name: review_id + description: Id of the review. + isRequired: true + types: + - + - name: timescale + description: Timescale of the video you are adding frames to. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ReviewsOperations.add_video_frame_stream + name: add_video_frame_stream + summary: 'Use this method to add frames for a video review.Timescale: This + + parameter is a factor which is used to convert the timestamp on a frame + + into milliseconds. Timescale is provided in the output of the Content + + Moderator video media processor on the Azure Media Services + + platform.Timescale in the Video Moderation output is Ticks/Second.' + signature: add_video_frame_stream(content_type, team_name, review_id, frame_image_zip, + frame_metadata, timescale=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: team_name + description: Your team name. + isRequired: true + types: + - + - name: review_id + description: Id of the review. + isRequired: true + types: + - + - name: frame_image_zip + description: Zip file containing frame images. + isRequired: true + types: + - + - name: frame_metadata + description: Metadata of the frame. + isRequired: true + types: + - + - name: timescale + description: Timescale of the video . + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ReviewsOperations.add_video_frame_url + name: add_video_frame_url + summary: 'Use this method to add frames for a video review.Timescale: This + + parameter is a factor which is used to convert the timestamp on a frame + + into milliseconds. Timescale is provided in the output of the Content + + Moderator video media processor on the Azure Media Services + + platform.Timescale in the Video Moderation output is Ticks/Second.' + signature: add_video_frame_url(content_type, team_name, review_id, video_frame_body, + timescale=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: team_name + description: Your team name. + isRequired: true + types: + - + - name: review_id + description: Id of the review. + isRequired: true + types: + - + - name: video_frame_body + description: Body for add video frames API + isRequired: true + types: + - [] + - name: timescale + description: Timescale of the video. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ReviewsOperations.add_video_transcript + name: add_video_transcript + summary: 'This API adds a transcript file (text version of all the words spoken + + in a video) to a video review. The file should be a valid WebVTT + + format.' + signature: add_video_transcript(team_name, review_id, vt_tfile, custom_headers=None, + raw=False, callback=None, **operation_config) + parameters: + - name: team_name + description: Your team name. + isRequired: true + types: + - + - name: review_id + description: Id of the review. + isRequired: true + types: + - + - name: vt_tfile + description: Transcript file of the video. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ReviewsOperations.add_video_transcript_moderation_result + name: add_video_transcript_moderation_result + summary: 'This API adds a transcript screen text result file for a video review. + + Transcript screen text result file is a result of Screen Text API . In + + order to generate transcript screen text result file , a transcript + + file has to be screened for profanity using Screen Text API.' + signature: add_video_transcript_moderation_result(content_type, team_name, review_id, + transcript_moderation_body, custom_headers=None, raw=False, **operation_config) + parameters: + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: team_name + description: Your team name. + isRequired: true + types: + - + - name: review_id + description: Id of the review. + isRequired: true + types: + - + - name: transcript_moderation_body + description: 'Body for add video transcript + + moderation result API' + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ReviewsOperations.create_job + name: create_job + summary: 'A job Id will be returned for the content posted on this endpoint. + + Once the content is evaluated against the Workflow provided the review + + will be created or ignored based on the workflow expression. + +

CallBack Schemas

+ +

+ +

Job Completion CallBack Sample


+ + {
+ + "JobId": ",
+ + "ReviewId": "",
+ + "WorkFlowId": "default",
+ + "Status": "",
+ + "ContentType": "Image",
+ + "ContentId": "",
+ + "CallBackType": "Job",
+ + "Metadata": {
+ + "adultscore": "0.xxx",
+ + "a": "False",
+ + "racyscore": "0.xxx",
+ + "r": "True"
+ + }
+ + }
+ +

+ +

+ +

Review Completion CallBack Sample


+ + { + + "ReviewId": "",
+ + "ModifiedOn": "2016-10-11T22:36:32.9934851Z",
+ + "ModifiedBy": "",
+ + "CallBackType": "Review",
+ + "ContentId": "",
+ + "Metadata": {
+ + "adultscore": "0.xxx", + + "a": "False",
+ + "racyscore": "0.xxx",
+ + "r": "True"
+ + },
+ + "ReviewerResultTags": {
+ + "a": "False",
+ + "r": "True"
+ + }
+ + }
+ +

.' + signature: create_job(team_name, content_type, content_id, workflow_name, job_content_type, + content_value, call_back_endpoint=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: team_name + description: Your team name. + isRequired: true + types: + - + - name: content_type + description: 'Image, Text or Video. Possible values include: + + ''Image'', ''Text'', ''Video''' + isRequired: true + types: + - + - name: content_id + description: Id/Name to identify the content submitted. + isRequired: true + types: + - + - name: workflow_name + description: Workflow Name that you want to invoke. + isRequired: true + types: + - + - name: job_content_type + description: 'The content type. Possible values include: + + ''application/json'', ''image/jpeg''' + isRequired: true + types: + - + - name: content_value + description: Content to evaluate for a job. + isRequired: true + types: + - + - name: call_back_endpoint + description: 'Callback endpoint for posting the create + + job result.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: JobId or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ReviewsOperations.create_reviews + name: create_reviews + summary: 'The reviews created would show up for Reviewers on your team. As + + Reviewers complete reviewing, results of the Review would be POSTED + + (i.e. HTTP POST) on the specified CallBackEndpoint. + +

CallBack Schemas

+ +

Review Completion CallBack Sample

+ +

+ + {
+ + "ReviewId": "",
+ + "ModifiedOn": "2016-10-11T22:36:32.9934851Z",
+ + "ModifiedBy": "",
+ + "CallBackType": "Review",
+ + "ContentId": "",
+ + "Metadata": {
+ + "adultscore": "0.xxx",
+ + "a": "False",
+ + "racyscore": "0.xxx",
+ + "r": "True"
+ + },
+ + "ReviewerResultTags": {
+ + "a": "False",
+ + "r": "True"
+ + }
+ + }
+ +

.' + signature: create_reviews(url_content_type, team_name, create_review_body, sub_team=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: url_content_type + description: The content type. + isRequired: true + types: + - + - name: team_name + description: Your team name. + isRequired: true + types: + - + - name: create_review_body + description: Body for create reviews API + isRequired: true + types: + - [] + - name: sub_team + description: 'SubTeam of your team, you want to assign the created + + review to.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ReviewsOperations.create_video_reviews + name: create_video_reviews + summary: 'The reviews created would show up for Reviewers on your team. As + + Reviewers complete reviewing, results of the Review would be POSTED + + (i.e. HTTP POST) on the specified CallBackEndpoint. + +

CallBack Schemas

+ +

Review Completion CallBack Sample

+ +

+ + {
+ + "ReviewId": "",
+ + "ModifiedOn": "2016-10-11T22:36:32.9934851Z",
+ + "ModifiedBy": "",
+ + "CallBackType": "Review",
+ + "ContentId": "",
+ + "Metadata": {
+ + "adultscore": "0.xxx",
+ + "a": "False",
+ + "racyscore": "0.xxx",
+ + "r": "True"
+ + },
+ + "ReviewerResultTags": {
+ + "a": "False",
+ + "r": "True"
+ + }
+ + }
+ +

.' + signature: create_video_reviews(content_type, team_name, create_video_reviews_body, + sub_team=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: team_name + description: Your team name. + isRequired: true + types: + - + - name: create_video_reviews_body + description: Body for create reviews API + isRequired: true + types: + - [] + - name: sub_team + description: 'SubTeam of your team, you want to assign the created + + review to.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ReviewsOperations.get_job_details + name: get_job_details + summary: Get the Job Details for a Job Id. + signature: get_job_details(team_name, job_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: team_name + description: Your Team Name. + isRequired: true + types: + - + - name: job_id + description: Id of the job. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Job or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ReviewsOperations.get_review + name: get_review + summary: Returns review details for the review Id passed. + signature: get_review(team_name, review_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: team_name + description: Your Team Name. + isRequired: true + types: + - + - name: review_id + description: Id of the review. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Review or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ReviewsOperations.get_video_frames + name: get_video_frames + summary: 'The reviews created would show up for Reviewers on your team. As + + Reviewers complete reviewing, results of the Review would be POSTED + + (i.e. HTTP POST) on the specified CallBackEndpoint. + +

CallBack Schemas

+ +

Review Completion CallBack Sample

+ +

+ + {
+ + "ReviewId": "",
+ + "ModifiedOn": "2016-10-11T22:36:32.9934851Z",
+ + "ModifiedBy": "",
+ + "CallBackType": "Review",
+ + "ContentId": "",
+ + "Metadata": {
+ + "adultscore": "0.xxx",
+ + "a": "False",
+ + "racyscore": "0.xxx",
+ + "r": "True"
+ + },
+ + "ReviewerResultTags": {
+ + "a": "False",
+ + "r": "True"
+ + }
+ + }
+ +

.' + signature: get_video_frames(team_name, review_id, start_seed=None, no_of_records=None, + filter=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: team_name + description: Your team name. + isRequired: true + types: + - + - name: review_id + description: Id of the review. + isRequired: true + types: + - + - name: start_seed + description: 'Time stamp of the frame from where you want to + + start fetching the frames.' + defaultValue: None + types: + - + - name: no_of_records + description: Number of frames to fetch. + defaultValue: None + types: + - + - name: filter + description: Get frames filtered by tags. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Frames or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ReviewsOperations.publish_video_review + name: publish_video_review + summary: Publish video review to make it available for review. + signature: publish_video_review(team_name, review_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: team_name + description: Your team name. + isRequired: true + types: + - + - name: review_id + description: Id of the review. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +attributes: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.ReviewsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.TextModerationOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.TextModerationOperations.yml new file mode 100644 index 00000000..4f106766 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.TextModerationOperations.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.operations.TextModerationOperations +name: TextModerationOperations +fullName: azure.cognitiveservices.vision.contentmoderator.operations.TextModerationOperations +module: azure.cognitiveservices.vision.contentmoderator.operations +summary: TextModerationOperations operations. +constructor: + syntax: TextModerationOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.TextModerationOperations.detect_language + name: detect_language + summary: 'This operation will detect the language of given input content. Returns + + the ISO + 639-3 + + code for the predominant language comprising the submitted text. + + Over 110 languages supported.' + signature: detect_language(text_content_type, text_content, custom_headers=None, + raw=False, callback=None, **operation_config) + parameters: + - name: text_content_type + description: 'The content type. Possible values include: + + ''text/plain'', ''text/html'', ''text/xml'', ''text/markdown''' + isRequired: true + types: + - + - name: text_content + description: Content to screen. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DetectedLanguage or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.TextModerationOperations.screen_text + name: screen_text + summary: 'Detect profanity and match against custom and shared blocklists. + + + Detects profanity in more than 100 languages and match against custom + + and shared blocklists.' + signature: screen_text(text_content_type, text_content, language=None, autocorrect=False, + pii=False, list_id=None, classify=False, custom_headers=None, raw=False, callback=None, + **operation_config) + parameters: + - name: text_content_type + description: 'The content type. Possible values include: + + ''text/plain'', ''text/html'', ''text/xml'', ''text/markdown''' + isRequired: true + types: + - + - name: text_content + description: Content to screen. + isRequired: true + types: + - + - name: language + description: Language of the text. + defaultValue: None + types: + - + - name: autocorrect + description: Autocorrect text. + defaultValue: 'False' + types: + - + - name: pii + description: Detect personal identifiable information. + defaultValue: 'False' + types: + - + - name: list_id + description: The list Id. + defaultValue: None + types: + - + - name: classify + description: Classify input. + defaultValue: 'False' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Screen or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +attributes: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.TextModerationOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.ImageModerationOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.ImageModerationOperations.yml new file mode 100644 index 00000000..058275c6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.ImageModerationOperations.yml @@ -0,0 +1,696 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.ImageModerationOperations +name: ImageModerationOperations +fullName: azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.ImageModerationOperations +module: azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations +summary: ImageModerationOperations operations. +constructor: + syntax: ImageModerationOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.ImageModerationOperations.evaluate_file_input + name: evaluate_file_input + summary: Returns probabilities of the image containing racy or adult content. + signature: evaluate_file_input(image_stream, cache_image=None, custom_headers=None, + raw=False, callback=None, **operation_config) + parameters: + - name: image_stream + description: The image file. + isRequired: true + types: + - + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Evaluate or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.ImageModerationOperations.evaluate_method + name: evaluate_method + summary: Returns probabilities of the image containing racy or adult content. + signature: evaluate_method(cache_image=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Evaluate or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.ImageModerationOperations.evaluate_url_input + name: evaluate_url_input + summary: Returns probabilities of the image containing racy or adult content. + signature: evaluate_url_input(content_type, cache_image=None, data_representation='URL', + value=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: data_representation + defaultValue: URL + types: + - + - name: value + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Evaluate or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.ImageModerationOperations.find_faces + name: find_faces + summary: Returns the list of faces found. + signature: find_faces(cache_image=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: FoundFaces or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.ImageModerationOperations.find_faces_file_input + name: find_faces_file_input + summary: Returns the list of faces found. + signature: find_faces_file_input(image_stream, cache_image=None, custom_headers=None, + raw=False, callback=None, **operation_config) + parameters: + - name: image_stream + description: The image file. + isRequired: true + types: + - + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: FoundFaces or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.ImageModerationOperations.find_faces_url_input + name: find_faces_url_input + summary: Returns the list of faces found. + signature: find_faces_url_input(content_type, cache_image=None, data_representation='URL', + value=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: data_representation + defaultValue: URL + types: + - + - name: value + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: FoundFaces or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.ImageModerationOperations.match_file_input + name: match_file_input + summary: 'Fuzzily match an image against one of your custom Image Lists. You can + + create and manage your custom image lists using this + + API. + + Returns ID and tags of matching image.
+ +
+ + Note: Refresh Index must be run on the corresponding Image List before + + additions and removals are reflected in the response.' + signature: match_file_input(image_stream, list_id=None, cache_image=None, custom_headers=None, + raw=False, callback=None, **operation_config) + parameters: + - name: image_stream + description: The image file. + isRequired: true + types: + - + - name: list_id + description: The list Id. + defaultValue: None + types: + - + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: MatchResponse or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.ImageModerationOperations.match_method + name: match_method + summary: 'Fuzzily match an image against one of your custom Image Lists. You can + + create and manage your custom image lists using this + + API. + + Returns ID and tags of matching image.
+ +
+ + Note: Refresh Index must be run on the corresponding Image List before + + additions and removals are reflected in the response.' + signature: match_method(list_id=None, cache_image=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: list_id + description: The list Id. + defaultValue: None + types: + - + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: MatchResponse or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.ImageModerationOperations.match_url_input + name: match_url_input + summary: 'Fuzzily match an image against one of your custom Image Lists. You can + + create and manage your custom image lists using this + + API. + + Returns ID and tags of matching image.
+ +
+ + Note: Refresh Index must be run on the corresponding Image List before + + additions and removals are reflected in the response.' + signature: match_url_input(content_type, list_id=None, cache_image=None, data_representation='URL', + value=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: list_id + description: The list Id. + defaultValue: None + types: + - + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: data_representation + defaultValue: URL + types: + - + - name: value + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: MatchResponse or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.ImageModerationOperations.ocr_file_input + name: ocr_file_input + summary: 'Returns any text found in the image for the language specified. If no + + language is specified in input then the detection defaults to English.' + signature: ocr_file_input(language, image_stream, cache_image=None, enhanced=False, + custom_headers=None, raw=False, callback=None, **operation_config) + parameters: + - name: language + description: Language of the terms. + isRequired: true + types: + - + - name: image_stream + description: The image file. + isRequired: true + types: + - + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: enhanced + description: 'When set to True, the image goes through additional + + processing to come with additional candidates. + + image/tiff is not supported when enhanced is set to true + + Note: This impacts the response time.' + defaultValue: 'False' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OCR or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.ImageModerationOperations.ocr_method + name: ocr_method + summary: 'Returns any text found in the image for the language specified. If no + + language is specified in input then the detection defaults to English.' + signature: ocr_method(language, cache_image=None, enhanced=False, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: language + description: Language of the terms. + isRequired: true + types: + - + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: enhanced + description: 'When set to True, the image goes through additional + + processing to come with additional candidates. + + image/tiff is not supported when enhanced is set to true + + Note: This impacts the response time.' + defaultValue: 'False' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OCR or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.ImageModerationOperations.ocr_url_input + name: ocr_url_input + summary: 'Returns any text found in the image for the language specified. If no + + language is specified in input then the detection defaults to English.' + signature: ocr_url_input(language, content_type, cache_image=None, enhanced=False, + data_representation='URL', value=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: language + description: Language of the terms. + isRequired: true + types: + - + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: cache_image + description: 'Whether to retain the submitted image for future + + use; defaults to false if omitted.' + defaultValue: None + types: + - + - name: enhanced + description: 'When set to True, the image goes through additional + + processing to come with additional candidates. + + image/tiff is not supported when enhanced is set to true + + Note: This impacts the response time.' + defaultValue: 'False' + types: + - + - name: data_representation + defaultValue: URL + types: + - + - name: value + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OCR or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +attributes: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.ImageModerationOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.yml new file mode 100644 index 00000000..16ff5b7d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations +name: image_moderation_operations +fullName: azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations +classes: +- azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.ImageModerationOperations diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations.ListManagementImageListsOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations.ListManagementImageListsOperations.yml new file mode 100644 index 00000000..2f6696ac --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations.ListManagementImageListsOperations.yml @@ -0,0 +1,243 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations.ListManagementImageListsOperations +name: ListManagementImageListsOperations +fullName: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations.ListManagementImageListsOperations +module: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations +summary: ListManagementImageListsOperations operations. +constructor: + syntax: ListManagementImageListsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations.ListManagementImageListsOperations.create + name: create + summary: Creates an image list. + signature: create(content_type, body, custom_headers=None, raw=False, **operation_config) + parameters: + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: body + description: Schema of the body. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageList or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations.ListManagementImageListsOperations.delete + name: delete + summary: Deletes image list with the list Id equal to list Id passed. + signature: delete(list_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations.ListManagementImageListsOperations.get_all_image_lists + name: get_all_image_lists + summary: Gets all the Image Lists. + signature: get_all_image_lists(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations.ListManagementImageListsOperations.get_details + name: get_details + summary: 'Returns the details of the image list with list Id equal to list Id + + passed.' + signature: get_details(list_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageList or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations.ListManagementImageListsOperations.refresh_index_method + name: refresh_index_method + summary: Refreshes the index of the list with list Id equal to list Id passed. + signature: refresh_index_method(list_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: RefreshIndex or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations.ListManagementImageListsOperations.update + name: update + summary: Updates an image list with list Id equal to list Id passed. + signature: update(list_id, content_type, body, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: body + description: Schema of the body. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageList or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +attributes: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations.ListManagementImageListsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations.yml new file mode 100644 index 00000000..4e18919e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations +name: list_management_image_lists_operations +fullName: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations +classes: +- azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations.ListManagementImageListsOperations diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations.ListManagementImageOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations.ListManagementImageOperations.yml new file mode 100644 index 00000000..d13c5f88 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations.ListManagementImageOperations.yml @@ -0,0 +1,298 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations.ListManagementImageOperations +name: ListManagementImageOperations +fullName: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations.ListManagementImageOperations +module: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations +summary: ListManagementImageOperations operations. +constructor: + syntax: ListManagementImageOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations.ListManagementImageOperations.add_image + name: add_image + summary: Add an image to the list with list Id equal to list Id passed. + signature: add_image(list_id, tag=None, label=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: tag + description: Tag for the image. + defaultValue: None + types: + - + - name: label + description: The image label. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Image or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations.ListManagementImageOperations.add_image_file_input + name: add_image_file_input + summary: Add an image to the list with list Id equal to list Id passed. + signature: add_image_file_input(list_id, image_stream, tag=None, label=None, custom_headers=None, + raw=False, callback=None, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: image_stream + description: The image file. + isRequired: true + types: + - + - name: tag + description: Tag for the image. + defaultValue: None + types: + - + - name: label + description: The image label. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Image or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations.ListManagementImageOperations.add_image_url_input + name: add_image_url_input + summary: Add an image to the list with list Id equal to list Id passed. + signature: add_image_url_input(list_id, content_type, tag=None, label=None, data_representation='URL', + value=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: tag + description: Tag for the image. + defaultValue: None + types: + - + - name: label + description: The image label. + defaultValue: None + types: + - + - name: data_representation + defaultValue: URL + types: + - + - name: value + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Image or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations.ListManagementImageOperations.delete_all_images + name: delete_all_images + summary: Deletes all images from the list with list Id equal to list Id passed. + signature: delete_all_images(list_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations.ListManagementImageOperations.delete_image + name: delete_image + summary: Deletes an image from the list with list Id and image Id passed. + signature: delete_image(list_id, image_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: image_id + description: Id of the image. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations.ListManagementImageOperations.get_all_image_ids + name: get_all_image_ids + summary: Gets all image Ids from the list with list Id equal to list Id passed. + signature: get_all_image_ids(list_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageIds or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +attributes: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations.ListManagementImageOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations.yml new file mode 100644 index 00000000..5176f37c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations +name: list_management_image_operations +fullName: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations +classes: +- azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations.ListManagementImageOperations diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations.ListManagementTermListsOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations.ListManagementTermListsOperations.yml new file mode 100644 index 00000000..708e8cb2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations.ListManagementTermListsOperations.yml @@ -0,0 +1,249 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations.ListManagementTermListsOperations +name: ListManagementTermListsOperations +fullName: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations.ListManagementTermListsOperations +module: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations +summary: ListManagementTermListsOperations operations. +constructor: + syntax: ListManagementTermListsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations.ListManagementTermListsOperations.create + name: create + summary: Creates a Term List. + signature: create(content_type, body, custom_headers=None, raw=False, **operation_config) + parameters: + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: body + description: Schema of the body. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: TermList or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations.ListManagementTermListsOperations.delete + name: delete + summary: Deletes term list with the list Id equal to list Id passed. + signature: delete(list_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations.ListManagementTermListsOperations.get_all_term_lists + name: get_all_term_lists + summary: gets all the Term Lists. + signature: get_all_term_lists(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations.ListManagementTermListsOperations.get_details + name: get_details + summary: 'Returns list Id details of the term list with list Id equal to list Id + + passed.' + signature: get_details(list_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: TermList or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations.ListManagementTermListsOperations.refresh_index_method + name: refresh_index_method + summary: Refreshes the index of the list with list Id equal to list ID passed. + signature: refresh_index_method(list_id, language, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: language + description: Language of the terms. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: RefreshIndex or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations.ListManagementTermListsOperations.update + name: update + summary: Updates an Term List. + signature: update(list_id, content_type, body, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: body + description: Schema of the body. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: TermList or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +attributes: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations.ListManagementTermListsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations.yml new file mode 100644 index 00000000..dea7bb78 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations +name: list_management_term_lists_operations +fullName: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations +classes: +- azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations.ListManagementTermListsOperations diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_operations.ListManagementTermOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_operations.ListManagementTermOperations.yml new file mode 100644 index 00000000..df50091a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_operations.ListManagementTermOperations.yml @@ -0,0 +1,207 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_operations.ListManagementTermOperations +name: ListManagementTermOperations +fullName: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_operations.ListManagementTermOperations +module: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_operations +summary: ListManagementTermOperations operations. +constructor: + syntax: ListManagementTermOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_operations.ListManagementTermOperations.add_term + name: add_term + summary: Add a term to the term list with list Id equal to list Id passed. + signature: add_term(list_id, term, language, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: term + description: Term to be deleted + isRequired: true + types: + - + - name: language + description: Language of the terms. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: object or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_operations.ListManagementTermOperations.delete_all_terms + name: delete_all_terms + summary: 'Deletes all terms from the list with list Id equal to the list Id + + passed.' + signature: delete_all_terms(list_id, language, custom_headers=None, raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: language + description: Language of the terms. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_operations.ListManagementTermOperations.delete_term + name: delete_term + summary: Deletes a term from the list with list Id equal to the list Id passed. + signature: delete_term(list_id, term, language, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: term + description: Term to be deleted + isRequired: true + types: + - + - name: language + description: Language of the terms. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: str or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_operations.ListManagementTermOperations.get_all_terms + name: get_all_terms + summary: Gets all terms from the list with list Id equal to the list Id passed. + signature: get_all_terms(list_id, language, offset=None, limit=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: list_id + description: List Id of the image list. + isRequired: true + types: + - + - name: language + description: Language of the terms. + isRequired: true + types: + - + - name: offset + description: The pagination start index. + defaultValue: None + types: + - + - name: limit + description: The max limit. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Terms or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +attributes: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_operations.ListManagementTermOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_operations.yml new file mode 100644 index 00000000..b8165215 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_operations +name: list_management_term_operations +fullName: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_operations +classes: +- azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_operations.ListManagementTermOperations diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.ReviewsOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.ReviewsOperations.yml new file mode 100644 index 00000000..95bd2fe3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.ReviewsOperations.yml @@ -0,0 +1,944 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.ReviewsOperations +name: ReviewsOperations +fullName: azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.ReviewsOperations +module: azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations +summary: ReviewsOperations operations. +constructor: + syntax: ReviewsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The content type. Constant value: "text/plain".' + name: content_type +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.ReviewsOperations.add_video_frame + name: add_video_frame + summary: 'The reviews created would show up for Reviewers on your team. As + + Reviewers complete reviewing, results of the Review would be POSTED + + (i.e. HTTP POST) on the specified CallBackEndpoint. + +

CallBack Schemas

+ +

Review Completion CallBack Sample

+ +

+ + {
+ + "ReviewId": "",
+ + "ModifiedOn": "2016-10-11T22:36:32.9934851Z",
+ + "ModifiedBy": "",
+ + "CallBackType": "Review",
+ + "ContentId": "",
+ + "Metadata": {
+ + "adultscore": "0.xxx",
+ + "a": "False",
+ + "racyscore": "0.xxx",
+ + "r": "True"
+ + },
+ + "ReviewerResultTags": {
+ + "a": "False",
+ + "r": "True"
+ + }
+ + }
+ +

.' + signature: add_video_frame(team_name, review_id, timescale=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: team_name + description: Your team name. + isRequired: true + types: + - + - name: review_id + description: Id of the review. + isRequired: true + types: + - + - name: timescale + description: Timescale of the video you are adding frames to. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.ReviewsOperations.add_video_frame_stream + name: add_video_frame_stream + summary: 'Use this method to add frames for a video review.Timescale: This + + parameter is a factor which is used to convert the timestamp on a frame + + into milliseconds. Timescale is provided in the output of the Content + + Moderator video media processor on the Azure Media Services + + platform.Timescale in the Video Moderation output is Ticks/Second.' + signature: add_video_frame_stream(content_type, team_name, review_id, frame_image_zip, + frame_metadata, timescale=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: team_name + description: Your team name. + isRequired: true + types: + - + - name: review_id + description: Id of the review. + isRequired: true + types: + - + - name: frame_image_zip + description: Zip file containing frame images. + isRequired: true + types: + - + - name: frame_metadata + description: Metadata of the frame. + isRequired: true + types: + - + - name: timescale + description: Timescale of the video . + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.ReviewsOperations.add_video_frame_url + name: add_video_frame_url + summary: 'Use this method to add frames for a video review.Timescale: This + + parameter is a factor which is used to convert the timestamp on a frame + + into milliseconds. Timescale is provided in the output of the Content + + Moderator video media processor on the Azure Media Services + + platform.Timescale in the Video Moderation output is Ticks/Second.' + signature: add_video_frame_url(content_type, team_name, review_id, video_frame_body, + timescale=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: team_name + description: Your team name. + isRequired: true + types: + - + - name: review_id + description: Id of the review. + isRequired: true + types: + - + - name: video_frame_body + description: Body for add video frames API + isRequired: true + types: + - [] + - name: timescale + description: Timescale of the video. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.ReviewsOperations.add_video_transcript + name: add_video_transcript + summary: 'This API adds a transcript file (text version of all the words spoken + + in a video) to a video review. The file should be a valid WebVTT + + format.' + signature: add_video_transcript(team_name, review_id, vt_tfile, custom_headers=None, + raw=False, callback=None, **operation_config) + parameters: + - name: team_name + description: Your team name. + isRequired: true + types: + - + - name: review_id + description: Id of the review. + isRequired: true + types: + - + - name: vt_tfile + description: Transcript file of the video. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.ReviewsOperations.add_video_transcript_moderation_result + name: add_video_transcript_moderation_result + summary: 'This API adds a transcript screen text result file for a video review. + + Transcript screen text result file is a result of Screen Text API . In + + order to generate transcript screen text result file , a transcript + + file has to be screened for profanity using Screen Text API.' + signature: add_video_transcript_moderation_result(content_type, team_name, review_id, + transcript_moderation_body, custom_headers=None, raw=False, **operation_config) + parameters: + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: team_name + description: Your team name. + isRequired: true + types: + - + - name: review_id + description: Id of the review. + isRequired: true + types: + - + - name: transcript_moderation_body + description: 'Body for add video transcript + + moderation result API' + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.ReviewsOperations.create_job + name: create_job + summary: 'A job Id will be returned for the content posted on this endpoint. + + Once the content is evaluated against the Workflow provided the review + + will be created or ignored based on the workflow expression. + +

CallBack Schemas

+ +

+ +

Job Completion CallBack Sample


+ + {
+ + "JobId": ",
+ + "ReviewId": "",
+ + "WorkFlowId": "default",
+ + "Status": "",
+ + "ContentType": "Image",
+ + "ContentId": "",
+ + "CallBackType": "Job",
+ + "Metadata": {
+ + "adultscore": "0.xxx",
+ + "a": "False",
+ + "racyscore": "0.xxx",
+ + "r": "True"
+ + }
+ + }
+ +

+ +

+ +

Review Completion CallBack Sample


+ + { + + "ReviewId": "",
+ + "ModifiedOn": "2016-10-11T22:36:32.9934851Z",
+ + "ModifiedBy": "",
+ + "CallBackType": "Review",
+ + "ContentId": "",
+ + "Metadata": {
+ + "adultscore": "0.xxx", + + "a": "False",
+ + "racyscore": "0.xxx",
+ + "r": "True"
+ + },
+ + "ReviewerResultTags": {
+ + "a": "False",
+ + "r": "True"
+ + }
+ + }
+ +

.' + signature: create_job(team_name, content_type, content_id, workflow_name, job_content_type, + content_value, call_back_endpoint=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: team_name + description: Your team name. + isRequired: true + types: + - + - name: content_type + description: 'Image, Text or Video. Possible values include: + + ''Image'', ''Text'', ''Video''' + isRequired: true + types: + - + - name: content_id + description: Id/Name to identify the content submitted. + isRequired: true + types: + - + - name: workflow_name + description: Workflow Name that you want to invoke. + isRequired: true + types: + - + - name: job_content_type + description: 'The content type. Possible values include: + + ''application/json'', ''image/jpeg''' + isRequired: true + types: + - + - name: content_value + description: Content to evaluate for a job. + isRequired: true + types: + - + - name: call_back_endpoint + description: 'Callback endpoint for posting the create + + job result.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: JobId or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.ReviewsOperations.create_reviews + name: create_reviews + summary: 'The reviews created would show up for Reviewers on your team. As + + Reviewers complete reviewing, results of the Review would be POSTED + + (i.e. HTTP POST) on the specified CallBackEndpoint. + +

CallBack Schemas

+ +

Review Completion CallBack Sample

+ +

+ + {
+ + "ReviewId": "",
+ + "ModifiedOn": "2016-10-11T22:36:32.9934851Z",
+ + "ModifiedBy": "",
+ + "CallBackType": "Review",
+ + "ContentId": "",
+ + "Metadata": {
+ + "adultscore": "0.xxx",
+ + "a": "False",
+ + "racyscore": "0.xxx",
+ + "r": "True"
+ + },
+ + "ReviewerResultTags": {
+ + "a": "False",
+ + "r": "True"
+ + }
+ + }
+ +

.' + signature: create_reviews(url_content_type, team_name, create_review_body, sub_team=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: url_content_type + description: The content type. + isRequired: true + types: + - + - name: team_name + description: Your team name. + isRequired: true + types: + - + - name: create_review_body + description: Body for create reviews API + isRequired: true + types: + - [] + - name: sub_team + description: 'SubTeam of your team, you want to assign the created + + review to.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.ReviewsOperations.create_video_reviews + name: create_video_reviews + summary: 'The reviews created would show up for Reviewers on your team. As + + Reviewers complete reviewing, results of the Review would be POSTED + + (i.e. HTTP POST) on the specified CallBackEndpoint. + +

CallBack Schemas

+ +

Review Completion CallBack Sample

+ +

+ + {
+ + "ReviewId": "",
+ + "ModifiedOn": "2016-10-11T22:36:32.9934851Z",
+ + "ModifiedBy": "",
+ + "CallBackType": "Review",
+ + "ContentId": "",
+ + "Metadata": {
+ + "adultscore": "0.xxx",
+ + "a": "False",
+ + "racyscore": "0.xxx",
+ + "r": "True"
+ + },
+ + "ReviewerResultTags": {
+ + "a": "False",
+ + "r": "True"
+ + }
+ + }
+ +

.' + signature: create_video_reviews(content_type, team_name, create_video_reviews_body, + sub_team=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: content_type + description: The content type. + isRequired: true + types: + - + - name: team_name + description: Your team name. + isRequired: true + types: + - + - name: create_video_reviews_body + description: Body for create reviews API + isRequired: true + types: + - [] + - name: sub_team + description: 'SubTeam of your team, you want to assign the created + + review to.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.ReviewsOperations.get_job_details + name: get_job_details + summary: Get the Job Details for a Job Id. + signature: get_job_details(team_name, job_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: team_name + description: Your Team Name. + isRequired: true + types: + - + - name: job_id + description: Id of the job. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Job or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.ReviewsOperations.get_review + name: get_review + summary: Returns review details for the review Id passed. + signature: get_review(team_name, review_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: team_name + description: Your Team Name. + isRequired: true + types: + - + - name: review_id + description: Id of the review. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Review or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.ReviewsOperations.get_video_frames + name: get_video_frames + summary: 'The reviews created would show up for Reviewers on your team. As + + Reviewers complete reviewing, results of the Review would be POSTED + + (i.e. HTTP POST) on the specified CallBackEndpoint. + +

CallBack Schemas

+ +

Review Completion CallBack Sample

+ +

+ + {
+ + "ReviewId": "",
+ + "ModifiedOn": "2016-10-11T22:36:32.9934851Z",
+ + "ModifiedBy": "",
+ + "CallBackType": "Review",
+ + "ContentId": "",
+ + "Metadata": {
+ + "adultscore": "0.xxx",
+ + "a": "False",
+ + "racyscore": "0.xxx",
+ + "r": "True"
+ + },
+ + "ReviewerResultTags": {
+ + "a": "False",
+ + "r": "True"
+ + }
+ + }
+ +

.' + signature: get_video_frames(team_name, review_id, start_seed=None, no_of_records=None, + filter=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: team_name + description: Your team name. + isRequired: true + types: + - + - name: review_id + description: Id of the review. + isRequired: true + types: + - + - name: start_seed + description: 'Time stamp of the frame from where you want to + + start fetching the frames.' + defaultValue: None + types: + - + - name: no_of_records + description: Number of frames to fetch. + defaultValue: None + types: + - + - name: filter + description: Get frames filtered by tags. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Frames or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.ReviewsOperations.publish_video_review + name: publish_video_review + summary: Publish video review to make it available for review. + signature: publish_video_review(team_name, review_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: team_name + description: Your team name. + isRequired: true + types: + - + - name: review_id + description: Id of the review. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +attributes: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.ReviewsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.yml new file mode 100644 index 00000000..30393dec --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations +name: reviews_operations +fullName: azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations +classes: +- azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.ReviewsOperations diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.text_moderation_operations.TextModerationOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.text_moderation_operations.TextModerationOperations.yml new file mode 100644 index 00000000..db0cdd7b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.text_moderation_operations.TextModerationOperations.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.contentmoderator.operations.text_moderation_operations.TextModerationOperations +name: TextModerationOperations +fullName: azure.cognitiveservices.vision.contentmoderator.operations.text_moderation_operations.TextModerationOperations +module: azure.cognitiveservices.vision.contentmoderator.operations.text_moderation_operations +summary: TextModerationOperations operations. +constructor: + syntax: TextModerationOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.text_moderation_operations.TextModerationOperations.detect_language + name: detect_language + summary: 'This operation will detect the language of given input content. Returns + + the ISO + 639-3 + + code for the predominant language comprising the submitted text. + + Over 110 languages supported.' + signature: detect_language(text_content_type, text_content, custom_headers=None, + raw=False, callback=None, **operation_config) + parameters: + - name: text_content_type + description: 'The content type. Possible values include: + + ''text/plain'', ''text/html'', ''text/xml'', ''text/markdown''' + isRequired: true + types: + - + - name: text_content + description: Content to screen. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DetectedLanguage or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +- uid: azure.cognitiveservices.vision.contentmoderator.operations.text_moderation_operations.TextModerationOperations.screen_text + name: screen_text + summary: 'Detect profanity and match against custom and shared blocklists. + + + Detects profanity in more than 100 languages and match against custom + + and shared blocklists.' + signature: screen_text(text_content_type, text_content, language=None, autocorrect=False, + pii=False, list_id=None, classify=False, custom_headers=None, raw=False, callback=None, + **operation_config) + parameters: + - name: text_content_type + description: 'The content type. Possible values include: + + ''text/plain'', ''text/html'', ''text/xml'', ''text/markdown''' + isRequired: true + types: + - + - name: text_content + description: Content to screen. + isRequired: true + types: + - + - name: language + description: Language of the text. + defaultValue: None + types: + - + - name: autocorrect + description: Autocorrect text. + defaultValue: 'False' + types: + - + - name: pii + description: Detect personal identifiable information. + defaultValue: 'False' + types: + - + - name: list_id + description: The list Id. + defaultValue: None + types: + - + - name: classify + description: Classify input. + defaultValue: 'False' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Screen or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException +attributes: +- uid: azure.cognitiveservices.vision.contentmoderator.operations.text_moderation_operations.TextModerationOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.text_moderation_operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.text_moderation_operations.yml new file mode 100644 index 00000000..6e164c01 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.text_moderation_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.vision.contentmoderator.operations.text_moderation_operations +name: text_moderation_operations +fullName: azure.cognitiveservices.vision.contentmoderator.operations.text_moderation_operations +classes: +- azure.cognitiveservices.vision.contentmoderator.operations.text_moderation_operations.TextModerationOperations diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.yml new file mode 100644 index 00000000..3dd027d2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.operations.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.vision.contentmoderator.operations +name: operations +fullName: azure.cognitiveservices.vision.contentmoderator.operations +type: import +classes: +- azure.cognitiveservices.vision.contentmoderator.operations.ImageModerationOperations +- azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageListsOperations +- azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageOperations +- azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations +- azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermOperations +- azure.cognitiveservices.vision.contentmoderator.operations.ReviewsOperations +- azure.cognitiveservices.vision.contentmoderator.operations.TextModerationOperations +modules: +- azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations +- azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations +- azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations +- azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations +- azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_operations +- azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations +- azure.cognitiveservices.vision.contentmoderator.operations.text_moderation_operations diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.version.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.version.yml new file mode 100644 index 00000000..9c04c761 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.vision.contentmoderator.version +name: version +fullName: azure.cognitiveservices.vision.contentmoderator.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.yml new file mode 100644 index 00000000..e0994b64 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.vision.contentmoderator +name: contentmoderator +fullName: azure.cognitiveservices.vision.contentmoderator +type: rootImport +classes: +- azure.cognitiveservices.vision.contentmoderator.ContentModeratorClient +packages: +- azure.cognitiveservices.vision.contentmoderator.models +- azure.cognitiveservices.vision.contentmoderator.operations +modules: +- azure.cognitiveservices.vision.contentmoderator.content_moderator_client +- azure.cognitiveservices.vision.contentmoderator.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClient.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClient.yml new file mode 100644 index 00000000..275f4aeb --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClient.yml @@ -0,0 +1,470 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClient +name: CustomVisionPredictionClient +fullName: azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClient +module: azure.cognitiveservices.vision.customvision.prediction +constructor: + syntax: CustomVisionPredictionClient(endpoint, credentials) + parameters: + - name: endpoint + description: Supported Cognitive Services endpoints. + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +methods: +- uid: azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClient.classify_image + name: classify_image + summary: Classify an image and saves the result. + signature: classify_image(project_id, published_name, image_data, application=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: published_name + description: 'Specifies the name of the model to evaluate + + against.' + isRequired: true + types: + - + - name: image_data + description: 'Binary image data. Supported formats are JPEG, GIF, + + PNG, and BMP. Supports images up to 4MB.' + isRequired: true + types: + - + - name: application + description: 'Optional. Specifies the name of application using + + the endpoint.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImagePrediction or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClient.classify_image_url + name: classify_image_url + summary: Classify an image url and saves the result. + signature: classify_image_url(project_id, published_name, url, application=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: published_name + description: 'Specifies the name of the model to evaluate + + against.' + isRequired: true + types: + - + - name: url + description: Url of the image. + isRequired: true + types: + - + - name: application + description: 'Optional. Specifies the name of application using + + the endpoint.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImagePrediction or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClient.classify_image_url_with_no_store + name: classify_image_url_with_no_store + summary: Classify an image url without saving the result. + signature: classify_image_url_with_no_store(project_id, published_name, url, application=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: published_name + description: 'Specifies the name of the model to evaluate + + against.' + isRequired: true + types: + - + - name: url + description: Url of the image. + isRequired: true + types: + - + - name: application + description: 'Optional. Specifies the name of application using + + the endpoint.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImagePrediction or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClient.classify_image_with_no_store + name: classify_image_with_no_store + summary: Classify an image without saving the result. + signature: classify_image_with_no_store(project_id, published_name, image_data, + application=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: published_name + description: 'Specifies the name of the model to evaluate + + against.' + isRequired: true + types: + - + - name: image_data + description: 'Binary image data. Supported formats are JPEG, GIF, + + PNG, and BMP. Supports images up to 4MB.' + isRequired: true + types: + - + - name: application + description: 'Optional. Specifies the name of application using + + the endpoint.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImagePrediction or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None +- uid: azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClient.detect_image + name: detect_image + summary: Detect objects in an image and saves the result. + signature: detect_image(project_id, published_name, image_data, application=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: published_name + description: 'Specifies the name of the model to evaluate + + against.' + isRequired: true + types: + - + - name: image_data + description: 'Binary image data. Supported formats are JPEG, GIF, + + PNG, and BMP. Supports images up to 4MB.' + isRequired: true + types: + - + - name: application + description: 'Optional. Specifies the name of application using + + the endpoint.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImagePrediction or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClient.detect_image_url + name: detect_image_url + summary: Detect objects in an image url and saves the result. + signature: detect_image_url(project_id, published_name, url, application=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: published_name + description: 'Specifies the name of the model to evaluate + + against.' + isRequired: true + types: + - + - name: url + description: Url of the image. + isRequired: true + types: + - + - name: application + description: 'Optional. Specifies the name of application using + + the endpoint.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImagePrediction or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClient.detect_image_url_with_no_store + name: detect_image_url_with_no_store + summary: Detect objects in an image url without saving the result. + signature: detect_image_url_with_no_store(project_id, published_name, url, application=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: published_name + description: 'Specifies the name of the model to evaluate + + against.' + isRequired: true + types: + - + - name: url + description: Url of the image. + isRequired: true + types: + - + - name: application + description: 'Optional. Specifies the name of application using + + the endpoint.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImagePrediction or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClient.detect_image_with_no_store + name: detect_image_with_no_store + summary: Detect objects in an image without saving the result. + signature: detect_image_with_no_store(project_id, published_name, image_data, application=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: published_name + description: 'Specifies the name of the model to evaluate + + against.' + isRequired: true + types: + - + - name: image_data + description: 'Binary image data. Supported formats are JPEG, GIF, + + PNG, and BMP. Supports images up to 4MB.' + isRequired: true + types: + - + - name: application + description: 'Optional. Specifies the name of application using + + the endpoint.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImagePrediction or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClientConfiguration.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClientConfiguration.yml new file mode 100644 index 00000000..cd0eb488 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClientConfiguration.yml @@ -0,0 +1,60 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClientConfiguration +name: CustomVisionPredictionClientConfiguration +fullName: azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClientConfiguration +module: azure.cognitiveservices.vision.customvision.prediction +summary: 'Configuration for CustomVisionPredictionClient + + Note that all parameters used to create this instance are saved as instance + + attributes.' +constructor: + syntax: CustomVisionPredictionClientConfiguration(endpoint, credentials) + parameters: + - name: endpoint + description: Supported Cognitive Services endpoints. + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClientConfiguration.add_user_agent + name: add_user_agent + summary: Add value to current user agent with a space. + signature: 'add_user_agent(value: str) -> None' + parameters: + - name: value + description: value to add to user agent. + isRequired: true + types: + - +- uid: azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClientConfiguration.load + name: load + signature: load(filepath) + parameters: + - name: filepath + isRequired: true +- uid: azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClientConfiguration.save + name: save + summary: Save current configuration to file. + signature: save(filepath) + parameters: + - name: filepath + description: Path to file where settings will be saved. + isRequired: true + types: + - + exceptions: + - type: ValueError if supplied filepath cannot be written to. +attributes: +- uid: azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClientConfiguration.enable_http_logger + name: enable_http_logger +- uid: azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClientConfiguration.user_agent + name: user_agent + summary: The current user agent value. diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.BoundingBox.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.BoundingBox.yml new file mode 100644 index 00000000..5e41e820 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.BoundingBox.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.prediction.models.BoundingBox +name: BoundingBox +fullName: azure.cognitiveservices.vision.customvision.prediction.models.BoundingBox +module: azure.cognitiveservices.vision.customvision.prediction.models +summary: 'Bounding box that defines a region of an image. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'BoundingBox(*, left: float, top: float, width: float, height: float, **kwargs)' + parameters: + - name: left + description: Required. Coordinate of the left boundary. + isRequired: true + types: + - + - name: top + description: Required. Coordinate of the top boundary. + isRequired: true + types: + - + - name: width + description: Required. Width. + isRequired: true + types: + - + - name: height + description: Required. Height. + isRequired: true + types: + - + keywordOnlyParameters: + - name: left + isRequired: true + - name: top + isRequired: true + - name: width + isRequired: true + - name: height + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.prediction.models.BoundingBox.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.prediction.models.BoundingBox.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.prediction.models.BoundingBox.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.prediction.models.BoundingBox.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.prediction.models.BoundingBox.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.prediction.models.BoundingBox.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.prediction.models.BoundingBox.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionError.yml new file mode 100644 index 00000000..9a9d721b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionError.yml @@ -0,0 +1,282 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionError +name: CustomVisionError +fullName: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionError +module: azure.cognitiveservices.vision.customvision.prediction.models +summary: 'CustomVisionError. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CustomVisionError(*, code, message: str, **kwargs)' + parameters: + - name: code + description: 'Required. The error code. Possible values include: ''NoError'', + + ''BadRequest'', ''BadRequestExceededBatchSize'', ''BadRequestNotSupported'', + + ''BadRequestInvalidIds'', ''BadRequestProjectName'', + + ''BadRequestProjectNameNotUnique'', ''BadRequestProjectDescription'', + + ''BadRequestProjectUnknownDomain'', + + ''BadRequestProjectUnknownClassification'', + + ''BadRequestProjectUnsupportedDomainTypeChange'', + + ''BadRequestProjectUnsupportedExportPlatform'', + + ''BadRequestProjectImagePreprocessingSettings'', + + ''BadRequestProjectDuplicated'', ''BadRequestIterationName'', + + ''BadRequestIterationNameNotUnique'', ''BadRequestIterationDescription'', + + ''BadRequestIterationIsNotTrained'', ''BadRequestIterationValidationFailed'', + + ''BadRequestWorkspaceCannotBeModified'', ''BadRequestWorkspaceNotDeletable'', + + ''BadRequestTagName'', ''BadRequestTagNameNotUnique'', + + ''BadRequestTagDescription'', ''BadRequestTagType'', + + ''BadRequestMultipleNegativeTag'', ''BadRequestMultipleGeneralProductTag'', + + ''BadRequestImageTags'', ''BadRequestImageRegions'', + + ''BadRequestNegativeAndRegularTagOnSameImage'', + + ''BadRequestUnsupportedDomain'', ''BadRequestRequiredParamIsNull'', + + ''BadRequestIterationIsPublished'', ''BadRequestInvalidPublishName'', + + ''BadRequestInvalidPublishTarget'', ''BadRequestUnpublishFailed'', + + ''BadRequestIterationNotPublished'', ''BadRequestSubscriptionApi'', + + ''BadRequestExceedProjectLimit'', + + ''BadRequestExceedIterationPerProjectLimit'', + + ''BadRequestExceedTagPerProjectLimit'', ''BadRequestExceedTagPerImageLimit'', + + ''BadRequestExceededQuota'', ''BadRequestCannotMigrateProjectWithName'', + + ''BadRequestNotLimitedTrial'', ''BadRequestImageBatch'', + + ''BadRequestImageStream'', ''BadRequestImageUrl'', ''BadRequestImageFormat'', + + ''BadRequestImageSizeBytes'', ''BadRequestImageDimensions'', + + ''BadRequestImageExceededCount'', ''BadRequestTrainingNotNeeded'', + + ''BadRequestTrainingNotNeededButTrainingPipelineUpdated'', + + ''BadRequestTrainingValidationFailed'', + + ''BadRequestClassificationTrainingValidationFailed'', + + ''BadRequestMultiClassClassificationTrainingValidationFailed'', + + ''BadRequestMultiLabelClassificationTrainingValidationFailed'', + + ''BadRequestDetectionTrainingValidationFailed'', + + ''BadRequestTrainingAlreadyInProgress'', + + ''BadRequestDetectionTrainingNotAllowNegativeTag'', + + ''BadRequestInvalidEmailAddress'', + + ''BadRequestDomainNotSupportedForAdvancedTraining'', + + ''BadRequestExportPlatformNotSupportedForAdvancedTraining'', + + ''BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining'', + + ''BadRequestExportValidationFailed'', ''BadRequestExportAlreadyInProgress'', + + ''BadRequestPredictionIdsMissing'', ''BadRequestPredictionIdsExceededCount'', + + ''BadRequestPredictionTagsExceededCount'', + + ''BadRequestPredictionResultsExceededCount'', + + ''BadRequestPredictionInvalidApplicationName'', + + ''BadRequestPredictionInvalidQueryParameters'', + + ''BadRequestInvalidImportToken'', ''BadRequestExportWhileTraining'', + + ''BadRequestImageMetadataKey'', ''BadRequestImageMetadataValue'', + + ''BadRequestOperationNotSupported'', ''BadRequestInvalidArtifactUri'', + + ''BadRequestCustomerManagedKeyRevoked'', ''BadRequestInvalid'', + + ''UnsupportedMediaType'', ''Forbidden'', ''ForbiddenUser'', + + ''ForbiddenUserResource'', ''ForbiddenUserSignupDisabled'', + + ''ForbiddenUserSignupAllowanceExceeded'', ''ForbiddenUserDoesNotExist'', + + ''ForbiddenUserDisabled'', ''ForbiddenUserInsufficientCapability'', + + ''ForbiddenDRModeEnabled'', ''ForbiddenInvalid'', ''NotFound'', + + ''NotFoundProject'', ''NotFoundProjectDefaultIteration'', ''NotFoundIteration'', + + ''NotFoundIterationPerformance'', ''NotFoundTag'', ''NotFoundImage'', + + ''NotFoundDomain'', ''NotFoundApimSubscription'', ''NotFoundInvalid'', + + ''Conflict'', ''ConflictInvalid'', ''ErrorUnknown'', ''ErrorIterationCopyFailed'', + + ''ErrorPreparePerformanceMigrationFailed'', ''ErrorProjectInvalidWorkspace'', + + ''ErrorProjectInvalidPipelineConfiguration'', ''ErrorProjectInvalidDomain'', + + ''ErrorProjectTrainingRequestFailed'', ''ErrorProjectImportRequestFailed'', + + ''ErrorProjectExportRequestFailed'', ''ErrorFeaturizationServiceUnavailable'', + + ''ErrorFeaturizationQueueTimeout'', ''ErrorFeaturizationInvalidFeaturizer'', + + ''ErrorFeaturizationAugmentationUnavailable'', + + ''ErrorFeaturizationUnrecognizedJob'', + + ''ErrorFeaturizationAugmentationError'', ''ErrorExporterInvalidPlatform'', + + ''ErrorExporterInvalidFeaturizer'', ''ErrorExporterInvalidClassifier'', + + ''ErrorPredictionServiceUnavailable'', ''ErrorPredictionModelNotFound'', + + ''ErrorPredictionModelNotCached'', ''ErrorPrediction'', + + ''ErrorPredictionStorage'', ''ErrorRegionProposal'', ''ErrorUnknownBaseModel'', + + ''ErrorInvalid''' + isRequired: true + types: + - + - + - name: message + description: 'Required. A message explaining the error reported by the + + service.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.yml new file mode 100644 index 00000000..abdb3792 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.yml @@ -0,0 +1,266 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes +name: CustomVisionErrorCodes +fullName: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes +module: azure.cognitiveservices.vision.customvision.prediction.models +fields: +- name: bad_request + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request +- name: bad_request_cannot_migrate_project_with_name + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_cannot_migrate_project_with_name +- name: bad_request_classification_training_validation_failed + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_classification_training_validation_failed +- name: bad_request_customer_managed_key_revoked + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_customer_managed_key_revoked +- name: bad_request_detection_training_not_allow_negative_tag + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_detection_training_not_allow_negative_tag +- name: bad_request_detection_training_validation_failed + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_detection_training_validation_failed +- name: bad_request_domain_not_supported_for_advanced_training + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_domain_not_supported_for_advanced_training +- name: bad_request_exceed_iteration_per_project_limit + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_exceed_iteration_per_project_limit +- name: bad_request_exceed_project_limit + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_exceed_project_limit +- name: bad_request_exceed_tag_per_image_limit + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_exceed_tag_per_image_limit +- name: bad_request_exceed_tag_per_project_limit + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_exceed_tag_per_project_limit +- name: bad_request_exceeded_batch_size + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_exceeded_batch_size +- name: bad_request_exceeded_quota + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_exceeded_quota +- name: bad_request_export_already_in_progress + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_export_already_in_progress +- name: bad_request_export_platform_not_supported_for_advanced_training + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_export_platform_not_supported_for_advanced_training +- name: bad_request_export_validation_failed + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_export_validation_failed +- name: bad_request_export_while_training + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_export_while_training +- name: bad_request_image_batch + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_image_batch +- name: bad_request_image_dimensions + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_image_dimensions +- name: bad_request_image_exceeded_count + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_image_exceeded_count +- name: bad_request_image_format + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_image_format +- name: bad_request_image_metadata_key + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_image_metadata_key +- name: bad_request_image_metadata_value + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_image_metadata_value +- name: bad_request_image_regions + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_image_regions +- name: bad_request_image_size_bytes + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_image_size_bytes +- name: bad_request_image_stream + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_image_stream +- name: bad_request_image_tags + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_image_tags +- name: bad_request_image_url + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_image_url +- name: bad_request_invalid + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_invalid +- name: bad_request_invalid_artifact_uri + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_invalid_artifact_uri +- name: bad_request_invalid_email_address + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_invalid_email_address +- name: bad_request_invalid_ids + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_invalid_ids +- name: bad_request_invalid_import_token + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_invalid_import_token +- name: bad_request_invalid_publish_name + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_invalid_publish_name +- name: bad_request_invalid_publish_target + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_invalid_publish_target +- name: bad_request_iteration_description + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_iteration_description +- name: bad_request_iteration_is_not_trained + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_iteration_is_not_trained +- name: bad_request_iteration_is_published + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_iteration_is_published +- name: bad_request_iteration_name + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_iteration_name +- name: bad_request_iteration_name_not_unique + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_iteration_name_not_unique +- name: bad_request_iteration_not_published + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_iteration_not_published +- name: bad_request_iteration_validation_failed + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_iteration_validation_failed +- name: bad_request_multi_class_classification_training_validation_failed + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_multi_class_classification_training_validation_failed +- name: bad_request_multi_label_classification_training_validation_failed + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_multi_label_classification_training_validation_failed +- name: bad_request_multiple_general_product_tag + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_multiple_general_product_tag +- name: bad_request_multiple_negative_tag + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_multiple_negative_tag +- name: bad_request_negative_and_regular_tag_on_same_image + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_negative_and_regular_tag_on_same_image +- name: bad_request_not_limited_trial + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_not_limited_trial +- name: bad_request_not_supported + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_not_supported +- name: bad_request_operation_not_supported + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_operation_not_supported +- name: bad_request_prediction_ids_exceeded_count + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_prediction_ids_exceeded_count +- name: bad_request_prediction_ids_missing + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_prediction_ids_missing +- name: bad_request_prediction_invalid_application_name + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_prediction_invalid_application_name +- name: bad_request_prediction_invalid_query_parameters + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_prediction_invalid_query_parameters +- name: bad_request_prediction_results_exceeded_count + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_prediction_results_exceeded_count +- name: bad_request_prediction_tags_exceeded_count + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_prediction_tags_exceeded_count +- name: bad_request_project_description + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_project_description +- name: bad_request_project_duplicated + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_project_duplicated +- name: bad_request_project_image_preprocessing_settings + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_project_image_preprocessing_settings +- name: bad_request_project_name + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_project_name +- name: bad_request_project_name_not_unique + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_project_name_not_unique +- name: bad_request_project_unknown_classification + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_project_unknown_classification +- name: bad_request_project_unknown_domain + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_project_unknown_domain +- name: bad_request_project_unsupported_domain_type_change + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_project_unsupported_domain_type_change +- name: bad_request_project_unsupported_export_platform + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_project_unsupported_export_platform +- name: bad_request_required_param_is_null + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_required_param_is_null +- name: bad_request_reserved_budget_in_hours_not_enough_for_advanced_training + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_reserved_budget_in_hours_not_enough_for_advanced_training +- name: bad_request_subscription_api + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_subscription_api +- name: bad_request_tag_description + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_tag_description +- name: bad_request_tag_name + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_tag_name +- name: bad_request_tag_name_not_unique + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_tag_name_not_unique +- name: bad_request_tag_type + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_tag_type +- name: bad_request_training_already_in_progress + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_training_already_in_progress +- name: bad_request_training_not_needed + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_training_not_needed +- name: bad_request_training_not_needed_but_training_pipeline_updated + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_training_not_needed_but_training_pipeline_updated +- name: bad_request_training_validation_failed + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_training_validation_failed +- name: bad_request_unpublish_failed + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_unpublish_failed +- name: bad_request_unsupported_domain + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_unsupported_domain +- name: bad_request_workspace_cannot_be_modified + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_workspace_cannot_be_modified +- name: bad_request_workspace_not_deletable + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.bad_request_workspace_not_deletable +- name: conflict + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.conflict +- name: conflict_invalid + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.conflict_invalid +- name: error_exporter_invalid_classifier + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_exporter_invalid_classifier +- name: error_exporter_invalid_featurizer + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_exporter_invalid_featurizer +- name: error_exporter_invalid_platform + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_exporter_invalid_platform +- name: error_featurization_augmentation_error + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_featurization_augmentation_error +- name: error_featurization_augmentation_unavailable + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_featurization_augmentation_unavailable +- name: error_featurization_invalid_featurizer + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_featurization_invalid_featurizer +- name: error_featurization_queue_timeout + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_featurization_queue_timeout +- name: error_featurization_service_unavailable + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_featurization_service_unavailable +- name: error_featurization_unrecognized_job + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_featurization_unrecognized_job +- name: error_invalid + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_invalid +- name: error_iteration_copy_failed + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_iteration_copy_failed +- name: error_prediction + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_prediction +- name: error_prediction_model_not_cached + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_prediction_model_not_cached +- name: error_prediction_model_not_found + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_prediction_model_not_found +- name: error_prediction_service_unavailable + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_prediction_service_unavailable +- name: error_prediction_storage + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_prediction_storage +- name: error_prepare_performance_migration_failed + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_prepare_performance_migration_failed +- name: error_project_export_request_failed + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_project_export_request_failed +- name: error_project_import_request_failed + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_project_import_request_failed +- name: error_project_invalid_domain + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_project_invalid_domain +- name: error_project_invalid_pipeline_configuration + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_project_invalid_pipeline_configuration +- name: error_project_invalid_workspace + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_project_invalid_workspace +- name: error_project_training_request_failed + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_project_training_request_failed +- name: error_region_proposal + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_region_proposal +- name: error_unknown + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_unknown +- name: error_unknown_base_model + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.error_unknown_base_model +- name: forbidden + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.forbidden +- name: forbidden_dr_mode_enabled + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.forbidden_dr_mode_enabled +- name: forbidden_invalid + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.forbidden_invalid +- name: forbidden_user + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.forbidden_user +- name: forbidden_user_disabled + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.forbidden_user_disabled +- name: forbidden_user_does_not_exist + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.forbidden_user_does_not_exist +- name: forbidden_user_insufficient_capability + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.forbidden_user_insufficient_capability +- name: forbidden_user_resource + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.forbidden_user_resource +- name: forbidden_user_signup_allowance_exceeded + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.forbidden_user_signup_allowance_exceeded +- name: forbidden_user_signup_disabled + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.forbidden_user_signup_disabled +- name: no_error + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.no_error +- name: not_found + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.not_found +- name: not_found_apim_subscription + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.not_found_apim_subscription +- name: not_found_domain + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.not_found_domain +- name: not_found_image + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.not_found_image +- name: not_found_invalid + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.not_found_invalid +- name: not_found_iteration + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.not_found_iteration +- name: not_found_iteration_performance + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.not_found_iteration_performance +- name: not_found_project + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.not_found_project +- name: not_found_project_default_iteration + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.not_found_project_default_iteration +- name: not_found_tag + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.not_found_tag +- name: unsupported_media_type + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes.unsupported_media_type diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException.yml new file mode 100644 index 00000000..2b76349b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException +name: CustomVisionErrorException +fullName: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException +module: azure.cognitiveservices.vision.customvision.prediction.models +summary: 'Server responded with exception of type: ''CustomVisionError''.' +constructor: + syntax: CustomVisionErrorException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException.args + name: args diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.ImagePrediction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.ImagePrediction.yml new file mode 100644 index 00000000..ff735fb3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.ImagePrediction.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.prediction.models.ImagePrediction +name: ImagePrediction +fullName: azure.cognitiveservices.vision.customvision.prediction.models.ImagePrediction +module: azure.cognitiveservices.vision.customvision.prediction.models +summary: 'Result of an image prediction request. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: ImagePrediction(**kwargs) +variables: +- description: Prediction Id. + name: id + types: + - +- description: Project Id. + name: project + types: + - +- description: Iteration Id. + name: iteration + types: + - +- description: Date this prediction was created. + name: created + types: + - +- description: List of predictions. + name: predictions + types: + - [] +methods: +- uid: azure.cognitiveservices.vision.customvision.prediction.models.ImagePrediction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.prediction.models.ImagePrediction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.prediction.models.ImagePrediction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.prediction.models.ImagePrediction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.prediction.models.ImagePrediction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.prediction.models.ImagePrediction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.prediction.models.ImagePrediction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.ImageUrl.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.ImageUrl.yml new file mode 100644 index 00000000..dc7535b4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.ImageUrl.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.prediction.models.ImageUrl +name: ImageUrl +fullName: azure.cognitiveservices.vision.customvision.prediction.models.ImageUrl +module: azure.cognitiveservices.vision.customvision.prediction.models +summary: 'Image url. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ImageUrl(*, url: str, **kwargs)' + parameters: + - name: url + description: Required. Url of the image. + isRequired: true + types: + - + keywordOnlyParameters: + - name: url + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.prediction.models.ImageUrl.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.prediction.models.ImageUrl.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.prediction.models.ImageUrl.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.prediction.models.ImageUrl.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.prediction.models.ImageUrl.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.prediction.models.ImageUrl.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.prediction.models.ImageUrl.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.Prediction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.Prediction.yml new file mode 100644 index 00000000..e3aaf779 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.Prediction.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.prediction.models.Prediction +name: Prediction +fullName: azure.cognitiveservices.vision.customvision.prediction.models.Prediction +module: azure.cognitiveservices.vision.customvision.prediction.models +summary: 'Prediction result. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Prediction(**kwargs) +variables: +- description: Probability of the tag. + name: probability + types: + - +- description: Id of the predicted tag. + name: tag_id + types: + - +- description: Name of the predicted tag. + name: tag_name + types: + - +- description: Bounding box of the prediction. + name: bounding_box + types: + - +- description: 'Type of the predicted tag. Possible values include: + + ''Regular'', ''Negative'', ''GeneralProduct''' + name: tag_type + types: + - + - +methods: +- uid: azure.cognitiveservices.vision.customvision.prediction.models.Prediction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.prediction.models.Prediction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.prediction.models.Prediction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.prediction.models.Prediction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.prediction.models.Prediction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.prediction.models.Prediction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.prediction.models.Prediction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.TagType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.TagType.yml new file mode 100644 index 00000000..a6e023b8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.TagType.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.customvision.prediction.models.TagType +name: TagType +fullName: azure.cognitiveservices.vision.customvision.prediction.models.TagType +module: azure.cognitiveservices.vision.customvision.prediction.models +fields: +- name: general_product + uid: azure.cognitiveservices.vision.customvision.prediction.models.TagType.general_product +- name: negative + uid: azure.cognitiveservices.vision.customvision.prediction.models.TagType.negative +- name: regular + uid: azure.cognitiveservices.vision.customvision.prediction.models.TagType.regular diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.yml new file mode 100644 index 00000000..67475a7c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.models.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.vision.customvision.prediction.models +name: models +fullName: azure.cognitiveservices.vision.customvision.prediction.models +type: import +classes: +- azure.cognitiveservices.vision.customvision.prediction.models.BoundingBox +- azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionError +- azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException +- azure.cognitiveservices.vision.customvision.prediction.models.ImagePrediction +- azure.cognitiveservices.vision.customvision.prediction.models.ImageUrl +- azure.cognitiveservices.vision.customvision.prediction.models.Prediction +enums: +- azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes +- azure.cognitiveservices.vision.customvision.prediction.models.TagType diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.operations.CustomVisionPredictionClientOperationsMixin.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.operations.CustomVisionPredictionClientOperationsMixin.yml new file mode 100644 index 00000000..92a53fe6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.operations.CustomVisionPredictionClientOperationsMixin.yml @@ -0,0 +1,448 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.prediction.operations.CustomVisionPredictionClientOperationsMixin +name: CustomVisionPredictionClientOperationsMixin +fullName: azure.cognitiveservices.vision.customvision.prediction.operations.CustomVisionPredictionClientOperationsMixin +module: azure.cognitiveservices.vision.customvision.prediction.operations +constructor: + syntax: CustomVisionPredictionClientOperationsMixin() +methods: +- uid: azure.cognitiveservices.vision.customvision.prediction.operations.CustomVisionPredictionClientOperationsMixin.classify_image + name: classify_image + summary: Classify an image and saves the result. + signature: classify_image(project_id, published_name, image_data, application=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: published_name + description: 'Specifies the name of the model to evaluate + + against.' + isRequired: true + types: + - + - name: image_data + description: 'Binary image data. Supported formats are JPEG, GIF, + + PNG, and BMP. Supports images up to 4MB.' + isRequired: true + types: + - + - name: application + description: 'Optional. Specifies the name of application using + + the endpoint.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImagePrediction or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.prediction.operations.CustomVisionPredictionClientOperationsMixin.classify_image_url + name: classify_image_url + summary: Classify an image url and saves the result. + signature: classify_image_url(project_id, published_name, url, application=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: published_name + description: 'Specifies the name of the model to evaluate + + against.' + isRequired: true + types: + - + - name: url + description: Url of the image. + isRequired: true + types: + - + - name: application + description: 'Optional. Specifies the name of application using + + the endpoint.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImagePrediction or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.prediction.operations.CustomVisionPredictionClientOperationsMixin.classify_image_url_with_no_store + name: classify_image_url_with_no_store + summary: Classify an image url without saving the result. + signature: classify_image_url_with_no_store(project_id, published_name, url, application=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: published_name + description: 'Specifies the name of the model to evaluate + + against.' + isRequired: true + types: + - + - name: url + description: Url of the image. + isRequired: true + types: + - + - name: application + description: 'Optional. Specifies the name of application using + + the endpoint.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImagePrediction or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.prediction.operations.CustomVisionPredictionClientOperationsMixin.classify_image_with_no_store + name: classify_image_with_no_store + summary: Classify an image without saving the result. + signature: classify_image_with_no_store(project_id, published_name, image_data, + application=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: published_name + description: 'Specifies the name of the model to evaluate + + against.' + isRequired: true + types: + - + - name: image_data + description: 'Binary image data. Supported formats are JPEG, GIF, + + PNG, and BMP. Supports images up to 4MB.' + isRequired: true + types: + - + - name: application + description: 'Optional. Specifies the name of application using + + the endpoint.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImagePrediction or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.prediction.operations.CustomVisionPredictionClientOperationsMixin.detect_image + name: detect_image + summary: Detect objects in an image and saves the result. + signature: detect_image(project_id, published_name, image_data, application=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: published_name + description: 'Specifies the name of the model to evaluate + + against.' + isRequired: true + types: + - + - name: image_data + description: 'Binary image data. Supported formats are JPEG, GIF, + + PNG, and BMP. Supports images up to 4MB.' + isRequired: true + types: + - + - name: application + description: 'Optional. Specifies the name of application using + + the endpoint.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImagePrediction or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.prediction.operations.CustomVisionPredictionClientOperationsMixin.detect_image_url + name: detect_image_url + summary: Detect objects in an image url and saves the result. + signature: detect_image_url(project_id, published_name, url, application=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: published_name + description: 'Specifies the name of the model to evaluate + + against.' + isRequired: true + types: + - + - name: url + description: Url of the image. + isRequired: true + types: + - + - name: application + description: 'Optional. Specifies the name of application using + + the endpoint.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImagePrediction or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.prediction.operations.CustomVisionPredictionClientOperationsMixin.detect_image_url_with_no_store + name: detect_image_url_with_no_store + summary: Detect objects in an image url without saving the result. + signature: detect_image_url_with_no_store(project_id, published_name, url, application=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: published_name + description: 'Specifies the name of the model to evaluate + + against.' + isRequired: true + types: + - + - name: url + description: Url of the image. + isRequired: true + types: + - + - name: application + description: 'Optional. Specifies the name of application using + + the endpoint.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImagePrediction or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.prediction.operations.CustomVisionPredictionClientOperationsMixin.detect_image_with_no_store + name: detect_image_with_no_store + summary: Detect objects in an image without saving the result. + signature: detect_image_with_no_store(project_id, published_name, image_data, application=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: published_name + description: 'Specifies the name of the model to evaluate + + against.' + isRequired: true + types: + - + - name: image_data + description: 'Binary image data. Supported formats are JPEG, GIF, + + PNG, and BMP. Supports images up to 4MB.' + isRequired: true + types: + - + - name: application + description: 'Optional. Specifies the name of application using + + the endpoint.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImagePrediction or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.operations.yml new file mode 100644 index 00000000..85719d6d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.operations.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.vision.customvision.prediction.operations +name: operations +fullName: azure.cognitiveservices.vision.customvision.prediction.operations +type: import +classes: +- azure.cognitiveservices.vision.customvision.prediction.operations.CustomVisionPredictionClientOperationsMixin diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.version.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.version.yml new file mode 100644 index 00000000..698cb08f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.vision.customvision.prediction.version +name: version +fullName: azure.cognitiveservices.vision.customvision.prediction.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.yml new file mode 100644 index 00000000..74ced761 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.prediction.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.vision.customvision.prediction +name: prediction +fullName: azure.cognitiveservices.vision.customvision.prediction +type: import +classes: +- azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClient +- azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClientConfiguration +packages: +- azure.cognitiveservices.vision.customvision.prediction.models +- azure.cognitiveservices.vision.customvision.prediction.operations +modules: +- azure.cognitiveservices.vision.customvision.prediction.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.yml new file mode 100644 index 00000000..886358cd --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.yml @@ -0,0 +1,2732 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient +name: CustomVisionTrainingClient +fullName: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient +module: azure.cognitiveservices.vision.customvision.training +constructor: + syntax: CustomVisionTrainingClient(endpoint, credentials) + parameters: + - name: endpoint + description: Supported Cognitive Services endpoints. + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +methods: +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.create_image_regions + name: create_image_regions + summary: 'Create a set of image regions. + + + This API accepts a batch of image regions, and optionally tags, to + + update existing images with region information. + + There is a limit of 64 entries in the batch. + + If all regions are successful created, 200(OK) status code will be + + returned. + + Otherwise, 207 (Multi-Status) status code will be returned and detail + + status for each region will be listed in the response payload.' + signature: create_image_regions(project_id, regions=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: regions + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageRegionCreateSummary or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.create_image_tags + name: create_image_tags + summary: Associate a set of images with a set of tags. + signature: create_image_tags(project_id, tags=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: tags + description: Image Tag entries to include in this batch. + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageTagCreateSummary or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.create_images_from_data + name: create_images_from_data + summary: 'Add the provided images to the set of training images. + + + This API accepts body content as multipart/form-data and + + application/octet-stream. When using multipart + + multiple image files can be sent at once, with a maximum of 64 files. + + If all images are successful created, 200(OK) status code will be + + returned. + + Otherwise, 207 (Multi-Status) status code will be returned and detail + + status for each image will be listed in the response payload.' + signature: create_images_from_data(project_id, image_data, tag_ids=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: image_data + description: 'Binary image data. Supported formats are JPEG, GIF, + + PNG, and BMP. Supports images up to 6MB.' + isRequired: true + types: + - + - name: tag_ids + description: 'The tags ids with which to tag each image. Limited to + + 20.' + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageCreateSummary or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.create_images_from_files + name: create_images_from_files + summary: 'Add the provided batch of images to the set of training images. + + + This API accepts a batch of files, and optionally tags, to create + + images. There is a limit of 64 images and 20 tags. + + If all images are successful created, 200(OK) status code will be + + returned. + + Otherwise, 207 (Multi-Status) status code will be returned and detail + + status for each image will be listed in the response payload.' + signature: create_images_from_files(project_id, batch, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: batch + description: 'The batch of image files to add. Limited to 64 images + + and 20 tags per batch.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageCreateSummary or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.create_images_from_predictions + name: create_images_from_predictions + summary: 'Add the specified predicted images to the set of training images. + + + This API creates a batch of images from predicted images specified. + + There is a limit of 64 images and 20 tags. + + If all images are successful created, 200(OK) status code will be + + returned. + + Otherwise, 207 (Multi-Status) status code will be returned and detail + + status for each image will be listed in the response payload.' + signature: create_images_from_predictions(project_id, batch, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: batch + description: 'Image, tag ids, and metadata. Limited to 64 images and + + 20 tags per batch.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageCreateSummary or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.create_images_from_urls + name: create_images_from_urls + summary: 'Add the provided images urls to the set of training images. + + + This API accepts a batch of urls, and optionally tags, to create + + images. There is a limit of 64 images and 20 tags. + + If all images are successful created, 200(OK) status code will be + + returned. + + Otherwise, 207 (Multi-Status) status code will be returned and detail + + status for each image will be listed in the response payload.' + signature: create_images_from_urls(project_id, batch, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: batch + description: 'Image urls, tag ids, and metadata. Limited to 64 images + + and 20 tags per batch.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageCreateSummary or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.create_project + name: create_project + summary: Create a project. + signature: create_project(name, description=None, domain_id=None, classification_type=None, + target_export_platforms=None, export_model_container_uri=None, notification_queue_uri=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: name + description: Name of the project. + isRequired: true + types: + - + - name: description + description: The description of the project. + defaultValue: None + types: + - + - name: domain_id + description: 'The id of the domain to use for this project. + + Defaults to General.' + defaultValue: None + types: + - + - name: classification_type + description: 'The type of classifier to create for this + + project. Possible values include: ''Multiclass'', ''Multilabel''' + defaultValue: None + types: + - + - name: target_export_platforms + description: 'List of platforms the trained model is + + intending exporting to.' + defaultValue: None + types: + - [] + - name: export_model_container_uri + description: 'The uri to the Azure Storage + + container that will be used to store exported models.' + defaultValue: None + types: + - + - name: notification_queue_uri + description: 'The uri to the Azure Storage queue that + + will be used to send project-related notifications. See Storage + + notifications documentation for setup and message format.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Project or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.create_tag + name: create_tag + summary: Create a tag for the project. + signature: create_tag(project_id, name, description=None, type=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: name + description: The tag name. + isRequired: true + types: + - + - name: description + description: Optional description for the tag. + defaultValue: None + types: + - + - name: type + description: 'Optional type for the tag. Possible values include: + + ''Regular'', ''Negative'', ''GeneralProduct''' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Tag or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.delete_image_regions + name: delete_image_regions + summary: Delete a set of image regions. + signature: delete_image_regions(project_id, region_ids, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: region_ids + description: Regions to delete. Limited to 64. + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.delete_image_tags + name: delete_image_tags + summary: Remove a set of tags from a set of images. + signature: delete_image_tags(project_id, image_ids, tag_ids, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: image_ids + description: Image ids. Limited to 64 images. + isRequired: true + types: + - [] + - name: tag_ids + description: 'Tags to be deleted from the specified images. Limited + + to 20 tags.' + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.delete_images + name: delete_images + summary: Delete images from the set of training images. + signature: delete_images(project_id, image_ids=None, all_images=None, all_iterations=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: image_ids + description: 'Ids of the images to be deleted. Limited to 256 + + images per batch.' + defaultValue: None + types: + - [] + - name: all_images + description: 'Flag to specify delete all images, specify this + + flag or a list of images. Using this flag will return a 202 response + + to indicate the images are being deleted.' + defaultValue: None + types: + - + - name: all_iterations + description: 'Removes these images from all iterations, not + + just the current workspace. Using this flag will return a 202 response + + to indicate the images are being deleted.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.delete_iteration + name: delete_iteration + summary: Delete a specific iteration of a project. + signature: delete_iteration(project_id, iteration_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.delete_prediction + name: delete_prediction + summary: 'Delete a set of predicted images and their associated prediction + + results.' + signature: delete_prediction(project_id, ids, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: ids + description: The prediction ids. Limited to 64. + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.delete_project + name: delete_project + summary: Delete a specific project. + signature: delete_project(project_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.delete_tag + name: delete_tag + summary: Delete a tag from the project. + signature: delete_tag(project_id, tag_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: tag_id + description: Id of the tag to be deleted. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.export_iteration + name: export_iteration + summary: Export a trained iteration. + signature: export_iteration(project_id, iteration_id, platform, flavor=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. + isRequired: true + types: + - + - name: platform + description: 'The target platform. Possible values include: + + ''CoreML'', ''TensorFlow'', ''DockerFile'', ''ONNX'', ''VAIDK'', ''OpenVino''' + isRequired: true + types: + - + - name: flavor + description: 'The flavor of the target platform. Possible values + + include: ''Linux'', ''Windows'', ''ONNX10'', ''ONNX12'', ''ARM'', + + ''TensorFlowNormal'', ''TensorFlowLite''' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Export or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.export_project + name: export_project + summary: Exports a project. + signature: export_project(project_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id of the project to export. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ProjectExport or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.get_artifact + name: get_artifact + summary: 'Get artifact content from blob storage, based on artifact relative path + + in the blob.' + signature: get_artifact(project_id, path, custom_headers=None, raw=False, callback=None, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: path + description: The relative path for artifact. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: object or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrest.exceptions.HttpOperationError +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.get_domain + name: get_domain + summary: Get information about a specific domain. + signature: get_domain(domain_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: domain_id + description: The id of the domain to get information about. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Domain or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.get_domains + name: get_domains + summary: Get a list of the available domains. + signature: get_domains(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.get_exports + name: get_exports + summary: Get the list of exports for a specific iteration. + signature: get_exports(project_id, iteration_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.get_image_count + name: get_image_count + summary: 'Get the number of images. + + + The filtering is on an and/or relationship. For example, if the + + provided tag ids are for the "Dog" and + + "Cat" tags, then only images tagged with Dog and/or Cat will be + + returned.' + signature: get_image_count(project_id, iteration_id=None, tagging_status=None, filter=None, + tag_ids=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. Defaults to workspace. + defaultValue: None + types: + - + - name: tagging_status + description: 'The tagging status filter. It can be ''All'', + + ''Tagged'', or ''Untagged''. Defaults to ''All''. Possible values include: + + ''All'', ''Tagged'', ''Untagged''' + defaultValue: None + types: + - + - name: filter + description: 'An expression to filter the images against image + + metadata. Only images where the expression evaluates to true are + + included in the response. + + The expression supports eq (Equal), ne (Not equal), and (Logical and), + + or (Logical or) operators. + + Here is an example, metadata=key1 eq ''value1'' and key2 ne ''value2''.' + defaultValue: None + types: + - + - name: tag_ids + description: 'A list of tags ids to filter the images to count. + + Defaults to all tags when null.' + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: int or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.get_image_performance_count + name: get_image_performance_count + summary: 'Gets the number of images tagged with the provided {tagIds} that have + + prediction results from + + training for the provided iteration {iterationId}. + + + The filtering is on an and/or relationship. For example, if the + + provided tag ids are for the "Dog" and + + "Cat" tags, then only images tagged with Dog and/or Cat will be + + returned.' + signature: get_image_performance_count(project_id, iteration_id, tag_ids=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. Defaults to workspace. + isRequired: true + types: + - + - name: tag_ids + description: 'A list of tags ids to filter the images to count. + + Defaults to all tags when null.' + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: int or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.get_image_performances + name: get_image_performances + summary: 'Get image with its prediction for a given project iteration. + + + This API supports batching and range selection. By default it will only + + return first 50 images matching images. + + Use the {take} and {skip} parameters to control how many images to + + return in a given batch. + + The filtering is on an and/or relationship. For example, if the + + provided tag ids are for the "Dog" and + + "Cat" tags, then only images tagged with Dog and/or Cat will be + + returned.' + signature: get_image_performances(project_id, iteration_id, tag_ids=None, order_by=None, + take=50, skip=0, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. Defaults to workspace. + isRequired: true + types: + - + - name: tag_ids + description: 'A list of tags ids to filter the images. Defaults to + + all tagged images when null. Limited to 20.' + defaultValue: None + types: + - [] + - name: order_by + description: 'The ordering. Defaults to newest. Possible values + + include: ''Newest'', ''Oldest''' + defaultValue: None + types: + - + - name: take + description: 'Maximum number of images to return. Defaults to 50, + + limited to 256.' + defaultValue: '50' + types: + - + - name: skip + description: 'Number of images to skip before beginning the image + + batch. Defaults to 0.' + defaultValue: '0' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.get_image_region_proposals + name: get_image_region_proposals + summary: 'Get region proposals for an image. Returns empty array if no proposals + + are found. + + + This API will get region proposals for an image along with confidences + + for the region. It returns an empty array if no proposals are found.' + signature: get_image_region_proposals(project_id, image_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: image_id + description: The image id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageRegionProposal or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.get_images + name: get_images + summary: 'Get images for a given project iteration or workspace. + + + This API supports batching and range selection. By default it will only + + return first 50 images matching images. + + Use the {take} and {skip} parameters to control how many images to + + return in a given batch. + + The filtering is on an and/or relationship. For example, if the + + provided tag ids are for the "Dog" and + + "Cat" tags, then only images tagged with Dog and/or Cat will be + + returned.' + signature: get_images(project_id, iteration_id=None, tag_ids=None, tagging_status=None, + filter=None, order_by=None, take=50, skip=0, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. Defaults to workspace. + defaultValue: None + types: + - + - name: tag_ids + description: 'A list of tags ids to filter the images. Defaults to + + all tagged images when null. Limited to 20.' + defaultValue: None + types: + - [] + - name: tagging_status + description: 'The tagging status filter. It can be ''All'', + + ''Tagged'', or ''Untagged''. Defaults to ''All''. Possible values include: + + ''All'', ''Tagged'', ''Untagged''' + defaultValue: None + types: + - + - name: filter + description: 'An expression to filter the images against image + + metadata. Only images where the expression evaluates to true are + + included in the response. + + The expression supports eq (Equal), ne (Not equal), and (Logical and), + + or (Logical or) operators. + + Here is an example, metadata=key1 eq ''value1'' and key2 ne ''value2''.' + defaultValue: None + types: + - + - name: order_by + description: 'The ordering. Defaults to newest. Possible values + + include: ''Newest'', ''Oldest''' + defaultValue: None + types: + - + - name: take + description: 'Maximum number of images to return. Defaults to 50, + + limited to 256.' + defaultValue: '50' + types: + - + - name: skip + description: 'Number of images to skip before beginning the image + + batch. Defaults to 0.' + defaultValue: '0' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.get_images_by_ids + name: get_images_by_ids + summary: 'Get images by id for a given project iteration. + + + This API will return a set of Images for the specified tags and + + optionally iteration. If no iteration is specified the + + current workspace is used.' + signature: get_images_by_ids(project_id, image_ids=None, iteration_id=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: image_ids + description: The list of image ids to retrieve. Limited to 256. + defaultValue: None + types: + - [] + - name: iteration_id + description: The iteration id. Defaults to workspace. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.get_iteration + name: get_iteration + summary: Get a specific iteration. + signature: get_iteration(project_id, iteration_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The id of the project the iteration belongs to. + isRequired: true + types: + - + - name: iteration_id + description: The id of the iteration to get. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Iteration or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.get_iteration_performance + name: get_iteration_performance + summary: Get detailed performance information about an iteration. + signature: get_iteration_performance(project_id, iteration_id, threshold=None, overlap_threshold=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The id of the project the iteration belongs to. + isRequired: true + types: + - + - name: iteration_id + description: The id of the iteration to get. + isRequired: true + types: + - + - name: threshold + description: The threshold used to determine true predictions. + defaultValue: None + types: + - + - name: overlap_threshold + description: 'If applicable, the bounding box overlap + + threshold used to determine true predictions.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: IterationPerformance or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.get_iterations + name: get_iterations + summary: Get iterations for the project. + signature: get_iterations(project_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.get_project + name: get_project + summary: Get a specific project. + signature: get_project(project_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The id of the project to get. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Project or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.get_projects + name: get_projects + summary: Get your projects. + signature: get_projects(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.get_tag + name: get_tag + summary: Get information about a specific tag. + signature: get_tag(project_id, tag_id, iteration_id=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project this tag belongs to. + isRequired: true + types: + - + - name: tag_id + description: The tag id. + isRequired: true + types: + - + - name: iteration_id + description: 'The iteration to retrieve this tag from. + + Optional, defaults to current training set.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Tag or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.get_tagged_image_count + name: get_tagged_image_count + summary: 'Gets the number of images tagged with the provided {tagIds}. + + + The filtering is on an and/or relationship. For example, if the + + provided tag ids are for the "Dog" and + + "Cat" tags, then only images tagged with Dog and/or Cat will be + + returned.' + signature: get_tagged_image_count(project_id, iteration_id=None, tag_ids=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. Defaults to workspace. + defaultValue: None + types: + - + - name: tag_ids + description: 'A list of tags ids to filter the images to count. + + Defaults to all tags when null.' + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: int or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.get_tagged_images + name: get_tagged_images + summary: 'Get tagged images for a given project iteration. + + + This API supports batching and range selection. By default it will only + + return first 50 images matching images. + + Use the {take} and {skip} parameters to control how many images to + + return in a given batch. + + The filtering is on an and/or relationship. For example, if the + + provided tag ids are for the "Dog" and + + "Cat" tags, then only images tagged with Dog and/or Cat will be + + returned.' + signature: get_tagged_images(project_id, iteration_id=None, tag_ids=None, order_by=None, + take=50, skip=0, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. Defaults to workspace. + defaultValue: None + types: + - + - name: tag_ids + description: 'A list of tags ids to filter the images. Defaults to + + all tagged images when null. Limited to 20.' + defaultValue: None + types: + - [] + - name: order_by + description: 'The ordering. Defaults to newest. Possible values + + include: ''Newest'', ''Oldest''' + defaultValue: None + types: + - + - name: take + description: 'Maximum number of images to return. Defaults to 50, + + limited to 256.' + defaultValue: '50' + types: + - + - name: skip + description: 'Number of images to skip before beginning the image + + batch. Defaults to 0.' + defaultValue: '0' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.get_tags + name: get_tags + summary: Get the tags for a given project and iteration. + signature: get_tags(project_id, iteration_id=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. Defaults to workspace. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.get_untagged_image_count + name: get_untagged_image_count + summary: 'Gets the number of untagged images. + + + This API returns the images which have no tags for a given project and + + optionally an iteration. If no iteration is specified the + + current workspace is used.' + signature: get_untagged_image_count(project_id, iteration_id=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. Defaults to workspace. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: int or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.get_untagged_images + name: get_untagged_images + summary: 'Get untagged images for a given project iteration. + + + This API supports batching and range selection. By default it will only + + return first 50 images matching images. + + Use the {take} and {skip} parameters to control how many images to + + return in a given batch.' + signature: get_untagged_images(project_id, iteration_id=None, order_by=None, take=50, + skip=0, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. Defaults to workspace. + defaultValue: None + types: + - + - name: order_by + description: 'The ordering. Defaults to newest. Possible values + + include: ''Newest'', ''Oldest''' + defaultValue: None + types: + - + - name: take + description: 'Maximum number of images to return. Defaults to 50, + + limited to 256.' + defaultValue: '50' + types: + - + - name: skip + description: 'Number of images to skip before beginning the image + + batch. Defaults to 0.' + defaultValue: '0' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.import_project + name: import_project + summary: Imports a project. + signature: import_project(token, name=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: token + description: Token generated from the export project call. + isRequired: true + types: + - + - name: name + description: 'Optional, name of the project to use instead of + + auto-generated name.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Project or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.publish_iteration + name: publish_iteration + summary: Publish a specific iteration. + signature: publish_iteration(project_id, iteration_id, publish_name, prediction_id, + overwrite=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. + isRequired: true + types: + - + - name: publish_name + description: The name to give the published iteration. + isRequired: true + types: + - + - name: prediction_id + description: The id of the prediction resource to publish to. + isRequired: true + types: + - + - name: overwrite + description: 'Whether to overwrite the published model with the + + given name (default: false).' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: bool or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.query_predictions + name: query_predictions + summary: Get images that were sent to your prediction endpoint. + signature: query_predictions(project_id, query, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: query + description: 'Parameters used to query the predictions. Limited to + + combining 2 tags.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: PredictionQueryResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.query_suggested_image_count + name: query_suggested_image_count + summary: 'Get count of images whose suggested tags match given tags and their + + probabilities are greater than or equal to the given threshold. Returns + + count as 0 if none found. + + + This API takes in tagIds to get count of untagged images per suggested + + tags for a given threshold.' + signature: query_suggested_image_count(project_id, iteration_id, tag_ids=None, threshold=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: 'IterationId to use for the suggested tags and + + regions.' + isRequired: true + types: + - + - name: tag_ids + description: 'Existing TagIds in project to get suggested tags count + + for.' + defaultValue: None + types: + - [] + - name: threshold + description: Confidence threshold to filter suggested tags on. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: dict or ClientRawResponse if raw=true + types: + - [, ] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.query_suggested_images + name: query_suggested_images + summary: 'Get untagged images whose suggested tags match given tags. Returns + + empty array if no images are found. + + + This API will fetch untagged images filtered by suggested tags Ids. It + + returns an empty array if no images are found.' + signature: query_suggested_images(project_id, iteration_id, query, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: 'IterationId to use for the suggested tags and + + regions.' + isRequired: true + types: + - + - name: query + description: Contains properties we need to query suggested images. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SuggestedTagAndRegionQuery or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.quick_test_image + name: quick_test_image + summary: Quick test an image. + signature: quick_test_image(project_id, image_data, iteration_id=None, store=True, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: image_data + description: 'Binary image data. Supported formats are JPEG, GIF, + + PNG, and BMP. Supports images up to 6MB.' + isRequired: true + types: + - + - name: iteration_id + description: 'Optional. Specifies the id of a particular + + iteration to evaluate against. + + The default iteration for the project will be used when not specified.' + defaultValue: None + types: + - + - name: store + description: 'Optional. Specifies whether or not to store the result + + of this prediction. The default is true, to store.' + defaultValue: 'True' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImagePrediction or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.quick_test_image_url + name: quick_test_image_url + summary: Quick test an image url. + signature: quick_test_image_url(project_id, url, iteration_id=None, store=True, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project to evaluate against. + isRequired: true + types: + - + - name: url + description: Url of the image. + isRequired: true + types: + - + - name: iteration_id + description: 'Optional. Specifies the id of a particular + + iteration to evaluate against. + + The default iteration for the project will be used when not specified.' + defaultValue: None + types: + - + - name: store + description: 'Optional. Specifies whether or not to store the result + + of this prediction. The default is true, to store.' + defaultValue: 'True' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImagePrediction or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.suggest_tags_and_regions + name: suggest_tags_and_regions + summary: 'Suggest tags and regions for an array/batch of untagged images. Returns + + empty array if no tags are found. + + + This API will get suggested tags and regions for an array/batch of + + untagged images along with confidences for the tags. It returns an + + empty array if no tags are found. + + There is a limit of 64 images in the batch.' + signature: suggest_tags_and_regions(project_id, iteration_id, image_ids, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: IterationId to use for tag and region suggestion. + isRequired: true + types: + - + - name: image_ids + description: 'Array of image ids tag suggestion are needed for. + + Use GetUntaggedImages API to get imageIds.' + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.train_project + name: train_project + summary: Queues project for training. + signature: train_project(project_id, training_type=None, reserved_budget_in_hours=0, + force_train=False, notification_email_address=None, selected_tags=None, custom_base_model_info=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: training_type + description: 'The type of training to use to train the project + + (default: Regular). Possible values include: ''Regular'', ''Advanced''' + defaultValue: None + types: + - + - name: reserved_budget_in_hours + description: 'The number of hours reserved as + + budget for training (if applicable).' + defaultValue: '0' + types: + - + - name: force_train + description: 'Whether to force train even if dataset and + + configuration does not change (default: false).' + defaultValue: 'False' + types: + - + - name: notification_email_address + description: 'The email address to send + + notification to when training finishes (default: null).' + defaultValue: None + types: + - + - name: selected_tags + description: 'List of tags selected for this training session, + + other tags in the project will be ignored.' + defaultValue: None + types: + - [] + - name: custom_base_model_info + description: 'Information of the previously trained + + iteration which provides the base model for current iteration''s + + training.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Iteration or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.unpublish_iteration + name: unpublish_iteration + summary: Unpublish a specific iteration. + signature: unpublish_iteration(project_id, iteration_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.update_image_metadata + name: update_image_metadata + summary: 'Update metadata of images. + + + This API accepts a batch of image Ids, and metadata, to update images. + + There is a limit of 64 images.' + signature: update_image_metadata(project_id, image_ids, metadata, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: image_ids + description: The list of image ids to update. Limited to 64. + isRequired: true + types: + - [] + - name: metadata + description: 'The metadata to be updated to the specified images. + + Limited to 10 key-value pairs per image. The length of key is limited + + to 128. The length of value is limited to 256.' + isRequired: true + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageMetadataUpdateSummary or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.update_iteration + name: update_iteration + summary: Update a specific iteration. + signature: update_iteration(project_id, iteration_id, name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: Project id. + isRequired: true + types: + - + - name: iteration_id + description: Iteration id. + isRequired: true + types: + - + - name: name + description: Gets or sets the name of the iteration. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Iteration or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.update_project + name: update_project + summary: Update a specific project. + signature: update_project(project_id, updated_project, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The id of the project to update. + isRequired: true + types: + - + - name: updated_project + description: The updated project model. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Project or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient.update_tag + name: update_tag + summary: Update a tag. + signature: update_tag(project_id, tag_id, updated_tag, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: tag_id + description: The id of the target tag. + isRequired: true + types: + - + - name: updated_tag + description: The updated tag model. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Tag or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClientConfiguration.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClientConfiguration.yml new file mode 100644 index 00000000..f77d41d6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClientConfiguration.yml @@ -0,0 +1,60 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClientConfiguration +name: CustomVisionTrainingClientConfiguration +fullName: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClientConfiguration +module: azure.cognitiveservices.vision.customvision.training +summary: 'Configuration for CustomVisionTrainingClient + + Note that all parameters used to create this instance are saved as instance + + attributes.' +constructor: + syntax: CustomVisionTrainingClientConfiguration(endpoint, credentials) + parameters: + - name: endpoint + description: Supported Cognitive Services endpoints. + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClientConfiguration.add_user_agent + name: add_user_agent + summary: Add value to current user agent with a space. + signature: 'add_user_agent(value: str) -> None' + parameters: + - name: value + description: value to add to user agent. + isRequired: true + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClientConfiguration.load + name: load + signature: load(filepath) + parameters: + - name: filepath + isRequired: true +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClientConfiguration.save + name: save + summary: Save current configuration to file. + signature: save(filepath) + parameters: + - name: filepath + description: Path to file where settings will be saved. + isRequired: true + types: + - + exceptions: + - type: ValueError if supplied filepath cannot be written to. +attributes: +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClientConfiguration.enable_http_logger + name: enable_http_logger +- uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClientConfiguration.user_agent + name: user_agent + summary: The current user agent value. diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.BoundingBox.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.BoundingBox.yml new file mode 100644 index 00000000..b068cd40 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.BoundingBox.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.BoundingBox +name: BoundingBox +fullName: azure.cognitiveservices.vision.customvision.training.models.BoundingBox +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Bounding box that defines a region of an image. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'BoundingBox(*, left: float, top: float, width: float, height: float, **kwargs)' + parameters: + - name: left + description: Required. Coordinate of the left boundary. + isRequired: true + types: + - + - name: top + description: Required. Coordinate of the top boundary. + isRequired: true + types: + - + - name: width + description: Required. Width. + isRequired: true + types: + - + - name: height + description: Required. Height. + isRequired: true + types: + - + keywordOnlyParameters: + - name: left + isRequired: true + - name: top + isRequired: true + - name: width + isRequired: true + - name: height + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.BoundingBox.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.BoundingBox.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.BoundingBox.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.BoundingBox.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.BoundingBox.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.BoundingBox.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.BoundingBox.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Classifier.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Classifier.yml new file mode 100644 index 00000000..32ee744d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Classifier.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.customvision.training.models.Classifier +name: Classifier +fullName: azure.cognitiveservices.vision.customvision.training.models.Classifier +module: azure.cognitiveservices.vision.customvision.training.models +fields: +- name: multiclass + uid: azure.cognitiveservices.vision.customvision.training.models.Classifier.multiclass +- name: multilabel + uid: azure.cognitiveservices.vision.customvision.training.models.Classifier.multilabel diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CreateProjectOptions.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CreateProjectOptions.yml new file mode 100644 index 00000000..b1ee97ef --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CreateProjectOptions.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.CreateProjectOptions +name: CreateProjectOptions +fullName: azure.cognitiveservices.vision.customvision.training.models.CreateProjectOptions +module: azure.cognitiveservices.vision.customvision.training.models +summary: Options used for createProject. +constructor: + syntax: 'CreateProjectOptions(*, export_model_container_uri: str = None, notification_queue_uri: + str = None, **kwargs)' + parameters: + - name: export_model_container_uri + description: 'The uri to the Azure Storage container + + that will be used to store exported models.' + isRequired: true + types: + - + - name: notification_queue_uri + description: 'The uri to the Azure Storage queue that + + will be used to send project-related notifications. See Storage + + notifications documentation for setup and message format.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: export_model_container_uri + isRequired: true + - name: notification_queue_uri + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.CreateProjectOptions.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.CreateProjectOptions.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.CreateProjectOptions.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.CreateProjectOptions.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.CreateProjectOptions.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.CreateProjectOptions.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.CreateProjectOptions.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CustomBaseModelInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CustomBaseModelInfo.yml new file mode 100644 index 00000000..9faa87d7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CustomBaseModelInfo.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.CustomBaseModelInfo +name: CustomBaseModelInfo +fullName: azure.cognitiveservices.vision.customvision.training.models.CustomBaseModelInfo +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'CustomBaseModelInfo. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CustomBaseModelInfo(*, project_id: str, iteration_id: str, **kwargs)' + parameters: + - name: project_id + description: 'Required. Project Id of the previously trained project + + to be used for current iteration''s training.' + isRequired: true + types: + - + - name: iteration_id + description: 'Required. Iteration Id of the previously trained + + project to be used for current iteration''s training.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: project_id + isRequired: true + - name: iteration_id + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.CustomBaseModelInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.CustomBaseModelInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.CustomBaseModelInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.CustomBaseModelInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.CustomBaseModelInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.CustomBaseModelInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.CustomBaseModelInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CustomVisionError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CustomVisionError.yml new file mode 100644 index 00000000..ece97254 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CustomVisionError.yml @@ -0,0 +1,292 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionError +name: CustomVisionError +fullName: azure.cognitiveservices.vision.customvision.training.models.CustomVisionError +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'CustomVisionError. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CustomVisionError(*, code, message: str, **kwargs)' + parameters: + - name: code + description: 'Required. The error code. Possible values include: ''NoError'', + + ''BadRequest'', ''BadRequestExceededBatchSize'', ''BadRequestNotSupported'', + + ''BadRequestInvalidIds'', ''BadRequestProjectName'', + + ''BadRequestProjectNameNotUnique'', ''BadRequestProjectDescription'', + + ''BadRequestProjectUnknownDomain'', + + ''BadRequestProjectUnknownClassification'', + + ''BadRequestProjectUnsupportedDomainTypeChange'', + + ''BadRequestProjectUnsupportedExportPlatform'', + + ''BadRequestProjectImagePreprocessingSettings'', + + ''BadRequestProjectDuplicated'', ''BadRequestIterationName'', + + ''BadRequestIterationNameNotUnique'', ''BadRequestIterationDescription'', + + ''BadRequestIterationIsNotTrained'', ''BadRequestIterationValidationFailed'', + + ''BadRequestWorkspaceCannotBeModified'', ''BadRequestWorkspaceNotDeletable'', + + ''BadRequestTagName'', ''BadRequestTagNameNotUnique'', + + ''BadRequestTagDescription'', ''BadRequestTagType'', + + ''BadRequestMultipleNegativeTag'', ''BadRequestMultipleGeneralProductTag'', + + ''BadRequestImageTags'', ''BadRequestImageRegions'', + + ''BadRequestNegativeAndRegularTagOnSameImage'', + + ''BadRequestUnsupportedDomain'', ''BadRequestRequiredParamIsNull'', + + ''BadRequestIterationIsPublished'', ''BadRequestInvalidPublishName'', + + ''BadRequestInvalidPublishTarget'', ''BadRequestUnpublishFailed'', + + ''BadRequestIterationNotPublished'', ''BadRequestSubscriptionApi'', + + ''BadRequestExceedProjectLimit'', + + ''BadRequestExceedIterationPerProjectLimit'', + + ''BadRequestExceedTagPerProjectLimit'', ''BadRequestExceedTagPerImageLimit'', + + ''BadRequestExceededQuota'', ''BadRequestCannotMigrateProjectWithName'', + + ''BadRequestNotLimitedTrial'', ''BadRequestImageBatch'', + + ''BadRequestImageStream'', ''BadRequestImageUrl'', ''BadRequestImageFormat'', + + ''BadRequestImageSizeBytes'', ''BadRequestImageDimensions'', + + ''BadRequestImageAspectRatio'', ''BadRequestImageExceededCount'', + + ''BadRequestTrainingNotNeeded'', + + ''BadRequestTrainingNotNeededButTrainingPipelineUpdated'', + + ''BadRequestTrainingValidationFailed'', + + ''BadRequestClassificationTrainingValidationFailed'', + + ''BadRequestMultiClassClassificationTrainingValidationFailed'', + + ''BadRequestMultiLabelClassificationTrainingValidationFailed'', + + ''BadRequestDetectionTrainingValidationFailed'', + + ''BadRequestTrainingAlreadyInProgress'', + + ''BadRequestDetectionTrainingNotAllowNegativeTag'', + + ''BadRequestInvalidEmailAddress'', + + ''BadRequestRetiredDomainNotSupportedForTraining'', + + ''BadRequestDomainNotSupportedForAdvancedTraining'', + + ''BadRequestExportPlatformNotSupportedForAdvancedTraining'', + + ''BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining'', + + ''BadRequestCustomBaseModelIterationStatusNotCompleted'', + + ''BadRequestCustomBaseModelDomainNotCompatible'', + + ''BadRequestCustomBaseModelArchitectureRetired'', + + ''BadRequestExportValidationFailed'', ''BadRequestExportAlreadyInProgress'', + + ''BadRequestPredictionIdsMissing'', ''BadRequestPredictionIdsExceededCount'', + + ''BadRequestPredictionTagsExceededCount'', + + ''BadRequestPredictionResultsExceededCount'', + + ''BadRequestPredictionInvalidApplicationName'', + + ''BadRequestPredictionInvalidQueryParameters'', + + ''BadRequestInvalidImportToken'', ''BadRequestExportWhileTraining'', + + ''BadRequestImageMetadataKey'', ''BadRequestImageMetadataValue'', + + ''BadRequestOperationNotSupported'', ''BadRequestInvalidArtifactUri'', + + ''BadRequestCustomerManagedKeyRevoked'', ''BadRequestInvalidUri'', + + ''BadRequestInvalid'', ''UnsupportedMediaType'', ''Forbidden'', ''ForbiddenUser'', + + ''ForbiddenUserResource'', ''ForbiddenUserSignupDisabled'', + + ''ForbiddenUserSignupAllowanceExceeded'', ''ForbiddenUserDoesNotExist'', + + ''ForbiddenUserDisabled'', ''ForbiddenUserInsufficientCapability'', + + ''ForbiddenDRModeEnabled'', ''ForbiddenInvalid'', ''NotFound'', + + ''NotFoundProject'', ''NotFoundProjectDefaultIteration'', ''NotFoundIteration'', + + ''NotFoundIterationPerformance'', ''NotFoundTag'', ''NotFoundImage'', + + ''NotFoundDomain'', ''NotFoundApimSubscription'', ''NotFoundInvalid'', + + ''Conflict'', ''ConflictInvalid'', ''ErrorUnknown'', ''ErrorIterationCopyFailed'', + + ''ErrorPreparePerformanceMigrationFailed'', ''ErrorProjectInvalidWorkspace'', + + ''ErrorProjectInvalidPipelineConfiguration'', ''ErrorProjectInvalidDomain'', + + ''ErrorProjectTrainingRequestFailed'', ''ErrorProjectImportRequestFailed'', + + ''ErrorProjectExportRequestFailed'', ''ErrorFeaturizationServiceUnavailable'', + + ''ErrorFeaturizationQueueTimeout'', ''ErrorFeaturizationInvalidFeaturizer'', + + ''ErrorFeaturizationAugmentationUnavailable'', + + ''ErrorFeaturizationUnrecognizedJob'', + + ''ErrorFeaturizationAugmentationError'', ''ErrorExporterInvalidPlatform'', + + ''ErrorExporterInvalidFeaturizer'', ''ErrorExporterInvalidClassifier'', + + ''ErrorPredictionServiceUnavailable'', ''ErrorPredictionModelNotFound'', + + ''ErrorPredictionModelNotCached'', ''ErrorPrediction'', + + ''ErrorPredictionStorage'', ''ErrorRegionProposal'', ''ErrorUnknownBaseModel'', + + ''ErrorServerTimeOut'', ''ErrorInvalid''' + isRequired: true + types: + - + - + - name: message + description: 'Required. A message explaining the error reported by the + + service.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.yml new file mode 100644 index 00000000..17a5978a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.yml @@ -0,0 +1,280 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes +name: CustomVisionErrorCodes +fullName: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes +module: azure.cognitiveservices.vision.customvision.training.models +fields: +- name: bad_request + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request +- name: bad_request_cannot_migrate_project_with_name + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_cannot_migrate_project_with_name +- name: bad_request_classification_training_validation_failed + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_classification_training_validation_failed +- name: bad_request_custom_base_model_architecture_retired + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_custom_base_model_architecture_retired +- name: bad_request_custom_base_model_domain_not_compatible + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_custom_base_model_domain_not_compatible +- name: bad_request_custom_base_model_iteration_status_not_completed + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_custom_base_model_iteration_status_not_completed +- name: bad_request_customer_managed_key_revoked + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_customer_managed_key_revoked +- name: bad_request_detection_training_not_allow_negative_tag + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_detection_training_not_allow_negative_tag +- name: bad_request_detection_training_validation_failed + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_detection_training_validation_failed +- name: bad_request_domain_not_supported_for_advanced_training + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_domain_not_supported_for_advanced_training +- name: bad_request_exceed_iteration_per_project_limit + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_exceed_iteration_per_project_limit +- name: bad_request_exceed_project_limit + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_exceed_project_limit +- name: bad_request_exceed_tag_per_image_limit + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_exceed_tag_per_image_limit +- name: bad_request_exceed_tag_per_project_limit + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_exceed_tag_per_project_limit +- name: bad_request_exceeded_batch_size + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_exceeded_batch_size +- name: bad_request_exceeded_quota + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_exceeded_quota +- name: bad_request_export_already_in_progress + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_export_already_in_progress +- name: bad_request_export_platform_not_supported_for_advanced_training + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_export_platform_not_supported_for_advanced_training +- name: bad_request_export_validation_failed + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_export_validation_failed +- name: bad_request_export_while_training + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_export_while_training +- name: bad_request_image_aspect_ratio + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_image_aspect_ratio +- name: bad_request_image_batch + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_image_batch +- name: bad_request_image_dimensions + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_image_dimensions +- name: bad_request_image_exceeded_count + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_image_exceeded_count +- name: bad_request_image_format + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_image_format +- name: bad_request_image_metadata_key + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_image_metadata_key +- name: bad_request_image_metadata_value + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_image_metadata_value +- name: bad_request_image_regions + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_image_regions +- name: bad_request_image_size_bytes + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_image_size_bytes +- name: bad_request_image_stream + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_image_stream +- name: bad_request_image_tags + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_image_tags +- name: bad_request_image_url + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_image_url +- name: bad_request_invalid + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_invalid +- name: bad_request_invalid_artifact_uri + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_invalid_artifact_uri +- name: bad_request_invalid_email_address + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_invalid_email_address +- name: bad_request_invalid_ids + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_invalid_ids +- name: bad_request_invalid_import_token + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_invalid_import_token +- name: bad_request_invalid_publish_name + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_invalid_publish_name +- name: bad_request_invalid_publish_target + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_invalid_publish_target +- name: bad_request_invalid_uri + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_invalid_uri +- name: bad_request_iteration_description + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_iteration_description +- name: bad_request_iteration_is_not_trained + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_iteration_is_not_trained +- name: bad_request_iteration_is_published + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_iteration_is_published +- name: bad_request_iteration_name + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_iteration_name +- name: bad_request_iteration_name_not_unique + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_iteration_name_not_unique +- name: bad_request_iteration_not_published + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_iteration_not_published +- name: bad_request_iteration_validation_failed + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_iteration_validation_failed +- name: bad_request_multi_class_classification_training_validation_failed + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_multi_class_classification_training_validation_failed +- name: bad_request_multi_label_classification_training_validation_failed + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_multi_label_classification_training_validation_failed +- name: bad_request_multiple_general_product_tag + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_multiple_general_product_tag +- name: bad_request_multiple_negative_tag + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_multiple_negative_tag +- name: bad_request_negative_and_regular_tag_on_same_image + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_negative_and_regular_tag_on_same_image +- name: bad_request_not_limited_trial + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_not_limited_trial +- name: bad_request_not_supported + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_not_supported +- name: bad_request_operation_not_supported + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_operation_not_supported +- name: bad_request_prediction_ids_exceeded_count + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_prediction_ids_exceeded_count +- name: bad_request_prediction_ids_missing + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_prediction_ids_missing +- name: bad_request_prediction_invalid_application_name + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_prediction_invalid_application_name +- name: bad_request_prediction_invalid_query_parameters + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_prediction_invalid_query_parameters +- name: bad_request_prediction_results_exceeded_count + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_prediction_results_exceeded_count +- name: bad_request_prediction_tags_exceeded_count + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_prediction_tags_exceeded_count +- name: bad_request_project_description + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_project_description +- name: bad_request_project_duplicated + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_project_duplicated +- name: bad_request_project_image_preprocessing_settings + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_project_image_preprocessing_settings +- name: bad_request_project_name + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_project_name +- name: bad_request_project_name_not_unique + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_project_name_not_unique +- name: bad_request_project_unknown_classification + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_project_unknown_classification +- name: bad_request_project_unknown_domain + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_project_unknown_domain +- name: bad_request_project_unsupported_domain_type_change + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_project_unsupported_domain_type_change +- name: bad_request_project_unsupported_export_platform + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_project_unsupported_export_platform +- name: bad_request_required_param_is_null + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_required_param_is_null +- name: bad_request_reserved_budget_in_hours_not_enough_for_advanced_training + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_reserved_budget_in_hours_not_enough_for_advanced_training +- name: bad_request_retired_domain_not_supported_for_training + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_retired_domain_not_supported_for_training +- name: bad_request_subscription_api + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_subscription_api +- name: bad_request_tag_description + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_tag_description +- name: bad_request_tag_name + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_tag_name +- name: bad_request_tag_name_not_unique + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_tag_name_not_unique +- name: bad_request_tag_type + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_tag_type +- name: bad_request_training_already_in_progress + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_training_already_in_progress +- name: bad_request_training_not_needed + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_training_not_needed +- name: bad_request_training_not_needed_but_training_pipeline_updated + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_training_not_needed_but_training_pipeline_updated +- name: bad_request_training_validation_failed + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_training_validation_failed +- name: bad_request_unpublish_failed + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_unpublish_failed +- name: bad_request_unsupported_domain + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_unsupported_domain +- name: bad_request_workspace_cannot_be_modified + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_workspace_cannot_be_modified +- name: bad_request_workspace_not_deletable + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.bad_request_workspace_not_deletable +- name: conflict + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.conflict +- name: conflict_invalid + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.conflict_invalid +- name: error_exporter_invalid_classifier + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_exporter_invalid_classifier +- name: error_exporter_invalid_featurizer + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_exporter_invalid_featurizer +- name: error_exporter_invalid_platform + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_exporter_invalid_platform +- name: error_featurization_augmentation_error + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_featurization_augmentation_error +- name: error_featurization_augmentation_unavailable + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_featurization_augmentation_unavailable +- name: error_featurization_invalid_featurizer + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_featurization_invalid_featurizer +- name: error_featurization_queue_timeout + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_featurization_queue_timeout +- name: error_featurization_service_unavailable + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_featurization_service_unavailable +- name: error_featurization_unrecognized_job + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_featurization_unrecognized_job +- name: error_invalid + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_invalid +- name: error_iteration_copy_failed + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_iteration_copy_failed +- name: error_prediction + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_prediction +- name: error_prediction_model_not_cached + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_prediction_model_not_cached +- name: error_prediction_model_not_found + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_prediction_model_not_found +- name: error_prediction_service_unavailable + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_prediction_service_unavailable +- name: error_prediction_storage + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_prediction_storage +- name: error_prepare_performance_migration_failed + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_prepare_performance_migration_failed +- name: error_project_export_request_failed + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_project_export_request_failed +- name: error_project_import_request_failed + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_project_import_request_failed +- name: error_project_invalid_domain + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_project_invalid_domain +- name: error_project_invalid_pipeline_configuration + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_project_invalid_pipeline_configuration +- name: error_project_invalid_workspace + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_project_invalid_workspace +- name: error_project_training_request_failed + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_project_training_request_failed +- name: error_region_proposal + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_region_proposal +- name: error_server_time_out + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_server_time_out +- name: error_unknown + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_unknown +- name: error_unknown_base_model + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.error_unknown_base_model +- name: forbidden + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.forbidden +- name: forbidden_dr_mode_enabled + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.forbidden_dr_mode_enabled +- name: forbidden_invalid + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.forbidden_invalid +- name: forbidden_user + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.forbidden_user +- name: forbidden_user_disabled + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.forbidden_user_disabled +- name: forbidden_user_does_not_exist + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.forbidden_user_does_not_exist +- name: forbidden_user_insufficient_capability + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.forbidden_user_insufficient_capability +- name: forbidden_user_resource + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.forbidden_user_resource +- name: forbidden_user_signup_allowance_exceeded + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.forbidden_user_signup_allowance_exceeded +- name: forbidden_user_signup_disabled + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.forbidden_user_signup_disabled +- name: no_error + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.no_error +- name: not_found + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.not_found +- name: not_found_apim_subscription + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.not_found_apim_subscription +- name: not_found_domain + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.not_found_domain +- name: not_found_image + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.not_found_image +- name: not_found_invalid + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.not_found_invalid +- name: not_found_iteration + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.not_found_iteration +- name: not_found_iteration_performance + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.not_found_iteration_performance +- name: not_found_project + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.not_found_project +- name: not_found_project_default_iteration + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.not_found_project_default_iteration +- name: not_found_tag + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.not_found_tag +- name: unsupported_media_type + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes.unsupported_media_type diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException.yml new file mode 100644 index 00000000..3fba1962 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +name: CustomVisionErrorException +fullName: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Server responded with exception of type: ''CustomVisionError''.' +constructor: + syntax: CustomVisionErrorException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException.args + name: args diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Domain.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Domain.yml new file mode 100644 index 00000000..030329b8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Domain.yml @@ -0,0 +1,161 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.Domain +name: Domain +fullName: azure.cognitiveservices.vision.customvision.training.models.Domain +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Domains are used as the starting point for your project. Each domain is + + optimized for specific types of images. Domains with compact in their name + + can be exported. For more information visit the domain + + documentation. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Domain(**kwargs) +variables: +- description: Domain id. + name: id + types: + - +- description: 'Name of the domain, describing the types of images used to + + train it.' + name: name + types: + - +- description: 'Domain type: Classification or ObjectDetection. Possible + + values include: ''Classification'', ''ObjectDetection''' + name: type + types: + - + - +- description: Indicating if the domain is exportable. + name: exportable + types: + - +- description: Indicating if the domain is enabled. + name: enabled + types: + - +- description: Platforms that the domain can be exported to. + name: exportable_platforms + types: + - [] +- description: Model information. + name: model_information + types: + - +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.Domain.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.Domain.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.Domain.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.Domain.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.Domain.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.Domain.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.Domain.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.DomainType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.DomainType.yml new file mode 100644 index 00000000..b98c7b3d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.DomainType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.customvision.training.models.DomainType +name: DomainType +fullName: azure.cognitiveservices.vision.customvision.training.models.DomainType +module: azure.cognitiveservices.vision.customvision.training.models +fields: +- name: classification + uid: azure.cognitiveservices.vision.customvision.training.models.DomainType.classification +- name: object_detection + uid: azure.cognitiveservices.vision.customvision.training.models.DomainType.object_detection diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Export.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Export.yml new file mode 100644 index 00000000..fa4a4856 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Export.yml @@ -0,0 +1,165 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.Export +name: Export +fullName: azure.cognitiveservices.vision.customvision.training.models.Export +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Export. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Export(**kwargs) +variables: +- description: 'Platform of the export. Possible values include: ''CoreML'', + + ''TensorFlow'', ''DockerFile'', ''ONNX'', ''VAIDK'', ''OpenVino''' + name: platform + types: + - + - +- description: 'Status of the export. Possible values include: ''Exporting'', + + ''Failed'', ''Done''' + name: status + types: + - + - +- description: 'URI used to download the model. If VNET feature is + + enabled this will be a relative path to be used with GetArtifact, + + otherwise this will be an absolute URI to the resource.' + name: download_uri + types: + - +- description: 'Flavor of the export. These are specializations of the + + export platform. + + Docker platform has valid flavors: Linux, Windows, ARM. + + Tensorflow platform has valid flavors: TensorFlowNormal, TensorFlowLite. + + ONNX platform has valid flavors: ONNX10, ONNX12. Possible values include: + + ''Linux'', ''Windows'', ''ONNX10'', ''ONNX12'', ''ARM'', ''TensorFlowNormal'', + + ''TensorFlowLite''' + name: flavor + types: + - + - +- description: 'Indicates an updated version of the export + + package is available and should be re-exported for the latest changes.' + name: newer_version_available + types: + - +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.Export.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.Export.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.Export.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.Export.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.Export.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.Export.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.Export.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ExportFlavor.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ExportFlavor.yml new file mode 100644 index 00000000..db03f7d6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ExportFlavor.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.customvision.training.models.ExportFlavor +name: ExportFlavor +fullName: azure.cognitiveservices.vision.customvision.training.models.ExportFlavor +module: azure.cognitiveservices.vision.customvision.training.models +fields: +- name: arm + uid: azure.cognitiveservices.vision.customvision.training.models.ExportFlavor.arm +- name: linux + uid: azure.cognitiveservices.vision.customvision.training.models.ExportFlavor.linux +- name: onnx10 + uid: azure.cognitiveservices.vision.customvision.training.models.ExportFlavor.onnx10 +- name: onnx12 + uid: azure.cognitiveservices.vision.customvision.training.models.ExportFlavor.onnx12 +- name: tensor_flow_lite + uid: azure.cognitiveservices.vision.customvision.training.models.ExportFlavor.tensor_flow_lite +- name: tensor_flow_normal + uid: azure.cognitiveservices.vision.customvision.training.models.ExportFlavor.tensor_flow_normal +- name: windows + uid: azure.cognitiveservices.vision.customvision.training.models.ExportFlavor.windows diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ExportPlatform.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ExportPlatform.yml new file mode 100644 index 00000000..abd8c311 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ExportPlatform.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.customvision.training.models.ExportPlatform +name: ExportPlatform +fullName: azure.cognitiveservices.vision.customvision.training.models.ExportPlatform +module: azure.cognitiveservices.vision.customvision.training.models +fields: +- name: core_ml + uid: azure.cognitiveservices.vision.customvision.training.models.ExportPlatform.core_ml +- name: docker_file + uid: azure.cognitiveservices.vision.customvision.training.models.ExportPlatform.docker_file +- name: onnx + uid: azure.cognitiveservices.vision.customvision.training.models.ExportPlatform.onnx +- name: open_vino + uid: azure.cognitiveservices.vision.customvision.training.models.ExportPlatform.open_vino +- name: tensor_flow + uid: azure.cognitiveservices.vision.customvision.training.models.ExportPlatform.tensor_flow +- name: vaidk + uid: azure.cognitiveservices.vision.customvision.training.models.ExportPlatform.vaidk diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ExportStatus.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ExportStatus.yml new file mode 100644 index 00000000..1e1097d6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ExportStatus.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.customvision.training.models.ExportStatus +name: ExportStatus +fullName: azure.cognitiveservices.vision.customvision.training.models.ExportStatus +module: azure.cognitiveservices.vision.customvision.training.models +fields: +- name: done + uid: azure.cognitiveservices.vision.customvision.training.models.ExportStatus.done +- name: exporting + uid: azure.cognitiveservices.vision.customvision.training.models.ExportStatus.exporting +- name: failed + uid: azure.cognitiveservices.vision.customvision.training.models.ExportStatus.failed diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Image.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Image.yml new file mode 100644 index 00000000..abdfcbcc --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Image.yml @@ -0,0 +1,172 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.Image +name: Image +fullName: azure.cognitiveservices.vision.customvision.training.models.Image +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Image model to be sent as JSON. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Image(**kwargs) +variables: +- description: Id of the image. + name: id + types: + - +- description: Date the image was created. + name: created + types: + - +- description: Width of the image. + name: width + types: + - +- description: Height of the image. + name: height + types: + - +- description: 'The URI to the (resized) image used for training. + + If VNET feature is enabled this will be a relative path to be used with + + GetArtifact, otherwise this will be an absolute URI to the resource.' + name: resized_image_uri + types: + - +- description: 'The URI to the thumbnail of the original image. If + + VNET feature is enabled this will be a relative path to be used with + + GetArtifact, otherwise this will be an absolute URI to the resource.' + name: thumbnail_uri + types: + - +- description: 'The URI to the original uploaded image. If VNET + + feature is enabled this will be a relative path to be used with + + GetArtifact, otherwise this will be an absolute URI to the resource.' + name: original_image_uri + types: + - +- description: Tags associated with this image. + name: tags + types: + - [] +- description: Regions associated with this image. + name: regions + types: + - [] +- description: Metadata associated with this image. + name: metadata + types: + - [, ] +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.Image.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.Image.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.Image.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.Image.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.Image.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.Image.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.Image.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageCreateResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageCreateResult.yml new file mode 100644 index 00000000..96abe830 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageCreateResult.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateResult +name: ImageCreateResult +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageCreateResult +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'ImageCreateResult. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: ImageCreateResult(**kwargs) +variables: +- description: Source URL of the image. + name: source_url + types: + - +- description: 'Status of the image creation. Possible values include: ''OK'', + + ''OKDuplicate'', ''ErrorSource'', ''ErrorImageFormat'', ''ErrorImageSize'', + + ''ErrorStorage'', ''ErrorLimitExceed'', ''ErrorTagLimitExceed'', + + ''ErrorRegionLimitExceed'', ''ErrorUnknown'', + + ''ErrorNegativeAndRegularTagOnSameImage'', ''ErrorImageDimensions'', + + ''ErrorInvalidTag''' + name: status + types: + - + - +- description: The image. + name: image + types: + - +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageCreateStatus.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageCreateStatus.yml new file mode 100644 index 00000000..84753c8f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageCreateStatus.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateStatus +name: ImageCreateStatus +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageCreateStatus +module: azure.cognitiveservices.vision.customvision.training.models +fields: +- name: error_image_dimensions + uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateStatus.error_image_dimensions +- name: error_image_format + uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateStatus.error_image_format +- name: error_image_size + uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateStatus.error_image_size +- name: error_invalid_tag + uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateStatus.error_invalid_tag +- name: error_limit_exceed + uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateStatus.error_limit_exceed +- name: error_negative_and_regular_tag_on_same_image + uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateStatus.error_negative_and_regular_tag_on_same_image +- name: error_region_limit_exceed + uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateStatus.error_region_limit_exceed +- name: error_source + uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateStatus.error_source +- name: error_storage + uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateStatus.error_storage +- name: error_tag_limit_exceed + uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateStatus.error_tag_limit_exceed +- name: error_unknown + uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateStatus.error_unknown +- name: ok + uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateStatus.ok +- name: ok_duplicate + uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateStatus.ok_duplicate diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageCreateSummary.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageCreateSummary.yml new file mode 100644 index 00000000..c9408c3f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageCreateSummary.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateSummary +name: ImageCreateSummary +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageCreateSummary +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'ImageCreateSummary. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: ImageCreateSummary(**kwargs) +variables: +- description: 'True if all of the images in the batch were + + created successfully, otherwise false.' + name: is_batch_successful + types: + - +- description: List of the image creation results. + name: images + types: + - [] +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateSummary.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateSummary.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateSummary.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateSummary.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateSummary.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateSummary.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateSummary.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateBatch.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateBatch.yml new file mode 100644 index 00000000..6658c31f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateBatch.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateBatch +name: ImageFileCreateBatch +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateBatch +module: azure.cognitiveservices.vision.customvision.training.models +summary: ImageFileCreateBatch. +constructor: + syntax: ImageFileCreateBatch(*, images=None, tag_ids=None, metadata=None, **kwargs) + parameters: + - name: images + isRequired: true + types: + - [] + - name: tag_ids + isRequired: true + types: + - [] + - name: metadata + description: 'The metadata of image. Limited to 10 key-value pairs per + + image. The length of key is limited to 128. The length of value is limited + + to 256.' + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: images + isRequired: true + - name: tag_ids + isRequired: true + - name: metadata + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateBatch.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateBatch.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateBatch.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateBatch.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateBatch.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateBatch.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateBatch.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateEntry.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateEntry.yml new file mode 100644 index 00000000..a83f9ba1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateEntry.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateEntry +name: ImageFileCreateEntry +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateEntry +module: azure.cognitiveservices.vision.customvision.training.models +summary: ImageFileCreateEntry. +constructor: + syntax: 'ImageFileCreateEntry(*, name: str = None, contents: bytearray = None, tag_ids=None, + regions=None, **kwargs)' + parameters: + - name: name + isRequired: true + types: + - + - name: contents + isRequired: true + types: + - + - name: tag_ids + isRequired: true + types: + - [] + - name: regions + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: name + isRequired: true + - name: contents + isRequired: true + - name: tag_ids + isRequired: true + - name: regions + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateEntry.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateEntry.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateEntry.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateEntry.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateEntry.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateEntry.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateEntry.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateBatch.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateBatch.yml new file mode 100644 index 00000000..0f464810 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateBatch.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateBatch +name: ImageIdCreateBatch +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateBatch +module: azure.cognitiveservices.vision.customvision.training.models +summary: ImageIdCreateBatch. +constructor: + syntax: ImageIdCreateBatch(*, images=None, tag_ids=None, metadata=None, **kwargs) + parameters: + - name: images + isRequired: true + types: + - [] + - name: tag_ids + isRequired: true + types: + - [] + - name: metadata + description: 'The metadata of image. Limited to 10 key-value pairs per + + image. The length of key is limited to 128. The length of value is limited + + to 256.' + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: images + isRequired: true + - name: tag_ids + isRequired: true + - name: metadata + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateBatch.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateBatch.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateBatch.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateBatch.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateBatch.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateBatch.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateBatch.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateEntry.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateEntry.yml new file mode 100644 index 00000000..514d892e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateEntry.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateEntry +name: ImageIdCreateEntry +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateEntry +module: azure.cognitiveservices.vision.customvision.training.models +summary: ImageIdCreateEntry. +constructor: + syntax: 'ImageIdCreateEntry(*, id: str = None, tag_ids=None, regions=None, **kwargs)' + parameters: + - name: id + description: Id of the image. + isRequired: true + types: + - + - name: tag_ids + isRequired: true + types: + - [] + - name: regions + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: tag_ids + isRequired: true + - name: regions + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateEntry.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateEntry.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateEntry.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateEntry.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateEntry.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateEntry.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateEntry.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateEntry.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateEntry.yml new file mode 100644 index 00000000..e6cdcf24 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateEntry.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateEntry +name: ImageMetadataUpdateEntry +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateEntry +module: azure.cognitiveservices.vision.customvision.training.models +summary: Entry associating a metadata to an image. +constructor: + syntax: 'ImageMetadataUpdateEntry(*, image_id: str = None, status=None, metadata=None, + **kwargs)' + parameters: + - name: image_id + description: Id of the image. + isRequired: true + types: + - + - name: status + description: 'Status of the metadata update. Possible values include: + + ''OK'', ''ErrorImageNotFound'', ''ErrorLimitExceed'', ''ErrorUnknown''' + isRequired: true + types: + - + - + - name: metadata + description: Metadata of the image. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: image_id + isRequired: true + - name: status + isRequired: true + - name: metadata + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateEntry.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateEntry.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateEntry.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateEntry.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateEntry.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateEntry.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateEntry.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateStatus.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateStatus.yml new file mode 100644 index 00000000..fdde7585 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateStatus.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateStatus +name: ImageMetadataUpdateStatus +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateStatus +module: azure.cognitiveservices.vision.customvision.training.models +fields: +- name: error_image_not_found + uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateStatus.error_image_not_found +- name: error_limit_exceed + uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateStatus.error_limit_exceed +- name: error_unknown + uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateStatus.error_unknown +- name: ok + uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateStatus.ok diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateSummary.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateSummary.yml new file mode 100644 index 00000000..d01e4b9f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateSummary.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateSummary +name: ImageMetadataUpdateSummary +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateSummary +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'ImageMetadataUpdateSummary. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: ImageMetadataUpdateSummary(**kwargs) +variables: +- name: is_batch_successful + types: + - +- name: images + types: + - [] +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateSummary.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateSummary.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateSummary.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateSummary.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateSummary.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateSummary.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateSummary.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImagePerformance.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImagePerformance.yml new file mode 100644 index 00000000..c19e2f69 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImagePerformance.yml @@ -0,0 +1,163 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImagePerformance +name: ImagePerformance +fullName: azure.cognitiveservices.vision.customvision.training.models.ImagePerformance +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Image performance model. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: ImagePerformance(**kwargs) +variables: +- name: predictions + types: + - [] +- description: Id of the image. + name: id + types: + - +- description: Date the image was created. + name: created + types: + - +- description: Width of the image. + name: width + types: + - +- description: Height of the image. + name: height + types: + - +- description: 'The URI to the image used for training. If VNET feature + + is enabled this will be a relative path to be used with GetArtifact, + + otherwise this will be an absolute URI to the resource.' + name: image_uri + types: + - +- description: 'The URI to the thumbnail of the original image. If + + VNET feature is enabled this will be a relative path to be used with + + GetArtifact, otherwise this will be an absolute URI to the resource.' + name: thumbnail_uri + types: + - +- description: Tags associated with this image. + name: tags + types: + - [] +- description: Regions associated with this image. + name: regions + types: + - [] +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImagePerformance.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImagePerformance.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImagePerformance.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImagePerformance.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImagePerformance.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImagePerformance.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImagePerformance.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImagePrediction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImagePrediction.yml new file mode 100644 index 00000000..66115152 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImagePrediction.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImagePrediction +name: ImagePrediction +fullName: azure.cognitiveservices.vision.customvision.training.models.ImagePrediction +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Result of an image prediction request. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: ImagePrediction(**kwargs) +variables: +- description: Prediction Id. + name: id + types: + - +- description: Project Id. + name: project + types: + - +- description: Iteration Id. + name: iteration + types: + - +- description: Date this prediction was created. + name: created + types: + - +- description: List of predictions. + name: predictions + types: + - [] +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImagePrediction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImagePrediction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImagePrediction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImagePrediction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImagePrediction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImagePrediction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImagePrediction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageProcessingSettings.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageProcessingSettings.yml new file mode 100644 index 00000000..9a030eca --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageProcessingSettings.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImageProcessingSettings +name: ImageProcessingSettings +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageProcessingSettings +module: azure.cognitiveservices.vision.customvision.training.models +summary: Represents image preprocessing settings used by image augmentation. +constructor: + syntax: ImageProcessingSettings(*, augmentation_methods=None, **kwargs) + parameters: + - name: augmentation_methods + description: 'Gets or sets enabled image transforms. The + + key corresponds to the transform name. If value is set to true, then + + correspondent transform is enabled. Otherwise this transform will not be + + used. + + Augmentation will be uniformly distributed among enabled transforms.' + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: augmentation_methods + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageProcessingSettings.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageProcessingSettings.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageProcessingSettings.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageProcessingSettings.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageProcessingSettings.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageProcessingSettings.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageProcessingSettings.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegion.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegion.yml new file mode 100644 index 00000000..d4c84970 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegion.yml @@ -0,0 +1,170 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegion +name: ImageRegion +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageRegion +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'ImageRegion. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ImageRegion(*, tag_id: str, left: float, top: float, width: float, height: + float, **kwargs)' + parameters: + - name: tag_id + description: Required. Id of the tag associated with this region. + isRequired: true + types: + - + - name: left + description: Required. Coordinate of the left boundary. + isRequired: true + types: + - + - name: top + description: Required. Coordinate of the top boundary. + isRequired: true + types: + - + - name: width + description: Required. Width. + isRequired: true + types: + - + - name: height + description: Required. Height. + isRequired: true + types: + - + keywordOnlyParameters: + - name: tag_id + isRequired: true + - name: left + isRequired: true + - name: top + isRequired: true + - name: width + isRequired: true + - name: height + isRequired: true +variables: +- name: region_id + types: + - +- name: tag_name + types: + - +- name: created + types: + - +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegion.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegion.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegion.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegion.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegion.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegion.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegion.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateBatch.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateBatch.yml new file mode 100644 index 00000000..ff421198 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateBatch.yml @@ -0,0 +1,122 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateBatch +name: ImageRegionCreateBatch +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateBatch +module: azure.cognitiveservices.vision.customvision.training.models +summary: Batch of image region information to create. +constructor: + syntax: ImageRegionCreateBatch(*, regions=None, **kwargs) + parameters: + - name: regions + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: regions + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateBatch.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateBatch.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateBatch.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateBatch.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateBatch.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateBatch.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateBatch.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateEntry.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateEntry.yml new file mode 100644 index 00000000..13e4e68a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateEntry.yml @@ -0,0 +1,162 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateEntry +name: ImageRegionCreateEntry +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateEntry +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Entry associating a region to an image. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ImageRegionCreateEntry(*, image_id: str, tag_id: str, left: float, top: + float, width: float, height: float, **kwargs)' + parameters: + - name: image_id + description: Required. Id of the image. + isRequired: true + types: + - + - name: tag_id + description: Required. Id of the tag associated with this region. + isRequired: true + types: + - + - name: left + description: Required. Coordinate of the left boundary. + isRequired: true + types: + - + - name: top + description: Required. Coordinate of the top boundary. + isRequired: true + types: + - + - name: width + description: Required. Width. + isRequired: true + types: + - + - name: height + description: Required. Height. + isRequired: true + types: + - + keywordOnlyParameters: + - name: image_id + isRequired: true + - name: tag_id + isRequired: true + - name: left + isRequired: true + - name: top + isRequired: true + - name: width + isRequired: true + - name: height + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateEntry.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateEntry.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateEntry.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateEntry.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateEntry.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateEntry.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateEntry.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateResult.yml new file mode 100644 index 00000000..e24f5bf7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateResult.yml @@ -0,0 +1,173 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateResult +name: ImageRegionCreateResult +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateResult +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'ImageRegionCreateResult. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ImageRegionCreateResult(*, tag_id: str, left: float, top: float, width: + float, height: float, **kwargs)' + parameters: + - name: tag_id + description: Required. Id of the tag associated with this region. + isRequired: true + types: + - + - name: left + description: Required. Coordinate of the left boundary. + isRequired: true + types: + - + - name: top + description: Required. Coordinate of the top boundary. + isRequired: true + types: + - + - name: width + description: Required. Width. + isRequired: true + types: + - + - name: height + description: Required. Height. + isRequired: true + types: + - + keywordOnlyParameters: + - name: tag_id + isRequired: true + - name: left + isRequired: true + - name: top + isRequired: true + - name: width + isRequired: true + - name: height + isRequired: true +variables: +- name: image_id + types: + - +- name: region_id + types: + - +- name: tag_name + types: + - +- name: created + types: + - +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateSummary.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateSummary.yml new file mode 100644 index 00000000..f82d83c4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateSummary.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateSummary +name: ImageRegionCreateSummary +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateSummary +module: azure.cognitiveservices.vision.customvision.training.models +summary: ImageRegionCreateSummary. +constructor: + syntax: ImageRegionCreateSummary(*, created=None, duplicated=None, exceeded=None, + **kwargs) + parameters: + - name: created + isRequired: true + types: + - [] + - name: duplicated + isRequired: true + types: + - [] + - name: exceeded + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: created + isRequired: true + - name: duplicated + isRequired: true + - name: exceeded + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateSummary.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateSummary.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateSummary.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateSummary.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateSummary.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateSummary.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateSummary.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionProposal.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionProposal.yml new file mode 100644 index 00000000..ecb684c0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionProposal.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionProposal +name: ImageRegionProposal +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageRegionProposal +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'ImageRegionProposal. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: ImageRegionProposal(**kwargs) +variables: +- name: project_id + types: + - +- name: image_id + types: + - +- name: proposals + types: + - [] +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionProposal.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionProposal.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionProposal.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionProposal.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionProposal.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionProposal.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionProposal.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTag.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTag.yml new file mode 100644 index 00000000..2cccd10e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTag.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImageTag +name: ImageTag +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageTag +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'ImageTag. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: ImageTag(**kwargs) +variables: +- name: tag_id + types: + - +- name: tag_name + types: + - +- name: created + types: + - +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTag.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTag.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTag.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTag.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTag.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTag.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTag.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateBatch.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateBatch.yml new file mode 100644 index 00000000..3ec8024e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateBatch.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateBatch +name: ImageTagCreateBatch +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateBatch +module: azure.cognitiveservices.vision.customvision.training.models +summary: Batch of image tags. +constructor: + syntax: ImageTagCreateBatch(*, tags=None, **kwargs) + parameters: + - name: tags + description: Image Tag entries to include in this batch. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: tags + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateBatch.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateBatch.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateBatch.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateBatch.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateBatch.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateBatch.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateBatch.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateEntry.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateEntry.yml new file mode 100644 index 00000000..e8bcf7fa --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateEntry.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateEntry +name: ImageTagCreateEntry +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateEntry +module: azure.cognitiveservices.vision.customvision.training.models +summary: Entry associating a tag to an image. +constructor: + syntax: 'ImageTagCreateEntry(*, image_id: str = None, tag_id: str = None, **kwargs)' + parameters: + - name: image_id + description: Id of the image. + isRequired: true + types: + - + - name: tag_id + description: Id of the tag. + isRequired: true + types: + - + keywordOnlyParameters: + - name: image_id + isRequired: true + - name: tag_id + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateEntry.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateEntry.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateEntry.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateEntry.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateEntry.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateEntry.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateEntry.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateSummary.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateSummary.yml new file mode 100644 index 00000000..868ea551 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateSummary.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateSummary +name: ImageTagCreateSummary +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateSummary +module: azure.cognitiveservices.vision.customvision.training.models +summary: ImageTagCreateSummary. +constructor: + syntax: ImageTagCreateSummary(*, created=None, duplicated=None, exceeded=None, **kwargs) + parameters: + - name: created + isRequired: true + types: + - [] + - name: duplicated + isRequired: true + types: + - [] + - name: exceeded + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: created + isRequired: true + - name: duplicated + isRequired: true + - name: exceeded + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateSummary.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateSummary.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateSummary.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateSummary.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateSummary.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateSummary.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateSummary.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageUrl.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageUrl.yml new file mode 100644 index 00000000..1c7f629a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageUrl.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrl +name: ImageUrl +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageUrl +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Image url. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ImageUrl(*, url: str, **kwargs)' + parameters: + - name: url + description: Required. Url of the image. + isRequired: true + types: + - + keywordOnlyParameters: + - name: url + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrl.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrl.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrl.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrl.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrl.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrl.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrl.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateBatch.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateBatch.yml new file mode 100644 index 00000000..907bd4e0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateBatch.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateBatch +name: ImageUrlCreateBatch +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateBatch +module: azure.cognitiveservices.vision.customvision.training.models +summary: ImageUrlCreateBatch. +constructor: + syntax: ImageUrlCreateBatch(*, images=None, tag_ids=None, metadata=None, **kwargs) + parameters: + - name: images + isRequired: true + types: + - [] + - name: tag_ids + isRequired: true + types: + - [] + - name: metadata + description: 'The metadata of image. Limited to 10 key-value pairs per + + image. The length of key is limited to 128. The length of value is limited + + to 256.' + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: images + isRequired: true + - name: tag_ids + isRequired: true + - name: metadata + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateBatch.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateBatch.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateBatch.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateBatch.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateBatch.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateBatch.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateBatch.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateEntry.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateEntry.yml new file mode 100644 index 00000000..d3720fc6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateEntry.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateEntry +name: ImageUrlCreateEntry +fullName: azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateEntry +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'ImageUrlCreateEntry. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ImageUrlCreateEntry(*, url: str, tag_ids=None, regions=None, **kwargs)' + parameters: + - name: url + description: Required. Url of the image. + isRequired: true + types: + - + - name: tag_ids + isRequired: true + types: + - [] + - name: regions + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: url + isRequired: true + - name: tag_ids + isRequired: true + - name: regions + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateEntry.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateEntry.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateEntry.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateEntry.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateEntry.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateEntry.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateEntry.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Iteration.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Iteration.yml new file mode 100644 index 00000000..6ace1f0e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Iteration.yml @@ -0,0 +1,222 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.Iteration +name: Iteration +fullName: azure.cognitiveservices.vision.customvision.training.models.Iteration +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Iteration model to be sent over JSON. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Iteration(*, name: str, **kwargs)' + parameters: + - name: name + description: Required. Gets or sets the name of the iteration. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true +variables: +- description: Gets the id of the iteration. + name: id + types: + - +- description: Gets the current iteration status. + name: status + types: + - +- description: Gets the time this iteration was completed. + name: created + types: + - +- description: Gets the time this iteration was last modified. + name: last_modified + types: + - +- description: Gets the time this iteration was last modified. + name: trained_at + types: + - +- description: Gets the project id of the iteration. + name: project_id + types: + - +- description: 'Whether the iteration can be exported to another format + + for download.' + name: exportable + types: + - +- description: A set of platforms this iteration can export to. + name: exportable_to + types: + - [] +- description: 'Get or sets a guid of the domain the iteration has been + + trained on.' + name: domain_id + types: + - +- description: 'Gets the classification type of the project. + + Possible values include: ''Multiclass'', ''Multilabel''' + name: classification_type + types: + - + - +- description: 'Gets the training type of the iteration. Possible + + values include: ''Regular'', ''Advanced''' + name: training_type + types: + - + - +- description: 'Gets the reserved advanced training budget + + for the iteration.' + name: reserved_budget_in_hours + types: + - +- description: Gets the training time for the iteration. + name: training_time_in_minutes + types: + - +- description: Name of the published model. + name: publish_name + types: + - +- description: 'Resource Provider Id this iteration + + was originally published to.' + name: original_publish_resource_id + types: + - +- description: 'Information of the previously trained + + iteration which provides the base model for current iteration''s training. + + Default value of null specifies that no previously trained iteration will + + be used for incremental learning.' + name: custom_base_model_info + types: + - +- description: 'Training error details, when training fails. + + Value is null when training succeeds.' + name: training_error_details + types: + - +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.Iteration.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.Iteration.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.Iteration.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.Iteration.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.Iteration.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.Iteration.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.Iteration.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.IterationPerformance.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.IterationPerformance.yml new file mode 100644 index 00000000..d0e54a5e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.IterationPerformance.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.IterationPerformance +name: IterationPerformance +fullName: azure.cognitiveservices.vision.customvision.training.models.IterationPerformance +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Represents the detailed performance data for a trained iteration. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: IterationPerformance(**kwargs) +variables: +- description: 'Gets the per-tag performance details for this + + iteration.' + name: per_tag_performance + types: + - [] +- description: Gets the precision. + name: precision + types: + - +- description: 'Gets the standard deviation for the + + precision.' + name: precision_std_deviation + types: + - +- description: Gets the recall. + name: recall + types: + - +- description: Gets the standard deviation for the recall. + name: recall_std_deviation + types: + - +- description: Gets the average precision when applicable. + name: average_precision + types: + - +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.IterationPerformance.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.IterationPerformance.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.IterationPerformance.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.IterationPerformance.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.IterationPerformance.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.IterationPerformance.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.IterationPerformance.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ModelInformation.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ModelInformation.yml new file mode 100644 index 00000000..090ab4b2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ModelInformation.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ModelInformation +name: ModelInformation +fullName: azure.cognitiveservices.vision.customvision.training.models.ModelInformation +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Model information. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ModelInformation(*, description: str, estimated_model_size_in_megabytes: + int = None, **kwargs)' + parameters: + - name: estimated_model_size_in_megabytes + description: 'Estimation of the exported FP32 + + Onnx model size (2 tags) in megabytes. This information is not present if + + the model cannot be exported.' + isRequired: true + types: + - + - name: description + description: Required. Model description. + isRequired: true + types: + - + keywordOnlyParameters: + - name: description + isRequired: true + - name: estimated_model_size_in_megabytes + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ModelInformation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ModelInformation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ModelInformation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ModelInformation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ModelInformation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ModelInformation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ModelInformation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.OrderBy.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.OrderBy.yml new file mode 100644 index 00000000..81cd601c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.OrderBy.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.customvision.training.models.OrderBy +name: OrderBy +fullName: azure.cognitiveservices.vision.customvision.training.models.OrderBy +module: azure.cognitiveservices.vision.customvision.training.models +fields: +- name: newest + uid: azure.cognitiveservices.vision.customvision.training.models.OrderBy.newest +- name: oldest + uid: azure.cognitiveservices.vision.customvision.training.models.OrderBy.oldest +- name: suggested + uid: azure.cognitiveservices.vision.customvision.training.models.OrderBy.suggested diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Prediction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Prediction.yml new file mode 100644 index 00000000..90828601 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Prediction.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.Prediction +name: Prediction +fullName: azure.cognitiveservices.vision.customvision.training.models.Prediction +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Prediction result. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Prediction(**kwargs) +variables: +- description: Probability of the tag. + name: probability + types: + - +- description: Id of the predicted tag. + name: tag_id + types: + - +- description: Name of the predicted tag. + name: tag_name + types: + - +- description: Bounding box of the prediction. + name: bounding_box + types: + - +- description: 'Type of the predicted tag. Possible values include: + + ''Regular'', ''Negative'', ''GeneralProduct''' + name: tag_type + types: + - + - +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.Prediction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.Prediction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.Prediction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.Prediction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.Prediction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.Prediction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.Prediction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryResult.yml new file mode 100644 index 00000000..1a0d858a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryResult.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryResult +name: PredictionQueryResult +fullName: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryResult +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Query result of the prediction images that were sent to your prediction + + endpoint. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: PredictionQueryResult(*, token=None, **kwargs) + parameters: + - name: token + description: Prediction Query Token. + isRequired: true + types: + - + keywordOnlyParameters: + - name: token + isRequired: true +variables: +- description: Result of an image prediction request. + name: results + types: + - [] +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryTag.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryTag.yml new file mode 100644 index 00000000..c9093e07 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryTag.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryTag +name: PredictionQueryTag +fullName: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryTag +module: azure.cognitiveservices.vision.customvision.training.models +summary: PredictionQueryTag. +constructor: + syntax: 'PredictionQueryTag(*, id: str = None, min_threshold: float = None, max_threshold: + float = None, **kwargs)' + parameters: + - name: id + isRequired: true + types: + - + - name: min_threshold + isRequired: true + types: + - + - name: max_threshold + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: min_threshold + isRequired: true + - name: max_threshold + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryTag.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryTag.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryTag.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryTag.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryTag.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryTag.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryTag.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryToken.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryToken.yml new file mode 100644 index 00000000..fe72b08f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryToken.yml @@ -0,0 +1,174 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryToken +name: PredictionQueryToken +fullName: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryToken +module: azure.cognitiveservices.vision.customvision.training.models +summary: PredictionQueryToken. +constructor: + syntax: 'PredictionQueryToken(*, session: str = None, continuation: str = None, + max_count: int = None, order_by=None, tags=None, iteration_id: str = None, start_time=None, + end_time=None, application: str = None, **kwargs)' + parameters: + - name: session + isRequired: true + types: + - + - name: continuation + isRequired: true + types: + - + - name: max_count + isRequired: true + types: + - + - name: order_by + description: 'Possible values include: ''Newest'', ''Oldest'', ''Suggested''' + isRequired: true + types: + - + - + - name: tags + isRequired: true + types: + - [] + - name: iteration_id + isRequired: true + types: + - + - name: start_time + isRequired: true + types: + - + - name: end_time + isRequired: true + types: + - + - name: application + isRequired: true + types: + - + keywordOnlyParameters: + - name: session + isRequired: true + - name: continuation + isRequired: true + - name: max_count + isRequired: true + - name: order_by + isRequired: true + - name: tags + isRequired: true + - name: iteration_id + isRequired: true + - name: start_time + isRequired: true + - name: end_time + isRequired: true + - name: application + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryToken.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryToken.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryToken.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryToken.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryToken.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryToken.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryToken.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Project.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Project.yml new file mode 100644 index 00000000..94f39d01 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Project.yml @@ -0,0 +1,182 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.Project +name: Project +fullName: azure.cognitiveservices.vision.customvision.training.models.Project +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Represents a project. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Project(*, name: str, description: str, settings, status=None, **kwargs)' + parameters: + - name: name + description: Required. Gets or sets the name of the project. + isRequired: true + types: + - + - name: description + description: Required. Gets or sets the description of the project. + isRequired: true + types: + - + - name: settings + description: Required. Gets or sets the project settings. + isRequired: true + types: + - + - name: status + description: 'Gets the status of the project. Possible values include: + + ''Succeeded'', ''Importing'', ''Failed''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: description + isRequired: true + - name: settings + isRequired: true + - name: status + isRequired: true +variables: +- description: Gets the project id. + name: id + types: + - +- description: Gets the date this project was created. + name: created + types: + - +- description: Gets the date this project was last modified. + name: last_modified + types: + - +- description: 'Gets the thumbnail url representing the image. If + + VNET feature is enabled this will be a relative path to be used with + + GetArtifact, otherwise this will be an absolute URI to the resource.' + name: thumbnail_uri + types: + - +- description: 'Gets if the Disaster Recovery (DR) mode is on, + + indicating the project is temporarily read-only.' + name: dr_mode_enabled + types: + - +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.Project.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.Project.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.Project.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.Project.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.Project.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.Project.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.Project.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ProjectExport.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ProjectExport.yml new file mode 100644 index 00000000..c72f0d59 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ProjectExport.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ProjectExport +name: ProjectExport +fullName: azure.cognitiveservices.vision.customvision.training.models.ProjectExport +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Represents information about a project export. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: ProjectExport(**kwargs) +variables: +- description: Count of iterations that will be exported. + name: iteration_count + types: + - +- description: Count of images that will be exported. + name: image_count + types: + - +- description: Count of tags that will be exported. + name: tag_count + types: + - +- description: Count of regions that will be exported. + name: region_count + types: + - +- description: 'Estimated time this project will take + + to import, can change based on network connectivity and load between + + source and destination regions.' + name: estimated_import_time_in_ms + types: + - +- description: 'Opaque token that should be passed to ImportProject to + + perform the import. This token grants access to import this + + project to all that have the token.' + name: token + types: + - +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ProjectExport.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ProjectExport.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ProjectExport.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ProjectExport.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ProjectExport.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ProjectExport.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ProjectExport.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ProjectSettings.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ProjectSettings.yml new file mode 100644 index 00000000..f5725a1b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ProjectSettings.yml @@ -0,0 +1,184 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.ProjectSettings +name: ProjectSettings +fullName: azure.cognitiveservices.vision.customvision.training.models.ProjectSettings +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Represents settings associated with a project. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'ProjectSettings(*, domain_id: str = None, classification_type=None, target_export_platforms=None, + image_processing_settings=None, **kwargs)' + parameters: + - name: domain_id + description: 'Gets or sets the id of the Domain to use with this + + project.' + isRequired: true + types: + - + - name: classification_type + description: 'Gets or sets the classification type of the + + project. Possible values include: ''Multiclass'', ''Multilabel''' + isRequired: true + types: + - + - + - name: target_export_platforms + description: 'A list of ExportPlatform that the trained + + model should be able to support.' + isRequired: true + types: + - [] + - name: image_processing_settings + description: 'Gets or sets image preprocessing + + settings.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: domain_id + isRequired: true + - name: classification_type + isRequired: true + - name: target_export_platforms + isRequired: true + - name: image_processing_settings + isRequired: true +variables: +- description: Indicates if negative set is being used. + name: use_negative_set + types: + - +- description: Detection parameters in use, if any. + name: detection_parameters + types: + - +- description: 'The uri to the Azure Storage container + + that will be used to store exported models.' + name: export_model_container_uri + types: + - +- description: 'The uri to the Azure Storage queue that will + + be used to send project-related notifications. See Storage + + notifications documentation for setup and message format.' + name: notification_queue_uri + types: + - +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.ProjectSettings.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ProjectSettings.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ProjectSettings.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.ProjectSettings.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.ProjectSettings.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.ProjectSettings.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.ProjectSettings.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ProjectStatus.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ProjectStatus.yml new file mode 100644 index 00000000..0cced459 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ProjectStatus.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.customvision.training.models.ProjectStatus +name: ProjectStatus +fullName: azure.cognitiveservices.vision.customvision.training.models.ProjectStatus +module: azure.cognitiveservices.vision.customvision.training.models +fields: +- name: failed + uid: azure.cognitiveservices.vision.customvision.training.models.ProjectStatus.failed +- name: importing + uid: azure.cognitiveservices.vision.customvision.training.models.ProjectStatus.importing +- name: succeeded + uid: azure.cognitiveservices.vision.customvision.training.models.ProjectStatus.succeeded diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Region.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Region.yml new file mode 100644 index 00000000..05527bc2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Region.yml @@ -0,0 +1,155 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.Region +name: Region +fullName: azure.cognitiveservices.vision.customvision.training.models.Region +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Region. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Region(*, tag_id: str, left: float, top: float, width: float, height: float, + **kwargs)' + parameters: + - name: tag_id + description: Required. Id of the tag associated with this region. + isRequired: true + types: + - + - name: left + description: Required. Coordinate of the left boundary. + isRequired: true + types: + - + - name: top + description: Required. Coordinate of the top boundary. + isRequired: true + types: + - + - name: width + description: Required. Width. + isRequired: true + types: + - + - name: height + description: Required. Height. + isRequired: true + types: + - + keywordOnlyParameters: + - name: tag_id + isRequired: true + - name: left + isRequired: true + - name: top + isRequired: true + - name: width + isRequired: true + - name: height + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.Region.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.Region.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.Region.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.Region.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.Region.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.Region.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.Region.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.RegionProposal.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.RegionProposal.yml new file mode 100644 index 00000000..c2f967c5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.RegionProposal.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.RegionProposal +name: RegionProposal +fullName: azure.cognitiveservices.vision.customvision.training.models.RegionProposal +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'RegionProposal. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: RegionProposal(**kwargs) +variables: +- name: confidence + types: + - +- name: bounding_box + types: + - +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.RegionProposal.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.RegionProposal.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.RegionProposal.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.RegionProposal.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.RegionProposal.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.RegionProposal.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.RegionProposal.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SortBy.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SortBy.yml new file mode 100644 index 00000000..a9d05e8d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SortBy.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.customvision.training.models.SortBy +name: SortBy +fullName: azure.cognitiveservices.vision.customvision.training.models.SortBy +module: azure.cognitiveservices.vision.customvision.training.models +fields: +- name: uncertainty_ascending + uid: azure.cognitiveservices.vision.customvision.training.models.SortBy.uncertainty_ascending +- name: uncertainty_descending + uid: azure.cognitiveservices.vision.customvision.training.models.SortBy.uncertainty_descending diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.StoredImagePrediction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.StoredImagePrediction.yml new file mode 100644 index 00000000..d934fffc --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.StoredImagePrediction.yml @@ -0,0 +1,168 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.StoredImagePrediction +name: StoredImagePrediction +fullName: azure.cognitiveservices.vision.customvision.training.models.StoredImagePrediction +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Result of an image prediction request. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: StoredImagePrediction(**kwargs) +variables: +- description: 'The URI to the (resized) prediction image. If + + VNET feature is enabled this will be a relative path to be used with + + GetArtifact, otherwise this will be an absolute URI to the resource.' + name: resized_image_uri + types: + - +- description: 'The URI to the thumbnail of the original prediction + + image. If VNET feature is enabled this will be a relative path to be used + + with GetArtifact, otherwise this will be an absolute URI to the resource.' + name: thumbnail_uri + types: + - +- description: 'The URI to the original prediction image. If + + VNET feature is enabled this will be a relative path to be used with + + GetArtifact, otherwise this will be an absolute URI to the resource.' + name: original_image_uri + types: + - +- description: Domain used for the prediction. + name: domain + types: + - +- description: Prediction Id. + name: id + types: + - +- description: Project Id. + name: project + types: + - +- description: Iteration Id. + name: iteration + types: + - +- description: Date this prediction was created. + name: created + types: + - +- description: List of predictions. + name: predictions + types: + - [] +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.StoredImagePrediction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.StoredImagePrediction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.StoredImagePrediction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.StoredImagePrediction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.StoredImagePrediction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.StoredImagePrediction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.StoredImagePrediction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.StoredSuggestedTagAndRegion.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.StoredSuggestedTagAndRegion.yml new file mode 100644 index 00000000..a611268a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.StoredSuggestedTagAndRegion.yml @@ -0,0 +1,182 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.StoredSuggestedTagAndRegion +name: StoredSuggestedTagAndRegion +fullName: azure.cognitiveservices.vision.customvision.training.models.StoredSuggestedTagAndRegion +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Result of a suggested tags and regions request of the untagged image. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: StoredSuggestedTagAndRegion(**kwargs) +variables: +- description: Width of the resized image. + name: width + types: + - +- description: Height of the resized image. + name: height + types: + - +- description: 'The URI to the (resized) prediction image. If + + VNET feature is enabled this will be a relative path to be used with + + GetArtifact, otherwise this will be an absolute URI to the resource.' + name: resized_image_uri + types: + - +- description: 'The URI to the thumbnail of the original prediction + + image. If VNET feature is enabled this will be a relative path to be used + + with GetArtifact, otherwise this will be an absolute URI to the resource.' + name: thumbnail_uri + types: + - +- description: 'The URI to the original prediction image. If + + VNET feature is enabled this will be a relative path to be used with + + GetArtifact, otherwise this will be an absolute URI to the resource.' + name: original_image_uri + types: + - +- description: Domain used for the prediction. + name: domain + types: + - +- description: Prediction Id. + name: id + types: + - +- description: Project Id. + name: project + types: + - +- description: Iteration Id. + name: iteration + types: + - +- description: Date this prediction was created. + name: created + types: + - +- description: List of predictions. + name: predictions + types: + - [] +- description: 'Uncertainty (entropy) of suggested tags or + + regions per image.' + name: prediction_uncertainty + types: + - +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.StoredSuggestedTagAndRegion.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.StoredSuggestedTagAndRegion.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.StoredSuggestedTagAndRegion.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.StoredSuggestedTagAndRegion.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.StoredSuggestedTagAndRegion.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.StoredSuggestedTagAndRegion.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.StoredSuggestedTagAndRegion.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegion.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegion.yml new file mode 100644 index 00000000..326d8ba8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegion.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegion +name: SuggestedTagAndRegion +fullName: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegion +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Result of a suggested tags and regions request. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SuggestedTagAndRegion(**kwargs) +variables: +- description: Prediction Id. + name: id + types: + - +- description: Project Id. + name: project + types: + - +- description: Iteration Id. + name: iteration + types: + - +- description: Date this prediction was created. + name: created + types: + - +- description: List of predictions. + name: predictions + types: + - [] +- description: 'Uncertainty (entropy) of suggested tags or + + regions per image.' + name: prediction_uncertainty + types: + - +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegion.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegion.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegion.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegion.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegion.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegion.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegion.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQuery.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQuery.yml new file mode 100644 index 00000000..2ba15854 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQuery.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQuery +name: SuggestedTagAndRegionQuery +fullName: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQuery +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'The array of result images and token containing session and continuation + + Ids for the next query. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SuggestedTagAndRegionQuery(*, token=None, **kwargs) + parameters: + - name: token + description: Contains properties we need to fetch suggested tags for. + isRequired: true + types: + - + keywordOnlyParameters: + - name: token + isRequired: true +variables: +- description: 'Result of a suggested tags and regions request of the + + untagged image.' + name: results + types: + - [] +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQuery.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQuery.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQuery.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQuery.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQuery.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQuery.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQuery.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQueryToken.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQueryToken.yml new file mode 100644 index 00000000..51d5fbec --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQueryToken.yml @@ -0,0 +1,175 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQueryToken +name: SuggestedTagAndRegionQueryToken +fullName: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQueryToken +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Contains properties we need to fetch suggested tags for. For the first + + call, Session and continuation set to null. + + Then on subsequent calls, uses the session/continuation from the previous + + SuggestedTagAndRegionQuery result to fetch additional results.' +constructor: + syntax: 'SuggestedTagAndRegionQueryToken(*, tag_ids=None, threshold: float = None, + session: str = None, continuation: str = None, max_count: int = None, sort_by=None, + **kwargs)' + parameters: + - name: tag_ids + description: Existing TagIds in project to filter suggested tags on. + isRequired: true + types: + - [] + - name: threshold + description: Confidence threshold to filter suggested tags on. + isRequired: true + types: + - + - name: session + description: 'SessionId for database query. Initially set to null but + + later used to paginate.' + isRequired: true + types: + - + - name: continuation + description: 'Continuation Id for database pagination. Initially + + null but later used to paginate.' + isRequired: true + types: + - + - name: max_count + description: 'Maximum number of results you want to be returned in the + + response.' + isRequired: true + types: + - + - name: sort_by + description: 'OrderBy. Ordering mechanism for your results. Possible + + values include: ''UncertaintyAscending'', ''UncertaintyDescending''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: tag_ids + isRequired: true + - name: threshold + isRequired: true + - name: session + isRequired: true + - name: continuation + isRequired: true + - name: max_count + isRequired: true + - name: sort_by + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQueryToken.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQueryToken.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQueryToken.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQueryToken.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQueryToken.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQueryToken.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQueryToken.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Tag.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Tag.yml new file mode 100644 index 00000000..d2e3d0be --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Tag.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.Tag +name: Tag +fullName: azure.cognitiveservices.vision.customvision.training.models.Tag +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Represents a Tag. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Tag(*, name: str, description: str, type, **kwargs)' + parameters: + - name: name + description: Required. Gets or sets the name of the tag. + isRequired: true + types: + - + - name: description + description: Required. Gets or sets the description of the tag. + isRequired: true + types: + - + - name: type + description: 'Required. Gets or sets the type of the tag. Possible values + + include: ''Regular'', ''Negative'', ''GeneralProduct''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: description + isRequired: true + - name: type + isRequired: true +variables: +- description: Gets the Tag ID. + name: id + types: + - +- description: Gets the number of images with this tag. + name: image_count + types: + - +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.Tag.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.Tag.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.Tag.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.Tag.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.Tag.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.Tag.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.Tag.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TagFilter.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TagFilter.yml new file mode 100644 index 00000000..6098f1e2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TagFilter.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.TagFilter +name: TagFilter +fullName: azure.cognitiveservices.vision.customvision.training.models.TagFilter +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Model that query for counting of images whose suggested tags match given + + tags and their probability are greater than or equal to the given + + threshold.' +constructor: + syntax: 'TagFilter(*, tag_ids=None, threshold: float = None, **kwargs)' + parameters: + - name: tag_ids + description: 'Existing TagIds in project to get suggested tags count + + for.' + isRequired: true + types: + - [] + - name: threshold + description: Confidence threshold to filter suggested tags on. + isRequired: true + types: + - + keywordOnlyParameters: + - name: tag_ids + isRequired: true + - name: threshold + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.TagFilter.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.TagFilter.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.TagFilter.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.TagFilter.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.TagFilter.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.TagFilter.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.TagFilter.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TagPerformance.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TagPerformance.yml new file mode 100644 index 00000000..de0ae4e8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TagPerformance.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.TagPerformance +name: TagPerformance +fullName: azure.cognitiveservices.vision.customvision.training.models.TagPerformance +module: azure.cognitiveservices.vision.customvision.training.models +summary: 'Represents performance data for a particular tag in a trained iteration. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: TagPerformance(**kwargs) +variables: +- name: id + types: + - +- name: name + types: + - +- description: Gets the precision. + name: precision + types: + - +- description: 'Gets the standard deviation for the + + precision.' + name: precision_std_deviation + types: + - +- description: Gets the recall. + name: recall + types: + - +- description: Gets the standard deviation for the recall. + name: recall_std_deviation + types: + - +- description: Gets the average precision when applicable. + name: average_precision + types: + - +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.TagPerformance.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.TagPerformance.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.TagPerformance.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.TagPerformance.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.TagPerformance.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.TagPerformance.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.TagPerformance.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TagType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TagType.yml new file mode 100644 index 00000000..8e838b4e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TagType.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.customvision.training.models.TagType +name: TagType +fullName: azure.cognitiveservices.vision.customvision.training.models.TagType +module: azure.cognitiveservices.vision.customvision.training.models +fields: +- name: general_product + uid: azure.cognitiveservices.vision.customvision.training.models.TagType.general_product +- name: negative + uid: azure.cognitiveservices.vision.customvision.training.models.TagType.negative +- name: regular + uid: azure.cognitiveservices.vision.customvision.training.models.TagType.regular diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TrainingParameters.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TrainingParameters.yml new file mode 100644 index 00000000..f4e7d78c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TrainingParameters.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.models.TrainingParameters +name: TrainingParameters +fullName: azure.cognitiveservices.vision.customvision.training.models.TrainingParameters +module: azure.cognitiveservices.vision.customvision.training.models +summary: Parameters used for training. +constructor: + syntax: TrainingParameters(*, selected_tags=None, custom_base_model_info=None, **kwargs) + parameters: + - name: selected_tags + description: 'List of tags selected for this training session, + + other tags in the project will be ignored.' + isRequired: true + types: + - [] + - name: custom_base_model_info + description: 'Information of the previously trained + + iteration which provides the base model for current iteration''s training.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: selected_tags + isRequired: true + - name: custom_base_model_info + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.customvision.training.models.TrainingParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.TrainingParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.TrainingParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.customvision.training.models.TrainingParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.customvision.training.models.TrainingParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.customvision.training.models.TrainingParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.customvision.training.models.TrainingParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TrainingType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TrainingType.yml new file mode 100644 index 00000000..eb7769f5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TrainingType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.customvision.training.models.TrainingType +name: TrainingType +fullName: azure.cognitiveservices.vision.customvision.training.models.TrainingType +module: azure.cognitiveservices.vision.customvision.training.models +fields: +- name: advanced + uid: azure.cognitiveservices.vision.customvision.training.models.TrainingType.advanced +- name: regular + uid: azure.cognitiveservices.vision.customvision.training.models.TrainingType.regular diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.yml new file mode 100644 index 00000000..f0b2a77a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.yml @@ -0,0 +1,73 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.vision.customvision.training.models +name: models +fullName: azure.cognitiveservices.vision.customvision.training.models +type: import +classes: +- azure.cognitiveservices.vision.customvision.training.models.BoundingBox +- azure.cognitiveservices.vision.customvision.training.models.CreateProjectOptions +- azure.cognitiveservices.vision.customvision.training.models.CustomBaseModelInfo +- azure.cognitiveservices.vision.customvision.training.models.CustomVisionError +- azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- azure.cognitiveservices.vision.customvision.training.models.Domain +- azure.cognitiveservices.vision.customvision.training.models.Export +- azure.cognitiveservices.vision.customvision.training.models.Image +- azure.cognitiveservices.vision.customvision.training.models.ImageCreateResult +- azure.cognitiveservices.vision.customvision.training.models.ImageCreateSummary +- azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateBatch +- azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateEntry +- azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateBatch +- azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateEntry +- azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateEntry +- azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateSummary +- azure.cognitiveservices.vision.customvision.training.models.ImagePerformance +- azure.cognitiveservices.vision.customvision.training.models.ImagePrediction +- azure.cognitiveservices.vision.customvision.training.models.ImageProcessingSettings +- azure.cognitiveservices.vision.customvision.training.models.ImageRegion +- azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateBatch +- azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateEntry +- azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateResult +- azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateSummary +- azure.cognitiveservices.vision.customvision.training.models.ImageRegionProposal +- azure.cognitiveservices.vision.customvision.training.models.ImageTag +- azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateBatch +- azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateEntry +- azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateSummary +- azure.cognitiveservices.vision.customvision.training.models.ImageUrl +- azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateBatch +- azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateEntry +- azure.cognitiveservices.vision.customvision.training.models.Iteration +- azure.cognitiveservices.vision.customvision.training.models.IterationPerformance +- azure.cognitiveservices.vision.customvision.training.models.ModelInformation +- azure.cognitiveservices.vision.customvision.training.models.Prediction +- azure.cognitiveservices.vision.customvision.training.models.PredictionQueryResult +- azure.cognitiveservices.vision.customvision.training.models.PredictionQueryTag +- azure.cognitiveservices.vision.customvision.training.models.PredictionQueryToken +- azure.cognitiveservices.vision.customvision.training.models.Project +- azure.cognitiveservices.vision.customvision.training.models.ProjectExport +- azure.cognitiveservices.vision.customvision.training.models.ProjectSettings +- azure.cognitiveservices.vision.customvision.training.models.Region +- azure.cognitiveservices.vision.customvision.training.models.RegionProposal +- azure.cognitiveservices.vision.customvision.training.models.StoredImagePrediction +- azure.cognitiveservices.vision.customvision.training.models.StoredSuggestedTagAndRegion +- azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegion +- azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQuery +- azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQueryToken +- azure.cognitiveservices.vision.customvision.training.models.Tag +- azure.cognitiveservices.vision.customvision.training.models.TagFilter +- azure.cognitiveservices.vision.customvision.training.models.TagPerformance +- azure.cognitiveservices.vision.customvision.training.models.TrainingParameters +enums: +- azure.cognitiveservices.vision.customvision.training.models.Classifier +- azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes +- azure.cognitiveservices.vision.customvision.training.models.DomainType +- azure.cognitiveservices.vision.customvision.training.models.ExportFlavor +- azure.cognitiveservices.vision.customvision.training.models.ExportPlatform +- azure.cognitiveservices.vision.customvision.training.models.ExportStatus +- azure.cognitiveservices.vision.customvision.training.models.ImageCreateStatus +- azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateStatus +- azure.cognitiveservices.vision.customvision.training.models.OrderBy +- azure.cognitiveservices.vision.customvision.training.models.ProjectStatus +- azure.cognitiveservices.vision.customvision.training.models.SortBy +- azure.cognitiveservices.vision.customvision.training.models.TagType +- azure.cognitiveservices.vision.customvision.training.models.TrainingType diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.yml new file mode 100644 index 00000000..6fec90dd --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.yml @@ -0,0 +1,2710 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin +name: CustomVisionTrainingClientOperationsMixin +fullName: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin +module: azure.cognitiveservices.vision.customvision.training.operations +constructor: + syntax: CustomVisionTrainingClientOperationsMixin() +methods: +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.create_image_regions + name: create_image_regions + summary: 'Create a set of image regions. + + + This API accepts a batch of image regions, and optionally tags, to + + update existing images with region information. + + There is a limit of 64 entries in the batch. + + If all regions are successful created, 200(OK) status code will be + + returned. + + Otherwise, 207 (Multi-Status) status code will be returned and detail + + status for each region will be listed in the response payload.' + signature: create_image_regions(project_id, regions=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: regions + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageRegionCreateSummary or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.create_image_tags + name: create_image_tags + summary: Associate a set of images with a set of tags. + signature: create_image_tags(project_id, tags=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: tags + description: Image Tag entries to include in this batch. + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageTagCreateSummary or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.create_images_from_data + name: create_images_from_data + summary: 'Add the provided images to the set of training images. + + + This API accepts body content as multipart/form-data and + + application/octet-stream. When using multipart + + multiple image files can be sent at once, with a maximum of 64 files. + + If all images are successful created, 200(OK) status code will be + + returned. + + Otherwise, 207 (Multi-Status) status code will be returned and detail + + status for each image will be listed in the response payload.' + signature: create_images_from_data(project_id, image_data, tag_ids=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: image_data + description: 'Binary image data. Supported formats are JPEG, GIF, + + PNG, and BMP. Supports images up to 6MB.' + isRequired: true + types: + - + - name: tag_ids + description: 'The tags ids with which to tag each image. Limited to + + 20.' + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageCreateSummary or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.create_images_from_files + name: create_images_from_files + summary: 'Add the provided batch of images to the set of training images. + + + This API accepts a batch of files, and optionally tags, to create + + images. There is a limit of 64 images and 20 tags. + + If all images are successful created, 200(OK) status code will be + + returned. + + Otherwise, 207 (Multi-Status) status code will be returned and detail + + status for each image will be listed in the response payload.' + signature: create_images_from_files(project_id, batch, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: batch + description: 'The batch of image files to add. Limited to 64 images + + and 20 tags per batch.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageCreateSummary or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.create_images_from_predictions + name: create_images_from_predictions + summary: 'Add the specified predicted images to the set of training images. + + + This API creates a batch of images from predicted images specified. + + There is a limit of 64 images and 20 tags. + + If all images are successful created, 200(OK) status code will be + + returned. + + Otherwise, 207 (Multi-Status) status code will be returned and detail + + status for each image will be listed in the response payload.' + signature: create_images_from_predictions(project_id, batch, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: batch + description: 'Image, tag ids, and metadata. Limited to 64 images and + + 20 tags per batch.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageCreateSummary or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.create_images_from_urls + name: create_images_from_urls + summary: 'Add the provided images urls to the set of training images. + + + This API accepts a batch of urls, and optionally tags, to create + + images. There is a limit of 64 images and 20 tags. + + If all images are successful created, 200(OK) status code will be + + returned. + + Otherwise, 207 (Multi-Status) status code will be returned and detail + + status for each image will be listed in the response payload.' + signature: create_images_from_urls(project_id, batch, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: batch + description: 'Image urls, tag ids, and metadata. Limited to 64 images + + and 20 tags per batch.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageCreateSummary or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.create_project + name: create_project + summary: Create a project. + signature: create_project(name, description=None, domain_id=None, classification_type=None, + target_export_platforms=None, export_model_container_uri=None, notification_queue_uri=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: name + description: Name of the project. + isRequired: true + types: + - + - name: description + description: The description of the project. + defaultValue: None + types: + - + - name: domain_id + description: 'The id of the domain to use for this project. + + Defaults to General.' + defaultValue: None + types: + - + - name: classification_type + description: 'The type of classifier to create for this + + project. Possible values include: ''Multiclass'', ''Multilabel''' + defaultValue: None + types: + - + - name: target_export_platforms + description: 'List of platforms the trained model is + + intending exporting to.' + defaultValue: None + types: + - [] + - name: export_model_container_uri + description: 'The uri to the Azure Storage + + container that will be used to store exported models.' + defaultValue: None + types: + - + - name: notification_queue_uri + description: 'The uri to the Azure Storage queue that + + will be used to send project-related notifications. See Storage + + notifications documentation for setup and message format.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Project or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.create_tag + name: create_tag + summary: Create a tag for the project. + signature: create_tag(project_id, name, description=None, type=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: name + description: The tag name. + isRequired: true + types: + - + - name: description + description: Optional description for the tag. + defaultValue: None + types: + - + - name: type + description: 'Optional type for the tag. Possible values include: + + ''Regular'', ''Negative'', ''GeneralProduct''' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Tag or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.delete_image_regions + name: delete_image_regions + summary: Delete a set of image regions. + signature: delete_image_regions(project_id, region_ids, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: region_ids + description: Regions to delete. Limited to 64. + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.delete_image_tags + name: delete_image_tags + summary: Remove a set of tags from a set of images. + signature: delete_image_tags(project_id, image_ids, tag_ids, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: image_ids + description: Image ids. Limited to 64 images. + isRequired: true + types: + - [] + - name: tag_ids + description: 'Tags to be deleted from the specified images. Limited + + to 20 tags.' + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.delete_images + name: delete_images + summary: Delete images from the set of training images. + signature: delete_images(project_id, image_ids=None, all_images=None, all_iterations=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: image_ids + description: 'Ids of the images to be deleted. Limited to 256 + + images per batch.' + defaultValue: None + types: + - [] + - name: all_images + description: 'Flag to specify delete all images, specify this + + flag or a list of images. Using this flag will return a 202 response + + to indicate the images are being deleted.' + defaultValue: None + types: + - + - name: all_iterations + description: 'Removes these images from all iterations, not + + just the current workspace. Using this flag will return a 202 response + + to indicate the images are being deleted.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.delete_iteration + name: delete_iteration + summary: Delete a specific iteration of a project. + signature: delete_iteration(project_id, iteration_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.delete_prediction + name: delete_prediction + summary: 'Delete a set of predicted images and their associated prediction + + results.' + signature: delete_prediction(project_id, ids, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: ids + description: The prediction ids. Limited to 64. + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.delete_project + name: delete_project + summary: Delete a specific project. + signature: delete_project(project_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.delete_tag + name: delete_tag + summary: Delete a tag from the project. + signature: delete_tag(project_id, tag_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: tag_id + description: Id of the tag to be deleted. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.export_iteration + name: export_iteration + summary: Export a trained iteration. + signature: export_iteration(project_id, iteration_id, platform, flavor=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. + isRequired: true + types: + - + - name: platform + description: 'The target platform. Possible values include: + + ''CoreML'', ''TensorFlow'', ''DockerFile'', ''ONNX'', ''VAIDK'', ''OpenVino''' + isRequired: true + types: + - + - name: flavor + description: 'The flavor of the target platform. Possible values + + include: ''Linux'', ''Windows'', ''ONNX10'', ''ONNX12'', ''ARM'', + + ''TensorFlowNormal'', ''TensorFlowLite''' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Export or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.export_project + name: export_project + summary: Exports a project. + signature: export_project(project_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id of the project to export. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ProjectExport or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.get_artifact + name: get_artifact + summary: 'Get artifact content from blob storage, based on artifact relative path + + in the blob.' + signature: get_artifact(project_id, path, custom_headers=None, raw=False, callback=None, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: path + description: The relative path for artifact. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: object or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrest.exceptions.HttpOperationError +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.get_domain + name: get_domain + summary: Get information about a specific domain. + signature: get_domain(domain_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: domain_id + description: The id of the domain to get information about. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Domain or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.get_domains + name: get_domains + summary: Get a list of the available domains. + signature: get_domains(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.get_exports + name: get_exports + summary: Get the list of exports for a specific iteration. + signature: get_exports(project_id, iteration_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.get_image_count + name: get_image_count + summary: 'Get the number of images. + + + The filtering is on an and/or relationship. For example, if the + + provided tag ids are for the "Dog" and + + "Cat" tags, then only images tagged with Dog and/or Cat will be + + returned.' + signature: get_image_count(project_id, iteration_id=None, tagging_status=None, filter=None, + tag_ids=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. Defaults to workspace. + defaultValue: None + types: + - + - name: tagging_status + description: 'The tagging status filter. It can be ''All'', + + ''Tagged'', or ''Untagged''. Defaults to ''All''. Possible values include: + + ''All'', ''Tagged'', ''Untagged''' + defaultValue: None + types: + - + - name: filter + description: 'An expression to filter the images against image + + metadata. Only images where the expression evaluates to true are + + included in the response. + + The expression supports eq (Equal), ne (Not equal), and (Logical and), + + or (Logical or) operators. + + Here is an example, metadata=key1 eq ''value1'' and key2 ne ''value2''.' + defaultValue: None + types: + - + - name: tag_ids + description: 'A list of tags ids to filter the images to count. + + Defaults to all tags when null.' + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: int or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.get_image_performance_count + name: get_image_performance_count + summary: 'Gets the number of images tagged with the provided {tagIds} that have + + prediction results from + + training for the provided iteration {iterationId}. + + + The filtering is on an and/or relationship. For example, if the + + provided tag ids are for the "Dog" and + + "Cat" tags, then only images tagged with Dog and/or Cat will be + + returned.' + signature: get_image_performance_count(project_id, iteration_id, tag_ids=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. Defaults to workspace. + isRequired: true + types: + - + - name: tag_ids + description: 'A list of tags ids to filter the images to count. + + Defaults to all tags when null.' + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: int or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.get_image_performances + name: get_image_performances + summary: 'Get image with its prediction for a given project iteration. + + + This API supports batching and range selection. By default it will only + + return first 50 images matching images. + + Use the {take} and {skip} parameters to control how many images to + + return in a given batch. + + The filtering is on an and/or relationship. For example, if the + + provided tag ids are for the "Dog" and + + "Cat" tags, then only images tagged with Dog and/or Cat will be + + returned.' + signature: get_image_performances(project_id, iteration_id, tag_ids=None, order_by=None, + take=50, skip=0, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. Defaults to workspace. + isRequired: true + types: + - + - name: tag_ids + description: 'A list of tags ids to filter the images. Defaults to + + all tagged images when null. Limited to 20.' + defaultValue: None + types: + - [] + - name: order_by + description: 'The ordering. Defaults to newest. Possible values + + include: ''Newest'', ''Oldest''' + defaultValue: None + types: + - + - name: take + description: 'Maximum number of images to return. Defaults to 50, + + limited to 256.' + defaultValue: '50' + types: + - + - name: skip + description: 'Number of images to skip before beginning the image + + batch. Defaults to 0.' + defaultValue: '0' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.get_image_region_proposals + name: get_image_region_proposals + summary: 'Get region proposals for an image. Returns empty array if no proposals + + are found. + + + This API will get region proposals for an image along with confidences + + for the region. It returns an empty array if no proposals are found.' + signature: get_image_region_proposals(project_id, image_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: image_id + description: The image id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageRegionProposal or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.get_images + name: get_images + summary: 'Get images for a given project iteration or workspace. + + + This API supports batching and range selection. By default it will only + + return first 50 images matching images. + + Use the {take} and {skip} parameters to control how many images to + + return in a given batch. + + The filtering is on an and/or relationship. For example, if the + + provided tag ids are for the "Dog" and + + "Cat" tags, then only images tagged with Dog and/or Cat will be + + returned.' + signature: get_images(project_id, iteration_id=None, tag_ids=None, tagging_status=None, + filter=None, order_by=None, take=50, skip=0, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. Defaults to workspace. + defaultValue: None + types: + - + - name: tag_ids + description: 'A list of tags ids to filter the images. Defaults to + + all tagged images when null. Limited to 20.' + defaultValue: None + types: + - [] + - name: tagging_status + description: 'The tagging status filter. It can be ''All'', + + ''Tagged'', or ''Untagged''. Defaults to ''All''. Possible values include: + + ''All'', ''Tagged'', ''Untagged''' + defaultValue: None + types: + - + - name: filter + description: 'An expression to filter the images against image + + metadata. Only images where the expression evaluates to true are + + included in the response. + + The expression supports eq (Equal), ne (Not equal), and (Logical and), + + or (Logical or) operators. + + Here is an example, metadata=key1 eq ''value1'' and key2 ne ''value2''.' + defaultValue: None + types: + - + - name: order_by + description: 'The ordering. Defaults to newest. Possible values + + include: ''Newest'', ''Oldest''' + defaultValue: None + types: + - + - name: take + description: 'Maximum number of images to return. Defaults to 50, + + limited to 256.' + defaultValue: '50' + types: + - + - name: skip + description: 'Number of images to skip before beginning the image + + batch. Defaults to 0.' + defaultValue: '0' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.get_images_by_ids + name: get_images_by_ids + summary: 'Get images by id for a given project iteration. + + + This API will return a set of Images for the specified tags and + + optionally iteration. If no iteration is specified the + + current workspace is used.' + signature: get_images_by_ids(project_id, image_ids=None, iteration_id=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: image_ids + description: The list of image ids to retrieve. Limited to 256. + defaultValue: None + types: + - [] + - name: iteration_id + description: The iteration id. Defaults to workspace. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.get_iteration + name: get_iteration + summary: Get a specific iteration. + signature: get_iteration(project_id, iteration_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The id of the project the iteration belongs to. + isRequired: true + types: + - + - name: iteration_id + description: The id of the iteration to get. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Iteration or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.get_iteration_performance + name: get_iteration_performance + summary: Get detailed performance information about an iteration. + signature: get_iteration_performance(project_id, iteration_id, threshold=None, overlap_threshold=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The id of the project the iteration belongs to. + isRequired: true + types: + - + - name: iteration_id + description: The id of the iteration to get. + isRequired: true + types: + - + - name: threshold + description: The threshold used to determine true predictions. + defaultValue: None + types: + - + - name: overlap_threshold + description: 'If applicable, the bounding box overlap + + threshold used to determine true predictions.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: IterationPerformance or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.get_iterations + name: get_iterations + summary: Get iterations for the project. + signature: get_iterations(project_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.get_project + name: get_project + summary: Get a specific project. + signature: get_project(project_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The id of the project to get. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Project or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.get_projects + name: get_projects + summary: Get your projects. + signature: get_projects(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.get_tag + name: get_tag + summary: Get information about a specific tag. + signature: get_tag(project_id, tag_id, iteration_id=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project this tag belongs to. + isRequired: true + types: + - + - name: tag_id + description: The tag id. + isRequired: true + types: + - + - name: iteration_id + description: 'The iteration to retrieve this tag from. + + Optional, defaults to current training set.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Tag or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.get_tagged_image_count + name: get_tagged_image_count + summary: 'Gets the number of images tagged with the provided {tagIds}. + + + The filtering is on an and/or relationship. For example, if the + + provided tag ids are for the "Dog" and + + "Cat" tags, then only images tagged with Dog and/or Cat will be + + returned.' + signature: get_tagged_image_count(project_id, iteration_id=None, tag_ids=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. Defaults to workspace. + defaultValue: None + types: + - + - name: tag_ids + description: 'A list of tags ids to filter the images to count. + + Defaults to all tags when null.' + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: int or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.get_tagged_images + name: get_tagged_images + summary: 'Get tagged images for a given project iteration. + + + This API supports batching and range selection. By default it will only + + return first 50 images matching images. + + Use the {take} and {skip} parameters to control how many images to + + return in a given batch. + + The filtering is on an and/or relationship. For example, if the + + provided tag ids are for the "Dog" and + + "Cat" tags, then only images tagged with Dog and/or Cat will be + + returned.' + signature: get_tagged_images(project_id, iteration_id=None, tag_ids=None, order_by=None, + take=50, skip=0, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. Defaults to workspace. + defaultValue: None + types: + - + - name: tag_ids + description: 'A list of tags ids to filter the images. Defaults to + + all tagged images when null. Limited to 20.' + defaultValue: None + types: + - [] + - name: order_by + description: 'The ordering. Defaults to newest. Possible values + + include: ''Newest'', ''Oldest''' + defaultValue: None + types: + - + - name: take + description: 'Maximum number of images to return. Defaults to 50, + + limited to 256.' + defaultValue: '50' + types: + - + - name: skip + description: 'Number of images to skip before beginning the image + + batch. Defaults to 0.' + defaultValue: '0' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.get_tags + name: get_tags + summary: Get the tags for a given project and iteration. + signature: get_tags(project_id, iteration_id=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. Defaults to workspace. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.get_untagged_image_count + name: get_untagged_image_count + summary: 'Gets the number of untagged images. + + + This API returns the images which have no tags for a given project and + + optionally an iteration. If no iteration is specified the + + current workspace is used.' + signature: get_untagged_image_count(project_id, iteration_id=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. Defaults to workspace. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: int or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.get_untagged_images + name: get_untagged_images + summary: 'Get untagged images for a given project iteration. + + + This API supports batching and range selection. By default it will only + + return first 50 images matching images. + + Use the {take} and {skip} parameters to control how many images to + + return in a given batch.' + signature: get_untagged_images(project_id, iteration_id=None, order_by=None, take=50, + skip=0, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. Defaults to workspace. + defaultValue: None + types: + - + - name: order_by + description: 'The ordering. Defaults to newest. Possible values + + include: ''Newest'', ''Oldest''' + defaultValue: None + types: + - + - name: take + description: 'Maximum number of images to return. Defaults to 50, + + limited to 256.' + defaultValue: '50' + types: + - + - name: skip + description: 'Number of images to skip before beginning the image + + batch. Defaults to 0.' + defaultValue: '0' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.import_project + name: import_project + summary: Imports a project. + signature: import_project(token, name=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: token + description: Token generated from the export project call. + isRequired: true + types: + - + - name: name + description: 'Optional, name of the project to use instead of + + auto-generated name.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Project or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.publish_iteration + name: publish_iteration + summary: Publish a specific iteration. + signature: publish_iteration(project_id, iteration_id, publish_name, prediction_id, + overwrite=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. + isRequired: true + types: + - + - name: publish_name + description: The name to give the published iteration. + isRequired: true + types: + - + - name: prediction_id + description: The id of the prediction resource to publish to. + isRequired: true + types: + - + - name: overwrite + description: 'Whether to overwrite the published model with the + + given name (default: false).' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: bool or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.query_predictions + name: query_predictions + summary: Get images that were sent to your prediction endpoint. + signature: query_predictions(project_id, query, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: query + description: 'Parameters used to query the predictions. Limited to + + combining 2 tags.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: PredictionQueryResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.query_suggested_image_count + name: query_suggested_image_count + summary: 'Get count of images whose suggested tags match given tags and their + + probabilities are greater than or equal to the given threshold. Returns + + count as 0 if none found. + + + This API takes in tagIds to get count of untagged images per suggested + + tags for a given threshold.' + signature: query_suggested_image_count(project_id, iteration_id, tag_ids=None, threshold=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: 'IterationId to use for the suggested tags and + + regions.' + isRequired: true + types: + - + - name: tag_ids + description: 'Existing TagIds in project to get suggested tags count + + for.' + defaultValue: None + types: + - [] + - name: threshold + description: Confidence threshold to filter suggested tags on. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: dict or ClientRawResponse if raw=true + types: + - [, ] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.query_suggested_images + name: query_suggested_images + summary: 'Get untagged images whose suggested tags match given tags. Returns + + empty array if no images are found. + + + This API will fetch untagged images filtered by suggested tags Ids. It + + returns an empty array if no images are found.' + signature: query_suggested_images(project_id, iteration_id, query, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: 'IterationId to use for the suggested tags and + + regions.' + isRequired: true + types: + - + - name: query + description: Contains properties we need to query suggested images. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SuggestedTagAndRegionQuery or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.quick_test_image + name: quick_test_image + summary: Quick test an image. + signature: quick_test_image(project_id, image_data, iteration_id=None, store=True, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: image_data + description: 'Binary image data. Supported formats are JPEG, GIF, + + PNG, and BMP. Supports images up to 6MB.' + isRequired: true + types: + - + - name: iteration_id + description: 'Optional. Specifies the id of a particular + + iteration to evaluate against. + + The default iteration for the project will be used when not specified.' + defaultValue: None + types: + - + - name: store + description: 'Optional. Specifies whether or not to store the result + + of this prediction. The default is true, to store.' + defaultValue: 'True' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImagePrediction or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.quick_test_image_url + name: quick_test_image_url + summary: Quick test an image url. + signature: quick_test_image_url(project_id, url, iteration_id=None, store=True, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project to evaluate against. + isRequired: true + types: + - + - name: url + description: Url of the image. + isRequired: true + types: + - + - name: iteration_id + description: 'Optional. Specifies the id of a particular + + iteration to evaluate against. + + The default iteration for the project will be used when not specified.' + defaultValue: None + types: + - + - name: store + description: 'Optional. Specifies whether or not to store the result + + of this prediction. The default is true, to store.' + defaultValue: 'True' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImagePrediction or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.suggest_tags_and_regions + name: suggest_tags_and_regions + summary: 'Suggest tags and regions for an array/batch of untagged images. Returns + + empty array if no tags are found. + + + This API will get suggested tags and regions for an array/batch of + + untagged images along with confidences for the tags. It returns an + + empty array if no tags are found. + + There is a limit of 64 images in the batch.' + signature: suggest_tags_and_regions(project_id, iteration_id, image_ids, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: IterationId to use for tag and region suggestion. + isRequired: true + types: + - + - name: image_ids + description: 'Array of image ids tag suggestion are needed for. + + Use GetUntaggedImages API to get imageIds.' + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.train_project + name: train_project + summary: Queues project for training. + signature: train_project(project_id, training_type=None, reserved_budget_in_hours=0, + force_train=False, notification_email_address=None, selected_tags=None, custom_base_model_info=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: training_type + description: 'The type of training to use to train the project + + (default: Regular). Possible values include: ''Regular'', ''Advanced''' + defaultValue: None + types: + - + - name: reserved_budget_in_hours + description: 'The number of hours reserved as + + budget for training (if applicable).' + defaultValue: '0' + types: + - + - name: force_train + description: 'Whether to force train even if dataset and + + configuration does not change (default: false).' + defaultValue: 'False' + types: + - + - name: notification_email_address + description: 'The email address to send + + notification to when training finishes (default: null).' + defaultValue: None + types: + - + - name: selected_tags + description: 'List of tags selected for this training session, + + other tags in the project will be ignored.' + defaultValue: None + types: + - [] + - name: custom_base_model_info + description: 'Information of the previously trained + + iteration which provides the base model for current iteration''s + + training.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Iteration or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.unpublish_iteration + name: unpublish_iteration + summary: Unpublish a specific iteration. + signature: unpublish_iteration(project_id, iteration_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: iteration_id + description: The iteration id. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.update_image_metadata + name: update_image_metadata + summary: 'Update metadata of images. + + + This API accepts a batch of image Ids, and metadata, to update images. + + There is a limit of 64 images.' + signature: update_image_metadata(project_id, image_ids, metadata, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: image_ids + description: The list of image ids to update. Limited to 64. + isRequired: true + types: + - [] + - name: metadata + description: 'The metadata to be updated to the specified images. + + Limited to 10 key-value pairs per image. The length of key is limited + + to 128. The length of value is limited to 256.' + isRequired: true + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ImageMetadataUpdateSummary or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.update_iteration + name: update_iteration + summary: Update a specific iteration. + signature: update_iteration(project_id, iteration_id, name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: project_id + description: Project id. + isRequired: true + types: + - + - name: iteration_id + description: Iteration id. + isRequired: true + types: + - + - name: name + description: Gets or sets the name of the iteration. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Iteration or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.update_project + name: update_project + summary: Update a specific project. + signature: update_project(project_id, updated_project, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The id of the project to update. + isRequired: true + types: + - + - name: updated_project + description: The updated project model. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Project or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException +- uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin.update_tag + name: update_tag + summary: Update a tag. + signature: update_tag(project_id, tag_id, updated_tag, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: project_id + description: The project id. + isRequired: true + types: + - + - name: tag_id + description: The id of the target tag. + isRequired: true + types: + - + - name: updated_tag + description: The updated tag model. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Tag or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.operations.yml new file mode 100644 index 00000000..8b0cafdc --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.operations.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.vision.customvision.training.operations +name: operations +fullName: azure.cognitiveservices.vision.customvision.training.operations +type: import +classes: +- azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.version.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.version.yml new file mode 100644 index 00000000..296b2594 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.vision.customvision.training.version +name: version +fullName: azure.cognitiveservices.vision.customvision.training.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.yml new file mode 100644 index 00000000..237916b1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.vision.customvision.training +name: training +fullName: azure.cognitiveservices.vision.customvision.training +type: import +classes: +- azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient +- azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClientConfiguration +packages: +- azure.cognitiveservices.vision.customvision.training.models +- azure.cognitiveservices.vision.customvision.training.operations +modules: +- azure.cognitiveservices.vision.customvision.training.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.version.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.version.yml new file mode 100644 index 00000000..554ab3cd --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.vision.customvision.version +name: version +fullName: azure.cognitiveservices.vision.customvision.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.yml new file mode 100644 index 00000000..17c0a356 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.vision.customvision +name: customvision +fullName: azure.cognitiveservices.vision.customvision +type: rootImport +packages: +- azure.cognitiveservices.vision.customvision.prediction +- azure.cognitiveservices.vision.customvision.training +modules: +- azure.cognitiveservices.vision.customvision.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.FaceClient.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.FaceClient.yml new file mode 100644 index 00000000..d1ca1d3f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.FaceClient.yml @@ -0,0 +1,65 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.FaceClient +name: FaceClient +fullName: azure.cognitiveservices.vision.face.FaceClient +module: azure.cognitiveservices.vision.face +summary: An API for face detection, verification, and identification. +constructor: + syntax: FaceClient(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and + + hostname, for example: [https://westus.api.cognitive.microsoft.com](https://westus.api.cognitive.microsoft.com)).' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +- description: Face operations + name: face + types: + - +- description: PersonGroupPerson operations + name: person_group_person + types: + - +- description: PersonGroup operations + name: person_group + types: + - +- description: FaceList operations + name: face_list + types: + - +- description: LargePersonGroupPerson operations + name: large_person_group_person + types: + - +- description: LargePersonGroup operations + name: large_person_group + types: + - +- description: LargeFaceList operations + name: large_face_list + types: + - +- description: Snapshot operations + name: snapshot + types: + - +methods: +- uid: azure.cognitiveservices.vision.face.FaceClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.FaceClientConfiguration.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.FaceClientConfiguration.yml new file mode 100644 index 00000000..892131ce --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.FaceClientConfiguration.yml @@ -0,0 +1,62 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.FaceClientConfiguration +name: FaceClientConfiguration +fullName: azure.cognitiveservices.vision.face.FaceClientConfiguration +module: azure.cognitiveservices.vision.face +summary: 'Configuration for FaceClient + + Note that all parameters used to create this instance are saved as instance + + attributes.' +constructor: + syntax: FaceClientConfiguration(endpoint, credentials) + parameters: + - name: endpoint + description: 'Supported Cognitive Services endpoints (protocol and + + hostname, for example: [https://westus.api.cognitive.microsoft.com](https://westus.api.cognitive.microsoft.com)).' + isRequired: true + types: + - + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - +methods: +- uid: azure.cognitiveservices.vision.face.FaceClientConfiguration.add_user_agent + name: add_user_agent + summary: Add value to current user agent with a space. + signature: 'add_user_agent(value: str) -> None' + parameters: + - name: value + description: value to add to user agent. + isRequired: true + types: + - +- uid: azure.cognitiveservices.vision.face.FaceClientConfiguration.load + name: load + signature: load(filepath) + parameters: + - name: filepath + isRequired: true +- uid: azure.cognitiveservices.vision.face.FaceClientConfiguration.save + name: save + summary: Save current configuration to file. + signature: save(filepath) + parameters: + - name: filepath + description: Path to file where settings will be saved. + isRequired: true + types: + - + exceptions: + - type: ValueError if supplied filepath cannot be written to. +attributes: +- uid: azure.cognitiveservices.vision.face.FaceClientConfiguration.enable_http_logger + name: enable_http_logger +- uid: azure.cognitiveservices.vision.face.FaceClientConfiguration.user_agent + name: user_agent + summary: The current user agent value. diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.APIError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.APIError.yml new file mode 100644 index 00000000..1636cac4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.APIError.yml @@ -0,0 +1,122 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.APIError +name: APIError +fullName: azure.cognitiveservices.vision.face.models.APIError +module: azure.cognitiveservices.vision.face.models +summary: Error information returned by the API. +constructor: + syntax: APIError(*, error=None, **kwargs) + parameters: + - name: error + isRequired: true + types: + - + keywordOnlyParameters: + - name: error + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.APIError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.APIError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.APIError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.APIError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.APIError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.APIError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.APIError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.APIErrorException.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.APIErrorException.yml new file mode 100644 index 00000000..19d7c4a0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.APIErrorException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.APIErrorException +name: APIErrorException +fullName: azure.cognitiveservices.vision.face.models.APIErrorException +module: azure.cognitiveservices.vision.face.models +summary: 'Server responsed with exception of type: ''APIError''.' +constructor: + syntax: APIErrorException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.APIErrorException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cognitiveservices.vision.face.models.APIErrorException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cognitiveservices.vision.face.models.APIErrorException.args + name: args diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Accessory.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Accessory.yml new file mode 100644 index 00000000..788349b9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Accessory.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.Accessory +name: Accessory +fullName: azure.cognitiveservices.vision.face.models.Accessory +module: azure.cognitiveservices.vision.face.models +summary: Accessory item and corresponding confidence level. +constructor: + syntax: 'Accessory(*, type=None, confidence: float = None, **kwargs)' + parameters: + - name: type + description: 'Type of an accessory. Possible values include: ''headWear'', + + ''glasses'', ''mask''' + isRequired: true + types: + - + - + - name: confidence + description: Confidence level of an accessory + isRequired: true + types: + - + keywordOnlyParameters: + - name: type + isRequired: true + - name: confidence + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.Accessory.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Accessory.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Accessory.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.Accessory.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Accessory.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.Accessory.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Accessory.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.AccessoryType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.AccessoryType.yml new file mode 100644 index 00000000..7764b851 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.AccessoryType.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.face.models.AccessoryType +name: AccessoryType +fullName: azure.cognitiveservices.vision.face.models.AccessoryType +module: azure.cognitiveservices.vision.face.models +fields: +- name: glasses + uid: azure.cognitiveservices.vision.face.models.AccessoryType.glasses +- name: head_wear + uid: azure.cognitiveservices.vision.face.models.AccessoryType.head_wear +- name: mask + uid: azure.cognitiveservices.vision.face.models.AccessoryType.mask diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.ApplySnapshotRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.ApplySnapshotRequest.yml new file mode 100644 index 00000000..30e64a0c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.ApplySnapshotRequest.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.ApplySnapshotRequest +name: ApplySnapshotRequest +fullName: azure.cognitiveservices.vision.face.models.ApplySnapshotRequest +module: azure.cognitiveservices.vision.face.models +summary: 'Request body for applying snapshot operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ApplySnapshotRequest(*, object_id: str, mode=''CreateNew'', **kwargs)' + parameters: + - name: object_id + description: 'Required. User specified target object id to be created + + from the snapshot.' + isRequired: true + types: + - + - name: mode + description: 'Snapshot applying mode. Currently only CreateNew is + + supported, which means the apply operation will fail if target + + subscription already contains an object of same type and using the same + + objectId. Users can specify the "objectId" in request body to avoid such + + conflicts. Possible values include: ''CreateNew''. Default value: + + "CreateNew" .' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: object_id + isRequired: true + - name: mode + defaultValue: CreateNew +methods: +- uid: azure.cognitiveservices.vision.face.models.ApplySnapshotRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.ApplySnapshotRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.ApplySnapshotRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.ApplySnapshotRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.ApplySnapshotRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.ApplySnapshotRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.ApplySnapshotRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Blur.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Blur.yml new file mode 100644 index 00000000..922e5e32 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Blur.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.Blur +name: Blur +fullName: azure.cognitiveservices.vision.face.models.Blur +module: azure.cognitiveservices.vision.face.models +summary: Properties describing any presence of blur within the image. +constructor: + syntax: 'Blur(*, blur_level=None, value: float = None, **kwargs)' + parameters: + - name: blur_level + description: 'An enum value indicating level of blurriness. Possible + + values include: ''Low'', ''Medium'', ''High''' + isRequired: true + types: + - + - + - name: value + description: A number indicating level of blurriness ranging from 0 to 1. + isRequired: true + types: + - + keywordOnlyParameters: + - name: blur_level + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.Blur.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Blur.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Blur.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.Blur.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Blur.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.Blur.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Blur.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.BlurLevel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.BlurLevel.yml new file mode 100644 index 00000000..ac5ff325 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.BlurLevel.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.face.models.BlurLevel +name: BlurLevel +fullName: azure.cognitiveservices.vision.face.models.BlurLevel +module: azure.cognitiveservices.vision.face.models +fields: +- name: high + uid: azure.cognitiveservices.vision.face.models.BlurLevel.high +- name: low + uid: azure.cognitiveservices.vision.face.models.BlurLevel.low +- name: medium + uid: azure.cognitiveservices.vision.face.models.BlurLevel.medium diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Coordinate.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Coordinate.yml new file mode 100644 index 00000000..42bf7511 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Coordinate.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.Coordinate +name: Coordinate +fullName: azure.cognitiveservices.vision.face.models.Coordinate +module: azure.cognitiveservices.vision.face.models +summary: 'Coordinates within an image. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Coordinate(*, x: float, y: float, **kwargs)' + parameters: + - name: x + description: Required. The horizontal component, in pixels. + isRequired: true + types: + - + - name: y + description: Required. The vertical component, in pixels. + isRequired: true + types: + - + keywordOnlyParameters: + - name: x + isRequired: true + - name: y + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.Coordinate.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Coordinate.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Coordinate.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.Coordinate.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Coordinate.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.Coordinate.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Coordinate.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.DetectedFace.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.DetectedFace.yml new file mode 100644 index 00000000..a8d52f61 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.DetectedFace.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.DetectedFace +name: DetectedFace +fullName: azure.cognitiveservices.vision.face.models.DetectedFace +module: azure.cognitiveservices.vision.face.models +summary: 'Detected Face object. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DetectedFace(*, face_rectangle, face_id: str = None, recognition_model=''recognition_01'', + face_landmarks=None, face_attributes=None, **kwargs)' + parameters: + - name: face_id + isRequired: true + types: + - + - name: recognition_model + description: 'Possible values include: ''recognition_01'', + + ''recognition_02'', ''recognition_03'', ''recognition_04''. Default value: + + "recognition_01" .' + isRequired: true + types: + - + - + - name: face_rectangle + description: Required. + isRequired: true + types: + - + - name: face_landmarks + isRequired: true + types: + - + - name: face_attributes + isRequired: true + types: + - + keywordOnlyParameters: + - name: face_rectangle + isRequired: true + - name: face_id + isRequired: true + - name: recognition_model + defaultValue: recognition_01 + - name: face_landmarks + isRequired: true + - name: face_attributes + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.DetectedFace.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.DetectedFace.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.DetectedFace.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.DetectedFace.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.DetectedFace.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.DetectedFace.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.DetectedFace.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.DetectionModel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.DetectionModel.yml new file mode 100644 index 00000000..85548592 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.DetectionModel.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.face.models.DetectionModel +name: DetectionModel +fullName: azure.cognitiveservices.vision.face.models.DetectionModel +module: azure.cognitiveservices.vision.face.models +fields: +- name: detection_01 + uid: azure.cognitiveservices.vision.face.models.DetectionModel.detection_01 +- name: detection_02 + uid: azure.cognitiveservices.vision.face.models.DetectionModel.detection_02 +- name: detection_03 + uid: azure.cognitiveservices.vision.face.models.DetectionModel.detection_03 diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Emotion.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Emotion.yml new file mode 100644 index 00000000..410a1808 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Emotion.yml @@ -0,0 +1,169 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.Emotion +name: Emotion +fullName: azure.cognitiveservices.vision.face.models.Emotion +module: azure.cognitiveservices.vision.face.models +summary: 'Properties describing facial emotion in form of confidence ranging from + 0 + + to 1.' +constructor: + syntax: 'Emotion(*, anger: float = None, contempt: float = None, disgust: float + = None, fear: float = None, happiness: float = None, neutral: float = None, sadness: + float = None, surprise: float = None, **kwargs)' + parameters: + - name: anger + isRequired: true + types: + - + - name: contempt + isRequired: true + types: + - + - name: disgust + isRequired: true + types: + - + - name: fear + isRequired: true + types: + - + - name: happiness + isRequired: true + types: + - + - name: neutral + isRequired: true + types: + - + - name: sadness + isRequired: true + types: + - + - name: surprise + isRequired: true + types: + - + keywordOnlyParameters: + - name: anger + isRequired: true + - name: contempt + isRequired: true + - name: disgust + isRequired: true + - name: fear + isRequired: true + - name: happiness + isRequired: true + - name: neutral + isRequired: true + - name: sadness + isRequired: true + - name: surprise + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.Emotion.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Emotion.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Emotion.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.Emotion.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Emotion.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.Emotion.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Emotion.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Error.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Error.yml new file mode 100644 index 00000000..10131fd4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Error.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.Error +name: Error +fullName: azure.cognitiveservices.vision.face.models.Error +module: azure.cognitiveservices.vision.face.models +summary: Error body. +constructor: + syntax: 'Error(*, code: str = None, message: str = None, **kwargs)' + parameters: + - name: code + isRequired: true + types: + - + - name: message + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.Error.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Error.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Error.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.Error.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Error.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.Error.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Error.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Exposure.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Exposure.yml new file mode 100644 index 00000000..0a6b5eb7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Exposure.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.Exposure +name: Exposure +fullName: azure.cognitiveservices.vision.face.models.Exposure +module: azure.cognitiveservices.vision.face.models +summary: Properties describing exposure level of the image. +constructor: + syntax: 'Exposure(*, exposure_level=None, value: float = None, **kwargs)' + parameters: + - name: exposure_level + description: 'An enum value indicating level of exposure. + + Possible values include: ''UnderExposure'', ''GoodExposure'', ''OverExposure''' + isRequired: true + types: + - + - + - name: value + description: 'A number indicating level of exposure level ranging from 0 + + to 1. [0, 0.25) is under exposure. [0.25, 0.75) is good exposure. [0.75, + + 1] is over exposure.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: exposure_level + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.Exposure.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Exposure.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Exposure.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.Exposure.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Exposure.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.Exposure.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Exposure.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.ExposureLevel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.ExposureLevel.yml new file mode 100644 index 00000000..fa1c7ee3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.ExposureLevel.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.face.models.ExposureLevel +name: ExposureLevel +fullName: azure.cognitiveservices.vision.face.models.ExposureLevel +module: azure.cognitiveservices.vision.face.models +fields: +- name: good_exposure + uid: azure.cognitiveservices.vision.face.models.ExposureLevel.good_exposure +- name: over_exposure + uid: azure.cognitiveservices.vision.face.models.ExposureLevel.over_exposure +- name: under_exposure + uid: azure.cognitiveservices.vision.face.models.ExposureLevel.under_exposure diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceAttributeType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceAttributeType.yml new file mode 100644 index 00000000..e523d2c0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceAttributeType.yml @@ -0,0 +1,38 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.face.models.FaceAttributeType +name: FaceAttributeType +fullName: azure.cognitiveservices.vision.face.models.FaceAttributeType +module: azure.cognitiveservices.vision.face.models +fields: +- name: accessories + uid: azure.cognitiveservices.vision.face.models.FaceAttributeType.accessories +- name: age + uid: azure.cognitiveservices.vision.face.models.FaceAttributeType.age +- name: blur + uid: azure.cognitiveservices.vision.face.models.FaceAttributeType.blur +- name: emotion + uid: azure.cognitiveservices.vision.face.models.FaceAttributeType.emotion +- name: exposure + uid: azure.cognitiveservices.vision.face.models.FaceAttributeType.exposure +- name: facial_hair + uid: azure.cognitiveservices.vision.face.models.FaceAttributeType.facial_hair +- name: gender + uid: azure.cognitiveservices.vision.face.models.FaceAttributeType.gender +- name: glasses + uid: azure.cognitiveservices.vision.face.models.FaceAttributeType.glasses +- name: hair + uid: azure.cognitiveservices.vision.face.models.FaceAttributeType.hair +- name: head_pose + uid: azure.cognitiveservices.vision.face.models.FaceAttributeType.head_pose +- name: makeup + uid: azure.cognitiveservices.vision.face.models.FaceAttributeType.makeup +- name: mask + uid: azure.cognitiveservices.vision.face.models.FaceAttributeType.mask +- name: noise + uid: azure.cognitiveservices.vision.face.models.FaceAttributeType.noise +- name: occlusion + uid: azure.cognitiveservices.vision.face.models.FaceAttributeType.occlusion +- name: quality_for_recognition + uid: azure.cognitiveservices.vision.face.models.FaceAttributeType.quality_for_recognition +- name: smile + uid: azure.cognitiveservices.vision.face.models.FaceAttributeType.smile diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceAttributes.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceAttributes.yml new file mode 100644 index 00000000..04d68501 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceAttributes.yml @@ -0,0 +1,248 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.FaceAttributes +name: FaceAttributes +fullName: azure.cognitiveservices.vision.face.models.FaceAttributes +module: azure.cognitiveservices.vision.face.models +summary: Face Attributes. +constructor: + syntax: 'FaceAttributes(*, age: float = None, gender=None, smile: float = None, + facial_hair=None, glasses=None, head_pose=None, emotion=None, hair=None, makeup=None, + occlusion=None, accessories=None, blur=None, exposure=None, noise=None, mask=None, + quality_for_recognition=None, **kwargs)' + parameters: + - name: age + description: Age in years + isRequired: true + types: + - + - name: gender + description: 'Possible gender of the face. Possible values include: + + ''male'', ''female''' + isRequired: true + types: + - + - + - name: smile + description: Smile intensity, a number between [0,1] + isRequired: true + types: + - + - name: facial_hair + description: Properties describing facial hair attributes. + isRequired: true + types: + - + - name: glasses + description: 'Glasses type if any of the face. Possible values include: + + ''noGlasses'', ''readingGlasses'', ''sunglasses'', ''swimmingGoggles''' + isRequired: true + types: + - + - + - name: head_pose + description: Properties indicating head pose of the face. + isRequired: true + types: + - + - name: emotion + description: 'Properties describing facial emotion in form of confidence + + ranging from 0 to 1.' + isRequired: true + types: + - + - name: hair + description: Properties describing hair attributes. + isRequired: true + types: + - + - name: makeup + description: 'Properties describing the presence of makeup on a given + + face.' + isRequired: true + types: + - + - name: occlusion + description: Properties describing occlusions on a given face. + isRequired: true + types: + - + - name: accessories + description: Properties describing any accessories on a given face. + isRequired: true + types: + - [] + - name: blur + description: Properties describing any presence of blur within the image. + isRequired: true + types: + - + - name: exposure + description: Properties describing exposure level of the image. + isRequired: true + types: + - + - name: noise + description: Properties describing noise level of the image. + isRequired: true + types: + - + - name: mask + description: Properties describing the presence of a mask on a given face. + isRequired: true + types: + - + - name: quality_for_recognition + description: 'Properties describing the overall image + + quality regarding whether the image being used in the detection is of + + sufficient quality to attempt face recognition on. Possible values + + include: ''Low'', ''Medium'', ''High''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: age + isRequired: true + - name: gender + isRequired: true + - name: smile + isRequired: true + - name: facial_hair + isRequired: true + - name: glasses + isRequired: true + - name: head_pose + isRequired: true + - name: emotion + isRequired: true + - name: hair + isRequired: true + - name: makeup + isRequired: true + - name: occlusion + isRequired: true + - name: accessories + isRequired: true + - name: blur + isRequired: true + - name: exposure + isRequired: true + - name: noise + isRequired: true + - name: mask + isRequired: true + - name: quality_for_recognition + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.FaceAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.FaceAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.FaceAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.FaceAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.FaceAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.FaceAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.FaceAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceLandmarks.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceLandmarks.yml new file mode 100644 index 00000000..0064c91e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceLandmarks.yml @@ -0,0 +1,287 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.FaceLandmarks +name: FaceLandmarks +fullName: azure.cognitiveservices.vision.face.models.FaceLandmarks +module: azure.cognitiveservices.vision.face.models +summary: 'A collection of 27-point face landmarks pointing to the important positions + + of face components.' +constructor: + syntax: FaceLandmarks(*, pupil_left=None, pupil_right=None, nose_tip=None, mouth_left=None, + mouth_right=None, eyebrow_left_outer=None, eyebrow_left_inner=None, eye_left_outer=None, + eye_left_top=None, eye_left_bottom=None, eye_left_inner=None, eyebrow_right_inner=None, + eyebrow_right_outer=None, eye_right_inner=None, eye_right_top=None, eye_right_bottom=None, + eye_right_outer=None, nose_root_left=None, nose_root_right=None, nose_left_alar_top=None, + nose_right_alar_top=None, nose_left_alar_out_tip=None, nose_right_alar_out_tip=None, + upper_lip_top=None, upper_lip_bottom=None, under_lip_top=None, under_lip_bottom=None, + **kwargs) + parameters: + - name: pupil_left + isRequired: true + types: + - + - name: pupil_right + isRequired: true + types: + - + - name: nose_tip + isRequired: true + types: + - + - name: mouth_left + isRequired: true + types: + - + - name: mouth_right + isRequired: true + types: + - + - name: eyebrow_left_outer + isRequired: true + types: + - + - name: eyebrow_left_inner + isRequired: true + types: + - + - name: eye_left_outer + isRequired: true + types: + - + - name: eye_left_top + isRequired: true + types: + - + - name: eye_left_bottom + isRequired: true + types: + - + - name: eye_left_inner + isRequired: true + types: + - + - name: eyebrow_right_inner + isRequired: true + types: + - + - name: eyebrow_right_outer + isRequired: true + types: + - + - name: eye_right_inner + isRequired: true + types: + - + - name: eye_right_top + isRequired: true + types: + - + - name: eye_right_bottom + isRequired: true + types: + - + - name: eye_right_outer + isRequired: true + types: + - + - name: nose_root_left + isRequired: true + types: + - + - name: nose_root_right + isRequired: true + types: + - + - name: nose_left_alar_top + isRequired: true + types: + - + - name: nose_right_alar_top + isRequired: true + types: + - + - name: nose_left_alar_out_tip + isRequired: true + types: + - + - name: nose_right_alar_out_tip + isRequired: true + types: + - + - name: upper_lip_top + isRequired: true + types: + - + - name: upper_lip_bottom + isRequired: true + types: + - + - name: under_lip_top + isRequired: true + types: + - + - name: under_lip_bottom + isRequired: true + types: + - + keywordOnlyParameters: + - name: pupil_left + isRequired: true + - name: pupil_right + isRequired: true + - name: nose_tip + isRequired: true + - name: mouth_left + isRequired: true + - name: mouth_right + isRequired: true + - name: eyebrow_left_outer + isRequired: true + - name: eyebrow_left_inner + isRequired: true + - name: eye_left_outer + isRequired: true + - name: eye_left_top + isRequired: true + - name: eye_left_bottom + isRequired: true + - name: eye_left_inner + isRequired: true + - name: eyebrow_right_inner + isRequired: true + - name: eyebrow_right_outer + isRequired: true + - name: eye_right_inner + isRequired: true + - name: eye_right_top + isRequired: true + - name: eye_right_bottom + isRequired: true + - name: eye_right_outer + isRequired: true + - name: nose_root_left + isRequired: true + - name: nose_root_right + isRequired: true + - name: nose_left_alar_top + isRequired: true + - name: nose_right_alar_top + isRequired: true + - name: nose_left_alar_out_tip + isRequired: true + - name: nose_right_alar_out_tip + isRequired: true + - name: upper_lip_top + isRequired: true + - name: upper_lip_bottom + isRequired: true + - name: under_lip_top + isRequired: true + - name: under_lip_bottom + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.FaceLandmarks.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.FaceLandmarks.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.FaceLandmarks.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.FaceLandmarks.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.FaceLandmarks.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.FaceLandmarks.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.FaceLandmarks.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceList.yml new file mode 100644 index 00000000..06d4b4b1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceList.yml @@ -0,0 +1,160 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.FaceList +name: FaceList +fullName: azure.cognitiveservices.vision.face.models.FaceList +module: azure.cognitiveservices.vision.face.models +summary: 'Face list object. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'FaceList(*, name: str, face_list_id: str, user_data: str = None, recognition_model=''recognition_01'', + persisted_faces=None, **kwargs)' + parameters: + - name: name + description: Required. User defined name, maximum length is 128. + isRequired: true + types: + - + - name: user_data + description: User specified data. Length should not exceed 16KB. + isRequired: true + types: + - + - name: recognition_model + description: 'Possible values include: ''recognition_01'', + + ''recognition_02'', ''recognition_03'', ''recognition_04''. Default value: + + "recognition_01" .' + isRequired: true + types: + - + - + - name: face_list_id + description: Required. FaceListId of the target face list. + isRequired: true + types: + - + - name: persisted_faces + description: Persisted faces within the face list. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: name + isRequired: true + - name: face_list_id + isRequired: true + - name: user_data + isRequired: true + - name: recognition_model + defaultValue: recognition_01 + - name: persisted_faces + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.FaceList.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.FaceList.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.FaceList.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.FaceList.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.FaceList.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.FaceList.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.FaceList.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceRectangle.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceRectangle.yml new file mode 100644 index 00000000..e5dc444d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceRectangle.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.FaceRectangle +name: FaceRectangle +fullName: azure.cognitiveservices.vision.face.models.FaceRectangle +module: azure.cognitiveservices.vision.face.models +summary: 'A rectangle within which a face can be found. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'FaceRectangle(*, width: int, height: int, left: int, top: int, **kwargs)' + parameters: + - name: width + description: Required. The width of the rectangle, in pixels. + isRequired: true + types: + - + - name: height + description: Required. The height of the rectangle, in pixels. + isRequired: true + types: + - + - name: left + description: 'Required. The distance from the left edge if the image to the + + left edge of the rectangle, in pixels.' + isRequired: true + types: + - + - name: top + description: 'Required. The distance from the top edge if the image to the + + top edge of the rectangle, in pixels.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: width + isRequired: true + - name: height + isRequired: true + - name: left + isRequired: true + - name: top + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.FaceRectangle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.FaceRectangle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.FaceRectangle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.FaceRectangle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.FaceRectangle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.FaceRectangle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.FaceRectangle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FacialHair.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FacialHair.yml new file mode 100644 index 00000000..23a7da4b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FacialHair.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.FacialHair +name: FacialHair +fullName: azure.cognitiveservices.vision.face.models.FacialHair +module: azure.cognitiveservices.vision.face.models +summary: Properties describing facial hair attributes. +constructor: + syntax: 'FacialHair(*, moustache: float = None, beard: float = None, sideburns: + float = None, **kwargs)' + parameters: + - name: moustache + isRequired: true + types: + - + - name: beard + isRequired: true + types: + - + - name: sideburns + isRequired: true + types: + - + keywordOnlyParameters: + - name: moustache + isRequired: true + - name: beard + isRequired: true + - name: sideburns + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.FacialHair.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.FacialHair.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.FacialHair.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.FacialHair.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.FacialHair.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.FacialHair.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.FacialHair.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FindSimilarMatchMode.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FindSimilarMatchMode.yml new file mode 100644 index 00000000..167517a4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FindSimilarMatchMode.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.face.models.FindSimilarMatchMode +name: FindSimilarMatchMode +fullName: azure.cognitiveservices.vision.face.models.FindSimilarMatchMode +module: azure.cognitiveservices.vision.face.models +fields: +- name: match_face + uid: azure.cognitiveservices.vision.face.models.FindSimilarMatchMode.match_face +- name: match_person + uid: azure.cognitiveservices.vision.face.models.FindSimilarMatchMode.match_person diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FindSimilarRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FindSimilarRequest.yml new file mode 100644 index 00000000..c6efecad --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FindSimilarRequest.yml @@ -0,0 +1,200 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.FindSimilarRequest +name: FindSimilarRequest +fullName: azure.cognitiveservices.vision.face.models.FindSimilarRequest +module: azure.cognitiveservices.vision.face.models +summary: 'Request body for find similar operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'FindSimilarRequest(*, face_id: str, face_list_id: str = None, large_face_list_id: + str = None, face_ids=None, max_num_of_candidates_returned: int = 20, mode=''matchPerson'', + **kwargs)' + parameters: + - name: face_id + description: 'Required. FaceId of the query face. User needs to call + + Face - Detect first to get a valid faceId. Note that this faceId is not + + persisted and will expire at the time specified by faceIdTimeToLive after + + the detection call' + isRequired: true + types: + - + - name: face_list_id + description: 'An existing user-specified unique candidate face + + list, created in Face List - Create a Face List. Face list contains a set + + of persistedFaceIds which are persisted and will never expire. Parameter + + faceListId, largeFaceListId and faceIds should not be provided at the same + + time.' + isRequired: true + types: + - + - name: large_face_list_id + description: 'An existing user-specified unique candidate + + large face list, created in LargeFaceList - Create. Large face list + + contains a set of persistedFaceIds which are persisted and will never + + expire. Parameter faceListId, largeFaceListId and faceIds should not be + + provided at the same time.' + isRequired: true + types: + - + - name: face_ids + description: 'An array of candidate faceIds. All of them are created by + + Face - Detect and the faceIds will expire at the time specified by + + faceIdTimeToLive after the detection call. The number of faceIds is + + limited to 1000. Parameter faceListId, largeFaceListId and faceIds should + + not be provided at the same time.' + isRequired: true + types: + - [] + - name: max_num_of_candidates_returned + description: 'The number of top similar faces + + returned. The valid range is [1, 1000]. Default value: 20 .' + isRequired: true + types: + - + - name: mode + description: 'Similar face searching mode. It can be "matchPerson" or + + "matchFace". Possible values include: ''matchPerson'', ''matchFace''. Default + + value: "matchPerson" .' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: face_id + isRequired: true + - name: face_list_id + isRequired: true + - name: large_face_list_id + isRequired: true + - name: face_ids + isRequired: true + - name: max_num_of_candidates_returned + defaultValue: '20' + - name: mode + defaultValue: matchPerson +methods: +- uid: azure.cognitiveservices.vision.face.models.FindSimilarRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.FindSimilarRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.FindSimilarRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.FindSimilarRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.FindSimilarRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.FindSimilarRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.FindSimilarRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Gender.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Gender.yml new file mode 100644 index 00000000..2aae889e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Gender.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.face.models.Gender +name: Gender +fullName: azure.cognitiveservices.vision.face.models.Gender +module: azure.cognitiveservices.vision.face.models +fields: +- name: female + uid: azure.cognitiveservices.vision.face.models.Gender.female +- name: male + uid: azure.cognitiveservices.vision.face.models.Gender.male diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.GlassesType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.GlassesType.yml new file mode 100644 index 00000000..0eff448b --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.GlassesType.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.face.models.GlassesType +name: GlassesType +fullName: azure.cognitiveservices.vision.face.models.GlassesType +module: azure.cognitiveservices.vision.face.models +fields: +- name: no_glasses + uid: azure.cognitiveservices.vision.face.models.GlassesType.no_glasses +- name: reading_glasses + uid: azure.cognitiveservices.vision.face.models.GlassesType.reading_glasses +- name: sunglasses + uid: azure.cognitiveservices.vision.face.models.GlassesType.sunglasses +- name: swimming_goggles + uid: azure.cognitiveservices.vision.face.models.GlassesType.swimming_goggles diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.GroupRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.GroupRequest.yml new file mode 100644 index 00000000..f6455487 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.GroupRequest.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.GroupRequest +name: GroupRequest +fullName: azure.cognitiveservices.vision.face.models.GroupRequest +module: azure.cognitiveservices.vision.face.models +summary: 'Request body for group request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: GroupRequest(*, face_ids, **kwargs) + parameters: + - name: face_ids + description: 'Required. Array of candidate faceId created by Face - + + Detect. The maximum is 1000 faces' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: face_ids + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.GroupRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.GroupRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.GroupRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.GroupRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.GroupRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.GroupRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.GroupRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.GroupResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.GroupResult.yml new file mode 100644 index 00000000..7a3f7ddd --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.GroupResult.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.GroupResult +name: GroupResult +fullName: azure.cognitiveservices.vision.face.models.GroupResult +module: azure.cognitiveservices.vision.face.models +summary: 'An array of face groups based on face similarity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: GroupResult(*, groups, messy_group=None, **kwargs) + parameters: + - name: groups + description: 'Required. A partition of the original faces based on face + + similarity. Groups are ranked by number of faces' + isRequired: true + types: + - [[]] + - name: messy_group + description: 'Face ids array of faces that cannot find any similar + + faces from original faces.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: groups + isRequired: true + - name: messy_group + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.GroupResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.GroupResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.GroupResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.GroupResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.GroupResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.GroupResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.GroupResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Hair.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Hair.yml new file mode 100644 index 00000000..f835ad73 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Hair.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.Hair +name: Hair +fullName: azure.cognitiveservices.vision.face.models.Hair +module: azure.cognitiveservices.vision.face.models +summary: Properties describing hair attributes. +constructor: + syntax: 'Hair(*, bald: float = None, invisible: bool = None, hair_color=None, **kwargs)' + parameters: + - name: bald + description: 'A number describing confidence level of whether the person is + + bald.' + isRequired: true + types: + - + - name: invisible + description: 'A boolean value describing whether the hair is visible + + in the image.' + isRequired: true + types: + - + - name: hair_color + description: 'An array of candidate colors and confidence level in + + the presence of each.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: bald + isRequired: true + - name: invisible + isRequired: true + - name: hair_color + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.Hair.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Hair.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Hair.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.Hair.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Hair.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.Hair.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Hair.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.HairColor.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.HairColor.yml new file mode 100644 index 00000000..df4aa326 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.HairColor.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.HairColor +name: HairColor +fullName: azure.cognitiveservices.vision.face.models.HairColor +module: azure.cognitiveservices.vision.face.models +summary: Hair color and associated confidence. +constructor: + syntax: 'HairColor(*, color=None, confidence: float = None, **kwargs)' + parameters: + - name: color + description: 'Name of the hair color. Possible values include: ''unknown'', + + ''white'', ''gray'', ''blond'', ''brown'', ''red'', ''black'', ''other''' + isRequired: true + types: + - + - + - name: confidence + description: Confidence level of the color + isRequired: true + types: + - + keywordOnlyParameters: + - name: color + isRequired: true + - name: confidence + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.HairColor.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.HairColor.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.HairColor.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.HairColor.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.HairColor.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.HairColor.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.HairColor.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.HairColorType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.HairColorType.yml new file mode 100644 index 00000000..f17a3453 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.HairColorType.yml @@ -0,0 +1,22 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.face.models.HairColorType +name: HairColorType +fullName: azure.cognitiveservices.vision.face.models.HairColorType +module: azure.cognitiveservices.vision.face.models +fields: +- name: black + uid: azure.cognitiveservices.vision.face.models.HairColorType.black +- name: blond + uid: azure.cognitiveservices.vision.face.models.HairColorType.blond +- name: brown + uid: azure.cognitiveservices.vision.face.models.HairColorType.brown +- name: gray + uid: azure.cognitiveservices.vision.face.models.HairColorType.gray +- name: other + uid: azure.cognitiveservices.vision.face.models.HairColorType.other +- name: red + uid: azure.cognitiveservices.vision.face.models.HairColorType.red +- name: unknown + uid: azure.cognitiveservices.vision.face.models.HairColorType.unknown +- name: white + uid: azure.cognitiveservices.vision.face.models.HairColorType.white diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.HeadPose.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.HeadPose.yml new file mode 100644 index 00000000..588acf39 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.HeadPose.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.HeadPose +name: HeadPose +fullName: azure.cognitiveservices.vision.face.models.HeadPose +module: azure.cognitiveservices.vision.face.models +summary: Properties indicating head pose of the face. +constructor: + syntax: 'HeadPose(*, roll: float = None, yaw: float = None, pitch: float = None, + **kwargs)' + parameters: + - name: roll + isRequired: true + types: + - + - name: yaw + isRequired: true + types: + - + - name: pitch + isRequired: true + types: + - + keywordOnlyParameters: + - name: roll + isRequired: true + - name: yaw + isRequired: true + - name: pitch + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.HeadPose.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.HeadPose.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.HeadPose.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.HeadPose.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.HeadPose.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.HeadPose.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.HeadPose.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.IdentifyCandidate.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.IdentifyCandidate.yml new file mode 100644 index 00000000..4f131f80 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.IdentifyCandidate.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.IdentifyCandidate +name: IdentifyCandidate +fullName: azure.cognitiveservices.vision.face.models.IdentifyCandidate +module: azure.cognitiveservices.vision.face.models +summary: 'All possible faces that may qualify. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'IdentifyCandidate(*, person_id: str, confidence: float, **kwargs)' + parameters: + - name: person_id + description: Required. Id of candidate + isRequired: true + types: + - + - name: confidence + description: 'Required. Confidence threshold of identification, used + + to judge whether one face belong to one person. The range of + + confidenceThreshold is [0, 1] (default specified by algorithm).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: person_id + isRequired: true + - name: confidence + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.IdentifyCandidate.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.IdentifyCandidate.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.IdentifyCandidate.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.IdentifyCandidate.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.IdentifyCandidate.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.IdentifyCandidate.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.IdentifyCandidate.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.IdentifyRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.IdentifyRequest.yml new file mode 100644 index 00000000..f04c1a7f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.IdentifyRequest.yml @@ -0,0 +1,178 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.IdentifyRequest +name: IdentifyRequest +fullName: azure.cognitiveservices.vision.face.models.IdentifyRequest +module: azure.cognitiveservices.vision.face.models +summary: 'Request body for identify face operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'IdentifyRequest(*, face_ids, person_group_id: str = None, large_person_group_id: + str = None, max_num_of_candidates_returned: int = 1, confidence_threshold: float + = None, **kwargs)' + parameters: + - name: face_ids + description: 'Required. Array of query faces faceIds, created by the + + Face - Detect. Each of the faces are identified independently. The valid + + number of faceIds is between [1, 10].' + isRequired: true + types: + - [] + - name: person_group_id + description: 'PersonGroupId of the target person group, created + + by PersonGroup - Create. Parameter personGroupId and largePersonGroupId + + should not be provided at the same time.' + isRequired: true + types: + - + - name: large_person_group_id + description: 'LargePersonGroupId of the target large + + person group, created by LargePersonGroup - Create. Parameter + + personGroupId and largePersonGroupId should not be provided at the same + + time.' + isRequired: true + types: + - + - name: max_num_of_candidates_returned + description: 'The range of + + maxNumOfCandidatesReturned is between 1 and 100 (default is 1). Default + + value: 1 .' + isRequired: true + types: + - + - name: confidence_threshold + description: 'Confidence threshold of identification, used + + to judge whether one face belong to one person. The range of + + confidenceThreshold is [0, 1] (default specified by algorithm).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: face_ids + isRequired: true + - name: person_group_id + isRequired: true + - name: large_person_group_id + isRequired: true + - name: max_num_of_candidates_returned + defaultValue: '1' + - name: confidence_threshold + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.IdentifyRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.IdentifyRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.IdentifyRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.IdentifyRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.IdentifyRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.IdentifyRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.IdentifyRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.IdentifyResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.IdentifyResult.yml new file mode 100644 index 00000000..d8662071 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.IdentifyResult.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.IdentifyResult +name: IdentifyResult +fullName: azure.cognitiveservices.vision.face.models.IdentifyResult +module: azure.cognitiveservices.vision.face.models +summary: 'Response body for identify face operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'IdentifyResult(*, face_id: str, candidates, **kwargs)' + parameters: + - name: face_id + description: Required. FaceId of the query face + isRequired: true + types: + - + - name: candidates + description: 'Required. Identified person candidates for that face + + (ranked by confidence). Array size should be no larger than input + + maxNumOfCandidatesReturned. If no person is identified, will return an + + empty array.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: face_id + isRequired: true + - name: candidates + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.IdentifyResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.IdentifyResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.IdentifyResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.IdentifyResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.IdentifyResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.IdentifyResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.IdentifyResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.ImageUrl.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.ImageUrl.yml new file mode 100644 index 00000000..02eb64f4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.ImageUrl.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.ImageUrl +name: ImageUrl +fullName: azure.cognitiveservices.vision.face.models.ImageUrl +module: azure.cognitiveservices.vision.face.models +summary: 'ImageUrl. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ImageUrl(*, url: str, **kwargs)' + parameters: + - name: url + description: Required. Publicly reachable URL of an image + isRequired: true + types: + - + keywordOnlyParameters: + - name: url + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.ImageUrl.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.ImageUrl.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.ImageUrl.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.ImageUrl.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.ImageUrl.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.ImageUrl.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.ImageUrl.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.LargeFaceList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.LargeFaceList.yml new file mode 100644 index 00000000..b51018d5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.LargeFaceList.yml @@ -0,0 +1,155 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.LargeFaceList +name: LargeFaceList +fullName: azure.cognitiveservices.vision.face.models.LargeFaceList +module: azure.cognitiveservices.vision.face.models +summary: 'Large face list object. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'LargeFaceList(*, name: str, large_face_list_id: str, user_data: str = None, + recognition_model=''recognition_01'', **kwargs)' + parameters: + - name: name + description: Required. User defined name, maximum length is 128. + isRequired: true + types: + - + - name: user_data + description: User specified data. Length should not exceed 16KB. + isRequired: true + types: + - + - name: recognition_model + description: 'Possible values include: ''recognition_01'', + + ''recognition_02'', ''recognition_03'', ''recognition_04''. Default value: + + "recognition_01" .' + isRequired: true + types: + - + - + - name: large_face_list_id + description: 'Required. LargeFaceListId of the target large + + face list.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: large_face_list_id + isRequired: true + - name: user_data + isRequired: true + - name: recognition_model + defaultValue: recognition_01 +methods: +- uid: azure.cognitiveservices.vision.face.models.LargeFaceList.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.LargeFaceList.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.LargeFaceList.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.LargeFaceList.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.LargeFaceList.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.LargeFaceList.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.LargeFaceList.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.LargePersonGroup.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.LargePersonGroup.yml new file mode 100644 index 00000000..ce395d96 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.LargePersonGroup.yml @@ -0,0 +1,155 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.LargePersonGroup +name: LargePersonGroup +fullName: azure.cognitiveservices.vision.face.models.LargePersonGroup +module: azure.cognitiveservices.vision.face.models +summary: 'Large person group object. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'LargePersonGroup(*, name: str, large_person_group_id: str, user_data: str + = None, recognition_model=''recognition_01'', **kwargs)' + parameters: + - name: name + description: Required. User defined name, maximum length is 128. + isRequired: true + types: + - + - name: user_data + description: User specified data. Length should not exceed 16KB. + isRequired: true + types: + - + - name: recognition_model + description: 'Possible values include: ''recognition_01'', + + ''recognition_02'', ''recognition_03'', ''recognition_04''. Default value: + + "recognition_01" .' + isRequired: true + types: + - + - + - name: large_person_group_id + description: 'Required. LargePersonGroupId of the target + + large person groups' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: large_person_group_id + isRequired: true + - name: user_data + isRequired: true + - name: recognition_model + defaultValue: recognition_01 +methods: +- uid: azure.cognitiveservices.vision.face.models.LargePersonGroup.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.LargePersonGroup.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.LargePersonGroup.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.LargePersonGroup.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.LargePersonGroup.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.LargePersonGroup.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.LargePersonGroup.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Makeup.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Makeup.yml new file mode 100644 index 00000000..ebbb3014 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Makeup.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.Makeup +name: Makeup +fullName: azure.cognitiveservices.vision.face.models.Makeup +module: azure.cognitiveservices.vision.face.models +summary: Properties describing the presence of makeup on a given face. +constructor: + syntax: 'Makeup(*, eye_makeup: bool = None, lip_makeup: bool = None, **kwargs)' + parameters: + - name: eye_makeup + description: 'A boolean value describing whether eye makeup is + + present on a face.' + isRequired: true + types: + - + - name: lip_makeup + description: 'A boolean value describing whether lip makeup is + + present on a face.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: eye_makeup + isRequired: true + - name: lip_makeup + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.Makeup.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Makeup.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Makeup.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.Makeup.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Makeup.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.Makeup.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Makeup.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Mask.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Mask.yml new file mode 100644 index 00000000..8f2aafd0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Mask.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.Mask +name: Mask +fullName: azure.cognitiveservices.vision.face.models.Mask +module: azure.cognitiveservices.vision.face.models +summary: Properties describing the presence of a mask on a given face. +constructor: + syntax: 'Mask(*, type=None, nose_and_mouth_covered: bool = None, **kwargs)' + parameters: + - name: type + description: 'Mask type if any of the face. Possible values include: + + ''noMask'', ''faceMask'', ''otherMaskOrOcclusion'', ''uncertain''' + isRequired: true + types: + - + - + - name: nose_and_mouth_covered + description: 'A boolean value indicating whether nose and + + mouth are covered.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: type + isRequired: true + - name: nose_and_mouth_covered + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.Mask.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Mask.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Mask.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.Mask.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Mask.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.Mask.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Mask.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.MaskType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.MaskType.yml new file mode 100644 index 00000000..40522f49 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.MaskType.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.face.models.MaskType +name: MaskType +fullName: azure.cognitiveservices.vision.face.models.MaskType +module: azure.cognitiveservices.vision.face.models +fields: +- name: face_mask + uid: azure.cognitiveservices.vision.face.models.MaskType.face_mask +- name: no_mask + uid: azure.cognitiveservices.vision.face.models.MaskType.no_mask +- name: other_mask_or_occlusion + uid: azure.cognitiveservices.vision.face.models.MaskType.other_mask_or_occlusion +- name: uncertain + uid: azure.cognitiveservices.vision.face.models.MaskType.uncertain diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.MetaDataContract.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.MetaDataContract.yml new file mode 100644 index 00000000..6d239dd0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.MetaDataContract.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.MetaDataContract +name: MetaDataContract +fullName: azure.cognitiveservices.vision.face.models.MetaDataContract +module: azure.cognitiveservices.vision.face.models +summary: 'A combination of user defined name and user specified data and recognition + + model name for largePersonGroup/personGroup, and largeFaceList/faceList. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MetaDataContract(*, name: str, user_data: str = None, recognition_model=''recognition_01'', + **kwargs)' + parameters: + - name: name + description: Required. User defined name, maximum length is 128. + isRequired: true + types: + - + - name: user_data + description: User specified data. Length should not exceed 16KB. + isRequired: true + types: + - + - name: recognition_model + description: 'Possible values include: ''recognition_01'', + + ''recognition_02'', ''recognition_03'', ''recognition_04''. Default value: + + "recognition_01" .' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: user_data + isRequired: true + - name: recognition_model + defaultValue: recognition_01 +methods: +- uid: azure.cognitiveservices.vision.face.models.MetaDataContract.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.MetaDataContract.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.MetaDataContract.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.MetaDataContract.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.MetaDataContract.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.MetaDataContract.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.MetaDataContract.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.NameAndUserDataContract.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.NameAndUserDataContract.yml new file mode 100644 index 00000000..f1cd9909 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.NameAndUserDataContract.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.NameAndUserDataContract +name: NameAndUserDataContract +fullName: azure.cognitiveservices.vision.face.models.NameAndUserDataContract +module: azure.cognitiveservices.vision.face.models +summary: 'A combination of user defined name and user specified data for the person, + + largePersonGroup/personGroup, and largeFaceList/faceList.' +constructor: + syntax: 'NameAndUserDataContract(*, name: str = None, user_data: str = None, **kwargs)' + parameters: + - name: name + description: User defined name, maximum length is 128. + isRequired: true + types: + - + - name: user_data + description: User specified data. Length should not exceed 16KB. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: user_data + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.NameAndUserDataContract.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.NameAndUserDataContract.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.NameAndUserDataContract.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.NameAndUserDataContract.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.NameAndUserDataContract.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.NameAndUserDataContract.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.NameAndUserDataContract.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Noise.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Noise.yml new file mode 100644 index 00000000..2ee31df6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Noise.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.Noise +name: Noise +fullName: azure.cognitiveservices.vision.face.models.Noise +module: azure.cognitiveservices.vision.face.models +summary: Properties describing noise level of the image. +constructor: + syntax: 'Noise(*, noise_level=None, value: float = None, **kwargs)' + parameters: + - name: noise_level + description: 'An enum value indicating level of noise. Possible + + values include: ''Low'', ''Medium'', ''High''' + isRequired: true + types: + - + - + - name: value + description: 'A number indicating level of noise level ranging from 0 to + + 1. [0, 0.25) is under exposure. [0.25, 0.75) is good exposure. [0.75, 1] + + is over exposure. [0, 0.3) is low noise level. [0.3, 0.7) is medium noise + + level. [0.7, 1] is high noise level.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: noise_level + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.Noise.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Noise.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Noise.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.Noise.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Noise.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.Noise.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Noise.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.NoiseLevel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.NoiseLevel.yml new file mode 100644 index 00000000..cad035d3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.NoiseLevel.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.face.models.NoiseLevel +name: NoiseLevel +fullName: azure.cognitiveservices.vision.face.models.NoiseLevel +module: azure.cognitiveservices.vision.face.models +fields: +- name: high + uid: azure.cognitiveservices.vision.face.models.NoiseLevel.high +- name: low + uid: azure.cognitiveservices.vision.face.models.NoiseLevel.low +- name: medium + uid: azure.cognitiveservices.vision.face.models.NoiseLevel.medium diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Occlusion.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Occlusion.yml new file mode 100644 index 00000000..2f456309 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Occlusion.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.Occlusion +name: Occlusion +fullName: azure.cognitiveservices.vision.face.models.Occlusion +module: azure.cognitiveservices.vision.face.models +summary: Properties describing occlusions on a given face. +constructor: + syntax: 'Occlusion(*, forehead_occluded: bool = None, eye_occluded: bool = None, + mouth_occluded: bool = None, **kwargs)' + parameters: + - name: forehead_occluded + description: 'A boolean value indicating whether forehead is + + occluded.' + isRequired: true + types: + - + - name: eye_occluded + description: A boolean value indicating whether eyes are occluded. + isRequired: true + types: + - + - name: mouth_occluded + description: 'A boolean value indicating whether the mouth is + + occluded.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: forehead_occluded + isRequired: true + - name: eye_occluded + isRequired: true + - name: mouth_occluded + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.Occlusion.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Occlusion.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Occlusion.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.Occlusion.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Occlusion.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.Occlusion.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Occlusion.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.OperationStatus.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.OperationStatus.yml new file mode 100644 index 00000000..780ae7d7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.OperationStatus.yml @@ -0,0 +1,198 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.OperationStatus +name: OperationStatus +fullName: azure.cognitiveservices.vision.face.models.OperationStatus +module: azure.cognitiveservices.vision.face.models +summary: 'Operation status object. Operation refers to the asynchronous backend task + + including taking a snapshot and applying a snapshot. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'OperationStatus(*, status, created_time, last_action_time=None, resource_location: + str = None, message: str = None, **kwargs)' + parameters: + - name: status + description: 'Required. Operation status: notstarted, running, succeeded, + + failed. If the operation is requested and waiting to perform, the status + + is notstarted. If the operation is ongoing in backend, the status is + + running. Status succeeded means the operation is completed successfully, + + specifically for snapshot taking operation, it illustrates the snapshot is + + well taken and ready to apply, and for snapshot applying operation, it + + presents the target object has finished creating by the snapshot and ready + + to be used. Status failed is often caused by editing the source object + + while taking the snapshot or editing the target object while applying the + + snapshot before completion, see the field "message" to check the failure + + reason. Possible values include: ''notstarted'', ''running'', ''succeeded'', + + ''failed''' + isRequired: true + types: + - + - + - name: created_time + description: 'Required. A combined UTC date and time string that + + describes the time when the operation (take or apply a snapshot) is + + requested. E.g. 2018-12-25T11:41:02.2331413Z.' + isRequired: true + types: + - + - name: last_action_time + description: 'A combined UTC date and time string that + + describes the last time the operation (take or apply a snapshot) is + + actively migrating data. The lastActionTime will keep increasing until the + + operation finishes. E.g. 2018-12-25T11:51:27.8705696Z.' + isRequired: true + types: + - + - name: resource_location + description: 'When the operation succeeds successfully, for + + snapshot taking operation the snapshot id will be included in this field, + + and for snapshot applying operation, the path to get the target object + + will be returned in this field.' + isRequired: true + types: + - + - name: message + description: 'Show failure message when operation fails (omitted when + + operation succeeds).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: status + isRequired: true + - name: created_time + isRequired: true + - name: last_action_time + isRequired: true + - name: resource_location + isRequired: true + - name: message + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.OperationStatus.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.OperationStatus.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.OperationStatus.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.OperationStatus.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.OperationStatus.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.OperationStatus.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.OperationStatus.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.OperationStatusType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.OperationStatusType.yml new file mode 100644 index 00000000..d96a6b4a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.OperationStatusType.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.face.models.OperationStatusType +name: OperationStatusType +fullName: azure.cognitiveservices.vision.face.models.OperationStatusType +module: azure.cognitiveservices.vision.face.models +fields: +- name: failed + uid: azure.cognitiveservices.vision.face.models.OperationStatusType.failed +- name: notstarted + uid: azure.cognitiveservices.vision.face.models.OperationStatusType.notstarted +- name: running + uid: azure.cognitiveservices.vision.face.models.OperationStatusType.running +- name: succeeded + uid: azure.cognitiveservices.vision.face.models.OperationStatusType.succeeded diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.PersistedFace.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.PersistedFace.yml new file mode 100644 index 00000000..a0d8827c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.PersistedFace.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.PersistedFace +name: PersistedFace +fullName: azure.cognitiveservices.vision.face.models.PersistedFace +module: azure.cognitiveservices.vision.face.models +summary: 'PersonFace object. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PersistedFace(*, persisted_face_id: str, user_data: str = None, **kwargs)' + parameters: + - name: persisted_face_id + description: 'Required. The persistedFaceId of the target + + face, which is persisted and will not expire. Different from faceId + + created by Face - Detect and will expire in at the time specified by + + faceIdTimeToLive after the detection call.' + isRequired: true + types: + - + - name: user_data + description: 'User-provided data attached to the face. The size limit + + is 1KB.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: persisted_face_id + isRequired: true + - name: user_data + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.PersistedFace.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.PersistedFace.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.PersistedFace.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.PersistedFace.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.PersistedFace.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.PersistedFace.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.PersistedFace.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Person.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Person.yml new file mode 100644 index 00000000..17915a6c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Person.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.Person +name: Person +fullName: azure.cognitiveservices.vision.face.models.Person +module: azure.cognitiveservices.vision.face.models +summary: 'Person object. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Person(*, person_id: str, name: str = None, user_data: str = None, persisted_face_ids=None, + **kwargs)' + parameters: + - name: name + description: User defined name, maximum length is 128. + isRequired: true + types: + - + - name: user_data + description: User specified data. Length should not exceed 16KB. + isRequired: true + types: + - + - name: person_id + description: Required. PersonId of the target face list. + isRequired: true + types: + - + - name: persisted_face_ids + description: 'PersistedFaceIds of registered faces in the + + person. These persistedFaceIds are returned from Person - Add a Person + + Face, and will not expire.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: person_id + isRequired: true + - name: name + isRequired: true + - name: user_data + isRequired: true + - name: persisted_face_ids + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.Person.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Person.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Person.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.Person.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Person.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.Person.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Person.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.PersonGroup.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.PersonGroup.yml new file mode 100644 index 00000000..4b40fc80 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.PersonGroup.yml @@ -0,0 +1,155 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.PersonGroup +name: PersonGroup +fullName: azure.cognitiveservices.vision.face.models.PersonGroup +module: azure.cognitiveservices.vision.face.models +summary: 'Person group object. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PersonGroup(*, name: str, person_group_id: str, user_data: str = None, + recognition_model=''recognition_01'', **kwargs)' + parameters: + - name: name + description: Required. User defined name, maximum length is 128. + isRequired: true + types: + - + - name: user_data + description: User specified data. Length should not exceed 16KB. + isRequired: true + types: + - + - name: recognition_model + description: 'Possible values include: ''recognition_01'', + + ''recognition_02'', ''recognition_03'', ''recognition_04''. Default value: + + "recognition_01" .' + isRequired: true + types: + - + - + - name: person_group_id + description: 'Required. PersonGroupId of the target person + + group.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: person_group_id + isRequired: true + - name: user_data + isRequired: true + - name: recognition_model + defaultValue: recognition_01 +methods: +- uid: azure.cognitiveservices.vision.face.models.PersonGroup.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.PersonGroup.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.PersonGroup.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.PersonGroup.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.PersonGroup.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.PersonGroup.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.PersonGroup.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.QualityForRecognition.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.QualityForRecognition.yml new file mode 100644 index 00000000..9e70caba --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.QualityForRecognition.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.face.models.QualityForRecognition +name: QualityForRecognition +fullName: azure.cognitiveservices.vision.face.models.QualityForRecognition +module: azure.cognitiveservices.vision.face.models +fields: +- name: high + uid: azure.cognitiveservices.vision.face.models.QualityForRecognition.high +- name: low + uid: azure.cognitiveservices.vision.face.models.QualityForRecognition.low +- name: medium + uid: azure.cognitiveservices.vision.face.models.QualityForRecognition.medium diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.RecognitionModel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.RecognitionModel.yml new file mode 100644 index 00000000..72906eba --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.RecognitionModel.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.face.models.RecognitionModel +name: RecognitionModel +fullName: azure.cognitiveservices.vision.face.models.RecognitionModel +module: azure.cognitiveservices.vision.face.models +fields: +- name: recognition_01 + uid: azure.cognitiveservices.vision.face.models.RecognitionModel.recognition_01 +- name: recognition_02 + uid: azure.cognitiveservices.vision.face.models.RecognitionModel.recognition_02 +- name: recognition_03 + uid: azure.cognitiveservices.vision.face.models.RecognitionModel.recognition_03 +- name: recognition_04 + uid: azure.cognitiveservices.vision.face.models.RecognitionModel.recognition_04 diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.SimilarFace.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.SimilarFace.yml new file mode 100644 index 00000000..67657360 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.SimilarFace.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.SimilarFace +name: SimilarFace +fullName: azure.cognitiveservices.vision.face.models.SimilarFace +module: azure.cognitiveservices.vision.face.models +summary: 'Response body for find similar face operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SimilarFace(*, confidence: float, face_id: str = None, persisted_face_id: + str = None, **kwargs)' + parameters: + - name: face_id + description: 'FaceId of candidate face when find by faceIds. faceId is + + created by Face - Detect and will expire at the time specified by + + faceIdTimeToLive after the detection call' + isRequired: true + types: + - + - name: persisted_face_id + description: 'PersistedFaceId of candidate face when find by + + faceListId. persistedFaceId in face list is persisted and will not expire. + + As showed in below response' + isRequired: true + types: + - + - name: confidence + description: 'Required. Similarity confidence of the candidate face. + + The higher confidence, the more similar. Range between [0,1].' + isRequired: true + types: + - + keywordOnlyParameters: + - name: confidence + isRequired: true + - name: face_id + isRequired: true + - name: persisted_face_id + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.SimilarFace.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.SimilarFace.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.SimilarFace.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.SimilarFace.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.SimilarFace.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.SimilarFace.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.SimilarFace.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Snapshot.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Snapshot.yml new file mode 100644 index 00000000..6d27b4fe --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Snapshot.yml @@ -0,0 +1,196 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.Snapshot +name: Snapshot +fullName: azure.cognitiveservices.vision.face.models.Snapshot +module: azure.cognitiveservices.vision.face.models +summary: 'Snapshot object. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Snapshot(*, id: str, account: str, type, apply_scope, created_time, last_update_time, + user_data: str = None, **kwargs)' + parameters: + - name: id + description: Required. Snapshot id. + isRequired: true + types: + - + - name: account + description: 'Required. Azure Cognitive Service Face account id of the + + subscriber who created the snapshot by Snapshot - Take.' + isRequired: true + types: + - + - name: type + description: 'Required. Type of the source object in the snapshot, + + specified by the subscriber who created the snapshot when calling Snapshot + + - Take. Currently FaceList, PersonGroup, LargeFaceList and + + LargePersonGroup are supported. Possible values include: ''FaceList'', + + ''LargeFaceList'', ''LargePersonGroup'', ''PersonGroup''' + isRequired: true + types: + - + - + - name: apply_scope + description: 'Required. Array of the target Face subscription ids + + for the snapshot, specified by the user who created the snapshot when + + calling Snapshot - Take. For each snapshot, only subscriptions included in + + the applyScope of Snapshot - Take can apply it.' + isRequired: true + types: + - [] + - name: user_data + description: 'User specified data about the snapshot for any purpose. + + Length should not exceed 16KB.' + isRequired: true + types: + - + - name: created_time + description: 'Required. A combined UTC date and time string that + + describes the created time of the snapshot. E.g. + + 2018-12-25T11:41:02.2331413Z.' + isRequired: true + types: + - + - name: last_update_time + description: 'Required. A combined UTC date and time string + + that describes the last time when the snapshot was created or updated by + + Snapshot - Update. E.g. 2018-12-25T11:51:27.8705696Z.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: account + isRequired: true + - name: type + isRequired: true + - name: apply_scope + isRequired: true + - name: created_time + isRequired: true + - name: last_update_time + isRequired: true + - name: user_data + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.Snapshot.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Snapshot.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Snapshot.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.Snapshot.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.Snapshot.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.Snapshot.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.Snapshot.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.SnapshotApplyMode.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.SnapshotApplyMode.yml new file mode 100644 index 00000000..2dbdf2e5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.SnapshotApplyMode.yml @@ -0,0 +1,8 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.face.models.SnapshotApplyMode +name: SnapshotApplyMode +fullName: azure.cognitiveservices.vision.face.models.SnapshotApplyMode +module: azure.cognitiveservices.vision.face.models +fields: +- name: create_new + uid: azure.cognitiveservices.vision.face.models.SnapshotApplyMode.create_new diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.SnapshotObjectType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.SnapshotObjectType.yml new file mode 100644 index 00000000..1c69360d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.SnapshotObjectType.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.face.models.SnapshotObjectType +name: SnapshotObjectType +fullName: azure.cognitiveservices.vision.face.models.SnapshotObjectType +module: azure.cognitiveservices.vision.face.models +fields: +- name: face_list + uid: azure.cognitiveservices.vision.face.models.SnapshotObjectType.face_list +- name: large_face_list + uid: azure.cognitiveservices.vision.face.models.SnapshotObjectType.large_face_list +- name: large_person_group + uid: azure.cognitiveservices.vision.face.models.SnapshotObjectType.large_person_group +- name: person_group + uid: azure.cognitiveservices.vision.face.models.SnapshotObjectType.person_group diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.TakeSnapshotRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.TakeSnapshotRequest.yml new file mode 100644 index 00000000..609f9da3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.TakeSnapshotRequest.yml @@ -0,0 +1,163 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.TakeSnapshotRequest +name: TakeSnapshotRequest +fullName: azure.cognitiveservices.vision.face.models.TakeSnapshotRequest +module: azure.cognitiveservices.vision.face.models +summary: 'Request body for taking snapshot operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TakeSnapshotRequest(*, type, object_id: str, apply_scope, user_data: str + = None, **kwargs)' + parameters: + - name: type + description: 'Required. User specified type for the source object to take + + snapshot from. Currently FaceList, PersonGroup, LargeFaceList and + + LargePersonGroup are supported. Possible values include: ''FaceList'', + + ''LargeFaceList'', ''LargePersonGroup'', ''PersonGroup''' + isRequired: true + types: + - + - + - name: object_id + description: 'Required. User specified source object id to take + + snapshot from.' + isRequired: true + types: + - + - name: apply_scope + description: 'Required. User specified array of target Face + + subscription ids for the snapshot. For each snapshot, only subscriptions + + included in the applyScope of Snapshot - Take can apply it.' + isRequired: true + types: + - [] + - name: user_data + description: 'User specified data about the snapshot for any purpose. + + Length should not exceed 16KB.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: type + isRequired: true + - name: object_id + isRequired: true + - name: apply_scope + isRequired: true + - name: user_data + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.TakeSnapshotRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.TakeSnapshotRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.TakeSnapshotRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.TakeSnapshotRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.TakeSnapshotRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.TakeSnapshotRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.TakeSnapshotRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.TrainingStatus.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.TrainingStatus.yml new file mode 100644 index 00000000..2e78aa36 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.TrainingStatus.yml @@ -0,0 +1,186 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.TrainingStatus +name: TrainingStatus +fullName: azure.cognitiveservices.vision.face.models.TrainingStatus +module: azure.cognitiveservices.vision.face.models +summary: 'Training status object. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TrainingStatus(*, status, created, last_action=None, last_successful_training=None, + message: str = None, **kwargs)' + parameters: + - name: status + description: 'Required. Training status: notstarted, running, succeeded, + + failed. If the training process is waiting to perform, the status is + + notstarted. If the training is ongoing, the status is running. Status + + succeed means this person group or large person group is ready for Face - + + Identify, or this large face list is ready for Face - Find Similar. Status + + failed is often caused by no person or no persisted face exist in the + + person group or large person group, or no persisted face exist in the + + large face list. Possible values include: ''nonstarted'', ''running'', + + ''succeeded'', ''failed''' + isRequired: true + types: + - + - + - name: created + description: 'Required. A combined UTC date and time string that + + describes the created time of the person group, large person group or + + large face list.' + isRequired: true + types: + - + - name: last_action + description: 'A combined UTC date and time string that describes the + + last modify time of the person group, large person group or large face + + list, could be null value when the group is not successfully trained.' + isRequired: true + types: + - + - name: last_successful_training + description: 'A combined UTC date and time string that + + describes the last successful training time of the person group, large + + person group or large face list.' + isRequired: true + types: + - + - name: message + description: 'Show failure message when training failed (omitted when + + training succeed).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: status + isRequired: true + - name: created + isRequired: true + - name: last_action + isRequired: true + - name: last_successful_training + isRequired: true + - name: message + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.TrainingStatus.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.TrainingStatus.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.TrainingStatus.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.TrainingStatus.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.TrainingStatus.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.TrainingStatus.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.TrainingStatus.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.TrainingStatusType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.TrainingStatusType.yml new file mode 100644 index 00000000..cf165aab --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.TrainingStatusType.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.cognitiveservices.vision.face.models.TrainingStatusType +name: TrainingStatusType +fullName: azure.cognitiveservices.vision.face.models.TrainingStatusType +module: azure.cognitiveservices.vision.face.models +fields: +- name: failed + uid: azure.cognitiveservices.vision.face.models.TrainingStatusType.failed +- name: nonstarted + uid: azure.cognitiveservices.vision.face.models.TrainingStatusType.nonstarted +- name: running + uid: azure.cognitiveservices.vision.face.models.TrainingStatusType.running +- name: succeeded + uid: azure.cognitiveservices.vision.face.models.TrainingStatusType.succeeded diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.UpdateFaceRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.UpdateFaceRequest.yml new file mode 100644 index 00000000..5f7d1154 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.UpdateFaceRequest.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.UpdateFaceRequest +name: UpdateFaceRequest +fullName: azure.cognitiveservices.vision.face.models.UpdateFaceRequest +module: azure.cognitiveservices.vision.face.models +summary: Request to update face data. +constructor: + syntax: 'UpdateFaceRequest(*, user_data: str = None, **kwargs)' + parameters: + - name: user_data + description: 'User-provided data attached to the face. The size limit + + is 1KB.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: user_data + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.UpdateFaceRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.UpdateFaceRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.UpdateFaceRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.UpdateFaceRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.UpdateFaceRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.UpdateFaceRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.UpdateFaceRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.UpdateSnapshotRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.UpdateSnapshotRequest.yml new file mode 100644 index 00000000..3cabb1f5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.UpdateSnapshotRequest.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.UpdateSnapshotRequest +name: UpdateSnapshotRequest +fullName: azure.cognitiveservices.vision.face.models.UpdateSnapshotRequest +module: azure.cognitiveservices.vision.face.models +summary: 'Request body for updating a snapshot, with a combination of user defined + + apply scope and user specified data.' +constructor: + syntax: 'UpdateSnapshotRequest(*, apply_scope=None, user_data: str = None, **kwargs)' + parameters: + - name: apply_scope + description: 'Array of the target Face subscription ids for the + + snapshot, specified by the user who created the snapshot when calling + + Snapshot - Take. For each snapshot, only subscriptions included in the + + applyScope of Snapshot - Take can apply it.' + isRequired: true + types: + - [] + - name: user_data + description: 'User specified data about the snapshot for any purpose. + + Length should not exceed 16KB.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: apply_scope + isRequired: true + - name: user_data + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.UpdateSnapshotRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.UpdateSnapshotRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.UpdateSnapshotRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.UpdateSnapshotRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.UpdateSnapshotRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.UpdateSnapshotRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.UpdateSnapshotRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.VerifyFaceToFaceRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.VerifyFaceToFaceRequest.yml new file mode 100644 index 00000000..e1b727fc --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.VerifyFaceToFaceRequest.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.VerifyFaceToFaceRequest +name: VerifyFaceToFaceRequest +fullName: azure.cognitiveservices.vision.face.models.VerifyFaceToFaceRequest +module: azure.cognitiveservices.vision.face.models +summary: 'Request body for face to face verification. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'VerifyFaceToFaceRequest(*, face_id1: str, face_id2: str, **kwargs)' + parameters: + - name: face_id1 + description: 'Required. FaceId of the first face, comes from Face - + + Detect' + isRequired: true + types: + - + - name: face_id2 + description: 'Required. FaceId of the second face, comes from Face - + + Detect' + isRequired: true + types: + - + keywordOnlyParameters: + - name: face_id1 + isRequired: true + - name: face_id2 + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.VerifyFaceToFaceRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.VerifyFaceToFaceRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.VerifyFaceToFaceRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.VerifyFaceToFaceRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.VerifyFaceToFaceRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.VerifyFaceToFaceRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.VerifyFaceToFaceRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.VerifyFaceToPersonRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.VerifyFaceToPersonRequest.yml new file mode 100644 index 00000000..8cf104b6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.VerifyFaceToPersonRequest.yml @@ -0,0 +1,164 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.VerifyFaceToPersonRequest +name: VerifyFaceToPersonRequest +fullName: azure.cognitiveservices.vision.face.models.VerifyFaceToPersonRequest +module: azure.cognitiveservices.vision.face.models +summary: 'Request body for face to person verification. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'VerifyFaceToPersonRequest(*, face_id: str, person_id: str, person_group_id: + str = None, large_person_group_id: str = None, **kwargs)' + parameters: + - name: face_id + description: Required. FaceId of the face, comes from Face - Detect + isRequired: true + types: + - + - name: person_group_id + description: 'Using existing personGroupId and personId for fast + + loading a specified person. personGroupId is created in PersonGroup - + + Create. Parameter personGroupId and largePersonGroupId should not be + + provided at the same time.' + isRequired: true + types: + - + - name: large_person_group_id + description: 'Using existing largePersonGroupId and + + personId for fast loading a specified person. largePersonGroupId is + + created in LargePersonGroup - Create. Parameter personGroupId and + + largePersonGroupId should not be provided at the same time.' + isRequired: true + types: + - + - name: person_id + description: 'Required. Specify a certain person in a person group or + + a large person group. personId is created in PersonGroup Person - Create + + or LargePersonGroup Person - Create.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: face_id + isRequired: true + - name: person_id + isRequired: true + - name: person_group_id + isRequired: true + - name: large_person_group_id + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.VerifyFaceToPersonRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.VerifyFaceToPersonRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.VerifyFaceToPersonRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.VerifyFaceToPersonRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.VerifyFaceToPersonRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.VerifyFaceToPersonRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.VerifyFaceToPersonRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.VerifyResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.VerifyResult.yml new file mode 100644 index 00000000..25f4d000 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.VerifyResult.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.models.VerifyResult +name: VerifyResult +fullName: azure.cognitiveservices.vision.face.models.VerifyResult +module: azure.cognitiveservices.vision.face.models +summary: 'Result of the verify operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'VerifyResult(*, is_identical: bool, confidence: float, **kwargs)' + parameters: + - name: is_identical + description: 'Required. True if the two faces belong to the same + + person or the face belongs to the person, otherwise false.' + isRequired: true + types: + - + - name: confidence + description: 'Required. A number indicates the similarity confidence + + of whether two faces belong to the same person, or whether the face + + belongs to the person. By default, isIdentical is set to True if + + similarity confidence is greater than or equal to 0.5. This is useful for + + advanced users to override "isIdentical" and fine-tune the result on their + + own data.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: is_identical + isRequired: true + - name: confidence + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.models.VerifyResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.VerifyResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.VerifyResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.cognitiveservices.vision.face.models.VerifyResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.cognitiveservices.vision.face.models.VerifyResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.cognitiveservices.vision.face.models.VerifyResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.cognitiveservices.vision.face.models.VerifyResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.yml new file mode 100644 index 00000000..8914bf4e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.yml @@ -0,0 +1,70 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.vision.face.models +name: models +fullName: azure.cognitiveservices.vision.face.models +type: import +classes: +- azure.cognitiveservices.vision.face.models.APIError +- azure.cognitiveservices.vision.face.models.APIErrorException +- azure.cognitiveservices.vision.face.models.Accessory +- azure.cognitiveservices.vision.face.models.ApplySnapshotRequest +- azure.cognitiveservices.vision.face.models.Blur +- azure.cognitiveservices.vision.face.models.Coordinate +- azure.cognitiveservices.vision.face.models.DetectedFace +- azure.cognitiveservices.vision.face.models.Emotion +- azure.cognitiveservices.vision.face.models.Error +- azure.cognitiveservices.vision.face.models.Exposure +- azure.cognitiveservices.vision.face.models.FaceAttributes +- azure.cognitiveservices.vision.face.models.FaceLandmarks +- azure.cognitiveservices.vision.face.models.FaceList +- azure.cognitiveservices.vision.face.models.FaceRectangle +- azure.cognitiveservices.vision.face.models.FacialHair +- azure.cognitiveservices.vision.face.models.FindSimilarRequest +- azure.cognitiveservices.vision.face.models.GroupRequest +- azure.cognitiveservices.vision.face.models.GroupResult +- azure.cognitiveservices.vision.face.models.Hair +- azure.cognitiveservices.vision.face.models.HairColor +- azure.cognitiveservices.vision.face.models.HeadPose +- azure.cognitiveservices.vision.face.models.IdentifyCandidate +- azure.cognitiveservices.vision.face.models.IdentifyRequest +- azure.cognitiveservices.vision.face.models.IdentifyResult +- azure.cognitiveservices.vision.face.models.ImageUrl +- azure.cognitiveservices.vision.face.models.LargeFaceList +- azure.cognitiveservices.vision.face.models.LargePersonGroup +- azure.cognitiveservices.vision.face.models.Makeup +- azure.cognitiveservices.vision.face.models.Mask +- azure.cognitiveservices.vision.face.models.MetaDataContract +- azure.cognitiveservices.vision.face.models.NameAndUserDataContract +- azure.cognitiveservices.vision.face.models.Noise +- azure.cognitiveservices.vision.face.models.Occlusion +- azure.cognitiveservices.vision.face.models.OperationStatus +- azure.cognitiveservices.vision.face.models.PersistedFace +- azure.cognitiveservices.vision.face.models.Person +- azure.cognitiveservices.vision.face.models.PersonGroup +- azure.cognitiveservices.vision.face.models.SimilarFace +- azure.cognitiveservices.vision.face.models.Snapshot +- azure.cognitiveservices.vision.face.models.TakeSnapshotRequest +- azure.cognitiveservices.vision.face.models.TrainingStatus +- azure.cognitiveservices.vision.face.models.UpdateFaceRequest +- azure.cognitiveservices.vision.face.models.UpdateSnapshotRequest +- azure.cognitiveservices.vision.face.models.VerifyFaceToFaceRequest +- azure.cognitiveservices.vision.face.models.VerifyFaceToPersonRequest +- azure.cognitiveservices.vision.face.models.VerifyResult +enums: +- azure.cognitiveservices.vision.face.models.AccessoryType +- azure.cognitiveservices.vision.face.models.BlurLevel +- azure.cognitiveservices.vision.face.models.DetectionModel +- azure.cognitiveservices.vision.face.models.ExposureLevel +- azure.cognitiveservices.vision.face.models.FaceAttributeType +- azure.cognitiveservices.vision.face.models.FindSimilarMatchMode +- azure.cognitiveservices.vision.face.models.Gender +- azure.cognitiveservices.vision.face.models.GlassesType +- azure.cognitiveservices.vision.face.models.HairColorType +- azure.cognitiveservices.vision.face.models.MaskType +- azure.cognitiveservices.vision.face.models.NoiseLevel +- azure.cognitiveservices.vision.face.models.OperationStatusType +- azure.cognitiveservices.vision.face.models.QualityForRecognition +- azure.cognitiveservices.vision.face.models.RecognitionModel +- azure.cognitiveservices.vision.face.models.SnapshotApplyMode +- azure.cognitiveservices.vision.face.models.SnapshotObjectType +- azure.cognitiveservices.vision.face.models.TrainingStatusType diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.FaceListOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.FaceListOperations.yml new file mode 100644 index 00000000..d3d8bbff --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.FaceListOperations.yml @@ -0,0 +1,661 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.operations.FaceListOperations +name: FaceListOperations +fullName: azure.cognitiveservices.vision.face.operations.FaceListOperations +module: azure.cognitiveservices.vision.face.operations +summary: 'FaceListOperations operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: FaceListOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.operations.FaceListOperations.add_face_from_stream + name: add_face_from_stream + summary: 'Add a face to a specified face list, up to 1,000 faces. + +
To deal with an image contains multiple faces, input face can be + + specified as an image with a targetFace rectangle. It returns a + + persistedFaceId representing the added face. No image will be stored. + + Only the extracted face feature will be stored on server until + + [FaceList - Delete + + Face](https://docs.microsoft.com/rest/api/faceapi/facelist/deleteface) + + or [FaceList - + + Delete](https://docs.microsoft.com/rest/api/faceapi/facelist/delete) is + + called. + +
Note persistedFaceId is different from faceId generated by [Face + + - + + Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl). + + * Higher face image quality means better detection and recognition + + precision. Please consider high-quality faces: frontal, clear, and face + + size is 200x200 pixels (100 pixels between eyes) or bigger. + + * JPEG, PNG, GIF (the first frame), and BMP format are supported. The + + allowed image file size is from 1KB to 6MB. + + * "targetFace" rectangle should contain one face. Zero or multiple + + faces will be regarded as an error. If the provided "targetFace" + + rectangle is not returned from [Face - + + Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl), + + there''s no guarantee to detect and add the face successfully. + + * Out of detectable face size (36x36 - 4096x4096 pixels), large + + head-pose, or large occlusions will cause failures. + + * Adding/deleting faces to/from a same face list are processed + + sequentially and to/from different face lists are in parallel. + + * The minimum detectable face size is 36x36 pixels in an image no + + larger than 1920x1080 pixels. Images with dimensions higher than + + 1920x1080 pixels will need a proportionally larger minimum face size. + + * Different ''detectionModel'' values can be provided. To use and compare + + different detection models, please refer to [How to specify a detection + + model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model).' + signature: add_face_from_stream(face_list_id, image, user_data=None, target_face=None, + detection_model='detection_01', custom_headers=None, raw=False, callback=None, + **operation_config) + parameters: + - name: face_list_id + description: Id referencing a particular face list. + isRequired: true + types: + - + - name: image + description: An image stream. + isRequired: true + types: + - + - name: user_data + description: 'User-specified data about the face for any purpose. + + The maximum length is 1KB.' + defaultValue: None + types: + - + - name: target_face + description: 'A face rectangle to specify the target face to be + + added to a person in the format of "targetFace=left,top,width,height". + + E.g. "targetFace=10,10,100,100". If there is more than one face in the + + image, targetFace is required to specify which face to add. No + + targetFace means there is only one face detected in the entire image.' + defaultValue: None + types: + - [] + - name: detection_model + description: 'Name of detection model. Detection model is + + used to detect faces in the submitted image. A detection model name + + can be provided when performing Face - Detect or (Large)FaceList - Add + + Face or (Large)PersonGroup - Add Face. The default value is + + ''detection_01'', if another model is needed, please explicitly specify + + it. Possible values include: ''detection_01'', ''detection_02'', + + ''detection_03''' + defaultValue: detection_01 + types: + - + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: PersistedFace or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.FaceListOperations.add_face_from_url + name: add_face_from_url + summary: 'Add a face to a specified face list, up to 1,000 faces. + +
To deal with an image contains multiple faces, input face can be + + specified as an image with a targetFace rectangle. It returns a + + persistedFaceId representing the added face. No image will be stored. + + Only the extracted face feature will be stored on server until + + [FaceList - Delete + + Face](https://docs.microsoft.com/rest/api/faceapi/facelist/deleteface) + + or [FaceList - + + Delete](https://docs.microsoft.com/rest/api/faceapi/facelist/delete) is + + called. + +
Note persistedFaceId is different from faceId generated by [Face + + - + + Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl). + + * Higher face image quality means better detection and recognition + + precision. Please consider high-quality faces: frontal, clear, and face + + size is 200x200 pixels (100 pixels between eyes) or bigger. + + * JPEG, PNG, GIF (the first frame), and BMP format are supported. The + + allowed image file size is from 1KB to 6MB. + + * "targetFace" rectangle should contain one face. Zero or multiple + + faces will be regarded as an error. If the provided "targetFace" + + rectangle is not returned from [Face - + + Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl), + + there''s no guarantee to detect and add the face successfully. + + * Out of detectable face size (36x36 - 4096x4096 pixels), large + + head-pose, or large occlusions will cause failures. + + * Adding/deleting faces to/from a same face list are processed + + sequentially and to/from different face lists are in parallel. + + * The minimum detectable face size is 36x36 pixels in an image no + + larger than 1920x1080 pixels. Images with dimensions higher than + + 1920x1080 pixels will need a proportionally larger minimum face size. + + * Different ''detectionModel'' values can be provided. To use and compare + + different detection models, please refer to [How to specify a detection + + model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model).' + signature: add_face_from_url(face_list_id, url, user_data=None, target_face=None, + detection_model='detection_01', custom_headers=None, raw=False, **operation_config) + parameters: + - name: face_list_id + description: Id referencing a particular face list. + isRequired: true + types: + - + - name: url + description: Publicly reachable URL of an image + isRequired: true + types: + - + - name: user_data + description: 'User-specified data about the face for any purpose. + + The maximum length is 1KB.' + defaultValue: None + types: + - + - name: target_face + description: 'A face rectangle to specify the target face to be + + added to a person in the format of "targetFace=left,top,width,height". + + E.g. "targetFace=10,10,100,100". If there is more than one face in the + + image, targetFace is required to specify which face to add. No + + targetFace means there is only one face detected in the entire image.' + defaultValue: None + types: + - [] + - name: detection_model + description: 'Name of detection model. Detection model is + + used to detect faces in the submitted image. A detection model name + + can be provided when performing Face - Detect or (Large)FaceList - Add + + Face or (Large)PersonGroup - Add Face. The default value is + + ''detection_01'', if another model is needed, please explicitly specify + + it. Possible values include: ''detection_01'', ''detection_02'', + + ''detection_03''' + defaultValue: detection_01 + types: + - + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: PersistedFace or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.FaceListOperations.create + name: create + summary: 'Create an empty face list with user-specified faceListId, name, an + + optional userData and recognitionModel. Up to 64 face lists are allowed + + in one subscription. + +
Face list is a list of faces, up to 1,000 faces, and used by + + [Face - Find + + Similar](https://docs.microsoft.com/rest/api/faceapi/face/findsimilar). + +
After creation, user should use [FaceList - Add + + Face](https://docs.microsoft.com/rest/api/faceapi/facelist/addfacefromurl) + + to import the faces. No image will be stored. Only the extracted face + + features are stored on server until [FaceList - + + Delete](https://docs.microsoft.com/rest/api/faceapi/facelist/delete) is + + called. + +
Find Similar is used for scenario like finding celebrity-like + + faces, similar face filtering, or as a light way face identification. + + But if the actual use is to identify person, please use + + [PersonGroup](https://docs.microsoft.com/rest/api/faceapi/persongroup) + + / + + [LargePersonGroup](https://docs.microsoft.com/rest/api/faceapi/largepersongroup) + + and [Face - + + Identify](https://docs.microsoft.com/rest/api/faceapi/face/identify). + +
Please consider + + [LargeFaceList](https://docs.microsoft.com/rest/api/faceapi/largefacelist) + + when the face number is large. It can support up to 1,000,000 faces. + +
''recognitionModel'' should be specified to associate with this + + face list. The default value for ''recognitionModel'' is + + ''recognition_01'', if the latest model needed, please explicitly specify + + the model you need in this parameter. New faces that are added to an + + existing face list will use the recognition model that''s already + + associated with the collection. Existing face features in a face list + + can''t be updated to features extracted by another version of + + recognition model. + + Please Refer to [Specify a face recognition + + model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model).' + signature: create(face_list_id, name, user_data=None, recognition_model='recognition_01', + custom_headers=None, raw=False, **operation_config) + parameters: + - name: face_list_id + description: Id referencing a particular face list. + isRequired: true + types: + - + - name: name + description: User defined name, maximum length is 128. + isRequired: true + types: + - + - name: user_data + description: User specified data. Length should not exceed 16KB. + defaultValue: None + types: + - + - name: recognition_model + description: 'Possible values include: ''recognition_01'', + + ''recognition_02'', ''recognition_03'', ''recognition_04''' + defaultValue: recognition_01 + types: + - + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.FaceListOperations.delete + name: delete + summary: Delete a specified face list. + signature: delete(face_list_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: face_list_id + description: Id referencing a particular face list. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.FaceListOperations.delete_face + name: delete_face + summary: 'Delete a face from a face list by specified faceListId and + + persistedFaceId. + +
Adding/deleting faces to/from a same face list are processed + + sequentially and to/from different face lists are in parallel.' + signature: delete_face(face_list_id, persisted_face_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: face_list_id + description: Id referencing a particular face list. + isRequired: true + types: + - + - name: persisted_face_id + description: 'Id referencing a particular persistedFaceId + + of an existing face.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.FaceListOperations.get + name: get + summary: 'Retrieve a face list''s faceListId, name, userData, recognitionModel and + + faces in the face list. + + .' + signature: get(face_list_id, return_recognition_model=False, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: face_list_id + description: Id referencing a particular face list. + isRequired: true + types: + - + - name: return_recognition_model + description: 'A value indicating whether the + + operation should return ''recognitionModel'' in response.' + defaultValue: 'False' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: FaceList or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.FaceListOperations.list + name: list + summary: 'List face lists'' faceListId, name, userData and recognitionModel.
+ + To get face information inside faceList use [FaceList - + + Get](https://docs.microsoft.com/rest/api/faceapi/facelist/get) + + .' + signature: list(return_recognition_model=False, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: return_recognition_model + description: 'A value indicating whether the + + operation should return ''recognitionModel'' in response.' + defaultValue: 'False' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.FaceListOperations.update + name: update + summary: Update information of a face list. + signature: update(face_list_id, name=None, user_data=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: face_list_id + description: Id referencing a particular face list. + isRequired: true + types: + - + - name: name + description: User defined name, maximum length is 128. + defaultValue: None + types: + - + - name: user_data + description: User specified data. Length should not exceed 16KB. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +attributes: +- uid: azure.cognitiveservices.vision.face.operations.FaceListOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.FaceOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.FaceOperations.yml new file mode 100644 index 00000000..588b43a9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.FaceOperations.yml @@ -0,0 +1,963 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.operations.FaceOperations +name: FaceOperations +fullName: azure.cognitiveservices.vision.face.operations.FaceOperations +module: azure.cognitiveservices.vision.face.operations +summary: 'FaceOperations operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: FaceOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.operations.FaceOperations.detect_with_stream + name: detect_with_stream + summary: 'Detect human faces in an image, return face rectangles, and optionally + + with faceIds, landmarks, and attributes.
+ + * No image will be stored. Only the extracted face feature will be + + stored on server. The faceId is an identifier of the face feature and + + will be used in [Face - + + Identify](https://docs.microsoft.com/rest/api/faceapi/face/identify), + + [Face - + + Verify](https://docs.microsoft.com/rest/api/faceapi/face/verifyfacetoface), + + and [Face - Find + + Similar](https://docs.microsoft.com/rest/api/faceapi/face/findsimilar). + + The stored face feature(s) will expire and be deleted at the time + + specified by faceIdTimeToLive after the original detection call. + + * Optional parameters include faceId, landmarks, and attributes. + + Attributes include age, gender, headPose, smile, facialHair, glasses, + + emotion, hair, makeup, occlusion, accessories, blur, exposure, noise, + + mask, and qualityForRecognition. Some of the results returned for + + specific attributes may not be highly accurate. + + * JPEG, PNG, GIF (the first frame), and BMP format are supported. The + + allowed image file size is from 1KB to 6MB. + + * Up to 100 faces can be returned for an image. Faces are ranked by + + face rectangle size from large to small. + + * For optimal results when querying [Face - + + Identify](https://docs.microsoft.com/rest/api/faceapi/face/identify), + + [Face - + + Verify](https://docs.microsoft.com/rest/api/faceapi/face/verifyfacetoface), + + and [Face - Find + + Similar](https://docs.microsoft.com/rest/api/faceapi/face/findsimilar) + + (''returnFaceId'' is true), please use faces that are: frontal, clear, + + and with a minimum size of 200x200 pixels (100 pixels between eyes). + + * The minimum detectable face size is 36x36 pixels in an image no + + larger than 1920x1080 pixels. Images with dimensions higher than + + 1920x1080 pixels will need a proportionally larger minimum face size. + + * Different ''detectionModel'' values can be provided. To use and compare + + different detection models, please refer to [How to specify a detection + + model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model) + + * Different ''recognitionModel'' values are provided. If follow-up + + operations like Verify, Identify, Find Similar are needed, please + + specify the recognition model with ''recognitionModel'' parameter. The + + default value for ''recognitionModel'' is ''recognition_01'', if latest + + model needed, please explicitly specify the model you need in this + + parameter. Once specified, the detected faceIds will be associated with + + the specified recognition model. More details, please refer to [Specify + + a recognition + + model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model).' + signature: detect_with_stream(image, return_face_id=True, return_face_landmarks=False, + return_face_attributes=None, recognition_model='recognition_01', return_recognition_model=False, + detection_model='detection_01', face_id_time_to_live=86400, custom_headers=None, + raw=False, callback=None, **operation_config) + parameters: + - name: image + description: An image stream. + isRequired: true + types: + - + - name: return_face_id + description: 'A value indicating whether the operation should + + return faceIds of detected faces.' + defaultValue: 'True' + types: + - + - name: return_face_landmarks + description: 'A value indicating whether the operation + + should return landmarks of the detected faces.' + defaultValue: 'False' + types: + - + - name: return_face_attributes + description: 'Analyze and return the one or more + + specified face attributes in the comma-separated string like + + "returnFaceAttributes=age,gender". The available attributes depends on + + the ''detectionModel'' specified. ''detection_01'' supports age, gender, + + headPose, smile, facialHair, glasses, emotion, hair, makeup, + + occlusion, accessories, blur, exposure, noise, and + + qualityForRecognition. While ''detection_02'' does not support any + + attributes and ''detection_03'' only supports mask and + + qualityForRecognition. Additionally, qualityForRecognition is only + + supported when the ''recognitionModel'' is specified as ''recognition_03'' + + or ''recognition_04''. Note that each face attribute analysis has + + additional computational and time cost.' + defaultValue: None + types: + - [ + - ] + - name: recognition_model + description: 'Name of recognition model. Recognition model + + is used when the face features are extracted and associated with + + detected faceIds, (Large)FaceList or (Large)PersonGroup. A recognition + + model name can be provided when performing Face - Detect or + + (Large)FaceList - Create or (Large)PersonGroup - Create. The default + + value is ''recognition_01'', if latest model needed, please explicitly + + specify the model you need. Possible values include: ''recognition_01'', + + ''recognition_02'', ''recognition_03'', ''recognition_04''' + defaultValue: recognition_01 + types: + - + - + - name: return_recognition_model + description: 'A value indicating whether the + + operation should return ''recognitionModel'' in response.' + defaultValue: 'False' + types: + - + - name: detection_model + description: 'Name of detection model. Detection model is + + used to detect faces in the submitted image. A detection model name + + can be provided when performing Face - Detect or (Large)FaceList - Add + + Face or (Large)PersonGroup - Add Face. The default value is + + ''detection_01'', if another model is needed, please explicitly specify + + it. Possible values include: ''detection_01'', ''detection_02'', + + ''detection_03''' + defaultValue: detection_01 + types: + - + - + - name: face_id_time_to_live + description: 'The number of seconds for the faceId + + being cached. Supported range from 60 seconds up to 86400 seconds. The + + default value is 86400 (24 hours).' + defaultValue: '86400' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.FaceOperations.detect_with_url + name: detect_with_url + summary: 'Detect human faces in an image, return face rectangles, and optionally + + with faceIds, landmarks, and attributes.
+ + * No image will be stored. Only the extracted face feature will be + + stored on server. The faceId is an identifier of the face feature and + + will be used in [Face - + + Identify](https://docs.microsoft.com/rest/api/faceapi/face/identify), + + [Face - + + Verify](https://docs.microsoft.com/rest/api/faceapi/face/verifyfacetoface), + + and [Face - Find + + Similar](https://docs.microsoft.com/rest/api/faceapi/face/findsimilar). + + The stored face feature(s) will expire and be deleted at the time + + specified by faceIdTimeToLive after the original detection call. + + * Optional parameters include faceId, landmarks, and attributes. + + Attributes include age, gender, headPose, smile, facialHair, glasses, + + emotion, hair, makeup, occlusion, accessories, blur, exposure, noise, + + mask, and qualityForRecognition. Some of the results returned for + + specific attributes may not be highly accurate. + + * JPEG, PNG, GIF (the first frame), and BMP format are supported. The + + allowed image file size is from 1KB to 6MB. + + * Up to 100 faces can be returned for an image. Faces are ranked by + + face rectangle size from large to small. + + * For optimal results when querying [Face - + + Identify](https://docs.microsoft.com/rest/api/faceapi/face/identify), + + [Face - + + Verify](https://docs.microsoft.com/rest/api/faceapi/face/verifyfacetoface), + + and [Face - Find + + Similar](https://docs.microsoft.com/rest/api/faceapi/face/findsimilar) + + (''returnFaceId'' is true), please use faces that are: frontal, clear, + + and with a minimum size of 200x200 pixels (100 pixels between eyes). + + * The minimum detectable face size is 36x36 pixels in an image no + + larger than 1920x1080 pixels. Images with dimensions higher than + + 1920x1080 pixels will need a proportionally larger minimum face size. + + * Different ''detectionModel'' values can be provided. To use and compare + + different detection models, please refer to [How to specify a detection + + model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model). + + * Different ''recognitionModel'' values are provided. If follow-up + + operations like Verify, Identify, Find Similar are needed, please + + specify the recognition model with ''recognitionModel'' parameter. The + + default value for ''recognitionModel'' is ''recognition_01'', if latest + + model needed, please explicitly specify the model you need in this + + parameter. Once specified, the detected faceIds will be associated with + + the specified recognition model. More details, please refer to [Specify + + a recognition + + model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model).' + signature: detect_with_url(url, return_face_id=True, return_face_landmarks=False, + return_face_attributes=None, recognition_model='recognition_01', return_recognition_model=False, + detection_model='detection_01', face_id_time_to_live=86400, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: url + description: Publicly reachable URL of an image + isRequired: true + types: + - + - name: return_face_id + description: 'A value indicating whether the operation should + + return faceIds of detected faces.' + defaultValue: 'True' + types: + - + - name: return_face_landmarks + description: 'A value indicating whether the operation + + should return landmarks of the detected faces.' + defaultValue: 'False' + types: + - + - name: return_face_attributes + description: 'Analyze and return the one or more + + specified face attributes in the comma-separated string like + + "returnFaceAttributes=age,gender". The available attributes depends on + + the ''detectionModel'' specified. ''detection_01'' supports age, gender, + + headPose, smile, facialHair, glasses, emotion, hair, makeup, + + occlusion, accessories, blur, exposure, noise, and + + qualityForRecognition. While ''detection_02'' does not support any + + attributes and ''detection_03'' only supports mask and + + qualityForRecognition. Additionally, qualityForRecognition is only + + supported when the ''recognitionModel'' is specified as ''recognition_03'' + + or ''recognition_04''. Note that each face attribute analysis has + + additional computational and time cost.' + defaultValue: None + types: + - [ + - ] + - name: recognition_model + description: 'Name of recognition model. Recognition model + + is used when the face features are extracted and associated with + + detected faceIds, (Large)FaceList or (Large)PersonGroup. A recognition + + model name can be provided when performing Face - Detect or + + (Large)FaceList - Create or (Large)PersonGroup - Create. The default + + value is ''recognition_01'', if latest model needed, please explicitly + + specify the model you need. Possible values include: ''recognition_01'', + + ''recognition_02'', ''recognition_03'', ''recognition_04''' + defaultValue: recognition_01 + types: + - + - + - name: return_recognition_model + description: 'A value indicating whether the + + operation should return ''recognitionModel'' in response.' + defaultValue: 'False' + types: + - + - name: detection_model + description: 'Name of detection model. Detection model is + + used to detect faces in the submitted image. A detection model name + + can be provided when performing Face - Detect or (Large)FaceList - Add + + Face or (Large)PersonGroup - Add Face. The default value is + + ''detection_01'', if another model is needed, please explicitly specify + + it. Possible values include: ''detection_01'', ''detection_02'', + + ''detection_03''' + defaultValue: detection_01 + types: + - + - + - name: face_id_time_to_live + description: 'The number of seconds for the faceId + + being cached. Supported range from 60 seconds up to 86400 seconds. The + + default value is 86400 (24 hours).' + defaultValue: '86400' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.FaceOperations.find_similar + name: find_similar + summary: 'Given query face''s faceId, to search the similar-looking faces from a + + faceId array, a face list or a large face list. faceId array contains + + the faces created by [Face - Detect With + + Url](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl) or + + [Face - Detect With + + Stream](https://docs.microsoft.com/rest/api/faceapi/face/detectwithstream), + + which will expire at the time specified by faceIdTimeToLive after + + creation. A "faceListId" is created by [FaceList - + + Create](https://docs.microsoft.com/rest/api/faceapi/facelist/create) + + containing persistedFaceIds that will not expire. And a + + "largeFaceListId" is created by [LargeFaceList - + + Create](https://docs.microsoft.com/rest/api/faceapi/largefacelist/create) + + containing persistedFaceIds that will also not expire. Depending on the + + input the returned similar faces list contains faceIds or + + persistedFaceIds ranked by similarity. + +
Find similar has two working modes, "matchPerson" and "matchFace". + + "matchPerson" is the default mode that it tries to find faces of the + + same person as possible by using internal same-person thresholds. It is + + useful to find a known person''s other photos. Note that an empty list + + will be returned if no faces pass the internal thresholds. "matchFace" + + mode ignores same-person thresholds and returns ranked similar faces + + anyway, even the similarity is low. It can be used in the cases like + + searching celebrity-looking faces. + +
The ''recognitionModel'' associated with the query face''s faceId + + should be the same as the ''recognitionModel'' used by the target faceId + + array, face list or large face list. + + .' + signature: find_similar(face_id, face_list_id=None, large_face_list_id=None, face_ids=None, + max_num_of_candidates_returned=20, mode='matchPerson', custom_headers=None, raw=False, + **operation_config) + parameters: + - name: face_id + description: 'FaceId of the query face. User needs to call Face - + + Detect first to get a valid faceId. Note that this faceId is not + + persisted and will expire at the time specified by faceIdTimeToLive + + after the detection call' + isRequired: true + types: + - + - name: face_list_id + description: 'An existing user-specified unique candidate face + + list, created in Face List - Create a Face List. Face list contains a + + set of persistedFaceIds which are persisted and will never expire. + + Parameter faceListId, largeFaceListId and faceIds should not be + + provided at the same time.' + defaultValue: None + types: + - + - name: large_face_list_id + description: 'An existing user-specified unique candidate + + large face list, created in LargeFaceList - Create. Large face list + + contains a set of persistedFaceIds which are persisted and will never + + expire. Parameter faceListId, largeFaceListId and faceIds should not + + be provided at the same time.' + defaultValue: None + types: + - + - name: face_ids + description: 'An array of candidate faceIds. All of them are + + created by Face - Detect and the faceIds will expire at the time + + specified by faceIdTimeToLive after the detection call. The number of + + faceIds is limited to 1000. Parameter faceListId, largeFaceListId and + + faceIds should not be provided at the same time.' + defaultValue: None + types: + - [] + - name: max_num_of_candidates_returned + description: 'The number of top similar faces + + returned. The valid range is [1, 1000].' + defaultValue: '20' + types: + - + - name: mode + description: 'Similar face searching mode. It can be "matchPerson" or + + "matchFace". Possible values include: ''matchPerson'', ''matchFace''' + defaultValue: matchPerson + types: + - + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.FaceOperations.group + name: group + summary: 'Divide candidate faces into groups based on face similarity.
+ + * The output is one or more disjointed face groups and a messyGroup. A + + face group contains faces that have similar looking, often of the same + + person. Face groups are ranked by group size, i.e. number of faces. + + Notice that faces belonging to a same person might be split into + + several groups in the result. + + * MessyGroup is a special face group containing faces that cannot find + + any similar counterpart face from original faces. The messyGroup will + + not appear in the result if all faces found their counterparts. + + * Group API needs at least 2 candidate faces and 1000 at most. We + + suggest to try [Face - + + Verify](https://docs.microsoft.com/rest/api/faceapi/face/verifyfacetoface) + + when you only have 2 candidate faces. + + * The ''recognitionModel'' associated with the query faces'' faceIds + + should be the same. + + .' + signature: group(face_ids, custom_headers=None, raw=False, **operation_config) + parameters: + - name: face_ids + description: 'Array of candidate faceId created by Face - Detect. + + The maximum is 1000 faces' + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: GroupResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.FaceOperations.identify + name: identify + summary: '1-to-many identification to find the closest matches of the specific + + query person face from a person group or large person group. + +
For each face in the faceIds array, Face Identify will compute + + similarities between the query face and all the faces in the person + + group (given by personGroupId) or large person group (given by + + largePersonGroupId), and return candidate person(s) for that face + + ranked by similarity confidence. The person group/large person group + + should be trained to make it ready for identification. See more in + + [PersonGroup - + + Train](https://docs.microsoft.com/rest/api/faceapi/persongroup/train) + + and [LargePersonGroup - + + Train](https://docs.microsoft.com/rest/api/faceapi/largepersongroup/train). + +
+ + Remarks:
+ + * The algorithm allows more than one face to be identified + + independently at the same request, but no more than 10 faces. + + * Each person in the person group/large person group could have more + + than one face, but no more than 248 faces. + + * Higher face image quality means better identification precision. + + Please consider high-quality faces: frontal, clear, and face size is + + 200x200 pixels (100 pixels between eyes) or bigger. + + * Number of candidates returned is restricted by + + maxNumOfCandidatesReturned and confidenceThreshold. If no person is + + identified, the returned candidates will be an empty array. + + * Try [Face - Find + + Similar](https://docs.microsoft.com/rest/api/faceapi/face/findsimilar) + + when you need to find similar faces from a face list/large face list + + instead of a person group/large person group. + + * The ''recognitionModel'' associated with the query faces'' faceIds + + should be the same as the ''recognitionModel'' used by the target person + + group or large person group. + + .' + signature: identify(face_ids, person_group_id=None, large_person_group_id=None, + max_num_of_candidates_returned=1, confidence_threshold=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: face_ids + description: 'Array of query faces faceIds, created by the Face - + + Detect. Each of the faces are identified independently. The valid + + number of faceIds is between [1, 10].' + isRequired: true + types: + - [] + - name: person_group_id + description: 'PersonGroupId of the target person group, + + created by PersonGroup - Create. Parameter personGroupId and + + largePersonGroupId should not be provided at the same time.' + defaultValue: None + types: + - + - name: large_person_group_id + description: 'LargePersonGroupId of the target large + + person group, created by LargePersonGroup - Create. Parameter + + personGroupId and largePersonGroupId should not be provided at the + + same time.' + defaultValue: None + types: + - + - name: max_num_of_candidates_returned + description: 'The range of + + maxNumOfCandidatesReturned is between 1 and 100 (default is 1).' + defaultValue: '1' + types: + - + - name: confidence_threshold + description: 'Confidence threshold of identification, + + used to judge whether one face belong to one person. The range of + + confidenceThreshold is [0, 1] (default specified by algorithm).' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.FaceOperations.verify_face_to_face + name: verify_face_to_face + summary: 'Verify whether two faces belong to a same person or whether one face + + belongs to a person. + +
+ + Remarks:
+ + * Higher face image quality means better identification precision. + + Please consider high-quality faces: frontal, clear, and face size is + + 200x200 pixels (100 pixels between eyes) or bigger. + + * For the scenarios that are sensitive to accuracy please make your own + + judgment. + + * The ''recognitionModel'' associated with the query faces'' faceIds + + should be the same as the ''recognitionModel'' used by the target face, + + person group or large person group. + + .' + signature: verify_face_to_face(face_id1, face_id2, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: face_id1 + description: FaceId of the first face, comes from Face - Detect + isRequired: true + types: + - + - name: face_id2 + description: FaceId of the second face, comes from Face - Detect + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: VerifyResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.FaceOperations.verify_face_to_person + name: verify_face_to_person + summary: 'Verify whether two faces belong to a same person. Compares a face Id + + with a Person Id.' + signature: verify_face_to_person(face_id, person_id, person_group_id=None, large_person_group_id=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: face_id + description: FaceId of the face, comes from Face - Detect + isRequired: true + types: + - + - name: person_id + description: 'Specify a certain person in a person group or a + + large person group. personId is created in PersonGroup Person - Create + + or LargePersonGroup Person - Create.' + isRequired: true + types: + - + - name: person_group_id + description: 'Using existing personGroupId and personId for + + fast loading a specified person. personGroupId is created in + + PersonGroup - Create. Parameter personGroupId and largePersonGroupId + + should not be provided at the same time.' + defaultValue: None + types: + - + - name: large_person_group_id + description: 'Using existing largePersonGroupId and + + personId for fast loading a specified person. largePersonGroupId is + + created in LargePersonGroup - Create. Parameter personGroupId and + + largePersonGroupId should not be provided at the same time.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: VerifyResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +attributes: +- uid: azure.cognitiveservices.vision.face.operations.FaceOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.LargeFaceListOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.LargeFaceListOperations.yml new file mode 100644 index 00000000..889ab7a5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.LargeFaceListOperations.yml @@ -0,0 +1,964 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.operations.LargeFaceListOperations +name: LargeFaceListOperations +fullName: azure.cognitiveservices.vision.face.operations.LargeFaceListOperations +module: azure.cognitiveservices.vision.face.operations +summary: 'LargeFaceListOperations operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: LargeFaceListOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.operations.LargeFaceListOperations.add_face_from_stream + name: add_face_from_stream + summary: 'Add a face to a specified large face list, up to 1,000,000 faces. + +
To deal with an image contains multiple faces, input face can be + + specified as an image with a targetFace rectangle. It returns a + + persistedFaceId representing the added face. No image will be stored. + + Only the extracted face feature will be stored on server until + + [LargeFaceList Face - + + Delete](https://docs.microsoft.com/rest/api/faceapi/largefacelist/deleteface) + + or [LargeFaceList - + + Delete](https://docs.microsoft.com/rest/api/faceapi/largefacelist/delete) + + is called. + +
Note persistedFaceId is different from faceId generated by [Face + + - + + Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl). + + * Higher face image quality means better recognition precision. Please + + consider high-quality faces: frontal, clear, and face size is 200x200 + + pixels (100 pixels between eyes) or bigger. + + * JPEG, PNG, GIF (the first frame), and BMP format are supported. The + + allowed image file size is from 1KB to 6MB. + + * "targetFace" rectangle should contain one face. Zero or multiple + + faces will be regarded as an error. If the provided "targetFace" + + rectangle is not returned from [Face - + + Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl), + + there''s no guarantee to detect and add the face successfully. + + * Out of detectable face size (36x36 - 4096x4096 pixels), large + + head-pose, or large occlusions will cause failures. + + * Adding/deleting faces to/from a same face list are processed + + sequentially and to/from different face lists are in parallel. + + * The minimum detectable face size is 36x36 pixels in an image no + + larger than 1920x1080 pixels. Images with dimensions higher than + + 1920x1080 pixels will need a proportionally larger minimum face size. + + * Different ''detectionModel'' values can be provided. To use and compare + + different detection models, please refer to [How to specify a detection + + model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model). + + Quota: + + * Free-tier subscription quota: 1,000 faces per large face list. + + * S0-tier subscription quota: 1,000,000 faces per large face list.' + signature: add_face_from_stream(large_face_list_id, image, user_data=None, target_face=None, + detection_model='detection_01', custom_headers=None, raw=False, callback=None, + **operation_config) + parameters: + - name: large_face_list_id + description: 'Id referencing a particular large face + + list.' + isRequired: true + types: + - + - name: image + description: An image stream. + isRequired: true + types: + - + - name: user_data + description: 'User-specified data about the face for any purpose. + + The maximum length is 1KB.' + defaultValue: None + types: + - + - name: target_face + description: 'A face rectangle to specify the target face to be + + added to a person in the format of "targetFace=left,top,width,height". + + E.g. "targetFace=10,10,100,100". If there is more than one face in the + + image, targetFace is required to specify which face to add. No + + targetFace means there is only one face detected in the entire image.' + defaultValue: None + types: + - [] + - name: detection_model + description: 'Name of detection model. Detection model is + + used to detect faces in the submitted image. A detection model name + + can be provided when performing Face - Detect or (Large)FaceList - Add + + Face or (Large)PersonGroup - Add Face. The default value is + + ''detection_01'', if another model is needed, please explicitly specify + + it. Possible values include: ''detection_01'', ''detection_02'', + + ''detection_03''' + defaultValue: detection_01 + types: + - + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: PersistedFace or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargeFaceListOperations.add_face_from_url + name: add_face_from_url + summary: 'Add a face to a specified large face list, up to 1,000,000 faces. + +
To deal with an image contains multiple faces, input face can be + + specified as an image with a targetFace rectangle. It returns a + + persistedFaceId representing the added face. No image will be stored. + + Only the extracted face feature will be stored on server until + + [LargeFaceList Face - + + Delete](https://docs.microsoft.com/rest/api/faceapi/largefacelist/deleteface) + + or [LargeFaceList - + + Delete](https://docs.microsoft.com/rest/api/faceapi/largefacelist/delete) + + is called. + +
Note persistedFaceId is different from faceId generated by [Face + + - + + Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl). + + * Higher face image quality means better recognition precision. Please + + consider high-quality faces: frontal, clear, and face size is 200x200 + + pixels (100 pixels between eyes) or bigger. + + * JPEG, PNG, GIF (the first frame), and BMP format are supported. The + + allowed image file size is from 1KB to 6MB. + + * "targetFace" rectangle should contain one face. Zero or multiple + + faces will be regarded as an error. If the provided "targetFace" + + rectangle is not returned from [Face - + + Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl), + + there''s no guarantee to detect and add the face successfully. + + * Out of detectable face size (36x36 - 4096x4096 pixels), large + + head-pose, or large occlusions will cause failures. + + * Adding/deleting faces to/from a same face list are processed + + sequentially and to/from different face lists are in parallel. + + * The minimum detectable face size is 36x36 pixels in an image no + + larger than 1920x1080 pixels. Images with dimensions higher than + + 1920x1080 pixels will need a proportionally larger minimum face size. + + * Different ''detectionModel'' values can be provided. To use and compare + + different detection models, please refer to [How to specify a detection + + model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model) + + Quota: + + * Free-tier subscription quota: 1,000 faces per large face list. + + * S0-tier subscription quota: 1,000,000 faces per large face list.' + signature: add_face_from_url(large_face_list_id, url, user_data=None, target_face=None, + detection_model='detection_01', custom_headers=None, raw=False, **operation_config) + parameters: + - name: large_face_list_id + description: 'Id referencing a particular large face + + list.' + isRequired: true + types: + - + - name: url + description: Publicly reachable URL of an image + isRequired: true + types: + - + - name: user_data + description: 'User-specified data about the face for any purpose. + + The maximum length is 1KB.' + defaultValue: None + types: + - + - name: target_face + description: 'A face rectangle to specify the target face to be + + added to a person in the format of "targetFace=left,top,width,height". + + E.g. "targetFace=10,10,100,100". If there is more than one face in the + + image, targetFace is required to specify which face to add. No + + targetFace means there is only one face detected in the entire image.' + defaultValue: None + types: + - [] + - name: detection_model + description: 'Name of detection model. Detection model is + + used to detect faces in the submitted image. A detection model name + + can be provided when performing Face - Detect or (Large)FaceList - Add + + Face or (Large)PersonGroup - Add Face. The default value is + + ''detection_01'', if another model is needed, please explicitly specify + + it. Possible values include: ''detection_01'', ''detection_02'', + + ''detection_03''' + defaultValue: detection_01 + types: + - + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: PersistedFace or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargeFaceListOperations.create + name: create + summary: 'Create an empty large face list with user-specified largeFaceListId, + + name, an optional userData and recognitionModel. + +
Large face list is a list of faces, up to 1,000,000 faces, and + + used by [Face - Find + + Similar](https://docs.microsoft.com/rest/api/faceapi/face/findsimilar). + +
After creation, user should use [LargeFaceList Face - + + Add](https://docs.microsoft.com/rest/api/faceapi/largefacelist/addfacefromurl) + + to import the faces and [LargeFaceList - + + Train](https://docs.microsoft.com/rest/api/faceapi/largefacelist/train) + + to make it ready for [Face - Find + + Similar](https://docs.microsoft.com/rest/api/faceapi/face/findsimilar). + + No image will be stored. Only the extracted face features are stored on + + server until [LargeFaceList - + + Delete](https://docs.microsoft.com/rest/api/faceapi/largefacelist/delete) + + is called. + +
Find Similar is used for scenario like finding celebrity-like + + faces, similar face filtering, or as a light way face identification. + + But if the actual use is to identify person, please use + + [PersonGroup](https://docs.microsoft.com/rest/api/faceapi/persongroup) + + / + + [LargePersonGroup](https://docs.microsoft.com/rest/api/faceapi/largepersongroup) + + and [Face - + + Identify](https://docs.microsoft.com/rest/api/faceapi/face/identify). + +
''recognitionModel'' should be specified to associate with this + + large face list. The default value for ''recognitionModel'' is + + ''recognition_01'', if the latest model needed, please explicitly specify + + the model you need in this parameter. New faces that are added to an + + existing large face list will use the recognition model that''s already + + associated with the collection. Existing face features in a large face + + list can''t be updated to features extracted by another version of + + recognition model. Please refer to [Specify a recognition + + model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model). + + Large face list quota: + + * Free-tier subscription quota: 64 large face lists. + + * S0-tier subscription quota: 1,000,000 large face lists.' + signature: create(large_face_list_id, name, user_data=None, recognition_model='recognition_01', + custom_headers=None, raw=False, **operation_config) + parameters: + - name: large_face_list_id + description: 'Id referencing a particular large face + + list.' + isRequired: true + types: + - + - name: name + description: User defined name, maximum length is 128. + isRequired: true + types: + - + - name: user_data + description: User specified data. Length should not exceed 16KB. + defaultValue: None + types: + - + - name: recognition_model + description: 'Possible values include: ''recognition_01'', + + ''recognition_02'', ''recognition_03'', ''recognition_04''' + defaultValue: recognition_01 + types: + - + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargeFaceListOperations.delete + name: delete + summary: Delete a specified large face list. + signature: delete(large_face_list_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: large_face_list_id + description: 'Id referencing a particular large face + + list.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargeFaceListOperations.delete_face + name: delete_face + summary: 'Delete a face from a large face list by specified largeFaceListId and + + persistedFaceId. + +
Adding/deleting faces to/from a same large face list are + + processed sequentially and to/from different large face lists are in + + parallel.' + signature: delete_face(large_face_list_id, persisted_face_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: large_face_list_id + description: 'Id referencing a particular large face + + list.' + isRequired: true + types: + - + - name: persisted_face_id + description: 'Id referencing a particular persistedFaceId + + of an existing face.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargeFaceListOperations.get + name: get + summary: 'Retrieve a large face list''s largeFaceListId, name, userData and + + recognitionModel.' + signature: get(large_face_list_id, return_recognition_model=False, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: large_face_list_id + description: 'Id referencing a particular large face + + list.' + isRequired: true + types: + - + - name: return_recognition_model + description: 'A value indicating whether the + + operation should return ''recognitionModel'' in response.' + defaultValue: 'False' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: LargeFaceList or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargeFaceListOperations.get_face + name: get_face + summary: 'Retrieve information about a persisted face (specified by + + persistedFaceId and its belonging largeFaceListId).' + signature: get_face(large_face_list_id, persisted_face_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: large_face_list_id + description: 'Id referencing a particular large face + + list.' + isRequired: true + types: + - + - name: persisted_face_id + description: 'Id referencing a particular persistedFaceId + + of an existing face.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: PersistedFace or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargeFaceListOperations.get_training_status + name: get_training_status + summary: 'Retrieve the training status of a large face list (completed or + + ongoing).' + signature: get_training_status(large_face_list_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: large_face_list_id + description: 'Id referencing a particular large face + + list.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: TrainingStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargeFaceListOperations.list + name: list + summary: 'List large face lists'' information of largeFaceListId, name, userData + + and recognitionModel.
+ + To get face information inside largeFaceList use [LargeFaceList Face - + + Get](https://docs.microsoft.com/rest/api/faceapi/largefacelist/getface)
+ + * Large face lists are stored in alphabetical order of largeFaceListId. + + * "start" parameter (string, optional) is a user-provided + + largeFaceListId value that returned entries have larger ids by string + + comparison. "start" set to empty to indicate return from the first + + item. + + * "top" parameter (int, optional) specifies the number of entries to + + return. A maximal of 1000 entries can be returned in one call. To fetch + + more, you can specify "start" with the last returned entry''s Id of the + + current call. + +
+ + For example, total 5 large person lists: "list1", ..., "list5". + +
"start=&top=" will return all 5 lists. + +
"start=&top=2" will return "list1", "list2". + +
"start=list2&top=3" will return "list3", "list4", "list5". + + .' + signature: list(return_recognition_model=False, start=None, top=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: return_recognition_model + description: 'A value indicating whether the + + operation should return ''recognitionModel'' in response.' + defaultValue: 'False' + types: + - + - name: start + description: 'Starting large face list id to return (used to list a + + range of large face lists).' + defaultValue: None + types: + - + - name: top + description: 'Number of large face lists to return starting with the + + large face list id indicated by the ''start'' parameter.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargeFaceListOperations.list_faces + name: list_faces + summary: 'List all faces in a large face list, and retrieve face information + + (including userData and persistedFaceIds of registered faces of the + + face).' + signature: list_faces(large_face_list_id, start=None, top=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: large_face_list_id + description: 'Id referencing a particular large face + + list.' + isRequired: true + types: + - + - name: start + description: 'Starting face id to return (used to list a range of + + faces).' + defaultValue: None + types: + - + - name: top + description: 'Number of faces to return starting with the face id + + indicated by the ''start'' parameter.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargeFaceListOperations.train + name: train + summary: 'Queue a large face list training task, the training task may not be + + started immediately.' + signature: train(large_face_list_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: large_face_list_id + description: 'Id referencing a particular large face + + list.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargeFaceListOperations.update + name: update + summary: Update information of a large face list. + signature: update(large_face_list_id, name=None, user_data=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: large_face_list_id + description: 'Id referencing a particular large face + + list.' + isRequired: true + types: + - + - name: name + description: User defined name, maximum length is 128. + defaultValue: None + types: + - + - name: user_data + description: User specified data. Length should not exceed 16KB. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargeFaceListOperations.update_face + name: update_face + summary: Update a persisted face's userData field. + signature: update_face(large_face_list_id, persisted_face_id, user_data=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: large_face_list_id + description: 'Id referencing a particular large face + + list.' + isRequired: true + types: + - + - name: persisted_face_id + description: 'Id referencing a particular persistedFaceId + + of an existing face.' + isRequired: true + types: + - + - name: user_data + description: 'User-provided data attached to the face. The size + + limit is 1KB.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +attributes: +- uid: azure.cognitiveservices.vision.face.operations.LargeFaceListOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.LargePersonGroupOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.LargePersonGroupOperations.yml new file mode 100644 index 00000000..ce089ae5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.LargePersonGroupOperations.yml @@ -0,0 +1,446 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.operations.LargePersonGroupOperations +name: LargePersonGroupOperations +fullName: azure.cognitiveservices.vision.face.operations.LargePersonGroupOperations +module: azure.cognitiveservices.vision.face.operations +summary: 'LargePersonGroupOperations operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: LargePersonGroupOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.operations.LargePersonGroupOperations.create + name: create + summary: 'Create a new large person group with user-specified largePersonGroupId, + + name, an optional userData and recognitionModel. + +
A large person group is the container of the uploaded person + + data, including face recognition feature, and up to 1,000,000 + + people. + +
After creation, use [LargePersonGroup Person - + + Create](https://docs.microsoft.com/rest/api/faceapi/largepersongroupperson/create) + + to add person into the group, and call [LargePersonGroup - + + Train](https://docs.microsoft.com/rest/api/faceapi/largepersongroup/train) + + to get this group ready for [Face - + + Identify](https://docs.microsoft.com/rest/api/faceapi/face/identify). + +
No image will be stored. Only the person''s extracted face + + features and userData will be stored on server until [LargePersonGroup + + Person - + + Delete](https://docs.microsoft.com/rest/api/faceapi/largepersongroupperson/delete) + + or [LargePersonGroup - + + Delete](https://docs.microsoft.com/rest/api/faceapi/largepersongroup/delete) + + is called. + +
''recognitionModel'' should be specified to associate with this + + large person group. The default value for ''recognitionModel'' is + + ''recognition_01'', if the latest model needed, please explicitly specify + + the model you need in this parameter. New faces that are added to an + + existing large person group will use the recognition model that''s + + already associated with the collection. Existing face features in a + + large person group can''t be updated to features extracted by another + + version of recognition model. Please refer to [Specify a face + + recognition + + model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model). + + Large person group quota: + + * Free-tier subscription quota: 1,000 large person groups. + + * S0-tier subscription quota: 1,000,000 large person groups.' + signature: create(large_person_group_id, name, user_data=None, recognition_model='recognition_01', + custom_headers=None, raw=False, **operation_config) + parameters: + - name: large_person_group_id + description: 'Id referencing a particular large person + + group.' + isRequired: true + types: + - + - name: name + description: User defined name, maximum length is 128. + isRequired: true + types: + - + - name: user_data + description: User specified data. Length should not exceed 16KB. + defaultValue: None + types: + - + - name: recognition_model + description: 'Possible values include: ''recognition_01'', + + ''recognition_02'', ''recognition_03'', ''recognition_04''' + defaultValue: recognition_01 + types: + - + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargePersonGroupOperations.delete + name: delete + summary: 'Delete an existing large person group. Persisted face features of all + + people in the large person group will also be deleted.' + signature: delete(large_person_group_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: large_person_group_id + description: 'Id referencing a particular large person + + group.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargePersonGroupOperations.get + name: get + summary: 'Retrieve the information of a large person group, including its name, + + userData and recognitionModel. This API returns large person group + + information only, use [LargePersonGroup Person - + + List](https://docs.microsoft.com/rest/api/faceapi/largepersongroupperson/list) + + instead to retrieve person information under the large person group. + + .' + signature: get(large_person_group_id, return_recognition_model=False, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: large_person_group_id + description: 'Id referencing a particular large person + + group.' + isRequired: true + types: + - + - name: return_recognition_model + description: 'A value indicating whether the + + operation should return ''recognitionModel'' in response.' + defaultValue: 'False' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: LargePersonGroup or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargePersonGroupOperations.get_training_status + name: get_training_status + summary: 'Retrieve the training status of a large person group (completed or + + ongoing).' + signature: get_training_status(large_person_group_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: large_person_group_id + description: 'Id referencing a particular large person + + group.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: TrainingStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargePersonGroupOperations.list + name: list + summary: 'List all existing large person groups'' largePersonGroupId, name, + + userData and recognitionModel.
+ + * Large person groups are stored in alphabetical order of + + largePersonGroupId. + + * "start" parameter (string, optional) is a user-provided + + largePersonGroupId value that returned entries have larger ids by + + string comparison. "start" set to empty to indicate return from the + + first item. + + * "top" parameter (int, optional) specifies the number of entries to + + return. A maximal of 1000 entries can be returned in one call. To fetch + + more, you can specify "start" with the last returned entry''s Id of the + + current call. + +
+ + For example, total 5 large person groups: "group1", ..., "group5". + +
"start=&top=" will return all 5 groups. + +
"start=&top=2" will return "group1", "group2". + +
"start=group2&top=3" will return "group3", "group4", "group5". + + .' + signature: list(start=None, top=1000, return_recognition_model=False, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: start + description: 'List large person groups from the least + + largePersonGroupId greater than the "start".' + defaultValue: None + types: + - + - name: top + description: The number of large person groups to list. + defaultValue: '1000' + types: + - + - name: return_recognition_model + description: 'A value indicating whether the + + operation should return ''recognitionModel'' in response.' + defaultValue: 'False' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargePersonGroupOperations.train + name: train + summary: 'Queue a large person group training task, the training task may not be + + started immediately.' + signature: train(large_person_group_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: large_person_group_id + description: 'Id referencing a particular large person + + group.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargePersonGroupOperations.update + name: update + summary: 'Update an existing large person group''s display name and userData. The + + properties which does not appear in request body will not be updated.' + signature: update(large_person_group_id, name=None, user_data=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: large_person_group_id + description: 'Id referencing a particular large person + + group.' + isRequired: true + types: + - + - name: name + description: User defined name, maximum length is 128. + defaultValue: None + types: + - + - name: user_data + description: User specified data. Length should not exceed 16KB. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +attributes: +- uid: azure.cognitiveservices.vision.face.operations.LargePersonGroupOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.LargePersonGroupPersonOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.LargePersonGroupPersonOperations.yml new file mode 100644 index 00000000..b682be52 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.LargePersonGroupPersonOperations.yml @@ -0,0 +1,765 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.operations.LargePersonGroupPersonOperations +name: LargePersonGroupPersonOperations +fullName: azure.cognitiveservices.vision.face.operations.LargePersonGroupPersonOperations +module: azure.cognitiveservices.vision.face.operations +summary: 'LargePersonGroupPersonOperations operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: LargePersonGroupPersonOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.operations.LargePersonGroupPersonOperations.add_face_from_stream + name: add_face_from_stream + summary: 'Add a face to a person into a large person group for face + + identification or verification. To deal with an image contains multiple + + faces, input face can be specified as an image with a targetFace + + rectangle. It returns a persistedFaceId representing the added face. No + + image will be stored. Only the extracted face feature will be stored on + + server until [LargePersonGroup PersonFace - + + Delete](https://docs.microsoft.com/rest/api/faceapi/largepersongroupperson/deleteface), + + [LargePersonGroup Person - + + Delete](https://docs.microsoft.com/rest/api/faceapi/largepersongroupperson/delete) + + or [LargePersonGroup - + + Delete](https://docs.microsoft.com/rest/api/faceapi/largepersongroup/delete) + + is called. + +
Note persistedFaceId is different from faceId generated by [Face + + - + + Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl). + + * Higher face image quality means better recognition precision. Please + + consider high-quality faces: frontal, clear, and face size is 200x200 + + pixels (100 pixels between eyes) or bigger. + + * Each person entry can hold up to 248 faces. + + * JPEG, PNG, GIF (the first frame), and BMP format are supported. The + + allowed image file size is from 1KB to 6MB. + + * "targetFace" rectangle should contain one face. Zero or multiple + + faces will be regarded as an error. If the provided "targetFace" + + rectangle is not returned from [Face - + + Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl), + + there''s no guarantee to detect and add the face successfully. + + * Out of detectable face size (36x36 - 4096x4096 pixels), large + + head-pose, or large occlusions will cause failures. + + * Adding/deleting faces to/from a same person will be processed + + sequentially. Adding/deleting faces to/from different persons are + + processed in parallel. + + * The minimum detectable face size is 36x36 pixels in an image no + + larger than 1920x1080 pixels. Images with dimensions higher than + + 1920x1080 pixels will need a proportionally larger minimum face size. + + * Different ''detectionModel'' values can be provided. To use and compare + + different detection models, please refer to [How to specify a detection + + model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model).' + signature: add_face_from_stream(large_person_group_id, person_id, image, user_data=None, + target_face=None, detection_model='detection_01', custom_headers=None, raw=False, + callback=None, **operation_config) + parameters: + - name: large_person_group_id + description: 'Id referencing a particular large person + + group.' + isRequired: true + types: + - + - name: person_id + description: Id referencing a particular person. + isRequired: true + types: + - + - name: image + description: An image stream. + isRequired: true + types: + - + - name: user_data + description: 'User-specified data about the face for any purpose. + + The maximum length is 1KB.' + defaultValue: None + types: + - + - name: target_face + description: 'A face rectangle to specify the target face to be + + added to a person in the format of "targetFace=left,top,width,height". + + E.g. "targetFace=10,10,100,100". If there is more than one face in the + + image, targetFace is required to specify which face to add. No + + targetFace means there is only one face detected in the entire image.' + defaultValue: None + types: + - [] + - name: detection_model + description: 'Name of detection model. Detection model is + + used to detect faces in the submitted image. A detection model name + + can be provided when performing Face - Detect or (Large)FaceList - Add + + Face or (Large)PersonGroup - Add Face. The default value is + + ''detection_01'', if another model is needed, please explicitly specify + + it. Possible values include: ''detection_01'', ''detection_02'', + + ''detection_03''' + defaultValue: detection_01 + types: + - + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: PersistedFace or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargePersonGroupPersonOperations.add_face_from_url + name: add_face_from_url + summary: 'Add a face to a person into a large person group for face + + identification or verification. To deal with an image contains multiple + + faces, input face can be specified as an image with a targetFace + + rectangle. It returns a persistedFaceId representing the added face. No + + image will be stored. Only the extracted face feature will be stored on + + server until [LargePersonGroup PersonFace - + + Delete](https://docs.microsoft.com/rest/api/faceapi/largepersongroupperson/deleteface), + + [LargePersonGroup Person - + + Delete](https://docs.microsoft.com/rest/api/faceapi/largepersongroupperson/delete) + + or [LargePersonGroup - + + Delete](https://docs.microsoft.com/rest/api/faceapi/largepersongroup/delete) + + is called. + +
Note persistedFaceId is different from faceId generated by [Face + + - + + Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl). + + * Higher face image quality means better recognition precision. Please + + consider high-quality faces: frontal, clear, and face size is 200x200 + + pixels (100 pixels between eyes) or bigger. + + * Each person entry can hold up to 248 faces. + + * JPEG, PNG, GIF (the first frame), and BMP format are supported. The + + allowed image file size is from 1KB to 6MB. + + * "targetFace" rectangle should contain one face. Zero or multiple + + faces will be regarded as an error. If the provided "targetFace" + + rectangle is not returned from [Face - + + Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl), + + there''s no guarantee to detect and add the face successfully. + + * Out of detectable face size (36x36 - 4096x4096 pixels), large + + head-pose, or large occlusions will cause failures. + + * Adding/deleting faces to/from a same person will be processed + + sequentially. Adding/deleting faces to/from different persons are + + processed in parallel. + + * The minimum detectable face size is 36x36 pixels in an image no + + larger than 1920x1080 pixels. Images with dimensions higher than + + 1920x1080 pixels will need a proportionally larger minimum face size. + + * Different ''detectionModel'' values can be provided. To use and compare + + different detection models, please refer to [How to specify a detection + + model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model).' + signature: add_face_from_url(large_person_group_id, person_id, url, user_data=None, + target_face=None, detection_model='detection_01', custom_headers=None, raw=False, + **operation_config) + parameters: + - name: large_person_group_id + description: 'Id referencing a particular large person + + group.' + isRequired: true + types: + - + - name: person_id + description: Id referencing a particular person. + isRequired: true + types: + - + - name: url + description: Publicly reachable URL of an image + isRequired: true + types: + - + - name: user_data + description: 'User-specified data about the face for any purpose. + + The maximum length is 1KB.' + defaultValue: None + types: + - + - name: target_face + description: 'A face rectangle to specify the target face to be + + added to a person in the format of "targetFace=left,top,width,height". + + E.g. "targetFace=10,10,100,100". If there is more than one face in the + + image, targetFace is required to specify which face to add. No + + targetFace means there is only one face detected in the entire image.' + defaultValue: None + types: + - [] + - name: detection_model + description: 'Name of detection model. Detection model is + + used to detect faces in the submitted image. A detection model name + + can be provided when performing Face - Detect or (Large)FaceList - Add + + Face or (Large)PersonGroup - Add Face. The default value is + + ''detection_01'', if another model is needed, please explicitly specify + + it. Possible values include: ''detection_01'', ''detection_02'', + + ''detection_03''' + defaultValue: detection_01 + types: + - + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: PersistedFace or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargePersonGroupPersonOperations.create + name: create + summary: Create a new person in a specified large person group. + signature: create(large_person_group_id, name=None, user_data=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: large_person_group_id + description: 'Id referencing a particular large person + + group.' + isRequired: true + types: + - + - name: name + description: User defined name, maximum length is 128. + defaultValue: None + types: + - + - name: user_data + description: User specified data. Length should not exceed 16KB. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Person or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargePersonGroupPersonOperations.delete + name: delete + summary: 'Delete an existing person from a large person group. The + + persistedFaceId, userData, person name and face feature in the person + + entry will all be deleted.' + signature: delete(large_person_group_id, person_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: large_person_group_id + description: 'Id referencing a particular large person + + group.' + isRequired: true + types: + - + - name: person_id + description: Id referencing a particular person. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargePersonGroupPersonOperations.delete_face + name: delete_face + summary: 'Delete a face from a person in a large person group by specified + + largePersonGroupId, personId and persistedFaceId. + +
Adding/deleting faces to/from a same person will be processed + + sequentially. Adding/deleting faces to/from different persons are + + processed in parallel.' + signature: delete_face(large_person_group_id, person_id, persisted_face_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: large_person_group_id + description: 'Id referencing a particular large person + + group.' + isRequired: true + types: + - + - name: person_id + description: Id referencing a particular person. + isRequired: true + types: + - + - name: persisted_face_id + description: 'Id referencing a particular persistedFaceId + + of an existing face.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargePersonGroupPersonOperations.get + name: get + summary: 'Retrieve a person''s name and userData, and the persisted faceIds + + representing the registered person face feature.' + signature: get(large_person_group_id, person_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: large_person_group_id + description: 'Id referencing a particular large person + + group.' + isRequired: true + types: + - + - name: person_id + description: Id referencing a particular person. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Person or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargePersonGroupPersonOperations.get_face + name: get_face + summary: 'Retrieve information about a persisted face (specified by + + persistedFaceId, personId and its belonging largePersonGroupId).' + signature: get_face(large_person_group_id, person_id, persisted_face_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: large_person_group_id + description: 'Id referencing a particular large person + + group.' + isRequired: true + types: + - + - name: person_id + description: Id referencing a particular person. + isRequired: true + types: + - + - name: persisted_face_id + description: 'Id referencing a particular persistedFaceId + + of an existing face.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: PersistedFace or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargePersonGroupPersonOperations.list + name: list + summary: 'List all persons in a large person group, and retrieve person + + information (including personId, name, userData and persistedFaceIds of + + registered faces of the person).' + signature: list(large_person_group_id, start=None, top=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: large_person_group_id + description: 'Id referencing a particular large person + + group.' + isRequired: true + types: + - + - name: start + description: 'Starting person id to return (used to list a range of + + persons).' + defaultValue: None + types: + - + - name: top + description: 'Number of persons to return starting with the person id + + indicated by the ''start'' parameter.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargePersonGroupPersonOperations.update + name: update + summary: Update name or userData of a person. + signature: update(large_person_group_id, person_id, name=None, user_data=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: large_person_group_id + description: 'Id referencing a particular large person + + group.' + isRequired: true + types: + - + - name: person_id + description: Id referencing a particular person. + isRequired: true + types: + - + - name: name + description: User defined name, maximum length is 128. + defaultValue: None + types: + - + - name: user_data + description: User specified data. Length should not exceed 16KB. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.LargePersonGroupPersonOperations.update_face + name: update_face + summary: Update a person persisted face's userData field. + signature: update_face(large_person_group_id, person_id, persisted_face_id, user_data=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: large_person_group_id + description: 'Id referencing a particular large person + + group.' + isRequired: true + types: + - + - name: person_id + description: Id referencing a particular person. + isRequired: true + types: + - + - name: persisted_face_id + description: 'Id referencing a particular persistedFaceId + + of an existing face.' + isRequired: true + types: + - + - name: user_data + description: 'User-provided data attached to the face. The size + + limit is 1KB.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +attributes: +- uid: azure.cognitiveservices.vision.face.operations.LargePersonGroupPersonOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.PersonGroupOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.PersonGroupOperations.yml new file mode 100644 index 00000000..b73b7d22 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.PersonGroupOperations.yml @@ -0,0 +1,426 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.operations.PersonGroupOperations +name: PersonGroupOperations +fullName: azure.cognitiveservices.vision.face.operations.PersonGroupOperations +module: azure.cognitiveservices.vision.face.operations +summary: 'PersonGroupOperations operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: PersonGroupOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.operations.PersonGroupOperations.create + name: create + summary: 'Create a new person group with specified personGroupId, name, + + user-provided userData and recognitionModel. + +
A person group is the container of the uploaded person data, + + including face recognition features. + +
After creation, use [PersonGroup Person - + + Create](https://docs.microsoft.com/rest/api/faceapi/persongroupperson/create) + + to add persons into the group, and then call [PersonGroup - + + Train](https://docs.microsoft.com/rest/api/faceapi/persongroup/train) + + to get this group ready for [Face - + + Identify](https://docs.microsoft.com/rest/api/faceapi/face/identify). + +
No image will be stored. Only the person''s extracted face + + features and userData will be stored on server until [PersonGroup + + Person - + + Delete](https://docs.microsoft.com/rest/api/faceapi/persongroupperson/delete) + + or [PersonGroup - + + Delete](https://docs.microsoft.com/rest/api/faceapi/persongroup/delete) + + is called. + +
''recognitionModel'' should be specified to associate with this + + person group. The default value for ''recognitionModel'' is + + ''recognition_01'', if the latest model needed, please explicitly specify + + the model you need in this parameter. New faces that are added to an + + existing person group will use the recognition model that''s already + + associated with the collection. Existing face features in a person + + group can''t be updated to features extracted by another version of + + recognition model. + + Person group quota: + + * Free-tier subscription quota: 1,000 person groups. Each holds up to + + 1,000 persons. + + * S0-tier subscription quota: 1,000,000 person groups. Each holds up to + + 10,000 persons. + + * to handle larger scale face identification problem, please consider + + using + + [LargePersonGroup](https://docs.microsoft.com/rest/api/faceapi/largepersongroup).' + signature: create(person_group_id, name, user_data=None, recognition_model='recognition_01', + custom_headers=None, raw=False, **operation_config) + parameters: + - name: person_group_id + description: Id referencing a particular person group. + isRequired: true + types: + - + - name: name + description: User defined name, maximum length is 128. + isRequired: true + types: + - + - name: user_data + description: User specified data. Length should not exceed 16KB. + defaultValue: None + types: + - + - name: recognition_model + description: 'Possible values include: ''recognition_01'', + + ''recognition_02'', ''recognition_03'', ''recognition_04''' + defaultValue: recognition_01 + types: + - + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.PersonGroupOperations.delete + name: delete + summary: 'Delete an existing person group. Persisted face features of all people + + in the person group will also be deleted.' + signature: delete(person_group_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: person_group_id + description: Id referencing a particular person group. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.PersonGroupOperations.get + name: get + summary: 'Retrieve person group name, userData and recognitionModel. To get + + person information under this personGroup, use [PersonGroup Person - + + List](https://docs.microsoft.com/rest/api/faceapi/persongroupperson/list).' + signature: get(person_group_id, return_recognition_model=False, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: person_group_id + description: Id referencing a particular person group. + isRequired: true + types: + - + - name: return_recognition_model + description: 'A value indicating whether the + + operation should return ''recognitionModel'' in response.' + defaultValue: 'False' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: PersonGroup or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.PersonGroupOperations.get_training_status + name: get_training_status + summary: Retrieve the training status of a person group (completed or ongoing). + signature: get_training_status(person_group_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: person_group_id + description: Id referencing a particular person group. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: TrainingStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.PersonGroupOperations.list + name: list + summary: 'List person groups'' personGroupId, name, userData and + + recognitionModel.
+ + * Person groups are stored in alphabetical order of personGroupId. + + * "start" parameter (string, optional) is a user-provided personGroupId + + value that returned entries have larger ids by string comparison. + + "start" set to empty to indicate return from the first item. + + * "top" parameter (int, optional) specifies the number of entries to + + return. A maximal of 1000 entries can be returned in one call. To fetch + + more, you can specify "start" with the last returned entry''s Id of the + + current call. + +
+ + For example, total 5 person groups: "group1", ..., "group5". + +
"start=&top=" will return all 5 groups. + +
"start=&top=2" will return "group1", "group2". + +
"start=group2&top=3" will return "group3", "group4", "group5". + + .' + signature: list(start=None, top=1000, return_recognition_model=False, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: start + description: 'List person groups from the least personGroupId greater + + than the "start".' + defaultValue: None + types: + - + - name: top + description: The number of person groups to list. + defaultValue: '1000' + types: + - + - name: return_recognition_model + description: 'A value indicating whether the + + operation should return ''recognitionModel'' in response.' + defaultValue: 'False' + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.PersonGroupOperations.train + name: train + summary: 'Queue a person group training task, the training task may not be + + started immediately.' + signature: train(person_group_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: person_group_id + description: Id referencing a particular person group. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.PersonGroupOperations.update + name: update + summary: 'Update an existing person group''s display name and userData. The + + properties which does not appear in request body will not be updated.' + signature: update(person_group_id, name=None, user_data=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: person_group_id + description: Id referencing a particular person group. + isRequired: true + types: + - + - name: name + description: User defined name, maximum length is 128. + defaultValue: None + types: + - + - name: user_data + description: User specified data. Length should not exceed 16KB. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +attributes: +- uid: azure.cognitiveservices.vision.face.operations.PersonGroupOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.PersonGroupPersonOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.PersonGroupPersonOperations.yml new file mode 100644 index 00000000..771bb137 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.PersonGroupPersonOperations.yml @@ -0,0 +1,802 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.operations.PersonGroupPersonOperations +name: PersonGroupPersonOperations +fullName: azure.cognitiveservices.vision.face.operations.PersonGroupPersonOperations +module: azure.cognitiveservices.vision.face.operations +summary: 'PersonGroupPersonOperations operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: PersonGroupPersonOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.operations.PersonGroupPersonOperations.add_face_from_stream + name: add_face_from_stream + summary: 'Add a face to a person into a person group for face identification or + + verification. To deal with an image contains multiple faces, input face + + can be specified as an image with a targetFace rectangle. It returns a + + persistedFaceId representing the added face. No image will be stored. + + Only the extracted face feature will be stored on server until + + [PersonGroup PersonFace - + + Delete](https://docs.microsoft.com/rest/api/faceapi/persongroupperson/deleteface), + + [PersonGroup Person - + + Delete](https://docs.microsoft.com/rest/api/faceapi/persongroupperson/delete) + + or [PersonGroup - + + Delete](https://docs.microsoft.com/rest/api/faceapi/persongroup/delete) + + is called. + +
Note persistedFaceId is different from faceId generated by [Face + + - + + Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl). + + * Higher face image quality means better recognition precision. + + Please consider high-quality faces: frontal, clear, and face size is + + 200x200 pixels (100 pixels between eyes) or bigger. + + * Each person entry can hold up to 248 faces. + + * JPEG, PNG, GIF (the first frame), and BMP format are supported. The + + allowed image file size is from 1KB to 6MB. + + * "targetFace" rectangle should contain one face. Zero or multiple + + faces will be regarded as an error. If the provided "targetFace" + + rectangle is not returned from [Face - + + Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl), + + there''s no guarantee to detect and add the face successfully. + + * Out of detectable face size (36x36 - 4096x4096 pixels), large + + head-pose, or large occlusions will cause failures. + + * Adding/deleting faces to/from a same person will be processed + + sequentially. Adding/deleting faces to/from different persons are + + processed in parallel. + + * The minimum detectable face size is 36x36 pixels in an image no + + larger than 1920x1080 pixels. Images with dimensions higher than + + 1920x1080 pixels will need a proportionally larger minimum face size. + + * Different ''detectionModel'' values can be provided. To use and compare + + different detection models, please refer to [How to specify a detection + + model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model).' + signature: add_face_from_stream(person_group_id, person_id, image, user_data=None, + target_face=None, detection_model='detection_01', custom_headers=None, raw=False, + callback=None, **operation_config) + parameters: + - name: person_group_id + description: Id referencing a particular person group. + isRequired: true + types: + - + - name: person_id + description: Id referencing a particular person. + isRequired: true + types: + - + - name: image + description: An image stream. + isRequired: true + types: + - + - name: user_data + description: 'User-specified data about the face for any purpose. + + The maximum length is 1KB.' + defaultValue: None + types: + - + - name: target_face + description: 'A face rectangle to specify the target face to be + + added to a person in the format of "targetFace=left,top,width,height". + + E.g. "targetFace=10,10,100,100". If there is more than one face in the + + image, targetFace is required to specify which face to add. No + + targetFace means there is only one face detected in the entire image.' + defaultValue: None + types: + - [] + - name: detection_model + description: 'Name of detection model. Detection model is + + used to detect faces in the submitted image. A detection model name + + can be provided when performing Face - Detect or (Large)FaceList - Add + + Face or (Large)PersonGroup - Add Face. The default value is + + ''detection_01'', if another model is needed, please explicitly specify + + it. Possible values include: ''detection_01'', ''detection_02'', + + ''detection_03''' + defaultValue: detection_01 + types: + - + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: callback + description: 'When specified, will be called with each chunk of + + data that is streamed. The callback should take two arguments, the + + bytes of the current chunk of data and the response object. If the + + data is uploading, response will be None.' + defaultValue: None + types: + - [, ] + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: PersistedFace or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.PersonGroupPersonOperations.add_face_from_url + name: add_face_from_url + summary: 'Add a face to a person into a person group for face identification or + + verification. To deal with an image contains multiple faces, input face + + can be specified as an image with a targetFace rectangle. It returns a + + persistedFaceId representing the added face. No image will be stored. + + Only the extracted face feature will be stored on server until + + [PersonGroup PersonFace - + + Delete](https://docs.microsoft.com/rest/api/faceapi/persongroupperson/deleteface), + + [PersonGroup Person - + + Delete](https://docs.microsoft.com/rest/api/faceapi/persongroupperson/delete) + + or [PersonGroup - + + Delete](https://docs.microsoft.com/rest/api/faceapi/persongroup/delete) + + is called. + +
Note persistedFaceId is different from faceId generated by [Face + + - + + Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl). + + * Higher face image quality means better recognition precision. + + Please consider high-quality faces: frontal, clear, and face size is + + 200x200 pixels (100 pixels between eyes) or bigger. + + * Each person entry can hold up to 248 faces. + + * JPEG, PNG, GIF (the first frame), and BMP format are supported. The + + allowed image file size is from 1KB to 6MB. + + * "targetFace" rectangle should contain one face. Zero or multiple + + faces will be regarded as an error. If the provided "targetFace" + + rectangle is not returned from [Face - + + Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl), + + there''s no guarantee to detect and add the face successfully. + + * Out of detectable face size (36x36 - 4096x4096 pixels), large + + head-pose, or large occlusions will cause failures. + + * Adding/deleting faces to/from a same person will be processed + + sequentially. Adding/deleting faces to/from different persons are + + processed in parallel. + + * The minimum detectable face size is 36x36 pixels in an image no + + larger than 1920x1080 pixels. Images with dimensions higher than + + 1920x1080 pixels will need a proportionally larger minimum face size. + + * Different ''detectionModel'' values can be provided. To use and compare + + different detection models, please refer to [How to specify a detection + + model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model).' + signature: add_face_from_url(person_group_id, person_id, url, user_data=None, target_face=None, + detection_model='detection_01', custom_headers=None, raw=False, **operation_config) + parameters: + - name: person_group_id + description: Id referencing a particular person group. + isRequired: true + types: + - + - name: person_id + description: Id referencing a particular person. + isRequired: true + types: + - + - name: url + description: Publicly reachable URL of an image + isRequired: true + types: + - + - name: user_data + description: 'User-specified data about the face for any purpose. + + The maximum length is 1KB.' + defaultValue: None + types: + - + - name: target_face + description: 'A face rectangle to specify the target face to be + + added to a person in the format of "targetFace=left,top,width,height". + + E.g. "targetFace=10,10,100,100". If there is more than one face in the + + image, targetFace is required to specify which face to add. No + + targetFace means there is only one face detected in the entire image.' + defaultValue: None + types: + - [] + - name: detection_model + description: 'Name of detection model. Detection model is + + used to detect faces in the submitted image. A detection model name + + can be provided when performing Face - Detect or (Large)FaceList - Add + + Face or (Large)PersonGroup - Add Face. The default value is + + ''detection_01'', if another model is needed, please explicitly specify + + it. Possible values include: ''detection_01'', ''detection_02'', + + ''detection_03''' + defaultValue: detection_01 + types: + - + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: PersistedFace or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.PersonGroupPersonOperations.create + name: create + summary: Create a new person in a specified person group. + signature: create(person_group_id, name=None, user_data=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: person_group_id + description: Id referencing a particular person group. + isRequired: true + types: + - + - name: name + description: User defined name, maximum length is 128. + defaultValue: None + types: + - + - name: user_data + description: User specified data. Length should not exceed 16KB. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Person or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.PersonGroupPersonOperations.delete + name: delete + summary: 'Delete an existing person from a person group. The persistedFaceId, + + userData, person name and face feature in the person entry will all be + + deleted.' + signature: delete(person_group_id, person_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: person_group_id + description: Id referencing a particular person group. + isRequired: true + types: + - + - name: person_id + description: Id referencing a particular person. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.PersonGroupPersonOperations.delete_face + name: delete_face + summary: 'Delete a face from a person in a person group by specified + + personGroupId, personId and persistedFaceId. + +
Adding/deleting faces to/from a same person will be processed + + sequentially. Adding/deleting faces to/from different persons are + + processed in parallel.' + signature: delete_face(person_group_id, person_id, persisted_face_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: person_group_id + description: Id referencing a particular person group. + isRequired: true + types: + - + - name: person_id + description: Id referencing a particular person. + isRequired: true + types: + - + - name: persisted_face_id + description: 'Id referencing a particular persistedFaceId + + of an existing face.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.PersonGroupPersonOperations.get + name: get + summary: 'Retrieve a person''s information, including registered persisted faces, + + name and userData.' + signature: get(person_group_id, person_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: person_group_id + description: Id referencing a particular person group. + isRequired: true + types: + - + - name: person_id + description: Id referencing a particular person. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Person or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.PersonGroupPersonOperations.get_face + name: get_face + summary: 'Retrieve information about a persisted face (specified by + + persistedFaceId, personId and its belonging personGroupId).' + signature: get_face(person_group_id, person_id, persisted_face_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: person_group_id + description: Id referencing a particular person group. + isRequired: true + types: + - + - name: person_id + description: Id referencing a particular person. + isRequired: true + types: + - + - name: persisted_face_id + description: 'Id referencing a particular persistedFaceId + + of an existing face.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: PersistedFace or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.PersonGroupPersonOperations.list + name: list + summary: 'List all persons in a person group, and retrieve person information + + (including personId, name, userData and persistedFaceIds of registered + + faces of the person).' + signature: list(person_group_id, start=None, top=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: person_group_id + description: Id referencing a particular person group. + isRequired: true + types: + - + - name: start + description: 'Starting person id to return (used to list a range of + + persons).' + defaultValue: None + types: + - + - name: top + description: 'Number of persons to return starting with the person id + + indicated by the ''start'' parameter.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.PersonGroupPersonOperations.update + name: update + summary: Update name or userData of a person. + signature: update(person_group_id, person_id, name=None, user_data=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: person_group_id + description: Id referencing a particular person group. + isRequired: true + types: + - + - name: person_id + description: Id referencing a particular person. + isRequired: true + types: + - + - name: name + description: User defined name, maximum length is 128. + defaultValue: None + types: + - + - name: user_data + description: User specified data. Length should not exceed 16KB. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.PersonGroupPersonOperations.update_face + name: update_face + summary: 'Add a face to a person into a person group for face identification or + + verification. To deal with an image contains multiple faces, input face + + can be specified as an image with a targetFace rectangle. It returns a + + persistedFaceId representing the added face. No image will be stored. + + Only the extracted face feature will be stored on server until + + [PersonGroup PersonFace - + + Delete](https://docs.microsoft.com/rest/api/faceapi/persongroupperson/deleteface), + + [PersonGroup Person - + + Delete](https://docs.microsoft.com/rest/api/faceapi/persongroupperson/delete) + + or [PersonGroup - + + Delete](https://docs.microsoft.com/rest/api/faceapi/persongroup/delete) + + is called. + +
Note persistedFaceId is different from faceId generated by [Face + + - + + Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl). + + * Higher face image quality means better recognition precision. Please + + consider high-quality faces: frontal, clear, and face size is 200x200 + + pixels (100 pixels between eyes) or bigger. + + * Each person entry can hold up to 248 faces. + + * JPEG, PNG, GIF (the first frame), and BMP format are supported. The + + allowed image file size is from 1KB to 6MB. + + * "targetFace" rectangle should contain one face. Zero or multiple + + faces will be regarded as an error. If the provided "targetFace" + + rectangle is not returned from [Face - + + Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl), + + there''s no guarantee to detect and add the face successfully. + + * Out of detectable face size (36x36 - 4096x4096 pixels), large + + head-pose, or large occlusions will cause failures. + + * Adding/deleting faces to/from a same person will be processed + + sequentially. Adding/deleting faces to/from different persons are + + processed in parallel.' + signature: update_face(person_group_id, person_id, persisted_face_id, user_data=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: person_group_id + description: Id referencing a particular person group. + isRequired: true + types: + - + - name: person_id + description: Id referencing a particular person. + isRequired: true + types: + - + - name: persisted_face_id + description: 'Id referencing a particular persistedFaceId + + of an existing face.' + isRequired: true + types: + - + - name: user_data + description: 'User-provided data attached to the face. The size + + limit is 1KB.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +attributes: +- uid: azure.cognitiveservices.vision.face.operations.PersonGroupPersonOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.SnapshotOperations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.SnapshotOperations.yml new file mode 100644 index 00000000..365cba57 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.SnapshotOperations.yml @@ -0,0 +1,522 @@ +### YamlMime:PythonClass +uid: azure.cognitiveservices.vision.face.operations.SnapshotOperations +name: SnapshotOperations +fullName: azure.cognitiveservices.vision.face.operations.SnapshotOperations +module: azure.cognitiveservices.vision.face.operations +summary: 'SnapshotOperations operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: SnapshotOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +methods: +- uid: azure.cognitiveservices.vision.face.operations.SnapshotOperations.apply + name: apply + summary: 'Submit an operation to apply a snapshot to current subscription. For + + each snapshot, only subscriptions included in the applyScope of + + Snapshot - Take can apply it.
+ + The snapshot interfaces are for users to backup and restore their face + + data from one face subscription to another, inside same region or + + across regions. The workflow contains two phases, user first calls + + Snapshot - Take to create a copy of the source object and store it as a + + snapshot, then calls Snapshot - Apply to paste the snapshot to target + + subscription. The snapshots are stored in a centralized location (per + + Azure instance), so that they can be applied cross accounts and + + regions.
+ + Applying snapshot is an asynchronous operation. An operation id can be + + obtained from the "Operation-Location" field in response header, to be + + used in OperationStatus - Get for tracking the progress of applying the + + snapshot. The target object id will be included in the + + "resourceLocation" field in OperationStatus - Get response when the + + operation status is "succeeded".
+ + Snapshot applying time depends on the number of person and face entries + + in the snapshot object. It could be in seconds, or up to 1 hour for + + 1,000,000 persons with multiple faces.
+ + Snapshots will be automatically expired and cleaned in 48 hours after + + it is created by Snapshot - Take. So the target subscription is + + required to apply the snapshot in 48 hours since its creation.
+ + Applying a snapshot will not block any other operations against the + + target object, however it is not recommended because the correctness + + cannot be guaranteed during snapshot applying. After snapshot applying + + is completed, all operations towards the target object can work as + + normal. Snapshot also includes the training results of the source + + object, which means target subscription the snapshot applied to does + + not need re-train the target object before calling + + Identify/FindSimilar.
+ + One snapshot can be applied multiple times in parallel, while currently + + only CreateNew apply mode is supported, which means the apply operation + + will fail if target subscription already contains an object of same + + type and using the same objectId. Users can specify the "objectId" in + + request body to avoid such conflicts.
+ + * Free-tier subscription quota: 100 apply operations per month. + + * S0-tier subscription quota: 100 apply operations per day.' + signature: apply(snapshot_id, object_id, mode='CreateNew', custom_headers=None, + raw=False, **operation_config) + parameters: + - name: snapshot_id + description: Id referencing a particular snapshot. + isRequired: true + types: + - + - name: object_id + description: 'User specified target object id to be created from + + the snapshot.' + isRequired: true + types: + - + - name: mode + description: 'Snapshot applying mode. Currently only CreateNew is + + supported, which means the apply operation will fail if target + + subscription already contains an object of same type and using the + + same objectId. Users can specify the "objectId" in request body to + + avoid such conflicts. Possible values include: ''CreateNew''' + defaultValue: CreateNew + types: + - + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.SnapshotOperations.delete + name: delete + summary: 'Delete an existing snapshot according to the snapshotId. All object + + data and information in the snapshot will also be deleted. Only the + + source subscription who took the snapshot can delete the snapshot. If + + the user does not delete a snapshot with this API, the snapshot will + + still be automatically deleted in 48 hours after creation.' + signature: delete(snapshot_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: snapshot_id + description: Id referencing a particular snapshot. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.SnapshotOperations.get + name: get + summary: 'Retrieve information about a snapshot. Snapshot is only accessible to + + the source subscription who took it, and target subscriptions included + + in the applyScope in Snapshot - Take.' + signature: get(snapshot_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: snapshot_id + description: Id referencing a particular snapshot. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Snapshot or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.SnapshotOperations.get_operation_status + name: get_operation_status + summary: Retrieve the status of a take/apply snapshot operation. + signature: get_operation_status(operation_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: operation_id + description: 'Id referencing a particular take/apply snapshot + + operation.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OperationStatus or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.SnapshotOperations.list + name: list + summary: 'List all accessible snapshots with related information, including + + snapshots that were taken by the user, or snapshots to be applied to + + the user (subscription id was included in the applyScope in Snapshot - + + Take).' + signature: list(type=None, apply_scope=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: type + description: 'User specified object type as a search filter. Possible + + values include: ''FaceList'', ''LargeFaceList'', ''LargePersonGroup'', + + ''PersonGroup''' + defaultValue: None + types: + - + - + - name: apply_scope + description: 'User specified snapshot apply scopes as a search + + filter. ApplyScope is an array of the target Azure subscription ids + + for the snapshot, specified by the user who created the snapshot by + + Snapshot - Take.' + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: list or ClientRawResponse if raw=true + types: + - [] + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.SnapshotOperations.take + name: take + summary: 'Submit an operation to take a snapshot of face list, large face list, + + person group or large person group, with user-specified snapshot type, + + source object id, apply scope and an optional user data.
+ + The snapshot interfaces are for users to backup and restore their face + + data from one face subscription to another, inside same region or + + across regions. The workflow contains two phases, user first calls + + Snapshot - Take to create a copy of the source object and store it as a + + snapshot, then calls Snapshot - Apply to paste the snapshot to target + + subscription. The snapshots are stored in a centralized location (per + + Azure instance), so that they can be applied cross accounts and + + regions.
+ + Taking snapshot is an asynchronous operation. An operation id can be + + obtained from the "Operation-Location" field in response header, to be + + used in OperationStatus - Get for tracking the progress of creating the + + snapshot. The snapshot id will be included in the "resourceLocation" + + field in OperationStatus - Get response when the operation status is + + "succeeded".
+ + Snapshot taking time depends on the number of person and face entries + + in the source object. It could be in seconds, or up to several hours + + for 1,000,000 persons with multiple faces.
+ + Snapshots will be automatically expired and cleaned in 48 hours after + + it is created by Snapshot - Take. User can delete the snapshot using + + Snapshot - Delete by themselves any time before expiration.
+ + Taking snapshot for a certain object will not block any other + + operations against the object. All read-only operations (Get/List and + + Identify/FindSimilar/Verify) can be conducted as usual. For all + + writable operations, including Add/Update/Delete the source object or + + its persons/faces and Train, they are not blocked but not recommended + + because writable updates may not be reflected on the snapshot during + + its taking. After snapshot taking is completed, all readable and + + writable operations can work as normal. Snapshot will also include the + + training results of the source object, which means target subscription + + the snapshot applied to does not need re-train the target object before + + calling Identify/FindSimilar.
+ + * Free-tier subscription quota: 100 take operations per month. + + * S0-tier subscription quota: 100 take operations per day.' + signature: take(type, object_id, apply_scope, user_data=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: type + description: 'User specified type for the source object to take + + snapshot from. Currently FaceList, PersonGroup, LargeFaceList and + + LargePersonGroup are supported. Possible values include: ''FaceList'', + + ''LargeFaceList'', ''LargePersonGroup'', ''PersonGroup''' + isRequired: true + types: + - + - + - name: object_id + description: 'User specified source object id to take snapshot + + from.' + isRequired: true + types: + - + - name: apply_scope + description: 'User specified array of target Face subscription + + ids for the snapshot. For each snapshot, only subscriptions included + + in the applyScope of Snapshot - Take can apply it.' + isRequired: true + types: + - [] + - name: user_data + description: 'User specified data about the snapshot for any + + purpose. Length should not exceed 16KB.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +- uid: azure.cognitiveservices.vision.face.operations.SnapshotOperations.update + name: update + summary: 'Update the information of a snapshot. Only the source subscription who + + took the snapshot can update the snapshot.' + signature: update(snapshot_id, apply_scope=None, user_data=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: snapshot_id + description: Id referencing a particular snapshot. + isRequired: true + types: + - + - name: apply_scope + description: 'Array of the target Face subscription ids for the + + snapshot, specified by the user who created the snapshot when calling + + Snapshot - Take. For each snapshot, only subscriptions included in the + + applyScope of Snapshot - Take can apply it.' + defaultValue: None + types: + - [] + - name: user_data + description: 'User specified data about the snapshot for any + + purpose. Length should not exceed 16KB.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.cognitiveservices.vision.face.models.APIErrorException +attributes: +- uid: azure.cognitiveservices.vision.face.operations.SnapshotOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.yml new file mode 100644 index 00000000..89fc53b7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.operations.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.vision.face.operations +name: operations +fullName: azure.cognitiveservices.vision.face.operations +type: import +classes: +- azure.cognitiveservices.vision.face.operations.FaceListOperations +- azure.cognitiveservices.vision.face.operations.FaceOperations +- azure.cognitiveservices.vision.face.operations.LargeFaceListOperations +- azure.cognitiveservices.vision.face.operations.LargePersonGroupOperations +- azure.cognitiveservices.vision.face.operations.LargePersonGroupPersonOperations +- azure.cognitiveservices.vision.face.operations.PersonGroupOperations +- azure.cognitiveservices.vision.face.operations.PersonGroupPersonOperations +- azure.cognitiveservices.vision.face.operations.SnapshotOperations diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.version.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.version.yml new file mode 100644 index 00000000..2dbfed11 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.cognitiveservices.vision.face.version +name: version +fullName: azure.cognitiveservices.vision.face.version diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.yml new file mode 100644 index 00000000..6c191860 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.cognitiveservices.vision.face +name: face +fullName: azure.cognitiveservices.vision.face +type: rootImport +classes: +- azure.cognitiveservices.vision.face.FaceClient +- azure.cognitiveservices.vision.face.FaceClientConfiguration +packages: +- azure.cognitiveservices.vision.face.models +- azure.cognitiveservices.vision.face.operations +modules: +- azure.cognitiveservices.vision.face.version diff --git a/previous/docs-ref-autogen/azure-common/azure.common.AzureConflictHttpError.yml b/previous/docs-ref-autogen/azure-common/azure.common.AzureConflictHttpError.yml new file mode 100644 index 00000000..de7b6cc1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-common/azure.common.AzureConflictHttpError.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.common.AzureConflictHttpError +name: AzureConflictHttpError +fullName: azure.common.AzureConflictHttpError +module: azure.common +constructor: + syntax: AzureConflictHttpError(message, status_code, *args, **kwargs) + parameters: + - name: message + isRequired: true + - name: status_code + isRequired: true +methods: +- uid: azure.common.AzureConflictHttpError.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.common.AzureConflictHttpError.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.common.AzureConflictHttpError.args + name: args diff --git a/previous/docs-ref-autogen/azure-common/azure.common.AzureException.yml b/previous/docs-ref-autogen/azure-common/azure.common.AzureException.yml new file mode 100644 index 00000000..09ac9201 --- /dev/null +++ b/previous/docs-ref-autogen/azure-common/azure.common.AzureException.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.common.AzureException +name: AzureException +fullName: azure.common.AzureException +module: azure.common +constructor: + syntax: AzureException() +methods: +- uid: azure.common.AzureException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.common.AzureException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.common.AzureException.args + name: args diff --git a/previous/docs-ref-autogen/azure-common/azure.common.AzureHttpError.yml b/previous/docs-ref-autogen/azure-common/azure.common.AzureHttpError.yml new file mode 100644 index 00000000..932dce91 --- /dev/null +++ b/previous/docs-ref-autogen/azure-common/azure.common.AzureHttpError.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.common.AzureHttpError +name: AzureHttpError +fullName: azure.common.AzureHttpError +module: azure.common +constructor: + syntax: AzureHttpError(message, status_code, *args, **kwargs) + parameters: + - name: message + isRequired: true + - name: status_code + isRequired: true +methods: +- uid: azure.common.AzureHttpError.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.common.AzureHttpError.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.common.AzureHttpError.args + name: args diff --git a/previous/docs-ref-autogen/azure-common/azure.common.AzureMissingResourceHttpError.yml b/previous/docs-ref-autogen/azure-common/azure.common.AzureMissingResourceHttpError.yml new file mode 100644 index 00000000..3f759ea5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-common/azure.common.AzureMissingResourceHttpError.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.common.AzureMissingResourceHttpError +name: AzureMissingResourceHttpError +fullName: azure.common.AzureMissingResourceHttpError +module: azure.common +constructor: + syntax: AzureMissingResourceHttpError(message, status_code, *args, **kwargs) + parameters: + - name: message + isRequired: true + - name: status_code + isRequired: true +methods: +- uid: azure.common.AzureMissingResourceHttpError.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.common.AzureMissingResourceHttpError.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.common.AzureMissingResourceHttpError.args + name: args diff --git a/previous/docs-ref-autogen/azure-common/azure.common.client_factory.yml b/previous/docs-ref-autogen/azure-common/azure.common.client_factory.yml new file mode 100644 index 00000000..e3eca4d8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-common/azure.common.client_factory.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonModule +uid: azure.common.client_factory +name: client_factory +fullName: azure.common.client_factory +functions: +- uid: azure.common.client_factory.get_client_from_auth_file + name: get_client_from_auth_file + summary: "Return a SDK client initialized with auth file.\n\n*Disclaimer*: This\ + \ is NOT the recommended approach, see [https://aka.ms/azsdk/python/identity/migration](https://aka.ms/azsdk/python/identity/migration)\ + \ for guidance.\n\nYou can specific the file path directly, or fill the environment\ + \ variable AZURE_AUTH_LOCATION.\nFile must be UTF-8.\n\nThis method will fill\ + \ automatically the following client parameters:\n- credentials\n- subscription_id\n\ + - base_url\n\nParameters provided in kwargs will override parameters and be passed\ + \ directly to the client.\n\n\n\n````python\n\n from azure.common.client_factory import get_client_from_auth_file\n\ + \ from azure.mgmt.compute import ComputeManagementClient\n client = get_client_from_auth_file(ComputeManagementClient)\n\ + \ ````\n\nExample of file:\n\n\n\n````json\n\n {\n \"clientId\": \"ad735158-65ca-11e7-ba4d-ecb1d756380e\"\ + ,\n \"clientSecret\": \"b70bb224-65ca-11e7-810c-ecb1d756380e\",\n \ + \ \"subscriptionId\": \"bfc42d3a-65ca-11e7-95cf-ecb1d756380e\",\n \"tenantId\"\ + : \"c81da1d8-65ca-11e7-b1d1-ecb1d756380e\",\n \"activeDirectoryEndpointUrl\"\ + : \"https://login.microsoftonline.com\",\n \"resourceManagerEndpointUrl\"\ + : \"https://management.azure.com/\",\n \"activeDirectoryGraphResourceId\"\ + : \"https://graph.windows.net/\",\n \"sqlManagementEndpointUrl\": \"https://management.core.windows.net:8443/\"\ + ,\n \"galleryEndpointUrl\": \"https://gallery.azure.com/\",\n \"managementEndpointUrl\"\ + : \"https://management.core.windows.net/\"\n }\n ````\n\n*New in version 1.1.7.*\ + \ \n\n*Deprecated since version 1.1.28.*" + signature: get_client_from_auth_file(client_class, auth_path=None, **kwargs) + parameters: + - name: client_class + description: A SDK client class + isRequired: true + - name: auth_path + description: Path to the file. + defaultValue: None + types: + - + return: + description: An instantiated client + exceptions: + - type: KeyError if AZURE_AUTH_LOCATION is not an environment variable and no path + is provided + - type: FileNotFoundError if provided file path does not exists + - type: json.JSONDecodeError if provided file is not JSON valid + - type: UnicodeDecodeError if file is not UTF8 compliant + seeAlsoContent: ' [https://aka.ms/azsdk/python/identity/migration](https://aka.ms/azsdk/python/identity/migration) + + ' +- uid: azure.common.client_factory.get_client_from_cli_profile + name: get_client_from_cli_profile + summary: "Return a SDK client initialized with current CLI credentials, CLI default\ + \ subscription and CLI default cloud.\n\n*Disclaimer*: This is NOT the recommended\ + \ approach to authenticate with CLI login, this method is deprecated.\nuse [https://pypi.org/project/azure-identity/](https://pypi.org/project/azure-identity/)\ + \ and AzureCliCredential instead. See example code below:\n\n\n\n````python\n\n from azure.identity\ + \ import AzureCliCredential\n from azure.mgmt.compute import ComputeManagementClient\n\ + \ client = ComputeManagementClient(AzureCliCredential(), subscription_id)\n\ + \ ````\n\nThis method is not working for azure-cli-core>=2.21.0 (released in\ + \ March 2021).\n\nFor compatible azure-cli-core (< 2.20.0), This method will automatically\ + \ fill the following client parameters:\n- credentials/credential\n- subscription_id\n\ + - base_url\n\nParameters provided in kwargs will override CLI parameters and be\ + \ passed directly to the client.\n\n\n\n````python\n\n from azure.common.client_factory import\ + \ get_client_from_cli_profile\n from azure.mgmt.compute import ComputeManagementClient\n\ + \ client = get_client_from_cli_profile(ComputeManagementClient)\n ````\n\n\ + *New in version 1.1.6.* \n\n*Deprecated since version 1.1.28.*" + signature: get_client_from_cli_profile(client_class, **kwargs) + parameters: + - name: client_class + description: A SDK client class + isRequired: true + return: + description: An instantiated client + exceptions: + - type: ImportError if azure-cli-core package is not available + seeAlsoContent: ' [https://aka.ms/azsdk/python/identity/migration](https://aka.ms/azsdk/python/identity/migration) + + ' +- uid: azure.common.client_factory.get_client_from_json_dict + name: get_client_from_json_dict + summary: "Return a SDK client initialized with a JSON auth dict.\n\n*Disclaimer*:\ + \ This is NOT the recommended approach, see [https://aka.ms/azsdk/python/identity/migration](https://aka.ms/azsdk/python/identity/migration)\ + \ for guidance.\n\nThis method will fill automatically the following client parameters:\n\ + - credentials\n- subscription_id\n- base_url\n- tenant_id\n\nParameters provided\ + \ in kwargs will override parameters and be passed directly to the client.\n\n\ + \n\n````python\n\ + \n from azure.common.client_factory import get_client_from_auth_file\n from\ + \ azure.mgmt.compute import ComputeManagementClient\n config_dict = {\n \ + \ \"clientId\": \"ad735158-65ca-11e7-ba4d-ecb1d756380e\",\n \"clientSecret\"\ + : \"b70bb224-65ca-11e7-810c-ecb1d756380e\",\n \"subscriptionId\": \"bfc42d3a-65ca-11e7-95cf-ecb1d756380e\"\ + ,\n \"tenantId\": \"c81da1d8-65ca-11e7-b1d1-ecb1d756380e\",\n \"activeDirectoryEndpointUrl\"\ + : \"https://login.microsoftonline.com\",\n \"resourceManagerEndpointUrl\"\ + : \"https://management.azure.com/\",\n \"activeDirectoryGraphResourceId\"\ + : \"https://graph.windows.net/\",\n \"sqlManagementEndpointUrl\": \"https://management.core.windows.net:8443/\"\ + ,\n \"galleryEndpointUrl\": \"https://gallery.azure.com/\",\n \"managementEndpointUrl\"\ + : \"https://management.core.windows.net/\"\n }\n client = get_client_from_json_dict(ComputeManagementClient,\ + \ config_dict)\n ````\n\n*New in version 1.1.7.* \n\n*Deprecated since version\ + \ 1.1.28.*" + signature: get_client_from_json_dict(client_class, config_dict, **kwargs) + parameters: + - name: client_class + description: A SDK client class + isRequired: true + - name: config_dict + description: A config dict. + isRequired: true + types: + - + return: + description: An instantiated client + seeAlsoContent: ' [https://aka.ms/azsdk/python/identity/migration](https://aka.ms/azsdk/python/identity/migration) + + ' diff --git a/previous/docs-ref-autogen/azure-common/azure.common.cloud.yml b/previous/docs-ref-autogen/azure-common/azure.common.cloud.yml new file mode 100644 index 00000000..e98b6977 --- /dev/null +++ b/previous/docs-ref-autogen/azure-common/azure.common.cloud.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonModule +uid: azure.common.cloud +name: cloud +fullName: azure.common.cloud +functions: +- uid: azure.common.cloud.get_cli_active_cloud + name: get_cli_active_cloud + summary: "Return a CLI active cloud.\n\n*Disclaimer*: This method is not working\ + \ for azure-cli-core>=2.21.0 (released in March 2021).\n\n*New in version 1.1.6.*\ + \ \n\n*Deprecated since version 1.1.28.*" + signature: get_cli_active_cloud() + return: + description: A CLI Cloud + types: + - + exceptions: + - type: ImportError if azure-cli-core package is not available diff --git a/previous/docs-ref-autogen/azure-common/azure.common.credentials.yml b/previous/docs-ref-autogen/azure-common/azure.common.credentials.yml new file mode 100644 index 00000000..b2d4a8d8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-common/azure.common.credentials.yml @@ -0,0 +1,52 @@ +### YamlMime:PythonModule +uid: azure.common.credentials +name: credentials +fullName: azure.common.credentials +functions: +- uid: azure.common.credentials.get_azure_cli_credentials + name: get_azure_cli_credentials + summary: "Return Credentials and default SubscriptionID of current loaded profile\ + \ of the CLI.\n\n*Disclaimer*: This method is not working for azure-cli-core>=2.21.0\ + \ (released in March 2021).\nIt is now recommended to authenticate using [https://pypi.org/project/azure-identity/](https://pypi.org/project/azure-identity/)\ + \ and AzureCliCredential.\nSee example code below:\n\n\n\n````python\n\n from azure.identity import\ + \ AzureCliCredential\n from azure.mgmt.compute import ComputeManagementClient\n\ + \ client = ComputeManagementClient(AzureCliCredential(), subscription_id)\n\ + \ ````\n\nFor compatible azure-cli-core version (< 2.20.0), credentials will\ + \ be the \"az login\" command:\n[https://docs.microsoft.com/cli/azure/authenticate-azure-cli](https://docs.microsoft.com/cli/azure/authenticate-azure-cli)\n\ + \nDefault subscription ID is either the only one you have, or you can define it:\n\ + [https://docs.microsoft.com/cli/azure/manage-azure-subscriptions-azure-cli](https://docs.microsoft.com/cli/azure/manage-azure-subscriptions-azure-cli)\n\ + \n*New in version 1.1.6.* \n\n*Deprecated since version 1.1.28.*" + signature: get_azure_cli_credentials(resource=None, with_tenant=False) + parameters: + - name: resource + description: The alternative resource for credentials if not ARM (GraphRBac, etc.) + defaultValue: None + types: + - + - name: with_tenant + description: If True, return a three-tuple with last as tenant ID + defaultValue: 'False' + types: + - + return: + description: tuple of Credentials and SubscriptionID (and tenant ID if with_tenant) + types: + - + seeAlsoContent: ' [https://aka.ms/azsdk/python/identity/migration](https://aka.ms/azsdk/python/identity/migration) + + ' +- uid: azure.common.credentials.get_cli_profile + name: get_cli_profile + summary: "Return a CLI profile class.\n\n*Disclaimer*: This method is not working\ + \ for azure-cli-core>=2.21.0 (released in March 2021).\n\n*New in version 1.1.6.*\ + \ \n\n*Deprecated since version 1.1.28.*" + signature: get_cli_profile() + return: + description: A CLI Profile + types: + - + exceptions: + - type: ImportError if azure-cli-core package is not available diff --git a/previous/docs-ref-autogen/azure-common/azure.common.exceptions.yml b/previous/docs-ref-autogen/azure-common/azure.common.exceptions.yml new file mode 100644 index 00000000..919416eb --- /dev/null +++ b/previous/docs-ref-autogen/azure-common/azure.common.exceptions.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.common.exceptions +name: exceptions +fullName: azure.common.exceptions diff --git a/previous/docs-ref-autogen/azure-common/azure.common.yml b/previous/docs-ref-autogen/azure-common/azure.common.yml new file mode 100644 index 00000000..080c02da --- /dev/null +++ b/previous/docs-ref-autogen/azure-common/azure.common.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonPackage +uid: azure.common +name: common +fullName: azure.common +type: rootImport +classes: +- azure.common.AzureConflictHttpError +- azure.common.AzureException +- azure.common.AzureHttpError +- azure.common.AzureMissingResourceHttpError +modules: +- azure.common.client_factory +- azure.common.cloud +- azure.common.credentials +- azure.common.exceptions diff --git a/previous/docs-ref-autogen/azure-common/azure.profiles.DefaultProfile.yml b/previous/docs-ref-autogen/azure-common/azure.profiles.DefaultProfile.yml new file mode 100644 index 00000000..8964382b --- /dev/null +++ b/previous/docs-ref-autogen/azure-common/azure.profiles.DefaultProfile.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.profiles.DefaultProfile +name: DefaultProfile +fullName: azure.profiles.DefaultProfile +module: azure.profiles +summary: Store a default profile. +constructor: + syntax: DefaultProfile() +variables: +- description: The default profile as class attribute + name: profile + types: + - +methods: +- uid: azure.profiles.DefaultProfile.definition + name: definition + signature: definition() +- uid: azure.profiles.DefaultProfile.use + name: use + summary: Define a new default profile. + signature: use(profile) + parameters: + - name: profile + isRequired: true +attributes: +- uid: azure.profiles.DefaultProfile.profile + name: profile + signature: profile = latest diff --git a/previous/docs-ref-autogen/azure-common/azure.profiles.KnownProfiles.yml b/previous/docs-ref-autogen/azure-common/azure.profiles.KnownProfiles.yml new file mode 100644 index 00000000..a8665049 --- /dev/null +++ b/previous/docs-ref-autogen/azure-common/azure.profiles.KnownProfiles.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonEnum +uid: azure.profiles.KnownProfiles +name: KnownProfiles +fullName: azure.profiles.KnownProfiles +summary: "This defines known Azure Profiles.\n\nThere is two meta-profiles:\n\n* latest\ + \ : will always use latest available api-version on each package \n\n* default :\ + \ mutable, will define profile automatically for all packages \n\nIf you change\ + \ default, this changes all created packages on the fly to\nthis profile. This can\ + \ be used to switch a complete set of API Version\nwithout re-creating all clients." +module: azure.profiles +fields: +- name: default + uid: azure.profiles.KnownProfiles.default +- name: latest + uid: azure.profiles.KnownProfiles.latest +- name: v2017_03_09_profile + uid: azure.profiles.KnownProfiles.v2017_03_09_profile +- name: v2018_03_01_hybrid + uid: azure.profiles.KnownProfiles.v2018_03_01_hybrid +- name: v2019_03_01_hybrid + uid: azure.profiles.KnownProfiles.v2019_03_01_hybrid +- name: v2020_09_01_hybrid + uid: azure.profiles.KnownProfiles.v2020_09_01_hybrid diff --git a/previous/docs-ref-autogen/azure-common/azure.profiles.ProfileDefinition.yml b/previous/docs-ref-autogen/azure-common/azure.profiles.ProfileDefinition.yml new file mode 100644 index 00000000..eaa64014 --- /dev/null +++ b/previous/docs-ref-autogen/azure-common/azure.profiles.ProfileDefinition.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.profiles.ProfileDefinition +name: ProfileDefinition +fullName: azure.profiles.ProfileDefinition +module: azure.profiles +summary: 'Allow to define a custom Profile definition. + + + Note: + + + The dict format taken as input is yet to be confirmed and should + + *not* be considered as stable in the current implementation.' +constructor: + syntax: ProfileDefinition(profile_dict, label=None) + parameters: + - name: profile_dict + description: A profile dictionnary + isRequired: true + types: + - + - name: label + description: A label for pretty printing + defaultValue: None + types: + - +methods: +- uid: azure.profiles.ProfileDefinition.get_profile_dict + name: get_profile_dict + summary: 'Return the current profile dict. + + + This is internal information, and content should not be considered stable.' + signature: get_profile_dict() +attributes: +- uid: azure.profiles.ProfileDefinition.label + name: label + summary: The label associated to this profile definition. diff --git a/previous/docs-ref-autogen/azure-common/azure.profiles.multiapiclient.InvalidMultiApiClientError.yml b/previous/docs-ref-autogen/azure-common/azure.profiles.multiapiclient.InvalidMultiApiClientError.yml new file mode 100644 index 00000000..abb93d2c --- /dev/null +++ b/previous/docs-ref-autogen/azure-common/azure.profiles.multiapiclient.InvalidMultiApiClientError.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.profiles.multiapiclient.InvalidMultiApiClientError +name: InvalidMultiApiClientError +fullName: azure.profiles.multiapiclient.InvalidMultiApiClientError +module: azure.profiles.multiapiclient +summary: If the mixin is not used with a compatible class. +constructor: + syntax: InvalidMultiApiClientError() +methods: +- uid: azure.profiles.multiapiclient.InvalidMultiApiClientError.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.profiles.multiapiclient.InvalidMultiApiClientError.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.profiles.multiapiclient.InvalidMultiApiClientError.args + name: args diff --git a/previous/docs-ref-autogen/azure-common/azure.profiles.multiapiclient.MultiApiClientMixin.yml b/previous/docs-ref-autogen/azure-common/azure.profiles.multiapiclient.MultiApiClientMixin.yml new file mode 100644 index 00000000..54a418d0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-common/azure.profiles.multiapiclient.MultiApiClientMixin.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.profiles.multiapiclient.MultiApiClientMixin +name: MultiApiClientMixin +fullName: azure.profiles.multiapiclient.MultiApiClientMixin +module: azure.profiles.multiapiclient +summary: 'Mixin that contains multi-api version profile management. + + + To use this mixin, a client must define two class attributes: + + - LATEST_PROFILE : a ProfileDefinition correspond to latest profile + + - _PROFILE_TAG : a tag that filter a full profile for this particular client + + + This should not be used directly and will only provide private methods.' +constructor: + syntax: MultiApiClientMixin(*args, **kwargs) diff --git a/previous/docs-ref-autogen/azure-common/azure.profiles.multiapiclient.yml b/previous/docs-ref-autogen/azure-common/azure.profiles.multiapiclient.yml new file mode 100644 index 00000000..c19a507d --- /dev/null +++ b/previous/docs-ref-autogen/azure-common/azure.profiles.multiapiclient.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.profiles.multiapiclient +name: multiapiclient +fullName: azure.profiles.multiapiclient +classes: +- azure.profiles.multiapiclient.InvalidMultiApiClientError +- azure.profiles.multiapiclient.MultiApiClientMixin diff --git a/previous/docs-ref-autogen/azure-common/azure.profiles.yml b/previous/docs-ref-autogen/azure-common/azure.profiles.yml new file mode 100644 index 00000000..edc20772 --- /dev/null +++ b/previous/docs-ref-autogen/azure-common/azure.profiles.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonPackage +uid: azure.profiles +name: profiles +fullName: azure.profiles +type: rootImport +classes: +- azure.profiles.DefaultProfile +- azure.profiles.ProfileDefinition +modules: +- azure.profiles.multiapiclient +enums: +- azure.profiles.KnownProfiles diff --git a/previous/docs-ref-autogen/azure-communication-networktraversal/azure.communication.networktraversal.aio.CommunicationRelayClient.yml b/previous/docs-ref-autogen/azure-communication-networktraversal/azure.communication.networktraversal.aio.CommunicationRelayClient.yml new file mode 100644 index 00000000..69f6d600 --- /dev/null +++ b/previous/docs-ref-autogen/azure-communication-networktraversal/azure.communication.networktraversal.aio.CommunicationRelayClient.yml @@ -0,0 +1,106 @@ +### YamlMime:PythonClass +uid: azure.communication.networktraversal.aio.CommunicationRelayClient +name: CommunicationRelayClient +fullName: azure.communication.networktraversal.aio.CommunicationRelayClient +module: azure.communication.networktraversal.aio +summary: Azure Communication Services Network Traversal client. +constructor: + syntax: 'CommunicationRelayClient(endpoint: str, credential: AsyncTokenCredential + | AzureKeyCredential, **kwargs)' + parameters: + - name: endpoint + description: The endpoint url for Azure Communication Service resource. + isRequired: true + types: + - + - name: credential + description: The credential we use to authenticate against the service. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: api_version + description: 'Azure Communication Network Traversal API version. + + Default value is "2022-03-01-preview". + + Note that overriding this default value may result in unsupported behavior.' + types: + - +examples: +- "\n\n\n\n````python\n\n : utf-8\n\n -------------------------------------------------------------------\n\ + \ ght (c) Microsoft Corporation. All rights reserved.\n ed under the MIT License.\ + \ See License.txt in the project root for\n e information.\n --------------------------------------------------------------------\n\ + \n\n twork_traversal_samples_async.py\n ION:\n e samples demonstrate creating\ + \ a user, issuing a token, revoking a token and deleting a user.\n\n\n on network_traversal_samples.py\n\ + \ the environment variables with your own values before running the sample:\n\ + \ OMMUNICATION_SAMPLES_CONNECTION_STRING - the connection string in your ACS resource\n\ + \ ZURE_CLIENT_ID - the client ID of your active directory application\n ZURE_CLIENT_SECRET\ + \ - the secret of your active directory application\n ZURE_TENANT_ID - the tenant\ + \ ID of your active directory application\n\n s\n syncio\n re.communication.networktraversal._shared.utils\ + \ import parse_connection_str\n\n mmunicationRelayClientSamples(object):\n\n \ + \ __init__(self):\n self.connection_string = os.getenv('COMMUNICATION_SAMPLES_CONNECTION_STRING')\n\ + \ self.client_id = os.getenv('AZURE_CLIENT_ID')\n self.client_secret = os.getenv('AZURE_CLIENT_SECRET')\n\ + \ self.tenant_id = os.getenv('AZURE_TENANT_ID')\n\n c def get_relay_config(self):\n\ + \ from azure.communication.networktraversal.aio import CommunicationRelayClient\n\ + \ from azure.communication.identity.aio import CommunicationIdentityClient\n\n\ + \ if self.client_id is not None and self.client_secret is not None and self.tenant_id\ + \ is not None:\n from azure.identity.aio import DefaultAzureCredential\n \ + \ endpoint, _ = parse_connection_str(self.connection_string)\n identity_client\ + \ = CommunicationIdentityClient(endpoint, DefaultAzureCredential())\n relay_client\ + \ = CommunicationRelayClient(endpoint, DefaultAzureCredential())\n else:\n \ + \ identity_client = CommunicationIdentityClient.from_connection_string(self.connection_string)\n\ + \ relay_client = CommunicationRelayClient.from_connection_string(self.connection_string)\n\ + \n async with identity_client:\n print(\"Creating new user\")\n user\ + \ = await identity_client.create_user()\n print(\"User created with id:\"\ + \ + user.properties.get('id'))\n\n async with relay_client:\n print(\"Getting\ + \ relay configuration\")\n relay_configuration = await relay_client.get_relay_configuration(user=user)\n\ + \n for iceServer in relay_configuration.ice_servers:\n print(\"Icer server:\"\ + )\n print(iceServer)\n\n f main():\n le = CommunicationRelayClientSamples()\n\ + \ t sample.get_relay_config()\n\n e__ == '__main__':\n cio.run(main())\n\n\ + \ ````\n" +methods: +- uid: azure.communication.networktraversal.aio.CommunicationRelayClient.close + name: close + summary: 'Close the :class: + + *~azure.communication.networktraversal.aio.CommunicationRelayClient* session.' + signature: async close() -> None +- uid: azure.communication.networktraversal.aio.CommunicationRelayClient.from_connection_string + name: from_connection_string + summary: Create CommunicationRelayClient from a Connection String. + signature: 'from_connection_string(conn_str: str, **kwargs) -> CommunicationRelayClient' + parameters: + - name: conn_str + description: A connection string to an Azure Communication Service resource. + isRequired: true + types: + - + return: + description: Instance of CommunicationRelayClient. + types: + - +- uid: azure.communication.networktraversal.aio.CommunicationRelayClient.get_relay_configuration + name: get_relay_configuration + summary: 'get a Communication Relay configuration. + + :keyword user: Azure Communication User + + :paramtype user: ~azure.communication.identity.CommunicationUserIdentifier + + :keyword route_type: Azure Communication Route Type + + :paramtype route_type: ~azure.communication.networktraversal.RouteType + + :return: CommunicationRelayConfiguration + + :rtype: ~azure.communication.networktraversal.models.CommunicationRelayConfiguration' + signature: 'async get_relay_configuration(*, user: CommunicationUserIdentifier = + None, route_type: str | RouteType | None = None, ttl: int | None = 172800, **kwargs) + -> CommunicationRelayConfiguration' diff --git a/previous/docs-ref-autogen/azure-communication-networktraversal/azure.communication.networktraversal.aio.yml b/previous/docs-ref-autogen/azure-communication-networktraversal/azure.communication.networktraversal.aio.yml new file mode 100644 index 00000000..c5924d90 --- /dev/null +++ b/previous/docs-ref-autogen/azure-communication-networktraversal/azure.communication.networktraversal.aio.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonPackage +uid: azure.communication.networktraversal.aio +name: aio +fullName: azure.communication.networktraversal.aio +type: import +classes: +- azure.communication.networktraversal.aio.CommunicationRelayClient diff --git a/previous/docs-ref-autogen/azure-communication-networktraversal/azure.communication.networktraversal.yml b/previous/docs-ref-autogen/azure-communication-networktraversal/azure.communication.networktraversal.yml new file mode 100644 index 00000000..489d62f1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-communication-networktraversal/azure.communication.networktraversal.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonPackage +uid: azure.communication.networktraversal +name: networktraversal +fullName: azure.communication.networktraversal +type: rootImport +packages: +- azure.communication.networktraversal.aio diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.auth.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.auth.yml new file mode 100644 index 00000000..a436a2dd --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.auth.yml @@ -0,0 +1,42 @@ +### YamlMime:PythonModule +uid: azure.cosmos.auth +name: auth +fullName: azure.cosmos.auth +summary: Authorization helper functions in the Azure Cosmos database service. +functions: +- uid: azure.cosmos.auth.GetAuthorizationHeader + name: GetAuthorizationHeader + summary: Gets the authorization header. + signature: GetAuthorizationHeader(cosmos_client, verb, path, resource_id_or_fullname, + is_name_based, resource_type, headers) + parameters: + - name: cosmos_client + isRequired: true + types: + - + - name: verb + isRequired: true + types: + - + - name: path + isRequired: true + types: + - + - name: resource_id_or_fullname + isRequired: true + types: + - + - name: resource_type + isRequired: true + types: + - + - name: headers + isRequired: true + types: + - + - name: is_name_based + isRequired: true + return: + description: The authorization headers. + types: + - diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.base.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.base.yml new file mode 100644 index 00000000..f4eb6227 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.base.yml @@ -0,0 +1,255 @@ +### YamlMime:PythonModule +uid: azure.cosmos.base +name: base +fullName: azure.cosmos.base +summary: Base functions in the Azure Cosmos database service. +functions: +- uid: azure.cosmos.base.GenerateGuidId + name: GenerateGuidId + summary: 'Gets a random GUID. + + + Note that here we use python''s UUID generation library. Basically UUID + + is the same as GUID when represented as a string.' + signature: GenerateGuidId() + return: + description: The generated random GUID. + types: + - +- uid: azure.cosmos.base.GetAttachmentIdFromMediaId + name: GetAttachmentIdFromMediaId + summary: Gets attachment id from media id. + signature: GetAttachmentIdFromMediaId(media_id) + parameters: + - name: media_id + isRequired: true + types: + - + return: + description: The attachment id from the media id. + types: + - +- uid: azure.cosmos.base.GetHeaders + name: GetHeaders + summary: Gets HTTP request headers. + signature: GetHeaders(cosmos_client, default_headers, verb, path, resource_id, resource_type, + options, partition_key_range_id=None) + parameters: + - name: cosmos_client + isRequired: true + types: + - + - name: default_headers + isRequired: true + types: + - + - name: verb + isRequired: true + types: + - + - name: path + isRequired: true + types: + - + - name: resource_id + isRequired: true + types: + - + - name: resource_type + isRequired: true + types: + - + - name: options + isRequired: true + types: + - + - name: partition_key_range_id + defaultValue: None + types: + - + return: + description: The HTTP request headers. + types: + - +- uid: azure.cosmos.base.GetItemContainerInfo + name: GetItemContainerInfo + summary: "Given the self link and alt_content_path from the reponse header and result\n\ + \ extract the collection name and collection id\n\n Ever response header has\ + \ alt-content-path that is the\n owner's path in ascii. For document create\ + \ / update requests, this can be used\n to get the collection name, but for\ + \ collection create response, we can't use it.\n So we also rely on" + signature: GetItemContainerInfo(self_link, alt_content_path, id_from_response) + parameters: + - name: self_link + description: Self link of the resource, as obtained from response result. + isRequired: true + types: + - + - name: alt_content_path + description: Owner path of the resource, as obtained from response header. + isRequired: true + types: + - + - name: resource_id + description: "'id' as returned from the response result. This is only used if\ + \ it is deduced that the\n request was to create a collection." + isRequired: true + types: + - + - name: id_from_response + isRequired: true + return: + description: tuple of (collection rid, collection name) + types: + - +- uid: azure.cosmos.base.GetItemContainerLink + name: GetItemContainerLink + summary: Gets the document collection link + signature: GetItemContainerLink(link) + parameters: + - name: link + description: Resource link + isRequired: true + types: + - + return: + description: Document collection link. + types: + - +- uid: azure.cosmos.base.GetPathFromLink + name: GetPathFromLink + summary: Gets path from resource link with optional resource type + signature: GetPathFromLink(resource_link, resource_type='') + parameters: + - name: resource_link + isRequired: true + types: + - + - name: resource_type + isRequired: true + types: + - + return: + description: Path from resource link with resource type appended (if provided). + types: + - +- uid: azure.cosmos.base.GetResourceIdOrFullNameFromLink + name: GetResourceIdOrFullNameFromLink + summary: Gets resource id or full name from resource link. + signature: GetResourceIdOrFullNameFromLink(resource_link) + parameters: + - name: resource_link + isRequired: true + types: + - + return: + description: The resource id or full name from the resource link. + types: + - +- uid: azure.cosmos.base.IndexOfNth + name: IndexOfNth + summary: Gets the index of Nth occurance of a given character in a string + signature: IndexOfNth(s, value, n) + parameters: + - name: s + description: Input string + isRequired: true + types: + - + - name: value + description: Input char to be searched. + isRequired: true + types: + - + - name: n + description: Nth occurrence of char to be searched. + isRequired: true + types: + - + return: + description: Index of the Nth occurrence in the string. + types: + - +- uid: azure.cosmos.base.IsDatabaseLink + name: IsDatabaseLink + summary: Finds whether the link is a database Self Link or a database ID based link + signature: IsDatabaseLink(link) + parameters: + - name: link + description: Link to analyze + isRequired: true + types: + - + return: + description: True or False. + types: + - +- uid: azure.cosmos.base.IsItemContainerLink + name: IsItemContainerLink + summary: Finds whether the link is a document colllection Self Link or a document + colllection ID based link + signature: IsItemContainerLink(link) + parameters: + - name: link + description: Link to analyze + isRequired: true + types: + - + return: + description: True or False. + types: + - +- uid: azure.cosmos.base.IsMasterResource + name: IsMasterResource + signature: IsMasterResource(resourceType) + parameters: + - name: resourceType + isRequired: true +- uid: azure.cosmos.base.IsNameBased + name: IsNameBased + summary: Finds whether the link is name based or not + signature: IsNameBased(link) + parameters: + - name: link + isRequired: true + types: + - + return: + description: True if link is name-based; otherwise, False. + types: + - +- uid: azure.cosmos.base.IsValidBase64String + name: IsValidBase64String + summary: Verifies if a string is a valid Base64 encoded string, after replacing + '-' with '/' + signature: IsValidBase64String(string_to_validate) + parameters: + - name: string_to_validate + description: String to validate. + isRequired: true + types: + - + return: + description: Whether given string is a valid base64 string or not. + types: + - +- uid: azure.cosmos.base.ParsePaths + name: ParsePaths + signature: ParsePaths(paths) + parameters: + - name: paths + isRequired: true +- uid: azure.cosmos.base.TrimBeginningAndEndingSlashes + name: TrimBeginningAndEndingSlashes + summary: Trims beginning and ending slashes + signature: TrimBeginningAndEndingSlashes(path) + parameters: + - name: path + isRequired: true + types: + - + return: + description: Path with beginning and ending slashes trimmed. + types: + - diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.consistent_hash_ring.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.consistent_hash_ring.yml new file mode 100644 index 00000000..1423f34a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.consistent_hash_ring.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cosmos.consistent_hash_ring +name: consistent_hash_ring +fullName: azure.cosmos.consistent_hash_ring +summary: Internal class for consistent hash ring implementation in the Azure Cosmos + database service. diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.constants.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.constants.yml new file mode 100644 index 00000000..a8162243 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.constants.yml @@ -0,0 +1,5 @@ +### YamlMime:PythonModule +uid: azure.cosmos.constants +name: constants +fullName: azure.cosmos.constants +summary: Class for defining internal constants in the Azure Cosmos database service. diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.cosmos_client.CosmosClient.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.cosmos_client.CosmosClient.yml new file mode 100644 index 00000000..9535e64e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.cosmos_client.CosmosClient.yml @@ -0,0 +1,1866 @@ +### YamlMime:PythonClass +uid: azure.cosmos.cosmos_client.CosmosClient +name: CosmosClient +fullName: azure.cosmos.cosmos_client.CosmosClient +module: azure.cosmos.cosmos_client +summary: "Represents a document client.\n\nProvides a client-side logical representation\ + \ of the Azure Cosmos\nservice. This client is used to configure and execute requests\ + \ against the\nservice.\n\nThe service client encapsulates the endpoint and credentials\ + \ used to access\nthe Azure Cosmos service.\n\nif url_connection and auth are not\ + \ provided,\n COSMOS_ENDPOINT and COSMOS_KEY environment variables will be used." +constructor: + syntax: CosmosClient(url_connection, auth, connection_policy=None, consistency_level='Session') + parameters: + - name: url_connection + description: The URL for connecting to the DB server. + isRequired: true + types: + - + - name: auth + description: 'Contains ''masterKey'' or ''resourceTokens'', where + + auth[''masterKey''] is the default authorization key to use to + + create the client, and auth[''resourceTokens''] is the alternative + + authorization key.' + isRequired: true + types: + - + - name: connection_policy + description: The connection policy for the client. + defaultValue: None + types: + - + - name: consistency_level + description: The default consistency policy for client operations. + defaultValue: Session + types: + - +methods: +- uid: azure.cosmos.cosmos_client.CosmosClient.Create + name: Create + summary: Creates a Azure Cosmos resource and returns it. + signature: Create(body, path, type, id, initial_headers, options=None) + parameters: + - name: body + isRequired: true + types: + - + - name: path + isRequired: true + types: + - + - name: type + isRequired: true + types: + - + - name: id + isRequired: true + types: + - + - name: initial_headers + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The created Azure Cosmos resource. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.CreateAttachment + name: CreateAttachment + summary: Creates an attachment in a document. + signature: CreateAttachment(document_link, attachment, options=None) + parameters: + - name: document_link + description: The link to the document. + isRequired: true + types: + - + - name: attachment + description: The Azure Cosmos attachment to create. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The created Attachment. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.CreateAttachmentAndUploadMedia + name: CreateAttachmentAndUploadMedia + summary: Creates an attachment and upload media. + signature: CreateAttachmentAndUploadMedia(document_link, readable_stream, options=None) + parameters: + - name: document_link + description: The link to the document. + isRequired: true + types: + - + - name: readable_stream + isRequired: true + types: + - )> + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The created Attachment. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.CreateContainer + name: CreateContainer + summary: Creates a collection in a database. + signature: CreateContainer(database_link, collection, options=None) + parameters: + - name: database_link + description: The link to the database. + isRequired: true + types: + - + - name: collection + description: The Azure Cosmos collection to create. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The Collection that was created. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.CreateDatabase + name: CreateDatabase + summary: Creates a database. + signature: CreateDatabase(database, options=None) + parameters: + - name: database + description: The Azure Cosmos database to create. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The Database that was created. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.CreateItem + name: CreateItem + summary: Creates a document in a collection. + signature: CreateItem(database_or_Container_link, document, options=None) + parameters: + - name: database_or_Container_link + description: The link to the database when using partitioning, otherwise link + to the document collection. + isRequired: true + types: + - + - name: document + description: The Azure Cosmos document to create. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + - name: options['disableAutomaticIdGeneration'] + description: 'Disables the automatic id generation. If id is missing in the body + and this + + option is true, an error will be returned.' + isRequired: true + types: + - '''disableAutomaticIdGeneration''] (' + return: + description: The created Document. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.CreatePermission + name: CreatePermission + summary: Creates a permission for a user. + signature: CreatePermission(user_link, permission, options=None) + parameters: + - name: user_link + description: The link to the user entity. + isRequired: true + types: + - + - name: permission + description: The Azure Cosmos user permission to create. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The created Permission. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.CreateStoredProcedure + name: CreateStoredProcedure + summary: Creates a stored procedure in a collection. + signature: CreateStoredProcedure(collection_link, sproc, options=None) + parameters: + - name: collection_link + description: The link to the document collection. + isRequired: true + types: + - + - name: sproc + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The created Stored Procedure. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.CreateTrigger + name: CreateTrigger + summary: Creates a trigger in a collection. + signature: CreateTrigger(collection_link, trigger, options=None) + parameters: + - name: collection_link + description: The link to the document collection. + isRequired: true + types: + - + - name: trigger + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The created Trigger. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.CreateUser + name: CreateUser + summary: Creates a user. + signature: CreateUser(database_link, user, options=None) + parameters: + - name: database_link + description: The link to the database. + isRequired: true + types: + - + - name: user + description: The Azure Cosmos user to create. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The created User. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.CreateUserDefinedFunction + name: CreateUserDefinedFunction + summary: Creates a user defined function in a collection. + signature: CreateUserDefinedFunction(collection_link, udf, options=None) + parameters: + - name: collection_link + description: The link to the collection. + isRequired: true + types: + - + - name: udf + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The created UDF. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.DeleteAttachment + name: DeleteAttachment + summary: Deletes an attachment. + signature: DeleteAttachment(attachment_link, options=None) + parameters: + - name: attachment_link + description: The link to the attachment. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The deleted Attachment. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.DeleteConflict + name: DeleteConflict + summary: Deletes a conflict. + signature: DeleteConflict(conflict_link, options=None) + parameters: + - name: conflict_link + description: The link to the conflict. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The deleted Conflict. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.DeleteContainer + name: DeleteContainer + summary: Deletes a collection. + signature: DeleteContainer(collection_link, options=None) + parameters: + - name: collection_link + description: The link to the document collection. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The deleted Collection. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.DeleteDatabase + name: DeleteDatabase + summary: Deletes a database. + signature: DeleteDatabase(database_link, options=None) + parameters: + - name: database_link + description: The link to the database. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The deleted Database. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.DeleteItem + name: DeleteItem + summary: Deletes a document. + signature: DeleteItem(document_link, options=None) + parameters: + - name: document_link + description: The link to the document. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The deleted Document. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.DeletePermission + name: DeletePermission + summary: Deletes a permission. + signature: DeletePermission(permission_link, options=None) + parameters: + - name: permission_link + description: The link to the permission. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The deleted Permission. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.DeleteResource + name: DeleteResource + summary: Deletes a Azure Cosmos resource and returns it. + signature: DeleteResource(path, type, id, initial_headers, options=None) + parameters: + - name: path + isRequired: true + types: + - + - name: type + isRequired: true + types: + - + - name: id + isRequired: true + types: + - + - name: initial_headers + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The deleted Azure Cosmos resource. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.DeleteStoredProcedure + name: DeleteStoredProcedure + summary: Deletes a stored procedure. + signature: DeleteStoredProcedure(sproc_link, options=None) + parameters: + - name: sproc_link + description: The link to the stored procedure. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The deleted Stored Procedure. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.DeleteTrigger + name: DeleteTrigger + summary: Deletes a trigger. + signature: DeleteTrigger(trigger_link, options=None) + parameters: + - name: trigger_link + description: The link to the trigger. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The deleted Trigger. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.DeleteUser + name: DeleteUser + summary: Deletes a user. + signature: DeleteUser(user_link, options=None) + parameters: + - name: user_link + description: The link to the user entity. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The deleted user. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.DeleteUserDefinedFunction + name: DeleteUserDefinedFunction + summary: Deletes a user defined function. + signature: DeleteUserDefinedFunction(udf_link, options=None) + parameters: + - name: udf_link + description: The link to the user defined function. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The deleted UDF. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ExecuteStoredProcedure + name: ExecuteStoredProcedure + summary: Executes a store procedure. + signature: ExecuteStoredProcedure(sproc_link, params, options=None) + parameters: + - name: sproc_link + description: The link to the stored procedure. + isRequired: true + types: + - + - name: params + description: List or None + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The Stored Procedure response. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.GetDatabaseAccount + name: GetDatabaseAccount + summary: Gets database account info. + signature: GetDatabaseAccount(url_connection=None) + parameters: + - name: url_connection + defaultValue: None + return: + description: The Database Account. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.GetPartitionResolver + name: GetPartitionResolver + summary: Gets the partition resolver associated with the database link + signature: GetPartitionResolver(database_link) + parameters: + - name: database_link + description: Database self link or ID based link. + isRequired: true + types: + - + return: + description: An instance of PartitionResolver. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.QueryAttachments + name: QueryAttachments + summary: Queries attachments in a document. + signature: QueryAttachments(document_link, query, options=None) + parameters: + - name: document_link + description: The link to the document. + isRequired: true + types: + - + - name: query + isRequired: true + types: + - ( + - ) + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: Query Iterable of Attachments. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.QueryConflicts + name: QueryConflicts + summary: Queries conflicts in a collection. + signature: QueryConflicts(collection_link, query, options=None) + parameters: + - name: collection_link + description: The link to the document collection. + isRequired: true + types: + - + - name: query + isRequired: true + types: + - ( + - ) + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: Query Iterable of Conflicts. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.QueryContainers + name: QueryContainers + summary: Queries collections in a database. + signature: QueryContainers(database_link, query, options=None) + parameters: + - name: database_link + description: The link to the database. + isRequired: true + types: + - + - name: query + isRequired: true + types: + - ( + - ) + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: Query Iterable of Collections. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.QueryDatabases + name: QueryDatabases + summary: Queries databases. + signature: QueryDatabases(query, options=None) + parameters: + - name: query + isRequired: true + types: + - ( + - ) + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: Query Iterable of Databases. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.QueryFeed + name: QueryFeed + summary: Query Feed for Document Collection resource. + signature: QueryFeed(path, collection_id, query, options, partition_key_range_id=None) + parameters: + - name: path + description: Path to the document collection. + isRequired: true + types: + - + - name: collection_id + description: Id of the document collection. + isRequired: true + types: + - + - name: query + isRequired: true + types: + - ( + - ) + - name: options + description: The request options for the request. + isRequired: true + types: + - + - name: partition_key_range_id + description: Partition key range id. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.QueryItems + name: QueryItems + summary: Queries documents in a collection. + signature: QueryItems(database_or_Container_link, query, options=None, partition_key=None) + parameters: + - name: database_or_Container_link + description: The link to the database when using partitioning, otherwise link + to the document collection. + isRequired: true + types: + - + - name: query + isRequired: true + types: + - ( + - ) + - name: options + description: The request options for the request. + defaultValue: None + types: + - + - name: partition_key + description: Partition key for the query(default value None) + defaultValue: None + types: + - + return: + description: Query Iterable of Documents. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.QueryItemsChangeFeed + name: QueryItemsChangeFeed + summary: Queries documents change feed in a collection. + signature: QueryItemsChangeFeed(collection_link, options=None) + parameters: + - name: collection_link + description: The link to the document collection. + isRequired: true + types: + - + - name: options + description: 'The request options for the request. + + options may also specify partition key range id.' + defaultValue: None + types: + - + return: + description: Query Iterable of Documents. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.QueryOffers + name: QueryOffers + summary: Query for all offers. + signature: QueryOffers(query, options=None) + parameters: + - name: query + isRequired: true + types: + - ( + - ) + - name: options + description: The request options for the request + defaultValue: None + types: + - + return: + description: Query Iterable of Offers. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.QueryPermissions + name: QueryPermissions + summary: Queries permissions for a user. + signature: QueryPermissions(user_link, query, options=None) + parameters: + - name: user_link + description: The link to the user entity. + isRequired: true + types: + - + - name: query + isRequired: true + types: + - ( + - ) + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: Query Iterable of Permissions. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.QueryStoredProcedures + name: QueryStoredProcedures + summary: Queries stored procedures in a collection. + signature: QueryStoredProcedures(collection_link, query, options=None) + parameters: + - name: collection_link + description: The link to the document collection. + isRequired: true + types: + - + - name: query + isRequired: true + types: + - ( + - ) + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: Query Iterable of Stored Procedures. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.QueryTriggers + name: QueryTriggers + summary: Queries triggers in a collection. + signature: QueryTriggers(collection_link, query, options=None) + parameters: + - name: collection_link + description: The link to the document collection. + isRequired: true + types: + - + - name: query + isRequired: true + types: + - ( + - ) + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: Query Iterable of Triggers. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.QueryUserDefinedFunctions + name: QueryUserDefinedFunctions + summary: Queries user defined functions in a collection. + signature: QueryUserDefinedFunctions(collection_link, query, options=None) + parameters: + - name: collection_link + description: The link to the collection. + isRequired: true + types: + - + - name: query + isRequired: true + types: + - ( + - ) + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: Query Iterable of UDFs. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.QueryUsers + name: QueryUsers + summary: Queries users in a database. + signature: QueryUsers(database_link, query, options=None) + parameters: + - name: database_link + description: The link to the database. + isRequired: true + types: + - + - name: query + isRequired: true + types: + - ( + - ) + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: Query Iterable of Users. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.Read + name: Read + summary: Reads a Azure Cosmos resource and returns it. + signature: Read(path, type, id, initial_headers, options=None) + parameters: + - name: path + isRequired: true + types: + - + - name: type + isRequired: true + types: + - + - name: id + isRequired: true + types: + - + - name: initial_headers + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The upserted Azure Cosmos resource. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadAttachment + name: ReadAttachment + summary: Reads an attachment. + signature: ReadAttachment(attachment_link, options=None) + parameters: + - name: attachment_link + description: The link to the attachment. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The read Attachment. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadAttachments + name: ReadAttachments + summary: Reads all attachments in a document. + signature: ReadAttachments(document_link, options=None) + parameters: + - name: document_link + description: The link to the document. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: Query Iterable of Attachments. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadConflict + name: ReadConflict + summary: Reads a conflict. + signature: ReadConflict(conflict_link, options=None) + parameters: + - name: conflict_link + description: The link to the conflict. + isRequired: true + types: + - + - name: options + defaultValue: None + types: + - + return: + description: The read Conflict. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadConflicts + name: ReadConflicts + summary: Reads conflicts. + signature: ReadConflicts(collection_link, feed_options=None) + parameters: + - name: collection_link + description: The link to the document collection. + isRequired: true + types: + - + - name: feed_options + defaultValue: None + types: + - + return: + description: Query Iterable of Conflicts. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadContainer + name: ReadContainer + summary: Reads a collection. + signature: ReadContainer(collection_link, options=None) + parameters: + - name: collection_link + description: The link to the document collection. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The read Collection. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadContainers + name: ReadContainers + summary: Reads all collections in a database. + signature: ReadContainers(database_link, options=None) + parameters: + - name: database_link + description: The link to the database. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: Query Iterable of Collections. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadDatabase + name: ReadDatabase + summary: Reads a database. + signature: ReadDatabase(database_link, options=None) + parameters: + - name: database_link + description: The link to the database. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The Database that was read. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadDatabases + name: ReadDatabases + summary: Reads all databases. + signature: ReadDatabases(options=None) + parameters: + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: Query Iterable of Databases. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadItem + name: ReadItem + summary: Reads a document. + signature: ReadItem(document_link, options=None) + parameters: + - name: document_link + description: The link to the document. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The read Document. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadItems + name: ReadItems + summary: Reads all documents in a collection. + signature: ReadItems(collection_link, feed_options=None) + parameters: + - name: collection_link + description: The link to the document collection. + isRequired: true + types: + - + - name: feed_options + defaultValue: None + types: + - + return: + description: Query Iterable of Documents. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadMedia + name: ReadMedia + summary: 'Reads a media. + + + When self.connection_policy.MediaReadMode == + + documents.MediaReadMode.Streamed, returns a file-like stream object; + + otherwise, returns a str.' + signature: ReadMedia(media_link) + parameters: + - name: media_link + description: The link to the media. + isRequired: true + types: + - + return: + description: The read Media. + types: + - + - - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadOffer + name: ReadOffer + summary: Reads an offer. + signature: ReadOffer(offer_link) + parameters: + - name: offer_link + description: The link to the offer. + isRequired: true + types: + - + return: + description: The read Offer. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadOffers + name: ReadOffers + summary: Reads all offers. + signature: ReadOffers(options=None) + parameters: + - name: options + description: The request options for the request + defaultValue: None + types: + - + return: + description: Query Iterable of Offers. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadPermission + name: ReadPermission + summary: Reads a permission. + signature: ReadPermission(permission_link, options=None) + parameters: + - name: permission_link + description: The link to the permission. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The read permission. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadPermissions + name: ReadPermissions + summary: Reads all permissions for a user. + signature: ReadPermissions(user_link, options=None) + parameters: + - name: user_link + description: The link to the user entity. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: Query Iterable of Permissions. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadStoredProcedure + name: ReadStoredProcedure + summary: Reads a stored procedure. + signature: ReadStoredProcedure(sproc_link, options=None) + parameters: + - name: sproc_link + description: The link to the stored procedure. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The read Stored Procedure. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadStoredProcedures + name: ReadStoredProcedures + summary: Reads all store procedures in a collection. + signature: ReadStoredProcedures(collection_link, options=None) + parameters: + - name: collection_link + description: The link to the document collection. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: Query Iterable of Stored Procedures. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadTrigger + name: ReadTrigger + summary: Reads a trigger. + signature: ReadTrigger(trigger_link, options=None) + parameters: + - name: trigger_link + description: The link to the trigger. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The read Trigger. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadTriggers + name: ReadTriggers + summary: Reads all triggers in a collection. + signature: ReadTriggers(collection_link, options=None) + parameters: + - name: collection_link + description: The link to the document collection. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: Query Iterable of Triggers. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadUser + name: ReadUser + summary: Reads a user. + signature: ReadUser(user_link, options=None) + parameters: + - name: user_link + description: The link to the user entity. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The read User. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadUserDefinedFunction + name: ReadUserDefinedFunction + summary: Reads a user defined function. + signature: ReadUserDefinedFunction(udf_link, options=None) + parameters: + - name: udf_link + description: The link to the user defined function. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The read UDF. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadUserDefinedFunctions + name: ReadUserDefinedFunctions + summary: Reads all user defined functions in a collection. + signature: ReadUserDefinedFunctions(collection_link, options=None) + parameters: + - name: collection_link + description: The link to the document collection. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: Query Iterable of UDFs. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadUsers + name: ReadUsers + summary: Reads all users in a database. + signature: ReadUsers(database_link, options=None) + parameters: + - name: database_link + isRequired: true + - name: options + defaultValue: None + return: + description: Query iterable of Users. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.RegisterPartitionResolver + name: RegisterPartitionResolver + summary: Registers the partition resolver associated with the database link + signature: RegisterPartitionResolver(database_link, partition_resolver) + parameters: + - name: database_link + description: Database Self Link or ID based link. + isRequired: true + types: + - + - name: partition_resolver + description: An instance of PartitionResolver. + isRequired: true + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.Replace + name: Replace + summary: Replaces a Azure Cosmos resource and returns it. + signature: Replace(resource, path, type, id, initial_headers, options=None) + parameters: + - name: resource + isRequired: true + types: + - + - name: path + isRequired: true + types: + - + - name: type + isRequired: true + types: + - + - name: id + isRequired: true + types: + - + - name: initial_headers + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The new Azure Cosmos resource. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReplaceAttachment + name: ReplaceAttachment + summary: Replaces an attachment and returns it. + signature: ReplaceAttachment(attachment_link, attachment, options=None) + parameters: + - name: attachment_link + description: The link to the attachment. + isRequired: true + types: + - + - name: attachment + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The replaced Attachment + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReplaceContainer + name: ReplaceContainer + summary: Replaces a collection and return it. + signature: ReplaceContainer(collection_link, collection, options=None) + parameters: + - name: collection_link + description: The link to the collection entity. + isRequired: true + types: + - + - name: collection + description: The collection to be used. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The new Collection. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReplaceItem + name: ReplaceItem + summary: Replaces a document and returns it. + signature: ReplaceItem(document_link, new_document, options=None) + parameters: + - name: document_link + description: The link to the document. + isRequired: true + types: + - + - name: new_document + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The new Document. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReplaceOffer + name: ReplaceOffer + summary: Replaces an offer and returns it. + signature: ReplaceOffer(offer_link, offer) + parameters: + - name: offer_link + description: The link to the offer. + isRequired: true + types: + - + - name: offer + isRequired: true + types: + - + return: + description: The replaced Offer. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReplacePermission + name: ReplacePermission + summary: Replaces a permission and return it. + signature: ReplacePermission(permission_link, permission, options=None) + parameters: + - name: permission_link + description: The link to the permission. + isRequired: true + types: + - + - name: permission + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The new Permission. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReplaceStoredProcedure + name: ReplaceStoredProcedure + summary: Replaces a stored procedure and returns it. + signature: ReplaceStoredProcedure(sproc_link, sproc, options=None) + parameters: + - name: sproc_link + description: The link to the stored procedure. + isRequired: true + types: + - + - name: sproc + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The replaced Stored Procedure. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReplaceTrigger + name: ReplaceTrigger + summary: Replaces a trigger and returns it. + signature: ReplaceTrigger(trigger_link, trigger, options=None) + parameters: + - name: trigger_link + description: The link to the trigger. + isRequired: true + types: + - + - name: trigger + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The replaced Trigger. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReplaceUser + name: ReplaceUser + summary: Replaces a user and return it. + signature: ReplaceUser(user_link, user, options=None) + parameters: + - name: user_link + description: The link to the user entity. + isRequired: true + types: + - + - name: user + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The new User. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.ReplaceUserDefinedFunction + name: ReplaceUserDefinedFunction + summary: Replaces a user defined function and returns it. + signature: ReplaceUserDefinedFunction(udf_link, udf, options=None) + parameters: + - name: udf_link + description: The link to the user defined function. + isRequired: true + types: + - + - name: udf + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The new UDF. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.UpdateMedia + name: UpdateMedia + summary: Updates a media and returns it. + signature: UpdateMedia(media_link, readable_stream, options=None) + parameters: + - name: media_link + description: The link to the media. + isRequired: true + types: + - + - name: readable_stream + isRequired: true + types: + - )> + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The updated Media. + types: + - + - - +- uid: azure.cosmos.cosmos_client.CosmosClient.Upsert + name: Upsert + summary: Upserts a Azure Cosmos resource and returns it. + signature: Upsert(body, path, type, id, initial_headers, options=None) + parameters: + - name: body + isRequired: true + types: + - + - name: path + isRequired: true + types: + - + - name: type + isRequired: true + types: + - + - name: id + isRequired: true + types: + - + - name: initial_headers + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The upserted Azure Cosmos resource. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.UpsertAttachment + name: UpsertAttachment + summary: Upserts an attachment in a document. + signature: UpsertAttachment(document_link, attachment, options=None) + parameters: + - name: document_link + description: The link to the document. + isRequired: true + types: + - + - name: attachment + description: The Azure Cosmos attachment to upsert. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The upserted Attachment. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.UpsertAttachmentAndUploadMedia + name: UpsertAttachmentAndUploadMedia + summary: Upserts an attachment and upload media. + signature: UpsertAttachmentAndUploadMedia(document_link, readable_stream, options=None) + parameters: + - name: document_link + description: The link to the document. + isRequired: true + types: + - + - name: readable_stream + isRequired: true + types: + - )> + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The upserted Attachment. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.UpsertItem + name: UpsertItem + summary: Upserts a document in a collection. + signature: UpsertItem(database_or_Container_link, document, options=None) + parameters: + - name: database_or_Container_link + description: The link to the database when using partitioning, otherwise link + to the document collection. + isRequired: true + types: + - + - name: document + description: The Azure Cosmos document to upsert. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + - name: options['disableAutomaticIdGeneration'] + description: 'Disables the automatic id generation. If id is missing in the body + and this + + option is true, an error will be returned.' + isRequired: true + types: + - '''disableAutomaticIdGeneration''] (' + return: + description: The upserted Document. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.UpsertPermission + name: UpsertPermission + summary: Upserts a permission for a user. + signature: UpsertPermission(user_link, permission, options=None) + parameters: + - name: user_link + description: The link to the user entity. + isRequired: true + types: + - + - name: permission + description: The Azure Cosmos user permission to upsert. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The upserted permission. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.UpsertStoredProcedure + name: UpsertStoredProcedure + summary: Upserts a stored procedure in a collection. + signature: UpsertStoredProcedure(collection_link, sproc, options=None) + parameters: + - name: collection_link + description: The link to the document collection. + isRequired: true + types: + - + - name: sproc + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The upserted Stored Procedure. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.UpsertTrigger + name: UpsertTrigger + summary: Upserts a trigger in a collection. + signature: UpsertTrigger(collection_link, trigger, options=None) + parameters: + - name: collection_link + description: The link to the document collection. + isRequired: true + types: + - + - name: trigger + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The upserted Trigger. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.UpsertUser + name: UpsertUser + summary: Upserts a user. + signature: UpsertUser(database_link, user, options=None) + parameters: + - name: database_link + description: The link to the database. + isRequired: true + types: + - + - name: user + description: The Azure Cosmos user to upsert. + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The upserted User. + types: + - +- uid: azure.cosmos.cosmos_client.CosmosClient.UpsertUserDefinedFunction + name: UpsertUserDefinedFunction + summary: Upserts a user defined function in a collection. + signature: UpsertUserDefinedFunction(collection_link, udf, options=None) + parameters: + - name: collection_link + description: The link to the collection. + isRequired: true + types: + - + - name: udf + isRequired: true + types: + - + - name: options + description: The request options for the request. + defaultValue: None + types: + - + return: + description: The upserted UDF. + types: + - +attributes: +- uid: azure.cosmos.cosmos_client.CosmosClient.ReadEndpoint + name: ReadEndpoint + summary: Gets the curent read endpoint for a geo-replicated database account. +- uid: azure.cosmos.cosmos_client.CosmosClient.Session + name: Session + summary: Gets the session object from the client +- uid: azure.cosmos.cosmos_client.CosmosClient.WriteEndpoint + name: WriteEndpoint + summary: Gets the curent write endpoint for a geo-replicated database account. +- uid: azure.cosmos.cosmos_client.CosmosClient.PartitionResolverErrorMessage + name: PartitionResolverErrorMessage + signature: PartitionResolverErrorMessage = "Couldn't find any partition resolvers + for the database link provided. Ensure that the link you used when registering + the partition resolvers matches the link provided or you need to register both + types of database link(self link as well as ID based link)." diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.cosmos_client.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.cosmos_client.yml new file mode 100644 index 00000000..fcb9b026 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.cosmos_client.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.cosmos.cosmos_client +name: cosmos_client +fullName: azure.cosmos.cosmos_client +summary: Document client class for the Azure Cosmos database service. +classes: +- azure.cosmos.cosmos_client.CosmosClient diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.default_retry_policy.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.default_retry_policy.yml new file mode 100644 index 00000000..aac439fe --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.default_retry_policy.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cosmos.default_retry_policy +name: default_retry_policy +fullName: azure.cosmos.default_retry_policy +summary: Internal class for connection reset retry policy implementation in the Azure + Cosmos database service. diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.ConnectionMode.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.ConnectionMode.yml new file mode 100644 index 00000000..9c1c3372 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.ConnectionMode.yml @@ -0,0 +1,19 @@ +### YamlMime:PythonClass +uid: azure.cosmos.documents.ConnectionMode +name: ConnectionMode +fullName: azure.cosmos.documents.ConnectionMode +module: azure.cosmos.documents +summary: Represents the connection mode to be used by the client. +constructor: + syntax: ConnectionMode() +variables: +- description: 'Use the Azure Cosmos gateway to route all requests. The + + gateway proxies requests to the right data partition.' + name: Gateway + types: + - +attributes: +- uid: azure.cosmos.documents.ConnectionMode.Gateway + name: Gateway + signature: Gateway = 0 diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.ConnectionPolicy.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.ConnectionPolicy.yml new file mode 100644 index 00000000..2b02a122 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.ConnectionPolicy.yml @@ -0,0 +1,87 @@ +### YamlMime:PythonClass +uid: azure.cosmos.documents.ConnectionPolicy +name: ConnectionPolicy +fullName: azure.cosmos.documents.ConnectionPolicy +module: azure.cosmos.documents +summary: Represents the Connection policy assocated with a CosmosClient. +constructor: + syntax: ConnectionPolicy() +variables: +- description: 'Gets or sets the request timeout (time to wait + + for response from network peer).' + name: RequestTimeout + types: + - +- description: 'Gets or sets Time to wait for response + + from network peer for attachment content (aka media) operations.' + name: MediaRequestTimeout + types: + - +- description: 'Gets or sets the connection mode used in the client. Currently + + only Gateway is supported.' + name: ConnectionMode + types: + - +- description: Gets or sets the attachment content (aka media) download mode. + name: MediaReadMode + types: + - +- description: Gets or sets the SSL configuration. + name: SSLConfiguration + types: + - +- description: Gets or sets the proxy configuration. + name: ProxyConfiguration + types: + - +- description: 'Gets or sets endpoint discovery flag for geo-replicated database accounts. + + When EnableEndpointDiscovery is true, the client will automatically discover the + + current write and read locations and direct the requests to the correct location + + taking into consideration of the user''s preference(if provided) as PreferredLocations.' + name: EnableEndpointDiscovery + types: + - +- description: 'Gets or sets the preferred locations for geo-replicated database accounts. + + When EnableEndpointDiscovery is true and PreferredLocations is non-empty, + + the client will use this list to evaluate the final location, taking into consideration + + the order specified in PreferredLocations list. The locations in this list are + specified as the names of + + the azure Cosmos locations like, ''West US'', ''East US'', ''Central India'' and + so on.' + name: PreferredLocations + types: + - +- description: Gets or sets the retry options to be applied to all requests when retrying. + name: RetryOptions + types: + - +- description: 'Flag to disable SSL verification for the requests. SSL verification + is enabled by default. + + Don''t set this when targeting production endpoints. + + This is intended to be used only when targeting emulator endpoint to avoid failing + your requests with SSL related error.' + name: DisableSSLVerification + types: + - +- description: Flag to enable writes on any locations (regions) for geo-replicated + database accounts in the azure Cosmos service. + name: UseMultipleWriteLocations + types: + - +- description: Retry Configuration to be used for urllib3 connection retries. + name: ConnectionRetryConfiguration + types: + - ( + - ) diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.ConsistencyLevel.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.ConsistencyLevel.yml new file mode 100644 index 00000000..146371a4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.ConsistencyLevel.yml @@ -0,0 +1,77 @@ +### YamlMime:PythonClass +uid: azure.cosmos.documents.ConsistencyLevel +name: ConsistencyLevel +fullName: azure.cosmos.documents.ConsistencyLevel +module: azure.cosmos.documents +summary: 'Represents the consistency levels supported for Azure Cosmos client + + operations. + + + The requested ConsistencyLevel must match or be weaker than that provisioned + + for the database account. Consistency levels. + + + Consistency levels by order of strength are Strong, BoundedStaleness, + + Session, ConsistentPrefix and Eventual.' +constructor: + syntax: ConsistencyLevel() +variables: +- description: 'Strong Consistency guarantees that read operations always + + return the value that was last written.' + name: ConsistencyLevel.Strong + types: + - +- description: 'Bounded Staleness guarantees that reads are not + + too out-of-date. This can be configured based on number of operations + + (MaxStalenessPrefix) or time (MaxStalenessIntervalInSeconds).' + name: ConsistencyLevel.BoundedStaleness + types: + - +- description: 'Session Consistency guarantees monotonic reads (you never + + read old data, then new, then old again), monotonic writes (writes + + are ordered) and read your writes (your writes are immediately + + visible to your reads) within any single session.' + name: ConsistencyLevel.Session + types: + - +- description: 'Eventual Consistency guarantees that reads will return + + a subset of writes. All writes will be eventually be available for + + reads.' + name: ConsistencyLevel.Eventual + types: + - +- description: 'ConsistentPrefix Consistency guarantees that + + reads will return some prefix of all writes with no gaps. All writes + + will be eventually be available for reads.' + name: ConsistencyLevel.ConsistentPrefix + types: + - +attributes: +- uid: azure.cosmos.documents.ConsistencyLevel.BoundedStaleness + name: BoundedStaleness + signature: BoundedStaleness = 'BoundedStaleness' +- uid: azure.cosmos.documents.ConsistencyLevel.ConsistentPrefix + name: ConsistentPrefix + signature: ConsistentPrefix = 'ConsistentPrefix' +- uid: azure.cosmos.documents.ConsistencyLevel.Eventual + name: Eventual + signature: Eventual = 'Eventual' +- uid: azure.cosmos.documents.ConsistencyLevel.Session + name: Session + signature: Session = 'Session' +- uid: azure.cosmos.documents.ConsistencyLevel.Strong + name: Strong + signature: Strong = 'Strong' diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.DataType.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.DataType.yml new file mode 100644 index 00000000..72288cac --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.DataType.yml @@ -0,0 +1,52 @@ +### YamlMime:PythonClass +uid: azure.cosmos.documents.DataType +name: DataType +fullName: azure.cosmos.documents.DataType +module: azure.cosmos.documents +summary: Specifies the data type of index specs. +constructor: + syntax: DataType() +variables: +- description: Represents a numeric data type. + name: Number + types: + - +- description: Represents a string data type. + name: String + types: + - +- description: Represents a point data type. + name: Point + types: + - +- description: Represents a line string data type. + name: LineString + types: + - +- description: Represents a polygon data type. + name: Polygon + types: + - +- description: Represents a multi-polygon data type. + name: MultiPolygon + types: + - +attributes: +- uid: azure.cosmos.documents.DataType.LineString + name: LineString + signature: LineString = 'LineString' +- uid: azure.cosmos.documents.DataType.MultiPolygon + name: MultiPolygon + signature: MultiPolygon = 'MultiPolygon' +- uid: azure.cosmos.documents.DataType.Number + name: Number + signature: Number = 'Number' +- uid: azure.cosmos.documents.DataType.Point + name: Point + signature: Point = 'Point' +- uid: azure.cosmos.documents.DataType.Polygon + name: Polygon + signature: Polygon = 'Polygon' +- uid: azure.cosmos.documents.DataType.String + name: String + signature: String = 'String' diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.DatabaseAccount.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.DatabaseAccount.yml new file mode 100644 index 00000000..cc009e80 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.DatabaseAccount.yml @@ -0,0 +1,62 @@ +### YamlMime:PythonClass +uid: azure.cosmos.documents.DatabaseAccount +name: DatabaseAccount +fullName: azure.cosmos.documents.DatabaseAccount +module: azure.cosmos.documents +summary: Database account. A DatabaseAccount is the container for databases. +constructor: + syntax: DatabaseAccount() +variables: +- description: The self-link for Databases in the databaseAccount. + name: DatabaseLink + types: + - +- description: The self-link for Media in the databaseAccount. + name: MediaLink + types: + - +- description: Attachment content (media) storage quota in MBs (Retrieved from gateway). + name: MaxMediaStorageUsageInMB + types: + - +- description: 'Current attachment content (media) usage in MBs (Retrieved from gateway). + + Value is returned from cached information updated periodically and + + is not guaranteed to be real time.' + name: CurrentMediaStorageUsageInMB + types: + - +- description: UserConsistencyPolicy settings. + name: ConsistencyPolicy + types: + - +- description: The default consistency level. + name: ConsistencyPolicy['defaultConsistencyLevel'] + types: + - '''defaultConsistencyLevel''] (' +- description: 'In bounded staleness consistency, the maximum allowed staleness in + + terms difference in sequence numbers (aka version).' + name: ConsistencyPolicy['maxStalenessPrefix'] + types: + - '''maxStalenessPrefix''] (' +- description: 'In bounded staleness consistency, the maximum allowed staleness in + + terms time interval.' + name: ConsistencyPolicy['maxStalenessIntervalInSeconds'] + types: + - '''maxStalenessIntervalInSeconds''] (' +- description: 'Flag on the azure Cosmos account that indicates if writes can take + + place in multiple locations.' + name: EnableMultipleWritableLocations + types: + - +attributes: +- uid: azure.cosmos.documents.DatabaseAccount.ReadableLocations + name: ReadableLocations + summary: Gets the list of readable locations for a geo-replicated database account. +- uid: azure.cosmos.documents.DatabaseAccount.WritableLocations + name: WritableLocations + summary: Gets the list of writable locations for a geo-replicated database account. diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.IndexKind.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.IndexKind.yml new file mode 100644 index 00000000..e72eb6d4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.IndexKind.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.cosmos.documents.IndexKind +name: IndexKind +fullName: azure.cosmos.documents.IndexKind +module: azure.cosmos.documents +summary: Specifies the index kind of index specs. +constructor: + syntax: IndexKind() +variables: +- description: 'The index entries are hashed to serve point look up queries. + + Can be used to serve queries like: SELECT * FROM docs d WHERE d.prop = 5' + name: IndexKind.Hash + types: + - +- description: 'The index entries are ordered. Range indexes are optimized for + + inequality predicate queries with efficient range scans. + + Can be used to serve queries like: SELECT * FROM docs d WHERE d.prop > 5' + name: IndexKind.Range + types: + - +attributes: +- uid: azure.cosmos.documents.IndexKind.Hash + name: Hash + signature: Hash = 'Hash' +- uid: azure.cosmos.documents.IndexKind.Range + name: Range + signature: Range = 'Range' diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.IndexingDirective.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.IndexingDirective.yml new file mode 100644 index 00000000..cd353210 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.IndexingDirective.yml @@ -0,0 +1,31 @@ +### YamlMime:PythonClass +uid: azure.cosmos.documents.IndexingDirective +name: IndexingDirective +fullName: azure.cosmos.documents.IndexingDirective +module: azure.cosmos.documents +summary: Specifies whether or not the resource is to be indexed. +constructor: + syntax: IndexingDirective() +variables: +- description: Use any pre-defined/pre-configured defaults. + name: Default + types: + - +- description: Index the resource. + name: Exclude + types: + - +- description: Do not index the resource. + name: Include + types: + - +attributes: +- uid: azure.cosmos.documents.IndexingDirective.Default + name: Default + signature: Default = 0 +- uid: azure.cosmos.documents.IndexingDirective.Exclude + name: Exclude + signature: Exclude = 1 +- uid: azure.cosmos.documents.IndexingDirective.Include + name: Include + signature: Include = 2 diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.IndexingMode.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.IndexingMode.yml new file mode 100644 index 00000000..f4e85cbc --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.IndexingMode.yml @@ -0,0 +1,56 @@ +### YamlMime:PythonClass +uid: azure.cosmos.documents.IndexingMode +name: IndexingMode +fullName: azure.cosmos.documents.IndexingMode +module: azure.cosmos.documents +summary: Specifies the supported indexing modes. +constructor: + syntax: IndexingMode() +variables: +- description: 'Index is updated synchronously with a create or + + update operation. With consistent indexing, query behavior is the + + same as the default consistency level for the collection. + + + The index is + + always kept up to date with the data.' + name: Consistent + types: + - +- description: 'Index is updated asynchronously with respect to a create + + or update operation. + + + With lazy indexing, queries are eventually consistent. The index is + + updated when the collection is idle.' + name: Lazy + types: + - +- description: 'No index is provided. + + + Setting IndexingMode to "None" drops the index. Use this if you don''t + + want to maintain the index for a document collection, to save the + + storage cost or improve the write throughput. Your queries will + + degenerate to scans of the entire collection.' + name: NoIndex + types: + - +attributes: +- uid: azure.cosmos.documents.IndexingMode.Consistent + name: Consistent + signature: Consistent = 'consistent' +- uid: azure.cosmos.documents.IndexingMode.Lazy + name: Lazy + signature: Lazy = 'lazy' +- uid: azure.cosmos.documents.IndexingMode.NoIndex + name: NoIndex + signature: NoIndex = 'none' diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.MediaReadMode.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.MediaReadMode.yml new file mode 100644 index 00000000..257c022d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.MediaReadMode.yml @@ -0,0 +1,38 @@ +### YamlMime:PythonClass +uid: azure.cosmos.documents.MediaReadMode +name: MediaReadMode +fullName: azure.cosmos.documents.MediaReadMode +module: azure.cosmos.documents +summary: 'Represents the mode for use with downloading attachment content + + (aka media).' +constructor: + syntax: MediaReadMode() +variables: +- description: 'Content is buffered at the client and not directly + + streamed from the content store. + + + Use Buffered to reduce the time taken to read and write media files.' + name: Buffered + types: + - +- description: 'Content is directly streamed from the content store + + without any buffering at the client. + + + Use Streamed to reduce the client memory overhead of reading and + + writing media files.' + name: Streamed + types: + - +attributes: +- uid: azure.cosmos.documents.MediaReadMode.Buffered + name: Buffered + signature: Buffered = 'Buffered' +- uid: azure.cosmos.documents.MediaReadMode.Streamed + name: Streamed + signature: Streamed = 'Streamed' diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.PartitionKind.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.PartitionKind.yml new file mode 100644 index 00000000..ce296931 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.PartitionKind.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.cosmos.documents.PartitionKind +name: PartitionKind +fullName: azure.cosmos.documents.PartitionKind +module: azure.cosmos.documents +summary: Specifies the kind of partitioning to be applied. +constructor: + syntax: PartitionKind() +variables: +- description: The partition key definition path is hashed. + name: PartitionKind.Hash + types: + - +attributes: +- uid: azure.cosmos.documents.PartitionKind.Hash + name: Hash + signature: Hash = 'Hash' diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.PermissionMode.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.PermissionMode.yml new file mode 100644 index 00000000..b5187d44 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.PermissionMode.yml @@ -0,0 +1,31 @@ +### YamlMime:PythonClass +uid: azure.cosmos.documents.PermissionMode +name: PermissionMode +fullName: azure.cosmos.documents.PermissionMode +module: azure.cosmos.documents +summary: Enumeration specifying applicability of permission. +constructor: + syntax: PermissionMode() +variables: +- description: None. + name: PermissionMode.NoneMode + types: + - +- description: Permission applicable for read operations only. + name: PermissionMode.Read + types: + - +- description: Permission applicable for all operations. + name: PermissionMode.All + types: + - +attributes: +- uid: azure.cosmos.documents.PermissionMode.All + name: All + signature: All = 'all' +- uid: azure.cosmos.documents.PermissionMode.NoneMode + name: NoneMode + signature: NoneMode = 'none' +- uid: azure.cosmos.documents.PermissionMode.Read + name: Read + signature: Read = 'read' diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.ProxyConfiguration.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.ProxyConfiguration.yml new file mode 100644 index 00000000..77d10dfb --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.ProxyConfiguration.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.cosmos.documents.ProxyConfiguration +name: ProxyConfiguration +fullName: azure.cosmos.documents.ProxyConfiguration +module: azure.cosmos.documents +summary: Configurations for proxy. +constructor: + syntax: ProxyConfiguration() +variables: +- description: The host address of the proxy. + name: Host + types: + - +- description: The port number of the proxy. + name: Port + types: + - diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.SSLConfiguration.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.SSLConfiguration.yml new file mode 100644 index 00000000..0b7b1127 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.SSLConfiguration.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.cosmos.documents.SSLConfiguration +name: SSLConfiguration +fullName: azure.cosmos.documents.SSLConfiguration +module: azure.cosmos.documents +summary: 'Configurations for SSL connections. + + + Please refer to [http://docs.python-requests.org/en/master/user/advanced/#ssl-cert-verification](http://docs.python-requests.org/en/master/user/advanced/#ssl-cert-verification) + for more detail.' +constructor: + syntax: SSLConfiguration() +variables: +- description: The path of the key file for ssl connection. + name: SSLKeyFIle + types: + - +- description: The path of the cert file for ssl connection. + name: SSLCertFile + types: + - +- description: The path of the CA_BUNDLE file with certificates of trusted CAs. + name: SSLCaCerts + types: + - diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.TriggerOperation.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.TriggerOperation.yml new file mode 100644 index 00000000..a4a540f5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.TriggerOperation.yml @@ -0,0 +1,45 @@ +### YamlMime:PythonClass +uid: azure.cosmos.documents.TriggerOperation +name: TriggerOperation +fullName: azure.cosmos.documents.TriggerOperation +module: azure.cosmos.documents +summary: Specifies the operations on which a trigger should be executed. +constructor: + syntax: TriggerOperation() +variables: +- description: All operations. + name: TriggerOperation.All + types: + - +- description: Create operations only. + name: TriggerOperation.Create + types: + - +- description: Update operations only. + name: TriggerOperation.Update + types: + - +- description: Delete operations only. + name: TriggerOperation.Delete + types: + - +- description: Replace operations only. + name: TriggerOperation.Replace + types: + - +attributes: +- uid: azure.cosmos.documents.TriggerOperation.All + name: All + signature: All = 'all' +- uid: azure.cosmos.documents.TriggerOperation.Create + name: Create + signature: Create = 'create' +- uid: azure.cosmos.documents.TriggerOperation.Delete + name: Delete + signature: Delete = 'delete' +- uid: azure.cosmos.documents.TriggerOperation.Replace + name: Replace + signature: Replace = 'replace' +- uid: azure.cosmos.documents.TriggerOperation.Update + name: Update + signature: Update = 'update' diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.TriggerType.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.TriggerType.yml new file mode 100644 index 00000000..6c8aaeae --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.TriggerType.yml @@ -0,0 +1,24 @@ +### YamlMime:PythonClass +uid: azure.cosmos.documents.TriggerType +name: TriggerType +fullName: azure.cosmos.documents.TriggerType +module: azure.cosmos.documents +summary: Specifies the type of the trigger. +constructor: + syntax: TriggerType() +variables: +- description: Trigger should be executed before the associated operation(s). + name: TriggerType.Pre + types: + - +- description: Trigger should be executed after the associated operation(s). + name: TriggerType.Post + types: + - +attributes: +- uid: azure.cosmos.documents.TriggerType.Post + name: Post + signature: Post = 'post' +- uid: azure.cosmos.documents.TriggerType.Pre + name: Pre + signature: Pre = 'pre' diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.Undefined.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.Undefined.yml new file mode 100644 index 00000000..7ee3378d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.Undefined.yml @@ -0,0 +1,8 @@ +### YamlMime:PythonClass +uid: azure.cosmos.documents.Undefined +name: Undefined +fullName: azure.cosmos.documents.Undefined +module: azure.cosmos.documents +summary: Represents undefined value for partitionKey when it's mising. +constructor: + syntax: Undefined() diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.yml new file mode 100644 index 00000000..9e5dd2f1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.documents.yml @@ -0,0 +1,22 @@ +### YamlMime:PythonModule +uid: azure.cosmos.documents +name: documents +fullName: azure.cosmos.documents +summary: AzureDocument classes and enums for the Azure Cosmos database service. +classes: +- azure.cosmos.documents.ConnectionMode +- azure.cosmos.documents.ConnectionPolicy +- azure.cosmos.documents.ConsistencyLevel +- azure.cosmos.documents.DataType +- azure.cosmos.documents.DatabaseAccount +- azure.cosmos.documents.IndexKind +- azure.cosmos.documents.IndexingDirective +- azure.cosmos.documents.IndexingMode +- azure.cosmos.documents.MediaReadMode +- azure.cosmos.documents.PartitionKind +- azure.cosmos.documents.PermissionMode +- azure.cosmos.documents.ProxyConfiguration +- azure.cosmos.documents.SSLConfiguration +- azure.cosmos.documents.TriggerOperation +- azure.cosmos.documents.TriggerType +- azure.cosmos.documents.Undefined diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.endpoint_discovery_retry_policy.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.endpoint_discovery_retry_policy.yml new file mode 100644 index 00000000..e9ec27e4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.endpoint_discovery_retry_policy.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cosmos.endpoint_discovery_retry_policy +name: endpoint_discovery_retry_policy +fullName: azure.cosmos.endpoint_discovery_retry_policy +summary: Internal class for endpoint discovery retry policy implementation in the + Azure Cosmos database service. diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.errors.CosmosError.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.errors.CosmosError.yml new file mode 100644 index 00000000..fa33fa16 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.errors.CosmosError.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.cosmos.errors.CosmosError +name: CosmosError +fullName: azure.cosmos.errors.CosmosError +module: azure.cosmos.errors +summary: Base class for all Azure Cosmos errors. +constructor: + syntax: CosmosError() +methods: +- uid: azure.cosmos.errors.CosmosError.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cosmos.errors.CosmosError.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cosmos.errors.CosmosError.args + name: args diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.errors.HTTPFailure.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.errors.HTTPFailure.yml new file mode 100644 index 00000000..9739f3cb --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.errors.HTTPFailure.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonClass +uid: azure.cosmos.errors.HTTPFailure +name: HTTPFailure +fullName: azure.cosmos.errors.HTTPFailure +module: azure.cosmos.errors +summary: Raised when a HTTP request to the Azure Cosmos has failed. +constructor: + syntax: HTTPFailure(status_code, message='', headers=None) + parameters: + - name: status_code + isRequired: true + types: + - + - name: message + isRequired: true + types: + - + - name: headers + defaultValue: None +methods: +- uid: azure.cosmos.errors.HTTPFailure.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cosmos.errors.HTTPFailure.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cosmos.errors.HTTPFailure.args + name: args diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.errors.JSONParseFailure.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.errors.JSONParseFailure.yml new file mode 100644 index 00000000..e387d279 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.errors.JSONParseFailure.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.cosmos.errors.JSONParseFailure +name: JSONParseFailure +fullName: azure.cosmos.errors.JSONParseFailure +module: azure.cosmos.errors +summary: Raised when fails to parse JSON message. +constructor: + syntax: JSONParseFailure() +methods: +- uid: azure.cosmos.errors.JSONParseFailure.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cosmos.errors.JSONParseFailure.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cosmos.errors.JSONParseFailure.args + name: args diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.errors.UnexpectedDataType.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.errors.UnexpectedDataType.yml new file mode 100644 index 00000000..b3f4ef1d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.errors.UnexpectedDataType.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.cosmos.errors.UnexpectedDataType +name: UnexpectedDataType +fullName: azure.cosmos.errors.UnexpectedDataType +module: azure.cosmos.errors +summary: Raised when unexpected data type is provided as parameter. +constructor: + syntax: UnexpectedDataType() +methods: +- uid: azure.cosmos.errors.UnexpectedDataType.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.cosmos.errors.UnexpectedDataType.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.cosmos.errors.UnexpectedDataType.args + name: args diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.errors.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.errors.yml new file mode 100644 index 00000000..0bfa147d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.errors.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonModule +uid: azure.cosmos.errors +name: errors +fullName: azure.cosmos.errors +summary: PyCosmos Exceptions in the Azure Cosmos database service. +classes: +- azure.cosmos.errors.CosmosError +- azure.cosmos.errors.HTTPFailure +- azure.cosmos.errors.JSONParseFailure +- azure.cosmos.errors.UnexpectedDataType diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.aggregators.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.aggregators.yml new file mode 100644 index 00000000..a70b016a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.aggregators.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cosmos.execution_context.aggregators +name: aggregators +fullName: azure.cosmos.execution_context.aggregators +summary: Internal class for aggregation queries implementation in the Azure Cosmos + database service. diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.base_execution_context.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.base_execution_context.yml new file mode 100644 index 00000000..55af7621 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.base_execution_context.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cosmos.execution_context.base_execution_context +name: base_execution_context +fullName: azure.cosmos.execution_context.base_execution_context +summary: Internal class for query execution context implementation in the Azure Cosmos + database service. diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.document_producer.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.document_producer.yml new file mode 100644 index 00000000..445595d9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.document_producer.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cosmos.execution_context.document_producer +name: document_producer +fullName: azure.cosmos.execution_context.document_producer +summary: Internal class for document producer implementation in the Azure Cosmos database + service. diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.endpoint_component.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.endpoint_component.yml new file mode 100644 index 00000000..1ea11a1d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.endpoint_component.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cosmos.execution_context.endpoint_component +name: endpoint_component +fullName: azure.cosmos.execution_context.endpoint_component +summary: Internal class for query execution endpoint component implementation in the + Azure Cosmos database service. diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.execution_dispatcher.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.execution_dispatcher.yml new file mode 100644 index 00000000..fd4f8952 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.execution_dispatcher.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cosmos.execution_context.execution_dispatcher +name: execution_dispatcher +fullName: azure.cosmos.execution_context.execution_dispatcher +summary: Internal class for proxy query execution context implementation in the Azure + Cosmos database service. diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.multi_execution_aggregator.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.multi_execution_aggregator.yml new file mode 100644 index 00000000..cfa79fa3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.multi_execution_aggregator.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cosmos.execution_context.multi_execution_aggregator +name: multi_execution_aggregator +fullName: azure.cosmos.execution_context.multi_execution_aggregator +summary: Internal class for multi execution context aggregator implementation in the + Azure Cosmos database service. diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.query_execution_info.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.query_execution_info.yml new file mode 100644 index 00000000..2a48903f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.query_execution_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cosmos.execution_context.query_execution_info +name: query_execution_info +fullName: azure.cosmos.execution_context.query_execution_info +summary: Internal class for partitioned query execution info implementation in the + Azure Cosmos database service. diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.yml new file mode 100644 index 00000000..3f1dd4be --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.execution_context.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.cosmos.execution_context +name: execution_context +fullName: azure.cosmos.execution_context +type: import +modules: +- azure.cosmos.execution_context.aggregators +- azure.cosmos.execution_context.base_execution_context +- azure.cosmos.execution_context.document_producer +- azure.cosmos.execution_context.endpoint_component +- azure.cosmos.execution_context.execution_dispatcher +- azure.cosmos.execution_context.multi_execution_aggregator +- azure.cosmos.execution_context.query_execution_info diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.global_endpoint_manager.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.global_endpoint_manager.yml new file mode 100644 index 00000000..9087a698 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.global_endpoint_manager.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cosmos.global_endpoint_manager +name: global_endpoint_manager +fullName: azure.cosmos.global_endpoint_manager +summary: Internal class for global endpoint manager implementation in the Azure Cosmos + database service. diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.hash_partition_resolver.HashPartitionResolver.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.hash_partition_resolver.HashPartitionResolver.yml new file mode 100644 index 00000000..5de8415d --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.hash_partition_resolver.HashPartitionResolver.yml @@ -0,0 +1,68 @@ +### YamlMime:PythonClass +uid: azure.cosmos.hash_partition_resolver.HashPartitionResolver +name: HashPartitionResolver +fullName: azure.cosmos.hash_partition_resolver.HashPartitionResolver +module: azure.cosmos.hash_partition_resolver +summary: 'HashPartitionResolver implements partitioning based on the value of a hash + function, allowing you to evenly + + distribute requests and data across a number of partitions.' +constructor: + syntax: HashPartitionResolver(partition_key_extractor, collection_links, default_number_of_virtual_nodes_per_collection=128, + hash_generator=None) + parameters: + - name: partition_key_extractor + description: Returning the partition key from the document passed. + isRequired: true + types: + - + - name: collection_links + description: The links of collections participating in partitioning. + isRequired: true + types: + - + - name: default_number_of_virtual_nodes_per_collection + description: Number of virtual nodes per collection. + defaultValue: '128' + types: + - + - name: hash_generator + description: The hash generator to be used for hashing algorithm. + defaultValue: None + types: + - +methods: +- uid: azure.cosmos.hash_partition_resolver.HashPartitionResolver.ResolveForCreate + name: ResolveForCreate + summary: Resolves the collection for creating the document based on the partition + key. + signature: ResolveForCreate(document) + parameters: + - name: document + description: The document to be created. + isRequired: true + types: + - + return: + description: Collection Self link or Name based link which should handle the Create + operation. + types: + - +- uid: azure.cosmos.hash_partition_resolver.HashPartitionResolver.ResolveForRead + name: ResolveForRead + summary: Resolves the collection for reading/querying the documents based on the + partition key. + signature: ResolveForRead(partition_key) + parameters: + - name: document + description: The document to be read/queried. + isRequired: true + types: + - + - name: partition_key + isRequired: true + return: + description: Collection Self link(s) or Name based link(s) which should handle + the Read operation. + types: + - diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.hash_partition_resolver.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.hash_partition_resolver.yml new file mode 100644 index 00000000..74dd3ad5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.hash_partition_resolver.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.cosmos.hash_partition_resolver +name: hash_partition_resolver +fullName: azure.cosmos.hash_partition_resolver +summary: Hash partition resolver implementation in the Azure Cosmos database service. +classes: +- azure.cosmos.hash_partition_resolver.HashPartitionResolver diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.CookieHeaders.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.CookieHeaders.yml new file mode 100644 index 00000000..cf655efa --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.CookieHeaders.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonClass +uid: azure.cosmos.http_constants.CookieHeaders +name: CookieHeaders +fullName: azure.cosmos.http_constants.CookieHeaders +module: azure.cosmos.http_constants +summary: Constants of cookie headers. +constructor: + syntax: CookieHeaders() +attributes: +- uid: azure.cosmos.http_constants.CookieHeaders.SessionToken + name: SessionToken + signature: SessionToken = 'x-ms-session-token' diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.Delimiters.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.Delimiters.yml new file mode 100644 index 00000000..f0f35df1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.Delimiters.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonClass +uid: azure.cosmos.http_constants.Delimiters +name: Delimiters +fullName: azure.cosmos.http_constants.Delimiters +module: azure.cosmos.http_constants +summary: Constants of delimiters. +constructor: + syntax: Delimiters() +attributes: +- uid: azure.cosmos.http_constants.Delimiters.ClientContinuationDelimiter + name: ClientContinuationDelimiter + signature: ClientContinuationDelimiter = '!!' +- uid: azure.cosmos.http_constants.Delimiters.ClientContinuationFormat + name: ClientContinuationFormat + signature: ClientContinuationFormat = '{0}!!{1}' diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpContextProperties.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpContextProperties.yml new file mode 100644 index 00000000..c5d12506 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpContextProperties.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonClass +uid: azure.cosmos.http_constants.HttpContextProperties +name: HttpContextProperties +fullName: azure.cosmos.http_constants.HttpContextProperties +module: azure.cosmos.http_constants +summary: Constants of http context properties. +constructor: + syntax: HttpContextProperties() +attributes: +- uid: azure.cosmos.http_constants.HttpContextProperties.SubscriptionId + name: SubscriptionId + signature: SubscriptionId = 'SubscriptionId' diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpHeaderPreferenceTokens.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpHeaderPreferenceTokens.yml new file mode 100644 index 00000000..22339884 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpHeaderPreferenceTokens.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonClass +uid: azure.cosmos.http_constants.HttpHeaderPreferenceTokens +name: HttpHeaderPreferenceTokens +fullName: azure.cosmos.http_constants.HttpHeaderPreferenceTokens +module: azure.cosmos.http_constants +summary: Constants of http header preference tokens. +constructor: + syntax: HttpHeaderPreferenceTokens() +attributes: +- uid: azure.cosmos.http_constants.HttpHeaderPreferenceTokens.PreferUnfilteredQueryResponse + name: PreferUnfilteredQueryResponse + signature: PreferUnfilteredQueryResponse = 'PreferUnfilteredQueryResponse' diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpHeaders.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpHeaders.yml new file mode 100644 index 00000000..9ee76487 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpHeaders.yml @@ -0,0 +1,345 @@ +### YamlMime:PythonClass +uid: azure.cosmos.http_constants.HttpHeaders +name: HttpHeaders +fullName: azure.cosmos.http_constants.HttpHeaders +module: azure.cosmos.http_constants +summary: Constants of http headers. +constructor: + syntax: HttpHeaders() +attributes: +- uid: azure.cosmos.http_constants.HttpHeaders.AIM + name: AIM + signature: AIM = 'A-IM' +- uid: azure.cosmos.http_constants.HttpHeaders.Accept + name: Accept + signature: Accept = 'Accept' +- uid: azure.cosmos.http_constants.HttpHeaders.AcceptCharset + name: AcceptCharset + signature: AcceptCharset = 'Accept-Charset' +- uid: azure.cosmos.http_constants.HttpHeaders.AcceptEncoding + name: AcceptEncoding + signature: AcceptEncoding = 'Accept-Encoding' +- uid: azure.cosmos.http_constants.HttpHeaders.AcceptLanguage + name: AcceptLanguage + signature: AcceptLanguage = 'Accept-Language' +- uid: azure.cosmos.http_constants.HttpHeaders.AcceptRanges + name: AcceptRanges + signature: AcceptRanges = 'Accept-Ranges' +- uid: azure.cosmos.http_constants.HttpHeaders.AccessControlAllowHeaders + name: AccessControlAllowHeaders + signature: AccessControlAllowHeaders = 'Access-Control-Allow-Headers' +- uid: azure.cosmos.http_constants.HttpHeaders.AccessControlAllowOrigin + name: AccessControlAllowOrigin + signature: AccessControlAllowOrigin = 'Access-Control-Allow-Origin' +- uid: azure.cosmos.http_constants.HttpHeaders.ActivityId + name: ActivityId + signature: ActivityId = 'x-ms-activity-id' +- uid: azure.cosmos.http_constants.HttpHeaders.AllowTentativeWrites + name: AllowTentativeWrites + signature: AllowTentativeWrites = 'x-ms-cosmos-allow-tentative-writes' +- uid: azure.cosmos.http_constants.HttpHeaders.AlternateContentPath + name: AlternateContentPath + signature: AlternateContentPath = 'x-ms-alt-content-path' +- uid: azure.cosmos.http_constants.HttpHeaders.Authorization + name: Authorization + signature: Authorization = 'authorization' +- uid: azure.cosmos.http_constants.HttpHeaders.CacheControl + name: CacheControl + signature: CacheControl = 'Cache-Control' +- uid: azure.cosmos.http_constants.HttpHeaders.CharacterSet + name: CharacterSet + signature: CharacterSet = 'CharacterSet' +- uid: azure.cosmos.http_constants.HttpHeaders.CollectionCurrentUsageInMb + name: CollectionCurrentUsageInMb + signature: CollectionCurrentUsageInMb = 'x-ms-collection-usage-mb' +- uid: azure.cosmos.http_constants.HttpHeaders.CollectionPartitionInfo + name: CollectionPartitionInfo + signature: CollectionPartitionInfo = 'x-ms-collection-partition-info' +- uid: azure.cosmos.http_constants.HttpHeaders.CollectionQuotaInMb + name: CollectionQuotaInMb + signature: CollectionQuotaInMb = 'x-ms-collection-quota-mb' +- uid: azure.cosmos.http_constants.HttpHeaders.CollectionServiceInfo + name: CollectionServiceInfo + signature: CollectionServiceInfo = 'x-ms-collection-service-info' +- uid: azure.cosmos.http_constants.HttpHeaders.ConsistencyLevel + name: ConsistencyLevel + signature: ConsistencyLevel = 'x-ms-consistency-level' +- uid: azure.cosmos.http_constants.HttpHeaders.ContentEncoding + name: ContentEncoding + signature: ContentEncoding = 'Content-Encoding' +- uid: azure.cosmos.http_constants.HttpHeaders.ContentLanguage + name: ContentLanguage + signature: ContentLanguage = 'Content-Language' +- uid: azure.cosmos.http_constants.HttpHeaders.ContentLength + name: ContentLength + signature: ContentLength = 'Content-Length' +- uid: azure.cosmos.http_constants.HttpHeaders.ContentLocation + name: ContentLocation + signature: ContentLocation = 'Content-Location' +- uid: azure.cosmos.http_constants.HttpHeaders.ContentMd5 + name: ContentMd5 + signature: ContentMd5 = 'Content-Md5' +- uid: azure.cosmos.http_constants.HttpHeaders.ContentRange + name: ContentRange + signature: ContentRange = 'Content-Range' +- uid: azure.cosmos.http_constants.HttpHeaders.ContentType + name: ContentType + signature: ContentType = 'Content-Type' +- uid: azure.cosmos.http_constants.HttpHeaders.Continuation + name: Continuation + signature: Continuation = 'x-ms-continuation' +- uid: azure.cosmos.http_constants.HttpHeaders.CurrentEntityCount + name: CurrentEntityCount + signature: CurrentEntityCount = 'x-ms-root-entity-current-count' +- uid: azure.cosmos.http_constants.HttpHeaders.CurrentMediaStorageUsageInMB + name: CurrentMediaStorageUsageInMB + signature: CurrentMediaStorageUsageInMB = 'x-ms-media-storage-usage-mb' +- uid: azure.cosmos.http_constants.HttpHeaders.DisableRUPerMinuteUsage + name: DisableRUPerMinuteUsage + signature: DisableRUPerMinuteUsage = 'x-ms-documentdb-disable-ru-per-minute-usage' +- uid: azure.cosmos.http_constants.HttpHeaders.ETag + name: ETag + signature: ETag = 'etag' +- uid: azure.cosmos.http_constants.HttpHeaders.EmitVerboseTracesInQuery + name: EmitVerboseTracesInQuery + signature: EmitVerboseTracesInQuery = 'x-ms-documentdb-query-emit-traces' +- uid: azure.cosmos.http_constants.HttpHeaders.EnableCrossPartitionQuery + name: EnableCrossPartitionQuery + signature: EnableCrossPartitionQuery = 'x-ms-documentdb-query-enablecrosspartition' +- uid: azure.cosmos.http_constants.HttpHeaders.EnableScanInQuery + name: EnableScanInQuery + signature: EnableScanInQuery = 'x-ms-documentdb-query-enable-scan' +- uid: azure.cosmos.http_constants.HttpHeaders.EnableScriptLogging + name: EnableScriptLogging + signature: EnableScriptLogging = 'x-ms-documentdb-script-enable-logging' +- uid: azure.cosmos.http_constants.HttpHeaders.ForceRefresh + name: ForceRefresh + signature: ForceRefresh = 'x-ms-force-refresh' +- uid: azure.cosmos.http_constants.HttpHeaders.FullUpgrade + name: FullUpgrade + signature: FullUpgrade = 'x-ms-force-full-upgrade' +- uid: azure.cosmos.http_constants.HttpHeaders.Host + name: Host + signature: Host = 'Host' +- uid: azure.cosmos.http_constants.HttpHeaders.HttpDate + name: HttpDate + signature: HttpDate = 'date' +- uid: azure.cosmos.http_constants.HttpHeaders.IfMatch + name: IfMatch + signature: IfMatch = 'If-Match' +- uid: azure.cosmos.http_constants.HttpHeaders.IfModified_since + name: IfModified_since + signature: IfModified_since = 'If-Modified-Since' +- uid: azure.cosmos.http_constants.HttpHeaders.IfNoneMatch + name: IfNoneMatch + signature: IfNoneMatch = 'If-None-Match' +- uid: azure.cosmos.http_constants.HttpHeaders.IfRange + name: IfRange + signature: IfRange = 'If-Range' +- uid: azure.cosmos.http_constants.HttpHeaders.IfUnmodifiedSince + name: IfUnmodifiedSince + signature: IfUnmodifiedSince = 'If-Unmodified-Since' +- uid: azure.cosmos.http_constants.HttpHeaders.IgnoreInProgressUpgrade + name: IgnoreInProgressUpgrade + signature: IgnoreInProgressUpgrade = 'x-ms-ignore-inprogress-upgrade' +- uid: azure.cosmos.http_constants.HttpHeaders.IncrementalFeedHeaderValue + name: IncrementalFeedHeaderValue + signature: IncrementalFeedHeaderValue = 'Incremental feed' +- uid: azure.cosmos.http_constants.HttpHeaders.IndexTransformationProgress + name: IndexTransformationProgress + signature: IndexTransformationProgress = 'x-ms-documentdb-collection-index-transformation-progress' +- uid: azure.cosmos.http_constants.HttpHeaders.IndexingDirective + name: IndexingDirective + signature: IndexingDirective = 'x-ms-indexing-directive' +- uid: azure.cosmos.http_constants.HttpHeaders.IsCanary + name: IsCanary + signature: IsCanary = 'x-ms-iscanary' +- uid: azure.cosmos.http_constants.HttpHeaders.IsContinuationExpected + name: IsContinuationExpected + signature: IsContinuationExpected = 'x-ms-documentdb-query-iscontinuationexpected' +- uid: azure.cosmos.http_constants.HttpHeaders.IsFeedUnfiltered + name: IsFeedUnfiltered + signature: IsFeedUnfiltered = 'x-ms-is-feed-unfiltered' +- uid: azure.cosmos.http_constants.HttpHeaders.IsQuery + name: IsQuery + signature: IsQuery = 'x-ms-documentdb-isquery' +- uid: azure.cosmos.http_constants.HttpHeaders.IsRUPerMinuteUsed + name: IsRUPerMinuteUsed + signature: IsRUPerMinuteUsed = 'x-ms-documentdb-is-ru-per-minute-used' +- uid: azure.cosmos.http_constants.HttpHeaders.IsUpsert + name: IsUpsert + signature: IsUpsert = 'x-ms-documentdb-is-upsert' +- uid: azure.cosmos.http_constants.HttpHeaders.ItemCount + name: ItemCount + signature: ItemCount = 'x-ms-item-count' +- uid: azure.cosmos.http_constants.HttpHeaders.KeepAlive + name: KeepAlive + signature: KeepAlive = 'Keep-Alive' +- uid: azure.cosmos.http_constants.HttpHeaders.KeyValueEncodingFormat + name: KeyValueEncodingFormat + signature: KeyValueEncodingFormat = 'application/x-www-form-urlencoded' +- uid: azure.cosmos.http_constants.HttpHeaders.LastModified + name: LastModified + signature: LastModified = 'Last-Modified' +- uid: azure.cosmos.http_constants.HttpHeaders.LastStateChangeUtc + name: LastStateChangeUtc + signature: LastStateChangeUtc = 'x-ms-last-state-change-utc' +- uid: azure.cosmos.http_constants.HttpHeaders.LazyIndexingProgress + name: LazyIndexingProgress + signature: LazyIndexingProgress = 'x-ms-documentdb-collection-lazy-indexing-progress' +- uid: azure.cosmos.http_constants.HttpHeaders.Location + name: Location + signature: Location = 'Location' +- uid: azure.cosmos.http_constants.HttpHeaders.MaxEntityCount + name: MaxEntityCount + signature: MaxEntityCount = 'x-ms-root-entity-max-count' +- uid: azure.cosmos.http_constants.HttpHeaders.MaxForwards + name: MaxForwards + signature: MaxForwards = 'Max-Forwards' +- uid: azure.cosmos.http_constants.HttpHeaders.MaxMediaStorageUsageInMB + name: MaxMediaStorageUsageInMB + signature: MaxMediaStorageUsageInMB = 'x-ms-max-media-storage-usage-mb' +- uid: azure.cosmos.http_constants.HttpHeaders.MethodOverride + name: MethodOverride + signature: MethodOverride = 'X-HTTP-Method' +- uid: azure.cosmos.http_constants.HttpHeaders.NewResourceId + name: NewResourceId + signature: NewResourceId = 'x-ms-new-resource-id' +- uid: azure.cosmos.http_constants.HttpHeaders.OcpResourceProviderRegisteredUri + name: OcpResourceProviderRegisteredUri + signature: OcpResourceProviderRegisteredUri = 'ocp-resourceprovider-registered-uri' +- uid: azure.cosmos.http_constants.HttpHeaders.OfferIsRUPerMinuteThroughputEnabled + name: OfferIsRUPerMinuteThroughputEnabled + signature: OfferIsRUPerMinuteThroughputEnabled = 'x-ms-offer-is-ru-per-minute-throughput-enabled' +- uid: azure.cosmos.http_constants.HttpHeaders.OfferThroughput + name: OfferThroughput + signature: OfferThroughput = 'x-ms-offer-throughput' +- uid: azure.cosmos.http_constants.HttpHeaders.OfferType + name: OfferType + signature: OfferType = 'x-ms-offer-type' +- uid: azure.cosmos.http_constants.HttpHeaders.OnlyUpgradeNonSystemApplications + name: OnlyUpgradeNonSystemApplications + signature: OnlyUpgradeNonSystemApplications = 'x-ms-only-upgrade-non-system-applications' +- uid: azure.cosmos.http_constants.HttpHeaders.OnlyUpgradeSystemApplications + name: OnlyUpgradeSystemApplications + signature: OnlyUpgradeSystemApplications = 'x-ms-only-upgrade-system-applications' +- uid: azure.cosmos.http_constants.HttpHeaders.Origin + name: Origin + signature: Origin = 'Origin' +- uid: azure.cosmos.http_constants.HttpHeaders.PageSize + name: PageSize + signature: PageSize = 'x-ms-max-item-count' +- uid: azure.cosmos.http_constants.HttpHeaders.PartitionKey + name: PartitionKey + signature: PartitionKey = 'x-ms-documentdb-partitionkey' +- uid: azure.cosmos.http_constants.HttpHeaders.PartitionKeyRangeID + name: PartitionKeyRangeID + signature: PartitionKeyRangeID = 'x-ms-documentdb-partitionkeyrangeid' +- uid: azure.cosmos.http_constants.HttpHeaders.PopulatePartitionKeyRangeStatistics + name: PopulatePartitionKeyRangeStatistics + signature: PopulatePartitionKeyRangeStatistics = 'x-ms-documentdb-populatepartitionstatistics' +- uid: azure.cosmos.http_constants.HttpHeaders.PopulateQueryMetrics + name: PopulateQueryMetrics + signature: PopulateQueryMetrics = 'x-ms-documentdb-populatequerymetrics' +- uid: azure.cosmos.http_constants.HttpHeaders.PopulateQuotaInfo + name: PopulateQuotaInfo + signature: PopulateQuotaInfo = 'x-ms-documentdb-populatequotainfo' +- uid: azure.cosmos.http_constants.HttpHeaders.PostTriggerExclude + name: PostTriggerExclude + signature: PostTriggerExclude = 'x-ms-documentdb-post-trigger-exclude' +- uid: azure.cosmos.http_constants.HttpHeaders.PostTriggerInclude + name: PostTriggerInclude + signature: PostTriggerInclude = 'x-ms-documentdb-post-trigger-include' +- uid: azure.cosmos.http_constants.HttpHeaders.PreTriggerExclude + name: PreTriggerExclude + signature: PreTriggerExclude = 'x-ms-documentdb-pre-trigger-exclude' +- uid: azure.cosmos.http_constants.HttpHeaders.PreTriggerInclude + name: PreTriggerInclude + signature: PreTriggerInclude = 'x-ms-documentdb-pre-trigger-include' +- uid: azure.cosmos.http_constants.HttpHeaders.Prefer + name: Prefer + signature: Prefer = 'Prefer' +- uid: azure.cosmos.http_constants.HttpHeaders.ProxyAuthenticate + name: ProxyAuthenticate + signature: ProxyAuthenticate = 'Proxy-Authenticate' +- uid: azure.cosmos.http_constants.HttpHeaders.ProxyAuthorization + name: ProxyAuthorization + signature: ProxyAuthorization = 'Proxy-Authorization' +- uid: azure.cosmos.http_constants.HttpHeaders.Query + name: Query + signature: Query = 'x-ms-documentdb-query' +- uid: azure.cosmos.http_constants.HttpHeaders.Referer + name: Referer + signature: Referer = 'referer' +- uid: azure.cosmos.http_constants.HttpHeaders.RequestCharge + name: RequestCharge + signature: RequestCharge = 'x-ms-request-charge' +- uid: azure.cosmos.http_constants.HttpHeaders.RequestId + name: RequestId + signature: RequestId = 'x-ms-request-id' +- uid: azure.cosmos.http_constants.HttpHeaders.ResourceTokenExpiry + name: ResourceTokenExpiry + signature: ResourceTokenExpiry = 'x-ms-documentdb-expiry-seconds' +- uid: azure.cosmos.http_constants.HttpHeaders.RetryAfter + name: RetryAfter + signature: RetryAfter = 'Retry-After' +- uid: azure.cosmos.http_constants.HttpHeaders.RetryAfterInMilliseconds + name: RetryAfterInMilliseconds + signature: RetryAfterInMilliseconds = 'x-ms-retry-after-ms' +- uid: azure.cosmos.http_constants.HttpHeaders.ScriptLogResults + name: ScriptLogResults + signature: ScriptLogResults = 'x-ms-documentdb-script-log-results' +- uid: azure.cosmos.http_constants.HttpHeaders.SessionToken + name: SessionToken + signature: SessionToken = 'x-ms-session-token' +- uid: azure.cosmos.http_constants.HttpHeaders.SetCookie + name: SetCookie + signature: SetCookie = 'Set-Cookie' +- uid: azure.cosmos.http_constants.HttpHeaders.SimpleToken + name: SimpleToken + signature: SimpleToken = 'SWT' +- uid: azure.cosmos.http_constants.HttpHeaders.Slug + name: Slug + signature: Slug = 'Slug' +- uid: azure.cosmos.http_constants.HttpHeaders.SubStatus + name: SubStatus + signature: SubStatus = 'x-ms-substatus' +- uid: azure.cosmos.http_constants.HttpHeaders.ThrottleRetryCount + name: ThrottleRetryCount + signature: ThrottleRetryCount = 'x-ms-throttle-retry-count' +- uid: azure.cosmos.http_constants.HttpHeaders.ThrottleRetryWaitTimeInMs + name: ThrottleRetryWaitTimeInMs + signature: ThrottleRetryWaitTimeInMs = 'x-ms-throttle-retry-wait-time-ms' +- uid: azure.cosmos.http_constants.HttpHeaders.TransferEncoding + name: TransferEncoding + signature: TransferEncoding = 'Transfer-Encoding' +- uid: azure.cosmos.http_constants.HttpHeaders.UpgradeFabricRingCodeAndConfig + name: UpgradeFabricRingCodeAndConfig + signature: UpgradeFabricRingCodeAndConfig = 'x-ms-upgrade-fabric-code-config' +- uid: azure.cosmos.http_constants.HttpHeaders.UpgradeVerificationKind + name: UpgradeVerificationKind + signature: UpgradeVerificationKind = 'x-ms-upgrade-verification-kind' +- uid: azure.cosmos.http_constants.HttpHeaders.UseMasterCollectionResolver + name: UseMasterCollectionResolver + signature: UseMasterCollectionResolver = 'x-ms-use-master-collection-resolver' +- uid: azure.cosmos.http_constants.HttpHeaders.UserAgent + name: UserAgent + signature: UserAgent = 'User-Agent' +- uid: azure.cosmos.http_constants.HttpHeaders.Version + name: Version + signature: Version = 'x-ms-version' +- uid: azure.cosmos.http_constants.HttpHeaders.WrapAssertion + name: WrapAssertion + signature: WrapAssertion = 'wrap_assertion' +- uid: azure.cosmos.http_constants.HttpHeaders.WrapAssertionFormat + name: WrapAssertionFormat + signature: WrapAssertionFormat = 'wrap_assertion_format' +- uid: azure.cosmos.http_constants.HttpHeaders.WrapScope + name: WrapScope + signature: WrapScope = 'wrap_scope' +- uid: azure.cosmos.http_constants.HttpHeaders.WwwAuthenticate + name: WwwAuthenticate + signature: WwwAuthenticate = 'Www-Authenticate' +- uid: azure.cosmos.http_constants.HttpHeaders.XDate + name: XDate + signature: XDate = 'x-ms-date' diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpListenerErrorCodes.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpListenerErrorCodes.yml new file mode 100644 index 00000000..9e5281f6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpListenerErrorCodes.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonClass +uid: azure.cosmos.http_constants.HttpListenerErrorCodes +name: HttpListenerErrorCodes +fullName: azure.cosmos.http_constants.HttpListenerErrorCodes +module: azure.cosmos.http_constants +summary: Constants of http listener error codes. +constructor: + syntax: HttpListenerErrorCodes() +attributes: +- uid: azure.cosmos.http_constants.HttpListenerErrorCodes.ERROR_CONNECTION_INVALID + name: ERROR_CONNECTION_INVALID + signature: ERROR_CONNECTION_INVALID = 1229 +- uid: azure.cosmos.http_constants.HttpListenerErrorCodes.ERROR_OPERATION_ABORTED + name: ERROR_OPERATION_ABORTED + signature: ERROR_OPERATION_ABORTED = 995 diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpMethods.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpMethods.yml new file mode 100644 index 00000000..c416dae9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpMethods.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.cosmos.http_constants.HttpMethods +name: HttpMethods +fullName: azure.cosmos.http_constants.HttpMethods +module: azure.cosmos.http_constants +summary: Constants of http methods. +constructor: + syntax: HttpMethods() +attributes: +- uid: azure.cosmos.http_constants.HttpMethods.Delete + name: Delete + signature: Delete = 'DELETE' +- uid: azure.cosmos.http_constants.HttpMethods.Get + name: Get + signature: Get = 'GET' +- uid: azure.cosmos.http_constants.HttpMethods.Head + name: Head + signature: Head = 'HEAD' +- uid: azure.cosmos.http_constants.HttpMethods.Options + name: Options + signature: Options = 'OPTIONS' +- uid: azure.cosmos.http_constants.HttpMethods.Post + name: Post + signature: Post = 'POST' +- uid: azure.cosmos.http_constants.HttpMethods.Put + name: Put + signature: Put = 'PUT' diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpStatusDescriptions.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpStatusDescriptions.yml new file mode 100644 index 00000000..e87ad44e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.HttpStatusDescriptions.yml @@ -0,0 +1,81 @@ +### YamlMime:PythonClass +uid: azure.cosmos.http_constants.HttpStatusDescriptions +name: HttpStatusDescriptions +fullName: azure.cosmos.http_constants.HttpStatusDescriptions +module: azure.cosmos.http_constants +summary: Constants of http status descriptions. +constructor: + syntax: HttpStatusDescriptions() +attributes: +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.Accepted + name: Accepted + signature: Accepted = 'Accepted' +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.BadGateway + name: BadGateway + signature: BadGateway = 'Bad Gateway' +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.BadRequest + name: BadRequest + signature: BadRequest = 'Bad Request' +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.Conflict + name: Conflict + signature: Conflict = 'Conflict' +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.Created + name: Created + signature: Created = 'Created' +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.Forbidden + name: Forbidden + signature: Forbidden = 'Forbidden' +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.GatewayTimeout + name: GatewayTimeout + signature: GatewayTimeout = 'Gateway timed out' +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.Gone + name: Gone + signature: Gone = 'Gone' +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.InternalServerError + name: InternalServerError + signature: InternalServerError = 'Internal Server Error' +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.LengthRequired + name: LengthRequired + signature: LengthRequired = 'Length Required' +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.MethodNotAllowed + name: MethodNotAllowed + signature: MethodNotAllowed = 'MethodNotAllowed' +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.NoContent + name: NoContent + signature: NoContent = 'No Content' +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.NotAcceptable + name: NotAcceptable + signature: NotAcceptable = 'Not Acceptable' +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.NotFound + name: NotFound + signature: NotFound = 'Not Found' +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.NotModified + name: NotModified + signature: NotModified = 'Not Modified' +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.OK + name: OK + signature: OK = 'Ok' +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.PreconditionFailed + name: PreconditionFailed + signature: PreconditionFailed = 'Precondition Failed' +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.RequestEntityTooLarge + name: RequestEntityTooLarge + signature: RequestEntityTooLarge = 'Request Entity Too Large' +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.RequestTimeout + name: RequestTimeout + signature: RequestTimeout = 'Request timed out' +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.RetryWith + name: RetryWith + signature: RetryWith = 'Retry the request' +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.ServiceUnavailable + name: ServiceUnavailable + signature: ServiceUnavailable = 'Service Unavailable' +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.TooManyRequests + name: TooManyRequests + signature: TooManyRequests = 'Too Many Requests' +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.Unauthorized + name: Unauthorized + signature: Unauthorized = 'Unauthorized' +- uid: azure.cosmos.http_constants.HttpStatusDescriptions.UnsupportedMediaType + name: UnsupportedMediaType + signature: UnsupportedMediaType = 'Unsupported Media Type' diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.QueryStrings.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.QueryStrings.yml new file mode 100644 index 00000000..2bbfeec9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.QueryStrings.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.cosmos.http_constants.QueryStrings +name: QueryStrings +fullName: azure.cosmos.http_constants.QueryStrings +module: azure.cosmos.http_constants +summary: Constants of query strings. +constructor: + syntax: QueryStrings() +attributes: +- uid: azure.cosmos.http_constants.QueryStrings.ContentView + name: ContentView + signature: ContentView = 'contentview' +- uid: azure.cosmos.http_constants.QueryStrings.Filter + name: Filter + signature: Filter = '$filter' +- uid: azure.cosmos.http_constants.QueryStrings.GenerateId + name: GenerateId + signature: GenerateId = '$generateFor' +- uid: azure.cosmos.http_constants.QueryStrings.GenerateIdBatchSize + name: GenerateIdBatchSize + signature: GenerateIdBatchSize = '$batchSize' +- uid: azure.cosmos.http_constants.QueryStrings.Generic + name: Generic + signature: Generic = 'generic' +- uid: azure.cosmos.http_constants.QueryStrings.GetChildResourcePartitions + name: GetChildResourcePartitions + signature: GetChildResourcePartitions = '$getChildResourcePartitions' +- uid: azure.cosmos.http_constants.QueryStrings.Query + name: Query + signature: Query = 'query' +- uid: azure.cosmos.http_constants.QueryStrings.RootIndex + name: RootIndex + signature: RootIndex = '$rootIndex' +- uid: azure.cosmos.http_constants.QueryStrings.SQLQueryType + name: SQLQueryType + signature: SQLQueryType = 'sql' +- uid: azure.cosmos.http_constants.QueryStrings.Url + name: Url + signature: Url = '$resolveFor' diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.ResourceType.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.ResourceType.yml new file mode 100644 index 00000000..030e63a2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.ResourceType.yml @@ -0,0 +1,64 @@ +### YamlMime:PythonClass +uid: azure.cosmos.http_constants.ResourceType +name: ResourceType +fullName: azure.cosmos.http_constants.ResourceType +module: azure.cosmos.http_constants +summary: Types of resources in Azure Cosmos +constructor: + syntax: ResourceType() +methods: +- uid: azure.cosmos.http_constants.ResourceType.IsCollectionChild + name: IsCollectionChild + signature: static IsCollectionChild(resourceType) + parameters: + - name: resourceType + isRequired: true +attributes: +- uid: azure.cosmos.http_constants.ResourceType.Attachment + name: Attachment + signature: Attachment = 'attachments' +- uid: azure.cosmos.http_constants.ResourceType.Collection + name: Collection + signature: Collection = 'colls' +- uid: azure.cosmos.http_constants.ResourceType.Conflict + name: Conflict + signature: Conflict = 'conflicts' +- uid: azure.cosmos.http_constants.ResourceType.Database + name: Database + signature: Database = 'dbs' +- uid: azure.cosmos.http_constants.ResourceType.DatabaseAccount + name: DatabaseAccount + signature: DatabaseAccount = 'databaseaccount' +- uid: azure.cosmos.http_constants.ResourceType.Document + name: Document + signature: Document = 'docs' +- uid: azure.cosmos.http_constants.ResourceType.Media + name: Media + signature: Media = 'media' +- uid: azure.cosmos.http_constants.ResourceType.Offer + name: Offer + signature: Offer = 'offers' +- uid: azure.cosmos.http_constants.ResourceType.PartitionKeyRange + name: PartitionKeyRange + signature: PartitionKeyRange = 'pkranges' +- uid: azure.cosmos.http_constants.ResourceType.Permission + name: Permission + signature: Permission = 'permissions' +- uid: azure.cosmos.http_constants.ResourceType.Schema + name: Schema + signature: Schema = 'schemas' +- uid: azure.cosmos.http_constants.ResourceType.StoredProcedure + name: StoredProcedure + signature: StoredProcedure = 'sprocs' +- uid: azure.cosmos.http_constants.ResourceType.Topology + name: Topology + signature: Topology = 'topology' +- uid: azure.cosmos.http_constants.ResourceType.Trigger + name: Trigger + signature: Trigger = 'triggers' +- uid: azure.cosmos.http_constants.ResourceType.User + name: User + signature: User = 'users' +- uid: azure.cosmos.http_constants.ResourceType.UserDefinedFunction + name: UserDefinedFunction + signature: UserDefinedFunction = 'udfs' diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.StatusCodes.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.StatusCodes.yml new file mode 100644 index 00000000..ea5b9325 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.StatusCodes.yml @@ -0,0 +1,72 @@ +### YamlMime:PythonClass +uid: azure.cosmos.http_constants.StatusCodes +name: StatusCodes +fullName: azure.cosmos.http_constants.StatusCodes +module: azure.cosmos.http_constants +summary: HTTP status codes returned by the REST operations +constructor: + syntax: StatusCodes() +attributes: +- uid: azure.cosmos.http_constants.StatusCodes.ACCEPTED + name: ACCEPTED + signature: ACCEPTED = 202 +- uid: azure.cosmos.http_constants.StatusCodes.BAD_REQUEST + name: BAD_REQUEST + signature: BAD_REQUEST = 400 +- uid: azure.cosmos.http_constants.StatusCodes.CONFLICT + name: CONFLICT + signature: CONFLICT = 409 +- uid: azure.cosmos.http_constants.StatusCodes.CREATED + name: CREATED + signature: CREATED = 201 +- uid: azure.cosmos.http_constants.StatusCodes.FORBIDDEN + name: FORBIDDEN + signature: FORBIDDEN = 403 +- uid: azure.cosmos.http_constants.StatusCodes.GONE + name: GONE + signature: GONE = 410 +- uid: azure.cosmos.http_constants.StatusCodes.INTERNAL_SERVER_ERROR + name: INTERNAL_SERVER_ERROR + signature: INTERNAL_SERVER_ERROR = 500 +- uid: azure.cosmos.http_constants.StatusCodes.METHOD_NOT_ALLOWED + name: METHOD_NOT_ALLOWED + signature: METHOD_NOT_ALLOWED = 405 +- uid: azure.cosmos.http_constants.StatusCodes.NOT_FOUND + name: NOT_FOUND + signature: NOT_FOUND = 404 +- uid: azure.cosmos.http_constants.StatusCodes.NOT_MODIFIED + name: NOT_MODIFIED + signature: NOT_MODIFIED = 304 +- uid: azure.cosmos.http_constants.StatusCodes.NO_CONTENT + name: NO_CONTENT + signature: NO_CONTENT = 204 +- uid: azure.cosmos.http_constants.StatusCodes.OK + name: OK + signature: OK = 200 +- uid: azure.cosmos.http_constants.StatusCodes.OPERATION_CANCELLED + name: OPERATION_CANCELLED + signature: OPERATION_CANCELLED = 1201 +- uid: azure.cosmos.http_constants.StatusCodes.OPERATION_PAUSED + name: OPERATION_PAUSED + signature: OPERATION_PAUSED = 1200 +- uid: azure.cosmos.http_constants.StatusCodes.PRECONDITION_FAILED + name: PRECONDITION_FAILED + signature: PRECONDITION_FAILED = 412 +- uid: azure.cosmos.http_constants.StatusCodes.REQUEST_ENTITY_TOO_LARGE + name: REQUEST_ENTITY_TOO_LARGE + signature: REQUEST_ENTITY_TOO_LARGE = 413 +- uid: azure.cosmos.http_constants.StatusCodes.REQUEST_TIMEOUT + name: REQUEST_TIMEOUT + signature: REQUEST_TIMEOUT = 408 +- uid: azure.cosmos.http_constants.StatusCodes.RETRY_WITH + name: RETRY_WITH + signature: RETRY_WITH = 449 +- uid: azure.cosmos.http_constants.StatusCodes.SERVICE_UNAVAILABLE + name: SERVICE_UNAVAILABLE + signature: SERVICE_UNAVAILABLE = 503 +- uid: azure.cosmos.http_constants.StatusCodes.TOO_MANY_REQUESTS + name: TOO_MANY_REQUESTS + signature: TOO_MANY_REQUESTS = 429 +- uid: azure.cosmos.http_constants.StatusCodes.UNAUTHORIZED + name: UNAUTHORIZED + signature: UNAUTHORIZED = 401 diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.SubStatusCodes.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.SubStatusCodes.yml new file mode 100644 index 00000000..c731f67f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.SubStatusCodes.yml @@ -0,0 +1,61 @@ +### YamlMime:PythonClass +uid: azure.cosmos.http_constants.SubStatusCodes +name: SubStatusCodes +fullName: azure.cosmos.http_constants.SubStatusCodes +module: azure.cosmos.http_constants +summary: Sub status codes returned by the REST operations specifying the details of + the operation +constructor: + syntax: SubStatusCodes() +attributes: +- uid: azure.cosmos.http_constants.SubStatusCodes.COMPLETING_PARTITION_MIGRATION + name: COMPLETING_PARTITION_MIGRATION + signature: COMPLETING_PARTITION_MIGRATION = 1008 +- uid: azure.cosmos.http_constants.SubStatusCodes.COMPLETING_SPLIT + name: COMPLETING_SPLIT + signature: COMPLETING_SPLIT = 1007 +- uid: azure.cosmos.http_constants.SubStatusCodes.CONFLICT_WITH_CONTROL_PLANE + name: CONFLICT_WITH_CONTROL_PLANE + signature: CONFLICT_WITH_CONTROL_PLANE = 1006 +- uid: azure.cosmos.http_constants.SubStatusCodes.CROSS_PARTITION_QUERY_NOT_SERVABLE + name: CROSS_PARTITION_QUERY_NOT_SERVABLE + signature: CROSS_PARTITION_QUERY_NOT_SERVABLE = 1004 +- uid: azure.cosmos.http_constants.SubStatusCodes.DATABASE_ACCOUNT_NOT_FOUND + name: DATABASE_ACCOUNT_NOT_FOUND + signature: DATABASE_ACCOUNT_NOT_FOUND = 1008 +- uid: azure.cosmos.http_constants.SubStatusCodes.INSUFFICIENT_BINDABLE_PARTITIONS + name: INSUFFICIENT_BINDABLE_PARTITIONS + signature: INSUFFICIENT_BINDABLE_PARTITIONS = 1007 +- uid: azure.cosmos.http_constants.SubStatusCodes.NAME_CACHE_IS_STALE + name: NAME_CACHE_IS_STALE + signature: NAME_CACHE_IS_STALE = 1000 +- uid: azure.cosmos.http_constants.SubStatusCodes.OWNER_RESOURCE_NOT_FOUND + name: OWNER_RESOURCE_NOT_FOUND + signature: OWNER_RESOURCE_NOT_FOUND = 1003 +- uid: azure.cosmos.http_constants.SubStatusCodes.PARTITION_KEY_MISMATCH + name: PARTITION_KEY_MISMATCH + signature: PARTITION_KEY_MISMATCH = 1001 +- uid: azure.cosmos.http_constants.SubStatusCodes.PARTITION_KEY_RANGE_GONE + name: PARTITION_KEY_RANGE_GONE + signature: PARTITION_KEY_RANGE_GONE = 1002 +- uid: azure.cosmos.http_constants.SubStatusCodes.PROVISION_LIMIT_REACHED + name: PROVISION_LIMIT_REACHED + signature: PROVISION_LIMIT_REACHED = 1005 +- uid: azure.cosmos.http_constants.SubStatusCodes.READ_SESSION_NOTAVAILABLE + name: READ_SESSION_NOTAVAILABLE + signature: READ_SESSION_NOTAVAILABLE = 1002 +- uid: azure.cosmos.http_constants.SubStatusCodes.REDUNDANT_COLLECTION_PUT + name: REDUNDANT_COLLECTION_PUT + signature: REDUNDANT_COLLECTION_PUT = 1009 +- uid: azure.cosmos.http_constants.SubStatusCodes.SHARED_THROUGHPUT_DATABASE_QUOTA_EXCEEDED + name: SHARED_THROUGHPUT_DATABASE_QUOTA_EXCEEDED + signature: SHARED_THROUGHPUT_DATABASE_QUOTA_EXCEEDED = 1010 +- uid: azure.cosmos.http_constants.SubStatusCodes.SHARED_THROUGHPUT_OFFER_GROW_NOT_NEEDED + name: SHARED_THROUGHPUT_OFFER_GROW_NOT_NEEDED + signature: SHARED_THROUGHPUT_OFFER_GROW_NOT_NEEDED = 1011 +- uid: azure.cosmos.http_constants.SubStatusCodes.UNKNOWN + name: UNKNOWN + signature: UNKNOWN = 0 +- uid: azure.cosmos.http_constants.SubStatusCodes.WRITE_FORBIDDEN + name: WRITE_FORBIDDEN + signature: WRITE_FORBIDDEN = 3 diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.Versions.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.Versions.yml new file mode 100644 index 00000000..84ba9c3e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.Versions.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.cosmos.http_constants.Versions +name: Versions +fullName: azure.cosmos.http_constants.Versions +module: azure.cosmos.http_constants +summary: Constants of versions. +constructor: + syntax: Versions() +attributes: +- uid: azure.cosmos.http_constants.Versions.CurrentVersion + name: CurrentVersion + signature: CurrentVersion = '2018-09-17' +- uid: azure.cosmos.http_constants.Versions.SDKName + name: SDKName + signature: SDKName = 'azure-cosmos' +- uid: azure.cosmos.http_constants.Versions.SDKVersion + name: SDKVersion + signature: SDKVersion = '3.1.2' diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.yml new file mode 100644 index 00000000..231c86b1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.http_constants.yml @@ -0,0 +1,19 @@ +### YamlMime:PythonModule +uid: azure.cosmos.http_constants +name: http_constants +fullName: azure.cosmos.http_constants +summary: HTTP Constants in the Azure Cosmos database service. +classes: +- azure.cosmos.http_constants.CookieHeaders +- azure.cosmos.http_constants.Delimiters +- azure.cosmos.http_constants.HttpContextProperties +- azure.cosmos.http_constants.HttpHeaderPreferenceTokens +- azure.cosmos.http_constants.HttpHeaders +- azure.cosmos.http_constants.HttpListenerErrorCodes +- azure.cosmos.http_constants.HttpMethods +- azure.cosmos.http_constants.HttpStatusDescriptions +- azure.cosmos.http_constants.QueryStrings +- azure.cosmos.http_constants.ResourceType +- azure.cosmos.http_constants.StatusCodes +- azure.cosmos.http_constants.SubStatusCodes +- azure.cosmos.http_constants.Versions diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.location_cache.EndpointOperationType.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.location_cache.EndpointOperationType.yml new file mode 100644 index 00000000..91533292 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.location_cache.EndpointOperationType.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.cosmos.location_cache.EndpointOperationType +name: EndpointOperationType +fullName: azure.cosmos.location_cache.EndpointOperationType +module: azure.cosmos.location_cache +constructor: + syntax: EndpointOperationType() +attributes: +- uid: azure.cosmos.location_cache.EndpointOperationType.NoneType + name: NoneType + signature: NoneType = 'None' +- uid: azure.cosmos.location_cache.EndpointOperationType.ReadType + name: ReadType + signature: ReadType = 'Read' +- uid: azure.cosmos.location_cache.EndpointOperationType.WriteType + name: WriteType + signature: WriteType = 'Write' diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.location_cache.LocationCache.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.location_cache.LocationCache.yml new file mode 100644 index 00000000..7b0624bc --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.location_cache.LocationCache.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.cosmos.location_cache.LocationCache +name: LocationCache +fullName: azure.cosmos.location_cache.LocationCache +module: azure.cosmos.location_cache +constructor: + syntax: LocationCache(preferred_locations, default_endpoint, enable_endpoint_discovery, + use_multiple_write_locations, refresh_time_interval_in_ms) + parameters: + - name: preferred_locations + isRequired: true + - name: default_endpoint + isRequired: true + - name: enable_endpoint_discovery + isRequired: true + - name: use_multiple_write_locations + isRequired: true + - name: refresh_time_interval_in_ms + isRequired: true +methods: +- uid: azure.cosmos.location_cache.LocationCache.can_use_multiple_write_locations + name: can_use_multiple_write_locations + signature: can_use_multiple_write_locations() +- uid: azure.cosmos.location_cache.LocationCache.can_use_multiple_write_locations_for_request + name: can_use_multiple_write_locations_for_request + signature: can_use_multiple_write_locations_for_request(request) + parameters: + - name: request + isRequired: true +- uid: azure.cosmos.location_cache.LocationCache.check_and_update_cache + name: check_and_update_cache + signature: check_and_update_cache() +- uid: azure.cosmos.location_cache.LocationCache.clear_stale_endpoint_unavailability_info + name: clear_stale_endpoint_unavailability_info + signature: clear_stale_endpoint_unavailability_info() +- uid: azure.cosmos.location_cache.LocationCache.current_time_millis + name: current_time_millis + signature: current_time_millis() +- uid: azure.cosmos.location_cache.LocationCache.get_endpoint_by_location + name: get_endpoint_by_location + signature: get_endpoint_by_location(locations) + parameters: + - name: locations + isRequired: true +- uid: azure.cosmos.location_cache.LocationCache.get_ordered_read_endpoints + name: get_ordered_read_endpoints + signature: get_ordered_read_endpoints() +- uid: azure.cosmos.location_cache.LocationCache.get_ordered_write_endpoints + name: get_ordered_write_endpoints + signature: get_ordered_write_endpoints() +- uid: azure.cosmos.location_cache.LocationCache.get_preferred_available_endpoints + name: get_preferred_available_endpoints + signature: get_preferred_available_endpoints(endpoints_by_location, orderedLocations, + expected_available_operation, fallback_endpoint) + parameters: + - name: endpoints_by_location + isRequired: true + - name: orderedLocations + isRequired: true + - name: expected_available_operation + isRequired: true + - name: fallback_endpoint + isRequired: true +- uid: azure.cosmos.location_cache.LocationCache.get_preferred_locations + name: get_preferred_locations + signature: get_preferred_locations() +- uid: azure.cosmos.location_cache.LocationCache.get_read_endpoint + name: get_read_endpoint + signature: get_read_endpoint() +- uid: azure.cosmos.location_cache.LocationCache.get_read_endpoints + name: get_read_endpoints + signature: get_read_endpoints() +- uid: azure.cosmos.location_cache.LocationCache.get_write_endpoint + name: get_write_endpoint + signature: get_write_endpoint() +- uid: azure.cosmos.location_cache.LocationCache.get_write_endpoints + name: get_write_endpoints + signature: get_write_endpoints() +- uid: azure.cosmos.location_cache.LocationCache.is_endpoint_unavailable + name: is_endpoint_unavailable + signature: is_endpoint_unavailable(endpoint, expected_available_operations) + parameters: + - name: endpoint + isRequired: true + - name: expected_available_operations + isRequired: true +- uid: azure.cosmos.location_cache.LocationCache.mark_endpoint_unavailable + name: mark_endpoint_unavailable + signature: mark_endpoint_unavailable(unavailable_endpoint, unavailable_operation_type) + parameters: + - name: unavailable_endpoint + isRequired: true + - name: unavailable_operation_type + isRequired: true +- uid: azure.cosmos.location_cache.LocationCache.mark_endpoint_unavailable_for_read + name: mark_endpoint_unavailable_for_read + signature: mark_endpoint_unavailable_for_read(endpoint) + parameters: + - name: endpoint + isRequired: true +- uid: azure.cosmos.location_cache.LocationCache.mark_endpoint_unavailable_for_write + name: mark_endpoint_unavailable_for_write + signature: mark_endpoint_unavailable_for_write(endpoint) + parameters: + - name: endpoint + isRequired: true +- uid: azure.cosmos.location_cache.LocationCache.perform_on_database_account_read + name: perform_on_database_account_read + signature: perform_on_database_account_read(database_account) + parameters: + - name: database_account + isRequired: true +- uid: azure.cosmos.location_cache.LocationCache.resolve_service_endpoint + name: resolve_service_endpoint + signature: resolve_service_endpoint(request) + parameters: + - name: request + isRequired: true +- uid: azure.cosmos.location_cache.LocationCache.should_refresh_endpoints + name: should_refresh_endpoints + signature: should_refresh_endpoints() +- uid: azure.cosmos.location_cache.LocationCache.update_location_cache + name: update_location_cache + signature: update_location_cache(write_locations=None, read_locations=None, enable_multiple_writable_locations=None) + parameters: + - name: write_locations + defaultValue: None + - name: read_locations + defaultValue: None + - name: enable_multiple_writable_locations + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.location_cache.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.location_cache.yml new file mode 100644 index 00000000..5ba90a0e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.location_cache.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonModule +uid: azure.cosmos.location_cache +name: location_cache +fullName: azure.cosmos.location_cache +summary: 'Implements the abstraction to resolve target location for geo-replicated + DatabaseAccount + + with multiple writable and readable locations.' +classes: +- azure.cosmos.location_cache.EndpointOperationType +- azure.cosmos.location_cache.LocationCache diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.murmur_hash.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.murmur_hash.yml new file mode 100644 index 00000000..173332d4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.murmur_hash.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cosmos.murmur_hash +name: murmur_hash +fullName: azure.cosmos.murmur_hash +summary: Internal class for Murmur hash implementation in the Azure Cosmos database + service. diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.partition.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.partition.yml new file mode 100644 index 00000000..6c2b0e09 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.partition.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cosmos.partition +name: partition +fullName: azure.cosmos.partition +summary: Internal class for client side partition implementation in the Azure Cosmos + database service. diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.query_iterable.QueryIterable.Iterator.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.query_iterable.QueryIterable.Iterator.yml new file mode 100644 index 00000000..c8780dd4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.query_iterable.QueryIterable.Iterator.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonClass +uid: azure.cosmos.query_iterable.QueryIterable.Iterator +name: Iterator +fullName: azure.cosmos.query_iterable.QueryIterable.Iterator +module: azure.cosmos.query_iterable.QueryIterable +constructor: + syntax: Iterator(iterable) + parameters: + - name: iterable + isRequired: true +methods: +- uid: azure.cosmos.query_iterable.QueryIterable.Iterator.next + name: next + signature: next() diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.query_iterable.QueryIterable.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.query_iterable.QueryIterable.yml new file mode 100644 index 00000000..38a0b05e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.query_iterable.QueryIterable.yml @@ -0,0 +1,103 @@ +### YamlMime:PythonClass +uid: azure.cosmos.query_iterable.QueryIterable +name: QueryIterable +fullName: azure.cosmos.query_iterable.QueryIterable +module: azure.cosmos.query_iterable +summary: 'Represents an iterable object of the query results. + + QueryIterable is a wrapper for query execution context. + + + Instantiates a QueryIterable for non-client side partitioning queries. + + _ProxyQueryExecutionContext will be used as the internal query execution context + + + Example of *fetch_function*: + + + ``` + + + >>> def result_fn(result): + + >>> return result[''Databases''] + + ```' +constructor: + syntax: QueryIterable(client, query, options, fetch_function, collection_link=None) + parameters: + - name: client + description: Instance of document client. + isRequired: true + types: + - + - name: query + isRequired: true + types: + - ( + - ) + - name: options + description: The request options for the request. + isRequired: true + types: + - + - name: fetch_function + isRequired: true + types: + - + - name: collection_link + description: If this is a Document query/feed collection_link is required. + defaultValue: None + types: + - +methods: +- uid: azure.cosmos.query_iterable.QueryIterable.PartitioningQueryIterable + name: PartitioningQueryIterable + summary: 'Represents a client side partitioning query iterable. + + + This constructor instantiates a QueryIterable for + + client side partitioning queries, and sets _MultiCollectionQueryExecutionContext + + as the internal execution context.' + signature: PartitioningQueryIterable(client, query, options, database_link, partition_key) + parameters: + - name: client + description: Instance of document client + isRequired: true + types: + - + - name: options + isRequired: true + types: + - + - name: options + description: The request options for the request. + isRequired: true + - name: database_link + description: Database self link or ID based link + isRequired: true + types: + - + - name: partition_key + description: Partition key for the query + isRequired: true + types: + - + - name: query + isRequired: true +- uid: azure.cosmos.query_iterable.QueryIterable.fetch_next_block + name: fetch_next_block + summary: 'Returns a block of results with respecting retry policy. + + + This method only exists for backward compatibility reasons. (Because QueryIterable + + has exposed fetch_next_block api).' + signature: fetch_next_block() + return: + description: List of results. + types: + - diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.query_iterable.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.query_iterable.yml new file mode 100644 index 00000000..a77bc42f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.query_iterable.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.cosmos.query_iterable +name: query_iterable +fullName: azure.cosmos.query_iterable +summary: Iterable query results in the Azure Cosmos database service. +classes: +- azure.cosmos.query_iterable.QueryIterable diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.range.Range.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.range.Range.yml new file mode 100644 index 00000000..b6b7f0df --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.range.Range.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.cosmos.range.Range +name: Range +fullName: azure.cosmos.range.Range +module: azure.cosmos.range +summary: Represents the Range class used to map the partition key of the document + to their associated collection. +constructor: + syntax: Range(low, high) + parameters: + - name: low + isRequired: true + - name: high + isRequired: true +methods: +- uid: azure.cosmos.range.Range.Contains + name: Contains + summary: Checks if the passed parameter is in the range of this object. + signature: Contains(other) + parameters: + - name: other + isRequired: true +- uid: azure.cosmos.range.Range.Intersect + name: Intersect + summary: Checks if the passed parameter intersects the range of this object. + signature: Intersect(other) + parameters: + - name: other + isRequired: true diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.range.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.range.yml new file mode 100644 index 00000000..32a753ca --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.range.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.cosmos.range +name: range +fullName: azure.cosmos.range +summary: Range class implementation in the Azure Cosmos database service. +classes: +- azure.cosmos.range.Range diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.range_partition_resolver.RangePartitionResolver.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.range_partition_resolver.RangePartitionResolver.yml new file mode 100644 index 00000000..8c9cd28e --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.range_partition_resolver.RangePartitionResolver.yml @@ -0,0 +1,57 @@ +### YamlMime:PythonClass +uid: azure.cosmos.range_partition_resolver.RangePartitionResolver +name: RangePartitionResolver +fullName: azure.cosmos.range_partition_resolver.RangePartitionResolver +module: azure.cosmos.range_partition_resolver +summary: 'RangePartitionResolver implements partitioning based on the ranges, allowing + you to + + distribute requests and data across a number of partitions.' +constructor: + syntax: RangePartitionResolver(partition_key_extractor, partition_map) + parameters: + - name: partition_key_extractor + description: Returning the partition key from the document passed. + isRequired: true + types: + - + - name: partition_map + description: The dictionary of ranges mapped to their associated collection + isRequired: true + types: + - +methods: +- uid: azure.cosmos.range_partition_resolver.RangePartitionResolver.ResolveForCreate + name: ResolveForCreate + summary: Resolves the collection for creating the document based on the partition + key. + signature: ResolveForCreate(document) + parameters: + - name: document + description: The document to be created. + isRequired: true + types: + - + return: + description: Collection Self link or Name based link which should handle the Create + operation. + types: + - +- uid: azure.cosmos.range_partition_resolver.RangePartitionResolver.ResolveForRead + name: ResolveForRead + summary: Resolves the collection for reading/querying the documents based on the + partition key. + signature: ResolveForRead(partition_key) + parameters: + - name: document + description: The document to be read/queried. + isRequired: true + types: + - + - name: partition_key + isRequired: true + return: + description: Collection Self link(s) or Name based link(s) which should handle + the Read operation. + types: + - diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.range_partition_resolver.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.range_partition_resolver.yml new file mode 100644 index 00000000..d0d420ac --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.range_partition_resolver.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.cosmos.range_partition_resolver +name: range_partition_resolver +fullName: azure.cosmos.range_partition_resolver +summary: Range partition resolver implementation in the Azure Cosmos database service. +classes: +- azure.cosmos.range_partition_resolver.RangePartitionResolver diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.request_object.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.request_object.yml new file mode 100644 index 00000000..24e5e57c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.request_object.yml @@ -0,0 +1,5 @@ +### YamlMime:PythonModule +uid: azure.cosmos.request_object +name: request_object +fullName: azure.cosmos.request_object +summary: Represents a request object. diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.resource_throttle_retry_policy.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.resource_throttle_retry_policy.yml new file mode 100644 index 00000000..f028401f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.resource_throttle_retry_policy.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cosmos.resource_throttle_retry_policy +name: resource_throttle_retry_policy +fullName: azure.cosmos.resource_throttle_retry_policy +summary: Internal class for resource throttle retry policy implementation in the Azure + Cosmos database service. diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.retry_options.RetryOptions.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.retry_options.RetryOptions.yml new file mode 100644 index 00000000..08faecc4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.retry_options.RetryOptions.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.cosmos.retry_options.RetryOptions +name: RetryOptions +fullName: azure.cosmos.retry_options.RetryOptions +module: azure.cosmos.retry_options +summary: The retry options to be applied to all requests when retrying +constructor: + syntax: RetryOptions(max_retry_attempt_count=9, fixed_retry_interval_in_milliseconds=None, + max_wait_time_in_seconds=30) + parameters: + - name: max_retry_attempt_count + defaultValue: '9' + - name: fixed_retry_interval_in_milliseconds + defaultValue: None + - name: max_wait_time_in_seconds + defaultValue: '30' +variables: +- description: Max number of retries to be performed for a request. Default value + 9. + name: MaxRetryAttemptCount + types: + - +- description: Fixed retry interval in milliseconds to wait between each retry ignoring + the retryAfter returned as part of the response. + name: FixedRetryIntervalInMilliseconds + types: + - +- description: Max wait time in seconds to wait for a request while the retries are + happening. Default value 30 seconds. + name: MaxWaitTimeInSeconds + types: + - +attributes: +- uid: azure.cosmos.retry_options.RetryOptions.FixedRetryIntervalInMilliseconds + name: FixedRetryIntervalInMilliseconds +- uid: azure.cosmos.retry_options.RetryOptions.MaxRetryAttemptCount + name: MaxRetryAttemptCount +- uid: azure.cosmos.retry_options.RetryOptions.MaxWaitTimeInSeconds + name: MaxWaitTimeInSeconds diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.retry_options.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.retry_options.yml new file mode 100644 index 00000000..5d3f459a --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.retry_options.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.cosmos.retry_options +name: retry_options +fullName: azure.cosmos.retry_options +summary: Class for retry options in the Azure Cosmos database service. +classes: +- azure.cosmos.retry_options.RetryOptions diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.retry_utility.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.retry_utility.yml new file mode 100644 index 00000000..814b1acb --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.retry_utility.yml @@ -0,0 +1,5 @@ +### YamlMime:PythonModule +uid: azure.cosmos.retry_utility +name: retry_utility +fullName: azure.cosmos.retry_utility +summary: Internal methods for executing functions in the Azure Cosmos database service. diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.routing.collection_routing_map.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.routing.collection_routing_map.yml new file mode 100644 index 00000000..66cc6192 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.routing.collection_routing_map.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cosmos.routing.collection_routing_map +name: collection_routing_map +fullName: azure.cosmos.routing.collection_routing_map +summary: Internal class for collection routing map implementation in the Azure Cosmos + database service. diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.routing.routing_map_provider.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.routing.routing_map_provider.yml new file mode 100644 index 00000000..86b48ba7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.routing.routing_map_provider.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cosmos.routing.routing_map_provider +name: routing_map_provider +fullName: azure.cosmos.routing.routing_map_provider +summary: Internal class for partition key range cache implementation in the Azure + Cosmos database service. diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.routing.routing_range.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.routing.routing_range.yml new file mode 100644 index 00000000..477f1035 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.routing.routing_range.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cosmos.routing.routing_range +name: routing_range +fullName: azure.cosmos.routing.routing_range +summary: Internal class for partition key range implementation in the Azure Cosmos + database service. diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.routing.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.routing.yml new file mode 100644 index 00000000..3f1ac5c4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.routing.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.cosmos.routing +name: routing +fullName: azure.cosmos.routing +type: import +modules: +- azure.cosmos.routing.collection_routing_map +- azure.cosmos.routing.routing_map_provider +- azure.cosmos.routing.routing_range diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.runtime_constants.MediaTypes.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.runtime_constants.MediaTypes.yml new file mode 100644 index 00000000..478d4033 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.runtime_constants.MediaTypes.yml @@ -0,0 +1,45 @@ +### YamlMime:PythonClass +uid: azure.cosmos.runtime_constants.MediaTypes +name: MediaTypes +fullName: azure.cosmos.runtime_constants.MediaTypes +module: azure.cosmos.runtime_constants +summary: 'Constants of media types. + + + [http://www.iana.org/assignments/media-types/media-types.xhtml](http://www.iana.org/assignments/media-types/media-types.xhtml)' +constructor: + syntax: MediaTypes() +attributes: +- uid: azure.cosmos.runtime_constants.MediaTypes.Any + name: Any + signature: Any = '*/*' +- uid: azure.cosmos.runtime_constants.MediaTypes.ImageJpeg + name: ImageJpeg + signature: ImageJpeg = 'image/jpeg' +- uid: azure.cosmos.runtime_constants.MediaTypes.ImagePng + name: ImagePng + signature: ImagePng = 'image/png' +- uid: azure.cosmos.runtime_constants.MediaTypes.JavaScript + name: JavaScript + signature: JavaScript = 'application/x-javascript' +- uid: azure.cosmos.runtime_constants.MediaTypes.Json + name: Json + signature: Json = 'application/json' +- uid: azure.cosmos.runtime_constants.MediaTypes.OctetStream + name: OctetStream + signature: OctetStream = 'application/octet-stream' +- uid: azure.cosmos.runtime_constants.MediaTypes.QueryJson + name: QueryJson + signature: QueryJson = 'application/query+json' +- uid: azure.cosmos.runtime_constants.MediaTypes.SQL + name: SQL + signature: SQL = 'application/sql' +- uid: azure.cosmos.runtime_constants.MediaTypes.TextHtml + name: TextHtml + signature: TextHtml = 'text/html' +- uid: azure.cosmos.runtime_constants.MediaTypes.TextPlain + name: TextPlain + signature: TextPlain = 'text/plain' +- uid: azure.cosmos.runtime_constants.MediaTypes.Xml + name: Xml + signature: Xml = 'application/xml' diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.runtime_constants.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.runtime_constants.yml new file mode 100644 index 00000000..174b4e0c --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.runtime_constants.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.cosmos.runtime_constants +name: runtime_constants +fullName: azure.cosmos.runtime_constants +summary: Runtime Constants in the Azure Cosmos database service. +classes: +- azure.cosmos.runtime_constants.MediaTypes diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.session.Session.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.session.Session.yml new file mode 100644 index 00000000..ec018d38 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.session.Session.yml @@ -0,0 +1,34 @@ +### YamlMime:PythonClass +uid: azure.cosmos.session.Session +name: Session +fullName: azure.cosmos.session.Session +module: azure.cosmos.session +summary: 'State of a Azure Cosmos session. This session object + + can be shared across clients within the same process' +constructor: + syntax: Session(url_connection) + parameters: + - name: url_connection + isRequired: true +methods: +- uid: azure.cosmos.session.Session.clear_session_token + name: clear_session_token + signature: clear_session_token(response_headers) + parameters: + - name: response_headers + isRequired: true +- uid: azure.cosmos.session.Session.get_session_token + name: get_session_token + signature: get_session_token(resource_path) + parameters: + - name: resource_path + isRequired: true +- uid: azure.cosmos.session.Session.update_session + name: update_session + signature: update_session(response_result, response_headers) + parameters: + - name: response_result + isRequired: true + - name: response_headers + isRequired: true diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.session.SessionContainer.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.session.SessionContainer.yml new file mode 100644 index 00000000..2ca07832 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.session.SessionContainer.yml @@ -0,0 +1,61 @@ +### YamlMime:PythonClass +uid: azure.cosmos.session.SessionContainer +name: SessionContainer +fullName: azure.cosmos.session.SessionContainer +module: azure.cosmos.session +constructor: + syntax: SessionContainer() +methods: +- uid: azure.cosmos.session.SessionContainer.clear_session_token + name: clear_session_token + signature: clear_session_token(response_headers) + parameters: + - name: response_headers + isRequired: true +- uid: azure.cosmos.session.SessionContainer.get_session_token + name: get_session_token + summary: Get Session Token for collection_link + signature: get_session_token(resource_path) + parameters: + - name: resource_path + description: Self link / path to the resource + isRequired: true + types: + - + return: + description: Session Token dictionary for the collection_id + types: + - +- uid: azure.cosmos.session.SessionContainer.parse_session_token + name: parse_session_token + summary: Extracts session token from response headers and parses + signature: static parse_session_token(response_headers) + parameters: + - name: response_headers + isRequired: true + types: + - + return: + description: 'A dictionary of partition id to session lsn + + for given collection' + types: + - +- uid: azure.cosmos.session.SessionContainer.set_session_token + name: set_session_token + summary: 'Session token must only be updated from response of requests that successfully + mutate resource on the + + server side (write, replace, delete etc)' + signature: set_session_token(response_result, response_headers) + parameters: + - name: response_result + isRequired: true + types: + - + - name: response_headers + isRequired: true + types: + - + return: + description: '* None' diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.session.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.session.yml new file mode 100644 index 00000000..06830393 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.session.yml @@ -0,0 +1,8 @@ +### YamlMime:PythonModule +uid: azure.cosmos.session +name: session +fullName: azure.cosmos.session +summary: Session Consistency Tracking in the Azure Cosmos database service. +classes: +- azure.cosmos.session.Session +- azure.cosmos.session.SessionContainer diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.session_retry_policy.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.session_retry_policy.yml new file mode 100644 index 00000000..c314b72f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.session_retry_policy.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.cosmos.session_retry_policy +name: session_retry_policy +fullName: azure.cosmos.session_retry_policy +summary: Internal class for session read/write unavailable retry policy implementation + in the Azure Cosmos database service. diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.synchronized_request.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.synchronized_request.yml new file mode 100644 index 00000000..88cec22f --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.synchronized_request.yml @@ -0,0 +1,59 @@ +### YamlMime:PythonModule +uid: azure.cosmos.synchronized_request +name: synchronized_request +fullName: azure.cosmos.synchronized_request +summary: Synchronized request in the Azure Cosmos database service. +functions: +- uid: azure.cosmos.synchronized_request.SynchronizedRequest + name: SynchronizedRequest + summary: Performs one synchronized http request according to the parameters. + signature: SynchronizedRequest(client, request, global_endpoint_manager, connection_policy, + requests_session, method, path, request_data, query_params, headers) + parameters: + - name: client + description: Document client instance + isRequired: true + types: + - + - name: request + isRequired: true + types: + - + - name: global_endpoint_manager + isRequired: true + types: + - + - name: connection_policy + isRequired: true + types: + - + - name: requests_session + description: Session object in requests module + isRequired: true + types: + - + - name: method + isRequired: true + types: + - + - name: path + isRequired: true + types: + - + - name: request_data + isRequired: true + types: + - (, , , , + - ) + - name: query_params + isRequired: true + types: + - + - name: headers + isRequired: true + types: + - + return: + description: tuple of (result, headers) + types: + - ( ) diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.utils.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.utils.yml new file mode 100644 index 00000000..54cfbb36 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.utils.yml @@ -0,0 +1,5 @@ +### YamlMime:PythonModule +uid: azure.cosmos.utils +name: utils +fullName: azure.cosmos.utils +summary: Internal Helper functions in the Azure Cosmos database service. diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.vector_session_token.VectorSessionToken.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.vector_session_token.VectorSessionToken.yml new file mode 100644 index 00000000..086e53c1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.vector_session_token.VectorSessionToken.yml @@ -0,0 +1,58 @@ +### YamlMime:PythonClass +uid: azure.cosmos.vector_session_token.VectorSessionToken +name: VectorSessionToken +fullName: azure.cosmos.vector_session_token.VectorSessionToken +module: azure.cosmos.vector_session_token +constructor: + syntax: VectorSessionToken(version, global_lsn, local_lsn_by_region, session_token=None) + parameters: + - name: version + isRequired: true + - name: global_lsn + isRequired: true + - name: local_lsn_by_region + isRequired: true + - name: session_token + defaultValue: None +methods: +- uid: azure.cosmos.vector_session_token.VectorSessionToken.are_region_progress_equal + name: are_region_progress_equal + signature: are_region_progress_equal(other) + parameters: + - name: other + isRequired: true +- uid: azure.cosmos.vector_session_token.VectorSessionToken.convert_to_string + name: convert_to_string + signature: convert_to_string() +- uid: azure.cosmos.vector_session_token.VectorSessionToken.create + name: create + summary: Parses session token and creates the vector session token + signature: create(session_token) + parameters: + - name: session_token + isRequired: true + types: + - + return: + description: A Vector session Token + types: + - +- uid: azure.cosmos.vector_session_token.VectorSessionToken.equals + name: equals + signature: equals(other) + parameters: + - name: other + isRequired: true +- uid: azure.cosmos.vector_session_token.VectorSessionToken.merge + name: merge + signature: merge(other) + parameters: + - name: other + isRequired: true +attributes: +- uid: azure.cosmos.vector_session_token.VectorSessionToken.region_progress_separator + name: region_progress_separator + signature: region_progress_separator = '=' +- uid: azure.cosmos.vector_session_token.VectorSessionToken.segment_separator + name: segment_separator + signature: segment_separator = '#' diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.vector_session_token.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.vector_session_token.yml new file mode 100644 index 00000000..45abfad1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.vector_session_token.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.cosmos.vector_session_token +name: vector_session_token +fullName: azure.cosmos.vector_session_token +summary: Session Consistency Tracking in the Azure Cosmos database service. +classes: +- azure.cosmos.vector_session_token.VectorSessionToken diff --git a/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.yml b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.yml new file mode 100644 index 00000000..d77174df --- /dev/null +++ b/previous/docs-ref-autogen/azure-cosmos/azure.cosmos.yml @@ -0,0 +1,37 @@ +### YamlMime:PythonPackage +uid: azure.cosmos +name: cosmos +fullName: azure.cosmos +type: rootImport +packages: +- azure.cosmos.execution_context +- azure.cosmos.routing +modules: +- azure.cosmos.auth +- azure.cosmos.base +- azure.cosmos.consistent_hash_ring +- azure.cosmos.constants +- azure.cosmos.cosmos_client +- azure.cosmos.default_retry_policy +- azure.cosmos.documents +- azure.cosmos.endpoint_discovery_retry_policy +- azure.cosmos.errors +- azure.cosmos.global_endpoint_manager +- azure.cosmos.hash_partition_resolver +- azure.cosmos.http_constants +- azure.cosmos.location_cache +- azure.cosmos.murmur_hash +- azure.cosmos.partition +- azure.cosmos.query_iterable +- azure.cosmos.range +- azure.cosmos.range_partition_resolver +- azure.cosmos.request_object +- azure.cosmos.resource_throttle_retry_policy +- azure.cosmos.retry_options +- azure.cosmos.retry_utility +- azure.cosmos.runtime_constants +- azure.cosmos.session +- azure.cosmos.session_retry_policy +- azure.cosmos.synchronized_request +- azure.cosmos.utils +- azure.cosmos.vector_session_token diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.core.AzureDLFile.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.core.AzureDLFile.yml new file mode 100644 index 00000000..b8d3a8c0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.core.AzureDLFile.yml @@ -0,0 +1,169 @@ +### YamlMime:PythonClass +uid: azure.datalake.store.core.AzureDLFile +name: AzureDLFile +fullName: azure.datalake.store.core.AzureDLFile +module: azure.datalake.store.core +summary: Open ADL key as a file. Data is only loaded and cached on demand. +constructor: + syntax: AzureDLFile(azure, path, mode='rb', blocksize=33554432, delimiter=None) + parameters: + - name: azure + isRequired: true + types: + - > + - name: path + description: location of file + isRequired: true + types: + - + - name: mode + defaultValue: rb + - name: blocksize + description: 'Size of the write or read-ahead buffer. For writing(and appending, + will be + + truncated to 4MB (2**22).' + defaultValue: '33554432' + types: + - + - name: delimiter + description: 'If specified and in write mode, each flush will send data terminating + + on this bytestring, potentially leaving some data in the buffer.' + defaultValue: None + types: + - + - +examples: +- "\n```\n\n>>> adl = AzureDLFileSystem() \n>>> with adl.open('my-dir/my-file.txt',\ + \ mode='rb') as f: \n... f.read(10) \n```\n" +methods: +- uid: azure.datalake.store.core.AzureDLFile.close + name: close + summary: 'Close file + + + If in write mode, causes flush of any unwritten data.' + signature: close() +- uid: azure.datalake.store.core.AzureDLFile.flush + name: flush + summary: 'Write buffered data to ADL. + + + Without delimiter: Uploads the current buffer. + + + With delimiter: writes an amount of data less than or equal to the + + block-size, which ends on the delimiter, until buffer is smaller than + + the blocksize. If there is no delimiter in a block uploads whole block. + + + If force=True, flushes all data in the buffer, even if it doesn''t end + + with a delimiter; appropriate when closing the file.' + signature: flush(syncFlag='METADATA', force=False) + parameters: + - name: syncFlag + defaultValue: METADATA + - name: force + defaultValue: 'False' +- uid: azure.datalake.store.core.AzureDLFile.info + name: info + summary: File information about this path + signature: info() +- uid: azure.datalake.store.core.AzureDLFile.next + name: next + signature: next() +- uid: azure.datalake.store.core.AzureDLFile.read + name: read + summary: Return data from cache, or fetch pieces as necessary + signature: read(length=-1) + parameters: + - name: length + description: Number of bytes to read; if <0, all remaining bytes. + defaultValue: '-1' + types: + - () +- uid: azure.datalake.store.core.AzureDLFile.read1 + name: read1 + summary: Return data from cache, or fetch pieces as necessary + signature: read1(length=-1) + parameters: + - name: length + description: Number of bytes to read; if <0, all remaining bytes. + defaultValue: '-1' + types: + - () +- uid: azure.datalake.store.core.AzureDLFile.readable + name: readable + summary: Return whether the AzureDLFile was opened for reading + signature: readable() +- uid: azure.datalake.store.core.AzureDLFile.readinto + name: readinto + summary: Reads data into buffer b + signature: readinto(b) + parameters: + - name: b + description: Buffer to which bytes are read into + isRequired: true + types: + - + return: + types: + - +- uid: azure.datalake.store.core.AzureDLFile.readline + name: readline + summary: 'Read and return a line from the stream. + + + If length is specified, at most size bytes will be read.' + signature: readline(length=-1) + parameters: + - name: length + defaultValue: '-1' +- uid: azure.datalake.store.core.AzureDLFile.readlines + name: readlines + summary: Return all lines in a file as a list + signature: readlines() +- uid: azure.datalake.store.core.AzureDLFile.seek + name: seek + summary: Set current file location + signature: seek(loc, whence=0) + parameters: + - name: loc + description: byte location + isRequired: true + types: + - + - name: whence + description: from start of file, current location or end of file, resp. + defaultValue: '0' +- uid: azure.datalake.store.core.AzureDLFile.seekable + name: seekable + summary: Return whether the AzureDLFile is seekable (only in read mode) + signature: seekable() +- uid: azure.datalake.store.core.AzureDLFile.tell + name: tell + summary: Current file location + signature: tell() +- uid: azure.datalake.store.core.AzureDLFile.writable + name: writable + summary: Return whether the AzureDLFile was opened for writing + signature: writable() +- uid: azure.datalake.store.core.AzureDLFile.write + name: write + summary: 'Write data to buffer. + + + Buffer only sent to ADL on flush() or if buffer is bigger than + + blocksize.' + signature: write(data) + parameters: + - name: data + description: Set of bytes to be written. + isRequired: true + types: + - diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.core.AzureDLFileSystem.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.core.AzureDLFileSystem.yml new file mode 100644 index 00000000..f7e968b8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.core.AzureDLFileSystem.yml @@ -0,0 +1,888 @@ +### YamlMime:PythonClass +uid: azure.datalake.store.core.AzureDLFileSystem +name: AzureDLFileSystem +fullName: azure.datalake.store.core.AzureDLFileSystem +module: azure.datalake.store.core +summary: Access Azure DataLake Store as if it were a file-system +constructor: + syntax: AzureDLFileSystem(token_credential=None, **kwargs) + parameters: + - name: store_name + description: Store name to connect to. If not supplied, we use environment variable + azure_data_lake_store_name + isRequired: true + types: + - "(> + - name: scopes + description: which is a list of scopes to use for the token. + isRequired: true + types: + - () + - name: url_suffix + description: 'Domain to send REST requests to. The end-point URL is constructed + + using this and the store_name. If None, use default.' + isRequired: true + types: + - () + - name: api_version + description: The API version to target with requests. Changing this value will + change the behavior of the requests, and can cause unexpected behavior or breaking + changes. Changes to this value should be undergone with caution. + isRequired: true + types: + - () + - name: per_call_timeout_seconds + description: This is the timeout for each requests library call. + isRequired: true + types: + - () + - name: kwargs + description: Other arguments forwarded to the DatalakeRESTInterface constructor. + isRequired: true + types: + - > +methods: +- uid: azure.datalake.store.core.AzureDLFileSystem.access + name: access + summary: Does such a file/directory exist? + signature: access(path, invalidate_cache=True) + parameters: + - name: path + description: Path to query + isRequired: true + types: + - + - + - name: invalidate_cache + description: Whether to invalidate cache + defaultValue: 'True' + types: + - + return: + types: + - + - + +- uid: azure.datalake.store.core.AzureDLFileSystem.cat + name: cat + summary: Return contents of file + signature: cat(path) + parameters: + - name: path + description: Path to query + isRequired: true + types: + - + - + return: + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.chmod + name: chmod + summary: 'Change access mode of path + + + Note this is not recursive.' + signature: chmod(path, mod) + parameters: + - name: path + description: Location to change + isRequired: true + types: + - + - name: mod + description: 'Octal representation of access, e.g., "0777" for public read/write. + + See [docs](http://hadoop.apache.org/docs/r2.4.1/hadoop-project-dist/hadoop-hdfs/WebHDFS.html#Permission)' + isRequired: true + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.chown + name: chown + summary: 'Change owner and/or owning group + + + Note this is not recursive.' + signature: chown(path, owner=None, group=None) + parameters: + - name: path + description: Location to change + isRequired: true + types: + - + - name: owner + description: UUID of owning entity + defaultValue: None + types: + - + - name: group + description: UUID of group + defaultValue: None + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.concat + name: concat + summary: Concatenate a list of files into one new file + signature: concat(outfile, filelist, delete_source=False) + parameters: + - name: outfile + description: 'The file which will be concatenated to. If it already exists, + + the extra pieces will be appended.' + isRequired: true + types: + - + - name: filelist + description: Existing adl files to concatenate, in order + isRequired: true + types: + - of + - name: delete_source + description: 'If True, assume that the paths to concatenate exist alone in a + + directory, and delete that whole directory when done.' + defaultValue: 'False' + types: + - () + return: + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.connect + name: connect + summary: Establish connection object. + signature: connect() +- uid: azure.datalake.store.core.AzureDLFileSystem.cp + name: cp + summary: Not implemented. Copy file between locations on ADL + signature: cp(path1, path2) + parameters: + - name: path1 + isRequired: true + - name: path2 + isRequired: true +- uid: azure.datalake.store.core.AzureDLFileSystem.current + name: current + summary: Return the most recently created AzureDLFileSystem + signature: current() +- uid: azure.datalake.store.core.AzureDLFileSystem.df + name: df + summary: Resource summary of path + signature: df(path) + parameters: + - name: path + description: Path to query + isRequired: true + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.du + name: du + summary: Bytes in keys at path + signature: du(path, total=False, deep=False, invalidate_cache=True) + parameters: + - name: path + description: Path to query + isRequired: true + types: + - + - + - name: total + description: Return the sum on list + defaultValue: 'False' + types: + - + - name: deep + description: Recursively enumerate or just use files under current dir + defaultValue: 'False' + types: + - + - name: invalidate_cache + description: Whether to invalidate cache + defaultValue: 'True' + types: + - + return: + description: '**List of dict of name**' + types: + - + - +- uid: azure.datalake.store.core.AzureDLFileSystem.exists + name: exists + summary: Does such a file/directory exist? + signature: exists(path, invalidate_cache=True) + parameters: + - name: path + description: Path to query + isRequired: true + types: + - + - + - name: invalidate_cache + description: Whether to invalidate cache + defaultValue: 'True' + types: + - + return: + types: + - + - + +- uid: azure.datalake.store.core.AzureDLFileSystem.get + name: get + summary: Stream data from file at path to local filename + signature: get(path, filename) + parameters: + - name: path + description: ADL Path to read + isRequired: true + types: + - + - + - name: filename + description: Local file path to write to + isRequired: true + types: + - + - + return: + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.get_acl_status + name: get_acl_status + summary: Gets Access Control List (ACL) entries for the specified file or directory. + signature: get_acl_status(path) + parameters: + - name: path + description: Location to get the ACL. + isRequired: true + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.glob + name: glob + summary: Find files (not directories) by glob-matching. + signature: glob(path, details=False, invalidate_cache=True) + parameters: + - name: path + description: Path to query + isRequired: true + types: + - + - + - name: details + description: Whether to include file details + defaultValue: 'False' + types: + - + - name: invalidate_cache + description: Whether to invalidate cache + defaultValue: 'True' + types: + - + return: + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.head + name: head + summary: Return first bytes of file + signature: head(path, size=1024) + parameters: + - name: path + description: Path to query + isRequired: true + types: + - + - + - name: size + description: How many bytes to return + defaultValue: '1024' + types: + - + return: + types: + - () +- uid: azure.datalake.store.core.AzureDLFileSystem.info + name: info + summary: File information for path + signature: info(path, invalidate_cache=True, expected_error_code=None) + parameters: + - name: path + description: Path to query + isRequired: true + types: + - + - + - name: invalidate_cache + description: Whether to invalidate cache or not + defaultValue: 'True' + types: + - + - name: expected_error_code + description: Optionally indicates a specific, expected error code, if any. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.invalidate_cache + name: invalidate_cache + summary: Remove entry from object file-cache + signature: invalidate_cache(path=None) + parameters: + - name: path + description: Remove the path from object file-cache + defaultValue: None + types: + - + - + return: + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.listdir + name: listdir + summary: List all elements under directory specified with path + signature: listdir(path='', detail=False, invalidate_cache=True) + parameters: + - name: path + description: Path to query + isRequired: true + types: + - + - + - name: detail + description: Detailed info or not. + defaultValue: 'False' + types: + - + - name: invalidate_cache + description: Whether to invalidate cache or not + defaultValue: 'True' + types: + - + return: + types: + - + +- uid: azure.datalake.store.core.AzureDLFileSystem.ls + name: ls + summary: List all elements under directory specified with path + signature: ls(path='', detail=False, invalidate_cache=True) + parameters: + - name: path + description: Path to query + isRequired: true + types: + - + - + - name: detail + description: Detailed info or not. + defaultValue: 'False' + types: + - + - name: invalidate_cache + description: Whether to invalidate cache or not + defaultValue: 'True' + types: + - + return: + types: + - + +- uid: azure.datalake.store.core.AzureDLFileSystem.merge + name: merge + summary: Concatenate a list of files into one new file + signature: merge(outfile, filelist, delete_source=False) + parameters: + - name: outfile + description: 'The file which will be concatenated to. If it already exists, + + the extra pieces will be appended.' + isRequired: true + types: + - + - name: filelist + description: Existing adl files to concatenate, in order + isRequired: true + types: + - of + - name: delete_source + description: 'If True, assume that the paths to concatenate exist alone in a + + directory, and delete that whole directory when done.' + defaultValue: 'False' + types: + - () + return: + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.mkdir + name: mkdir + summary: Make new directory + signature: mkdir(path) + parameters: + - name: path + description: Path to create directory + isRequired: true + types: + - + - + return: + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.modify_acl_entries + name: modify_acl_entries + summary: 'Modify existing Access Control List (ACL) entries on a file or folder. + + If the entry does not exist it is added, otherwise it is updated based on the + spec passed in. + + No entries are removed by this process (unlike set_acl). + + + Note: this is by default not recursive, and applies only to the file or folder + specified.' + signature: modify_acl_entries(path, acl_spec, recursive=False, number_of_sub_process=None) + parameters: + - name: path + description: Location to set the ACL entries on. + isRequired: true + types: + - + - name: acl_spec + description: 'The ACL specification to use in modifying the ACL at the path in + the format + + ''[default:]user|group|other:[entity id or UPN]:r|-w|-x|-,[default:]user|group|other:[entity + id or UPN]:r|-w|-x|-,...''' + isRequired: true + types: + - + - name: recursive + description: Specifies whether to modify ACLs recursively or not + defaultValue: 'False' + types: + - + - name: number_of_sub_process + defaultValue: None +- uid: azure.datalake.store.core.AzureDLFileSystem.mv + name: mv + summary: Move file between locations on ADL + signature: mv(path1, path2) + parameters: + - name: path1 + description: Source Path + isRequired: true + - name: path2 + description: Destination path + isRequired: true + return: + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.open + name: open + summary: Open a file for reading or writing + signature: open(path, mode='rb', blocksize=33554432, delimiter=None) + parameters: + - name: path + description: Path of file on ADL + isRequired: true + types: + - + - name: mode + description: One of 'rb', 'ab' or 'wb' + defaultValue: rb + types: + - + - name: blocksize + description: Size of data-node blocks if reading + defaultValue: '33554432' + types: + - + - name: delimiter + description: For writing delimiter-ended blocks + defaultValue: None + types: + - () + - +- uid: azure.datalake.store.core.AzureDLFileSystem.put + name: put + summary: Stream data from local filename to file at path + signature: put(filename, path, delimiter=None) + parameters: + - name: filename + description: Local file path to read from + isRequired: true + types: + - + - + - name: path + description: ADL Path to write to + isRequired: true + types: + - + - + - name: delimiter + description: Optional delimeter for delimiter-ended blocks + defaultValue: None + return: + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.read_block + name: read_block + summary: 'Read a block of bytes from an ADL file + + + Starting at `offset` of the file, read `length` bytes. If + + `delimiter` is set then we ensure that the read starts and stops at + + delimiter boundaries that follow the locations `offset` and `offset + + + length`. If `offset` is zero then we start at zero. The + + bytestring returned WILL include the end delimiter string. + + + If offset+length is beyond the eof, reads to eof.' + signature: read_block(fn, offset, length, delimiter=None) + parameters: + - name: fn + description: Path to filename on ADL + isRequired: true + types: + - + - name: offset + description: Byte offset to start read + isRequired: true + types: + - + - name: length + description: Number of bytes to read + isRequired: true + types: + - + - name: delimiter + description: Ensure reading starts and stops at delimiter bytestring + defaultValue: None + types: + - () + examples: + - "\n```\n\n>>> adl.read_block('data/file.csv', 0, 13) \nb'Alice, 100\\nBo'\n>>>\ + \ adl.read_block('data/file.csv', 0, 13, delimiter=b'\\n') \nb'Alice, 100\\nBob,\ + \ 200\\n'\n```\n\nUse `length=None` to read to the end of the file.\n>>> adl.read_block('data/file.csv',\ + \ 0, None, delimiter=b'n') # doctest: +SKIP\nb'Alice, 100nBob, 200nCharlie, 300'\n" + seeAlsoContent: ' + + ' +- uid: azure.datalake.store.core.AzureDLFileSystem.remove + name: remove + summary: Remove a file or directory + signature: remove(path, recursive=False) + parameters: + - name: path + description: The location to remove. + isRequired: true + types: + - + - + - name: recursive + description: 'Whether to remove also all entries below, i.e., which are returned + + by *walk()*.' + defaultValue: 'False' + types: + - () + return: + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.remove_acl + name: remove_acl + summary: 'Remove the entire, non default, ACL from the file or folder, including + unnamed entries. + + Default entries cannot be removed this way, please use remove_default_acl for + that. + + + Note: this is not recursive, and applies only to the file or folder specified.' + signature: remove_acl(path) + parameters: + - name: path + description: Location to remove the ACL. + isRequired: true + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.remove_acl_entries + name: remove_acl_entries + summary: 'Remove existing, named, Access Control List (ACL) entries on a file or + folder. + + If the entry does not exist already it is ignored. + + Default entries cannot be removed this way, please use remove_default_acl for + that. + + Unnamed entries cannot be removed in this way, please use remove_acl for that. + + + Note: this is by default not recursive, and applies only to the file or folder + specified.' + signature: remove_acl_entries(path, acl_spec, recursive=False, number_of_sub_process=None) + parameters: + - name: path + description: Location to remove the ACL entries. + isRequired: true + types: + - + - name: acl_spec + description: 'The ACL specification to remove from the ACL at the path in the + format (note that the permission portion is missing) + + ''[default:]user|group|other:[entity id or UPN],[default:]user|group|other:[entity + id or UPN],...''' + isRequired: true + types: + - + - name: recursive + description: Specifies whether to remove ACLs recursively or not + defaultValue: 'False' + types: + - + - name: number_of_sub_process + defaultValue: None +- uid: azure.datalake.store.core.AzureDLFileSystem.remove_default_acl + name: remove_default_acl + summary: 'Remove the entire default ACL from the folder. + + Default entries do not exist on files, if a file + + is specified, this operation does nothing. + + + Note: this is not recursive, and applies only to the folder specified.' + signature: remove_default_acl(path) + parameters: + - name: path + description: Location to set the ACL on. + isRequired: true + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.rename + name: rename + summary: Move file between locations on ADL + signature: rename(path1, path2) + parameters: + - name: path1 + description: Source Path + isRequired: true + - name: path2 + description: Destination path + isRequired: true + return: + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.rm + name: rm + summary: Remove a file or directory + signature: rm(path, recursive=False) + parameters: + - name: path + description: The location to remove. + isRequired: true + types: + - + - + - name: recursive + description: 'Whether to remove also all entries below, i.e., which are returned + + by *walk()*.' + defaultValue: 'False' + types: + - () + return: + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.rmdir + name: rmdir + summary: Remove empty directory + signature: rmdir(path) + parameters: + - name: path + description: Directory path to remove + isRequired: true + types: + - + - + return: + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.set_acl + name: set_acl + summary: 'Set the Access Control List (ACL) for a file or folder. + + + Note: this is by default not recursive, and applies only to the file or folder + specified.' + signature: set_acl(path, acl_spec, recursive=False, number_of_sub_process=None) + parameters: + - name: path + description: Location to set the ACL on. + isRequired: true + types: + - + - name: acl_spec + description: 'The ACL specification to set on the path in the format + + ''[default:]user|group|other:[entity id or UPN]:r|-w|-x|-,[default:]user|group|other:[entity + id or UPN]:r|-w|-x|-,...''' + isRequired: true + types: + - + - name: recursive + description: Specifies whether to set ACLs recursively or not + defaultValue: 'False' + types: + - + - name: number_of_sub_process + defaultValue: None +- uid: azure.datalake.store.core.AzureDLFileSystem.set_expiry + name: set_expiry + summary: 'Set or remove the expiration time on the specified file. + + This operation can only be executed against files. + + + Note: Folders are not supported.' + signature: set_expiry(path, expiry_option, expire_time=None) + parameters: + - name: path + description: File path to set or remove expiration time + isRequired: true + types: + - + - name: expire_time + description: The time that the file will expire, corresponding to the expiry_option + that was set + defaultValue: None + types: + - + - name: expiry_option + description: "Indicates the type of expiration to use for the file:\n 1. NeverExpire:\ + \ ExpireTime is ignored. \n\n 2. RelativeToNow: ExpireTime is an integer in\ + \ milliseconds representing the expiration date relative to when file expiration\ + \ is updated. \n\n 3. RelativeToCreationDate: ExpireTime is an integer in\ + \ milliseconds representing the expiration date relative to file creation. \n\ + \n 4. Absolute: ExpireTime is an integer in milliseconds, as a Unix timestamp\ + \ relative to 1/1/1970 00:00:00." + isRequired: true + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.stat + name: stat + summary: File information for path + signature: stat(path, invalidate_cache=True, expected_error_code=None) + parameters: + - name: path + description: Path to query + isRequired: true + types: + - + - + - name: invalidate_cache + description: Whether to invalidate cache or not + defaultValue: 'True' + types: + - + - name: expected_error_code + description: Optionally indicates a specific, expected error code, if any. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.tail + name: tail + summary: Return last bytes of file + signature: tail(path, size=1024) + parameters: + - name: path + description: Path to query + isRequired: true + types: + - + - + - name: size + description: How many bytes to return + defaultValue: '1024' + types: + - + return: + types: + - () +- uid: azure.datalake.store.core.AzureDLFileSystem.touch + name: touch + summary: Create empty file + signature: touch(path) + parameters: + - name: path + description: Path of file to create + isRequired: true + types: + - + - + return: + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.unlink + name: unlink + summary: Remove a file or directory + signature: unlink(path, recursive=False) + parameters: + - name: path + description: The location to remove. + isRequired: true + types: + - + - + - name: recursive + description: 'Whether to remove also all entries below, i.e., which are returned + + by *walk()*.' + defaultValue: 'False' + types: + - () + return: + types: + - +- uid: azure.datalake.store.core.AzureDLFileSystem.walk + name: walk + summary: Get all files below given path + signature: walk(path='', details=False, invalidate_cache=True) + parameters: + - name: path + description: Path to query + isRequired: true + types: + - + - + - name: details + description: Whether to include file details + defaultValue: 'False' + types: + - + - name: invalidate_cache + description: Whether to invalidate cache + defaultValue: 'True' + types: + - + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.core.AzureDLPath.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.core.AzureDLPath.yml new file mode 100644 index 00000000..e0b49322 --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.core.AzureDLPath.yml @@ -0,0 +1,57 @@ +### YamlMime:PythonClass +uid: azure.datalake.store.core.AzureDLPath +name: AzureDLPath +fullName: azure.datalake.store.core.AzureDLPath +module: azure.datalake.store.core +summary: 'Subclass of native object-oriented filesystem path. + + + This is used as a convenience class for reducing boilerplate and + + eliminating differences between system-dependent paths. + + + We subclass the system''s concrete pathlib class due to this issue: + + + [http://stackoverflow.com/questions/29850801/subclass-pathlib-path-fails](http://stackoverflow.com/questions/29850801/subclass-pathlib-path-fails) + + + Construct a PurePath from one or several strings and or existing + + PurePath objects. The strings and path objects are combined so as + + to yield a canonicalized path, which is incorporated into the + + new PurePath object.' +constructor: + syntax: AzureDLPath(*args) + parameters: + - name: path + description: location of file or directory + isRequired: true + types: + - + - +examples: +- "\n```\n\n>>> p1 = AzureDLPath('/Users/foo') \n>>> p2 = AzureDLPath(p1.name) \n\ + ```\n" +methods: +- uid: azure.datalake.store.core.AzureDLPath.startswith + name: startswith + summary: 'Return whether string starts with the prefix. + + + This is equivalent to *str.startswith*.' + signature: startswith(prefix, *args, **kwargs) + parameters: + - name: prefix + isRequired: true +- uid: azure.datalake.store.core.AzureDLPath.trim + name: trim + summary: Return path without anchor (concatenation of drive and root). + signature: trim() +attributes: +- uid: azure.datalake.store.core.AzureDLPath.globless_prefix + name: globless_prefix + summary: Return shortest path prefix without glob quantifiers. diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.core.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.core.yml new file mode 100644 index 00000000..1692a30a --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.core.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonModule +uid: azure.datalake.store.core +name: core +fullName: azure.datalake.store.core +summary: 'The main file-system class and functionality. + + + + Provides an pythonic interface to the Azure Data-lake Store, including + + file-system commands with typical names and options, and a File object + + which is compatible with the built-in File.' +classes: +- azure.datalake.store.core.AzureDLFile +- azure.datalake.store.core.AzureDLFileSystem +- azure.datalake.store.core.AzureDLPath diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.enums.ExpiryOptionType.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.enums.ExpiryOptionType.yml new file mode 100644 index 00000000..af64d5b8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.enums.ExpiryOptionType.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.datalake.store.enums.ExpiryOptionType +name: ExpiryOptionType +fullName: azure.datalake.store.enums.ExpiryOptionType +module: azure.datalake.store.enums +fields: +- name: absolute + uid: azure.datalake.store.enums.ExpiryOptionType.absolute +- name: never_expire + uid: azure.datalake.store.enums.ExpiryOptionType.never_expire +- name: relative_to_creation_date + uid: azure.datalake.store.enums.ExpiryOptionType.relative_to_creation_date +- name: relative_to_now + uid: azure.datalake.store.enums.ExpiryOptionType.relative_to_now diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.enums.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.enums.yml new file mode 100644 index 00000000..f7523916 --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.enums.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.datalake.store.enums +name: enums +fullName: azure.datalake.store.enums +enums: +- azure.datalake.store.enums.ExpiryOptionType diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.exceptions.DatalakeBadOffsetException.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.exceptions.DatalakeBadOffsetException.yml new file mode 100644 index 00000000..7df95ac4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.exceptions.DatalakeBadOffsetException.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.datalake.store.exceptions.DatalakeBadOffsetException +name: DatalakeBadOffsetException +fullName: azure.datalake.store.exceptions.DatalakeBadOffsetException +module: azure.datalake.store.exceptions +constructor: + syntax: DatalakeBadOffsetException() diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.exceptions.DatalakeIncompleteTransferException.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.exceptions.DatalakeIncompleteTransferException.yml new file mode 100644 index 00000000..876b828f --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.exceptions.DatalakeIncompleteTransferException.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.datalake.store.exceptions.DatalakeIncompleteTransferException +name: DatalakeIncompleteTransferException +fullName: azure.datalake.store.exceptions.DatalakeIncompleteTransferException +module: azure.datalake.store.exceptions +constructor: + syntax: DatalakeIncompleteTransferException() diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.exceptions.DatalakeRESTException.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.exceptions.DatalakeRESTException.yml new file mode 100644 index 00000000..ac81084f --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.exceptions.DatalakeRESTException.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.datalake.store.exceptions.DatalakeRESTException +name: DatalakeRESTException +fullName: azure.datalake.store.exceptions.DatalakeRESTException +module: azure.datalake.store.exceptions +constructor: + syntax: DatalakeRESTException() diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.exceptions.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.exceptions.yml new file mode 100644 index 00000000..091c5bbc --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.exceptions.yml @@ -0,0 +1,8 @@ +### YamlMime:PythonModule +uid: azure.datalake.store.exceptions +name: exceptions +fullName: azure.datalake.store.exceptions +classes: +- azure.datalake.store.exceptions.DatalakeBadOffsetException +- azure.datalake.store.exceptions.DatalakeIncompleteTransferException +- azure.datalake.store.exceptions.DatalakeRESTException diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.lib.DatalakeRESTInterface.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.lib.DatalakeRESTInterface.yml new file mode 100644 index 00000000..fbd63b6a --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.lib.DatalakeRESTInterface.yml @@ -0,0 +1,144 @@ +### YamlMime:PythonClass +uid: azure.datalake.store.lib.DatalakeRESTInterface +name: DatalakeRESTInterface +fullName: azure.datalake.store.lib.DatalakeRESTInterface +module: azure.datalake.store.lib +summary: Call factory for webHDFS endpoints on ADLS +constructor: + syntax: DatalakeRESTInterface(store_name=None, token_credential=None, scopes=None, + url_suffix='azuredatalakestore.net', **kwargs) + parameters: + - name: store_name + description: The name of the Data Lake Store account to execute operations against. + defaultValue: None + types: + - + - name: token + description: from *auth()* or *refresh_token()* or other MSAL source + isRequired: true + types: + - + - name: url_suffix + description: 'Domain to send REST requests to. The end-point URL is constructed + + using this and the store_name. If None, use default.' + defaultValue: azuredatalakestore.net + types: + - () + - name: api_version + description: 'The API version to target with requests. Changing this value will + + change the behavior of the requests, and can cause unexpected behavior or + + breaking changes. Changes to this value should be undergone with caution.' + isRequired: true + types: + - () + - name: req_timeout_s + description: This is the timeout for each requests library call. + isRequired: true + types: + - () + - name: scopes + description: The scopes to use for the token. If not provided, the default [https://datalake.azure.net//.default](https://datalake.azure.net//.default) + is used. + defaultValue: None + types: + - () + - name: token_credential + defaultValue: None +methods: +- uid: azure.datalake.store.lib.DatalakeRESTInterface.call + name: call + summary: Execute a REST call + signature: call(op, path='', is_extended=False, expected_error_code=None, retry_policy=None, + headers={}, **kwargs) + parameters: + - name: op + description: webHDFS operation to perform, one of *DatalakeRESTInterface.ends* + isRequired: true + types: + - + - name: path + description: filepath on the remote system + isRequired: true + types: + - + - name: is_extended + description: 'Indicates if the API call comes from the webhdfs extensions path + or the basic webhdfs path. + + By default, all requests target the official webhdfs path. A small subset of + custom convenience + + methods specific to Azure Data Lake Store target the extension path (such as + SETEXPIRY).' + defaultValue: 'False' + types: + - () + - name: expected_error_code + description: 'Optionally indicates a specific, expected error code, if any. In + the event that this error + + is returned, the exception will be logged to DEBUG instead of ERROR stream. + The exception + + will still be raised, however, as it is expected that the caller will expect + to handle it + + and do something different if it is raised.' + defaultValue: None + types: + - + - name: kwargs + description: 'other parameters, as defined by the webHDFS standard and + + [https://msdn.microsoft.com/en-us/library/mt710547.aspx](https://msdn.microsoft.com/en-us/library/mt710547.aspx)' + isRequired: true + types: + - + - name: retry_policy + defaultValue: None + - name: headers + defaultValue: '{}' +- uid: azure.datalake.store.lib.DatalakeRESTInterface.get_refreshed_bearer_token + name: get_refreshed_bearer_token + signature: get_refreshed_bearer_token() +- uid: azure.datalake.store.lib.DatalakeRESTInterface.is_successful_response + name: is_successful_response + signature: is_successful_response(response, exception) + parameters: + - name: response + isRequired: true + - name: exception + isRequired: true +- uid: azure.datalake.store.lib.DatalakeRESTInterface.log_response_and_raise + name: log_response_and_raise + signature: log_response_and_raise(response, exception, level=40) + parameters: + - name: response + isRequired: true + - name: exception + isRequired: true + - name: level + defaultValue: '40' +attributes: +- uid: azure.datalake.store.lib.DatalakeRESTInterface.session + name: session +- uid: azure.datalake.store.lib.DatalakeRESTInterface.ends + name: ends + signature: 'ends = {''APPEND'': (''post'', set(), {''append'', ''leaseid'', ''offset'', + ''syncFlag'', ''filesessionid''}), ''CHECKACCESS'': (''get'', set(), {''fsaction''}), + ''CONCAT'': (''post'', {''sources''}, {''sources''}), ''CREATE'': (''put'', set(), + {''leaseid'', ''filesessionid'', ''write'', ''syncFlag'', ''overwrite''}), ''DELETE'': + (''delete'', set(), {''recursive''}), ''GETCONTENTSUMMARY'': (''get'', set(), + set()), ''GETFILESTATUS'': (''get'', set(), set()), ''LISTSTATUS'': (''get'', + set(), {''listAfter'', ''listSize''}), ''MKDIRS'': (''put'', set(), set()), ''MODIFYACLENTRIES'': + (''put'', {''aclSpec''}, {''aclSpec''}), ''MSCONCAT'': (''post'', set(), {''deleteSourceDirectory''}), + ''MSGETACLSTATUS'': (''get'', set(), set()), ''OPEN'': (''get'', set(), {''length'', + ''filesessionid'', ''offset'', ''read''}), ''REMOVEACL'': (''put'', set(), set()), + ''REMOVEACLENTRIES'': (''put'', {''aclSpec''}, {''aclSpec''}), ''REMOVEDEFAULTACL'': + (''put'', set(), set()), ''RENAME'': (''put'', {''destination''}, {''destination''}), + ''SETACL'': (''put'', {''aclSpec''}, {''aclSpec''}), ''SETEXPIRY'': (''put'', + {''expiryOption''}, {''expireTime'', ''expiryOption''}), ''SETOWNER'': (''put'', + set(), {''group'', ''owner''}), ''SETPERMISSION'': (''put'', set(), {''permission''})}' diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.lib.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.lib.yml new file mode 100644 index 00000000..4a0500e8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.lib.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonModule +uid: azure.datalake.store.lib +name: lib +fullName: azure.datalake.store.lib +summary: 'Low-level calls to REST end-points. + + + + Specific interfaces to the Data-lake Store filesystem layer and authentication code.' +functions: +- uid: azure.datalake.store.lib.enforce_no_py_open_ssl + name: enforce_no_py_open_ssl + signature: enforce_no_py_open_ssl() +classes: +- azure.datalake.store.lib.DatalakeRESTInterface diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.multiprocessor.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.multiprocessor.yml new file mode 100644 index 00000000..356c06dd --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.multiprocessor.yml @@ -0,0 +1,51 @@ +### YamlMime:PythonModule +uid: azure.datalake.store.multiprocessor +name: multiprocessor +fullName: azure.datalake.store.multiprocessor +functions: +- uid: azure.datalake.store.multiprocessor.log_listener_process + name: log_listener_process + signature: log_listener_process(queue) + parameters: + - name: queue + isRequired: true +- uid: azure.datalake.store.multiprocessor.monitor_exception + name: monitor_exception + signature: monitor_exception(exception_queue, process_ids) + parameters: + - name: exception_queue + isRequired: true + - name: process_ids + isRequired: true +- uid: azure.datalake.store.multiprocessor.multi_processor_change_acl + name: multi_processor_change_acl + signature: multi_processor_change_acl(adl, path=None, method_name='', acl_spec='', + number_of_sub_process=None) + parameters: + - name: adl + isRequired: true + - name: path + defaultValue: None + - name: method_name + - name: acl_spec + - name: number_of_sub_process + defaultValue: None +- uid: azure.datalake.store.multiprocessor.processor + name: processor + signature: processor(adl, file_path_queue, finish_queue_processing_flag, method_name, + acl_spec, log_queue, exception_queue) + parameters: + - name: adl + isRequired: true + - name: file_path_queue + isRequired: true + - name: finish_queue_processing_flag + isRequired: true + - name: method_name + isRequired: true + - name: acl_spec + isRequired: true + - name: log_queue + isRequired: true + - name: exception_queue + isRequired: true diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.multithread.ADLDownloader.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.multithread.ADLDownloader.yml new file mode 100644 index 00000000..c2a9eba4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.multithread.ADLDownloader.yml @@ -0,0 +1,189 @@ +### YamlMime:PythonClass +uid: azure.datalake.store.multithread.ADLDownloader +name: ADLDownloader +fullName: azure.datalake.store.multithread.ADLDownloader +module: azure.datalake.store.multithread +summary: 'Download remote file(s) using chunks and threads + + + Launches multiple threads for efficient downloading, with *chunksize* + + assigned to each. The remote path can be a single file, a directory + + of files or a glob pattern.' +constructor: + syntax: ADLDownloader(adlfs, rpath, lpath, nthreads=None, chunksize=268435456, buffersize=4194304, + blocksize=4194304, client=None, run=True, overwrite=False, verbose=False, progress_callback=None, + timeout=0) + parameters: + - name: adlfs + isRequired: true + types: + - > + - name: rpath + description: 'remote path/globstring to use to find remote files. Recursive glob + + patterns using **** are not supported.' + isRequired: true + types: + - + - name: lpath + description: 'local path. If downloading a single file, will write to this specific + + file, unless it is an existing directory, in which case a file is + + created within it. If downloading multiple files, this is the root + + directory to write within. Will create directories as required.' + isRequired: true + types: + - + - name: nthreads + description: Number of threads to use. If None, uses the number of cores. + defaultValue: None + types: + - [] + - name: chunksize + description: 'Number of bytes for a chunk. Large files are split into chunks. + Files + + smaller than this number will always be transferred in a single thread.' + defaultValue: '268435456' + types: + - [] + - name: buffersize + description: 'Ignored in curret implementation. + + Number of bytes for internal buffer. This block cannot be bigger than + + a chunk and cannot be smaller than a block.' + defaultValue: '4194304' + types: + - [] + - name: blocksize + description: 'Number of bytes for a block. Within each chunk, we write a smaller + + block for each API call. This block cannot be bigger than a chunk.' + defaultValue: '4194304' + types: + - [] + - name: client + description: 'Set an instance of ADLTransferClient when finer-grained control + over + + transfer parameters is needed. Ignores *nthreads* and *chunksize* set + + by constructor.' + defaultValue: None + types: + - [] + - name: run + description: Whether to begin executing immediately. + defaultValue: 'True' + types: + - [] + - name: overwrite + description: 'Whether to forcibly overwrite existing files/directories. If False + and + + local path is a directory, will quit regardless if any files would be + + overwritten or not. If True, only matching filenames are actually + + overwritten.' + defaultValue: 'False' + types: + - [] + - name: progress_callback + description: 'Callback for progress with signature function(current, total) where + + current is the number of bytes transfered so far, and total is the + + size of the blob, or None if the total size is unknown.' + defaultValue: None + types: + - [] + - name: timeout + description: 'Default value 0 means infinite timeout. Otherwise time in seconds + before the + + process will stop and raise an exception if transfer is still in progress' + defaultValue: '0' + types: + - () + - name: verbose + defaultValue: 'False' +methods: +- uid: azure.datalake.store.multithread.ADLDownloader.active + name: active + summary: Return whether the downloader is active + signature: active() +- uid: azure.datalake.store.multithread.ADLDownloader.clear_saved + name: clear_saved + summary: Remove references to all persisted downloads. + signature: static clear_saved() +- uid: azure.datalake.store.multithread.ADLDownloader.load + name: load + summary: Load list of persisted transfers from disk, for possible resumption. + signature: static load() + return: + description: "* of \n\n* \ + \ of , ,\ + \ \n\n* can be seen in the status attribute. Instances can be resumed\ + \ with \n\n* `run()`." +- uid: azure.datalake.store.multithread.ADLDownloader.run + name: run + summary: Populate transfer queue and execute downloads + signature: run(nthreads=None, monitor=True) + parameters: + - name: nthreads + description: Override default nthreads, if given + defaultValue: None + types: + - [] + - name: monitor + description: To watch and wait (block) until completion. + defaultValue: 'True' + types: + - [] +- uid: azure.datalake.store.multithread.ADLDownloader.save + name: save + summary: 'Persist this download + + + Saves a copy of this transfer process in its current state to disk. + + This is done automatically for a running transfer, so that as a chunk + + is completed, this is reflected. Thus, if a transfer is interrupted, + + e.g., by user action, the transfer can be restarted at another time. + + All chunks that were not already completed will be restarted at that + + time. + + + See methods `load` to retrieved saved transfers and `run` to + + resume a stopped transfer.' + signature: save(keep=True) + parameters: + - name: keep + description: 'If True, transfer will be saved if some chunks remain to be + + completed; the transfer will be sure to be removed otherwise.' + defaultValue: 'True' + types: + - () +- uid: azure.datalake.store.multithread.ADLDownloader.successful + name: successful + summary: 'Return whether the downloader completed successfully. + + + It will raise AssertionError if the downloader is active.' + signature: successful() +attributes: +- uid: azure.datalake.store.multithread.ADLDownloader.hash + name: hash diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.multithread.ADLUploader.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.multithread.ADLUploader.yml new file mode 100644 index 00000000..2d015d3f --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.multithread.ADLUploader.yml @@ -0,0 +1,186 @@ +### YamlMime:PythonClass +uid: azure.datalake.store.multithread.ADLUploader +name: ADLUploader +fullName: azure.datalake.store.multithread.ADLUploader +module: azure.datalake.store.multithread +summary: 'Upload local file(s) using chunks and threads + + + Launches multiple threads for efficient uploading, with *chunksize* + + assigned to each. The path can be a single file, a directory + + of files or a glob pattern.' +constructor: + syntax: ADLUploader(adlfs, rpath, lpath, nthreads=None, chunksize=268435456, buffersize=4194304, + blocksize=4194304, client=None, run=True, overwrite=False, verbose=False, progress_callback=None, + timeout=0) + parameters: + - name: adlfs + isRequired: true + types: + - > + - name: rpath + description: 'remote path to upload to; if multiple files, this is the dircetory + + root to write within' + isRequired: true + types: + - + - name: lpath + description: 'local path. Can be single file, directory (in which case, upload + + recursively) or glob pattern. Recursive glob patterns using **** are + + not supported.' + isRequired: true + types: + - + - name: nthreads + description: Number of threads to use. If None, uses the number of cores. + defaultValue: None + types: + - [] + - name: chunksize + description: 'Number of bytes for a chunk. Large files are split into chunks. + Files + + smaller than this number will always be transferred in a single thread.' + defaultValue: '268435456' + types: + - [] + - name: buffersize + description: 'Number of bytes for internal buffer. This block cannot be bigger + than + + a chunk and cannot be smaller than a block.' + defaultValue: '4194304' + types: + - [] + - name: blocksize + description: 'Number of bytes for a block. Within each chunk, we write a smaller + + block for each API call. This block cannot be bigger than a chunk.' + defaultValue: '4194304' + types: + - [] + - name: client + description: 'Set an instance of ADLTransferClient when finer-grained control + over + + transfer parameters is needed. Ignores *nthreads* and *chunksize* + + set by constructor.' + defaultValue: None + types: + - [] + - name: run + description: Whether to begin executing immediately. + defaultValue: 'True' + types: + - [] + - name: overwrite + description: 'Whether to forcibly overwrite existing files/directories. If False + and + + remote path is a directory, will quit regardless if any files would be + + overwritten or not. If True, only matching filenames are actually + + overwritten.' + defaultValue: 'False' + types: + - [] + - name: progress_callback + description: 'Callback for progress with signature function(current, total) where + + current is the number of bytes transfered so far, and total is the + + size of the blob, or None if the total size is unknown.' + defaultValue: None + types: + - [] + - name: timeout + description: 'Default value 0 means infinite timeout. Otherwise time in seconds + before the + + process will stop and raise an exception if transfer is still in progress' + defaultValue: '0' + types: + - () + - name: verbose + defaultValue: 'False' +methods: +- uid: azure.datalake.store.multithread.ADLUploader.active + name: active + summary: Return whether the uploader is active + signature: active() +- uid: azure.datalake.store.multithread.ADLUploader.clear_saved + name: clear_saved + summary: Remove references to all persisted uploads. + signature: static clear_saved() +- uid: azure.datalake.store.multithread.ADLUploader.load + name: load + summary: Load list of persisted transfers from disk, for possible resumption. + signature: static load() + return: + description: "* of \n\n* of\ + \ , ,\ + \ \n\n* can be seen in the status attribute. Instances can be resumed\ + \ with \n\n* `run()`." +- uid: azure.datalake.store.multithread.ADLUploader.run + name: run + summary: Populate transfer queue and execute downloads + signature: run(nthreads=None, monitor=True) + parameters: + - name: nthreads + description: Override default nthreads, if given + defaultValue: None + types: + - [] + - name: monitor + description: To watch and wait (block) until completion. + defaultValue: 'True' + types: + - [] +- uid: azure.datalake.store.multithread.ADLUploader.save + name: save + summary: 'Persist this upload + + + Saves a copy of this transfer process in its current state to disk. + + This is done automatically for a running transfer, so that as a chunk + + is completed, this is reflected. Thus, if a transfer is interrupted, + + e.g., by user action, the transfer can be restarted at another time. + + All chunks that were not already completed will be restarted at that + + time. + + + See methods `load` to retrieved saved transfers and `run` to + + resume a stopped transfer.' + signature: save(keep=True) + parameters: + - name: keep + description: 'If True, transfer will be saved if some chunks remain to be + + completed; the transfer will be sure to be removed otherwise.' + defaultValue: 'True' + types: + - () +- uid: azure.datalake.store.multithread.ADLUploader.successful + name: successful + summary: 'Return whether the uploader completed successfully. + + + It will raise AssertionError if the uploader is active.' + signature: successful() +attributes: +- uid: azure.datalake.store.multithread.ADLUploader.hash + name: hash diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.multithread.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.multithread.yml new file mode 100644 index 00000000..efac0bbc --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.multithread.yml @@ -0,0 +1,107 @@ +### YamlMime:PythonModule +uid: azure.datalake.store.multithread +name: multithread +fullName: azure.datalake.store.multithread +summary: 'High performance multi-threaded module to up/download + + + + Calls method in `core` with thread pool executor to ensure the network + + is used to its maximum throughput. + + + + Only implements upload and download of (massive) files and directory trees.' +functions: +- uid: azure.datalake.store.multithread.get_chunk + name: get_chunk + summary: 'Download a piece of a remote file and write locally + + + Internal function used by *download*.' + signature: get_chunk(adlfs, src, dst, offset, size, buffersize, blocksize, shutdown_event=None, + retries=10, delay=0.01, backoff=3) + parameters: + - name: adlfs + isRequired: true + - name: src + isRequired: true + - name: dst + isRequired: true + - name: offset + isRequired: true + - name: size + isRequired: true + - name: buffersize + isRequired: true + - name: blocksize + isRequired: true + - name: shutdown_event + defaultValue: None + - name: retries + defaultValue: '10' + - name: delay + defaultValue: '0.01' + - name: backoff + defaultValue: '3' +- uid: azure.datalake.store.multithread.load + name: load + signature: load(filename) + parameters: + - name: filename + isRequired: true +- uid: azure.datalake.store.multithread.merge_chunks + name: merge_chunks + signature: merge_chunks(adlfs, outfile, files, shutdown_event=None, overwrite=False) + parameters: + - name: adlfs + isRequired: true + - name: outfile + isRequired: true + - name: files + isRequired: true + - name: shutdown_event + defaultValue: None + - name: overwrite + defaultValue: 'False' +- uid: azure.datalake.store.multithread.put_chunk + name: put_chunk + summary: 'Upload a piece of a local file + + + Internal function used by *upload*.' + signature: put_chunk(adlfs, src, dst, offset, size, buffersize, blocksize, delimiter=None, + shutdown_event=None) + parameters: + - name: adlfs + isRequired: true + - name: src + isRequired: true + - name: dst + isRequired: true + - name: offset + isRequired: true + - name: size + isRequired: true + - name: buffersize + isRequired: true + - name: blocksize + isRequired: true + - name: delimiter + defaultValue: None + - name: shutdown_event + defaultValue: None +- uid: azure.datalake.store.multithread.save + name: save + signature: save(instance, filename, keep=True) + parameters: + - name: instance + isRequired: true + - name: filename + isRequired: true + - name: keep + defaultValue: 'True' +classes: +- azure.datalake.store.multithread.ADLDownloader +- azure.datalake.store.multithread.ADLUploader diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.retry.ExponentialRetryPolicy.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.retry.ExponentialRetryPolicy.yml new file mode 100644 index 00000000..28e4b122 --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.retry.ExponentialRetryPolicy.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.datalake.store.retry.ExponentialRetryPolicy +name: ExponentialRetryPolicy +fullName: azure.datalake.store.retry.ExponentialRetryPolicy +module: azure.datalake.store.retry +constructor: + syntax: ExponentialRetryPolicy(max_retries=None, exponential_retry_interval=None, + exponential_factor=None) + parameters: + - name: max_retries + defaultValue: None + - name: exponential_retry_interval + defaultValue: None + - name: exponential_factor + defaultValue: None +methods: +- uid: azure.datalake.store.retry.ExponentialRetryPolicy.should_retry + name: should_retry + signature: should_retry(response, last_exception, retry_count) + parameters: + - name: response + isRequired: true + - name: last_exception + isRequired: true + - name: retry_count + isRequired: true diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.retry.NoRetryPolicy.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.retry.NoRetryPolicy.yml new file mode 100644 index 00000000..41cc9581 --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.retry.NoRetryPolicy.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonClass +uid: azure.datalake.store.retry.NoRetryPolicy +name: NoRetryPolicy +fullName: azure.datalake.store.retry.NoRetryPolicy +module: azure.datalake.store.retry +constructor: + syntax: NoRetryPolicy() +methods: +- uid: azure.datalake.store.retry.NoRetryPolicy.should_retry + name: should_retry + signature: should_retry(*args) diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.retry.RetryPolicy.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.retry.RetryPolicy.yml new file mode 100644 index 00000000..5a530203 --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.retry.RetryPolicy.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonClass +uid: azure.datalake.store.retry.RetryPolicy +name: RetryPolicy +fullName: azure.datalake.store.retry.RetryPolicy +module: azure.datalake.store.retry +constructor: + syntax: RetryPolicy() +methods: +- uid: azure.datalake.store.retry.RetryPolicy.should_retry + name: should_retry + signature: should_retry(*args) diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.retry.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.retry.yml new file mode 100644 index 00000000..032dc780 --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.retry.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonModule +uid: azure.datalake.store.retry +name: retry +fullName: azure.datalake.store.retry +summary: Provides implementation of different Retry Policies +classes: +- azure.datalake.store.retry.ExponentialRetryPolicy +- azure.datalake.store.retry.NoRetryPolicy +- azure.datalake.store.retry.RetryPolicy diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.ADLTransferClient.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.ADLTransferClient.yml new file mode 100644 index 00000000..19dcabce --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.ADLTransferClient.yml @@ -0,0 +1,303 @@ +### YamlMime:PythonClass +uid: azure.datalake.store.transfer.ADLTransferClient +name: ADLTransferClient +fullName: azure.datalake.store.transfer.ADLTransferClient +module: azure.datalake.store.transfer +summary: "Client for transferring data from/to Azure DataLake Store\n\nThis is intended\ + \ as the underlying class for *ADLDownloader* and\n*ADLUploader*. If necessary,\ + \ it can be used directly for additional\ncontrol.\n\n:param :\n:param *fn(adlfs:\n\ + :param src:\n:param dst:\n:param offset:\n:param size:\n:param buffersize:\n:param\ + \ blocksize:\n:param shutdown_event)*.:\n:param *adlfs* is the ADL filesystem instance.\ + \ *src* and *dst* refer to the source:\n:param and destination of the respective\ + \ file transfer. *offset* is the location:\n:param in *src* to read *size* bytes\ + \ from. *buffersize* is the number of bytes:\n:param used for internal buffering\ + \ before transfer. *blocksize* is the number of:\n:param bytes in a chunk to write\ + \ at one time. The callable should return an:\n:param integer representing the number\ + \ of bytes written.:\n:param The *merge* callable has the function signature:\n\ + :param :\n:param *fn(adlfs:\n:param outfile:\n:param files:\n:param shutdown_event)*.\ + \ *adlfs* is the ADL filesystem:\n:param instance. *outfile* is the result of merging\ + \ *files*.:\n:param For both transfer callables:\n:param *shutdown_event* is optional.\ + \ In particular:\n:param :\n:param *shutdown_event* is a *threading.Event* that\ + \ is passed to the callable.:\n:param The event will be set when a shutdown is requested.\ + \ It is good practice:\n:param to listen for this.:\n:param Internal State:\n:param\ + \ \u2014\u2014\u2014\u2014\u2013:\n:param self._fstates: This captures the current\ + \ state of each transferred file.\n:type self._fstates: \n\ + :param self._files: Using a tuple of the file source/destination as the key, this\n\ + \n dictionary stores the file metadata and all chunk states. The\n dictionary\ + \ key is *(src, dst)* and the value is\n *dict(length, cstates, exception)*." +constructor: + syntax: ADLTransferClient(adlfs, transfer, merge=None, nthreads=None, chunksize=268435456, + blocksize=33554432, chunked=True, unique_temporary=True, delimiter=None, parent=None, + verbose=False, buffersize=33554432, progress_callback=None, timeout=0) + parameters: + - name: adlfs + isRequired: true + types: + - > + - name: name + description: Unique ID used for persistence. + isRequired: true + types: + - + - name: transfer + description: 'Function or callable object invoked when transferring chunks. See + + `Function Signatures`.' + isRequired: true + types: + - + - name: merge + description: 'Function or callable object invoked when merging chunks. For each + file + + containing only one chunk, no merge function will be called, even if + + provided. If None, then merging is skipped. See + + `Function Signatures`.' + defaultValue: None + types: + - [] + - name: nthreads + description: 'Number of threads to use (minimum is 1). If None, uses the number + of + + cores.' + defaultValue: None + types: + - [] + - name: chunksize + description: 'Number of bytes for a chunk. Large files are split into chunks. + Files + + smaller than this number will always be transferred in a single thread.' + defaultValue: '268435456' + types: + - [] + - name: buffersize + description: 'Number of bytes for internal buffer. This block cannot be bigger + than + + a chunk and cannot be smaller than a block.' + defaultValue: '33554432' + types: + - [] + - name: blocksize + description: 'Number of bytes for a block. Within each chunk, we write a smaller + + block for each API call. This block cannot be bigger than a chunk.' + defaultValue: '33554432' + types: + - [] + - name: chunked + description: 'If set, each transferred chunk is stored in a separate file until + + chunks are gathered into a single file. Otherwise, each chunk will be + + written into the same destination file.' + defaultValue: 'True' + types: + - [] + - name: unique_temporary + description: 'If set, transferred chunks are written into a unique temporary + + directory.' + defaultValue: 'True' + types: + - [] + - name: persist_path + description: 'Path used for persisting a client''s state. If None, then *save()* + + and *load()* will be empty operations.' + isRequired: true + types: + - [] + - name: delimiter + description: 'If set, will transfer blocks using delimiters, as well as split + + files for transferring on that delimiter.' + defaultValue: None + types: + - () + - + - name: parent + description: 'In typical usage, the transfer client is created in the context + of an + + upload or download, which can be persisted between sessions.' + defaultValue: None + types: + - , + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) where + + current is the number of bytes transferred so far, and total is the + + size of the blob, or None if the total size is unknown.' + defaultValue: None + types: + - [] + - name: timeout + description: 'Default value 0 means infinite timeout. Otherwise time in seconds + before the + + process will stop and raise an exception if transfer is still in progress' + defaultValue: '0' + types: + - () + - name: Files + isRequired: true + types: + - + - name: '---------------' + isRequired: true + - name: available + isRequired: true + types: + - > + - name: temporary + isRequired: true + types: + - > + - name: in + isRequired: true + types: + - > + - name: pseudo-BNF + isRequired: true + - name: '{dirname}/{basename}.segments[.{unique_str}]/{basename}_{offset}' + isRequired: true + types: + - >> >> + - name: Signatures + isRequired: true + types: + - + - name: '-------------------' + isRequired: true + - name: client + isRequired: true + types: + - > + - name: two + isRequired: true + types: + - > + - name: callables + isRequired: true + - name: provided + isRequired: true + types: + - > + - name: the + isRequired: true + types: + - + - name: skipped. + isRequired: true + types: + - > + - name: signature + isRequired: true + types: + - > + - name: self._chunks + description: 'Using a tuple of the chunk name/offset as the key, this dictionary + + stores the chunk metadata and has a reference to the chunk''s parent + + file. The dictionary key is *(name, offset)* and the value is + + *dict(parent=(src, dst), expected, actual, exception)*.' + isRequired: true + types: + - + - name: self._ffutures + description: 'Using a Future object as the key, this dictionary provides a reverse + + lookup for the file associated with the given future. The returned + + value is the file''s primary key, *(src, dst)*.' + isRequired: true + types: + - + - name: self._cfutures + description: 'Using a Future object as the key, this dictionary provides a reverse + + lookup for the chunk associated with the given future. The returned + + value is the chunk''s primary key, *(name, offset)*.' + isRequired: true + types: + - + - name: verbose + defaultValue: 'False' +methods: +- uid: azure.datalake.store.transfer.ADLTransferClient.monitor + name: monitor + summary: Wait for download to happen + signature: monitor(poll=0.1, timeout=0) + parameters: + - name: poll + defaultValue: '0.1' + - name: timeout + defaultValue: '0' +- uid: azure.datalake.store.transfer.ADLTransferClient.run + name: run + signature: run(nthreads=None, monitor=True, before_start=None) + parameters: + - name: nthreads + defaultValue: None + - name: monitor + defaultValue: 'True' + - name: before_start + defaultValue: None +- uid: azure.datalake.store.transfer.ADLTransferClient.save + name: save + signature: save(keep=True) + parameters: + - name: keep + defaultValue: 'True' +- uid: azure.datalake.store.transfer.ADLTransferClient.shutdown + name: shutdown + summary: 'Shutdown task threads in an orderly fashion. + + + Within the context of this method, we disable Ctrl+C keystroke events + + until all threads have exited. We re-enable Ctrl+C keystroke events + + before leaving.' + signature: shutdown() +- uid: azure.datalake.store.transfer.ADLTransferClient.submit + name: submit + summary: 'Split a given file into chunks. + + + All submitted files/chunks start in the *pending* state until *run()* + + is called.' + signature: submit(src, dst, length) + parameters: + - name: src + isRequired: true + - name: dst + isRequired: true + - name: length + isRequired: true +attributes: +- uid: azure.datalake.store.transfer.ADLTransferClient.active + name: active + summary: Return whether the transfer is active +- uid: azure.datalake.store.transfer.ADLTransferClient.progress + name: progress + summary: Return a summary of all transferred file/chunks +- uid: azure.datalake.store.transfer.ADLTransferClient.status + name: status +- uid: azure.datalake.store.transfer.ADLTransferClient.successful + name: successful + summary: 'Return whether the transfer completed successfully. + + + It will raise AssertionError if the transfer is active.' diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.Chunk.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.Chunk.yml new file mode 100644 index 00000000..8dd127bb --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.Chunk.yml @@ -0,0 +1,42 @@ +### YamlMime:PythonClass +uid: azure.datalake.store.transfer.Chunk +name: Chunk +fullName: azure.datalake.store.transfer.Chunk +module: azure.datalake.store.transfer +summary: Create new instance of Chunk(name, state, offset, expected, actual, exception) +constructor: + syntax: Chunk(name, state, offset, expected, actual, exception) + parameters: + - name: _cls + isRequired: true + - name: name + isRequired: true + - name: state + isRequired: true + - name: offset + isRequired: true + - name: expected + isRequired: true + - name: actual + isRequired: true + - name: exception + isRequired: true +attributes: +- uid: azure.datalake.store.transfer.Chunk.actual + name: actual + summary: Alias for field number 4 +- uid: azure.datalake.store.transfer.Chunk.exception + name: exception + summary: Alias for field number 5 +- uid: azure.datalake.store.transfer.Chunk.expected + name: expected + summary: Alias for field number 3 +- uid: azure.datalake.store.transfer.Chunk.name + name: name + summary: Alias for field number 0 +- uid: azure.datalake.store.transfer.Chunk.offset + name: offset + summary: Alias for field number 2 +- uid: azure.datalake.store.transfer.Chunk.state + name: state + summary: Alias for field number 1 diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.File.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.File.yml new file mode 100644 index 00000000..48ab823e --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.File.yml @@ -0,0 +1,42 @@ +### YamlMime:PythonClass +uid: azure.datalake.store.transfer.File +name: File +fullName: azure.datalake.store.transfer.File +module: azure.datalake.store.transfer +summary: Create new instance of File(src, dst, state, length, chunks, exception) +constructor: + syntax: File(src, dst, state, length, chunks, exception) + parameters: + - name: _cls + isRequired: true + - name: src + isRequired: true + - name: dst + isRequired: true + - name: state + isRequired: true + - name: length + isRequired: true + - name: chunks + isRequired: true + - name: exception + isRequired: true +attributes: +- uid: azure.datalake.store.transfer.File.chunks + name: chunks + summary: Alias for field number 4 +- uid: azure.datalake.store.transfer.File.dst + name: dst + summary: Alias for field number 1 +- uid: azure.datalake.store.transfer.File.exception + name: exception + summary: Alias for field number 5 +- uid: azure.datalake.store.transfer.File.length + name: length + summary: Alias for field number 3 +- uid: azure.datalake.store.transfer.File.src + name: src + summary: Alias for field number 0 +- uid: azure.datalake.store.transfer.File.state + name: state + summary: Alias for field number 2 diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.StateManager.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.StateManager.yml new file mode 100644 index 00000000..1416eb20 --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.StateManager.yml @@ -0,0 +1,51 @@ +### YamlMime:PythonClass +uid: azure.datalake.store.transfer.StateManager +name: StateManager +fullName: azure.datalake.store.transfer.StateManager +module: azure.datalake.store.transfer +summary: 'Manages state for any hashable object. + + + When tracking multiple files and their chunks, each file/chunk can be in + + any valid state for that particular type. + + + At the simplest level, we need to set and retrieve an object''s current + + state, while only allowing valid states to be used. In addition, we also + + need to give statistics about a group of objects (are all objects in one + + state? how many objects are in each available state?).' +constructor: + syntax: StateManager(*states) + parameters: + - name: states + description: Managed objects can only use these defined states. + isRequired: true + types: + - of +examples: +- "\n```\n\n>>> StateManager('draft', 'review', 'complete') \n\n>>> mgr = StateManager('off', 'on')\n>>> mgr['foo'] = 'on'\n\ + >>> mgr['bar'] = 'off'\n>>> mgr['quux'] = 'on'\n>>> mgr \n\n>>> mgr.contains_all('on')\nFalse\n>>> mgr['bar'] = 'on'\n>>> mgr.contains_all('on')\n\ + True\n>>> mgr.contains_none('off')\nTrue\n```\n\nInternal class used by *ADLTransferClient*.\n" +methods: +- uid: azure.datalake.store.transfer.StateManager.contains_all + name: contains_all + summary: Return whether all managed objects are in the given state + signature: contains_all(state) + parameters: + - name: state + isRequired: true +- uid: azure.datalake.store.transfer.StateManager.contains_none + name: contains_none + summary: Return whether no managed objects are in the given states + signature: contains_none(*states) +attributes: +- uid: azure.datalake.store.transfer.StateManager.objects + name: objects +- uid: azure.datalake.store.transfer.StateManager.states + name: states diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.yml new file mode 100644 index 00000000..b225a59a --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonModule +uid: azure.datalake.store.transfer +name: transfer +fullName: azure.datalake.store.transfer +summary: Low-level classes for managing data transfer. +classes: +- azure.datalake.store.transfer.ADLTransferClient +- azure.datalake.store.transfer.Chunk +- azure.datalake.store.transfer.File +- azure.datalake.store.transfer.StateManager diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.utils.CountUpDownLatch.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.utils.CountUpDownLatch.yml new file mode 100644 index 00000000..7fdfcb20 --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.utils.CountUpDownLatch.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.datalake.store.utils.CountUpDownLatch +name: CountUpDownLatch +fullName: azure.datalake.store.utils.CountUpDownLatch +module: azure.datalake.store.utils +summary: CountUpDownLatch provides a thread safe implementation of Up Down latch +constructor: + syntax: CountUpDownLatch() +methods: +- uid: azure.datalake.store.utils.CountUpDownLatch.decrement + name: decrement + signature: decrement() +- uid: azure.datalake.store.utils.CountUpDownLatch.increment + name: increment + signature: increment() +- uid: azure.datalake.store.utils.CountUpDownLatch.is_zero + name: is_zero + signature: is_zero() +- uid: azure.datalake.store.utils.CountUpDownLatch.total_processed + name: total_processed + signature: total_processed() diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.utils.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.utils.yml new file mode 100644 index 00000000..f208fed4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.utils.yml @@ -0,0 +1,204 @@ +### YamlMime:PythonModule +uid: azure.datalake.store.utils +name: utils +fullName: azure.datalake.store.utils +functions: +- uid: azure.datalake.store.utils.clamp + name: clamp + summary: 'Limit a value to a given range + + + This is equivalent to smallest <= n <= largest.' + signature: clamp(n, smallest, largest) + parameters: + - name: n + isRequired: true + - name: smallest + isRequired: true + - name: largest + isRequired: true + examples: + - ' + + ``` + + + >>> clamp(0, 1, 100) + + 1 + + ``` + + + + ``` + + + >>> clamp(42, 2, 128) + + 42 + + ``` + + + + ``` + + + >>> clamp(1024, 1, 32) + + 32 + + ``` + + ' +- uid: azure.datalake.store.utils.commonprefix + name: commonprefix + summary: 'Find common directory for all paths + + + Python''s `os.path.commonprefix` will not return a valid directory path in + + some cases, so we wrote this convenience method.' + signature: commonprefix(paths) + parameters: + - name: paths + isRequired: true + examples: + - ' + + ``` + + + >>> # os.path.commonprefix returns ''/disk1/foo'' + + >>> commonprefix([''/disk1/foobar'', ''/disk1/foobaz'']) + + ''/disk1'' + + ``` + + + + ``` + + + >>> commonprefix([''a/b/c'', ''a/b/d'', ''a/c/d'']) + + ''a'' + + ``` + + + + ``` + + + >>> commonprefix([''a/b/c'', ''d/e/f'', ''g/h/i'']) + + '''' + + ``` + + ' +- uid: azure.datalake.store.utils.ensure_writable + name: ensure_writable + signature: ensure_writable(b) + parameters: + - name: b + isRequired: true +- uid: azure.datalake.store.utils.read_block + name: read_block + summary: Read a block of bytes from a file + signature: read_block(f, offset, length, delimiter=None) + parameters: + - name: fn + description: a file object that supports seek, tell and read. + isRequired: true + types: + - > + - name: offset + description: Byte offset to start read + isRequired: true + types: + - + - name: length + description: Maximum number of bytes to read + isRequired: true + types: + - + - name: delimiter + description: Ensure reading stops at delimiter bytestring + defaultValue: None + types: + - () + - name: read + isRequired: true + types: + - > + - name: location + isRequired: true + types: + - > + - > + - name: ADL + isRequired: true + types: + - > + - name: data + isRequired: true + types: + - > + - name: raised + isRequired: true + types: + - 4MB an exception is>> + - name: cannot + isRequired: true + types: + - > + - name: ADL. + isRequired: true + types: + - > + - name: the + isRequired: true + types: + - > + - name: string. + isRequired: true + types: + - > + - name: f + isRequired: true + examples: + - "\n```\n\n>>> from io import BytesIO \n>>> f = BytesIO(b'Alice, 100\\nBob, 200\\\ + nCharlie, 300') \n>>> read_block(f, 0, 13) \nb'Alice, 100\\nBo'\n```\n\n\n```\n\ + \n>>> read_block(f, 0, 13, delimiter=b'\\n') \nb'Alice, 100\\n'\n```\n\n\n```\n\ + \n>>> read_block(f, 10, 10, delimiter=b'\\n') \nb'\\nCharlie, 300'\n>>> f =\ + \ BytesIO(bytearray(2**22)) \n>>> read_block(f,0,2**22, delimiter=b'\\n') \n\ + IndexError: No delimiter found within max record size of 4MB.\nTransfer without\ + \ specifying a delimiter (as binary) instead.\n```\n" +- uid: azure.datalake.store.utils.tokenize + name: tokenize + summary: 'Deterministic token + + + ``` + + + >>> tokenize(''Hello'') == tokenize(''Hello'') + + True + + ```' + signature: tokenize(*args, **kwargs) +- uid: azure.datalake.store.utils.write_stdout + name: write_stdout + summary: Write bytes or strings to standard output + signature: write_stdout(data) + parameters: + - name: data + isRequired: true +classes: +- azure.datalake.store.utils.CountUpDownLatch diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.yml new file mode 100644 index 00000000..2dde6973 --- /dev/null +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonPackage +uid: azure.datalake.store +name: store +fullName: azure.datalake.store +type: rootImport +modules: +- azure.datalake.store.core +- azure.datalake.store.enums +- azure.datalake.store.exceptions +- azure.datalake.store.lib +- azure.datalake.store.multiprocessor +- azure.datalake.store.multithread +- azure.datalake.store.retry +- azure.datalake.store.transfer +- azure.datalake.store.utils diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.GraphRbacManagementClient.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.GraphRbacManagementClient.yml new file mode 100644 index 00000000..f5ab0d8a --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.GraphRbacManagementClient.yml @@ -0,0 +1,70 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.GraphRbacManagementClient +name: GraphRbacManagementClient +fullName: azure.graphrbac.GraphRbacManagementClient +module: azure.graphrbac +summary: The Graph RBAC Management Client +constructor: + syntax: GraphRbacManagementClient(credentials, tenant_id, base_url=None) + parameters: + - name: credentials + description: Credentials needed for the client to connect to Azure. + isRequired: true + types: + - + - name: tenant_id + description: The tenant ID. + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +- description: SignedInUser operations + name: signed_in_user + types: + - +- description: Applications operations + name: applications + types: + - +- description: DeletedApplications operations + name: deleted_applications + types: + - +- description: Groups operations + name: groups + types: + - +- description: ServicePrincipals operations + name: service_principals + types: + - +- description: Users operations + name: users + types: + - +- description: Objects operations + name: objects + types: + - +- description: Domains operations + name: domains + types: + - +- description: OAuth2PermissionGrant operations + name: oauth2_permission_grant + types: + - +methods: +- uid: azure.graphrbac.GraphRbacManagementClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.graph_rbac_management_client.GraphRbacManagementClient.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.graph_rbac_management_client.GraphRbacManagementClient.yml new file mode 100644 index 00000000..8d7e6c3b --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.graph_rbac_management_client.GraphRbacManagementClient.yml @@ -0,0 +1,70 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.graph_rbac_management_client.GraphRbacManagementClient +name: GraphRbacManagementClient +fullName: azure.graphrbac.graph_rbac_management_client.GraphRbacManagementClient +module: azure.graphrbac.graph_rbac_management_client +summary: The Graph RBAC Management Client +constructor: + syntax: GraphRbacManagementClient(credentials, tenant_id, base_url=None) + parameters: + - name: credentials + description: Credentials needed for the client to connect to Azure. + isRequired: true + types: + - + - name: tenant_id + description: The tenant ID. + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +- description: SignedInUser operations + name: signed_in_user + types: + - +- description: Applications operations + name: applications + types: + - +- description: DeletedApplications operations + name: deleted_applications + types: + - +- description: Groups operations + name: groups + types: + - +- description: ServicePrincipals operations + name: service_principals + types: + - +- description: Users operations + name: users + types: + - +- description: Objects operations + name: objects + types: + - +- description: Domains operations + name: domains + types: + - +- description: OAuth2PermissionGrant operations + name: oauth2_permission_grant + types: + - +methods: +- uid: azure.graphrbac.graph_rbac_management_client.GraphRbacManagementClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.graph_rbac_management_client.GraphRbacManagementClientConfiguration.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.graph_rbac_management_client.GraphRbacManagementClientConfiguration.yml new file mode 100644 index 00000000..f578518a --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.graph_rbac_management_client.GraphRbacManagementClientConfiguration.yml @@ -0,0 +1,69 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.graph_rbac_management_client.GraphRbacManagementClientConfiguration +name: GraphRbacManagementClientConfiguration +fullName: azure.graphrbac.graph_rbac_management_client.GraphRbacManagementClientConfiguration +module: azure.graphrbac.graph_rbac_management_client +summary: 'Configuration for GraphRbacManagementClient + + Note that all parameters used to create this instance are saved as instance + + attributes.' +constructor: + syntax: GraphRbacManagementClientConfiguration(credentials, tenant_id, base_url=None) + parameters: + - name: credentials + description: Credentials needed for the client to connect to Azure. + isRequired: true + types: + - + - name: tenant_id + description: The tenant ID. + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - +methods: +- uid: azure.graphrbac.graph_rbac_management_client.GraphRbacManagementClientConfiguration.add_user_agent + name: add_user_agent + summary: Add value to current user agent with a space. + signature: 'add_user_agent(value: str) -> None' + parameters: + - name: value + description: value to add to user agent. + isRequired: true + types: + - +- uid: azure.graphrbac.graph_rbac_management_client.GraphRbacManagementClientConfiguration.load + name: load + summary: Load configuration from existing file. + signature: load(filepath) + parameters: + - name: filepath + description: Path to existing config file. + isRequired: true + types: + - + exceptions: + - type: ValueError if supplied config file is invalid. +- uid: azure.graphrbac.graph_rbac_management_client.GraphRbacManagementClientConfiguration.save + name: save + summary: Save current configuration to file. + signature: save(filepath) + parameters: + - name: filepath + description: Path to save file to. + isRequired: true + types: + - + exceptions: + - type: ValueError if supplied filepath cannot be written to. +attributes: +- uid: azure.graphrbac.graph_rbac_management_client.GraphRbacManagementClientConfiguration.enable_http_logger + name: enable_http_logger +- uid: azure.graphrbac.graph_rbac_management_client.GraphRbacManagementClientConfiguration.user_agent + name: user_agent + summary: The current user agent value. diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.graph_rbac_management_client.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.graph_rbac_management_client.yml new file mode 100644 index 00000000..70b6c639 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.graph_rbac_management_client.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.graph_rbac_management_client +name: graph_rbac_management_client +fullName: azure.graphrbac.graph_rbac_management_client +classes: +- azure.graphrbac.graph_rbac_management_client.GraphRbacManagementClient +- azure.graphrbac.graph_rbac_management_client.GraphRbacManagementClientConfiguration diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ADGroup.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ADGroup.yml new file mode 100644 index 00000000..3b8a1063 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ADGroup.yml @@ -0,0 +1,190 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.ADGroup +name: ADGroup +fullName: azure.graphrbac.models.ADGroup +module: azure.graphrbac.models +summary: 'Active Directory group information. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ADGroup(*, additional_properties=None, display_name: str = None, mail_enabled: + bool = None, mail_nickname: str = None, security_enabled: bool = None, mail: str + = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: object_type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: display_name + description: The display name of the group. + isRequired: true + types: + - + - name: mail_enabled + description: 'Whether the group is mail-enabled. Must be false. + + This is because only pure security groups can be created using the Graph + + API.' + isRequired: true + types: + - + - name: mail_nickname + description: The mail alias for the group. + isRequired: true + types: + - + - name: security_enabled + description: Whether the group is security-enable. + isRequired: true + types: + - + - name: mail + description: The primary email address of the group. + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: display_name + isRequired: true + - name: mail_enabled + isRequired: true + - name: mail_nickname + isRequired: true + - name: security_enabled + isRequired: true + - name: mail + isRequired: true +variables: +- description: The object ID. + name: object_id + types: + - +- description: 'The time at which the directory object was + + deleted.' + name: deletion_timestamp + types: + - +methods: +- uid: azure.graphrbac.models.ADGroup.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ADGroup.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ADGroup.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.ADGroup.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ADGroup.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.ADGroup.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ADGroup.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ADGroupPaged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ADGroupPaged.yml new file mode 100644 index 00000000..80e3bf06 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ADGroupPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.ADGroupPaged +name: ADGroupPaged +fullName: azure.graphrbac.models.ADGroupPaged +module: azure.graphrbac.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: ADGroupPaged(*args, **kwargs) +methods: +- uid: azure.graphrbac.models.ADGroupPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.graphrbac.models.ADGroupPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.graphrbac.models.ADGroupPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.ADGroupPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.ADGroupPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.graphrbac.models.ADGroupPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.graphrbac.models.ADGroupPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.AddOwnerParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.AddOwnerParameters.yml new file mode 100644 index 00000000..97ac86e6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.AddOwnerParameters.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.AddOwnerParameters +name: AddOwnerParameters +fullName: azure.graphrbac.models.AddOwnerParameters +module: azure.graphrbac.models +summary: 'Request parameters for adding a owner to an application. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AddOwnerParameters(*, url: str, additional_properties=None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: url + description: 'Required. A owner object URL, such as + + "[https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd](https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd)", + + where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and + + "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the owner (user, + + application, servicePrincipal, group) to be added.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: url + isRequired: true + - name: additional_properties + isRequired: true +methods: +- uid: azure.graphrbac.models.AddOwnerParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.AddOwnerParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.AddOwnerParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.AddOwnerParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.AddOwnerParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.AddOwnerParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.AddOwnerParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.AppRole.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.AppRole.yml new file mode 100644 index 00000000..9775500a --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.AppRole.yml @@ -0,0 +1,178 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.AppRole +name: AppRole +fullName: azure.graphrbac.models.AppRole +module: azure.graphrbac.models +summary: AppRole. +constructor: + syntax: 'AppRole(*, id: str = None, allowed_member_types=None, description: str + = None, display_name: str = None, is_enabled: bool = None, value: str = None, + **kwargs)' + parameters: + - name: id + description: Unique role identifier inside the appRoles collection. + isRequired: true + types: + - + - name: allowed_member_types + description: 'Specifies whether this app role definition + + can be assigned to users and groups by setting to ''User'', or to other + + applications (that are accessing this application in daemon service + + scenarios) by setting to ''Application'', or to both.' + isRequired: true + types: + - [] + - name: description + description: 'Permission help text that appears in the admin app + + assignment and consent experiences.' + isRequired: true + types: + - + - name: display_name + description: 'Display name for the permission that appears in the + + admin consent and app assignment experiences.' + isRequired: true + types: + - + - name: is_enabled + description: 'When creating or updating a role definition, this must + + be set to true (which is the default). To delete a role, this must first + + be set to false. At that point, in a subsequent call, this role may be + + removed.' + isRequired: true + types: + - + - name: value + description: 'Specifies the value of the roles claim that the application + + should expect in the authentication and access tokens.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: allowed_member_types + isRequired: true + - name: description + isRequired: true + - name: display_name + isRequired: true + - name: is_enabled + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.graphrbac.models.AppRole.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.AppRole.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.AppRole.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.AppRole.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.AppRole.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.AppRole.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.AppRole.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.Application(class).yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.Application(class).yml new file mode 100644 index 00000000..286aa41d --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.Application(class).yml @@ -0,0 +1,447 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.Application +name: Application +fullName: azure.graphrbac.models.Application +module: azure.graphrbac.models +summary: 'Active Directory application information. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Application(*, additional_properties=None, app_id: str = None, allow_guests_sign_in: + bool = None, allow_passthrough_users: bool = None, app_logo_url: str = None, app_roles=None, + app_permissions=None, available_to_other_tenants: bool = None, display_name: str + = None, error_url: str = None, group_membership_claims=None, homepage: str = None, + identifier_uris=None, informational_urls=None, is_device_only_auth_supported: + bool = None, key_credentials=None, known_client_applications=None, logout_url: + str = None, oauth2_allow_implicit_flow: bool = None, oauth2_allow_url_path_matching: + bool = None, oauth2_permissions=None, oauth2_require_post_response: bool = None, + org_restrictions=None, optional_claims=None, password_credentials=None, pre_authorized_applications=None, + public_client: bool = None, publisher_domain: str = None, reply_urls=None, required_resource_access=None, + saml_metadata_url: str = None, sign_in_audience: str = None, www_homepage: str + = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: object_type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: allow_guests_sign_in + description: 'A property on the application to indicate if + + the application accepts other IDPs or not or partially accepts.' + isRequired: true + types: + - + - name: allow_passthrough_users + description: 'Indicates that the application supports + + pass through users who have no presence in the resource tenant.' + isRequired: true + types: + - + - name: app_logo_url + description: 'The url for the application logo image stored in a + + CDN.' + isRequired: true + types: + - + - name: app_roles + description: 'The collection of application roles that an application + + may declare. These roles can be assigned to users, groups or service + + principals.' + isRequired: true + types: + - [] + - name: app_permissions + description: The application permissions. + isRequired: true + types: + - [] + - name: available_to_other_tenants + description: 'Whether the application is available to + + other tenants.' + isRequired: true + types: + - + - name: display_name + description: The display name of the application. + isRequired: true + types: + - + - name: error_url + description: 'A URL provided by the author of the application to + + report errors when using the application.' + isRequired: true + types: + - + - name: group_membership_claims + description: 'Configures the groups claim issued in a + + user or OAuth 2.0 access token that the app expects.' + isRequired: true + types: + - + - name: homepage + description: The home page of the application. + isRequired: true + types: + - + - name: identifier_uris + description: A collection of URIs for the application. + isRequired: true + types: + - [] + - name: informational_urls + description: 'URLs with more information about the + + application.' + isRequired: true + types: + - + - name: is_device_only_auth_supported + description: 'Specifies whether this application + + supports device authentication without a user. The default is false.' + isRequired: true + types: + - + - name: key_credentials + description: A collection of KeyCredential objects. + isRequired: true + types: + - [] + - name: known_client_applications + description: 'Client applications that are tied to + + this resource application. Consent to any of the known client applications + + will result in implicit consent to the resource application through a + + combined consent dialog (showing the OAuth permission scopes required by + + the client and the resource).' + isRequired: true + types: + - [] + - name: logout_url + description: the url of the logout page + isRequired: true + types: + - + - name: oauth2_allow_implicit_flow + description: 'Whether to allow implicit grant flow + + for OAuth2' + isRequired: true + types: + - + - name: oauth2_allow_url_path_matching + description: 'Specifies whether during a token + + Request Azure AD will allow path matching of the redirect URI against the + + applications collection of replyURLs. The default is false.' + isRequired: true + types: + - + - name: oauth2_permissions + description: 'The collection of OAuth 2.0 permission scopes + + that the web API (resource) application exposes to client applications. + + These permission scopes may be granted to client applications during + + consent.' + isRequired: true + types: + - [] + - name: oauth2_require_post_response + description: 'Specifies whether, as part of OAuth + + 2.0 token requests, Azure AD will allow POST requests, as opposed to GET + + requests. The default is false, which specifies that only GET requests + + will be allowed.' + isRequired: true + types: + - + - name: org_restrictions + description: A list of tenants allowed to access application. + isRequired: true + types: + - [] + - name: optional_claims + isRequired: true + types: + - + - name: password_credentials + description: A collection of PasswordCredential objects + isRequired: true + types: + - [] + - name: pre_authorized_applications + description: list of pre-authorized applications. + isRequired: true + types: + - [] + - name: public_client + description: 'Specifies whether this application is a public + + client (such as an installed application running on a mobile device). + + Default is false.' + isRequired: true + types: + - + - name: publisher_domain + description: 'Reliable domain which can be used to identify an + + application.' + isRequired: true + types: + - + - name: reply_urls + description: A collection of reply URLs for the application. + isRequired: true + types: + - [] + - name: required_resource_access + description: 'Specifies resources that this application + + requires access to and the set of OAuth permission scopes and application + + roles that it needs under each of those resources. This pre-configuration + + of required resource access drives the consent experience.' + isRequired: true + types: + - [] + - name: saml_metadata_url + description: 'The URL to the SAML metadata for the + + application.' + isRequired: true + types: + - + - name: sign_in_audience + description: 'Audience for signing in to the application + + (AzureADMyOrganization, AzureADAllOrganizations, + + AzureADAndMicrosoftAccounts).' + isRequired: true + types: + - + - name: www_homepage + description: The primary Web page. + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: app_id + isRequired: true + - name: allow_guests_sign_in + isRequired: true + - name: allow_passthrough_users + isRequired: true + - name: app_logo_url + isRequired: true + - name: app_roles + isRequired: true + - name: app_permissions + isRequired: true + - name: available_to_other_tenants + isRequired: true + - name: display_name + isRequired: true + - name: error_url + isRequired: true + - name: group_membership_claims + isRequired: true + - name: homepage + isRequired: true + - name: identifier_uris + isRequired: true + - name: informational_urls + isRequired: true + - name: is_device_only_auth_supported + isRequired: true + - name: key_credentials + isRequired: true + - name: known_client_applications + isRequired: true + - name: logout_url + isRequired: true + - name: oauth2_allow_implicit_flow + isRequired: true + - name: oauth2_allow_url_path_matching + isRequired: true + - name: oauth2_permissions + isRequired: true + - name: oauth2_require_post_response + isRequired: true + - name: org_restrictions + isRequired: true + - name: optional_claims + isRequired: true + - name: password_credentials + isRequired: true + - name: pre_authorized_applications + isRequired: true + - name: public_client + isRequired: true + - name: publisher_domain + isRequired: true + - name: reply_urls + isRequired: true + - name: required_resource_access + isRequired: true + - name: saml_metadata_url + isRequired: true + - name: sign_in_audience + isRequired: true + - name: www_homepage + isRequired: true +variables: +- description: The object ID. + name: object_id + types: + - +- description: 'The time at which the directory object was + + deleted.' + name: deletion_timestamp + types: + - +methods: +- uid: azure.graphrbac.models.Application.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.Application.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.Application.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.Application.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.Application.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.Application.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.Application.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationBase.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationBase.yml new file mode 100644 index 00000000..8a260a0f --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationBase.yml @@ -0,0 +1,394 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.ApplicationBase +name: ApplicationBase +fullName: azure.graphrbac.models.ApplicationBase +module: azure.graphrbac.models +summary: 'Active Directive Application common properties shared among GET, POST and + + PATCH.' +constructor: + syntax: 'ApplicationBase(*, allow_guests_sign_in: bool = None, allow_passthrough_users: + bool = None, app_logo_url: str = None, app_roles=None, app_permissions=None, available_to_other_tenants: + bool = None, error_url: str = None, group_membership_claims=None, homepage: str + = None, informational_urls=None, is_device_only_auth_supported: bool = None, key_credentials=None, + known_client_applications=None, logout_url: str = None, oauth2_allow_implicit_flow: + bool = None, oauth2_allow_url_path_matching: bool = None, oauth2_permissions=None, + oauth2_require_post_response: bool = None, org_restrictions=None, optional_claims=None, + password_credentials=None, pre_authorized_applications=None, public_client: bool + = None, publisher_domain: str = None, reply_urls=None, required_resource_access=None, + saml_metadata_url: str = None, sign_in_audience: str = None, www_homepage: str + = None, **kwargs)' + parameters: + - name: allow_guests_sign_in + description: 'A property on the application to indicate if + + the application accepts other IDPs or not or partially accepts.' + isRequired: true + types: + - + - name: allow_passthrough_users + description: 'Indicates that the application supports + + pass through users who have no presence in the resource tenant.' + isRequired: true + types: + - + - name: app_logo_url + description: 'The url for the application logo image stored in a + + CDN.' + isRequired: true + types: + - + - name: app_roles + description: 'The collection of application roles that an application + + may declare. These roles can be assigned to users, groups or service + + principals.' + isRequired: true + types: + - [] + - name: app_permissions + description: The application permissions. + isRequired: true + types: + - [] + - name: available_to_other_tenants + description: 'Whether the application is available to + + other tenants.' + isRequired: true + types: + - + - name: error_url + description: 'A URL provided by the author of the application to + + report errors when using the application.' + isRequired: true + types: + - + - name: group_membership_claims + description: 'Configures the groups claim issued in a + + user or OAuth 2.0 access token that the app expects.' + isRequired: true + types: + - + - name: homepage + description: The home page of the application. + isRequired: true + types: + - + - name: informational_urls + description: 'URLs with more information about the + + application.' + isRequired: true + types: + - + - name: is_device_only_auth_supported + description: 'Specifies whether this application + + supports device authentication without a user. The default is false.' + isRequired: true + types: + - + - name: key_credentials + description: A collection of KeyCredential objects. + isRequired: true + types: + - [] + - name: known_client_applications + description: 'Client applications that are tied to + + this resource application. Consent to any of the known client applications + + will result in implicit consent to the resource application through a + + combined consent dialog (showing the OAuth permission scopes required by + + the client and the resource).' + isRequired: true + types: + - [] + - name: logout_url + description: the url of the logout page + isRequired: true + types: + - + - name: oauth2_allow_implicit_flow + description: 'Whether to allow implicit grant flow + + for OAuth2' + isRequired: true + types: + - + - name: oauth2_allow_url_path_matching + description: 'Specifies whether during a token + + Request Azure AD will allow path matching of the redirect URI against the + + applications collection of replyURLs. The default is false.' + isRequired: true + types: + - + - name: oauth2_permissions + description: 'The collection of OAuth 2.0 permission scopes + + that the web API (resource) application exposes to client applications. + + These permission scopes may be granted to client applications during + + consent.' + isRequired: true + types: + - [] + - name: oauth2_require_post_response + description: 'Specifies whether, as part of OAuth + + 2.0 token requests, Azure AD will allow POST requests, as opposed to GET + + requests. The default is false, which specifies that only GET requests + + will be allowed.' + isRequired: true + types: + - + - name: org_restrictions + description: A list of tenants allowed to access application. + isRequired: true + types: + - [] + - name: optional_claims + isRequired: true + types: + - + - name: password_credentials + description: A collection of PasswordCredential objects + isRequired: true + types: + - [] + - name: pre_authorized_applications + description: list of pre-authorized applications. + isRequired: true + types: + - [] + - name: public_client + description: 'Specifies whether this application is a public + + client (such as an installed application running on a mobile device). + + Default is false.' + isRequired: true + types: + - + - name: publisher_domain + description: 'Reliable domain which can be used to identify an + + application.' + isRequired: true + types: + - + - name: reply_urls + description: A collection of reply URLs for the application. + isRequired: true + types: + - [] + - name: required_resource_access + description: 'Specifies resources that this application + + requires access to and the set of OAuth permission scopes and application + + roles that it needs under each of those resources. This pre-configuration + + of required resource access drives the consent experience.' + isRequired: true + types: + - [] + - name: saml_metadata_url + description: 'The URL to the SAML metadata for the + + application.' + isRequired: true + types: + - + - name: sign_in_audience + description: 'Audience for signing in to the application + + (AzureADMyOrganization, AzureADAllOrganizations, + + AzureADAndMicrosoftAccounts).' + isRequired: true + types: + - + - name: www_homepage + description: The primary Web page. + isRequired: true + types: + - + keywordOnlyParameters: + - name: allow_guests_sign_in + isRequired: true + - name: allow_passthrough_users + isRequired: true + - name: app_logo_url + isRequired: true + - name: app_roles + isRequired: true + - name: app_permissions + isRequired: true + - name: available_to_other_tenants + isRequired: true + - name: error_url + isRequired: true + - name: group_membership_claims + isRequired: true + - name: homepage + isRequired: true + - name: informational_urls + isRequired: true + - name: is_device_only_auth_supported + isRequired: true + - name: key_credentials + isRequired: true + - name: known_client_applications + isRequired: true + - name: logout_url + isRequired: true + - name: oauth2_allow_implicit_flow + isRequired: true + - name: oauth2_allow_url_path_matching + isRequired: true + - name: oauth2_permissions + isRequired: true + - name: oauth2_require_post_response + isRequired: true + - name: org_restrictions + isRequired: true + - name: optional_claims + isRequired: true + - name: password_credentials + isRequired: true + - name: pre_authorized_applications + isRequired: true + - name: public_client + isRequired: true + - name: publisher_domain + isRequired: true + - name: reply_urls + isRequired: true + - name: required_resource_access + isRequired: true + - name: saml_metadata_url + isRequired: true + - name: sign_in_audience + isRequired: true + - name: www_homepage + isRequired: true +methods: +- uid: azure.graphrbac.models.ApplicationBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ApplicationBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ApplicationBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.ApplicationBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ApplicationBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.ApplicationBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ApplicationBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationCreateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationCreateParameters.yml new file mode 100644 index 00000000..c20501a2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationCreateParameters.yml @@ -0,0 +1,409 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.ApplicationCreateParameters +name: ApplicationCreateParameters +fullName: azure.graphrbac.models.ApplicationCreateParameters +module: azure.graphrbac.models +summary: 'Request parameters for creating a new application. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ApplicationCreateParameters(*, display_name: str, allow_guests_sign_in: + bool = None, allow_passthrough_users: bool = None, app_logo_url: str = None, app_roles=None, + app_permissions=None, available_to_other_tenants: bool = None, error_url: str + = None, group_membership_claims=None, homepage: str = None, informational_urls=None, + is_device_only_auth_supported: bool = None, key_credentials=None, known_client_applications=None, + logout_url: str = None, oauth2_allow_implicit_flow: bool = None, oauth2_allow_url_path_matching: + bool = None, oauth2_permissions=None, oauth2_require_post_response: bool = None, + org_restrictions=None, optional_claims=None, password_credentials=None, pre_authorized_applications=None, + public_client: bool = None, publisher_domain: str = None, reply_urls=None, required_resource_access=None, + saml_metadata_url: str = None, sign_in_audience: str = None, www_homepage: str + = None, identifier_uris=None, **kwargs)' + parameters: + - name: allow_guests_sign_in + description: 'A property on the application to indicate if + + the application accepts other IDPs or not or partially accepts.' + isRequired: true + types: + - + - name: allow_passthrough_users + description: 'Indicates that the application supports + + pass through users who have no presence in the resource tenant.' + isRequired: true + types: + - + - name: app_logo_url + description: 'The url for the application logo image stored in a + + CDN.' + isRequired: true + types: + - + - name: app_roles + description: 'The collection of application roles that an application + + may declare. These roles can be assigned to users, groups or service + + principals.' + isRequired: true + types: + - [] + - name: app_permissions + description: The application permissions. + isRequired: true + types: + - [] + - name: available_to_other_tenants + description: 'Whether the application is available to + + other tenants.' + isRequired: true + types: + - + - name: error_url + description: 'A URL provided by the author of the application to + + report errors when using the application.' + isRequired: true + types: + - + - name: group_membership_claims + description: 'Configures the groups claim issued in a + + user or OAuth 2.0 access token that the app expects.' + isRequired: true + types: + - + - name: homepage + description: The home page of the application. + isRequired: true + types: + - + - name: informational_urls + description: 'URLs with more information about the + + application.' + isRequired: true + types: + - + - name: is_device_only_auth_supported + description: 'Specifies whether this application + + supports device authentication without a user. The default is false.' + isRequired: true + types: + - + - name: key_credentials + description: A collection of KeyCredential objects. + isRequired: true + types: + - [] + - name: known_client_applications + description: 'Client applications that are tied to + + this resource application. Consent to any of the known client applications + + will result in implicit consent to the resource application through a + + combined consent dialog (showing the OAuth permission scopes required by + + the client and the resource).' + isRequired: true + types: + - [] + - name: logout_url + description: the url of the logout page + isRequired: true + types: + - + - name: oauth2_allow_implicit_flow + description: 'Whether to allow implicit grant flow + + for OAuth2' + isRequired: true + types: + - + - name: oauth2_allow_url_path_matching + description: 'Specifies whether during a token + + Request Azure AD will allow path matching of the redirect URI against the + + applications collection of replyURLs. The default is false.' + isRequired: true + types: + - + - name: oauth2_permissions + description: 'The collection of OAuth 2.0 permission scopes + + that the web API (resource) application exposes to client applications. + + These permission scopes may be granted to client applications during + + consent.' + isRequired: true + types: + - [] + - name: oauth2_require_post_response + description: 'Specifies whether, as part of OAuth + + 2.0 token requests, Azure AD will allow POST requests, as opposed to GET + + requests. The default is false, which specifies that only GET requests + + will be allowed.' + isRequired: true + types: + - + - name: org_restrictions + description: A list of tenants allowed to access application. + isRequired: true + types: + - [] + - name: optional_claims + isRequired: true + types: + - + - name: password_credentials + description: A collection of PasswordCredential objects + isRequired: true + types: + - [] + - name: pre_authorized_applications + description: list of pre-authorized applications. + isRequired: true + types: + - [] + - name: public_client + description: 'Specifies whether this application is a public + + client (such as an installed application running on a mobile device). + + Default is false.' + isRequired: true + types: + - + - name: publisher_domain + description: 'Reliable domain which can be used to identify an + + application.' + isRequired: true + types: + - + - name: reply_urls + description: A collection of reply URLs for the application. + isRequired: true + types: + - [] + - name: required_resource_access + description: 'Specifies resources that this application + + requires access to and the set of OAuth permission scopes and application + + roles that it needs under each of those resources. This pre-configuration + + of required resource access drives the consent experience.' + isRequired: true + types: + - [] + - name: saml_metadata_url + description: 'The URL to the SAML metadata for the + + application.' + isRequired: true + types: + - + - name: sign_in_audience + description: 'Audience for signing in to the application + + (AzureADMyOrganization, AzureADAllOrganizations, + + AzureADAndMicrosoftAccounts).' + isRequired: true + types: + - + - name: www_homepage + description: The primary Web page. + isRequired: true + types: + - + - name: display_name + description: Required. The display name of the application. + isRequired: true + types: + - + - name: identifier_uris + description: A collection of URIs for the application. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: display_name + isRequired: true + - name: allow_guests_sign_in + isRequired: true + - name: allow_passthrough_users + isRequired: true + - name: app_logo_url + isRequired: true + - name: app_roles + isRequired: true + - name: app_permissions + isRequired: true + - name: available_to_other_tenants + isRequired: true + - name: error_url + isRequired: true + - name: group_membership_claims + isRequired: true + - name: homepage + isRequired: true + - name: informational_urls + isRequired: true + - name: is_device_only_auth_supported + isRequired: true + - name: key_credentials + isRequired: true + - name: known_client_applications + isRequired: true + - name: logout_url + isRequired: true + - name: oauth2_allow_implicit_flow + isRequired: true + - name: oauth2_allow_url_path_matching + isRequired: true + - name: oauth2_permissions + isRequired: true + - name: oauth2_require_post_response + isRequired: true + - name: org_restrictions + isRequired: true + - name: optional_claims + isRequired: true + - name: password_credentials + isRequired: true + - name: pre_authorized_applications + isRequired: true + - name: public_client + isRequired: true + - name: publisher_domain + isRequired: true + - name: reply_urls + isRequired: true + - name: required_resource_access + isRequired: true + - name: saml_metadata_url + isRequired: true + - name: sign_in_audience + isRequired: true + - name: www_homepage + isRequired: true + - name: identifier_uris + isRequired: true +methods: +- uid: azure.graphrbac.models.ApplicationCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ApplicationCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ApplicationCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.ApplicationCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ApplicationCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.ApplicationCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ApplicationCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationPaged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationPaged.yml new file mode 100644 index 00000000..deaae54c --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.ApplicationPaged +name: ApplicationPaged +fullName: azure.graphrbac.models.ApplicationPaged +module: azure.graphrbac.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: ApplicationPaged(*args, **kwargs) +methods: +- uid: azure.graphrbac.models.ApplicationPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.graphrbac.models.ApplicationPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.graphrbac.models.ApplicationPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.ApplicationPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.ApplicationPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.graphrbac.models.ApplicationPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.graphrbac.models.ApplicationPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationUpdateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationUpdateParameters.yml new file mode 100644 index 00000000..2f78a6be --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationUpdateParameters.yml @@ -0,0 +1,406 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.ApplicationUpdateParameters +name: ApplicationUpdateParameters +fullName: azure.graphrbac.models.ApplicationUpdateParameters +module: azure.graphrbac.models +summary: Request parameters for updating a new application. +constructor: + syntax: 'ApplicationUpdateParameters(*, allow_guests_sign_in: bool = None, allow_passthrough_users: + bool = None, app_logo_url: str = None, app_roles=None, app_permissions=None, available_to_other_tenants: + bool = None, error_url: str = None, group_membership_claims=None, homepage: str + = None, informational_urls=None, is_device_only_auth_supported: bool = None, key_credentials=None, + known_client_applications=None, logout_url: str = None, oauth2_allow_implicit_flow: + bool = None, oauth2_allow_url_path_matching: bool = None, oauth2_permissions=None, + oauth2_require_post_response: bool = None, org_restrictions=None, optional_claims=None, + password_credentials=None, pre_authorized_applications=None, public_client: bool + = None, publisher_domain: str = None, reply_urls=None, required_resource_access=None, + saml_metadata_url: str = None, sign_in_audience: str = None, www_homepage: str + = None, display_name: str = None, identifier_uris=None, **kwargs)' + parameters: + - name: allow_guests_sign_in + description: 'A property on the application to indicate if + + the application accepts other IDPs or not or partially accepts.' + isRequired: true + types: + - + - name: allow_passthrough_users + description: 'Indicates that the application supports + + pass through users who have no presence in the resource tenant.' + isRequired: true + types: + - + - name: app_logo_url + description: 'The url for the application logo image stored in a + + CDN.' + isRequired: true + types: + - + - name: app_roles + description: 'The collection of application roles that an application + + may declare. These roles can be assigned to users, groups or service + + principals.' + isRequired: true + types: + - [] + - name: app_permissions + description: The application permissions. + isRequired: true + types: + - [] + - name: available_to_other_tenants + description: 'Whether the application is available to + + other tenants.' + isRequired: true + types: + - + - name: error_url + description: 'A URL provided by the author of the application to + + report errors when using the application.' + isRequired: true + types: + - + - name: group_membership_claims + description: 'Configures the groups claim issued in a + + user or OAuth 2.0 access token that the app expects.' + isRequired: true + types: + - + - name: homepage + description: The home page of the application. + isRequired: true + types: + - + - name: informational_urls + description: 'URLs with more information about the + + application.' + isRequired: true + types: + - + - name: is_device_only_auth_supported + description: 'Specifies whether this application + + supports device authentication without a user. The default is false.' + isRequired: true + types: + - + - name: key_credentials + description: A collection of KeyCredential objects. + isRequired: true + types: + - [] + - name: known_client_applications + description: 'Client applications that are tied to + + this resource application. Consent to any of the known client applications + + will result in implicit consent to the resource application through a + + combined consent dialog (showing the OAuth permission scopes required by + + the client and the resource).' + isRequired: true + types: + - [] + - name: logout_url + description: the url of the logout page + isRequired: true + types: + - + - name: oauth2_allow_implicit_flow + description: 'Whether to allow implicit grant flow + + for OAuth2' + isRequired: true + types: + - + - name: oauth2_allow_url_path_matching + description: 'Specifies whether during a token + + Request Azure AD will allow path matching of the redirect URI against the + + applications collection of replyURLs. The default is false.' + isRequired: true + types: + - + - name: oauth2_permissions + description: 'The collection of OAuth 2.0 permission scopes + + that the web API (resource) application exposes to client applications. + + These permission scopes may be granted to client applications during + + consent.' + isRequired: true + types: + - [] + - name: oauth2_require_post_response + description: 'Specifies whether, as part of OAuth + + 2.0 token requests, Azure AD will allow POST requests, as opposed to GET + + requests. The default is false, which specifies that only GET requests + + will be allowed.' + isRequired: true + types: + - + - name: org_restrictions + description: A list of tenants allowed to access application. + isRequired: true + types: + - [] + - name: optional_claims + isRequired: true + types: + - + - name: password_credentials + description: A collection of PasswordCredential objects + isRequired: true + types: + - [] + - name: pre_authorized_applications + description: list of pre-authorized applications. + isRequired: true + types: + - [] + - name: public_client + description: 'Specifies whether this application is a public + + client (such as an installed application running on a mobile device). + + Default is false.' + isRequired: true + types: + - + - name: publisher_domain + description: 'Reliable domain which can be used to identify an + + application.' + isRequired: true + types: + - + - name: reply_urls + description: A collection of reply URLs for the application. + isRequired: true + types: + - [] + - name: required_resource_access + description: 'Specifies resources that this application + + requires access to and the set of OAuth permission scopes and application + + roles that it needs under each of those resources. This pre-configuration + + of required resource access drives the consent experience.' + isRequired: true + types: + - [] + - name: saml_metadata_url + description: 'The URL to the SAML metadata for the + + application.' + isRequired: true + types: + - + - name: sign_in_audience + description: 'Audience for signing in to the application + + (AzureADMyOrganization, AzureADAllOrganizations, + + AzureADAndMicrosoftAccounts).' + isRequired: true + types: + - + - name: www_homepage + description: The primary Web page. + isRequired: true + types: + - + - name: display_name + description: The display name of the application. + isRequired: true + types: + - + - name: identifier_uris + description: A collection of URIs for the application. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: allow_guests_sign_in + isRequired: true + - name: allow_passthrough_users + isRequired: true + - name: app_logo_url + isRequired: true + - name: app_roles + isRequired: true + - name: app_permissions + isRequired: true + - name: available_to_other_tenants + isRequired: true + - name: error_url + isRequired: true + - name: group_membership_claims + isRequired: true + - name: homepage + isRequired: true + - name: informational_urls + isRequired: true + - name: is_device_only_auth_supported + isRequired: true + - name: key_credentials + isRequired: true + - name: known_client_applications + isRequired: true + - name: logout_url + isRequired: true + - name: oauth2_allow_implicit_flow + isRequired: true + - name: oauth2_allow_url_path_matching + isRequired: true + - name: oauth2_permissions + isRequired: true + - name: oauth2_require_post_response + isRequired: true + - name: org_restrictions + isRequired: true + - name: optional_claims + isRequired: true + - name: password_credentials + isRequired: true + - name: pre_authorized_applications + isRequired: true + - name: public_client + isRequired: true + - name: publisher_domain + isRequired: true + - name: reply_urls + isRequired: true + - name: required_resource_access + isRequired: true + - name: saml_metadata_url + isRequired: true + - name: sign_in_audience + isRequired: true + - name: www_homepage + isRequired: true + - name: display_name + isRequired: true + - name: identifier_uris + isRequired: true +methods: +- uid: azure.graphrbac.models.ApplicationUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ApplicationUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ApplicationUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.ApplicationUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ApplicationUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.ApplicationUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ApplicationUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.CheckGroupMembershipParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.CheckGroupMembershipParameters.yml new file mode 100644 index 00000000..99683c36 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.CheckGroupMembershipParameters.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.CheckGroupMembershipParameters +name: CheckGroupMembershipParameters +fullName: azure.graphrbac.models.CheckGroupMembershipParameters +module: azure.graphrbac.models +summary: 'Request parameters for IsMemberOf API call. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CheckGroupMembershipParameters(*, group_id: str, member_id: str, additional_properties=None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: group_id + description: Required. The object ID of the group to check. + isRequired: true + types: + - + - name: member_id + description: 'Required. The object ID of the contact, group, user, or + + service principal to check for membership in the specified group.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: group_id + isRequired: true + - name: member_id + isRequired: true + - name: additional_properties + isRequired: true +methods: +- uid: azure.graphrbac.models.CheckGroupMembershipParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.CheckGroupMembershipParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.CheckGroupMembershipParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.CheckGroupMembershipParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.CheckGroupMembershipParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.CheckGroupMembershipParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.CheckGroupMembershipParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.CheckGroupMembershipResult.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.CheckGroupMembershipResult.yml new file mode 100644 index 00000000..e44a582c --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.CheckGroupMembershipResult.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.CheckGroupMembershipResult +name: CheckGroupMembershipResult +fullName: azure.graphrbac.models.CheckGroupMembershipResult +module: azure.graphrbac.models +summary: Server response for IsMemberOf API call. +constructor: + syntax: 'CheckGroupMembershipResult(*, additional_properties=None, value: bool = + None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: value + description: 'True if the specified user, group, contact, or service + + principal has either direct or transitive membership in the specified + + group; otherwise, false.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.graphrbac.models.CheckGroupMembershipResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.CheckGroupMembershipResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.CheckGroupMembershipResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.CheckGroupMembershipResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.CheckGroupMembershipResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.CheckGroupMembershipResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.CheckGroupMembershipResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ConsentType.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ConsentType.yml new file mode 100644 index 00000000..318cabbc --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ConsentType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.graphrbac.models.ConsentType +name: ConsentType +fullName: azure.graphrbac.models.ConsentType +module: azure.graphrbac.models +fields: +- name: all_principals + uid: azure.graphrbac.models.ConsentType.all_principals +- name: principal + uid: azure.graphrbac.models.ConsentType.principal diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.DirectoryObject.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.DirectoryObject.yml new file mode 100644 index 00000000..342237c6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.DirectoryObject.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.DirectoryObject +name: DirectoryObject +fullName: azure.graphrbac.models.DirectoryObject +module: azure.graphrbac.models +summary: 'Represents an Azure Active Directory object. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Application, ADGroup, ServicePrincipal, User + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: DirectoryObject(*, additional_properties=None, **kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: object_type + description: Required. Constant filled by server. + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true +variables: +- description: The object ID. + name: object_id + types: + - +- description: 'The time at which the directory object was + + deleted.' + name: deletion_timestamp + types: + - +methods: +- uid: azure.graphrbac.models.DirectoryObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.DirectoryObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.DirectoryObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.DirectoryObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.DirectoryObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.DirectoryObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.DirectoryObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.DirectoryObjectPaged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.DirectoryObjectPaged.yml new file mode 100644 index 00000000..ad30af9a --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.DirectoryObjectPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.DirectoryObjectPaged +name: DirectoryObjectPaged +fullName: azure.graphrbac.models.DirectoryObjectPaged +module: azure.graphrbac.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: DirectoryObjectPaged(*args, **kwargs) +methods: +- uid: azure.graphrbac.models.DirectoryObjectPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.graphrbac.models.DirectoryObjectPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.graphrbac.models.DirectoryObjectPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.DirectoryObjectPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.DirectoryObjectPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.graphrbac.models.DirectoryObjectPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.graphrbac.models.DirectoryObjectPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.Domain(class).yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.Domain(class).yml new file mode 100644 index 00000000..51c0e988 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.Domain(class).yml @@ -0,0 +1,153 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.Domain +name: Domain +fullName: azure.graphrbac.models.Domain +module: azure.graphrbac.models +summary: 'Active Directory Domain information. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Domain(*, name: str, additional_properties=None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: name + description: Required. the domain name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: additional_properties + isRequired: true +variables: +- description: the type of the authentication into the domain. + name: authentication_type + types: + - +- description: if this is the default domain in the tenant. + name: is_default + types: + - +- description: if this domain's ownership is verified. + name: is_verified + types: + - +methods: +- uid: azure.graphrbac.models.Domain.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.Domain.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.Domain.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.Domain.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.Domain.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.Domain.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.Domain.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.DomainPaged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.DomainPaged.yml new file mode 100644 index 00000000..1991e8e4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.DomainPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.DomainPaged +name: DomainPaged +fullName: azure.graphrbac.models.DomainPaged +module: azure.graphrbac.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: DomainPaged(*args, **kwargs) +methods: +- uid: azure.graphrbac.models.DomainPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.graphrbac.models.DomainPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.graphrbac.models.DomainPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.DomainPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.DomainPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.graphrbac.models.DomainPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.graphrbac.models.DomainPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GetObjectsParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GetObjectsParameters.yml new file mode 100644 index 00000000..b76b0448 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GetObjectsParameters.yml @@ -0,0 +1,149 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.GetObjectsParameters +name: GetObjectsParameters +fullName: azure.graphrbac.models.GetObjectsParameters +module: azure.graphrbac.models +summary: Request parameters for the GetObjectsByObjectIds API. +constructor: + syntax: 'GetObjectsParameters(*, additional_properties=None, object_ids=None, types=None, + include_directory_object_references: bool = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: object_ids + description: The requested object IDs. + isRequired: true + types: + - [] + - name: types + description: The requested object types. + isRequired: true + types: + - [] + - name: include_directory_object_references + description: 'If true, also searches for + + object IDs in the partner tenant.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: object_ids + isRequired: true + - name: types + isRequired: true + - name: include_directory_object_references + isRequired: true +methods: +- uid: azure.graphrbac.models.GetObjectsParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.GetObjectsParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.GetObjectsParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.GetObjectsParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.GetObjectsParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.GetObjectsParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.GetObjectsParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GraphError.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GraphError.yml new file mode 100644 index 00000000..0b38a00a --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GraphError.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.GraphError +name: GraphError +fullName: azure.graphrbac.models.GraphError +module: azure.graphrbac.models +summary: Active Directory error information. +constructor: + syntax: 'GraphError(*, code: str = None, message: str = None, **kwargs)' + parameters: + - name: code + description: Error code. + isRequired: true + types: + - + - name: message + description: Error message value. + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true +methods: +- uid: azure.graphrbac.models.GraphError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.GraphError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.GraphError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.GraphError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.GraphError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.GraphError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.GraphError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GraphErrorException.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GraphErrorException.yml new file mode 100644 index 00000000..e0438a2e --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GraphErrorException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.GraphErrorException +name: GraphErrorException +fullName: azure.graphrbac.models.GraphErrorException +module: azure.graphrbac.models +summary: 'Server responded with exception of type: ''GraphError''.' +constructor: + syntax: GraphErrorException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.graphrbac.models.GraphErrorException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.graphrbac.models.GraphErrorException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.graphrbac.models.GraphErrorException.args + name: args diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupAddMemberParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupAddMemberParameters.yml new file mode 100644 index 00000000..34d1f988 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupAddMemberParameters.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.GroupAddMemberParameters +name: GroupAddMemberParameters +fullName: azure.graphrbac.models.GroupAddMemberParameters +module: azure.graphrbac.models +summary: 'Request parameters for adding a member to a group. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'GroupAddMemberParameters(*, url: str, additional_properties=None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: url + description: 'Required. A member object URL, such as + + "[https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd](https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd)", + + where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and + + "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the member + + (user, application, servicePrincipal, group) to be added.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: url + isRequired: true + - name: additional_properties + isRequired: true +methods: +- uid: azure.graphrbac.models.GroupAddMemberParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.GroupAddMemberParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.GroupAddMemberParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.GroupAddMemberParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.GroupAddMemberParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.GroupAddMemberParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.GroupAddMemberParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupCreateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupCreateParameters.yml new file mode 100644 index 00000000..7ebfc2af --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupCreateParameters.yml @@ -0,0 +1,172 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.GroupCreateParameters +name: GroupCreateParameters +fullName: azure.graphrbac.models.GroupCreateParameters +module: azure.graphrbac.models +summary: 'Request parameters for creating a new group. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'GroupCreateParameters(*, display_name: str, mail_nickname: str, additional_properties=None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: display_name + description: Required. Group display name + isRequired: true + types: + - + - name: mail_nickname + description: Required. Mail nickname + isRequired: true + types: + - + keywordOnlyParameters: + - name: display_name + isRequired: true + - name: mail_nickname + isRequired: true + - name: additional_properties + isRequired: true +variables: +- description: 'Required. Whether the group is mail-enabled. Must be + + false. This is because only pure security groups can be created using the + + Graph API. Default value: False .' + name: mail_enabled + types: + - +- description: 'Required. Whether the group is a security group. + + Must be true. This is because only pure security groups can be created + + using the Graph API. Default value: True .' + name: security_enabled + types: + - +methods: +- uid: azure.graphrbac.models.GroupCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.GroupCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.GroupCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.GroupCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.GroupCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.GroupCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.GroupCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +attributes: +- uid: azure.graphrbac.models.GroupCreateParameters.mail_enabled + name: mail_enabled + signature: mail_enabled = False +- uid: azure.graphrbac.models.GroupCreateParameters.security_enabled + name: security_enabled + signature: security_enabled = True diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupGetMemberGroupsParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupGetMemberGroupsParameters.yml new file mode 100644 index 00000000..76ea0c21 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupGetMemberGroupsParameters.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.GroupGetMemberGroupsParameters +name: GroupGetMemberGroupsParameters +fullName: azure.graphrbac.models.GroupGetMemberGroupsParameters +module: azure.graphrbac.models +summary: 'Request parameters for GetMemberGroups API call. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'GroupGetMemberGroupsParameters(*, security_enabled_only: bool, additional_properties=None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: security_enabled_only + description: 'Required. If true, only membership in + + security-enabled groups should be checked. Otherwise, membership in all + + groups should be checked.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: security_enabled_only + isRequired: true + - name: additional_properties + isRequired: true +methods: +- uid: azure.graphrbac.models.GroupGetMemberGroupsParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.GroupGetMemberGroupsParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.GroupGetMemberGroupsParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.GroupGetMemberGroupsParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.GroupGetMemberGroupsParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.GroupGetMemberGroupsParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.GroupGetMemberGroupsParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.InformationalUrl.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.InformationalUrl.yml new file mode 100644 index 00000000..fa685468 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.InformationalUrl.yml @@ -0,0 +1,149 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.InformationalUrl +name: InformationalUrl +fullName: azure.graphrbac.models.InformationalUrl +module: azure.graphrbac.models +summary: 'Represents a group of URIs that provide terms of service, marketing, + + support and privacy policy information about an application. The default + + value for each string is null.' +constructor: + syntax: 'InformationalUrl(*, terms_of_service: str = None, marketing: str = None, + privacy: str = None, support: str = None, **kwargs)' + parameters: + - name: terms_of_service + description: The terms of service URI + isRequired: true + types: + - + - name: marketing + description: The marketing URI + isRequired: true + types: + - + - name: privacy + description: The privacy policy URI + isRequired: true + types: + - + - name: support + description: The support URI + isRequired: true + types: + - + keywordOnlyParameters: + - name: terms_of_service + isRequired: true + - name: marketing + isRequired: true + - name: privacy + isRequired: true + - name: support + isRequired: true +methods: +- uid: azure.graphrbac.models.InformationalUrl.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.InformationalUrl.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.InformationalUrl.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.InformationalUrl.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.InformationalUrl.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.InformationalUrl.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.InformationalUrl.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.KeyCredential.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.KeyCredential.yml new file mode 100644 index 00000000..a598cb03 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.KeyCredential.yml @@ -0,0 +1,178 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.KeyCredential +name: KeyCredential +fullName: azure.graphrbac.models.KeyCredential +module: azure.graphrbac.models +summary: Active Directory Key Credential information. +constructor: + syntax: 'KeyCredential(*, additional_properties=None, start_date=None, end_date=None, + value: str = None, key_id: str = None, usage: str = None, type: str = None, custom_key_identifier: + str = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: start_date + description: Start date. + isRequired: true + types: + - + - name: end_date + description: End date. + isRequired: true + types: + - + - name: value + description: Key value. + isRequired: true + types: + - + - name: key_id + description: Key ID. + isRequired: true + types: + - + - name: usage + description: Usage. Acceptable values are 'Verify' and 'Sign'. + isRequired: true + types: + - + - name: type + description: 'Type. Acceptable values are ''AsymmetricX509Cert'' and + + ''Symmetric''.' + isRequired: true + types: + - + - name: custom_key_identifier + description: Custom Key Identifier + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: start_date + isRequired: true + - name: end_date + isRequired: true + - name: value + isRequired: true + - name: key_id + isRequired: true + - name: usage + isRequired: true + - name: type + isRequired: true + - name: custom_key_identifier + isRequired: true +methods: +- uid: azure.graphrbac.models.KeyCredential.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.KeyCredential.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.KeyCredential.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.KeyCredential.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.KeyCredential.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.KeyCredential.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.KeyCredential.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.KeyCredentialPaged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.KeyCredentialPaged.yml new file mode 100644 index 00000000..945b0993 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.KeyCredentialPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.KeyCredentialPaged +name: KeyCredentialPaged +fullName: azure.graphrbac.models.KeyCredentialPaged +module: azure.graphrbac.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: KeyCredentialPaged(*args, **kwargs) +methods: +- uid: azure.graphrbac.models.KeyCredentialPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.graphrbac.models.KeyCredentialPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.graphrbac.models.KeyCredentialPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.KeyCredentialPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.KeyCredentialPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.graphrbac.models.KeyCredentialPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.graphrbac.models.KeyCredentialPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.KeyCredentialsUpdateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.KeyCredentialsUpdateParameters.yml new file mode 100644 index 00000000..ea0778fc --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.KeyCredentialsUpdateParameters.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.KeyCredentialsUpdateParameters +name: KeyCredentialsUpdateParameters +fullName: azure.graphrbac.models.KeyCredentialsUpdateParameters +module: azure.graphrbac.models +summary: 'Request parameters for a KeyCredentials update operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: KeyCredentialsUpdateParameters(*, value, **kwargs) + parameters: + - name: value + description: Required. A collection of KeyCredentials. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: value + isRequired: true +methods: +- uid: azure.graphrbac.models.KeyCredentialsUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.KeyCredentialsUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.KeyCredentialsUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.KeyCredentialsUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.KeyCredentialsUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.KeyCredentialsUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.KeyCredentialsUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OAuth2Permission.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OAuth2Permission.yml new file mode 100644 index 00000000..79ef81b4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OAuth2Permission.yml @@ -0,0 +1,209 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.OAuth2Permission +name: OAuth2Permission +fullName: azure.graphrbac.models.OAuth2Permission +module: azure.graphrbac.models +summary: 'Represents an OAuth 2.0 delegated permission scope. The specified OAuth + 2.0 + + delegated permission scopes may be requested by client applications + + (through the requiredResourceAccess collection on the Application object) + + when calling a resource application. The oauth2Permissions property of the + + ServicePrincipal entity and of the Application entity is a collection of + + OAuth2Permission.' +constructor: + syntax: 'OAuth2Permission(*, admin_consent_description: str = None, admin_consent_display_name: + str = None, id: str = None, is_enabled: bool = None, type: str = None, user_consent_description: + str = None, user_consent_display_name: str = None, value: str = None, **kwargs)' + parameters: + - name: admin_consent_description + description: 'Permission help text that appears in the + + admin consent and app assignment experiences.' + isRequired: true + types: + - + - name: admin_consent_display_name + description: 'Display name for the permission that + + appears in the admin consent and app assignment experiences.' + isRequired: true + types: + - + - name: id + description: 'Unique scope permission identifier inside the oauth2Permissions + + collection.' + isRequired: true + types: + - + - name: is_enabled + description: 'When creating or updating a permission, this property + + must be set to true (which is the default). To delete a permission, this + + property must first be set to false. At that point, in a subsequent call, + + the permission may be removed.' + isRequired: true + types: + - + - name: type + description: 'Specifies whether this scope permission can be consented to + + by an end user, or whether it is a tenant-wide permission that must be + + consented to by a Company Administrator. Possible values are "User" or + + "Admin".' + isRequired: true + types: + - + - name: user_consent_description + description: 'Permission help text that appears in the + + end user consent experience.' + isRequired: true + types: + - + - name: user_consent_display_name + description: 'Display name for the permission that + + appears in the end user consent experience.' + isRequired: true + types: + - + - name: value + description: 'The value of the scope claim that the resource application + + should expect in the OAuth 2.0 access token.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: admin_consent_description + isRequired: true + - name: admin_consent_display_name + isRequired: true + - name: id + isRequired: true + - name: is_enabled + isRequired: true + - name: type + isRequired: true + - name: user_consent_description + isRequired: true + - name: user_consent_display_name + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.graphrbac.models.OAuth2Permission.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.OAuth2Permission.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.OAuth2Permission.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.OAuth2Permission.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.OAuth2Permission.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.OAuth2Permission.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.OAuth2Permission.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OAuth2PermissionGrant.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OAuth2PermissionGrant.yml new file mode 100644 index 00000000..fdbdad78 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OAuth2PermissionGrant.yml @@ -0,0 +1,199 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.OAuth2PermissionGrant +name: OAuth2PermissionGrant +fullName: azure.graphrbac.models.OAuth2PermissionGrant +module: azure.graphrbac.models +summary: OAuth2PermissionGrant. +constructor: + syntax: 'OAuth2PermissionGrant(*, odatatype: str = None, client_id: str = None, + object_id: str = None, consent_type=None, principal_id: str = None, resource_id: + str = None, scope: str = None, start_time: str = None, expiry_time: str = None, + **kwargs)' + parameters: + - name: odatatype + description: Microsoft.DirectoryServices.OAuth2PermissionGrant + isRequired: true + types: + - + - name: client_id + description: 'The id of the resource''s service principal granted + + consent to impersonate the user when accessing the resource (represented + + by the resourceId property).' + isRequired: true + types: + - + - name: object_id + description: The id of the permission grant + isRequired: true + types: + - + - name: consent_type + description: 'Indicates if consent was provided by the + + administrator (on behalf of the organization) or by an individual. + + Possible values include: ''AllPrincipals'', ''Principal''' + isRequired: true + types: + - + - + - name: principal_id + description: 'When consent type is Principal, this property + + specifies the id of the user that granted consent and applies only for + + that user.' + isRequired: true + types: + - + - name: resource_id + description: Object Id of the resource you want to grant + isRequired: true + types: + - + - name: scope + description: 'Specifies the value of the scope claim that the resource + + application should expect in the OAuth 2.0 access token. For example, + + User.Read' + isRequired: true + types: + - + - name: start_time + description: Start time for TTL + isRequired: true + types: + - + - name: expiry_time + description: Expiry time for TTL + isRequired: true + types: + - + keywordOnlyParameters: + - name: odatatype + isRequired: true + - name: client_id + isRequired: true + - name: object_id + isRequired: true + - name: consent_type + isRequired: true + - name: principal_id + isRequired: true + - name: resource_id + isRequired: true + - name: scope + isRequired: true + - name: start_time + isRequired: true + - name: expiry_time + isRequired: true +methods: +- uid: azure.graphrbac.models.OAuth2PermissionGrant.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.OAuth2PermissionGrant.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.OAuth2PermissionGrant.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.OAuth2PermissionGrant.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.OAuth2PermissionGrant.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.OAuth2PermissionGrant.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.OAuth2PermissionGrant.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OAuth2PermissionGrantPaged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OAuth2PermissionGrantPaged.yml new file mode 100644 index 00000000..7c35b057 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OAuth2PermissionGrantPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.OAuth2PermissionGrantPaged +name: OAuth2PermissionGrantPaged +fullName: azure.graphrbac.models.OAuth2PermissionGrantPaged +module: azure.graphrbac.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: OAuth2PermissionGrantPaged(*args, **kwargs) +methods: +- uid: azure.graphrbac.models.OAuth2PermissionGrantPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.graphrbac.models.OAuth2PermissionGrantPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.graphrbac.models.OAuth2PermissionGrantPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.OAuth2PermissionGrantPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.OAuth2PermissionGrantPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.graphrbac.models.OAuth2PermissionGrantPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.graphrbac.models.OAuth2PermissionGrantPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OptionalClaim.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OptionalClaim.yml new file mode 100644 index 00000000..15bc0ef4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OptionalClaim.yml @@ -0,0 +1,144 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.OptionalClaim +name: OptionalClaim +fullName: azure.graphrbac.models.OptionalClaim +module: azure.graphrbac.models +summary: Specifying the claims to be included in a token. +constructor: + syntax: 'OptionalClaim(*, name: str = None, source: str = None, essential: bool + = None, additional_properties=None, **kwargs)' + parameters: + - name: name + description: Claim name. + isRequired: true + types: + - + - name: source + description: Claim source. + isRequired: true + types: + - + - name: essential + description: Is this a required claim. + isRequired: true + types: + - + - name: additional_properties + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: source + isRequired: true + - name: essential + isRequired: true + - name: additional_properties + isRequired: true +methods: +- uid: azure.graphrbac.models.OptionalClaim.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.OptionalClaim.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.OptionalClaim.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.OptionalClaim.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.OptionalClaim.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.OptionalClaim.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.OptionalClaim.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OptionalClaims.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OptionalClaims.yml new file mode 100644 index 00000000..b00511aa --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OptionalClaims.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.OptionalClaims +name: OptionalClaims +fullName: azure.graphrbac.models.OptionalClaims +module: azure.graphrbac.models +summary: Specifying the claims to be included in the token. +constructor: + syntax: OptionalClaims(*, id_token=None, access_token=None, saml_token=None, **kwargs) + parameters: + - name: id_token + description: Optional claims requested to be included in the id token. + isRequired: true + types: + - [] + - name: access_token + description: 'Optional claims requested to be included in the + + access token.' + isRequired: true + types: + - [] + - name: saml_token + description: 'Optional claims requested to be included in the saml + + token.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id_token + isRequired: true + - name: access_token + isRequired: true + - name: saml_token + isRequired: true +methods: +- uid: azure.graphrbac.models.OptionalClaims.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.OptionalClaims.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.OptionalClaims.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.OptionalClaims.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.OptionalClaims.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.OptionalClaims.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.OptionalClaims.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordCredential.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordCredential.yml new file mode 100644 index 00000000..d77e988e --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordCredential.yml @@ -0,0 +1,162 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.PasswordCredential +name: PasswordCredential +fullName: azure.graphrbac.models.PasswordCredential +module: azure.graphrbac.models +summary: Active Directory Password Credential information. +constructor: + syntax: 'PasswordCredential(*, additional_properties=None, start_date=None, end_date=None, + key_id: str = None, value: str = None, custom_key_identifier: bytearray = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: start_date + description: Start date. + isRequired: true + types: + - + - name: end_date + description: End date. + isRequired: true + types: + - + - name: key_id + description: Key ID. + isRequired: true + types: + - + - name: value + description: Key value. + isRequired: true + types: + - + - name: custom_key_identifier + description: Custom Key Identifier + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: start_date + isRequired: true + - name: end_date + isRequired: true + - name: key_id + isRequired: true + - name: value + isRequired: true + - name: custom_key_identifier + isRequired: true +methods: +- uid: azure.graphrbac.models.PasswordCredential.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.PasswordCredential.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.PasswordCredential.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.PasswordCredential.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.PasswordCredential.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.PasswordCredential.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.PasswordCredential.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordCredentialPaged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordCredentialPaged.yml new file mode 100644 index 00000000..0263789e --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordCredentialPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.PasswordCredentialPaged +name: PasswordCredentialPaged +fullName: azure.graphrbac.models.PasswordCredentialPaged +module: azure.graphrbac.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: PasswordCredentialPaged(*args, **kwargs) +methods: +- uid: azure.graphrbac.models.PasswordCredentialPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.graphrbac.models.PasswordCredentialPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.graphrbac.models.PasswordCredentialPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.PasswordCredentialPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.PasswordCredentialPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.graphrbac.models.PasswordCredentialPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.graphrbac.models.PasswordCredentialPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordCredentialsUpdateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordCredentialsUpdateParameters.yml new file mode 100644 index 00000000..ece66854 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordCredentialsUpdateParameters.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.PasswordCredentialsUpdateParameters +name: PasswordCredentialsUpdateParameters +fullName: azure.graphrbac.models.PasswordCredentialsUpdateParameters +module: azure.graphrbac.models +summary: 'Request parameters for a PasswordCredentials update operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: PasswordCredentialsUpdateParameters(*, value, **kwargs) + parameters: + - name: value + description: Required. A collection of PasswordCredentials. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: value + isRequired: true +methods: +- uid: azure.graphrbac.models.PasswordCredentialsUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.PasswordCredentialsUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.PasswordCredentialsUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.PasswordCredentialsUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.PasswordCredentialsUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.PasswordCredentialsUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.PasswordCredentialsUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordProfile.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordProfile.yml new file mode 100644 index 00000000..ddc7a51b --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordProfile.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.PasswordProfile +name: PasswordProfile +fullName: azure.graphrbac.models.PasswordProfile +module: azure.graphrbac.models +summary: 'The password profile associated with a user. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PasswordProfile(*, password: str, additional_properties=None, force_change_password_next_login: + bool = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: password + description: Required. Password + isRequired: true + types: + - + - name: force_change_password_next_login + description: 'Whether to force a password + + change on next login.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: password + isRequired: true + - name: additional_properties + isRequired: true + - name: force_change_password_next_login + isRequired: true +methods: +- uid: azure.graphrbac.models.PasswordProfile.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.PasswordProfile.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.PasswordProfile.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.PasswordProfile.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.PasswordProfile.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.PasswordProfile.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.PasswordProfile.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplication.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplication.yml new file mode 100644 index 00000000..8c0274a0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplication.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.PreAuthorizedApplication +name: PreAuthorizedApplication +fullName: azure.graphrbac.models.PreAuthorizedApplication +module: azure.graphrbac.models +summary: Contains information about pre authorized client application. +constructor: + syntax: 'PreAuthorizedApplication(*, app_id: str = None, permissions=None, extensions=None, + **kwargs)' + parameters: + - name: app_id + description: Represents the application id. + isRequired: true + types: + - + - name: permissions + description: 'Collection of required app permissions/entitlements + + from the resource application.' + isRequired: true + types: + - [] + - name: extensions + description: Collection of extensions from the resource application. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: app_id + isRequired: true + - name: permissions + isRequired: true + - name: extensions + isRequired: true +methods: +- uid: azure.graphrbac.models.PreAuthorizedApplication.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.PreAuthorizedApplication.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.PreAuthorizedApplication.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.PreAuthorizedApplication.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.PreAuthorizedApplication.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.PreAuthorizedApplication.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.PreAuthorizedApplication.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplicationExtension.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplicationExtension.yml new file mode 100644 index 00000000..3c1f07df --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplicationExtension.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.PreAuthorizedApplicationExtension +name: PreAuthorizedApplicationExtension +fullName: azure.graphrbac.models.PreAuthorizedApplicationExtension +module: azure.graphrbac.models +summary: 'Representation of an app PreAuthorizedApplicationExtension required by a + + pre authorized client app.' +constructor: + syntax: PreAuthorizedApplicationExtension(*, conditions=None, **kwargs) + parameters: + - name: conditions + description: The extension's conditions. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: conditions + isRequired: true +methods: +- uid: azure.graphrbac.models.PreAuthorizedApplicationExtension.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.PreAuthorizedApplicationExtension.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.PreAuthorizedApplicationExtension.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.PreAuthorizedApplicationExtension.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.PreAuthorizedApplicationExtension.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.PreAuthorizedApplicationExtension.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.PreAuthorizedApplicationExtension.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplicationPermission.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplicationPermission.yml new file mode 100644 index 00000000..b90c1187 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplicationPermission.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.PreAuthorizedApplicationPermission +name: PreAuthorizedApplicationPermission +fullName: azure.graphrbac.models.PreAuthorizedApplicationPermission +module: azure.graphrbac.models +summary: Contains information about the pre-authorized permissions. +constructor: + syntax: 'PreAuthorizedApplicationPermission(*, direct_access_grant: bool = None, + access_grants=None, **kwargs)' + parameters: + - name: direct_access_grant + description: 'Indicates whether the permission set is + + DirectAccess or impersonation.' + isRequired: true + types: + - + - name: access_grants + description: The list of permissions. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: direct_access_grant + isRequired: true + - name: access_grants + isRequired: true +methods: +- uid: azure.graphrbac.models.PreAuthorizedApplicationPermission.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.PreAuthorizedApplicationPermission.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.PreAuthorizedApplicationPermission.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.PreAuthorizedApplicationPermission.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.PreAuthorizedApplicationPermission.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.PreAuthorizedApplicationPermission.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.PreAuthorizedApplicationPermission.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.RequiredResourceAccess.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.RequiredResourceAccess.yml new file mode 100644 index 00000000..915c2d67 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.RequiredResourceAccess.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.RequiredResourceAccess +name: RequiredResourceAccess +fullName: azure.graphrbac.models.RequiredResourceAccess +module: azure.graphrbac.models +summary: 'Specifies the set of OAuth 2.0 permission scopes and app roles under the + + specified resource that an application requires access to. The specified + + OAuth 2.0 permission scopes may be requested by client applications + + (through the requiredResourceAccess collection) when calling a resource + + application. The requiredResourceAccess property of the Application entity + + is a collection of RequiredResourceAccess. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RequiredResourceAccess(*, resource_access, additional_properties=None, + resource_app_id: str = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: resource_access + description: 'Required. The list of OAuth2.0 permission scopes + + and app roles that the application requires from the specified resource.' + isRequired: true + types: + - [] + - name: resource_app_id + description: 'The unique identifier for the resource that the + + application requires access to. This should be equal to the appId declared + + on the target resource application.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: resource_access + isRequired: true + - name: additional_properties + isRequired: true + - name: resource_app_id + isRequired: true +methods: +- uid: azure.graphrbac.models.RequiredResourceAccess.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.RequiredResourceAccess.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.RequiredResourceAccess.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.RequiredResourceAccess.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.RequiredResourceAccess.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.RequiredResourceAccess.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.RequiredResourceAccess.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ResourceAccess.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ResourceAccess.yml new file mode 100644 index 00000000..c283a7d0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ResourceAccess.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.ResourceAccess +name: ResourceAccess +fullName: azure.graphrbac.models.ResourceAccess +module: azure.graphrbac.models +summary: 'Specifies an OAuth 2.0 permission scope or an app role that an application + + requires. The resourceAccess property of the RequiredResourceAccess type is + + a collection of ResourceAccess. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ResourceAccess(*, id: str, additional_properties=None, type: str = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: id + description: 'Required. The unique identifier for one of the OAuth2Permission + + or AppRole instances that the resource application exposes.' + isRequired: true + types: + - + - name: type + description: 'Specifies whether the id property references an + + OAuth2Permission or an AppRole. Possible values are "scope" or "role".' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: additional_properties + isRequired: true + - name: type + isRequired: true +methods: +- uid: azure.graphrbac.models.ResourceAccess.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ResourceAccess.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ResourceAccess.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.ResourceAccess.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ResourceAccess.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.ResourceAccess.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ResourceAccess.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipal.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipal.yml new file mode 100644 index 00000000..c510c8c5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipal.yml @@ -0,0 +1,326 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.ServicePrincipal +name: ServicePrincipal +fullName: azure.graphrbac.models.ServicePrincipal +module: azure.graphrbac.models +summary: 'Active Directory service principal information. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ServicePrincipal(*, additional_properties=None, account_enabled: bool = + None, alternative_names=None, app_id: str = None, app_role_assignment_required: + bool = None, app_roles=None, display_name: str = None, error_url: str = None, + homepage: str = None, key_credentials=None, logout_url: str = None, password_credentials=None, + preferred_token_signing_key_thumbprint: str = None, publisher_name: str = None, + reply_urls=None, saml_metadata_url: str = None, service_principal_names=None, + service_principal_type: str = None, tags=None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: object_type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: account_enabled + description: 'whether or not the service principal account is + + enabled' + isRequired: true + types: + - + - name: alternative_names + description: alternative names + isRequired: true + types: + - [] + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: app_role_assignment_required + description: 'Specifies whether an + + AppRoleAssignment to a user or group is required before Azure AD will + + issue a user or access token to the application.' + isRequired: true + types: + - + - name: app_roles + description: 'The collection of application roles that an application + + may declare. These roles can be assigned to users, groups or service + + principals.' + isRequired: true + types: + - [] + - name: display_name + description: The display name of the service principal. + isRequired: true + types: + - + - name: error_url + description: 'A URL provided by the author of the associated + + application to report errors when using the application.' + isRequired: true + types: + - + - name: homepage + description: The URL to the homepage of the associated application. + isRequired: true + types: + - + - name: key_credentials + description: 'The collection of key credentials associated with + + the service principal.' + isRequired: true + types: + - [] + - name: logout_url + description: 'A URL provided by the author of the associated + + application to logout' + isRequired: true + types: + - + - name: password_credentials + description: 'The collection of password credentials + + associated with the service principal.' + isRequired: true + types: + - [] + - name: preferred_token_signing_key_thumbprint + description: 'The thumbprint of preferred + + certificate to sign the token' + isRequired: true + types: + - + - name: publisher_name + description: The publisher's name of the associated application + isRequired: true + types: + - + - name: reply_urls + description: 'The URLs that user tokens are sent to for sign in with + + the associated application. The redirect URIs that the oAuth 2.0 + + authorization code and access tokens are sent to for the associated + + application.' + isRequired: true + types: + - [] + - name: saml_metadata_url + description: 'The URL to the SAML metadata of the associated + + application' + isRequired: true + types: + - + - name: service_principal_names + description: A collection of service principal names. + isRequired: true + types: + - [] + - name: service_principal_type + description: the type of the service principal + isRequired: true + types: + - + - name: tags + description: 'Optional list of tags that you can apply to your service + + principals. Not nullable.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: account_enabled + isRequired: true + - name: alternative_names + isRequired: true + - name: app_id + isRequired: true + - name: app_role_assignment_required + isRequired: true + - name: app_roles + isRequired: true + - name: display_name + isRequired: true + - name: error_url + isRequired: true + - name: homepage + isRequired: true + - name: key_credentials + isRequired: true + - name: logout_url + isRequired: true + - name: password_credentials + isRequired: true + - name: preferred_token_signing_key_thumbprint + isRequired: true + - name: publisher_name + isRequired: true + - name: reply_urls + isRequired: true + - name: saml_metadata_url + isRequired: true + - name: service_principal_names + isRequired: true + - name: service_principal_type + isRequired: true + - name: tags + isRequired: true +variables: +- description: The object ID. + name: object_id + types: + - +- description: 'The time at which the directory object was + + deleted.' + name: deletion_timestamp + types: + - +- description: 'The display name exposed by the associated + + application.' + name: app_display_name + types: + - +- name: app_owner_tenant_id + types: + - +- description: 'The OAuth 2.0 permissions exposed by the + + associated application.' + name: oauth2_permissions + types: + - [] +methods: +- uid: azure.graphrbac.models.ServicePrincipal.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ServicePrincipal.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ServicePrincipal.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.ServicePrincipal.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ServicePrincipal.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.ServicePrincipal.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ServicePrincipal.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalBase.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalBase.yml new file mode 100644 index 00000000..bc3fa2c1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalBase.yml @@ -0,0 +1,174 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.ServicePrincipalBase +name: ServicePrincipalBase +fullName: azure.graphrbac.models.ServicePrincipalBase +module: azure.graphrbac.models +summary: 'Active Directory service principal common properties shared among GET, POST + + and PATCH.' +constructor: + syntax: 'ServicePrincipalBase(*, account_enabled: bool = None, app_role_assignment_required: + bool = None, key_credentials=None, password_credentials=None, service_principal_type: + str = None, tags=None, **kwargs)' + parameters: + - name: account_enabled + description: 'whether or not the service principal account is + + enabled' + isRequired: true + types: + - + - name: app_role_assignment_required + description: 'Specifies whether an + + AppRoleAssignment to a user or group is required before Azure AD will + + issue a user or access token to the application.' + isRequired: true + types: + - + - name: key_credentials + description: 'The collection of key credentials associated with + + the service principal.' + isRequired: true + types: + - [] + - name: password_credentials + description: 'The collection of password credentials + + associated with the service principal.' + isRequired: true + types: + - [] + - name: service_principal_type + description: the type of the service principal + isRequired: true + types: + - + - name: tags + description: 'Optional list of tags that you can apply to your service + + principals. Not nullable.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: account_enabled + isRequired: true + - name: app_role_assignment_required + isRequired: true + - name: key_credentials + isRequired: true + - name: password_credentials + isRequired: true + - name: service_principal_type + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.graphrbac.models.ServicePrincipalBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ServicePrincipalBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ServicePrincipalBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.ServicePrincipalBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ServicePrincipalBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.ServicePrincipalBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ServicePrincipalBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalCreateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalCreateParameters.yml new file mode 100644 index 00000000..25c0239d --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalCreateParameters.yml @@ -0,0 +1,182 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.ServicePrincipalCreateParameters +name: ServicePrincipalCreateParameters +fullName: azure.graphrbac.models.ServicePrincipalCreateParameters +module: azure.graphrbac.models +summary: 'Request parameters for creating a new service principal. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ServicePrincipalCreateParameters(*, app_id: str, account_enabled: bool + = None, app_role_assignment_required: bool = None, key_credentials=None, password_credentials=None, + service_principal_type: str = None, tags=None, **kwargs)' + parameters: + - name: account_enabled + description: 'whether or not the service principal account is + + enabled' + isRequired: true + types: + - + - name: app_role_assignment_required + description: 'Specifies whether an + + AppRoleAssignment to a user or group is required before Azure AD will + + issue a user or access token to the application.' + isRequired: true + types: + - + - name: key_credentials + description: 'The collection of key credentials associated with + + the service principal.' + isRequired: true + types: + - [] + - name: password_credentials + description: 'The collection of password credentials + + associated with the service principal.' + isRequired: true + types: + - [] + - name: service_principal_type + description: the type of the service principal + isRequired: true + types: + - + - name: tags + description: 'Optional list of tags that you can apply to your service + + principals. Not nullable.' + isRequired: true + types: + - [] + - name: app_id + description: Required. The application ID. + isRequired: true + types: + - + keywordOnlyParameters: + - name: app_id + isRequired: true + - name: account_enabled + isRequired: true + - name: app_role_assignment_required + isRequired: true + - name: key_credentials + isRequired: true + - name: password_credentials + isRequired: true + - name: service_principal_type + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.graphrbac.models.ServicePrincipalCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ServicePrincipalCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ServicePrincipalCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.ServicePrincipalCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ServicePrincipalCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.ServicePrincipalCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ServicePrincipalCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalObjectResult.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalObjectResult.yml new file mode 100644 index 00000000..a3157e7f --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalObjectResult.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.ServicePrincipalObjectResult +name: ServicePrincipalObjectResult +fullName: azure.graphrbac.models.ServicePrincipalObjectResult +module: azure.graphrbac.models +summary: Service Principal Object Result. +constructor: + syntax: 'ServicePrincipalObjectResult(*, value: str = None, odatametadata: str = + None, **kwargs)' + parameters: + - name: value + description: 'The Object ID of the service principal with the specified + + application ID.' + isRequired: true + types: + - + - name: odatametadata + description: The URL representing edm equivalent. + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: odatametadata + isRequired: true +methods: +- uid: azure.graphrbac.models.ServicePrincipalObjectResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ServicePrincipalObjectResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ServicePrincipalObjectResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.ServicePrincipalObjectResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ServicePrincipalObjectResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.ServicePrincipalObjectResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ServicePrincipalObjectResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalPaged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalPaged.yml new file mode 100644 index 00000000..9423999e --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.ServicePrincipalPaged +name: ServicePrincipalPaged +fullName: azure.graphrbac.models.ServicePrincipalPaged +module: azure.graphrbac.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: ServicePrincipalPaged(*args, **kwargs) +methods: +- uid: azure.graphrbac.models.ServicePrincipalPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.graphrbac.models.ServicePrincipalPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.graphrbac.models.ServicePrincipalPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.ServicePrincipalPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.ServicePrincipalPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.graphrbac.models.ServicePrincipalPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.graphrbac.models.ServicePrincipalPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalUpdateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalUpdateParameters.yml new file mode 100644 index 00000000..e79c163c --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalUpdateParameters.yml @@ -0,0 +1,172 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.ServicePrincipalUpdateParameters +name: ServicePrincipalUpdateParameters +fullName: azure.graphrbac.models.ServicePrincipalUpdateParameters +module: azure.graphrbac.models +summary: Request parameters for update an existing service principal. +constructor: + syntax: 'ServicePrincipalUpdateParameters(*, account_enabled: bool = None, app_role_assignment_required: + bool = None, key_credentials=None, password_credentials=None, service_principal_type: + str = None, tags=None, **kwargs)' + parameters: + - name: account_enabled + description: 'whether or not the service principal account is + + enabled' + isRequired: true + types: + - + - name: app_role_assignment_required + description: 'Specifies whether an + + AppRoleAssignment to a user or group is required before Azure AD will + + issue a user or access token to the application.' + isRequired: true + types: + - + - name: key_credentials + description: 'The collection of key credentials associated with + + the service principal.' + isRequired: true + types: + - [] + - name: password_credentials + description: 'The collection of password credentials + + associated with the service principal.' + isRequired: true + types: + - [] + - name: service_principal_type + description: the type of the service principal + isRequired: true + types: + - + - name: tags + description: 'Optional list of tags that you can apply to your service + + principals. Not nullable.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: account_enabled + isRequired: true + - name: app_role_assignment_required + isRequired: true + - name: key_credentials + isRequired: true + - name: password_credentials + isRequired: true + - name: service_principal_type + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.graphrbac.models.ServicePrincipalUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ServicePrincipalUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ServicePrincipalUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.ServicePrincipalUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ServicePrincipalUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.ServicePrincipalUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ServicePrincipalUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.SignInName.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.SignInName.yml new file mode 100644 index 00000000..2b337bef --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.SignInName.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.SignInName +name: SignInName +fullName: azure.graphrbac.models.SignInName +module: azure.graphrbac.models +summary: 'Contains information about a sign-in name of a local account user in an + + Azure Active Directory B2C tenant.' +constructor: + syntax: 'SignInName(*, additional_properties=None, type: str = None, value: str + = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: type + description: 'A string value that can be used to classify user sign-in + + types in your directory, such as ''emailAddress'' or ''userName''.' + isRequired: true + types: + - + - name: value + description: 'The sign-in used by the local account. Must be unique across + + the company/tenant. For example, ''.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: type + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.graphrbac.models.SignInName.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.SignInName.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.SignInName.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.SignInName.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.SignInName.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.SignInName.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.SignInName.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.StrPaged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.StrPaged.yml new file mode 100644 index 00000000..94075a91 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.StrPaged.yml @@ -0,0 +1,70 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.StrPaged +name: StrPaged +fullName: azure.graphrbac.models.StrPaged +module: azure.graphrbac.models +summary: A paging container for iterating over a list of str object +constructor: + syntax: StrPaged(*args, **kwargs) +methods: +- uid: azure.graphrbac.models.StrPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.graphrbac.models.StrPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.graphrbac.models.StrPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.StrPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.StrPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.graphrbac.models.StrPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.graphrbac.models.StrPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.User(class).yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.User(class).yml new file mode 100644 index 00000000..a5455943 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.User(class).yml @@ -0,0 +1,246 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.User +name: User +fullName: azure.graphrbac.models.User +module: azure.graphrbac.models +summary: 'Active Directory user information. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'User(*, additional_properties=None, immutable_id: str = None, usage_location: + str = None, given_name: str = None, surname: str = None, user_type=None, account_enabled: + bool = None, display_name: str = None, user_principal_name: str = None, mail_nickname: + str = None, mail: str = None, sign_in_names=None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: object_type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: immutable_id + description: 'This must be specified if you are using a federated + + domain for the user''s userPrincipalName (UPN) property when creating a new + + user account. It is used to associate an on-premises Active Directory user + + account with their Azure AD user object.' + isRequired: true + types: + - + - name: usage_location + description: 'A two letter country code (ISO standard 3166). + + Required for users that will be assigned licenses due to legal requirement + + to check for availability of services in countries. Examples include: + + "US", "JP", and "GB".' + isRequired: true + types: + - + - name: given_name + description: The given name for the user. + isRequired: true + types: + - + - name: surname + description: The user's surname (family name or last name). + isRequired: true + types: + - + - name: user_type + description: 'A string value that can be used to classify user types + + in your directory, such as ''Member'' and ''Guest''. Possible values include: + + ''Member'', ''Guest''' + isRequired: true + types: + - + - + - name: account_enabled + description: Whether the account is enabled. + isRequired: true + types: + - + - name: display_name + description: The display name of the user. + isRequired: true + types: + - + - name: user_principal_name + description: The principal name of the user. + isRequired: true + types: + - + - name: mail_nickname + description: The mail alias for the user. + isRequired: true + types: + - + - name: mail + description: The primary email address of the user. + isRequired: true + types: + - + - name: sign_in_names + description: The sign-in names of the user. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: immutable_id + isRequired: true + - name: usage_location + isRequired: true + - name: given_name + isRequired: true + - name: surname + isRequired: true + - name: user_type + isRequired: true + - name: account_enabled + isRequired: true + - name: display_name + isRequired: true + - name: user_principal_name + isRequired: true + - name: mail_nickname + isRequired: true + - name: mail + isRequired: true + - name: sign_in_names + isRequired: true +variables: +- description: The object ID. + name: object_id + types: + - +- description: 'The time at which the directory object was + + deleted.' + name: deletion_timestamp + types: + - +methods: +- uid: azure.graphrbac.models.User.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.User.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.User.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.User.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.User.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.User.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.User.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserBase.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserBase.yml new file mode 100644 index 00000000..39723f03 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserBase.yml @@ -0,0 +1,178 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.UserBase +name: UserBase +fullName: azure.graphrbac.models.UserBase +module: azure.graphrbac.models +summary: UserBase. +constructor: + syntax: 'UserBase(*, additional_properties=None, immutable_id: str = None, usage_location: + str = None, given_name: str = None, surname: str = None, user_type=None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: immutable_id + description: 'This must be specified if you are using a federated + + domain for the user''s userPrincipalName (UPN) property when creating a new + + user account. It is used to associate an on-premises Active Directory user + + account with their Azure AD user object.' + isRequired: true + types: + - + - name: usage_location + description: 'A two letter country code (ISO standard 3166). + + Required for users that will be assigned licenses due to legal requirement + + to check for availability of services in countries. Examples include: + + "US", "JP", and "GB".' + isRequired: true + types: + - + - name: given_name + description: The given name for the user. + isRequired: true + types: + - + - name: surname + description: The user's surname (family name or last name). + isRequired: true + types: + - + - name: user_type + description: 'A string value that can be used to classify user types + + in your directory, such as ''Member'' and ''Guest''. Possible values include: + + ''Member'', ''Guest''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: immutable_id + isRequired: true + - name: usage_location + isRequired: true + - name: given_name + isRequired: true + - name: surname + isRequired: true + - name: user_type + isRequired: true +methods: +- uid: azure.graphrbac.models.UserBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.UserBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.UserBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.UserBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.UserBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.UserBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.UserBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserCreateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserCreateParameters.yml new file mode 100644 index 00000000..27170325 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserCreateParameters.yml @@ -0,0 +1,230 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.UserCreateParameters +name: UserCreateParameters +fullName: azure.graphrbac.models.UserCreateParameters +module: azure.graphrbac.models +summary: 'Request parameters for creating a new work or school account user. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'UserCreateParameters(*, account_enabled: bool, display_name: str, password_profile, + user_principal_name: str, mail_nickname: str, additional_properties=None, immutable_id: + str = None, usage_location: str = None, given_name: str = None, surname: str = + None, user_type=None, mail: str = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: immutable_id + description: 'This must be specified if you are using a federated + + domain for the user''s userPrincipalName (UPN) property when creating a new + + user account. It is used to associate an on-premises Active Directory user + + account with their Azure AD user object.' + isRequired: true + types: + - + - name: usage_location + description: 'A two letter country code (ISO standard 3166). + + Required for users that will be assigned licenses due to legal requirement + + to check for availability of services in countries. Examples include: + + "US", "JP", and "GB".' + isRequired: true + types: + - + - name: given_name + description: The given name for the user. + isRequired: true + types: + - + - name: surname + description: The user's surname (family name or last name). + isRequired: true + types: + - + - name: user_type + description: 'A string value that can be used to classify user types + + in your directory, such as ''Member'' and ''Guest''. Possible values include: + + ''Member'', ''Guest''' + isRequired: true + types: + - + - + - name: account_enabled + description: Required. Whether the account is enabled. + isRequired: true + types: + - + - name: display_name + description: Required. The display name of the user. + isRequired: true + types: + - + - name: password_profile + description: Required. Password Profile + isRequired: true + types: + - + - name: user_principal_name + description: 'Required. The user principal name + + (). It must contain one of the verified domains + for + + the tenant.' + isRequired: true + types: + - + - name: mail_nickname + description: Required. The mail alias for the user. + isRequired: true + types: + - + - name: mail + description: The primary email address of the user. + isRequired: true + types: + - + keywordOnlyParameters: + - name: account_enabled + isRequired: true + - name: display_name + isRequired: true + - name: password_profile + isRequired: true + - name: user_principal_name + isRequired: true + - name: mail_nickname + isRequired: true + - name: additional_properties + isRequired: true + - name: immutable_id + isRequired: true + - name: usage_location + isRequired: true + - name: given_name + isRequired: true + - name: surname + isRequired: true + - name: user_type + isRequired: true + - name: mail + isRequired: true +methods: +- uid: azure.graphrbac.models.UserCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.UserCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.UserCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.UserCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.UserCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.UserCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.UserCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserGetMemberGroupsParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserGetMemberGroupsParameters.yml new file mode 100644 index 00000000..c797ccaa --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserGetMemberGroupsParameters.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.UserGetMemberGroupsParameters +name: UserGetMemberGroupsParameters +fullName: azure.graphrbac.models.UserGetMemberGroupsParameters +module: azure.graphrbac.models +summary: 'Request parameters for GetMemberGroups API call. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'UserGetMemberGroupsParameters(*, security_enabled_only: bool, additional_properties=None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: security_enabled_only + description: 'Required. If true, only membership in + + security-enabled groups should be checked. Otherwise, membership in all + + groups should be checked.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: security_enabled_only + isRequired: true + - name: additional_properties + isRequired: true +methods: +- uid: azure.graphrbac.models.UserGetMemberGroupsParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.UserGetMemberGroupsParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.UserGetMemberGroupsParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.UserGetMemberGroupsParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.UserGetMemberGroupsParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.UserGetMemberGroupsParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.UserGetMemberGroupsParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserPaged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserPaged.yml new file mode 100644 index 00000000..739c2d49 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.UserPaged +name: UserPaged +fullName: azure.graphrbac.models.UserPaged +module: azure.graphrbac.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: UserPaged(*args, **kwargs) +methods: +- uid: azure.graphrbac.models.UserPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.graphrbac.models.UserPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.graphrbac.models.UserPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.UserPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.UserPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.graphrbac.models.UserPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.graphrbac.models.UserPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserType.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserType.yml new file mode 100644 index 00000000..6ca4a152 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.graphrbac.models.UserType +name: UserType +fullName: azure.graphrbac.models.UserType +module: azure.graphrbac.models +fields: +- name: guest + uid: azure.graphrbac.models.UserType.guest +- name: member + uid: azure.graphrbac.models.UserType.member diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserUpdateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserUpdateParameters.yml new file mode 100644 index 00000000..5d67c25f --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserUpdateParameters.yml @@ -0,0 +1,220 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.UserUpdateParameters +name: UserUpdateParameters +fullName: azure.graphrbac.models.UserUpdateParameters +module: azure.graphrbac.models +summary: Request parameters for updating an existing work or school account user. +constructor: + syntax: 'UserUpdateParameters(*, additional_properties=None, immutable_id: str = + None, usage_location: str = None, given_name: str = None, surname: str = None, + user_type=None, account_enabled: bool = None, display_name: str = None, password_profile=None, + user_principal_name: str = None, mail_nickname: str = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: immutable_id + description: 'This must be specified if you are using a federated + + domain for the user''s userPrincipalName (UPN) property when creating a new + + user account. It is used to associate an on-premises Active Directory user + + account with their Azure AD user object.' + isRequired: true + types: + - + - name: usage_location + description: 'A two letter country code (ISO standard 3166). + + Required for users that will be assigned licenses due to legal requirement + + to check for availability of services in countries. Examples include: + + "US", "JP", and "GB".' + isRequired: true + types: + - + - name: given_name + description: The given name for the user. + isRequired: true + types: + - + - name: surname + description: The user's surname (family name or last name). + isRequired: true + types: + - + - name: user_type + description: 'A string value that can be used to classify user types + + in your directory, such as ''Member'' and ''Guest''. Possible values include: + + ''Member'', ''Guest''' + isRequired: true + types: + - + - + - name: account_enabled + description: Whether the account is enabled. + isRequired: true + types: + - + - name: display_name + description: The display name of the user. + isRequired: true + types: + - + - name: password_profile + description: The password profile of the user. + isRequired: true + types: + - + - name: user_principal_name + description: 'The user principal name + + (). It must contain one of the verified domains + for + + the tenant.' + isRequired: true + types: + - + - name: mail_nickname + description: The mail alias for the user. + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: immutable_id + isRequired: true + - name: usage_location + isRequired: true + - name: given_name + isRequired: true + - name: surname + isRequired: true + - name: user_type + isRequired: true + - name: account_enabled + isRequired: true + - name: display_name + isRequired: true + - name: password_profile + isRequired: true + - name: user_principal_name + isRequired: true + - name: mail_nickname + isRequired: true +methods: +- uid: azure.graphrbac.models.UserUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.UserUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.UserUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.UserUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.UserUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.UserUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.UserUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group.ADGroup.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group.ADGroup.yml new file mode 100644 index 00000000..bdf18411 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group.ADGroup.yml @@ -0,0 +1,175 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.ad_group.ADGroup +name: ADGroup +fullName: azure.graphrbac.models.ad_group.ADGroup +module: azure.graphrbac.models.ad_group +summary: 'Active Directory group information. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ADGroup(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: object_type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: display_name + description: The display name of the group. + isRequired: true + types: + - + - name: mail_enabled + description: 'Whether the group is mail-enabled. Must be false. + + This is because only pure security groups can be created using the Graph + + API.' + isRequired: true + types: + - + - name: mail_nickname + description: The mail alias for the group. + isRequired: true + types: + - + - name: security_enabled + description: Whether the group is security-enable. + isRequired: true + types: + - + - name: mail + description: The primary email address of the group. + isRequired: true + types: + - +variables: +- description: The object ID. + name: object_id + types: + - +- description: 'The time at which the directory object was + + deleted.' + name: deletion_timestamp + types: + - +methods: +- uid: azure.graphrbac.models.ad_group.ADGroup.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ad_group.ADGroup.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ad_group.ADGroup.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.ad_group.ADGroup.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ad_group.ADGroup.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.ad_group.ADGroup.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ad_group.ADGroup.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group.yml new file mode 100644 index 00000000..5525fbe6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.ad_group +name: ad_group +fullName: azure.graphrbac.models.ad_group +classes: +- azure.graphrbac.models.ad_group.ADGroup diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group_paged.ADGroupPaged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group_paged.ADGroupPaged.yml new file mode 100644 index 00000000..c3c07f58 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group_paged.ADGroupPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.ad_group_paged.ADGroupPaged +name: ADGroupPaged +fullName: azure.graphrbac.models.ad_group_paged.ADGroupPaged +module: azure.graphrbac.models.ad_group_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: ADGroupPaged(*args, **kwargs) +methods: +- uid: azure.graphrbac.models.ad_group_paged.ADGroupPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.graphrbac.models.ad_group_paged.ADGroupPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.graphrbac.models.ad_group_paged.ADGroupPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.ad_group_paged.ADGroupPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.ad_group_paged.ADGroupPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.graphrbac.models.ad_group_paged.ADGroupPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.graphrbac.models.ad_group_paged.ADGroupPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group_paged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group_paged.yml new file mode 100644 index 00000000..bd57e284 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.ad_group_paged +name: ad_group_paged +fullName: azure.graphrbac.models.ad_group_paged +classes: +- azure.graphrbac.models.ad_group_paged.ADGroupPaged diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group_py3.ADGroup.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group_py3.ADGroup.yml new file mode 100644 index 00000000..2b02090e --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group_py3.ADGroup.yml @@ -0,0 +1,190 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.ad_group_py3.ADGroup +name: ADGroup +fullName: azure.graphrbac.models.ad_group_py3.ADGroup +module: azure.graphrbac.models.ad_group_py3 +summary: 'Active Directory group information. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ADGroup(*, additional_properties=None, display_name: str = None, mail_enabled: + bool = None, mail_nickname: str = None, security_enabled: bool = None, mail: str + = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: object_type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: display_name + description: The display name of the group. + isRequired: true + types: + - + - name: mail_enabled + description: 'Whether the group is mail-enabled. Must be false. + + This is because only pure security groups can be created using the Graph + + API.' + isRequired: true + types: + - + - name: mail_nickname + description: The mail alias for the group. + isRequired: true + types: + - + - name: security_enabled + description: Whether the group is security-enable. + isRequired: true + types: + - + - name: mail + description: The primary email address of the group. + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: display_name + isRequired: true + - name: mail_enabled + isRequired: true + - name: mail_nickname + isRequired: true + - name: security_enabled + isRequired: true + - name: mail + isRequired: true +variables: +- description: The object ID. + name: object_id + types: + - +- description: 'The time at which the directory object was + + deleted.' + name: deletion_timestamp + types: + - +methods: +- uid: azure.graphrbac.models.ad_group_py3.ADGroup.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ad_group_py3.ADGroup.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ad_group_py3.ADGroup.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.ad_group_py3.ADGroup.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.ad_group_py3.ADGroup.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.ad_group_py3.ADGroup.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.ad_group_py3.ADGroup.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group_py3.yml new file mode 100644 index 00000000..4b445eef --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.ad_group_py3 +name: ad_group_py3 +fullName: azure.graphrbac.models.ad_group_py3 +classes: +- azure.graphrbac.models.ad_group_py3.ADGroup diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.add_owner_parameters.AddOwnerParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.add_owner_parameters.AddOwnerParameters.yml new file mode 100644 index 00000000..5ee92b3c --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.add_owner_parameters.AddOwnerParameters.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.add_owner_parameters.AddOwnerParameters +name: AddOwnerParameters +fullName: azure.graphrbac.models.add_owner_parameters.AddOwnerParameters +module: azure.graphrbac.models.add_owner_parameters +summary: 'Request parameters for adding a owner to an application. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: AddOwnerParameters(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: url + description: 'Required. A owner object URL, such as + + "[https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd](https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd)", + + where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and + + "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the owner (user, + + application, servicePrincipal, group) to be added.' + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.add_owner_parameters.AddOwnerParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.add_owner_parameters.AddOwnerParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.add_owner_parameters.AddOwnerParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.add_owner_parameters.AddOwnerParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.add_owner_parameters.AddOwnerParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.add_owner_parameters.AddOwnerParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.add_owner_parameters.AddOwnerParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.add_owner_parameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.add_owner_parameters.yml new file mode 100644 index 00000000..f1274b9b --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.add_owner_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.add_owner_parameters +name: add_owner_parameters +fullName: azure.graphrbac.models.add_owner_parameters +classes: +- azure.graphrbac.models.add_owner_parameters.AddOwnerParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.add_owner_parameters_py3.AddOwnerParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.add_owner_parameters_py3.AddOwnerParameters.yml new file mode 100644 index 00000000..69650022 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.add_owner_parameters_py3.AddOwnerParameters.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.add_owner_parameters_py3.AddOwnerParameters +name: AddOwnerParameters +fullName: azure.graphrbac.models.add_owner_parameters_py3.AddOwnerParameters +module: azure.graphrbac.models.add_owner_parameters_py3 +summary: 'Request parameters for adding a owner to an application. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AddOwnerParameters(*, url: str, additional_properties=None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: url + description: 'Required. A owner object URL, such as + + "[https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd](https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd)", + + where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and + + "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the owner (user, + + application, servicePrincipal, group) to be added.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: url + isRequired: true + - name: additional_properties + isRequired: true +methods: +- uid: azure.graphrbac.models.add_owner_parameters_py3.AddOwnerParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.add_owner_parameters_py3.AddOwnerParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.add_owner_parameters_py3.AddOwnerParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.add_owner_parameters_py3.AddOwnerParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.add_owner_parameters_py3.AddOwnerParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.add_owner_parameters_py3.AddOwnerParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.add_owner_parameters_py3.AddOwnerParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.add_owner_parameters_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.add_owner_parameters_py3.yml new file mode 100644 index 00000000..04bf2a05 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.add_owner_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.add_owner_parameters_py3 +name: add_owner_parameters_py3 +fullName: azure.graphrbac.models.add_owner_parameters_py3 +classes: +- azure.graphrbac.models.add_owner_parameters_py3.AddOwnerParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.app_role.AppRole.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.app_role.AppRole.yml new file mode 100644 index 00000000..3bda16b5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.app_role.AppRole.yml @@ -0,0 +1,163 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.app_role.AppRole +name: AppRole +fullName: azure.graphrbac.models.app_role.AppRole +module: azure.graphrbac.models.app_role +summary: AppRole. +constructor: + syntax: AppRole(**kwargs) + parameters: + - name: id + description: Unique role identifier inside the appRoles collection. + isRequired: true + types: + - + - name: allowed_member_types + description: 'Specifies whether this app role definition + + can be assigned to users and groups by setting to ''User'', or to other + + applications (that are accessing this application in daemon service + + scenarios) by setting to ''Application'', or to both.' + isRequired: true + types: + - [] + - name: description + description: 'Permission help text that appears in the admin app + + assignment and consent experiences.' + isRequired: true + types: + - + - name: display_name + description: 'Display name for the permission that appears in the + + admin consent and app assignment experiences.' + isRequired: true + types: + - + - name: is_enabled + description: 'When creating or updating a role definition, this must + + be set to true (which is the default). To delete a role, this must first + + be set to false. At that point, in a subsequent call, this role may be + + removed.' + isRequired: true + types: + - + - name: value + description: 'Specifies the value of the roles claim that the application + + should expect in the authentication and access tokens.' + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.app_role.AppRole.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.app_role.AppRole.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.app_role.AppRole.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.app_role.AppRole.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.app_role.AppRole.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.app_role.AppRole.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.app_role.AppRole.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.app_role.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.app_role.yml new file mode 100644 index 00000000..f93b9100 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.app_role.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.app_role +name: app_role +fullName: azure.graphrbac.models.app_role +classes: +- azure.graphrbac.models.app_role.AppRole diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.app_role_py3.AppRole.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.app_role_py3.AppRole.yml new file mode 100644 index 00000000..df46d155 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.app_role_py3.AppRole.yml @@ -0,0 +1,178 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.app_role_py3.AppRole +name: AppRole +fullName: azure.graphrbac.models.app_role_py3.AppRole +module: azure.graphrbac.models.app_role_py3 +summary: AppRole. +constructor: + syntax: 'AppRole(*, id: str = None, allowed_member_types=None, description: str + = None, display_name: str = None, is_enabled: bool = None, value: str = None, + **kwargs)' + parameters: + - name: id + description: Unique role identifier inside the appRoles collection. + isRequired: true + types: + - + - name: allowed_member_types + description: 'Specifies whether this app role definition + + can be assigned to users and groups by setting to ''User'', or to other + + applications (that are accessing this application in daemon service + + scenarios) by setting to ''Application'', or to both.' + isRequired: true + types: + - [] + - name: description + description: 'Permission help text that appears in the admin app + + assignment and consent experiences.' + isRequired: true + types: + - + - name: display_name + description: 'Display name for the permission that appears in the + + admin consent and app assignment experiences.' + isRequired: true + types: + - + - name: is_enabled + description: 'When creating or updating a role definition, this must + + be set to true (which is the default). To delete a role, this must first + + be set to false. At that point, in a subsequent call, this role may be + + removed.' + isRequired: true + types: + - + - name: value + description: 'Specifies the value of the roles claim that the application + + should expect in the authentication and access tokens.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: allowed_member_types + isRequired: true + - name: description + isRequired: true + - name: display_name + isRequired: true + - name: is_enabled + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.graphrbac.models.app_role_py3.AppRole.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.app_role_py3.AppRole.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.app_role_py3.AppRole.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.app_role_py3.AppRole.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.app_role_py3.AppRole.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.app_role_py3.AppRole.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.app_role_py3.AppRole.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.app_role_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.app_role_py3.yml new file mode 100644 index 00000000..3507c88e --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.app_role_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.app_role_py3 +name: app_role_py3 +fullName: azure.graphrbac.models.app_role_py3 +classes: +- azure.graphrbac.models.app_role_py3.AppRole diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application.Application.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application.Application.yml new file mode 100644 index 00000000..019b8774 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application.Application.yml @@ -0,0 +1,369 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.application.Application +name: Application +fullName: azure.graphrbac.models.application.Application +module: azure.graphrbac.models.application +summary: 'Active Directory application information. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Application(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: object_type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: allow_guests_sign_in + description: 'A property on the application to indicate if + + the application accepts other IDPs or not or partially accepts.' + isRequired: true + types: + - + - name: allow_passthrough_users + description: 'Indicates that the application supports + + pass through users who have no presence in the resource tenant.' + isRequired: true + types: + - + - name: app_logo_url + description: 'The url for the application logo image stored in a + + CDN.' + isRequired: true + types: + - + - name: app_roles + description: 'The collection of application roles that an application + + may declare. These roles can be assigned to users, groups or service + + principals.' + isRequired: true + types: + - [] + - name: app_permissions + description: The application permissions. + isRequired: true + types: + - [] + - name: available_to_other_tenants + description: 'Whether the application is available to + + other tenants.' + isRequired: true + types: + - + - name: display_name + description: The display name of the application. + isRequired: true + types: + - + - name: error_url + description: 'A URL provided by the author of the application to + + report errors when using the application.' + isRequired: true + types: + - + - name: group_membership_claims + description: 'Configures the groups claim issued in a + + user or OAuth 2.0 access token that the app expects.' + isRequired: true + types: + - + - name: homepage + description: The home page of the application. + isRequired: true + types: + - + - name: identifier_uris + description: A collection of URIs for the application. + isRequired: true + types: + - [] + - name: informational_urls + description: 'URLs with more information about the + + application.' + isRequired: true + types: + - + - name: is_device_only_auth_supported + description: 'Specifies whether this application + + supports device authentication without a user. The default is false.' + isRequired: true + types: + - + - name: key_credentials + description: A collection of KeyCredential objects. + isRequired: true + types: + - [] + - name: known_client_applications + description: 'Client applications that are tied to + + this resource application. Consent to any of the known client applications + + will result in implicit consent to the resource application through a + + combined consent dialog (showing the OAuth permission scopes required by + + the client and the resource).' + isRequired: true + types: + - [] + - name: logout_url + description: the url of the logout page + isRequired: true + types: + - + - name: oauth2_allow_implicit_flow + description: 'Whether to allow implicit grant flow + + for OAuth2' + isRequired: true + types: + - + - name: oauth2_allow_url_path_matching + description: 'Specifies whether during a token + + Request Azure AD will allow path matching of the redirect URI against the + + applications collection of replyURLs. The default is false.' + isRequired: true + types: + - + - name: oauth2_permissions + description: 'The collection of OAuth 2.0 permission scopes + + that the web API (resource) application exposes to client applications. + + These permission scopes may be granted to client applications during + + consent.' + isRequired: true + types: + - [] + - name: oauth2_require_post_response + description: 'Specifies whether, as part of OAuth + + 2.0 token requests, Azure AD will allow POST requests, as opposed to GET + + requests. The default is false, which specifies that only GET requests + + will be allowed.' + isRequired: true + types: + - + - name: org_restrictions + description: A list of tenants allowed to access application. + isRequired: true + types: + - [] + - name: optional_claims + isRequired: true + types: + - + - name: password_credentials + description: A collection of PasswordCredential objects + isRequired: true + types: + - [] + - name: pre_authorized_applications + description: list of pre-authorized applications. + isRequired: true + types: + - [] + - name: public_client + description: 'Specifies whether this application is a public + + client (such as an installed application running on a mobile device). + + Default is false.' + isRequired: true + types: + - + - name: publisher_domain + description: 'Reliable domain which can be used to identify an + + application.' + isRequired: true + types: + - + - name: reply_urls + description: A collection of reply URLs for the application. + isRequired: true + types: + - [] + - name: required_resource_access + description: 'Specifies resources that this application + + requires access to and the set of OAuth permission scopes and application + + roles that it needs under each of those resources. This pre-configuration + + of required resource access drives the consent experience.' + isRequired: true + types: + - [] + - name: saml_metadata_url + description: 'The URL to the SAML metadata for the + + application.' + isRequired: true + types: + - + - name: sign_in_audience + description: 'Audience for signing in to the application + + (AzureADMyOrganization, AzureADAllOrganizations, + + AzureADAndMicrosoftAccounts).' + isRequired: true + types: + - + - name: www_homepage + description: The primary Web page. + isRequired: true + types: + - +variables: +- description: The object ID. + name: object_id + types: + - +- description: 'The time at which the directory object was + + deleted.' + name: deletion_timestamp + types: + - +methods: +- uid: azure.graphrbac.models.application.Application.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.application.Application.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.application.Application.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.application.Application.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.application.Application.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.application.Application.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.application.Application.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application.yml new file mode 100644 index 00000000..a2ebfff5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.application +name: application +fullName: azure.graphrbac.models.application +classes: +- azure.graphrbac.models.application.Application diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_base.ApplicationBase.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_base.ApplicationBase.yml new file mode 100644 index 00000000..4a382e9c --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_base.ApplicationBase.yml @@ -0,0 +1,325 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.application_base.ApplicationBase +name: ApplicationBase +fullName: azure.graphrbac.models.application_base.ApplicationBase +module: azure.graphrbac.models.application_base +summary: 'Active Directive Application common properties shared among GET, POST and + + PATCH.' +constructor: + syntax: ApplicationBase(**kwargs) + parameters: + - name: allow_guests_sign_in + description: 'A property on the application to indicate if + + the application accepts other IDPs or not or partially accepts.' + isRequired: true + types: + - + - name: allow_passthrough_users + description: 'Indicates that the application supports + + pass through users who have no presence in the resource tenant.' + isRequired: true + types: + - + - name: app_logo_url + description: 'The url for the application logo image stored in a + + CDN.' + isRequired: true + types: + - + - name: app_roles + description: 'The collection of application roles that an application + + may declare. These roles can be assigned to users, groups or service + + principals.' + isRequired: true + types: + - [] + - name: app_permissions + description: The application permissions. + isRequired: true + types: + - [] + - name: available_to_other_tenants + description: 'Whether the application is available to + + other tenants.' + isRequired: true + types: + - + - name: error_url + description: 'A URL provided by the author of the application to + + report errors when using the application.' + isRequired: true + types: + - + - name: group_membership_claims + description: 'Configures the groups claim issued in a + + user or OAuth 2.0 access token that the app expects.' + isRequired: true + types: + - + - name: homepage + description: The home page of the application. + isRequired: true + types: + - + - name: informational_urls + description: 'URLs with more information about the + + application.' + isRequired: true + types: + - + - name: is_device_only_auth_supported + description: 'Specifies whether this application + + supports device authentication without a user. The default is false.' + isRequired: true + types: + - + - name: key_credentials + description: A collection of KeyCredential objects. + isRequired: true + types: + - [] + - name: known_client_applications + description: 'Client applications that are tied to + + this resource application. Consent to any of the known client applications + + will result in implicit consent to the resource application through a + + combined consent dialog (showing the OAuth permission scopes required by + + the client and the resource).' + isRequired: true + types: + - [] + - name: logout_url + description: the url of the logout page + isRequired: true + types: + - + - name: oauth2_allow_implicit_flow + description: 'Whether to allow implicit grant flow + + for OAuth2' + isRequired: true + types: + - + - name: oauth2_allow_url_path_matching + description: 'Specifies whether during a token + + Request Azure AD will allow path matching of the redirect URI against the + + applications collection of replyURLs. The default is false.' + isRequired: true + types: + - + - name: oauth2_permissions + description: 'The collection of OAuth 2.0 permission scopes + + that the web API (resource) application exposes to client applications. + + These permission scopes may be granted to client applications during + + consent.' + isRequired: true + types: + - [] + - name: oauth2_require_post_response + description: 'Specifies whether, as part of OAuth + + 2.0 token requests, Azure AD will allow POST requests, as opposed to GET + + requests. The default is false, which specifies that only GET requests + + will be allowed.' + isRequired: true + types: + - + - name: org_restrictions + description: A list of tenants allowed to access application. + isRequired: true + types: + - [] + - name: optional_claims + isRequired: true + types: + - + - name: password_credentials + description: A collection of PasswordCredential objects + isRequired: true + types: + - [] + - name: pre_authorized_applications + description: list of pre-authorized applications. + isRequired: true + types: + - [] + - name: public_client + description: 'Specifies whether this application is a public + + client (such as an installed application running on a mobile device). + + Default is false.' + isRequired: true + types: + - + - name: publisher_domain + description: 'Reliable domain which can be used to identify an + + application.' + isRequired: true + types: + - + - name: reply_urls + description: A collection of reply URLs for the application. + isRequired: true + types: + - [] + - name: required_resource_access + description: 'Specifies resources that this application + + requires access to and the set of OAuth permission scopes and application + + roles that it needs under each of those resources. This pre-configuration + + of required resource access drives the consent experience.' + isRequired: true + types: + - [] + - name: saml_metadata_url + description: 'The URL to the SAML metadata for the + + application.' + isRequired: true + types: + - + - name: sign_in_audience + description: 'Audience for signing in to the application + + (AzureADMyOrganization, AzureADAllOrganizations, + + AzureADAndMicrosoftAccounts).' + isRequired: true + types: + - + - name: www_homepage + description: The primary Web page. + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.application_base.ApplicationBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.application_base.ApplicationBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.application_base.ApplicationBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.application_base.ApplicationBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.application_base.ApplicationBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.application_base.ApplicationBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.application_base.ApplicationBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_base.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_base.yml new file mode 100644 index 00000000..8cedd893 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_base.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.application_base +name: application_base +fullName: azure.graphrbac.models.application_base +classes: +- azure.graphrbac.models.application_base.ApplicationBase diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_base_py3.ApplicationBase.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_base_py3.ApplicationBase.yml new file mode 100644 index 00000000..9c5ac2d9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_base_py3.ApplicationBase.yml @@ -0,0 +1,394 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.application_base_py3.ApplicationBase +name: ApplicationBase +fullName: azure.graphrbac.models.application_base_py3.ApplicationBase +module: azure.graphrbac.models.application_base_py3 +summary: 'Active Directive Application common properties shared among GET, POST and + + PATCH.' +constructor: + syntax: 'ApplicationBase(*, allow_guests_sign_in: bool = None, allow_passthrough_users: + bool = None, app_logo_url: str = None, app_roles=None, app_permissions=None, available_to_other_tenants: + bool = None, error_url: str = None, group_membership_claims=None, homepage: str + = None, informational_urls=None, is_device_only_auth_supported: bool = None, key_credentials=None, + known_client_applications=None, logout_url: str = None, oauth2_allow_implicit_flow: + bool = None, oauth2_allow_url_path_matching: bool = None, oauth2_permissions=None, + oauth2_require_post_response: bool = None, org_restrictions=None, optional_claims=None, + password_credentials=None, pre_authorized_applications=None, public_client: bool + = None, publisher_domain: str = None, reply_urls=None, required_resource_access=None, + saml_metadata_url: str = None, sign_in_audience: str = None, www_homepage: str + = None, **kwargs)' + parameters: + - name: allow_guests_sign_in + description: 'A property on the application to indicate if + + the application accepts other IDPs or not or partially accepts.' + isRequired: true + types: + - + - name: allow_passthrough_users + description: 'Indicates that the application supports + + pass through users who have no presence in the resource tenant.' + isRequired: true + types: + - + - name: app_logo_url + description: 'The url for the application logo image stored in a + + CDN.' + isRequired: true + types: + - + - name: app_roles + description: 'The collection of application roles that an application + + may declare. These roles can be assigned to users, groups or service + + principals.' + isRequired: true + types: + - [] + - name: app_permissions + description: The application permissions. + isRequired: true + types: + - [] + - name: available_to_other_tenants + description: 'Whether the application is available to + + other tenants.' + isRequired: true + types: + - + - name: error_url + description: 'A URL provided by the author of the application to + + report errors when using the application.' + isRequired: true + types: + - + - name: group_membership_claims + description: 'Configures the groups claim issued in a + + user or OAuth 2.0 access token that the app expects.' + isRequired: true + types: + - + - name: homepage + description: The home page of the application. + isRequired: true + types: + - + - name: informational_urls + description: 'URLs with more information about the + + application.' + isRequired: true + types: + - + - name: is_device_only_auth_supported + description: 'Specifies whether this application + + supports device authentication without a user. The default is false.' + isRequired: true + types: + - + - name: key_credentials + description: A collection of KeyCredential objects. + isRequired: true + types: + - [] + - name: known_client_applications + description: 'Client applications that are tied to + + this resource application. Consent to any of the known client applications + + will result in implicit consent to the resource application through a + + combined consent dialog (showing the OAuth permission scopes required by + + the client and the resource).' + isRequired: true + types: + - [] + - name: logout_url + description: the url of the logout page + isRequired: true + types: + - + - name: oauth2_allow_implicit_flow + description: 'Whether to allow implicit grant flow + + for OAuth2' + isRequired: true + types: + - + - name: oauth2_allow_url_path_matching + description: 'Specifies whether during a token + + Request Azure AD will allow path matching of the redirect URI against the + + applications collection of replyURLs. The default is false.' + isRequired: true + types: + - + - name: oauth2_permissions + description: 'The collection of OAuth 2.0 permission scopes + + that the web API (resource) application exposes to client applications. + + These permission scopes may be granted to client applications during + + consent.' + isRequired: true + types: + - [] + - name: oauth2_require_post_response + description: 'Specifies whether, as part of OAuth + + 2.0 token requests, Azure AD will allow POST requests, as opposed to GET + + requests. The default is false, which specifies that only GET requests + + will be allowed.' + isRequired: true + types: + - + - name: org_restrictions + description: A list of tenants allowed to access application. + isRequired: true + types: + - [] + - name: optional_claims + isRequired: true + types: + - + - name: password_credentials + description: A collection of PasswordCredential objects + isRequired: true + types: + - [] + - name: pre_authorized_applications + description: list of pre-authorized applications. + isRequired: true + types: + - [] + - name: public_client + description: 'Specifies whether this application is a public + + client (such as an installed application running on a mobile device). + + Default is false.' + isRequired: true + types: + - + - name: publisher_domain + description: 'Reliable domain which can be used to identify an + + application.' + isRequired: true + types: + - + - name: reply_urls + description: A collection of reply URLs for the application. + isRequired: true + types: + - [] + - name: required_resource_access + description: 'Specifies resources that this application + + requires access to and the set of OAuth permission scopes and application + + roles that it needs under each of those resources. This pre-configuration + + of required resource access drives the consent experience.' + isRequired: true + types: + - [] + - name: saml_metadata_url + description: 'The URL to the SAML metadata for the + + application.' + isRequired: true + types: + - + - name: sign_in_audience + description: 'Audience for signing in to the application + + (AzureADMyOrganization, AzureADAllOrganizations, + + AzureADAndMicrosoftAccounts).' + isRequired: true + types: + - + - name: www_homepage + description: The primary Web page. + isRequired: true + types: + - + keywordOnlyParameters: + - name: allow_guests_sign_in + isRequired: true + - name: allow_passthrough_users + isRequired: true + - name: app_logo_url + isRequired: true + - name: app_roles + isRequired: true + - name: app_permissions + isRequired: true + - name: available_to_other_tenants + isRequired: true + - name: error_url + isRequired: true + - name: group_membership_claims + isRequired: true + - name: homepage + isRequired: true + - name: informational_urls + isRequired: true + - name: is_device_only_auth_supported + isRequired: true + - name: key_credentials + isRequired: true + - name: known_client_applications + isRequired: true + - name: logout_url + isRequired: true + - name: oauth2_allow_implicit_flow + isRequired: true + - name: oauth2_allow_url_path_matching + isRequired: true + - name: oauth2_permissions + isRequired: true + - name: oauth2_require_post_response + isRequired: true + - name: org_restrictions + isRequired: true + - name: optional_claims + isRequired: true + - name: password_credentials + isRequired: true + - name: pre_authorized_applications + isRequired: true + - name: public_client + isRequired: true + - name: publisher_domain + isRequired: true + - name: reply_urls + isRequired: true + - name: required_resource_access + isRequired: true + - name: saml_metadata_url + isRequired: true + - name: sign_in_audience + isRequired: true + - name: www_homepage + isRequired: true +methods: +- uid: azure.graphrbac.models.application_base_py3.ApplicationBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.application_base_py3.ApplicationBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.application_base_py3.ApplicationBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.application_base_py3.ApplicationBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.application_base_py3.ApplicationBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.application_base_py3.ApplicationBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.application_base_py3.ApplicationBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_base_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_base_py3.yml new file mode 100644 index 00000000..464204c4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_base_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.application_base_py3 +name: application_base_py3 +fullName: azure.graphrbac.models.application_base_py3 +classes: +- azure.graphrbac.models.application_base_py3.ApplicationBase diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_create_parameters.ApplicationCreateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_create_parameters.ApplicationCreateParameters.yml new file mode 100644 index 00000000..30df79b8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_create_parameters.ApplicationCreateParameters.yml @@ -0,0 +1,336 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.application_create_parameters.ApplicationCreateParameters +name: ApplicationCreateParameters +fullName: azure.graphrbac.models.application_create_parameters.ApplicationCreateParameters +module: azure.graphrbac.models.application_create_parameters +summary: 'Request parameters for creating a new application. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ApplicationCreateParameters(**kwargs) + parameters: + - name: allow_guests_sign_in + description: 'A property on the application to indicate if + + the application accepts other IDPs or not or partially accepts.' + isRequired: true + types: + - + - name: allow_passthrough_users + description: 'Indicates that the application supports + + pass through users who have no presence in the resource tenant.' + isRequired: true + types: + - + - name: app_logo_url + description: 'The url for the application logo image stored in a + + CDN.' + isRequired: true + types: + - + - name: app_roles + description: 'The collection of application roles that an application + + may declare. These roles can be assigned to users, groups or service + + principals.' + isRequired: true + types: + - [] + - name: app_permissions + description: The application permissions. + isRequired: true + types: + - [] + - name: available_to_other_tenants + description: 'Whether the application is available to + + other tenants.' + isRequired: true + types: + - + - name: error_url + description: 'A URL provided by the author of the application to + + report errors when using the application.' + isRequired: true + types: + - + - name: group_membership_claims + description: 'Configures the groups claim issued in a + + user or OAuth 2.0 access token that the app expects.' + isRequired: true + types: + - + - name: homepage + description: The home page of the application. + isRequired: true + types: + - + - name: informational_urls + description: 'URLs with more information about the + + application.' + isRequired: true + types: + - + - name: is_device_only_auth_supported + description: 'Specifies whether this application + + supports device authentication without a user. The default is false.' + isRequired: true + types: + - + - name: key_credentials + description: A collection of KeyCredential objects. + isRequired: true + types: + - [] + - name: known_client_applications + description: 'Client applications that are tied to + + this resource application. Consent to any of the known client applications + + will result in implicit consent to the resource application through a + + combined consent dialog (showing the OAuth permission scopes required by + + the client and the resource).' + isRequired: true + types: + - [] + - name: logout_url + description: the url of the logout page + isRequired: true + types: + - + - name: oauth2_allow_implicit_flow + description: 'Whether to allow implicit grant flow + + for OAuth2' + isRequired: true + types: + - + - name: oauth2_allow_url_path_matching + description: 'Specifies whether during a token + + Request Azure AD will allow path matching of the redirect URI against the + + applications collection of replyURLs. The default is false.' + isRequired: true + types: + - + - name: oauth2_permissions + description: 'The collection of OAuth 2.0 permission scopes + + that the web API (resource) application exposes to client applications. + + These permission scopes may be granted to client applications during + + consent.' + isRequired: true + types: + - [] + - name: oauth2_require_post_response + description: 'Specifies whether, as part of OAuth + + 2.0 token requests, Azure AD will allow POST requests, as opposed to GET + + requests. The default is false, which specifies that only GET requests + + will be allowed.' + isRequired: true + types: + - + - name: org_restrictions + description: A list of tenants allowed to access application. + isRequired: true + types: + - [] + - name: optional_claims + isRequired: true + types: + - + - name: password_credentials + description: A collection of PasswordCredential objects + isRequired: true + types: + - [] + - name: pre_authorized_applications + description: list of pre-authorized applications. + isRequired: true + types: + - [] + - name: public_client + description: 'Specifies whether this application is a public + + client (such as an installed application running on a mobile device). + + Default is false.' + isRequired: true + types: + - + - name: publisher_domain + description: 'Reliable domain which can be used to identify an + + application.' + isRequired: true + types: + - + - name: reply_urls + description: A collection of reply URLs for the application. + isRequired: true + types: + - [] + - name: required_resource_access + description: 'Specifies resources that this application + + requires access to and the set of OAuth permission scopes and application + + roles that it needs under each of those resources. This pre-configuration + + of required resource access drives the consent experience.' + isRequired: true + types: + - [] + - name: saml_metadata_url + description: 'The URL to the SAML metadata for the + + application.' + isRequired: true + types: + - + - name: sign_in_audience + description: 'Audience for signing in to the application + + (AzureADMyOrganization, AzureADAllOrganizations, + + AzureADAndMicrosoftAccounts).' + isRequired: true + types: + - + - name: www_homepage + description: The primary Web page. + isRequired: true + types: + - + - name: display_name + description: Required. The display name of the application. + isRequired: true + types: + - + - name: identifier_uris + description: A collection of URIs for the application. + isRequired: true + types: + - [] +methods: +- uid: azure.graphrbac.models.application_create_parameters.ApplicationCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.application_create_parameters.ApplicationCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.application_create_parameters.ApplicationCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.application_create_parameters.ApplicationCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.application_create_parameters.ApplicationCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.application_create_parameters.ApplicationCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.application_create_parameters.ApplicationCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_create_parameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_create_parameters.yml new file mode 100644 index 00000000..5cf87309 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_create_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.application_create_parameters +name: application_create_parameters +fullName: azure.graphrbac.models.application_create_parameters +classes: +- azure.graphrbac.models.application_create_parameters.ApplicationCreateParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_create_parameters_py3.ApplicationCreateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_create_parameters_py3.ApplicationCreateParameters.yml new file mode 100644 index 00000000..a5d0dd12 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_create_parameters_py3.ApplicationCreateParameters.yml @@ -0,0 +1,409 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.application_create_parameters_py3.ApplicationCreateParameters +name: ApplicationCreateParameters +fullName: azure.graphrbac.models.application_create_parameters_py3.ApplicationCreateParameters +module: azure.graphrbac.models.application_create_parameters_py3 +summary: 'Request parameters for creating a new application. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ApplicationCreateParameters(*, display_name: str, allow_guests_sign_in: + bool = None, allow_passthrough_users: bool = None, app_logo_url: str = None, app_roles=None, + app_permissions=None, available_to_other_tenants: bool = None, error_url: str + = None, group_membership_claims=None, homepage: str = None, informational_urls=None, + is_device_only_auth_supported: bool = None, key_credentials=None, known_client_applications=None, + logout_url: str = None, oauth2_allow_implicit_flow: bool = None, oauth2_allow_url_path_matching: + bool = None, oauth2_permissions=None, oauth2_require_post_response: bool = None, + org_restrictions=None, optional_claims=None, password_credentials=None, pre_authorized_applications=None, + public_client: bool = None, publisher_domain: str = None, reply_urls=None, required_resource_access=None, + saml_metadata_url: str = None, sign_in_audience: str = None, www_homepage: str + = None, identifier_uris=None, **kwargs)' + parameters: + - name: allow_guests_sign_in + description: 'A property on the application to indicate if + + the application accepts other IDPs or not or partially accepts.' + isRequired: true + types: + - + - name: allow_passthrough_users + description: 'Indicates that the application supports + + pass through users who have no presence in the resource tenant.' + isRequired: true + types: + - + - name: app_logo_url + description: 'The url for the application logo image stored in a + + CDN.' + isRequired: true + types: + - + - name: app_roles + description: 'The collection of application roles that an application + + may declare. These roles can be assigned to users, groups or service + + principals.' + isRequired: true + types: + - [] + - name: app_permissions + description: The application permissions. + isRequired: true + types: + - [] + - name: available_to_other_tenants + description: 'Whether the application is available to + + other tenants.' + isRequired: true + types: + - + - name: error_url + description: 'A URL provided by the author of the application to + + report errors when using the application.' + isRequired: true + types: + - + - name: group_membership_claims + description: 'Configures the groups claim issued in a + + user or OAuth 2.0 access token that the app expects.' + isRequired: true + types: + - + - name: homepage + description: The home page of the application. + isRequired: true + types: + - + - name: informational_urls + description: 'URLs with more information about the + + application.' + isRequired: true + types: + - + - name: is_device_only_auth_supported + description: 'Specifies whether this application + + supports device authentication without a user. The default is false.' + isRequired: true + types: + - + - name: key_credentials + description: A collection of KeyCredential objects. + isRequired: true + types: + - [] + - name: known_client_applications + description: 'Client applications that are tied to + + this resource application. Consent to any of the known client applications + + will result in implicit consent to the resource application through a + + combined consent dialog (showing the OAuth permission scopes required by + + the client and the resource).' + isRequired: true + types: + - [] + - name: logout_url + description: the url of the logout page + isRequired: true + types: + - + - name: oauth2_allow_implicit_flow + description: 'Whether to allow implicit grant flow + + for OAuth2' + isRequired: true + types: + - + - name: oauth2_allow_url_path_matching + description: 'Specifies whether during a token + + Request Azure AD will allow path matching of the redirect URI against the + + applications collection of replyURLs. The default is false.' + isRequired: true + types: + - + - name: oauth2_permissions + description: 'The collection of OAuth 2.0 permission scopes + + that the web API (resource) application exposes to client applications. + + These permission scopes may be granted to client applications during + + consent.' + isRequired: true + types: + - [] + - name: oauth2_require_post_response + description: 'Specifies whether, as part of OAuth + + 2.0 token requests, Azure AD will allow POST requests, as opposed to GET + + requests. The default is false, which specifies that only GET requests + + will be allowed.' + isRequired: true + types: + - + - name: org_restrictions + description: A list of tenants allowed to access application. + isRequired: true + types: + - [] + - name: optional_claims + isRequired: true + types: + - + - name: password_credentials + description: A collection of PasswordCredential objects + isRequired: true + types: + - [] + - name: pre_authorized_applications + description: list of pre-authorized applications. + isRequired: true + types: + - [] + - name: public_client + description: 'Specifies whether this application is a public + + client (such as an installed application running on a mobile device). + + Default is false.' + isRequired: true + types: + - + - name: publisher_domain + description: 'Reliable domain which can be used to identify an + + application.' + isRequired: true + types: + - + - name: reply_urls + description: A collection of reply URLs for the application. + isRequired: true + types: + - [] + - name: required_resource_access + description: 'Specifies resources that this application + + requires access to and the set of OAuth permission scopes and application + + roles that it needs under each of those resources. This pre-configuration + + of required resource access drives the consent experience.' + isRequired: true + types: + - [] + - name: saml_metadata_url + description: 'The URL to the SAML metadata for the + + application.' + isRequired: true + types: + - + - name: sign_in_audience + description: 'Audience for signing in to the application + + (AzureADMyOrganization, AzureADAllOrganizations, + + AzureADAndMicrosoftAccounts).' + isRequired: true + types: + - + - name: www_homepage + description: The primary Web page. + isRequired: true + types: + - + - name: display_name + description: Required. The display name of the application. + isRequired: true + types: + - + - name: identifier_uris + description: A collection of URIs for the application. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: display_name + isRequired: true + - name: allow_guests_sign_in + isRequired: true + - name: allow_passthrough_users + isRequired: true + - name: app_logo_url + isRequired: true + - name: app_roles + isRequired: true + - name: app_permissions + isRequired: true + - name: available_to_other_tenants + isRequired: true + - name: error_url + isRequired: true + - name: group_membership_claims + isRequired: true + - name: homepage + isRequired: true + - name: informational_urls + isRequired: true + - name: is_device_only_auth_supported + isRequired: true + - name: key_credentials + isRequired: true + - name: known_client_applications + isRequired: true + - name: logout_url + isRequired: true + - name: oauth2_allow_implicit_flow + isRequired: true + - name: oauth2_allow_url_path_matching + isRequired: true + - name: oauth2_permissions + isRequired: true + - name: oauth2_require_post_response + isRequired: true + - name: org_restrictions + isRequired: true + - name: optional_claims + isRequired: true + - name: password_credentials + isRequired: true + - name: pre_authorized_applications + isRequired: true + - name: public_client + isRequired: true + - name: publisher_domain + isRequired: true + - name: reply_urls + isRequired: true + - name: required_resource_access + isRequired: true + - name: saml_metadata_url + isRequired: true + - name: sign_in_audience + isRequired: true + - name: www_homepage + isRequired: true + - name: identifier_uris + isRequired: true +methods: +- uid: azure.graphrbac.models.application_create_parameters_py3.ApplicationCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.application_create_parameters_py3.ApplicationCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.application_create_parameters_py3.ApplicationCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.application_create_parameters_py3.ApplicationCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.application_create_parameters_py3.ApplicationCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.application_create_parameters_py3.ApplicationCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.application_create_parameters_py3.ApplicationCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_create_parameters_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_create_parameters_py3.yml new file mode 100644 index 00000000..eccac6d9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_create_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.application_create_parameters_py3 +name: application_create_parameters_py3 +fullName: azure.graphrbac.models.application_create_parameters_py3 +classes: +- azure.graphrbac.models.application_create_parameters_py3.ApplicationCreateParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_paged.ApplicationPaged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_paged.ApplicationPaged.yml new file mode 100644 index 00000000..6804136b --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_paged.ApplicationPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.application_paged.ApplicationPaged +name: ApplicationPaged +fullName: azure.graphrbac.models.application_paged.ApplicationPaged +module: azure.graphrbac.models.application_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: ApplicationPaged(*args, **kwargs) +methods: +- uid: azure.graphrbac.models.application_paged.ApplicationPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.graphrbac.models.application_paged.ApplicationPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.graphrbac.models.application_paged.ApplicationPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.application_paged.ApplicationPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.application_paged.ApplicationPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.graphrbac.models.application_paged.ApplicationPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.graphrbac.models.application_paged.ApplicationPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_paged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_paged.yml new file mode 100644 index 00000000..955ba12f --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.application_paged +name: application_paged +fullName: azure.graphrbac.models.application_paged +classes: +- azure.graphrbac.models.application_paged.ApplicationPaged diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_py3.Application.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_py3.Application.yml new file mode 100644 index 00000000..290da281 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_py3.Application.yml @@ -0,0 +1,447 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.application_py3.Application +name: Application +fullName: azure.graphrbac.models.application_py3.Application +module: azure.graphrbac.models.application_py3 +summary: 'Active Directory application information. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Application(*, additional_properties=None, app_id: str = None, allow_guests_sign_in: + bool = None, allow_passthrough_users: bool = None, app_logo_url: str = None, app_roles=None, + app_permissions=None, available_to_other_tenants: bool = None, display_name: str + = None, error_url: str = None, group_membership_claims=None, homepage: str = None, + identifier_uris=None, informational_urls=None, is_device_only_auth_supported: + bool = None, key_credentials=None, known_client_applications=None, logout_url: + str = None, oauth2_allow_implicit_flow: bool = None, oauth2_allow_url_path_matching: + bool = None, oauth2_permissions=None, oauth2_require_post_response: bool = None, + org_restrictions=None, optional_claims=None, password_credentials=None, pre_authorized_applications=None, + public_client: bool = None, publisher_domain: str = None, reply_urls=None, required_resource_access=None, + saml_metadata_url: str = None, sign_in_audience: str = None, www_homepage: str + = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: object_type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: allow_guests_sign_in + description: 'A property on the application to indicate if + + the application accepts other IDPs or not or partially accepts.' + isRequired: true + types: + - + - name: allow_passthrough_users + description: 'Indicates that the application supports + + pass through users who have no presence in the resource tenant.' + isRequired: true + types: + - + - name: app_logo_url + description: 'The url for the application logo image stored in a + + CDN.' + isRequired: true + types: + - + - name: app_roles + description: 'The collection of application roles that an application + + may declare. These roles can be assigned to users, groups or service + + principals.' + isRequired: true + types: + - [] + - name: app_permissions + description: The application permissions. + isRequired: true + types: + - [] + - name: available_to_other_tenants + description: 'Whether the application is available to + + other tenants.' + isRequired: true + types: + - + - name: display_name + description: The display name of the application. + isRequired: true + types: + - + - name: error_url + description: 'A URL provided by the author of the application to + + report errors when using the application.' + isRequired: true + types: + - + - name: group_membership_claims + description: 'Configures the groups claim issued in a + + user or OAuth 2.0 access token that the app expects.' + isRequired: true + types: + - + - name: homepage + description: The home page of the application. + isRequired: true + types: + - + - name: identifier_uris + description: A collection of URIs for the application. + isRequired: true + types: + - [] + - name: informational_urls + description: 'URLs with more information about the + + application.' + isRequired: true + types: + - + - name: is_device_only_auth_supported + description: 'Specifies whether this application + + supports device authentication without a user. The default is false.' + isRequired: true + types: + - + - name: key_credentials + description: A collection of KeyCredential objects. + isRequired: true + types: + - [] + - name: known_client_applications + description: 'Client applications that are tied to + + this resource application. Consent to any of the known client applications + + will result in implicit consent to the resource application through a + + combined consent dialog (showing the OAuth permission scopes required by + + the client and the resource).' + isRequired: true + types: + - [] + - name: logout_url + description: the url of the logout page + isRequired: true + types: + - + - name: oauth2_allow_implicit_flow + description: 'Whether to allow implicit grant flow + + for OAuth2' + isRequired: true + types: + - + - name: oauth2_allow_url_path_matching + description: 'Specifies whether during a token + + Request Azure AD will allow path matching of the redirect URI against the + + applications collection of replyURLs. The default is false.' + isRequired: true + types: + - + - name: oauth2_permissions + description: 'The collection of OAuth 2.0 permission scopes + + that the web API (resource) application exposes to client applications. + + These permission scopes may be granted to client applications during + + consent.' + isRequired: true + types: + - [] + - name: oauth2_require_post_response + description: 'Specifies whether, as part of OAuth + + 2.0 token requests, Azure AD will allow POST requests, as opposed to GET + + requests. The default is false, which specifies that only GET requests + + will be allowed.' + isRequired: true + types: + - + - name: org_restrictions + description: A list of tenants allowed to access application. + isRequired: true + types: + - [] + - name: optional_claims + isRequired: true + types: + - + - name: password_credentials + description: A collection of PasswordCredential objects + isRequired: true + types: + - [] + - name: pre_authorized_applications + description: list of pre-authorized applications. + isRequired: true + types: + - [] + - name: public_client + description: 'Specifies whether this application is a public + + client (such as an installed application running on a mobile device). + + Default is false.' + isRequired: true + types: + - + - name: publisher_domain + description: 'Reliable domain which can be used to identify an + + application.' + isRequired: true + types: + - + - name: reply_urls + description: A collection of reply URLs for the application. + isRequired: true + types: + - [] + - name: required_resource_access + description: 'Specifies resources that this application + + requires access to and the set of OAuth permission scopes and application + + roles that it needs under each of those resources. This pre-configuration + + of required resource access drives the consent experience.' + isRequired: true + types: + - [] + - name: saml_metadata_url + description: 'The URL to the SAML metadata for the + + application.' + isRequired: true + types: + - + - name: sign_in_audience + description: 'Audience for signing in to the application + + (AzureADMyOrganization, AzureADAllOrganizations, + + AzureADAndMicrosoftAccounts).' + isRequired: true + types: + - + - name: www_homepage + description: The primary Web page. + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: app_id + isRequired: true + - name: allow_guests_sign_in + isRequired: true + - name: allow_passthrough_users + isRequired: true + - name: app_logo_url + isRequired: true + - name: app_roles + isRequired: true + - name: app_permissions + isRequired: true + - name: available_to_other_tenants + isRequired: true + - name: display_name + isRequired: true + - name: error_url + isRequired: true + - name: group_membership_claims + isRequired: true + - name: homepage + isRequired: true + - name: identifier_uris + isRequired: true + - name: informational_urls + isRequired: true + - name: is_device_only_auth_supported + isRequired: true + - name: key_credentials + isRequired: true + - name: known_client_applications + isRequired: true + - name: logout_url + isRequired: true + - name: oauth2_allow_implicit_flow + isRequired: true + - name: oauth2_allow_url_path_matching + isRequired: true + - name: oauth2_permissions + isRequired: true + - name: oauth2_require_post_response + isRequired: true + - name: org_restrictions + isRequired: true + - name: optional_claims + isRequired: true + - name: password_credentials + isRequired: true + - name: pre_authorized_applications + isRequired: true + - name: public_client + isRequired: true + - name: publisher_domain + isRequired: true + - name: reply_urls + isRequired: true + - name: required_resource_access + isRequired: true + - name: saml_metadata_url + isRequired: true + - name: sign_in_audience + isRequired: true + - name: www_homepage + isRequired: true +variables: +- description: The object ID. + name: object_id + types: + - +- description: 'The time at which the directory object was + + deleted.' + name: deletion_timestamp + types: + - +methods: +- uid: azure.graphrbac.models.application_py3.Application.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.application_py3.Application.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.application_py3.Application.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.application_py3.Application.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.application_py3.Application.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.application_py3.Application.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.application_py3.Application.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_py3.yml new file mode 100644 index 00000000..f6247798 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.application_py3 +name: application_py3 +fullName: azure.graphrbac.models.application_py3 +classes: +- azure.graphrbac.models.application_py3.Application diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_update_parameters.ApplicationUpdateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_update_parameters.ApplicationUpdateParameters.yml new file mode 100644 index 00000000..8648a5f0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_update_parameters.ApplicationUpdateParameters.yml @@ -0,0 +1,333 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.application_update_parameters.ApplicationUpdateParameters +name: ApplicationUpdateParameters +fullName: azure.graphrbac.models.application_update_parameters.ApplicationUpdateParameters +module: azure.graphrbac.models.application_update_parameters +summary: Request parameters for updating a new application. +constructor: + syntax: ApplicationUpdateParameters(**kwargs) + parameters: + - name: allow_guests_sign_in + description: 'A property on the application to indicate if + + the application accepts other IDPs or not or partially accepts.' + isRequired: true + types: + - + - name: allow_passthrough_users + description: 'Indicates that the application supports + + pass through users who have no presence in the resource tenant.' + isRequired: true + types: + - + - name: app_logo_url + description: 'The url for the application logo image stored in a + + CDN.' + isRequired: true + types: + - + - name: app_roles + description: 'The collection of application roles that an application + + may declare. These roles can be assigned to users, groups or service + + principals.' + isRequired: true + types: + - [] + - name: app_permissions + description: The application permissions. + isRequired: true + types: + - [] + - name: available_to_other_tenants + description: 'Whether the application is available to + + other tenants.' + isRequired: true + types: + - + - name: error_url + description: 'A URL provided by the author of the application to + + report errors when using the application.' + isRequired: true + types: + - + - name: group_membership_claims + description: 'Configures the groups claim issued in a + + user or OAuth 2.0 access token that the app expects.' + isRequired: true + types: + - + - name: homepage + description: The home page of the application. + isRequired: true + types: + - + - name: informational_urls + description: 'URLs with more information about the + + application.' + isRequired: true + types: + - + - name: is_device_only_auth_supported + description: 'Specifies whether this application + + supports device authentication without a user. The default is false.' + isRequired: true + types: + - + - name: key_credentials + description: A collection of KeyCredential objects. + isRequired: true + types: + - [] + - name: known_client_applications + description: 'Client applications that are tied to + + this resource application. Consent to any of the known client applications + + will result in implicit consent to the resource application through a + + combined consent dialog (showing the OAuth permission scopes required by + + the client and the resource).' + isRequired: true + types: + - [] + - name: logout_url + description: the url of the logout page + isRequired: true + types: + - + - name: oauth2_allow_implicit_flow + description: 'Whether to allow implicit grant flow + + for OAuth2' + isRequired: true + types: + - + - name: oauth2_allow_url_path_matching + description: 'Specifies whether during a token + + Request Azure AD will allow path matching of the redirect URI against the + + applications collection of replyURLs. The default is false.' + isRequired: true + types: + - + - name: oauth2_permissions + description: 'The collection of OAuth 2.0 permission scopes + + that the web API (resource) application exposes to client applications. + + These permission scopes may be granted to client applications during + + consent.' + isRequired: true + types: + - [] + - name: oauth2_require_post_response + description: 'Specifies whether, as part of OAuth + + 2.0 token requests, Azure AD will allow POST requests, as opposed to GET + + requests. The default is false, which specifies that only GET requests + + will be allowed.' + isRequired: true + types: + - + - name: org_restrictions + description: A list of tenants allowed to access application. + isRequired: true + types: + - [] + - name: optional_claims + isRequired: true + types: + - + - name: password_credentials + description: A collection of PasswordCredential objects + isRequired: true + types: + - [] + - name: pre_authorized_applications + description: list of pre-authorized applications. + isRequired: true + types: + - [] + - name: public_client + description: 'Specifies whether this application is a public + + client (such as an installed application running on a mobile device). + + Default is false.' + isRequired: true + types: + - + - name: publisher_domain + description: 'Reliable domain which can be used to identify an + + application.' + isRequired: true + types: + - + - name: reply_urls + description: A collection of reply URLs for the application. + isRequired: true + types: + - [] + - name: required_resource_access + description: 'Specifies resources that this application + + requires access to and the set of OAuth permission scopes and application + + roles that it needs under each of those resources. This pre-configuration + + of required resource access drives the consent experience.' + isRequired: true + types: + - [] + - name: saml_metadata_url + description: 'The URL to the SAML metadata for the + + application.' + isRequired: true + types: + - + - name: sign_in_audience + description: 'Audience for signing in to the application + + (AzureADMyOrganization, AzureADAllOrganizations, + + AzureADAndMicrosoftAccounts).' + isRequired: true + types: + - + - name: www_homepage + description: The primary Web page. + isRequired: true + types: + - + - name: display_name + description: The display name of the application. + isRequired: true + types: + - + - name: identifier_uris + description: A collection of URIs for the application. + isRequired: true + types: + - [] +methods: +- uid: azure.graphrbac.models.application_update_parameters.ApplicationUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.application_update_parameters.ApplicationUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.application_update_parameters.ApplicationUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.application_update_parameters.ApplicationUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.application_update_parameters.ApplicationUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.application_update_parameters.ApplicationUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.application_update_parameters.ApplicationUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_update_parameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_update_parameters.yml new file mode 100644 index 00000000..5fdcf08a --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_update_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.application_update_parameters +name: application_update_parameters +fullName: azure.graphrbac.models.application_update_parameters +classes: +- azure.graphrbac.models.application_update_parameters.ApplicationUpdateParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_update_parameters_py3.ApplicationUpdateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_update_parameters_py3.ApplicationUpdateParameters.yml new file mode 100644 index 00000000..edea5f7f --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_update_parameters_py3.ApplicationUpdateParameters.yml @@ -0,0 +1,406 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.application_update_parameters_py3.ApplicationUpdateParameters +name: ApplicationUpdateParameters +fullName: azure.graphrbac.models.application_update_parameters_py3.ApplicationUpdateParameters +module: azure.graphrbac.models.application_update_parameters_py3 +summary: Request parameters for updating a new application. +constructor: + syntax: 'ApplicationUpdateParameters(*, allow_guests_sign_in: bool = None, allow_passthrough_users: + bool = None, app_logo_url: str = None, app_roles=None, app_permissions=None, available_to_other_tenants: + bool = None, error_url: str = None, group_membership_claims=None, homepage: str + = None, informational_urls=None, is_device_only_auth_supported: bool = None, key_credentials=None, + known_client_applications=None, logout_url: str = None, oauth2_allow_implicit_flow: + bool = None, oauth2_allow_url_path_matching: bool = None, oauth2_permissions=None, + oauth2_require_post_response: bool = None, org_restrictions=None, optional_claims=None, + password_credentials=None, pre_authorized_applications=None, public_client: bool + = None, publisher_domain: str = None, reply_urls=None, required_resource_access=None, + saml_metadata_url: str = None, sign_in_audience: str = None, www_homepage: str + = None, display_name: str = None, identifier_uris=None, **kwargs)' + parameters: + - name: allow_guests_sign_in + description: 'A property on the application to indicate if + + the application accepts other IDPs or not or partially accepts.' + isRequired: true + types: + - + - name: allow_passthrough_users + description: 'Indicates that the application supports + + pass through users who have no presence in the resource tenant.' + isRequired: true + types: + - + - name: app_logo_url + description: 'The url for the application logo image stored in a + + CDN.' + isRequired: true + types: + - + - name: app_roles + description: 'The collection of application roles that an application + + may declare. These roles can be assigned to users, groups or service + + principals.' + isRequired: true + types: + - [] + - name: app_permissions + description: The application permissions. + isRequired: true + types: + - [] + - name: available_to_other_tenants + description: 'Whether the application is available to + + other tenants.' + isRequired: true + types: + - + - name: error_url + description: 'A URL provided by the author of the application to + + report errors when using the application.' + isRequired: true + types: + - + - name: group_membership_claims + description: 'Configures the groups claim issued in a + + user or OAuth 2.0 access token that the app expects.' + isRequired: true + types: + - + - name: homepage + description: The home page of the application. + isRequired: true + types: + - + - name: informational_urls + description: 'URLs with more information about the + + application.' + isRequired: true + types: + - + - name: is_device_only_auth_supported + description: 'Specifies whether this application + + supports device authentication without a user. The default is false.' + isRequired: true + types: + - + - name: key_credentials + description: A collection of KeyCredential objects. + isRequired: true + types: + - [] + - name: known_client_applications + description: 'Client applications that are tied to + + this resource application. Consent to any of the known client applications + + will result in implicit consent to the resource application through a + + combined consent dialog (showing the OAuth permission scopes required by + + the client and the resource).' + isRequired: true + types: + - [] + - name: logout_url + description: the url of the logout page + isRequired: true + types: + - + - name: oauth2_allow_implicit_flow + description: 'Whether to allow implicit grant flow + + for OAuth2' + isRequired: true + types: + - + - name: oauth2_allow_url_path_matching + description: 'Specifies whether during a token + + Request Azure AD will allow path matching of the redirect URI against the + + applications collection of replyURLs. The default is false.' + isRequired: true + types: + - + - name: oauth2_permissions + description: 'The collection of OAuth 2.0 permission scopes + + that the web API (resource) application exposes to client applications. + + These permission scopes may be granted to client applications during + + consent.' + isRequired: true + types: + - [] + - name: oauth2_require_post_response + description: 'Specifies whether, as part of OAuth + + 2.0 token requests, Azure AD will allow POST requests, as opposed to GET + + requests. The default is false, which specifies that only GET requests + + will be allowed.' + isRequired: true + types: + - + - name: org_restrictions + description: A list of tenants allowed to access application. + isRequired: true + types: + - [] + - name: optional_claims + isRequired: true + types: + - + - name: password_credentials + description: A collection of PasswordCredential objects + isRequired: true + types: + - [] + - name: pre_authorized_applications + description: list of pre-authorized applications. + isRequired: true + types: + - [] + - name: public_client + description: 'Specifies whether this application is a public + + client (such as an installed application running on a mobile device). + + Default is false.' + isRequired: true + types: + - + - name: publisher_domain + description: 'Reliable domain which can be used to identify an + + application.' + isRequired: true + types: + - + - name: reply_urls + description: A collection of reply URLs for the application. + isRequired: true + types: + - [] + - name: required_resource_access + description: 'Specifies resources that this application + + requires access to and the set of OAuth permission scopes and application + + roles that it needs under each of those resources. This pre-configuration + + of required resource access drives the consent experience.' + isRequired: true + types: + - [] + - name: saml_metadata_url + description: 'The URL to the SAML metadata for the + + application.' + isRequired: true + types: + - + - name: sign_in_audience + description: 'Audience for signing in to the application + + (AzureADMyOrganization, AzureADAllOrganizations, + + AzureADAndMicrosoftAccounts).' + isRequired: true + types: + - + - name: www_homepage + description: The primary Web page. + isRequired: true + types: + - + - name: display_name + description: The display name of the application. + isRequired: true + types: + - + - name: identifier_uris + description: A collection of URIs for the application. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: allow_guests_sign_in + isRequired: true + - name: allow_passthrough_users + isRequired: true + - name: app_logo_url + isRequired: true + - name: app_roles + isRequired: true + - name: app_permissions + isRequired: true + - name: available_to_other_tenants + isRequired: true + - name: error_url + isRequired: true + - name: group_membership_claims + isRequired: true + - name: homepage + isRequired: true + - name: informational_urls + isRequired: true + - name: is_device_only_auth_supported + isRequired: true + - name: key_credentials + isRequired: true + - name: known_client_applications + isRequired: true + - name: logout_url + isRequired: true + - name: oauth2_allow_implicit_flow + isRequired: true + - name: oauth2_allow_url_path_matching + isRequired: true + - name: oauth2_permissions + isRequired: true + - name: oauth2_require_post_response + isRequired: true + - name: org_restrictions + isRequired: true + - name: optional_claims + isRequired: true + - name: password_credentials + isRequired: true + - name: pre_authorized_applications + isRequired: true + - name: public_client + isRequired: true + - name: publisher_domain + isRequired: true + - name: reply_urls + isRequired: true + - name: required_resource_access + isRequired: true + - name: saml_metadata_url + isRequired: true + - name: sign_in_audience + isRequired: true + - name: www_homepage + isRequired: true + - name: display_name + isRequired: true + - name: identifier_uris + isRequired: true +methods: +- uid: azure.graphrbac.models.application_update_parameters_py3.ApplicationUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.application_update_parameters_py3.ApplicationUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.application_update_parameters_py3.ApplicationUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.application_update_parameters_py3.ApplicationUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.application_update_parameters_py3.ApplicationUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.application_update_parameters_py3.ApplicationUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.application_update_parameters_py3.ApplicationUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_update_parameters_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_update_parameters_py3.yml new file mode 100644 index 00000000..882ca994 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_update_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.application_update_parameters_py3 +name: application_update_parameters_py3 +fullName: azure.graphrbac.models.application_update_parameters_py3 +classes: +- azure.graphrbac.models.application_update_parameters_py3.ApplicationUpdateParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_parameters.CheckGroupMembershipParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_parameters.CheckGroupMembershipParameters.yml new file mode 100644 index 00000000..59380601 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_parameters.CheckGroupMembershipParameters.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.check_group_membership_parameters.CheckGroupMembershipParameters +name: CheckGroupMembershipParameters +fullName: azure.graphrbac.models.check_group_membership_parameters.CheckGroupMembershipParameters +module: azure.graphrbac.models.check_group_membership_parameters +summary: 'Request parameters for IsMemberOf API call. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CheckGroupMembershipParameters(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: group_id + description: Required. The object ID of the group to check. + isRequired: true + types: + - + - name: member_id + description: 'Required. The object ID of the contact, group, user, or + + service principal to check for membership in the specified group.' + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.check_group_membership_parameters.CheckGroupMembershipParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.check_group_membership_parameters.CheckGroupMembershipParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.check_group_membership_parameters.CheckGroupMembershipParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.check_group_membership_parameters.CheckGroupMembershipParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.check_group_membership_parameters.CheckGroupMembershipParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.check_group_membership_parameters.CheckGroupMembershipParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.check_group_membership_parameters.CheckGroupMembershipParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_parameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_parameters.yml new file mode 100644 index 00000000..c65f10ca --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.check_group_membership_parameters +name: check_group_membership_parameters +fullName: azure.graphrbac.models.check_group_membership_parameters +classes: +- azure.graphrbac.models.check_group_membership_parameters.CheckGroupMembershipParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_parameters_py3.CheckGroupMembershipParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_parameters_py3.CheckGroupMembershipParameters.yml new file mode 100644 index 00000000..b97b53d4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_parameters_py3.CheckGroupMembershipParameters.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.check_group_membership_parameters_py3.CheckGroupMembershipParameters +name: CheckGroupMembershipParameters +fullName: azure.graphrbac.models.check_group_membership_parameters_py3.CheckGroupMembershipParameters +module: azure.graphrbac.models.check_group_membership_parameters_py3 +summary: 'Request parameters for IsMemberOf API call. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CheckGroupMembershipParameters(*, group_id: str, member_id: str, additional_properties=None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: group_id + description: Required. The object ID of the group to check. + isRequired: true + types: + - + - name: member_id + description: 'Required. The object ID of the contact, group, user, or + + service principal to check for membership in the specified group.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: group_id + isRequired: true + - name: member_id + isRequired: true + - name: additional_properties + isRequired: true +methods: +- uid: azure.graphrbac.models.check_group_membership_parameters_py3.CheckGroupMembershipParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.check_group_membership_parameters_py3.CheckGroupMembershipParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.check_group_membership_parameters_py3.CheckGroupMembershipParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.check_group_membership_parameters_py3.CheckGroupMembershipParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.check_group_membership_parameters_py3.CheckGroupMembershipParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.check_group_membership_parameters_py3.CheckGroupMembershipParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.check_group_membership_parameters_py3.CheckGroupMembershipParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_parameters_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_parameters_py3.yml new file mode 100644 index 00000000..f4ebe725 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.check_group_membership_parameters_py3 +name: check_group_membership_parameters_py3 +fullName: azure.graphrbac.models.check_group_membership_parameters_py3 +classes: +- azure.graphrbac.models.check_group_membership_parameters_py3.CheckGroupMembershipParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_result.CheckGroupMembershipResult.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_result.CheckGroupMembershipResult.yml new file mode 100644 index 00000000..30d6a71a --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_result.CheckGroupMembershipResult.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.check_group_membership_result.CheckGroupMembershipResult +name: CheckGroupMembershipResult +fullName: azure.graphrbac.models.check_group_membership_result.CheckGroupMembershipResult +module: azure.graphrbac.models.check_group_membership_result +summary: Server response for IsMemberOf API call. +constructor: + syntax: CheckGroupMembershipResult(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: value + description: 'True if the specified user, group, contact, or service + + principal has either direct or transitive membership in the specified + + group; otherwise, false.' + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.check_group_membership_result.CheckGroupMembershipResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.check_group_membership_result.CheckGroupMembershipResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.check_group_membership_result.CheckGroupMembershipResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.check_group_membership_result.CheckGroupMembershipResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.check_group_membership_result.CheckGroupMembershipResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.check_group_membership_result.CheckGroupMembershipResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.check_group_membership_result.CheckGroupMembershipResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_result.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_result.yml new file mode 100644 index 00000000..13b0252f --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.check_group_membership_result +name: check_group_membership_result +fullName: azure.graphrbac.models.check_group_membership_result +classes: +- azure.graphrbac.models.check_group_membership_result.CheckGroupMembershipResult diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_result_py3.CheckGroupMembershipResult.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_result_py3.CheckGroupMembershipResult.yml new file mode 100644 index 00000000..d77a07bf --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_result_py3.CheckGroupMembershipResult.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.check_group_membership_result_py3.CheckGroupMembershipResult +name: CheckGroupMembershipResult +fullName: azure.graphrbac.models.check_group_membership_result_py3.CheckGroupMembershipResult +module: azure.graphrbac.models.check_group_membership_result_py3 +summary: Server response for IsMemberOf API call. +constructor: + syntax: 'CheckGroupMembershipResult(*, additional_properties=None, value: bool = + None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: value + description: 'True if the specified user, group, contact, or service + + principal has either direct or transitive membership in the specified + + group; otherwise, false.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.graphrbac.models.check_group_membership_result_py3.CheckGroupMembershipResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.check_group_membership_result_py3.CheckGroupMembershipResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.check_group_membership_result_py3.CheckGroupMembershipResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.check_group_membership_result_py3.CheckGroupMembershipResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.check_group_membership_result_py3.CheckGroupMembershipResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.check_group_membership_result_py3.CheckGroupMembershipResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.check_group_membership_result_py3.CheckGroupMembershipResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_result_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_result_py3.yml new file mode 100644 index 00000000..98806269 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.check_group_membership_result_py3 +name: check_group_membership_result_py3 +fullName: azure.graphrbac.models.check_group_membership_result_py3 +classes: +- azure.graphrbac.models.check_group_membership_result_py3.CheckGroupMembershipResult diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object.DirectoryObject.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object.DirectoryObject.yml new file mode 100644 index 00000000..2930c366 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object.DirectoryObject.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.directory_object.DirectoryObject +name: DirectoryObject +fullName: azure.graphrbac.models.directory_object.DirectoryObject +module: azure.graphrbac.models.directory_object +summary: 'Represents an Azure Active Directory object. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Application, ADGroup, ServicePrincipal, User + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: DirectoryObject(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: object_type + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: The object ID. + name: object_id + types: + - +- description: 'The time at which the directory object was + + deleted.' + name: deletion_timestamp + types: + - +methods: +- uid: azure.graphrbac.models.directory_object.DirectoryObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.directory_object.DirectoryObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.directory_object.DirectoryObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.directory_object.DirectoryObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.directory_object.DirectoryObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.directory_object.DirectoryObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.directory_object.DirectoryObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object.yml new file mode 100644 index 00000000..83d34ebb --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.directory_object +name: directory_object +fullName: azure.graphrbac.models.directory_object +classes: +- azure.graphrbac.models.directory_object.DirectoryObject diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object_paged.DirectoryObjectPaged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object_paged.DirectoryObjectPaged.yml new file mode 100644 index 00000000..9105bf58 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object_paged.DirectoryObjectPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.directory_object_paged.DirectoryObjectPaged +name: DirectoryObjectPaged +fullName: azure.graphrbac.models.directory_object_paged.DirectoryObjectPaged +module: azure.graphrbac.models.directory_object_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: DirectoryObjectPaged(*args, **kwargs) +methods: +- uid: azure.graphrbac.models.directory_object_paged.DirectoryObjectPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.graphrbac.models.directory_object_paged.DirectoryObjectPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.graphrbac.models.directory_object_paged.DirectoryObjectPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.directory_object_paged.DirectoryObjectPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.directory_object_paged.DirectoryObjectPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.graphrbac.models.directory_object_paged.DirectoryObjectPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.graphrbac.models.directory_object_paged.DirectoryObjectPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object_paged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object_paged.yml new file mode 100644 index 00000000..23097ce4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.directory_object_paged +name: directory_object_paged +fullName: azure.graphrbac.models.directory_object_paged +classes: +- azure.graphrbac.models.directory_object_paged.DirectoryObjectPaged diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object_py3.DirectoryObject.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object_py3.DirectoryObject.yml new file mode 100644 index 00000000..7687b292 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object_py3.DirectoryObject.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.directory_object_py3.DirectoryObject +name: DirectoryObject +fullName: azure.graphrbac.models.directory_object_py3.DirectoryObject +module: azure.graphrbac.models.directory_object_py3 +summary: 'Represents an Azure Active Directory object. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: Application, ADGroup, ServicePrincipal, User + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: DirectoryObject(*, additional_properties=None, **kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: object_type + description: Required. Constant filled by server. + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true +variables: +- description: The object ID. + name: object_id + types: + - +- description: 'The time at which the directory object was + + deleted.' + name: deletion_timestamp + types: + - +methods: +- uid: azure.graphrbac.models.directory_object_py3.DirectoryObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.directory_object_py3.DirectoryObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.directory_object_py3.DirectoryObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.directory_object_py3.DirectoryObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.directory_object_py3.DirectoryObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.directory_object_py3.DirectoryObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.directory_object_py3.DirectoryObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object_py3.yml new file mode 100644 index 00000000..eb97672c --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.directory_object_py3 +name: directory_object_py3 +fullName: azure.graphrbac.models.directory_object_py3 +classes: +- azure.graphrbac.models.directory_object_py3.DirectoryObject diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain.Domain.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain.Domain.yml new file mode 100644 index 00000000..891f0a72 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain.Domain.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.domain.Domain +name: Domain +fullName: azure.graphrbac.models.domain.Domain +module: azure.graphrbac.models.domain +summary: 'Active Directory Domain information. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Domain(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: name + description: Required. the domain name. + isRequired: true + types: + - +variables: +- description: the type of the authentication into the domain. + name: authentication_type + types: + - +- description: if this is the default domain in the tenant. + name: is_default + types: + - +- description: if this domain's ownership is verified. + name: is_verified + types: + - +methods: +- uid: azure.graphrbac.models.domain.Domain.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.domain.Domain.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.domain.Domain.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.domain.Domain.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.domain.Domain.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.domain.Domain.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.domain.Domain.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain.yml new file mode 100644 index 00000000..16ac4b1f --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.domain +name: domain +fullName: azure.graphrbac.models.domain +classes: +- azure.graphrbac.models.domain.Domain diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain_paged.DomainPaged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain_paged.DomainPaged.yml new file mode 100644 index 00000000..c6100dbe --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain_paged.DomainPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.domain_paged.DomainPaged +name: DomainPaged +fullName: azure.graphrbac.models.domain_paged.DomainPaged +module: azure.graphrbac.models.domain_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: DomainPaged(*args, **kwargs) +methods: +- uid: azure.graphrbac.models.domain_paged.DomainPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.graphrbac.models.domain_paged.DomainPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.graphrbac.models.domain_paged.DomainPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.domain_paged.DomainPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.domain_paged.DomainPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.graphrbac.models.domain_paged.DomainPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.graphrbac.models.domain_paged.DomainPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain_paged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain_paged.yml new file mode 100644 index 00000000..8b05c013 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.domain_paged +name: domain_paged +fullName: azure.graphrbac.models.domain_paged +classes: +- azure.graphrbac.models.domain_paged.DomainPaged diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain_py3.Domain.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain_py3.Domain.yml new file mode 100644 index 00000000..3f9dc123 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain_py3.Domain.yml @@ -0,0 +1,153 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.domain_py3.Domain +name: Domain +fullName: azure.graphrbac.models.domain_py3.Domain +module: azure.graphrbac.models.domain_py3 +summary: 'Active Directory Domain information. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Domain(*, name: str, additional_properties=None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: name + description: Required. the domain name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: additional_properties + isRequired: true +variables: +- description: the type of the authentication into the domain. + name: authentication_type + types: + - +- description: if this is the default domain in the tenant. + name: is_default + types: + - +- description: if this domain's ownership is verified. + name: is_verified + types: + - +methods: +- uid: azure.graphrbac.models.domain_py3.Domain.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.domain_py3.Domain.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.domain_py3.Domain.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.domain_py3.Domain.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.domain_py3.Domain.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.domain_py3.Domain.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.domain_py3.Domain.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain_py3.yml new file mode 100644 index 00000000..8ac68806 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.domain_py3 +name: domain_py3 +fullName: azure.graphrbac.models.domain_py3 +classes: +- azure.graphrbac.models.domain_py3.Domain diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.get_objects_parameters.GetObjectsParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.get_objects_parameters.GetObjectsParameters.yml new file mode 100644 index 00000000..ac1964d6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.get_objects_parameters.GetObjectsParameters.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.get_objects_parameters.GetObjectsParameters +name: GetObjectsParameters +fullName: azure.graphrbac.models.get_objects_parameters.GetObjectsParameters +module: azure.graphrbac.models.get_objects_parameters +summary: Request parameters for the GetObjectsByObjectIds API. +constructor: + syntax: GetObjectsParameters(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: object_ids + description: The requested object IDs. + isRequired: true + types: + - [] + - name: types + description: The requested object types. + isRequired: true + types: + - [] + - name: include_directory_object_references + description: 'If true, also searches for + + object IDs in the partner tenant.' + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.get_objects_parameters.GetObjectsParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.get_objects_parameters.GetObjectsParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.get_objects_parameters.GetObjectsParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.get_objects_parameters.GetObjectsParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.get_objects_parameters.GetObjectsParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.get_objects_parameters.GetObjectsParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.get_objects_parameters.GetObjectsParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.get_objects_parameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.get_objects_parameters.yml new file mode 100644 index 00000000..6d290b2b --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.get_objects_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.get_objects_parameters +name: get_objects_parameters +fullName: azure.graphrbac.models.get_objects_parameters +classes: +- azure.graphrbac.models.get_objects_parameters.GetObjectsParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.get_objects_parameters_py3.GetObjectsParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.get_objects_parameters_py3.GetObjectsParameters.yml new file mode 100644 index 00000000..394db18b --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.get_objects_parameters_py3.GetObjectsParameters.yml @@ -0,0 +1,149 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.get_objects_parameters_py3.GetObjectsParameters +name: GetObjectsParameters +fullName: azure.graphrbac.models.get_objects_parameters_py3.GetObjectsParameters +module: azure.graphrbac.models.get_objects_parameters_py3 +summary: Request parameters for the GetObjectsByObjectIds API. +constructor: + syntax: 'GetObjectsParameters(*, additional_properties=None, object_ids=None, types=None, + include_directory_object_references: bool = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: object_ids + description: The requested object IDs. + isRequired: true + types: + - [] + - name: types + description: The requested object types. + isRequired: true + types: + - [] + - name: include_directory_object_references + description: 'If true, also searches for + + object IDs in the partner tenant.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: object_ids + isRequired: true + - name: types + isRequired: true + - name: include_directory_object_references + isRequired: true +methods: +- uid: azure.graphrbac.models.get_objects_parameters_py3.GetObjectsParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.get_objects_parameters_py3.GetObjectsParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.get_objects_parameters_py3.GetObjectsParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.get_objects_parameters_py3.GetObjectsParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.get_objects_parameters_py3.GetObjectsParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.get_objects_parameters_py3.GetObjectsParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.get_objects_parameters_py3.GetObjectsParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.get_objects_parameters_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.get_objects_parameters_py3.yml new file mode 100644 index 00000000..e08320e4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.get_objects_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.get_objects_parameters_py3 +name: get_objects_parameters_py3 +fullName: azure.graphrbac.models.get_objects_parameters_py3 +classes: +- azure.graphrbac.models.get_objects_parameters_py3.GetObjectsParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error.GraphError.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error.GraphError.yml new file mode 100644 index 00000000..84f62730 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error.GraphError.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.graph_error.GraphError +name: GraphError +fullName: azure.graphrbac.models.graph_error.GraphError +module: azure.graphrbac.models.graph_error +summary: Active Directory error information. +constructor: + syntax: GraphError(**kwargs) + parameters: + - name: code + description: Error code. + isRequired: true + types: + - + - name: message + description: Error message value. + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.graph_error.GraphError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.graph_error.GraphError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.graph_error.GraphError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.graph_error.GraphError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.graph_error.GraphError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.graph_error.GraphError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.graph_error.GraphError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error.GraphErrorException.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error.GraphErrorException.yml new file mode 100644 index 00000000..5a91b365 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error.GraphErrorException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.graph_error.GraphErrorException +name: GraphErrorException +fullName: azure.graphrbac.models.graph_error.GraphErrorException +module: azure.graphrbac.models.graph_error +summary: 'Server responded with exception of type: ''GraphError''.' +constructor: + syntax: GraphErrorException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.graphrbac.models.graph_error.GraphErrorException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.graphrbac.models.graph_error.GraphErrorException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.graphrbac.models.graph_error.GraphErrorException.args + name: args diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error.yml new file mode 100644 index 00000000..e911340a --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.graph_error +name: graph_error +fullName: azure.graphrbac.models.graph_error +classes: +- azure.graphrbac.models.graph_error.GraphError +- azure.graphrbac.models.graph_error.GraphErrorException diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error_py3.GraphError.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error_py3.GraphError.yml new file mode 100644 index 00000000..0baf728c --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error_py3.GraphError.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.graph_error_py3.GraphError +name: GraphError +fullName: azure.graphrbac.models.graph_error_py3.GraphError +module: azure.graphrbac.models.graph_error_py3 +summary: Active Directory error information. +constructor: + syntax: 'GraphError(*, code: str = None, message: str = None, **kwargs)' + parameters: + - name: code + description: Error code. + isRequired: true + types: + - + - name: message + description: Error message value. + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true +methods: +- uid: azure.graphrbac.models.graph_error_py3.GraphError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.graph_error_py3.GraphError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.graph_error_py3.GraphError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.graph_error_py3.GraphError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.graph_error_py3.GraphError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.graph_error_py3.GraphError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.graph_error_py3.GraphError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error_py3.GraphErrorException.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error_py3.GraphErrorException.yml new file mode 100644 index 00000000..b065fc0d --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error_py3.GraphErrorException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.graph_error_py3.GraphErrorException +name: GraphErrorException +fullName: azure.graphrbac.models.graph_error_py3.GraphErrorException +module: azure.graphrbac.models.graph_error_py3 +summary: 'Server responded with exception of type: ''GraphError''.' +constructor: + syntax: GraphErrorException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.graphrbac.models.graph_error_py3.GraphErrorException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.graphrbac.models.graph_error_py3.GraphErrorException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.graphrbac.models.graph_error_py3.GraphErrorException.args + name: args diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error_py3.yml new file mode 100644 index 00000000..58d029c4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error_py3.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.graph_error_py3 +name: graph_error_py3 +fullName: azure.graphrbac.models.graph_error_py3 +classes: +- azure.graphrbac.models.graph_error_py3.GraphError +- azure.graphrbac.models.graph_error_py3.GraphErrorException diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_rbac_management_client_enums.ConsentType.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_rbac_management_client_enums.ConsentType.yml new file mode 100644 index 00000000..b2743fbc --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_rbac_management_client_enums.ConsentType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.graphrbac.models.graph_rbac_management_client_enums.ConsentType +name: ConsentType +fullName: azure.graphrbac.models.graph_rbac_management_client_enums.ConsentType +module: azure.graphrbac.models.graph_rbac_management_client_enums +fields: +- name: all_principals + uid: azure.graphrbac.models.graph_rbac_management_client_enums.ConsentType.all_principals +- name: principal + uid: azure.graphrbac.models.graph_rbac_management_client_enums.ConsentType.principal diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_rbac_management_client_enums.UserType.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_rbac_management_client_enums.UserType.yml new file mode 100644 index 00000000..d0d1e9fa --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_rbac_management_client_enums.UserType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.graphrbac.models.graph_rbac_management_client_enums.UserType +name: UserType +fullName: azure.graphrbac.models.graph_rbac_management_client_enums.UserType +module: azure.graphrbac.models.graph_rbac_management_client_enums +fields: +- name: guest + uid: azure.graphrbac.models.graph_rbac_management_client_enums.UserType.guest +- name: member + uid: azure.graphrbac.models.graph_rbac_management_client_enums.UserType.member diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_rbac_management_client_enums.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_rbac_management_client_enums.yml new file mode 100644 index 00000000..cdf63491 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_rbac_management_client_enums.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.graph_rbac_management_client_enums +name: graph_rbac_management_client_enums +fullName: azure.graphrbac.models.graph_rbac_management_client_enums +enums: +- azure.graphrbac.models.graph_rbac_management_client_enums.ConsentType +- azure.graphrbac.models.graph_rbac_management_client_enums.UserType diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_add_member_parameters.GroupAddMemberParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_add_member_parameters.GroupAddMemberParameters.yml new file mode 100644 index 00000000..3b6b6178 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_add_member_parameters.GroupAddMemberParameters.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.group_add_member_parameters.GroupAddMemberParameters +name: GroupAddMemberParameters +fullName: azure.graphrbac.models.group_add_member_parameters.GroupAddMemberParameters +module: azure.graphrbac.models.group_add_member_parameters +summary: 'Request parameters for adding a member to a group. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: GroupAddMemberParameters(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: url + description: 'Required. A member object URL, such as + + "[https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd](https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd)", + + where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and + + "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the member + + (user, application, servicePrincipal, group) to be added.' + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.group_add_member_parameters.GroupAddMemberParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.group_add_member_parameters.GroupAddMemberParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.group_add_member_parameters.GroupAddMemberParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.group_add_member_parameters.GroupAddMemberParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.group_add_member_parameters.GroupAddMemberParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.group_add_member_parameters.GroupAddMemberParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.group_add_member_parameters.GroupAddMemberParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_add_member_parameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_add_member_parameters.yml new file mode 100644 index 00000000..fc4e7589 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_add_member_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.group_add_member_parameters +name: group_add_member_parameters +fullName: azure.graphrbac.models.group_add_member_parameters +classes: +- azure.graphrbac.models.group_add_member_parameters.GroupAddMemberParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_add_member_parameters_py3.GroupAddMemberParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_add_member_parameters_py3.GroupAddMemberParameters.yml new file mode 100644 index 00000000..4217ea20 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_add_member_parameters_py3.GroupAddMemberParameters.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.group_add_member_parameters_py3.GroupAddMemberParameters +name: GroupAddMemberParameters +fullName: azure.graphrbac.models.group_add_member_parameters_py3.GroupAddMemberParameters +module: azure.graphrbac.models.group_add_member_parameters_py3 +summary: 'Request parameters for adding a member to a group. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'GroupAddMemberParameters(*, url: str, additional_properties=None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: url + description: 'Required. A member object URL, such as + + "[https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd](https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd)", + + where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and + + "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the member + + (user, application, servicePrincipal, group) to be added.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: url + isRequired: true + - name: additional_properties + isRequired: true +methods: +- uid: azure.graphrbac.models.group_add_member_parameters_py3.GroupAddMemberParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.group_add_member_parameters_py3.GroupAddMemberParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.group_add_member_parameters_py3.GroupAddMemberParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.group_add_member_parameters_py3.GroupAddMemberParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.group_add_member_parameters_py3.GroupAddMemberParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.group_add_member_parameters_py3.GroupAddMemberParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.group_add_member_parameters_py3.GroupAddMemberParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_add_member_parameters_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_add_member_parameters_py3.yml new file mode 100644 index 00000000..5ebf9b3a --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_add_member_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.group_add_member_parameters_py3 +name: group_add_member_parameters_py3 +fullName: azure.graphrbac.models.group_add_member_parameters_py3 +classes: +- azure.graphrbac.models.group_add_member_parameters_py3.GroupAddMemberParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_create_parameters.GroupCreateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_create_parameters.GroupCreateParameters.yml new file mode 100644 index 00000000..ef336c78 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_create_parameters.GroupCreateParameters.yml @@ -0,0 +1,164 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.group_create_parameters.GroupCreateParameters +name: GroupCreateParameters +fullName: azure.graphrbac.models.group_create_parameters.GroupCreateParameters +module: azure.graphrbac.models.group_create_parameters +summary: 'Request parameters for creating a new group. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: GroupCreateParameters(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: display_name + description: Required. Group display name + isRequired: true + types: + - + - name: mail_nickname + description: Required. Mail nickname + isRequired: true + types: + - +variables: +- description: 'Required. Whether the group is mail-enabled. Must be + + false. This is because only pure security groups can be created using the + + Graph API. Default value: False .' + name: mail_enabled + types: + - +- description: 'Required. Whether the group is a security group. + + Must be true. This is because only pure security groups can be created + + using the Graph API. Default value: True .' + name: security_enabled + types: + - +methods: +- uid: azure.graphrbac.models.group_create_parameters.GroupCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.group_create_parameters.GroupCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.group_create_parameters.GroupCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.group_create_parameters.GroupCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.group_create_parameters.GroupCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.group_create_parameters.GroupCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.group_create_parameters.GroupCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +attributes: +- uid: azure.graphrbac.models.group_create_parameters.GroupCreateParameters.mail_enabled + name: mail_enabled + signature: mail_enabled = False +- uid: azure.graphrbac.models.group_create_parameters.GroupCreateParameters.security_enabled + name: security_enabled + signature: security_enabled = True diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_create_parameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_create_parameters.yml new file mode 100644 index 00000000..393390ca --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_create_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.group_create_parameters +name: group_create_parameters +fullName: azure.graphrbac.models.group_create_parameters +classes: +- azure.graphrbac.models.group_create_parameters.GroupCreateParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_create_parameters_py3.GroupCreateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_create_parameters_py3.GroupCreateParameters.yml new file mode 100644 index 00000000..b9d81206 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_create_parameters_py3.GroupCreateParameters.yml @@ -0,0 +1,172 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.group_create_parameters_py3.GroupCreateParameters +name: GroupCreateParameters +fullName: azure.graphrbac.models.group_create_parameters_py3.GroupCreateParameters +module: azure.graphrbac.models.group_create_parameters_py3 +summary: 'Request parameters for creating a new group. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'GroupCreateParameters(*, display_name: str, mail_nickname: str, additional_properties=None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: display_name + description: Required. Group display name + isRequired: true + types: + - + - name: mail_nickname + description: Required. Mail nickname + isRequired: true + types: + - + keywordOnlyParameters: + - name: display_name + isRequired: true + - name: mail_nickname + isRequired: true + - name: additional_properties + isRequired: true +variables: +- description: 'Required. Whether the group is mail-enabled. Must be + + false. This is because only pure security groups can be created using the + + Graph API. Default value: False .' + name: mail_enabled + types: + - +- description: 'Required. Whether the group is a security group. + + Must be true. This is because only pure security groups can be created + + using the Graph API. Default value: True .' + name: security_enabled + types: + - +methods: +- uid: azure.graphrbac.models.group_create_parameters_py3.GroupCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.group_create_parameters_py3.GroupCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.group_create_parameters_py3.GroupCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.group_create_parameters_py3.GroupCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.group_create_parameters_py3.GroupCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.group_create_parameters_py3.GroupCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.group_create_parameters_py3.GroupCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +attributes: +- uid: azure.graphrbac.models.group_create_parameters_py3.GroupCreateParameters.mail_enabled + name: mail_enabled + signature: mail_enabled = False +- uid: azure.graphrbac.models.group_create_parameters_py3.GroupCreateParameters.security_enabled + name: security_enabled + signature: security_enabled = True diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_create_parameters_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_create_parameters_py3.yml new file mode 100644 index 00000000..667aec26 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_create_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.group_create_parameters_py3 +name: group_create_parameters_py3 +fullName: azure.graphrbac.models.group_create_parameters_py3 +classes: +- azure.graphrbac.models.group_create_parameters_py3.GroupCreateParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_get_member_groups_parameters.GroupGetMemberGroupsParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_get_member_groups_parameters.GroupGetMemberGroupsParameters.yml new file mode 100644 index 00000000..fbe717bf --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_get_member_groups_parameters.GroupGetMemberGroupsParameters.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.group_get_member_groups_parameters.GroupGetMemberGroupsParameters +name: GroupGetMemberGroupsParameters +fullName: azure.graphrbac.models.group_get_member_groups_parameters.GroupGetMemberGroupsParameters +module: azure.graphrbac.models.group_get_member_groups_parameters +summary: 'Request parameters for GetMemberGroups API call. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: GroupGetMemberGroupsParameters(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: security_enabled_only + description: 'Required. If true, only membership in + + security-enabled groups should be checked. Otherwise, membership in all + + groups should be checked.' + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.group_get_member_groups_parameters.GroupGetMemberGroupsParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.group_get_member_groups_parameters.GroupGetMemberGroupsParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.group_get_member_groups_parameters.GroupGetMemberGroupsParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.group_get_member_groups_parameters.GroupGetMemberGroupsParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.group_get_member_groups_parameters.GroupGetMemberGroupsParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.group_get_member_groups_parameters.GroupGetMemberGroupsParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.group_get_member_groups_parameters.GroupGetMemberGroupsParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_get_member_groups_parameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_get_member_groups_parameters.yml new file mode 100644 index 00000000..fd1790c4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_get_member_groups_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.group_get_member_groups_parameters +name: group_get_member_groups_parameters +fullName: azure.graphrbac.models.group_get_member_groups_parameters +classes: +- azure.graphrbac.models.group_get_member_groups_parameters.GroupGetMemberGroupsParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_get_member_groups_parameters_py3.GroupGetMemberGroupsParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_get_member_groups_parameters_py3.GroupGetMemberGroupsParameters.yml new file mode 100644 index 00000000..c3e08891 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_get_member_groups_parameters_py3.GroupGetMemberGroupsParameters.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.group_get_member_groups_parameters_py3.GroupGetMemberGroupsParameters +name: GroupGetMemberGroupsParameters +fullName: azure.graphrbac.models.group_get_member_groups_parameters_py3.GroupGetMemberGroupsParameters +module: azure.graphrbac.models.group_get_member_groups_parameters_py3 +summary: 'Request parameters for GetMemberGroups API call. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'GroupGetMemberGroupsParameters(*, security_enabled_only: bool, additional_properties=None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: security_enabled_only + description: 'Required. If true, only membership in + + security-enabled groups should be checked. Otherwise, membership in all + + groups should be checked.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: security_enabled_only + isRequired: true + - name: additional_properties + isRequired: true +methods: +- uid: azure.graphrbac.models.group_get_member_groups_parameters_py3.GroupGetMemberGroupsParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.group_get_member_groups_parameters_py3.GroupGetMemberGroupsParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.group_get_member_groups_parameters_py3.GroupGetMemberGroupsParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.group_get_member_groups_parameters_py3.GroupGetMemberGroupsParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.group_get_member_groups_parameters_py3.GroupGetMemberGroupsParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.group_get_member_groups_parameters_py3.GroupGetMemberGroupsParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.group_get_member_groups_parameters_py3.GroupGetMemberGroupsParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_get_member_groups_parameters_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_get_member_groups_parameters_py3.yml new file mode 100644 index 00000000..314658b8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_get_member_groups_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.group_get_member_groups_parameters_py3 +name: group_get_member_groups_parameters_py3 +fullName: azure.graphrbac.models.group_get_member_groups_parameters_py3 +classes: +- azure.graphrbac.models.group_get_member_groups_parameters_py3.GroupGetMemberGroupsParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.informational_url.InformationalUrl.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.informational_url.InformationalUrl.yml new file mode 100644 index 00000000..9e33b998 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.informational_url.InformationalUrl.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.informational_url.InformationalUrl +name: InformationalUrl +fullName: azure.graphrbac.models.informational_url.InformationalUrl +module: azure.graphrbac.models.informational_url +summary: 'Represents a group of URIs that provide terms of service, marketing, + + support and privacy policy information about an application. The default + + value for each string is null.' +constructor: + syntax: InformationalUrl(**kwargs) + parameters: + - name: terms_of_service + description: The terms of service URI + isRequired: true + types: + - + - name: marketing + description: The marketing URI + isRequired: true + types: + - + - name: privacy + description: The privacy policy URI + isRequired: true + types: + - + - name: support + description: The support URI + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.informational_url.InformationalUrl.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.informational_url.InformationalUrl.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.informational_url.InformationalUrl.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.informational_url.InformationalUrl.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.informational_url.InformationalUrl.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.informational_url.InformationalUrl.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.informational_url.InformationalUrl.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.informational_url.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.informational_url.yml new file mode 100644 index 00000000..632ca473 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.informational_url.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.informational_url +name: informational_url +fullName: azure.graphrbac.models.informational_url +classes: +- azure.graphrbac.models.informational_url.InformationalUrl diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.informational_url_py3.InformationalUrl.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.informational_url_py3.InformationalUrl.yml new file mode 100644 index 00000000..2b33fd1b --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.informational_url_py3.InformationalUrl.yml @@ -0,0 +1,149 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.informational_url_py3.InformationalUrl +name: InformationalUrl +fullName: azure.graphrbac.models.informational_url_py3.InformationalUrl +module: azure.graphrbac.models.informational_url_py3 +summary: 'Represents a group of URIs that provide terms of service, marketing, + + support and privacy policy information about an application. The default + + value for each string is null.' +constructor: + syntax: 'InformationalUrl(*, terms_of_service: str = None, marketing: str = None, + privacy: str = None, support: str = None, **kwargs)' + parameters: + - name: terms_of_service + description: The terms of service URI + isRequired: true + types: + - + - name: marketing + description: The marketing URI + isRequired: true + types: + - + - name: privacy + description: The privacy policy URI + isRequired: true + types: + - + - name: support + description: The support URI + isRequired: true + types: + - + keywordOnlyParameters: + - name: terms_of_service + isRequired: true + - name: marketing + isRequired: true + - name: privacy + isRequired: true + - name: support + isRequired: true +methods: +- uid: azure.graphrbac.models.informational_url_py3.InformationalUrl.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.informational_url_py3.InformationalUrl.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.informational_url_py3.InformationalUrl.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.informational_url_py3.InformationalUrl.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.informational_url_py3.InformationalUrl.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.informational_url_py3.InformationalUrl.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.informational_url_py3.InformationalUrl.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.informational_url_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.informational_url_py3.yml new file mode 100644 index 00000000..37dc8a41 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.informational_url_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.informational_url_py3 +name: informational_url_py3 +fullName: azure.graphrbac.models.informational_url_py3 +classes: +- azure.graphrbac.models.informational_url_py3.InformationalUrl diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential.KeyCredential.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential.KeyCredential.yml new file mode 100644 index 00000000..ad9e7d35 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential.KeyCredential.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.key_credential.KeyCredential +name: KeyCredential +fullName: azure.graphrbac.models.key_credential.KeyCredential +module: azure.graphrbac.models.key_credential +summary: Active Directory Key Credential information. +constructor: + syntax: KeyCredential(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: start_date + description: Start date. + isRequired: true + types: + - + - name: end_date + description: End date. + isRequired: true + types: + - + - name: value + description: Key value. + isRequired: true + types: + - + - name: key_id + description: Key ID. + isRequired: true + types: + - + - name: usage + description: Usage. Acceptable values are 'Verify' and 'Sign'. + isRequired: true + types: + - + - name: type + description: 'Type. Acceptable values are ''AsymmetricX509Cert'' and + + ''Symmetric''.' + isRequired: true + types: + - + - name: custom_key_identifier + description: Custom Key Identifier + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.key_credential.KeyCredential.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.key_credential.KeyCredential.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.key_credential.KeyCredential.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.key_credential.KeyCredential.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.key_credential.KeyCredential.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.key_credential.KeyCredential.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.key_credential.KeyCredential.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential.yml new file mode 100644 index 00000000..cef35c48 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.key_credential +name: key_credential +fullName: azure.graphrbac.models.key_credential +classes: +- azure.graphrbac.models.key_credential.KeyCredential diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential_paged.KeyCredentialPaged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential_paged.KeyCredentialPaged.yml new file mode 100644 index 00000000..16615031 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential_paged.KeyCredentialPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.key_credential_paged.KeyCredentialPaged +name: KeyCredentialPaged +fullName: azure.graphrbac.models.key_credential_paged.KeyCredentialPaged +module: azure.graphrbac.models.key_credential_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: KeyCredentialPaged(*args, **kwargs) +methods: +- uid: azure.graphrbac.models.key_credential_paged.KeyCredentialPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.graphrbac.models.key_credential_paged.KeyCredentialPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.graphrbac.models.key_credential_paged.KeyCredentialPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.key_credential_paged.KeyCredentialPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.key_credential_paged.KeyCredentialPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.graphrbac.models.key_credential_paged.KeyCredentialPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.graphrbac.models.key_credential_paged.KeyCredentialPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential_paged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential_paged.yml new file mode 100644 index 00000000..9ab991f9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.key_credential_paged +name: key_credential_paged +fullName: azure.graphrbac.models.key_credential_paged +classes: +- azure.graphrbac.models.key_credential_paged.KeyCredentialPaged diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential_py3.KeyCredential.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential_py3.KeyCredential.yml new file mode 100644 index 00000000..d75979a7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential_py3.KeyCredential.yml @@ -0,0 +1,178 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.key_credential_py3.KeyCredential +name: KeyCredential +fullName: azure.graphrbac.models.key_credential_py3.KeyCredential +module: azure.graphrbac.models.key_credential_py3 +summary: Active Directory Key Credential information. +constructor: + syntax: 'KeyCredential(*, additional_properties=None, start_date=None, end_date=None, + value: str = None, key_id: str = None, usage: str = None, type: str = None, custom_key_identifier: + str = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: start_date + description: Start date. + isRequired: true + types: + - + - name: end_date + description: End date. + isRequired: true + types: + - + - name: value + description: Key value. + isRequired: true + types: + - + - name: key_id + description: Key ID. + isRequired: true + types: + - + - name: usage + description: Usage. Acceptable values are 'Verify' and 'Sign'. + isRequired: true + types: + - + - name: type + description: 'Type. Acceptable values are ''AsymmetricX509Cert'' and + + ''Symmetric''.' + isRequired: true + types: + - + - name: custom_key_identifier + description: Custom Key Identifier + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: start_date + isRequired: true + - name: end_date + isRequired: true + - name: value + isRequired: true + - name: key_id + isRequired: true + - name: usage + isRequired: true + - name: type + isRequired: true + - name: custom_key_identifier + isRequired: true +methods: +- uid: azure.graphrbac.models.key_credential_py3.KeyCredential.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.key_credential_py3.KeyCredential.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.key_credential_py3.KeyCredential.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.key_credential_py3.KeyCredential.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.key_credential_py3.KeyCredential.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.key_credential_py3.KeyCredential.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.key_credential_py3.KeyCredential.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential_py3.yml new file mode 100644 index 00000000..4e3caca4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.key_credential_py3 +name: key_credential_py3 +fullName: azure.graphrbac.models.key_credential_py3 +classes: +- azure.graphrbac.models.key_credential_py3.KeyCredential diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credentials_update_parameters.KeyCredentialsUpdateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credentials_update_parameters.KeyCredentialsUpdateParameters.yml new file mode 100644 index 00000000..ddcf6192 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credentials_update_parameters.KeyCredentialsUpdateParameters.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.key_credentials_update_parameters.KeyCredentialsUpdateParameters +name: KeyCredentialsUpdateParameters +fullName: azure.graphrbac.models.key_credentials_update_parameters.KeyCredentialsUpdateParameters +module: azure.graphrbac.models.key_credentials_update_parameters +summary: 'Request parameters for a KeyCredentials update operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: KeyCredentialsUpdateParameters(**kwargs) + parameters: + - name: value + description: Required. A collection of KeyCredentials. + isRequired: true + types: + - [] +methods: +- uid: azure.graphrbac.models.key_credentials_update_parameters.KeyCredentialsUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.key_credentials_update_parameters.KeyCredentialsUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.key_credentials_update_parameters.KeyCredentialsUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.key_credentials_update_parameters.KeyCredentialsUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.key_credentials_update_parameters.KeyCredentialsUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.key_credentials_update_parameters.KeyCredentialsUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.key_credentials_update_parameters.KeyCredentialsUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credentials_update_parameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credentials_update_parameters.yml new file mode 100644 index 00000000..00e37b8f --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credentials_update_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.key_credentials_update_parameters +name: key_credentials_update_parameters +fullName: azure.graphrbac.models.key_credentials_update_parameters +classes: +- azure.graphrbac.models.key_credentials_update_parameters.KeyCredentialsUpdateParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credentials_update_parameters_py3.KeyCredentialsUpdateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credentials_update_parameters_py3.KeyCredentialsUpdateParameters.yml new file mode 100644 index 00000000..4d3b95e3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credentials_update_parameters_py3.KeyCredentialsUpdateParameters.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.key_credentials_update_parameters_py3.KeyCredentialsUpdateParameters +name: KeyCredentialsUpdateParameters +fullName: azure.graphrbac.models.key_credentials_update_parameters_py3.KeyCredentialsUpdateParameters +module: azure.graphrbac.models.key_credentials_update_parameters_py3 +summary: 'Request parameters for a KeyCredentials update operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: KeyCredentialsUpdateParameters(*, value, **kwargs) + parameters: + - name: value + description: Required. A collection of KeyCredentials. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: value + isRequired: true +methods: +- uid: azure.graphrbac.models.key_credentials_update_parameters_py3.KeyCredentialsUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.key_credentials_update_parameters_py3.KeyCredentialsUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.key_credentials_update_parameters_py3.KeyCredentialsUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.key_credentials_update_parameters_py3.KeyCredentialsUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.key_credentials_update_parameters_py3.KeyCredentialsUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.key_credentials_update_parameters_py3.KeyCredentialsUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.key_credentials_update_parameters_py3.KeyCredentialsUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credentials_update_parameters_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credentials_update_parameters_py3.yml new file mode 100644 index 00000000..3e2f84cf --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credentials_update_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.key_credentials_update_parameters_py3 +name: key_credentials_update_parameters_py3 +fullName: azure.graphrbac.models.key_credentials_update_parameters_py3 +classes: +- azure.graphrbac.models.key_credentials_update_parameters_py3.KeyCredentialsUpdateParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission.OAuth2Permission.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission.OAuth2Permission.yml new file mode 100644 index 00000000..0a08b908 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission.OAuth2Permission.yml @@ -0,0 +1,190 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.oauth2_permission.OAuth2Permission +name: OAuth2Permission +fullName: azure.graphrbac.models.oauth2_permission.OAuth2Permission +module: azure.graphrbac.models.oauth2_permission +summary: 'Represents an OAuth 2.0 delegated permission scope. The specified OAuth + 2.0 + + delegated permission scopes may be requested by client applications + + (through the requiredResourceAccess collection on the Application object) + + when calling a resource application. The oauth2Permissions property of the + + ServicePrincipal entity and of the Application entity is a collection of + + OAuth2Permission.' +constructor: + syntax: OAuth2Permission(**kwargs) + parameters: + - name: admin_consent_description + description: 'Permission help text that appears in the + + admin consent and app assignment experiences.' + isRequired: true + types: + - + - name: admin_consent_display_name + description: 'Display name for the permission that + + appears in the admin consent and app assignment experiences.' + isRequired: true + types: + - + - name: id + description: 'Unique scope permission identifier inside the oauth2Permissions + + collection.' + isRequired: true + types: + - + - name: is_enabled + description: 'When creating or updating a permission, this property + + must be set to true (which is the default). To delete a permission, this + + property must first be set to false. At that point, in a subsequent call, + + the permission may be removed.' + isRequired: true + types: + - + - name: type + description: 'Specifies whether this scope permission can be consented to + + by an end user, or whether it is a tenant-wide permission that must be + + consented to by a Company Administrator. Possible values are "User" or + + "Admin".' + isRequired: true + types: + - + - name: user_consent_description + description: 'Permission help text that appears in the + + end user consent experience.' + isRequired: true + types: + - + - name: user_consent_display_name + description: 'Display name for the permission that + + appears in the end user consent experience.' + isRequired: true + types: + - + - name: value + description: 'The value of the scope claim that the resource application + + should expect in the OAuth 2.0 access token.' + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.oauth2_permission.OAuth2Permission.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.oauth2_permission.OAuth2Permission.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.oauth2_permission.OAuth2Permission.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.oauth2_permission.OAuth2Permission.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.oauth2_permission.OAuth2Permission.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.oauth2_permission.OAuth2Permission.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.oauth2_permission.OAuth2Permission.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission.yml new file mode 100644 index 00000000..a7f7aa1f --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.oauth2_permission +name: oauth2_permission +fullName: azure.graphrbac.models.oauth2_permission +classes: +- azure.graphrbac.models.oauth2_permission.OAuth2Permission diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant.OAuth2PermissionGrant.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant.OAuth2PermissionGrant.yml new file mode 100644 index 00000000..8a2b57a5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant.OAuth2PermissionGrant.yml @@ -0,0 +1,177 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.oauth2_permission_grant.OAuth2PermissionGrant +name: OAuth2PermissionGrant +fullName: azure.graphrbac.models.oauth2_permission_grant.OAuth2PermissionGrant +module: azure.graphrbac.models.oauth2_permission_grant +summary: OAuth2PermissionGrant. +constructor: + syntax: OAuth2PermissionGrant(**kwargs) + parameters: + - name: odatatype + description: Microsoft.DirectoryServices.OAuth2PermissionGrant + isRequired: true + types: + - + - name: client_id + description: 'The id of the resource''s service principal granted + + consent to impersonate the user when accessing the resource (represented + + by the resourceId property).' + isRequired: true + types: + - + - name: object_id + description: The id of the permission grant + isRequired: true + types: + - + - name: consent_type + description: 'Indicates if consent was provided by the + + administrator (on behalf of the organization) or by an individual. + + Possible values include: ''AllPrincipals'', ''Principal''' + isRequired: true + types: + - + - + - name: principal_id + description: 'When consent type is Principal, this property + + specifies the id of the user that granted consent and applies only for + + that user.' + isRequired: true + types: + - + - name: resource_id + description: Object Id of the resource you want to grant + isRequired: true + types: + - + - name: scope + description: 'Specifies the value of the scope claim that the resource + + application should expect in the OAuth 2.0 access token. For example, + + User.Read' + isRequired: true + types: + - + - name: start_time + description: Start time for TTL + isRequired: true + types: + - + - name: expiry_time + description: Expiry time for TTL + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.oauth2_permission_grant.OAuth2PermissionGrant.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.oauth2_permission_grant.OAuth2PermissionGrant.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.oauth2_permission_grant.OAuth2PermissionGrant.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.oauth2_permission_grant.OAuth2PermissionGrant.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.oauth2_permission_grant.OAuth2PermissionGrant.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.oauth2_permission_grant.OAuth2PermissionGrant.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.oauth2_permission_grant.OAuth2PermissionGrant.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant.yml new file mode 100644 index 00000000..33d32f7b --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.oauth2_permission_grant +name: oauth2_permission_grant +fullName: azure.graphrbac.models.oauth2_permission_grant +classes: +- azure.graphrbac.models.oauth2_permission_grant.OAuth2PermissionGrant diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant_paged.OAuth2PermissionGrantPaged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant_paged.OAuth2PermissionGrantPaged.yml new file mode 100644 index 00000000..b7332d25 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant_paged.OAuth2PermissionGrantPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.oauth2_permission_grant_paged.OAuth2PermissionGrantPaged +name: OAuth2PermissionGrantPaged +fullName: azure.graphrbac.models.oauth2_permission_grant_paged.OAuth2PermissionGrantPaged +module: azure.graphrbac.models.oauth2_permission_grant_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: OAuth2PermissionGrantPaged(*args, **kwargs) +methods: +- uid: azure.graphrbac.models.oauth2_permission_grant_paged.OAuth2PermissionGrantPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.graphrbac.models.oauth2_permission_grant_paged.OAuth2PermissionGrantPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.graphrbac.models.oauth2_permission_grant_paged.OAuth2PermissionGrantPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.oauth2_permission_grant_paged.OAuth2PermissionGrantPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.oauth2_permission_grant_paged.OAuth2PermissionGrantPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.graphrbac.models.oauth2_permission_grant_paged.OAuth2PermissionGrantPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.graphrbac.models.oauth2_permission_grant_paged.OAuth2PermissionGrantPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant_paged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant_paged.yml new file mode 100644 index 00000000..1b63ed11 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.oauth2_permission_grant_paged +name: oauth2_permission_grant_paged +fullName: azure.graphrbac.models.oauth2_permission_grant_paged +classes: +- azure.graphrbac.models.oauth2_permission_grant_paged.OAuth2PermissionGrantPaged diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant_py3.OAuth2PermissionGrant.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant_py3.OAuth2PermissionGrant.yml new file mode 100644 index 00000000..b0a59ebf --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant_py3.OAuth2PermissionGrant.yml @@ -0,0 +1,199 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.oauth2_permission_grant_py3.OAuth2PermissionGrant +name: OAuth2PermissionGrant +fullName: azure.graphrbac.models.oauth2_permission_grant_py3.OAuth2PermissionGrant +module: azure.graphrbac.models.oauth2_permission_grant_py3 +summary: OAuth2PermissionGrant. +constructor: + syntax: 'OAuth2PermissionGrant(*, odatatype: str = None, client_id: str = None, + object_id: str = None, consent_type=None, principal_id: str = None, resource_id: + str = None, scope: str = None, start_time: str = None, expiry_time: str = None, + **kwargs)' + parameters: + - name: odatatype + description: Microsoft.DirectoryServices.OAuth2PermissionGrant + isRequired: true + types: + - + - name: client_id + description: 'The id of the resource''s service principal granted + + consent to impersonate the user when accessing the resource (represented + + by the resourceId property).' + isRequired: true + types: + - + - name: object_id + description: The id of the permission grant + isRequired: true + types: + - + - name: consent_type + description: 'Indicates if consent was provided by the + + administrator (on behalf of the organization) or by an individual. + + Possible values include: ''AllPrincipals'', ''Principal''' + isRequired: true + types: + - + - + - name: principal_id + description: 'When consent type is Principal, this property + + specifies the id of the user that granted consent and applies only for + + that user.' + isRequired: true + types: + - + - name: resource_id + description: Object Id of the resource you want to grant + isRequired: true + types: + - + - name: scope + description: 'Specifies the value of the scope claim that the resource + + application should expect in the OAuth 2.0 access token. For example, + + User.Read' + isRequired: true + types: + - + - name: start_time + description: Start time for TTL + isRequired: true + types: + - + - name: expiry_time + description: Expiry time for TTL + isRequired: true + types: + - + keywordOnlyParameters: + - name: odatatype + isRequired: true + - name: client_id + isRequired: true + - name: object_id + isRequired: true + - name: consent_type + isRequired: true + - name: principal_id + isRequired: true + - name: resource_id + isRequired: true + - name: scope + isRequired: true + - name: start_time + isRequired: true + - name: expiry_time + isRequired: true +methods: +- uid: azure.graphrbac.models.oauth2_permission_grant_py3.OAuth2PermissionGrant.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.oauth2_permission_grant_py3.OAuth2PermissionGrant.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.oauth2_permission_grant_py3.OAuth2PermissionGrant.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.oauth2_permission_grant_py3.OAuth2PermissionGrant.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.oauth2_permission_grant_py3.OAuth2PermissionGrant.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.oauth2_permission_grant_py3.OAuth2PermissionGrant.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.oauth2_permission_grant_py3.OAuth2PermissionGrant.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant_py3.yml new file mode 100644 index 00000000..a3427ba5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.oauth2_permission_grant_py3 +name: oauth2_permission_grant_py3 +fullName: azure.graphrbac.models.oauth2_permission_grant_py3 +classes: +- azure.graphrbac.models.oauth2_permission_grant_py3.OAuth2PermissionGrant diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_py3.OAuth2Permission.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_py3.OAuth2Permission.yml new file mode 100644 index 00000000..cd3f5f4d --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_py3.OAuth2Permission.yml @@ -0,0 +1,209 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.oauth2_permission_py3.OAuth2Permission +name: OAuth2Permission +fullName: azure.graphrbac.models.oauth2_permission_py3.OAuth2Permission +module: azure.graphrbac.models.oauth2_permission_py3 +summary: 'Represents an OAuth 2.0 delegated permission scope. The specified OAuth + 2.0 + + delegated permission scopes may be requested by client applications + + (through the requiredResourceAccess collection on the Application object) + + when calling a resource application. The oauth2Permissions property of the + + ServicePrincipal entity and of the Application entity is a collection of + + OAuth2Permission.' +constructor: + syntax: 'OAuth2Permission(*, admin_consent_description: str = None, admin_consent_display_name: + str = None, id: str = None, is_enabled: bool = None, type: str = None, user_consent_description: + str = None, user_consent_display_name: str = None, value: str = None, **kwargs)' + parameters: + - name: admin_consent_description + description: 'Permission help text that appears in the + + admin consent and app assignment experiences.' + isRequired: true + types: + - + - name: admin_consent_display_name + description: 'Display name for the permission that + + appears in the admin consent and app assignment experiences.' + isRequired: true + types: + - + - name: id + description: 'Unique scope permission identifier inside the oauth2Permissions + + collection.' + isRequired: true + types: + - + - name: is_enabled + description: 'When creating or updating a permission, this property + + must be set to true (which is the default). To delete a permission, this + + property must first be set to false. At that point, in a subsequent call, + + the permission may be removed.' + isRequired: true + types: + - + - name: type + description: 'Specifies whether this scope permission can be consented to + + by an end user, or whether it is a tenant-wide permission that must be + + consented to by a Company Administrator. Possible values are "User" or + + "Admin".' + isRequired: true + types: + - + - name: user_consent_description + description: 'Permission help text that appears in the + + end user consent experience.' + isRequired: true + types: + - + - name: user_consent_display_name + description: 'Display name for the permission that + + appears in the end user consent experience.' + isRequired: true + types: + - + - name: value + description: 'The value of the scope claim that the resource application + + should expect in the OAuth 2.0 access token.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: admin_consent_description + isRequired: true + - name: admin_consent_display_name + isRequired: true + - name: id + isRequired: true + - name: is_enabled + isRequired: true + - name: type + isRequired: true + - name: user_consent_description + isRequired: true + - name: user_consent_display_name + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.graphrbac.models.oauth2_permission_py3.OAuth2Permission.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.oauth2_permission_py3.OAuth2Permission.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.oauth2_permission_py3.OAuth2Permission.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.oauth2_permission_py3.OAuth2Permission.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.oauth2_permission_py3.OAuth2Permission.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.oauth2_permission_py3.OAuth2Permission.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.oauth2_permission_py3.OAuth2Permission.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_py3.yml new file mode 100644 index 00000000..717fd8a0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.oauth2_permission_py3 +name: oauth2_permission_py3 +fullName: azure.graphrbac.models.oauth2_permission_py3 +classes: +- azure.graphrbac.models.oauth2_permission_py3.OAuth2Permission diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claim.OptionalClaim.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claim.OptionalClaim.yml new file mode 100644 index 00000000..cf28484b --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claim.OptionalClaim.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.optional_claim.OptionalClaim +name: OptionalClaim +fullName: azure.graphrbac.models.optional_claim.OptionalClaim +module: azure.graphrbac.models.optional_claim +summary: Specifying the claims to be included in a token. +constructor: + syntax: OptionalClaim(**kwargs) + parameters: + - name: name + description: Claim name. + isRequired: true + types: + - + - name: source + description: Claim source. + isRequired: true + types: + - + - name: essential + description: Is this a required claim. + isRequired: true + types: + - + - name: additional_properties + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.optional_claim.OptionalClaim.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.optional_claim.OptionalClaim.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.optional_claim.OptionalClaim.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.optional_claim.OptionalClaim.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.optional_claim.OptionalClaim.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.optional_claim.OptionalClaim.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.optional_claim.OptionalClaim.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claim.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claim.yml new file mode 100644 index 00000000..f443086f --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claim.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.optional_claim +name: optional_claim +fullName: azure.graphrbac.models.optional_claim +classes: +- azure.graphrbac.models.optional_claim.OptionalClaim diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claim_py3.OptionalClaim.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claim_py3.OptionalClaim.yml new file mode 100644 index 00000000..dd1526ac --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claim_py3.OptionalClaim.yml @@ -0,0 +1,144 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.optional_claim_py3.OptionalClaim +name: OptionalClaim +fullName: azure.graphrbac.models.optional_claim_py3.OptionalClaim +module: azure.graphrbac.models.optional_claim_py3 +summary: Specifying the claims to be included in a token. +constructor: + syntax: 'OptionalClaim(*, name: str = None, source: str = None, essential: bool + = None, additional_properties=None, **kwargs)' + parameters: + - name: name + description: Claim name. + isRequired: true + types: + - + - name: source + description: Claim source. + isRequired: true + types: + - + - name: essential + description: Is this a required claim. + isRequired: true + types: + - + - name: additional_properties + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: source + isRequired: true + - name: essential + isRequired: true + - name: additional_properties + isRequired: true +methods: +- uid: azure.graphrbac.models.optional_claim_py3.OptionalClaim.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.optional_claim_py3.OptionalClaim.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.optional_claim_py3.OptionalClaim.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.optional_claim_py3.OptionalClaim.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.optional_claim_py3.OptionalClaim.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.optional_claim_py3.OptionalClaim.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.optional_claim_py3.OptionalClaim.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claim_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claim_py3.yml new file mode 100644 index 00000000..79779d14 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claim_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.optional_claim_py3 +name: optional_claim_py3 +fullName: azure.graphrbac.models.optional_claim_py3 +classes: +- azure.graphrbac.models.optional_claim_py3.OptionalClaim diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claims.OptionalClaims.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claims.OptionalClaims.yml new file mode 100644 index 00000000..cff420e3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claims.OptionalClaims.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.optional_claims.OptionalClaims +name: OptionalClaims +fullName: azure.graphrbac.models.optional_claims.OptionalClaims +module: azure.graphrbac.models.optional_claims +summary: Specifying the claims to be included in the token. +constructor: + syntax: OptionalClaims(**kwargs) + parameters: + - name: id_token + description: Optional claims requested to be included in the id token. + isRequired: true + types: + - [] + - name: access_token + description: 'Optional claims requested to be included in the + + access token.' + isRequired: true + types: + - [] + - name: saml_token + description: 'Optional claims requested to be included in the saml + + token.' + isRequired: true + types: + - [] +methods: +- uid: azure.graphrbac.models.optional_claims.OptionalClaims.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.optional_claims.OptionalClaims.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.optional_claims.OptionalClaims.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.optional_claims.OptionalClaims.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.optional_claims.OptionalClaims.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.optional_claims.OptionalClaims.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.optional_claims.OptionalClaims.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claims.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claims.yml new file mode 100644 index 00000000..8f3dd5d2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claims.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.optional_claims +name: optional_claims +fullName: azure.graphrbac.models.optional_claims +classes: +- azure.graphrbac.models.optional_claims.OptionalClaims diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claims_py3.OptionalClaims.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claims_py3.OptionalClaims.yml new file mode 100644 index 00000000..57a0422b --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claims_py3.OptionalClaims.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.optional_claims_py3.OptionalClaims +name: OptionalClaims +fullName: azure.graphrbac.models.optional_claims_py3.OptionalClaims +module: azure.graphrbac.models.optional_claims_py3 +summary: Specifying the claims to be included in the token. +constructor: + syntax: OptionalClaims(*, id_token=None, access_token=None, saml_token=None, **kwargs) + parameters: + - name: id_token + description: Optional claims requested to be included in the id token. + isRequired: true + types: + - [] + - name: access_token + description: 'Optional claims requested to be included in the + + access token.' + isRequired: true + types: + - [] + - name: saml_token + description: 'Optional claims requested to be included in the saml + + token.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id_token + isRequired: true + - name: access_token + isRequired: true + - name: saml_token + isRequired: true +methods: +- uid: azure.graphrbac.models.optional_claims_py3.OptionalClaims.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.optional_claims_py3.OptionalClaims.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.optional_claims_py3.OptionalClaims.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.optional_claims_py3.OptionalClaims.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.optional_claims_py3.OptionalClaims.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.optional_claims_py3.OptionalClaims.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.optional_claims_py3.OptionalClaims.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claims_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claims_py3.yml new file mode 100644 index 00000000..f2ab9dcd --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claims_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.optional_claims_py3 +name: optional_claims_py3 +fullName: azure.graphrbac.models.optional_claims_py3 +classes: +- azure.graphrbac.models.optional_claims_py3.OptionalClaims diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential.PasswordCredential.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential.PasswordCredential.yml new file mode 100644 index 00000000..12327f42 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential.PasswordCredential.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.password_credential.PasswordCredential +name: PasswordCredential +fullName: azure.graphrbac.models.password_credential.PasswordCredential +module: azure.graphrbac.models.password_credential +summary: Active Directory Password Credential information. +constructor: + syntax: PasswordCredential(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: start_date + description: Start date. + isRequired: true + types: + - + - name: end_date + description: End date. + isRequired: true + types: + - + - name: key_id + description: Key ID. + isRequired: true + types: + - + - name: value + description: Key value. + isRequired: true + types: + - + - name: custom_key_identifier + description: Custom Key Identifier + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.password_credential.PasswordCredential.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.password_credential.PasswordCredential.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.password_credential.PasswordCredential.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.password_credential.PasswordCredential.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.password_credential.PasswordCredential.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.password_credential.PasswordCredential.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.password_credential.PasswordCredential.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential.yml new file mode 100644 index 00000000..cdcea802 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.password_credential +name: password_credential +fullName: azure.graphrbac.models.password_credential +classes: +- azure.graphrbac.models.password_credential.PasswordCredential diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential_paged.PasswordCredentialPaged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential_paged.PasswordCredentialPaged.yml new file mode 100644 index 00000000..d7212e26 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential_paged.PasswordCredentialPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.password_credential_paged.PasswordCredentialPaged +name: PasswordCredentialPaged +fullName: azure.graphrbac.models.password_credential_paged.PasswordCredentialPaged +module: azure.graphrbac.models.password_credential_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: PasswordCredentialPaged(*args, **kwargs) +methods: +- uid: azure.graphrbac.models.password_credential_paged.PasswordCredentialPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.graphrbac.models.password_credential_paged.PasswordCredentialPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.graphrbac.models.password_credential_paged.PasswordCredentialPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.password_credential_paged.PasswordCredentialPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.password_credential_paged.PasswordCredentialPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.graphrbac.models.password_credential_paged.PasswordCredentialPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.graphrbac.models.password_credential_paged.PasswordCredentialPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential_paged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential_paged.yml new file mode 100644 index 00000000..fabd992f --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.password_credential_paged +name: password_credential_paged +fullName: azure.graphrbac.models.password_credential_paged +classes: +- azure.graphrbac.models.password_credential_paged.PasswordCredentialPaged diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential_py3.PasswordCredential.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential_py3.PasswordCredential.yml new file mode 100644 index 00000000..e475d9af --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential_py3.PasswordCredential.yml @@ -0,0 +1,162 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.password_credential_py3.PasswordCredential +name: PasswordCredential +fullName: azure.graphrbac.models.password_credential_py3.PasswordCredential +module: azure.graphrbac.models.password_credential_py3 +summary: Active Directory Password Credential information. +constructor: + syntax: 'PasswordCredential(*, additional_properties=None, start_date=None, end_date=None, + key_id: str = None, value: str = None, custom_key_identifier: bytearray = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: start_date + description: Start date. + isRequired: true + types: + - + - name: end_date + description: End date. + isRequired: true + types: + - + - name: key_id + description: Key ID. + isRequired: true + types: + - + - name: value + description: Key value. + isRequired: true + types: + - + - name: custom_key_identifier + description: Custom Key Identifier + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: start_date + isRequired: true + - name: end_date + isRequired: true + - name: key_id + isRequired: true + - name: value + isRequired: true + - name: custom_key_identifier + isRequired: true +methods: +- uid: azure.graphrbac.models.password_credential_py3.PasswordCredential.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.password_credential_py3.PasswordCredential.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.password_credential_py3.PasswordCredential.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.password_credential_py3.PasswordCredential.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.password_credential_py3.PasswordCredential.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.password_credential_py3.PasswordCredential.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.password_credential_py3.PasswordCredential.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential_py3.yml new file mode 100644 index 00000000..b51b933b --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.password_credential_py3 +name: password_credential_py3 +fullName: azure.graphrbac.models.password_credential_py3 +classes: +- azure.graphrbac.models.password_credential_py3.PasswordCredential diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credentials_update_parameters.PasswordCredentialsUpdateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credentials_update_parameters.PasswordCredentialsUpdateParameters.yml new file mode 100644 index 00000000..d37915a6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credentials_update_parameters.PasswordCredentialsUpdateParameters.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.password_credentials_update_parameters.PasswordCredentialsUpdateParameters +name: PasswordCredentialsUpdateParameters +fullName: azure.graphrbac.models.password_credentials_update_parameters.PasswordCredentialsUpdateParameters +module: azure.graphrbac.models.password_credentials_update_parameters +summary: 'Request parameters for a PasswordCredentials update operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: PasswordCredentialsUpdateParameters(**kwargs) + parameters: + - name: value + description: Required. A collection of PasswordCredentials. + isRequired: true + types: + - [] +methods: +- uid: azure.graphrbac.models.password_credentials_update_parameters.PasswordCredentialsUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.password_credentials_update_parameters.PasswordCredentialsUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.password_credentials_update_parameters.PasswordCredentialsUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.password_credentials_update_parameters.PasswordCredentialsUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.password_credentials_update_parameters.PasswordCredentialsUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.password_credentials_update_parameters.PasswordCredentialsUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.password_credentials_update_parameters.PasswordCredentialsUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credentials_update_parameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credentials_update_parameters.yml new file mode 100644 index 00000000..166bfad2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credentials_update_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.password_credentials_update_parameters +name: password_credentials_update_parameters +fullName: azure.graphrbac.models.password_credentials_update_parameters +classes: +- azure.graphrbac.models.password_credentials_update_parameters.PasswordCredentialsUpdateParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credentials_update_parameters_py3.PasswordCredentialsUpdateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credentials_update_parameters_py3.PasswordCredentialsUpdateParameters.yml new file mode 100644 index 00000000..875b9a0a --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credentials_update_parameters_py3.PasswordCredentialsUpdateParameters.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.password_credentials_update_parameters_py3.PasswordCredentialsUpdateParameters +name: PasswordCredentialsUpdateParameters +fullName: azure.graphrbac.models.password_credentials_update_parameters_py3.PasswordCredentialsUpdateParameters +module: azure.graphrbac.models.password_credentials_update_parameters_py3 +summary: 'Request parameters for a PasswordCredentials update operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: PasswordCredentialsUpdateParameters(*, value, **kwargs) + parameters: + - name: value + description: Required. A collection of PasswordCredentials. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: value + isRequired: true +methods: +- uid: azure.graphrbac.models.password_credentials_update_parameters_py3.PasswordCredentialsUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.password_credentials_update_parameters_py3.PasswordCredentialsUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.password_credentials_update_parameters_py3.PasswordCredentialsUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.password_credentials_update_parameters_py3.PasswordCredentialsUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.password_credentials_update_parameters_py3.PasswordCredentialsUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.password_credentials_update_parameters_py3.PasswordCredentialsUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.password_credentials_update_parameters_py3.PasswordCredentialsUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credentials_update_parameters_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credentials_update_parameters_py3.yml new file mode 100644 index 00000000..c90c5b12 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credentials_update_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.password_credentials_update_parameters_py3 +name: password_credentials_update_parameters_py3 +fullName: azure.graphrbac.models.password_credentials_update_parameters_py3 +classes: +- azure.graphrbac.models.password_credentials_update_parameters_py3.PasswordCredentialsUpdateParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_profile.PasswordProfile.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_profile.PasswordProfile.yml new file mode 100644 index 00000000..5e8a0cf3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_profile.PasswordProfile.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.password_profile.PasswordProfile +name: PasswordProfile +fullName: azure.graphrbac.models.password_profile.PasswordProfile +module: azure.graphrbac.models.password_profile +summary: 'The password profile associated with a user. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: PasswordProfile(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: password + description: Required. Password + isRequired: true + types: + - + - name: force_change_password_next_login + description: 'Whether to force a password + + change on next login.' + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.password_profile.PasswordProfile.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.password_profile.PasswordProfile.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.password_profile.PasswordProfile.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.password_profile.PasswordProfile.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.password_profile.PasswordProfile.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.password_profile.PasswordProfile.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.password_profile.PasswordProfile.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_profile.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_profile.yml new file mode 100644 index 00000000..30c6a6c1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_profile.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.password_profile +name: password_profile +fullName: azure.graphrbac.models.password_profile +classes: +- azure.graphrbac.models.password_profile.PasswordProfile diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_profile_py3.PasswordProfile.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_profile_py3.PasswordProfile.yml new file mode 100644 index 00000000..350e9607 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_profile_py3.PasswordProfile.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.password_profile_py3.PasswordProfile +name: PasswordProfile +fullName: azure.graphrbac.models.password_profile_py3.PasswordProfile +module: azure.graphrbac.models.password_profile_py3 +summary: 'The password profile associated with a user. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PasswordProfile(*, password: str, additional_properties=None, force_change_password_next_login: + bool = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: password + description: Required. Password + isRequired: true + types: + - + - name: force_change_password_next_login + description: 'Whether to force a password + + change on next login.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: password + isRequired: true + - name: additional_properties + isRequired: true + - name: force_change_password_next_login + isRequired: true +methods: +- uid: azure.graphrbac.models.password_profile_py3.PasswordProfile.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.password_profile_py3.PasswordProfile.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.password_profile_py3.PasswordProfile.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.password_profile_py3.PasswordProfile.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.password_profile_py3.PasswordProfile.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.password_profile_py3.PasswordProfile.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.password_profile_py3.PasswordProfile.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_profile_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_profile_py3.yml new file mode 100644 index 00000000..bd344c36 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_profile_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.password_profile_py3 +name: password_profile_py3 +fullName: azure.graphrbac.models.password_profile_py3 +classes: +- azure.graphrbac.models.password_profile_py3.PasswordProfile diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application.PreAuthorizedApplication.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application.PreAuthorizedApplication.yml new file mode 100644 index 00000000..bcf6e83d --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application.PreAuthorizedApplication.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.pre_authorized_application.PreAuthorizedApplication +name: PreAuthorizedApplication +fullName: azure.graphrbac.models.pre_authorized_application.PreAuthorizedApplication +module: azure.graphrbac.models.pre_authorized_application +summary: Contains information about pre authorized client application. +constructor: + syntax: PreAuthorizedApplication(**kwargs) + parameters: + - name: app_id + description: Represents the application id. + isRequired: true + types: + - + - name: permissions + description: 'Collection of required app permissions/entitlements + + from the resource application.' + isRequired: true + types: + - [] + - name: extensions + description: Collection of extensions from the resource application. + isRequired: true + types: + - [] +methods: +- uid: azure.graphrbac.models.pre_authorized_application.PreAuthorizedApplication.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.pre_authorized_application.PreAuthorizedApplication.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.pre_authorized_application.PreAuthorizedApplication.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.pre_authorized_application.PreAuthorizedApplication.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.pre_authorized_application.PreAuthorizedApplication.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.pre_authorized_application.PreAuthorizedApplication.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.pre_authorized_application.PreAuthorizedApplication.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application.yml new file mode 100644 index 00000000..93a86284 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.pre_authorized_application +name: pre_authorized_application +fullName: azure.graphrbac.models.pre_authorized_application +classes: +- azure.graphrbac.models.pre_authorized_application.PreAuthorizedApplication diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_extension.PreAuthorizedApplicationExtension.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_extension.PreAuthorizedApplicationExtension.yml new file mode 100644 index 00000000..64596ff6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_extension.PreAuthorizedApplicationExtension.yml @@ -0,0 +1,122 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.pre_authorized_application_extension.PreAuthorizedApplicationExtension +name: PreAuthorizedApplicationExtension +fullName: azure.graphrbac.models.pre_authorized_application_extension.PreAuthorizedApplicationExtension +module: azure.graphrbac.models.pre_authorized_application_extension +summary: 'Representation of an app PreAuthorizedApplicationExtension required by a + + pre authorized client app.' +constructor: + syntax: PreAuthorizedApplicationExtension(**kwargs) + parameters: + - name: conditions + description: The extension's conditions. + isRequired: true + types: + - [] +methods: +- uid: azure.graphrbac.models.pre_authorized_application_extension.PreAuthorizedApplicationExtension.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.pre_authorized_application_extension.PreAuthorizedApplicationExtension.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.pre_authorized_application_extension.PreAuthorizedApplicationExtension.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.pre_authorized_application_extension.PreAuthorizedApplicationExtension.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.pre_authorized_application_extension.PreAuthorizedApplicationExtension.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.pre_authorized_application_extension.PreAuthorizedApplicationExtension.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.pre_authorized_application_extension.PreAuthorizedApplicationExtension.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_extension.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_extension.yml new file mode 100644 index 00000000..d348bf1b --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_extension.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.pre_authorized_application_extension +name: pre_authorized_application_extension +fullName: azure.graphrbac.models.pre_authorized_application_extension +classes: +- azure.graphrbac.models.pre_authorized_application_extension.PreAuthorizedApplicationExtension diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_extension_py3.PreAuthorizedApplicationExtension.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_extension_py3.PreAuthorizedApplicationExtension.yml new file mode 100644 index 00000000..480ca2a6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_extension_py3.PreAuthorizedApplicationExtension.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.pre_authorized_application_extension_py3.PreAuthorizedApplicationExtension +name: PreAuthorizedApplicationExtension +fullName: azure.graphrbac.models.pre_authorized_application_extension_py3.PreAuthorizedApplicationExtension +module: azure.graphrbac.models.pre_authorized_application_extension_py3 +summary: 'Representation of an app PreAuthorizedApplicationExtension required by a + + pre authorized client app.' +constructor: + syntax: PreAuthorizedApplicationExtension(*, conditions=None, **kwargs) + parameters: + - name: conditions + description: The extension's conditions. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: conditions + isRequired: true +methods: +- uid: azure.graphrbac.models.pre_authorized_application_extension_py3.PreAuthorizedApplicationExtension.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.pre_authorized_application_extension_py3.PreAuthorizedApplicationExtension.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.pre_authorized_application_extension_py3.PreAuthorizedApplicationExtension.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.pre_authorized_application_extension_py3.PreAuthorizedApplicationExtension.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.pre_authorized_application_extension_py3.PreAuthorizedApplicationExtension.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.pre_authorized_application_extension_py3.PreAuthorizedApplicationExtension.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.pre_authorized_application_extension_py3.PreAuthorizedApplicationExtension.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_extension_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_extension_py3.yml new file mode 100644 index 00000000..7cd79c01 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_extension_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.pre_authorized_application_extension_py3 +name: pre_authorized_application_extension_py3 +fullName: azure.graphrbac.models.pre_authorized_application_extension_py3 +classes: +- azure.graphrbac.models.pre_authorized_application_extension_py3.PreAuthorizedApplicationExtension diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_permission.PreAuthorizedApplicationPermission.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_permission.PreAuthorizedApplicationPermission.yml new file mode 100644 index 00000000..38b8b1eb --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_permission.PreAuthorizedApplicationPermission.yml @@ -0,0 +1,127 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.pre_authorized_application_permission.PreAuthorizedApplicationPermission +name: PreAuthorizedApplicationPermission +fullName: azure.graphrbac.models.pre_authorized_application_permission.PreAuthorizedApplicationPermission +module: azure.graphrbac.models.pre_authorized_application_permission +summary: Contains information about the pre-authorized permissions. +constructor: + syntax: PreAuthorizedApplicationPermission(**kwargs) + parameters: + - name: direct_access_grant + description: 'Indicates whether the permission set is + + DirectAccess or impersonation.' + isRequired: true + types: + - + - name: access_grants + description: The list of permissions. + isRequired: true + types: + - [] +methods: +- uid: azure.graphrbac.models.pre_authorized_application_permission.PreAuthorizedApplicationPermission.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.pre_authorized_application_permission.PreAuthorizedApplicationPermission.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.pre_authorized_application_permission.PreAuthorizedApplicationPermission.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.pre_authorized_application_permission.PreAuthorizedApplicationPermission.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.pre_authorized_application_permission.PreAuthorizedApplicationPermission.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.pre_authorized_application_permission.PreAuthorizedApplicationPermission.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.pre_authorized_application_permission.PreAuthorizedApplicationPermission.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_permission.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_permission.yml new file mode 100644 index 00000000..ea82c7fd --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_permission.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.pre_authorized_application_permission +name: pre_authorized_application_permission +fullName: azure.graphrbac.models.pre_authorized_application_permission +classes: +- azure.graphrbac.models.pre_authorized_application_permission.PreAuthorizedApplicationPermission diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_permission_py3.PreAuthorizedApplicationPermission.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_permission_py3.PreAuthorizedApplicationPermission.yml new file mode 100644 index 00000000..d7451f2e --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_permission_py3.PreAuthorizedApplicationPermission.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.pre_authorized_application_permission_py3.PreAuthorizedApplicationPermission +name: PreAuthorizedApplicationPermission +fullName: azure.graphrbac.models.pre_authorized_application_permission_py3.PreAuthorizedApplicationPermission +module: azure.graphrbac.models.pre_authorized_application_permission_py3 +summary: Contains information about the pre-authorized permissions. +constructor: + syntax: 'PreAuthorizedApplicationPermission(*, direct_access_grant: bool = None, + access_grants=None, **kwargs)' + parameters: + - name: direct_access_grant + description: 'Indicates whether the permission set is + + DirectAccess or impersonation.' + isRequired: true + types: + - + - name: access_grants + description: The list of permissions. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: direct_access_grant + isRequired: true + - name: access_grants + isRequired: true +methods: +- uid: azure.graphrbac.models.pre_authorized_application_permission_py3.PreAuthorizedApplicationPermission.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.pre_authorized_application_permission_py3.PreAuthorizedApplicationPermission.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.pre_authorized_application_permission_py3.PreAuthorizedApplicationPermission.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.pre_authorized_application_permission_py3.PreAuthorizedApplicationPermission.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.pre_authorized_application_permission_py3.PreAuthorizedApplicationPermission.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.pre_authorized_application_permission_py3.PreAuthorizedApplicationPermission.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.pre_authorized_application_permission_py3.PreAuthorizedApplicationPermission.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_permission_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_permission_py3.yml new file mode 100644 index 00000000..ba118f9c --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_permission_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.pre_authorized_application_permission_py3 +name: pre_authorized_application_permission_py3 +fullName: azure.graphrbac.models.pre_authorized_application_permission_py3 +classes: +- azure.graphrbac.models.pre_authorized_application_permission_py3.PreAuthorizedApplicationPermission diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_py3.PreAuthorizedApplication.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_py3.PreAuthorizedApplication.yml new file mode 100644 index 00000000..b2c880bd --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_py3.PreAuthorizedApplication.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.pre_authorized_application_py3.PreAuthorizedApplication +name: PreAuthorizedApplication +fullName: azure.graphrbac.models.pre_authorized_application_py3.PreAuthorizedApplication +module: azure.graphrbac.models.pre_authorized_application_py3 +summary: Contains information about pre authorized client application. +constructor: + syntax: 'PreAuthorizedApplication(*, app_id: str = None, permissions=None, extensions=None, + **kwargs)' + parameters: + - name: app_id + description: Represents the application id. + isRequired: true + types: + - + - name: permissions + description: 'Collection of required app permissions/entitlements + + from the resource application.' + isRequired: true + types: + - [] + - name: extensions + description: Collection of extensions from the resource application. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: app_id + isRequired: true + - name: permissions + isRequired: true + - name: extensions + isRequired: true +methods: +- uid: azure.graphrbac.models.pre_authorized_application_py3.PreAuthorizedApplication.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.pre_authorized_application_py3.PreAuthorizedApplication.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.pre_authorized_application_py3.PreAuthorizedApplication.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.pre_authorized_application_py3.PreAuthorizedApplication.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.pre_authorized_application_py3.PreAuthorizedApplication.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.pre_authorized_application_py3.PreAuthorizedApplication.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.pre_authorized_application_py3.PreAuthorizedApplication.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_py3.yml new file mode 100644 index 00000000..bcff930a --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.pre_authorized_application_py3 +name: pre_authorized_application_py3 +fullName: azure.graphrbac.models.pre_authorized_application_py3 +classes: +- azure.graphrbac.models.pre_authorized_application_py3.PreAuthorizedApplication diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.required_resource_access.RequiredResourceAccess.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.required_resource_access.RequiredResourceAccess.yml new file mode 100644 index 00000000..ebc2db9f --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.required_resource_access.RequiredResourceAccess.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.required_resource_access.RequiredResourceAccess +name: RequiredResourceAccess +fullName: azure.graphrbac.models.required_resource_access.RequiredResourceAccess +module: azure.graphrbac.models.required_resource_access +summary: 'Specifies the set of OAuth 2.0 permission scopes and app roles under the + + specified resource that an application requires access to. The specified + + OAuth 2.0 permission scopes may be requested by client applications + + (through the requiredResourceAccess collection) when calling a resource + + application. The requiredResourceAccess property of the Application entity + + is a collection of RequiredResourceAccess. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: RequiredResourceAccess(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: resource_access + description: 'Required. The list of OAuth2.0 permission scopes + + and app roles that the application requires from the specified resource.' + isRequired: true + types: + - [] + - name: resource_app_id + description: 'The unique identifier for the resource that the + + application requires access to. This should be equal to the appId declared + + on the target resource application.' + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.required_resource_access.RequiredResourceAccess.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.required_resource_access.RequiredResourceAccess.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.required_resource_access.RequiredResourceAccess.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.required_resource_access.RequiredResourceAccess.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.required_resource_access.RequiredResourceAccess.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.required_resource_access.RequiredResourceAccess.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.required_resource_access.RequiredResourceAccess.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.required_resource_access.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.required_resource_access.yml new file mode 100644 index 00000000..499150f9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.required_resource_access.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.required_resource_access +name: required_resource_access +fullName: azure.graphrbac.models.required_resource_access +classes: +- azure.graphrbac.models.required_resource_access.RequiredResourceAccess diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.required_resource_access_py3.RequiredResourceAccess.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.required_resource_access_py3.RequiredResourceAccess.yml new file mode 100644 index 00000000..ce1b4b89 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.required_resource_access_py3.RequiredResourceAccess.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.required_resource_access_py3.RequiredResourceAccess +name: RequiredResourceAccess +fullName: azure.graphrbac.models.required_resource_access_py3.RequiredResourceAccess +module: azure.graphrbac.models.required_resource_access_py3 +summary: 'Specifies the set of OAuth 2.0 permission scopes and app roles under the + + specified resource that an application requires access to. The specified + + OAuth 2.0 permission scopes may be requested by client applications + + (through the requiredResourceAccess collection) when calling a resource + + application. The requiredResourceAccess property of the Application entity + + is a collection of RequiredResourceAccess. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RequiredResourceAccess(*, resource_access, additional_properties=None, + resource_app_id: str = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: resource_access + description: 'Required. The list of OAuth2.0 permission scopes + + and app roles that the application requires from the specified resource.' + isRequired: true + types: + - [] + - name: resource_app_id + description: 'The unique identifier for the resource that the + + application requires access to. This should be equal to the appId declared + + on the target resource application.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: resource_access + isRequired: true + - name: additional_properties + isRequired: true + - name: resource_app_id + isRequired: true +methods: +- uid: azure.graphrbac.models.required_resource_access_py3.RequiredResourceAccess.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.required_resource_access_py3.RequiredResourceAccess.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.required_resource_access_py3.RequiredResourceAccess.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.required_resource_access_py3.RequiredResourceAccess.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.required_resource_access_py3.RequiredResourceAccess.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.required_resource_access_py3.RequiredResourceAccess.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.required_resource_access_py3.RequiredResourceAccess.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.required_resource_access_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.required_resource_access_py3.yml new file mode 100644 index 00000000..719d0d26 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.required_resource_access_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.required_resource_access_py3 +name: required_resource_access_py3 +fullName: azure.graphrbac.models.required_resource_access_py3 +classes: +- azure.graphrbac.models.required_resource_access_py3.RequiredResourceAccess diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.resource_access.ResourceAccess.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.resource_access.ResourceAccess.yml new file mode 100644 index 00000000..b41f54d5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.resource_access.ResourceAccess.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.resource_access.ResourceAccess +name: ResourceAccess +fullName: azure.graphrbac.models.resource_access.ResourceAccess +module: azure.graphrbac.models.resource_access +summary: 'Specifies an OAuth 2.0 permission scope or an app role that an application + + requires. The resourceAccess property of the RequiredResourceAccess type is + + a collection of ResourceAccess. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ResourceAccess(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: id + description: 'Required. The unique identifier for one of the OAuth2Permission + + or AppRole instances that the resource application exposes.' + isRequired: true + types: + - + - name: type + description: 'Specifies whether the id property references an + + OAuth2Permission or an AppRole. Possible values are "scope" or "role".' + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.resource_access.ResourceAccess.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.resource_access.ResourceAccess.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.resource_access.ResourceAccess.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.resource_access.ResourceAccess.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.resource_access.ResourceAccess.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.resource_access.ResourceAccess.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.resource_access.ResourceAccess.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.resource_access.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.resource_access.yml new file mode 100644 index 00000000..589deaa0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.resource_access.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.resource_access +name: resource_access +fullName: azure.graphrbac.models.resource_access +classes: +- azure.graphrbac.models.resource_access.ResourceAccess diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.resource_access_py3.ResourceAccess.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.resource_access_py3.ResourceAccess.yml new file mode 100644 index 00000000..546a643e --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.resource_access_py3.ResourceAccess.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.resource_access_py3.ResourceAccess +name: ResourceAccess +fullName: azure.graphrbac.models.resource_access_py3.ResourceAccess +module: azure.graphrbac.models.resource_access_py3 +summary: 'Specifies an OAuth 2.0 permission scope or an app role that an application + + requires. The resourceAccess property of the RequiredResourceAccess type is + + a collection of ResourceAccess. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ResourceAccess(*, id: str, additional_properties=None, type: str = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: id + description: 'Required. The unique identifier for one of the OAuth2Permission + + or AppRole instances that the resource application exposes.' + isRequired: true + types: + - + - name: type + description: 'Specifies whether the id property references an + + OAuth2Permission or an AppRole. Possible values are "scope" or "role".' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: additional_properties + isRequired: true + - name: type + isRequired: true +methods: +- uid: azure.graphrbac.models.resource_access_py3.ResourceAccess.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.resource_access_py3.ResourceAccess.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.resource_access_py3.ResourceAccess.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.resource_access_py3.ResourceAccess.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.resource_access_py3.ResourceAccess.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.resource_access_py3.ResourceAccess.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.resource_access_py3.ResourceAccess.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.resource_access_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.resource_access_py3.yml new file mode 100644 index 00000000..47d07dd9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.resource_access_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.resource_access_py3 +name: resource_access_py3 +fullName: azure.graphrbac.models.resource_access_py3 +classes: +- azure.graphrbac.models.resource_access_py3.ResourceAccess diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal.ServicePrincipal.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal.ServicePrincipal.yml new file mode 100644 index 00000000..8172707f --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal.ServicePrincipal.yml @@ -0,0 +1,281 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.service_principal.ServicePrincipal +name: ServicePrincipal +fullName: azure.graphrbac.models.service_principal.ServicePrincipal +module: azure.graphrbac.models.service_principal +summary: 'Active Directory service principal information. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ServicePrincipal(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: object_type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: account_enabled + description: 'whether or not the service principal account is + + enabled' + isRequired: true + types: + - + - name: alternative_names + description: alternative names + isRequired: true + types: + - [] + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: app_role_assignment_required + description: 'Specifies whether an + + AppRoleAssignment to a user or group is required before Azure AD will + + issue a user or access token to the application.' + isRequired: true + types: + - + - name: app_roles + description: 'The collection of application roles that an application + + may declare. These roles can be assigned to users, groups or service + + principals.' + isRequired: true + types: + - [] + - name: display_name + description: The display name of the service principal. + isRequired: true + types: + - + - name: error_url + description: 'A URL provided by the author of the associated + + application to report errors when using the application.' + isRequired: true + types: + - + - name: homepage + description: The URL to the homepage of the associated application. + isRequired: true + types: + - + - name: key_credentials + description: 'The collection of key credentials associated with + + the service principal.' + isRequired: true + types: + - [] + - name: logout_url + description: 'A URL provided by the author of the associated + + application to logout' + isRequired: true + types: + - + - name: password_credentials + description: 'The collection of password credentials + + associated with the service principal.' + isRequired: true + types: + - [] + - name: preferred_token_signing_key_thumbprint + description: 'The thumbprint of preferred + + certificate to sign the token' + isRequired: true + types: + - + - name: publisher_name + description: The publisher's name of the associated application + isRequired: true + types: + - + - name: reply_urls + description: 'The URLs that user tokens are sent to for sign in with + + the associated application. The redirect URIs that the oAuth 2.0 + + authorization code and access tokens are sent to for the associated + + application.' + isRequired: true + types: + - [] + - name: saml_metadata_url + description: 'The URL to the SAML metadata of the associated + + application' + isRequired: true + types: + - + - name: service_principal_names + description: A collection of service principal names. + isRequired: true + types: + - [] + - name: service_principal_type + description: the type of the service principal + isRequired: true + types: + - + - name: tags + description: 'Optional list of tags that you can apply to your service + + principals. Not nullable.' + isRequired: true + types: + - [] +variables: +- description: The object ID. + name: object_id + types: + - +- description: 'The time at which the directory object was + + deleted.' + name: deletion_timestamp + types: + - +- description: 'The display name exposed by the associated + + application.' + name: app_display_name + types: + - +- name: app_owner_tenant_id + types: + - +- description: 'The OAuth 2.0 permissions exposed by the + + associated application.' + name: oauth2_permissions + types: + - [] +methods: +- uid: azure.graphrbac.models.service_principal.ServicePrincipal.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.service_principal.ServicePrincipal.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.service_principal.ServicePrincipal.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.service_principal.ServicePrincipal.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.service_principal.ServicePrincipal.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.service_principal.ServicePrincipal.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.service_principal.ServicePrincipal.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal.yml new file mode 100644 index 00000000..728a7b2c --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.service_principal +name: service_principal +fullName: azure.graphrbac.models.service_principal +classes: +- azure.graphrbac.models.service_principal.ServicePrincipal diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_base.ServicePrincipalBase.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_base.ServicePrincipalBase.yml new file mode 100644 index 00000000..b30eb49a --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_base.ServicePrincipalBase.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.service_principal_base.ServicePrincipalBase +name: ServicePrincipalBase +fullName: azure.graphrbac.models.service_principal_base.ServicePrincipalBase +module: azure.graphrbac.models.service_principal_base +summary: 'Active Directory service principal common properties shared among GET, POST + + and PATCH.' +constructor: + syntax: ServicePrincipalBase(**kwargs) + parameters: + - name: account_enabled + description: 'whether or not the service principal account is + + enabled' + isRequired: true + types: + - + - name: app_role_assignment_required + description: 'Specifies whether an + + AppRoleAssignment to a user or group is required before Azure AD will + + issue a user or access token to the application.' + isRequired: true + types: + - + - name: key_credentials + description: 'The collection of key credentials associated with + + the service principal.' + isRequired: true + types: + - [] + - name: password_credentials + description: 'The collection of password credentials + + associated with the service principal.' + isRequired: true + types: + - [] + - name: service_principal_type + description: the type of the service principal + isRequired: true + types: + - + - name: tags + description: 'Optional list of tags that you can apply to your service + + principals. Not nullable.' + isRequired: true + types: + - [] +methods: +- uid: azure.graphrbac.models.service_principal_base.ServicePrincipalBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.service_principal_base.ServicePrincipalBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.service_principal_base.ServicePrincipalBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.service_principal_base.ServicePrincipalBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.service_principal_base.ServicePrincipalBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.service_principal_base.ServicePrincipalBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.service_principal_base.ServicePrincipalBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_base.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_base.yml new file mode 100644 index 00000000..ad39071a --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_base.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.service_principal_base +name: service_principal_base +fullName: azure.graphrbac.models.service_principal_base +classes: +- azure.graphrbac.models.service_principal_base.ServicePrincipalBase diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_base_py3.ServicePrincipalBase.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_base_py3.ServicePrincipalBase.yml new file mode 100644 index 00000000..805d3a7e --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_base_py3.ServicePrincipalBase.yml @@ -0,0 +1,174 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.service_principal_base_py3.ServicePrincipalBase +name: ServicePrincipalBase +fullName: azure.graphrbac.models.service_principal_base_py3.ServicePrincipalBase +module: azure.graphrbac.models.service_principal_base_py3 +summary: 'Active Directory service principal common properties shared among GET, POST + + and PATCH.' +constructor: + syntax: 'ServicePrincipalBase(*, account_enabled: bool = None, app_role_assignment_required: + bool = None, key_credentials=None, password_credentials=None, service_principal_type: + str = None, tags=None, **kwargs)' + parameters: + - name: account_enabled + description: 'whether or not the service principal account is + + enabled' + isRequired: true + types: + - + - name: app_role_assignment_required + description: 'Specifies whether an + + AppRoleAssignment to a user or group is required before Azure AD will + + issue a user or access token to the application.' + isRequired: true + types: + - + - name: key_credentials + description: 'The collection of key credentials associated with + + the service principal.' + isRequired: true + types: + - [] + - name: password_credentials + description: 'The collection of password credentials + + associated with the service principal.' + isRequired: true + types: + - [] + - name: service_principal_type + description: the type of the service principal + isRequired: true + types: + - + - name: tags + description: 'Optional list of tags that you can apply to your service + + principals. Not nullable.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: account_enabled + isRequired: true + - name: app_role_assignment_required + isRequired: true + - name: key_credentials + isRequired: true + - name: password_credentials + isRequired: true + - name: service_principal_type + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.graphrbac.models.service_principal_base_py3.ServicePrincipalBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.service_principal_base_py3.ServicePrincipalBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.service_principal_base_py3.ServicePrincipalBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.service_principal_base_py3.ServicePrincipalBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.service_principal_base_py3.ServicePrincipalBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.service_principal_base_py3.ServicePrincipalBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.service_principal_base_py3.ServicePrincipalBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_base_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_base_py3.yml new file mode 100644 index 00000000..29dd3306 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_base_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.service_principal_base_py3 +name: service_principal_base_py3 +fullName: azure.graphrbac.models.service_principal_base_py3 +classes: +- azure.graphrbac.models.service_principal_base_py3.ServicePrincipalBase diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_create_parameters.ServicePrincipalCreateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_create_parameters.ServicePrincipalCreateParameters.yml new file mode 100644 index 00000000..b7fdfba7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_create_parameters.ServicePrincipalCreateParameters.yml @@ -0,0 +1,165 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.service_principal_create_parameters.ServicePrincipalCreateParameters +name: ServicePrincipalCreateParameters +fullName: azure.graphrbac.models.service_principal_create_parameters.ServicePrincipalCreateParameters +module: azure.graphrbac.models.service_principal_create_parameters +summary: 'Request parameters for creating a new service principal. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ServicePrincipalCreateParameters(**kwargs) + parameters: + - name: account_enabled + description: 'whether or not the service principal account is + + enabled' + isRequired: true + types: + - + - name: app_role_assignment_required + description: 'Specifies whether an + + AppRoleAssignment to a user or group is required before Azure AD will + + issue a user or access token to the application.' + isRequired: true + types: + - + - name: key_credentials + description: 'The collection of key credentials associated with + + the service principal.' + isRequired: true + types: + - [] + - name: password_credentials + description: 'The collection of password credentials + + associated with the service principal.' + isRequired: true + types: + - [] + - name: service_principal_type + description: the type of the service principal + isRequired: true + types: + - + - name: tags + description: 'Optional list of tags that you can apply to your service + + principals. Not nullable.' + isRequired: true + types: + - [] + - name: app_id + description: Required. The application ID. + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.service_principal_create_parameters.ServicePrincipalCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.service_principal_create_parameters.ServicePrincipalCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.service_principal_create_parameters.ServicePrincipalCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.service_principal_create_parameters.ServicePrincipalCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.service_principal_create_parameters.ServicePrincipalCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.service_principal_create_parameters.ServicePrincipalCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.service_principal_create_parameters.ServicePrincipalCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_create_parameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_create_parameters.yml new file mode 100644 index 00000000..bcdd39da --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_create_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.service_principal_create_parameters +name: service_principal_create_parameters +fullName: azure.graphrbac.models.service_principal_create_parameters +classes: +- azure.graphrbac.models.service_principal_create_parameters.ServicePrincipalCreateParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_create_parameters_py3.ServicePrincipalCreateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_create_parameters_py3.ServicePrincipalCreateParameters.yml new file mode 100644 index 00000000..fb038bed --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_create_parameters_py3.ServicePrincipalCreateParameters.yml @@ -0,0 +1,182 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.service_principal_create_parameters_py3.ServicePrincipalCreateParameters +name: ServicePrincipalCreateParameters +fullName: azure.graphrbac.models.service_principal_create_parameters_py3.ServicePrincipalCreateParameters +module: azure.graphrbac.models.service_principal_create_parameters_py3 +summary: 'Request parameters for creating a new service principal. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ServicePrincipalCreateParameters(*, app_id: str, account_enabled: bool + = None, app_role_assignment_required: bool = None, key_credentials=None, password_credentials=None, + service_principal_type: str = None, tags=None, **kwargs)' + parameters: + - name: account_enabled + description: 'whether or not the service principal account is + + enabled' + isRequired: true + types: + - + - name: app_role_assignment_required + description: 'Specifies whether an + + AppRoleAssignment to a user or group is required before Azure AD will + + issue a user or access token to the application.' + isRequired: true + types: + - + - name: key_credentials + description: 'The collection of key credentials associated with + + the service principal.' + isRequired: true + types: + - [] + - name: password_credentials + description: 'The collection of password credentials + + associated with the service principal.' + isRequired: true + types: + - [] + - name: service_principal_type + description: the type of the service principal + isRequired: true + types: + - + - name: tags + description: 'Optional list of tags that you can apply to your service + + principals. Not nullable.' + isRequired: true + types: + - [] + - name: app_id + description: Required. The application ID. + isRequired: true + types: + - + keywordOnlyParameters: + - name: app_id + isRequired: true + - name: account_enabled + isRequired: true + - name: app_role_assignment_required + isRequired: true + - name: key_credentials + isRequired: true + - name: password_credentials + isRequired: true + - name: service_principal_type + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.graphrbac.models.service_principal_create_parameters_py3.ServicePrincipalCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.service_principal_create_parameters_py3.ServicePrincipalCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.service_principal_create_parameters_py3.ServicePrincipalCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.service_principal_create_parameters_py3.ServicePrincipalCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.service_principal_create_parameters_py3.ServicePrincipalCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.service_principal_create_parameters_py3.ServicePrincipalCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.service_principal_create_parameters_py3.ServicePrincipalCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_create_parameters_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_create_parameters_py3.yml new file mode 100644 index 00000000..d0ea61cf --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_create_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.service_principal_create_parameters_py3 +name: service_principal_create_parameters_py3 +fullName: azure.graphrbac.models.service_principal_create_parameters_py3 +classes: +- azure.graphrbac.models.service_principal_create_parameters_py3.ServicePrincipalCreateParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_object_result.ServicePrincipalObjectResult.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_object_result.ServicePrincipalObjectResult.yml new file mode 100644 index 00000000..c8bb4f1d --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_object_result.ServicePrincipalObjectResult.yml @@ -0,0 +1,127 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.service_principal_object_result.ServicePrincipalObjectResult +name: ServicePrincipalObjectResult +fullName: azure.graphrbac.models.service_principal_object_result.ServicePrincipalObjectResult +module: azure.graphrbac.models.service_principal_object_result +summary: Service Principal Object Result. +constructor: + syntax: ServicePrincipalObjectResult(**kwargs) + parameters: + - name: value + description: 'The Object ID of the service principal with the specified + + application ID.' + isRequired: true + types: + - + - name: odatametadata + description: The URL representing edm equivalent. + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.service_principal_object_result.ServicePrincipalObjectResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.service_principal_object_result.ServicePrincipalObjectResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.service_principal_object_result.ServicePrincipalObjectResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.service_principal_object_result.ServicePrincipalObjectResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.service_principal_object_result.ServicePrincipalObjectResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.service_principal_object_result.ServicePrincipalObjectResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.service_principal_object_result.ServicePrincipalObjectResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_object_result.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_object_result.yml new file mode 100644 index 00000000..f4ddbfa1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_object_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.service_principal_object_result +name: service_principal_object_result +fullName: azure.graphrbac.models.service_principal_object_result +classes: +- azure.graphrbac.models.service_principal_object_result.ServicePrincipalObjectResult diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_object_result_py3.ServicePrincipalObjectResult.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_object_result_py3.ServicePrincipalObjectResult.yml new file mode 100644 index 00000000..9ea72319 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_object_result_py3.ServicePrincipalObjectResult.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.service_principal_object_result_py3.ServicePrincipalObjectResult +name: ServicePrincipalObjectResult +fullName: azure.graphrbac.models.service_principal_object_result_py3.ServicePrincipalObjectResult +module: azure.graphrbac.models.service_principal_object_result_py3 +summary: Service Principal Object Result. +constructor: + syntax: 'ServicePrincipalObjectResult(*, value: str = None, odatametadata: str = + None, **kwargs)' + parameters: + - name: value + description: 'The Object ID of the service principal with the specified + + application ID.' + isRequired: true + types: + - + - name: odatametadata + description: The URL representing edm equivalent. + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: odatametadata + isRequired: true +methods: +- uid: azure.graphrbac.models.service_principal_object_result_py3.ServicePrincipalObjectResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.service_principal_object_result_py3.ServicePrincipalObjectResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.service_principal_object_result_py3.ServicePrincipalObjectResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.service_principal_object_result_py3.ServicePrincipalObjectResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.service_principal_object_result_py3.ServicePrincipalObjectResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.service_principal_object_result_py3.ServicePrincipalObjectResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.service_principal_object_result_py3.ServicePrincipalObjectResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_object_result_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_object_result_py3.yml new file mode 100644 index 00000000..04ce3c2f --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_object_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.service_principal_object_result_py3 +name: service_principal_object_result_py3 +fullName: azure.graphrbac.models.service_principal_object_result_py3 +classes: +- azure.graphrbac.models.service_principal_object_result_py3.ServicePrincipalObjectResult diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_paged.ServicePrincipalPaged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_paged.ServicePrincipalPaged.yml new file mode 100644 index 00000000..5fb1b4b7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_paged.ServicePrincipalPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.service_principal_paged.ServicePrincipalPaged +name: ServicePrincipalPaged +fullName: azure.graphrbac.models.service_principal_paged.ServicePrincipalPaged +module: azure.graphrbac.models.service_principal_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: ServicePrincipalPaged(*args, **kwargs) +methods: +- uid: azure.graphrbac.models.service_principal_paged.ServicePrincipalPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.graphrbac.models.service_principal_paged.ServicePrincipalPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.graphrbac.models.service_principal_paged.ServicePrincipalPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.service_principal_paged.ServicePrincipalPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.service_principal_paged.ServicePrincipalPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.graphrbac.models.service_principal_paged.ServicePrincipalPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.graphrbac.models.service_principal_paged.ServicePrincipalPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_paged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_paged.yml new file mode 100644 index 00000000..2b2914eb --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.service_principal_paged +name: service_principal_paged +fullName: azure.graphrbac.models.service_principal_paged +classes: +- azure.graphrbac.models.service_principal_paged.ServicePrincipalPaged diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_py3.ServicePrincipal.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_py3.ServicePrincipal.yml new file mode 100644 index 00000000..0fecd73f --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_py3.ServicePrincipal.yml @@ -0,0 +1,326 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.service_principal_py3.ServicePrincipal +name: ServicePrincipal +fullName: azure.graphrbac.models.service_principal_py3.ServicePrincipal +module: azure.graphrbac.models.service_principal_py3 +summary: 'Active Directory service principal information. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ServicePrincipal(*, additional_properties=None, account_enabled: bool = + None, alternative_names=None, app_id: str = None, app_role_assignment_required: + bool = None, app_roles=None, display_name: str = None, error_url: str = None, + homepage: str = None, key_credentials=None, logout_url: str = None, password_credentials=None, + preferred_token_signing_key_thumbprint: str = None, publisher_name: str = None, + reply_urls=None, saml_metadata_url: str = None, service_principal_names=None, + service_principal_type: str = None, tags=None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: object_type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: account_enabled + description: 'whether or not the service principal account is + + enabled' + isRequired: true + types: + - + - name: alternative_names + description: alternative names + isRequired: true + types: + - [] + - name: app_id + description: The application ID. + isRequired: true + types: + - + - name: app_role_assignment_required + description: 'Specifies whether an + + AppRoleAssignment to a user or group is required before Azure AD will + + issue a user or access token to the application.' + isRequired: true + types: + - + - name: app_roles + description: 'The collection of application roles that an application + + may declare. These roles can be assigned to users, groups or service + + principals.' + isRequired: true + types: + - [] + - name: display_name + description: The display name of the service principal. + isRequired: true + types: + - + - name: error_url + description: 'A URL provided by the author of the associated + + application to report errors when using the application.' + isRequired: true + types: + - + - name: homepage + description: The URL to the homepage of the associated application. + isRequired: true + types: + - + - name: key_credentials + description: 'The collection of key credentials associated with + + the service principal.' + isRequired: true + types: + - [] + - name: logout_url + description: 'A URL provided by the author of the associated + + application to logout' + isRequired: true + types: + - + - name: password_credentials + description: 'The collection of password credentials + + associated with the service principal.' + isRequired: true + types: + - [] + - name: preferred_token_signing_key_thumbprint + description: 'The thumbprint of preferred + + certificate to sign the token' + isRequired: true + types: + - + - name: publisher_name + description: The publisher's name of the associated application + isRequired: true + types: + - + - name: reply_urls + description: 'The URLs that user tokens are sent to for sign in with + + the associated application. The redirect URIs that the oAuth 2.0 + + authorization code and access tokens are sent to for the associated + + application.' + isRequired: true + types: + - [] + - name: saml_metadata_url + description: 'The URL to the SAML metadata of the associated + + application' + isRequired: true + types: + - + - name: service_principal_names + description: A collection of service principal names. + isRequired: true + types: + - [] + - name: service_principal_type + description: the type of the service principal + isRequired: true + types: + - + - name: tags + description: 'Optional list of tags that you can apply to your service + + principals. Not nullable.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: account_enabled + isRequired: true + - name: alternative_names + isRequired: true + - name: app_id + isRequired: true + - name: app_role_assignment_required + isRequired: true + - name: app_roles + isRequired: true + - name: display_name + isRequired: true + - name: error_url + isRequired: true + - name: homepage + isRequired: true + - name: key_credentials + isRequired: true + - name: logout_url + isRequired: true + - name: password_credentials + isRequired: true + - name: preferred_token_signing_key_thumbprint + isRequired: true + - name: publisher_name + isRequired: true + - name: reply_urls + isRequired: true + - name: saml_metadata_url + isRequired: true + - name: service_principal_names + isRequired: true + - name: service_principal_type + isRequired: true + - name: tags + isRequired: true +variables: +- description: The object ID. + name: object_id + types: + - +- description: 'The time at which the directory object was + + deleted.' + name: deletion_timestamp + types: + - +- description: 'The display name exposed by the associated + + application.' + name: app_display_name + types: + - +- name: app_owner_tenant_id + types: + - +- description: 'The OAuth 2.0 permissions exposed by the + + associated application.' + name: oauth2_permissions + types: + - [] +methods: +- uid: azure.graphrbac.models.service_principal_py3.ServicePrincipal.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.service_principal_py3.ServicePrincipal.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.service_principal_py3.ServicePrincipal.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.service_principal_py3.ServicePrincipal.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.service_principal_py3.ServicePrincipal.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.service_principal_py3.ServicePrincipal.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.service_principal_py3.ServicePrincipal.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_py3.yml new file mode 100644 index 00000000..413b0e46 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.service_principal_py3 +name: service_principal_py3 +fullName: azure.graphrbac.models.service_principal_py3 +classes: +- azure.graphrbac.models.service_principal_py3.ServicePrincipal diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_update_parameters.ServicePrincipalUpdateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_update_parameters.ServicePrincipalUpdateParameters.yml new file mode 100644 index 00000000..c5bfa275 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_update_parameters.ServicePrincipalUpdateParameters.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.service_principal_update_parameters.ServicePrincipalUpdateParameters +name: ServicePrincipalUpdateParameters +fullName: azure.graphrbac.models.service_principal_update_parameters.ServicePrincipalUpdateParameters +module: azure.graphrbac.models.service_principal_update_parameters +summary: Request parameters for update an existing service principal. +constructor: + syntax: ServicePrincipalUpdateParameters(**kwargs) + parameters: + - name: account_enabled + description: 'whether or not the service principal account is + + enabled' + isRequired: true + types: + - + - name: app_role_assignment_required + description: 'Specifies whether an + + AppRoleAssignment to a user or group is required before Azure AD will + + issue a user or access token to the application.' + isRequired: true + types: + - + - name: key_credentials + description: 'The collection of key credentials associated with + + the service principal.' + isRequired: true + types: + - [] + - name: password_credentials + description: 'The collection of password credentials + + associated with the service principal.' + isRequired: true + types: + - [] + - name: service_principal_type + description: the type of the service principal + isRequired: true + types: + - + - name: tags + description: 'Optional list of tags that you can apply to your service + + principals. Not nullable.' + isRequired: true + types: + - [] +methods: +- uid: azure.graphrbac.models.service_principal_update_parameters.ServicePrincipalUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.service_principal_update_parameters.ServicePrincipalUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.service_principal_update_parameters.ServicePrincipalUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.service_principal_update_parameters.ServicePrincipalUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.service_principal_update_parameters.ServicePrincipalUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.service_principal_update_parameters.ServicePrincipalUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.service_principal_update_parameters.ServicePrincipalUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_update_parameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_update_parameters.yml new file mode 100644 index 00000000..bda4b34e --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_update_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.service_principal_update_parameters +name: service_principal_update_parameters +fullName: azure.graphrbac.models.service_principal_update_parameters +classes: +- azure.graphrbac.models.service_principal_update_parameters.ServicePrincipalUpdateParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_update_parameters_py3.ServicePrincipalUpdateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_update_parameters_py3.ServicePrincipalUpdateParameters.yml new file mode 100644 index 00000000..02e72304 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_update_parameters_py3.ServicePrincipalUpdateParameters.yml @@ -0,0 +1,172 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.service_principal_update_parameters_py3.ServicePrincipalUpdateParameters +name: ServicePrincipalUpdateParameters +fullName: azure.graphrbac.models.service_principal_update_parameters_py3.ServicePrincipalUpdateParameters +module: azure.graphrbac.models.service_principal_update_parameters_py3 +summary: Request parameters for update an existing service principal. +constructor: + syntax: 'ServicePrincipalUpdateParameters(*, account_enabled: bool = None, app_role_assignment_required: + bool = None, key_credentials=None, password_credentials=None, service_principal_type: + str = None, tags=None, **kwargs)' + parameters: + - name: account_enabled + description: 'whether or not the service principal account is + + enabled' + isRequired: true + types: + - + - name: app_role_assignment_required + description: 'Specifies whether an + + AppRoleAssignment to a user or group is required before Azure AD will + + issue a user or access token to the application.' + isRequired: true + types: + - + - name: key_credentials + description: 'The collection of key credentials associated with + + the service principal.' + isRequired: true + types: + - [] + - name: password_credentials + description: 'The collection of password credentials + + associated with the service principal.' + isRequired: true + types: + - [] + - name: service_principal_type + description: the type of the service principal + isRequired: true + types: + - + - name: tags + description: 'Optional list of tags that you can apply to your service + + principals. Not nullable.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: account_enabled + isRequired: true + - name: app_role_assignment_required + isRequired: true + - name: key_credentials + isRequired: true + - name: password_credentials + isRequired: true + - name: service_principal_type + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.graphrbac.models.service_principal_update_parameters_py3.ServicePrincipalUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.service_principal_update_parameters_py3.ServicePrincipalUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.service_principal_update_parameters_py3.ServicePrincipalUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.service_principal_update_parameters_py3.ServicePrincipalUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.service_principal_update_parameters_py3.ServicePrincipalUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.service_principal_update_parameters_py3.ServicePrincipalUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.service_principal_update_parameters_py3.ServicePrincipalUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_update_parameters_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_update_parameters_py3.yml new file mode 100644 index 00000000..de1ba9fd --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_update_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.service_principal_update_parameters_py3 +name: service_principal_update_parameters_py3 +fullName: azure.graphrbac.models.service_principal_update_parameters_py3 +classes: +- azure.graphrbac.models.service_principal_update_parameters_py3.ServicePrincipalUpdateParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.sign_in_name.SignInName.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.sign_in_name.SignInName.yml new file mode 100644 index 00000000..570dfa3e --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.sign_in_name.SignInName.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.sign_in_name.SignInName +name: SignInName +fullName: azure.graphrbac.models.sign_in_name.SignInName +module: azure.graphrbac.models.sign_in_name +summary: 'Contains information about a sign-in name of a local account user in an + + Azure Active Directory B2C tenant.' +constructor: + syntax: SignInName(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: type + description: 'A string value that can be used to classify user sign-in + + types in your directory, such as ''emailAddress'' or ''userName''.' + isRequired: true + types: + - + - name: value + description: 'The sign-in used by the local account. Must be unique across + + the company/tenant. For example, ''.' + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.sign_in_name.SignInName.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.sign_in_name.SignInName.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.sign_in_name.SignInName.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.sign_in_name.SignInName.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.sign_in_name.SignInName.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.sign_in_name.SignInName.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.sign_in_name.SignInName.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.sign_in_name.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.sign_in_name.yml new file mode 100644 index 00000000..466da835 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.sign_in_name.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.sign_in_name +name: sign_in_name +fullName: azure.graphrbac.models.sign_in_name +classes: +- azure.graphrbac.models.sign_in_name.SignInName diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.sign_in_name_py3.SignInName.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.sign_in_name_py3.SignInName.yml new file mode 100644 index 00000000..166e6d9c --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.sign_in_name_py3.SignInName.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.sign_in_name_py3.SignInName +name: SignInName +fullName: azure.graphrbac.models.sign_in_name_py3.SignInName +module: azure.graphrbac.models.sign_in_name_py3 +summary: 'Contains information about a sign-in name of a local account user in an + + Azure Active Directory B2C tenant.' +constructor: + syntax: 'SignInName(*, additional_properties=None, type: str = None, value: str + = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: type + description: 'A string value that can be used to classify user sign-in + + types in your directory, such as ''emailAddress'' or ''userName''.' + isRequired: true + types: + - + - name: value + description: 'The sign-in used by the local account. Must be unique across + + the company/tenant. For example, ''.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: type + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.graphrbac.models.sign_in_name_py3.SignInName.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.sign_in_name_py3.SignInName.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.sign_in_name_py3.SignInName.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.sign_in_name_py3.SignInName.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.sign_in_name_py3.SignInName.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.sign_in_name_py3.SignInName.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.sign_in_name_py3.SignInName.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.sign_in_name_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.sign_in_name_py3.yml new file mode 100644 index 00000000..89adc552 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.sign_in_name_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.sign_in_name_py3 +name: sign_in_name_py3 +fullName: azure.graphrbac.models.sign_in_name_py3 +classes: +- azure.graphrbac.models.sign_in_name_py3.SignInName diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.str_paged.StrPaged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.str_paged.StrPaged.yml new file mode 100644 index 00000000..4c323dfa --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.str_paged.StrPaged.yml @@ -0,0 +1,70 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.str_paged.StrPaged +name: StrPaged +fullName: azure.graphrbac.models.str_paged.StrPaged +module: azure.graphrbac.models.str_paged +summary: A paging container for iterating over a list of str object +constructor: + syntax: StrPaged(*args, **kwargs) +methods: +- uid: azure.graphrbac.models.str_paged.StrPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.graphrbac.models.str_paged.StrPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.graphrbac.models.str_paged.StrPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.str_paged.StrPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.str_paged.StrPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.graphrbac.models.str_paged.StrPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.graphrbac.models.str_paged.StrPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.str_paged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.str_paged.yml new file mode 100644 index 00000000..702eed68 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.str_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.str_paged +name: str_paged +fullName: azure.graphrbac.models.str_paged +classes: +- azure.graphrbac.models.str_paged.StrPaged diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user.User.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user.User.yml new file mode 100644 index 00000000..b48fdf88 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user.User.yml @@ -0,0 +1,218 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.user.User +name: User +fullName: azure.graphrbac.models.user.User +module: azure.graphrbac.models.user +summary: 'Active Directory user information. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: User(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: object_type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: immutable_id + description: 'This must be specified if you are using a federated + + domain for the user''s userPrincipalName (UPN) property when creating a new + + user account. It is used to associate an on-premises Active Directory user + + account with their Azure AD user object.' + isRequired: true + types: + - + - name: usage_location + description: 'A two letter country code (ISO standard 3166). + + Required for users that will be assigned licenses due to legal requirement + + to check for availability of services in countries. Examples include: + + "US", "JP", and "GB".' + isRequired: true + types: + - + - name: given_name + description: The given name for the user. + isRequired: true + types: + - + - name: surname + description: The user's surname (family name or last name). + isRequired: true + types: + - + - name: user_type + description: 'A string value that can be used to classify user types + + in your directory, such as ''Member'' and ''Guest''. Possible values include: + + ''Member'', ''Guest''' + isRequired: true + types: + - + - + - name: account_enabled + description: Whether the account is enabled. + isRequired: true + types: + - + - name: display_name + description: The display name of the user. + isRequired: true + types: + - + - name: user_principal_name + description: The principal name of the user. + isRequired: true + types: + - + - name: mail_nickname + description: The mail alias for the user. + isRequired: true + types: + - + - name: mail + description: The primary email address of the user. + isRequired: true + types: + - + - name: sign_in_names + description: The sign-in names of the user. + isRequired: true + types: + - [] +variables: +- description: The object ID. + name: object_id + types: + - +- description: 'The time at which the directory object was + + deleted.' + name: deletion_timestamp + types: + - +methods: +- uid: azure.graphrbac.models.user.User.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.user.User.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.user.User.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.user.User.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.user.User.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.user.User.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.user.User.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user.yml new file mode 100644 index 00000000..682952ea --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.user +name: user +fullName: azure.graphrbac.models.user +classes: +- azure.graphrbac.models.user.User diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_base.UserBase.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_base.UserBase.yml new file mode 100644 index 00000000..1f715126 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_base.UserBase.yml @@ -0,0 +1,164 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.user_base.UserBase +name: UserBase +fullName: azure.graphrbac.models.user_base.UserBase +module: azure.graphrbac.models.user_base +summary: UserBase. +constructor: + syntax: UserBase(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: immutable_id + description: 'This must be specified if you are using a federated + + domain for the user''s userPrincipalName (UPN) property when creating a new + + user account. It is used to associate an on-premises Active Directory user + + account with their Azure AD user object.' + isRequired: true + types: + - + - name: usage_location + description: 'A two letter country code (ISO standard 3166). + + Required for users that will be assigned licenses due to legal requirement + + to check for availability of services in countries. Examples include: + + "US", "JP", and "GB".' + isRequired: true + types: + - + - name: given_name + description: The given name for the user. + isRequired: true + types: + - + - name: surname + description: The user's surname (family name or last name). + isRequired: true + types: + - + - name: user_type + description: 'A string value that can be used to classify user types + + in your directory, such as ''Member'' and ''Guest''. Possible values include: + + ''Member'', ''Guest''' + isRequired: true + types: + - + - +methods: +- uid: azure.graphrbac.models.user_base.UserBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.user_base.UserBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.user_base.UserBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.user_base.UserBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.user_base.UserBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.user_base.UserBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.user_base.UserBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_base.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_base.yml new file mode 100644 index 00000000..44dfef56 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_base.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.user_base +name: user_base +fullName: azure.graphrbac.models.user_base +classes: +- azure.graphrbac.models.user_base.UserBase diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_base_py3.UserBase.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_base_py3.UserBase.yml new file mode 100644 index 00000000..a1815086 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_base_py3.UserBase.yml @@ -0,0 +1,178 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.user_base_py3.UserBase +name: UserBase +fullName: azure.graphrbac.models.user_base_py3.UserBase +module: azure.graphrbac.models.user_base_py3 +summary: UserBase. +constructor: + syntax: 'UserBase(*, additional_properties=None, immutable_id: str = None, usage_location: + str = None, given_name: str = None, surname: str = None, user_type=None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: immutable_id + description: 'This must be specified if you are using a federated + + domain for the user''s userPrincipalName (UPN) property when creating a new + + user account. It is used to associate an on-premises Active Directory user + + account with their Azure AD user object.' + isRequired: true + types: + - + - name: usage_location + description: 'A two letter country code (ISO standard 3166). + + Required for users that will be assigned licenses due to legal requirement + + to check for availability of services in countries. Examples include: + + "US", "JP", and "GB".' + isRequired: true + types: + - + - name: given_name + description: The given name for the user. + isRequired: true + types: + - + - name: surname + description: The user's surname (family name or last name). + isRequired: true + types: + - + - name: user_type + description: 'A string value that can be used to classify user types + + in your directory, such as ''Member'' and ''Guest''. Possible values include: + + ''Member'', ''Guest''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: immutable_id + isRequired: true + - name: usage_location + isRequired: true + - name: given_name + isRequired: true + - name: surname + isRequired: true + - name: user_type + isRequired: true +methods: +- uid: azure.graphrbac.models.user_base_py3.UserBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.user_base_py3.UserBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.user_base_py3.UserBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.user_base_py3.UserBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.user_base_py3.UserBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.user_base_py3.UserBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.user_base_py3.UserBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_base_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_base_py3.yml new file mode 100644 index 00000000..0c5a38cb --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_base_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.user_base_py3 +name: user_base_py3 +fullName: azure.graphrbac.models.user_base_py3 +classes: +- azure.graphrbac.models.user_base_py3.UserBase diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_create_parameters.UserCreateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_create_parameters.UserCreateParameters.yml new file mode 100644 index 00000000..09ab250b --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_create_parameters.UserCreateParameters.yml @@ -0,0 +1,202 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.user_create_parameters.UserCreateParameters +name: UserCreateParameters +fullName: azure.graphrbac.models.user_create_parameters.UserCreateParameters +module: azure.graphrbac.models.user_create_parameters +summary: 'Request parameters for creating a new work or school account user. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: UserCreateParameters(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: immutable_id + description: 'This must be specified if you are using a federated + + domain for the user''s userPrincipalName (UPN) property when creating a new + + user account. It is used to associate an on-premises Active Directory user + + account with their Azure AD user object.' + isRequired: true + types: + - + - name: usage_location + description: 'A two letter country code (ISO standard 3166). + + Required for users that will be assigned licenses due to legal requirement + + to check for availability of services in countries. Examples include: + + "US", "JP", and "GB".' + isRequired: true + types: + - + - name: given_name + description: The given name for the user. + isRequired: true + types: + - + - name: surname + description: The user's surname (family name or last name). + isRequired: true + types: + - + - name: user_type + description: 'A string value that can be used to classify user types + + in your directory, such as ''Member'' and ''Guest''. Possible values include: + + ''Member'', ''Guest''' + isRequired: true + types: + - + - + - name: account_enabled + description: Required. Whether the account is enabled. + isRequired: true + types: + - + - name: display_name + description: Required. The display name of the user. + isRequired: true + types: + - + - name: password_profile + description: Required. Password Profile + isRequired: true + types: + - + - name: user_principal_name + description: 'Required. The user principal name + + (). It must contain one of the verified domains + for + + the tenant.' + isRequired: true + types: + - + - name: mail_nickname + description: Required. The mail alias for the user. + isRequired: true + types: + - + - name: mail + description: The primary email address of the user. + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.user_create_parameters.UserCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.user_create_parameters.UserCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.user_create_parameters.UserCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.user_create_parameters.UserCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.user_create_parameters.UserCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.user_create_parameters.UserCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.user_create_parameters.UserCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_create_parameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_create_parameters.yml new file mode 100644 index 00000000..d11804fb --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_create_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.user_create_parameters +name: user_create_parameters +fullName: azure.graphrbac.models.user_create_parameters +classes: +- azure.graphrbac.models.user_create_parameters.UserCreateParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_create_parameters_py3.UserCreateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_create_parameters_py3.UserCreateParameters.yml new file mode 100644 index 00000000..00201a43 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_create_parameters_py3.UserCreateParameters.yml @@ -0,0 +1,230 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.user_create_parameters_py3.UserCreateParameters +name: UserCreateParameters +fullName: azure.graphrbac.models.user_create_parameters_py3.UserCreateParameters +module: azure.graphrbac.models.user_create_parameters_py3 +summary: 'Request parameters for creating a new work or school account user. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'UserCreateParameters(*, account_enabled: bool, display_name: str, password_profile, + user_principal_name: str, mail_nickname: str, additional_properties=None, immutable_id: + str = None, usage_location: str = None, given_name: str = None, surname: str = + None, user_type=None, mail: str = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: immutable_id + description: 'This must be specified if you are using a federated + + domain for the user''s userPrincipalName (UPN) property when creating a new + + user account. It is used to associate an on-premises Active Directory user + + account with their Azure AD user object.' + isRequired: true + types: + - + - name: usage_location + description: 'A two letter country code (ISO standard 3166). + + Required for users that will be assigned licenses due to legal requirement + + to check for availability of services in countries. Examples include: + + "US", "JP", and "GB".' + isRequired: true + types: + - + - name: given_name + description: The given name for the user. + isRequired: true + types: + - + - name: surname + description: The user's surname (family name or last name). + isRequired: true + types: + - + - name: user_type + description: 'A string value that can be used to classify user types + + in your directory, such as ''Member'' and ''Guest''. Possible values include: + + ''Member'', ''Guest''' + isRequired: true + types: + - + - + - name: account_enabled + description: Required. Whether the account is enabled. + isRequired: true + types: + - + - name: display_name + description: Required. The display name of the user. + isRequired: true + types: + - + - name: password_profile + description: Required. Password Profile + isRequired: true + types: + - + - name: user_principal_name + description: 'Required. The user principal name + + (). It must contain one of the verified domains + for + + the tenant.' + isRequired: true + types: + - + - name: mail_nickname + description: Required. The mail alias for the user. + isRequired: true + types: + - + - name: mail + description: The primary email address of the user. + isRequired: true + types: + - + keywordOnlyParameters: + - name: account_enabled + isRequired: true + - name: display_name + isRequired: true + - name: password_profile + isRequired: true + - name: user_principal_name + isRequired: true + - name: mail_nickname + isRequired: true + - name: additional_properties + isRequired: true + - name: immutable_id + isRequired: true + - name: usage_location + isRequired: true + - name: given_name + isRequired: true + - name: surname + isRequired: true + - name: user_type + isRequired: true + - name: mail + isRequired: true +methods: +- uid: azure.graphrbac.models.user_create_parameters_py3.UserCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.user_create_parameters_py3.UserCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.user_create_parameters_py3.UserCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.user_create_parameters_py3.UserCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.user_create_parameters_py3.UserCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.user_create_parameters_py3.UserCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.user_create_parameters_py3.UserCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_create_parameters_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_create_parameters_py3.yml new file mode 100644 index 00000000..087381d5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_create_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.user_create_parameters_py3 +name: user_create_parameters_py3 +fullName: azure.graphrbac.models.user_create_parameters_py3 +classes: +- azure.graphrbac.models.user_create_parameters_py3.UserCreateParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_get_member_groups_parameters.UserGetMemberGroupsParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_get_member_groups_parameters.UserGetMemberGroupsParameters.yml new file mode 100644 index 00000000..406e27fb --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_get_member_groups_parameters.UserGetMemberGroupsParameters.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.user_get_member_groups_parameters.UserGetMemberGroupsParameters +name: UserGetMemberGroupsParameters +fullName: azure.graphrbac.models.user_get_member_groups_parameters.UserGetMemberGroupsParameters +module: azure.graphrbac.models.user_get_member_groups_parameters +summary: 'Request parameters for GetMemberGroups API call. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: UserGetMemberGroupsParameters(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: security_enabled_only + description: 'Required. If true, only membership in + + security-enabled groups should be checked. Otherwise, membership in all + + groups should be checked.' + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.user_get_member_groups_parameters.UserGetMemberGroupsParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.user_get_member_groups_parameters.UserGetMemberGroupsParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.user_get_member_groups_parameters.UserGetMemberGroupsParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.user_get_member_groups_parameters.UserGetMemberGroupsParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.user_get_member_groups_parameters.UserGetMemberGroupsParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.user_get_member_groups_parameters.UserGetMemberGroupsParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.user_get_member_groups_parameters.UserGetMemberGroupsParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_get_member_groups_parameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_get_member_groups_parameters.yml new file mode 100644 index 00000000..396f5fe7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_get_member_groups_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.user_get_member_groups_parameters +name: user_get_member_groups_parameters +fullName: azure.graphrbac.models.user_get_member_groups_parameters +classes: +- azure.graphrbac.models.user_get_member_groups_parameters.UserGetMemberGroupsParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_get_member_groups_parameters_py3.UserGetMemberGroupsParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_get_member_groups_parameters_py3.UserGetMemberGroupsParameters.yml new file mode 100644 index 00000000..63445718 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_get_member_groups_parameters_py3.UserGetMemberGroupsParameters.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.user_get_member_groups_parameters_py3.UserGetMemberGroupsParameters +name: UserGetMemberGroupsParameters +fullName: azure.graphrbac.models.user_get_member_groups_parameters_py3.UserGetMemberGroupsParameters +module: azure.graphrbac.models.user_get_member_groups_parameters_py3 +summary: 'Request parameters for GetMemberGroups API call. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'UserGetMemberGroupsParameters(*, security_enabled_only: bool, additional_properties=None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: security_enabled_only + description: 'Required. If true, only membership in + + security-enabled groups should be checked. Otherwise, membership in all + + groups should be checked.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: security_enabled_only + isRequired: true + - name: additional_properties + isRequired: true +methods: +- uid: azure.graphrbac.models.user_get_member_groups_parameters_py3.UserGetMemberGroupsParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.user_get_member_groups_parameters_py3.UserGetMemberGroupsParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.user_get_member_groups_parameters_py3.UserGetMemberGroupsParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.user_get_member_groups_parameters_py3.UserGetMemberGroupsParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.user_get_member_groups_parameters_py3.UserGetMemberGroupsParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.user_get_member_groups_parameters_py3.UserGetMemberGroupsParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.user_get_member_groups_parameters_py3.UserGetMemberGroupsParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_get_member_groups_parameters_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_get_member_groups_parameters_py3.yml new file mode 100644 index 00000000..e74b5905 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_get_member_groups_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.user_get_member_groups_parameters_py3 +name: user_get_member_groups_parameters_py3 +fullName: azure.graphrbac.models.user_get_member_groups_parameters_py3 +classes: +- azure.graphrbac.models.user_get_member_groups_parameters_py3.UserGetMemberGroupsParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_paged.UserPaged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_paged.UserPaged.yml new file mode 100644 index 00000000..742524ec --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_paged.UserPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.user_paged.UserPaged +name: UserPaged +fullName: azure.graphrbac.models.user_paged.UserPaged +module: azure.graphrbac.models.user_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: UserPaged(*args, **kwargs) +methods: +- uid: azure.graphrbac.models.user_paged.UserPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.graphrbac.models.user_paged.UserPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.graphrbac.models.user_paged.UserPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.user_paged.UserPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.graphrbac.models.user_paged.UserPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.graphrbac.models.user_paged.UserPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.graphrbac.models.user_paged.UserPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_paged.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_paged.yml new file mode 100644 index 00000000..9dd1930e --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.user_paged +name: user_paged +fullName: azure.graphrbac.models.user_paged +classes: +- azure.graphrbac.models.user_paged.UserPaged diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_py3.User.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_py3.User.yml new file mode 100644 index 00000000..7ac008ce --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_py3.User.yml @@ -0,0 +1,246 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.user_py3.User +name: User +fullName: azure.graphrbac.models.user_py3.User +module: azure.graphrbac.models.user_py3 +summary: 'Active Directory user information. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'User(*, additional_properties=None, immutable_id: str = None, usage_location: + str = None, given_name: str = None, surname: str = None, user_type=None, account_enabled: + bool = None, display_name: str = None, user_principal_name: str = None, mail_nickname: + str = None, mail: str = None, sign_in_names=None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: object_type + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: immutable_id + description: 'This must be specified if you are using a federated + + domain for the user''s userPrincipalName (UPN) property when creating a new + + user account. It is used to associate an on-premises Active Directory user + + account with their Azure AD user object.' + isRequired: true + types: + - + - name: usage_location + description: 'A two letter country code (ISO standard 3166). + + Required for users that will be assigned licenses due to legal requirement + + to check for availability of services in countries. Examples include: + + "US", "JP", and "GB".' + isRequired: true + types: + - + - name: given_name + description: The given name for the user. + isRequired: true + types: + - + - name: surname + description: The user's surname (family name or last name). + isRequired: true + types: + - + - name: user_type + description: 'A string value that can be used to classify user types + + in your directory, such as ''Member'' and ''Guest''. Possible values include: + + ''Member'', ''Guest''' + isRequired: true + types: + - + - + - name: account_enabled + description: Whether the account is enabled. + isRequired: true + types: + - + - name: display_name + description: The display name of the user. + isRequired: true + types: + - + - name: user_principal_name + description: The principal name of the user. + isRequired: true + types: + - + - name: mail_nickname + description: The mail alias for the user. + isRequired: true + types: + - + - name: mail + description: The primary email address of the user. + isRequired: true + types: + - + - name: sign_in_names + description: The sign-in names of the user. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: immutable_id + isRequired: true + - name: usage_location + isRequired: true + - name: given_name + isRequired: true + - name: surname + isRequired: true + - name: user_type + isRequired: true + - name: account_enabled + isRequired: true + - name: display_name + isRequired: true + - name: user_principal_name + isRequired: true + - name: mail_nickname + isRequired: true + - name: mail + isRequired: true + - name: sign_in_names + isRequired: true +variables: +- description: The object ID. + name: object_id + types: + - +- description: 'The time at which the directory object was + + deleted.' + name: deletion_timestamp + types: + - +methods: +- uid: azure.graphrbac.models.user_py3.User.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.user_py3.User.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.user_py3.User.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.user_py3.User.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.user_py3.User.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.user_py3.User.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.user_py3.User.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_py3.yml new file mode 100644 index 00000000..6f143494 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.user_py3 +name: user_py3 +fullName: azure.graphrbac.models.user_py3 +classes: +- azure.graphrbac.models.user_py3.User diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_update_parameters.UserUpdateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_update_parameters.UserUpdateParameters.yml new file mode 100644 index 00000000..8c7b0ff4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_update_parameters.UserUpdateParameters.yml @@ -0,0 +1,194 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.user_update_parameters.UserUpdateParameters +name: UserUpdateParameters +fullName: azure.graphrbac.models.user_update_parameters.UserUpdateParameters +module: azure.graphrbac.models.user_update_parameters +summary: Request parameters for updating an existing work or school account user. +constructor: + syntax: UserUpdateParameters(**kwargs) + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: immutable_id + description: 'This must be specified if you are using a federated + + domain for the user''s userPrincipalName (UPN) property when creating a new + + user account. It is used to associate an on-premises Active Directory user + + account with their Azure AD user object.' + isRequired: true + types: + - + - name: usage_location + description: 'A two letter country code (ISO standard 3166). + + Required for users that will be assigned licenses due to legal requirement + + to check for availability of services in countries. Examples include: + + "US", "JP", and "GB".' + isRequired: true + types: + - + - name: given_name + description: The given name for the user. + isRequired: true + types: + - + - name: surname + description: The user's surname (family name or last name). + isRequired: true + types: + - + - name: user_type + description: 'A string value that can be used to classify user types + + in your directory, such as ''Member'' and ''Guest''. Possible values include: + + ''Member'', ''Guest''' + isRequired: true + types: + - + - + - name: account_enabled + description: Whether the account is enabled. + isRequired: true + types: + - + - name: display_name + description: The display name of the user. + isRequired: true + types: + - + - name: password_profile + description: The password profile of the user. + isRequired: true + types: + - + - name: user_principal_name + description: 'The user principal name + + (). It must contain one of the verified domains + for + + the tenant.' + isRequired: true + types: + - + - name: mail_nickname + description: The mail alias for the user. + isRequired: true + types: + - +methods: +- uid: azure.graphrbac.models.user_update_parameters.UserUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.user_update_parameters.UserUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.user_update_parameters.UserUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.user_update_parameters.UserUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.user_update_parameters.UserUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.user_update_parameters.UserUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.user_update_parameters.UserUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_update_parameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_update_parameters.yml new file mode 100644 index 00000000..97ad93dc --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_update_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.user_update_parameters +name: user_update_parameters +fullName: azure.graphrbac.models.user_update_parameters +classes: +- azure.graphrbac.models.user_update_parameters.UserUpdateParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_update_parameters_py3.UserUpdateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_update_parameters_py3.UserUpdateParameters.yml new file mode 100644 index 00000000..7f868f8f --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_update_parameters_py3.UserUpdateParameters.yml @@ -0,0 +1,220 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.models.user_update_parameters_py3.UserUpdateParameters +name: UserUpdateParameters +fullName: azure.graphrbac.models.user_update_parameters_py3.UserUpdateParameters +module: azure.graphrbac.models.user_update_parameters_py3 +summary: Request parameters for updating an existing work or school account user. +constructor: + syntax: 'UserUpdateParameters(*, additional_properties=None, immutable_id: str = + None, usage_location: str = None, given_name: str = None, surname: str = None, + user_type=None, account_enabled: bool = None, display_name: str = None, password_profile=None, + user_principal_name: str = None, mail_nickname: str = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are + + deserialized this collection' + isRequired: true + types: + - [, ] + - name: immutable_id + description: 'This must be specified if you are using a federated + + domain for the user''s userPrincipalName (UPN) property when creating a new + + user account. It is used to associate an on-premises Active Directory user + + account with their Azure AD user object.' + isRequired: true + types: + - + - name: usage_location + description: 'A two letter country code (ISO standard 3166). + + Required for users that will be assigned licenses due to legal requirement + + to check for availability of services in countries. Examples include: + + "US", "JP", and "GB".' + isRequired: true + types: + - + - name: given_name + description: The given name for the user. + isRequired: true + types: + - + - name: surname + description: The user's surname (family name or last name). + isRequired: true + types: + - + - name: user_type + description: 'A string value that can be used to classify user types + + in your directory, such as ''Member'' and ''Guest''. Possible values include: + + ''Member'', ''Guest''' + isRequired: true + types: + - + - + - name: account_enabled + description: Whether the account is enabled. + isRequired: true + types: + - + - name: display_name + description: The display name of the user. + isRequired: true + types: + - + - name: password_profile + description: The password profile of the user. + isRequired: true + types: + - + - name: user_principal_name + description: 'The user principal name + + (). It must contain one of the verified domains + for + + the tenant.' + isRequired: true + types: + - + - name: mail_nickname + description: The mail alias for the user. + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: immutable_id + isRequired: true + - name: usage_location + isRequired: true + - name: given_name + isRequired: true + - name: surname + isRequired: true + - name: user_type + isRequired: true + - name: account_enabled + isRequired: true + - name: display_name + isRequired: true + - name: password_profile + isRequired: true + - name: user_principal_name + isRequired: true + - name: mail_nickname + isRequired: true +methods: +- uid: azure.graphrbac.models.user_update_parameters_py3.UserUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.user_update_parameters_py3.UserUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.user_update_parameters_py3.UserUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.graphrbac.models.user_update_parameters_py3.UserUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.graphrbac.models.user_update_parameters_py3.UserUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.graphrbac.models.user_update_parameters_py3.UserUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.graphrbac.models.user_update_parameters_py3.UserUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_update_parameters_py3.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_update_parameters_py3.yml new file mode 100644 index 00000000..c8e9e0c5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_update_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.models.user_update_parameters_py3 +name: user_update_parameters_py3 +fullName: azure.graphrbac.models.user_update_parameters_py3 +classes: +- azure.graphrbac.models.user_update_parameters_py3.UserUpdateParameters diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.yml new file mode 100644 index 00000000..fe03931d --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.yml @@ -0,0 +1,158 @@ +### YamlMime:PythonPackage +uid: azure.graphrbac.models +name: models +fullName: azure.graphrbac.models +type: import +classes: +- azure.graphrbac.models.ADGroup +- azure.graphrbac.models.ADGroupPaged +- azure.graphrbac.models.AddOwnerParameters +- azure.graphrbac.models.AppRole +- azure.graphrbac.models.Application +- azure.graphrbac.models.ApplicationBase +- azure.graphrbac.models.ApplicationCreateParameters +- azure.graphrbac.models.ApplicationPaged +- azure.graphrbac.models.ApplicationUpdateParameters +- azure.graphrbac.models.CheckGroupMembershipParameters +- azure.graphrbac.models.CheckGroupMembershipResult +- azure.graphrbac.models.DirectoryObject +- azure.graphrbac.models.DirectoryObjectPaged +- azure.graphrbac.models.Domain +- azure.graphrbac.models.DomainPaged +- azure.graphrbac.models.GetObjectsParameters +- azure.graphrbac.models.GraphError +- azure.graphrbac.models.GraphErrorException +- azure.graphrbac.models.GroupAddMemberParameters +- azure.graphrbac.models.GroupCreateParameters +- azure.graphrbac.models.GroupGetMemberGroupsParameters +- azure.graphrbac.models.InformationalUrl +- azure.graphrbac.models.KeyCredential +- azure.graphrbac.models.KeyCredentialPaged +- azure.graphrbac.models.KeyCredentialsUpdateParameters +- azure.graphrbac.models.OAuth2Permission +- azure.graphrbac.models.OAuth2PermissionGrant +- azure.graphrbac.models.OAuth2PermissionGrantPaged +- azure.graphrbac.models.OptionalClaim +- azure.graphrbac.models.OptionalClaims +- azure.graphrbac.models.PasswordCredential +- azure.graphrbac.models.PasswordCredentialPaged +- azure.graphrbac.models.PasswordCredentialsUpdateParameters +- azure.graphrbac.models.PasswordProfile +- azure.graphrbac.models.PreAuthorizedApplication +- azure.graphrbac.models.PreAuthorizedApplicationExtension +- azure.graphrbac.models.PreAuthorizedApplicationPermission +- azure.graphrbac.models.RequiredResourceAccess +- azure.graphrbac.models.ResourceAccess +- azure.graphrbac.models.ServicePrincipal +- azure.graphrbac.models.ServicePrincipalBase +- azure.graphrbac.models.ServicePrincipalCreateParameters +- azure.graphrbac.models.ServicePrincipalObjectResult +- azure.graphrbac.models.ServicePrincipalPaged +- azure.graphrbac.models.ServicePrincipalUpdateParameters +- azure.graphrbac.models.SignInName +- azure.graphrbac.models.StrPaged +- azure.graphrbac.models.User +- azure.graphrbac.models.UserBase +- azure.graphrbac.models.UserCreateParameters +- azure.graphrbac.models.UserGetMemberGroupsParameters +- azure.graphrbac.models.UserPaged +- azure.graphrbac.models.UserUpdateParameters +modules: +- azure.graphrbac.models.ad_group +- azure.graphrbac.models.ad_group_paged +- azure.graphrbac.models.ad_group_py3 +- azure.graphrbac.models.add_owner_parameters +- azure.graphrbac.models.add_owner_parameters_py3 +- azure.graphrbac.models.app_role +- azure.graphrbac.models.app_role_py3 +- azure.graphrbac.models.application +- azure.graphrbac.models.application_base +- azure.graphrbac.models.application_base_py3 +- azure.graphrbac.models.application_create_parameters +- azure.graphrbac.models.application_create_parameters_py3 +- azure.graphrbac.models.application_paged +- azure.graphrbac.models.application_py3 +- azure.graphrbac.models.application_update_parameters +- azure.graphrbac.models.application_update_parameters_py3 +- azure.graphrbac.models.check_group_membership_parameters +- azure.graphrbac.models.check_group_membership_parameters_py3 +- azure.graphrbac.models.check_group_membership_result +- azure.graphrbac.models.check_group_membership_result_py3 +- azure.graphrbac.models.directory_object +- azure.graphrbac.models.directory_object_paged +- azure.graphrbac.models.directory_object_py3 +- azure.graphrbac.models.domain +- azure.graphrbac.models.domain_paged +- azure.graphrbac.models.domain_py3 +- azure.graphrbac.models.get_objects_parameters +- azure.graphrbac.models.get_objects_parameters_py3 +- azure.graphrbac.models.graph_error +- azure.graphrbac.models.graph_error_py3 +- azure.graphrbac.models.graph_rbac_management_client_enums +- azure.graphrbac.models.group_add_member_parameters +- azure.graphrbac.models.group_add_member_parameters_py3 +- azure.graphrbac.models.group_create_parameters +- azure.graphrbac.models.group_create_parameters_py3 +- azure.graphrbac.models.group_get_member_groups_parameters +- azure.graphrbac.models.group_get_member_groups_parameters_py3 +- azure.graphrbac.models.informational_url +- azure.graphrbac.models.informational_url_py3 +- azure.graphrbac.models.key_credential +- azure.graphrbac.models.key_credential_paged +- azure.graphrbac.models.key_credential_py3 +- azure.graphrbac.models.key_credentials_update_parameters +- azure.graphrbac.models.key_credentials_update_parameters_py3 +- azure.graphrbac.models.oauth2_permission +- azure.graphrbac.models.oauth2_permission_grant +- azure.graphrbac.models.oauth2_permission_grant_paged +- azure.graphrbac.models.oauth2_permission_grant_py3 +- azure.graphrbac.models.oauth2_permission_py3 +- azure.graphrbac.models.optional_claim +- azure.graphrbac.models.optional_claim_py3 +- azure.graphrbac.models.optional_claims +- azure.graphrbac.models.optional_claims_py3 +- azure.graphrbac.models.password_credential +- azure.graphrbac.models.password_credential_paged +- azure.graphrbac.models.password_credential_py3 +- azure.graphrbac.models.password_credentials_update_parameters +- azure.graphrbac.models.password_credentials_update_parameters_py3 +- azure.graphrbac.models.password_profile +- azure.graphrbac.models.password_profile_py3 +- azure.graphrbac.models.pre_authorized_application +- azure.graphrbac.models.pre_authorized_application_extension +- azure.graphrbac.models.pre_authorized_application_extension_py3 +- azure.graphrbac.models.pre_authorized_application_permission +- azure.graphrbac.models.pre_authorized_application_permission_py3 +- azure.graphrbac.models.pre_authorized_application_py3 +- azure.graphrbac.models.required_resource_access +- azure.graphrbac.models.required_resource_access_py3 +- azure.graphrbac.models.resource_access +- azure.graphrbac.models.resource_access_py3 +- azure.graphrbac.models.service_principal +- azure.graphrbac.models.service_principal_base +- azure.graphrbac.models.service_principal_base_py3 +- azure.graphrbac.models.service_principal_create_parameters +- azure.graphrbac.models.service_principal_create_parameters_py3 +- azure.graphrbac.models.service_principal_object_result +- azure.graphrbac.models.service_principal_object_result_py3 +- azure.graphrbac.models.service_principal_paged +- azure.graphrbac.models.service_principal_py3 +- azure.graphrbac.models.service_principal_update_parameters +- azure.graphrbac.models.service_principal_update_parameters_py3 +- azure.graphrbac.models.sign_in_name +- azure.graphrbac.models.sign_in_name_py3 +- azure.graphrbac.models.str_paged +- azure.graphrbac.models.user +- azure.graphrbac.models.user_base +- azure.graphrbac.models.user_base_py3 +- azure.graphrbac.models.user_create_parameters +- azure.graphrbac.models.user_create_parameters_py3 +- azure.graphrbac.models.user_get_member_groups_parameters +- azure.graphrbac.models.user_get_member_groups_parameters_py3 +- azure.graphrbac.models.user_paged +- azure.graphrbac.models.user_py3 +- azure.graphrbac.models.user_update_parameters +- azure.graphrbac.models.user_update_parameters_py3 +enums: +- azure.graphrbac.models.ConsentType +- azure.graphrbac.models.UserType diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.ApplicationsOperations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.ApplicationsOperations.yml new file mode 100644 index 00000000..de8b4785 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.ApplicationsOperations.yml @@ -0,0 +1,526 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.operations.ApplicationsOperations +name: ApplicationsOperations +fullName: azure.graphrbac.operations.ApplicationsOperations +module: azure.graphrbac.operations +summary: ApplicationsOperations operations. +constructor: + syntax: ApplicationsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'Client API version. Constant value: "1.6".' + name: api_version +methods: +- uid: azure.graphrbac.operations.ApplicationsOperations.add_owner + name: add_owner + summary: Add an owner to an application. + signature: add_owner(application_object_id, url, additional_properties=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: application_object_id + description: 'The object ID of the application to + + which to add the owner.' + isRequired: true + types: + - + - name: url + description: 'A owner object URL, such as + + "[https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd](https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd)", + + where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and + + "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the owner + + (user, application, servicePrincipal, group) to be added.' + isRequired: true + types: + - + - name: additional_properties + description: 'Unmatched properties from the message + + are deserialized this collection' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.ApplicationsOperations.create + name: create + summary: Create a new application. + signature: create(parameters, custom_headers=None, raw=False, **operation_config) + parameters: + - name: parameters + description: The parameters for creating an application. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Application or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.ApplicationsOperations.delete + name: delete + summary: Delete an application. + signature: delete(application_object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: application_object_id + description: Application object ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.ApplicationsOperations.get + name: get + summary: Get an application by object ID. + signature: get(application_object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: application_object_id + description: Application object ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Application or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.ApplicationsOperations.get_service_principals_id_by_app_id + name: get_service_principals_id_by_app_id + summary: Gets an object id for a given application id from the current tenant. + signature: get_service_principals_id_by_app_id(application_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: application_id + description: The application ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ServicePrincipalObjectResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.ApplicationsOperations.list + name: list + summary: Lists applications by filter parameters. + signature: list(filter=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: filter + description: The filters to apply to the operation. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of Application + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.ApplicationsOperations.list_key_credentials + name: list_key_credentials + summary: Get the keyCredentials associated with an application. + signature: list_key_credentials(application_object_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: application_object_id + description: Application object ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of KeyCredential + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.ApplicationsOperations.list_owners + name: list_owners + summary: 'Directory objects that are owners of the application. + + + The owners are a set of non-admin users who are allowed to modify this + + object.' + signature: list_owners(application_object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: application_object_id + description: 'The object ID of the application for + + which to get owners.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DirectoryObject + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.ApplicationsOperations.list_password_credentials + name: list_password_credentials + summary: Get the passwordCredentials associated with an application. + signature: list_password_credentials(application_object_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: application_object_id + description: Application object ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of PasswordCredential + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.ApplicationsOperations.patch + name: patch + summary: Update an existing application. + signature: patch(application_object_id, parameters, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: application_object_id + description: Application object ID. + isRequired: true + types: + - + - name: parameters + description: Parameters to update an existing application. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.ApplicationsOperations.remove_owner + name: remove_owner + summary: Remove a member from owners. + signature: remove_owner(application_object_id, owner_object_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: application_object_id + description: 'The object ID of the application from + + which to remove the owner.' + isRequired: true + types: + - + - name: owner_object_id + description: Owner object id + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.ApplicationsOperations.update_key_credentials + name: update_key_credentials + summary: Update the keyCredentials associated with an application. + signature: update_key_credentials(application_object_id, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: application_object_id + description: Application object ID. + isRequired: true + types: + - + - name: value + description: A collection of KeyCredentials. + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.ApplicationsOperations.update_password_credentials + name: update_password_credentials + summary: Update passwordCredentials associated with an application. + signature: update_password_credentials(application_object_id, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: application_object_id + description: Application object ID. + isRequired: true + types: + - + - name: value + description: A collection of PasswordCredentials. + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +attributes: +- uid: azure.graphrbac.operations.ApplicationsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.DeletedApplicationsOperations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.DeletedApplicationsOperations.yml new file mode 100644 index 00000000..32379f36 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.DeletedApplicationsOperations.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.operations.DeletedApplicationsOperations +name: DeletedApplicationsOperations +fullName: azure.graphrbac.operations.DeletedApplicationsOperations +module: azure.graphrbac.operations +summary: DeletedApplicationsOperations operations. +constructor: + syntax: DeletedApplicationsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'Client API version. Constant value: "1.6".' + name: api_version +methods: +- uid: azure.graphrbac.operations.DeletedApplicationsOperations.hard_delete + name: hard_delete + summary: Hard-delete an application. + signature: hard_delete(application_object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: application_object_id + description: Application object ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.DeletedApplicationsOperations.list + name: list + summary: Gets a list of deleted applications in the directory. + signature: list(filter=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: filter + description: The filter to apply to the operation. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of Application + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.DeletedApplicationsOperations.restore + name: restore + summary: Restores the deleted application in the directory. + signature: restore(object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: Application object ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Application or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +attributes: +- uid: azure.graphrbac.operations.DeletedApplicationsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.DomainsOperations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.DomainsOperations.yml new file mode 100644 index 00000000..c10fe4f9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.DomainsOperations.yml @@ -0,0 +1,96 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.operations.DomainsOperations +name: DomainsOperations +fullName: azure.graphrbac.operations.DomainsOperations +module: azure.graphrbac.operations +summary: DomainsOperations operations. +constructor: + syntax: DomainsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'Client API version. Constant value: "1.6".' + name: api_version +methods: +- uid: azure.graphrbac.operations.DomainsOperations.get + name: get + summary: Gets a specific domain in the current tenant. + signature: get(domain_name, custom_headers=None, raw=False, **operation_config) + parameters: + - name: domain_name + description: name of the domain. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Domain or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.graphrbac.operations.DomainsOperations.list + name: list + summary: Gets a list of domains for the current tenant. + signature: list(filter=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: filter + description: The filter to apply to the operation. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of Domain + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.graphrbac.operations.DomainsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.GroupsOperations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.GroupsOperations.yml new file mode 100644 index 00000000..a9b3249b --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.GroupsOperations.yml @@ -0,0 +1,527 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.operations.GroupsOperations +name: GroupsOperations +fullName: azure.graphrbac.operations.GroupsOperations +module: azure.graphrbac.operations +summary: GroupsOperations operations. +constructor: + syntax: GroupsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'Client API version. Constant value: "1.6".' + name: api_version +methods: +- uid: azure.graphrbac.operations.GroupsOperations.add_member + name: add_member + summary: Add a member to a group. + signature: add_member(group_object_id, url, additional_properties=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: group_object_id + description: 'The object ID of the group to which to add the + + member.' + isRequired: true + types: + - + - name: url + description: 'A member object URL, such as + + "[https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd](https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd)", + + where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and + + "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the member + + (user, application, servicePrincipal, group) to be added.' + isRequired: true + types: + - + - name: additional_properties + description: 'Unmatched properties from the message + + are deserialized this collection' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.GroupsOperations.add_owner + name: add_owner + summary: Add an owner to a group. + signature: add_owner(object_id, url, additional_properties=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: object_id + description: 'The object ID of the application to which to add the + + owner.' + isRequired: true + types: + - + - name: url + description: 'A owner object URL, such as + + "[https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd](https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd)", + + where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and + + "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the owner + + (user, application, servicePrincipal, group) to be added.' + isRequired: true + types: + - + - name: additional_properties + description: 'Unmatched properties from the message + + are deserialized this collection' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.GroupsOperations.create + name: create + summary: Create a group in the directory. + signature: create(parameters, custom_headers=None, raw=False, **operation_config) + parameters: + - name: parameters + description: The parameters for the group to create. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ADGroup or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.GroupsOperations.delete + name: delete + summary: Delete a group from the directory. + signature: delete(object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: The object ID of the group to delete. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.GroupsOperations.get + name: get + summary: Gets group information from the directory. + signature: get(object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: 'The object ID of the user for which to get group + + information.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ADGroup or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.GroupsOperations.get_group_members + name: get_group_members + summary: Gets the members of a group. + signature: get_group_members(object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: 'The object ID of the group whose members should be + + retrieved.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DirectoryObject + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.GroupsOperations.get_member_groups + name: get_member_groups + summary: 'Gets a collection of object IDs of groups of which the specified group + + is a member.' + signature: get_member_groups(object_id, security_enabled_only, additional_properties=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: 'The object ID of the group for which to get group + + membership.' + isRequired: true + types: + - + - name: security_enabled_only + description: 'If true, only membership in + + security-enabled groups should be checked. Otherwise, membership in + + all groups should be checked.' + isRequired: true + types: + - + - name: additional_properties + description: 'Unmatched properties from the message + + are deserialized this collection' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of str + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.GroupsOperations.is_member_of + name: is_member_of + summary: 'Checks whether the specified user, group, contact, or service principal + + is a direct or transitive member of the specified group.' + signature: is_member_of(parameters, custom_headers=None, raw=False, **operation_config) + parameters: + - name: parameters + description: The check group membership parameters. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CheckGroupMembershipResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.GroupsOperations.list + name: list + summary: Gets list of groups for the current tenant. + signature: list(filter=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: filter + description: The filter to apply to the operation. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of ADGroup + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.GroupsOperations.list_owners + name: list_owners + summary: 'Directory objects that are owners of the group. + + + The owners are a set of non-admin users who are allowed to modify this + + object.' + signature: list_owners(object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: The object ID of the group for which to get owners. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DirectoryObject + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.GroupsOperations.remove_member + name: remove_member + summary: Remove a member from a group. + signature: remove_member(group_object_id, member_object_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: group_object_id + description: 'The object ID of the group from which to + + remove the member.' + isRequired: true + types: + - + - name: member_object_id + description: Member object id + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.GroupsOperations.remove_owner + name: remove_owner + summary: Remove a member from owners. + signature: remove_owner(object_id, owner_object_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: object_id + description: 'The object ID of the group from which to remove the + + owner.' + isRequired: true + types: + - + - name: owner_object_id + description: Owner object id + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +attributes: +- uid: azure.graphrbac.operations.GroupsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.OAuth2PermissionGrantOperations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.OAuth2PermissionGrantOperations.yml new file mode 100644 index 00000000..f2d05bd3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.OAuth2PermissionGrantOperations.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.operations.OAuth2PermissionGrantOperations +name: OAuth2PermissionGrantOperations +fullName: azure.graphrbac.operations.OAuth2PermissionGrantOperations +module: azure.graphrbac.operations +summary: OAuth2PermissionGrantOperations operations. +constructor: + syntax: OAuth2PermissionGrantOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'Client API version. Constant value: "1.6".' + name: api_version +methods: +- uid: azure.graphrbac.operations.OAuth2PermissionGrantOperations.create + name: create + summary: Grants OAuth2 permissions for the relevant resource Ids of an app. + signature: create(body=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: body + description: 'The relevant app Service Principal Object Id and the + + Service Principal Object Id you want to grant.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OAuth2PermissionGrant or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.graphrbac.operations.OAuth2PermissionGrantOperations.delete + name: delete + summary: 'Delete a OAuth2 permission grant for the relevant resource Ids of an + + app.' + signature: delete(object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: The object ID of a permission grant. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.OAuth2PermissionGrantOperations.list + name: list + summary: 'Queries OAuth2 permissions grants for the relevant SP ObjectId of an + + app.' + signature: list(filter=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: filter + description: 'This is the Service Principal ObjectId associated with + + the app' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of OAuth2PermissionGrant + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.graphrbac.operations.OAuth2PermissionGrantOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.ObjectsOperations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.ObjectsOperations.yml new file mode 100644 index 00000000..048255d6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.ObjectsOperations.yml @@ -0,0 +1,67 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.operations.ObjectsOperations +name: ObjectsOperations +fullName: azure.graphrbac.operations.ObjectsOperations +module: azure.graphrbac.operations +summary: ObjectsOperations operations. +constructor: + syntax: ObjectsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'Client API version. Constant value: "1.6".' + name: api_version +methods: +- uid: azure.graphrbac.operations.ObjectsOperations.get_objects_by_object_ids + name: get_objects_by_object_ids + summary: 'Gets the directory objects specified in a list of object IDs. You can + + also specify which resource collections (users, groups, etc.) should be + + searched by specifying the optional types parameter.' + signature: get_objects_by_object_ids(parameters, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: parameters + description: Objects filtering parameters. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DirectoryObject + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.graphrbac.operations.ObjectsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.ServicePrincipalsOperations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.ServicePrincipalsOperations.yml new file mode 100644 index 00000000..d117a386 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.ServicePrincipalsOperations.yml @@ -0,0 +1,396 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.operations.ServicePrincipalsOperations +name: ServicePrincipalsOperations +fullName: azure.graphrbac.operations.ServicePrincipalsOperations +module: azure.graphrbac.operations +summary: ServicePrincipalsOperations operations. +constructor: + syntax: ServicePrincipalsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'Client API version. Constant value: "1.6".' + name: api_version +methods: +- uid: azure.graphrbac.operations.ServicePrincipalsOperations.create + name: create + summary: Creates a service principal in the directory. + signature: create(parameters, custom_headers=None, raw=False, **operation_config) + parameters: + - name: parameters + description: Parameters to create a service principal. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ServicePrincipal or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.ServicePrincipalsOperations.delete + name: delete + summary: Deletes a service principal from the directory. + signature: delete(object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: The object ID of the service principal to delete. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.ServicePrincipalsOperations.get + name: get + summary: 'Gets service principal information from the directory. Query by + + objectId or pass a filter to query by appId.' + signature: get(object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: The object ID of the service principal to get. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ServicePrincipal or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.ServicePrincipalsOperations.list + name: list + summary: Gets a list of service principals from the current tenant. + signature: list(filter=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: filter + description: The filter to apply to the operation. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of ServicePrincipal + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.ServicePrincipalsOperations.list_key_credentials + name: list_key_credentials + summary: Get the keyCredentials associated with the specified service principal. + signature: list_key_credentials(object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: 'The object ID of the service principal for which to + + get keyCredentials.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of KeyCredential + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.ServicePrincipalsOperations.list_owners + name: list_owners + summary: 'Directory objects that are owners of this service principal. + + + The owners are a set of non-admin users who are allowed to modify this + + object.' + signature: list_owners(object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: 'The object ID of the service principal for which to + + get owners.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DirectoryObject + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.ServicePrincipalsOperations.list_password_credentials + name: list_password_credentials + summary: Gets the passwordCredentials associated with a service principal. + signature: list_password_credentials(object_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: object_id + description: The object ID of the service principal. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of PasswordCredential + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.ServicePrincipalsOperations.update + name: update + summary: Updates a service principal in the directory. + signature: update(object_id, parameters, custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: The object ID of the service principal to delete. + isRequired: true + types: + - + - name: parameters + description: Parameters to update a service principal. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.ServicePrincipalsOperations.update_key_credentials + name: update_key_credentials + summary: Update the keyCredentials associated with a service principal. + signature: update_key_credentials(object_id, value, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: object_id + description: 'The object ID for which to get service principal + + information.' + isRequired: true + types: + - + - name: value + description: A collection of KeyCredentials. + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.ServicePrincipalsOperations.update_password_credentials + name: update_password_credentials + summary: Updates the passwordCredentials associated with a service principal. + signature: update_password_credentials(object_id, value, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: object_id + description: The object ID of the service principal. + isRequired: true + types: + - + - name: value + description: A collection of PasswordCredentials. + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +attributes: +- uid: azure.graphrbac.operations.ServicePrincipalsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.SignedInUserOperations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.SignedInUserOperations.yml new file mode 100644 index 00000000..8ac3cf12 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.SignedInUserOperations.yml @@ -0,0 +1,86 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.operations.SignedInUserOperations +name: SignedInUserOperations +fullName: azure.graphrbac.operations.SignedInUserOperations +module: azure.graphrbac.operations +summary: SignedInUserOperations operations. +constructor: + syntax: SignedInUserOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'Client API version. Constant value: "1.6".' + name: api_version +methods: +- uid: azure.graphrbac.operations.SignedInUserOperations.get + name: get + summary: Gets the details for the currently logged-in user. + signature: get(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: User or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.SignedInUserOperations.list_owned_objects + name: list_owned_objects + summary: Get the list of directory objects that are owned by the user. + signature: list_owned_objects(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DirectoryObject + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +attributes: +- uid: azure.graphrbac.operations.SignedInUserOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.UsersOperations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.UsersOperations.yml new file mode 100644 index 00000000..b9543b03 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.UsersOperations.yml @@ -0,0 +1,264 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.operations.UsersOperations +name: UsersOperations +fullName: azure.graphrbac.operations.UsersOperations +module: azure.graphrbac.operations +summary: UsersOperations operations. +constructor: + syntax: UsersOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'Client API version. Constant value: "1.6".' + name: api_version +methods: +- uid: azure.graphrbac.operations.UsersOperations.create + name: create + summary: Create a new user. + signature: create(parameters, custom_headers=None, raw=False, **operation_config) + parameters: + - name: parameters + description: Parameters to create a user. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: User or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.UsersOperations.delete + name: delete + summary: Delete a user. + signature: delete(upn_or_object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: upn_or_object_id + description: 'The object ID or principal name of the user + + to delete.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.UsersOperations.get + name: get + summary: Gets user information from the directory. + signature: get(upn_or_object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: upn_or_object_id + description: 'The object ID or principal name of the user + + for which to get information.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: User or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.UsersOperations.get_member_groups + name: get_member_groups + summary: 'Gets a collection that contains the object IDs of the groups of which + + the user is a member.' + signature: get_member_groups(object_id, security_enabled_only, additional_properties=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: 'The object ID of the user for which to get group + + membership.' + isRequired: true + types: + - + - name: security_enabled_only + description: 'If true, only membership in + + security-enabled groups should be checked. Otherwise, membership in + + all groups should be checked.' + isRequired: true + types: + - + - name: additional_properties + description: 'Unmatched properties from the message + + are deserialized this collection' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of str + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.UsersOperations.list + name: list + summary: Gets list of users for the current tenant. + signature: list(filter=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: filter + description: The filter to apply to the operation. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of User + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.UsersOperations.update + name: update + summary: Updates a user. + signature: update(upn_or_object_id, parameters, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: upn_or_object_id + description: 'The object ID or principal name of the user + + to update.' + isRequired: true + types: + - + - name: parameters + description: Parameters to update an existing user. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +attributes: +- uid: azure.graphrbac.operations.UsersOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.applications_operations.ApplicationsOperations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.applications_operations.ApplicationsOperations.yml new file mode 100644 index 00000000..5504cf28 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.applications_operations.ApplicationsOperations.yml @@ -0,0 +1,526 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.operations.applications_operations.ApplicationsOperations +name: ApplicationsOperations +fullName: azure.graphrbac.operations.applications_operations.ApplicationsOperations +module: azure.graphrbac.operations.applications_operations +summary: ApplicationsOperations operations. +constructor: + syntax: ApplicationsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'Client API version. Constant value: "1.6".' + name: api_version +methods: +- uid: azure.graphrbac.operations.applications_operations.ApplicationsOperations.add_owner + name: add_owner + summary: Add an owner to an application. + signature: add_owner(application_object_id, url, additional_properties=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: application_object_id + description: 'The object ID of the application to + + which to add the owner.' + isRequired: true + types: + - + - name: url + description: 'A owner object URL, such as + + "[https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd](https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd)", + + where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and + + "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the owner + + (user, application, servicePrincipal, group) to be added.' + isRequired: true + types: + - + - name: additional_properties + description: 'Unmatched properties from the message + + are deserialized this collection' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.applications_operations.ApplicationsOperations.create + name: create + summary: Create a new application. + signature: create(parameters, custom_headers=None, raw=False, **operation_config) + parameters: + - name: parameters + description: The parameters for creating an application. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Application or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.applications_operations.ApplicationsOperations.delete + name: delete + summary: Delete an application. + signature: delete(application_object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: application_object_id + description: Application object ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.applications_operations.ApplicationsOperations.get + name: get + summary: Get an application by object ID. + signature: get(application_object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: application_object_id + description: Application object ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Application or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.applications_operations.ApplicationsOperations.get_service_principals_id_by_app_id + name: get_service_principals_id_by_app_id + summary: Gets an object id for a given application id from the current tenant. + signature: get_service_principals_id_by_app_id(application_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: application_id + description: The application ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ServicePrincipalObjectResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.applications_operations.ApplicationsOperations.list + name: list + summary: Lists applications by filter parameters. + signature: list(filter=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: filter + description: The filters to apply to the operation. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of Application + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.applications_operations.ApplicationsOperations.list_key_credentials + name: list_key_credentials + summary: Get the keyCredentials associated with an application. + signature: list_key_credentials(application_object_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: application_object_id + description: Application object ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of KeyCredential + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.applications_operations.ApplicationsOperations.list_owners + name: list_owners + summary: 'Directory objects that are owners of the application. + + + The owners are a set of non-admin users who are allowed to modify this + + object.' + signature: list_owners(application_object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: application_object_id + description: 'The object ID of the application for + + which to get owners.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DirectoryObject + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.applications_operations.ApplicationsOperations.list_password_credentials + name: list_password_credentials + summary: Get the passwordCredentials associated with an application. + signature: list_password_credentials(application_object_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: application_object_id + description: Application object ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of PasswordCredential + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.applications_operations.ApplicationsOperations.patch + name: patch + summary: Update an existing application. + signature: patch(application_object_id, parameters, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: application_object_id + description: Application object ID. + isRequired: true + types: + - + - name: parameters + description: Parameters to update an existing application. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.applications_operations.ApplicationsOperations.remove_owner + name: remove_owner + summary: Remove a member from owners. + signature: remove_owner(application_object_id, owner_object_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: application_object_id + description: 'The object ID of the application from + + which to remove the owner.' + isRequired: true + types: + - + - name: owner_object_id + description: Owner object id + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.applications_operations.ApplicationsOperations.update_key_credentials + name: update_key_credentials + summary: Update the keyCredentials associated with an application. + signature: update_key_credentials(application_object_id, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: application_object_id + description: Application object ID. + isRequired: true + types: + - + - name: value + description: A collection of KeyCredentials. + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.applications_operations.ApplicationsOperations.update_password_credentials + name: update_password_credentials + summary: Update passwordCredentials associated with an application. + signature: update_password_credentials(application_object_id, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: application_object_id + description: Application object ID. + isRequired: true + types: + - + - name: value + description: A collection of PasswordCredentials. + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +attributes: +- uid: azure.graphrbac.operations.applications_operations.ApplicationsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.applications_operations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.applications_operations.yml new file mode 100644 index 00000000..02bed33d --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.applications_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.operations.applications_operations +name: applications_operations +fullName: azure.graphrbac.operations.applications_operations +classes: +- azure.graphrbac.operations.applications_operations.ApplicationsOperations diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.deleted_applications_operations.DeletedApplicationsOperations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.deleted_applications_operations.DeletedApplicationsOperations.yml new file mode 100644 index 00000000..f54ad59c --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.deleted_applications_operations.DeletedApplicationsOperations.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.operations.deleted_applications_operations.DeletedApplicationsOperations +name: DeletedApplicationsOperations +fullName: azure.graphrbac.operations.deleted_applications_operations.DeletedApplicationsOperations +module: azure.graphrbac.operations.deleted_applications_operations +summary: DeletedApplicationsOperations operations. +constructor: + syntax: DeletedApplicationsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'Client API version. Constant value: "1.6".' + name: api_version +methods: +- uid: azure.graphrbac.operations.deleted_applications_operations.DeletedApplicationsOperations.hard_delete + name: hard_delete + summary: Hard-delete an application. + signature: hard_delete(application_object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: application_object_id + description: Application object ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.deleted_applications_operations.DeletedApplicationsOperations.list + name: list + summary: Gets a list of deleted applications in the directory. + signature: list(filter=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: filter + description: The filter to apply to the operation. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of Application + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.deleted_applications_operations.DeletedApplicationsOperations.restore + name: restore + summary: Restores the deleted application in the directory. + signature: restore(object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: Application object ID. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Application or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +attributes: +- uid: azure.graphrbac.operations.deleted_applications_operations.DeletedApplicationsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.deleted_applications_operations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.deleted_applications_operations.yml new file mode 100644 index 00000000..ff09bfe2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.deleted_applications_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.operations.deleted_applications_operations +name: deleted_applications_operations +fullName: azure.graphrbac.operations.deleted_applications_operations +classes: +- azure.graphrbac.operations.deleted_applications_operations.DeletedApplicationsOperations diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.domains_operations.DomainsOperations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.domains_operations.DomainsOperations.yml new file mode 100644 index 00000000..41874d0b --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.domains_operations.DomainsOperations.yml @@ -0,0 +1,96 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.operations.domains_operations.DomainsOperations +name: DomainsOperations +fullName: azure.graphrbac.operations.domains_operations.DomainsOperations +module: azure.graphrbac.operations.domains_operations +summary: DomainsOperations operations. +constructor: + syntax: DomainsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'Client API version. Constant value: "1.6".' + name: api_version +methods: +- uid: azure.graphrbac.operations.domains_operations.DomainsOperations.get + name: get + summary: Gets a specific domain in the current tenant. + signature: get(domain_name, custom_headers=None, raw=False, **operation_config) + parameters: + - name: domain_name + description: name of the domain. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Domain or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.graphrbac.operations.domains_operations.DomainsOperations.list + name: list + summary: Gets a list of domains for the current tenant. + signature: list(filter=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: filter + description: The filter to apply to the operation. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of Domain + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.graphrbac.operations.domains_operations.DomainsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.domains_operations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.domains_operations.yml new file mode 100644 index 00000000..5767eec5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.domains_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.operations.domains_operations +name: domains_operations +fullName: azure.graphrbac.operations.domains_operations +classes: +- azure.graphrbac.operations.domains_operations.DomainsOperations diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.groups_operations.GroupsOperations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.groups_operations.GroupsOperations.yml new file mode 100644 index 00000000..867bfafb --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.groups_operations.GroupsOperations.yml @@ -0,0 +1,527 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.operations.groups_operations.GroupsOperations +name: GroupsOperations +fullName: azure.graphrbac.operations.groups_operations.GroupsOperations +module: azure.graphrbac.operations.groups_operations +summary: GroupsOperations operations. +constructor: + syntax: GroupsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'Client API version. Constant value: "1.6".' + name: api_version +methods: +- uid: azure.graphrbac.operations.groups_operations.GroupsOperations.add_member + name: add_member + summary: Add a member to a group. + signature: add_member(group_object_id, url, additional_properties=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: group_object_id + description: 'The object ID of the group to which to add the + + member.' + isRequired: true + types: + - + - name: url + description: 'A member object URL, such as + + "[https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd](https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd)", + + where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and + + "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the member + + (user, application, servicePrincipal, group) to be added.' + isRequired: true + types: + - + - name: additional_properties + description: 'Unmatched properties from the message + + are deserialized this collection' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.groups_operations.GroupsOperations.add_owner + name: add_owner + summary: Add an owner to a group. + signature: add_owner(object_id, url, additional_properties=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: object_id + description: 'The object ID of the application to which to add the + + owner.' + isRequired: true + types: + - + - name: url + description: 'A owner object URL, such as + + "[https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd](https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd)", + + where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and + + "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the owner + + (user, application, servicePrincipal, group) to be added.' + isRequired: true + types: + - + - name: additional_properties + description: 'Unmatched properties from the message + + are deserialized this collection' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.groups_operations.GroupsOperations.create + name: create + summary: Create a group in the directory. + signature: create(parameters, custom_headers=None, raw=False, **operation_config) + parameters: + - name: parameters + description: The parameters for the group to create. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ADGroup or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.groups_operations.GroupsOperations.delete + name: delete + summary: Delete a group from the directory. + signature: delete(object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: The object ID of the group to delete. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.groups_operations.GroupsOperations.get + name: get + summary: Gets group information from the directory. + signature: get(object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: 'The object ID of the user for which to get group + + information.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ADGroup or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.groups_operations.GroupsOperations.get_group_members + name: get_group_members + summary: Gets the members of a group. + signature: get_group_members(object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: 'The object ID of the group whose members should be + + retrieved.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DirectoryObject + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.groups_operations.GroupsOperations.get_member_groups + name: get_member_groups + summary: 'Gets a collection of object IDs of groups of which the specified group + + is a member.' + signature: get_member_groups(object_id, security_enabled_only, additional_properties=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: 'The object ID of the group for which to get group + + membership.' + isRequired: true + types: + - + - name: security_enabled_only + description: 'If true, only membership in + + security-enabled groups should be checked. Otherwise, membership in + + all groups should be checked.' + isRequired: true + types: + - + - name: additional_properties + description: 'Unmatched properties from the message + + are deserialized this collection' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of str + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.groups_operations.GroupsOperations.is_member_of + name: is_member_of + summary: 'Checks whether the specified user, group, contact, or service principal + + is a direct or transitive member of the specified group.' + signature: is_member_of(parameters, custom_headers=None, raw=False, **operation_config) + parameters: + - name: parameters + description: The check group membership parameters. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CheckGroupMembershipResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.groups_operations.GroupsOperations.list + name: list + summary: Gets list of groups for the current tenant. + signature: list(filter=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: filter + description: The filter to apply to the operation. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of ADGroup + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.groups_operations.GroupsOperations.list_owners + name: list_owners + summary: 'Directory objects that are owners of the group. + + + The owners are a set of non-admin users who are allowed to modify this + + object.' + signature: list_owners(object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: The object ID of the group for which to get owners. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DirectoryObject + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.groups_operations.GroupsOperations.remove_member + name: remove_member + summary: Remove a member from a group. + signature: remove_member(group_object_id, member_object_id, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: group_object_id + description: 'The object ID of the group from which to + + remove the member.' + isRequired: true + types: + - + - name: member_object_id + description: Member object id + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.groups_operations.GroupsOperations.remove_owner + name: remove_owner + summary: Remove a member from owners. + signature: remove_owner(object_id, owner_object_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: object_id + description: 'The object ID of the group from which to remove the + + owner.' + isRequired: true + types: + - + - name: owner_object_id + description: Owner object id + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +attributes: +- uid: azure.graphrbac.operations.groups_operations.GroupsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.groups_operations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.groups_operations.yml new file mode 100644 index 00000000..f406419f --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.groups_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.operations.groups_operations +name: groups_operations +fullName: azure.graphrbac.operations.groups_operations +classes: +- azure.graphrbac.operations.groups_operations.GroupsOperations diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.oauth2_permission_grant_operations.OAuth2PermissionGrantOperations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.oauth2_permission_grant_operations.OAuth2PermissionGrantOperations.yml new file mode 100644 index 00000000..d5927a62 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.oauth2_permission_grant_operations.OAuth2PermissionGrantOperations.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.operations.oauth2_permission_grant_operations.OAuth2PermissionGrantOperations +name: OAuth2PermissionGrantOperations +fullName: azure.graphrbac.operations.oauth2_permission_grant_operations.OAuth2PermissionGrantOperations +module: azure.graphrbac.operations.oauth2_permission_grant_operations +summary: OAuth2PermissionGrantOperations operations. +constructor: + syntax: OAuth2PermissionGrantOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'Client API version. Constant value: "1.6".' + name: api_version +methods: +- uid: azure.graphrbac.operations.oauth2_permission_grant_operations.OAuth2PermissionGrantOperations.create + name: create + summary: Grants OAuth2 permissions for the relevant resource Ids of an app. + signature: create(body=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: body + description: 'The relevant app Service Principal Object Id and the + + Service Principal Object Id you want to grant.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: OAuth2PermissionGrant or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.graphrbac.operations.oauth2_permission_grant_operations.OAuth2PermissionGrantOperations.delete + name: delete + summary: 'Delete a OAuth2 permission grant for the relevant resource Ids of an + + app.' + signature: delete(object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: The object ID of a permission grant. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.oauth2_permission_grant_operations.OAuth2PermissionGrantOperations.list + name: list + summary: 'Queries OAuth2 permissions grants for the relevant SP ObjectId of an + + app.' + signature: list(filter=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: filter + description: 'This is the Service Principal ObjectId associated with + + the app' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of OAuth2PermissionGrant + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.graphrbac.operations.oauth2_permission_grant_operations.OAuth2PermissionGrantOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.oauth2_permission_grant_operations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.oauth2_permission_grant_operations.yml new file mode 100644 index 00000000..7852b301 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.oauth2_permission_grant_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.operations.oauth2_permission_grant_operations +name: oauth2_permission_grant_operations +fullName: azure.graphrbac.operations.oauth2_permission_grant_operations +classes: +- azure.graphrbac.operations.oauth2_permission_grant_operations.OAuth2PermissionGrantOperations diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.objects_operations.ObjectsOperations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.objects_operations.ObjectsOperations.yml new file mode 100644 index 00000000..dac2416d --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.objects_operations.ObjectsOperations.yml @@ -0,0 +1,67 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.operations.objects_operations.ObjectsOperations +name: ObjectsOperations +fullName: azure.graphrbac.operations.objects_operations.ObjectsOperations +module: azure.graphrbac.operations.objects_operations +summary: ObjectsOperations operations. +constructor: + syntax: ObjectsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'Client API version. Constant value: "1.6".' + name: api_version +methods: +- uid: azure.graphrbac.operations.objects_operations.ObjectsOperations.get_objects_by_object_ids + name: get_objects_by_object_ids + summary: 'Gets the directory objects specified in a list of object IDs. You can + + also specify which resource collections (users, groups, etc.) should be + + searched by specifying the optional types parameter.' + signature: get_objects_by_object_ids(parameters, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: parameters + description: Objects filtering parameters. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DirectoryObject + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.graphrbac.operations.objects_operations.ObjectsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.objects_operations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.objects_operations.yml new file mode 100644 index 00000000..a876def6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.objects_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.operations.objects_operations +name: objects_operations +fullName: azure.graphrbac.operations.objects_operations +classes: +- azure.graphrbac.operations.objects_operations.ObjectsOperations diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.service_principals_operations.ServicePrincipalsOperations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.service_principals_operations.ServicePrincipalsOperations.yml new file mode 100644 index 00000000..e4a9fac1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.service_principals_operations.ServicePrincipalsOperations.yml @@ -0,0 +1,396 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.operations.service_principals_operations.ServicePrincipalsOperations +name: ServicePrincipalsOperations +fullName: azure.graphrbac.operations.service_principals_operations.ServicePrincipalsOperations +module: azure.graphrbac.operations.service_principals_operations +summary: ServicePrincipalsOperations operations. +constructor: + syntax: ServicePrincipalsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'Client API version. Constant value: "1.6".' + name: api_version +methods: +- uid: azure.graphrbac.operations.service_principals_operations.ServicePrincipalsOperations.create + name: create + summary: Creates a service principal in the directory. + signature: create(parameters, custom_headers=None, raw=False, **operation_config) + parameters: + - name: parameters + description: Parameters to create a service principal. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ServicePrincipal or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.service_principals_operations.ServicePrincipalsOperations.delete + name: delete + summary: Deletes a service principal from the directory. + signature: delete(object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: The object ID of the service principal to delete. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.service_principals_operations.ServicePrincipalsOperations.get + name: get + summary: 'Gets service principal information from the directory. Query by + + objectId or pass a filter to query by appId.' + signature: get(object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: The object ID of the service principal to get. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: ServicePrincipal or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.service_principals_operations.ServicePrincipalsOperations.list + name: list + summary: Gets a list of service principals from the current tenant. + signature: list(filter=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: filter + description: The filter to apply to the operation. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of ServicePrincipal + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.service_principals_operations.ServicePrincipalsOperations.list_key_credentials + name: list_key_credentials + summary: Get the keyCredentials associated with the specified service principal. + signature: list_key_credentials(object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: 'The object ID of the service principal for which to + + get keyCredentials.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of KeyCredential + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.service_principals_operations.ServicePrincipalsOperations.list_owners + name: list_owners + summary: 'Directory objects that are owners of this service principal. + + + The owners are a set of non-admin users who are allowed to modify this + + object.' + signature: list_owners(object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: 'The object ID of the service principal for which to + + get owners.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DirectoryObject + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.service_principals_operations.ServicePrincipalsOperations.list_password_credentials + name: list_password_credentials + summary: Gets the passwordCredentials associated with a service principal. + signature: list_password_credentials(object_id, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: object_id + description: The object ID of the service principal. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of PasswordCredential + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.service_principals_operations.ServicePrincipalsOperations.update + name: update + summary: Updates a service principal in the directory. + signature: update(object_id, parameters, custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: The object ID of the service principal to delete. + isRequired: true + types: + - + - name: parameters + description: Parameters to update a service principal. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.service_principals_operations.ServicePrincipalsOperations.update_key_credentials + name: update_key_credentials + summary: Update the keyCredentials associated with a service principal. + signature: update_key_credentials(object_id, value, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: object_id + description: 'The object ID for which to get service principal + + information.' + isRequired: true + types: + - + - name: value + description: A collection of KeyCredentials. + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.service_principals_operations.ServicePrincipalsOperations.update_password_credentials + name: update_password_credentials + summary: Updates the passwordCredentials associated with a service principal. + signature: update_password_credentials(object_id, value, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: object_id + description: The object ID of the service principal. + isRequired: true + types: + - + - name: value + description: A collection of PasswordCredentials. + isRequired: true + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +attributes: +- uid: azure.graphrbac.operations.service_principals_operations.ServicePrincipalsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.service_principals_operations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.service_principals_operations.yml new file mode 100644 index 00000000..35edab45 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.service_principals_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.operations.service_principals_operations +name: service_principals_operations +fullName: azure.graphrbac.operations.service_principals_operations +classes: +- azure.graphrbac.operations.service_principals_operations.ServicePrincipalsOperations diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.signed_in_user_operations.SignedInUserOperations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.signed_in_user_operations.SignedInUserOperations.yml new file mode 100644 index 00000000..f9cff41c --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.signed_in_user_operations.SignedInUserOperations.yml @@ -0,0 +1,86 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.operations.signed_in_user_operations.SignedInUserOperations +name: SignedInUserOperations +fullName: azure.graphrbac.operations.signed_in_user_operations.SignedInUserOperations +module: azure.graphrbac.operations.signed_in_user_operations +summary: SignedInUserOperations operations. +constructor: + syntax: SignedInUserOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'Client API version. Constant value: "1.6".' + name: api_version +methods: +- uid: azure.graphrbac.operations.signed_in_user_operations.SignedInUserOperations.get + name: get + summary: Gets the details for the currently logged-in user. + signature: get(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: User or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.signed_in_user_operations.SignedInUserOperations.list_owned_objects + name: list_owned_objects + summary: Get the list of directory objects that are owned by the user. + signature: list_owned_objects(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DirectoryObject + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +attributes: +- uid: azure.graphrbac.operations.signed_in_user_operations.SignedInUserOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.signed_in_user_operations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.signed_in_user_operations.yml new file mode 100644 index 00000000..39a5b2f3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.signed_in_user_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.operations.signed_in_user_operations +name: signed_in_user_operations +fullName: azure.graphrbac.operations.signed_in_user_operations +classes: +- azure.graphrbac.operations.signed_in_user_operations.SignedInUserOperations diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.users_operations.UsersOperations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.users_operations.UsersOperations.yml new file mode 100644 index 00000000..6ca39d90 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.users_operations.UsersOperations.yml @@ -0,0 +1,264 @@ +### YamlMime:PythonClass +uid: azure.graphrbac.operations.users_operations.UsersOperations +name: UsersOperations +fullName: azure.graphrbac.operations.users_operations.UsersOperations +module: azure.graphrbac.operations.users_operations +summary: UsersOperations operations. +constructor: + syntax: UsersOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'Client API version. Constant value: "1.6".' + name: api_version +methods: +- uid: azure.graphrbac.operations.users_operations.UsersOperations.create + name: create + summary: Create a new user. + signature: create(parameters, custom_headers=None, raw=False, **operation_config) + parameters: + - name: parameters + description: Parameters to create a user. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: User or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.users_operations.UsersOperations.delete + name: delete + summary: Delete a user. + signature: delete(upn_or_object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: upn_or_object_id + description: 'The object ID or principal name of the user + + to delete.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.users_operations.UsersOperations.get + name: get + summary: Gets user information from the directory. + signature: get(upn_or_object_id, custom_headers=None, raw=False, **operation_config) + parameters: + - name: upn_or_object_id + description: 'The object ID or principal name of the user + + for which to get information.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: User or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.users_operations.UsersOperations.get_member_groups + name: get_member_groups + summary: 'Gets a collection that contains the object IDs of the groups of which + + the user is a member.' + signature: get_member_groups(object_id, security_enabled_only, additional_properties=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: object_id + description: 'The object ID of the user for which to get group + + membership.' + isRequired: true + types: + - + - name: security_enabled_only + description: 'If true, only membership in + + security-enabled groups should be checked. Otherwise, membership in + + all groups should be checked.' + isRequired: true + types: + - + - name: additional_properties + description: 'Unmatched properties from the message + + are deserialized this collection' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of str + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.users_operations.UsersOperations.list + name: list + summary: Gets list of users for the current tenant. + signature: list(filter=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: filter + description: The filter to apply to the operation. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of User + types: + - [] + exceptions: + - type: azure.graphrbac.models.GraphErrorException +- uid: azure.graphrbac.operations.users_operations.UsersOperations.update + name: update + summary: Updates a user. + signature: update(upn_or_object_id, parameters, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: upn_or_object_id + description: 'The object ID or principal name of the user + + to update.' + isRequired: true + types: + - + - name: parameters + description: Parameters to update an existing user. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.graphrbac.models.GraphErrorException +attributes: +- uid: azure.graphrbac.operations.users_operations.UsersOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.users_operations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.users_operations.yml new file mode 100644 index 00000000..a1daa423 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.users_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.operations.users_operations +name: users_operations +fullName: azure.graphrbac.operations.users_operations +classes: +- azure.graphrbac.operations.users_operations.UsersOperations diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.yml new file mode 100644 index 00000000..ce6f1a2e --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.operations.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonPackage +uid: azure.graphrbac.operations +name: operations +fullName: azure.graphrbac.operations +type: import +classes: +- azure.graphrbac.operations.ApplicationsOperations +- azure.graphrbac.operations.DeletedApplicationsOperations +- azure.graphrbac.operations.DomainsOperations +- azure.graphrbac.operations.GroupsOperations +- azure.graphrbac.operations.OAuth2PermissionGrantOperations +- azure.graphrbac.operations.ObjectsOperations +- azure.graphrbac.operations.ServicePrincipalsOperations +- azure.graphrbac.operations.SignedInUserOperations +- azure.graphrbac.operations.UsersOperations +modules: +- azure.graphrbac.operations.applications_operations +- azure.graphrbac.operations.deleted_applications_operations +- azure.graphrbac.operations.domains_operations +- azure.graphrbac.operations.groups_operations +- azure.graphrbac.operations.oauth2_permission_grant_operations +- azure.graphrbac.operations.objects_operations +- azure.graphrbac.operations.service_principals_operations +- azure.graphrbac.operations.signed_in_user_operations +- azure.graphrbac.operations.users_operations diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.version.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.version.yml new file mode 100644 index 00000000..dea954dd --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.graphrbac.version +name: version +fullName: azure.graphrbac.version diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.yml new file mode 100644 index 00000000..56d3ecb5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.graphrbac +name: graphrbac +fullName: azure.graphrbac +type: rootImport +classes: +- azure.graphrbac.GraphRbacManagementClient +packages: +- azure.graphrbac.models +- azure.graphrbac.operations +modules: +- azure.graphrbac.graph_rbac_management_client +- azure.graphrbac.version diff --git a/previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.ModelError.yml b/previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.ModelError.yml new file mode 100644 index 00000000..2bc85cfc --- /dev/null +++ b/previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.ModelError.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.iot.modelsrepository.ModelError +name: ModelError +fullName: azure.iot.modelsrepository.ModelError +module: azure.iot.modelsrepository +constructor: + syntax: ModelError() +methods: +- uid: azure.iot.modelsrepository.ModelError.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.iot.modelsrepository.ModelError.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.iot.modelsrepository.ModelError.args + name: args diff --git a/previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.ModelsRepositoryClient.yml b/previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.ModelsRepositoryClient.yml new file mode 100644 index 00000000..a2006b23 --- /dev/null +++ b/previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.ModelsRepositoryClient.yml @@ -0,0 +1,83 @@ +### YamlMime:PythonClass +uid: azure.iot.modelsrepository.ModelsRepositoryClient +name: ModelsRepositoryClient +fullName: azure.iot.modelsrepository.ModelsRepositoryClient +module: azure.iot.modelsrepository +summary: 'Client providing APIs for Models Repository operations + + + Create a client for working with the Azure IoT Models Repository. + + + For additional request configuration options, please see [core options](https://aka.ms/azsdk/python/options).' +constructor: + syntax: 'ModelsRepositoryClient(**kwargs: Any)' + keywordOnlyParameters: + - name: repository_location + description: 'Location of the Models Repository you wish to access. + + This location can be a remote HTTP/HTTPS URL, or a local filesystem path. + + If omitted, will default to using "[https://devicemodels.azure.com](https://devicemodels.azure.com)".' + types: + - + - name: dependency_resolution + description: "Dependency resolution mode.\nPossible values:\n\n* \"disabled\"\ + : Do not resolve model dependencies \n\n* \"enabled\": Resolve model dependencies\ + \ from the repository \n\n* \"tryFromExpanded\": Attempt to resolve model and\ + \ dependencies from an expanded\n\n model DTDL document in the repository.\ + \ If this is not successful, will fall\n back on manually resolving dependencies\ + \ in the repository.\n\nIf using the default repository location, the default\ + \ dependency resolution mode will\nbe \"tryFromExpanded\". If using a custom\ + \ repository location, the default dependency\nresolution mode will be \"enabled\"\ + ." + types: + - + - name: api_version + description: 'The API version for the Models Repository Service you wish to + + access.' + types: + - +methods: +- uid: azure.iot.modelsrepository.ModelsRepositoryClient.close + name: close + summary: Close the client, preventing future operations + signature: close() -> None +- uid: azure.iot.modelsrepository.ModelsRepositoryClient.get_models + name: get_models + summary: Retrieve a model from the Models Repository. + signature: 'get_models(dtmis: List[str] | str, **kwargs: Any) -> Dict[str, Any]' + parameters: + - name: dtmis + description: The DTMI(s) for the model(s) you wish to retrieve + isRequired: true + types: + - + - [] + keywordOnlyParameters: + - name: dependency_resolution + description: "Dependency resolution mode override. This value takes\nprecedence\ + \ over the value set on the client.\nPossible values:\n\n* \"disabled\": Do\ + \ not resolve model dependencies \n\n* \"enabled\": Resolve model dependencies\ + \ from the repository \n\n* \"tryFromExpanded\": Attempt to resolve model and\ + \ dependencies from an expanded\n\n model DTDL document in the repository.\ + \ If this is not successful, will fall\n back on manually resolving dependencies\ + \ in the repository" + types: + - + return: + description: Dictionary mapping DTMIs to models + types: + - + exceptions: + - type: ValueError if given an invalid dependency resolution mode + - type: () + - type: '()' + - type: () + - type: '()' + - type: azure.core.exceptions.HttpResponseError if a failure response is received diff --git a/previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.dtmi_conventions.yml b/previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.dtmi_conventions.yml new file mode 100644 index 00000000..edf5d57d --- /dev/null +++ b/previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.dtmi_conventions.yml @@ -0,0 +1,45 @@ +### YamlMime:PythonModule +uid: azure.iot.modelsrepository.dtmi_conventions +name: dtmi_conventions +fullName: azure.iot.modelsrepository.dtmi_conventions +functions: +- uid: azure.iot.modelsrepository.dtmi_conventions.get_model_uri + name: get_model_uri + summary: Get the URI representing the absolute location of a model in a Models Repository + signature: get_model_uri(dtmi, repository_uri, expanded=False) + parameters: + - name: dtmi + description: DTMI for a model + isRequired: true + types: + - + - name: repository_uri + description: URI for a Models Repository + isRequired: true + types: + - + - name: expanded + description: 'Indicates if the URI should be for an expanded model (Default: False)' + defaultValue: 'False' + types: + - + return: + description: The URI for the model in the Models Repository + types: + - + exceptions: + - type: ValueError if given an invalid DTMI +- uid: azure.iot.modelsrepository.dtmi_conventions.is_valid_dtmi + name: is_valid_dtmi + summary: Checks validity of a DTMI + signature: is_valid_dtmi(dtmi) + parameters: + - name: dtmi + description: DTMI + isRequired: true + types: + - + return: + description: Boolean indicating if DTMI is valid + types: + - diff --git a/previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.exceptions.ModelError.yml b/previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.exceptions.ModelError.yml new file mode 100644 index 00000000..be33dbb5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.exceptions.ModelError.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.iot.modelsrepository.exceptions.ModelError +name: ModelError +fullName: azure.iot.modelsrepository.exceptions.ModelError +module: azure.iot.modelsrepository.exceptions +constructor: + syntax: ModelError() +methods: +- uid: azure.iot.modelsrepository.exceptions.ModelError.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.iot.modelsrepository.exceptions.ModelError.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.iot.modelsrepository.exceptions.ModelError.args + name: args diff --git a/previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.exceptions.yml b/previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.exceptions.yml new file mode 100644 index 00000000..44e25803 --- /dev/null +++ b/previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.exceptions.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.iot.modelsrepository.exceptions +name: exceptions +fullName: azure.iot.modelsrepository.exceptions +classes: +- azure.iot.modelsrepository.exceptions.ModelError diff --git a/previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.yml b/previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.yml new file mode 100644 index 00000000..3d81d666 --- /dev/null +++ b/previous/docs-ref-autogen/azure-iot-modelsrepository/azure.iot.modelsrepository.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonPackage +uid: azure.iot.modelsrepository +name: modelsrepository +fullName: azure.iot.modelsrepository +type: rootImport +classes: +- azure.iot.modelsrepository.ModelError +- azure.iot.modelsrepository.ModelsRepositoryClient +modules: +- azure.iot.modelsrepository.dtmi_conventions +- azure.iot.modelsrepository.exceptions diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.AccessToken.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.AccessToken.yml new file mode 100644 index 00000000..d047c6af --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.AccessToken.yml @@ -0,0 +1,49 @@ +### YamlMime:PythonClass +uid: azure.keyvault.AccessToken +name: AccessToken +fullName: azure.keyvault.AccessToken +module: azure.keyvault +summary: Create new instance of AccessToken(scheme, token, key) +constructor: + syntax: AccessToken(scheme, token, key) + parameters: + - name: _cls + isRequired: true + - name: scheme + defaultValue: Bearer + - name: token + defaultValue: None + - name: key + defaultValue: None +methods: +- uid: azure.keyvault.AccessToken.count + name: count + summary: Return number of occurrences of value. + signature: count(value, /) + positionalOnlyParameters: + - name: value + isRequired: true +- uid: azure.keyvault.AccessToken.index + name: index + summary: 'Return first index of value. + + + Raises ValueError if the value is not present.' + signature: index(value, start=0, stop=9223372036854775807, /) + positionalOnlyParameters: + - name: value + isRequired: true + - name: start + defaultValue: '0' + - name: stop + defaultValue: '9223372036854775807' +attributes: +- uid: azure.keyvault.AccessToken.key + name: key + summary: Alias for field number 2 +- uid: azure.keyvault.AccessToken.scheme + name: scheme + summary: Alias for field number 0 +- uid: azure.keyvault.AccessToken.token + name: token + summary: Alias for field number 1 diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.CertificateId.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.CertificateId.yml new file mode 100644 index 00000000..df3b40c5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.CertificateId.yml @@ -0,0 +1,243 @@ +### YamlMime:PythonClass +uid: azure.keyvault.CertificateId +name: CertificateId +fullName: azure.keyvault.CertificateId +module: azure.keyvault +summary: 'Creates a key vault certificate id. If uri is specified the id properties + are parsed from the uri, otherwise + + builds the id from the specified vault, name and version. + + :param uri: The uri of the key vault certificate + + :param vault: The vault uri + + :param name: The certificate name + + :param version: The certificate version' +constructor: + syntax: CertificateId(uri=None, vault=None, name=None, version=None) + parameters: + - name: uri + defaultValue: None + - name: vault + defaultValue: None + - name: name + defaultValue: None + - name: version + defaultValue: None +methods: +- uid: azure.keyvault.CertificateId.create_certificate_id + name: create_certificate_id + signature: static create_certificate_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + - name: version + description: The certificate version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateId.create_certificate_issuer_id + name: create_certificate_issuer_id + signature: static create_certificate_issuer_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateId.create_certificate_operation_id + name: create_certificate_operation_id + signature: static create_certificate_operation_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateId.create_key_id + name: create_key_id + signature: static create_key_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The key name. + isRequired: true + types: + - + - name: version + description: The key version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateId.create_object_id + name: create_object_id + signature: static create_object_id(collection, vault, name, version) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: vault + description: The vault URI. + isRequired: true + types: + - + - name: name + description: The resource name. + isRequired: true + types: + - + - name: version + description: The resource version. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateId.create_secret_id + name: create_secret_id + signature: static create_secret_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The secret name. + isRequired: true + types: + - + - name: version + description: The secret version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateId.parse_certificate_id + name: parse_certificate_id + signature: static parse_certificate_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateId.parse_certificate_issuer_id + name: parse_certificate_issuer_id + signature: static parse_certificate_issuer_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateId.parse_certificate_operation_id + name: parse_certificate_operation_id + signature: static parse_certificate_operation_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateId.parse_key_id + name: parse_key_id + signature: static parse_key_id(id) + parameters: + - name: id + description: The key uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateId.parse_object_id + name: parse_object_id + signature: static parse_object_id(collection, id) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: id + description: The resource uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateId.parse_secret_id + name: parse_secret_id + signature: static parse_secret_id(id) + parameters: + - name: id + description: The secret uri. + isRequired: true + types: + - + return: + types: + - +attributes: +- uid: azure.keyvault.CertificateId.base_id + name: base_id + summary: The version-less key vault object identifier uri, +- uid: azure.keyvault.CertificateId.id + name: id + summary: The full key vault object identifier uri +- uid: azure.keyvault.CertificateId.version_none + name: version_none + signature: version_none = '' diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.CertificateIssuerId.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.CertificateIssuerId.yml new file mode 100644 index 00000000..1aee2483 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.CertificateIssuerId.yml @@ -0,0 +1,239 @@ +### YamlMime:PythonClass +uid: azure.keyvault.CertificateIssuerId +name: CertificateIssuerId +fullName: azure.keyvault.CertificateIssuerId +module: azure.keyvault +summary: 'Creates a key vault certificate issuer id. If uri is specified the id properties + are parsed from the uri, otherwise + + builds the id from the specified vault and name. + + :param uri: The uri of the key vault certificate issuer + + :param vault: The vault uri + + :param name: The certificate issuer name' +constructor: + syntax: CertificateIssuerId(uri=None, vault=None, name=None) + parameters: + - name: uri + defaultValue: None + - name: vault + defaultValue: None + - name: name + defaultValue: None +methods: +- uid: azure.keyvault.CertificateIssuerId.create_certificate_id + name: create_certificate_id + signature: static create_certificate_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + - name: version + description: The certificate version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateIssuerId.create_certificate_issuer_id + name: create_certificate_issuer_id + signature: static create_certificate_issuer_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateIssuerId.create_certificate_operation_id + name: create_certificate_operation_id + signature: static create_certificate_operation_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateIssuerId.create_key_id + name: create_key_id + signature: static create_key_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The key name. + isRequired: true + types: + - + - name: version + description: The key version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateIssuerId.create_object_id + name: create_object_id + signature: static create_object_id(collection, vault, name, version) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: vault + description: The vault URI. + isRequired: true + types: + - + - name: name + description: The resource name. + isRequired: true + types: + - + - name: version + description: The resource version. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateIssuerId.create_secret_id + name: create_secret_id + signature: static create_secret_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The secret name. + isRequired: true + types: + - + - name: version + description: The secret version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateIssuerId.parse_certificate_id + name: parse_certificate_id + signature: static parse_certificate_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateIssuerId.parse_certificate_issuer_id + name: parse_certificate_issuer_id + signature: static parse_certificate_issuer_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateIssuerId.parse_certificate_operation_id + name: parse_certificate_operation_id + signature: static parse_certificate_operation_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateIssuerId.parse_key_id + name: parse_key_id + signature: static parse_key_id(id) + parameters: + - name: id + description: The key uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateIssuerId.parse_object_id + name: parse_object_id + signature: static parse_object_id(collection, id) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: id + description: The resource uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateIssuerId.parse_secret_id + name: parse_secret_id + signature: static parse_secret_id(id) + parameters: + - name: id + description: The secret uri. + isRequired: true + types: + - + return: + types: + - +attributes: +- uid: azure.keyvault.CertificateIssuerId.base_id + name: base_id + summary: The version-less key vault object identifier uri, +- uid: azure.keyvault.CertificateIssuerId.id + name: id + summary: The full key vault object identifier uri +- uid: azure.keyvault.CertificateIssuerId.version_none + name: version_none + signature: version_none = '' diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.CertificateOperationId.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.CertificateOperationId.yml new file mode 100644 index 00000000..ef25ec27 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.CertificateOperationId.yml @@ -0,0 +1,239 @@ +### YamlMime:PythonClass +uid: azure.keyvault.CertificateOperationId +name: CertificateOperationId +fullName: azure.keyvault.CertificateOperationId +module: azure.keyvault +summary: 'Creates a key vault certificate operation id. If uri is specified the id + properties are parsed from the uri, otherwise + + builds the id from the specified vault and name. + + :param uri: The uri of the key vault certificate operation + + :param vault: The vault uri + + :param name: The certificate name' +constructor: + syntax: CertificateOperationId(uri=None, vault=None, name=None) + parameters: + - name: uri + defaultValue: None + - name: vault + defaultValue: None + - name: name + defaultValue: None +methods: +- uid: azure.keyvault.CertificateOperationId.create_certificate_id + name: create_certificate_id + signature: static create_certificate_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + - name: version + description: The certificate version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateOperationId.create_certificate_issuer_id + name: create_certificate_issuer_id + signature: static create_certificate_issuer_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateOperationId.create_certificate_operation_id + name: create_certificate_operation_id + signature: static create_certificate_operation_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateOperationId.create_key_id + name: create_key_id + signature: static create_key_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The key name. + isRequired: true + types: + - + - name: version + description: The key version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateOperationId.create_object_id + name: create_object_id + signature: static create_object_id(collection, vault, name, version) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: vault + description: The vault URI. + isRequired: true + types: + - + - name: name + description: The resource name. + isRequired: true + types: + - + - name: version + description: The resource version. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateOperationId.create_secret_id + name: create_secret_id + signature: static create_secret_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The secret name. + isRequired: true + types: + - + - name: version + description: The secret version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateOperationId.parse_certificate_id + name: parse_certificate_id + signature: static parse_certificate_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateOperationId.parse_certificate_issuer_id + name: parse_certificate_issuer_id + signature: static parse_certificate_issuer_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateOperationId.parse_certificate_operation_id + name: parse_certificate_operation_id + signature: static parse_certificate_operation_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateOperationId.parse_key_id + name: parse_key_id + signature: static parse_key_id(id) + parameters: + - name: id + description: The key uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateOperationId.parse_object_id + name: parse_object_id + signature: static parse_object_id(collection, id) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: id + description: The resource uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.CertificateOperationId.parse_secret_id + name: parse_secret_id + signature: static parse_secret_id(id) + parameters: + - name: id + description: The secret uri. + isRequired: true + types: + - + return: + types: + - +attributes: +- uid: azure.keyvault.CertificateOperationId.base_id + name: base_id + summary: The version-less key vault object identifier uri, +- uid: azure.keyvault.CertificateOperationId.id + name: id + summary: The full key vault object identifier uri +- uid: azure.keyvault.CertificateOperationId.version_none + name: version_none + signature: version_none = '' diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.HttpBearerChallenge.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.HttpBearerChallenge.yml new file mode 100644 index 00000000..dc58719c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.HttpBearerChallenge.yml @@ -0,0 +1,44 @@ +### YamlMime:PythonClass +uid: azure.keyvault.HttpBearerChallenge +name: HttpBearerChallenge +fullName: azure.keyvault.HttpBearerChallenge +module: azure.keyvault +summary: Parses an HTTP WWW-Authentication Bearer challenge from a server. +constructor: + syntax: HttpBearerChallenge(request_uri, challenge) + parameters: + - name: request_uri + isRequired: true + - name: challenge + isRequired: true +methods: +- uid: azure.keyvault.HttpBearerChallenge.get_authorization_server + name: get_authorization_server + summary: Returns the URI for the authorization server if present, otherwise empty + string. + signature: get_authorization_server() +- uid: azure.keyvault.HttpBearerChallenge.get_resource + name: get_resource + summary: Returns the resource if present, otherwise empty string. + signature: get_resource() +- uid: azure.keyvault.HttpBearerChallenge.get_scope + name: get_scope + summary: Returns the scope if present, otherwise empty string. + signature: get_scope() +- uid: azure.keyvault.HttpBearerChallenge.get_value + name: get_value + signature: get_value(key) + parameters: + - name: key + isRequired: true +- uid: azure.keyvault.HttpBearerChallenge.is_bearer_challenge + name: is_bearer_challenge + summary: 'Tests whether an authentication header is a Bearer challenge. + + :param authentication_header: the authentication header to test + + rtype: bool' + signature: static is_bearer_challenge(authentication_header) + parameters: + - name: authentication_header + isRequired: true diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.HttpChallenge.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.HttpChallenge.yml new file mode 100644 index 00000000..72f4b265 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.HttpChallenge.yml @@ -0,0 +1,55 @@ +### YamlMime:PythonClass +uid: azure.keyvault.HttpChallenge +name: HttpChallenge +fullName: azure.keyvault.HttpChallenge +module: azure.keyvault +summary: Parses an HTTP WWW-Authentication Bearer challenge from a server. +constructor: + syntax: HttpChallenge(request_uri, challenge, response_headers=None) + parameters: + - name: request_uri + isRequired: true + - name: challenge + isRequired: true + - name: response_headers + defaultValue: None +methods: +- uid: azure.keyvault.HttpChallenge.get_authorization_server + name: get_authorization_server + summary: Returns the URI for the authorization server if present, otherwise empty + string. + signature: get_authorization_server() +- uid: azure.keyvault.HttpChallenge.get_resource + name: get_resource + summary: Returns the resource if present, otherwise empty string. + signature: get_resource() +- uid: azure.keyvault.HttpChallenge.get_scope + name: get_scope + summary: Returns the scope if present, otherwise empty string. + signature: get_scope() +- uid: azure.keyvault.HttpChallenge.get_value + name: get_value + signature: get_value(key) + parameters: + - name: key + isRequired: true +- uid: azure.keyvault.HttpChallenge.is_bearer_challenge + name: is_bearer_challenge + summary: 'Tests whether the HttpChallenge a Bearer challenge. + + rtype: bool' + signature: is_bearer_challenge() +- uid: azure.keyvault.HttpChallenge.is_pop_challenge + name: is_pop_challenge + summary: 'Tests whether the HttpChallenge is a proof of possession challenge. + + rtype: bool' + signature: is_pop_challenge() +- uid: azure.keyvault.HttpChallenge.supports_message_protection + name: supports_message_protection + summary: Returns True if challenge vault supports message protection + signature: supports_message_protection() +- uid: azure.keyvault.HttpChallenge.supports_pop + name: supports_pop + summary: Returns True if challenge supports pop token auth else False + signature: supports_pop() diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.KeyId.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.KeyId.yml new file mode 100644 index 00000000..be7b3ead --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.KeyId.yml @@ -0,0 +1,243 @@ +### YamlMime:PythonClass +uid: azure.keyvault.KeyId +name: KeyId +fullName: azure.keyvault.KeyId +module: azure.keyvault +summary: 'Creates a key vault key id. If uri is specified the id properties are parsed + from the uri, otherwise + + builds the id from the specified vault, name and version. + + :param uri: The uri of the key vault key + + :param vault: The vault uri + + :param name: The key name + + :param version: The key version' +constructor: + syntax: KeyId(uri=None, vault=None, name=None, version=None) + parameters: + - name: uri + defaultValue: None + - name: vault + defaultValue: None + - name: name + defaultValue: None + - name: version + defaultValue: None +methods: +- uid: azure.keyvault.KeyId.create_certificate_id + name: create_certificate_id + signature: static create_certificate_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + - name: version + description: The certificate version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.KeyId.create_certificate_issuer_id + name: create_certificate_issuer_id + signature: static create_certificate_issuer_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.KeyId.create_certificate_operation_id + name: create_certificate_operation_id + signature: static create_certificate_operation_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.KeyId.create_key_id + name: create_key_id + signature: static create_key_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The key name. + isRequired: true + types: + - + - name: version + description: The key version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.KeyId.create_object_id + name: create_object_id + signature: static create_object_id(collection, vault, name, version) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: vault + description: The vault URI. + isRequired: true + types: + - + - name: name + description: The resource name. + isRequired: true + types: + - + - name: version + description: The resource version. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.KeyId.create_secret_id + name: create_secret_id + signature: static create_secret_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The secret name. + isRequired: true + types: + - + - name: version + description: The secret version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.KeyId.parse_certificate_id + name: parse_certificate_id + signature: static parse_certificate_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.KeyId.parse_certificate_issuer_id + name: parse_certificate_issuer_id + signature: static parse_certificate_issuer_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.KeyId.parse_certificate_operation_id + name: parse_certificate_operation_id + signature: static parse_certificate_operation_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.KeyId.parse_key_id + name: parse_key_id + signature: static parse_key_id(id) + parameters: + - name: id + description: The key uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.KeyId.parse_object_id + name: parse_object_id + signature: static parse_object_id(collection, id) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: id + description: The resource uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.KeyId.parse_secret_id + name: parse_secret_id + signature: static parse_secret_id(id) + parameters: + - name: id + description: The secret uri. + isRequired: true + types: + - + return: + types: + - +attributes: +- uid: azure.keyvault.KeyId.base_id + name: base_id + summary: The version-less key vault object identifier uri, +- uid: azure.keyvault.KeyId.id + name: id + summary: The full key vault object identifier uri +- uid: azure.keyvault.KeyId.version_none + name: version_none + signature: version_none = '' diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.KeyVaultAuthBase.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.KeyVaultAuthBase.yml new file mode 100644 index 00000000..2ea0a3b4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.KeyVaultAuthBase.yml @@ -0,0 +1,19 @@ +### YamlMime:PythonClass +uid: azure.keyvault.KeyVaultAuthBase +name: KeyVaultAuthBase +fullName: azure.keyvault.KeyVaultAuthBase +module: azure.keyvault +summary: "Used for handling authentication challenges, by hooking into the request\ + \ AuthBase extension model.\n\nCreates a new KeyVaultAuthBase instance used for\ + \ handling authentication challenges, by hooking into the request AuthBase\nextension\ + \ model.\n:param authorization_callback: A callback used to provide authentication\ + \ credentials to the key vault data service.\nThis callback should take four str\ + \ arguments: authorization uri, resource, scope, and scheme, and return\nan AccessToken\n\ + \n return AccessToken(scheme=token['token_type'], token=token['access_token'])\n\ + \nNote: for backward compatibility a tuple of the scheme and token can also be returned.\n\ + \ return token['token_type'], token['access_token']" +constructor: + syntax: KeyVaultAuthBase(authorization_callback) + parameters: + - name: authorization_callback + isRequired: true diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.KeyVaultAuthentication.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.KeyVaultAuthentication.yml new file mode 100644 index 00000000..f8a0a4a1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.KeyVaultAuthentication.yml @@ -0,0 +1,60 @@ +### YamlMime:PythonClass +uid: azure.keyvault.KeyVaultAuthentication +name: KeyVaultAuthentication +fullName: azure.keyvault.KeyVaultAuthentication +module: azure.keyvault +summary: "Authentication class to be used as credentials for the KeyVaultClient.\n\ + :Example Usage:\n\n def auth_callack(server, resource, scope):\n self.data_creds\ + \ = self.data_creds or ServicePrincipalCredentials(client_id=self.config.client_id,\n\ + \ secret=self.config.client_secret,\n tenant=self.config.tenant_id,\n\ + \ resource=resource)\n\n token = self.data_creds.token\n return\ + \ token['token_type'], token['access_token']\n\n self.keyvault_data_client = KeyVaultClient(KeyVaultAuthentication(auth_callack))\n\ + \nCreates a new KeyVaultAuthentication instance used for authentication in the KeyVaultClient\n\ + :param authorization_callback: A callback used to provide authentication credentials\ + \ to the key vault data service.\nThis callback should take three str arguments:\ + \ authorization uri, resource, and scope, and return\na tuple of (token type, access\ + \ token).\n:param credentials:: Credentials needed for the client to connect to\ + \ Azure.\n:type credentials: :mod:>>`<`" +constructor: + syntax: KeyVaultAuthentication(authorization_callback=None, credentials=None) + parameters: + - name: authorization_callback + defaultValue: None + - name: credentials + defaultValue: None +methods: +- uid: azure.keyvault.KeyVaultAuthentication.construct_auth + name: construct_auth + summary: Format token header. + signature: construct_auth() -> str + return: + types: + - +- uid: azure.keyvault.KeyVaultAuthentication.refresh_session + name: refresh_session + summary: 'Return updated session if token has expired, attempts to + + refresh using refresh token.' + signature: refresh_session() + return: + types: + - +- uid: azure.keyvault.KeyVaultAuthentication.set_token + name: set_token + summary: 'Should be used to define the self.token attribute. + + + In this implementation, does nothing since the token is statically provided + + at creation.' + signature: set_token() -> None +- uid: azure.keyvault.KeyVaultAuthentication.signed_session + name: signed_session + signature: signed_session(session=None) + parameters: + - name: session + defaultValue: None +attributes: +- uid: azure.keyvault.KeyVaultAuthentication.header + name: header + signature: header = 'Authorization' diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.KeyVaultClient.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.KeyVaultClient.yml new file mode 100644 index 00000000..44626026 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.KeyVaultClient.yml @@ -0,0 +1,89 @@ +### YamlMime:PythonClass +uid: azure.keyvault.KeyVaultClient +name: KeyVaultClient +fullName: azure.keyvault.KeyVaultClient +module: azure.keyvault +summary: "The key vault client performs cryptographic key operations and vault operations\ + \ against the Key Vault service.\nImplementation depends on the API version:\n\n\ + \ * 2016-10-01: \n\n * 7.0:\ + \ " +constructor: + syntax: KeyVaultClient(credentials, api_version=None, profile=KnownProfiles.default) + parameters: + - name: credentials + description: Credentials needed for the client to connect to Azure. + isRequired: true + types: + - + - name: api_version + description: 'API version to use if no profile is provided, or if + + missing in profile.' + defaultValue: None + types: + - + - name: profile + description: A profile definition, from KnownProfiles to dict. + defaultValue: KnownProfiles.default + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +methods: +- uid: azure.keyvault.KeyVaultClient.get_pending_certificate_signing_request + name: get_pending_certificate_signing_request + summary: Gets the Base64 pending certificate signing request (PKCS-10). + signature: get_pending_certificate_signing_request(vault_base_url, certificate_name, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, e.g. + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net)' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Base64 encoded pending certificate signing request (PKCS-10). + types: + - + - = +attributes: +- uid: azure.keyvault.KeyVaultClient.models + name: models + summary: 'Module depends on the API version: + + * 2016-10-01: + + * 7.0: ' +- uid: azure.keyvault.KeyVaultClient.DEFAULT_API_VERSION + name: DEFAULT_API_VERSION + signature: DEFAULT_API_VERSION = '7.0' +- uid: azure.keyvault.KeyVaultClient.LATEST_PROFILE + name: LATEST_PROFILE + signature: LATEST_PROFILE = azure.keyvault.KeyVaultClient latest diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.KeyVaultId.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.KeyVaultId.yml new file mode 100644 index 00000000..456cbedd --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.KeyVaultId.yml @@ -0,0 +1,242 @@ +### YamlMime:PythonClass +uid: azure.keyvault.KeyVaultId +name: KeyVaultId +fullName: azure.keyvault.KeyVaultId +module: azure.keyvault +summary: An identifier for an Azure Key Vault resource. +constructor: + syntax: KeyVaultId(collection, vault, name, version) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: vault + description: The vault URI. + isRequired: true + types: + - + - name: name + description: The resource name. + isRequired: true + types: + - + - name: version + description: The resource version. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.KeyVaultId.create_certificate_id + name: create_certificate_id + signature: static create_certificate_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + - name: version + description: The certificate version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.KeyVaultId.create_certificate_issuer_id + name: create_certificate_issuer_id + signature: static create_certificate_issuer_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.KeyVaultId.create_certificate_operation_id + name: create_certificate_operation_id + signature: static create_certificate_operation_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.KeyVaultId.create_key_id + name: create_key_id + signature: static create_key_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The key name. + isRequired: true + types: + - + - name: version + description: The key version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.KeyVaultId.create_object_id + name: create_object_id + signature: static create_object_id(collection, vault, name, version) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: vault + description: The vault URI. + isRequired: true + types: + - + - name: name + description: The resource name. + isRequired: true + types: + - + - name: version + description: The resource version. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.KeyVaultId.create_secret_id + name: create_secret_id + signature: static create_secret_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The secret name. + isRequired: true + types: + - + - name: version + description: The secret version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.KeyVaultId.parse_certificate_id + name: parse_certificate_id + signature: static parse_certificate_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.KeyVaultId.parse_certificate_issuer_id + name: parse_certificate_issuer_id + signature: static parse_certificate_issuer_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.KeyVaultId.parse_certificate_operation_id + name: parse_certificate_operation_id + signature: static parse_certificate_operation_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.KeyVaultId.parse_key_id + name: parse_key_id + signature: static parse_key_id(id) + parameters: + - name: id + description: The key uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.KeyVaultId.parse_object_id + name: parse_object_id + signature: static parse_object_id(collection, id) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: id + description: The resource uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.KeyVaultId.parse_secret_id + name: parse_secret_id + signature: static parse_secret_id(id) + parameters: + - name: id + description: The secret uri. + isRequired: true + types: + - + return: + types: + - +attributes: +- uid: azure.keyvault.KeyVaultId.base_id + name: base_id +- uid: azure.keyvault.KeyVaultId.id + name: id +- uid: azure.keyvault.KeyVaultId.version_none + name: version_none + signature: version_none = '' diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.SecretId.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.SecretId.yml new file mode 100644 index 00000000..f7d2d389 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.SecretId.yml @@ -0,0 +1,243 @@ +### YamlMime:PythonClass +uid: azure.keyvault.SecretId +name: SecretId +fullName: azure.keyvault.SecretId +module: azure.keyvault +summary: 'Creates a key vault secret id. If uri is specified the id properties are + parsed from the uri, otherwise + + builds the id from the specified vault, name and version. + + :param uri: The uri of the key vault secret + + :param vault: The vault uri + + :param name: The secret name + + :param version: The secret version' +constructor: + syntax: SecretId(uri=None, vault=None, name=None, version=None) + parameters: + - name: uri + defaultValue: None + - name: vault + defaultValue: None + - name: name + defaultValue: None + - name: version + defaultValue: None +methods: +- uid: azure.keyvault.SecretId.create_certificate_id + name: create_certificate_id + signature: static create_certificate_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + - name: version + description: The certificate version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.SecretId.create_certificate_issuer_id + name: create_certificate_issuer_id + signature: static create_certificate_issuer_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.SecretId.create_certificate_operation_id + name: create_certificate_operation_id + signature: static create_certificate_operation_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.SecretId.create_key_id + name: create_key_id + signature: static create_key_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The key name. + isRequired: true + types: + - + - name: version + description: The key version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.SecretId.create_object_id + name: create_object_id + signature: static create_object_id(collection, vault, name, version) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: vault + description: The vault URI. + isRequired: true + types: + - + - name: name + description: The resource name. + isRequired: true + types: + - + - name: version + description: The resource version. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.SecretId.create_secret_id + name: create_secret_id + signature: static create_secret_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The secret name. + isRequired: true + types: + - + - name: version + description: The secret version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.SecretId.parse_certificate_id + name: parse_certificate_id + signature: static parse_certificate_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.SecretId.parse_certificate_issuer_id + name: parse_certificate_issuer_id + signature: static parse_certificate_issuer_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.SecretId.parse_certificate_operation_id + name: parse_certificate_operation_id + signature: static parse_certificate_operation_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.SecretId.parse_key_id + name: parse_key_id + signature: static parse_key_id(id) + parameters: + - name: id + description: The key uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.SecretId.parse_object_id + name: parse_object_id + signature: static parse_object_id(collection, id) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: id + description: The resource uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.SecretId.parse_secret_id + name: parse_secret_id + signature: static parse_secret_id(id) + parameters: + - name: id + description: The secret uri. + isRequired: true + types: + - + return: + types: + - +attributes: +- uid: azure.keyvault.SecretId.base_id + name: base_id + summary: The version-less key vault object identifier uri, +- uid: azure.keyvault.SecretId.id + name: id + summary: The full key vault object identifier uri +- uid: azure.keyvault.SecretId.version_none + name: version_none + signature: version_none = '' diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.StorageAccountId.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.StorageAccountId.yml new file mode 100644 index 00000000..1fec40f3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.StorageAccountId.yml @@ -0,0 +1,239 @@ +### YamlMime:PythonClass +uid: azure.keyvault.StorageAccountId +name: StorageAccountId +fullName: azure.keyvault.StorageAccountId +module: azure.keyvault +summary: 'Creates a key vault storage account id. If uri is specified the id properties + are parsed from the uri, otherwise + + builds the id from the specified vault and name. + + :param uri: The uri of the key vault storage account + + :param vault: The vault uri + + :param name: The storage account name' +constructor: + syntax: StorageAccountId(uri=None, vault=None, name=None) + parameters: + - name: uri + defaultValue: None + - name: vault + defaultValue: None + - name: name + defaultValue: None +methods: +- uid: azure.keyvault.StorageAccountId.create_certificate_id + name: create_certificate_id + signature: static create_certificate_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + - name: version + description: The certificate version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.StorageAccountId.create_certificate_issuer_id + name: create_certificate_issuer_id + signature: static create_certificate_issuer_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.StorageAccountId.create_certificate_operation_id + name: create_certificate_operation_id + signature: static create_certificate_operation_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.StorageAccountId.create_key_id + name: create_key_id + signature: static create_key_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The key name. + isRequired: true + types: + - + - name: version + description: The key version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.StorageAccountId.create_object_id + name: create_object_id + signature: static create_object_id(collection, vault, name, version) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: vault + description: The vault URI. + isRequired: true + types: + - + - name: name + description: The resource name. + isRequired: true + types: + - + - name: version + description: The resource version. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.StorageAccountId.create_secret_id + name: create_secret_id + signature: static create_secret_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The secret name. + isRequired: true + types: + - + - name: version + description: The secret version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.StorageAccountId.parse_certificate_id + name: parse_certificate_id + signature: static parse_certificate_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.StorageAccountId.parse_certificate_issuer_id + name: parse_certificate_issuer_id + signature: static parse_certificate_issuer_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.StorageAccountId.parse_certificate_operation_id + name: parse_certificate_operation_id + signature: static parse_certificate_operation_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.StorageAccountId.parse_key_id + name: parse_key_id + signature: static parse_key_id(id) + parameters: + - name: id + description: The key uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.StorageAccountId.parse_object_id + name: parse_object_id + signature: static parse_object_id(collection, id) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: id + description: The resource uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.StorageAccountId.parse_secret_id + name: parse_secret_id + signature: static parse_secret_id(id) + parameters: + - name: id + description: The secret uri. + isRequired: true + types: + - + return: + types: + - +attributes: +- uid: azure.keyvault.StorageAccountId.base_id + name: base_id + summary: The version-less key vault object identifier uri, +- uid: azure.keyvault.StorageAccountId.id + name: id + summary: The full key vault object identifier uri +- uid: azure.keyvault.StorageAccountId.version_none + name: version_none + signature: version_none = '' diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.StorageSasDefinitionId.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.StorageSasDefinitionId.yml new file mode 100644 index 00000000..757e7bd8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.StorageSasDefinitionId.yml @@ -0,0 +1,243 @@ +### YamlMime:PythonClass +uid: azure.keyvault.StorageSasDefinitionId +name: StorageSasDefinitionId +fullName: azure.keyvault.StorageSasDefinitionId +module: azure.keyvault +summary: 'Creates a key vault storage account sas definition id. If uri is specified + the id properties are parsed from the uri, otherwise + + builds the id from the specified vault, account_name, and sas_definition. + + :param uri: The uri of the key vault storage account sas definition + + :param vault: The vault uri + + :param account_name: The storage account name + + :param sas_definition: The sas definition name' +constructor: + syntax: StorageSasDefinitionId(uri=None, vault=None, account_name=None, sas_definition=None) + parameters: + - name: uri + defaultValue: None + - name: vault + defaultValue: None + - name: account_name + defaultValue: None + - name: sas_definition + defaultValue: None +methods: +- uid: azure.keyvault.StorageSasDefinitionId.create_certificate_id + name: create_certificate_id + signature: static create_certificate_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + - name: version + description: The certificate version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.StorageSasDefinitionId.create_certificate_issuer_id + name: create_certificate_issuer_id + signature: static create_certificate_issuer_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.StorageSasDefinitionId.create_certificate_operation_id + name: create_certificate_operation_id + signature: static create_certificate_operation_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.StorageSasDefinitionId.create_key_id + name: create_key_id + signature: static create_key_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The key name. + isRequired: true + types: + - + - name: version + description: The key version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.StorageSasDefinitionId.create_object_id + name: create_object_id + signature: static create_object_id(collection, vault, name, version) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: vault + description: The vault URI. + isRequired: true + types: + - + - name: name + description: The resource name. + isRequired: true + types: + - + - name: version + description: The resource version. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.StorageSasDefinitionId.create_secret_id + name: create_secret_id + signature: static create_secret_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The secret name. + isRequired: true + types: + - + - name: version + description: The secret version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.StorageSasDefinitionId.parse_certificate_id + name: parse_certificate_id + signature: static parse_certificate_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.StorageSasDefinitionId.parse_certificate_issuer_id + name: parse_certificate_issuer_id + signature: static parse_certificate_issuer_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.StorageSasDefinitionId.parse_certificate_operation_id + name: parse_certificate_operation_id + signature: static parse_certificate_operation_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.StorageSasDefinitionId.parse_key_id + name: parse_key_id + signature: static parse_key_id(id) + parameters: + - name: id + description: The key uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.StorageSasDefinitionId.parse_object_id + name: parse_object_id + signature: static parse_object_id(collection, id) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: id + description: The resource uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.StorageSasDefinitionId.parse_secret_id + name: parse_secret_id + signature: static parse_secret_id(id) + parameters: + - name: id + description: The secret uri. + isRequired: true + types: + - + return: + types: + - +attributes: +- uid: azure.keyvault.StorageSasDefinitionId.base_id + name: base_id + summary: The version-less key vault object identifier uri, +- uid: azure.keyvault.StorageSasDefinitionId.id + name: id + summary: The full key vault object identifier uri +- uid: azure.keyvault.StorageSasDefinitionId.version_none + name: version_none + signature: version_none = '' diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_bearer_challenge.HttpBearerChallenge.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_bearer_challenge.HttpBearerChallenge.yml new file mode 100644 index 00000000..b96ffe35 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_bearer_challenge.HttpBearerChallenge.yml @@ -0,0 +1,44 @@ +### YamlMime:PythonClass +uid: azure.keyvault.http_bearer_challenge.HttpBearerChallenge +name: HttpBearerChallenge +fullName: azure.keyvault.http_bearer_challenge.HttpBearerChallenge +module: azure.keyvault.http_bearer_challenge +summary: Parses an HTTP WWW-Authentication Bearer challenge from a server. +constructor: + syntax: HttpBearerChallenge(request_uri, challenge) + parameters: + - name: request_uri + isRequired: true + - name: challenge + isRequired: true +methods: +- uid: azure.keyvault.http_bearer_challenge.HttpBearerChallenge.get_authorization_server + name: get_authorization_server + summary: Returns the URI for the authorization server if present, otherwise empty + string. + signature: get_authorization_server() +- uid: azure.keyvault.http_bearer_challenge.HttpBearerChallenge.get_resource + name: get_resource + summary: Returns the resource if present, otherwise empty string. + signature: get_resource() +- uid: azure.keyvault.http_bearer_challenge.HttpBearerChallenge.get_scope + name: get_scope + summary: Returns the scope if present, otherwise empty string. + signature: get_scope() +- uid: azure.keyvault.http_bearer_challenge.HttpBearerChallenge.get_value + name: get_value + signature: get_value(key) + parameters: + - name: key + isRequired: true +- uid: azure.keyvault.http_bearer_challenge.HttpBearerChallenge.is_bearer_challenge + name: is_bearer_challenge + summary: 'Tests whether an authentication header is a Bearer challenge. + + :param authentication_header: the authentication header to test + + rtype: bool' + signature: static is_bearer_challenge(authentication_header) + parameters: + - name: authentication_header + isRequired: true diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_bearer_challenge.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_bearer_challenge.yml new file mode 100644 index 00000000..4eac0da6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_bearer_challenge.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.http_bearer_challenge +name: http_bearer_challenge +fullName: azure.keyvault.http_bearer_challenge +classes: +- azure.keyvault.http_bearer_challenge.HttpBearerChallenge diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_bearer_challenge_cache.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_bearer_challenge_cache.yml new file mode 100644 index 00000000..f6ec9a27 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_bearer_challenge_cache.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonPackage +uid: azure.keyvault.http_bearer_challenge_cache +name: http_bearer_challenge_cache +fullName: azure.keyvault.http_bearer_challenge_cache +type: import +functions: +- uid: azure.keyvault.http_bearer_challenge_cache.clear + name: clear + summary: Clears the cache. + signature: clear() +- uid: azure.keyvault.http_bearer_challenge_cache.get_challenge_for_url + name: get_challenge_for_url + summary: 'Gets the challenge for the cached URL. + + :param url: the URL the challenge is cached for. + + :rtype: HttpBearerChallenge' + signature: get_challenge_for_url(url) + parameters: + - name: url + isRequired: true +- uid: azure.keyvault.http_bearer_challenge_cache.remove_challenge_for_url + name: remove_challenge_for_url + summary: 'Removes the cached challenge for the specified URL. + + :param url: the URL for which to remove the cached challenge' + signature: remove_challenge_for_url(url) + parameters: + - name: url + isRequired: true +- uid: azure.keyvault.http_bearer_challenge_cache.set_challenge_for_url + name: set_challenge_for_url + summary: 'Caches the challenge for the specified URL. + + :param url: the URL for which to cache the challenge + + :param challenge: the challenge to cache' + signature: set_challenge_for_url(url, challenge) + parameters: + - name: url + isRequired: true + - name: challenge + isRequired: true diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_challenge.HttpChallenge.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_challenge.HttpChallenge.yml new file mode 100644 index 00000000..fa4b03aa --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_challenge.HttpChallenge.yml @@ -0,0 +1,55 @@ +### YamlMime:PythonClass +uid: azure.keyvault.http_challenge.HttpChallenge +name: HttpChallenge +fullName: azure.keyvault.http_challenge.HttpChallenge +module: azure.keyvault.http_challenge +summary: Parses an HTTP WWW-Authentication Bearer challenge from a server. +constructor: + syntax: HttpChallenge(request_uri, challenge, response_headers=None) + parameters: + - name: request_uri + isRequired: true + - name: challenge + isRequired: true + - name: response_headers + defaultValue: None +methods: +- uid: azure.keyvault.http_challenge.HttpChallenge.get_authorization_server + name: get_authorization_server + summary: Returns the URI for the authorization server if present, otherwise empty + string. + signature: get_authorization_server() +- uid: azure.keyvault.http_challenge.HttpChallenge.get_resource + name: get_resource + summary: Returns the resource if present, otherwise empty string. + signature: get_resource() +- uid: azure.keyvault.http_challenge.HttpChallenge.get_scope + name: get_scope + summary: Returns the scope if present, otherwise empty string. + signature: get_scope() +- uid: azure.keyvault.http_challenge.HttpChallenge.get_value + name: get_value + signature: get_value(key) + parameters: + - name: key + isRequired: true +- uid: azure.keyvault.http_challenge.HttpChallenge.is_bearer_challenge + name: is_bearer_challenge + summary: 'Tests whether the HttpChallenge a Bearer challenge. + + rtype: bool' + signature: is_bearer_challenge() +- uid: azure.keyvault.http_challenge.HttpChallenge.is_pop_challenge + name: is_pop_challenge + summary: 'Tests whether the HttpChallenge is a proof of possession challenge. + + rtype: bool' + signature: is_pop_challenge() +- uid: azure.keyvault.http_challenge.HttpChallenge.supports_message_protection + name: supports_message_protection + summary: Returns True if challenge vault supports message protection + signature: supports_message_protection() +- uid: azure.keyvault.http_challenge.HttpChallenge.supports_pop + name: supports_pop + summary: Returns True if challenge supports pop token auth else False + signature: supports_pop() diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_challenge.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_challenge.yml new file mode 100644 index 00000000..b5e4be31 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_challenge.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.http_challenge +name: http_challenge +fullName: azure.keyvault.http_challenge +classes: +- azure.keyvault.http_challenge.HttpChallenge diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_message_security.HttpMessageSecurity.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_message_security.HttpMessageSecurity.yml new file mode 100644 index 00000000..45e2828b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_message_security.HttpMessageSecurity.yml @@ -0,0 +1,58 @@ +### YamlMime:PythonClass +uid: azure.keyvault.http_message_security.HttpMessageSecurity +name: HttpMessageSecurity +fullName: azure.keyvault.http_message_security.HttpMessageSecurity +module: azure.keyvault.http_message_security +summary: 'Used for message authorization, encryption and decrtyption. + + + This class is intended for internal use only. Details are subject to non-compatible + changes, consumers of the + + azure-keyvault module should not take dependencies on this class or its current + implementation.' +constructor: + syntax: HttpMessageSecurity(client_security_token=None, client_signature_key=None, + client_encryption_key=None, server_signature_key=None, server_encryption_key=None) + parameters: + - name: client_security_token + defaultValue: None + - name: client_signature_key + defaultValue: None + - name: client_encryption_key + defaultValue: None + - name: server_signature_key + defaultValue: None + - name: server_encryption_key + defaultValue: None +methods: +- uid: azure.keyvault.http_message_security.HttpMessageSecurity.protect_request + name: protect_request + summary: 'Adds authorization header, and encrypts and signs the request if supported + on the specific request. + + :param request: unprotected request to apply security protocol + + :return: protected request with appropriate security protocal applied' + signature: protect_request(request) + parameters: + - name: request + isRequired: true +- uid: azure.keyvault.http_message_security.HttpMessageSecurity.supports_protection + name: supports_protection + summary: 'Determines if the the current HttpMessageSecurity object supports the + message protection protocol. + + :return: True if the current object supports protection, otherwise False' + signature: supports_protection() +- uid: azure.keyvault.http_message_security.HttpMessageSecurity.unprotect_response + name: unprotect_response + summary: 'Removes protection from the specified response + + :param request: response from the key vault service + + :return: unprotected response with any security protocal encryption removed' + signature: unprotect_response(response, **kwargs) + parameters: + - name: response + isRequired: true diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_message_security.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_message_security.yml new file mode 100644 index 00000000..44c78fb8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.http_message_security.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonModule +uid: azure.keyvault.http_message_security +name: http_message_security +fullName: azure.keyvault.http_message_security +functions: +- uid: azure.keyvault.http_message_security.generate_pop_key + name: generate_pop_key + summary: 'Generates a key which can be used for Proof Of Possession token authentication. + + :return:' + signature: generate_pop_key() +classes: +- azure.keyvault.http_message_security.HttpMessageSecurity diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_authentication.AccessToken.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_authentication.AccessToken.yml new file mode 100644 index 00000000..29c8bcb9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_authentication.AccessToken.yml @@ -0,0 +1,49 @@ +### YamlMime:PythonClass +uid: azure.keyvault.key_vault_authentication.AccessToken +name: AccessToken +fullName: azure.keyvault.key_vault_authentication.AccessToken +module: azure.keyvault.key_vault_authentication +summary: Create new instance of AccessToken(scheme, token, key) +constructor: + syntax: AccessToken(scheme, token, key) + parameters: + - name: _cls + isRequired: true + - name: scheme + defaultValue: Bearer + - name: token + defaultValue: None + - name: key + defaultValue: None +methods: +- uid: azure.keyvault.key_vault_authentication.AccessToken.count + name: count + summary: Return number of occurrences of value. + signature: count(value, /) + positionalOnlyParameters: + - name: value + isRequired: true +- uid: azure.keyvault.key_vault_authentication.AccessToken.index + name: index + summary: 'Return first index of value. + + + Raises ValueError if the value is not present.' + signature: index(value, start=0, stop=9223372036854775807, /) + positionalOnlyParameters: + - name: value + isRequired: true + - name: start + defaultValue: '0' + - name: stop + defaultValue: '9223372036854775807' +attributes: +- uid: azure.keyvault.key_vault_authentication.AccessToken.key + name: key + summary: Alias for field number 2 +- uid: azure.keyvault.key_vault_authentication.AccessToken.scheme + name: scheme + summary: Alias for field number 0 +- uid: azure.keyvault.key_vault_authentication.AccessToken.token + name: token + summary: Alias for field number 1 diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_authentication.KeyVaultAuthBase.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_authentication.KeyVaultAuthBase.yml new file mode 100644 index 00000000..dedcee43 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_authentication.KeyVaultAuthBase.yml @@ -0,0 +1,19 @@ +### YamlMime:PythonClass +uid: azure.keyvault.key_vault_authentication.KeyVaultAuthBase +name: KeyVaultAuthBase +fullName: azure.keyvault.key_vault_authentication.KeyVaultAuthBase +module: azure.keyvault.key_vault_authentication +summary: "Used for handling authentication challenges, by hooking into the request\ + \ AuthBase extension model.\n\nCreates a new KeyVaultAuthBase instance used for\ + \ handling authentication challenges, by hooking into the request AuthBase\nextension\ + \ model.\n:param authorization_callback: A callback used to provide authentication\ + \ credentials to the key vault data service.\nThis callback should take four str\ + \ arguments: authorization uri, resource, scope, and scheme, and return\nan AccessToken\n\ + \n return AccessToken(scheme=token['token_type'], token=token['access_token'])\n\ + \nNote: for backward compatibility a tuple of the scheme and token can also be returned.\n\ + \ return token['token_type'], token['access_token']" +constructor: + syntax: KeyVaultAuthBase(authorization_callback) + parameters: + - name: authorization_callback + isRequired: true diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_authentication.KeyVaultAuthentication.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_authentication.KeyVaultAuthentication.yml new file mode 100644 index 00000000..f1f7d582 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_authentication.KeyVaultAuthentication.yml @@ -0,0 +1,60 @@ +### YamlMime:PythonClass +uid: azure.keyvault.key_vault_authentication.KeyVaultAuthentication +name: KeyVaultAuthentication +fullName: azure.keyvault.key_vault_authentication.KeyVaultAuthentication +module: azure.keyvault.key_vault_authentication +summary: "Authentication class to be used as credentials for the KeyVaultClient.\n\ + :Example Usage:\n\n def auth_callack(server, resource, scope):\n self.data_creds\ + \ = self.data_creds or ServicePrincipalCredentials(client_id=self.config.client_id,\n\ + \ secret=self.config.client_secret,\n tenant=self.config.tenant_id,\n\ + \ resource=resource)\n\n token = self.data_creds.token\n return\ + \ token['token_type'], token['access_token']\n\n self.keyvault_data_client = KeyVaultClient(KeyVaultAuthentication(auth_callack))\n\ + \nCreates a new KeyVaultAuthentication instance used for authentication in the KeyVaultClient\n\ + :param authorization_callback: A callback used to provide authentication credentials\ + \ to the key vault data service.\nThis callback should take three str arguments:\ + \ authorization uri, resource, and scope, and return\na tuple of (token type, access\ + \ token).\n:param credentials:: Credentials needed for the client to connect to\ + \ Azure.\n:type credentials: :mod:>>`<`" +constructor: + syntax: KeyVaultAuthentication(authorization_callback=None, credentials=None) + parameters: + - name: authorization_callback + defaultValue: None + - name: credentials + defaultValue: None +methods: +- uid: azure.keyvault.key_vault_authentication.KeyVaultAuthentication.construct_auth + name: construct_auth + summary: Format token header. + signature: construct_auth() -> str + return: + types: + - +- uid: azure.keyvault.key_vault_authentication.KeyVaultAuthentication.refresh_session + name: refresh_session + summary: 'Return updated session if token has expired, attempts to + + refresh using refresh token.' + signature: refresh_session() + return: + types: + - +- uid: azure.keyvault.key_vault_authentication.KeyVaultAuthentication.set_token + name: set_token + summary: 'Should be used to define the self.token attribute. + + + In this implementation, does nothing since the token is statically provided + + at creation.' + signature: set_token() -> None +- uid: azure.keyvault.key_vault_authentication.KeyVaultAuthentication.signed_session + name: signed_session + signature: signed_session(session=None) + parameters: + - name: session + defaultValue: None +attributes: +- uid: azure.keyvault.key_vault_authentication.KeyVaultAuthentication.header + name: header + signature: header = 'Authorization' diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_authentication.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_authentication.yml new file mode 100644 index 00000000..3562f43e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_authentication.yml @@ -0,0 +1,8 @@ +### YamlMime:PythonModule +uid: azure.keyvault.key_vault_authentication +name: key_vault_authentication +fullName: azure.keyvault.key_vault_authentication +classes: +- azure.keyvault.key_vault_authentication.AccessToken +- azure.keyvault.key_vault_authentication.KeyVaultAuthBase +- azure.keyvault.key_vault_authentication.KeyVaultAuthentication diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_client.KeyVaultClient.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_client.KeyVaultClient.yml new file mode 100644 index 00000000..7e8e0f14 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_client.KeyVaultClient.yml @@ -0,0 +1,89 @@ +### YamlMime:PythonClass +uid: azure.keyvault.key_vault_client.KeyVaultClient +name: KeyVaultClient +fullName: azure.keyvault.key_vault_client.KeyVaultClient +module: azure.keyvault.key_vault_client +summary: "The key vault client performs cryptographic key operations and vault operations\ + \ against the Key Vault service.\nImplementation depends on the API version:\n\n\ + \ * 2016-10-01: \n\n * 7.0:\ + \ " +constructor: + syntax: KeyVaultClient(credentials, api_version=None, profile=KnownProfiles.default) + parameters: + - name: credentials + description: Credentials needed for the client to connect to Azure. + isRequired: true + types: + - + - name: api_version + description: 'API version to use if no profile is provided, or if + + missing in profile.' + defaultValue: None + types: + - + - name: profile + description: A profile definition, from KnownProfiles to dict. + defaultValue: KnownProfiles.default + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +methods: +- uid: azure.keyvault.key_vault_client.KeyVaultClient.get_pending_certificate_signing_request + name: get_pending_certificate_signing_request + summary: Gets the Base64 pending certificate signing request (PKCS-10). + signature: get_pending_certificate_signing_request(vault_base_url, certificate_name, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, e.g. + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net)' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Base64 encoded pending certificate signing request (PKCS-10). + types: + - + - = +attributes: +- uid: azure.keyvault.key_vault_client.KeyVaultClient.models + name: models + summary: 'Module depends on the API version: + + * 2016-10-01: + + * 7.0: ' +- uid: azure.keyvault.key_vault_client.KeyVaultClient.DEFAULT_API_VERSION + name: DEFAULT_API_VERSION + signature: DEFAULT_API_VERSION = '7.0' +- uid: azure.keyvault.key_vault_client.KeyVaultClient.LATEST_PROFILE + name: LATEST_PROFILE + signature: LATEST_PROFILE = azure.keyvault.KeyVaultClient latest diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_client.KeyVaultClientConfiguration.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_client.KeyVaultClientConfiguration.yml new file mode 100644 index 00000000..d4467b22 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_client.KeyVaultClientConfiguration.yml @@ -0,0 +1,59 @@ +### YamlMime:PythonClass +uid: azure.keyvault.key_vault_client.KeyVaultClientConfiguration +name: KeyVaultClientConfiguration +fullName: azure.keyvault.key_vault_client.KeyVaultClientConfiguration +module: azure.keyvault.key_vault_client +summary: 'Configuration for KeyVaultClient + + Note that all parameters used to create this instance are saved as instance + + attributes.' +constructor: + syntax: KeyVaultClientConfiguration(credentials) + parameters: + - name: credentials + description: Credentials needed for the client to connect to Azure. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.key_vault_client.KeyVaultClientConfiguration.add_user_agent + name: add_user_agent + summary: Add value to current user agent with a space. + signature: 'add_user_agent(value: str) -> None' + parameters: + - name: value + description: value to add to user agent. + isRequired: true + types: + - +- uid: azure.keyvault.key_vault_client.KeyVaultClientConfiguration.load + name: load + summary: Load configuration from existing file. + signature: load(filepath) + parameters: + - name: filepath + description: Path to existing config file. + isRequired: true + types: + - + exceptions: + - type: ValueError if supplied config file is invalid. +- uid: azure.keyvault.key_vault_client.KeyVaultClientConfiguration.save + name: save + summary: Save current configuration to file. + signature: save(filepath) + parameters: + - name: filepath + description: Path to save file to. + isRequired: true + types: + - + exceptions: + - type: ValueError if supplied filepath cannot be written to. +attributes: +- uid: azure.keyvault.key_vault_client.KeyVaultClientConfiguration.enable_http_logger + name: enable_http_logger +- uid: azure.keyvault.key_vault_client.KeyVaultClientConfiguration.user_agent + name: user_agent + summary: The current user agent value. diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_client.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_client.yml new file mode 100644 index 00000000..3d9bf0ef --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_client.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.keyvault.key_vault_client +name: key_vault_client +fullName: azure.keyvault.key_vault_client +classes: +- azure.keyvault.key_vault_client.KeyVaultClient +- azure.keyvault.key_vault_client.KeyVaultClientConfiguration diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.CertificateId.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.CertificateId.yml new file mode 100644 index 00000000..80c04a80 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.CertificateId.yml @@ -0,0 +1,243 @@ +### YamlMime:PythonClass +uid: azure.keyvault.key_vault_id.CertificateId +name: CertificateId +fullName: azure.keyvault.key_vault_id.CertificateId +module: azure.keyvault.key_vault_id +summary: 'Creates a key vault certificate id. If uri is specified the id properties + are parsed from the uri, otherwise + + builds the id from the specified vault, name and version. + + :param uri: The uri of the key vault certificate + + :param vault: The vault uri + + :param name: The certificate name + + :param version: The certificate version' +constructor: + syntax: CertificateId(uri=None, vault=None, name=None, version=None) + parameters: + - name: uri + defaultValue: None + - name: vault + defaultValue: None + - name: name + defaultValue: None + - name: version + defaultValue: None +methods: +- uid: azure.keyvault.key_vault_id.CertificateId.create_certificate_id + name: create_certificate_id + signature: static create_certificate_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + - name: version + description: The certificate version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateId.create_certificate_issuer_id + name: create_certificate_issuer_id + signature: static create_certificate_issuer_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateId.create_certificate_operation_id + name: create_certificate_operation_id + signature: static create_certificate_operation_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateId.create_key_id + name: create_key_id + signature: static create_key_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The key name. + isRequired: true + types: + - + - name: version + description: The key version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateId.create_object_id + name: create_object_id + signature: static create_object_id(collection, vault, name, version) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: vault + description: The vault URI. + isRequired: true + types: + - + - name: name + description: The resource name. + isRequired: true + types: + - + - name: version + description: The resource version. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateId.create_secret_id + name: create_secret_id + signature: static create_secret_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The secret name. + isRequired: true + types: + - + - name: version + description: The secret version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateId.parse_certificate_id + name: parse_certificate_id + signature: static parse_certificate_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateId.parse_certificate_issuer_id + name: parse_certificate_issuer_id + signature: static parse_certificate_issuer_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateId.parse_certificate_operation_id + name: parse_certificate_operation_id + signature: static parse_certificate_operation_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateId.parse_key_id + name: parse_key_id + signature: static parse_key_id(id) + parameters: + - name: id + description: The key uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateId.parse_object_id + name: parse_object_id + signature: static parse_object_id(collection, id) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: id + description: The resource uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateId.parse_secret_id + name: parse_secret_id + signature: static parse_secret_id(id) + parameters: + - name: id + description: The secret uri. + isRequired: true + types: + - + return: + types: + - +attributes: +- uid: azure.keyvault.key_vault_id.CertificateId.base_id + name: base_id + summary: The version-less key vault object identifier uri, +- uid: azure.keyvault.key_vault_id.CertificateId.id + name: id + summary: The full key vault object identifier uri +- uid: azure.keyvault.key_vault_id.CertificateId.version_none + name: version_none + signature: version_none = '' diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.CertificateIssuerId.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.CertificateIssuerId.yml new file mode 100644 index 00000000..31de139f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.CertificateIssuerId.yml @@ -0,0 +1,239 @@ +### YamlMime:PythonClass +uid: azure.keyvault.key_vault_id.CertificateIssuerId +name: CertificateIssuerId +fullName: azure.keyvault.key_vault_id.CertificateIssuerId +module: azure.keyvault.key_vault_id +summary: 'Creates a key vault certificate issuer id. If uri is specified the id properties + are parsed from the uri, otherwise + + builds the id from the specified vault and name. + + :param uri: The uri of the key vault certificate issuer + + :param vault: The vault uri + + :param name: The certificate issuer name' +constructor: + syntax: CertificateIssuerId(uri=None, vault=None, name=None) + parameters: + - name: uri + defaultValue: None + - name: vault + defaultValue: None + - name: name + defaultValue: None +methods: +- uid: azure.keyvault.key_vault_id.CertificateIssuerId.create_certificate_id + name: create_certificate_id + signature: static create_certificate_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + - name: version + description: The certificate version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateIssuerId.create_certificate_issuer_id + name: create_certificate_issuer_id + signature: static create_certificate_issuer_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateIssuerId.create_certificate_operation_id + name: create_certificate_operation_id + signature: static create_certificate_operation_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateIssuerId.create_key_id + name: create_key_id + signature: static create_key_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The key name. + isRequired: true + types: + - + - name: version + description: The key version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateIssuerId.create_object_id + name: create_object_id + signature: static create_object_id(collection, vault, name, version) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: vault + description: The vault URI. + isRequired: true + types: + - + - name: name + description: The resource name. + isRequired: true + types: + - + - name: version + description: The resource version. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateIssuerId.create_secret_id + name: create_secret_id + signature: static create_secret_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The secret name. + isRequired: true + types: + - + - name: version + description: The secret version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateIssuerId.parse_certificate_id + name: parse_certificate_id + signature: static parse_certificate_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateIssuerId.parse_certificate_issuer_id + name: parse_certificate_issuer_id + signature: static parse_certificate_issuer_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateIssuerId.parse_certificate_operation_id + name: parse_certificate_operation_id + signature: static parse_certificate_operation_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateIssuerId.parse_key_id + name: parse_key_id + signature: static parse_key_id(id) + parameters: + - name: id + description: The key uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateIssuerId.parse_object_id + name: parse_object_id + signature: static parse_object_id(collection, id) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: id + description: The resource uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateIssuerId.parse_secret_id + name: parse_secret_id + signature: static parse_secret_id(id) + parameters: + - name: id + description: The secret uri. + isRequired: true + types: + - + return: + types: + - +attributes: +- uid: azure.keyvault.key_vault_id.CertificateIssuerId.base_id + name: base_id + summary: The version-less key vault object identifier uri, +- uid: azure.keyvault.key_vault_id.CertificateIssuerId.id + name: id + summary: The full key vault object identifier uri +- uid: azure.keyvault.key_vault_id.CertificateIssuerId.version_none + name: version_none + signature: version_none = '' diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.CertificateOperationId.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.CertificateOperationId.yml new file mode 100644 index 00000000..f96baa9c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.CertificateOperationId.yml @@ -0,0 +1,239 @@ +### YamlMime:PythonClass +uid: azure.keyvault.key_vault_id.CertificateOperationId +name: CertificateOperationId +fullName: azure.keyvault.key_vault_id.CertificateOperationId +module: azure.keyvault.key_vault_id +summary: 'Creates a key vault certificate operation id. If uri is specified the id + properties are parsed from the uri, otherwise + + builds the id from the specified vault and name. + + :param uri: The uri of the key vault certificate operation + + :param vault: The vault uri + + :param name: The certificate name' +constructor: + syntax: CertificateOperationId(uri=None, vault=None, name=None) + parameters: + - name: uri + defaultValue: None + - name: vault + defaultValue: None + - name: name + defaultValue: None +methods: +- uid: azure.keyvault.key_vault_id.CertificateOperationId.create_certificate_id + name: create_certificate_id + signature: static create_certificate_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + - name: version + description: The certificate version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateOperationId.create_certificate_issuer_id + name: create_certificate_issuer_id + signature: static create_certificate_issuer_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateOperationId.create_certificate_operation_id + name: create_certificate_operation_id + signature: static create_certificate_operation_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateOperationId.create_key_id + name: create_key_id + signature: static create_key_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The key name. + isRequired: true + types: + - + - name: version + description: The key version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateOperationId.create_object_id + name: create_object_id + signature: static create_object_id(collection, vault, name, version) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: vault + description: The vault URI. + isRequired: true + types: + - + - name: name + description: The resource name. + isRequired: true + types: + - + - name: version + description: The resource version. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateOperationId.create_secret_id + name: create_secret_id + signature: static create_secret_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The secret name. + isRequired: true + types: + - + - name: version + description: The secret version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateOperationId.parse_certificate_id + name: parse_certificate_id + signature: static parse_certificate_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateOperationId.parse_certificate_issuer_id + name: parse_certificate_issuer_id + signature: static parse_certificate_issuer_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateOperationId.parse_certificate_operation_id + name: parse_certificate_operation_id + signature: static parse_certificate_operation_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateOperationId.parse_key_id + name: parse_key_id + signature: static parse_key_id(id) + parameters: + - name: id + description: The key uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateOperationId.parse_object_id + name: parse_object_id + signature: static parse_object_id(collection, id) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: id + description: The resource uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.CertificateOperationId.parse_secret_id + name: parse_secret_id + signature: static parse_secret_id(id) + parameters: + - name: id + description: The secret uri. + isRequired: true + types: + - + return: + types: + - +attributes: +- uid: azure.keyvault.key_vault_id.CertificateOperationId.base_id + name: base_id + summary: The version-less key vault object identifier uri, +- uid: azure.keyvault.key_vault_id.CertificateOperationId.id + name: id + summary: The full key vault object identifier uri +- uid: azure.keyvault.key_vault_id.CertificateOperationId.version_none + name: version_none + signature: version_none = '' diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.KeyId.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.KeyId.yml new file mode 100644 index 00000000..db91107d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.KeyId.yml @@ -0,0 +1,243 @@ +### YamlMime:PythonClass +uid: azure.keyvault.key_vault_id.KeyId +name: KeyId +fullName: azure.keyvault.key_vault_id.KeyId +module: azure.keyvault.key_vault_id +summary: 'Creates a key vault key id. If uri is specified the id properties are parsed + from the uri, otherwise + + builds the id from the specified vault, name and version. + + :param uri: The uri of the key vault key + + :param vault: The vault uri + + :param name: The key name + + :param version: The key version' +constructor: + syntax: KeyId(uri=None, vault=None, name=None, version=None) + parameters: + - name: uri + defaultValue: None + - name: vault + defaultValue: None + - name: name + defaultValue: None + - name: version + defaultValue: None +methods: +- uid: azure.keyvault.key_vault_id.KeyId.create_certificate_id + name: create_certificate_id + signature: static create_certificate_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + - name: version + description: The certificate version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyId.create_certificate_issuer_id + name: create_certificate_issuer_id + signature: static create_certificate_issuer_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyId.create_certificate_operation_id + name: create_certificate_operation_id + signature: static create_certificate_operation_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyId.create_key_id + name: create_key_id + signature: static create_key_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The key name. + isRequired: true + types: + - + - name: version + description: The key version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyId.create_object_id + name: create_object_id + signature: static create_object_id(collection, vault, name, version) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: vault + description: The vault URI. + isRequired: true + types: + - + - name: name + description: The resource name. + isRequired: true + types: + - + - name: version + description: The resource version. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyId.create_secret_id + name: create_secret_id + signature: static create_secret_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The secret name. + isRequired: true + types: + - + - name: version + description: The secret version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyId.parse_certificate_id + name: parse_certificate_id + signature: static parse_certificate_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyId.parse_certificate_issuer_id + name: parse_certificate_issuer_id + signature: static parse_certificate_issuer_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyId.parse_certificate_operation_id + name: parse_certificate_operation_id + signature: static parse_certificate_operation_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyId.parse_key_id + name: parse_key_id + signature: static parse_key_id(id) + parameters: + - name: id + description: The key uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyId.parse_object_id + name: parse_object_id + signature: static parse_object_id(collection, id) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: id + description: The resource uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyId.parse_secret_id + name: parse_secret_id + signature: static parse_secret_id(id) + parameters: + - name: id + description: The secret uri. + isRequired: true + types: + - + return: + types: + - +attributes: +- uid: azure.keyvault.key_vault_id.KeyId.base_id + name: base_id + summary: The version-less key vault object identifier uri, +- uid: azure.keyvault.key_vault_id.KeyId.id + name: id + summary: The full key vault object identifier uri +- uid: azure.keyvault.key_vault_id.KeyId.version_none + name: version_none + signature: version_none = '' diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.KeyVaultCollectionType.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.KeyVaultCollectionType.yml new file mode 100644 index 00000000..901c06e5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.KeyVaultCollectionType.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.key_vault_id.KeyVaultCollectionType +name: KeyVaultCollectionType +fullName: azure.keyvault.key_vault_id.KeyVaultCollectionType +module: azure.keyvault.key_vault_id +fields: +- name: certificate_issuers + uid: azure.keyvault.key_vault_id.KeyVaultCollectionType.certificate_issuers +- name: certificates + uid: azure.keyvault.key_vault_id.KeyVaultCollectionType.certificates +- name: keys + uid: azure.keyvault.key_vault_id.KeyVaultCollectionType.keys +- name: secrets + uid: azure.keyvault.key_vault_id.KeyVaultCollectionType.secrets diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.KeyVaultId.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.KeyVaultId.yml new file mode 100644 index 00000000..60ea0e90 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.KeyVaultId.yml @@ -0,0 +1,242 @@ +### YamlMime:PythonClass +uid: azure.keyvault.key_vault_id.KeyVaultId +name: KeyVaultId +fullName: azure.keyvault.key_vault_id.KeyVaultId +module: azure.keyvault.key_vault_id +summary: An identifier for an Azure Key Vault resource. +constructor: + syntax: KeyVaultId(collection, vault, name, version) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: vault + description: The vault URI. + isRequired: true + types: + - + - name: name + description: The resource name. + isRequired: true + types: + - + - name: version + description: The resource version. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.key_vault_id.KeyVaultId.create_certificate_id + name: create_certificate_id + signature: static create_certificate_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + - name: version + description: The certificate version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyVaultId.create_certificate_issuer_id + name: create_certificate_issuer_id + signature: static create_certificate_issuer_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyVaultId.create_certificate_operation_id + name: create_certificate_operation_id + signature: static create_certificate_operation_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyVaultId.create_key_id + name: create_key_id + signature: static create_key_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The key name. + isRequired: true + types: + - + - name: version + description: The key version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyVaultId.create_object_id + name: create_object_id + signature: static create_object_id(collection, vault, name, version) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: vault + description: The vault URI. + isRequired: true + types: + - + - name: name + description: The resource name. + isRequired: true + types: + - + - name: version + description: The resource version. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyVaultId.create_secret_id + name: create_secret_id + signature: static create_secret_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The secret name. + isRequired: true + types: + - + - name: version + description: The secret version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyVaultId.parse_certificate_id + name: parse_certificate_id + signature: static parse_certificate_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyVaultId.parse_certificate_issuer_id + name: parse_certificate_issuer_id + signature: static parse_certificate_issuer_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyVaultId.parse_certificate_operation_id + name: parse_certificate_operation_id + signature: static parse_certificate_operation_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyVaultId.parse_key_id + name: parse_key_id + signature: static parse_key_id(id) + parameters: + - name: id + description: The key uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyVaultId.parse_object_id + name: parse_object_id + signature: static parse_object_id(collection, id) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: id + description: The resource uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyVaultId.parse_secret_id + name: parse_secret_id + signature: static parse_secret_id(id) + parameters: + - name: id + description: The secret uri. + isRequired: true + types: + - + return: + types: + - +attributes: +- uid: azure.keyvault.key_vault_id.KeyVaultId.base_id + name: base_id +- uid: azure.keyvault.key_vault_id.KeyVaultId.id + name: id +- uid: azure.keyvault.key_vault_id.KeyVaultId.version_none + name: version_none + signature: version_none = '' diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.KeyVaultIdentifier.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.KeyVaultIdentifier.yml new file mode 100644 index 00000000..6586abcf --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.KeyVaultIdentifier.yml @@ -0,0 +1,233 @@ +### YamlMime:PythonClass +uid: azure.keyvault.key_vault_id.KeyVaultIdentifier +name: KeyVaultIdentifier +fullName: azure.keyvault.key_vault_id.KeyVaultIdentifier +module: azure.keyvault.key_vault_id +summary: 'Creates a KeyVaultIdentifier based of the specified uri or keyword arguments + + :param uri: The uri of the key vault object identifier + + :param kwargs: The format parameters for the key vault object identifier. If uri + is specified these are used to validate the + + components of the uri.' +constructor: + syntax: KeyVaultIdentifier(uri=None, **kwargs) + parameters: + - name: uri + defaultValue: None +methods: +- uid: azure.keyvault.key_vault_id.KeyVaultIdentifier.create_certificate_id + name: create_certificate_id + signature: static create_certificate_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + - name: version + description: The certificate version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyVaultIdentifier.create_certificate_issuer_id + name: create_certificate_issuer_id + signature: static create_certificate_issuer_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyVaultIdentifier.create_certificate_operation_id + name: create_certificate_operation_id + signature: static create_certificate_operation_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyVaultIdentifier.create_key_id + name: create_key_id + signature: static create_key_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The key name. + isRequired: true + types: + - + - name: version + description: The key version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyVaultIdentifier.create_object_id + name: create_object_id + signature: static create_object_id(collection, vault, name, version) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: vault + description: The vault URI. + isRequired: true + types: + - + - name: name + description: The resource name. + isRequired: true + types: + - + - name: version + description: The resource version. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyVaultIdentifier.create_secret_id + name: create_secret_id + signature: static create_secret_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The secret name. + isRequired: true + types: + - + - name: version + description: The secret version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyVaultIdentifier.parse_certificate_id + name: parse_certificate_id + signature: static parse_certificate_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyVaultIdentifier.parse_certificate_issuer_id + name: parse_certificate_issuer_id + signature: static parse_certificate_issuer_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyVaultIdentifier.parse_certificate_operation_id + name: parse_certificate_operation_id + signature: static parse_certificate_operation_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyVaultIdentifier.parse_key_id + name: parse_key_id + signature: static parse_key_id(id) + parameters: + - name: id + description: The key uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyVaultIdentifier.parse_object_id + name: parse_object_id + signature: static parse_object_id(collection, id) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: id + description: The resource uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.KeyVaultIdentifier.parse_secret_id + name: parse_secret_id + signature: static parse_secret_id(id) + parameters: + - name: id + description: The secret uri. + isRequired: true + types: + - + return: + types: + - +attributes: +- uid: azure.keyvault.key_vault_id.KeyVaultIdentifier.base_id + name: base_id + summary: The version-less key vault object identifier uri, +- uid: azure.keyvault.key_vault_id.KeyVaultIdentifier.id + name: id + summary: The full key vault object identifier uri +- uid: azure.keyvault.key_vault_id.KeyVaultIdentifier.version_none + name: version_none + signature: version_none = '' diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.SecretId.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.SecretId.yml new file mode 100644 index 00000000..255c73b1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.SecretId.yml @@ -0,0 +1,243 @@ +### YamlMime:PythonClass +uid: azure.keyvault.key_vault_id.SecretId +name: SecretId +fullName: azure.keyvault.key_vault_id.SecretId +module: azure.keyvault.key_vault_id +summary: 'Creates a key vault secret id. If uri is specified the id properties are + parsed from the uri, otherwise + + builds the id from the specified vault, name and version. + + :param uri: The uri of the key vault secret + + :param vault: The vault uri + + :param name: The secret name + + :param version: The secret version' +constructor: + syntax: SecretId(uri=None, vault=None, name=None, version=None) + parameters: + - name: uri + defaultValue: None + - name: vault + defaultValue: None + - name: name + defaultValue: None + - name: version + defaultValue: None +methods: +- uid: azure.keyvault.key_vault_id.SecretId.create_certificate_id + name: create_certificate_id + signature: static create_certificate_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + - name: version + description: The certificate version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.SecretId.create_certificate_issuer_id + name: create_certificate_issuer_id + signature: static create_certificate_issuer_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.SecretId.create_certificate_operation_id + name: create_certificate_operation_id + signature: static create_certificate_operation_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.SecretId.create_key_id + name: create_key_id + signature: static create_key_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The key name. + isRequired: true + types: + - + - name: version + description: The key version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.SecretId.create_object_id + name: create_object_id + signature: static create_object_id(collection, vault, name, version) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: vault + description: The vault URI. + isRequired: true + types: + - + - name: name + description: The resource name. + isRequired: true + types: + - + - name: version + description: The resource version. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.SecretId.create_secret_id + name: create_secret_id + signature: static create_secret_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The secret name. + isRequired: true + types: + - + - name: version + description: The secret version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.SecretId.parse_certificate_id + name: parse_certificate_id + signature: static parse_certificate_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.SecretId.parse_certificate_issuer_id + name: parse_certificate_issuer_id + signature: static parse_certificate_issuer_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.SecretId.parse_certificate_operation_id + name: parse_certificate_operation_id + signature: static parse_certificate_operation_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.SecretId.parse_key_id + name: parse_key_id + signature: static parse_key_id(id) + parameters: + - name: id + description: The key uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.SecretId.parse_object_id + name: parse_object_id + signature: static parse_object_id(collection, id) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: id + description: The resource uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.SecretId.parse_secret_id + name: parse_secret_id + signature: static parse_secret_id(id) + parameters: + - name: id + description: The secret uri. + isRequired: true + types: + - + return: + types: + - +attributes: +- uid: azure.keyvault.key_vault_id.SecretId.base_id + name: base_id + summary: The version-less key vault object identifier uri, +- uid: azure.keyvault.key_vault_id.SecretId.id + name: id + summary: The full key vault object identifier uri +- uid: azure.keyvault.key_vault_id.SecretId.version_none + name: version_none + signature: version_none = '' diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.StorageAccountId.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.StorageAccountId.yml new file mode 100644 index 00000000..621f42ee --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.StorageAccountId.yml @@ -0,0 +1,239 @@ +### YamlMime:PythonClass +uid: azure.keyvault.key_vault_id.StorageAccountId +name: StorageAccountId +fullName: azure.keyvault.key_vault_id.StorageAccountId +module: azure.keyvault.key_vault_id +summary: 'Creates a key vault storage account id. If uri is specified the id properties + are parsed from the uri, otherwise + + builds the id from the specified vault and name. + + :param uri: The uri of the key vault storage account + + :param vault: The vault uri + + :param name: The storage account name' +constructor: + syntax: StorageAccountId(uri=None, vault=None, name=None) + parameters: + - name: uri + defaultValue: None + - name: vault + defaultValue: None + - name: name + defaultValue: None +methods: +- uid: azure.keyvault.key_vault_id.StorageAccountId.create_certificate_id + name: create_certificate_id + signature: static create_certificate_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + - name: version + description: The certificate version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.StorageAccountId.create_certificate_issuer_id + name: create_certificate_issuer_id + signature: static create_certificate_issuer_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.StorageAccountId.create_certificate_operation_id + name: create_certificate_operation_id + signature: static create_certificate_operation_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.StorageAccountId.create_key_id + name: create_key_id + signature: static create_key_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The key name. + isRequired: true + types: + - + - name: version + description: The key version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.StorageAccountId.create_object_id + name: create_object_id + signature: static create_object_id(collection, vault, name, version) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: vault + description: The vault URI. + isRequired: true + types: + - + - name: name + description: The resource name. + isRequired: true + types: + - + - name: version + description: The resource version. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.StorageAccountId.create_secret_id + name: create_secret_id + signature: static create_secret_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The secret name. + isRequired: true + types: + - + - name: version + description: The secret version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.StorageAccountId.parse_certificate_id + name: parse_certificate_id + signature: static parse_certificate_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.StorageAccountId.parse_certificate_issuer_id + name: parse_certificate_issuer_id + signature: static parse_certificate_issuer_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.StorageAccountId.parse_certificate_operation_id + name: parse_certificate_operation_id + signature: static parse_certificate_operation_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.StorageAccountId.parse_key_id + name: parse_key_id + signature: static parse_key_id(id) + parameters: + - name: id + description: The key uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.StorageAccountId.parse_object_id + name: parse_object_id + signature: static parse_object_id(collection, id) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: id + description: The resource uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.StorageAccountId.parse_secret_id + name: parse_secret_id + signature: static parse_secret_id(id) + parameters: + - name: id + description: The secret uri. + isRequired: true + types: + - + return: + types: + - +attributes: +- uid: azure.keyvault.key_vault_id.StorageAccountId.base_id + name: base_id + summary: The version-less key vault object identifier uri, +- uid: azure.keyvault.key_vault_id.StorageAccountId.id + name: id + summary: The full key vault object identifier uri +- uid: azure.keyvault.key_vault_id.StorageAccountId.version_none + name: version_none + signature: version_none = '' diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.StorageSasDefinitionId.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.StorageSasDefinitionId.yml new file mode 100644 index 00000000..0d6bb2f5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.StorageSasDefinitionId.yml @@ -0,0 +1,243 @@ +### YamlMime:PythonClass +uid: azure.keyvault.key_vault_id.StorageSasDefinitionId +name: StorageSasDefinitionId +fullName: azure.keyvault.key_vault_id.StorageSasDefinitionId +module: azure.keyvault.key_vault_id +summary: 'Creates a key vault storage account sas definition id. If uri is specified + the id properties are parsed from the uri, otherwise + + builds the id from the specified vault, account_name, and sas_definition. + + :param uri: The uri of the key vault storage account sas definition + + :param vault: The vault uri + + :param account_name: The storage account name + + :param sas_definition: The sas definition name' +constructor: + syntax: StorageSasDefinitionId(uri=None, vault=None, account_name=None, sas_definition=None) + parameters: + - name: uri + defaultValue: None + - name: vault + defaultValue: None + - name: account_name + defaultValue: None + - name: sas_definition + defaultValue: None +methods: +- uid: azure.keyvault.key_vault_id.StorageSasDefinitionId.create_certificate_id + name: create_certificate_id + signature: static create_certificate_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + - name: version + description: The certificate version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.StorageSasDefinitionId.create_certificate_issuer_id + name: create_certificate_issuer_id + signature: static create_certificate_issuer_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.StorageSasDefinitionId.create_certificate_operation_id + name: create_certificate_operation_id + signature: static create_certificate_operation_id(vault, name) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The certificate name. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.StorageSasDefinitionId.create_key_id + name: create_key_id + signature: static create_key_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The key name. + isRequired: true + types: + - + - name: version + description: The key version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.StorageSasDefinitionId.create_object_id + name: create_object_id + signature: static create_object_id(collection, vault, name, version) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: vault + description: The vault URI. + isRequired: true + types: + - + - name: name + description: The resource name. + isRequired: true + types: + - + - name: version + description: The resource version. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.StorageSasDefinitionId.create_secret_id + name: create_secret_id + signature: static create_secret_id(vault, name, version=None) + parameters: + - name: vault + description: The vault uri. + isRequired: true + types: + - + - name: name + description: The secret name. + isRequired: true + types: + - + - name: version + description: The secret version. + defaultValue: None + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.StorageSasDefinitionId.parse_certificate_id + name: parse_certificate_id + signature: static parse_certificate_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.StorageSasDefinitionId.parse_certificate_issuer_id + name: parse_certificate_issuer_id + signature: static parse_certificate_issuer_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.StorageSasDefinitionId.parse_certificate_operation_id + name: parse_certificate_operation_id + signature: static parse_certificate_operation_id(id) + parameters: + - name: id + description: The resource collection type. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.StorageSasDefinitionId.parse_key_id + name: parse_key_id + signature: static parse_key_id(id) + parameters: + - name: id + description: The key uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.StorageSasDefinitionId.parse_object_id + name: parse_object_id + signature: static parse_object_id(collection, id) + parameters: + - name: collection + description: The resource collection type. + isRequired: true + types: + - + - name: id + description: The resource uri. + isRequired: true + types: + - + return: + types: + - +- uid: azure.keyvault.key_vault_id.StorageSasDefinitionId.parse_secret_id + name: parse_secret_id + signature: static parse_secret_id(id) + parameters: + - name: id + description: The secret uri. + isRequired: true + types: + - + return: + types: + - +attributes: +- uid: azure.keyvault.key_vault_id.StorageSasDefinitionId.base_id + name: base_id + summary: The version-less key vault object identifier uri, +- uid: azure.keyvault.key_vault_id.StorageSasDefinitionId.id + name: id + summary: The full key vault object identifier uri +- uid: azure.keyvault.key_vault_id.StorageSasDefinitionId.version_none + name: version_none + signature: version_none = '' diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.yml new file mode 100644 index 00000000..646cb558 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_id.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonModule +uid: azure.keyvault.key_vault_id +name: key_vault_id +fullName: azure.keyvault.key_vault_id +classes: +- azure.keyvault.key_vault_id.CertificateId +- azure.keyvault.key_vault_id.CertificateIssuerId +- azure.keyvault.key_vault_id.CertificateOperationId +- azure.keyvault.key_vault_id.KeyId +- azure.keyvault.key_vault_id.KeyVaultId +- azure.keyvault.key_vault_id.KeyVaultIdentifier +- azure.keyvault.key_vault_id.SecretId +- azure.keyvault.key_vault_id.StorageAccountId +- azure.keyvault.key_vault_id.StorageSasDefinitionId +enums: +- azure.keyvault.key_vault_id.KeyVaultCollectionType diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.models.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.models.yml new file mode 100644 index 00000000..179e8d13 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.models.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.keyvault.models +name: models +fullName: azure.keyvault.models diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.KeyVaultClient.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.KeyVaultClient.yml new file mode 100644 index 00000000..8b685f70 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.KeyVaultClient.yml @@ -0,0 +1,4005 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.KeyVaultClient +name: KeyVaultClient +fullName: azure.keyvault.v2016_10_01.KeyVaultClient +module: azure.keyvault.v2016_10_01 +summary: The key vault client performs cryptographic key operations and vault operations + against the Key Vault service. +constructor: + syntax: KeyVaultClient(credentials) + parameters: + - name: credentials + description: Credentials needed for the client to connect to Azure. + isRequired: true + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.backup_key + name: backup_key + summary: 'Requests that a backup of the specified key be downloaded to the + + client. + + + The Key Backup operation exports a key from Azure Key Vault in a + + protected form. Note that this operation does NOT return key material + + in a form that can be used outside the Azure Key Vault system, the + + returned key material is either protected to a Azure Key Vault HSM or + + to Azure Key Vault itself. The intent of this operation is to allow a + + client to GENERATE a key in one Azure Key Vault instance, BACKUP the + + key, and then RESTORE it into another Azure Key Vault instance. The + + BACKUP operation may be used to export, in protected form, any key type + + from Azure Key Vault. Individual versions of a key cannot be backed up. + + BACKUP / RESTORE can be performed within geographical boundaries only; + + meaning that a BACKUP from one geographical area cannot be restored to + + another geographical area. For example, a backup from the US + + geographical area cannot be restored in an EU geographical area. This + + operation requires the key/backup permission.' + signature: backup_key(vault_base_url, key_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: BackupKeyResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.backup_secret + name: backup_secret + summary: 'Backs up the specified secret. + + + Requests that a backup of the specified secret be downloaded to the + + client. All versions of the secret will be downloaded. This operation + + requires the secrets/backup permission.' + signature: backup_secret(vault_base_url, secret_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: BackupSecretResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.create_certificate + name: create_certificate + summary: 'Creates a new certificate. + + + If this is the first version, the certificate resource is created. This + + operation requires the certificates/create permission.' + signature: create_certificate(vault_base_url, certificate_name, certificate_policy=None, + certificate_attributes=None, tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: certificate_policy + description: The management policy for the certificate. + defaultValue: None + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateOperation or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.create_key + name: create_key + summary: 'Creates a new key, stores it, then returns key parameters and + + attributes to the client. + + + The create key operation can be used to create any key type in Azure + + Key Vault. If the named key already exists, Azure Key Vault creates a + + new version of the key. It requires the keys/create permission.' + signature: create_key(vault_base_url, key_name, kty, key_size=None, key_ops=None, + key_attributes=None, tags=None, curve=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: 'The name for the new key. The system will generate + + the version name for the new key.' + isRequired: true + types: + - + - name: kty + description: 'The type of key to create. For valid values, see + + JsonWebKeyType. Possible values include: ''EC'', ''EC-HSM'', ''RSA'', + + ''RSA-HSM'', ''oct''' + isRequired: true + types: + - + - + - name: key_size + description: 'The key size in bits. For example: 2048, 3072, or + + 4096 for RSA.' + defaultValue: None + types: + - + - name: key_ops + defaultValue: None + types: + - [ + - ] + - name: key_attributes + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: curve + description: 'Elliptic curve name. For valid values, see + + JsonWebKeyCurveName. Possible values include: ''P-256'', ''P-384'', + + ''P-521'', ''SECP256K1''' + defaultValue: None + types: + - + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.decrypt + name: decrypt + summary: 'Decrypts a single block of encrypted data. + + + The DECRYPT operation decrypts a well-formed block of ciphertext using + + the target encryption key and specified algorithm. This operation is + + the reverse of the ENCRYPT operation; only a single block of data may + + be decrypted, the size of this block is dependent on the target key and + + the algorithm to be used. The DECRYPT operation applies to asymmetric + + and symmetric keys stored in Azure Key Vault since it uses the private + + portion of the key. This operation requires the keys/decrypt + + permission.' + signature: decrypt(vault_base_url, key_name, key_version, algorithm, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'algorithm identifier. Possible values include: + + ''RSA-OAEP'', ''RSA-OAEP-256'', ''RSA1_5''' + isRequired: true + types: + - + - + - name: value + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyOperationResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.delete_certificate + name: delete_certificate + summary: 'Deletes a certificate from a specified key vault. + + + Deletes all versions of a certificate object along with its associated + + policy. Delete certificate cannot be used to remove individual versions + + of a certificate object. This operation requires the + + certificates/delete permission.' + signature: delete_certificate(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedCertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.delete_certificate_contacts + name: delete_certificate_contacts + summary: 'Deletes the certificate contacts for a specified key vault. + + + Deletes the certificate contacts for a specified key vault certificate. + + This operation requires the certificates/managecontacts permission.' + signature: delete_certificate_contacts(vault_base_url, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Contacts or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.delete_certificate_issuer + name: delete_certificate_issuer + summary: 'Deletes the specified certificate issuer. + + + The DeleteCertificateIssuer operation permanently removes the specified + + certificate issuer from the vault. This operation requires the + + certificates/manageissuers/deleteissuers permission.' + signature: delete_certificate_issuer(vault_base_url, issuer_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: issuer_name + description: The name of the issuer. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: IssuerBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.delete_certificate_operation + name: delete_certificate_operation + summary: 'Deletes the creation operation for a specific certificate. + + + Deletes the creation operation for a specified certificate that is in + + the process of being created. The certificate is no longer created. + + This operation requires the certificates/update permission.' + signature: delete_certificate_operation(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateOperation or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.delete_key + name: delete_key + summary: 'Deletes a key of any type from storage in Azure Key Vault. + + + The delete key operation cannot be used to remove individual versions + + of a key. This operation removes the cryptographic material associated + + with the key, which means the key is not usable for Sign/Verify, + + Wrap/Unwrap or Encrypt/Decrypt operations. This operation requires the + + keys/delete permission.' + signature: delete_key(vault_base_url, key_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key to delete. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedKeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.delete_sas_definition + name: delete_sas_definition + summary: 'Deletes a SAS definition from a specified storage account. This + + operation requires the storage/deletesas permission.' + signature: delete_sas_definition(vault_base_url, storage_account_name, sas_definition_name, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: sas_definition_name + description: The name of the SAS definition. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SasDefinitionBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.delete_secret + name: delete_secret + summary: 'Deletes a secret from a specified key vault. + + + The DELETE operation applies to any secret stored in Azure Key Vault. + + DELETE cannot be applied to an individual version of a secret. This + + operation requires the secrets/delete permission.' + signature: delete_secret(vault_base_url, secret_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedSecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.delete_storage_account + name: delete_storage_account + summary: 'Deletes a storage account. This operation requires the storage/delete + + permission.' + signature: delete_storage_account(vault_base_url, storage_account_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.encrypt + name: encrypt + summary: 'Encrypts an arbitrary sequence of bytes using an encryption key that is + + stored in a key vault. + + + The ENCRYPT operation encrypts an arbitrary sequence of bytes using an + + encryption key that is stored in Azure Key Vault. Note that the ENCRYPT + + operation only supports a single block of data, the size of which is + + dependent on the target key and the encryption algorithm to be used. + + The ENCRYPT operation is only strictly necessary for symmetric keys + + stored in Azure Key Vault since protection with an asymmetric key can + + be performed using public portion of the key. This operation is + + supported for asymmetric keys as a convenience for callers that have a + + key-reference but do not have access to the public key material. This + + operation requires the keys/encypt permission.' + signature: encrypt(vault_base_url, key_name, key_version, algorithm, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'algorithm identifier. Possible values include: + + ''RSA-OAEP'', ''RSA-OAEP-256'', ''RSA1_5''' + isRequired: true + types: + - + - + - name: value + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyOperationResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_certificate + name: get_certificate + summary: 'Gets information about a certificate. + + + Gets information about a specific certificate. This operation requires + + the certificates/get permission.' + signature: get_certificate(vault_base_url, certificate_name, certificate_version, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: 'The name of the certificate in the given + + vault.' + isRequired: true + types: + - + - name: certificate_version + description: The version of the certificate. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_certificate_contacts + name: get_certificate_contacts + summary: 'Lists the certificate contacts for a specified key vault. + + + The GetCertificateContacts operation returns the set of certificate + + contact resources in the specified key vault. This operation requires + + the certificates/managecontacts permission.' + signature: get_certificate_contacts(vault_base_url, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Contacts or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_certificate_issuer + name: get_certificate_issuer + summary: 'Lists the specified certificate issuer. + + + The GetCertificateIssuer operation returns the specified certificate + + issuer resources in the specified key vault. This operation requires + + the certificates/manageissuers/getissuers permission.' + signature: get_certificate_issuer(vault_base_url, issuer_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: issuer_name + description: The name of the issuer. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: IssuerBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_certificate_issuers + name: get_certificate_issuers + summary: 'List certificate issuers for a specified key vault. + + + The GetCertificateIssuers operation returns the set of certificate + + issuer resources in the specified key vault. This operation requires + + the certificates/manageissuers/getissuers permission.' + signature: get_certificate_issuers(vault_base_url, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of CertificateIssuerItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_certificate_operation + name: get_certificate_operation + summary: 'Gets the creation operation of a certificate. + + + Gets the creation operation associated with a specified certificate. + + This operation requires the certificates/get permission.' + signature: get_certificate_operation(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateOperation or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_certificate_policy + name: get_certificate_policy + summary: 'Lists the policy for a certificate. + + + The GetCertificatePolicy operation returns the specified certificate + + policy resources in the specified key vault. This operation requires + + the certificates/get permission.' + signature: get_certificate_policy(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: 'The name of the certificate in a given key + + vault.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificatePolicy or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_certificate_versions + name: get_certificate_versions + summary: 'List the versions of a certificate. + + + The GetCertificateVersions operation returns the versions of a + + certificate in the specified key vault. This operation requires the + + certificates/list permission.' + signature: get_certificate_versions(vault_base_url, certificate_name, maxresults=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of CertificateItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_certificates + name: get_certificates + summary: 'List certificates in a specified key vault. + + + The GetCertificates operation returns the set of certificates resources + + in the specified key vault. This operation requires the + + certificates/list permission.' + signature: get_certificates(vault_base_url, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of CertificateItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_deleted_certificate + name: get_deleted_certificate + summary: 'Retrieves information about the specified deleted certificate. + + + The GetDeletedCertificate operation retrieves the deleted certificate + + information plus its attributes, such as retention interval, scheduled + + permanent deletion and the current deletion recovery level. This + + operation requires the certificates/get permission.' + signature: get_deleted_certificate(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedCertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_deleted_certificates + name: get_deleted_certificates + summary: 'Lists the deleted certificates in the specified vault currently + + available for recovery. + + + The GetDeletedCertificates operation retrieves the certificates in the + + current vault which are in a deleted state and ready for recovery or + + purging. This operation includes deletion-specific information. This + + operation requires the certificates/get/list permission. This operation + + can only be enabled on soft-delete enabled vaults.' + signature: get_deleted_certificates(vault_base_url, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DeletedCertificateItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_deleted_key + name: get_deleted_key + summary: 'Gets the public part of a deleted key. + + + The Get Deleted Key operation is applicable for soft-delete enabled + + vaults. While the operation can be invoked on any vault, it will return + + an error if invoked on a non soft-delete enabled vault. This operation + + requires the keys/get permission. .' + signature: get_deleted_key(vault_base_url, key_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedKeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_deleted_keys + name: get_deleted_keys + summary: 'Lists the deleted keys in the specified vault. + + + Retrieves a list of the keys in the Key Vault as JSON Web Key + + structures that contain the public part of a deleted key. This + + operation includes deletion-specific information. The Get Deleted Keys + + operation is applicable for vaults enabled for soft-delete. While the + + operation can be invoked on any vault, it will return an error if + + invoked on a non soft-delete enabled vault. This operation requires the + + keys/list permission.' + signature: get_deleted_keys(vault_base_url, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DeletedKeyItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_deleted_secret + name: get_deleted_secret + summary: 'Gets the specified deleted secret. + + + The Get Deleted Secret operation returns the specified deleted secret + + along with its attributes. This operation requires the secrets/get + + permission.' + signature: get_deleted_secret(vault_base_url, secret_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedSecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_deleted_secrets + name: get_deleted_secrets + summary: 'Lists deleted secrets for the specified vault. + + + The Get Deleted Secrets operation returns the secrets that have been + + deleted for a vault enabled for soft-delete. This operation requires + + the secrets/list permission.' + signature: get_deleted_secrets(vault_base_url, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DeletedSecretItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_key + name: get_key + summary: 'Gets the public part of a stored key. + + + The get key operation is applicable to all key types. If the requested + + key is symmetric, then no key material is released in the response. + + This operation requires the keys/get permission.' + signature: get_key(vault_base_url, key_name, key_version, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key to get. + isRequired: true + types: + - + - name: key_version + description: 'Adding the version parameter retrieves a specific + + version of a key.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_key_versions + name: get_key_versions + summary: 'Retrieves a list of individual key versions with the same key name. + + + The full key identifier, attributes, and tags are provided in the + + response. This operation requires the keys/list permission.' + signature: get_key_versions(vault_base_url, key_name, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of KeyItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_keys + name: get_keys + summary: 'List keys in the specified vault. + + + Retrieves a list of the keys in the Key Vault as JSON Web Key + + structures that contain the public part of a stored key. The LIST + + operation is applicable to all key types, however only the base key + + identifier, attributes, and tags are provided in the response. + + Individual versions of a key are not listed in the response. This + + operation requires the keys/list permission.' + signature: get_keys(vault_base_url, maxresults=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of KeyItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_sas_definition + name: get_sas_definition + summary: 'Gets information about a SAS definition for the specified storage + + account. This operation requires the storage/getsas permission.' + signature: get_sas_definition(vault_base_url, storage_account_name, sas_definition_name, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: sas_definition_name + description: The name of the SAS definition. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SasDefinitionBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_sas_definitions + name: get_sas_definitions + summary: 'List storage SAS definitions for the given storage account. This + + operation requires the storage/listsas permission.' + signature: get_sas_definitions(vault_base_url, storage_account_name, maxresults=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of SasDefinitionItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_secret + name: get_secret + summary: 'Get a specified secret from a given key vault. + + + The GET operation is applicable to any secret stored in Azure Key + + Vault. This operation requires the secrets/get permission.' + signature: get_secret(vault_base_url, secret_name, secret_version, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: secret_version + description: The version of the secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_secret_versions + name: get_secret_versions + summary: 'List all versions of the specified secret. + + + The full secret identifier and attributes are provided in the response. + + No values are returned for the secrets. This operations requires the + + secrets/list permission.' + signature: get_secret_versions(vault_base_url, secret_name, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified, the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of SecretItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_secrets + name: get_secrets + summary: 'List secrets in a specified key vault. + + + The Get Secrets operation is applicable to the entire vault. However, + + only the base secret identifier and its attributes are provided in the + + response. Individual secret versions are not listed in the response. + + This operation requires the secrets/list permission.' + signature: get_secrets(vault_base_url, maxresults=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified, the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of SecretItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_storage_account + name: get_storage_account + summary: 'Gets information about a specified storage account. This operation + + requires the storage/get permission.' + signature: get_storage_account(vault_base_url, storage_account_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.get_storage_accounts + name: get_storage_accounts + summary: 'List storage accounts managed by the specified key vault. This + + operation requires the storage/list permission.' + signature: get_storage_accounts(vault_base_url, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of StorageAccountItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.import_certificate + name: import_certificate + summary: 'Imports a certificate into a specified key vault. + + + Imports an existing valid certificate, containing a private key, into + + Azure Key Vault. The certificate to be imported can be in either PFX or + + PEM format. If the certificate is in PEM format the PEM file must + + contain the key as well as x509 certificates. This operation requires + + the certificates/import permission.' + signature: import_certificate(vault_base_url, certificate_name, base64_encoded_certificate, + password=None, certificate_policy=None, certificate_attributes=None, tags=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: base64_encoded_certificate + description: 'Base64 encoded representation of + + the certificate object to import. This certificate needs to contain + + the private key.' + isRequired: true + types: + - + - name: password + description: 'If the private key in base64EncodedCertificate is + + encrypted, the password used for encryption.' + defaultValue: None + types: + - + - name: certificate_policy + description: The management policy for the certificate. + defaultValue: None + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.import_key + name: import_key + summary: 'Imports an externally created key, stores it, and returns key + + parameters and attributes to the client. + + + The import key operation may be used to import any key type into an + + Azure Key Vault. If the named key already exists, Azure Key Vault + + creates a new version of the key. This operation requires the + + keys/import permission.' + signature: import_key(vault_base_url, key_name, key, hsm=None, key_attributes=None, + tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: Name for the imported key. + isRequired: true + types: + - + - name: key + description: The Json web key + isRequired: true + types: + - + - name: hsm + description: Whether to import as a hardware key (HSM) or software key. + defaultValue: None + types: + - + - name: key_attributes + description: The key management attributes. + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.merge_certificate + name: merge_certificate + summary: 'Merges a certificate or a certificate chain with a key pair existing on + + the server. + + + The MergeCertificate operation performs the merging of a certificate or + + certificate chain with a key pair currently available in the service. + + This operation requires the certificates/create permission.' + signature: merge_certificate(vault_base_url, certificate_name, x509_certificates, + certificate_attributes=None, tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: x509_certificates + description: 'The certificate or the certificate chain to + + merge.' + isRequired: true + types: + - [] + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.purge_deleted_certificate + name: purge_deleted_certificate + summary: 'Permanently deletes the specified deleted certificate. + + + The PurgeDeletedCertificate operation performs an irreversible deletion + + of the specified certificate, without possibility for recovery. The + + operation is not available if the recovery level does not specify + + ''Purgeable''. This operation requires the certificate/purge permission.' + signature: purge_deleted_certificate(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.purge_deleted_key + name: purge_deleted_key + summary: 'Permanently deletes the specified key. + + + The Purge Deleted Key operation is applicable for soft-delete enabled + + vaults. While the operation can be invoked on any vault, it will return + + an error if invoked on a non soft-delete enabled vault. This operation + + requires the keys/purge permission.' + signature: purge_deleted_key(vault_base_url, key_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.purge_deleted_secret + name: purge_deleted_secret + summary: 'Permanently deletes the specified secret. + + + The purge deleted secret operation removes the secret permanently, + + without the possibility of recovery. This operation can only be enabled + + on a soft-delete enabled vault. This operation requires the + + secrets/purge permission.' + signature: purge_deleted_secret(vault_base_url, secret_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.recover_deleted_certificate + name: recover_deleted_certificate + summary: 'Recovers the deleted certificate back to its current version under + + /certificates. + + + The RecoverDeletedCertificate operation performs the reversal of the + + Delete operation. The operation is applicable in vaults enabled for + + soft-delete, and must be issued during the retention interval + + (available in the deleted certificate''s attributes). This operation + + requires the certificates/recover permission.' + signature: recover_deleted_certificate(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the deleted certificate + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.recover_deleted_key + name: recover_deleted_key + summary: 'Recovers the deleted key to its latest version. + + + The Recover Deleted Key operation is applicable for deleted keys in + + soft-delete enabled vaults. It recovers the deleted key back to its + + latest version under /keys. An attempt to recover an non-deleted key + + will return an error. Consider this the inverse of the delete operation + + on soft-delete enabled vaults. This operation requires the keys/recover + + permission.' + signature: recover_deleted_key(vault_base_url, key_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the deleted key. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.recover_deleted_secret + name: recover_deleted_secret + summary: 'Recovers the deleted secret to the latest version. + + + Recovers the deleted secret in the specified vault. This operation can + + only be performed on a soft-delete enabled vault. This operation + + requires the secrets/recover permission.' + signature: recover_deleted_secret(vault_base_url, secret_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the deleted secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.regenerate_storage_account_key + name: regenerate_storage_account_key + summary: 'Regenerates the specified key value for the given storage account. This + + operation requires the storage/regeneratekey permission.' + signature: regenerate_storage_account_key(vault_base_url, storage_account_name, + key_name, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: key_name + description: The storage account key name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.restore_key + name: restore_key + summary: 'Restores a backed up key to a vault. + + + Imports a previously backed up key into Azure Key Vault, restoring the + + key, its key identifier, attributes and access control policies. The + + RESTORE operation may be used to import a previously backed up key. + + Individual versions of a key cannot be restored. The key is restored in + + its entirety with the same key name as it had when it was backed up. If + + the key name is not available in the target Key Vault, the RESTORE + + operation will be rejected. While the key name is retained during + + restore, the final key identifier will change if the key is restored to + + a different vault. Restore will restore all versions and preserve + + version identifiers. The RESTORE operation is subject to security + + constraints: The target Key Vault must be owned by the same Microsoft + + Azure Subscription as the source Key Vault The user must have RESTORE + + permission in the target Key Vault. This operation requires the + + keys/restore permission.' + signature: restore_key(vault_base_url, key_bundle_backup, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_bundle_backup + description: 'The backup blob associated with a key + + bundle.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.restore_secret + name: restore_secret + summary: 'Restores a backed up secret to a vault. + + + Restores a backed up secret, and all its versions, to a vault. This + + operation requires the secrets/restore permission.' + signature: restore_secret(vault_base_url, secret_bundle_backup, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_bundle_backup + description: 'The backup blob associated with a secret + + bundle.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.set_certificate_contacts + name: set_certificate_contacts + summary: 'Sets the certificate contacts for the specified key vault. + + + Sets the certificate contacts for the specified key vault. This + + operation requires the certificates/managecontacts permission.' + signature: set_certificate_contacts(vault_base_url, contact_list=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: contact_list + description: The contact list for the vault certificates. + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Contacts or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.set_certificate_issuer + name: set_certificate_issuer + summary: 'Sets the specified certificate issuer. + + + The SetCertificateIssuer operation adds or updates the specified + + certificate issuer. This operation requires the certificates/setissuers + + permission.' + signature: set_certificate_issuer(vault_base_url, issuer_name, provider, credentials=None, + organization_details=None, attributes=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: issuer_name + description: The name of the issuer. + isRequired: true + types: + - + - name: provider + description: The issuer provider. + isRequired: true + types: + - + - name: credentials + description: The credentials to be used for the issuer. + defaultValue: None + types: + - + - name: organization_details + description: 'Details of the organization as provided + + to the issuer.' + defaultValue: None + types: + - + - name: attributes + description: Attributes of the issuer object. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: IssuerBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.set_sas_definition + name: set_sas_definition + summary: 'Creates or updates a new SAS definition for the specified storage + + account. This operation requires the storage/setsas permission.' + signature: set_sas_definition(vault_base_url, storage_account_name, sas_definition_name, + parameters, sas_definition_attributes=None, tags=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: sas_definition_name + description: The name of the SAS definition. + isRequired: true + types: + - + - name: parameters + description: 'Sas definition creation metadata in the form of + + key-value pairs.' + isRequired: true + types: + - [, ] + - name: sas_definition_attributes + description: 'The attributes of the SAS + + definition.' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SasDefinitionBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.set_secret + name: set_secret + summary: 'Sets a secret in a specified key vault. + + + The SET operation adds a secret to the Azure Key Vault. If the named + + secret already exists, Azure Key Vault creates a new version of that + + secret. This operation requires the secrets/set permission.' + signature: set_secret(vault_base_url, secret_name, value, tags=None, content_type=None, + secret_attributes=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: value + description: The value of the secret. + isRequired: true + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: content_type + description: Type of the secret value such as a password. + defaultValue: None + types: + - + - name: secret_attributes + description: The secret management attributes. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.set_storage_account + name: set_storage_account + summary: 'Creates or updates a new storage account. This operation requires the + + storage/set permission.' + signature: set_storage_account(vault_base_url, storage_account_name, resource_id, + active_key_name, auto_regenerate_key, regeneration_period=None, storage_account_attributes=None, + tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: resource_id + description: Storage account resource id. + isRequired: true + types: + - + - name: active_key_name + description: Current active storage account key name. + isRequired: true + types: + - + - name: auto_regenerate_key + description: 'whether keyvault should manage the storage + + account for the user.' + isRequired: true + types: + - + - name: regeneration_period + description: 'The key regeneration time duration + + specified in ISO-8601 format.' + defaultValue: None + types: + - + - name: storage_account_attributes + description: 'The attributes of the storage + + account.' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.sign + name: sign + summary: 'Creates a signature from a digest using the specified key. + + + The SIGN operation is applicable to asymmetric and symmetric keys + + stored in Azure Key Vault since this operation uses the private portion + + of the key. This operation requires the keys/sign permission.' + signature: sign(vault_base_url, key_name, key_version, algorithm, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'The signing/verification algorithm identifier. For + + more information on possible algorithm types, see + + JsonWebKeySignatureAlgorithm. Possible values include: ''PS256'', + + ''PS384'', ''PS512'', ''RS256'', ''RS384'', ''RS512'', ''RSNULL'', ''ES256'', + + ''ES384'', ''ES512'', ''ECDSA256''' + isRequired: true + types: + - + - + - name: value + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyOperationResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.unwrap_key + name: unwrap_key + summary: 'Unwraps a symmetric key using the specified key that was initially used + + for wrapping that key. + + + The UNWRAP operation supports decryption of a symmetric key using the + + target key encryption key. This operation is the reverse of the WRAP + + operation. The UNWRAP operation applies to asymmetric and symmetric + + keys stored in Azure Key Vault since it uses the private portion of the + + key. This operation requires the keys/unwrapKey permission.' + signature: unwrap_key(vault_base_url, key_name, key_version, algorithm, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'algorithm identifier. Possible values include: + + ''RSA-OAEP'', ''RSA-OAEP-256'', ''RSA1_5''' + isRequired: true + types: + - + - + - name: value + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyOperationResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.update_certificate + name: update_certificate + summary: 'Updates the specified attributes associated with the given certificate. + + + The UpdateCertificate operation applies the specified update on the + + given certificate; the only elements updated are the certificate''s + + attributes. This operation requires the certificates/update permission.' + signature: update_certificate(vault_base_url, certificate_name, certificate_version, + certificate_policy=None, certificate_attributes=None, tags=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: 'The name of the certificate in the given key + + vault.' + isRequired: true + types: + - + - name: certificate_version + description: The version of the certificate. + isRequired: true + types: + - + - name: certificate_policy + description: The management policy for the certificate. + defaultValue: None + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.update_certificate_issuer + name: update_certificate_issuer + summary: 'Updates the specified certificate issuer. + + + The UpdateCertificateIssuer operation performs an update on the + + specified certificate issuer entity. This operation requires the + + certificates/setissuers permission.' + signature: update_certificate_issuer(vault_base_url, issuer_name, provider=None, + credentials=None, organization_details=None, attributes=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: issuer_name + description: The name of the issuer. + isRequired: true + types: + - + - name: provider + description: The issuer provider. + defaultValue: None + types: + - + - name: credentials + description: The credentials to be used for the issuer. + defaultValue: None + types: + - + - name: organization_details + description: 'Details of the organization as provided + + to the issuer.' + defaultValue: None + types: + - + - name: attributes + description: Attributes of the issuer object. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: IssuerBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.update_certificate_operation + name: update_certificate_operation + summary: 'Updates a certificate operation. + + + Updates a certificate creation operation that is already in progress. + + This operation requires the certificates/update permission.' + signature: update_certificate_operation(vault_base_url, certificate_name, cancellation_requested, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: cancellation_requested + description: 'Indicates if cancellation was requested + + on the certificate operation.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateOperation or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.update_certificate_policy + name: update_certificate_policy + summary: 'Updates the policy for a certificate. + + + Set specified members in the certificate policy. Leave others as null. + + This operation requires the certificates/update permission.' + signature: update_certificate_policy(vault_base_url, certificate_name, certificate_policy, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: 'The name of the certificate in the given + + vault.' + isRequired: true + types: + - + - name: certificate_policy + description: The policy for the certificate. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificatePolicy or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.update_key + name: update_key + summary: 'The update key operation changes specified attributes of a stored key + + and can be applied to any key type and key version stored in Azure Key + + Vault. + + + In order to perform this operation, the key must already exist in the + + Key Vault. Note: The cryptographic material of a key itself cannot be + + changed. This operation requires the keys/update permission.' + signature: update_key(vault_base_url, key_name, key_version, key_ops=None, key_attributes=None, + tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of key to update. + isRequired: true + types: + - + - name: key_version + description: The version of the key to update. + isRequired: true + types: + - + - name: key_ops + description: 'Json web key operations. For more information on + + possible key operations, see JsonWebKeyOperation.' + defaultValue: None + types: + - [ + - ] + - name: key_attributes + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.update_sas_definition + name: update_sas_definition + summary: 'Updates the specified attributes associated with the given SAS + + definition. This operation requires the storage/setsas permission.' + signature: update_sas_definition(vault_base_url, storage_account_name, sas_definition_name, + parameters=None, sas_definition_attributes=None, tags=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: sas_definition_name + description: The name of the SAS definition. + isRequired: true + types: + - + - name: parameters + description: 'Sas definition update metadata in the form of + + key-value pairs.' + defaultValue: None + types: + - [, ] + - name: sas_definition_attributes + description: 'The attributes of the SAS + + definition.' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SasDefinitionBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.update_secret + name: update_secret + summary: 'Updates the attributes associated with a specified secret in a given + + key vault. + + + The UPDATE operation changes specified attributes of an existing stored + + secret. Attributes that are not specified in the request are left + + unchanged. The value of a secret itself cannot be changed. This + + operation requires the secrets/set permission.' + signature: update_secret(vault_base_url, secret_name, secret_version, content_type=None, + secret_attributes=None, tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: secret_version + description: The version of the secret. + isRequired: true + types: + - + - name: content_type + description: Type of the secret value such as a password. + defaultValue: None + types: + - + - name: secret_attributes + description: The secret management attributes. + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.update_storage_account + name: update_storage_account + summary: 'Updates the specified attributes associated with the given storage + + account. This operation requires the storage/set/update permission.' + signature: update_storage_account(vault_base_url, storage_account_name, active_key_name=None, + auto_regenerate_key=None, regeneration_period=None, storage_account_attributes=None, + tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: active_key_name + description: The current active storage account key name. + defaultValue: None + types: + - + - name: auto_regenerate_key + description: 'whether keyvault should manage the storage + + account for the user.' + defaultValue: None + types: + - + - name: regeneration_period + description: 'The key regeneration time duration + + specified in ISO-8601 format.' + defaultValue: None + types: + - + - name: storage_account_attributes + description: 'The attributes of the storage + + account.' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.verify + name: verify + summary: 'Verifies a signature using a specified key. + + + The VERIFY operation is applicable to symmetric keys stored in Azure + + Key Vault. VERIFY is not strictly necessary for asymmetric keys stored + + in Azure Key Vault since signature verification can be performed using + + the public portion of the key but this operation is supported as a + + convenience for callers that only have a key-reference and not the + + public portion of the key. This operation requires the keys/verify + + permission.' + signature: verify(vault_base_url, key_name, key_version, algorithm, digest, signature, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'The signing/verification algorithm. For more + + information on possible algorithm types, see + + JsonWebKeySignatureAlgorithm. Possible values include: ''PS256'', + + ''PS384'', ''PS512'', ''RS256'', ''RS384'', ''RS512'', ''RSNULL'', ''ES256'', + + ''ES384'', ''ES512'', ''ECDSA256''' + isRequired: true + types: + - + - + - name: digest + description: The digest used for signing. + isRequired: true + types: + - + - name: signature + description: The signature to be verified. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyVerifyResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.KeyVaultClient.wrap_key + name: wrap_key + summary: 'Wraps a symmetric key using a specified key. + + + The WRAP operation supports encryption of a symmetric key using a key + + encryption key that has previously been stored in an Azure Key Vault. + + The WRAP operation is only strictly necessary for symmetric keys stored + + in Azure Key Vault since protection with an asymmetric key can be + + performed using the public portion of the key. This operation is + + supported for asymmetric keys as a convenience for callers that have a + + key-reference but do not have access to the public key material. This + + operation requires the keys/wrapKey permission.' + signature: wrap_key(vault_base_url, key_name, key_version, algorithm, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'algorithm identifier. Possible values include: + + ''RSA-OAEP'', ''RSA-OAEP-256'', ''RSA1_5''' + isRequired: true + types: + - + - + - name: value + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyOperationResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.yml new file mode 100644 index 00000000..f78f25c5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.yml @@ -0,0 +1,4005 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient +name: KeyVaultClient +fullName: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient +module: azure.keyvault.v2016_10_01.key_vault_client +summary: The key vault client performs cryptographic key operations and vault operations + against the Key Vault service. +constructor: + syntax: KeyVaultClient(credentials) + parameters: + - name: credentials + description: Credentials needed for the client to connect to Azure. + isRequired: true + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.backup_key + name: backup_key + summary: 'Requests that a backup of the specified key be downloaded to the + + client. + + + The Key Backup operation exports a key from Azure Key Vault in a + + protected form. Note that this operation does NOT return key material + + in a form that can be used outside the Azure Key Vault system, the + + returned key material is either protected to a Azure Key Vault HSM or + + to Azure Key Vault itself. The intent of this operation is to allow a + + client to GENERATE a key in one Azure Key Vault instance, BACKUP the + + key, and then RESTORE it into another Azure Key Vault instance. The + + BACKUP operation may be used to export, in protected form, any key type + + from Azure Key Vault. Individual versions of a key cannot be backed up. + + BACKUP / RESTORE can be performed within geographical boundaries only; + + meaning that a BACKUP from one geographical area cannot be restored to + + another geographical area. For example, a backup from the US + + geographical area cannot be restored in an EU geographical area. This + + operation requires the key/backup permission.' + signature: backup_key(vault_base_url, key_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: BackupKeyResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.backup_secret + name: backup_secret + summary: 'Backs up the specified secret. + + + Requests that a backup of the specified secret be downloaded to the + + client. All versions of the secret will be downloaded. This operation + + requires the secrets/backup permission.' + signature: backup_secret(vault_base_url, secret_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: BackupSecretResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.create_certificate + name: create_certificate + summary: 'Creates a new certificate. + + + If this is the first version, the certificate resource is created. This + + operation requires the certificates/create permission.' + signature: create_certificate(vault_base_url, certificate_name, certificate_policy=None, + certificate_attributes=None, tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: certificate_policy + description: The management policy for the certificate. + defaultValue: None + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateOperation or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.create_key + name: create_key + summary: 'Creates a new key, stores it, then returns key parameters and + + attributes to the client. + + + The create key operation can be used to create any key type in Azure + + Key Vault. If the named key already exists, Azure Key Vault creates a + + new version of the key. It requires the keys/create permission.' + signature: create_key(vault_base_url, key_name, kty, key_size=None, key_ops=None, + key_attributes=None, tags=None, curve=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: 'The name for the new key. The system will generate + + the version name for the new key.' + isRequired: true + types: + - + - name: kty + description: 'The type of key to create. For valid values, see + + JsonWebKeyType. Possible values include: ''EC'', ''EC-HSM'', ''RSA'', + + ''RSA-HSM'', ''oct''' + isRequired: true + types: + - + - + - name: key_size + description: 'The key size in bits. For example: 2048, 3072, or + + 4096 for RSA.' + defaultValue: None + types: + - + - name: key_ops + defaultValue: None + types: + - [ + - ] + - name: key_attributes + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: curve + description: 'Elliptic curve name. For valid values, see + + JsonWebKeyCurveName. Possible values include: ''P-256'', ''P-384'', + + ''P-521'', ''SECP256K1''' + defaultValue: None + types: + - + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.decrypt + name: decrypt + summary: 'Decrypts a single block of encrypted data. + + + The DECRYPT operation decrypts a well-formed block of ciphertext using + + the target encryption key and specified algorithm. This operation is + + the reverse of the ENCRYPT operation; only a single block of data may + + be decrypted, the size of this block is dependent on the target key and + + the algorithm to be used. The DECRYPT operation applies to asymmetric + + and symmetric keys stored in Azure Key Vault since it uses the private + + portion of the key. This operation requires the keys/decrypt + + permission.' + signature: decrypt(vault_base_url, key_name, key_version, algorithm, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'algorithm identifier. Possible values include: + + ''RSA-OAEP'', ''RSA-OAEP-256'', ''RSA1_5''' + isRequired: true + types: + - + - + - name: value + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyOperationResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.delete_certificate + name: delete_certificate + summary: 'Deletes a certificate from a specified key vault. + + + Deletes all versions of a certificate object along with its associated + + policy. Delete certificate cannot be used to remove individual versions + + of a certificate object. This operation requires the + + certificates/delete permission.' + signature: delete_certificate(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedCertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.delete_certificate_contacts + name: delete_certificate_contacts + summary: 'Deletes the certificate contacts for a specified key vault. + + + Deletes the certificate contacts for a specified key vault certificate. + + This operation requires the certificates/managecontacts permission.' + signature: delete_certificate_contacts(vault_base_url, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Contacts or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.delete_certificate_issuer + name: delete_certificate_issuer + summary: 'Deletes the specified certificate issuer. + + + The DeleteCertificateIssuer operation permanently removes the specified + + certificate issuer from the vault. This operation requires the + + certificates/manageissuers/deleteissuers permission.' + signature: delete_certificate_issuer(vault_base_url, issuer_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: issuer_name + description: The name of the issuer. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: IssuerBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.delete_certificate_operation + name: delete_certificate_operation + summary: 'Deletes the creation operation for a specific certificate. + + + Deletes the creation operation for a specified certificate that is in + + the process of being created. The certificate is no longer created. + + This operation requires the certificates/update permission.' + signature: delete_certificate_operation(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateOperation or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.delete_key + name: delete_key + summary: 'Deletes a key of any type from storage in Azure Key Vault. + + + The delete key operation cannot be used to remove individual versions + + of a key. This operation removes the cryptographic material associated + + with the key, which means the key is not usable for Sign/Verify, + + Wrap/Unwrap or Encrypt/Decrypt operations. This operation requires the + + keys/delete permission.' + signature: delete_key(vault_base_url, key_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key to delete. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedKeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.delete_sas_definition + name: delete_sas_definition + summary: 'Deletes a SAS definition from a specified storage account. This + + operation requires the storage/deletesas permission.' + signature: delete_sas_definition(vault_base_url, storage_account_name, sas_definition_name, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: sas_definition_name + description: The name of the SAS definition. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SasDefinitionBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.delete_secret + name: delete_secret + summary: 'Deletes a secret from a specified key vault. + + + The DELETE operation applies to any secret stored in Azure Key Vault. + + DELETE cannot be applied to an individual version of a secret. This + + operation requires the secrets/delete permission.' + signature: delete_secret(vault_base_url, secret_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedSecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.delete_storage_account + name: delete_storage_account + summary: 'Deletes a storage account. This operation requires the storage/delete + + permission.' + signature: delete_storage_account(vault_base_url, storage_account_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.encrypt + name: encrypt + summary: 'Encrypts an arbitrary sequence of bytes using an encryption key that is + + stored in a key vault. + + + The ENCRYPT operation encrypts an arbitrary sequence of bytes using an + + encryption key that is stored in Azure Key Vault. Note that the ENCRYPT + + operation only supports a single block of data, the size of which is + + dependent on the target key and the encryption algorithm to be used. + + The ENCRYPT operation is only strictly necessary for symmetric keys + + stored in Azure Key Vault since protection with an asymmetric key can + + be performed using public portion of the key. This operation is + + supported for asymmetric keys as a convenience for callers that have a + + key-reference but do not have access to the public key material. This + + operation requires the keys/encypt permission.' + signature: encrypt(vault_base_url, key_name, key_version, algorithm, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'algorithm identifier. Possible values include: + + ''RSA-OAEP'', ''RSA-OAEP-256'', ''RSA1_5''' + isRequired: true + types: + - + - + - name: value + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyOperationResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_certificate + name: get_certificate + summary: 'Gets information about a certificate. + + + Gets information about a specific certificate. This operation requires + + the certificates/get permission.' + signature: get_certificate(vault_base_url, certificate_name, certificate_version, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: 'The name of the certificate in the given + + vault.' + isRequired: true + types: + - + - name: certificate_version + description: The version of the certificate. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_certificate_contacts + name: get_certificate_contacts + summary: 'Lists the certificate contacts for a specified key vault. + + + The GetCertificateContacts operation returns the set of certificate + + contact resources in the specified key vault. This operation requires + + the certificates/managecontacts permission.' + signature: get_certificate_contacts(vault_base_url, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Contacts or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_certificate_issuer + name: get_certificate_issuer + summary: 'Lists the specified certificate issuer. + + + The GetCertificateIssuer operation returns the specified certificate + + issuer resources in the specified key vault. This operation requires + + the certificates/manageissuers/getissuers permission.' + signature: get_certificate_issuer(vault_base_url, issuer_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: issuer_name + description: The name of the issuer. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: IssuerBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_certificate_issuers + name: get_certificate_issuers + summary: 'List certificate issuers for a specified key vault. + + + The GetCertificateIssuers operation returns the set of certificate + + issuer resources in the specified key vault. This operation requires + + the certificates/manageissuers/getissuers permission.' + signature: get_certificate_issuers(vault_base_url, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of CertificateIssuerItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_certificate_operation + name: get_certificate_operation + summary: 'Gets the creation operation of a certificate. + + + Gets the creation operation associated with a specified certificate. + + This operation requires the certificates/get permission.' + signature: get_certificate_operation(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateOperation or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_certificate_policy + name: get_certificate_policy + summary: 'Lists the policy for a certificate. + + + The GetCertificatePolicy operation returns the specified certificate + + policy resources in the specified key vault. This operation requires + + the certificates/get permission.' + signature: get_certificate_policy(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: 'The name of the certificate in a given key + + vault.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificatePolicy or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_certificate_versions + name: get_certificate_versions + summary: 'List the versions of a certificate. + + + The GetCertificateVersions operation returns the versions of a + + certificate in the specified key vault. This operation requires the + + certificates/list permission.' + signature: get_certificate_versions(vault_base_url, certificate_name, maxresults=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of CertificateItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_certificates + name: get_certificates + summary: 'List certificates in a specified key vault. + + + The GetCertificates operation returns the set of certificates resources + + in the specified key vault. This operation requires the + + certificates/list permission.' + signature: get_certificates(vault_base_url, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of CertificateItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_deleted_certificate + name: get_deleted_certificate + summary: 'Retrieves information about the specified deleted certificate. + + + The GetDeletedCertificate operation retrieves the deleted certificate + + information plus its attributes, such as retention interval, scheduled + + permanent deletion and the current deletion recovery level. This + + operation requires the certificates/get permission.' + signature: get_deleted_certificate(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedCertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_deleted_certificates + name: get_deleted_certificates + summary: 'Lists the deleted certificates in the specified vault currently + + available for recovery. + + + The GetDeletedCertificates operation retrieves the certificates in the + + current vault which are in a deleted state and ready for recovery or + + purging. This operation includes deletion-specific information. This + + operation requires the certificates/get/list permission. This operation + + can only be enabled on soft-delete enabled vaults.' + signature: get_deleted_certificates(vault_base_url, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DeletedCertificateItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_deleted_key + name: get_deleted_key + summary: 'Gets the public part of a deleted key. + + + The Get Deleted Key operation is applicable for soft-delete enabled + + vaults. While the operation can be invoked on any vault, it will return + + an error if invoked on a non soft-delete enabled vault. This operation + + requires the keys/get permission. .' + signature: get_deleted_key(vault_base_url, key_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedKeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_deleted_keys + name: get_deleted_keys + summary: 'Lists the deleted keys in the specified vault. + + + Retrieves a list of the keys in the Key Vault as JSON Web Key + + structures that contain the public part of a deleted key. This + + operation includes deletion-specific information. The Get Deleted Keys + + operation is applicable for vaults enabled for soft-delete. While the + + operation can be invoked on any vault, it will return an error if + + invoked on a non soft-delete enabled vault. This operation requires the + + keys/list permission.' + signature: get_deleted_keys(vault_base_url, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DeletedKeyItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_deleted_secret + name: get_deleted_secret + summary: 'Gets the specified deleted secret. + + + The Get Deleted Secret operation returns the specified deleted secret + + along with its attributes. This operation requires the secrets/get + + permission.' + signature: get_deleted_secret(vault_base_url, secret_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedSecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_deleted_secrets + name: get_deleted_secrets + summary: 'Lists deleted secrets for the specified vault. + + + The Get Deleted Secrets operation returns the secrets that have been + + deleted for a vault enabled for soft-delete. This operation requires + + the secrets/list permission.' + signature: get_deleted_secrets(vault_base_url, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DeletedSecretItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_key + name: get_key + summary: 'Gets the public part of a stored key. + + + The get key operation is applicable to all key types. If the requested + + key is symmetric, then no key material is released in the response. + + This operation requires the keys/get permission.' + signature: get_key(vault_base_url, key_name, key_version, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key to get. + isRequired: true + types: + - + - name: key_version + description: 'Adding the version parameter retrieves a specific + + version of a key.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_key_versions + name: get_key_versions + summary: 'Retrieves a list of individual key versions with the same key name. + + + The full key identifier, attributes, and tags are provided in the + + response. This operation requires the keys/list permission.' + signature: get_key_versions(vault_base_url, key_name, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of KeyItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_keys + name: get_keys + summary: 'List keys in the specified vault. + + + Retrieves a list of the keys in the Key Vault as JSON Web Key + + structures that contain the public part of a stored key. The LIST + + operation is applicable to all key types, however only the base key + + identifier, attributes, and tags are provided in the response. + + Individual versions of a key are not listed in the response. This + + operation requires the keys/list permission.' + signature: get_keys(vault_base_url, maxresults=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of KeyItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_sas_definition + name: get_sas_definition + summary: 'Gets information about a SAS definition for the specified storage + + account. This operation requires the storage/getsas permission.' + signature: get_sas_definition(vault_base_url, storage_account_name, sas_definition_name, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: sas_definition_name + description: The name of the SAS definition. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SasDefinitionBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_sas_definitions + name: get_sas_definitions + summary: 'List storage SAS definitions for the given storage account. This + + operation requires the storage/listsas permission.' + signature: get_sas_definitions(vault_base_url, storage_account_name, maxresults=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of SasDefinitionItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_secret + name: get_secret + summary: 'Get a specified secret from a given key vault. + + + The GET operation is applicable to any secret stored in Azure Key + + Vault. This operation requires the secrets/get permission.' + signature: get_secret(vault_base_url, secret_name, secret_version, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: secret_version + description: The version of the secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_secret_versions + name: get_secret_versions + summary: 'List all versions of the specified secret. + + + The full secret identifier and attributes are provided in the response. + + No values are returned for the secrets. This operations requires the + + secrets/list permission.' + signature: get_secret_versions(vault_base_url, secret_name, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified, the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of SecretItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_secrets + name: get_secrets + summary: 'List secrets in a specified key vault. + + + The Get Secrets operation is applicable to the entire vault. However, + + only the base secret identifier and its attributes are provided in the + + response. Individual secret versions are not listed in the response. + + This operation requires the secrets/list permission.' + signature: get_secrets(vault_base_url, maxresults=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified, the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of SecretItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_storage_account + name: get_storage_account + summary: 'Gets information about a specified storage account. This operation + + requires the storage/get permission.' + signature: get_storage_account(vault_base_url, storage_account_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.get_storage_accounts + name: get_storage_accounts + summary: 'List storage accounts managed by the specified key vault. This + + operation requires the storage/list permission.' + signature: get_storage_accounts(vault_base_url, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of StorageAccountItem + types: + - [] + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.import_certificate + name: import_certificate + summary: 'Imports a certificate into a specified key vault. + + + Imports an existing valid certificate, containing a private key, into + + Azure Key Vault. The certificate to be imported can be in either PFX or + + PEM format. If the certificate is in PEM format the PEM file must + + contain the key as well as x509 certificates. This operation requires + + the certificates/import permission.' + signature: import_certificate(vault_base_url, certificate_name, base64_encoded_certificate, + password=None, certificate_policy=None, certificate_attributes=None, tags=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: base64_encoded_certificate + description: 'Base64 encoded representation of + + the certificate object to import. This certificate needs to contain + + the private key.' + isRequired: true + types: + - + - name: password + description: 'If the private key in base64EncodedCertificate is + + encrypted, the password used for encryption.' + defaultValue: None + types: + - + - name: certificate_policy + description: The management policy for the certificate. + defaultValue: None + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.import_key + name: import_key + summary: 'Imports an externally created key, stores it, and returns key + + parameters and attributes to the client. + + + The import key operation may be used to import any key type into an + + Azure Key Vault. If the named key already exists, Azure Key Vault + + creates a new version of the key. This operation requires the + + keys/import permission.' + signature: import_key(vault_base_url, key_name, key, hsm=None, key_attributes=None, + tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: Name for the imported key. + isRequired: true + types: + - + - name: key + description: The Json web key + isRequired: true + types: + - + - name: hsm + description: Whether to import as a hardware key (HSM) or software key. + defaultValue: None + types: + - + - name: key_attributes + description: The key management attributes. + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.merge_certificate + name: merge_certificate + summary: 'Merges a certificate or a certificate chain with a key pair existing on + + the server. + + + The MergeCertificate operation performs the merging of a certificate or + + certificate chain with a key pair currently available in the service. + + This operation requires the certificates/create permission.' + signature: merge_certificate(vault_base_url, certificate_name, x509_certificates, + certificate_attributes=None, tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: x509_certificates + description: 'The certificate or the certificate chain to + + merge.' + isRequired: true + types: + - [] + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.purge_deleted_certificate + name: purge_deleted_certificate + summary: 'Permanently deletes the specified deleted certificate. + + + The PurgeDeletedCertificate operation performs an irreversible deletion + + of the specified certificate, without possibility for recovery. The + + operation is not available if the recovery level does not specify + + ''Purgeable''. This operation requires the certificate/purge permission.' + signature: purge_deleted_certificate(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.purge_deleted_key + name: purge_deleted_key + summary: 'Permanently deletes the specified key. + + + The Purge Deleted Key operation is applicable for soft-delete enabled + + vaults. While the operation can be invoked on any vault, it will return + + an error if invoked on a non soft-delete enabled vault. This operation + + requires the keys/purge permission.' + signature: purge_deleted_key(vault_base_url, key_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.purge_deleted_secret + name: purge_deleted_secret + summary: 'Permanently deletes the specified secret. + + + The purge deleted secret operation removes the secret permanently, + + without the possibility of recovery. This operation can only be enabled + + on a soft-delete enabled vault. This operation requires the + + secrets/purge permission.' + signature: purge_deleted_secret(vault_base_url, secret_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.recover_deleted_certificate + name: recover_deleted_certificate + summary: 'Recovers the deleted certificate back to its current version under + + /certificates. + + + The RecoverDeletedCertificate operation performs the reversal of the + + Delete operation. The operation is applicable in vaults enabled for + + soft-delete, and must be issued during the retention interval + + (available in the deleted certificate''s attributes). This operation + + requires the certificates/recover permission.' + signature: recover_deleted_certificate(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the deleted certificate + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.recover_deleted_key + name: recover_deleted_key + summary: 'Recovers the deleted key to its latest version. + + + The Recover Deleted Key operation is applicable for deleted keys in + + soft-delete enabled vaults. It recovers the deleted key back to its + + latest version under /keys. An attempt to recover an non-deleted key + + will return an error. Consider this the inverse of the delete operation + + on soft-delete enabled vaults. This operation requires the keys/recover + + permission.' + signature: recover_deleted_key(vault_base_url, key_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the deleted key. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.recover_deleted_secret + name: recover_deleted_secret + summary: 'Recovers the deleted secret to the latest version. + + + Recovers the deleted secret in the specified vault. This operation can + + only be performed on a soft-delete enabled vault. This operation + + requires the secrets/recover permission.' + signature: recover_deleted_secret(vault_base_url, secret_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the deleted secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.regenerate_storage_account_key + name: regenerate_storage_account_key + summary: 'Regenerates the specified key value for the given storage account. This + + operation requires the storage/regeneratekey permission.' + signature: regenerate_storage_account_key(vault_base_url, storage_account_name, + key_name, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: key_name + description: The storage account key name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.restore_key + name: restore_key + summary: 'Restores a backed up key to a vault. + + + Imports a previously backed up key into Azure Key Vault, restoring the + + key, its key identifier, attributes and access control policies. The + + RESTORE operation may be used to import a previously backed up key. + + Individual versions of a key cannot be restored. The key is restored in + + its entirety with the same key name as it had when it was backed up. If + + the key name is not available in the target Key Vault, the RESTORE + + operation will be rejected. While the key name is retained during + + restore, the final key identifier will change if the key is restored to + + a different vault. Restore will restore all versions and preserve + + version identifiers. The RESTORE operation is subject to security + + constraints: The target Key Vault must be owned by the same Microsoft + + Azure Subscription as the source Key Vault The user must have RESTORE + + permission in the target Key Vault. This operation requires the + + keys/restore permission.' + signature: restore_key(vault_base_url, key_bundle_backup, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_bundle_backup + description: 'The backup blob associated with a key + + bundle.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.restore_secret + name: restore_secret + summary: 'Restores a backed up secret to a vault. + + + Restores a backed up secret, and all its versions, to a vault. This + + operation requires the secrets/restore permission.' + signature: restore_secret(vault_base_url, secret_bundle_backup, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_bundle_backup + description: 'The backup blob associated with a secret + + bundle.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.set_certificate_contacts + name: set_certificate_contacts + summary: 'Sets the certificate contacts for the specified key vault. + + + Sets the certificate contacts for the specified key vault. This + + operation requires the certificates/managecontacts permission.' + signature: set_certificate_contacts(vault_base_url, contact_list=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: contact_list + description: The contact list for the vault certificates. + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Contacts or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.set_certificate_issuer + name: set_certificate_issuer + summary: 'Sets the specified certificate issuer. + + + The SetCertificateIssuer operation adds or updates the specified + + certificate issuer. This operation requires the certificates/setissuers + + permission.' + signature: set_certificate_issuer(vault_base_url, issuer_name, provider, credentials=None, + organization_details=None, attributes=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: issuer_name + description: The name of the issuer. + isRequired: true + types: + - + - name: provider + description: The issuer provider. + isRequired: true + types: + - + - name: credentials + description: The credentials to be used for the issuer. + defaultValue: None + types: + - + - name: organization_details + description: 'Details of the organization as provided + + to the issuer.' + defaultValue: None + types: + - + - name: attributes + description: Attributes of the issuer object. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: IssuerBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.set_sas_definition + name: set_sas_definition + summary: 'Creates or updates a new SAS definition for the specified storage + + account. This operation requires the storage/setsas permission.' + signature: set_sas_definition(vault_base_url, storage_account_name, sas_definition_name, + parameters, sas_definition_attributes=None, tags=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: sas_definition_name + description: The name of the SAS definition. + isRequired: true + types: + - + - name: parameters + description: 'Sas definition creation metadata in the form of + + key-value pairs.' + isRequired: true + types: + - [, ] + - name: sas_definition_attributes + description: 'The attributes of the SAS + + definition.' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SasDefinitionBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.set_secret + name: set_secret + summary: 'Sets a secret in a specified key vault. + + + The SET operation adds a secret to the Azure Key Vault. If the named + + secret already exists, Azure Key Vault creates a new version of that + + secret. This operation requires the secrets/set permission.' + signature: set_secret(vault_base_url, secret_name, value, tags=None, content_type=None, + secret_attributes=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: value + description: The value of the secret. + isRequired: true + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: content_type + description: Type of the secret value such as a password. + defaultValue: None + types: + - + - name: secret_attributes + description: The secret management attributes. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.set_storage_account + name: set_storage_account + summary: 'Creates or updates a new storage account. This operation requires the + + storage/set permission.' + signature: set_storage_account(vault_base_url, storage_account_name, resource_id, + active_key_name, auto_regenerate_key, regeneration_period=None, storage_account_attributes=None, + tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: resource_id + description: Storage account resource id. + isRequired: true + types: + - + - name: active_key_name + description: Current active storage account key name. + isRequired: true + types: + - + - name: auto_regenerate_key + description: 'whether keyvault should manage the storage + + account for the user.' + isRequired: true + types: + - + - name: regeneration_period + description: 'The key regeneration time duration + + specified in ISO-8601 format.' + defaultValue: None + types: + - + - name: storage_account_attributes + description: 'The attributes of the storage + + account.' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.sign + name: sign + summary: 'Creates a signature from a digest using the specified key. + + + The SIGN operation is applicable to asymmetric and symmetric keys + + stored in Azure Key Vault since this operation uses the private portion + + of the key. This operation requires the keys/sign permission.' + signature: sign(vault_base_url, key_name, key_version, algorithm, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'The signing/verification algorithm identifier. For + + more information on possible algorithm types, see + + JsonWebKeySignatureAlgorithm. Possible values include: ''PS256'', + + ''PS384'', ''PS512'', ''RS256'', ''RS384'', ''RS512'', ''RSNULL'', ''ES256'', + + ''ES384'', ''ES512'', ''ECDSA256''' + isRequired: true + types: + - + - + - name: value + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyOperationResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.unwrap_key + name: unwrap_key + summary: 'Unwraps a symmetric key using the specified key that was initially used + + for wrapping that key. + + + The UNWRAP operation supports decryption of a symmetric key using the + + target key encryption key. This operation is the reverse of the WRAP + + operation. The UNWRAP operation applies to asymmetric and symmetric + + keys stored in Azure Key Vault since it uses the private portion of the + + key. This operation requires the keys/unwrapKey permission.' + signature: unwrap_key(vault_base_url, key_name, key_version, algorithm, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'algorithm identifier. Possible values include: + + ''RSA-OAEP'', ''RSA-OAEP-256'', ''RSA1_5''' + isRequired: true + types: + - + - + - name: value + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyOperationResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.update_certificate + name: update_certificate + summary: 'Updates the specified attributes associated with the given certificate. + + + The UpdateCertificate operation applies the specified update on the + + given certificate; the only elements updated are the certificate''s + + attributes. This operation requires the certificates/update permission.' + signature: update_certificate(vault_base_url, certificate_name, certificate_version, + certificate_policy=None, certificate_attributes=None, tags=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: 'The name of the certificate in the given key + + vault.' + isRequired: true + types: + - + - name: certificate_version + description: The version of the certificate. + isRequired: true + types: + - + - name: certificate_policy + description: The management policy for the certificate. + defaultValue: None + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.update_certificate_issuer + name: update_certificate_issuer + summary: 'Updates the specified certificate issuer. + + + The UpdateCertificateIssuer operation performs an update on the + + specified certificate issuer entity. This operation requires the + + certificates/setissuers permission.' + signature: update_certificate_issuer(vault_base_url, issuer_name, provider=None, + credentials=None, organization_details=None, attributes=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: issuer_name + description: The name of the issuer. + isRequired: true + types: + - + - name: provider + description: The issuer provider. + defaultValue: None + types: + - + - name: credentials + description: The credentials to be used for the issuer. + defaultValue: None + types: + - + - name: organization_details + description: 'Details of the organization as provided + + to the issuer.' + defaultValue: None + types: + - + - name: attributes + description: Attributes of the issuer object. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: IssuerBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.update_certificate_operation + name: update_certificate_operation + summary: 'Updates a certificate operation. + + + Updates a certificate creation operation that is already in progress. + + This operation requires the certificates/update permission.' + signature: update_certificate_operation(vault_base_url, certificate_name, cancellation_requested, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: cancellation_requested + description: 'Indicates if cancellation was requested + + on the certificate operation.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateOperation or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.update_certificate_policy + name: update_certificate_policy + summary: 'Updates the policy for a certificate. + + + Set specified members in the certificate policy. Leave others as null. + + This operation requires the certificates/update permission.' + signature: update_certificate_policy(vault_base_url, certificate_name, certificate_policy, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: 'The name of the certificate in the given + + vault.' + isRequired: true + types: + - + - name: certificate_policy + description: The policy for the certificate. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificatePolicy or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.update_key + name: update_key + summary: 'The update key operation changes specified attributes of a stored key + + and can be applied to any key type and key version stored in Azure Key + + Vault. + + + In order to perform this operation, the key must already exist in the + + Key Vault. Note: The cryptographic material of a key itself cannot be + + changed. This operation requires the keys/update permission.' + signature: update_key(vault_base_url, key_name, key_version, key_ops=None, key_attributes=None, + tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of key to update. + isRequired: true + types: + - + - name: key_version + description: The version of the key to update. + isRequired: true + types: + - + - name: key_ops + description: 'Json web key operations. For more information on + + possible key operations, see JsonWebKeyOperation.' + defaultValue: None + types: + - [ + - ] + - name: key_attributes + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.update_sas_definition + name: update_sas_definition + summary: 'Updates the specified attributes associated with the given SAS + + definition. This operation requires the storage/setsas permission.' + signature: update_sas_definition(vault_base_url, storage_account_name, sas_definition_name, + parameters=None, sas_definition_attributes=None, tags=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: sas_definition_name + description: The name of the SAS definition. + isRequired: true + types: + - + - name: parameters + description: 'Sas definition update metadata in the form of + + key-value pairs.' + defaultValue: None + types: + - [, ] + - name: sas_definition_attributes + description: 'The attributes of the SAS + + definition.' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SasDefinitionBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.update_secret + name: update_secret + summary: 'Updates the attributes associated with a specified secret in a given + + key vault. + + + The UPDATE operation changes specified attributes of an existing stored + + secret. Attributes that are not specified in the request are left + + unchanged. The value of a secret itself cannot be changed. This + + operation requires the secrets/set permission.' + signature: update_secret(vault_base_url, secret_name, secret_version, content_type=None, + secret_attributes=None, tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: secret_version + description: The version of the secret. + isRequired: true + types: + - + - name: content_type + description: Type of the secret value such as a password. + defaultValue: None + types: + - + - name: secret_attributes + description: The secret management attributes. + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.update_storage_account + name: update_storage_account + summary: 'Updates the specified attributes associated with the given storage + + account. This operation requires the storage/set/update permission.' + signature: update_storage_account(vault_base_url, storage_account_name, active_key_name=None, + auto_regenerate_key=None, regeneration_period=None, storage_account_attributes=None, + tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: active_key_name + description: The current active storage account key name. + defaultValue: None + types: + - + - name: auto_regenerate_key + description: 'whether keyvault should manage the storage + + account for the user.' + defaultValue: None + types: + - + - name: regeneration_period + description: 'The key regeneration time duration + + specified in ISO-8601 format.' + defaultValue: None + types: + - + - name: storage_account_attributes + description: 'The attributes of the storage + + account.' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.verify + name: verify + summary: 'Verifies a signature using a specified key. + + + The VERIFY operation is applicable to symmetric keys stored in Azure + + Key Vault. VERIFY is not strictly necessary for asymmetric keys stored + + in Azure Key Vault since signature verification can be performed using + + the public portion of the key but this operation is supported as a + + convenience for callers that only have a key-reference and not the + + public portion of the key. This operation requires the keys/verify + + permission.' + signature: verify(vault_base_url, key_name, key_version, algorithm, digest, signature, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'The signing/verification algorithm. For more + + information on possible algorithm types, see + + JsonWebKeySignatureAlgorithm. Possible values include: ''PS256'', + + ''PS384'', ''PS512'', ''RS256'', ''RS384'', ''RS512'', ''RSNULL'', ''ES256'', + + ''ES384'', ''ES512'', ''ECDSA256''' + isRequired: true + types: + - + - + - name: digest + description: The digest used for signing. + isRequired: true + types: + - + - name: signature + description: The signature to be verified. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyVerifyResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient.wrap_key + name: wrap_key + summary: 'Wraps a symmetric key using a specified key. + + + The WRAP operation supports encryption of a symmetric key using a key + + encryption key that has previously been stored in an Azure Key Vault. + + The WRAP operation is only strictly necessary for symmetric keys stored + + in Azure Key Vault since protection with an asymmetric key can be + + performed using the public portion of the key. This operation is + + supported for asymmetric keys as a convenience for callers that have a + + key-reference but do not have access to the public key material. This + + operation requires the keys/wrapKey permission.' + signature: wrap_key(vault_base_url, key_name, key_version, algorithm, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'algorithm identifier. Possible values include: + + ''RSA-OAEP'', ''RSA-OAEP-256'', ''RSA1_5''' + isRequired: true + types: + - + - + - name: value + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyOperationResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v2016_10_01.models.KeyVaultErrorException diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClientConfiguration.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClientConfiguration.yml new file mode 100644 index 00000000..a8c9db26 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClientConfiguration.yml @@ -0,0 +1,59 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClientConfiguration +name: KeyVaultClientConfiguration +fullName: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClientConfiguration +module: azure.keyvault.v2016_10_01.key_vault_client +summary: 'Configuration for KeyVaultClient + + Note that all parameters used to create this instance are saved as instance + + attributes.' +constructor: + syntax: KeyVaultClientConfiguration(credentials) + parameters: + - name: credentials + description: Credentials needed for the client to connect to Azure. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClientConfiguration.add_user_agent + name: add_user_agent + summary: Add value to current user agent with a space. + signature: 'add_user_agent(value: str) -> None' + parameters: + - name: value + description: value to add to user agent. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClientConfiguration.load + name: load + summary: Load configuration from existing file. + signature: load(filepath) + parameters: + - name: filepath + description: Path to existing config file. + isRequired: true + types: + - + exceptions: + - type: ValueError if supplied config file is invalid. +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClientConfiguration.save + name: save + summary: Save current configuration to file. + signature: save(filepath) + parameters: + - name: filepath + description: Path to save file to. + isRequired: true + types: + - + exceptions: + - type: ValueError if supplied filepath cannot be written to. +attributes: +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClientConfiguration.enable_http_logger + name: enable_http_logger +- uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClientConfiguration.user_agent + name: user_agent + summary: The current user agent value. diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.key_vault_client.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.key_vault_client.yml new file mode 100644 index 00000000..b57dc15a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.key_vault_client.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.key_vault_client +name: key_vault_client +fullName: azure.keyvault.v2016_10_01.key_vault_client +classes: +- azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient +- azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClientConfiguration diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Action(class).yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Action(class).yml new file mode 100644 index 00000000..40175b27 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Action(class).yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.Action +name: Action +fullName: azure.keyvault.v2016_10_01.models.Action +module: azure.keyvault.v2016_10_01.models +summary: The action that will be executed. +constructor: + syntax: Action(*, action_type=None, **kwargs) + parameters: + - name: action_type + description: 'The type of the action. Possible values include: + + ''EmailContacts'', ''AutoRenew''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: action_type + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.Action.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.Action.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.Action.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.Action.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.Action.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.Action.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.Action.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.ActionType.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.ActionType.yml new file mode 100644 index 00000000..a66a4db8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.ActionType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v2016_10_01.models.ActionType +name: ActionType +fullName: azure.keyvault.v2016_10_01.models.ActionType +module: azure.keyvault.v2016_10_01.models +fields: +- name: auto_renew + uid: azure.keyvault.v2016_10_01.models.ActionType.auto_renew +- name: email_contacts + uid: azure.keyvault.v2016_10_01.models.ActionType.email_contacts diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.AdministratorDetails.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.AdministratorDetails.yml new file mode 100644 index 00000000..d3cb41f9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.AdministratorDetails.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.AdministratorDetails +name: AdministratorDetails +fullName: azure.keyvault.v2016_10_01.models.AdministratorDetails +module: azure.keyvault.v2016_10_01.models +summary: Details of the organization administrator of the certificate issuer. +constructor: + syntax: 'AdministratorDetails(*, first_name: str = None, last_name: str = None, + email_address: str = None, phone: str = None, **kwargs)' + parameters: + - name: first_name + description: First name. + isRequired: true + types: + - + - name: last_name + description: Last name. + isRequired: true + types: + - + - name: email_address + description: Email addresss. + isRequired: true + types: + - + - name: phone + description: Phone number. + isRequired: true + types: + - + keywordOnlyParameters: + - name: first_name + isRequired: true + - name: last_name + isRequired: true + - name: email_address + isRequired: true + - name: phone + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.AdministratorDetails.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.AdministratorDetails.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.AdministratorDetails.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.AdministratorDetails.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.AdministratorDetails.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.AdministratorDetails.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.AdministratorDetails.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Attributes(class).yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Attributes(class).yml new file mode 100644 index 00000000..275545cd --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Attributes(class).yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.Attributes +name: Attributes +fullName: azure.keyvault.v2016_10_01.models.Attributes +module: azure.keyvault.v2016_10_01.models +summary: 'The object attributes managed by the KeyVault service. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'Attributes(*, enabled: bool = None, not_before=None, expires=None, **kwargs)' + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true + - name: not_before + isRequired: true + - name: expires + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.Attributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.Attributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.Attributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.Attributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.Attributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.Attributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.Attributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.BackupKeyResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.BackupKeyResult.yml new file mode 100644 index 00000000..906485d5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.BackupKeyResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.BackupKeyResult +name: BackupKeyResult +fullName: azure.keyvault.v2016_10_01.models.BackupKeyResult +module: azure.keyvault.v2016_10_01.models +summary: 'The backup key result, containing the backup blob. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: BackupKeyResult(**kwargs) +variables: +- description: The backup blob containing the backed up key. + name: value + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.BackupKeyResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.BackupKeyResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.BackupKeyResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.BackupKeyResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.BackupKeyResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.BackupKeyResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.BackupKeyResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.BackupSecretResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.BackupSecretResult.yml new file mode 100644 index 00000000..c49198d2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.BackupSecretResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.BackupSecretResult +name: BackupSecretResult +fullName: azure.keyvault.v2016_10_01.models.BackupSecretResult +module: azure.keyvault.v2016_10_01.models +summary: 'The backup secret result, containing the backup blob. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: BackupSecretResult(**kwargs) +variables: +- description: The backup blob containing the backed up secret. + name: value + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.BackupSecretResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.BackupSecretResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.BackupSecretResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.BackupSecretResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.BackupSecretResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.BackupSecretResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.BackupSecretResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateAttributes.yml new file mode 100644 index 00000000..fa085851 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateAttributes.yml @@ -0,0 +1,169 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.CertificateAttributes +name: CertificateAttributes +fullName: azure.keyvault.v2016_10_01.models.CertificateAttributes +module: azure.keyvault.v2016_10_01.models +summary: 'The certificate management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'CertificateAttributes(*, enabled: bool = None, not_before=None, expires=None, + **kwargs)' + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true + - name: not_before + isRequired: true + - name: expires + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for certificates in the current vault. If it contains ''Purgeable'', + + the certificate can be permanently deleted by a privileged user; + + otherwise, only the system can purge the certificate, at the end of the + + retention interval. Possible values include: ''Purgeable'', + + ''Recoverable+Purgeable'', ''Recoverable'', + + ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v2016_10_01.models.CertificateAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.CertificateAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.CertificateAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateBundle.yml new file mode 100644 index 00000000..54ff1209 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateBundle.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.CertificateBundle +name: CertificateBundle +fullName: azure.keyvault.v2016_10_01.models.CertificateBundle +module: azure.keyvault.v2016_10_01.models +summary: 'A certificate bundle consists of a certificate (X509) plus its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'CertificateBundle(*, cer: bytearray = None, content_type: str = None, attributes=None, + tags=None, **kwargs)' + parameters: + - name: cer + description: CER contents of x509 certificate. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The certificate attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: cer + isRequired: true + - name: content_type + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true +variables: +- description: The certificate id. + name: id + types: + - +- description: The key id. + name: kid + types: + - +- description: The secret id. + name: sid + types: + - +- description: Thumbprint of the certificate. + name: x509_thumbprint + types: + - +- description: The management policy. + name: policy + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.CertificateBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.CertificateBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.CertificateBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateCreateParameters.yml new file mode 100644 index 00000000..1201867c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateCreateParameters.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.CertificateCreateParameters +name: CertificateCreateParameters +fullName: azure.keyvault.v2016_10_01.models.CertificateCreateParameters +module: azure.keyvault.v2016_10_01.models +summary: The certificate create parameters. +constructor: + syntax: CertificateCreateParameters(*, certificate_policy=None, certificate_attributes=None, + tags=None, **kwargs) + parameters: + - name: certificate_policy + description: The management policy for the certificate. + isRequired: true + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: certificate_policy + isRequired: true + - name: certificate_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.CertificateCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.CertificateCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.CertificateCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateImportParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateImportParameters.yml new file mode 100644 index 00000000..cdbe7a48 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateImportParameters.yml @@ -0,0 +1,163 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.CertificateImportParameters +name: CertificateImportParameters +fullName: azure.keyvault.v2016_10_01.models.CertificateImportParameters +module: azure.keyvault.v2016_10_01.models +summary: 'The certificate import parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CertificateImportParameters(*, base64_encoded_certificate: str, password: + str = None, certificate_policy=None, certificate_attributes=None, tags=None, **kwargs)' + parameters: + - name: base64_encoded_certificate + description: 'Required. Base64 encoded representation + + of the certificate object to import. This certificate needs to contain the + + private key.' + isRequired: true + types: + - + - name: password + description: 'If the private key in base64EncodedCertificate is + + encrypted, the password used for encryption.' + isRequired: true + types: + - + - name: certificate_policy + description: The management policy for the certificate. + isRequired: true + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: base64_encoded_certificate + isRequired: true + - name: password + isRequired: true + - name: certificate_policy + isRequired: true + - name: certificate_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.CertificateImportParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateImportParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateImportParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.CertificateImportParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateImportParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.CertificateImportParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateImportParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerItem.yml new file mode 100644 index 00000000..1877dc7e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerItem.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.CertificateIssuerItem +name: CertificateIssuerItem +fullName: azure.keyvault.v2016_10_01.models.CertificateIssuerItem +module: azure.keyvault.v2016_10_01.models +summary: The certificate issuer item containing certificate issuer metadata. +constructor: + syntax: 'CertificateIssuerItem(*, id: str = None, provider: str = None, **kwargs)' + parameters: + - name: id + description: Certificate Identifier. + isRequired: true + types: + - + - name: provider + description: The issuer provider. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: provider + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerItemPaged.yml new file mode 100644 index 00000000..cc541145 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.CertificateIssuerItemPaged +name: CertificateIssuerItemPaged +fullName: azure.keyvault.v2016_10_01.models.CertificateIssuerItemPaged +module: azure.keyvault.v2016_10_01.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: CertificateIssuerItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerSetParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerSetParameters.yml new file mode 100644 index 00000000..926750a5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerSetParameters.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.CertificateIssuerSetParameters +name: CertificateIssuerSetParameters +fullName: azure.keyvault.v2016_10_01.models.CertificateIssuerSetParameters +module: azure.keyvault.v2016_10_01.models +summary: 'The certificate issuer set parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CertificateIssuerSetParameters(*, provider: str, credentials=None, organization_details=None, + attributes=None, **kwargs)' + parameters: + - name: provider + description: Required. The issuer provider. + isRequired: true + types: + - + - name: credentials + description: The credentials to be used for the issuer. + isRequired: true + types: + - + - name: organization_details + description: 'Details of the organization as provided to + + the issuer.' + isRequired: true + types: + - + - name: attributes + description: Attributes of the issuer object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: provider + isRequired: true + - name: credentials + isRequired: true + - name: organization_details + isRequired: true + - name: attributes + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerSetParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerSetParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerSetParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerSetParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerSetParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerSetParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerSetParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerUpdateParameters.yml new file mode 100644 index 00000000..8e2c3df8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerUpdateParameters.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.CertificateIssuerUpdateParameters +name: CertificateIssuerUpdateParameters +fullName: azure.keyvault.v2016_10_01.models.CertificateIssuerUpdateParameters +module: azure.keyvault.v2016_10_01.models +summary: The certificate issuer update parameters. +constructor: + syntax: 'CertificateIssuerUpdateParameters(*, provider: str = None, credentials=None, + organization_details=None, attributes=None, **kwargs)' + parameters: + - name: provider + description: The issuer provider. + isRequired: true + types: + - + - name: credentials + description: The credentials to be used for the issuer. + isRequired: true + types: + - + - name: organization_details + description: 'Details of the organization as provided to + + the issuer.' + isRequired: true + types: + - + - name: attributes + description: Attributes of the issuer object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: provider + isRequired: true + - name: credentials + isRequired: true + - name: organization_details + isRequired: true + - name: attributes + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateIssuerUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateItem.yml new file mode 100644 index 00000000..4ffcee9a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateItem.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.CertificateItem +name: CertificateItem +fullName: azure.keyvault.v2016_10_01.models.CertificateItem +module: azure.keyvault.v2016_10_01.models +summary: The certificate item containing certificate metadata. +constructor: + syntax: 'CertificateItem(*, id: str = None, attributes=None, tags=None, x509_thumbprint: + bytes = None, **kwargs)' + parameters: + - name: id + description: Certificate identifier. + isRequired: true + types: + - + - name: attributes + description: The certificate management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: x509_thumbprint + description: Thumbprint of the certificate. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: x509_thumbprint + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.CertificateItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.CertificateItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.CertificateItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateItemPaged.yml new file mode 100644 index 00000000..122ef688 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.CertificateItemPaged +name: CertificateItemPaged +fullName: azure.keyvault.v2016_10_01.models.CertificateItemPaged +module: azure.keyvault.v2016_10_01.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: CertificateItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v2016_10_01.models.CertificateItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v2016_10_01.models.CertificateItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v2016_10_01.models.CertificateItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v2016_10_01.models.CertificateItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v2016_10_01.models.CertificateItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateMergeParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateMergeParameters.yml new file mode 100644 index 00000000..442b2f0f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateMergeParameters.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.CertificateMergeParameters +name: CertificateMergeParameters +fullName: azure.keyvault.v2016_10_01.models.CertificateMergeParameters +module: azure.keyvault.v2016_10_01.models +summary: 'The certificate merge parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CertificateMergeParameters(*, x509_certificates, certificate_attributes=None, + tags=None, **kwargs) + parameters: + - name: x509_certificates + description: 'Required. The certificate or the certificate + + chain to merge.' + isRequired: true + types: + - [] + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: x509_certificates + isRequired: true + - name: certificate_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.CertificateMergeParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateMergeParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateMergeParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.CertificateMergeParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateMergeParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.CertificateMergeParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateMergeParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateOperation.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateOperation.yml new file mode 100644 index 00000000..187a657d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateOperation.yml @@ -0,0 +1,192 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.CertificateOperation +name: CertificateOperation +fullName: azure.keyvault.v2016_10_01.models.CertificateOperation +module: azure.keyvault.v2016_10_01.models +summary: 'A certificate operation is returned in case of asynchronous requests. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'CertificateOperation(*, issuer_parameters=None, csr: bytearray = None, + cancellation_requested: bool = None, status: str = None, status_details: str = + None, error=None, target: str = None, request_id: str = None, **kwargs)' + parameters: + - name: issuer_parameters + description: 'Parameters for the issuer of the X509 component + + of a certificate.' + isRequired: true + types: + - + - name: csr + description: 'The certificate signing request (CSR) that is being used in + + the certificate operation.' + isRequired: true + types: + - + - name: cancellation_requested + description: 'Indicates if cancellation was requested on + + the certificate operation.' + isRequired: true + types: + - + - name: status + description: Status of the certificate operation. + isRequired: true + types: + - + - name: status_details + description: The status details of the certificate operation. + isRequired: true + types: + - + - name: error + description: Error encountered, if any, during the certificate operation. + isRequired: true + types: + - + - name: target + description: 'Location which contains the result of the certificate + + operation.' + isRequired: true + types: + - + - name: request_id + description: Identifier for the certificate operation. + isRequired: true + types: + - + keywordOnlyParameters: + - name: issuer_parameters + isRequired: true + - name: csr + isRequired: true + - name: cancellation_requested + isRequired: true + - name: status + isRequired: true + - name: status_details + isRequired: true + - name: error + isRequired: true + - name: target + isRequired: true + - name: request_id + isRequired: true +variables: +- description: The certificate id. + name: id + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.CertificateOperation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateOperation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateOperation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.CertificateOperation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateOperation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.CertificateOperation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateOperation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateOperationUpdateParameter.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateOperationUpdateParameter.yml new file mode 100644 index 00000000..79ab5cef --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateOperationUpdateParameter.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.CertificateOperationUpdateParameter +name: CertificateOperationUpdateParameter +fullName: azure.keyvault.v2016_10_01.models.CertificateOperationUpdateParameter +module: azure.keyvault.v2016_10_01.models +summary: 'The certificate operation update parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CertificateOperationUpdateParameter(*, cancellation_requested: bool, **kwargs)' + parameters: + - name: cancellation_requested + description: 'Required. Indicates if cancellation was + + requested on the certificate operation.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cancellation_requested + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.CertificateOperationUpdateParameter.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateOperationUpdateParameter.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateOperationUpdateParameter.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.CertificateOperationUpdateParameter.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateOperationUpdateParameter.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.CertificateOperationUpdateParameter.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateOperationUpdateParameter.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificatePolicy.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificatePolicy.yml new file mode 100644 index 00000000..6653d5b7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificatePolicy.yml @@ -0,0 +1,175 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.CertificatePolicy +name: CertificatePolicy +fullName: azure.keyvault.v2016_10_01.models.CertificatePolicy +module: azure.keyvault.v2016_10_01.models +summary: 'Management policy for a certificate. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: CertificatePolicy(*, key_properties=None, secret_properties=None, x509_certificate_properties=None, + lifetime_actions=None, issuer_parameters=None, attributes=None, **kwargs) + parameters: + - name: key_properties + description: Properties of the key backing a certificate. + isRequired: true + types: + - + - name: secret_properties + description: Properties of the secret backing a certificate. + isRequired: true + types: + - + - name: x509_certificate_properties + description: 'Properties of the X509 component of a + + certificate.' + isRequired: true + types: + - + - name: lifetime_actions + description: 'Actions that will be performed by Key Vault over + + the lifetime of a certificate.' + isRequired: true + types: + - [] + - name: issuer_parameters + description: 'Parameters for the issuer of the X509 component + + of a certificate.' + isRequired: true + types: + - + - name: attributes + description: The certificate attributes. + isRequired: true + types: + - + keywordOnlyParameters: + - name: key_properties + isRequired: true + - name: secret_properties + isRequired: true + - name: x509_certificate_properties + isRequired: true + - name: lifetime_actions + isRequired: true + - name: issuer_parameters + isRequired: true + - name: attributes + isRequired: true +variables: +- description: The certificate id. + name: id + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.CertificatePolicy.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificatePolicy.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificatePolicy.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.CertificatePolicy.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificatePolicy.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.CertificatePolicy.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificatePolicy.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateUpdateParameters.yml new file mode 100644 index 00000000..9635180a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateUpdateParameters.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.CertificateUpdateParameters +name: CertificateUpdateParameters +fullName: azure.keyvault.v2016_10_01.models.CertificateUpdateParameters +module: azure.keyvault.v2016_10_01.models +summary: The certificate update parameters. +constructor: + syntax: CertificateUpdateParameters(*, certificate_policy=None, certificate_attributes=None, + tags=None, **kwargs) + parameters: + - name: certificate_policy + description: The management policy for the certificate. + isRequired: true + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: certificate_policy + isRequired: true + - name: certificate_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.CertificateUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.CertificateUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.CertificateUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.CertificateUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.CertificateUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Contact(class).yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Contact(class).yml new file mode 100644 index 00000000..395e585c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Contact(class).yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.Contact +name: Contact +fullName: azure.keyvault.v2016_10_01.models.Contact +module: azure.keyvault.v2016_10_01.models +summary: The contact information for the vault certificates. +constructor: + syntax: 'Contact(*, email_address: str = None, name: str = None, phone: str = None, + **kwargs)' + parameters: + - name: email_address + description: Email addresss. + isRequired: true + types: + - + - name: name + description: Name. + isRequired: true + types: + - + - name: phone + description: Phone number. + isRequired: true + types: + - + keywordOnlyParameters: + - name: email_address + isRequired: true + - name: name + isRequired: true + - name: phone + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.Contact.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.Contact.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.Contact.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.Contact.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.Contact.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.Contact.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.Contact.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Contacts(class).yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Contacts(class).yml new file mode 100644 index 00000000..eacaa70d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Contacts(class).yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.Contacts +name: Contacts +fullName: azure.keyvault.v2016_10_01.models.Contacts +module: azure.keyvault.v2016_10_01.models +summary: 'The contacts for the vault certificates. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Contacts(*, contact_list=None, **kwargs) + parameters: + - name: contact_list + description: The contact list for the vault certificates. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: contact_list + isRequired: true +variables: +- description: Identifier for the contacts collection. + name: id + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.Contacts.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.Contacts.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.Contacts.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.Contacts.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.Contacts.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.Contacts.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.Contacts.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedCertificateBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedCertificateBundle.yml new file mode 100644 index 00000000..086dad51 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedCertificateBundle.yml @@ -0,0 +1,192 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.DeletedCertificateBundle +name: DeletedCertificateBundle +fullName: azure.keyvault.v2016_10_01.models.DeletedCertificateBundle +module: azure.keyvault.v2016_10_01.models +summary: 'A Deleted Certificate consisting of its previous id, attributes and its + + tags, as well as information on when it will be purged. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedCertificateBundle(*, cer: bytearray = None, content_type: str = + None, attributes=None, tags=None, recovery_id: str = None, **kwargs)' + parameters: + - name: cer + description: CER contents of x509 certificate. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The certificate attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted certificate.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cer + isRequired: true + - name: content_type + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: The certificate id. + name: id + types: + - +- description: The key id. + name: kid + types: + - +- description: The secret id. + name: sid + types: + - +- description: Thumbprint of the certificate. + name: x509_thumbprint + types: + - +- description: The management policy. + name: policy + types: + - +- description: 'The time when the certificate is scheduled to + + be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the certificate was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.DeletedCertificateBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.DeletedCertificateBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.DeletedCertificateBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.DeletedCertificateBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.DeletedCertificateBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.DeletedCertificateBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.DeletedCertificateBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedCertificateItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedCertificateItem.yml new file mode 100644 index 00000000..c64218bf --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedCertificateItem.yml @@ -0,0 +1,172 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.DeletedCertificateItem +name: DeletedCertificateItem +fullName: azure.keyvault.v2016_10_01.models.DeletedCertificateItem +module: azure.keyvault.v2016_10_01.models +summary: 'The deleted certificate item containing metadata about the deleted + + certificate. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedCertificateItem(*, id: str = None, attributes=None, tags=None, x509_thumbprint: + bytes = None, recovery_id: str = None, **kwargs)' + parameters: + - name: id + description: Certificate identifier. + isRequired: true + types: + - + - name: attributes + description: The certificate management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: x509_thumbprint + description: Thumbprint of the certificate. + isRequired: true + types: + - + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted certificate.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: x509_thumbprint + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: 'The time when the certificate is scheduled to + + be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the certificate was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.DeletedCertificateItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.DeletedCertificateItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.DeletedCertificateItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.DeletedCertificateItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.DeletedCertificateItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.DeletedCertificateItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.DeletedCertificateItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedCertificateItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedCertificateItemPaged.yml new file mode 100644 index 00000000..5a2fd040 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedCertificateItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.DeletedCertificateItemPaged +name: DeletedCertificateItemPaged +fullName: azure.keyvault.v2016_10_01.models.DeletedCertificateItemPaged +module: azure.keyvault.v2016_10_01.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: DeletedCertificateItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v2016_10_01.models.DeletedCertificateItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v2016_10_01.models.DeletedCertificateItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v2016_10_01.models.DeletedCertificateItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.DeletedCertificateItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.DeletedCertificateItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v2016_10_01.models.DeletedCertificateItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v2016_10_01.models.DeletedCertificateItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedKeyBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedKeyBundle.yml new file mode 100644 index 00000000..e26ed279 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedKeyBundle.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.DeletedKeyBundle +name: DeletedKeyBundle +fullName: azure.keyvault.v2016_10_01.models.DeletedKeyBundle +module: azure.keyvault.v2016_10_01.models +summary: 'A DeletedKeyBundle consisting of a WebKey plus its Attributes and deletion + + info. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedKeyBundle(*, key=None, attributes=None, tags=None, recovery_id: + str = None, **kwargs)' + parameters: + - name: key + description: The Json web key. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted key.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: key + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the key is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the key was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.DeletedKeyBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.DeletedKeyBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.DeletedKeyBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.DeletedKeyBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.DeletedKeyBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.DeletedKeyBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.DeletedKeyBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedKeyItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedKeyItem.yml new file mode 100644 index 00000000..d0ab4da9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedKeyItem.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.DeletedKeyItem +name: DeletedKeyItem +fullName: azure.keyvault.v2016_10_01.models.DeletedKeyItem +module: azure.keyvault.v2016_10_01.models +summary: 'The deleted key item containing the deleted key metadata and information + + about deletion. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedKeyItem(*, kid: str = None, attributes=None, tags=None, recovery_id: + str = None, **kwargs)' + parameters: + - name: kid + description: Key identifier. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted key.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: kid + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the key is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the key was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.DeletedKeyItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.DeletedKeyItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.DeletedKeyItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.DeletedKeyItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.DeletedKeyItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.DeletedKeyItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.DeletedKeyItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedKeyItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedKeyItemPaged.yml new file mode 100644 index 00000000..5efaec97 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedKeyItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.DeletedKeyItemPaged +name: DeletedKeyItemPaged +fullName: azure.keyvault.v2016_10_01.models.DeletedKeyItemPaged +module: azure.keyvault.v2016_10_01.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: DeletedKeyItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v2016_10_01.models.DeletedKeyItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v2016_10_01.models.DeletedKeyItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v2016_10_01.models.DeletedKeyItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.DeletedKeyItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.DeletedKeyItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v2016_10_01.models.DeletedKeyItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v2016_10_01.models.DeletedKeyItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedSecretBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedSecretBundle.yml new file mode 100644 index 00000000..11b2101c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedSecretBundle.yml @@ -0,0 +1,192 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.DeletedSecretBundle +name: DeletedSecretBundle +fullName: azure.keyvault.v2016_10_01.models.DeletedSecretBundle +module: azure.keyvault.v2016_10_01.models +summary: 'A Deleted Secret consisting of its previous id, attributes and its tags, + as + + well as information on when it will be purged. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedSecretBundle(*, value: str = None, id: str = None, content_type: + str = None, attributes=None, tags=None, recovery_id: str = None, **kwargs)' + parameters: + - name: value + description: The secret value. + isRequired: true + types: + - + - name: id + description: The secret id. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted secret.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: id + isRequired: true + - name: content_type + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: 'If this is a secret backing a KV certificate, then this field + + specifies the corresponding key backing the KV certificate.' + name: kid + types: + - +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a secret backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the secret is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the secret was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.DeletedSecretBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.DeletedSecretBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.DeletedSecretBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.DeletedSecretBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.DeletedSecretBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.DeletedSecretBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.DeletedSecretBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedSecretItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedSecretItem.yml new file mode 100644 index 00000000..d5c42ec1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedSecretItem.yml @@ -0,0 +1,176 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.DeletedSecretItem +name: DeletedSecretItem +fullName: azure.keyvault.v2016_10_01.models.DeletedSecretItem +module: azure.keyvault.v2016_10_01.models +summary: 'The deleted secret item containing metadata about the deleted secret. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedSecretItem(*, id: str = None, attributes=None, tags=None, content_type: + str = None, recovery_id: str = None, **kwargs)' + parameters: + - name: id + description: Secret identifier. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted secret.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: content_type + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a key backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the secret is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the secret was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.DeletedSecretItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.DeletedSecretItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.DeletedSecretItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.DeletedSecretItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.DeletedSecretItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.DeletedSecretItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.DeletedSecretItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedSecretItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedSecretItemPaged.yml new file mode 100644 index 00000000..2670d3ab --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedSecretItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.DeletedSecretItemPaged +name: DeletedSecretItemPaged +fullName: azure.keyvault.v2016_10_01.models.DeletedSecretItemPaged +module: azure.keyvault.v2016_10_01.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: DeletedSecretItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v2016_10_01.models.DeletedSecretItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v2016_10_01.models.DeletedSecretItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v2016_10_01.models.DeletedSecretItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.DeletedSecretItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.DeletedSecretItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v2016_10_01.models.DeletedSecretItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v2016_10_01.models.DeletedSecretItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletionRecoveryLevel.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletionRecoveryLevel.yml new file mode 100644 index 00000000..39a10bc2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletionRecoveryLevel.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v2016_10_01.models.DeletionRecoveryLevel +name: DeletionRecoveryLevel +fullName: azure.keyvault.v2016_10_01.models.DeletionRecoveryLevel +module: azure.keyvault.v2016_10_01.models +fields: +- name: purgeable + uid: azure.keyvault.v2016_10_01.models.DeletionRecoveryLevel.purgeable +- name: recoverable + uid: azure.keyvault.v2016_10_01.models.DeletionRecoveryLevel.recoverable +- name: recoverable_protected_subscription + uid: azure.keyvault.v2016_10_01.models.DeletionRecoveryLevel.recoverable_protected_subscription +- name: recoverable_purgeable + uid: azure.keyvault.v2016_10_01.models.DeletionRecoveryLevel.recoverable_purgeable diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Error(class).yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Error(class).yml new file mode 100644 index 00000000..3322170d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Error(class).yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.Error +name: Error +fullName: azure.keyvault.v2016_10_01.models.Error +module: azure.keyvault.v2016_10_01.models +summary: 'The key vault server error. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Error(**kwargs) +variables: +- description: The error code. + name: code + types: + - +- description: The error message. + name: message + types: + - +- name: inner_error + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.Error.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.Error.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.Error.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.Error.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.Error.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.Error.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.Error.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerAttributes.yml new file mode 100644 index 00000000..59339597 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerAttributes.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.IssuerAttributes +name: IssuerAttributes +fullName: azure.keyvault.v2016_10_01.models.IssuerAttributes +module: azure.keyvault.v2016_10_01.models +summary: 'The attributes of an issuer managed by the Key Vault service. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'IssuerAttributes(*, enabled: bool = None, **kwargs)' + parameters: + - name: enabled + description: Determines whether the issuer is enabled. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.IssuerAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.IssuerAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.IssuerAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.IssuerAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.IssuerAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.IssuerAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.IssuerAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerBundle.yml new file mode 100644 index 00000000..4cfec1eb --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerBundle.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.IssuerBundle +name: IssuerBundle +fullName: azure.keyvault.v2016_10_01.models.IssuerBundle +module: azure.keyvault.v2016_10_01.models +summary: 'The issuer for Key Vault certificate. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'IssuerBundle(*, provider: str = None, credentials=None, organization_details=None, + attributes=None, **kwargs)' + parameters: + - name: provider + description: The issuer provider. + isRequired: true + types: + - + - name: credentials + description: The credentials to be used for the issuer. + isRequired: true + types: + - + - name: organization_details + description: 'Details of the organization as provided to + + the issuer.' + isRequired: true + types: + - + - name: attributes + description: Attributes of the issuer object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: provider + isRequired: true + - name: credentials + isRequired: true + - name: organization_details + isRequired: true + - name: attributes + isRequired: true +variables: +- description: Identifier for the issuer object. + name: id + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.IssuerBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.IssuerBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.IssuerBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.IssuerBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.IssuerBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.IssuerBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.IssuerBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerCredentials.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerCredentials.yml new file mode 100644 index 00000000..5db5e636 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerCredentials.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.IssuerCredentials +name: IssuerCredentials +fullName: azure.keyvault.v2016_10_01.models.IssuerCredentials +module: azure.keyvault.v2016_10_01.models +summary: The credentials to be used for the certificate issuer. +constructor: + syntax: 'IssuerCredentials(*, account_id: str = None, password: str = None, **kwargs)' + parameters: + - name: account_id + description: The user name/account name/account id. + isRequired: true + types: + - + - name: password + description: The password/secret/account key. + isRequired: true + types: + - + keywordOnlyParameters: + - name: account_id + isRequired: true + - name: password + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.IssuerCredentials.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.IssuerCredentials.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.IssuerCredentials.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.IssuerCredentials.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.IssuerCredentials.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.IssuerCredentials.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.IssuerCredentials.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerParameters.yml new file mode 100644 index 00000000..306c71be --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerParameters.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.IssuerParameters +name: IssuerParameters +fullName: azure.keyvault.v2016_10_01.models.IssuerParameters +module: azure.keyvault.v2016_10_01.models +summary: Parameters for the issuer of the X509 component of a certificate. +constructor: + syntax: 'IssuerParameters(*, name: str = None, certificate_type: str = None, **kwargs)' + parameters: + - name: name + description: 'Name of the referenced issuer object or reserved names; for + + example, ''Self'' or ''Unknown''.' + isRequired: true + types: + - + - name: certificate_type + description: 'Type of certificate to be requested from the + + issuer provider.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: certificate_type + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.IssuerParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.IssuerParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.IssuerParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.IssuerParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.IssuerParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.IssuerParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.IssuerParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKey.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKey.yml new file mode 100644 index 00000000..201dc0d1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKey.yml @@ -0,0 +1,238 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.JsonWebKey +name: JsonWebKey +fullName: azure.keyvault.v2016_10_01.models.JsonWebKey +module: azure.keyvault.v2016_10_01.models +summary: As of [http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18](http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18). +constructor: + syntax: 'JsonWebKey(*, kid: str = None, kty=None, key_ops=None, n: bytes = None, + e: bytes = None, d: bytes = None, dp: bytes = None, dq: bytes = None, qi: bytes + = None, p: bytes = None, q: bytes = None, k: bytes = None, t: bytes = None, crv=None, + x: bytes = None, y: bytes = None, **kwargs)' + parameters: + - name: kid + description: Key identifier. + isRequired: true + types: + - + - name: kty + description: 'JsonWebKey key type (kty). Possible values include: ''EC'', + + ''EC-HSM'', ''RSA'', ''RSA-HSM'', ''oct''' + isRequired: true + types: + - + - + - name: key_ops + isRequired: true + types: + - [] + - name: n + description: RSA modulus. + isRequired: true + types: + - + - name: e + description: RSA public exponent. + isRequired: true + types: + - + - name: d + description: RSA private exponent, or the D component of an EC private key. + isRequired: true + types: + - + - name: dp + description: RSA private key parameter. + isRequired: true + types: + - + - name: dq + description: RSA private key parameter. + isRequired: true + types: + - + - name: qi + description: RSA private key parameter. + isRequired: true + types: + - + - name: p + description: RSA secret prime. + isRequired: true + types: + - + - name: q + description: RSA secret prime, with p < q. + isRequired: true + types: + - + - name: k + description: Symmetric key. + isRequired: true + types: + - + - name: t + description: HSM Token, used with 'Bring Your Own Key'. + isRequired: true + types: + - + - name: crv + description: 'Elliptic curve name. For valid values, see + + JsonWebKeyCurveName. Possible values include: ''P-256'', ''P-384'', ''P-521'', + + ''SECP256K1''' + isRequired: true + types: + - + - + - name: x + description: X component of an EC public key. + isRequired: true + types: + - + - name: y + description: Y component of an EC public key. + isRequired: true + types: + - + keywordOnlyParameters: + - name: kid + isRequired: true + - name: kty + isRequired: true + - name: key_ops + isRequired: true + - name: n + isRequired: true + - name: e + isRequired: true + - name: d + isRequired: true + - name: dp + isRequired: true + - name: dq + isRequired: true + - name: qi + isRequired: true + - name: p + isRequired: true + - name: q + isRequired: true + - name: k + isRequired: true + - name: t + isRequired: true + - name: crv + isRequired: true + - name: x + isRequired: true + - name: y + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.JsonWebKey.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.JsonWebKey.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.JsonWebKey.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.JsonWebKey.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.JsonWebKey.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.JsonWebKey.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.JsonWebKey.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKeyCurveName.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKeyCurveName.yml new file mode 100644 index 00000000..e788bdbf --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKeyCurveName.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v2016_10_01.models.JsonWebKeyCurveName +name: JsonWebKeyCurveName +fullName: azure.keyvault.v2016_10_01.models.JsonWebKeyCurveName +module: azure.keyvault.v2016_10_01.models +fields: +- name: p_256 + uid: azure.keyvault.v2016_10_01.models.JsonWebKeyCurveName.p_256 +- name: p_384 + uid: azure.keyvault.v2016_10_01.models.JsonWebKeyCurveName.p_384 +- name: p_521 + uid: azure.keyvault.v2016_10_01.models.JsonWebKeyCurveName.p_521 +- name: secp256_k1 + uid: azure.keyvault.v2016_10_01.models.JsonWebKeyCurveName.secp256_k1 diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKeyEncryptionAlgorithm.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKeyEncryptionAlgorithm.yml new file mode 100644 index 00000000..87439915 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKeyEncryptionAlgorithm.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v2016_10_01.models.JsonWebKeyEncryptionAlgorithm +name: JsonWebKeyEncryptionAlgorithm +fullName: azure.keyvault.v2016_10_01.models.JsonWebKeyEncryptionAlgorithm +module: azure.keyvault.v2016_10_01.models +fields: +- name: rsa1_5 + uid: azure.keyvault.v2016_10_01.models.JsonWebKeyEncryptionAlgorithm.rsa1_5 +- name: rsa_oaep + uid: azure.keyvault.v2016_10_01.models.JsonWebKeyEncryptionAlgorithm.rsa_oaep +- name: rsa_oaep_256 + uid: azure.keyvault.v2016_10_01.models.JsonWebKeyEncryptionAlgorithm.rsa_oaep_256 diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKeyOperation.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKeyOperation.yml new file mode 100644 index 00000000..5f7cd4b2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKeyOperation.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v2016_10_01.models.JsonWebKeyOperation +name: JsonWebKeyOperation +fullName: azure.keyvault.v2016_10_01.models.JsonWebKeyOperation +module: azure.keyvault.v2016_10_01.models +fields: +- name: decrypt + uid: azure.keyvault.v2016_10_01.models.JsonWebKeyOperation.decrypt +- name: encrypt + uid: azure.keyvault.v2016_10_01.models.JsonWebKeyOperation.encrypt +- name: sign + uid: azure.keyvault.v2016_10_01.models.JsonWebKeyOperation.sign +- name: unwrap_key + uid: azure.keyvault.v2016_10_01.models.JsonWebKeyOperation.unwrap_key +- name: verify + uid: azure.keyvault.v2016_10_01.models.JsonWebKeyOperation.verify +- name: wrap_key + uid: azure.keyvault.v2016_10_01.models.JsonWebKeyOperation.wrap_key diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKeySignatureAlgorithm.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKeySignatureAlgorithm.yml new file mode 100644 index 00000000..e32b2bd2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKeySignatureAlgorithm.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v2016_10_01.models.JsonWebKeySignatureAlgorithm +name: JsonWebKeySignatureAlgorithm +fullName: azure.keyvault.v2016_10_01.models.JsonWebKeySignatureAlgorithm +module: azure.keyvault.v2016_10_01.models +fields: +- name: ecdsa256 + uid: azure.keyvault.v2016_10_01.models.JsonWebKeySignatureAlgorithm.ecdsa256 +- name: es256 + uid: azure.keyvault.v2016_10_01.models.JsonWebKeySignatureAlgorithm.es256 +- name: es384 + uid: azure.keyvault.v2016_10_01.models.JsonWebKeySignatureAlgorithm.es384 +- name: es512 + uid: azure.keyvault.v2016_10_01.models.JsonWebKeySignatureAlgorithm.es512 +- name: ps256 + uid: azure.keyvault.v2016_10_01.models.JsonWebKeySignatureAlgorithm.ps256 +- name: ps384 + uid: azure.keyvault.v2016_10_01.models.JsonWebKeySignatureAlgorithm.ps384 +- name: ps512 + uid: azure.keyvault.v2016_10_01.models.JsonWebKeySignatureAlgorithm.ps512 +- name: rs256 + uid: azure.keyvault.v2016_10_01.models.JsonWebKeySignatureAlgorithm.rs256 +- name: rs384 + uid: azure.keyvault.v2016_10_01.models.JsonWebKeySignatureAlgorithm.rs384 +- name: rs512 + uid: azure.keyvault.v2016_10_01.models.JsonWebKeySignatureAlgorithm.rs512 +- name: rsnull + uid: azure.keyvault.v2016_10_01.models.JsonWebKeySignatureAlgorithm.rsnull diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKeyType.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKeyType.yml new file mode 100644 index 00000000..6060b6fd --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKeyType.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v2016_10_01.models.JsonWebKeyType +name: JsonWebKeyType +fullName: azure.keyvault.v2016_10_01.models.JsonWebKeyType +module: azure.keyvault.v2016_10_01.models +fields: +- name: ec + uid: azure.keyvault.v2016_10_01.models.JsonWebKeyType.ec +- name: ec_hsm + uid: azure.keyvault.v2016_10_01.models.JsonWebKeyType.ec_hsm +- name: oct + uid: azure.keyvault.v2016_10_01.models.JsonWebKeyType.oct +- name: rsa + uid: azure.keyvault.v2016_10_01.models.JsonWebKeyType.rsa +- name: rsa_hsm + uid: azure.keyvault.v2016_10_01.models.JsonWebKeyType.rsa_hsm diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyAttributes.yml new file mode 100644 index 00000000..a4e90824 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyAttributes.yml @@ -0,0 +1,166 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.KeyAttributes +name: KeyAttributes +fullName: azure.keyvault.v2016_10_01.models.KeyAttributes +module: azure.keyvault.v2016_10_01.models +summary: 'The attributes of a key managed by the key vault service. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'KeyAttributes(*, enabled: bool = None, not_before=None, expires=None, **kwargs)' + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true + - name: not_before + isRequired: true + - name: expires + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for keys in the current vault. If it contains ''Purgeable'' the key + + can be permanently deleted by a privileged user; otherwise, only the + + system can purge the key, at the end of the retention interval. Possible + + values include: ''Purgeable'', ''Recoverable+Purgeable'', ''Recoverable'', + + ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v2016_10_01.models.KeyAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.KeyAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.KeyAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyBundle.yml new file mode 100644 index 00000000..74ad7ccd --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyBundle.yml @@ -0,0 +1,149 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.KeyBundle +name: KeyBundle +fullName: azure.keyvault.v2016_10_01.models.KeyBundle +module: azure.keyvault.v2016_10_01.models +summary: 'A KeyBundle consisting of a WebKey plus its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyBundle(*, key=None, attributes=None, tags=None, **kwargs) + parameters: + - name: key + description: The Json web key. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: key + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.KeyBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.KeyBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.KeyBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyCreateParameters.yml new file mode 100644 index 00000000..72e9dfa7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyCreateParameters.yml @@ -0,0 +1,173 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.KeyCreateParameters +name: KeyCreateParameters +fullName: azure.keyvault.v2016_10_01.models.KeyCreateParameters +module: azure.keyvault.v2016_10_01.models +summary: 'The key create parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeyCreateParameters(*, kty, key_size: int = None, key_ops=None, key_attributes=None, + tags=None, curve=None, **kwargs)' + parameters: + - name: kty + description: 'Required. The type of key to create. For valid values, see + + JsonWebKeyType. Possible values include: ''EC'', ''EC-HSM'', ''RSA'', ''RSA-HSM'', + + ''oct''' + isRequired: true + types: + - + - + - name: key_size + description: 'The key size in bits. For example: 2048, 3072, or 4096 + + for RSA.' + isRequired: true + types: + - + - name: key_ops + isRequired: true + types: + - [ + - ] + - name: key_attributes + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: curve + description: 'Elliptic curve name. For valid values, see + + JsonWebKeyCurveName. Possible values include: ''P-256'', ''P-384'', ''P-521'', + + ''SECP256K1''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: kty + isRequired: true + - name: key_size + isRequired: true + - name: key_ops + isRequired: true + - name: key_attributes + isRequired: true + - name: tags + isRequired: true + - name: curve + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.KeyCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.KeyCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.KeyCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyImportParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyImportParameters.yml new file mode 100644 index 00000000..7c9bf0d9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyImportParameters.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.KeyImportParameters +name: KeyImportParameters +fullName: azure.keyvault.v2016_10_01.models.KeyImportParameters +module: azure.keyvault.v2016_10_01.models +summary: 'The key import parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeyImportParameters(*, key, hsm: bool = None, key_attributes=None, tags=None, + **kwargs)' + parameters: + - name: hsm + description: Whether to import as a hardware key (HSM) or software key. + isRequired: true + types: + - + - name: key + description: Required. The Json web key + isRequired: true + types: + - + - name: key_attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: key + isRequired: true + - name: hsm + isRequired: true + - name: key_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.KeyImportParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyImportParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyImportParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.KeyImportParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyImportParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.KeyImportParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyImportParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyItem.yml new file mode 100644 index 00000000..aa15c4ee --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyItem.yml @@ -0,0 +1,149 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.KeyItem +name: KeyItem +fullName: azure.keyvault.v2016_10_01.models.KeyItem +module: azure.keyvault.v2016_10_01.models +summary: 'The key item containing key metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'KeyItem(*, kid: str = None, attributes=None, tags=None, **kwargs)' + parameters: + - name: kid + description: Key identifier. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: kid + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.KeyItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.KeyItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.KeyItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyItemPaged.yml new file mode 100644 index 00000000..8b3e238b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.KeyItemPaged +name: KeyItemPaged +fullName: azure.keyvault.v2016_10_01.models.KeyItemPaged +module: azure.keyvault.v2016_10_01.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: KeyItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v2016_10_01.models.KeyItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v2016_10_01.models.KeyItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v2016_10_01.models.KeyItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v2016_10_01.models.KeyItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v2016_10_01.models.KeyItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyOperationResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyOperationResult.yml new file mode 100644 index 00000000..e217aa37 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyOperationResult.yml @@ -0,0 +1,127 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.KeyOperationResult +name: KeyOperationResult +fullName: azure.keyvault.v2016_10_01.models.KeyOperationResult +module: azure.keyvault.v2016_10_01.models +summary: 'The key operation result. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyOperationResult(**kwargs) +variables: +- description: Key identifier + name: kid + types: + - +- name: result + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.KeyOperationResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyOperationResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyOperationResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.KeyOperationResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyOperationResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.KeyOperationResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyOperationResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyOperationsParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyOperationsParameters.yml new file mode 100644 index 00000000..01d17118 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyOperationsParameters.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.KeyOperationsParameters +name: KeyOperationsParameters +fullName: azure.keyvault.v2016_10_01.models.KeyOperationsParameters +module: azure.keyvault.v2016_10_01.models +summary: 'The key operations parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeyOperationsParameters(*, algorithm, value: bytes, **kwargs)' + parameters: + - name: algorithm + description: 'Required. algorithm identifier. Possible values include: + + ''RSA-OAEP'', ''RSA-OAEP-256'', ''RSA1_5''' + isRequired: true + types: + - + - + - name: value + description: Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: algorithm + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.KeyOperationsParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyOperationsParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyOperationsParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.KeyOperationsParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyOperationsParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.KeyOperationsParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyOperationsParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyProperties.yml new file mode 100644 index 00000000..084efc90 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyProperties.yml @@ -0,0 +1,149 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.KeyProperties +name: KeyProperties +fullName: azure.keyvault.v2016_10_01.models.KeyProperties +module: azure.keyvault.v2016_10_01.models +summary: Properties of the key pair backing a certificate. +constructor: + syntax: 'KeyProperties(*, exportable: bool = None, key_type: str = None, key_size: + int = None, reuse_key: bool = None, **kwargs)' + parameters: + - name: exportable + description: Indicates if the private key can be exported. + isRequired: true + types: + - + - name: key_type + description: The key type. + isRequired: true + types: + - + - name: key_size + description: 'The key size in bits. For example: 2048, 3072, or 4096 + + for RSA.' + isRequired: true + types: + - + - name: reuse_key + description: 'Indicates if the same key pair will be used on + + certificate renewal.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: exportable + isRequired: true + - name: key_type + isRequired: true + - name: key_size + isRequired: true + - name: reuse_key + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.KeyProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.KeyProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.KeyProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyRestoreParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyRestoreParameters.yml new file mode 100644 index 00000000..3f08f28a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyRestoreParameters.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.KeyRestoreParameters +name: KeyRestoreParameters +fullName: azure.keyvault.v2016_10_01.models.KeyRestoreParameters +module: azure.keyvault.v2016_10_01.models +summary: 'The key restore parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeyRestoreParameters(*, key_bundle_backup: bytes, **kwargs)' + parameters: + - name: key_bundle_backup + description: 'Required. The backup blob associated with a key + + bundle.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: key_bundle_backup + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.KeyRestoreParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyRestoreParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyRestoreParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.KeyRestoreParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyRestoreParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.KeyRestoreParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyRestoreParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeySignParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeySignParameters.yml new file mode 100644 index 00000000..72eed47f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeySignParameters.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.KeySignParameters +name: KeySignParameters +fullName: azure.keyvault.v2016_10_01.models.KeySignParameters +module: azure.keyvault.v2016_10_01.models +summary: 'The key operations parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeySignParameters(*, algorithm, value: bytes, **kwargs)' + parameters: + - name: algorithm + description: 'Required. The signing/verification algorithm identifier. + + For more information on possible algorithm types, see + + JsonWebKeySignatureAlgorithm. Possible values include: ''PS256'', ''PS384'', + + ''PS512'', ''RS256'', ''RS384'', ''RS512'', ''RSNULL'', ''ES256'', ''ES384'', + ''ES512'', + + ''ECDSA256''' + isRequired: true + types: + - + - + - name: value + description: Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: algorithm + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.KeySignParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeySignParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeySignParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.KeySignParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeySignParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.KeySignParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeySignParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyUpdateParameters.yml new file mode 100644 index 00000000..6547c62e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyUpdateParameters.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.KeyUpdateParameters +name: KeyUpdateParameters +fullName: azure.keyvault.v2016_10_01.models.KeyUpdateParameters +module: azure.keyvault.v2016_10_01.models +summary: The key update parameters. +constructor: + syntax: KeyUpdateParameters(*, key_ops=None, key_attributes=None, tags=None, **kwargs) + parameters: + - name: key_ops + description: 'Json web key operations. For more information on possible + + key operations, see JsonWebKeyOperation.' + isRequired: true + types: + - [ + - ] + - name: key_attributes + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: key_ops + isRequired: true + - name: key_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.KeyUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.KeyUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.KeyUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyUsageType.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyUsageType.yml new file mode 100644 index 00000000..02a637a7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyUsageType.yml @@ -0,0 +1,24 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v2016_10_01.models.KeyUsageType +name: KeyUsageType +fullName: azure.keyvault.v2016_10_01.models.KeyUsageType +module: azure.keyvault.v2016_10_01.models +fields: +- name: c_rl_sign + uid: azure.keyvault.v2016_10_01.models.KeyUsageType.c_rl_sign +- name: data_encipherment + uid: azure.keyvault.v2016_10_01.models.KeyUsageType.data_encipherment +- name: decipher_only + uid: azure.keyvault.v2016_10_01.models.KeyUsageType.decipher_only +- name: digital_signature + uid: azure.keyvault.v2016_10_01.models.KeyUsageType.digital_signature +- name: encipher_only + uid: azure.keyvault.v2016_10_01.models.KeyUsageType.encipher_only +- name: key_agreement + uid: azure.keyvault.v2016_10_01.models.KeyUsageType.key_agreement +- name: key_cert_sign + uid: azure.keyvault.v2016_10_01.models.KeyUsageType.key_cert_sign +- name: key_encipherment + uid: azure.keyvault.v2016_10_01.models.KeyUsageType.key_encipherment +- name: non_repudiation + uid: azure.keyvault.v2016_10_01.models.KeyUsageType.non_repudiation diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyVaultError.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyVaultError.yml new file mode 100644 index 00000000..9650ae70 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyVaultError.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.KeyVaultError +name: KeyVaultError +fullName: azure.keyvault.v2016_10_01.models.KeyVaultError +module: azure.keyvault.v2016_10_01.models +summary: 'The key vault error exception. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyVaultError(**kwargs) +variables: +- name: error + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.KeyVaultError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyVaultError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyVaultError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.KeyVaultError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyVaultError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.KeyVaultError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyVaultError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyVaultErrorException.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyVaultErrorException.yml new file mode 100644 index 00000000..98515347 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyVaultErrorException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +name: KeyVaultErrorException +fullName: azure.keyvault.v2016_10_01.models.KeyVaultErrorException +module: azure.keyvault.v2016_10_01.models +summary: 'Server responsed with exception of type: ''KeyVaultError''.' +constructor: + syntax: KeyVaultErrorException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.KeyVaultErrorException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.keyvault.v2016_10_01.models.KeyVaultErrorException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.keyvault.v2016_10_01.models.KeyVaultErrorException.args + name: args diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyVerifyParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyVerifyParameters.yml new file mode 100644 index 00000000..3f984487 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyVerifyParameters.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.KeyVerifyParameters +name: KeyVerifyParameters +fullName: azure.keyvault.v2016_10_01.models.KeyVerifyParameters +module: azure.keyvault.v2016_10_01.models +summary: 'The key verify parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeyVerifyParameters(*, algorithm, digest: bytes, signature: bytes, **kwargs)' + parameters: + - name: algorithm + description: 'Required. The signing/verification algorithm. For more + + information on possible algorithm types, see JsonWebKeySignatureAlgorithm. + + Possible values include: ''PS256'', ''PS384'', ''PS512'', ''RS256'', ''RS384'', + + ''RS512'', ''RSNULL'', ''ES256'', ''ES384'', ''ES512'', ''ECDSA256''' + isRequired: true + types: + - + - + - name: digest + description: Required. The digest used for signing. + isRequired: true + types: + - + - name: signature + description: Required. The signature to be verified. + isRequired: true + types: + - + keywordOnlyParameters: + - name: algorithm + isRequired: true + - name: digest + isRequired: true + - name: signature + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.KeyVerifyParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyVerifyParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyVerifyParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.KeyVerifyParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyVerifyParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.KeyVerifyParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyVerifyParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyVerifyResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyVerifyResult.yml new file mode 100644 index 00000000..b33b993e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyVerifyResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.KeyVerifyResult +name: KeyVerifyResult +fullName: azure.keyvault.v2016_10_01.models.KeyVerifyResult +module: azure.keyvault.v2016_10_01.models +summary: 'The key verify result. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyVerifyResult(**kwargs) +variables: +- description: True if the signature is verified, otherwise false. + name: value + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.KeyVerifyResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyVerifyResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyVerifyResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.KeyVerifyResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.KeyVerifyResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.KeyVerifyResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.KeyVerifyResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.LifetimeAction.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.LifetimeAction.yml new file mode 100644 index 00000000..5c12d613 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.LifetimeAction.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.LifetimeAction +name: LifetimeAction +fullName: azure.keyvault.v2016_10_01.models.LifetimeAction +module: azure.keyvault.v2016_10_01.models +summary: 'Action and its trigger that will be performed by Key Vault over the + + lifetime of a certificate.' +constructor: + syntax: LifetimeAction(*, trigger=None, action=None, **kwargs) + parameters: + - name: trigger + description: The condition that will execute the action. + isRequired: true + types: + - + - name: action + description: The action that will be executed. + isRequired: true + types: + - + keywordOnlyParameters: + - name: trigger + isRequired: true + - name: action + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.LifetimeAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.LifetimeAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.LifetimeAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.LifetimeAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.LifetimeAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.LifetimeAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.LifetimeAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.OrganizationDetails.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.OrganizationDetails.yml new file mode 100644 index 00000000..6cff66de --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.OrganizationDetails.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.OrganizationDetails +name: OrganizationDetails +fullName: azure.keyvault.v2016_10_01.models.OrganizationDetails +module: azure.keyvault.v2016_10_01.models +summary: Details of the organization of the certificate issuer. +constructor: + syntax: 'OrganizationDetails(*, id: str = None, admin_details=None, **kwargs)' + parameters: + - name: id + description: Id of the organization. + isRequired: true + types: + - + - name: admin_details + description: Details of the organization administrator. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: admin_details + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.OrganizationDetails.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.OrganizationDetails.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.OrganizationDetails.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.OrganizationDetails.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.OrganizationDetails.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.OrganizationDetails.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.OrganizationDetails.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.PendingCertificateSigningRequestResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.PendingCertificateSigningRequestResult.yml new file mode 100644 index 00000000..19aa3e08 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.PendingCertificateSigningRequestResult.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.PendingCertificateSigningRequestResult +name: PendingCertificateSigningRequestResult +fullName: azure.keyvault.v2016_10_01.models.PendingCertificateSigningRequestResult +module: azure.keyvault.v2016_10_01.models +summary: 'The pending certificate signing request result. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: PendingCertificateSigningRequestResult(**kwargs) +variables: +- description: 'The pending certificate signing request as Base64 encoded + + string.' + name: value + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.PendingCertificateSigningRequestResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.PendingCertificateSigningRequestResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.PendingCertificateSigningRequestResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.PendingCertificateSigningRequestResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.PendingCertificateSigningRequestResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.PendingCertificateSigningRequestResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.PendingCertificateSigningRequestResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionAttributes.yml new file mode 100644 index 00000000..9e81324b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionAttributes.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.SasDefinitionAttributes +name: SasDefinitionAttributes +fullName: azure.keyvault.v2016_10_01.models.SasDefinitionAttributes +module: azure.keyvault.v2016_10_01.models +summary: 'The SAS definition management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'SasDefinitionAttributes(*, enabled: bool = None, **kwargs)' + parameters: + - name: enabled + description: the enabled state of the object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionBundle.yml new file mode 100644 index 00000000..6d0bb306 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionBundle.yml @@ -0,0 +1,144 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.SasDefinitionBundle +name: SasDefinitionBundle +fullName: azure.keyvault.v2016_10_01.models.SasDefinitionBundle +module: azure.keyvault.v2016_10_01.models +summary: 'A SAS definition bundle consists of key vault SAS definition details plus + + its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SasDefinitionBundle(**kwargs) +variables: +- description: The SAS definition id. + name: id + types: + - +- description: Storage account SAS definition secret id. + name: secret_id + types: + - +- description: 'The SAS definition metadata in the form of key-value + + pairs.' + name: parameters + types: + - [, ] +- description: The SAS definition attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionCreateParameters.yml new file mode 100644 index 00000000..83c1aace --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionCreateParameters.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.SasDefinitionCreateParameters +name: SasDefinitionCreateParameters +fullName: azure.keyvault.v2016_10_01.models.SasDefinitionCreateParameters +module: azure.keyvault.v2016_10_01.models +summary: 'The SAS definition create parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: SasDefinitionCreateParameters(*, parameters, sas_definition_attributes=None, + tags=None, **kwargs) + parameters: + - name: parameters + description: 'Required. Sas definition creation metadata in the form + + of key-value pairs.' + isRequired: true + types: + - [, ] + - name: sas_definition_attributes + description: The attributes of the SAS definition. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: parameters + isRequired: true + - name: sas_definition_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionItem.yml new file mode 100644 index 00000000..78a13655 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionItem.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.SasDefinitionItem +name: SasDefinitionItem +fullName: azure.keyvault.v2016_10_01.models.SasDefinitionItem +module: azure.keyvault.v2016_10_01.models +summary: 'The SAS definition item containing storage SAS definition metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SasDefinitionItem(**kwargs) +variables: +- description: The storage SAS identifier. + name: id + types: + - +- description: The storage account SAS definition secret id. + name: secret_id + types: + - +- description: The SAS definition management attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs. + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionItemPaged.yml new file mode 100644 index 00000000..ddc97834 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.SasDefinitionItemPaged +name: SasDefinitionItemPaged +fullName: azure.keyvault.v2016_10_01.models.SasDefinitionItemPaged +module: azure.keyvault.v2016_10_01.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: SasDefinitionItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionUpdateParameters.yml new file mode 100644 index 00000000..57ef96a9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionUpdateParameters.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.SasDefinitionUpdateParameters +name: SasDefinitionUpdateParameters +fullName: azure.keyvault.v2016_10_01.models.SasDefinitionUpdateParameters +module: azure.keyvault.v2016_10_01.models +summary: The SAS definition update parameters. +constructor: + syntax: SasDefinitionUpdateParameters(*, parameters=None, sas_definition_attributes=None, + tags=None, **kwargs) + parameters: + - name: parameters + description: 'Sas definition update metadata in the form of key-value + + pairs.' + isRequired: true + types: + - [, ] + - name: sas_definition_attributes + description: The attributes of the SAS definition. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: parameters + isRequired: true + - name: sas_definition_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SasDefinitionUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretAttributes.yml new file mode 100644 index 00000000..9ac0afa4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretAttributes.yml @@ -0,0 +1,167 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.SecretAttributes +name: SecretAttributes +fullName: azure.keyvault.v2016_10_01.models.SecretAttributes +module: azure.keyvault.v2016_10_01.models +summary: 'The secret management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'SecretAttributes(*, enabled: bool = None, not_before=None, expires=None, + **kwargs)' + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true + - name: not_before + isRequired: true + - name: expires + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for secrets in the current vault. If it contains ''Purgeable'', the + + secret can be permanently deleted by a privileged user; otherwise, only + + the system can purge the secret, at the end of the retention interval. + + Possible values include: ''Purgeable'', ''Recoverable+Purgeable'', + + ''Recoverable'', ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v2016_10_01.models.SecretAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SecretAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SecretAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.SecretAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SecretAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.SecretAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SecretAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretBundle.yml new file mode 100644 index 00000000..47574638 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretBundle.yml @@ -0,0 +1,170 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.SecretBundle +name: SecretBundle +fullName: azure.keyvault.v2016_10_01.models.SecretBundle +module: azure.keyvault.v2016_10_01.models +summary: 'A secret consisting of a value, id and its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'SecretBundle(*, value: str = None, id: str = None, content_type: str = + None, attributes=None, tags=None, **kwargs)' + parameters: + - name: value + description: The secret value. + isRequired: true + types: + - + - name: id + description: The secret id. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: value + isRequired: true + - name: id + isRequired: true + - name: content_type + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true +variables: +- description: 'If this is a secret backing a KV certificate, then this field + + specifies the corresponding key backing the KV certificate.' + name: kid + types: + - +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a secret backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.SecretBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SecretBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SecretBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.SecretBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SecretBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.SecretBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SecretBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretItem.yml new file mode 100644 index 00000000..33280603 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretItem.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.SecretItem +name: SecretItem +fullName: azure.keyvault.v2016_10_01.models.SecretItem +module: azure.keyvault.v2016_10_01.models +summary: 'The secret item containing secret metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'SecretItem(*, id: str = None, attributes=None, tags=None, content_type: + str = None, **kwargs)' + parameters: + - name: id + description: Secret identifier. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: content_type + isRequired: true +variables: +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a key backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.SecretItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SecretItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SecretItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.SecretItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SecretItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.SecretItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SecretItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretItemPaged.yml new file mode 100644 index 00000000..60bae292 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.SecretItemPaged +name: SecretItemPaged +fullName: azure.keyvault.v2016_10_01.models.SecretItemPaged +module: azure.keyvault.v2016_10_01.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: SecretItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v2016_10_01.models.SecretItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v2016_10_01.models.SecretItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v2016_10_01.models.SecretItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.SecretItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.SecretItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v2016_10_01.models.SecretItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v2016_10_01.models.SecretItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretProperties.yml new file mode 100644 index 00000000..3b5b97d5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretProperties.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.SecretProperties +name: SecretProperties +fullName: azure.keyvault.v2016_10_01.models.SecretProperties +module: azure.keyvault.v2016_10_01.models +summary: Properties of the key backing a certificate. +constructor: + syntax: 'SecretProperties(*, content_type: str = None, **kwargs)' + parameters: + - name: content_type + description: The media type (MIME type). + isRequired: true + types: + - + keywordOnlyParameters: + - name: content_type + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.SecretProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SecretProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SecretProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.SecretProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SecretProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.SecretProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SecretProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretRestoreParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretRestoreParameters.yml new file mode 100644 index 00000000..80681f5c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretRestoreParameters.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.SecretRestoreParameters +name: SecretRestoreParameters +fullName: azure.keyvault.v2016_10_01.models.SecretRestoreParameters +module: azure.keyvault.v2016_10_01.models +summary: 'The secret restore parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SecretRestoreParameters(*, secret_bundle_backup: bytes, **kwargs)' + parameters: + - name: secret_bundle_backup + description: 'Required. The backup blob associated with a + + secret bundle.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: secret_bundle_backup + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.SecretRestoreParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SecretRestoreParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SecretRestoreParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.SecretRestoreParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SecretRestoreParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.SecretRestoreParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SecretRestoreParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretSetParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretSetParameters.yml new file mode 100644 index 00000000..34bcb576 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretSetParameters.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.SecretSetParameters +name: SecretSetParameters +fullName: azure.keyvault.v2016_10_01.models.SecretSetParameters +module: azure.keyvault.v2016_10_01.models +summary: 'The secret set parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SecretSetParameters(*, value: str, tags=None, content_type: str = None, + secret_attributes=None, **kwargs)' + parameters: + - name: value + description: Required. The value of the secret. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - + - name: secret_attributes + description: The secret management attributes. + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: tags + isRequired: true + - name: content_type + isRequired: true + - name: secret_attributes + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.SecretSetParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SecretSetParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SecretSetParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.SecretSetParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SecretSetParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.SecretSetParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SecretSetParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretUpdateParameters.yml new file mode 100644 index 00000000..8059c2b7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretUpdateParameters.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.SecretUpdateParameters +name: SecretUpdateParameters +fullName: azure.keyvault.v2016_10_01.models.SecretUpdateParameters +module: azure.keyvault.v2016_10_01.models +summary: The secret update parameters. +constructor: + syntax: 'SecretUpdateParameters(*, content_type: str = None, secret_attributes=None, + tags=None, **kwargs)' + parameters: + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - + - name: secret_attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: content_type + isRequired: true + - name: secret_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.SecretUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SecretUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SecretUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.SecretUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SecretUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.SecretUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SecretUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountAttributes.yml new file mode 100644 index 00000000..b2469149 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountAttributes.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.StorageAccountAttributes +name: StorageAccountAttributes +fullName: azure.keyvault.v2016_10_01.models.StorageAccountAttributes +module: azure.keyvault.v2016_10_01.models +summary: 'The storage account management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'StorageAccountAttributes(*, enabled: bool = None, **kwargs)' + parameters: + - name: enabled + description: the enabled state of the object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.StorageAccountAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.StorageAccountAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.StorageAccountAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.StorageAccountAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.StorageAccountAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.StorageAccountAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.StorageAccountAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountCreateParameters.yml new file mode 100644 index 00000000..6090df86 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountCreateParameters.yml @@ -0,0 +1,167 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.StorageAccountCreateParameters +name: StorageAccountCreateParameters +fullName: azure.keyvault.v2016_10_01.models.StorageAccountCreateParameters +module: azure.keyvault.v2016_10_01.models +summary: 'The storage account create parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'StorageAccountCreateParameters(*, resource_id: str, active_key_name: str, + auto_regenerate_key: bool, regeneration_period: str = None, storage_account_attributes=None, + tags=None, **kwargs)' + parameters: + - name: resource_id + description: Required. Storage account resource id. + isRequired: true + types: + - + - name: active_key_name + description: Required. Current active storage account key name. + isRequired: true + types: + - + - name: auto_regenerate_key + description: 'Required. whether keyvault should manage the + + storage account for the user.' + isRequired: true + types: + - + - name: regeneration_period + description: 'The key regeneration time duration specified + + in ISO-8601 format.' + isRequired: true + types: + - + - name: storage_account_attributes + description: The attributes of the storage account. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: resource_id + isRequired: true + - name: active_key_name + isRequired: true + - name: auto_regenerate_key + isRequired: true + - name: regeneration_period + isRequired: true + - name: storage_account_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.StorageAccountCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.StorageAccountCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.StorageAccountCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.StorageAccountCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.StorageAccountCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.StorageAccountCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.StorageAccountCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountItem.yml new file mode 100644 index 00000000..fb5622a6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountItem.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.StorageAccountItem +name: StorageAccountItem +fullName: azure.keyvault.v2016_10_01.models.StorageAccountItem +module: azure.keyvault.v2016_10_01.models +summary: 'The storage account item containing storage account metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: StorageAccountItem(**kwargs) +variables: +- description: Storage identifier. + name: id + types: + - +- description: Storage account resource Id. + name: resource_id + types: + - +- description: The storage account management attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs. + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v2016_10_01.models.StorageAccountItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.StorageAccountItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.StorageAccountItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.StorageAccountItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.StorageAccountItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.StorageAccountItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.StorageAccountItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountItemPaged.yml new file mode 100644 index 00000000..13c6fdf7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.StorageAccountItemPaged +name: StorageAccountItemPaged +fullName: azure.keyvault.v2016_10_01.models.StorageAccountItemPaged +module: azure.keyvault.v2016_10_01.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: StorageAccountItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v2016_10_01.models.StorageAccountItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v2016_10_01.models.StorageAccountItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v2016_10_01.models.StorageAccountItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.StorageAccountItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.StorageAccountItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v2016_10_01.models.StorageAccountItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v2016_10_01.models.StorageAccountItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountRegenerteKeyParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountRegenerteKeyParameters.yml new file mode 100644 index 00000000..cc8d9dcc --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountRegenerteKeyParameters.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.StorageAccountRegenerteKeyParameters +name: StorageAccountRegenerteKeyParameters +fullName: azure.keyvault.v2016_10_01.models.StorageAccountRegenerteKeyParameters +module: azure.keyvault.v2016_10_01.models +summary: 'The storage account key regenerate parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'StorageAccountRegenerteKeyParameters(*, key_name: str, **kwargs)' + parameters: + - name: key_name + description: Required. The storage account key name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: key_name + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.StorageAccountRegenerteKeyParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.StorageAccountRegenerteKeyParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.StorageAccountRegenerteKeyParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.StorageAccountRegenerteKeyParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.StorageAccountRegenerteKeyParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.StorageAccountRegenerteKeyParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.StorageAccountRegenerteKeyParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountUpdateParameters.yml new file mode 100644 index 00000000..f95425fa --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountUpdateParameters.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.StorageAccountUpdateParameters +name: StorageAccountUpdateParameters +fullName: azure.keyvault.v2016_10_01.models.StorageAccountUpdateParameters +module: azure.keyvault.v2016_10_01.models +summary: The storage account update parameters. +constructor: + syntax: 'StorageAccountUpdateParameters(*, active_key_name: str = None, auto_regenerate_key: + bool = None, regeneration_period: str = None, storage_account_attributes=None, + tags=None, **kwargs)' + parameters: + - name: active_key_name + description: The current active storage account key name. + isRequired: true + types: + - + - name: auto_regenerate_key + description: 'whether keyvault should manage the storage + + account for the user.' + isRequired: true + types: + - + - name: regeneration_period + description: 'The key regeneration time duration specified + + in ISO-8601 format.' + isRequired: true + types: + - + - name: storage_account_attributes + description: The attributes of the storage account. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: active_key_name + isRequired: true + - name: auto_regenerate_key + isRequired: true + - name: regeneration_period + isRequired: true + - name: storage_account_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.StorageAccountUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.StorageAccountUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.StorageAccountUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.StorageAccountUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.StorageAccountUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.StorageAccountUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.StorageAccountUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageBundle.yml new file mode 100644 index 00000000..b7d959e8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageBundle.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.StorageBundle +name: StorageBundle +fullName: azure.keyvault.v2016_10_01.models.StorageBundle +module: azure.keyvault.v2016_10_01.models +summary: 'A Storage account bundle consists of key vault storage account details plus + + its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: StorageBundle(**kwargs) +variables: +- description: The storage account id. + name: id + types: + - +- description: The storage account resource id. + name: resource_id + types: + - +- description: The current active storage account key name. + name: active_key_name + types: + - +- description: 'whether keyvault should manage the storage + + account for the user.' + name: auto_regenerate_key + types: + - +- description: 'The key regeneration time duration specified in + + ISO-8601 format.' + name: regeneration_period + types: + - +- description: The storage account attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v2016_10_01.models.StorageBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.StorageBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.StorageBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.StorageBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.StorageBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.StorageBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.StorageBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SubjectAlternativeNames.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SubjectAlternativeNames.yml new file mode 100644 index 00000000..f8b921b0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SubjectAlternativeNames.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.SubjectAlternativeNames +name: SubjectAlternativeNames +fullName: azure.keyvault.v2016_10_01.models.SubjectAlternativeNames +module: azure.keyvault.v2016_10_01.models +summary: The subject alternate names of a X509 object. +constructor: + syntax: SubjectAlternativeNames(*, emails=None, dns_names=None, upns=None, **kwargs) + parameters: + - name: emails + description: Email addresses. + isRequired: true + types: + - [] + - name: dns_names + description: Domain names. + isRequired: true + types: + - [] + - name: upns + description: User principal names. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: emails + isRequired: true + - name: dns_names + isRequired: true + - name: upns + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.SubjectAlternativeNames.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SubjectAlternativeNames.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SubjectAlternativeNames.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.SubjectAlternativeNames.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.SubjectAlternativeNames.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.SubjectAlternativeNames.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.SubjectAlternativeNames.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Trigger(class).yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Trigger(class).yml new file mode 100644 index 00000000..cfdae830 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Trigger(class).yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.Trigger +name: Trigger +fullName: azure.keyvault.v2016_10_01.models.Trigger +module: azure.keyvault.v2016_10_01.models +summary: A condition to be satisfied for an action to be executed. +constructor: + syntax: 'Trigger(*, lifetime_percentage: int = None, days_before_expiry: int = None, + **kwargs)' + parameters: + - name: lifetime_percentage + description: 'Percentage of lifetime at which to trigger. + + Value should be between 1 and 99.' + isRequired: true + types: + - + - name: days_before_expiry + description: 'Days before expiry to attempt renewal. Value + + should be between 1 and validity_in_months multiplied by 27. If + + validity_in_months is 36, then value should be between 1 and 972 (36 * + + 27).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: lifetime_percentage + isRequired: true + - name: days_before_expiry + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.Trigger.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.Trigger.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.Trigger.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.Trigger.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.Trigger.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.Trigger.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.Trigger.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.X509CertificateProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.X509CertificateProperties.yml new file mode 100644 index 00000000..172033d7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.X509CertificateProperties.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.X509CertificateProperties +name: X509CertificateProperties +fullName: azure.keyvault.v2016_10_01.models.X509CertificateProperties +module: azure.keyvault.v2016_10_01.models +summary: Properties of the X509 component of a certificate. +constructor: + syntax: 'X509CertificateProperties(*, subject: str = None, ekus=None, subject_alternative_names=None, + key_usage=None, validity_in_months: int = None, **kwargs)' + parameters: + - name: subject + description: 'The subject name. Should be a valid X509 distinguished + + Name.' + isRequired: true + types: + - + - name: ekus + description: The enhanced key usage. + isRequired: true + types: + - [] + - name: subject_alternative_names + description: The subject alternative names. + isRequired: true + types: + - + - name: key_usage + description: List of key usages. + isRequired: true + types: + - [ + - ] + - name: validity_in_months + description: 'The duration that the ceritifcate is valid in + + months.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: subject + isRequired: true + - name: ekus + isRequired: true + - name: subject_alternative_names + isRequired: true + - name: key_usage + isRequired: true + - name: validity_in_months + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.X509CertificateProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.X509CertificateProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.X509CertificateProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.X509CertificateProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.X509CertificateProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.X509CertificateProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.X509CertificateProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.action.Action.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.action.Action.yml new file mode 100644 index 00000000..dede389c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.action.Action.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.action.Action +name: Action +fullName: azure.keyvault.v2016_10_01.models.action.Action +module: azure.keyvault.v2016_10_01.models.action +summary: The action that will be executed. +constructor: + syntax: Action(**kwargs) + parameters: + - name: action_type + description: 'The type of the action. Possible values include: + + ''EmailContacts'', ''AutoRenew''' + isRequired: true + types: + - + - +methods: +- uid: azure.keyvault.v2016_10_01.models.action.Action.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.action.Action.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.action.Action.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.action.Action.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.action.Action.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.action.Action.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.action.Action.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.action.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.action.yml new file mode 100644 index 00000000..a953f302 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.action.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.action +name: action +fullName: azure.keyvault.v2016_10_01.models.action +classes: +- azure.keyvault.v2016_10_01.models.action.Action diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.action_py3.Action.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.action_py3.Action.yml new file mode 100644 index 00000000..fca338ed --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.action_py3.Action.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.action_py3.Action +name: Action +fullName: azure.keyvault.v2016_10_01.models.action_py3.Action +module: azure.keyvault.v2016_10_01.models.action_py3 +summary: The action that will be executed. +constructor: + syntax: Action(*, action_type=None, **kwargs) + parameters: + - name: action_type + description: 'The type of the action. Possible values include: + + ''EmailContacts'', ''AutoRenew''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: action_type + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.action_py3.Action.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.action_py3.Action.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.action_py3.Action.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.action_py3.Action.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.action_py3.Action.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.action_py3.Action.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.action_py3.Action.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.action_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.action_py3.yml new file mode 100644 index 00000000..4fd35d0c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.action_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.action_py3 +name: action_py3 +fullName: azure.keyvault.v2016_10_01.models.action_py3 +classes: +- azure.keyvault.v2016_10_01.models.action_py3.Action diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.administrator_details.AdministratorDetails.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.administrator_details.AdministratorDetails.yml new file mode 100644 index 00000000..0681e149 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.administrator_details.AdministratorDetails.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.administrator_details.AdministratorDetails +name: AdministratorDetails +fullName: azure.keyvault.v2016_10_01.models.administrator_details.AdministratorDetails +module: azure.keyvault.v2016_10_01.models.administrator_details +summary: Details of the organization administrator of the certificate issuer. +constructor: + syntax: AdministratorDetails(**kwargs) + parameters: + - name: first_name + description: First name. + isRequired: true + types: + - + - name: last_name + description: Last name. + isRequired: true + types: + - + - name: email_address + description: Email addresss. + isRequired: true + types: + - + - name: phone + description: Phone number. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.administrator_details.AdministratorDetails.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.administrator_details.AdministratorDetails.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.administrator_details.AdministratorDetails.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.administrator_details.AdministratorDetails.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.administrator_details.AdministratorDetails.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.administrator_details.AdministratorDetails.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.administrator_details.AdministratorDetails.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.administrator_details.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.administrator_details.yml new file mode 100644 index 00000000..6a71f13a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.administrator_details.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.administrator_details +name: administrator_details +fullName: azure.keyvault.v2016_10_01.models.administrator_details +classes: +- azure.keyvault.v2016_10_01.models.administrator_details.AdministratorDetails diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.administrator_details_py3.AdministratorDetails.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.administrator_details_py3.AdministratorDetails.yml new file mode 100644 index 00000000..ad464936 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.administrator_details_py3.AdministratorDetails.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.administrator_details_py3.AdministratorDetails +name: AdministratorDetails +fullName: azure.keyvault.v2016_10_01.models.administrator_details_py3.AdministratorDetails +module: azure.keyvault.v2016_10_01.models.administrator_details_py3 +summary: Details of the organization administrator of the certificate issuer. +constructor: + syntax: 'AdministratorDetails(*, first_name: str = None, last_name: str = None, + email_address: str = None, phone: str = None, **kwargs)' + parameters: + - name: first_name + description: First name. + isRequired: true + types: + - + - name: last_name + description: Last name. + isRequired: true + types: + - + - name: email_address + description: Email addresss. + isRequired: true + types: + - + - name: phone + description: Phone number. + isRequired: true + types: + - + keywordOnlyParameters: + - name: first_name + isRequired: true + - name: last_name + isRequired: true + - name: email_address + isRequired: true + - name: phone + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.administrator_details_py3.AdministratorDetails.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.administrator_details_py3.AdministratorDetails.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.administrator_details_py3.AdministratorDetails.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.administrator_details_py3.AdministratorDetails.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.administrator_details_py3.AdministratorDetails.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.administrator_details_py3.AdministratorDetails.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.administrator_details_py3.AdministratorDetails.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.administrator_details_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.administrator_details_py3.yml new file mode 100644 index 00000000..608ed68b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.administrator_details_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.administrator_details_py3 +name: administrator_details_py3 +fullName: azure.keyvault.v2016_10_01.models.administrator_details_py3 +classes: +- azure.keyvault.v2016_10_01.models.administrator_details_py3.AdministratorDetails diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.attributes.Attributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.attributes.Attributes.yml new file mode 100644 index 00000000..790a9f59 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.attributes.Attributes.yml @@ -0,0 +1,144 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.attributes.Attributes +name: Attributes +fullName: azure.keyvault.v2016_10_01.models.attributes.Attributes +module: azure.keyvault.v2016_10_01.models.attributes +summary: 'The object attributes managed by the KeyVault service. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Attributes(**kwargs) + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.attributes.Attributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.attributes.Attributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.attributes.Attributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.attributes.Attributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.attributes.Attributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.attributes.Attributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.attributes.Attributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.attributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.attributes.yml new file mode 100644 index 00000000..ba0092d9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.attributes.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.attributes +name: attributes +fullName: azure.keyvault.v2016_10_01.models.attributes +classes: +- azure.keyvault.v2016_10_01.models.attributes.Attributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.attributes_py3.Attributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.attributes_py3.Attributes.yml new file mode 100644 index 00000000..2d1c2e81 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.attributes_py3.Attributes.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.attributes_py3.Attributes +name: Attributes +fullName: azure.keyvault.v2016_10_01.models.attributes_py3.Attributes +module: azure.keyvault.v2016_10_01.models.attributes_py3 +summary: 'The object attributes managed by the KeyVault service. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'Attributes(*, enabled: bool = None, not_before=None, expires=None, **kwargs)' + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true + - name: not_before + isRequired: true + - name: expires + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.attributes_py3.Attributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.attributes_py3.Attributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.attributes_py3.Attributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.attributes_py3.Attributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.attributes_py3.Attributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.attributes_py3.Attributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.attributes_py3.Attributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.attributes_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.attributes_py3.yml new file mode 100644 index 00000000..e812a3f4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.attributes_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.attributes_py3 +name: attributes_py3 +fullName: azure.keyvault.v2016_10_01.models.attributes_py3 +classes: +- azure.keyvault.v2016_10_01.models.attributes_py3.Attributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_key_result.BackupKeyResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_key_result.BackupKeyResult.yml new file mode 100644 index 00000000..cfeecbfc --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_key_result.BackupKeyResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.backup_key_result.BackupKeyResult +name: BackupKeyResult +fullName: azure.keyvault.v2016_10_01.models.backup_key_result.BackupKeyResult +module: azure.keyvault.v2016_10_01.models.backup_key_result +summary: 'The backup key result, containing the backup blob. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: BackupKeyResult(**kwargs) +variables: +- description: The backup blob containing the backed up key. + name: value + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.backup_key_result.BackupKeyResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.backup_key_result.BackupKeyResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.backup_key_result.BackupKeyResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.backup_key_result.BackupKeyResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.backup_key_result.BackupKeyResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.backup_key_result.BackupKeyResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.backup_key_result.BackupKeyResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_key_result.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_key_result.yml new file mode 100644 index 00000000..023e0056 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_key_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.backup_key_result +name: backup_key_result +fullName: azure.keyvault.v2016_10_01.models.backup_key_result +classes: +- azure.keyvault.v2016_10_01.models.backup_key_result.BackupKeyResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_key_result_py3.BackupKeyResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_key_result_py3.BackupKeyResult.yml new file mode 100644 index 00000000..0c722db2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_key_result_py3.BackupKeyResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.backup_key_result_py3.BackupKeyResult +name: BackupKeyResult +fullName: azure.keyvault.v2016_10_01.models.backup_key_result_py3.BackupKeyResult +module: azure.keyvault.v2016_10_01.models.backup_key_result_py3 +summary: 'The backup key result, containing the backup blob. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: BackupKeyResult(**kwargs) +variables: +- description: The backup blob containing the backed up key. + name: value + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.backup_key_result_py3.BackupKeyResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.backup_key_result_py3.BackupKeyResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.backup_key_result_py3.BackupKeyResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.backup_key_result_py3.BackupKeyResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.backup_key_result_py3.BackupKeyResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.backup_key_result_py3.BackupKeyResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.backup_key_result_py3.BackupKeyResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_key_result_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_key_result_py3.yml new file mode 100644 index 00000000..4ea6dd56 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_key_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.backup_key_result_py3 +name: backup_key_result_py3 +fullName: azure.keyvault.v2016_10_01.models.backup_key_result_py3 +classes: +- azure.keyvault.v2016_10_01.models.backup_key_result_py3.BackupKeyResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_secret_result.BackupSecretResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_secret_result.BackupSecretResult.yml new file mode 100644 index 00000000..4604c38c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_secret_result.BackupSecretResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.backup_secret_result.BackupSecretResult +name: BackupSecretResult +fullName: azure.keyvault.v2016_10_01.models.backup_secret_result.BackupSecretResult +module: azure.keyvault.v2016_10_01.models.backup_secret_result +summary: 'The backup secret result, containing the backup blob. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: BackupSecretResult(**kwargs) +variables: +- description: The backup blob containing the backed up secret. + name: value + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.backup_secret_result.BackupSecretResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.backup_secret_result.BackupSecretResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.backup_secret_result.BackupSecretResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.backup_secret_result.BackupSecretResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.backup_secret_result.BackupSecretResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.backup_secret_result.BackupSecretResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.backup_secret_result.BackupSecretResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_secret_result.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_secret_result.yml new file mode 100644 index 00000000..5a29129f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_secret_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.backup_secret_result +name: backup_secret_result +fullName: azure.keyvault.v2016_10_01.models.backup_secret_result +classes: +- azure.keyvault.v2016_10_01.models.backup_secret_result.BackupSecretResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_secret_result_py3.BackupSecretResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_secret_result_py3.BackupSecretResult.yml new file mode 100644 index 00000000..25221b17 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_secret_result_py3.BackupSecretResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.backup_secret_result_py3.BackupSecretResult +name: BackupSecretResult +fullName: azure.keyvault.v2016_10_01.models.backup_secret_result_py3.BackupSecretResult +module: azure.keyvault.v2016_10_01.models.backup_secret_result_py3 +summary: 'The backup secret result, containing the backup blob. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: BackupSecretResult(**kwargs) +variables: +- description: The backup blob containing the backed up secret. + name: value + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.backup_secret_result_py3.BackupSecretResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.backup_secret_result_py3.BackupSecretResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.backup_secret_result_py3.BackupSecretResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.backup_secret_result_py3.BackupSecretResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.backup_secret_result_py3.BackupSecretResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.backup_secret_result_py3.BackupSecretResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.backup_secret_result_py3.BackupSecretResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_secret_result_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_secret_result_py3.yml new file mode 100644 index 00000000..7d463f8d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.backup_secret_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.backup_secret_result_py3 +name: backup_secret_result_py3 +fullName: azure.keyvault.v2016_10_01.models.backup_secret_result_py3 +classes: +- azure.keyvault.v2016_10_01.models.backup_secret_result_py3.BackupSecretResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_attributes.CertificateAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_attributes.CertificateAttributes.yml new file mode 100644 index 00000000..750cb70d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_attributes.CertificateAttributes.yml @@ -0,0 +1,161 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_attributes.CertificateAttributes +name: CertificateAttributes +fullName: azure.keyvault.v2016_10_01.models.certificate_attributes.CertificateAttributes +module: azure.keyvault.v2016_10_01.models.certificate_attributes +summary: 'The certificate management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: CertificateAttributes(**kwargs) + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for certificates in the current vault. If it contains ''Purgeable'', + + the certificate can be permanently deleted by a privileged user; + + otherwise, only the system can purge the certificate, at the end of the + + retention interval. Possible values include: ''Purgeable'', + + ''Recoverable+Purgeable'', ''Recoverable'', + + ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_attributes.CertificateAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_attributes.CertificateAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_attributes.CertificateAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_attributes.CertificateAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_attributes.CertificateAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_attributes.CertificateAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_attributes.CertificateAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_attributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_attributes.yml new file mode 100644 index 00000000..1791a3a5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_attributes.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_attributes +name: certificate_attributes +fullName: azure.keyvault.v2016_10_01.models.certificate_attributes +classes: +- azure.keyvault.v2016_10_01.models.certificate_attributes.CertificateAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_attributes_py3.CertificateAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_attributes_py3.CertificateAttributes.yml new file mode 100644 index 00000000..19ed3c1c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_attributes_py3.CertificateAttributes.yml @@ -0,0 +1,169 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_attributes_py3.CertificateAttributes +name: CertificateAttributes +fullName: azure.keyvault.v2016_10_01.models.certificate_attributes_py3.CertificateAttributes +module: azure.keyvault.v2016_10_01.models.certificate_attributes_py3 +summary: 'The certificate management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'CertificateAttributes(*, enabled: bool = None, not_before=None, expires=None, + **kwargs)' + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true + - name: not_before + isRequired: true + - name: expires + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for certificates in the current vault. If it contains ''Purgeable'', + + the certificate can be permanently deleted by a privileged user; + + otherwise, only the system can purge the certificate, at the end of the + + retention interval. Possible values include: ''Purgeable'', + + ''Recoverable+Purgeable'', ''Recoverable'', + + ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_attributes_py3.CertificateAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_attributes_py3.CertificateAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_attributes_py3.CertificateAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_attributes_py3.CertificateAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_attributes_py3.CertificateAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_attributes_py3.CertificateAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_attributes_py3.CertificateAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_attributes_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_attributes_py3.yml new file mode 100644 index 00000000..2aa84196 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_attributes_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_attributes_py3 +name: certificate_attributes_py3 +fullName: azure.keyvault.v2016_10_01.models.certificate_attributes_py3 +classes: +- azure.keyvault.v2016_10_01.models.certificate_attributes_py3.CertificateAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_bundle.CertificateBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_bundle.CertificateBundle.yml new file mode 100644 index 00000000..1d45d76f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_bundle.CertificateBundle.yml @@ -0,0 +1,161 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_bundle.CertificateBundle +name: CertificateBundle +fullName: azure.keyvault.v2016_10_01.models.certificate_bundle.CertificateBundle +module: azure.keyvault.v2016_10_01.models.certificate_bundle +summary: 'A certificate bundle consists of a certificate (X509) plus its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: CertificateBundle(**kwargs) + parameters: + - name: cer + description: CER contents of x509 certificate. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The certificate attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs + isRequired: true + types: + - [, ] +variables: +- description: The certificate id. + name: id + types: + - +- description: The key id. + name: kid + types: + - +- description: The secret id. + name: sid + types: + - +- description: Thumbprint of the certificate. + name: x509_thumbprint + types: + - +- description: The management policy. + name: policy + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_bundle.CertificateBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_bundle.CertificateBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_bundle.CertificateBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_bundle.CertificateBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_bundle.CertificateBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_bundle.CertificateBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_bundle.CertificateBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_bundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_bundle.yml new file mode 100644 index 00000000..0c19c2ee --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_bundle.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_bundle +name: certificate_bundle +fullName: azure.keyvault.v2016_10_01.models.certificate_bundle +classes: +- azure.keyvault.v2016_10_01.models.certificate_bundle.CertificateBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_bundle_py3.CertificateBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_bundle_py3.CertificateBundle.yml new file mode 100644 index 00000000..ff407241 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_bundle_py3.CertificateBundle.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_bundle_py3.CertificateBundle +name: CertificateBundle +fullName: azure.keyvault.v2016_10_01.models.certificate_bundle_py3.CertificateBundle +module: azure.keyvault.v2016_10_01.models.certificate_bundle_py3 +summary: 'A certificate bundle consists of a certificate (X509) plus its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'CertificateBundle(*, cer: bytearray = None, content_type: str = None, attributes=None, + tags=None, **kwargs)' + parameters: + - name: cer + description: CER contents of x509 certificate. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The certificate attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: cer + isRequired: true + - name: content_type + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true +variables: +- description: The certificate id. + name: id + types: + - +- description: The key id. + name: kid + types: + - +- description: The secret id. + name: sid + types: + - +- description: Thumbprint of the certificate. + name: x509_thumbprint + types: + - +- description: The management policy. + name: policy + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_bundle_py3.CertificateBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_bundle_py3.CertificateBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_bundle_py3.CertificateBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_bundle_py3.CertificateBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_bundle_py3.CertificateBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_bundle_py3.CertificateBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_bundle_py3.CertificateBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_bundle_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_bundle_py3.yml new file mode 100644 index 00000000..e3b77d06 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_bundle_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_bundle_py3 +name: certificate_bundle_py3 +fullName: azure.keyvault.v2016_10_01.models.certificate_bundle_py3 +classes: +- azure.keyvault.v2016_10_01.models.certificate_bundle_py3.CertificateBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_create_parameters.CertificateCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_create_parameters.CertificateCreateParameters.yml new file mode 100644 index 00000000..5ce1e32c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_create_parameters.CertificateCreateParameters.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_create_parameters.CertificateCreateParameters +name: CertificateCreateParameters +fullName: azure.keyvault.v2016_10_01.models.certificate_create_parameters.CertificateCreateParameters +module: azure.keyvault.v2016_10_01.models.certificate_create_parameters +summary: The certificate create parameters. +constructor: + syntax: CertificateCreateParameters(**kwargs) + parameters: + - name: certificate_policy + description: The management policy for the certificate. + isRequired: true + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_create_parameters.CertificateCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_create_parameters.CertificateCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_create_parameters.CertificateCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_create_parameters.CertificateCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_create_parameters.CertificateCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_create_parameters.CertificateCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_create_parameters.CertificateCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_create_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_create_parameters.yml new file mode 100644 index 00000000..d273d0d6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_create_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_create_parameters +name: certificate_create_parameters +fullName: azure.keyvault.v2016_10_01.models.certificate_create_parameters +classes: +- azure.keyvault.v2016_10_01.models.certificate_create_parameters.CertificateCreateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.CertificateCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.CertificateCreateParameters.yml new file mode 100644 index 00000000..51347987 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.CertificateCreateParameters.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.CertificateCreateParameters +name: CertificateCreateParameters +fullName: azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.CertificateCreateParameters +module: azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3 +summary: The certificate create parameters. +constructor: + syntax: CertificateCreateParameters(*, certificate_policy=None, certificate_attributes=None, + tags=None, **kwargs) + parameters: + - name: certificate_policy + description: The management policy for the certificate. + isRequired: true + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: certificate_policy + isRequired: true + - name: certificate_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.CertificateCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.CertificateCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.CertificateCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.CertificateCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.CertificateCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.CertificateCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.CertificateCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.yml new file mode 100644 index 00000000..67c1be24 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3 +name: certificate_create_parameters_py3 +fullName: azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3 +classes: +- azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.CertificateCreateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_import_parameters.CertificateImportParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_import_parameters.CertificateImportParameters.yml new file mode 100644 index 00000000..402fae53 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_import_parameters.CertificateImportParameters.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_import_parameters.CertificateImportParameters +name: CertificateImportParameters +fullName: azure.keyvault.v2016_10_01.models.certificate_import_parameters.CertificateImportParameters +module: azure.keyvault.v2016_10_01.models.certificate_import_parameters +summary: 'The certificate import parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CertificateImportParameters(**kwargs) + parameters: + - name: base64_encoded_certificate + description: 'Required. Base64 encoded representation + + of the certificate object to import. This certificate needs to contain the + + private key.' + isRequired: true + types: + - + - name: password + description: 'If the private key in base64EncodedCertificate is + + encrypted, the password used for encryption.' + isRequired: true + types: + - + - name: certificate_policy + description: The management policy for the certificate. + isRequired: true + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_import_parameters.CertificateImportParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_import_parameters.CertificateImportParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_import_parameters.CertificateImportParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_import_parameters.CertificateImportParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_import_parameters.CertificateImportParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_import_parameters.CertificateImportParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_import_parameters.CertificateImportParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_import_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_import_parameters.yml new file mode 100644 index 00000000..bcd1b1a5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_import_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_import_parameters +name: certificate_import_parameters +fullName: azure.keyvault.v2016_10_01.models.certificate_import_parameters +classes: +- azure.keyvault.v2016_10_01.models.certificate_import_parameters.CertificateImportParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.CertificateImportParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.CertificateImportParameters.yml new file mode 100644 index 00000000..b93b8e9e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.CertificateImportParameters.yml @@ -0,0 +1,163 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.CertificateImportParameters +name: CertificateImportParameters +fullName: azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.CertificateImportParameters +module: azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3 +summary: 'The certificate import parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CertificateImportParameters(*, base64_encoded_certificate: str, password: + str = None, certificate_policy=None, certificate_attributes=None, tags=None, **kwargs)' + parameters: + - name: base64_encoded_certificate + description: 'Required. Base64 encoded representation + + of the certificate object to import. This certificate needs to contain the + + private key.' + isRequired: true + types: + - + - name: password + description: 'If the private key in base64EncodedCertificate is + + encrypted, the password used for encryption.' + isRequired: true + types: + - + - name: certificate_policy + description: The management policy for the certificate. + isRequired: true + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: base64_encoded_certificate + isRequired: true + - name: password + isRequired: true + - name: certificate_policy + isRequired: true + - name: certificate_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.CertificateImportParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.CertificateImportParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.CertificateImportParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.CertificateImportParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.CertificateImportParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.CertificateImportParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.CertificateImportParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.yml new file mode 100644 index 00000000..40ce64f0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3 +name: certificate_import_parameters_py3 +fullName: azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3 +classes: +- azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.CertificateImportParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item.CertificateIssuerItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item.CertificateIssuerItem.yml new file mode 100644 index 00000000..1d3cba6b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item.CertificateIssuerItem.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item.CertificateIssuerItem +name: CertificateIssuerItem +fullName: azure.keyvault.v2016_10_01.models.certificate_issuer_item.CertificateIssuerItem +module: azure.keyvault.v2016_10_01.models.certificate_issuer_item +summary: The certificate issuer item containing certificate issuer metadata. +constructor: + syntax: CertificateIssuerItem(**kwargs) + parameters: + - name: id + description: Certificate Identifier. + isRequired: true + types: + - + - name: provider + description: The issuer provider. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item.CertificateIssuerItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item.CertificateIssuerItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item.CertificateIssuerItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item.CertificateIssuerItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item.CertificateIssuerItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item.CertificateIssuerItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item.CertificateIssuerItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item.yml new file mode 100644 index 00000000..1d95401a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item +name: certificate_issuer_item +fullName: azure.keyvault.v2016_10_01.models.certificate_issuer_item +classes: +- azure.keyvault.v2016_10_01.models.certificate_issuer_item.CertificateIssuerItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged.CertificateIssuerItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged.CertificateIssuerItemPaged.yml new file mode 100644 index 00000000..9277c1bc --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged.CertificateIssuerItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged.CertificateIssuerItemPaged +name: CertificateIssuerItemPaged +fullName: azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged.CertificateIssuerItemPaged +module: azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: CertificateIssuerItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged.CertificateIssuerItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged.CertificateIssuerItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged.CertificateIssuerItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged.CertificateIssuerItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged.CertificateIssuerItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged.CertificateIssuerItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged.CertificateIssuerItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged.yml new file mode 100644 index 00000000..323dc541 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged +name: certificate_issuer_item_paged +fullName: azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged +classes: +- azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged.CertificateIssuerItemPaged diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.CertificateIssuerItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.CertificateIssuerItem.yml new file mode 100644 index 00000000..173c7977 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.CertificateIssuerItem.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.CertificateIssuerItem +name: CertificateIssuerItem +fullName: azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.CertificateIssuerItem +module: azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3 +summary: The certificate issuer item containing certificate issuer metadata. +constructor: + syntax: 'CertificateIssuerItem(*, id: str = None, provider: str = None, **kwargs)' + parameters: + - name: id + description: Certificate Identifier. + isRequired: true + types: + - + - name: provider + description: The issuer provider. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: provider + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.CertificateIssuerItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.CertificateIssuerItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.CertificateIssuerItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.CertificateIssuerItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.CertificateIssuerItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.CertificateIssuerItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.CertificateIssuerItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.yml new file mode 100644 index 00000000..7b2ea7cc --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3 +name: certificate_issuer_item_py3 +fullName: azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3 +classes: +- azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.CertificateIssuerItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters.yml new file mode 100644 index 00000000..9ad54083 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters +name: CertificateIssuerSetParameters +fullName: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters +module: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters +summary: 'The certificate issuer set parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CertificateIssuerSetParameters(**kwargs) + parameters: + - name: provider + description: Required. The issuer provider. + isRequired: true + types: + - + - name: credentials + description: The credentials to be used for the issuer. + isRequired: true + types: + - + - name: organization_details + description: 'Details of the organization as provided to + + the issuer.' + isRequired: true + types: + - + - name: attributes + description: Attributes of the issuer object. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters.yml new file mode 100644 index 00000000..a626b8c1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters +name: certificate_issuer_set_parameters +fullName: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters +classes: +- azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.yml new file mode 100644 index 00000000..6962edc4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters +name: CertificateIssuerSetParameters +fullName: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters +module: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3 +summary: 'The certificate issuer set parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CertificateIssuerSetParameters(*, provider: str, credentials=None, organization_details=None, + attributes=None, **kwargs)' + parameters: + - name: provider + description: Required. The issuer provider. + isRequired: true + types: + - + - name: credentials + description: The credentials to be used for the issuer. + isRequired: true + types: + - + - name: organization_details + description: 'Details of the organization as provided to + + the issuer.' + isRequired: true + types: + - + - name: attributes + description: Attributes of the issuer object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: provider + isRequired: true + - name: credentials + isRequired: true + - name: organization_details + isRequired: true + - name: attributes + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.yml new file mode 100644 index 00000000..012f3ae0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3 +name: certificate_issuer_set_parameters_py3 +fullName: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3 +classes: +- azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters.yml new file mode 100644 index 00000000..10c68339 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters +name: CertificateIssuerUpdateParameters +fullName: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters +module: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters +summary: The certificate issuer update parameters. +constructor: + syntax: CertificateIssuerUpdateParameters(**kwargs) + parameters: + - name: provider + description: The issuer provider. + isRequired: true + types: + - + - name: credentials + description: The credentials to be used for the issuer. + isRequired: true + types: + - + - name: organization_details + description: 'Details of the organization as provided to + + the issuer.' + isRequired: true + types: + - + - name: attributes + description: Attributes of the issuer object. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters.yml new file mode 100644 index 00000000..259d3ce4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters +name: certificate_issuer_update_parameters +fullName: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters +classes: +- azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.yml new file mode 100644 index 00000000..bc7991e4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters +name: CertificateIssuerUpdateParameters +fullName: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters +module: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3 +summary: The certificate issuer update parameters. +constructor: + syntax: 'CertificateIssuerUpdateParameters(*, provider: str = None, credentials=None, + organization_details=None, attributes=None, **kwargs)' + parameters: + - name: provider + description: The issuer provider. + isRequired: true + types: + - + - name: credentials + description: The credentials to be used for the issuer. + isRequired: true + types: + - + - name: organization_details + description: 'Details of the organization as provided to + + the issuer.' + isRequired: true + types: + - + - name: attributes + description: Attributes of the issuer object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: provider + isRequired: true + - name: credentials + isRequired: true + - name: organization_details + isRequired: true + - name: attributes + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.yml new file mode 100644 index 00000000..81c40798 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3 +name: certificate_issuer_update_parameters_py3 +fullName: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3 +classes: +- azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item.CertificateItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item.CertificateItem.yml new file mode 100644 index 00000000..50b04487 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item.CertificateItem.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_item.CertificateItem +name: CertificateItem +fullName: azure.keyvault.v2016_10_01.models.certificate_item.CertificateItem +module: azure.keyvault.v2016_10_01.models.certificate_item +summary: The certificate item containing certificate metadata. +constructor: + syntax: CertificateItem(**kwargs) + parameters: + - name: id + description: Certificate identifier. + isRequired: true + types: + - + - name: attributes + description: The certificate management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: x509_thumbprint + description: Thumbprint of the certificate. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_item.CertificateItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_item.CertificateItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_item.CertificateItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_item.CertificateItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_item.CertificateItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_item.CertificateItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_item.CertificateItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item.yml new file mode 100644 index 00000000..f38655e6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_item +name: certificate_item +fullName: azure.keyvault.v2016_10_01.models.certificate_item +classes: +- azure.keyvault.v2016_10_01.models.certificate_item.CertificateItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item_paged.CertificateItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item_paged.CertificateItemPaged.yml new file mode 100644 index 00000000..3fb62d50 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item_paged.CertificateItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_item_paged.CertificateItemPaged +name: CertificateItemPaged +fullName: azure.keyvault.v2016_10_01.models.certificate_item_paged.CertificateItemPaged +module: azure.keyvault.v2016_10_01.models.certificate_item_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: CertificateItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_item_paged.CertificateItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v2016_10_01.models.certificate_item_paged.CertificateItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v2016_10_01.models.certificate_item_paged.CertificateItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_item_paged.CertificateItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_item_paged.CertificateItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v2016_10_01.models.certificate_item_paged.CertificateItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v2016_10_01.models.certificate_item_paged.CertificateItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item_paged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item_paged.yml new file mode 100644 index 00000000..13eeec43 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_item_paged +name: certificate_item_paged +fullName: azure.keyvault.v2016_10_01.models.certificate_item_paged +classes: +- azure.keyvault.v2016_10_01.models.certificate_item_paged.CertificateItemPaged diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item_py3.CertificateItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item_py3.CertificateItem.yml new file mode 100644 index 00000000..b9c67403 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item_py3.CertificateItem.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_item_py3.CertificateItem +name: CertificateItem +fullName: azure.keyvault.v2016_10_01.models.certificate_item_py3.CertificateItem +module: azure.keyvault.v2016_10_01.models.certificate_item_py3 +summary: The certificate item containing certificate metadata. +constructor: + syntax: 'CertificateItem(*, id: str = None, attributes=None, tags=None, x509_thumbprint: + bytes = None, **kwargs)' + parameters: + - name: id + description: Certificate identifier. + isRequired: true + types: + - + - name: attributes + description: The certificate management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: x509_thumbprint + description: Thumbprint of the certificate. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: x509_thumbprint + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_item_py3.CertificateItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_item_py3.CertificateItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_item_py3.CertificateItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_item_py3.CertificateItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_item_py3.CertificateItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_item_py3.CertificateItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_item_py3.CertificateItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item_py3.yml new file mode 100644 index 00000000..6fa381f8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_item_py3 +name: certificate_item_py3 +fullName: azure.keyvault.v2016_10_01.models.certificate_item_py3 +classes: +- azure.keyvault.v2016_10_01.models.certificate_item_py3.CertificateItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_merge_parameters.CertificateMergeParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_merge_parameters.CertificateMergeParameters.yml new file mode 100644 index 00000000..9b538d32 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_merge_parameters.CertificateMergeParameters.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_merge_parameters.CertificateMergeParameters +name: CertificateMergeParameters +fullName: azure.keyvault.v2016_10_01.models.certificate_merge_parameters.CertificateMergeParameters +module: azure.keyvault.v2016_10_01.models.certificate_merge_parameters +summary: 'The certificate merge parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CertificateMergeParameters(**kwargs) + parameters: + - name: x509_certificates + description: 'Required. The certificate or the certificate + + chain to merge.' + isRequired: true + types: + - [] + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_merge_parameters.CertificateMergeParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_merge_parameters.CertificateMergeParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_merge_parameters.CertificateMergeParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_merge_parameters.CertificateMergeParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_merge_parameters.CertificateMergeParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_merge_parameters.CertificateMergeParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_merge_parameters.CertificateMergeParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_merge_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_merge_parameters.yml new file mode 100644 index 00000000..3e62cb64 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_merge_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_merge_parameters +name: certificate_merge_parameters +fullName: azure.keyvault.v2016_10_01.models.certificate_merge_parameters +classes: +- azure.keyvault.v2016_10_01.models.certificate_merge_parameters.CertificateMergeParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.CertificateMergeParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.CertificateMergeParameters.yml new file mode 100644 index 00000000..c3bab9b7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.CertificateMergeParameters.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.CertificateMergeParameters +name: CertificateMergeParameters +fullName: azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.CertificateMergeParameters +module: azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3 +summary: 'The certificate merge parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CertificateMergeParameters(*, x509_certificates, certificate_attributes=None, + tags=None, **kwargs) + parameters: + - name: x509_certificates + description: 'Required. The certificate or the certificate + + chain to merge.' + isRequired: true + types: + - [] + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: x509_certificates + isRequired: true + - name: certificate_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.CertificateMergeParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.CertificateMergeParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.CertificateMergeParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.CertificateMergeParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.CertificateMergeParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.CertificateMergeParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.CertificateMergeParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.yml new file mode 100644 index 00000000..75cca8aa --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3 +name: certificate_merge_parameters_py3 +fullName: azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3 +classes: +- azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.CertificateMergeParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation.CertificateOperation.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation.CertificateOperation.yml new file mode 100644 index 00000000..38334fb8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation.CertificateOperation.yml @@ -0,0 +1,173 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_operation.CertificateOperation +name: CertificateOperation +fullName: azure.keyvault.v2016_10_01.models.certificate_operation.CertificateOperation +module: azure.keyvault.v2016_10_01.models.certificate_operation +summary: 'A certificate operation is returned in case of asynchronous requests. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: CertificateOperation(**kwargs) + parameters: + - name: issuer_parameters + description: 'Parameters for the issuer of the X509 component + + of a certificate.' + isRequired: true + types: + - + - name: csr + description: 'The certificate signing request (CSR) that is being used in + + the certificate operation.' + isRequired: true + types: + - + - name: cancellation_requested + description: 'Indicates if cancellation was requested on + + the certificate operation.' + isRequired: true + types: + - + - name: status + description: Status of the certificate operation. + isRequired: true + types: + - + - name: status_details + description: The status details of the certificate operation. + isRequired: true + types: + - + - name: error + description: Error encountered, if any, during the certificate operation. + isRequired: true + types: + - + - name: target + description: 'Location which contains the result of the certificate + + operation.' + isRequired: true + types: + - + - name: request_id + description: Identifier for the certificate operation. + isRequired: true + types: + - +variables: +- description: The certificate id. + name: id + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_operation.CertificateOperation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_operation.CertificateOperation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_operation.CertificateOperation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_operation.CertificateOperation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_operation.CertificateOperation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_operation.CertificateOperation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_operation.CertificateOperation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation.yml new file mode 100644 index 00000000..70bfa187 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_operation +name: certificate_operation +fullName: azure.keyvault.v2016_10_01.models.certificate_operation +classes: +- azure.keyvault.v2016_10_01.models.certificate_operation.CertificateOperation diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_py3.CertificateOperation.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_py3.CertificateOperation.yml new file mode 100644 index 00000000..8b7b2249 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_py3.CertificateOperation.yml @@ -0,0 +1,192 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_operation_py3.CertificateOperation +name: CertificateOperation +fullName: azure.keyvault.v2016_10_01.models.certificate_operation_py3.CertificateOperation +module: azure.keyvault.v2016_10_01.models.certificate_operation_py3 +summary: 'A certificate operation is returned in case of asynchronous requests. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'CertificateOperation(*, issuer_parameters=None, csr: bytearray = None, + cancellation_requested: bool = None, status: str = None, status_details: str = + None, error=None, target: str = None, request_id: str = None, **kwargs)' + parameters: + - name: issuer_parameters + description: 'Parameters for the issuer of the X509 component + + of a certificate.' + isRequired: true + types: + - + - name: csr + description: 'The certificate signing request (CSR) that is being used in + + the certificate operation.' + isRequired: true + types: + - + - name: cancellation_requested + description: 'Indicates if cancellation was requested on + + the certificate operation.' + isRequired: true + types: + - + - name: status + description: Status of the certificate operation. + isRequired: true + types: + - + - name: status_details + description: The status details of the certificate operation. + isRequired: true + types: + - + - name: error + description: Error encountered, if any, during the certificate operation. + isRequired: true + types: + - + - name: target + description: 'Location which contains the result of the certificate + + operation.' + isRequired: true + types: + - + - name: request_id + description: Identifier for the certificate operation. + isRequired: true + types: + - + keywordOnlyParameters: + - name: issuer_parameters + isRequired: true + - name: csr + isRequired: true + - name: cancellation_requested + isRequired: true + - name: status + isRequired: true + - name: status_details + isRequired: true + - name: error + isRequired: true + - name: target + isRequired: true + - name: request_id + isRequired: true +variables: +- description: The certificate id. + name: id + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_operation_py3.CertificateOperation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_operation_py3.CertificateOperation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_operation_py3.CertificateOperation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_operation_py3.CertificateOperation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_operation_py3.CertificateOperation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_operation_py3.CertificateOperation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_operation_py3.CertificateOperation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_py3.yml new file mode 100644 index 00000000..59b257c7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_operation_py3 +name: certificate_operation_py3 +fullName: azure.keyvault.v2016_10_01.models.certificate_operation_py3 +classes: +- azure.keyvault.v2016_10_01.models.certificate_operation_py3.CertificateOperation diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter.yml new file mode 100644 index 00000000..48d6b125 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter +name: CertificateOperationUpdateParameter +fullName: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter +module: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter +summary: 'The certificate operation update parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CertificateOperationUpdateParameter(**kwargs) + parameters: + - name: cancellation_requested + description: 'Required. Indicates if cancellation was + + requested on the certificate operation.' + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter.yml new file mode 100644 index 00000000..d8d68704 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter +name: certificate_operation_update_parameter +fullName: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter +classes: +- azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter.yml new file mode 100644 index 00000000..901ed3f4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter +name: CertificateOperationUpdateParameter +fullName: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter +module: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3 +summary: 'The certificate operation update parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CertificateOperationUpdateParameter(*, cancellation_requested: bool, **kwargs)' + parameters: + - name: cancellation_requested + description: 'Required. Indicates if cancellation was + + requested on the certificate operation.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cancellation_requested + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3.yml new file mode 100644 index 00000000..0e52c9e7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3 +name: certificate_operation_update_parameter_py3 +fullName: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3 +classes: +- azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_policy.CertificatePolicy.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_policy.CertificatePolicy.yml new file mode 100644 index 00000000..bba32468 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_policy.CertificatePolicy.yml @@ -0,0 +1,161 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_policy.CertificatePolicy +name: CertificatePolicy +fullName: azure.keyvault.v2016_10_01.models.certificate_policy.CertificatePolicy +module: azure.keyvault.v2016_10_01.models.certificate_policy +summary: 'Management policy for a certificate. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: CertificatePolicy(**kwargs) + parameters: + - name: key_properties + description: Properties of the key backing a certificate. + isRequired: true + types: + - + - name: secret_properties + description: Properties of the secret backing a certificate. + isRequired: true + types: + - + - name: x509_certificate_properties + description: 'Properties of the X509 component of a + + certificate.' + isRequired: true + types: + - + - name: lifetime_actions + description: 'Actions that will be performed by Key Vault over + + the lifetime of a certificate.' + isRequired: true + types: + - [] + - name: issuer_parameters + description: 'Parameters for the issuer of the X509 component + + of a certificate.' + isRequired: true + types: + - + - name: attributes + description: The certificate attributes. + isRequired: true + types: + - +variables: +- description: The certificate id. + name: id + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_policy.CertificatePolicy.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_policy.CertificatePolicy.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_policy.CertificatePolicy.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_policy.CertificatePolicy.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_policy.CertificatePolicy.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_policy.CertificatePolicy.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_policy.CertificatePolicy.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_policy.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_policy.yml new file mode 100644 index 00000000..10f32123 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_policy.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_policy +name: certificate_policy +fullName: azure.keyvault.v2016_10_01.models.certificate_policy +classes: +- azure.keyvault.v2016_10_01.models.certificate_policy.CertificatePolicy diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_policy_py3.CertificatePolicy.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_policy_py3.CertificatePolicy.yml new file mode 100644 index 00000000..980e222f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_policy_py3.CertificatePolicy.yml @@ -0,0 +1,175 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_policy_py3.CertificatePolicy +name: CertificatePolicy +fullName: azure.keyvault.v2016_10_01.models.certificate_policy_py3.CertificatePolicy +module: azure.keyvault.v2016_10_01.models.certificate_policy_py3 +summary: 'Management policy for a certificate. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: CertificatePolicy(*, key_properties=None, secret_properties=None, x509_certificate_properties=None, + lifetime_actions=None, issuer_parameters=None, attributes=None, **kwargs) + parameters: + - name: key_properties + description: Properties of the key backing a certificate. + isRequired: true + types: + - + - name: secret_properties + description: Properties of the secret backing a certificate. + isRequired: true + types: + - + - name: x509_certificate_properties + description: 'Properties of the X509 component of a + + certificate.' + isRequired: true + types: + - + - name: lifetime_actions + description: 'Actions that will be performed by Key Vault over + + the lifetime of a certificate.' + isRequired: true + types: + - [] + - name: issuer_parameters + description: 'Parameters for the issuer of the X509 component + + of a certificate.' + isRequired: true + types: + - + - name: attributes + description: The certificate attributes. + isRequired: true + types: + - + keywordOnlyParameters: + - name: key_properties + isRequired: true + - name: secret_properties + isRequired: true + - name: x509_certificate_properties + isRequired: true + - name: lifetime_actions + isRequired: true + - name: issuer_parameters + isRequired: true + - name: attributes + isRequired: true +variables: +- description: The certificate id. + name: id + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_policy_py3.CertificatePolicy.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_policy_py3.CertificatePolicy.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_policy_py3.CertificatePolicy.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_policy_py3.CertificatePolicy.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_policy_py3.CertificatePolicy.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_policy_py3.CertificatePolicy.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_policy_py3.CertificatePolicy.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_policy_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_policy_py3.yml new file mode 100644 index 00000000..656dfcbd --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_policy_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_policy_py3 +name: certificate_policy_py3 +fullName: azure.keyvault.v2016_10_01.models.certificate_policy_py3 +classes: +- azure.keyvault.v2016_10_01.models.certificate_policy_py3.CertificatePolicy diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_update_parameters.CertificateUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_update_parameters.CertificateUpdateParameters.yml new file mode 100644 index 00000000..7a7a0ac8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_update_parameters.CertificateUpdateParameters.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_update_parameters.CertificateUpdateParameters +name: CertificateUpdateParameters +fullName: azure.keyvault.v2016_10_01.models.certificate_update_parameters.CertificateUpdateParameters +module: azure.keyvault.v2016_10_01.models.certificate_update_parameters +summary: The certificate update parameters. +constructor: + syntax: CertificateUpdateParameters(**kwargs) + parameters: + - name: certificate_policy + description: The management policy for the certificate. + isRequired: true + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_update_parameters.CertificateUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_update_parameters.CertificateUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_update_parameters.CertificateUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_update_parameters.CertificateUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_update_parameters.CertificateUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_update_parameters.CertificateUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_update_parameters.CertificateUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_update_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_update_parameters.yml new file mode 100644 index 00000000..4f9c5628 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_update_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_update_parameters +name: certificate_update_parameters +fullName: azure.keyvault.v2016_10_01.models.certificate_update_parameters +classes: +- azure.keyvault.v2016_10_01.models.certificate_update_parameters.CertificateUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.CertificateUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.CertificateUpdateParameters.yml new file mode 100644 index 00000000..0f765989 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.CertificateUpdateParameters.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.CertificateUpdateParameters +name: CertificateUpdateParameters +fullName: azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.CertificateUpdateParameters +module: azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3 +summary: The certificate update parameters. +constructor: + syntax: CertificateUpdateParameters(*, certificate_policy=None, certificate_attributes=None, + tags=None, **kwargs) + parameters: + - name: certificate_policy + description: The management policy for the certificate. + isRequired: true + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: certificate_policy + isRequired: true + - name: certificate_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.CertificateUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.CertificateUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.CertificateUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.CertificateUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.CertificateUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.CertificateUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.CertificateUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.yml new file mode 100644 index 00000000..1a95f12f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3 +name: certificate_update_parameters_py3 +fullName: azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3 +classes: +- azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.CertificateUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contact.Contact.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contact.Contact.yml new file mode 100644 index 00000000..996ed852 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contact.Contact.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.contact.Contact +name: Contact +fullName: azure.keyvault.v2016_10_01.models.contact.Contact +module: azure.keyvault.v2016_10_01.models.contact +summary: The contact information for the vault certificates. +constructor: + syntax: Contact(**kwargs) + parameters: + - name: email_address + description: Email addresss. + isRequired: true + types: + - + - name: name + description: Name. + isRequired: true + types: + - + - name: phone + description: Phone number. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.contact.Contact.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.contact.Contact.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.contact.Contact.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.contact.Contact.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.contact.Contact.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.contact.Contact.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.contact.Contact.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contact.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contact.yml new file mode 100644 index 00000000..a8b9e06a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contact.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.contact +name: contact +fullName: azure.keyvault.v2016_10_01.models.contact +classes: +- azure.keyvault.v2016_10_01.models.contact.Contact diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contact_py3.Contact.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contact_py3.Contact.yml new file mode 100644 index 00000000..ec40e02d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contact_py3.Contact.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.contact_py3.Contact +name: Contact +fullName: azure.keyvault.v2016_10_01.models.contact_py3.Contact +module: azure.keyvault.v2016_10_01.models.contact_py3 +summary: The contact information for the vault certificates. +constructor: + syntax: 'Contact(*, email_address: str = None, name: str = None, phone: str = None, + **kwargs)' + parameters: + - name: email_address + description: Email addresss. + isRequired: true + types: + - + - name: name + description: Name. + isRequired: true + types: + - + - name: phone + description: Phone number. + isRequired: true + types: + - + keywordOnlyParameters: + - name: email_address + isRequired: true + - name: name + isRequired: true + - name: phone + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.contact_py3.Contact.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.contact_py3.Contact.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.contact_py3.Contact.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.contact_py3.Contact.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.contact_py3.Contact.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.contact_py3.Contact.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.contact_py3.Contact.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contact_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contact_py3.yml new file mode 100644 index 00000000..1a45f43a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contact_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.contact_py3 +name: contact_py3 +fullName: azure.keyvault.v2016_10_01.models.contact_py3 +classes: +- azure.keyvault.v2016_10_01.models.contact_py3.Contact diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contacts.Contacts.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contacts.Contacts.yml new file mode 100644 index 00000000..762c366a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contacts.Contacts.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.contacts.Contacts +name: Contacts +fullName: azure.keyvault.v2016_10_01.models.contacts.Contacts +module: azure.keyvault.v2016_10_01.models.contacts +summary: 'The contacts for the vault certificates. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Contacts(**kwargs) + parameters: + - name: contact_list + description: The contact list for the vault certificates. + isRequired: true + types: + - [] +variables: +- description: Identifier for the contacts collection. + name: id + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.contacts.Contacts.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.contacts.Contacts.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.contacts.Contacts.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.contacts.Contacts.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.contacts.Contacts.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.contacts.Contacts.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.contacts.Contacts.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contacts.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contacts.yml new file mode 100644 index 00000000..1144f788 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contacts.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.contacts +name: contacts +fullName: azure.keyvault.v2016_10_01.models.contacts +classes: +- azure.keyvault.v2016_10_01.models.contacts.Contacts diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contacts_py3.Contacts.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contacts_py3.Contacts.yml new file mode 100644 index 00000000..17ff13d0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contacts_py3.Contacts.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.contacts_py3.Contacts +name: Contacts +fullName: azure.keyvault.v2016_10_01.models.contacts_py3.Contacts +module: azure.keyvault.v2016_10_01.models.contacts_py3 +summary: 'The contacts for the vault certificates. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Contacts(*, contact_list=None, **kwargs) + parameters: + - name: contact_list + description: The contact list for the vault certificates. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: contact_list + isRequired: true +variables: +- description: Identifier for the contacts collection. + name: id + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.contacts_py3.Contacts.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.contacts_py3.Contacts.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.contacts_py3.Contacts.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.contacts_py3.Contacts.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.contacts_py3.Contacts.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.contacts_py3.Contacts.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.contacts_py3.Contacts.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contacts_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contacts_py3.yml new file mode 100644 index 00000000..54b0310b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contacts_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.contacts_py3 +name: contacts_py3 +fullName: azure.keyvault.v2016_10_01.models.contacts_py3 +classes: +- azure.keyvault.v2016_10_01.models.contacts_py3.Contacts diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_bundle.DeletedCertificateBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_bundle.DeletedCertificateBundle.yml new file mode 100644 index 00000000..48ea8324 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_bundle.DeletedCertificateBundle.yml @@ -0,0 +1,180 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle.DeletedCertificateBundle +name: DeletedCertificateBundle +fullName: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle.DeletedCertificateBundle +module: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle +summary: 'A Deleted Certificate consisting of its previous id, attributes and its + + tags, as well as information on when it will be purged. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: DeletedCertificateBundle(**kwargs) + parameters: + - name: cer + description: CER contents of x509 certificate. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The certificate attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted certificate.' + isRequired: true + types: + - +variables: +- description: The certificate id. + name: id + types: + - +- description: The key id. + name: kid + types: + - +- description: The secret id. + name: sid + types: + - +- description: Thumbprint of the certificate. + name: x509_thumbprint + types: + - +- description: The management policy. + name: policy + types: + - +- description: 'The time when the certificate is scheduled to + + be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the certificate was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle.DeletedCertificateBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle.DeletedCertificateBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle.DeletedCertificateBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle.DeletedCertificateBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle.DeletedCertificateBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle.DeletedCertificateBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle.DeletedCertificateBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_bundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_bundle.yml new file mode 100644 index 00000000..fbedd4cf --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_bundle.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle +name: deleted_certificate_bundle +fullName: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle +classes: +- azure.keyvault.v2016_10_01.models.deleted_certificate_bundle.DeletedCertificateBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.yml new file mode 100644 index 00000000..01835338 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.yml @@ -0,0 +1,192 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3.DeletedCertificateBundle +name: DeletedCertificateBundle +fullName: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3.DeletedCertificateBundle +module: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3 +summary: 'A Deleted Certificate consisting of its previous id, attributes and its + + tags, as well as information on when it will be purged. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedCertificateBundle(*, cer: bytearray = None, content_type: str = + None, attributes=None, tags=None, recovery_id: str = None, **kwargs)' + parameters: + - name: cer + description: CER contents of x509 certificate. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The certificate attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted certificate.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cer + isRequired: true + - name: content_type + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: The certificate id. + name: id + types: + - +- description: The key id. + name: kid + types: + - +- description: The secret id. + name: sid + types: + - +- description: Thumbprint of the certificate. + name: x509_thumbprint + types: + - +- description: The management policy. + name: policy + types: + - +- description: 'The time when the certificate is scheduled to + + be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the certificate was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3.yml new file mode 100644 index 00000000..2a4824cd --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3 +name: deleted_certificate_bundle_py3 +fullName: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3 +classes: +- azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3.DeletedCertificateBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item.DeletedCertificateItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item.DeletedCertificateItem.yml new file mode 100644 index 00000000..078412df --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item.DeletedCertificateItem.yml @@ -0,0 +1,160 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item.DeletedCertificateItem +name: DeletedCertificateItem +fullName: azure.keyvault.v2016_10_01.models.deleted_certificate_item.DeletedCertificateItem +module: azure.keyvault.v2016_10_01.models.deleted_certificate_item +summary: 'The deleted certificate item containing metadata about the deleted + + certificate. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: DeletedCertificateItem(**kwargs) + parameters: + - name: id + description: Certificate identifier. + isRequired: true + types: + - + - name: attributes + description: The certificate management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: x509_thumbprint + description: Thumbprint of the certificate. + isRequired: true + types: + - + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted certificate.' + isRequired: true + types: + - +variables: +- description: 'The time when the certificate is scheduled to + + be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the certificate was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item.DeletedCertificateItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item.DeletedCertificateItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item.DeletedCertificateItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item.DeletedCertificateItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item.DeletedCertificateItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item.DeletedCertificateItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item.DeletedCertificateItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item.yml new file mode 100644 index 00000000..5a4990a8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item +name: deleted_certificate_item +fullName: azure.keyvault.v2016_10_01.models.deleted_certificate_item +classes: +- azure.keyvault.v2016_10_01.models.deleted_certificate_item.DeletedCertificateItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged.DeletedCertificateItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged.DeletedCertificateItemPaged.yml new file mode 100644 index 00000000..e52e3e87 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged.DeletedCertificateItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged.DeletedCertificateItemPaged +name: DeletedCertificateItemPaged +fullName: azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged.DeletedCertificateItemPaged +module: azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: DeletedCertificateItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged.DeletedCertificateItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged.DeletedCertificateItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged.DeletedCertificateItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged.DeletedCertificateItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged.DeletedCertificateItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged.DeletedCertificateItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged.DeletedCertificateItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged.yml new file mode 100644 index 00000000..f19f57b5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged +name: deleted_certificate_item_paged +fullName: azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged +classes: +- azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged.DeletedCertificateItemPaged diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3.DeletedCertificateItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3.DeletedCertificateItem.yml new file mode 100644 index 00000000..2978191f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3.DeletedCertificateItem.yml @@ -0,0 +1,172 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3.DeletedCertificateItem +name: DeletedCertificateItem +fullName: azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3.DeletedCertificateItem +module: azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3 +summary: 'The deleted certificate item containing metadata about the deleted + + certificate. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedCertificateItem(*, id: str = None, attributes=None, tags=None, x509_thumbprint: + bytes = None, recovery_id: str = None, **kwargs)' + parameters: + - name: id + description: Certificate identifier. + isRequired: true + types: + - + - name: attributes + description: The certificate management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: x509_thumbprint + description: Thumbprint of the certificate. + isRequired: true + types: + - + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted certificate.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: x509_thumbprint + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: 'The time when the certificate is scheduled to + + be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the certificate was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3.DeletedCertificateItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3.DeletedCertificateItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3.DeletedCertificateItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3.DeletedCertificateItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3.DeletedCertificateItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3.DeletedCertificateItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3.DeletedCertificateItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3.yml new file mode 100644 index 00000000..141e1bcf --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3 +name: deleted_certificate_item_py3 +fullName: azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3 +classes: +- azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3.DeletedCertificateItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_bundle.DeletedKeyBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_bundle.DeletedKeyBundle.yml new file mode 100644 index 00000000..8d312e9d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_bundle.DeletedKeyBundle.yml @@ -0,0 +1,161 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.deleted_key_bundle.DeletedKeyBundle +name: DeletedKeyBundle +fullName: azure.keyvault.v2016_10_01.models.deleted_key_bundle.DeletedKeyBundle +module: azure.keyvault.v2016_10_01.models.deleted_key_bundle +summary: 'A DeletedKeyBundle consisting of a WebKey plus its Attributes and deletion + + info. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: DeletedKeyBundle(**kwargs) + parameters: + - name: key + description: The Json web key. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted key.' + isRequired: true + types: + - +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the key is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the key was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.deleted_key_bundle.DeletedKeyBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_key_bundle.DeletedKeyBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_key_bundle.DeletedKeyBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.deleted_key_bundle.DeletedKeyBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_key_bundle.DeletedKeyBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.deleted_key_bundle.DeletedKeyBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_key_bundle.DeletedKeyBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_bundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_bundle.yml new file mode 100644 index 00000000..e3a827cd --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_bundle.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.deleted_key_bundle +name: deleted_key_bundle +fullName: azure.keyvault.v2016_10_01.models.deleted_key_bundle +classes: +- azure.keyvault.v2016_10_01.models.deleted_key_bundle.DeletedKeyBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3.DeletedKeyBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3.DeletedKeyBundle.yml new file mode 100644 index 00000000..6057b874 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3.DeletedKeyBundle.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3.DeletedKeyBundle +name: DeletedKeyBundle +fullName: azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3.DeletedKeyBundle +module: azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3 +summary: 'A DeletedKeyBundle consisting of a WebKey plus its Attributes and deletion + + info. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedKeyBundle(*, key=None, attributes=None, tags=None, recovery_id: + str = None, **kwargs)' + parameters: + - name: key + description: The Json web key. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted key.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: key + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the key is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the key was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3.DeletedKeyBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3.DeletedKeyBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3.DeletedKeyBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3.DeletedKeyBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3.DeletedKeyBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3.DeletedKeyBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3.DeletedKeyBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3.yml new file mode 100644 index 00000000..9741ebe0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3 +name: deleted_key_bundle_py3 +fullName: azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3 +classes: +- azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3.DeletedKeyBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item.DeletedKeyItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item.DeletedKeyItem.yml new file mode 100644 index 00000000..04545ce0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item.DeletedKeyItem.yml @@ -0,0 +1,161 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.deleted_key_item.DeletedKeyItem +name: DeletedKeyItem +fullName: azure.keyvault.v2016_10_01.models.deleted_key_item.DeletedKeyItem +module: azure.keyvault.v2016_10_01.models.deleted_key_item +summary: 'The deleted key item containing the deleted key metadata and information + + about deletion. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: DeletedKeyItem(**kwargs) + parameters: + - name: kid + description: Key identifier. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted key.' + isRequired: true + types: + - +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the key is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the key was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.deleted_key_item.DeletedKeyItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_key_item.DeletedKeyItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_key_item.DeletedKeyItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.deleted_key_item.DeletedKeyItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_key_item.DeletedKeyItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.deleted_key_item.DeletedKeyItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_key_item.DeletedKeyItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item.yml new file mode 100644 index 00000000..4fa07503 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.deleted_key_item +name: deleted_key_item +fullName: azure.keyvault.v2016_10_01.models.deleted_key_item +classes: +- azure.keyvault.v2016_10_01.models.deleted_key_item.DeletedKeyItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item_paged.DeletedKeyItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item_paged.DeletedKeyItemPaged.yml new file mode 100644 index 00000000..dc109bef --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item_paged.DeletedKeyItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.deleted_key_item_paged.DeletedKeyItemPaged +name: DeletedKeyItemPaged +fullName: azure.keyvault.v2016_10_01.models.deleted_key_item_paged.DeletedKeyItemPaged +module: azure.keyvault.v2016_10_01.models.deleted_key_item_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: DeletedKeyItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v2016_10_01.models.deleted_key_item_paged.DeletedKeyItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v2016_10_01.models.deleted_key_item_paged.DeletedKeyItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v2016_10_01.models.deleted_key_item_paged.DeletedKeyItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_key_item_paged.DeletedKeyItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_key_item_paged.DeletedKeyItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v2016_10_01.models.deleted_key_item_paged.DeletedKeyItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v2016_10_01.models.deleted_key_item_paged.DeletedKeyItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item_paged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item_paged.yml new file mode 100644 index 00000000..ecb784f3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.deleted_key_item_paged +name: deleted_key_item_paged +fullName: azure.keyvault.v2016_10_01.models.deleted_key_item_paged +classes: +- azure.keyvault.v2016_10_01.models.deleted_key_item_paged.DeletedKeyItemPaged diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item_py3.DeletedKeyItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item_py3.DeletedKeyItem.yml new file mode 100644 index 00000000..6b6a615c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item_py3.DeletedKeyItem.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.deleted_key_item_py3.DeletedKeyItem +name: DeletedKeyItem +fullName: azure.keyvault.v2016_10_01.models.deleted_key_item_py3.DeletedKeyItem +module: azure.keyvault.v2016_10_01.models.deleted_key_item_py3 +summary: 'The deleted key item containing the deleted key metadata and information + + about deletion. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedKeyItem(*, kid: str = None, attributes=None, tags=None, recovery_id: + str = None, **kwargs)' + parameters: + - name: kid + description: Key identifier. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted key.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: kid + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the key is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the key was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.deleted_key_item_py3.DeletedKeyItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_key_item_py3.DeletedKeyItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_key_item_py3.DeletedKeyItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.deleted_key_item_py3.DeletedKeyItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_key_item_py3.DeletedKeyItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.deleted_key_item_py3.DeletedKeyItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_key_item_py3.DeletedKeyItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item_py3.yml new file mode 100644 index 00000000..534deeb3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.deleted_key_item_py3 +name: deleted_key_item_py3 +fullName: azure.keyvault.v2016_10_01.models.deleted_key_item_py3 +classes: +- azure.keyvault.v2016_10_01.models.deleted_key_item_py3.DeletedKeyItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_bundle.DeletedSecretBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_bundle.DeletedSecretBundle.yml new file mode 100644 index 00000000..f06e4d8c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_bundle.DeletedSecretBundle.yml @@ -0,0 +1,178 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.deleted_secret_bundle.DeletedSecretBundle +name: DeletedSecretBundle +fullName: azure.keyvault.v2016_10_01.models.deleted_secret_bundle.DeletedSecretBundle +module: azure.keyvault.v2016_10_01.models.deleted_secret_bundle +summary: 'A Deleted Secret consisting of its previous id, attributes and its tags, + as + + well as information on when it will be purged. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: DeletedSecretBundle(**kwargs) + parameters: + - name: value + description: The secret value. + isRequired: true + types: + - + - name: id + description: The secret id. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted secret.' + isRequired: true + types: + - +variables: +- description: 'If this is a secret backing a KV certificate, then this field + + specifies the corresponding key backing the KV certificate.' + name: kid + types: + - +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a secret backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the secret is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the secret was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_bundle.DeletedSecretBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_bundle.DeletedSecretBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_bundle.DeletedSecretBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_bundle.DeletedSecretBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_bundle.DeletedSecretBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_bundle.DeletedSecretBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_bundle.DeletedSecretBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_bundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_bundle.yml new file mode 100644 index 00000000..dd0c3bd6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_bundle.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.deleted_secret_bundle +name: deleted_secret_bundle +fullName: azure.keyvault.v2016_10_01.models.deleted_secret_bundle +classes: +- azure.keyvault.v2016_10_01.models.deleted_secret_bundle.DeletedSecretBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3.DeletedSecretBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3.DeletedSecretBundle.yml new file mode 100644 index 00000000..9522c6e5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3.DeletedSecretBundle.yml @@ -0,0 +1,192 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3.DeletedSecretBundle +name: DeletedSecretBundle +fullName: azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3.DeletedSecretBundle +module: azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3 +summary: 'A Deleted Secret consisting of its previous id, attributes and its tags, + as + + well as information on when it will be purged. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedSecretBundle(*, value: str = None, id: str = None, content_type: + str = None, attributes=None, tags=None, recovery_id: str = None, **kwargs)' + parameters: + - name: value + description: The secret value. + isRequired: true + types: + - + - name: id + description: The secret id. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted secret.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: id + isRequired: true + - name: content_type + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: 'If this is a secret backing a KV certificate, then this field + + specifies the corresponding key backing the KV certificate.' + name: kid + types: + - +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a secret backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the secret is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the secret was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3.DeletedSecretBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3.DeletedSecretBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3.DeletedSecretBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3.DeletedSecretBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3.DeletedSecretBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3.DeletedSecretBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3.DeletedSecretBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3.yml new file mode 100644 index 00000000..a51d1556 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3 +name: deleted_secret_bundle_py3 +fullName: azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3 +classes: +- azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3.DeletedSecretBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item.DeletedSecretItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item.DeletedSecretItem.yml new file mode 100644 index 00000000..ed216c44 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item.DeletedSecretItem.yml @@ -0,0 +1,164 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.deleted_secret_item.DeletedSecretItem +name: DeletedSecretItem +fullName: azure.keyvault.v2016_10_01.models.deleted_secret_item.DeletedSecretItem +module: azure.keyvault.v2016_10_01.models.deleted_secret_item +summary: 'The deleted secret item containing metadata about the deleted secret. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: DeletedSecretItem(**kwargs) + parameters: + - name: id + description: Secret identifier. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted secret.' + isRequired: true + types: + - +variables: +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a key backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the secret is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the secret was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_item.DeletedSecretItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_item.DeletedSecretItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_item.DeletedSecretItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_item.DeletedSecretItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_item.DeletedSecretItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_item.DeletedSecretItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_item.DeletedSecretItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item.yml new file mode 100644 index 00000000..69372ca4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.deleted_secret_item +name: deleted_secret_item +fullName: azure.keyvault.v2016_10_01.models.deleted_secret_item +classes: +- azure.keyvault.v2016_10_01.models.deleted_secret_item.DeletedSecretItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item_paged.DeletedSecretItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item_paged.DeletedSecretItemPaged.yml new file mode 100644 index 00000000..d7d6e85c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item_paged.DeletedSecretItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.deleted_secret_item_paged.DeletedSecretItemPaged +name: DeletedSecretItemPaged +fullName: azure.keyvault.v2016_10_01.models.deleted_secret_item_paged.DeletedSecretItemPaged +module: azure.keyvault.v2016_10_01.models.deleted_secret_item_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: DeletedSecretItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_item_paged.DeletedSecretItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_item_paged.DeletedSecretItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_item_paged.DeletedSecretItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_item_paged.DeletedSecretItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_item_paged.DeletedSecretItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_item_paged.DeletedSecretItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_item_paged.DeletedSecretItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item_paged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item_paged.yml new file mode 100644 index 00000000..5f919fe7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.deleted_secret_item_paged +name: deleted_secret_item_paged +fullName: azure.keyvault.v2016_10_01.models.deleted_secret_item_paged +classes: +- azure.keyvault.v2016_10_01.models.deleted_secret_item_paged.DeletedSecretItemPaged diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item_py3.DeletedSecretItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item_py3.DeletedSecretItem.yml new file mode 100644 index 00000000..674ab0a1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item_py3.DeletedSecretItem.yml @@ -0,0 +1,176 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.deleted_secret_item_py3.DeletedSecretItem +name: DeletedSecretItem +fullName: azure.keyvault.v2016_10_01.models.deleted_secret_item_py3.DeletedSecretItem +module: azure.keyvault.v2016_10_01.models.deleted_secret_item_py3 +summary: 'The deleted secret item containing metadata about the deleted secret. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedSecretItem(*, id: str = None, attributes=None, tags=None, content_type: + str = None, recovery_id: str = None, **kwargs)' + parameters: + - name: id + description: Secret identifier. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted secret.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: content_type + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a key backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the secret is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the secret was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_item_py3.DeletedSecretItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_item_py3.DeletedSecretItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_item_py3.DeletedSecretItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_item_py3.DeletedSecretItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_item_py3.DeletedSecretItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_item_py3.DeletedSecretItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.deleted_secret_item_py3.DeletedSecretItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item_py3.yml new file mode 100644 index 00000000..29bc4f61 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.deleted_secret_item_py3 +name: deleted_secret_item_py3 +fullName: azure.keyvault.v2016_10_01.models.deleted_secret_item_py3 +classes: +- azure.keyvault.v2016_10_01.models.deleted_secret_item_py3.DeletedSecretItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.error.Error.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.error.Error.yml new file mode 100644 index 00000000..852ba0a8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.error.Error.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.error.Error +name: Error +fullName: azure.keyvault.v2016_10_01.models.error.Error +module: azure.keyvault.v2016_10_01.models.error +summary: 'The key vault server error. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Error(**kwargs) +variables: +- description: The error code. + name: code + types: + - +- description: The error message. + name: message + types: + - +- name: inner_error + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.error.Error.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.error.Error.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.error.Error.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.error.Error.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.error.Error.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.error.Error.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.error.Error.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.error.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.error.yml new file mode 100644 index 00000000..24938f2a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.error.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.error +name: error +fullName: azure.keyvault.v2016_10_01.models.error +classes: +- azure.keyvault.v2016_10_01.models.error.Error diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.error_py3.Error.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.error_py3.Error.yml new file mode 100644 index 00000000..32b39020 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.error_py3.Error.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.error_py3.Error +name: Error +fullName: azure.keyvault.v2016_10_01.models.error_py3.Error +module: azure.keyvault.v2016_10_01.models.error_py3 +summary: 'The key vault server error. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Error(**kwargs) +variables: +- description: The error code. + name: code + types: + - +- description: The error message. + name: message + types: + - +- name: inner_error + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.error_py3.Error.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.error_py3.Error.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.error_py3.Error.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.error_py3.Error.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.error_py3.Error.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.error_py3.Error.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.error_py3.Error.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.error_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.error_py3.yml new file mode 100644 index 00000000..5dd1228e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.error_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.error_py3 +name: error_py3 +fullName: azure.keyvault.v2016_10_01.models.error_py3 +classes: +- azure.keyvault.v2016_10_01.models.error_py3.Error diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_attributes.IssuerAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_attributes.IssuerAttributes.yml new file mode 100644 index 00000000..1ad9d5e7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_attributes.IssuerAttributes.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.issuer_attributes.IssuerAttributes +name: IssuerAttributes +fullName: azure.keyvault.v2016_10_01.models.issuer_attributes.IssuerAttributes +module: azure.keyvault.v2016_10_01.models.issuer_attributes +summary: 'The attributes of an issuer managed by the Key Vault service. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: IssuerAttributes(**kwargs) + parameters: + - name: enabled + description: Determines whether the issuer is enabled. + isRequired: true + types: + - +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.issuer_attributes.IssuerAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.issuer_attributes.IssuerAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.issuer_attributes.IssuerAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.issuer_attributes.IssuerAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.issuer_attributes.IssuerAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.issuer_attributes.IssuerAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.issuer_attributes.IssuerAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_attributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_attributes.yml new file mode 100644 index 00000000..b19d5fe3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_attributes.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.issuer_attributes +name: issuer_attributes +fullName: azure.keyvault.v2016_10_01.models.issuer_attributes +classes: +- azure.keyvault.v2016_10_01.models.issuer_attributes.IssuerAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_attributes_py3.IssuerAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_attributes_py3.IssuerAttributes.yml new file mode 100644 index 00000000..a74667e5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_attributes_py3.IssuerAttributes.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.issuer_attributes_py3.IssuerAttributes +name: IssuerAttributes +fullName: azure.keyvault.v2016_10_01.models.issuer_attributes_py3.IssuerAttributes +module: azure.keyvault.v2016_10_01.models.issuer_attributes_py3 +summary: 'The attributes of an issuer managed by the Key Vault service. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'IssuerAttributes(*, enabled: bool = None, **kwargs)' + parameters: + - name: enabled + description: Determines whether the issuer is enabled. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.issuer_attributes_py3.IssuerAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.issuer_attributes_py3.IssuerAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.issuer_attributes_py3.IssuerAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.issuer_attributes_py3.IssuerAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.issuer_attributes_py3.IssuerAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.issuer_attributes_py3.IssuerAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.issuer_attributes_py3.IssuerAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_attributes_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_attributes_py3.yml new file mode 100644 index 00000000..1259341f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_attributes_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.issuer_attributes_py3 +name: issuer_attributes_py3 +fullName: azure.keyvault.v2016_10_01.models.issuer_attributes_py3 +classes: +- azure.keyvault.v2016_10_01.models.issuer_attributes_py3.IssuerAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_bundle.IssuerBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_bundle.IssuerBundle.yml new file mode 100644 index 00000000..843ef42d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_bundle.IssuerBundle.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.issuer_bundle.IssuerBundle +name: IssuerBundle +fullName: azure.keyvault.v2016_10_01.models.issuer_bundle.IssuerBundle +module: azure.keyvault.v2016_10_01.models.issuer_bundle +summary: 'The issuer for Key Vault certificate. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: IssuerBundle(**kwargs) + parameters: + - name: provider + description: The issuer provider. + isRequired: true + types: + - + - name: credentials + description: The credentials to be used for the issuer. + isRequired: true + types: + - + - name: organization_details + description: 'Details of the organization as provided to + + the issuer.' + isRequired: true + types: + - + - name: attributes + description: Attributes of the issuer object. + isRequired: true + types: + - +variables: +- description: Identifier for the issuer object. + name: id + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.issuer_bundle.IssuerBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.issuer_bundle.IssuerBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.issuer_bundle.IssuerBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.issuer_bundle.IssuerBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.issuer_bundle.IssuerBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.issuer_bundle.IssuerBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.issuer_bundle.IssuerBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_bundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_bundle.yml new file mode 100644 index 00000000..ba5f3a03 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_bundle.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.issuer_bundle +name: issuer_bundle +fullName: azure.keyvault.v2016_10_01.models.issuer_bundle +classes: +- azure.keyvault.v2016_10_01.models.issuer_bundle.IssuerBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_bundle_py3.IssuerBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_bundle_py3.IssuerBundle.yml new file mode 100644 index 00000000..01ca999e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_bundle_py3.IssuerBundle.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.issuer_bundle_py3.IssuerBundle +name: IssuerBundle +fullName: azure.keyvault.v2016_10_01.models.issuer_bundle_py3.IssuerBundle +module: azure.keyvault.v2016_10_01.models.issuer_bundle_py3 +summary: 'The issuer for Key Vault certificate. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'IssuerBundle(*, provider: str = None, credentials=None, organization_details=None, + attributes=None, **kwargs)' + parameters: + - name: provider + description: The issuer provider. + isRequired: true + types: + - + - name: credentials + description: The credentials to be used for the issuer. + isRequired: true + types: + - + - name: organization_details + description: 'Details of the organization as provided to + + the issuer.' + isRequired: true + types: + - + - name: attributes + description: Attributes of the issuer object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: provider + isRequired: true + - name: credentials + isRequired: true + - name: organization_details + isRequired: true + - name: attributes + isRequired: true +variables: +- description: Identifier for the issuer object. + name: id + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.issuer_bundle_py3.IssuerBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.issuer_bundle_py3.IssuerBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.issuer_bundle_py3.IssuerBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.issuer_bundle_py3.IssuerBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.issuer_bundle_py3.IssuerBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.issuer_bundle_py3.IssuerBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.issuer_bundle_py3.IssuerBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_bundle_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_bundle_py3.yml new file mode 100644 index 00000000..e086a944 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_bundle_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.issuer_bundle_py3 +name: issuer_bundle_py3 +fullName: azure.keyvault.v2016_10_01.models.issuer_bundle_py3 +classes: +- azure.keyvault.v2016_10_01.models.issuer_bundle_py3.IssuerBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_credentials.IssuerCredentials.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_credentials.IssuerCredentials.yml new file mode 100644 index 00000000..2a577b97 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_credentials.IssuerCredentials.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.issuer_credentials.IssuerCredentials +name: IssuerCredentials +fullName: azure.keyvault.v2016_10_01.models.issuer_credentials.IssuerCredentials +module: azure.keyvault.v2016_10_01.models.issuer_credentials +summary: The credentials to be used for the certificate issuer. +constructor: + syntax: IssuerCredentials(**kwargs) + parameters: + - name: account_id + description: The user name/account name/account id. + isRequired: true + types: + - + - name: password + description: The password/secret/account key. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.issuer_credentials.IssuerCredentials.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.issuer_credentials.IssuerCredentials.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.issuer_credentials.IssuerCredentials.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.issuer_credentials.IssuerCredentials.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.issuer_credentials.IssuerCredentials.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.issuer_credentials.IssuerCredentials.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.issuer_credentials.IssuerCredentials.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_credentials.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_credentials.yml new file mode 100644 index 00000000..810bdecc --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_credentials.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.issuer_credentials +name: issuer_credentials +fullName: azure.keyvault.v2016_10_01.models.issuer_credentials +classes: +- azure.keyvault.v2016_10_01.models.issuer_credentials.IssuerCredentials diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_credentials_py3.IssuerCredentials.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_credentials_py3.IssuerCredentials.yml new file mode 100644 index 00000000..edd63e43 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_credentials_py3.IssuerCredentials.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.issuer_credentials_py3.IssuerCredentials +name: IssuerCredentials +fullName: azure.keyvault.v2016_10_01.models.issuer_credentials_py3.IssuerCredentials +module: azure.keyvault.v2016_10_01.models.issuer_credentials_py3 +summary: The credentials to be used for the certificate issuer. +constructor: + syntax: 'IssuerCredentials(*, account_id: str = None, password: str = None, **kwargs)' + parameters: + - name: account_id + description: The user name/account name/account id. + isRequired: true + types: + - + - name: password + description: The password/secret/account key. + isRequired: true + types: + - + keywordOnlyParameters: + - name: account_id + isRequired: true + - name: password + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.issuer_credentials_py3.IssuerCredentials.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.issuer_credentials_py3.IssuerCredentials.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.issuer_credentials_py3.IssuerCredentials.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.issuer_credentials_py3.IssuerCredentials.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.issuer_credentials_py3.IssuerCredentials.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.issuer_credentials_py3.IssuerCredentials.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.issuer_credentials_py3.IssuerCredentials.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_credentials_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_credentials_py3.yml new file mode 100644 index 00000000..9214aac0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_credentials_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.issuer_credentials_py3 +name: issuer_credentials_py3 +fullName: azure.keyvault.v2016_10_01.models.issuer_credentials_py3 +classes: +- azure.keyvault.v2016_10_01.models.issuer_credentials_py3.IssuerCredentials diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_parameters.IssuerParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_parameters.IssuerParameters.yml new file mode 100644 index 00000000..bc07c7b5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_parameters.IssuerParameters.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.issuer_parameters.IssuerParameters +name: IssuerParameters +fullName: azure.keyvault.v2016_10_01.models.issuer_parameters.IssuerParameters +module: azure.keyvault.v2016_10_01.models.issuer_parameters +summary: Parameters for the issuer of the X509 component of a certificate. +constructor: + syntax: IssuerParameters(**kwargs) + parameters: + - name: name + description: 'Name of the referenced issuer object or reserved names; for + + example, ''Self'' or ''Unknown''.' + isRequired: true + types: + - + - name: certificate_type + description: 'Type of certificate to be requested from the + + issuer provider.' + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.issuer_parameters.IssuerParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.issuer_parameters.IssuerParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.issuer_parameters.IssuerParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.issuer_parameters.IssuerParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.issuer_parameters.IssuerParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.issuer_parameters.IssuerParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.issuer_parameters.IssuerParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_parameters.yml new file mode 100644 index 00000000..fc609ecd --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.issuer_parameters +name: issuer_parameters +fullName: azure.keyvault.v2016_10_01.models.issuer_parameters +classes: +- azure.keyvault.v2016_10_01.models.issuer_parameters.IssuerParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_parameters_py3.IssuerParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_parameters_py3.IssuerParameters.yml new file mode 100644 index 00000000..a6202bb2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_parameters_py3.IssuerParameters.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.issuer_parameters_py3.IssuerParameters +name: IssuerParameters +fullName: azure.keyvault.v2016_10_01.models.issuer_parameters_py3.IssuerParameters +module: azure.keyvault.v2016_10_01.models.issuer_parameters_py3 +summary: Parameters for the issuer of the X509 component of a certificate. +constructor: + syntax: 'IssuerParameters(*, name: str = None, certificate_type: str = None, **kwargs)' + parameters: + - name: name + description: 'Name of the referenced issuer object or reserved names; for + + example, ''Self'' or ''Unknown''.' + isRequired: true + types: + - + - name: certificate_type + description: 'Type of certificate to be requested from the + + issuer provider.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: certificate_type + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.issuer_parameters_py3.IssuerParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.issuer_parameters_py3.IssuerParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.issuer_parameters_py3.IssuerParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.issuer_parameters_py3.IssuerParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.issuer_parameters_py3.IssuerParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.issuer_parameters_py3.IssuerParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.issuer_parameters_py3.IssuerParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_parameters_py3.yml new file mode 100644 index 00000000..b07b01bc --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.issuer_parameters_py3 +name: issuer_parameters_py3 +fullName: azure.keyvault.v2016_10_01.models.issuer_parameters_py3 +classes: +- azure.keyvault.v2016_10_01.models.issuer_parameters_py3.IssuerParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.json_web_key.JsonWebKey.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.json_web_key.JsonWebKey.yml new file mode 100644 index 00000000..322a4e48 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.json_web_key.JsonWebKey.yml @@ -0,0 +1,202 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.json_web_key.JsonWebKey +name: JsonWebKey +fullName: azure.keyvault.v2016_10_01.models.json_web_key.JsonWebKey +module: azure.keyvault.v2016_10_01.models.json_web_key +summary: As of [http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18](http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18). +constructor: + syntax: JsonWebKey(**kwargs) + parameters: + - name: kid + description: Key identifier. + isRequired: true + types: + - + - name: kty + description: 'JsonWebKey key type (kty). Possible values include: ''EC'', + + ''EC-HSM'', ''RSA'', ''RSA-HSM'', ''oct''' + isRequired: true + types: + - + - + - name: key_ops + isRequired: true + types: + - [] + - name: n + description: RSA modulus. + isRequired: true + types: + - + - name: e + description: RSA public exponent. + isRequired: true + types: + - + - name: d + description: RSA private exponent, or the D component of an EC private key. + isRequired: true + types: + - + - name: dp + description: RSA private key parameter. + isRequired: true + types: + - + - name: dq + description: RSA private key parameter. + isRequired: true + types: + - + - name: qi + description: RSA private key parameter. + isRequired: true + types: + - + - name: p + description: RSA secret prime. + isRequired: true + types: + - + - name: q + description: RSA secret prime, with p < q. + isRequired: true + types: + - + - name: k + description: Symmetric key. + isRequired: true + types: + - + - name: t + description: HSM Token, used with 'Bring Your Own Key'. + isRequired: true + types: + - + - name: crv + description: 'Elliptic curve name. For valid values, see + + JsonWebKeyCurveName. Possible values include: ''P-256'', ''P-384'', ''P-521'', + + ''SECP256K1''' + isRequired: true + types: + - + - + - name: x + description: X component of an EC public key. + isRequired: true + types: + - + - name: y + description: Y component of an EC public key. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.json_web_key.JsonWebKey.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.json_web_key.JsonWebKey.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.json_web_key.JsonWebKey.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.json_web_key.JsonWebKey.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.json_web_key.JsonWebKey.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.json_web_key.JsonWebKey.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.json_web_key.JsonWebKey.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.json_web_key.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.json_web_key.yml new file mode 100644 index 00000000..5295a80f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.json_web_key.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.json_web_key +name: json_web_key +fullName: azure.keyvault.v2016_10_01.models.json_web_key +classes: +- azure.keyvault.v2016_10_01.models.json_web_key.JsonWebKey diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.json_web_key_py3.JsonWebKey.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.json_web_key_py3.JsonWebKey.yml new file mode 100644 index 00000000..d89bcfa4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.json_web_key_py3.JsonWebKey.yml @@ -0,0 +1,238 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.json_web_key_py3.JsonWebKey +name: JsonWebKey +fullName: azure.keyvault.v2016_10_01.models.json_web_key_py3.JsonWebKey +module: azure.keyvault.v2016_10_01.models.json_web_key_py3 +summary: As of [http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18](http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18). +constructor: + syntax: 'JsonWebKey(*, kid: str = None, kty=None, key_ops=None, n: bytes = None, + e: bytes = None, d: bytes = None, dp: bytes = None, dq: bytes = None, qi: bytes + = None, p: bytes = None, q: bytes = None, k: bytes = None, t: bytes = None, crv=None, + x: bytes = None, y: bytes = None, **kwargs)' + parameters: + - name: kid + description: Key identifier. + isRequired: true + types: + - + - name: kty + description: 'JsonWebKey key type (kty). Possible values include: ''EC'', + + ''EC-HSM'', ''RSA'', ''RSA-HSM'', ''oct''' + isRequired: true + types: + - + - + - name: key_ops + isRequired: true + types: + - [] + - name: n + description: RSA modulus. + isRequired: true + types: + - + - name: e + description: RSA public exponent. + isRequired: true + types: + - + - name: d + description: RSA private exponent, or the D component of an EC private key. + isRequired: true + types: + - + - name: dp + description: RSA private key parameter. + isRequired: true + types: + - + - name: dq + description: RSA private key parameter. + isRequired: true + types: + - + - name: qi + description: RSA private key parameter. + isRequired: true + types: + - + - name: p + description: RSA secret prime. + isRequired: true + types: + - + - name: q + description: RSA secret prime, with p < q. + isRequired: true + types: + - + - name: k + description: Symmetric key. + isRequired: true + types: + - + - name: t + description: HSM Token, used with 'Bring Your Own Key'. + isRequired: true + types: + - + - name: crv + description: 'Elliptic curve name. For valid values, see + + JsonWebKeyCurveName. Possible values include: ''P-256'', ''P-384'', ''P-521'', + + ''SECP256K1''' + isRequired: true + types: + - + - + - name: x + description: X component of an EC public key. + isRequired: true + types: + - + - name: y + description: Y component of an EC public key. + isRequired: true + types: + - + keywordOnlyParameters: + - name: kid + isRequired: true + - name: kty + isRequired: true + - name: key_ops + isRequired: true + - name: n + isRequired: true + - name: e + isRequired: true + - name: d + isRequired: true + - name: dp + isRequired: true + - name: dq + isRequired: true + - name: qi + isRequired: true + - name: p + isRequired: true + - name: q + isRequired: true + - name: k + isRequired: true + - name: t + isRequired: true + - name: crv + isRequired: true + - name: x + isRequired: true + - name: y + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.json_web_key_py3.JsonWebKey.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.json_web_key_py3.JsonWebKey.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.json_web_key_py3.JsonWebKey.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.json_web_key_py3.JsonWebKey.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.json_web_key_py3.JsonWebKey.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.json_web_key_py3.JsonWebKey.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.json_web_key_py3.JsonWebKey.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.json_web_key_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.json_web_key_py3.yml new file mode 100644 index 00000000..6af91568 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.json_web_key_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.json_web_key_py3 +name: json_web_key_py3 +fullName: azure.keyvault.v2016_10_01.models.json_web_key_py3 +classes: +- azure.keyvault.v2016_10_01.models.json_web_key_py3.JsonWebKey diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_attributes.KeyAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_attributes.KeyAttributes.yml new file mode 100644 index 00000000..0634a4a7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_attributes.KeyAttributes.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_attributes.KeyAttributes +name: KeyAttributes +fullName: azure.keyvault.v2016_10_01.models.key_attributes.KeyAttributes +module: azure.keyvault.v2016_10_01.models.key_attributes +summary: 'The attributes of a key managed by the key vault service. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyAttributes(**kwargs) + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for keys in the current vault. If it contains ''Purgeable'' the key + + can be permanently deleted by a privileged user; otherwise, only the + + system can purge the key, at the end of the retention interval. Possible + + values include: ''Purgeable'', ''Recoverable+Purgeable'', ''Recoverable'', + + ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v2016_10_01.models.key_attributes.KeyAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_attributes.KeyAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_attributes.KeyAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_attributes.KeyAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_attributes.KeyAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_attributes.KeyAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_attributes.KeyAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_attributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_attributes.yml new file mode 100644 index 00000000..3b110c4d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_attributes.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_attributes +name: key_attributes +fullName: azure.keyvault.v2016_10_01.models.key_attributes +classes: +- azure.keyvault.v2016_10_01.models.key_attributes.KeyAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_attributes_py3.KeyAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_attributes_py3.KeyAttributes.yml new file mode 100644 index 00000000..61688fa0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_attributes_py3.KeyAttributes.yml @@ -0,0 +1,166 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_attributes_py3.KeyAttributes +name: KeyAttributes +fullName: azure.keyvault.v2016_10_01.models.key_attributes_py3.KeyAttributes +module: azure.keyvault.v2016_10_01.models.key_attributes_py3 +summary: 'The attributes of a key managed by the key vault service. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'KeyAttributes(*, enabled: bool = None, not_before=None, expires=None, **kwargs)' + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true + - name: not_before + isRequired: true + - name: expires + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for keys in the current vault. If it contains ''Purgeable'' the key + + can be permanently deleted by a privileged user; otherwise, only the + + system can purge the key, at the end of the retention interval. Possible + + values include: ''Purgeable'', ''Recoverable+Purgeable'', ''Recoverable'', + + ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v2016_10_01.models.key_attributes_py3.KeyAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_attributes_py3.KeyAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_attributes_py3.KeyAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_attributes_py3.KeyAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_attributes_py3.KeyAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_attributes_py3.KeyAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_attributes_py3.KeyAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_attributes_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_attributes_py3.yml new file mode 100644 index 00000000..66530234 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_attributes_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_attributes_py3 +name: key_attributes_py3 +fullName: azure.keyvault.v2016_10_01.models.key_attributes_py3 +classes: +- azure.keyvault.v2016_10_01.models.key_attributes_py3.KeyAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_bundle.KeyBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_bundle.KeyBundle.yml new file mode 100644 index 00000000..29dfdfb4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_bundle.KeyBundle.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_bundle.KeyBundle +name: KeyBundle +fullName: azure.keyvault.v2016_10_01.models.key_bundle.KeyBundle +module: azure.keyvault.v2016_10_01.models.key_bundle +summary: 'A KeyBundle consisting of a WebKey plus its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyBundle(**kwargs) + parameters: + - name: key + description: The Json web key. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.key_bundle.KeyBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_bundle.KeyBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_bundle.KeyBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_bundle.KeyBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_bundle.KeyBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_bundle.KeyBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_bundle.KeyBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_bundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_bundle.yml new file mode 100644 index 00000000..1a4c4b13 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_bundle.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_bundle +name: key_bundle +fullName: azure.keyvault.v2016_10_01.models.key_bundle +classes: +- azure.keyvault.v2016_10_01.models.key_bundle.KeyBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_bundle_py3.KeyBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_bundle_py3.KeyBundle.yml new file mode 100644 index 00000000..2e5dc2ca --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_bundle_py3.KeyBundle.yml @@ -0,0 +1,149 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_bundle_py3.KeyBundle +name: KeyBundle +fullName: azure.keyvault.v2016_10_01.models.key_bundle_py3.KeyBundle +module: azure.keyvault.v2016_10_01.models.key_bundle_py3 +summary: 'A KeyBundle consisting of a WebKey plus its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyBundle(*, key=None, attributes=None, tags=None, **kwargs) + parameters: + - name: key + description: The Json web key. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: key + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.key_bundle_py3.KeyBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_bundle_py3.KeyBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_bundle_py3.KeyBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_bundle_py3.KeyBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_bundle_py3.KeyBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_bundle_py3.KeyBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_bundle_py3.KeyBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_bundle_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_bundle_py3.yml new file mode 100644 index 00000000..7583c99c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_bundle_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_bundle_py3 +name: key_bundle_py3 +fullName: azure.keyvault.v2016_10_01.models.key_bundle_py3 +classes: +- azure.keyvault.v2016_10_01.models.key_bundle_py3.KeyBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_create_parameters.KeyCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_create_parameters.KeyCreateParameters.yml new file mode 100644 index 00000000..f3de8877 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_create_parameters.KeyCreateParameters.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_create_parameters.KeyCreateParameters +name: KeyCreateParameters +fullName: azure.keyvault.v2016_10_01.models.key_create_parameters.KeyCreateParameters +module: azure.keyvault.v2016_10_01.models.key_create_parameters +summary: 'The key create parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: KeyCreateParameters(**kwargs) + parameters: + - name: kty + description: 'Required. The type of key to create. For valid values, see + + JsonWebKeyType. Possible values include: ''EC'', ''EC-HSM'', ''RSA'', ''RSA-HSM'', + + ''oct''' + isRequired: true + types: + - + - + - name: key_size + description: 'The key size in bits. For example: 2048, 3072, or 4096 + + for RSA.' + isRequired: true + types: + - + - name: key_ops + isRequired: true + types: + - [ + - ] + - name: key_attributes + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: curve + description: 'Elliptic curve name. For valid values, see + + JsonWebKeyCurveName. Possible values include: ''P-256'', ''P-384'', ''P-521'', + + ''SECP256K1''' + isRequired: true + types: + - + - +methods: +- uid: azure.keyvault.v2016_10_01.models.key_create_parameters.KeyCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_create_parameters.KeyCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_create_parameters.KeyCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_create_parameters.KeyCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_create_parameters.KeyCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_create_parameters.KeyCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_create_parameters.KeyCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_create_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_create_parameters.yml new file mode 100644 index 00000000..ca6003aa --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_create_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_create_parameters +name: key_create_parameters +fullName: azure.keyvault.v2016_10_01.models.key_create_parameters +classes: +- azure.keyvault.v2016_10_01.models.key_create_parameters.KeyCreateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_create_parameters_py3.KeyCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_create_parameters_py3.KeyCreateParameters.yml new file mode 100644 index 00000000..5bf546d8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_create_parameters_py3.KeyCreateParameters.yml @@ -0,0 +1,173 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_create_parameters_py3.KeyCreateParameters +name: KeyCreateParameters +fullName: azure.keyvault.v2016_10_01.models.key_create_parameters_py3.KeyCreateParameters +module: azure.keyvault.v2016_10_01.models.key_create_parameters_py3 +summary: 'The key create parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeyCreateParameters(*, kty, key_size: int = None, key_ops=None, key_attributes=None, + tags=None, curve=None, **kwargs)' + parameters: + - name: kty + description: 'Required. The type of key to create. For valid values, see + + JsonWebKeyType. Possible values include: ''EC'', ''EC-HSM'', ''RSA'', ''RSA-HSM'', + + ''oct''' + isRequired: true + types: + - + - + - name: key_size + description: 'The key size in bits. For example: 2048, 3072, or 4096 + + for RSA.' + isRequired: true + types: + - + - name: key_ops + isRequired: true + types: + - [ + - ] + - name: key_attributes + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: curve + description: 'Elliptic curve name. For valid values, see + + JsonWebKeyCurveName. Possible values include: ''P-256'', ''P-384'', ''P-521'', + + ''SECP256K1''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: kty + isRequired: true + - name: key_size + isRequired: true + - name: key_ops + isRequired: true + - name: key_attributes + isRequired: true + - name: tags + isRequired: true + - name: curve + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.key_create_parameters_py3.KeyCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_create_parameters_py3.KeyCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_create_parameters_py3.KeyCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_create_parameters_py3.KeyCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_create_parameters_py3.KeyCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_create_parameters_py3.KeyCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_create_parameters_py3.KeyCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_create_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_create_parameters_py3.yml new file mode 100644 index 00000000..ab363100 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_create_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_create_parameters_py3 +name: key_create_parameters_py3 +fullName: azure.keyvault.v2016_10_01.models.key_create_parameters_py3 +classes: +- azure.keyvault.v2016_10_01.models.key_create_parameters_py3.KeyCreateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_import_parameters.KeyImportParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_import_parameters.KeyImportParameters.yml new file mode 100644 index 00000000..a2870aed --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_import_parameters.KeyImportParameters.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_import_parameters.KeyImportParameters +name: KeyImportParameters +fullName: azure.keyvault.v2016_10_01.models.key_import_parameters.KeyImportParameters +module: azure.keyvault.v2016_10_01.models.key_import_parameters +summary: 'The key import parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: KeyImportParameters(**kwargs) + parameters: + - name: hsm + description: Whether to import as a hardware key (HSM) or software key. + isRequired: true + types: + - + - name: key + description: Required. The Json web key + isRequired: true + types: + - + - name: key_attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +methods: +- uid: azure.keyvault.v2016_10_01.models.key_import_parameters.KeyImportParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_import_parameters.KeyImportParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_import_parameters.KeyImportParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_import_parameters.KeyImportParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_import_parameters.KeyImportParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_import_parameters.KeyImportParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_import_parameters.KeyImportParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_import_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_import_parameters.yml new file mode 100644 index 00000000..1b5c76bb --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_import_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_import_parameters +name: key_import_parameters +fullName: azure.keyvault.v2016_10_01.models.key_import_parameters +classes: +- azure.keyvault.v2016_10_01.models.key_import_parameters.KeyImportParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_import_parameters_py3.KeyImportParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_import_parameters_py3.KeyImportParameters.yml new file mode 100644 index 00000000..a0a7b4f6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_import_parameters_py3.KeyImportParameters.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_import_parameters_py3.KeyImportParameters +name: KeyImportParameters +fullName: azure.keyvault.v2016_10_01.models.key_import_parameters_py3.KeyImportParameters +module: azure.keyvault.v2016_10_01.models.key_import_parameters_py3 +summary: 'The key import parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeyImportParameters(*, key, hsm: bool = None, key_attributes=None, tags=None, + **kwargs)' + parameters: + - name: hsm + description: Whether to import as a hardware key (HSM) or software key. + isRequired: true + types: + - + - name: key + description: Required. The Json web key + isRequired: true + types: + - + - name: key_attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: key + isRequired: true + - name: hsm + isRequired: true + - name: key_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.key_import_parameters_py3.KeyImportParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_import_parameters_py3.KeyImportParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_import_parameters_py3.KeyImportParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_import_parameters_py3.KeyImportParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_import_parameters_py3.KeyImportParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_import_parameters_py3.KeyImportParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_import_parameters_py3.KeyImportParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_import_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_import_parameters_py3.yml new file mode 100644 index 00000000..e378546b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_import_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_import_parameters_py3 +name: key_import_parameters_py3 +fullName: azure.keyvault.v2016_10_01.models.key_import_parameters_py3 +classes: +- azure.keyvault.v2016_10_01.models.key_import_parameters_py3.KeyImportParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item.KeyItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item.KeyItem.yml new file mode 100644 index 00000000..46f8b371 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item.KeyItem.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_item.KeyItem +name: KeyItem +fullName: azure.keyvault.v2016_10_01.models.key_item.KeyItem +module: azure.keyvault.v2016_10_01.models.key_item +summary: 'The key item containing key metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyItem(**kwargs) + parameters: + - name: kid + description: Key identifier. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.key_item.KeyItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_item.KeyItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_item.KeyItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_item.KeyItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_item.KeyItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_item.KeyItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_item.KeyItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item.yml new file mode 100644 index 00000000..f59b8b9c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_item +name: key_item +fullName: azure.keyvault.v2016_10_01.models.key_item +classes: +- azure.keyvault.v2016_10_01.models.key_item.KeyItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item_paged.KeyItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item_paged.KeyItemPaged.yml new file mode 100644 index 00000000..f97adabc --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item_paged.KeyItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_item_paged.KeyItemPaged +name: KeyItemPaged +fullName: azure.keyvault.v2016_10_01.models.key_item_paged.KeyItemPaged +module: azure.keyvault.v2016_10_01.models.key_item_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: KeyItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v2016_10_01.models.key_item_paged.KeyItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v2016_10_01.models.key_item_paged.KeyItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v2016_10_01.models.key_item_paged.KeyItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_item_paged.KeyItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_item_paged.KeyItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v2016_10_01.models.key_item_paged.KeyItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v2016_10_01.models.key_item_paged.KeyItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item_paged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item_paged.yml new file mode 100644 index 00000000..f57fddd4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_item_paged +name: key_item_paged +fullName: azure.keyvault.v2016_10_01.models.key_item_paged +classes: +- azure.keyvault.v2016_10_01.models.key_item_paged.KeyItemPaged diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item_py3.KeyItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item_py3.KeyItem.yml new file mode 100644 index 00000000..5ac30a1f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item_py3.KeyItem.yml @@ -0,0 +1,149 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_item_py3.KeyItem +name: KeyItem +fullName: azure.keyvault.v2016_10_01.models.key_item_py3.KeyItem +module: azure.keyvault.v2016_10_01.models.key_item_py3 +summary: 'The key item containing key metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'KeyItem(*, kid: str = None, attributes=None, tags=None, **kwargs)' + parameters: + - name: kid + description: Key identifier. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: kid + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.key_item_py3.KeyItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_item_py3.KeyItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_item_py3.KeyItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_item_py3.KeyItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_item_py3.KeyItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_item_py3.KeyItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_item_py3.KeyItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item_py3.yml new file mode 100644 index 00000000..d7625b3a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_item_py3 +name: key_item_py3 +fullName: azure.keyvault.v2016_10_01.models.key_item_py3 +classes: +- azure.keyvault.v2016_10_01.models.key_item_py3.KeyItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operation_result.KeyOperationResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operation_result.KeyOperationResult.yml new file mode 100644 index 00000000..4256001e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operation_result.KeyOperationResult.yml @@ -0,0 +1,127 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_operation_result.KeyOperationResult +name: KeyOperationResult +fullName: azure.keyvault.v2016_10_01.models.key_operation_result.KeyOperationResult +module: azure.keyvault.v2016_10_01.models.key_operation_result +summary: 'The key operation result. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyOperationResult(**kwargs) +variables: +- description: Key identifier + name: kid + types: + - +- name: result + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.key_operation_result.KeyOperationResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_operation_result.KeyOperationResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_operation_result.KeyOperationResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_operation_result.KeyOperationResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_operation_result.KeyOperationResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_operation_result.KeyOperationResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_operation_result.KeyOperationResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operation_result.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operation_result.yml new file mode 100644 index 00000000..81f1438c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operation_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_operation_result +name: key_operation_result +fullName: azure.keyvault.v2016_10_01.models.key_operation_result +classes: +- azure.keyvault.v2016_10_01.models.key_operation_result.KeyOperationResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operation_result_py3.KeyOperationResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operation_result_py3.KeyOperationResult.yml new file mode 100644 index 00000000..ccde850a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operation_result_py3.KeyOperationResult.yml @@ -0,0 +1,127 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_operation_result_py3.KeyOperationResult +name: KeyOperationResult +fullName: azure.keyvault.v2016_10_01.models.key_operation_result_py3.KeyOperationResult +module: azure.keyvault.v2016_10_01.models.key_operation_result_py3 +summary: 'The key operation result. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyOperationResult(**kwargs) +variables: +- description: Key identifier + name: kid + types: + - +- name: result + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.key_operation_result_py3.KeyOperationResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_operation_result_py3.KeyOperationResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_operation_result_py3.KeyOperationResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_operation_result_py3.KeyOperationResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_operation_result_py3.KeyOperationResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_operation_result_py3.KeyOperationResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_operation_result_py3.KeyOperationResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operation_result_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operation_result_py3.yml new file mode 100644 index 00000000..ec7e398c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operation_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_operation_result_py3 +name: key_operation_result_py3 +fullName: azure.keyvault.v2016_10_01.models.key_operation_result_py3 +classes: +- azure.keyvault.v2016_10_01.models.key_operation_result_py3.KeyOperationResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operations_parameters.KeyOperationsParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operations_parameters.KeyOperationsParameters.yml new file mode 100644 index 00000000..c1a0fb37 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operations_parameters.KeyOperationsParameters.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_operations_parameters.KeyOperationsParameters +name: KeyOperationsParameters +fullName: azure.keyvault.v2016_10_01.models.key_operations_parameters.KeyOperationsParameters +module: azure.keyvault.v2016_10_01.models.key_operations_parameters +summary: 'The key operations parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: KeyOperationsParameters(**kwargs) + parameters: + - name: algorithm + description: 'Required. algorithm identifier. Possible values include: + + ''RSA-OAEP'', ''RSA-OAEP-256'', ''RSA1_5''' + isRequired: true + types: + - + - + - name: value + description: Required. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.key_operations_parameters.KeyOperationsParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_operations_parameters.KeyOperationsParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_operations_parameters.KeyOperationsParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_operations_parameters.KeyOperationsParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_operations_parameters.KeyOperationsParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_operations_parameters.KeyOperationsParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_operations_parameters.KeyOperationsParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operations_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operations_parameters.yml new file mode 100644 index 00000000..8fba632e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operations_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_operations_parameters +name: key_operations_parameters +fullName: azure.keyvault.v2016_10_01.models.key_operations_parameters +classes: +- azure.keyvault.v2016_10_01.models.key_operations_parameters.KeyOperationsParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operations_parameters_py3.KeyOperationsParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operations_parameters_py3.KeyOperationsParameters.yml new file mode 100644 index 00000000..20b30a60 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operations_parameters_py3.KeyOperationsParameters.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_operations_parameters_py3.KeyOperationsParameters +name: KeyOperationsParameters +fullName: azure.keyvault.v2016_10_01.models.key_operations_parameters_py3.KeyOperationsParameters +module: azure.keyvault.v2016_10_01.models.key_operations_parameters_py3 +summary: 'The key operations parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeyOperationsParameters(*, algorithm, value: bytes, **kwargs)' + parameters: + - name: algorithm + description: 'Required. algorithm identifier. Possible values include: + + ''RSA-OAEP'', ''RSA-OAEP-256'', ''RSA1_5''' + isRequired: true + types: + - + - + - name: value + description: Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: algorithm + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.key_operations_parameters_py3.KeyOperationsParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_operations_parameters_py3.KeyOperationsParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_operations_parameters_py3.KeyOperationsParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_operations_parameters_py3.KeyOperationsParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_operations_parameters_py3.KeyOperationsParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_operations_parameters_py3.KeyOperationsParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_operations_parameters_py3.KeyOperationsParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operations_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operations_parameters_py3.yml new file mode 100644 index 00000000..9c7e78f4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_operations_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_operations_parameters_py3 +name: key_operations_parameters_py3 +fullName: azure.keyvault.v2016_10_01.models.key_operations_parameters_py3 +classes: +- azure.keyvault.v2016_10_01.models.key_operations_parameters_py3.KeyOperationsParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_properties.KeyProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_properties.KeyProperties.yml new file mode 100644 index 00000000..75ff15bd --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_properties.KeyProperties.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_properties.KeyProperties +name: KeyProperties +fullName: azure.keyvault.v2016_10_01.models.key_properties.KeyProperties +module: azure.keyvault.v2016_10_01.models.key_properties +summary: Properties of the key pair backing a certificate. +constructor: + syntax: KeyProperties(**kwargs) + parameters: + - name: exportable + description: Indicates if the private key can be exported. + isRequired: true + types: + - + - name: key_type + description: The key type. + isRequired: true + types: + - + - name: key_size + description: 'The key size in bits. For example: 2048, 3072, or 4096 + + for RSA.' + isRequired: true + types: + - + - name: reuse_key + description: 'Indicates if the same key pair will be used on + + certificate renewal.' + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.key_properties.KeyProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_properties.KeyProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_properties.KeyProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_properties.KeyProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_properties.KeyProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_properties.KeyProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_properties.KeyProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_properties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_properties.yml new file mode 100644 index 00000000..32a5f482 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_properties.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_properties +name: key_properties +fullName: azure.keyvault.v2016_10_01.models.key_properties +classes: +- azure.keyvault.v2016_10_01.models.key_properties.KeyProperties diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_properties_py3.KeyProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_properties_py3.KeyProperties.yml new file mode 100644 index 00000000..dc5df794 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_properties_py3.KeyProperties.yml @@ -0,0 +1,149 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_properties_py3.KeyProperties +name: KeyProperties +fullName: azure.keyvault.v2016_10_01.models.key_properties_py3.KeyProperties +module: azure.keyvault.v2016_10_01.models.key_properties_py3 +summary: Properties of the key pair backing a certificate. +constructor: + syntax: 'KeyProperties(*, exportable: bool = None, key_type: str = None, key_size: + int = None, reuse_key: bool = None, **kwargs)' + parameters: + - name: exportable + description: Indicates if the private key can be exported. + isRequired: true + types: + - + - name: key_type + description: The key type. + isRequired: true + types: + - + - name: key_size + description: 'The key size in bits. For example: 2048, 3072, or 4096 + + for RSA.' + isRequired: true + types: + - + - name: reuse_key + description: 'Indicates if the same key pair will be used on + + certificate renewal.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: exportable + isRequired: true + - name: key_type + isRequired: true + - name: key_size + isRequired: true + - name: reuse_key + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.key_properties_py3.KeyProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_properties_py3.KeyProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_properties_py3.KeyProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_properties_py3.KeyProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_properties_py3.KeyProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_properties_py3.KeyProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_properties_py3.KeyProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_properties_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_properties_py3.yml new file mode 100644 index 00000000..bd27c536 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_properties_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_properties_py3 +name: key_properties_py3 +fullName: azure.keyvault.v2016_10_01.models.key_properties_py3 +classes: +- azure.keyvault.v2016_10_01.models.key_properties_py3.KeyProperties diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_restore_parameters.KeyRestoreParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_restore_parameters.KeyRestoreParameters.yml new file mode 100644 index 00000000..ce7cd5a7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_restore_parameters.KeyRestoreParameters.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_restore_parameters.KeyRestoreParameters +name: KeyRestoreParameters +fullName: azure.keyvault.v2016_10_01.models.key_restore_parameters.KeyRestoreParameters +module: azure.keyvault.v2016_10_01.models.key_restore_parameters +summary: 'The key restore parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: KeyRestoreParameters(**kwargs) + parameters: + - name: key_bundle_backup + description: 'Required. The backup blob associated with a key + + bundle.' + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.key_restore_parameters.KeyRestoreParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_restore_parameters.KeyRestoreParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_restore_parameters.KeyRestoreParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_restore_parameters.KeyRestoreParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_restore_parameters.KeyRestoreParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_restore_parameters.KeyRestoreParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_restore_parameters.KeyRestoreParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_restore_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_restore_parameters.yml new file mode 100644 index 00000000..64926398 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_restore_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_restore_parameters +name: key_restore_parameters +fullName: azure.keyvault.v2016_10_01.models.key_restore_parameters +classes: +- azure.keyvault.v2016_10_01.models.key_restore_parameters.KeyRestoreParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_restore_parameters_py3.KeyRestoreParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_restore_parameters_py3.KeyRestoreParameters.yml new file mode 100644 index 00000000..c129e195 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_restore_parameters_py3.KeyRestoreParameters.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_restore_parameters_py3.KeyRestoreParameters +name: KeyRestoreParameters +fullName: azure.keyvault.v2016_10_01.models.key_restore_parameters_py3.KeyRestoreParameters +module: azure.keyvault.v2016_10_01.models.key_restore_parameters_py3 +summary: 'The key restore parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeyRestoreParameters(*, key_bundle_backup: bytes, **kwargs)' + parameters: + - name: key_bundle_backup + description: 'Required. The backup blob associated with a key + + bundle.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: key_bundle_backup + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.key_restore_parameters_py3.KeyRestoreParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_restore_parameters_py3.KeyRestoreParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_restore_parameters_py3.KeyRestoreParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_restore_parameters_py3.KeyRestoreParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_restore_parameters_py3.KeyRestoreParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_restore_parameters_py3.KeyRestoreParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_restore_parameters_py3.KeyRestoreParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_restore_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_restore_parameters_py3.yml new file mode 100644 index 00000000..db50d1e6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_restore_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_restore_parameters_py3 +name: key_restore_parameters_py3 +fullName: azure.keyvault.v2016_10_01.models.key_restore_parameters_py3 +classes: +- azure.keyvault.v2016_10_01.models.key_restore_parameters_py3.KeyRestoreParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_sign_parameters.KeySignParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_sign_parameters.KeySignParameters.yml new file mode 100644 index 00000000..276c6e8a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_sign_parameters.KeySignParameters.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_sign_parameters.KeySignParameters +name: KeySignParameters +fullName: azure.keyvault.v2016_10_01.models.key_sign_parameters.KeySignParameters +module: azure.keyvault.v2016_10_01.models.key_sign_parameters +summary: 'The key operations parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: KeySignParameters(**kwargs) + parameters: + - name: algorithm + description: 'Required. The signing/verification algorithm identifier. + + For more information on possible algorithm types, see + + JsonWebKeySignatureAlgorithm. Possible values include: ''PS256'', ''PS384'', + + ''PS512'', ''RS256'', ''RS384'', ''RS512'', ''RSNULL'', ''ES256'', ''ES384'', + ''ES512'', + + ''ECDSA256''' + isRequired: true + types: + - + - + - name: value + description: Required. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.key_sign_parameters.KeySignParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_sign_parameters.KeySignParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_sign_parameters.KeySignParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_sign_parameters.KeySignParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_sign_parameters.KeySignParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_sign_parameters.KeySignParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_sign_parameters.KeySignParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_sign_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_sign_parameters.yml new file mode 100644 index 00000000..3c17c09a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_sign_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_sign_parameters +name: key_sign_parameters +fullName: azure.keyvault.v2016_10_01.models.key_sign_parameters +classes: +- azure.keyvault.v2016_10_01.models.key_sign_parameters.KeySignParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_sign_parameters_py3.KeySignParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_sign_parameters_py3.KeySignParameters.yml new file mode 100644 index 00000000..5ab8db9f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_sign_parameters_py3.KeySignParameters.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_sign_parameters_py3.KeySignParameters +name: KeySignParameters +fullName: azure.keyvault.v2016_10_01.models.key_sign_parameters_py3.KeySignParameters +module: azure.keyvault.v2016_10_01.models.key_sign_parameters_py3 +summary: 'The key operations parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeySignParameters(*, algorithm, value: bytes, **kwargs)' + parameters: + - name: algorithm + description: 'Required. The signing/verification algorithm identifier. + + For more information on possible algorithm types, see + + JsonWebKeySignatureAlgorithm. Possible values include: ''PS256'', ''PS384'', + + ''PS512'', ''RS256'', ''RS384'', ''RS512'', ''RSNULL'', ''ES256'', ''ES384'', + ''ES512'', + + ''ECDSA256''' + isRequired: true + types: + - + - + - name: value + description: Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: algorithm + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.key_sign_parameters_py3.KeySignParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_sign_parameters_py3.KeySignParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_sign_parameters_py3.KeySignParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_sign_parameters_py3.KeySignParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_sign_parameters_py3.KeySignParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_sign_parameters_py3.KeySignParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_sign_parameters_py3.KeySignParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_sign_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_sign_parameters_py3.yml new file mode 100644 index 00000000..0c5cf2c5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_sign_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_sign_parameters_py3 +name: key_sign_parameters_py3 +fullName: azure.keyvault.v2016_10_01.models.key_sign_parameters_py3 +classes: +- azure.keyvault.v2016_10_01.models.key_sign_parameters_py3.KeySignParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_update_parameters.KeyUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_update_parameters.KeyUpdateParameters.yml new file mode 100644 index 00000000..2777275c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_update_parameters.KeyUpdateParameters.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_update_parameters.KeyUpdateParameters +name: KeyUpdateParameters +fullName: azure.keyvault.v2016_10_01.models.key_update_parameters.KeyUpdateParameters +module: azure.keyvault.v2016_10_01.models.key_update_parameters +summary: The key update parameters. +constructor: + syntax: KeyUpdateParameters(**kwargs) + parameters: + - name: key_ops + description: 'Json web key operations. For more information on possible + + key operations, see JsonWebKeyOperation.' + isRequired: true + types: + - [ + - ] + - name: key_attributes + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +methods: +- uid: azure.keyvault.v2016_10_01.models.key_update_parameters.KeyUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_update_parameters.KeyUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_update_parameters.KeyUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_update_parameters.KeyUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_update_parameters.KeyUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_update_parameters.KeyUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_update_parameters.KeyUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_update_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_update_parameters.yml new file mode 100644 index 00000000..7ddf1c54 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_update_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_update_parameters +name: key_update_parameters +fullName: azure.keyvault.v2016_10_01.models.key_update_parameters +classes: +- azure.keyvault.v2016_10_01.models.key_update_parameters.KeyUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_update_parameters_py3.KeyUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_update_parameters_py3.KeyUpdateParameters.yml new file mode 100644 index 00000000..e4e29e81 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_update_parameters_py3.KeyUpdateParameters.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_update_parameters_py3.KeyUpdateParameters +name: KeyUpdateParameters +fullName: azure.keyvault.v2016_10_01.models.key_update_parameters_py3.KeyUpdateParameters +module: azure.keyvault.v2016_10_01.models.key_update_parameters_py3 +summary: The key update parameters. +constructor: + syntax: KeyUpdateParameters(*, key_ops=None, key_attributes=None, tags=None, **kwargs) + parameters: + - name: key_ops + description: 'Json web key operations. For more information on possible + + key operations, see JsonWebKeyOperation.' + isRequired: true + types: + - [ + - ] + - name: key_attributes + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: key_ops + isRequired: true + - name: key_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.key_update_parameters_py3.KeyUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_update_parameters_py3.KeyUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_update_parameters_py3.KeyUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_update_parameters_py3.KeyUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_update_parameters_py3.KeyUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_update_parameters_py3.KeyUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_update_parameters_py3.KeyUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_update_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_update_parameters_py3.yml new file mode 100644 index 00000000..730019bc --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_update_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_update_parameters_py3 +name: key_update_parameters_py3 +fullName: azure.keyvault.v2016_10_01.models.key_update_parameters_py3 +classes: +- azure.keyvault.v2016_10_01.models.key_update_parameters_py3.KeyUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.ActionType.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.ActionType.yml new file mode 100644 index 00000000..470eca16 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.ActionType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.ActionType +name: ActionType +fullName: azure.keyvault.v2016_10_01.models.key_vault_client_enums.ActionType +module: azure.keyvault.v2016_10_01.models.key_vault_client_enums +fields: +- name: auto_renew + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.ActionType.auto_renew +- name: email_contacts + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.ActionType.email_contacts diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.DeletionRecoveryLevel.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.DeletionRecoveryLevel.yml new file mode 100644 index 00000000..0d0060b8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.DeletionRecoveryLevel.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.DeletionRecoveryLevel +name: DeletionRecoveryLevel +fullName: azure.keyvault.v2016_10_01.models.key_vault_client_enums.DeletionRecoveryLevel +module: azure.keyvault.v2016_10_01.models.key_vault_client_enums +fields: +- name: purgeable + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.DeletionRecoveryLevel.purgeable +- name: recoverable + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.DeletionRecoveryLevel.recoverable +- name: recoverable_protected_subscription + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.DeletionRecoveryLevel.recoverable_protected_subscription +- name: recoverable_purgeable + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.DeletionRecoveryLevel.recoverable_purgeable diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyCurveName.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyCurveName.yml new file mode 100644 index 00000000..cf08299d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyCurveName.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyCurveName +name: JsonWebKeyCurveName +fullName: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyCurveName +module: azure.keyvault.v2016_10_01.models.key_vault_client_enums +fields: +- name: p_256 + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyCurveName.p_256 +- name: p_384 + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyCurveName.p_384 +- name: p_521 + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyCurveName.p_521 +- name: secp256_k1 + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyCurveName.secp256_k1 diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyEncryptionAlgorithm.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyEncryptionAlgorithm.yml new file mode 100644 index 00000000..fd38ed9b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyEncryptionAlgorithm.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyEncryptionAlgorithm +name: JsonWebKeyEncryptionAlgorithm +fullName: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyEncryptionAlgorithm +module: azure.keyvault.v2016_10_01.models.key_vault_client_enums +fields: +- name: rsa1_5 + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyEncryptionAlgorithm.rsa1_5 +- name: rsa_oaep + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyEncryptionAlgorithm.rsa_oaep +- name: rsa_oaep_256 + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyEncryptionAlgorithm.rsa_oaep_256 diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyOperation.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyOperation.yml new file mode 100644 index 00000000..2768aa00 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyOperation.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyOperation +name: JsonWebKeyOperation +fullName: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyOperation +module: azure.keyvault.v2016_10_01.models.key_vault_client_enums +fields: +- name: decrypt + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyOperation.decrypt +- name: encrypt + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyOperation.encrypt +- name: sign + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyOperation.sign +- name: unwrap_key + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyOperation.unwrap_key +- name: verify + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyOperation.verify +- name: wrap_key + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyOperation.wrap_key diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.yml new file mode 100644 index 00000000..8361fefe --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm +name: JsonWebKeySignatureAlgorithm +fullName: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm +module: azure.keyvault.v2016_10_01.models.key_vault_client_enums +fields: +- name: ecdsa256 + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.ecdsa256 +- name: es256 + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.es256 +- name: es384 + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.es384 +- name: es512 + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.es512 +- name: ps256 + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.ps256 +- name: ps384 + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.ps384 +- name: ps512 + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.ps512 +- name: rs256 + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.rs256 +- name: rs384 + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.rs384 +- name: rs512 + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.rs512 +- name: rsnull + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.rsnull diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyType.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyType.yml new file mode 100644 index 00000000..15a8fa16 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyType.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyType +name: JsonWebKeyType +fullName: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyType +module: azure.keyvault.v2016_10_01.models.key_vault_client_enums +fields: +- name: ec + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyType.ec +- name: ec_hsm + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyType.ec_hsm +- name: oct + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyType.oct +- name: rsa + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyType.rsa +- name: rsa_hsm + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyType.rsa_hsm diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.KeyUsageType.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.KeyUsageType.yml new file mode 100644 index 00000000..82961952 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.KeyUsageType.yml @@ -0,0 +1,24 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.KeyUsageType +name: KeyUsageType +fullName: azure.keyvault.v2016_10_01.models.key_vault_client_enums.KeyUsageType +module: azure.keyvault.v2016_10_01.models.key_vault_client_enums +fields: +- name: c_rl_sign + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.KeyUsageType.c_rl_sign +- name: data_encipherment + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.KeyUsageType.data_encipherment +- name: decipher_only + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.KeyUsageType.decipher_only +- name: digital_signature + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.KeyUsageType.digital_signature +- name: encipher_only + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.KeyUsageType.encipher_only +- name: key_agreement + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.KeyUsageType.key_agreement +- name: key_cert_sign + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.KeyUsageType.key_cert_sign +- name: key_encipherment + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.KeyUsageType.key_encipherment +- name: non_repudiation + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.KeyUsageType.non_repudiation diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.yml new file mode 100644 index 00000000..7a8e3a0a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_client_enums.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums +name: key_vault_client_enums +fullName: azure.keyvault.v2016_10_01.models.key_vault_client_enums +enums: +- azure.keyvault.v2016_10_01.models.key_vault_client_enums.ActionType +- azure.keyvault.v2016_10_01.models.key_vault_client_enums.DeletionRecoveryLevel +- azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyCurveName +- azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyEncryptionAlgorithm +- azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyOperation +- azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm +- azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyType +- azure.keyvault.v2016_10_01.models.key_vault_client_enums.KeyUsageType diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultError.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultError.yml new file mode 100644 index 00000000..82dd4ad8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultError.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultError +name: KeyVaultError +fullName: azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultError +module: azure.keyvault.v2016_10_01.models.key_vault_error +summary: 'The key vault error exception. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyVaultError(**kwargs) +variables: +- name: error + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultErrorException.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultErrorException.yml new file mode 100644 index 00000000..5896c70c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultErrorException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultErrorException +name: KeyVaultErrorException +fullName: azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultErrorException +module: azure.keyvault.v2016_10_01.models.key_vault_error +summary: 'Server responsed with exception of type: ''KeyVaultError''.' +constructor: + syntax: KeyVaultErrorException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultErrorException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultErrorException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultErrorException.args + name: args diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error.yml new file mode 100644 index 00000000..2bbab573 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_vault_error +name: key_vault_error +fullName: azure.keyvault.v2016_10_01.models.key_vault_error +classes: +- azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultError +- azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultErrorException diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultError.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultError.yml new file mode 100644 index 00000000..ab864005 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultError.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultError +name: KeyVaultError +fullName: azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultError +module: azure.keyvault.v2016_10_01.models.key_vault_error_py3 +summary: 'The key vault error exception. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyVaultError(**kwargs) +variables: +- name: error + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultErrorException.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultErrorException.yml new file mode 100644 index 00000000..fe59210d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultErrorException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultErrorException +name: KeyVaultErrorException +fullName: azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultErrorException +module: azure.keyvault.v2016_10_01.models.key_vault_error_py3 +summary: 'Server responsed with exception of type: ''KeyVaultError''.' +constructor: + syntax: KeyVaultErrorException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultErrorException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultErrorException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultErrorException.args + name: args diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error_py3.yml new file mode 100644 index 00000000..8ee643cc --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_vault_error_py3.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_vault_error_py3 +name: key_vault_error_py3 +fullName: azure.keyvault.v2016_10_01.models.key_vault_error_py3 +classes: +- azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultError +- azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultErrorException diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_parameters.KeyVerifyParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_parameters.KeyVerifyParameters.yml new file mode 100644 index 00000000..fd5e917f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_parameters.KeyVerifyParameters.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_verify_parameters.KeyVerifyParameters +name: KeyVerifyParameters +fullName: azure.keyvault.v2016_10_01.models.key_verify_parameters.KeyVerifyParameters +module: azure.keyvault.v2016_10_01.models.key_verify_parameters +summary: 'The key verify parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: KeyVerifyParameters(**kwargs) + parameters: + - name: algorithm + description: 'Required. The signing/verification algorithm. For more + + information on possible algorithm types, see JsonWebKeySignatureAlgorithm. + + Possible values include: ''PS256'', ''PS384'', ''PS512'', ''RS256'', ''RS384'', + + ''RS512'', ''RSNULL'', ''ES256'', ''ES384'', ''ES512'', ''ECDSA256''' + isRequired: true + types: + - + - + - name: digest + description: Required. The digest used for signing. + isRequired: true + types: + - + - name: signature + description: Required. The signature to be verified. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.key_verify_parameters.KeyVerifyParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_verify_parameters.KeyVerifyParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_verify_parameters.KeyVerifyParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_verify_parameters.KeyVerifyParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_verify_parameters.KeyVerifyParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_verify_parameters.KeyVerifyParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_verify_parameters.KeyVerifyParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_parameters.yml new file mode 100644 index 00000000..7d037b73 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_verify_parameters +name: key_verify_parameters +fullName: azure.keyvault.v2016_10_01.models.key_verify_parameters +classes: +- azure.keyvault.v2016_10_01.models.key_verify_parameters.KeyVerifyParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_parameters_py3.KeyVerifyParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_parameters_py3.KeyVerifyParameters.yml new file mode 100644 index 00000000..2daa0214 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_parameters_py3.KeyVerifyParameters.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_verify_parameters_py3.KeyVerifyParameters +name: KeyVerifyParameters +fullName: azure.keyvault.v2016_10_01.models.key_verify_parameters_py3.KeyVerifyParameters +module: azure.keyvault.v2016_10_01.models.key_verify_parameters_py3 +summary: 'The key verify parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeyVerifyParameters(*, algorithm, digest: bytes, signature: bytes, **kwargs)' + parameters: + - name: algorithm + description: 'Required. The signing/verification algorithm. For more + + information on possible algorithm types, see JsonWebKeySignatureAlgorithm. + + Possible values include: ''PS256'', ''PS384'', ''PS512'', ''RS256'', ''RS384'', + + ''RS512'', ''RSNULL'', ''ES256'', ''ES384'', ''ES512'', ''ECDSA256''' + isRequired: true + types: + - + - + - name: digest + description: Required. The digest used for signing. + isRequired: true + types: + - + - name: signature + description: Required. The signature to be verified. + isRequired: true + types: + - + keywordOnlyParameters: + - name: algorithm + isRequired: true + - name: digest + isRequired: true + - name: signature + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.key_verify_parameters_py3.KeyVerifyParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_verify_parameters_py3.KeyVerifyParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_verify_parameters_py3.KeyVerifyParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_verify_parameters_py3.KeyVerifyParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_verify_parameters_py3.KeyVerifyParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_verify_parameters_py3.KeyVerifyParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_verify_parameters_py3.KeyVerifyParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_parameters_py3.yml new file mode 100644 index 00000000..778ef55d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_verify_parameters_py3 +name: key_verify_parameters_py3 +fullName: azure.keyvault.v2016_10_01.models.key_verify_parameters_py3 +classes: +- azure.keyvault.v2016_10_01.models.key_verify_parameters_py3.KeyVerifyParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_result.KeyVerifyResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_result.KeyVerifyResult.yml new file mode 100644 index 00000000..8a0b1a61 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_result.KeyVerifyResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_verify_result.KeyVerifyResult +name: KeyVerifyResult +fullName: azure.keyvault.v2016_10_01.models.key_verify_result.KeyVerifyResult +module: azure.keyvault.v2016_10_01.models.key_verify_result +summary: 'The key verify result. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyVerifyResult(**kwargs) +variables: +- description: True if the signature is verified, otherwise false. + name: value + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.key_verify_result.KeyVerifyResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_verify_result.KeyVerifyResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_verify_result.KeyVerifyResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_verify_result.KeyVerifyResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_verify_result.KeyVerifyResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_verify_result.KeyVerifyResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_verify_result.KeyVerifyResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_result.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_result.yml new file mode 100644 index 00000000..b7e675d4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_verify_result +name: key_verify_result +fullName: azure.keyvault.v2016_10_01.models.key_verify_result +classes: +- azure.keyvault.v2016_10_01.models.key_verify_result.KeyVerifyResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_result_py3.KeyVerifyResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_result_py3.KeyVerifyResult.yml new file mode 100644 index 00000000..decab27e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_result_py3.KeyVerifyResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.key_verify_result_py3.KeyVerifyResult +name: KeyVerifyResult +fullName: azure.keyvault.v2016_10_01.models.key_verify_result_py3.KeyVerifyResult +module: azure.keyvault.v2016_10_01.models.key_verify_result_py3 +summary: 'The key verify result. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyVerifyResult(**kwargs) +variables: +- description: True if the signature is verified, otherwise false. + name: value + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.key_verify_result_py3.KeyVerifyResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_verify_result_py3.KeyVerifyResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_verify_result_py3.KeyVerifyResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.key_verify_result_py3.KeyVerifyResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.key_verify_result_py3.KeyVerifyResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.key_verify_result_py3.KeyVerifyResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.key_verify_result_py3.KeyVerifyResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_result_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_result_py3.yml new file mode 100644 index 00000000..0004e1e2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_verify_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.key_verify_result_py3 +name: key_verify_result_py3 +fullName: azure.keyvault.v2016_10_01.models.key_verify_result_py3 +classes: +- azure.keyvault.v2016_10_01.models.key_verify_result_py3.KeyVerifyResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.lifetime_action.LifetimeAction.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.lifetime_action.LifetimeAction.yml new file mode 100644 index 00000000..60d05173 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.lifetime_action.LifetimeAction.yml @@ -0,0 +1,127 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.lifetime_action.LifetimeAction +name: LifetimeAction +fullName: azure.keyvault.v2016_10_01.models.lifetime_action.LifetimeAction +module: azure.keyvault.v2016_10_01.models.lifetime_action +summary: 'Action and its trigger that will be performed by Key Vault over the + + lifetime of a certificate.' +constructor: + syntax: LifetimeAction(**kwargs) + parameters: + - name: trigger + description: The condition that will execute the action. + isRequired: true + types: + - + - name: action + description: The action that will be executed. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.lifetime_action.LifetimeAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.lifetime_action.LifetimeAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.lifetime_action.LifetimeAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.lifetime_action.LifetimeAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.lifetime_action.LifetimeAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.lifetime_action.LifetimeAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.lifetime_action.LifetimeAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.lifetime_action.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.lifetime_action.yml new file mode 100644 index 00000000..fb8ae399 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.lifetime_action.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.lifetime_action +name: lifetime_action +fullName: azure.keyvault.v2016_10_01.models.lifetime_action +classes: +- azure.keyvault.v2016_10_01.models.lifetime_action.LifetimeAction diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.lifetime_action_py3.LifetimeAction.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.lifetime_action_py3.LifetimeAction.yml new file mode 100644 index 00000000..919a1a62 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.lifetime_action_py3.LifetimeAction.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.lifetime_action_py3.LifetimeAction +name: LifetimeAction +fullName: azure.keyvault.v2016_10_01.models.lifetime_action_py3.LifetimeAction +module: azure.keyvault.v2016_10_01.models.lifetime_action_py3 +summary: 'Action and its trigger that will be performed by Key Vault over the + + lifetime of a certificate.' +constructor: + syntax: LifetimeAction(*, trigger=None, action=None, **kwargs) + parameters: + - name: trigger + description: The condition that will execute the action. + isRequired: true + types: + - + - name: action + description: The action that will be executed. + isRequired: true + types: + - + keywordOnlyParameters: + - name: trigger + isRequired: true + - name: action + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.lifetime_action_py3.LifetimeAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.lifetime_action_py3.LifetimeAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.lifetime_action_py3.LifetimeAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.lifetime_action_py3.LifetimeAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.lifetime_action_py3.LifetimeAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.lifetime_action_py3.LifetimeAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.lifetime_action_py3.LifetimeAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.lifetime_action_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.lifetime_action_py3.yml new file mode 100644 index 00000000..7af0650a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.lifetime_action_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.lifetime_action_py3 +name: lifetime_action_py3 +fullName: azure.keyvault.v2016_10_01.models.lifetime_action_py3 +classes: +- azure.keyvault.v2016_10_01.models.lifetime_action_py3.LifetimeAction diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.organization_details.OrganizationDetails.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.organization_details.OrganizationDetails.yml new file mode 100644 index 00000000..27d8c1a6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.organization_details.OrganizationDetails.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.organization_details.OrganizationDetails +name: OrganizationDetails +fullName: azure.keyvault.v2016_10_01.models.organization_details.OrganizationDetails +module: azure.keyvault.v2016_10_01.models.organization_details +summary: Details of the organization of the certificate issuer. +constructor: + syntax: OrganizationDetails(**kwargs) + parameters: + - name: id + description: Id of the organization. + isRequired: true + types: + - + - name: admin_details + description: Details of the organization administrator. + isRequired: true + types: + - [] +methods: +- uid: azure.keyvault.v2016_10_01.models.organization_details.OrganizationDetails.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.organization_details.OrganizationDetails.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.organization_details.OrganizationDetails.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.organization_details.OrganizationDetails.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.organization_details.OrganizationDetails.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.organization_details.OrganizationDetails.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.organization_details.OrganizationDetails.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.organization_details.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.organization_details.yml new file mode 100644 index 00000000..a6119a4d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.organization_details.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.organization_details +name: organization_details +fullName: azure.keyvault.v2016_10_01.models.organization_details +classes: +- azure.keyvault.v2016_10_01.models.organization_details.OrganizationDetails diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.organization_details_py3.OrganizationDetails.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.organization_details_py3.OrganizationDetails.yml new file mode 100644 index 00000000..23453afe --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.organization_details_py3.OrganizationDetails.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.organization_details_py3.OrganizationDetails +name: OrganizationDetails +fullName: azure.keyvault.v2016_10_01.models.organization_details_py3.OrganizationDetails +module: azure.keyvault.v2016_10_01.models.organization_details_py3 +summary: Details of the organization of the certificate issuer. +constructor: + syntax: 'OrganizationDetails(*, id: str = None, admin_details=None, **kwargs)' + parameters: + - name: id + description: Id of the organization. + isRequired: true + types: + - + - name: admin_details + description: Details of the organization administrator. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: admin_details + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.organization_details_py3.OrganizationDetails.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.organization_details_py3.OrganizationDetails.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.organization_details_py3.OrganizationDetails.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.organization_details_py3.OrganizationDetails.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.organization_details_py3.OrganizationDetails.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.organization_details_py3.OrganizationDetails.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.organization_details_py3.OrganizationDetails.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.organization_details_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.organization_details_py3.yml new file mode 100644 index 00000000..a71de86a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.organization_details_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.organization_details_py3 +name: organization_details_py3 +fullName: azure.keyvault.v2016_10_01.models.organization_details_py3 +classes: +- azure.keyvault.v2016_10_01.models.organization_details_py3.OrganizationDetails diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult.yml new file mode 100644 index 00000000..c93e7ff4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult +name: PendingCertificateSigningRequestResult +fullName: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult +module: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result +summary: 'The pending certificate signing request result. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: PendingCertificateSigningRequestResult(**kwargs) +variables: +- description: 'The pending certificate signing request as Base64 encoded + + string.' + name: value + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result.yml new file mode 100644 index 00000000..4599129a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result +name: pending_certificate_signing_request_result +fullName: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result +classes: +- azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult.yml new file mode 100644 index 00000000..6afe74bf --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult +name: PendingCertificateSigningRequestResult +fullName: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult +module: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3 +summary: 'The pending certificate signing request result. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: PendingCertificateSigningRequestResult(**kwargs) +variables: +- description: 'The pending certificate signing request as Base64 encoded + + string.' + name: value + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3.yml new file mode 100644 index 00000000..e955bef9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3 +name: pending_certificate_signing_request_result_py3 +fullName: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3 +classes: +- azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_attributes.SasDefinitionAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_attributes.SasDefinitionAttributes.yml new file mode 100644 index 00000000..6b1be003 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_attributes.SasDefinitionAttributes.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.sas_definition_attributes.SasDefinitionAttributes +name: SasDefinitionAttributes +fullName: azure.keyvault.v2016_10_01.models.sas_definition_attributes.SasDefinitionAttributes +module: azure.keyvault.v2016_10_01.models.sas_definition_attributes +summary: 'The SAS definition management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SasDefinitionAttributes(**kwargs) + parameters: + - name: enabled + description: the enabled state of the object. + isRequired: true + types: + - +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.sas_definition_attributes.SasDefinitionAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.sas_definition_attributes.SasDefinitionAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.sas_definition_attributes.SasDefinitionAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.sas_definition_attributes.SasDefinitionAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.sas_definition_attributes.SasDefinitionAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.sas_definition_attributes.SasDefinitionAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.sas_definition_attributes.SasDefinitionAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_attributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_attributes.yml new file mode 100644 index 00000000..38189240 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_attributes.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.sas_definition_attributes +name: sas_definition_attributes +fullName: azure.keyvault.v2016_10_01.models.sas_definition_attributes +classes: +- azure.keyvault.v2016_10_01.models.sas_definition_attributes.SasDefinitionAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3.SasDefinitionAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3.SasDefinitionAttributes.yml new file mode 100644 index 00000000..89430afa --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3.SasDefinitionAttributes.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3.SasDefinitionAttributes +name: SasDefinitionAttributes +fullName: azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3.SasDefinitionAttributes +module: azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3 +summary: 'The SAS definition management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'SasDefinitionAttributes(*, enabled: bool = None, **kwargs)' + parameters: + - name: enabled + description: the enabled state of the object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3.SasDefinitionAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3.SasDefinitionAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3.SasDefinitionAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3.SasDefinitionAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3.SasDefinitionAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3.SasDefinitionAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3.SasDefinitionAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3.yml new file mode 100644 index 00000000..60fcef00 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3 +name: sas_definition_attributes_py3 +fullName: azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3 +classes: +- azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3.SasDefinitionAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_bundle.SasDefinitionBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_bundle.SasDefinitionBundle.yml new file mode 100644 index 00000000..560bf630 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_bundle.SasDefinitionBundle.yml @@ -0,0 +1,144 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.sas_definition_bundle.SasDefinitionBundle +name: SasDefinitionBundle +fullName: azure.keyvault.v2016_10_01.models.sas_definition_bundle.SasDefinitionBundle +module: azure.keyvault.v2016_10_01.models.sas_definition_bundle +summary: 'A SAS definition bundle consists of key vault SAS definition details plus + + its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SasDefinitionBundle(**kwargs) +variables: +- description: The SAS definition id. + name: id + types: + - +- description: Storage account SAS definition secret id. + name: secret_id + types: + - +- description: 'The SAS definition metadata in the form of key-value + + pairs.' + name: parameters + types: + - [, ] +- description: The SAS definition attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v2016_10_01.models.sas_definition_bundle.SasDefinitionBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.sas_definition_bundle.SasDefinitionBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.sas_definition_bundle.SasDefinitionBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.sas_definition_bundle.SasDefinitionBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.sas_definition_bundle.SasDefinitionBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.sas_definition_bundle.SasDefinitionBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.sas_definition_bundle.SasDefinitionBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_bundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_bundle.yml new file mode 100644 index 00000000..c2990f74 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_bundle.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.sas_definition_bundle +name: sas_definition_bundle +fullName: azure.keyvault.v2016_10_01.models.sas_definition_bundle +classes: +- azure.keyvault.v2016_10_01.models.sas_definition_bundle.SasDefinitionBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3.SasDefinitionBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3.SasDefinitionBundle.yml new file mode 100644 index 00000000..be1e900b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3.SasDefinitionBundle.yml @@ -0,0 +1,144 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3.SasDefinitionBundle +name: SasDefinitionBundle +fullName: azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3.SasDefinitionBundle +module: azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3 +summary: 'A SAS definition bundle consists of key vault SAS definition details plus + + its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SasDefinitionBundle(**kwargs) +variables: +- description: The SAS definition id. + name: id + types: + - +- description: Storage account SAS definition secret id. + name: secret_id + types: + - +- description: 'The SAS definition metadata in the form of key-value + + pairs.' + name: parameters + types: + - [, ] +- description: The SAS definition attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3.SasDefinitionBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3.SasDefinitionBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3.SasDefinitionBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3.SasDefinitionBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3.SasDefinitionBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3.SasDefinitionBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3.SasDefinitionBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3.yml new file mode 100644 index 00000000..6791d31f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3 +name: sas_definition_bundle_py3 +fullName: azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3 +classes: +- azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3.SasDefinitionBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_create_parameters.SasDefinitionCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_create_parameters.SasDefinitionCreateParameters.yml new file mode 100644 index 00000000..e44e1b41 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_create_parameters.SasDefinitionCreateParameters.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters.SasDefinitionCreateParameters +name: SasDefinitionCreateParameters +fullName: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters.SasDefinitionCreateParameters +module: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters +summary: 'The SAS definition create parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: SasDefinitionCreateParameters(**kwargs) + parameters: + - name: parameters + description: 'Required. Sas definition creation metadata in the form + + of key-value pairs.' + isRequired: true + types: + - [, ] + - name: sas_definition_attributes + description: The attributes of the SAS definition. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +methods: +- uid: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters.SasDefinitionCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters.SasDefinitionCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters.SasDefinitionCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters.SasDefinitionCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters.SasDefinitionCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters.SasDefinitionCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters.SasDefinitionCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_create_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_create_parameters.yml new file mode 100644 index 00000000..bdd6a24d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_create_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters +name: sas_definition_create_parameters +fullName: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters +classes: +- azure.keyvault.v2016_10_01.models.sas_definition_create_parameters.SasDefinitionCreateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.yml new file mode 100644 index 00000000..bcefd9e1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters +name: SasDefinitionCreateParameters +fullName: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters +module: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3 +summary: 'The SAS definition create parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: SasDefinitionCreateParameters(*, parameters, sas_definition_attributes=None, + tags=None, **kwargs) + parameters: + - name: parameters + description: 'Required. Sas definition creation metadata in the form + + of key-value pairs.' + isRequired: true + types: + - [, ] + - name: sas_definition_attributes + description: The attributes of the SAS definition. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: parameters + isRequired: true + - name: sas_definition_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.yml new file mode 100644 index 00000000..a89d07fc --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3 +name: sas_definition_create_parameters_py3 +fullName: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3 +classes: +- azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item.SasDefinitionItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item.SasDefinitionItem.yml new file mode 100644 index 00000000..d3a5659f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item.SasDefinitionItem.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.sas_definition_item.SasDefinitionItem +name: SasDefinitionItem +fullName: azure.keyvault.v2016_10_01.models.sas_definition_item.SasDefinitionItem +module: azure.keyvault.v2016_10_01.models.sas_definition_item +summary: 'The SAS definition item containing storage SAS definition metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SasDefinitionItem(**kwargs) +variables: +- description: The storage SAS identifier. + name: id + types: + - +- description: The storage account SAS definition secret id. + name: secret_id + types: + - +- description: The SAS definition management attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs. + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v2016_10_01.models.sas_definition_item.SasDefinitionItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.sas_definition_item.SasDefinitionItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.sas_definition_item.SasDefinitionItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.sas_definition_item.SasDefinitionItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.sas_definition_item.SasDefinitionItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.sas_definition_item.SasDefinitionItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.sas_definition_item.SasDefinitionItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item.yml new file mode 100644 index 00000000..6648ec9a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.sas_definition_item +name: sas_definition_item +fullName: azure.keyvault.v2016_10_01.models.sas_definition_item +classes: +- azure.keyvault.v2016_10_01.models.sas_definition_item.SasDefinitionItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item_paged.SasDefinitionItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item_paged.SasDefinitionItemPaged.yml new file mode 100644 index 00000000..d3f963bc --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item_paged.SasDefinitionItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.sas_definition_item_paged.SasDefinitionItemPaged +name: SasDefinitionItemPaged +fullName: azure.keyvault.v2016_10_01.models.sas_definition_item_paged.SasDefinitionItemPaged +module: azure.keyvault.v2016_10_01.models.sas_definition_item_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: SasDefinitionItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v2016_10_01.models.sas_definition_item_paged.SasDefinitionItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v2016_10_01.models.sas_definition_item_paged.SasDefinitionItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v2016_10_01.models.sas_definition_item_paged.SasDefinitionItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.sas_definition_item_paged.SasDefinitionItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.sas_definition_item_paged.SasDefinitionItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v2016_10_01.models.sas_definition_item_paged.SasDefinitionItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v2016_10_01.models.sas_definition_item_paged.SasDefinitionItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item_paged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item_paged.yml new file mode 100644 index 00000000..b0d21e93 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.sas_definition_item_paged +name: sas_definition_item_paged +fullName: azure.keyvault.v2016_10_01.models.sas_definition_item_paged +classes: +- azure.keyvault.v2016_10_01.models.sas_definition_item_paged.SasDefinitionItemPaged diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item_py3.SasDefinitionItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item_py3.SasDefinitionItem.yml new file mode 100644 index 00000000..0fbe8f96 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item_py3.SasDefinitionItem.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.sas_definition_item_py3.SasDefinitionItem +name: SasDefinitionItem +fullName: azure.keyvault.v2016_10_01.models.sas_definition_item_py3.SasDefinitionItem +module: azure.keyvault.v2016_10_01.models.sas_definition_item_py3 +summary: 'The SAS definition item containing storage SAS definition metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SasDefinitionItem(**kwargs) +variables: +- description: The storage SAS identifier. + name: id + types: + - +- description: The storage account SAS definition secret id. + name: secret_id + types: + - +- description: The SAS definition management attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs. + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v2016_10_01.models.sas_definition_item_py3.SasDefinitionItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.sas_definition_item_py3.SasDefinitionItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.sas_definition_item_py3.SasDefinitionItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.sas_definition_item_py3.SasDefinitionItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.sas_definition_item_py3.SasDefinitionItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.sas_definition_item_py3.SasDefinitionItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.sas_definition_item_py3.SasDefinitionItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item_py3.yml new file mode 100644 index 00000000..f95d92d1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.sas_definition_item_py3 +name: sas_definition_item_py3 +fullName: azure.keyvault.v2016_10_01.models.sas_definition_item_py3 +classes: +- azure.keyvault.v2016_10_01.models.sas_definition_item_py3.SasDefinitionItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_update_parameters.SasDefinitionUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_update_parameters.SasDefinitionUpdateParameters.yml new file mode 100644 index 00000000..6125f37d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_update_parameters.SasDefinitionUpdateParameters.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters.SasDefinitionUpdateParameters +name: SasDefinitionUpdateParameters +fullName: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters.SasDefinitionUpdateParameters +module: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters +summary: The SAS definition update parameters. +constructor: + syntax: SasDefinitionUpdateParameters(**kwargs) + parameters: + - name: parameters + description: 'Sas definition update metadata in the form of key-value + + pairs.' + isRequired: true + types: + - [, ] + - name: sas_definition_attributes + description: The attributes of the SAS definition. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +methods: +- uid: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters.SasDefinitionUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters.SasDefinitionUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters.SasDefinitionUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters.SasDefinitionUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters.SasDefinitionUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters.SasDefinitionUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters.SasDefinitionUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_update_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_update_parameters.yml new file mode 100644 index 00000000..b474b200 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_update_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters +name: sas_definition_update_parameters +fullName: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters +classes: +- azure.keyvault.v2016_10_01.models.sas_definition_update_parameters.SasDefinitionUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.yml new file mode 100644 index 00000000..99346ad2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters +name: SasDefinitionUpdateParameters +fullName: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters +module: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3 +summary: The SAS definition update parameters. +constructor: + syntax: SasDefinitionUpdateParameters(*, parameters=None, sas_definition_attributes=None, + tags=None, **kwargs) + parameters: + - name: parameters + description: 'Sas definition update metadata in the form of key-value + + pairs.' + isRequired: true + types: + - [, ] + - name: sas_definition_attributes + description: The attributes of the SAS definition. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: parameters + isRequired: true + - name: sas_definition_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.yml new file mode 100644 index 00000000..db1b8ba6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3 +name: sas_definition_update_parameters_py3 +fullName: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3 +classes: +- azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_attributes.SecretAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_attributes.SecretAttributes.yml new file mode 100644 index 00000000..01d1651d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_attributes.SecretAttributes.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.secret_attributes.SecretAttributes +name: SecretAttributes +fullName: azure.keyvault.v2016_10_01.models.secret_attributes.SecretAttributes +module: azure.keyvault.v2016_10_01.models.secret_attributes +summary: 'The secret management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SecretAttributes(**kwargs) + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for secrets in the current vault. If it contains ''Purgeable'', the + + secret can be permanently deleted by a privileged user; otherwise, only + + the system can purge the secret, at the end of the retention interval. + + Possible values include: ''Purgeable'', ''Recoverable+Purgeable'', + + ''Recoverable'', ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v2016_10_01.models.secret_attributes.SecretAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_attributes.SecretAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_attributes.SecretAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.secret_attributes.SecretAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_attributes.SecretAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.secret_attributes.SecretAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_attributes.SecretAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_attributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_attributes.yml new file mode 100644 index 00000000..e8c3dd73 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_attributes.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.secret_attributes +name: secret_attributes +fullName: azure.keyvault.v2016_10_01.models.secret_attributes +classes: +- azure.keyvault.v2016_10_01.models.secret_attributes.SecretAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_attributes_py3.SecretAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_attributes_py3.SecretAttributes.yml new file mode 100644 index 00000000..e0cf4089 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_attributes_py3.SecretAttributes.yml @@ -0,0 +1,167 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.secret_attributes_py3.SecretAttributes +name: SecretAttributes +fullName: azure.keyvault.v2016_10_01.models.secret_attributes_py3.SecretAttributes +module: azure.keyvault.v2016_10_01.models.secret_attributes_py3 +summary: 'The secret management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'SecretAttributes(*, enabled: bool = None, not_before=None, expires=None, + **kwargs)' + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true + - name: not_before + isRequired: true + - name: expires + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for secrets in the current vault. If it contains ''Purgeable'', the + + secret can be permanently deleted by a privileged user; otherwise, only + + the system can purge the secret, at the end of the retention interval. + + Possible values include: ''Purgeable'', ''Recoverable+Purgeable'', + + ''Recoverable'', ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v2016_10_01.models.secret_attributes_py3.SecretAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_attributes_py3.SecretAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_attributes_py3.SecretAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.secret_attributes_py3.SecretAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_attributes_py3.SecretAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.secret_attributes_py3.SecretAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_attributes_py3.SecretAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_attributes_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_attributes_py3.yml new file mode 100644 index 00000000..9a48984b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_attributes_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.secret_attributes_py3 +name: secret_attributes_py3 +fullName: azure.keyvault.v2016_10_01.models.secret_attributes_py3 +classes: +- azure.keyvault.v2016_10_01.models.secret_attributes_py3.SecretAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_bundle.SecretBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_bundle.SecretBundle.yml new file mode 100644 index 00000000..a818616b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_bundle.SecretBundle.yml @@ -0,0 +1,158 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.secret_bundle.SecretBundle +name: SecretBundle +fullName: azure.keyvault.v2016_10_01.models.secret_bundle.SecretBundle +module: azure.keyvault.v2016_10_01.models.secret_bundle +summary: 'A secret consisting of a value, id and its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SecretBundle(**kwargs) + parameters: + - name: value + description: The secret value. + isRequired: true + types: + - + - name: id + description: The secret id. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +variables: +- description: 'If this is a secret backing a KV certificate, then this field + + specifies the corresponding key backing the KV certificate.' + name: kid + types: + - +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a secret backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.secret_bundle.SecretBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_bundle.SecretBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_bundle.SecretBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.secret_bundle.SecretBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_bundle.SecretBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.secret_bundle.SecretBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_bundle.SecretBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_bundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_bundle.yml new file mode 100644 index 00000000..562f64dc --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_bundle.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.secret_bundle +name: secret_bundle +fullName: azure.keyvault.v2016_10_01.models.secret_bundle +classes: +- azure.keyvault.v2016_10_01.models.secret_bundle.SecretBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_bundle_py3.SecretBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_bundle_py3.SecretBundle.yml new file mode 100644 index 00000000..2271b23c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_bundle_py3.SecretBundle.yml @@ -0,0 +1,170 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.secret_bundle_py3.SecretBundle +name: SecretBundle +fullName: azure.keyvault.v2016_10_01.models.secret_bundle_py3.SecretBundle +module: azure.keyvault.v2016_10_01.models.secret_bundle_py3 +summary: 'A secret consisting of a value, id and its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'SecretBundle(*, value: str = None, id: str = None, content_type: str = + None, attributes=None, tags=None, **kwargs)' + parameters: + - name: value + description: The secret value. + isRequired: true + types: + - + - name: id + description: The secret id. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: value + isRequired: true + - name: id + isRequired: true + - name: content_type + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true +variables: +- description: 'If this is a secret backing a KV certificate, then this field + + specifies the corresponding key backing the KV certificate.' + name: kid + types: + - +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a secret backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.secret_bundle_py3.SecretBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_bundle_py3.SecretBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_bundle_py3.SecretBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.secret_bundle_py3.SecretBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_bundle_py3.SecretBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.secret_bundle_py3.SecretBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_bundle_py3.SecretBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_bundle_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_bundle_py3.yml new file mode 100644 index 00000000..bc1a378c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_bundle_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.secret_bundle_py3 +name: secret_bundle_py3 +fullName: azure.keyvault.v2016_10_01.models.secret_bundle_py3 +classes: +- azure.keyvault.v2016_10_01.models.secret_bundle_py3.SecretBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item.SecretItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item.SecretItem.yml new file mode 100644 index 00000000..f646b11e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item.SecretItem.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.secret_item.SecretItem +name: SecretItem +fullName: azure.keyvault.v2016_10_01.models.secret_item.SecretItem +module: azure.keyvault.v2016_10_01.models.secret_item +summary: 'The secret item containing secret metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SecretItem(**kwargs) + parameters: + - name: id + description: Secret identifier. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - +variables: +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a key backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.secret_item.SecretItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_item.SecretItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_item.SecretItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.secret_item.SecretItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_item.SecretItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.secret_item.SecretItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_item.SecretItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item.yml new file mode 100644 index 00000000..11055ca0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.secret_item +name: secret_item +fullName: azure.keyvault.v2016_10_01.models.secret_item +classes: +- azure.keyvault.v2016_10_01.models.secret_item.SecretItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item_paged.SecretItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item_paged.SecretItemPaged.yml new file mode 100644 index 00000000..23dcf0bb --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item_paged.SecretItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.secret_item_paged.SecretItemPaged +name: SecretItemPaged +fullName: azure.keyvault.v2016_10_01.models.secret_item_paged.SecretItemPaged +module: azure.keyvault.v2016_10_01.models.secret_item_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: SecretItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v2016_10_01.models.secret_item_paged.SecretItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v2016_10_01.models.secret_item_paged.SecretItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v2016_10_01.models.secret_item_paged.SecretItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_item_paged.SecretItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_item_paged.SecretItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v2016_10_01.models.secret_item_paged.SecretItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v2016_10_01.models.secret_item_paged.SecretItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item_paged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item_paged.yml new file mode 100644 index 00000000..53dccf83 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.secret_item_paged +name: secret_item_paged +fullName: azure.keyvault.v2016_10_01.models.secret_item_paged +classes: +- azure.keyvault.v2016_10_01.models.secret_item_paged.SecretItemPaged diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item_py3.SecretItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item_py3.SecretItem.yml new file mode 100644 index 00000000..cc7b5d2e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item_py3.SecretItem.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.secret_item_py3.SecretItem +name: SecretItem +fullName: azure.keyvault.v2016_10_01.models.secret_item_py3.SecretItem +module: azure.keyvault.v2016_10_01.models.secret_item_py3 +summary: 'The secret item containing secret metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'SecretItem(*, id: str = None, attributes=None, tags=None, content_type: + str = None, **kwargs)' + parameters: + - name: id + description: Secret identifier. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: content_type + isRequired: true +variables: +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a key backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.secret_item_py3.SecretItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_item_py3.SecretItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_item_py3.SecretItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.secret_item_py3.SecretItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_item_py3.SecretItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.secret_item_py3.SecretItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_item_py3.SecretItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item_py3.yml new file mode 100644 index 00000000..bc2f7ef9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.secret_item_py3 +name: secret_item_py3 +fullName: azure.keyvault.v2016_10_01.models.secret_item_py3 +classes: +- azure.keyvault.v2016_10_01.models.secret_item_py3.SecretItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_properties.SecretProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_properties.SecretProperties.yml new file mode 100644 index 00000000..a9ae57c6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_properties.SecretProperties.yml @@ -0,0 +1,120 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.secret_properties.SecretProperties +name: SecretProperties +fullName: azure.keyvault.v2016_10_01.models.secret_properties.SecretProperties +module: azure.keyvault.v2016_10_01.models.secret_properties +summary: Properties of the key backing a certificate. +constructor: + syntax: SecretProperties(**kwargs) + parameters: + - name: content_type + description: The media type (MIME type). + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.secret_properties.SecretProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_properties.SecretProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_properties.SecretProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.secret_properties.SecretProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_properties.SecretProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.secret_properties.SecretProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_properties.SecretProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_properties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_properties.yml new file mode 100644 index 00000000..bab16875 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_properties.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.secret_properties +name: secret_properties +fullName: azure.keyvault.v2016_10_01.models.secret_properties +classes: +- azure.keyvault.v2016_10_01.models.secret_properties.SecretProperties diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_properties_py3.SecretProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_properties_py3.SecretProperties.yml new file mode 100644 index 00000000..60db5ccf --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_properties_py3.SecretProperties.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.secret_properties_py3.SecretProperties +name: SecretProperties +fullName: azure.keyvault.v2016_10_01.models.secret_properties_py3.SecretProperties +module: azure.keyvault.v2016_10_01.models.secret_properties_py3 +summary: Properties of the key backing a certificate. +constructor: + syntax: 'SecretProperties(*, content_type: str = None, **kwargs)' + parameters: + - name: content_type + description: The media type (MIME type). + isRequired: true + types: + - + keywordOnlyParameters: + - name: content_type + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.secret_properties_py3.SecretProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_properties_py3.SecretProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_properties_py3.SecretProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.secret_properties_py3.SecretProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_properties_py3.SecretProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.secret_properties_py3.SecretProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_properties_py3.SecretProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_properties_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_properties_py3.yml new file mode 100644 index 00000000..0566974c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_properties_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.secret_properties_py3 +name: secret_properties_py3 +fullName: azure.keyvault.v2016_10_01.models.secret_properties_py3 +classes: +- azure.keyvault.v2016_10_01.models.secret_properties_py3.SecretProperties diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_restore_parameters.SecretRestoreParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_restore_parameters.SecretRestoreParameters.yml new file mode 100644 index 00000000..f9214c82 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_restore_parameters.SecretRestoreParameters.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.secret_restore_parameters.SecretRestoreParameters +name: SecretRestoreParameters +fullName: azure.keyvault.v2016_10_01.models.secret_restore_parameters.SecretRestoreParameters +module: azure.keyvault.v2016_10_01.models.secret_restore_parameters +summary: 'The secret restore parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: SecretRestoreParameters(**kwargs) + parameters: + - name: secret_bundle_backup + description: 'Required. The backup blob associated with a + + secret bundle.' + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.secret_restore_parameters.SecretRestoreParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_restore_parameters.SecretRestoreParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_restore_parameters.SecretRestoreParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.secret_restore_parameters.SecretRestoreParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_restore_parameters.SecretRestoreParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.secret_restore_parameters.SecretRestoreParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_restore_parameters.SecretRestoreParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_restore_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_restore_parameters.yml new file mode 100644 index 00000000..86a71840 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_restore_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.secret_restore_parameters +name: secret_restore_parameters +fullName: azure.keyvault.v2016_10_01.models.secret_restore_parameters +classes: +- azure.keyvault.v2016_10_01.models.secret_restore_parameters.SecretRestoreParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3.SecretRestoreParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3.SecretRestoreParameters.yml new file mode 100644 index 00000000..92fc591d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3.SecretRestoreParameters.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3.SecretRestoreParameters +name: SecretRestoreParameters +fullName: azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3.SecretRestoreParameters +module: azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3 +summary: 'The secret restore parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SecretRestoreParameters(*, secret_bundle_backup: bytes, **kwargs)' + parameters: + - name: secret_bundle_backup + description: 'Required. The backup blob associated with a + + secret bundle.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: secret_bundle_backup + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3.SecretRestoreParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3.SecretRestoreParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3.SecretRestoreParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3.SecretRestoreParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3.SecretRestoreParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3.SecretRestoreParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3.SecretRestoreParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3.yml new file mode 100644 index 00000000..f1827cf1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3 +name: secret_restore_parameters_py3 +fullName: azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3 +classes: +- azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3.SecretRestoreParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_set_parameters.SecretSetParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_set_parameters.SecretSetParameters.yml new file mode 100644 index 00000000..68ae6b76 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_set_parameters.SecretSetParameters.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.secret_set_parameters.SecretSetParameters +name: SecretSetParameters +fullName: azure.keyvault.v2016_10_01.models.secret_set_parameters.SecretSetParameters +module: azure.keyvault.v2016_10_01.models.secret_set_parameters +summary: 'The secret set parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: SecretSetParameters(**kwargs) + parameters: + - name: value + description: Required. The value of the secret. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - + - name: secret_attributes + description: The secret management attributes. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.secret_set_parameters.SecretSetParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_set_parameters.SecretSetParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_set_parameters.SecretSetParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.secret_set_parameters.SecretSetParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_set_parameters.SecretSetParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.secret_set_parameters.SecretSetParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_set_parameters.SecretSetParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_set_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_set_parameters.yml new file mode 100644 index 00000000..556ab0b0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_set_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.secret_set_parameters +name: secret_set_parameters +fullName: azure.keyvault.v2016_10_01.models.secret_set_parameters +classes: +- azure.keyvault.v2016_10_01.models.secret_set_parameters.SecretSetParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.SecretSetParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.SecretSetParameters.yml new file mode 100644 index 00000000..79653201 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.SecretSetParameters.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.SecretSetParameters +name: SecretSetParameters +fullName: azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.SecretSetParameters +module: azure.keyvault.v2016_10_01.models.secret_set_parameters_py3 +summary: 'The secret set parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SecretSetParameters(*, value: str, tags=None, content_type: str = None, + secret_attributes=None, **kwargs)' + parameters: + - name: value + description: Required. The value of the secret. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - + - name: secret_attributes + description: The secret management attributes. + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: tags + isRequired: true + - name: content_type + isRequired: true + - name: secret_attributes + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.SecretSetParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.SecretSetParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.SecretSetParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.SecretSetParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.SecretSetParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.SecretSetParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.SecretSetParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.yml new file mode 100644 index 00000000..de104628 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.secret_set_parameters_py3 +name: secret_set_parameters_py3 +fullName: azure.keyvault.v2016_10_01.models.secret_set_parameters_py3 +classes: +- azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.SecretSetParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_update_parameters.SecretUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_update_parameters.SecretUpdateParameters.yml new file mode 100644 index 00000000..a82f7ead --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_update_parameters.SecretUpdateParameters.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.secret_update_parameters.SecretUpdateParameters +name: SecretUpdateParameters +fullName: azure.keyvault.v2016_10_01.models.secret_update_parameters.SecretUpdateParameters +module: azure.keyvault.v2016_10_01.models.secret_update_parameters +summary: The secret update parameters. +constructor: + syntax: SecretUpdateParameters(**kwargs) + parameters: + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - + - name: secret_attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +methods: +- uid: azure.keyvault.v2016_10_01.models.secret_update_parameters.SecretUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_update_parameters.SecretUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_update_parameters.SecretUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.secret_update_parameters.SecretUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_update_parameters.SecretUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.secret_update_parameters.SecretUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_update_parameters.SecretUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_update_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_update_parameters.yml new file mode 100644 index 00000000..4dd728a8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_update_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.secret_update_parameters +name: secret_update_parameters +fullName: azure.keyvault.v2016_10_01.models.secret_update_parameters +classes: +- azure.keyvault.v2016_10_01.models.secret_update_parameters.SecretUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.SecretUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.SecretUpdateParameters.yml new file mode 100644 index 00000000..dbea5923 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.SecretUpdateParameters.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.SecretUpdateParameters +name: SecretUpdateParameters +fullName: azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.SecretUpdateParameters +module: azure.keyvault.v2016_10_01.models.secret_update_parameters_py3 +summary: The secret update parameters. +constructor: + syntax: 'SecretUpdateParameters(*, content_type: str = None, secret_attributes=None, + tags=None, **kwargs)' + parameters: + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - + - name: secret_attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: content_type + isRequired: true + - name: secret_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.SecretUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.SecretUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.SecretUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.SecretUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.SecretUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.SecretUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.SecretUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.yml new file mode 100644 index 00000000..efcbdbe3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.secret_update_parameters_py3 +name: secret_update_parameters_py3 +fullName: azure.keyvault.v2016_10_01.models.secret_update_parameters_py3 +classes: +- azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.SecretUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_attributes.StorageAccountAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_attributes.StorageAccountAttributes.yml new file mode 100644 index 00000000..8cdbc538 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_attributes.StorageAccountAttributes.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.storage_account_attributes.StorageAccountAttributes +name: StorageAccountAttributes +fullName: azure.keyvault.v2016_10_01.models.storage_account_attributes.StorageAccountAttributes +module: azure.keyvault.v2016_10_01.models.storage_account_attributes +summary: 'The storage account management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: StorageAccountAttributes(**kwargs) + parameters: + - name: enabled + description: the enabled state of the object. + isRequired: true + types: + - +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.storage_account_attributes.StorageAccountAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_account_attributes.StorageAccountAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_account_attributes.StorageAccountAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.storage_account_attributes.StorageAccountAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_account_attributes.StorageAccountAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.storage_account_attributes.StorageAccountAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_account_attributes.StorageAccountAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_attributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_attributes.yml new file mode 100644 index 00000000..521f549f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_attributes.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.storage_account_attributes +name: storage_account_attributes +fullName: azure.keyvault.v2016_10_01.models.storage_account_attributes +classes: +- azure.keyvault.v2016_10_01.models.storage_account_attributes.StorageAccountAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_attributes_py3.StorageAccountAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_attributes_py3.StorageAccountAttributes.yml new file mode 100644 index 00000000..e9dd6503 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_attributes_py3.StorageAccountAttributes.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.storage_account_attributes_py3.StorageAccountAttributes +name: StorageAccountAttributes +fullName: azure.keyvault.v2016_10_01.models.storage_account_attributes_py3.StorageAccountAttributes +module: azure.keyvault.v2016_10_01.models.storage_account_attributes_py3 +summary: 'The storage account management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'StorageAccountAttributes(*, enabled: bool = None, **kwargs)' + parameters: + - name: enabled + description: the enabled state of the object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.storage_account_attributes_py3.StorageAccountAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_account_attributes_py3.StorageAccountAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_account_attributes_py3.StorageAccountAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.storage_account_attributes_py3.StorageAccountAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_account_attributes_py3.StorageAccountAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.storage_account_attributes_py3.StorageAccountAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_account_attributes_py3.StorageAccountAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_attributes_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_attributes_py3.yml new file mode 100644 index 00000000..bfb411da --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_attributes_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.storage_account_attributes_py3 +name: storage_account_attributes_py3 +fullName: azure.keyvault.v2016_10_01.models.storage_account_attributes_py3 +classes: +- azure.keyvault.v2016_10_01.models.storage_account_attributes_py3.StorageAccountAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_create_parameters.StorageAccountCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_create_parameters.StorageAccountCreateParameters.yml new file mode 100644 index 00000000..60f4e34c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_create_parameters.StorageAccountCreateParameters.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.storage_account_create_parameters.StorageAccountCreateParameters +name: StorageAccountCreateParameters +fullName: azure.keyvault.v2016_10_01.models.storage_account_create_parameters.StorageAccountCreateParameters +module: azure.keyvault.v2016_10_01.models.storage_account_create_parameters +summary: 'The storage account create parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: StorageAccountCreateParameters(**kwargs) + parameters: + - name: resource_id + description: Required. Storage account resource id. + isRequired: true + types: + - + - name: active_key_name + description: Required. Current active storage account key name. + isRequired: true + types: + - + - name: auto_regenerate_key + description: 'Required. whether keyvault should manage the + + storage account for the user.' + isRequired: true + types: + - + - name: regeneration_period + description: 'The key regeneration time duration specified + + in ISO-8601 format.' + isRequired: true + types: + - + - name: storage_account_attributes + description: The attributes of the storage account. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +methods: +- uid: azure.keyvault.v2016_10_01.models.storage_account_create_parameters.StorageAccountCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_account_create_parameters.StorageAccountCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_account_create_parameters.StorageAccountCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.storage_account_create_parameters.StorageAccountCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_account_create_parameters.StorageAccountCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.storage_account_create_parameters.StorageAccountCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_account_create_parameters.StorageAccountCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_create_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_create_parameters.yml new file mode 100644 index 00000000..7b08bfb5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_create_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.storage_account_create_parameters +name: storage_account_create_parameters +fullName: azure.keyvault.v2016_10_01.models.storage_account_create_parameters +classes: +- azure.keyvault.v2016_10_01.models.storage_account_create_parameters.StorageAccountCreateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.yml new file mode 100644 index 00000000..2898b239 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.yml @@ -0,0 +1,167 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.StorageAccountCreateParameters +name: StorageAccountCreateParameters +fullName: azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.StorageAccountCreateParameters +module: azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3 +summary: 'The storage account create parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'StorageAccountCreateParameters(*, resource_id: str, active_key_name: str, + auto_regenerate_key: bool, regeneration_period: str = None, storage_account_attributes=None, + tags=None, **kwargs)' + parameters: + - name: resource_id + description: Required. Storage account resource id. + isRequired: true + types: + - + - name: active_key_name + description: Required. Current active storage account key name. + isRequired: true + types: + - + - name: auto_regenerate_key + description: 'Required. whether keyvault should manage the + + storage account for the user.' + isRequired: true + types: + - + - name: regeneration_period + description: 'The key regeneration time duration specified + + in ISO-8601 format.' + isRequired: true + types: + - + - name: storage_account_attributes + description: The attributes of the storage account. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: resource_id + isRequired: true + - name: active_key_name + isRequired: true + - name: auto_regenerate_key + isRequired: true + - name: regeneration_period + isRequired: true + - name: storage_account_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.yml new file mode 100644 index 00000000..b148720a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3 +name: storage_account_create_parameters_py3 +fullName: azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3 +classes: +- azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.StorageAccountCreateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item.StorageAccountItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item.StorageAccountItem.yml new file mode 100644 index 00000000..8d632e04 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item.StorageAccountItem.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.storage_account_item.StorageAccountItem +name: StorageAccountItem +fullName: azure.keyvault.v2016_10_01.models.storage_account_item.StorageAccountItem +module: azure.keyvault.v2016_10_01.models.storage_account_item +summary: 'The storage account item containing storage account metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: StorageAccountItem(**kwargs) +variables: +- description: Storage identifier. + name: id + types: + - +- description: Storage account resource Id. + name: resource_id + types: + - +- description: The storage account management attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs. + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v2016_10_01.models.storage_account_item.StorageAccountItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_account_item.StorageAccountItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_account_item.StorageAccountItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.storage_account_item.StorageAccountItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_account_item.StorageAccountItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.storage_account_item.StorageAccountItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_account_item.StorageAccountItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item.yml new file mode 100644 index 00000000..b4e1498a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.storage_account_item +name: storage_account_item +fullName: azure.keyvault.v2016_10_01.models.storage_account_item +classes: +- azure.keyvault.v2016_10_01.models.storage_account_item.StorageAccountItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item_paged.StorageAccountItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item_paged.StorageAccountItemPaged.yml new file mode 100644 index 00000000..91cf9722 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item_paged.StorageAccountItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.storage_account_item_paged.StorageAccountItemPaged +name: StorageAccountItemPaged +fullName: azure.keyvault.v2016_10_01.models.storage_account_item_paged.StorageAccountItemPaged +module: azure.keyvault.v2016_10_01.models.storage_account_item_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: StorageAccountItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v2016_10_01.models.storage_account_item_paged.StorageAccountItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v2016_10_01.models.storage_account_item_paged.StorageAccountItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v2016_10_01.models.storage_account_item_paged.StorageAccountItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_account_item_paged.StorageAccountItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_account_item_paged.StorageAccountItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v2016_10_01.models.storage_account_item_paged.StorageAccountItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v2016_10_01.models.storage_account_item_paged.StorageAccountItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item_paged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item_paged.yml new file mode 100644 index 00000000..6ddabf4d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.storage_account_item_paged +name: storage_account_item_paged +fullName: azure.keyvault.v2016_10_01.models.storage_account_item_paged +classes: +- azure.keyvault.v2016_10_01.models.storage_account_item_paged.StorageAccountItemPaged diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item_py3.StorageAccountItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item_py3.StorageAccountItem.yml new file mode 100644 index 00000000..8f2b7a28 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item_py3.StorageAccountItem.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.storage_account_item_py3.StorageAccountItem +name: StorageAccountItem +fullName: azure.keyvault.v2016_10_01.models.storage_account_item_py3.StorageAccountItem +module: azure.keyvault.v2016_10_01.models.storage_account_item_py3 +summary: 'The storage account item containing storage account metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: StorageAccountItem(**kwargs) +variables: +- description: Storage identifier. + name: id + types: + - +- description: Storage account resource Id. + name: resource_id + types: + - +- description: The storage account management attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs. + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v2016_10_01.models.storage_account_item_py3.StorageAccountItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_account_item_py3.StorageAccountItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_account_item_py3.StorageAccountItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.storage_account_item_py3.StorageAccountItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_account_item_py3.StorageAccountItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.storage_account_item_py3.StorageAccountItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_account_item_py3.StorageAccountItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item_py3.yml new file mode 100644 index 00000000..01984031 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.storage_account_item_py3 +name: storage_account_item_py3 +fullName: azure.keyvault.v2016_10_01.models.storage_account_item_py3 +classes: +- azure.keyvault.v2016_10_01.models.storage_account_item_py3.StorageAccountItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters.yml new file mode 100644 index 00000000..f434d50c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters +name: StorageAccountRegenerteKeyParameters +fullName: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters +module: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters +summary: 'The storage account key regenerate parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: StorageAccountRegenerteKeyParameters(**kwargs) + parameters: + - name: key_name + description: Required. The storage account key name. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters.yml new file mode 100644 index 00000000..e430f067 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters +name: storage_account_regenerte_key_parameters +fullName: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters +classes: +- azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters.yml new file mode 100644 index 00000000..eec52b32 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters +name: StorageAccountRegenerteKeyParameters +fullName: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters +module: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3 +summary: 'The storage account key regenerate parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'StorageAccountRegenerteKeyParameters(*, key_name: str, **kwargs)' + parameters: + - name: key_name + description: Required. The storage account key name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: key_name + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3.yml new file mode 100644 index 00000000..63acb793 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3 +name: storage_account_regenerte_key_parameters_py3 +fullName: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3 +classes: +- azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_update_parameters.StorageAccountUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_update_parameters.StorageAccountUpdateParameters.yml new file mode 100644 index 00000000..23dbf6ce --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_update_parameters.StorageAccountUpdateParameters.yml @@ -0,0 +1,144 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.storage_account_update_parameters.StorageAccountUpdateParameters +name: StorageAccountUpdateParameters +fullName: azure.keyvault.v2016_10_01.models.storage_account_update_parameters.StorageAccountUpdateParameters +module: azure.keyvault.v2016_10_01.models.storage_account_update_parameters +summary: The storage account update parameters. +constructor: + syntax: StorageAccountUpdateParameters(**kwargs) + parameters: + - name: active_key_name + description: The current active storage account key name. + isRequired: true + types: + - + - name: auto_regenerate_key + description: 'whether keyvault should manage the storage + + account for the user.' + isRequired: true + types: + - + - name: regeneration_period + description: 'The key regeneration time duration specified + + in ISO-8601 format.' + isRequired: true + types: + - + - name: storage_account_attributes + description: The attributes of the storage account. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +methods: +- uid: azure.keyvault.v2016_10_01.models.storage_account_update_parameters.StorageAccountUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_account_update_parameters.StorageAccountUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_account_update_parameters.StorageAccountUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.storage_account_update_parameters.StorageAccountUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_account_update_parameters.StorageAccountUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.storage_account_update_parameters.StorageAccountUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_account_update_parameters.StorageAccountUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_update_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_update_parameters.yml new file mode 100644 index 00000000..4034c3da --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_update_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.storage_account_update_parameters +name: storage_account_update_parameters +fullName: azure.keyvault.v2016_10_01.models.storage_account_update_parameters +classes: +- azure.keyvault.v2016_10_01.models.storage_account_update_parameters.StorageAccountUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.yml new file mode 100644 index 00000000..0b6151a1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters +name: StorageAccountUpdateParameters +fullName: azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters +module: azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3 +summary: The storage account update parameters. +constructor: + syntax: 'StorageAccountUpdateParameters(*, active_key_name: str = None, auto_regenerate_key: + bool = None, regeneration_period: str = None, storage_account_attributes=None, + tags=None, **kwargs)' + parameters: + - name: active_key_name + description: The current active storage account key name. + isRequired: true + types: + - + - name: auto_regenerate_key + description: 'whether keyvault should manage the storage + + account for the user.' + isRequired: true + types: + - + - name: regeneration_period + description: 'The key regeneration time duration specified + + in ISO-8601 format.' + isRequired: true + types: + - + - name: storage_account_attributes + description: The attributes of the storage account. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: active_key_name + isRequired: true + - name: auto_regenerate_key + isRequired: true + - name: regeneration_period + isRequired: true + - name: storage_account_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.yml new file mode 100644 index 00000000..6ac8e753 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3 +name: storage_account_update_parameters_py3 +fullName: azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3 +classes: +- azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_bundle.StorageBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_bundle.StorageBundle.yml new file mode 100644 index 00000000..18c2f55e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_bundle.StorageBundle.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.storage_bundle.StorageBundle +name: StorageBundle +fullName: azure.keyvault.v2016_10_01.models.storage_bundle.StorageBundle +module: azure.keyvault.v2016_10_01.models.storage_bundle +summary: 'A Storage account bundle consists of key vault storage account details plus + + its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: StorageBundle(**kwargs) +variables: +- description: The storage account id. + name: id + types: + - +- description: The storage account resource id. + name: resource_id + types: + - +- description: The current active storage account key name. + name: active_key_name + types: + - +- description: 'whether keyvault should manage the storage + + account for the user.' + name: auto_regenerate_key + types: + - +- description: 'The key regeneration time duration specified in + + ISO-8601 format.' + name: regeneration_period + types: + - +- description: The storage account attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v2016_10_01.models.storage_bundle.StorageBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_bundle.StorageBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_bundle.StorageBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.storage_bundle.StorageBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_bundle.StorageBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.storage_bundle.StorageBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_bundle.StorageBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_bundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_bundle.yml new file mode 100644 index 00000000..f11c6538 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_bundle.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.storage_bundle +name: storage_bundle +fullName: azure.keyvault.v2016_10_01.models.storage_bundle +classes: +- azure.keyvault.v2016_10_01.models.storage_bundle.StorageBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_bundle_py3.StorageBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_bundle_py3.StorageBundle.yml new file mode 100644 index 00000000..d7c28548 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_bundle_py3.StorageBundle.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.storage_bundle_py3.StorageBundle +name: StorageBundle +fullName: azure.keyvault.v2016_10_01.models.storage_bundle_py3.StorageBundle +module: azure.keyvault.v2016_10_01.models.storage_bundle_py3 +summary: 'A Storage account bundle consists of key vault storage account details plus + + its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: StorageBundle(**kwargs) +variables: +- description: The storage account id. + name: id + types: + - +- description: The storage account resource id. + name: resource_id + types: + - +- description: The current active storage account key name. + name: active_key_name + types: + - +- description: 'whether keyvault should manage the storage + + account for the user.' + name: auto_regenerate_key + types: + - +- description: 'The key regeneration time duration specified in + + ISO-8601 format.' + name: regeneration_period + types: + - +- description: The storage account attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v2016_10_01.models.storage_bundle_py3.StorageBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_bundle_py3.StorageBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_bundle_py3.StorageBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.storage_bundle_py3.StorageBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.storage_bundle_py3.StorageBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.storage_bundle_py3.StorageBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.storage_bundle_py3.StorageBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_bundle_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_bundle_py3.yml new file mode 100644 index 00000000..daed269b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_bundle_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.storage_bundle_py3 +name: storage_bundle_py3 +fullName: azure.keyvault.v2016_10_01.models.storage_bundle_py3 +classes: +- azure.keyvault.v2016_10_01.models.storage_bundle_py3.StorageBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.subject_alternative_names.SubjectAlternativeNames.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.subject_alternative_names.SubjectAlternativeNames.yml new file mode 100644 index 00000000..059e6f78 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.subject_alternative_names.SubjectAlternativeNames.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.subject_alternative_names.SubjectAlternativeNames +name: SubjectAlternativeNames +fullName: azure.keyvault.v2016_10_01.models.subject_alternative_names.SubjectAlternativeNames +module: azure.keyvault.v2016_10_01.models.subject_alternative_names +summary: The subject alternate names of a X509 object. +constructor: + syntax: SubjectAlternativeNames(**kwargs) + parameters: + - name: emails + description: Email addresses. + isRequired: true + types: + - [] + - name: dns_names + description: Domain names. + isRequired: true + types: + - [] + - name: upns + description: User principal names. + isRequired: true + types: + - [] +methods: +- uid: azure.keyvault.v2016_10_01.models.subject_alternative_names.SubjectAlternativeNames.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.subject_alternative_names.SubjectAlternativeNames.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.subject_alternative_names.SubjectAlternativeNames.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.subject_alternative_names.SubjectAlternativeNames.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.subject_alternative_names.SubjectAlternativeNames.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.subject_alternative_names.SubjectAlternativeNames.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.subject_alternative_names.SubjectAlternativeNames.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.subject_alternative_names.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.subject_alternative_names.yml new file mode 100644 index 00000000..aa7a71f9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.subject_alternative_names.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.subject_alternative_names +name: subject_alternative_names +fullName: azure.keyvault.v2016_10_01.models.subject_alternative_names +classes: +- azure.keyvault.v2016_10_01.models.subject_alternative_names.SubjectAlternativeNames diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.SubjectAlternativeNames.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.SubjectAlternativeNames.yml new file mode 100644 index 00000000..b609a3c0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.SubjectAlternativeNames.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.SubjectAlternativeNames +name: SubjectAlternativeNames +fullName: azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.SubjectAlternativeNames +module: azure.keyvault.v2016_10_01.models.subject_alternative_names_py3 +summary: The subject alternate names of a X509 object. +constructor: + syntax: SubjectAlternativeNames(*, emails=None, dns_names=None, upns=None, **kwargs) + parameters: + - name: emails + description: Email addresses. + isRequired: true + types: + - [] + - name: dns_names + description: Domain names. + isRequired: true + types: + - [] + - name: upns + description: User principal names. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: emails + isRequired: true + - name: dns_names + isRequired: true + - name: upns + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.SubjectAlternativeNames.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.SubjectAlternativeNames.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.SubjectAlternativeNames.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.SubjectAlternativeNames.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.SubjectAlternativeNames.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.SubjectAlternativeNames.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.SubjectAlternativeNames.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.yml new file mode 100644 index 00000000..00d93122 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.subject_alternative_names_py3 +name: subject_alternative_names_py3 +fullName: azure.keyvault.v2016_10_01.models.subject_alternative_names_py3 +classes: +- azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.SubjectAlternativeNames diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.trigger.Trigger.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.trigger.Trigger.yml new file mode 100644 index 00000000..d6732741 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.trigger.Trigger.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.trigger.Trigger +name: Trigger +fullName: azure.keyvault.v2016_10_01.models.trigger.Trigger +module: azure.keyvault.v2016_10_01.models.trigger +summary: A condition to be satisfied for an action to be executed. +constructor: + syntax: Trigger(**kwargs) + parameters: + - name: lifetime_percentage + description: 'Percentage of lifetime at which to trigger. + + Value should be between 1 and 99.' + isRequired: true + types: + - + - name: days_before_expiry + description: 'Days before expiry to attempt renewal. Value + + should be between 1 and validity_in_months multiplied by 27. If + + validity_in_months is 36, then value should be between 1 and 972 (36 * + + 27).' + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.trigger.Trigger.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.trigger.Trigger.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.trigger.Trigger.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.trigger.Trigger.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.trigger.Trigger.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.trigger.Trigger.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.trigger.Trigger.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.trigger.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.trigger.yml new file mode 100644 index 00000000..bcba5bdd --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.trigger.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.trigger +name: trigger +fullName: azure.keyvault.v2016_10_01.models.trigger +classes: +- azure.keyvault.v2016_10_01.models.trigger.Trigger diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.trigger_py3.Trigger.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.trigger_py3.Trigger.yml new file mode 100644 index 00000000..6a742f88 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.trigger_py3.Trigger.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.trigger_py3.Trigger +name: Trigger +fullName: azure.keyvault.v2016_10_01.models.trigger_py3.Trigger +module: azure.keyvault.v2016_10_01.models.trigger_py3 +summary: A condition to be satisfied for an action to be executed. +constructor: + syntax: 'Trigger(*, lifetime_percentage: int = None, days_before_expiry: int = None, + **kwargs)' + parameters: + - name: lifetime_percentage + description: 'Percentage of lifetime at which to trigger. + + Value should be between 1 and 99.' + isRequired: true + types: + - + - name: days_before_expiry + description: 'Days before expiry to attempt renewal. Value + + should be between 1 and validity_in_months multiplied by 27. If + + validity_in_months is 36, then value should be between 1 and 972 (36 * + + 27).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: lifetime_percentage + isRequired: true + - name: days_before_expiry + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.trigger_py3.Trigger.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.trigger_py3.Trigger.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.trigger_py3.Trigger.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.trigger_py3.Trigger.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.trigger_py3.Trigger.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.trigger_py3.Trigger.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.trigger_py3.Trigger.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.trigger_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.trigger_py3.yml new file mode 100644 index 00000000..9ac17559 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.trigger_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.trigger_py3 +name: trigger_py3 +fullName: azure.keyvault.v2016_10_01.models.trigger_py3 +classes: +- azure.keyvault.v2016_10_01.models.trigger_py3.Trigger diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.x509_certificate_properties.X509CertificateProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.x509_certificate_properties.X509CertificateProperties.yml new file mode 100644 index 00000000..94ce2361 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.x509_certificate_properties.X509CertificateProperties.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.x509_certificate_properties.X509CertificateProperties +name: X509CertificateProperties +fullName: azure.keyvault.v2016_10_01.models.x509_certificate_properties.X509CertificateProperties +module: azure.keyvault.v2016_10_01.models.x509_certificate_properties +summary: Properties of the X509 component of a certificate. +constructor: + syntax: X509CertificateProperties(**kwargs) + parameters: + - name: subject + description: 'The subject name. Should be a valid X509 distinguished + + Name.' + isRequired: true + types: + - + - name: ekus + description: The enhanced key usage. + isRequired: true + types: + - [] + - name: subject_alternative_names + description: The subject alternative names. + isRequired: true + types: + - + - name: key_usage + description: List of key usages. + isRequired: true + types: + - [ + - ] + - name: validity_in_months + description: 'The duration that the ceritifcate is valid in + + months.' + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v2016_10_01.models.x509_certificate_properties.X509CertificateProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.x509_certificate_properties.X509CertificateProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.x509_certificate_properties.X509CertificateProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.x509_certificate_properties.X509CertificateProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.x509_certificate_properties.X509CertificateProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.x509_certificate_properties.X509CertificateProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.x509_certificate_properties.X509CertificateProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.x509_certificate_properties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.x509_certificate_properties.yml new file mode 100644 index 00000000..66f88947 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.x509_certificate_properties.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.x509_certificate_properties +name: x509_certificate_properties +fullName: azure.keyvault.v2016_10_01.models.x509_certificate_properties +classes: +- azure.keyvault.v2016_10_01.models.x509_certificate_properties.X509CertificateProperties diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.X509CertificateProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.X509CertificateProperties.yml new file mode 100644 index 00000000..c42da771 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.X509CertificateProperties.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.X509CertificateProperties +name: X509CertificateProperties +fullName: azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.X509CertificateProperties +module: azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3 +summary: Properties of the X509 component of a certificate. +constructor: + syntax: 'X509CertificateProperties(*, subject: str = None, ekus=None, subject_alternative_names=None, + key_usage=None, validity_in_months: int = None, **kwargs)' + parameters: + - name: subject + description: 'The subject name. Should be a valid X509 distinguished + + Name.' + isRequired: true + types: + - + - name: ekus + description: The enhanced key usage. + isRequired: true + types: + - [] + - name: subject_alternative_names + description: The subject alternative names. + isRequired: true + types: + - + - name: key_usage + description: List of key usages. + isRequired: true + types: + - [ + - ] + - name: validity_in_months + description: 'The duration that the ceritifcate is valid in + + months.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: subject + isRequired: true + - name: ekus + isRequired: true + - name: subject_alternative_names + isRequired: true + - name: key_usage + isRequired: true + - name: validity_in_months + isRequired: true +methods: +- uid: azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.X509CertificateProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.X509CertificateProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.X509CertificateProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.X509CertificateProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.X509CertificateProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.X509CertificateProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.X509CertificateProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.yml new file mode 100644 index 00000000..b4d29172 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3 +name: x509_certificate_properties_py3 +fullName: azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3 +classes: +- azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.X509CertificateProperties diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.yml new file mode 100644 index 00000000..c4f3a3d5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.yml @@ -0,0 +1,246 @@ +### YamlMime:PythonPackage +uid: azure.keyvault.v2016_10_01.models +name: models +fullName: azure.keyvault.v2016_10_01.models +type: import +classes: +- azure.keyvault.v2016_10_01.models.Action +- azure.keyvault.v2016_10_01.models.AdministratorDetails +- azure.keyvault.v2016_10_01.models.Attributes +- azure.keyvault.v2016_10_01.models.BackupKeyResult +- azure.keyvault.v2016_10_01.models.BackupSecretResult +- azure.keyvault.v2016_10_01.models.CertificateAttributes +- azure.keyvault.v2016_10_01.models.CertificateBundle +- azure.keyvault.v2016_10_01.models.CertificateCreateParameters +- azure.keyvault.v2016_10_01.models.CertificateImportParameters +- azure.keyvault.v2016_10_01.models.CertificateIssuerItem +- azure.keyvault.v2016_10_01.models.CertificateIssuerItemPaged +- azure.keyvault.v2016_10_01.models.CertificateIssuerSetParameters +- azure.keyvault.v2016_10_01.models.CertificateIssuerUpdateParameters +- azure.keyvault.v2016_10_01.models.CertificateItem +- azure.keyvault.v2016_10_01.models.CertificateItemPaged +- azure.keyvault.v2016_10_01.models.CertificateMergeParameters +- azure.keyvault.v2016_10_01.models.CertificateOperation +- azure.keyvault.v2016_10_01.models.CertificateOperationUpdateParameter +- azure.keyvault.v2016_10_01.models.CertificatePolicy +- azure.keyvault.v2016_10_01.models.CertificateUpdateParameters +- azure.keyvault.v2016_10_01.models.Contact +- azure.keyvault.v2016_10_01.models.Contacts +- azure.keyvault.v2016_10_01.models.DeletedCertificateBundle +- azure.keyvault.v2016_10_01.models.DeletedCertificateItem +- azure.keyvault.v2016_10_01.models.DeletedCertificateItemPaged +- azure.keyvault.v2016_10_01.models.DeletedKeyBundle +- azure.keyvault.v2016_10_01.models.DeletedKeyItem +- azure.keyvault.v2016_10_01.models.DeletedKeyItemPaged +- azure.keyvault.v2016_10_01.models.DeletedSecretBundle +- azure.keyvault.v2016_10_01.models.DeletedSecretItem +- azure.keyvault.v2016_10_01.models.DeletedSecretItemPaged +- azure.keyvault.v2016_10_01.models.Error +- azure.keyvault.v2016_10_01.models.IssuerAttributes +- azure.keyvault.v2016_10_01.models.IssuerBundle +- azure.keyvault.v2016_10_01.models.IssuerCredentials +- azure.keyvault.v2016_10_01.models.IssuerParameters +- azure.keyvault.v2016_10_01.models.JsonWebKey +- azure.keyvault.v2016_10_01.models.KeyAttributes +- azure.keyvault.v2016_10_01.models.KeyBundle +- azure.keyvault.v2016_10_01.models.KeyCreateParameters +- azure.keyvault.v2016_10_01.models.KeyImportParameters +- azure.keyvault.v2016_10_01.models.KeyItem +- azure.keyvault.v2016_10_01.models.KeyItemPaged +- azure.keyvault.v2016_10_01.models.KeyOperationResult +- azure.keyvault.v2016_10_01.models.KeyOperationsParameters +- azure.keyvault.v2016_10_01.models.KeyProperties +- azure.keyvault.v2016_10_01.models.KeyRestoreParameters +- azure.keyvault.v2016_10_01.models.KeySignParameters +- azure.keyvault.v2016_10_01.models.KeyUpdateParameters +- azure.keyvault.v2016_10_01.models.KeyVaultError +- azure.keyvault.v2016_10_01.models.KeyVaultErrorException +- azure.keyvault.v2016_10_01.models.KeyVerifyParameters +- azure.keyvault.v2016_10_01.models.KeyVerifyResult +- azure.keyvault.v2016_10_01.models.LifetimeAction +- azure.keyvault.v2016_10_01.models.OrganizationDetails +- azure.keyvault.v2016_10_01.models.PendingCertificateSigningRequestResult +- azure.keyvault.v2016_10_01.models.SasDefinitionAttributes +- azure.keyvault.v2016_10_01.models.SasDefinitionBundle +- azure.keyvault.v2016_10_01.models.SasDefinitionCreateParameters +- azure.keyvault.v2016_10_01.models.SasDefinitionItem +- azure.keyvault.v2016_10_01.models.SasDefinitionItemPaged +- azure.keyvault.v2016_10_01.models.SasDefinitionUpdateParameters +- azure.keyvault.v2016_10_01.models.SecretAttributes +- azure.keyvault.v2016_10_01.models.SecretBundle +- azure.keyvault.v2016_10_01.models.SecretItem +- azure.keyvault.v2016_10_01.models.SecretItemPaged +- azure.keyvault.v2016_10_01.models.SecretProperties +- azure.keyvault.v2016_10_01.models.SecretRestoreParameters +- azure.keyvault.v2016_10_01.models.SecretSetParameters +- azure.keyvault.v2016_10_01.models.SecretUpdateParameters +- azure.keyvault.v2016_10_01.models.StorageAccountAttributes +- azure.keyvault.v2016_10_01.models.StorageAccountCreateParameters +- azure.keyvault.v2016_10_01.models.StorageAccountItem +- azure.keyvault.v2016_10_01.models.StorageAccountItemPaged +- azure.keyvault.v2016_10_01.models.StorageAccountRegenerteKeyParameters +- azure.keyvault.v2016_10_01.models.StorageAccountUpdateParameters +- azure.keyvault.v2016_10_01.models.StorageBundle +- azure.keyvault.v2016_10_01.models.SubjectAlternativeNames +- azure.keyvault.v2016_10_01.models.Trigger +- azure.keyvault.v2016_10_01.models.X509CertificateProperties +modules: +- azure.keyvault.v2016_10_01.models.action +- azure.keyvault.v2016_10_01.models.action_py3 +- azure.keyvault.v2016_10_01.models.administrator_details +- azure.keyvault.v2016_10_01.models.administrator_details_py3 +- azure.keyvault.v2016_10_01.models.attributes +- azure.keyvault.v2016_10_01.models.attributes_py3 +- azure.keyvault.v2016_10_01.models.backup_key_result +- azure.keyvault.v2016_10_01.models.backup_key_result_py3 +- azure.keyvault.v2016_10_01.models.backup_secret_result +- azure.keyvault.v2016_10_01.models.backup_secret_result_py3 +- azure.keyvault.v2016_10_01.models.certificate_attributes +- azure.keyvault.v2016_10_01.models.certificate_attributes_py3 +- azure.keyvault.v2016_10_01.models.certificate_bundle +- azure.keyvault.v2016_10_01.models.certificate_bundle_py3 +- azure.keyvault.v2016_10_01.models.certificate_create_parameters +- azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3 +- azure.keyvault.v2016_10_01.models.certificate_import_parameters +- azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3 +- azure.keyvault.v2016_10_01.models.certificate_issuer_item +- azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged +- azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3 +- azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters +- azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3 +- azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters +- azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3 +- azure.keyvault.v2016_10_01.models.certificate_item +- azure.keyvault.v2016_10_01.models.certificate_item_paged +- azure.keyvault.v2016_10_01.models.certificate_item_py3 +- azure.keyvault.v2016_10_01.models.certificate_merge_parameters +- azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3 +- azure.keyvault.v2016_10_01.models.certificate_operation +- azure.keyvault.v2016_10_01.models.certificate_operation_py3 +- azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter +- azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3 +- azure.keyvault.v2016_10_01.models.certificate_policy +- azure.keyvault.v2016_10_01.models.certificate_policy_py3 +- azure.keyvault.v2016_10_01.models.certificate_update_parameters +- azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3 +- azure.keyvault.v2016_10_01.models.contact +- azure.keyvault.v2016_10_01.models.contact_py3 +- azure.keyvault.v2016_10_01.models.contacts +- azure.keyvault.v2016_10_01.models.contacts_py3 +- azure.keyvault.v2016_10_01.models.deleted_certificate_bundle +- azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3 +- azure.keyvault.v2016_10_01.models.deleted_certificate_item +- azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged +- azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3 +- azure.keyvault.v2016_10_01.models.deleted_key_bundle +- azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3 +- azure.keyvault.v2016_10_01.models.deleted_key_item +- azure.keyvault.v2016_10_01.models.deleted_key_item_paged +- azure.keyvault.v2016_10_01.models.deleted_key_item_py3 +- azure.keyvault.v2016_10_01.models.deleted_secret_bundle +- azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3 +- azure.keyvault.v2016_10_01.models.deleted_secret_item +- azure.keyvault.v2016_10_01.models.deleted_secret_item_paged +- azure.keyvault.v2016_10_01.models.deleted_secret_item_py3 +- azure.keyvault.v2016_10_01.models.error +- azure.keyvault.v2016_10_01.models.error_py3 +- azure.keyvault.v2016_10_01.models.issuer_attributes +- azure.keyvault.v2016_10_01.models.issuer_attributes_py3 +- azure.keyvault.v2016_10_01.models.issuer_bundle +- azure.keyvault.v2016_10_01.models.issuer_bundle_py3 +- azure.keyvault.v2016_10_01.models.issuer_credentials +- azure.keyvault.v2016_10_01.models.issuer_credentials_py3 +- azure.keyvault.v2016_10_01.models.issuer_parameters +- azure.keyvault.v2016_10_01.models.issuer_parameters_py3 +- azure.keyvault.v2016_10_01.models.json_web_key +- azure.keyvault.v2016_10_01.models.json_web_key_py3 +- azure.keyvault.v2016_10_01.models.key_attributes +- azure.keyvault.v2016_10_01.models.key_attributes_py3 +- azure.keyvault.v2016_10_01.models.key_bundle +- azure.keyvault.v2016_10_01.models.key_bundle_py3 +- azure.keyvault.v2016_10_01.models.key_create_parameters +- azure.keyvault.v2016_10_01.models.key_create_parameters_py3 +- azure.keyvault.v2016_10_01.models.key_import_parameters +- azure.keyvault.v2016_10_01.models.key_import_parameters_py3 +- azure.keyvault.v2016_10_01.models.key_item +- azure.keyvault.v2016_10_01.models.key_item_paged +- azure.keyvault.v2016_10_01.models.key_item_py3 +- azure.keyvault.v2016_10_01.models.key_operation_result +- azure.keyvault.v2016_10_01.models.key_operation_result_py3 +- azure.keyvault.v2016_10_01.models.key_operations_parameters +- azure.keyvault.v2016_10_01.models.key_operations_parameters_py3 +- azure.keyvault.v2016_10_01.models.key_properties +- azure.keyvault.v2016_10_01.models.key_properties_py3 +- azure.keyvault.v2016_10_01.models.key_restore_parameters +- azure.keyvault.v2016_10_01.models.key_restore_parameters_py3 +- azure.keyvault.v2016_10_01.models.key_sign_parameters +- azure.keyvault.v2016_10_01.models.key_sign_parameters_py3 +- azure.keyvault.v2016_10_01.models.key_update_parameters +- azure.keyvault.v2016_10_01.models.key_update_parameters_py3 +- azure.keyvault.v2016_10_01.models.key_vault_client_enums +- azure.keyvault.v2016_10_01.models.key_vault_error +- azure.keyvault.v2016_10_01.models.key_vault_error_py3 +- azure.keyvault.v2016_10_01.models.key_verify_parameters +- azure.keyvault.v2016_10_01.models.key_verify_parameters_py3 +- azure.keyvault.v2016_10_01.models.key_verify_result +- azure.keyvault.v2016_10_01.models.key_verify_result_py3 +- azure.keyvault.v2016_10_01.models.lifetime_action +- azure.keyvault.v2016_10_01.models.lifetime_action_py3 +- azure.keyvault.v2016_10_01.models.organization_details +- azure.keyvault.v2016_10_01.models.organization_details_py3 +- azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result +- azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3 +- azure.keyvault.v2016_10_01.models.sas_definition_attributes +- azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3 +- azure.keyvault.v2016_10_01.models.sas_definition_bundle +- azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3 +- azure.keyvault.v2016_10_01.models.sas_definition_create_parameters +- azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3 +- azure.keyvault.v2016_10_01.models.sas_definition_item +- azure.keyvault.v2016_10_01.models.sas_definition_item_paged +- azure.keyvault.v2016_10_01.models.sas_definition_item_py3 +- azure.keyvault.v2016_10_01.models.sas_definition_update_parameters +- azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3 +- azure.keyvault.v2016_10_01.models.secret_attributes +- azure.keyvault.v2016_10_01.models.secret_attributes_py3 +- azure.keyvault.v2016_10_01.models.secret_bundle +- azure.keyvault.v2016_10_01.models.secret_bundle_py3 +- azure.keyvault.v2016_10_01.models.secret_item +- azure.keyvault.v2016_10_01.models.secret_item_paged +- azure.keyvault.v2016_10_01.models.secret_item_py3 +- azure.keyvault.v2016_10_01.models.secret_properties +- azure.keyvault.v2016_10_01.models.secret_properties_py3 +- azure.keyvault.v2016_10_01.models.secret_restore_parameters +- azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3 +- azure.keyvault.v2016_10_01.models.secret_set_parameters +- azure.keyvault.v2016_10_01.models.secret_set_parameters_py3 +- azure.keyvault.v2016_10_01.models.secret_update_parameters +- azure.keyvault.v2016_10_01.models.secret_update_parameters_py3 +- azure.keyvault.v2016_10_01.models.storage_account_attributes +- azure.keyvault.v2016_10_01.models.storage_account_attributes_py3 +- azure.keyvault.v2016_10_01.models.storage_account_create_parameters +- azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3 +- azure.keyvault.v2016_10_01.models.storage_account_item +- azure.keyvault.v2016_10_01.models.storage_account_item_paged +- azure.keyvault.v2016_10_01.models.storage_account_item_py3 +- azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters +- azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3 +- azure.keyvault.v2016_10_01.models.storage_account_update_parameters +- azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3 +- azure.keyvault.v2016_10_01.models.storage_bundle +- azure.keyvault.v2016_10_01.models.storage_bundle_py3 +- azure.keyvault.v2016_10_01.models.subject_alternative_names +- azure.keyvault.v2016_10_01.models.subject_alternative_names_py3 +- azure.keyvault.v2016_10_01.models.trigger +- azure.keyvault.v2016_10_01.models.trigger_py3 +- azure.keyvault.v2016_10_01.models.x509_certificate_properties +- azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3 +enums: +- azure.keyvault.v2016_10_01.models.ActionType +- azure.keyvault.v2016_10_01.models.DeletionRecoveryLevel +- azure.keyvault.v2016_10_01.models.JsonWebKeyCurveName +- azure.keyvault.v2016_10_01.models.JsonWebKeyEncryptionAlgorithm +- azure.keyvault.v2016_10_01.models.JsonWebKeyOperation +- azure.keyvault.v2016_10_01.models.JsonWebKeySignatureAlgorithm +- azure.keyvault.v2016_10_01.models.JsonWebKeyType +- azure.keyvault.v2016_10_01.models.KeyUsageType diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.version.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.version.yml new file mode 100644 index 00000000..bae7a68f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v2016_10_01.version +name: version +fullName: azure.keyvault.v2016_10_01.version diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.yml new file mode 100644 index 00000000..9bacc574 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonPackage +uid: azure.keyvault.v2016_10_01 +name: v2016_10_01 +fullName: azure.keyvault.v2016_10_01 +type: import +classes: +- azure.keyvault.v2016_10_01.KeyVaultClient +packages: +- azure.keyvault.v2016_10_01.models +modules: +- azure.keyvault.v2016_10_01.key_vault_client +- azure.keyvault.v2016_10_01.version diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.KeyVaultClient.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.KeyVaultClient.yml new file mode 100644 index 00000000..b883a94d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.KeyVaultClient.yml @@ -0,0 +1,4611 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.KeyVaultClient +name: KeyVaultClient +fullName: azure.keyvault.v7_0.KeyVaultClient +module: azure.keyvault.v7_0 +summary: The key vault client performs cryptographic key operations and vault operations + against the Key Vault service. +constructor: + syntax: KeyVaultClient(credentials) + parameters: + - name: credentials + description: Credentials needed for the client to connect to Azure. + isRequired: true + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +methods: +- uid: azure.keyvault.v7_0.KeyVaultClient.backup_certificate + name: backup_certificate + summary: 'Backs up the specified certificate. + + + Requests that a backup of the specified certificate be downloaded to + + the client. All versions of the certificate will be downloaded. This + + operation requires the certificates/backup permission.' + signature: backup_certificate(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: BackupCertificateResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.backup_key + name: backup_key + summary: 'Requests that a backup of the specified key be downloaded to the + + client. + + + The Key Backup operation exports a key from Azure Key Vault in a + + protected form. Note that this operation does NOT return key material + + in a form that can be used outside the Azure Key Vault system, the + + returned key material is either protected to a Azure Key Vault HSM or + + to Azure Key Vault itself. The intent of this operation is to allow a + + client to GENERATE a key in one Azure Key Vault instance, BACKUP the + + key, and then RESTORE it into another Azure Key Vault instance. The + + BACKUP operation may be used to export, in protected form, any key type + + from Azure Key Vault. Individual versions of a key cannot be backed up. + + BACKUP / RESTORE can be performed within geographical boundaries only; + + meaning that a BACKUP from one geographical area cannot be restored to + + another geographical area. For example, a backup from the US + + geographical area cannot be restored in an EU geographical area. This + + operation requires the key/backup permission.' + signature: backup_key(vault_base_url, key_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: BackupKeyResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.backup_secret + name: backup_secret + summary: 'Backs up the specified secret. + + + Requests that a backup of the specified secret be downloaded to the + + client. All versions of the secret will be downloaded. This operation + + requires the secrets/backup permission.' + signature: backup_secret(vault_base_url, secret_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: BackupSecretResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.backup_storage_account + name: backup_storage_account + summary: 'Backs up the specified storage account. + + + Requests that a backup of the specified storage account be downloaded + + to the client. This operation requires the storage/backup permission.' + signature: backup_storage_account(vault_base_url, storage_account_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: BackupStorageResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None +- uid: azure.keyvault.v7_0.KeyVaultClient.create_certificate + name: create_certificate + summary: 'Creates a new certificate. + + + If this is the first version, the certificate resource is created. This + + operation requires the certificates/create permission.' + signature: create_certificate(vault_base_url, certificate_name, certificate_policy=None, + certificate_attributes=None, tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: certificate_policy + description: The management policy for the certificate. + defaultValue: None + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateOperation or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.create_key + name: create_key + summary: 'Creates a new key, stores it, then returns key parameters and + + attributes to the client. + + + The create key operation can be used to create any key type in Azure + + Key Vault. If the named key already exists, Azure Key Vault creates a + + new version of the key. It requires the keys/create permission.' + signature: create_key(vault_base_url, key_name, kty, key_size=None, key_ops=None, + key_attributes=None, tags=None, curve=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: 'The name for the new key. The system will generate + + the version name for the new key.' + isRequired: true + types: + - + - name: kty + description: 'The type of key to create. For valid values, see + + JsonWebKeyType. Possible values include: ''EC'', ''EC-HSM'', ''RSA'', + + ''RSA-HSM'', ''oct''' + isRequired: true + types: + - + - + - name: key_size + description: 'The key size in bits. For example: 2048, 3072, or + + 4096 for RSA.' + defaultValue: None + types: + - + - name: key_ops + defaultValue: None + types: + - [ + - ] + - name: key_attributes + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: curve + description: 'Elliptic curve name. For valid values, see + + JsonWebKeyCurveName. Possible values include: ''P-256'', ''P-384'', + + ''P-521'', ''P-256K''' + defaultValue: None + types: + - + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.decrypt + name: decrypt + summary: 'Decrypts a single block of encrypted data. + + + The DECRYPT operation decrypts a well-formed block of ciphertext using + + the target encryption key and specified algorithm. This operation is + + the reverse of the ENCRYPT operation; only a single block of data may + + be decrypted, the size of this block is dependent on the target key and + + the algorithm to be used. The DECRYPT operation applies to asymmetric + + and symmetric keys stored in Azure Key Vault since it uses the private + + portion of the key. This operation requires the keys/decrypt + + permission.' + signature: decrypt(vault_base_url, key_name, key_version, algorithm, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'algorithm identifier. Possible values include: + + ''RSA-OAEP'', ''RSA-OAEP-256'', ''RSA1_5''' + isRequired: true + types: + - + - + - name: value + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyOperationResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.delete_certificate + name: delete_certificate + summary: 'Deletes a certificate from a specified key vault. + + + Deletes all versions of a certificate object along with its associated + + policy. Delete certificate cannot be used to remove individual versions + + of a certificate object. This operation requires the + + certificates/delete permission.' + signature: delete_certificate(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedCertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.delete_certificate_contacts + name: delete_certificate_contacts + summary: 'Deletes the certificate contacts for a specified key vault. + + + Deletes the certificate contacts for a specified key vault certificate. + + This operation requires the certificates/managecontacts permission.' + signature: delete_certificate_contacts(vault_base_url, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Contacts or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.delete_certificate_issuer + name: delete_certificate_issuer + summary: 'Deletes the specified certificate issuer. + + + The DeleteCertificateIssuer operation permanently removes the specified + + certificate issuer from the vault. This operation requires the + + certificates/manageissuers/deleteissuers permission.' + signature: delete_certificate_issuer(vault_base_url, issuer_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: issuer_name + description: The name of the issuer. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: IssuerBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.delete_certificate_operation + name: delete_certificate_operation + summary: 'Deletes the creation operation for a specific certificate. + + + Deletes the creation operation for a specified certificate that is in + + the process of being created. The certificate is no longer created. + + This operation requires the certificates/update permission.' + signature: delete_certificate_operation(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateOperation or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.delete_key + name: delete_key + summary: 'Deletes a key of any type from storage in Azure Key Vault. + + + The delete key operation cannot be used to remove individual versions + + of a key. This operation removes the cryptographic material associated + + with the key, which means the key is not usable for Sign/Verify, + + Wrap/Unwrap or Encrypt/Decrypt operations. This operation requires the + + keys/delete permission.' + signature: delete_key(vault_base_url, key_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key to delete. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedKeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.delete_sas_definition + name: delete_sas_definition + summary: 'Deletes a SAS definition from a specified storage account. This + + operation requires the storage/deletesas permission.' + signature: delete_sas_definition(vault_base_url, storage_account_name, sas_definition_name, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: sas_definition_name + description: The name of the SAS definition. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedSasDefinitionBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.delete_secret + name: delete_secret + summary: 'Deletes a secret from a specified key vault. + + + The DELETE operation applies to any secret stored in Azure Key Vault. + + DELETE cannot be applied to an individual version of a secret. This + + operation requires the secrets/delete permission.' + signature: delete_secret(vault_base_url, secret_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedSecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.delete_storage_account + name: delete_storage_account + summary: 'Deletes a storage account. This operation requires the storage/delete + + permission.' + signature: delete_storage_account(vault_base_url, storage_account_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedStorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.encrypt + name: encrypt + summary: 'Encrypts an arbitrary sequence of bytes using an encryption key that is + + stored in a key vault. + + + The ENCRYPT operation encrypts an arbitrary sequence of bytes using an + + encryption key that is stored in Azure Key Vault. Note that the ENCRYPT + + operation only supports a single block of data, the size of which is + + dependent on the target key and the encryption algorithm to be used. + + The ENCRYPT operation is only strictly necessary for symmetric keys + + stored in Azure Key Vault since protection with an asymmetric key can + + be performed using public portion of the key. This operation is + + supported for asymmetric keys as a convenience for callers that have a + + key-reference but do not have access to the public key material. This + + operation requires the keys/encypt permission.' + signature: encrypt(vault_base_url, key_name, key_version, algorithm, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'algorithm identifier. Possible values include: + + ''RSA-OAEP'', ''RSA-OAEP-256'', ''RSA1_5''' + isRequired: true + types: + - + - + - name: value + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyOperationResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_certificate + name: get_certificate + summary: 'Gets information about a certificate. + + + Gets information about a specific certificate. This operation requires + + the certificates/get permission.' + signature: get_certificate(vault_base_url, certificate_name, certificate_version, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: 'The name of the certificate in the given + + vault.' + isRequired: true + types: + - + - name: certificate_version + description: The version of the certificate. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_certificate_contacts + name: get_certificate_contacts + summary: 'Lists the certificate contacts for a specified key vault. + + + The GetCertificateContacts operation returns the set of certificate + + contact resources in the specified key vault. This operation requires + + the certificates/managecontacts permission.' + signature: get_certificate_contacts(vault_base_url, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Contacts or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_certificate_issuer + name: get_certificate_issuer + summary: 'Lists the specified certificate issuer. + + + The GetCertificateIssuer operation returns the specified certificate + + issuer resources in the specified key vault. This operation requires + + the certificates/manageissuers/getissuers permission.' + signature: get_certificate_issuer(vault_base_url, issuer_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: issuer_name + description: The name of the issuer. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: IssuerBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_certificate_issuers + name: get_certificate_issuers + summary: 'List certificate issuers for a specified key vault. + + + The GetCertificateIssuers operation returns the set of certificate + + issuer resources in the specified key vault. This operation requires + + the certificates/manageissuers/getissuers permission.' + signature: get_certificate_issuers(vault_base_url, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of CertificateIssuerItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_certificate_operation + name: get_certificate_operation + summary: 'Gets the creation operation of a certificate. + + + Gets the creation operation associated with a specified certificate. + + This operation requires the certificates/get permission.' + signature: get_certificate_operation(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateOperation or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_certificate_policy + name: get_certificate_policy + summary: 'Lists the policy for a certificate. + + + The GetCertificatePolicy operation returns the specified certificate + + policy resources in the specified key vault. This operation requires + + the certificates/get permission.' + signature: get_certificate_policy(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: 'The name of the certificate in a given key + + vault.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificatePolicy or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_certificate_versions + name: get_certificate_versions + summary: 'List the versions of a certificate. + + + The GetCertificateVersions operation returns the versions of a + + certificate in the specified key vault. This operation requires the + + certificates/list permission.' + signature: get_certificate_versions(vault_base_url, certificate_name, maxresults=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of CertificateItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_certificates + name: get_certificates + summary: 'List certificates in a specified key vault. + + + The GetCertificates operation returns the set of certificates resources + + in the specified key vault. This operation requires the + + certificates/list permission.' + signature: get_certificates(vault_base_url, maxresults=None, include_pending=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: include_pending + description: 'Specifies whether to include certificates + + which are not completely provisioned.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of CertificateItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_deleted_certificate + name: get_deleted_certificate + summary: 'Retrieves information about the specified deleted certificate. + + + The GetDeletedCertificate operation retrieves the deleted certificate + + information plus its attributes, such as retention interval, scheduled + + permanent deletion and the current deletion recovery level. This + + operation requires the certificates/get permission.' + signature: get_deleted_certificate(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedCertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_deleted_certificates + name: get_deleted_certificates + summary: 'Lists the deleted certificates in the specified vault currently + + available for recovery. + + + The GetDeletedCertificates operation retrieves the certificates in the + + current vault which are in a deleted state and ready for recovery or + + purging. This operation includes deletion-specific information. This + + operation requires the certificates/get/list permission. This operation + + can only be enabled on soft-delete enabled vaults.' + signature: get_deleted_certificates(vault_base_url, maxresults=None, include_pending=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: include_pending + description: 'Specifies whether to include certificates + + which are not completely provisioned.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DeletedCertificateItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_deleted_key + name: get_deleted_key + summary: 'Gets the public part of a deleted key. + + + The Get Deleted Key operation is applicable for soft-delete enabled + + vaults. While the operation can be invoked on any vault, it will return + + an error if invoked on a non soft-delete enabled vault. This operation + + requires the keys/get permission. .' + signature: get_deleted_key(vault_base_url, key_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedKeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_deleted_keys + name: get_deleted_keys + summary: 'Lists the deleted keys in the specified vault. + + + Retrieves a list of the keys in the Key Vault as JSON Web Key + + structures that contain the public part of a deleted key. This + + operation includes deletion-specific information. The Get Deleted Keys + + operation is applicable for vaults enabled for soft-delete. While the + + operation can be invoked on any vault, it will return an error if + + invoked on a non soft-delete enabled vault. This operation requires the + + keys/list permission.' + signature: get_deleted_keys(vault_base_url, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DeletedKeyItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_deleted_sas_definition + name: get_deleted_sas_definition + summary: 'Gets the specified deleted sas definition. + + + The Get Deleted SAS Definition operation returns the specified deleted + + SAS definition along with its attributes. This operation requires the + + storage/getsas permission.' + signature: get_deleted_sas_definition(vault_base_url, storage_account_name, sas_definition_name, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: sas_definition_name + description: The name of the SAS definition. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedSasDefinitionBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_deleted_sas_definitions + name: get_deleted_sas_definitions + summary: 'Lists deleted SAS definitions for the specified vault and storage + + account. + + + The Get Deleted Sas Definitions operation returns the SAS definitions + + that have been deleted for a vault enabled for soft-delete. This + + operation requires the storage/listsas permission.' + signature: get_deleted_sas_definitions(vault_base_url, storage_account_name, maxresults=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DeletedSasDefinitionItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_deleted_secret + name: get_deleted_secret + summary: 'Gets the specified deleted secret. + + + The Get Deleted Secret operation returns the specified deleted secret + + along with its attributes. This operation requires the secrets/get + + permission.' + signature: get_deleted_secret(vault_base_url, secret_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedSecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_deleted_secrets + name: get_deleted_secrets + summary: 'Lists deleted secrets for the specified vault. + + + The Get Deleted Secrets operation returns the secrets that have been + + deleted for a vault enabled for soft-delete. This operation requires + + the secrets/list permission.' + signature: get_deleted_secrets(vault_base_url, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DeletedSecretItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_deleted_storage_account + name: get_deleted_storage_account + summary: 'Gets the specified deleted storage account. + + + The Get Deleted Storage Account operation returns the specified deleted + + storage account along with its attributes. This operation requires the + + storage/get permission.' + signature: get_deleted_storage_account(vault_base_url, storage_account_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedStorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_deleted_storage_accounts + name: get_deleted_storage_accounts + summary: 'Lists deleted storage accounts for the specified vault. + + + The Get Deleted Storage Accounts operation returns the storage accounts + + that have been deleted for a vault enabled for soft-delete. This + + operation requires the storage/list permission.' + signature: get_deleted_storage_accounts(vault_base_url, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DeletedStorageAccountItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_key + name: get_key + summary: 'Gets the public part of a stored key. + + + The get key operation is applicable to all key types. If the requested + + key is symmetric, then no key material is released in the response. + + This operation requires the keys/get permission.' + signature: get_key(vault_base_url, key_name, key_version, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key to get. + isRequired: true + types: + - + - name: key_version + description: 'Adding the version parameter retrieves a specific + + version of a key.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_key_versions + name: get_key_versions + summary: 'Retrieves a list of individual key versions with the same key name. + + + The full key identifier, attributes, and tags are provided in the + + response. This operation requires the keys/list permission.' + signature: get_key_versions(vault_base_url, key_name, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of KeyItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_keys + name: get_keys + summary: 'List keys in the specified vault. + + + Retrieves a list of the keys in the Key Vault as JSON Web Key + + structures that contain the public part of a stored key. The LIST + + operation is applicable to all key types, however only the base key + + identifier, attributes, and tags are provided in the response. + + Individual versions of a key are not listed in the response. This + + operation requires the keys/list permission.' + signature: get_keys(vault_base_url, maxresults=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of KeyItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_sas_definition + name: get_sas_definition + summary: 'Gets information about a SAS definition for the specified storage + + account. This operation requires the storage/getsas permission.' + signature: get_sas_definition(vault_base_url, storage_account_name, sas_definition_name, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: sas_definition_name + description: The name of the SAS definition. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SasDefinitionBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_sas_definitions + name: get_sas_definitions + summary: 'List storage SAS definitions for the given storage account. This + + operation requires the storage/listsas permission.' + signature: get_sas_definitions(vault_base_url, storage_account_name, maxresults=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of SasDefinitionItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_secret + name: get_secret + summary: 'Get a specified secret from a given key vault. + + + The GET operation is applicable to any secret stored in Azure Key + + Vault. This operation requires the secrets/get permission.' + signature: get_secret(vault_base_url, secret_name, secret_version, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: secret_version + description: The version of the secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_secret_versions + name: get_secret_versions + summary: 'List all versions of the specified secret. + + + The full secret identifier and attributes are provided in the response. + + No values are returned for the secrets. This operations requires the + + secrets/list permission.' + signature: get_secret_versions(vault_base_url, secret_name, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified, the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of SecretItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_secrets + name: get_secrets + summary: 'List secrets in a specified key vault. + + + The Get Secrets operation is applicable to the entire vault. However, + + only the base secret identifier and its attributes are provided in the + + response. Individual secret versions are not listed in the response. + + This operation requires the secrets/list permission.' + signature: get_secrets(vault_base_url, maxresults=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified, the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of SecretItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_storage_account + name: get_storage_account + summary: 'Gets information about a specified storage account. This operation + + requires the storage/get permission.' + signature: get_storage_account(vault_base_url, storage_account_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.get_storage_accounts + name: get_storage_accounts + summary: 'List storage accounts managed by the specified key vault. This + + operation requires the storage/list permission.' + signature: get_storage_accounts(vault_base_url, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of StorageAccountItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.import_certificate + name: import_certificate + summary: 'Imports a certificate into a specified key vault. + + + Imports an existing valid certificate, containing a private key, into + + Azure Key Vault. The certificate to be imported can be in either PFX or + + PEM format. If the certificate is in PEM format the PEM file must + + contain the key as well as x509 certificates. This operation requires + + the certificates/import permission.' + signature: import_certificate(vault_base_url, certificate_name, base64_encoded_certificate, + password=None, certificate_policy=None, certificate_attributes=None, tags=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: base64_encoded_certificate + description: 'Base64 encoded representation of + + the certificate object to import. This certificate needs to contain + + the private key.' + isRequired: true + types: + - + - name: password + description: 'If the private key in base64EncodedCertificate is + + encrypted, the password used for encryption.' + defaultValue: None + types: + - + - name: certificate_policy + description: The management policy for the certificate. + defaultValue: None + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.import_key + name: import_key + summary: 'Imports an externally created key, stores it, and returns key + + parameters and attributes to the client. + + + The import key operation may be used to import any key type into an + + Azure Key Vault. If the named key already exists, Azure Key Vault + + creates a new version of the key. This operation requires the + + keys/import permission.' + signature: import_key(vault_base_url, key_name, key, hsm=None, key_attributes=None, + tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: Name for the imported key. + isRequired: true + types: + - + - name: key + description: The Json web key + isRequired: true + types: + - + - name: hsm + description: Whether to import as a hardware key (HSM) or software key. + defaultValue: None + types: + - + - name: key_attributes + description: The key management attributes. + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.merge_certificate + name: merge_certificate + summary: 'Merges a certificate or a certificate chain with a key pair existing on + + the server. + + + The MergeCertificate operation performs the merging of a certificate or + + certificate chain with a key pair currently available in the service. + + This operation requires the certificates/create permission.' + signature: merge_certificate(vault_base_url, certificate_name, x509_certificates, + certificate_attributes=None, tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: x509_certificates + description: 'The certificate or the certificate chain to + + merge.' + isRequired: true + types: + - [] + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.purge_deleted_certificate + name: purge_deleted_certificate + summary: 'Permanently deletes the specified deleted certificate. + + + The PurgeDeletedCertificate operation performs an irreversible deletion + + of the specified certificate, without possibility for recovery. The + + operation is not available if the recovery level does not specify + + ''Purgeable''. This operation requires the certificate/purge permission.' + signature: purge_deleted_certificate(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.purge_deleted_key + name: purge_deleted_key + summary: 'Permanently deletes the specified key. + + + The Purge Deleted Key operation is applicable for soft-delete enabled + + vaults. While the operation can be invoked on any vault, it will return + + an error if invoked on a non soft-delete enabled vault. This operation + + requires the keys/purge permission.' + signature: purge_deleted_key(vault_base_url, key_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.purge_deleted_secret + name: purge_deleted_secret + summary: 'Permanently deletes the specified secret. + + + The purge deleted secret operation removes the secret permanently, + + without the possibility of recovery. This operation can only be enabled + + on a soft-delete enabled vault. This operation requires the + + secrets/purge permission.' + signature: purge_deleted_secret(vault_base_url, secret_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.purge_deleted_storage_account + name: purge_deleted_storage_account + summary: 'Permanently deletes the specified storage account. + + + The purge deleted storage account operation removes the secret + + permanently, without the possibility of recovery. This operation can + + only be performed on a soft-delete enabled vault. This operation + + requires the storage/purge permission.' + signature: purge_deleted_storage_account(vault_base_url, storage_account_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.recover_deleted_certificate + name: recover_deleted_certificate + summary: 'Recovers the deleted certificate back to its current version under + + /certificates. + + + The RecoverDeletedCertificate operation performs the reversal of the + + Delete operation. The operation is applicable in vaults enabled for + + soft-delete, and must be issued during the retention interval + + (available in the deleted certificate''s attributes). This operation + + requires the certificates/recover permission.' + signature: recover_deleted_certificate(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the deleted certificate + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.recover_deleted_key + name: recover_deleted_key + summary: 'Recovers the deleted key to its latest version. + + + The Recover Deleted Key operation is applicable for deleted keys in + + soft-delete enabled vaults. It recovers the deleted key back to its + + latest version under /keys. An attempt to recover an non-deleted key + + will return an error. Consider this the inverse of the delete operation + + on soft-delete enabled vaults. This operation requires the keys/recover + + permission.' + signature: recover_deleted_key(vault_base_url, key_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the deleted key. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.recover_deleted_sas_definition + name: recover_deleted_sas_definition + summary: 'Recovers the deleted SAS definition. + + + Recovers the deleted SAS definition for the specified storage account. + + This operation can only be performed on a soft-delete enabled vault. + + This operation requires the storage/recover permission.' + signature: recover_deleted_sas_definition(vault_base_url, storage_account_name, + sas_definition_name, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: sas_definition_name + description: The name of the SAS definition. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SasDefinitionBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.recover_deleted_secret + name: recover_deleted_secret + summary: 'Recovers the deleted secret to the latest version. + + + Recovers the deleted secret in the specified vault. This operation can + + only be performed on a soft-delete enabled vault. This operation + + requires the secrets/recover permission.' + signature: recover_deleted_secret(vault_base_url, secret_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the deleted secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.recover_deleted_storage_account + name: recover_deleted_storage_account + summary: 'Recovers the deleted storage account. + + + Recovers the deleted storage account in the specified vault. This + + operation can only be performed on a soft-delete enabled vault. This + + operation requires the storage/recover permission.' + signature: recover_deleted_storage_account(vault_base_url, storage_account_name, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.regenerate_storage_account_key + name: regenerate_storage_account_key + summary: 'Regenerates the specified key value for the given storage account. This + + operation requires the storage/regeneratekey permission.' + signature: regenerate_storage_account_key(vault_base_url, storage_account_name, + key_name, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: key_name + description: The storage account key name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.restore_certificate + name: restore_certificate + summary: 'Restores a backed up certificate to a vault. + + + Restores a backed up certificate, and all its versions, to a vault. + + This operation requires the certificates/restore permission.' + signature: restore_certificate(vault_base_url, certificate_bundle_backup, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_bundle_backup + description: 'The backup blob associated with a + + certificate bundle.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.restore_key + name: restore_key + summary: 'Restores a backed up key to a vault. + + + Imports a previously backed up key into Azure Key Vault, restoring the + + key, its key identifier, attributes and access control policies. The + + RESTORE operation may be used to import a previously backed up key. + + Individual versions of a key cannot be restored. The key is restored in + + its entirety with the same key name as it had when it was backed up. If + + the key name is not available in the target Key Vault, the RESTORE + + operation will be rejected. While the key name is retained during + + restore, the final key identifier will change if the key is restored to + + a different vault. Restore will restore all versions and preserve + + version identifiers. The RESTORE operation is subject to security + + constraints: The target Key Vault must be owned by the same Microsoft + + Azure Subscription as the source Key Vault The user must have RESTORE + + permission in the target Key Vault. This operation requires the + + keys/restore permission.' + signature: restore_key(vault_base_url, key_bundle_backup, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_bundle_backup + description: 'The backup blob associated with a key + + bundle.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.restore_secret + name: restore_secret + summary: 'Restores a backed up secret to a vault. + + + Restores a backed up secret, and all its versions, to a vault. This + + operation requires the secrets/restore permission.' + signature: restore_secret(vault_base_url, secret_bundle_backup, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_bundle_backup + description: 'The backup blob associated with a secret + + bundle.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.restore_storage_account + name: restore_storage_account + summary: 'Restores a backed up storage account to a vault. + + + Restores a backed up storage account to a vault. This operation + + requires the storage/restore permission.' + signature: restore_storage_account(vault_base_url, storage_bundle_backup, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_bundle_backup + description: 'The backup blob associated with a + + storage account.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.set_certificate_contacts + name: set_certificate_contacts + summary: 'Sets the certificate contacts for the specified key vault. + + + Sets the certificate contacts for the specified key vault. This + + operation requires the certificates/managecontacts permission.' + signature: set_certificate_contacts(vault_base_url, contact_list=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: contact_list + description: The contact list for the vault certificates. + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Contacts or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.set_certificate_issuer + name: set_certificate_issuer + summary: 'Sets the specified certificate issuer. + + + The SetCertificateIssuer operation adds or updates the specified + + certificate issuer. This operation requires the certificates/setissuers + + permission.' + signature: set_certificate_issuer(vault_base_url, issuer_name, provider, credentials=None, + organization_details=None, attributes=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: issuer_name + description: The name of the issuer. + isRequired: true + types: + - + - name: provider + description: The issuer provider. + isRequired: true + types: + - + - name: credentials + description: The credentials to be used for the issuer. + defaultValue: None + types: + - + - name: organization_details + description: 'Details of the organization as provided + + to the issuer.' + defaultValue: None + types: + - + - name: attributes + description: Attributes of the issuer object. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: IssuerBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.set_sas_definition + name: set_sas_definition + summary: 'Creates or updates a new SAS definition for the specified storage + + account. This operation requires the storage/setsas permission.' + signature: set_sas_definition(vault_base_url, storage_account_name, sas_definition_name, + template_uri, sas_type, validity_period, sas_definition_attributes=None, tags=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: sas_definition_name + description: The name of the SAS definition. + isRequired: true + types: + - + - name: template_uri + description: 'The SAS definition token template signed with an + + arbitrary key. Tokens created according to the SAS definition will + + have the same properties as the template.' + isRequired: true + types: + - + - name: sas_type + description: 'The type of SAS token the SAS definition will create. + + Possible values include: ''account'', ''service''' + isRequired: true + types: + - + - + - name: validity_period + description: 'The validity period of SAS tokens created + + according to the SAS definition.' + isRequired: true + types: + - + - name: sas_definition_attributes + description: 'The attributes of the SAS + + definition.' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SasDefinitionBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.set_secret + name: set_secret + summary: 'Sets a secret in a specified key vault. + + + The SET operation adds a secret to the Azure Key Vault. If the named + + secret already exists, Azure Key Vault creates a new version of that + + secret. This operation requires the secrets/set permission.' + signature: set_secret(vault_base_url, secret_name, value, tags=None, content_type=None, + secret_attributes=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: value + description: The value of the secret. + isRequired: true + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: content_type + description: Type of the secret value such as a password. + defaultValue: None + types: + - + - name: secret_attributes + description: The secret management attributes. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.set_storage_account + name: set_storage_account + summary: 'Creates or updates a new storage account. This operation requires the + + storage/set permission.' + signature: set_storage_account(vault_base_url, storage_account_name, resource_id, + active_key_name, auto_regenerate_key, regeneration_period=None, storage_account_attributes=None, + tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: resource_id + description: Storage account resource id. + isRequired: true + types: + - + - name: active_key_name + description: Current active storage account key name. + isRequired: true + types: + - + - name: auto_regenerate_key + description: 'whether keyvault should manage the storage + + account for the user.' + isRequired: true + types: + - + - name: regeneration_period + description: 'The key regeneration time duration + + specified in ISO-8601 format.' + defaultValue: None + types: + - + - name: storage_account_attributes + description: 'The attributes of the storage + + account.' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.sign + name: sign + summary: 'Creates a signature from a digest using the specified key. + + + The SIGN operation is applicable to asymmetric and symmetric keys + + stored in Azure Key Vault since this operation uses the private portion + + of the key. This operation requires the keys/sign permission.' + signature: sign(vault_base_url, key_name, key_version, algorithm, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'The signing/verification algorithm identifier. For + + more information on possible algorithm types, see + + JsonWebKeySignatureAlgorithm. Possible values include: ''PS256'', + + ''PS384'', ''PS512'', ''RS256'', ''RS384'', ''RS512'', ''RSNULL'', ''ES256'', + + ''ES384'', ''ES512'', ''ES256K''' + isRequired: true + types: + - + - + - name: value + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyOperationResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.unwrap_key + name: unwrap_key + summary: 'Unwraps a symmetric key using the specified key that was initially used + + for wrapping that key. + + + The UNWRAP operation supports decryption of a symmetric key using the + + target key encryption key. This operation is the reverse of the WRAP + + operation. The UNWRAP operation applies to asymmetric and symmetric + + keys stored in Azure Key Vault since it uses the private portion of the + + key. This operation requires the keys/unwrapKey permission.' + signature: unwrap_key(vault_base_url, key_name, key_version, algorithm, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'algorithm identifier. Possible values include: + + ''RSA-OAEP'', ''RSA-OAEP-256'', ''RSA1_5''' + isRequired: true + types: + - + - + - name: value + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyOperationResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.update_certificate + name: update_certificate + summary: 'Updates the specified attributes associated with the given certificate. + + + The UpdateCertificate operation applies the specified update on the + + given certificate; the only elements updated are the certificate''s + + attributes. This operation requires the certificates/update permission.' + signature: update_certificate(vault_base_url, certificate_name, certificate_version, + certificate_policy=None, certificate_attributes=None, tags=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: 'The name of the certificate in the given key + + vault.' + isRequired: true + types: + - + - name: certificate_version + description: The version of the certificate. + isRequired: true + types: + - + - name: certificate_policy + description: The management policy for the certificate. + defaultValue: None + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.update_certificate_issuer + name: update_certificate_issuer + summary: 'Updates the specified certificate issuer. + + + The UpdateCertificateIssuer operation performs an update on the + + specified certificate issuer entity. This operation requires the + + certificates/setissuers permission.' + signature: update_certificate_issuer(vault_base_url, issuer_name, provider=None, + credentials=None, organization_details=None, attributes=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: issuer_name + description: The name of the issuer. + isRequired: true + types: + - + - name: provider + description: The issuer provider. + defaultValue: None + types: + - + - name: credentials + description: The credentials to be used for the issuer. + defaultValue: None + types: + - + - name: organization_details + description: 'Details of the organization as provided + + to the issuer.' + defaultValue: None + types: + - + - name: attributes + description: Attributes of the issuer object. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: IssuerBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.update_certificate_operation + name: update_certificate_operation + summary: 'Updates a certificate operation. + + + Updates a certificate creation operation that is already in progress. + + This operation requires the certificates/update permission.' + signature: update_certificate_operation(vault_base_url, certificate_name, cancellation_requested, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: cancellation_requested + description: 'Indicates if cancellation was requested + + on the certificate operation.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateOperation or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.update_certificate_policy + name: update_certificate_policy + summary: 'Updates the policy for a certificate. + + + Set specified members in the certificate policy. Leave others as null. + + This operation requires the certificates/update permission.' + signature: update_certificate_policy(vault_base_url, certificate_name, certificate_policy, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: 'The name of the certificate in the given + + vault.' + isRequired: true + types: + - + - name: certificate_policy + description: The policy for the certificate. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificatePolicy or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.update_key + name: update_key + summary: 'The update key operation changes specified attributes of a stored key + + and can be applied to any key type and key version stored in Azure Key + + Vault. + + + In order to perform this operation, the key must already exist in the + + Key Vault. Note: The cryptographic material of a key itself cannot be + + changed. This operation requires the keys/update permission.' + signature: update_key(vault_base_url, key_name, key_version, key_ops=None, key_attributes=None, + tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of key to update. + isRequired: true + types: + - + - name: key_version + description: The version of the key to update. + isRequired: true + types: + - + - name: key_ops + description: 'Json web key operations. For more information on + + possible key operations, see JsonWebKeyOperation.' + defaultValue: None + types: + - [ + - ] + - name: key_attributes + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.update_sas_definition + name: update_sas_definition + summary: 'Updates the specified attributes associated with the given SAS + + definition. This operation requires the storage/setsas permission.' + signature: update_sas_definition(vault_base_url, storage_account_name, sas_definition_name, + template_uri=None, sas_type=None, validity_period=None, sas_definition_attributes=None, + tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: sas_definition_name + description: The name of the SAS definition. + isRequired: true + types: + - + - name: template_uri + description: 'The SAS definition token template signed with an + + arbitrary key. Tokens created according to the SAS definition will + + have the same properties as the template.' + defaultValue: None + types: + - + - name: sas_type + description: 'The type of SAS token the SAS definition will create. + + Possible values include: ''account'', ''service''' + defaultValue: None + types: + - + - + - name: validity_period + description: 'The validity period of SAS tokens created + + according to the SAS definition.' + defaultValue: None + types: + - + - name: sas_definition_attributes + description: 'The attributes of the SAS + + definition.' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SasDefinitionBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.update_secret + name: update_secret + summary: 'Updates the attributes associated with a specified secret in a given + + key vault. + + + The UPDATE operation changes specified attributes of an existing stored + + secret. Attributes that are not specified in the request are left + + unchanged. The value of a secret itself cannot be changed. This + + operation requires the secrets/set permission.' + signature: update_secret(vault_base_url, secret_name, secret_version, content_type=None, + secret_attributes=None, tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: secret_version + description: The version of the secret. + isRequired: true + types: + - + - name: content_type + description: Type of the secret value such as a password. + defaultValue: None + types: + - + - name: secret_attributes + description: The secret management attributes. + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.update_storage_account + name: update_storage_account + summary: 'Updates the specified attributes associated with the given storage + + account. This operation requires the storage/set/update permission.' + signature: update_storage_account(vault_base_url, storage_account_name, active_key_name=None, + auto_regenerate_key=None, regeneration_period=None, storage_account_attributes=None, + tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: active_key_name + description: The current active storage account key name. + defaultValue: None + types: + - + - name: auto_regenerate_key + description: 'whether keyvault should manage the storage + + account for the user.' + defaultValue: None + types: + - + - name: regeneration_period + description: 'The key regeneration time duration + + specified in ISO-8601 format.' + defaultValue: None + types: + - + - name: storage_account_attributes + description: 'The attributes of the storage + + account.' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.verify + name: verify + summary: 'Verifies a signature using a specified key. + + + The VERIFY operation is applicable to symmetric keys stored in Azure + + Key Vault. VERIFY is not strictly necessary for asymmetric keys stored + + in Azure Key Vault since signature verification can be performed using + + the public portion of the key but this operation is supported as a + + convenience for callers that only have a key-reference and not the + + public portion of the key. This operation requires the keys/verify + + permission.' + signature: verify(vault_base_url, key_name, key_version, algorithm, digest, signature, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'The signing/verification algorithm. For more + + information on possible algorithm types, see + + JsonWebKeySignatureAlgorithm. Possible values include: ''PS256'', + + ''PS384'', ''PS512'', ''RS256'', ''RS384'', ''RS512'', ''RSNULL'', ''ES256'', + + ''ES384'', ''ES512'', ''ES256K''' + isRequired: true + types: + - + - + - name: digest + description: The digest used for signing. + isRequired: true + types: + - + - name: signature + description: The signature to be verified. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyVerifyResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.KeyVaultClient.wrap_key + name: wrap_key + summary: 'Wraps a symmetric key using a specified key. + + + The WRAP operation supports encryption of a symmetric key using a key + + encryption key that has previously been stored in an Azure Key Vault. + + The WRAP operation is only strictly necessary for symmetric keys stored + + in Azure Key Vault since protection with an asymmetric key can be + + performed using the public portion of the key. This operation is + + supported for asymmetric keys as a convenience for callers that have a + + key-reference but do not have access to the public key material. This + + operation requires the keys/wrapKey permission.' + signature: wrap_key(vault_base_url, key_name, key_version, algorithm, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'algorithm identifier. Possible values include: + + ''RSA-OAEP'', ''RSA-OAEP-256'', ''RSA1_5''' + isRequired: true + types: + - + - + - name: value + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyOperationResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.key_vault_client.KeyVaultClient.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.key_vault_client.KeyVaultClient.yml new file mode 100644 index 00000000..ea99789d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.key_vault_client.KeyVaultClient.yml @@ -0,0 +1,4611 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient +name: KeyVaultClient +fullName: azure.keyvault.v7_0.key_vault_client.KeyVaultClient +module: azure.keyvault.v7_0.key_vault_client +summary: The key vault client performs cryptographic key operations and vault operations + against the Key Vault service. +constructor: + syntax: KeyVaultClient(credentials) + parameters: + - name: credentials + description: Credentials needed for the client to connect to Azure. + isRequired: true + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +methods: +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.backup_certificate + name: backup_certificate + summary: 'Backs up the specified certificate. + + + Requests that a backup of the specified certificate be downloaded to + + the client. All versions of the certificate will be downloaded. This + + operation requires the certificates/backup permission.' + signature: backup_certificate(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: BackupCertificateResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.backup_key + name: backup_key + summary: 'Requests that a backup of the specified key be downloaded to the + + client. + + + The Key Backup operation exports a key from Azure Key Vault in a + + protected form. Note that this operation does NOT return key material + + in a form that can be used outside the Azure Key Vault system, the + + returned key material is either protected to a Azure Key Vault HSM or + + to Azure Key Vault itself. The intent of this operation is to allow a + + client to GENERATE a key in one Azure Key Vault instance, BACKUP the + + key, and then RESTORE it into another Azure Key Vault instance. The + + BACKUP operation may be used to export, in protected form, any key type + + from Azure Key Vault. Individual versions of a key cannot be backed up. + + BACKUP / RESTORE can be performed within geographical boundaries only; + + meaning that a BACKUP from one geographical area cannot be restored to + + another geographical area. For example, a backup from the US + + geographical area cannot be restored in an EU geographical area. This + + operation requires the key/backup permission.' + signature: backup_key(vault_base_url, key_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: BackupKeyResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.backup_secret + name: backup_secret + summary: 'Backs up the specified secret. + + + Requests that a backup of the specified secret be downloaded to the + + client. All versions of the secret will be downloaded. This operation + + requires the secrets/backup permission.' + signature: backup_secret(vault_base_url, secret_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: BackupSecretResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.backup_storage_account + name: backup_storage_account + summary: 'Backs up the specified storage account. + + + Requests that a backup of the specified storage account be downloaded + + to the client. This operation requires the storage/backup permission.' + signature: backup_storage_account(vault_base_url, storage_account_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: BackupStorageResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.create_certificate + name: create_certificate + summary: 'Creates a new certificate. + + + If this is the first version, the certificate resource is created. This + + operation requires the certificates/create permission.' + signature: create_certificate(vault_base_url, certificate_name, certificate_policy=None, + certificate_attributes=None, tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: certificate_policy + description: The management policy for the certificate. + defaultValue: None + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateOperation or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.create_key + name: create_key + summary: 'Creates a new key, stores it, then returns key parameters and + + attributes to the client. + + + The create key operation can be used to create any key type in Azure + + Key Vault. If the named key already exists, Azure Key Vault creates a + + new version of the key. It requires the keys/create permission.' + signature: create_key(vault_base_url, key_name, kty, key_size=None, key_ops=None, + key_attributes=None, tags=None, curve=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: 'The name for the new key. The system will generate + + the version name for the new key.' + isRequired: true + types: + - + - name: kty + description: 'The type of key to create. For valid values, see + + JsonWebKeyType. Possible values include: ''EC'', ''EC-HSM'', ''RSA'', + + ''RSA-HSM'', ''oct''' + isRequired: true + types: + - + - + - name: key_size + description: 'The key size in bits. For example: 2048, 3072, or + + 4096 for RSA.' + defaultValue: None + types: + - + - name: key_ops + defaultValue: None + types: + - [ + - ] + - name: key_attributes + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: curve + description: 'Elliptic curve name. For valid values, see + + JsonWebKeyCurveName. Possible values include: ''P-256'', ''P-384'', + + ''P-521'', ''P-256K''' + defaultValue: None + types: + - + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.decrypt + name: decrypt + summary: 'Decrypts a single block of encrypted data. + + + The DECRYPT operation decrypts a well-formed block of ciphertext using + + the target encryption key and specified algorithm. This operation is + + the reverse of the ENCRYPT operation; only a single block of data may + + be decrypted, the size of this block is dependent on the target key and + + the algorithm to be used. The DECRYPT operation applies to asymmetric + + and symmetric keys stored in Azure Key Vault since it uses the private + + portion of the key. This operation requires the keys/decrypt + + permission.' + signature: decrypt(vault_base_url, key_name, key_version, algorithm, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'algorithm identifier. Possible values include: + + ''RSA-OAEP'', ''RSA-OAEP-256'', ''RSA1_5''' + isRequired: true + types: + - + - + - name: value + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyOperationResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.delete_certificate + name: delete_certificate + summary: 'Deletes a certificate from a specified key vault. + + + Deletes all versions of a certificate object along with its associated + + policy. Delete certificate cannot be used to remove individual versions + + of a certificate object. This operation requires the + + certificates/delete permission.' + signature: delete_certificate(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedCertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.delete_certificate_contacts + name: delete_certificate_contacts + summary: 'Deletes the certificate contacts for a specified key vault. + + + Deletes the certificate contacts for a specified key vault certificate. + + This operation requires the certificates/managecontacts permission.' + signature: delete_certificate_contacts(vault_base_url, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Contacts or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.delete_certificate_issuer + name: delete_certificate_issuer + summary: 'Deletes the specified certificate issuer. + + + The DeleteCertificateIssuer operation permanently removes the specified + + certificate issuer from the vault. This operation requires the + + certificates/manageissuers/deleteissuers permission.' + signature: delete_certificate_issuer(vault_base_url, issuer_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: issuer_name + description: The name of the issuer. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: IssuerBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.delete_certificate_operation + name: delete_certificate_operation + summary: 'Deletes the creation operation for a specific certificate. + + + Deletes the creation operation for a specified certificate that is in + + the process of being created. The certificate is no longer created. + + This operation requires the certificates/update permission.' + signature: delete_certificate_operation(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateOperation or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.delete_key + name: delete_key + summary: 'Deletes a key of any type from storage in Azure Key Vault. + + + The delete key operation cannot be used to remove individual versions + + of a key. This operation removes the cryptographic material associated + + with the key, which means the key is not usable for Sign/Verify, + + Wrap/Unwrap or Encrypt/Decrypt operations. This operation requires the + + keys/delete permission.' + signature: delete_key(vault_base_url, key_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key to delete. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedKeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.delete_sas_definition + name: delete_sas_definition + summary: 'Deletes a SAS definition from a specified storage account. This + + operation requires the storage/deletesas permission.' + signature: delete_sas_definition(vault_base_url, storage_account_name, sas_definition_name, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: sas_definition_name + description: The name of the SAS definition. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedSasDefinitionBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.delete_secret + name: delete_secret + summary: 'Deletes a secret from a specified key vault. + + + The DELETE operation applies to any secret stored in Azure Key Vault. + + DELETE cannot be applied to an individual version of a secret. This + + operation requires the secrets/delete permission.' + signature: delete_secret(vault_base_url, secret_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedSecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.delete_storage_account + name: delete_storage_account + summary: 'Deletes a storage account. This operation requires the storage/delete + + permission.' + signature: delete_storage_account(vault_base_url, storage_account_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedStorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.encrypt + name: encrypt + summary: 'Encrypts an arbitrary sequence of bytes using an encryption key that is + + stored in a key vault. + + + The ENCRYPT operation encrypts an arbitrary sequence of bytes using an + + encryption key that is stored in Azure Key Vault. Note that the ENCRYPT + + operation only supports a single block of data, the size of which is + + dependent on the target key and the encryption algorithm to be used. + + The ENCRYPT operation is only strictly necessary for symmetric keys + + stored in Azure Key Vault since protection with an asymmetric key can + + be performed using public portion of the key. This operation is + + supported for asymmetric keys as a convenience for callers that have a + + key-reference but do not have access to the public key material. This + + operation requires the keys/encypt permission.' + signature: encrypt(vault_base_url, key_name, key_version, algorithm, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'algorithm identifier. Possible values include: + + ''RSA-OAEP'', ''RSA-OAEP-256'', ''RSA1_5''' + isRequired: true + types: + - + - + - name: value + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyOperationResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_certificate + name: get_certificate + summary: 'Gets information about a certificate. + + + Gets information about a specific certificate. This operation requires + + the certificates/get permission.' + signature: get_certificate(vault_base_url, certificate_name, certificate_version, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: 'The name of the certificate in the given + + vault.' + isRequired: true + types: + - + - name: certificate_version + description: The version of the certificate. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_certificate_contacts + name: get_certificate_contacts + summary: 'Lists the certificate contacts for a specified key vault. + + + The GetCertificateContacts operation returns the set of certificate + + contact resources in the specified key vault. This operation requires + + the certificates/managecontacts permission.' + signature: get_certificate_contacts(vault_base_url, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Contacts or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_certificate_issuer + name: get_certificate_issuer + summary: 'Lists the specified certificate issuer. + + + The GetCertificateIssuer operation returns the specified certificate + + issuer resources in the specified key vault. This operation requires + + the certificates/manageissuers/getissuers permission.' + signature: get_certificate_issuer(vault_base_url, issuer_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: issuer_name + description: The name of the issuer. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: IssuerBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_certificate_issuers + name: get_certificate_issuers + summary: 'List certificate issuers for a specified key vault. + + + The GetCertificateIssuers operation returns the set of certificate + + issuer resources in the specified key vault. This operation requires + + the certificates/manageissuers/getissuers permission.' + signature: get_certificate_issuers(vault_base_url, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of CertificateIssuerItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_certificate_operation + name: get_certificate_operation + summary: 'Gets the creation operation of a certificate. + + + Gets the creation operation associated with a specified certificate. + + This operation requires the certificates/get permission.' + signature: get_certificate_operation(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateOperation or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_certificate_policy + name: get_certificate_policy + summary: 'Lists the policy for a certificate. + + + The GetCertificatePolicy operation returns the specified certificate + + policy resources in the specified key vault. This operation requires + + the certificates/get permission.' + signature: get_certificate_policy(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: 'The name of the certificate in a given key + + vault.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificatePolicy or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_certificate_versions + name: get_certificate_versions + summary: 'List the versions of a certificate. + + + The GetCertificateVersions operation returns the versions of a + + certificate in the specified key vault. This operation requires the + + certificates/list permission.' + signature: get_certificate_versions(vault_base_url, certificate_name, maxresults=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of CertificateItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_certificates + name: get_certificates + summary: 'List certificates in a specified key vault. + + + The GetCertificates operation returns the set of certificates resources + + in the specified key vault. This operation requires the + + certificates/list permission.' + signature: get_certificates(vault_base_url, maxresults=None, include_pending=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: include_pending + description: 'Specifies whether to include certificates + + which are not completely provisioned.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of CertificateItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_deleted_certificate + name: get_deleted_certificate + summary: 'Retrieves information about the specified deleted certificate. + + + The GetDeletedCertificate operation retrieves the deleted certificate + + information plus its attributes, such as retention interval, scheduled + + permanent deletion and the current deletion recovery level. This + + operation requires the certificates/get permission.' + signature: get_deleted_certificate(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedCertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_deleted_certificates + name: get_deleted_certificates + summary: 'Lists the deleted certificates in the specified vault currently + + available for recovery. + + + The GetDeletedCertificates operation retrieves the certificates in the + + current vault which are in a deleted state and ready for recovery or + + purging. This operation includes deletion-specific information. This + + operation requires the certificates/get/list permission. This operation + + can only be enabled on soft-delete enabled vaults.' + signature: get_deleted_certificates(vault_base_url, maxresults=None, include_pending=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: include_pending + description: 'Specifies whether to include certificates + + which are not completely provisioned.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DeletedCertificateItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_deleted_key + name: get_deleted_key + summary: 'Gets the public part of a deleted key. + + + The Get Deleted Key operation is applicable for soft-delete enabled + + vaults. While the operation can be invoked on any vault, it will return + + an error if invoked on a non soft-delete enabled vault. This operation + + requires the keys/get permission. .' + signature: get_deleted_key(vault_base_url, key_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedKeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_deleted_keys + name: get_deleted_keys + summary: 'Lists the deleted keys in the specified vault. + + + Retrieves a list of the keys in the Key Vault as JSON Web Key + + structures that contain the public part of a deleted key. This + + operation includes deletion-specific information. The Get Deleted Keys + + operation is applicable for vaults enabled for soft-delete. While the + + operation can be invoked on any vault, it will return an error if + + invoked on a non soft-delete enabled vault. This operation requires the + + keys/list permission.' + signature: get_deleted_keys(vault_base_url, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DeletedKeyItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_deleted_sas_definition + name: get_deleted_sas_definition + summary: 'Gets the specified deleted sas definition. + + + The Get Deleted SAS Definition operation returns the specified deleted + + SAS definition along with its attributes. This operation requires the + + storage/getsas permission.' + signature: get_deleted_sas_definition(vault_base_url, storage_account_name, sas_definition_name, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: sas_definition_name + description: The name of the SAS definition. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedSasDefinitionBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_deleted_sas_definitions + name: get_deleted_sas_definitions + summary: 'Lists deleted SAS definitions for the specified vault and storage + + account. + + + The Get Deleted Sas Definitions operation returns the SAS definitions + + that have been deleted for a vault enabled for soft-delete. This + + operation requires the storage/listsas permission.' + signature: get_deleted_sas_definitions(vault_base_url, storage_account_name, maxresults=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DeletedSasDefinitionItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_deleted_secret + name: get_deleted_secret + summary: 'Gets the specified deleted secret. + + + The Get Deleted Secret operation returns the specified deleted secret + + along with its attributes. This operation requires the secrets/get + + permission.' + signature: get_deleted_secret(vault_base_url, secret_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedSecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_deleted_secrets + name: get_deleted_secrets + summary: 'Lists deleted secrets for the specified vault. + + + The Get Deleted Secrets operation returns the secrets that have been + + deleted for a vault enabled for soft-delete. This operation requires + + the secrets/list permission.' + signature: get_deleted_secrets(vault_base_url, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DeletedSecretItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_deleted_storage_account + name: get_deleted_storage_account + summary: 'Gets the specified deleted storage account. + + + The Get Deleted Storage Account operation returns the specified deleted + + storage account along with its attributes. This operation requires the + + storage/get permission.' + signature: get_deleted_storage_account(vault_base_url, storage_account_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DeletedStorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_deleted_storage_accounts + name: get_deleted_storage_accounts + summary: 'Lists deleted storage accounts for the specified vault. + + + The Get Deleted Storage Accounts operation returns the storage accounts + + that have been deleted for a vault enabled for soft-delete. This + + operation requires the storage/list permission.' + signature: get_deleted_storage_accounts(vault_base_url, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DeletedStorageAccountItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_key + name: get_key + summary: 'Gets the public part of a stored key. + + + The get key operation is applicable to all key types. If the requested + + key is symmetric, then no key material is released in the response. + + This operation requires the keys/get permission.' + signature: get_key(vault_base_url, key_name, key_version, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key to get. + isRequired: true + types: + - + - name: key_version + description: 'Adding the version parameter retrieves a specific + + version of a key.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_key_versions + name: get_key_versions + summary: 'Retrieves a list of individual key versions with the same key name. + + + The full key identifier, attributes, and tags are provided in the + + response. This operation requires the keys/list permission.' + signature: get_key_versions(vault_base_url, key_name, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of KeyItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_keys + name: get_keys + summary: 'List keys in the specified vault. + + + Retrieves a list of the keys in the Key Vault as JSON Web Key + + structures that contain the public part of a stored key. The LIST + + operation is applicable to all key types, however only the base key + + identifier, attributes, and tags are provided in the response. + + Individual versions of a key are not listed in the response. This + + operation requires the keys/list permission.' + signature: get_keys(vault_base_url, maxresults=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of KeyItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_sas_definition + name: get_sas_definition + summary: 'Gets information about a SAS definition for the specified storage + + account. This operation requires the storage/getsas permission.' + signature: get_sas_definition(vault_base_url, storage_account_name, sas_definition_name, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: sas_definition_name + description: The name of the SAS definition. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SasDefinitionBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_sas_definitions + name: get_sas_definitions + summary: 'List storage SAS definitions for the given storage account. This + + operation requires the storage/listsas permission.' + signature: get_sas_definitions(vault_base_url, storage_account_name, maxresults=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of SasDefinitionItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_secret + name: get_secret + summary: 'Get a specified secret from a given key vault. + + + The GET operation is applicable to any secret stored in Azure Key + + Vault. This operation requires the secrets/get permission.' + signature: get_secret(vault_base_url, secret_name, secret_version, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: secret_version + description: The version of the secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_secret_versions + name: get_secret_versions + summary: 'List all versions of the specified secret. + + + The full secret identifier and attributes are provided in the response. + + No values are returned for the secrets. This operations requires the + + secrets/list permission.' + signature: get_secret_versions(vault_base_url, secret_name, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified, the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of SecretItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_secrets + name: get_secrets + summary: 'List secrets in a specified key vault. + + + The Get Secrets operation is applicable to the entire vault. However, + + only the base secret identifier and its attributes are provided in the + + response. Individual secret versions are not listed in the response. + + This operation requires the secrets/list permission.' + signature: get_secrets(vault_base_url, maxresults=None, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified, the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of SecretItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_storage_account + name: get_storage_account + summary: 'Gets information about a specified storage account. This operation + + requires the storage/get permission.' + signature: get_storage_account(vault_base_url, storage_account_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.get_storage_accounts + name: get_storage_accounts + summary: 'List storage accounts managed by the specified key vault. This + + operation requires the storage/list permission.' + signature: get_storage_accounts(vault_base_url, maxresults=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: maxresults + description: 'Maximum number of results to return in a page. If + + not specified the service will return up to 25 results.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of StorageAccountItem + types: + - [] + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.import_certificate + name: import_certificate + summary: 'Imports a certificate into a specified key vault. + + + Imports an existing valid certificate, containing a private key, into + + Azure Key Vault. The certificate to be imported can be in either PFX or + + PEM format. If the certificate is in PEM format the PEM file must + + contain the key as well as x509 certificates. This operation requires + + the certificates/import permission.' + signature: import_certificate(vault_base_url, certificate_name, base64_encoded_certificate, + password=None, certificate_policy=None, certificate_attributes=None, tags=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: base64_encoded_certificate + description: 'Base64 encoded representation of + + the certificate object to import. This certificate needs to contain + + the private key.' + isRequired: true + types: + - + - name: password + description: 'If the private key in base64EncodedCertificate is + + encrypted, the password used for encryption.' + defaultValue: None + types: + - + - name: certificate_policy + description: The management policy for the certificate. + defaultValue: None + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.import_key + name: import_key + summary: 'Imports an externally created key, stores it, and returns key + + parameters and attributes to the client. + + + The import key operation may be used to import any key type into an + + Azure Key Vault. If the named key already exists, Azure Key Vault + + creates a new version of the key. This operation requires the + + keys/import permission.' + signature: import_key(vault_base_url, key_name, key, hsm=None, key_attributes=None, + tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: Name for the imported key. + isRequired: true + types: + - + - name: key + description: The Json web key + isRequired: true + types: + - + - name: hsm + description: Whether to import as a hardware key (HSM) or software key. + defaultValue: None + types: + - + - name: key_attributes + description: The key management attributes. + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.merge_certificate + name: merge_certificate + summary: 'Merges a certificate or a certificate chain with a key pair existing on + + the server. + + + The MergeCertificate operation performs the merging of a certificate or + + certificate chain with a key pair currently available in the service. + + This operation requires the certificates/create permission.' + signature: merge_certificate(vault_base_url, certificate_name, x509_certificates, + certificate_attributes=None, tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: x509_certificates + description: 'The certificate or the certificate chain to + + merge.' + isRequired: true + types: + - [] + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.purge_deleted_certificate + name: purge_deleted_certificate + summary: 'Permanently deletes the specified deleted certificate. + + + The PurgeDeletedCertificate operation performs an irreversible deletion + + of the specified certificate, without possibility for recovery. The + + operation is not available if the recovery level does not specify + + ''Purgeable''. This operation requires the certificate/purge permission.' + signature: purge_deleted_certificate(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.purge_deleted_key + name: purge_deleted_key + summary: 'Permanently deletes the specified key. + + + The Purge Deleted Key operation is applicable for soft-delete enabled + + vaults. While the operation can be invoked on any vault, it will return + + an error if invoked on a non soft-delete enabled vault. This operation + + requires the keys/purge permission.' + signature: purge_deleted_key(vault_base_url, key_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.purge_deleted_secret + name: purge_deleted_secret + summary: 'Permanently deletes the specified secret. + + + The purge deleted secret operation removes the secret permanently, + + without the possibility of recovery. This operation can only be enabled + + on a soft-delete enabled vault. This operation requires the + + secrets/purge permission.' + signature: purge_deleted_secret(vault_base_url, secret_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.purge_deleted_storage_account + name: purge_deleted_storage_account + summary: 'Permanently deletes the specified storage account. + + + The purge deleted storage account operation removes the secret + + permanently, without the possibility of recovery. This operation can + + only be performed on a soft-delete enabled vault. This operation + + requires the storage/purge permission.' + signature: purge_deleted_storage_account(vault_base_url, storage_account_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: None or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.recover_deleted_certificate + name: recover_deleted_certificate + summary: 'Recovers the deleted certificate back to its current version under + + /certificates. + + + The RecoverDeletedCertificate operation performs the reversal of the + + Delete operation. The operation is applicable in vaults enabled for + + soft-delete, and must be issued during the retention interval + + (available in the deleted certificate''s attributes). This operation + + requires the certificates/recover permission.' + signature: recover_deleted_certificate(vault_base_url, certificate_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the deleted certificate + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.recover_deleted_key + name: recover_deleted_key + summary: 'Recovers the deleted key to its latest version. + + + The Recover Deleted Key operation is applicable for deleted keys in + + soft-delete enabled vaults. It recovers the deleted key back to its + + latest version under /keys. An attempt to recover an non-deleted key + + will return an error. Consider this the inverse of the delete operation + + on soft-delete enabled vaults. This operation requires the keys/recover + + permission.' + signature: recover_deleted_key(vault_base_url, key_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the deleted key. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.recover_deleted_sas_definition + name: recover_deleted_sas_definition + summary: 'Recovers the deleted SAS definition. + + + Recovers the deleted SAS definition for the specified storage account. + + This operation can only be performed on a soft-delete enabled vault. + + This operation requires the storage/recover permission.' + signature: recover_deleted_sas_definition(vault_base_url, storage_account_name, + sas_definition_name, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: sas_definition_name + description: The name of the SAS definition. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SasDefinitionBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.recover_deleted_secret + name: recover_deleted_secret + summary: 'Recovers the deleted secret to the latest version. + + + Recovers the deleted secret in the specified vault. This operation can + + only be performed on a soft-delete enabled vault. This operation + + requires the secrets/recover permission.' + signature: recover_deleted_secret(vault_base_url, secret_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the deleted secret. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.recover_deleted_storage_account + name: recover_deleted_storage_account + summary: 'Recovers the deleted storage account. + + + Recovers the deleted storage account in the specified vault. This + + operation can only be performed on a soft-delete enabled vault. This + + operation requires the storage/recover permission.' + signature: recover_deleted_storage_account(vault_base_url, storage_account_name, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.regenerate_storage_account_key + name: regenerate_storage_account_key + summary: 'Regenerates the specified key value for the given storage account. This + + operation requires the storage/regeneratekey permission.' + signature: regenerate_storage_account_key(vault_base_url, storage_account_name, + key_name, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: key_name + description: The storage account key name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.restore_certificate + name: restore_certificate + summary: 'Restores a backed up certificate to a vault. + + + Restores a backed up certificate, and all its versions, to a vault. + + This operation requires the certificates/restore permission.' + signature: restore_certificate(vault_base_url, certificate_bundle_backup, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_bundle_backup + description: 'The backup blob associated with a + + certificate bundle.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.restore_key + name: restore_key + summary: 'Restores a backed up key to a vault. + + + Imports a previously backed up key into Azure Key Vault, restoring the + + key, its key identifier, attributes and access control policies. The + + RESTORE operation may be used to import a previously backed up key. + + Individual versions of a key cannot be restored. The key is restored in + + its entirety with the same key name as it had when it was backed up. If + + the key name is not available in the target Key Vault, the RESTORE + + operation will be rejected. While the key name is retained during + + restore, the final key identifier will change if the key is restored to + + a different vault. Restore will restore all versions and preserve + + version identifiers. The RESTORE operation is subject to security + + constraints: The target Key Vault must be owned by the same Microsoft + + Azure Subscription as the source Key Vault The user must have RESTORE + + permission in the target Key Vault. This operation requires the + + keys/restore permission.' + signature: restore_key(vault_base_url, key_bundle_backup, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_bundle_backup + description: 'The backup blob associated with a key + + bundle.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.restore_secret + name: restore_secret + summary: 'Restores a backed up secret to a vault. + + + Restores a backed up secret, and all its versions, to a vault. This + + operation requires the secrets/restore permission.' + signature: restore_secret(vault_base_url, secret_bundle_backup, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_bundle_backup + description: 'The backup blob associated with a secret + + bundle.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.restore_storage_account + name: restore_storage_account + summary: 'Restores a backed up storage account to a vault. + + + Restores a backed up storage account to a vault. This operation + + requires the storage/restore permission.' + signature: restore_storage_account(vault_base_url, storage_bundle_backup, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_bundle_backup + description: 'The backup blob associated with a + + storage account.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.set_certificate_contacts + name: set_certificate_contacts + summary: 'Sets the certificate contacts for the specified key vault. + + + Sets the certificate contacts for the specified key vault. This + + operation requires the certificates/managecontacts permission.' + signature: set_certificate_contacts(vault_base_url, contact_list=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: contact_list + description: The contact list for the vault certificates. + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Contacts or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.set_certificate_issuer + name: set_certificate_issuer + summary: 'Sets the specified certificate issuer. + + + The SetCertificateIssuer operation adds or updates the specified + + certificate issuer. This operation requires the certificates/setissuers + + permission.' + signature: set_certificate_issuer(vault_base_url, issuer_name, provider, credentials=None, + organization_details=None, attributes=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: issuer_name + description: The name of the issuer. + isRequired: true + types: + - + - name: provider + description: The issuer provider. + isRequired: true + types: + - + - name: credentials + description: The credentials to be used for the issuer. + defaultValue: None + types: + - + - name: organization_details + description: 'Details of the organization as provided + + to the issuer.' + defaultValue: None + types: + - + - name: attributes + description: Attributes of the issuer object. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: IssuerBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.set_sas_definition + name: set_sas_definition + summary: 'Creates or updates a new SAS definition for the specified storage + + account. This operation requires the storage/setsas permission.' + signature: set_sas_definition(vault_base_url, storage_account_name, sas_definition_name, + template_uri, sas_type, validity_period, sas_definition_attributes=None, tags=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: sas_definition_name + description: The name of the SAS definition. + isRequired: true + types: + - + - name: template_uri + description: 'The SAS definition token template signed with an + + arbitrary key. Tokens created according to the SAS definition will + + have the same properties as the template.' + isRequired: true + types: + - + - name: sas_type + description: 'The type of SAS token the SAS definition will create. + + Possible values include: ''account'', ''service''' + isRequired: true + types: + - + - + - name: validity_period + description: 'The validity period of SAS tokens created + + according to the SAS definition.' + isRequired: true + types: + - + - name: sas_definition_attributes + description: 'The attributes of the SAS + + definition.' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SasDefinitionBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.set_secret + name: set_secret + summary: 'Sets a secret in a specified key vault. + + + The SET operation adds a secret to the Azure Key Vault. If the named + + secret already exists, Azure Key Vault creates a new version of that + + secret. This operation requires the secrets/set permission.' + signature: set_secret(vault_base_url, secret_name, value, tags=None, content_type=None, + secret_attributes=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: value + description: The value of the secret. + isRequired: true + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: content_type + description: Type of the secret value such as a password. + defaultValue: None + types: + - + - name: secret_attributes + description: The secret management attributes. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.set_storage_account + name: set_storage_account + summary: 'Creates or updates a new storage account. This operation requires the + + storage/set permission.' + signature: set_storage_account(vault_base_url, storage_account_name, resource_id, + active_key_name, auto_regenerate_key, regeneration_period=None, storage_account_attributes=None, + tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: resource_id + description: Storage account resource id. + isRequired: true + types: + - + - name: active_key_name + description: Current active storage account key name. + isRequired: true + types: + - + - name: auto_regenerate_key + description: 'whether keyvault should manage the storage + + account for the user.' + isRequired: true + types: + - + - name: regeneration_period + description: 'The key regeneration time duration + + specified in ISO-8601 format.' + defaultValue: None + types: + - + - name: storage_account_attributes + description: 'The attributes of the storage + + account.' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.sign + name: sign + summary: 'Creates a signature from a digest using the specified key. + + + The SIGN operation is applicable to asymmetric and symmetric keys + + stored in Azure Key Vault since this operation uses the private portion + + of the key. This operation requires the keys/sign permission.' + signature: sign(vault_base_url, key_name, key_version, algorithm, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'The signing/verification algorithm identifier. For + + more information on possible algorithm types, see + + JsonWebKeySignatureAlgorithm. Possible values include: ''PS256'', + + ''PS384'', ''PS512'', ''RS256'', ''RS384'', ''RS512'', ''RSNULL'', ''ES256'', + + ''ES384'', ''ES512'', ''ES256K''' + isRequired: true + types: + - + - + - name: value + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyOperationResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.unwrap_key + name: unwrap_key + summary: 'Unwraps a symmetric key using the specified key that was initially used + + for wrapping that key. + + + The UNWRAP operation supports decryption of a symmetric key using the + + target key encryption key. This operation is the reverse of the WRAP + + operation. The UNWRAP operation applies to asymmetric and symmetric + + keys stored in Azure Key Vault since it uses the private portion of the + + key. This operation requires the keys/unwrapKey permission.' + signature: unwrap_key(vault_base_url, key_name, key_version, algorithm, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'algorithm identifier. Possible values include: + + ''RSA-OAEP'', ''RSA-OAEP-256'', ''RSA1_5''' + isRequired: true + types: + - + - + - name: value + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyOperationResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.update_certificate + name: update_certificate + summary: 'Updates the specified attributes associated with the given certificate. + + + The UpdateCertificate operation applies the specified update on the + + given certificate; the only elements updated are the certificate''s + + attributes. This operation requires the certificates/update permission.' + signature: update_certificate(vault_base_url, certificate_name, certificate_version, + certificate_policy=None, certificate_attributes=None, tags=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: 'The name of the certificate in the given key + + vault.' + isRequired: true + types: + - + - name: certificate_version + description: The version of the certificate. + isRequired: true + types: + - + - name: certificate_policy + description: The management policy for the certificate. + defaultValue: None + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.update_certificate_issuer + name: update_certificate_issuer + summary: 'Updates the specified certificate issuer. + + + The UpdateCertificateIssuer operation performs an update on the + + specified certificate issuer entity. This operation requires the + + certificates/setissuers permission.' + signature: update_certificate_issuer(vault_base_url, issuer_name, provider=None, + credentials=None, organization_details=None, attributes=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: issuer_name + description: The name of the issuer. + isRequired: true + types: + - + - name: provider + description: The issuer provider. + defaultValue: None + types: + - + - name: credentials + description: The credentials to be used for the issuer. + defaultValue: None + types: + - + - name: organization_details + description: 'Details of the organization as provided + + to the issuer.' + defaultValue: None + types: + - + - name: attributes + description: Attributes of the issuer object. + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: IssuerBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.update_certificate_operation + name: update_certificate_operation + summary: 'Updates a certificate operation. + + + Updates a certificate creation operation that is already in progress. + + This operation requires the certificates/update permission.' + signature: update_certificate_operation(vault_base_url, certificate_name, cancellation_requested, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: The name of the certificate. + isRequired: true + types: + - + - name: cancellation_requested + description: 'Indicates if cancellation was requested + + on the certificate operation.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificateOperation or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.update_certificate_policy + name: update_certificate_policy + summary: 'Updates the policy for a certificate. + + + Set specified members in the certificate policy. Leave others as null. + + This operation requires the certificates/update permission.' + signature: update_certificate_policy(vault_base_url, certificate_name, certificate_policy, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: certificate_name + description: 'The name of the certificate in the given + + vault.' + isRequired: true + types: + - + - name: certificate_policy + description: The policy for the certificate. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: CertificatePolicy or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.update_key + name: update_key + summary: 'The update key operation changes specified attributes of a stored key + + and can be applied to any key type and key version stored in Azure Key + + Vault. + + + In order to perform this operation, the key must already exist in the + + Key Vault. Note: The cryptographic material of a key itself cannot be + + changed. This operation requires the keys/update permission.' + signature: update_key(vault_base_url, key_name, key_version, key_ops=None, key_attributes=None, + tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of key to update. + isRequired: true + types: + - + - name: key_version + description: The version of the key to update. + isRequired: true + types: + - + - name: key_ops + description: 'Json web key operations. For more information on + + possible key operations, see JsonWebKeyOperation.' + defaultValue: None + types: + - [ + - ] + - name: key_attributes + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.update_sas_definition + name: update_sas_definition + summary: 'Updates the specified attributes associated with the given SAS + + definition. This operation requires the storage/setsas permission.' + signature: update_sas_definition(vault_base_url, storage_account_name, sas_definition_name, + template_uri=None, sas_type=None, validity_period=None, sas_definition_attributes=None, + tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: sas_definition_name + description: The name of the SAS definition. + isRequired: true + types: + - + - name: template_uri + description: 'The SAS definition token template signed with an + + arbitrary key. Tokens created according to the SAS definition will + + have the same properties as the template.' + defaultValue: None + types: + - + - name: sas_type + description: 'The type of SAS token the SAS definition will create. + + Possible values include: ''account'', ''service''' + defaultValue: None + types: + - + - + - name: validity_period + description: 'The validity period of SAS tokens created + + according to the SAS definition.' + defaultValue: None + types: + - + - name: sas_definition_attributes + description: 'The attributes of the SAS + + definition.' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SasDefinitionBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.update_secret + name: update_secret + summary: 'Updates the attributes associated with a specified secret in a given + + key vault. + + + The UPDATE operation changes specified attributes of an existing stored + + secret. Attributes that are not specified in the request are left + + unchanged. The value of a secret itself cannot be changed. This + + operation requires the secrets/set permission.' + signature: update_secret(vault_base_url, secret_name, secret_version, content_type=None, + secret_attributes=None, tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: secret_name + description: The name of the secret. + isRequired: true + types: + - + - name: secret_version + description: The version of the secret. + isRequired: true + types: + - + - name: content_type + description: Type of the secret value such as a password. + defaultValue: None + types: + - + - name: secret_attributes + description: The secret management attributes. + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: SecretBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.update_storage_account + name: update_storage_account + summary: 'Updates the specified attributes associated with the given storage + + account. This operation requires the storage/set/update permission.' + signature: update_storage_account(vault_base_url, storage_account_name, active_key_name=None, + auto_regenerate_key=None, regeneration_period=None, storage_account_attributes=None, + tags=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: storage_account_name + description: The name of the storage account. + isRequired: true + types: + - + - name: active_key_name + description: The current active storage account key name. + defaultValue: None + types: + - + - name: auto_regenerate_key + description: 'whether keyvault should manage the storage + + account for the user.' + defaultValue: None + types: + - + - name: regeneration_period + description: 'The key regeneration time duration + + specified in ISO-8601 format.' + defaultValue: None + types: + - + - name: storage_account_attributes + description: 'The attributes of the storage + + account.' + defaultValue: None + types: + - + - name: tags + description: 'Application specific metadata in the form of key-value + + pairs.' + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageBundle or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.verify + name: verify + summary: 'Verifies a signature using a specified key. + + + The VERIFY operation is applicable to symmetric keys stored in Azure + + Key Vault. VERIFY is not strictly necessary for asymmetric keys stored + + in Azure Key Vault since signature verification can be performed using + + the public portion of the key but this operation is supported as a + + convenience for callers that only have a key-reference and not the + + public portion of the key. This operation requires the keys/verify + + permission.' + signature: verify(vault_base_url, key_name, key_version, algorithm, digest, signature, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'The signing/verification algorithm. For more + + information on possible algorithm types, see + + JsonWebKeySignatureAlgorithm. Possible values include: ''PS256'', + + ''PS384'', ''PS512'', ''RS256'', ''RS384'', ''RS512'', ''RSNULL'', ''ES256'', + + ''ES384'', ''ES512'', ''ES256K''' + isRequired: true + types: + - + - + - name: digest + description: The digest used for signing. + isRequired: true + types: + - + - name: signature + description: The signature to be verified. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyVerifyResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient.wrap_key + name: wrap_key + summary: 'Wraps a symmetric key using a specified key. + + + The WRAP operation supports encryption of a symmetric key using a key + + encryption key that has previously been stored in an Azure Key Vault. + + The WRAP operation is only strictly necessary for symmetric keys stored + + in Azure Key Vault since protection with an asymmetric key can be + + performed using the public portion of the key. This operation is + + supported for asymmetric keys as a convenience for callers that have a + + key-reference but do not have access to the public key material. This + + operation requires the keys/wrapKey permission.' + signature: wrap_key(vault_base_url, key_name, key_version, algorithm, value, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: vault_base_url + description: 'The vault name, for example + + [https://myvault.vault.azure.net](https://myvault.vault.azure.net).' + isRequired: true + types: + - + - name: key_name + description: The name of the key. + isRequired: true + types: + - + - name: key_version + description: The version of the key. + isRequired: true + types: + - + - name: algorithm + description: 'algorithm identifier. Possible values include: + + ''RSA-OAEP'', ''RSA-OAEP-256'', ''RSA1_5''' + isRequired: true + types: + - + - + - name: value + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: KeyOperationResult or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.keyvault.v7_0.models.KeyVaultErrorException diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.key_vault_client.KeyVaultClientConfiguration.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.key_vault_client.KeyVaultClientConfiguration.yml new file mode 100644 index 00000000..4f36b895 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.key_vault_client.KeyVaultClientConfiguration.yml @@ -0,0 +1,59 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClientConfiguration +name: KeyVaultClientConfiguration +fullName: azure.keyvault.v7_0.key_vault_client.KeyVaultClientConfiguration +module: azure.keyvault.v7_0.key_vault_client +summary: 'Configuration for KeyVaultClient + + Note that all parameters used to create this instance are saved as instance + + attributes.' +constructor: + syntax: KeyVaultClientConfiguration(credentials) + parameters: + - name: credentials + description: Credentials needed for the client to connect to Azure. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClientConfiguration.add_user_agent + name: add_user_agent + summary: Add value to current user agent with a space. + signature: 'add_user_agent(value: str) -> None' + parameters: + - name: value + description: value to add to user agent. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClientConfiguration.load + name: load + summary: Load configuration from existing file. + signature: load(filepath) + parameters: + - name: filepath + description: Path to existing config file. + isRequired: true + types: + - + exceptions: + - type: ValueError if supplied config file is invalid. +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClientConfiguration.save + name: save + summary: Save current configuration to file. + signature: save(filepath) + parameters: + - name: filepath + description: Path to save file to. + isRequired: true + types: + - + exceptions: + - type: ValueError if supplied filepath cannot be written to. +attributes: +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClientConfiguration.enable_http_logger + name: enable_http_logger +- uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClientConfiguration.user_agent + name: user_agent + summary: The current user agent value. diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.key_vault_client.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.key_vault_client.yml new file mode 100644 index 00000000..e69df9fb --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.key_vault_client.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.key_vault_client +name: key_vault_client +fullName: azure.keyvault.v7_0.key_vault_client +classes: +- azure.keyvault.v7_0.key_vault_client.KeyVaultClient +- azure.keyvault.v7_0.key_vault_client.KeyVaultClientConfiguration diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Action(class).yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Action(class).yml new file mode 100644 index 00000000..587af155 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Action(class).yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.Action +name: Action +fullName: azure.keyvault.v7_0.models.Action +module: azure.keyvault.v7_0.models +summary: The action that will be executed. +constructor: + syntax: Action(*, action_type=None, **kwargs) + parameters: + - name: action_type + description: 'The type of the action. Possible values include: + + ''EmailContacts'', ''AutoRenew''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: action_type + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.Action.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.Action.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.Action.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.Action.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.Action.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.Action.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.Action.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.ActionType.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.ActionType.yml new file mode 100644 index 00000000..5e78daef --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.ActionType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v7_0.models.ActionType +name: ActionType +fullName: azure.keyvault.v7_0.models.ActionType +module: azure.keyvault.v7_0.models +fields: +- name: auto_renew + uid: azure.keyvault.v7_0.models.ActionType.auto_renew +- name: email_contacts + uid: azure.keyvault.v7_0.models.ActionType.email_contacts diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.AdministratorDetails.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.AdministratorDetails.yml new file mode 100644 index 00000000..d72d1a43 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.AdministratorDetails.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.AdministratorDetails +name: AdministratorDetails +fullName: azure.keyvault.v7_0.models.AdministratorDetails +module: azure.keyvault.v7_0.models +summary: Details of the organization administrator of the certificate issuer. +constructor: + syntax: 'AdministratorDetails(*, first_name: str = None, last_name: str = None, + email_address: str = None, phone: str = None, **kwargs)' + parameters: + - name: first_name + description: First name. + isRequired: true + types: + - + - name: last_name + description: Last name. + isRequired: true + types: + - + - name: email_address + description: Email addresss. + isRequired: true + types: + - + - name: phone + description: Phone number. + isRequired: true + types: + - + keywordOnlyParameters: + - name: first_name + isRequired: true + - name: last_name + isRequired: true + - name: email_address + isRequired: true + - name: phone + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.AdministratorDetails.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.AdministratorDetails.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.AdministratorDetails.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.AdministratorDetails.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.AdministratorDetails.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.AdministratorDetails.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.AdministratorDetails.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Attributes(class).yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Attributes(class).yml new file mode 100644 index 00000000..5b996439 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Attributes(class).yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.Attributes +name: Attributes +fullName: azure.keyvault.v7_0.models.Attributes +module: azure.keyvault.v7_0.models +summary: 'The object attributes managed by the KeyVault service. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'Attributes(*, enabled: bool = None, not_before=None, expires=None, **kwargs)' + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true + - name: not_before + isRequired: true + - name: expires + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +methods: +- uid: azure.keyvault.v7_0.models.Attributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.Attributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.Attributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.Attributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.Attributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.Attributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.Attributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.BackupCertificateResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.BackupCertificateResult.yml new file mode 100644 index 00000000..94dae272 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.BackupCertificateResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.BackupCertificateResult +name: BackupCertificateResult +fullName: azure.keyvault.v7_0.models.BackupCertificateResult +module: azure.keyvault.v7_0.models +summary: 'The backup certificate result, containing the backup blob. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: BackupCertificateResult(**kwargs) +variables: +- description: The backup blob containing the backed up certificate. + name: value + types: + - +methods: +- uid: azure.keyvault.v7_0.models.BackupCertificateResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.BackupCertificateResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.BackupCertificateResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.BackupCertificateResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.BackupCertificateResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.BackupCertificateResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.BackupCertificateResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.BackupKeyResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.BackupKeyResult.yml new file mode 100644 index 00000000..a32300e4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.BackupKeyResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.BackupKeyResult +name: BackupKeyResult +fullName: azure.keyvault.v7_0.models.BackupKeyResult +module: azure.keyvault.v7_0.models +summary: 'The backup key result, containing the backup blob. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: BackupKeyResult(**kwargs) +variables: +- description: The backup blob containing the backed up key. + name: value + types: + - +methods: +- uid: azure.keyvault.v7_0.models.BackupKeyResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.BackupKeyResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.BackupKeyResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.BackupKeyResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.BackupKeyResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.BackupKeyResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.BackupKeyResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.BackupSecretResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.BackupSecretResult.yml new file mode 100644 index 00000000..1d9cd6f7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.BackupSecretResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.BackupSecretResult +name: BackupSecretResult +fullName: azure.keyvault.v7_0.models.BackupSecretResult +module: azure.keyvault.v7_0.models +summary: 'The backup secret result, containing the backup blob. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: BackupSecretResult(**kwargs) +variables: +- description: The backup blob containing the backed up secret. + name: value + types: + - +methods: +- uid: azure.keyvault.v7_0.models.BackupSecretResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.BackupSecretResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.BackupSecretResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.BackupSecretResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.BackupSecretResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.BackupSecretResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.BackupSecretResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.BackupStorageResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.BackupStorageResult.yml new file mode 100644 index 00000000..3cbcf014 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.BackupStorageResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.BackupStorageResult +name: BackupStorageResult +fullName: azure.keyvault.v7_0.models.BackupStorageResult +module: azure.keyvault.v7_0.models +summary: 'The backup storage result, containing the backup blob. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: BackupStorageResult(**kwargs) +variables: +- description: The backup blob containing the backed up storage account. + name: value + types: + - +methods: +- uid: azure.keyvault.v7_0.models.BackupStorageResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.BackupStorageResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.BackupStorageResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.BackupStorageResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.BackupStorageResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.BackupStorageResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.BackupStorageResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateAttributes.yml new file mode 100644 index 00000000..a3732cf4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateAttributes.yml @@ -0,0 +1,169 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.CertificateAttributes +name: CertificateAttributes +fullName: azure.keyvault.v7_0.models.CertificateAttributes +module: azure.keyvault.v7_0.models +summary: 'The certificate management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'CertificateAttributes(*, enabled: bool = None, not_before=None, expires=None, + **kwargs)' + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true + - name: not_before + isRequired: true + - name: expires + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for certificates in the current vault. If it contains ''Purgeable'', + + the certificate can be permanently deleted by a privileged user; + + otherwise, only the system can purge the certificate, at the end of the + + retention interval. Possible values include: ''Purgeable'', + + ''Recoverable+Purgeable'', ''Recoverable'', + + ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v7_0.models.CertificateAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.CertificateAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.CertificateAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateBundle.yml new file mode 100644 index 00000000..6cc23243 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateBundle.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.CertificateBundle +name: CertificateBundle +fullName: azure.keyvault.v7_0.models.CertificateBundle +module: azure.keyvault.v7_0.models +summary: 'A certificate bundle consists of a certificate (X509) plus its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'CertificateBundle(*, cer: bytearray = None, content_type: str = None, attributes=None, + tags=None, **kwargs)' + parameters: + - name: cer + description: CER contents of x509 certificate. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The certificate attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: cer + isRequired: true + - name: content_type + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true +variables: +- description: The certificate id. + name: id + types: + - +- description: The key id. + name: kid + types: + - +- description: The secret id. + name: sid + types: + - +- description: Thumbprint of the certificate. + name: x509_thumbprint + types: + - +- description: The management policy. + name: policy + types: + - +methods: +- uid: azure.keyvault.v7_0.models.CertificateBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.CertificateBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.CertificateBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateCreateParameters.yml new file mode 100644 index 00000000..f86fe662 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateCreateParameters.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.CertificateCreateParameters +name: CertificateCreateParameters +fullName: azure.keyvault.v7_0.models.CertificateCreateParameters +module: azure.keyvault.v7_0.models +summary: The certificate create parameters. +constructor: + syntax: CertificateCreateParameters(*, certificate_policy=None, certificate_attributes=None, + tags=None, **kwargs) + parameters: + - name: certificate_policy + description: The management policy for the certificate. + isRequired: true + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: certificate_policy + isRequired: true + - name: certificate_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.CertificateCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.CertificateCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.CertificateCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateImportParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateImportParameters.yml new file mode 100644 index 00000000..fd83415a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateImportParameters.yml @@ -0,0 +1,163 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.CertificateImportParameters +name: CertificateImportParameters +fullName: azure.keyvault.v7_0.models.CertificateImportParameters +module: azure.keyvault.v7_0.models +summary: 'The certificate import parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CertificateImportParameters(*, base64_encoded_certificate: str, password: + str = None, certificate_policy=None, certificate_attributes=None, tags=None, **kwargs)' + parameters: + - name: base64_encoded_certificate + description: 'Required. Base64 encoded representation + + of the certificate object to import. This certificate needs to contain the + + private key.' + isRequired: true + types: + - + - name: password + description: 'If the private key in base64EncodedCertificate is + + encrypted, the password used for encryption.' + isRequired: true + types: + - + - name: certificate_policy + description: The management policy for the certificate. + isRequired: true + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: base64_encoded_certificate + isRequired: true + - name: password + isRequired: true + - name: certificate_policy + isRequired: true + - name: certificate_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.CertificateImportParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateImportParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateImportParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.CertificateImportParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateImportParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.CertificateImportParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateImportParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerItem.yml new file mode 100644 index 00000000..7b0c6810 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerItem.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.CertificateIssuerItem +name: CertificateIssuerItem +fullName: azure.keyvault.v7_0.models.CertificateIssuerItem +module: azure.keyvault.v7_0.models +summary: The certificate issuer item containing certificate issuer metadata. +constructor: + syntax: 'CertificateIssuerItem(*, id: str = None, provider: str = None, **kwargs)' + parameters: + - name: id + description: Certificate Identifier. + isRequired: true + types: + - + - name: provider + description: The issuer provider. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: provider + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.CertificateIssuerItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateIssuerItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateIssuerItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.CertificateIssuerItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateIssuerItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.CertificateIssuerItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateIssuerItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerItemPaged.yml new file mode 100644 index 00000000..e858fb99 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.CertificateIssuerItemPaged +name: CertificateIssuerItemPaged +fullName: azure.keyvault.v7_0.models.CertificateIssuerItemPaged +module: azure.keyvault.v7_0.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: CertificateIssuerItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v7_0.models.CertificateIssuerItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v7_0.models.CertificateIssuerItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v7_0.models.CertificateIssuerItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.CertificateIssuerItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.CertificateIssuerItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v7_0.models.CertificateIssuerItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v7_0.models.CertificateIssuerItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerSetParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerSetParameters.yml new file mode 100644 index 00000000..ae8d9904 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerSetParameters.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.CertificateIssuerSetParameters +name: CertificateIssuerSetParameters +fullName: azure.keyvault.v7_0.models.CertificateIssuerSetParameters +module: azure.keyvault.v7_0.models +summary: 'The certificate issuer set parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CertificateIssuerSetParameters(*, provider: str, credentials=None, organization_details=None, + attributes=None, **kwargs)' + parameters: + - name: provider + description: Required. The issuer provider. + isRequired: true + types: + - + - name: credentials + description: The credentials to be used for the issuer. + isRequired: true + types: + - + - name: organization_details + description: 'Details of the organization as provided to + + the issuer.' + isRequired: true + types: + - + - name: attributes + description: Attributes of the issuer object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: provider + isRequired: true + - name: credentials + isRequired: true + - name: organization_details + isRequired: true + - name: attributes + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.CertificateIssuerSetParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateIssuerSetParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateIssuerSetParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.CertificateIssuerSetParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateIssuerSetParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.CertificateIssuerSetParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateIssuerSetParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerUpdateParameters.yml new file mode 100644 index 00000000..321a8fe5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerUpdateParameters.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.CertificateIssuerUpdateParameters +name: CertificateIssuerUpdateParameters +fullName: azure.keyvault.v7_0.models.CertificateIssuerUpdateParameters +module: azure.keyvault.v7_0.models +summary: The certificate issuer update parameters. +constructor: + syntax: 'CertificateIssuerUpdateParameters(*, provider: str = None, credentials=None, + organization_details=None, attributes=None, **kwargs)' + parameters: + - name: provider + description: The issuer provider. + isRequired: true + types: + - + - name: credentials + description: The credentials to be used for the issuer. + isRequired: true + types: + - + - name: organization_details + description: 'Details of the organization as provided to + + the issuer.' + isRequired: true + types: + - + - name: attributes + description: Attributes of the issuer object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: provider + isRequired: true + - name: credentials + isRequired: true + - name: organization_details + isRequired: true + - name: attributes + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.CertificateIssuerUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateIssuerUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateIssuerUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.CertificateIssuerUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateIssuerUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.CertificateIssuerUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateIssuerUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateItem.yml new file mode 100644 index 00000000..8b71bcda --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateItem.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.CertificateItem +name: CertificateItem +fullName: azure.keyvault.v7_0.models.CertificateItem +module: azure.keyvault.v7_0.models +summary: The certificate item containing certificate metadata. +constructor: + syntax: 'CertificateItem(*, id: str = None, attributes=None, tags=None, x509_thumbprint: + bytes = None, **kwargs)' + parameters: + - name: id + description: Certificate identifier. + isRequired: true + types: + - + - name: attributes + description: The certificate management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: x509_thumbprint + description: Thumbprint of the certificate. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: x509_thumbprint + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.CertificateItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.CertificateItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.CertificateItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateItemPaged.yml new file mode 100644 index 00000000..e078814c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.CertificateItemPaged +name: CertificateItemPaged +fullName: azure.keyvault.v7_0.models.CertificateItemPaged +module: azure.keyvault.v7_0.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: CertificateItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v7_0.models.CertificateItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v7_0.models.CertificateItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v7_0.models.CertificateItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.CertificateItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.CertificateItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v7_0.models.CertificateItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v7_0.models.CertificateItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateMergeParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateMergeParameters.yml new file mode 100644 index 00000000..93fe66d1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateMergeParameters.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.CertificateMergeParameters +name: CertificateMergeParameters +fullName: azure.keyvault.v7_0.models.CertificateMergeParameters +module: azure.keyvault.v7_0.models +summary: 'The certificate merge parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CertificateMergeParameters(*, x509_certificates, certificate_attributes=None, + tags=None, **kwargs) + parameters: + - name: x509_certificates + description: 'Required. The certificate or the certificate + + chain to merge.' + isRequired: true + types: + - [] + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: x509_certificates + isRequired: true + - name: certificate_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.CertificateMergeParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateMergeParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateMergeParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.CertificateMergeParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateMergeParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.CertificateMergeParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateMergeParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateOperation.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateOperation.yml new file mode 100644 index 00000000..c3765422 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateOperation.yml @@ -0,0 +1,192 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.CertificateOperation +name: CertificateOperation +fullName: azure.keyvault.v7_0.models.CertificateOperation +module: azure.keyvault.v7_0.models +summary: 'A certificate operation is returned in case of asynchronous requests. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'CertificateOperation(*, issuer_parameters=None, csr: bytearray = None, + cancellation_requested: bool = None, status: str = None, status_details: str = + None, error=None, target: str = None, request_id: str = None, **kwargs)' + parameters: + - name: issuer_parameters + description: 'Parameters for the issuer of the X509 component + + of a certificate.' + isRequired: true + types: + - + - name: csr + description: 'The certificate signing request (CSR) that is being used in + + the certificate operation.' + isRequired: true + types: + - + - name: cancellation_requested + description: 'Indicates if cancellation was requested on + + the certificate operation.' + isRequired: true + types: + - + - name: status + description: Status of the certificate operation. + isRequired: true + types: + - + - name: status_details + description: The status details of the certificate operation. + isRequired: true + types: + - + - name: error + description: Error encountered, if any, during the certificate operation. + isRequired: true + types: + - + - name: target + description: 'Location which contains the result of the certificate + + operation.' + isRequired: true + types: + - + - name: request_id + description: Identifier for the certificate operation. + isRequired: true + types: + - + keywordOnlyParameters: + - name: issuer_parameters + isRequired: true + - name: csr + isRequired: true + - name: cancellation_requested + isRequired: true + - name: status + isRequired: true + - name: status_details + isRequired: true + - name: error + isRequired: true + - name: target + isRequired: true + - name: request_id + isRequired: true +variables: +- description: The certificate id. + name: id + types: + - +methods: +- uid: azure.keyvault.v7_0.models.CertificateOperation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateOperation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateOperation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.CertificateOperation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateOperation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.CertificateOperation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateOperation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateOperationUpdateParameter.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateOperationUpdateParameter.yml new file mode 100644 index 00000000..59d9b88e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateOperationUpdateParameter.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.CertificateOperationUpdateParameter +name: CertificateOperationUpdateParameter +fullName: azure.keyvault.v7_0.models.CertificateOperationUpdateParameter +module: azure.keyvault.v7_0.models +summary: 'The certificate operation update parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CertificateOperationUpdateParameter(*, cancellation_requested: bool, **kwargs)' + parameters: + - name: cancellation_requested + description: 'Required. Indicates if cancellation was + + requested on the certificate operation.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cancellation_requested + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.CertificateOperationUpdateParameter.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateOperationUpdateParameter.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateOperationUpdateParameter.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.CertificateOperationUpdateParameter.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateOperationUpdateParameter.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.CertificateOperationUpdateParameter.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateOperationUpdateParameter.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificatePolicy.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificatePolicy.yml new file mode 100644 index 00000000..abcfbaf3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificatePolicy.yml @@ -0,0 +1,175 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.CertificatePolicy +name: CertificatePolicy +fullName: azure.keyvault.v7_0.models.CertificatePolicy +module: azure.keyvault.v7_0.models +summary: 'Management policy for a certificate. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: CertificatePolicy(*, key_properties=None, secret_properties=None, x509_certificate_properties=None, + lifetime_actions=None, issuer_parameters=None, attributes=None, **kwargs) + parameters: + - name: key_properties + description: Properties of the key backing a certificate. + isRequired: true + types: + - + - name: secret_properties + description: Properties of the secret backing a certificate. + isRequired: true + types: + - + - name: x509_certificate_properties + description: 'Properties of the X509 component of a + + certificate.' + isRequired: true + types: + - + - name: lifetime_actions + description: 'Actions that will be performed by Key Vault over + + the lifetime of a certificate.' + isRequired: true + types: + - [] + - name: issuer_parameters + description: 'Parameters for the issuer of the X509 component + + of a certificate.' + isRequired: true + types: + - + - name: attributes + description: The certificate attributes. + isRequired: true + types: + - + keywordOnlyParameters: + - name: key_properties + isRequired: true + - name: secret_properties + isRequired: true + - name: x509_certificate_properties + isRequired: true + - name: lifetime_actions + isRequired: true + - name: issuer_parameters + isRequired: true + - name: attributes + isRequired: true +variables: +- description: The certificate id. + name: id + types: + - +methods: +- uid: azure.keyvault.v7_0.models.CertificatePolicy.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificatePolicy.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificatePolicy.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.CertificatePolicy.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificatePolicy.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.CertificatePolicy.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificatePolicy.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateRestoreParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateRestoreParameters.yml new file mode 100644 index 00000000..ff7607e1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateRestoreParameters.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.CertificateRestoreParameters +name: CertificateRestoreParameters +fullName: azure.keyvault.v7_0.models.CertificateRestoreParameters +module: azure.keyvault.v7_0.models +summary: 'The certificate restore parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CertificateRestoreParameters(*, certificate_bundle_backup: bytes, **kwargs)' + parameters: + - name: certificate_bundle_backup + description: 'Required. The backup blob associated + + with a certificate bundle.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: certificate_bundle_backup + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.CertificateRestoreParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateRestoreParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateRestoreParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.CertificateRestoreParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateRestoreParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.CertificateRestoreParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateRestoreParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateUpdateParameters.yml new file mode 100644 index 00000000..cb9efcd3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateUpdateParameters.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.CertificateUpdateParameters +name: CertificateUpdateParameters +fullName: azure.keyvault.v7_0.models.CertificateUpdateParameters +module: azure.keyvault.v7_0.models +summary: The certificate update parameters. +constructor: + syntax: CertificateUpdateParameters(*, certificate_policy=None, certificate_attributes=None, + tags=None, **kwargs) + parameters: + - name: certificate_policy + description: The management policy for the certificate. + isRequired: true + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: certificate_policy + isRequired: true + - name: certificate_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.CertificateUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.CertificateUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.CertificateUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.CertificateUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.CertificateUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Contact(class).yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Contact(class).yml new file mode 100644 index 00000000..c15922f5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Contact(class).yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.Contact +name: Contact +fullName: azure.keyvault.v7_0.models.Contact +module: azure.keyvault.v7_0.models +summary: The contact information for the vault certificates. +constructor: + syntax: 'Contact(*, email_address: str = None, name: str = None, phone: str = None, + **kwargs)' + parameters: + - name: email_address + description: Email addresss. + isRequired: true + types: + - + - name: name + description: Name. + isRequired: true + types: + - + - name: phone + description: Phone number. + isRequired: true + types: + - + keywordOnlyParameters: + - name: email_address + isRequired: true + - name: name + isRequired: true + - name: phone + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.Contact.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.Contact.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.Contact.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.Contact.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.Contact.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.Contact.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.Contact.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Contacts(class).yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Contacts(class).yml new file mode 100644 index 00000000..16ae8907 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Contacts(class).yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.Contacts +name: Contacts +fullName: azure.keyvault.v7_0.models.Contacts +module: azure.keyvault.v7_0.models +summary: 'The contacts for the vault certificates. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Contacts(*, contact_list=None, **kwargs) + parameters: + - name: contact_list + description: The contact list for the vault certificates. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: contact_list + isRequired: true +variables: +- description: Identifier for the contacts collection. + name: id + types: + - +methods: +- uid: azure.keyvault.v7_0.models.Contacts.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.Contacts.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.Contacts.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.Contacts.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.Contacts.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.Contacts.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.Contacts.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedCertificateBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedCertificateBundle.yml new file mode 100644 index 00000000..b36f784d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedCertificateBundle.yml @@ -0,0 +1,192 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.DeletedCertificateBundle +name: DeletedCertificateBundle +fullName: azure.keyvault.v7_0.models.DeletedCertificateBundle +module: azure.keyvault.v7_0.models +summary: 'A Deleted Certificate consisting of its previous id, attributes and its + + tags, as well as information on when it will be purged. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedCertificateBundle(*, cer: bytearray = None, content_type: str = + None, attributes=None, tags=None, recovery_id: str = None, **kwargs)' + parameters: + - name: cer + description: CER contents of x509 certificate. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The certificate attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted certificate.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cer + isRequired: true + - name: content_type + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: The certificate id. + name: id + types: + - +- description: The key id. + name: kid + types: + - +- description: The secret id. + name: sid + types: + - +- description: Thumbprint of the certificate. + name: x509_thumbprint + types: + - +- description: The management policy. + name: policy + types: + - +- description: 'The time when the certificate is scheduled to + + be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the certificate was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.DeletedCertificateBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.DeletedCertificateBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.DeletedCertificateBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.DeletedCertificateBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.DeletedCertificateBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.DeletedCertificateBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.DeletedCertificateBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedCertificateItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedCertificateItem.yml new file mode 100644 index 00000000..fb3987b7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedCertificateItem.yml @@ -0,0 +1,172 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.DeletedCertificateItem +name: DeletedCertificateItem +fullName: azure.keyvault.v7_0.models.DeletedCertificateItem +module: azure.keyvault.v7_0.models +summary: 'The deleted certificate item containing metadata about the deleted + + certificate. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedCertificateItem(*, id: str = None, attributes=None, tags=None, x509_thumbprint: + bytes = None, recovery_id: str = None, **kwargs)' + parameters: + - name: id + description: Certificate identifier. + isRequired: true + types: + - + - name: attributes + description: The certificate management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: x509_thumbprint + description: Thumbprint of the certificate. + isRequired: true + types: + - + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted certificate.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: x509_thumbprint + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: 'The time when the certificate is scheduled to + + be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the certificate was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.DeletedCertificateItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.DeletedCertificateItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.DeletedCertificateItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.DeletedCertificateItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.DeletedCertificateItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.DeletedCertificateItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.DeletedCertificateItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedCertificateItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedCertificateItemPaged.yml new file mode 100644 index 00000000..1744239f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedCertificateItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.DeletedCertificateItemPaged +name: DeletedCertificateItemPaged +fullName: azure.keyvault.v7_0.models.DeletedCertificateItemPaged +module: azure.keyvault.v7_0.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: DeletedCertificateItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v7_0.models.DeletedCertificateItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v7_0.models.DeletedCertificateItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v7_0.models.DeletedCertificateItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.DeletedCertificateItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.DeletedCertificateItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v7_0.models.DeletedCertificateItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v7_0.models.DeletedCertificateItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedKeyBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedKeyBundle.yml new file mode 100644 index 00000000..962a8e94 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedKeyBundle.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.DeletedKeyBundle +name: DeletedKeyBundle +fullName: azure.keyvault.v7_0.models.DeletedKeyBundle +module: azure.keyvault.v7_0.models +summary: 'A DeletedKeyBundle consisting of a WebKey plus its Attributes and deletion + + info. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedKeyBundle(*, key=None, attributes=None, tags=None, recovery_id: + str = None, **kwargs)' + parameters: + - name: key + description: The Json web key. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted key.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: key + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the key is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the key was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.DeletedKeyBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.DeletedKeyBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.DeletedKeyBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.DeletedKeyBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.DeletedKeyBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.DeletedKeyBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.DeletedKeyBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedKeyItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedKeyItem.yml new file mode 100644 index 00000000..ca35e738 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedKeyItem.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.DeletedKeyItem +name: DeletedKeyItem +fullName: azure.keyvault.v7_0.models.DeletedKeyItem +module: azure.keyvault.v7_0.models +summary: 'The deleted key item containing the deleted key metadata and information + + about deletion. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedKeyItem(*, kid: str = None, attributes=None, tags=None, recovery_id: + str = None, **kwargs)' + parameters: + - name: kid + description: Key identifier. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted key.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: kid + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the key is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the key was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.DeletedKeyItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.DeletedKeyItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.DeletedKeyItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.DeletedKeyItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.DeletedKeyItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.DeletedKeyItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.DeletedKeyItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedKeyItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedKeyItemPaged.yml new file mode 100644 index 00000000..e37cf073 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedKeyItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.DeletedKeyItemPaged +name: DeletedKeyItemPaged +fullName: azure.keyvault.v7_0.models.DeletedKeyItemPaged +module: azure.keyvault.v7_0.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: DeletedKeyItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v7_0.models.DeletedKeyItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v7_0.models.DeletedKeyItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v7_0.models.DeletedKeyItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.DeletedKeyItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.DeletedKeyItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v7_0.models.DeletedKeyItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v7_0.models.DeletedKeyItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSasDefinitionBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSasDefinitionBundle.yml new file mode 100644 index 00000000..bd7805a4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSasDefinitionBundle.yml @@ -0,0 +1,180 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.DeletedSasDefinitionBundle +name: DeletedSasDefinitionBundle +fullName: azure.keyvault.v7_0.models.DeletedSasDefinitionBundle +module: azure.keyvault.v7_0.models +summary: 'A deleted SAS definition bundle consisting of its previous id, attributes + + and its tags, as well as information on when it will be purged. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedSasDefinitionBundle(*, recovery_id: str = None, **kwargs)' + parameters: + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted SAS definition.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: recovery_id + isRequired: true +variables: +- description: The SAS definition id. + name: id + types: + - +- description: Storage account SAS definition secret id. + name: secret_id + types: + - +- description: 'The SAS definition token template signed with an + + arbitrary key. Tokens created according to the SAS definition will have + + the same properties as the template.' + name: template_uri + types: + - +- description: 'The type of SAS token the SAS definition will create. + + Possible values include: ''account'', ''service''' + name: sas_type + types: + - + - +- description: 'The validity period of SAS tokens created according + + to the SAS definition.' + name: validity_period + types: + - +- description: The SAS definition attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs + name: tags + types: + - [, ] +- description: 'The time when the SAS definition is scheduled + + to be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the SAS definition was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.DeletedSasDefinitionBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.DeletedSasDefinitionBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.DeletedSasDefinitionBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.DeletedSasDefinitionBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.DeletedSasDefinitionBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.DeletedSasDefinitionBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.DeletedSasDefinitionBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSasDefinitionItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSasDefinitionItem.yml new file mode 100644 index 00000000..5d98d4ca --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSasDefinitionItem.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.DeletedSasDefinitionItem +name: DeletedSasDefinitionItem +fullName: azure.keyvault.v7_0.models.DeletedSasDefinitionItem +module: azure.keyvault.v7_0.models +summary: 'The deleted SAS definition item containing metadata about the deleted SAS + + definition. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedSasDefinitionItem(*, recovery_id: str = None, **kwargs)' + parameters: + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted SAS definition.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: recovery_id + isRequired: true +variables: +- description: The storage SAS identifier. + name: id + types: + - +- description: The storage account SAS definition secret id. + name: secret_id + types: + - +- description: The SAS definition management attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs. + name: tags + types: + - [, ] +- description: 'The time when the SAS definition is scheduled + + to be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the SAS definition was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.DeletedSasDefinitionItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.DeletedSasDefinitionItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.DeletedSasDefinitionItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.DeletedSasDefinitionItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.DeletedSasDefinitionItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.DeletedSasDefinitionItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.DeletedSasDefinitionItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSasDefinitionItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSasDefinitionItemPaged.yml new file mode 100644 index 00000000..42615ecf --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSasDefinitionItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.DeletedSasDefinitionItemPaged +name: DeletedSasDefinitionItemPaged +fullName: azure.keyvault.v7_0.models.DeletedSasDefinitionItemPaged +module: azure.keyvault.v7_0.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: DeletedSasDefinitionItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v7_0.models.DeletedSasDefinitionItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v7_0.models.DeletedSasDefinitionItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v7_0.models.DeletedSasDefinitionItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.DeletedSasDefinitionItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.DeletedSasDefinitionItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v7_0.models.DeletedSasDefinitionItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v7_0.models.DeletedSasDefinitionItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSecretBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSecretBundle.yml new file mode 100644 index 00000000..c948b932 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSecretBundle.yml @@ -0,0 +1,192 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.DeletedSecretBundle +name: DeletedSecretBundle +fullName: azure.keyvault.v7_0.models.DeletedSecretBundle +module: azure.keyvault.v7_0.models +summary: 'A Deleted Secret consisting of its previous id, attributes and its tags, + as + + well as information on when it will be purged. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedSecretBundle(*, value: str = None, id: str = None, content_type: + str = None, attributes=None, tags=None, recovery_id: str = None, **kwargs)' + parameters: + - name: value + description: The secret value. + isRequired: true + types: + - + - name: id + description: The secret id. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted secret.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: id + isRequired: true + - name: content_type + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: 'If this is a secret backing a KV certificate, then this field + + specifies the corresponding key backing the KV certificate.' + name: kid + types: + - +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a secret backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the secret is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the secret was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.DeletedSecretBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.DeletedSecretBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.DeletedSecretBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.DeletedSecretBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.DeletedSecretBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.DeletedSecretBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.DeletedSecretBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSecretItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSecretItem.yml new file mode 100644 index 00000000..12525508 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSecretItem.yml @@ -0,0 +1,176 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.DeletedSecretItem +name: DeletedSecretItem +fullName: azure.keyvault.v7_0.models.DeletedSecretItem +module: azure.keyvault.v7_0.models +summary: 'The deleted secret item containing metadata about the deleted secret. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedSecretItem(*, id: str = None, attributes=None, tags=None, content_type: + str = None, recovery_id: str = None, **kwargs)' + parameters: + - name: id + description: Secret identifier. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted secret.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: content_type + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a key backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the secret is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the secret was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.DeletedSecretItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.DeletedSecretItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.DeletedSecretItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.DeletedSecretItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.DeletedSecretItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.DeletedSecretItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.DeletedSecretItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSecretItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSecretItemPaged.yml new file mode 100644 index 00000000..f85bb3b3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSecretItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.DeletedSecretItemPaged +name: DeletedSecretItemPaged +fullName: azure.keyvault.v7_0.models.DeletedSecretItemPaged +module: azure.keyvault.v7_0.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: DeletedSecretItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v7_0.models.DeletedSecretItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v7_0.models.DeletedSecretItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v7_0.models.DeletedSecretItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.DeletedSecretItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.DeletedSecretItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v7_0.models.DeletedSecretItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v7_0.models.DeletedSecretItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedStorageAccountItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedStorageAccountItem.yml new file mode 100644 index 00000000..c0ab6b35 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedStorageAccountItem.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.DeletedStorageAccountItem +name: DeletedStorageAccountItem +fullName: azure.keyvault.v7_0.models.DeletedStorageAccountItem +module: azure.keyvault.v7_0.models +summary: 'The deleted storage account item containing metadata about the deleted + + storage account. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedStorageAccountItem(*, recovery_id: str = None, **kwargs)' + parameters: + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted storage account.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: recovery_id + isRequired: true +variables: +- description: Storage identifier. + name: id + types: + - +- description: Storage account resource Id. + name: resource_id + types: + - +- description: The storage account management attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs. + name: tags + types: + - [, ] +- description: 'The time when the storage account is scheduled + + to be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the storage account was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.DeletedStorageAccountItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.DeletedStorageAccountItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.DeletedStorageAccountItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.DeletedStorageAccountItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.DeletedStorageAccountItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.DeletedStorageAccountItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.DeletedStorageAccountItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedStorageAccountItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedStorageAccountItemPaged.yml new file mode 100644 index 00000000..326ade77 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedStorageAccountItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.DeletedStorageAccountItemPaged +name: DeletedStorageAccountItemPaged +fullName: azure.keyvault.v7_0.models.DeletedStorageAccountItemPaged +module: azure.keyvault.v7_0.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: DeletedStorageAccountItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v7_0.models.DeletedStorageAccountItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v7_0.models.DeletedStorageAccountItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v7_0.models.DeletedStorageAccountItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.DeletedStorageAccountItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.DeletedStorageAccountItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v7_0.models.DeletedStorageAccountItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v7_0.models.DeletedStorageAccountItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedStorageBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedStorageBundle.yml new file mode 100644 index 00000000..eb60a521 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedStorageBundle.yml @@ -0,0 +1,175 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.DeletedStorageBundle +name: DeletedStorageBundle +fullName: azure.keyvault.v7_0.models.DeletedStorageBundle +module: azure.keyvault.v7_0.models +summary: 'A deleted storage account bundle consisting of its previous id, attributes + + and its tags, as well as information on when it will be purged. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedStorageBundle(*, recovery_id: str = None, **kwargs)' + parameters: + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted storage account.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: recovery_id + isRequired: true +variables: +- description: The storage account id. + name: id + types: + - +- description: The storage account resource id. + name: resource_id + types: + - +- description: The current active storage account key name. + name: active_key_name + types: + - +- description: 'whether keyvault should manage the storage + + account for the user.' + name: auto_regenerate_key + types: + - +- description: 'The key regeneration time duration specified in + + ISO-8601 format.' + name: regeneration_period + types: + - +- description: The storage account attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs + name: tags + types: + - [, ] +- description: 'The time when the storage account is scheduled + + to be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the storage account was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.DeletedStorageBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.DeletedStorageBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.DeletedStorageBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.DeletedStorageBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.DeletedStorageBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.DeletedStorageBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.DeletedStorageBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletionRecoveryLevel.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletionRecoveryLevel.yml new file mode 100644 index 00000000..ae22b6e0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletionRecoveryLevel.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v7_0.models.DeletionRecoveryLevel +name: DeletionRecoveryLevel +fullName: azure.keyvault.v7_0.models.DeletionRecoveryLevel +module: azure.keyvault.v7_0.models +fields: +- name: purgeable + uid: azure.keyvault.v7_0.models.DeletionRecoveryLevel.purgeable +- name: recoverable + uid: azure.keyvault.v7_0.models.DeletionRecoveryLevel.recoverable +- name: recoverable_protected_subscription + uid: azure.keyvault.v7_0.models.DeletionRecoveryLevel.recoverable_protected_subscription +- name: recoverable_purgeable + uid: azure.keyvault.v7_0.models.DeletionRecoveryLevel.recoverable_purgeable diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Error(class).yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Error(class).yml new file mode 100644 index 00000000..bb176a7d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Error(class).yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.Error +name: Error +fullName: azure.keyvault.v7_0.models.Error +module: azure.keyvault.v7_0.models +summary: 'The key vault server error. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Error(**kwargs) +variables: +- description: The error code. + name: code + types: + - +- description: The error message. + name: message + types: + - +- name: inner_error + types: + - +methods: +- uid: azure.keyvault.v7_0.models.Error.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.Error.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.Error.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.Error.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.Error.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.Error.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.Error.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerAttributes.yml new file mode 100644 index 00000000..c73a2686 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerAttributes.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.IssuerAttributes +name: IssuerAttributes +fullName: azure.keyvault.v7_0.models.IssuerAttributes +module: azure.keyvault.v7_0.models +summary: 'The attributes of an issuer managed by the Key Vault service. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'IssuerAttributes(*, enabled: bool = None, **kwargs)' + parameters: + - name: enabled + description: Determines whether the issuer is enabled. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +methods: +- uid: azure.keyvault.v7_0.models.IssuerAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.IssuerAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.IssuerAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.IssuerAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.IssuerAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.IssuerAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.IssuerAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerBundle.yml new file mode 100644 index 00000000..61e96ec0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerBundle.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.IssuerBundle +name: IssuerBundle +fullName: azure.keyvault.v7_0.models.IssuerBundle +module: azure.keyvault.v7_0.models +summary: 'The issuer for Key Vault certificate. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'IssuerBundle(*, provider: str = None, credentials=None, organization_details=None, + attributes=None, **kwargs)' + parameters: + - name: provider + description: The issuer provider. + isRequired: true + types: + - + - name: credentials + description: The credentials to be used for the issuer. + isRequired: true + types: + - + - name: organization_details + description: 'Details of the organization as provided to + + the issuer.' + isRequired: true + types: + - + - name: attributes + description: Attributes of the issuer object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: provider + isRequired: true + - name: credentials + isRequired: true + - name: organization_details + isRequired: true + - name: attributes + isRequired: true +variables: +- description: Identifier for the issuer object. + name: id + types: + - +methods: +- uid: azure.keyvault.v7_0.models.IssuerBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.IssuerBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.IssuerBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.IssuerBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.IssuerBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.IssuerBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.IssuerBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerCredentials.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerCredentials.yml new file mode 100644 index 00000000..f780dfd5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerCredentials.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.IssuerCredentials +name: IssuerCredentials +fullName: azure.keyvault.v7_0.models.IssuerCredentials +module: azure.keyvault.v7_0.models +summary: The credentials to be used for the certificate issuer. +constructor: + syntax: 'IssuerCredentials(*, account_id: str = None, password: str = None, **kwargs)' + parameters: + - name: account_id + description: The user name/account name/account id. + isRequired: true + types: + - + - name: password + description: The password/secret/account key. + isRequired: true + types: + - + keywordOnlyParameters: + - name: account_id + isRequired: true + - name: password + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.IssuerCredentials.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.IssuerCredentials.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.IssuerCredentials.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.IssuerCredentials.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.IssuerCredentials.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.IssuerCredentials.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.IssuerCredentials.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerParameters.yml new file mode 100644 index 00000000..e1607af6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerParameters.yml @@ -0,0 +1,144 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.IssuerParameters +name: IssuerParameters +fullName: azure.keyvault.v7_0.models.IssuerParameters +module: azure.keyvault.v7_0.models +summary: Parameters for the issuer of the X509 component of a certificate. +constructor: + syntax: 'IssuerParameters(*, name: str = None, certificate_type: str = None, certificate_transparency: + bool = None, **kwargs)' + parameters: + - name: name + description: 'Name of the referenced issuer object or reserved names; for + + example, ''Self'' or ''Unknown''.' + isRequired: true + types: + - + - name: certificate_type + description: 'Type of certificate to be requested from the + + issuer provider.' + isRequired: true + types: + - + - name: certificate_transparency + description: 'Indicates if the certificates generated + + under this policy should be published to certificate transparency logs.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: certificate_type + isRequired: true + - name: certificate_transparency + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.IssuerParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.IssuerParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.IssuerParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.IssuerParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.IssuerParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.IssuerParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.IssuerParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKey.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKey.yml new file mode 100644 index 00000000..5684cbb8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKey.yml @@ -0,0 +1,240 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.JsonWebKey +name: JsonWebKey +fullName: azure.keyvault.v7_0.models.JsonWebKey +module: azure.keyvault.v7_0.models +summary: As of [http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18](http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18). +constructor: + syntax: 'JsonWebKey(*, kid: str = None, kty=None, key_ops=None, n: bytes = None, + e: bytes = None, d: bytes = None, dp: bytes = None, dq: bytes = None, qi: bytes + = None, p: bytes = None, q: bytes = None, k: bytes = None, t: bytes = None, crv=None, + x: bytes = None, y: bytes = None, **kwargs)' + parameters: + - name: kid + description: Key identifier. + isRequired: true + types: + - + - name: kty + description: 'JsonWebKey Key Type (kty), as defined in + + [https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40](https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40). + + Possible values include: ''EC'', ''EC-HSM'', ''RSA'', ''RSA-HSM'', ''oct''' + isRequired: true + types: + - + - + - name: key_ops + isRequired: true + types: + - [] + - name: n + description: RSA modulus. + isRequired: true + types: + - + - name: e + description: RSA public exponent. + isRequired: true + types: + - + - name: d + description: RSA private exponent, or the D component of an EC private key. + isRequired: true + types: + - + - name: dp + description: RSA private key parameter. + isRequired: true + types: + - + - name: dq + description: RSA private key parameter. + isRequired: true + types: + - + - name: qi + description: RSA private key parameter. + isRequired: true + types: + - + - name: p + description: RSA secret prime. + isRequired: true + types: + - + - name: q + description: RSA secret prime, with p < q. + isRequired: true + types: + - + - name: k + description: Symmetric key. + isRequired: true + types: + - + - name: t + description: HSM Token, used with 'Bring Your Own Key'. + isRequired: true + types: + - + - name: crv + description: 'Elliptic curve name. For valid values, see + + JsonWebKeyCurveName. Possible values include: ''P-256'', ''P-384'', ''P-521'', + + ''P-256K''' + isRequired: true + types: + - + - + - name: x + description: X component of an EC public key. + isRequired: true + types: + - + - name: y + description: Y component of an EC public key. + isRequired: true + types: + - + keywordOnlyParameters: + - name: kid + isRequired: true + - name: kty + isRequired: true + - name: key_ops + isRequired: true + - name: n + isRequired: true + - name: e + isRequired: true + - name: d + isRequired: true + - name: dp + isRequired: true + - name: dq + isRequired: true + - name: qi + isRequired: true + - name: p + isRequired: true + - name: q + isRequired: true + - name: k + isRequired: true + - name: t + isRequired: true + - name: crv + isRequired: true + - name: x + isRequired: true + - name: y + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.JsonWebKey.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.JsonWebKey.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.JsonWebKey.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.JsonWebKey.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.JsonWebKey.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.JsonWebKey.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.JsonWebKey.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKeyCurveName.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKeyCurveName.yml new file mode 100644 index 00000000..2c252e77 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKeyCurveName.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v7_0.models.JsonWebKeyCurveName +name: JsonWebKeyCurveName +fullName: azure.keyvault.v7_0.models.JsonWebKeyCurveName +module: azure.keyvault.v7_0.models +fields: +- name: p_256 + uid: azure.keyvault.v7_0.models.JsonWebKeyCurveName.p_256 +- name: p_256_k + uid: azure.keyvault.v7_0.models.JsonWebKeyCurveName.p_256_k +- name: p_384 + uid: azure.keyvault.v7_0.models.JsonWebKeyCurveName.p_384 +- name: p_521 + uid: azure.keyvault.v7_0.models.JsonWebKeyCurveName.p_521 diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKeyEncryptionAlgorithm.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKeyEncryptionAlgorithm.yml new file mode 100644 index 00000000..ffaabb40 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKeyEncryptionAlgorithm.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v7_0.models.JsonWebKeyEncryptionAlgorithm +name: JsonWebKeyEncryptionAlgorithm +fullName: azure.keyvault.v7_0.models.JsonWebKeyEncryptionAlgorithm +module: azure.keyvault.v7_0.models +fields: +- name: rsa1_5 + uid: azure.keyvault.v7_0.models.JsonWebKeyEncryptionAlgorithm.rsa1_5 +- name: rsa_oaep + uid: azure.keyvault.v7_0.models.JsonWebKeyEncryptionAlgorithm.rsa_oaep +- name: rsa_oaep_256 + uid: azure.keyvault.v7_0.models.JsonWebKeyEncryptionAlgorithm.rsa_oaep_256 diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKeyOperation.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKeyOperation.yml new file mode 100644 index 00000000..44fbbd18 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKeyOperation.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v7_0.models.JsonWebKeyOperation +name: JsonWebKeyOperation +fullName: azure.keyvault.v7_0.models.JsonWebKeyOperation +module: azure.keyvault.v7_0.models +fields: +- name: decrypt + uid: azure.keyvault.v7_0.models.JsonWebKeyOperation.decrypt +- name: encrypt + uid: azure.keyvault.v7_0.models.JsonWebKeyOperation.encrypt +- name: sign + uid: azure.keyvault.v7_0.models.JsonWebKeyOperation.sign +- name: unwrap_key + uid: azure.keyvault.v7_0.models.JsonWebKeyOperation.unwrap_key +- name: verify + uid: azure.keyvault.v7_0.models.JsonWebKeyOperation.verify +- name: wrap_key + uid: azure.keyvault.v7_0.models.JsonWebKeyOperation.wrap_key diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKeySignatureAlgorithm.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKeySignatureAlgorithm.yml new file mode 100644 index 00000000..54423720 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKeySignatureAlgorithm.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v7_0.models.JsonWebKeySignatureAlgorithm +name: JsonWebKeySignatureAlgorithm +fullName: azure.keyvault.v7_0.models.JsonWebKeySignatureAlgorithm +module: azure.keyvault.v7_0.models +fields: +- name: es256 + uid: azure.keyvault.v7_0.models.JsonWebKeySignatureAlgorithm.es256 +- name: es256_k + uid: azure.keyvault.v7_0.models.JsonWebKeySignatureAlgorithm.es256_k +- name: es384 + uid: azure.keyvault.v7_0.models.JsonWebKeySignatureAlgorithm.es384 +- name: es512 + uid: azure.keyvault.v7_0.models.JsonWebKeySignatureAlgorithm.es512 +- name: ps256 + uid: azure.keyvault.v7_0.models.JsonWebKeySignatureAlgorithm.ps256 +- name: ps384 + uid: azure.keyvault.v7_0.models.JsonWebKeySignatureAlgorithm.ps384 +- name: ps512 + uid: azure.keyvault.v7_0.models.JsonWebKeySignatureAlgorithm.ps512 +- name: rs256 + uid: azure.keyvault.v7_0.models.JsonWebKeySignatureAlgorithm.rs256 +- name: rs384 + uid: azure.keyvault.v7_0.models.JsonWebKeySignatureAlgorithm.rs384 +- name: rs512 + uid: azure.keyvault.v7_0.models.JsonWebKeySignatureAlgorithm.rs512 +- name: rsnull + uid: azure.keyvault.v7_0.models.JsonWebKeySignatureAlgorithm.rsnull diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKeyType.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKeyType.yml new file mode 100644 index 00000000..8caf04bb --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKeyType.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v7_0.models.JsonWebKeyType +name: JsonWebKeyType +fullName: azure.keyvault.v7_0.models.JsonWebKeyType +module: azure.keyvault.v7_0.models +fields: +- name: ec + uid: azure.keyvault.v7_0.models.JsonWebKeyType.ec +- name: ec_hsm + uid: azure.keyvault.v7_0.models.JsonWebKeyType.ec_hsm +- name: oct + uid: azure.keyvault.v7_0.models.JsonWebKeyType.oct +- name: rsa + uid: azure.keyvault.v7_0.models.JsonWebKeyType.rsa +- name: rsa_hsm + uid: azure.keyvault.v7_0.models.JsonWebKeyType.rsa_hsm diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyAttributes.yml new file mode 100644 index 00000000..d558ebcb --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyAttributes.yml @@ -0,0 +1,166 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.KeyAttributes +name: KeyAttributes +fullName: azure.keyvault.v7_0.models.KeyAttributes +module: azure.keyvault.v7_0.models +summary: 'The attributes of a key managed by the key vault service. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'KeyAttributes(*, enabled: bool = None, not_before=None, expires=None, **kwargs)' + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true + - name: not_before + isRequired: true + - name: expires + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for keys in the current vault. If it contains ''Purgeable'' the key + + can be permanently deleted by a privileged user; otherwise, only the + + system can purge the key, at the end of the retention interval. Possible + + values include: ''Purgeable'', ''Recoverable+Purgeable'', ''Recoverable'', + + ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v7_0.models.KeyAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.KeyAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.KeyAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyBundle.yml new file mode 100644 index 00000000..5e9091f9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyBundle.yml @@ -0,0 +1,149 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.KeyBundle +name: KeyBundle +fullName: azure.keyvault.v7_0.models.KeyBundle +module: azure.keyvault.v7_0.models +summary: 'A KeyBundle consisting of a WebKey plus its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyBundle(*, key=None, attributes=None, tags=None, **kwargs) + parameters: + - name: key + description: The Json web key. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: key + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v7_0.models.KeyBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.KeyBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.KeyBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyCreateParameters.yml new file mode 100644 index 00000000..67e98ca7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyCreateParameters.yml @@ -0,0 +1,173 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.KeyCreateParameters +name: KeyCreateParameters +fullName: azure.keyvault.v7_0.models.KeyCreateParameters +module: azure.keyvault.v7_0.models +summary: 'The key create parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeyCreateParameters(*, kty, key_size: int = None, key_ops=None, key_attributes=None, + tags=None, curve=None, **kwargs)' + parameters: + - name: kty + description: 'Required. The type of key to create. For valid values, see + + JsonWebKeyType. Possible values include: ''EC'', ''EC-HSM'', ''RSA'', ''RSA-HSM'', + + ''oct''' + isRequired: true + types: + - + - + - name: key_size + description: 'The key size in bits. For example: 2048, 3072, or 4096 + + for RSA.' + isRequired: true + types: + - + - name: key_ops + isRequired: true + types: + - [ + - ] + - name: key_attributes + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: curve + description: 'Elliptic curve name. For valid values, see + + JsonWebKeyCurveName. Possible values include: ''P-256'', ''P-384'', ''P-521'', + + ''P-256K''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: kty + isRequired: true + - name: key_size + isRequired: true + - name: key_ops + isRequired: true + - name: key_attributes + isRequired: true + - name: tags + isRequired: true + - name: curve + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.KeyCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.KeyCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.KeyCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyImportParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyImportParameters.yml new file mode 100644 index 00000000..167b3c5b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyImportParameters.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.KeyImportParameters +name: KeyImportParameters +fullName: azure.keyvault.v7_0.models.KeyImportParameters +module: azure.keyvault.v7_0.models +summary: 'The key import parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeyImportParameters(*, key, hsm: bool = None, key_attributes=None, tags=None, + **kwargs)' + parameters: + - name: hsm + description: Whether to import as a hardware key (HSM) or software key. + isRequired: true + types: + - + - name: key + description: Required. The Json web key + isRequired: true + types: + - + - name: key_attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: key + isRequired: true + - name: hsm + isRequired: true + - name: key_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.KeyImportParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyImportParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyImportParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.KeyImportParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyImportParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.KeyImportParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyImportParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyItem.yml new file mode 100644 index 00000000..5bcb52fb --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyItem.yml @@ -0,0 +1,149 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.KeyItem +name: KeyItem +fullName: azure.keyvault.v7_0.models.KeyItem +module: azure.keyvault.v7_0.models +summary: 'The key item containing key metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'KeyItem(*, kid: str = None, attributes=None, tags=None, **kwargs)' + parameters: + - name: kid + description: Key identifier. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: kid + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v7_0.models.KeyItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.KeyItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.KeyItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyItemPaged.yml new file mode 100644 index 00000000..c99dab2f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.KeyItemPaged +name: KeyItemPaged +fullName: azure.keyvault.v7_0.models.KeyItemPaged +module: azure.keyvault.v7_0.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: KeyItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v7_0.models.KeyItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v7_0.models.KeyItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v7_0.models.KeyItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.KeyItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.KeyItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v7_0.models.KeyItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v7_0.models.KeyItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyOperationResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyOperationResult.yml new file mode 100644 index 00000000..be7fe8f4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyOperationResult.yml @@ -0,0 +1,127 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.KeyOperationResult +name: KeyOperationResult +fullName: azure.keyvault.v7_0.models.KeyOperationResult +module: azure.keyvault.v7_0.models +summary: 'The key operation result. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyOperationResult(**kwargs) +variables: +- description: Key identifier + name: kid + types: + - +- name: result + types: + - +methods: +- uid: azure.keyvault.v7_0.models.KeyOperationResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyOperationResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyOperationResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.KeyOperationResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyOperationResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.KeyOperationResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyOperationResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyOperationsParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyOperationsParameters.yml new file mode 100644 index 00000000..08b1c156 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyOperationsParameters.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.KeyOperationsParameters +name: KeyOperationsParameters +fullName: azure.keyvault.v7_0.models.KeyOperationsParameters +module: azure.keyvault.v7_0.models +summary: 'The key operations parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeyOperationsParameters(*, algorithm, value: bytes, **kwargs)' + parameters: + - name: algorithm + description: 'Required. algorithm identifier. Possible values include: + + ''RSA-OAEP'', ''RSA-OAEP-256'', ''RSA1_5''' + isRequired: true + types: + - + - + - name: value + description: Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: algorithm + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.KeyOperationsParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyOperationsParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyOperationsParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.KeyOperationsParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyOperationsParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.KeyOperationsParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyOperationsParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyProperties.yml new file mode 100644 index 00000000..122820ae --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyProperties.yml @@ -0,0 +1,164 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.KeyProperties +name: KeyProperties +fullName: azure.keyvault.v7_0.models.KeyProperties +module: azure.keyvault.v7_0.models +summary: Properties of the key pair backing a certificate. +constructor: + syntax: 'KeyProperties(*, exportable: bool = None, key_type=None, key_size: int + = None, reuse_key: bool = None, curve=None, **kwargs)' + parameters: + - name: exportable + description: Indicates if the private key can be exported. + isRequired: true + types: + - + - name: key_type + description: 'The type of key pair to be used for the certificate. + + Possible values include: ''EC'', ''EC-HSM'', ''RSA'', ''RSA-HSM'', ''oct''' + isRequired: true + types: + - + - + - name: key_size + description: 'The key size in bits. For example: 2048, 3072, or 4096 + + for RSA.' + isRequired: true + types: + - + - name: reuse_key + description: 'Indicates if the same key pair will be used on + + certificate renewal.' + isRequired: true + types: + - + - name: curve + description: 'Elliptic curve name. For valid values, see + + JsonWebKeyCurveName. Possible values include: ''P-256'', ''P-384'', ''P-521'', + + ''P-256K''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: exportable + isRequired: true + - name: key_type + isRequired: true + - name: key_size + isRequired: true + - name: reuse_key + isRequired: true + - name: curve + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.KeyProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.KeyProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.KeyProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyRestoreParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyRestoreParameters.yml new file mode 100644 index 00000000..ca3427a0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyRestoreParameters.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.KeyRestoreParameters +name: KeyRestoreParameters +fullName: azure.keyvault.v7_0.models.KeyRestoreParameters +module: azure.keyvault.v7_0.models +summary: 'The key restore parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeyRestoreParameters(*, key_bundle_backup: bytes, **kwargs)' + parameters: + - name: key_bundle_backup + description: 'Required. The backup blob associated with a key + + bundle.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: key_bundle_backup + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.KeyRestoreParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyRestoreParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyRestoreParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.KeyRestoreParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyRestoreParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.KeyRestoreParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyRestoreParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeySignParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeySignParameters.yml new file mode 100644 index 00000000..8060b701 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeySignParameters.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.KeySignParameters +name: KeySignParameters +fullName: azure.keyvault.v7_0.models.KeySignParameters +module: azure.keyvault.v7_0.models +summary: 'The key operations parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeySignParameters(*, algorithm, value: bytes, **kwargs)' + parameters: + - name: algorithm + description: 'Required. The signing/verification algorithm identifier. + + For more information on possible algorithm types, see + + JsonWebKeySignatureAlgorithm. Possible values include: ''PS256'', ''PS384'', + + ''PS512'', ''RS256'', ''RS384'', ''RS512'', ''RSNULL'', ''ES256'', ''ES384'', + ''ES512'', + + ''ES256K''' + isRequired: true + types: + - + - + - name: value + description: Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: algorithm + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.KeySignParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeySignParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeySignParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.KeySignParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeySignParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.KeySignParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeySignParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyUpdateParameters.yml new file mode 100644 index 00000000..bc3f5429 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyUpdateParameters.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.KeyUpdateParameters +name: KeyUpdateParameters +fullName: azure.keyvault.v7_0.models.KeyUpdateParameters +module: azure.keyvault.v7_0.models +summary: The key update parameters. +constructor: + syntax: KeyUpdateParameters(*, key_ops=None, key_attributes=None, tags=None, **kwargs) + parameters: + - name: key_ops + description: 'Json web key operations. For more information on possible + + key operations, see JsonWebKeyOperation.' + isRequired: true + types: + - [ + - ] + - name: key_attributes + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: key_ops + isRequired: true + - name: key_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.KeyUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.KeyUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.KeyUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyUsageType.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyUsageType.yml new file mode 100644 index 00000000..42325abc --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyUsageType.yml @@ -0,0 +1,24 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v7_0.models.KeyUsageType +name: KeyUsageType +fullName: azure.keyvault.v7_0.models.KeyUsageType +module: azure.keyvault.v7_0.models +fields: +- name: c_rl_sign + uid: azure.keyvault.v7_0.models.KeyUsageType.c_rl_sign +- name: data_encipherment + uid: azure.keyvault.v7_0.models.KeyUsageType.data_encipherment +- name: decipher_only + uid: azure.keyvault.v7_0.models.KeyUsageType.decipher_only +- name: digital_signature + uid: azure.keyvault.v7_0.models.KeyUsageType.digital_signature +- name: encipher_only + uid: azure.keyvault.v7_0.models.KeyUsageType.encipher_only +- name: key_agreement + uid: azure.keyvault.v7_0.models.KeyUsageType.key_agreement +- name: key_cert_sign + uid: azure.keyvault.v7_0.models.KeyUsageType.key_cert_sign +- name: key_encipherment + uid: azure.keyvault.v7_0.models.KeyUsageType.key_encipherment +- name: non_repudiation + uid: azure.keyvault.v7_0.models.KeyUsageType.non_repudiation diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyVaultError.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyVaultError.yml new file mode 100644 index 00000000..2750f6f2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyVaultError.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.KeyVaultError +name: KeyVaultError +fullName: azure.keyvault.v7_0.models.KeyVaultError +module: azure.keyvault.v7_0.models +summary: 'The key vault error exception. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyVaultError(**kwargs) +variables: +- name: error + types: + - +methods: +- uid: azure.keyvault.v7_0.models.KeyVaultError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyVaultError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyVaultError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.KeyVaultError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyVaultError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.KeyVaultError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyVaultError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyVaultErrorException.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyVaultErrorException.yml new file mode 100644 index 00000000..47c9b5a5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyVaultErrorException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.KeyVaultErrorException +name: KeyVaultErrorException +fullName: azure.keyvault.v7_0.models.KeyVaultErrorException +module: azure.keyvault.v7_0.models +summary: 'Server responsed with exception of type: ''KeyVaultError''.' +constructor: + syntax: KeyVaultErrorException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.KeyVaultErrorException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.keyvault.v7_0.models.KeyVaultErrorException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.keyvault.v7_0.models.KeyVaultErrorException.args + name: args diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyVerifyParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyVerifyParameters.yml new file mode 100644 index 00000000..28d5b59c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyVerifyParameters.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.KeyVerifyParameters +name: KeyVerifyParameters +fullName: azure.keyvault.v7_0.models.KeyVerifyParameters +module: azure.keyvault.v7_0.models +summary: 'The key verify parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeyVerifyParameters(*, algorithm, digest: bytes, signature: bytes, **kwargs)' + parameters: + - name: algorithm + description: 'Required. The signing/verification algorithm. For more + + information on possible algorithm types, see JsonWebKeySignatureAlgorithm. + + Possible values include: ''PS256'', ''PS384'', ''PS512'', ''RS256'', ''RS384'', + + ''RS512'', ''RSNULL'', ''ES256'', ''ES384'', ''ES512'', ''ES256K''' + isRequired: true + types: + - + - + - name: digest + description: Required. The digest used for signing. + isRequired: true + types: + - + - name: signature + description: Required. The signature to be verified. + isRequired: true + types: + - + keywordOnlyParameters: + - name: algorithm + isRequired: true + - name: digest + isRequired: true + - name: signature + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.KeyVerifyParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyVerifyParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyVerifyParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.KeyVerifyParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyVerifyParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.KeyVerifyParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyVerifyParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyVerifyResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyVerifyResult.yml new file mode 100644 index 00000000..f43aa317 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyVerifyResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.KeyVerifyResult +name: KeyVerifyResult +fullName: azure.keyvault.v7_0.models.KeyVerifyResult +module: azure.keyvault.v7_0.models +summary: 'The key verify result. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyVerifyResult(**kwargs) +variables: +- description: True if the signature is verified, otherwise false. + name: value + types: + - +methods: +- uid: azure.keyvault.v7_0.models.KeyVerifyResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyVerifyResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyVerifyResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.KeyVerifyResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.KeyVerifyResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.KeyVerifyResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.KeyVerifyResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.LifetimeAction.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.LifetimeAction.yml new file mode 100644 index 00000000..0542a46b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.LifetimeAction.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.LifetimeAction +name: LifetimeAction +fullName: azure.keyvault.v7_0.models.LifetimeAction +module: azure.keyvault.v7_0.models +summary: 'Action and its trigger that will be performed by Key Vault over the + + lifetime of a certificate.' +constructor: + syntax: LifetimeAction(*, trigger=None, action=None, **kwargs) + parameters: + - name: trigger + description: The condition that will execute the action. + isRequired: true + types: + - + - name: action + description: The action that will be executed. + isRequired: true + types: + - + keywordOnlyParameters: + - name: trigger + isRequired: true + - name: action + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.LifetimeAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.LifetimeAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.LifetimeAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.LifetimeAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.LifetimeAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.LifetimeAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.LifetimeAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.OrganizationDetails.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.OrganizationDetails.yml new file mode 100644 index 00000000..327fc90d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.OrganizationDetails.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.OrganizationDetails +name: OrganizationDetails +fullName: azure.keyvault.v7_0.models.OrganizationDetails +module: azure.keyvault.v7_0.models +summary: Details of the organization of the certificate issuer. +constructor: + syntax: 'OrganizationDetails(*, id: str = None, admin_details=None, **kwargs)' + parameters: + - name: id + description: Id of the organization. + isRequired: true + types: + - + - name: admin_details + description: Details of the organization administrator. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: admin_details + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.OrganizationDetails.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.OrganizationDetails.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.OrganizationDetails.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.OrganizationDetails.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.OrganizationDetails.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.OrganizationDetails.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.OrganizationDetails.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.PendingCertificateSigningRequestResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.PendingCertificateSigningRequestResult.yml new file mode 100644 index 00000000..e6a7d94a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.PendingCertificateSigningRequestResult.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.PendingCertificateSigningRequestResult +name: PendingCertificateSigningRequestResult +fullName: azure.keyvault.v7_0.models.PendingCertificateSigningRequestResult +module: azure.keyvault.v7_0.models +summary: 'The pending certificate signing request result. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: PendingCertificateSigningRequestResult(**kwargs) +variables: +- description: 'The pending certificate signing request as Base64 encoded + + string.' + name: value + types: + - +methods: +- uid: azure.keyvault.v7_0.models.PendingCertificateSigningRequestResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.PendingCertificateSigningRequestResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.PendingCertificateSigningRequestResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.PendingCertificateSigningRequestResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.PendingCertificateSigningRequestResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.PendingCertificateSigningRequestResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.PendingCertificateSigningRequestResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionAttributes.yml new file mode 100644 index 00000000..5fe82bf9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionAttributes.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.SasDefinitionAttributes +name: SasDefinitionAttributes +fullName: azure.keyvault.v7_0.models.SasDefinitionAttributes +module: azure.keyvault.v7_0.models +summary: 'The SAS definition management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'SasDefinitionAttributes(*, enabled: bool = None, **kwargs)' + parameters: + - name: enabled + description: the enabled state of the object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for SAS definitions in the current vault. If it contains + + ''Purgeable'' the SAS definition can be permanently deleted by a privileged + + user; otherwise, only the system can purge the SAS definition, at the end + + of the retention interval. Possible values include: ''Purgeable'', + + ''Recoverable+Purgeable'', ''Recoverable'', + + ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v7_0.models.SasDefinitionAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SasDefinitionAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SasDefinitionAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.SasDefinitionAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SasDefinitionAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.SasDefinitionAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SasDefinitionAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionBundle.yml new file mode 100644 index 00000000..fc258e1f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionBundle.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.SasDefinitionBundle +name: SasDefinitionBundle +fullName: azure.keyvault.v7_0.models.SasDefinitionBundle +module: azure.keyvault.v7_0.models +summary: 'A SAS definition bundle consists of key vault SAS definition details plus + + its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SasDefinitionBundle(**kwargs) +variables: +- description: The SAS definition id. + name: id + types: + - +- description: Storage account SAS definition secret id. + name: secret_id + types: + - +- description: 'The SAS definition token template signed with an + + arbitrary key. Tokens created according to the SAS definition will have + + the same properties as the template.' + name: template_uri + types: + - +- description: 'The type of SAS token the SAS definition will create. + + Possible values include: ''account'', ''service''' + name: sas_type + types: + - + - +- description: 'The validity period of SAS tokens created according + + to the SAS definition.' + name: validity_period + types: + - +- description: The SAS definition attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v7_0.models.SasDefinitionBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SasDefinitionBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SasDefinitionBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.SasDefinitionBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SasDefinitionBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.SasDefinitionBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SasDefinitionBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionCreateParameters.yml new file mode 100644 index 00000000..be62b73c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionCreateParameters.yml @@ -0,0 +1,164 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.SasDefinitionCreateParameters +name: SasDefinitionCreateParameters +fullName: azure.keyvault.v7_0.models.SasDefinitionCreateParameters +module: azure.keyvault.v7_0.models +summary: 'The SAS definition create parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SasDefinitionCreateParameters(*, template_uri: str, sas_type, validity_period: + str, sas_definition_attributes=None, tags=None, **kwargs)' + parameters: + - name: template_uri + description: 'Required. The SAS definition token template signed + + with an arbitrary key. Tokens created according to the SAS definition + + will have the same properties as the template.' + isRequired: true + types: + - + - name: sas_type + description: 'Required. The type of SAS token the SAS definition will + + create. Possible values include: ''account'', ''service''' + isRequired: true + types: + - + - + - name: validity_period + description: 'Required. The validity period of SAS tokens + + created according to the SAS definition.' + isRequired: true + types: + - + - name: sas_definition_attributes + description: The attributes of the SAS definition. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: template_uri + isRequired: true + - name: sas_type + isRequired: true + - name: validity_period + isRequired: true + - name: sas_definition_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.SasDefinitionCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SasDefinitionCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SasDefinitionCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.SasDefinitionCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SasDefinitionCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.SasDefinitionCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SasDefinitionCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionItem.yml new file mode 100644 index 00000000..f43d8d98 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionItem.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.SasDefinitionItem +name: SasDefinitionItem +fullName: azure.keyvault.v7_0.models.SasDefinitionItem +module: azure.keyvault.v7_0.models +summary: 'The SAS definition item containing storage SAS definition metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SasDefinitionItem(**kwargs) +variables: +- description: The storage SAS identifier. + name: id + types: + - +- description: The storage account SAS definition secret id. + name: secret_id + types: + - +- description: The SAS definition management attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs. + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v7_0.models.SasDefinitionItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SasDefinitionItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SasDefinitionItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.SasDefinitionItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SasDefinitionItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.SasDefinitionItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SasDefinitionItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionItemPaged.yml new file mode 100644 index 00000000..106c3965 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.SasDefinitionItemPaged +name: SasDefinitionItemPaged +fullName: azure.keyvault.v7_0.models.SasDefinitionItemPaged +module: azure.keyvault.v7_0.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: SasDefinitionItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v7_0.models.SasDefinitionItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v7_0.models.SasDefinitionItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v7_0.models.SasDefinitionItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.SasDefinitionItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.SasDefinitionItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v7_0.models.SasDefinitionItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v7_0.models.SasDefinitionItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionUpdateParameters.yml new file mode 100644 index 00000000..13c74ee5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionUpdateParameters.yml @@ -0,0 +1,161 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.SasDefinitionUpdateParameters +name: SasDefinitionUpdateParameters +fullName: azure.keyvault.v7_0.models.SasDefinitionUpdateParameters +module: azure.keyvault.v7_0.models +summary: The SAS definition update parameters. +constructor: + syntax: 'SasDefinitionUpdateParameters(*, template_uri: str = None, sas_type=None, + validity_period: str = None, sas_definition_attributes=None, tags=None, **kwargs)' + parameters: + - name: template_uri + description: 'The SAS definition token template signed with an + + arbitrary key. Tokens created according to the SAS definition will have + + the same properties as the template.' + isRequired: true + types: + - + - name: sas_type + description: 'The type of SAS token the SAS definition will create. + + Possible values include: ''account'', ''service''' + isRequired: true + types: + - + - + - name: validity_period + description: 'The validity period of SAS tokens created + + according to the SAS definition.' + isRequired: true + types: + - + - name: sas_definition_attributes + description: The attributes of the SAS definition. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: template_uri + isRequired: true + - name: sas_type + isRequired: true + - name: validity_period + isRequired: true + - name: sas_definition_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.SasDefinitionUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SasDefinitionUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SasDefinitionUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.SasDefinitionUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SasDefinitionUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.SasDefinitionUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SasDefinitionUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasTokenType.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasTokenType.yml new file mode 100644 index 00000000..fc9984eb --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasTokenType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v7_0.models.SasTokenType +name: SasTokenType +fullName: azure.keyvault.v7_0.models.SasTokenType +module: azure.keyvault.v7_0.models +fields: +- name: account + uid: azure.keyvault.v7_0.models.SasTokenType.account +- name: service + uid: azure.keyvault.v7_0.models.SasTokenType.service diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretAttributes.yml new file mode 100644 index 00000000..6191f981 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretAttributes.yml @@ -0,0 +1,167 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.SecretAttributes +name: SecretAttributes +fullName: azure.keyvault.v7_0.models.SecretAttributes +module: azure.keyvault.v7_0.models +summary: 'The secret management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'SecretAttributes(*, enabled: bool = None, not_before=None, expires=None, + **kwargs)' + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true + - name: not_before + isRequired: true + - name: expires + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for secrets in the current vault. If it contains ''Purgeable'', the + + secret can be permanently deleted by a privileged user; otherwise, only + + the system can purge the secret, at the end of the retention interval. + + Possible values include: ''Purgeable'', ''Recoverable+Purgeable'', + + ''Recoverable'', ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v7_0.models.SecretAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SecretAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SecretAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.SecretAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SecretAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.SecretAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SecretAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretBundle.yml new file mode 100644 index 00000000..52e58cca --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretBundle.yml @@ -0,0 +1,170 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.SecretBundle +name: SecretBundle +fullName: azure.keyvault.v7_0.models.SecretBundle +module: azure.keyvault.v7_0.models +summary: 'A secret consisting of a value, id and its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'SecretBundle(*, value: str = None, id: str = None, content_type: str = + None, attributes=None, tags=None, **kwargs)' + parameters: + - name: value + description: The secret value. + isRequired: true + types: + - + - name: id + description: The secret id. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: value + isRequired: true + - name: id + isRequired: true + - name: content_type + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true +variables: +- description: 'If this is a secret backing a KV certificate, then this field + + specifies the corresponding key backing the KV certificate.' + name: kid + types: + - +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a secret backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v7_0.models.SecretBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SecretBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SecretBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.SecretBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SecretBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.SecretBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SecretBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretItem.yml new file mode 100644 index 00000000..b74648b2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretItem.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.SecretItem +name: SecretItem +fullName: azure.keyvault.v7_0.models.SecretItem +module: azure.keyvault.v7_0.models +summary: 'The secret item containing secret metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'SecretItem(*, id: str = None, attributes=None, tags=None, content_type: + str = None, **kwargs)' + parameters: + - name: id + description: Secret identifier. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: content_type + isRequired: true +variables: +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a key backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v7_0.models.SecretItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SecretItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SecretItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.SecretItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SecretItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.SecretItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SecretItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretItemPaged.yml new file mode 100644 index 00000000..ee1ff37e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.SecretItemPaged +name: SecretItemPaged +fullName: azure.keyvault.v7_0.models.SecretItemPaged +module: azure.keyvault.v7_0.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: SecretItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v7_0.models.SecretItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v7_0.models.SecretItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v7_0.models.SecretItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.SecretItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.SecretItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v7_0.models.SecretItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v7_0.models.SecretItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretProperties.yml new file mode 100644 index 00000000..2eeab73c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretProperties.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.SecretProperties +name: SecretProperties +fullName: azure.keyvault.v7_0.models.SecretProperties +module: azure.keyvault.v7_0.models +summary: Properties of the key backing a certificate. +constructor: + syntax: 'SecretProperties(*, content_type: str = None, **kwargs)' + parameters: + - name: content_type + description: The media type (MIME type). + isRequired: true + types: + - + keywordOnlyParameters: + - name: content_type + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.SecretProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SecretProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SecretProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.SecretProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SecretProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.SecretProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SecretProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretRestoreParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretRestoreParameters.yml new file mode 100644 index 00000000..9beb81e6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretRestoreParameters.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.SecretRestoreParameters +name: SecretRestoreParameters +fullName: azure.keyvault.v7_0.models.SecretRestoreParameters +module: azure.keyvault.v7_0.models +summary: 'The secret restore parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SecretRestoreParameters(*, secret_bundle_backup: bytes, **kwargs)' + parameters: + - name: secret_bundle_backup + description: 'Required. The backup blob associated with a + + secret bundle.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: secret_bundle_backup + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.SecretRestoreParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SecretRestoreParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SecretRestoreParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.SecretRestoreParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SecretRestoreParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.SecretRestoreParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SecretRestoreParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretSetParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretSetParameters.yml new file mode 100644 index 00000000..80f68ab7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretSetParameters.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.SecretSetParameters +name: SecretSetParameters +fullName: azure.keyvault.v7_0.models.SecretSetParameters +module: azure.keyvault.v7_0.models +summary: 'The secret set parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SecretSetParameters(*, value: str, tags=None, content_type: str = None, + secret_attributes=None, **kwargs)' + parameters: + - name: value + description: Required. The value of the secret. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - + - name: secret_attributes + description: The secret management attributes. + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: tags + isRequired: true + - name: content_type + isRequired: true + - name: secret_attributes + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.SecretSetParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SecretSetParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SecretSetParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.SecretSetParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SecretSetParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.SecretSetParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SecretSetParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretUpdateParameters.yml new file mode 100644 index 00000000..6cba83c0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretUpdateParameters.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.SecretUpdateParameters +name: SecretUpdateParameters +fullName: azure.keyvault.v7_0.models.SecretUpdateParameters +module: azure.keyvault.v7_0.models +summary: The secret update parameters. +constructor: + syntax: 'SecretUpdateParameters(*, content_type: str = None, secret_attributes=None, + tags=None, **kwargs)' + parameters: + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - + - name: secret_attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: content_type + isRequired: true + - name: secret_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.SecretUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SecretUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SecretUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.SecretUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SecretUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.SecretUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SecretUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountAttributes.yml new file mode 100644 index 00000000..43678502 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountAttributes.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.StorageAccountAttributes +name: StorageAccountAttributes +fullName: azure.keyvault.v7_0.models.StorageAccountAttributes +module: azure.keyvault.v7_0.models +summary: 'The storage account management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'StorageAccountAttributes(*, enabled: bool = None, **kwargs)' + parameters: + - name: enabled + description: the enabled state of the object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for storage accounts in the current vault. If it contains + + ''Purgeable'' the storage account can be permanently deleted by a privileged + + user; otherwise, only the system can purge the storage account, at the end + + of the retention interval. Possible values include: ''Purgeable'', + + ''Recoverable+Purgeable'', ''Recoverable'', + + ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v7_0.models.StorageAccountAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.StorageAccountAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.StorageAccountAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.StorageAccountAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.StorageAccountAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.StorageAccountAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.StorageAccountAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountCreateParameters.yml new file mode 100644 index 00000000..9483c11f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountCreateParameters.yml @@ -0,0 +1,167 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.StorageAccountCreateParameters +name: StorageAccountCreateParameters +fullName: azure.keyvault.v7_0.models.StorageAccountCreateParameters +module: azure.keyvault.v7_0.models +summary: 'The storage account create parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'StorageAccountCreateParameters(*, resource_id: str, active_key_name: str, + auto_regenerate_key: bool, regeneration_period: str = None, storage_account_attributes=None, + tags=None, **kwargs)' + parameters: + - name: resource_id + description: Required. Storage account resource id. + isRequired: true + types: + - + - name: active_key_name + description: Required. Current active storage account key name. + isRequired: true + types: + - + - name: auto_regenerate_key + description: 'Required. whether keyvault should manage the + + storage account for the user.' + isRequired: true + types: + - + - name: regeneration_period + description: 'The key regeneration time duration specified + + in ISO-8601 format.' + isRequired: true + types: + - + - name: storage_account_attributes + description: The attributes of the storage account. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: resource_id + isRequired: true + - name: active_key_name + isRequired: true + - name: auto_regenerate_key + isRequired: true + - name: regeneration_period + isRequired: true + - name: storage_account_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.StorageAccountCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.StorageAccountCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.StorageAccountCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.StorageAccountCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.StorageAccountCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.StorageAccountCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.StorageAccountCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountItem.yml new file mode 100644 index 00000000..11c32472 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountItem.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.StorageAccountItem +name: StorageAccountItem +fullName: azure.keyvault.v7_0.models.StorageAccountItem +module: azure.keyvault.v7_0.models +summary: 'The storage account item containing storage account metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: StorageAccountItem(**kwargs) +variables: +- description: Storage identifier. + name: id + types: + - +- description: Storage account resource Id. + name: resource_id + types: + - +- description: The storage account management attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs. + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v7_0.models.StorageAccountItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.StorageAccountItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.StorageAccountItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.StorageAccountItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.StorageAccountItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.StorageAccountItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.StorageAccountItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountItemPaged.yml new file mode 100644 index 00000000..5c3bff79 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.StorageAccountItemPaged +name: StorageAccountItemPaged +fullName: azure.keyvault.v7_0.models.StorageAccountItemPaged +module: azure.keyvault.v7_0.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: StorageAccountItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v7_0.models.StorageAccountItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v7_0.models.StorageAccountItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v7_0.models.StorageAccountItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.StorageAccountItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.StorageAccountItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v7_0.models.StorageAccountItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v7_0.models.StorageAccountItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountRegenerteKeyParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountRegenerteKeyParameters.yml new file mode 100644 index 00000000..56d3c277 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountRegenerteKeyParameters.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.StorageAccountRegenerteKeyParameters +name: StorageAccountRegenerteKeyParameters +fullName: azure.keyvault.v7_0.models.StorageAccountRegenerteKeyParameters +module: azure.keyvault.v7_0.models +summary: 'The storage account key regenerate parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'StorageAccountRegenerteKeyParameters(*, key_name: str, **kwargs)' + parameters: + - name: key_name + description: Required. The storage account key name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: key_name + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.StorageAccountRegenerteKeyParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.StorageAccountRegenerteKeyParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.StorageAccountRegenerteKeyParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.StorageAccountRegenerteKeyParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.StorageAccountRegenerteKeyParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.StorageAccountRegenerteKeyParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.StorageAccountRegenerteKeyParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountUpdateParameters.yml new file mode 100644 index 00000000..296d8895 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountUpdateParameters.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.StorageAccountUpdateParameters +name: StorageAccountUpdateParameters +fullName: azure.keyvault.v7_0.models.StorageAccountUpdateParameters +module: azure.keyvault.v7_0.models +summary: The storage account update parameters. +constructor: + syntax: 'StorageAccountUpdateParameters(*, active_key_name: str = None, auto_regenerate_key: + bool = None, regeneration_period: str = None, storage_account_attributes=None, + tags=None, **kwargs)' + parameters: + - name: active_key_name + description: The current active storage account key name. + isRequired: true + types: + - + - name: auto_regenerate_key + description: 'whether keyvault should manage the storage + + account for the user.' + isRequired: true + types: + - + - name: regeneration_period + description: 'The key regeneration time duration specified + + in ISO-8601 format.' + isRequired: true + types: + - + - name: storage_account_attributes + description: The attributes of the storage account. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: active_key_name + isRequired: true + - name: auto_regenerate_key + isRequired: true + - name: regeneration_period + isRequired: true + - name: storage_account_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.StorageAccountUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.StorageAccountUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.StorageAccountUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.StorageAccountUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.StorageAccountUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.StorageAccountUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.StorageAccountUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageBundle.yml new file mode 100644 index 00000000..ef3879cc --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageBundle.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.StorageBundle +name: StorageBundle +fullName: azure.keyvault.v7_0.models.StorageBundle +module: azure.keyvault.v7_0.models +summary: 'A Storage account bundle consists of key vault storage account details plus + + its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: StorageBundle(**kwargs) +variables: +- description: The storage account id. + name: id + types: + - +- description: The storage account resource id. + name: resource_id + types: + - +- description: The current active storage account key name. + name: active_key_name + types: + - +- description: 'whether keyvault should manage the storage + + account for the user.' + name: auto_regenerate_key + types: + - +- description: 'The key regeneration time duration specified in + + ISO-8601 format.' + name: regeneration_period + types: + - +- description: The storage account attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v7_0.models.StorageBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.StorageBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.StorageBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.StorageBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.StorageBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.StorageBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.StorageBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageRestoreParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageRestoreParameters.yml new file mode 100644 index 00000000..c0b81c47 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageRestoreParameters.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.StorageRestoreParameters +name: StorageRestoreParameters +fullName: azure.keyvault.v7_0.models.StorageRestoreParameters +module: azure.keyvault.v7_0.models +summary: 'The secret restore parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'StorageRestoreParameters(*, storage_bundle_backup: bytes, **kwargs)' + parameters: + - name: storage_bundle_backup + description: 'Required. The backup blob associated with a + + storage account.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: storage_bundle_backup + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.StorageRestoreParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.StorageRestoreParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.StorageRestoreParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.StorageRestoreParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.StorageRestoreParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.StorageRestoreParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.StorageRestoreParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SubjectAlternativeNames.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SubjectAlternativeNames.yml new file mode 100644 index 00000000..e2a70167 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SubjectAlternativeNames.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.SubjectAlternativeNames +name: SubjectAlternativeNames +fullName: azure.keyvault.v7_0.models.SubjectAlternativeNames +module: azure.keyvault.v7_0.models +summary: The subject alternate names of a X509 object. +constructor: + syntax: SubjectAlternativeNames(*, emails=None, dns_names=None, upns=None, **kwargs) + parameters: + - name: emails + description: Email addresses. + isRequired: true + types: + - [] + - name: dns_names + description: Domain names. + isRequired: true + types: + - [] + - name: upns + description: User principal names. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: emails + isRequired: true + - name: dns_names + isRequired: true + - name: upns + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.SubjectAlternativeNames.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SubjectAlternativeNames.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SubjectAlternativeNames.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.SubjectAlternativeNames.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.SubjectAlternativeNames.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.SubjectAlternativeNames.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.SubjectAlternativeNames.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Trigger(class).yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Trigger(class).yml new file mode 100644 index 00000000..5cfc2b7a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Trigger(class).yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.Trigger +name: Trigger +fullName: azure.keyvault.v7_0.models.Trigger +module: azure.keyvault.v7_0.models +summary: A condition to be satisfied for an action to be executed. +constructor: + syntax: 'Trigger(*, lifetime_percentage: int = None, days_before_expiry: int = None, + **kwargs)' + parameters: + - name: lifetime_percentage + description: 'Percentage of lifetime at which to trigger. + + Value should be between 1 and 99.' + isRequired: true + types: + - + - name: days_before_expiry + description: 'Days before expiry to attempt renewal. Value + + should be between 1 and validity_in_months multiplied by 27. If + + validity_in_months is 36, then value should be between 1 and 972 (36 * + + 27).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: lifetime_percentage + isRequired: true + - name: days_before_expiry + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.Trigger.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.Trigger.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.Trigger.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.Trigger.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.Trigger.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.Trigger.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.Trigger.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.X509CertificateProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.X509CertificateProperties.yml new file mode 100644 index 00000000..c1fbf888 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.X509CertificateProperties.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.X509CertificateProperties +name: X509CertificateProperties +fullName: azure.keyvault.v7_0.models.X509CertificateProperties +module: azure.keyvault.v7_0.models +summary: Properties of the X509 component of a certificate. +constructor: + syntax: 'X509CertificateProperties(*, subject: str = None, ekus=None, subject_alternative_names=None, + key_usage=None, validity_in_months: int = None, **kwargs)' + parameters: + - name: subject + description: 'The subject name. Should be a valid X509 distinguished + + Name.' + isRequired: true + types: + - + - name: ekus + description: The enhanced key usage. + isRequired: true + types: + - [] + - name: subject_alternative_names + description: The subject alternative names. + isRequired: true + types: + - + - name: key_usage + description: List of key usages. + isRequired: true + types: + - [ + - ] + - name: validity_in_months + description: 'The duration that the ceritifcate is valid in + + months.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: subject + isRequired: true + - name: ekus + isRequired: true + - name: subject_alternative_names + isRequired: true + - name: key_usage + isRequired: true + - name: validity_in_months + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.X509CertificateProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.X509CertificateProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.X509CertificateProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.X509CertificateProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.X509CertificateProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.X509CertificateProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.X509CertificateProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.action.Action.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.action.Action.yml new file mode 100644 index 00000000..51eda2d6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.action.Action.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.action.Action +name: Action +fullName: azure.keyvault.v7_0.models.action.Action +module: azure.keyvault.v7_0.models.action +summary: The action that will be executed. +constructor: + syntax: Action(**kwargs) + parameters: + - name: action_type + description: 'The type of the action. Possible values include: + + ''EmailContacts'', ''AutoRenew''' + isRequired: true + types: + - + - +methods: +- uid: azure.keyvault.v7_0.models.action.Action.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.action.Action.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.action.Action.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.action.Action.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.action.Action.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.action.Action.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.action.Action.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.action.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.action.yml new file mode 100644 index 00000000..dc7d3af5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.action.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.action +name: action +fullName: azure.keyvault.v7_0.models.action +classes: +- azure.keyvault.v7_0.models.action.Action diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.action_py3.Action.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.action_py3.Action.yml new file mode 100644 index 00000000..94a84ee6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.action_py3.Action.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.action_py3.Action +name: Action +fullName: azure.keyvault.v7_0.models.action_py3.Action +module: azure.keyvault.v7_0.models.action_py3 +summary: The action that will be executed. +constructor: + syntax: Action(*, action_type=None, **kwargs) + parameters: + - name: action_type + description: 'The type of the action. Possible values include: + + ''EmailContacts'', ''AutoRenew''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: action_type + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.action_py3.Action.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.action_py3.Action.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.action_py3.Action.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.action_py3.Action.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.action_py3.Action.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.action_py3.Action.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.action_py3.Action.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.action_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.action_py3.yml new file mode 100644 index 00000000..66d8cb0e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.action_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.action_py3 +name: action_py3 +fullName: azure.keyvault.v7_0.models.action_py3 +classes: +- azure.keyvault.v7_0.models.action_py3.Action diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.administrator_details.AdministratorDetails.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.administrator_details.AdministratorDetails.yml new file mode 100644 index 00000000..10e18139 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.administrator_details.AdministratorDetails.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.administrator_details.AdministratorDetails +name: AdministratorDetails +fullName: azure.keyvault.v7_0.models.administrator_details.AdministratorDetails +module: azure.keyvault.v7_0.models.administrator_details +summary: Details of the organization administrator of the certificate issuer. +constructor: + syntax: AdministratorDetails(**kwargs) + parameters: + - name: first_name + description: First name. + isRequired: true + types: + - + - name: last_name + description: Last name. + isRequired: true + types: + - + - name: email_address + description: Email addresss. + isRequired: true + types: + - + - name: phone + description: Phone number. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.models.administrator_details.AdministratorDetails.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.administrator_details.AdministratorDetails.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.administrator_details.AdministratorDetails.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.administrator_details.AdministratorDetails.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.administrator_details.AdministratorDetails.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.administrator_details.AdministratorDetails.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.administrator_details.AdministratorDetails.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.administrator_details.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.administrator_details.yml new file mode 100644 index 00000000..f62228c3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.administrator_details.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.administrator_details +name: administrator_details +fullName: azure.keyvault.v7_0.models.administrator_details +classes: +- azure.keyvault.v7_0.models.administrator_details.AdministratorDetails diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.administrator_details_py3.AdministratorDetails.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.administrator_details_py3.AdministratorDetails.yml new file mode 100644 index 00000000..fc0d307b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.administrator_details_py3.AdministratorDetails.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.administrator_details_py3.AdministratorDetails +name: AdministratorDetails +fullName: azure.keyvault.v7_0.models.administrator_details_py3.AdministratorDetails +module: azure.keyvault.v7_0.models.administrator_details_py3 +summary: Details of the organization administrator of the certificate issuer. +constructor: + syntax: 'AdministratorDetails(*, first_name: str = None, last_name: str = None, + email_address: str = None, phone: str = None, **kwargs)' + parameters: + - name: first_name + description: First name. + isRequired: true + types: + - + - name: last_name + description: Last name. + isRequired: true + types: + - + - name: email_address + description: Email addresss. + isRequired: true + types: + - + - name: phone + description: Phone number. + isRequired: true + types: + - + keywordOnlyParameters: + - name: first_name + isRequired: true + - name: last_name + isRequired: true + - name: email_address + isRequired: true + - name: phone + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.administrator_details_py3.AdministratorDetails.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.administrator_details_py3.AdministratorDetails.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.administrator_details_py3.AdministratorDetails.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.administrator_details_py3.AdministratorDetails.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.administrator_details_py3.AdministratorDetails.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.administrator_details_py3.AdministratorDetails.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.administrator_details_py3.AdministratorDetails.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.administrator_details_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.administrator_details_py3.yml new file mode 100644 index 00000000..ed79a000 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.administrator_details_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.administrator_details_py3 +name: administrator_details_py3 +fullName: azure.keyvault.v7_0.models.administrator_details_py3 +classes: +- azure.keyvault.v7_0.models.administrator_details_py3.AdministratorDetails diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.attributes.Attributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.attributes.Attributes.yml new file mode 100644 index 00000000..ace3076e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.attributes.Attributes.yml @@ -0,0 +1,144 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.attributes.Attributes +name: Attributes +fullName: azure.keyvault.v7_0.models.attributes.Attributes +module: azure.keyvault.v7_0.models.attributes +summary: 'The object attributes managed by the KeyVault service. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Attributes(**kwargs) + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +methods: +- uid: azure.keyvault.v7_0.models.attributes.Attributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.attributes.Attributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.attributes.Attributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.attributes.Attributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.attributes.Attributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.attributes.Attributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.attributes.Attributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.attributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.attributes.yml new file mode 100644 index 00000000..dac8517d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.attributes.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.attributes +name: attributes +fullName: azure.keyvault.v7_0.models.attributes +classes: +- azure.keyvault.v7_0.models.attributes.Attributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.attributes_py3.Attributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.attributes_py3.Attributes.yml new file mode 100644 index 00000000..dcf6def0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.attributes_py3.Attributes.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.attributes_py3.Attributes +name: Attributes +fullName: azure.keyvault.v7_0.models.attributes_py3.Attributes +module: azure.keyvault.v7_0.models.attributes_py3 +summary: 'The object attributes managed by the KeyVault service. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'Attributes(*, enabled: bool = None, not_before=None, expires=None, **kwargs)' + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true + - name: not_before + isRequired: true + - name: expires + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +methods: +- uid: azure.keyvault.v7_0.models.attributes_py3.Attributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.attributes_py3.Attributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.attributes_py3.Attributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.attributes_py3.Attributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.attributes_py3.Attributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.attributes_py3.Attributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.attributes_py3.Attributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.attributes_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.attributes_py3.yml new file mode 100644 index 00000000..fb3e6fbb --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.attributes_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.attributes_py3 +name: attributes_py3 +fullName: azure.keyvault.v7_0.models.attributes_py3 +classes: +- azure.keyvault.v7_0.models.attributes_py3.Attributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_certificate_result.BackupCertificateResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_certificate_result.BackupCertificateResult.yml new file mode 100644 index 00000000..ae4a67ff --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_certificate_result.BackupCertificateResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.backup_certificate_result.BackupCertificateResult +name: BackupCertificateResult +fullName: azure.keyvault.v7_0.models.backup_certificate_result.BackupCertificateResult +module: azure.keyvault.v7_0.models.backup_certificate_result +summary: 'The backup certificate result, containing the backup blob. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: BackupCertificateResult(**kwargs) +variables: +- description: The backup blob containing the backed up certificate. + name: value + types: + - +methods: +- uid: azure.keyvault.v7_0.models.backup_certificate_result.BackupCertificateResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.backup_certificate_result.BackupCertificateResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.backup_certificate_result.BackupCertificateResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.backup_certificate_result.BackupCertificateResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.backup_certificate_result.BackupCertificateResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.backup_certificate_result.BackupCertificateResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.backup_certificate_result.BackupCertificateResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_certificate_result.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_certificate_result.yml new file mode 100644 index 00000000..138f7d2c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_certificate_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.backup_certificate_result +name: backup_certificate_result +fullName: azure.keyvault.v7_0.models.backup_certificate_result +classes: +- azure.keyvault.v7_0.models.backup_certificate_result.BackupCertificateResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_certificate_result_py3.BackupCertificateResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_certificate_result_py3.BackupCertificateResult.yml new file mode 100644 index 00000000..91a50d95 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_certificate_result_py3.BackupCertificateResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.backup_certificate_result_py3.BackupCertificateResult +name: BackupCertificateResult +fullName: azure.keyvault.v7_0.models.backup_certificate_result_py3.BackupCertificateResult +module: azure.keyvault.v7_0.models.backup_certificate_result_py3 +summary: 'The backup certificate result, containing the backup blob. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: BackupCertificateResult(**kwargs) +variables: +- description: The backup blob containing the backed up certificate. + name: value + types: + - +methods: +- uid: azure.keyvault.v7_0.models.backup_certificate_result_py3.BackupCertificateResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.backup_certificate_result_py3.BackupCertificateResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.backup_certificate_result_py3.BackupCertificateResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.backup_certificate_result_py3.BackupCertificateResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.backup_certificate_result_py3.BackupCertificateResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.backup_certificate_result_py3.BackupCertificateResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.backup_certificate_result_py3.BackupCertificateResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_certificate_result_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_certificate_result_py3.yml new file mode 100644 index 00000000..676fc61a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_certificate_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.backup_certificate_result_py3 +name: backup_certificate_result_py3 +fullName: azure.keyvault.v7_0.models.backup_certificate_result_py3 +classes: +- azure.keyvault.v7_0.models.backup_certificate_result_py3.BackupCertificateResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_key_result.BackupKeyResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_key_result.BackupKeyResult.yml new file mode 100644 index 00000000..fb2a250b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_key_result.BackupKeyResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.backup_key_result.BackupKeyResult +name: BackupKeyResult +fullName: azure.keyvault.v7_0.models.backup_key_result.BackupKeyResult +module: azure.keyvault.v7_0.models.backup_key_result +summary: 'The backup key result, containing the backup blob. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: BackupKeyResult(**kwargs) +variables: +- description: The backup blob containing the backed up key. + name: value + types: + - +methods: +- uid: azure.keyvault.v7_0.models.backup_key_result.BackupKeyResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.backup_key_result.BackupKeyResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.backup_key_result.BackupKeyResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.backup_key_result.BackupKeyResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.backup_key_result.BackupKeyResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.backup_key_result.BackupKeyResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.backup_key_result.BackupKeyResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_key_result.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_key_result.yml new file mode 100644 index 00000000..22f57b7a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_key_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.backup_key_result +name: backup_key_result +fullName: azure.keyvault.v7_0.models.backup_key_result +classes: +- azure.keyvault.v7_0.models.backup_key_result.BackupKeyResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_key_result_py3.BackupKeyResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_key_result_py3.BackupKeyResult.yml new file mode 100644 index 00000000..60946af4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_key_result_py3.BackupKeyResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.backup_key_result_py3.BackupKeyResult +name: BackupKeyResult +fullName: azure.keyvault.v7_0.models.backup_key_result_py3.BackupKeyResult +module: azure.keyvault.v7_0.models.backup_key_result_py3 +summary: 'The backup key result, containing the backup blob. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: BackupKeyResult(**kwargs) +variables: +- description: The backup blob containing the backed up key. + name: value + types: + - +methods: +- uid: azure.keyvault.v7_0.models.backup_key_result_py3.BackupKeyResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.backup_key_result_py3.BackupKeyResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.backup_key_result_py3.BackupKeyResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.backup_key_result_py3.BackupKeyResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.backup_key_result_py3.BackupKeyResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.backup_key_result_py3.BackupKeyResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.backup_key_result_py3.BackupKeyResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_key_result_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_key_result_py3.yml new file mode 100644 index 00000000..9aff1adc --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_key_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.backup_key_result_py3 +name: backup_key_result_py3 +fullName: azure.keyvault.v7_0.models.backup_key_result_py3 +classes: +- azure.keyvault.v7_0.models.backup_key_result_py3.BackupKeyResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_secret_result.BackupSecretResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_secret_result.BackupSecretResult.yml new file mode 100644 index 00000000..b5ce4cb3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_secret_result.BackupSecretResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.backup_secret_result.BackupSecretResult +name: BackupSecretResult +fullName: azure.keyvault.v7_0.models.backup_secret_result.BackupSecretResult +module: azure.keyvault.v7_0.models.backup_secret_result +summary: 'The backup secret result, containing the backup blob. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: BackupSecretResult(**kwargs) +variables: +- description: The backup blob containing the backed up secret. + name: value + types: + - +methods: +- uid: azure.keyvault.v7_0.models.backup_secret_result.BackupSecretResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.backup_secret_result.BackupSecretResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.backup_secret_result.BackupSecretResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.backup_secret_result.BackupSecretResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.backup_secret_result.BackupSecretResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.backup_secret_result.BackupSecretResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.backup_secret_result.BackupSecretResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_secret_result.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_secret_result.yml new file mode 100644 index 00000000..9ac00e00 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_secret_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.backup_secret_result +name: backup_secret_result +fullName: azure.keyvault.v7_0.models.backup_secret_result +classes: +- azure.keyvault.v7_0.models.backup_secret_result.BackupSecretResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_secret_result_py3.BackupSecretResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_secret_result_py3.BackupSecretResult.yml new file mode 100644 index 00000000..519dc6c7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_secret_result_py3.BackupSecretResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.backup_secret_result_py3.BackupSecretResult +name: BackupSecretResult +fullName: azure.keyvault.v7_0.models.backup_secret_result_py3.BackupSecretResult +module: azure.keyvault.v7_0.models.backup_secret_result_py3 +summary: 'The backup secret result, containing the backup blob. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: BackupSecretResult(**kwargs) +variables: +- description: The backup blob containing the backed up secret. + name: value + types: + - +methods: +- uid: azure.keyvault.v7_0.models.backup_secret_result_py3.BackupSecretResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.backup_secret_result_py3.BackupSecretResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.backup_secret_result_py3.BackupSecretResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.backup_secret_result_py3.BackupSecretResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.backup_secret_result_py3.BackupSecretResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.backup_secret_result_py3.BackupSecretResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.backup_secret_result_py3.BackupSecretResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_secret_result_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_secret_result_py3.yml new file mode 100644 index 00000000..21b06c7b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_secret_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.backup_secret_result_py3 +name: backup_secret_result_py3 +fullName: azure.keyvault.v7_0.models.backup_secret_result_py3 +classes: +- azure.keyvault.v7_0.models.backup_secret_result_py3.BackupSecretResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_storage_result.BackupStorageResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_storage_result.BackupStorageResult.yml new file mode 100644 index 00000000..19dc3ebe --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_storage_result.BackupStorageResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.backup_storage_result.BackupStorageResult +name: BackupStorageResult +fullName: azure.keyvault.v7_0.models.backup_storage_result.BackupStorageResult +module: azure.keyvault.v7_0.models.backup_storage_result +summary: 'The backup storage result, containing the backup blob. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: BackupStorageResult(**kwargs) +variables: +- description: The backup blob containing the backed up storage account. + name: value + types: + - +methods: +- uid: azure.keyvault.v7_0.models.backup_storage_result.BackupStorageResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.backup_storage_result.BackupStorageResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.backup_storage_result.BackupStorageResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.backup_storage_result.BackupStorageResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.backup_storage_result.BackupStorageResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.backup_storage_result.BackupStorageResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.backup_storage_result.BackupStorageResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_storage_result.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_storage_result.yml new file mode 100644 index 00000000..25520863 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_storage_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.backup_storage_result +name: backup_storage_result +fullName: azure.keyvault.v7_0.models.backup_storage_result +classes: +- azure.keyvault.v7_0.models.backup_storage_result.BackupStorageResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_storage_result_py3.BackupStorageResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_storage_result_py3.BackupStorageResult.yml new file mode 100644 index 00000000..938e7abf --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_storage_result_py3.BackupStorageResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.backup_storage_result_py3.BackupStorageResult +name: BackupStorageResult +fullName: azure.keyvault.v7_0.models.backup_storage_result_py3.BackupStorageResult +module: azure.keyvault.v7_0.models.backup_storage_result_py3 +summary: 'The backup storage result, containing the backup blob. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: BackupStorageResult(**kwargs) +variables: +- description: The backup blob containing the backed up storage account. + name: value + types: + - +methods: +- uid: azure.keyvault.v7_0.models.backup_storage_result_py3.BackupStorageResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.backup_storage_result_py3.BackupStorageResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.backup_storage_result_py3.BackupStorageResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.backup_storage_result_py3.BackupStorageResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.backup_storage_result_py3.BackupStorageResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.backup_storage_result_py3.BackupStorageResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.backup_storage_result_py3.BackupStorageResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_storage_result_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_storage_result_py3.yml new file mode 100644 index 00000000..b67483e8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.backup_storage_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.backup_storage_result_py3 +name: backup_storage_result_py3 +fullName: azure.keyvault.v7_0.models.backup_storage_result_py3 +classes: +- azure.keyvault.v7_0.models.backup_storage_result_py3.BackupStorageResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_attributes.CertificateAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_attributes.CertificateAttributes.yml new file mode 100644 index 00000000..a78111aa --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_attributes.CertificateAttributes.yml @@ -0,0 +1,161 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_attributes.CertificateAttributes +name: CertificateAttributes +fullName: azure.keyvault.v7_0.models.certificate_attributes.CertificateAttributes +module: azure.keyvault.v7_0.models.certificate_attributes +summary: 'The certificate management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: CertificateAttributes(**kwargs) + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for certificates in the current vault. If it contains ''Purgeable'', + + the certificate can be permanently deleted by a privileged user; + + otherwise, only the system can purge the certificate, at the end of the + + retention interval. Possible values include: ''Purgeable'', + + ''Recoverable+Purgeable'', ''Recoverable'', + + ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v7_0.models.certificate_attributes.CertificateAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_attributes.CertificateAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_attributes.CertificateAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_attributes.CertificateAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_attributes.CertificateAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_attributes.CertificateAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_attributes.CertificateAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_attributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_attributes.yml new file mode 100644 index 00000000..952eb60f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_attributes.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_attributes +name: certificate_attributes +fullName: azure.keyvault.v7_0.models.certificate_attributes +classes: +- azure.keyvault.v7_0.models.certificate_attributes.CertificateAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_attributes_py3.CertificateAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_attributes_py3.CertificateAttributes.yml new file mode 100644 index 00000000..982bbbdc --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_attributes_py3.CertificateAttributes.yml @@ -0,0 +1,169 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_attributes_py3.CertificateAttributes +name: CertificateAttributes +fullName: azure.keyvault.v7_0.models.certificate_attributes_py3.CertificateAttributes +module: azure.keyvault.v7_0.models.certificate_attributes_py3 +summary: 'The certificate management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'CertificateAttributes(*, enabled: bool = None, not_before=None, expires=None, + **kwargs)' + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true + - name: not_before + isRequired: true + - name: expires + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for certificates in the current vault. If it contains ''Purgeable'', + + the certificate can be permanently deleted by a privileged user; + + otherwise, only the system can purge the certificate, at the end of the + + retention interval. Possible values include: ''Purgeable'', + + ''Recoverable+Purgeable'', ''Recoverable'', + + ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v7_0.models.certificate_attributes_py3.CertificateAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_attributes_py3.CertificateAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_attributes_py3.CertificateAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_attributes_py3.CertificateAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_attributes_py3.CertificateAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_attributes_py3.CertificateAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_attributes_py3.CertificateAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_attributes_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_attributes_py3.yml new file mode 100644 index 00000000..6d7dcd37 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_attributes_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_attributes_py3 +name: certificate_attributes_py3 +fullName: azure.keyvault.v7_0.models.certificate_attributes_py3 +classes: +- azure.keyvault.v7_0.models.certificate_attributes_py3.CertificateAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_bundle.CertificateBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_bundle.CertificateBundle.yml new file mode 100644 index 00000000..4ea26eb3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_bundle.CertificateBundle.yml @@ -0,0 +1,161 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_bundle.CertificateBundle +name: CertificateBundle +fullName: azure.keyvault.v7_0.models.certificate_bundle.CertificateBundle +module: azure.keyvault.v7_0.models.certificate_bundle +summary: 'A certificate bundle consists of a certificate (X509) plus its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: CertificateBundle(**kwargs) + parameters: + - name: cer + description: CER contents of x509 certificate. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The certificate attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs + isRequired: true + types: + - [, ] +variables: +- description: The certificate id. + name: id + types: + - +- description: The key id. + name: kid + types: + - +- description: The secret id. + name: sid + types: + - +- description: Thumbprint of the certificate. + name: x509_thumbprint + types: + - +- description: The management policy. + name: policy + types: + - +methods: +- uid: azure.keyvault.v7_0.models.certificate_bundle.CertificateBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_bundle.CertificateBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_bundle.CertificateBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_bundle.CertificateBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_bundle.CertificateBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_bundle.CertificateBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_bundle.CertificateBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_bundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_bundle.yml new file mode 100644 index 00000000..4d359997 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_bundle.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_bundle +name: certificate_bundle +fullName: azure.keyvault.v7_0.models.certificate_bundle +classes: +- azure.keyvault.v7_0.models.certificate_bundle.CertificateBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_bundle_py3.CertificateBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_bundle_py3.CertificateBundle.yml new file mode 100644 index 00000000..d9cf46e6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_bundle_py3.CertificateBundle.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_bundle_py3.CertificateBundle +name: CertificateBundle +fullName: azure.keyvault.v7_0.models.certificate_bundle_py3.CertificateBundle +module: azure.keyvault.v7_0.models.certificate_bundle_py3 +summary: 'A certificate bundle consists of a certificate (X509) plus its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'CertificateBundle(*, cer: bytearray = None, content_type: str = None, attributes=None, + tags=None, **kwargs)' + parameters: + - name: cer + description: CER contents of x509 certificate. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The certificate attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: cer + isRequired: true + - name: content_type + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true +variables: +- description: The certificate id. + name: id + types: + - +- description: The key id. + name: kid + types: + - +- description: The secret id. + name: sid + types: + - +- description: Thumbprint of the certificate. + name: x509_thumbprint + types: + - +- description: The management policy. + name: policy + types: + - +methods: +- uid: azure.keyvault.v7_0.models.certificate_bundle_py3.CertificateBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_bundle_py3.CertificateBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_bundle_py3.CertificateBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_bundle_py3.CertificateBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_bundle_py3.CertificateBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_bundle_py3.CertificateBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_bundle_py3.CertificateBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_bundle_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_bundle_py3.yml new file mode 100644 index 00000000..2857d100 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_bundle_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_bundle_py3 +name: certificate_bundle_py3 +fullName: azure.keyvault.v7_0.models.certificate_bundle_py3 +classes: +- azure.keyvault.v7_0.models.certificate_bundle_py3.CertificateBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_create_parameters.CertificateCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_create_parameters.CertificateCreateParameters.yml new file mode 100644 index 00000000..b6a732af --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_create_parameters.CertificateCreateParameters.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_create_parameters.CertificateCreateParameters +name: CertificateCreateParameters +fullName: azure.keyvault.v7_0.models.certificate_create_parameters.CertificateCreateParameters +module: azure.keyvault.v7_0.models.certificate_create_parameters +summary: The certificate create parameters. +constructor: + syntax: CertificateCreateParameters(**kwargs) + parameters: + - name: certificate_policy + description: The management policy for the certificate. + isRequired: true + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +methods: +- uid: azure.keyvault.v7_0.models.certificate_create_parameters.CertificateCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_create_parameters.CertificateCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_create_parameters.CertificateCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_create_parameters.CertificateCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_create_parameters.CertificateCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_create_parameters.CertificateCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_create_parameters.CertificateCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_create_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_create_parameters.yml new file mode 100644 index 00000000..735f8a51 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_create_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_create_parameters +name: certificate_create_parameters +fullName: azure.keyvault.v7_0.models.certificate_create_parameters +classes: +- azure.keyvault.v7_0.models.certificate_create_parameters.CertificateCreateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_create_parameters_py3.CertificateCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_create_parameters_py3.CertificateCreateParameters.yml new file mode 100644 index 00000000..b381fade --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_create_parameters_py3.CertificateCreateParameters.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_create_parameters_py3.CertificateCreateParameters +name: CertificateCreateParameters +fullName: azure.keyvault.v7_0.models.certificate_create_parameters_py3.CertificateCreateParameters +module: azure.keyvault.v7_0.models.certificate_create_parameters_py3 +summary: The certificate create parameters. +constructor: + syntax: CertificateCreateParameters(*, certificate_policy=None, certificate_attributes=None, + tags=None, **kwargs) + parameters: + - name: certificate_policy + description: The management policy for the certificate. + isRequired: true + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: certificate_policy + isRequired: true + - name: certificate_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.certificate_create_parameters_py3.CertificateCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_create_parameters_py3.CertificateCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_create_parameters_py3.CertificateCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_create_parameters_py3.CertificateCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_create_parameters_py3.CertificateCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_create_parameters_py3.CertificateCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_create_parameters_py3.CertificateCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_create_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_create_parameters_py3.yml new file mode 100644 index 00000000..cb24de64 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_create_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_create_parameters_py3 +name: certificate_create_parameters_py3 +fullName: azure.keyvault.v7_0.models.certificate_create_parameters_py3 +classes: +- azure.keyvault.v7_0.models.certificate_create_parameters_py3.CertificateCreateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_import_parameters.CertificateImportParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_import_parameters.CertificateImportParameters.yml new file mode 100644 index 00000000..eb1423ec --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_import_parameters.CertificateImportParameters.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_import_parameters.CertificateImportParameters +name: CertificateImportParameters +fullName: azure.keyvault.v7_0.models.certificate_import_parameters.CertificateImportParameters +module: azure.keyvault.v7_0.models.certificate_import_parameters +summary: 'The certificate import parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CertificateImportParameters(**kwargs) + parameters: + - name: base64_encoded_certificate + description: 'Required. Base64 encoded representation + + of the certificate object to import. This certificate needs to contain the + + private key.' + isRequired: true + types: + - + - name: password + description: 'If the private key in base64EncodedCertificate is + + encrypted, the password used for encryption.' + isRequired: true + types: + - + - name: certificate_policy + description: The management policy for the certificate. + isRequired: true + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +methods: +- uid: azure.keyvault.v7_0.models.certificate_import_parameters.CertificateImportParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_import_parameters.CertificateImportParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_import_parameters.CertificateImportParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_import_parameters.CertificateImportParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_import_parameters.CertificateImportParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_import_parameters.CertificateImportParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_import_parameters.CertificateImportParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_import_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_import_parameters.yml new file mode 100644 index 00000000..2f08a340 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_import_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_import_parameters +name: certificate_import_parameters +fullName: azure.keyvault.v7_0.models.certificate_import_parameters +classes: +- azure.keyvault.v7_0.models.certificate_import_parameters.CertificateImportParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_import_parameters_py3.CertificateImportParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_import_parameters_py3.CertificateImportParameters.yml new file mode 100644 index 00000000..4ecfff66 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_import_parameters_py3.CertificateImportParameters.yml @@ -0,0 +1,163 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_import_parameters_py3.CertificateImportParameters +name: CertificateImportParameters +fullName: azure.keyvault.v7_0.models.certificate_import_parameters_py3.CertificateImportParameters +module: azure.keyvault.v7_0.models.certificate_import_parameters_py3 +summary: 'The certificate import parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CertificateImportParameters(*, base64_encoded_certificate: str, password: + str = None, certificate_policy=None, certificate_attributes=None, tags=None, **kwargs)' + parameters: + - name: base64_encoded_certificate + description: 'Required. Base64 encoded representation + + of the certificate object to import. This certificate needs to contain the + + private key.' + isRequired: true + types: + - + - name: password + description: 'If the private key in base64EncodedCertificate is + + encrypted, the password used for encryption.' + isRequired: true + types: + - + - name: certificate_policy + description: The management policy for the certificate. + isRequired: true + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: base64_encoded_certificate + isRequired: true + - name: password + isRequired: true + - name: certificate_policy + isRequired: true + - name: certificate_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.certificate_import_parameters_py3.CertificateImportParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_import_parameters_py3.CertificateImportParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_import_parameters_py3.CertificateImportParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_import_parameters_py3.CertificateImportParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_import_parameters_py3.CertificateImportParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_import_parameters_py3.CertificateImportParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_import_parameters_py3.CertificateImportParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_import_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_import_parameters_py3.yml new file mode 100644 index 00000000..f42bf735 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_import_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_import_parameters_py3 +name: certificate_import_parameters_py3 +fullName: azure.keyvault.v7_0.models.certificate_import_parameters_py3 +classes: +- azure.keyvault.v7_0.models.certificate_import_parameters_py3.CertificateImportParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item.CertificateIssuerItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item.CertificateIssuerItem.yml new file mode 100644 index 00000000..d6d4fce8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item.CertificateIssuerItem.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_issuer_item.CertificateIssuerItem +name: CertificateIssuerItem +fullName: azure.keyvault.v7_0.models.certificate_issuer_item.CertificateIssuerItem +module: azure.keyvault.v7_0.models.certificate_issuer_item +summary: The certificate issuer item containing certificate issuer metadata. +constructor: + syntax: CertificateIssuerItem(**kwargs) + parameters: + - name: id + description: Certificate Identifier. + isRequired: true + types: + - + - name: provider + description: The issuer provider. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.models.certificate_issuer_item.CertificateIssuerItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_issuer_item.CertificateIssuerItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_issuer_item.CertificateIssuerItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_issuer_item.CertificateIssuerItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_issuer_item.CertificateIssuerItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_issuer_item.CertificateIssuerItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_issuer_item.CertificateIssuerItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item.yml new file mode 100644 index 00000000..8527ec7c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_issuer_item +name: certificate_issuer_item +fullName: azure.keyvault.v7_0.models.certificate_issuer_item +classes: +- azure.keyvault.v7_0.models.certificate_issuer_item.CertificateIssuerItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item_paged.CertificateIssuerItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item_paged.CertificateIssuerItemPaged.yml new file mode 100644 index 00000000..d6c3e148 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item_paged.CertificateIssuerItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_issuer_item_paged.CertificateIssuerItemPaged +name: CertificateIssuerItemPaged +fullName: azure.keyvault.v7_0.models.certificate_issuer_item_paged.CertificateIssuerItemPaged +module: azure.keyvault.v7_0.models.certificate_issuer_item_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: CertificateIssuerItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v7_0.models.certificate_issuer_item_paged.CertificateIssuerItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v7_0.models.certificate_issuer_item_paged.CertificateIssuerItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v7_0.models.certificate_issuer_item_paged.CertificateIssuerItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.certificate_issuer_item_paged.CertificateIssuerItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.certificate_issuer_item_paged.CertificateIssuerItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v7_0.models.certificate_issuer_item_paged.CertificateIssuerItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v7_0.models.certificate_issuer_item_paged.CertificateIssuerItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item_paged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item_paged.yml new file mode 100644 index 00000000..8da5cc5d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_issuer_item_paged +name: certificate_issuer_item_paged +fullName: azure.keyvault.v7_0.models.certificate_issuer_item_paged +classes: +- azure.keyvault.v7_0.models.certificate_issuer_item_paged.CertificateIssuerItemPaged diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item_py3.CertificateIssuerItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item_py3.CertificateIssuerItem.yml new file mode 100644 index 00000000..7c4421ad --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item_py3.CertificateIssuerItem.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_issuer_item_py3.CertificateIssuerItem +name: CertificateIssuerItem +fullName: azure.keyvault.v7_0.models.certificate_issuer_item_py3.CertificateIssuerItem +module: azure.keyvault.v7_0.models.certificate_issuer_item_py3 +summary: The certificate issuer item containing certificate issuer metadata. +constructor: + syntax: 'CertificateIssuerItem(*, id: str = None, provider: str = None, **kwargs)' + parameters: + - name: id + description: Certificate Identifier. + isRequired: true + types: + - + - name: provider + description: The issuer provider. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: provider + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.certificate_issuer_item_py3.CertificateIssuerItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_issuer_item_py3.CertificateIssuerItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_issuer_item_py3.CertificateIssuerItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_issuer_item_py3.CertificateIssuerItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_issuer_item_py3.CertificateIssuerItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_issuer_item_py3.CertificateIssuerItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_issuer_item_py3.CertificateIssuerItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item_py3.yml new file mode 100644 index 00000000..93609a04 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_issuer_item_py3 +name: certificate_issuer_item_py3 +fullName: azure.keyvault.v7_0.models.certificate_issuer_item_py3 +classes: +- azure.keyvault.v7_0.models.certificate_issuer_item_py3.CertificateIssuerItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters.yml new file mode 100644 index 00000000..9c294f5d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters +name: CertificateIssuerSetParameters +fullName: azure.keyvault.v7_0.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters +module: azure.keyvault.v7_0.models.certificate_issuer_set_parameters +summary: 'The certificate issuer set parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CertificateIssuerSetParameters(**kwargs) + parameters: + - name: provider + description: Required. The issuer provider. + isRequired: true + types: + - + - name: credentials + description: The credentials to be used for the issuer. + isRequired: true + types: + - + - name: organization_details + description: 'Details of the organization as provided to + + the issuer.' + isRequired: true + types: + - + - name: attributes + description: Attributes of the issuer object. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_set_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_set_parameters.yml new file mode 100644 index 00000000..642b3c4b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_set_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_issuer_set_parameters +name: certificate_issuer_set_parameters +fullName: azure.keyvault.v7_0.models.certificate_issuer_set_parameters +classes: +- azure.keyvault.v7_0.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.yml new file mode 100644 index 00000000..b5e65b01 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters +name: CertificateIssuerSetParameters +fullName: azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters +module: azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3 +summary: 'The certificate issuer set parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CertificateIssuerSetParameters(*, provider: str, credentials=None, organization_details=None, + attributes=None, **kwargs)' + parameters: + - name: provider + description: Required. The issuer provider. + isRequired: true + types: + - + - name: credentials + description: The credentials to be used for the issuer. + isRequired: true + types: + - + - name: organization_details + description: 'Details of the organization as provided to + + the issuer.' + isRequired: true + types: + - + - name: attributes + description: Attributes of the issuer object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: provider + isRequired: true + - name: credentials + isRequired: true + - name: organization_details + isRequired: true + - name: attributes + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.yml new file mode 100644 index 00000000..18777a6d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3 +name: certificate_issuer_set_parameters_py3 +fullName: azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3 +classes: +- azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters.yml new file mode 100644 index 00000000..f5872a3c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters +name: CertificateIssuerUpdateParameters +fullName: azure.keyvault.v7_0.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters +module: azure.keyvault.v7_0.models.certificate_issuer_update_parameters +summary: The certificate issuer update parameters. +constructor: + syntax: CertificateIssuerUpdateParameters(**kwargs) + parameters: + - name: provider + description: The issuer provider. + isRequired: true + types: + - + - name: credentials + description: The credentials to be used for the issuer. + isRequired: true + types: + - + - name: organization_details + description: 'Details of the organization as provided to + + the issuer.' + isRequired: true + types: + - + - name: attributes + description: Attributes of the issuer object. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_update_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_update_parameters.yml new file mode 100644 index 00000000..be7f67c6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_update_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_issuer_update_parameters +name: certificate_issuer_update_parameters +fullName: azure.keyvault.v7_0.models.certificate_issuer_update_parameters +classes: +- azure.keyvault.v7_0.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.yml new file mode 100644 index 00000000..87669150 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters +name: CertificateIssuerUpdateParameters +fullName: azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters +module: azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3 +summary: The certificate issuer update parameters. +constructor: + syntax: 'CertificateIssuerUpdateParameters(*, provider: str = None, credentials=None, + organization_details=None, attributes=None, **kwargs)' + parameters: + - name: provider + description: The issuer provider. + isRequired: true + types: + - + - name: credentials + description: The credentials to be used for the issuer. + isRequired: true + types: + - + - name: organization_details + description: 'Details of the organization as provided to + + the issuer.' + isRequired: true + types: + - + - name: attributes + description: Attributes of the issuer object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: provider + isRequired: true + - name: credentials + isRequired: true + - name: organization_details + isRequired: true + - name: attributes + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.yml new file mode 100644 index 00000000..47585330 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3 +name: certificate_issuer_update_parameters_py3 +fullName: azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3 +classes: +- azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item.CertificateItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item.CertificateItem.yml new file mode 100644 index 00000000..b5ce0963 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item.CertificateItem.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_item.CertificateItem +name: CertificateItem +fullName: azure.keyvault.v7_0.models.certificate_item.CertificateItem +module: azure.keyvault.v7_0.models.certificate_item +summary: The certificate item containing certificate metadata. +constructor: + syntax: CertificateItem(**kwargs) + parameters: + - name: id + description: Certificate identifier. + isRequired: true + types: + - + - name: attributes + description: The certificate management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: x509_thumbprint + description: Thumbprint of the certificate. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.models.certificate_item.CertificateItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_item.CertificateItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_item.CertificateItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_item.CertificateItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_item.CertificateItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_item.CertificateItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_item.CertificateItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item.yml new file mode 100644 index 00000000..f026c32d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_item +name: certificate_item +fullName: azure.keyvault.v7_0.models.certificate_item +classes: +- azure.keyvault.v7_0.models.certificate_item.CertificateItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item_paged.CertificateItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item_paged.CertificateItemPaged.yml new file mode 100644 index 00000000..222cca59 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item_paged.CertificateItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_item_paged.CertificateItemPaged +name: CertificateItemPaged +fullName: azure.keyvault.v7_0.models.certificate_item_paged.CertificateItemPaged +module: azure.keyvault.v7_0.models.certificate_item_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: CertificateItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v7_0.models.certificate_item_paged.CertificateItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v7_0.models.certificate_item_paged.CertificateItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v7_0.models.certificate_item_paged.CertificateItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.certificate_item_paged.CertificateItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.certificate_item_paged.CertificateItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v7_0.models.certificate_item_paged.CertificateItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v7_0.models.certificate_item_paged.CertificateItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item_paged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item_paged.yml new file mode 100644 index 00000000..f949514b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_item_paged +name: certificate_item_paged +fullName: azure.keyvault.v7_0.models.certificate_item_paged +classes: +- azure.keyvault.v7_0.models.certificate_item_paged.CertificateItemPaged diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item_py3.CertificateItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item_py3.CertificateItem.yml new file mode 100644 index 00000000..d4f42f64 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item_py3.CertificateItem.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_item_py3.CertificateItem +name: CertificateItem +fullName: azure.keyvault.v7_0.models.certificate_item_py3.CertificateItem +module: azure.keyvault.v7_0.models.certificate_item_py3 +summary: The certificate item containing certificate metadata. +constructor: + syntax: 'CertificateItem(*, id: str = None, attributes=None, tags=None, x509_thumbprint: + bytes = None, **kwargs)' + parameters: + - name: id + description: Certificate identifier. + isRequired: true + types: + - + - name: attributes + description: The certificate management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: x509_thumbprint + description: Thumbprint of the certificate. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: x509_thumbprint + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.certificate_item_py3.CertificateItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_item_py3.CertificateItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_item_py3.CertificateItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_item_py3.CertificateItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_item_py3.CertificateItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_item_py3.CertificateItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_item_py3.CertificateItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item_py3.yml new file mode 100644 index 00000000..e098af70 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_item_py3 +name: certificate_item_py3 +fullName: azure.keyvault.v7_0.models.certificate_item_py3 +classes: +- azure.keyvault.v7_0.models.certificate_item_py3.CertificateItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_merge_parameters.CertificateMergeParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_merge_parameters.CertificateMergeParameters.yml new file mode 100644 index 00000000..ad7d9b73 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_merge_parameters.CertificateMergeParameters.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_merge_parameters.CertificateMergeParameters +name: CertificateMergeParameters +fullName: azure.keyvault.v7_0.models.certificate_merge_parameters.CertificateMergeParameters +module: azure.keyvault.v7_0.models.certificate_merge_parameters +summary: 'The certificate merge parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CertificateMergeParameters(**kwargs) + parameters: + - name: x509_certificates + description: 'Required. The certificate or the certificate + + chain to merge.' + isRequired: true + types: + - [] + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +methods: +- uid: azure.keyvault.v7_0.models.certificate_merge_parameters.CertificateMergeParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_merge_parameters.CertificateMergeParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_merge_parameters.CertificateMergeParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_merge_parameters.CertificateMergeParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_merge_parameters.CertificateMergeParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_merge_parameters.CertificateMergeParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_merge_parameters.CertificateMergeParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_merge_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_merge_parameters.yml new file mode 100644 index 00000000..af9277a8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_merge_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_merge_parameters +name: certificate_merge_parameters +fullName: azure.keyvault.v7_0.models.certificate_merge_parameters +classes: +- azure.keyvault.v7_0.models.certificate_merge_parameters.CertificateMergeParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_merge_parameters_py3.CertificateMergeParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_merge_parameters_py3.CertificateMergeParameters.yml new file mode 100644 index 00000000..cba5714c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_merge_parameters_py3.CertificateMergeParameters.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_merge_parameters_py3.CertificateMergeParameters +name: CertificateMergeParameters +fullName: azure.keyvault.v7_0.models.certificate_merge_parameters_py3.CertificateMergeParameters +module: azure.keyvault.v7_0.models.certificate_merge_parameters_py3 +summary: 'The certificate merge parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CertificateMergeParameters(*, x509_certificates, certificate_attributes=None, + tags=None, **kwargs) + parameters: + - name: x509_certificates + description: 'Required. The certificate or the certificate + + chain to merge.' + isRequired: true + types: + - [] + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: x509_certificates + isRequired: true + - name: certificate_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.certificate_merge_parameters_py3.CertificateMergeParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_merge_parameters_py3.CertificateMergeParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_merge_parameters_py3.CertificateMergeParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_merge_parameters_py3.CertificateMergeParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_merge_parameters_py3.CertificateMergeParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_merge_parameters_py3.CertificateMergeParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_merge_parameters_py3.CertificateMergeParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_merge_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_merge_parameters_py3.yml new file mode 100644 index 00000000..af364397 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_merge_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_merge_parameters_py3 +name: certificate_merge_parameters_py3 +fullName: azure.keyvault.v7_0.models.certificate_merge_parameters_py3 +classes: +- azure.keyvault.v7_0.models.certificate_merge_parameters_py3.CertificateMergeParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation.CertificateOperation.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation.CertificateOperation.yml new file mode 100644 index 00000000..1325cdc9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation.CertificateOperation.yml @@ -0,0 +1,173 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_operation.CertificateOperation +name: CertificateOperation +fullName: azure.keyvault.v7_0.models.certificate_operation.CertificateOperation +module: azure.keyvault.v7_0.models.certificate_operation +summary: 'A certificate operation is returned in case of asynchronous requests. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: CertificateOperation(**kwargs) + parameters: + - name: issuer_parameters + description: 'Parameters for the issuer of the X509 component + + of a certificate.' + isRequired: true + types: + - + - name: csr + description: 'The certificate signing request (CSR) that is being used in + + the certificate operation.' + isRequired: true + types: + - + - name: cancellation_requested + description: 'Indicates if cancellation was requested on + + the certificate operation.' + isRequired: true + types: + - + - name: status + description: Status of the certificate operation. + isRequired: true + types: + - + - name: status_details + description: The status details of the certificate operation. + isRequired: true + types: + - + - name: error + description: Error encountered, if any, during the certificate operation. + isRequired: true + types: + - + - name: target + description: 'Location which contains the result of the certificate + + operation.' + isRequired: true + types: + - + - name: request_id + description: Identifier for the certificate operation. + isRequired: true + types: + - +variables: +- description: The certificate id. + name: id + types: + - +methods: +- uid: azure.keyvault.v7_0.models.certificate_operation.CertificateOperation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_operation.CertificateOperation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_operation.CertificateOperation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_operation.CertificateOperation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_operation.CertificateOperation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_operation.CertificateOperation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_operation.CertificateOperation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation.yml new file mode 100644 index 00000000..6fc5279c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_operation +name: certificate_operation +fullName: azure.keyvault.v7_0.models.certificate_operation +classes: +- azure.keyvault.v7_0.models.certificate_operation.CertificateOperation diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_py3.CertificateOperation.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_py3.CertificateOperation.yml new file mode 100644 index 00000000..56d5a9d1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_py3.CertificateOperation.yml @@ -0,0 +1,192 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_operation_py3.CertificateOperation +name: CertificateOperation +fullName: azure.keyvault.v7_0.models.certificate_operation_py3.CertificateOperation +module: azure.keyvault.v7_0.models.certificate_operation_py3 +summary: 'A certificate operation is returned in case of asynchronous requests. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'CertificateOperation(*, issuer_parameters=None, csr: bytearray = None, + cancellation_requested: bool = None, status: str = None, status_details: str = + None, error=None, target: str = None, request_id: str = None, **kwargs)' + parameters: + - name: issuer_parameters + description: 'Parameters for the issuer of the X509 component + + of a certificate.' + isRequired: true + types: + - + - name: csr + description: 'The certificate signing request (CSR) that is being used in + + the certificate operation.' + isRequired: true + types: + - + - name: cancellation_requested + description: 'Indicates if cancellation was requested on + + the certificate operation.' + isRequired: true + types: + - + - name: status + description: Status of the certificate operation. + isRequired: true + types: + - + - name: status_details + description: The status details of the certificate operation. + isRequired: true + types: + - + - name: error + description: Error encountered, if any, during the certificate operation. + isRequired: true + types: + - + - name: target + description: 'Location which contains the result of the certificate + + operation.' + isRequired: true + types: + - + - name: request_id + description: Identifier for the certificate operation. + isRequired: true + types: + - + keywordOnlyParameters: + - name: issuer_parameters + isRequired: true + - name: csr + isRequired: true + - name: cancellation_requested + isRequired: true + - name: status + isRequired: true + - name: status_details + isRequired: true + - name: error + isRequired: true + - name: target + isRequired: true + - name: request_id + isRequired: true +variables: +- description: The certificate id. + name: id + types: + - +methods: +- uid: azure.keyvault.v7_0.models.certificate_operation_py3.CertificateOperation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_operation_py3.CertificateOperation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_operation_py3.CertificateOperation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_operation_py3.CertificateOperation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_operation_py3.CertificateOperation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_operation_py3.CertificateOperation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_operation_py3.CertificateOperation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_py3.yml new file mode 100644 index 00000000..b7e6e4ac --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_operation_py3 +name: certificate_operation_py3 +fullName: azure.keyvault.v7_0.models.certificate_operation_py3 +classes: +- azure.keyvault.v7_0.models.certificate_operation_py3.CertificateOperation diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter.yml new file mode 100644 index 00000000..f7e92cc9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter +name: CertificateOperationUpdateParameter +fullName: azure.keyvault.v7_0.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter +module: azure.keyvault.v7_0.models.certificate_operation_update_parameter +summary: 'The certificate operation update parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CertificateOperationUpdateParameter(**kwargs) + parameters: + - name: cancellation_requested + description: 'Required. Indicates if cancellation was + + requested on the certificate operation.' + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_update_parameter.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_update_parameter.yml new file mode 100644 index 00000000..42b76a58 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_update_parameter.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_operation_update_parameter +name: certificate_operation_update_parameter +fullName: azure.keyvault.v7_0.models.certificate_operation_update_parameter +classes: +- azure.keyvault.v7_0.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter.yml new file mode 100644 index 00000000..43cf6a2f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter +name: CertificateOperationUpdateParameter +fullName: azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter +module: azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3 +summary: 'The certificate operation update parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CertificateOperationUpdateParameter(*, cancellation_requested: bool, **kwargs)' + parameters: + - name: cancellation_requested + description: 'Required. Indicates if cancellation was + + requested on the certificate operation.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cancellation_requested + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3.yml new file mode 100644 index 00000000..86dfa9fb --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3 +name: certificate_operation_update_parameter_py3 +fullName: azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3 +classes: +- azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_policy.CertificatePolicy.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_policy.CertificatePolicy.yml new file mode 100644 index 00000000..392f789a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_policy.CertificatePolicy.yml @@ -0,0 +1,161 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_policy.CertificatePolicy +name: CertificatePolicy +fullName: azure.keyvault.v7_0.models.certificate_policy.CertificatePolicy +module: azure.keyvault.v7_0.models.certificate_policy +summary: 'Management policy for a certificate. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: CertificatePolicy(**kwargs) + parameters: + - name: key_properties + description: Properties of the key backing a certificate. + isRequired: true + types: + - + - name: secret_properties + description: Properties of the secret backing a certificate. + isRequired: true + types: + - + - name: x509_certificate_properties + description: 'Properties of the X509 component of a + + certificate.' + isRequired: true + types: + - + - name: lifetime_actions + description: 'Actions that will be performed by Key Vault over + + the lifetime of a certificate.' + isRequired: true + types: + - [] + - name: issuer_parameters + description: 'Parameters for the issuer of the X509 component + + of a certificate.' + isRequired: true + types: + - + - name: attributes + description: The certificate attributes. + isRequired: true + types: + - +variables: +- description: The certificate id. + name: id + types: + - +methods: +- uid: azure.keyvault.v7_0.models.certificate_policy.CertificatePolicy.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_policy.CertificatePolicy.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_policy.CertificatePolicy.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_policy.CertificatePolicy.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_policy.CertificatePolicy.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_policy.CertificatePolicy.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_policy.CertificatePolicy.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_policy.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_policy.yml new file mode 100644 index 00000000..521bd17f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_policy.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_policy +name: certificate_policy +fullName: azure.keyvault.v7_0.models.certificate_policy +classes: +- azure.keyvault.v7_0.models.certificate_policy.CertificatePolicy diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_policy_py3.CertificatePolicy.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_policy_py3.CertificatePolicy.yml new file mode 100644 index 00000000..bccf390f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_policy_py3.CertificatePolicy.yml @@ -0,0 +1,175 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_policy_py3.CertificatePolicy +name: CertificatePolicy +fullName: azure.keyvault.v7_0.models.certificate_policy_py3.CertificatePolicy +module: azure.keyvault.v7_0.models.certificate_policy_py3 +summary: 'Management policy for a certificate. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: CertificatePolicy(*, key_properties=None, secret_properties=None, x509_certificate_properties=None, + lifetime_actions=None, issuer_parameters=None, attributes=None, **kwargs) + parameters: + - name: key_properties + description: Properties of the key backing a certificate. + isRequired: true + types: + - + - name: secret_properties + description: Properties of the secret backing a certificate. + isRequired: true + types: + - + - name: x509_certificate_properties + description: 'Properties of the X509 component of a + + certificate.' + isRequired: true + types: + - + - name: lifetime_actions + description: 'Actions that will be performed by Key Vault over + + the lifetime of a certificate.' + isRequired: true + types: + - [] + - name: issuer_parameters + description: 'Parameters for the issuer of the X509 component + + of a certificate.' + isRequired: true + types: + - + - name: attributes + description: The certificate attributes. + isRequired: true + types: + - + keywordOnlyParameters: + - name: key_properties + isRequired: true + - name: secret_properties + isRequired: true + - name: x509_certificate_properties + isRequired: true + - name: lifetime_actions + isRequired: true + - name: issuer_parameters + isRequired: true + - name: attributes + isRequired: true +variables: +- description: The certificate id. + name: id + types: + - +methods: +- uid: azure.keyvault.v7_0.models.certificate_policy_py3.CertificatePolicy.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_policy_py3.CertificatePolicy.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_policy_py3.CertificatePolicy.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_policy_py3.CertificatePolicy.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_policy_py3.CertificatePolicy.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_policy_py3.CertificatePolicy.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_policy_py3.CertificatePolicy.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_policy_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_policy_py3.yml new file mode 100644 index 00000000..17ae3e22 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_policy_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_policy_py3 +name: certificate_policy_py3 +fullName: azure.keyvault.v7_0.models.certificate_policy_py3 +classes: +- azure.keyvault.v7_0.models.certificate_policy_py3.CertificatePolicy diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_restore_parameters.CertificateRestoreParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_restore_parameters.CertificateRestoreParameters.yml new file mode 100644 index 00000000..8465011e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_restore_parameters.CertificateRestoreParameters.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_restore_parameters.CertificateRestoreParameters +name: CertificateRestoreParameters +fullName: azure.keyvault.v7_0.models.certificate_restore_parameters.CertificateRestoreParameters +module: azure.keyvault.v7_0.models.certificate_restore_parameters +summary: 'The certificate restore parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CertificateRestoreParameters(**kwargs) + parameters: + - name: certificate_bundle_backup + description: 'Required. The backup blob associated + + with a certificate bundle.' + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.models.certificate_restore_parameters.CertificateRestoreParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_restore_parameters.CertificateRestoreParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_restore_parameters.CertificateRestoreParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_restore_parameters.CertificateRestoreParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_restore_parameters.CertificateRestoreParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_restore_parameters.CertificateRestoreParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_restore_parameters.CertificateRestoreParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_restore_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_restore_parameters.yml new file mode 100644 index 00000000..db9357d8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_restore_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_restore_parameters +name: certificate_restore_parameters +fullName: azure.keyvault.v7_0.models.certificate_restore_parameters +classes: +- azure.keyvault.v7_0.models.certificate_restore_parameters.CertificateRestoreParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_restore_parameters_py3.CertificateRestoreParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_restore_parameters_py3.CertificateRestoreParameters.yml new file mode 100644 index 00000000..0c821346 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_restore_parameters_py3.CertificateRestoreParameters.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_restore_parameters_py3.CertificateRestoreParameters +name: CertificateRestoreParameters +fullName: azure.keyvault.v7_0.models.certificate_restore_parameters_py3.CertificateRestoreParameters +module: azure.keyvault.v7_0.models.certificate_restore_parameters_py3 +summary: 'The certificate restore parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CertificateRestoreParameters(*, certificate_bundle_backup: bytes, **kwargs)' + parameters: + - name: certificate_bundle_backup + description: 'Required. The backup blob associated + + with a certificate bundle.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: certificate_bundle_backup + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.certificate_restore_parameters_py3.CertificateRestoreParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_restore_parameters_py3.CertificateRestoreParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_restore_parameters_py3.CertificateRestoreParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_restore_parameters_py3.CertificateRestoreParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_restore_parameters_py3.CertificateRestoreParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_restore_parameters_py3.CertificateRestoreParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_restore_parameters_py3.CertificateRestoreParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_restore_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_restore_parameters_py3.yml new file mode 100644 index 00000000..84df64a3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_restore_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_restore_parameters_py3 +name: certificate_restore_parameters_py3 +fullName: azure.keyvault.v7_0.models.certificate_restore_parameters_py3 +classes: +- azure.keyvault.v7_0.models.certificate_restore_parameters_py3.CertificateRestoreParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_update_parameters.CertificateUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_update_parameters.CertificateUpdateParameters.yml new file mode 100644 index 00000000..59469218 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_update_parameters.CertificateUpdateParameters.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_update_parameters.CertificateUpdateParameters +name: CertificateUpdateParameters +fullName: azure.keyvault.v7_0.models.certificate_update_parameters.CertificateUpdateParameters +module: azure.keyvault.v7_0.models.certificate_update_parameters +summary: The certificate update parameters. +constructor: + syntax: CertificateUpdateParameters(**kwargs) + parameters: + - name: certificate_policy + description: The management policy for the certificate. + isRequired: true + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +methods: +- uid: azure.keyvault.v7_0.models.certificate_update_parameters.CertificateUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_update_parameters.CertificateUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_update_parameters.CertificateUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_update_parameters.CertificateUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_update_parameters.CertificateUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_update_parameters.CertificateUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_update_parameters.CertificateUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_update_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_update_parameters.yml new file mode 100644 index 00000000..bdf9fdfe --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_update_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_update_parameters +name: certificate_update_parameters +fullName: azure.keyvault.v7_0.models.certificate_update_parameters +classes: +- azure.keyvault.v7_0.models.certificate_update_parameters.CertificateUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_update_parameters_py3.CertificateUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_update_parameters_py3.CertificateUpdateParameters.yml new file mode 100644 index 00000000..3923b64b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_update_parameters_py3.CertificateUpdateParameters.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.certificate_update_parameters_py3.CertificateUpdateParameters +name: CertificateUpdateParameters +fullName: azure.keyvault.v7_0.models.certificate_update_parameters_py3.CertificateUpdateParameters +module: azure.keyvault.v7_0.models.certificate_update_parameters_py3 +summary: The certificate update parameters. +constructor: + syntax: CertificateUpdateParameters(*, certificate_policy=None, certificate_attributes=None, + tags=None, **kwargs) + parameters: + - name: certificate_policy + description: The management policy for the certificate. + isRequired: true + types: + - + - name: certificate_attributes + description: 'The attributes of the certificate + + (optional).' + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: certificate_policy + isRequired: true + - name: certificate_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.certificate_update_parameters_py3.CertificateUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_update_parameters_py3.CertificateUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_update_parameters_py3.CertificateUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.certificate_update_parameters_py3.CertificateUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.certificate_update_parameters_py3.CertificateUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.certificate_update_parameters_py3.CertificateUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.certificate_update_parameters_py3.CertificateUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_update_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_update_parameters_py3.yml new file mode 100644 index 00000000..603418a4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_update_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.certificate_update_parameters_py3 +name: certificate_update_parameters_py3 +fullName: azure.keyvault.v7_0.models.certificate_update_parameters_py3 +classes: +- azure.keyvault.v7_0.models.certificate_update_parameters_py3.CertificateUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contact.Contact.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contact.Contact.yml new file mode 100644 index 00000000..70e8c610 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contact.Contact.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.contact.Contact +name: Contact +fullName: azure.keyvault.v7_0.models.contact.Contact +module: azure.keyvault.v7_0.models.contact +summary: The contact information for the vault certificates. +constructor: + syntax: Contact(**kwargs) + parameters: + - name: email_address + description: Email addresss. + isRequired: true + types: + - + - name: name + description: Name. + isRequired: true + types: + - + - name: phone + description: Phone number. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.models.contact.Contact.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.contact.Contact.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.contact.Contact.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.contact.Contact.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.contact.Contact.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.contact.Contact.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.contact.Contact.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contact.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contact.yml new file mode 100644 index 00000000..98b6af0e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contact.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.contact +name: contact +fullName: azure.keyvault.v7_0.models.contact +classes: +- azure.keyvault.v7_0.models.contact.Contact diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contact_py3.Contact.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contact_py3.Contact.yml new file mode 100644 index 00000000..69f4f9b7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contact_py3.Contact.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.contact_py3.Contact +name: Contact +fullName: azure.keyvault.v7_0.models.contact_py3.Contact +module: azure.keyvault.v7_0.models.contact_py3 +summary: The contact information for the vault certificates. +constructor: + syntax: 'Contact(*, email_address: str = None, name: str = None, phone: str = None, + **kwargs)' + parameters: + - name: email_address + description: Email addresss. + isRequired: true + types: + - + - name: name + description: Name. + isRequired: true + types: + - + - name: phone + description: Phone number. + isRequired: true + types: + - + keywordOnlyParameters: + - name: email_address + isRequired: true + - name: name + isRequired: true + - name: phone + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.contact_py3.Contact.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.contact_py3.Contact.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.contact_py3.Contact.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.contact_py3.Contact.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.contact_py3.Contact.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.contact_py3.Contact.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.contact_py3.Contact.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contact_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contact_py3.yml new file mode 100644 index 00000000..200bc335 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contact_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.contact_py3 +name: contact_py3 +fullName: azure.keyvault.v7_0.models.contact_py3 +classes: +- azure.keyvault.v7_0.models.contact_py3.Contact diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contacts.Contacts.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contacts.Contacts.yml new file mode 100644 index 00000000..8c72bee5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contacts.Contacts.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.contacts.Contacts +name: Contacts +fullName: azure.keyvault.v7_0.models.contacts.Contacts +module: azure.keyvault.v7_0.models.contacts +summary: 'The contacts for the vault certificates. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Contacts(**kwargs) + parameters: + - name: contact_list + description: The contact list for the vault certificates. + isRequired: true + types: + - [] +variables: +- description: Identifier for the contacts collection. + name: id + types: + - +methods: +- uid: azure.keyvault.v7_0.models.contacts.Contacts.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.contacts.Contacts.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.contacts.Contacts.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.contacts.Contacts.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.contacts.Contacts.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.contacts.Contacts.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.contacts.Contacts.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contacts.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contacts.yml new file mode 100644 index 00000000..fd047d28 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contacts.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.contacts +name: contacts +fullName: azure.keyvault.v7_0.models.contacts +classes: +- azure.keyvault.v7_0.models.contacts.Contacts diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contacts_py3.Contacts.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contacts_py3.Contacts.yml new file mode 100644 index 00000000..2149f84d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contacts_py3.Contacts.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.contacts_py3.Contacts +name: Contacts +fullName: azure.keyvault.v7_0.models.contacts_py3.Contacts +module: azure.keyvault.v7_0.models.contacts_py3 +summary: 'The contacts for the vault certificates. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Contacts(*, contact_list=None, **kwargs) + parameters: + - name: contact_list + description: The contact list for the vault certificates. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: contact_list + isRequired: true +variables: +- description: Identifier for the contacts collection. + name: id + types: + - +methods: +- uid: azure.keyvault.v7_0.models.contacts_py3.Contacts.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.contacts_py3.Contacts.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.contacts_py3.Contacts.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.contacts_py3.Contacts.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.contacts_py3.Contacts.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.contacts_py3.Contacts.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.contacts_py3.Contacts.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contacts_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contacts_py3.yml new file mode 100644 index 00000000..d65d63e0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contacts_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.contacts_py3 +name: contacts_py3 +fullName: azure.keyvault.v7_0.models.contacts_py3 +classes: +- azure.keyvault.v7_0.models.contacts_py3.Contacts diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_bundle.DeletedCertificateBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_bundle.DeletedCertificateBundle.yml new file mode 100644 index 00000000..29c95120 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_bundle.DeletedCertificateBundle.yml @@ -0,0 +1,180 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_certificate_bundle.DeletedCertificateBundle +name: DeletedCertificateBundle +fullName: azure.keyvault.v7_0.models.deleted_certificate_bundle.DeletedCertificateBundle +module: azure.keyvault.v7_0.models.deleted_certificate_bundle +summary: 'A Deleted Certificate consisting of its previous id, attributes and its + + tags, as well as information on when it will be purged. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: DeletedCertificateBundle(**kwargs) + parameters: + - name: cer + description: CER contents of x509 certificate. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The certificate attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted certificate.' + isRequired: true + types: + - +variables: +- description: The certificate id. + name: id + types: + - +- description: The key id. + name: kid + types: + - +- description: The secret id. + name: sid + types: + - +- description: Thumbprint of the certificate. + name: x509_thumbprint + types: + - +- description: The management policy. + name: policy + types: + - +- description: 'The time when the certificate is scheduled to + + be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the certificate was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.deleted_certificate_bundle.DeletedCertificateBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_certificate_bundle.DeletedCertificateBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_certificate_bundle.DeletedCertificateBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.deleted_certificate_bundle.DeletedCertificateBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_certificate_bundle.DeletedCertificateBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.deleted_certificate_bundle.DeletedCertificateBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_certificate_bundle.DeletedCertificateBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_bundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_bundle.yml new file mode 100644 index 00000000..11026a68 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_bundle.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_certificate_bundle +name: deleted_certificate_bundle +fullName: azure.keyvault.v7_0.models.deleted_certificate_bundle +classes: +- azure.keyvault.v7_0.models.deleted_certificate_bundle.DeletedCertificateBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.yml new file mode 100644 index 00000000..6134a84d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.yml @@ -0,0 +1,192 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_certificate_bundle_py3.DeletedCertificateBundle +name: DeletedCertificateBundle +fullName: azure.keyvault.v7_0.models.deleted_certificate_bundle_py3.DeletedCertificateBundle +module: azure.keyvault.v7_0.models.deleted_certificate_bundle_py3 +summary: 'A Deleted Certificate consisting of its previous id, attributes and its + + tags, as well as information on when it will be purged. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedCertificateBundle(*, cer: bytearray = None, content_type: str = + None, attributes=None, tags=None, recovery_id: str = None, **kwargs)' + parameters: + - name: cer + description: CER contents of x509 certificate. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The certificate attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted certificate.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cer + isRequired: true + - name: content_type + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: The certificate id. + name: id + types: + - +- description: The key id. + name: kid + types: + - +- description: The secret id. + name: sid + types: + - +- description: Thumbprint of the certificate. + name: x509_thumbprint + types: + - +- description: The management policy. + name: policy + types: + - +- description: 'The time when the certificate is scheduled to + + be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the certificate was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_bundle_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_bundle_py3.yml new file mode 100644 index 00000000..7d27d33e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_bundle_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_certificate_bundle_py3 +name: deleted_certificate_bundle_py3 +fullName: azure.keyvault.v7_0.models.deleted_certificate_bundle_py3 +classes: +- azure.keyvault.v7_0.models.deleted_certificate_bundle_py3.DeletedCertificateBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item.DeletedCertificateItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item.DeletedCertificateItem.yml new file mode 100644 index 00000000..319dd56b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item.DeletedCertificateItem.yml @@ -0,0 +1,160 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_certificate_item.DeletedCertificateItem +name: DeletedCertificateItem +fullName: azure.keyvault.v7_0.models.deleted_certificate_item.DeletedCertificateItem +module: azure.keyvault.v7_0.models.deleted_certificate_item +summary: 'The deleted certificate item containing metadata about the deleted + + certificate. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: DeletedCertificateItem(**kwargs) + parameters: + - name: id + description: Certificate identifier. + isRequired: true + types: + - + - name: attributes + description: The certificate management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: x509_thumbprint + description: Thumbprint of the certificate. + isRequired: true + types: + - + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted certificate.' + isRequired: true + types: + - +variables: +- description: 'The time when the certificate is scheduled to + + be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the certificate was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.deleted_certificate_item.DeletedCertificateItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_certificate_item.DeletedCertificateItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_certificate_item.DeletedCertificateItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.deleted_certificate_item.DeletedCertificateItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_certificate_item.DeletedCertificateItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.deleted_certificate_item.DeletedCertificateItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_certificate_item.DeletedCertificateItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item.yml new file mode 100644 index 00000000..27a19e8a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_certificate_item +name: deleted_certificate_item +fullName: azure.keyvault.v7_0.models.deleted_certificate_item +classes: +- azure.keyvault.v7_0.models.deleted_certificate_item.DeletedCertificateItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item_paged.DeletedCertificateItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item_paged.DeletedCertificateItemPaged.yml new file mode 100644 index 00000000..f32034a3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item_paged.DeletedCertificateItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_certificate_item_paged.DeletedCertificateItemPaged +name: DeletedCertificateItemPaged +fullName: azure.keyvault.v7_0.models.deleted_certificate_item_paged.DeletedCertificateItemPaged +module: azure.keyvault.v7_0.models.deleted_certificate_item_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: DeletedCertificateItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v7_0.models.deleted_certificate_item_paged.DeletedCertificateItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v7_0.models.deleted_certificate_item_paged.DeletedCertificateItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v7_0.models.deleted_certificate_item_paged.DeletedCertificateItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.deleted_certificate_item_paged.DeletedCertificateItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.deleted_certificate_item_paged.DeletedCertificateItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v7_0.models.deleted_certificate_item_paged.DeletedCertificateItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v7_0.models.deleted_certificate_item_paged.DeletedCertificateItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item_paged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item_paged.yml new file mode 100644 index 00000000..d3654a2f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_certificate_item_paged +name: deleted_certificate_item_paged +fullName: azure.keyvault.v7_0.models.deleted_certificate_item_paged +classes: +- azure.keyvault.v7_0.models.deleted_certificate_item_paged.DeletedCertificateItemPaged diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item_py3.DeletedCertificateItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item_py3.DeletedCertificateItem.yml new file mode 100644 index 00000000..4c5ebc18 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item_py3.DeletedCertificateItem.yml @@ -0,0 +1,172 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_certificate_item_py3.DeletedCertificateItem +name: DeletedCertificateItem +fullName: azure.keyvault.v7_0.models.deleted_certificate_item_py3.DeletedCertificateItem +module: azure.keyvault.v7_0.models.deleted_certificate_item_py3 +summary: 'The deleted certificate item containing metadata about the deleted + + certificate. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedCertificateItem(*, id: str = None, attributes=None, tags=None, x509_thumbprint: + bytes = None, recovery_id: str = None, **kwargs)' + parameters: + - name: id + description: Certificate identifier. + isRequired: true + types: + - + - name: attributes + description: The certificate management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: x509_thumbprint + description: Thumbprint of the certificate. + isRequired: true + types: + - + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted certificate.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: x509_thumbprint + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: 'The time when the certificate is scheduled to + + be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the certificate was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.deleted_certificate_item_py3.DeletedCertificateItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_certificate_item_py3.DeletedCertificateItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_certificate_item_py3.DeletedCertificateItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.deleted_certificate_item_py3.DeletedCertificateItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_certificate_item_py3.DeletedCertificateItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.deleted_certificate_item_py3.DeletedCertificateItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_certificate_item_py3.DeletedCertificateItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item_py3.yml new file mode 100644 index 00000000..3191f383 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_certificate_item_py3 +name: deleted_certificate_item_py3 +fullName: azure.keyvault.v7_0.models.deleted_certificate_item_py3 +classes: +- azure.keyvault.v7_0.models.deleted_certificate_item_py3.DeletedCertificateItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_bundle.DeletedKeyBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_bundle.DeletedKeyBundle.yml new file mode 100644 index 00000000..f9f2b05d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_bundle.DeletedKeyBundle.yml @@ -0,0 +1,161 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_key_bundle.DeletedKeyBundle +name: DeletedKeyBundle +fullName: azure.keyvault.v7_0.models.deleted_key_bundle.DeletedKeyBundle +module: azure.keyvault.v7_0.models.deleted_key_bundle +summary: 'A DeletedKeyBundle consisting of a WebKey plus its Attributes and deletion + + info. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: DeletedKeyBundle(**kwargs) + parameters: + - name: key + description: The Json web key. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted key.' + isRequired: true + types: + - +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the key is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the key was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.deleted_key_bundle.DeletedKeyBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_key_bundle.DeletedKeyBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_key_bundle.DeletedKeyBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.deleted_key_bundle.DeletedKeyBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_key_bundle.DeletedKeyBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.deleted_key_bundle.DeletedKeyBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_key_bundle.DeletedKeyBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_bundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_bundle.yml new file mode 100644 index 00000000..24c8a227 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_bundle.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_key_bundle +name: deleted_key_bundle +fullName: azure.keyvault.v7_0.models.deleted_key_bundle +classes: +- azure.keyvault.v7_0.models.deleted_key_bundle.DeletedKeyBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_bundle_py3.DeletedKeyBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_bundle_py3.DeletedKeyBundle.yml new file mode 100644 index 00000000..17e5cd34 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_bundle_py3.DeletedKeyBundle.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_key_bundle_py3.DeletedKeyBundle +name: DeletedKeyBundle +fullName: azure.keyvault.v7_0.models.deleted_key_bundle_py3.DeletedKeyBundle +module: azure.keyvault.v7_0.models.deleted_key_bundle_py3 +summary: 'A DeletedKeyBundle consisting of a WebKey plus its Attributes and deletion + + info. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedKeyBundle(*, key=None, attributes=None, tags=None, recovery_id: + str = None, **kwargs)' + parameters: + - name: key + description: The Json web key. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted key.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: key + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the key is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the key was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.deleted_key_bundle_py3.DeletedKeyBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_key_bundle_py3.DeletedKeyBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_key_bundle_py3.DeletedKeyBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.deleted_key_bundle_py3.DeletedKeyBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_key_bundle_py3.DeletedKeyBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.deleted_key_bundle_py3.DeletedKeyBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_key_bundle_py3.DeletedKeyBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_bundle_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_bundle_py3.yml new file mode 100644 index 00000000..eea79de0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_bundle_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_key_bundle_py3 +name: deleted_key_bundle_py3 +fullName: azure.keyvault.v7_0.models.deleted_key_bundle_py3 +classes: +- azure.keyvault.v7_0.models.deleted_key_bundle_py3.DeletedKeyBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item.DeletedKeyItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item.DeletedKeyItem.yml new file mode 100644 index 00000000..abef4245 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item.DeletedKeyItem.yml @@ -0,0 +1,161 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_key_item.DeletedKeyItem +name: DeletedKeyItem +fullName: azure.keyvault.v7_0.models.deleted_key_item.DeletedKeyItem +module: azure.keyvault.v7_0.models.deleted_key_item +summary: 'The deleted key item containing the deleted key metadata and information + + about deletion. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: DeletedKeyItem(**kwargs) + parameters: + - name: kid + description: Key identifier. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted key.' + isRequired: true + types: + - +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the key is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the key was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.deleted_key_item.DeletedKeyItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_key_item.DeletedKeyItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_key_item.DeletedKeyItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.deleted_key_item.DeletedKeyItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_key_item.DeletedKeyItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.deleted_key_item.DeletedKeyItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_key_item.DeletedKeyItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item.yml new file mode 100644 index 00000000..5db9bc5e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_key_item +name: deleted_key_item +fullName: azure.keyvault.v7_0.models.deleted_key_item +classes: +- azure.keyvault.v7_0.models.deleted_key_item.DeletedKeyItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item_paged.DeletedKeyItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item_paged.DeletedKeyItemPaged.yml new file mode 100644 index 00000000..bd5c9b83 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item_paged.DeletedKeyItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_key_item_paged.DeletedKeyItemPaged +name: DeletedKeyItemPaged +fullName: azure.keyvault.v7_0.models.deleted_key_item_paged.DeletedKeyItemPaged +module: azure.keyvault.v7_0.models.deleted_key_item_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: DeletedKeyItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v7_0.models.deleted_key_item_paged.DeletedKeyItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v7_0.models.deleted_key_item_paged.DeletedKeyItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v7_0.models.deleted_key_item_paged.DeletedKeyItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.deleted_key_item_paged.DeletedKeyItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.deleted_key_item_paged.DeletedKeyItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v7_0.models.deleted_key_item_paged.DeletedKeyItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v7_0.models.deleted_key_item_paged.DeletedKeyItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item_paged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item_paged.yml new file mode 100644 index 00000000..f4b5ccb9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_key_item_paged +name: deleted_key_item_paged +fullName: azure.keyvault.v7_0.models.deleted_key_item_paged +classes: +- azure.keyvault.v7_0.models.deleted_key_item_paged.DeletedKeyItemPaged diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item_py3.DeletedKeyItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item_py3.DeletedKeyItem.yml new file mode 100644 index 00000000..90196f0b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item_py3.DeletedKeyItem.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_key_item_py3.DeletedKeyItem +name: DeletedKeyItem +fullName: azure.keyvault.v7_0.models.deleted_key_item_py3.DeletedKeyItem +module: azure.keyvault.v7_0.models.deleted_key_item_py3 +summary: 'The deleted key item containing the deleted key metadata and information + + about deletion. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedKeyItem(*, kid: str = None, attributes=None, tags=None, recovery_id: + str = None, **kwargs)' + parameters: + - name: kid + description: Key identifier. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted key.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: kid + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the key is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the key was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.deleted_key_item_py3.DeletedKeyItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_key_item_py3.DeletedKeyItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_key_item_py3.DeletedKeyItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.deleted_key_item_py3.DeletedKeyItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_key_item_py3.DeletedKeyItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.deleted_key_item_py3.DeletedKeyItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_key_item_py3.DeletedKeyItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item_py3.yml new file mode 100644 index 00000000..6bdf0c16 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_key_item_py3 +name: deleted_key_item_py3 +fullName: azure.keyvault.v7_0.models.deleted_key_item_py3 +classes: +- azure.keyvault.v7_0.models.deleted_key_item_py3.DeletedKeyItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_bundle.DeletedSasDefinitionBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_bundle.DeletedSasDefinitionBundle.yml new file mode 100644 index 00000000..469d5ed2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_bundle.DeletedSasDefinitionBundle.yml @@ -0,0 +1,177 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_sas_definition_bundle.DeletedSasDefinitionBundle +name: DeletedSasDefinitionBundle +fullName: azure.keyvault.v7_0.models.deleted_sas_definition_bundle.DeletedSasDefinitionBundle +module: azure.keyvault.v7_0.models.deleted_sas_definition_bundle +summary: 'A deleted SAS definition bundle consisting of its previous id, attributes + + and its tags, as well as information on when it will be purged. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: DeletedSasDefinitionBundle(**kwargs) + parameters: + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted SAS definition.' + isRequired: true + types: + - +variables: +- description: The SAS definition id. + name: id + types: + - +- description: Storage account SAS definition secret id. + name: secret_id + types: + - +- description: 'The SAS definition token template signed with an + + arbitrary key. Tokens created according to the SAS definition will have + + the same properties as the template.' + name: template_uri + types: + - +- description: 'The type of SAS token the SAS definition will create. + + Possible values include: ''account'', ''service''' + name: sas_type + types: + - + - +- description: 'The validity period of SAS tokens created according + + to the SAS definition.' + name: validity_period + types: + - +- description: The SAS definition attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs + name: tags + types: + - [, ] +- description: 'The time when the SAS definition is scheduled + + to be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the SAS definition was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_bundle.DeletedSasDefinitionBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_bundle.DeletedSasDefinitionBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_bundle.DeletedSasDefinitionBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_bundle.DeletedSasDefinitionBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_bundle.DeletedSasDefinitionBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_bundle.DeletedSasDefinitionBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_bundle.DeletedSasDefinitionBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_bundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_bundle.yml new file mode 100644 index 00000000..1ae41676 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_bundle.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_sas_definition_bundle +name: deleted_sas_definition_bundle +fullName: azure.keyvault.v7_0.models.deleted_sas_definition_bundle +classes: +- azure.keyvault.v7_0.models.deleted_sas_definition_bundle.DeletedSasDefinitionBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3.DeletedSasDefinitionBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3.DeletedSasDefinitionBundle.yml new file mode 100644 index 00000000..4c47cf14 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3.DeletedSasDefinitionBundle.yml @@ -0,0 +1,180 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3.DeletedSasDefinitionBundle +name: DeletedSasDefinitionBundle +fullName: azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3.DeletedSasDefinitionBundle +module: azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3 +summary: 'A deleted SAS definition bundle consisting of its previous id, attributes + + and its tags, as well as information on when it will be purged. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedSasDefinitionBundle(*, recovery_id: str = None, **kwargs)' + parameters: + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted SAS definition.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: recovery_id + isRequired: true +variables: +- description: The SAS definition id. + name: id + types: + - +- description: Storage account SAS definition secret id. + name: secret_id + types: + - +- description: 'The SAS definition token template signed with an + + arbitrary key. Tokens created according to the SAS definition will have + + the same properties as the template.' + name: template_uri + types: + - +- description: 'The type of SAS token the SAS definition will create. + + Possible values include: ''account'', ''service''' + name: sas_type + types: + - + - +- description: 'The validity period of SAS tokens created according + + to the SAS definition.' + name: validity_period + types: + - +- description: The SAS definition attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs + name: tags + types: + - [, ] +- description: 'The time when the SAS definition is scheduled + + to be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the SAS definition was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3.DeletedSasDefinitionBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3.DeletedSasDefinitionBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3.DeletedSasDefinitionBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3.DeletedSasDefinitionBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3.DeletedSasDefinitionBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3.DeletedSasDefinitionBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3.DeletedSasDefinitionBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3.yml new file mode 100644 index 00000000..c158bab9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3 +name: deleted_sas_definition_bundle_py3 +fullName: azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3 +classes: +- azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3.DeletedSasDefinitionBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item.DeletedSasDefinitionItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item.DeletedSasDefinitionItem.yml new file mode 100644 index 00000000..3d46c910 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item.DeletedSasDefinitionItem.yml @@ -0,0 +1,156 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_sas_definition_item.DeletedSasDefinitionItem +name: DeletedSasDefinitionItem +fullName: azure.keyvault.v7_0.models.deleted_sas_definition_item.DeletedSasDefinitionItem +module: azure.keyvault.v7_0.models.deleted_sas_definition_item +summary: 'The deleted SAS definition item containing metadata about the deleted SAS + + definition. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: DeletedSasDefinitionItem(**kwargs) + parameters: + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted SAS definition.' + isRequired: true + types: + - +variables: +- description: The storage SAS identifier. + name: id + types: + - +- description: The storage account SAS definition secret id. + name: secret_id + types: + - +- description: The SAS definition management attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs. + name: tags + types: + - [, ] +- description: 'The time when the SAS definition is scheduled + + to be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the SAS definition was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_item.DeletedSasDefinitionItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_item.DeletedSasDefinitionItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_item.DeletedSasDefinitionItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_item.DeletedSasDefinitionItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_item.DeletedSasDefinitionItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_item.DeletedSasDefinitionItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_item.DeletedSasDefinitionItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item.yml new file mode 100644 index 00000000..12a10e16 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_sas_definition_item +name: deleted_sas_definition_item +fullName: azure.keyvault.v7_0.models.deleted_sas_definition_item +classes: +- azure.keyvault.v7_0.models.deleted_sas_definition_item.DeletedSasDefinitionItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item_paged.DeletedSasDefinitionItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item_paged.DeletedSasDefinitionItemPaged.yml new file mode 100644 index 00000000..4646e9c8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item_paged.DeletedSasDefinitionItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_sas_definition_item_paged.DeletedSasDefinitionItemPaged +name: DeletedSasDefinitionItemPaged +fullName: azure.keyvault.v7_0.models.deleted_sas_definition_item_paged.DeletedSasDefinitionItemPaged +module: azure.keyvault.v7_0.models.deleted_sas_definition_item_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: DeletedSasDefinitionItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_item_paged.DeletedSasDefinitionItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_item_paged.DeletedSasDefinitionItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_item_paged.DeletedSasDefinitionItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_item_paged.DeletedSasDefinitionItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_item_paged.DeletedSasDefinitionItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_item_paged.DeletedSasDefinitionItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_item_paged.DeletedSasDefinitionItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item_paged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item_paged.yml new file mode 100644 index 00000000..791b096d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_sas_definition_item_paged +name: deleted_sas_definition_item_paged +fullName: azure.keyvault.v7_0.models.deleted_sas_definition_item_paged +classes: +- azure.keyvault.v7_0.models.deleted_sas_definition_item_paged.DeletedSasDefinitionItemPaged diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item_py3.DeletedSasDefinitionItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item_py3.DeletedSasDefinitionItem.yml new file mode 100644 index 00000000..ba3a6cea --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item_py3.DeletedSasDefinitionItem.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_sas_definition_item_py3.DeletedSasDefinitionItem +name: DeletedSasDefinitionItem +fullName: azure.keyvault.v7_0.models.deleted_sas_definition_item_py3.DeletedSasDefinitionItem +module: azure.keyvault.v7_0.models.deleted_sas_definition_item_py3 +summary: 'The deleted SAS definition item containing metadata about the deleted SAS + + definition. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedSasDefinitionItem(*, recovery_id: str = None, **kwargs)' + parameters: + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted SAS definition.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: recovery_id + isRequired: true +variables: +- description: The storage SAS identifier. + name: id + types: + - +- description: The storage account SAS definition secret id. + name: secret_id + types: + - +- description: The SAS definition management attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs. + name: tags + types: + - [, ] +- description: 'The time when the SAS definition is scheduled + + to be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the SAS definition was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_item_py3.DeletedSasDefinitionItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_item_py3.DeletedSasDefinitionItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_item_py3.DeletedSasDefinitionItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_item_py3.DeletedSasDefinitionItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_item_py3.DeletedSasDefinitionItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_item_py3.DeletedSasDefinitionItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_sas_definition_item_py3.DeletedSasDefinitionItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item_py3.yml new file mode 100644 index 00000000..ac6b5c42 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_sas_definition_item_py3 +name: deleted_sas_definition_item_py3 +fullName: azure.keyvault.v7_0.models.deleted_sas_definition_item_py3 +classes: +- azure.keyvault.v7_0.models.deleted_sas_definition_item_py3.DeletedSasDefinitionItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_bundle.DeletedSecretBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_bundle.DeletedSecretBundle.yml new file mode 100644 index 00000000..74c8c0af --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_bundle.DeletedSecretBundle.yml @@ -0,0 +1,178 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_secret_bundle.DeletedSecretBundle +name: DeletedSecretBundle +fullName: azure.keyvault.v7_0.models.deleted_secret_bundle.DeletedSecretBundle +module: azure.keyvault.v7_0.models.deleted_secret_bundle +summary: 'A Deleted Secret consisting of its previous id, attributes and its tags, + as + + well as information on when it will be purged. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: DeletedSecretBundle(**kwargs) + parameters: + - name: value + description: The secret value. + isRequired: true + types: + - + - name: id + description: The secret id. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted secret.' + isRequired: true + types: + - +variables: +- description: 'If this is a secret backing a KV certificate, then this field + + specifies the corresponding key backing the KV certificate.' + name: kid + types: + - +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a secret backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the secret is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the secret was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.deleted_secret_bundle.DeletedSecretBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_secret_bundle.DeletedSecretBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_secret_bundle.DeletedSecretBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.deleted_secret_bundle.DeletedSecretBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_secret_bundle.DeletedSecretBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.deleted_secret_bundle.DeletedSecretBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_secret_bundle.DeletedSecretBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_bundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_bundle.yml new file mode 100644 index 00000000..5c8f14ed --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_bundle.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_secret_bundle +name: deleted_secret_bundle +fullName: azure.keyvault.v7_0.models.deleted_secret_bundle +classes: +- azure.keyvault.v7_0.models.deleted_secret_bundle.DeletedSecretBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_bundle_py3.DeletedSecretBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_bundle_py3.DeletedSecretBundle.yml new file mode 100644 index 00000000..85f208d8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_bundle_py3.DeletedSecretBundle.yml @@ -0,0 +1,192 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_secret_bundle_py3.DeletedSecretBundle +name: DeletedSecretBundle +fullName: azure.keyvault.v7_0.models.deleted_secret_bundle_py3.DeletedSecretBundle +module: azure.keyvault.v7_0.models.deleted_secret_bundle_py3 +summary: 'A Deleted Secret consisting of its previous id, attributes and its tags, + as + + well as information on when it will be purged. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedSecretBundle(*, value: str = None, id: str = None, content_type: + str = None, attributes=None, tags=None, recovery_id: str = None, **kwargs)' + parameters: + - name: value + description: The secret value. + isRequired: true + types: + - + - name: id + description: The secret id. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted secret.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: id + isRequired: true + - name: content_type + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: 'If this is a secret backing a KV certificate, then this field + + specifies the corresponding key backing the KV certificate.' + name: kid + types: + - +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a secret backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the secret is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the secret was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.deleted_secret_bundle_py3.DeletedSecretBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_secret_bundle_py3.DeletedSecretBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_secret_bundle_py3.DeletedSecretBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.deleted_secret_bundle_py3.DeletedSecretBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_secret_bundle_py3.DeletedSecretBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.deleted_secret_bundle_py3.DeletedSecretBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_secret_bundle_py3.DeletedSecretBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_bundle_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_bundle_py3.yml new file mode 100644 index 00000000..b4000c87 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_bundle_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_secret_bundle_py3 +name: deleted_secret_bundle_py3 +fullName: azure.keyvault.v7_0.models.deleted_secret_bundle_py3 +classes: +- azure.keyvault.v7_0.models.deleted_secret_bundle_py3.DeletedSecretBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item.DeletedSecretItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item.DeletedSecretItem.yml new file mode 100644 index 00000000..e4b0d328 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item.DeletedSecretItem.yml @@ -0,0 +1,164 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_secret_item.DeletedSecretItem +name: DeletedSecretItem +fullName: azure.keyvault.v7_0.models.deleted_secret_item.DeletedSecretItem +module: azure.keyvault.v7_0.models.deleted_secret_item +summary: 'The deleted secret item containing metadata about the deleted secret. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: DeletedSecretItem(**kwargs) + parameters: + - name: id + description: Secret identifier. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted secret.' + isRequired: true + types: + - +variables: +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a key backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the secret is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the secret was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.deleted_secret_item.DeletedSecretItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_secret_item.DeletedSecretItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_secret_item.DeletedSecretItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.deleted_secret_item.DeletedSecretItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_secret_item.DeletedSecretItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.deleted_secret_item.DeletedSecretItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_secret_item.DeletedSecretItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item.yml new file mode 100644 index 00000000..faad6c9f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_secret_item +name: deleted_secret_item +fullName: azure.keyvault.v7_0.models.deleted_secret_item +classes: +- azure.keyvault.v7_0.models.deleted_secret_item.DeletedSecretItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item_paged.DeletedSecretItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item_paged.DeletedSecretItemPaged.yml new file mode 100644 index 00000000..8b8716d2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item_paged.DeletedSecretItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_secret_item_paged.DeletedSecretItemPaged +name: DeletedSecretItemPaged +fullName: azure.keyvault.v7_0.models.deleted_secret_item_paged.DeletedSecretItemPaged +module: azure.keyvault.v7_0.models.deleted_secret_item_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: DeletedSecretItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v7_0.models.deleted_secret_item_paged.DeletedSecretItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v7_0.models.deleted_secret_item_paged.DeletedSecretItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v7_0.models.deleted_secret_item_paged.DeletedSecretItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.deleted_secret_item_paged.DeletedSecretItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.deleted_secret_item_paged.DeletedSecretItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v7_0.models.deleted_secret_item_paged.DeletedSecretItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v7_0.models.deleted_secret_item_paged.DeletedSecretItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item_paged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item_paged.yml new file mode 100644 index 00000000..ec432aef --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_secret_item_paged +name: deleted_secret_item_paged +fullName: azure.keyvault.v7_0.models.deleted_secret_item_paged +classes: +- azure.keyvault.v7_0.models.deleted_secret_item_paged.DeletedSecretItemPaged diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item_py3.DeletedSecretItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item_py3.DeletedSecretItem.yml new file mode 100644 index 00000000..53d7a821 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item_py3.DeletedSecretItem.yml @@ -0,0 +1,176 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_secret_item_py3.DeletedSecretItem +name: DeletedSecretItem +fullName: azure.keyvault.v7_0.models.deleted_secret_item_py3.DeletedSecretItem +module: azure.keyvault.v7_0.models.deleted_secret_item_py3 +summary: 'The deleted secret item containing metadata about the deleted secret. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedSecretItem(*, id: str = None, attributes=None, tags=None, content_type: + str = None, recovery_id: str = None, **kwargs)' + parameters: + - name: id + description: Secret identifier. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted secret.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: content_type + isRequired: true + - name: recovery_id + isRequired: true +variables: +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a key backing a certificate, then managed will be true.' + name: managed + types: + - +- description: 'The time when the secret is scheduled to be + + purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the secret was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.deleted_secret_item_py3.DeletedSecretItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_secret_item_py3.DeletedSecretItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_secret_item_py3.DeletedSecretItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.deleted_secret_item_py3.DeletedSecretItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_secret_item_py3.DeletedSecretItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.deleted_secret_item_py3.DeletedSecretItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_secret_item_py3.DeletedSecretItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item_py3.yml new file mode 100644 index 00000000..ab5d892b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_secret_item_py3 +name: deleted_secret_item_py3 +fullName: azure.keyvault.v7_0.models.deleted_secret_item_py3 +classes: +- azure.keyvault.v7_0.models.deleted_secret_item_py3.DeletedSecretItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item.DeletedStorageAccountItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item.DeletedStorageAccountItem.yml new file mode 100644 index 00000000..933a8441 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item.DeletedStorageAccountItem.yml @@ -0,0 +1,156 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_storage_account_item.DeletedStorageAccountItem +name: DeletedStorageAccountItem +fullName: azure.keyvault.v7_0.models.deleted_storage_account_item.DeletedStorageAccountItem +module: azure.keyvault.v7_0.models.deleted_storage_account_item +summary: 'The deleted storage account item containing metadata about the deleted + + storage account. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: DeletedStorageAccountItem(**kwargs) + parameters: + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted storage account.' + isRequired: true + types: + - +variables: +- description: Storage identifier. + name: id + types: + - +- description: Storage account resource Id. + name: resource_id + types: + - +- description: The storage account management attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs. + name: tags + types: + - [, ] +- description: 'The time when the storage account is scheduled + + to be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the storage account was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.deleted_storage_account_item.DeletedStorageAccountItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_storage_account_item.DeletedStorageAccountItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_storage_account_item.DeletedStorageAccountItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.deleted_storage_account_item.DeletedStorageAccountItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_storage_account_item.DeletedStorageAccountItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.deleted_storage_account_item.DeletedStorageAccountItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_storage_account_item.DeletedStorageAccountItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item.yml new file mode 100644 index 00000000..e6acc19a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_storage_account_item +name: deleted_storage_account_item +fullName: azure.keyvault.v7_0.models.deleted_storage_account_item +classes: +- azure.keyvault.v7_0.models.deleted_storage_account_item.DeletedStorageAccountItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item_paged.DeletedStorageAccountItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item_paged.DeletedStorageAccountItemPaged.yml new file mode 100644 index 00000000..f9b5af92 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item_paged.DeletedStorageAccountItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_storage_account_item_paged.DeletedStorageAccountItemPaged +name: DeletedStorageAccountItemPaged +fullName: azure.keyvault.v7_0.models.deleted_storage_account_item_paged.DeletedStorageAccountItemPaged +module: azure.keyvault.v7_0.models.deleted_storage_account_item_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: DeletedStorageAccountItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v7_0.models.deleted_storage_account_item_paged.DeletedStorageAccountItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v7_0.models.deleted_storage_account_item_paged.DeletedStorageAccountItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v7_0.models.deleted_storage_account_item_paged.DeletedStorageAccountItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.deleted_storage_account_item_paged.DeletedStorageAccountItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.deleted_storage_account_item_paged.DeletedStorageAccountItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v7_0.models.deleted_storage_account_item_paged.DeletedStorageAccountItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v7_0.models.deleted_storage_account_item_paged.DeletedStorageAccountItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item_paged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item_paged.yml new file mode 100644 index 00000000..dd8b9196 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_storage_account_item_paged +name: deleted_storage_account_item_paged +fullName: azure.keyvault.v7_0.models.deleted_storage_account_item_paged +classes: +- azure.keyvault.v7_0.models.deleted_storage_account_item_paged.DeletedStorageAccountItemPaged diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item_py3.DeletedStorageAccountItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item_py3.DeletedStorageAccountItem.yml new file mode 100644 index 00000000..f0aa4b3e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item_py3.DeletedStorageAccountItem.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_storage_account_item_py3.DeletedStorageAccountItem +name: DeletedStorageAccountItem +fullName: azure.keyvault.v7_0.models.deleted_storage_account_item_py3.DeletedStorageAccountItem +module: azure.keyvault.v7_0.models.deleted_storage_account_item_py3 +summary: 'The deleted storage account item containing metadata about the deleted + + storage account. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedStorageAccountItem(*, recovery_id: str = None, **kwargs)' + parameters: + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted storage account.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: recovery_id + isRequired: true +variables: +- description: Storage identifier. + name: id + types: + - +- description: Storage account resource Id. + name: resource_id + types: + - +- description: The storage account management attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs. + name: tags + types: + - [, ] +- description: 'The time when the storage account is scheduled + + to be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the storage account was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.deleted_storage_account_item_py3.DeletedStorageAccountItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_storage_account_item_py3.DeletedStorageAccountItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_storage_account_item_py3.DeletedStorageAccountItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.deleted_storage_account_item_py3.DeletedStorageAccountItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_storage_account_item_py3.DeletedStorageAccountItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.deleted_storage_account_item_py3.DeletedStorageAccountItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_storage_account_item_py3.DeletedStorageAccountItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item_py3.yml new file mode 100644 index 00000000..6121391b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_storage_account_item_py3 +name: deleted_storage_account_item_py3 +fullName: azure.keyvault.v7_0.models.deleted_storage_account_item_py3 +classes: +- azure.keyvault.v7_0.models.deleted_storage_account_item_py3.DeletedStorageAccountItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_bundle.DeletedStorageBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_bundle.DeletedStorageBundle.yml new file mode 100644 index 00000000..c2f244f7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_bundle.DeletedStorageBundle.yml @@ -0,0 +1,172 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_storage_bundle.DeletedStorageBundle +name: DeletedStorageBundle +fullName: azure.keyvault.v7_0.models.deleted_storage_bundle.DeletedStorageBundle +module: azure.keyvault.v7_0.models.deleted_storage_bundle +summary: 'A deleted storage account bundle consisting of its previous id, attributes + + and its tags, as well as information on when it will be purged. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: DeletedStorageBundle(**kwargs) + parameters: + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted storage account.' + isRequired: true + types: + - +variables: +- description: The storage account id. + name: id + types: + - +- description: The storage account resource id. + name: resource_id + types: + - +- description: The current active storage account key name. + name: active_key_name + types: + - +- description: 'whether keyvault should manage the storage + + account for the user.' + name: auto_regenerate_key + types: + - +- description: 'The key regeneration time duration specified in + + ISO-8601 format.' + name: regeneration_period + types: + - +- description: The storage account attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs + name: tags + types: + - [, ] +- description: 'The time when the storage account is scheduled + + to be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the storage account was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.deleted_storage_bundle.DeletedStorageBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_storage_bundle.DeletedStorageBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_storage_bundle.DeletedStorageBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.deleted_storage_bundle.DeletedStorageBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_storage_bundle.DeletedStorageBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.deleted_storage_bundle.DeletedStorageBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_storage_bundle.DeletedStorageBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_bundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_bundle.yml new file mode 100644 index 00000000..be1344cf --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_bundle.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_storage_bundle +name: deleted_storage_bundle +fullName: azure.keyvault.v7_0.models.deleted_storage_bundle +classes: +- azure.keyvault.v7_0.models.deleted_storage_bundle.DeletedStorageBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_bundle_py3.DeletedStorageBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_bundle_py3.DeletedStorageBundle.yml new file mode 100644 index 00000000..c6be3c9f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_bundle_py3.DeletedStorageBundle.yml @@ -0,0 +1,175 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.deleted_storage_bundle_py3.DeletedStorageBundle +name: DeletedStorageBundle +fullName: azure.keyvault.v7_0.models.deleted_storage_bundle_py3.DeletedStorageBundle +module: azure.keyvault.v7_0.models.deleted_storage_bundle_py3 +summary: 'A deleted storage account bundle consisting of its previous id, attributes + + and its tags, as well as information on when it will be purged. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DeletedStorageBundle(*, recovery_id: str = None, **kwargs)' + parameters: + - name: recovery_id + description: 'The url of the recovery object, used to identify and + + recover the deleted storage account.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: recovery_id + isRequired: true +variables: +- description: The storage account id. + name: id + types: + - +- description: The storage account resource id. + name: resource_id + types: + - +- description: The current active storage account key name. + name: active_key_name + types: + - +- description: 'whether keyvault should manage the storage + + account for the user.' + name: auto_regenerate_key + types: + - +- description: 'The key regeneration time duration specified in + + ISO-8601 format.' + name: regeneration_period + types: + - +- description: The storage account attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs + name: tags + types: + - [, ] +- description: 'The time when the storage account is scheduled + + to be purged, in UTC' + name: scheduled_purge_date + types: + - +- description: The time when the storage account was deleted, in UTC + name: deleted_date + types: + - +methods: +- uid: azure.keyvault.v7_0.models.deleted_storage_bundle_py3.DeletedStorageBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_storage_bundle_py3.DeletedStorageBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_storage_bundle_py3.DeletedStorageBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.deleted_storage_bundle_py3.DeletedStorageBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.deleted_storage_bundle_py3.DeletedStorageBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.deleted_storage_bundle_py3.DeletedStorageBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.deleted_storage_bundle_py3.DeletedStorageBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_bundle_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_bundle_py3.yml new file mode 100644 index 00000000..fbfea3f7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_bundle_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.deleted_storage_bundle_py3 +name: deleted_storage_bundle_py3 +fullName: azure.keyvault.v7_0.models.deleted_storage_bundle_py3 +classes: +- azure.keyvault.v7_0.models.deleted_storage_bundle_py3.DeletedStorageBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.error.Error.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.error.Error.yml new file mode 100644 index 00000000..289d541c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.error.Error.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.error.Error +name: Error +fullName: azure.keyvault.v7_0.models.error.Error +module: azure.keyvault.v7_0.models.error +summary: 'The key vault server error. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Error(**kwargs) +variables: +- description: The error code. + name: code + types: + - +- description: The error message. + name: message + types: + - +- name: inner_error + types: + - +methods: +- uid: azure.keyvault.v7_0.models.error.Error.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.error.Error.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.error.Error.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.error.Error.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.error.Error.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.error.Error.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.error.Error.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.error.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.error.yml new file mode 100644 index 00000000..081b4699 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.error.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.error +name: error +fullName: azure.keyvault.v7_0.models.error +classes: +- azure.keyvault.v7_0.models.error.Error diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.error_py3.Error.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.error_py3.Error.yml new file mode 100644 index 00000000..a6aede3c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.error_py3.Error.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.error_py3.Error +name: Error +fullName: azure.keyvault.v7_0.models.error_py3.Error +module: azure.keyvault.v7_0.models.error_py3 +summary: 'The key vault server error. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Error(**kwargs) +variables: +- description: The error code. + name: code + types: + - +- description: The error message. + name: message + types: + - +- name: inner_error + types: + - +methods: +- uid: azure.keyvault.v7_0.models.error_py3.Error.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.error_py3.Error.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.error_py3.Error.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.error_py3.Error.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.error_py3.Error.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.error_py3.Error.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.error_py3.Error.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.error_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.error_py3.yml new file mode 100644 index 00000000..fc8e5c3d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.error_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.error_py3 +name: error_py3 +fullName: azure.keyvault.v7_0.models.error_py3 +classes: +- azure.keyvault.v7_0.models.error_py3.Error diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_attributes.IssuerAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_attributes.IssuerAttributes.yml new file mode 100644 index 00000000..59ee57ab --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_attributes.IssuerAttributes.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.issuer_attributes.IssuerAttributes +name: IssuerAttributes +fullName: azure.keyvault.v7_0.models.issuer_attributes.IssuerAttributes +module: azure.keyvault.v7_0.models.issuer_attributes +summary: 'The attributes of an issuer managed by the Key Vault service. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: IssuerAttributes(**kwargs) + parameters: + - name: enabled + description: Determines whether the issuer is enabled. + isRequired: true + types: + - +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +methods: +- uid: azure.keyvault.v7_0.models.issuer_attributes.IssuerAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.issuer_attributes.IssuerAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.issuer_attributes.IssuerAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.issuer_attributes.IssuerAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.issuer_attributes.IssuerAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.issuer_attributes.IssuerAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.issuer_attributes.IssuerAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_attributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_attributes.yml new file mode 100644 index 00000000..f43a5696 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_attributes.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.issuer_attributes +name: issuer_attributes +fullName: azure.keyvault.v7_0.models.issuer_attributes +classes: +- azure.keyvault.v7_0.models.issuer_attributes.IssuerAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_attributes_py3.IssuerAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_attributes_py3.IssuerAttributes.yml new file mode 100644 index 00000000..9beb7d56 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_attributes_py3.IssuerAttributes.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.issuer_attributes_py3.IssuerAttributes +name: IssuerAttributes +fullName: azure.keyvault.v7_0.models.issuer_attributes_py3.IssuerAttributes +module: azure.keyvault.v7_0.models.issuer_attributes_py3 +summary: 'The attributes of an issuer managed by the Key Vault service. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'IssuerAttributes(*, enabled: bool = None, **kwargs)' + parameters: + - name: enabled + description: Determines whether the issuer is enabled. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +methods: +- uid: azure.keyvault.v7_0.models.issuer_attributes_py3.IssuerAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.issuer_attributes_py3.IssuerAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.issuer_attributes_py3.IssuerAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.issuer_attributes_py3.IssuerAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.issuer_attributes_py3.IssuerAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.issuer_attributes_py3.IssuerAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.issuer_attributes_py3.IssuerAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_attributes_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_attributes_py3.yml new file mode 100644 index 00000000..473d4588 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_attributes_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.issuer_attributes_py3 +name: issuer_attributes_py3 +fullName: azure.keyvault.v7_0.models.issuer_attributes_py3 +classes: +- azure.keyvault.v7_0.models.issuer_attributes_py3.IssuerAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_bundle.IssuerBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_bundle.IssuerBundle.yml new file mode 100644 index 00000000..70cdb13a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_bundle.IssuerBundle.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.issuer_bundle.IssuerBundle +name: IssuerBundle +fullName: azure.keyvault.v7_0.models.issuer_bundle.IssuerBundle +module: azure.keyvault.v7_0.models.issuer_bundle +summary: 'The issuer for Key Vault certificate. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: IssuerBundle(**kwargs) + parameters: + - name: provider + description: The issuer provider. + isRequired: true + types: + - + - name: credentials + description: The credentials to be used for the issuer. + isRequired: true + types: + - + - name: organization_details + description: 'Details of the organization as provided to + + the issuer.' + isRequired: true + types: + - + - name: attributes + description: Attributes of the issuer object. + isRequired: true + types: + - +variables: +- description: Identifier for the issuer object. + name: id + types: + - +methods: +- uid: azure.keyvault.v7_0.models.issuer_bundle.IssuerBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.issuer_bundle.IssuerBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.issuer_bundle.IssuerBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.issuer_bundle.IssuerBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.issuer_bundle.IssuerBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.issuer_bundle.IssuerBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.issuer_bundle.IssuerBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_bundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_bundle.yml new file mode 100644 index 00000000..3e6e7fa6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_bundle.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.issuer_bundle +name: issuer_bundle +fullName: azure.keyvault.v7_0.models.issuer_bundle +classes: +- azure.keyvault.v7_0.models.issuer_bundle.IssuerBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_bundle_py3.IssuerBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_bundle_py3.IssuerBundle.yml new file mode 100644 index 00000000..b87e0bb7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_bundle_py3.IssuerBundle.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.issuer_bundle_py3.IssuerBundle +name: IssuerBundle +fullName: azure.keyvault.v7_0.models.issuer_bundle_py3.IssuerBundle +module: azure.keyvault.v7_0.models.issuer_bundle_py3 +summary: 'The issuer for Key Vault certificate. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'IssuerBundle(*, provider: str = None, credentials=None, organization_details=None, + attributes=None, **kwargs)' + parameters: + - name: provider + description: The issuer provider. + isRequired: true + types: + - + - name: credentials + description: The credentials to be used for the issuer. + isRequired: true + types: + - + - name: organization_details + description: 'Details of the organization as provided to + + the issuer.' + isRequired: true + types: + - + - name: attributes + description: Attributes of the issuer object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: provider + isRequired: true + - name: credentials + isRequired: true + - name: organization_details + isRequired: true + - name: attributes + isRequired: true +variables: +- description: Identifier for the issuer object. + name: id + types: + - +methods: +- uid: azure.keyvault.v7_0.models.issuer_bundle_py3.IssuerBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.issuer_bundle_py3.IssuerBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.issuer_bundle_py3.IssuerBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.issuer_bundle_py3.IssuerBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.issuer_bundle_py3.IssuerBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.issuer_bundle_py3.IssuerBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.issuer_bundle_py3.IssuerBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_bundle_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_bundle_py3.yml new file mode 100644 index 00000000..d6d8f94a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_bundle_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.issuer_bundle_py3 +name: issuer_bundle_py3 +fullName: azure.keyvault.v7_0.models.issuer_bundle_py3 +classes: +- azure.keyvault.v7_0.models.issuer_bundle_py3.IssuerBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_credentials.IssuerCredentials.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_credentials.IssuerCredentials.yml new file mode 100644 index 00000000..253459cf --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_credentials.IssuerCredentials.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.issuer_credentials.IssuerCredentials +name: IssuerCredentials +fullName: azure.keyvault.v7_0.models.issuer_credentials.IssuerCredentials +module: azure.keyvault.v7_0.models.issuer_credentials +summary: The credentials to be used for the certificate issuer. +constructor: + syntax: IssuerCredentials(**kwargs) + parameters: + - name: account_id + description: The user name/account name/account id. + isRequired: true + types: + - + - name: password + description: The password/secret/account key. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.models.issuer_credentials.IssuerCredentials.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.issuer_credentials.IssuerCredentials.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.issuer_credentials.IssuerCredentials.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.issuer_credentials.IssuerCredentials.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.issuer_credentials.IssuerCredentials.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.issuer_credentials.IssuerCredentials.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.issuer_credentials.IssuerCredentials.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_credentials.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_credentials.yml new file mode 100644 index 00000000..1f66fb12 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_credentials.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.issuer_credentials +name: issuer_credentials +fullName: azure.keyvault.v7_0.models.issuer_credentials +classes: +- azure.keyvault.v7_0.models.issuer_credentials.IssuerCredentials diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_credentials_py3.IssuerCredentials.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_credentials_py3.IssuerCredentials.yml new file mode 100644 index 00000000..7c5db135 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_credentials_py3.IssuerCredentials.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.issuer_credentials_py3.IssuerCredentials +name: IssuerCredentials +fullName: azure.keyvault.v7_0.models.issuer_credentials_py3.IssuerCredentials +module: azure.keyvault.v7_0.models.issuer_credentials_py3 +summary: The credentials to be used for the certificate issuer. +constructor: + syntax: 'IssuerCredentials(*, account_id: str = None, password: str = None, **kwargs)' + parameters: + - name: account_id + description: The user name/account name/account id. + isRequired: true + types: + - + - name: password + description: The password/secret/account key. + isRequired: true + types: + - + keywordOnlyParameters: + - name: account_id + isRequired: true + - name: password + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.issuer_credentials_py3.IssuerCredentials.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.issuer_credentials_py3.IssuerCredentials.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.issuer_credentials_py3.IssuerCredentials.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.issuer_credentials_py3.IssuerCredentials.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.issuer_credentials_py3.IssuerCredentials.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.issuer_credentials_py3.IssuerCredentials.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.issuer_credentials_py3.IssuerCredentials.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_credentials_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_credentials_py3.yml new file mode 100644 index 00000000..10d53738 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_credentials_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.issuer_credentials_py3 +name: issuer_credentials_py3 +fullName: azure.keyvault.v7_0.models.issuer_credentials_py3 +classes: +- azure.keyvault.v7_0.models.issuer_credentials_py3.IssuerCredentials diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_parameters.IssuerParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_parameters.IssuerParameters.yml new file mode 100644 index 00000000..21362040 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_parameters.IssuerParameters.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.issuer_parameters.IssuerParameters +name: IssuerParameters +fullName: azure.keyvault.v7_0.models.issuer_parameters.IssuerParameters +module: azure.keyvault.v7_0.models.issuer_parameters +summary: Parameters for the issuer of the X509 component of a certificate. +constructor: + syntax: IssuerParameters(**kwargs) + parameters: + - name: name + description: 'Name of the referenced issuer object or reserved names; for + + example, ''Self'' or ''Unknown''.' + isRequired: true + types: + - + - name: certificate_type + description: 'Type of certificate to be requested from the + + issuer provider.' + isRequired: true + types: + - + - name: certificate_transparency + description: 'Indicates if the certificates generated + + under this policy should be published to certificate transparency logs.' + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.models.issuer_parameters.IssuerParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.issuer_parameters.IssuerParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.issuer_parameters.IssuerParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.issuer_parameters.IssuerParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.issuer_parameters.IssuerParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.issuer_parameters.IssuerParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.issuer_parameters.IssuerParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_parameters.yml new file mode 100644 index 00000000..3e7658e2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.issuer_parameters +name: issuer_parameters +fullName: azure.keyvault.v7_0.models.issuer_parameters +classes: +- azure.keyvault.v7_0.models.issuer_parameters.IssuerParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_parameters_py3.IssuerParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_parameters_py3.IssuerParameters.yml new file mode 100644 index 00000000..831913b7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_parameters_py3.IssuerParameters.yml @@ -0,0 +1,144 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.issuer_parameters_py3.IssuerParameters +name: IssuerParameters +fullName: azure.keyvault.v7_0.models.issuer_parameters_py3.IssuerParameters +module: azure.keyvault.v7_0.models.issuer_parameters_py3 +summary: Parameters for the issuer of the X509 component of a certificate. +constructor: + syntax: 'IssuerParameters(*, name: str = None, certificate_type: str = None, certificate_transparency: + bool = None, **kwargs)' + parameters: + - name: name + description: 'Name of the referenced issuer object or reserved names; for + + example, ''Self'' or ''Unknown''.' + isRequired: true + types: + - + - name: certificate_type + description: 'Type of certificate to be requested from the + + issuer provider.' + isRequired: true + types: + - + - name: certificate_transparency + description: 'Indicates if the certificates generated + + under this policy should be published to certificate transparency logs.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: certificate_type + isRequired: true + - name: certificate_transparency + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.issuer_parameters_py3.IssuerParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.issuer_parameters_py3.IssuerParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.issuer_parameters_py3.IssuerParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.issuer_parameters_py3.IssuerParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.issuer_parameters_py3.IssuerParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.issuer_parameters_py3.IssuerParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.issuer_parameters_py3.IssuerParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_parameters_py3.yml new file mode 100644 index 00000000..10774154 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.issuer_parameters_py3 +name: issuer_parameters_py3 +fullName: azure.keyvault.v7_0.models.issuer_parameters_py3 +classes: +- azure.keyvault.v7_0.models.issuer_parameters_py3.IssuerParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.json_web_key.JsonWebKey.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.json_web_key.JsonWebKey.yml new file mode 100644 index 00000000..8ef39fdb --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.json_web_key.JsonWebKey.yml @@ -0,0 +1,204 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.json_web_key.JsonWebKey +name: JsonWebKey +fullName: azure.keyvault.v7_0.models.json_web_key.JsonWebKey +module: azure.keyvault.v7_0.models.json_web_key +summary: As of [http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18](http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18). +constructor: + syntax: JsonWebKey(**kwargs) + parameters: + - name: kid + description: Key identifier. + isRequired: true + types: + - + - name: kty + description: 'JsonWebKey Key Type (kty), as defined in + + [https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40](https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40). + + Possible values include: ''EC'', ''EC-HSM'', ''RSA'', ''RSA-HSM'', ''oct''' + isRequired: true + types: + - + - + - name: key_ops + isRequired: true + types: + - [] + - name: n + description: RSA modulus. + isRequired: true + types: + - + - name: e + description: RSA public exponent. + isRequired: true + types: + - + - name: d + description: RSA private exponent, or the D component of an EC private key. + isRequired: true + types: + - + - name: dp + description: RSA private key parameter. + isRequired: true + types: + - + - name: dq + description: RSA private key parameter. + isRequired: true + types: + - + - name: qi + description: RSA private key parameter. + isRequired: true + types: + - + - name: p + description: RSA secret prime. + isRequired: true + types: + - + - name: q + description: RSA secret prime, with p < q. + isRequired: true + types: + - + - name: k + description: Symmetric key. + isRequired: true + types: + - + - name: t + description: HSM Token, used with 'Bring Your Own Key'. + isRequired: true + types: + - + - name: crv + description: 'Elliptic curve name. For valid values, see + + JsonWebKeyCurveName. Possible values include: ''P-256'', ''P-384'', ''P-521'', + + ''P-256K''' + isRequired: true + types: + - + - + - name: x + description: X component of an EC public key. + isRequired: true + types: + - + - name: y + description: Y component of an EC public key. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.models.json_web_key.JsonWebKey.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.json_web_key.JsonWebKey.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.json_web_key.JsonWebKey.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.json_web_key.JsonWebKey.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.json_web_key.JsonWebKey.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.json_web_key.JsonWebKey.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.json_web_key.JsonWebKey.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.json_web_key.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.json_web_key.yml new file mode 100644 index 00000000..18826a61 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.json_web_key.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.json_web_key +name: json_web_key +fullName: azure.keyvault.v7_0.models.json_web_key +classes: +- azure.keyvault.v7_0.models.json_web_key.JsonWebKey diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.json_web_key_py3.JsonWebKey.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.json_web_key_py3.JsonWebKey.yml new file mode 100644 index 00000000..7aadda6a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.json_web_key_py3.JsonWebKey.yml @@ -0,0 +1,240 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.json_web_key_py3.JsonWebKey +name: JsonWebKey +fullName: azure.keyvault.v7_0.models.json_web_key_py3.JsonWebKey +module: azure.keyvault.v7_0.models.json_web_key_py3 +summary: As of [http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18](http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18). +constructor: + syntax: 'JsonWebKey(*, kid: str = None, kty=None, key_ops=None, n: bytes = None, + e: bytes = None, d: bytes = None, dp: bytes = None, dq: bytes = None, qi: bytes + = None, p: bytes = None, q: bytes = None, k: bytes = None, t: bytes = None, crv=None, + x: bytes = None, y: bytes = None, **kwargs)' + parameters: + - name: kid + description: Key identifier. + isRequired: true + types: + - + - name: kty + description: 'JsonWebKey Key Type (kty), as defined in + + [https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40](https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40). + + Possible values include: ''EC'', ''EC-HSM'', ''RSA'', ''RSA-HSM'', ''oct''' + isRequired: true + types: + - + - + - name: key_ops + isRequired: true + types: + - [] + - name: n + description: RSA modulus. + isRequired: true + types: + - + - name: e + description: RSA public exponent. + isRequired: true + types: + - + - name: d + description: RSA private exponent, or the D component of an EC private key. + isRequired: true + types: + - + - name: dp + description: RSA private key parameter. + isRequired: true + types: + - + - name: dq + description: RSA private key parameter. + isRequired: true + types: + - + - name: qi + description: RSA private key parameter. + isRequired: true + types: + - + - name: p + description: RSA secret prime. + isRequired: true + types: + - + - name: q + description: RSA secret prime, with p < q. + isRequired: true + types: + - + - name: k + description: Symmetric key. + isRequired: true + types: + - + - name: t + description: HSM Token, used with 'Bring Your Own Key'. + isRequired: true + types: + - + - name: crv + description: 'Elliptic curve name. For valid values, see + + JsonWebKeyCurveName. Possible values include: ''P-256'', ''P-384'', ''P-521'', + + ''P-256K''' + isRequired: true + types: + - + - + - name: x + description: X component of an EC public key. + isRequired: true + types: + - + - name: y + description: Y component of an EC public key. + isRequired: true + types: + - + keywordOnlyParameters: + - name: kid + isRequired: true + - name: kty + isRequired: true + - name: key_ops + isRequired: true + - name: n + isRequired: true + - name: e + isRequired: true + - name: d + isRequired: true + - name: dp + isRequired: true + - name: dq + isRequired: true + - name: qi + isRequired: true + - name: p + isRequired: true + - name: q + isRequired: true + - name: k + isRequired: true + - name: t + isRequired: true + - name: crv + isRequired: true + - name: x + isRequired: true + - name: y + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.json_web_key_py3.JsonWebKey.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.json_web_key_py3.JsonWebKey.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.json_web_key_py3.JsonWebKey.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.json_web_key_py3.JsonWebKey.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.json_web_key_py3.JsonWebKey.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.json_web_key_py3.JsonWebKey.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.json_web_key_py3.JsonWebKey.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.json_web_key_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.json_web_key_py3.yml new file mode 100644 index 00000000..39a653aa --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.json_web_key_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.json_web_key_py3 +name: json_web_key_py3 +fullName: azure.keyvault.v7_0.models.json_web_key_py3 +classes: +- azure.keyvault.v7_0.models.json_web_key_py3.JsonWebKey diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_attributes.KeyAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_attributes.KeyAttributes.yml new file mode 100644 index 00000000..718e2544 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_attributes.KeyAttributes.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_attributes.KeyAttributes +name: KeyAttributes +fullName: azure.keyvault.v7_0.models.key_attributes.KeyAttributes +module: azure.keyvault.v7_0.models.key_attributes +summary: 'The attributes of a key managed by the key vault service. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyAttributes(**kwargs) + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for keys in the current vault. If it contains ''Purgeable'' the key + + can be permanently deleted by a privileged user; otherwise, only the + + system can purge the key, at the end of the retention interval. Possible + + values include: ''Purgeable'', ''Recoverable+Purgeable'', ''Recoverable'', + + ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v7_0.models.key_attributes.KeyAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_attributes.KeyAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_attributes.KeyAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_attributes.KeyAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_attributes.KeyAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_attributes.KeyAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_attributes.KeyAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_attributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_attributes.yml new file mode 100644 index 00000000..444989a5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_attributes.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_attributes +name: key_attributes +fullName: azure.keyvault.v7_0.models.key_attributes +classes: +- azure.keyvault.v7_0.models.key_attributes.KeyAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_attributes_py3.KeyAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_attributes_py3.KeyAttributes.yml new file mode 100644 index 00000000..a6beadc1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_attributes_py3.KeyAttributes.yml @@ -0,0 +1,166 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_attributes_py3.KeyAttributes +name: KeyAttributes +fullName: azure.keyvault.v7_0.models.key_attributes_py3.KeyAttributes +module: azure.keyvault.v7_0.models.key_attributes_py3 +summary: 'The attributes of a key managed by the key vault service. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'KeyAttributes(*, enabled: bool = None, not_before=None, expires=None, **kwargs)' + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true + - name: not_before + isRequired: true + - name: expires + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for keys in the current vault. If it contains ''Purgeable'' the key + + can be permanently deleted by a privileged user; otherwise, only the + + system can purge the key, at the end of the retention interval. Possible + + values include: ''Purgeable'', ''Recoverable+Purgeable'', ''Recoverable'', + + ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v7_0.models.key_attributes_py3.KeyAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_attributes_py3.KeyAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_attributes_py3.KeyAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_attributes_py3.KeyAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_attributes_py3.KeyAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_attributes_py3.KeyAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_attributes_py3.KeyAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_attributes_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_attributes_py3.yml new file mode 100644 index 00000000..ae4f19ab --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_attributes_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_attributes_py3 +name: key_attributes_py3 +fullName: azure.keyvault.v7_0.models.key_attributes_py3 +classes: +- azure.keyvault.v7_0.models.key_attributes_py3.KeyAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_bundle.KeyBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_bundle.KeyBundle.yml new file mode 100644 index 00000000..7d078203 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_bundle.KeyBundle.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_bundle.KeyBundle +name: KeyBundle +fullName: azure.keyvault.v7_0.models.key_bundle.KeyBundle +module: azure.keyvault.v7_0.models.key_bundle +summary: 'A KeyBundle consisting of a WebKey plus its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyBundle(**kwargs) + parameters: + - name: key + description: The Json web key. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v7_0.models.key_bundle.KeyBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_bundle.KeyBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_bundle.KeyBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_bundle.KeyBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_bundle.KeyBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_bundle.KeyBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_bundle.KeyBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_bundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_bundle.yml new file mode 100644 index 00000000..1a8e1720 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_bundle.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_bundle +name: key_bundle +fullName: azure.keyvault.v7_0.models.key_bundle +classes: +- azure.keyvault.v7_0.models.key_bundle.KeyBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_bundle_py3.KeyBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_bundle_py3.KeyBundle.yml new file mode 100644 index 00000000..589ce624 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_bundle_py3.KeyBundle.yml @@ -0,0 +1,149 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_bundle_py3.KeyBundle +name: KeyBundle +fullName: azure.keyvault.v7_0.models.key_bundle_py3.KeyBundle +module: azure.keyvault.v7_0.models.key_bundle_py3 +summary: 'A KeyBundle consisting of a WebKey plus its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyBundle(*, key=None, attributes=None, tags=None, **kwargs) + parameters: + - name: key + description: The Json web key. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: key + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v7_0.models.key_bundle_py3.KeyBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_bundle_py3.KeyBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_bundle_py3.KeyBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_bundle_py3.KeyBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_bundle_py3.KeyBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_bundle_py3.KeyBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_bundle_py3.KeyBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_bundle_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_bundle_py3.yml new file mode 100644 index 00000000..e8ec4289 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_bundle_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_bundle_py3 +name: key_bundle_py3 +fullName: azure.keyvault.v7_0.models.key_bundle_py3 +classes: +- azure.keyvault.v7_0.models.key_bundle_py3.KeyBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_create_parameters.KeyCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_create_parameters.KeyCreateParameters.yml new file mode 100644 index 00000000..b43f8a88 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_create_parameters.KeyCreateParameters.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_create_parameters.KeyCreateParameters +name: KeyCreateParameters +fullName: azure.keyvault.v7_0.models.key_create_parameters.KeyCreateParameters +module: azure.keyvault.v7_0.models.key_create_parameters +summary: 'The key create parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: KeyCreateParameters(**kwargs) + parameters: + - name: kty + description: 'Required. The type of key to create. For valid values, see + + JsonWebKeyType. Possible values include: ''EC'', ''EC-HSM'', ''RSA'', ''RSA-HSM'', + + ''oct''' + isRequired: true + types: + - + - + - name: key_size + description: 'The key size in bits. For example: 2048, 3072, or 4096 + + for RSA.' + isRequired: true + types: + - + - name: key_ops + isRequired: true + types: + - [ + - ] + - name: key_attributes + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: curve + description: 'Elliptic curve name. For valid values, see + + JsonWebKeyCurveName. Possible values include: ''P-256'', ''P-384'', ''P-521'', + + ''P-256K''' + isRequired: true + types: + - + - +methods: +- uid: azure.keyvault.v7_0.models.key_create_parameters.KeyCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_create_parameters.KeyCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_create_parameters.KeyCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_create_parameters.KeyCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_create_parameters.KeyCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_create_parameters.KeyCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_create_parameters.KeyCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_create_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_create_parameters.yml new file mode 100644 index 00000000..0fb391c3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_create_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_create_parameters +name: key_create_parameters +fullName: azure.keyvault.v7_0.models.key_create_parameters +classes: +- azure.keyvault.v7_0.models.key_create_parameters.KeyCreateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_create_parameters_py3.KeyCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_create_parameters_py3.KeyCreateParameters.yml new file mode 100644 index 00000000..498bf156 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_create_parameters_py3.KeyCreateParameters.yml @@ -0,0 +1,173 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_create_parameters_py3.KeyCreateParameters +name: KeyCreateParameters +fullName: azure.keyvault.v7_0.models.key_create_parameters_py3.KeyCreateParameters +module: azure.keyvault.v7_0.models.key_create_parameters_py3 +summary: 'The key create parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeyCreateParameters(*, kty, key_size: int = None, key_ops=None, key_attributes=None, + tags=None, curve=None, **kwargs)' + parameters: + - name: kty + description: 'Required. The type of key to create. For valid values, see + + JsonWebKeyType. Possible values include: ''EC'', ''EC-HSM'', ''RSA'', ''RSA-HSM'', + + ''oct''' + isRequired: true + types: + - + - + - name: key_size + description: 'The key size in bits. For example: 2048, 3072, or 4096 + + for RSA.' + isRequired: true + types: + - + - name: key_ops + isRequired: true + types: + - [ + - ] + - name: key_attributes + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: curve + description: 'Elliptic curve name. For valid values, see + + JsonWebKeyCurveName. Possible values include: ''P-256'', ''P-384'', ''P-521'', + + ''P-256K''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: kty + isRequired: true + - name: key_size + isRequired: true + - name: key_ops + isRequired: true + - name: key_attributes + isRequired: true + - name: tags + isRequired: true + - name: curve + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.key_create_parameters_py3.KeyCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_create_parameters_py3.KeyCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_create_parameters_py3.KeyCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_create_parameters_py3.KeyCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_create_parameters_py3.KeyCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_create_parameters_py3.KeyCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_create_parameters_py3.KeyCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_create_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_create_parameters_py3.yml new file mode 100644 index 00000000..13300022 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_create_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_create_parameters_py3 +name: key_create_parameters_py3 +fullName: azure.keyvault.v7_0.models.key_create_parameters_py3 +classes: +- azure.keyvault.v7_0.models.key_create_parameters_py3.KeyCreateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_import_parameters.KeyImportParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_import_parameters.KeyImportParameters.yml new file mode 100644 index 00000000..d83a9c82 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_import_parameters.KeyImportParameters.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_import_parameters.KeyImportParameters +name: KeyImportParameters +fullName: azure.keyvault.v7_0.models.key_import_parameters.KeyImportParameters +module: azure.keyvault.v7_0.models.key_import_parameters +summary: 'The key import parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: KeyImportParameters(**kwargs) + parameters: + - name: hsm + description: Whether to import as a hardware key (HSM) or software key. + isRequired: true + types: + - + - name: key + description: Required. The Json web key + isRequired: true + types: + - + - name: key_attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +methods: +- uid: azure.keyvault.v7_0.models.key_import_parameters.KeyImportParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_import_parameters.KeyImportParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_import_parameters.KeyImportParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_import_parameters.KeyImportParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_import_parameters.KeyImportParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_import_parameters.KeyImportParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_import_parameters.KeyImportParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_import_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_import_parameters.yml new file mode 100644 index 00000000..dae7544e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_import_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_import_parameters +name: key_import_parameters +fullName: azure.keyvault.v7_0.models.key_import_parameters +classes: +- azure.keyvault.v7_0.models.key_import_parameters.KeyImportParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_import_parameters_py3.KeyImportParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_import_parameters_py3.KeyImportParameters.yml new file mode 100644 index 00000000..7ee55878 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_import_parameters_py3.KeyImportParameters.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_import_parameters_py3.KeyImportParameters +name: KeyImportParameters +fullName: azure.keyvault.v7_0.models.key_import_parameters_py3.KeyImportParameters +module: azure.keyvault.v7_0.models.key_import_parameters_py3 +summary: 'The key import parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeyImportParameters(*, key, hsm: bool = None, key_attributes=None, tags=None, + **kwargs)' + parameters: + - name: hsm + description: Whether to import as a hardware key (HSM) or software key. + isRequired: true + types: + - + - name: key + description: Required. The Json web key + isRequired: true + types: + - + - name: key_attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: key + isRequired: true + - name: hsm + isRequired: true + - name: key_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.key_import_parameters_py3.KeyImportParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_import_parameters_py3.KeyImportParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_import_parameters_py3.KeyImportParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_import_parameters_py3.KeyImportParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_import_parameters_py3.KeyImportParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_import_parameters_py3.KeyImportParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_import_parameters_py3.KeyImportParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_import_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_import_parameters_py3.yml new file mode 100644 index 00000000..8e87536b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_import_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_import_parameters_py3 +name: key_import_parameters_py3 +fullName: azure.keyvault.v7_0.models.key_import_parameters_py3 +classes: +- azure.keyvault.v7_0.models.key_import_parameters_py3.KeyImportParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item.KeyItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item.KeyItem.yml new file mode 100644 index 00000000..3170d5a4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item.KeyItem.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_item.KeyItem +name: KeyItem +fullName: azure.keyvault.v7_0.models.key_item.KeyItem +module: azure.keyvault.v7_0.models.key_item +summary: 'The key item containing key metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyItem(**kwargs) + parameters: + - name: kid + description: Key identifier. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v7_0.models.key_item.KeyItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_item.KeyItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_item.KeyItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_item.KeyItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_item.KeyItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_item.KeyItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_item.KeyItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item.yml new file mode 100644 index 00000000..c2971bf4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_item +name: key_item +fullName: azure.keyvault.v7_0.models.key_item +classes: +- azure.keyvault.v7_0.models.key_item.KeyItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item_paged.KeyItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item_paged.KeyItemPaged.yml new file mode 100644 index 00000000..1151edd5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item_paged.KeyItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_item_paged.KeyItemPaged +name: KeyItemPaged +fullName: azure.keyvault.v7_0.models.key_item_paged.KeyItemPaged +module: azure.keyvault.v7_0.models.key_item_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: KeyItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v7_0.models.key_item_paged.KeyItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v7_0.models.key_item_paged.KeyItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v7_0.models.key_item_paged.KeyItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.key_item_paged.KeyItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.key_item_paged.KeyItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v7_0.models.key_item_paged.KeyItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v7_0.models.key_item_paged.KeyItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item_paged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item_paged.yml new file mode 100644 index 00000000..1badf0a9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_item_paged +name: key_item_paged +fullName: azure.keyvault.v7_0.models.key_item_paged +classes: +- azure.keyvault.v7_0.models.key_item_paged.KeyItemPaged diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item_py3.KeyItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item_py3.KeyItem.yml new file mode 100644 index 00000000..49bb540c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item_py3.KeyItem.yml @@ -0,0 +1,149 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_item_py3.KeyItem +name: KeyItem +fullName: azure.keyvault.v7_0.models.key_item_py3.KeyItem +module: azure.keyvault.v7_0.models.key_item_py3 +summary: 'The key item containing key metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'KeyItem(*, kid: str = None, attributes=None, tags=None, **kwargs)' + parameters: + - name: kid + description: Key identifier. + isRequired: true + types: + - + - name: attributes + description: The key management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: kid + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true +variables: +- description: 'True if the key''s lifetime is managed by key vault. If this + + is a key backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v7_0.models.key_item_py3.KeyItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_item_py3.KeyItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_item_py3.KeyItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_item_py3.KeyItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_item_py3.KeyItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_item_py3.KeyItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_item_py3.KeyItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item_py3.yml new file mode 100644 index 00000000..520ecccc --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_item_py3 +name: key_item_py3 +fullName: azure.keyvault.v7_0.models.key_item_py3 +classes: +- azure.keyvault.v7_0.models.key_item_py3.KeyItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operation_result.KeyOperationResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operation_result.KeyOperationResult.yml new file mode 100644 index 00000000..1d3a948f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operation_result.KeyOperationResult.yml @@ -0,0 +1,127 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_operation_result.KeyOperationResult +name: KeyOperationResult +fullName: azure.keyvault.v7_0.models.key_operation_result.KeyOperationResult +module: azure.keyvault.v7_0.models.key_operation_result +summary: 'The key operation result. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyOperationResult(**kwargs) +variables: +- description: Key identifier + name: kid + types: + - +- name: result + types: + - +methods: +- uid: azure.keyvault.v7_0.models.key_operation_result.KeyOperationResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_operation_result.KeyOperationResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_operation_result.KeyOperationResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_operation_result.KeyOperationResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_operation_result.KeyOperationResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_operation_result.KeyOperationResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_operation_result.KeyOperationResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operation_result.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operation_result.yml new file mode 100644 index 00000000..56693372 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operation_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_operation_result +name: key_operation_result +fullName: azure.keyvault.v7_0.models.key_operation_result +classes: +- azure.keyvault.v7_0.models.key_operation_result.KeyOperationResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operation_result_py3.KeyOperationResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operation_result_py3.KeyOperationResult.yml new file mode 100644 index 00000000..999e2341 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operation_result_py3.KeyOperationResult.yml @@ -0,0 +1,127 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_operation_result_py3.KeyOperationResult +name: KeyOperationResult +fullName: azure.keyvault.v7_0.models.key_operation_result_py3.KeyOperationResult +module: azure.keyvault.v7_0.models.key_operation_result_py3 +summary: 'The key operation result. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyOperationResult(**kwargs) +variables: +- description: Key identifier + name: kid + types: + - +- name: result + types: + - +methods: +- uid: azure.keyvault.v7_0.models.key_operation_result_py3.KeyOperationResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_operation_result_py3.KeyOperationResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_operation_result_py3.KeyOperationResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_operation_result_py3.KeyOperationResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_operation_result_py3.KeyOperationResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_operation_result_py3.KeyOperationResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_operation_result_py3.KeyOperationResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operation_result_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operation_result_py3.yml new file mode 100644 index 00000000..7111b8b3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operation_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_operation_result_py3 +name: key_operation_result_py3 +fullName: azure.keyvault.v7_0.models.key_operation_result_py3 +classes: +- azure.keyvault.v7_0.models.key_operation_result_py3.KeyOperationResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operations_parameters.KeyOperationsParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operations_parameters.KeyOperationsParameters.yml new file mode 100644 index 00000000..f8b732b8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operations_parameters.KeyOperationsParameters.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_operations_parameters.KeyOperationsParameters +name: KeyOperationsParameters +fullName: azure.keyvault.v7_0.models.key_operations_parameters.KeyOperationsParameters +module: azure.keyvault.v7_0.models.key_operations_parameters +summary: 'The key operations parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: KeyOperationsParameters(**kwargs) + parameters: + - name: algorithm + description: 'Required. algorithm identifier. Possible values include: + + ''RSA-OAEP'', ''RSA-OAEP-256'', ''RSA1_5''' + isRequired: true + types: + - + - + - name: value + description: Required. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.models.key_operations_parameters.KeyOperationsParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_operations_parameters.KeyOperationsParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_operations_parameters.KeyOperationsParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_operations_parameters.KeyOperationsParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_operations_parameters.KeyOperationsParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_operations_parameters.KeyOperationsParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_operations_parameters.KeyOperationsParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operations_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operations_parameters.yml new file mode 100644 index 00000000..124debc4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operations_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_operations_parameters +name: key_operations_parameters +fullName: azure.keyvault.v7_0.models.key_operations_parameters +classes: +- azure.keyvault.v7_0.models.key_operations_parameters.KeyOperationsParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operations_parameters_py3.KeyOperationsParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operations_parameters_py3.KeyOperationsParameters.yml new file mode 100644 index 00000000..95506baf --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operations_parameters_py3.KeyOperationsParameters.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_operations_parameters_py3.KeyOperationsParameters +name: KeyOperationsParameters +fullName: azure.keyvault.v7_0.models.key_operations_parameters_py3.KeyOperationsParameters +module: azure.keyvault.v7_0.models.key_operations_parameters_py3 +summary: 'The key operations parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeyOperationsParameters(*, algorithm, value: bytes, **kwargs)' + parameters: + - name: algorithm + description: 'Required. algorithm identifier. Possible values include: + + ''RSA-OAEP'', ''RSA-OAEP-256'', ''RSA1_5''' + isRequired: true + types: + - + - + - name: value + description: Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: algorithm + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.key_operations_parameters_py3.KeyOperationsParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_operations_parameters_py3.KeyOperationsParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_operations_parameters_py3.KeyOperationsParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_operations_parameters_py3.KeyOperationsParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_operations_parameters_py3.KeyOperationsParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_operations_parameters_py3.KeyOperationsParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_operations_parameters_py3.KeyOperationsParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operations_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operations_parameters_py3.yml new file mode 100644 index 00000000..5a684fbe --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_operations_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_operations_parameters_py3 +name: key_operations_parameters_py3 +fullName: azure.keyvault.v7_0.models.key_operations_parameters_py3 +classes: +- azure.keyvault.v7_0.models.key_operations_parameters_py3.KeyOperationsParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_properties.KeyProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_properties.KeyProperties.yml new file mode 100644 index 00000000..5f34f3d8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_properties.KeyProperties.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_properties.KeyProperties +name: KeyProperties +fullName: azure.keyvault.v7_0.models.key_properties.KeyProperties +module: azure.keyvault.v7_0.models.key_properties +summary: Properties of the key pair backing a certificate. +constructor: + syntax: KeyProperties(**kwargs) + parameters: + - name: exportable + description: Indicates if the private key can be exported. + isRequired: true + types: + - + - name: key_type + description: 'The type of key pair to be used for the certificate. + + Possible values include: ''EC'', ''EC-HSM'', ''RSA'', ''RSA-HSM'', ''oct''' + isRequired: true + types: + - + - + - name: key_size + description: 'The key size in bits. For example: 2048, 3072, or 4096 + + for RSA.' + isRequired: true + types: + - + - name: reuse_key + description: 'Indicates if the same key pair will be used on + + certificate renewal.' + isRequired: true + types: + - + - name: curve + description: 'Elliptic curve name. For valid values, see + + JsonWebKeyCurveName. Possible values include: ''P-256'', ''P-384'', ''P-521'', + + ''P-256K''' + isRequired: true + types: + - + - +methods: +- uid: azure.keyvault.v7_0.models.key_properties.KeyProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_properties.KeyProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_properties.KeyProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_properties.KeyProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_properties.KeyProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_properties.KeyProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_properties.KeyProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_properties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_properties.yml new file mode 100644 index 00000000..5e6a2b11 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_properties.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_properties +name: key_properties +fullName: azure.keyvault.v7_0.models.key_properties +classes: +- azure.keyvault.v7_0.models.key_properties.KeyProperties diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_properties_py3.KeyProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_properties_py3.KeyProperties.yml new file mode 100644 index 00000000..356adfaa --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_properties_py3.KeyProperties.yml @@ -0,0 +1,164 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_properties_py3.KeyProperties +name: KeyProperties +fullName: azure.keyvault.v7_0.models.key_properties_py3.KeyProperties +module: azure.keyvault.v7_0.models.key_properties_py3 +summary: Properties of the key pair backing a certificate. +constructor: + syntax: 'KeyProperties(*, exportable: bool = None, key_type=None, key_size: int + = None, reuse_key: bool = None, curve=None, **kwargs)' + parameters: + - name: exportable + description: Indicates if the private key can be exported. + isRequired: true + types: + - + - name: key_type + description: 'The type of key pair to be used for the certificate. + + Possible values include: ''EC'', ''EC-HSM'', ''RSA'', ''RSA-HSM'', ''oct''' + isRequired: true + types: + - + - + - name: key_size + description: 'The key size in bits. For example: 2048, 3072, or 4096 + + for RSA.' + isRequired: true + types: + - + - name: reuse_key + description: 'Indicates if the same key pair will be used on + + certificate renewal.' + isRequired: true + types: + - + - name: curve + description: 'Elliptic curve name. For valid values, see + + JsonWebKeyCurveName. Possible values include: ''P-256'', ''P-384'', ''P-521'', + + ''P-256K''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: exportable + isRequired: true + - name: key_type + isRequired: true + - name: key_size + isRequired: true + - name: reuse_key + isRequired: true + - name: curve + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.key_properties_py3.KeyProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_properties_py3.KeyProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_properties_py3.KeyProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_properties_py3.KeyProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_properties_py3.KeyProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_properties_py3.KeyProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_properties_py3.KeyProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_properties_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_properties_py3.yml new file mode 100644 index 00000000..fc92b788 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_properties_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_properties_py3 +name: key_properties_py3 +fullName: azure.keyvault.v7_0.models.key_properties_py3 +classes: +- azure.keyvault.v7_0.models.key_properties_py3.KeyProperties diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_restore_parameters.KeyRestoreParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_restore_parameters.KeyRestoreParameters.yml new file mode 100644 index 00000000..beef1c51 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_restore_parameters.KeyRestoreParameters.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_restore_parameters.KeyRestoreParameters +name: KeyRestoreParameters +fullName: azure.keyvault.v7_0.models.key_restore_parameters.KeyRestoreParameters +module: azure.keyvault.v7_0.models.key_restore_parameters +summary: 'The key restore parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: KeyRestoreParameters(**kwargs) + parameters: + - name: key_bundle_backup + description: 'Required. The backup blob associated with a key + + bundle.' + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.models.key_restore_parameters.KeyRestoreParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_restore_parameters.KeyRestoreParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_restore_parameters.KeyRestoreParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_restore_parameters.KeyRestoreParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_restore_parameters.KeyRestoreParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_restore_parameters.KeyRestoreParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_restore_parameters.KeyRestoreParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_restore_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_restore_parameters.yml new file mode 100644 index 00000000..5c75051c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_restore_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_restore_parameters +name: key_restore_parameters +fullName: azure.keyvault.v7_0.models.key_restore_parameters +classes: +- azure.keyvault.v7_0.models.key_restore_parameters.KeyRestoreParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_restore_parameters_py3.KeyRestoreParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_restore_parameters_py3.KeyRestoreParameters.yml new file mode 100644 index 00000000..72fa8209 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_restore_parameters_py3.KeyRestoreParameters.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_restore_parameters_py3.KeyRestoreParameters +name: KeyRestoreParameters +fullName: azure.keyvault.v7_0.models.key_restore_parameters_py3.KeyRestoreParameters +module: azure.keyvault.v7_0.models.key_restore_parameters_py3 +summary: 'The key restore parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeyRestoreParameters(*, key_bundle_backup: bytes, **kwargs)' + parameters: + - name: key_bundle_backup + description: 'Required. The backup blob associated with a key + + bundle.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: key_bundle_backup + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.key_restore_parameters_py3.KeyRestoreParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_restore_parameters_py3.KeyRestoreParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_restore_parameters_py3.KeyRestoreParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_restore_parameters_py3.KeyRestoreParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_restore_parameters_py3.KeyRestoreParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_restore_parameters_py3.KeyRestoreParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_restore_parameters_py3.KeyRestoreParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_restore_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_restore_parameters_py3.yml new file mode 100644 index 00000000..34518a96 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_restore_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_restore_parameters_py3 +name: key_restore_parameters_py3 +fullName: azure.keyvault.v7_0.models.key_restore_parameters_py3 +classes: +- azure.keyvault.v7_0.models.key_restore_parameters_py3.KeyRestoreParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_sign_parameters.KeySignParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_sign_parameters.KeySignParameters.yml new file mode 100644 index 00000000..adfe23be --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_sign_parameters.KeySignParameters.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_sign_parameters.KeySignParameters +name: KeySignParameters +fullName: azure.keyvault.v7_0.models.key_sign_parameters.KeySignParameters +module: azure.keyvault.v7_0.models.key_sign_parameters +summary: 'The key operations parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: KeySignParameters(**kwargs) + parameters: + - name: algorithm + description: 'Required. The signing/verification algorithm identifier. + + For more information on possible algorithm types, see + + JsonWebKeySignatureAlgorithm. Possible values include: ''PS256'', ''PS384'', + + ''PS512'', ''RS256'', ''RS384'', ''RS512'', ''RSNULL'', ''ES256'', ''ES384'', + ''ES512'', + + ''ES256K''' + isRequired: true + types: + - + - + - name: value + description: Required. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.models.key_sign_parameters.KeySignParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_sign_parameters.KeySignParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_sign_parameters.KeySignParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_sign_parameters.KeySignParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_sign_parameters.KeySignParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_sign_parameters.KeySignParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_sign_parameters.KeySignParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_sign_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_sign_parameters.yml new file mode 100644 index 00000000..dcccb1ce --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_sign_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_sign_parameters +name: key_sign_parameters +fullName: azure.keyvault.v7_0.models.key_sign_parameters +classes: +- azure.keyvault.v7_0.models.key_sign_parameters.KeySignParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_sign_parameters_py3.KeySignParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_sign_parameters_py3.KeySignParameters.yml new file mode 100644 index 00000000..4275c02c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_sign_parameters_py3.KeySignParameters.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_sign_parameters_py3.KeySignParameters +name: KeySignParameters +fullName: azure.keyvault.v7_0.models.key_sign_parameters_py3.KeySignParameters +module: azure.keyvault.v7_0.models.key_sign_parameters_py3 +summary: 'The key operations parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeySignParameters(*, algorithm, value: bytes, **kwargs)' + parameters: + - name: algorithm + description: 'Required. The signing/verification algorithm identifier. + + For more information on possible algorithm types, see + + JsonWebKeySignatureAlgorithm. Possible values include: ''PS256'', ''PS384'', + + ''PS512'', ''RS256'', ''RS384'', ''RS512'', ''RSNULL'', ''ES256'', ''ES384'', + ''ES512'', + + ''ES256K''' + isRequired: true + types: + - + - + - name: value + description: Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: algorithm + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.key_sign_parameters_py3.KeySignParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_sign_parameters_py3.KeySignParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_sign_parameters_py3.KeySignParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_sign_parameters_py3.KeySignParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_sign_parameters_py3.KeySignParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_sign_parameters_py3.KeySignParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_sign_parameters_py3.KeySignParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_sign_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_sign_parameters_py3.yml new file mode 100644 index 00000000..07ec27aa --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_sign_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_sign_parameters_py3 +name: key_sign_parameters_py3 +fullName: azure.keyvault.v7_0.models.key_sign_parameters_py3 +classes: +- azure.keyvault.v7_0.models.key_sign_parameters_py3.KeySignParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_update_parameters.KeyUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_update_parameters.KeyUpdateParameters.yml new file mode 100644 index 00000000..2a6de28d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_update_parameters.KeyUpdateParameters.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_update_parameters.KeyUpdateParameters +name: KeyUpdateParameters +fullName: azure.keyvault.v7_0.models.key_update_parameters.KeyUpdateParameters +module: azure.keyvault.v7_0.models.key_update_parameters +summary: The key update parameters. +constructor: + syntax: KeyUpdateParameters(**kwargs) + parameters: + - name: key_ops + description: 'Json web key operations. For more information on possible + + key operations, see JsonWebKeyOperation.' + isRequired: true + types: + - [ + - ] + - name: key_attributes + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +methods: +- uid: azure.keyvault.v7_0.models.key_update_parameters.KeyUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_update_parameters.KeyUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_update_parameters.KeyUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_update_parameters.KeyUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_update_parameters.KeyUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_update_parameters.KeyUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_update_parameters.KeyUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_update_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_update_parameters.yml new file mode 100644 index 00000000..23bbf3af --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_update_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_update_parameters +name: key_update_parameters +fullName: azure.keyvault.v7_0.models.key_update_parameters +classes: +- azure.keyvault.v7_0.models.key_update_parameters.KeyUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_update_parameters_py3.KeyUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_update_parameters_py3.KeyUpdateParameters.yml new file mode 100644 index 00000000..64b6aac8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_update_parameters_py3.KeyUpdateParameters.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_update_parameters_py3.KeyUpdateParameters +name: KeyUpdateParameters +fullName: azure.keyvault.v7_0.models.key_update_parameters_py3.KeyUpdateParameters +module: azure.keyvault.v7_0.models.key_update_parameters_py3 +summary: The key update parameters. +constructor: + syntax: KeyUpdateParameters(*, key_ops=None, key_attributes=None, tags=None, **kwargs) + parameters: + - name: key_ops + description: 'Json web key operations. For more information on possible + + key operations, see JsonWebKeyOperation.' + isRequired: true + types: + - [ + - ] + - name: key_attributes + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: key_ops + isRequired: true + - name: key_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.key_update_parameters_py3.KeyUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_update_parameters_py3.KeyUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_update_parameters_py3.KeyUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_update_parameters_py3.KeyUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_update_parameters_py3.KeyUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_update_parameters_py3.KeyUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_update_parameters_py3.KeyUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_update_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_update_parameters_py3.yml new file mode 100644 index 00000000..ae00b976 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_update_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_update_parameters_py3 +name: key_update_parameters_py3 +fullName: azure.keyvault.v7_0.models.key_update_parameters_py3 +classes: +- azure.keyvault.v7_0.models.key_update_parameters_py3.KeyUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.ActionType.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.ActionType.yml new file mode 100644 index 00000000..31050cf6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.ActionType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v7_0.models.key_vault_client_enums.ActionType +name: ActionType +fullName: azure.keyvault.v7_0.models.key_vault_client_enums.ActionType +module: azure.keyvault.v7_0.models.key_vault_client_enums +fields: +- name: auto_renew + uid: azure.keyvault.v7_0.models.key_vault_client_enums.ActionType.auto_renew +- name: email_contacts + uid: azure.keyvault.v7_0.models.key_vault_client_enums.ActionType.email_contacts diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.DeletionRecoveryLevel.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.DeletionRecoveryLevel.yml new file mode 100644 index 00000000..f1b7ac2b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.DeletionRecoveryLevel.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v7_0.models.key_vault_client_enums.DeletionRecoveryLevel +name: DeletionRecoveryLevel +fullName: azure.keyvault.v7_0.models.key_vault_client_enums.DeletionRecoveryLevel +module: azure.keyvault.v7_0.models.key_vault_client_enums +fields: +- name: purgeable + uid: azure.keyvault.v7_0.models.key_vault_client_enums.DeletionRecoveryLevel.purgeable +- name: recoverable + uid: azure.keyvault.v7_0.models.key_vault_client_enums.DeletionRecoveryLevel.recoverable +- name: recoverable_protected_subscription + uid: azure.keyvault.v7_0.models.key_vault_client_enums.DeletionRecoveryLevel.recoverable_protected_subscription +- name: recoverable_purgeable + uid: azure.keyvault.v7_0.models.key_vault_client_enums.DeletionRecoveryLevel.recoverable_purgeable diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyCurveName.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyCurveName.yml new file mode 100644 index 00000000..6b93f0d5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyCurveName.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyCurveName +name: JsonWebKeyCurveName +fullName: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyCurveName +module: azure.keyvault.v7_0.models.key_vault_client_enums +fields: +- name: p_256 + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyCurveName.p_256 +- name: p_256_k + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyCurveName.p_256_k +- name: p_384 + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyCurveName.p_384 +- name: p_521 + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyCurveName.p_521 diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyEncryptionAlgorithm.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyEncryptionAlgorithm.yml new file mode 100644 index 00000000..2b230ced --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyEncryptionAlgorithm.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyEncryptionAlgorithm +name: JsonWebKeyEncryptionAlgorithm +fullName: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyEncryptionAlgorithm +module: azure.keyvault.v7_0.models.key_vault_client_enums +fields: +- name: rsa1_5 + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyEncryptionAlgorithm.rsa1_5 +- name: rsa_oaep + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyEncryptionAlgorithm.rsa_oaep +- name: rsa_oaep_256 + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyEncryptionAlgorithm.rsa_oaep_256 diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyOperation.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyOperation.yml new file mode 100644 index 00000000..ebfb9896 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyOperation.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyOperation +name: JsonWebKeyOperation +fullName: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyOperation +module: azure.keyvault.v7_0.models.key_vault_client_enums +fields: +- name: decrypt + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyOperation.decrypt +- name: encrypt + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyOperation.encrypt +- name: sign + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyOperation.sign +- name: unwrap_key + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyOperation.unwrap_key +- name: verify + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyOperation.verify +- name: wrap_key + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyOperation.wrap_key diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.yml new file mode 100644 index 00000000..07e6b2e0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm +name: JsonWebKeySignatureAlgorithm +fullName: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm +module: azure.keyvault.v7_0.models.key_vault_client_enums +fields: +- name: es256 + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.es256 +- name: es256_k + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.es256_k +- name: es384 + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.es384 +- name: es512 + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.es512 +- name: ps256 + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.ps256 +- name: ps384 + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.ps384 +- name: ps512 + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.ps512 +- name: rs256 + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.rs256 +- name: rs384 + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.rs384 +- name: rs512 + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.rs512 +- name: rsnull + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm.rsnull diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyType.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyType.yml new file mode 100644 index 00000000..c082b515 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyType.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyType +name: JsonWebKeyType +fullName: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyType +module: azure.keyvault.v7_0.models.key_vault_client_enums +fields: +- name: ec + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyType.ec +- name: ec_hsm + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyType.ec_hsm +- name: oct + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyType.oct +- name: rsa + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyType.rsa +- name: rsa_hsm + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyType.rsa_hsm diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.KeyUsageType.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.KeyUsageType.yml new file mode 100644 index 00000000..5516ac53 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.KeyUsageType.yml @@ -0,0 +1,24 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v7_0.models.key_vault_client_enums.KeyUsageType +name: KeyUsageType +fullName: azure.keyvault.v7_0.models.key_vault_client_enums.KeyUsageType +module: azure.keyvault.v7_0.models.key_vault_client_enums +fields: +- name: c_rl_sign + uid: azure.keyvault.v7_0.models.key_vault_client_enums.KeyUsageType.c_rl_sign +- name: data_encipherment + uid: azure.keyvault.v7_0.models.key_vault_client_enums.KeyUsageType.data_encipherment +- name: decipher_only + uid: azure.keyvault.v7_0.models.key_vault_client_enums.KeyUsageType.decipher_only +- name: digital_signature + uid: azure.keyvault.v7_0.models.key_vault_client_enums.KeyUsageType.digital_signature +- name: encipher_only + uid: azure.keyvault.v7_0.models.key_vault_client_enums.KeyUsageType.encipher_only +- name: key_agreement + uid: azure.keyvault.v7_0.models.key_vault_client_enums.KeyUsageType.key_agreement +- name: key_cert_sign + uid: azure.keyvault.v7_0.models.key_vault_client_enums.KeyUsageType.key_cert_sign +- name: key_encipherment + uid: azure.keyvault.v7_0.models.key_vault_client_enums.KeyUsageType.key_encipherment +- name: non_repudiation + uid: azure.keyvault.v7_0.models.key_vault_client_enums.KeyUsageType.non_repudiation diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.SasTokenType.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.SasTokenType.yml new file mode 100644 index 00000000..7c1a76c6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.SasTokenType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.keyvault.v7_0.models.key_vault_client_enums.SasTokenType +name: SasTokenType +fullName: azure.keyvault.v7_0.models.key_vault_client_enums.SasTokenType +module: azure.keyvault.v7_0.models.key_vault_client_enums +fields: +- name: account + uid: azure.keyvault.v7_0.models.key_vault_client_enums.SasTokenType.account +- name: service + uid: azure.keyvault.v7_0.models.key_vault_client_enums.SasTokenType.service diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.yml new file mode 100644 index 00000000..a19999aa --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_client_enums.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_vault_client_enums +name: key_vault_client_enums +fullName: azure.keyvault.v7_0.models.key_vault_client_enums +enums: +- azure.keyvault.v7_0.models.key_vault_client_enums.ActionType +- azure.keyvault.v7_0.models.key_vault_client_enums.DeletionRecoveryLevel +- azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyCurveName +- azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyEncryptionAlgorithm +- azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyOperation +- azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm +- azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyType +- azure.keyvault.v7_0.models.key_vault_client_enums.KeyUsageType +- azure.keyvault.v7_0.models.key_vault_client_enums.SasTokenType diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error.KeyVaultError.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error.KeyVaultError.yml new file mode 100644 index 00000000..51eb103a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error.KeyVaultError.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_vault_error.KeyVaultError +name: KeyVaultError +fullName: azure.keyvault.v7_0.models.key_vault_error.KeyVaultError +module: azure.keyvault.v7_0.models.key_vault_error +summary: 'The key vault error exception. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyVaultError(**kwargs) +variables: +- name: error + types: + - +methods: +- uid: azure.keyvault.v7_0.models.key_vault_error.KeyVaultError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_vault_error.KeyVaultError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_vault_error.KeyVaultError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_vault_error.KeyVaultError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_vault_error.KeyVaultError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_vault_error.KeyVaultError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_vault_error.KeyVaultError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error.KeyVaultErrorException.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error.KeyVaultErrorException.yml new file mode 100644 index 00000000..d90665e8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error.KeyVaultErrorException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_vault_error.KeyVaultErrorException +name: KeyVaultErrorException +fullName: azure.keyvault.v7_0.models.key_vault_error.KeyVaultErrorException +module: azure.keyvault.v7_0.models.key_vault_error +summary: 'Server responsed with exception of type: ''KeyVaultError''.' +constructor: + syntax: KeyVaultErrorException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.key_vault_error.KeyVaultErrorException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.keyvault.v7_0.models.key_vault_error.KeyVaultErrorException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.keyvault.v7_0.models.key_vault_error.KeyVaultErrorException.args + name: args diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error.yml new file mode 100644 index 00000000..f594c39e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_vault_error +name: key_vault_error +fullName: azure.keyvault.v7_0.models.key_vault_error +classes: +- azure.keyvault.v7_0.models.key_vault_error.KeyVaultError +- azure.keyvault.v7_0.models.key_vault_error.KeyVaultErrorException diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultError.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultError.yml new file mode 100644 index 00000000..e3a86c85 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultError.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultError +name: KeyVaultError +fullName: azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultError +module: azure.keyvault.v7_0.models.key_vault_error_py3 +summary: 'The key vault error exception. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyVaultError(**kwargs) +variables: +- name: error + types: + - +methods: +- uid: azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultErrorException.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultErrorException.yml new file mode 100644 index 00000000..356c086a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultErrorException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultErrorException +name: KeyVaultErrorException +fullName: azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultErrorException +module: azure.keyvault.v7_0.models.key_vault_error_py3 +summary: 'Server responsed with exception of type: ''KeyVaultError''.' +constructor: + syntax: KeyVaultErrorException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultErrorException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultErrorException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultErrorException.args + name: args diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error_py3.yml new file mode 100644 index 00000000..fa0f55d4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_vault_error_py3.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_vault_error_py3 +name: key_vault_error_py3 +fullName: azure.keyvault.v7_0.models.key_vault_error_py3 +classes: +- azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultError +- azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultErrorException diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_parameters.KeyVerifyParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_parameters.KeyVerifyParameters.yml new file mode 100644 index 00000000..eaf10497 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_parameters.KeyVerifyParameters.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_verify_parameters.KeyVerifyParameters +name: KeyVerifyParameters +fullName: azure.keyvault.v7_0.models.key_verify_parameters.KeyVerifyParameters +module: azure.keyvault.v7_0.models.key_verify_parameters +summary: 'The key verify parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: KeyVerifyParameters(**kwargs) + parameters: + - name: algorithm + description: 'Required. The signing/verification algorithm. For more + + information on possible algorithm types, see JsonWebKeySignatureAlgorithm. + + Possible values include: ''PS256'', ''PS384'', ''PS512'', ''RS256'', ''RS384'', + + ''RS512'', ''RSNULL'', ''ES256'', ''ES384'', ''ES512'', ''ES256K''' + isRequired: true + types: + - + - + - name: digest + description: Required. The digest used for signing. + isRequired: true + types: + - + - name: signature + description: Required. The signature to be verified. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.models.key_verify_parameters.KeyVerifyParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_verify_parameters.KeyVerifyParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_verify_parameters.KeyVerifyParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_verify_parameters.KeyVerifyParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_verify_parameters.KeyVerifyParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_verify_parameters.KeyVerifyParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_verify_parameters.KeyVerifyParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_parameters.yml new file mode 100644 index 00000000..5502acf3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_verify_parameters +name: key_verify_parameters +fullName: azure.keyvault.v7_0.models.key_verify_parameters +classes: +- azure.keyvault.v7_0.models.key_verify_parameters.KeyVerifyParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_parameters_py3.KeyVerifyParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_parameters_py3.KeyVerifyParameters.yml new file mode 100644 index 00000000..f3ff7809 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_parameters_py3.KeyVerifyParameters.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_verify_parameters_py3.KeyVerifyParameters +name: KeyVerifyParameters +fullName: azure.keyvault.v7_0.models.key_verify_parameters_py3.KeyVerifyParameters +module: azure.keyvault.v7_0.models.key_verify_parameters_py3 +summary: 'The key verify parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeyVerifyParameters(*, algorithm, digest: bytes, signature: bytes, **kwargs)' + parameters: + - name: algorithm + description: 'Required. The signing/verification algorithm. For more + + information on possible algorithm types, see JsonWebKeySignatureAlgorithm. + + Possible values include: ''PS256'', ''PS384'', ''PS512'', ''RS256'', ''RS384'', + + ''RS512'', ''RSNULL'', ''ES256'', ''ES384'', ''ES512'', ''ES256K''' + isRequired: true + types: + - + - + - name: digest + description: Required. The digest used for signing. + isRequired: true + types: + - + - name: signature + description: Required. The signature to be verified. + isRequired: true + types: + - + keywordOnlyParameters: + - name: algorithm + isRequired: true + - name: digest + isRequired: true + - name: signature + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.key_verify_parameters_py3.KeyVerifyParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_verify_parameters_py3.KeyVerifyParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_verify_parameters_py3.KeyVerifyParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_verify_parameters_py3.KeyVerifyParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_verify_parameters_py3.KeyVerifyParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_verify_parameters_py3.KeyVerifyParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_verify_parameters_py3.KeyVerifyParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_parameters_py3.yml new file mode 100644 index 00000000..69d679bf --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_verify_parameters_py3 +name: key_verify_parameters_py3 +fullName: azure.keyvault.v7_0.models.key_verify_parameters_py3 +classes: +- azure.keyvault.v7_0.models.key_verify_parameters_py3.KeyVerifyParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_result.KeyVerifyResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_result.KeyVerifyResult.yml new file mode 100644 index 00000000..e25ba50e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_result.KeyVerifyResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_verify_result.KeyVerifyResult +name: KeyVerifyResult +fullName: azure.keyvault.v7_0.models.key_verify_result.KeyVerifyResult +module: azure.keyvault.v7_0.models.key_verify_result +summary: 'The key verify result. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyVerifyResult(**kwargs) +variables: +- description: True if the signature is verified, otherwise false. + name: value + types: + - +methods: +- uid: azure.keyvault.v7_0.models.key_verify_result.KeyVerifyResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_verify_result.KeyVerifyResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_verify_result.KeyVerifyResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_verify_result.KeyVerifyResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_verify_result.KeyVerifyResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_verify_result.KeyVerifyResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_verify_result.KeyVerifyResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_result.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_result.yml new file mode 100644 index 00000000..7098d851 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_verify_result +name: key_verify_result +fullName: azure.keyvault.v7_0.models.key_verify_result +classes: +- azure.keyvault.v7_0.models.key_verify_result.KeyVerifyResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_result_py3.KeyVerifyResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_result_py3.KeyVerifyResult.yml new file mode 100644 index 00000000..d440bb91 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_result_py3.KeyVerifyResult.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.key_verify_result_py3.KeyVerifyResult +name: KeyVerifyResult +fullName: azure.keyvault.v7_0.models.key_verify_result_py3.KeyVerifyResult +module: azure.keyvault.v7_0.models.key_verify_result_py3 +summary: 'The key verify result. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: KeyVerifyResult(**kwargs) +variables: +- description: True if the signature is verified, otherwise false. + name: value + types: + - +methods: +- uid: azure.keyvault.v7_0.models.key_verify_result_py3.KeyVerifyResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_verify_result_py3.KeyVerifyResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_verify_result_py3.KeyVerifyResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.key_verify_result_py3.KeyVerifyResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.key_verify_result_py3.KeyVerifyResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.key_verify_result_py3.KeyVerifyResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.key_verify_result_py3.KeyVerifyResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_result_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_result_py3.yml new file mode 100644 index 00000000..fdfc0712 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_verify_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.key_verify_result_py3 +name: key_verify_result_py3 +fullName: azure.keyvault.v7_0.models.key_verify_result_py3 +classes: +- azure.keyvault.v7_0.models.key_verify_result_py3.KeyVerifyResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.lifetime_action.LifetimeAction.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.lifetime_action.LifetimeAction.yml new file mode 100644 index 00000000..1307a25d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.lifetime_action.LifetimeAction.yml @@ -0,0 +1,127 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.lifetime_action.LifetimeAction +name: LifetimeAction +fullName: azure.keyvault.v7_0.models.lifetime_action.LifetimeAction +module: azure.keyvault.v7_0.models.lifetime_action +summary: 'Action and its trigger that will be performed by Key Vault over the + + lifetime of a certificate.' +constructor: + syntax: LifetimeAction(**kwargs) + parameters: + - name: trigger + description: The condition that will execute the action. + isRequired: true + types: + - + - name: action + description: The action that will be executed. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.models.lifetime_action.LifetimeAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.lifetime_action.LifetimeAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.lifetime_action.LifetimeAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.lifetime_action.LifetimeAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.lifetime_action.LifetimeAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.lifetime_action.LifetimeAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.lifetime_action.LifetimeAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.lifetime_action.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.lifetime_action.yml new file mode 100644 index 00000000..bf4c86f6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.lifetime_action.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.lifetime_action +name: lifetime_action +fullName: azure.keyvault.v7_0.models.lifetime_action +classes: +- azure.keyvault.v7_0.models.lifetime_action.LifetimeAction diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.lifetime_action_py3.LifetimeAction.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.lifetime_action_py3.LifetimeAction.yml new file mode 100644 index 00000000..6ce158f6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.lifetime_action_py3.LifetimeAction.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.lifetime_action_py3.LifetimeAction +name: LifetimeAction +fullName: azure.keyvault.v7_0.models.lifetime_action_py3.LifetimeAction +module: azure.keyvault.v7_0.models.lifetime_action_py3 +summary: 'Action and its trigger that will be performed by Key Vault over the + + lifetime of a certificate.' +constructor: + syntax: LifetimeAction(*, trigger=None, action=None, **kwargs) + parameters: + - name: trigger + description: The condition that will execute the action. + isRequired: true + types: + - + - name: action + description: The action that will be executed. + isRequired: true + types: + - + keywordOnlyParameters: + - name: trigger + isRequired: true + - name: action + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.lifetime_action_py3.LifetimeAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.lifetime_action_py3.LifetimeAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.lifetime_action_py3.LifetimeAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.lifetime_action_py3.LifetimeAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.lifetime_action_py3.LifetimeAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.lifetime_action_py3.LifetimeAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.lifetime_action_py3.LifetimeAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.lifetime_action_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.lifetime_action_py3.yml new file mode 100644 index 00000000..441301df --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.lifetime_action_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.lifetime_action_py3 +name: lifetime_action_py3 +fullName: azure.keyvault.v7_0.models.lifetime_action_py3 +classes: +- azure.keyvault.v7_0.models.lifetime_action_py3.LifetimeAction diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.organization_details.OrganizationDetails.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.organization_details.OrganizationDetails.yml new file mode 100644 index 00000000..370e8ddc --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.organization_details.OrganizationDetails.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.organization_details.OrganizationDetails +name: OrganizationDetails +fullName: azure.keyvault.v7_0.models.organization_details.OrganizationDetails +module: azure.keyvault.v7_0.models.organization_details +summary: Details of the organization of the certificate issuer. +constructor: + syntax: OrganizationDetails(**kwargs) + parameters: + - name: id + description: Id of the organization. + isRequired: true + types: + - + - name: admin_details + description: Details of the organization administrator. + isRequired: true + types: + - [] +methods: +- uid: azure.keyvault.v7_0.models.organization_details.OrganizationDetails.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.organization_details.OrganizationDetails.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.organization_details.OrganizationDetails.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.organization_details.OrganizationDetails.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.organization_details.OrganizationDetails.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.organization_details.OrganizationDetails.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.organization_details.OrganizationDetails.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.organization_details.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.organization_details.yml new file mode 100644 index 00000000..c84e824e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.organization_details.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.organization_details +name: organization_details +fullName: azure.keyvault.v7_0.models.organization_details +classes: +- azure.keyvault.v7_0.models.organization_details.OrganizationDetails diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.organization_details_py3.OrganizationDetails.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.organization_details_py3.OrganizationDetails.yml new file mode 100644 index 00000000..cb57a5a5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.organization_details_py3.OrganizationDetails.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.organization_details_py3.OrganizationDetails +name: OrganizationDetails +fullName: azure.keyvault.v7_0.models.organization_details_py3.OrganizationDetails +module: azure.keyvault.v7_0.models.organization_details_py3 +summary: Details of the organization of the certificate issuer. +constructor: + syntax: 'OrganizationDetails(*, id: str = None, admin_details=None, **kwargs)' + parameters: + - name: id + description: Id of the organization. + isRequired: true + types: + - + - name: admin_details + description: Details of the organization administrator. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: admin_details + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.organization_details_py3.OrganizationDetails.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.organization_details_py3.OrganizationDetails.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.organization_details_py3.OrganizationDetails.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.organization_details_py3.OrganizationDetails.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.organization_details_py3.OrganizationDetails.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.organization_details_py3.OrganizationDetails.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.organization_details_py3.OrganizationDetails.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.organization_details_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.organization_details_py3.yml new file mode 100644 index 00000000..05358151 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.organization_details_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.organization_details_py3 +name: organization_details_py3 +fullName: azure.keyvault.v7_0.models.organization_details_py3 +classes: +- azure.keyvault.v7_0.models.organization_details_py3.OrganizationDetails diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult.yml new file mode 100644 index 00000000..3dc978b1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult +name: PendingCertificateSigningRequestResult +fullName: azure.keyvault.v7_0.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult +module: azure.keyvault.v7_0.models.pending_certificate_signing_request_result +summary: 'The pending certificate signing request result. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: PendingCertificateSigningRequestResult(**kwargs) +variables: +- description: 'The pending certificate signing request as Base64 encoded + + string.' + name: value + types: + - +methods: +- uid: azure.keyvault.v7_0.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.pending_certificate_signing_request_result.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.pending_certificate_signing_request_result.yml new file mode 100644 index 00000000..32d81283 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.pending_certificate_signing_request_result.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.pending_certificate_signing_request_result +name: pending_certificate_signing_request_result +fullName: azure.keyvault.v7_0.models.pending_certificate_signing_request_result +classes: +- azure.keyvault.v7_0.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult.yml new file mode 100644 index 00000000..1a05f352 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult +name: PendingCertificateSigningRequestResult +fullName: azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult +module: azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3 +summary: 'The pending certificate signing request result. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: PendingCertificateSigningRequestResult(**kwargs) +variables: +- description: 'The pending certificate signing request as Base64 encoded + + string.' + name: value + types: + - +methods: +- uid: azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3.yml new file mode 100644 index 00000000..cb2eac34 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3 +name: pending_certificate_signing_request_result_py3 +fullName: azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3 +classes: +- azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_attributes.SasDefinitionAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_attributes.SasDefinitionAttributes.yml new file mode 100644 index 00000000..4563f78c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_attributes.SasDefinitionAttributes.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.sas_definition_attributes.SasDefinitionAttributes +name: SasDefinitionAttributes +fullName: azure.keyvault.v7_0.models.sas_definition_attributes.SasDefinitionAttributes +module: azure.keyvault.v7_0.models.sas_definition_attributes +summary: 'The SAS definition management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SasDefinitionAttributes(**kwargs) + parameters: + - name: enabled + description: the enabled state of the object. + isRequired: true + types: + - +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for SAS definitions in the current vault. If it contains + + ''Purgeable'' the SAS definition can be permanently deleted by a privileged + + user; otherwise, only the system can purge the SAS definition, at the end + + of the retention interval. Possible values include: ''Purgeable'', + + ''Recoverable+Purgeable'', ''Recoverable'', + + ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v7_0.models.sas_definition_attributes.SasDefinitionAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.sas_definition_attributes.SasDefinitionAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.sas_definition_attributes.SasDefinitionAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.sas_definition_attributes.SasDefinitionAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.sas_definition_attributes.SasDefinitionAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.sas_definition_attributes.SasDefinitionAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.sas_definition_attributes.SasDefinitionAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_attributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_attributes.yml new file mode 100644 index 00000000..66677b45 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_attributes.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.sas_definition_attributes +name: sas_definition_attributes +fullName: azure.keyvault.v7_0.models.sas_definition_attributes +classes: +- azure.keyvault.v7_0.models.sas_definition_attributes.SasDefinitionAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_attributes_py3.SasDefinitionAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_attributes_py3.SasDefinitionAttributes.yml new file mode 100644 index 00000000..7cbb1f41 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_attributes_py3.SasDefinitionAttributes.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.sas_definition_attributes_py3.SasDefinitionAttributes +name: SasDefinitionAttributes +fullName: azure.keyvault.v7_0.models.sas_definition_attributes_py3.SasDefinitionAttributes +module: azure.keyvault.v7_0.models.sas_definition_attributes_py3 +summary: 'The SAS definition management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'SasDefinitionAttributes(*, enabled: bool = None, **kwargs)' + parameters: + - name: enabled + description: the enabled state of the object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for SAS definitions in the current vault. If it contains + + ''Purgeable'' the SAS definition can be permanently deleted by a privileged + + user; otherwise, only the system can purge the SAS definition, at the end + + of the retention interval. Possible values include: ''Purgeable'', + + ''Recoverable+Purgeable'', ''Recoverable'', + + ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v7_0.models.sas_definition_attributes_py3.SasDefinitionAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.sas_definition_attributes_py3.SasDefinitionAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.sas_definition_attributes_py3.SasDefinitionAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.sas_definition_attributes_py3.SasDefinitionAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.sas_definition_attributes_py3.SasDefinitionAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.sas_definition_attributes_py3.SasDefinitionAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.sas_definition_attributes_py3.SasDefinitionAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_attributes_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_attributes_py3.yml new file mode 100644 index 00000000..cadd249e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_attributes_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.sas_definition_attributes_py3 +name: sas_definition_attributes_py3 +fullName: azure.keyvault.v7_0.models.sas_definition_attributes_py3 +classes: +- azure.keyvault.v7_0.models.sas_definition_attributes_py3.SasDefinitionAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_bundle.SasDefinitionBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_bundle.SasDefinitionBundle.yml new file mode 100644 index 00000000..f9a2b176 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_bundle.SasDefinitionBundle.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.sas_definition_bundle.SasDefinitionBundle +name: SasDefinitionBundle +fullName: azure.keyvault.v7_0.models.sas_definition_bundle.SasDefinitionBundle +module: azure.keyvault.v7_0.models.sas_definition_bundle +summary: 'A SAS definition bundle consists of key vault SAS definition details plus + + its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SasDefinitionBundle(**kwargs) +variables: +- description: The SAS definition id. + name: id + types: + - +- description: Storage account SAS definition secret id. + name: secret_id + types: + - +- description: 'The SAS definition token template signed with an + + arbitrary key. Tokens created according to the SAS definition will have + + the same properties as the template.' + name: template_uri + types: + - +- description: 'The type of SAS token the SAS definition will create. + + Possible values include: ''account'', ''service''' + name: sas_type + types: + - + - +- description: 'The validity period of SAS tokens created according + + to the SAS definition.' + name: validity_period + types: + - +- description: The SAS definition attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v7_0.models.sas_definition_bundle.SasDefinitionBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.sas_definition_bundle.SasDefinitionBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.sas_definition_bundle.SasDefinitionBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.sas_definition_bundle.SasDefinitionBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.sas_definition_bundle.SasDefinitionBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.sas_definition_bundle.SasDefinitionBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.sas_definition_bundle.SasDefinitionBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_bundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_bundle.yml new file mode 100644 index 00000000..ac47599f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_bundle.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.sas_definition_bundle +name: sas_definition_bundle +fullName: azure.keyvault.v7_0.models.sas_definition_bundle +classes: +- azure.keyvault.v7_0.models.sas_definition_bundle.SasDefinitionBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_bundle_py3.SasDefinitionBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_bundle_py3.SasDefinitionBundle.yml new file mode 100644 index 00000000..bf886757 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_bundle_py3.SasDefinitionBundle.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.sas_definition_bundle_py3.SasDefinitionBundle +name: SasDefinitionBundle +fullName: azure.keyvault.v7_0.models.sas_definition_bundle_py3.SasDefinitionBundle +module: azure.keyvault.v7_0.models.sas_definition_bundle_py3 +summary: 'A SAS definition bundle consists of key vault SAS definition details plus + + its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SasDefinitionBundle(**kwargs) +variables: +- description: The SAS definition id. + name: id + types: + - +- description: Storage account SAS definition secret id. + name: secret_id + types: + - +- description: 'The SAS definition token template signed with an + + arbitrary key. Tokens created according to the SAS definition will have + + the same properties as the template.' + name: template_uri + types: + - +- description: 'The type of SAS token the SAS definition will create. + + Possible values include: ''account'', ''service''' + name: sas_type + types: + - + - +- description: 'The validity period of SAS tokens created according + + to the SAS definition.' + name: validity_period + types: + - +- description: The SAS definition attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v7_0.models.sas_definition_bundle_py3.SasDefinitionBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.sas_definition_bundle_py3.SasDefinitionBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.sas_definition_bundle_py3.SasDefinitionBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.sas_definition_bundle_py3.SasDefinitionBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.sas_definition_bundle_py3.SasDefinitionBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.sas_definition_bundle_py3.SasDefinitionBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.sas_definition_bundle_py3.SasDefinitionBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_bundle_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_bundle_py3.yml new file mode 100644 index 00000000..97a05628 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_bundle_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.sas_definition_bundle_py3 +name: sas_definition_bundle_py3 +fullName: azure.keyvault.v7_0.models.sas_definition_bundle_py3 +classes: +- azure.keyvault.v7_0.models.sas_definition_bundle_py3.SasDefinitionBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_create_parameters.SasDefinitionCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_create_parameters.SasDefinitionCreateParameters.yml new file mode 100644 index 00000000..c374be22 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_create_parameters.SasDefinitionCreateParameters.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.sas_definition_create_parameters.SasDefinitionCreateParameters +name: SasDefinitionCreateParameters +fullName: azure.keyvault.v7_0.models.sas_definition_create_parameters.SasDefinitionCreateParameters +module: azure.keyvault.v7_0.models.sas_definition_create_parameters +summary: 'The SAS definition create parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: SasDefinitionCreateParameters(**kwargs) + parameters: + - name: template_uri + description: 'Required. The SAS definition token template signed + + with an arbitrary key. Tokens created according to the SAS definition + + will have the same properties as the template.' + isRequired: true + types: + - + - name: sas_type + description: 'Required. The type of SAS token the SAS definition will + + create. Possible values include: ''account'', ''service''' + isRequired: true + types: + - + - + - name: validity_period + description: 'Required. The validity period of SAS tokens + + created according to the SAS definition.' + isRequired: true + types: + - + - name: sas_definition_attributes + description: The attributes of the SAS definition. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +methods: +- uid: azure.keyvault.v7_0.models.sas_definition_create_parameters.SasDefinitionCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.sas_definition_create_parameters.SasDefinitionCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.sas_definition_create_parameters.SasDefinitionCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.sas_definition_create_parameters.SasDefinitionCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.sas_definition_create_parameters.SasDefinitionCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.sas_definition_create_parameters.SasDefinitionCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.sas_definition_create_parameters.SasDefinitionCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_create_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_create_parameters.yml new file mode 100644 index 00000000..ebb9db81 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_create_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.sas_definition_create_parameters +name: sas_definition_create_parameters +fullName: azure.keyvault.v7_0.models.sas_definition_create_parameters +classes: +- azure.keyvault.v7_0.models.sas_definition_create_parameters.SasDefinitionCreateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.yml new file mode 100644 index 00000000..529c9635 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.yml @@ -0,0 +1,164 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters +name: SasDefinitionCreateParameters +fullName: azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters +module: azure.keyvault.v7_0.models.sas_definition_create_parameters_py3 +summary: 'The SAS definition create parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SasDefinitionCreateParameters(*, template_uri: str, sas_type, validity_period: + str, sas_definition_attributes=None, tags=None, **kwargs)' + parameters: + - name: template_uri + description: 'Required. The SAS definition token template signed + + with an arbitrary key. Tokens created according to the SAS definition + + will have the same properties as the template.' + isRequired: true + types: + - + - name: sas_type + description: 'Required. The type of SAS token the SAS definition will + + create. Possible values include: ''account'', ''service''' + isRequired: true + types: + - + - + - name: validity_period + description: 'Required. The validity period of SAS tokens + + created according to the SAS definition.' + isRequired: true + types: + - + - name: sas_definition_attributes + description: The attributes of the SAS definition. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: template_uri + isRequired: true + - name: sas_type + isRequired: true + - name: validity_period + isRequired: true + - name: sas_definition_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.yml new file mode 100644 index 00000000..b1e9b708 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.sas_definition_create_parameters_py3 +name: sas_definition_create_parameters_py3 +fullName: azure.keyvault.v7_0.models.sas_definition_create_parameters_py3 +classes: +- azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item.SasDefinitionItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item.SasDefinitionItem.yml new file mode 100644 index 00000000..e662979e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item.SasDefinitionItem.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.sas_definition_item.SasDefinitionItem +name: SasDefinitionItem +fullName: azure.keyvault.v7_0.models.sas_definition_item.SasDefinitionItem +module: azure.keyvault.v7_0.models.sas_definition_item +summary: 'The SAS definition item containing storage SAS definition metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SasDefinitionItem(**kwargs) +variables: +- description: The storage SAS identifier. + name: id + types: + - +- description: The storage account SAS definition secret id. + name: secret_id + types: + - +- description: The SAS definition management attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs. + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v7_0.models.sas_definition_item.SasDefinitionItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.sas_definition_item.SasDefinitionItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.sas_definition_item.SasDefinitionItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.sas_definition_item.SasDefinitionItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.sas_definition_item.SasDefinitionItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.sas_definition_item.SasDefinitionItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.sas_definition_item.SasDefinitionItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item.yml new file mode 100644 index 00000000..67482c63 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.sas_definition_item +name: sas_definition_item +fullName: azure.keyvault.v7_0.models.sas_definition_item +classes: +- azure.keyvault.v7_0.models.sas_definition_item.SasDefinitionItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item_paged.SasDefinitionItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item_paged.SasDefinitionItemPaged.yml new file mode 100644 index 00000000..eb2c67a6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item_paged.SasDefinitionItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.sas_definition_item_paged.SasDefinitionItemPaged +name: SasDefinitionItemPaged +fullName: azure.keyvault.v7_0.models.sas_definition_item_paged.SasDefinitionItemPaged +module: azure.keyvault.v7_0.models.sas_definition_item_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: SasDefinitionItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v7_0.models.sas_definition_item_paged.SasDefinitionItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v7_0.models.sas_definition_item_paged.SasDefinitionItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v7_0.models.sas_definition_item_paged.SasDefinitionItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.sas_definition_item_paged.SasDefinitionItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.sas_definition_item_paged.SasDefinitionItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v7_0.models.sas_definition_item_paged.SasDefinitionItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v7_0.models.sas_definition_item_paged.SasDefinitionItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item_paged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item_paged.yml new file mode 100644 index 00000000..3f868ed7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.sas_definition_item_paged +name: sas_definition_item_paged +fullName: azure.keyvault.v7_0.models.sas_definition_item_paged +classes: +- azure.keyvault.v7_0.models.sas_definition_item_paged.SasDefinitionItemPaged diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item_py3.SasDefinitionItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item_py3.SasDefinitionItem.yml new file mode 100644 index 00000000..29aa8264 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item_py3.SasDefinitionItem.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.sas_definition_item_py3.SasDefinitionItem +name: SasDefinitionItem +fullName: azure.keyvault.v7_0.models.sas_definition_item_py3.SasDefinitionItem +module: azure.keyvault.v7_0.models.sas_definition_item_py3 +summary: 'The SAS definition item containing storage SAS definition metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SasDefinitionItem(**kwargs) +variables: +- description: The storage SAS identifier. + name: id + types: + - +- description: The storage account SAS definition secret id. + name: secret_id + types: + - +- description: The SAS definition management attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs. + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v7_0.models.sas_definition_item_py3.SasDefinitionItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.sas_definition_item_py3.SasDefinitionItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.sas_definition_item_py3.SasDefinitionItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.sas_definition_item_py3.SasDefinitionItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.sas_definition_item_py3.SasDefinitionItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.sas_definition_item_py3.SasDefinitionItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.sas_definition_item_py3.SasDefinitionItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item_py3.yml new file mode 100644 index 00000000..fabce096 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.sas_definition_item_py3 +name: sas_definition_item_py3 +fullName: azure.keyvault.v7_0.models.sas_definition_item_py3 +classes: +- azure.keyvault.v7_0.models.sas_definition_item_py3.SasDefinitionItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_update_parameters.SasDefinitionUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_update_parameters.SasDefinitionUpdateParameters.yml new file mode 100644 index 00000000..5e20e6c6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_update_parameters.SasDefinitionUpdateParameters.yml @@ -0,0 +1,149 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.sas_definition_update_parameters.SasDefinitionUpdateParameters +name: SasDefinitionUpdateParameters +fullName: azure.keyvault.v7_0.models.sas_definition_update_parameters.SasDefinitionUpdateParameters +module: azure.keyvault.v7_0.models.sas_definition_update_parameters +summary: The SAS definition update parameters. +constructor: + syntax: SasDefinitionUpdateParameters(**kwargs) + parameters: + - name: template_uri + description: 'The SAS definition token template signed with an + + arbitrary key. Tokens created according to the SAS definition will have + + the same properties as the template.' + isRequired: true + types: + - + - name: sas_type + description: 'The type of SAS token the SAS definition will create. + + Possible values include: ''account'', ''service''' + isRequired: true + types: + - + - + - name: validity_period + description: 'The validity period of SAS tokens created + + according to the SAS definition.' + isRequired: true + types: + - + - name: sas_definition_attributes + description: The attributes of the SAS definition. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +methods: +- uid: azure.keyvault.v7_0.models.sas_definition_update_parameters.SasDefinitionUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.sas_definition_update_parameters.SasDefinitionUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.sas_definition_update_parameters.SasDefinitionUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.sas_definition_update_parameters.SasDefinitionUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.sas_definition_update_parameters.SasDefinitionUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.sas_definition_update_parameters.SasDefinitionUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.sas_definition_update_parameters.SasDefinitionUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_update_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_update_parameters.yml new file mode 100644 index 00000000..0ab41ec3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_update_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.sas_definition_update_parameters +name: sas_definition_update_parameters +fullName: azure.keyvault.v7_0.models.sas_definition_update_parameters +classes: +- azure.keyvault.v7_0.models.sas_definition_update_parameters.SasDefinitionUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.yml new file mode 100644 index 00000000..ee09f4f9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.yml @@ -0,0 +1,161 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters +name: SasDefinitionUpdateParameters +fullName: azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters +module: azure.keyvault.v7_0.models.sas_definition_update_parameters_py3 +summary: The SAS definition update parameters. +constructor: + syntax: 'SasDefinitionUpdateParameters(*, template_uri: str = None, sas_type=None, + validity_period: str = None, sas_definition_attributes=None, tags=None, **kwargs)' + parameters: + - name: template_uri + description: 'The SAS definition token template signed with an + + arbitrary key. Tokens created according to the SAS definition will have + + the same properties as the template.' + isRequired: true + types: + - + - name: sas_type + description: 'The type of SAS token the SAS definition will create. + + Possible values include: ''account'', ''service''' + isRequired: true + types: + - + - + - name: validity_period + description: 'The validity period of SAS tokens created + + according to the SAS definition.' + isRequired: true + types: + - + - name: sas_definition_attributes + description: The attributes of the SAS definition. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: template_uri + isRequired: true + - name: sas_type + isRequired: true + - name: validity_period + isRequired: true + - name: sas_definition_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.yml new file mode 100644 index 00000000..146aea5c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.sas_definition_update_parameters_py3 +name: sas_definition_update_parameters_py3 +fullName: azure.keyvault.v7_0.models.sas_definition_update_parameters_py3 +classes: +- azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_attributes.SecretAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_attributes.SecretAttributes.yml new file mode 100644 index 00000000..605b9004 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_attributes.SecretAttributes.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.secret_attributes.SecretAttributes +name: SecretAttributes +fullName: azure.keyvault.v7_0.models.secret_attributes.SecretAttributes +module: azure.keyvault.v7_0.models.secret_attributes +summary: 'The secret management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SecretAttributes(**kwargs) + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for secrets in the current vault. If it contains ''Purgeable'', the + + secret can be permanently deleted by a privileged user; otherwise, only + + the system can purge the secret, at the end of the retention interval. + + Possible values include: ''Purgeable'', ''Recoverable+Purgeable'', + + ''Recoverable'', ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v7_0.models.secret_attributes.SecretAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_attributes.SecretAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_attributes.SecretAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.secret_attributes.SecretAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_attributes.SecretAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.secret_attributes.SecretAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_attributes.SecretAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_attributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_attributes.yml new file mode 100644 index 00000000..4219adca --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_attributes.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.secret_attributes +name: secret_attributes +fullName: azure.keyvault.v7_0.models.secret_attributes +classes: +- azure.keyvault.v7_0.models.secret_attributes.SecretAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_attributes_py3.SecretAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_attributes_py3.SecretAttributes.yml new file mode 100644 index 00000000..2c08af72 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_attributes_py3.SecretAttributes.yml @@ -0,0 +1,167 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.secret_attributes_py3.SecretAttributes +name: SecretAttributes +fullName: azure.keyvault.v7_0.models.secret_attributes_py3.SecretAttributes +module: azure.keyvault.v7_0.models.secret_attributes_py3 +summary: 'The secret management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'SecretAttributes(*, enabled: bool = None, not_before=None, expires=None, + **kwargs)' + parameters: + - name: enabled + description: Determines whether the object is enabled. + isRequired: true + types: + - + - name: not_before + description: Not before date in UTC. + isRequired: true + types: + - + - name: expires + description: Expiry date in UTC. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true + - name: not_before + isRequired: true + - name: expires + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for secrets in the current vault. If it contains ''Purgeable'', the + + secret can be permanently deleted by a privileged user; otherwise, only + + the system can purge the secret, at the end of the retention interval. + + Possible values include: ''Purgeable'', ''Recoverable+Purgeable'', + + ''Recoverable'', ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v7_0.models.secret_attributes_py3.SecretAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_attributes_py3.SecretAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_attributes_py3.SecretAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.secret_attributes_py3.SecretAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_attributes_py3.SecretAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.secret_attributes_py3.SecretAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_attributes_py3.SecretAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_attributes_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_attributes_py3.yml new file mode 100644 index 00000000..8ad979a7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_attributes_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.secret_attributes_py3 +name: secret_attributes_py3 +fullName: azure.keyvault.v7_0.models.secret_attributes_py3 +classes: +- azure.keyvault.v7_0.models.secret_attributes_py3.SecretAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_bundle.SecretBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_bundle.SecretBundle.yml new file mode 100644 index 00000000..825a25c0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_bundle.SecretBundle.yml @@ -0,0 +1,158 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.secret_bundle.SecretBundle +name: SecretBundle +fullName: azure.keyvault.v7_0.models.secret_bundle.SecretBundle +module: azure.keyvault.v7_0.models.secret_bundle +summary: 'A secret consisting of a value, id and its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SecretBundle(**kwargs) + parameters: + - name: value + description: The secret value. + isRequired: true + types: + - + - name: id + description: The secret id. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +variables: +- description: 'If this is a secret backing a KV certificate, then this field + + specifies the corresponding key backing the KV certificate.' + name: kid + types: + - +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a secret backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v7_0.models.secret_bundle.SecretBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_bundle.SecretBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_bundle.SecretBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.secret_bundle.SecretBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_bundle.SecretBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.secret_bundle.SecretBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_bundle.SecretBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_bundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_bundle.yml new file mode 100644 index 00000000..16d5bb49 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_bundle.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.secret_bundle +name: secret_bundle +fullName: azure.keyvault.v7_0.models.secret_bundle +classes: +- azure.keyvault.v7_0.models.secret_bundle.SecretBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_bundle_py3.SecretBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_bundle_py3.SecretBundle.yml new file mode 100644 index 00000000..1a6c6d45 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_bundle_py3.SecretBundle.yml @@ -0,0 +1,170 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.secret_bundle_py3.SecretBundle +name: SecretBundle +fullName: azure.keyvault.v7_0.models.secret_bundle_py3.SecretBundle +module: azure.keyvault.v7_0.models.secret_bundle_py3 +summary: 'A secret consisting of a value, id and its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'SecretBundle(*, value: str = None, id: str = None, content_type: str = + None, attributes=None, tags=None, **kwargs)' + parameters: + - name: value + description: The secret value. + isRequired: true + types: + - + - name: id + description: The secret id. + isRequired: true + types: + - + - name: content_type + description: The content type of the secret. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: value + isRequired: true + - name: id + isRequired: true + - name: content_type + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true +variables: +- description: 'If this is a secret backing a KV certificate, then this field + + specifies the corresponding key backing the KV certificate.' + name: kid + types: + - +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a secret backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v7_0.models.secret_bundle_py3.SecretBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_bundle_py3.SecretBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_bundle_py3.SecretBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.secret_bundle_py3.SecretBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_bundle_py3.SecretBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.secret_bundle_py3.SecretBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_bundle_py3.SecretBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_bundle_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_bundle_py3.yml new file mode 100644 index 00000000..f04cf170 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_bundle_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.secret_bundle_py3 +name: secret_bundle_py3 +fullName: azure.keyvault.v7_0.models.secret_bundle_py3 +classes: +- azure.keyvault.v7_0.models.secret_bundle_py3.SecretBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item.SecretItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item.SecretItem.yml new file mode 100644 index 00000000..8a2c32e8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item.SecretItem.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.secret_item.SecretItem +name: SecretItem +fullName: azure.keyvault.v7_0.models.secret_item.SecretItem +module: azure.keyvault.v7_0.models.secret_item +summary: 'The secret item containing secret metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: SecretItem(**kwargs) + parameters: + - name: id + description: Secret identifier. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - +variables: +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a key backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v7_0.models.secret_item.SecretItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_item.SecretItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_item.SecretItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.secret_item.SecretItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_item.SecretItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.secret_item.SecretItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_item.SecretItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item.yml new file mode 100644 index 00000000..ee4e6e10 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.secret_item +name: secret_item +fullName: azure.keyvault.v7_0.models.secret_item +classes: +- azure.keyvault.v7_0.models.secret_item.SecretItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item_paged.SecretItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item_paged.SecretItemPaged.yml new file mode 100644 index 00000000..4d050560 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item_paged.SecretItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.secret_item_paged.SecretItemPaged +name: SecretItemPaged +fullName: azure.keyvault.v7_0.models.secret_item_paged.SecretItemPaged +module: azure.keyvault.v7_0.models.secret_item_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: SecretItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v7_0.models.secret_item_paged.SecretItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v7_0.models.secret_item_paged.SecretItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v7_0.models.secret_item_paged.SecretItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.secret_item_paged.SecretItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.secret_item_paged.SecretItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v7_0.models.secret_item_paged.SecretItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v7_0.models.secret_item_paged.SecretItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item_paged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item_paged.yml new file mode 100644 index 00000000..b48f9e98 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.secret_item_paged +name: secret_item_paged +fullName: azure.keyvault.v7_0.models.secret_item_paged +classes: +- azure.keyvault.v7_0.models.secret_item_paged.SecretItemPaged diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item_py3.SecretItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item_py3.SecretItem.yml new file mode 100644 index 00000000..0bec9397 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item_py3.SecretItem.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.secret_item_py3.SecretItem +name: SecretItem +fullName: azure.keyvault.v7_0.models.secret_item_py3.SecretItem +module: azure.keyvault.v7_0.models.secret_item_py3 +summary: 'The secret item containing secret metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'SecretItem(*, id: str = None, attributes=None, tags=None, content_type: + str = None, **kwargs)' + parameters: + - name: id + description: Secret identifier. + isRequired: true + types: + - + - name: attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: attributes + isRequired: true + - name: tags + isRequired: true + - name: content_type + isRequired: true +variables: +- description: 'True if the secret''s lifetime is managed by key vault. If + + this is a key backing a certificate, then managed will be true.' + name: managed + types: + - +methods: +- uid: azure.keyvault.v7_0.models.secret_item_py3.SecretItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_item_py3.SecretItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_item_py3.SecretItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.secret_item_py3.SecretItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_item_py3.SecretItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.secret_item_py3.SecretItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_item_py3.SecretItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item_py3.yml new file mode 100644 index 00000000..d5a8e6dd --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.secret_item_py3 +name: secret_item_py3 +fullName: azure.keyvault.v7_0.models.secret_item_py3 +classes: +- azure.keyvault.v7_0.models.secret_item_py3.SecretItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_properties.SecretProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_properties.SecretProperties.yml new file mode 100644 index 00000000..88b44b8b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_properties.SecretProperties.yml @@ -0,0 +1,120 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.secret_properties.SecretProperties +name: SecretProperties +fullName: azure.keyvault.v7_0.models.secret_properties.SecretProperties +module: azure.keyvault.v7_0.models.secret_properties +summary: Properties of the key backing a certificate. +constructor: + syntax: SecretProperties(**kwargs) + parameters: + - name: content_type + description: The media type (MIME type). + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.models.secret_properties.SecretProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_properties.SecretProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_properties.SecretProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.secret_properties.SecretProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_properties.SecretProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.secret_properties.SecretProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_properties.SecretProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_properties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_properties.yml new file mode 100644 index 00000000..fe3583c8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_properties.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.secret_properties +name: secret_properties +fullName: azure.keyvault.v7_0.models.secret_properties +classes: +- azure.keyvault.v7_0.models.secret_properties.SecretProperties diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_properties_py3.SecretProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_properties_py3.SecretProperties.yml new file mode 100644 index 00000000..a1e73ccb --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_properties_py3.SecretProperties.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.secret_properties_py3.SecretProperties +name: SecretProperties +fullName: azure.keyvault.v7_0.models.secret_properties_py3.SecretProperties +module: azure.keyvault.v7_0.models.secret_properties_py3 +summary: Properties of the key backing a certificate. +constructor: + syntax: 'SecretProperties(*, content_type: str = None, **kwargs)' + parameters: + - name: content_type + description: The media type (MIME type). + isRequired: true + types: + - + keywordOnlyParameters: + - name: content_type + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.secret_properties_py3.SecretProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_properties_py3.SecretProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_properties_py3.SecretProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.secret_properties_py3.SecretProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_properties_py3.SecretProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.secret_properties_py3.SecretProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_properties_py3.SecretProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_properties_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_properties_py3.yml new file mode 100644 index 00000000..2d915437 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_properties_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.secret_properties_py3 +name: secret_properties_py3 +fullName: azure.keyvault.v7_0.models.secret_properties_py3 +classes: +- azure.keyvault.v7_0.models.secret_properties_py3.SecretProperties diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_restore_parameters.SecretRestoreParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_restore_parameters.SecretRestoreParameters.yml new file mode 100644 index 00000000..b5ab05fe --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_restore_parameters.SecretRestoreParameters.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.secret_restore_parameters.SecretRestoreParameters +name: SecretRestoreParameters +fullName: azure.keyvault.v7_0.models.secret_restore_parameters.SecretRestoreParameters +module: azure.keyvault.v7_0.models.secret_restore_parameters +summary: 'The secret restore parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: SecretRestoreParameters(**kwargs) + parameters: + - name: secret_bundle_backup + description: 'Required. The backup blob associated with a + + secret bundle.' + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.models.secret_restore_parameters.SecretRestoreParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_restore_parameters.SecretRestoreParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_restore_parameters.SecretRestoreParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.secret_restore_parameters.SecretRestoreParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_restore_parameters.SecretRestoreParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.secret_restore_parameters.SecretRestoreParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_restore_parameters.SecretRestoreParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_restore_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_restore_parameters.yml new file mode 100644 index 00000000..da2ac537 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_restore_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.secret_restore_parameters +name: secret_restore_parameters +fullName: azure.keyvault.v7_0.models.secret_restore_parameters +classes: +- azure.keyvault.v7_0.models.secret_restore_parameters.SecretRestoreParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_restore_parameters_py3.SecretRestoreParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_restore_parameters_py3.SecretRestoreParameters.yml new file mode 100644 index 00000000..ae2e876f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_restore_parameters_py3.SecretRestoreParameters.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.secret_restore_parameters_py3.SecretRestoreParameters +name: SecretRestoreParameters +fullName: azure.keyvault.v7_0.models.secret_restore_parameters_py3.SecretRestoreParameters +module: azure.keyvault.v7_0.models.secret_restore_parameters_py3 +summary: 'The secret restore parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SecretRestoreParameters(*, secret_bundle_backup: bytes, **kwargs)' + parameters: + - name: secret_bundle_backup + description: 'Required. The backup blob associated with a + + secret bundle.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: secret_bundle_backup + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.secret_restore_parameters_py3.SecretRestoreParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_restore_parameters_py3.SecretRestoreParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_restore_parameters_py3.SecretRestoreParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.secret_restore_parameters_py3.SecretRestoreParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_restore_parameters_py3.SecretRestoreParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.secret_restore_parameters_py3.SecretRestoreParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_restore_parameters_py3.SecretRestoreParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_restore_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_restore_parameters_py3.yml new file mode 100644 index 00000000..75605cdc --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_restore_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.secret_restore_parameters_py3 +name: secret_restore_parameters_py3 +fullName: azure.keyvault.v7_0.models.secret_restore_parameters_py3 +classes: +- azure.keyvault.v7_0.models.secret_restore_parameters_py3.SecretRestoreParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_set_parameters.SecretSetParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_set_parameters.SecretSetParameters.yml new file mode 100644 index 00000000..bd870370 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_set_parameters.SecretSetParameters.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.secret_set_parameters.SecretSetParameters +name: SecretSetParameters +fullName: azure.keyvault.v7_0.models.secret_set_parameters.SecretSetParameters +module: azure.keyvault.v7_0.models.secret_set_parameters +summary: 'The secret set parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: SecretSetParameters(**kwargs) + parameters: + - name: value + description: Required. The value of the secret. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - + - name: secret_attributes + description: The secret management attributes. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.models.secret_set_parameters.SecretSetParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_set_parameters.SecretSetParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_set_parameters.SecretSetParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.secret_set_parameters.SecretSetParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_set_parameters.SecretSetParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.secret_set_parameters.SecretSetParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_set_parameters.SecretSetParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_set_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_set_parameters.yml new file mode 100644 index 00000000..3581799f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_set_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.secret_set_parameters +name: secret_set_parameters +fullName: azure.keyvault.v7_0.models.secret_set_parameters +classes: +- azure.keyvault.v7_0.models.secret_set_parameters.SecretSetParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_set_parameters_py3.SecretSetParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_set_parameters_py3.SecretSetParameters.yml new file mode 100644 index 00000000..e57fee19 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_set_parameters_py3.SecretSetParameters.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.secret_set_parameters_py3.SecretSetParameters +name: SecretSetParameters +fullName: azure.keyvault.v7_0.models.secret_set_parameters_py3.SecretSetParameters +module: azure.keyvault.v7_0.models.secret_set_parameters_py3 +summary: 'The secret set parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SecretSetParameters(*, value: str, tags=None, content_type: str = None, + secret_attributes=None, **kwargs)' + parameters: + - name: value + description: Required. The value of the secret. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - + - name: secret_attributes + description: The secret management attributes. + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: tags + isRequired: true + - name: content_type + isRequired: true + - name: secret_attributes + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.secret_set_parameters_py3.SecretSetParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_set_parameters_py3.SecretSetParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_set_parameters_py3.SecretSetParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.secret_set_parameters_py3.SecretSetParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_set_parameters_py3.SecretSetParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.secret_set_parameters_py3.SecretSetParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_set_parameters_py3.SecretSetParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_set_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_set_parameters_py3.yml new file mode 100644 index 00000000..9cbb0f35 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_set_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.secret_set_parameters_py3 +name: secret_set_parameters_py3 +fullName: azure.keyvault.v7_0.models.secret_set_parameters_py3 +classes: +- azure.keyvault.v7_0.models.secret_set_parameters_py3.SecretSetParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_update_parameters.SecretUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_update_parameters.SecretUpdateParameters.yml new file mode 100644 index 00000000..1ffcfc71 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_update_parameters.SecretUpdateParameters.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.secret_update_parameters.SecretUpdateParameters +name: SecretUpdateParameters +fullName: azure.keyvault.v7_0.models.secret_update_parameters.SecretUpdateParameters +module: azure.keyvault.v7_0.models.secret_update_parameters +summary: The secret update parameters. +constructor: + syntax: SecretUpdateParameters(**kwargs) + parameters: + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - + - name: secret_attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +methods: +- uid: azure.keyvault.v7_0.models.secret_update_parameters.SecretUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_update_parameters.SecretUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_update_parameters.SecretUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.secret_update_parameters.SecretUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_update_parameters.SecretUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.secret_update_parameters.SecretUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_update_parameters.SecretUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_update_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_update_parameters.yml new file mode 100644 index 00000000..624e8393 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_update_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.secret_update_parameters +name: secret_update_parameters +fullName: azure.keyvault.v7_0.models.secret_update_parameters +classes: +- azure.keyvault.v7_0.models.secret_update_parameters.SecretUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_update_parameters_py3.SecretUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_update_parameters_py3.SecretUpdateParameters.yml new file mode 100644 index 00000000..34bac331 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_update_parameters_py3.SecretUpdateParameters.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.secret_update_parameters_py3.SecretUpdateParameters +name: SecretUpdateParameters +fullName: azure.keyvault.v7_0.models.secret_update_parameters_py3.SecretUpdateParameters +module: azure.keyvault.v7_0.models.secret_update_parameters_py3 +summary: The secret update parameters. +constructor: + syntax: 'SecretUpdateParameters(*, content_type: str = None, secret_attributes=None, + tags=None, **kwargs)' + parameters: + - name: content_type + description: Type of the secret value such as a password. + isRequired: true + types: + - + - name: secret_attributes + description: The secret management attributes. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: content_type + isRequired: true + - name: secret_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.secret_update_parameters_py3.SecretUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_update_parameters_py3.SecretUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_update_parameters_py3.SecretUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.secret_update_parameters_py3.SecretUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.secret_update_parameters_py3.SecretUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.secret_update_parameters_py3.SecretUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.secret_update_parameters_py3.SecretUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_update_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_update_parameters_py3.yml new file mode 100644 index 00000000..b4264776 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_update_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.secret_update_parameters_py3 +name: secret_update_parameters_py3 +fullName: azure.keyvault.v7_0.models.secret_update_parameters_py3 +classes: +- azure.keyvault.v7_0.models.secret_update_parameters_py3.SecretUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_attributes.StorageAccountAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_attributes.StorageAccountAttributes.yml new file mode 100644 index 00000000..79f7e681 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_attributes.StorageAccountAttributes.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.storage_account_attributes.StorageAccountAttributes +name: StorageAccountAttributes +fullName: azure.keyvault.v7_0.models.storage_account_attributes.StorageAccountAttributes +module: azure.keyvault.v7_0.models.storage_account_attributes +summary: 'The storage account management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: StorageAccountAttributes(**kwargs) + parameters: + - name: enabled + description: the enabled state of the object. + isRequired: true + types: + - +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for storage accounts in the current vault. If it contains + + ''Purgeable'' the storage account can be permanently deleted by a privileged + + user; otherwise, only the system can purge the storage account, at the end + + of the retention interval. Possible values include: ''Purgeable'', + + ''Recoverable+Purgeable'', ''Recoverable'', + + ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v7_0.models.storage_account_attributes.StorageAccountAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_account_attributes.StorageAccountAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_account_attributes.StorageAccountAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.storage_account_attributes.StorageAccountAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_account_attributes.StorageAccountAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.storage_account_attributes.StorageAccountAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_account_attributes.StorageAccountAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_attributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_attributes.yml new file mode 100644 index 00000000..66a46a32 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_attributes.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.storage_account_attributes +name: storage_account_attributes +fullName: azure.keyvault.v7_0.models.storage_account_attributes +classes: +- azure.keyvault.v7_0.models.storage_account_attributes.StorageAccountAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_attributes_py3.StorageAccountAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_attributes_py3.StorageAccountAttributes.yml new file mode 100644 index 00000000..25ee98bb --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_attributes_py3.StorageAccountAttributes.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.storage_account_attributes_py3.StorageAccountAttributes +name: StorageAccountAttributes +fullName: azure.keyvault.v7_0.models.storage_account_attributes_py3.StorageAccountAttributes +module: azure.keyvault.v7_0.models.storage_account_attributes_py3 +summary: 'The storage account management attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'StorageAccountAttributes(*, enabled: bool = None, **kwargs)' + parameters: + - name: enabled + description: the enabled state of the object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: enabled + isRequired: true +variables: +- description: Creation time in UTC. + name: created + types: + - +- description: Last updated time in UTC. + name: updated + types: + - +- description: 'Reflects the deletion recovery level currently in + + effect for storage accounts in the current vault. If it contains + + ''Purgeable'' the storage account can be permanently deleted by a privileged + + user; otherwise, only the system can purge the storage account, at the end + + of the retention interval. Possible values include: ''Purgeable'', + + ''Recoverable+Purgeable'', ''Recoverable'', + + ''Recoverable+ProtectedSubscription''' + name: recovery_level + types: + - + - +methods: +- uid: azure.keyvault.v7_0.models.storage_account_attributes_py3.StorageAccountAttributes.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_account_attributes_py3.StorageAccountAttributes.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_account_attributes_py3.StorageAccountAttributes.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.storage_account_attributes_py3.StorageAccountAttributes.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_account_attributes_py3.StorageAccountAttributes.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.storage_account_attributes_py3.StorageAccountAttributes.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_account_attributes_py3.StorageAccountAttributes.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_attributes_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_attributes_py3.yml new file mode 100644 index 00000000..9af67346 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_attributes_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.storage_account_attributes_py3 +name: storage_account_attributes_py3 +fullName: azure.keyvault.v7_0.models.storage_account_attributes_py3 +classes: +- azure.keyvault.v7_0.models.storage_account_attributes_py3.StorageAccountAttributes diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_create_parameters.StorageAccountCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_create_parameters.StorageAccountCreateParameters.yml new file mode 100644 index 00000000..18707aff --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_create_parameters.StorageAccountCreateParameters.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.storage_account_create_parameters.StorageAccountCreateParameters +name: StorageAccountCreateParameters +fullName: azure.keyvault.v7_0.models.storage_account_create_parameters.StorageAccountCreateParameters +module: azure.keyvault.v7_0.models.storage_account_create_parameters +summary: 'The storage account create parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: StorageAccountCreateParameters(**kwargs) + parameters: + - name: resource_id + description: Required. Storage account resource id. + isRequired: true + types: + - + - name: active_key_name + description: Required. Current active storage account key name. + isRequired: true + types: + - + - name: auto_regenerate_key + description: 'Required. whether keyvault should manage the + + storage account for the user.' + isRequired: true + types: + - + - name: regeneration_period + description: 'The key regeneration time duration specified + + in ISO-8601 format.' + isRequired: true + types: + - + - name: storage_account_attributes + description: The attributes of the storage account. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +methods: +- uid: azure.keyvault.v7_0.models.storage_account_create_parameters.StorageAccountCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_account_create_parameters.StorageAccountCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_account_create_parameters.StorageAccountCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.storage_account_create_parameters.StorageAccountCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_account_create_parameters.StorageAccountCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.storage_account_create_parameters.StorageAccountCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_account_create_parameters.StorageAccountCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_create_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_create_parameters.yml new file mode 100644 index 00000000..67c2c04a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_create_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.storage_account_create_parameters +name: storage_account_create_parameters +fullName: azure.keyvault.v7_0.models.storage_account_create_parameters +classes: +- azure.keyvault.v7_0.models.storage_account_create_parameters.StorageAccountCreateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.yml new file mode 100644 index 00000000..682111c7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.yml @@ -0,0 +1,167 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.storage_account_create_parameters_py3.StorageAccountCreateParameters +name: StorageAccountCreateParameters +fullName: azure.keyvault.v7_0.models.storage_account_create_parameters_py3.StorageAccountCreateParameters +module: azure.keyvault.v7_0.models.storage_account_create_parameters_py3 +summary: 'The storage account create parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'StorageAccountCreateParameters(*, resource_id: str, active_key_name: str, + auto_regenerate_key: bool, regeneration_period: str = None, storage_account_attributes=None, + tags=None, **kwargs)' + parameters: + - name: resource_id + description: Required. Storage account resource id. + isRequired: true + types: + - + - name: active_key_name + description: Required. Current active storage account key name. + isRequired: true + types: + - + - name: auto_regenerate_key + description: 'Required. whether keyvault should manage the + + storage account for the user.' + isRequired: true + types: + - + - name: regeneration_period + description: 'The key regeneration time duration specified + + in ISO-8601 format.' + isRequired: true + types: + - + - name: storage_account_attributes + description: The attributes of the storage account. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: resource_id + isRequired: true + - name: active_key_name + isRequired: true + - name: auto_regenerate_key + isRequired: true + - name: regeneration_period + isRequired: true + - name: storage_account_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_create_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_create_parameters_py3.yml new file mode 100644 index 00000000..57e3ea66 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_create_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.storage_account_create_parameters_py3 +name: storage_account_create_parameters_py3 +fullName: azure.keyvault.v7_0.models.storage_account_create_parameters_py3 +classes: +- azure.keyvault.v7_0.models.storage_account_create_parameters_py3.StorageAccountCreateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item.StorageAccountItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item.StorageAccountItem.yml new file mode 100644 index 00000000..9bab7687 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item.StorageAccountItem.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.storage_account_item.StorageAccountItem +name: StorageAccountItem +fullName: azure.keyvault.v7_0.models.storage_account_item.StorageAccountItem +module: azure.keyvault.v7_0.models.storage_account_item +summary: 'The storage account item containing storage account metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: StorageAccountItem(**kwargs) +variables: +- description: Storage identifier. + name: id + types: + - +- description: Storage account resource Id. + name: resource_id + types: + - +- description: The storage account management attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs. + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v7_0.models.storage_account_item.StorageAccountItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_account_item.StorageAccountItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_account_item.StorageAccountItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.storage_account_item.StorageAccountItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_account_item.StorageAccountItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.storage_account_item.StorageAccountItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_account_item.StorageAccountItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item.yml new file mode 100644 index 00000000..810b4776 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.storage_account_item +name: storage_account_item +fullName: azure.keyvault.v7_0.models.storage_account_item +classes: +- azure.keyvault.v7_0.models.storage_account_item.StorageAccountItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item_paged.StorageAccountItemPaged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item_paged.StorageAccountItemPaged.yml new file mode 100644 index 00000000..15ef2f41 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item_paged.StorageAccountItemPaged.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.storage_account_item_paged.StorageAccountItemPaged +name: StorageAccountItemPaged +fullName: azure.keyvault.v7_0.models.storage_account_item_paged.StorageAccountItemPaged +module: azure.keyvault.v7_0.models.storage_account_item_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: StorageAccountItemPaged(*args, **kwargs) +methods: +- uid: azure.keyvault.v7_0.models.storage_account_item_paged.StorageAccountItemPaged.advance_page + name: advance_page + summary: 'Force moving the cursor to the next azure call. + + + This method is for advanced usage, iterator protocol is preferred.' + signature: advance_page() -> List[Model] + return: + description: The current page list + types: + - + exceptions: + - type: StopIteration if no further page +- uid: azure.keyvault.v7_0.models.storage_account_item_paged.StorageAccountItemPaged.async_advance_page + name: async_advance_page + signature: async async_advance_page() +- uid: azure.keyvault.v7_0.models.storage_account_item_paged.StorageAccountItemPaged.async_get + name: async_get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: async async_get(url) + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.storage_account_item_paged.StorageAccountItemPaged.get + name: get + summary: 'Get an arbitrary page. + + + This resets the iterator and then fully consumes it to return the + + specific page **only**.' + signature: 'get(url: str) -> List[Model]' + parameters: + - name: url + description: URL to arbitrary page results. + isRequired: true + types: + - +- uid: azure.keyvault.v7_0.models.storage_account_item_paged.StorageAccountItemPaged.next + name: next + summary: Iterate through responses. + signature: next() +- uid: azure.keyvault.v7_0.models.storage_account_item_paged.StorageAccountItemPaged.reset + name: reset + summary: Reset iterator to first page. + signature: reset() -> None +attributes: +- uid: azure.keyvault.v7_0.models.storage_account_item_paged.StorageAccountItemPaged.raw + name: raw + summary: Get current page as ClientRawResponse. + return: + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item_paged.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item_paged.yml new file mode 100644 index 00000000..a3e48ecb --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.storage_account_item_paged +name: storage_account_item_paged +fullName: azure.keyvault.v7_0.models.storage_account_item_paged +classes: +- azure.keyvault.v7_0.models.storage_account_item_paged.StorageAccountItemPaged diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item_py3.StorageAccountItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item_py3.StorageAccountItem.yml new file mode 100644 index 00000000..3ddb4853 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item_py3.StorageAccountItem.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.storage_account_item_py3.StorageAccountItem +name: StorageAccountItem +fullName: azure.keyvault.v7_0.models.storage_account_item_py3.StorageAccountItem +module: azure.keyvault.v7_0.models.storage_account_item_py3 +summary: 'The storage account item containing storage account metadata. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: StorageAccountItem(**kwargs) +variables: +- description: Storage identifier. + name: id + types: + - +- description: Storage account resource Id. + name: resource_id + types: + - +- description: The storage account management attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs. + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v7_0.models.storage_account_item_py3.StorageAccountItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_account_item_py3.StorageAccountItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_account_item_py3.StorageAccountItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.storage_account_item_py3.StorageAccountItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_account_item_py3.StorageAccountItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.storage_account_item_py3.StorageAccountItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_account_item_py3.StorageAccountItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item_py3.yml new file mode 100644 index 00000000..721f723f --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.storage_account_item_py3 +name: storage_account_item_py3 +fullName: azure.keyvault.v7_0.models.storage_account_item_py3 +classes: +- azure.keyvault.v7_0.models.storage_account_item_py3.StorageAccountItem diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters.yml new file mode 100644 index 00000000..8c56af04 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters +name: StorageAccountRegenerteKeyParameters +fullName: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters +module: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters +summary: 'The storage account key regenerate parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: StorageAccountRegenerteKeyParameters(**kwargs) + parameters: + - name: key_name + description: Required. The storage account key name. + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters.yml new file mode 100644 index 00000000..0fb168d3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters +name: storage_account_regenerte_key_parameters +fullName: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters +classes: +- azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters.yml new file mode 100644 index 00000000..38821b03 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters +name: StorageAccountRegenerteKeyParameters +fullName: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters +module: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3 +summary: 'The storage account key regenerate parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'StorageAccountRegenerteKeyParameters(*, key_name: str, **kwargs)' + parameters: + - name: key_name + description: Required. The storage account key name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: key_name + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3.yml new file mode 100644 index 00000000..e0d4a0f5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3 +name: storage_account_regenerte_key_parameters_py3 +fullName: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3 +classes: +- azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_update_parameters.StorageAccountUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_update_parameters.StorageAccountUpdateParameters.yml new file mode 100644 index 00000000..cec0662e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_update_parameters.StorageAccountUpdateParameters.yml @@ -0,0 +1,144 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.storage_account_update_parameters.StorageAccountUpdateParameters +name: StorageAccountUpdateParameters +fullName: azure.keyvault.v7_0.models.storage_account_update_parameters.StorageAccountUpdateParameters +module: azure.keyvault.v7_0.models.storage_account_update_parameters +summary: The storage account update parameters. +constructor: + syntax: StorageAccountUpdateParameters(**kwargs) + parameters: + - name: active_key_name + description: The current active storage account key name. + isRequired: true + types: + - + - name: auto_regenerate_key + description: 'whether keyvault should manage the storage + + account for the user.' + isRequired: true + types: + - + - name: regeneration_period + description: 'The key regeneration time duration specified + + in ISO-8601 format.' + isRequired: true + types: + - + - name: storage_account_attributes + description: The attributes of the storage account. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] +methods: +- uid: azure.keyvault.v7_0.models.storage_account_update_parameters.StorageAccountUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_account_update_parameters.StorageAccountUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_account_update_parameters.StorageAccountUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.storage_account_update_parameters.StorageAccountUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_account_update_parameters.StorageAccountUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.storage_account_update_parameters.StorageAccountUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_account_update_parameters.StorageAccountUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_update_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_update_parameters.yml new file mode 100644 index 00000000..927ce8d7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_update_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.storage_account_update_parameters +name: storage_account_update_parameters +fullName: azure.keyvault.v7_0.models.storage_account_update_parameters +classes: +- azure.keyvault.v7_0.models.storage_account_update_parameters.StorageAccountUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.yml new file mode 100644 index 00000000..569658ac --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters +name: StorageAccountUpdateParameters +fullName: azure.keyvault.v7_0.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters +module: azure.keyvault.v7_0.models.storage_account_update_parameters_py3 +summary: The storage account update parameters. +constructor: + syntax: 'StorageAccountUpdateParameters(*, active_key_name: str = None, auto_regenerate_key: + bool = None, regeneration_period: str = None, storage_account_attributes=None, + tags=None, **kwargs)' + parameters: + - name: active_key_name + description: The current active storage account key name. + isRequired: true + types: + - + - name: auto_regenerate_key + description: 'whether keyvault should manage the storage + + account for the user.' + isRequired: true + types: + - + - name: regeneration_period + description: 'The key regeneration time duration specified + + in ISO-8601 format.' + isRequired: true + types: + - + - name: storage_account_attributes + description: The attributes of the storage account. + isRequired: true + types: + - + - name: tags + description: Application specific metadata in the form of key-value pairs. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: active_key_name + isRequired: true + - name: auto_regenerate_key + isRequired: true + - name: regeneration_period + isRequired: true + - name: storage_account_attributes + isRequired: true + - name: tags + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_update_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_update_parameters_py3.yml new file mode 100644 index 00000000..09e9bcf6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_update_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.storage_account_update_parameters_py3 +name: storage_account_update_parameters_py3 +fullName: azure.keyvault.v7_0.models.storage_account_update_parameters_py3 +classes: +- azure.keyvault.v7_0.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_bundle.StorageBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_bundle.StorageBundle.yml new file mode 100644 index 00000000..17fa09dd --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_bundle.StorageBundle.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.storage_bundle.StorageBundle +name: StorageBundle +fullName: azure.keyvault.v7_0.models.storage_bundle.StorageBundle +module: azure.keyvault.v7_0.models.storage_bundle +summary: 'A Storage account bundle consists of key vault storage account details plus + + its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: StorageBundle(**kwargs) +variables: +- description: The storage account id. + name: id + types: + - +- description: The storage account resource id. + name: resource_id + types: + - +- description: The current active storage account key name. + name: active_key_name + types: + - +- description: 'whether keyvault should manage the storage + + account for the user.' + name: auto_regenerate_key + types: + - +- description: 'The key regeneration time duration specified in + + ISO-8601 format.' + name: regeneration_period + types: + - +- description: The storage account attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v7_0.models.storage_bundle.StorageBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_bundle.StorageBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_bundle.StorageBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.storage_bundle.StorageBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_bundle.StorageBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.storage_bundle.StorageBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_bundle.StorageBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_bundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_bundle.yml new file mode 100644 index 00000000..2bafa6a2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_bundle.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.storage_bundle +name: storage_bundle +fullName: azure.keyvault.v7_0.models.storage_bundle +classes: +- azure.keyvault.v7_0.models.storage_bundle.StorageBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_bundle_py3.StorageBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_bundle_py3.StorageBundle.yml new file mode 100644 index 00000000..d3108b70 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_bundle_py3.StorageBundle.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.storage_bundle_py3.StorageBundle +name: StorageBundle +fullName: azure.keyvault.v7_0.models.storage_bundle_py3.StorageBundle +module: azure.keyvault.v7_0.models.storage_bundle_py3 +summary: 'A Storage account bundle consists of key vault storage account details plus + + its attributes. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: StorageBundle(**kwargs) +variables: +- description: The storage account id. + name: id + types: + - +- description: The storage account resource id. + name: resource_id + types: + - +- description: The current active storage account key name. + name: active_key_name + types: + - +- description: 'whether keyvault should manage the storage + + account for the user.' + name: auto_regenerate_key + types: + - +- description: 'The key regeneration time duration specified in + + ISO-8601 format.' + name: regeneration_period + types: + - +- description: The storage account attributes. + name: attributes + types: + - +- description: Application specific metadata in the form of key-value pairs + name: tags + types: + - [, ] +methods: +- uid: azure.keyvault.v7_0.models.storage_bundle_py3.StorageBundle.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_bundle_py3.StorageBundle.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_bundle_py3.StorageBundle.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.storage_bundle_py3.StorageBundle.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_bundle_py3.StorageBundle.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.storage_bundle_py3.StorageBundle.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_bundle_py3.StorageBundle.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_bundle_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_bundle_py3.yml new file mode 100644 index 00000000..d3115a68 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_bundle_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.storage_bundle_py3 +name: storage_bundle_py3 +fullName: azure.keyvault.v7_0.models.storage_bundle_py3 +classes: +- azure.keyvault.v7_0.models.storage_bundle_py3.StorageBundle diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_restore_parameters.StorageRestoreParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_restore_parameters.StorageRestoreParameters.yml new file mode 100644 index 00000000..4d867193 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_restore_parameters.StorageRestoreParameters.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.storage_restore_parameters.StorageRestoreParameters +name: StorageRestoreParameters +fullName: azure.keyvault.v7_0.models.storage_restore_parameters.StorageRestoreParameters +module: azure.keyvault.v7_0.models.storage_restore_parameters +summary: 'The secret restore parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: StorageRestoreParameters(**kwargs) + parameters: + - name: storage_bundle_backup + description: 'Required. The backup blob associated with a + + storage account.' + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.models.storage_restore_parameters.StorageRestoreParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_restore_parameters.StorageRestoreParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_restore_parameters.StorageRestoreParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.storage_restore_parameters.StorageRestoreParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_restore_parameters.StorageRestoreParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.storage_restore_parameters.StorageRestoreParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_restore_parameters.StorageRestoreParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_restore_parameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_restore_parameters.yml new file mode 100644 index 00000000..2ba2db12 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_restore_parameters.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.storage_restore_parameters +name: storage_restore_parameters +fullName: azure.keyvault.v7_0.models.storage_restore_parameters +classes: +- azure.keyvault.v7_0.models.storage_restore_parameters.StorageRestoreParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_restore_parameters_py3.StorageRestoreParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_restore_parameters_py3.StorageRestoreParameters.yml new file mode 100644 index 00000000..b31cc616 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_restore_parameters_py3.StorageRestoreParameters.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.storage_restore_parameters_py3.StorageRestoreParameters +name: StorageRestoreParameters +fullName: azure.keyvault.v7_0.models.storage_restore_parameters_py3.StorageRestoreParameters +module: azure.keyvault.v7_0.models.storage_restore_parameters_py3 +summary: 'The secret restore parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'StorageRestoreParameters(*, storage_bundle_backup: bytes, **kwargs)' + parameters: + - name: storage_bundle_backup + description: 'Required. The backup blob associated with a + + storage account.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: storage_bundle_backup + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.storage_restore_parameters_py3.StorageRestoreParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_restore_parameters_py3.StorageRestoreParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_restore_parameters_py3.StorageRestoreParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.storage_restore_parameters_py3.StorageRestoreParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.storage_restore_parameters_py3.StorageRestoreParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.storage_restore_parameters_py3.StorageRestoreParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.storage_restore_parameters_py3.StorageRestoreParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_restore_parameters_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_restore_parameters_py3.yml new file mode 100644 index 00000000..c70f7b3b --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_restore_parameters_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.storage_restore_parameters_py3 +name: storage_restore_parameters_py3 +fullName: azure.keyvault.v7_0.models.storage_restore_parameters_py3 +classes: +- azure.keyvault.v7_0.models.storage_restore_parameters_py3.StorageRestoreParameters diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.subject_alternative_names.SubjectAlternativeNames.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.subject_alternative_names.SubjectAlternativeNames.yml new file mode 100644 index 00000000..8e6542d1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.subject_alternative_names.SubjectAlternativeNames.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.subject_alternative_names.SubjectAlternativeNames +name: SubjectAlternativeNames +fullName: azure.keyvault.v7_0.models.subject_alternative_names.SubjectAlternativeNames +module: azure.keyvault.v7_0.models.subject_alternative_names +summary: The subject alternate names of a X509 object. +constructor: + syntax: SubjectAlternativeNames(**kwargs) + parameters: + - name: emails + description: Email addresses. + isRequired: true + types: + - [] + - name: dns_names + description: Domain names. + isRequired: true + types: + - [] + - name: upns + description: User principal names. + isRequired: true + types: + - [] +methods: +- uid: azure.keyvault.v7_0.models.subject_alternative_names.SubjectAlternativeNames.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.subject_alternative_names.SubjectAlternativeNames.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.subject_alternative_names.SubjectAlternativeNames.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.subject_alternative_names.SubjectAlternativeNames.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.subject_alternative_names.SubjectAlternativeNames.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.subject_alternative_names.SubjectAlternativeNames.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.subject_alternative_names.SubjectAlternativeNames.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.subject_alternative_names.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.subject_alternative_names.yml new file mode 100644 index 00000000..2a37a10d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.subject_alternative_names.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.subject_alternative_names +name: subject_alternative_names +fullName: azure.keyvault.v7_0.models.subject_alternative_names +classes: +- azure.keyvault.v7_0.models.subject_alternative_names.SubjectAlternativeNames diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.subject_alternative_names_py3.SubjectAlternativeNames.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.subject_alternative_names_py3.SubjectAlternativeNames.yml new file mode 100644 index 00000000..9682988a --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.subject_alternative_names_py3.SubjectAlternativeNames.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.subject_alternative_names_py3.SubjectAlternativeNames +name: SubjectAlternativeNames +fullName: azure.keyvault.v7_0.models.subject_alternative_names_py3.SubjectAlternativeNames +module: azure.keyvault.v7_0.models.subject_alternative_names_py3 +summary: The subject alternate names of a X509 object. +constructor: + syntax: SubjectAlternativeNames(*, emails=None, dns_names=None, upns=None, **kwargs) + parameters: + - name: emails + description: Email addresses. + isRequired: true + types: + - [] + - name: dns_names + description: Domain names. + isRequired: true + types: + - [] + - name: upns + description: User principal names. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: emails + isRequired: true + - name: dns_names + isRequired: true + - name: upns + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.subject_alternative_names_py3.SubjectAlternativeNames.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.subject_alternative_names_py3.SubjectAlternativeNames.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.subject_alternative_names_py3.SubjectAlternativeNames.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.subject_alternative_names_py3.SubjectAlternativeNames.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.subject_alternative_names_py3.SubjectAlternativeNames.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.subject_alternative_names_py3.SubjectAlternativeNames.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.subject_alternative_names_py3.SubjectAlternativeNames.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.subject_alternative_names_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.subject_alternative_names_py3.yml new file mode 100644 index 00000000..9ec0829c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.subject_alternative_names_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.subject_alternative_names_py3 +name: subject_alternative_names_py3 +fullName: azure.keyvault.v7_0.models.subject_alternative_names_py3 +classes: +- azure.keyvault.v7_0.models.subject_alternative_names_py3.SubjectAlternativeNames diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.trigger.Trigger.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.trigger.Trigger.yml new file mode 100644 index 00000000..49680f3c --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.trigger.Trigger.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.trigger.Trigger +name: Trigger +fullName: azure.keyvault.v7_0.models.trigger.Trigger +module: azure.keyvault.v7_0.models.trigger +summary: A condition to be satisfied for an action to be executed. +constructor: + syntax: Trigger(**kwargs) + parameters: + - name: lifetime_percentage + description: 'Percentage of lifetime at which to trigger. + + Value should be between 1 and 99.' + isRequired: true + types: + - + - name: days_before_expiry + description: 'Days before expiry to attempt renewal. Value + + should be between 1 and validity_in_months multiplied by 27. If + + validity_in_months is 36, then value should be between 1 and 972 (36 * + + 27).' + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.models.trigger.Trigger.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.trigger.Trigger.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.trigger.Trigger.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.trigger.Trigger.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.trigger.Trigger.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.trigger.Trigger.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.trigger.Trigger.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.trigger.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.trigger.yml new file mode 100644 index 00000000..b828f1b4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.trigger.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.trigger +name: trigger +fullName: azure.keyvault.v7_0.models.trigger +classes: +- azure.keyvault.v7_0.models.trigger.Trigger diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.trigger_py3.Trigger.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.trigger_py3.Trigger.yml new file mode 100644 index 00000000..57d2f3fd --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.trigger_py3.Trigger.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.trigger_py3.Trigger +name: Trigger +fullName: azure.keyvault.v7_0.models.trigger_py3.Trigger +module: azure.keyvault.v7_0.models.trigger_py3 +summary: A condition to be satisfied for an action to be executed. +constructor: + syntax: 'Trigger(*, lifetime_percentage: int = None, days_before_expiry: int = None, + **kwargs)' + parameters: + - name: lifetime_percentage + description: 'Percentage of lifetime at which to trigger. + + Value should be between 1 and 99.' + isRequired: true + types: + - + - name: days_before_expiry + description: 'Days before expiry to attempt renewal. Value + + should be between 1 and validity_in_months multiplied by 27. If + + validity_in_months is 36, then value should be between 1 and 972 (36 * + + 27).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: lifetime_percentage + isRequired: true + - name: days_before_expiry + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.trigger_py3.Trigger.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.trigger_py3.Trigger.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.trigger_py3.Trigger.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.trigger_py3.Trigger.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.trigger_py3.Trigger.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.trigger_py3.Trigger.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.trigger_py3.Trigger.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.trigger_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.trigger_py3.yml new file mode 100644 index 00000000..22fb1dee --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.trigger_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.trigger_py3 +name: trigger_py3 +fullName: azure.keyvault.v7_0.models.trigger_py3 +classes: +- azure.keyvault.v7_0.models.trigger_py3.Trigger diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.x509_certificate_properties.X509CertificateProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.x509_certificate_properties.X509CertificateProperties.yml new file mode 100644 index 00000000..0881f3d3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.x509_certificate_properties.X509CertificateProperties.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.x509_certificate_properties.X509CertificateProperties +name: X509CertificateProperties +fullName: azure.keyvault.v7_0.models.x509_certificate_properties.X509CertificateProperties +module: azure.keyvault.v7_0.models.x509_certificate_properties +summary: Properties of the X509 component of a certificate. +constructor: + syntax: X509CertificateProperties(**kwargs) + parameters: + - name: subject + description: 'The subject name. Should be a valid X509 distinguished + + Name.' + isRequired: true + types: + - + - name: ekus + description: The enhanced key usage. + isRequired: true + types: + - [] + - name: subject_alternative_names + description: The subject alternative names. + isRequired: true + types: + - + - name: key_usage + description: List of key usages. + isRequired: true + types: + - [ + - ] + - name: validity_in_months + description: 'The duration that the ceritifcate is valid in + + months.' + isRequired: true + types: + - +methods: +- uid: azure.keyvault.v7_0.models.x509_certificate_properties.X509CertificateProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.x509_certificate_properties.X509CertificateProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.x509_certificate_properties.X509CertificateProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.x509_certificate_properties.X509CertificateProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.x509_certificate_properties.X509CertificateProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.x509_certificate_properties.X509CertificateProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.x509_certificate_properties.X509CertificateProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.x509_certificate_properties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.x509_certificate_properties.yml new file mode 100644 index 00000000..ca369cc6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.x509_certificate_properties.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.x509_certificate_properties +name: x509_certificate_properties +fullName: azure.keyvault.v7_0.models.x509_certificate_properties +classes: +- azure.keyvault.v7_0.models.x509_certificate_properties.X509CertificateProperties diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.x509_certificate_properties_py3.X509CertificateProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.x509_certificate_properties_py3.X509CertificateProperties.yml new file mode 100644 index 00000000..b552f02e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.x509_certificate_properties_py3.X509CertificateProperties.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.keyvault.v7_0.models.x509_certificate_properties_py3.X509CertificateProperties +name: X509CertificateProperties +fullName: azure.keyvault.v7_0.models.x509_certificate_properties_py3.X509CertificateProperties +module: azure.keyvault.v7_0.models.x509_certificate_properties_py3 +summary: Properties of the X509 component of a certificate. +constructor: + syntax: 'X509CertificateProperties(*, subject: str = None, ekus=None, subject_alternative_names=None, + key_usage=None, validity_in_months: int = None, **kwargs)' + parameters: + - name: subject + description: 'The subject name. Should be a valid X509 distinguished + + Name.' + isRequired: true + types: + - + - name: ekus + description: The enhanced key usage. + isRequired: true + types: + - [] + - name: subject_alternative_names + description: The subject alternative names. + isRequired: true + types: + - + - name: key_usage + description: List of key usages. + isRequired: true + types: + - [ + - ] + - name: validity_in_months + description: 'The duration that the ceritifcate is valid in + + months.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: subject + isRequired: true + - name: ekus + isRequired: true + - name: subject_alternative_names + isRequired: true + - name: key_usage + isRequired: true + - name: validity_in_months + isRequired: true +methods: +- uid: azure.keyvault.v7_0.models.x509_certificate_properties_py3.X509CertificateProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.x509_certificate_properties_py3.X509CertificateProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.x509_certificate_properties_py3.X509CertificateProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.keyvault.v7_0.models.x509_certificate_properties_py3.X509CertificateProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.keyvault.v7_0.models.x509_certificate_properties_py3.X509CertificateProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.keyvault.v7_0.models.x509_certificate_properties_py3.X509CertificateProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.keyvault.v7_0.models.x509_certificate_properties_py3.X509CertificateProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.x509_certificate_properties_py3.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.x509_certificate_properties_py3.yml new file mode 100644 index 00000000..10d1e16e --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.x509_certificate_properties_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.models.x509_certificate_properties_py3 +name: x509_certificate_properties_py3 +fullName: azure.keyvault.v7_0.models.x509_certificate_properties_py3 +classes: +- azure.keyvault.v7_0.models.x509_certificate_properties_py3.X509CertificateProperties diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.yml new file mode 100644 index 00000000..b1b0434d --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.yml @@ -0,0 +1,275 @@ +### YamlMime:PythonPackage +uid: azure.keyvault.v7_0.models +name: models +fullName: azure.keyvault.v7_0.models +type: import +classes: +- azure.keyvault.v7_0.models.Action +- azure.keyvault.v7_0.models.AdministratorDetails +- azure.keyvault.v7_0.models.Attributes +- azure.keyvault.v7_0.models.BackupCertificateResult +- azure.keyvault.v7_0.models.BackupKeyResult +- azure.keyvault.v7_0.models.BackupSecretResult +- azure.keyvault.v7_0.models.BackupStorageResult +- azure.keyvault.v7_0.models.CertificateAttributes +- azure.keyvault.v7_0.models.CertificateBundle +- azure.keyvault.v7_0.models.CertificateCreateParameters +- azure.keyvault.v7_0.models.CertificateImportParameters +- azure.keyvault.v7_0.models.CertificateIssuerItem +- azure.keyvault.v7_0.models.CertificateIssuerItemPaged +- azure.keyvault.v7_0.models.CertificateIssuerSetParameters +- azure.keyvault.v7_0.models.CertificateIssuerUpdateParameters +- azure.keyvault.v7_0.models.CertificateItem +- azure.keyvault.v7_0.models.CertificateItemPaged +- azure.keyvault.v7_0.models.CertificateMergeParameters +- azure.keyvault.v7_0.models.CertificateOperation +- azure.keyvault.v7_0.models.CertificateOperationUpdateParameter +- azure.keyvault.v7_0.models.CertificatePolicy +- azure.keyvault.v7_0.models.CertificateRestoreParameters +- azure.keyvault.v7_0.models.CertificateUpdateParameters +- azure.keyvault.v7_0.models.Contact +- azure.keyvault.v7_0.models.Contacts +- azure.keyvault.v7_0.models.DeletedCertificateBundle +- azure.keyvault.v7_0.models.DeletedCertificateItem +- azure.keyvault.v7_0.models.DeletedCertificateItemPaged +- azure.keyvault.v7_0.models.DeletedKeyBundle +- azure.keyvault.v7_0.models.DeletedKeyItem +- azure.keyvault.v7_0.models.DeletedKeyItemPaged +- azure.keyvault.v7_0.models.DeletedSasDefinitionBundle +- azure.keyvault.v7_0.models.DeletedSasDefinitionItem +- azure.keyvault.v7_0.models.DeletedSasDefinitionItemPaged +- azure.keyvault.v7_0.models.DeletedSecretBundle +- azure.keyvault.v7_0.models.DeletedSecretItem +- azure.keyvault.v7_0.models.DeletedSecretItemPaged +- azure.keyvault.v7_0.models.DeletedStorageAccountItem +- azure.keyvault.v7_0.models.DeletedStorageAccountItemPaged +- azure.keyvault.v7_0.models.DeletedStorageBundle +- azure.keyvault.v7_0.models.Error +- azure.keyvault.v7_0.models.IssuerAttributes +- azure.keyvault.v7_0.models.IssuerBundle +- azure.keyvault.v7_0.models.IssuerCredentials +- azure.keyvault.v7_0.models.IssuerParameters +- azure.keyvault.v7_0.models.JsonWebKey +- azure.keyvault.v7_0.models.KeyAttributes +- azure.keyvault.v7_0.models.KeyBundle +- azure.keyvault.v7_0.models.KeyCreateParameters +- azure.keyvault.v7_0.models.KeyImportParameters +- azure.keyvault.v7_0.models.KeyItem +- azure.keyvault.v7_0.models.KeyItemPaged +- azure.keyvault.v7_0.models.KeyOperationResult +- azure.keyvault.v7_0.models.KeyOperationsParameters +- azure.keyvault.v7_0.models.KeyProperties +- azure.keyvault.v7_0.models.KeyRestoreParameters +- azure.keyvault.v7_0.models.KeySignParameters +- azure.keyvault.v7_0.models.KeyUpdateParameters +- azure.keyvault.v7_0.models.KeyVaultError +- azure.keyvault.v7_0.models.KeyVaultErrorException +- azure.keyvault.v7_0.models.KeyVerifyParameters +- azure.keyvault.v7_0.models.KeyVerifyResult +- azure.keyvault.v7_0.models.LifetimeAction +- azure.keyvault.v7_0.models.OrganizationDetails +- azure.keyvault.v7_0.models.PendingCertificateSigningRequestResult +- azure.keyvault.v7_0.models.SasDefinitionAttributes +- azure.keyvault.v7_0.models.SasDefinitionBundle +- azure.keyvault.v7_0.models.SasDefinitionCreateParameters +- azure.keyvault.v7_0.models.SasDefinitionItem +- azure.keyvault.v7_0.models.SasDefinitionItemPaged +- azure.keyvault.v7_0.models.SasDefinitionUpdateParameters +- azure.keyvault.v7_0.models.SecretAttributes +- azure.keyvault.v7_0.models.SecretBundle +- azure.keyvault.v7_0.models.SecretItem +- azure.keyvault.v7_0.models.SecretItemPaged +- azure.keyvault.v7_0.models.SecretProperties +- azure.keyvault.v7_0.models.SecretRestoreParameters +- azure.keyvault.v7_0.models.SecretSetParameters +- azure.keyvault.v7_0.models.SecretUpdateParameters +- azure.keyvault.v7_0.models.StorageAccountAttributes +- azure.keyvault.v7_0.models.StorageAccountCreateParameters +- azure.keyvault.v7_0.models.StorageAccountItem +- azure.keyvault.v7_0.models.StorageAccountItemPaged +- azure.keyvault.v7_0.models.StorageAccountRegenerteKeyParameters +- azure.keyvault.v7_0.models.StorageAccountUpdateParameters +- azure.keyvault.v7_0.models.StorageBundle +- azure.keyvault.v7_0.models.StorageRestoreParameters +- azure.keyvault.v7_0.models.SubjectAlternativeNames +- azure.keyvault.v7_0.models.Trigger +- azure.keyvault.v7_0.models.X509CertificateProperties +modules: +- azure.keyvault.v7_0.models.action +- azure.keyvault.v7_0.models.action_py3 +- azure.keyvault.v7_0.models.administrator_details +- azure.keyvault.v7_0.models.administrator_details_py3 +- azure.keyvault.v7_0.models.attributes +- azure.keyvault.v7_0.models.attributes_py3 +- azure.keyvault.v7_0.models.backup_certificate_result +- azure.keyvault.v7_0.models.backup_certificate_result_py3 +- azure.keyvault.v7_0.models.backup_key_result +- azure.keyvault.v7_0.models.backup_key_result_py3 +- azure.keyvault.v7_0.models.backup_secret_result +- azure.keyvault.v7_0.models.backup_secret_result_py3 +- azure.keyvault.v7_0.models.backup_storage_result +- azure.keyvault.v7_0.models.backup_storage_result_py3 +- azure.keyvault.v7_0.models.certificate_attributes +- azure.keyvault.v7_0.models.certificate_attributes_py3 +- azure.keyvault.v7_0.models.certificate_bundle +- azure.keyvault.v7_0.models.certificate_bundle_py3 +- azure.keyvault.v7_0.models.certificate_create_parameters +- azure.keyvault.v7_0.models.certificate_create_parameters_py3 +- azure.keyvault.v7_0.models.certificate_import_parameters +- azure.keyvault.v7_0.models.certificate_import_parameters_py3 +- azure.keyvault.v7_0.models.certificate_issuer_item +- azure.keyvault.v7_0.models.certificate_issuer_item_paged +- azure.keyvault.v7_0.models.certificate_issuer_item_py3 +- azure.keyvault.v7_0.models.certificate_issuer_set_parameters +- azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3 +- azure.keyvault.v7_0.models.certificate_issuer_update_parameters +- azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3 +- azure.keyvault.v7_0.models.certificate_item +- azure.keyvault.v7_0.models.certificate_item_paged +- azure.keyvault.v7_0.models.certificate_item_py3 +- azure.keyvault.v7_0.models.certificate_merge_parameters +- azure.keyvault.v7_0.models.certificate_merge_parameters_py3 +- azure.keyvault.v7_0.models.certificate_operation +- azure.keyvault.v7_0.models.certificate_operation_py3 +- azure.keyvault.v7_0.models.certificate_operation_update_parameter +- azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3 +- azure.keyvault.v7_0.models.certificate_policy +- azure.keyvault.v7_0.models.certificate_policy_py3 +- azure.keyvault.v7_0.models.certificate_restore_parameters +- azure.keyvault.v7_0.models.certificate_restore_parameters_py3 +- azure.keyvault.v7_0.models.certificate_update_parameters +- azure.keyvault.v7_0.models.certificate_update_parameters_py3 +- azure.keyvault.v7_0.models.contact +- azure.keyvault.v7_0.models.contact_py3 +- azure.keyvault.v7_0.models.contacts +- azure.keyvault.v7_0.models.contacts_py3 +- azure.keyvault.v7_0.models.deleted_certificate_bundle +- azure.keyvault.v7_0.models.deleted_certificate_bundle_py3 +- azure.keyvault.v7_0.models.deleted_certificate_item +- azure.keyvault.v7_0.models.deleted_certificate_item_paged +- azure.keyvault.v7_0.models.deleted_certificate_item_py3 +- azure.keyvault.v7_0.models.deleted_key_bundle +- azure.keyvault.v7_0.models.deleted_key_bundle_py3 +- azure.keyvault.v7_0.models.deleted_key_item +- azure.keyvault.v7_0.models.deleted_key_item_paged +- azure.keyvault.v7_0.models.deleted_key_item_py3 +- azure.keyvault.v7_0.models.deleted_sas_definition_bundle +- azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3 +- azure.keyvault.v7_0.models.deleted_sas_definition_item +- azure.keyvault.v7_0.models.deleted_sas_definition_item_paged +- azure.keyvault.v7_0.models.deleted_sas_definition_item_py3 +- azure.keyvault.v7_0.models.deleted_secret_bundle +- azure.keyvault.v7_0.models.deleted_secret_bundle_py3 +- azure.keyvault.v7_0.models.deleted_secret_item +- azure.keyvault.v7_0.models.deleted_secret_item_paged +- azure.keyvault.v7_0.models.deleted_secret_item_py3 +- azure.keyvault.v7_0.models.deleted_storage_account_item +- azure.keyvault.v7_0.models.deleted_storage_account_item_paged +- azure.keyvault.v7_0.models.deleted_storage_account_item_py3 +- azure.keyvault.v7_0.models.deleted_storage_bundle +- azure.keyvault.v7_0.models.deleted_storage_bundle_py3 +- azure.keyvault.v7_0.models.error +- azure.keyvault.v7_0.models.error_py3 +- azure.keyvault.v7_0.models.issuer_attributes +- azure.keyvault.v7_0.models.issuer_attributes_py3 +- azure.keyvault.v7_0.models.issuer_bundle +- azure.keyvault.v7_0.models.issuer_bundle_py3 +- azure.keyvault.v7_0.models.issuer_credentials +- azure.keyvault.v7_0.models.issuer_credentials_py3 +- azure.keyvault.v7_0.models.issuer_parameters +- azure.keyvault.v7_0.models.issuer_parameters_py3 +- azure.keyvault.v7_0.models.json_web_key +- azure.keyvault.v7_0.models.json_web_key_py3 +- azure.keyvault.v7_0.models.key_attributes +- azure.keyvault.v7_0.models.key_attributes_py3 +- azure.keyvault.v7_0.models.key_bundle +- azure.keyvault.v7_0.models.key_bundle_py3 +- azure.keyvault.v7_0.models.key_create_parameters +- azure.keyvault.v7_0.models.key_create_parameters_py3 +- azure.keyvault.v7_0.models.key_import_parameters +- azure.keyvault.v7_0.models.key_import_parameters_py3 +- azure.keyvault.v7_0.models.key_item +- azure.keyvault.v7_0.models.key_item_paged +- azure.keyvault.v7_0.models.key_item_py3 +- azure.keyvault.v7_0.models.key_operation_result +- azure.keyvault.v7_0.models.key_operation_result_py3 +- azure.keyvault.v7_0.models.key_operations_parameters +- azure.keyvault.v7_0.models.key_operations_parameters_py3 +- azure.keyvault.v7_0.models.key_properties +- azure.keyvault.v7_0.models.key_properties_py3 +- azure.keyvault.v7_0.models.key_restore_parameters +- azure.keyvault.v7_0.models.key_restore_parameters_py3 +- azure.keyvault.v7_0.models.key_sign_parameters +- azure.keyvault.v7_0.models.key_sign_parameters_py3 +- azure.keyvault.v7_0.models.key_update_parameters +- azure.keyvault.v7_0.models.key_update_parameters_py3 +- azure.keyvault.v7_0.models.key_vault_client_enums +- azure.keyvault.v7_0.models.key_vault_error +- azure.keyvault.v7_0.models.key_vault_error_py3 +- azure.keyvault.v7_0.models.key_verify_parameters +- azure.keyvault.v7_0.models.key_verify_parameters_py3 +- azure.keyvault.v7_0.models.key_verify_result +- azure.keyvault.v7_0.models.key_verify_result_py3 +- azure.keyvault.v7_0.models.lifetime_action +- azure.keyvault.v7_0.models.lifetime_action_py3 +- azure.keyvault.v7_0.models.organization_details +- azure.keyvault.v7_0.models.organization_details_py3 +- azure.keyvault.v7_0.models.pending_certificate_signing_request_result +- azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3 +- azure.keyvault.v7_0.models.sas_definition_attributes +- azure.keyvault.v7_0.models.sas_definition_attributes_py3 +- azure.keyvault.v7_0.models.sas_definition_bundle +- azure.keyvault.v7_0.models.sas_definition_bundle_py3 +- azure.keyvault.v7_0.models.sas_definition_create_parameters +- azure.keyvault.v7_0.models.sas_definition_create_parameters_py3 +- azure.keyvault.v7_0.models.sas_definition_item +- azure.keyvault.v7_0.models.sas_definition_item_paged +- azure.keyvault.v7_0.models.sas_definition_item_py3 +- azure.keyvault.v7_0.models.sas_definition_update_parameters +- azure.keyvault.v7_0.models.sas_definition_update_parameters_py3 +- azure.keyvault.v7_0.models.secret_attributes +- azure.keyvault.v7_0.models.secret_attributes_py3 +- azure.keyvault.v7_0.models.secret_bundle +- azure.keyvault.v7_0.models.secret_bundle_py3 +- azure.keyvault.v7_0.models.secret_item +- azure.keyvault.v7_0.models.secret_item_paged +- azure.keyvault.v7_0.models.secret_item_py3 +- azure.keyvault.v7_0.models.secret_properties +- azure.keyvault.v7_0.models.secret_properties_py3 +- azure.keyvault.v7_0.models.secret_restore_parameters +- azure.keyvault.v7_0.models.secret_restore_parameters_py3 +- azure.keyvault.v7_0.models.secret_set_parameters +- azure.keyvault.v7_0.models.secret_set_parameters_py3 +- azure.keyvault.v7_0.models.secret_update_parameters +- azure.keyvault.v7_0.models.secret_update_parameters_py3 +- azure.keyvault.v7_0.models.storage_account_attributes +- azure.keyvault.v7_0.models.storage_account_attributes_py3 +- azure.keyvault.v7_0.models.storage_account_create_parameters +- azure.keyvault.v7_0.models.storage_account_create_parameters_py3 +- azure.keyvault.v7_0.models.storage_account_item +- azure.keyvault.v7_0.models.storage_account_item_paged +- azure.keyvault.v7_0.models.storage_account_item_py3 +- azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters +- azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3 +- azure.keyvault.v7_0.models.storage_account_update_parameters +- azure.keyvault.v7_0.models.storage_account_update_parameters_py3 +- azure.keyvault.v7_0.models.storage_bundle +- azure.keyvault.v7_0.models.storage_bundle_py3 +- azure.keyvault.v7_0.models.storage_restore_parameters +- azure.keyvault.v7_0.models.storage_restore_parameters_py3 +- azure.keyvault.v7_0.models.subject_alternative_names +- azure.keyvault.v7_0.models.subject_alternative_names_py3 +- azure.keyvault.v7_0.models.trigger +- azure.keyvault.v7_0.models.trigger_py3 +- azure.keyvault.v7_0.models.x509_certificate_properties +- azure.keyvault.v7_0.models.x509_certificate_properties_py3 +enums: +- azure.keyvault.v7_0.models.ActionType +- azure.keyvault.v7_0.models.DeletionRecoveryLevel +- azure.keyvault.v7_0.models.JsonWebKeyCurveName +- azure.keyvault.v7_0.models.JsonWebKeyEncryptionAlgorithm +- azure.keyvault.v7_0.models.JsonWebKeyOperation +- azure.keyvault.v7_0.models.JsonWebKeySignatureAlgorithm +- azure.keyvault.v7_0.models.JsonWebKeyType +- azure.keyvault.v7_0.models.KeyUsageType +- azure.keyvault.v7_0.models.SasTokenType diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.version.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.version.yml new file mode 100644 index 00000000..c886e816 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.keyvault.v7_0.version +name: version +fullName: azure.keyvault.v7_0.version diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.yml new file mode 100644 index 00000000..0c1a2de5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonPackage +uid: azure.keyvault.v7_0 +name: v7_0 +fullName: azure.keyvault.v7_0 +type: import +classes: +- azure.keyvault.v7_0.KeyVaultClient +packages: +- azure.keyvault.v7_0.models +modules: +- azure.keyvault.v7_0.key_vault_client +- azure.keyvault.v7_0.version diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.version.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.version.yml new file mode 100644 index 00000000..0dadefdf --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.keyvault.version +name: version +fullName: azure.keyvault.version diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.yml new file mode 100644 index 00000000..822c8783 --- /dev/null +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.yml @@ -0,0 +1,40 @@ +### YamlMime:PythonPackage +uid: azure.keyvault +name: keyvault +fullName: azure.keyvault +type: rootImport +functions: +- uid: azure.keyvault.generate_pop_key + name: generate_pop_key + summary: 'Generates a key which can be used for Proof Of Possession token authentication. + + :return:' + signature: generate_pop_key() +classes: +- azure.keyvault.AccessToken +- azure.keyvault.CertificateId +- azure.keyvault.CertificateIssuerId +- azure.keyvault.CertificateOperationId +- azure.keyvault.HttpBearerChallenge +- azure.keyvault.HttpChallenge +- azure.keyvault.KeyId +- azure.keyvault.KeyVaultAuthBase +- azure.keyvault.KeyVaultAuthentication +- azure.keyvault.KeyVaultClient +- azure.keyvault.KeyVaultId +- azure.keyvault.SecretId +- azure.keyvault.StorageAccountId +- azure.keyvault.StorageSasDefinitionId +packages: +- azure.keyvault.http_bearer_challenge_cache +- azure.keyvault.v2016_10_01 +- azure.keyvault.v7_0 +modules: +- azure.keyvault.http_bearer_challenge +- azure.keyvault.http_challenge +- azure.keyvault.http_message_security +- azure.keyvault.key_vault_authentication +- azure.keyvault.key_vault_client +- azure.keyvault.key_vault_id +- azure.keyvault.models +- azure.keyvault.version diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.LogAnalyticsDataClient.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.LogAnalyticsDataClient.yml new file mode 100644 index 00000000..83ee78d7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.LogAnalyticsDataClient.yml @@ -0,0 +1,83 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.LogAnalyticsDataClient +name: LogAnalyticsDataClient +fullName: azure.loganalytics.LogAnalyticsDataClient +module: azure.loganalytics +summary: Log Analytics Data Plane Client +constructor: + syntax: LogAnalyticsDataClient(credentials, base_url=None) + parameters: + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +methods: +- uid: azure.loganalytics.LogAnalyticsDataClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None +- uid: azure.loganalytics.LogAnalyticsDataClient.query + name: query + summary: 'Execute an Analytics query. + + + Executes an Analytics query for data. + + [Here](https://dev.loganalytics.io/documentation/Using-the-API) is an + + example for using POST with an Analytics query.' + signature: query(workspace_id, body, custom_headers=None, raw=False, **operation_config) + parameters: + - name: workspace_id + description: 'ID of the workspace. This is Workspace ID from + + the Properties blade in the Azure portal.' + isRequired: true + types: + - + - name: body + description: 'The Analytics query. Learn more about the [Analytics + + query + + syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: QueryResults or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.loganalytics.models.ErrorResponseException diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.log_analytics_data_client.LogAnalyticsDataClient.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.log_analytics_data_client.LogAnalyticsDataClient.yml new file mode 100644 index 00000000..9de86f7a --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.log_analytics_data_client.LogAnalyticsDataClient.yml @@ -0,0 +1,83 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.log_analytics_data_client.LogAnalyticsDataClient +name: LogAnalyticsDataClient +fullName: azure.loganalytics.log_analytics_data_client.LogAnalyticsDataClient +module: azure.loganalytics.log_analytics_data_client +summary: Log Analytics Data Plane Client +constructor: + syntax: LogAnalyticsDataClient(credentials, base_url=None) + parameters: + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +methods: +- uid: azure.loganalytics.log_analytics_data_client.LogAnalyticsDataClient.close + name: close + summary: Close the client if keep_alive is True. + signature: close() -> None +- uid: azure.loganalytics.log_analytics_data_client.LogAnalyticsDataClient.query + name: query + summary: 'Execute an Analytics query. + + + Executes an Analytics query for data. + + [Here](https://dev.loganalytics.io/documentation/Using-the-API) is an + + example for using POST with an Analytics query.' + signature: query(workspace_id, body, custom_headers=None, raw=False, **operation_config) + parameters: + - name: workspace_id + description: 'ID of the workspace. This is Workspace ID from + + the Properties blade in the Azure portal.' + isRequired: true + types: + - + - name: body + description: 'The Analytics query. Learn more about the [Analytics + + query + + syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: QueryResults or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: azure.loganalytics.models.ErrorResponseException diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.log_analytics_data_client.LogAnalyticsDataClientConfiguration.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.log_analytics_data_client.LogAnalyticsDataClientConfiguration.yml new file mode 100644 index 00000000..7416f9e1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.log_analytics_data_client.LogAnalyticsDataClientConfiguration.yml @@ -0,0 +1,60 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.log_analytics_data_client.LogAnalyticsDataClientConfiguration +name: LogAnalyticsDataClientConfiguration +fullName: azure.loganalytics.log_analytics_data_client.LogAnalyticsDataClientConfiguration +module: azure.loganalytics.log_analytics_data_client +summary: 'Configuration for LogAnalyticsDataClient + + Note that all parameters used to create this instance are saved as instance + + attributes.' +constructor: + syntax: LogAnalyticsDataClientConfiguration(credentials, base_url=None) + parameters: + - name: credentials + description: 'Subscription credentials which uniquely identify + + client subscription.' + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - +methods: +- uid: azure.loganalytics.log_analytics_data_client.LogAnalyticsDataClientConfiguration.add_user_agent + name: add_user_agent + summary: Add value to current user agent with a space. + signature: 'add_user_agent(value: str) -> None' + parameters: + - name: value + description: value to add to user agent. + isRequired: true + types: + - +- uid: azure.loganalytics.log_analytics_data_client.LogAnalyticsDataClientConfiguration.load + name: load + signature: load(filepath) + parameters: + - name: filepath + isRequired: true +- uid: azure.loganalytics.log_analytics_data_client.LogAnalyticsDataClientConfiguration.save + name: save + summary: Save current configuration to file. + signature: save(filepath) + parameters: + - name: filepath + description: Path to file where settings will be saved. + isRequired: true + types: + - + exceptions: + - type: ValueError if supplied filepath cannot be written to. +attributes: +- uid: azure.loganalytics.log_analytics_data_client.LogAnalyticsDataClientConfiguration.enable_http_logger + name: enable_http_logger +- uid: azure.loganalytics.log_analytics_data_client.LogAnalyticsDataClientConfiguration.user_agent + name: user_agent + summary: The current user agent value. diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.log_analytics_data_client.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.log_analytics_data_client.yml new file mode 100644 index 00000000..2ebddd37 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.log_analytics_data_client.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.loganalytics.log_analytics_data_client +name: log_analytics_data_client +fullName: azure.loganalytics.log_analytics_data_client +classes: +- azure.loganalytics.log_analytics_data_client.LogAnalyticsDataClient +- azure.loganalytics.log_analytics_data_client.LogAnalyticsDataClientConfiguration diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.Column(class).yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.Column(class).yml new file mode 100644 index 00000000..55798c92 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.Column(class).yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.Column +name: Column +fullName: azure.loganalytics.models.Column +module: azure.loganalytics.models +summary: 'A table column. + + + A column in a table.' +constructor: + syntax: 'Column(*, name: str = None, type: str = None, **kwargs)' + parameters: + - name: name + description: The name of this column. + isRequired: true + types: + - + - name: type + description: The data type of this column. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: type + isRequired: true +methods: +- uid: azure.loganalytics.models.Column.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.Column.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.Column.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.loganalytics.models.Column.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.Column.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.loganalytics.models.Column.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.Column.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorDetail.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorDetail.yml new file mode 100644 index 00000000..3f6d8c12 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorDetail.yml @@ -0,0 +1,167 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.ErrorDetail +name: ErrorDetail +fullName: azure.loganalytics.models.ErrorDetail +module: azure.loganalytics.models +summary: 'Error details. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ErrorDetail(*, code: str, message: str, target: str = None, value: str + = None, resources=None, additional_properties=None, **kwargs)' + parameters: + - name: code + description: Required. The error's code. + isRequired: true + types: + - + - name: message + description: Required. A human readable error message. + isRequired: true + types: + - + - name: target + description: 'Indicates which property in the request is responsible for + + the error.' + isRequired: true + types: + - + - name: value + description: 'Indicates which value in ''target'' is responsible for the + + error.' + isRequired: true + types: + - + - name: resources + description: 'Indicates resources which were responsible for the + + error.' + isRequired: true + types: + - [] + - name: additional_properties + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true + - name: target + isRequired: true + - name: value + isRequired: true + - name: resources + isRequired: true + - name: additional_properties + isRequired: true +methods: +- uid: azure.loganalytics.models.ErrorDetail.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.ErrorDetail.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.ErrorDetail.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.loganalytics.models.ErrorDetail.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.ErrorDetail.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.loganalytics.models.ErrorDetail.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.ErrorDetail.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorInfo.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorInfo.yml new file mode 100644 index 00000000..2ce0d59a --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorInfo.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.ErrorInfo +name: ErrorInfo +fullName: azure.loganalytics.models.ErrorInfo +module: azure.loganalytics.models +summary: 'The code and message for an error. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ErrorInfo(*, code: str, message: str, details=None, innererror=None, additional_properties=None, + **kwargs)' + parameters: + - name: code + description: Required. A machine readable error code. + isRequired: true + types: + - + - name: message + description: Required. A human readable error message. + isRequired: true + types: + - + - name: details + description: error details. + isRequired: true + types: + - [] + - name: innererror + description: Inner error details if they exist. + isRequired: true + types: + - + - name: additional_properties + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true + - name: details + isRequired: true + - name: innererror + isRequired: true + - name: additional_properties + isRequired: true +methods: +- uid: azure.loganalytics.models.ErrorInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.ErrorInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.ErrorInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.loganalytics.models.ErrorInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.ErrorInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.loganalytics.models.ErrorInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.ErrorInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorResponse.yml new file mode 100644 index 00000000..57d69c59 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorResponse.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.ErrorResponse +name: ErrorResponse +fullName: azure.loganalytics.models.ErrorResponse +module: azure.loganalytics.models +summary: 'Error details. + + + Contains details when the response code indicates an error. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ErrorResponse(*, error, **kwargs) + parameters: + - name: error + description: Required. The error details. + isRequired: true + types: + - + keywordOnlyParameters: + - name: error + isRequired: true +methods: +- uid: azure.loganalytics.models.ErrorResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.ErrorResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.ErrorResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.loganalytics.models.ErrorResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.ErrorResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.loganalytics.models.ErrorResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.ErrorResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorResponseException.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorResponseException.yml new file mode 100644 index 00000000..85e68eb1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorResponseException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.ErrorResponseException +name: ErrorResponseException +fullName: azure.loganalytics.models.ErrorResponseException +module: azure.loganalytics.models +summary: 'Server responded with exception of type: ''ErrorResponse''.' +constructor: + syntax: ErrorResponseException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.loganalytics.models.ErrorResponseException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.loganalytics.models.ErrorResponseException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.loganalytics.models.ErrorResponseException.args + name: args diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.QueryBody.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.QueryBody.yml new file mode 100644 index 00000000..24d9caf0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.QueryBody.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.QueryBody +name: QueryBody +fullName: azure.loganalytics.models.QueryBody +module: azure.loganalytics.models +summary: 'The Analytics query. Learn more about the [Analytics query + + syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/). + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'QueryBody(*, query: str, timespan: str = None, workspaces=None, **kwargs)' + parameters: + - name: query + description: Required. The query to execute. + isRequired: true + types: + - + - name: timespan + description: 'Optional. The timespan over which to query data. This is + + an ISO8601 time period value. This timespan is applied in addition to any + + that are specified in the query expression.' + isRequired: true + types: + - + - name: workspaces + description: A list of workspaces that are included in the query. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: query + isRequired: true + - name: timespan + isRequired: true + - name: workspaces + isRequired: true +methods: +- uid: azure.loganalytics.models.QueryBody.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.QueryBody.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.QueryBody.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.loganalytics.models.QueryBody.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.QueryBody.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.loganalytics.models.QueryBody.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.QueryBody.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.QueryResults.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.QueryResults.yml new file mode 100644 index 00000000..54fcdb62 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.QueryResults.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.QueryResults +name: QueryResults +fullName: azure.loganalytics.models.QueryResults +module: azure.loganalytics.models +summary: 'A query response. + + + Contains the tables, columns & rows resulting from a query. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: QueryResults(*, tables, **kwargs) + parameters: + - name: tables + description: Required. The list of tables, columns and rows. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: tables + isRequired: true +methods: +- uid: azure.loganalytics.models.QueryResults.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.QueryResults.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.QueryResults.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.loganalytics.models.QueryResults.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.QueryResults.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.loganalytics.models.QueryResults.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.QueryResults.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.Table(class).yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.Table(class).yml new file mode 100644 index 00000000..ab7fe5b6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.Table(class).yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.Table +name: Table +fullName: azure.loganalytics.models.Table +module: azure.loganalytics.models +summary: 'A query response table. + + + Contains the columns and rows for one table in a query response. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Table(*, name: str, columns, rows, **kwargs)' + parameters: + - name: name + description: Required. The name of the table. + isRequired: true + types: + - + - name: columns + description: Required. The list of columns in this table. + isRequired: true + types: + - [] + - name: rows + description: Required. The resulting rows from this query. + isRequired: true + types: + - [[]] + keywordOnlyParameters: + - name: name + isRequired: true + - name: columns + isRequired: true + - name: rows + isRequired: true +methods: +- uid: azure.loganalytics.models.Table.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.Table.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.Table.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.loganalytics.models.Table.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.Table.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.loganalytics.models.Table.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.Table.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.column.Column.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.column.Column.yml new file mode 100644 index 00000000..716ed155 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.column.Column.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.column.Column +name: Column +fullName: azure.loganalytics.models.column.Column +module: azure.loganalytics.models.column +summary: 'A table column. + + + A column in a table.' +constructor: + syntax: Column(**kwargs) + parameters: + - name: name + description: The name of this column. + isRequired: true + types: + - + - name: type + description: The data type of this column. + isRequired: true + types: + - +methods: +- uid: azure.loganalytics.models.column.Column.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.column.Column.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.column.Column.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.loganalytics.models.column.Column.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.column.Column.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.loganalytics.models.column.Column.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.column.Column.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.column.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.column.yml new file mode 100644 index 00000000..7aaf8d6d --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.column.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.loganalytics.models.column +name: column +fullName: azure.loganalytics.models.column +classes: +- azure.loganalytics.models.column.Column diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.column_py3.Column.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.column_py3.Column.yml new file mode 100644 index 00000000..178bbcc1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.column_py3.Column.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.column_py3.Column +name: Column +fullName: azure.loganalytics.models.column_py3.Column +module: azure.loganalytics.models.column_py3 +summary: 'A table column. + + + A column in a table.' +constructor: + syntax: 'Column(*, name: str = None, type: str = None, **kwargs)' + parameters: + - name: name + description: The name of this column. + isRequired: true + types: + - + - name: type + description: The data type of this column. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: type + isRequired: true +methods: +- uid: azure.loganalytics.models.column_py3.Column.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.column_py3.Column.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.column_py3.Column.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.loganalytics.models.column_py3.Column.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.column_py3.Column.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.loganalytics.models.column_py3.Column.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.column_py3.Column.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.column_py3.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.column_py3.yml new file mode 100644 index 00000000..c11e8e8a --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.column_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.loganalytics.models.column_py3 +name: column_py3 +fullName: azure.loganalytics.models.column_py3 +classes: +- azure.loganalytics.models.column_py3.Column diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_detail.ErrorDetail.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_detail.ErrorDetail.yml new file mode 100644 index 00000000..bdbd9355 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_detail.ErrorDetail.yml @@ -0,0 +1,153 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.error_detail.ErrorDetail +name: ErrorDetail +fullName: azure.loganalytics.models.error_detail.ErrorDetail +module: azure.loganalytics.models.error_detail +summary: 'Error details. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ErrorDetail(**kwargs) + parameters: + - name: code + description: Required. The error's code. + isRequired: true + types: + - + - name: message + description: Required. A human readable error message. + isRequired: true + types: + - + - name: target + description: 'Indicates which property in the request is responsible for + + the error.' + isRequired: true + types: + - + - name: value + description: 'Indicates which value in ''target'' is responsible for the + + error.' + isRequired: true + types: + - + - name: resources + description: 'Indicates resources which were responsible for the + + error.' + isRequired: true + types: + - [] + - name: additional_properties + isRequired: true + types: + - +methods: +- uid: azure.loganalytics.models.error_detail.ErrorDetail.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.error_detail.ErrorDetail.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.error_detail.ErrorDetail.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.loganalytics.models.error_detail.ErrorDetail.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.error_detail.ErrorDetail.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.loganalytics.models.error_detail.ErrorDetail.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.error_detail.ErrorDetail.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_detail.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_detail.yml new file mode 100644 index 00000000..d14705c3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_detail.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.loganalytics.models.error_detail +name: error_detail +fullName: azure.loganalytics.models.error_detail +classes: +- azure.loganalytics.models.error_detail.ErrorDetail diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_detail_py3.ErrorDetail.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_detail_py3.ErrorDetail.yml new file mode 100644 index 00000000..f78155dc --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_detail_py3.ErrorDetail.yml @@ -0,0 +1,167 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.error_detail_py3.ErrorDetail +name: ErrorDetail +fullName: azure.loganalytics.models.error_detail_py3.ErrorDetail +module: azure.loganalytics.models.error_detail_py3 +summary: 'Error details. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ErrorDetail(*, code: str, message: str, target: str = None, value: str + = None, resources=None, additional_properties=None, **kwargs)' + parameters: + - name: code + description: Required. The error's code. + isRequired: true + types: + - + - name: message + description: Required. A human readable error message. + isRequired: true + types: + - + - name: target + description: 'Indicates which property in the request is responsible for + + the error.' + isRequired: true + types: + - + - name: value + description: 'Indicates which value in ''target'' is responsible for the + + error.' + isRequired: true + types: + - + - name: resources + description: 'Indicates resources which were responsible for the + + error.' + isRequired: true + types: + - [] + - name: additional_properties + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true + - name: target + isRequired: true + - name: value + isRequired: true + - name: resources + isRequired: true + - name: additional_properties + isRequired: true +methods: +- uid: azure.loganalytics.models.error_detail_py3.ErrorDetail.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.error_detail_py3.ErrorDetail.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.error_detail_py3.ErrorDetail.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.loganalytics.models.error_detail_py3.ErrorDetail.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.error_detail_py3.ErrorDetail.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.loganalytics.models.error_detail_py3.ErrorDetail.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.error_detail_py3.ErrorDetail.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_detail_py3.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_detail_py3.yml new file mode 100644 index 00000000..4d3cd9d3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_detail_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.loganalytics.models.error_detail_py3 +name: error_detail_py3 +fullName: azure.loganalytics.models.error_detail_py3 +classes: +- azure.loganalytics.models.error_detail_py3.ErrorDetail diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_info.ErrorInfo.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_info.ErrorInfo.yml new file mode 100644 index 00000000..542930f8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_info.ErrorInfo.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.error_info.ErrorInfo +name: ErrorInfo +fullName: azure.loganalytics.models.error_info.ErrorInfo +module: azure.loganalytics.models.error_info +summary: 'The code and message for an error. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ErrorInfo(**kwargs) + parameters: + - name: code + description: Required. A machine readable error code. + isRequired: true + types: + - + - name: message + description: Required. A human readable error message. + isRequired: true + types: + - + - name: details + description: error details. + isRequired: true + types: + - [] + - name: innererror + description: Inner error details if they exist. + isRequired: true + types: + - + - name: additional_properties + isRequired: true + types: + - +methods: +- uid: azure.loganalytics.models.error_info.ErrorInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.error_info.ErrorInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.error_info.ErrorInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.loganalytics.models.error_info.ErrorInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.error_info.ErrorInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.loganalytics.models.error_info.ErrorInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.error_info.ErrorInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_info.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_info.yml new file mode 100644 index 00000000..c975ee32 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.loganalytics.models.error_info +name: error_info +fullName: azure.loganalytics.models.error_info +classes: +- azure.loganalytics.models.error_info.ErrorInfo diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_info_py3.ErrorInfo.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_info_py3.ErrorInfo.yml new file mode 100644 index 00000000..e24ef87e --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_info_py3.ErrorInfo.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.error_info_py3.ErrorInfo +name: ErrorInfo +fullName: azure.loganalytics.models.error_info_py3.ErrorInfo +module: azure.loganalytics.models.error_info_py3 +summary: 'The code and message for an error. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ErrorInfo(*, code: str, message: str, details=None, innererror=None, additional_properties=None, + **kwargs)' + parameters: + - name: code + description: Required. A machine readable error code. + isRequired: true + types: + - + - name: message + description: Required. A human readable error message. + isRequired: true + types: + - + - name: details + description: error details. + isRequired: true + types: + - [] + - name: innererror + description: Inner error details if they exist. + isRequired: true + types: + - + - name: additional_properties + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true + - name: details + isRequired: true + - name: innererror + isRequired: true + - name: additional_properties + isRequired: true +methods: +- uid: azure.loganalytics.models.error_info_py3.ErrorInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.error_info_py3.ErrorInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.error_info_py3.ErrorInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.loganalytics.models.error_info_py3.ErrorInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.error_info_py3.ErrorInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.loganalytics.models.error_info_py3.ErrorInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.error_info_py3.ErrorInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_info_py3.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_info_py3.yml new file mode 100644 index 00000000..eb8e89cd --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.loganalytics.models.error_info_py3 +name: error_info_py3 +fullName: azure.loganalytics.models.error_info_py3 +classes: +- azure.loganalytics.models.error_info_py3.ErrorInfo diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response.ErrorResponse.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response.ErrorResponse.yml new file mode 100644 index 00000000..72732653 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response.ErrorResponse.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.error_response.ErrorResponse +name: ErrorResponse +fullName: azure.loganalytics.models.error_response.ErrorResponse +module: azure.loganalytics.models.error_response +summary: 'Error details. + + + Contains details when the response code indicates an error. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ErrorResponse(**kwargs) + parameters: + - name: error + description: Required. The error details. + isRequired: true + types: + - +methods: +- uid: azure.loganalytics.models.error_response.ErrorResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.error_response.ErrorResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.error_response.ErrorResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.loganalytics.models.error_response.ErrorResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.error_response.ErrorResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.loganalytics.models.error_response.ErrorResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.error_response.ErrorResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response.ErrorResponseException.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response.ErrorResponseException.yml new file mode 100644 index 00000000..11ad59d8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response.ErrorResponseException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.error_response.ErrorResponseException +name: ErrorResponseException +fullName: azure.loganalytics.models.error_response.ErrorResponseException +module: azure.loganalytics.models.error_response +summary: 'Server responded with exception of type: ''ErrorResponse''.' +constructor: + syntax: ErrorResponseException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.loganalytics.models.error_response.ErrorResponseException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.loganalytics.models.error_response.ErrorResponseException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.loganalytics.models.error_response.ErrorResponseException.args + name: args diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response.yml new file mode 100644 index 00000000..626e21e6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.loganalytics.models.error_response +name: error_response +fullName: azure.loganalytics.models.error_response +classes: +- azure.loganalytics.models.error_response.ErrorResponse +- azure.loganalytics.models.error_response.ErrorResponseException diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response_py3.ErrorResponse.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response_py3.ErrorResponse.yml new file mode 100644 index 00000000..fda3d560 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response_py3.ErrorResponse.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.error_response_py3.ErrorResponse +name: ErrorResponse +fullName: azure.loganalytics.models.error_response_py3.ErrorResponse +module: azure.loganalytics.models.error_response_py3 +summary: 'Error details. + + + Contains details when the response code indicates an error. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ErrorResponse(*, error, **kwargs) + parameters: + - name: error + description: Required. The error details. + isRequired: true + types: + - + keywordOnlyParameters: + - name: error + isRequired: true +methods: +- uid: azure.loganalytics.models.error_response_py3.ErrorResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.error_response_py3.ErrorResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.error_response_py3.ErrorResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.loganalytics.models.error_response_py3.ErrorResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.error_response_py3.ErrorResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.loganalytics.models.error_response_py3.ErrorResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.error_response_py3.ErrorResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response_py3.ErrorResponseException.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response_py3.ErrorResponseException.yml new file mode 100644 index 00000000..6d2036c7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response_py3.ErrorResponseException.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.error_response_py3.ErrorResponseException +name: ErrorResponseException +fullName: azure.loganalytics.models.error_response_py3.ErrorResponseException +module: azure.loganalytics.models.error_response_py3 +summary: 'Server responded with exception of type: ''ErrorResponse''.' +constructor: + syntax: ErrorResponseException(deserialize, response, *args) + parameters: + - name: deserialize + description: A deserializer + isRequired: true + - name: response + description: Server response to be deserialized. + isRequired: true +methods: +- uid: azure.loganalytics.models.error_response_py3.ErrorResponseException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.loganalytics.models.error_response_py3.ErrorResponseException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.loganalytics.models.error_response_py3.ErrorResponseException.args + name: args diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response_py3.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response_py3.yml new file mode 100644 index 00000000..c5274056 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_response_py3.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.loganalytics.models.error_response_py3 +name: error_response_py3 +fullName: azure.loganalytics.models.error_response_py3 +classes: +- azure.loganalytics.models.error_response_py3.ErrorResponse +- azure.loganalytics.models.error_response_py3.ErrorResponseException diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_body.QueryBody.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_body.QueryBody.yml new file mode 100644 index 00000000..34e05bfa --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_body.QueryBody.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.query_body.QueryBody +name: QueryBody +fullName: azure.loganalytics.models.query_body.QueryBody +module: azure.loganalytics.models.query_body +summary: 'The Analytics query. Learn more about the [Analytics query + + syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/). + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: QueryBody(**kwargs) + parameters: + - name: query + description: Required. The query to execute. + isRequired: true + types: + - + - name: timespan + description: 'Optional. The timespan over which to query data. This is + + an ISO8601 time period value. This timespan is applied in addition to any + + that are specified in the query expression.' + isRequired: true + types: + - + - name: workspaces + description: A list of workspaces that are included in the query. + isRequired: true + types: + - [] +methods: +- uid: azure.loganalytics.models.query_body.QueryBody.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.query_body.QueryBody.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.query_body.QueryBody.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.loganalytics.models.query_body.QueryBody.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.query_body.QueryBody.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.loganalytics.models.query_body.QueryBody.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.query_body.QueryBody.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_body.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_body.yml new file mode 100644 index 00000000..4caef794 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_body.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.loganalytics.models.query_body +name: query_body +fullName: azure.loganalytics.models.query_body +classes: +- azure.loganalytics.models.query_body.QueryBody diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_body_py3.QueryBody.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_body_py3.QueryBody.yml new file mode 100644 index 00000000..51b174a4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_body_py3.QueryBody.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.query_body_py3.QueryBody +name: QueryBody +fullName: azure.loganalytics.models.query_body_py3.QueryBody +module: azure.loganalytics.models.query_body_py3 +summary: 'The Analytics query. Learn more about the [Analytics query + + syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/). + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'QueryBody(*, query: str, timespan: str = None, workspaces=None, **kwargs)' + parameters: + - name: query + description: Required. The query to execute. + isRequired: true + types: + - + - name: timespan + description: 'Optional. The timespan over which to query data. This is + + an ISO8601 time period value. This timespan is applied in addition to any + + that are specified in the query expression.' + isRequired: true + types: + - + - name: workspaces + description: A list of workspaces that are included in the query. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: query + isRequired: true + - name: timespan + isRequired: true + - name: workspaces + isRequired: true +methods: +- uid: azure.loganalytics.models.query_body_py3.QueryBody.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.query_body_py3.QueryBody.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.query_body_py3.QueryBody.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.loganalytics.models.query_body_py3.QueryBody.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.query_body_py3.QueryBody.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.loganalytics.models.query_body_py3.QueryBody.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.query_body_py3.QueryBody.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_body_py3.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_body_py3.yml new file mode 100644 index 00000000..62a403b3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_body_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.loganalytics.models.query_body_py3 +name: query_body_py3 +fullName: azure.loganalytics.models.query_body_py3 +classes: +- azure.loganalytics.models.query_body_py3.QueryBody diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_results.QueryResults.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_results.QueryResults.yml new file mode 100644 index 00000000..fc8eb836 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_results.QueryResults.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.query_results.QueryResults +name: QueryResults +fullName: azure.loganalytics.models.query_results.QueryResults +module: azure.loganalytics.models.query_results +summary: 'A query response. + + + Contains the tables, columns & rows resulting from a query. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: QueryResults(**kwargs) + parameters: + - name: tables + description: Required. The list of tables, columns and rows. + isRequired: true + types: + - [] +methods: +- uid: azure.loganalytics.models.query_results.QueryResults.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.query_results.QueryResults.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.query_results.QueryResults.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.loganalytics.models.query_results.QueryResults.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.query_results.QueryResults.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.loganalytics.models.query_results.QueryResults.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.query_results.QueryResults.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_results.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_results.yml new file mode 100644 index 00000000..ed21cfea --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_results.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.loganalytics.models.query_results +name: query_results +fullName: azure.loganalytics.models.query_results +classes: +- azure.loganalytics.models.query_results.QueryResults diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_results_py3.QueryResults.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_results_py3.QueryResults.yml new file mode 100644 index 00000000..41ee227b --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_results_py3.QueryResults.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.query_results_py3.QueryResults +name: QueryResults +fullName: azure.loganalytics.models.query_results_py3.QueryResults +module: azure.loganalytics.models.query_results_py3 +summary: 'A query response. + + + Contains the tables, columns & rows resulting from a query. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: QueryResults(*, tables, **kwargs) + parameters: + - name: tables + description: Required. The list of tables, columns and rows. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: tables + isRequired: true +methods: +- uid: azure.loganalytics.models.query_results_py3.QueryResults.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.query_results_py3.QueryResults.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.query_results_py3.QueryResults.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.loganalytics.models.query_results_py3.QueryResults.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.query_results_py3.QueryResults.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.loganalytics.models.query_results_py3.QueryResults.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.query_results_py3.QueryResults.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_results_py3.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_results_py3.yml new file mode 100644 index 00000000..98bc2616 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_results_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.loganalytics.models.query_results_py3 +name: query_results_py3 +fullName: azure.loganalytics.models.query_results_py3 +classes: +- azure.loganalytics.models.query_results_py3.QueryResults diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.table.Table.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.table.Table.yml new file mode 100644 index 00000000..f80d64b0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.table.Table.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.table.Table +name: Table +fullName: azure.loganalytics.models.table.Table +module: azure.loganalytics.models.table +summary: 'A query response table. + + + Contains the columns and rows for one table in a query response. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Table(**kwargs) + parameters: + - name: name + description: Required. The name of the table. + isRequired: true + types: + - + - name: columns + description: Required. The list of columns in this table. + isRequired: true + types: + - [] + - name: rows + description: Required. The resulting rows from this query. + isRequired: true + types: + - [[]] +methods: +- uid: azure.loganalytics.models.table.Table.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.table.Table.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.table.Table.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.loganalytics.models.table.Table.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.table.Table.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.loganalytics.models.table.Table.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.table.Table.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.table.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.table.yml new file mode 100644 index 00000000..2be1ee09 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.table.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.loganalytics.models.table +name: table +fullName: azure.loganalytics.models.table +classes: +- azure.loganalytics.models.table.Table diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.table_py3.Table.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.table_py3.Table.yml new file mode 100644 index 00000000..97fedcda --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.table_py3.Table.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.loganalytics.models.table_py3.Table +name: Table +fullName: azure.loganalytics.models.table_py3.Table +module: azure.loganalytics.models.table_py3 +summary: 'A query response table. + + + Contains the columns and rows for one table in a query response. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Table(*, name: str, columns, rows, **kwargs)' + parameters: + - name: name + description: Required. The name of the table. + isRequired: true + types: + - + - name: columns + description: Required. The list of columns in this table. + isRequired: true + types: + - [] + - name: rows + description: Required. The resulting rows from this query. + isRequired: true + types: + - [[]] + keywordOnlyParameters: + - name: name + isRequired: true + - name: columns + isRequired: true + - name: rows + isRequired: true +methods: +- uid: azure.loganalytics.models.table_py3.Table.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.table_py3.Table.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.table_py3.Table.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.loganalytics.models.table_py3.Table.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.loganalytics.models.table_py3.Table.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.loganalytics.models.table_py3.Table.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.loganalytics.models.table_py3.Table.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.table_py3.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.table_py3.yml new file mode 100644 index 00000000..aca908b2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.table_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.loganalytics.models.table_py3 +name: table_py3 +fullName: azure.loganalytics.models.table_py3 +classes: +- azure.loganalytics.models.table_py3.Table diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.yml new file mode 100644 index 00000000..7ca5adae --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonPackage +uid: azure.loganalytics.models +name: models +fullName: azure.loganalytics.models +type: import +classes: +- azure.loganalytics.models.Column +- azure.loganalytics.models.ErrorDetail +- azure.loganalytics.models.ErrorInfo +- azure.loganalytics.models.ErrorResponse +- azure.loganalytics.models.ErrorResponseException +- azure.loganalytics.models.QueryBody +- azure.loganalytics.models.QueryResults +- azure.loganalytics.models.Table +modules: +- azure.loganalytics.models.column +- azure.loganalytics.models.column_py3 +- azure.loganalytics.models.error_detail +- azure.loganalytics.models.error_detail_py3 +- azure.loganalytics.models.error_info +- azure.loganalytics.models.error_info_py3 +- azure.loganalytics.models.error_response +- azure.loganalytics.models.error_response_py3 +- azure.loganalytics.models.query_body +- azure.loganalytics.models.query_body_py3 +- azure.loganalytics.models.query_results +- azure.loganalytics.models.query_results_py3 +- azure.loganalytics.models.table +- azure.loganalytics.models.table_py3 diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.version.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.version.yml new file mode 100644 index 00000000..88fe4726 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.loganalytics.version +name: version +fullName: azure.loganalytics.version diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.yml new file mode 100644 index 00000000..6ce21b65 --- /dev/null +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonPackage +uid: azure.loganalytics +name: loganalytics +fullName: azure.loganalytics +type: rootImport +classes: +- azure.loganalytics.LogAnalyticsDataClient +packages: +- azure.loganalytics.models +modules: +- azure.loganalytics.log_analytics_data_client +- azure.loganalytics.version diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.CertificateSource.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.CertificateSource.yml new file mode 100644 index 00000000..87ab92a0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.CertificateSource.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.CertificateSource +name: CertificateSource +fullName: azure.media.videoanalyzeredge.CertificateSource +module: azure.media.videoanalyzeredge +summary: 'Base class for certificate sources. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: PemCertificateList. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CertificateSource(**kwargs) +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +methods: +- uid: azure.media.videoanalyzeredge.CertificateSource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.CertificateSource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.CertificateSource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.CertificateSource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.CertificateSource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.CertificateSource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.CertificateSource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.CognitiveServicesVisionProcessor.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.CognitiveServicesVisionProcessor.yml new file mode 100644 index 00000000..24e77df0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.CognitiveServicesVisionProcessor.yml @@ -0,0 +1,195 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.CognitiveServicesVisionProcessor +name: CognitiveServicesVisionProcessor +fullName: azure.media.videoanalyzeredge.CognitiveServicesVisionProcessor +module: azure.media.videoanalyzeredge +summary: 'A processor that allows the pipeline topology to send video frames to a + Cognitive Services Vision extension. Inference results are relayed to downstream + nodes. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CognitiveServicesVisionProcessor(*, name: str, inputs: List[NodeInput], + endpoint: EndpointBase, operation: SpatialAnalysisOperationBase, image: ImageProperties + | None = None, sampling_options: SamplingOptions | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Node name. Must be unique within the topology. + types: + - + - name: inputs + description: 'Required. An array of upstream node references within the topology + to be used + + as inputs for this node.' + types: + - [] + - name: endpoint + description: Required. Endpoint to which this processor should connect. + types: + - + - name: image + description: Describes the parameters of the image that is sent as input to the + endpoint. + types: + - + - name: sampling_options + description: 'Describes the sampling options to be applied when forwarding samples + + to the extension.' + types: + - + - name: operation + description: 'Required. Describes the Spatial Analysis operation to be used in + the + + Cognitive Services Vision processor.' + types: + - +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. Node name. Must be unique within the topology. + name: name + types: + - +- description: 'Required. An array of upstream node references within the topology + to be used as + + inputs for this node.' + name: inputs + types: + - [] +- description: Required. Endpoint to which this processor should connect. + name: endpoint + types: + - +- description: Describes the parameters of the image that is sent as input to the + endpoint. + name: image + types: + - +- description: 'Describes the sampling options to be applied when forwarding samples + to + + the extension.' + name: sampling_options + types: + - +- description: 'Required. Describes the Spatial Analysis operation to be used in the + Cognitive + + Services Vision processor.' + name: operation + types: + - +methods: +- uid: azure.media.videoanalyzeredge.CognitiveServicesVisionProcessor.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.CognitiveServicesVisionProcessor.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.CognitiveServicesVisionProcessor.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.CognitiveServicesVisionProcessor.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.CognitiveServicesVisionProcessor.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.CognitiveServicesVisionProcessor.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.CognitiveServicesVisionProcessor.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.CredentialsBase.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.CredentialsBase.yml new file mode 100644 index 00000000..87117c1d --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.CredentialsBase.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.CredentialsBase +name: CredentialsBase +fullName: azure.media.videoanalyzeredge.CredentialsBase +module: azure.media.videoanalyzeredge +summary: 'Base class for credential objects. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: HttpHeaderCredentials, SymmetricKeyCredentials, UsernamePasswordCredentials. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CredentialsBase(**kwargs) +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +methods: +- uid: azure.media.videoanalyzeredge.CredentialsBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.CredentialsBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.CredentialsBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.CredentialsBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.CredentialsBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.CredentialsBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.CredentialsBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.DiscoveredOnvifDevice.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.DiscoveredOnvifDevice.yml new file mode 100644 index 00000000..b22cea55 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.DiscoveredOnvifDevice.yml @@ -0,0 +1,168 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.DiscoveredOnvifDevice +name: DiscoveredOnvifDevice +fullName: azure.media.videoanalyzeredge.DiscoveredOnvifDevice +module: azure.media.videoanalyzeredge +summary: The discovered properties of the ONVIF device that are returned during the + discovery. +constructor: + syntax: 'DiscoveredOnvifDevice(*, service_identifier: str | None = None, remote_ip_address: + str | None = None, scopes: List[str] | None = None, endpoints: List[str] | None + = None, **kwargs)' + keywordOnlyParameters: + - name: service_identifier + description: 'The unique identifier of the ONVIF device that was discovered in + + the same subnet as the IoT Edge device.' + types: + - + - name: remote_ip_address + description: 'The IP address of the ONVIF device that was discovered in the same + + subnet as the IoT Edge device.' + types: + - + - name: scopes + description: 'An array of hostnames for the ONVIF discovered devices that are + in the same + + subnet as the IoT Edge device.' + types: + - [] + - name: endpoints + description: 'An array of media profile endpoints that the ONVIF discovered device + + supports.' + types: + - [] +variables: +- description: 'The unique identifier of the ONVIF device that was discovered in the + + same subnet as the IoT Edge device.' + name: service_identifier + types: + - +- description: 'The IP address of the ONVIF device that was discovered in the same + + subnet as the IoT Edge device.' + name: remote_ip_address + types: + - +- description: 'An array of hostnames for the ONVIF discovered devices that are in + the same + + subnet as the IoT Edge device.' + name: scopes + types: + - [] +- description: An array of media profile endpoints that the ONVIF discovered device + supports. + name: endpoints + types: + - [] +methods: +- uid: azure.media.videoanalyzeredge.DiscoveredOnvifDevice.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.DiscoveredOnvifDevice.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.DiscoveredOnvifDevice.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.DiscoveredOnvifDevice.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.DiscoveredOnvifDevice.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.DiscoveredOnvifDevice.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.DiscoveredOnvifDevice.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.DiscoveredOnvifDeviceCollection.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.DiscoveredOnvifDeviceCollection.yml new file mode 100644 index 00000000..61967b6d --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.DiscoveredOnvifDeviceCollection.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.DiscoveredOnvifDeviceCollection +name: DiscoveredOnvifDeviceCollection +fullName: azure.media.videoanalyzeredge.DiscoveredOnvifDeviceCollection +module: azure.media.videoanalyzeredge +summary: A list of ONVIF devices that were discovered in the same subnet as the IoT + Edge device. +constructor: + syntax: 'DiscoveredOnvifDeviceCollection(*, value: List[DiscoveredOnvifDevice] | + None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: 'An array of ONVIF devices that have been discovered in the same + subnet as the + + IoT Edge device.' + types: + - [] +variables: +- description: 'An array of ONVIF devices that have been discovered in the same subnet + as the IoT + + Edge device.' + name: value + types: + - [] +methods: +- uid: azure.media.videoanalyzeredge.DiscoveredOnvifDeviceCollection.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.DiscoveredOnvifDeviceCollection.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.DiscoveredOnvifDeviceCollection.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.DiscoveredOnvifDeviceCollection.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.DiscoveredOnvifDeviceCollection.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.DiscoveredOnvifDeviceCollection.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.DiscoveredOnvifDeviceCollection.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.EndpointBase.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.EndpointBase.yml new file mode 100644 index 00000000..f9d0537a --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.EndpointBase.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.EndpointBase +name: EndpointBase +fullName: azure.media.videoanalyzeredge.EndpointBase +module: azure.media.videoanalyzeredge +summary: 'Base class for endpoints. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: TlsEndpoint, UnsecuredEndpoint. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EndpointBase(*, url: str, credentials: CredentialsBase | None = None, **kwargs)' + keywordOnlyParameters: + - name: credentials + description: Credentials to be presented to the endpoint. + types: + - + - name: url + description: Required. The endpoint URL for Video Analyzer to connect to. + types: + - +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Credentials to be presented to the endpoint. + name: credentials + types: + - +- description: Required. The endpoint URL for Video Analyzer to connect to. + name: url + types: + - +methods: +- uid: azure.media.videoanalyzeredge.EndpointBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.EndpointBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.EndpointBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.EndpointBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.EndpointBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.EndpointBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.EndpointBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ExtensionProcessorBase.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ExtensionProcessorBase.yml new file mode 100644 index 00000000..18412ae2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ExtensionProcessorBase.yml @@ -0,0 +1,189 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.ExtensionProcessorBase +name: ExtensionProcessorBase +fullName: azure.media.videoanalyzeredge.ExtensionProcessorBase +module: azure.media.videoanalyzeredge +summary: 'Base class for pipeline extension processors. Pipeline extensions allow + for custom media analysis and processing to be plugged into the Video Analyzer pipeline. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: GrpcExtension, HttpExtension. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ExtensionProcessorBase(*, name: str, inputs: List[NodeInput], endpoint: + EndpointBase, image: ImageProperties, sampling_options: SamplingOptions | None + = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Node name. Must be unique within the topology. + types: + - + - name: inputs + description: 'Required. An array of upstream node references within the topology + to be used + + as inputs for this node.' + types: + - [] + - name: endpoint + description: Required. Endpoint details of the pipeline extension plugin. + types: + - + - name: image + description: 'Required. Image transformations and formatting options to be applied + to the + + video frame(s) prior submission to the pipeline extension plugin.' + types: + - + - name: sampling_options + description: 'Media sampling parameters that define how often media is submitted + + to the extension plugin.' + types: + - +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. Node name. Must be unique within the topology. + name: name + types: + - +- description: 'Required. An array of upstream node references within the topology + to be used as + + inputs for this node.' + name: inputs + types: + - [] +- description: Required. Endpoint details of the pipeline extension plugin. + name: endpoint + types: + - +- description: 'Required. Image transformations and formatting options to be applied + to the video + + frame(s) prior submission to the pipeline extension plugin.' + name: image + types: + - +- description: 'Media sampling parameters that define how often media is submitted + to + + the extension plugin.' + name: sampling_options + types: + - +methods: +- uid: azure.media.videoanalyzeredge.ExtensionProcessorBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ExtensionProcessorBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ExtensionProcessorBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.ExtensionProcessorBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ExtensionProcessorBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.ExtensionProcessorBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ExtensionProcessorBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.FileSink.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.FileSink.yml new file mode 100644 index 00000000..5b7cfe1a --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.FileSink.yml @@ -0,0 +1,188 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.FileSink +name: FileSink +fullName: azure.media.videoanalyzeredge.FileSink +module: azure.media.videoanalyzeredge +summary: 'File sink allows for video and audio content to be recorded on the file + system on the edge device. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'FileSink(*, name: str, inputs: List[NodeInput], base_directory_path: str, + file_name_pattern: str, maximum_size_mi_b: str, **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Node name. Must be unique within the topology. + types: + - + - name: inputs + description: 'Required. An array of upstream node references within the topology + to be used + + as inputs for this node.' + types: + - [] + - name: base_directory_path + description: 'Required. Absolute directory path where media files will be + + stored.' + types: + - + - name: file_name_pattern + description: 'Required. File name pattern for creating new files when performing + + event based recording. The pattern must include at least one system variable.' + types: + - + - name: maximum_size_mi_b + description: 'Required. Maximum amount of disk space that can be used for storing + + files from this sink. Once this limit is reached, the oldest files from this + sink will be + + automatically deleted.' + types: + - +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. Node name. Must be unique within the topology. + name: name + types: + - +- description: 'Required. An array of upstream node references within the topology + to be used as + + inputs for this node.' + name: inputs + types: + - [] +- description: Required. Absolute directory path where media files will be stored. + name: base_directory_path + types: + - +- description: 'Required. File name pattern for creating new files when performing + + event based recording. The pattern must include at least one system variable.' + name: file_name_pattern + types: + - +- description: 'Required. Maximum amount of disk space that can be used for storing + + files from this sink. Once this limit is reached, the oldest files from this sink + will be + + automatically deleted.' + name: maximum_size_mi_b + types: + - +methods: +- uid: azure.media.videoanalyzeredge.FileSink.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.FileSink.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.FileSink.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.FileSink.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.FileSink.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.FileSink.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.FileSink.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.GrpcExtension.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.GrpcExtension.yml new file mode 100644 index 00000000..3de4329b --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.GrpcExtension.yml @@ -0,0 +1,215 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.GrpcExtension +name: GrpcExtension +fullName: azure.media.videoanalyzeredge.GrpcExtension +module: azure.media.videoanalyzeredge +summary: 'GRPC extension processor allows pipeline extension plugins to be connected + to the pipeline through over a gRPC channel. Extension plugins must act as an gRPC + server. Please see [https://aka.ms/ava-extension-grpc](https://aka.ms/ava-extension-grpc) + for details. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'GrpcExtension(*, name: str, inputs: List[NodeInput], endpoint: EndpointBase, + image: ImageProperties, data_transfer: GrpcExtensionDataTransfer, sampling_options: + SamplingOptions | None = None, extension_configuration: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Node name. Must be unique within the topology. + types: + - + - name: inputs + description: 'Required. An array of upstream node references within the topology + to be used + + as inputs for this node.' + types: + - [] + - name: endpoint + description: Required. Endpoint details of the pipeline extension plugin. + types: + - + - name: image + description: 'Required. Image transformations and formatting options to be applied + to the + + video frame(s) prior submission to the pipeline extension plugin.' + types: + - + - name: sampling_options + description: 'Media sampling parameters that define how often media is submitted + + to the extension plugin.' + types: + - + - name: data_transfer + description: Required. Specifies how media is transferred to the extension plugin. + types: + - + - name: extension_configuration + description: 'An optional configuration string that is sent to the + + extension plugin. The configuration string is specific to each custom extension + and it not + + understood neither validated by Video Analyzer. Please see [https://aka.ms/ava-extension-grpc](https://aka.ms/ava-extension-grpc) + + for details.' + types: + - +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. Node name. Must be unique within the topology. + name: name + types: + - +- description: 'Required. An array of upstream node references within the topology + to be used as + + inputs for this node.' + name: inputs + types: + - [] +- description: Required. Endpoint details of the pipeline extension plugin. + name: endpoint + types: + - +- description: 'Required. Image transformations and formatting options to be applied + to the video + + frame(s) prior submission to the pipeline extension plugin.' + name: image + types: + - +- description: 'Media sampling parameters that define how often media is submitted + to + + the extension plugin.' + name: sampling_options + types: + - +- description: Required. Specifies how media is transferred to the extension plugin. + name: data_transfer + types: + - +- description: 'An optional configuration string that is sent to the extension + + plugin. The configuration string is specific to each custom extension and it not + understood + + neither validated by Video Analyzer. Please see [https://aka.ms/ava-extension-grpc](https://aka.ms/ava-extension-grpc) + for details.' + name: extension_configuration + types: + - +methods: +- uid: azure.media.videoanalyzeredge.GrpcExtension.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.GrpcExtension.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.GrpcExtension.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.GrpcExtension.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.GrpcExtension.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.GrpcExtension.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.GrpcExtension.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.GrpcExtensionDataTransfer.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.GrpcExtensionDataTransfer.yml new file mode 100644 index 00000000..304a210a --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.GrpcExtensionDataTransfer.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.GrpcExtensionDataTransfer +name: GrpcExtensionDataTransfer +fullName: azure.media.videoanalyzeredge.GrpcExtensionDataTransfer +module: azure.media.videoanalyzeredge +summary: 'Describes how media is transferred to the extension plugin. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'GrpcExtensionDataTransfer(*, mode: str | GrpcExtensionDataTransferMode, + shared_memory_size_mi_b: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: shared_memory_size_mi_b + description: 'The share memory buffer for sample transfers, in mebibytes. + + It can only be used with the ''SharedMemory'' transfer mode.' + types: + - + - name: mode + description: 'Required. Data transfer mode: embedded or sharedMemory. Possible + values include: + + "embedded", "sharedMemory".' + types: + - + - +variables: +- description: 'The share memory buffer for sample transfers, in mebibytes. It + + can only be used with the ''SharedMemory'' transfer mode.' + name: shared_memory_size_mi_b + types: + - +- description: 'Required. Data transfer mode: embedded or sharedMemory. Possible values + include: + + "embedded", "sharedMemory".' + name: mode + types: + - + - +methods: +- uid: azure.media.videoanalyzeredge.GrpcExtensionDataTransfer.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.GrpcExtensionDataTransfer.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.GrpcExtensionDataTransfer.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.GrpcExtensionDataTransfer.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.GrpcExtensionDataTransfer.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.GrpcExtensionDataTransfer.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.GrpcExtensionDataTransfer.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.GrpcExtensionDataTransferMode.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.GrpcExtensionDataTransferMode.yml new file mode 100644 index 00000000..02906ff6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.GrpcExtensionDataTransferMode.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.media.videoanalyzeredge.GrpcExtensionDataTransferMode +name: GrpcExtensionDataTransferMode +fullName: azure.media.videoanalyzeredge.GrpcExtensionDataTransferMode +summary: 'Data transfer mode: embedded or sharedMemory.' +module: azure.media.videoanalyzeredge +fields: +- name: EMBEDDED + uid: azure.media.videoanalyzeredge.GrpcExtensionDataTransferMode.EMBEDDED +- name: SHARED_MEMORY + uid: azure.media.videoanalyzeredge.GrpcExtensionDataTransferMode.SHARED_MEMORY diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.H264Configuration.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.H264Configuration.yml new file mode 100644 index 00000000..348775a4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.H264Configuration.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.H264Configuration +name: H264Configuration +fullName: azure.media.videoanalyzeredge.H264Configuration +module: azure.media.videoanalyzeredge +summary: Class representing the H264 Configuration. +constructor: + syntax: 'H264Configuration(*, gov_length: float | None = None, profile: str | H264Profile + | None = None, **kwargs)' + keywordOnlyParameters: + - name: gov_length + description: Group of Video frames length. + types: + - + - name: profile + description: 'The H264 Profile. Possible values include: "Baseline", "Main", "Extended", + + "High".' + types: + - + - +variables: +- description: Group of Video frames length. + name: gov_length + types: + - +- description: 'The H264 Profile. Possible values include: "Baseline", "Main", "Extended", + + "High".' + name: profile + types: + - + - +methods: +- uid: azure.media.videoanalyzeredge.H264Configuration.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.H264Configuration.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.H264Configuration.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.H264Configuration.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.H264Configuration.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.H264Configuration.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.H264Configuration.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.H264Profile.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.H264Profile.yml new file mode 100644 index 00000000..5df912d3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.H264Profile.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.media.videoanalyzeredge.H264Profile +name: H264Profile +fullName: azure.media.videoanalyzeredge.H264Profile +summary: The H264 Profile +module: azure.media.videoanalyzeredge +fields: +- name: BASELINE + uid: azure.media.videoanalyzeredge.H264Profile.BASELINE +- name: EXTENDED + uid: azure.media.videoanalyzeredge.H264Profile.EXTENDED +- name: HIGH + uid: azure.media.videoanalyzeredge.H264Profile.HIGH +- name: MAIN + uid: azure.media.videoanalyzeredge.H264Profile.MAIN diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.HttpExtension.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.HttpExtension.yml new file mode 100644 index 00000000..e32d6138 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.HttpExtension.yml @@ -0,0 +1,185 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.HttpExtension +name: HttpExtension +fullName: azure.media.videoanalyzeredge.HttpExtension +module: azure.media.videoanalyzeredge +summary: 'HTTP extension processor allows pipeline extension plugins to be connected + to the pipeline through over the HTTP protocol. Extension plugins must act as an + HTTP server. Please see [https://aka.ms/ava-extension-http](https://aka.ms/ava-extension-http) + for details. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'HttpExtension(*, name: str, inputs: List[NodeInput], endpoint: EndpointBase, + image: ImageProperties, sampling_options: SamplingOptions | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Node name. Must be unique within the topology. + types: + - + - name: inputs + description: 'Required. An array of upstream node references within the topology + to be used + + as inputs for this node.' + types: + - [] + - name: endpoint + description: Required. Endpoint details of the pipeline extension plugin. + types: + - + - name: image + description: 'Required. Image transformations and formatting options to be applied + to the + + video frame(s) prior submission to the pipeline extension plugin.' + types: + - + - name: sampling_options + description: 'Media sampling parameters that define how often media is submitted + + to the extension plugin.' + types: + - +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. Node name. Must be unique within the topology. + name: name + types: + - +- description: 'Required. An array of upstream node references within the topology + to be used as + + inputs for this node.' + name: inputs + types: + - [] +- description: Required. Endpoint details of the pipeline extension plugin. + name: endpoint + types: + - +- description: 'Required. Image transformations and formatting options to be applied + to the video + + frame(s) prior submission to the pipeline extension plugin.' + name: image + types: + - +- description: 'Media sampling parameters that define how often media is submitted + to + + the extension plugin.' + name: sampling_options + types: + - +methods: +- uid: azure.media.videoanalyzeredge.HttpExtension.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.HttpExtension.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.HttpExtension.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.HttpExtension.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.HttpExtension.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.HttpExtension.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.HttpExtension.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.HttpHeaderCredentials.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.HttpHeaderCredentials.yml new file mode 100644 index 00000000..1422dc42 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.HttpHeaderCredentials.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.HttpHeaderCredentials +name: HttpHeaderCredentials +fullName: azure.media.videoanalyzeredge.HttpHeaderCredentials +module: azure.media.videoanalyzeredge +summary: 'HTTP header credentials. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'HttpHeaderCredentials(*, header_name: str, header_value: str, **kwargs)' + keywordOnlyParameters: + - name: header_name + description: Required. HTTP header name. + types: + - + - name: header_value + description: 'Required. HTTP header value. It is recommended that this value is + + parameterized as a secret string in order to prevent this value to be returned + as part of the + + resource on API requests.' + types: + - +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. HTTP header name. + name: header_name + types: + - +- description: 'Required. HTTP header value. It is recommended that this value is + + parameterized as a secret string in order to prevent this value to be returned + as part of the + + resource on API requests.' + name: header_value + types: + - +methods: +- uid: azure.media.videoanalyzeredge.HttpHeaderCredentials.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.HttpHeaderCredentials.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.HttpHeaderCredentials.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.HttpHeaderCredentials.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.HttpHeaderCredentials.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.HttpHeaderCredentials.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.HttpHeaderCredentials.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatBmp.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatBmp.yml new file mode 100644 index 00000000..869eb094 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatBmp.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.ImageFormatBmp +name: ImageFormatBmp +fullName: azure.media.videoanalyzeredge.ImageFormatBmp +module: azure.media.videoanalyzeredge +summary: 'BMP image encoding. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageFormatBmp(**kwargs) +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +methods: +- uid: azure.media.videoanalyzeredge.ImageFormatBmp.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ImageFormatBmp.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ImageFormatBmp.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.ImageFormatBmp.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ImageFormatBmp.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.ImageFormatBmp.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ImageFormatBmp.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatJpeg.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatJpeg.yml new file mode 100644 index 00000000..593e248b --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatJpeg.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.ImageFormatJpeg +name: ImageFormatJpeg +fullName: azure.media.videoanalyzeredge.ImageFormatJpeg +module: azure.media.videoanalyzeredge +summary: 'JPEG image encoding. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ImageFormatJpeg(*, quality: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: quality + description: Image quality value between 0 to 100 (best quality). + types: + - +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Image quality value between 0 to 100 (best quality). + name: quality + types: + - +methods: +- uid: azure.media.videoanalyzeredge.ImageFormatJpeg.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ImageFormatJpeg.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ImageFormatJpeg.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.ImageFormatJpeg.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ImageFormatJpeg.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.ImageFormatJpeg.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ImageFormatJpeg.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatPng.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatPng.yml new file mode 100644 index 00000000..ff90357c --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatPng.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.ImageFormatPng +name: ImageFormatPng +fullName: azure.media.videoanalyzeredge.ImageFormatPng +module: azure.media.videoanalyzeredge +summary: 'PNG image encoding. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageFormatPng(**kwargs) +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +methods: +- uid: azure.media.videoanalyzeredge.ImageFormatPng.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ImageFormatPng.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ImageFormatPng.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.ImageFormatPng.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ImageFormatPng.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.ImageFormatPng.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ImageFormatPng.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatProperties.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatProperties.yml new file mode 100644 index 00000000..bc057a0c --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatProperties.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.ImageFormatProperties +name: ImageFormatProperties +fullName: azure.media.videoanalyzeredge.ImageFormatProperties +module: azure.media.videoanalyzeredge +summary: 'Base class for image formatting properties. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: ImageFormatBmp, ImageFormatJpeg, ImageFormatPng, ImageFormatRaw. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ImageFormatProperties(**kwargs) +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +methods: +- uid: azure.media.videoanalyzeredge.ImageFormatProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ImageFormatProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ImageFormatProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.ImageFormatProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ImageFormatProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.ImageFormatProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ImageFormatProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatRaw.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatRaw.yml new file mode 100644 index 00000000..2a70eb88 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatRaw.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.ImageFormatRaw +name: ImageFormatRaw +fullName: azure.media.videoanalyzeredge.ImageFormatRaw +module: azure.media.videoanalyzeredge +summary: 'Raw image formatting. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ImageFormatRaw(*, pixel_format: str | ImageFormatRawPixelFormat, **kwargs)' + keywordOnlyParameters: + - name: pixel_format + description: 'Required. Pixel format to be applied to the raw image. Possible + values + + include: "yuv420p", "rgb565be", "rgb565le", "rgb555be", "rgb555le", "rgb24", + "bgr24", "argb", + + "rgba", "abgr", "bgra".' + types: + - + - +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: 'Required. Pixel format to be applied to the raw image. Possible values + + include: "yuv420p", "rgb565be", "rgb565le", "rgb555be", "rgb555le", "rgb24", "bgr24", + "argb", + + "rgba", "abgr", "bgra".' + name: pixel_format + types: + - + - +methods: +- uid: azure.media.videoanalyzeredge.ImageFormatRaw.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ImageFormatRaw.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ImageFormatRaw.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.ImageFormatRaw.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ImageFormatRaw.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.ImageFormatRaw.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ImageFormatRaw.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatRawPixelFormat.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatRawPixelFormat.yml new file mode 100644 index 00000000..f89c4197 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatRawPixelFormat.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonEnum +uid: azure.media.videoanalyzeredge.ImageFormatRawPixelFormat +name: ImageFormatRawPixelFormat +fullName: azure.media.videoanalyzeredge.ImageFormatRawPixelFormat +summary: Pixel format to be applied to the raw image. +module: azure.media.videoanalyzeredge +fields: +- name: ABGR + uid: azure.media.videoanalyzeredge.ImageFormatRawPixelFormat.ABGR +- name: ARGB + uid: azure.media.videoanalyzeredge.ImageFormatRawPixelFormat.ARGB +- name: BGR24 + uid: azure.media.videoanalyzeredge.ImageFormatRawPixelFormat.BGR24 +- name: BGRA + uid: azure.media.videoanalyzeredge.ImageFormatRawPixelFormat.BGRA +- name: RGB24 + uid: azure.media.videoanalyzeredge.ImageFormatRawPixelFormat.RGB24 +- name: RGB555_BE + uid: azure.media.videoanalyzeredge.ImageFormatRawPixelFormat.RGB555_BE +- name: RGB555_LE + uid: azure.media.videoanalyzeredge.ImageFormatRawPixelFormat.RGB555_LE +- name: RGB565_BE + uid: azure.media.videoanalyzeredge.ImageFormatRawPixelFormat.RGB565_BE +- name: RGB565_LE + uid: azure.media.videoanalyzeredge.ImageFormatRawPixelFormat.RGB565_LE +- name: RGBA + uid: azure.media.videoanalyzeredge.ImageFormatRawPixelFormat.RGBA +- name: YUV420_P + uid: azure.media.videoanalyzeredge.ImageFormatRawPixelFormat.YUV420_P diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageProperties.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageProperties.yml new file mode 100644 index 00000000..013d5a36 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageProperties.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.ImageProperties +name: ImageProperties +fullName: azure.media.videoanalyzeredge.ImageProperties +module: azure.media.videoanalyzeredge +summary: Image transformations and formatting options to be applied to the video frame(s). +constructor: + syntax: 'ImageProperties(*, scale: ImageScale | None = None, format: ImageFormatProperties + | None = None, **kwargs)' + keywordOnlyParameters: + - name: scale + description: Image scaling mode. + types: + - + - name: format + description: Base class for image formatting properties. + types: + - +variables: +- description: Image scaling mode. + name: scale + types: + - +- description: Base class for image formatting properties. + name: format + types: + - +methods: +- uid: azure.media.videoanalyzeredge.ImageProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ImageProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ImageProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.ImageProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ImageProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.ImageProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ImageProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageScale.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageScale.yml new file mode 100644 index 00000000..d6111e00 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageScale.yml @@ -0,0 +1,149 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.ImageScale +name: ImageScale +fullName: azure.media.videoanalyzeredge.ImageScale +module: azure.media.videoanalyzeredge +summary: Image scaling mode. +constructor: + syntax: 'ImageScale(*, mode: str | ImageScaleMode | None = None, width: str | None + = None, height: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: mode + description: 'Describes the image scaling mode to be applied. Default mode is + ''pad''. Possible + + values include: "preserveAspectRatio", "pad", "stretch".' + types: + - + - + - name: width + description: The desired output image width. + types: + - + - name: height + description: The desired output image height. + types: + - +variables: +- description: 'Describes the image scaling mode to be applied. Default mode is ''pad''. + Possible + + values include: "preserveAspectRatio", "pad", "stretch".' + name: mode + types: + - + - +- description: The desired output image width. + name: width + types: + - +- description: The desired output image height. + name: height + types: + - +methods: +- uid: azure.media.videoanalyzeredge.ImageScale.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ImageScale.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ImageScale.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.ImageScale.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ImageScale.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.ImageScale.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ImageScale.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageScaleMode.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageScaleMode.yml new file mode 100644 index 00000000..3aa6455e --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageScaleMode.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.media.videoanalyzeredge.ImageScaleMode +name: ImageScaleMode +fullName: azure.media.videoanalyzeredge.ImageScaleMode +summary: Describes the image scaling mode to be applied. Default mode is 'pad'. +module: azure.media.videoanalyzeredge +fields: +- name: PAD + uid: azure.media.videoanalyzeredge.ImageScaleMode.PAD +- name: PRESERVE_ASPECT_RATIO + uid: azure.media.videoanalyzeredge.ImageScaleMode.PRESERVE_ASPECT_RATIO +- name: STRETCH + uid: azure.media.videoanalyzeredge.ImageScaleMode.STRETCH diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.IotHubDeviceConnection.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.IotHubDeviceConnection.yml new file mode 100644 index 00000000..d42e24b5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.IotHubDeviceConnection.yml @@ -0,0 +1,149 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.IotHubDeviceConnection +name: IotHubDeviceConnection +fullName: azure.media.videoanalyzeredge.IotHubDeviceConnection +module: azure.media.videoanalyzeredge +summary: 'Information that enables communication between the IoT Hub and the IoT device + - allowing this edge module to act as a transparent gateway between the two. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'IotHubDeviceConnection(*, device_id: str, credentials: CredentialsBase + | None = None, **kwargs)' + keywordOnlyParameters: + - name: device_id + description: 'Required. The name of the IoT device configured and managed in IoT + Hub. + + (case-sensitive).' + types: + - + - name: credentials + description: 'IoT device connection credentials. Currently IoT device symmetric + key + + credentials are supported.' + types: + - +variables: +- description: 'Required. The name of the IoT device configured and managed in IoT + Hub. + + (case-sensitive).' + name: device_id + types: + - +- description: 'IoT device connection credentials. Currently IoT device symmetric + key + + credentials are supported.' + name: credentials + types: + - +methods: +- uid: azure.media.videoanalyzeredge.IotHubDeviceConnection.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.IotHubDeviceConnection.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.IotHubDeviceConnection.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.IotHubDeviceConnection.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.IotHubDeviceConnection.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.IotHubDeviceConnection.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.IotHubDeviceConnection.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.IotHubMessageSink.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.IotHubMessageSink.yml new file mode 100644 index 00000000..dc34759d --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.IotHubMessageSink.yml @@ -0,0 +1,163 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.IotHubMessageSink +name: IotHubMessageSink +fullName: azure.media.videoanalyzeredge.IotHubMessageSink +module: azure.media.videoanalyzeredge +summary: 'IoT Hub Message sink allows for pipeline messages to published into the + IoT Edge Hub. Published messages can then be delivered to the cloud and other modules + via routes declared in the IoT Edge deployment manifest. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'IotHubMessageSink(*, name: str, inputs: List[NodeInput], hub_output_name: + str, **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Node name. Must be unique within the topology. + types: + - + - name: inputs + description: 'Required. An array of upstream node references within the topology + to be used + + as inputs for this node.' + types: + - [] + - name: hub_output_name + description: 'Required. Name of the Iot Edge Hub output to which the messages + will + + be published.' + types: + - +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. Node name. Must be unique within the topology. + name: name + types: + - +- description: 'Required. An array of upstream node references within the topology + to be used as + + inputs for this node.' + name: inputs + types: + - [] +- description: 'Required. Name of the Iot Edge Hub output to which the messages will + be + + published.' + name: hub_output_name + types: + - +methods: +- uid: azure.media.videoanalyzeredge.IotHubMessageSink.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.IotHubMessageSink.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.IotHubMessageSink.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.IotHubMessageSink.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.IotHubMessageSink.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.IotHubMessageSink.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.IotHubMessageSink.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.IotHubMessageSource.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.IotHubMessageSource.yml new file mode 100644 index 00000000..aa0dd655 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.IotHubMessageSource.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.IotHubMessageSource +name: IotHubMessageSource +fullName: azure.media.videoanalyzeredge.IotHubMessageSource +module: azure.media.videoanalyzeredge +summary: 'IoT Hub Message source allows for the pipeline to consume messages from + the IoT Edge Hub. Messages can be routed from other IoT modules via routes declared + in the IoT Edge deployment manifest. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'IotHubMessageSource(*, name: str, hub_input_name: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Node name. Must be unique within the topology. + types: + - + - name: hub_input_name + description: Name of the IoT Edge Hub input from which messages will be consumed. + types: + - +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. Node name. Must be unique within the topology. + name: name + types: + - +- description: Name of the IoT Edge Hub input from which messages will be consumed. + name: hub_input_name + types: + - +methods: +- uid: azure.media.videoanalyzeredge.IotHubMessageSource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.IotHubMessageSource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.IotHubMessageSource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.IotHubMessageSource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.IotHubMessageSource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.IotHubMessageSource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.IotHubMessageSource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LineCrossingProcessor.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LineCrossingProcessor.yml new file mode 100644 index 00000000..e093de1b --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LineCrossingProcessor.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.LineCrossingProcessor +name: LineCrossingProcessor +fullName: azure.media.videoanalyzeredge.LineCrossingProcessor +module: azure.media.videoanalyzeredge +summary: 'Line crossing processor allows for the detection of tracked objects moving + across one or more predefined lines. It must be downstream of an object tracker + of downstream on an AI extension node that generates sequenceId for objects which + are tracked across different frames of the video. Inference events are generated + every time objects crosses from one side of the line to another. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'LineCrossingProcessor(*, name: str, inputs: List[NodeInput], lines: List[NamedLineBase], + **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Node name. Must be unique within the topology. + types: + - + - name: inputs + description: 'Required. An array of upstream node references within the topology + to be used + + as inputs for this node.' + types: + - [] + - name: lines + description: Required. An array of lines used to compute line crossing events. + types: + - [] +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. Node name. Must be unique within the topology. + name: name + types: + - +- description: 'Required. An array of upstream node references within the topology + to be used as + + inputs for this node.' + name: inputs + types: + - [] +- description: Required. An array of lines used to compute line crossing events. + name: lines + types: + - [] +methods: +- uid: azure.media.videoanalyzeredge.LineCrossingProcessor.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.LineCrossingProcessor.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.LineCrossingProcessor.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.LineCrossingProcessor.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.LineCrossingProcessor.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.LineCrossingProcessor.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.LineCrossingProcessor.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipeline.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipeline.yml new file mode 100644 index 00000000..128df8c5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipeline.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.LivePipeline +name: LivePipeline +fullName: azure.media.videoanalyzeredge.LivePipeline +module: azure.media.videoanalyzeredge +summary: 'Live Pipeline represents an unique instance of a pipeline topology which + is used for real-time content ingestion and analysis. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'LivePipeline(*, name: str, system_data: SystemData | None = None, properties: + LivePipelineProperties | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Live pipeline unique identifier. + types: + - + - name: system_data + description: Read-only system metadata associated with this object. + types: + - + - name: properties + description: Live pipeline properties. + types: + - +variables: +- description: Required. Live pipeline unique identifier. + name: name + types: + - +- description: Read-only system metadata associated with this object. + name: system_data + types: + - +- description: Live pipeline properties. + name: properties + types: + - +methods: +- uid: azure.media.videoanalyzeredge.LivePipeline.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.LivePipeline.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.LivePipeline.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.LivePipeline.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.LivePipeline.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.LivePipeline.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.LivePipeline.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineActivateRequest.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineActivateRequest.yml new file mode 100644 index 00000000..59672114 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineActivateRequest.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.LivePipelineActivateRequest +name: LivePipelineActivateRequest +fullName: azure.media.videoanalyzeredge.LivePipelineActivateRequest +module: azure.media.videoanalyzeredge +summary: 'Activates an existing live pipeline. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'LivePipelineActivateRequest(*, name: str, api_version: str | None = ''1.1'', + **kwargs)' + keywordOnlyParameters: + - name: api_version + description: 'Video Analyzer API version. The only acceptable values to pass in + are + + None and "1.1". The default value is "1.1".' + defaultValue: '1.1' + types: + - + - name: name + description: Required. Resource name. + types: + - +variables: +- description: Required. Direct method method name.Constant filled by server. + name: method_name + types: + - +- description: 'Video Analyzer API version. The only acceptable values to pass in + are None + + and "1.1". The default value is "1.1".' + name: api_version + types: + - +- description: Required. Resource name. + name: name + types: + - +methods: +- uid: azure.media.videoanalyzeredge.LivePipelineActivateRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.LivePipelineActivateRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.LivePipelineActivateRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.LivePipelineActivateRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.LivePipelineActivateRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.LivePipelineActivateRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.LivePipelineActivateRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineCollection.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineCollection.yml new file mode 100644 index 00000000..90af4609 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineCollection.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.LivePipelineCollection +name: LivePipelineCollection +fullName: azure.media.videoanalyzeredge.LivePipelineCollection +module: azure.media.videoanalyzeredge +summary: A collection of live pipelines. +constructor: + syntax: 'LivePipelineCollection(*, value: List[LivePipeline] | None = None, continuation_token: + str | None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: List of live pipelines. + types: + - [] + - name: continuation_token + description: 'A continuation token to be used in subsequent calls when + + enumerating through the collection. This is returned when the collection results + won''t fit in a + + single response.' + types: + - +variables: +- description: List of live pipelines. + name: value + types: + - [] +- description: 'A continuation token to be used in subsequent calls when enumerating + + through the collection. This is returned when the collection results won''t fit + in a single + + response.' + name: continuation_token + types: + - +methods: +- uid: azure.media.videoanalyzeredge.LivePipelineCollection.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.LivePipelineCollection.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.LivePipelineCollection.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.LivePipelineCollection.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.LivePipelineCollection.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.LivePipelineCollection.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.LivePipelineCollection.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineDeactivateRequest.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineDeactivateRequest.yml new file mode 100644 index 00000000..16505120 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineDeactivateRequest.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.LivePipelineDeactivateRequest +name: LivePipelineDeactivateRequest +fullName: azure.media.videoanalyzeredge.LivePipelineDeactivateRequest +module: azure.media.videoanalyzeredge +summary: 'Deactivates an existing live pipeline. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'LivePipelineDeactivateRequest(*, name: str, api_version: str | None = ''1.1'', + **kwargs)' + keywordOnlyParameters: + - name: api_version + description: 'Video Analyzer API version. The only acceptable values to pass in + are + + None and "1.1". The default value is "1.1".' + defaultValue: '1.1' + types: + - + - name: name + description: Required. Resource name. + types: + - +variables: +- description: Required. Direct method method name.Constant filled by server. + name: method_name + types: + - +- description: 'Video Analyzer API version. The only acceptable values to pass in + are None + + and "1.1". The default value is "1.1".' + name: api_version + types: + - +- description: Required. Resource name. + name: name + types: + - +methods: +- uid: azure.media.videoanalyzeredge.LivePipelineDeactivateRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.LivePipelineDeactivateRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.LivePipelineDeactivateRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.LivePipelineDeactivateRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.LivePipelineDeactivateRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.LivePipelineDeactivateRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.LivePipelineDeactivateRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineDeleteRequest.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineDeleteRequest.yml new file mode 100644 index 00000000..c117666f --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineDeleteRequest.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.LivePipelineDeleteRequest +name: LivePipelineDeleteRequest +fullName: azure.media.videoanalyzeredge.LivePipelineDeleteRequest +module: azure.media.videoanalyzeredge +summary: 'Deletes an existing live pipeline. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'LivePipelineDeleteRequest(*, name: str, api_version: str | None = ''1.1'', + **kwargs)' + keywordOnlyParameters: + - name: api_version + description: 'Video Analyzer API version. The only acceptable values to pass in + are + + None and "1.1". The default value is "1.1".' + defaultValue: '1.1' + types: + - + - name: name + description: Required. Resource name. + types: + - +variables: +- description: Required. Direct method method name.Constant filled by server. + name: method_name + types: + - +- description: 'Video Analyzer API version. The only acceptable values to pass in + are None + + and "1.1". The default value is "1.1".' + name: api_version + types: + - +- description: Required. Resource name. + name: name + types: + - +methods: +- uid: azure.media.videoanalyzeredge.LivePipelineDeleteRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.LivePipelineDeleteRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.LivePipelineDeleteRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.LivePipelineDeleteRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.LivePipelineDeleteRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.LivePipelineDeleteRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.LivePipelineDeleteRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineGetRequest.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineGetRequest.yml new file mode 100644 index 00000000..6950a87c --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineGetRequest.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.LivePipelineGetRequest +name: LivePipelineGetRequest +fullName: azure.media.videoanalyzeredge.LivePipelineGetRequest +module: azure.media.videoanalyzeredge +summary: 'Retrieves an existing live pipeline. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'LivePipelineGetRequest(*, name: str, api_version: str | None = ''1.1'', + **kwargs)' + keywordOnlyParameters: + - name: api_version + description: 'Video Analyzer API version. The only acceptable values to pass in + are + + None and "1.1". The default value is "1.1".' + defaultValue: '1.1' + types: + - + - name: name + description: Required. Resource name. + types: + - +variables: +- description: Required. Direct method method name.Constant filled by server. + name: method_name + types: + - +- description: 'Video Analyzer API version. The only acceptable values to pass in + are None + + and "1.1". The default value is "1.1".' + name: api_version + types: + - +- description: Required. Resource name. + name: name + types: + - +methods: +- uid: azure.media.videoanalyzeredge.LivePipelineGetRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.LivePipelineGetRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.LivePipelineGetRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.LivePipelineGetRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.LivePipelineGetRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.LivePipelineGetRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.LivePipelineGetRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineListRequest.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineListRequest.yml new file mode 100644 index 00000000..dc03b82a --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineListRequest.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.LivePipelineListRequest +name: LivePipelineListRequest +fullName: azure.media.videoanalyzeredge.LivePipelineListRequest +module: azure.media.videoanalyzeredge +summary: 'List all existing live pipelines. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'LivePipelineListRequest(*, api_version: str | None = ''1.1'', **kwargs)' + keywordOnlyParameters: + - name: api_version + description: 'Video Analyzer API version. The only acceptable values to pass in + are + + None and "1.1". The default value is "1.1".' + defaultValue: '1.1' + types: + - +variables: +- description: Required. Direct method method name.Constant filled by server. + name: method_name + types: + - +- description: 'Video Analyzer API version. The only acceptable values to pass in + are None + + and "1.1". The default value is "1.1".' + name: api_version + types: + - +methods: +- uid: azure.media.videoanalyzeredge.LivePipelineListRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.LivePipelineListRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.LivePipelineListRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.LivePipelineListRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.LivePipelineListRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.LivePipelineListRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.LivePipelineListRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineProperties.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineProperties.yml new file mode 100644 index 00000000..d8850b7d --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineProperties.yml @@ -0,0 +1,183 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.LivePipelineProperties +name: LivePipelineProperties +fullName: azure.media.videoanalyzeredge.LivePipelineProperties +module: azure.media.videoanalyzeredge +summary: Live pipeline properties. +constructor: + syntax: 'LivePipelineProperties(*, description: str | None = None, topology_name: + str | None = None, parameters: List[ParameterDefinition] | None = None, state: + str | LivePipelineState | None = None, **kwargs)' + keywordOnlyParameters: + - name: description + description: An optional description of the live pipeline. + types: + - + - name: topology_name + description: 'The reference to an existing pipeline topology defined for real-time + + content processing. When activated, this live pipeline will process content + according to the + + pipeline topology definition.' + types: + - + - name: parameters + description: 'List of the instance level parameter values for the user-defined + topology + + parameters. A pipeline can only define or override parameters values for parameters + which have + + been declared in the referenced topology. Topology parameters without a default + value must be + + defined. Topology parameters with a default value can be optionally be overridden.' + types: + - [] + - name: state + description: 'Current pipeline state (read-only). Possible values include: "inactive", + + "activating", "active", "deactivating".' + types: + - + - +variables: +- description: An optional description of the live pipeline. + name: description + types: + - +- description: 'The reference to an existing pipeline topology defined for real-time + + content processing. When activated, this live pipeline will process content according + to the + + pipeline topology definition.' + name: topology_name + types: + - +- description: 'List of the instance level parameter values for the user-defined topology + + parameters. A pipeline can only define or override parameters values for parameters + which have + + been declared in the referenced topology. Topology parameters without a default + value must be + + defined. Topology parameters with a default value can be optionally be overridden.' + name: parameters + types: + - [] +- description: 'Current pipeline state (read-only). Possible values include: "inactive", + + "activating", "active", "deactivating".' + name: state + types: + - + - +methods: +- uid: azure.media.videoanalyzeredge.LivePipelineProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.LivePipelineProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.LivePipelineProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.LivePipelineProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.LivePipelineProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.LivePipelineProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.LivePipelineProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineSetRequest.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineSetRequest.yml new file mode 100644 index 00000000..68ff481e --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineSetRequest.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.LivePipelineSetRequest +name: LivePipelineSetRequest +fullName: azure.media.videoanalyzeredge.LivePipelineSetRequest +module: azure.media.videoanalyzeredge +summary: 'Creates a new live pipeline or updates an existing one. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'LivePipelineSetRequest(*, live_pipeline: LivePipeline, api_version: str + | None = ''1.1'', **kwargs)' + keywordOnlyParameters: + - name: api_version + description: 'Video Analyzer API version. The only acceptable values to pass in + are + + None and "1.1". The default value is "1.1".' + defaultValue: '1.1' + types: + - + - name: live_pipeline + description: 'Required. Live Pipeline represents an unique instance of a pipeline + + topology which is used for real-time content ingestion and analysis.' + types: + - +variables: +- description: Required. Direct method method name.Constant filled by server. + name: method_name + types: + - +- description: 'Video Analyzer API version. The only acceptable values to pass in + are None + + and "1.1". The default value is "1.1".' + name: api_version + types: + - +- description: 'Required. Live Pipeline represents an unique instance of a pipeline + + topology which is used for real-time content ingestion and analysis.' + name: live_pipeline + types: + - +methods: +- uid: azure.media.videoanalyzeredge.LivePipelineSetRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.LivePipelineSetRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.LivePipelineSetRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.LivePipelineSetRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.LivePipelineSetRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.LivePipelineSetRequest.serialize + name: serialize + signature: serialize() +- uid: azure.media.videoanalyzeredge.LivePipelineSetRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineSetRequestBody.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineSetRequestBody.yml new file mode 100644 index 00000000..70c98916 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineSetRequestBody.yml @@ -0,0 +1,168 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.LivePipelineSetRequestBody +name: LivePipelineSetRequestBody +fullName: azure.media.videoanalyzeredge.LivePipelineSetRequestBody +module: azure.media.videoanalyzeredge +summary: 'Live Pipeline represents an unique instance of a pipeline topology which + is used for real-time content ingestion and analysis. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'LivePipelineSetRequestBody(*, name: str, api_version: str | None = ''1.1'', + system_data: SystemData | None = None, properties: LivePipelineProperties | None + = None, **kwargs)' + keywordOnlyParameters: + - name: api_version + description: 'Video Analyzer API version. The only acceptable values to pass in + are + + None and "1.1". The default value is "1.1".' + defaultValue: '1.1' + types: + - + - name: name + description: Required. Live pipeline unique identifier. + types: + - + - name: system_data + description: Read-only system metadata associated with this object. + types: + - + - name: properties + description: Live pipeline properties. + types: + - +variables: +- description: Required. Direct method method name.Constant filled by server. + name: method_name + types: + - +- description: 'Video Analyzer API version. The only acceptable values to pass in + are None + + and "1.1". The default value is "1.1".' + name: api_version + types: + - +- description: Required. Live pipeline unique identifier. + name: name + types: + - +- description: Read-only system metadata associated with this object. + name: system_data + types: + - +- description: Live pipeline properties. + name: properties + types: + - +methods: +- uid: azure.media.videoanalyzeredge.LivePipelineSetRequestBody.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.LivePipelineSetRequestBody.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.LivePipelineSetRequestBody.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.LivePipelineSetRequestBody.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.LivePipelineSetRequestBody.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.LivePipelineSetRequestBody.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.LivePipelineSetRequestBody.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineState.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineState.yml new file mode 100644 index 00000000..d2b34166 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineState.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.media.videoanalyzeredge.LivePipelineState +name: LivePipelineState +fullName: azure.media.videoanalyzeredge.LivePipelineState +summary: Current pipeline state (read-only). +module: azure.media.videoanalyzeredge +fields: +- name: ACTIVATING + uid: azure.media.videoanalyzeredge.LivePipelineState.ACTIVATING +- name: ACTIVE + uid: azure.media.videoanalyzeredge.LivePipelineState.ACTIVE +- name: DEACTIVATING + uid: azure.media.videoanalyzeredge.LivePipelineState.DEACTIVATING +- name: INACTIVE + uid: azure.media.videoanalyzeredge.LivePipelineState.INACTIVE diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MPEG4Configuration.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MPEG4Configuration.yml new file mode 100644 index 00000000..1b9f20f3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MPEG4Configuration.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.MPEG4Configuration +name: MPEG4Configuration +fullName: azure.media.videoanalyzeredge.MPEG4Configuration +module: azure.media.videoanalyzeredge +summary: Class representing the MPEG4 Configuration. +constructor: + syntax: 'MPEG4Configuration(*, gov_length: float | None = None, profile: str | MPEG4Profile + | None = None, **kwargs)' + keywordOnlyParameters: + - name: gov_length + description: Group of Video frames length. + types: + - + - name: profile + description: 'The MPEG4 Profile. Possible values include: "SP", "ASP".' + types: + - + - +variables: +- description: Group of Video frames length. + name: gov_length + types: + - +- description: 'The MPEG4 Profile. Possible values include: "SP", "ASP".' + name: profile + types: + - + - +methods: +- uid: azure.media.videoanalyzeredge.MPEG4Configuration.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.MPEG4Configuration.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.MPEG4Configuration.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.MPEG4Configuration.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.MPEG4Configuration.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.MPEG4Configuration.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.MPEG4Configuration.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MPEG4Profile.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MPEG4Profile.yml new file mode 100644 index 00000000..56dabe4f --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MPEG4Profile.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.media.videoanalyzeredge.MPEG4Profile +name: MPEG4Profile +fullName: azure.media.videoanalyzeredge.MPEG4Profile +summary: The MPEG4 Profile +module: azure.media.videoanalyzeredge +fields: +- name: ASP + uid: azure.media.videoanalyzeredge.MPEG4Profile.ASP +- name: SP + uid: azure.media.videoanalyzeredge.MPEG4Profile.SP diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MediaProfile.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MediaProfile.yml new file mode 100644 index 00000000..847c7921 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MediaProfile.yml @@ -0,0 +1,144 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.MediaProfile +name: MediaProfile +fullName: azure.media.videoanalyzeredge.MediaProfile +module: azure.media.videoanalyzeredge +summary: Class representing the ONVIF MediaProfiles. +constructor: + syntax: 'MediaProfile(*, name: str | None = None, media_uri: Any | None = None, + video_encoder_configuration: VideoEncoderConfiguration | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: The name of the Media Profile. + types: + - + - name: media_uri + description: 'Object representing the URI that will be used to request for media + + streaming.' + types: + - + - name: video_encoder_configuration + description: The Video encoder configuration. + types: + - +variables: +- description: The name of the Media Profile. + name: name + types: + - +- description: Object representing the URI that will be used to request for media + streaming. + name: media_uri + types: + - +- description: The Video encoder configuration. + name: video_encoder_configuration + types: + - +methods: +- uid: azure.media.videoanalyzeredge.MediaProfile.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.MediaProfile.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.MediaProfile.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.MediaProfile.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.MediaProfile.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.MediaProfile.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.MediaProfile.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MediaUri.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MediaUri.yml new file mode 100644 index 00000000..e2dc7afe --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MediaUri.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.MediaUri +name: MediaUri +fullName: azure.media.videoanalyzeredge.MediaUri +module: azure.media.videoanalyzeredge +summary: Object representing the URI that will be used to request for media streaming. +constructor: + syntax: 'MediaUri(*, uri: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: uri + description: URI that can be used for media streaming. + types: + - +variables: +- description: URI that can be used for media streaming. + name: uri + types: + - +methods: +- uid: azure.media.videoanalyzeredge.MediaUri.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.MediaUri.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.MediaUri.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.MediaUri.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.MediaUri.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.MediaUri.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.MediaUri.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MethodRequest.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MethodRequest.yml new file mode 100644 index 00000000..3c6b921a --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MethodRequest.yml @@ -0,0 +1,149 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.MethodRequest +name: MethodRequest +fullName: azure.media.videoanalyzeredge.MethodRequest +module: azure.media.videoanalyzeredge +summary: 'Base class for direct method calls. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: LivePipelineSetRequestBody, MethodRequestEmptyBodyBase, PipelineTopologySetRequestBody, + RemoteDeviceAdapterSetRequestBody, LivePipelineListRequest, LivePipelineSetRequest, + OnvifDeviceDiscoverRequest, OnvifDeviceGetRequest, PipelineTopologyListRequest, + PipelineTopologySetRequest, RemoteDeviceAdapterListRequest, RemoteDeviceAdapterSetRequest. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MethodRequest(*, api_version: str | None = ''1.1'', **kwargs)' + keywordOnlyParameters: + - name: api_version + description: 'Video Analyzer API version. The only acceptable values to pass in + are + + None and "1.1". The default value is "1.1".' + defaultValue: '1.1' + types: + - +variables: +- description: Required. Direct method method name.Constant filled by server. + name: method_name + types: + - +- description: 'Video Analyzer API version. The only acceptable values to pass in + are None + + and "1.1". The default value is "1.1".' + name: api_version + types: + - +methods: +- uid: azure.media.videoanalyzeredge.MethodRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.MethodRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.MethodRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.MethodRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.MethodRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.MethodRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.MethodRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MethodRequestEmptyBodyBase.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MethodRequestEmptyBodyBase.yml new file mode 100644 index 00000000..95c4d1b2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MethodRequestEmptyBodyBase.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.MethodRequestEmptyBodyBase +name: MethodRequestEmptyBodyBase +fullName: azure.media.videoanalyzeredge.MethodRequestEmptyBodyBase +module: azure.media.videoanalyzeredge +summary: 'MethodRequestEmptyBodyBase. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: LivePipelineActivateRequest, LivePipelineDeactivateRequest, LivePipelineDeleteRequest, + LivePipelineGetRequest, PipelineTopologyDeleteRequest, PipelineTopologyGetRequest, + RemoteDeviceAdapterDeleteRequest, RemoteDeviceAdapterGetRequest. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MethodRequestEmptyBodyBase(*, name: str, api_version: str | None = ''1.1'', + **kwargs)' + keywordOnlyParameters: + - name: api_version + description: 'Video Analyzer API version. The only acceptable values to pass in + are + + None and "1.1". The default value is "1.1".' + defaultValue: '1.1' + types: + - + - name: name + description: Required. Resource name. + types: + - +variables: +- description: Required. Direct method method name.Constant filled by server. + name: method_name + types: + - +- description: 'Video Analyzer API version. The only acceptable values to pass in + are None + + and "1.1". The default value is "1.1".' + name: api_version + types: + - +- description: Required. Resource name. + name: name + types: + - +methods: +- uid: azure.media.videoanalyzeredge.MethodRequestEmptyBodyBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.MethodRequestEmptyBodyBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.MethodRequestEmptyBodyBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.MethodRequestEmptyBodyBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.MethodRequestEmptyBodyBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.MethodRequestEmptyBodyBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.MethodRequestEmptyBodyBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MotionDetectionProcessor.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MotionDetectionProcessor.yml new file mode 100644 index 00000000..02a42279 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MotionDetectionProcessor.yml @@ -0,0 +1,194 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.MotionDetectionProcessor +name: MotionDetectionProcessor +fullName: azure.media.videoanalyzeredge.MotionDetectionProcessor +module: azure.media.videoanalyzeredge +summary: 'Motion detection processor allows for motion detection on the video stream. + It generates motion events whenever motion is present on the video. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MotionDetectionProcessor(*, name: str, inputs: List[NodeInput], sensitivity: + str | MotionDetectionSensitivity | None = None, output_motion_region: bool | None + = None, event_aggregation_window: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Node name. Must be unique within the topology. + types: + - + - name: inputs + description: 'Required. An array of upstream node references within the topology + to be used + + as inputs for this node.' + types: + - [] + - name: sensitivity + description: 'Motion detection sensitivity: low, medium, high. Possible values + include: + + "low", "medium", "high".' + types: + - + - + - name: output_motion_region + description: 'Indicates whether the processor should detect and output the + + regions within the video frame where motion was detected. Default is true.' + types: + - + - name: event_aggregation_window + description: 'Time window duration on which events are aggregated before + + being emitted. Value must be specified in ISO8601 duration format (i.e. "PT2S" + equals 2 + + seconds). Use 0 seconds for no aggregation. Default is 1 second.' + types: + - +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. Node name. Must be unique within the topology. + name: name + types: + - +- description: 'Required. An array of upstream node references within the topology + to be used as + + inputs for this node.' + name: inputs + types: + - [] +- description: 'Motion detection sensitivity: low, medium, high. Possible values include: + + "low", "medium", "high".' + name: sensitivity + types: + - + - +- description: 'Indicates whether the processor should detect and output the + + regions within the video frame where motion was detected. Default is true.' + name: output_motion_region + types: + - +- description: 'Time window duration on which events are aggregated before + + being emitted. Value must be specified in ISO8601 duration format (i.e. "PT2S" + equals 2 + + seconds). Use 0 seconds for no aggregation. Default is 1 second.' + name: event_aggregation_window + types: + - +methods: +- uid: azure.media.videoanalyzeredge.MotionDetectionProcessor.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.MotionDetectionProcessor.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.MotionDetectionProcessor.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.MotionDetectionProcessor.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.MotionDetectionProcessor.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.MotionDetectionProcessor.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.MotionDetectionProcessor.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MotionDetectionSensitivity.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MotionDetectionSensitivity.yml new file mode 100644 index 00000000..eb32470e --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MotionDetectionSensitivity.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.media.videoanalyzeredge.MotionDetectionSensitivity +name: MotionDetectionSensitivity +fullName: azure.media.videoanalyzeredge.MotionDetectionSensitivity +summary: 'Motion detection sensitivity: low, medium, high.' +module: azure.media.videoanalyzeredge +fields: +- name: HIGH + uid: azure.media.videoanalyzeredge.MotionDetectionSensitivity.HIGH +- name: LOW + uid: azure.media.videoanalyzeredge.MotionDetectionSensitivity.LOW +- name: MEDIUM + uid: azure.media.videoanalyzeredge.MotionDetectionSensitivity.MEDIUM diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NamedLineBase.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NamedLineBase.yml new file mode 100644 index 00000000..a9168c17 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NamedLineBase.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.NamedLineBase +name: NamedLineBase +fullName: azure.media.videoanalyzeredge.NamedLineBase +module: azure.media.videoanalyzeredge +summary: 'Base class for named lines. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: NamedLineString. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'NamedLineBase(*, name: str, **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Line name. Must be unique within the node. + types: + - +variables: +- description: Required. The Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. Line name. Must be unique within the node. + name: name + types: + - +methods: +- uid: azure.media.videoanalyzeredge.NamedLineBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.NamedLineBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.NamedLineBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.NamedLineBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.NamedLineBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.NamedLineBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.NamedLineBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NamedLineString.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NamedLineString.yml new file mode 100644 index 00000000..0a1b69f8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NamedLineString.yml @@ -0,0 +1,158 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.NamedLineString +name: NamedLineString +fullName: azure.media.videoanalyzeredge.NamedLineString +module: azure.media.videoanalyzeredge +summary: 'Describes a line configuration. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'NamedLineString(*, name: str, line: str, **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Line name. Must be unique within the node. + types: + - + - name: line + description: 'Required. Point coordinates for the line start and end, respectively. + Example: + + ''[[0.3, 0.2],[0.9, 0.8]]''. Each point is expressed as [LEFT, TOP] coordinate + ratios ranging + + from 0.0 to 1.0, where [0,0] is the upper-left frame corner and [1, 1] is the + bottom-right + + frame corner.' + types: + - +variables: +- description: Required. The Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. Line name. Must be unique within the node. + name: name + types: + - +- description: 'Required. Point coordinates for the line start and end, respectively. + Example: + + ''[[0.3, 0.2],[0.9, 0.8]]''. Each point is expressed as [LEFT, TOP] coordinate + ratios ranging + + from 0.0 to 1.0, where [0,0] is the upper-left frame corner and [1, 1] is the + bottom-right + + frame corner.' + name: line + types: + - +methods: +- uid: azure.media.videoanalyzeredge.NamedLineString.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.NamedLineString.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.NamedLineString.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.NamedLineString.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.NamedLineString.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.NamedLineString.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.NamedLineString.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NamedPolygonBase.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NamedPolygonBase.yml new file mode 100644 index 00000000..3af4c507 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NamedPolygonBase.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.NamedPolygonBase +name: NamedPolygonBase +fullName: azure.media.videoanalyzeredge.NamedPolygonBase +module: azure.media.videoanalyzeredge +summary: 'Describes the named polygon. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: NamedPolygonString. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'NamedPolygonBase(*, name: str, **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Polygon name. Must be unique within the node. + types: + - +variables: +- description: Required. The Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. Polygon name. Must be unique within the node. + name: name + types: + - +methods: +- uid: azure.media.videoanalyzeredge.NamedPolygonBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.NamedPolygonBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.NamedPolygonBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.NamedPolygonBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.NamedPolygonBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.NamedPolygonBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.NamedPolygonBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NamedPolygonString.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NamedPolygonString.yml new file mode 100644 index 00000000..d1515e7c --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NamedPolygonString.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.NamedPolygonString +name: NamedPolygonString +fullName: azure.media.videoanalyzeredge.NamedPolygonString +module: azure.media.videoanalyzeredge +summary: 'Describes a closed polygon configuration. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'NamedPolygonString(*, name: str, polygon: str, **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Polygon name. Must be unique within the node. + types: + - + - name: polygon + description: 'Required. Point coordinates for the polygon. Example: ''[[0.3, 0.2],[0.9, + + 0.8],[0.7, 0.6]]''. Each point is expressed as [LEFT, TOP] coordinate ratios + ranging from 0.0 to + + 1.0, where [0,0] is the upper-left frame corner and [1, 1] is the bottom-right + frame corner.' + types: + - +variables: +- description: Required. The Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. Polygon name. Must be unique within the node. + name: name + types: + - +- description: 'Required. Point coordinates for the polygon. Example: ''[[0.3, 0.2],[0.9, + + 0.8],[0.7, 0.6]]''. Each point is expressed as [LEFT, TOP] coordinate ratios ranging + from 0.0 to + + 1.0, where [0,0] is the upper-left frame corner and [1, 1] is the bottom-right + frame corner.' + name: polygon + types: + - +methods: +- uid: azure.media.videoanalyzeredge.NamedPolygonString.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.NamedPolygonString.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.NamedPolygonString.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.NamedPolygonString.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.NamedPolygonString.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.NamedPolygonString.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.NamedPolygonString.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NodeInput.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NodeInput.yml new file mode 100644 index 00000000..ab821c55 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NodeInput.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.NodeInput +name: NodeInput +fullName: azure.media.videoanalyzeredge.NodeInput +module: azure.media.videoanalyzeredge +summary: 'Describes an input signal to be used on a pipeline node. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'NodeInput(*, node_name: str, output_selectors: List[OutputSelector] | None + = None, **kwargs)' + keywordOnlyParameters: + - name: node_name + description: 'Required. The name of the upstream node in the pipeline which output + is + + used as input of the current node.' + types: + - + - name: output_selectors + description: 'Allows for the selection of specific data streams (eg. video only) + + from another node.' + types: + - [] +variables: +- description: 'Required. The name of the upstream node in the pipeline which output + is used + + as input of the current node.' + name: node_name + types: + - +- description: 'Allows for the selection of specific data streams (eg. video only) + from + + another node.' + name: output_selectors + types: + - [] +methods: +- uid: azure.media.videoanalyzeredge.NodeInput.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.NodeInput.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.NodeInput.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.NodeInput.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.NodeInput.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.NodeInput.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.NodeInput.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ObjectTrackingAccuracy.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ObjectTrackingAccuracy.yml new file mode 100644 index 00000000..2098b7db --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ObjectTrackingAccuracy.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonEnum +uid: azure.media.videoanalyzeredge.ObjectTrackingAccuracy +name: ObjectTrackingAccuracy +fullName: azure.media.videoanalyzeredge.ObjectTrackingAccuracy +summary: 'Object tracker accuracy: low, medium, high. Higher accuracy leads to higher + CPU consumption in + + average.' +module: azure.media.videoanalyzeredge +fields: +- name: HIGH + uid: azure.media.videoanalyzeredge.ObjectTrackingAccuracy.HIGH +- name: LOW + uid: azure.media.videoanalyzeredge.ObjectTrackingAccuracy.LOW +- name: MEDIUM + uid: azure.media.videoanalyzeredge.ObjectTrackingAccuracy.MEDIUM diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ObjectTrackingProcessor.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ObjectTrackingProcessor.yml new file mode 100644 index 00000000..da60c706 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ObjectTrackingProcessor.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.ObjectTrackingProcessor +name: ObjectTrackingProcessor +fullName: azure.media.videoanalyzeredge.ObjectTrackingProcessor +module: azure.media.videoanalyzeredge +summary: 'Object tracker processor allows for continuous tracking of one of more objects + over a finite sequence of video frames. It must be used downstream of an object + detector extension node, thus allowing for the extension to be configured to to + perform inferences on sparse frames through the use of the ''maximumSamplesPerSecond'' + sampling property. The object tracker node will then track the detected objects + over the frames in which the detector is not invoked resulting on a smother tracking + of detected objects across the continuum of video frames. The tracker will stop + tracking objects which are not subsequently detected by the upstream detector on + the subsequent detections. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ObjectTrackingProcessor(*, name: str, inputs: List[NodeInput], accuracy: + str | ObjectTrackingAccuracy | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Node name. Must be unique within the topology. + types: + - + - name: inputs + description: 'Required. An array of upstream node references within the topology + to be used + + as inputs for this node.' + types: + - [] + - name: accuracy + description: 'Object tracker accuracy: low, medium, high. Higher accuracy leads + to higher + + CPU consumption in average. Possible values include: "low", "medium", "high".' + types: + - + - +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. Node name. Must be unique within the topology. + name: name + types: + - +- description: 'Required. An array of upstream node references within the topology + to be used as + + inputs for this node.' + name: inputs + types: + - [] +- description: 'Object tracker accuracy: low, medium, high. Higher accuracy leads + to higher CPU + + consumption in average. Possible values include: "low", "medium", "high".' + name: accuracy + types: + - + - +methods: +- uid: azure.media.videoanalyzeredge.ObjectTrackingProcessor.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ObjectTrackingProcessor.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ObjectTrackingProcessor.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.ObjectTrackingProcessor.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ObjectTrackingProcessor.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.ObjectTrackingProcessor.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ObjectTrackingProcessor.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDevice.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDevice.yml new file mode 100644 index 00000000..8fe42502 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDevice.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.OnvifDevice +name: OnvifDevice +fullName: azure.media.videoanalyzeredge.OnvifDevice +module: azure.media.videoanalyzeredge +summary: The ONVIF device properties. +constructor: + syntax: 'OnvifDevice(*, hostname: OnvifHostName | None = None, system_date_time: + OnvifSystemDateTime | None = None, dns: OnvifDns | None = None, media_profiles: + List[MediaProfile] | None = None, **kwargs)' + keywordOnlyParameters: + - name: hostname + description: The hostname of the ONVIF device. + types: + - + - name: system_date_time + description: The system date and time of the ONVIF device. + types: + - + - name: dns + description: The ONVIF device DNS properties. + types: + - + - name: media_profiles + description: An array of of ONVIF media profiles supported by the ONVIF device. + types: + - [] +variables: +- description: The hostname of the ONVIF device. + name: hostname + types: + - +- description: The system date and time of the ONVIF device. + name: system_date_time + types: + - +- description: The ONVIF device DNS properties. + name: dns + types: + - +- description: An array of of ONVIF media profiles supported by the ONVIF device. + name: media_profiles + types: + - [] +methods: +- uid: azure.media.videoanalyzeredge.OnvifDevice.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.OnvifDevice.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.OnvifDevice.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.OnvifDevice.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.OnvifDevice.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.OnvifDevice.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.OnvifDevice.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDeviceDiscoverRequest.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDeviceDiscoverRequest.yml new file mode 100644 index 00000000..0ca75303 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDeviceDiscoverRequest.yml @@ -0,0 +1,155 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.OnvifDeviceDiscoverRequest +name: OnvifDeviceDiscoverRequest +fullName: azure.media.videoanalyzeredge.OnvifDeviceDiscoverRequest +module: azure.media.videoanalyzeredge +summary: 'Lists all the discoverable ONVIF devices on the same subnet as the Edge + Module. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'OnvifDeviceDiscoverRequest(*, api_version: str | None = ''1.1'', discovery_duration: + str | None = None, **kwargs)' + keywordOnlyParameters: + - name: api_version + description: 'Video Analyzer API version. The only acceptable values to pass in + are + + None and "1.1". The default value is "1.1".' + defaultValue: '1.1' + types: + - + - name: discovery_duration + description: 'The amount of time that the ONVIF device discovery will wait for + + supported device responses.' + types: + - +variables: +- description: Required. Direct method method name.Constant filled by server. + name: method_name + types: + - +- description: 'Video Analyzer API version. The only acceptable values to pass in + are None + + and "1.1". The default value is "1.1".' + name: api_version + types: + - +- description: 'The amount of time that the ONVIF device discovery will wait for + + supported device responses.' + name: discovery_duration + types: + - +methods: +- uid: azure.media.videoanalyzeredge.OnvifDeviceDiscoverRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.OnvifDeviceDiscoverRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.OnvifDeviceDiscoverRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.OnvifDeviceDiscoverRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.OnvifDeviceDiscoverRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.OnvifDeviceDiscoverRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.OnvifDeviceDiscoverRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDeviceGetRequest.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDeviceGetRequest.yml new file mode 100644 index 00000000..d04363b5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDeviceGetRequest.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.OnvifDeviceGetRequest +name: OnvifDeviceGetRequest +fullName: azure.media.videoanalyzeredge.OnvifDeviceGetRequest +module: azure.media.videoanalyzeredge +summary: 'Retrieves properties and media profiles of an ONVIF device. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'OnvifDeviceGetRequest(*, endpoint: EndpointBase, api_version: str | None + = ''1.1'', **kwargs)' + keywordOnlyParameters: + - name: api_version + description: 'Video Analyzer API version. The only acceptable values to pass in + are + + None and "1.1". The default value is "1.1".' + defaultValue: '1.1' + types: + - + - name: endpoint + description: Required. Base class for endpoints. + types: + - +variables: +- description: Required. Direct method method name.Constant filled by server. + name: method_name + types: + - +- description: 'Video Analyzer API version. The only acceptable values to pass in + are None + + and "1.1". The default value is "1.1".' + name: api_version + types: + - +- description: Required. Base class for endpoints. + name: endpoint + types: + - +methods: +- uid: azure.media.videoanalyzeredge.OnvifDeviceGetRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.OnvifDeviceGetRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.OnvifDeviceGetRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.OnvifDeviceGetRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.OnvifDeviceGetRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.OnvifDeviceGetRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.OnvifDeviceGetRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDns.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDns.yml new file mode 100644 index 00000000..9919b853 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDns.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.OnvifDns +name: OnvifDns +fullName: azure.media.videoanalyzeredge.OnvifDns +module: azure.media.videoanalyzeredge +summary: The ONVIF device DNS properties. +constructor: + syntax: 'OnvifDns(*, from_dhcp: bool | None = None, ipv4_address: List[str] | None + = None, ipv6_address: List[str] | None = None, **kwargs)' + keywordOnlyParameters: + - name: from_dhcp + description: Result value showing if the ONVIF device is configured to use DHCP. + types: + - + - name: ipv4_address + description: An array of IPv4 address for the discovered ONVIF device. + types: + - [] + - name: ipv6_address + description: An array of IPv6 address for the discovered ONVIF device. + types: + - [] +variables: +- description: Result value showing if the ONVIF device is configured to use DHCP. + name: from_dhcp + types: + - +- description: An array of IPv4 address for the discovered ONVIF device. + name: ipv4_address + types: + - [] +- description: An array of IPv6 address for the discovered ONVIF device. + name: ipv6_address + types: + - [] +methods: +- uid: azure.media.videoanalyzeredge.OnvifDns.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.OnvifDns.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.OnvifDns.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.OnvifDns.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.OnvifDns.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.OnvifDns.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.OnvifDns.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifHostName.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifHostName.yml new file mode 100644 index 00000000..9e39cfab --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifHostName.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.OnvifHostName +name: OnvifHostName +fullName: azure.media.videoanalyzeredge.OnvifHostName +module: azure.media.videoanalyzeredge +summary: The ONVIF device DNS properties. +constructor: + syntax: 'OnvifHostName(*, from_dhcp: bool | None = None, hostname: str | None = + None, **kwargs)' + keywordOnlyParameters: + - name: from_dhcp + description: Result value showing if the ONVIF device is configured to use DHCP. + types: + - + - name: hostname + description: The hostname of the ONVIF device. + types: + - +variables: +- description: Result value showing if the ONVIF device is configured to use DHCP. + name: from_dhcp + types: + - +- description: The hostname of the ONVIF device. + name: hostname + types: + - +methods: +- uid: azure.media.videoanalyzeredge.OnvifHostName.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.OnvifHostName.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.OnvifHostName.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.OnvifHostName.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.OnvifHostName.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.OnvifHostName.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.OnvifHostName.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifSystemDateTime.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifSystemDateTime.yml new file mode 100644 index 00000000..db362052 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifSystemDateTime.yml @@ -0,0 +1,149 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.OnvifSystemDateTime +name: OnvifSystemDateTime +fullName: azure.media.videoanalyzeredge.OnvifSystemDateTime +module: azure.media.videoanalyzeredge +summary: The ONVIF device DNS properties. +constructor: + syntax: 'OnvifSystemDateTime(*, type: str | OnvifSystemDateTimeType | None = None, + time: str | None = None, time_zone: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: type + description: 'An enum value determining whether the date time was configured using + NTP or + + manual. Possible values include: "Ntp", "Manual".' + types: + - + - + - name: time + description: The device datetime returned when calling the request. + types: + - + - name: time_zone + description: The timezone of the ONVIF device datetime. + types: + - +variables: +- description: 'An enum value determining whether the date time was configured using + NTP or manual. + + Possible values include: "Ntp", "Manual".' + name: type + types: + - + - +- description: The device datetime returned when calling the request. + name: time + types: + - +- description: The timezone of the ONVIF device datetime. + name: time_zone + types: + - +methods: +- uid: azure.media.videoanalyzeredge.OnvifSystemDateTime.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.OnvifSystemDateTime.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.OnvifSystemDateTime.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.OnvifSystemDateTime.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.OnvifSystemDateTime.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.OnvifSystemDateTime.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.OnvifSystemDateTime.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifSystemDateTimeType.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifSystemDateTimeType.yml new file mode 100644 index 00000000..4aa55774 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifSystemDateTimeType.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.media.videoanalyzeredge.OnvifSystemDateTimeType +name: OnvifSystemDateTimeType +fullName: azure.media.videoanalyzeredge.OnvifSystemDateTimeType +summary: An enum value determining whether the date time was configured using NTP + or manual. +module: azure.media.videoanalyzeredge +fields: +- name: MANUAL + uid: azure.media.videoanalyzeredge.OnvifSystemDateTimeType.MANUAL +- name: NTP + uid: azure.media.videoanalyzeredge.OnvifSystemDateTimeType.NTP diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OutputSelector.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OutputSelector.yml new file mode 100644 index 00000000..3b8fd3ee --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OutputSelector.yml @@ -0,0 +1,155 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.OutputSelector +name: OutputSelector +fullName: azure.media.videoanalyzeredge.OutputSelector +module: azure.media.videoanalyzeredge +summary: Allows for the selection of particular streams from another node. +constructor: + syntax: 'OutputSelector(*, property: str | OutputSelectorProperty | None = None, + operator: str | OutputSelectorOperator | None = None, value: str | None = None, + **kwargs)' + keywordOnlyParameters: + - name: property + description: 'The property of the data stream to be used as the selection criteria. + + Possible values include: "mediaType".' + types: + - + - + - name: operator + description: 'The operator to compare properties by. Possible values include: + "is", + + "isNot".' + types: + - + - + - name: value + description: Value to compare against. + types: + - +variables: +- description: 'The property of the data stream to be used as the selection criteria. + Possible + + values include: "mediaType".' + name: property + types: + - + - +- description: 'The operator to compare properties by. Possible values include: "is", + "isNot".' + name: operator + types: + - + - +- description: Value to compare against. + name: value + types: + - +methods: +- uid: azure.media.videoanalyzeredge.OutputSelector.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.OutputSelector.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.OutputSelector.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.OutputSelector.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.OutputSelector.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.OutputSelector.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.OutputSelector.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OutputSelectorOperator.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OutputSelectorOperator.yml new file mode 100644 index 00000000..c2d2bbff --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OutputSelectorOperator.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.media.videoanalyzeredge.OutputSelectorOperator +name: OutputSelectorOperator +fullName: azure.media.videoanalyzeredge.OutputSelectorOperator +summary: The operator to compare properties by. +module: azure.media.videoanalyzeredge +fields: +- name: IS_ENUM + uid: azure.media.videoanalyzeredge.OutputSelectorOperator.IS_ENUM +- name: IS_NOT + uid: azure.media.videoanalyzeredge.OutputSelectorOperator.IS_NOT diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OutputSelectorProperty.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OutputSelectorProperty.yml new file mode 100644 index 00000000..8b3b46f8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OutputSelectorProperty.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonEnum +uid: azure.media.videoanalyzeredge.OutputSelectorProperty +name: OutputSelectorProperty +fullName: azure.media.videoanalyzeredge.OutputSelectorProperty +summary: The property of the data stream to be used as the selection criteria. +module: azure.media.videoanalyzeredge +fields: +- name: MEDIA_TYPE + uid: azure.media.videoanalyzeredge.OutputSelectorProperty.MEDIA_TYPE diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ParameterDeclaration.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ParameterDeclaration.yml new file mode 100644 index 00000000..d59366c4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ParameterDeclaration.yml @@ -0,0 +1,167 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.ParameterDeclaration +name: ParameterDeclaration +fullName: azure.media.videoanalyzeredge.ParameterDeclaration +module: azure.media.videoanalyzeredge +summary: 'Single topology parameter declaration. Declared parameters can and must + be referenced throughout the topology and can optionally have default values to + be used when they are not defined in the pipeline instances. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ParameterDeclaration(*, name: str, type: str | ParameterType, description: + str | None = None, default: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Name of the parameter. + types: + - + - name: type + description: 'Required. Type of the parameter. Possible values include: "string", + + "secretString", "int", "double", "bool".' + types: + - + - + - name: description + description: Description of the parameter. + types: + - + - name: default + description: 'The default value for the parameter to be used if the live pipeline + does not + + specify a value.' + types: + - +variables: +- description: Required. Name of the parameter. + name: name + types: + - +- description: 'Required. Type of the parameter. Possible values include: "string", + "secretString", + + "int", "double", "bool".' + name: type + types: + - + - +- description: Description of the parameter. + name: description + types: + - +- description: 'The default value for the parameter to be used if the live pipeline + does not + + specify a value.' + name: default + types: + - +methods: +- uid: azure.media.videoanalyzeredge.ParameterDeclaration.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ParameterDeclaration.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ParameterDeclaration.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.ParameterDeclaration.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ParameterDeclaration.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.ParameterDeclaration.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ParameterDeclaration.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ParameterDefinition.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ParameterDefinition.yml new file mode 100644 index 00000000..3fa0d710 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ParameterDefinition.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.ParameterDefinition +name: ParameterDefinition +fullName: azure.media.videoanalyzeredge.ParameterDefinition +module: azure.media.videoanalyzeredge +summary: 'Defines the parameter value of an specific pipeline topology parameter. + See pipeline topology parameters for more information. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ParameterDefinition(*, name: str, value: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Name of the parameter declared in the pipeline topology. + types: + - + - name: value + description: Parameter value to be applied on this specific live pipeline. + types: + - +variables: +- description: Required. Name of the parameter declared in the pipeline topology. + name: name + types: + - +- description: Parameter value to be applied on this specific live pipeline. + name: value + types: + - +methods: +- uid: azure.media.videoanalyzeredge.ParameterDefinition.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ParameterDefinition.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ParameterDefinition.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.ParameterDefinition.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ParameterDefinition.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.ParameterDefinition.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ParameterDefinition.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ParameterType.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ParameterType.yml new file mode 100644 index 00000000..383af016 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ParameterType.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonEnum +uid: azure.media.videoanalyzeredge.ParameterType +name: ParameterType +fullName: azure.media.videoanalyzeredge.ParameterType +summary: Type of the parameter. +module: azure.media.videoanalyzeredge +fields: +- name: BOOL + uid: azure.media.videoanalyzeredge.ParameterType.BOOL +- name: DOUBLE + uid: azure.media.videoanalyzeredge.ParameterType.DOUBLE +- name: INT + uid: azure.media.videoanalyzeredge.ParameterType.INT +- name: SECRET_STRING + uid: azure.media.videoanalyzeredge.ParameterType.SECRET_STRING +- name: STRING + uid: azure.media.videoanalyzeredge.ParameterType.STRING diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PemCertificateList.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PemCertificateList.yml new file mode 100644 index 00000000..d5e6df99 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PemCertificateList.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.PemCertificateList +name: PemCertificateList +fullName: azure.media.videoanalyzeredge.PemCertificateList +module: azure.media.videoanalyzeredge +summary: 'A list of PEM formatted certificates. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PemCertificateList(*, certificates: List[str], **kwargs)' + keywordOnlyParameters: + - name: certificates + description: Required. PEM formatted public certificates. One certificate per + entry. + types: + - [] +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. PEM formatted public certificates. One certificate per entry. + name: certificates + types: + - [] +methods: +- uid: azure.media.videoanalyzeredge.PemCertificateList.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.PemCertificateList.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.PemCertificateList.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.PemCertificateList.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.PemCertificateList.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.PemCertificateList.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.PemCertificateList.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopology.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopology.yml new file mode 100644 index 00000000..1e43ba0c --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopology.yml @@ -0,0 +1,149 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.PipelineTopology +name: PipelineTopology +fullName: azure.media.videoanalyzeredge.PipelineTopology +module: azure.media.videoanalyzeredge +summary: "Pipeline topology describes the processing steps to be applied when processing\ + \ media for a particular outcome. The topology should be defined according to the\ + \ scenario to be achieved and can be reused across many pipeline instances which\ + \ share the same processing characteristics. For instance, a pipeline topology which\ + \ acquires data from a RTSP camera, process it with an specific AI model and stored\ + \ the data on the cloud can be reused across many different cameras, as long as\ + \ the same processing should be applied across all the cameras. Individual instance\ + \ properties can be defined through the use of user-defined parameters, which allow\ + \ for a topology to be parameterized, thus allowing individual pipelines to refer\ + \ to different values, such as individual cameras RTSP endpoints and credentials.\ + \ Overall a topology is composed of the following:\n\n* Parameters: list of user\ + \ defined parameters that can be references across the topology nodes. \n\n* Sources:\ + \ list of one or more data sources nodes such as an RTSP source which allows for\ + \ media to be ingested from cameras. \n\n* Processors: list of nodes which perform\ + \ data analysis or transformations. -Sinks: list of one or more data sinks which\ + \ allow for data to be stored or exported to other destinations. \n\n All required\ + \ parameters must be populated in order to send to Azure.\n\n ivar name:\n \ + \ Required. Pipeline topology unique identifier.\n\n vartype name:\n \ + \ str\n\n ivar system_data:\n Read-only system metadata associated\ + \ with this object.\n\n vartype system_data:\n ~azure.media.videoanalyzer.edge.models.SystemData\n\ + \n ivar properties:\n Pipeline topology properties.\n\n vartype properties:\n\ + \ ~azure.media.videoanalyzer.edge.models.PipelineTopologyProperties" +constructor: + syntax: 'PipelineTopology(*, name: str, system_data: SystemData | None = None, properties: + PipelineTopologyProperties | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Pipeline topology unique identifier. + types: + - + - name: system_data + description: Read-only system metadata associated with this object. + types: + - + - name: properties + description: Pipeline topology properties. + types: + - +methods: +- uid: azure.media.videoanalyzeredge.PipelineTopology.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.PipelineTopology.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.PipelineTopology.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.PipelineTopology.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.PipelineTopology.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.PipelineTopology.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.PipelineTopology.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyCollection.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyCollection.yml new file mode 100644 index 00000000..4bcee5eb --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyCollection.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.PipelineTopologyCollection +name: PipelineTopologyCollection +fullName: azure.media.videoanalyzeredge.PipelineTopologyCollection +module: azure.media.videoanalyzeredge +summary: A collection of pipeline topologies. +constructor: + syntax: 'PipelineTopologyCollection(*, value: List[PipelineTopology] | None = None, + continuation_token: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: List of pipeline topologies. + types: + - [] + - name: continuation_token + description: 'A continuation token to be used in subsequent calls when + + enumerating through the collection. This is returned when the collection results + won''t fit in a + + single response.' + types: + - +variables: +- description: List of pipeline topologies. + name: value + types: + - [] +- description: 'A continuation token to be used in subsequent calls when enumerating + + through the collection. This is returned when the collection results won''t fit + in a single + + response.' + name: continuation_token + types: + - +methods: +- uid: azure.media.videoanalyzeredge.PipelineTopologyCollection.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.PipelineTopologyCollection.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.PipelineTopologyCollection.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.PipelineTopologyCollection.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.PipelineTopologyCollection.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.PipelineTopologyCollection.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.PipelineTopologyCollection.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyDeleteRequest.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyDeleteRequest.yml new file mode 100644 index 00000000..480cd8fe --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyDeleteRequest.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.PipelineTopologyDeleteRequest +name: PipelineTopologyDeleteRequest +fullName: azure.media.videoanalyzeredge.PipelineTopologyDeleteRequest +module: azure.media.videoanalyzeredge +summary: 'Deletes an existing pipeline topology. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PipelineTopologyDeleteRequest(*, name: str, api_version: str | None = ''1.1'', + **kwargs)' + keywordOnlyParameters: + - name: api_version + description: 'Video Analyzer API version. The only acceptable values to pass in + are + + None and "1.1". The default value is "1.1".' + defaultValue: '1.1' + types: + - + - name: name + description: Required. Resource name. + types: + - +variables: +- description: Required. Direct method method name.Constant filled by server. + name: method_name + types: + - +- description: 'Video Analyzer API version. The only acceptable values to pass in + are None + + and "1.1". The default value is "1.1".' + name: api_version + types: + - +- description: Required. Resource name. + name: name + types: + - +methods: +- uid: azure.media.videoanalyzeredge.PipelineTopologyDeleteRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.PipelineTopologyDeleteRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.PipelineTopologyDeleteRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.PipelineTopologyDeleteRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.PipelineTopologyDeleteRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.PipelineTopologyDeleteRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.PipelineTopologyDeleteRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyGetRequest.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyGetRequest.yml new file mode 100644 index 00000000..ec5185a5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyGetRequest.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.PipelineTopologyGetRequest +name: PipelineTopologyGetRequest +fullName: azure.media.videoanalyzeredge.PipelineTopologyGetRequest +module: azure.media.videoanalyzeredge +summary: 'Retrieves an existing pipeline topology. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PipelineTopologyGetRequest(*, name: str, api_version: str | None = ''1.1'', + **kwargs)' + keywordOnlyParameters: + - name: api_version + description: 'Video Analyzer API version. The only acceptable values to pass in + are + + None and "1.1". The default value is "1.1".' + defaultValue: '1.1' + types: + - + - name: name + description: Required. Resource name. + types: + - +variables: +- description: Required. Direct method method name.Constant filled by server. + name: method_name + types: + - +- description: 'Video Analyzer API version. The only acceptable values to pass in + are None + + and "1.1". The default value is "1.1".' + name: api_version + types: + - +- description: Required. Resource name. + name: name + types: + - +methods: +- uid: azure.media.videoanalyzeredge.PipelineTopologyGetRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.PipelineTopologyGetRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.PipelineTopologyGetRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.PipelineTopologyGetRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.PipelineTopologyGetRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.PipelineTopologyGetRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.PipelineTopologyGetRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyListRequest.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyListRequest.yml new file mode 100644 index 00000000..46af1c0a --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyListRequest.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.PipelineTopologyListRequest +name: PipelineTopologyListRequest +fullName: azure.media.videoanalyzeredge.PipelineTopologyListRequest +module: azure.media.videoanalyzeredge +summary: 'List all existing pipeline topologies. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PipelineTopologyListRequest(*, api_version: str | None = ''1.1'', **kwargs)' + keywordOnlyParameters: + - name: api_version + description: 'Video Analyzer API version. The only acceptable values to pass in + are + + None and "1.1". The default value is "1.1".' + defaultValue: '1.1' + types: + - +variables: +- description: Required. Direct method method name.Constant filled by server. + name: method_name + types: + - +- description: 'Video Analyzer API version. The only acceptable values to pass in + are None + + and "1.1". The default value is "1.1".' + name: api_version + types: + - +methods: +- uid: azure.media.videoanalyzeredge.PipelineTopologyListRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.PipelineTopologyListRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.PipelineTopologyListRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.PipelineTopologyListRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.PipelineTopologyListRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.PipelineTopologyListRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.PipelineTopologyListRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyProperties.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyProperties.yml new file mode 100644 index 00000000..c5a8dd59 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyProperties.yml @@ -0,0 +1,201 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.PipelineTopologyProperties +name: PipelineTopologyProperties +fullName: azure.media.videoanalyzeredge.PipelineTopologyProperties +module: azure.media.videoanalyzeredge +summary: Pipeline topology properties. +constructor: + syntax: 'PipelineTopologyProperties(*, description: str | None = None, parameters: + List[ParameterDeclaration] | None = None, sources: List[SourceNodeBase] | None + = None, processors: List[ProcessorNodeBase] | None = None, sinks: List[SinkNodeBase] + | None = None, **kwargs)' + keywordOnlyParameters: + - name: description + description: 'An optional description of the pipeline topology. It is recommended + that + + the expected use of the topology to be described here.' + types: + - + - name: parameters + description: 'List of the topology parameter declarations. Parameters declared + here can + + be referenced throughout the topology nodes through the use of "${PARAMETER_NAME}" + string + + pattern. Parameters can have optional default values and can later be defined + in individual + + instances of the pipeline.' + types: + - [] + - name: sources + description: 'List of the topology source nodes. Source nodes enable external + data to be + + ingested by the pipeline.' + types: + - [] + - name: processors + description: 'List of the topology processor nodes. Processor nodes enable pipeline + data + + to be analyzed, processed or transformed.' + types: + - [] + - name: sinks + description: 'List of the topology sink nodes. Sink nodes allow pipeline data + to be stored or + + exported.' + types: + - [] +variables: +- description: 'An optional description of the pipeline topology. It is recommended + that the + + expected use of the topology to be described here.' + name: description + types: + - +- description: 'List of the topology parameter declarations. Parameters declared here + can be + + referenced throughout the topology nodes through the use of "${PARAMETER_NAME}" + string pattern. + + Parameters can have optional default values and can later be defined in individual + instances of + + the pipeline.' + name: parameters + types: + - [] +- description: 'List of the topology source nodes. Source nodes enable external data + to be + + ingested by the pipeline.' + name: sources + types: + - [] +- description: 'List of the topology processor nodes. Processor nodes enable pipeline + data to + + be analyzed, processed or transformed.' + name: processors + types: + - [] +- description: 'List of the topology sink nodes. Sink nodes allow pipeline data to + be stored or + + exported.' + name: sinks + types: + - [] +methods: +- uid: azure.media.videoanalyzeredge.PipelineTopologyProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.PipelineTopologyProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.PipelineTopologyProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.PipelineTopologyProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.PipelineTopologyProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.PipelineTopologyProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.PipelineTopologyProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologySetRequest.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologySetRequest.yml new file mode 100644 index 00000000..08345a9d --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologySetRequest.yml @@ -0,0 +1,165 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.PipelineTopologySetRequest +name: PipelineTopologySetRequest +fullName: azure.media.videoanalyzeredge.PipelineTopologySetRequest +module: azure.media.videoanalyzeredge +summary: 'Creates a new pipeline topology or updates an existing one. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PipelineTopologySetRequest(*, pipeline_topology: PipelineTopology, api_version: + str | None = ''1.1'', **kwargs)' + keywordOnlyParameters: + - name: api_version + description: 'Video Analyzer API version. The only acceptable values to pass in + are + + None and "1.1". The default value is "1.1".' + defaultValue: '1.1' + types: + - + - name: pipeline_topology + description: "Required. Pipeline topology describes the processing steps to be\n\ + applied when processing media for a particular outcome. The topology should\ + \ be defined\naccording to the scenario to be achieved and can be reused across\ + \ many pipeline instances which\nshare the same processing characteristics.\ + \ For instance, a pipeline topology which acquires\ndata from a RTSP camera,\ + \ process it with an specific AI model and stored the data on the cloud\ncan\ + \ be reused across many different cameras, as long as the same processing should\ + \ be applied\nacross all the cameras. Individual instance properties can be\ + \ defined through the use of\nuser-defined parameters, which allow for a topology\ + \ to be parameterized, thus allowing\nindividual pipelines to refer to different\ + \ values, such as individual cameras RTSP endpoints\nand credentials. Overall\ + \ a topology is composed of the following:\n\n* Parameters: list of user defined\ + \ parameters that can be references across the topology \n\nnodes.\n* Sources:\ + \ list of one or more data sources nodes such as an RTSP source which allows\ + \ for\nmedia to be ingested from cameras.\n* Processors: list of nodes which\ + \ perform data analysis or transformations.\n\n -Sinks: list of one or more\ + \ data sinks which allow for data to be stored or exported to\n\nother destinations." + types: + - +variables: +- description: Required. Direct method method name.Constant filled by server. + name: method_name + types: + - +- description: 'Video Analyzer API version. The only acceptable values to pass in + are None + + and "1.1". The default value is "1.1".' + name: api_version + types: + - +- description: "Required. Pipeline topology describes the processing steps to be\n\ + applied when processing media for a particular outcome. The topology should be\ + \ defined\naccording to the scenario to be achieved and can be reused across many\ + \ pipeline instances which\nshare the same processing characteristics. For instance,\ + \ a pipeline topology which acquires\ndata from a RTSP camera, process it with\ + \ an specific AI model and stored the data on the cloud\ncan be reused across\ + \ many different cameras, as long as the same processing should be applied\nacross\ + \ all the cameras. Individual instance properties can be defined through the use\ + \ of\nuser-defined parameters, which allow for a topology to be parameterized,\ + \ thus allowing\nindividual pipelines to refer to different values, such as individual\ + \ cameras RTSP endpoints\nand credentials. Overall a topology is composed of the\ + \ following:\n\n* Parameters: list of user defined parameters that can be references\ + \ across the topology \n\nnodes.\n* Sources: list of one or more data sources\ + \ nodes such as an RTSP source which allows for\nmedia to be ingested from cameras.\n\ + * Processors: list of nodes which perform data analysis or transformations.\n\n\ + \ -Sinks: list of one or more data sinks which allow for data to be stored or\ + \ exported to\n\nother destinations." + name: pipeline_topology + types: + - +methods: +- uid: azure.media.videoanalyzeredge.PipelineTopologySetRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.PipelineTopologySetRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.PipelineTopologySetRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.PipelineTopologySetRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.PipelineTopologySetRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.PipelineTopologySetRequest.serialize + name: serialize + signature: serialize() +- uid: azure.media.videoanalyzeredge.PipelineTopologySetRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologySetRequestBody.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologySetRequestBody.yml new file mode 100644 index 00000000..5fa86a7b --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologySetRequestBody.yml @@ -0,0 +1,163 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.PipelineTopologySetRequestBody +name: PipelineTopologySetRequestBody +fullName: azure.media.videoanalyzeredge.PipelineTopologySetRequestBody +module: azure.media.videoanalyzeredge +summary: "Pipeline topology describes the processing steps to be applied when processing\ + \ media for a particular outcome. The topology should be defined according to the\ + \ scenario to be achieved and can be reused across many pipeline instances which\ + \ share the same processing characteristics. For instance, a pipeline topology which\ + \ acquires data from a RTSP camera, process it with an specific AI model and stored\ + \ the data on the cloud can be reused across many different cameras, as long as\ + \ the same processing should be applied across all the cameras. Individual instance\ + \ properties can be defined through the use of user-defined parameters, which allow\ + \ for a topology to be parameterized, thus allowing individual pipelines to refer\ + \ to different values, such as individual cameras RTSP endpoints and credentials.\ + \ Overall a topology is composed of the following:\n\n* Parameters: list of user\ + \ defined parameters that can be references across the topology nodes. \n\n* Sources:\ + \ list of one or more data sources nodes such as an RTSP source which allows for\ + \ media to be ingested from cameras. \n\n* Processors: list of nodes which perform\ + \ data analysis or transformations. -Sinks: list of one or more data sinks which\ + \ allow for data to be stored or exported to other destinations. \n\n Variables\ + \ are only populated by the server, and will be ignored when sending a request.\n\ + \n All required parameters must be populated in order to send to Azure.\n\n\ + \ ivar method_name:\n Required. Direct method method name.Constant filled\ + \ by server.\n\n vartype method_name:\n str\n\n ivar api_version:\n\ + \ Video Analyzer API version. The only acceptable values to pass in are None\n\ + \ and \"1.1\". The default value is \"1.1\".\n\n vartype api_version:\n\ + \ str\n\n ivar name:\n Required. Pipeline topology unique identifier.\n\ + \n vartype name:\n str\n\n ivar system_data:\n Read-only system\ + \ metadata associated with this object.\n\n vartype system_data:\n ~azure.media.videoanalyzer.edge.models.SystemData\n\ + \n ivar properties:\n Pipeline topology properties.\n\n vartype properties:\n\ + \ ~azure.media.videoanalyzer.edge.models.PipelineTopologyProperties" +constructor: + syntax: 'PipelineTopologySetRequestBody(*, name: str, api_version: str | None = + ''1.1'', system_data: SystemData | None = None, properties: PipelineTopologyProperties + | None = None, **kwargs)' + keywordOnlyParameters: + - name: api_version + description: 'Video Analyzer API version. The only acceptable values to pass in + are + + None and "1.1". The default value is "1.1".' + defaultValue: '1.1' + types: + - + - name: name + description: Required. Pipeline topology unique identifier. + types: + - + - name: system_data + description: Read-only system metadata associated with this object. + types: + - + - name: properties + description: Pipeline topology properties. + types: + - +methods: +- uid: azure.media.videoanalyzeredge.PipelineTopologySetRequestBody.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.PipelineTopologySetRequestBody.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.PipelineTopologySetRequestBody.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.PipelineTopologySetRequestBody.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.PipelineTopologySetRequestBody.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.PipelineTopologySetRequestBody.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.PipelineTopologySetRequestBody.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ProcessorNodeBase.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ProcessorNodeBase.yml new file mode 100644 index 00000000..f17eedf0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ProcessorNodeBase.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.ProcessorNodeBase +name: ProcessorNodeBase +fullName: azure.media.videoanalyzeredge.ProcessorNodeBase +module: azure.media.videoanalyzeredge +summary: 'Base class for topology processor nodes. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: CognitiveServicesVisionProcessor, ExtensionProcessorBase, LineCrossingProcessor, + MotionDetectionProcessor, ObjectTrackingProcessor, SignalGateProcessor. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ProcessorNodeBase(*, name: str, inputs: List[NodeInput], **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Node name. Must be unique within the topology. + types: + - + - name: inputs + description: 'Required. An array of upstream node references within the topology + to be used + + as inputs for this node.' + types: + - [] +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. Node name. Must be unique within the topology. + name: name + types: + - +- description: 'Required. An array of upstream node references within the topology + to be used as + + inputs for this node.' + name: inputs + types: + - [] +methods: +- uid: azure.media.videoanalyzeredge.ProcessorNodeBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ProcessorNodeBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ProcessorNodeBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.ProcessorNodeBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.ProcessorNodeBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.ProcessorNodeBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.ProcessorNodeBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RateControl.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RateControl.yml new file mode 100644 index 00000000..9765a593 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RateControl.yml @@ -0,0 +1,160 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.RateControl +name: RateControl +fullName: azure.media.videoanalyzeredge.RateControl +module: azure.media.videoanalyzeredge +summary: Class representing the video's rate control. +constructor: + syntax: 'RateControl(*, bit_rate_limit: float | None = None, encoding_interval: + float | None = None, frame_rate_limit: float | None = None, guaranteed_frame_rate: + bool | None = None, **kwargs)' + keywordOnlyParameters: + - name: bit_rate_limit + description: the maximum output bitrate in kbps. + types: + - + - name: encoding_interval + description: Interval at which images are encoded and transmitted. + types: + - + - name: frame_rate_limit + description: Maximum output framerate in fps. + types: + - + - name: guaranteed_frame_rate + description: 'A value of true indicates that frame rate is a fixed value + + rather than an upper limit, and that the video encoder shall prioritize frame + rate over all + + other adaptable configuration values such as bitrate.' + types: + - +variables: +- description: the maximum output bitrate in kbps. + name: bit_rate_limit + types: + - +- description: Interval at which images are encoded and transmitted. + name: encoding_interval + types: + - +- description: Maximum output framerate in fps. + name: frame_rate_limit + types: + - +- description: 'A value of true indicates that frame rate is a fixed value rather + + than an upper limit, and that the video encoder shall prioritize frame rate over + all other + + adaptable configuration values such as bitrate.' + name: guaranteed_frame_rate + types: + - +methods: +- uid: azure.media.videoanalyzeredge.RateControl.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.RateControl.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.RateControl.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.RateControl.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.RateControl.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.RateControl.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.RateControl.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapter.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapter.yml new file mode 100644 index 00000000..85fe9424 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapter.yml @@ -0,0 +1,147 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.RemoteDeviceAdapter +name: RemoteDeviceAdapter +fullName: azure.media.videoanalyzeredge.RemoteDeviceAdapter +module: azure.media.videoanalyzeredge +summary: 'The Video Analyzer edge module can act as a transparent gateway for video, + enabling IoT devices to send video to the cloud from behind a firewall. A remote + device adapter should be created for each such IoT device. Communication between + the cloud and IoT device would then flow via the Video Analyzer edge module. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RemoteDeviceAdapter(*, name: str, system_data: SystemData | None = None, + properties: RemoteDeviceAdapterProperties | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. The unique identifier for the remote device adapter. + types: + - + - name: system_data + description: Read-only system metadata associated with this object. + types: + - + - name: properties + description: Properties of the remote device adapter. + types: + - +variables: +- description: Required. The unique identifier for the remote device adapter. + name: name + types: + - +- description: Read-only system metadata associated with this object. + name: system_data + types: + - +- description: Properties of the remote device adapter. + name: properties + types: + - +methods: +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapter.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapter.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapter.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapter.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapter.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapter.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapter.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterCollection.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterCollection.yml new file mode 100644 index 00000000..304b7a10 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterCollection.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterCollection +name: RemoteDeviceAdapterCollection +fullName: azure.media.videoanalyzeredge.RemoteDeviceAdapterCollection +module: azure.media.videoanalyzeredge +summary: A list of remote device adapters. +constructor: + syntax: 'RemoteDeviceAdapterCollection(*, value: List[RemoteDeviceAdapter] | None + = None, continuation_token: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: An array of remote device adapters. + types: + - [] + - name: continuation_token + description: 'A continuation token to use in subsequent calls to enumerate + + through the remote device adapter collection. This is used when the collection + contains too + + many results to return in one response.' + types: + - +variables: +- description: An array of remote device adapters. + name: value + types: + - [] +- description: 'A continuation token to use in subsequent calls to enumerate through + + the remote device adapter collection. This is used when the collection contains + too many + + results to return in one response.' + name: continuation_token + types: + - +methods: +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterCollection.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterCollection.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterCollection.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterCollection.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterCollection.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterCollection.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterCollection.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterDeleteRequest.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterDeleteRequest.yml new file mode 100644 index 00000000..efc6d8e8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterDeleteRequest.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterDeleteRequest +name: RemoteDeviceAdapterDeleteRequest +fullName: azure.media.videoanalyzeredge.RemoteDeviceAdapterDeleteRequest +module: azure.media.videoanalyzeredge +summary: 'Deletes an existing remote device adapter. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RemoteDeviceAdapterDeleteRequest(*, name: str, api_version: str | None + = ''1.1'', **kwargs)' + keywordOnlyParameters: + - name: api_version + description: 'Video Analyzer API version. The only acceptable values to pass in + are + + None and "1.1". The default value is "1.1".' + defaultValue: '1.1' + types: + - + - name: name + description: Required. Resource name. + types: + - +variables: +- description: Required. Direct method method name.Constant filled by server. + name: method_name + types: + - +- description: 'Video Analyzer API version. The only acceptable values to pass in + are None + + and "1.1". The default value is "1.1".' + name: api_version + types: + - +- description: Required. Resource name. + name: name + types: + - +methods: +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterDeleteRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterDeleteRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterDeleteRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterDeleteRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterDeleteRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterDeleteRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterDeleteRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterGetRequest.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterGetRequest.yml new file mode 100644 index 00000000..f7bac6b6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterGetRequest.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterGetRequest +name: RemoteDeviceAdapterGetRequest +fullName: azure.media.videoanalyzeredge.RemoteDeviceAdapterGetRequest +module: azure.media.videoanalyzeredge +summary: 'Retrieves an existing remote device adapter. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RemoteDeviceAdapterGetRequest(*, name: str, api_version: str | None = ''1.1'', + **kwargs)' + keywordOnlyParameters: + - name: api_version + description: 'Video Analyzer API version. The only acceptable values to pass in + are + + None and "1.1". The default value is "1.1".' + defaultValue: '1.1' + types: + - + - name: name + description: Required. Resource name. + types: + - +variables: +- description: Required. Direct method method name.Constant filled by server. + name: method_name + types: + - +- description: 'Video Analyzer API version. The only acceptable values to pass in + are None + + and "1.1". The default value is "1.1".' + name: api_version + types: + - +- description: Required. Resource name. + name: name + types: + - +methods: +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterGetRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterGetRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterGetRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterGetRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterGetRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterGetRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterGetRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterListRequest.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterListRequest.yml new file mode 100644 index 00000000..308a277a --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterListRequest.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterListRequest +name: RemoteDeviceAdapterListRequest +fullName: azure.media.videoanalyzeredge.RemoteDeviceAdapterListRequest +module: azure.media.videoanalyzeredge +summary: 'List all existing remote device adapters. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RemoteDeviceAdapterListRequest(*, api_version: str | None = ''1.1'', **kwargs)' + keywordOnlyParameters: + - name: api_version + description: 'Video Analyzer API version. The only acceptable values to pass in + are + + None and "1.1". The default value is "1.1".' + defaultValue: '1.1' + types: + - +variables: +- description: Required. Direct method method name.Constant filled by server. + name: method_name + types: + - +- description: 'Video Analyzer API version. The only acceptable values to pass in + are None + + and "1.1". The default value is "1.1".' + name: api_version + types: + - +methods: +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterListRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterListRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterListRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterListRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterListRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterListRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterListRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterProperties.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterProperties.yml new file mode 100644 index 00000000..359f2984 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterProperties.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterProperties +name: RemoteDeviceAdapterProperties +fullName: azure.media.videoanalyzeredge.RemoteDeviceAdapterProperties +module: azure.media.videoanalyzeredge +summary: 'Remote device adapter properties. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RemoteDeviceAdapterProperties(*, target: RemoteDeviceAdapterTarget, iot_hub_device_connection: + IotHubDeviceConnection, description: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: description + description: An optional description for the remote device adapter. + types: + - + - name: target + description: Required. The IoT device to which this remote device will connect. + types: + - + - name: iot_hub_device_connection + description: 'Required. Information that enables communication between + + the IoT Hub and the IoT device - allowing this edge module to act as a transparent + gateway + + between the two.' + types: + - +variables: +- description: An optional description for the remote device adapter. + name: description + types: + - +- description: Required. The IoT device to which this remote device will connect. + name: target + types: + - +- description: 'Required. Information that enables communication between the + + IoT Hub and the IoT device - allowing this edge module to act as a transparent + gateway between + + the two.' + name: iot_hub_device_connection + types: + - +methods: +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequest.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequest.yml new file mode 100644 index 00000000..1bc4b15f --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequest.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequest +name: RemoteDeviceAdapterSetRequest +fullName: azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequest +module: azure.media.videoanalyzeredge +summary: 'Creates a new remote device adapter or updates an existing one. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RemoteDeviceAdapterSetRequest(*, remote_device_adapter: RemoteDeviceAdapter, + api_version: str | None = ''1.1'', **kwargs)' + keywordOnlyParameters: + - name: api_version + description: 'Video Analyzer API version. The only acceptable values to pass in + are + + None and "1.1". The default value is "1.1".' + defaultValue: '1.1' + types: + - + - name: remote_device_adapter + description: 'Required. The Video Analyzer edge module can act as a + + transparent gateway for video, enabling IoT devices to send video to the cloud + from behind a + + firewall. A remote device adapter should be created for each such IoT device. + Communication + + between the cloud and IoT device would then flow via the Video Analyzer edge + module.' + types: + - +variables: +- description: Required. Direct method method name.Constant filled by server. + name: method_name + types: + - +- description: 'Video Analyzer API version. The only acceptable values to pass in + are None + + and "1.1". The default value is "1.1".' + name: api_version + types: + - +- description: 'Required. The Video Analyzer edge module can act as a transparent + + gateway for video, enabling IoT devices to send video to the cloud from behind + a firewall. A + + remote device adapter should be created for each such IoT device. Communication + between the + + cloud and IoT device would then flow via the Video Analyzer edge module.' + name: remote_device_adapter + types: + - +methods: +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequest.serialize + name: serialize + signature: serialize() +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequestBody.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequestBody.yml new file mode 100644 index 00000000..757dc9dd --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequestBody.yml @@ -0,0 +1,170 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequestBody +name: RemoteDeviceAdapterSetRequestBody +fullName: azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequestBody +module: azure.media.videoanalyzeredge +summary: 'The Video Analyzer edge module can act as a transparent gateway for video, + enabling IoT devices to send video to the cloud from behind a firewall. A remote + device adapter should be created for each such IoT device. Communication between + the cloud and IoT device would then flow via the Video Analyzer edge module. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RemoteDeviceAdapterSetRequestBody(*, name: str, api_version: str | None + = ''1.1'', system_data: SystemData | None = None, properties: RemoteDeviceAdapterProperties + | None = None, **kwargs)' + keywordOnlyParameters: + - name: api_version + description: 'Video Analyzer API version. The only acceptable values to pass in + are + + None and "1.1". The default value is "1.1".' + defaultValue: '1.1' + types: + - + - name: name + description: Required. The unique identifier for the remote device adapter. + types: + - + - name: system_data + description: Read-only system metadata associated with this object. + types: + - + - name: properties + description: Properties of the remote device adapter. + types: + - +variables: +- description: Required. Direct method method name.Constant filled by server. + name: method_name + types: + - +- description: 'Video Analyzer API version. The only acceptable values to pass in + are None + + and "1.1". The default value is "1.1".' + name: api_version + types: + - +- description: Required. The unique identifier for the remote device adapter. + name: name + types: + - +- description: Read-only system metadata associated with this object. + name: system_data + types: + - +- description: Properties of the remote device adapter. + name: properties + types: + - +methods: +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequestBody.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequestBody.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequestBody.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequestBody.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequestBody.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequestBody.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequestBody.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterTarget.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterTarget.yml new file mode 100644 index 00000000..33074e25 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterTarget.yml @@ -0,0 +1,127 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterTarget +name: RemoteDeviceAdapterTarget +fullName: azure.media.videoanalyzeredge.RemoteDeviceAdapterTarget +module: azure.media.videoanalyzeredge +summary: 'Properties of the remote device adapter target. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RemoteDeviceAdapterTarget(*, host: str, **kwargs)' + keywordOnlyParameters: + - name: host + description: Required. Hostname or IP address of the remote device. + types: + - +variables: +- description: Required. Hostname or IP address of the remote device. + name: host + types: + - +methods: +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterTarget.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterTarget.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterTarget.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterTarget.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterTarget.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterTarget.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterTarget.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RtspSource.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RtspSource.yml new file mode 100644 index 00000000..3e1a930e --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RtspSource.yml @@ -0,0 +1,188 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.RtspSource +name: RtspSource +fullName: azure.media.videoanalyzeredge.RtspSource +module: azure.media.videoanalyzeredge +summary: 'RTSP source allows for media from an RTSP camera or generic RTSP server + to be ingested into a live pipeline. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RtspSource(*, name: str, endpoint: EndpointBase, transport: str | RtspTransport + | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Node name. Must be unique within the topology. + types: + - + - name: transport + description: 'Network transport utilized by the RTSP and RTP exchange: TCP or + HTTP. When + + using TCP, the RTP packets are interleaved on the TCP RTSP connection. When + using HTTP, the + + RTSP messages are exchanged through long lived HTTP connections, and the RTP + packages are + + interleaved in the HTTP connections alongside the RTSP messages. Possible values + include: + + "http", "tcp".' + types: + - + - + - name: endpoint + description: 'Required. RTSP endpoint information for Video Analyzer to connect + to. This + + contains the required information for Video Analyzer to connect to RTSP cameras + and/or generic + + RTSP servers.' + types: + - +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. Node name. Must be unique within the topology. + name: name + types: + - +- description: 'Network transport utilized by the RTSP and RTP exchange: TCP or HTTP. + When + + using TCP, the RTP packets are interleaved on the TCP RTSP connection. When using + HTTP, the + + RTSP messages are exchanged through long lived HTTP connections, and the RTP packages + are + + interleaved in the HTTP connections alongside the RTSP messages. Possible values + include: + + "http", "tcp".' + name: transport + types: + - + - +- description: 'Required. RTSP endpoint information for Video Analyzer to connect + to. This + + contains the required information for Video Analyzer to connect to RTSP cameras + and/or generic + + RTSP servers.' + name: endpoint + types: + - +methods: +- uid: azure.media.videoanalyzeredge.RtspSource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.RtspSource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.RtspSource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.RtspSource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.RtspSource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.RtspSource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.RtspSource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RtspTransport.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RtspTransport.yml new file mode 100644 index 00000000..70f9b202 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RtspTransport.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonEnum +uid: azure.media.videoanalyzeredge.RtspTransport +name: RtspTransport +fullName: azure.media.videoanalyzeredge.RtspTransport +summary: 'Network transport utilized by the RTSP and RTP exchange: TCP or HTTP. When + using TCP, the RTP + + packets are interleaved on the TCP RTSP connection. When using HTTP, the RTSP messages + are + + exchanged through long lived HTTP connections, and the RTP packages are interleaved + in the HTTP + + connections alongside the RTSP messages.' +module: azure.media.videoanalyzeredge +fields: +- name: HTTP + uid: azure.media.videoanalyzeredge.RtspTransport.HTTP +- name: TCP + uid: azure.media.videoanalyzeredge.RtspTransport.TCP diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SamplingOptions.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SamplingOptions.yml new file mode 100644 index 00000000..9c9f30ab --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SamplingOptions.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.SamplingOptions +name: SamplingOptions +fullName: azure.media.videoanalyzeredge.SamplingOptions +module: azure.media.videoanalyzeredge +summary: Defines how often media is submitted to the extension plugin. +constructor: + syntax: 'SamplingOptions(*, skip_samples_without_annotation: str | None = None, + maximum_samples_per_second: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: skip_samples_without_annotation + description: 'When set to ''true'', prevents frames without upstream + + inference data to be sent to the extension plugin. This is useful to limit the + frames sent to + + the extension to pre-analyzed frames only. For example, when used downstream + from a motion + + detector, this can enable for only frames in which motion has been detected + to be further + + analyzed.' + types: + - + - name: maximum_samples_per_second + description: 'Maximum rate of samples submitted to the extension. This + + prevents an extension plugin to be overloaded with data.' + types: + - +variables: +- description: 'When set to ''true'', prevents frames without upstream + + inference data to be sent to the extension plugin. This is useful to limit the + frames sent to + + the extension to pre-analyzed frames only. For example, when used downstream from + a motion + + detector, this can enable for only frames in which motion has been detected to + be further + + analyzed.' + name: skip_samples_without_annotation + types: + - +- description: 'Maximum rate of samples submitted to the extension. This + + prevents an extension plugin to be overloaded with data.' + name: maximum_samples_per_second + types: + - +methods: +- uid: azure.media.videoanalyzeredge.SamplingOptions.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SamplingOptions.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SamplingOptions.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.SamplingOptions.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SamplingOptions.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.SamplingOptions.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SamplingOptions.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SignalGateProcessor.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SignalGateProcessor.yml new file mode 100644 index 00000000..021328fd --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SignalGateProcessor.yml @@ -0,0 +1,235 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.SignalGateProcessor +name: SignalGateProcessor +fullName: azure.media.videoanalyzeredge.SignalGateProcessor +module: azure.media.videoanalyzeredge +summary: 'A signal gate determines when to block (gate) incoming media, and when to + allow it through. It gathers input events over the activationEvaluationWindow, and + determines whether to open or close the gate. See [https://aka.ms/ava-signalgate](https://aka.ms/ava-signalgate) + for more information. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SignalGateProcessor(*, name: str, inputs: List[NodeInput], activation_evaluation_window: + str | None = None, activation_signal_offset: str | None = None, minimum_activation_time: + str | None = None, maximum_activation_time: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Node name. Must be unique within the topology. + types: + - + - name: inputs + description: 'Required. An array of upstream node references within the topology + to be used + + as inputs for this node.' + types: + - [] + - name: activation_evaluation_window + description: 'The period of time over which the gate gathers input + + events before evaluating them.' + types: + - + - name: activation_signal_offset + description: 'Signal offset once the gate is activated (can be negative). + + It determines the how much farther behind of after the signal will be let through + based on the + + activation time. A negative offset indicates that data prior the activation + time must be + + included on the signal that is let through, once the gate is activated. When + used upstream of a + + file or video sink, this allows for scenarios such as recording buffered media + prior an event, + + such as: record video 5 seconds prior motions is detected.' + types: + - + - name: minimum_activation_time + description: 'The minimum period for which the gate remains open in the + + absence of subsequent triggers (events). When used upstream of a file or video + sink, it + + determines the minimum length of the recorded video clip.' + types: + - + - name: maximum_activation_time + description: 'The maximum period for which the gate remains open in the + + presence of subsequent triggers (events). When used upstream of a file or video + sink, it + + determines the maximum length of the recorded video clip.' + types: + - +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. Node name. Must be unique within the topology. + name: name + types: + - +- description: 'Required. An array of upstream node references within the topology + to be used as + + inputs for this node.' + name: inputs + types: + - [] +- description: 'The period of time over which the gate gathers input events + + before evaluating them.' + name: activation_evaluation_window + types: + - +- description: 'Signal offset once the gate is activated (can be negative). It + + determines the how much farther behind of after the signal will be let through + based on the + + activation time. A negative offset indicates that data prior the activation time + must be + + included on the signal that is let through, once the gate is activated. When used + upstream of a + + file or video sink, this allows for scenarios such as recording buffered media + prior an event, + + such as: record video 5 seconds prior motions is detected.' + name: activation_signal_offset + types: + - +- description: 'The minimum period for which the gate remains open in the + + absence of subsequent triggers (events). When used upstream of a file or video + sink, it + + determines the minimum length of the recorded video clip.' + name: minimum_activation_time + types: + - +- description: 'The maximum period for which the gate remains open in the + + presence of subsequent triggers (events). When used upstream of a file or video + sink, it + + determines the maximum length of the recorded video clip.' + name: maximum_activation_time + types: + - +methods: +- uid: azure.media.videoanalyzeredge.SignalGateProcessor.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SignalGateProcessor.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SignalGateProcessor.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.SignalGateProcessor.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SignalGateProcessor.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.SignalGateProcessor.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SignalGateProcessor.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SinkNodeBase.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SinkNodeBase.yml new file mode 100644 index 00000000..c46bc769 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SinkNodeBase.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.SinkNodeBase +name: SinkNodeBase +fullName: azure.media.videoanalyzeredge.SinkNodeBase +module: azure.media.videoanalyzeredge +summary: 'Base class for topology sink nodes. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: FileSink, IotHubMessageSink, VideoSink. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SinkNodeBase(*, name: str, inputs: List[NodeInput], **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Node name. Must be unique within the topology. + types: + - + - name: inputs + description: 'Required. An array of upstream node references within the topology + to be used + + as inputs for this node.' + types: + - [] +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. Node name. Must be unique within the topology. + name: name + types: + - +- description: 'Required. An array of upstream node references within the topology + to be used as + + inputs for this node.' + name: inputs + types: + - [] +methods: +- uid: azure.media.videoanalyzeredge.SinkNodeBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SinkNodeBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SinkNodeBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.SinkNodeBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SinkNodeBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.SinkNodeBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SinkNodeBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SourceNodeBase.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SourceNodeBase.yml new file mode 100644 index 00000000..25df6965 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SourceNodeBase.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.SourceNodeBase +name: SourceNodeBase +fullName: azure.media.videoanalyzeredge.SourceNodeBase +module: azure.media.videoanalyzeredge +summary: 'Base class for topology source nodes. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: IotHubMessageSource, RtspSource. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SourceNodeBase(*, name: str, **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Node name. Must be unique within the topology. + types: + - +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. Node name. Must be unique within the topology. + name: name + types: + - +methods: +- uid: azure.media.videoanalyzeredge.SourceNodeBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SourceNodeBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SourceNodeBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.SourceNodeBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SourceNodeBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.SourceNodeBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SourceNodeBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisCustomOperation.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisCustomOperation.yml new file mode 100644 index 00000000..cba2db3b --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisCustomOperation.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.SpatialAnalysisCustomOperation +name: SpatialAnalysisCustomOperation +fullName: azure.media.videoanalyzeredge.SpatialAnalysisCustomOperation +module: azure.media.videoanalyzeredge +summary: 'Defines a Spatial Analysis custom operation. This requires the Azure Cognitive + Services Spatial analysis module to be deployed alongside the Video Analyzer module, + please see [https://aka.ms/ava-spatial-analysis](https://aka.ms/ava-spatial-analysis) + for more information. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SpatialAnalysisCustomOperation(*, extension_configuration: str, **kwargs)' + keywordOnlyParameters: + - name: extension_configuration + description: 'Required. Custom configuration to pass to the Azure Cognitive + + Services Spatial Analysis module.' + types: + - +variables: +- description: Required. The Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: 'Required. Custom configuration to pass to the Azure Cognitive + + Services Spatial Analysis module.' + name: extension_configuration + types: + - +methods: +- uid: azure.media.videoanalyzeredge.SpatialAnalysisCustomOperation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisCustomOperation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisCustomOperation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisCustomOperation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisCustomOperation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisCustomOperation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisCustomOperation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisOperationBase.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisOperationBase.yml new file mode 100644 index 00000000..1323b053 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisOperationBase.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.SpatialAnalysisOperationBase +name: SpatialAnalysisOperationBase +fullName: azure.media.videoanalyzeredge.SpatialAnalysisOperationBase +module: azure.media.videoanalyzeredge +summary: 'Base class for Azure Cognitive Services Spatial Analysis operations. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: SpatialAnalysisCustomOperation, SpatialAnalysisTypedOperationBase. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: SpatialAnalysisOperationBase(**kwargs) +variables: +- description: Required. The Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +methods: +- uid: azure.media.videoanalyzeredge.SpatialAnalysisOperationBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisOperationBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisOperationBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisOperationBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisOperationBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisOperationBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisOperationBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisOperationEventBase.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisOperationEventBase.yml new file mode 100644 index 00000000..61a91bf4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisOperationEventBase.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.SpatialAnalysisOperationEventBase +name: SpatialAnalysisOperationEventBase +fullName: azure.media.videoanalyzeredge.SpatialAnalysisOperationEventBase +module: azure.media.videoanalyzeredge +summary: Defines the Azure Cognitive Services Spatial Analysis operation eventing + configuration. +constructor: + syntax: 'SpatialAnalysisOperationEventBase(*, threshold: str | None = None, focus: + str | SpatialAnalysisOperationFocus | None = None, **kwargs)' + keywordOnlyParameters: + - name: threshold + description: The event threshold. + types: + - + - name: focus + description: 'The operation focus type. Possible values include: "center", "bottomCenter", + + "footprint".' + types: + - + - +variables: +- description: The event threshold. + name: threshold + types: + - +- description: 'The operation focus type. Possible values include: "center", "bottomCenter", + + "footprint".' + name: focus + types: + - + - +methods: +- uid: azure.media.videoanalyzeredge.SpatialAnalysisOperationEventBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisOperationEventBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisOperationEventBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisOperationEventBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisOperationEventBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisOperationEventBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisOperationEventBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisOperationFocus.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisOperationFocus.yml new file mode 100644 index 00000000..aa0d9c8a --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisOperationFocus.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.media.videoanalyzeredge.SpatialAnalysisOperationFocus +name: SpatialAnalysisOperationFocus +fullName: azure.media.videoanalyzeredge.SpatialAnalysisOperationFocus +summary: The operation focus type. +module: azure.media.videoanalyzeredge +fields: +- name: BOTTOM_CENTER + uid: azure.media.videoanalyzeredge.SpatialAnalysisOperationFocus.BOTTOM_CENTER +- name: CENTER + uid: azure.media.videoanalyzeredge.SpatialAnalysisOperationFocus.CENTER +- name: FOOTPRINT + uid: azure.media.videoanalyzeredge.SpatialAnalysisOperationFocus.FOOTPRINT diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEvent.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEvent.yml new file mode 100644 index 00000000..62a697bd --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEvent.yml @@ -0,0 +1,158 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEvent +name: SpatialAnalysisPersonCountEvent +fullName: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEvent +module: azure.media.videoanalyzeredge +summary: Defines a Spatial Analysis person count operation eventing configuration. +constructor: + syntax: 'SpatialAnalysisPersonCountEvent(*, threshold: str | None = None, focus: + str | SpatialAnalysisOperationFocus | None = None, trigger: str | SpatialAnalysisPersonCountEventTrigger + | None = None, output_frequency: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: threshold + description: The event threshold. + types: + - + - name: focus + description: 'The operation focus type. Possible values include: "center", "bottomCenter", + + "footprint".' + types: + - + - + - name: trigger + description: 'The event trigger type. Possible values include: "event", "interval".' + types: + - + - + - name: output_frequency + description: The event or interval output frequency. + types: + - +variables: +- description: The event threshold. + name: threshold + types: + - +- description: 'The operation focus type. Possible values include: "center", "bottomCenter", + + "footprint".' + name: focus + types: + - + - +- description: 'The event trigger type. Possible values include: "event", "interval".' + name: trigger + types: + - + - +- description: The event or interval output frequency. + name: output_frequency + types: + - +methods: +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEvent.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEvent.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEvent.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEvent.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEvent.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEvent.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEvent.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEventTrigger.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEventTrigger.yml new file mode 100644 index 00000000..11fa34e2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEventTrigger.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEventTrigger +name: SpatialAnalysisPersonCountEventTrigger +fullName: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEventTrigger +summary: The event trigger type. +module: azure.media.videoanalyzeredge +fields: +- name: EVENT + uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEventTrigger.EVENT +- name: INTERVAL + uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEventTrigger.INTERVAL diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountOperation.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountOperation.yml new file mode 100644 index 00000000..5e8b3be0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountOperation.yml @@ -0,0 +1,199 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountOperation +name: SpatialAnalysisPersonCountOperation +fullName: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountOperation +module: azure.media.videoanalyzeredge +summary: 'Defines a Spatial Analysis person count operation. This requires the Azure + Cognitive Services Spatial analysis module to be deployed alongside the Video Analyzer + module, please see [https://aka.ms/ava-spatial-analysis](https://aka.ms/ava-spatial-analysis) + for more information. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SpatialAnalysisPersonCountOperation(*, zones: List[SpatialAnalysisPersonCountZoneEvents], + debug: str | None = None, calibration_configuration: str | None = None, camera_configuration: + str | None = None, camera_calibrator_node_configuration: str | None = None, detector_node_configuration: + str | None = None, tracker_node_configuration: str | None = None, enable_face_mask_classifier: + str | None = None, **kwargs)' + keywordOnlyParameters: + - name: debug + description: If set to 'true', enables debugging mode for this operation. + types: + - + - name: calibration_configuration + description: Advanced calibration configuration. + types: + - + - name: camera_configuration + description: Advanced camera configuration. + types: + - + - name: camera_calibrator_node_configuration + description: Advanced camera calibrator configuration. + types: + - + - name: detector_node_configuration + description: Advanced detector node configuration. + types: + - + - name: tracker_node_configuration + description: Advanced tracker node configuration. + types: + - + - name: enable_face_mask_classifier + description: 'If set to ''true'', enables face mask detection for this + + operation.' + types: + - + - name: zones + description: Required. The list of zones and optional events. + types: + - [] +variables: +- description: Required. The Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: If set to 'true', enables debugging mode for this operation. + name: debug + types: + - +- description: Advanced calibration configuration. + name: calibration_configuration + types: + - +- description: Advanced camera configuration. + name: camera_configuration + types: + - +- description: Advanced camera calibrator configuration. + name: camera_calibrator_node_configuration + types: + - +- description: Advanced detector node configuration. + name: detector_node_configuration + types: + - +- description: Advanced tracker node configuration. + name: tracker_node_configuration + types: + - +- description: 'If set to ''true'', enables face mask detection for this + + operation.' + name: enable_face_mask_classifier + types: + - +- description: Required. The list of zones and optional events. + name: zones + types: + - [] +methods: +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountOperation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountOperation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountOperation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountOperation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountOperation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountOperation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountOperation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountZoneEvents.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountZoneEvents.yml new file mode 100644 index 00000000..af1ddefc --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountZoneEvents.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountZoneEvents +name: SpatialAnalysisPersonCountZoneEvents +fullName: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountZoneEvents +module: azure.media.videoanalyzeredge +summary: 'SpatialAnalysisPersonCountZoneEvents. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SpatialAnalysisPersonCountZoneEvents(*, zone: NamedPolygonBase, events: + List[SpatialAnalysisPersonCountEvent] | None = None, **kwargs)' + keywordOnlyParameters: + - name: zone + description: Required. The named zone. + types: + - + - name: events + description: The event configuration. + types: + - [] +variables: +- description: Required. The named zone. + name: zone + types: + - +- description: The event configuration. + name: events + types: + - [] +methods: +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountZoneEvents.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountZoneEvents.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountZoneEvents.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountZoneEvents.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountZoneEvents.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountZoneEvents.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountZoneEvents.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEvent.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEvent.yml new file mode 100644 index 00000000..3abb1fc2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEvent.yml @@ -0,0 +1,175 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEvent +name: SpatialAnalysisPersonDistanceEvent +fullName: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEvent +module: azure.media.videoanalyzeredge +summary: Defines a Spatial Analysis person distance operation eventing configuration. +constructor: + syntax: 'SpatialAnalysisPersonDistanceEvent(*, threshold: str | None = None, focus: + str | SpatialAnalysisOperationFocus | None = None, trigger: str | SpatialAnalysisPersonDistanceEventTrigger + | None = None, output_frequency: str | None = None, minimum_distance_threshold: + str | None = None, maximum_distance_threshold: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: threshold + description: The event threshold. + types: + - + - name: focus + description: 'The operation focus type. Possible values include: "center", "bottomCenter", + + "footprint".' + types: + - + - + - name: trigger + description: 'The event trigger type. Possible values include: "event", "interval".' + types: + - + - + - name: output_frequency + description: The event or interval output frequency. + types: + - + - name: minimum_distance_threshold + description: The minimum distance threshold. + types: + - + - name: maximum_distance_threshold + description: The maximum distance threshold. + types: + - +variables: +- description: The event threshold. + name: threshold + types: + - +- description: 'The operation focus type. Possible values include: "center", "bottomCenter", + + "footprint".' + name: focus + types: + - + - +- description: 'The event trigger type. Possible values include: "event", "interval".' + name: trigger + types: + - + - +- description: The event or interval output frequency. + name: output_frequency + types: + - +- description: The minimum distance threshold. + name: minimum_distance_threshold + types: + - +- description: The maximum distance threshold. + name: maximum_distance_threshold + types: + - +methods: +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEvent.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEvent.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEvent.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEvent.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEvent.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEvent.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEvent.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEventTrigger.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEventTrigger.yml new file mode 100644 index 00000000..7e3b9d38 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEventTrigger.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEventTrigger +name: SpatialAnalysisPersonDistanceEventTrigger +fullName: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEventTrigger +summary: The event trigger type. +module: azure.media.videoanalyzeredge +fields: +- name: EVENT + uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEventTrigger.EVENT +- name: INTERVAL + uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEventTrigger.INTERVAL diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceOperation.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceOperation.yml new file mode 100644 index 00000000..4905d825 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceOperation.yml @@ -0,0 +1,199 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceOperation +name: SpatialAnalysisPersonDistanceOperation +fullName: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceOperation +module: azure.media.videoanalyzeredge +summary: 'Defines a Spatial Analysis person distance operation. This requires the + Azure Cognitive Services Spatial analysis module to be deployed alongside the Video + Analyzer module, please see [https://aka.ms/ava-spatial-analysis](https://aka.ms/ava-spatial-analysis) + for more information. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SpatialAnalysisPersonDistanceOperation(*, zones: List[SpatialAnalysisPersonDistanceZoneEvents], + debug: str | None = None, calibration_configuration: str | None = None, camera_configuration: + str | None = None, camera_calibrator_node_configuration: str | None = None, detector_node_configuration: + str | None = None, tracker_node_configuration: str | None = None, enable_face_mask_classifier: + str | None = None, **kwargs)' + keywordOnlyParameters: + - name: debug + description: If set to 'true', enables debugging mode for this operation. + types: + - + - name: calibration_configuration + description: Advanced calibration configuration. + types: + - + - name: camera_configuration + description: Advanced camera configuration. + types: + - + - name: camera_calibrator_node_configuration + description: Advanced camera calibrator configuration. + types: + - + - name: detector_node_configuration + description: Advanced detector node configuration. + types: + - + - name: tracker_node_configuration + description: Advanced tracker node configuration. + types: + - + - name: enable_face_mask_classifier + description: 'If set to ''true'', enables face mask detection for this + + operation.' + types: + - + - name: zones + description: Required. The list of zones with optional events. + types: + - [] +variables: +- description: Required. The Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: If set to 'true', enables debugging mode for this operation. + name: debug + types: + - +- description: Advanced calibration configuration. + name: calibration_configuration + types: + - +- description: Advanced camera configuration. + name: camera_configuration + types: + - +- description: Advanced camera calibrator configuration. + name: camera_calibrator_node_configuration + types: + - +- description: Advanced detector node configuration. + name: detector_node_configuration + types: + - +- description: Advanced tracker node configuration. + name: tracker_node_configuration + types: + - +- description: 'If set to ''true'', enables face mask detection for this + + operation.' + name: enable_face_mask_classifier + types: + - +- description: Required. The list of zones with optional events. + name: zones + types: + - [] +methods: +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceOperation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceOperation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceOperation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceOperation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceOperation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceOperation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceOperation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceZoneEvents.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceZoneEvents.yml new file mode 100644 index 00000000..465bf446 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceZoneEvents.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceZoneEvents +name: SpatialAnalysisPersonDistanceZoneEvents +fullName: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceZoneEvents +module: azure.media.videoanalyzeredge +summary: 'SpatialAnalysisPersonDistanceZoneEvents. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SpatialAnalysisPersonDistanceZoneEvents(*, zone: NamedPolygonBase, events: + List[SpatialAnalysisPersonDistanceEvent] | None = None, **kwargs)' + keywordOnlyParameters: + - name: zone + description: Required. The named zone. + types: + - + - name: events + description: The event configuration. + types: + - [] +variables: +- description: Required. The named zone. + name: zone + types: + - +- description: The event configuration. + name: events + types: + - [] +methods: +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceZoneEvents.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceZoneEvents.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceZoneEvents.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceZoneEvents.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceZoneEvents.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceZoneEvents.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceZoneEvents.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingEvent.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingEvent.yml new file mode 100644 index 00000000..3114d6fe --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingEvent.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingEvent +name: SpatialAnalysisPersonLineCrossingEvent +fullName: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingEvent +module: azure.media.videoanalyzeredge +summary: Defines a Spatial Analysis person line crossing operation eventing configuration. +constructor: + syntax: 'SpatialAnalysisPersonLineCrossingEvent(*, threshold: str | None = None, + focus: str | SpatialAnalysisOperationFocus | None = None, **kwargs)' + keywordOnlyParameters: + - name: threshold + description: The event threshold. + types: + - + - name: focus + description: 'The operation focus type. Possible values include: "center", "bottomCenter", + + "footprint".' + types: + - + - +variables: +- description: The event threshold. + name: threshold + types: + - +- description: 'The operation focus type. Possible values include: "center", "bottomCenter", + + "footprint".' + name: focus + types: + - + - +methods: +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingEvent.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingEvent.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingEvent.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingEvent.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingEvent.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingEvent.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingEvent.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingLineEvents.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingLineEvents.yml new file mode 100644 index 00000000..e36a7cf7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingLineEvents.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingLineEvents +name: SpatialAnalysisPersonLineCrossingLineEvents +fullName: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingLineEvents +module: azure.media.videoanalyzeredge +summary: 'SpatialAnalysisPersonLineCrossingLineEvents. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SpatialAnalysisPersonLineCrossingLineEvents(*, line: NamedLineBase, events: + List[SpatialAnalysisPersonLineCrossingEvent] | None = None, **kwargs)' + keywordOnlyParameters: + - name: line + description: Required. The named line. + types: + - + - name: events + description: The event configuration. + types: + - [] +variables: +- description: Required. The named line. + name: line + types: + - +- description: The event configuration. + name: events + types: + - [] +methods: +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingLineEvents.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingLineEvents.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingLineEvents.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingLineEvents.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingLineEvents.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingLineEvents.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingLineEvents.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingOperation.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingOperation.yml new file mode 100644 index 00000000..b04d42e0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingOperation.yml @@ -0,0 +1,199 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingOperation +name: SpatialAnalysisPersonLineCrossingOperation +fullName: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingOperation +module: azure.media.videoanalyzeredge +summary: 'Defines a Spatial Analysis person line crossing operation. This requires + the Azure Cognitive Services Spatial analysis module to be deployed alongside the + Video Analyzer module, please see [https://aka.ms/ava-spatial-analysis](https://aka.ms/ava-spatial-analysis) + for more information. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SpatialAnalysisPersonLineCrossingOperation(*, lines: List[SpatialAnalysisPersonLineCrossingLineEvents], + debug: str | None = None, calibration_configuration: str | None = None, camera_configuration: + str | None = None, camera_calibrator_node_configuration: str | None = None, detector_node_configuration: + str | None = None, tracker_node_configuration: str | None = None, enable_face_mask_classifier: + str | None = None, **kwargs)' + keywordOnlyParameters: + - name: debug + description: If set to 'true', enables debugging mode for this operation. + types: + - + - name: calibration_configuration + description: Advanced calibration configuration. + types: + - + - name: camera_configuration + description: Advanced camera configuration. + types: + - + - name: camera_calibrator_node_configuration + description: Advanced camera calibrator configuration. + types: + - + - name: detector_node_configuration + description: Advanced detector node configuration. + types: + - + - name: tracker_node_configuration + description: Advanced tracker node configuration. + types: + - + - name: enable_face_mask_classifier + description: 'If set to ''true'', enables face mask detection for this + + operation.' + types: + - + - name: lines + description: Required. The list of lines with optional events. + types: + - [] +variables: +- description: Required. The Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: If set to 'true', enables debugging mode for this operation. + name: debug + types: + - +- description: Advanced calibration configuration. + name: calibration_configuration + types: + - +- description: Advanced camera configuration. + name: camera_configuration + types: + - +- description: Advanced camera calibrator configuration. + name: camera_calibrator_node_configuration + types: + - +- description: Advanced detector node configuration. + name: detector_node_configuration + types: + - +- description: Advanced tracker node configuration. + name: tracker_node_configuration + types: + - +- description: 'If set to ''true'', enables face mask detection for this + + operation.' + name: enable_face_mask_classifier + types: + - +- description: Required. The list of lines with optional events. + name: lines + types: + - [] +methods: +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingOperation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingOperation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingOperation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingOperation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingOperation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingOperation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingOperation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEvent.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEvent.yml new file mode 100644 index 00000000..e4aadc25 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEvent.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEvent +name: SpatialAnalysisPersonZoneCrossingEvent +fullName: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEvent +module: azure.media.videoanalyzeredge +summary: Defines a Spatial Analysis person crossing zone operation eventing configuration. +constructor: + syntax: 'SpatialAnalysisPersonZoneCrossingEvent(*, threshold: str | None = None, + focus: str | SpatialAnalysisOperationFocus | None = None, event_type: str | SpatialAnalysisPersonZoneCrossingEventType + | None = None, **kwargs)' + keywordOnlyParameters: + - name: threshold + description: The event threshold. + types: + - + - name: focus + description: 'The operation focus type. Possible values include: "center", "bottomCenter", + + "footprint".' + types: + - + - + - name: event_type + description: 'The event type. Possible values include: "zoneCrossing", "zoneDwellTime".' + types: + - + - +variables: +- description: The event threshold. + name: threshold + types: + - +- description: 'The operation focus type. Possible values include: "center", "bottomCenter", + + "footprint".' + name: focus + types: + - + - +- description: 'The event type. Possible values include: "zoneCrossing", "zoneDwellTime".' + name: event_type + types: + - + - +methods: +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEvent.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEvent.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEvent.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEvent.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEvent.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEvent.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEvent.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEventType.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEventType.yml new file mode 100644 index 00000000..5c0799f7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEventType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEventType +name: SpatialAnalysisPersonZoneCrossingEventType +fullName: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEventType +summary: The event type. +module: azure.media.videoanalyzeredge +fields: +- name: ZONE_CROSSING + uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEventType.ZONE_CROSSING +- name: ZONE_DWELL_TIME + uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEventType.ZONE_DWELL_TIME diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingOperation.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingOperation.yml new file mode 100644 index 00000000..49e1cd77 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingOperation.yml @@ -0,0 +1,199 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingOperation +name: SpatialAnalysisPersonZoneCrossingOperation +fullName: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingOperation +module: azure.media.videoanalyzeredge +summary: 'Defines a Spatial Analysis person zone crossing operation. This requires + the Azure Cognitive Services Spatial analysis module to be deployed alongside the + Video Analyzer module, please see [https://aka.ms/ava-spatial-analysis](https://aka.ms/ava-spatial-analysis) + for more information. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SpatialAnalysisPersonZoneCrossingOperation(*, zones: List[SpatialAnalysisPersonZoneCrossingZoneEvents], + debug: str | None = None, calibration_configuration: str | None = None, camera_configuration: + str | None = None, camera_calibrator_node_configuration: str | None = None, detector_node_configuration: + str | None = None, tracker_node_configuration: str | None = None, enable_face_mask_classifier: + str | None = None, **kwargs)' + keywordOnlyParameters: + - name: debug + description: If set to 'true', enables debugging mode for this operation. + types: + - + - name: calibration_configuration + description: Advanced calibration configuration. + types: + - + - name: camera_configuration + description: Advanced camera configuration. + types: + - + - name: camera_calibrator_node_configuration + description: Advanced camera calibrator configuration. + types: + - + - name: detector_node_configuration + description: Advanced detector node configuration. + types: + - + - name: tracker_node_configuration + description: Advanced tracker node configuration. + types: + - + - name: enable_face_mask_classifier + description: 'If set to ''true'', enables face mask detection for this + + operation.' + types: + - + - name: zones + description: Required. The list of zones with optional events. + types: + - [] +variables: +- description: Required. The Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: If set to 'true', enables debugging mode for this operation. + name: debug + types: + - +- description: Advanced calibration configuration. + name: calibration_configuration + types: + - +- description: Advanced camera configuration. + name: camera_configuration + types: + - +- description: Advanced camera calibrator configuration. + name: camera_calibrator_node_configuration + types: + - +- description: Advanced detector node configuration. + name: detector_node_configuration + types: + - +- description: Advanced tracker node configuration. + name: tracker_node_configuration + types: + - +- description: 'If set to ''true'', enables face mask detection for this + + operation.' + name: enable_face_mask_classifier + types: + - +- description: Required. The list of zones with optional events. + name: zones + types: + - [] +methods: +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingOperation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingOperation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingOperation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingOperation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingOperation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingOperation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingOperation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingZoneEvents.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingZoneEvents.yml new file mode 100644 index 00000000..84185c85 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingZoneEvents.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingZoneEvents +name: SpatialAnalysisPersonZoneCrossingZoneEvents +fullName: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingZoneEvents +module: azure.media.videoanalyzeredge +summary: 'SpatialAnalysisPersonZoneCrossingZoneEvents. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SpatialAnalysisPersonZoneCrossingZoneEvents(*, zone: NamedPolygonBase, + events: List[SpatialAnalysisPersonZoneCrossingEvent] | None = None, **kwargs)' + keywordOnlyParameters: + - name: zone + description: Required. The named zone. + types: + - + - name: events + description: The event configuration. + types: + - [] +variables: +- description: Required. The named zone. + name: zone + types: + - +- description: The event configuration. + name: events + types: + - [] +methods: +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingZoneEvents.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingZoneEvents.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingZoneEvents.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingZoneEvents.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingZoneEvents.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingZoneEvents.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingZoneEvents.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisTypedOperationBase.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisTypedOperationBase.yml new file mode 100644 index 00000000..a810b48c --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisTypedOperationBase.yml @@ -0,0 +1,193 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.SpatialAnalysisTypedOperationBase +name: SpatialAnalysisTypedOperationBase +fullName: azure.media.videoanalyzeredge.SpatialAnalysisTypedOperationBase +module: azure.media.videoanalyzeredge +summary: 'Base class for Azure Cognitive Services Spatial Analysis typed operations. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: SpatialAnalysisPersonCountOperation, SpatialAnalysisPersonDistanceOperation, + SpatialAnalysisPersonLineCrossingOperation, SpatialAnalysisPersonZoneCrossingOperation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SpatialAnalysisTypedOperationBase(*, debug: str | None = None, calibration_configuration: + str | None = None, camera_configuration: str | None = None, camera_calibrator_node_configuration: + str | None = None, detector_node_configuration: str | None = None, tracker_node_configuration: + str | None = None, enable_face_mask_classifier: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: debug + description: If set to 'true', enables debugging mode for this operation. + types: + - + - name: calibration_configuration + description: Advanced calibration configuration. + types: + - + - name: camera_configuration + description: Advanced camera configuration. + types: + - + - name: camera_calibrator_node_configuration + description: Advanced camera calibrator configuration. + types: + - + - name: detector_node_configuration + description: Advanced detector node configuration. + types: + - + - name: tracker_node_configuration + description: Advanced tracker node configuration. + types: + - + - name: enable_face_mask_classifier + description: 'If set to ''true'', enables face mask detection for this + + operation.' + types: + - +variables: +- description: Required. The Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: If set to 'true', enables debugging mode for this operation. + name: debug + types: + - +- description: Advanced calibration configuration. + name: calibration_configuration + types: + - +- description: Advanced camera configuration. + name: camera_configuration + types: + - +- description: Advanced camera calibrator configuration. + name: camera_calibrator_node_configuration + types: + - +- description: Advanced detector node configuration. + name: detector_node_configuration + types: + - +- description: Advanced tracker node configuration. + name: tracker_node_configuration + types: + - +- description: 'If set to ''true'', enables face mask detection for this + + operation.' + name: enable_face_mask_classifier + types: + - +methods: +- uid: azure.media.videoanalyzeredge.SpatialAnalysisTypedOperationBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisTypedOperationBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisTypedOperationBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisTypedOperationBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SpatialAnalysisTypedOperationBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.SpatialAnalysisTypedOperationBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SpatialAnalysisTypedOperationBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SymmetricKeyCredentials.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SymmetricKeyCredentials.yml new file mode 100644 index 00000000..6a49b4c2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SymmetricKeyCredentials.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.SymmetricKeyCredentials +name: SymmetricKeyCredentials +fullName: azure.media.videoanalyzeredge.SymmetricKeyCredentials +module: azure.media.videoanalyzeredge +summary: 'Symmetric key credential. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SymmetricKeyCredentials(*, key: str, **kwargs)' + keywordOnlyParameters: + - name: key + description: Required. Symmetric key credential. + types: + - +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. Symmetric key credential. + name: key + types: + - +methods: +- uid: azure.media.videoanalyzeredge.SymmetricKeyCredentials.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SymmetricKeyCredentials.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SymmetricKeyCredentials.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.SymmetricKeyCredentials.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SymmetricKeyCredentials.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.SymmetricKeyCredentials.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SymmetricKeyCredentials.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SystemData.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SystemData.yml new file mode 100644 index 00000000..05befbb5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SystemData.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.SystemData +name: SystemData +fullName: azure.media.videoanalyzeredge.SystemData +module: azure.media.videoanalyzeredge +summary: Read-only system metadata associated with a resource. +constructor: + syntax: 'SystemData(*, created_at: datetime | None = None, last_modified_at: datetime + | None = None, **kwargs)' + keywordOnlyParameters: + - name: created_at + description: 'Date and time when this resource was first created. Value is represented + + in UTC according to the ISO8601 date format.' + types: + - + - name: last_modified_at + description: 'Date and time when this resource was last modified. Value is + + represented in UTC according to the ISO8601 date format.' + types: + - +variables: +- description: 'Date and time when this resource was first created. Value is represented + in + + UTC according to the ISO8601 date format.' + name: created_at + types: + - +- description: 'Date and time when this resource was last modified. Value is + + represented in UTC according to the ISO8601 date format.' + name: last_modified_at + types: + - +methods: +- uid: azure.media.videoanalyzeredge.SystemData.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SystemData.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SystemData.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.SystemData.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.SystemData.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.SystemData.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.SystemData.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.TlsEndpoint.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.TlsEndpoint.yml new file mode 100644 index 00000000..4333689d --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.TlsEndpoint.yml @@ -0,0 +1,174 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.TlsEndpoint +name: TlsEndpoint +fullName: azure.media.videoanalyzeredge.TlsEndpoint +module: azure.media.videoanalyzeredge +summary: 'TLS endpoint describes an endpoint that the pipeline can connect to over + TLS transport (data is encrypted in transit). + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TlsEndpoint(*, url: str, credentials: CredentialsBase | None = None, trusted_certificates: + CertificateSource | None = None, validation_options: TlsValidationOptions | None + = None, **kwargs)' + keywordOnlyParameters: + - name: credentials + description: Credentials to be presented to the endpoint. + types: + - + - name: url + description: Required. The endpoint URL for Video Analyzer to connect to. + types: + - + - name: trusted_certificates + description: 'List of trusted certificate authorities when authenticating a + + TLS connection. A null list designates that Azure Video Analyzer''s list of + trusted authorities + + should be used.' + types: + - + - name: validation_options + description: 'Validation options to use when authenticating a TLS connection. + By + + default, strict validation is used.' + types: + - +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Credentials to be presented to the endpoint. + name: credentials + types: + - +- description: Required. The endpoint URL for Video Analyzer to connect to. + name: url + types: + - +- description: 'List of trusted certificate authorities when authenticating a TLS + + connection. A null list designates that Azure Video Analyzer''s list of trusted + authorities + + should be used.' + name: trusted_certificates + types: + - +- description: 'Validation options to use when authenticating a TLS connection. By + + default, strict validation is used.' + name: validation_options + types: + - +methods: +- uid: azure.media.videoanalyzeredge.TlsEndpoint.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.TlsEndpoint.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.TlsEndpoint.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.TlsEndpoint.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.TlsEndpoint.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.TlsEndpoint.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.TlsEndpoint.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.TlsValidationOptions.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.TlsValidationOptions.yml new file mode 100644 index 00000000..d9b2ca5a --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.TlsValidationOptions.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.TlsValidationOptions +name: TlsValidationOptions +fullName: azure.media.videoanalyzeredge.TlsValidationOptions +module: azure.media.videoanalyzeredge +summary: Options for controlling the validation of TLS endpoints. +constructor: + syntax: 'TlsValidationOptions(*, ignore_hostname: str | None = None, ignore_signature: + str | None = None, **kwargs)' + keywordOnlyParameters: + - name: ignore_hostname + description: 'When set to ''true'' causes the certificate subject name validation + to + + be skipped. Default is ''false''.' + types: + - + - name: ignore_signature + description: 'When set to ''true'' causes the certificate chain trust validation + to + + be skipped. Default is ''false''.' + types: + - +variables: +- description: 'When set to ''true'' causes the certificate subject name validation + to be + + skipped. Default is ''false''.' + name: ignore_hostname + types: + - +- description: 'When set to ''true'' causes the certificate chain trust validation + to be + + skipped. Default is ''false''.' + name: ignore_signature + types: + - +methods: +- uid: azure.media.videoanalyzeredge.TlsValidationOptions.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.TlsValidationOptions.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.TlsValidationOptions.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.TlsValidationOptions.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.TlsValidationOptions.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.TlsValidationOptions.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.TlsValidationOptions.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.UnsecuredEndpoint.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.UnsecuredEndpoint.yml new file mode 100644 index 00000000..6174e5f2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.UnsecuredEndpoint.yml @@ -0,0 +1,142 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.UnsecuredEndpoint +name: UnsecuredEndpoint +fullName: azure.media.videoanalyzeredge.UnsecuredEndpoint +module: azure.media.videoanalyzeredge +summary: 'Unsecured endpoint describes an endpoint that the pipeline can connect to + over clear transport (no encryption in transit). + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'UnsecuredEndpoint(*, url: str, credentials: CredentialsBase | None = None, + **kwargs)' + keywordOnlyParameters: + - name: credentials + description: Credentials to be presented to the endpoint. + types: + - + - name: url + description: Required. The endpoint URL for Video Analyzer to connect to. + types: + - +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Credentials to be presented to the endpoint. + name: credentials + types: + - +- description: Required. The endpoint URL for Video Analyzer to connect to. + name: url + types: + - +methods: +- uid: azure.media.videoanalyzeredge.UnsecuredEndpoint.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.UnsecuredEndpoint.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.UnsecuredEndpoint.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.UnsecuredEndpoint.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.UnsecuredEndpoint.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.UnsecuredEndpoint.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.UnsecuredEndpoint.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.UsernamePasswordCredentials.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.UsernamePasswordCredentials.yml new file mode 100644 index 00000000..6429bd84 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.UsernamePasswordCredentials.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.UsernamePasswordCredentials +name: UsernamePasswordCredentials +fullName: azure.media.videoanalyzeredge.UsernamePasswordCredentials +module: azure.media.videoanalyzeredge +summary: 'Username and password credentials. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'UsernamePasswordCredentials(*, username: str, password: str, **kwargs)' + keywordOnlyParameters: + - name: username + description: Required. Username to be presented as part of the credentials. + types: + - + - name: password + description: 'Required. Password to be presented as part of the credentials. It + is + + recommended that this value is parameterized as a secret string in order to + prevent this value + + to be returned as part of the resource on API requests.' + types: + - +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. Username to be presented as part of the credentials. + name: username + types: + - +- description: 'Required. Password to be presented as part of the credentials. It + is + + recommended that this value is parameterized as a secret string in order to prevent + this value + + to be returned as part of the resource on API requests.' + name: password + types: + - +methods: +- uid: azure.media.videoanalyzeredge.UsernamePasswordCredentials.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.UsernamePasswordCredentials.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.UsernamePasswordCredentials.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.UsernamePasswordCredentials.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.UsernamePasswordCredentials.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.UsernamePasswordCredentials.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.UsernamePasswordCredentials.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoCreationProperties.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoCreationProperties.yml new file mode 100644 index 00000000..0439a598 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoCreationProperties.yml @@ -0,0 +1,206 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.VideoCreationProperties +name: VideoCreationProperties +fullName: azure.media.videoanalyzeredge.VideoCreationProperties +module: azure.media.videoanalyzeredge +summary: Optional video properties to be used in case a new video resource needs to + be created on the service. These will not take effect if the video already exists. +constructor: + syntax: 'VideoCreationProperties(*, title: str | None = None, description: str | + None = None, segment_length: str | None = None, retention_period: str | None = + None, **kwargs)' + keywordOnlyParameters: + - name: title + description: 'Optional video title provided by the user. Value can be up to 256 + characters + + long.' + types: + - + - name: description + description: 'Optional video description provided by the user. Value can be up + to 2048 + + characters long.' + types: + - + - name: segment_length + description: 'Video segment length indicates the length of individual video files + + (segments) which are persisted to storage. Smaller segments provide lower archive + playback + + latency but generate larger volume of storage transactions. Larger segments + reduce the amount + + of storage transactions while increasing the archive playback latency. Value + must be specified + + in ISO8601 duration format (i.e. "PT30S" equals 30 seconds) and can vary between + 30 seconds to + + 5 minutes, in 30 seconds increments. Changing this value after the video is + initially created + + can lead to errors when uploading media to the archive. Default value is 30 + seconds.' + types: + - + - name: retention_period + description: 'Video retention period indicates how long the video is kept in + + storage, and must be a multiple of 1 day. For example, if this is set to 30 + days, then content + + older than 30 days will be deleted.' + types: + - +variables: +- description: Optional video title provided by the user. Value can be up to 256 characters + long. + name: title + types: + - +- description: 'Optional video description provided by the user. Value can be up to + 2048 + + characters long.' + name: description + types: + - +- description: 'Video segment length indicates the length of individual video files + + (segments) which are persisted to storage. Smaller segments provide lower archive + playback + + latency but generate larger volume of storage transactions. Larger segments reduce + the amount + + of storage transactions while increasing the archive playback latency. Value must + be specified + + in ISO8601 duration format (i.e. "PT30S" equals 30 seconds) and can vary between + 30 seconds to + + 5 minutes, in 30 seconds increments. Changing this value after the video is initially + created + + can lead to errors when uploading media to the archive. Default value is 30 seconds.' + name: segment_length + types: + - +- description: 'Video retention period indicates how long the video is kept in storage, + + and must be a multiple of 1 day. For example, if this is set to 30 days, then + content older + + than 30 days will be deleted.' + name: retention_period + types: + - +methods: +- uid: azure.media.videoanalyzeredge.VideoCreationProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.VideoCreationProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.VideoCreationProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.VideoCreationProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.VideoCreationProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.VideoCreationProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.VideoCreationProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoEncoderConfiguration.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoEncoderConfiguration.yml new file mode 100644 index 00000000..2651a2ea --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoEncoderConfiguration.yml @@ -0,0 +1,175 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.VideoEncoderConfiguration +name: VideoEncoderConfiguration +fullName: azure.media.videoanalyzeredge.VideoEncoderConfiguration +module: azure.media.videoanalyzeredge +summary: Class representing the MPEG4 Configuration. +constructor: + syntax: 'VideoEncoderConfiguration(*, encoding: str | VideoEncoding | None = None, + quality: float | None = None, resolution: VideoResolution | None = None, rate_control: + RateControl | None = None, h264: H264Configuration | None = None, mpeg4: MPEG4Configuration + | None = None, **kwargs)' + keywordOnlyParameters: + - name: encoding + description: 'The video codec used by the Media Profile. Possible values include: + "JPEG", + + "H264", "MPEG4".' + types: + - + - + - name: quality + description: Relative value representing the quality of the video. + types: + - + - name: resolution + description: The Video Resolution. + types: + - + - name: rate_control + description: The Video's rate control. + types: + - + - name: h264 + description: The H264 Configuration. + types: + - + - name: mpeg4 + description: The H264 Configuration. + types: + - +variables: +- description: 'The video codec used by the Media Profile. Possible values include: + "JPEG", + + "H264", "MPEG4".' + name: encoding + types: + - + - +- description: Relative value representing the quality of the video. + name: quality + types: + - +- description: The Video Resolution. + name: resolution + types: + - +- description: The Video's rate control. + name: rate_control + types: + - +- description: The H264 Configuration. + name: h264 + types: + - +- description: The H264 Configuration. + name: mpeg4 + types: + - +methods: +- uid: azure.media.videoanalyzeredge.VideoEncoderConfiguration.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.VideoEncoderConfiguration.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.VideoEncoderConfiguration.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.VideoEncoderConfiguration.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.VideoEncoderConfiguration.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.VideoEncoderConfiguration.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.VideoEncoderConfiguration.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoEncoding.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoEncoding.yml new file mode 100644 index 00000000..da780d46 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoEncoding.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.media.videoanalyzeredge.VideoEncoding +name: VideoEncoding +fullName: azure.media.videoanalyzeredge.VideoEncoding +summary: The video codec used by the Media Profile. +module: azure.media.videoanalyzeredge +fields: +- name: H264 + uid: azure.media.videoanalyzeredge.VideoEncoding.H264 +- name: JPEG + uid: azure.media.videoanalyzeredge.VideoEncoding.JPEG +- name: MPEG4 + uid: azure.media.videoanalyzeredge.VideoEncoding.MPEG4 diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoPublishingOptions.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoPublishingOptions.yml new file mode 100644 index 00000000..16e3c58c --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoPublishingOptions.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.VideoPublishingOptions +name: VideoPublishingOptions +fullName: azure.media.videoanalyzeredge.VideoPublishingOptions +module: azure.media.videoanalyzeredge +summary: Options for changing video publishing behavior on the video sink and output + video. +constructor: + syntax: 'VideoPublishingOptions(*, enable_video_preview_image: str | None = None, + **kwargs)' + keywordOnlyParameters: + - name: enable_video_preview_image + description: 'When set to ''true'' the video will publish preview images. + + Default is ''false''.' + types: + - +variables: +- description: 'When set to ''true'' the video will publish preview images. + + Default is ''false''.' + name: enable_video_preview_image + types: + - +methods: +- uid: azure.media.videoanalyzeredge.VideoPublishingOptions.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.VideoPublishingOptions.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.VideoPublishingOptions.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.VideoPublishingOptions.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.VideoPublishingOptions.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.VideoPublishingOptions.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.VideoPublishingOptions.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoResolution.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoResolution.yml new file mode 100644 index 00000000..86bc83a2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoResolution.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.VideoResolution +name: VideoResolution +fullName: azure.media.videoanalyzeredge.VideoResolution +module: azure.media.videoanalyzeredge +summary: The Video resolution. +constructor: + syntax: 'VideoResolution(*, width: float | None = None, height: float | None = None, + **kwargs)' + keywordOnlyParameters: + - name: width + description: The number of columns of the Video image. + types: + - + - name: height + description: The number of lines of the Video image. + types: + - +variables: +- description: The number of columns of the Video image. + name: width + types: + - +- description: The number of lines of the Video image. + name: height + types: + - +methods: +- uid: azure.media.videoanalyzeredge.VideoResolution.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.VideoResolution.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.VideoResolution.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.VideoResolution.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.VideoResolution.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.VideoResolution.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.VideoResolution.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoSink.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoSink.yml new file mode 100644 index 00000000..895b6879 --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoSink.yml @@ -0,0 +1,235 @@ +### YamlMime:PythonClass +uid: azure.media.videoanalyzeredge.VideoSink +name: VideoSink +fullName: azure.media.videoanalyzeredge.VideoSink +module: azure.media.videoanalyzeredge +summary: 'Video sink allows for video and audio to be recorded to the Video Analyzer + service. The recorded video can be played from anywhere and further managed from + the cloud. Due to security reasons, a given Video Analyzer edge module instance + can only record content to new video entries, or existing video entries previously + recorded by the same module. Any attempt to record content to an existing video + which has not been created by the same module instance will result in failure to + record. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'VideoSink(*, name: str, inputs: List[NodeInput], video_name: str, local_media_cache_path: + str, local_media_cache_maximum_size_mi_b: str, video_creation_properties: VideoCreationProperties + | None = None, video_publishing_options: VideoPublishingOptions | None = None, + **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Node name. Must be unique within the topology. + types: + - + - name: inputs + description: 'Required. An array of upstream node references within the topology + to be used + + as inputs for this node.' + types: + - [] + - name: video_name + description: 'Required. Name of a new or existing Video Analyzer video resource + used for + + the media recording.' + types: + - + - name: video_creation_properties + description: 'Optional video properties to be used in case a new video + + resource needs to be created on the service.' + types: + - + - name: video_publishing_options + description: 'Optional video publishing options to be used for changing + + publishing behavior of the output video.' + types: + - + - name: local_media_cache_path + description: 'Required. Path to a local file system directory for caching of + + temporary media files. This will also be used to store content which cannot + be immediately + + uploaded to Azure due to Internet connectivity issues.' + types: + - + - name: local_media_cache_maximum_size_mi_b + description: 'Required. Maximum amount of disk space that can + + be used for caching of temporary media files. Once this limit is reached, the + oldest segments + + of the media archive will be continuously deleted in order to make space for + new media, thus + + leading to gaps in the cloud recorded content.' + types: + - +variables: +- description: Required. Type discriminator for the derived types.Constant filled + by server. + name: type + types: + - +- description: Required. Node name. Must be unique within the topology. + name: name + types: + - +- description: 'Required. An array of upstream node references within the topology + to be used as + + inputs for this node.' + name: inputs + types: + - [] +- description: 'Required. Name of a new or existing Video Analyzer video resource + used for + + the media recording.' + name: video_name + types: + - +- description: 'Optional video properties to be used in case a new video + + resource needs to be created on the service.' + name: video_creation_properties + types: + - +- description: 'Optional video publishing options to be used for changing + + publishing behavior of the output video.' + name: video_publishing_options + types: + - +- description: 'Required. Path to a local file system directory for caching of + + temporary media files. This will also be used to store content which cannot be + immediately + + uploaded to Azure due to Internet connectivity issues.' + name: local_media_cache_path + types: + - +- description: 'Required. Maximum amount of disk space that can be + + used for caching of temporary media files. Once this limit is reached, the oldest + segments of + + the media archive will be continuously deleted in order to make space for new + media, thus + + leading to gaps in the cloud recorded content.' + name: local_media_cache_maximum_size_mi_b + types: + - +methods: +- uid: azure.media.videoanalyzeredge.VideoSink.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.VideoSink.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.VideoSink.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.media.videoanalyzeredge.VideoSink.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.media.videoanalyzeredge.VideoSink.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.media.videoanalyzeredge.VideoSink.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.media.videoanalyzeredge.VideoSink.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.yml new file mode 100644 index 00000000..38c0de4b --- /dev/null +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonPackage +uid: azure.media.videoanalyzeredge +name: videoanalyzeredge +fullName: azure.media.videoanalyzeredge +type: rootImport +classes: +- azure.media.videoanalyzeredge.CertificateSource +- azure.media.videoanalyzeredge.CognitiveServicesVisionProcessor +- azure.media.videoanalyzeredge.CredentialsBase +- azure.media.videoanalyzeredge.DiscoveredOnvifDevice +- azure.media.videoanalyzeredge.DiscoveredOnvifDeviceCollection +- azure.media.videoanalyzeredge.EndpointBase +- azure.media.videoanalyzeredge.ExtensionProcessorBase +- azure.media.videoanalyzeredge.FileSink +- azure.media.videoanalyzeredge.GrpcExtension +- azure.media.videoanalyzeredge.GrpcExtensionDataTransfer +- azure.media.videoanalyzeredge.H264Configuration +- azure.media.videoanalyzeredge.HttpExtension +- azure.media.videoanalyzeredge.HttpHeaderCredentials +- azure.media.videoanalyzeredge.ImageFormatBmp +- azure.media.videoanalyzeredge.ImageFormatJpeg +- azure.media.videoanalyzeredge.ImageFormatPng +- azure.media.videoanalyzeredge.ImageFormatProperties +- azure.media.videoanalyzeredge.ImageFormatRaw +- azure.media.videoanalyzeredge.ImageProperties +- azure.media.videoanalyzeredge.ImageScale +- azure.media.videoanalyzeredge.IotHubDeviceConnection +- azure.media.videoanalyzeredge.IotHubMessageSink +- azure.media.videoanalyzeredge.IotHubMessageSource +- azure.media.videoanalyzeredge.LineCrossingProcessor +- azure.media.videoanalyzeredge.LivePipeline +- azure.media.videoanalyzeredge.LivePipelineActivateRequest +- azure.media.videoanalyzeredge.LivePipelineCollection +- azure.media.videoanalyzeredge.LivePipelineDeactivateRequest +- azure.media.videoanalyzeredge.LivePipelineDeleteRequest +- azure.media.videoanalyzeredge.LivePipelineGetRequest +- azure.media.videoanalyzeredge.LivePipelineListRequest +- azure.media.videoanalyzeredge.LivePipelineProperties +- azure.media.videoanalyzeredge.LivePipelineSetRequest +- azure.media.videoanalyzeredge.LivePipelineSetRequestBody +- azure.media.videoanalyzeredge.MPEG4Configuration +- azure.media.videoanalyzeredge.MediaProfile +- azure.media.videoanalyzeredge.MediaUri +- azure.media.videoanalyzeredge.MethodRequest +- azure.media.videoanalyzeredge.MethodRequestEmptyBodyBase +- azure.media.videoanalyzeredge.MotionDetectionProcessor +- azure.media.videoanalyzeredge.NamedLineBase +- azure.media.videoanalyzeredge.NamedLineString +- azure.media.videoanalyzeredge.NamedPolygonBase +- azure.media.videoanalyzeredge.NamedPolygonString +- azure.media.videoanalyzeredge.NodeInput +- azure.media.videoanalyzeredge.ObjectTrackingProcessor +- azure.media.videoanalyzeredge.OnvifDevice +- azure.media.videoanalyzeredge.OnvifDeviceDiscoverRequest +- azure.media.videoanalyzeredge.OnvifDeviceGetRequest +- azure.media.videoanalyzeredge.OnvifDns +- azure.media.videoanalyzeredge.OnvifHostName +- azure.media.videoanalyzeredge.OnvifSystemDateTime +- azure.media.videoanalyzeredge.OutputSelector +- azure.media.videoanalyzeredge.ParameterDeclaration +- azure.media.videoanalyzeredge.ParameterDefinition +- azure.media.videoanalyzeredge.PemCertificateList +- azure.media.videoanalyzeredge.PipelineTopology +- azure.media.videoanalyzeredge.PipelineTopologyCollection +- azure.media.videoanalyzeredge.PipelineTopologyDeleteRequest +- azure.media.videoanalyzeredge.PipelineTopologyGetRequest +- azure.media.videoanalyzeredge.PipelineTopologyListRequest +- azure.media.videoanalyzeredge.PipelineTopologyProperties +- azure.media.videoanalyzeredge.PipelineTopologySetRequest +- azure.media.videoanalyzeredge.PipelineTopologySetRequestBody +- azure.media.videoanalyzeredge.ProcessorNodeBase +- azure.media.videoanalyzeredge.RateControl +- azure.media.videoanalyzeredge.RemoteDeviceAdapter +- azure.media.videoanalyzeredge.RemoteDeviceAdapterCollection +- azure.media.videoanalyzeredge.RemoteDeviceAdapterDeleteRequest +- azure.media.videoanalyzeredge.RemoteDeviceAdapterGetRequest +- azure.media.videoanalyzeredge.RemoteDeviceAdapterListRequest +- azure.media.videoanalyzeredge.RemoteDeviceAdapterProperties +- azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequest +- azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequestBody +- azure.media.videoanalyzeredge.RemoteDeviceAdapterTarget +- azure.media.videoanalyzeredge.RtspSource +- azure.media.videoanalyzeredge.SamplingOptions +- azure.media.videoanalyzeredge.SignalGateProcessor +- azure.media.videoanalyzeredge.SinkNodeBase +- azure.media.videoanalyzeredge.SourceNodeBase +- azure.media.videoanalyzeredge.SpatialAnalysisCustomOperation +- azure.media.videoanalyzeredge.SpatialAnalysisOperationBase +- azure.media.videoanalyzeredge.SpatialAnalysisOperationEventBase +- azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEvent +- azure.media.videoanalyzeredge.SpatialAnalysisPersonCountOperation +- azure.media.videoanalyzeredge.SpatialAnalysisPersonCountZoneEvents +- azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEvent +- azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceOperation +- azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceZoneEvents +- azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingEvent +- azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingLineEvents +- azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingOperation +- azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEvent +- azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingOperation +- azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingZoneEvents +- azure.media.videoanalyzeredge.SpatialAnalysisTypedOperationBase +- azure.media.videoanalyzeredge.SymmetricKeyCredentials +- azure.media.videoanalyzeredge.SystemData +- azure.media.videoanalyzeredge.TlsEndpoint +- azure.media.videoanalyzeredge.TlsValidationOptions +- azure.media.videoanalyzeredge.UnsecuredEndpoint +- azure.media.videoanalyzeredge.UsernamePasswordCredentials +- azure.media.videoanalyzeredge.VideoCreationProperties +- azure.media.videoanalyzeredge.VideoEncoderConfiguration +- azure.media.videoanalyzeredge.VideoPublishingOptions +- azure.media.videoanalyzeredge.VideoResolution +- azure.media.videoanalyzeredge.VideoSink +enums: +- azure.media.videoanalyzeredge.GrpcExtensionDataTransferMode +- azure.media.videoanalyzeredge.H264Profile +- azure.media.videoanalyzeredge.ImageFormatRawPixelFormat +- azure.media.videoanalyzeredge.ImageScaleMode +- azure.media.videoanalyzeredge.LivePipelineState +- azure.media.videoanalyzeredge.MPEG4Profile +- azure.media.videoanalyzeredge.MotionDetectionSensitivity +- azure.media.videoanalyzeredge.ObjectTrackingAccuracy +- azure.media.videoanalyzeredge.OnvifSystemDateTimeType +- azure.media.videoanalyzeredge.OutputSelectorOperator +- azure.media.videoanalyzeredge.OutputSelectorProperty +- azure.media.videoanalyzeredge.ParameterType +- azure.media.videoanalyzeredge.RtspTransport +- azure.media.videoanalyzeredge.SpatialAnalysisOperationFocus +- azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEventTrigger +- azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEventTrigger +- azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEventType +- azure.media.videoanalyzeredge.VideoEncoding diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.AzureAgFoodPlatformRPService.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.AzureAgFoodPlatformRPService.yml new file mode 100644 index 00000000..a743c8f1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.AzureAgFoodPlatformRPService.yml @@ -0,0 +1,50 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.AzureAgFoodPlatformRPService +name: AzureAgFoodPlatformRPService +fullName: azure.mgmt.agfood.AzureAgFoodPlatformRPService +module: azure.mgmt.agfood +summary: APIs documentation for Azure AgFoodPlatform Resource Provider Service. +constructor: + syntax: 'AzureAgFoodPlatformRPService(credential: ''TokenCredential'', subscription_id: + str, base_url: str | None = None, **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: subscription_id + description: The ID of the target subscription. + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - +variables: +- description: ExtensionsOperations operations + name: extensions + types: + - +- description: FarmBeatsExtensionsOperations operations + name: farm_beats_extensions + types: + - +- description: FarmBeatsModelsOperations operations + name: farm_beats_models + types: + - +- description: LocationsOperations operations + name: locations + types: + - +- description: Operations operations + name: operations + types: + - +methods: +- uid: azure.mgmt.agfood.AzureAgFoodPlatformRPService.close + name: close + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.AzureAgFoodPlatformRPService.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.AzureAgFoodPlatformRPService.yml new file mode 100644 index 00000000..3ba6f5b1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.AzureAgFoodPlatformRPService.yml @@ -0,0 +1,50 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.aio.AzureAgFoodPlatformRPService +name: AzureAgFoodPlatformRPService +fullName: azure.mgmt.agfood.aio.AzureAgFoodPlatformRPService +module: azure.mgmt.agfood.aio +summary: APIs documentation for Azure AgFoodPlatform Resource Provider Service. +constructor: + syntax: 'AzureAgFoodPlatformRPService(credential: AsyncTokenCredential, subscription_id: + str, base_url: str | None = None, **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: subscription_id + description: The ID of the target subscription. + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - +variables: +- description: ExtensionsOperations operations + name: extensions + types: + - +- description: FarmBeatsExtensionsOperations operations + name: farm_beats_extensions + types: + - +- description: FarmBeatsModelsOperations operations + name: farm_beats_models + types: + - +- description: LocationsOperations operations + name: locations + types: + - +- description: Operations operations + name: operations + types: + - +methods: +- uid: azure.mgmt.agfood.aio.AzureAgFoodPlatformRPService.close + name: close + signature: async close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.ExtensionsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.ExtensionsOperations.yml new file mode 100644 index 00000000..5bc4d736 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.ExtensionsOperations.yml @@ -0,0 +1,215 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.aio.operations.ExtensionsOperations +name: ExtensionsOperations +fullName: azure.mgmt.agfood.aio.operations.ExtensionsOperations +module: azure.mgmt.agfood.aio.operations +summary: 'ExtensionsOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: ExtensionsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.agfood.aio.operations.ExtensionsOperations.create + name: create + summary: Install extension. + signature: 'async create(extension_id: str, farm_beats_resource_name: str, resource_group_name: + str, **kwargs) -> Extension' + parameters: + - name: extension_id + description: Id of extension resource. + isRequired: true + types: + - + - name: farm_beats_resource_name + description: FarmBeats resource name. + isRequired: true + types: + - + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Extension, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.agfood.aio.operations.ExtensionsOperations.delete + name: delete + summary: Uninstall extension. + signature: 'async delete(extension_id: str, farm_beats_resource_name: str, resource_group_name: + str, **kwargs) -> None' + parameters: + - name: extension_id + description: Id of extension resource. + isRequired: true + types: + - + - name: farm_beats_resource_name + description: FarmBeats resource name. + isRequired: true + types: + - + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.agfood.aio.operations.ExtensionsOperations.get + name: get + summary: Get installed extension details by extension id. + signature: 'async get(extension_id: str, farm_beats_resource_name: str, resource_group_name: + str, **kwargs) -> Extension' + parameters: + - name: extension_id + description: Id of extension resource. + isRequired: true + types: + - + - name: farm_beats_resource_name + description: FarmBeats resource name. + isRequired: true + types: + - + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Extension, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.agfood.aio.operations.ExtensionsOperations.list_by_farm_beats + name: list_by_farm_beats + summary: Get installed extensions details. + signature: 'list_by_farm_beats(resource_group_name: str, farm_beats_resource_name: + str, extension_ids: List[str] | None = None, extension_categories: List[str] | + None = None, max_page_size: int | None = 50, skip_token: str | None = None, **kwargs) + -> AsyncIterable[ExtensionListResponse]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: farm_beats_resource_name + description: FarmBeats resource name. + isRequired: true + types: + - + - name: extension_ids + description: Installed extension ids. + defaultValue: None + types: + - [] + - name: extension_categories + description: Installed extension categories. + defaultValue: None + types: + - [] + - name: max_page_size + description: 'Maximum number of items needed (inclusive). + + Minimum = 10, Maximum = 1000, Default value = 50.' + defaultValue: '50' + types: + - + - name: skip_token + description: Skip token for getting next set of results. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either ExtensionListResponse or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.agfood.aio.operations.ExtensionsOperations.update + name: update + summary: Upgrade to latest extension. + signature: 'async update(extension_id: str, farm_beats_resource_name: str, resource_group_name: + str, **kwargs) -> Extension' + parameters: + - name: extension_id + description: Id of extension resource. + isRequired: true + types: + - + - name: farm_beats_resource_name + description: FarmBeats resource name. + isRequired: true + types: + - + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Extension, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.agfood.aio.operations.ExtensionsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.FarmBeatsExtensionsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.FarmBeatsExtensionsOperations.yml new file mode 100644 index 00000000..beeb82f6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.FarmBeatsExtensionsOperations.yml @@ -0,0 +1,102 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.aio.operations.FarmBeatsExtensionsOperations +name: FarmBeatsExtensionsOperations +fullName: azure.mgmt.agfood.aio.operations.FarmBeatsExtensionsOperations +module: azure.mgmt.agfood.aio.operations +summary: 'FarmBeatsExtensionsOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: FarmBeatsExtensionsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.agfood.aio.operations.FarmBeatsExtensionsOperations.get + name: get + summary: Get farmBeats extension. + signature: 'async get(farm_beats_extension_id: str, **kwargs) -> FarmBeatsExtension' + parameters: + - name: farm_beats_extension_id + description: farmBeatsExtensionId to be queried. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: FarmBeatsExtension, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.agfood.aio.operations.FarmBeatsExtensionsOperations.list + name: list + summary: Get list of farmBeats extension. + signature: 'list(farm_beats_extension_ids: List[str] | None = None, farm_beats_extension_names: + List[str] | None = None, extension_categories: List[str] | None = None, publisher_ids: + List[str] | None = None, max_page_size: int | None = 50, **kwargs) -> AsyncIterable[FarmBeatsExtensionListResponse]' + parameters: + - name: farm_beats_extension_ids + description: FarmBeatsExtension ids. + defaultValue: None + types: + - [] + - name: farm_beats_extension_names + description: FarmBeats extension names. + defaultValue: None + types: + - [] + - name: extension_categories + description: Extension categories. + defaultValue: None + types: + - [] + - name: publisher_ids + description: Publisher ids. + defaultValue: None + types: + - [] + - name: max_page_size + description: 'Maximum number of items needed (inclusive). + + Minimum = 10, Maximum = 1000, Default value = 50.' + defaultValue: '50' + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either FarmBeatsExtensionListResponse + or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.agfood.aio.operations.FarmBeatsExtensionsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.FarmBeatsModelsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.FarmBeatsModelsOperations.yml new file mode 100644 index 00000000..c5dda83f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.FarmBeatsModelsOperations.yml @@ -0,0 +1,218 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.aio.operations.FarmBeatsModelsOperations +name: FarmBeatsModelsOperations +fullName: azure.mgmt.agfood.aio.operations.FarmBeatsModelsOperations +module: azure.mgmt.agfood.aio.operations +summary: 'FarmBeatsModelsOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: FarmBeatsModelsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.agfood.aio.operations.FarmBeatsModelsOperations.create_or_update + name: create_or_update + summary: Create or update FarmBeats resource. + signature: 'async create_or_update(farm_beats_resource_name: str, resource_group_name: + str, body: FarmBeats, **kwargs) -> FarmBeats' + parameters: + - name: farm_beats_resource_name + description: FarmBeats resource name. + isRequired: true + types: + - + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: body + description: FarmBeats resource create or update request object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: FarmBeats, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.agfood.aio.operations.FarmBeatsModelsOperations.delete + name: delete + summary: Delete a FarmBeats resource. + signature: 'async delete(resource_group_name: str, farm_beats_resource_name: str, + **kwargs) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: farm_beats_resource_name + description: FarmBeats resource name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.agfood.aio.operations.FarmBeatsModelsOperations.get + name: get + summary: Get FarmBeats resource. + signature: 'async get(resource_group_name: str, farm_beats_resource_name: str, **kwargs) + -> FarmBeats' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: farm_beats_resource_name + description: FarmBeats resource name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: FarmBeats, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.agfood.aio.operations.FarmBeatsModelsOperations.list_by_resource_group + name: list_by_resource_group + summary: Lists the FarmBeats instances for a resource group. + signature: 'list_by_resource_group(resource_group_name: str, max_page_size: int + | None = 50, skip_token: str | None = None, **kwargs) -> AsyncIterable[FarmBeatsListResponse]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: max_page_size + description: 'Maximum number of items needed (inclusive). + + Minimum = 10, Maximum = 1000, Default value = 50.' + defaultValue: '50' + types: + - + - name: skip_token + description: Continuation token for getting next set of results. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either FarmBeatsListResponse or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.agfood.aio.operations.FarmBeatsModelsOperations.list_by_subscription + name: list_by_subscription + summary: Lists the FarmBeats instances for a subscription. + signature: 'list_by_subscription(max_page_size: int | None = 50, skip_token: str + | None = None, **kwargs) -> AsyncIterable[FarmBeatsListResponse]' + parameters: + - name: max_page_size + description: 'Maximum number of items needed (inclusive). + + Minimum = 10, Maximum = 1000, Default value = 50.' + defaultValue: '50' + types: + - + - name: skip_token + description: Skip token for getting next set of results. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either FarmBeatsListResponse or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.agfood.aio.operations.FarmBeatsModelsOperations.update + name: update + summary: Update a FarmBeats resource. + signature: 'async update(farm_beats_resource_name: str, resource_group_name: str, + body: FarmBeatsUpdateRequestModel, **kwargs) -> FarmBeats' + parameters: + - name: farm_beats_resource_name + description: FarmBeats resource name. + isRequired: true + types: + - + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: body + description: Request object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: FarmBeats, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.agfood.aio.operations.FarmBeatsModelsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.LocationsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.LocationsOperations.yml new file mode 100644 index 00000000..04bb1d01 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.LocationsOperations.yml @@ -0,0 +1,57 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.aio.operations.LocationsOperations +name: LocationsOperations +fullName: azure.mgmt.agfood.aio.operations.LocationsOperations +module: azure.mgmt.agfood.aio.operations +summary: 'LocationsOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: LocationsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.agfood.aio.operations.LocationsOperations.check_name_availability + name: check_name_availability + summary: Checks the name availability of the resource with requested resource name. + signature: 'async check_name_availability(body: CheckNameAvailabilityRequest, **kwargs) + -> CheckNameAvailabilityResponse' + parameters: + - name: body + description: NameAvailabilityRequest object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: CheckNameAvailabilityResponse, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.agfood.aio.operations.LocationsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.Operations.yml new file mode 100644 index 00000000..86715f3a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.Operations.yml @@ -0,0 +1,51 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.aio.operations.Operations +name: Operations +fullName: azure.mgmt.agfood.aio.operations.Operations +module: azure.mgmt.agfood.aio.operations +summary: 'Operations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: Operations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.agfood.aio.operations.Operations.list + name: list + summary: Lists the available operations of Microsoft.AgFoodPlatform resource provider. + signature: list(**kwargs) -> AsyncIterable[OperationListResult] + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either OperationListResult or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.agfood.aio.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.yml new file mode 100644 index 00000000..1db4a608 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.operations.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.agfood.aio.operations +name: operations +fullName: azure.mgmt.agfood.aio.operations +type: import +classes: +- azure.mgmt.agfood.aio.operations.ExtensionsOperations +- azure.mgmt.agfood.aio.operations.FarmBeatsExtensionsOperations +- azure.mgmt.agfood.aio.operations.FarmBeatsModelsOperations +- azure.mgmt.agfood.aio.operations.LocationsOperations +- azure.mgmt.agfood.aio.operations.Operations diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.yml new file mode 100644 index 00000000..45cdfd47 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.aio.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.agfood.aio +name: aio +fullName: azure.mgmt.agfood.aio +type: import +classes: +- azure.mgmt.agfood.aio.AzureAgFoodPlatformRPService +packages: +- azure.mgmt.agfood.aio.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ActionType.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ActionType.yml new file mode 100644 index 00000000..773cd2eb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ActionType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.agfood.models.ActionType +name: ActionType +fullName: azure.mgmt.agfood.models.ActionType +summary: Enum. Indicates the action type. "Internal" refers to actions that are for + internal only APIs. +module: azure.mgmt.agfood.models +fields: +- name: INTERNAL + uid: azure.mgmt.agfood.models.ActionType.INTERNAL diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CheckNameAvailabilityReason.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CheckNameAvailabilityReason.yml new file mode 100644 index 00000000..f453d8dd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CheckNameAvailabilityReason.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.agfood.models.CheckNameAvailabilityReason +name: CheckNameAvailabilityReason +fullName: azure.mgmt.agfood.models.CheckNameAvailabilityReason +summary: The reason why the given name is not available. +module: azure.mgmt.agfood.models +fields: +- name: ALREADY_EXISTS + uid: azure.mgmt.agfood.models.CheckNameAvailabilityReason.ALREADY_EXISTS +- name: INVALID + uid: azure.mgmt.agfood.models.CheckNameAvailabilityReason.INVALID diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CheckNameAvailabilityRequest.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CheckNameAvailabilityRequest.yml new file mode 100644 index 00000000..13c5f5e3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CheckNameAvailabilityRequest.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.models.CheckNameAvailabilityRequest +name: CheckNameAvailabilityRequest +fullName: azure.mgmt.agfood.models.CheckNameAvailabilityRequest +module: azure.mgmt.agfood.models +summary: The check availability request body. +constructor: + syntax: 'CheckNameAvailabilityRequest(*, name: str | None = None, type: str | None + = None, **kwargs)' + parameters: + - name: name + description: The name of the resource for which availability needs to be checked. + isRequired: true + types: + - + - name: type + description: The resource type. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: type + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CheckNameAvailabilityResponse.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CheckNameAvailabilityResponse.yml new file mode 100644 index 00000000..00ecd7ae --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CheckNameAvailabilityResponse.yml @@ -0,0 +1,36 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.models.CheckNameAvailabilityResponse +name: CheckNameAvailabilityResponse +fullName: azure.mgmt.agfood.models.CheckNameAvailabilityResponse +module: azure.mgmt.agfood.models +summary: The check availability result. +constructor: + syntax: 'CheckNameAvailabilityResponse(*, name_available: bool | None = None, reason: + str | CheckNameAvailabilityReason | None = None, message: str | None = None, **kwargs)' + parameters: + - name: name_available + description: Indicates if the resource name is available. + isRequired: true + types: + - + - name: reason + description: 'The reason why the given name is not available. Possible values + include: + + "Invalid", "AlreadyExists".' + isRequired: true + types: + - + - + - name: message + description: Detailed reason why the given name is available. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name_available + isRequired: true + - name: reason + isRequired: true + - name: message + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CreatedByType.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CreatedByType.yml new file mode 100644 index 00000000..18e835c4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CreatedByType.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.agfood.models.CreatedByType +name: CreatedByType +fullName: azure.mgmt.agfood.models.CreatedByType +summary: The type of identity that created the resource. +module: azure.mgmt.agfood.models +fields: +- name: APPLICATION + uid: azure.mgmt.agfood.models.CreatedByType.APPLICATION +- name: KEY + uid: azure.mgmt.agfood.models.CreatedByType.KEY +- name: MANAGED_IDENTITY + uid: azure.mgmt.agfood.models.CreatedByType.MANAGED_IDENTITY +- name: USER + uid: azure.mgmt.agfood.models.CreatedByType.USER diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.DetailedInformation.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.DetailedInformation.yml new file mode 100644 index 00000000..a3f640a3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.DetailedInformation.yml @@ -0,0 +1,48 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.models.DetailedInformation +name: DetailedInformation +fullName: azure.mgmt.agfood.models.DetailedInformation +module: azure.mgmt.agfood.models +summary: Model to capture detailed information for farmBeatsExtensions. +constructor: + syntax: 'DetailedInformation(*, api_name: str | None = None, custom_parameters: + List[str] | None = None, platform_parameters: List[str] | None = None, units_supported: + UnitSystemsInfo | None = None, api_input_parameters: List[str] | None = None, + **kwargs)' + parameters: + - name: api_name + description: ApiName available for the farmBeatsExtension. + isRequired: true + types: + - + - name: custom_parameters + description: List of customParameters. + isRequired: true + types: + - [] + - name: platform_parameters + description: List of platformParameters. + isRequired: true + types: + - [] + - name: units_supported + description: Unit systems info for the data provider. + isRequired: true + types: + - + - name: api_input_parameters + description: List of apiInputParameters. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: api_name + isRequired: true + - name: custom_parameters + isRequired: true + - name: platform_parameters + isRequired: true + - name: units_supported + isRequired: true + - name: api_input_parameters + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ErrorAdditionalInfo.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ErrorAdditionalInfo.yml new file mode 100644 index 00000000..082201ee --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ErrorAdditionalInfo.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.models.ErrorAdditionalInfo +name: ErrorAdditionalInfo +fullName: azure.mgmt.agfood.models.ErrorAdditionalInfo +module: azure.mgmt.agfood.models +summary: 'The resource management error additional info. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: ErrorAdditionalInfo(**kwargs) +variables: +- description: The additional info type. + name: type + types: + - +- description: The additional info. + name: info + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ErrorDetail.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ErrorDetail.yml new file mode 100644 index 00000000..49572eed --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ErrorDetail.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.models.ErrorDetail +name: ErrorDetail +fullName: azure.mgmt.agfood.models.ErrorDetail +module: azure.mgmt.agfood.models +summary: 'The error detail. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: ErrorDetail(**kwargs) +variables: +- description: The error code. + name: code + types: + - +- description: The error message. + name: message + types: + - +- description: The error target. + name: target + types: + - +- description: The error details. + name: details + types: + - [] +- description: The error additional info. + name: additional_info + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ErrorResponse.yml new file mode 100644 index 00000000..37edb43c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ErrorResponse.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.models.ErrorResponse +name: ErrorResponse +fullName: azure.mgmt.agfood.models.ErrorResponse +module: azure.mgmt.agfood.models +summary: Common error response for all Azure Resource Manager APIs to return error + details for failed operations. (This also follows the OData error response format.). +constructor: + syntax: 'ErrorResponse(*, error: ErrorDetail | None = None, **kwargs)' + parameters: + - name: error + description: The error object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: error + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.Extension.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.Extension.yml new file mode 100644 index 00000000..7e5e9ae0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.Extension.yml @@ -0,0 +1,57 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.models.Extension +name: Extension +fullName: azure.mgmt.agfood.models.Extension +module: azure.mgmt.agfood.models +summary: 'Extension resource. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: Extension(**kwargs) +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: Metadata pertaining to creation and last modification of the resource. + name: system_data + types: + - +- description: The ETag value to implement optimistic concurrency. + name: e_tag + types: + - +- description: Extension Id. + name: extension_id + types: + - +- description: Extension category. e.g. weather/sensor/satellite. + name: extension_category + types: + - +- description: Installed extension version. + name: installed_extension_version + types: + - +- description: Extension auth link. + name: extension_auth_link + types: + - +- description: Extension api docs link. + name: extension_api_docs_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ExtensionListResponse.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ExtensionListResponse.yml new file mode 100644 index 00000000..f280e4e2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ExtensionListResponse.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.models.ExtensionListResponse +name: ExtensionListResponse +fullName: azure.mgmt.agfood.models.ExtensionListResponse +module: azure.mgmt.agfood.models +summary: 'Paged response contains list of requested objects and a URL link to get + the next set of results. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'ExtensionListResponse(*, value: List[Extension] | None = None, **kwargs)' + parameters: + - name: value + description: List of requested objects. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: value + isRequired: true +variables: +- description: Continuation link (absolute URI) to the next page of results in the + list. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeats.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeats.yml new file mode 100644 index 00000000..63a1c5cc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeats.yml @@ -0,0 +1,63 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.models.FarmBeats +name: FarmBeats +fullName: azure.mgmt.agfood.models.FarmBeats +module: azure.mgmt.agfood.models +summary: 'FarmBeats ARM Resource. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'FarmBeats(*, location: str, tags: Dict[str, str] | None = None, **kwargs)' + parameters: + - name: tags + description: A set of tags. Resource tags. + isRequired: true + types: + - [, ] + - name: location + description: Required. The geo-location where the resource lives. + isRequired: true + types: + - + keywordOnlyParameters: + - name: location + isRequired: true + - name: tags + isRequired: true +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: Metadata pertaining to creation and last modification of the resource. + name: system_data + types: + - +- description: Uri of the FarmBeats instance. + name: instance_uri + types: + - +- description: 'FarmBeats instance provisioning state. Possible values include: + + "Succeeded", "Failed".' + name: provisioning_state + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsExtension.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsExtension.yml new file mode 100644 index 00000000..8027b727 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsExtension.yml @@ -0,0 +1,79 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.models.FarmBeatsExtension +name: FarmBeatsExtension +fullName: azure.mgmt.agfood.models.FarmBeatsExtension +module: azure.mgmt.agfood.models +summary: 'FarmBeats extension resource. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: FarmBeatsExtension(**kwargs) +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: Metadata pertaining to creation and last modification of the resource. + name: system_data + types: + - +- description: Target ResourceType of the farmBeatsExtension. + name: target_resource_type + types: + - +- description: FarmBeatsExtension ID. + name: farm_beats_extension_id + types: + - +- description: FarmBeatsExtension name. + name: farm_beats_extension_name + types: + - +- description: FarmBeatsExtension version. + name: farm_beats_extension_version + types: + - +- description: Publisher ID. + name: publisher_id + types: + - +- description: Textual description. + name: description + types: + - +- description: Category of the extension. e.g. weather/sensor/satellite. + name: extension_category + types: + - +- description: FarmBeatsExtension auth link. + name: extension_auth_link + types: + - +- description: FarmBeatsExtension api docs link. + name: extension_api_docs_link + types: + - +- description: 'Detailed information which shows summary of requested data. + + Used in descriptive get extension metadata call. + + Information for weather category per api included are apisSupported, + + customParameters, PlatformParameters and Units supported.' + name: detailed_information + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsExtensionListResponse.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsExtensionListResponse.yml new file mode 100644 index 00000000..66830c70 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsExtensionListResponse.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.models.FarmBeatsExtensionListResponse +name: FarmBeatsExtensionListResponse +fullName: azure.mgmt.agfood.models.FarmBeatsExtensionListResponse +module: azure.mgmt.agfood.models +summary: 'Paged response contains list of requested objects and a URL link to get + the next set of results. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'FarmBeatsExtensionListResponse(*, value: List[FarmBeatsExtension] | None + = None, **kwargs)' + parameters: + - name: value + description: List of requested objects. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: value + isRequired: true +variables: +- description: Continuation link (absolute URI) to the next page of results in the + list. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsListResponse.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsListResponse.yml new file mode 100644 index 00000000..3e56f413 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsListResponse.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.models.FarmBeatsListResponse +name: FarmBeatsListResponse +fullName: azure.mgmt.agfood.models.FarmBeatsListResponse +module: azure.mgmt.agfood.models +summary: 'Paged response contains list of requested objects and a URL link to get + the next set of results. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'FarmBeatsListResponse(*, value: List[FarmBeats] | None = None, **kwargs)' + parameters: + - name: value + description: List of requested objects. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: value + isRequired: true +variables: +- description: Continuation link (absolute URI) to the next page of results in the + list. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsUpdateRequestModel.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsUpdateRequestModel.yml new file mode 100644 index 00000000..57053210 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsUpdateRequestModel.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.models.FarmBeatsUpdateRequestModel +name: FarmBeatsUpdateRequestModel +fullName: azure.mgmt.agfood.models.FarmBeatsUpdateRequestModel +module: azure.mgmt.agfood.models +summary: FarmBeats update request. +constructor: + syntax: 'FarmBeatsUpdateRequestModel(*, location: str | None = None, tags: Dict[str, + str] | None = None, **kwargs)' + parameters: + - name: location + description: Geo-location where the resource lives. + isRequired: true + types: + - + - name: tags + description: A set of tags. Resource tags. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: location + isRequired: true + - name: tags + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.Operation.yml new file mode 100644 index 00000000..a01c9845 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.Operation.yml @@ -0,0 +1,54 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.models.Operation +name: Operation +fullName: azure.mgmt.agfood.models.Operation +module: azure.mgmt.agfood.models +summary: 'Details of a REST API operation, returned from the Resource Provider Operations + API. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'Operation(*, display: OperationDisplay | None = None, **kwargs)' + parameters: + - name: display + description: Localized display information for this particular operation. + isRequired: true + types: + - + keywordOnlyParameters: + - name: display + isRequired: true +variables: +- description: 'The name of the operation, as per Resource-Based Access Control (RBAC). + Examples: + + "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action".' + name: name + types: + - +- description: 'Whether the operation applies to data-plane. This is "true" for + + data-plane operations and "false" for ARM/control-plane operations.' + name: is_data_action + types: + - +- description: 'The intended executor of the operation; as in Resource Based Access + Control + + (RBAC) and audit logs UX. Default value is "user,system". Possible values include: + "user", + + "system", "user,system".' + name: origin + types: + - + - +- description: 'Enum. Indicates the action type. "Internal" refers to actions that + are for + + internal only APIs. Possible values include: "Internal".' + name: action_type + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.OperationDisplay.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.OperationDisplay.yml new file mode 100644 index 00000000..7b254ec2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.OperationDisplay.yml @@ -0,0 +1,37 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.models.OperationDisplay +name: OperationDisplay +fullName: azure.mgmt.agfood.models.OperationDisplay +module: azure.mgmt.agfood.models +summary: 'Localized display information for this particular operation. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: OperationDisplay(**kwargs) +variables: +- description: 'The localized friendly form of the resource provider name, e.g. "Microsoft + + Monitoring Insights" or "Microsoft Compute".' + name: provider + types: + - +- description: 'The localized friendly name of the resource type related to this operation. + + E.g. "Virtual Machines" or "Job Schedule Collections".' + name: resource + types: + - +- description: 'The concise, localized friendly name for the operation; suitable for + + dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine".' + name: operation + types: + - +- description: 'The short, localized friendly description of the operation; suitable + for + + tool tips and detailed views.' + name: description + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.OperationListResult.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.OperationListResult.yml new file mode 100644 index 00000000..304e3f78 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.OperationListResult.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.models.OperationListResult +name: OperationListResult +fullName: azure.mgmt.agfood.models.OperationListResult +module: azure.mgmt.agfood.models +summary: 'A list of REST API operations supported by an Azure Resource Provider. It + contains an URL link to get the next set of results. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: OperationListResult(**kwargs) +variables: +- description: List of operations supported by the resource provider. + name: value + types: + - [] +- description: URL to get the next set of operation list results (if there are any). + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.Origin.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.Origin.yml new file mode 100644 index 00000000..e7a35901 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.Origin.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.agfood.models.Origin +name: Origin +fullName: azure.mgmt.agfood.models.Origin +summary: 'The intended executor of the operation; as in Resource Based Access Control + (RBAC) and audit + + logs UX. Default value is "user,system"' +module: azure.mgmt.agfood.models +fields: +- name: SYSTEM + uid: azure.mgmt.agfood.models.Origin.SYSTEM +- name: USER + uid: azure.mgmt.agfood.models.Origin.USER +- name: USER_SYSTEM + uid: azure.mgmt.agfood.models.Origin.USER_SYSTEM diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ProvisioningState.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ProvisioningState.yml new file mode 100644 index 00000000..67fe2937 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ProvisioningState.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.agfood.models.ProvisioningState +name: ProvisioningState +fullName: azure.mgmt.agfood.models.ProvisioningState +summary: FarmBeats instance provisioning state. +module: azure.mgmt.agfood.models +fields: +- name: FAILED + uid: azure.mgmt.agfood.models.ProvisioningState.FAILED +- name: SUCCEEDED + uid: azure.mgmt.agfood.models.ProvisioningState.SUCCEEDED diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ProxyResource.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ProxyResource.yml new file mode 100644 index 00000000..96a6829d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ProxyResource.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.models.ProxyResource +name: ProxyResource +fullName: azure.mgmt.agfood.models.ProxyResource +module: azure.mgmt.agfood.models +summary: 'The resource model definition for a Azure Resource Manager proxy resource. + It will not have tags and a location. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: ProxyResource(**kwargs) +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.Resource.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.Resource.yml new file mode 100644 index 00000000..49fa7f8f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.Resource.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.models.Resource +name: Resource +fullName: azure.mgmt.agfood.models.Resource +module: azure.mgmt.agfood.models +summary: 'Common fields that are returned in the response for all Azure Resource Manager + resources. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: Resource(**kwargs) +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.SystemData.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.SystemData.yml new file mode 100644 index 00000000..6e8f2aa6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.SystemData.yml @@ -0,0 +1,61 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.models.SystemData +name: SystemData +fullName: azure.mgmt.agfood.models.SystemData +module: azure.mgmt.agfood.models +summary: Metadata pertaining to creation and last modification of the resource. +constructor: + syntax: 'SystemData(*, created_by: str | None = None, created_by_type: str | CreatedByType + | None = None, created_at: datetime | None = None, last_modified_by: str | None + = None, last_modified_by_type: str | CreatedByType | None = None, last_modified_at: + datetime | None = None, **kwargs)' + parameters: + - name: created_by + description: The identity that created the resource. + isRequired: true + types: + - + - name: created_by_type + description: 'The type of identity that created the resource. Possible values + + include: "User", "Application", "ManagedIdentity", "Key".' + isRequired: true + types: + - + - + - name: created_at + description: The timestamp of resource creation (UTC). + isRequired: true + types: + - + - name: last_modified_by + description: The identity that last modified the resource. + isRequired: true + types: + - + - name: last_modified_by_type + description: 'The type of identity that last modified the resource. Possible + + values include: "User", "Application", "ManagedIdentity", "Key".' + isRequired: true + types: + - + - + - name: last_modified_at + description: The timestamp of resource last modification (UTC). + isRequired: true + types: + - + keywordOnlyParameters: + - name: created_by + isRequired: true + - name: created_by_type + isRequired: true + - name: created_at + isRequired: true + - name: last_modified_by + isRequired: true + - name: last_modified_by_type + isRequired: true + - name: last_modified_at + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.TrackedResource.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.TrackedResource.yml new file mode 100644 index 00000000..145705ba --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.TrackedResource.yml @@ -0,0 +1,49 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.models.TrackedResource +name: TrackedResource +fullName: azure.mgmt.agfood.models.TrackedResource +module: azure.mgmt.agfood.models +summary: 'The resource model definition for an Azure Resource Manager tracked top + level resource which has ''tags'' and a ''location''. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TrackedResource(*, location: str, tags: Dict[str, str] | None = None, **kwargs)' + parameters: + - name: tags + description: A set of tags. Resource tags. + isRequired: true + types: + - [, ] + - name: location + description: Required. The geo-location where the resource lives. + isRequired: true + types: + - + keywordOnlyParameters: + - name: location + isRequired: true + - name: tags + isRequired: true +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.UnitSystemsInfo.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.UnitSystemsInfo.yml new file mode 100644 index 00000000..013ffc5d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.UnitSystemsInfo.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.models.UnitSystemsInfo +name: UnitSystemsInfo +fullName: azure.mgmt.agfood.models.UnitSystemsInfo +module: azure.mgmt.agfood.models +summary: 'Unit systems info for the data provider. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'UnitSystemsInfo(*, key: str, values: List[str], **kwargs)' + parameters: + - name: key + description: Required. UnitSystem key sent as part of ProviderInput. + isRequired: true + types: + - + - name: values + description: Required. List of unit systems supported by this data provider. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: key + isRequired: true + - name: values + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.yml new file mode 100644 index 00000000..9970bbaa --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.yml @@ -0,0 +1,33 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.agfood.models +name: models +fullName: azure.mgmt.agfood.models +type: import +classes: +- azure.mgmt.agfood.models.CheckNameAvailabilityRequest +- azure.mgmt.agfood.models.CheckNameAvailabilityResponse +- azure.mgmt.agfood.models.DetailedInformation +- azure.mgmt.agfood.models.ErrorAdditionalInfo +- azure.mgmt.agfood.models.ErrorDetail +- azure.mgmt.agfood.models.ErrorResponse +- azure.mgmt.agfood.models.Extension +- azure.mgmt.agfood.models.ExtensionListResponse +- azure.mgmt.agfood.models.FarmBeats +- azure.mgmt.agfood.models.FarmBeatsExtension +- azure.mgmt.agfood.models.FarmBeatsExtensionListResponse +- azure.mgmt.agfood.models.FarmBeatsListResponse +- azure.mgmt.agfood.models.FarmBeatsUpdateRequestModel +- azure.mgmt.agfood.models.Operation +- azure.mgmt.agfood.models.OperationDisplay +- azure.mgmt.agfood.models.OperationListResult +- azure.mgmt.agfood.models.ProxyResource +- azure.mgmt.agfood.models.Resource +- azure.mgmt.agfood.models.SystemData +- azure.mgmt.agfood.models.TrackedResource +- azure.mgmt.agfood.models.UnitSystemsInfo +enums: +- azure.mgmt.agfood.models.ActionType +- azure.mgmt.agfood.models.CheckNameAvailabilityReason +- azure.mgmt.agfood.models.CreatedByType +- azure.mgmt.agfood.models.Origin +- azure.mgmt.agfood.models.ProvisioningState diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.ExtensionsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.ExtensionsOperations.yml new file mode 100644 index 00000000..01d9a9d0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.ExtensionsOperations.yml @@ -0,0 +1,215 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.operations.ExtensionsOperations +name: ExtensionsOperations +fullName: azure.mgmt.agfood.operations.ExtensionsOperations +module: azure.mgmt.agfood.operations +summary: 'ExtensionsOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: ExtensionsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.agfood.operations.ExtensionsOperations.create + name: create + summary: Install extension. + signature: 'create(extension_id: str, farm_beats_resource_name: str, resource_group_name: + str, **kwargs: Any) -> _models.Extension' + parameters: + - name: extension_id + description: Id of extension resource. + isRequired: true + types: + - + - name: farm_beats_resource_name + description: FarmBeats resource name. + isRequired: true + types: + - + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Extension, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.agfood.operations.ExtensionsOperations.delete + name: delete + summary: Uninstall extension. + signature: 'delete(extension_id: str, farm_beats_resource_name: str, resource_group_name: + str, **kwargs: Any) -> None' + parameters: + - name: extension_id + description: Id of extension resource. + isRequired: true + types: + - + - name: farm_beats_resource_name + description: FarmBeats resource name. + isRequired: true + types: + - + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.agfood.operations.ExtensionsOperations.get + name: get + summary: Get installed extension details by extension id. + signature: 'get(extension_id: str, farm_beats_resource_name: str, resource_group_name: + str, **kwargs: Any) -> _models.Extension' + parameters: + - name: extension_id + description: Id of extension resource. + isRequired: true + types: + - + - name: farm_beats_resource_name + description: FarmBeats resource name. + isRequired: true + types: + - + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Extension, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.agfood.operations.ExtensionsOperations.list_by_farm_beats + name: list_by_farm_beats + summary: Get installed extensions details. + signature: 'list_by_farm_beats(resource_group_name: str, farm_beats_resource_name: + str, extension_ids: List[str] | None = None, extension_categories: List[str] | + None = None, max_page_size: int | None = 50, skip_token: str | None = None, **kwargs: + Any) -> Iterable[''_models.ExtensionListResponse'']' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: farm_beats_resource_name + description: FarmBeats resource name. + isRequired: true + types: + - + - name: extension_ids + description: Installed extension ids. + defaultValue: None + types: + - [] + - name: extension_categories + description: Installed extension categories. + defaultValue: None + types: + - [] + - name: max_page_size + description: 'Maximum number of items needed (inclusive). + + Minimum = 10, Maximum = 1000, Default value = 50.' + defaultValue: '50' + types: + - + - name: skip_token + description: Skip token for getting next set of results. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either ExtensionListResponse or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.agfood.operations.ExtensionsOperations.update + name: update + summary: Upgrade to latest extension. + signature: 'update(extension_id: str, farm_beats_resource_name: str, resource_group_name: + str, **kwargs: Any) -> _models.Extension' + parameters: + - name: extension_id + description: Id of extension resource. + isRequired: true + types: + - + - name: farm_beats_resource_name + description: FarmBeats resource name. + isRequired: true + types: + - + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Extension, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.agfood.operations.ExtensionsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.FarmBeatsExtensionsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.FarmBeatsExtensionsOperations.yml new file mode 100644 index 00000000..a3afd9b2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.FarmBeatsExtensionsOperations.yml @@ -0,0 +1,102 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.operations.FarmBeatsExtensionsOperations +name: FarmBeatsExtensionsOperations +fullName: azure.mgmt.agfood.operations.FarmBeatsExtensionsOperations +module: azure.mgmt.agfood.operations +summary: 'FarmBeatsExtensionsOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: FarmBeatsExtensionsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.agfood.operations.FarmBeatsExtensionsOperations.get + name: get + summary: Get farmBeats extension. + signature: 'get(farm_beats_extension_id: str, **kwargs: Any) -> _models.FarmBeatsExtension' + parameters: + - name: farm_beats_extension_id + description: farmBeatsExtensionId to be queried. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: FarmBeatsExtension, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.agfood.operations.FarmBeatsExtensionsOperations.list + name: list + summary: Get list of farmBeats extension. + signature: 'list(farm_beats_extension_ids: List[str] | None = None, farm_beats_extension_names: + List[str] | None = None, extension_categories: List[str] | None = None, publisher_ids: + List[str] | None = None, max_page_size: int | None = 50, **kwargs: Any) -> Iterable[''_models.FarmBeatsExtensionListResponse'']' + parameters: + - name: farm_beats_extension_ids + description: FarmBeatsExtension ids. + defaultValue: None + types: + - [] + - name: farm_beats_extension_names + description: FarmBeats extension names. + defaultValue: None + types: + - [] + - name: extension_categories + description: Extension categories. + defaultValue: None + types: + - [] + - name: publisher_ids + description: Publisher ids. + defaultValue: None + types: + - [] + - name: max_page_size + description: 'Maximum number of items needed (inclusive). + + Minimum = 10, Maximum = 1000, Default value = 50.' + defaultValue: '50' + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either FarmBeatsExtensionListResponse + or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.agfood.operations.FarmBeatsExtensionsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.FarmBeatsModelsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.FarmBeatsModelsOperations.yml new file mode 100644 index 00000000..f3014808 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.FarmBeatsModelsOperations.yml @@ -0,0 +1,218 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.operations.FarmBeatsModelsOperations +name: FarmBeatsModelsOperations +fullName: azure.mgmt.agfood.operations.FarmBeatsModelsOperations +module: azure.mgmt.agfood.operations +summary: 'FarmBeatsModelsOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: FarmBeatsModelsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.agfood.operations.FarmBeatsModelsOperations.create_or_update + name: create_or_update + summary: Create or update FarmBeats resource. + signature: 'create_or_update(farm_beats_resource_name: str, resource_group_name: + str, body: ''_models.FarmBeats'', **kwargs: Any) -> _models.FarmBeats' + parameters: + - name: farm_beats_resource_name + description: FarmBeats resource name. + isRequired: true + types: + - + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: body + description: FarmBeats resource create or update request object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: FarmBeats, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.agfood.operations.FarmBeatsModelsOperations.delete + name: delete + summary: Delete a FarmBeats resource. + signature: 'delete(resource_group_name: str, farm_beats_resource_name: str, **kwargs: + Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: farm_beats_resource_name + description: FarmBeats resource name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.agfood.operations.FarmBeatsModelsOperations.get + name: get + summary: Get FarmBeats resource. + signature: 'get(resource_group_name: str, farm_beats_resource_name: str, **kwargs: + Any) -> _models.FarmBeats' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: farm_beats_resource_name + description: FarmBeats resource name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: FarmBeats, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.agfood.operations.FarmBeatsModelsOperations.list_by_resource_group + name: list_by_resource_group + summary: Lists the FarmBeats instances for a resource group. + signature: 'list_by_resource_group(resource_group_name: str, max_page_size: int + | None = 50, skip_token: str | None = None, **kwargs: Any) -> Iterable[''_models.FarmBeatsListResponse'']' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: max_page_size + description: 'Maximum number of items needed (inclusive). + + Minimum = 10, Maximum = 1000, Default value = 50.' + defaultValue: '50' + types: + - + - name: skip_token + description: Continuation token for getting next set of results. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either FarmBeatsListResponse or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.agfood.operations.FarmBeatsModelsOperations.list_by_subscription + name: list_by_subscription + summary: Lists the FarmBeats instances for a subscription. + signature: 'list_by_subscription(max_page_size: int | None = 50, skip_token: str + | None = None, **kwargs: Any) -> Iterable[''_models.FarmBeatsListResponse'']' + parameters: + - name: max_page_size + description: 'Maximum number of items needed (inclusive). + + Minimum = 10, Maximum = 1000, Default value = 50.' + defaultValue: '50' + types: + - + - name: skip_token + description: Skip token for getting next set of results. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either FarmBeatsListResponse or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.agfood.operations.FarmBeatsModelsOperations.update + name: update + summary: Update a FarmBeats resource. + signature: 'update(farm_beats_resource_name: str, resource_group_name: str, body: + ''_models.FarmBeatsUpdateRequestModel'', **kwargs: Any) -> _models.FarmBeats' + parameters: + - name: farm_beats_resource_name + description: FarmBeats resource name. + isRequired: true + types: + - + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: body + description: Request object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: FarmBeats, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.agfood.operations.FarmBeatsModelsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.LocationsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.LocationsOperations.yml new file mode 100644 index 00000000..b294c57f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.LocationsOperations.yml @@ -0,0 +1,57 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.operations.LocationsOperations +name: LocationsOperations +fullName: azure.mgmt.agfood.operations.LocationsOperations +module: azure.mgmt.agfood.operations +summary: 'LocationsOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: LocationsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.agfood.operations.LocationsOperations.check_name_availability + name: check_name_availability + summary: Checks the name availability of the resource with requested resource name. + signature: 'check_name_availability(body: ''_models.CheckNameAvailabilityRequest'', + **kwargs: Any) -> _models.CheckNameAvailabilityResponse' + parameters: + - name: body + description: NameAvailabilityRequest object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: CheckNameAvailabilityResponse, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.agfood.operations.LocationsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.Operations.yml new file mode 100644 index 00000000..e5e332ed --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.Operations.yml @@ -0,0 +1,51 @@ +### YamlMime:PythonClass +uid: azure.mgmt.agfood.operations.Operations +name: Operations +fullName: azure.mgmt.agfood.operations.Operations +module: azure.mgmt.agfood.operations +summary: 'Operations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: Operations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.agfood.operations.Operations.list + name: list + summary: Lists the available operations of Microsoft.AgFoodPlatform resource provider. + signature: 'list(**kwargs: Any) -> Iterable[''_models.OperationListResult'']' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either OperationListResult or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.agfood.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.yml new file mode 100644 index 00000000..4a51665c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.operations.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.agfood.operations +name: operations +fullName: azure.mgmt.agfood.operations +type: import +classes: +- azure.mgmt.agfood.operations.ExtensionsOperations +- azure.mgmt.agfood.operations.FarmBeatsExtensionsOperations +- azure.mgmt.agfood.operations.FarmBeatsModelsOperations +- azure.mgmt.agfood.operations.LocationsOperations +- azure.mgmt.agfood.operations.Operations diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.yml new file mode 100644 index 00000000..5959233e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.agfood +name: agfood +fullName: azure.mgmt.agfood +type: rootImport +classes: +- azure.mgmt.agfood.AzureAgFoodPlatformRPService +packages: +- azure.mgmt.agfood.aio +- azure.mgmt.agfood.models +- azure.mgmt.agfood.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.ContainerAppsAPIClient.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.ContainerAppsAPIClient.yml new file mode 100644 index 00000000..8db89bdb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.ContainerAppsAPIClient.yml @@ -0,0 +1,77 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.ContainerAppsAPIClient +name: ContainerAppsAPIClient +fullName: azure.mgmt.app.ContainerAppsAPIClient +module: azure.mgmt.app +summary: ContainerAppsAPIClient. +constructor: + syntax: 'ContainerAppsAPIClient(credential: TokenCredential, subscription_id: str, + base_url: str = ''https://management.azure.com'', **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: subscription_id + description: The ID of the target subscription. + isRequired: true + types: + - + - name: base_url + description: Service URL. Default value is '`https://management.azure.com`'. + defaultValue: https://management.azure.com + types: + - + keywordOnlyParameters: + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - +variables: +- description: ContainerAppsOperations operations + name: container_apps + types: + - +- description: ContainerAppsRevisionsOperations operations + name: container_apps_revisions + types: + - +- description: ContainerAppsRevisionReplicasOperations operations + name: container_apps_revision_replicas + types: + - +- description: ManagedEnvironmentsOperations operations + name: managed_environments + types: + - +- description: CertificatesOperations operations + name: certificates + types: + - +- description: Operations operations + name: operations + types: + - +- description: ContainerAppsSourceControlsOperations operations + name: container_apps_source_controls + types: + - +- description: DaprComponentsOperations operations + name: dapr_components + types: + - +- description: ContainerAppsAuthConfigsOperations operations + name: container_apps_auth_configs + types: + - +- description: ManagedEnvironmentsStoragesOperations operations + name: managed_environments_storages + types: + - +methods: +- uid: azure.mgmt.app.ContainerAppsAPIClient.close + name: close + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.ContainerAppsAPIClient.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.ContainerAppsAPIClient.yml new file mode 100644 index 00000000..220c9348 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.ContainerAppsAPIClient.yml @@ -0,0 +1,77 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.aio.ContainerAppsAPIClient +name: ContainerAppsAPIClient +fullName: azure.mgmt.app.aio.ContainerAppsAPIClient +module: azure.mgmt.app.aio +summary: ContainerAppsAPIClient. +constructor: + syntax: 'ContainerAppsAPIClient(credential: AsyncTokenCredential, subscription_id: + str, base_url: str = ''https://management.azure.com'', **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: subscription_id + description: The ID of the target subscription. + isRequired: true + types: + - + - name: base_url + description: Service URL. Default value is '`https://management.azure.com`'. + defaultValue: https://management.azure.com + types: + - + keywordOnlyParameters: + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - +variables: +- description: ContainerAppsOperations operations + name: container_apps + types: + - +- description: ContainerAppsRevisionsOperations operations + name: container_apps_revisions + types: + - +- description: ContainerAppsRevisionReplicasOperations operations + name: container_apps_revision_replicas + types: + - +- description: ManagedEnvironmentsOperations operations + name: managed_environments + types: + - +- description: CertificatesOperations operations + name: certificates + types: + - +- description: Operations operations + name: operations + types: + - +- description: ContainerAppsSourceControlsOperations operations + name: container_apps_source_controls + types: + - +- description: DaprComponentsOperations operations + name: dapr_components + types: + - +- description: ContainerAppsAuthConfigsOperations operations + name: container_apps_auth_configs + types: + - +- description: ManagedEnvironmentsStoragesOperations operations + name: managed_environments_storages + types: + - +methods: +- uid: azure.mgmt.app.aio.ContainerAppsAPIClient.close + name: close + signature: async close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.CertificatesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.CertificatesOperations.yml new file mode 100644 index 00000000..7057354b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.CertificatesOperations.yml @@ -0,0 +1,219 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.aio.operations.CertificatesOperations +name: CertificatesOperations +fullName: azure.mgmt.app.aio.operations.CertificatesOperations +module: azure.mgmt.app.aio.operations +summary: 'CertificatesOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: CertificatesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.app.aio.operations.CertificatesOperations.create_or_update + name: create_or_update + summary: 'Create or Update a Certificate. + + + Create or Update a Certificate.' + signature: 'async create_or_update(resource_group_name: str, managed_environment_name: + str, name: str, certificate_envelope: Certificate | None = None, **kwargs: Any) + -> Certificate' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: managed_environment_name + description: Name of the Managed Environment. + isRequired: true + types: + - + - name: name + description: Name of the Certificate. + isRequired: true + types: + - + - name: certificate_envelope + description: Certificate to be created or updated. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Certificate, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.CertificatesOperations.delete + name: delete + summary: 'Deletes the specified Certificate. + + + Deletes the specified Certificate.' + signature: 'async delete(resource_group_name: str, managed_environment_name: str, + name: str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: managed_environment_name + description: Name of the Managed Environment. + isRequired: true + types: + - + - name: name + description: Name of the Certificate. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.CertificatesOperations.get + name: get + summary: 'Get the specified Certificate. + + + Get the specified Certificate.' + signature: 'async get(resource_group_name: str, managed_environment_name: str, name: + str, **kwargs: Any) -> Certificate' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: managed_environment_name + description: Name of the Managed Environment. + isRequired: true + types: + - + - name: name + description: Name of the Certificate. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Certificate, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.CertificatesOperations.list + name: list + summary: 'Get the Certificates in a given managed environment. + + + Get the Certificates in a given managed environment.' + signature: 'list(resource_group_name: str, managed_environment_name: str, **kwargs: + Any) -> AsyncIterable[CertificateCollection]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: managed_environment_name + description: Name of the Managed Environment. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either CertificateCollection or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.CertificatesOperations.update + name: update + summary: 'Update properties of a certificate. + + + Patches a certificate. Currently only patching of tags is supported.' + signature: 'async update(resource_group_name: str, managed_environment_name: str, + name: str, certificate_envelope: CertificatePatch, **kwargs: Any) -> Certificate' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: managed_environment_name + description: Name of the Managed Environment. + isRequired: true + types: + - + - name: name + description: Name of the Certificate. + isRequired: true + types: + - + - name: certificate_envelope + description: Properties of a certificate that need to be updated. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Certificate, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.app.aio.operations.CertificatesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsAuthConfigsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsAuthConfigsOperations.yml new file mode 100644 index 00000000..3528fbac --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsAuthConfigsOperations.yml @@ -0,0 +1,178 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.aio.operations.ContainerAppsAuthConfigsOperations +name: ContainerAppsAuthConfigsOperations +fullName: azure.mgmt.app.aio.operations.ContainerAppsAuthConfigsOperations +module: azure.mgmt.app.aio.operations +summary: 'ContainerAppsAuthConfigsOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: ContainerAppsAuthConfigsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.app.aio.operations.ContainerAppsAuthConfigsOperations.create_or_update + name: create_or_update + summary: 'Create or update the AuthConfig for a Container App. + + + Description for Create or update the AuthConfig for a Container App.' + signature: 'async create_or_update(resource_group_name: str, container_app_name: + str, name: str, auth_config_envelope: AuthConfig, **kwargs: Any) -> AuthConfig' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: name + description: Name of the Container App AuthConfig. + isRequired: true + types: + - + - name: auth_config_envelope + description: Properties used to create a Container App AuthConfig. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AuthConfig, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ContainerAppsAuthConfigsOperations.delete + name: delete + summary: 'Delete a Container App AuthConfig. + + + Description for Delete a Container App AuthConfig.' + signature: 'async delete(resource_group_name: str, container_app_name: str, name: + str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: name + description: Name of the Container App AuthConfig. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ContainerAppsAuthConfigsOperations.get + name: get + summary: 'Get a AuthConfig of a Container App. + + + Get a AuthConfig of a Container App.' + signature: 'async get(resource_group_name: str, container_app_name: str, name: str, + **kwargs: Any) -> AuthConfig' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: name + description: Name of the Container App AuthConfig. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AuthConfig, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ContainerAppsAuthConfigsOperations.list_by_container_app + name: list_by_container_app + summary: 'Get the Container App AuthConfigs in a given resource group. + + + Get the Container App AuthConfigs in a given resource group.' + signature: 'list_by_container_app(resource_group_name: str, container_app_name: + str, **kwargs: Any) -> AsyncIterable[AuthConfigCollection]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either AuthConfigCollection or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.app.aio.operations.ContainerAppsAuthConfigsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsOperations.yml new file mode 100644 index 00000000..41b0df47 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsOperations.yml @@ -0,0 +1,323 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.aio.operations.ContainerAppsOperations +name: ContainerAppsOperations +fullName: azure.mgmt.app.aio.operations.ContainerAppsOperations +module: azure.mgmt.app.aio.operations +summary: 'ContainerAppsOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: ContainerAppsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.app.aio.operations.ContainerAppsOperations.begin_create_or_update + name: begin_create_or_update + summary: 'Create or update a Container App. + + + Description for Create or update a Container App.' + signature: 'async begin_create_or_update(resource_group_name: str, name: str, container_app_envelope: + ContainerApp, **kwargs: Any) -> AsyncLROPoller[ContainerApp]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: name + description: Name of the Container App. + isRequired: true + types: + - + - name: container_app_envelope + description: Properties used to create a container app. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of AsyncLROPoller that returns either ContainerApp or + the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ContainerAppsOperations.begin_delete + name: begin_delete + summary: 'Delete a Container App. + + + Description for Delete a Container App.' + signature: 'async begin_delete(resource_group_name: str, name: str, **kwargs: Any) + -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: name + description: Name of the Container App. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ContainerAppsOperations.get + name: get + summary: 'Get the properties of a Container App. + + + Get the properties of a Container App.' + signature: 'async get(resource_group_name: str, name: str, **kwargs: Any) -> ContainerApp' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: name + description: Name of the Container App. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ContainerApp, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ContainerAppsOperations.list_by_resource_group + name: list_by_resource_group + summary: 'Get the Container Apps in a given resource group. + + + Get the Container Apps in a given resource group.' + signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[ContainerAppCollection]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either ContainerAppCollection or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ContainerAppsOperations.list_by_subscription + name: list_by_subscription + summary: 'Get the Container Apps in a given subscription. + + + Get the Container Apps in a given subscription.' + signature: 'list_by_subscription(**kwargs: Any) -> AsyncIterable[ContainerAppCollection]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either ContainerAppCollection or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ContainerAppsOperations.list_custom_host_name_analysis + name: list_custom_host_name_analysis + summary: 'Analyzes a custom hostname for a Container App. + + + Analyzes a custom hostname for a Container App.' + signature: 'async list_custom_host_name_analysis(resource_group_name: str, container_app_name: + str, custom_hostname: str | None = None, **kwargs: Any) -> CustomHostnameAnalysisResult' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: custom_hostname + description: Custom hostname. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: CustomHostnameAnalysisResult, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ContainerAppsOperations.list_secrets + name: list_secrets + summary: 'List secrets for a container app. + + + List secrets for a container app.' + signature: 'async list_secrets(resource_group_name: str, name: str, **kwargs: Any) + -> SecretsCollection' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: name + description: Name of the Container App. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SecretsCollection, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ContainerAppsOperations.update + name: update + summary: 'Update properties of a Container App. + + + Patches a Container App. Currently only patching of tags is supported.' + signature: 'async update(resource_group_name: str, name: str, container_app_envelope: + ContainerAppPatch, **kwargs: Any) -> ContainerApp' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: name + description: Name of the Container App. + isRequired: true + types: + - + - name: container_app_envelope + description: Properties of a container app that need to be updated. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ContainerApp, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.app.aio.operations.ContainerAppsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsRevisionReplicasOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsRevisionReplicasOperations.yml new file mode 100644 index 00000000..9314eb87 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsRevisionReplicasOperations.yml @@ -0,0 +1,110 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.aio.operations.ContainerAppsRevisionReplicasOperations +name: ContainerAppsRevisionReplicasOperations +fullName: azure.mgmt.app.aio.operations.ContainerAppsRevisionReplicasOperations +module: azure.mgmt.app.aio.operations +summary: 'ContainerAppsRevisionReplicasOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: ContainerAppsRevisionReplicasOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.app.aio.operations.ContainerAppsRevisionReplicasOperations.get_replica + name: get_replica + summary: 'Get a replica for a Container App Revision. + + + Get a replica for a Container App Revision.' + signature: 'async get_replica(resource_group_name: str, container_app_name: str, + revision_name: str, name: str, **kwargs: Any) -> Replica' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: revision_name + description: Name of the Container App Revision. + isRequired: true + types: + - + - name: name + description: Name of the Container App Revision Replica. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Replica, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ContainerAppsRevisionReplicasOperations.list_replicas + name: list_replicas + summary: 'List replicas for a Container App Revision. + + + List replicas for a Container App Revision.' + signature: 'async list_replicas(resource_group_name: str, container_app_name: str, + revision_name: str, **kwargs: Any) -> ReplicaCollection' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: revision_name + description: Name of the Container App Revision. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ReplicaCollection, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.app.aio.operations.ContainerAppsRevisionReplicasOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsRevisionsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsRevisionsOperations.yml new file mode 100644 index 00000000..0f2cac08 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsRevisionsOperations.yml @@ -0,0 +1,206 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.aio.operations.ContainerAppsRevisionsOperations +name: ContainerAppsRevisionsOperations +fullName: azure.mgmt.app.aio.operations.ContainerAppsRevisionsOperations +module: azure.mgmt.app.aio.operations +summary: 'ContainerAppsRevisionsOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: ContainerAppsRevisionsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.app.aio.operations.ContainerAppsRevisionsOperations.activate_revision + name: activate_revision + summary: 'Activates a revision for a Container App. + + + Activates a revision for a Container App.' + signature: 'async activate_revision(resource_group_name: str, container_app_name: + str, name: str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: name + description: Name of the Container App Revision. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ContainerAppsRevisionsOperations.deactivate_revision + name: deactivate_revision + summary: 'Deactivates a revision for a Container App. + + + Deactivates a revision for a Container App.' + signature: 'async deactivate_revision(resource_group_name: str, container_app_name: + str, name: str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: name + description: Name of the Container App Revision. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ContainerAppsRevisionsOperations.get_revision + name: get_revision + summary: 'Get a revision of a Container App. + + + Get a revision of a Container App.' + signature: 'async get_revision(resource_group_name: str, container_app_name: str, + name: str, **kwargs: Any) -> Revision' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: name + description: Name of the Container App Revision. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Revision, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ContainerAppsRevisionsOperations.list_revisions + name: list_revisions + summary: 'Get the Revisions for a given Container App. + + + Get the Revisions for a given Container App.' + signature: 'list_revisions(resource_group_name: str, container_app_name: str, **kwargs: + Any) -> AsyncIterable[RevisionCollection]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App for which Revisions are needed. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either RevisionCollection or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ContainerAppsRevisionsOperations.restart_revision + name: restart_revision + summary: 'Restarts a revision for a Container App. + + + Restarts a revision for a Container App.' + signature: 'async restart_revision(resource_group_name: str, container_app_name: + str, name: str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: name + description: Name of the Container App Revision. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.app.aio.operations.ContainerAppsRevisionsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsSourceControlsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsSourceControlsOperations.yml new file mode 100644 index 00000000..db86d27f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsSourceControlsOperations.yml @@ -0,0 +1,224 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.aio.operations.ContainerAppsSourceControlsOperations +name: ContainerAppsSourceControlsOperations +fullName: azure.mgmt.app.aio.operations.ContainerAppsSourceControlsOperations +module: azure.mgmt.app.aio.operations +summary: 'ContainerAppsSourceControlsOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: ContainerAppsSourceControlsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.app.aio.operations.ContainerAppsSourceControlsOperations.begin_create_or_update + name: begin_create_or_update + summary: 'Create or update the SourceControl for a Container App. + + + Description for Create or update the SourceControl for a Container App.' + signature: 'async begin_create_or_update(resource_group_name: str, container_app_name: + str, name: str, source_control_envelope: SourceControl, **kwargs: Any) -> AsyncLROPoller[SourceControl]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: name + description: Name of the Container App SourceControl. + isRequired: true + types: + - + - name: source_control_envelope + description: Properties used to create a Container App SourceControl. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of AsyncLROPoller that returns either SourceControl + or the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ContainerAppsSourceControlsOperations.begin_delete + name: begin_delete + summary: 'Delete a Container App SourceControl. + + + Description for Delete a Container App SourceControl.' + signature: 'async begin_delete(resource_group_name: str, container_app_name: str, + name: str, **kwargs: Any) -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: name + description: Name of the Container App SourceControl. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ContainerAppsSourceControlsOperations.get + name: get + summary: 'Get a SourceControl of a Container App. + + + Get a SourceControl of a Container App.' + signature: 'async get(resource_group_name: str, container_app_name: str, name: str, + **kwargs: Any) -> SourceControl' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: name + description: Name of the Container App SourceControl. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SourceControl, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ContainerAppsSourceControlsOperations.list_by_container_app + name: list_by_container_app + summary: 'Get the Container App SourceControls in a given resource group. + + + Get the Container App SourceControls in a given resource group.' + signature: 'list_by_container_app(resource_group_name: str, container_app_name: + str, **kwargs: Any) -> AsyncIterable[SourceControlCollection]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either SourceControlCollection or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.app.aio.operations.ContainerAppsSourceControlsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.DaprComponentsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.DaprComponentsOperations.yml new file mode 100644 index 00000000..d3e93a4d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.DaprComponentsOperations.yml @@ -0,0 +1,178 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.aio.operations.DaprComponentsOperations +name: DaprComponentsOperations +fullName: azure.mgmt.app.aio.operations.DaprComponentsOperations +module: azure.mgmt.app.aio.operations +summary: 'DaprComponentsOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: DaprComponentsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.app.aio.operations.DaprComponentsOperations.create_or_update + name: create_or_update + summary: 'Creates or updates a Dapr Component. + + + Creates or updates a Dapr Component in a Managed Environment.' + signature: 'async create_or_update(resource_group_name: str, environment_name: str, + name: str, dapr_component_envelope: DaprComponent, **kwargs: Any) -> DaprComponent' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: environment_name + description: Name of the Managed Environment. + isRequired: true + types: + - + - name: name + description: Name of the Dapr Component. + isRequired: true + types: + - + - name: dapr_component_envelope + description: Configuration details of the Dapr Component. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DaprComponent, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.DaprComponentsOperations.delete + name: delete + summary: 'Delete a Dapr Component. + + + Delete a Dapr Component from a Managed Environment.' + signature: 'async delete(resource_group_name: str, environment_name: str, name: + str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: environment_name + description: Name of the Managed Environment. + isRequired: true + types: + - + - name: name + description: Name of the Dapr Component. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.DaprComponentsOperations.get + name: get + summary: 'Get a dapr component. + + + Get a dapr component.' + signature: 'async get(resource_group_name: str, environment_name: str, name: str, + **kwargs: Any) -> DaprComponent' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: environment_name + description: Name of the Managed Environment. + isRequired: true + types: + - + - name: name + description: Name of the Dapr Component. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DaprComponent, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.DaprComponentsOperations.list + name: list + summary: 'Get the Dapr Components for a managed environment. + + + Get the Dapr Components for a managed environment.' + signature: 'list(resource_group_name: str, environment_name: str, **kwargs: Any) + -> AsyncIterable[DaprComponentsCollection]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: environment_name + description: Name of the Managed Environment. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either DaprComponentsCollection or + the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.app.aio.operations.DaprComponentsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ManagedEnvironmentsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ManagedEnvironmentsOperations.yml new file mode 100644 index 00000000..f8a3756b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ManagedEnvironmentsOperations.yml @@ -0,0 +1,258 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.aio.operations.ManagedEnvironmentsOperations +name: ManagedEnvironmentsOperations +fullName: azure.mgmt.app.aio.operations.ManagedEnvironmentsOperations +module: azure.mgmt.app.aio.operations +summary: 'ManagedEnvironmentsOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: ManagedEnvironmentsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.app.aio.operations.ManagedEnvironmentsOperations.begin_create_or_update + name: begin_create_or_update + summary: 'Creates or updates a Managed Environment. + + + Creates or updates a Managed Environment used to host container apps.' + signature: 'async begin_create_or_update(resource_group_name: str, name: str, environment_envelope: + ManagedEnvironment, **kwargs: Any) -> AsyncLROPoller[ManagedEnvironment]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: name + description: Name of the Environment. + isRequired: true + types: + - + - name: environment_envelope + description: Configuration details of the Environment. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of AsyncLROPoller that returns either ManagedEnvironment + or the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ManagedEnvironmentsOperations.begin_delete + name: begin_delete + summary: 'Delete a Managed Environment. + + + Delete a Managed Environment if it does not have any container apps.' + signature: 'async begin_delete(resource_group_name: str, name: str, **kwargs: Any) + -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: name + description: Name of the Environment. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ManagedEnvironmentsOperations.get + name: get + summary: 'Get the properties of a Managed Environment. + + + Get the properties of a Managed Environment used to host container apps.' + signature: 'async get(resource_group_name: str, name: str, **kwargs: Any) -> ManagedEnvironment' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: name + description: Name of the Environment. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ManagedEnvironment, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ManagedEnvironmentsOperations.list_by_resource_group + name: list_by_resource_group + summary: 'Get all the Environments in a resource group. + + + Get all the Managed Environments in a resource group.' + signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[ManagedEnvironmentsCollection]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either ManagedEnvironmentsCollection + or the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ManagedEnvironmentsOperations.list_by_subscription + name: list_by_subscription + summary: 'Get all Environments for a subscription. + + + Get all Managed Environments for a subscription.' + signature: 'list_by_subscription(**kwargs: Any) -> AsyncIterable[ManagedEnvironmentsCollection]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either ManagedEnvironmentsCollection + or the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ManagedEnvironmentsOperations.update + name: update + summary: 'Update Managed Environment''s properties. + + + Patches a Managed Environment. Only patching of tags is supported currently.' + signature: 'async update(resource_group_name: str, name: str, environment_envelope: + ManagedEnvironmentPatch, **kwargs: Any) -> ManagedEnvironment' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: name + description: Name of the Environment. + isRequired: true + types: + - + - name: environment_envelope + description: Configuration details of the Environment. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ManagedEnvironment, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.app.aio.operations.ManagedEnvironmentsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ManagedEnvironmentsStoragesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ManagedEnvironmentsStoragesOperations.yml new file mode 100644 index 00000000..edc40a0b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ManagedEnvironmentsStoragesOperations.yml @@ -0,0 +1,175 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.aio.operations.ManagedEnvironmentsStoragesOperations +name: ManagedEnvironmentsStoragesOperations +fullName: azure.mgmt.app.aio.operations.ManagedEnvironmentsStoragesOperations +module: azure.mgmt.app.aio.operations +summary: 'ManagedEnvironmentsStoragesOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: ManagedEnvironmentsStoragesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.app.aio.operations.ManagedEnvironmentsStoragesOperations.create_or_update + name: create_or_update + summary: 'Create or update storage for a managedEnvironment. + + + Create or update storage for a managedEnvironment.' + signature: 'async create_or_update(resource_group_name: str, env_name: str, name: + str, storage_envelope: ManagedEnvironmentStorage, **kwargs: Any) -> ManagedEnvironmentStorage' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: env_name + description: Name of the Environment. + isRequired: true + types: + - + - name: name + description: Name of the storage. + isRequired: true + types: + - + - name: storage_envelope + description: Configuration details of storage. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ManagedEnvironmentStorage, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ManagedEnvironmentsStoragesOperations.delete + name: delete + summary: 'Delete storage for a managedEnvironment. + + + Delete storage for a managedEnvironment.' + signature: 'async delete(resource_group_name: str, env_name: str, name: str, **kwargs: + Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: env_name + description: Name of the Environment. + isRequired: true + types: + - + - name: name + description: Name of the storage. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ManagedEnvironmentsStoragesOperations.get + name: get + summary: 'Get storage for a managedEnvironment. + + + Get storage for a managedEnvironment.' + signature: 'async get(resource_group_name: str, env_name: str, name: str, **kwargs: + Any) -> ManagedEnvironmentStorage' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: env_name + description: Name of the Environment. + isRequired: true + types: + - + - name: name + description: Name of the storage. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ManagedEnvironmentStorage, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.aio.operations.ManagedEnvironmentsStoragesOperations.list + name: list + summary: 'Get all storages for a managedEnvironment. + + + Get all storages for a managedEnvironment.' + signature: 'async list(resource_group_name: str, env_name: str, **kwargs: Any) -> + ManagedEnvironmentStoragesCollection' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: env_name + description: Name of the Environment. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ManagedEnvironmentStoragesCollection, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.app.aio.operations.ManagedEnvironmentsStoragesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.Operations.yml new file mode 100644 index 00000000..74f64aeb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.Operations.yml @@ -0,0 +1,51 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.aio.operations.Operations +name: Operations +fullName: azure.mgmt.app.aio.operations.Operations +module: azure.mgmt.app.aio.operations +summary: 'Operations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: Operations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.app.aio.operations.Operations.list + name: list + summary: Lists all of the available RP operations. + signature: 'list(**kwargs: Any) -> AsyncIterable[AvailableOperations]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either AvailableOperations or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.app.aio.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.yml new file mode 100644 index 00000000..ccda601a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.app.aio.operations +name: operations +fullName: azure.mgmt.app.aio.operations +type: import +classes: +- azure.mgmt.app.aio.operations.CertificatesOperations +- azure.mgmt.app.aio.operations.ContainerAppsAuthConfigsOperations +- azure.mgmt.app.aio.operations.ContainerAppsOperations +- azure.mgmt.app.aio.operations.ContainerAppsRevisionReplicasOperations +- azure.mgmt.app.aio.operations.ContainerAppsRevisionsOperations +- azure.mgmt.app.aio.operations.ContainerAppsSourceControlsOperations +- azure.mgmt.app.aio.operations.DaprComponentsOperations +- azure.mgmt.app.aio.operations.ManagedEnvironmentsOperations +- azure.mgmt.app.aio.operations.ManagedEnvironmentsStoragesOperations +- azure.mgmt.app.aio.operations.Operations diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.yml new file mode 100644 index 00000000..eb1cc9c2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.app.aio +name: aio +fullName: azure.mgmt.app.aio +type: import +classes: +- azure.mgmt.app.aio.ContainerAppsAPIClient +packages: +- azure.mgmt.app.aio.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AccessMode.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AccessMode.yml new file mode 100644 index 00000000..d46f7c45 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AccessMode.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.app.models.AccessMode +name: AccessMode +fullName: azure.mgmt.app.models.AccessMode +summary: Access mode for storage +module: azure.mgmt.app.models +fields: +- name: READ_ONLY + uid: azure.mgmt.app.models.AccessMode.READ_ONLY +- name: READ_WRITE + uid: azure.mgmt.app.models.AccessMode.READ_WRITE diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ActiveRevisionsMode.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ActiveRevisionsMode.yml new file mode 100644 index 00000000..6eec1e59 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ActiveRevisionsMode.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.app.models.ActiveRevisionsMode +name: ActiveRevisionsMode +fullName: azure.mgmt.app.models.ActiveRevisionsMode +summary: 'ActiveRevisionsMode controls how active revisions are handled for the Container + app: + + + defaultSingle: Only one revision can be active at a time. Revision + weights can not + + be used in this mode' +module: azure.mgmt.app.models +fields: +- name: MULTIPLE + uid: azure.mgmt.app.models.ActiveRevisionsMode.MULTIPLE +- name: SINGLE + uid: azure.mgmt.app.models.ActiveRevisionsMode.SINGLE diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AllowedAudiencesValidation.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AllowedAudiencesValidation.yml new file mode 100644 index 00000000..bb04db0e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AllowedAudiencesValidation.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.AllowedAudiencesValidation +name: AllowedAudiencesValidation +fullName: azure.mgmt.app.models.AllowedAudiencesValidation +module: azure.mgmt.app.models +summary: The configuration settings of the Allowed Audiences validation flow. +constructor: + syntax: 'AllowedAudiencesValidation(*, allowed_audiences: List[str] | None = None, + **kwargs)' + keywordOnlyParameters: + - name: allowed_audiences + description: 'The configuration settings of the allowed list of audiences from + + which to validate the JWT token.' + types: + - [] +variables: +- description: 'The configuration settings of the allowed list of audiences from which + + to validate the JWT token.' + name: allowed_audiences + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AllowedPrincipals.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AllowedPrincipals.yml new file mode 100644 index 00000000..54f25775 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AllowedPrincipals.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.AllowedPrincipals +name: AllowedPrincipals +fullName: azure.mgmt.app.models.AllowedPrincipals +module: azure.mgmt.app.models +summary: The configuration settings of the Azure Active Directory allowed principals. +constructor: + syntax: 'AllowedPrincipals(*, groups: List[str] | None = None, identities: List[str] + | None = None, **kwargs)' + keywordOnlyParameters: + - name: groups + description: The list of the allowed groups. + types: + - [] + - name: identities + description: The list of the allowed identities. + types: + - [] +variables: +- description: The list of the allowed groups. + name: groups + types: + - [] +- description: The list of the allowed identities. + name: identities + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppLogsConfiguration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppLogsConfiguration.yml new file mode 100644 index 00000000..b8210a88 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppLogsConfiguration.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.AppLogsConfiguration +name: AppLogsConfiguration +fullName: azure.mgmt.app.models.AppLogsConfiguration +module: azure.mgmt.app.models +summary: Configuration of application logs. +constructor: + syntax: 'AppLogsConfiguration(*, destination: str | None = None, log_analytics_configuration: + LogAnalyticsConfiguration | None = None, **kwargs)' + keywordOnlyParameters: + - name: destination + description: Logs destination. + types: + - + - name: log_analytics_configuration + description: Log Analytics configuration. + types: + - +variables: +- description: Logs destination. + name: destination + types: + - +- description: Log Analytics configuration. + name: log_analytics_configuration + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppProtocol.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppProtocol.yml new file mode 100644 index 00000000..0579aa93 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppProtocol.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.app.models.AppProtocol +name: AppProtocol +fullName: azure.mgmt.app.models.AppProtocol +summary: 'Tells Dapr which protocol your application is using. Valid options are http + and grpc. Default + + is http' +module: azure.mgmt.app.models +fields: +- name: GRPC + uid: azure.mgmt.app.models.AppProtocol.GRPC +- name: HTTP + uid: azure.mgmt.app.models.AppProtocol.HTTP diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppRegistration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppRegistration.yml new file mode 100644 index 00000000..524b6407 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppRegistration.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.AppRegistration +name: AppRegistration +fullName: azure.mgmt.app.models.AppRegistration +module: azure.mgmt.app.models +summary: The configuration settings of the app registration for providers that have + app ids and app secrets. +constructor: + syntax: 'AppRegistration(*, app_id: str | None = None, app_secret_setting_name: + str | None = None, **kwargs)' + keywordOnlyParameters: + - name: app_id + description: The App ID of the app used for login. + types: + - + - name: app_secret_setting_name + description: The app setting name that contains the app secret. + types: + - +variables: +- description: The App ID of the app used for login. + name: app_id + types: + - +- description: The app setting name that contains the app secret. + name: app_secret_setting_name + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Apple.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Apple.yml new file mode 100644 index 00000000..ca7375e2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Apple.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.Apple +name: Apple +fullName: azure.mgmt.app.models.Apple +module: azure.mgmt.app.models +summary: The configuration settings of the Apple provider. +constructor: + syntax: 'Apple(*, enabled: bool | None = None, registration: AppleRegistration | + None = None, login: LoginScopes | None = None, **kwargs)' + keywordOnlyParameters: + - name: enabled + description: '`false` if the Apple provider should not be enabled + + despite the set registration; otherwise, `true`.' + types: + - + - name: registration + description: The configuration settings of the Apple registration. + types: + - + - name: login + description: The configuration settings of the login flow. + types: + - +variables: +- description: '`false` if the Apple provider should not be enabled despite + + the set registration; otherwise, `true`.' + name: enabled + types: + - +- description: The configuration settings of the Apple registration. + name: registration + types: + - +- description: The configuration settings of the login flow. + name: login + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppleRegistration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppleRegistration.yml new file mode 100644 index 00000000..513dd517 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppleRegistration.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.AppleRegistration +name: AppleRegistration +fullName: azure.mgmt.app.models.AppleRegistration +module: azure.mgmt.app.models +summary: The configuration settings of the registration for the Apple provider. +constructor: + syntax: 'AppleRegistration(*, client_id: str | None = None, client_secret_setting_name: + str | None = None, **kwargs)' + keywordOnlyParameters: + - name: client_id + description: The Client ID of the app used for login. + types: + - + - name: client_secret_setting_name + description: The app setting name that contains the client secret. + types: + - +variables: +- description: The Client ID of the app used for login. + name: client_id + types: + - +- description: The app setting name that contains the client secret. + name: client_secret_setting_name + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AuthConfig.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AuthConfig.yml new file mode 100644 index 00000000..9188ab94 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AuthConfig.yml @@ -0,0 +1,103 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.AuthConfig +name: AuthConfig +fullName: azure.mgmt.app.models.AuthConfig +module: azure.mgmt.app.models +summary: 'Configuration settings for the Azure ContainerApp Service Authentication + / Authorization feature. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'AuthConfig(*, platform: AuthPlatform | None = None, global_validation: + GlobalValidation | None = None, identity_providers: IdentityProviders | None = + None, login: Login | None = None, http_settings: HttpSettings | None = None, **kwargs)' + keywordOnlyParameters: + - name: platform + description: 'The configuration settings of the platform of ContainerApp Service + + Authentication/Authorization.' + types: + - + - name: global_validation + description: 'The configuration settings that determines the validation flow of + + users using Service Authentication/Authorization.' + types: + - + - name: identity_providers + description: 'The configuration settings of each of the identity providers used + + to configure ContainerApp Service Authentication/Authorization.' + types: + - + - name: login + description: 'The configuration settings of the login flow of users using ContainerApp + + Service Authentication/Authorization.' + types: + - + - name: http_settings + description: 'The configuration settings of the HTTP requests for authentication + and + + authorization requests made against ContainerApp Service Authentication/Authorization.' + types: + - +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: 'The configuration settings of the platform of ContainerApp Service + + Authentication/Authorization.' + name: platform + types: + - +- description: 'The configuration settings that determines the validation flow of + + users using Service Authentication/Authorization.' + name: global_validation + types: + - +- description: 'The configuration settings of each of the identity providers used + to + + configure ContainerApp Service Authentication/Authorization.' + name: identity_providers + types: + - +- description: 'The configuration settings of the login flow of users using ContainerApp + Service + + Authentication/Authorization.' + name: login + types: + - +- description: 'The configuration settings of the HTTP requests for authentication + and + + authorization requests made against ContainerApp Service Authentication/Authorization.' + name: http_settings + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AuthConfigCollection.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AuthConfigCollection.yml new file mode 100644 index 00000000..cf14e551 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AuthConfigCollection.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.AuthConfigCollection +name: AuthConfigCollection +fullName: azure.mgmt.app.models.AuthConfigCollection +module: azure.mgmt.app.models +summary: 'AuthConfig collection ARM resource. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AuthConfigCollection(*, value: List[AuthConfig], **kwargs)' + keywordOnlyParameters: + - name: value + description: Required. Collection of resources. + types: + - [] +variables: +- description: Required. Collection of resources. + name: value + types: + - [] +- description: Link to next page of resources. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AuthPlatform.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AuthPlatform.yml new file mode 100644 index 00000000..4b5e3712 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AuthPlatform.yml @@ -0,0 +1,49 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.AuthPlatform +name: AuthPlatform +fullName: azure.mgmt.app.models.AuthPlatform +module: azure.mgmt.app.models +summary: The configuration settings of the platform of ContainerApp Service Authentication/Authorization. +constructor: + syntax: 'AuthPlatform(*, enabled: bool | None = None, runtime_version: str | None + = None, **kwargs)' + keywordOnlyParameters: + - name: enabled + description: '`true` if the Authentication / Authorization feature + is + + enabled for the current app; otherwise, `false`.' + types: + - + - name: runtime_version + description: 'The RuntimeVersion of the Authentication / Authorization feature + in + + use for the current app. + + The setting in this value can control the behavior of certain features in the + Authentication / + + Authorization module.' + types: + - +variables: +- description: '`true` if the Authentication / Authorization feature + is + + enabled for the current app; otherwise, `false`.' + name: enabled + types: + - +- description: 'The RuntimeVersion of the Authentication / Authorization feature in + use + + for the current app. + + The setting in this value can control the behavior of certain features in the + Authentication / + + Authorization module.' + name: runtime_version + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AvailableOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AvailableOperations.yml new file mode 100644 index 00000000..01cc810a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AvailableOperations.yml @@ -0,0 +1,31 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.AvailableOperations +name: AvailableOperations +fullName: azure.mgmt.app.models.AvailableOperations +module: azure.mgmt.app.models +summary: Available operations of the service. +constructor: + syntax: 'AvailableOperations(*, value: List[OperationDetail] | None = None, next_link: + str | None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: Collection of available operation details. + types: + - [] + - name: next_link + description: 'URL client should use to fetch the next page (per server side paging). + + It''s null for now, added for future use.' + types: + - +variables: +- description: Collection of available operation details. + name: value + types: + - [] +- description: 'URL client should use to fetch the next page (per server side paging). + + It''s null for now, added for future use.' + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectory.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectory.yml new file mode 100644 index 00000000..afc0ab83 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectory.yml @@ -0,0 +1,82 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.AzureActiveDirectory +name: AzureActiveDirectory +fullName: azure.mgmt.app.models.AzureActiveDirectory +module: azure.mgmt.app.models +summary: The configuration settings of the Azure Active directory provider. +constructor: + syntax: 'AzureActiveDirectory(*, enabled: bool | None = None, registration: AzureActiveDirectoryRegistration + | None = None, login: AzureActiveDirectoryLogin | None = None, validation: AzureActiveDirectoryValidation + | None = None, is_auto_provisioned: bool | None = None, **kwargs)' + keywordOnlyParameters: + - name: enabled + description: '`false` if the Azure Active Directory provider should + not + + be enabled despite the set registration; otherwise, `true`.' + types: + - + - name: registration + description: 'The configuration settings of the Azure Active Directory app + + registration.' + types: + - + - name: login + description: The configuration settings of the Azure Active Directory login flow. + types: + - + - name: validation + description: 'The configuration settings of the Azure Active Directory token validation + + flow.' + types: + - + - name: is_auto_provisioned + description: 'Gets a value indicating whether the Azure AD configuration was + + auto-provisioned using 1st party tooling. + + This is an internal flag primarily intended to support the Azure Management + Portal. Users + + should not + + read or write to this property.' + types: + - +variables: +- description: '`false` if the Azure Active Directory provider should + not be + + enabled despite the set registration; otherwise, `true`.' + name: enabled + types: + - +- description: The configuration settings of the Azure Active Directory app registration. + name: registration + types: + - +- description: The configuration settings of the Azure Active Directory login flow. + name: login + types: + - +- description: 'The configuration settings of the Azure Active Directory token validation + + flow.' + name: validation + types: + - +- description: 'Gets a value indicating whether the Azure AD configuration was + + auto-provisioned using 1st party tooling. + + This is an internal flag primarily intended to support the Azure Management Portal. + Users + + should not + + read or write to this property.' + name: is_auto_provisioned + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryLogin.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryLogin.yml new file mode 100644 index 00000000..90706dea --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryLogin.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.AzureActiveDirectoryLogin +name: AzureActiveDirectoryLogin +fullName: azure.mgmt.app.models.AzureActiveDirectoryLogin +module: azure.mgmt.app.models +summary: The configuration settings of the Azure Active Directory login flow. +constructor: + syntax: 'AzureActiveDirectoryLogin(*, login_parameters: List[str] | None = None, + disable_www_authenticate: bool | None = None, **kwargs)' + keywordOnlyParameters: + - name: login_parameters + description: 'Login parameters to send to the OpenID Connect authorization + + endpoint when + + a user logs in. Each parameter must be in the form "key=value".' + types: + - [] + - name: disable_www_authenticate + description: '`true` if the www-authenticate provider + + should be omitted from the request; otherwise, `false`.' + types: + - +variables: +- description: 'Login parameters to send to the OpenID Connect authorization endpoint + + when + + a user logs in. Each parameter must be in the form "key=value".' + name: login_parameters + types: + - [] +- description: '`true` if the www-authenticate provider + + should be omitted from the request; otherwise, `false`.' + name: disable_www_authenticate + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryRegistration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryRegistration.yml new file mode 100644 index 00000000..cdea7529 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryRegistration.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.AzureActiveDirectoryRegistration +name: AzureActiveDirectoryRegistration +fullName: azure.mgmt.app.models.AzureActiveDirectoryRegistration +module: azure.mgmt.app.models +summary: The configuration settings of the Azure Active Directory app registration. +constructor: + syntax: 'AzureActiveDirectoryRegistration(*, open_id_issuer: str | None = None, + client_id: str | None = None, client_secret_setting_name: str | None = None, client_secret_certificate_thumbprint: + str | None = None, client_secret_certificate_subject_alternative_name: str | None + = None, client_secret_certificate_issuer: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: open_id_issuer + description: 'The OpenID Connect Issuer URI that represents the entity which issues + + access tokens for this application. + + When using Azure Active Directory, this value is the URI of the directory tenant, + e.g. + + [https://login.microsoftonline.com/v2.0](https://login.microsoftonline.com/v2.0)/{tenant-guid}/. + + This URI is a case-sensitive identifier for the token issuer. + + More information on OpenID Connect Discovery: + + [http://openid.net/specs/openid-connect-discovery-1_0.html](http://openid.net/specs/openid-connect-discovery-1_0.html).' + types: + - + - name: client_id + description: 'The Client ID of this relying party application, known as the client_id. + + This setting is required for enabling OpenID Connection authentication with + Azure Active + + Directory or + + other 3rd party OpenID Connect providers. + + More information on OpenID Connect: [http://openid.net/specs/openid-connect-core-1_0.html](http://openid.net/specs/openid-connect-core-1_0.html).' + types: + - + - name: client_secret_setting_name + description: 'The app setting name that contains the client secret of + + the relying party application.' + types: + - + - name: client_secret_certificate_thumbprint + description: 'An alternative to the client secret, that is the + + thumbprint of a certificate used for signing purposes. This property acts as + + a replacement for the Client Secret. It is also optional.' + types: + - + - name: client_secret_certificate_subject_alternative_name + description: 'An alternative to the client + + secret thumbprint, that is the subject alternative name of a certificate used + for signing + + purposes. This property acts as + + a replacement for the Client Secret Certificate Thumbprint. It is also optional.' + types: + - + - name: client_secret_certificate_issuer + description: 'An alternative to the client secret thumbprint, that + + is the issuer of a certificate used for signing purposes. This property acts + as + + a replacement for the Client Secret Certificate Thumbprint. It is also optional.' + types: + - +variables: +- description: 'The OpenID Connect Issuer URI that represents the entity which issues + + access tokens for this application. + + When using Azure Active Directory, this value is the URI of the directory tenant, + e.g. + + [https://login.microsoftonline.com/v2.0](https://login.microsoftonline.com/v2.0)/{tenant-guid}/. + + This URI is a case-sensitive identifier for the token issuer. + + More information on OpenID Connect Discovery: + + [http://openid.net/specs/openid-connect-discovery-1_0.html](http://openid.net/specs/openid-connect-discovery-1_0.html).' + name: open_id_issuer + types: + - +- description: 'The Client ID of this relying party application, known as the client_id. + + This setting is required for enabling OpenID Connection authentication with Azure + Active + + Directory or + + other 3rd party OpenID Connect providers. + + More information on OpenID Connect: [http://openid.net/specs/openid-connect-core-1_0.html](http://openid.net/specs/openid-connect-core-1_0.html).' + name: client_id + types: + - +- description: 'The app setting name that contains the client secret of the + + relying party application.' + name: client_secret_setting_name + types: + - +- description: 'An alternative to the client secret, that is the + + thumbprint of a certificate used for signing purposes. This property acts as + + a replacement for the Client Secret. It is also optional.' + name: client_secret_certificate_thumbprint + types: + - +- description: 'An alternative to the client secret + + thumbprint, that is the subject alternative name of a certificate used for signing + purposes. + + This property acts as + + a replacement for the Client Secret Certificate Thumbprint. It is also optional.' + name: client_secret_certificate_subject_alternative_name + types: + - +- description: 'An alternative to the client secret thumbprint, that is + + the issuer of a certificate used for signing purposes. This property acts as + + a replacement for the Client Secret Certificate Thumbprint. It is also optional.' + name: client_secret_certificate_issuer + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryValidation.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryValidation.yml new file mode 100644 index 00000000..bf1bb30e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryValidation.yml @@ -0,0 +1,49 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.AzureActiveDirectoryValidation +name: AzureActiveDirectoryValidation +fullName: azure.mgmt.app.models.AzureActiveDirectoryValidation +module: azure.mgmt.app.models +summary: The configuration settings of the Azure Active Directory token validation + flow. +constructor: + syntax: 'AzureActiveDirectoryValidation(*, jwt_claim_checks: JwtClaimChecks | None + = None, allowed_audiences: List[str] | None = None, default_authorization_policy: + DefaultAuthorizationPolicy | None = None, **kwargs)' + keywordOnlyParameters: + - name: jwt_claim_checks + description: 'The configuration settings of the checks that should be made while + + validating the JWT Claims.' + types: + - + - name: allowed_audiences + description: 'The list of audiences that can make successful + + authentication/authorization requests.' + types: + - [] + - name: default_authorization_policy + description: 'The configuration settings of the default authorization + + policy.' + types: + - +variables: +- description: 'The configuration settings of the checks that should be made while + + validating the JWT Claims.' + name: jwt_claim_checks + types: + - +- description: 'The list of audiences that can make successful + + authentication/authorization requests.' + name: allowed_audiences + types: + - [] +- description: 'The configuration settings of the default authorization + + policy.' + name: default_authorization_policy + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureCredentials.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureCredentials.yml new file mode 100644 index 00000000..a3205483 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureCredentials.yml @@ -0,0 +1,44 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.AzureCredentials +name: AzureCredentials +fullName: azure.mgmt.app.models.AzureCredentials +module: azure.mgmt.app.models +summary: Container App credentials. +constructor: + syntax: 'AzureCredentials(*, client_id: str | None = None, client_secret: str | + None = None, tenant_id: str | None = None, subscription_id: str | None = None, + **kwargs)' + keywordOnlyParameters: + - name: client_id + description: Client Id. + types: + - + - name: client_secret + description: Client Secret. + types: + - + - name: tenant_id + description: Tenant Id. + types: + - + - name: subscription_id + description: Subscription Id. + types: + - +variables: +- description: Client Id. + name: client_id + types: + - +- description: Client Secret. + name: client_secret + types: + - +- description: Tenant Id. + name: tenant_id + types: + - +- description: Subscription Id. + name: subscription_id + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureFileProperties.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureFileProperties.yml new file mode 100644 index 00000000..d69830b1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureFileProperties.yml @@ -0,0 +1,48 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.AzureFileProperties +name: AzureFileProperties +fullName: azure.mgmt.app.models.AzureFileProperties +module: azure.mgmt.app.models +summary: Azure File Properties. +constructor: + syntax: 'AzureFileProperties(*, account_name: str | None = None, account_key: str + | None = None, access_mode: str | AccessMode | None = None, share_name: str | + None = None, **kwargs)' + keywordOnlyParameters: + - name: account_name + description: Storage account name for azure file. + types: + - + - name: account_key + description: Storage account key for azure file. + types: + - + - name: access_mode + description: 'Access mode for storage. Possible values include: "ReadOnly", + + "ReadWrite".' + types: + - + - + - name: share_name + description: Azure file share name. + types: + - +variables: +- description: Storage account name for azure file. + name: account_name + types: + - +- description: Storage account key for azure file. + name: account_key + types: + - +- description: 'Access mode for storage. Possible values include: "ReadOnly", "ReadWrite".' + name: access_mode + types: + - + - +- description: Azure file share name. + name: share_name + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureStaticWebApps.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureStaticWebApps.yml new file mode 100644 index 00000000..731f2da1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureStaticWebApps.yml @@ -0,0 +1,33 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.AzureStaticWebApps +name: AzureStaticWebApps +fullName: azure.mgmt.app.models.AzureStaticWebApps +module: azure.mgmt.app.models +summary: The configuration settings of the Azure Static Web Apps provider. +constructor: + syntax: 'AzureStaticWebApps(*, enabled: bool | None = None, registration: AzureStaticWebAppsRegistration + | None = None, **kwargs)' + keywordOnlyParameters: + - name: enabled + description: '`false` if the Azure Static Web Apps provider should + not + + be enabled despite the set registration; otherwise, `true`.' + types: + - + - name: registration + description: The configuration settings of the Azure Static Web Apps registration. + types: + - +variables: +- description: '`false` if the Azure Static Web Apps provider should + not be + + enabled despite the set registration; otherwise, `true`.' + name: enabled + types: + - +- description: The configuration settings of the Azure Static Web Apps registration. + name: registration + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureStaticWebAppsRegistration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureStaticWebAppsRegistration.yml new file mode 100644 index 00000000..f7c3e701 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureStaticWebAppsRegistration.yml @@ -0,0 +1,19 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.AzureStaticWebAppsRegistration +name: AzureStaticWebAppsRegistration +fullName: azure.mgmt.app.models.AzureStaticWebAppsRegistration +module: azure.mgmt.app.models +summary: The configuration settings of the registration for the Azure Static Web Apps + provider. +constructor: + syntax: 'AzureStaticWebAppsRegistration(*, client_id: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: client_id + description: The Client ID of the app used for login. + types: + - +variables: +- description: The Client ID of the app used for login. + name: client_id + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.BindingType.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.BindingType.yml new file mode 100644 index 00000000..d4676610 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.BindingType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.app.models.BindingType +name: BindingType +fullName: azure.mgmt.app.models.BindingType +summary: Custom Domain binding type. +module: azure.mgmt.app.models +fields: +- name: DISABLED + uid: azure.mgmt.app.models.BindingType.DISABLED +- name: SNI_ENABLED + uid: azure.mgmt.app.models.BindingType.SNI_ENABLED diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Certificate.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Certificate.yml new file mode 100644 index 00000000..1aa0f746 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Certificate.yml @@ -0,0 +1,65 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.Certificate +name: Certificate +fullName: azure.mgmt.app.models.Certificate +module: azure.mgmt.app.models +summary: 'Certificate used for Custom Domain bindings of Container Apps in a Managed + Environment. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Certificate(*, location: str, tags: Dict[str, str] | None = None, properties: + CertificateProperties | None = None, **kwargs)' + keywordOnlyParameters: + - name: tags + description: A set of tags. Resource tags. + types: + - [, ] + - name: location + description: Required. The geo-location where the resource lives. + types: + - + - name: properties + description: Certificate resource specific properties. + types: + - +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: A set of tags. Resource tags. + name: tags + types: + - [, ] +- description: Required. The geo-location where the resource lives. + name: location + types: + - +- description: Certificate resource specific properties. + name: properties + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificateCollection.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificateCollection.yml new file mode 100644 index 00000000..fa1222c3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificateCollection.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.CertificateCollection +name: CertificateCollection +fullName: azure.mgmt.app.models.CertificateCollection +module: azure.mgmt.app.models +summary: 'Collection of Certificates. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CertificateCollection(*, value: List[Certificate], **kwargs)' + keywordOnlyParameters: + - name: value + description: Required. Collection of resources. + types: + - [] +variables: +- description: Required. Collection of resources. + name: value + types: + - [] +- description: Link to next page of resources. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificatePatch.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificatePatch.yml new file mode 100644 index 00000000..1727d029 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificatePatch.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.CertificatePatch +name: CertificatePatch +fullName: azure.mgmt.app.models.CertificatePatch +module: azure.mgmt.app.models +summary: A certificate to update. +constructor: + syntax: 'CertificatePatch(*, tags: Dict[str, str] | None = None, **kwargs)' + keywordOnlyParameters: + - name: tags + description: A set of tags. Application-specific metadata in the form of key-value + pairs. + types: + - [, ] +variables: +- description: A set of tags. Application-specific metadata in the form of key-value + pairs. + name: tags + types: + - [, ] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificateProperties.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificateProperties.yml new file mode 100644 index 00000000..46854f74 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificateProperties.yml @@ -0,0 +1,65 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.CertificateProperties +name: CertificateProperties +fullName: azure.mgmt.app.models.CertificateProperties +module: azure.mgmt.app.models +summary: 'Certificate resource specific properties. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'CertificateProperties(*, password: str | None = None, value: bytearray + | None = None, **kwargs)' + keywordOnlyParameters: + - name: password + description: Certificate password. + types: + - + - name: value + description: PFX or PEM blob. + types: + - +variables: +- description: 'Provisioning state of the certificate. Possible values include: + + "Succeeded", "Failed", "Canceled", "DeleteFailed", "Pending".' + name: provisioning_state + types: + - + - +- description: Certificate password. + name: password + types: + - +- description: Subject name of the certificate. + name: subject_name + types: + - +- description: PFX or PEM blob. + name: value + types: + - +- description: Certificate issuer. + name: issuer + types: + - +- description: Certificate issue Date. + name: issue_date + types: + - +- description: Certificate expiration date. + name: expiration_date + types: + - +- description: Certificate thumbprint. + name: thumbprint + types: + - +- description: Is the certificate valid?. + name: valid + types: + - +- description: Public key hash. + name: public_key_hash + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificateProvisioningState.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificateProvisioningState.yml new file mode 100644 index 00000000..ee7ece20 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificateProvisioningState.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.app.models.CertificateProvisioningState +name: CertificateProvisioningState +fullName: azure.mgmt.app.models.CertificateProvisioningState +summary: Provisioning state of the certificate. +module: azure.mgmt.app.models +fields: +- name: CANCELED + uid: azure.mgmt.app.models.CertificateProvisioningState.CANCELED +- name: DELETE_FAILED + uid: azure.mgmt.app.models.CertificateProvisioningState.DELETE_FAILED +- name: FAILED + uid: azure.mgmt.app.models.CertificateProvisioningState.FAILED +- name: PENDING + uid: azure.mgmt.app.models.CertificateProvisioningState.PENDING +- name: SUCCEEDED + uid: azure.mgmt.app.models.CertificateProvisioningState.SUCCEEDED diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ClientRegistration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ClientRegistration.yml new file mode 100644 index 00000000..8b5b3043 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ClientRegistration.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.ClientRegistration +name: ClientRegistration +fullName: azure.mgmt.app.models.ClientRegistration +module: azure.mgmt.app.models +summary: The configuration settings of the app registration for providers that have + client ids and client secrets. +constructor: + syntax: 'ClientRegistration(*, client_id: str | None = None, client_secret_setting_name: + str | None = None, **kwargs)' + keywordOnlyParameters: + - name: client_id + description: The Client ID of the app used for login. + types: + - + - name: client_secret_setting_name + description: The app setting name that contains the client secret. + types: + - +variables: +- description: The Client ID of the app used for login. + name: client_id + types: + - +- description: The app setting name that contains the client secret. + name: client_secret_setting_name + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Configuration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Configuration.yml new file mode 100644 index 00000000..f89606d5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Configuration.yml @@ -0,0 +1,78 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.Configuration +name: Configuration +fullName: azure.mgmt.app.models.Configuration +module: azure.mgmt.app.models +summary: Non versioned Container App configuration properties that define the mutable + settings of a Container app. +constructor: + syntax: 'Configuration(*, secrets: List[Secret] | None = None, active_revisions_mode: + str | ActiveRevisionsMode | None = None, ingress: Ingress | None = None, registries: + List[RegistryCredentials] | None = None, dapr: Dapr | None = None, **kwargs)' + keywordOnlyParameters: + - name: secrets + description: Collection of secrets used by a Container app. + types: + - [] + - name: active_revisions_mode + description: 'ActiveRevisionsMode controls how active revisions are handled + + for the Container app: + + + the defaultSingle: Only one revision can be active at a time. Revision + weights can + + not be used in this mode. Possible values include: "multiple", + "single".' + types: + - + - + - name: ingress + description: Ingress configurations. + types: + - + - name: registries + description: 'Collection of private container registry credentials for containers + used + + by the Container app.' + types: + - [] + - name: dapr + description: Dapr configuration for the Container App. + types: + - +variables: +- description: Collection of secrets used by a Container app. + name: secrets + types: + - [] +- description: 'ActiveRevisionsMode controls how active revisions are handled for + + the Container app: + + + the defaultSingle: Only one revision can be active at a time. Revision + weights can + + not be used in this mode. Possible values include: "multiple", "single".' + name: active_revisions_mode + types: + - + - +- description: Ingress configurations. + name: ingress + types: + - +- description: 'Collection of private container registry credentials for containers + used by + + the Container app.' + name: registries + types: + - [] +- description: Dapr configuration for the Container App. + name: dapr + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Container.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Container.yml new file mode 100644 index 00000000..e67afed0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Container.yml @@ -0,0 +1,77 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.Container +name: Container +fullName: azure.mgmt.app.models.Container +module: azure.mgmt.app.models +summary: Container App container definition. +constructor: + syntax: 'Container(*, image: str | None = None, name: str | None = None, command: + List[str] | None = None, args: List[str] | None = None, env: List[EnvironmentVar] + | None = None, resources: ContainerResources | None = None, probes: List[ContainerAppProbe] + | None = None, volume_mounts: List[VolumeMount] | None = None, **kwargs)' + keywordOnlyParameters: + - name: image + description: Container image tag. + types: + - + - name: name + description: Custom container name. + types: + - + - name: command + description: Container start command. + types: + - [] + - name: args + description: Container start command arguments. + types: + - [] + - name: env + description: Container environment variables. + types: + - [] + - name: resources + description: Container resource requirements. + types: + - + - name: probes + description: List of probes for the container. + types: + - [] + - name: volume_mounts + description: Container volume mounts. + types: + - [] +variables: +- description: Container image tag. + name: image + types: + - +- description: Custom container name. + name: name + types: + - +- description: Container start command. + name: command + types: + - [] +- description: Container start command arguments. + name: args + types: + - [] +- description: Container environment variables. + name: env + types: + - [] +- description: Container resource requirements. + name: resources + types: + - +- description: List of probes for the container. + name: probes + types: + - [] +- description: Container volume mounts. + name: volume_mounts + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerApp.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerApp.yml new file mode 100644 index 00000000..e995d25d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerApp.yml @@ -0,0 +1,121 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.ContainerApp +name: ContainerApp +fullName: azure.mgmt.app.models.ContainerApp +module: azure.mgmt.app.models +summary: 'Container App. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ContainerApp(*, location: str, tags: Dict[str, str] | None = None, identity: + ManagedServiceIdentity | None = None, managed_environment_id: str | None = None, + configuration: Configuration | None = None, template: Template | None = None, + **kwargs)' + keywordOnlyParameters: + - name: tags + description: A set of tags. Resource tags. + types: + - [, ] + - name: location + description: Required. The geo-location where the resource lives. + types: + - + - name: identity + description: 'managed identities for the Container App to interact with other + Azure + + services without maintaining any secrets or credentials in code.' + types: + - + - name: managed_environment_id + description: Resource ID of the Container App's environment. + types: + - + - name: configuration + description: Non versioned Container App configuration properties. + types: + - + - name: template + description: Container App versioned application definition. + types: + - +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: A set of tags. Resource tags. + name: tags + types: + - [, ] +- description: Required. The geo-location where the resource lives. + name: location + types: + - +- description: 'managed identities for the Container App to interact with other Azure + services + + without maintaining any secrets or credentials in code.' + name: identity + types: + - +- description: 'Provisioning state of the Container App. Possible values include: + + "InProgress", "Succeeded", "Failed", "Canceled".' + name: provisioning_state + types: + - + - +- description: Resource ID of the Container App's environment. + name: managed_environment_id + types: + - +- description: Name of the latest revision of the Container App. + name: latest_revision_name + types: + - +- description: 'Fully Qualified Domain Name of the latest revision of the Container + + App.' + name: latest_revision_fqdn + types: + - +- description: Id used to verify domain name ownership. + name: custom_domain_verification_id + types: + - +- description: Non versioned Container App configuration properties. + name: configuration + types: + - +- description: Container App versioned application definition. + name: template + types: + - +- description: Outbound IP Addresses for container app. + name: outbound_ip_addresses + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppCollection.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppCollection.yml new file mode 100644 index 00000000..4e3d3b61 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppCollection.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.ContainerAppCollection +name: ContainerAppCollection +fullName: azure.mgmt.app.models.ContainerAppCollection +module: azure.mgmt.app.models +summary: 'Container App collection ARM resource. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ContainerAppCollection(*, value: List[ContainerApp], **kwargs)' + keywordOnlyParameters: + - name: value + description: Required. Collection of resources. + types: + - [] +variables: +- description: Required. Collection of resources. + name: value + types: + - [] +- description: Link to next page of resources. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppPatch.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppPatch.yml new file mode 100644 index 00000000..32646811 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppPatch.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.ContainerAppPatch +name: ContainerAppPatch +fullName: azure.mgmt.app.models.ContainerAppPatch +module: azure.mgmt.app.models +summary: Container App Patch. +constructor: + syntax: 'ContainerAppPatch(*, tags: Dict[str, str] | None = None, **kwargs)' + keywordOnlyParameters: + - name: tags + description: A set of tags. Application-specific metadata in the form of key-value + pairs. + types: + - [, ] +variables: +- description: A set of tags. Application-specific metadata in the form of key-value + pairs. + name: tags + types: + - [, ] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbe.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbe.yml new file mode 100644 index 00000000..cb509cfb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbe.yml @@ -0,0 +1,170 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.ContainerAppProbe +name: ContainerAppProbe +fullName: azure.mgmt.app.models.ContainerAppProbe +module: azure.mgmt.app.models +summary: Probe describes a health check to be performed against a container to determine + whether it is alive or ready to receive traffic. +constructor: + syntax: 'ContainerAppProbe(*, failure_threshold: int | None = None, http_get: ContainerAppProbeHttpGet + | None = None, initial_delay_seconds: int | None = None, period_seconds: int | + None = None, success_threshold: int | None = None, tcp_socket: ContainerAppProbeTcpSocket + | None = None, termination_grace_period_seconds: int | None = None, timeout_seconds: + int | None = None, type: str | Type | None = None, **kwargs)' + keywordOnlyParameters: + - name: failure_threshold + description: 'Minimum consecutive failures for the probe to be considered failed + + after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is + 10.' + types: + - + - name: http_get + description: HTTPGet specifies the http request to perform. + types: + - + - name: initial_delay_seconds + description: 'Number of seconds after the container has started before + + liveness probes are initiated. Minimum value is 1. Maximum value is 60.' + types: + - + - name: period_seconds + description: 'How often (in seconds) to perform the probe. Default to 10 seconds. + + Minimum value is 1. Maximum value is 240.' + types: + - + - name: success_threshold + description: 'Minimum consecutive successes for the probe to be considered + + successful after having failed. Defaults to 1. Must be 1 for liveness and startup. + Minimum + + value is 1. Maximum value is 10.' + types: + - + - name: tcp_socket + description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not + yet + + supported.' + types: + - + - name: termination_grace_period_seconds + description: 'Optional duration in seconds the pod needs to + + terminate gracefully upon probe failure. The grace period is the duration in + seconds after the + + processes running in the pod are sent a termination signal and the time when + the processes are + + forcibly halted with a kill signal. Set this value longer than the expected + cleanup time for + + your process. If this value is nil, the pod''s terminationGracePeriodSeconds + will be used. + + Otherwise, this value overrides the value provided by the pod spec. Value must + be non-negative + + integer. The value zero indicates stop immediately via the kill signal (no opportunity + to shut + + down). This is an alpha field and requires enabling ProbeTerminationGracePeriod + feature gate. + + Maximum value is 3600 seconds (1 hour).' + types: + - + - name: timeout_seconds + description: 'Number of seconds after which the probe times out. Defaults to 1 + + second. Minimum value is 1. Maximum value is 240.' + types: + - + - name: type + description: 'The type of probe. Possible values include: "liveness", "readiness", + "startup".' + types: + - + - +variables: +- description: 'Minimum consecutive failures for the probe to be considered failed + + after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10.' + name: failure_threshold + types: + - +- description: HTTPGet specifies the http request to perform. + name: http_get + types: + - +- description: 'Number of seconds after the container has started before liveness + + probes are initiated. Minimum value is 1. Maximum value is 60.' + name: initial_delay_seconds + types: + - +- description: 'How often (in seconds) to perform the probe. Default to 10 seconds. + + Minimum value is 1. Maximum value is 240.' + name: period_seconds + types: + - +- description: 'Minimum consecutive successes for the probe to be considered + + successful after having failed. Defaults to 1. Must be 1 for liveness and startup. + Minimum + + value is 1. Maximum value is 10.' + name: success_threshold + types: + - +- description: 'TCPSocket specifies an action involving a TCP port. TCP hooks not + yet + + supported.' + name: tcp_socket + types: + - +- description: 'Optional duration in seconds the pod needs to terminate + + gracefully upon probe failure. The grace period is the duration in seconds after + the processes + + running in the pod are sent a termination signal and the time when the processes + are forcibly + + halted with a kill signal. Set this value longer than the expected cleanup time + for your + + process. If this value is nil, the pod''s terminationGracePeriodSeconds will be + used. Otherwise, + + this value overrides the value provided by the pod spec. Value must be non-negative + integer. + + The value zero indicates stop immediately via the kill signal (no opportunity + to shut down). + + This is an alpha field and requires enabling ProbeTerminationGracePeriod feature + gate. Maximum + + value is 3600 seconds (1 hour).' + name: termination_grace_period_seconds + types: + - +- description: 'Number of seconds after which the probe times out. Defaults to 1 second. + + Minimum value is 1. Maximum value is 240.' + name: timeout_seconds + types: + - +- description: 'The type of probe. Possible values include: "liveness", "readiness", + "startup".' + name: type + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbeHttpGet.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbeHttpGet.yml new file mode 100644 index 00000000..9caa1b0b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbeHttpGet.yml @@ -0,0 +1,67 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.ContainerAppProbeHttpGet +name: ContainerAppProbeHttpGet +fullName: azure.mgmt.app.models.ContainerAppProbeHttpGet +module: azure.mgmt.app.models +summary: 'HTTPGet specifies the http request to perform. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ContainerAppProbeHttpGet(*, port: int, host: str | None = None, http_headers: + List[ContainerAppProbeHttpGetHttpHeadersItem] | None = None, path: str | None + = None, scheme: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: host + description: 'Host name to connect to, defaults to the pod IP. You probably want + to set "Host" + + in httpHeaders instead.' + types: + - + - name: http_headers + description: Custom headers to set in the request. HTTP allows repeated headers. + types: + - [] + - name: path + description: Path to access on the HTTP server. + types: + - + - name: port + description: 'Required. Name or number of the port to access on the container. + Number must be + + in the range 1 to 65535. Name must be an IANA_SVC_NAME.' + types: + - + - name: scheme + description: Scheme to use for connecting to the host. Defaults to HTTP. + types: + - +variables: +- description: 'Host name to connect to, defaults to the pod IP. You probably want + to set "Host" in + + httpHeaders instead.' + name: host + types: + - +- description: Custom headers to set in the request. HTTP allows repeated headers. + name: http_headers + types: + - [] +- description: Path to access on the HTTP server. + name: path + types: + - +- description: 'Required. Name or number of the port to access on the container. Number + must be in + + the range 1 to 65535. Name must be an IANA_SVC_NAME.' + name: port + types: + - +- description: Scheme to use for connecting to the host. Defaults to HTTP. + name: scheme + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbeHttpGetHttpHeadersItem.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbeHttpGetHttpHeadersItem.yml new file mode 100644 index 00000000..966614e0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbeHttpGetHttpHeadersItem.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.ContainerAppProbeHttpGetHttpHeadersItem +name: ContainerAppProbeHttpGetHttpHeadersItem +fullName: azure.mgmt.app.models.ContainerAppProbeHttpGetHttpHeadersItem +module: azure.mgmt.app.models +summary: 'HTTPHeader describes a custom header to be used in HTTP probes. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ContainerAppProbeHttpGetHttpHeadersItem(*, name: str, value: str, **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. The header field name. + types: + - + - name: value + description: Required. The header field value. + types: + - +variables: +- description: Required. The header field name. + name: name + types: + - +- description: Required. The header field value. + name: value + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbeTcpSocket.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbeTcpSocket.yml new file mode 100644 index 00000000..63597c5d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbeTcpSocket.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.ContainerAppProbeTcpSocket +name: ContainerAppProbeTcpSocket +fullName: azure.mgmt.app.models.ContainerAppProbeTcpSocket +module: azure.mgmt.app.models +summary: 'TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ContainerAppProbeTcpSocket(*, port: int, host: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: host + description: 'Optional: Host name to connect to, defaults to the pod IP.' + types: + - + - name: port + description: 'Required. Number or name of the port to access on the container. + Number must be + + in the range 1 to 65535. Name must be an IANA_SVC_NAME.' + types: + - +variables: +- description: 'Optional: Host name to connect to, defaults to the pod IP.' + name: host + types: + - +- description: 'Required. Number or name of the port to access on the container. Number + must be in + + the range 1 to 65535. Name must be an IANA_SVC_NAME.' + name: port + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProvisioningState.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProvisioningState.yml new file mode 100644 index 00000000..aa892118 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProvisioningState.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.app.models.ContainerAppProvisioningState +name: ContainerAppProvisioningState +fullName: azure.mgmt.app.models.ContainerAppProvisioningState +summary: Provisioning state of the Container App. +module: azure.mgmt.app.models +fields: +- name: CANCELED + uid: azure.mgmt.app.models.ContainerAppProvisioningState.CANCELED +- name: FAILED + uid: azure.mgmt.app.models.ContainerAppProvisioningState.FAILED +- name: IN_PROGRESS + uid: azure.mgmt.app.models.ContainerAppProvisioningState.IN_PROGRESS +- name: SUCCEEDED + uid: azure.mgmt.app.models.ContainerAppProvisioningState.SUCCEEDED diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppSecret.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppSecret.yml new file mode 100644 index 00000000..e165146c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppSecret.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.ContainerAppSecret +name: ContainerAppSecret +fullName: azure.mgmt.app.models.ContainerAppSecret +module: azure.mgmt.app.models +summary: 'Container App Secret. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: ContainerAppSecret(**kwargs) +variables: +- description: Secret Name. + name: name + types: + - +- description: Secret Value. + name: value + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerResources.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerResources.yml new file mode 100644 index 00000000..e0c3574f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerResources.yml @@ -0,0 +1,34 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.ContainerResources +name: ContainerResources +fullName: azure.mgmt.app.models.ContainerResources +module: azure.mgmt.app.models +summary: 'Container App container resource requirements. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'ContainerResources(*, cpu: float | None = None, memory: str | None = None, + **kwargs)' + keywordOnlyParameters: + - name: cpu + description: Required CPU in cores, e.g. 0.5. + types: + - + - name: memory + description: Required memory, e.g. "250Mb". + types: + - +variables: +- description: Required CPU in cores, e.g. 0.5. + name: cpu + types: + - +- description: Required memory, e.g. "250Mb". + name: memory + types: + - +- description: Ephemeral Storage, e.g. "1Gi". + name: ephemeral_storage + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CookieExpiration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CookieExpiration.yml new file mode 100644 index 00000000..b907ed74 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CookieExpiration.yml @@ -0,0 +1,37 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.CookieExpiration +name: CookieExpiration +fullName: azure.mgmt.app.models.CookieExpiration +module: azure.mgmt.app.models +summary: The configuration settings of the session cookie's expiration. +constructor: + syntax: 'CookieExpiration(*, convention: str | CookieExpirationConvention | None + = None, time_to_expiration: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: convention + description: 'The convention used when determining the session cookie''s expiration. + + Possible values include: "FixedTime", "IdentityProviderDerived".' + types: + - + - + - name: time_to_expiration + description: 'The time after the request is made when the session cookie should + + expire.' + types: + - +variables: +- description: 'The convention used when determining the session cookie''s expiration. + + Possible values include: "FixedTime", "IdentityProviderDerived".' + name: convention + types: + - + - +- description: 'The time after the request is made when the session cookie should + + expire.' + name: time_to_expiration + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CookieExpirationConvention.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CookieExpirationConvention.yml new file mode 100644 index 00000000..9102cea0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CookieExpirationConvention.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.app.models.CookieExpirationConvention +name: CookieExpirationConvention +fullName: azure.mgmt.app.models.CookieExpirationConvention +summary: The convention used when determining the session cookie's expiration. +module: azure.mgmt.app.models +fields: +- name: FIXED_TIME + uid: azure.mgmt.app.models.CookieExpirationConvention.FIXED_TIME +- name: IDENTITY_PROVIDER_DERIVED + uid: azure.mgmt.app.models.CookieExpirationConvention.IDENTITY_PROVIDER_DERIVED diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CreatedByType.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CreatedByType.yml new file mode 100644 index 00000000..b2f551a1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CreatedByType.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.app.models.CreatedByType +name: CreatedByType +fullName: azure.mgmt.app.models.CreatedByType +summary: The type of identity that created the resource. +module: azure.mgmt.app.models +fields: +- name: APPLICATION + uid: azure.mgmt.app.models.CreatedByType.APPLICATION +- name: KEY + uid: azure.mgmt.app.models.CreatedByType.KEY +- name: MANAGED_IDENTITY + uid: azure.mgmt.app.models.CreatedByType.MANAGED_IDENTITY +- name: USER + uid: azure.mgmt.app.models.CreatedByType.USER diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomDomain.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomDomain.yml new file mode 100644 index 00000000..317f07ce --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomDomain.yml @@ -0,0 +1,48 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.CustomDomain +name: CustomDomain +fullName: azure.mgmt.app.models.CustomDomain +module: azure.mgmt.app.models +summary: 'Custom Domain of a Container App. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CustomDomain(*, name: str, certificate_id: str, binding_type: str | BindingType + | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Required. Hostname. + types: + - + - name: binding_type + description: 'Custom Domain binding type. Possible values include: "Disabled", + + "SniEnabled".' + types: + - + - + - name: certificate_id + description: 'Required. Resource Id of the Certificate to be bound to this hostname. + + Must exist in the Managed Environment.' + types: + - +variables: +- description: Required. Hostname. + name: name + types: + - +- description: 'Custom Domain binding type. Possible values include: "Disabled", + + "SniEnabled".' + name: binding_type + types: + - + - +- description: 'Required. Resource Id of the Certificate to be bound to this hostname. + + Must exist in the Managed Environment.' + name: certificate_id + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomHostnameAnalysisResult.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomHostnameAnalysisResult.yml new file mode 100644 index 00000000..de7cb67c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomHostnameAnalysisResult.yml @@ -0,0 +1,113 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.CustomHostnameAnalysisResult +name: CustomHostnameAnalysisResult +fullName: azure.mgmt.app.models.CustomHostnameAnalysisResult +module: azure.mgmt.app.models +summary: 'Custom domain analysis. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'CustomHostnameAnalysisResult(*, c_name_records: List[str] | None = None, + txt_records: List[str] | None = None, a_records: List[str] | None = None, alternate_c_name_records: + List[str] | None = None, alternate_txt_records: List[str] | None = None, **kwargs)' + keywordOnlyParameters: + - name: c_name_records + description: CName records visible for this hostname. + types: + - [] + - name: txt_records + description: TXT records visible for this hostname. + types: + - [] + - name: a_records + description: A records visible for this hostname. + types: + - [] + - name: alternate_c_name_records + description: Alternate CName records visible for this hostname. + types: + - [] + - name: alternate_txt_records + description: Alternate TXT records visible for this hostname. + types: + - [] +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: Host name that was analyzed. + name: host_name + types: + - +- description: '`true` if hostname is already verified; + + otherwise, `false`.' + name: is_hostname_already_verified + types: + - +- description: 'DNS verification test result. Possible values include: + + "Passed", "Failed", "Skipped".' + name: custom_domain_verification_test + types: + - + - +- description: 'Raw failure information if DNS verification + + fails.' + name: custom_domain_verification_failure_info + types: + - +- description: '`true` if there is a conflict on + + the Container App''s managed environment; otherwise, `false`.' + name: has_conflict_on_managed_environment + types: + - +- description: 'Name of the conflicting Container App on the + + Managed Environment if it''s within the same subscription.' + name: conflicting_container_app_resource_id + types: + - +- description: CName records visible for this hostname. + name: c_name_records + types: + - [] +- description: TXT records visible for this hostname. + name: txt_records + types: + - [] +- description: A records visible for this hostname. + name: a_records + types: + - [] +- description: Alternate CName records visible for this hostname. + name: alternate_c_name_records + types: + - [] +- description: Alternate TXT records visible for this hostname. + name: alternate_txt_records + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomOpenIdConnectProvider.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomOpenIdConnectProvider.yml new file mode 100644 index 00000000..742d4395 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomOpenIdConnectProvider.yml @@ -0,0 +1,54 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.CustomOpenIdConnectProvider +name: CustomOpenIdConnectProvider +fullName: azure.mgmt.app.models.CustomOpenIdConnectProvider +module: azure.mgmt.app.models +summary: The configuration settings of the custom Open ID Connect provider. +constructor: + syntax: 'CustomOpenIdConnectProvider(*, enabled: bool | None = None, registration: + OpenIdConnectRegistration | None = None, login: OpenIdConnectLogin | None = None, + **kwargs)' + keywordOnlyParameters: + - name: enabled + description: '`false` if the custom Open ID provider provider should + not + + be enabled; otherwise, `true`.' + types: + - + - name: registration + description: 'The configuration settings of the app registration for the custom + Open + + ID Connect provider.' + types: + - + - name: login + description: 'The configuration settings of the login flow of the custom Open + ID Connect + + provider.' + types: + - +variables: +- description: '`false` if the custom Open ID provider provider should + not be + + enabled; otherwise, `true`.' + name: enabled + types: + - +- description: 'The configuration settings of the app registration for the custom + Open ID + + Connect provider.' + name: registration + types: + - +- description: 'The configuration settings of the login flow of the custom Open ID + Connect + + provider.' + name: login + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomScaleRule.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomScaleRule.yml new file mode 100644 index 00000000..eb901dec --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomScaleRule.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.CustomScaleRule +name: CustomScaleRule +fullName: azure.mgmt.app.models.CustomScaleRule +module: azure.mgmt.app.models +summary: Container App container Custom scaling rule. +constructor: + syntax: 'CustomScaleRule(*, type: str | None = None, metadata: Dict[str, str] | + None = None, auth: List[ScaleRuleAuth] | None = None, **kwargs)' + keywordOnlyParameters: + - name: type + description: 'Type of the custom scale rule + + eg: azure-servicebus, redis etc.' + types: + - + - name: metadata + description: Metadata properties to describe custom scale rule. + types: + - [, ] + - name: auth + description: Authentication secrets for the custom scale rule. + types: + - [] +variables: +- description: 'Type of the custom scale rule + + eg: azure-servicebus, redis etc.' + name: type + types: + - +- description: Metadata properties to describe custom scale rule. + name: metadata + types: + - [, ] +- description: Authentication secrets for the custom scale rule. + name: auth + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Dapr.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Dapr.yml new file mode 100644 index 00000000..c80b5d8a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Dapr.yml @@ -0,0 +1,51 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.Dapr +name: Dapr +fullName: azure.mgmt.app.models.Dapr +module: azure.mgmt.app.models +summary: Container App Dapr configuration. +constructor: + syntax: 'Dapr(*, enabled: bool | None = None, app_id: str | None = None, app_protocol: + str | AppProtocol | None = None, app_port: int | None = None, **kwargs)' + keywordOnlyParameters: + - name: enabled + description: Boolean indicating if the Dapr side car is enabled. + types: + - + - name: app_id + description: Dapr application identifier. + types: + - + - name: app_protocol + description: 'Tells Dapr which protocol your application is using. Valid options + are + + http and grpc. Default is http. Possible values include: "http", "grpc".' + types: + - + - + - name: app_port + description: Tells Dapr which port your application is listening on. + types: + - +variables: +- description: Boolean indicating if the Dapr side car is enabled. + name: enabled + types: + - +- description: Dapr application identifier. + name: app_id + types: + - +- description: 'Tells Dapr which protocol your application is using. Valid options + are http + + and grpc. Default is http. Possible values include: "http", "grpc".' + name: app_protocol + types: + - + - +- description: Tells Dapr which port your application is listening on. + name: app_port + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DaprComponent.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DaprComponent.yml new file mode 100644 index 00000000..e86f500e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DaprComponent.yml @@ -0,0 +1,95 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.DaprComponent +name: DaprComponent +fullName: azure.mgmt.app.models.DaprComponent +module: azure.mgmt.app.models +summary: 'Dapr Component. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'DaprComponent(*, component_type: str | None = None, version: str | None + = None, ignore_errors: bool | None = None, init_timeout: str | None = None, secrets: + List[Secret] | None = None, metadata: List[DaprMetadata] | None = None, scopes: + List[str] | None = None, **kwargs)' + keywordOnlyParameters: + - name: component_type + description: Component type. + types: + - + - name: version + description: Component version. + types: + - + - name: ignore_errors + description: Boolean describing if the component errors are ignores. + types: + - + - name: init_timeout + description: Initialization timeout. + types: + - + - name: secrets + description: Collection of secrets used by a Dapr component. + types: + - [] + - name: metadata + description: Component metadata. + types: + - [] + - name: scopes + description: Names of container apps that can use this Dapr component. + types: + - [] +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: Component type. + name: component_type + types: + - +- description: Component version. + name: version + types: + - +- description: Boolean describing if the component errors are ignores. + name: ignore_errors + types: + - +- description: Initialization timeout. + name: init_timeout + types: + - +- description: Collection of secrets used by a Dapr component. + name: secrets + types: + - [] +- description: Component metadata. + name: metadata + types: + - [] +- description: Names of container apps that can use this Dapr component. + name: scopes + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DaprComponentsCollection.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DaprComponentsCollection.yml new file mode 100644 index 00000000..1d2cd04d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DaprComponentsCollection.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.DaprComponentsCollection +name: DaprComponentsCollection +fullName: azure.mgmt.app.models.DaprComponentsCollection +module: azure.mgmt.app.models +summary: 'Dapr Components ARM resource. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DaprComponentsCollection(*, value: List[DaprComponent], **kwargs)' + keywordOnlyParameters: + - name: value + description: Required. Collection of resources. + types: + - [] +variables: +- description: Required. Collection of resources. + name: value + types: + - [] +- description: Link to next page of resources. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DaprMetadata.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DaprMetadata.yml new file mode 100644 index 00000000..d9ab1489 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DaprMetadata.yml @@ -0,0 +1,41 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.DaprMetadata +name: DaprMetadata +fullName: azure.mgmt.app.models.DaprMetadata +module: azure.mgmt.app.models +summary: Dapr component metadata. +constructor: + syntax: 'DaprMetadata(*, name: str | None = None, value: str | None = None, secret_ref: + str | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Metadata property name. + types: + - + - name: value + description: Metadata property value. + types: + - + - name: secret_ref + description: 'Name of the Dapr Component secret from which to pull the metadata + property + + value.' + types: + - +variables: +- description: Metadata property name. + name: name + types: + - +- description: Metadata property value. + name: value + types: + - +- description: 'Name of the Dapr Component secret from which to pull the metadata + property + + value.' + name: secret_ref + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultAuthorizationPolicy.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultAuthorizationPolicy.yml new file mode 100644 index 00000000..9585d605 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultAuthorizationPolicy.yml @@ -0,0 +1,36 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.DefaultAuthorizationPolicy +name: DefaultAuthorizationPolicy +fullName: azure.mgmt.app.models.DefaultAuthorizationPolicy +module: azure.mgmt.app.models +summary: The configuration settings of the Azure Active Directory default authorization + policy. +constructor: + syntax: 'DefaultAuthorizationPolicy(*, allowed_principals: AllowedPrincipals | None + = None, allowed_applications: List[str] | None = None, **kwargs)' + keywordOnlyParameters: + - name: allowed_principals + description: 'The configuration settings of the Azure Active Directory allowed + + principals.' + types: + - + - name: allowed_applications + description: 'The configuration settings of the Azure Active Directory allowed + + applications.' + types: + - [] +variables: +- description: 'The configuration settings of the Azure Active Directory allowed + + principals.' + name: allowed_principals + types: + - +- description: 'The configuration settings of the Azure Active Directory allowed + + applications.' + name: allowed_applications + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultErrorResponse.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultErrorResponse.yml new file mode 100644 index 00000000..f6d62faf --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultErrorResponse.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.DefaultErrorResponse +name: DefaultErrorResponse +fullName: azure.mgmt.app.models.DefaultErrorResponse +module: azure.mgmt.app.models +summary: 'App Service error response. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: DefaultErrorResponse(**kwargs) +variables: +- description: Error model. + name: error + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultErrorResponseError.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultErrorResponseError.yml new file mode 100644 index 00000000..1e298a71 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultErrorResponseError.yml @@ -0,0 +1,38 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.DefaultErrorResponseError +name: DefaultErrorResponseError +fullName: azure.mgmt.app.models.DefaultErrorResponseError +module: azure.mgmt.app.models +summary: 'Error model. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'DefaultErrorResponseError(*, details: List[DefaultErrorResponseErrorDetailsItem] + | None = None, **kwargs)' + keywordOnlyParameters: + - name: details + description: Details or the error. + types: + - [] +variables: +- description: Standardized string to programmatically identify the error. + name: code + types: + - +- description: Detailed error description and debugging information. + name: message + types: + - +- description: Detailed error description and debugging information. + name: target + types: + - +- description: Details or the error. + name: details + types: + - [] +- description: More information to debug error. + name: innererror + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultErrorResponseErrorDetailsItem.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultErrorResponseErrorDetailsItem.yml new file mode 100644 index 00000000..d3b7711d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultErrorResponseErrorDetailsItem.yml @@ -0,0 +1,24 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.DefaultErrorResponseErrorDetailsItem +name: DefaultErrorResponseErrorDetailsItem +fullName: azure.mgmt.app.models.DefaultErrorResponseErrorDetailsItem +module: azure.mgmt.app.models +summary: 'Detailed errors. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: DefaultErrorResponseErrorDetailsItem(**kwargs) +variables: +- description: Standardized string to programmatically identify the error. + name: code + types: + - +- description: Detailed error description and debugging information. + name: message + types: + - +- description: Detailed error description and debugging information. + name: target + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DnsVerificationTestResult.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DnsVerificationTestResult.yml new file mode 100644 index 00000000..7e28cf3a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DnsVerificationTestResult.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.app.models.DnsVerificationTestResult +name: DnsVerificationTestResult +fullName: azure.mgmt.app.models.DnsVerificationTestResult +summary: DNS verification test result. +module: azure.mgmt.app.models +fields: +- name: FAILED + uid: azure.mgmt.app.models.DnsVerificationTestResult.FAILED +- name: PASSED + uid: azure.mgmt.app.models.DnsVerificationTestResult.PASSED +- name: SKIPPED + uid: azure.mgmt.app.models.DnsVerificationTestResult.SKIPPED diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.EnvironmentProvisioningState.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.EnvironmentProvisioningState.yml new file mode 100644 index 00000000..af4ecc84 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.EnvironmentProvisioningState.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.app.models.EnvironmentProvisioningState +name: EnvironmentProvisioningState +fullName: azure.mgmt.app.models.EnvironmentProvisioningState +summary: Provisioning state of the Environment. +module: azure.mgmt.app.models +fields: +- name: CANCELED + uid: azure.mgmt.app.models.EnvironmentProvisioningState.CANCELED +- name: FAILED + uid: azure.mgmt.app.models.EnvironmentProvisioningState.FAILED +- name: INFRASTRUCTURE_SETUP_COMPLETE + uid: azure.mgmt.app.models.EnvironmentProvisioningState.INFRASTRUCTURE_SETUP_COMPLETE +- name: INFRASTRUCTURE_SETUP_IN_PROGRESS + uid: azure.mgmt.app.models.EnvironmentProvisioningState.INFRASTRUCTURE_SETUP_IN_PROGRESS +- name: INITIALIZATION_IN_PROGRESS + uid: azure.mgmt.app.models.EnvironmentProvisioningState.INITIALIZATION_IN_PROGRESS +- name: SCHEDULED_FOR_DELETE + uid: azure.mgmt.app.models.EnvironmentProvisioningState.SCHEDULED_FOR_DELETE +- name: SUCCEEDED + uid: azure.mgmt.app.models.EnvironmentProvisioningState.SUCCEEDED +- name: UPGRADE_FAILED + uid: azure.mgmt.app.models.EnvironmentProvisioningState.UPGRADE_FAILED +- name: UPGRADE_REQUESTED + uid: azure.mgmt.app.models.EnvironmentProvisioningState.UPGRADE_REQUESTED +- name: WAITING + uid: azure.mgmt.app.models.EnvironmentProvisioningState.WAITING diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.EnvironmentVar.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.EnvironmentVar.yml new file mode 100644 index 00000000..846667f0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.EnvironmentVar.yml @@ -0,0 +1,40 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.EnvironmentVar +name: EnvironmentVar +fullName: azure.mgmt.app.models.EnvironmentVar +module: azure.mgmt.app.models +summary: Container App container environment variable. +constructor: + syntax: 'EnvironmentVar(*, name: str | None = None, value: str | None = None, secret_ref: + str | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Environment variable name. + types: + - + - name: value + description: Non-secret environment variable value. + types: + - + - name: secret_ref + description: 'Name of the Container App secret from which to pull the environment + + variable value.' + types: + - +variables: +- description: Environment variable name. + name: name + types: + - +- description: Non-secret environment variable value. + name: value + types: + - +- description: 'Name of the Container App secret from which to pull the environment + variable + + value.' + name: secret_ref + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Facebook.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Facebook.yml new file mode 100644 index 00000000..abc41df9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Facebook.yml @@ -0,0 +1,52 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.Facebook +name: Facebook +fullName: azure.mgmt.app.models.Facebook +module: azure.mgmt.app.models +summary: The configuration settings of the Facebook provider. +constructor: + syntax: 'Facebook(*, enabled: bool | None = None, registration: AppRegistration + | None = None, graph_api_version: str | None = None, login: LoginScopes | None + = None, **kwargs)' + keywordOnlyParameters: + - name: enabled + description: '`false` if the Facebook provider should not be enabled + + despite the set registration; otherwise, `true`.' + types: + - + - name: registration + description: 'The configuration settings of the app registration for the Facebook + + provider.' + types: + - + - name: graph_api_version + description: The version of the Facebook api to be used while logging in. + types: + - + - name: login + description: The configuration settings of the login flow. + types: + - +variables: +- description: '`false` if the Facebook provider should not be enabled + + despite the set registration; otherwise, `true`.' + name: enabled + types: + - +- description: 'The configuration settings of the app registration for the Facebook + + provider.' + name: registration + types: + - +- description: The version of the Facebook api to be used while logging in. + name: graph_api_version + types: + - +- description: The configuration settings of the login flow. + name: login + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ForwardProxy.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ForwardProxy.yml new file mode 100644 index 00000000..95994287 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ForwardProxy.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.ForwardProxy +name: ForwardProxy +fullName: azure.mgmt.app.models.ForwardProxy +module: azure.mgmt.app.models +summary: The configuration settings of a forward proxy used to make the requests. +constructor: + syntax: 'ForwardProxy(*, convention: str | ForwardProxyConvention | None = None, + custom_host_header_name: str | None = None, custom_proto_header_name: str | None + = None, **kwargs)' + keywordOnlyParameters: + - name: convention + description: 'The convention used to determine the url of the request made. Possible + + values include: "NoProxy", "Standard", "Custom".' + types: + - + - + - name: custom_host_header_name + description: The name of the header containing the host of the request. + types: + - + - name: custom_proto_header_name + description: The name of the header containing the scheme of the request. + types: + - +variables: +- description: 'The convention used to determine the url of the request made. Possible + values + + include: "NoProxy", "Standard", "Custom".' + name: convention + types: + - + - +- description: The name of the header containing the host of the request. + name: custom_host_header_name + types: + - +- description: The name of the header containing the scheme of the request. + name: custom_proto_header_name + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ForwardProxyConvention.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ForwardProxyConvention.yml new file mode 100644 index 00000000..cdf85649 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ForwardProxyConvention.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.app.models.ForwardProxyConvention +name: ForwardProxyConvention +fullName: azure.mgmt.app.models.ForwardProxyConvention +summary: The convention used to determine the url of the request made. +module: azure.mgmt.app.models +fields: +- name: CUSTOM + uid: azure.mgmt.app.models.ForwardProxyConvention.CUSTOM +- name: NO_PROXY + uid: azure.mgmt.app.models.ForwardProxyConvention.NO_PROXY +- name: STANDARD + uid: azure.mgmt.app.models.ForwardProxyConvention.STANDARD diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GitHub.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GitHub.yml new file mode 100644 index 00000000..64a541c6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GitHub.yml @@ -0,0 +1,42 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.GitHub +name: GitHub +fullName: azure.mgmt.app.models.GitHub +module: azure.mgmt.app.models +summary: The configuration settings of the GitHub provider. +constructor: + syntax: 'GitHub(*, enabled: bool | None = None, registration: ClientRegistration + | None = None, login: LoginScopes | None = None, **kwargs)' + keywordOnlyParameters: + - name: enabled + description: '`false` if the GitHub provider should not be enabled + + despite the set registration; otherwise, `true`.' + types: + - + - name: registration + description: 'The configuration settings of the app registration for the GitHub + + provider.' + types: + - + - name: login + description: The configuration settings of the login flow. + types: + - +variables: +- description: '`false` if the GitHub provider should not be enabled + despite + + the set registration; otherwise, `true`.' + name: enabled + types: + - +- description: The configuration settings of the app registration for the GitHub provider. + name: registration + types: + - +- description: The configuration settings of the login flow. + name: login + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GithubActionConfiguration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GithubActionConfiguration.yml new file mode 100644 index 00000000..487022fd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GithubActionConfiguration.yml @@ -0,0 +1,70 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.GithubActionConfiguration +name: GithubActionConfiguration +fullName: azure.mgmt.app.models.GithubActionConfiguration +module: azure.mgmt.app.models +summary: Configuration properties that define the mutable settings of a Container + App SourceControl. +constructor: + syntax: 'GithubActionConfiguration(*, registry_info: RegistryInfo | None = None, + azure_credentials: AzureCredentials | None = None, dockerfile_path: str | None + = None, publish_type: str | None = None, os: str | None = None, runtime_stack: + str | None = None, runtime_version: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: registry_info + description: Registry configurations. + types: + - + - name: azure_credentials + description: AzureCredentials configurations. + types: + - + - name: dockerfile_path + description: Docker file path. + types: + - + - name: publish_type + description: Code or Image. + types: + - + - name: os + description: Operation system. + types: + - + - name: runtime_stack + description: Runtime stack. + types: + - + - name: runtime_version + description: Runtime Version. + types: + - +variables: +- description: Registry configurations. + name: registry_info + types: + - +- description: AzureCredentials configurations. + name: azure_credentials + types: + - +- description: Docker file path. + name: dockerfile_path + types: + - +- description: Code or Image. + name: publish_type + types: + - +- description: Operation system. + name: os + types: + - +- description: Runtime stack. + name: runtime_stack + types: + - +- description: Runtime Version. + name: runtime_version + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GlobalValidation.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GlobalValidation.yml new file mode 100644 index 00000000..87b5b503 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GlobalValidation.yml @@ -0,0 +1,70 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.GlobalValidation +name: GlobalValidation +fullName: azure.mgmt.app.models.GlobalValidation +module: azure.mgmt.app.models +summary: The configuration settings that determines the validation flow of users using + ContainerApp Service Authentication/Authorization. +constructor: + syntax: 'GlobalValidation(*, unauthenticated_client_action: str | UnauthenticatedClientActionV2 + | None = None, redirect_to_provider: str | None = None, excluded_paths: List[str] + | None = None, **kwargs)' + keywordOnlyParameters: + - name: unauthenticated_client_action + description: 'The action to take when an unauthenticated client + + attempts to access the app. Possible values include: "RedirectToLoginPage", + "AllowAnonymous", + + "Return401", "Return403".' + types: + - + - + - name: redirect_to_provider + description: 'The default authentication provider to use when multiple + + providers are configured. + + This setting is only needed if multiple providers are configured and the unauthenticated + + client + + action is set to "RedirectToLoginPage".' + types: + - + - name: excluded_paths + description: 'The paths for which unauthenticated flow would not be redirected + to + + the login page.' + types: + - [] +variables: +- description: 'The action to take when an unauthenticated client attempts + + to access the app. Possible values include: "RedirectToLoginPage", "AllowAnonymous", + + "Return401", "Return403".' + name: unauthenticated_client_action + types: + - + - +- description: 'The default authentication provider to use when multiple providers + + are configured. + + This setting is only needed if multiple providers are configured and the unauthenticated + + client + + action is set to "RedirectToLoginPage".' + name: redirect_to_provider + types: + - +- description: 'The paths for which unauthenticated flow would not be redirected to + the + + login page.' + name: excluded_paths + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Google.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Google.yml new file mode 100644 index 00000000..9c393be6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Google.yml @@ -0,0 +1,55 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.Google +name: Google +fullName: azure.mgmt.app.models.Google +module: azure.mgmt.app.models +summary: The configuration settings of the Google provider. +constructor: + syntax: 'Google(*, enabled: bool | None = None, registration: ClientRegistration + | None = None, login: LoginScopes | None = None, validation: AllowedAudiencesValidation + | None = None, **kwargs)' + keywordOnlyParameters: + - name: enabled + description: '`false` if the Google provider should not be enabled + + despite the set registration; otherwise, `true`.' + types: + - + - name: registration + description: 'The configuration settings of the app registration for the Google + + provider.' + types: + - + - name: login + description: The configuration settings of the login flow. + types: + - + - name: validation + description: 'The configuration settings of the Azure Active Directory token validation + + flow.' + types: + - +variables: +- description: '`false` if the Google provider should not be enabled + despite + + the set registration; otherwise, `true`.' + name: enabled + types: + - +- description: The configuration settings of the app registration for the Google provider. + name: registration + types: + - +- description: The configuration settings of the login flow. + name: login + types: + - +- description: 'The configuration settings of the Azure Active Directory token validation + + flow.' + name: validation + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpScaleRule.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpScaleRule.yml new file mode 100644 index 00000000..6c1a08dd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpScaleRule.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.HttpScaleRule +name: HttpScaleRule +fullName: azure.mgmt.app.models.HttpScaleRule +module: azure.mgmt.app.models +summary: Container App container Custom scaling rule. +constructor: + syntax: 'HttpScaleRule(*, metadata: Dict[str, str] | None = None, auth: List[ScaleRuleAuth] + | None = None, **kwargs)' + keywordOnlyParameters: + - name: metadata + description: Metadata properties to describe http scale rule. + types: + - [, ] + - name: auth + description: Authentication secrets for the custom scale rule. + types: + - [] +variables: +- description: Metadata properties to describe http scale rule. + name: metadata + types: + - [, ] +- description: Authentication secrets for the custom scale rule. + name: auth + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpSettings.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpSettings.yml new file mode 100644 index 00000000..59b07978 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpSettings.yml @@ -0,0 +1,42 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.HttpSettings +name: HttpSettings +fullName: azure.mgmt.app.models.HttpSettings +module: azure.mgmt.app.models +summary: The configuration settings of the HTTP requests for authentication and authorization + requests made against ContainerApp Service Authentication/Authorization. +constructor: + syntax: 'HttpSettings(*, require_https: bool | None = None, routes: HttpSettingsRoutes + | None = None, forward_proxy: ForwardProxy | None = None, **kwargs)' + keywordOnlyParameters: + - name: require_https + description: '`false` if the authentication/authorization + + responses not having the HTTPS scheme are permissible; otherwise, `true`.' + types: + - + - name: routes + description: The configuration settings of the paths HTTP requests. + types: + - + - name: forward_proxy + description: 'The configuration settings of a forward proxy used to make the + + requests.' + types: + - +variables: +- description: '`false` if the authentication/authorization responses + + not having the HTTPS scheme are permissible; otherwise, `true`.' + name: require_https + types: + - +- description: The configuration settings of the paths HTTP requests. + name: routes + types: + - +- description: The configuration settings of a forward proxy used to make the requests. + name: forward_proxy + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpSettingsRoutes.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpSettingsRoutes.yml new file mode 100644 index 00000000..507ad461 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpSettingsRoutes.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.HttpSettingsRoutes +name: HttpSettingsRoutes +fullName: azure.mgmt.app.models.HttpSettingsRoutes +module: azure.mgmt.app.models +summary: The configuration settings of the paths HTTP requests. +constructor: + syntax: 'HttpSettingsRoutes(*, api_prefix: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: api_prefix + description: The prefix that should precede all the authentication/authorization + paths. + types: + - +variables: +- description: The prefix that should precede all the authentication/authorization + paths. + name: api_prefix + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.IdentityProviders.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.IdentityProviders.yml new file mode 100644 index 00000000..0d68b39d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.IdentityProviders.yml @@ -0,0 +1,93 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.IdentityProviders +name: IdentityProviders +fullName: azure.mgmt.app.models.IdentityProviders +module: azure.mgmt.app.models +summary: The configuration settings of each of the identity providers used to configure + ContainerApp Service Authentication/Authorization. +constructor: + syntax: 'IdentityProviders(*, azure_active_directory: AzureActiveDirectory | None + = None, facebook: Facebook | None = None, git_hub: GitHub | None = None, google: + Google | None = None, twitter: Twitter | None = None, apple: Apple | None = None, + azure_static_web_apps: AzureStaticWebApps | None = None, custom_open_id_connect_providers: + Dict[str, CustomOpenIdConnectProvider] | None = None, **kwargs)' + keywordOnlyParameters: + - name: azure_active_directory + description: 'The configuration settings of the Azure Active directory + + provider.' + types: + - + - name: facebook + description: The configuration settings of the Facebook provider. + types: + - + - name: git_hub + description: The configuration settings of the GitHub provider. + types: + - + - name: google + description: The configuration settings of the Google provider. + types: + - + - name: twitter + description: The configuration settings of the Twitter provider. + types: + - + - name: apple + description: The configuration settings of the Apple provider. + types: + - + - name: azure_static_web_apps + description: 'The configuration settings of the Azure Static Web Apps + + provider.' + types: + - + - name: custom_open_id_connect_providers + description: 'The map of the name of the alias of each custom Open + + ID Connect provider to the + + configuration settings of the custom Open ID Connect provider.' + types: + - [, ] +variables: +- description: 'The configuration settings of the Azure Active directory + + provider.' + name: azure_active_directory + types: + - +- description: The configuration settings of the Facebook provider. + name: facebook + types: + - +- description: The configuration settings of the GitHub provider. + name: git_hub + types: + - +- description: The configuration settings of the Google provider. + name: google + types: + - +- description: The configuration settings of the Twitter provider. + name: twitter + types: + - +- description: The configuration settings of the Apple provider. + name: apple + types: + - +- description: The configuration settings of the Azure Static Web Apps provider. + name: azure_static_web_apps + types: + - +- description: 'The map of the name of the alias of each custom Open ID + + Connect provider to the + + configuration settings of the custom Open ID Connect provider.' + name: custom_open_id_connect_providers + types: + - [, ] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Ingress.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Ingress.yml new file mode 100644 index 00000000..6747b564 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Ingress.yml @@ -0,0 +1,78 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.Ingress +name: Ingress +fullName: azure.mgmt.app.models.Ingress +module: azure.mgmt.app.models +summary: 'Container App Ingress configuration. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'Ingress(*, external: bool | None = False, target_port: int | None = None, + transport: str | IngressTransportMethod | None = None, traffic: List[TrafficWeight] + | None = None, custom_domains: List[CustomDomain] | None = None, allow_insecure: + bool | None = None, **kwargs)' + keywordOnlyParameters: + - name: external + description: Bool indicating if app exposes an external http endpoint. + types: + - + - name: target_port + description: Target Port in containers for traffic from ingress. + types: + - + - name: transport + description: 'Ingress transport protocol. Possible values include: "auto", "http", + + "http2".' + types: + - + - + - name: traffic + description: Traffic weights for app's revisions. + types: + - [] + - name: custom_domains + description: custom domain bindings for Container Apps' hostnames. + types: + - [] + - name: allow_insecure + description: 'Bool indicating if HTTP connections to is allowed. If set to false + + HTTP connections are automatically redirected to HTTPS connections.' + types: + - +variables: +- description: Hostname. + name: fqdn + types: + - +- description: Bool indicating if app exposes an external http endpoint. + name: external + types: + - +- description: Target Port in containers for traffic from ingress. + name: target_port + types: + - +- description: 'Ingress transport protocol. Possible values include: "auto", "http", + "http2".' + name: transport + types: + - + - +- description: Traffic weights for app's revisions. + name: traffic + types: + - [] +- description: custom domain bindings for Container Apps' hostnames. + name: custom_domains + types: + - [] +- description: 'Bool indicating if HTTP connections to is allowed. If set to false + HTTP + + connections are automatically redirected to HTTPS connections.' + name: allow_insecure + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.IngressTransportMethod.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.IngressTransportMethod.yml new file mode 100644 index 00000000..485961df --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.IngressTransportMethod.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.app.models.IngressTransportMethod +name: IngressTransportMethod +fullName: azure.mgmt.app.models.IngressTransportMethod +summary: Ingress transport protocol +module: azure.mgmt.app.models +fields: +- name: AUTO + uid: azure.mgmt.app.models.IngressTransportMethod.AUTO +- name: HTTP + uid: azure.mgmt.app.models.IngressTransportMethod.HTTP +- name: HTTP2 + uid: azure.mgmt.app.models.IngressTransportMethod.HTTP2 diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.JwtClaimChecks.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.JwtClaimChecks.yml new file mode 100644 index 00000000..b026ed57 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.JwtClaimChecks.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.JwtClaimChecks +name: JwtClaimChecks +fullName: azure.mgmt.app.models.JwtClaimChecks +module: azure.mgmt.app.models +summary: The configuration settings of the checks that should be made while validating + the JWT Claims. +constructor: + syntax: 'JwtClaimChecks(*, allowed_groups: List[str] | None = None, allowed_client_applications: + List[str] | None = None, **kwargs)' + keywordOnlyParameters: + - name: allowed_groups + description: The list of the allowed groups. + types: + - [] + - name: allowed_client_applications + description: The list of the allowed client applications. + types: + - [] +variables: +- description: The list of the allowed groups. + name: allowed_groups + types: + - [] +- description: The list of the allowed client applications. + name: allowed_client_applications + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LogAnalyticsConfiguration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LogAnalyticsConfiguration.yml new file mode 100644 index 00000000..442a538d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LogAnalyticsConfiguration.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.LogAnalyticsConfiguration +name: LogAnalyticsConfiguration +fullName: azure.mgmt.app.models.LogAnalyticsConfiguration +module: azure.mgmt.app.models +summary: Log analytics configuration. +constructor: + syntax: 'LogAnalyticsConfiguration(*, customer_id: str | None = None, shared_key: + str | None = None, **kwargs)' + keywordOnlyParameters: + - name: customer_id + description: Log analytics customer id. + types: + - + - name: shared_key + description: Log analytics customer key. + types: + - +variables: +- description: Log analytics customer id. + name: customer_id + types: + - +- description: Log analytics customer key. + name: shared_key + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Login.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Login.yml new file mode 100644 index 00000000..2b06f038 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Login.yml @@ -0,0 +1,73 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.Login +name: Login +fullName: azure.mgmt.app.models.Login +module: azure.mgmt.app.models +summary: The configuration settings of the login flow of users using ContainerApp + Service Authentication/Authorization. +constructor: + syntax: 'Login(*, routes: LoginRoutes | None = None, preserve_url_fragments_for_logins: + bool | None = None, allowed_external_redirect_urls: List[str] | None = None, cookie_expiration: + CookieExpiration | None = None, nonce: Nonce | None = None, **kwargs)' + keywordOnlyParameters: + - name: routes + description: The routes that specify the endpoints used for login and logout requests. + types: + - + - name: preserve_url_fragments_for_logins + description: '`true` if the fragments from the + + request are preserved after the login request is made; otherwise, `false`.' + types: + - + - name: allowed_external_redirect_urls + description: 'External URLs that can be redirected to as part of + + logging in or logging out of the app. Note that the query string part of the + URL is ignored. + + This is an advanced setting typically only needed by Windows Store application + backends. + + Note that URLs within the current domain are always implicitly allowed.' + types: + - [] + - name: cookie_expiration + description: The configuration settings of the session cookie's expiration. + types: + - + - name: nonce + description: The configuration settings of the nonce used in the login flow. + types: + - +variables: +- description: The routes that specify the endpoints used for login and logout requests. + name: routes + types: + - +- description: '`true` if the fragments from the + + request are preserved after the login request is made; otherwise, `false`.' + name: preserve_url_fragments_for_logins + types: + - +- description: 'External URLs that can be redirected to as part of + + logging in or logging out of the app. Note that the query string part of the URL + is ignored. + + This is an advanced setting typically only needed by Windows Store application + backends. + + Note that URLs within the current domain are always implicitly allowed.' + name: allowed_external_redirect_urls + types: + - [] +- description: The configuration settings of the session cookie's expiration. + name: cookie_expiration + types: + - +- description: The configuration settings of the nonce used in the login flow. + name: nonce + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LoginRoutes.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LoginRoutes.yml new file mode 100644 index 00000000..4b28669d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LoginRoutes.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.LoginRoutes +name: LoginRoutes +fullName: azure.mgmt.app.models.LoginRoutes +module: azure.mgmt.app.models +summary: The routes that specify the endpoints used for login and logout requests. +constructor: + syntax: 'LoginRoutes(*, logout_endpoint: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: logout_endpoint + description: The endpoint at which a logout request should be made. + types: + - +variables: +- description: The endpoint at which a logout request should be made. + name: logout_endpoint + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LoginScopes.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LoginScopes.yml new file mode 100644 index 00000000..efd6ddce --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LoginScopes.yml @@ -0,0 +1,19 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.LoginScopes +name: LoginScopes +fullName: azure.mgmt.app.models.LoginScopes +module: azure.mgmt.app.models +summary: The configuration settings of the login flow, including the scopes that should + be requested. +constructor: + syntax: 'LoginScopes(*, scopes: List[str] | None = None, **kwargs)' + keywordOnlyParameters: + - name: scopes + description: A list of the scopes that should be requested while authenticating. + types: + - [] +variables: +- description: A list of the scopes that should be requested while authenticating. + name: scopes + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironment.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironment.yml new file mode 100644 index 00000000..8fd333b7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironment.yml @@ -0,0 +1,116 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.ManagedEnvironment +name: ManagedEnvironment +fullName: azure.mgmt.app.models.ManagedEnvironment +module: azure.mgmt.app.models +summary: 'An environment for hosting container apps. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ManagedEnvironment(*, location: str, tags: Dict[str, str] | None = None, + dapr_ai_instrumentation_key: str | None = None, vnet_configuration: VnetConfiguration + | None = None, app_logs_configuration: AppLogsConfiguration | None = None, **kwargs)' + keywordOnlyParameters: + - name: tags + description: A set of tags. Resource tags. + types: + - [, ] + - name: location + description: Required. The geo-location where the resource lives. + types: + - + - name: dapr_ai_instrumentation_key + description: 'Azure Monitor instrumentation key used by Dapr to export + + Service to Service communication telemetry.' + types: + - + - name: vnet_configuration + description: Vnet configuration for the environment. + types: + - + - name: app_logs_configuration + description: 'Cluster configuration which enables the log daemon to export + + app logs to a destination. Currently only "log-analytics" is + + supported.' + types: + - +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: A set of tags. Resource tags. + name: tags + types: + - [, ] +- description: Required. The geo-location where the resource lives. + name: location + types: + - +- description: 'Provisioning state of the Environment. Possible values include: + + "Succeeded", "Failed", "Canceled", "Waiting", "InitializationInProgress", + + "InfrastructureSetupInProgress", "InfrastructureSetupComplete", "ScheduledForDelete", + + "UpgradeRequested", "UpgradeFailed".' + name: provisioning_state + types: + - + - +- description: 'Azure Monitor instrumentation key used by Dapr to export + + Service to Service communication telemetry.' + name: dapr_ai_instrumentation_key + types: + - +- description: Vnet configuration for the environment. + name: vnet_configuration + types: + - +- description: Any errors that occurred during deployment or deployment validation. + name: deployment_errors + types: + - +- description: Default Domain Name for the cluster. + name: default_domain + types: + - +- description: Static IP of the Environment. + name: static_ip + types: + - +- description: 'Cluster configuration which enables the log daemon to export + + app logs to a destination. Currently only "log-analytics" is + + supported.' + name: app_logs_configuration + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentPatch.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentPatch.yml new file mode 100644 index 00000000..25b0bcd0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentPatch.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.ManagedEnvironmentPatch +name: ManagedEnvironmentPatch +fullName: azure.mgmt.app.models.ManagedEnvironmentPatch +module: azure.mgmt.app.models +summary: An environment for hosting container apps. +constructor: + syntax: 'ManagedEnvironmentPatch(*, tags: Dict[str, str] | None = None, **kwargs)' + keywordOnlyParameters: + - name: tags + description: A set of tags. Application-specific metadata in the form of key-value + pairs. + types: + - [, ] +variables: +- description: A set of tags. Application-specific metadata in the form of key-value + pairs. + name: tags + types: + - [, ] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentStorage.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentStorage.yml new file mode 100644 index 00000000..2e98c942 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentStorage.yml @@ -0,0 +1,45 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.ManagedEnvironmentStorage +name: ManagedEnvironmentStorage +fullName: azure.mgmt.app.models.ManagedEnvironmentStorage +module: azure.mgmt.app.models +summary: 'Storage resource for managedEnvironment. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'ManagedEnvironmentStorage(*, properties: ManagedEnvironmentStorageProperties + | None = None, **kwargs)' + keywordOnlyParameters: + - name: properties + description: Storage properties. + types: + - +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: Storage properties. + name: properties + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentStorageProperties.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentStorageProperties.yml new file mode 100644 index 00000000..a548a3a1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentStorageProperties.yml @@ -0,0 +1,19 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.ManagedEnvironmentStorageProperties +name: ManagedEnvironmentStorageProperties +fullName: azure.mgmt.app.models.ManagedEnvironmentStorageProperties +module: azure.mgmt.app.models +summary: Storage properties. +constructor: + syntax: 'ManagedEnvironmentStorageProperties(*, azure_file: AzureFileProperties + | None = None, **kwargs)' + keywordOnlyParameters: + - name: azure_file + description: Azure file properties. + types: + - +variables: +- description: Azure file properties. + name: azure_file + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentStoragesCollection.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentStoragesCollection.yml new file mode 100644 index 00000000..8ebe8f26 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentStoragesCollection.yml @@ -0,0 +1,22 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.ManagedEnvironmentStoragesCollection +name: ManagedEnvironmentStoragesCollection +fullName: azure.mgmt.app.models.ManagedEnvironmentStoragesCollection +module: azure.mgmt.app.models +summary: 'Collection of Storage for Environments. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ManagedEnvironmentStoragesCollection(*, value: List[ManagedEnvironmentStorage], + **kwargs)' + keywordOnlyParameters: + - name: value + description: Required. Collection of storage resources. + types: + - [] +variables: +- description: Required. Collection of storage resources. + name: value + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentsCollection.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentsCollection.yml new file mode 100644 index 00000000..b2f3266a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentsCollection.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.ManagedEnvironmentsCollection +name: ManagedEnvironmentsCollection +fullName: azure.mgmt.app.models.ManagedEnvironmentsCollection +module: azure.mgmt.app.models +summary: 'Collection of Environments. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ManagedEnvironmentsCollection(*, value: List[ManagedEnvironment], **kwargs)' + keywordOnlyParameters: + - name: value + description: Required. Collection of resources. + types: + - [] +variables: +- description: Required. Collection of resources. + name: value + types: + - [] +- description: Link to next page of resources. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedServiceIdentity.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedServiceIdentity.yml new file mode 100644 index 00000000..17838d3c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedServiceIdentity.yml @@ -0,0 +1,72 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.ManagedServiceIdentity +name: ManagedServiceIdentity +fullName: azure.mgmt.app.models.ManagedServiceIdentity +module: azure.mgmt.app.models +summary: 'Managed service identity (system assigned and/or user assigned identities). + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ManagedServiceIdentity(*, type: str | ManagedServiceIdentityType, user_assigned_identities: + Dict[str, UserAssignedIdentity] | None = None, **kwargs)' + keywordOnlyParameters: + - name: type + description: 'Required. Type of managed service identity (where both SystemAssigned + and + + UserAssigned types are allowed). Possible values include: "None", "SystemAssigned", + + "UserAssigned", "SystemAssigned,UserAssigned".' + types: + - + - + - name: user_assigned_identities + description: '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.' + types: + - [, ] +variables: +- description: 'The service principal ID of the system assigned identity. This property + + will only be provided for a system assigned identity.' + name: principal_id + types: + - +- description: 'The tenant ID of the system assigned identity. This property will + only be + + provided for a system assigned identity.' + name: tenant_id + types: + - +- description: 'Required. Type of managed service identity (where both SystemAssigned + and + + UserAssigned types are allowed). Possible values include: "None", "SystemAssigned", + + "UserAssigned", "SystemAssigned,UserAssigned".' + name: type + types: + - + - +- description: '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.' + name: user_assigned_identities + types: + - [, ] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedServiceIdentityType.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedServiceIdentityType.yml new file mode 100644 index 00000000..74f80d60 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedServiceIdentityType.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.app.models.ManagedServiceIdentityType +name: ManagedServiceIdentityType +fullName: azure.mgmt.app.models.ManagedServiceIdentityType +summary: 'Type of managed service identity (where both SystemAssigned and UserAssigned + types are + + allowed).' +module: azure.mgmt.app.models +fields: +- name: NONE + uid: azure.mgmt.app.models.ManagedServiceIdentityType.NONE +- name: SYSTEM_ASSIGNED + uid: azure.mgmt.app.models.ManagedServiceIdentityType.SYSTEM_ASSIGNED +- name: SYSTEM_ASSIGNED_USER_ASSIGNED + uid: azure.mgmt.app.models.ManagedServiceIdentityType.SYSTEM_ASSIGNED_USER_ASSIGNED +- name: USER_ASSIGNED + uid: azure.mgmt.app.models.ManagedServiceIdentityType.USER_ASSIGNED diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Nonce.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Nonce.yml new file mode 100644 index 00000000..0eaf3541 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Nonce.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.Nonce +name: Nonce +fullName: azure.mgmt.app.models.Nonce +module: azure.mgmt.app.models +summary: The configuration settings of the nonce used in the login flow. +constructor: + syntax: 'Nonce(*, validate_nonce: bool | None = None, nonce_expiration_interval: + str | None = None, **kwargs)' + keywordOnlyParameters: + - name: validate_nonce + description: '`false` if the nonce should not be validated while + + completing the login flow; otherwise, `true`.' + types: + - + - name: nonce_expiration_interval + description: 'The time after the request is made when the nonce should + + expire.' + types: + - +variables: +- description: '`false` if the nonce should not be validated while + + completing the login flow; otherwise, `true`.' + name: validate_nonce + types: + - +- description: 'The time after the request is made when the nonce should + + expire.' + name: nonce_expiration_interval + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectClientCredential.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectClientCredential.yml new file mode 100644 index 00000000..151b54d8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectClientCredential.yml @@ -0,0 +1,37 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.OpenIdConnectClientCredential +name: OpenIdConnectClientCredential +fullName: azure.mgmt.app.models.OpenIdConnectClientCredential +module: azure.mgmt.app.models +summary: The authentication client credentials of the custom Open ID Connect provider. +constructor: + syntax: 'OpenIdConnectClientCredential(*, method: str | None = None, client_secret_setting_name: + str | None = None, **kwargs)' + keywordOnlyParameters: + - name: method + description: 'The method that should be used to authenticate the user. The only + acceptable + + values to pass in are None and "ClientSecretPost". The default value is None.' + types: + - + - name: client_secret_setting_name + description: 'The app setting that contains the client secret for the + + custom Open ID Connect provider.' + types: + - +variables: +- description: 'The method that should be used to authenticate the user. The only + acceptable + + values to pass in are None and "ClientSecretPost". The default value is None.' + name: method + types: + - +- description: 'The app setting that contains the client secret for the + + custom Open ID Connect provider.' + name: client_secret_setting_name + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectConfig.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectConfig.yml new file mode 100644 index 00000000..0944cd8a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectConfig.yml @@ -0,0 +1,59 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.OpenIdConnectConfig +name: OpenIdConnectConfig +fullName: azure.mgmt.app.models.OpenIdConnectConfig +module: azure.mgmt.app.models +summary: The configuration settings of the endpoints used for the custom Open ID Connect + provider. +constructor: + syntax: 'OpenIdConnectConfig(*, authorization_endpoint: str | None = None, token_endpoint: + str | None = None, issuer: str | None = None, certification_uri: str | None = + None, well_known_open_id_configuration: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: authorization_endpoint + description: The endpoint to be used to make an authorization request. + types: + - + - name: token_endpoint + description: The endpoint to be used to request a token. + types: + - + - name: issuer + description: The endpoint that issues the token. + types: + - + - name: certification_uri + description: 'The endpoint that provides the keys necessary to validate the + + token.' + types: + - + - name: well_known_open_id_configuration + description: 'The endpoint that contains all the configuration + + endpoints for the provider.' + types: + - +variables: +- description: The endpoint to be used to make an authorization request. + name: authorization_endpoint + types: + - +- description: The endpoint to be used to request a token. + name: token_endpoint + types: + - +- description: The endpoint that issues the token. + name: issuer + types: + - +- description: The endpoint that provides the keys necessary to validate the token. + name: certification_uri + types: + - +- description: 'The endpoint that contains all the configuration + + endpoints for the provider.' + name: well_known_open_id_configuration + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectLogin.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectLogin.yml new file mode 100644 index 00000000..a556ff9e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectLogin.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.OpenIdConnectLogin +name: OpenIdConnectLogin +fullName: azure.mgmt.app.models.OpenIdConnectLogin +module: azure.mgmt.app.models +summary: The configuration settings of the login flow of the custom Open ID Connect + provider. +constructor: + syntax: 'OpenIdConnectLogin(*, name_claim_type: str | None = None, scopes: List[str] + | None = None, **kwargs)' + keywordOnlyParameters: + - name: name_claim_type + description: The name of the claim that contains the users name. + types: + - + - name: scopes + description: A list of the scopes that should be requested while authenticating. + types: + - [] +variables: +- description: The name of the claim that contains the users name. + name: name_claim_type + types: + - +- description: A list of the scopes that should be requested while authenticating. + name: scopes + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectRegistration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectRegistration.yml new file mode 100644 index 00000000..e7f52517 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectRegistration.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.OpenIdConnectRegistration +name: OpenIdConnectRegistration +fullName: azure.mgmt.app.models.OpenIdConnectRegistration +module: azure.mgmt.app.models +summary: The configuration settings of the app registration for the custom Open ID + Connect provider. +constructor: + syntax: 'OpenIdConnectRegistration(*, client_id: str | None = None, client_credential: + OpenIdConnectClientCredential | None = None, open_id_connect_configuration: OpenIdConnectConfig + | None = None, **kwargs)' + keywordOnlyParameters: + - name: client_id + description: The client id of the custom Open ID Connect provider. + types: + - + - name: client_credential + description: 'The authentication credentials of the custom Open ID Connect + + provider.' + types: + - + - name: open_id_connect_configuration + description: 'The configuration settings of the endpoints used for + + the custom Open ID Connect provider.' + types: + - +variables: +- description: The client id of the custom Open ID Connect provider. + name: client_id + types: + - +- description: The authentication credentials of the custom Open ID Connect provider. + name: client_credential + types: + - +- description: 'The configuration settings of the endpoints used for the + + custom Open ID Connect provider.' + name: open_id_connect_configuration + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OperationDetail.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OperationDetail.yml new file mode 100644 index 00000000..03637368 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OperationDetail.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.OperationDetail +name: OperationDetail +fullName: azure.mgmt.app.models.OperationDetail +module: azure.mgmt.app.models +summary: Operation detail payload. +constructor: + syntax: 'OperationDetail(*, name: str | None = None, is_data_action: bool | None + = None, display: OperationDisplay | None = None, origin: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Name of the operation. + types: + - + - name: is_data_action + description: Indicates whether the operation is a data action. + types: + - + - name: display + description: Display of the operation. + types: + - + - name: origin + description: Origin of the operation. + types: + - +variables: +- description: Name of the operation. + name: name + types: + - +- description: Indicates whether the operation is a data action. + name: is_data_action + types: + - +- description: Display of the operation. + name: display + types: + - +- description: Origin of the operation. + name: origin + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OperationDisplay.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OperationDisplay.yml new file mode 100644 index 00000000..31453446 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OperationDisplay.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.OperationDisplay +name: OperationDisplay +fullName: azure.mgmt.app.models.OperationDisplay +module: azure.mgmt.app.models +summary: Operation display payload. +constructor: + syntax: 'OperationDisplay(*, provider: str | None = None, resource: str | None = + None, operation: str | None = None, description: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: provider + description: Resource provider of the operation. + types: + - + - name: resource + description: Resource of the operation. + types: + - + - name: operation + description: Localized friendly name for the operation. + types: + - + - name: description + description: Localized friendly description for the operation. + types: + - +variables: +- description: Resource provider of the operation. + name: provider + types: + - +- description: Resource of the operation. + name: resource + types: + - +- description: Localized friendly name for the operation. + name: operation + types: + - +- description: Localized friendly description for the operation. + name: description + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ProxyResource.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ProxyResource.yml new file mode 100644 index 00000000..17ad183d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ProxyResource.yml @@ -0,0 +1,36 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.ProxyResource +name: ProxyResource +fullName: azure.mgmt.app.models.ProxyResource +module: azure.mgmt.app.models +summary: 'The resource model definition for a Azure Resource Manager proxy resource. + It will not have tags and a location. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: ProxyResource(**kwargs) +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.QueueScaleRule.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.QueueScaleRule.yml new file mode 100644 index 00000000..f8a31ead --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.QueueScaleRule.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.QueueScaleRule +name: QueueScaleRule +fullName: azure.mgmt.app.models.QueueScaleRule +module: azure.mgmt.app.models +summary: Container App container Azure Queue based scaling rule. +constructor: + syntax: 'QueueScaleRule(*, queue_name: str | None = None, queue_length: int | None + = None, auth: List[ScaleRuleAuth] | None = None, **kwargs)' + keywordOnlyParameters: + - name: queue_name + description: Queue name. + types: + - + - name: queue_length + description: Queue length. + types: + - + - name: auth + description: Authentication secrets for the queue scale rule. + types: + - [] +variables: +- description: Queue name. + name: queue_name + types: + - +- description: Queue length. + name: queue_length + types: + - +- description: Authentication secrets for the queue scale rule. + name: auth + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RegistryCredentials.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RegistryCredentials.yml new file mode 100644 index 00000000..262046e8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RegistryCredentials.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.RegistryCredentials +name: RegistryCredentials +fullName: azure.mgmt.app.models.RegistryCredentials +module: azure.mgmt.app.models +summary: Container App Private Registry. +constructor: + syntax: 'RegistryCredentials(*, server: str | None = None, username: str | None + = None, password_secret_ref: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: server + description: Container Registry Server. + types: + - + - name: username + description: Container Registry Username. + types: + - + - name: password_secret_ref + description: The name of the Secret that contains the registry login password. + types: + - +variables: +- description: Container Registry Server. + name: server + types: + - +- description: Container Registry Username. + name: username + types: + - +- description: The name of the Secret that contains the registry login password. + name: password_secret_ref + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RegistryInfo.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RegistryInfo.yml new file mode 100644 index 00000000..4226feb5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RegistryInfo.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.RegistryInfo +name: RegistryInfo +fullName: azure.mgmt.app.models.RegistryInfo +module: azure.mgmt.app.models +summary: Container App registry information. +constructor: + syntax: 'RegistryInfo(*, registry_url: str | None = None, registry_user_name: str + | None = None, registry_password: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: registry_url + description: registry server Url. + types: + - + - name: registry_user_name + description: registry username. + types: + - + - name: registry_password + description: registry secret. + types: + - +variables: +- description: registry server Url. + name: registry_url + types: + - +- description: registry username. + name: registry_user_name + types: + - +- description: registry secret. + name: registry_password + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Replica.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Replica.yml new file mode 100644 index 00000000..b6c83fb2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Replica.yml @@ -0,0 +1,48 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.Replica +name: Replica +fullName: azure.mgmt.app.models.Replica +module: azure.mgmt.app.models +summary: 'Container App Revision Replica. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'Replica(*, containers: List[ReplicaContainer] | None = None, **kwargs)' + keywordOnlyParameters: + - name: containers + description: The containers collection under a replica. + types: + - [] +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: Timestamp describing when the pod was created by controller. + name: created_time + types: + - +- description: The containers collection under a replica. + name: containers + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ReplicaCollection.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ReplicaCollection.yml new file mode 100644 index 00000000..0fa0e0eb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ReplicaCollection.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.ReplicaCollection +name: ReplicaCollection +fullName: azure.mgmt.app.models.ReplicaCollection +module: azure.mgmt.app.models +summary: 'Container App Revision Replicas collection ARM resource. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ReplicaCollection(*, value: List[Replica], **kwargs)' + keywordOnlyParameters: + - name: value + description: Required. Collection of resources. + types: + - [] +variables: +- description: Required. Collection of resources. + name: value + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ReplicaContainer.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ReplicaContainer.yml new file mode 100644 index 00000000..ee918a50 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ReplicaContainer.yml @@ -0,0 +1,52 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.ReplicaContainer +name: ReplicaContainer +fullName: azure.mgmt.app.models.ReplicaContainer +module: azure.mgmt.app.models +summary: Container object under Container App Revision Replica. +constructor: + syntax: 'ReplicaContainer(*, name: str | None = None, container_id: str | None = + None, ready: bool | None = None, started: bool | None = None, restart_count: int + | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: The Name of the Container. + types: + - + - name: container_id + description: The Id of the Container. + types: + - + - name: ready + description: The container ready status. + types: + - + - name: started + description: The container start status. + types: + - + - name: restart_count + description: The container restart count. + types: + - +variables: +- description: The Name of the Container. + name: name + types: + - +- description: The Id of the Container. + name: container_id + types: + - +- description: The container ready status. + name: ready + types: + - +- description: The container start status. + name: started + types: + - +- description: The container restart count. + name: restart_count + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Resource.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Resource.yml new file mode 100644 index 00000000..b6ee3f07 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Resource.yml @@ -0,0 +1,36 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.Resource +name: Resource +fullName: azure.mgmt.app.models.Resource +module: azure.mgmt.app.models +summary: 'Common fields that are returned in the response for all Azure Resource Manager + resources. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: Resource(**kwargs) +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Revision.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Revision.yml new file mode 100644 index 00000000..3069a1b6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Revision.yml @@ -0,0 +1,83 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.Revision +name: Revision +fullName: azure.mgmt.app.models.Revision +module: azure.mgmt.app.models +summary: 'Container App Revision. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: Revision(**kwargs) +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: 'Timestamp describing when the revision was created + + by controller.' + name: created_time + types: + - +- description: Fully qualified domain name of the revision. + name: fqdn + types: + - +- description: 'Container App Revision Template with all possible settings and the + + defaults if user did not provide them. The defaults are populated + + as they were at the creation time.' + name: template + types: + - +- description: Boolean describing if the Revision is Active. + name: active + types: + - +- description: Number of pods currently running for this revision. + name: replicas + types: + - +- description: Traffic weight assigned to this revision. + name: traffic_weight + types: + - +- description: Optional Field - Platform Error Message. + name: provisioning_error + types: + - +- description: 'Current health State of the revision. Possible values include: "Healthy", + + "Unhealthy", "None".' + name: health_state + types: + - + - +- description: 'Current provisioning State of the revision. Possible values include: + + "Provisioning", "Provisioned", "Failed", "Deprovisioning", "Deprovisioned".' + name: provisioning_state + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RevisionCollection.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RevisionCollection.yml new file mode 100644 index 00000000..a20e6474 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RevisionCollection.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.RevisionCollection +name: RevisionCollection +fullName: azure.mgmt.app.models.RevisionCollection +module: azure.mgmt.app.models +summary: 'Container App Revisions collection ARM resource. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RevisionCollection(*, value: List[Revision], **kwargs)' + keywordOnlyParameters: + - name: value + description: Required. Collection of resources. + types: + - [] +variables: +- description: Required. Collection of resources. + name: value + types: + - [] +- description: Link to next page of resources. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RevisionHealthState.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RevisionHealthState.yml new file mode 100644 index 00000000..dd139e7e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RevisionHealthState.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.app.models.RevisionHealthState +name: RevisionHealthState +fullName: azure.mgmt.app.models.RevisionHealthState +summary: Current health State of the revision +module: azure.mgmt.app.models +fields: +- name: HEALTHY + uid: azure.mgmt.app.models.RevisionHealthState.HEALTHY +- name: NONE + uid: azure.mgmt.app.models.RevisionHealthState.NONE +- name: UNHEALTHY + uid: azure.mgmt.app.models.RevisionHealthState.UNHEALTHY diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RevisionProvisioningState.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RevisionProvisioningState.yml new file mode 100644 index 00000000..b0bb771e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RevisionProvisioningState.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.app.models.RevisionProvisioningState +name: RevisionProvisioningState +fullName: azure.mgmt.app.models.RevisionProvisioningState +summary: Current provisioning State of the revision +module: azure.mgmt.app.models +fields: +- name: DEPROVISIONED + uid: azure.mgmt.app.models.RevisionProvisioningState.DEPROVISIONED +- name: DEPROVISIONING + uid: azure.mgmt.app.models.RevisionProvisioningState.DEPROVISIONING +- name: FAILED + uid: azure.mgmt.app.models.RevisionProvisioningState.FAILED +- name: PROVISIONED + uid: azure.mgmt.app.models.RevisionProvisioningState.PROVISIONED +- name: PROVISIONING + uid: azure.mgmt.app.models.RevisionProvisioningState.PROVISIONING diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Scale.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Scale.yml new file mode 100644 index 00000000..c18c6e86 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Scale.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.Scale +name: Scale +fullName: azure.mgmt.app.models.Scale +module: azure.mgmt.app.models +summary: Container App scaling configurations. +constructor: + syntax: 'Scale(*, min_replicas: int | None = None, max_replicas: int | None = None, + rules: List[ScaleRule] | None = None, **kwargs)' + keywordOnlyParameters: + - name: min_replicas + description: Optional. Minimum number of container replicas. + types: + - + - name: max_replicas + description: 'Optional. Maximum number of container replicas. Defaults to 10 if + not + + set.' + types: + - + - name: rules + description: Scaling rules. + types: + - [] +variables: +- description: Optional. Minimum number of container replicas. + name: min_replicas + types: + - +- description: Optional. Maximum number of container replicas. Defaults to 10 if not + set. + name: max_replicas + types: + - +- description: Scaling rules. + name: rules + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ScaleRule.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ScaleRule.yml new file mode 100644 index 00000000..ffef4e5c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ScaleRule.yml @@ -0,0 +1,44 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.ScaleRule +name: ScaleRule +fullName: azure.mgmt.app.models.ScaleRule +module: azure.mgmt.app.models +summary: Container App container scaling rule. +constructor: + syntax: 'ScaleRule(*, name: str | None = None, azure_queue: QueueScaleRule | None + = None, custom: CustomScaleRule | None = None, http: HttpScaleRule | None = None, + **kwargs)' + keywordOnlyParameters: + - name: name + description: Scale Rule Name. + types: + - + - name: azure_queue + description: Azure Queue based scaling. + types: + - + - name: custom + description: Custom scale rule. + types: + - + - name: http + description: HTTP requests based scaling. + types: + - +variables: +- description: Scale Rule Name. + name: name + types: + - +- description: Azure Queue based scaling. + name: azure_queue + types: + - +- description: Custom scale rule. + name: custom + types: + - +- description: HTTP requests based scaling. + name: http + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ScaleRuleAuth.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ScaleRuleAuth.yml new file mode 100644 index 00000000..2f37e630 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ScaleRuleAuth.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.ScaleRuleAuth +name: ScaleRuleAuth +fullName: azure.mgmt.app.models.ScaleRuleAuth +module: azure.mgmt.app.models +summary: Auth Secrets for Container App Scale Rule. +constructor: + syntax: 'ScaleRuleAuth(*, secret_ref: str | None = None, trigger_parameter: str + | None = None, **kwargs)' + keywordOnlyParameters: + - name: secret_ref + description: Name of the Container App secret from which to pull the auth params. + types: + - + - name: trigger_parameter + description: Trigger Parameter that uses the secret. + types: + - +variables: +- description: Name of the Container App secret from which to pull the auth params. + name: secret_ref + types: + - +- description: Trigger Parameter that uses the secret. + name: trigger_parameter + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Secret.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Secret.yml new file mode 100644 index 00000000..1c69cbf9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Secret.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.Secret +name: Secret +fullName: azure.mgmt.app.models.Secret +module: azure.mgmt.app.models +summary: Secret definition. +constructor: + syntax: 'Secret(*, name: str | None = None, value: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Secret Name. + types: + - + - name: value + description: Secret Value. + types: + - +variables: +- description: Secret Name. + name: name + types: + - +- description: Secret Value. + name: value + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SecretsCollection.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SecretsCollection.yml new file mode 100644 index 00000000..eec364fe --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SecretsCollection.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.SecretsCollection +name: SecretsCollection +fullName: azure.mgmt.app.models.SecretsCollection +module: azure.mgmt.app.models +summary: 'Container App Secrets Collection ARM resource. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SecretsCollection(*, value: List[ContainerAppSecret], **kwargs)' + keywordOnlyParameters: + - name: value + description: Required. Collection of resources. + types: + - [] +variables: +- description: Required. Collection of resources. + name: value + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SourceControl.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SourceControl.yml new file mode 100644 index 00000000..e337e61a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SourceControl.yml @@ -0,0 +1,80 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.SourceControl +name: SourceControl +fullName: azure.mgmt.app.models.SourceControl +module: azure.mgmt.app.models +summary: 'Container App SourceControl. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'SourceControl(*, repo_url: str | None = None, branch: str | None = None, + github_action_configuration: GithubActionConfiguration | None = None, **kwargs)' + keywordOnlyParameters: + - name: repo_url + description: The repo url which will be integrated to ContainerApp. + types: + - + - name: branch + description: The branch which will trigger the auto deployment. + types: + - + - name: github_action_configuration + description: 'Container App Revision Template with all possible + + settings and the + + defaults if user did not provide them. The defaults are populated + + as they were at the creation time.' + types: + - +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: 'Current provisioning State of the operation. Possible values include: + + "InProgress", "Succeeded", "Failed", "Canceled".' + name: operation_state + types: + - + - +- description: The repo url which will be integrated to ContainerApp. + name: repo_url + types: + - +- description: The branch which will trigger the auto deployment. + name: branch + types: + - +- description: 'Container App Revision Template with all possible settings + + and the + + defaults if user did not provide them. The defaults are populated + + as they were at the creation time.' + name: github_action_configuration + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SourceControlCollection.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SourceControlCollection.yml new file mode 100644 index 00000000..9fdc4c92 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SourceControlCollection.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.SourceControlCollection +name: SourceControlCollection +fullName: azure.mgmt.app.models.SourceControlCollection +module: azure.mgmt.app.models +summary: 'SourceControl collection ARM resource. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SourceControlCollection(*, value: List[SourceControl], **kwargs)' + keywordOnlyParameters: + - name: value + description: Required. Collection of resources. + types: + - [] +variables: +- description: Required. Collection of resources. + name: value + types: + - [] +- description: Link to next page of resources. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SourceControlOperationState.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SourceControlOperationState.yml new file mode 100644 index 00000000..65db84a5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SourceControlOperationState.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.app.models.SourceControlOperationState +name: SourceControlOperationState +fullName: azure.mgmt.app.models.SourceControlOperationState +summary: Current provisioning State of the operation +module: azure.mgmt.app.models +fields: +- name: CANCELED + uid: azure.mgmt.app.models.SourceControlOperationState.CANCELED +- name: FAILED + uid: azure.mgmt.app.models.SourceControlOperationState.FAILED +- name: IN_PROGRESS + uid: azure.mgmt.app.models.SourceControlOperationState.IN_PROGRESS +- name: SUCCEEDED + uid: azure.mgmt.app.models.SourceControlOperationState.SUCCEEDED diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.StorageType.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.StorageType.yml new file mode 100644 index 00000000..78cf5232 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.StorageType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.app.models.StorageType +name: StorageType +fullName: azure.mgmt.app.models.StorageType +summary: Storage type for the volume. If not provided, use EmptyDir. +module: azure.mgmt.app.models +fields: +- name: AZURE_FILE + uid: azure.mgmt.app.models.StorageType.AZURE_FILE +- name: EMPTY_DIR + uid: azure.mgmt.app.models.StorageType.EMPTY_DIR diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SystemData.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SystemData.yml new file mode 100644 index 00000000..8b2f80c7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SystemData.yml @@ -0,0 +1,73 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.SystemData +name: SystemData +fullName: azure.mgmt.app.models.SystemData +module: azure.mgmt.app.models +summary: Metadata pertaining to creation and last modification of the resource. +constructor: + syntax: 'SystemData(*, created_by: str | None = None, created_by_type: str | CreatedByType + | None = None, created_at: datetime | None = None, last_modified_by: str | None + = None, last_modified_by_type: str | CreatedByType | None = None, last_modified_at: + datetime | None = None, **kwargs)' + keywordOnlyParameters: + - name: created_by + description: The identity that created the resource. + types: + - + - name: created_by_type + description: 'The type of identity that created the resource. Possible values + + include: "User", "Application", "ManagedIdentity", "Key".' + types: + - + - + - name: created_at + description: The timestamp of resource creation (UTC). + types: + - + - name: last_modified_by + description: The identity that last modified the resource. + types: + - + - name: last_modified_by_type + description: 'The type of identity that last modified the resource. Possible + + values include: "User", "Application", "ManagedIdentity", "Key".' + types: + - + - + - name: last_modified_at + description: The timestamp of resource last modification (UTC). + types: + - +variables: +- description: The identity that created the resource. + name: created_by + types: + - +- description: 'The type of identity that created the resource. Possible values include: + + "User", "Application", "ManagedIdentity", "Key".' + name: created_by_type + types: + - + - +- description: The timestamp of resource creation (UTC). + name: created_at + types: + - +- description: The identity that last modified the resource. + name: last_modified_by + types: + - +- description: 'The type of identity that last modified the resource. Possible + + values include: "User", "Application", "ManagedIdentity", "Key".' + name: last_modified_by_type + types: + - + - +- description: The timestamp of resource last modification (UTC). + name: last_modified_at + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Template.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Template.yml new file mode 100644 index 00000000..3687b711 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Template.yml @@ -0,0 +1,36 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.Template +name: Template +fullName: azure.mgmt.app.models.Template +module: azure.mgmt.app.models +summary: "Container App versioned application definition.\nDefines the desired state\ + \ of an immutable revision.\nAny changes to this section Will result in a new revision\ + \ being created.\n\n ivar revision_suffix:\n User friendly suffix that is\ + \ appended to the revision name.\n\n vartype revision_suffix:\n str\n\n \ + \ ivar containers:\n List of container definitions for the Container App.\n\ + \n vartype containers:\n list[~container_apps_api_client.models.Container]\n\ + \n ivar scale:\n Scaling properties for the Container App.\n\n vartype\ + \ scale:\n ~container_apps_api_client.models.Scale\n\n ivar volumes:\n \ + \ List of volume definitions for the Container App.\n\n vartype volumes:\n\ + \ list[~container_apps_api_client.models.Volume]" +constructor: + syntax: 'Template(*, revision_suffix: str | None = None, containers: List[Container] + | None = None, scale: Scale | None = None, volumes: List[Volume] | None = None, + **kwargs)' + keywordOnlyParameters: + - name: revision_suffix + description: User friendly suffix that is appended to the revision name. + types: + - + - name: containers + description: List of container definitions for the Container App. + types: + - [] + - name: scale + description: Scaling properties for the Container App. + types: + - + - name: volumes + description: List of volume definitions for the Container App. + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TrackedResource.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TrackedResource.yml new file mode 100644 index 00000000..7c75b6a1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TrackedResource.yml @@ -0,0 +1,56 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.TrackedResource +name: TrackedResource +fullName: azure.mgmt.app.models.TrackedResource +module: azure.mgmt.app.models +summary: 'The resource model definition for an Azure Resource Manager tracked top + level resource which has ''tags'' and a ''location''. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TrackedResource(*, location: str, tags: Dict[str, str] | None = None, **kwargs)' + keywordOnlyParameters: + - name: tags + description: A set of tags. Resource tags. + types: + - [, ] + - name: location + description: Required. The geo-location where the resource lives. + types: + - +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: A set of tags. Resource tags. + name: tags + types: + - [, ] +- description: Required. The geo-location where the resource lives. + name: location + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TrafficWeight.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TrafficWeight.yml new file mode 100644 index 00000000..3403353e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TrafficWeight.yml @@ -0,0 +1,37 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.TrafficWeight +name: TrafficWeight +fullName: azure.mgmt.app.models.TrafficWeight +module: azure.mgmt.app.models +summary: Traffic weight assigned to a revision. +constructor: + syntax: 'TrafficWeight(*, revision_name: str | None = None, weight: int | None = + None, latest_revision: bool | None = False, **kwargs)' + keywordOnlyParameters: + - name: revision_name + description: Name of a revision. + types: + - + - name: weight + description: Traffic weight assigned to a revision. + types: + - + - name: latest_revision + description: 'Indicates that the traffic weight belongs to a latest stable + + revision.' + types: + - +variables: +- description: Name of a revision. + name: revision_name + types: + - +- description: Traffic weight assigned to a revision. + name: weight + types: + - +- description: Indicates that the traffic weight belongs to a latest stable revision. + name: latest_revision + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Twitter.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Twitter.yml new file mode 100644 index 00000000..4c88560a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Twitter.yml @@ -0,0 +1,36 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.Twitter +name: Twitter +fullName: azure.mgmt.app.models.Twitter +module: azure.mgmt.app.models +summary: The configuration settings of the Twitter provider. +constructor: + syntax: 'Twitter(*, enabled: bool | None = None, registration: TwitterRegistration + | None = None, **kwargs)' + keywordOnlyParameters: + - name: enabled + description: '`false` if the Twitter provider should not be enabled + + despite the set registration; otherwise, `true`.' + types: + - + - name: registration + description: 'The configuration settings of the app registration for the Twitter + + provider.' + types: + - +variables: +- description: '`false` if the Twitter provider should not be enabled + despite + + the set registration; otherwise, `true`.' + name: enabled + types: + - +- description: 'The configuration settings of the app registration for the Twitter + + provider.' + name: registration + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TwitterRegistration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TwitterRegistration.yml new file mode 100644 index 00000000..7107c74e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TwitterRegistration.yml @@ -0,0 +1,44 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.TwitterRegistration +name: TwitterRegistration +fullName: azure.mgmt.app.models.TwitterRegistration +module: azure.mgmt.app.models +summary: The configuration settings of the app registration for the Twitter provider. +constructor: + syntax: 'TwitterRegistration(*, consumer_key: str | None = None, consumer_secret_setting_name: + str | None = None, **kwargs)' + keywordOnlyParameters: + - name: consumer_key + description: 'The OAuth 1.0a consumer key of the Twitter application used for + sign-in. + + This setting is required for enabling Twitter Sign-In. + + Twitter Sign-In documentation: [https://dev.twitter.com/web/sign-in](https://dev.twitter.com/web/sign-in).' + types: + - + - name: consumer_secret_setting_name + description: 'The app setting name that contains the OAuth 1.0a + + consumer secret of the Twitter + + application used for sign-in.' + types: + - +variables: +- description: 'The OAuth 1.0a consumer key of the Twitter application used for sign-in. + + This setting is required for enabling Twitter Sign-In. + + Twitter Sign-In documentation: [https://dev.twitter.com/web/sign-in](https://dev.twitter.com/web/sign-in).' + name: consumer_key + types: + - +- description: 'The app setting name that contains the OAuth 1.0a consumer + + secret of the Twitter + + application used for sign-in.' + name: consumer_secret_setting_name + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Type.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Type.yml new file mode 100644 index 00000000..fb2316b9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Type.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.app.models.Type +name: Type +fullName: azure.mgmt.app.models.Type +summary: The type of probe. +module: azure.mgmt.app.models +fields: +- name: LIVENESS + uid: azure.mgmt.app.models.Type.LIVENESS +- name: READINESS + uid: azure.mgmt.app.models.Type.READINESS +- name: STARTUP + uid: azure.mgmt.app.models.Type.STARTUP diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.UnauthenticatedClientActionV2.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.UnauthenticatedClientActionV2.yml new file mode 100644 index 00000000..4680b083 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.UnauthenticatedClientActionV2.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.app.models.UnauthenticatedClientActionV2 +name: UnauthenticatedClientActionV2 +fullName: azure.mgmt.app.models.UnauthenticatedClientActionV2 +summary: The action to take when an unauthenticated client attempts to access the + app. +module: azure.mgmt.app.models +fields: +- name: ALLOW_ANONYMOUS + uid: azure.mgmt.app.models.UnauthenticatedClientActionV2.ALLOW_ANONYMOUS +- name: REDIRECT_TO_LOGIN_PAGE + uid: azure.mgmt.app.models.UnauthenticatedClientActionV2.REDIRECT_TO_LOGIN_PAGE +- name: RETURN401 + uid: azure.mgmt.app.models.UnauthenticatedClientActionV2.RETURN401 +- name: RETURN403 + uid: azure.mgmt.app.models.UnauthenticatedClientActionV2.RETURN403 diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.UserAssignedIdentity.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.UserAssignedIdentity.yml new file mode 100644 index 00000000..0dabb5f4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.UserAssignedIdentity.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.UserAssignedIdentity +name: UserAssignedIdentity +fullName: azure.mgmt.app.models.UserAssignedIdentity +module: azure.mgmt.app.models +summary: 'User assigned identity properties. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: UserAssignedIdentity(**kwargs) +variables: +- description: The principal ID of the assigned identity. + name: principal_id + types: + - +- description: The client ID of the assigned identity. + name: client_id + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.VnetConfiguration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.VnetConfiguration.yml new file mode 100644 index 00000000..cb562565 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.VnetConfiguration.yml @@ -0,0 +1,101 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.VnetConfiguration +name: VnetConfiguration +fullName: azure.mgmt.app.models.VnetConfiguration +module: azure.mgmt.app.models +summary: Configuration properties for apps environment to join a Virtual Network. +constructor: + syntax: 'VnetConfiguration(*, internal: bool | None = None, infrastructure_subnet_id: + str | None = None, runtime_subnet_id: str | None = None, docker_bridge_cidr: str + | None = None, platform_reserved_cidr: str | None = None, platform_reserved_dns_ip: + str | None = None, **kwargs)' + keywordOnlyParameters: + - name: internal + description: 'Boolean indicating the environment only has an internal load balancer. + These + + environments do not have a public static IP resource, must provide ControlPlaneSubnetResourceId + + and AppSubnetResourceId if enabling this property.' + types: + - + - name: infrastructure_subnet_id + description: 'Resource ID of a subnet for infrastructure components. This + + subnet must be in the same VNET as the subnet defined in runtimeSubnetId. Must + not overlap with + + any other provided IP ranges.' + types: + - + - name: runtime_subnet_id + description: 'Resource ID of a subnet that Container App containers are injected + + into. This subnet must be in the same VNET as the subnet defined in infrastructureSubnetId. + + Must not overlap with any other provided IP ranges.' + types: + - + - name: docker_bridge_cidr + description: 'CIDR notation IP range assigned to the Docker bridge, network. + + Must not overlap with any other provided IP ranges.' + types: + - + - name: platform_reserved_cidr + description: 'IP range in CIDR notation that can be reserved for environment + + infrastructure IP addresses. Must not overlap with any other provided IP ranges.' + types: + - + - name: platform_reserved_dns_ip + description: 'An IP address from the IP range defined by + + platformReservedCidr that will be reserved for the internal DNS server.' + types: + - +variables: +- description: 'Boolean indicating the environment only has an internal load balancer. + These + + environments do not have a public static IP resource, must provide ControlPlaneSubnetResourceId + + and AppSubnetResourceId if enabling this property.' + name: internal + types: + - +- description: 'Resource ID of a subnet for infrastructure components. This + + subnet must be in the same VNET as the subnet defined in runtimeSubnetId. Must + not overlap with + + any other provided IP ranges.' + name: infrastructure_subnet_id + types: + - +- description: 'Resource ID of a subnet that Container App containers are injected + + into. This subnet must be in the same VNET as the subnet defined in infrastructureSubnetId. + + Must not overlap with any other provided IP ranges.' + name: runtime_subnet_id + types: + - +- description: 'CIDR notation IP range assigned to the Docker bridge, network. Must + + not overlap with any other provided IP ranges.' + name: docker_bridge_cidr + types: + - +- description: 'IP range in CIDR notation that can be reserved for environment + + infrastructure IP addresses. Must not overlap with any other provided IP ranges.' + name: platform_reserved_cidr + types: + - +- description: 'An IP address from the IP range defined by platformReservedCidr + + that will be reserved for the internal DNS server.' + name: platform_reserved_dns_ip + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Volume.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Volume.yml new file mode 100644 index 00000000..9b95e210 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Volume.yml @@ -0,0 +1,42 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.Volume +name: Volume +fullName: azure.mgmt.app.models.Volume +module: azure.mgmt.app.models +summary: Volume definitions for the Container App. +constructor: + syntax: 'Volume(*, name: str | None = None, storage_type: str | StorageType | None + = None, storage_name: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Volume name. + types: + - + - name: storage_type + description: 'Storage type for the volume. If not provided, use EmptyDir. Possible + + values include: "AzureFile", "EmptyDir".' + types: + - + - + - name: storage_name + description: Name of storage resource. No need to provide for EmptyDir. + types: + - +variables: +- description: Volume name. + name: name + types: + - +- description: 'Storage type for the volume. If not provided, use EmptyDir. Possible + values + + include: "AzureFile", "EmptyDir".' + name: storage_type + types: + - + - +- description: Name of storage resource. No need to provide for EmptyDir. + name: storage_name + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.VolumeMount.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.VolumeMount.yml new file mode 100644 index 00000000..799c8894 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.VolumeMount.yml @@ -0,0 +1,33 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.models.VolumeMount +name: VolumeMount +fullName: azure.mgmt.app.models.VolumeMount +module: azure.mgmt.app.models +summary: Volume mount for the Container App. +constructor: + syntax: 'VolumeMount(*, volume_name: str | None = None, mount_path: str | None = + None, **kwargs)' + keywordOnlyParameters: + - name: volume_name + description: This must match the Name of a Volume. + types: + - + - name: mount_path + description: 'Path within the container at which the volume should be mounted.Must + not + + contain '':''.' + types: + - +variables: +- description: This must match the Name of a Volume. + name: volume_name + types: + - +- description: 'Path within the container at which the volume should be mounted.Must + not + + contain '':''.' + name: mount_path + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.yml new file mode 100644 index 00000000..e8eac487 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.app.models +name: models +fullName: azure.mgmt.app.models +type: import +classes: +- azure.mgmt.app.models.AllowedAudiencesValidation +- azure.mgmt.app.models.AllowedPrincipals +- azure.mgmt.app.models.AppLogsConfiguration +- azure.mgmt.app.models.AppRegistration +- azure.mgmt.app.models.Apple +- azure.mgmt.app.models.AppleRegistration +- azure.mgmt.app.models.AuthConfig +- azure.mgmt.app.models.AuthConfigCollection +- azure.mgmt.app.models.AuthPlatform +- azure.mgmt.app.models.AvailableOperations +- azure.mgmt.app.models.AzureActiveDirectory +- azure.mgmt.app.models.AzureActiveDirectoryLogin +- azure.mgmt.app.models.AzureActiveDirectoryRegistration +- azure.mgmt.app.models.AzureActiveDirectoryValidation +- azure.mgmt.app.models.AzureCredentials +- azure.mgmt.app.models.AzureFileProperties +- azure.mgmt.app.models.AzureStaticWebApps +- azure.mgmt.app.models.AzureStaticWebAppsRegistration +- azure.mgmt.app.models.Certificate +- azure.mgmt.app.models.CertificateCollection +- azure.mgmt.app.models.CertificatePatch +- azure.mgmt.app.models.CertificateProperties +- azure.mgmt.app.models.ClientRegistration +- azure.mgmt.app.models.Configuration +- azure.mgmt.app.models.Container +- azure.mgmt.app.models.ContainerApp +- azure.mgmt.app.models.ContainerAppCollection +- azure.mgmt.app.models.ContainerAppPatch +- azure.mgmt.app.models.ContainerAppProbe +- azure.mgmt.app.models.ContainerAppProbeHttpGet +- azure.mgmt.app.models.ContainerAppProbeHttpGetHttpHeadersItem +- azure.mgmt.app.models.ContainerAppProbeTcpSocket +- azure.mgmt.app.models.ContainerAppSecret +- azure.mgmt.app.models.ContainerResources +- azure.mgmt.app.models.CookieExpiration +- azure.mgmt.app.models.CustomDomain +- azure.mgmt.app.models.CustomHostnameAnalysisResult +- azure.mgmt.app.models.CustomOpenIdConnectProvider +- azure.mgmt.app.models.CustomScaleRule +- azure.mgmt.app.models.Dapr +- azure.mgmt.app.models.DaprComponent +- azure.mgmt.app.models.DaprComponentsCollection +- azure.mgmt.app.models.DaprMetadata +- azure.mgmt.app.models.DefaultAuthorizationPolicy +- azure.mgmt.app.models.DefaultErrorResponse +- azure.mgmt.app.models.DefaultErrorResponseError +- azure.mgmt.app.models.DefaultErrorResponseErrorDetailsItem +- azure.mgmt.app.models.EnvironmentVar +- azure.mgmt.app.models.Facebook +- azure.mgmt.app.models.ForwardProxy +- azure.mgmt.app.models.GitHub +- azure.mgmt.app.models.GithubActionConfiguration +- azure.mgmt.app.models.GlobalValidation +- azure.mgmt.app.models.Google +- azure.mgmt.app.models.HttpScaleRule +- azure.mgmt.app.models.HttpSettings +- azure.mgmt.app.models.HttpSettingsRoutes +- azure.mgmt.app.models.IdentityProviders +- azure.mgmt.app.models.Ingress +- azure.mgmt.app.models.JwtClaimChecks +- azure.mgmt.app.models.LogAnalyticsConfiguration +- azure.mgmt.app.models.Login +- azure.mgmt.app.models.LoginRoutes +- azure.mgmt.app.models.LoginScopes +- azure.mgmt.app.models.ManagedEnvironment +- azure.mgmt.app.models.ManagedEnvironmentPatch +- azure.mgmt.app.models.ManagedEnvironmentStorage +- azure.mgmt.app.models.ManagedEnvironmentStorageProperties +- azure.mgmt.app.models.ManagedEnvironmentStoragesCollection +- azure.mgmt.app.models.ManagedEnvironmentsCollection +- azure.mgmt.app.models.ManagedServiceIdentity +- azure.mgmt.app.models.Nonce +- azure.mgmt.app.models.OpenIdConnectClientCredential +- azure.mgmt.app.models.OpenIdConnectConfig +- azure.mgmt.app.models.OpenIdConnectLogin +- azure.mgmt.app.models.OpenIdConnectRegistration +- azure.mgmt.app.models.OperationDetail +- azure.mgmt.app.models.OperationDisplay +- azure.mgmt.app.models.ProxyResource +- azure.mgmt.app.models.QueueScaleRule +- azure.mgmt.app.models.RegistryCredentials +- azure.mgmt.app.models.RegistryInfo +- azure.mgmt.app.models.Replica +- azure.mgmt.app.models.ReplicaCollection +- azure.mgmt.app.models.ReplicaContainer +- azure.mgmt.app.models.Resource +- azure.mgmt.app.models.Revision +- azure.mgmt.app.models.RevisionCollection +- azure.mgmt.app.models.Scale +- azure.mgmt.app.models.ScaleRule +- azure.mgmt.app.models.ScaleRuleAuth +- azure.mgmt.app.models.Secret +- azure.mgmt.app.models.SecretsCollection +- azure.mgmt.app.models.SourceControl +- azure.mgmt.app.models.SourceControlCollection +- azure.mgmt.app.models.SystemData +- azure.mgmt.app.models.Template +- azure.mgmt.app.models.TrackedResource +- azure.mgmt.app.models.TrafficWeight +- azure.mgmt.app.models.Twitter +- azure.mgmt.app.models.TwitterRegistration +- azure.mgmt.app.models.UserAssignedIdentity +- azure.mgmt.app.models.VnetConfiguration +- azure.mgmt.app.models.Volume +- azure.mgmt.app.models.VolumeMount +enums: +- azure.mgmt.app.models.AccessMode +- azure.mgmt.app.models.ActiveRevisionsMode +- azure.mgmt.app.models.AppProtocol +- azure.mgmt.app.models.BindingType +- azure.mgmt.app.models.CertificateProvisioningState +- azure.mgmt.app.models.ContainerAppProvisioningState +- azure.mgmt.app.models.CookieExpirationConvention +- azure.mgmt.app.models.CreatedByType +- azure.mgmt.app.models.DnsVerificationTestResult +- azure.mgmt.app.models.EnvironmentProvisioningState +- azure.mgmt.app.models.ForwardProxyConvention +- azure.mgmt.app.models.IngressTransportMethod +- azure.mgmt.app.models.ManagedServiceIdentityType +- azure.mgmt.app.models.RevisionHealthState +- azure.mgmt.app.models.RevisionProvisioningState +- azure.mgmt.app.models.SourceControlOperationState +- azure.mgmt.app.models.StorageType +- azure.mgmt.app.models.Type +- azure.mgmt.app.models.UnauthenticatedClientActionV2 diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.CertificatesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.CertificatesOperations.yml new file mode 100644 index 00000000..eab35895 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.CertificatesOperations.yml @@ -0,0 +1,219 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.operations.CertificatesOperations +name: CertificatesOperations +fullName: azure.mgmt.app.operations.CertificatesOperations +module: azure.mgmt.app.operations +summary: 'CertificatesOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: CertificatesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.app.operations.CertificatesOperations.create_or_update + name: create_or_update + summary: 'Create or Update a Certificate. + + + Create or Update a Certificate.' + signature: 'create_or_update(resource_group_name: str, managed_environment_name: + str, name: str, certificate_envelope: Certificate | None = None, **kwargs: Any) + -> Certificate' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: managed_environment_name + description: Name of the Managed Environment. + isRequired: true + types: + - + - name: name + description: Name of the Certificate. + isRequired: true + types: + - + - name: certificate_envelope + description: Certificate to be created or updated. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Certificate, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.CertificatesOperations.delete + name: delete + summary: 'Deletes the specified Certificate. + + + Deletes the specified Certificate.' + signature: 'delete(resource_group_name: str, managed_environment_name: str, name: + str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: managed_environment_name + description: Name of the Managed Environment. + isRequired: true + types: + - + - name: name + description: Name of the Certificate. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.CertificatesOperations.get + name: get + summary: 'Get the specified Certificate. + + + Get the specified Certificate.' + signature: 'get(resource_group_name: str, managed_environment_name: str, name: str, + **kwargs: Any) -> Certificate' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: managed_environment_name + description: Name of the Managed Environment. + isRequired: true + types: + - + - name: name + description: Name of the Certificate. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Certificate, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.CertificatesOperations.list + name: list + summary: 'Get the Certificates in a given managed environment. + + + Get the Certificates in a given managed environment.' + signature: 'list(resource_group_name: str, managed_environment_name: str, **kwargs: + Any) -> Iterable[CertificateCollection]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: managed_environment_name + description: Name of the Managed Environment. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either CertificateCollection or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.CertificatesOperations.update + name: update + summary: 'Update properties of a certificate. + + + Patches a certificate. Currently only patching of tags is supported.' + signature: 'update(resource_group_name: str, managed_environment_name: str, name: + str, certificate_envelope: CertificatePatch, **kwargs: Any) -> Certificate' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: managed_environment_name + description: Name of the Managed Environment. + isRequired: true + types: + - + - name: name + description: Name of the Certificate. + isRequired: true + types: + - + - name: certificate_envelope + description: Properties of a certificate that need to be updated. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Certificate, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.app.operations.CertificatesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsAuthConfigsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsAuthConfigsOperations.yml new file mode 100644 index 00000000..b2dcf029 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsAuthConfigsOperations.yml @@ -0,0 +1,178 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.operations.ContainerAppsAuthConfigsOperations +name: ContainerAppsAuthConfigsOperations +fullName: azure.mgmt.app.operations.ContainerAppsAuthConfigsOperations +module: azure.mgmt.app.operations +summary: 'ContainerAppsAuthConfigsOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: ContainerAppsAuthConfigsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.app.operations.ContainerAppsAuthConfigsOperations.create_or_update + name: create_or_update + summary: 'Create or update the AuthConfig for a Container App. + + + Description for Create or update the AuthConfig for a Container App.' + signature: 'create_or_update(resource_group_name: str, container_app_name: str, + name: str, auth_config_envelope: AuthConfig, **kwargs: Any) -> AuthConfig' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: name + description: Name of the Container App AuthConfig. + isRequired: true + types: + - + - name: auth_config_envelope + description: Properties used to create a Container App AuthConfig. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AuthConfig, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ContainerAppsAuthConfigsOperations.delete + name: delete + summary: 'Delete a Container App AuthConfig. + + + Description for Delete a Container App AuthConfig.' + signature: 'delete(resource_group_name: str, container_app_name: str, name: str, + **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: name + description: Name of the Container App AuthConfig. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ContainerAppsAuthConfigsOperations.get + name: get + summary: 'Get a AuthConfig of a Container App. + + + Get a AuthConfig of a Container App.' + signature: 'get(resource_group_name: str, container_app_name: str, name: str, **kwargs: + Any) -> AuthConfig' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: name + description: Name of the Container App AuthConfig. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AuthConfig, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ContainerAppsAuthConfigsOperations.list_by_container_app + name: list_by_container_app + summary: 'Get the Container App AuthConfigs in a given resource group. + + + Get the Container App AuthConfigs in a given resource group.' + signature: 'list_by_container_app(resource_group_name: str, container_app_name: + str, **kwargs: Any) -> Iterable[AuthConfigCollection]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either AuthConfigCollection or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.app.operations.ContainerAppsAuthConfigsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsOperations.yml new file mode 100644 index 00000000..ff5e2fbc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsOperations.yml @@ -0,0 +1,323 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.operations.ContainerAppsOperations +name: ContainerAppsOperations +fullName: azure.mgmt.app.operations.ContainerAppsOperations +module: azure.mgmt.app.operations +summary: 'ContainerAppsOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: ContainerAppsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.app.operations.ContainerAppsOperations.begin_create_or_update + name: begin_create_or_update + summary: 'Create or update a Container App. + + + Description for Create or update a Container App.' + signature: 'begin_create_or_update(resource_group_name: str, name: str, container_app_envelope: + ContainerApp, **kwargs: Any) -> LROPoller[ContainerApp]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: name + description: Name of the Container App. + isRequired: true + types: + - + - name: container_app_envelope + description: Properties used to create a container app. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of LROPoller that returns either ContainerApp or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ContainerAppsOperations.begin_delete + name: begin_delete + summary: 'Delete a Container App. + + + Description for Delete a Container App.' + signature: 'begin_delete(resource_group_name: str, name: str, **kwargs: Any) -> + LROPoller[None]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: name + description: Name of the Container App. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ContainerAppsOperations.get + name: get + summary: 'Get the properties of a Container App. + + + Get the properties of a Container App.' + signature: 'get(resource_group_name: str, name: str, **kwargs: Any) -> ContainerApp' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: name + description: Name of the Container App. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ContainerApp, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ContainerAppsOperations.list_by_resource_group + name: list_by_resource_group + summary: 'Get the Container Apps in a given resource group. + + + Get the Container Apps in a given resource group.' + signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[ContainerAppCollection]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either ContainerAppCollection or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ContainerAppsOperations.list_by_subscription + name: list_by_subscription + summary: 'Get the Container Apps in a given subscription. + + + Get the Container Apps in a given subscription.' + signature: 'list_by_subscription(**kwargs: Any) -> Iterable[ContainerAppCollection]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either ContainerAppCollection or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ContainerAppsOperations.list_custom_host_name_analysis + name: list_custom_host_name_analysis + summary: 'Analyzes a custom hostname for a Container App. + + + Analyzes a custom hostname for a Container App.' + signature: 'list_custom_host_name_analysis(resource_group_name: str, container_app_name: + str, custom_hostname: str | None = None, **kwargs: Any) -> CustomHostnameAnalysisResult' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: custom_hostname + description: Custom hostname. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: CustomHostnameAnalysisResult, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ContainerAppsOperations.list_secrets + name: list_secrets + summary: 'List secrets for a container app. + + + List secrets for a container app.' + signature: 'list_secrets(resource_group_name: str, name: str, **kwargs: Any) -> + SecretsCollection' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: name + description: Name of the Container App. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SecretsCollection, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ContainerAppsOperations.update + name: update + summary: 'Update properties of a Container App. + + + Patches a Container App. Currently only patching of tags is supported.' + signature: 'update(resource_group_name: str, name: str, container_app_envelope: + ContainerAppPatch, **kwargs: Any) -> ContainerApp' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: name + description: Name of the Container App. + isRequired: true + types: + - + - name: container_app_envelope + description: Properties of a container app that need to be updated. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ContainerApp, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.app.operations.ContainerAppsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsRevisionReplicasOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsRevisionReplicasOperations.yml new file mode 100644 index 00000000..f508f5a7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsRevisionReplicasOperations.yml @@ -0,0 +1,110 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.operations.ContainerAppsRevisionReplicasOperations +name: ContainerAppsRevisionReplicasOperations +fullName: azure.mgmt.app.operations.ContainerAppsRevisionReplicasOperations +module: azure.mgmt.app.operations +summary: 'ContainerAppsRevisionReplicasOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: ContainerAppsRevisionReplicasOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.app.operations.ContainerAppsRevisionReplicasOperations.get_replica + name: get_replica + summary: 'Get a replica for a Container App Revision. + + + Get a replica for a Container App Revision.' + signature: 'get_replica(resource_group_name: str, container_app_name: str, revision_name: + str, name: str, **kwargs: Any) -> Replica' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: revision_name + description: Name of the Container App Revision. + isRequired: true + types: + - + - name: name + description: Name of the Container App Revision Replica. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Replica, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ContainerAppsRevisionReplicasOperations.list_replicas + name: list_replicas + summary: 'List replicas for a Container App Revision. + + + List replicas for a Container App Revision.' + signature: 'list_replicas(resource_group_name: str, container_app_name: str, revision_name: + str, **kwargs: Any) -> ReplicaCollection' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: revision_name + description: Name of the Container App Revision. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ReplicaCollection, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.app.operations.ContainerAppsRevisionReplicasOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsRevisionsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsRevisionsOperations.yml new file mode 100644 index 00000000..308fe266 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsRevisionsOperations.yml @@ -0,0 +1,206 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.operations.ContainerAppsRevisionsOperations +name: ContainerAppsRevisionsOperations +fullName: azure.mgmt.app.operations.ContainerAppsRevisionsOperations +module: azure.mgmt.app.operations +summary: 'ContainerAppsRevisionsOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: ContainerAppsRevisionsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.app.operations.ContainerAppsRevisionsOperations.activate_revision + name: activate_revision + summary: 'Activates a revision for a Container App. + + + Activates a revision for a Container App.' + signature: 'activate_revision(resource_group_name: str, container_app_name: str, + name: str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: name + description: Name of the Container App Revision. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ContainerAppsRevisionsOperations.deactivate_revision + name: deactivate_revision + summary: 'Deactivates a revision for a Container App. + + + Deactivates a revision for a Container App.' + signature: 'deactivate_revision(resource_group_name: str, container_app_name: str, + name: str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: name + description: Name of the Container App Revision. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ContainerAppsRevisionsOperations.get_revision + name: get_revision + summary: 'Get a revision of a Container App. + + + Get a revision of a Container App.' + signature: 'get_revision(resource_group_name: str, container_app_name: str, name: + str, **kwargs: Any) -> Revision' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: name + description: Name of the Container App Revision. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Revision, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ContainerAppsRevisionsOperations.list_revisions + name: list_revisions + summary: 'Get the Revisions for a given Container App. + + + Get the Revisions for a given Container App.' + signature: 'list_revisions(resource_group_name: str, container_app_name: str, **kwargs: + Any) -> Iterable[RevisionCollection]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App for which Revisions are needed. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either RevisionCollection or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ContainerAppsRevisionsOperations.restart_revision + name: restart_revision + summary: 'Restarts a revision for a Container App. + + + Restarts a revision for a Container App.' + signature: 'restart_revision(resource_group_name: str, container_app_name: str, + name: str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: name + description: Name of the Container App Revision. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.app.operations.ContainerAppsRevisionsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsSourceControlsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsSourceControlsOperations.yml new file mode 100644 index 00000000..d3caf910 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsSourceControlsOperations.yml @@ -0,0 +1,224 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.operations.ContainerAppsSourceControlsOperations +name: ContainerAppsSourceControlsOperations +fullName: azure.mgmt.app.operations.ContainerAppsSourceControlsOperations +module: azure.mgmt.app.operations +summary: 'ContainerAppsSourceControlsOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: ContainerAppsSourceControlsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.app.operations.ContainerAppsSourceControlsOperations.begin_create_or_update + name: begin_create_or_update + summary: 'Create or update the SourceControl for a Container App. + + + Description for Create or update the SourceControl for a Container App.' + signature: 'begin_create_or_update(resource_group_name: str, container_app_name: + str, name: str, source_control_envelope: SourceControl, **kwargs: Any) -> LROPoller[SourceControl]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: name + description: Name of the Container App SourceControl. + isRequired: true + types: + - + - name: source_control_envelope + description: Properties used to create a Container App SourceControl. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of LROPoller that returns either SourceControl or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ContainerAppsSourceControlsOperations.begin_delete + name: begin_delete + summary: 'Delete a Container App SourceControl. + + + Description for Delete a Container App SourceControl.' + signature: 'begin_delete(resource_group_name: str, container_app_name: str, name: + str, **kwargs: Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: name + description: Name of the Container App SourceControl. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ContainerAppsSourceControlsOperations.get + name: get + summary: 'Get a SourceControl of a Container App. + + + Get a SourceControl of a Container App.' + signature: 'get(resource_group_name: str, container_app_name: str, name: str, **kwargs: + Any) -> SourceControl' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + - name: name + description: Name of the Container App SourceControl. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SourceControl, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ContainerAppsSourceControlsOperations.list_by_container_app + name: list_by_container_app + summary: 'Get the Container App SourceControls in a given resource group. + + + Get the Container App SourceControls in a given resource group.' + signature: 'list_by_container_app(resource_group_name: str, container_app_name: + str, **kwargs: Any) -> Iterable[SourceControlCollection]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: container_app_name + description: Name of the Container App. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either SourceControlCollection or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.app.operations.ContainerAppsSourceControlsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.DaprComponentsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.DaprComponentsOperations.yml new file mode 100644 index 00000000..7bd39245 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.DaprComponentsOperations.yml @@ -0,0 +1,178 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.operations.DaprComponentsOperations +name: DaprComponentsOperations +fullName: azure.mgmt.app.operations.DaprComponentsOperations +module: azure.mgmt.app.operations +summary: 'DaprComponentsOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: DaprComponentsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.app.operations.DaprComponentsOperations.create_or_update + name: create_or_update + summary: 'Creates or updates a Dapr Component. + + + Creates or updates a Dapr Component in a Managed Environment.' + signature: 'create_or_update(resource_group_name: str, environment_name: str, name: + str, dapr_component_envelope: DaprComponent, **kwargs: Any) -> DaprComponent' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: environment_name + description: Name of the Managed Environment. + isRequired: true + types: + - + - name: name + description: Name of the Dapr Component. + isRequired: true + types: + - + - name: dapr_component_envelope + description: Configuration details of the Dapr Component. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DaprComponent, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.DaprComponentsOperations.delete + name: delete + summary: 'Delete a Dapr Component. + + + Delete a Dapr Component from a Managed Environment.' + signature: 'delete(resource_group_name: str, environment_name: str, name: str, **kwargs: + Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: environment_name + description: Name of the Managed Environment. + isRequired: true + types: + - + - name: name + description: Name of the Dapr Component. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.DaprComponentsOperations.get + name: get + summary: 'Get a dapr component. + + + Get a dapr component.' + signature: 'get(resource_group_name: str, environment_name: str, name: str, **kwargs: + Any) -> DaprComponent' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: environment_name + description: Name of the Managed Environment. + isRequired: true + types: + - + - name: name + description: Name of the Dapr Component. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DaprComponent, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.DaprComponentsOperations.list + name: list + summary: 'Get the Dapr Components for a managed environment. + + + Get the Dapr Components for a managed environment.' + signature: 'list(resource_group_name: str, environment_name: str, **kwargs: Any) + -> Iterable[DaprComponentsCollection]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: environment_name + description: Name of the Managed Environment. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either DaprComponentsCollection or + the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.app.operations.DaprComponentsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ManagedEnvironmentsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ManagedEnvironmentsOperations.yml new file mode 100644 index 00000000..8c716406 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ManagedEnvironmentsOperations.yml @@ -0,0 +1,258 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.operations.ManagedEnvironmentsOperations +name: ManagedEnvironmentsOperations +fullName: azure.mgmt.app.operations.ManagedEnvironmentsOperations +module: azure.mgmt.app.operations +summary: 'ManagedEnvironmentsOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: ManagedEnvironmentsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.app.operations.ManagedEnvironmentsOperations.begin_create_or_update + name: begin_create_or_update + summary: 'Creates or updates a Managed Environment. + + + Creates or updates a Managed Environment used to host container apps.' + signature: 'begin_create_or_update(resource_group_name: str, name: str, environment_envelope: + ManagedEnvironment, **kwargs: Any) -> LROPoller[ManagedEnvironment]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: name + description: Name of the Environment. + isRequired: true + types: + - + - name: environment_envelope + description: Configuration details of the Environment. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of LROPoller that returns either ManagedEnvironment + or the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ManagedEnvironmentsOperations.begin_delete + name: begin_delete + summary: 'Delete a Managed Environment. + + + Delete a Managed Environment if it does not have any container apps.' + signature: 'begin_delete(resource_group_name: str, name: str, **kwargs: Any) -> + LROPoller[None]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: name + description: Name of the Environment. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ManagedEnvironmentsOperations.get + name: get + summary: 'Get the properties of a Managed Environment. + + + Get the properties of a Managed Environment used to host container apps.' + signature: 'get(resource_group_name: str, name: str, **kwargs: Any) -> ManagedEnvironment' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: name + description: Name of the Environment. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ManagedEnvironment, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ManagedEnvironmentsOperations.list_by_resource_group + name: list_by_resource_group + summary: 'Get all the Environments in a resource group. + + + Get all the Managed Environments in a resource group.' + signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[ManagedEnvironmentsCollection]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either ManagedEnvironmentsCollection + or the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ManagedEnvironmentsOperations.list_by_subscription + name: list_by_subscription + summary: 'Get all Environments for a subscription. + + + Get all Managed Environments for a subscription.' + signature: 'list_by_subscription(**kwargs: Any) -> Iterable[ManagedEnvironmentsCollection]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either ManagedEnvironmentsCollection + or the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ManagedEnvironmentsOperations.update + name: update + summary: 'Update Managed Environment''s properties. + + + Patches a Managed Environment. Only patching of tags is supported currently.' + signature: 'update(resource_group_name: str, name: str, environment_envelope: ManagedEnvironmentPatch, + **kwargs: Any) -> ManagedEnvironment' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: name + description: Name of the Environment. + isRequired: true + types: + - + - name: environment_envelope + description: Configuration details of the Environment. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ManagedEnvironment, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.app.operations.ManagedEnvironmentsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ManagedEnvironmentsStoragesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ManagedEnvironmentsStoragesOperations.yml new file mode 100644 index 00000000..9a1e0798 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ManagedEnvironmentsStoragesOperations.yml @@ -0,0 +1,174 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.operations.ManagedEnvironmentsStoragesOperations +name: ManagedEnvironmentsStoragesOperations +fullName: azure.mgmt.app.operations.ManagedEnvironmentsStoragesOperations +module: azure.mgmt.app.operations +summary: 'ManagedEnvironmentsStoragesOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: ManagedEnvironmentsStoragesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.app.operations.ManagedEnvironmentsStoragesOperations.create_or_update + name: create_or_update + summary: 'Create or update storage for a managedEnvironment. + + + Create or update storage for a managedEnvironment.' + signature: 'create_or_update(resource_group_name: str, env_name: str, name: str, + storage_envelope: ManagedEnvironmentStorage, **kwargs: Any) -> ManagedEnvironmentStorage' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: env_name + description: Name of the Environment. + isRequired: true + types: + - + - name: name + description: Name of the storage. + isRequired: true + types: + - + - name: storage_envelope + description: Configuration details of storage. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ManagedEnvironmentStorage, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ManagedEnvironmentsStoragesOperations.delete + name: delete + summary: 'Delete storage for a managedEnvironment. + + + Delete storage for a managedEnvironment.' + signature: 'delete(resource_group_name: str, env_name: str, name: str, **kwargs: + Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: env_name + description: Name of the Environment. + isRequired: true + types: + - + - name: name + description: Name of the storage. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ManagedEnvironmentsStoragesOperations.get + name: get + summary: 'Get storage for a managedEnvironment. + + + Get storage for a managedEnvironment.' + signature: 'get(resource_group_name: str, env_name: str, name: str, **kwargs: Any) + -> ManagedEnvironmentStorage' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: env_name + description: Name of the Environment. + isRequired: true + types: + - + - name: name + description: Name of the storage. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ManagedEnvironmentStorage, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.app.operations.ManagedEnvironmentsStoragesOperations.list + name: list + summary: 'Get all storages for a managedEnvironment. + + + Get all storages for a managedEnvironment.' + signature: 'list(resource_group_name: str, env_name: str, **kwargs: Any) -> ManagedEnvironmentStoragesCollection' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: env_name + description: Name of the Environment. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ManagedEnvironmentStoragesCollection, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.app.operations.ManagedEnvironmentsStoragesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.Operations.yml new file mode 100644 index 00000000..33acd189 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.Operations.yml @@ -0,0 +1,51 @@ +### YamlMime:PythonClass +uid: azure.mgmt.app.operations.Operations +name: Operations +fullName: azure.mgmt.app.operations.Operations +module: azure.mgmt.app.operations +summary: 'Operations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: Operations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.app.operations.Operations.list + name: list + summary: Lists all of the available RP operations. + signature: 'list(**kwargs: Any) -> Iterable[AvailableOperations]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either AvailableOperations or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.app.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.yml new file mode 100644 index 00000000..c17449d1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.app.operations +name: operations +fullName: azure.mgmt.app.operations +type: import +classes: +- azure.mgmt.app.operations.CertificatesOperations +- azure.mgmt.app.operations.ContainerAppsAuthConfigsOperations +- azure.mgmt.app.operations.ContainerAppsOperations +- azure.mgmt.app.operations.ContainerAppsRevisionReplicasOperations +- azure.mgmt.app.operations.ContainerAppsRevisionsOperations +- azure.mgmt.app.operations.ContainerAppsSourceControlsOperations +- azure.mgmt.app.operations.DaprComponentsOperations +- azure.mgmt.app.operations.ManagedEnvironmentsOperations +- azure.mgmt.app.operations.ManagedEnvironmentsStoragesOperations +- azure.mgmt.app.operations.Operations diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.yml new file mode 100644 index 00000000..1139b4e8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.app +name: app +fullName: azure.mgmt.app +type: rootImport +classes: +- azure.mgmt.app.ContainerAppsAPIClient +packages: +- azure.mgmt.app.aio +- azure.mgmt.app.models +- azure.mgmt.app.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.CPIMConfigurationClient.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.CPIMConfigurationClient.yml new file mode 100644 index 00000000..77d4aaeb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.CPIMConfigurationClient.yml @@ -0,0 +1,95 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.CPIMConfigurationClient +name: CPIMConfigurationClient +fullName: azure.mgmt.azureadb2c.CPIMConfigurationClient +module: azure.mgmt.azureadb2c +summary: 'CPIM Configuration Client. + + + This ready contains multiple API versions, to help you deal with all of the Azure + clouds + + (Azure Stack, Azure Government, Azure China, etc.). + + By default, it uses the latest API version available on public Azure. + + For production, you should stick to a particular api-version and/or profile. + + The profile sets a mapping between an operation group and its API version. + + The api-version parameter sets the default API version if the operation + + group is not described in the profile.' +constructor: + syntax: CPIMConfigurationClient(credential, subscription_id, api_version=None, base_url=None, + profile=KnownProfiles.default, **kwargs) + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: subscription_id + description: The Azure subscription ID. This is a GUID-formatted string (e.g. + 00000000-0000-0000-0000-000000000000). + isRequired: true + types: + - + - name: api_version + description: 'API version to use if no profile is provided, or if + + missing in profile.' + defaultValue: None + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - + - name: profile + description: A profile definition, from KnownProfiles to dict. + defaultValue: KnownProfiles.default + types: + - + keywordOnlyParameters: + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - +methods: +- uid: azure.mgmt.azureadb2c.CPIMConfigurationClient.close + name: close + signature: close() +- uid: azure.mgmt.azureadb2c.CPIMConfigurationClient.models + name: models + summary: "Module depends on the API version:\n\n* 2019-01-01-preview: \ + \ \n\n* 2020-05-01-preview: " + signature: models(api_version='2020-05-01-preview') + parameters: + - name: api_version + defaultValue: 2020-05-01-preview +attributes: +- uid: azure.mgmt.azureadb2c.CPIMConfigurationClient.b2_ctenants + name: b2_ctenants + summary: 'Instance depends on the API version: + + + * 2019-01-01-preview: ' +- uid: azure.mgmt.azureadb2c.CPIMConfigurationClient.guest_usages + name: guest_usages + summary: 'Instance depends on the API version: + + + * 2020-05-01-preview: ' +- uid: azure.mgmt.azureadb2c.CPIMConfigurationClient.operations + name: operations + summary: "Instance depends on the API version:\n\n* 2019-01-01-preview: \ + \ \n\n* 2020-05-01-preview: " +- uid: azure.mgmt.azureadb2c.CPIMConfigurationClient.DEFAULT_API_VERSION + name: DEFAULT_API_VERSION + signature: DEFAULT_API_VERSION = '2020-05-01-preview' +- uid: azure.mgmt.azureadb2c.CPIMConfigurationClient.LATEST_PROFILE + name: LATEST_PROFILE + signature: LATEST_PROFILE = azure.mgmt.azureadb2c.CPIMConfigurationClient latest diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.aio.CPIMConfigurationClient.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.aio.CPIMConfigurationClient.yml new file mode 100644 index 00000000..6f0f7708 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.aio.CPIMConfigurationClient.yml @@ -0,0 +1,95 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.aio.CPIMConfigurationClient +name: CPIMConfigurationClient +fullName: azure.mgmt.azureadb2c.aio.CPIMConfigurationClient +module: azure.mgmt.azureadb2c.aio +summary: 'CPIM Configuration Client. + + + This ready contains multiple API versions, to help you deal with all of the Azure + clouds + + (Azure Stack, Azure Government, Azure China, etc.). + + By default, it uses the latest API version available on public Azure. + + For production, you should stick to a particular api-version and/or profile. + + The profile sets a mapping between an operation group and its API version. + + The api-version parameter sets the default API version if the operation + + group is not described in the profile.' +constructor: + syntax: CPIMConfigurationClient(credential, subscription_id, api_version=None, base_url=None, + profile=KnownProfiles.default, **kwargs) + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: subscription_id + description: The Azure subscription ID. This is a GUID-formatted string (e.g. + 00000000-0000-0000-0000-000000000000). + isRequired: true + types: + - + - name: api_version + description: 'API version to use if no profile is provided, or if + + missing in profile.' + defaultValue: None + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - + - name: profile + description: A profile definition, from KnownProfiles to dict. + defaultValue: KnownProfiles.default + types: + - + keywordOnlyParameters: + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - +methods: +- uid: azure.mgmt.azureadb2c.aio.CPIMConfigurationClient.close + name: close + signature: async close() +- uid: azure.mgmt.azureadb2c.aio.CPIMConfigurationClient.models + name: models + summary: "Module depends on the API version:\n\n* 2019-01-01-preview: \ + \ \n\n* 2020-05-01-preview: " + signature: models(api_version='2020-05-01-preview') + parameters: + - name: api_version + defaultValue: 2020-05-01-preview +attributes: +- uid: azure.mgmt.azureadb2c.aio.CPIMConfigurationClient.b2_ctenants + name: b2_ctenants + summary: 'Instance depends on the API version: + + + * 2019-01-01-preview: ' +- uid: azure.mgmt.azureadb2c.aio.CPIMConfigurationClient.guest_usages + name: guest_usages + summary: 'Instance depends on the API version: + + + * 2020-05-01-preview: ' +- uid: azure.mgmt.azureadb2c.aio.CPIMConfigurationClient.operations + name: operations + summary: "Instance depends on the API version:\n\n* 2019-01-01-preview: \ + \ \n\n* 2020-05-01-preview: " +- uid: azure.mgmt.azureadb2c.aio.CPIMConfigurationClient.DEFAULT_API_VERSION + name: DEFAULT_API_VERSION + signature: DEFAULT_API_VERSION = '2020-05-01-preview' +- uid: azure.mgmt.azureadb2c.aio.CPIMConfigurationClient.LATEST_PROFILE + name: LATEST_PROFILE + signature: LATEST_PROFILE = azure.mgmt.azureadb2c.CPIMConfigurationClient latest diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.aio.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.aio.yml new file mode 100644 index 00000000..b8754ce8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.aio.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.azureadb2c.aio +name: aio +fullName: azure.mgmt.azureadb2c.aio +type: import +classes: +- azure.mgmt.azureadb2c.aio.CPIMConfigurationClient diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.models.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.models.yml new file mode 100644 index 00000000..34d2a9b5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.models.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.mgmt.azureadb2c.models +name: models +fullName: azure.mgmt.azureadb2c.models diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.CPIMConfigurationClient.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.CPIMConfigurationClient.yml new file mode 100644 index 00000000..77a242cd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.CPIMConfigurationClient.yml @@ -0,0 +1,45 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.CPIMConfigurationClient +name: CPIMConfigurationClient +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.CPIMConfigurationClient +module: azure.mgmt.azureadb2c.v2019_01_01_preview +summary: CPIM Configuration Client. +constructor: + syntax: 'CPIMConfigurationClient(credential: ''TokenCredential'', subscription_id: + str, base_url: str | None = None, **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: subscription_id + description: Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for every service call. + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - + keywordOnlyParameters: + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - +variables: +- description: B2CTenantsOperations operations + name: b2_ctenants + types: + - () +- description: Operations operations + name: operations + types: + - () +methods: +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.CPIMConfigurationClient.close + name: close + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.aio.CPIMConfigurationClient.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.aio.CPIMConfigurationClient.yml new file mode 100644 index 00000000..598fd52c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.aio.CPIMConfigurationClient.yml @@ -0,0 +1,45 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.CPIMConfigurationClient +name: CPIMConfigurationClient +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.CPIMConfigurationClient +module: azure.mgmt.azureadb2c.v2019_01_01_preview.aio +summary: CPIM Configuration Client. +constructor: + syntax: 'CPIMConfigurationClient(credential: AsyncTokenCredential, subscription_id: + str, base_url: str | None = None, **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: subscription_id + description: Subscription credentials which uniquely identify Microsoft Azure + subscription. The subscription ID forms part of the URI for every service call. + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - + keywordOnlyParameters: + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - +variables: +- description: B2CTenantsOperations operations + name: b2_ctenants + types: + - () +- description: Operations operations + name: operations + types: + - () +methods: +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.CPIMConfigurationClient.close + name: close + signature: async close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations.yml new file mode 100644 index 00000000..496b7afd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations.yml @@ -0,0 +1,251 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations +name: B2CTenantsOperations +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations +module: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations +summary: 'B2CTenantsOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: B2CTenantsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations.begin_create + name: begin_create + summary: 'Initiates an async request to create both the Azure AD B2C tenant and + the corresponding Azure + + resource linked to a subscription.' + signature: 'async begin_create(resource_group_name: str, resource_name: str, create_tenant_request_body: + CreateTenantRequestBody | None = None, **kwargs) -> AsyncLROPoller[B2CTenantResource]' + parameters: + - name: resource_group_name + description: The name of the resource group. + isRequired: true + types: + - + - name: resource_name + description: The initial domain name of the B2C tenant. + isRequired: true + types: + - + - name: create_tenant_request_body + defaultValue: None + types: + - () + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either B2CTenantResource + or the result of cls(response) + types: + - [~$(--)] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations.begin_delete + name: begin_delete + summary: 'Initiates an async operation to delete the Azure AD B2C tenant and Azure + resource. The resource + + deletion can only happen as the last step in [the tenant deletion process](https://aka.ms/deleteB2Ctenant).' + signature: 'async begin_delete(resource_group_name: str, resource_name: str, **kwargs) + -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: The name of the resource group. + isRequired: true + types: + - + - name: resource_name + description: The initial domain name of the B2C tenant. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations.check_name_availability + name: check_name_availability + summary: Checks the availability and validity of a domain name for the tenant. + signature: 'async check_name_availability(check_name_availability_request_body: + CheckNameAvailabilityRequestBody | None = None, **kwargs) -> NameAvailabilityResponse' + parameters: + - name: check_name_availability_request_body + defaultValue: None + types: + - () + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: NameAvailabilityResponse, or the result of cls(response) + types: + - $(--) + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations.get + name: get + summary: Get the Azure AD B2C tenant resource. + signature: 'async get(resource_group_name: str, resource_name: str, **kwargs) -> + B2CTenantResource' + parameters: + - name: resource_group_name + description: The name of the resource group. + isRequired: true + types: + - + - name: resource_name + description: The initial domain name of the B2C tenant. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: B2CTenantResource, or the result of cls(response) + types: + - $(--) + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations.list_by_resource_group + name: list_by_resource_group + summary: Get all the Azure AD B2C tenant resources in a resource group. + signature: 'list_by_resource_group(resource_group_name: str, **kwargs) -> AsyncIterable[B2CTenantResourceList]' + parameters: + - name: resource_group_name + description: The name of the resource group. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either B2CTenantResourceList or the + result of cls(response) + types: + - [~$(--)] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations.list_by_subscription + name: list_by_subscription + summary: Get all the Azure AD B2C tenant resources in a subscription. + signature: list_by_subscription(**kwargs) -> AsyncIterable[B2CTenantResourceList] + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either B2CTenantResourceList or the + result of cls(response) + types: + - [~$(--)] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations.update + name: update + summary: Update the Azure AD B2C tenant resource. + signature: 'async update(resource_group_name: str, resource_name: str, update_tenant_request_body: + B2CTenantUpdateRequest | None = None, **kwargs) -> B2CTenantResource' + parameters: + - name: resource_group_name + description: The name of the resource group. + isRequired: true + types: + - + - name: resource_name + description: The initial domain name of the B2C tenant. + isRequired: true + types: + - + - name: update_tenant_request_body + defaultValue: None + types: + - () + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: B2CTenantResource, or the result of cls(response) + types: + - $(--) + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.Operations.yml new file mode 100644 index 00000000..5e7c41fb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.Operations.yml @@ -0,0 +1,73 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.Operations +name: Operations +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.Operations +module: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations +summary: 'Operations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: Operations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.Operations.get_async_status + name: get_async_status + summary: Gets the status of the async operation. + signature: 'async get_async_status(operation_id: str, **kwargs) -> AsyncOperationStatus' + parameters: + - name: operation_id + description: The operation ID. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AsyncOperationStatus, or the result of cls(response) + types: + - $(--) + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.Operations.list + name: list + summary: Lists the operations available from this provider. + signature: list(**kwargs) -> AsyncIterable[OperationListResult] + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either OperationListResult or the result + of cls(response) + types: + - [~$(--)] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.yml new file mode 100644 index 00000000..6222f617 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.yml @@ -0,0 +1,8 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations +name: operations +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations +type: import +classes: +- azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations +- azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.Operations diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.aio.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.aio.yml new file mode 100644 index 00000000..4c123f70 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.aio.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio +name: aio +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.aio +type: import +classes: +- azure.mgmt.azureadb2c.v2019_01_01_preview.aio.CPIMConfigurationClient +packages: +- azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatus.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatus.yml new file mode 100644 index 00000000..2b36f913 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatus.yml @@ -0,0 +1,81 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatus +name: AsyncOperationStatus +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatus +module: azure.mgmt.azureadb2c.v2019_01_01_preview.models +summary: The async operation status. +constructor: + syntax: 'AsyncOperationStatus(*, subscription_id: str | None = None, id: str | None + = None, name: str | None = None, status: str | StatusType | None = None, start_time: + str | None = None, end_time: str | None = None, error: AsyncOperationStatusError + | None = None, billing_config: B2CTenantResourcePropertiesBillingConfig | None + = None, tenant_id: str | None = None, **kwargs)' + parameters: + - name: subscription_id + description: Subscription ID that the resource belongs to. + isRequired: true + types: + - + - name: id + description: The GET resource path for the operation. + isRequired: true + types: + - + - name: name + description: The operation ID. + isRequired: true + types: + - + - name: status + description: 'The status of the operation. Possible values include: "Succeeded", + "Pending", + + "Failed".' + isRequired: true + types: + - + - () + - name: start_time + description: Start time of the async operation. + isRequired: true + types: + - + - name: end_time + description: End time of the async operation. + isRequired: true + types: + - + - name: error + description: Error response if async operation failed. + isRequired: true + types: + - () + - name: billing_config + description: The billing configuration for the tenant. + isRequired: true + types: + - () + - name: tenant_id + description: An identifier of the B2C tenant. + isRequired: true + types: + - + keywordOnlyParameters: + - name: subscription_id + isRequired: true + - name: id + isRequired: true + - name: name + isRequired: true + - name: status + isRequired: true + - name: start_time + isRequired: true + - name: end_time + isRequired: true + - name: error + isRequired: true + - name: billing_config + isRequired: true + - name: tenant_id + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatusError.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatusError.yml new file mode 100644 index 00000000..fd62952d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatusError.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatusError +name: AsyncOperationStatusError +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatusError +module: azure.mgmt.azureadb2c.v2019_01_01_preview.models +summary: Error response if async operation failed. +constructor: + syntax: 'AsyncOperationStatusError(*, code: str | None = None, message: str | None + = None, **kwargs)' + parameters: + - name: code + description: Error code. + isRequired: true + types: + - + - name: message + description: Error message. + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKU.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKU.yml new file mode 100644 index 00000000..0943ecaf --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKU.yml @@ -0,0 +1,33 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKU +name: B2CResourceSKU +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKU +module: azure.mgmt.azureadb2c.v2019_01_01_preview.models +summary: 'SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C + billing at [aka.ms/b2cBilling](https://aka.ms/b2cBilling). + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'B2CResourceSKU(*, name: str | B2CResourceSKUName | None = None, **kwargs)' + parameters: + - name: name + description: 'The name of the SKU for the tenant. Possible values include: "Standard", + + "PremiumP1", "PremiumP2".' + isRequired: true + types: + - + - () + keywordOnlyParameters: + - name: name + isRequired: true +variables: +- description: 'The tier of the tenant. Default value: "A0".' + name: tier + types: + - +attributes: +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKU.tier + name: tier + signature: tier = 'A0' diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKUName.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKUName.yml new file mode 100644 index 00000000..9d0595d0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKUName.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKUName +name: B2CResourceSKUName +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKUName +summary: The name of the SKU for the tenant. +module: azure.mgmt.azureadb2c.v2019_01_01_preview.models +fields: +- name: PREMIUM_P1 + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKUName.PREMIUM_P1 +- name: PREMIUM_P2 + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKUName.PREMIUM_P2 +- name: STANDARD + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKUName.STANDARD diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResource.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResource.yml new file mode 100644 index 00000000..6454dc7e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResource.yml @@ -0,0 +1,80 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResource +name: B2CTenantResource +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResource +module: azure.mgmt.azureadb2c.v2019_01_01_preview.models +summary: 'B2CTenantResource. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'B2CTenantResource(*, sku: B2CResourceSKU, location: str, tags: Dict[str, + str] | None = None, billing_config: B2CTenantResourcePropertiesBillingConfig | + None = None, tenant_id: str | None = None, **kwargs)' + parameters: + - name: sku + description: 'Required. SKU properties of the Azure AD B2C tenant. Learn more + about Azure AD B2C + + billing at [aka.ms/b2cBilling](https://aka.ms/b2cBilling).' + isRequired: true + types: + - () + - name: location + description: 'Required. The location in which the resource is hosted and data + resides. Refer + + to [this documentation](https://aka.ms/B2CDataResidency) to see valid data residency + + locations. Please choose one of ''United States'', ''Europe'', and ''Asia Pacific''.' + isRequired: true + types: + - + - name: tags + description: A set of tags. Resource Tags. + isRequired: true + types: + - [, ] + - name: billing_config + description: The billing configuration for the tenant. + isRequired: true + types: + - () + - name: tenant_id + description: An identifier of the B2C tenant. + isRequired: true + types: + - + keywordOnlyParameters: + - name: sku + isRequired: true + - name: location + isRequired: true + - name: tags + isRequired: true + - name: billing_config + isRequired: true + - name: tenant_id + isRequired: true +variables: +- description: 'The type of the B2C tenant resource. Default value: + + "Microsoft.AzureActiveDirectory/b2cDirectories".' + name: type + types: + - +- description: An identifier that represents the B2C tenant resource. + name: id + types: + - +- description: The name of the B2C tenant resource. + name: name + types: + - +attributes: +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResource.type + name: type + signature: type = 'Microsoft.AzureActiveDirectory/b2cDirectories' diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResourceList.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResourceList.yml new file mode 100644 index 00000000..d2ca4d9b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResourceList.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResourceList +name: B2CTenantResourceList +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResourceList +module: azure.mgmt.azureadb2c.v2019_01_01_preview.models +summary: 'The collection of Azure AD B2C tenant resources. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: B2CTenantResourceList(**kwargs) +variables: +- description: List of guest usages resources. + name: value + types: + - [()] diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResourcePropertiesBillingConfig.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResourcePropertiesBillingConfig.yml new file mode 100644 index 00000000..a2b722e2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResourcePropertiesBillingConfig.yml @@ -0,0 +1,34 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResourcePropertiesBillingConfig +name: B2CTenantResourcePropertiesBillingConfig +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResourcePropertiesBillingConfig +module: azure.mgmt.azureadb2c.v2019_01_01_preview.models +summary: 'The billing configuration for the tenant. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'B2CTenantResourcePropertiesBillingConfig(*, billing_type: str | BillingType + | None = None, **kwargs)' + parameters: + - name: billing_type + description: 'The type of billing. Will be MAU for all new customers. If ''Auths'', + it can + + be updated to ''MAU''. Cannot be changed if value is ''MAU''. Learn more about + Azure AD B2C billing + + at [aka.ms/b2cBilling](https://aka.ms/b2cbilling). Possible values include: + "MAU", "Auths".' + isRequired: true + types: + - + - () + keywordOnlyParameters: + - name: billing_type + isRequired: true +variables: +- description: The data from which the billing type took effect. + name: effective_start_date_utc + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantUpdateRequest.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantUpdateRequest.yml new file mode 100644 index 00000000..681edbc6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantUpdateRequest.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantUpdateRequest +name: B2CTenantUpdateRequest +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantUpdateRequest +module: azure.mgmt.azureadb2c.v2019_01_01_preview.models +summary: The request body to update the Azure AD B2C tenant resource. +constructor: + syntax: 'B2CTenantUpdateRequest(*, sku: B2CResourceSKU | None = None, tags: Dict[str, + str] | None = None, billing_config: B2CTenantResourcePropertiesBillingConfig | + None = None, tenant_id: str | None = None, **kwargs)' + parameters: + - name: sku + description: 'SKU properties of the Azure AD B2C tenant. Learn more about Azure + AD B2C billing at + + [aka.ms/b2cBilling](https://aka.ms/b2cBilling).' + isRequired: true + types: + - () + - name: tags + description: A set of tags. Resource Tags. + isRequired: true + types: + - [, ] + - name: billing_config + description: The billing configuration for the tenant. + isRequired: true + types: + - () + - name: tenant_id + description: An identifier of the B2C tenant. + isRequired: true + types: + - + keywordOnlyParameters: + - name: sku + isRequired: true + - name: tags + isRequired: true + - name: billing_config + isRequired: true + - name: tenant_id + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.BillingType.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.BillingType.yml new file mode 100644 index 00000000..40e0dc11 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.BillingType.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.BillingType +name: BillingType +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.models.BillingType +summary: 'The type of billing. Will be MAU for all new customers. If ''Auths'', it + can be updated to ''MAU''. + + Cannot be changed if value is ''MAU''. Learn more about Azure AD B2C billing at + + [aka.ms/b2cBilling](https://aka.ms/b2cbilling).' +module: azure.mgmt.azureadb2c.v2019_01_01_preview.models +fields: +- name: AUTHS + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.BillingType.AUTHS +- name: MAU + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.BillingType.MAU diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.CheckNameAvailabilityRequestBody.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.CheckNameAvailabilityRequestBody.yml new file mode 100644 index 00000000..14f642dc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.CheckNameAvailabilityRequestBody.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.CheckNameAvailabilityRequestBody +name: CheckNameAvailabilityRequestBody +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.models.CheckNameAvailabilityRequestBody +module: azure.mgmt.azureadb2c.v2019_01_01_preview.models +summary: 'The information required to check the availability of the name for the tenant. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CheckNameAvailabilityRequestBody(*, name: str, country_code: str, **kwargs)' + parameters: + - name: name + description: Required. The domain name to check for availability. + isRequired: true + types: + - + - name: country_code + description: 'Required. Country code of Azure tenant (e.g. ''US''). Refer to + + [aka.ms/B2CDataResidency](https://aka.ms/B2CDataResidency) to see valid country + codes and + + corresponding data residency locations. If you do not see a country code in + an valid data + + residency location, choose one from the list.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: country_code + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBody.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBody.yml new file mode 100644 index 00000000..b97fb822 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBody.yml @@ -0,0 +1,51 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBody +name: CreateTenantRequestBody +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBody +module: azure.mgmt.azureadb2c.v2019_01_01_preview.models +summary: 'The information needed to create the Azure AD B2C tenant and corresponding + Azure resource, which is used for billing purposes. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CreateTenantRequestBody(*, location: str, properties: CreateTenantRequestBodyProperties, + sku: B2CResourceSKU, tags: Dict[str, str] | None = None, **kwargs)' + parameters: + - name: location + description: 'Required. The location in which the resource is hosted and data + resides. Refer + + to [this documentation](https://aka.ms/B2CDataResidency) to see valid data residency + + locations. Please choose one of ''United States'', ''Europe'', and ''Asia Pacific''.' + isRequired: true + types: + - + - name: properties + description: Required. + isRequired: true + types: + - () + - name: sku + description: 'Required. SKU properties of the Azure AD B2C tenant. Learn more + about Azure AD B2C + + billing at [aka.ms/b2cBilling](https://aka.ms/b2cBilling).' + isRequired: true + types: + - () + - name: tags + description: A set of tags. Resource Tags. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: location + isRequired: true + - name: properties + isRequired: true + - name: sku + isRequired: true + - name: tags + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBodyProperties.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBodyProperties.yml new file mode 100644 index 00000000..718befcd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBodyProperties.yml @@ -0,0 +1,33 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBodyProperties +name: CreateTenantRequestBodyProperties +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBodyProperties +module: azure.mgmt.azureadb2c.v2019_01_01_preview.models +summary: CreateTenantRequestBodyProperties. +constructor: + syntax: 'CreateTenantRequestBodyProperties(*, display_name: str | None = None, country_code: + str | None = None, **kwargs)' + parameters: + - name: display_name + description: The display name of the B2C tenant. + isRequired: true + types: + - + - name: country_code + description: 'Country code of Azure tenant (e.g. ''US''). Refer to + + [aka.ms/B2CDataResidency](https://aka.ms/B2CDataResidency) to see valid country + codes and + + corresponding data residency locations. If you do not see a country code in + an valid data + + residency location, choose one from the list.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: display_name + isRequired: true + - name: country_code + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.ErrorAdditionalInfo.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.ErrorAdditionalInfo.yml new file mode 100644 index 00000000..1a11bb7a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.ErrorAdditionalInfo.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.ErrorAdditionalInfo +name: ErrorAdditionalInfo +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.models.ErrorAdditionalInfo +module: azure.mgmt.azureadb2c.v2019_01_01_preview.models +summary: 'The resource management error additional info. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: ErrorAdditionalInfo(**kwargs) +variables: +- description: The additional info type. + name: type + types: + - +- description: The additional info. + name: info + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.ErrorResponse.yml new file mode 100644 index 00000000..9eb13626 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.ErrorResponse.yml @@ -0,0 +1,33 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.ErrorResponse +name: ErrorResponse +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.models.ErrorResponse +module: azure.mgmt.azureadb2c.v2019_01_01_preview.models +summary: 'Common error response for all Azure Resource Manager APIs to return error + details for failed operations. (This also follows the OData error response format.). + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: ErrorResponse(**kwargs) +variables: +- description: The error code. + name: code + types: + - +- description: The error message. + name: message + types: + - +- description: The error target. + name: target + types: + - +- description: The error details. + name: details + types: + - [()] +- description: The error additional info. + name: additional_info + types: + - [()] diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.NameAvailabilityReasonType.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.NameAvailabilityReasonType.yml new file mode 100644 index 00000000..e2e58085 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.NameAvailabilityReasonType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.NameAvailabilityReasonType +name: NameAvailabilityReasonType +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.models.NameAvailabilityReasonType +summary: Describes the reason for the 'nameAvailable' value. +module: azure.mgmt.azureadb2c.v2019_01_01_preview.models +fields: +- name: ALREADY_EXISTS + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.NameAvailabilityReasonType.ALREADY_EXISTS +- name: INVALID + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.NameAvailabilityReasonType.INVALID diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.NameAvailabilityResponse.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.NameAvailabilityResponse.yml new file mode 100644 index 00000000..5a01cd85 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.NameAvailabilityResponse.yml @@ -0,0 +1,38 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.NameAvailabilityResponse +name: NameAvailabilityResponse +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.models.NameAvailabilityResponse +module: azure.mgmt.azureadb2c.v2019_01_01_preview.models +summary: Response of the CheckNameAvailability operation. +constructor: + syntax: 'NameAvailabilityResponse(*, message: str | None = None, name_available: + bool | None = None, reason: str | NameAvailabilityReasonType | None = None, **kwargs)' + parameters: + - name: message + description: Description of the reason if name is not available. + isRequired: true + types: + - + - name: name_available + description: 'True if the name is available and can be used to create a new tenant. + + Otherwise false.' + isRequired: true + types: + - + - name: reason + description: 'Describes the reason for the ''nameAvailable'' value. Possible values + include: + + "AlreadyExists", "Invalid".' + isRequired: true + types: + - + - () + keywordOnlyParameters: + - name: message + isRequired: true + - name: name_available + isRequired: true + - name: reason + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.Operation.yml new file mode 100644 index 00000000..3f8dc131 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.Operation.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.Operation +name: Operation +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.models.Operation +module: azure.mgmt.azureadb2c.v2019_01_01_preview.models +summary: 'Microsoft.AzureActiveDirectory REST API operation. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'Operation(*, display: OperationDisplay | None = None, **kwargs)' + parameters: + - name: display + description: The object that represents the operation. + isRequired: true + types: + - () + keywordOnlyParameters: + - name: display + isRequired: true +variables: +- description: 'Operation name: {provider}/{resource}/{operation}.' + name: name + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.OperationDisplay.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.OperationDisplay.yml new file mode 100644 index 00000000..a14cc6e3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.OperationDisplay.yml @@ -0,0 +1,33 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.OperationDisplay +name: OperationDisplay +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.models.OperationDisplay +module: azure.mgmt.azureadb2c.v2019_01_01_preview.models +summary: 'The object that represents the operation. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'OperationDisplay(*, description: str | None = None, **kwargs)' + parameters: + - name: description + description: Friendly name of the operation. + isRequired: true + types: + - + keywordOnlyParameters: + - name: description + isRequired: true +variables: +- description: 'Service provider: Microsoft.AzureActiveDirectory.' + name: provider + types: + - +- description: 'Resource on which the operation is performed: GuestUsages, etc.' + name: resource + types: + - +- description: 'Operation type: Read, write, delete, etc.' + name: operation + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.OperationListResult.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.OperationListResult.yml new file mode 100644 index 00000000..1b339e1f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.OperationListResult.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.OperationListResult +name: OperationListResult +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.models.OperationListResult +module: azure.mgmt.azureadb2c.v2019_01_01_preview.models +summary: 'Result of listing operations for the resourceProvider. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: OperationListResult(**kwargs) +variables: +- description: 'List of cpim service operations supported by the Microsoft.AzureActiveDirectory + + resource provider.' + name: value + types: + - [()] diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.StatusType.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.StatusType.yml new file mode 100644 index 00000000..1df68544 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.StatusType.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.StatusType +name: StatusType +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.models.StatusType +summary: The status of the operation. +module: azure.mgmt.azureadb2c.v2019_01_01_preview.models +fields: +- name: FAILED + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.StatusType.FAILED +- name: PENDING + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.StatusType.PENDING +- name: SUCCEEDED + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.StatusType.SUCCEEDED diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.yml new file mode 100644 index 00000000..82eb3f47 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models +name: models +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.models +type: import +classes: +- azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatus +- azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatusError +- azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKU +- azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResource +- azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResourceList +- azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResourcePropertiesBillingConfig +- azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantUpdateRequest +- azure.mgmt.azureadb2c.v2019_01_01_preview.models.CheckNameAvailabilityRequestBody +- azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBody +- azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBodyProperties +- azure.mgmt.azureadb2c.v2019_01_01_preview.models.ErrorAdditionalInfo +- azure.mgmt.azureadb2c.v2019_01_01_preview.models.ErrorResponse +- azure.mgmt.azureadb2c.v2019_01_01_preview.models.NameAvailabilityResponse +- azure.mgmt.azureadb2c.v2019_01_01_preview.models.Operation +- azure.mgmt.azureadb2c.v2019_01_01_preview.models.OperationDisplay +- azure.mgmt.azureadb2c.v2019_01_01_preview.models.OperationListResult +enums: +- azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKUName +- azure.mgmt.azureadb2c.v2019_01_01_preview.models.BillingType +- azure.mgmt.azureadb2c.v2019_01_01_preview.models.NameAvailabilityReasonType +- azure.mgmt.azureadb2c.v2019_01_01_preview.models.StatusType diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.operations.B2CTenantsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.operations.B2CTenantsOperations.yml new file mode 100644 index 00000000..e7b06fff --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.operations.B2CTenantsOperations.yml @@ -0,0 +1,251 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.operations.B2CTenantsOperations +name: B2CTenantsOperations +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.operations.B2CTenantsOperations +module: azure.mgmt.azureadb2c.v2019_01_01_preview.operations +summary: 'B2CTenantsOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: B2CTenantsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.operations.B2CTenantsOperations.begin_create + name: begin_create + summary: 'Initiates an async request to create both the Azure AD B2C tenant and + the corresponding Azure + + resource linked to a subscription.' + signature: 'begin_create(resource_group_name: str, resource_name: str, create_tenant_request_body: + ''_models.CreateTenantRequestBody'' | None = None, **kwargs: Any) -> LROPoller[''_models.B2CTenantResource'']' + parameters: + - name: resource_group_name + description: The name of the resource group. + isRequired: true + types: + - + - name: resource_name + description: The initial domain name of the B2C tenant. + isRequired: true + types: + - + - name: create_tenant_request_body + defaultValue: None + types: + - () + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either B2CTenantResource or + the result of cls(response) + types: + - [~$(--)] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.operations.B2CTenantsOperations.begin_delete + name: begin_delete + summary: 'Initiates an async operation to delete the Azure AD B2C tenant and Azure + resource. The resource + + deletion can only happen as the last step in [the tenant deletion process](https://aka.ms/deleteB2Ctenant).' + signature: 'begin_delete(resource_group_name: str, resource_name: str, **kwargs: + Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: The name of the resource group. + isRequired: true + types: + - + - name: resource_name + description: The initial domain name of the B2C tenant. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.operations.B2CTenantsOperations.check_name_availability + name: check_name_availability + summary: Checks the availability and validity of a domain name for the tenant. + signature: 'check_name_availability(check_name_availability_request_body: ''_models.CheckNameAvailabilityRequestBody'' + | None = None, **kwargs: Any) -> _models.NameAvailabilityResponse' + parameters: + - name: check_name_availability_request_body + defaultValue: None + types: + - () + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: NameAvailabilityResponse, or the result of cls(response) + types: + - $(--) + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.operations.B2CTenantsOperations.get + name: get + summary: Get the Azure AD B2C tenant resource. + signature: 'get(resource_group_name: str, resource_name: str, **kwargs: Any) -> + _models.B2CTenantResource' + parameters: + - name: resource_group_name + description: The name of the resource group. + isRequired: true + types: + - + - name: resource_name + description: The initial domain name of the B2C tenant. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: B2CTenantResource, or the result of cls(response) + types: + - $(--) + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.operations.B2CTenantsOperations.list_by_resource_group + name: list_by_resource_group + summary: Get all the Azure AD B2C tenant resources in a resource group. + signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[''_models.B2CTenantResourceList'']' + parameters: + - name: resource_group_name + description: The name of the resource group. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either B2CTenantResourceList or the + result of cls(response) + types: + - [~$(--)] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.operations.B2CTenantsOperations.list_by_subscription + name: list_by_subscription + summary: Get all the Azure AD B2C tenant resources in a subscription. + signature: 'list_by_subscription(**kwargs: Any) -> Iterable[''_models.B2CTenantResourceList'']' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either B2CTenantResourceList or the + result of cls(response) + types: + - [~$(--)] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.operations.B2CTenantsOperations.update + name: update + summary: Update the Azure AD B2C tenant resource. + signature: 'update(resource_group_name: str, resource_name: str, update_tenant_request_body: + ''_models.B2CTenantUpdateRequest'' | None = None, **kwargs: Any) -> _models.B2CTenantResource' + parameters: + - name: resource_group_name + description: The name of the resource group. + isRequired: true + types: + - + - name: resource_name + description: The initial domain name of the B2C tenant. + isRequired: true + types: + - + - name: update_tenant_request_body + defaultValue: None + types: + - () + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: B2CTenantResource, or the result of cls(response) + types: + - $(--) + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.operations.B2CTenantsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.operations.Operations.yml new file mode 100644 index 00000000..add0e1f0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.operations.Operations.yml @@ -0,0 +1,73 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.operations.Operations +name: Operations +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.operations.Operations +module: azure.mgmt.azureadb2c.v2019_01_01_preview.operations +summary: 'Operations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: Operations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.operations.Operations.get_async_status + name: get_async_status + summary: Gets the status of the async operation. + signature: 'get_async_status(operation_id: str, **kwargs: Any) -> _models.AsyncOperationStatus' + parameters: + - name: operation_id + description: The operation ID. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AsyncOperationStatus, or the result of cls(response) + types: + - $(--) + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.operations.Operations.list + name: list + summary: Lists the operations available from this provider. + signature: 'list(**kwargs: Any) -> Iterable[''_models.OperationListResult'']' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either OperationListResult or the result + of cls(response) + types: + - [~$(--)] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.azureadb2c.v2019_01_01_preview.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.operations.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.operations.yml new file mode 100644 index 00000000..ab2231f6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.operations.yml @@ -0,0 +1,8 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.azureadb2c.v2019_01_01_preview.operations +name: operations +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview.operations +type: import +classes: +- azure.mgmt.azureadb2c.v2019_01_01_preview.operations.B2CTenantsOperations +- azure.mgmt.azureadb2c.v2019_01_01_preview.operations.Operations diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.yml new file mode 100644 index 00000000..2a645638 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.azureadb2c.v2019_01_01_preview +name: v2019_01_01_preview +fullName: azure.mgmt.azureadb2c.v2019_01_01_preview +type: import +classes: +- azure.mgmt.azureadb2c.v2019_01_01_preview.CPIMConfigurationClient +packages: +- azure.mgmt.azureadb2c.v2019_01_01_preview.aio +- azure.mgmt.azureadb2c.v2019_01_01_preview.models +- azure.mgmt.azureadb2c.v2019_01_01_preview.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.CPIMConfigurationClient.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.CPIMConfigurationClient.yml new file mode 100644 index 00000000..03140b7f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.CPIMConfigurationClient.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2020_05_01_preview.CPIMConfigurationClient +name: CPIMConfigurationClient +fullName: azure.mgmt.azureadb2c.v2020_05_01_preview.CPIMConfigurationClient +module: azure.mgmt.azureadb2c.v2020_05_01_preview +summary: CPIM Configuration Client. +constructor: + syntax: 'CPIMConfigurationClient(credential: ''TokenCredential'', subscription_id: + str, base_url: str | None = None, **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: subscription_id + description: The Azure subscription ID. This is a GUID-formatted string (e.g. + 00000000-0000-0000-0000-000000000000). + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - +variables: +- description: Operations operations + name: operations + types: + - () +- description: GuestUsagesOperations operations + name: guest_usages + types: + - () +methods: +- uid: azure.mgmt.azureadb2c.v2020_05_01_preview.CPIMConfigurationClient.close + name: close + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.aio.CPIMConfigurationClient.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.aio.CPIMConfigurationClient.yml new file mode 100644 index 00000000..ca795a26 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.aio.CPIMConfigurationClient.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.CPIMConfigurationClient +name: CPIMConfigurationClient +fullName: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.CPIMConfigurationClient +module: azure.mgmt.azureadb2c.v2020_05_01_preview.aio +summary: CPIM Configuration Client. +constructor: + syntax: 'CPIMConfigurationClient(credential: AsyncTokenCredential, subscription_id: + str, base_url: str | None = None, **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: subscription_id + description: The Azure subscription ID. This is a GUID-formatted string (e.g. + 00000000-0000-0000-0000-000000000000). + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - +variables: +- description: Operations operations + name: operations + types: + - () +- description: GuestUsagesOperations operations + name: guest_usages + types: + - () +methods: +- uid: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.CPIMConfigurationClient.close + name: close + signature: async close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.GuestUsagesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.GuestUsagesOperations.yml new file mode 100644 index 00000000..8bad5436 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.GuestUsagesOperations.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.GuestUsagesOperations +name: GuestUsagesOperations +fullName: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.GuestUsagesOperations +module: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations +summary: 'GuestUsagesOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: GuestUsagesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.GuestUsagesOperations.create + name: create + summary: 'Creates a Guest Usages resource. + + + Creates a Guest Usages resource for the Microsoft.AzureActiveDirectory resource + provider.' + signature: 'async create(resource_group_name: str, resource_name: str, resource: + GuestUsagesResource | None = None, **kwargs) -> GuestUsagesResource' + parameters: + - name: resource_group_name + description: The name of the resource group. + isRequired: true + types: + - + - name: resource_name + description: The initial domain name of the AAD tenant. + isRequired: true + types: + - + - name: resource + description: Guest Usages resource to be created. + defaultValue: None + types: + - () + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: GuestUsagesResource, or the result of cls(response) + types: + - $(--) + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.GuestUsagesOperations.delete + name: delete + summary: 'Deletes a Guest Usages resource. + + + Deletes a Guest Usages resource for the Microsoft.AzureActiveDirectory resource + provider.' + signature: 'async delete(resource_group_name: str, resource_name: str, **kwargs) + -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. + isRequired: true + types: + - + - name: resource_name + description: The initial domain name of the AAD tenant. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.GuestUsagesOperations.get + name: get + summary: 'Gets a Guest Usages resource. + + + Gets a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider.' + signature: 'async get(resource_group_name: str, resource_name: str, **kwargs) -> + GuestUsagesResource' + parameters: + - name: resource_group_name + description: The name of the resource group. + isRequired: true + types: + - + - name: resource_name + description: The initial domain name of the AAD tenant. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: GuestUsagesResource, or the result of cls(response) + types: + - $(--) + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.GuestUsagesOperations.list_by_resource_group + name: list_by_resource_group + summary: 'Gets Guest Usages resources under resource group. + + + Gets Guest Usages resources under a resource group for the Microsoft.AzureActiveDirectory + + resource provider.' + signature: 'list_by_resource_group(resource_group_name: str, **kwargs) -> AsyncIterable[GuestUsagesResourceList]' + parameters: + - name: resource_group_name + description: The name of the resource group. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either GuestUsagesResourceList or the + result of cls(response) + types: + - [~$(--)] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.GuestUsagesOperations.list_by_subscription + name: list_by_subscription + summary: 'Gets Guest Usages resources under a subscription. + + + Gets Guest Usages resources under a subscription for the Microsoft.AzureActiveDirectory + + resource provider.' + signature: list_by_subscription(**kwargs) -> AsyncIterable[GuestUsagesResourceList] + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either GuestUsagesResourceList or the + result of cls(response) + types: + - [~$(--)] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.GuestUsagesOperations.update + name: update + summary: 'Updates a Guest Usages resource. + + + Updates a Guest Usages resource for the Microsoft.AzureActiveDirectory resource + provider.' + signature: 'async update(resource_group_name: str, resource_name: str, resource_patch: + GuestUsagesResourcePatch | None = None, **kwargs) -> GuestUsagesResource' + parameters: + - name: resource_group_name + description: The name of the resource group. + isRequired: true + types: + - + - name: resource_name + description: The initial domain name of the AAD tenant. + isRequired: true + types: + - + - name: resource_patch + description: Guest Usages Resource to be updated. + defaultValue: None + types: + - () + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: GuestUsagesResource, or the result of cls(response) + types: + - $(--) + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.GuestUsagesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.Operations.yml new file mode 100644 index 00000000..7b9ed173 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.Operations.yml @@ -0,0 +1,52 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.Operations +name: Operations +fullName: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.Operations +module: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations +summary: 'Operations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: Operations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.Operations.list + name: list + summary: Lists the operations available from this provider. + signature: list(**kwargs) -> AsyncIterable[OperationListResult] + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either OperationListResult or the result + of cls(response) + types: + - [~$(--)] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.yml new file mode 100644 index 00000000..aa3721d3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.yml @@ -0,0 +1,8 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations +name: operations +fullName: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations +type: import +classes: +- azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.GuestUsagesOperations +- azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.Operations diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.aio.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.aio.yml new file mode 100644 index 00000000..689f5d34 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.aio.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.azureadb2c.v2020_05_01_preview.aio +name: aio +fullName: azure.mgmt.azureadb2c.v2020_05_01_preview.aio +type: import +classes: +- azure.mgmt.azureadb2c.v2020_05_01_preview.aio.CPIMConfigurationClient +packages: +- azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.ErrorAdditionalInfo.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.ErrorAdditionalInfo.yml new file mode 100644 index 00000000..8c1af580 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.ErrorAdditionalInfo.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2020_05_01_preview.models.ErrorAdditionalInfo +name: ErrorAdditionalInfo +fullName: azure.mgmt.azureadb2c.v2020_05_01_preview.models.ErrorAdditionalInfo +module: azure.mgmt.azureadb2c.v2020_05_01_preview.models +summary: 'The resource management error additional info. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: ErrorAdditionalInfo(**kwargs) +variables: +- description: The additional info type. + name: type + types: + - +- description: The additional info. + name: info + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.ErrorResponse.yml new file mode 100644 index 00000000..e41d7dd6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.ErrorResponse.yml @@ -0,0 +1,33 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2020_05_01_preview.models.ErrorResponse +name: ErrorResponse +fullName: azure.mgmt.azureadb2c.v2020_05_01_preview.models.ErrorResponse +module: azure.mgmt.azureadb2c.v2020_05_01_preview.models +summary: 'Common error response for all Azure Resource Manager APIs to return error + details for failed operations. (This also follows the OData error response format.). + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: ErrorResponse(**kwargs) +variables: +- description: The error code. + name: code + types: + - +- description: The error message. + name: message + types: + - +- description: The error target. + name: target + types: + - +- description: The error details. + name: details + types: + - [()] +- description: The error additional info. + name: additional_info + types: + - [()] diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResource.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResource.yml new file mode 100644 index 00000000..dcb801cc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResource.yml @@ -0,0 +1,49 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResource +name: GuestUsagesResource +fullName: azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResource +module: azure.mgmt.azureadb2c.v2020_05_01_preview.models +summary: 'Guest Usages Resource. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'GuestUsagesResource(*, location: str | None = None, tags: Dict[str, str] + | None = None, tenant_id: str | None = None, **kwargs)' + parameters: + - name: location + description: Location of the Guest Usages resource. + isRequired: true + types: + - + - name: tags + description: A set of tags. Key-value pairs of additional resource provisioning + properties. + isRequired: true + types: + - [, ] + - name: tenant_id + description: An identifier for the tenant for which the resource is being created. + isRequired: true + types: + - + keywordOnlyParameters: + - name: location + isRequired: true + - name: tags + isRequired: true + - name: tenant_id + isRequired: true +variables: +- description: An identifier that represents the Guest Usages resource. + name: id + types: + - +- description: The name of the Guest Usages resource. + name: name + types: + - +- description: The type of the Guest Usages resource. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResourceList.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResourceList.yml new file mode 100644 index 00000000..ee52f610 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResourceList.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResourceList +name: GuestUsagesResourceList +fullName: azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResourceList +module: azure.mgmt.azureadb2c.v2020_05_01_preview.models +summary: 'The collection of guest usages resources. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: GuestUsagesResourceList(**kwargs) +variables: +- description: List of guest usages resources. + name: value + types: + - [()] diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResourcePatch.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResourcePatch.yml new file mode 100644 index 00000000..c7441289 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResourcePatch.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResourcePatch +name: GuestUsagesResourcePatch +fullName: azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResourcePatch +module: azure.mgmt.azureadb2c.v2020_05_01_preview.models +summary: Guest Usages Resource for Patch. +constructor: + syntax: 'GuestUsagesResourcePatch(*, tags: Dict[str, str] | None = None, **kwargs)' + parameters: + - name: tags + description: A set of tags. Key-value pairs of additional resource provisioning + properties. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: tags + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.Operation.yml new file mode 100644 index 00000000..67707876 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.Operation.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2020_05_01_preview.models.Operation +name: Operation +fullName: azure.mgmt.azureadb2c.v2020_05_01_preview.models.Operation +module: azure.mgmt.azureadb2c.v2020_05_01_preview.models +summary: 'Microsoft.AzureActiveDirectory REST API operation. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'Operation(*, display: OperationDisplay | None = None, **kwargs)' + parameters: + - name: display + description: The object that represents the operation. + isRequired: true + types: + - () + keywordOnlyParameters: + - name: display + isRequired: true +variables: +- description: 'Operation name: {provider}/{resource}/{operation}.' + name: name + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.OperationDisplay.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.OperationDisplay.yml new file mode 100644 index 00000000..68ef3c90 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.OperationDisplay.yml @@ -0,0 +1,33 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2020_05_01_preview.models.OperationDisplay +name: OperationDisplay +fullName: azure.mgmt.azureadb2c.v2020_05_01_preview.models.OperationDisplay +module: azure.mgmt.azureadb2c.v2020_05_01_preview.models +summary: 'The object that represents the operation. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'OperationDisplay(*, description: str | None = None, **kwargs)' + parameters: + - name: description + description: Friendly name of the operation. + isRequired: true + types: + - + keywordOnlyParameters: + - name: description + isRequired: true +variables: +- description: 'Service provider: Microsoft.AzureActiveDirectory.' + name: provider + types: + - +- description: 'Resource on which the operation is performed: GuestUsages, etc.' + name: resource + types: + - +- description: 'Operation type: Read, write, delete, etc.' + name: operation + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.OperationListResult.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.OperationListResult.yml new file mode 100644 index 00000000..42f66dc1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.OperationListResult.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2020_05_01_preview.models.OperationListResult +name: OperationListResult +fullName: azure.mgmt.azureadb2c.v2020_05_01_preview.models.OperationListResult +module: azure.mgmt.azureadb2c.v2020_05_01_preview.models +summary: 'Result of listing operations for the resourceProvider. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: OperationListResult(**kwargs) +variables: +- description: 'List of cpim service operations supported by the Microsoft.AzureActiveDirectory + + resource provider.' + name: value + types: + - [()] diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.yml new file mode 100644 index 00000000..cb539ac5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.azureadb2c.v2020_05_01_preview.models +name: models +fullName: azure.mgmt.azureadb2c.v2020_05_01_preview.models +type: import +classes: +- azure.mgmt.azureadb2c.v2020_05_01_preview.models.ErrorAdditionalInfo +- azure.mgmt.azureadb2c.v2020_05_01_preview.models.ErrorResponse +- azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResource +- azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResourceList +- azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResourcePatch +- azure.mgmt.azureadb2c.v2020_05_01_preview.models.Operation +- azure.mgmt.azureadb2c.v2020_05_01_preview.models.OperationDisplay +- azure.mgmt.azureadb2c.v2020_05_01_preview.models.OperationListResult diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.operations.GuestUsagesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.operations.GuestUsagesOperations.yml new file mode 100644 index 00000000..fcd2c1e5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.operations.GuestUsagesOperations.yml @@ -0,0 +1,217 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2020_05_01_preview.operations.GuestUsagesOperations +name: GuestUsagesOperations +fullName: azure.mgmt.azureadb2c.v2020_05_01_preview.operations.GuestUsagesOperations +module: azure.mgmt.azureadb2c.v2020_05_01_preview.operations +summary: 'GuestUsagesOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: GuestUsagesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.azureadb2c.v2020_05_01_preview.operations.GuestUsagesOperations.create + name: create + summary: 'Creates a Guest Usages resource. + + + Creates a Guest Usages resource for the Microsoft.AzureActiveDirectory resource + provider.' + signature: 'create(resource_group_name: str, resource_name: str, resource: ''_models.GuestUsagesResource'' + | None = None, **kwargs: Any) -> _models.GuestUsagesResource' + parameters: + - name: resource_group_name + description: The name of the resource group. + isRequired: true + types: + - + - name: resource_name + description: The initial domain name of the AAD tenant. + isRequired: true + types: + - + - name: resource + description: Guest Usages resource to be created. + defaultValue: None + types: + - () + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: GuestUsagesResource, or the result of cls(response) + types: + - $(--) + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2020_05_01_preview.operations.GuestUsagesOperations.delete + name: delete + summary: 'Deletes a Guest Usages resource. + + + Deletes a Guest Usages resource for the Microsoft.AzureActiveDirectory resource + provider.' + signature: 'delete(resource_group_name: str, resource_name: str, **kwargs: Any) + -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. + isRequired: true + types: + - + - name: resource_name + description: The initial domain name of the AAD tenant. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2020_05_01_preview.operations.GuestUsagesOperations.get + name: get + summary: 'Gets a Guest Usages resource. + + + Gets a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider.' + signature: 'get(resource_group_name: str, resource_name: str, **kwargs: Any) -> + _models.GuestUsagesResource' + parameters: + - name: resource_group_name + description: The name of the resource group. + isRequired: true + types: + - + - name: resource_name + description: The initial domain name of the AAD tenant. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: GuestUsagesResource, or the result of cls(response) + types: + - $(--) + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2020_05_01_preview.operations.GuestUsagesOperations.list_by_resource_group + name: list_by_resource_group + summary: 'Gets Guest Usages resources under resource group. + + + Gets Guest Usages resources under a resource group for the Microsoft.AzureActiveDirectory + + resource provider.' + signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[''_models.GuestUsagesResourceList'']' + parameters: + - name: resource_group_name + description: The name of the resource group. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either GuestUsagesResourceList or the + result of cls(response) + types: + - [~$(--)] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2020_05_01_preview.operations.GuestUsagesOperations.list_by_subscription + name: list_by_subscription + summary: 'Gets Guest Usages resources under a subscription. + + + Gets Guest Usages resources under a subscription for the Microsoft.AzureActiveDirectory + + resource provider.' + signature: 'list_by_subscription(**kwargs: Any) -> Iterable[''_models.GuestUsagesResourceList'']' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either GuestUsagesResourceList or the + result of cls(response) + types: + - [~$(--)] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azureadb2c.v2020_05_01_preview.operations.GuestUsagesOperations.update + name: update + summary: 'Updates a Guest Usages resource. + + + Updates a Guest Usages resource for the Microsoft.AzureActiveDirectory resource + provider.' + signature: 'update(resource_group_name: str, resource_name: str, resource_patch: + ''_models.GuestUsagesResourcePatch'' | None = None, **kwargs: Any) -> _models.GuestUsagesResource' + parameters: + - name: resource_group_name + description: The name of the resource group. + isRequired: true + types: + - + - name: resource_name + description: The initial domain name of the AAD tenant. + isRequired: true + types: + - + - name: resource_patch + description: Guest Usages Resource to be updated. + defaultValue: None + types: + - () + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: GuestUsagesResource, or the result of cls(response) + types: + - $(--) + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.azureadb2c.v2020_05_01_preview.operations.GuestUsagesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.operations.Operations.yml new file mode 100644 index 00000000..6d0a5abc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.operations.Operations.yml @@ -0,0 +1,52 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azureadb2c.v2020_05_01_preview.operations.Operations +name: Operations +fullName: azure.mgmt.azureadb2c.v2020_05_01_preview.operations.Operations +module: azure.mgmt.azureadb2c.v2020_05_01_preview.operations +summary: 'Operations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: Operations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.azureadb2c.v2020_05_01_preview.operations.Operations.list + name: list + summary: Lists the operations available from this provider. + signature: 'list(**kwargs: Any) -> Iterable[''_models.OperationListResult'']' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either OperationListResult or the result + of cls(response) + types: + - [~$(--)] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.azureadb2c.v2020_05_01_preview.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.operations.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.operations.yml new file mode 100644 index 00000000..39e23cd7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.operations.yml @@ -0,0 +1,8 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.azureadb2c.v2020_05_01_preview.operations +name: operations +fullName: azure.mgmt.azureadb2c.v2020_05_01_preview.operations +type: import +classes: +- azure.mgmt.azureadb2c.v2020_05_01_preview.operations.GuestUsagesOperations +- azure.mgmt.azureadb2c.v2020_05_01_preview.operations.Operations diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.yml new file mode 100644 index 00000000..a62c92ef --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.azureadb2c.v2020_05_01_preview +name: v2020_05_01_preview +fullName: azure.mgmt.azureadb2c.v2020_05_01_preview +type: import +classes: +- azure.mgmt.azureadb2c.v2020_05_01_preview.CPIMConfigurationClient +packages: +- azure.mgmt.azureadb2c.v2020_05_01_preview.aio +- azure.mgmt.azureadb2c.v2020_05_01_preview.models +- azure.mgmt.azureadb2c.v2020_05_01_preview.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.yml new file mode 100644 index 00000000..e3fcd508 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.azureadb2c +name: azureadb2c +fullName: azure.mgmt.azureadb2c +type: rootImport +classes: +- azure.mgmt.azureadb2c.CPIMConfigurationClient +packages: +- azure.mgmt.azureadb2c.aio +- azure.mgmt.azureadb2c.v2019_01_01_preview +- azure.mgmt.azureadb2c.v2020_05_01_preview +modules: +- azure.mgmt.azureadb2c.models diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.LargeInstanceMgmtClient.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.LargeInstanceMgmtClient.yml new file mode 100644 index 00000000..d8e7818d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.LargeInstanceMgmtClient.yml @@ -0,0 +1,55 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.LargeInstanceMgmtClient +name: LargeInstanceMgmtClient +fullName: azure.mgmt.azurelargeinstance.LargeInstanceMgmtClient +module: azure.mgmt.azurelargeinstance +summary: The AzureLargeInstance Management client. +constructor: + syntax: 'LargeInstanceMgmtClient(credential: TokenCredential, subscription_id: str, + base_url: str = ''https://management.azure.com'', **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. Required. + isRequired: true + types: + - + - name: subscription_id + description: The ID of the target subscription. The value must be an UUID. Required. + isRequired: true + types: + - + - name: base_url + description: Service URL. Default value is "`https://management.azure.com`". + defaultValue: https://management.azure.com + types: + - + keywordOnlyParameters: + - name: api_version + description: 'Api Version. Default value is "2023-07-20-preview". Note that overriding + + this default value may result in unsupported behavior.' + types: + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - +variables: +- description: Operations operations + name: operations + types: + - +- description: AzureLargeInstanceOperations operations + name: azure_large_instance + types: + - +- description: AzureLargeStorageInstanceOperations operations + name: azure_large_storage_instance + types: + - +methods: +- uid: azure.mgmt.azurelargeinstance.LargeInstanceMgmtClient.close + name: close + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.LargeInstanceMgmtClient.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.LargeInstanceMgmtClient.yml new file mode 100644 index 00000000..04af7f6b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.LargeInstanceMgmtClient.yml @@ -0,0 +1,55 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.aio.LargeInstanceMgmtClient +name: LargeInstanceMgmtClient +fullName: azure.mgmt.azurelargeinstance.aio.LargeInstanceMgmtClient +module: azure.mgmt.azurelargeinstance.aio +summary: The AzureLargeInstance Management client. +constructor: + syntax: 'LargeInstanceMgmtClient(credential: AsyncTokenCredential, subscription_id: + str, base_url: str = ''https://management.azure.com'', **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. Required. + isRequired: true + types: + - + - name: subscription_id + description: The ID of the target subscription. The value must be an UUID. Required. + isRequired: true + types: + - + - name: base_url + description: Service URL. Default value is "`https://management.azure.com`". + defaultValue: https://management.azure.com + types: + - + keywordOnlyParameters: + - name: api_version + description: 'Api Version. Default value is "2023-07-20-preview". Note that overriding + + this default value may result in unsupported behavior.' + types: + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - +variables: +- description: Operations operations + name: operations + types: + - +- description: AzureLargeInstanceOperations operations + name: azure_large_instance + types: + - +- description: AzureLargeStorageInstanceOperations operations + name: azure_large_storage_instance + types: + - +methods: +- uid: azure.mgmt.azurelargeinstance.aio.LargeInstanceMgmtClient.close + name: close + signature: async close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.operations.AzureLargeInstanceOperations.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.operations.AzureLargeInstanceOperations.yml new file mode 100644 index 00000000..f5b062bd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.operations.AzureLargeInstanceOperations.yml @@ -0,0 +1,316 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.aio.operations.AzureLargeInstanceOperations +name: AzureLargeInstanceOperations +fullName: azure.mgmt.azurelargeinstance.aio.operations.AzureLargeInstanceOperations +module: azure.mgmt.azurelargeinstance.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: AzureLargeInstanceOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.azurelargeinstance.aio.operations.AzureLargeInstanceOperations.begin_restart + name: begin_restart + summary: The operation to restart an Azure Large Instance (only for compute instances). + signature: 'async begin_restart(resource_group_name: str, azure_large_instance_name: + str, force_parameter: _models.ForceState | None = None, *, content_type: str = + ''application/json'', **kwargs: Any) -> AsyncLROPoller[_models.OperationStatusResult]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: azure_large_instance_name + description: Name of the AzureLargeInstance. Required. + isRequired: true + types: + - + - name: force_parameter + description: 'When set to ''active'', this parameter empowers the server with + the + + ability to forcefully terminate and halt any existing processes that may be + running on the + + server. Is either a ForceState type or a IO type. Default value is None.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of AsyncLROPoller that returns either OperationStatusResult + or the result + + of cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azurelargeinstance.aio.operations.AzureLargeInstanceOperations.begin_shutdown + name: begin_shutdown + summary: The operation to shutdown an Azure Large Instance (only for compute instances). + signature: 'async begin_shutdown(resource_group_name: str, azure_large_instance_name: + str, **kwargs: Any) -> AsyncLROPoller[OperationStatusResult]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: azure_large_instance_name + description: Name of the AzureLargeInstance. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of AsyncLROPoller that returns either OperationStatusResult + or the result + + of cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azurelargeinstance.aio.operations.AzureLargeInstanceOperations.begin_start + name: begin_start + summary: The operation to start an Azure Large Instance (only for compute instances). + signature: 'async begin_start(resource_group_name: str, azure_large_instance_name: + str, **kwargs: Any) -> AsyncLROPoller[OperationStatusResult]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: azure_large_instance_name + description: Name of the AzureLargeInstance. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of AsyncLROPoller that returns either OperationStatusResult + or the result + + of cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azurelargeinstance.aio.operations.AzureLargeInstanceOperations.get + name: get + summary: 'Gets an Azure Large Instance for the specified subscription, resource + group, + + and instance name.' + signature: 'async get(resource_group_name: str, azure_large_instance_name: str, + **kwargs: Any) -> AzureLargeInstance' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: azure_large_instance_name + description: Name of the AzureLargeInstance. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AzureLargeInstance or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azurelargeinstance.aio.operations.AzureLargeInstanceOperations.list_by_resource_group + name: list_by_resource_group + summary: 'Gets a list of Azure Large Instances in the specified subscription and + resource + + group. The operations returns various properties of each Azure Large Instance.' + signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[AzureLargeInstance]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either AzureLargeInstance or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azurelargeinstance.aio.operations.AzureLargeInstanceOperations.list_by_subscription + name: list_by_subscription + summary: 'Gets a list of Azure Large Instances in the specified subscription. The + + operations returns various properties of each Azure Large Instance.' + signature: 'list_by_subscription(**kwargs: Any) -> AsyncIterable[AzureLargeInstance]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either AzureLargeInstance or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azurelargeinstance.aio.operations.AzureLargeInstanceOperations.update + name: update + summary: 'Patches the Tags field of an Azure Large Instance for the specified + + subscription, resource group, and instance name.' + signature: 'async update(resource_group_name: str, azure_large_instance_name: str, + properties: _models.AzureLargeInstanceTagsUpdate, *, content_type: str = ''application/json'', + **kwargs: Any) -> _models.AzureLargeInstance' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: azure_large_instance_name + description: Name of the AzureLargeInstance. Required. + isRequired: true + types: + - + - name: properties + description: 'The resource properties to be updated. Is either a + + AzureLargeInstanceTagsUpdate type or a IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AzureLargeInstance or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.azurelargeinstance.aio.operations.AzureLargeInstanceOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.operations.AzureLargeStorageInstanceOperations.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.operations.AzureLargeStorageInstanceOperations.yml new file mode 100644 index 00000000..1823c4e8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.operations.AzureLargeStorageInstanceOperations.yml @@ -0,0 +1,144 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.aio.operations.AzureLargeStorageInstanceOperations +name: AzureLargeStorageInstanceOperations +fullName: azure.mgmt.azurelargeinstance.aio.operations.AzureLargeStorageInstanceOperations +module: azure.mgmt.azurelargeinstance.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: AzureLargeStorageInstanceOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.azurelargeinstance.aio.operations.AzureLargeStorageInstanceOperations.get + name: get + summary: 'Gets an Azure Large Storage instance for the specified subscription, resource + + group, and instance name.' + signature: 'async get(resource_group_name: str, azure_large_storage_instance_name: + str, **kwargs: Any) -> AzureLargeStorageInstance' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: azure_large_storage_instance_name + description: Name of the AzureLargeStorageInstance. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AzureLargeStorageInstance or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azurelargeinstance.aio.operations.AzureLargeStorageInstanceOperations.list_by_resource_group + name: list_by_resource_group + summary: 'Gets a list of AzureLargeStorageInstances in the specified subscription + and + + resource group. The operations returns various properties of each Azure + + LargeStorage instance.' + signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[AzureLargeStorageInstance]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either AzureLargeStorageInstance or + the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azurelargeinstance.aio.operations.AzureLargeStorageInstanceOperations.list_by_subscription + name: list_by_subscription + summary: 'Gets a list of AzureLargeStorageInstances in the specified subscription. + The + + operations returns various properties of each Azure LargeStorage instance.' + signature: 'list_by_subscription(**kwargs: Any) -> AsyncIterable[AzureLargeStorageInstance]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either AzureLargeStorageInstance or + the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azurelargeinstance.aio.operations.AzureLargeStorageInstanceOperations.update + name: update + summary: 'Patches the Tags field of a Azure Large Storage Instance for the specified + + subscription, resource group, and instance name.' + signature: 'async update(resource_group_name: str, azure_large_storage_instance_name: + str, properties: _models.AzureLargeStorageInstanceTagsUpdate, *, content_type: + str = ''application/json'', **kwargs: Any) -> _models.AzureLargeStorageInstance' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: azure_large_storage_instance_name + description: Name of the AzureLargeStorageInstance. Required. + isRequired: true + types: + - + - name: properties + description: 'The resource properties to be updated. Is either a + + AzureLargeStorageInstanceTagsUpdate type or a IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AzureLargeStorageInstance or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.azurelargeinstance.aio.operations.AzureLargeStorageInstanceOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.operations.Operations.yml new file mode 100644 index 00000000..925aa0ca --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.operations.Operations.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.aio.operations.Operations +name: Operations +fullName: azure.mgmt.azurelargeinstance.aio.operations.Operations +module: azure.mgmt.azurelargeinstance.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: Operations(*args, **kwargs) +methods: +- uid: azure.mgmt.azurelargeinstance.aio.operations.Operations.list + name: list + summary: List the operations for the provider. + signature: 'list(**kwargs: Any) -> AsyncIterable[Operation]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either Operation or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.azurelargeinstance.aio.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.operations.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.operations.yml new file mode 100644 index 00000000..d614572a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.operations.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.azurelargeinstance.aio.operations +name: operations +fullName: azure.mgmt.azurelargeinstance.aio.operations +type: import +classes: +- azure.mgmt.azurelargeinstance.aio.operations.AzureLargeInstanceOperations +- azure.mgmt.azurelargeinstance.aio.operations.AzureLargeStorageInstanceOperations +- azure.mgmt.azurelargeinstance.aio.operations.Operations diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.yml new file mode 100644 index 00000000..62f245e1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.azurelargeinstance.aio +name: aio +fullName: azure.mgmt.azurelargeinstance.aio +type: import +classes: +- azure.mgmt.azurelargeinstance.aio.LargeInstanceMgmtClient +packages: +- azure.mgmt.azurelargeinstance.aio.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ActionType.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ActionType.yml new file mode 100644 index 00000000..71c31ef0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ActionType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.azurelargeinstance.models.ActionType +name: ActionType +fullName: azure.mgmt.azurelargeinstance.models.ActionType +summary: Enum. Indicates the action type. "Internal" refers to actions that are for + internal only APIs. +module: azure.mgmt.azurelargeinstance.models +fields: +- name: INTERNAL + uid: azure.mgmt.azurelargeinstance.models.ActionType.INTERNAL diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstance.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstance.yml new file mode 100644 index 00000000..c0c85d2d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstance.yml @@ -0,0 +1,66 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstance +name: AzureLargeInstance +fullName: azure.mgmt.azurelargeinstance.models.AzureLargeInstance +module: azure.mgmt.azurelargeinstance.models +summary: 'Azure Large Instance info on Azure (ARM properties and AzureLargeInstance + + properties). + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureLargeInstance(*, location: str, tags: Dict[str, str] | None = None, + properties: _models.AzureLargeInstanceProperties | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: tags + description: Resource tags. + types: + - [, ] + - name: location + description: The geo-location where the resource lives. Required. + types: + - + - name: properties + description: The resource-specific properties for this resource. + types: + - +variables: +- description: 'Fully qualified resource ID for the resource. E.g. + + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: Resource tags. + name: tags + types: + - [, ] +- description: The geo-location where the resource lives. Required. + name: location + types: + - +- description: The resource-specific properties for this resource. + name: properties + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceForcePowerState.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceForcePowerState.yml new file mode 100644 index 00000000..cd34dbea --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceForcePowerState.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceForcePowerState +name: AzureLargeInstanceForcePowerState +fullName: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceForcePowerState +summary: 'Enum of two possible values to determine if the ALI instance restart operation + should + + forcefully terminate and halt any existing processes that may be running on the + server or not.' +module: azure.mgmt.azurelargeinstance.models +fields: +- name: ACTIVE + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceForcePowerState.ACTIVE +- name: INACTIVE + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceForcePowerState.INACTIVE diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceHardwareTypeNamesEnum.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceHardwareTypeNamesEnum.yml new file mode 100644 index 00000000..b52bc3a5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceHardwareTypeNamesEnum.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceHardwareTypeNamesEnum +name: AzureLargeInstanceHardwareTypeNamesEnum +fullName: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceHardwareTypeNamesEnum +summary: Enum of the hardware options (vendor and/or their product name) for an Azure + Large Instance. +module: azure.mgmt.azurelargeinstance.models +fields: +- name: CISCO_UCS + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceHardwareTypeNamesEnum.CISCO_UCS +- name: HPE + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceHardwareTypeNamesEnum.HPE +- name: SDFLEX + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceHardwareTypeNamesEnum.SDFLEX diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceListResult.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceListResult.yml new file mode 100644 index 00000000..24ca7878 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceListResult.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceListResult +name: AzureLargeInstanceListResult +fullName: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceListResult +module: azure.mgmt.azurelargeinstance.models +summary: 'The response of a AzureLargeInstance list operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureLargeInstanceListResult(*, value: List[_models.AzureLargeInstance], + next_link: str | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: value + description: The AzureLargeInstance items on this page. Required. + types: + - [] + - name: next_link + description: The link to the next page of items. + types: + - +variables: +- description: The AzureLargeInstance items on this page. Required. + name: value + types: + - [] +- description: The link to the next page of items. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstancePowerStateEnum.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstancePowerStateEnum.yml new file mode 100644 index 00000000..9182e1ba --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstancePowerStateEnum.yml @@ -0,0 +1,19 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstancePowerStateEnum +name: AzureLargeInstancePowerStateEnum +fullName: azure.mgmt.azurelargeinstance.models.AzureLargeInstancePowerStateEnum +summary: Power states that an Azure Large Instance can be in. +module: azure.mgmt.azurelargeinstance.models +fields: +- name: RESTARTING + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstancePowerStateEnum.RESTARTING +- name: STARTED + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstancePowerStateEnum.STARTED +- name: STARTING + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstancePowerStateEnum.STARTING +- name: STOPPED + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstancePowerStateEnum.STOPPED +- name: STOPPING + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstancePowerStateEnum.STOPPING +- name: UNKNOWN + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstancePowerStateEnum.UNKNOWN diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProperties.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProperties.yml new file mode 100644 index 00000000..34501e5e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProperties.yml @@ -0,0 +1,92 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProperties +name: AzureLargeInstanceProperties +fullName: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProperties +module: azure.mgmt.azurelargeinstance.models +summary: 'Describes the properties of an Azure Large Instance. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'AzureLargeInstanceProperties(*, hardware_profile: _models.HardwareProfile + | None = None, storage_profile: _models.StorageProfile | None = None, os_profile: + _models.OsProfile | None = None, network_profile: _models.NetworkProfile | None + = None, partner_node_id: str | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: hardware_profile + description: Specifies the hardware settings for the Azure Large Instance. + types: + - + - name: storage_profile + description: Specifies the storage settings for the Azure Large Instance disks. + types: + - + - name: os_profile + description: Specifies the operating system settings for the Azure Large Instance. + types: + - + - name: network_profile + description: Specifies the network settings for the Azure Large Instance. + types: + - + - name: partner_node_id + description: 'ARM ID of another AzureLargeInstance that will share a network with + + this + + AzureLargeInstance.' + types: + - +variables: +- description: Specifies the hardware settings for the Azure Large Instance. + name: hardware_profile + types: + - +- description: Specifies the storage settings for the Azure Large Instance disks. + name: storage_profile + types: + - +- description: Specifies the operating system settings for the Azure Large Instance. + name: os_profile + types: + - +- description: Specifies the network settings for the Azure Large Instance. + name: network_profile + types: + - +- description: Specifies the Azure Large Instance unique ID. + name: azure_large_instance_id + types: + - +- description: 'Resource power state. Known values are: "starting", "started", "stopping", + + "stopped", "restarting", and "unknown".' + name: power_state + types: + - + - +- description: Resource proximity placement group. + name: proximity_placement_group + types: + - +- description: Hardware revision of an Azure Large Instance. + name: hw_revision + types: + - +- description: 'ARM ID of another AzureLargeInstance that will share a network with + this + + AzureLargeInstance.' + name: partner_node_id + types: + - +- description: 'State of provisioning of the AzureLargeInstance. Known values are: + + "Accepted", "Creating", "Updating", "Failed", "Succeeded", "Deleting", "Migrating", + and + + "Canceled".' + name: provisioning_state + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProvisioningStatesEnum.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProvisioningStatesEnum.yml new file mode 100644 index 00000000..04e2f2cc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProvisioningStatesEnum.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProvisioningStatesEnum +name: AzureLargeInstanceProvisioningStatesEnum +fullName: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProvisioningStatesEnum +summary: Provisioning states that an Azure Large Instance can be in. +module: azure.mgmt.azurelargeinstance.models +fields: +- name: ACCEPTED + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProvisioningStatesEnum.ACCEPTED +- name: CANCELED + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProvisioningStatesEnum.CANCELED +- name: CREATING + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProvisioningStatesEnum.CREATING +- name: DELETING + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProvisioningStatesEnum.DELETING +- name: FAILED + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProvisioningStatesEnum.FAILED +- name: MIGRATING + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProvisioningStatesEnum.MIGRATING +- name: SUCCEEDED + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProvisioningStatesEnum.SUCCEEDED +- name: UPDATING + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProvisioningStatesEnum.UPDATING diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.yml new file mode 100644 index 00000000..5eed75d1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.yml @@ -0,0 +1,102 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum +name: AzureLargeInstanceSizeNamesEnum +fullName: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum +summary: 'Enum of available model types (each of which have their own storage / memory + sizes) for an + + Azure Large Instance type. See + + [https://docs.microsoft.com/azure/sap/large-instances/hana-available-skus](https://docs.microsoft.com/azure/sap/large-instances/hana-available-skus).' +module: azure.mgmt.azurelargeinstance.models +fields: +- name: S112 + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S112 +- name: S144 + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S144 +- name: S144_M + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S144_M +- name: S192 + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S192 +- name: S192_M + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S192_M +- name: S192_XM + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S192_XM +- name: S224 + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S224 +- name: S224_M + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S224_M +- name: S224_OM + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S224_OM +- name: S224_OO + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S224_OO +- name: S224_OOM + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S224_OOM +- name: S224_OOO + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S224_OOO +- name: S224_SE + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S224_SE +- name: S384 + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S384 +- name: S384_M + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S384_M +- name: S384_XM + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S384_XM +- name: S384_XXM + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S384_XXM +- name: S448 + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S448 +- name: S448_M + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S448_M +- name: S448_OM + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S448_OM +- name: S448_OO + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S448_OO +- name: S448_OOM + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S448_OOM +- name: S448_OOO + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S448_OOO +- name: S448_SE + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S448_SE +- name: S576_M + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S576_M +- name: S576_XM + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S576_XM +- name: S672 + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S672 +- name: S672_M + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S672_M +- name: S672_OM + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S672_OM +- name: S672_OO + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S672_OO +- name: S672_OOM + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S672_OOM +- name: S672_OOO + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S672_OOO +- name: S72 + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S72 +- name: S72_M + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S72_M +- name: S768 + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S768 +- name: S768_M + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S768_M +- name: S768_XM + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S768_XM +- name: S896 + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S896 +- name: S896_M + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S896_M +- name: S896_OM + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S896_OM +- name: S896_OO + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S896_OO +- name: S896_OOM + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S896_OOM +- name: S896_OOO + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S896_OOO +- name: S96 + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S96 +- name: S960_M + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum.S960_M diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceTagsUpdate.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceTagsUpdate.yml new file mode 100644 index 00000000..14ab6dec --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceTagsUpdate.yml @@ -0,0 +1,19 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceTagsUpdate +name: AzureLargeInstanceTagsUpdate +fullName: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceTagsUpdate +module: azure.mgmt.azurelargeinstance.models +summary: The type used for updating tags in AzureLargeInstance resources. +constructor: + syntax: 'AzureLargeInstanceTagsUpdate(*, tags: Dict[str, str] | None = None, **kwargs: + Any)' + keywordOnlyParameters: + - name: tags + description: Resource tags. + types: + - [, ] +variables: +- description: Resource tags. + name: tags + types: + - [, ] diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstance.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstance.yml new file mode 100644 index 00000000..2237027b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstance.yml @@ -0,0 +1,67 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstance +name: AzureLargeStorageInstance +fullName: azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstance +module: azure.mgmt.azurelargeinstance.models +summary: 'AzureLargeStorageInstance info on Azure (ARM properties and + + AzureLargeStorageInstance properties). + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureLargeStorageInstance(*, location: str, tags: Dict[str, str] | None + = None, properties: _models.AzureLargeStorageInstanceProperties | None = None, + **kwargs: Any)' + keywordOnlyParameters: + - name: tags + description: Resource tags. + types: + - [, ] + - name: location + description: The geo-location where the resource lives. Required. + types: + - + - name: properties + description: The resource-specific properties for this resource. + types: + - +variables: +- description: 'Fully qualified resource ID for the resource. E.g. + + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: Resource tags. + name: tags + types: + - [, ] +- description: The geo-location where the resource lives. Required. + name: location + types: + - +- description: The resource-specific properties for this resource. + name: properties + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceListResult.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceListResult.yml new file mode 100644 index 00000000..1913d076 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceListResult.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceListResult +name: AzureLargeStorageInstanceListResult +fullName: azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceListResult +module: azure.mgmt.azurelargeinstance.models +summary: 'The response of a AzureLargeStorageInstance list operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureLargeStorageInstanceListResult(*, value: List[_models.AzureLargeStorageInstance], + next_link: str | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: value + description: The AzureLargeStorageInstance items on this page. Required. + types: + - [] + - name: next_link + description: The link to the next page of items. + types: + - +variables: +- description: The AzureLargeStorageInstance items on this page. Required. + name: value + types: + - [] +- description: The link to the next page of items. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceProperties.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceProperties.yml new file mode 100644 index 00000000..e9a4a923 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceProperties.yml @@ -0,0 +1,34 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceProperties +name: AzureLargeStorageInstanceProperties +fullName: azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceProperties +module: azure.mgmt.azurelargeinstance.models +summary: Describes the properties of an AzureLargeStorageInstance. +constructor: + syntax: 'AzureLargeStorageInstanceProperties(*, azure_large_storage_instance_unique_identifier: + str | None = None, storage_properties: _models.StorageProperties | None = None, + **kwargs: Any)' + keywordOnlyParameters: + - name: azure_large_storage_instance_unique_identifier + description: 'Specifies the + + AzureLargeStorageInstance unique ID.' + types: + - + - name: storage_properties + description: 'Specifies the storage properties for the AzureLargeStorage + + instance.' + types: + - +variables: +- description: 'Specifies the AzureLargeStorageInstance + + unique ID.' + name: azure_large_storage_instance_unique_identifier + types: + - +- description: Specifies the storage properties for the AzureLargeStorage instance. + name: storage_properties + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceTagsUpdate.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceTagsUpdate.yml new file mode 100644 index 00000000..aab559df --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceTagsUpdate.yml @@ -0,0 +1,19 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceTagsUpdate +name: AzureLargeStorageInstanceTagsUpdate +fullName: azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceTagsUpdate +module: azure.mgmt.azurelargeinstance.models +summary: The type used for updating tags in AzureLargeStorageInstance resources. +constructor: + syntax: 'AzureLargeStorageInstanceTagsUpdate(*, tags: Dict[str, str] | None = None, + **kwargs: Any)' + keywordOnlyParameters: + - name: tags + description: Resource tags. + types: + - [, ] +variables: +- description: Resource tags. + name: tags + types: + - [, ] diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.CreatedByType.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.CreatedByType.yml new file mode 100644 index 00000000..ad4fb0e2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.CreatedByType.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.azurelargeinstance.models.CreatedByType +name: CreatedByType +fullName: azure.mgmt.azurelargeinstance.models.CreatedByType +summary: The type of identity that created the resource. +module: azure.mgmt.azurelargeinstance.models +fields: +- name: APPLICATION + uid: azure.mgmt.azurelargeinstance.models.CreatedByType.APPLICATION +- name: KEY + uid: azure.mgmt.azurelargeinstance.models.CreatedByType.KEY +- name: MANAGED_IDENTITY + uid: azure.mgmt.azurelargeinstance.models.CreatedByType.MANAGED_IDENTITY +- name: USER + uid: azure.mgmt.azurelargeinstance.models.CreatedByType.USER diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Disk.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Disk.yml new file mode 100644 index 00000000..6121b471 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Disk.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.Disk +name: Disk +fullName: azure.mgmt.azurelargeinstance.models.Disk +module: azure.mgmt.azurelargeinstance.models +summary: 'Specifies the disk information fo the Azure Large Instance. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'Disk(*, name: str | None = None, disk_size_gb: int | None = None, **kwargs: + Any)' + keywordOnlyParameters: + - name: name + description: The disk name. + types: + - + - name: disk_size_gb + description: Specifies the size of an empty data disk in gigabytes. + types: + - +variables: +- description: The disk name. + name: name + types: + - +- description: Specifies the size of an empty data disk in gigabytes. + name: disk_size_gb + types: + - +- description: 'Specifies the logical unit number of the data disk. This value is + used to + + identify data disks within the VM and therefore must be unique for each data + + disk attached to a VM.' + name: lun + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ErrorAdditionalInfo.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ErrorAdditionalInfo.yml new file mode 100644 index 00000000..0dcfa30b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ErrorAdditionalInfo.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.ErrorAdditionalInfo +name: ErrorAdditionalInfo +fullName: azure.mgmt.azurelargeinstance.models.ErrorAdditionalInfo +module: azure.mgmt.azurelargeinstance.models +summary: 'The resource management error additional info. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'ErrorAdditionalInfo(**kwargs: Any)' +variables: +- description: The additional info type. + name: type + types: + - +- description: The additional info. + name: info + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ErrorDetail.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ErrorDetail.yml new file mode 100644 index 00000000..0be86ba0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ErrorDetail.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.ErrorDetail +name: ErrorDetail +fullName: azure.mgmt.azurelargeinstance.models.ErrorDetail +module: azure.mgmt.azurelargeinstance.models +summary: 'The error detail. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'ErrorDetail(**kwargs: Any)' +variables: +- description: The error code. + name: code + types: + - +- description: The error message. + name: message + types: + - +- description: The error target. + name: target + types: + - +- description: The error details. + name: details + types: + - [] +- description: The error additional info. + name: additional_info + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ErrorResponse.yml new file mode 100644 index 00000000..e291879d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ErrorResponse.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.ErrorResponse +name: ErrorResponse +fullName: azure.mgmt.azurelargeinstance.models.ErrorResponse +module: azure.mgmt.azurelargeinstance.models +summary: 'Common error response for all Azure Resource Manager APIs to return error + details for failed + + operations. (This also follows the OData error response format.).' +constructor: + syntax: 'ErrorResponse(*, error: _models.ErrorDetail | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: error + description: The error object. + types: + - +variables: +- description: The error object. + name: error + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ForceState.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ForceState.yml new file mode 100644 index 00000000..f58e8dea --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ForceState.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.ForceState +name: ForceState +fullName: azure.mgmt.azurelargeinstance.models.ForceState +module: azure.mgmt.azurelargeinstance.models +summary: 'The active state empowers the server with the ability to forcefully terminate + + and halt any existing processes that may be running on the server.' +constructor: + syntax: 'ForceState(*, force_state: str | _models.AzureLargeInstanceForcePowerState + | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: force_state + description: 'Whether to force restart by shutting all processes. Known values + are: + + "active" and "inactive".' + types: + - + - +variables: +- description: 'Whether to force restart by shutting all processes. Known values are: + + "active" and "inactive".' + name: force_state + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.HardwareProfile.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.HardwareProfile.yml new file mode 100644 index 00000000..9971fecb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.HardwareProfile.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.HardwareProfile +name: HardwareProfile +fullName: azure.mgmt.azurelargeinstance.models.HardwareProfile +module: azure.mgmt.azurelargeinstance.models +summary: 'Specifies the hardware settings for the Azure Large Instance. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'HardwareProfile(**kwargs: Any)' +variables: +- description: 'Name of the hardware type (vendor and/or their product name). Known + values + + are: "Cisco_UCS", "HPE", and "SDFLEX".' + name: hardware_type + types: + - + - +- description: 'Specifies the Azure Large Instance SKU. Known values are: + + "S72m", "S144m", "S72", "S144", "S192", "S192m", "S192xm", "S96", "S112", "S224", + "S224m", + + "S224om", "S224oo", "S224oom", "S224ooo", "S224se", "S384", "S384m", "S384xm", + "S384xxm", + + "S448", "S448m", "S448om", "S448oo", "S448oom", "S448ooo", "S448se", "S576m", + "S576xm", "S672", + + "S672m", "S672om", "S672oo", "S672oom", "S672ooo", "S768", "S768m", "S768xm", + "S896", "S896m", + + "S896om", "S896oo", "S896oom", "S896ooo", and "S960m".' + name: azure_large_instance_size + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.IpAddress.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.IpAddress.yml new file mode 100644 index 00000000..02b2fe2b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.IpAddress.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.IpAddress +name: IpAddress +fullName: azure.mgmt.azurelargeinstance.models.IpAddress +module: azure.mgmt.azurelargeinstance.models +summary: Specifies the IP address of the network interface. +constructor: + syntax: 'IpAddress(*, ip_address: str | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: ip_address + description: Specifies the IP address of the network interface. + types: + - +variables: +- description: Specifies the IP address of the network interface. + name: ip_address + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.NetworkProfile.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.NetworkProfile.yml new file mode 100644 index 00000000..3fc54fcb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.NetworkProfile.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.NetworkProfile +name: NetworkProfile +fullName: azure.mgmt.azurelargeinstance.models.NetworkProfile +module: azure.mgmt.azurelargeinstance.models +summary: 'Specifies the network settings for the Azure Large Instance disks. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'NetworkProfile(*, network_interfaces: List[_models.IpAddress] | None = + None, **kwargs: Any)' + keywordOnlyParameters: + - name: network_interfaces + description: Specifies the network interfaces for the Azure Large Instance. + types: + - [] +variables: +- description: Specifies the network interfaces for the Azure Large Instance. + name: network_interfaces + types: + - [] +- description: Specifies the circuit id for connecting to express route. + name: circuit_id + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Operation.yml new file mode 100644 index 00000000..18ab1ce6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Operation.yml @@ -0,0 +1,55 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.Operation +name: Operation +fullName: azure.mgmt.azurelargeinstance.models.Operation +module: azure.mgmt.azurelargeinstance.models +summary: 'Details of a REST API operation, returned from the Resource Provider Operations + API. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'Operation(*, display: _models.OperationDisplay | None = None, **kwargs: + Any)' + keywordOnlyParameters: + - name: display + description: Localized display information for this particular operation. + types: + - +variables: +- description: 'The name of the operation, as per Resource-Based Access Control (RBAC). + Examples: + + "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action".' + name: name + types: + - +- description: 'Whether the operation applies to data-plane. This is "true" for + + data-plane operations and "false" for ARM/control-plane operations.' + name: is_data_action + types: + - +- description: Localized display information for this particular operation. + name: display + types: + - +- description: 'The intended executor of the operation; as in Resource Based Access + Control + + (RBAC) and audit logs UX. Default value is "user,system". Known values are: "user", + "system", + + and "user,system".' + name: origin + types: + - + - +- description: 'Enum. Indicates the action type. "Internal" refers to actions that + are for + + internal only APIs. "Internal"' + name: action_type + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OperationDisplay.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OperationDisplay.yml new file mode 100644 index 00000000..bc906ee7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OperationDisplay.yml @@ -0,0 +1,37 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.OperationDisplay +name: OperationDisplay +fullName: azure.mgmt.azurelargeinstance.models.OperationDisplay +module: azure.mgmt.azurelargeinstance.models +summary: 'Localized display information for this particular operation. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'OperationDisplay(**kwargs: Any)' +variables: +- description: 'The localized friendly form of the resource provider name, e.g. "Microsoft + + Monitoring Insights" or "Microsoft Compute".' + name: provider + types: + - +- description: 'The localized friendly name of the resource type related to this operation. + + E.g. "Virtual Machines" or "Job Schedule Collections".' + name: resource + types: + - +- description: 'The concise, localized friendly name for the operation; suitable for + + dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine".' + name: operation + types: + - +- description: 'The short, localized friendly description of the operation; suitable + for + + tool tips and detailed views.' + name: description + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OperationListResult.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OperationListResult.yml new file mode 100644 index 00000000..b14fed32 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OperationListResult.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.OperationListResult +name: OperationListResult +fullName: azure.mgmt.azurelargeinstance.models.OperationListResult +module: azure.mgmt.azurelargeinstance.models +summary: 'A list of REST API operations supported by an Azure Resource Provider. It + contains an URL link + + to get the next set of results. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'OperationListResult(**kwargs: Any)' +variables: +- description: List of operations supported by the resource provider. + name: value + types: + - [] +- description: URL to get the next set of operation list results (if there are any). + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OperationStatusResult.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OperationStatusResult.yml new file mode 100644 index 00000000..3d0492ae --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OperationStatusResult.yml @@ -0,0 +1,89 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.OperationStatusResult +name: OperationStatusResult +fullName: azure.mgmt.azurelargeinstance.models.OperationStatusResult +module: azure.mgmt.azurelargeinstance.models +summary: 'The current status of an async operation. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'OperationStatusResult(*, status: str, id: str | None = None, name: str + | None = None, percent_complete: float | None = None, start_time: datetime | None + = None, end_time: datetime | None = None, operations: List[_models.OperationStatusResult] + | None = None, error: _models.ErrorDetail | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: id + description: Fully qualified ID for the async operation. + types: + - + - name: name + description: Name of the async operation. + types: + - + - name: status + description: Operation status. Required. + types: + - + - name: percent_complete + description: Percent of the operation that is complete. + types: + - + - name: start_time + description: The start time of the operation. + types: + - + - name: end_time + description: The end time of the operation. + types: + - + - name: operations + description: The operations list. + types: + - [] + - name: error + description: If present, details of the operation error. + types: + - +variables: +- description: Fully qualified ID for the async operation. + name: id + types: + - +- description: 'Fully qualified ID of the resource against which the original async + + operation was started.' + name: resource_id + types: + - +- description: Name of the async operation. + name: name + types: + - +- description: Operation status. Required. + name: status + types: + - +- description: Percent of the operation that is complete. + name: percent_complete + types: + - +- description: The start time of the operation. + name: start_time + types: + - +- description: The end time of the operation. + name: end_time + types: + - +- description: The operations list. + name: operations + types: + - [] +- description: If present, details of the operation error. + name: error + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Origin.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Origin.yml new file mode 100644 index 00000000..74cb2da2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Origin.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.azurelargeinstance.models.Origin +name: Origin +fullName: azure.mgmt.azurelargeinstance.models.Origin +summary: 'The intended executor of the operation; as in Resource Based Access Control + (RBAC) and audit + + logs UX. Default value is "user,system".' +module: azure.mgmt.azurelargeinstance.models +fields: +- name: SYSTEM + uid: azure.mgmt.azurelargeinstance.models.Origin.SYSTEM +- name: USER + uid: azure.mgmt.azurelargeinstance.models.Origin.USER +- name: USER_SYSTEM + uid: azure.mgmt.azurelargeinstance.models.Origin.USER_SYSTEM diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OsProfile.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OsProfile.yml new file mode 100644 index 00000000..451285a7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OsProfile.yml @@ -0,0 +1,38 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.OsProfile +name: OsProfile +fullName: azure.mgmt.azurelargeinstance.models.OsProfile +module: azure.mgmt.azurelargeinstance.models +summary: 'Specifies the operating system settings for the Azure Large Instance. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'OsProfile(*, computer_name: str | None = None, ssh_public_key: str | None + = None, **kwargs: Any)' + keywordOnlyParameters: + - name: computer_name + description: Specifies the host OS name of the Azure Large Instance. + types: + - + - name: ssh_public_key + description: Specifies the SSH public key used to access the operating system. + types: + - +variables: +- description: Specifies the host OS name of the Azure Large Instance. + name: computer_name + types: + - +- description: This property allows you to specify the type of the OS. + name: os_type + types: + - +- description: Specifies version of operating system. + name: version + types: + - +- description: Specifies the SSH public key used to access the operating system. + name: ssh_public_key + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ProvisioningState.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ProvisioningState.yml new file mode 100644 index 00000000..fbfdd87f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ProvisioningState.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.azurelargeinstance.models.ProvisioningState +name: ProvisioningState +fullName: azure.mgmt.azurelargeinstance.models.ProvisioningState +summary: An enum of possible operation states for an AzureLargeStorageInstances. +module: azure.mgmt.azurelargeinstance.models +fields: +- name: ACCEPTED + uid: azure.mgmt.azurelargeinstance.models.ProvisioningState.ACCEPTED +- name: CANCELED + uid: azure.mgmt.azurelargeinstance.models.ProvisioningState.CANCELED +- name: CREATING + uid: azure.mgmt.azurelargeinstance.models.ProvisioningState.CREATING +- name: DELETING + uid: azure.mgmt.azurelargeinstance.models.ProvisioningState.DELETING +- name: FAILED + uid: azure.mgmt.azurelargeinstance.models.ProvisioningState.FAILED +- name: MIGRATING + uid: azure.mgmt.azurelargeinstance.models.ProvisioningState.MIGRATING +- name: SUCCEEDED + uid: azure.mgmt.azurelargeinstance.models.ProvisioningState.SUCCEEDED +- name: UPDATING + uid: azure.mgmt.azurelargeinstance.models.ProvisioningState.UPDATING diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Resource.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Resource.yml new file mode 100644 index 00000000..22c575e2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Resource.yml @@ -0,0 +1,36 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.Resource +name: Resource +fullName: azure.mgmt.azurelargeinstance.models.Resource +module: azure.mgmt.azurelargeinstance.models +summary: 'Common fields that are returned in the response for all Azure Resource Manager + resources. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'Resource(**kwargs: Any)' +variables: +- description: 'Fully qualified resource ID for the resource. E.g. + + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageBillingProperties.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageBillingProperties.yml new file mode 100644 index 00000000..02461cd7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageBillingProperties.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.StorageBillingProperties +name: StorageBillingProperties +fullName: azure.mgmt.azurelargeinstance.models.StorageBillingProperties +module: azure.mgmt.azurelargeinstance.models +summary: Describes the billing related details of the AzureLargeStorageInstance. +constructor: + syntax: 'StorageBillingProperties(*, billing_mode: str | None = None, sku: str | + None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: billing_mode + description: the billing mode for the storage instance. + types: + - + - name: sku + description: the SKU type that is provisioned. + types: + - +variables: +- description: the billing mode for the storage instance. + name: billing_mode + types: + - +- description: the SKU type that is provisioned. + name: sku + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageProfile.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageProfile.yml new file mode 100644 index 00000000..12aafae3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageProfile.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.StorageProfile +name: StorageProfile +fullName: azure.mgmt.azurelargeinstance.models.StorageProfile +module: azure.mgmt.azurelargeinstance.models +summary: 'Specifies the storage settings for the Azure Large Instance disks. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'StorageProfile(*, os_disks: List[_models.Disk] | None = None, **kwargs: + Any)' + keywordOnlyParameters: + - name: os_disks + description: 'Specifies information about the operating system disk used by Azure + Large + + Instance.' + types: + - [] +variables: +- description: IP Address to connect to storage. + name: nfs_ip_address + types: + - +- description: 'Specifies information about the operating system disk used by Azure + Large + + Instance.' + name: os_disks + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageProperties.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageProperties.yml new file mode 100644 index 00000000..87cf626b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageProperties.yml @@ -0,0 +1,80 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.StorageProperties +name: StorageProperties +fullName: azure.mgmt.azurelargeinstance.models.StorageProperties +module: azure.mgmt.azurelargeinstance.models +summary: 'described the storage properties of the azure large storage instance. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'StorageProperties(*, offering_type: str | None = None, storage_type: str + | None = None, generation: str | None = None, hardware_type: str | _models.AzureLargeInstanceHardwareTypeNamesEnum + | None = None, workload_type: str | None = None, storage_billing_properties: _models.StorageBillingProperties + | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: offering_type + description: the offering type for which the resource is getting provisioned. + types: + - + - name: storage_type + description: the storage protocol for which the resource is getting provisioned. + types: + - + - name: generation + description: the kind of storage instance. + types: + - + - name: hardware_type + description: 'the hardware type of the storage instance. Known values are: + + "Cisco_UCS", "HPE", and "SDFLEX".' + types: + - + - + - name: workload_type + description: the workload for which the resource is getting provisioned. + types: + - + - name: storage_billing_properties + description: the billing related information for the resource. + types: + - +variables: +- description: 'State of provisioning of the AzureLargeStorageInstance. Known values + + are: "Accepted", "Creating", "Updating", "Failed", "Succeeded", "Deleting", "Canceled", + and + + "Migrating".' + name: provisioning_state + types: + - + - +- description: the offering type for which the resource is getting provisioned. + name: offering_type + types: + - +- description: the storage protocol for which the resource is getting provisioned. + name: storage_type + types: + - +- description: the kind of storage instance. + name: generation + types: + - +- description: 'the hardware type of the storage instance. Known values are: "Cisco_UCS", + + "HPE", and "SDFLEX".' + name: hardware_type + types: + - + - +- description: the workload for which the resource is getting provisioned. + name: workload_type + types: + - +- description: the billing related information for the resource. + name: storage_billing_properties + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.SystemData.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.SystemData.yml new file mode 100644 index 00000000..fde456e1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.SystemData.yml @@ -0,0 +1,73 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.SystemData +name: SystemData +fullName: azure.mgmt.azurelargeinstance.models.SystemData +module: azure.mgmt.azurelargeinstance.models +summary: Metadata pertaining to creation and last modification of the resource. +constructor: + syntax: 'SystemData(*, created_by: str | None = None, created_by_type: str | _models.CreatedByType + | None = None, created_at: datetime | None = None, last_modified_by: str | None + = None, last_modified_by_type: str | _models.CreatedByType | None = None, last_modified_at: + datetime | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: created_by + description: The identity that created the resource. + types: + - + - name: created_by_type + description: 'The type of identity that created the resource. Known values are: + + "User", "Application", "ManagedIdentity", and "Key".' + types: + - + - + - name: created_at + description: The timestamp of resource creation (UTC). + types: + - + - name: last_modified_by + description: The identity that last modified the resource. + types: + - + - name: last_modified_by_type + description: 'The type of identity that last modified the resource. Known + + values are: "User", "Application", "ManagedIdentity", and "Key".' + types: + - + - + - name: last_modified_at + description: The timestamp of resource last modification (UTC). + types: + - +variables: +- description: The identity that created the resource. + name: created_by + types: + - +- description: 'The type of identity that created the resource. Known values are: + + "User", "Application", "ManagedIdentity", and "Key".' + name: created_by_type + types: + - + - +- description: The timestamp of resource creation (UTC). + name: created_at + types: + - +- description: The identity that last modified the resource. + name: last_modified_by + types: + - +- description: 'The type of identity that last modified the resource. Known values + + are: "User", "Application", "ManagedIdentity", and "Key".' + name: last_modified_by_type + types: + - + - +- description: The timestamp of resource last modification (UTC). + name: last_modified_at + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Tags.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Tags.yml new file mode 100644 index 00000000..000f74aa --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Tags.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.Tags +name: Tags +fullName: azure.mgmt.azurelargeinstance.models.Tags +module: azure.mgmt.azurelargeinstance.models +summary: Tags field of the AzureLargeInstance instance. +constructor: + syntax: 'Tags(*, tags: Dict[str, str] | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: tags + description: Tags field of the AzureLargeInstance instance. + types: + - [, ] +variables: +- description: Tags field of the AzureLargeInstance instance. + name: tags + types: + - [, ] diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.TrackedResource.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.TrackedResource.yml new file mode 100644 index 00000000..1875c5fd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.TrackedResource.yml @@ -0,0 +1,59 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.models.TrackedResource +name: TrackedResource +fullName: azure.mgmt.azurelargeinstance.models.TrackedResource +module: azure.mgmt.azurelargeinstance.models +summary: 'The resource model definition for an Azure Resource Manager tracked top + level resource which + + has ''tags'' and a ''location''. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TrackedResource(*, location: str, tags: Dict[str, str] | None = None, **kwargs: + Any)' + keywordOnlyParameters: + - name: tags + description: Resource tags. + types: + - [, ] + - name: location + description: The geo-location where the resource lives. Required. + types: + - +variables: +- description: 'Fully qualified resource ID for the resource. E.g. + + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: Resource tags. + name: tags + types: + - [, ] +- description: The geo-location where the resource lives. Required. + name: location + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Versions.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Versions.yml new file mode 100644 index 00000000..85dc10ff --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Versions.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.azurelargeinstance.models.Versions +name: Versions +fullName: azure.mgmt.azurelargeinstance.models.Versions +summary: Azure Large Instance api versions. +module: azure.mgmt.azurelargeinstance.models +fields: +- name: V2023_07_20_PREVIEW + uid: azure.mgmt.azurelargeinstance.models.Versions.V2023_07_20_PREVIEW diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.yml new file mode 100644 index 00000000..068fb3cd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.yml @@ -0,0 +1,45 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.azurelargeinstance.models +name: models +fullName: azure.mgmt.azurelargeinstance.models +type: import +classes: +- azure.mgmt.azurelargeinstance.models.AzureLargeInstance +- azure.mgmt.azurelargeinstance.models.AzureLargeInstanceListResult +- azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProperties +- azure.mgmt.azurelargeinstance.models.AzureLargeInstanceTagsUpdate +- azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstance +- azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceListResult +- azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceProperties +- azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceTagsUpdate +- azure.mgmt.azurelargeinstance.models.Disk +- azure.mgmt.azurelargeinstance.models.ErrorAdditionalInfo +- azure.mgmt.azurelargeinstance.models.ErrorDetail +- azure.mgmt.azurelargeinstance.models.ErrorResponse +- azure.mgmt.azurelargeinstance.models.ForceState +- azure.mgmt.azurelargeinstance.models.HardwareProfile +- azure.mgmt.azurelargeinstance.models.IpAddress +- azure.mgmt.azurelargeinstance.models.NetworkProfile +- azure.mgmt.azurelargeinstance.models.Operation +- azure.mgmt.azurelargeinstance.models.OperationDisplay +- azure.mgmt.azurelargeinstance.models.OperationListResult +- azure.mgmt.azurelargeinstance.models.OperationStatusResult +- azure.mgmt.azurelargeinstance.models.OsProfile +- azure.mgmt.azurelargeinstance.models.Resource +- azure.mgmt.azurelargeinstance.models.StorageBillingProperties +- azure.mgmt.azurelargeinstance.models.StorageProfile +- azure.mgmt.azurelargeinstance.models.StorageProperties +- azure.mgmt.azurelargeinstance.models.SystemData +- azure.mgmt.azurelargeinstance.models.Tags +- azure.mgmt.azurelargeinstance.models.TrackedResource +enums: +- azure.mgmt.azurelargeinstance.models.ActionType +- azure.mgmt.azurelargeinstance.models.AzureLargeInstanceForcePowerState +- azure.mgmt.azurelargeinstance.models.AzureLargeInstanceHardwareTypeNamesEnum +- azure.mgmt.azurelargeinstance.models.AzureLargeInstancePowerStateEnum +- azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProvisioningStatesEnum +- azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum +- azure.mgmt.azurelargeinstance.models.CreatedByType +- azure.mgmt.azurelargeinstance.models.Origin +- azure.mgmt.azurelargeinstance.models.ProvisioningState +- azure.mgmt.azurelargeinstance.models.Versions diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.operations.AzureLargeInstanceOperations.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.operations.AzureLargeInstanceOperations.yml new file mode 100644 index 00000000..f6900f16 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.operations.AzureLargeInstanceOperations.yml @@ -0,0 +1,316 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.operations.AzureLargeInstanceOperations +name: AzureLargeInstanceOperations +fullName: azure.mgmt.azurelargeinstance.operations.AzureLargeInstanceOperations +module: azure.mgmt.azurelargeinstance.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: AzureLargeInstanceOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.azurelargeinstance.operations.AzureLargeInstanceOperations.begin_restart + name: begin_restart + summary: The operation to restart an Azure Large Instance (only for compute instances). + signature: 'begin_restart(resource_group_name: str, azure_large_instance_name: str, + force_parameter: _models.ForceState | None = None, *, content_type: str = ''application/json'', + **kwargs: Any) -> LROPoller[_models.OperationStatusResult]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: azure_large_instance_name + description: Name of the AzureLargeInstance. Required. + isRequired: true + types: + - + - name: force_parameter + description: 'When set to ''active'', this parameter empowers the server with + the + + ability to forcefully terminate and halt any existing processes that may be + running on the + + server. Is either a ForceState type or a IO type. Default value is None.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of LROPoller that returns either OperationStatusResult + or the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azurelargeinstance.operations.AzureLargeInstanceOperations.begin_shutdown + name: begin_shutdown + summary: The operation to shutdown an Azure Large Instance (only for compute instances). + signature: 'begin_shutdown(resource_group_name: str, azure_large_instance_name: + str, **kwargs: Any) -> LROPoller[OperationStatusResult]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: azure_large_instance_name + description: Name of the AzureLargeInstance. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of LROPoller that returns either OperationStatusResult + or the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azurelargeinstance.operations.AzureLargeInstanceOperations.begin_start + name: begin_start + summary: The operation to start an Azure Large Instance (only for compute instances). + signature: 'begin_start(resource_group_name: str, azure_large_instance_name: str, + **kwargs: Any) -> LROPoller[OperationStatusResult]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: azure_large_instance_name + description: Name of the AzureLargeInstance. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of LROPoller that returns either OperationStatusResult + or the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azurelargeinstance.operations.AzureLargeInstanceOperations.get + name: get + summary: 'Gets an Azure Large Instance for the specified subscription, resource + group, + + and instance name.' + signature: 'get(resource_group_name: str, azure_large_instance_name: str, **kwargs: + Any) -> AzureLargeInstance' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: azure_large_instance_name + description: Name of the AzureLargeInstance. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AzureLargeInstance or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azurelargeinstance.operations.AzureLargeInstanceOperations.list_by_resource_group + name: list_by_resource_group + summary: 'Gets a list of Azure Large Instances in the specified subscription and + resource + + group. The operations returns various properties of each Azure Large Instance.' + signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[AzureLargeInstance]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either AzureLargeInstance or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azurelargeinstance.operations.AzureLargeInstanceOperations.list_by_subscription + name: list_by_subscription + summary: 'Gets a list of Azure Large Instances in the specified subscription. The + + operations returns various properties of each Azure Large Instance.' + signature: 'list_by_subscription(**kwargs: Any) -> Iterable[AzureLargeInstance]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either AzureLargeInstance or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azurelargeinstance.operations.AzureLargeInstanceOperations.update + name: update + summary: 'Patches the Tags field of an Azure Large Instance for the specified + + subscription, resource group, and instance name.' + signature: 'update(resource_group_name: str, azure_large_instance_name: str, properties: + _models.AzureLargeInstanceTagsUpdate, *, content_type: str = ''application/json'', + **kwargs: Any) -> _models.AzureLargeInstance' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: azure_large_instance_name + description: Name of the AzureLargeInstance. Required. + isRequired: true + types: + - + - name: properties + description: 'The resource properties to be updated. Is either a + + AzureLargeInstanceTagsUpdate type or a IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AzureLargeInstance or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.azurelargeinstance.operations.AzureLargeInstanceOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.operations.AzureLargeStorageInstanceOperations.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.operations.AzureLargeStorageInstanceOperations.yml new file mode 100644 index 00000000..aaa9fa04 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.operations.AzureLargeStorageInstanceOperations.yml @@ -0,0 +1,144 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.operations.AzureLargeStorageInstanceOperations +name: AzureLargeStorageInstanceOperations +fullName: azure.mgmt.azurelargeinstance.operations.AzureLargeStorageInstanceOperations +module: azure.mgmt.azurelargeinstance.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: AzureLargeStorageInstanceOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.azurelargeinstance.operations.AzureLargeStorageInstanceOperations.get + name: get + summary: 'Gets an Azure Large Storage instance for the specified subscription, resource + + group, and instance name.' + signature: 'get(resource_group_name: str, azure_large_storage_instance_name: str, + **kwargs: Any) -> AzureLargeStorageInstance' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: azure_large_storage_instance_name + description: Name of the AzureLargeStorageInstance. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AzureLargeStorageInstance or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azurelargeinstance.operations.AzureLargeStorageInstanceOperations.list_by_resource_group + name: list_by_resource_group + summary: 'Gets a list of AzureLargeStorageInstances in the specified subscription + and + + resource group. The operations returns various properties of each Azure + + LargeStorage instance.' + signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[AzureLargeStorageInstance]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either AzureLargeStorageInstance or + the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azurelargeinstance.operations.AzureLargeStorageInstanceOperations.list_by_subscription + name: list_by_subscription + summary: 'Gets a list of AzureLargeStorageInstances in the specified subscription. + The + + operations returns various properties of each Azure LargeStorage instance.' + signature: 'list_by_subscription(**kwargs: Any) -> Iterable[AzureLargeStorageInstance]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either AzureLargeStorageInstance or + the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.azurelargeinstance.operations.AzureLargeStorageInstanceOperations.update + name: update + summary: 'Patches the Tags field of a Azure Large Storage Instance for the specified + + subscription, resource group, and instance name.' + signature: 'update(resource_group_name: str, azure_large_storage_instance_name: + str, properties: _models.AzureLargeStorageInstanceTagsUpdate, *, content_type: + str = ''application/json'', **kwargs: Any) -> _models.AzureLargeStorageInstance' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: azure_large_storage_instance_name + description: Name of the AzureLargeStorageInstance. Required. + isRequired: true + types: + - + - name: properties + description: 'The resource properties to be updated. Is either a + + AzureLargeStorageInstanceTagsUpdate type or a IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AzureLargeStorageInstance or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.azurelargeinstance.operations.AzureLargeStorageInstanceOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.operations.Operations.yml new file mode 100644 index 00000000..e4a850c3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.operations.Operations.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.azurelargeinstance.operations.Operations +name: Operations +fullName: azure.mgmt.azurelargeinstance.operations.Operations +module: azure.mgmt.azurelargeinstance.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: Operations(*args, **kwargs) +methods: +- uid: azure.mgmt.azurelargeinstance.operations.Operations.list + name: list + summary: List the operations for the provider. + signature: 'list(**kwargs: Any) -> Iterable[Operation]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either Operation or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.azurelargeinstance.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.operations.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.operations.yml new file mode 100644 index 00000000..55dc30c0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.operations.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.azurelargeinstance.operations +name: operations +fullName: azure.mgmt.azurelargeinstance.operations +type: import +classes: +- azure.mgmt.azurelargeinstance.operations.AzureLargeInstanceOperations +- azure.mgmt.azurelargeinstance.operations.AzureLargeStorageInstanceOperations +- azure.mgmt.azurelargeinstance.operations.Operations diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.yml new file mode 100644 index 00000000..d3e7613e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.azurelargeinstance +name: azurelargeinstance +fullName: azure.mgmt.azurelargeinstance +type: rootImport +classes: +- azure.mgmt.azurelargeinstance.LargeInstanceMgmtClient +packages: +- azure.mgmt.azurelargeinstance.aio +- azure.mgmt.azurelargeinstance.models +- azure.mgmt.azurelargeinstance.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.BatchAI.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.BatchAI.yml new file mode 100644 index 00000000..f5273a20 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.BatchAI.yml @@ -0,0 +1,64 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.BatchAI +name: BatchAI +fullName: azure.mgmt.batchai.BatchAI +module: azure.mgmt.batchai +summary: The Azure BatchAI Management API. +constructor: + syntax: 'BatchAI(credential: ''TokenCredential'', subscription_id: str, base_url: + str | None = None, **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: subscription_id + description: The subscriptionID for the Azure user. + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - + keywordOnlyParameters: + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - +variables: +- description: Operations operations + name: operations + types: + - +- description: UsagesOperations operations + name: usages + types: + - +- description: WorkspacesOperations operations + name: workspaces + types: + - +- description: ExperimentsOperations operations + name: experiments + types: + - +- description: JobsOperations operations + name: jobs + types: + - +- description: FileServersOperations operations + name: file_servers + types: + - +- description: ClustersOperations operations + name: clusters + types: + - +methods: +- uid: azure.mgmt.batchai.BatchAI.close + name: close + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.BatchAI.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.BatchAI.yml new file mode 100644 index 00000000..98358ffa --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.BatchAI.yml @@ -0,0 +1,64 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.aio.BatchAI +name: BatchAI +fullName: azure.mgmt.batchai.aio.BatchAI +module: azure.mgmt.batchai.aio +summary: The Azure BatchAI Management API. +constructor: + syntax: 'BatchAI(credential: AsyncTokenCredential, subscription_id: str, base_url: + str | None = None, **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: subscription_id + description: The subscriptionID for the Azure user. + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - + keywordOnlyParameters: + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - +variables: +- description: Operations operations + name: operations + types: + - +- description: UsagesOperations operations + name: usages + types: + - +- description: WorkspacesOperations operations + name: workspaces + types: + - +- description: ExperimentsOperations operations + name: experiments + types: + - +- description: JobsOperations operations + name: jobs + types: + - +- description: FileServersOperations operations + name: file_servers + types: + - +- description: ClustersOperations operations + name: clusters + types: + - +methods: +- uid: azure.mgmt.batchai.aio.BatchAI.close + name: close + signature: async close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.ClustersOperations.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.ClustersOperations.yml new file mode 100644 index 00000000..871b7f23 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.ClustersOperations.yml @@ -0,0 +1,335 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.aio.operations.ClustersOperations +name: ClustersOperations +fullName: azure.mgmt.batchai.aio.operations.ClustersOperations +module: azure.mgmt.batchai.aio.operations +summary: 'ClustersOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: ClustersOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.batchai.aio.operations.ClustersOperations.begin_create + name: begin_create + summary: Creates a Cluster in the given Workspace. + signature: 'async begin_create(resource_group_name: str, workspace_name: str, cluster_name: + str, parameters: ClusterCreateParameters, **kwargs: Any) -> AsyncLROPoller[Cluster]' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: cluster_name + description: 'The name of the cluster within the specified resource group. Cluster + names + + can only contain a combination of alphanumeric characters along with dash (-) + and underscore + + (_). The name must be from 1 through 64 characters long.' + isRequired: true + types: + - + - name: parameters + description: The parameters to provide for the Cluster creation. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either Cluster or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.aio.operations.ClustersOperations.begin_delete + name: begin_delete + summary: Deletes a Cluster. + signature: 'async begin_delete(resource_group_name: str, workspace_name: str, cluster_name: + str, **kwargs: Any) -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: cluster_name + description: 'The name of the cluster within the specified resource group. Cluster + names + + can only contain a combination of alphanumeric characters along with dash (-) + and underscore + + (_). The name must be from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.aio.operations.ClustersOperations.get + name: get + summary: Gets information about a Cluster. + signature: 'async get(resource_group_name: str, workspace_name: str, cluster_name: + str, **kwargs: Any) -> Cluster' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: cluster_name + description: 'The name of the cluster within the specified resource group. Cluster + names + + can only contain a combination of alphanumeric characters along with dash (-) + and underscore + + (_). The name must be from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Cluster, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.aio.operations.ClustersOperations.list_by_workspace + name: list_by_workspace + summary: Gets information about Clusters associated with the given Workspace. + signature: 'list_by_workspace(resource_group_name: str, workspace_name: str, clusters_list_by_workspace_options: + ClustersListByWorkspaceOptions | None = None, **kwargs: Any) -> AsyncIterable[ClusterListResult]' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: clusters_list_by_workspace_options + description: Parameter group. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either ClusterListResult or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.aio.operations.ClustersOperations.list_remote_login_information + name: list_remote_login_information + summary: Get the IP address, port of all the compute nodes in the Cluster. + signature: 'list_remote_login_information(resource_group_name: str, workspace_name: + str, cluster_name: str, **kwargs: Any) -> AsyncIterable[RemoteLoginInformationListResult]' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: cluster_name + description: 'The name of the cluster within the specified resource group. Cluster + names + + can only contain a combination of alphanumeric characters along with dash (-) + and underscore + + (_). The name must be from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either RemoteLoginInformationListResult + or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.aio.operations.ClustersOperations.update + name: update + summary: Updates properties of a Cluster. + signature: 'async update(resource_group_name: str, workspace_name: str, cluster_name: + str, parameters: ClusterUpdateParameters, **kwargs: Any) -> Cluster' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: cluster_name + description: 'The name of the cluster within the specified resource group. Cluster + names + + can only contain a combination of alphanumeric characters along with dash (-) + and underscore + + (_). The name must be from 1 through 64 characters long.' + isRequired: true + types: + - + - name: parameters + description: Additional parameters for cluster update. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Cluster, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.batchai.aio.operations.ClustersOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.ExperimentsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.ExperimentsOperations.yml new file mode 100644 index 00000000..f21f3ef1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.ExperimentsOperations.yml @@ -0,0 +1,235 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.aio.operations.ExperimentsOperations +name: ExperimentsOperations +fullName: azure.mgmt.batchai.aio.operations.ExperimentsOperations +module: azure.mgmt.batchai.aio.operations +summary: 'ExperimentsOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: ExperimentsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.batchai.aio.operations.ExperimentsOperations.begin_create + name: begin_create + summary: Creates an Experiment. + signature: 'async begin_create(resource_group_name: str, workspace_name: str, experiment_name: + str, **kwargs: Any) -> AsyncLROPoller[Experiment]' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: experiment_name + description: 'The name of the experiment. Experiment names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either Experiment or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.aio.operations.ExperimentsOperations.begin_delete + name: begin_delete + summary: Deletes an Experiment. + signature: 'async begin_delete(resource_group_name: str, workspace_name: str, experiment_name: + str, **kwargs: Any) -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: experiment_name + description: 'The name of the experiment. Experiment names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.aio.operations.ExperimentsOperations.get + name: get + summary: Gets information about an Experiment. + signature: 'async get(resource_group_name: str, workspace_name: str, experiment_name: + str, **kwargs: Any) -> Experiment' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: experiment_name + description: 'The name of the experiment. Experiment names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Experiment, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.aio.operations.ExperimentsOperations.list_by_workspace + name: list_by_workspace + summary: Gets a list of Experiments within the specified Workspace. + signature: 'list_by_workspace(resource_group_name: str, workspace_name: str, experiments_list_by_workspace_options: + ExperimentsListByWorkspaceOptions | None = None, **kwargs: Any) -> AsyncIterable[ExperimentListResult]' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: experiments_list_by_workspace_options + description: Parameter group. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either ExperimentListResult or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.batchai.aio.operations.ExperimentsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.FileServersOperations.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.FileServersOperations.yml new file mode 100644 index 00000000..3529a7a9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.FileServersOperations.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.aio.operations.FileServersOperations +name: FileServersOperations +fullName: azure.mgmt.batchai.aio.operations.FileServersOperations +module: azure.mgmt.batchai.aio.operations +summary: 'FileServersOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: FileServersOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.batchai.aio.operations.FileServersOperations.begin_create + name: begin_create + summary: Creates a File Server in the given workspace. + signature: 'async begin_create(resource_group_name: str, workspace_name: str, file_server_name: + str, parameters: FileServerCreateParameters, **kwargs: Any) -> AsyncLROPoller[FileServer]' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: file_server_name + description: 'The name of the file server within the specified resource group. + File + + server names can only contain a combination of alphanumeric characters along + with dash (-) and + + underscore (_). The name must be from 1 through 64 characters long.' + isRequired: true + types: + - + - name: parameters + description: The parameters to provide for File Server creation. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either FileServer or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.aio.operations.FileServersOperations.list_by_workspace + name: list_by_workspace + summary: Gets a list of File Servers associated with the specified workspace. + signature: 'list_by_workspace(resource_group_name: str, workspace_name: str, file_servers_list_by_workspace_options: + FileServersListByWorkspaceOptions | None = None, **kwargs: Any) -> AsyncIterable[FileServerListResult]' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: file_servers_list_by_workspace_options + description: Parameter group. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either FileServerListResult or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.batchai.aio.operations.FileServersOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.JobsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.JobsOperations.yml new file mode 100644 index 00000000..df5ee624 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.JobsOperations.yml @@ -0,0 +1,475 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.aio.operations.JobsOperations +name: JobsOperations +fullName: azure.mgmt.batchai.aio.operations.JobsOperations +module: azure.mgmt.batchai.aio.operations +summary: 'JobsOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: JobsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.batchai.aio.operations.JobsOperations.begin_create + name: begin_create + summary: Creates a Job in the given Experiment. + signature: 'async begin_create(resource_group_name: str, workspace_name: str, experiment_name: + str, job_name: str, parameters: JobCreateParameters, **kwargs: Any) -> AsyncLROPoller[Job]' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: experiment_name + description: 'The name of the experiment. Experiment names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: job_name + description: 'The name of the job within the specified resource group. Job names + can only + + contain a combination of alphanumeric characters along with dash (-) and underscore + (_). The + + name must be from 1 through 64 characters long.' + isRequired: true + types: + - + - name: parameters + description: The parameters to provide for job creation. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either Job or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.aio.operations.JobsOperations.begin_delete + name: begin_delete + summary: Deletes a Job. + signature: 'async begin_delete(resource_group_name: str, workspace_name: str, experiment_name: + str, job_name: str, **kwargs: Any) -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: experiment_name + description: 'The name of the experiment. Experiment names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: job_name + description: 'The name of the job within the specified resource group. Job names + can only + + contain a combination of alphanumeric characters along with dash (-) and underscore + (_). The + + name must be from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.aio.operations.JobsOperations.begin_terminate + name: begin_terminate + summary: Terminates a job. + signature: 'async begin_terminate(resource_group_name: str, workspace_name: str, + experiment_name: str, job_name: str, **kwargs: Any) -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: experiment_name + description: 'The name of the experiment. Experiment names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: job_name + description: 'The name of the job within the specified resource group. Job names + can only + + contain a combination of alphanumeric characters along with dash (-) and underscore + (_). The + + name must be from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.aio.operations.JobsOperations.get + name: get + summary: Gets information about a Job. + signature: 'async get(resource_group_name: str, workspace_name: str, experiment_name: + str, job_name: str, **kwargs: Any) -> Job' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: experiment_name + description: 'The name of the experiment. Experiment names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: job_name + description: 'The name of the job within the specified resource group. Job names + can only + + contain a combination of alphanumeric characters along with dash (-) and underscore + (_). The + + name must be from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Job, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.aio.operations.JobsOperations.list_by_experiment + name: list_by_experiment + summary: Gets a list of Jobs within the specified Experiment. + signature: 'list_by_experiment(resource_group_name: str, workspace_name: str, experiment_name: + str, jobs_list_by_experiment_options: JobsListByExperimentOptions | None = None, + **kwargs: Any) -> AsyncIterable[JobListResult]' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: experiment_name + description: 'The name of the experiment. Experiment names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: jobs_list_by_experiment_options + description: Parameter group. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either JobListResult or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.aio.operations.JobsOperations.list_output_files + name: list_output_files + summary: 'List all directories and files inside the given directory of the Job''s + output directory (if the + + output directory is on Azure File Share or Azure Storage Container).' + signature: 'list_output_files(resource_group_name: str, workspace_name: str, experiment_name: + str, job_name: str, jobs_list_output_files_options: JobsListOutputFilesOptions, + **kwargs: Any) -> AsyncIterable[FileListResult]' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: experiment_name + description: 'The name of the experiment. Experiment names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: job_name + description: 'The name of the job within the specified resource group. Job names + can only + + contain a combination of alphanumeric characters along with dash (-) and underscore + (_). The + + name must be from 1 through 64 characters long.' + isRequired: true + types: + - + - name: jobs_list_output_files_options + description: Parameter group. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either FileListResult or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.aio.operations.JobsOperations.list_remote_login_information + name: list_remote_login_information + summary: 'Gets a list of currently existing nodes which were used for the Job execution. + The returned + + information contains the node ID, its public IP and SSH port.' + signature: 'list_remote_login_information(resource_group_name: str, workspace_name: + str, experiment_name: str, job_name: str, **kwargs: Any) -> AsyncIterable[RemoteLoginInformationListResult]' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: experiment_name + description: 'The name of the experiment. Experiment names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: job_name + description: 'The name of the job within the specified resource group. Job names + can only + + contain a combination of alphanumeric characters along with dash (-) and underscore + (_). The + + name must be from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either RemoteLoginInformationListResult + or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.batchai.aio.operations.JobsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.Operations.yml new file mode 100644 index 00000000..badf6988 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.Operations.yml @@ -0,0 +1,51 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.aio.operations.Operations +name: Operations +fullName: azure.mgmt.batchai.aio.operations.Operations +module: azure.mgmt.batchai.aio.operations +summary: 'Operations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: Operations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.batchai.aio.operations.Operations.list + name: list + summary: Lists available operations for the Microsoft.BatchAI provider. + signature: 'list(**kwargs: Any) -> AsyncIterable[OperationListResult]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either OperationListResult or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.batchai.aio.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.UsagesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.UsagesOperations.yml new file mode 100644 index 00000000..351236d9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.UsagesOperations.yml @@ -0,0 +1,60 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.aio.operations.UsagesOperations +name: UsagesOperations +fullName: azure.mgmt.batchai.aio.operations.UsagesOperations +module: azure.mgmt.batchai.aio.operations +summary: 'UsagesOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: UsagesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.batchai.aio.operations.UsagesOperations.list + name: list + summary: 'Gets the current usage information as well as limits for Batch AI resources + for given + + subscription.' + signature: 'list(location: str, **kwargs: Any) -> AsyncIterable[ListUsagesResult]' + parameters: + - name: location + description: The location for which resource usage is queried. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either ListUsagesResult or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.batchai.aio.operations.UsagesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.WorkspacesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.WorkspacesOperations.yml new file mode 100644 index 00000000..eaad7589 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.WorkspacesOperations.yml @@ -0,0 +1,260 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.aio.operations.WorkspacesOperations +name: WorkspacesOperations +fullName: azure.mgmt.batchai.aio.operations.WorkspacesOperations +module: azure.mgmt.batchai.aio.operations +summary: 'WorkspacesOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: WorkspacesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.batchai.aio.operations.WorkspacesOperations.begin_create + name: begin_create + summary: Creates a Workspace. + signature: 'async begin_create(resource_group_name: str, workspace_name: str, parameters: + WorkspaceCreateParameters, **kwargs: Any) -> AsyncLROPoller[Workspace]' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: parameters + description: Workspace creation parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either Workspace or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.aio.operations.WorkspacesOperations.begin_delete + name: begin_delete + summary: Deletes a Workspace. + signature: 'async begin_delete(resource_group_name: str, workspace_name: str, **kwargs: + Any) -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.aio.operations.WorkspacesOperations.get + name: get + summary: Gets information about a Workspace. + signature: 'async get(resource_group_name: str, workspace_name: str, **kwargs: Any) + -> Workspace' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Workspace, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.aio.operations.WorkspacesOperations.list + name: list + summary: Gets a list of Workspaces associated with the given subscription. + signature: 'list(workspaces_list_options: WorkspacesListOptions | None = None, **kwargs: + Any) -> AsyncIterable[WorkspaceListResult]' + parameters: + - name: workspaces_list_options + description: Parameter group. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either WorkspaceListResult or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.aio.operations.WorkspacesOperations.list_by_resource_group + name: list_by_resource_group + summary: Gets a list of Workspaces within the specified resource group. + signature: 'list_by_resource_group(resource_group_name: str, workspaces_list_by_resource_group_options: + WorkspacesListByResourceGroupOptions | None = None, **kwargs: Any) -> AsyncIterable[WorkspaceListResult]' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspaces_list_by_resource_group_options + description: Parameter group. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either WorkspaceListResult or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.aio.operations.WorkspacesOperations.update + name: update + summary: Updates properties of a Workspace. + signature: 'async update(resource_group_name: str, workspace_name: str, parameters: + WorkspaceUpdateParameters, **kwargs: Any) -> Workspace' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: parameters + description: Additional parameters for workspace update. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Workspace, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.batchai.aio.operations.WorkspacesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.yml new file mode 100644 index 00000000..b276b488 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.operations.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.batchai.aio.operations +name: operations +fullName: azure.mgmt.batchai.aio.operations +type: import +classes: +- azure.mgmt.batchai.aio.operations.ClustersOperations +- azure.mgmt.batchai.aio.operations.ExperimentsOperations +- azure.mgmt.batchai.aio.operations.FileServersOperations +- azure.mgmt.batchai.aio.operations.JobsOperations +- azure.mgmt.batchai.aio.operations.Operations +- azure.mgmt.batchai.aio.operations.UsagesOperations +- azure.mgmt.batchai.aio.operations.WorkspacesOperations diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.yml new file mode 100644 index 00000000..00f8f1d5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.aio.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.batchai.aio +name: aio +fullName: azure.mgmt.batchai.aio +type: import +classes: +- azure.mgmt.batchai.aio.BatchAI +packages: +- azure.mgmt.batchai.aio.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AllocationState.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AllocationState.yml new file mode 100644 index 00000000..613af222 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AllocationState.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.batchai.models.AllocationState +name: AllocationState +fullName: azure.mgmt.batchai.models.AllocationState +summary: 'Allocation state of the cluster. Possible values are: steady - Indicates + that the cluster is + + not resizing. There are no changes to the number of compute nodes in the cluster + in progress. A + + cluster enters this state when it is created and when no operations are being performed + on the + + cluster to change the number of compute nodes. resizing - Indicates that the cluster + is + + resizing; that is, compute nodes are being added to or removed from the cluster.' +module: azure.mgmt.batchai.models +fields: +- name: RESIZING + uid: azure.mgmt.batchai.models.AllocationState.RESIZING +- name: STEADY + uid: azure.mgmt.batchai.models.AllocationState.STEADY diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AppInsightsReference.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AppInsightsReference.yml new file mode 100644 index 00000000..b3e51016 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AppInsightsReference.yml @@ -0,0 +1,40 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.AppInsightsReference +name: AppInsightsReference +fullName: azure.mgmt.batchai.models.AppInsightsReference +module: azure.mgmt.batchai.models +summary: 'Azure Application Insights information for performance counters reporting. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AppInsightsReference(*, component: ResourceId, instrumentation_key: str + | None = None, instrumentation_key_secret_reference: KeyVaultSecretReference | + None = None, **kwargs)' + parameters: + - name: component + description: Required. Azure Application Insights component resource ID. + isRequired: true + types: + - + - name: instrumentation_key + description: Value of the Azure Application Insights instrumentation key. + isRequired: true + types: + - + - name: instrumentation_key_secret_reference + description: 'KeyVault Store and Secret which contains Azure + + Application Insights instrumentation key. One of instrumentationKey or + + instrumentationKeySecretReference must be specified.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: component + isRequired: true + - name: instrumentation_key + isRequired: true + - name: instrumentation_key_secret_reference + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AutoScaleSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AutoScaleSettings.yml new file mode 100644 index 00000000..c9ea5c3b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AutoScaleSettings.yml @@ -0,0 +1,44 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.AutoScaleSettings +name: AutoScaleSettings +fullName: azure.mgmt.batchai.models.AutoScaleSettings +module: azure.mgmt.batchai.models +summary: 'Auto-scale settings for the cluster. The system automatically scales the + cluster up and down (within minimumNodeCount and maximumNodeCount) based on the + number of queued and running jobs assigned to the cluster. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AutoScaleSettings(*, minimum_node_count: int, maximum_node_count: int, + initial_node_count: int | None = 0, **kwargs)' + parameters: + - name: minimum_node_count + description: 'Required. The minimum number of compute nodes the Batch AI service + + will try to allocate for the cluster. Note, the actual number of nodes can be + less than the + + specified value if the subscription has not enough quota to fulfill the request.' + isRequired: true + types: + - + - name: maximum_node_count + description: Required. The maximum number of compute nodes the cluster can have. + isRequired: true + types: + - + - name: initial_node_count + description: 'The number of compute nodes to allocate on cluster creation. Note + + that this value is used only during cluster creation. Default: 0.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: minimum_node_count + isRequired: true + - name: maximum_node_count + isRequired: true + - name: initial_node_count + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AzureBlobFileSystemReference.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AzureBlobFileSystemReference.yml new file mode 100644 index 00000000..b942ab39 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AzureBlobFileSystemReference.yml @@ -0,0 +1,60 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.AzureBlobFileSystemReference +name: AzureBlobFileSystemReference +fullName: azure.mgmt.batchai.models.AzureBlobFileSystemReference +module: azure.mgmt.batchai.models +summary: 'Azure Blob Storage Container mounting configuration. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureBlobFileSystemReference(*, account_name: str, container_name: str, + credentials: AzureStorageCredentialsInfo, relative_mount_path: str, mount_options: + str | None = None, **kwargs)' + parameters: + - name: account_name + description: Required. Name of the Azure storage account. + isRequired: true + types: + - + - name: container_name + description: 'Required. Name of the Azure Blob Storage container to mount on the + + cluster.' + isRequired: true + types: + - + - name: credentials + description: Required. Information about the Azure storage credentials. + isRequired: true + types: + - + - name: relative_mount_path + description: 'Required. The relative path on the compute node where the Azure + + File container will be mounted. Note that all cluster level containers will + be mounted under + + $AZ_BATCHAI_MOUNT_ROOT location and all job level containers will be mounted + under + + $AZ_BATCHAI_JOB_MOUNT_ROOT.' + isRequired: true + types: + - + - name: mount_options + description: Mount options for mounting blobfuse file system. + isRequired: true + types: + - + keywordOnlyParameters: + - name: account_name + isRequired: true + - name: container_name + isRequired: true + - name: credentials + isRequired: true + - name: relative_mount_path + isRequired: true + - name: mount_options + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AzureFileShareReference.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AzureFileShareReference.yml new file mode 100644 index 00000000..0d32d0ae --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AzureFileShareReference.yml @@ -0,0 +1,67 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.AzureFileShareReference +name: AzureFileShareReference +fullName: azure.mgmt.batchai.models.AzureFileShareReference +module: azure.mgmt.batchai.models +summary: 'Azure File Share mounting configuration. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureFileShareReference(*, account_name: str, azure_file_url: str, credentials: + AzureStorageCredentialsInfo, relative_mount_path: str, file_mode: str | None = + ''0777'', directory_mode: str | None = ''0777'', **kwargs)' + parameters: + - name: account_name + description: Required. Name of the Azure storage account. + isRequired: true + types: + - + - name: azure_file_url + description: Required. URL to access the Azure File. + isRequired: true + types: + - + - name: credentials + description: Required. Information about the Azure storage credentials. + isRequired: true + types: + - + - name: relative_mount_path + description: 'Required. The relative path on the compute node where the Azure + + File share will be mounted. Note that all cluster level file shares will be + mounted under + + $AZ_BATCHAI_MOUNT_ROOT location and all job level file shares will be mounted + under + + $AZ_BATCHAI_JOB_MOUNT_ROOT.' + isRequired: true + types: + - + - name: file_mode + description: 'File mode for files on the mounted file share. Default value: 0777.' + isRequired: true + types: + - + - name: directory_mode + description: 'File mode for directories on the mounted file share. Default value: + + 0777.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: account_name + isRequired: true + - name: azure_file_url + isRequired: true + - name: credentials + isRequired: true + - name: relative_mount_path + isRequired: true + - name: file_mode + defaultValue: '0777' + - name: directory_mode + defaultValue: '0777' diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AzureStorageCredentialsInfo.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AzureStorageCredentialsInfo.yml new file mode 100644 index 00000000..8cf61a71 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AzureStorageCredentialsInfo.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.AzureStorageCredentialsInfo +name: AzureStorageCredentialsInfo +fullName: azure.mgmt.batchai.models.AzureStorageCredentialsInfo +module: azure.mgmt.batchai.models +summary: Azure storage account credentials. +constructor: + syntax: 'AzureStorageCredentialsInfo(*, account_key: str | None = None, account_key_secret_reference: + KeyVaultSecretReference | None = None, **kwargs)' + parameters: + - name: account_key + description: 'Storage account key. One of accountKey or accountKeySecretReference + must be + + specified.' + isRequired: true + types: + - + - name: account_key_secret_reference + description: 'Information about KeyVault secret storing the storage + + account key. One of accountKey or accountKeySecretReference must be specified.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: account_key + isRequired: true + - name: account_key_secret_reference + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.BatchAIError.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.BatchAIError.yml new file mode 100644 index 00000000..bc2cf5fc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.BatchAIError.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.BatchAIError +name: BatchAIError +fullName: azure.mgmt.batchai.models.BatchAIError +module: azure.mgmt.batchai.models +summary: 'An error response from the Batch AI service. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: BatchAIError(**kwargs) +variables: +- description: 'An identifier of the error. Codes are invariant and are intended to + be consumed + + programmatically.' + name: code + types: + - +- description: 'A message describing the error, intended to be suitable for display + in a user + + interface.' + name: message + types: + - +- description: A list of additional details about the error. + name: details + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CNTKsettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CNTKsettings.yml new file mode 100644 index 00000000..f70f04e5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CNTKsettings.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.CNTKsettings +name: CNTKsettings +fullName: azure.mgmt.batchai.models.CNTKsettings +module: azure.mgmt.batchai.models +summary: CNTK (aka Microsoft Cognitive Toolkit) job settings. +constructor: + syntax: 'CNTKsettings(*, language_type: str | None = None, config_file_path: str + | None = None, python_script_file_path: str | None = None, python_interpreter_path: + str | None = None, command_line_args: str | None = None, process_count: int | + None = None, **kwargs)' + parameters: + - name: language_type + description: 'The language to use for launching CNTK (aka Microsoft Cognitive + Toolkit) + + job. Valid values are ''BrainScript'' or ''Python''.' + isRequired: true + types: + - + - name: config_file_path + description: 'Specifies the path of the BrainScript config file. This property + can + + be specified only if the languageType is ''BrainScript''.' + isRequired: true + types: + - + - name: python_script_file_path + description: 'Python script to execute. This property can be specified only + + if the languageType is ''Python''.' + isRequired: true + types: + - + - name: python_interpreter_path + description: 'The path to the Python interpreter. This property can be + + specified only if the languageType is ''Python''.' + isRequired: true + types: + - + - name: command_line_args + description: 'Command line arguments that need to be passed to the python script + or + + cntk executable.' + isRequired: true + types: + - + - name: process_count + description: 'Number of processes to launch for the job execution. The default + value + + for this property is equal to nodeCount property.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: language_type + isRequired: true + - name: config_file_path + isRequired: true + - name: python_script_file_path + isRequired: true + - name: python_interpreter_path + isRequired: true + - name: command_line_args + isRequired: true + - name: process_count + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CachingType.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CachingType.yml new file mode 100644 index 00000000..eca0d800 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CachingType.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.batchai.models.CachingType +name: CachingType +fullName: azure.mgmt.batchai.models.CachingType +summary: 'Caching type for the disks. Available values are none (default), readonly, + readwrite. Caching + + type can be set only for VM sizes supporting premium storage.' +module: azure.mgmt.batchai.models +fields: +- name: NONE + uid: azure.mgmt.batchai.models.CachingType.NONE +- name: READONLY + uid: azure.mgmt.batchai.models.CachingType.READONLY +- name: READWRITE + uid: azure.mgmt.batchai.models.CachingType.READWRITE diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Caffe2Settings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Caffe2Settings.yml new file mode 100644 index 00000000..52ce00ed --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Caffe2Settings.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.Caffe2Settings +name: Caffe2Settings +fullName: azure.mgmt.batchai.models.Caffe2Settings +module: azure.mgmt.batchai.models +summary: 'Caffe2 job settings. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Caffe2Settings(*, python_script_file_path: str, python_interpreter_path: + str | None = None, command_line_args: str | None = None, **kwargs)' + parameters: + - name: python_script_file_path + description: Required. The python script to execute. + isRequired: true + types: + - + - name: python_interpreter_path + description: The path to the Python interpreter. + isRequired: true + types: + - + - name: command_line_args + description: Command line arguments that need to be passed to the python script. + isRequired: true + types: + - + keywordOnlyParameters: + - name: python_script_file_path + isRequired: true + - name: python_interpreter_path + isRequired: true + - name: command_line_args + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CaffeSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CaffeSettings.yml new file mode 100644 index 00000000..e827629d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CaffeSettings.yml @@ -0,0 +1,56 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.CaffeSettings +name: CaffeSettings +fullName: azure.mgmt.batchai.models.CaffeSettings +module: azure.mgmt.batchai.models +summary: Caffe job settings. +constructor: + syntax: 'CaffeSettings(*, config_file_path: str | None = None, python_script_file_path: + str | None = None, python_interpreter_path: str | None = None, command_line_args: + str | None = None, process_count: int | None = None, **kwargs)' + parameters: + - name: config_file_path + description: 'Path of the config file for the job. This property cannot be specified + + if pythonScriptFilePath is specified.' + isRequired: true + types: + - + - name: python_script_file_path + description: 'Python script to execute. This property cannot be specified if + + configFilePath is specified.' + isRequired: true + types: + - + - name: python_interpreter_path + description: 'The path to the Python interpreter. The property can be + + specified only if the pythonScriptFilePath is specified.' + isRequired: true + types: + - + - name: command_line_args + description: Command line arguments that need to be passed to the Caffe job. + isRequired: true + types: + - + - name: process_count + description: 'Number of processes to launch for the job execution. The default + value + + for this property is equal to nodeCount property.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: config_file_path + isRequired: true + - name: python_script_file_path + isRequired: true + - name: python_interpreter_path + isRequired: true + - name: command_line_args + isRequired: true + - name: process_count + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ChainerSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ChainerSettings.yml new file mode 100644 index 00000000..abc34d93 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ChainerSettings.yml @@ -0,0 +1,46 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.ChainerSettings +name: ChainerSettings +fullName: azure.mgmt.batchai.models.ChainerSettings +module: azure.mgmt.batchai.models +summary: 'Chainer job settings. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ChainerSettings(*, python_script_file_path: str, python_interpreter_path: + str | None = None, command_line_args: str | None = None, process_count: int | + None = None, **kwargs)' + parameters: + - name: python_script_file_path + description: Required. The python script to execute. + isRequired: true + types: + - + - name: python_interpreter_path + description: The path to the Python interpreter. + isRequired: true + types: + - + - name: command_line_args + description: Command line arguments that need to be passed to the python script. + isRequired: true + types: + - + - name: process_count + description: 'Number of processes to launch for the job execution. The default + value + + for this property is equal to nodeCount property.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: python_script_file_path + isRequired: true + - name: python_interpreter_path + isRequired: true + - name: command_line_args + isRequired: true + - name: process_count + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CloudErrorBody.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CloudErrorBody.yml new file mode 100644 index 00000000..c0154c1c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CloudErrorBody.yml @@ -0,0 +1,37 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.CloudErrorBody +name: CloudErrorBody +fullName: azure.mgmt.batchai.models.CloudErrorBody +module: azure.mgmt.batchai.models +summary: 'An error response from the Batch AI service. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: CloudErrorBody(**kwargs) +variables: +- description: 'An identifier for the error. Codes are invariant and are intended + to be consumed + + programmatically.' + name: code + types: + - +- description: 'A message describing the error, intended to be suitable for display + in a user + + interface.' + name: message + types: + - +- description: 'The target of the particular error. For example, the name of the property + in + + error.' + name: target + types: + - +- description: A list of additional details about the error. + name: details + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Cluster.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Cluster.yml new file mode 100644 index 00000000..7ef199cb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Cluster.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.Cluster +name: Cluster +fullName: azure.mgmt.batchai.models.Cluster +module: azure.mgmt.batchai.models +summary: 'Information about a Cluster. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'Cluster(*, vm_size: str | None = None, vm_priority: str | VmPriority | + None = None, scale_settings: ScaleSettings | None = None, virtual_machine_configuration: + VirtualMachineConfiguration | None = None, node_setup: NodeSetup | None = None, + user_account_settings: UserAccountSettings | None = None, subnet: ResourceId | + None = None, **kwargs)' + parameters: + - name: vm_size + description: 'The size of the virtual machines in the cluster. All nodes in a + cluster have + + the same VM size.' + isRequired: true + types: + - + - name: vm_priority + description: 'VM priority of cluster nodes. Possible values include: "dedicated", + + "lowpriority".' + isRequired: true + types: + - + - + - name: scale_settings + description: Scale settings of the cluster. + isRequired: true + types: + - + - name: virtual_machine_configuration + description: 'Virtual machine configuration (OS image) of the compute + + nodes. All nodes in a cluster have the same OS image configuration.' + isRequired: true + types: + - + - name: node_setup + description: 'Setup (mount file systems, performance counters settings and custom + setup + + task) to be performed on each compute node in the cluster.' + isRequired: true + types: + - + - name: user_account_settings + description: 'Administrator user account settings which can be used to SSH to + + compute nodes.' + isRequired: true + types: + - + - name: subnet + description: Virtual network subnet resource ID the cluster nodes belong to. + isRequired: true + types: + - + keywordOnlyParameters: + - name: vm_size + isRequired: true + - name: vm_priority + isRequired: true + - name: scale_settings + isRequired: true + - name: virtual_machine_configuration + isRequired: true + - name: node_setup + isRequired: true + - name: user_account_settings + isRequired: true + - name: subnet + isRequired: true +variables: +- description: The ID of the resource. + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: The type of the resource. + name: type + types: + - +- description: The time when the cluster was created. + name: creation_time + types: + - +- description: 'Provisioning state of the cluster. Possible value are: creating - + + Specifies that the cluster is being created. succeeded - Specifies that the cluster + has been + + created successfully. failed - Specifies that the cluster creation has failed. + deleting - + + Specifies that the cluster is being deleted. Possible values include: "creating", + "succeeded", + + "failed", "deleting".' + name: provisioning_state + types: + - + - +- description: Time when the provisioning state was changed. + name: provisioning_state_transition_time + types: + - +- description: 'Allocation state of the cluster. Possible values are: steady - + + Indicates that the cluster is not resizing. There are no changes to the number + of compute nodes + + in the cluster in progress. A cluster enters this state when it is created and + when no + + operations are being performed on the cluster to change the number of compute + nodes. resizing - + + Indicates that the cluster is resizing; that is, compute nodes are being added + to or removed + + from the cluster. Possible values include: "steady", "resizing".' + name: allocation_state + types: + - + - +- description: 'The time at which the cluster entered its current + + allocation state.' + name: allocation_state_transition_time + types: + - +- description: Collection of errors encountered by various compute nodes during node + setup. + name: errors + types: + - [] +- description: The number of compute nodes currently assigned to the cluster. + name: current_node_count + types: + - +- description: Counts of various node states on the cluster. + name: node_state_counts + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClusterCreateParameters.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClusterCreateParameters.yml new file mode 100644 index 00000000..2fc33535 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClusterCreateParameters.yml @@ -0,0 +1,89 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.ClusterCreateParameters +name: ClusterCreateParameters +fullName: azure.mgmt.batchai.models.ClusterCreateParameters +module: azure.mgmt.batchai.models +summary: Cluster creation operation. +constructor: + syntax: 'ClusterCreateParameters(*, vm_size: str | None = None, vm_priority: str + | VmPriority | None = None, scale_settings: ScaleSettings | None = None, virtual_machine_configuration: + VirtualMachineConfiguration | None = None, node_setup: NodeSetup | None = None, + user_account_settings: UserAccountSettings | None = None, subnet: ResourceId | + None = None, **kwargs)' + parameters: + - name: vm_size + description: 'The size of the virtual machines in the cluster. All nodes in a + cluster have + + the same VM size. For information about available VM sizes for clusters using + images from the + + Virtual Machines Marketplace see Sizes for Virtual Machines (Linux). Batch AI + service supports + + all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, + STANDARD_DS, + + and STANDARD_DSV2 series).' + isRequired: true + types: + - + - name: vm_priority + description: 'VM priority. Allowed values are: dedicated (default) and lowpriority. + + Possible values include: "dedicated", "lowpriority".' + isRequired: true + types: + - + - + - name: scale_settings + description: 'Scale settings for the cluster. Batch AI service supports manual + and + + auto scale clusters.' + isRequired: true + types: + - + - name: virtual_machine_configuration + description: 'OS image configuration for cluster nodes. All nodes in a + + cluster have the same OS image.' + isRequired: true + types: + - + - name: node_setup + description: Setup to be performed on each compute node in the cluster. + isRequired: true + types: + - + - name: user_account_settings + description: 'Settings for an administrator user account that will be created + + on each compute node in the cluster.' + isRequired: true + types: + - + - name: subnet + description: 'Existing virtual network subnet to put the cluster nodes in. Note, + if a File + + Server mount configured in node setup, the File Server''s subnet will be used + automatically.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: vm_size + isRequired: true + - name: vm_priority + isRequired: true + - name: scale_settings + isRequired: true + - name: virtual_machine_configuration + isRequired: true + - name: node_setup + isRequired: true + - name: user_account_settings + isRequired: true + - name: subnet + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClusterListResult.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClusterListResult.yml new file mode 100644 index 00000000..3310cb0c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClusterListResult.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.ClusterListResult +name: ClusterListResult +fullName: azure.mgmt.batchai.models.ClusterListResult +module: azure.mgmt.batchai.models +summary: 'Values returned by the List Clusters operation. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: ClusterListResult(**kwargs) +variables: +- description: The collection of returned Clusters. + name: value + types: + - [] +- description: The continuation token. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClusterUpdateParameters.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClusterUpdateParameters.yml new file mode 100644 index 00000000..50947de0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClusterUpdateParameters.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.ClusterUpdateParameters +name: ClusterUpdateParameters +fullName: azure.mgmt.batchai.models.ClusterUpdateParameters +module: azure.mgmt.batchai.models +summary: Cluster update parameters. +constructor: + syntax: 'ClusterUpdateParameters(*, scale_settings: ScaleSettings | None = None, + **kwargs)' + parameters: + - name: scale_settings + description: 'Desired scale settings for the cluster. Batch AI service supports + manual + + and auto scale clusters.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: scale_settings + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClustersListByWorkspaceOptions.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClustersListByWorkspaceOptions.yml new file mode 100644 index 00000000..78e72181 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClustersListByWorkspaceOptions.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.ClustersListByWorkspaceOptions +name: ClustersListByWorkspaceOptions +fullName: azure.mgmt.batchai.models.ClustersListByWorkspaceOptions +module: azure.mgmt.batchai.models +summary: Parameter group. +constructor: + syntax: 'ClustersListByWorkspaceOptions(*, max_results: int | None = 1000, **kwargs)' + parameters: + - name: max_results + description: 'The maximum number of items to return in the response. A maximum + of 1000 + + files can be returned.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: max_results + defaultValue: '1000' diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ContainerSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ContainerSettings.yml new file mode 100644 index 00000000..f6a91632 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ContainerSettings.yml @@ -0,0 +1,33 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.ContainerSettings +name: ContainerSettings +fullName: azure.mgmt.batchai.models.ContainerSettings +module: azure.mgmt.batchai.models +summary: 'Docker container settings. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ContainerSettings(*, image_source_registry: ImageSourceRegistry, shm_size: + str | None = None, **kwargs)' + parameters: + - name: image_source_registry + description: 'Required. Information about docker image and docker registry to + + download the container from.' + isRequired: true + types: + - + - name: shm_size + description: 'Size of /dev/shm. Please refer to docker documentation for supported + argument + + formats.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: image_source_registry + isRequired: true + - name: shm_size + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CustomMpiSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CustomMpiSettings.yml new file mode 100644 index 00000000..ff4534c5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CustomMpiSettings.yml @@ -0,0 +1,34 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.CustomMpiSettings +name: CustomMpiSettings +fullName: azure.mgmt.batchai.models.CustomMpiSettings +module: azure.mgmt.batchai.models +summary: 'Custom MPI job settings. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CustomMpiSettings(*, command_line: str, process_count: int | None = None, + **kwargs)' + parameters: + - name: command_line + description: 'Required. The command line to be executed by mpi runtime on each + compute + + node.' + isRequired: true + types: + - + - name: process_count + description: 'Number of processes to launch for the job execution. The default + value + + for this property is equal to nodeCount property.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: command_line + isRequired: true + - name: process_count + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CustomToolkitSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CustomToolkitSettings.yml new file mode 100644 index 00000000..5fef9494 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CustomToolkitSettings.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.CustomToolkitSettings +name: CustomToolkitSettings +fullName: azure.mgmt.batchai.models.CustomToolkitSettings +module: azure.mgmt.batchai.models +summary: Custom tool kit job settings. +constructor: + syntax: 'CustomToolkitSettings(*, command_line: str | None = None, **kwargs)' + parameters: + - name: command_line + description: The command line to execute on the master node. + isRequired: true + types: + - + keywordOnlyParameters: + - name: command_line + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.DataDisks.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.DataDisks.yml new file mode 100644 index 00000000..e4cafeec --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.DataDisks.yml @@ -0,0 +1,57 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.DataDisks +name: DataDisks +fullName: azure.mgmt.batchai.models.DataDisks +module: azure.mgmt.batchai.models +summary: 'Data disks settings. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DataDisks(*, disk_size_in_gb: int, disk_count: int, storage_account_type: + str | StorageAccountType, caching_type: str | CachingType | None = ''none'', **kwargs)' + parameters: + - name: disk_size_in_gb + description: Required. Disk size in GB for the blank data disks. + isRequired: true + types: + - + - name: caching_type + description: 'Caching type for the disks. Available values are none (default), + readonly, + + readwrite. Caching type can be set only for VM sizes supporting premium storage. + Possible + + values include: "none", "readonly", "readwrite". Default value: "none".' + isRequired: true + types: + - + - + - name: disk_count + description: 'Required. Number of data disks attached to the File Server. If multiple + + disks attached, they will be configured in RAID level 0.' + isRequired: true + types: + - + - name: storage_account_type + description: 'Required. Type of storage account to be used on the disk. Possible + + values are: Standard_LRS or Premium_LRS. Premium storage account type can only + be used with VM + + sizes supporting premium storage. Possible values include: "Standard_LRS", "Premium_LRS".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: disk_size_in_gb + isRequired: true + - name: disk_count + isRequired: true + - name: storage_account_type + isRequired: true + - name: caching_type + defaultValue: none diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.DeallocationOption.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.DeallocationOption.yml new file mode 100644 index 00000000..8eb37ebe --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.DeallocationOption.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.batchai.models.DeallocationOption +name: DeallocationOption +fullName: azure.mgmt.batchai.models.DeallocationOption +summary: 'Actions which should be performed when compute nodes are removed from the + cluster. Possible + + values are: requeue (default) - Terminate running jobs and requeue them so the jobs + will run + + again. Remove compute nodes as soon as jobs have been terminated; terminate - Terminate + running + + jobs. The jobs will not run again. Remove compute nodes as soon as jobs have been + terminated. + + waitforjobcompletion - Allow currently running jobs to complete. Schedule no new + jobs while + + waiting. Remove compute nodes when all jobs have completed.' +module: azure.mgmt.batchai.models +fields: +- name: REQUEUE + uid: azure.mgmt.batchai.models.DeallocationOption.REQUEUE +- name: TERMINATE + uid: azure.mgmt.batchai.models.DeallocationOption.TERMINATE +- name: WAITFORJOBCOMPLETION + uid: azure.mgmt.batchai.models.DeallocationOption.WAITFORJOBCOMPLETION diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.EnvironmentVariable.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.EnvironmentVariable.yml new file mode 100644 index 00000000..317fd8aa --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.EnvironmentVariable.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.EnvironmentVariable +name: EnvironmentVariable +fullName: azure.mgmt.batchai.models.EnvironmentVariable +module: azure.mgmt.batchai.models +summary: 'An environment variable definition. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EnvironmentVariable(*, name: str, value: str, **kwargs)' + parameters: + - name: name + description: Required. The name of the environment variable. + isRequired: true + types: + - + - name: value + description: Required. The value of the environment variable. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: value + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.EnvironmentVariableWithSecretValue.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.EnvironmentVariableWithSecretValue.yml new file mode 100644 index 00000000..3a04480d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.EnvironmentVariableWithSecretValue.yml @@ -0,0 +1,41 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.EnvironmentVariableWithSecretValue +name: EnvironmentVariableWithSecretValue +fullName: azure.mgmt.batchai.models.EnvironmentVariableWithSecretValue +module: azure.mgmt.batchai.models +summary: 'An environment variable with secret value definition. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EnvironmentVariableWithSecretValue(*, name: str, value: str | None = None, + value_secret_reference: KeyVaultSecretReference | None = None, **kwargs)' + parameters: + - name: name + description: Required. The name of the environment variable to store the secret + value. + isRequired: true + types: + - + - name: value + description: 'The value of the environment variable. This value will never be + reported back by + + Batch AI.' + isRequired: true + types: + - + - name: value_secret_reference + description: 'KeyVault store and secret which contains the value for the + + environment variable. One of value or valueSecretReference must be provided.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: value + isRequired: true + - name: value_secret_reference + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ExecutionState.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ExecutionState.yml new file mode 100644 index 00000000..33e1e5b8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ExecutionState.yml @@ -0,0 +1,41 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.batchai.models.ExecutionState +name: ExecutionState +fullName: azure.mgmt.batchai.models.ExecutionState +summary: 'The current state of the job. Possible values are: queued - The job is queued + and able to run. + + A job enters this state when it is created, or when it is awaiting a retry after + a failed run. + + running - The job is running on a compute cluster. This includes job-level preparation + such as + + downloading resource files or set up container specified on the job - it does not + necessarily + + mean that the job command line has started executing. terminating - The job is terminated + by + + the user, the terminate operation is in progress. succeeded - The job has completed + running + + successfully and exited with exit code 0. failed - The job has finished unsuccessfully + (failed + + with a non-zero exit code) and has exhausted its retry limit. A job is also marked + as failed if + + an error occurred launching the job.' +module: azure.mgmt.batchai.models +fields: +- name: FAILED + uid: azure.mgmt.batchai.models.ExecutionState.FAILED +- name: QUEUED + uid: azure.mgmt.batchai.models.ExecutionState.QUEUED +- name: RUNNING + uid: azure.mgmt.batchai.models.ExecutionState.RUNNING +- name: SUCCEEDED + uid: azure.mgmt.batchai.models.ExecutionState.SUCCEEDED +- name: TERMINATING + uid: azure.mgmt.batchai.models.ExecutionState.TERMINATING diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Experiment.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Experiment.yml new file mode 100644 index 00000000..9487bcbb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Experiment.yml @@ -0,0 +1,41 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.Experiment +name: Experiment +fullName: azure.mgmt.batchai.models.Experiment +module: azure.mgmt.batchai.models +summary: 'Experiment information. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: Experiment(**kwargs) +variables: +- description: The ID of the resource. + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: The type of the resource. + name: type + types: + - +- description: Time when the Experiment was created. + name: creation_time + types: + - +- description: 'The provisioned state of the experiment. Possible values include: + + "creating", "succeeded", "failed", "deleting".' + name: provisioning_state + types: + - + - +- description: 'The time at which the experiment entered its current + + provisioning state.' + name: provisioning_state_transition_time + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ExperimentListResult.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ExperimentListResult.yml new file mode 100644 index 00000000..25adf9be --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ExperimentListResult.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.ExperimentListResult +name: ExperimentListResult +fullName: azure.mgmt.batchai.models.ExperimentListResult +module: azure.mgmt.batchai.models +summary: 'Values returned by the List operation. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: ExperimentListResult(**kwargs) +variables: +- description: The collection of experiments. + name: value + types: + - [] +- description: The continuation token. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ExperimentsListByWorkspaceOptions.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ExperimentsListByWorkspaceOptions.yml new file mode 100644 index 00000000..ed6974e7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ExperimentsListByWorkspaceOptions.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.ExperimentsListByWorkspaceOptions +name: ExperimentsListByWorkspaceOptions +fullName: azure.mgmt.batchai.models.ExperimentsListByWorkspaceOptions +module: azure.mgmt.batchai.models +summary: Parameter group. +constructor: + syntax: 'ExperimentsListByWorkspaceOptions(*, max_results: int | None = 1000, **kwargs)' + parameters: + - name: max_results + description: 'The maximum number of items to return in the response. A maximum + of 1000 + + files can be returned.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: max_results + defaultValue: '1000' diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.File.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.File.yml new file mode 100644 index 00000000..27e0f7ce --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.File.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.File +name: File +fullName: azure.mgmt.batchai.models.File +module: azure.mgmt.batchai.models +summary: 'Properties of the file or directory. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: File(**kwargs) +variables: +- description: Name of the file. + name: name + types: + - +- description: 'Type of the file. Possible values are file and directory. Possible + values + + include: "file", "directory".' + name: file_type + types: + - + - +- description: 'URL to download the corresponding file. The downloadUrl is not returned + for + + directories.' + name: download_url + types: + - +- description: The time at which the file was last modified. + name: last_modified + types: + - +- description: The file of the size. + name: content_length + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileListResult.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileListResult.yml new file mode 100644 index 00000000..64b4caa7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileListResult.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.FileListResult +name: FileListResult +fullName: azure.mgmt.batchai.models.FileListResult +module: azure.mgmt.batchai.models +summary: 'Values returned by the List operation. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: FileListResult(**kwargs) +variables: +- description: The collection of returned job directories and files. + name: value + types: + - [] +- description: The continuation token. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServer.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServer.yml new file mode 100644 index 00000000..99e0abcc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServer.yml @@ -0,0 +1,89 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.FileServer +name: FileServer +fullName: azure.mgmt.batchai.models.FileServer +module: azure.mgmt.batchai.models +summary: 'File Server information. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'FileServer(*, vm_size: str | None = None, ssh_configuration: SshConfiguration + | None = None, data_disks: DataDisks | None = None, subnet: ResourceId | None + = None, **kwargs)' + parameters: + - name: vm_size + description: VM size of the File Server. + isRequired: true + types: + - + - name: ssh_configuration + description: SSH configuration for accessing the File Server node. + isRequired: true + types: + - + - name: data_disks + description: Information about disks attached to File Server VM. + isRequired: true + types: + - + - name: subnet + description: File Server virtual network subnet resource ID. + isRequired: true + types: + - + keywordOnlyParameters: + - name: vm_size + isRequired: true + - name: ssh_configuration + isRequired: true + - name: data_disks + isRequired: true + - name: subnet + isRequired: true +variables: +- description: The ID of the resource. + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: The type of the resource. + name: type + types: + - +- description: File Server mount settings. + name: mount_settings + types: + - +- description: Time when the provisioning state was changed. + name: provisioning_state_transition_time + types: + - +- description: Time when the FileServer was created. + name: creation_time + types: + - +- description: 'Provisioning state of the File Server. Possible values: creating - + + The File Server is getting created; updating - The File Server creation has been + accepted and + + it is getting updated; deleting - The user has requested that the File Server + be deleted, and + + it is in the process of being deleted; failed - The File Server creation has failed + with the + + specified error code. Details about the error code are specified in the message + field; + + succeeded - The File Server creation has succeeded. Possible values include: "creating", + + "updating", "deleting", "succeeded", "failed".' + name: provisioning_state + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerCreateParameters.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerCreateParameters.yml new file mode 100644 index 00000000..0df80de7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerCreateParameters.yml @@ -0,0 +1,49 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.FileServerCreateParameters +name: FileServerCreateParameters +fullName: azure.mgmt.batchai.models.FileServerCreateParameters +module: azure.mgmt.batchai.models +summary: File Server creation parameters. +constructor: + syntax: 'FileServerCreateParameters(*, vm_size: str | None = None, ssh_configuration: + SshConfiguration | None = None, data_disks: DataDisks | None = None, subnet: ResourceId + | None = None, **kwargs)' + parameters: + - name: vm_size + description: 'The size of the virtual machine for the File Server. For information + about + + available VM sizes from the Virtual Machines Marketplace, see Sizes for Virtual + Machines + + (Linux).' + isRequired: true + types: + - + - name: ssh_configuration + description: SSH configuration for the File Server node. + isRequired: true + types: + - + - name: data_disks + description: Settings for the data disks which will be created for the File Server. + isRequired: true + types: + - + - name: subnet + description: 'Identifier of an existing virtual network subnet to put the File + Server in. If + + not provided, a new virtual network and subnet will be created.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: vm_size + isRequired: true + - name: ssh_configuration + isRequired: true + - name: data_disks + isRequired: true + - name: subnet + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerListResult.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerListResult.yml new file mode 100644 index 00000000..e9d29186 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerListResult.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.FileServerListResult +name: FileServerListResult +fullName: azure.mgmt.batchai.models.FileServerListResult +module: azure.mgmt.batchai.models +summary: 'Values returned by the File Server List operation. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'FileServerListResult(*, value: List[FileServer] | None = None, **kwargs)' + parameters: + - name: value + description: The collection of File Servers. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: value + isRequired: true +variables: +- description: The continuation token. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerProvisioningState.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerProvisioningState.yml new file mode 100644 index 00000000..80e5a508 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerProvisioningState.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.batchai.models.FileServerProvisioningState +name: FileServerProvisioningState +fullName: azure.mgmt.batchai.models.FileServerProvisioningState +summary: 'Provisioning state of the File Server. Possible values: creating - The File + Server is getting + + created; updating - The File Server creation has been accepted and it is getting + updated; + + deleting - The user has requested that the File Server be deleted, and it is in + the process of + + being deleted; failed - The File Server creation has failed with the specified error + code. + + Details about the error code are specified in the message field; succeeded - The + File Server + + creation has succeeded.' +module: azure.mgmt.batchai.models +fields: +- name: CREATING + uid: azure.mgmt.batchai.models.FileServerProvisioningState.CREATING +- name: DELETING + uid: azure.mgmt.batchai.models.FileServerProvisioningState.DELETING +- name: FAILED + uid: azure.mgmt.batchai.models.FileServerProvisioningState.FAILED +- name: SUCCEEDED + uid: azure.mgmt.batchai.models.FileServerProvisioningState.SUCCEEDED +- name: UPDATING + uid: azure.mgmt.batchai.models.FileServerProvisioningState.UPDATING diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerReference.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerReference.yml new file mode 100644 index 00000000..ff2babbb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerReference.yml @@ -0,0 +1,53 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.FileServerReference +name: FileServerReference +fullName: azure.mgmt.batchai.models.FileServerReference +module: azure.mgmt.batchai.models +summary: 'File Server mounting configuration. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'FileServerReference(*, file_server: ResourceId, relative_mount_path: str, + source_directory: str | None = None, mount_options: str | None = None, **kwargs)' + parameters: + - name: file_server + description: Required. Resource ID of the existing File Server to be mounted. + isRequired: true + types: + - + - name: source_directory + description: 'File Server directory that needs to be mounted. If this property + is + + not specified, the entire File Server will be mounted.' + isRequired: true + types: + - + - name: relative_mount_path + description: 'Required. The relative path on the compute node where the File + + Server will be mounted. Note that all cluster level file servers will be mounted + under + + $AZ_BATCHAI_MOUNT_ROOT location and all job level file servers will be mounted + under + + $AZ_BATCHAI_JOB_MOUNT_ROOT.' + isRequired: true + types: + - + - name: mount_options + description: Mount options to be passed to mount command. + isRequired: true + types: + - + keywordOnlyParameters: + - name: file_server + isRequired: true + - name: relative_mount_path + isRequired: true + - name: source_directory + isRequired: true + - name: mount_options + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServersListByWorkspaceOptions.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServersListByWorkspaceOptions.yml new file mode 100644 index 00000000..20235f67 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServersListByWorkspaceOptions.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.FileServersListByWorkspaceOptions +name: FileServersListByWorkspaceOptions +fullName: azure.mgmt.batchai.models.FileServersListByWorkspaceOptions +module: azure.mgmt.batchai.models +summary: Parameter group. +constructor: + syntax: 'FileServersListByWorkspaceOptions(*, max_results: int | None = 1000, **kwargs)' + parameters: + - name: max_results + description: 'The maximum number of items to return in the response. A maximum + of 1000 + + files can be returned.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: max_results + defaultValue: '1000' diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileType.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileType.yml new file mode 100644 index 00000000..f1802bb6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.batchai.models.FileType +name: FileType +fullName: azure.mgmt.batchai.models.FileType +summary: Type of the file. Possible values are file and directory. +module: azure.mgmt.batchai.models +fields: +- name: DIRECTORY + uid: azure.mgmt.batchai.models.FileType.DIRECTORY +- name: FILE + uid: azure.mgmt.batchai.models.FileType.FILE diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.HorovodSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.HorovodSettings.yml new file mode 100644 index 00000000..e61b926f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.HorovodSettings.yml @@ -0,0 +1,46 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.HorovodSettings +name: HorovodSettings +fullName: azure.mgmt.batchai.models.HorovodSettings +module: azure.mgmt.batchai.models +summary: 'Specifies the settings for Horovod job. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'HorovodSettings(*, python_script_file_path: str, python_interpreter_path: + str | None = None, command_line_args: str | None = None, process_count: int | + None = None, **kwargs)' + parameters: + - name: python_script_file_path + description: Required. The python script to execute. + isRequired: true + types: + - + - name: python_interpreter_path + description: The path to the Python interpreter. + isRequired: true + types: + - + - name: command_line_args + description: Command line arguments that need to be passed to the python script. + isRequired: true + types: + - + - name: process_count + description: 'Number of processes to launch for the job execution. The default + value + + for this property is equal to nodeCount property.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: python_script_file_path + isRequired: true + - name: python_interpreter_path + isRequired: true + - name: command_line_args + isRequired: true + - name: process_count + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ImageReference.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ImageReference.yml new file mode 100644 index 00000000..234f0bc6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ImageReference.yml @@ -0,0 +1,68 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.ImageReference +name: ImageReference +fullName: azure.mgmt.batchai.models.ImageReference +module: azure.mgmt.batchai.models +summary: 'The OS image reference. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ImageReference(*, publisher: str, offer: str, sku: str, version: str | + None = None, virtual_machine_image_id: str | None = None, **kwargs)' + parameters: + - name: publisher + description: Required. Publisher of the image. + isRequired: true + types: + - + - name: offer + description: Required. Offer of the image. + isRequired: true + types: + - + - name: sku + description: Required. SKU of the image. + isRequired: true + types: + - + - name: version + description: Version of the image. + isRequired: true + types: + - + - name: virtual_machine_image_id + description: 'The ARM resource identifier of the virtual machine image for + + the compute nodes. This is of the form + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}. + + The virtual machine image must be in the same region and subscription as the + cluster. For + + information about the firewall settings for the Batch node agent to communicate + with the Batch + + service see + + [https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration](https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration). + + Note, you need to provide publisher, offer and sku of the base OS image of which + the custom + + image has been derived from.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: publisher + isRequired: true + - name: offer + isRequired: true + - name: sku + isRequired: true + - name: version + isRequired: true + - name: virtual_machine_image_id + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ImageSourceRegistry.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ImageSourceRegistry.yml new file mode 100644 index 00000000..01ed3cc9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ImageSourceRegistry.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.ImageSourceRegistry +name: ImageSourceRegistry +fullName: azure.mgmt.batchai.models.ImageSourceRegistry +module: azure.mgmt.batchai.models +summary: 'Information about docker image for the job. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ImageSourceRegistry(*, image: str, server_url: str | None = None, credentials: + PrivateRegistryCredentials | None = None, **kwargs)' + parameters: + - name: server_url + description: URL for image repository. + isRequired: true + types: + - + - name: image + description: Required. The name of the image in the image repository. + isRequired: true + types: + - + - name: credentials + description: Credentials to access the private docker repository. + isRequired: true + types: + - + keywordOnlyParameters: + - name: image + isRequired: true + - name: server_url + isRequired: true + - name: credentials + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.InputDirectory.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.InputDirectory.yml new file mode 100644 index 00000000..a16e8c6d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.InputDirectory.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.InputDirectory +name: InputDirectory +fullName: azure.mgmt.batchai.models.InputDirectory +module: azure.mgmt.batchai.models +summary: 'Input directory for the job. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'InputDirectory(*, id: str, path: str, **kwargs)' + parameters: + - name: id + description: 'Required. The ID for the input directory. The job can use AZ_BATCHAI*INPUT* `` + environment variable to find the directory path, where `` is the value + + of id attribute.' + isRequired: true + types: + - + - name: path + description: Required. The path to the input directory. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: path + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Job.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Job.yml new file mode 100644 index 00000000..5d6ac67e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Job.yml @@ -0,0 +1,297 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.Job +name: Job +fullName: azure.mgmt.batchai.models.Job +module: azure.mgmt.batchai.models +summary: 'Information about a Job. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'Job(*, scheduling_priority: str | JobPriority | None = None, cluster: ResourceId + | None = None, mount_volumes: MountVolumes | None = None, node_count: int | None + = None, container_settings: ContainerSettings | None = None, tool_type: str | + ToolType | None = None, cntk_settings: CNTKsettings | None = None, py_torch_settings: + PyTorchSettings | None = None, tensor_flow_settings: TensorFlowSettings | None + = None, caffe_settings: CaffeSettings | None = None, caffe2_settings: Caffe2Settings + | None = None, chainer_settings: ChainerSettings | None = None, custom_toolkit_settings: + CustomToolkitSettings | None = None, custom_mpi_settings: CustomMpiSettings | + None = None, horovod_settings: HorovodSettings | None = None, job_preparation: + JobPreparation | None = None, std_out_err_path_prefix: str | None = None, input_directories: + List[InputDirectory] | None = None, output_directories: List[OutputDirectory] + | None = None, environment_variables: List[EnvironmentVariable] | None = None, + secrets: List[EnvironmentVariableWithSecretValue] | None = None, constraints: + JobPropertiesConstraints | None = None, execution_info: JobPropertiesExecutionInfo + | None = None, **kwargs)' + parameters: + - name: scheduling_priority + description: 'Scheduling priority associated with the job. Possible values + + include: "low", "normal", "high".' + isRequired: true + types: + - + - + - name: cluster + description: Resource ID of the cluster associated with the job. + isRequired: true + types: + - + - name: mount_volumes + description: 'Collection of mount volumes available to the job during execution. + These + + volumes are mounted before the job execution and unmounted after the job completion. + The + + volumes are mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment + variable.' + isRequired: true + types: + - + - name: node_count + description: The job will be gang scheduled on that many compute nodes. + isRequired: true + types: + - + - name: container_settings + description: 'If the container was downloaded as part of cluster setup then the + + same container image will be used. If not provided, the job will run on the + VM.' + isRequired: true + types: + - + - name: tool_type + description: 'Possible values are: cntk, tensorflow, caffe, caffe2, chainer, pytorch, + + custom, custommpi, horovod. Possible values include: "cntk", "tensorflow", "caffe", + "caffe2", + + "chainer", "horovod", "custommpi", "custom".' + isRequired: true + types: + - + - + - name: cntk_settings + description: CNTK (aka Microsoft Cognitive Toolkit) job settings. + isRequired: true + types: + - + - name: py_torch_settings + description: pyTorch job settings. + isRequired: true + types: + - + - name: tensor_flow_settings + description: TensorFlow job settings. + isRequired: true + types: + - + - name: caffe_settings + description: Caffe job settings. + isRequired: true + types: + - + - name: caffe2_settings + description: Caffe2 job settings. + isRequired: true + types: + - + - name: chainer_settings + description: Chainer job settings. + isRequired: true + types: + - + - name: custom_toolkit_settings + description: Custom tool kit job settings. + isRequired: true + types: + - + - name: custom_mpi_settings + description: Custom MPI job settings. + isRequired: true + types: + - + - name: horovod_settings + description: Specifies the settings for Horovod job. + isRequired: true + types: + - + - name: job_preparation + description: 'The specified actions will run on all the nodes that are part of + the + + job.' + isRequired: true + types: + - + - name: std_out_err_path_prefix + description: 'The path where the Batch AI service stores stdout, stderror and + + execution log of the job.' + isRequired: true + types: + - + - name: input_directories + description: A list of input directories for the job. + isRequired: true + types: + - [] + - name: output_directories + description: A list of output directories for the job. + isRequired: true + types: + - [] + - name: environment_variables + description: 'A collection of user defined environment variables to be setup + + for the job.' + isRequired: true + types: + - [] + - name: secrets + description: 'A collection of user defined environment variables with secret values + to be + + setup for the job. Server will never report values of these variables back.' + isRequired: true + types: + - [] + - name: constraints + description: Constraints associated with the Job. + isRequired: true + types: + - + - name: execution_info + description: Information about the execution of a job. + isRequired: true + types: + - + keywordOnlyParameters: + - name: scheduling_priority + isRequired: true + - name: cluster + isRequired: true + - name: mount_volumes + isRequired: true + - name: node_count + isRequired: true + - name: container_settings + isRequired: true + - name: tool_type + isRequired: true + - name: cntk_settings + isRequired: true + - name: py_torch_settings + isRequired: true + - name: tensor_flow_settings + isRequired: true + - name: caffe_settings + isRequired: true + - name: caffe2_settings + isRequired: true + - name: chainer_settings + isRequired: true + - name: custom_toolkit_settings + isRequired: true + - name: custom_mpi_settings + isRequired: true + - name: horovod_settings + isRequired: true + - name: job_preparation + isRequired: true + - name: std_out_err_path_prefix + isRequired: true + - name: input_directories + isRequired: true + - name: output_directories + isRequired: true + - name: environment_variables + isRequired: true + - name: secrets + isRequired: true + - name: constraints + isRequired: true + - name: execution_info + isRequired: true +variables: +- description: The ID of the resource. + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: The type of the resource. + name: type + types: + - +- description: 'A segment of job''s output directories path created by + + Batch AI. Batch AI creates job''s output directories under an unique path to avoid + conflicts + + between jobs. This value contains a path segment generated by Batch AI to make + the path unique + + and can be used to find the output directory on the node or mounted filesystem.' + name: job_output_directory_path_segment + types: + - +- description: The creation time of the job. + name: creation_time + types: + - +- description: 'The provisioned state of the Batch AI job. Possible values include: + + "creating", "succeeded", "failed", "deleting".' + name: provisioning_state + types: + - + - +- description: 'The time at which the job entered its current + + provisioning state.' + name: provisioning_state_transition_time + types: + - +- description: 'The current state of the job. Possible values are: queued - The job + is + + queued and able to run. A job enters this state when it is created, or when it + is awaiting a + + retry after a failed run. running - The job is running on a compute cluster. This + includes + + job-level preparation such as downloading resource files or set up container specified + on the + + job - it does not necessarily mean that the job command line has started executing. + terminating + + - The job is terminated by the user, the terminate operation is in progress. succeeded + - The + + job has completed running successfully and exited with exit code 0. failed - The + job has + + finished unsuccessfully (failed with a non-zero exit code) and has exhausted its + retry limit. A + + job is also marked as failed if an error occurred launching the job. Possible + values include: + + "queued", "running", "terminating", "succeeded", "failed".' + name: execution_state + types: + - + - +- description: 'The time at which the job entered its current execution + + state.' + name: execution_state_transition_time + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobBasePropertiesConstraints.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobBasePropertiesConstraints.yml new file mode 100644 index 00000000..d005929a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobBasePropertiesConstraints.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.JobBasePropertiesConstraints +name: JobBasePropertiesConstraints +fullName: azure.mgmt.batchai.models.JobBasePropertiesConstraints +module: azure.mgmt.batchai.models +summary: Constraints associated with the Job. +constructor: + syntax: 'JobBasePropertiesConstraints(*, max_wall_clock_time: timedelta | None = + ''7.00:00:00'', **kwargs)' + parameters: + - name: max_wall_clock_time + description: 'Max time the job can run. Default value: 1 week.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: max_wall_clock_time + defaultValue: 7.00:00:00 diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobCreateParameters.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobCreateParameters.yml new file mode 100644 index 00000000..b02b5225 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobCreateParameters.yml @@ -0,0 +1,195 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.JobCreateParameters +name: JobCreateParameters +fullName: azure.mgmt.batchai.models.JobCreateParameters +module: azure.mgmt.batchai.models +summary: Job creation parameters. +constructor: + syntax: 'JobCreateParameters(*, scheduling_priority: str | JobPriority | None = + None, cluster: ResourceId | None = None, mount_volumes: MountVolumes | None = + None, node_count: int | None = None, container_settings: ContainerSettings | None + = None, cntk_settings: CNTKsettings | None = None, py_torch_settings: PyTorchSettings + | None = None, tensor_flow_settings: TensorFlowSettings | None = None, caffe_settings: + CaffeSettings | None = None, caffe2_settings: Caffe2Settings | None = None, chainer_settings: + ChainerSettings | None = None, custom_toolkit_settings: CustomToolkitSettings + | None = None, custom_mpi_settings: CustomMpiSettings | None = None, horovod_settings: + HorovodSettings | None = None, job_preparation: JobPreparation | None = None, + std_out_err_path_prefix: str | None = None, input_directories: List[InputDirectory] + | None = None, output_directories: List[OutputDirectory] | None = None, environment_variables: + List[EnvironmentVariable] | None = None, secrets: List[EnvironmentVariableWithSecretValue] + | None = None, constraints: JobBasePropertiesConstraints | None = None, **kwargs)' + parameters: + - name: scheduling_priority + description: 'Scheduling priority associated with the job. Possible values: low, + + normal, high. Possible values include: "low", "normal", "high".' + isRequired: true + types: + - + - + - name: cluster + description: Resource ID of the cluster on which this job will run. + isRequired: true + types: + - + - name: mount_volumes + description: 'Information on mount volumes to be used by the job. These volumes + will be + + mounted before the job execution and will be unmounted after the job completion. + The volumes + + will be mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment + variable.' + isRequired: true + types: + - + - name: node_count + description: 'Number of compute nodes to run the job on. The job will be gang + scheduled on + + that many compute nodes.' + isRequired: true + types: + - + - name: container_settings + description: 'Docker container settings for the job. If not provided, the job + will + + run directly on the node.' + isRequired: true + types: + - + - name: cntk_settings + description: Settings for CNTK (aka Microsoft Cognitive Toolkit) job. + isRequired: true + types: + - + - name: py_torch_settings + description: Settings for pyTorch job. + isRequired: true + types: + - + - name: tensor_flow_settings + description: Settings for Tensor Flow job. + isRequired: true + types: + - + - name: caffe_settings + description: Settings for Caffe job. + isRequired: true + types: + - + - name: caffe2_settings + description: Settings for Caffe2 job. + isRequired: true + types: + - + - name: chainer_settings + description: Settings for Chainer job. + isRequired: true + types: + - + - name: custom_toolkit_settings + description: Settings for custom tool kit job. + isRequired: true + types: + - + - name: custom_mpi_settings + description: Settings for custom MPI job. + isRequired: true + types: + - + - name: horovod_settings + description: Settings for Horovod job. + isRequired: true + types: + - + - name: job_preparation + description: 'A command line to be executed on each node allocated for the job + before + + tool kit is launched.' + isRequired: true + types: + - + - name: std_out_err_path_prefix + description: 'The path where the Batch AI service will store stdout, stderror + + and execution log of the job.' + isRequired: true + types: + - + - name: input_directories + description: A list of input directories for the job. + isRequired: true + types: + - [] + - name: output_directories + description: A list of output directories for the job. + isRequired: true + types: + - [] + - name: environment_variables + description: 'A list of user defined environment variables which will be setup + + for the job.' + isRequired: true + types: + - [] + - name: secrets + description: 'A list of user defined environment variables with secret values + which will be + + setup for the job. Server will never report values of these variables back.' + isRequired: true + types: + - [] + - name: constraints + description: Constraints associated with the Job. + isRequired: true + types: + - + keywordOnlyParameters: + - name: scheduling_priority + isRequired: true + - name: cluster + isRequired: true + - name: mount_volumes + isRequired: true + - name: node_count + isRequired: true + - name: container_settings + isRequired: true + - name: cntk_settings + isRequired: true + - name: py_torch_settings + isRequired: true + - name: tensor_flow_settings + isRequired: true + - name: caffe_settings + isRequired: true + - name: caffe2_settings + isRequired: true + - name: chainer_settings + isRequired: true + - name: custom_toolkit_settings + isRequired: true + - name: custom_mpi_settings + isRequired: true + - name: horovod_settings + isRequired: true + - name: job_preparation + isRequired: true + - name: std_out_err_path_prefix + isRequired: true + - name: input_directories + isRequired: true + - name: output_directories + isRequired: true + - name: environment_variables + isRequired: true + - name: secrets + isRequired: true + - name: constraints + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobListResult.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobListResult.yml new file mode 100644 index 00000000..5cb4a6a0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobListResult.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.JobListResult +name: JobListResult +fullName: azure.mgmt.batchai.models.JobListResult +module: azure.mgmt.batchai.models +summary: 'Values returned by the List operation. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: JobListResult(**kwargs) +variables: +- description: The collection of jobs. + name: value + types: + - [] +- description: The continuation token. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobPreparation.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobPreparation.yml new file mode 100644 index 00000000..27c639f3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobPreparation.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.JobPreparation +name: JobPreparation +fullName: azure.mgmt.batchai.models.JobPreparation +module: azure.mgmt.batchai.models +summary: 'Job preparation settings. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'JobPreparation(*, command_line: str, **kwargs)' + parameters: + - name: command_line + description: 'Required. The command line to execute. If containerSettings is specified + + on the job, this commandLine will be executed in the same container as job. + Otherwise it will + + be executed on the node.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: command_line + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobPriority.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobPriority.yml new file mode 100644 index 00000000..35d41cee --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobPriority.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.batchai.models.JobPriority +name: JobPriority +fullName: azure.mgmt.batchai.models.JobPriority +summary: 'Scheduling priority associated with the job. Possible values: low, normal, + high.' +module: azure.mgmt.batchai.models +fields: +- name: HIGH + uid: azure.mgmt.batchai.models.JobPriority.HIGH +- name: LOW + uid: azure.mgmt.batchai.models.JobPriority.LOW +- name: NORMAL + uid: azure.mgmt.batchai.models.JobPriority.NORMAL diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobPropertiesConstraints.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobPropertiesConstraints.yml new file mode 100644 index 00000000..73179838 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobPropertiesConstraints.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.JobPropertiesConstraints +name: JobPropertiesConstraints +fullName: azure.mgmt.batchai.models.JobPropertiesConstraints +module: azure.mgmt.batchai.models +summary: Constraints associated with the Job. +constructor: + syntax: 'JobPropertiesConstraints(*, max_wall_clock_time: timedelta | None = ''7.00:00:00'', + **kwargs)' + parameters: + - name: max_wall_clock_time + description: 'Max time the job can run. Default value: 1 week.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: max_wall_clock_time + defaultValue: 7.00:00:00 diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobPropertiesExecutionInfo.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobPropertiesExecutionInfo.yml new file mode 100644 index 00000000..1e5e3f35 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobPropertiesExecutionInfo.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.JobPropertiesExecutionInfo +name: JobPropertiesExecutionInfo +fullName: azure.mgmt.batchai.models.JobPropertiesExecutionInfo +module: azure.mgmt.batchai.models +summary: 'Information about the execution of a job. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: JobPropertiesExecutionInfo(**kwargs) +variables: +- description: 'The time at which the job started running. ''Running'' corresponds + to the + + running state. If the job has been restarted or retried, this is the most recent + time at which + + the job started running. This property is present only for job that are in the + running or + + completed state.' + name: start_time + types: + - +- description: 'The time at which the job completed. This property is only returned + if the job + + is in completed state.' + name: end_time + types: + - +- description: 'The exit code of the job. This property is only returned if the job + is in + + completed state.' + name: exit_code + types: + - +- description: A collection of errors encountered by the service during job execution. + name: errors + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobsListByExperimentOptions.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobsListByExperimentOptions.yml new file mode 100644 index 00000000..e06ccb23 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobsListByExperimentOptions.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.JobsListByExperimentOptions +name: JobsListByExperimentOptions +fullName: azure.mgmt.batchai.models.JobsListByExperimentOptions +module: azure.mgmt.batchai.models +summary: Parameter group. +constructor: + syntax: 'JobsListByExperimentOptions(*, max_results: int | None = 1000, **kwargs)' + parameters: + - name: max_results + description: 'The maximum number of items to return in the response. A maximum + of 1000 + + files can be returned.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: max_results + defaultValue: '1000' diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobsListOutputFilesOptions.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobsListOutputFilesOptions.yml new file mode 100644 index 00000000..caf852a0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobsListOutputFilesOptions.yml @@ -0,0 +1,47 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.JobsListOutputFilesOptions +name: JobsListOutputFilesOptions +fullName: azure.mgmt.batchai.models.JobsListOutputFilesOptions +module: azure.mgmt.batchai.models +summary: 'Parameter group. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'JobsListOutputFilesOptions(*, outputdirectoryid: str, directory: str | + None = ''.'', linkexpiryinminutes: int | None = 60, max_results: int | None = + 1000, **kwargs)' + parameters: + - name: outputdirectoryid + description: "Required. Id of the job output directory. This is the\nOutputDirectory\u2013\ + >id parameter that is given by the user during Create Job." + isRequired: true + types: + - + - name: directory + description: The path to the directory. + isRequired: true + types: + - + - name: linkexpiryinminutes + description: The number of minutes after which the download link will expire. + isRequired: true + types: + - + - name: max_results + description: 'The maximum number of items to return in the response. A maximum + of 1000 + + files can be returned.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: outputdirectoryid + isRequired: true + - name: directory + defaultValue: . + - name: linkexpiryinminutes + defaultValue: '60' + - name: max_results + defaultValue: '1000' diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.KeyVaultSecretReference.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.KeyVaultSecretReference.yml new file mode 100644 index 00000000..f54cd439 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.KeyVaultSecretReference.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.KeyVaultSecretReference +name: KeyVaultSecretReference +fullName: azure.mgmt.batchai.models.KeyVaultSecretReference +module: azure.mgmt.batchai.models +summary: 'Key Vault Secret reference. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeyVaultSecretReference(*, source_vault: ResourceId, secret_url: str, **kwargs)' + parameters: + - name: source_vault + description: Required. Fully qualified resource identifier of the Key Vault. + isRequired: true + types: + - + - name: secret_url + description: Required. The URL referencing a secret in the Key Vault. + isRequired: true + types: + - + keywordOnlyParameters: + - name: source_vault + isRequired: true + - name: secret_url + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ListUsagesResult.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ListUsagesResult.yml new file mode 100644 index 00000000..dc268b2e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ListUsagesResult.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.ListUsagesResult +name: ListUsagesResult +fullName: azure.mgmt.batchai.models.ListUsagesResult +module: azure.mgmt.batchai.models +summary: 'The List Usages operation response. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: ListUsagesResult(**kwargs) +variables: +- description: The list of compute resource usages. + name: value + types: + - [] +- description: 'The URI to fetch the next page of compute resource usage information. + Call + + ListNext() with this to fetch the next page of compute resource usage information.' + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ManualScaleSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ManualScaleSettings.yml new file mode 100644 index 00000000..a0f7dc5d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ManualScaleSettings.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.ManualScaleSettings +name: ManualScaleSettings +fullName: azure.mgmt.batchai.models.ManualScaleSettings +module: azure.mgmt.batchai.models +summary: 'Manual scale settings for the cluster. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ManualScaleSettings(*, target_node_count: int, node_deallocation_option: + str | DeallocationOption | None = ''requeue'', **kwargs)' + parameters: + - name: target_node_count + description: 'Required. The desired number of compute nodes in the Cluster. Default + + is 0.' + isRequired: true + types: + - + - name: node_deallocation_option + description: 'An action to be performed when the cluster size is decreasing. + + The default value is requeue. Possible values include: "requeue", "terminate", + + "waitforjobcompletion". Default value: "requeue".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: target_node_count + isRequired: true + - name: node_deallocation_option + defaultValue: requeue diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.MountSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.MountSettings.yml new file mode 100644 index 00000000..8f650247 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.MountSettings.yml @@ -0,0 +1,36 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.MountSettings +name: MountSettings +fullName: azure.mgmt.batchai.models.MountSettings +module: azure.mgmt.batchai.models +summary: File Server mount Information. +constructor: + syntax: 'MountSettings(*, mount_point: str | None = None, file_server_public_ip: + str | None = None, file_server_internal_ip: str | None = None, **kwargs)' + parameters: + - name: mount_point + description: Path where the data disks are mounted on the File Server. + isRequired: true + types: + - + - name: file_server_public_ip + description: 'Public IP address of the File Server which can be used to SSH to + + the node from outside of the subnet.' + isRequired: true + types: + - + - name: file_server_internal_ip + description: 'Internal IP address of the File Server which can be used to + + access the File Server from within the subnet.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: mount_point + isRequired: true + - name: file_server_public_ip + isRequired: true + - name: file_server_internal_ip + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.MountVolumes.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.MountVolumes.yml new file mode 100644 index 00000000..8f49e86a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.MountVolumes.yml @@ -0,0 +1,50 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.MountVolumes +name: MountVolumes +fullName: azure.mgmt.batchai.models.MountVolumes +module: azure.mgmt.batchai.models +summary: Details of volumes to mount on the cluster. +constructor: + syntax: 'MountVolumes(*, azure_file_shares: List[AzureFileShareReference] | None + = None, azure_blob_file_systems: List[AzureBlobFileSystemReference] | None = None, + file_servers: List[FileServerReference] | None = None, unmanaged_file_systems: + List[UnmanagedFileSystemReference] | None = None, **kwargs)' + parameters: + - name: azure_file_shares + description: 'A collection of Azure File Shares that are to be mounted to the + + cluster nodes.' + isRequired: true + types: + - [] + - name: azure_blob_file_systems + description: 'A collection of Azure Blob Containers that are to be mounted to + + the cluster nodes.' + isRequired: true + types: + - [] + - name: file_servers + description: 'A collection of Batch AI File Servers that are to be mounted to + the + + cluster nodes.' + isRequired: true + types: + - [] + - name: unmanaged_file_systems + description: 'A collection of unmanaged file systems that are to be mounted to + + the cluster nodes.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: azure_file_shares + isRequired: true + - name: azure_blob_file_systems + isRequired: true + - name: file_servers + isRequired: true + - name: unmanaged_file_systems + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.NameValuePair.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.NameValuePair.yml new file mode 100644 index 00000000..b4b3cfa0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.NameValuePair.yml @@ -0,0 +1,24 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.NameValuePair +name: NameValuePair +fullName: azure.mgmt.batchai.models.NameValuePair +module: azure.mgmt.batchai.models +summary: Name-value pair. +constructor: + syntax: 'NameValuePair(*, name: str | None = None, value: str | None = None, **kwargs)' + parameters: + - name: name + description: The name in the name-value pair. + isRequired: true + types: + - + - name: value + description: The value in the name-value pair. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: value + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.NodeSetup.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.NodeSetup.yml new file mode 100644 index 00000000..a7c435ba --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.NodeSetup.yml @@ -0,0 +1,48 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.NodeSetup +name: NodeSetup +fullName: azure.mgmt.batchai.models.NodeSetup +module: azure.mgmt.batchai.models +summary: Node setup settings. +constructor: + syntax: 'NodeSetup(*, setup_task: SetupTask | None = None, mount_volumes: MountVolumes + | None = None, performance_counters_settings: PerformanceCountersSettings | None + = None, **kwargs)' + parameters: + - name: setup_task + description: 'Setup task to run on cluster nodes when nodes got created or rebooted. + The + + setup task code needs to be idempotent. Generally the setup task is used to + download static + + data that is required for all jobs that run on the cluster VMs and/or to download/install + + software.' + isRequired: true + types: + - + - name: mount_volumes + description: 'Mount volumes to be available to setup task and all jobs executing + on the + + cluster. The volumes will be mounted at location specified by $AZ_BATCHAI_MOUNT_ROOT + + environment variable.' + isRequired: true + types: + - + - name: performance_counters_settings + description: 'Settings for performance counters collecting and + + uploading.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: setup_task + isRequired: true + - name: mount_volumes + isRequired: true + - name: performance_counters_settings + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.NodeStateCounts.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.NodeStateCounts.yml new file mode 100644 index 00000000..74fa5f84 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.NodeStateCounts.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.NodeStateCounts +name: NodeStateCounts +fullName: azure.mgmt.batchai.models.NodeStateCounts +module: azure.mgmt.batchai.models +summary: 'Counts of various compute node states on the cluster. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: NodeStateCounts(**kwargs) +variables: +- description: Number of compute nodes in idle state. + name: idle_node_count + types: + - +- description: Number of compute nodes which are running jobs. + name: running_node_count + types: + - +- description: Number of compute nodes which are being prepared. + name: preparing_node_count + types: + - +- description: Number of compute nodes which are in unusable state. + name: unusable_node_count + types: + - +- description: Number of compute nodes which are leaving the cluster. + name: leaving_node_count + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Operation.yml new file mode 100644 index 00000000..a60169b8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Operation.yml @@ -0,0 +1,37 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.Operation +name: Operation +fullName: azure.mgmt.batchai.models.Operation +module: azure.mgmt.batchai.models +summary: 'Details of a REST API operation. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'Operation(*, display: OperationDisplay | None = None, properties: Any | + None = None, **kwargs)' + parameters: + - name: display + description: The object that describes the operation. + isRequired: true + types: + - + - name: properties + description: Any object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: display + isRequired: true + - name: properties + isRequired: true +variables: +- description: This is of the format {provider}/{resource}/{operation}. + name: name + types: + - +- description: The intended executor of the operation. + name: origin + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.OperationDisplay.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.OperationDisplay.yml new file mode 100644 index 00000000..1a14314b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.OperationDisplay.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.OperationDisplay +name: OperationDisplay +fullName: azure.mgmt.batchai.models.OperationDisplay +module: azure.mgmt.batchai.models +summary: 'The object that describes the operation. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: OperationDisplay(**kwargs) +variables: +- description: Friendly name of the resource provider. + name: provider + types: + - +- description: 'For example: read, write, delete, or listKeys/action.' + name: operation + types: + - +- description: The resource type on which the operation is performed. + name: resource + types: + - +- description: The friendly name of the operation. + name: description + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.OperationListResult.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.OperationListResult.yml new file mode 100644 index 00000000..7af92f7a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.OperationListResult.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.OperationListResult +name: OperationListResult +fullName: azure.mgmt.batchai.models.OperationListResult +module: azure.mgmt.batchai.models +summary: 'Contains the list of all operations supported by BatchAI resource provider. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: OperationListResult(**kwargs) +variables: +- description: The list of operations supported by the resource provider. + name: value + types: + - [] +- description: The URL to get the next set of operation list results if there are + any. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.OutputDirectory.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.OutputDirectory.yml new file mode 100644 index 00000000..04d6c710 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.OutputDirectory.yml @@ -0,0 +1,52 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.OutputDirectory +name: OutputDirectory +fullName: azure.mgmt.batchai.models.OutputDirectory +module: azure.mgmt.batchai.models +summary: 'Output directory for the job. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'OutputDirectory(*, id: str, path_prefix: str, path_suffix: str | None = + None, **kwargs)' + parameters: + - name: id + description: 'Required. The ID of the output directory. The job can use AZ_BATCHAI*OUTPUT* `` + environment variable to find the directory path, where `` is the value + + of id attribute.' + isRequired: true + types: + - + - name: path_prefix + description: 'Required. The prefix path where the output directory will be created. + Note, + + this is an absolute path to prefix. E.g. $AZ_BATCHAI_MOUNT_ROOT/MyNFS/MyLogs. + The full path to + + the output directory by combining pathPrefix, jobOutputDirectoryPathSegment + (reported by get + + job) and pathSuffix.' + isRequired: true + types: + - + - name: path_suffix + description: 'The suffix path where the output directory will be created. E.g. + models. + + You can find the full path to the output directory by combining pathPrefix, + + jobOutputDirectoryPathSegment (reported by get job) and pathSuffix.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: path_prefix + isRequired: true + - name: path_suffix + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.PerformanceCountersSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.PerformanceCountersSettings.yml new file mode 100644 index 00000000..dd4cfa75 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.PerformanceCountersSettings.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.PerformanceCountersSettings +name: PerformanceCountersSettings +fullName: azure.mgmt.batchai.models.PerformanceCountersSettings +module: azure.mgmt.batchai.models +summary: 'Performance counters reporting settings. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PerformanceCountersSettings(*, app_insights_reference: AppInsightsReference, + **kwargs)' + parameters: + - name: app_insights_reference + description: 'Required. Azure Application Insights information for performance + + counters reporting. If provided, Batch AI will upload node performance counters + to the + + corresponding Azure Application Insights account.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: app_insights_reference + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.PrivateRegistryCredentials.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.PrivateRegistryCredentials.yml new file mode 100644 index 00000000..9daece68 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.PrivateRegistryCredentials.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.PrivateRegistryCredentials +name: PrivateRegistryCredentials +fullName: azure.mgmt.batchai.models.PrivateRegistryCredentials +module: azure.mgmt.batchai.models +summary: 'Credentials to access a container image in a private repository. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PrivateRegistryCredentials(*, username: str, password: str | None = None, + password_secret_reference: KeyVaultSecretReference | None = None, **kwargs)' + parameters: + - name: username + description: Required. User name to login to the repository. + isRequired: true + types: + - + - name: password + description: 'User password to login to the docker repository. One of password + or + + passwordSecretReference must be specified.' + isRequired: true + types: + - + - name: password_secret_reference + description: 'KeyVault Secret storing the password. Users can store their + + secrets in Azure KeyVault and pass it to the Batch AI service to integrate with + KeyVault. One + + of password or passwordSecretReference must be specified.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: username + isRequired: true + - name: password + isRequired: true + - name: password_secret_reference + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ProvisioningState.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ProvisioningState.yml new file mode 100644 index 00000000..cc561d90 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ProvisioningState.yml @@ -0,0 +1,24 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.batchai.models.ProvisioningState +name: ProvisioningState +fullName: azure.mgmt.batchai.models.ProvisioningState +summary: 'Provisioning state of the cluster. Possible value are: creating - Specifies + that the cluster is + + being created. succeeded - Specifies that the cluster has been created successfully. + failed - + + Specifies that the cluster creation has failed. deleting - Specifies that the cluster + is being + + deleted.' +module: azure.mgmt.batchai.models +fields: +- name: CREATING + uid: azure.mgmt.batchai.models.ProvisioningState.CREATING +- name: DELETING + uid: azure.mgmt.batchai.models.ProvisioningState.DELETING +- name: FAILED + uid: azure.mgmt.batchai.models.ProvisioningState.FAILED +- name: SUCCEEDED + uid: azure.mgmt.batchai.models.ProvisioningState.SUCCEEDED diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ProxyResource.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ProxyResource.yml new file mode 100644 index 00000000..2525f518 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ProxyResource.yml @@ -0,0 +1,24 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.ProxyResource +name: ProxyResource +fullName: azure.mgmt.batchai.models.ProxyResource +module: azure.mgmt.batchai.models +summary: 'A definition of an Azure proxy resource. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: ProxyResource(**kwargs) +variables: +- description: The ID of the resource. + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: The type of the resource. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.PyTorchSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.PyTorchSettings.yml new file mode 100644 index 00000000..902fdfd2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.PyTorchSettings.yml @@ -0,0 +1,55 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.PyTorchSettings +name: PyTorchSettings +fullName: azure.mgmt.batchai.models.PyTorchSettings +module: azure.mgmt.batchai.models +summary: 'pyTorch job settings. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PyTorchSettings(*, python_script_file_path: str, python_interpreter_path: + str | None = None, command_line_args: str | None = None, process_count: int | + None = None, communication_backend: str | None = None, **kwargs)' + parameters: + - name: python_script_file_path + description: Required. The python script to execute. + isRequired: true + types: + - + - name: python_interpreter_path + description: The path to the Python interpreter. + isRequired: true + types: + - + - name: command_line_args + description: Command line arguments that need to be passed to the python script. + isRequired: true + types: + - + - name: process_count + description: 'Number of processes to launch for the job execution. The default + value + + for this property is equal to nodeCount property.' + isRequired: true + types: + - + - name: communication_backend + description: 'Type of the communication backend for distributed jobs. Valid + + values are ''TCP'', ''Gloo'' or ''MPI''. Not required for non-distributed jobs.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: python_script_file_path + isRequired: true + - name: python_interpreter_path + isRequired: true + - name: command_line_args + isRequired: true + - name: process_count + isRequired: true + - name: communication_backend + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.RemoteLoginInformation.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.RemoteLoginInformation.yml new file mode 100644 index 00000000..98af1083 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.RemoteLoginInformation.yml @@ -0,0 +1,24 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.RemoteLoginInformation +name: RemoteLoginInformation +fullName: azure.mgmt.batchai.models.RemoteLoginInformation +module: azure.mgmt.batchai.models +summary: 'Login details to SSH to a compute node in cluster. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: RemoteLoginInformation(**kwargs) +variables: +- description: ID of the compute node. + name: node_id + types: + - +- description: Public IP address of the compute node. + name: ip_address + types: + - +- description: SSH port number of the node. + name: port + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.RemoteLoginInformationListResult.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.RemoteLoginInformationListResult.yml new file mode 100644 index 00000000..6e526f0b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.RemoteLoginInformationListResult.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.RemoteLoginInformationListResult +name: RemoteLoginInformationListResult +fullName: azure.mgmt.batchai.models.RemoteLoginInformationListResult +module: azure.mgmt.batchai.models +summary: 'Values returned by the List operation. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: RemoteLoginInformationListResult(**kwargs) +variables: +- description: The collection of returned remote login details. + name: value + types: + - [] +- description: The continuation token. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Resource.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Resource.yml new file mode 100644 index 00000000..3626ab16 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Resource.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.Resource +name: Resource +fullName: azure.mgmt.batchai.models.Resource +module: azure.mgmt.batchai.models +summary: 'A definition of an Azure resource. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: Resource(**kwargs) +variables: +- description: The ID of the resource. + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: The type of the resource. + name: type + types: + - +- description: The location of the resource. + name: location + types: + - +- description: A set of tags. The tags of the resource. + name: tags + types: + - [, ] diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ResourceId.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ResourceId.yml new file mode 100644 index 00000000..92379f89 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ResourceId.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.ResourceId +name: ResourceId +fullName: azure.mgmt.batchai.models.ResourceId +module: azure.mgmt.batchai.models +summary: 'Represents a resource ID. For example, for a subnet, it is the resource + URL for the subnet. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ResourceId(*, id: str, **kwargs)' + parameters: + - name: id + description: Required. The ID of the resource. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ScaleSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ScaleSettings.yml new file mode 100644 index 00000000..235db1c5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ScaleSettings.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.ScaleSettings +name: ScaleSettings +fullName: azure.mgmt.batchai.models.ScaleSettings +module: azure.mgmt.batchai.models +summary: At least one of manual or autoScale settings must be specified. Only one + of manual or autoScale settings can be specified. If autoScale settings are specified, + the system automatically scales the cluster up and down (within the supplied limits) + based on the pending jobs on the cluster. +constructor: + syntax: 'ScaleSettings(*, manual: ManualScaleSettings | None = None, auto_scale: + AutoScaleSettings | None = None, **kwargs)' + parameters: + - name: manual + description: Manual scale settings for the cluster. + isRequired: true + types: + - + - name: auto_scale + description: Auto-scale settings for the cluster. + isRequired: true + types: + - + keywordOnlyParameters: + - name: manual + isRequired: true + - name: auto_scale + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.SetupTask.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.SetupTask.yml new file mode 100644 index 00000000..b9964bd4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.SetupTask.yml @@ -0,0 +1,74 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.SetupTask +name: SetupTask +fullName: azure.mgmt.batchai.models.SetupTask +module: azure.mgmt.batchai.models +summary: 'Specifies a setup task which can be used to customize the compute nodes + of the cluster. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SetupTask(*, command_line: str, std_out_err_path_prefix: str, environment_variables: + List[EnvironmentVariable] | None = None, secrets: List[EnvironmentVariableWithSecretValue] + | None = None, **kwargs)' + parameters: + - name: command_line + description: 'Required. The command line to be executed on each cluster''s node + after it + + being allocated or rebooted. The command is executed in a bash subshell as a + root.' + isRequired: true + types: + - + - name: environment_variables + description: 'A collection of user defined environment variables to be set for + + setup task.' + isRequired: true + types: + - [] + - name: secrets + description: 'A collection of user defined environment variables with secret values + to be set + + for the setup task. Server will never report values of these variables back.' + isRequired: true + types: + - [] + - name: std_out_err_path_prefix + description: 'Required. The prefix of a path where the Batch AI service will + + upload the stdout, stderr and execution log of the setup task.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: command_line + isRequired: true + - name: std_out_err_path_prefix + isRequired: true + - name: environment_variables + isRequired: true + - name: secrets + isRequired: true +variables: +- description: 'A path segment appended by Batch AI to stdOutErrPathPrefix to + + form a path where stdout, stderr and execution log of the setup task will be uploaded. + Batch AI + + creates the setup task output directories under an unique path to avoid conflicts + between + + different clusters. The full path can be obtained by concatenation of stdOutErrPathPrefix + and + + stdOutErrPathSuffix.' + name: std_out_err_path_suffix + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.SshConfiguration.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.SshConfiguration.yml new file mode 100644 index 00000000..43e22fd0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.SshConfiguration.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.SshConfiguration +name: SshConfiguration +fullName: azure.mgmt.batchai.models.SshConfiguration +module: azure.mgmt.batchai.models +summary: 'SSH configuration. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SshConfiguration(*, user_account_settings: UserAccountSettings, public_ips_to_allow: + List[str] | None = None, **kwargs)' + parameters: + - name: public_ips_to_allow + description: 'List of source IP ranges to allow SSH connection from. The default + + value is ''*'' (all source IPs are allowed). Maximum number of IP ranges that + can be specified is + + 400.' + isRequired: true + types: + - [] + - name: user_account_settings + description: 'Required. Settings for administrator user account to be created + + on a node. The account can be used to establish SSH connection to the node.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: user_account_settings + isRequired: true + - name: public_ips_to_allow + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.StorageAccountType.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.StorageAccountType.yml new file mode 100644 index 00000000..c986052f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.StorageAccountType.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.batchai.models.StorageAccountType +name: StorageAccountType +fullName: azure.mgmt.batchai.models.StorageAccountType +summary: 'Type of storage account to be used on the disk. Possible values are: Standard_LRS + or + + Premium_LRS. Premium storage account type can only be used with VM sizes supporting + premium + + storage.' +module: azure.mgmt.batchai.models +fields: +- name: PREMIUM_LRS + uid: azure.mgmt.batchai.models.StorageAccountType.PREMIUM_LRS +- name: STANDARD_LRS + uid: azure.mgmt.batchai.models.StorageAccountType.STANDARD_LRS diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.TensorFlowSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.TensorFlowSettings.yml new file mode 100644 index 00000000..6e0f507f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.TensorFlowSettings.yml @@ -0,0 +1,85 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.TensorFlowSettings +name: TensorFlowSettings +fullName: azure.mgmt.batchai.models.TensorFlowSettings +module: azure.mgmt.batchai.models +summary: 'TensorFlow job settings. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TensorFlowSettings(*, python_script_file_path: str, python_interpreter_path: + str | None = None, master_command_line_args: str | None = None, worker_command_line_args: + str | None = None, parameter_server_command_line_args: str | None = None, worker_count: + int | None = None, parameter_server_count: int | None = None, **kwargs)' + parameters: + - name: python_script_file_path + description: Required. The python script to execute. + isRequired: true + types: + - + - name: python_interpreter_path + description: The path to the Python interpreter. + isRequired: true + types: + - + - name: master_command_line_args + description: 'Command line arguments that need to be passed to the python + + script for the master task.' + isRequired: true + types: + - + - name: worker_command_line_args + description: 'Command line arguments that need to be passed to the python + + script for the worker task. Optional for single process jobs.' + isRequired: true + types: + - + - name: parameter_server_command_line_args + description: 'Command line arguments that need to be passed to the + + python script for the parameter server. Optional for single process jobs.' + isRequired: true + types: + - + - name: worker_count + description: 'The number of worker tasks. If specified, the value must be less + than or + + equal to (nodeCount * numberOfGPUs per VM). If not specified, the default value + is equal to + + nodeCount. This property can be specified only for distributed TensorFlow training.' + isRequired: true + types: + - + - name: parameter_server_count + description: 'The number of parameter server tasks. If specified, the value + + must be less than or equal to nodeCount. If not specified, the default value + is equal to 1 for + + distributed TensorFlow training. This property can be specified only for distributed + TensorFlow + + training.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: python_script_file_path + isRequired: true + - name: python_interpreter_path + isRequired: true + - name: master_command_line_args + isRequired: true + - name: worker_command_line_args + isRequired: true + - name: parameter_server_command_line_args + isRequired: true + - name: worker_count + isRequired: true + - name: parameter_server_count + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ToolType.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ToolType.yml new file mode 100644 index 00000000..48774bdf --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ToolType.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.batchai.models.ToolType +name: ToolType +fullName: azure.mgmt.batchai.models.ToolType +summary: The toolkit type of the job. +module: azure.mgmt.batchai.models +fields: +- name: CAFFE + uid: azure.mgmt.batchai.models.ToolType.CAFFE +- name: CAFFE2 + uid: azure.mgmt.batchai.models.ToolType.CAFFE2 +- name: CHAINER + uid: azure.mgmt.batchai.models.ToolType.CHAINER +- name: CNTK + uid: azure.mgmt.batchai.models.ToolType.CNTK +- name: CUSTOM + uid: azure.mgmt.batchai.models.ToolType.CUSTOM +- name: CUSTOMMPI + uid: azure.mgmt.batchai.models.ToolType.CUSTOMMPI +- name: HOROVOD + uid: azure.mgmt.batchai.models.ToolType.HOROVOD +- name: TENSORFLOW + uid: azure.mgmt.batchai.models.ToolType.TENSORFLOW diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.UnmanagedFileSystemReference.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.UnmanagedFileSystemReference.yml new file mode 100644 index 00000000..d48c5b0c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.UnmanagedFileSystemReference.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.UnmanagedFileSystemReference +name: UnmanagedFileSystemReference +fullName: azure.mgmt.batchai.models.UnmanagedFileSystemReference +module: azure.mgmt.batchai.models +summary: 'Unmanaged file system mounting configuration. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'UnmanagedFileSystemReference(*, mount_command: str, relative_mount_path: + str, **kwargs)' + parameters: + - name: mount_command + description: 'Required. Mount command line. Note, Batch AI will append mount path + to + + the command on its own.' + isRequired: true + types: + - + - name: relative_mount_path + description: 'Required. The relative path on the compute node where the unmanaged + + file system will be mounted. Note that all cluster level unmanaged file systems + will be mounted + + under $AZ_BATCHAI_MOUNT_ROOT location and all job level unmanaged file systems + will be mounted + + under $AZ_BATCHAI_JOB_MOUNT_ROOT.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: mount_command + isRequired: true + - name: relative_mount_path + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Usage.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Usage.yml new file mode 100644 index 00000000..3d30612a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Usage.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.Usage +name: Usage +fullName: azure.mgmt.batchai.models.Usage +module: azure.mgmt.batchai.models +summary: 'Describes Batch AI Resource Usage. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: Usage(**kwargs) +variables: +- description: 'An enum describing the unit of usage measurement. Possible values + include: "Count".' + name: unit + types: + - + - +- description: The current usage of the resource. + name: current_value + types: + - +- description: The maximum permitted usage of the resource. + name: limit + types: + - +- description: The name of the type of usage. + name: name + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.UsageName.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.UsageName.yml new file mode 100644 index 00000000..ef4cb872 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.UsageName.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.UsageName +name: UsageName +fullName: azure.mgmt.batchai.models.UsageName +module: azure.mgmt.batchai.models +summary: 'The Usage Names. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: UsageName(**kwargs) +variables: +- description: The name of the resource. + name: value + types: + - +- description: The localized name of the resource. + name: localized_value + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.UsageUnit.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.UsageUnit.yml new file mode 100644 index 00000000..0791099a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.UsageUnit.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.batchai.models.UsageUnit +name: UsageUnit +fullName: azure.mgmt.batchai.models.UsageUnit +summary: An enum describing the unit of usage measurement. +module: azure.mgmt.batchai.models +fields: +- name: COUNT + uid: azure.mgmt.batchai.models.UsageUnit.COUNT diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.UserAccountSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.UserAccountSettings.yml new file mode 100644 index 00000000..c66cff8f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.UserAccountSettings.yml @@ -0,0 +1,38 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.UserAccountSettings +name: UserAccountSettings +fullName: azure.mgmt.batchai.models.UserAccountSettings +module: azure.mgmt.batchai.models +summary: 'Settings for user account that gets created on each on the nodes of a cluster. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'UserAccountSettings(*, admin_user_name: str, admin_user_ssh_public_key: + str | None = None, admin_user_password: str | None = None, **kwargs)' + parameters: + - name: admin_user_name + description: 'Required. Name of the administrator user account which can be used + to + + SSH to nodes.' + isRequired: true + types: + - + - name: admin_user_ssh_public_key + description: SSH public key of the administrator user account. + isRequired: true + types: + - + - name: admin_user_password + description: Password of the administrator user account. + isRequired: true + types: + - + keywordOnlyParameters: + - name: admin_user_name + isRequired: true + - name: admin_user_ssh_public_key + isRequired: true + - name: admin_user_password + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.VirtualMachineConfiguration.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.VirtualMachineConfiguration.yml new file mode 100644 index 00000000..97154af1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.VirtualMachineConfiguration.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.VirtualMachineConfiguration +name: VirtualMachineConfiguration +fullName: azure.mgmt.batchai.models.VirtualMachineConfiguration +module: azure.mgmt.batchai.models +summary: VM configuration. +constructor: + syntax: 'VirtualMachineConfiguration(*, image_reference: ImageReference | None = + None, **kwargs)' + parameters: + - name: image_reference + description: OS image reference for cluster nodes. + isRequired: true + types: + - + keywordOnlyParameters: + - name: image_reference + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.VmPriority.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.VmPriority.yml new file mode 100644 index 00000000..437c4316 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.VmPriority.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.batchai.models.VmPriority +name: VmPriority +fullName: azure.mgmt.batchai.models.VmPriority +summary: 'VM priority. Allowed values are: dedicated (default) and lowpriority.' +module: azure.mgmt.batchai.models +fields: +- name: DEDICATED + uid: azure.mgmt.batchai.models.VmPriority.DEDICATED +- name: LOWPRIORITY + uid: azure.mgmt.batchai.models.VmPriority.LOWPRIORITY diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Workspace.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Workspace.yml new file mode 100644 index 00000000..d68d0f79 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Workspace.yml @@ -0,0 +1,49 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.Workspace +name: Workspace +fullName: azure.mgmt.batchai.models.Workspace +module: azure.mgmt.batchai.models +summary: 'Batch AI Workspace information. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: Workspace(**kwargs) +variables: +- description: The ID of the resource. + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: The type of the resource. + name: type + types: + - +- description: The location of the resource. + name: location + types: + - +- description: A set of tags. The tags of the resource. + name: tags + types: + - [, ] +- description: Time when the Workspace was created. + name: creation_time + types: + - +- description: 'The provisioned state of the Workspace. Possible values include: + + "creating", "succeeded", "failed", "deleting".' + name: provisioning_state + types: + - + - +- description: 'The time at which the workspace entered its current + + provisioning state.' + name: provisioning_state_transition_time + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspaceCreateParameters.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspaceCreateParameters.yml new file mode 100644 index 00000000..f118578e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspaceCreateParameters.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.WorkspaceCreateParameters +name: WorkspaceCreateParameters +fullName: azure.mgmt.batchai.models.WorkspaceCreateParameters +module: azure.mgmt.batchai.models +summary: 'Workspace creation parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'WorkspaceCreateParameters(*, location: str, tags: Dict[str, str] | None + = None, **kwargs)' + parameters: + - name: location + description: Required. The region in which to create the Workspace. + isRequired: true + types: + - + - name: tags + description: A set of tags. The user specified tags associated with the Workspace. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: location + isRequired: true + - name: tags + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspaceListResult.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspaceListResult.yml new file mode 100644 index 00000000..5ac28549 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspaceListResult.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.WorkspaceListResult +name: WorkspaceListResult +fullName: azure.mgmt.batchai.models.WorkspaceListResult +module: azure.mgmt.batchai.models +summary: 'Values returned by the List operation. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: WorkspaceListResult(**kwargs) +variables: +- description: The collection of workspaces. + name: value + types: + - [] +- description: The continuation token. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspaceUpdateParameters.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspaceUpdateParameters.yml new file mode 100644 index 00000000..c2c5a715 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspaceUpdateParameters.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.WorkspaceUpdateParameters +name: WorkspaceUpdateParameters +fullName: azure.mgmt.batchai.models.WorkspaceUpdateParameters +module: azure.mgmt.batchai.models +summary: Workspace update parameters. +constructor: + syntax: 'WorkspaceUpdateParameters(*, tags: Dict[str, str] | None = None, **kwargs)' + parameters: + - name: tags + description: A set of tags. The user specified tags associated with the Workspace. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: tags + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspacesListByResourceGroupOptions.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspacesListByResourceGroupOptions.yml new file mode 100644 index 00000000..fb651b79 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspacesListByResourceGroupOptions.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.WorkspacesListByResourceGroupOptions +name: WorkspacesListByResourceGroupOptions +fullName: azure.mgmt.batchai.models.WorkspacesListByResourceGroupOptions +module: azure.mgmt.batchai.models +summary: Parameter group. +constructor: + syntax: 'WorkspacesListByResourceGroupOptions(*, max_results: int | None = 1000, + **kwargs)' + parameters: + - name: max_results + description: 'The maximum number of items to return in the response. A maximum + of 1000 + + files can be returned.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: max_results + defaultValue: '1000' diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspacesListOptions.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspacesListOptions.yml new file mode 100644 index 00000000..c4ff2c6c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspacesListOptions.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.models.WorkspacesListOptions +name: WorkspacesListOptions +fullName: azure.mgmt.batchai.models.WorkspacesListOptions +module: azure.mgmt.batchai.models +summary: Parameter group. +constructor: + syntax: 'WorkspacesListOptions(*, max_results: int | None = 1000, **kwargs)' + parameters: + - name: max_results + description: 'The maximum number of items to return in the response. A maximum + of 1000 + + files can be returned.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: max_results + defaultValue: '1000' diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.yml new file mode 100644 index 00000000..0fe6d326 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.yml @@ -0,0 +1,99 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.batchai.models +name: models +fullName: azure.mgmt.batchai.models +type: import +classes: +- azure.mgmt.batchai.models.AppInsightsReference +- azure.mgmt.batchai.models.AutoScaleSettings +- azure.mgmt.batchai.models.AzureBlobFileSystemReference +- azure.mgmt.batchai.models.AzureFileShareReference +- azure.mgmt.batchai.models.AzureStorageCredentialsInfo +- azure.mgmt.batchai.models.BatchAIError +- azure.mgmt.batchai.models.CNTKsettings +- azure.mgmt.batchai.models.Caffe2Settings +- azure.mgmt.batchai.models.CaffeSettings +- azure.mgmt.batchai.models.ChainerSettings +- azure.mgmt.batchai.models.CloudErrorBody +- azure.mgmt.batchai.models.Cluster +- azure.mgmt.batchai.models.ClusterCreateParameters +- azure.mgmt.batchai.models.ClusterListResult +- azure.mgmt.batchai.models.ClusterUpdateParameters +- azure.mgmt.batchai.models.ClustersListByWorkspaceOptions +- azure.mgmt.batchai.models.ContainerSettings +- azure.mgmt.batchai.models.CustomMpiSettings +- azure.mgmt.batchai.models.CustomToolkitSettings +- azure.mgmt.batchai.models.DataDisks +- azure.mgmt.batchai.models.EnvironmentVariable +- azure.mgmt.batchai.models.EnvironmentVariableWithSecretValue +- azure.mgmt.batchai.models.Experiment +- azure.mgmt.batchai.models.ExperimentListResult +- azure.mgmt.batchai.models.ExperimentsListByWorkspaceOptions +- azure.mgmt.batchai.models.File +- azure.mgmt.batchai.models.FileListResult +- azure.mgmt.batchai.models.FileServer +- azure.mgmt.batchai.models.FileServerCreateParameters +- azure.mgmt.batchai.models.FileServerListResult +- azure.mgmt.batchai.models.FileServerReference +- azure.mgmt.batchai.models.FileServersListByWorkspaceOptions +- azure.mgmt.batchai.models.HorovodSettings +- azure.mgmt.batchai.models.ImageReference +- azure.mgmt.batchai.models.ImageSourceRegistry +- azure.mgmt.batchai.models.InputDirectory +- azure.mgmt.batchai.models.Job +- azure.mgmt.batchai.models.JobBasePropertiesConstraints +- azure.mgmt.batchai.models.JobCreateParameters +- azure.mgmt.batchai.models.JobListResult +- azure.mgmt.batchai.models.JobPreparation +- azure.mgmt.batchai.models.JobPropertiesConstraints +- azure.mgmt.batchai.models.JobPropertiesExecutionInfo +- azure.mgmt.batchai.models.JobsListByExperimentOptions +- azure.mgmt.batchai.models.JobsListOutputFilesOptions +- azure.mgmt.batchai.models.KeyVaultSecretReference +- azure.mgmt.batchai.models.ListUsagesResult +- azure.mgmt.batchai.models.ManualScaleSettings +- azure.mgmt.batchai.models.MountSettings +- azure.mgmt.batchai.models.MountVolumes +- azure.mgmt.batchai.models.NameValuePair +- azure.mgmt.batchai.models.NodeSetup +- azure.mgmt.batchai.models.NodeStateCounts +- azure.mgmt.batchai.models.Operation +- azure.mgmt.batchai.models.OperationDisplay +- azure.mgmt.batchai.models.OperationListResult +- azure.mgmt.batchai.models.OutputDirectory +- azure.mgmt.batchai.models.PerformanceCountersSettings +- azure.mgmt.batchai.models.PrivateRegistryCredentials +- azure.mgmt.batchai.models.ProxyResource +- azure.mgmt.batchai.models.PyTorchSettings +- azure.mgmt.batchai.models.RemoteLoginInformation +- azure.mgmt.batchai.models.RemoteLoginInformationListResult +- azure.mgmt.batchai.models.Resource +- azure.mgmt.batchai.models.ResourceId +- azure.mgmt.batchai.models.ScaleSettings +- azure.mgmt.batchai.models.SetupTask +- azure.mgmt.batchai.models.SshConfiguration +- azure.mgmt.batchai.models.TensorFlowSettings +- azure.mgmt.batchai.models.UnmanagedFileSystemReference +- azure.mgmt.batchai.models.Usage +- azure.mgmt.batchai.models.UsageName +- azure.mgmt.batchai.models.UserAccountSettings +- azure.mgmt.batchai.models.VirtualMachineConfiguration +- azure.mgmt.batchai.models.Workspace +- azure.mgmt.batchai.models.WorkspaceCreateParameters +- azure.mgmt.batchai.models.WorkspaceListResult +- azure.mgmt.batchai.models.WorkspaceUpdateParameters +- azure.mgmt.batchai.models.WorkspacesListByResourceGroupOptions +- azure.mgmt.batchai.models.WorkspacesListOptions +enums: +- azure.mgmt.batchai.models.AllocationState +- azure.mgmt.batchai.models.CachingType +- azure.mgmt.batchai.models.DeallocationOption +- azure.mgmt.batchai.models.ExecutionState +- azure.mgmt.batchai.models.FileServerProvisioningState +- azure.mgmt.batchai.models.FileType +- azure.mgmt.batchai.models.JobPriority +- azure.mgmt.batchai.models.ProvisioningState +- azure.mgmt.batchai.models.StorageAccountType +- azure.mgmt.batchai.models.ToolType +- azure.mgmt.batchai.models.UsageUnit +- azure.mgmt.batchai.models.VmPriority diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.ClustersOperations.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.ClustersOperations.yml new file mode 100644 index 00000000..00bdbf2a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.ClustersOperations.yml @@ -0,0 +1,335 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.operations.ClustersOperations +name: ClustersOperations +fullName: azure.mgmt.batchai.operations.ClustersOperations +module: azure.mgmt.batchai.operations +summary: 'ClustersOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: ClustersOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.batchai.operations.ClustersOperations.begin_create + name: begin_create + summary: Creates a Cluster in the given Workspace. + signature: 'begin_create(resource_group_name: str, workspace_name: str, cluster_name: + str, parameters: ''_models.ClusterCreateParameters'', **kwargs: Any) -> LROPoller[''_models.Cluster'']' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: cluster_name + description: 'The name of the cluster within the specified resource group. Cluster + names + + can only contain a combination of alphanumeric characters along with dash (-) + and underscore + + (_). The name must be from 1 through 64 characters long.' + isRequired: true + types: + - + - name: parameters + description: The parameters to provide for the Cluster creation. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either Cluster or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.operations.ClustersOperations.begin_delete + name: begin_delete + summary: Deletes a Cluster. + signature: 'begin_delete(resource_group_name: str, workspace_name: str, cluster_name: + str, **kwargs: Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: cluster_name + description: 'The name of the cluster within the specified resource group. Cluster + names + + can only contain a combination of alphanumeric characters along with dash (-) + and underscore + + (_). The name must be from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.operations.ClustersOperations.get + name: get + summary: Gets information about a Cluster. + signature: 'get(resource_group_name: str, workspace_name: str, cluster_name: str, + **kwargs: Any) -> _models.Cluster' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: cluster_name + description: 'The name of the cluster within the specified resource group. Cluster + names + + can only contain a combination of alphanumeric characters along with dash (-) + and underscore + + (_). The name must be from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Cluster, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.operations.ClustersOperations.list_by_workspace + name: list_by_workspace + summary: Gets information about Clusters associated with the given Workspace. + signature: 'list_by_workspace(resource_group_name: str, workspace_name: str, clusters_list_by_workspace_options: + ''_models.ClustersListByWorkspaceOptions'' | None = None, **kwargs: Any) -> Iterable[''_models.ClusterListResult'']' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: clusters_list_by_workspace_options + description: Parameter group. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either ClusterListResult or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.operations.ClustersOperations.list_remote_login_information + name: list_remote_login_information + summary: Get the IP address, port of all the compute nodes in the Cluster. + signature: 'list_remote_login_information(resource_group_name: str, workspace_name: + str, cluster_name: str, **kwargs: Any) -> Iterable[''_models.RemoteLoginInformationListResult'']' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: cluster_name + description: 'The name of the cluster within the specified resource group. Cluster + names + + can only contain a combination of alphanumeric characters along with dash (-) + and underscore + + (_). The name must be from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either RemoteLoginInformationListResult + or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.operations.ClustersOperations.update + name: update + summary: Updates properties of a Cluster. + signature: 'update(resource_group_name: str, workspace_name: str, cluster_name: + str, parameters: ''_models.ClusterUpdateParameters'', **kwargs: Any) -> _models.Cluster' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: cluster_name + description: 'The name of the cluster within the specified resource group. Cluster + names + + can only contain a combination of alphanumeric characters along with dash (-) + and underscore + + (_). The name must be from 1 through 64 characters long.' + isRequired: true + types: + - + - name: parameters + description: Additional parameters for cluster update. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Cluster, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.batchai.operations.ClustersOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.ExperimentsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.ExperimentsOperations.yml new file mode 100644 index 00000000..f7fdb238 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.ExperimentsOperations.yml @@ -0,0 +1,236 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.operations.ExperimentsOperations +name: ExperimentsOperations +fullName: azure.mgmt.batchai.operations.ExperimentsOperations +module: azure.mgmt.batchai.operations +summary: 'ExperimentsOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: ExperimentsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.batchai.operations.ExperimentsOperations.begin_create + name: begin_create + summary: Creates an Experiment. + signature: 'begin_create(resource_group_name: str, workspace_name: str, experiment_name: + str, **kwargs: Any) -> LROPoller[''_models.Experiment'']' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: experiment_name + description: 'The name of the experiment. Experiment names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either Experiment or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.operations.ExperimentsOperations.begin_delete + name: begin_delete + summary: Deletes an Experiment. + signature: 'begin_delete(resource_group_name: str, workspace_name: str, experiment_name: + str, **kwargs: Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: experiment_name + description: 'The name of the experiment. Experiment names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.operations.ExperimentsOperations.get + name: get + summary: Gets information about an Experiment. + signature: 'get(resource_group_name: str, workspace_name: str, experiment_name: + str, **kwargs: Any) -> _models.Experiment' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: experiment_name + description: 'The name of the experiment. Experiment names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Experiment, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.operations.ExperimentsOperations.list_by_workspace + name: list_by_workspace + summary: Gets a list of Experiments within the specified Workspace. + signature: 'list_by_workspace(resource_group_name: str, workspace_name: str, experiments_list_by_workspace_options: + ''_models.ExperimentsListByWorkspaceOptions'' | None = None, **kwargs: Any) -> + Iterable[''_models.ExperimentListResult'']' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: experiments_list_by_workspace_options + description: Parameter group. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either ExperimentListResult or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.batchai.operations.ExperimentsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.FileServersOperations.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.FileServersOperations.yml new file mode 100644 index 00000000..c944d559 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.FileServersOperations.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.operations.FileServersOperations +name: FileServersOperations +fullName: azure.mgmt.batchai.operations.FileServersOperations +module: azure.mgmt.batchai.operations +summary: 'FileServersOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: FileServersOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.batchai.operations.FileServersOperations.begin_create + name: begin_create + summary: Creates a File Server in the given workspace. + signature: 'begin_create(resource_group_name: str, workspace_name: str, file_server_name: + str, parameters: ''_models.FileServerCreateParameters'', **kwargs: Any) -> LROPoller[''_models.FileServer'']' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: file_server_name + description: 'The name of the file server within the specified resource group. + File + + server names can only contain a combination of alphanumeric characters along + with dash (-) and + + underscore (_). The name must be from 1 through 64 characters long.' + isRequired: true + types: + - + - name: parameters + description: The parameters to provide for File Server creation. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either FileServer or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.operations.FileServersOperations.list_by_workspace + name: list_by_workspace + summary: Gets a list of File Servers associated with the specified workspace. + signature: 'list_by_workspace(resource_group_name: str, workspace_name: str, file_servers_list_by_workspace_options: + ''_models.FileServersListByWorkspaceOptions'' | None = None, **kwargs: Any) -> + Iterable[''_models.FileServerListResult'']' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: file_servers_list_by_workspace_options + description: Parameter group. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either FileServerListResult or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.batchai.operations.FileServersOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.JobsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.JobsOperations.yml new file mode 100644 index 00000000..207fb614 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.JobsOperations.yml @@ -0,0 +1,476 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.operations.JobsOperations +name: JobsOperations +fullName: azure.mgmt.batchai.operations.JobsOperations +module: azure.mgmt.batchai.operations +summary: 'JobsOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: JobsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.batchai.operations.JobsOperations.begin_create + name: begin_create + summary: Creates a Job in the given Experiment. + signature: 'begin_create(resource_group_name: str, workspace_name: str, experiment_name: + str, job_name: str, parameters: ''_models.JobCreateParameters'', **kwargs: Any) + -> LROPoller[''_models.Job'']' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: experiment_name + description: 'The name of the experiment. Experiment names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: job_name + description: 'The name of the job within the specified resource group. Job names + can only + + contain a combination of alphanumeric characters along with dash (-) and underscore + (_). The + + name must be from 1 through 64 characters long.' + isRequired: true + types: + - + - name: parameters + description: The parameters to provide for job creation. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either Job or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.operations.JobsOperations.begin_delete + name: begin_delete + summary: Deletes a Job. + signature: 'begin_delete(resource_group_name: str, workspace_name: str, experiment_name: + str, job_name: str, **kwargs: Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: experiment_name + description: 'The name of the experiment. Experiment names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: job_name + description: 'The name of the job within the specified resource group. Job names + can only + + contain a combination of alphanumeric characters along with dash (-) and underscore + (_). The + + name must be from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.operations.JobsOperations.begin_terminate + name: begin_terminate + summary: Terminates a job. + signature: 'begin_terminate(resource_group_name: str, workspace_name: str, experiment_name: + str, job_name: str, **kwargs: Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: experiment_name + description: 'The name of the experiment. Experiment names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: job_name + description: 'The name of the job within the specified resource group. Job names + can only + + contain a combination of alphanumeric characters along with dash (-) and underscore + (_). The + + name must be from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.operations.JobsOperations.get + name: get + summary: Gets information about a Job. + signature: 'get(resource_group_name: str, workspace_name: str, experiment_name: + str, job_name: str, **kwargs: Any) -> _models.Job' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: experiment_name + description: 'The name of the experiment. Experiment names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: job_name + description: 'The name of the job within the specified resource group. Job names + can only + + contain a combination of alphanumeric characters along with dash (-) and underscore + (_). The + + name must be from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Job, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.operations.JobsOperations.list_by_experiment + name: list_by_experiment + summary: Gets a list of Jobs within the specified Experiment. + signature: 'list_by_experiment(resource_group_name: str, workspace_name: str, experiment_name: + str, jobs_list_by_experiment_options: ''_models.JobsListByExperimentOptions'' + | None = None, **kwargs: Any) -> Iterable[''_models.JobListResult'']' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: experiment_name + description: 'The name of the experiment. Experiment names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: jobs_list_by_experiment_options + description: Parameter group. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either JobListResult or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.operations.JobsOperations.list_output_files + name: list_output_files + summary: 'List all directories and files inside the given directory of the Job''s + output directory (if the + + output directory is on Azure File Share or Azure Storage Container).' + signature: 'list_output_files(resource_group_name: str, workspace_name: str, experiment_name: + str, job_name: str, jobs_list_output_files_options: ''_models.JobsListOutputFilesOptions'', + **kwargs: Any) -> Iterable[''_models.FileListResult'']' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: experiment_name + description: 'The name of the experiment. Experiment names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: job_name + description: 'The name of the job within the specified resource group. Job names + can only + + contain a combination of alphanumeric characters along with dash (-) and underscore + (_). The + + name must be from 1 through 64 characters long.' + isRequired: true + types: + - + - name: jobs_list_output_files_options + description: Parameter group. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either FileListResult or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.operations.JobsOperations.list_remote_login_information + name: list_remote_login_information + summary: 'Gets a list of currently existing nodes which were used for the Job execution. + The returned + + information contains the node ID, its public IP and SSH port.' + signature: 'list_remote_login_information(resource_group_name: str, workspace_name: + str, experiment_name: str, job_name: str, **kwargs: Any) -> Iterable[''_models.RemoteLoginInformationListResult'']' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: experiment_name + description: 'The name of the experiment. Experiment names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: job_name + description: 'The name of the job within the specified resource group. Job names + can only + + contain a combination of alphanumeric characters along with dash (-) and underscore + (_). The + + name must be from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either RemoteLoginInformationListResult + or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.batchai.operations.JobsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.Operations.yml new file mode 100644 index 00000000..c5751f5c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.Operations.yml @@ -0,0 +1,51 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.operations.Operations +name: Operations +fullName: azure.mgmt.batchai.operations.Operations +module: azure.mgmt.batchai.operations +summary: 'Operations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: Operations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.batchai.operations.Operations.list + name: list + summary: Lists available operations for the Microsoft.BatchAI provider. + signature: 'list(**kwargs: Any) -> Iterable[''_models.OperationListResult'']' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either OperationListResult or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.batchai.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.UsagesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.UsagesOperations.yml new file mode 100644 index 00000000..df891639 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.UsagesOperations.yml @@ -0,0 +1,60 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.operations.UsagesOperations +name: UsagesOperations +fullName: azure.mgmt.batchai.operations.UsagesOperations +module: azure.mgmt.batchai.operations +summary: 'UsagesOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: UsagesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.batchai.operations.UsagesOperations.list + name: list + summary: 'Gets the current usage information as well as limits for Batch AI resources + for given + + subscription.' + signature: 'list(location: str, **kwargs: Any) -> Iterable[''_models.ListUsagesResult'']' + parameters: + - name: location + description: The location for which resource usage is queried. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either ListUsagesResult or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.batchai.operations.UsagesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.WorkspacesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.WorkspacesOperations.yml new file mode 100644 index 00000000..8f27de76 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.WorkspacesOperations.yml @@ -0,0 +1,261 @@ +### YamlMime:PythonClass +uid: azure.mgmt.batchai.operations.WorkspacesOperations +name: WorkspacesOperations +fullName: azure.mgmt.batchai.operations.WorkspacesOperations +module: azure.mgmt.batchai.operations +summary: 'WorkspacesOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: WorkspacesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.batchai.operations.WorkspacesOperations.begin_create + name: begin_create + summary: Creates a Workspace. + signature: 'begin_create(resource_group_name: str, workspace_name: str, parameters: + ''_models.WorkspaceCreateParameters'', **kwargs: Any) -> LROPoller[''_models.Workspace'']' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: parameters + description: Workspace creation parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either Workspace or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.operations.WorkspacesOperations.begin_delete + name: begin_delete + summary: Deletes a Workspace. + signature: 'begin_delete(resource_group_name: str, workspace_name: str, **kwargs: + Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.operations.WorkspacesOperations.get + name: get + summary: Gets information about a Workspace. + signature: 'get(resource_group_name: str, workspace_name: str, **kwargs: Any) -> + _models.Workspace' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Workspace, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.operations.WorkspacesOperations.list + name: list + summary: Gets a list of Workspaces associated with the given subscription. + signature: 'list(workspaces_list_options: ''_models.WorkspacesListOptions'' | None + = None, **kwargs: Any) -> Iterable[''_models.WorkspaceListResult'']' + parameters: + - name: workspaces_list_options + description: Parameter group. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either WorkspaceListResult or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.operations.WorkspacesOperations.list_by_resource_group + name: list_by_resource_group + summary: Gets a list of Workspaces within the specified resource group. + signature: 'list_by_resource_group(resource_group_name: str, workspaces_list_by_resource_group_options: + ''_models.WorkspacesListByResourceGroupOptions'' | None = None, **kwargs: Any) + -> Iterable[''_models.WorkspaceListResult'']' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspaces_list_by_resource_group_options + description: Parameter group. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either WorkspaceListResult or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.batchai.operations.WorkspacesOperations.update + name: update + summary: Updates properties of a Workspace. + signature: 'update(resource_group_name: str, workspace_name: str, parameters: ''_models.WorkspaceUpdateParameters'', + **kwargs: Any) -> _models.Workspace' + parameters: + - name: resource_group_name + description: Name of the resource group to which the resource belongs. + isRequired: true + types: + - + - name: workspace_name + description: 'The name of the workspace. Workspace names can only contain a + + combination of alphanumeric characters along with dash (-) and underscore (_). + The name must be + + from 1 through 64 characters long.' + isRequired: true + types: + - + - name: parameters + description: Additional parameters for workspace update. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Workspace, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.batchai.operations.WorkspacesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.yml new file mode 100644 index 00000000..8d8ac2fe --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.operations.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.batchai.operations +name: operations +fullName: azure.mgmt.batchai.operations +type: import +classes: +- azure.mgmt.batchai.operations.ClustersOperations +- azure.mgmt.batchai.operations.ExperimentsOperations +- azure.mgmt.batchai.operations.FileServersOperations +- azure.mgmt.batchai.operations.JobsOperations +- azure.mgmt.batchai.operations.Operations +- azure.mgmt.batchai.operations.UsagesOperations +- azure.mgmt.batchai.operations.WorkspacesOperations diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.yml new file mode 100644 index 00000000..d6b8be52 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.batchai +name: batchai +fullName: azure.mgmt.batchai +type: rootImport +classes: +- azure.mgmt.batchai.BatchAI +packages: +- azure.mgmt.batchai.aio +- azure.mgmt.batchai.models +- azure.mgmt.batchai.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.DataBoxEdgeManagementClient.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.DataBoxEdgeManagementClient.yml new file mode 100644 index 00000000..a6b3bc65 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.DataBoxEdgeManagementClient.yml @@ -0,0 +1,76 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.DataBoxEdgeManagementClient +name: DataBoxEdgeManagementClient +fullName: azure.mgmt.edgegateway.DataBoxEdgeManagementClient +module: azure.mgmt.edgegateway +constructor: + syntax: DataBoxEdgeManagementClient(credentials, subscription_id, base_url=None) + parameters: + - name: credentials + description: Credentials needed for the client to connect to Azure. + isRequired: true + types: + - + - name: subscription_id + description: The subscription ID. + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +- description: Operations operations + name: operations + types: + - +- description: Devices operations + name: devices + types: + - +- description: Alerts operations + name: alerts + types: + - +- description: BandwidthSchedules operations + name: bandwidth_schedules + types: + - +- description: Jobs operations + name: jobs + types: + - +- description: OperationsStatus operations + name: operations_status + types: + - +- description: Orders operations + name: orders + types: + - +- description: Roles operations + name: roles + types: + - +- description: Shares operations + name: shares + types: + - +- description: StorageAccountCredentials operations + name: storage_account_credentials + types: + - +- description: Triggers operations + name: triggers + types: + - +- description: Users operations + name: users + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.data_box_edge_management_client.DataBoxEdgeManagementClient.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.data_box_edge_management_client.DataBoxEdgeManagementClient.yml new file mode 100644 index 00000000..c25a4b76 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.data_box_edge_management_client.DataBoxEdgeManagementClient.yml @@ -0,0 +1,76 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.data_box_edge_management_client.DataBoxEdgeManagementClient +name: DataBoxEdgeManagementClient +fullName: azure.mgmt.edgegateway.data_box_edge_management_client.DataBoxEdgeManagementClient +module: azure.mgmt.edgegateway.data_box_edge_management_client +constructor: + syntax: DataBoxEdgeManagementClient(credentials, subscription_id, base_url=None) + parameters: + - name: credentials + description: Credentials needed for the client to connect to Azure. + isRequired: true + types: + - + - name: subscription_id + description: The subscription ID. + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - +variables: +- description: Configuration for client. + name: config + types: + - +- description: Operations operations + name: operations + types: + - +- description: Devices operations + name: devices + types: + - +- description: Alerts operations + name: alerts + types: + - +- description: BandwidthSchedules operations + name: bandwidth_schedules + types: + - +- description: Jobs operations + name: jobs + types: + - +- description: OperationsStatus operations + name: operations_status + types: + - +- description: Orders operations + name: orders + types: + - +- description: Roles operations + name: roles + types: + - +- description: Shares operations + name: shares + types: + - +- description: StorageAccountCredentials operations + name: storage_account_credentials + types: + - +- description: Triggers operations + name: triggers + types: + - +- description: Users operations + name: users + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.data_box_edge_management_client.DataBoxEdgeManagementClientConfiguration.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.data_box_edge_management_client.DataBoxEdgeManagementClientConfiguration.yml new file mode 100644 index 00000000..6ce47939 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.data_box_edge_management_client.DataBoxEdgeManagementClientConfiguration.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.data_box_edge_management_client.DataBoxEdgeManagementClientConfiguration +name: DataBoxEdgeManagementClientConfiguration +fullName: azure.mgmt.edgegateway.data_box_edge_management_client.DataBoxEdgeManagementClientConfiguration +module: azure.mgmt.edgegateway.data_box_edge_management_client +summary: 'Configuration for DataBoxEdgeManagementClient + + Note that all parameters used to create this instance are saved as instance + + attributes.' +constructor: + syntax: DataBoxEdgeManagementClientConfiguration(credentials, subscription_id, base_url=None) + parameters: + - name: credentials + description: Credentials needed for the client to connect to Azure. + isRequired: true + types: + - + - name: subscription_id + description: The subscription ID. + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.data_box_edge_management_client.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.data_box_edge_management_client.yml new file mode 100644 index 00000000..fc1e6f7f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.data_box_edge_management_client.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.data_box_edge_management_client +name: data_box_edge_management_client +fullName: azure.mgmt.edgegateway.data_box_edge_management_client +classes: +- azure.mgmt.edgegateway.data_box_edge_management_client.DataBoxEdgeManagementClient +- azure.mgmt.edgegateway.data_box_edge_management_client.DataBoxEdgeManagementClientConfiguration diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ARMBaseModel.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ARMBaseModel.yml new file mode 100644 index 00000000..43f1edf8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ARMBaseModel.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.ARMBaseModel +name: ARMBaseModel +fullName: azure.mgmt.edgegateway.models.ARMBaseModel +module: azure.mgmt.edgegateway.models +summary: 'Represents the base class for all object models. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: ARMBaseModel(**kwargs) +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AccountType.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AccountType.yml new file mode 100644 index 00000000..ed38f71d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AccountType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.AccountType +name: AccountType +fullName: azure.mgmt.edgegateway.models.AccountType +module: azure.mgmt.edgegateway.models +fields: +- name: blob_storage + uid: azure.mgmt.edgegateway.models.AccountType.blob_storage +- name: general_purpose_storage + uid: azure.mgmt.edgegateway.models.AccountType.general_purpose_storage diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Address(class).yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Address(class).yml new file mode 100644 index 00000000..7dfd82d5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Address(class).yml @@ -0,0 +1,63 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.Address +name: Address +fullName: azure.mgmt.edgegateway.models.Address +module: azure.mgmt.edgegateway.models +summary: 'The shipping address of the customer. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Address(*, address_line1: str, postal_code: str, city: str, state: str, + country: str, address_line2: str = None, address_line3: str = None, **kwargs)' + parameters: + - name: address_line1 + description: Required. The address line1. + isRequired: true + types: + - + - name: address_line2 + description: The address line2. + isRequired: true + types: + - + - name: address_line3 + description: The address line3. + isRequired: true + types: + - + - name: postal_code + description: Required. The postal code. + isRequired: true + types: + - + - name: city + description: Required. The city name. + isRequired: true + types: + - + - name: state + description: Required. The state name. + isRequired: true + types: + - + - name: country + description: Required. The country name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: address_line1 + isRequired: true + - name: postal_code + isRequired: true + - name: city + isRequired: true + - name: state + isRequired: true + - name: country + isRequired: true + - name: address_line2 + isRequired: true + - name: address_line3 + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Alert(class).yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Alert(class).yml new file mode 100644 index 00000000..1b07f00c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Alert(class).yml @@ -0,0 +1,57 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.Alert +name: Alert +fullName: azure.mgmt.edgegateway.models.Alert +module: azure.mgmt.edgegateway.models +summary: 'Alert on the data box edge/gateway device. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Alert(**kwargs) +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: Alert title. + name: title + types: + - +- description: Alert type. + name: alert_type + types: + - +- description: UTC time when the alert appeared. + name: appeared_at_date_time + types: + - +- description: Alert recommendation. + name: recommendation + types: + - +- description: 'Severity of the alert. Possible values include: + + ''Informational'', ''Warning'', ''Critical''' + name: severity + types: + - + - +- description: Error details of the alert. + name: error_details + types: + - +- description: Alert details. + name: detailed_information + types: + - [, ] diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AlertErrorDetails.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AlertErrorDetails.yml new file mode 100644 index 00000000..93e32eda --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AlertErrorDetails.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.AlertErrorDetails +name: AlertErrorDetails +fullName: azure.mgmt.edgegateway.models.AlertErrorDetails +module: azure.mgmt.edgegateway.models +summary: 'Error details for the alert. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: AlertErrorDetails(**kwargs) +variables: +- description: Error code. + name: error_code + types: + - +- description: Error Message. + name: error_message + types: + - +- description: Number of occurrences. + name: occurrences + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AlertPaged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AlertPaged.yml new file mode 100644 index 00000000..c2450f10 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AlertPaged.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.AlertPaged +name: AlertPaged +fullName: azure.mgmt.edgegateway.models.AlertPaged +module: azure.mgmt.edgegateway.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: AlertPaged(*args, **kwargs) diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AlertSeverity.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AlertSeverity.yml new file mode 100644 index 00000000..56c7da86 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AlertSeverity.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.AlertSeverity +name: AlertSeverity +fullName: azure.mgmt.edgegateway.models.AlertSeverity +module: azure.mgmt.edgegateway.models +fields: +- name: critical + uid: azure.mgmt.edgegateway.models.AlertSeverity.critical +- name: informational + uid: azure.mgmt.edgegateway.models.AlertSeverity.informational +- name: warning + uid: azure.mgmt.edgegateway.models.AlertSeverity.warning diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AsymmetricEncryptedSecret.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AsymmetricEncryptedSecret.yml new file mode 100644 index 00000000..8e89b220 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AsymmetricEncryptedSecret.yml @@ -0,0 +1,40 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.AsymmetricEncryptedSecret +name: AsymmetricEncryptedSecret +fullName: azure.mgmt.edgegateway.models.AsymmetricEncryptedSecret +module: azure.mgmt.edgegateway.models +summary: 'Represent the secrets intended for encryption with asymmetric key pair. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AsymmetricEncryptedSecret(*, value: str, encryption_algorithm, encryption_cert_thumbprint: + str = None, **kwargs)' + parameters: + - name: value + description: Required. The value of the secret. + isRequired: true + types: + - + - name: encryption_cert_thumbprint + description: 'Thumbprint certificate used to encrypt + + "Value". If the value is unencrypted, it will be null.' + isRequired: true + types: + - + - name: encryption_algorithm + description: 'Required. The algorithm used to encrypt + + "Value". Possible values include: ''None'', ''AES256'', ''RSAES_PKCS1_v_1_5''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: encryption_algorithm + isRequired: true + - name: encryption_cert_thumbprint + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Authentication(class).yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Authentication(class).yml new file mode 100644 index 00000000..f27de4ea --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Authentication(class).yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.Authentication +name: Authentication +fullName: azure.mgmt.edgegateway.models.Authentication +module: azure.mgmt.edgegateway.models +summary: Authentication mechanism for IoT devices. +constructor: + syntax: Authentication(*, symmetric_key=None, **kwargs) + parameters: + - name: symmetric_key + description: Symmetric key for authentication. + isRequired: true + types: + - + keywordOnlyParameters: + - name: symmetric_key + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AuthenticationType.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AuthenticationType.yml new file mode 100644 index 00000000..2dc3f0b8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AuthenticationType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.AuthenticationType +name: AuthenticationType +fullName: azure.mgmt.edgegateway.models.AuthenticationType +module: azure.mgmt.edgegateway.models +fields: +- name: azure_active_directory + uid: azure.mgmt.edgegateway.models.AuthenticationType.azure_active_directory +- name: invalid + uid: azure.mgmt.edgegateway.models.AuthenticationType.invalid diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AzureContainerDataFormat.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AzureContainerDataFormat.yml new file mode 100644 index 00000000..83623588 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AzureContainerDataFormat.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.AzureContainerDataFormat +name: AzureContainerDataFormat +fullName: azure.mgmt.edgegateway.models.AzureContainerDataFormat +module: azure.mgmt.edgegateway.models +fields: +- name: azure_file + uid: azure.mgmt.edgegateway.models.AzureContainerDataFormat.azure_file +- name: block_blob + uid: azure.mgmt.edgegateway.models.AzureContainerDataFormat.block_blob +- name: page_blob + uid: azure.mgmt.edgegateway.models.AzureContainerDataFormat.page_blob diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AzureContainerInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AzureContainerInfo.yml new file mode 100644 index 00000000..1b43a46f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AzureContainerInfo.yml @@ -0,0 +1,44 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.AzureContainerInfo +name: AzureContainerInfo +fullName: azure.mgmt.edgegateway.models.AzureContainerInfo +module: azure.mgmt.edgegateway.models +summary: 'Azure container mapping of the endpoint. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureContainerInfo(*, storage_account_credential_id: str, container_name: + str, data_format, **kwargs)' + parameters: + - name: storage_account_credential_id + description: 'Required. ID of the storage account + + credential used to access storage.' + isRequired: true + types: + - + - name: container_name + description: 'Required. Container name (Based on the data format + + specified, this represents the name of Azure Files/Page blob/Block blob).' + isRequired: true + types: + - + - name: data_format + description: 'Required. Storage format used for the file represented + + by the share. Possible values include: ''BlockBlob'', ''PageBlob'', + + ''AzureFile''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: storage_account_credential_id + isRequired: true + - name: container_name + isRequired: true + - name: data_format + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.BandwidthSchedule.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.BandwidthSchedule.yml new file mode 100644 index 00000000..5645748b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.BandwidthSchedule.yml @@ -0,0 +1,62 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.BandwidthSchedule +name: BandwidthSchedule +fullName: azure.mgmt.edgegateway.models.BandwidthSchedule +module: azure.mgmt.edgegateway.models +summary: 'The bandwidth schedule details. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'BandwidthSchedule(*, start: str, stop: str, rate_in_mbps: int, days, **kwargs)' + parameters: + - name: start + description: Required. The start time of the schedule in UTC. + isRequired: true + types: + - + - name: stop + description: Required. The stop time of the schedule in UTC. + isRequired: true + types: + - + - name: rate_in_mbps + description: Required. The bandwidth rate in Mbps. + isRequired: true + types: + - + - name: days + description: 'Required. The days of the week when this schedule is + + applicable.' + isRequired: true + types: + - [ + - ] + keywordOnlyParameters: + - name: start + isRequired: true + - name: stop + isRequired: true + - name: rate_in_mbps + isRequired: true + - name: days + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.BandwidthSchedulePaged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.BandwidthSchedulePaged.yml new file mode 100644 index 00000000..ea65ebc6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.BandwidthSchedulePaged.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.BandwidthSchedulePaged +name: BandwidthSchedulePaged +fullName: azure.mgmt.edgegateway.models.BandwidthSchedulePaged +module: azure.mgmt.edgegateway.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: BandwidthSchedulePaged(*args, **kwargs) diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ClientAccessRight.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ClientAccessRight.yml new file mode 100644 index 00000000..265ba4bf --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ClientAccessRight.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.ClientAccessRight +name: ClientAccessRight +fullName: azure.mgmt.edgegateway.models.ClientAccessRight +module: azure.mgmt.edgegateway.models +summary: 'The mapping between a particular client IP and the type of access client + + has on the NFS share. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ClientAccessRight(*, client: str, access_permission, **kwargs)' + parameters: + - name: client + description: Required. IP of the client. + isRequired: true + types: + - + - name: access_permission + description: 'Required. Type of access to be allowed for the + + client. Possible values include: ''NoAccess'', ''ReadOnly'', ''ReadWrite''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: client + isRequired: true + - name: access_permission + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ClientPermissionType.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ClientPermissionType.yml new file mode 100644 index 00000000..1bcdd521 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ClientPermissionType.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.ClientPermissionType +name: ClientPermissionType +fullName: azure.mgmt.edgegateway.models.ClientPermissionType +module: azure.mgmt.edgegateway.models +fields: +- name: no_access + uid: azure.mgmt.edgegateway.models.ClientPermissionType.no_access +- name: read_only + uid: azure.mgmt.edgegateway.models.ClientPermissionType.read_only +- name: read_write + uid: azure.mgmt.edgegateway.models.ClientPermissionType.read_write diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ContactDetails.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ContactDetails.yml new file mode 100644 index 00000000..8722aa34 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ContactDetails.yml @@ -0,0 +1,42 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.ContactDetails +name: ContactDetails +fullName: azure.mgmt.edgegateway.models.ContactDetails +module: azure.mgmt.edgegateway.models +summary: 'Contains all the contact details of the customer. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ContactDetails(*, contact_person: str, company_name: str, phone: str, email_list, + **kwargs)' + parameters: + - name: contact_person + description: Required. The contact person name. + isRequired: true + types: + - + - name: company_name + description: Required. The name of the company. + isRequired: true + types: + - + - name: phone + description: Required. The phone number. + isRequired: true + types: + - + - name: email_list + description: Required. The email list. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: contact_person + isRequired: true + - name: company_name + isRequired: true + - name: phone + isRequired: true + - name: email_list + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDevice.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDevice.yml new file mode 100644 index 00000000..6d534b43 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDevice.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.DataBoxEdgeDevice +name: DataBoxEdgeDevice +fullName: azure.mgmt.edgegateway.models.DataBoxEdgeDevice +module: azure.mgmt.edgegateway.models +summary: 'The Data Box Edge/Gateway device. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DataBoxEdgeDevice(*, location: str, tags=None, sku=None, etag: str = None, + data_box_edge_device_status=None, description: str = None, model_description: + str = None, friendly_name: str = None, **kwargs)' + parameters: + - name: location + description: 'Required. The location of the device. This is a supported + + and registered Azure geographical region (for example, West US, East US, + + or Southeast Asia). The geographical region of a device cannot be changed + + once it is created, but if an identical geographical region is specified + + on update, the request will succeed.' + isRequired: true + types: + - + - name: tags + description: 'The list of tags that describe the device. These tags can be + + used to view and group this device (across resource groups).' + isRequired: true + types: + - [, ] + - name: sku + description: The SKU type. + isRequired: true + types: + - + - name: etag + description: The etag for the devices. + isRequired: true + types: + - + - name: data_box_edge_device_status + description: 'The status of the Data Box + + Edge/Gateway device. Possible values include: ''ReadyToSetup'', ''Online'', + + ''Offline'', ''NeedsAttention'', ''Disconnected'', ''PartiallyDisconnected''' + isRequired: true + types: + - + - + - name: description + description: The Description of the Data Box Edge/Gateway device. + isRequired: true + types: + - + - name: model_description + description: 'The description of the Data Box Edge/Gateway + + device model.' + isRequired: true + types: + - + - name: friendly_name + description: The Data Box Edge/Gateway device name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: location + isRequired: true + - name: tags + isRequired: true + - name: sku + isRequired: true + - name: etag + isRequired: true + - name: data_box_edge_device_status + isRequired: true + - name: description + isRequired: true + - name: model_description + isRequired: true + - name: friendly_name + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: The Serial Number of Data Box Edge/Gateway device. + name: serial_number + types: + - +- description: 'The type of the Data Box Edge/Gateway device. Possible + + values include: ''DataBoxEdgeDevice''' + name: device_type + types: + - + - +- description: The Data Box Edge/Gateway device culture. + name: culture + types: + - +- description: The Data Box Edge/Gateway device model. + name: device_model + types: + - +- description: 'The Data Box Edge/Gateway device software + + version.' + name: device_software_version + types: + - +- description: 'The Data Box Edge/Gateway device local + + capacity in MB.' + name: device_local_capacity + types: + - +- description: The Data Box Edge/Gateway device timezone. + name: time_zone + types: + - +- description: 'The device software version number of the device + + (eg: 1.2.18105.6).' + name: device_hcs_version + types: + - +- description: Type of compute roles configured. + name: configured_role_types + types: + - [ + - ] diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDeviceExtendedInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDeviceExtendedInfo.yml new file mode 100644 index 00000000..4bc36be8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDeviceExtendedInfo.yml @@ -0,0 +1,51 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.DataBoxEdgeDeviceExtendedInfo +name: DataBoxEdgeDeviceExtendedInfo +fullName: azure.mgmt.edgegateway.models.DataBoxEdgeDeviceExtendedInfo +module: azure.mgmt.edgegateway.models +summary: 'The extended Info of the Data Box Edge/Gateway device. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DataBoxEdgeDeviceExtendedInfo(*, encryption_key_thumbprint: str = None, + encryption_key: str = None, **kwargs)' + parameters: + - name: encryption_key_thumbprint + description: 'The digital signature of encrypted + + certificate.' + isRequired: true + types: + - + - name: encryption_key + description: 'The public part of the encryption certificate. + + Client uses this to encrypt any secret.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: encryption_key_thumbprint + isRequired: true + - name: encryption_key + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: The Resource ID of the Resource. + name: resource_key + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDevicePaged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDevicePaged.yml new file mode 100644 index 00000000..b98c22fd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDevicePaged.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.DataBoxEdgeDevicePaged +name: DataBoxEdgeDevicePaged +fullName: azure.mgmt.edgegateway.models.DataBoxEdgeDevicePaged +module: azure.mgmt.edgegateway.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: DataBoxEdgeDevicePaged(*args, **kwargs) diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDevicePatch.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDevicePatch.yml new file mode 100644 index 00000000..ef765db9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDevicePatch.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.DataBoxEdgeDevicePatch +name: DataBoxEdgeDevicePatch +fullName: azure.mgmt.edgegateway.models.DataBoxEdgeDevicePatch +module: azure.mgmt.edgegateway.models +summary: The Data Box Edge/Gateway device patch. +constructor: + syntax: DataBoxEdgeDevicePatch(*, tags=None, **kwargs) + parameters: + - name: tags + description: The tags attached to the Data Box Edge/Gateway resource. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: tags + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDeviceStatus.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDeviceStatus.yml new file mode 100644 index 00000000..38a374bf --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDeviceStatus.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.DataBoxEdgeDeviceStatus +name: DataBoxEdgeDeviceStatus +fullName: azure.mgmt.edgegateway.models.DataBoxEdgeDeviceStatus +module: azure.mgmt.edgegateway.models +fields: +- name: disconnected + uid: azure.mgmt.edgegateway.models.DataBoxEdgeDeviceStatus.disconnected +- name: needs_attention + uid: azure.mgmt.edgegateway.models.DataBoxEdgeDeviceStatus.needs_attention +- name: offline + uid: azure.mgmt.edgegateway.models.DataBoxEdgeDeviceStatus.offline +- name: online + uid: azure.mgmt.edgegateway.models.DataBoxEdgeDeviceStatus.online +- name: partially_disconnected + uid: azure.mgmt.edgegateway.models.DataBoxEdgeDeviceStatus.partially_disconnected +- name: ready_to_setup + uid: azure.mgmt.edgegateway.models.DataBoxEdgeDeviceStatus.ready_to_setup diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataPolicy.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataPolicy.yml new file mode 100644 index 00000000..3a356146 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataPolicy.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.DataPolicy +name: DataPolicy +fullName: azure.mgmt.edgegateway.models.DataPolicy +module: azure.mgmt.edgegateway.models +fields: +- name: cloud + uid: azure.mgmt.edgegateway.models.DataPolicy.cloud +- name: local + uid: azure.mgmt.edgegateway.models.DataPolicy.local diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DayOfWeek.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DayOfWeek.yml new file mode 100644 index 00000000..eecf88fc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DayOfWeek.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.DayOfWeek +name: DayOfWeek +fullName: azure.mgmt.edgegateway.models.DayOfWeek +module: azure.mgmt.edgegateway.models +fields: +- name: friday + uid: azure.mgmt.edgegateway.models.DayOfWeek.friday +- name: monday + uid: azure.mgmt.edgegateway.models.DayOfWeek.monday +- name: saturday + uid: azure.mgmt.edgegateway.models.DayOfWeek.saturday +- name: sunday + uid: azure.mgmt.edgegateway.models.DayOfWeek.sunday +- name: thursday + uid: azure.mgmt.edgegateway.models.DayOfWeek.thursday +- name: tuesday + uid: azure.mgmt.edgegateway.models.DayOfWeek.tuesday +- name: wednesday + uid: azure.mgmt.edgegateway.models.DayOfWeek.wednesday diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DeviceType.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DeviceType.yml new file mode 100644 index 00000000..c56ae9cb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DeviceType.yml @@ -0,0 +1,8 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.DeviceType +name: DeviceType +fullName: azure.mgmt.edgegateway.models.DeviceType +module: azure.mgmt.edgegateway.models +fields: +- name: data_box_edge_device + uid: azure.mgmt.edgegateway.models.DeviceType.data_box_edge_device diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DownloadPhase.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DownloadPhase.yml new file mode 100644 index 00000000..d00d7451 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DownloadPhase.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.DownloadPhase +name: DownloadPhase +fullName: azure.mgmt.edgegateway.models.DownloadPhase +module: azure.mgmt.edgegateway.models +fields: +- name: downloading + uid: azure.mgmt.edgegateway.models.DownloadPhase.downloading +- name: initializing + uid: azure.mgmt.edgegateway.models.DownloadPhase.initializing +- name: unknown + uid: azure.mgmt.edgegateway.models.DownloadPhase.unknown +- name: verifying + uid: azure.mgmt.edgegateway.models.DownloadPhase.verifying diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.EncryptionAlgorithm.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.EncryptionAlgorithm.yml new file mode 100644 index 00000000..a06e9abf --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.EncryptionAlgorithm.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.EncryptionAlgorithm +name: EncryptionAlgorithm +fullName: azure.mgmt.edgegateway.models.EncryptionAlgorithm +module: azure.mgmt.edgegateway.models +fields: +- name: aes256 + uid: azure.mgmt.edgegateway.models.EncryptionAlgorithm.aes256 +- name: none + uid: azure.mgmt.edgegateway.models.EncryptionAlgorithm.none +- name: rsaes_pkcs1_v_1_5 + uid: azure.mgmt.edgegateway.models.EncryptionAlgorithm.rsaes_pkcs1_v_1_5 diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.FileEventTrigger.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.FileEventTrigger.yml new file mode 100644 index 00000000..4574fa1f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.FileEventTrigger.yml @@ -0,0 +1,64 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.FileEventTrigger +name: FileEventTrigger +fullName: azure.mgmt.edgegateway.models.FileEventTrigger +module: azure.mgmt.edgegateway.models +summary: 'Trigger details. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'FileEventTrigger(*, source_info, sink_info, custom_context_tag: str = None, + **kwargs)' + parameters: + - name: kind + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: source_info + description: Required. File event source details. + isRequired: true + types: + - + - name: sink_info + description: Required. Role sink info. + isRequired: true + types: + - + - name: custom_context_tag + description: 'A custom context tag typically used to + + correlate the trigger against its usage. For example, if a periodic timer + + trigger is intended for certain specific IoT modules in the device, the + + tag can be the name or the image URL of the module.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: source_info + isRequired: true + - name: sink_info + isRequired: true + - name: custom_context_tag + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.FileSourceInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.FileSourceInfo.yml new file mode 100644 index 00000000..202e6d94 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.FileSourceInfo.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.FileSourceInfo +name: FileSourceInfo +fullName: azure.mgmt.edgegateway.models.FileSourceInfo +module: azure.mgmt.edgegateway.models +summary: 'File source details. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'FileSourceInfo(*, share_id: str, **kwargs)' + parameters: + - name: share_id + description: Required. File share ID. + isRequired: true + types: + - + keywordOnlyParameters: + - name: share_id + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.InstallRebootBehavior.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.InstallRebootBehavior.yml new file mode 100644 index 00000000..40aa8a41 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.InstallRebootBehavior.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.InstallRebootBehavior +name: InstallRebootBehavior +fullName: azure.mgmt.edgegateway.models.InstallRebootBehavior +module: azure.mgmt.edgegateway.models +fields: +- name: never_reboots + uid: azure.mgmt.edgegateway.models.InstallRebootBehavior.never_reboots +- name: request_reboot + uid: azure.mgmt.edgegateway.models.InstallRebootBehavior.request_reboot +- name: requires_reboot + uid: azure.mgmt.edgegateway.models.InstallRebootBehavior.requires_reboot diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.IoTDeviceInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.IoTDeviceInfo.yml new file mode 100644 index 00000000..cedbdc92 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.IoTDeviceInfo.yml @@ -0,0 +1,37 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.IoTDeviceInfo +name: IoTDeviceInfo +fullName: azure.mgmt.edgegateway.models.IoTDeviceInfo +module: azure.mgmt.edgegateway.models +summary: 'Metadata of IoT device/IoT Edge device to be configured. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'IoTDeviceInfo(*, device_id: str, io_thost_hub: str, authentication=None, + **kwargs)' + parameters: + - name: device_id + description: Required. ID of the IoT device/edge device. + isRequired: true + types: + - + - name: io_thost_hub + description: 'Required. Host name for the IoT hub associated to the + + device.' + isRequired: true + types: + - + - name: authentication + description: IoT device authentication info. + isRequired: true + types: + - + keywordOnlyParameters: + - name: device_id + isRequired: true + - name: io_thost_hub + isRequired: true + - name: authentication + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.IoTRole.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.IoTRole.yml new file mode 100644 index 00000000..244728c1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.IoTRole.yml @@ -0,0 +1,82 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.IoTRole +name: IoTRole +fullName: azure.mgmt.edgegateway.models.IoTRole +module: azure.mgmt.edgegateway.models +summary: 'Compute role. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: IoTRole(*, host_platform, io_tdevice_details, io_tedge_device_details, role_status, + share_mappings=None, **kwargs) + parameters: + - name: kind + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: host_platform + description: 'Required. Host OS supported by the IoT role. + + Possible values include: ''Windows'', ''Linux''' + isRequired: true + types: + - + - + - name: io_tdevice_details + description: 'Required. IoT device metadata to which data box + + edge device needs to be connected.' + isRequired: true + types: + - + - name: io_tedge_device_details + description: 'Required. IoT edge device to which the IoT + + role needs to be configured.' + isRequired: true + types: + - + - name: share_mappings + description: Mount points of shares in role(s). + isRequired: true + types: + - [] + - name: role_status + description: 'Required. Role status. Possible values include: + + ''Enabled'', ''Disabled''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: host_platform + isRequired: true + - name: io_tdevice_details + isRequired: true + - name: io_tedge_device_details + isRequired: true + - name: role_status + isRequired: true + - name: share_mappings + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Ipv4Config.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Ipv4Config.yml new file mode 100644 index 00000000..37d7bc88 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Ipv4Config.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.Ipv4Config +name: Ipv4Config +fullName: azure.mgmt.edgegateway.models.Ipv4Config +module: azure.mgmt.edgegateway.models +summary: 'Details related to the IPv4 address configuration. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Ipv4Config(**kwargs) +variables: +- description: The IPv4 address of the network adapter. + name: ip_address + types: + - +- description: The IPv4 subnet of the network adapter. + name: subnet + types: + - +- description: The IPv4 gateway of the network adapter. + name: gateway + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Ipv6Config.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Ipv6Config.yml new file mode 100644 index 00000000..38a1831c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Ipv6Config.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.Ipv6Config +name: Ipv6Config +fullName: azure.mgmt.edgegateway.models.Ipv6Config +module: azure.mgmt.edgegateway.models +summary: 'Details related to the IPv6 address configuration. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Ipv6Config(**kwargs) +variables: +- description: The IPv6 address of the network adapter. + name: ip_address + types: + - +- description: The IPv6 prefix of the network adapter. + name: prefix_length + types: + - +- description: The IPv6 gateway of the network adapter. + name: gateway + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Job(class).yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Job(class).yml new file mode 100644 index 00000000..5822bcaf --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Job(class).yml @@ -0,0 +1,106 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.Job +name: Job +fullName: azure.mgmt.edgegateway.models.Job +module: azure.mgmt.edgegateway.models +summary: 'A device job. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'Job(*, folder: str = None, **kwargs)' + parameters: + - name: folder + description: 'If only subfolders need to be refreshed, then the subfolder + + path inside the share. (The path is empty if there are no subfolders.)' + isRequired: true + types: + - + keywordOnlyParameters: + - name: folder + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The name of the object. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: 'The current status of the job. Possible values include: + + ''Invalid'', ''Running'', ''Succeeded'', ''Failed'', ''Canceled'', ''Paused'', + + ''Scheduled''' + name: status + types: + - + - +- description: The UTC date and time at which the job started. + name: start_time + types: + - +- description: The UTC date and time at which the job completed. + name: end_time + types: + - +- description: The percentage of the job that is complete. + name: percent_complete + types: + - +- description: The error details. + name: error + types: + - +- description: 'The type of the job. Possible values include: ''Invalid'', + + ''ScanForUpdates'', ''DownloadUpdates'', ''InstallUpdates'', ''RefreshShare''' + name: job_type + types: + - + - +- description: 'Current stage of the update operation. Possible + + values include: ''Unknown'', ''Initial'', ''ScanStarted'', ''ScanComplete'', + + ''ScanFailed'', ''DownloadStarted'', ''DownloadComplete'', ''DownloadFailed'', + + ''InstallStarted'', ''InstallComplete'', ''InstallFailed'', ''RebootInitiated'', + + ''Success'', ''Failure'', ''RescanStarted'', ''RescanComplete'', ''RescanFailed''' + name: current_stage + types: + - + - +- description: The download progress. + name: download_progress + types: + - +- description: The install progress. + name: install_progress + types: + - +- description: 'Total number of errors encountered during the + + refresh process.' + name: total_refresh_errors + types: + - +- description: 'Local share/remote container relative path to + + the error manifest file of the refresh.' + name: error_manifest_file + types: + - +- description: ARM ID of the share that was refreshed. + name: share_id + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.JobErrorDetails.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.JobErrorDetails.yml new file mode 100644 index 00000000..bde62baf --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.JobErrorDetails.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.JobErrorDetails +name: JobErrorDetails +fullName: azure.mgmt.edgegateway.models.JobErrorDetails +module: azure.mgmt.edgegateway.models +summary: 'The job error information containing the list of job errors. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: JobErrorDetails(**kwargs) +variables: +- description: The error details. + name: error_details + types: + - [] +- description: The code intended for programmatic access. + name: code + types: + - +- description: The message that describes the error in detail. + name: message + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.JobErrorItem.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.JobErrorItem.yml new file mode 100644 index 00000000..72eba81b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.JobErrorItem.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.JobErrorItem +name: JobErrorItem +fullName: azure.mgmt.edgegateway.models.JobErrorItem +module: azure.mgmt.edgegateway.models +summary: 'The job error items. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: JobErrorItem(**kwargs) +variables: +- description: The recommended actions. + name: recommendations + types: + - [] +- description: The code intended for programmatic access. + name: code + types: + - +- description: The message that describes the error in detail. + name: message + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.JobStatus.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.JobStatus.yml new file mode 100644 index 00000000..188089eb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.JobStatus.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.JobStatus +name: JobStatus +fullName: azure.mgmt.edgegateway.models.JobStatus +module: azure.mgmt.edgegateway.models +fields: +- name: canceled + uid: azure.mgmt.edgegateway.models.JobStatus.canceled +- name: failed + uid: azure.mgmt.edgegateway.models.JobStatus.failed +- name: invalid + uid: azure.mgmt.edgegateway.models.JobStatus.invalid +- name: paused + uid: azure.mgmt.edgegateway.models.JobStatus.paused +- name: running + uid: azure.mgmt.edgegateway.models.JobStatus.running +- name: scheduled + uid: azure.mgmt.edgegateway.models.JobStatus.scheduled +- name: succeeded + uid: azure.mgmt.edgegateway.models.JobStatus.succeeded diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.JobType.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.JobType.yml new file mode 100644 index 00000000..eb41fbc4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.JobType.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.JobType +name: JobType +fullName: azure.mgmt.edgegateway.models.JobType +module: azure.mgmt.edgegateway.models +fields: +- name: download_updates + uid: azure.mgmt.edgegateway.models.JobType.download_updates +- name: install_updates + uid: azure.mgmt.edgegateway.models.JobType.install_updates +- name: invalid + uid: azure.mgmt.edgegateway.models.JobType.invalid +- name: refresh_share + uid: azure.mgmt.edgegateway.models.JobType.refresh_share +- name: scan_for_updates + uid: azure.mgmt.edgegateway.models.JobType.scan_for_updates diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricAggregationType.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricAggregationType.yml new file mode 100644 index 00000000..42067548 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricAggregationType.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.MetricAggregationType +name: MetricAggregationType +fullName: azure.mgmt.edgegateway.models.MetricAggregationType +module: azure.mgmt.edgegateway.models +fields: +- name: average + uid: azure.mgmt.edgegateway.models.MetricAggregationType.average +- name: count + uid: azure.mgmt.edgegateway.models.MetricAggregationType.count +- name: maximum + uid: azure.mgmt.edgegateway.models.MetricAggregationType.maximum +- name: minimum + uid: azure.mgmt.edgegateway.models.MetricAggregationType.minimum +- name: none + uid: azure.mgmt.edgegateway.models.MetricAggregationType.none +- name: not_specified + uid: azure.mgmt.edgegateway.models.MetricAggregationType.not_specified +- name: total + uid: azure.mgmt.edgegateway.models.MetricAggregationType.total diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricCategory.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricCategory.yml new file mode 100644 index 00000000..5e84ca41 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricCategory.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.MetricCategory +name: MetricCategory +fullName: azure.mgmt.edgegateway.models.MetricCategory +module: azure.mgmt.edgegateway.models +fields: +- name: capacity + uid: azure.mgmt.edgegateway.models.MetricCategory.capacity +- name: transaction + uid: azure.mgmt.edgegateway.models.MetricCategory.transaction diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricDimensionV1.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricDimensionV1.yml new file mode 100644 index 00000000..1e9a1b04 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricDimensionV1.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.MetricDimensionV1 +name: MetricDimensionV1 +fullName: azure.mgmt.edgegateway.models.MetricDimensionV1 +module: azure.mgmt.edgegateway.models +summary: Metric Dimension v1. +constructor: + syntax: 'MetricDimensionV1(*, name: str = None, display_name: str = None, to_be_exported_for_shoebox: + bool = None, **kwargs)' + parameters: + - name: name + description: Name of the metrics dimension. + isRequired: true + types: + - + - name: display_name + description: Display name of the metrics dimension. + isRequired: true + types: + - + - name: to_be_exported_for_shoebox + description: To be exported to shoe box. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: display_name + isRequired: true + - name: to_be_exported_for_shoebox + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricSpecificationV1.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricSpecificationV1.yml new file mode 100644 index 00000000..dba5adbc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricSpecificationV1.yml @@ -0,0 +1,106 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.MetricSpecificationV1 +name: MetricSpecificationV1 +fullName: azure.mgmt.edgegateway.models.MetricSpecificationV1 +module: azure.mgmt.edgegateway.models +summary: Metric specification version 1. +constructor: + syntax: 'MetricSpecificationV1(*, name: str = None, display_name: str = None, display_description: + str = None, unit=None, aggregation_type=None, dimensions=None, fill_gap_with_zero: + bool = None, category=None, resource_id_dimension_name_override: str = None, supported_time_grain_types=None, + supported_aggregation_types=None, **kwargs)' + parameters: + - name: name + description: Name of the metric. + isRequired: true + types: + - + - name: display_name + description: Display name of the metric. + isRequired: true + types: + - + - name: display_description + description: Description of the metric to be displayed. + isRequired: true + types: + - + - name: unit + description: 'Metric units. Possible values include: ''NotSpecified'', + + ''Percent'', ''Count'', ''Seconds'', ''Milliseconds'', ''Bytes'', ''BytesPerSecond'', + + ''CountPerSecond''' + isRequired: true + types: + - + - + - name: aggregation_type + description: 'Metric aggregation type. Possible values include: + + ''NotSpecified'', ''None'', ''Average'', ''Minimum'', ''Maximum'', ''Total'', + ''Count''' + isRequired: true + types: + - + - + - name: dimensions + description: 'Metric dimensions, other than default dimension which + + is resource.' + isRequired: true + types: + - [] + - name: fill_gap_with_zero + description: Set true to fill the gaps with zero. + isRequired: true + types: + - + - name: category + description: 'Metric category. Possible values include: ''Capacity'', + + ''Transaction''' + isRequired: true + types: + - + - + - name: resource_id_dimension_name_override + description: Resource name override. + isRequired: true + types: + - + - name: supported_time_grain_types + description: Support granularity of metrics. + isRequired: true + types: + - [ + - ] + - name: supported_aggregation_types + description: Support metric aggregation type. + isRequired: true + types: + - [ + - ] + keywordOnlyParameters: + - name: name + isRequired: true + - name: display_name + isRequired: true + - name: display_description + isRequired: true + - name: unit + isRequired: true + - name: aggregation_type + isRequired: true + - name: dimensions + isRequired: true + - name: fill_gap_with_zero + isRequired: true + - name: category + isRequired: true + - name: resource_id_dimension_name_override + isRequired: true + - name: supported_time_grain_types + isRequired: true + - name: supported_aggregation_types + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricUnit.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricUnit.yml new file mode 100644 index 00000000..6a6fde17 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricUnit.yml @@ -0,0 +1,22 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.MetricUnit +name: MetricUnit +fullName: azure.mgmt.edgegateway.models.MetricUnit +module: azure.mgmt.edgegateway.models +fields: +- name: bytes + uid: azure.mgmt.edgegateway.models.MetricUnit.bytes +- name: bytes_per_second + uid: azure.mgmt.edgegateway.models.MetricUnit.bytes_per_second +- name: count + uid: azure.mgmt.edgegateway.models.MetricUnit.count +- name: count_per_second + uid: azure.mgmt.edgegateway.models.MetricUnit.count_per_second +- name: milliseconds + uid: azure.mgmt.edgegateway.models.MetricUnit.milliseconds +- name: not_specified + uid: azure.mgmt.edgegateway.models.MetricUnit.not_specified +- name: percent + uid: azure.mgmt.edgegateway.models.MetricUnit.percent +- name: seconds + uid: azure.mgmt.edgegateway.models.MetricUnit.seconds diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MonitoringStatus.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MonitoringStatus.yml new file mode 100644 index 00000000..56ac8d9c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MonitoringStatus.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.MonitoringStatus +name: MonitoringStatus +fullName: azure.mgmt.edgegateway.models.MonitoringStatus +module: azure.mgmt.edgegateway.models +fields: +- name: disabled + uid: azure.mgmt.edgegateway.models.MonitoringStatus.disabled +- name: enabled + uid: azure.mgmt.edgegateway.models.MonitoringStatus.enabled diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MountPointMap.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MountPointMap.yml new file mode 100644 index 00000000..e504331b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MountPointMap.yml @@ -0,0 +1,41 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.MountPointMap +name: MountPointMap +fullName: azure.mgmt.edgegateway.models.MountPointMap +module: azure.mgmt.edgegateway.models +summary: 'The share mount point. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MountPointMap(*, share_id: str, **kwargs)' + parameters: + - name: share_id + description: Required. ID of the share mounted to the role VM. + isRequired: true + types: + - + keywordOnlyParameters: + - name: share_id + isRequired: true +variables: +- description: ID of the role to which share is mounted. + name: role_id + types: + - +- description: Mount point for the share. + name: mount_point + types: + - +- description: 'Role type. Possible values include: ''IOT'', ''ASA'', + + ''Functions'', ''Cognitive''' + name: role_type + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapter.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapter.yml new file mode 100644 index 00000000..5c31c313 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapter.yml @@ -0,0 +1,91 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.NetworkAdapter +name: NetworkAdapter +fullName: azure.mgmt.edgegateway.models.NetworkAdapter +module: azure.mgmt.edgegateway.models +summary: 'Represents the networkAdapter on a device. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: NetworkAdapter(*, rdma_status=None, dhcp_status=None, **kwargs) + parameters: + - name: rdma_status + description: 'Value indicating whether this adapter is RDMA capable. + + Possible values include: ''Incapable'', ''Capable''' + isRequired: true + types: + - + - + - name: dhcp_status + description: 'Value indicating whether this adapter has DHCP + + enabled. Possible values include: ''Disabled'', ''Enabled''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: rdma_status + isRequired: true + - name: dhcp_status + isRequired: true +variables: +- description: Instance ID of network adapter. + name: adapter_id + types: + - +- description: Hardware position of network adapter. + name: adapter_position + types: + - +- description: Logical index of the adapter. + name: index + types: + - +- description: Node ID of the network adapter. + name: node_id + types: + - +- description: Network adapter name. + name: network_adapter_name + types: + - +- description: Hardware label for the adapter. + name: label + types: + - +- description: MAC address. + name: mac_address + types: + - +- description: Link speed. + name: link_speed + types: + - +- description: 'Value indicating whether this adapter is valid. Possible + + values include: ''Inactive'', ''Active''' + name: status + types: + - + - +- description: The IPv4 configuration of the network adapter. + name: ipv4_configuration + types: + - +- description: The IPv6 configuration of the network adapter. + name: ipv6_configuration + types: + - +- description: The IPv6 local address. + name: ipv6_link_local_address + types: + - +- description: The list of DNS Servers of the device. + name: dns_servers + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapterDHCPStatus.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapterDHCPStatus.yml new file mode 100644 index 00000000..f69444bb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapterDHCPStatus.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.NetworkAdapterDHCPStatus +name: NetworkAdapterDHCPStatus +fullName: azure.mgmt.edgegateway.models.NetworkAdapterDHCPStatus +module: azure.mgmt.edgegateway.models +fields: +- name: disabled + uid: azure.mgmt.edgegateway.models.NetworkAdapterDHCPStatus.disabled +- name: enabled + uid: azure.mgmt.edgegateway.models.NetworkAdapterDHCPStatus.enabled diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapterPosition.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapterPosition.yml new file mode 100644 index 00000000..e9831204 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapterPosition.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.NetworkAdapterPosition +name: NetworkAdapterPosition +fullName: azure.mgmt.edgegateway.models.NetworkAdapterPosition +module: azure.mgmt.edgegateway.models +summary: 'The network adapter position. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: NetworkAdapterPosition(**kwargs) +variables: +- description: 'The network group. Possible values include: ''None'', + + ''NonRDMA'', ''RDMA''' + name: network_group + types: + - + - +- description: The port. + name: port + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapterRDMAStatus.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapterRDMAStatus.yml new file mode 100644 index 00000000..7014fc46 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapterRDMAStatus.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.NetworkAdapterRDMAStatus +name: NetworkAdapterRDMAStatus +fullName: azure.mgmt.edgegateway.models.NetworkAdapterRDMAStatus +module: azure.mgmt.edgegateway.models +fields: +- name: capable + uid: azure.mgmt.edgegateway.models.NetworkAdapterRDMAStatus.capable +- name: incapable + uid: azure.mgmt.edgegateway.models.NetworkAdapterRDMAStatus.incapable diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapterStatus.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapterStatus.yml new file mode 100644 index 00000000..5dc4679d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapterStatus.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.NetworkAdapterStatus +name: NetworkAdapterStatus +fullName: azure.mgmt.edgegateway.models.NetworkAdapterStatus +module: azure.mgmt.edgegateway.models +fields: +- name: active + uid: azure.mgmt.edgegateway.models.NetworkAdapterStatus.active +- name: inactive + uid: azure.mgmt.edgegateway.models.NetworkAdapterStatus.inactive diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkGroup.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkGroup.yml new file mode 100644 index 00000000..0aec68f7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkGroup.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.NetworkGroup +name: NetworkGroup +fullName: azure.mgmt.edgegateway.models.NetworkGroup +module: azure.mgmt.edgegateway.models +fields: +- name: non_rdma + uid: azure.mgmt.edgegateway.models.NetworkGroup.non_rdma +- name: none + uid: azure.mgmt.edgegateway.models.NetworkGroup.none +- name: rdma + uid: azure.mgmt.edgegateway.models.NetworkGroup.rdma diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkSettings.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkSettings.yml new file mode 100644 index 00000000..7c7845d6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkSettings.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.NetworkSettings +name: NetworkSettings +fullName: azure.mgmt.edgegateway.models.NetworkSettings +module: azure.mgmt.edgegateway.models +summary: 'The network settings of a device. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: NetworkSettings(**kwargs) +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: The network adapter list on the device. + name: network_adapters + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Operation(class).yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Operation(class).yml new file mode 100644 index 00000000..4537f0ef --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Operation(class).yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.Operation +name: Operation +fullName: azure.mgmt.edgegateway.models.Operation +module: azure.mgmt.edgegateway.models +summary: Operations. +constructor: + syntax: 'Operation(*, name: str = None, display=None, origin: str = None, service_specification=None, + **kwargs)' + parameters: + - name: name + description: Name of the operation. + isRequired: true + types: + - + - name: display + description: Properties displayed for the operation. + isRequired: true + types: + - + - name: origin + description: Origin of the operation. + isRequired: true + types: + - + - name: service_specification + description: Service specification. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: display + isRequired: true + - name: origin + isRequired: true + - name: service_specification + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OperationDisplay.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OperationDisplay.yml new file mode 100644 index 00000000..4b0faf08 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OperationDisplay.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.OperationDisplay +name: OperationDisplay +fullName: azure.mgmt.edgegateway.models.OperationDisplay +module: azure.mgmt.edgegateway.models +summary: Operation display properties. +constructor: + syntax: 'OperationDisplay(*, provider: str = None, resource: str = None, operation: + str = None, description: str = None, **kwargs)' + parameters: + - name: provider + description: Provider name. + isRequired: true + types: + - + - name: resource + description: The type of resource in which the operation is performed. + isRequired: true + types: + - + - name: operation + description: Operation to be performed on the resource. + isRequired: true + types: + - + - name: description + description: Description of the operation to be performed. + isRequired: true + types: + - + keywordOnlyParameters: + - name: provider + isRequired: true + - name: resource + isRequired: true + - name: operation + isRequired: true + - name: description + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OperationPaged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OperationPaged.yml new file mode 100644 index 00000000..fc2cd7af --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OperationPaged.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.OperationPaged +name: OperationPaged +fullName: azure.mgmt.edgegateway.models.OperationPaged +module: azure.mgmt.edgegateway.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: OperationPaged(*args, **kwargs) diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Order(class).yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Order(class).yml new file mode 100644 index 00000000..f4a5f78f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Order(class).yml @@ -0,0 +1,74 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.Order +name: Order +fullName: azure.mgmt.edgegateway.models.Order +module: azure.mgmt.edgegateway.models +summary: 'The order details. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Order(*, contact_information, shipping_address, current_status=None, **kwargs) + parameters: + - name: contact_information + description: Required. The contact details. + isRequired: true + types: + - + - name: shipping_address + description: Required. The shipping address. + isRequired: true + types: + - + - name: current_status + description: Current status of the order. + isRequired: true + types: + - + keywordOnlyParameters: + - name: contact_information + isRequired: true + - name: shipping_address + isRequired: true + - name: current_status + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: List of status changes in the order. + name: order_history + types: + - [] +- description: Serial number of the device. + name: serial_number + types: + - +- description: 'Tracking information for the package + + delivered to the customer whether it has an original or a replacement + + device.' + name: delivery_tracking_info + types: + - [] +- description: 'Tracking information for the package returned + + from the customer whether it has an original or a replacement device.' + name: return_tracking_info + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OrderPaged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OrderPaged.yml new file mode 100644 index 00000000..526935fe --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OrderPaged.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.OrderPaged +name: OrderPaged +fullName: azure.mgmt.edgegateway.models.OrderPaged +module: azure.mgmt.edgegateway.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: OrderPaged(*args, **kwargs) diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OrderState.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OrderState.yml new file mode 100644 index 00000000..892f2476 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OrderState.yml @@ -0,0 +1,34 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.OrderState +name: OrderState +fullName: azure.mgmt.edgegateway.models.OrderState +module: azure.mgmt.edgegateway.models +fields: +- name: arriving + uid: azure.mgmt.edgegateway.models.OrderState.arriving +- name: awaiting_fulfilment + uid: azure.mgmt.edgegateway.models.OrderState.awaiting_fulfilment +- name: awaiting_preparation + uid: azure.mgmt.edgegateway.models.OrderState.awaiting_preparation +- name: awaiting_return_shipment + uid: azure.mgmt.edgegateway.models.OrderState.awaiting_return_shipment +- name: awaiting_shipment + uid: azure.mgmt.edgegateway.models.OrderState.awaiting_shipment +- name: collected_at_microsoft + uid: azure.mgmt.edgegateway.models.OrderState.collected_at_microsoft +- name: declined + uid: azure.mgmt.edgegateway.models.OrderState.declined +- name: delivered + uid: azure.mgmt.edgegateway.models.OrderState.delivered +- name: lost_device + uid: azure.mgmt.edgegateway.models.OrderState.lost_device +- name: replacement_requested + uid: azure.mgmt.edgegateway.models.OrderState.replacement_requested +- name: return_initiated + uid: azure.mgmt.edgegateway.models.OrderState.return_initiated +- name: shipped + uid: azure.mgmt.edgegateway.models.OrderState.shipped +- name: shipped_back + uid: azure.mgmt.edgegateway.models.OrderState.shipped_back +- name: untracked + uid: azure.mgmt.edgegateway.models.OrderState.untracked diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OrderStatus.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OrderStatus.yml new file mode 100644 index 00000000..d3be8a8a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OrderStatus.yml @@ -0,0 +1,48 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.OrderStatus +name: OrderStatus +fullName: azure.mgmt.edgegateway.models.OrderStatus +module: azure.mgmt.edgegateway.models +summary: 'Represents a single status change. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'OrderStatus(*, status, comments: str = None, **kwargs)' + parameters: + - name: status + description: 'Required. Status of the order as per the allowed status + + types. Possible values include: ''Untracked'', ''AwaitingFulfilment'', + + ''AwaitingPreparation'', ''AwaitingShipment'', ''Shipped'', ''Arriving'', + + ''Delivered'', ''ReplacementRequested'', ''LostDevice'', ''Declined'', + + ''ReturnInitiated'', ''AwaitingReturnShipment'', ''ShippedBack'', + + ''CollectedAtMicrosoft''' + isRequired: true + types: + - + - + - name: comments + description: Comments related to this status change. + isRequired: true + types: + - + keywordOnlyParameters: + - name: status + isRequired: true + - name: comments + isRequired: true +variables: +- description: Time of status update. + name: update_date_time + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.PeriodicTimerEventTrigger.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.PeriodicTimerEventTrigger.yml new file mode 100644 index 00000000..92c6d74b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.PeriodicTimerEventTrigger.yml @@ -0,0 +1,64 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.PeriodicTimerEventTrigger +name: PeriodicTimerEventTrigger +fullName: azure.mgmt.edgegateway.models.PeriodicTimerEventTrigger +module: azure.mgmt.edgegateway.models +summary: 'Trigger details. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PeriodicTimerEventTrigger(*, source_info, sink_info, custom_context_tag: + str = None, **kwargs)' + parameters: + - name: kind + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: source_info + description: Required. Periodic timer details. + isRequired: true + types: + - + - name: sink_info + description: Required. Role Sink information. + isRequired: true + types: + - + - name: custom_context_tag + description: 'A custom context tag typically used to + + correlate the trigger against its usage. For example, if a periodic timer + + trigger is intended for certain specific IoT modules in the device, the + + tag can be the name or the image URL of the module.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: source_info + isRequired: true + - name: sink_info + isRequired: true + - name: custom_context_tag + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.PeriodicTimerSourceInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.PeriodicTimerSourceInfo.yml new file mode 100644 index 00000000..763f43e6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.PeriodicTimerSourceInfo.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.PeriodicTimerSourceInfo +name: PeriodicTimerSourceInfo +fullName: azure.mgmt.edgegateway.models.PeriodicTimerSourceInfo +module: azure.mgmt.edgegateway.models +summary: 'Periodic timer event source. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PeriodicTimerSourceInfo(*, start_time, schedule: str, topic: str = None, + **kwargs)' + parameters: + - name: start_time + description: 'Required. The time of the day that results in a valid + + trigger. Schedule is computed with reference to the time specified up to + + seconds. If timezone is not specified the time will considered to be in + + device timezone. The value will always be returned as UTC time.' + isRequired: true + types: + - + - name: schedule + description: 'Required. Periodic frequency at which timer event needs + + to be raised. Supports daily, hourly, minutes, and seconds.' + isRequired: true + types: + - + - name: topic + description: Topic where periodic events are published to IoT device. + isRequired: true + types: + - + keywordOnlyParameters: + - name: start_time + isRequired: true + - name: schedule + isRequired: true + - name: topic + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.PlatformType.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.PlatformType.yml new file mode 100644 index 00000000..95e47144 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.PlatformType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.PlatformType +name: PlatformType +fullName: azure.mgmt.edgegateway.models.PlatformType +module: azure.mgmt.edgegateway.models +fields: +- name: linux + uid: azure.mgmt.edgegateway.models.PlatformType.linux +- name: windows + uid: azure.mgmt.edgegateway.models.PlatformType.windows diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RefreshDetails.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RefreshDetails.yml new file mode 100644 index 00000000..90a34f21 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RefreshDetails.yml @@ -0,0 +1,53 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.RefreshDetails +name: RefreshDetails +fullName: azure.mgmt.edgegateway.models.RefreshDetails +module: azure.mgmt.edgegateway.models +summary: Fields for tracking refresh job on the share. +constructor: + syntax: 'RefreshDetails(*, in_progress_refresh_job_id: str = None, last_completed_refresh_job_time_in_utc=None, + error_manifest_file: str = None, last_job: str = None, **kwargs)' + parameters: + - name: in_progress_refresh_job_id + description: 'If a refresh share job is currently in + + progress on this share, this field indicates the ARM resource ID of that + + job. The field is empty if no job is in progress.' + isRequired: true + types: + - + - name: last_completed_refresh_job_time_in_utc + description: 'Indicates the completed + + time for the last refresh job on this particular share, if any.This could + + be a failed job or a successful job.' + isRequired: true + types: + - + - name: error_manifest_file + description: 'Indicates the relative path of the error xml + + for the last refresh job on this particular share, if any. This could be a + + failed job or a successful job.' + isRequired: true + types: + - + - name: last_job + description: 'Indicates the id of the last refresh job on this + + particular share,if any. This could be a failed job or a successful job.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: in_progress_refresh_job_id + isRequired: true + - name: last_completed_refresh_job_time_in_utc + isRequired: true + - name: error_manifest_file + isRequired: true + - name: last_job + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Role(class).yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Role(class).yml new file mode 100644 index 00000000..82934a36 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Role(class).yml @@ -0,0 +1,40 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.Role +name: Role +fullName: azure.mgmt.edgegateway.models.Role +module: azure.mgmt.edgegateway.models +summary: 'Compute role. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: IoTRole + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Role(**kwargs) + parameters: + - name: kind + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RolePaged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RolePaged.yml new file mode 100644 index 00000000..20615fc8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RolePaged.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.RolePaged +name: RolePaged +fullName: azure.mgmt.edgegateway.models.RolePaged +module: azure.mgmt.edgegateway.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: RolePaged(*args, **kwargs) diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RoleSinkInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RoleSinkInfo.yml new file mode 100644 index 00000000..a8420a42 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RoleSinkInfo.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.RoleSinkInfo +name: RoleSinkInfo +fullName: azure.mgmt.edgegateway.models.RoleSinkInfo +module: azure.mgmt.edgegateway.models +summary: 'Compute role against which events will be raised. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RoleSinkInfo(*, role_id: str, **kwargs)' + parameters: + - name: role_id + description: Required. Compute role ID. + isRequired: true + types: + - + keywordOnlyParameters: + - name: role_id + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RoleStatus.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RoleStatus.yml new file mode 100644 index 00000000..16b2d0a4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RoleStatus.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.RoleStatus +name: RoleStatus +fullName: azure.mgmt.edgegateway.models.RoleStatus +module: azure.mgmt.edgegateway.models +fields: +- name: disabled + uid: azure.mgmt.edgegateway.models.RoleStatus.disabled +- name: enabled + uid: azure.mgmt.edgegateway.models.RoleStatus.enabled diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RoleTypes.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RoleTypes.yml new file mode 100644 index 00000000..920f6d3c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RoleTypes.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.RoleTypes +name: RoleTypes +fullName: azure.mgmt.edgegateway.models.RoleTypes +module: azure.mgmt.edgegateway.models +fields: +- name: asa + uid: azure.mgmt.edgegateway.models.RoleTypes.asa +- name: cognitive + uid: azure.mgmt.edgegateway.models.RoleTypes.cognitive +- name: functions + uid: azure.mgmt.edgegateway.models.RoleTypes.functions +- name: iot + uid: azure.mgmt.edgegateway.models.RoleTypes.iot diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SSLStatus.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SSLStatus.yml new file mode 100644 index 00000000..a1ead9c7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SSLStatus.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.SSLStatus +name: SSLStatus +fullName: azure.mgmt.edgegateway.models.SSLStatus +module: azure.mgmt.edgegateway.models +fields: +- name: disabled + uid: azure.mgmt.edgegateway.models.SSLStatus.disabled +- name: enabled + uid: azure.mgmt.edgegateway.models.SSLStatus.enabled diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SecuritySettings.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SecuritySettings.yml new file mode 100644 index 00000000..971c583f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SecuritySettings.yml @@ -0,0 +1,46 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.SecuritySettings +name: SecuritySettings +fullName: azure.mgmt.edgegateway.models.SecuritySettings +module: azure.mgmt.edgegateway.models +summary: 'The security settings of a device. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: SecuritySettings(*, device_admin_password, **kwargs) + parameters: + - name: device_admin_password + description: 'Required. Device administrator password as + + an encrypted string (encrypted using RSA PKCS #1) is used to sign into the + + local web UI of the device. The Actual password should have at least 8 + + characters that are a combination of uppercase, lowercase, numeric, and + + special characters.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: device_admin_password + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ServiceSpecification.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ServiceSpecification.yml new file mode 100644 index 00000000..ce26837e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ServiceSpecification.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.ServiceSpecification +name: ServiceSpecification +fullName: azure.mgmt.edgegateway.models.ServiceSpecification +module: azure.mgmt.edgegateway.models +summary: Service specification. +constructor: + syntax: ServiceSpecification(*, metric_specifications=None, **kwargs) + parameters: + - name: metric_specifications + description: Metric specification as defined by shoebox. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: metric_specifications + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Share(class).yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Share(class).yml new file mode 100644 index 00000000..7b5c30f4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Share(class).yml @@ -0,0 +1,116 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.Share +name: Share +fullName: azure.mgmt.edgegateway.models.Share +module: azure.mgmt.edgegateway.models +summary: 'Represents a share on the Data Box Edge/Gateway device. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Share(*, share_status, monitoring_status, access_protocol, description: + str = None, azure_container_info=None, user_access_rights=None, client_access_rights=None, + refresh_details=None, data_policy=None, **kwargs)' + parameters: + - name: description + description: Description for the share. + isRequired: true + types: + - + - name: share_status + description: 'Required. Current status of the share. Possible + + values include: ''Online'', ''Offline''' + isRequired: true + types: + - + - + - name: monitoring_status + description: 'Required. Current monitoring status of the + + share. Possible values include: ''Enabled'', ''Disabled''' + isRequired: true + types: + - + - + - name: azure_container_info + description: Azure container mapping for the share. + isRequired: true + types: + - + - name: access_protocol + description: 'Required. Access protocol to be used by the share. + + Possible values include: ''SMB'', ''NFS''' + isRequired: true + types: + - + - + - name: user_access_rights + description: 'Mapping of users and corresponding access + + rights on the share (required for SMB protocol).' + isRequired: true + types: + - [] + - name: client_access_rights + description: 'List of IP addresses and corresponding access + + rights on the share(required for NFS protocol).' + isRequired: true + types: + - [] + - name: refresh_details + description: Details of the refresh job on this share. + isRequired: true + types: + - + - name: data_policy + description: 'Data policy of the share. Possible values include: + + ''Cloud'', ''Local''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: share_status + isRequired: true + - name: monitoring_status + isRequired: true + - name: access_protocol + isRequired: true + - name: description + isRequired: true + - name: azure_container_info + isRequired: true + - name: user_access_rights + isRequired: true + - name: client_access_rights + isRequired: true + - name: refresh_details + isRequired: true + - name: data_policy + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: Share mount point to the role. + name: share_mappings + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ShareAccessProtocol.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ShareAccessProtocol.yml new file mode 100644 index 00000000..e07a7604 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ShareAccessProtocol.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.ShareAccessProtocol +name: ShareAccessProtocol +fullName: azure.mgmt.edgegateway.models.ShareAccessProtocol +module: azure.mgmt.edgegateway.models +fields: +- name: nfs + uid: azure.mgmt.edgegateway.models.ShareAccessProtocol.nfs +- name: smb + uid: azure.mgmt.edgegateway.models.ShareAccessProtocol.smb diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ShareAccessRight.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ShareAccessRight.yml new file mode 100644 index 00000000..94e62ee9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ShareAccessRight.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.ShareAccessRight +name: ShareAccessRight +fullName: azure.mgmt.edgegateway.models.ShareAccessRight +module: azure.mgmt.edgegateway.models +summary: 'Specifies the mapping between this particular user and the type of access + + he has on shares on this device. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ShareAccessRight(*, share_id: str, access_type, **kwargs)' + parameters: + - name: share_id + description: Required. The share ID. + isRequired: true + types: + - + - name: access_type + description: 'Required. Type of access to be allowed on the share + + for this user. Possible values include: ''Change'', ''Read'', ''Custom''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: share_id + isRequired: true + - name: access_type + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ShareAccessType.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ShareAccessType.yml new file mode 100644 index 00000000..3fe9de96 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ShareAccessType.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.ShareAccessType +name: ShareAccessType +fullName: azure.mgmt.edgegateway.models.ShareAccessType +module: azure.mgmt.edgegateway.models +fields: +- name: change + uid: azure.mgmt.edgegateway.models.ShareAccessType.change +- name: custom + uid: azure.mgmt.edgegateway.models.ShareAccessType.custom +- name: read + uid: azure.mgmt.edgegateway.models.ShareAccessType.read diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SharePaged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SharePaged.yml new file mode 100644 index 00000000..2d5ce56b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SharePaged.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.SharePaged +name: SharePaged +fullName: azure.mgmt.edgegateway.models.SharePaged +module: azure.mgmt.edgegateway.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: SharePaged(*args, **kwargs) diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ShareStatus.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ShareStatus.yml new file mode 100644 index 00000000..7cfb43ca --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ShareStatus.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.ShareStatus +name: ShareStatus +fullName: azure.mgmt.edgegateway.models.ShareStatus +module: azure.mgmt.edgegateway.models +fields: +- name: offline + uid: azure.mgmt.edgegateway.models.ShareStatus.offline +- name: online + uid: azure.mgmt.edgegateway.models.ShareStatus.online diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Sku(class).yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Sku(class).yml new file mode 100644 index 00000000..4a527339 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Sku(class).yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.Sku +name: Sku +fullName: azure.mgmt.edgegateway.models.Sku +module: azure.mgmt.edgegateway.models +summary: The SKU type. +constructor: + syntax: Sku(*, name=None, tier=None, **kwargs) + parameters: + - name: name + description: 'SKU name. Possible values include: ''Gateway'', ''Edge''' + isRequired: true + types: + - + - + - name: tier + description: 'The SKU tier. This is based on the SKU name. Possible values + + include: ''Standard''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: tier + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SkuName.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SkuName.yml new file mode 100644 index 00000000..131e20a4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SkuName.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.SkuName +name: SkuName +fullName: azure.mgmt.edgegateway.models.SkuName +module: azure.mgmt.edgegateway.models +fields: +- name: edge + uid: azure.mgmt.edgegateway.models.SkuName.edge +- name: gateway + uid: azure.mgmt.edgegateway.models.SkuName.gateway diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SkuTier.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SkuTier.yml new file mode 100644 index 00000000..13087820 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SkuTier.yml @@ -0,0 +1,8 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.SkuTier +name: SkuTier +fullName: azure.mgmt.edgegateway.models.SkuTier +module: azure.mgmt.edgegateway.models +fields: +- name: standard + uid: azure.mgmt.edgegateway.models.SkuTier.standard diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.StorageAccountCredential.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.StorageAccountCredential.yml new file mode 100644 index 00000000..6107f9d6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.StorageAccountCredential.yml @@ -0,0 +1,90 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.StorageAccountCredential +name: StorageAccountCredential +fullName: azure.mgmt.edgegateway.models.StorageAccountCredential +module: azure.mgmt.edgegateway.models +summary: 'The storage account credential. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'StorageAccountCredential(*, alias: str, ssl_status, account_type, user_name: + str = None, account_key=None, connection_string: str = None, blob_domain_name: + str = None, **kwargs)' + parameters: + - name: alias + description: Required. Alias for the storage account. + isRequired: true + types: + - + - name: user_name + description: Username for the storage account. + isRequired: true + types: + - + - name: account_key + description: Encrypted storage key. + isRequired: true + types: + - + - name: connection_string + description: 'Connection string for the storage account. Use + + this string if username and account key are not specified.' + isRequired: true + types: + - + - name: ssl_status + description: 'Required. Signifies whether SSL needs to be enabled or + + not. Possible values include: ''Enabled'', ''Disabled''' + isRequired: true + types: + - + - + - name: blob_domain_name + description: Blob end point for private clouds. + isRequired: true + types: + - + - name: account_type + description: 'Required. Type of storage accessed on the storage + + account. Possible values include: ''GeneralPurposeStorage'', ''BlobStorage''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: alias + isRequired: true + - name: ssl_status + isRequired: true + - name: account_type + isRequired: true + - name: user_name + isRequired: true + - name: account_key + isRequired: true + - name: connection_string + isRequired: true + - name: blob_domain_name + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.StorageAccountCredentialPaged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.StorageAccountCredentialPaged.yml new file mode 100644 index 00000000..55166bf5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.StorageAccountCredentialPaged.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.StorageAccountCredentialPaged +name: StorageAccountCredentialPaged +fullName: azure.mgmt.edgegateway.models.StorageAccountCredentialPaged +module: azure.mgmt.edgegateway.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: StorageAccountCredentialPaged(*args, **kwargs) diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SymmetricKey.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SymmetricKey.yml new file mode 100644 index 00000000..9c9faf85 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SymmetricKey.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.SymmetricKey +name: SymmetricKey +fullName: azure.mgmt.edgegateway.models.SymmetricKey +module: azure.mgmt.edgegateway.models +summary: Symmetric key for authentication. +constructor: + syntax: SymmetricKey(*, connection_string=None, **kwargs) + parameters: + - name: connection_string + description: Connection string based on the symmetric key. + isRequired: true + types: + - + keywordOnlyParameters: + - name: connection_string + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.TimeGrain.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.TimeGrain.yml new file mode 100644 index 00000000..275d907f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.TimeGrain.yml @@ -0,0 +1,22 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.TimeGrain +name: TimeGrain +fullName: azure.mgmt.edgegateway.models.TimeGrain +module: azure.mgmt.edgegateway.models +fields: +- name: pt12_h + uid: azure.mgmt.edgegateway.models.TimeGrain.pt12_h +- name: pt15_m + uid: azure.mgmt.edgegateway.models.TimeGrain.pt15_m +- name: pt1_d + uid: azure.mgmt.edgegateway.models.TimeGrain.pt1_d +- name: pt1_h + uid: azure.mgmt.edgegateway.models.TimeGrain.pt1_h +- name: pt1_m + uid: azure.mgmt.edgegateway.models.TimeGrain.pt1_m +- name: pt30_m + uid: azure.mgmt.edgegateway.models.TimeGrain.pt30_m +- name: pt5_m + uid: azure.mgmt.edgegateway.models.TimeGrain.pt5_m +- name: pt6_h + uid: azure.mgmt.edgegateway.models.TimeGrain.pt6_h diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.TrackingInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.TrackingInfo.yml new file mode 100644 index 00000000..fd5bf825 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.TrackingInfo.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.TrackingInfo +name: TrackingInfo +fullName: azure.mgmt.edgegateway.models.TrackingInfo +module: azure.mgmt.edgegateway.models +summary: Tracking courier information. +constructor: + syntax: 'TrackingInfo(*, serial_number: str = None, carrier_name: str = None, tracking_id: + str = None, tracking_url: str = None, **kwargs)' + parameters: + - name: serial_number + description: Serial number of the device being tracked. + isRequired: true + types: + - + - name: carrier_name + description: Name of the carrier used in the delivery. + isRequired: true + types: + - + - name: tracking_id + description: Tracking ID of the shipment. + isRequired: true + types: + - + - name: tracking_url + description: Tracking URL of the shipment. + isRequired: true + types: + - + keywordOnlyParameters: + - name: serial_number + isRequired: true + - name: carrier_name + isRequired: true + - name: tracking_id + isRequired: true + - name: tracking_url + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Trigger(class).yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Trigger(class).yml new file mode 100644 index 00000000..d0c4f2e3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Trigger(class).yml @@ -0,0 +1,40 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.Trigger +name: Trigger +fullName: azure.mgmt.edgegateway.models.Trigger +module: azure.mgmt.edgegateway.models +summary: 'Trigger details. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: FileEventTrigger, PeriodicTimerEventTrigger + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Trigger(**kwargs) + parameters: + - name: kind + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.TriggerPaged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.TriggerPaged.yml new file mode 100644 index 00000000..86c54d25 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.TriggerPaged.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.TriggerPaged +name: TriggerPaged +fullName: azure.mgmt.edgegateway.models.TriggerPaged +module: azure.mgmt.edgegateway.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: TriggerPaged(*args, **kwargs) diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateDownloadProgress.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateDownloadProgress.yml new file mode 100644 index 00000000..30e95a05 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateDownloadProgress.yml @@ -0,0 +1,41 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.UpdateDownloadProgress +name: UpdateDownloadProgress +fullName: azure.mgmt.edgegateway.models.UpdateDownloadProgress +module: azure.mgmt.edgegateway.models +summary: 'Details about the download progress of update. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: UpdateDownloadProgress(**kwargs) +variables: +- description: 'The download phase. Possible values include: + + ''Unknown'', ''Initializing'', ''Downloading'', ''Verifying''' + name: download_phase + types: + - + - +- description: Percentage of completion. + name: percent_complete + types: + - +- description: Total bytes to download. + name: total_bytes_to_download + types: + - +- description: Total bytes downloaded. + name: total_bytes_downloaded + types: + - +- description: Number of updates to download. + name: number_of_updates_to_download + types: + - +- description: Number of updates downloaded. + name: number_of_updates_downloaded + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateInstallProgress.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateInstallProgress.yml new file mode 100644 index 00000000..0cc96766 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateInstallProgress.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.UpdateInstallProgress +name: UpdateInstallProgress +fullName: azure.mgmt.edgegateway.models.UpdateInstallProgress +module: azure.mgmt.edgegateway.models +summary: 'Progress details during installation of updates. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: UpdateInstallProgress(**kwargs) +variables: +- description: Percentage completed. + name: percent_complete + types: + - +- description: Number of updates to install. + name: number_of_updates_to_install + types: + - +- description: Number of updates installed. + name: number_of_updates_installed + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateOperation.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateOperation.yml new file mode 100644 index 00000000..ce6fc614 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateOperation.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.UpdateOperation +name: UpdateOperation +fullName: azure.mgmt.edgegateway.models.UpdateOperation +module: azure.mgmt.edgegateway.models +fields: +- name: download + uid: azure.mgmt.edgegateway.models.UpdateOperation.download +- name: install + uid: azure.mgmt.edgegateway.models.UpdateOperation.install +- name: none + uid: azure.mgmt.edgegateway.models.UpdateOperation.none +- name: scan + uid: azure.mgmt.edgegateway.models.UpdateOperation.scan diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateOperationStage.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateOperationStage.yml new file mode 100644 index 00000000..9bfc8358 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateOperationStage.yml @@ -0,0 +1,40 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.UpdateOperationStage +name: UpdateOperationStage +fullName: azure.mgmt.edgegateway.models.UpdateOperationStage +module: azure.mgmt.edgegateway.models +fields: +- name: download_complete + uid: azure.mgmt.edgegateway.models.UpdateOperationStage.download_complete +- name: download_failed + uid: azure.mgmt.edgegateway.models.UpdateOperationStage.download_failed +- name: download_started + uid: azure.mgmt.edgegateway.models.UpdateOperationStage.download_started +- name: failure + uid: azure.mgmt.edgegateway.models.UpdateOperationStage.failure +- name: initial + uid: azure.mgmt.edgegateway.models.UpdateOperationStage.initial +- name: install_complete + uid: azure.mgmt.edgegateway.models.UpdateOperationStage.install_complete +- name: install_failed + uid: azure.mgmt.edgegateway.models.UpdateOperationStage.install_failed +- name: install_started + uid: azure.mgmt.edgegateway.models.UpdateOperationStage.install_started +- name: reboot_initiated + uid: azure.mgmt.edgegateway.models.UpdateOperationStage.reboot_initiated +- name: rescan_complete + uid: azure.mgmt.edgegateway.models.UpdateOperationStage.rescan_complete +- name: rescan_failed + uid: azure.mgmt.edgegateway.models.UpdateOperationStage.rescan_failed +- name: rescan_started + uid: azure.mgmt.edgegateway.models.UpdateOperationStage.rescan_started +- name: scan_complete + uid: azure.mgmt.edgegateway.models.UpdateOperationStage.scan_complete +- name: scan_failed + uid: azure.mgmt.edgegateway.models.UpdateOperationStage.scan_failed +- name: scan_started + uid: azure.mgmt.edgegateway.models.UpdateOperationStage.scan_started +- name: success + uid: azure.mgmt.edgegateway.models.UpdateOperationStage.success +- name: unknown + uid: azure.mgmt.edgegateway.models.UpdateOperationStage.unknown diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateSummary.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateSummary.yml new file mode 100644 index 00000000..491b919c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateSummary.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.UpdateSummary +name: UpdateSummary +fullName: azure.mgmt.edgegateway.models.UpdateSummary +module: azure.mgmt.edgegateway.models +summary: 'Details about ongoing updates and availability of updates on the device. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'UpdateSummary(*, device_version_number: str = None, friendly_device_version_name: + str = None, device_last_scanned_date_time=None, last_completed_scan_job_date_time=None, + **kwargs)' + parameters: + - name: device_version_number + description: 'The current version of the device in format: + + 1.2.17312.13.",' + isRequired: true + types: + - + - name: friendly_device_version_name + description: 'The current version of the device in + + text format.' + isRequired: true + types: + - + - name: device_last_scanned_date_time + description: 'The last time when a scan was done + + on the device.' + isRequired: true + types: + - + - name: last_completed_scan_job_date_time + description: 'The time when the last scan job + + was completed (success/cancelled/failed) on the appliance.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: device_version_number + isRequired: true + - name: friendly_device_version_name + isRequired: true + - name: device_last_scanned_date_time + isRequired: true + - name: last_completed_scan_job_date_time + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: 'The time when the last + + Download job was completed (success/cancelled/failed) on the appliance.' + name: last_completed_download_job_date_time + types: + - +- description: 'The time when the last Install + + job was completed (success/cancelled/failed) on the appliance.' + name: last_completed_install_job_date_time + types: + - +- description: 'The number of updates available + + for the current device version as per the last device scan.' + name: total_number_of_updates_available + types: + - +- description: 'The total number of items + + pending download.' + name: total_number_of_updates_pending_download + types: + - +- description: 'The total number of items + + pending install.' + name: total_number_of_updates_pending_install + types: + - +- description: 'Indicates if updates are available and at least one + + of the updates needs a reboot. Possible values include: ''NeverReboots'', + + ''RequiresReboot'', ''RequestReboot''' + name: reboot_behavior + types: + - + - +- description: 'The current update operation. Possible + + values include: ''None'', ''Scan'', ''Download'', ''Install''' + name: ongoing_update_operation + types: + - + - +- description: 'The job ID of the download job in + + progress.' + name: in_progress_download_job_id + types: + - +- description: 'The job ID of the install job in + + progress.' + name: in_progress_install_job_id + types: + - +- description: 'The time when the + + currently running download (if any) started.' + name: in_progress_download_job_started_date_time + types: + - +- description: 'The time when the + + currently running install (if any) started.' + name: in_progress_install_job_started_date_time + types: + - +- description: The list of updates available for install. + name: update_titles + types: + - [] +- description: 'The total size of updates available for + + download in bytes.' + name: total_update_size_in_bytes + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UploadCertificateRequest.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UploadCertificateRequest.yml new file mode 100644 index 00000000..976b36ef --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UploadCertificateRequest.yml @@ -0,0 +1,31 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.UploadCertificateRequest +name: UploadCertificateRequest +fullName: azure.mgmt.edgegateway.models.UploadCertificateRequest +module: azure.mgmt.edgegateway.models +summary: 'The upload certificate request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'UploadCertificateRequest(*, certificate: str, authentication_type=None, + **kwargs)' + parameters: + - name: authentication_type + description: 'The authentication type. Possible values + + include: ''Invalid'', ''AzureActiveDirectory''' + isRequired: true + types: + - + - + - name: certificate + description: Required. The base64 encoded certificate raw data. + isRequired: true + types: + - + keywordOnlyParameters: + - name: certificate + isRequired: true + - name: authentication_type + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UploadCertificateResponse.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UploadCertificateResponse.yml new file mode 100644 index 00000000..ab7f10d5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UploadCertificateResponse.yml @@ -0,0 +1,75 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.UploadCertificateResponse +name: UploadCertificateResponse +fullName: azure.mgmt.edgegateway.models.UploadCertificateResponse +module: azure.mgmt.edgegateway.models +summary: 'The upload registration certificate response. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'UploadCertificateResponse(*, resource_id: str, aad_authority: str, aad_tenant_id: + str, service_principal_client_id: str, service_principal_object_id: str, azure_management_endpoint_audience: + str, auth_type=None, **kwargs)' + parameters: + - name: auth_type + description: 'Specifies authentication type. Possible values include: + + ''Invalid'', ''AzureActiveDirectory''' + isRequired: true + types: + - + - + - name: resource_id + description: 'Required. The resource ID of the Data Box Edge/Gateway + + device.' + isRequired: true + types: + - + - name: aad_authority + description: Required. Azure Active Directory tenant authority. + isRequired: true + types: + - + - name: aad_tenant_id + description: Required. Azure Active Directory tenant ID. + isRequired: true + types: + - + - name: service_principal_client_id + description: 'Required. Azure Active Directory + + service principal client ID.' + isRequired: true + types: + - + - name: service_principal_object_id + description: 'Required. Azure Active Directory + + service principal object ID.' + isRequired: true + types: + - + - name: azure_management_endpoint_audience + description: 'Required. The azure management + + endpoint audience.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: resource_id + isRequired: true + - name: aad_authority + isRequired: true + - name: aad_tenant_id + isRequired: true + - name: service_principal_client_id + isRequired: true + - name: service_principal_object_id + isRequired: true + - name: azure_management_endpoint_audience + isRequired: true + - name: auth_type + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.User(class).yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.User(class).yml new file mode 100644 index 00000000..dab24907 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.User(class).yml @@ -0,0 +1,46 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.User +name: User +fullName: azure.mgmt.edgegateway.models.User +module: azure.mgmt.edgegateway.models +summary: 'Represents a user who has access to one or more shares on the Data Box + + Edge/Gateway device. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: User(*, encrypted_password=None, share_access_rights=None, **kwargs) + parameters: + - name: encrypted_password + description: The password details. + isRequired: true + types: + - + - name: share_access_rights + description: 'List of shares that the user has rights on. + + This field should not be specified during user creation.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: encrypted_password + isRequired: true + - name: share_access_rights + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UserAccessRight.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UserAccessRight.yml new file mode 100644 index 00000000..95e222c1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UserAccessRight.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.UserAccessRight +name: UserAccessRight +fullName: azure.mgmt.edgegateway.models.UserAccessRight +module: azure.mgmt.edgegateway.models +summary: 'The mapping between a particular user and the access type on the SMB share. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'UserAccessRight(*, user_id: str, access_type, **kwargs)' + parameters: + - name: user_id + description: Required. User ID (already existing in the device). + isRequired: true + types: + - + - name: access_type + description: 'Required. Type of access to be allowed for the user. + + Possible values include: ''Change'', ''Read'', ''Custom''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: user_id + isRequired: true + - name: access_type + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UserPaged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UserPaged.yml new file mode 100644 index 00000000..adbc6ed4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UserPaged.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.UserPaged +name: UserPaged +fullName: azure.mgmt.edgegateway.models.UserPaged +module: azure.mgmt.edgegateway.models +summary: A paging container for iterating over a list of + object +constructor: + syntax: UserPaged(*args, **kwargs) diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.address.Address.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.address.Address.yml new file mode 100644 index 00000000..05f7abd5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.address.Address.yml @@ -0,0 +1,47 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.address.Address +name: Address +fullName: azure.mgmt.edgegateway.models.address.Address +module: azure.mgmt.edgegateway.models.address +summary: 'The shipping address of the customer. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Address(**kwargs) + parameters: + - name: address_line1 + description: Required. The address line1. + isRequired: true + types: + - + - name: address_line2 + description: The address line2. + isRequired: true + types: + - + - name: address_line3 + description: The address line3. + isRequired: true + types: + - + - name: postal_code + description: Required. The postal code. + isRequired: true + types: + - + - name: city + description: Required. The city name. + isRequired: true + types: + - + - name: state + description: Required. The state name. + isRequired: true + types: + - + - name: country + description: Required. The country name. + isRequired: true + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.address.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.address.yml new file mode 100644 index 00000000..b3130a43 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.address.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.address +name: address +fullName: azure.mgmt.edgegateway.models.address +classes: +- azure.mgmt.edgegateway.models.address.Address diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.address_py3.Address.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.address_py3.Address.yml new file mode 100644 index 00000000..074f0485 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.address_py3.Address.yml @@ -0,0 +1,63 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.address_py3.Address +name: Address +fullName: azure.mgmt.edgegateway.models.address_py3.Address +module: azure.mgmt.edgegateway.models.address_py3 +summary: 'The shipping address of the customer. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Address(*, address_line1: str, postal_code: str, city: str, state: str, + country: str, address_line2: str = None, address_line3: str = None, **kwargs)' + parameters: + - name: address_line1 + description: Required. The address line1. + isRequired: true + types: + - + - name: address_line2 + description: The address line2. + isRequired: true + types: + - + - name: address_line3 + description: The address line3. + isRequired: true + types: + - + - name: postal_code + description: Required. The postal code. + isRequired: true + types: + - + - name: city + description: Required. The city name. + isRequired: true + types: + - + - name: state + description: Required. The state name. + isRequired: true + types: + - + - name: country + description: Required. The country name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: address_line1 + isRequired: true + - name: postal_code + isRequired: true + - name: city + isRequired: true + - name: state + isRequired: true + - name: country + isRequired: true + - name: address_line2 + isRequired: true + - name: address_line3 + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.address_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.address_py3.yml new file mode 100644 index 00000000..ab43f748 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.address_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.address_py3 +name: address_py3 +fullName: azure.mgmt.edgegateway.models.address_py3 +classes: +- azure.mgmt.edgegateway.models.address_py3.Address diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert.Alert.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert.Alert.yml new file mode 100644 index 00000000..5a210c8a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert.Alert.yml @@ -0,0 +1,57 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.alert.Alert +name: Alert +fullName: azure.mgmt.edgegateway.models.alert.Alert +module: azure.mgmt.edgegateway.models.alert +summary: 'Alert on the data box edge/gateway device. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Alert(**kwargs) +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: Alert title. + name: title + types: + - +- description: Alert type. + name: alert_type + types: + - +- description: UTC time when the alert appeared. + name: appeared_at_date_time + types: + - +- description: Alert recommendation. + name: recommendation + types: + - +- description: 'Severity of the alert. Possible values include: + + ''Informational'', ''Warning'', ''Critical''' + name: severity + types: + - + - +- description: Error details of the alert. + name: error_details + types: + - +- description: Alert details. + name: detailed_information + types: + - [, ] diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert.yml new file mode 100644 index 00000000..fd80f224 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.alert +name: alert +fullName: azure.mgmt.edgegateway.models.alert +classes: +- azure.mgmt.edgegateway.models.alert.Alert diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_error_details.AlertErrorDetails.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_error_details.AlertErrorDetails.yml new file mode 100644 index 00000000..c42962dd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_error_details.AlertErrorDetails.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.alert_error_details.AlertErrorDetails +name: AlertErrorDetails +fullName: azure.mgmt.edgegateway.models.alert_error_details.AlertErrorDetails +module: azure.mgmt.edgegateway.models.alert_error_details +summary: 'Error details for the alert. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: AlertErrorDetails(**kwargs) +variables: +- description: Error code. + name: error_code + types: + - +- description: Error Message. + name: error_message + types: + - +- description: Number of occurrences. + name: occurrences + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_error_details.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_error_details.yml new file mode 100644 index 00000000..38c5d991 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_error_details.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.alert_error_details +name: alert_error_details +fullName: azure.mgmt.edgegateway.models.alert_error_details +classes: +- azure.mgmt.edgegateway.models.alert_error_details.AlertErrorDetails diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_error_details_py3.AlertErrorDetails.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_error_details_py3.AlertErrorDetails.yml new file mode 100644 index 00000000..2f2b49d2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_error_details_py3.AlertErrorDetails.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.alert_error_details_py3.AlertErrorDetails +name: AlertErrorDetails +fullName: azure.mgmt.edgegateway.models.alert_error_details_py3.AlertErrorDetails +module: azure.mgmt.edgegateway.models.alert_error_details_py3 +summary: 'Error details for the alert. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: AlertErrorDetails(**kwargs) +variables: +- description: Error code. + name: error_code + types: + - +- description: Error Message. + name: error_message + types: + - +- description: Number of occurrences. + name: occurrences + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_error_details_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_error_details_py3.yml new file mode 100644 index 00000000..d487ad91 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_error_details_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.alert_error_details_py3 +name: alert_error_details_py3 +fullName: azure.mgmt.edgegateway.models.alert_error_details_py3 +classes: +- azure.mgmt.edgegateway.models.alert_error_details_py3.AlertErrorDetails diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_paged.AlertPaged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_paged.AlertPaged.yml new file mode 100644 index 00000000..cb19d42b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_paged.AlertPaged.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.alert_paged.AlertPaged +name: AlertPaged +fullName: azure.mgmt.edgegateway.models.alert_paged.AlertPaged +module: azure.mgmt.edgegateway.models.alert_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: AlertPaged(*args, **kwargs) diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_paged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_paged.yml new file mode 100644 index 00000000..43ca1975 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.alert_paged +name: alert_paged +fullName: azure.mgmt.edgegateway.models.alert_paged +classes: +- azure.mgmt.edgegateway.models.alert_paged.AlertPaged diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_py3.Alert.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_py3.Alert.yml new file mode 100644 index 00000000..fa71bdb3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_py3.Alert.yml @@ -0,0 +1,57 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.alert_py3.Alert +name: Alert +fullName: azure.mgmt.edgegateway.models.alert_py3.Alert +module: azure.mgmt.edgegateway.models.alert_py3 +summary: 'Alert on the data box edge/gateway device. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Alert(**kwargs) +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: Alert title. + name: title + types: + - +- description: Alert type. + name: alert_type + types: + - +- description: UTC time when the alert appeared. + name: appeared_at_date_time + types: + - +- description: Alert recommendation. + name: recommendation + types: + - +- description: 'Severity of the alert. Possible values include: + + ''Informational'', ''Warning'', ''Critical''' + name: severity + types: + - + - +- description: Error details of the alert. + name: error_details + types: + - +- description: Alert details. + name: detailed_information + types: + - [, ] diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_py3.yml new file mode 100644 index 00000000..446da6e3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.alert_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.alert_py3 +name: alert_py3 +fullName: azure.mgmt.edgegateway.models.alert_py3 +classes: +- azure.mgmt.edgegateway.models.alert_py3.Alert diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.arm_base_model.ARMBaseModel.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.arm_base_model.ARMBaseModel.yml new file mode 100644 index 00000000..b1944987 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.arm_base_model.ARMBaseModel.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.arm_base_model.ARMBaseModel +name: ARMBaseModel +fullName: azure.mgmt.edgegateway.models.arm_base_model.ARMBaseModel +module: azure.mgmt.edgegateway.models.arm_base_model +summary: 'Represents the base class for all object models. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: ARMBaseModel(**kwargs) +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.arm_base_model.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.arm_base_model.yml new file mode 100644 index 00000000..f3cfa49c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.arm_base_model.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.arm_base_model +name: arm_base_model +fullName: azure.mgmt.edgegateway.models.arm_base_model +classes: +- azure.mgmt.edgegateway.models.arm_base_model.ARMBaseModel diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.arm_base_model_py3.ARMBaseModel.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.arm_base_model_py3.ARMBaseModel.yml new file mode 100644 index 00000000..0a8c426a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.arm_base_model_py3.ARMBaseModel.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.arm_base_model_py3.ARMBaseModel +name: ARMBaseModel +fullName: azure.mgmt.edgegateway.models.arm_base_model_py3.ARMBaseModel +module: azure.mgmt.edgegateway.models.arm_base_model_py3 +summary: 'Represents the base class for all object models. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: ARMBaseModel(**kwargs) +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.arm_base_model_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.arm_base_model_py3.yml new file mode 100644 index 00000000..aeb2d96a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.arm_base_model_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.arm_base_model_py3 +name: arm_base_model_py3 +fullName: azure.mgmt.edgegateway.models.arm_base_model_py3 +classes: +- azure.mgmt.edgegateway.models.arm_base_model_py3.ARMBaseModel diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.asymmetric_encrypted_secret.AsymmetricEncryptedSecret.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.asymmetric_encrypted_secret.AsymmetricEncryptedSecret.yml new file mode 100644 index 00000000..b1bfea26 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.asymmetric_encrypted_secret.AsymmetricEncryptedSecret.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.asymmetric_encrypted_secret.AsymmetricEncryptedSecret +name: AsymmetricEncryptedSecret +fullName: azure.mgmt.edgegateway.models.asymmetric_encrypted_secret.AsymmetricEncryptedSecret +module: azure.mgmt.edgegateway.models.asymmetric_encrypted_secret +summary: 'Represent the secrets intended for encryption with asymmetric key pair. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: AsymmetricEncryptedSecret(**kwargs) + parameters: + - name: value + description: Required. The value of the secret. + isRequired: true + types: + - + - name: encryption_cert_thumbprint + description: 'Thumbprint certificate used to encrypt + + "Value". If the value is unencrypted, it will be null.' + isRequired: true + types: + - + - name: encryption_algorithm + description: 'Required. The algorithm used to encrypt + + "Value". Possible values include: ''None'', ''AES256'', ''RSAES_PKCS1_v_1_5''' + isRequired: true + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.asymmetric_encrypted_secret.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.asymmetric_encrypted_secret.yml new file mode 100644 index 00000000..5cecf7db --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.asymmetric_encrypted_secret.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.asymmetric_encrypted_secret +name: asymmetric_encrypted_secret +fullName: azure.mgmt.edgegateway.models.asymmetric_encrypted_secret +classes: +- azure.mgmt.edgegateway.models.asymmetric_encrypted_secret.AsymmetricEncryptedSecret diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.asymmetric_encrypted_secret_py3.AsymmetricEncryptedSecret.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.asymmetric_encrypted_secret_py3.AsymmetricEncryptedSecret.yml new file mode 100644 index 00000000..ca6e149e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.asymmetric_encrypted_secret_py3.AsymmetricEncryptedSecret.yml @@ -0,0 +1,40 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.asymmetric_encrypted_secret_py3.AsymmetricEncryptedSecret +name: AsymmetricEncryptedSecret +fullName: azure.mgmt.edgegateway.models.asymmetric_encrypted_secret_py3.AsymmetricEncryptedSecret +module: azure.mgmt.edgegateway.models.asymmetric_encrypted_secret_py3 +summary: 'Represent the secrets intended for encryption with asymmetric key pair. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AsymmetricEncryptedSecret(*, value: str, encryption_algorithm, encryption_cert_thumbprint: + str = None, **kwargs)' + parameters: + - name: value + description: Required. The value of the secret. + isRequired: true + types: + - + - name: encryption_cert_thumbprint + description: 'Thumbprint certificate used to encrypt + + "Value". If the value is unencrypted, it will be null.' + isRequired: true + types: + - + - name: encryption_algorithm + description: 'Required. The algorithm used to encrypt + + "Value". Possible values include: ''None'', ''AES256'', ''RSAES_PKCS1_v_1_5''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: encryption_algorithm + isRequired: true + - name: encryption_cert_thumbprint + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.asymmetric_encrypted_secret_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.asymmetric_encrypted_secret_py3.yml new file mode 100644 index 00000000..2db9d7a6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.asymmetric_encrypted_secret_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.asymmetric_encrypted_secret_py3 +name: asymmetric_encrypted_secret_py3 +fullName: azure.mgmt.edgegateway.models.asymmetric_encrypted_secret_py3 +classes: +- azure.mgmt.edgegateway.models.asymmetric_encrypted_secret_py3.AsymmetricEncryptedSecret diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.authentication.Authentication.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.authentication.Authentication.yml new file mode 100644 index 00000000..2bfb2d41 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.authentication.Authentication.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.authentication.Authentication +name: Authentication +fullName: azure.mgmt.edgegateway.models.authentication.Authentication +module: azure.mgmt.edgegateway.models.authentication +summary: Authentication mechanism for IoT devices. +constructor: + syntax: Authentication(**kwargs) + parameters: + - name: symmetric_key + description: Symmetric key for authentication. + isRequired: true + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.authentication.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.authentication.yml new file mode 100644 index 00000000..4e3b8395 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.authentication.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.authentication +name: authentication +fullName: azure.mgmt.edgegateway.models.authentication +classes: +- azure.mgmt.edgegateway.models.authentication.Authentication diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.authentication_py3.Authentication.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.authentication_py3.Authentication.yml new file mode 100644 index 00000000..19ec8b90 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.authentication_py3.Authentication.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.authentication_py3.Authentication +name: Authentication +fullName: azure.mgmt.edgegateway.models.authentication_py3.Authentication +module: azure.mgmt.edgegateway.models.authentication_py3 +summary: Authentication mechanism for IoT devices. +constructor: + syntax: Authentication(*, symmetric_key=None, **kwargs) + parameters: + - name: symmetric_key + description: Symmetric key for authentication. + isRequired: true + types: + - + keywordOnlyParameters: + - name: symmetric_key + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.authentication_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.authentication_py3.yml new file mode 100644 index 00000000..e5bf66fd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.authentication_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.authentication_py3 +name: authentication_py3 +fullName: azure.mgmt.edgegateway.models.authentication_py3 +classes: +- azure.mgmt.edgegateway.models.authentication_py3.Authentication diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.azure_container_info.AzureContainerInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.azure_container_info.AzureContainerInfo.yml new file mode 100644 index 00000000..18b3aa21 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.azure_container_info.AzureContainerInfo.yml @@ -0,0 +1,36 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.azure_container_info.AzureContainerInfo +name: AzureContainerInfo +fullName: azure.mgmt.edgegateway.models.azure_container_info.AzureContainerInfo +module: azure.mgmt.edgegateway.models.azure_container_info +summary: 'Azure container mapping of the endpoint. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: AzureContainerInfo(**kwargs) + parameters: + - name: storage_account_credential_id + description: 'Required. ID of the storage account + + credential used to access storage.' + isRequired: true + types: + - + - name: container_name + description: 'Required. Container name (Based on the data format + + specified, this represents the name of Azure Files/Page blob/Block blob).' + isRequired: true + types: + - + - name: data_format + description: 'Required. Storage format used for the file represented + + by the share. Possible values include: ''BlockBlob'', ''PageBlob'', + + ''AzureFile''' + isRequired: true + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.azure_container_info.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.azure_container_info.yml new file mode 100644 index 00000000..43c75efc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.azure_container_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.azure_container_info +name: azure_container_info +fullName: azure.mgmt.edgegateway.models.azure_container_info +classes: +- azure.mgmt.edgegateway.models.azure_container_info.AzureContainerInfo diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.azure_container_info_py3.AzureContainerInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.azure_container_info_py3.AzureContainerInfo.yml new file mode 100644 index 00000000..00d10a2d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.azure_container_info_py3.AzureContainerInfo.yml @@ -0,0 +1,44 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.azure_container_info_py3.AzureContainerInfo +name: AzureContainerInfo +fullName: azure.mgmt.edgegateway.models.azure_container_info_py3.AzureContainerInfo +module: azure.mgmt.edgegateway.models.azure_container_info_py3 +summary: 'Azure container mapping of the endpoint. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureContainerInfo(*, storage_account_credential_id: str, container_name: + str, data_format, **kwargs)' + parameters: + - name: storage_account_credential_id + description: 'Required. ID of the storage account + + credential used to access storage.' + isRequired: true + types: + - + - name: container_name + description: 'Required. Container name (Based on the data format + + specified, this represents the name of Azure Files/Page blob/Block blob).' + isRequired: true + types: + - + - name: data_format + description: 'Required. Storage format used for the file represented + + by the share. Possible values include: ''BlockBlob'', ''PageBlob'', + + ''AzureFile''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: storage_account_credential_id + isRequired: true + - name: container_name + isRequired: true + - name: data_format + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.azure_container_info_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.azure_container_info_py3.yml new file mode 100644 index 00000000..74e3e618 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.azure_container_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.azure_container_info_py3 +name: azure_container_info_py3 +fullName: azure.mgmt.edgegateway.models.azure_container_info_py3 +classes: +- azure.mgmt.edgegateway.models.azure_container_info_py3.AzureContainerInfo diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule.BandwidthSchedule.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule.BandwidthSchedule.yml new file mode 100644 index 00000000..3df77531 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule.BandwidthSchedule.yml @@ -0,0 +1,53 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.bandwidth_schedule.BandwidthSchedule +name: BandwidthSchedule +fullName: azure.mgmt.edgegateway.models.bandwidth_schedule.BandwidthSchedule +module: azure.mgmt.edgegateway.models.bandwidth_schedule +summary: 'The bandwidth schedule details. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: BandwidthSchedule(**kwargs) + parameters: + - name: start + description: Required. The start time of the schedule in UTC. + isRequired: true + types: + - + - name: stop + description: Required. The stop time of the schedule in UTC. + isRequired: true + types: + - + - name: rate_in_mbps + description: Required. The bandwidth rate in Mbps. + isRequired: true + types: + - + - name: days + description: 'Required. The days of the week when this schedule is + + applicable.' + isRequired: true + types: + - [ + - ] +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule.yml new file mode 100644 index 00000000..a846209e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.bandwidth_schedule +name: bandwidth_schedule +fullName: azure.mgmt.edgegateway.models.bandwidth_schedule +classes: +- azure.mgmt.edgegateway.models.bandwidth_schedule.BandwidthSchedule diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule_paged.BandwidthSchedulePaged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule_paged.BandwidthSchedulePaged.yml new file mode 100644 index 00000000..5374a499 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule_paged.BandwidthSchedulePaged.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.bandwidth_schedule_paged.BandwidthSchedulePaged +name: BandwidthSchedulePaged +fullName: azure.mgmt.edgegateway.models.bandwidth_schedule_paged.BandwidthSchedulePaged +module: azure.mgmt.edgegateway.models.bandwidth_schedule_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: BandwidthSchedulePaged(*args, **kwargs) diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule_paged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule_paged.yml new file mode 100644 index 00000000..0cd6dbc2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.bandwidth_schedule_paged +name: bandwidth_schedule_paged +fullName: azure.mgmt.edgegateway.models.bandwidth_schedule_paged +classes: +- azure.mgmt.edgegateway.models.bandwidth_schedule_paged.BandwidthSchedulePaged diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule_py3.BandwidthSchedule.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule_py3.BandwidthSchedule.yml new file mode 100644 index 00000000..6fc0da87 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule_py3.BandwidthSchedule.yml @@ -0,0 +1,62 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.bandwidth_schedule_py3.BandwidthSchedule +name: BandwidthSchedule +fullName: azure.mgmt.edgegateway.models.bandwidth_schedule_py3.BandwidthSchedule +module: azure.mgmt.edgegateway.models.bandwidth_schedule_py3 +summary: 'The bandwidth schedule details. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'BandwidthSchedule(*, start: str, stop: str, rate_in_mbps: int, days, **kwargs)' + parameters: + - name: start + description: Required. The start time of the schedule in UTC. + isRequired: true + types: + - + - name: stop + description: Required. The stop time of the schedule in UTC. + isRequired: true + types: + - + - name: rate_in_mbps + description: Required. The bandwidth rate in Mbps. + isRequired: true + types: + - + - name: days + description: 'Required. The days of the week when this schedule is + + applicable.' + isRequired: true + types: + - [ + - ] + keywordOnlyParameters: + - name: start + isRequired: true + - name: stop + isRequired: true + - name: rate_in_mbps + isRequired: true + - name: days + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule_py3.yml new file mode 100644 index 00000000..d55cd03f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.bandwidth_schedule_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.bandwidth_schedule_py3 +name: bandwidth_schedule_py3 +fullName: azure.mgmt.edgegateway.models.bandwidth_schedule_py3 +classes: +- azure.mgmt.edgegateway.models.bandwidth_schedule_py3.BandwidthSchedule diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.client_access_right.ClientAccessRight.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.client_access_right.ClientAccessRight.yml new file mode 100644 index 00000000..f4771585 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.client_access_right.ClientAccessRight.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.client_access_right.ClientAccessRight +name: ClientAccessRight +fullName: azure.mgmt.edgegateway.models.client_access_right.ClientAccessRight +module: azure.mgmt.edgegateway.models.client_access_right +summary: 'The mapping between a particular client IP and the type of access client + + has on the NFS share. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ClientAccessRight(**kwargs) + parameters: + - name: client + description: Required. IP of the client. + isRequired: true + types: + - + - name: access_permission + description: 'Required. Type of access to be allowed for the + + client. Possible values include: ''NoAccess'', ''ReadOnly'', ''ReadWrite''' + isRequired: true + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.client_access_right.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.client_access_right.yml new file mode 100644 index 00000000..ed6e231b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.client_access_right.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.client_access_right +name: client_access_right +fullName: azure.mgmt.edgegateway.models.client_access_right +classes: +- azure.mgmt.edgegateway.models.client_access_right.ClientAccessRight diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.client_access_right_py3.ClientAccessRight.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.client_access_right_py3.ClientAccessRight.yml new file mode 100644 index 00000000..2933d688 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.client_access_right_py3.ClientAccessRight.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.client_access_right_py3.ClientAccessRight +name: ClientAccessRight +fullName: azure.mgmt.edgegateway.models.client_access_right_py3.ClientAccessRight +module: azure.mgmt.edgegateway.models.client_access_right_py3 +summary: 'The mapping between a particular client IP and the type of access client + + has on the NFS share. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ClientAccessRight(*, client: str, access_permission, **kwargs)' + parameters: + - name: client + description: Required. IP of the client. + isRequired: true + types: + - + - name: access_permission + description: 'Required. Type of access to be allowed for the + + client. Possible values include: ''NoAccess'', ''ReadOnly'', ''ReadWrite''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: client + isRequired: true + - name: access_permission + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.client_access_right_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.client_access_right_py3.yml new file mode 100644 index 00000000..0c8aa3ba --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.client_access_right_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.client_access_right_py3 +name: client_access_right_py3 +fullName: azure.mgmt.edgegateway.models.client_access_right_py3 +classes: +- azure.mgmt.edgegateway.models.client_access_right_py3.ClientAccessRight diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.contact_details.ContactDetails.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.contact_details.ContactDetails.yml new file mode 100644 index 00000000..b08ca755 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.contact_details.ContactDetails.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.contact_details.ContactDetails +name: ContactDetails +fullName: azure.mgmt.edgegateway.models.contact_details.ContactDetails +module: azure.mgmt.edgegateway.models.contact_details +summary: 'Contains all the contact details of the customer. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ContactDetails(**kwargs) + parameters: + - name: contact_person + description: Required. The contact person name. + isRequired: true + types: + - + - name: company_name + description: Required. The name of the company. + isRequired: true + types: + - + - name: phone + description: Required. The phone number. + isRequired: true + types: + - + - name: email_list + description: Required. The email list. + isRequired: true + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.contact_details.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.contact_details.yml new file mode 100644 index 00000000..1a077019 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.contact_details.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.contact_details +name: contact_details +fullName: azure.mgmt.edgegateway.models.contact_details +classes: +- azure.mgmt.edgegateway.models.contact_details.ContactDetails diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.contact_details_py3.ContactDetails.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.contact_details_py3.ContactDetails.yml new file mode 100644 index 00000000..74f51d60 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.contact_details_py3.ContactDetails.yml @@ -0,0 +1,42 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.contact_details_py3.ContactDetails +name: ContactDetails +fullName: azure.mgmt.edgegateway.models.contact_details_py3.ContactDetails +module: azure.mgmt.edgegateway.models.contact_details_py3 +summary: 'Contains all the contact details of the customer. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ContactDetails(*, contact_person: str, company_name: str, phone: str, email_list, + **kwargs)' + parameters: + - name: contact_person + description: Required. The contact person name. + isRequired: true + types: + - + - name: company_name + description: Required. The name of the company. + isRequired: true + types: + - + - name: phone + description: Required. The phone number. + isRequired: true + types: + - + - name: email_list + description: Required. The email list. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: contact_person + isRequired: true + - name: company_name + isRequired: true + - name: phone + isRequired: true + - name: email_list + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.contact_details_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.contact_details_py3.yml new file mode 100644 index 00000000..18bc56a2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.contact_details_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.contact_details_py3 +name: contact_details_py3 +fullName: azure.mgmt.edgegateway.models.contact_details_py3 +classes: +- azure.mgmt.edgegateway.models.contact_details_py3.ContactDetails diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device.DataBoxEdgeDevice.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device.DataBoxEdgeDevice.yml new file mode 100644 index 00000000..51fffd2e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device.DataBoxEdgeDevice.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.data_box_edge_device.DataBoxEdgeDevice +name: DataBoxEdgeDevice +fullName: azure.mgmt.edgegateway.models.data_box_edge_device.DataBoxEdgeDevice +module: azure.mgmt.edgegateway.models.data_box_edge_device +summary: 'The Data Box Edge/Gateway device. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: DataBoxEdgeDevice(**kwargs) + parameters: + - name: location + description: 'Required. The location of the device. This is a supported + + and registered Azure geographical region (for example, West US, East US, + + or Southeast Asia). The geographical region of a device cannot be changed + + once it is created, but if an identical geographical region is specified + + on update, the request will succeed.' + isRequired: true + types: + - + - name: tags + description: 'The list of tags that describe the device. These tags can be + + used to view and group this device (across resource groups).' + isRequired: true + types: + - [, ] + - name: sku + description: The SKU type. + isRequired: true + types: + - + - name: etag + description: The etag for the devices. + isRequired: true + types: + - + - name: data_box_edge_device_status + description: 'The status of the Data Box + + Edge/Gateway device. Possible values include: ''ReadyToSetup'', ''Online'', + + ''Offline'', ''NeedsAttention'', ''Disconnected'', ''PartiallyDisconnected''' + isRequired: true + types: + - + - + - name: description + description: The Description of the Data Box Edge/Gateway device. + isRequired: true + types: + - + - name: model_description + description: 'The description of the Data Box Edge/Gateway + + device model.' + isRequired: true + types: + - + - name: friendly_name + description: The Data Box Edge/Gateway device name. + isRequired: true + types: + - +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: The Serial Number of Data Box Edge/Gateway device. + name: serial_number + types: + - +- description: 'The type of the Data Box Edge/Gateway device. Possible + + values include: ''DataBoxEdgeDevice''' + name: device_type + types: + - + - +- description: The Data Box Edge/Gateway device culture. + name: culture + types: + - +- description: The Data Box Edge/Gateway device model. + name: device_model + types: + - +- description: 'The Data Box Edge/Gateway device software + + version.' + name: device_software_version + types: + - +- description: 'The Data Box Edge/Gateway device local + + capacity in MB.' + name: device_local_capacity + types: + - +- description: The Data Box Edge/Gateway device timezone. + name: time_zone + types: + - +- description: 'The device software version number of the device + + (eg: 1.2.18105.6).' + name: device_hcs_version + types: + - +- description: Type of compute roles configured. + name: configured_role_types + types: + - [ + - ] diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device.yml new file mode 100644 index 00000000..34b7aa9f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.data_box_edge_device +name: data_box_edge_device +fullName: azure.mgmt.edgegateway.models.data_box_edge_device +classes: +- azure.mgmt.edgegateway.models.data_box_edge_device.DataBoxEdgeDevice diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_extended_info.DataBoxEdgeDeviceExtendedInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_extended_info.DataBoxEdgeDeviceExtendedInfo.yml new file mode 100644 index 00000000..0206cc2f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_extended_info.DataBoxEdgeDeviceExtendedInfo.yml @@ -0,0 +1,45 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.data_box_edge_device_extended_info.DataBoxEdgeDeviceExtendedInfo +name: DataBoxEdgeDeviceExtendedInfo +fullName: azure.mgmt.edgegateway.models.data_box_edge_device_extended_info.DataBoxEdgeDeviceExtendedInfo +module: azure.mgmt.edgegateway.models.data_box_edge_device_extended_info +summary: 'The extended Info of the Data Box Edge/Gateway device. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: DataBoxEdgeDeviceExtendedInfo(**kwargs) + parameters: + - name: encryption_key_thumbprint + description: 'The digital signature of encrypted + + certificate.' + isRequired: true + types: + - + - name: encryption_key + description: 'The public part of the encryption certificate. + + Client uses this to encrypt any secret.' + isRequired: true + types: + - +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: The Resource ID of the Resource. + name: resource_key + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_extended_info.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_extended_info.yml new file mode 100644 index 00000000..df3d74d5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_extended_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.data_box_edge_device_extended_info +name: data_box_edge_device_extended_info +fullName: azure.mgmt.edgegateway.models.data_box_edge_device_extended_info +classes: +- azure.mgmt.edgegateway.models.data_box_edge_device_extended_info.DataBoxEdgeDeviceExtendedInfo diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_extended_info_py3.DataBoxEdgeDeviceExtendedInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_extended_info_py3.DataBoxEdgeDeviceExtendedInfo.yml new file mode 100644 index 00000000..3e3adf3f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_extended_info_py3.DataBoxEdgeDeviceExtendedInfo.yml @@ -0,0 +1,51 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.data_box_edge_device_extended_info_py3.DataBoxEdgeDeviceExtendedInfo +name: DataBoxEdgeDeviceExtendedInfo +fullName: azure.mgmt.edgegateway.models.data_box_edge_device_extended_info_py3.DataBoxEdgeDeviceExtendedInfo +module: azure.mgmt.edgegateway.models.data_box_edge_device_extended_info_py3 +summary: 'The extended Info of the Data Box Edge/Gateway device. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'DataBoxEdgeDeviceExtendedInfo(*, encryption_key_thumbprint: str = None, + encryption_key: str = None, **kwargs)' + parameters: + - name: encryption_key_thumbprint + description: 'The digital signature of encrypted + + certificate.' + isRequired: true + types: + - + - name: encryption_key + description: 'The public part of the encryption certificate. + + Client uses this to encrypt any secret.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: encryption_key_thumbprint + isRequired: true + - name: encryption_key + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: The Resource ID of the Resource. + name: resource_key + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_extended_info_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_extended_info_py3.yml new file mode 100644 index 00000000..19d22088 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_extended_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.data_box_edge_device_extended_info_py3 +name: data_box_edge_device_extended_info_py3 +fullName: azure.mgmt.edgegateway.models.data_box_edge_device_extended_info_py3 +classes: +- azure.mgmt.edgegateway.models.data_box_edge_device_extended_info_py3.DataBoxEdgeDeviceExtendedInfo diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_paged.DataBoxEdgeDevicePaged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_paged.DataBoxEdgeDevicePaged.yml new file mode 100644 index 00000000..8ef63af0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_paged.DataBoxEdgeDevicePaged.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.data_box_edge_device_paged.DataBoxEdgeDevicePaged +name: DataBoxEdgeDevicePaged +fullName: azure.mgmt.edgegateway.models.data_box_edge_device_paged.DataBoxEdgeDevicePaged +module: azure.mgmt.edgegateway.models.data_box_edge_device_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: DataBoxEdgeDevicePaged(*args, **kwargs) diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_paged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_paged.yml new file mode 100644 index 00000000..689600ff --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.data_box_edge_device_paged +name: data_box_edge_device_paged +fullName: azure.mgmt.edgegateway.models.data_box_edge_device_paged +classes: +- azure.mgmt.edgegateway.models.data_box_edge_device_paged.DataBoxEdgeDevicePaged diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_patch.DataBoxEdgeDevicePatch.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_patch.DataBoxEdgeDevicePatch.yml new file mode 100644 index 00000000..f2630bd9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_patch.DataBoxEdgeDevicePatch.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.data_box_edge_device_patch.DataBoxEdgeDevicePatch +name: DataBoxEdgeDevicePatch +fullName: azure.mgmt.edgegateway.models.data_box_edge_device_patch.DataBoxEdgeDevicePatch +module: azure.mgmt.edgegateway.models.data_box_edge_device_patch +summary: The Data Box Edge/Gateway device patch. +constructor: + syntax: DataBoxEdgeDevicePatch(**kwargs) + parameters: + - name: tags + description: The tags attached to the Data Box Edge/Gateway resource. + isRequired: true + types: + - [, ] diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_patch.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_patch.yml new file mode 100644 index 00000000..fb91aaae --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_patch.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.data_box_edge_device_patch +name: data_box_edge_device_patch +fullName: azure.mgmt.edgegateway.models.data_box_edge_device_patch +classes: +- azure.mgmt.edgegateway.models.data_box_edge_device_patch.DataBoxEdgeDevicePatch diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_patch_py3.DataBoxEdgeDevicePatch.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_patch_py3.DataBoxEdgeDevicePatch.yml new file mode 100644 index 00000000..f3e016e4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_patch_py3.DataBoxEdgeDevicePatch.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.data_box_edge_device_patch_py3.DataBoxEdgeDevicePatch +name: DataBoxEdgeDevicePatch +fullName: azure.mgmt.edgegateway.models.data_box_edge_device_patch_py3.DataBoxEdgeDevicePatch +module: azure.mgmt.edgegateway.models.data_box_edge_device_patch_py3 +summary: The Data Box Edge/Gateway device patch. +constructor: + syntax: DataBoxEdgeDevicePatch(*, tags=None, **kwargs) + parameters: + - name: tags + description: The tags attached to the Data Box Edge/Gateway resource. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: tags + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_patch_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_patch_py3.yml new file mode 100644 index 00000000..0709f089 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_patch_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.data_box_edge_device_patch_py3 +name: data_box_edge_device_patch_py3 +fullName: azure.mgmt.edgegateway.models.data_box_edge_device_patch_py3 +classes: +- azure.mgmt.edgegateway.models.data_box_edge_device_patch_py3.DataBoxEdgeDevicePatch diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_py3.DataBoxEdgeDevice.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_py3.DataBoxEdgeDevice.yml new file mode 100644 index 00000000..e68a2ca3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_py3.DataBoxEdgeDevice.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.data_box_edge_device_py3.DataBoxEdgeDevice +name: DataBoxEdgeDevice +fullName: azure.mgmt.edgegateway.models.data_box_edge_device_py3.DataBoxEdgeDevice +module: azure.mgmt.edgegateway.models.data_box_edge_device_py3 +summary: 'The Data Box Edge/Gateway device. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DataBoxEdgeDevice(*, location: str, tags=None, sku=None, etag: str = None, + data_box_edge_device_status=None, description: str = None, model_description: + str = None, friendly_name: str = None, **kwargs)' + parameters: + - name: location + description: 'Required. The location of the device. This is a supported + + and registered Azure geographical region (for example, West US, East US, + + or Southeast Asia). The geographical region of a device cannot be changed + + once it is created, but if an identical geographical region is specified + + on update, the request will succeed.' + isRequired: true + types: + - + - name: tags + description: 'The list of tags that describe the device. These tags can be + + used to view and group this device (across resource groups).' + isRequired: true + types: + - [, ] + - name: sku + description: The SKU type. + isRequired: true + types: + - + - name: etag + description: The etag for the devices. + isRequired: true + types: + - + - name: data_box_edge_device_status + description: 'The status of the Data Box + + Edge/Gateway device. Possible values include: ''ReadyToSetup'', ''Online'', + + ''Offline'', ''NeedsAttention'', ''Disconnected'', ''PartiallyDisconnected''' + isRequired: true + types: + - + - + - name: description + description: The Description of the Data Box Edge/Gateway device. + isRequired: true + types: + - + - name: model_description + description: 'The description of the Data Box Edge/Gateway + + device model.' + isRequired: true + types: + - + - name: friendly_name + description: The Data Box Edge/Gateway device name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: location + isRequired: true + - name: tags + isRequired: true + - name: sku + isRequired: true + - name: etag + isRequired: true + - name: data_box_edge_device_status + isRequired: true + - name: description + isRequired: true + - name: model_description + isRequired: true + - name: friendly_name + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: The Serial Number of Data Box Edge/Gateway device. + name: serial_number + types: + - +- description: 'The type of the Data Box Edge/Gateway device. Possible + + values include: ''DataBoxEdgeDevice''' + name: device_type + types: + - + - +- description: The Data Box Edge/Gateway device culture. + name: culture + types: + - +- description: The Data Box Edge/Gateway device model. + name: device_model + types: + - +- description: 'The Data Box Edge/Gateway device software + + version.' + name: device_software_version + types: + - +- description: 'The Data Box Edge/Gateway device local + + capacity in MB.' + name: device_local_capacity + types: + - +- description: The Data Box Edge/Gateway device timezone. + name: time_zone + types: + - +- description: 'The device software version number of the device + + (eg: 1.2.18105.6).' + name: device_hcs_version + types: + - +- description: Type of compute roles configured. + name: configured_role_types + types: + - [ + - ] diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_py3.yml new file mode 100644 index 00000000..9f84c3fe --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.data_box_edge_device_py3 +name: data_box_edge_device_py3 +fullName: azure.mgmt.edgegateway.models.data_box_edge_device_py3 +classes: +- azure.mgmt.edgegateway.models.data_box_edge_device_py3.DataBoxEdgeDevice diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AccountType.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AccountType.yml new file mode 100644 index 00000000..59f60bac --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AccountType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AccountType +name: AccountType +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AccountType +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: blob_storage + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AccountType.blob_storage +- name: general_purpose_storage + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AccountType.general_purpose_storage diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AlertSeverity.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AlertSeverity.yml new file mode 100644 index 00000000..9f7af1a1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AlertSeverity.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AlertSeverity +name: AlertSeverity +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AlertSeverity +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: critical + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AlertSeverity.critical +- name: informational + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AlertSeverity.informational +- name: warning + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AlertSeverity.warning diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AuthenticationType.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AuthenticationType.yml new file mode 100644 index 00000000..497bfe94 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AuthenticationType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AuthenticationType +name: AuthenticationType +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AuthenticationType +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: azure_active_directory + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AuthenticationType.azure_active_directory +- name: invalid + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AuthenticationType.invalid diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AzureContainerDataFormat.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AzureContainerDataFormat.yml new file mode 100644 index 00000000..a5ce726f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AzureContainerDataFormat.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AzureContainerDataFormat +name: AzureContainerDataFormat +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AzureContainerDataFormat +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: azure_file + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AzureContainerDataFormat.azure_file +- name: block_blob + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AzureContainerDataFormat.block_blob +- name: page_blob + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AzureContainerDataFormat.page_blob diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ClientPermissionType.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ClientPermissionType.yml new file mode 100644 index 00000000..5a7e5181 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ClientPermissionType.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ClientPermissionType +name: ClientPermissionType +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ClientPermissionType +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: no_access + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ClientPermissionType.no_access +- name: read_only + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ClientPermissionType.read_only +- name: read_write + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ClientPermissionType.read_write diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataBoxEdgeDeviceStatus.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataBoxEdgeDeviceStatus.yml new file mode 100644 index 00000000..1deda7e7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataBoxEdgeDeviceStatus.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataBoxEdgeDeviceStatus +name: DataBoxEdgeDeviceStatus +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataBoxEdgeDeviceStatus +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: disconnected + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataBoxEdgeDeviceStatus.disconnected +- name: needs_attention + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataBoxEdgeDeviceStatus.needs_attention +- name: offline + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataBoxEdgeDeviceStatus.offline +- name: online + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataBoxEdgeDeviceStatus.online +- name: partially_disconnected + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataBoxEdgeDeviceStatus.partially_disconnected +- name: ready_to_setup + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataBoxEdgeDeviceStatus.ready_to_setup diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataPolicy.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataPolicy.yml new file mode 100644 index 00000000..2863d009 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataPolicy.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataPolicy +name: DataPolicy +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataPolicy +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: cloud + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataPolicy.cloud +- name: local + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataPolicy.local diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DayOfWeek.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DayOfWeek.yml new file mode 100644 index 00000000..ef5565f7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DayOfWeek.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DayOfWeek +name: DayOfWeek +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DayOfWeek +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: friday + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DayOfWeek.friday +- name: monday + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DayOfWeek.monday +- name: saturday + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DayOfWeek.saturday +- name: sunday + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DayOfWeek.sunday +- name: thursday + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DayOfWeek.thursday +- name: tuesday + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DayOfWeek.tuesday +- name: wednesday + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DayOfWeek.wednesday diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DeviceType.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DeviceType.yml new file mode 100644 index 00000000..27747704 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DeviceType.yml @@ -0,0 +1,8 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DeviceType +name: DeviceType +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DeviceType +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: data_box_edge_device + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DeviceType.data_box_edge_device diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DownloadPhase.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DownloadPhase.yml new file mode 100644 index 00000000..f946539e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DownloadPhase.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DownloadPhase +name: DownloadPhase +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DownloadPhase +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: downloading + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DownloadPhase.downloading +- name: initializing + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DownloadPhase.initializing +- name: unknown + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DownloadPhase.unknown +- name: verifying + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DownloadPhase.verifying diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.EncryptionAlgorithm.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.EncryptionAlgorithm.yml new file mode 100644 index 00000000..81b75d32 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.EncryptionAlgorithm.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.EncryptionAlgorithm +name: EncryptionAlgorithm +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.EncryptionAlgorithm +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: aes256 + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.EncryptionAlgorithm.aes256 +- name: none + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.EncryptionAlgorithm.none +- name: rsaes_pkcs1_v_1_5 + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.EncryptionAlgorithm.rsaes_pkcs1_v_1_5 diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.InstallRebootBehavior.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.InstallRebootBehavior.yml new file mode 100644 index 00000000..c62f293e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.InstallRebootBehavior.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.InstallRebootBehavior +name: InstallRebootBehavior +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.InstallRebootBehavior +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: never_reboots + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.InstallRebootBehavior.never_reboots +- name: request_reboot + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.InstallRebootBehavior.request_reboot +- name: requires_reboot + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.InstallRebootBehavior.requires_reboot diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobStatus.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobStatus.yml new file mode 100644 index 00000000..3bae10c2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobStatus.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobStatus +name: JobStatus +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobStatus +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: canceled + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobStatus.canceled +- name: failed + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobStatus.failed +- name: invalid + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobStatus.invalid +- name: paused + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobStatus.paused +- name: running + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobStatus.running +- name: scheduled + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobStatus.scheduled +- name: succeeded + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobStatus.succeeded diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobType.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobType.yml new file mode 100644 index 00000000..d00392c4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobType.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobType +name: JobType +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobType +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: download_updates + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobType.download_updates +- name: install_updates + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobType.install_updates +- name: invalid + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobType.invalid +- name: refresh_share + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobType.refresh_share +- name: scan_for_updates + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobType.scan_for_updates diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricAggregationType.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricAggregationType.yml new file mode 100644 index 00000000..a8099950 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricAggregationType.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricAggregationType +name: MetricAggregationType +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricAggregationType +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: average + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricAggregationType.average +- name: count + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricAggregationType.count +- name: maximum + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricAggregationType.maximum +- name: minimum + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricAggregationType.minimum +- name: none + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricAggregationType.none +- name: not_specified + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricAggregationType.not_specified +- name: total + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricAggregationType.total diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricCategory.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricCategory.yml new file mode 100644 index 00000000..70e69f8d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricCategory.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricCategory +name: MetricCategory +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricCategory +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: capacity + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricCategory.capacity +- name: transaction + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricCategory.transaction diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricUnit.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricUnit.yml new file mode 100644 index 00000000..18333682 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricUnit.yml @@ -0,0 +1,22 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricUnit +name: MetricUnit +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricUnit +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: bytes + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricUnit.bytes +- name: bytes_per_second + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricUnit.bytes_per_second +- name: count + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricUnit.count +- name: count_per_second + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricUnit.count_per_second +- name: milliseconds + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricUnit.milliseconds +- name: not_specified + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricUnit.not_specified +- name: percent + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricUnit.percent +- name: seconds + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricUnit.seconds diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MonitoringStatus.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MonitoringStatus.yml new file mode 100644 index 00000000..d3ea582f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MonitoringStatus.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MonitoringStatus +name: MonitoringStatus +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MonitoringStatus +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: disabled + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MonitoringStatus.disabled +- name: enabled + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MonitoringStatus.enabled diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterDHCPStatus.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterDHCPStatus.yml new file mode 100644 index 00000000..882aaeca --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterDHCPStatus.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterDHCPStatus +name: NetworkAdapterDHCPStatus +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterDHCPStatus +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: disabled + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterDHCPStatus.disabled +- name: enabled + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterDHCPStatus.enabled diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterRDMAStatus.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterRDMAStatus.yml new file mode 100644 index 00000000..73430c76 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterRDMAStatus.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterRDMAStatus +name: NetworkAdapterRDMAStatus +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterRDMAStatus +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: capable + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterRDMAStatus.capable +- name: incapable + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterRDMAStatus.incapable diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterStatus.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterStatus.yml new file mode 100644 index 00000000..0da294ba --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterStatus.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterStatus +name: NetworkAdapterStatus +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterStatus +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: active + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterStatus.active +- name: inactive + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterStatus.inactive diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkGroup.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkGroup.yml new file mode 100644 index 00000000..17312609 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkGroup.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkGroup +name: NetworkGroup +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkGroup +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: non_rdma + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkGroup.non_rdma +- name: none + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkGroup.none +- name: rdma + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkGroup.rdma diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.OrderState.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.OrderState.yml new file mode 100644 index 00000000..6316209d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.OrderState.yml @@ -0,0 +1,34 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.OrderState +name: OrderState +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.OrderState +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: arriving + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.OrderState.arriving +- name: awaiting_fulfilment + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.OrderState.awaiting_fulfilment +- name: awaiting_preparation + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.OrderState.awaiting_preparation +- name: awaiting_return_shipment + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.OrderState.awaiting_return_shipment +- name: awaiting_shipment + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.OrderState.awaiting_shipment +- name: collected_at_microsoft + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.OrderState.collected_at_microsoft +- name: declined + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.OrderState.declined +- name: delivered + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.OrderState.delivered +- name: lost_device + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.OrderState.lost_device +- name: replacement_requested + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.OrderState.replacement_requested +- name: return_initiated + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.OrderState.return_initiated +- name: shipped + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.OrderState.shipped +- name: shipped_back + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.OrderState.shipped_back +- name: untracked + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.OrderState.untracked diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.PlatformType.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.PlatformType.yml new file mode 100644 index 00000000..55cd64c9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.PlatformType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.PlatformType +name: PlatformType +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.PlatformType +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: linux + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.PlatformType.linux +- name: windows + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.PlatformType.windows diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.RoleStatus.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.RoleStatus.yml new file mode 100644 index 00000000..e4619de8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.RoleStatus.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.RoleStatus +name: RoleStatus +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.RoleStatus +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: disabled + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.RoleStatus.disabled +- name: enabled + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.RoleStatus.enabled diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.RoleTypes.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.RoleTypes.yml new file mode 100644 index 00000000..a98ebf8c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.RoleTypes.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.RoleTypes +name: RoleTypes +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.RoleTypes +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: asa + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.RoleTypes.asa +- name: cognitive + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.RoleTypes.cognitive +- name: functions + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.RoleTypes.functions +- name: iot + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.RoleTypes.iot diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SSLStatus.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SSLStatus.yml new file mode 100644 index 00000000..3ec6fde6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SSLStatus.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SSLStatus +name: SSLStatus +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SSLStatus +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: disabled + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SSLStatus.disabled +- name: enabled + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SSLStatus.enabled diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareAccessProtocol.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareAccessProtocol.yml new file mode 100644 index 00000000..c81ce9fd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareAccessProtocol.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareAccessProtocol +name: ShareAccessProtocol +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareAccessProtocol +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: nfs + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareAccessProtocol.nfs +- name: smb + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareAccessProtocol.smb diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareAccessType.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareAccessType.yml new file mode 100644 index 00000000..792fea6a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareAccessType.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareAccessType +name: ShareAccessType +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareAccessType +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: change + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareAccessType.change +- name: custom + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareAccessType.custom +- name: read + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareAccessType.read diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareStatus.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareStatus.yml new file mode 100644 index 00000000..2d93ee75 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareStatus.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareStatus +name: ShareStatus +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareStatus +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: offline + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareStatus.offline +- name: online + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareStatus.online diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SkuName.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SkuName.yml new file mode 100644 index 00000000..f577ecd7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SkuName.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SkuName +name: SkuName +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SkuName +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: edge + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SkuName.edge +- name: gateway + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SkuName.gateway diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SkuTier.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SkuTier.yml new file mode 100644 index 00000000..c1865ba3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SkuTier.yml @@ -0,0 +1,8 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SkuTier +name: SkuTier +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SkuTier +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: standard + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SkuTier.standard diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.TimeGrain.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.TimeGrain.yml new file mode 100644 index 00000000..3c1d7050 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.TimeGrain.yml @@ -0,0 +1,22 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.TimeGrain +name: TimeGrain +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.TimeGrain +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: pt12_h + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.TimeGrain.pt12_h +- name: pt15_m + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.TimeGrain.pt15_m +- name: pt1_d + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.TimeGrain.pt1_d +- name: pt1_h + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.TimeGrain.pt1_h +- name: pt1_m + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.TimeGrain.pt1_m +- name: pt30_m + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.TimeGrain.pt30_m +- name: pt5_m + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.TimeGrain.pt5_m +- name: pt6_h + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.TimeGrain.pt6_h diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperation.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperation.yml new file mode 100644 index 00000000..0553797e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperation.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperation +name: UpdateOperation +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperation +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: download + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperation.download +- name: install + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperation.install +- name: none + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperation.none +- name: scan + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperation.scan diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage.yml new file mode 100644 index 00000000..d2b21f53 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage.yml @@ -0,0 +1,40 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage +name: UpdateOperationStage +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage +module: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +fields: +- name: download_complete + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage.download_complete +- name: download_failed + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage.download_failed +- name: download_started + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage.download_started +- name: failure + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage.failure +- name: initial + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage.initial +- name: install_complete + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage.install_complete +- name: install_failed + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage.install_failed +- name: install_started + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage.install_started +- name: reboot_initiated + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage.reboot_initiated +- name: rescan_complete + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage.rescan_complete +- name: rescan_failed + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage.rescan_failed +- name: rescan_started + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage.rescan_started +- name: scan_complete + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage.scan_complete +- name: scan_failed + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage.scan_failed +- name: scan_started + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage.scan_started +- name: success + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage.success +- name: unknown + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage.unknown diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.yml new file mode 100644 index 00000000..415ee1e3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.yml @@ -0,0 +1,40 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +name: data_box_edge_management_client_enums +fullName: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +enums: +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AccountType +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AlertSeverity +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AuthenticationType +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AzureContainerDataFormat +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ClientPermissionType +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataBoxEdgeDeviceStatus +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataPolicy +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DayOfWeek +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DeviceType +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DownloadPhase +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.EncryptionAlgorithm +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.InstallRebootBehavior +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobStatus +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobType +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricAggregationType +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricCategory +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricUnit +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MonitoringStatus +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterDHCPStatus +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterRDMAStatus +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterStatus +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkGroup +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.OrderState +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.PlatformType +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.RoleStatus +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.RoleTypes +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SSLStatus +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareAccessProtocol +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareAccessType +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareStatus +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SkuName +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SkuTier +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.TimeGrain +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperation +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_event_trigger.FileEventTrigger.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_event_trigger.FileEventTrigger.yml new file mode 100644 index 00000000..c663254a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_event_trigger.FileEventTrigger.yml @@ -0,0 +1,56 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.file_event_trigger.FileEventTrigger +name: FileEventTrigger +fullName: azure.mgmt.edgegateway.models.file_event_trigger.FileEventTrigger +module: azure.mgmt.edgegateway.models.file_event_trigger +summary: 'Trigger details. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: FileEventTrigger(**kwargs) + parameters: + - name: kind + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: source_info + description: Required. File event source details. + isRequired: true + types: + - + - name: sink_info + description: Required. Role sink info. + isRequired: true + types: + - + - name: custom_context_tag + description: 'A custom context tag typically used to + + correlate the trigger against its usage. For example, if a periodic timer + + trigger is intended for certain specific IoT modules in the device, the + + tag can be the name or the image URL of the module.' + isRequired: true + types: + - +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_event_trigger.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_event_trigger.yml new file mode 100644 index 00000000..f2e2c3a4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_event_trigger.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.file_event_trigger +name: file_event_trigger +fullName: azure.mgmt.edgegateway.models.file_event_trigger +classes: +- azure.mgmt.edgegateway.models.file_event_trigger.FileEventTrigger diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_event_trigger_py3.FileEventTrigger.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_event_trigger_py3.FileEventTrigger.yml new file mode 100644 index 00000000..ceec0b6e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_event_trigger_py3.FileEventTrigger.yml @@ -0,0 +1,64 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.file_event_trigger_py3.FileEventTrigger +name: FileEventTrigger +fullName: azure.mgmt.edgegateway.models.file_event_trigger_py3.FileEventTrigger +module: azure.mgmt.edgegateway.models.file_event_trigger_py3 +summary: 'Trigger details. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'FileEventTrigger(*, source_info, sink_info, custom_context_tag: str = None, + **kwargs)' + parameters: + - name: kind + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: source_info + description: Required. File event source details. + isRequired: true + types: + - + - name: sink_info + description: Required. Role sink info. + isRequired: true + types: + - + - name: custom_context_tag + description: 'A custom context tag typically used to + + correlate the trigger against its usage. For example, if a periodic timer + + trigger is intended for certain specific IoT modules in the device, the + + tag can be the name or the image URL of the module.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: source_info + isRequired: true + - name: sink_info + isRequired: true + - name: custom_context_tag + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_event_trigger_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_event_trigger_py3.yml new file mode 100644 index 00000000..d3475382 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_event_trigger_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.file_event_trigger_py3 +name: file_event_trigger_py3 +fullName: azure.mgmt.edgegateway.models.file_event_trigger_py3 +classes: +- azure.mgmt.edgegateway.models.file_event_trigger_py3.FileEventTrigger diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_source_info.FileSourceInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_source_info.FileSourceInfo.yml new file mode 100644 index 00000000..14422a07 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_source_info.FileSourceInfo.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.file_source_info.FileSourceInfo +name: FileSourceInfo +fullName: azure.mgmt.edgegateway.models.file_source_info.FileSourceInfo +module: azure.mgmt.edgegateway.models.file_source_info +summary: 'File source details. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: FileSourceInfo(**kwargs) + parameters: + - name: share_id + description: Required. File share ID. + isRequired: true + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_source_info.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_source_info.yml new file mode 100644 index 00000000..f0e6a705 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_source_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.file_source_info +name: file_source_info +fullName: azure.mgmt.edgegateway.models.file_source_info +classes: +- azure.mgmt.edgegateway.models.file_source_info.FileSourceInfo diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_source_info_py3.FileSourceInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_source_info_py3.FileSourceInfo.yml new file mode 100644 index 00000000..f3855787 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_source_info_py3.FileSourceInfo.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.file_source_info_py3.FileSourceInfo +name: FileSourceInfo +fullName: azure.mgmt.edgegateway.models.file_source_info_py3.FileSourceInfo +module: azure.mgmt.edgegateway.models.file_source_info_py3 +summary: 'File source details. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'FileSourceInfo(*, share_id: str, **kwargs)' + parameters: + - name: share_id + description: Required. File share ID. + isRequired: true + types: + - + keywordOnlyParameters: + - name: share_id + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_source_info_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_source_info_py3.yml new file mode 100644 index 00000000..3376f17e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_source_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.file_source_info_py3 +name: file_source_info_py3 +fullName: azure.mgmt.edgegateway.models.file_source_info_py3 +classes: +- azure.mgmt.edgegateway.models.file_source_info_py3.FileSourceInfo diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_tdevice_info.IoTDeviceInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_tdevice_info.IoTDeviceInfo.yml new file mode 100644 index 00000000..7f41012f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_tdevice_info.IoTDeviceInfo.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.io_tdevice_info.IoTDeviceInfo +name: IoTDeviceInfo +fullName: azure.mgmt.edgegateway.models.io_tdevice_info.IoTDeviceInfo +module: azure.mgmt.edgegateway.models.io_tdevice_info +summary: 'Metadata of IoT device/IoT Edge device to be configured. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: IoTDeviceInfo(**kwargs) + parameters: + - name: device_id + description: Required. ID of the IoT device/edge device. + isRequired: true + types: + - + - name: io_thost_hub + description: 'Required. Host name for the IoT hub associated to the + + device.' + isRequired: true + types: + - + - name: authentication + description: IoT device authentication info. + isRequired: true + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_tdevice_info.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_tdevice_info.yml new file mode 100644 index 00000000..e12c12b4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_tdevice_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.io_tdevice_info +name: io_tdevice_info +fullName: azure.mgmt.edgegateway.models.io_tdevice_info +classes: +- azure.mgmt.edgegateway.models.io_tdevice_info.IoTDeviceInfo diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_tdevice_info_py3.IoTDeviceInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_tdevice_info_py3.IoTDeviceInfo.yml new file mode 100644 index 00000000..62efc215 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_tdevice_info_py3.IoTDeviceInfo.yml @@ -0,0 +1,37 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.io_tdevice_info_py3.IoTDeviceInfo +name: IoTDeviceInfo +fullName: azure.mgmt.edgegateway.models.io_tdevice_info_py3.IoTDeviceInfo +module: azure.mgmt.edgegateway.models.io_tdevice_info_py3 +summary: 'Metadata of IoT device/IoT Edge device to be configured. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'IoTDeviceInfo(*, device_id: str, io_thost_hub: str, authentication=None, + **kwargs)' + parameters: + - name: device_id + description: Required. ID of the IoT device/edge device. + isRequired: true + types: + - + - name: io_thost_hub + description: 'Required. Host name for the IoT hub associated to the + + device.' + isRequired: true + types: + - + - name: authentication + description: IoT device authentication info. + isRequired: true + types: + - + keywordOnlyParameters: + - name: device_id + isRequired: true + - name: io_thost_hub + isRequired: true + - name: authentication + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_tdevice_info_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_tdevice_info_py3.yml new file mode 100644 index 00000000..bef451fd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_tdevice_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.io_tdevice_info_py3 +name: io_tdevice_info_py3 +fullName: azure.mgmt.edgegateway.models.io_tdevice_info_py3 +classes: +- azure.mgmt.edgegateway.models.io_tdevice_info_py3.IoTDeviceInfo diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_trole.IoTRole.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_trole.IoTRole.yml new file mode 100644 index 00000000..ccad672b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_trole.IoTRole.yml @@ -0,0 +1,70 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.io_trole.IoTRole +name: IoTRole +fullName: azure.mgmt.edgegateway.models.io_trole.IoTRole +module: azure.mgmt.edgegateway.models.io_trole +summary: 'Compute role. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: IoTRole(**kwargs) + parameters: + - name: kind + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: host_platform + description: 'Required. Host OS supported by the IoT role. + + Possible values include: ''Windows'', ''Linux''' + isRequired: true + types: + - + - + - name: io_tdevice_details + description: 'Required. IoT device metadata to which data box + + edge device needs to be connected.' + isRequired: true + types: + - + - name: io_tedge_device_details + description: 'Required. IoT edge device to which the IoT + + role needs to be configured.' + isRequired: true + types: + - + - name: share_mappings + description: Mount points of shares in role(s). + isRequired: true + types: + - [] + - name: role_status + description: 'Required. Role status. Possible values include: + + ''Enabled'', ''Disabled''' + isRequired: true + types: + - + - +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_trole.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_trole.yml new file mode 100644 index 00000000..77038566 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_trole.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.io_trole +name: io_trole +fullName: azure.mgmt.edgegateway.models.io_trole +classes: +- azure.mgmt.edgegateway.models.io_trole.IoTRole diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_trole_py3.IoTRole.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_trole_py3.IoTRole.yml new file mode 100644 index 00000000..5f4a84b1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_trole_py3.IoTRole.yml @@ -0,0 +1,82 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.io_trole_py3.IoTRole +name: IoTRole +fullName: azure.mgmt.edgegateway.models.io_trole_py3.IoTRole +module: azure.mgmt.edgegateway.models.io_trole_py3 +summary: 'Compute role. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: IoTRole(*, host_platform, io_tdevice_details, io_tedge_device_details, role_status, + share_mappings=None, **kwargs) + parameters: + - name: kind + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: host_platform + description: 'Required. Host OS supported by the IoT role. + + Possible values include: ''Windows'', ''Linux''' + isRequired: true + types: + - + - + - name: io_tdevice_details + description: 'Required. IoT device metadata to which data box + + edge device needs to be connected.' + isRequired: true + types: + - + - name: io_tedge_device_details + description: 'Required. IoT edge device to which the IoT + + role needs to be configured.' + isRequired: true + types: + - + - name: share_mappings + description: Mount points of shares in role(s). + isRequired: true + types: + - [] + - name: role_status + description: 'Required. Role status. Possible values include: + + ''Enabled'', ''Disabled''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: host_platform + isRequired: true + - name: io_tdevice_details + isRequired: true + - name: io_tedge_device_details + isRequired: true + - name: role_status + isRequired: true + - name: share_mappings + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_trole_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_trole_py3.yml new file mode 100644 index 00000000..b0e455d2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_trole_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.io_trole_py3 +name: io_trole_py3 +fullName: azure.mgmt.edgegateway.models.io_trole_py3 +classes: +- azure.mgmt.edgegateway.models.io_trole_py3.IoTRole diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv4_config.Ipv4Config.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv4_config.Ipv4Config.yml new file mode 100644 index 00000000..6d25e9e2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv4_config.Ipv4Config.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.ipv4_config.Ipv4Config +name: Ipv4Config +fullName: azure.mgmt.edgegateway.models.ipv4_config.Ipv4Config +module: azure.mgmt.edgegateway.models.ipv4_config +summary: 'Details related to the IPv4 address configuration. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Ipv4Config(**kwargs) +variables: +- description: The IPv4 address of the network adapter. + name: ip_address + types: + - +- description: The IPv4 subnet of the network adapter. + name: subnet + types: + - +- description: The IPv4 gateway of the network adapter. + name: gateway + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv4_config.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv4_config.yml new file mode 100644 index 00000000..004f38e4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv4_config.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.ipv4_config +name: ipv4_config +fullName: azure.mgmt.edgegateway.models.ipv4_config +classes: +- azure.mgmt.edgegateway.models.ipv4_config.Ipv4Config diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv4_config_py3.Ipv4Config.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv4_config_py3.Ipv4Config.yml new file mode 100644 index 00000000..fb4a9601 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv4_config_py3.Ipv4Config.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.ipv4_config_py3.Ipv4Config +name: Ipv4Config +fullName: azure.mgmt.edgegateway.models.ipv4_config_py3.Ipv4Config +module: azure.mgmt.edgegateway.models.ipv4_config_py3 +summary: 'Details related to the IPv4 address configuration. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Ipv4Config(**kwargs) +variables: +- description: The IPv4 address of the network adapter. + name: ip_address + types: + - +- description: The IPv4 subnet of the network adapter. + name: subnet + types: + - +- description: The IPv4 gateway of the network adapter. + name: gateway + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv4_config_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv4_config_py3.yml new file mode 100644 index 00000000..e1a42e9e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv4_config_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.ipv4_config_py3 +name: ipv4_config_py3 +fullName: azure.mgmt.edgegateway.models.ipv4_config_py3 +classes: +- azure.mgmt.edgegateway.models.ipv4_config_py3.Ipv4Config diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv6_config.Ipv6Config.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv6_config.Ipv6Config.yml new file mode 100644 index 00000000..e65cf95e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv6_config.Ipv6Config.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.ipv6_config.Ipv6Config +name: Ipv6Config +fullName: azure.mgmt.edgegateway.models.ipv6_config.Ipv6Config +module: azure.mgmt.edgegateway.models.ipv6_config +summary: 'Details related to the IPv6 address configuration. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Ipv6Config(**kwargs) +variables: +- description: The IPv6 address of the network adapter. + name: ip_address + types: + - +- description: The IPv6 prefix of the network adapter. + name: prefix_length + types: + - +- description: The IPv6 gateway of the network adapter. + name: gateway + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv6_config.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv6_config.yml new file mode 100644 index 00000000..d8e2fcb0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv6_config.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.ipv6_config +name: ipv6_config +fullName: azure.mgmt.edgegateway.models.ipv6_config +classes: +- azure.mgmt.edgegateway.models.ipv6_config.Ipv6Config diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv6_config_py3.Ipv6Config.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv6_config_py3.Ipv6Config.yml new file mode 100644 index 00000000..dda38a14 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv6_config_py3.Ipv6Config.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.ipv6_config_py3.Ipv6Config +name: Ipv6Config +fullName: azure.mgmt.edgegateway.models.ipv6_config_py3.Ipv6Config +module: azure.mgmt.edgegateway.models.ipv6_config_py3 +summary: 'Details related to the IPv6 address configuration. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Ipv6Config(**kwargs) +variables: +- description: The IPv6 address of the network adapter. + name: ip_address + types: + - +- description: The IPv6 prefix of the network adapter. + name: prefix_length + types: + - +- description: The IPv6 gateway of the network adapter. + name: gateway + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv6_config_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv6_config_py3.yml new file mode 100644 index 00000000..41bb0b01 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ipv6_config_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.ipv6_config_py3 +name: ipv6_config_py3 +fullName: azure.mgmt.edgegateway.models.ipv6_config_py3 +classes: +- azure.mgmt.edgegateway.models.ipv6_config_py3.Ipv6Config diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job.Job.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job.Job.yml new file mode 100644 index 00000000..9d395b8d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job.Job.yml @@ -0,0 +1,103 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.job.Job +name: Job +fullName: azure.mgmt.edgegateway.models.job.Job +module: azure.mgmt.edgegateway.models.job +summary: 'A device job. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: Job(**kwargs) + parameters: + - name: folder + description: 'If only subfolders need to be refreshed, then the subfolder + + path inside the share. (The path is empty if there are no subfolders.)' + isRequired: true + types: + - +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The name of the object. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: 'The current status of the job. Possible values include: + + ''Invalid'', ''Running'', ''Succeeded'', ''Failed'', ''Canceled'', ''Paused'', + + ''Scheduled''' + name: status + types: + - + - +- description: The UTC date and time at which the job started. + name: start_time + types: + - +- description: The UTC date and time at which the job completed. + name: end_time + types: + - +- description: The percentage of the job that is complete. + name: percent_complete + types: + - +- description: The error details. + name: error + types: + - +- description: 'The type of the job. Possible values include: ''Invalid'', + + ''ScanForUpdates'', ''DownloadUpdates'', ''InstallUpdates'', ''RefreshShare''' + name: job_type + types: + - + - +- description: 'Current stage of the update operation. Possible + + values include: ''Unknown'', ''Initial'', ''ScanStarted'', ''ScanComplete'', + + ''ScanFailed'', ''DownloadStarted'', ''DownloadComplete'', ''DownloadFailed'', + + ''InstallStarted'', ''InstallComplete'', ''InstallFailed'', ''RebootInitiated'', + + ''Success'', ''Failure'', ''RescanStarted'', ''RescanComplete'', ''RescanFailed''' + name: current_stage + types: + - + - +- description: The download progress. + name: download_progress + types: + - +- description: The install progress. + name: install_progress + types: + - +- description: 'Total number of errors encountered during the + + refresh process.' + name: total_refresh_errors + types: + - +- description: 'Local share/remote container relative path to + + the error manifest file of the refresh.' + name: error_manifest_file + types: + - +- description: ARM ID of the share that was refreshed. + name: share_id + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job.yml new file mode 100644 index 00000000..aa739506 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.job +name: job +fullName: azure.mgmt.edgegateway.models.job +classes: +- azure.mgmt.edgegateway.models.job.Job diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_details.JobErrorDetails.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_details.JobErrorDetails.yml new file mode 100644 index 00000000..2b82e77d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_details.JobErrorDetails.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.job_error_details.JobErrorDetails +name: JobErrorDetails +fullName: azure.mgmt.edgegateway.models.job_error_details.JobErrorDetails +module: azure.mgmt.edgegateway.models.job_error_details +summary: 'The job error information containing the list of job errors. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: JobErrorDetails(**kwargs) +variables: +- description: The error details. + name: error_details + types: + - [] +- description: The code intended for programmatic access. + name: code + types: + - +- description: The message that describes the error in detail. + name: message + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_details.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_details.yml new file mode 100644 index 00000000..04688bca --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_details.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.job_error_details +name: job_error_details +fullName: azure.mgmt.edgegateway.models.job_error_details +classes: +- azure.mgmt.edgegateway.models.job_error_details.JobErrorDetails diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_details_py3.JobErrorDetails.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_details_py3.JobErrorDetails.yml new file mode 100644 index 00000000..2b27c61d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_details_py3.JobErrorDetails.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.job_error_details_py3.JobErrorDetails +name: JobErrorDetails +fullName: azure.mgmt.edgegateway.models.job_error_details_py3.JobErrorDetails +module: azure.mgmt.edgegateway.models.job_error_details_py3 +summary: 'The job error information containing the list of job errors. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: JobErrorDetails(**kwargs) +variables: +- description: The error details. + name: error_details + types: + - [] +- description: The code intended for programmatic access. + name: code + types: + - +- description: The message that describes the error in detail. + name: message + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_details_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_details_py3.yml new file mode 100644 index 00000000..f4d9758d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_details_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.job_error_details_py3 +name: job_error_details_py3 +fullName: azure.mgmt.edgegateway.models.job_error_details_py3 +classes: +- azure.mgmt.edgegateway.models.job_error_details_py3.JobErrorDetails diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_item.JobErrorItem.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_item.JobErrorItem.yml new file mode 100644 index 00000000..d4a59cce --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_item.JobErrorItem.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.job_error_item.JobErrorItem +name: JobErrorItem +fullName: azure.mgmt.edgegateway.models.job_error_item.JobErrorItem +module: azure.mgmt.edgegateway.models.job_error_item +summary: 'The job error items. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: JobErrorItem(**kwargs) +variables: +- description: The recommended actions. + name: recommendations + types: + - [] +- description: The code intended for programmatic access. + name: code + types: + - +- description: The message that describes the error in detail. + name: message + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_item.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_item.yml new file mode 100644 index 00000000..5ce87a98 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_item.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.job_error_item +name: job_error_item +fullName: azure.mgmt.edgegateway.models.job_error_item +classes: +- azure.mgmt.edgegateway.models.job_error_item.JobErrorItem diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_item_py3.JobErrorItem.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_item_py3.JobErrorItem.yml new file mode 100644 index 00000000..11e242c7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_item_py3.JobErrorItem.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.job_error_item_py3.JobErrorItem +name: JobErrorItem +fullName: azure.mgmt.edgegateway.models.job_error_item_py3.JobErrorItem +module: azure.mgmt.edgegateway.models.job_error_item_py3 +summary: 'The job error items. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: JobErrorItem(**kwargs) +variables: +- description: The recommended actions. + name: recommendations + types: + - [] +- description: The code intended for programmatic access. + name: code + types: + - +- description: The message that describes the error in detail. + name: message + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_item_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_item_py3.yml new file mode 100644 index 00000000..2d0f4fcb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_error_item_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.job_error_item_py3 +name: job_error_item_py3 +fullName: azure.mgmt.edgegateway.models.job_error_item_py3 +classes: +- azure.mgmt.edgegateway.models.job_error_item_py3.JobErrorItem diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_py3.Job.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_py3.Job.yml new file mode 100644 index 00000000..42c51722 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_py3.Job.yml @@ -0,0 +1,106 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.job_py3.Job +name: Job +fullName: azure.mgmt.edgegateway.models.job_py3.Job +module: azure.mgmt.edgegateway.models.job_py3 +summary: 'A device job. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'Job(*, folder: str = None, **kwargs)' + parameters: + - name: folder + description: 'If only subfolders need to be refreshed, then the subfolder + + path inside the share. (The path is empty if there are no subfolders.)' + isRequired: true + types: + - + keywordOnlyParameters: + - name: folder + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The name of the object. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: 'The current status of the job. Possible values include: + + ''Invalid'', ''Running'', ''Succeeded'', ''Failed'', ''Canceled'', ''Paused'', + + ''Scheduled''' + name: status + types: + - + - +- description: The UTC date and time at which the job started. + name: start_time + types: + - +- description: The UTC date and time at which the job completed. + name: end_time + types: + - +- description: The percentage of the job that is complete. + name: percent_complete + types: + - +- description: The error details. + name: error + types: + - +- description: 'The type of the job. Possible values include: ''Invalid'', + + ''ScanForUpdates'', ''DownloadUpdates'', ''InstallUpdates'', ''RefreshShare''' + name: job_type + types: + - + - +- description: 'Current stage of the update operation. Possible + + values include: ''Unknown'', ''Initial'', ''ScanStarted'', ''ScanComplete'', + + ''ScanFailed'', ''DownloadStarted'', ''DownloadComplete'', ''DownloadFailed'', + + ''InstallStarted'', ''InstallComplete'', ''InstallFailed'', ''RebootInitiated'', + + ''Success'', ''Failure'', ''RescanStarted'', ''RescanComplete'', ''RescanFailed''' + name: current_stage + types: + - + - +- description: The download progress. + name: download_progress + types: + - +- description: The install progress. + name: install_progress + types: + - +- description: 'Total number of errors encountered during the + + refresh process.' + name: total_refresh_errors + types: + - +- description: 'Local share/remote container relative path to + + the error manifest file of the refresh.' + name: error_manifest_file + types: + - +- description: ARM ID of the share that was refreshed. + name: share_id + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_py3.yml new file mode 100644 index 00000000..757469f7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.job_py3 +name: job_py3 +fullName: azure.mgmt.edgegateway.models.job_py3 +classes: +- azure.mgmt.edgegateway.models.job_py3.Job diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_dimension_v1.MetricDimensionV1.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_dimension_v1.MetricDimensionV1.yml new file mode 100644 index 00000000..4cc6fa81 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_dimension_v1.MetricDimensionV1.yml @@ -0,0 +1,24 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.metric_dimension_v1.MetricDimensionV1 +name: MetricDimensionV1 +fullName: azure.mgmt.edgegateway.models.metric_dimension_v1.MetricDimensionV1 +module: azure.mgmt.edgegateway.models.metric_dimension_v1 +summary: Metric Dimension v1. +constructor: + syntax: MetricDimensionV1(**kwargs) + parameters: + - name: name + description: Name of the metrics dimension. + isRequired: true + types: + - + - name: display_name + description: Display name of the metrics dimension. + isRequired: true + types: + - + - name: to_be_exported_for_shoebox + description: To be exported to shoe box. + isRequired: true + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_dimension_v1.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_dimension_v1.yml new file mode 100644 index 00000000..35b91602 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_dimension_v1.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.metric_dimension_v1 +name: metric_dimension_v1 +fullName: azure.mgmt.edgegateway.models.metric_dimension_v1 +classes: +- azure.mgmt.edgegateway.models.metric_dimension_v1.MetricDimensionV1 diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_dimension_v1_py3.MetricDimensionV1.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_dimension_v1_py3.MetricDimensionV1.yml new file mode 100644 index 00000000..d8354652 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_dimension_v1_py3.MetricDimensionV1.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.metric_dimension_v1_py3.MetricDimensionV1 +name: MetricDimensionV1 +fullName: azure.mgmt.edgegateway.models.metric_dimension_v1_py3.MetricDimensionV1 +module: azure.mgmt.edgegateway.models.metric_dimension_v1_py3 +summary: Metric Dimension v1. +constructor: + syntax: 'MetricDimensionV1(*, name: str = None, display_name: str = None, to_be_exported_for_shoebox: + bool = None, **kwargs)' + parameters: + - name: name + description: Name of the metrics dimension. + isRequired: true + types: + - + - name: display_name + description: Display name of the metrics dimension. + isRequired: true + types: + - + - name: to_be_exported_for_shoebox + description: To be exported to shoe box. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: display_name + isRequired: true + - name: to_be_exported_for_shoebox + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_dimension_v1_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_dimension_v1_py3.yml new file mode 100644 index 00000000..d8c706af --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_dimension_v1_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.metric_dimension_v1_py3 +name: metric_dimension_v1_py3 +fullName: azure.mgmt.edgegateway.models.metric_dimension_v1_py3 +classes: +- azure.mgmt.edgegateway.models.metric_dimension_v1_py3.MetricDimensionV1 diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_specification_v1.MetricSpecificationV1.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_specification_v1.MetricSpecificationV1.yml new file mode 100644 index 00000000..f92fbfbd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_specification_v1.MetricSpecificationV1.yml @@ -0,0 +1,80 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.metric_specification_v1.MetricSpecificationV1 +name: MetricSpecificationV1 +fullName: azure.mgmt.edgegateway.models.metric_specification_v1.MetricSpecificationV1 +module: azure.mgmt.edgegateway.models.metric_specification_v1 +summary: Metric specification version 1. +constructor: + syntax: MetricSpecificationV1(**kwargs) + parameters: + - name: name + description: Name of the metric. + isRequired: true + types: + - + - name: display_name + description: Display name of the metric. + isRequired: true + types: + - + - name: display_description + description: Description of the metric to be displayed. + isRequired: true + types: + - + - name: unit + description: 'Metric units. Possible values include: ''NotSpecified'', + + ''Percent'', ''Count'', ''Seconds'', ''Milliseconds'', ''Bytes'', ''BytesPerSecond'', + + ''CountPerSecond''' + isRequired: true + types: + - + - + - name: aggregation_type + description: 'Metric aggregation type. Possible values include: + + ''NotSpecified'', ''None'', ''Average'', ''Minimum'', ''Maximum'', ''Total'', + ''Count''' + isRequired: true + types: + - + - + - name: dimensions + description: 'Metric dimensions, other than default dimension which + + is resource.' + isRequired: true + types: + - [] + - name: fill_gap_with_zero + description: Set true to fill the gaps with zero. + isRequired: true + types: + - + - name: category + description: 'Metric category. Possible values include: ''Capacity'', + + ''Transaction''' + isRequired: true + types: + - + - + - name: resource_id_dimension_name_override + description: Resource name override. + isRequired: true + types: + - + - name: supported_time_grain_types + description: Support granularity of metrics. + isRequired: true + types: + - [ + - ] + - name: supported_aggregation_types + description: Support metric aggregation type. + isRequired: true + types: + - [ + - ] diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_specification_v1.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_specification_v1.yml new file mode 100644 index 00000000..ddba2e4f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_specification_v1.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.metric_specification_v1 +name: metric_specification_v1 +fullName: azure.mgmt.edgegateway.models.metric_specification_v1 +classes: +- azure.mgmt.edgegateway.models.metric_specification_v1.MetricSpecificationV1 diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_specification_v1_py3.MetricSpecificationV1.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_specification_v1_py3.MetricSpecificationV1.yml new file mode 100644 index 00000000..f9719de6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_specification_v1_py3.MetricSpecificationV1.yml @@ -0,0 +1,106 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.metric_specification_v1_py3.MetricSpecificationV1 +name: MetricSpecificationV1 +fullName: azure.mgmt.edgegateway.models.metric_specification_v1_py3.MetricSpecificationV1 +module: azure.mgmt.edgegateway.models.metric_specification_v1_py3 +summary: Metric specification version 1. +constructor: + syntax: 'MetricSpecificationV1(*, name: str = None, display_name: str = None, display_description: + str = None, unit=None, aggregation_type=None, dimensions=None, fill_gap_with_zero: + bool = None, category=None, resource_id_dimension_name_override: str = None, supported_time_grain_types=None, + supported_aggregation_types=None, **kwargs)' + parameters: + - name: name + description: Name of the metric. + isRequired: true + types: + - + - name: display_name + description: Display name of the metric. + isRequired: true + types: + - + - name: display_description + description: Description of the metric to be displayed. + isRequired: true + types: + - + - name: unit + description: 'Metric units. Possible values include: ''NotSpecified'', + + ''Percent'', ''Count'', ''Seconds'', ''Milliseconds'', ''Bytes'', ''BytesPerSecond'', + + ''CountPerSecond''' + isRequired: true + types: + - + - + - name: aggregation_type + description: 'Metric aggregation type. Possible values include: + + ''NotSpecified'', ''None'', ''Average'', ''Minimum'', ''Maximum'', ''Total'', + ''Count''' + isRequired: true + types: + - + - + - name: dimensions + description: 'Metric dimensions, other than default dimension which + + is resource.' + isRequired: true + types: + - [] + - name: fill_gap_with_zero + description: Set true to fill the gaps with zero. + isRequired: true + types: + - + - name: category + description: 'Metric category. Possible values include: ''Capacity'', + + ''Transaction''' + isRequired: true + types: + - + - + - name: resource_id_dimension_name_override + description: Resource name override. + isRequired: true + types: + - + - name: supported_time_grain_types + description: Support granularity of metrics. + isRequired: true + types: + - [ + - ] + - name: supported_aggregation_types + description: Support metric aggregation type. + isRequired: true + types: + - [ + - ] + keywordOnlyParameters: + - name: name + isRequired: true + - name: display_name + isRequired: true + - name: display_description + isRequired: true + - name: unit + isRequired: true + - name: aggregation_type + isRequired: true + - name: dimensions + isRequired: true + - name: fill_gap_with_zero + isRequired: true + - name: category + isRequired: true + - name: resource_id_dimension_name_override + isRequired: true + - name: supported_time_grain_types + isRequired: true + - name: supported_aggregation_types + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_specification_v1_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_specification_v1_py3.yml new file mode 100644 index 00000000..20fd958f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_specification_v1_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.metric_specification_v1_py3 +name: metric_specification_v1_py3 +fullName: azure.mgmt.edgegateway.models.metric_specification_v1_py3 +classes: +- azure.mgmt.edgegateway.models.metric_specification_v1_py3.MetricSpecificationV1 diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.mount_point_map.MountPointMap.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.mount_point_map.MountPointMap.yml new file mode 100644 index 00000000..1f3763a2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.mount_point_map.MountPointMap.yml @@ -0,0 +1,38 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.mount_point_map.MountPointMap +name: MountPointMap +fullName: azure.mgmt.edgegateway.models.mount_point_map.MountPointMap +module: azure.mgmt.edgegateway.models.mount_point_map +summary: 'The share mount point. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: MountPointMap(**kwargs) + parameters: + - name: share_id + description: Required. ID of the share mounted to the role VM. + isRequired: true + types: + - +variables: +- description: ID of the role to which share is mounted. + name: role_id + types: + - +- description: Mount point for the share. + name: mount_point + types: + - +- description: 'Role type. Possible values include: ''IOT'', ''ASA'', + + ''Functions'', ''Cognitive''' + name: role_type + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.mount_point_map.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.mount_point_map.yml new file mode 100644 index 00000000..4c501765 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.mount_point_map.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.mount_point_map +name: mount_point_map +fullName: azure.mgmt.edgegateway.models.mount_point_map +classes: +- azure.mgmt.edgegateway.models.mount_point_map.MountPointMap diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.mount_point_map_py3.MountPointMap.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.mount_point_map_py3.MountPointMap.yml new file mode 100644 index 00000000..5db98595 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.mount_point_map_py3.MountPointMap.yml @@ -0,0 +1,41 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.mount_point_map_py3.MountPointMap +name: MountPointMap +fullName: azure.mgmt.edgegateway.models.mount_point_map_py3.MountPointMap +module: azure.mgmt.edgegateway.models.mount_point_map_py3 +summary: 'The share mount point. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MountPointMap(*, share_id: str, **kwargs)' + parameters: + - name: share_id + description: Required. ID of the share mounted to the role VM. + isRequired: true + types: + - + keywordOnlyParameters: + - name: share_id + isRequired: true +variables: +- description: ID of the role to which share is mounted. + name: role_id + types: + - +- description: Mount point for the share. + name: mount_point + types: + - +- description: 'Role type. Possible values include: ''IOT'', ''ASA'', + + ''Functions'', ''Cognitive''' + name: role_type + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.mount_point_map_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.mount_point_map_py3.yml new file mode 100644 index 00000000..7f0f12f6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.mount_point_map_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.mount_point_map_py3 +name: mount_point_map_py3 +fullName: azure.mgmt.edgegateway.models.mount_point_map_py3 +classes: +- azure.mgmt.edgegateway.models.mount_point_map_py3.MountPointMap diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter.NetworkAdapter.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter.NetworkAdapter.yml new file mode 100644 index 00000000..a0ed1d3d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter.NetworkAdapter.yml @@ -0,0 +1,86 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.network_adapter.NetworkAdapter +name: NetworkAdapter +fullName: azure.mgmt.edgegateway.models.network_adapter.NetworkAdapter +module: azure.mgmt.edgegateway.models.network_adapter +summary: 'Represents the networkAdapter on a device. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: NetworkAdapter(**kwargs) + parameters: + - name: rdma_status + description: 'Value indicating whether this adapter is RDMA capable. + + Possible values include: ''Incapable'', ''Capable''' + isRequired: true + types: + - + - + - name: dhcp_status + description: 'Value indicating whether this adapter has DHCP + + enabled. Possible values include: ''Disabled'', ''Enabled''' + isRequired: true + types: + - + - +variables: +- description: Instance ID of network adapter. + name: adapter_id + types: + - +- description: Hardware position of network adapter. + name: adapter_position + types: + - +- description: Logical index of the adapter. + name: index + types: + - +- description: Node ID of the network adapter. + name: node_id + types: + - +- description: Network adapter name. + name: network_adapter_name + types: + - +- description: Hardware label for the adapter. + name: label + types: + - +- description: MAC address. + name: mac_address + types: + - +- description: Link speed. + name: link_speed + types: + - +- description: 'Value indicating whether this adapter is valid. Possible + + values include: ''Inactive'', ''Active''' + name: status + types: + - + - +- description: The IPv4 configuration of the network adapter. + name: ipv4_configuration + types: + - +- description: The IPv6 configuration of the network adapter. + name: ipv6_configuration + types: + - +- description: The IPv6 local address. + name: ipv6_link_local_address + types: + - +- description: The list of DNS Servers of the device. + name: dns_servers + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter.yml new file mode 100644 index 00000000..b437c3c8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.network_adapter +name: network_adapter +fullName: azure.mgmt.edgegateway.models.network_adapter +classes: +- azure.mgmt.edgegateway.models.network_adapter.NetworkAdapter diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_position.NetworkAdapterPosition.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_position.NetworkAdapterPosition.yml new file mode 100644 index 00000000..d2c37bfc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_position.NetworkAdapterPosition.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.network_adapter_position.NetworkAdapterPosition +name: NetworkAdapterPosition +fullName: azure.mgmt.edgegateway.models.network_adapter_position.NetworkAdapterPosition +module: azure.mgmt.edgegateway.models.network_adapter_position +summary: 'The network adapter position. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: NetworkAdapterPosition(**kwargs) +variables: +- description: 'The network group. Possible values include: ''None'', + + ''NonRDMA'', ''RDMA''' + name: network_group + types: + - + - +- description: The port. + name: port + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_position.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_position.yml new file mode 100644 index 00000000..5f3b8f93 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_position.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.network_adapter_position +name: network_adapter_position +fullName: azure.mgmt.edgegateway.models.network_adapter_position +classes: +- azure.mgmt.edgegateway.models.network_adapter_position.NetworkAdapterPosition diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_position_py3.NetworkAdapterPosition.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_position_py3.NetworkAdapterPosition.yml new file mode 100644 index 00000000..8d3f9673 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_position_py3.NetworkAdapterPosition.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.network_adapter_position_py3.NetworkAdapterPosition +name: NetworkAdapterPosition +fullName: azure.mgmt.edgegateway.models.network_adapter_position_py3.NetworkAdapterPosition +module: azure.mgmt.edgegateway.models.network_adapter_position_py3 +summary: 'The network adapter position. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: NetworkAdapterPosition(**kwargs) +variables: +- description: 'The network group. Possible values include: ''None'', + + ''NonRDMA'', ''RDMA''' + name: network_group + types: + - + - +- description: The port. + name: port + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_position_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_position_py3.yml new file mode 100644 index 00000000..fd03c34f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_position_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.network_adapter_position_py3 +name: network_adapter_position_py3 +fullName: azure.mgmt.edgegateway.models.network_adapter_position_py3 +classes: +- azure.mgmt.edgegateway.models.network_adapter_position_py3.NetworkAdapterPosition diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_py3.NetworkAdapter.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_py3.NetworkAdapter.yml new file mode 100644 index 00000000..83a17ca2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_py3.NetworkAdapter.yml @@ -0,0 +1,91 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.network_adapter_py3.NetworkAdapter +name: NetworkAdapter +fullName: azure.mgmt.edgegateway.models.network_adapter_py3.NetworkAdapter +module: azure.mgmt.edgegateway.models.network_adapter_py3 +summary: 'Represents the networkAdapter on a device. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: NetworkAdapter(*, rdma_status=None, dhcp_status=None, **kwargs) + parameters: + - name: rdma_status + description: 'Value indicating whether this adapter is RDMA capable. + + Possible values include: ''Incapable'', ''Capable''' + isRequired: true + types: + - + - + - name: dhcp_status + description: 'Value indicating whether this adapter has DHCP + + enabled. Possible values include: ''Disabled'', ''Enabled''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: rdma_status + isRequired: true + - name: dhcp_status + isRequired: true +variables: +- description: Instance ID of network adapter. + name: adapter_id + types: + - +- description: Hardware position of network adapter. + name: adapter_position + types: + - +- description: Logical index of the adapter. + name: index + types: + - +- description: Node ID of the network adapter. + name: node_id + types: + - +- description: Network adapter name. + name: network_adapter_name + types: + - +- description: Hardware label for the adapter. + name: label + types: + - +- description: MAC address. + name: mac_address + types: + - +- description: Link speed. + name: link_speed + types: + - +- description: 'Value indicating whether this adapter is valid. Possible + + values include: ''Inactive'', ''Active''' + name: status + types: + - + - +- description: The IPv4 configuration of the network adapter. + name: ipv4_configuration + types: + - +- description: The IPv6 configuration of the network adapter. + name: ipv6_configuration + types: + - +- description: The IPv6 local address. + name: ipv6_link_local_address + types: + - +- description: The list of DNS Servers of the device. + name: dns_servers + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_py3.yml new file mode 100644 index 00000000..50838e00 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.network_adapter_py3 +name: network_adapter_py3 +fullName: azure.mgmt.edgegateway.models.network_adapter_py3 +classes: +- azure.mgmt.edgegateway.models.network_adapter_py3.NetworkAdapter diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_settings.NetworkSettings.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_settings.NetworkSettings.yml new file mode 100644 index 00000000..354c0bbc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_settings.NetworkSettings.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.network_settings.NetworkSettings +name: NetworkSettings +fullName: azure.mgmt.edgegateway.models.network_settings.NetworkSettings +module: azure.mgmt.edgegateway.models.network_settings +summary: 'The network settings of a device. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: NetworkSettings(**kwargs) +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: The network adapter list on the device. + name: network_adapters + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_settings.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_settings.yml new file mode 100644 index 00000000..27b292c0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_settings.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.network_settings +name: network_settings +fullName: azure.mgmt.edgegateway.models.network_settings +classes: +- azure.mgmt.edgegateway.models.network_settings.NetworkSettings diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_settings_py3.NetworkSettings.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_settings_py3.NetworkSettings.yml new file mode 100644 index 00000000..4777d111 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_settings_py3.NetworkSettings.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.network_settings_py3.NetworkSettings +name: NetworkSettings +fullName: azure.mgmt.edgegateway.models.network_settings_py3.NetworkSettings +module: azure.mgmt.edgegateway.models.network_settings_py3 +summary: 'The network settings of a device. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: NetworkSettings(**kwargs) +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: The network adapter list on the device. + name: network_adapters + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_settings_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_settings_py3.yml new file mode 100644 index 00000000..9ffdf7b6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_settings_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.network_settings_py3 +name: network_settings_py3 +fullName: azure.mgmt.edgegateway.models.network_settings_py3 +classes: +- azure.mgmt.edgegateway.models.network_settings_py3.NetworkSettings diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation.Operation.yml new file mode 100644 index 00000000..e2aea8f8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation.Operation.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.operation.Operation +name: Operation +fullName: azure.mgmt.edgegateway.models.operation.Operation +module: azure.mgmt.edgegateway.models.operation +summary: Operations. +constructor: + syntax: Operation(**kwargs) + parameters: + - name: name + description: Name of the operation. + isRequired: true + types: + - + - name: display + description: Properties displayed for the operation. + isRequired: true + types: + - + - name: origin + description: Origin of the operation. + isRequired: true + types: + - + - name: service_specification + description: Service specification. + isRequired: true + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation.yml new file mode 100644 index 00000000..30ec05f0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.operation +name: operation +fullName: azure.mgmt.edgegateway.models.operation +classes: +- azure.mgmt.edgegateway.models.operation.Operation diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_display.OperationDisplay.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_display.OperationDisplay.yml new file mode 100644 index 00000000..fe48102f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_display.OperationDisplay.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.operation_display.OperationDisplay +name: OperationDisplay +fullName: azure.mgmt.edgegateway.models.operation_display.OperationDisplay +module: azure.mgmt.edgegateway.models.operation_display +summary: Operation display properties. +constructor: + syntax: OperationDisplay(**kwargs) + parameters: + - name: provider + description: Provider name. + isRequired: true + types: + - + - name: resource + description: The type of resource in which the operation is performed. + isRequired: true + types: + - + - name: operation + description: Operation to be performed on the resource. + isRequired: true + types: + - + - name: description + description: Description of the operation to be performed. + isRequired: true + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_display.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_display.yml new file mode 100644 index 00000000..e85d64e1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_display.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.operation_display +name: operation_display +fullName: azure.mgmt.edgegateway.models.operation_display +classes: +- azure.mgmt.edgegateway.models.operation_display.OperationDisplay diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_display_py3.OperationDisplay.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_display_py3.OperationDisplay.yml new file mode 100644 index 00000000..96260331 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_display_py3.OperationDisplay.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.operation_display_py3.OperationDisplay +name: OperationDisplay +fullName: azure.mgmt.edgegateway.models.operation_display_py3.OperationDisplay +module: azure.mgmt.edgegateway.models.operation_display_py3 +summary: Operation display properties. +constructor: + syntax: 'OperationDisplay(*, provider: str = None, resource: str = None, operation: + str = None, description: str = None, **kwargs)' + parameters: + - name: provider + description: Provider name. + isRequired: true + types: + - + - name: resource + description: The type of resource in which the operation is performed. + isRequired: true + types: + - + - name: operation + description: Operation to be performed on the resource. + isRequired: true + types: + - + - name: description + description: Description of the operation to be performed. + isRequired: true + types: + - + keywordOnlyParameters: + - name: provider + isRequired: true + - name: resource + isRequired: true + - name: operation + isRequired: true + - name: description + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_display_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_display_py3.yml new file mode 100644 index 00000000..f70d3558 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_display_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.operation_display_py3 +name: operation_display_py3 +fullName: azure.mgmt.edgegateway.models.operation_display_py3 +classes: +- azure.mgmt.edgegateway.models.operation_display_py3.OperationDisplay diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_paged.OperationPaged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_paged.OperationPaged.yml new file mode 100644 index 00000000..6d2c8d56 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_paged.OperationPaged.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.operation_paged.OperationPaged +name: OperationPaged +fullName: azure.mgmt.edgegateway.models.operation_paged.OperationPaged +module: azure.mgmt.edgegateway.models.operation_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: OperationPaged(*args, **kwargs) diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_paged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_paged.yml new file mode 100644 index 00000000..a1a37de1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.operation_paged +name: operation_paged +fullName: azure.mgmt.edgegateway.models.operation_paged +classes: +- azure.mgmt.edgegateway.models.operation_paged.OperationPaged diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_py3.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_py3.Operation.yml new file mode 100644 index 00000000..ba4fcf06 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_py3.Operation.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.operation_py3.Operation +name: Operation +fullName: azure.mgmt.edgegateway.models.operation_py3.Operation +module: azure.mgmt.edgegateway.models.operation_py3 +summary: Operations. +constructor: + syntax: 'Operation(*, name: str = None, display=None, origin: str = None, service_specification=None, + **kwargs)' + parameters: + - name: name + description: Name of the operation. + isRequired: true + types: + - + - name: display + description: Properties displayed for the operation. + isRequired: true + types: + - + - name: origin + description: Origin of the operation. + isRequired: true + types: + - + - name: service_specification + description: Service specification. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: display + isRequired: true + - name: origin + isRequired: true + - name: service_specification + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_py3.yml new file mode 100644 index 00000000..67caf52c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.operation_py3 +name: operation_py3 +fullName: azure.mgmt.edgegateway.models.operation_py3 +classes: +- azure.mgmt.edgegateway.models.operation_py3.Operation diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order.Order.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order.Order.yml new file mode 100644 index 00000000..03d9e770 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order.Order.yml @@ -0,0 +1,67 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.order.Order +name: Order +fullName: azure.mgmt.edgegateway.models.order.Order +module: azure.mgmt.edgegateway.models.order +summary: 'The order details. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Order(**kwargs) + parameters: + - name: contact_information + description: Required. The contact details. + isRequired: true + types: + - + - name: shipping_address + description: Required. The shipping address. + isRequired: true + types: + - + - name: current_status + description: Current status of the order. + isRequired: true + types: + - +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: List of status changes in the order. + name: order_history + types: + - [] +- description: Serial number of the device. + name: serial_number + types: + - +- description: 'Tracking information for the package + + delivered to the customer whether it has an original or a replacement + + device.' + name: delivery_tracking_info + types: + - [] +- description: 'Tracking information for the package returned + + from the customer whether it has an original or a replacement device.' + name: return_tracking_info + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order.yml new file mode 100644 index 00000000..100b750e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.order +name: order +fullName: azure.mgmt.edgegateway.models.order +classes: +- azure.mgmt.edgegateway.models.order.Order diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_paged.OrderPaged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_paged.OrderPaged.yml new file mode 100644 index 00000000..d32d346b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_paged.OrderPaged.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.order_paged.OrderPaged +name: OrderPaged +fullName: azure.mgmt.edgegateway.models.order_paged.OrderPaged +module: azure.mgmt.edgegateway.models.order_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: OrderPaged(*args, **kwargs) diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_paged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_paged.yml new file mode 100644 index 00000000..db2d9861 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.order_paged +name: order_paged +fullName: azure.mgmt.edgegateway.models.order_paged +classes: +- azure.mgmt.edgegateway.models.order_paged.OrderPaged diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_py3.Order.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_py3.Order.yml new file mode 100644 index 00000000..bd4635b4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_py3.Order.yml @@ -0,0 +1,74 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.order_py3.Order +name: Order +fullName: azure.mgmt.edgegateway.models.order_py3.Order +module: azure.mgmt.edgegateway.models.order_py3 +summary: 'The order details. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Order(*, contact_information, shipping_address, current_status=None, **kwargs) + parameters: + - name: contact_information + description: Required. The contact details. + isRequired: true + types: + - + - name: shipping_address + description: Required. The shipping address. + isRequired: true + types: + - + - name: current_status + description: Current status of the order. + isRequired: true + types: + - + keywordOnlyParameters: + - name: contact_information + isRequired: true + - name: shipping_address + isRequired: true + - name: current_status + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: List of status changes in the order. + name: order_history + types: + - [] +- description: Serial number of the device. + name: serial_number + types: + - +- description: 'Tracking information for the package + + delivered to the customer whether it has an original or a replacement + + device.' + name: delivery_tracking_info + types: + - [] +- description: 'Tracking information for the package returned + + from the customer whether it has an original or a replacement device.' + name: return_tracking_info + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_py3.yml new file mode 100644 index 00000000..0af0c64a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.order_py3 +name: order_py3 +fullName: azure.mgmt.edgegateway.models.order_py3 +classes: +- azure.mgmt.edgegateway.models.order_py3.Order diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_status.OrderStatus.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_status.OrderStatus.yml new file mode 100644 index 00000000..61c73dc4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_status.OrderStatus.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.order_status.OrderStatus +name: OrderStatus +fullName: azure.mgmt.edgegateway.models.order_status.OrderStatus +module: azure.mgmt.edgegateway.models.order_status +summary: 'Represents a single status change. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: OrderStatus(**kwargs) + parameters: + - name: status + description: 'Required. Status of the order as per the allowed status + + types. Possible values include: ''Untracked'', ''AwaitingFulfilment'', + + ''AwaitingPreparation'', ''AwaitingShipment'', ''Shipped'', ''Arriving'', + + ''Delivered'', ''ReplacementRequested'', ''LostDevice'', ''Declined'', + + ''ReturnInitiated'', ''AwaitingReturnShipment'', ''ShippedBack'', + + ''CollectedAtMicrosoft''' + isRequired: true + types: + - + - + - name: comments + description: Comments related to this status change. + isRequired: true + types: + - +variables: +- description: Time of status update. + name: update_date_time + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_status.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_status.yml new file mode 100644 index 00000000..9640f2f8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_status.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.order_status +name: order_status +fullName: azure.mgmt.edgegateway.models.order_status +classes: +- azure.mgmt.edgegateway.models.order_status.OrderStatus diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_status_py3.OrderStatus.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_status_py3.OrderStatus.yml new file mode 100644 index 00000000..9d0e69bf --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_status_py3.OrderStatus.yml @@ -0,0 +1,48 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.order_status_py3.OrderStatus +name: OrderStatus +fullName: azure.mgmt.edgegateway.models.order_status_py3.OrderStatus +module: azure.mgmt.edgegateway.models.order_status_py3 +summary: 'Represents a single status change. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'OrderStatus(*, status, comments: str = None, **kwargs)' + parameters: + - name: status + description: 'Required. Status of the order as per the allowed status + + types. Possible values include: ''Untracked'', ''AwaitingFulfilment'', + + ''AwaitingPreparation'', ''AwaitingShipment'', ''Shipped'', ''Arriving'', + + ''Delivered'', ''ReplacementRequested'', ''LostDevice'', ''Declined'', + + ''ReturnInitiated'', ''AwaitingReturnShipment'', ''ShippedBack'', + + ''CollectedAtMicrosoft''' + isRequired: true + types: + - + - + - name: comments + description: Comments related to this status change. + isRequired: true + types: + - + keywordOnlyParameters: + - name: status + isRequired: true + - name: comments + isRequired: true +variables: +- description: Time of status update. + name: update_date_time + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_status_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_status_py3.yml new file mode 100644 index 00000000..d77e7527 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_status_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.order_status_py3 +name: order_status_py3 +fullName: azure.mgmt.edgegateway.models.order_status_py3 +classes: +- azure.mgmt.edgegateway.models.order_status_py3.OrderStatus diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_event_trigger.PeriodicTimerEventTrigger.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_event_trigger.PeriodicTimerEventTrigger.yml new file mode 100644 index 00000000..9a279a65 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_event_trigger.PeriodicTimerEventTrigger.yml @@ -0,0 +1,56 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.periodic_timer_event_trigger.PeriodicTimerEventTrigger +name: PeriodicTimerEventTrigger +fullName: azure.mgmt.edgegateway.models.periodic_timer_event_trigger.PeriodicTimerEventTrigger +module: azure.mgmt.edgegateway.models.periodic_timer_event_trigger +summary: 'Trigger details. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: PeriodicTimerEventTrigger(**kwargs) + parameters: + - name: kind + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: source_info + description: Required. Periodic timer details. + isRequired: true + types: + - + - name: sink_info + description: Required. Role Sink information. + isRequired: true + types: + - + - name: custom_context_tag + description: 'A custom context tag typically used to + + correlate the trigger against its usage. For example, if a periodic timer + + trigger is intended for certain specific IoT modules in the device, the + + tag can be the name or the image URL of the module.' + isRequired: true + types: + - +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_event_trigger.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_event_trigger.yml new file mode 100644 index 00000000..8c048005 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_event_trigger.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.periodic_timer_event_trigger +name: periodic_timer_event_trigger +fullName: azure.mgmt.edgegateway.models.periodic_timer_event_trigger +classes: +- azure.mgmt.edgegateway.models.periodic_timer_event_trigger.PeriodicTimerEventTrigger diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_event_trigger_py3.PeriodicTimerEventTrigger.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_event_trigger_py3.PeriodicTimerEventTrigger.yml new file mode 100644 index 00000000..c6352a19 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_event_trigger_py3.PeriodicTimerEventTrigger.yml @@ -0,0 +1,64 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.periodic_timer_event_trigger_py3.PeriodicTimerEventTrigger +name: PeriodicTimerEventTrigger +fullName: azure.mgmt.edgegateway.models.periodic_timer_event_trigger_py3.PeriodicTimerEventTrigger +module: azure.mgmt.edgegateway.models.periodic_timer_event_trigger_py3 +summary: 'Trigger details. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PeriodicTimerEventTrigger(*, source_info, sink_info, custom_context_tag: + str = None, **kwargs)' + parameters: + - name: kind + description: Required. Constant filled by server. + isRequired: true + types: + - + - name: source_info + description: Required. Periodic timer details. + isRequired: true + types: + - + - name: sink_info + description: Required. Role Sink information. + isRequired: true + types: + - + - name: custom_context_tag + description: 'A custom context tag typically used to + + correlate the trigger against its usage. For example, if a periodic timer + + trigger is intended for certain specific IoT modules in the device, the + + tag can be the name or the image URL of the module.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: source_info + isRequired: true + - name: sink_info + isRequired: true + - name: custom_context_tag + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_event_trigger_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_event_trigger_py3.yml new file mode 100644 index 00000000..d102a974 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_event_trigger_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.periodic_timer_event_trigger_py3 +name: periodic_timer_event_trigger_py3 +fullName: azure.mgmt.edgegateway.models.periodic_timer_event_trigger_py3 +classes: +- azure.mgmt.edgegateway.models.periodic_timer_event_trigger_py3.PeriodicTimerEventTrigger diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_source_info.PeriodicTimerSourceInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_source_info.PeriodicTimerSourceInfo.yml new file mode 100644 index 00000000..3148aac2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_source_info.PeriodicTimerSourceInfo.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.periodic_timer_source_info.PeriodicTimerSourceInfo +name: PeriodicTimerSourceInfo +fullName: azure.mgmt.edgegateway.models.periodic_timer_source_info.PeriodicTimerSourceInfo +module: azure.mgmt.edgegateway.models.periodic_timer_source_info +summary: 'Periodic timer event source. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: PeriodicTimerSourceInfo(**kwargs) + parameters: + - name: start_time + description: 'Required. The time of the day that results in a valid + + trigger. Schedule is computed with reference to the time specified up to + + seconds. If timezone is not specified the time will considered to be in + + device timezone. The value will always be returned as UTC time.' + isRequired: true + types: + - + - name: schedule + description: 'Required. Periodic frequency at which timer event needs + + to be raised. Supports daily, hourly, minutes, and seconds.' + isRequired: true + types: + - + - name: topic + description: Topic where periodic events are published to IoT device. + isRequired: true + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_source_info.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_source_info.yml new file mode 100644 index 00000000..14b79646 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_source_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.periodic_timer_source_info +name: periodic_timer_source_info +fullName: azure.mgmt.edgegateway.models.periodic_timer_source_info +classes: +- azure.mgmt.edgegateway.models.periodic_timer_source_info.PeriodicTimerSourceInfo diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_source_info_py3.PeriodicTimerSourceInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_source_info_py3.PeriodicTimerSourceInfo.yml new file mode 100644 index 00000000..0e8858eb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_source_info_py3.PeriodicTimerSourceInfo.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.periodic_timer_source_info_py3.PeriodicTimerSourceInfo +name: PeriodicTimerSourceInfo +fullName: azure.mgmt.edgegateway.models.periodic_timer_source_info_py3.PeriodicTimerSourceInfo +module: azure.mgmt.edgegateway.models.periodic_timer_source_info_py3 +summary: 'Periodic timer event source. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PeriodicTimerSourceInfo(*, start_time, schedule: str, topic: str = None, + **kwargs)' + parameters: + - name: start_time + description: 'Required. The time of the day that results in a valid + + trigger. Schedule is computed with reference to the time specified up to + + seconds. If timezone is not specified the time will considered to be in + + device timezone. The value will always be returned as UTC time.' + isRequired: true + types: + - + - name: schedule + description: 'Required. Periodic frequency at which timer event needs + + to be raised. Supports daily, hourly, minutes, and seconds.' + isRequired: true + types: + - + - name: topic + description: Topic where periodic events are published to IoT device. + isRequired: true + types: + - + keywordOnlyParameters: + - name: start_time + isRequired: true + - name: schedule + isRequired: true + - name: topic + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_source_info_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_source_info_py3.yml new file mode 100644 index 00000000..4c083cc5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_source_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.periodic_timer_source_info_py3 +name: periodic_timer_source_info_py3 +fullName: azure.mgmt.edgegateway.models.periodic_timer_source_info_py3 +classes: +- azure.mgmt.edgegateway.models.periodic_timer_source_info_py3.PeriodicTimerSourceInfo diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.refresh_details.RefreshDetails.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.refresh_details.RefreshDetails.yml new file mode 100644 index 00000000..4e05e38b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.refresh_details.RefreshDetails.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.refresh_details.RefreshDetails +name: RefreshDetails +fullName: azure.mgmt.edgegateway.models.refresh_details.RefreshDetails +module: azure.mgmt.edgegateway.models.refresh_details +summary: Fields for tracking refresh job on the share. +constructor: + syntax: RefreshDetails(**kwargs) + parameters: + - name: in_progress_refresh_job_id + description: 'If a refresh share job is currently in + + progress on this share, this field indicates the ARM resource ID of that + + job. The field is empty if no job is in progress.' + isRequired: true + types: + - + - name: last_completed_refresh_job_time_in_utc + description: 'Indicates the completed + + time for the last refresh job on this particular share, if any.This could + + be a failed job or a successful job.' + isRequired: true + types: + - + - name: error_manifest_file + description: 'Indicates the relative path of the error xml + + for the last refresh job on this particular share, if any. This could be a + + failed job or a successful job.' + isRequired: true + types: + - + - name: last_job + description: 'Indicates the id of the last refresh job on this + + particular share,if any. This could be a failed job or a successful job.' + isRequired: true + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.refresh_details.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.refresh_details.yml new file mode 100644 index 00000000..a7aca7b9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.refresh_details.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.refresh_details +name: refresh_details +fullName: azure.mgmt.edgegateway.models.refresh_details +classes: +- azure.mgmt.edgegateway.models.refresh_details.RefreshDetails diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.refresh_details_py3.RefreshDetails.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.refresh_details_py3.RefreshDetails.yml new file mode 100644 index 00000000..7f0d2467 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.refresh_details_py3.RefreshDetails.yml @@ -0,0 +1,53 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.refresh_details_py3.RefreshDetails +name: RefreshDetails +fullName: azure.mgmt.edgegateway.models.refresh_details_py3.RefreshDetails +module: azure.mgmt.edgegateway.models.refresh_details_py3 +summary: Fields for tracking refresh job on the share. +constructor: + syntax: 'RefreshDetails(*, in_progress_refresh_job_id: str = None, last_completed_refresh_job_time_in_utc=None, + error_manifest_file: str = None, last_job: str = None, **kwargs)' + parameters: + - name: in_progress_refresh_job_id + description: 'If a refresh share job is currently in + + progress on this share, this field indicates the ARM resource ID of that + + job. The field is empty if no job is in progress.' + isRequired: true + types: + - + - name: last_completed_refresh_job_time_in_utc + description: 'Indicates the completed + + time for the last refresh job on this particular share, if any.This could + + be a failed job or a successful job.' + isRequired: true + types: + - + - name: error_manifest_file + description: 'Indicates the relative path of the error xml + + for the last refresh job on this particular share, if any. This could be a + + failed job or a successful job.' + isRequired: true + types: + - + - name: last_job + description: 'Indicates the id of the last refresh job on this + + particular share,if any. This could be a failed job or a successful job.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: in_progress_refresh_job_id + isRequired: true + - name: last_completed_refresh_job_time_in_utc + isRequired: true + - name: error_manifest_file + isRequired: true + - name: last_job + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.refresh_details_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.refresh_details_py3.yml new file mode 100644 index 00000000..b2422bba --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.refresh_details_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.refresh_details_py3 +name: refresh_details_py3 +fullName: azure.mgmt.edgegateway.models.refresh_details_py3 +classes: +- azure.mgmt.edgegateway.models.refresh_details_py3.RefreshDetails diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role.Role.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role.Role.yml new file mode 100644 index 00000000..4d2b4d16 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role.Role.yml @@ -0,0 +1,40 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.role.Role +name: Role +fullName: azure.mgmt.edgegateway.models.role.Role +module: azure.mgmt.edgegateway.models.role +summary: 'Compute role. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: IoTRole + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Role(**kwargs) + parameters: + - name: kind + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role.yml new file mode 100644 index 00000000..090437c4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.role +name: role +fullName: azure.mgmt.edgegateway.models.role +classes: +- azure.mgmt.edgegateway.models.role.Role diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_paged.RolePaged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_paged.RolePaged.yml new file mode 100644 index 00000000..db81cd3a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_paged.RolePaged.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.role_paged.RolePaged +name: RolePaged +fullName: azure.mgmt.edgegateway.models.role_paged.RolePaged +module: azure.mgmt.edgegateway.models.role_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: RolePaged(*args, **kwargs) diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_paged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_paged.yml new file mode 100644 index 00000000..87c6a615 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.role_paged +name: role_paged +fullName: azure.mgmt.edgegateway.models.role_paged +classes: +- azure.mgmt.edgegateway.models.role_paged.RolePaged diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_py3.Role.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_py3.Role.yml new file mode 100644 index 00000000..9c038f1c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_py3.Role.yml @@ -0,0 +1,40 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.role_py3.Role +name: Role +fullName: azure.mgmt.edgegateway.models.role_py3.Role +module: azure.mgmt.edgegateway.models.role_py3 +summary: 'Compute role. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: IoTRole + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Role(**kwargs) + parameters: + - name: kind + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_py3.yml new file mode 100644 index 00000000..473ec629 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.role_py3 +name: role_py3 +fullName: azure.mgmt.edgegateway.models.role_py3 +classes: +- azure.mgmt.edgegateway.models.role_py3.Role diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_sink_info.RoleSinkInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_sink_info.RoleSinkInfo.yml new file mode 100644 index 00000000..a799a731 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_sink_info.RoleSinkInfo.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.role_sink_info.RoleSinkInfo +name: RoleSinkInfo +fullName: azure.mgmt.edgegateway.models.role_sink_info.RoleSinkInfo +module: azure.mgmt.edgegateway.models.role_sink_info +summary: 'Compute role against which events will be raised. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: RoleSinkInfo(**kwargs) + parameters: + - name: role_id + description: Required. Compute role ID. + isRequired: true + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_sink_info.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_sink_info.yml new file mode 100644 index 00000000..43326dc5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_sink_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.role_sink_info +name: role_sink_info +fullName: azure.mgmt.edgegateway.models.role_sink_info +classes: +- azure.mgmt.edgegateway.models.role_sink_info.RoleSinkInfo diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_sink_info_py3.RoleSinkInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_sink_info_py3.RoleSinkInfo.yml new file mode 100644 index 00000000..a562bace --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_sink_info_py3.RoleSinkInfo.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.role_sink_info_py3.RoleSinkInfo +name: RoleSinkInfo +fullName: azure.mgmt.edgegateway.models.role_sink_info_py3.RoleSinkInfo +module: azure.mgmt.edgegateway.models.role_sink_info_py3 +summary: 'Compute role against which events will be raised. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RoleSinkInfo(*, role_id: str, **kwargs)' + parameters: + - name: role_id + description: Required. Compute role ID. + isRequired: true + types: + - + keywordOnlyParameters: + - name: role_id + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_sink_info_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_sink_info_py3.yml new file mode 100644 index 00000000..a4b7ae43 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.role_sink_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.role_sink_info_py3 +name: role_sink_info_py3 +fullName: azure.mgmt.edgegateway.models.role_sink_info_py3 +classes: +- azure.mgmt.edgegateway.models.role_sink_info_py3.RoleSinkInfo diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.security_settings.SecuritySettings.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.security_settings.SecuritySettings.yml new file mode 100644 index 00000000..1583af86 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.security_settings.SecuritySettings.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.security_settings.SecuritySettings +name: SecuritySettings +fullName: azure.mgmt.edgegateway.models.security_settings.SecuritySettings +module: azure.mgmt.edgegateway.models.security_settings +summary: 'The security settings of a device. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: SecuritySettings(**kwargs) + parameters: + - name: device_admin_password + description: 'Required. Device administrator password as + + an encrypted string (encrypted using RSA PKCS #1) is used to sign into the + + local web UI of the device. The Actual password should have at least 8 + + characters that are a combination of uppercase, lowercase, numeric, and + + special characters.' + isRequired: true + types: + - +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.security_settings.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.security_settings.yml new file mode 100644 index 00000000..b21e2943 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.security_settings.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.security_settings +name: security_settings +fullName: azure.mgmt.edgegateway.models.security_settings +classes: +- azure.mgmt.edgegateway.models.security_settings.SecuritySettings diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.security_settings_py3.SecuritySettings.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.security_settings_py3.SecuritySettings.yml new file mode 100644 index 00000000..4fa5308e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.security_settings_py3.SecuritySettings.yml @@ -0,0 +1,46 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.security_settings_py3.SecuritySettings +name: SecuritySettings +fullName: azure.mgmt.edgegateway.models.security_settings_py3.SecuritySettings +module: azure.mgmt.edgegateway.models.security_settings_py3 +summary: 'The security settings of a device. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: SecuritySettings(*, device_admin_password, **kwargs) + parameters: + - name: device_admin_password + description: 'Required. Device administrator password as + + an encrypted string (encrypted using RSA PKCS #1) is used to sign into the + + local web UI of the device. The Actual password should have at least 8 + + characters that are a combination of uppercase, lowercase, numeric, and + + special characters.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: device_admin_password + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.security_settings_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.security_settings_py3.yml new file mode 100644 index 00000000..04ac91f9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.security_settings_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.security_settings_py3 +name: security_settings_py3 +fullName: azure.mgmt.edgegateway.models.security_settings_py3 +classes: +- azure.mgmt.edgegateway.models.security_settings_py3.SecuritySettings diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.service_specification.ServiceSpecification.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.service_specification.ServiceSpecification.yml new file mode 100644 index 00000000..43c4b468 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.service_specification.ServiceSpecification.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.service_specification.ServiceSpecification +name: ServiceSpecification +fullName: azure.mgmt.edgegateway.models.service_specification.ServiceSpecification +module: azure.mgmt.edgegateway.models.service_specification +summary: Service specification. +constructor: + syntax: ServiceSpecification(**kwargs) + parameters: + - name: metric_specifications + description: Metric specification as defined by shoebox. + isRequired: true + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.service_specification.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.service_specification.yml new file mode 100644 index 00000000..47c1bf7d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.service_specification.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.service_specification +name: service_specification +fullName: azure.mgmt.edgegateway.models.service_specification +classes: +- azure.mgmt.edgegateway.models.service_specification.ServiceSpecification diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.service_specification_py3.ServiceSpecification.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.service_specification_py3.ServiceSpecification.yml new file mode 100644 index 00000000..e10833aa --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.service_specification_py3.ServiceSpecification.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.service_specification_py3.ServiceSpecification +name: ServiceSpecification +fullName: azure.mgmt.edgegateway.models.service_specification_py3.ServiceSpecification +module: azure.mgmt.edgegateway.models.service_specification_py3 +summary: Service specification. +constructor: + syntax: ServiceSpecification(*, metric_specifications=None, **kwargs) + parameters: + - name: metric_specifications + description: Metric specification as defined by shoebox. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: metric_specifications + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.service_specification_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.service_specification_py3.yml new file mode 100644 index 00000000..e5e27d63 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.service_specification_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.service_specification_py3 +name: service_specification_py3 +fullName: azure.mgmt.edgegateway.models.service_specification_py3 +classes: +- azure.mgmt.edgegateway.models.service_specification_py3.ServiceSpecification diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share.Share.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share.Share.yml new file mode 100644 index 00000000..f9e0beb1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share.Share.yml @@ -0,0 +1,95 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.share.Share +name: Share +fullName: azure.mgmt.edgegateway.models.share.Share +module: azure.mgmt.edgegateway.models.share +summary: 'Represents a share on the Data Box Edge/Gateway device. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Share(**kwargs) + parameters: + - name: description + description: Description for the share. + isRequired: true + types: + - + - name: share_status + description: 'Required. Current status of the share. Possible + + values include: ''Online'', ''Offline''' + isRequired: true + types: + - + - + - name: monitoring_status + description: 'Required. Current monitoring status of the + + share. Possible values include: ''Enabled'', ''Disabled''' + isRequired: true + types: + - + - + - name: azure_container_info + description: Azure container mapping for the share. + isRequired: true + types: + - + - name: access_protocol + description: 'Required. Access protocol to be used by the share. + + Possible values include: ''SMB'', ''NFS''' + isRequired: true + types: + - + - + - name: user_access_rights + description: 'Mapping of users and corresponding access + + rights on the share (required for SMB protocol).' + isRequired: true + types: + - [] + - name: client_access_rights + description: 'List of IP addresses and corresponding access + + rights on the share(required for NFS protocol).' + isRequired: true + types: + - [] + - name: refresh_details + description: Details of the refresh job on this share. + isRequired: true + types: + - + - name: data_policy + description: 'Data policy of the share. Possible values include: + + ''Cloud'', ''Local''' + isRequired: true + types: + - + - +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: Share mount point to the role. + name: share_mappings + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share.yml new file mode 100644 index 00000000..6b986ead --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.share +name: share +fullName: azure.mgmt.edgegateway.models.share +classes: +- azure.mgmt.edgegateway.models.share.Share diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_access_right.ShareAccessRight.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_access_right.ShareAccessRight.yml new file mode 100644 index 00000000..a99bc58c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_access_right.ShareAccessRight.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.share_access_right.ShareAccessRight +name: ShareAccessRight +fullName: azure.mgmt.edgegateway.models.share_access_right.ShareAccessRight +module: azure.mgmt.edgegateway.models.share_access_right +summary: 'Specifies the mapping between this particular user and the type of access + + he has on shares on this device. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: ShareAccessRight(**kwargs) + parameters: + - name: share_id + description: Required. The share ID. + isRequired: true + types: + - + - name: access_type + description: 'Required. Type of access to be allowed on the share + + for this user. Possible values include: ''Change'', ''Read'', ''Custom''' + isRequired: true + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_access_right.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_access_right.yml new file mode 100644 index 00000000..502e0183 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_access_right.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.share_access_right +name: share_access_right +fullName: azure.mgmt.edgegateway.models.share_access_right +classes: +- azure.mgmt.edgegateway.models.share_access_right.ShareAccessRight diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_access_right_py3.ShareAccessRight.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_access_right_py3.ShareAccessRight.yml new file mode 100644 index 00000000..a8bd2280 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_access_right_py3.ShareAccessRight.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.share_access_right_py3.ShareAccessRight +name: ShareAccessRight +fullName: azure.mgmt.edgegateway.models.share_access_right_py3.ShareAccessRight +module: azure.mgmt.edgegateway.models.share_access_right_py3 +summary: 'Specifies the mapping between this particular user and the type of access + + he has on shares on this device. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ShareAccessRight(*, share_id: str, access_type, **kwargs)' + parameters: + - name: share_id + description: Required. The share ID. + isRequired: true + types: + - + - name: access_type + description: 'Required. Type of access to be allowed on the share + + for this user. Possible values include: ''Change'', ''Read'', ''Custom''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: share_id + isRequired: true + - name: access_type + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_access_right_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_access_right_py3.yml new file mode 100644 index 00000000..ebf43ff0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_access_right_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.share_access_right_py3 +name: share_access_right_py3 +fullName: azure.mgmt.edgegateway.models.share_access_right_py3 +classes: +- azure.mgmt.edgegateway.models.share_access_right_py3.ShareAccessRight diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_paged.SharePaged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_paged.SharePaged.yml new file mode 100644 index 00000000..072f7d5c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_paged.SharePaged.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.share_paged.SharePaged +name: SharePaged +fullName: azure.mgmt.edgegateway.models.share_paged.SharePaged +module: azure.mgmt.edgegateway.models.share_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: SharePaged(*args, **kwargs) diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_paged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_paged.yml new file mode 100644 index 00000000..392a1452 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.share_paged +name: share_paged +fullName: azure.mgmt.edgegateway.models.share_paged +classes: +- azure.mgmt.edgegateway.models.share_paged.SharePaged diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_py3.Share.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_py3.Share.yml new file mode 100644 index 00000000..56b59ebd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_py3.Share.yml @@ -0,0 +1,116 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.share_py3.Share +name: Share +fullName: azure.mgmt.edgegateway.models.share_py3.Share +module: azure.mgmt.edgegateway.models.share_py3 +summary: 'Represents a share on the Data Box Edge/Gateway device. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Share(*, share_status, monitoring_status, access_protocol, description: + str = None, azure_container_info=None, user_access_rights=None, client_access_rights=None, + refresh_details=None, data_policy=None, **kwargs)' + parameters: + - name: description + description: Description for the share. + isRequired: true + types: + - + - name: share_status + description: 'Required. Current status of the share. Possible + + values include: ''Online'', ''Offline''' + isRequired: true + types: + - + - + - name: monitoring_status + description: 'Required. Current monitoring status of the + + share. Possible values include: ''Enabled'', ''Disabled''' + isRequired: true + types: + - + - + - name: azure_container_info + description: Azure container mapping for the share. + isRequired: true + types: + - + - name: access_protocol + description: 'Required. Access protocol to be used by the share. + + Possible values include: ''SMB'', ''NFS''' + isRequired: true + types: + - + - + - name: user_access_rights + description: 'Mapping of users and corresponding access + + rights on the share (required for SMB protocol).' + isRequired: true + types: + - [] + - name: client_access_rights + description: 'List of IP addresses and corresponding access + + rights on the share(required for NFS protocol).' + isRequired: true + types: + - [] + - name: refresh_details + description: Details of the refresh job on this share. + isRequired: true + types: + - + - name: data_policy + description: 'Data policy of the share. Possible values include: + + ''Cloud'', ''Local''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: share_status + isRequired: true + - name: monitoring_status + isRequired: true + - name: access_protocol + isRequired: true + - name: description + isRequired: true + - name: azure_container_info + isRequired: true + - name: user_access_rights + isRequired: true + - name: client_access_rights + isRequired: true + - name: refresh_details + isRequired: true + - name: data_policy + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: Share mount point to the role. + name: share_mappings + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_py3.yml new file mode 100644 index 00000000..1fdca8c0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.share_py3 +name: share_py3 +fullName: azure.mgmt.edgegateway.models.share_py3 +classes: +- azure.mgmt.edgegateway.models.share_py3.Share diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.sku.Sku.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.sku.Sku.yml new file mode 100644 index 00000000..f986ba34 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.sku.Sku.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.sku.Sku +name: Sku +fullName: azure.mgmt.edgegateway.models.sku.Sku +module: azure.mgmt.edgegateway.models.sku +summary: The SKU type. +constructor: + syntax: Sku(**kwargs) + parameters: + - name: name + description: 'SKU name. Possible values include: ''Gateway'', ''Edge''' + isRequired: true + types: + - + - + - name: tier + description: 'The SKU tier. This is based on the SKU name. Possible values + + include: ''Standard''' + isRequired: true + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.sku.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.sku.yml new file mode 100644 index 00000000..bf159002 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.sku.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.sku +name: sku +fullName: azure.mgmt.edgegateway.models.sku +classes: +- azure.mgmt.edgegateway.models.sku.Sku diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.sku_py3.Sku.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.sku_py3.Sku.yml new file mode 100644 index 00000000..6381cf15 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.sku_py3.Sku.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.sku_py3.Sku +name: Sku +fullName: azure.mgmt.edgegateway.models.sku_py3.Sku +module: azure.mgmt.edgegateway.models.sku_py3 +summary: The SKU type. +constructor: + syntax: Sku(*, name=None, tier=None, **kwargs) + parameters: + - name: name + description: 'SKU name. Possible values include: ''Gateway'', ''Edge''' + isRequired: true + types: + - + - + - name: tier + description: 'The SKU tier. This is based on the SKU name. Possible values + + include: ''Standard''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: tier + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.sku_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.sku_py3.yml new file mode 100644 index 00000000..64751a6a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.sku_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.sku_py3 +name: sku_py3 +fullName: azure.mgmt.edgegateway.models.sku_py3 +classes: +- azure.mgmt.edgegateway.models.sku_py3.Sku diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential.StorageAccountCredential.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential.StorageAccountCredential.yml new file mode 100644 index 00000000..1bacbcf6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential.StorageAccountCredential.yml @@ -0,0 +1,73 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.storage_account_credential.StorageAccountCredential +name: StorageAccountCredential +fullName: azure.mgmt.edgegateway.models.storage_account_credential.StorageAccountCredential +module: azure.mgmt.edgegateway.models.storage_account_credential +summary: 'The storage account credential. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: StorageAccountCredential(**kwargs) + parameters: + - name: alias + description: Required. Alias for the storage account. + isRequired: true + types: + - + - name: user_name + description: Username for the storage account. + isRequired: true + types: + - + - name: account_key + description: Encrypted storage key. + isRequired: true + types: + - + - name: connection_string + description: 'Connection string for the storage account. Use + + this string if username and account key are not specified.' + isRequired: true + types: + - + - name: ssl_status + description: 'Required. Signifies whether SSL needs to be enabled or + + not. Possible values include: ''Enabled'', ''Disabled''' + isRequired: true + types: + - + - + - name: blob_domain_name + description: Blob end point for private clouds. + isRequired: true + types: + - + - name: account_type + description: 'Required. Type of storage accessed on the storage + + account. Possible values include: ''GeneralPurposeStorage'', ''BlobStorage''' + isRequired: true + types: + - + - +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential.yml new file mode 100644 index 00000000..5b248845 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.storage_account_credential +name: storage_account_credential +fullName: azure.mgmt.edgegateway.models.storage_account_credential +classes: +- azure.mgmt.edgegateway.models.storage_account_credential.StorageAccountCredential diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential_paged.StorageAccountCredentialPaged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential_paged.StorageAccountCredentialPaged.yml new file mode 100644 index 00000000..a34f26df --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential_paged.StorageAccountCredentialPaged.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.storage_account_credential_paged.StorageAccountCredentialPaged +name: StorageAccountCredentialPaged +fullName: azure.mgmt.edgegateway.models.storage_account_credential_paged.StorageAccountCredentialPaged +module: azure.mgmt.edgegateway.models.storage_account_credential_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: StorageAccountCredentialPaged(*args, **kwargs) diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential_paged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential_paged.yml new file mode 100644 index 00000000..2faa7b67 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.storage_account_credential_paged +name: storage_account_credential_paged +fullName: azure.mgmt.edgegateway.models.storage_account_credential_paged +classes: +- azure.mgmt.edgegateway.models.storage_account_credential_paged.StorageAccountCredentialPaged diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential_py3.StorageAccountCredential.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential_py3.StorageAccountCredential.yml new file mode 100644 index 00000000..b74e6334 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential_py3.StorageAccountCredential.yml @@ -0,0 +1,90 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.storage_account_credential_py3.StorageAccountCredential +name: StorageAccountCredential +fullName: azure.mgmt.edgegateway.models.storage_account_credential_py3.StorageAccountCredential +module: azure.mgmt.edgegateway.models.storage_account_credential_py3 +summary: 'The storage account credential. + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'StorageAccountCredential(*, alias: str, ssl_status, account_type, user_name: + str = None, account_key=None, connection_string: str = None, blob_domain_name: + str = None, **kwargs)' + parameters: + - name: alias + description: Required. Alias for the storage account. + isRequired: true + types: + - + - name: user_name + description: Username for the storage account. + isRequired: true + types: + - + - name: account_key + description: Encrypted storage key. + isRequired: true + types: + - + - name: connection_string + description: 'Connection string for the storage account. Use + + this string if username and account key are not specified.' + isRequired: true + types: + - + - name: ssl_status + description: 'Required. Signifies whether SSL needs to be enabled or + + not. Possible values include: ''Enabled'', ''Disabled''' + isRequired: true + types: + - + - + - name: blob_domain_name + description: Blob end point for private clouds. + isRequired: true + types: + - + - name: account_type + description: 'Required. Type of storage accessed on the storage + + account. Possible values include: ''GeneralPurposeStorage'', ''BlobStorage''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: alias + isRequired: true + - name: ssl_status + isRequired: true + - name: account_type + isRequired: true + - name: user_name + isRequired: true + - name: account_key + isRequired: true + - name: connection_string + isRequired: true + - name: blob_domain_name + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential_py3.yml new file mode 100644 index 00000000..2160033e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.storage_account_credential_py3 +name: storage_account_credential_py3 +fullName: azure.mgmt.edgegateway.models.storage_account_credential_py3 +classes: +- azure.mgmt.edgegateway.models.storage_account_credential_py3.StorageAccountCredential diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.symmetric_key.SymmetricKey.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.symmetric_key.SymmetricKey.yml new file mode 100644 index 00000000..ea6c032a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.symmetric_key.SymmetricKey.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.symmetric_key.SymmetricKey +name: SymmetricKey +fullName: azure.mgmt.edgegateway.models.symmetric_key.SymmetricKey +module: azure.mgmt.edgegateway.models.symmetric_key +summary: Symmetric key for authentication. +constructor: + syntax: SymmetricKey(**kwargs) + parameters: + - name: connection_string + description: Connection string based on the symmetric key. + isRequired: true + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.symmetric_key.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.symmetric_key.yml new file mode 100644 index 00000000..3401a625 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.symmetric_key.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.symmetric_key +name: symmetric_key +fullName: azure.mgmt.edgegateway.models.symmetric_key +classes: +- azure.mgmt.edgegateway.models.symmetric_key.SymmetricKey diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.symmetric_key_py3.SymmetricKey.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.symmetric_key_py3.SymmetricKey.yml new file mode 100644 index 00000000..56a323a0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.symmetric_key_py3.SymmetricKey.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.symmetric_key_py3.SymmetricKey +name: SymmetricKey +fullName: azure.mgmt.edgegateway.models.symmetric_key_py3.SymmetricKey +module: azure.mgmt.edgegateway.models.symmetric_key_py3 +summary: Symmetric key for authentication. +constructor: + syntax: SymmetricKey(*, connection_string=None, **kwargs) + parameters: + - name: connection_string + description: Connection string based on the symmetric key. + isRequired: true + types: + - + keywordOnlyParameters: + - name: connection_string + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.symmetric_key_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.symmetric_key_py3.yml new file mode 100644 index 00000000..76800778 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.symmetric_key_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.symmetric_key_py3 +name: symmetric_key_py3 +fullName: azure.mgmt.edgegateway.models.symmetric_key_py3 +classes: +- azure.mgmt.edgegateway.models.symmetric_key_py3.SymmetricKey diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.tracking_info.TrackingInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.tracking_info.TrackingInfo.yml new file mode 100644 index 00000000..554f78b4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.tracking_info.TrackingInfo.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.tracking_info.TrackingInfo +name: TrackingInfo +fullName: azure.mgmt.edgegateway.models.tracking_info.TrackingInfo +module: azure.mgmt.edgegateway.models.tracking_info +summary: Tracking courier information. +constructor: + syntax: TrackingInfo(**kwargs) + parameters: + - name: serial_number + description: Serial number of the device being tracked. + isRequired: true + types: + - + - name: carrier_name + description: Name of the carrier used in the delivery. + isRequired: true + types: + - + - name: tracking_id + description: Tracking ID of the shipment. + isRequired: true + types: + - + - name: tracking_url + description: Tracking URL of the shipment. + isRequired: true + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.tracking_info.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.tracking_info.yml new file mode 100644 index 00000000..35241248 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.tracking_info.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.tracking_info +name: tracking_info +fullName: azure.mgmt.edgegateway.models.tracking_info +classes: +- azure.mgmt.edgegateway.models.tracking_info.TrackingInfo diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.tracking_info_py3.TrackingInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.tracking_info_py3.TrackingInfo.yml new file mode 100644 index 00000000..246c1328 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.tracking_info_py3.TrackingInfo.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.tracking_info_py3.TrackingInfo +name: TrackingInfo +fullName: azure.mgmt.edgegateway.models.tracking_info_py3.TrackingInfo +module: azure.mgmt.edgegateway.models.tracking_info_py3 +summary: Tracking courier information. +constructor: + syntax: 'TrackingInfo(*, serial_number: str = None, carrier_name: str = None, tracking_id: + str = None, tracking_url: str = None, **kwargs)' + parameters: + - name: serial_number + description: Serial number of the device being tracked. + isRequired: true + types: + - + - name: carrier_name + description: Name of the carrier used in the delivery. + isRequired: true + types: + - + - name: tracking_id + description: Tracking ID of the shipment. + isRequired: true + types: + - + - name: tracking_url + description: Tracking URL of the shipment. + isRequired: true + types: + - + keywordOnlyParameters: + - name: serial_number + isRequired: true + - name: carrier_name + isRequired: true + - name: tracking_id + isRequired: true + - name: tracking_url + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.tracking_info_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.tracking_info_py3.yml new file mode 100644 index 00000000..61c04c40 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.tracking_info_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.tracking_info_py3 +name: tracking_info_py3 +fullName: azure.mgmt.edgegateway.models.tracking_info_py3 +classes: +- azure.mgmt.edgegateway.models.tracking_info_py3.TrackingInfo diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger.Trigger.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger.Trigger.yml new file mode 100644 index 00000000..11099d17 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger.Trigger.yml @@ -0,0 +1,40 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.trigger.Trigger +name: Trigger +fullName: azure.mgmt.edgegateway.models.trigger.Trigger +module: azure.mgmt.edgegateway.models.trigger +summary: 'Trigger details. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: FileEventTrigger, PeriodicTimerEventTrigger + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Trigger(**kwargs) + parameters: + - name: kind + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger.yml new file mode 100644 index 00000000..af64d204 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.trigger +name: trigger +fullName: azure.mgmt.edgegateway.models.trigger +classes: +- azure.mgmt.edgegateway.models.trigger.Trigger diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger_paged.TriggerPaged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger_paged.TriggerPaged.yml new file mode 100644 index 00000000..0ebb5fde --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger_paged.TriggerPaged.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.trigger_paged.TriggerPaged +name: TriggerPaged +fullName: azure.mgmt.edgegateway.models.trigger_paged.TriggerPaged +module: azure.mgmt.edgegateway.models.trigger_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: TriggerPaged(*args, **kwargs) diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger_paged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger_paged.yml new file mode 100644 index 00000000..e6d7e030 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.trigger_paged +name: trigger_paged +fullName: azure.mgmt.edgegateway.models.trigger_paged +classes: +- azure.mgmt.edgegateway.models.trigger_paged.TriggerPaged diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger_py3.Trigger.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger_py3.Trigger.yml new file mode 100644 index 00000000..c12c757c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger_py3.Trigger.yml @@ -0,0 +1,40 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.trigger_py3.Trigger +name: Trigger +fullName: azure.mgmt.edgegateway.models.trigger_py3.Trigger +module: azure.mgmt.edgegateway.models.trigger_py3 +summary: 'Trigger details. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: FileEventTrigger, PeriodicTimerEventTrigger + + + Variables are only populated by the server, and will be ignored when + + sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: Trigger(**kwargs) + parameters: + - name: kind + description: Required. Constant filled by server. + isRequired: true + types: + - +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger_py3.yml new file mode 100644 index 00000000..960ce10b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.trigger_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.trigger_py3 +name: trigger_py3 +fullName: azure.mgmt.edgegateway.models.trigger_py3 +classes: +- azure.mgmt.edgegateway.models.trigger_py3.Trigger diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_download_progress.UpdateDownloadProgress.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_download_progress.UpdateDownloadProgress.yml new file mode 100644 index 00000000..9783eff1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_download_progress.UpdateDownloadProgress.yml @@ -0,0 +1,41 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.update_download_progress.UpdateDownloadProgress +name: UpdateDownloadProgress +fullName: azure.mgmt.edgegateway.models.update_download_progress.UpdateDownloadProgress +module: azure.mgmt.edgegateway.models.update_download_progress +summary: 'Details about the download progress of update. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: UpdateDownloadProgress(**kwargs) +variables: +- description: 'The download phase. Possible values include: + + ''Unknown'', ''Initializing'', ''Downloading'', ''Verifying''' + name: download_phase + types: + - + - +- description: Percentage of completion. + name: percent_complete + types: + - +- description: Total bytes to download. + name: total_bytes_to_download + types: + - +- description: Total bytes downloaded. + name: total_bytes_downloaded + types: + - +- description: Number of updates to download. + name: number_of_updates_to_download + types: + - +- description: Number of updates downloaded. + name: number_of_updates_downloaded + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_download_progress.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_download_progress.yml new file mode 100644 index 00000000..d9eabd3b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_download_progress.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.update_download_progress +name: update_download_progress +fullName: azure.mgmt.edgegateway.models.update_download_progress +classes: +- azure.mgmt.edgegateway.models.update_download_progress.UpdateDownloadProgress diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_download_progress_py3.UpdateDownloadProgress.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_download_progress_py3.UpdateDownloadProgress.yml new file mode 100644 index 00000000..9206acf8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_download_progress_py3.UpdateDownloadProgress.yml @@ -0,0 +1,41 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.update_download_progress_py3.UpdateDownloadProgress +name: UpdateDownloadProgress +fullName: azure.mgmt.edgegateway.models.update_download_progress_py3.UpdateDownloadProgress +module: azure.mgmt.edgegateway.models.update_download_progress_py3 +summary: 'Details about the download progress of update. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: UpdateDownloadProgress(**kwargs) +variables: +- description: 'The download phase. Possible values include: + + ''Unknown'', ''Initializing'', ''Downloading'', ''Verifying''' + name: download_phase + types: + - + - +- description: Percentage of completion. + name: percent_complete + types: + - +- description: Total bytes to download. + name: total_bytes_to_download + types: + - +- description: Total bytes downloaded. + name: total_bytes_downloaded + types: + - +- description: Number of updates to download. + name: number_of_updates_to_download + types: + - +- description: Number of updates downloaded. + name: number_of_updates_downloaded + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_download_progress_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_download_progress_py3.yml new file mode 100644 index 00000000..a2cfa0b6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_download_progress_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.update_download_progress_py3 +name: update_download_progress_py3 +fullName: azure.mgmt.edgegateway.models.update_download_progress_py3 +classes: +- azure.mgmt.edgegateway.models.update_download_progress_py3.UpdateDownloadProgress diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_install_progress.UpdateInstallProgress.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_install_progress.UpdateInstallProgress.yml new file mode 100644 index 00000000..6ce99963 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_install_progress.UpdateInstallProgress.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.update_install_progress.UpdateInstallProgress +name: UpdateInstallProgress +fullName: azure.mgmt.edgegateway.models.update_install_progress.UpdateInstallProgress +module: azure.mgmt.edgegateway.models.update_install_progress +summary: 'Progress details during installation of updates. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: UpdateInstallProgress(**kwargs) +variables: +- description: Percentage completed. + name: percent_complete + types: + - +- description: Number of updates to install. + name: number_of_updates_to_install + types: + - +- description: Number of updates installed. + name: number_of_updates_installed + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_install_progress.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_install_progress.yml new file mode 100644 index 00000000..618fd8dd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_install_progress.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.update_install_progress +name: update_install_progress +fullName: azure.mgmt.edgegateway.models.update_install_progress +classes: +- azure.mgmt.edgegateway.models.update_install_progress.UpdateInstallProgress diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_install_progress_py3.UpdateInstallProgress.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_install_progress_py3.UpdateInstallProgress.yml new file mode 100644 index 00000000..ae1d5112 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_install_progress_py3.UpdateInstallProgress.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.update_install_progress_py3.UpdateInstallProgress +name: UpdateInstallProgress +fullName: azure.mgmt.edgegateway.models.update_install_progress_py3.UpdateInstallProgress +module: azure.mgmt.edgegateway.models.update_install_progress_py3 +summary: 'Progress details during installation of updates. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: UpdateInstallProgress(**kwargs) +variables: +- description: Percentage completed. + name: percent_complete + types: + - +- description: Number of updates to install. + name: number_of_updates_to_install + types: + - +- description: Number of updates installed. + name: number_of_updates_installed + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_install_progress_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_install_progress_py3.yml new file mode 100644 index 00000000..e4ce7850 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_install_progress_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.update_install_progress_py3 +name: update_install_progress_py3 +fullName: azure.mgmt.edgegateway.models.update_install_progress_py3 +classes: +- azure.mgmt.edgegateway.models.update_install_progress_py3.UpdateInstallProgress diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_summary.UpdateSummary.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_summary.UpdateSummary.yml new file mode 100644 index 00000000..bfad7648 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_summary.UpdateSummary.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.update_summary.UpdateSummary +name: UpdateSummary +fullName: azure.mgmt.edgegateway.models.update_summary.UpdateSummary +module: azure.mgmt.edgegateway.models.update_summary +summary: 'Details about ongoing updates and availability of updates on the device. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: UpdateSummary(**kwargs) + parameters: + - name: device_version_number + description: 'The current version of the device in format: + + 1.2.17312.13.",' + isRequired: true + types: + - + - name: friendly_device_version_name + description: 'The current version of the device in + + text format.' + isRequired: true + types: + - + - name: device_last_scanned_date_time + description: 'The last time when a scan was done + + on the device.' + isRequired: true + types: + - + - name: last_completed_scan_job_date_time + description: 'The time when the last scan job + + was completed (success/cancelled/failed) on the appliance.' + isRequired: true + types: + - +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: 'The time when the last + + Download job was completed (success/cancelled/failed) on the appliance.' + name: last_completed_download_job_date_time + types: + - +- description: 'The time when the last Install + + job was completed (success/cancelled/failed) on the appliance.' + name: last_completed_install_job_date_time + types: + - +- description: 'The number of updates available + + for the current device version as per the last device scan.' + name: total_number_of_updates_available + types: + - +- description: 'The total number of items + + pending download.' + name: total_number_of_updates_pending_download + types: + - +- description: 'The total number of items + + pending install.' + name: total_number_of_updates_pending_install + types: + - +- description: 'Indicates if updates are available and at least one + + of the updates needs a reboot. Possible values include: ''NeverReboots'', + + ''RequiresReboot'', ''RequestReboot''' + name: reboot_behavior + types: + - + - +- description: 'The current update operation. Possible + + values include: ''None'', ''Scan'', ''Download'', ''Install''' + name: ongoing_update_operation + types: + - + - +- description: 'The job ID of the download job in + + progress.' + name: in_progress_download_job_id + types: + - +- description: 'The job ID of the install job in + + progress.' + name: in_progress_install_job_id + types: + - +- description: 'The time when the + + currently running download (if any) started.' + name: in_progress_download_job_started_date_time + types: + - +- description: 'The time when the + + currently running install (if any) started.' + name: in_progress_install_job_started_date_time + types: + - +- description: The list of updates available for install. + name: update_titles + types: + - [] +- description: 'The total size of updates available for + + download in bytes.' + name: total_update_size_in_bytes + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_summary.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_summary.yml new file mode 100644 index 00000000..ae6bc9fd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_summary.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.update_summary +name: update_summary +fullName: azure.mgmt.edgegateway.models.update_summary +classes: +- azure.mgmt.edgegateway.models.update_summary.UpdateSummary diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_summary_py3.UpdateSummary.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_summary_py3.UpdateSummary.yml new file mode 100644 index 00000000..fd782df7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_summary_py3.UpdateSummary.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.update_summary_py3.UpdateSummary +name: UpdateSummary +fullName: azure.mgmt.edgegateway.models.update_summary_py3.UpdateSummary +module: azure.mgmt.edgegateway.models.update_summary_py3 +summary: 'Details about ongoing updates and availability of updates on the device. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: 'UpdateSummary(*, device_version_number: str = None, friendly_device_version_name: + str = None, device_last_scanned_date_time=None, last_completed_scan_job_date_time=None, + **kwargs)' + parameters: + - name: device_version_number + description: 'The current version of the device in format: + + 1.2.17312.13.",' + isRequired: true + types: + - + - name: friendly_device_version_name + description: 'The current version of the device in + + text format.' + isRequired: true + types: + - + - name: device_last_scanned_date_time + description: 'The last time when a scan was done + + on the device.' + isRequired: true + types: + - + - name: last_completed_scan_job_date_time + description: 'The time when the last scan job + + was completed (success/cancelled/failed) on the appliance.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: device_version_number + isRequired: true + - name: friendly_device_version_name + isRequired: true + - name: device_last_scanned_date_time + isRequired: true + - name: last_completed_scan_job_date_time + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - +- description: 'The time when the last + + Download job was completed (success/cancelled/failed) on the appliance.' + name: last_completed_download_job_date_time + types: + - +- description: 'The time when the last Install + + job was completed (success/cancelled/failed) on the appliance.' + name: last_completed_install_job_date_time + types: + - +- description: 'The number of updates available + + for the current device version as per the last device scan.' + name: total_number_of_updates_available + types: + - +- description: 'The total number of items + + pending download.' + name: total_number_of_updates_pending_download + types: + - +- description: 'The total number of items + + pending install.' + name: total_number_of_updates_pending_install + types: + - +- description: 'Indicates if updates are available and at least one + + of the updates needs a reboot. Possible values include: ''NeverReboots'', + + ''RequiresReboot'', ''RequestReboot''' + name: reboot_behavior + types: + - + - +- description: 'The current update operation. Possible + + values include: ''None'', ''Scan'', ''Download'', ''Install''' + name: ongoing_update_operation + types: + - + - +- description: 'The job ID of the download job in + + progress.' + name: in_progress_download_job_id + types: + - +- description: 'The job ID of the install job in + + progress.' + name: in_progress_install_job_id + types: + - +- description: 'The time when the + + currently running download (if any) started.' + name: in_progress_download_job_started_date_time + types: + - +- description: 'The time when the + + currently running install (if any) started.' + name: in_progress_install_job_started_date_time + types: + - +- description: The list of updates available for install. + name: update_titles + types: + - [] +- description: 'The total size of updates available for + + download in bytes.' + name: total_update_size_in_bytes + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_summary_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_summary_py3.yml new file mode 100644 index 00000000..7c0a0bb3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_summary_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.update_summary_py3 +name: update_summary_py3 +fullName: azure.mgmt.edgegateway.models.update_summary_py3 +classes: +- azure.mgmt.edgegateway.models.update_summary_py3.UpdateSummary diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_request.UploadCertificateRequest.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_request.UploadCertificateRequest.yml new file mode 100644 index 00000000..c78bdb25 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_request.UploadCertificateRequest.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.upload_certificate_request.UploadCertificateRequest +name: UploadCertificateRequest +fullName: azure.mgmt.edgegateway.models.upload_certificate_request.UploadCertificateRequest +module: azure.mgmt.edgegateway.models.upload_certificate_request +summary: 'The upload certificate request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: UploadCertificateRequest(**kwargs) + parameters: + - name: authentication_type + description: 'The authentication type. Possible values + + include: ''Invalid'', ''AzureActiveDirectory''' + isRequired: true + types: + - + - + - name: certificate + description: Required. The base64 encoded certificate raw data. + isRequired: true + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_request.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_request.yml new file mode 100644 index 00000000..a33e0d7a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_request.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.upload_certificate_request +name: upload_certificate_request +fullName: azure.mgmt.edgegateway.models.upload_certificate_request +classes: +- azure.mgmt.edgegateway.models.upload_certificate_request.UploadCertificateRequest diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_request_py3.UploadCertificateRequest.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_request_py3.UploadCertificateRequest.yml new file mode 100644 index 00000000..b159f0a8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_request_py3.UploadCertificateRequest.yml @@ -0,0 +1,31 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.upload_certificate_request_py3.UploadCertificateRequest +name: UploadCertificateRequest +fullName: azure.mgmt.edgegateway.models.upload_certificate_request_py3.UploadCertificateRequest +module: azure.mgmt.edgegateway.models.upload_certificate_request_py3 +summary: 'The upload certificate request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'UploadCertificateRequest(*, certificate: str, authentication_type=None, + **kwargs)' + parameters: + - name: authentication_type + description: 'The authentication type. Possible values + + include: ''Invalid'', ''AzureActiveDirectory''' + isRequired: true + types: + - + - + - name: certificate + description: Required. The base64 encoded certificate raw data. + isRequired: true + types: + - + keywordOnlyParameters: + - name: certificate + isRequired: true + - name: authentication_type + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_request_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_request_py3.yml new file mode 100644 index 00000000..4167dd3d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_request_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.upload_certificate_request_py3 +name: upload_certificate_request_py3 +fullName: azure.mgmt.edgegateway.models.upload_certificate_request_py3 +classes: +- azure.mgmt.edgegateway.models.upload_certificate_request_py3.UploadCertificateRequest diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_response.UploadCertificateResponse.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_response.UploadCertificateResponse.yml new file mode 100644 index 00000000..0819e5fb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_response.UploadCertificateResponse.yml @@ -0,0 +1,58 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.upload_certificate_response.UploadCertificateResponse +name: UploadCertificateResponse +fullName: azure.mgmt.edgegateway.models.upload_certificate_response.UploadCertificateResponse +module: azure.mgmt.edgegateway.models.upload_certificate_response +summary: 'The upload registration certificate response. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: UploadCertificateResponse(**kwargs) + parameters: + - name: auth_type + description: 'Specifies authentication type. Possible values include: + + ''Invalid'', ''AzureActiveDirectory''' + isRequired: true + types: + - + - + - name: resource_id + description: 'Required. The resource ID of the Data Box Edge/Gateway + + device.' + isRequired: true + types: + - + - name: aad_authority + description: Required. Azure Active Directory tenant authority. + isRequired: true + types: + - + - name: aad_tenant_id + description: Required. Azure Active Directory tenant ID. + isRequired: true + types: + - + - name: service_principal_client_id + description: 'Required. Azure Active Directory + + service principal client ID.' + isRequired: true + types: + - + - name: service_principal_object_id + description: 'Required. Azure Active Directory + + service principal object ID.' + isRequired: true + types: + - + - name: azure_management_endpoint_audience + description: 'Required. The azure management + + endpoint audience.' + isRequired: true + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_response.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_response.yml new file mode 100644 index 00000000..72551d40 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_response.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.upload_certificate_response +name: upload_certificate_response +fullName: azure.mgmt.edgegateway.models.upload_certificate_response +classes: +- azure.mgmt.edgegateway.models.upload_certificate_response.UploadCertificateResponse diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_response_py3.UploadCertificateResponse.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_response_py3.UploadCertificateResponse.yml new file mode 100644 index 00000000..f40f4849 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_response_py3.UploadCertificateResponse.yml @@ -0,0 +1,75 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.upload_certificate_response_py3.UploadCertificateResponse +name: UploadCertificateResponse +fullName: azure.mgmt.edgegateway.models.upload_certificate_response_py3.UploadCertificateResponse +module: azure.mgmt.edgegateway.models.upload_certificate_response_py3 +summary: 'The upload registration certificate response. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'UploadCertificateResponse(*, resource_id: str, aad_authority: str, aad_tenant_id: + str, service_principal_client_id: str, service_principal_object_id: str, azure_management_endpoint_audience: + str, auth_type=None, **kwargs)' + parameters: + - name: auth_type + description: 'Specifies authentication type. Possible values include: + + ''Invalid'', ''AzureActiveDirectory''' + isRequired: true + types: + - + - + - name: resource_id + description: 'Required. The resource ID of the Data Box Edge/Gateway + + device.' + isRequired: true + types: + - + - name: aad_authority + description: Required. Azure Active Directory tenant authority. + isRequired: true + types: + - + - name: aad_tenant_id + description: Required. Azure Active Directory tenant ID. + isRequired: true + types: + - + - name: service_principal_client_id + description: 'Required. Azure Active Directory + + service principal client ID.' + isRequired: true + types: + - + - name: service_principal_object_id + description: 'Required. Azure Active Directory + + service principal object ID.' + isRequired: true + types: + - + - name: azure_management_endpoint_audience + description: 'Required. The azure management + + endpoint audience.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: resource_id + isRequired: true + - name: aad_authority + isRequired: true + - name: aad_tenant_id + isRequired: true + - name: service_principal_client_id + isRequired: true + - name: service_principal_object_id + isRequired: true + - name: azure_management_endpoint_audience + isRequired: true + - name: auth_type + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_response_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_response_py3.yml new file mode 100644 index 00000000..414d3178 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_response_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.upload_certificate_response_py3 +name: upload_certificate_response_py3 +fullName: azure.mgmt.edgegateway.models.upload_certificate_response_py3 +classes: +- azure.mgmt.edgegateway.models.upload_certificate_response_py3.UploadCertificateResponse diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user.User.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user.User.yml new file mode 100644 index 00000000..da83aec3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user.User.yml @@ -0,0 +1,41 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.user.User +name: User +fullName: azure.mgmt.edgegateway.models.user.User +module: azure.mgmt.edgegateway.models.user +summary: 'Represents a user who has access to one or more shares on the Data Box + + Edge/Gateway device. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: User(**kwargs) + parameters: + - name: encrypted_password + description: The password details. + isRequired: true + types: + - + - name: share_access_rights + description: 'List of shares that the user has rights on. + + This field should not be specified during user creation.' + isRequired: true + types: + - [] +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user.yml new file mode 100644 index 00000000..afdf2fd1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.user +name: user +fullName: azure.mgmt.edgegateway.models.user +classes: +- azure.mgmt.edgegateway.models.user.User diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_access_right.UserAccessRight.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_access_right.UserAccessRight.yml new file mode 100644 index 00000000..6339e2de --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_access_right.UserAccessRight.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.user_access_right.UserAccessRight +name: UserAccessRight +fullName: azure.mgmt.edgegateway.models.user_access_right.UserAccessRight +module: azure.mgmt.edgegateway.models.user_access_right +summary: 'The mapping between a particular user and the access type on the SMB share. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: UserAccessRight(**kwargs) + parameters: + - name: user_id + description: Required. User ID (already existing in the device). + isRequired: true + types: + - + - name: access_type + description: 'Required. Type of access to be allowed for the user. + + Possible values include: ''Change'', ''Read'', ''Custom''' + isRequired: true + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_access_right.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_access_right.yml new file mode 100644 index 00000000..82dc0d27 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_access_right.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.user_access_right +name: user_access_right +fullName: azure.mgmt.edgegateway.models.user_access_right +classes: +- azure.mgmt.edgegateway.models.user_access_right.UserAccessRight diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_access_right_py3.UserAccessRight.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_access_right_py3.UserAccessRight.yml new file mode 100644 index 00000000..b8c4e304 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_access_right_py3.UserAccessRight.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.user_access_right_py3.UserAccessRight +name: UserAccessRight +fullName: azure.mgmt.edgegateway.models.user_access_right_py3.UserAccessRight +module: azure.mgmt.edgegateway.models.user_access_right_py3 +summary: 'The mapping between a particular user and the access type on the SMB share. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'UserAccessRight(*, user_id: str, access_type, **kwargs)' + parameters: + - name: user_id + description: Required. User ID (already existing in the device). + isRequired: true + types: + - + - name: access_type + description: 'Required. Type of access to be allowed for the user. + + Possible values include: ''Change'', ''Read'', ''Custom''' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: user_id + isRequired: true + - name: access_type + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_access_right_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_access_right_py3.yml new file mode 100644 index 00000000..5299aba7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_access_right_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.user_access_right_py3 +name: user_access_right_py3 +fullName: azure.mgmt.edgegateway.models.user_access_right_py3 +classes: +- azure.mgmt.edgegateway.models.user_access_right_py3.UserAccessRight diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_paged.UserPaged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_paged.UserPaged.yml new file mode 100644 index 00000000..9fd29809 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_paged.UserPaged.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.user_paged.UserPaged +name: UserPaged +fullName: azure.mgmt.edgegateway.models.user_paged.UserPaged +module: azure.mgmt.edgegateway.models.user_paged +summary: A paging container for iterating over a list of + object +constructor: + syntax: UserPaged(*args, **kwargs) diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_paged.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_paged.yml new file mode 100644 index 00000000..d2737c53 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_paged.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.user_paged +name: user_paged +fullName: azure.mgmt.edgegateway.models.user_paged +classes: +- azure.mgmt.edgegateway.models.user_paged.UserPaged diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_py3.User.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_py3.User.yml new file mode 100644 index 00000000..bceda2b7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_py3.User.yml @@ -0,0 +1,46 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.models.user_py3.User +name: User +fullName: azure.mgmt.edgegateway.models.user_py3.User +module: azure.mgmt.edgegateway.models.user_py3 +summary: 'Represents a user who has access to one or more shares on the Data Box + + Edge/Gateway device. + + + Variables are only populated by the server, and will be ignored when + + sending a request.' +constructor: + syntax: User(*, encrypted_password=None, share_access_rights=None, **kwargs) + parameters: + - name: encrypted_password + description: The password details. + isRequired: true + types: + - + - name: share_access_rights + description: 'List of shares that the user has rights on. + + This field should not be specified during user creation.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: encrypted_password + isRequired: true + - name: share_access_rights + isRequired: true +variables: +- description: The path ID that uniquely identifies the object. + name: id + types: + - +- description: The object name. + name: name + types: + - +- description: The hierarchical type of the object. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_py3.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_py3.yml new file mode 100644 index 00000000..63b453d9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_py3.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.models.user_py3 +name: user_py3 +fullName: azure.mgmt.edgegateway.models.user_py3 +classes: +- azure.mgmt.edgegateway.models.user_py3.User diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.yml new file mode 100644 index 00000000..b613b3bf --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.yml @@ -0,0 +1,223 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.edgegateway.models +name: models +fullName: azure.mgmt.edgegateway.models +type: import +classes: +- azure.mgmt.edgegateway.models.ARMBaseModel +- azure.mgmt.edgegateway.models.Address +- azure.mgmt.edgegateway.models.Alert +- azure.mgmt.edgegateway.models.AlertErrorDetails +- azure.mgmt.edgegateway.models.AlertPaged +- azure.mgmt.edgegateway.models.AsymmetricEncryptedSecret +- azure.mgmt.edgegateway.models.Authentication +- azure.mgmt.edgegateway.models.AzureContainerInfo +- azure.mgmt.edgegateway.models.BandwidthSchedule +- azure.mgmt.edgegateway.models.BandwidthSchedulePaged +- azure.mgmt.edgegateway.models.ClientAccessRight +- azure.mgmt.edgegateway.models.ContactDetails +- azure.mgmt.edgegateway.models.DataBoxEdgeDevice +- azure.mgmt.edgegateway.models.DataBoxEdgeDeviceExtendedInfo +- azure.mgmt.edgegateway.models.DataBoxEdgeDevicePaged +- azure.mgmt.edgegateway.models.DataBoxEdgeDevicePatch +- azure.mgmt.edgegateway.models.FileEventTrigger +- azure.mgmt.edgegateway.models.FileSourceInfo +- azure.mgmt.edgegateway.models.IoTDeviceInfo +- azure.mgmt.edgegateway.models.IoTRole +- azure.mgmt.edgegateway.models.Ipv4Config +- azure.mgmt.edgegateway.models.Ipv6Config +- azure.mgmt.edgegateway.models.Job +- azure.mgmt.edgegateway.models.JobErrorDetails +- azure.mgmt.edgegateway.models.JobErrorItem +- azure.mgmt.edgegateway.models.MetricDimensionV1 +- azure.mgmt.edgegateway.models.MetricSpecificationV1 +- azure.mgmt.edgegateway.models.MountPointMap +- azure.mgmt.edgegateway.models.NetworkAdapter +- azure.mgmt.edgegateway.models.NetworkAdapterPosition +- azure.mgmt.edgegateway.models.NetworkSettings +- azure.mgmt.edgegateway.models.Operation +- azure.mgmt.edgegateway.models.OperationDisplay +- azure.mgmt.edgegateway.models.OperationPaged +- azure.mgmt.edgegateway.models.Order +- azure.mgmt.edgegateway.models.OrderPaged +- azure.mgmt.edgegateway.models.OrderStatus +- azure.mgmt.edgegateway.models.PeriodicTimerEventTrigger +- azure.mgmt.edgegateway.models.PeriodicTimerSourceInfo +- azure.mgmt.edgegateway.models.RefreshDetails +- azure.mgmt.edgegateway.models.Role +- azure.mgmt.edgegateway.models.RolePaged +- azure.mgmt.edgegateway.models.RoleSinkInfo +- azure.mgmt.edgegateway.models.SecuritySettings +- azure.mgmt.edgegateway.models.ServiceSpecification +- azure.mgmt.edgegateway.models.Share +- azure.mgmt.edgegateway.models.ShareAccessRight +- azure.mgmt.edgegateway.models.SharePaged +- azure.mgmt.edgegateway.models.Sku +- azure.mgmt.edgegateway.models.StorageAccountCredential +- azure.mgmt.edgegateway.models.StorageAccountCredentialPaged +- azure.mgmt.edgegateway.models.SymmetricKey +- azure.mgmt.edgegateway.models.TrackingInfo +- azure.mgmt.edgegateway.models.Trigger +- azure.mgmt.edgegateway.models.TriggerPaged +- azure.mgmt.edgegateway.models.UpdateDownloadProgress +- azure.mgmt.edgegateway.models.UpdateInstallProgress +- azure.mgmt.edgegateway.models.UpdateSummary +- azure.mgmt.edgegateway.models.UploadCertificateRequest +- azure.mgmt.edgegateway.models.UploadCertificateResponse +- azure.mgmt.edgegateway.models.User +- azure.mgmt.edgegateway.models.UserAccessRight +- azure.mgmt.edgegateway.models.UserPaged +modules: +- azure.mgmt.edgegateway.models.address +- azure.mgmt.edgegateway.models.address_py3 +- azure.mgmt.edgegateway.models.alert +- azure.mgmt.edgegateway.models.alert_error_details +- azure.mgmt.edgegateway.models.alert_error_details_py3 +- azure.mgmt.edgegateway.models.alert_paged +- azure.mgmt.edgegateway.models.alert_py3 +- azure.mgmt.edgegateway.models.arm_base_model +- azure.mgmt.edgegateway.models.arm_base_model_py3 +- azure.mgmt.edgegateway.models.asymmetric_encrypted_secret +- azure.mgmt.edgegateway.models.asymmetric_encrypted_secret_py3 +- azure.mgmt.edgegateway.models.authentication +- azure.mgmt.edgegateway.models.authentication_py3 +- azure.mgmt.edgegateway.models.azure_container_info +- azure.mgmt.edgegateway.models.azure_container_info_py3 +- azure.mgmt.edgegateway.models.bandwidth_schedule +- azure.mgmt.edgegateway.models.bandwidth_schedule_paged +- azure.mgmt.edgegateway.models.bandwidth_schedule_py3 +- azure.mgmt.edgegateway.models.client_access_right +- azure.mgmt.edgegateway.models.client_access_right_py3 +- azure.mgmt.edgegateway.models.contact_details +- azure.mgmt.edgegateway.models.contact_details_py3 +- azure.mgmt.edgegateway.models.data_box_edge_device +- azure.mgmt.edgegateway.models.data_box_edge_device_extended_info +- azure.mgmt.edgegateway.models.data_box_edge_device_extended_info_py3 +- azure.mgmt.edgegateway.models.data_box_edge_device_paged +- azure.mgmt.edgegateway.models.data_box_edge_device_patch +- azure.mgmt.edgegateway.models.data_box_edge_device_patch_py3 +- azure.mgmt.edgegateway.models.data_box_edge_device_py3 +- azure.mgmt.edgegateway.models.data_box_edge_management_client_enums +- azure.mgmt.edgegateway.models.file_event_trigger +- azure.mgmt.edgegateway.models.file_event_trigger_py3 +- azure.mgmt.edgegateway.models.file_source_info +- azure.mgmt.edgegateway.models.file_source_info_py3 +- azure.mgmt.edgegateway.models.io_tdevice_info +- azure.mgmt.edgegateway.models.io_tdevice_info_py3 +- azure.mgmt.edgegateway.models.io_trole +- azure.mgmt.edgegateway.models.io_trole_py3 +- azure.mgmt.edgegateway.models.ipv4_config +- azure.mgmt.edgegateway.models.ipv4_config_py3 +- azure.mgmt.edgegateway.models.ipv6_config +- azure.mgmt.edgegateway.models.ipv6_config_py3 +- azure.mgmt.edgegateway.models.job +- azure.mgmt.edgegateway.models.job_error_details +- azure.mgmt.edgegateway.models.job_error_details_py3 +- azure.mgmt.edgegateway.models.job_error_item +- azure.mgmt.edgegateway.models.job_error_item_py3 +- azure.mgmt.edgegateway.models.job_py3 +- azure.mgmt.edgegateway.models.metric_dimension_v1 +- azure.mgmt.edgegateway.models.metric_dimension_v1_py3 +- azure.mgmt.edgegateway.models.metric_specification_v1 +- azure.mgmt.edgegateway.models.metric_specification_v1_py3 +- azure.mgmt.edgegateway.models.mount_point_map +- azure.mgmt.edgegateway.models.mount_point_map_py3 +- azure.mgmt.edgegateway.models.network_adapter +- azure.mgmt.edgegateway.models.network_adapter_position +- azure.mgmt.edgegateway.models.network_adapter_position_py3 +- azure.mgmt.edgegateway.models.network_adapter_py3 +- azure.mgmt.edgegateway.models.network_settings +- azure.mgmt.edgegateway.models.network_settings_py3 +- azure.mgmt.edgegateway.models.operation +- azure.mgmt.edgegateway.models.operation_display +- azure.mgmt.edgegateway.models.operation_display_py3 +- azure.mgmt.edgegateway.models.operation_paged +- azure.mgmt.edgegateway.models.operation_py3 +- azure.mgmt.edgegateway.models.order +- azure.mgmt.edgegateway.models.order_paged +- azure.mgmt.edgegateway.models.order_py3 +- azure.mgmt.edgegateway.models.order_status +- azure.mgmt.edgegateway.models.order_status_py3 +- azure.mgmt.edgegateway.models.periodic_timer_event_trigger +- azure.mgmt.edgegateway.models.periodic_timer_event_trigger_py3 +- azure.mgmt.edgegateway.models.periodic_timer_source_info +- azure.mgmt.edgegateway.models.periodic_timer_source_info_py3 +- azure.mgmt.edgegateway.models.refresh_details +- azure.mgmt.edgegateway.models.refresh_details_py3 +- azure.mgmt.edgegateway.models.role +- azure.mgmt.edgegateway.models.role_paged +- azure.mgmt.edgegateway.models.role_py3 +- azure.mgmt.edgegateway.models.role_sink_info +- azure.mgmt.edgegateway.models.role_sink_info_py3 +- azure.mgmt.edgegateway.models.security_settings +- azure.mgmt.edgegateway.models.security_settings_py3 +- azure.mgmt.edgegateway.models.service_specification +- azure.mgmt.edgegateway.models.service_specification_py3 +- azure.mgmt.edgegateway.models.share +- azure.mgmt.edgegateway.models.share_access_right +- azure.mgmt.edgegateway.models.share_access_right_py3 +- azure.mgmt.edgegateway.models.share_paged +- azure.mgmt.edgegateway.models.share_py3 +- azure.mgmt.edgegateway.models.sku +- azure.mgmt.edgegateway.models.sku_py3 +- azure.mgmt.edgegateway.models.storage_account_credential +- azure.mgmt.edgegateway.models.storage_account_credential_paged +- azure.mgmt.edgegateway.models.storage_account_credential_py3 +- azure.mgmt.edgegateway.models.symmetric_key +- azure.mgmt.edgegateway.models.symmetric_key_py3 +- azure.mgmt.edgegateway.models.tracking_info +- azure.mgmt.edgegateway.models.tracking_info_py3 +- azure.mgmt.edgegateway.models.trigger +- azure.mgmt.edgegateway.models.trigger_paged +- azure.mgmt.edgegateway.models.trigger_py3 +- azure.mgmt.edgegateway.models.update_download_progress +- azure.mgmt.edgegateway.models.update_download_progress_py3 +- azure.mgmt.edgegateway.models.update_install_progress +- azure.mgmt.edgegateway.models.update_install_progress_py3 +- azure.mgmt.edgegateway.models.update_summary +- azure.mgmt.edgegateway.models.update_summary_py3 +- azure.mgmt.edgegateway.models.upload_certificate_request +- azure.mgmt.edgegateway.models.upload_certificate_request_py3 +- azure.mgmt.edgegateway.models.upload_certificate_response +- azure.mgmt.edgegateway.models.upload_certificate_response_py3 +- azure.mgmt.edgegateway.models.user +- azure.mgmt.edgegateway.models.user_access_right +- azure.mgmt.edgegateway.models.user_access_right_py3 +- azure.mgmt.edgegateway.models.user_paged +- azure.mgmt.edgegateway.models.user_py3 +enums: +- azure.mgmt.edgegateway.models.AccountType +- azure.mgmt.edgegateway.models.AlertSeverity +- azure.mgmt.edgegateway.models.AuthenticationType +- azure.mgmt.edgegateway.models.AzureContainerDataFormat +- azure.mgmt.edgegateway.models.ClientPermissionType +- azure.mgmt.edgegateway.models.DataBoxEdgeDeviceStatus +- azure.mgmt.edgegateway.models.DataPolicy +- azure.mgmt.edgegateway.models.DayOfWeek +- azure.mgmt.edgegateway.models.DeviceType +- azure.mgmt.edgegateway.models.DownloadPhase +- azure.mgmt.edgegateway.models.EncryptionAlgorithm +- azure.mgmt.edgegateway.models.InstallRebootBehavior +- azure.mgmt.edgegateway.models.JobStatus +- azure.mgmt.edgegateway.models.JobType +- azure.mgmt.edgegateway.models.MetricAggregationType +- azure.mgmt.edgegateway.models.MetricCategory +- azure.mgmt.edgegateway.models.MetricUnit +- azure.mgmt.edgegateway.models.MonitoringStatus +- azure.mgmt.edgegateway.models.NetworkAdapterDHCPStatus +- azure.mgmt.edgegateway.models.NetworkAdapterRDMAStatus +- azure.mgmt.edgegateway.models.NetworkAdapterStatus +- azure.mgmt.edgegateway.models.NetworkGroup +- azure.mgmt.edgegateway.models.OrderState +- azure.mgmt.edgegateway.models.PlatformType +- azure.mgmt.edgegateway.models.RoleStatus +- azure.mgmt.edgegateway.models.RoleTypes +- azure.mgmt.edgegateway.models.SSLStatus +- azure.mgmt.edgegateway.models.ShareAccessProtocol +- azure.mgmt.edgegateway.models.ShareAccessType +- azure.mgmt.edgegateway.models.ShareStatus +- azure.mgmt.edgegateway.models.SkuName +- azure.mgmt.edgegateway.models.SkuTier +- azure.mgmt.edgegateway.models.TimeGrain +- azure.mgmt.edgegateway.models.UpdateOperation +- azure.mgmt.edgegateway.models.UpdateOperationStage diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.AlertsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.AlertsOperations.yml new file mode 100644 index 00000000..04656c96 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.AlertsOperations.yml @@ -0,0 +1,113 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.AlertsOperations +name: AlertsOperations +fullName: azure.mgmt.edgegateway.operations.AlertsOperations +module: azure.mgmt.edgegateway.operations +summary: AlertsOperations operations. +constructor: + syntax: AlertsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.AlertsOperations.get + name: get + summary: Gets an alert by name. + signature: get(device_name, name, resource_group_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The alert name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Alert or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.AlertsOperations.list_by_data_box_edge_device + name: list_by_data_box_edge_device + summary: Gets all the alerts for a data box edge/gateway device. + signature: list_by_data_box_edge_device(device_name, resource_group_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of Alert + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.AlertsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.BandwidthSchedulesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.BandwidthSchedulesOperations.yml new file mode 100644 index 00000000..22120470 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.BandwidthSchedulesOperations.yml @@ -0,0 +1,214 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.BandwidthSchedulesOperations +name: BandwidthSchedulesOperations +fullName: azure.mgmt.edgegateway.operations.BandwidthSchedulesOperations +module: azure.mgmt.edgegateway.operations +summary: BandwidthSchedulesOperations operations. +constructor: + syntax: BandwidthSchedulesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.BandwidthSchedulesOperations.create_or_update + name: create_or_update + summary: Creates or updates a bandwidth schedule. + signature: create_or_update(device_name, name, parameters, resource_group_name, + custom_headers=None, raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: 'The bandwidth schedule name which needs to be + + added/updated.' + isRequired: true + types: + - + - name: parameters + description: The bandwidth schedule to be added or updated. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns BandwidthSchedule or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.BandwidthSchedulesOperations.delete + name: delete + summary: Deletes the specified bandwidth schedule. + signature: delete(device_name, name, resource_group_name, custom_headers=None, raw=False, + polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The bandwidth schedule name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.BandwidthSchedulesOperations.get + name: get + summary: Gets the properties of the specified bandwidth schedule. + signature: get(device_name, name, resource_group_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The bandwidth schedule name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: BandwidthSchedule or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.BandwidthSchedulesOperations.list_by_data_box_edge_device + name: list_by_data_box_edge_device + summary: Gets all the bandwidth schedules for a data box edge/gateway device. + signature: list_by_data_box_edge_device(device_name, resource_group_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of BandwidthSchedule + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.BandwidthSchedulesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.DevicesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.DevicesOperations.yml new file mode 100644 index 00000000..cf5b184d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.DevicesOperations.yml @@ -0,0 +1,647 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.DevicesOperations +name: DevicesOperations +fullName: azure.mgmt.edgegateway.operations.DevicesOperations +module: azure.mgmt.edgegateway.operations +summary: DevicesOperations operations. +constructor: + syntax: DevicesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.DevicesOperations.create_or_update + name: create_or_update + summary: Creates or updates a Data Box Edge/Gateway resource. + signature: create_or_update(device_name, data_box_edge_device, resource_group_name, + custom_headers=None, raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: data_box_edge_device + description: The resource object. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns DataBoxEdgeDevice or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.DevicesOperations.create_or_update_security_settings + name: create_or_update_security_settings + summary: Updates the security settings on a data box edge/gateway device. + signature: create_or_update_security_settings(device_name, resource_group_name, + device_admin_password, custom_headers=None, raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: device_admin_password + description: 'Device administrator password as an + + encrypted string (encrypted using RSA PKCS #1) is used to sign into + + the local web UI of the device. The Actual password should have at + + least 8 characters that are a combination of uppercase, lowercase, + + numeric, and special characters.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.DevicesOperations.delete + name: delete + summary: Deletes the data box edge/gateway device. + signature: delete(device_name, resource_group_name, custom_headers=None, raw=False, + polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.DevicesOperations.download_updates + name: download_updates + summary: Downloads the updates on a data box edge/gateway device. + signature: download_updates(device_name, resource_group_name, custom_headers=None, + raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.DevicesOperations.get + name: get + summary: Gets the properties of the data box edge/gateway device. + signature: get(device_name, resource_group_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DataBoxEdgeDevice or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.DevicesOperations.get_extended_information + name: get_extended_information + summary: 'Gets additional information for the specified data box edge/gateway + + device.' + signature: get_extended_information(device_name, resource_group_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: 'DataBoxEdgeDeviceExtendedInfo or ClientRawResponse if + + raw=true' + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.DevicesOperations.get_network_settings + name: get_network_settings + summary: 'Gets the network settings of the specified data box edge/gateway + + device.' + signature: get_network_settings(device_name, resource_group_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: NetworkSettings or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.DevicesOperations.get_update_summary + name: get_update_summary + summary: 'Gets information about the availability of updates based on the last + + scan of the device. It also gets information about any ongoing download + + or install jobs on the device.' + signature: get_update_summary(device_name, resource_group_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: UpdateSummary or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.DevicesOperations.install_updates + name: install_updates + summary: Installs the updates on the data box edge/gateway device. + signature: install_updates(device_name, resource_group_name, custom_headers=None, + raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.DevicesOperations.list_by_resource_group + name: list_by_resource_group + summary: Gets all the data box edge/gateway devices in a resource group. + signature: list_by_resource_group(resource_group_name, expand=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: expand + description: 'Specify $expand=details to populate additional fields + + related to the resource or Specify $skipToken= to populate the + + next page in the list.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DataBoxEdgeDevice + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.DevicesOperations.list_by_subscription + name: list_by_subscription + summary: Gets all the data box edge/gateway devices in a subscription. + signature: list_by_subscription(expand=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: expand + description: 'Specify $expand=details to populate additional fields + + related to the resource or Specify $skipToken= to populate the + + next page in the list.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DataBoxEdgeDevice + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.DevicesOperations.scan_for_updates + name: scan_for_updates + summary: Scans for updates on a data box edge/gateway device. + signature: scan_for_updates(device_name, resource_group_name, custom_headers=None, + raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.DevicesOperations.update + name: update + summary: Modifies a Data Box Edge/Gateway resource. + signature: update(device_name, resource_group_name, tags=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: tags + description: The tags attached to the Data Box Edge/Gateway resource. + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DataBoxEdgeDevice or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.DevicesOperations.upload_certificate + name: upload_certificate + summary: Uploads registration certificate for the device. + signature: upload_certificate(device_name, resource_group_name, certificate, authentication_type=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: certificate + description: The base64 encoded certificate raw data. + isRequired: true + types: + - + - name: authentication_type + description: 'The authentication type. Possible values + + include: ''Invalid'', ''AzureActiveDirectory''' + defaultValue: None + types: + - + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: UploadCertificateResponse or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.DevicesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.JobsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.JobsOperations.yml new file mode 100644 index 00000000..98a4dd97 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.JobsOperations.yml @@ -0,0 +1,74 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.JobsOperations +name: JobsOperations +fullName: azure.mgmt.edgegateway.operations.JobsOperations +module: azure.mgmt.edgegateway.operations +summary: JobsOperations operations. +constructor: + syntax: JobsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.JobsOperations.get + name: get + summary: Gets the details of a specified job on a data box edge/gateway device. + signature: get(device_name, name, resource_group_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The job name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Job or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.JobsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.Operations(class).yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.Operations(class).yml new file mode 100644 index 00000000..33a386ef --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.Operations(class).yml @@ -0,0 +1,57 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.Operations +name: Operations +fullName: azure.mgmt.edgegateway.operations.Operations +module: azure.mgmt.edgegateway.operations +summary: Operations operations. +constructor: + syntax: Operations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.Operations.list + name: list + summary: List all the supported operations. + signature: list(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of Operation + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.OperationsStatusOperations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.OperationsStatusOperations.yml new file mode 100644 index 00000000..9942f9ab --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.OperationsStatusOperations.yml @@ -0,0 +1,74 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.OperationsStatusOperations +name: OperationsStatusOperations +fullName: azure.mgmt.edgegateway.operations.OperationsStatusOperations +module: azure.mgmt.edgegateway.operations +summary: OperationsStatusOperations operations. +constructor: + syntax: OperationsStatusOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.OperationsStatusOperations.get + name: get + summary: Gets the details of a specified job on a data box edge/gateway device. + signature: get(device_name, name, resource_group_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The job name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Job or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.OperationsStatusOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.OrdersOperations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.OrdersOperations.yml new file mode 100644 index 00000000..1ff85e15 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.OrdersOperations.yml @@ -0,0 +1,197 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.OrdersOperations +name: OrdersOperations +fullName: azure.mgmt.edgegateway.operations.OrdersOperations +module: azure.mgmt.edgegateway.operations +summary: OrdersOperations operations. +constructor: + syntax: OrdersOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.OrdersOperations.create_or_update + name: create_or_update + summary: Creates or updates an order. + signature: create_or_update(device_name, order, resource_group_name, custom_headers=None, + raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: order + description: The order to be created or updated. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns Order or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.OrdersOperations.delete + name: delete + summary: Deletes the order related to the device. + signature: delete(device_name, resource_group_name, custom_headers=None, raw=False, + polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.OrdersOperations.get + name: get + summary: Gets a specific order by name. + signature: get(device_name, resource_group_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Order or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.OrdersOperations.list_by_data_box_edge_device + name: list_by_data_box_edge_device + summary: Lists all the orders related to a data box edge/gateway device. + signature: list_by_data_box_edge_device(device_name, resource_group_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of Order + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.OrdersOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.RolesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.RolesOperations.yml new file mode 100644 index 00000000..040919bc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.RolesOperations.yml @@ -0,0 +1,212 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.RolesOperations +name: RolesOperations +fullName: azure.mgmt.edgegateway.operations.RolesOperations +module: azure.mgmt.edgegateway.operations +summary: RolesOperations operations. +constructor: + syntax: RolesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.RolesOperations.create_or_update + name: create_or_update + summary: Create or update a role. + signature: create_or_update(device_name, name, role, resource_group_name, custom_headers=None, + raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The role name. + isRequired: true + types: + - + - name: role + description: The role properties. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns Role or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.RolesOperations.delete + name: delete + summary: Deletes the role on the data box edge device. + signature: delete(device_name, name, resource_group_name, custom_headers=None, raw=False, + polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The role name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.RolesOperations.get + name: get + summary: Gets a specific role by name. + signature: get(device_name, name, resource_group_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The role name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Role or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.RolesOperations.list_by_data_box_edge_device + name: list_by_data_box_edge_device + summary: Lists all the roles configured in a data box edge/gateway device. + signature: list_by_data_box_edge_device(device_name, resource_group_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of Role + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.RolesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.SharesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.SharesOperations.yml new file mode 100644 index 00000000..563c1c60 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.SharesOperations.yml @@ -0,0 +1,259 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.SharesOperations +name: SharesOperations +fullName: azure.mgmt.edgegateway.operations.SharesOperations +module: azure.mgmt.edgegateway.operations +summary: SharesOperations operations. +constructor: + syntax: SharesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.SharesOperations.create_or_update + name: create_or_update + summary: Creates a new share or updates an existing share on the device. + signature: create_or_update(device_name, name, share, resource_group_name, custom_headers=None, + raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The share name. + isRequired: true + types: + - + - name: share + description: The share properties. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns Share or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.SharesOperations.delete + name: delete + summary: Deletes the share on the data box edge/gateway device. + signature: delete(device_name, name, resource_group_name, custom_headers=None, raw=False, + polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The share name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.SharesOperations.get + name: get + summary: Gets a share by name. + signature: get(device_name, name, resource_group_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The share name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Share or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.SharesOperations.list_by_data_box_edge_device + name: list_by_data_box_edge_device + summary: Lists all the shares in a data box edge/gateway device. + signature: list_by_data_box_edge_device(device_name, resource_group_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of Share + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.SharesOperations.refresh + name: refresh + summary: Refreshes the share metadata with the data from the cloud. + signature: refresh(device_name, name, resource_group_name, custom_headers=None, + raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The share name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.SharesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.StorageAccountCredentialsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.StorageAccountCredentialsOperations.yml new file mode 100644 index 00000000..6e0c9bf7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.StorageAccountCredentialsOperations.yml @@ -0,0 +1,216 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.StorageAccountCredentialsOperations +name: StorageAccountCredentialsOperations +fullName: azure.mgmt.edgegateway.operations.StorageAccountCredentialsOperations +module: azure.mgmt.edgegateway.operations +summary: StorageAccountCredentialsOperations operations. +constructor: + syntax: StorageAccountCredentialsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.StorageAccountCredentialsOperations.create_or_update + name: create_or_update + summary: Creates or updates the storage account credential. + signature: create_or_update(device_name, name, storage_account_credential, resource_group_name, + custom_headers=None, raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The storage account credential name. + isRequired: true + types: + - + - name: storage_account_credential + description: The storage account credential. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns + + StorageAccountCredential or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.StorageAccountCredentialsOperations.delete + name: delete + summary: Deletes the storage account credential. + signature: delete(device_name, name, resource_group_name, custom_headers=None, raw=False, + polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The storage account credential name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.StorageAccountCredentialsOperations.get + name: get + summary: Gets the properties of the specified storage account credential. + signature: get(device_name, name, resource_group_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The storage account credential name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageAccountCredential or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.StorageAccountCredentialsOperations.list_by_data_box_edge_device + name: list_by_data_box_edge_device + summary: 'Gets all the storage account credentials in a data box edge/gateway + + device.' + signature: list_by_data_box_edge_device(device_name, resource_group_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of StorageAccountCredential + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.StorageAccountCredentialsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.TriggersOperations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.TriggersOperations.yml new file mode 100644 index 00000000..af985c10 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.TriggersOperations.yml @@ -0,0 +1,219 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.TriggersOperations +name: TriggersOperations +fullName: azure.mgmt.edgegateway.operations.TriggersOperations +module: azure.mgmt.edgegateway.operations +summary: TriggersOperations operations. +constructor: + syntax: TriggersOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.TriggersOperations.create_or_update + name: create_or_update + summary: Creates or updates a trigger. + signature: create_or_update(device_name, name, trigger, resource_group_name, custom_headers=None, + raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: Creates or updates a trigger + isRequired: true + types: + - + - name: name + description: The trigger name. + isRequired: true + types: + - + - name: trigger + description: The trigger. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns Trigger or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.TriggersOperations.delete + name: delete + summary: Deletes the trigger on the gateway device. + signature: delete(device_name, name, resource_group_name, custom_headers=None, raw=False, + polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The trigger name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.TriggersOperations.get + name: get + summary: Get a specific trigger by name. + signature: get(device_name, name, resource_group_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The trigger name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Trigger or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.TriggersOperations.list_by_data_box_edge_device + name: list_by_data_box_edge_device + summary: Lists all the triggers configured in the device. + signature: list_by_data_box_edge_device(device_name, resource_group_name, expand=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: expand + description: 'Specify $filter=''CustomContextTag eq '' to filter + + on custom context tag property' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of Trigger + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.TriggersOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.UsersOperations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.UsersOperations.yml new file mode 100644 index 00000000..3fcc00f6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.UsersOperations.yml @@ -0,0 +1,221 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.UsersOperations +name: UsersOperations +fullName: azure.mgmt.edgegateway.operations.UsersOperations +module: azure.mgmt.edgegateway.operations +summary: UsersOperations operations. +constructor: + syntax: UsersOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.UsersOperations.create_or_update + name: create_or_update + summary: 'Creates a new user or updates an existing user''s information on a data + + box edge/gateway device.' + signature: create_or_update(device_name, name, resource_group_name, encrypted_password=None, + share_access_rights=None, custom_headers=None, raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The user name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: encrypted_password + description: The password details. + defaultValue: None + types: + - + - name: share_access_rights + description: 'List of shares that the user has rights + + on. This field should not be specified during user creation.' + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns User or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.UsersOperations.delete + name: delete + summary: Deletes the user on a databox edge/gateway device. + signature: delete(device_name, name, resource_group_name, custom_headers=None, raw=False, + polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The user name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.UsersOperations.get + name: get + summary: Gets the properties of the specified user. + signature: get(device_name, name, resource_group_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The user name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: User or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.UsersOperations.list_by_data_box_edge_device + name: list_by_data_box_edge_device + summary: Gets all the users registered on a data box edge/gateway device. + signature: list_by_data_box_edge_device(device_name, resource_group_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of User + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.UsersOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.alerts_operations.AlertsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.alerts_operations.AlertsOperations.yml new file mode 100644 index 00000000..1c51bda2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.alerts_operations.AlertsOperations.yml @@ -0,0 +1,113 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.alerts_operations.AlertsOperations +name: AlertsOperations +fullName: azure.mgmt.edgegateway.operations.alerts_operations.AlertsOperations +module: azure.mgmt.edgegateway.operations.alerts_operations +summary: AlertsOperations operations. +constructor: + syntax: AlertsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.alerts_operations.AlertsOperations.get + name: get + summary: Gets an alert by name. + signature: get(device_name, name, resource_group_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The alert name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Alert or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.alerts_operations.AlertsOperations.list_by_data_box_edge_device + name: list_by_data_box_edge_device + summary: Gets all the alerts for a data box edge/gateway device. + signature: list_by_data_box_edge_device(device_name, resource_group_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of Alert + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.alerts_operations.AlertsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.alerts_operations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.alerts_operations.yml new file mode 100644 index 00000000..0fb3acfc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.alerts_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.operations.alerts_operations +name: alerts_operations +fullName: azure.mgmt.edgegateway.operations.alerts_operations +classes: +- azure.mgmt.edgegateway.operations.alerts_operations.AlertsOperations diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.bandwidth_schedules_operations.BandwidthSchedulesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.bandwidth_schedules_operations.BandwidthSchedulesOperations.yml new file mode 100644 index 00000000..17a4c9e2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.bandwidth_schedules_operations.BandwidthSchedulesOperations.yml @@ -0,0 +1,214 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.bandwidth_schedules_operations.BandwidthSchedulesOperations +name: BandwidthSchedulesOperations +fullName: azure.mgmt.edgegateway.operations.bandwidth_schedules_operations.BandwidthSchedulesOperations +module: azure.mgmt.edgegateway.operations.bandwidth_schedules_operations +summary: BandwidthSchedulesOperations operations. +constructor: + syntax: BandwidthSchedulesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.bandwidth_schedules_operations.BandwidthSchedulesOperations.create_or_update + name: create_or_update + summary: Creates or updates a bandwidth schedule. + signature: create_or_update(device_name, name, parameters, resource_group_name, + custom_headers=None, raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: 'The bandwidth schedule name which needs to be + + added/updated.' + isRequired: true + types: + - + - name: parameters + description: The bandwidth schedule to be added or updated. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns BandwidthSchedule or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.bandwidth_schedules_operations.BandwidthSchedulesOperations.delete + name: delete + summary: Deletes the specified bandwidth schedule. + signature: delete(device_name, name, resource_group_name, custom_headers=None, raw=False, + polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The bandwidth schedule name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.bandwidth_schedules_operations.BandwidthSchedulesOperations.get + name: get + summary: Gets the properties of the specified bandwidth schedule. + signature: get(device_name, name, resource_group_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The bandwidth schedule name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: BandwidthSchedule or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.bandwidth_schedules_operations.BandwidthSchedulesOperations.list_by_data_box_edge_device + name: list_by_data_box_edge_device + summary: Gets all the bandwidth schedules for a data box edge/gateway device. + signature: list_by_data_box_edge_device(device_name, resource_group_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of BandwidthSchedule + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.bandwidth_schedules_operations.BandwidthSchedulesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.bandwidth_schedules_operations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.bandwidth_schedules_operations.yml new file mode 100644 index 00000000..ac0ad646 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.bandwidth_schedules_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.operations.bandwidth_schedules_operations +name: bandwidth_schedules_operations +fullName: azure.mgmt.edgegateway.operations.bandwidth_schedules_operations +classes: +- azure.mgmt.edgegateway.operations.bandwidth_schedules_operations.BandwidthSchedulesOperations diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.devices_operations.DevicesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.devices_operations.DevicesOperations.yml new file mode 100644 index 00000000..3f924670 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.devices_operations.DevicesOperations.yml @@ -0,0 +1,647 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.devices_operations.DevicesOperations +name: DevicesOperations +fullName: azure.mgmt.edgegateway.operations.devices_operations.DevicesOperations +module: azure.mgmt.edgegateway.operations.devices_operations +summary: DevicesOperations operations. +constructor: + syntax: DevicesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.devices_operations.DevicesOperations.create_or_update + name: create_or_update + summary: Creates or updates a Data Box Edge/Gateway resource. + signature: create_or_update(device_name, data_box_edge_device, resource_group_name, + custom_headers=None, raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: data_box_edge_device + description: The resource object. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns DataBoxEdgeDevice or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.devices_operations.DevicesOperations.create_or_update_security_settings + name: create_or_update_security_settings + summary: Updates the security settings on a data box edge/gateway device. + signature: create_or_update_security_settings(device_name, resource_group_name, + device_admin_password, custom_headers=None, raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: device_admin_password + description: 'Device administrator password as an + + encrypted string (encrypted using RSA PKCS #1) is used to sign into + + the local web UI of the device. The Actual password should have at + + least 8 characters that are a combination of uppercase, lowercase, + + numeric, and special characters.' + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.devices_operations.DevicesOperations.delete + name: delete + summary: Deletes the data box edge/gateway device. + signature: delete(device_name, resource_group_name, custom_headers=None, raw=False, + polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.devices_operations.DevicesOperations.download_updates + name: download_updates + summary: Downloads the updates on a data box edge/gateway device. + signature: download_updates(device_name, resource_group_name, custom_headers=None, + raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.devices_operations.DevicesOperations.get + name: get + summary: Gets the properties of the data box edge/gateway device. + signature: get(device_name, resource_group_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DataBoxEdgeDevice or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.devices_operations.DevicesOperations.get_extended_information + name: get_extended_information + summary: 'Gets additional information for the specified data box edge/gateway + + device.' + signature: get_extended_information(device_name, resource_group_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: 'DataBoxEdgeDeviceExtendedInfo or ClientRawResponse if + + raw=true' + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.devices_operations.DevicesOperations.get_network_settings + name: get_network_settings + summary: 'Gets the network settings of the specified data box edge/gateway + + device.' + signature: get_network_settings(device_name, resource_group_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: NetworkSettings or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.devices_operations.DevicesOperations.get_update_summary + name: get_update_summary + summary: 'Gets information about the availability of updates based on the last + + scan of the device. It also gets information about any ongoing download + + or install jobs on the device.' + signature: get_update_summary(device_name, resource_group_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: UpdateSummary or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.devices_operations.DevicesOperations.install_updates + name: install_updates + summary: Installs the updates on the data box edge/gateway device. + signature: install_updates(device_name, resource_group_name, custom_headers=None, + raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.devices_operations.DevicesOperations.list_by_resource_group + name: list_by_resource_group + summary: Gets all the data box edge/gateway devices in a resource group. + signature: list_by_resource_group(resource_group_name, expand=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: expand + description: 'Specify $expand=details to populate additional fields + + related to the resource or Specify $skipToken= to populate the + + next page in the list.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DataBoxEdgeDevice + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.devices_operations.DevicesOperations.list_by_subscription + name: list_by_subscription + summary: Gets all the data box edge/gateway devices in a subscription. + signature: list_by_subscription(expand=None, custom_headers=None, raw=False, **operation_config) + parameters: + - name: expand + description: 'Specify $expand=details to populate additional fields + + related to the resource or Specify $skipToken= to populate the + + next page in the list.' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of DataBoxEdgeDevice + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.devices_operations.DevicesOperations.scan_for_updates + name: scan_for_updates + summary: Scans for updates on a data box edge/gateway device. + signature: scan_for_updates(device_name, resource_group_name, custom_headers=None, + raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.devices_operations.DevicesOperations.update + name: update + summary: Modifies a Data Box Edge/Gateway resource. + signature: update(device_name, resource_group_name, tags=None, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: tags + description: The tags attached to the Data Box Edge/Gateway resource. + defaultValue: None + types: + - [, ] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: DataBoxEdgeDevice or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.devices_operations.DevicesOperations.upload_certificate + name: upload_certificate + summary: Uploads registration certificate for the device. + signature: upload_certificate(device_name, resource_group_name, certificate, authentication_type=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: certificate + description: The base64 encoded certificate raw data. + isRequired: true + types: + - + - name: authentication_type + description: 'The authentication type. Possible values + + include: ''Invalid'', ''AzureActiveDirectory''' + defaultValue: None + types: + - + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: UploadCertificateResponse or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.devices_operations.DevicesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.devices_operations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.devices_operations.yml new file mode 100644 index 00000000..a5f87d0b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.devices_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.operations.devices_operations +name: devices_operations +fullName: azure.mgmt.edgegateway.operations.devices_operations +classes: +- azure.mgmt.edgegateway.operations.devices_operations.DevicesOperations diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.jobs_operations.JobsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.jobs_operations.JobsOperations.yml new file mode 100644 index 00000000..f5492b87 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.jobs_operations.JobsOperations.yml @@ -0,0 +1,74 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.jobs_operations.JobsOperations +name: JobsOperations +fullName: azure.mgmt.edgegateway.operations.jobs_operations.JobsOperations +module: azure.mgmt.edgegateway.operations.jobs_operations +summary: JobsOperations operations. +constructor: + syntax: JobsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.jobs_operations.JobsOperations.get + name: get + summary: Gets the details of a specified job on a data box edge/gateway device. + signature: get(device_name, name, resource_group_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The job name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Job or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.jobs_operations.JobsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.jobs_operations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.jobs_operations.yml new file mode 100644 index 00000000..4bb7800c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.jobs_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.operations.jobs_operations +name: jobs_operations +fullName: azure.mgmt.edgegateway.operations.jobs_operations +classes: +- azure.mgmt.edgegateway.operations.jobs_operations.JobsOperations diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.operations.Operations.yml new file mode 100644 index 00000000..eab8e96d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.operations.Operations.yml @@ -0,0 +1,57 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.operations.Operations +name: Operations +fullName: azure.mgmt.edgegateway.operations.operations.Operations +module: azure.mgmt.edgegateway.operations.operations +summary: Operations operations. +constructor: + syntax: Operations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.operations.Operations.list + name: list + summary: List all the supported operations. + signature: list(custom_headers=None, raw=False, **operation_config) + parameters: + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of Operation + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.operations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.operations.yml new file mode 100644 index 00000000..aa725e5c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.operations.operations +name: operations +fullName: azure.mgmt.edgegateway.operations.operations +classes: +- azure.mgmt.edgegateway.operations.operations.Operations diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.operations_status_operations.OperationsStatusOperations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.operations_status_operations.OperationsStatusOperations.yml new file mode 100644 index 00000000..273feea5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.operations_status_operations.OperationsStatusOperations.yml @@ -0,0 +1,74 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.operations_status_operations.OperationsStatusOperations +name: OperationsStatusOperations +fullName: azure.mgmt.edgegateway.operations.operations_status_operations.OperationsStatusOperations +module: azure.mgmt.edgegateway.operations.operations_status_operations +summary: OperationsStatusOperations operations. +constructor: + syntax: OperationsStatusOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.operations_status_operations.OperationsStatusOperations.get + name: get + summary: Gets the details of a specified job on a data box edge/gateway device. + signature: get(device_name, name, resource_group_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The job name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Job or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.operations_status_operations.OperationsStatusOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.operations_status_operations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.operations_status_operations.yml new file mode 100644 index 00000000..20f2e123 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.operations_status_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.operations.operations_status_operations +name: operations_status_operations +fullName: azure.mgmt.edgegateway.operations.operations_status_operations +classes: +- azure.mgmt.edgegateway.operations.operations_status_operations.OperationsStatusOperations diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.orders_operations.OrdersOperations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.orders_operations.OrdersOperations.yml new file mode 100644 index 00000000..baf68775 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.orders_operations.OrdersOperations.yml @@ -0,0 +1,197 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.orders_operations.OrdersOperations +name: OrdersOperations +fullName: azure.mgmt.edgegateway.operations.orders_operations.OrdersOperations +module: azure.mgmt.edgegateway.operations.orders_operations +summary: OrdersOperations operations. +constructor: + syntax: OrdersOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.orders_operations.OrdersOperations.create_or_update + name: create_or_update + summary: Creates or updates an order. + signature: create_or_update(device_name, order, resource_group_name, custom_headers=None, + raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: order + description: The order to be created or updated. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns Order or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.orders_operations.OrdersOperations.delete + name: delete + summary: Deletes the order related to the device. + signature: delete(device_name, resource_group_name, custom_headers=None, raw=False, + polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.orders_operations.OrdersOperations.get + name: get + summary: Gets a specific order by name. + signature: get(device_name, resource_group_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Order or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.orders_operations.OrdersOperations.list_by_data_box_edge_device + name: list_by_data_box_edge_device + summary: Lists all the orders related to a data box edge/gateway device. + signature: list_by_data_box_edge_device(device_name, resource_group_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of Order + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.orders_operations.OrdersOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.orders_operations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.orders_operations.yml new file mode 100644 index 00000000..ba4e8e88 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.orders_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.operations.orders_operations +name: orders_operations +fullName: azure.mgmt.edgegateway.operations.orders_operations +classes: +- azure.mgmt.edgegateway.operations.orders_operations.OrdersOperations diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.roles_operations.RolesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.roles_operations.RolesOperations.yml new file mode 100644 index 00000000..9ca8ec40 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.roles_operations.RolesOperations.yml @@ -0,0 +1,212 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.roles_operations.RolesOperations +name: RolesOperations +fullName: azure.mgmt.edgegateway.operations.roles_operations.RolesOperations +module: azure.mgmt.edgegateway.operations.roles_operations +summary: RolesOperations operations. +constructor: + syntax: RolesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.roles_operations.RolesOperations.create_or_update + name: create_or_update + summary: Create or update a role. + signature: create_or_update(device_name, name, role, resource_group_name, custom_headers=None, + raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The role name. + isRequired: true + types: + - + - name: role + description: The role properties. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns Role or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.roles_operations.RolesOperations.delete + name: delete + summary: Deletes the role on the data box edge device. + signature: delete(device_name, name, resource_group_name, custom_headers=None, raw=False, + polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The role name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.roles_operations.RolesOperations.get + name: get + summary: Gets a specific role by name. + signature: get(device_name, name, resource_group_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The role name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Role or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.roles_operations.RolesOperations.list_by_data_box_edge_device + name: list_by_data_box_edge_device + summary: Lists all the roles configured in a data box edge/gateway device. + signature: list_by_data_box_edge_device(device_name, resource_group_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of Role + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.roles_operations.RolesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.roles_operations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.roles_operations.yml new file mode 100644 index 00000000..0812659d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.roles_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.operations.roles_operations +name: roles_operations +fullName: azure.mgmt.edgegateway.operations.roles_operations +classes: +- azure.mgmt.edgegateway.operations.roles_operations.RolesOperations diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.shares_operations.SharesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.shares_operations.SharesOperations.yml new file mode 100644 index 00000000..f6a7181b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.shares_operations.SharesOperations.yml @@ -0,0 +1,259 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.shares_operations.SharesOperations +name: SharesOperations +fullName: azure.mgmt.edgegateway.operations.shares_operations.SharesOperations +module: azure.mgmt.edgegateway.operations.shares_operations +summary: SharesOperations operations. +constructor: + syntax: SharesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.shares_operations.SharesOperations.create_or_update + name: create_or_update + summary: Creates a new share or updates an existing share on the device. + signature: create_or_update(device_name, name, share, resource_group_name, custom_headers=None, + raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The share name. + isRequired: true + types: + - + - name: share + description: The share properties. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns Share or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.shares_operations.SharesOperations.delete + name: delete + summary: Deletes the share on the data box edge/gateway device. + signature: delete(device_name, name, resource_group_name, custom_headers=None, raw=False, + polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The share name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.shares_operations.SharesOperations.get + name: get + summary: Gets a share by name. + signature: get(device_name, name, resource_group_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The share name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Share or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.shares_operations.SharesOperations.list_by_data_box_edge_device + name: list_by_data_box_edge_device + summary: Lists all the shares in a data box edge/gateway device. + signature: list_by_data_box_edge_device(device_name, resource_group_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of Share + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.shares_operations.SharesOperations.refresh + name: refresh + summary: Refreshes the share metadata with the data from the cloud. + signature: refresh(device_name, name, resource_group_name, custom_headers=None, + raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The share name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.shares_operations.SharesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.shares_operations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.shares_operations.yml new file mode 100644 index 00000000..230abc5b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.shares_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.operations.shares_operations +name: shares_operations +fullName: azure.mgmt.edgegateway.operations.shares_operations +classes: +- azure.mgmt.edgegateway.operations.shares_operations.SharesOperations diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.storage_account_credentials_operations.StorageAccountCredentialsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.storage_account_credentials_operations.StorageAccountCredentialsOperations.yml new file mode 100644 index 00000000..55bb89a1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.storage_account_credentials_operations.StorageAccountCredentialsOperations.yml @@ -0,0 +1,216 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.storage_account_credentials_operations.StorageAccountCredentialsOperations +name: StorageAccountCredentialsOperations +fullName: azure.mgmt.edgegateway.operations.storage_account_credentials_operations.StorageAccountCredentialsOperations +module: azure.mgmt.edgegateway.operations.storage_account_credentials_operations +summary: StorageAccountCredentialsOperations operations. +constructor: + syntax: StorageAccountCredentialsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.storage_account_credentials_operations.StorageAccountCredentialsOperations.create_or_update + name: create_or_update + summary: Creates or updates the storage account credential. + signature: create_or_update(device_name, name, storage_account_credential, resource_group_name, + custom_headers=None, raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The storage account credential name. + isRequired: true + types: + - + - name: storage_account_credential + description: The storage account credential. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns + + StorageAccountCredential or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.storage_account_credentials_operations.StorageAccountCredentialsOperations.delete + name: delete + summary: Deletes the storage account credential. + signature: delete(device_name, name, resource_group_name, custom_headers=None, raw=False, + polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The storage account credential name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.storage_account_credentials_operations.StorageAccountCredentialsOperations.get + name: get + summary: Gets the properties of the specified storage account credential. + signature: get(device_name, name, resource_group_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The storage account credential name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: StorageAccountCredential or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.storage_account_credentials_operations.StorageAccountCredentialsOperations.list_by_data_box_edge_device + name: list_by_data_box_edge_device + summary: 'Gets all the storage account credentials in a data box edge/gateway + + device.' + signature: list_by_data_box_edge_device(device_name, resource_group_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of StorageAccountCredential + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.storage_account_credentials_operations.StorageAccountCredentialsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.storage_account_credentials_operations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.storage_account_credentials_operations.yml new file mode 100644 index 00000000..2f210bfd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.storage_account_credentials_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.operations.storage_account_credentials_operations +name: storage_account_credentials_operations +fullName: azure.mgmt.edgegateway.operations.storage_account_credentials_operations +classes: +- azure.mgmt.edgegateway.operations.storage_account_credentials_operations.StorageAccountCredentialsOperations diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.triggers_operations.TriggersOperations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.triggers_operations.TriggersOperations.yml new file mode 100644 index 00000000..d95fde73 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.triggers_operations.TriggersOperations.yml @@ -0,0 +1,219 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.triggers_operations.TriggersOperations +name: TriggersOperations +fullName: azure.mgmt.edgegateway.operations.triggers_operations.TriggersOperations +module: azure.mgmt.edgegateway.operations.triggers_operations +summary: TriggersOperations operations. +constructor: + syntax: TriggersOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.triggers_operations.TriggersOperations.create_or_update + name: create_or_update + summary: Creates or updates a trigger. + signature: create_or_update(device_name, name, trigger, resource_group_name, custom_headers=None, + raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: Creates or updates a trigger + isRequired: true + types: + - + - name: name + description: The trigger name. + isRequired: true + types: + - + - name: trigger + description: The trigger. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns Trigger or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.triggers_operations.TriggersOperations.delete + name: delete + summary: Deletes the trigger on the gateway device. + signature: delete(device_name, name, resource_group_name, custom_headers=None, raw=False, + polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The trigger name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.triggers_operations.TriggersOperations.get + name: get + summary: Get a specific trigger by name. + signature: get(device_name, name, resource_group_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The trigger name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: Trigger or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.triggers_operations.TriggersOperations.list_by_data_box_edge_device + name: list_by_data_box_edge_device + summary: Lists all the triggers configured in the device. + signature: list_by_data_box_edge_device(device_name, resource_group_name, expand=None, + custom_headers=None, raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: expand + description: 'Specify $filter=''CustomContextTag eq '' to filter + + on custom context tag property' + defaultValue: None + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of Trigger + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.triggers_operations.TriggersOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.triggers_operations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.triggers_operations.yml new file mode 100644 index 00000000..fb4fa755 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.triggers_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.operations.triggers_operations +name: triggers_operations +fullName: azure.mgmt.edgegateway.operations.triggers_operations +classes: +- azure.mgmt.edgegateway.operations.triggers_operations.TriggersOperations diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.users_operations.UsersOperations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.users_operations.UsersOperations.yml new file mode 100644 index 00000000..8ed9666a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.users_operations.UsersOperations.yml @@ -0,0 +1,221 @@ +### YamlMime:PythonClass +uid: azure.mgmt.edgegateway.operations.users_operations.UsersOperations +name: UsersOperations +fullName: azure.mgmt.edgegateway.operations.users_operations.UsersOperations +module: azure.mgmt.edgegateway.operations.users_operations +summary: UsersOperations operations. +constructor: + syntax: UsersOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: 'The API version. Constant value: "2019-03-01".' + name: api_version +methods: +- uid: azure.mgmt.edgegateway.operations.users_operations.UsersOperations.create_or_update + name: create_or_update + summary: 'Creates a new user or updates an existing user''s information on a data + + box edge/gateway device.' + signature: create_or_update(device_name, name, resource_group_name, encrypted_password=None, + share_access_rights=None, custom_headers=None, raw=False, polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The user name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: encrypted_password + description: The password details. + defaultValue: None + types: + - + - name: share_access_rights + description: 'List of shares that the user has rights + + on. This field should not be specified during user creation.' + defaultValue: None + types: + - [] + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns User or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.users_operations.UsersOperations.delete + name: delete + summary: Deletes the user on a databox edge/gateway device. + signature: delete(device_name, name, resource_group_name, custom_headers=None, raw=False, + polling=True, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The user name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'The poller return type is ClientRawResponse, the + + direct response alongside the deserialized response' + defaultValue: 'False' + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + defaultValue: 'True' + return: + description: 'An instance of LROPoller that returns None or + + ClientRawResponse if raw==True' + types: + - [] + - [[]] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.users_operations.UsersOperations.get + name: get + summary: Gets the properties of the specified user. + signature: get(device_name, name, resource_group_name, custom_headers=None, raw=False, + **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: name + description: The user name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: User or ClientRawResponse if raw=true + types: + - + - + exceptions: + - type: msrestazure.azure_exceptions.CloudError +- uid: azure.mgmt.edgegateway.operations.users_operations.UsersOperations.list_by_data_box_edge_device + name: list_by_data_box_edge_device + summary: Gets all the users registered on a data box edge/gateway device. + signature: list_by_data_box_edge_device(device_name, resource_group_name, custom_headers=None, + raw=False, **operation_config) + parameters: + - name: device_name + description: The device name. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: custom_headers + description: headers that will be added to the request + defaultValue: None + types: + - + - name: raw + description: 'returns the direct response alongside the + + deserialized response' + defaultValue: 'False' + types: + - + - name: operation_config + description: '*Operation configuration + + overrides*.' + isRequired: true + return: + description: An iterator like instance of User + types: + - [] + exceptions: + - type: msrestazure.azure_exceptions.CloudError +attributes: +- uid: azure.mgmt.edgegateway.operations.users_operations.UsersOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.users_operations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.users_operations.yml new file mode 100644 index 00000000..d5e0c855 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.users_operations.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.operations.users_operations +name: users_operations +fullName: azure.mgmt.edgegateway.operations.users_operations +classes: +- azure.mgmt.edgegateway.operations.users_operations.UsersOperations diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.yml new file mode 100644 index 00000000..9875e06e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.operations.yml @@ -0,0 +1,31 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.edgegateway.operations +name: operations +fullName: azure.mgmt.edgegateway.operations +type: import +classes: +- azure.mgmt.edgegateway.operations.AlertsOperations +- azure.mgmt.edgegateway.operations.BandwidthSchedulesOperations +- azure.mgmt.edgegateway.operations.DevicesOperations +- azure.mgmt.edgegateway.operations.JobsOperations +- azure.mgmt.edgegateway.operations.Operations +- azure.mgmt.edgegateway.operations.OperationsStatusOperations +- azure.mgmt.edgegateway.operations.OrdersOperations +- azure.mgmt.edgegateway.operations.RolesOperations +- azure.mgmt.edgegateway.operations.SharesOperations +- azure.mgmt.edgegateway.operations.StorageAccountCredentialsOperations +- azure.mgmt.edgegateway.operations.TriggersOperations +- azure.mgmt.edgegateway.operations.UsersOperations +modules: +- azure.mgmt.edgegateway.operations.alerts_operations +- azure.mgmt.edgegateway.operations.bandwidth_schedules_operations +- azure.mgmt.edgegateway.operations.devices_operations +- azure.mgmt.edgegateway.operations.jobs_operations +- azure.mgmt.edgegateway.operations.operations +- azure.mgmt.edgegateway.operations.operations_status_operations +- azure.mgmt.edgegateway.operations.orders_operations +- azure.mgmt.edgegateway.operations.roles_operations +- azure.mgmt.edgegateway.operations.shares_operations +- azure.mgmt.edgegateway.operations.storage_account_credentials_operations +- azure.mgmt.edgegateway.operations.triggers_operations +- azure.mgmt.edgegateway.operations.users_operations diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.version.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.version.yml new file mode 100644 index 00000000..2dcd1ad0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.version.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.mgmt.edgegateway.version +name: version +fullName: azure.mgmt.edgegateway.version diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.yml new file mode 100644 index 00000000..3c407aff --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.edgegateway +name: edgegateway +fullName: azure.mgmt.edgegateway +type: rootImport +classes: +- azure.mgmt.edgegateway.DataBoxEdgeManagementClient +packages: +- azure.mgmt.edgegateway.models +- azure.mgmt.edgegateway.operations +modules: +- azure.mgmt.edgegateway.data_box_edge_management_client +- azure.mgmt.edgegateway.version diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.MicrosoftLogz.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.MicrosoftLogz.yml new file mode 100644 index 00000000..73fba668 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.MicrosoftLogz.yml @@ -0,0 +1,72 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.MicrosoftLogz +name: MicrosoftLogz +fullName: azure.mgmt.logz.MicrosoftLogz +module: azure.mgmt.logz +summary: MicrosoftLogz. +constructor: + syntax: 'MicrosoftLogz(credential: TokenCredential, subscription_id: str, base_url: + str = ''https://management.azure.com'', **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. Required. + isRequired: true + types: + - + - name: subscription_id + description: The ID of the target subscription. Required. + isRequired: true + types: + - + - name: base_url + description: Service URL. Default value is "`https://management.azure.com`". + defaultValue: https://management.azure.com + types: + - + keywordOnlyParameters: + - name: api_version + description: 'Api Version. Default value is "2020-10-01". Note that overriding + this + + default value may result in unsupported behavior.' + types: + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - +variables: +- description: MonitorsOperations operations + name: monitors + types: + - +- description: Operations operations + name: operations + types: + - +- description: TagRulesOperations operations + name: tag_rules + types: + - +- description: SingleSignOnOperations operations + name: single_sign_on + types: + - +- description: SubAccountOperations operations + name: sub_account + types: + - +- description: SubAccountTagRulesOperations operations + name: sub_account_tag_rules + types: + - +- description: MonitorOperations operations + name: monitor + types: + - +methods: +- uid: azure.mgmt.logz.MicrosoftLogz.close + name: close + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.MicrosoftLogz.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.MicrosoftLogz.yml new file mode 100644 index 00000000..3d983128 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.MicrosoftLogz.yml @@ -0,0 +1,72 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.aio.MicrosoftLogz +name: MicrosoftLogz +fullName: azure.mgmt.logz.aio.MicrosoftLogz +module: azure.mgmt.logz.aio +summary: MicrosoftLogz. +constructor: + syntax: 'MicrosoftLogz(credential: AsyncTokenCredential, subscription_id: str, base_url: + str = ''https://management.azure.com'', **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. Required. + isRequired: true + types: + - + - name: subscription_id + description: The ID of the target subscription. Required. + isRequired: true + types: + - + - name: base_url + description: Service URL. Default value is "`https://management.azure.com`". + defaultValue: https://management.azure.com + types: + - + keywordOnlyParameters: + - name: api_version + description: 'Api Version. Default value is "2020-10-01". Note that overriding + this + + default value may result in unsupported behavior.' + types: + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - +variables: +- description: MonitorsOperations operations + name: monitors + types: + - +- description: Operations operations + name: operations + types: + - +- description: TagRulesOperations operations + name: tag_rules + types: + - +- description: SingleSignOnOperations operations + name: single_sign_on + types: + - +- description: SubAccountOperations operations + name: sub_account + types: + - +- description: SubAccountTagRulesOperations operations + name: sub_account_tag_rules + types: + - +- description: MonitorOperations operations + name: monitor + types: + - +methods: +- uid: azure.mgmt.logz.aio.MicrosoftLogz.close + name: close + signature: async close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.MonitorOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.MonitorOperations.yml new file mode 100644 index 00000000..bdbb177f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.MonitorOperations.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.aio.operations.MonitorOperations +name: MonitorOperations +fullName: azure.mgmt.logz.aio.operations.MonitorOperations +module: azure.mgmt.logz.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: MonitorOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.logz.aio.operations.MonitorOperations.list_vm_host_update + name: list_vm_host_update + summary: 'Sending request to update the collection when Logz.io agent has been installed + on a VM for a + + given monitor. + + + Sending request to update the collection when Logz.io agent has been installed + on a VM for a + + given monitor.' + signature: 'list_vm_host_update(resource_group_name: str, monitor_name: str, body: + _models.VMHostUpdateRequest | None = None, *, content_type: str = ''application/json'', + **kwargs: Any) -> AsyncIterable[''_models.VMResources'']' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: body + description: 'Request body to update the collection for agent installed in the + given monitor. Is + + either a model type or a IO type. Default value is None.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either VMResources or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.MonitorOperations.list_vm_hosts + name: list_vm_hosts + summary: 'List the compute resources currently being monitored by the Logz main + account resource. + + + List the compute resources currently being monitored by the Logz main account + resource.' + signature: 'list_vm_hosts(resource_group_name: str, monitor_name: str, **kwargs: + Any) -> AsyncIterable[VMResources]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either VMResources or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.MonitorOperations.vm_host_payload + name: vm_host_payload + summary: 'Returns the payload that needs to be passed in the request body for installing + Logz.io agent on + + a VM. + + + Returns the payload that needs to be passed in the request body for installing + Logz.io agent on + + a VM.' + signature: 'async vm_host_payload(resource_group_name: str, monitor_name: str, **kwargs: + Any) -> VMExtensionPayload' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VMExtensionPayload or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.logz.aio.operations.MonitorOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.MonitorsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.MonitorsOperations.yml new file mode 100644 index 00000000..a10a9c0c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.MonitorsOperations.yml @@ -0,0 +1,348 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.aio.operations.MonitorsOperations +name: MonitorsOperations +fullName: azure.mgmt.logz.aio.operations.MonitorsOperations +module: azure.mgmt.logz.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: MonitorsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.logz.aio.operations.MonitorsOperations.begin_create + name: begin_create + summary: 'Create a monitor resource. This create operation can take upto 10 minutes + to complete. + + + Create a monitor resource. This create operation can take upto 10 minutes to complete.' + signature: 'async begin_create(resource_group_name: str, monitor_name: str, body: + _models.LogzMonitorResource | None = None, *, content_type: str = ''application/json'', + **kwargs: Any) -> AsyncLROPoller[_models.LogzMonitorResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: body + description: Is either a model type or a IO type. Default value is None. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of AsyncLROPoller that returns either LogzMonitorResource + or the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.MonitorsOperations.begin_delete + name: begin_delete + summary: 'Delete a monitor resource. This delete operation can take upto 10 minutes + to complete. + + + Delete a monitor resource. This delete operation can take upto 10 minutes to complete.' + signature: 'async begin_delete(resource_group_name: str, monitor_name: str, **kwargs: + Any) -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.MonitorsOperations.get + name: get + summary: 'Get the properties of a specific monitor resource. + + + Get the properties of a specific monitor resource.' + signature: 'async get(resource_group_name: str, monitor_name: str, **kwargs: Any) + -> LogzMonitorResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LogzMonitorResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.MonitorsOperations.list_by_resource_group + name: list_by_resource_group + summary: 'List all monitors under the specified resource group. + + + List all monitors under the specified resource group.' + signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[LogzMonitorResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either LogzMonitorResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.MonitorsOperations.list_by_subscription + name: list_by_subscription + summary: 'List all monitors under the specified subscription. + + + List all monitors under the specified subscription.' + signature: 'list_by_subscription(**kwargs: Any) -> AsyncIterable[LogzMonitorResource]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either LogzMonitorResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.MonitorsOperations.list_monitored_resources + name: list_monitored_resources + summary: 'List the resources currently being monitored by the Logz monitor resource. + + + List the resources currently being monitored by the Logz monitor resource.' + signature: 'list_monitored_resources(resource_group_name: str, monitor_name: str, + **kwargs: Any) -> AsyncIterable[MonitoredResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either MonitoredResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.MonitorsOperations.list_user_roles + name: list_user_roles + summary: 'List the user''s roles configured on Logz.io side for the account corresponding + to the monitor + + resource. + + + List the user''s roles configured on Logz.io side for the account corresponding + to the monitor + + resource.' + signature: 'list_user_roles(resource_group_name: str, monitor_name: str, body: _models.UserRoleRequest + | None = None, *, content_type: str = ''application/json'', **kwargs: Any) -> + AsyncIterable[''_models.UserRoleResponse'']' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: body + description: Is either a model type or a IO type. Default value is None. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either UserRoleResponse or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.MonitorsOperations.update + name: update + summary: 'Update a monitor resource. + + + Update a monitor resource.' + signature: 'async update(resource_group_name: str, monitor_name: str, body: _models.LogzMonitorResourceUpdateParameters + | None = None, *, content_type: str = ''application/json'', **kwargs: Any) -> + _models.LogzMonitorResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: body + description: Is either a model type or a IO type. Default value is None. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LogzMonitorResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.logz.aio.operations.MonitorsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.Operations.yml new file mode 100644 index 00000000..f1db2595 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.Operations.yml @@ -0,0 +1,34 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.aio.operations.Operations +name: Operations +fullName: azure.mgmt.logz.aio.operations.Operations +module: azure.mgmt.logz.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: Operations(*args, **kwargs) +methods: +- uid: azure.mgmt.logz.aio.operations.Operations.list + name: list + summary: 'List all operations provided by Microsoft.Logz. + + + List all operations provided by Microsoft.Logz.' + signature: 'list(**kwargs: Any) -> AsyncIterable[OperationResult]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either OperationResult or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.logz.aio.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SingleSignOnOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SingleSignOnOperations.yml new file mode 100644 index 00000000..2a944025 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SingleSignOnOperations.yml @@ -0,0 +1,167 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.aio.operations.SingleSignOnOperations +name: SingleSignOnOperations +fullName: azure.mgmt.logz.aio.operations.SingleSignOnOperations +module: azure.mgmt.logz.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: SingleSignOnOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.logz.aio.operations.SingleSignOnOperations.begin_create_or_update + name: begin_create_or_update + summary: 'Configures single-sign-on for this resource. This operation can take upto + 10 minutes to + + complete. + + + Configures single-sign-on for this resource. This operation can take upto 10 minutes + to + + complete.' + signature: 'async begin_create_or_update(resource_group_name: str, monitor_name: + str, configuration_name: str, body: _models.LogzSingleSignOnResource | None = + None, *, content_type: str = ''application/json'', **kwargs: Any) -> AsyncLROPoller[_models.LogzSingleSignOnResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: configuration_name + description: Required. + isRequired: true + types: + - + - name: body + description: Is either a model type or a IO type. Default value is None. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of AsyncLROPoller that returns either LogzSingleSignOnResource + or the + + result of cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.SingleSignOnOperations.get + name: get + summary: 'Gets the Logz single sign-on resource for the given Monitor. + + + Gets the Logz single sign-on resource for the given Monitor.' + signature: 'async get(resource_group_name: str, monitor_name: str, configuration_name: + str, **kwargs: Any) -> LogzSingleSignOnResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: configuration_name + description: Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LogzSingleSignOnResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.SingleSignOnOperations.list + name: list + summary: 'List the single sign-on configurations for a given monitor resource. + + + List the single sign-on configurations for a given monitor resource.' + signature: 'list(resource_group_name: str, monitor_name: str, **kwargs: Any) -> + AsyncIterable[LogzSingleSignOnResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either LogzSingleSignOnResource or + the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.logz.aio.operations.SingleSignOnOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SubAccountOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SubAccountOperations.yml new file mode 100644 index 00000000..4f1a3ea7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SubAccountOperations.yml @@ -0,0 +1,452 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.aio.operations.SubAccountOperations +name: SubAccountOperations +fullName: azure.mgmt.logz.aio.operations.SubAccountOperations +module: azure.mgmt.logz.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: SubAccountOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.logz.aio.operations.SubAccountOperations.begin_create + name: begin_create + summary: 'Create sub account under a given monitor resource. This create operation + can take upto 10 + + minutes to complete. + + + Create sub account under a given monitor resource. This create operation can take + upto 10 + + minutes to complete.' + signature: 'async begin_create(resource_group_name: str, monitor_name: str, sub_account_name: + str, body: _models.LogzMonitorResource | None = None, *, content_type: str = ''application/json'', + **kwargs: Any) -> AsyncLROPoller[_models.LogzMonitorResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + - name: body + description: Is either a model type or a IO type. Default value is None. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of AsyncLROPoller that returns either LogzMonitorResource + or the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.SubAccountOperations.begin_delete + name: begin_delete + summary: 'Delete a sub account resource. This delete operation can take upto 10 + minutes to complete. + + + Delete a sub account resource. This delete operation can take upto 10 minutes + to complete.' + signature: 'async begin_delete(resource_group_name: str, monitor_name: str, sub_account_name: + str, **kwargs: Any) -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.SubAccountOperations.get + name: get + summary: 'Get a sub account under a given monitor resource. + + + Get a sub account under a given monitor resource.' + signature: 'async get(resource_group_name: str, monitor_name: str, sub_account_name: + str, **kwargs: Any) -> LogzMonitorResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LogzMonitorResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.SubAccountOperations.list + name: list + summary: 'List the sub account under a given monitor resource. + + + List the sub account under a given monitor resource.' + signature: 'list(resource_group_name: str, monitor_name: str, **kwargs: Any) -> + AsyncIterable[LogzMonitorResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either LogzMonitorResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.SubAccountOperations.list_monitored_resources + name: list_monitored_resources + summary: 'List the resources currently being monitored by the Logz sub account resource. + + + List the resources currently being monitored by the Logz sub account resource.' + signature: 'list_monitored_resources(resource_group_name: str, monitor_name: str, + sub_account_name: str, **kwargs: Any) -> AsyncIterable[MonitoredResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either MonitoredResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.SubAccountOperations.list_vm_host_update + name: list_vm_host_update + summary: 'Sending request to update the collection when Logz.io agent has been installed + on a VM for a + + given monitor. + + + Sending request to update the collection when Logz.io agent has been installed + on a VM for a + + given monitor.' + signature: 'list_vm_host_update(resource_group_name: str, monitor_name: str, sub_account_name: + str, body: _models.VMHostUpdateRequest | None = None, *, content_type: str = ''application/json'', + **kwargs: Any) -> AsyncIterable[''_models.VMResources'']' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + - name: body + description: 'Request body to update the collection for agent installed in the + given monitor. Is + + either a model type or a IO type. Default value is None.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either VMResources or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.SubAccountOperations.list_vm_hosts + name: list_vm_hosts + summary: 'List the compute resources currently being monitored by the Logz sub account + resource. + + + List the compute resources currently being monitored by the Logz sub account resource.' + signature: 'list_vm_hosts(resource_group_name: str, monitor_name: str, sub_account_name: + str, **kwargs: Any) -> AsyncIterable[VMResources]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either VMResources or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.SubAccountOperations.update + name: update + summary: 'Update a monitor resource. + + + Update a monitor resource.' + signature: 'async update(resource_group_name: str, monitor_name: str, sub_account_name: + str, body: _models.LogzMonitorResourceUpdateParameters | None = None, *, content_type: + str = ''application/json'', **kwargs: Any) -> _models.LogzMonitorResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + - name: body + description: Is either a model type or a IO type. Default value is None. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LogzMonitorResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.SubAccountOperations.vm_host_payload + name: vm_host_payload + summary: 'Returns the payload that needs to be passed as a request for installing + Logz.io agent on a VM. + + + Returns the payload that needs to be passed as a request for installing Logz.io + agent on a VM.' + signature: 'async vm_host_payload(resource_group_name: str, monitor_name: str, sub_account_name: + str, **kwargs: Any) -> VMExtensionPayload' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VMExtensionPayload or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.logz.aio.operations.SubAccountOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SubAccountTagRulesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SubAccountTagRulesOperations.yml new file mode 100644 index 00000000..1bb89dc1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SubAccountTagRulesOperations.yml @@ -0,0 +1,192 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.aio.operations.SubAccountTagRulesOperations +name: SubAccountTagRulesOperations +fullName: azure.mgmt.logz.aio.operations.SubAccountTagRulesOperations +module: azure.mgmt.logz.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: SubAccountTagRulesOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.logz.aio.operations.SubAccountTagRulesOperations.create_or_update + name: create_or_update + summary: 'Create or update a tag rule set for a given sub account resource. + + + Create or update a tag rule set for a given sub account resource.' + signature: 'async create_or_update(resource_group_name: str, monitor_name: str, + sub_account_name: str, rule_set_name: str, body: _models.MonitoringTagRules | + None = None, *, content_type: str = ''application/json'', **kwargs: Any) -> _models.MonitoringTagRules' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + - name: rule_set_name + description: Required. + isRequired: true + types: + - + - name: body + description: Is either a model type or a IO type. Default value is None. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: MonitoringTagRules or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.SubAccountTagRulesOperations.delete + name: delete + summary: 'Delete a tag rule set for a given monitor resource. + + + Delete a tag rule set for a given monitor resource.' + signature: 'async delete(resource_group_name: str, monitor_name: str, sub_account_name: + str, rule_set_name: str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + - name: rule_set_name + description: Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.SubAccountTagRulesOperations.get + name: get + summary: 'Get a tag rule set for a given monitor resource. + + + Get a tag rule set for a given monitor resource.' + signature: 'async get(resource_group_name: str, monitor_name: str, sub_account_name: + str, rule_set_name: str, **kwargs: Any) -> MonitoringTagRules' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + - name: rule_set_name + description: Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: MonitoringTagRules or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.SubAccountTagRulesOperations.list + name: list + summary: 'List the tag rules for a given sub account resource. + + + List the tag rules for a given sub account resource.' + signature: 'list(resource_group_name: str, monitor_name: str, sub_account_name: + str, **kwargs: Any) -> AsyncIterable[MonitoringTagRules]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either MonitoringTagRules or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.logz.aio.operations.SubAccountTagRulesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.TagRulesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.TagRulesOperations.yml new file mode 100644 index 00000000..eaca9d9d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.TagRulesOperations.yml @@ -0,0 +1,172 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.aio.operations.TagRulesOperations +name: TagRulesOperations +fullName: azure.mgmt.logz.aio.operations.TagRulesOperations +module: azure.mgmt.logz.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: TagRulesOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.logz.aio.operations.TagRulesOperations.create_or_update + name: create_or_update + summary: 'Create or update a tag rule set for a given monitor resource. + + + Create or update a tag rule set for a given monitor resource.' + signature: 'async create_or_update(resource_group_name: str, monitor_name: str, + rule_set_name: str, body: _models.MonitoringTagRules | None = None, *, content_type: + str = ''application/json'', **kwargs: Any) -> _models.MonitoringTagRules' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: rule_set_name + description: Required. + isRequired: true + types: + - + - name: body + description: Is either a model type or a IO type. Default value is None. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: MonitoringTagRules or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.TagRulesOperations.delete + name: delete + summary: 'Delete a tag rule set for a given monitor resource. + + + Delete a tag rule set for a given monitor resource.' + signature: 'async delete(resource_group_name: str, monitor_name: str, rule_set_name: + str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: rule_set_name + description: Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.TagRulesOperations.get + name: get + summary: 'Get a tag rule set for a given monitor resource. + + + Get a tag rule set for a given monitor resource.' + signature: 'async get(resource_group_name: str, monitor_name: str, rule_set_name: + str, **kwargs: Any) -> MonitoringTagRules' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: rule_set_name + description: Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: MonitoringTagRules or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.aio.operations.TagRulesOperations.list + name: list + summary: 'List the tag rules for a given monitor resource. + + + List the tag rules for a given monitor resource.' + signature: 'list(resource_group_name: str, monitor_name: str, **kwargs: Any) -> + AsyncIterable[MonitoringTagRules]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either MonitoringTagRules or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.logz.aio.operations.TagRulesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.yml new file mode 100644 index 00000000..894e9ffb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.logz.aio.operations +name: operations +fullName: azure.mgmt.logz.aio.operations +type: import +classes: +- azure.mgmt.logz.aio.operations.MonitorOperations +- azure.mgmt.logz.aio.operations.MonitorsOperations +- azure.mgmt.logz.aio.operations.Operations +- azure.mgmt.logz.aio.operations.SingleSignOnOperations +- azure.mgmt.logz.aio.operations.SubAccountOperations +- azure.mgmt.logz.aio.operations.SubAccountTagRulesOperations +- azure.mgmt.logz.aio.operations.TagRulesOperations diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.yml new file mode 100644 index 00000000..01bdbb5d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.logz.aio +name: aio +fullName: azure.mgmt.logz.aio +type: import +classes: +- azure.mgmt.logz.aio.MicrosoftLogz +packages: +- azure.mgmt.logz.aio.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.CreatedByType.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.CreatedByType.yml new file mode 100644 index 00000000..cfbf6d1f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.CreatedByType.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.logz.models.CreatedByType +name: CreatedByType +fullName: azure.mgmt.logz.models.CreatedByType +summary: The type of identity that created the resource. +module: azure.mgmt.logz.models +fields: +- name: APPLICATION + uid: azure.mgmt.logz.models.CreatedByType.APPLICATION +- name: KEY + uid: azure.mgmt.logz.models.CreatedByType.KEY +- name: MANAGED_IDENTITY + uid: azure.mgmt.logz.models.CreatedByType.MANAGED_IDENTITY +- name: USER + uid: azure.mgmt.logz.models.CreatedByType.USER diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ErrorAdditionalInfo.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ErrorAdditionalInfo.yml new file mode 100644 index 00000000..231caa96 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ErrorAdditionalInfo.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.ErrorAdditionalInfo +name: ErrorAdditionalInfo +fullName: azure.mgmt.logz.models.ErrorAdditionalInfo +module: azure.mgmt.logz.models +summary: 'The resource management error additional info. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: ErrorAdditionalInfo(**kwargs) +variables: +- description: The additional info type. + name: type + types: + - +- description: The additional info. + name: info + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ErrorDetail.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ErrorDetail.yml new file mode 100644 index 00000000..313ac920 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ErrorDetail.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.ErrorDetail +name: ErrorDetail +fullName: azure.mgmt.logz.models.ErrorDetail +module: azure.mgmt.logz.models +summary: 'The error detail. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: ErrorDetail(**kwargs) +variables: +- description: The error code. + name: code + types: + - +- description: The error message. + name: message + types: + - +- description: The error target. + name: target + types: + - +- description: The error details. + name: details + types: + - [] +- description: The error additional info. + name: additional_info + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ErrorResponse.yml new file mode 100644 index 00000000..137e78bb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ErrorResponse.yml @@ -0,0 +1,19 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.ErrorResponse +name: ErrorResponse +fullName: azure.mgmt.logz.models.ErrorResponse +module: azure.mgmt.logz.models +summary: Common error response for all Azure Resource Manager APIs to return error + details for failed operations. (This also follows the OData error response format.). +constructor: + syntax: 'ErrorResponse(*, error: _models.ErrorDetail | None = None, **kwargs)' + keywordOnlyParameters: + - name: error + description: The error object. + types: + - +variables: +- description: The error object. + name: error + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.FilteringTag.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.FilteringTag.yml new file mode 100644 index 00000000..ebdb50b1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.FilteringTag.yml @@ -0,0 +1,44 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.FilteringTag +name: FilteringTag +fullName: azure.mgmt.logz.models.FilteringTag +module: azure.mgmt.logz.models +summary: The definition of a filtering tag. Filtering tags are used for capturing + resources and include/exclude them from being monitored. +constructor: + syntax: 'FilteringTag(*, name: str | None = None, value: str | None = None, action: + str | _models.TagAction | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: The name (also known as the key) of the tag. + types: + - + - name: value + description: The value of the tag. + types: + - + - name: action + description: 'Valid actions for a filtering tag. Exclusion takes priority over + inclusion. + + Known values are: "Include" and "Exclude".' + types: + - + - +variables: +- description: The name (also known as the key) of the tag. + name: name + types: + - +- description: The value of the tag. + name: value + types: + - +- description: 'Valid actions for a filtering tag. Exclusion takes priority over inclusion. + Known + + values are: "Include" and "Exclude".' + name: action + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.IdentityProperties.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.IdentityProperties.yml new file mode 100644 index 00000000..adadaf56 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.IdentityProperties.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.IdentityProperties +name: IdentityProperties +fullName: azure.mgmt.logz.models.IdentityProperties +module: azure.mgmt.logz.models +summary: 'IdentityProperties. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'IdentityProperties(*, type: str | _models.ManagedIdentityTypes | None = + None, **kwargs)' + keywordOnlyParameters: + - name: type + description: 'Known values are: "SystemAssigned" and "UserAssigned".' + types: + - + - +variables: +- description: The identity ID. + name: principal_id + types: + - +- description: The tenant ID of resource. + name: tenant_id + types: + - +- description: 'Known values are: "SystemAssigned" and "UserAssigned".' + name: type + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LiftrResourceCategories.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LiftrResourceCategories.yml new file mode 100644 index 00000000..ad1afc99 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LiftrResourceCategories.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.logz.models.LiftrResourceCategories +name: LiftrResourceCategories +fullName: azure.mgmt.logz.models.LiftrResourceCategories +summary: LiftrResourceCategories. +module: azure.mgmt.logz.models +fields: +- name: MONITOR_LOGS + uid: azure.mgmt.logz.models.LiftrResourceCategories.MONITOR_LOGS +- name: UNKNOWN + uid: azure.mgmt.logz.models.LiftrResourceCategories.UNKNOWN diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogRules.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogRules.yml new file mode 100644 index 00000000..6c2dce11 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogRules.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.LogRules +name: LogRules +fullName: azure.mgmt.logz.models.LogRules +module: azure.mgmt.logz.models +summary: Set of rules for sending logs for the Monitor resource. +constructor: + syntax: 'LogRules(*, send_aad_logs: bool | None = None, send_subscription_logs: + bool | None = None, send_activity_logs: bool | None = None, filtering_tags: List[_models.FilteringTag] + | None = None, **kwargs)' + keywordOnlyParameters: + - name: send_aad_logs + description: Flag specifying if AAD logs should be sent for the Monitor resource. + types: + - + - name: send_subscription_logs + description: 'Flag specifying if subscription logs should be sent for the + + Monitor resource.' + types: + - + - name: send_activity_logs + description: 'Flag specifying if activity logs from Azure resources should be + + sent for the Monitor resource.' + types: + - + - name: filtering_tags + description: 'List of filtering tags to be used for capturing logs. This only + takes + + effect if SendActivityLogs flag is enabled. If empty, all resources will be + captured. If only + + Exclude action is specified, the rules will apply to the list of all available + resources. If + + Include actions are specified, the rules will only include resources with the + associated tags.' + types: + - [] +variables: +- description: Flag specifying if AAD logs should be sent for the Monitor resource. + name: send_aad_logs + types: + - +- description: 'Flag specifying if subscription logs should be sent for the + + Monitor resource.' + name: send_subscription_logs + types: + - +- description: 'Flag specifying if activity logs from Azure resources should be sent + + for the Monitor resource.' + name: send_activity_logs + types: + - +- description: 'List of filtering tags to be used for capturing logs. This only takes + + effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. + If only + + Exclude action is specified, the rules will apply to the list of all available + resources. If + + Include actions are specified, the rules will only include resources with the + associated tags.' + name: filtering_tags + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResource.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResource.yml new file mode 100644 index 00000000..0a795456 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResource.yml @@ -0,0 +1,64 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.LogzMonitorResource +name: LogzMonitorResource +fullName: azure.mgmt.logz.models.LogzMonitorResource +module: azure.mgmt.logz.models +summary: 'LogzMonitorResource. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'LogzMonitorResource(*, location: str, properties: _models.MonitorProperties + | None = None, identity: _models.IdentityProperties | None = None, tags: Dict[str, + str] | None = None, **kwargs)' + keywordOnlyParameters: + - name: properties + description: Properties specific to the monitor resource. + types: + - + - name: identity + types: + - + - name: tags + description: Dictionary of ``. + types: + - [, ] + - name: location + description: Required. + types: + - +variables: +- description: ARM id of the monitor resource. + name: id + types: + - +- description: The system metadata relating to this resource. + name: system_data + types: + - +- description: Name of the monitor resource. + name: name + types: + - +- description: The type of the monitor resource. + name: type + types: + - +- description: Properties specific to the monitor resource. + name: properties + types: + - +- name: identity + types: + - +- description: Dictionary of ``. + name: tags + types: + - [, ] +- description: Required. + name: location + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResourceListResponse.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResourceListResponse.yml new file mode 100644 index 00000000..75ca72f2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResourceListResponse.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.LogzMonitorResourceListResponse +name: LogzMonitorResourceListResponse +fullName: azure.mgmt.logz.models.LogzMonitorResourceListResponse +module: azure.mgmt.logz.models +summary: Response of a list operation. +constructor: + syntax: 'LogzMonitorResourceListResponse(*, value: List[_models.LogzMonitorResource] + | None = None, next_link: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: Results of a list operation. + types: + - [] + - name: next_link + description: Link to the next set of results, if any. + types: + - +variables: +- description: Results of a list operation. + name: value + types: + - [] +- description: Link to the next set of results, if any. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResourceUpdateParameters.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResourceUpdateParameters.yml new file mode 100644 index 00000000..29af3a1e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResourceUpdateParameters.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.LogzMonitorResourceUpdateParameters +name: LogzMonitorResourceUpdateParameters +fullName: azure.mgmt.logz.models.LogzMonitorResourceUpdateParameters +module: azure.mgmt.logz.models +summary: The parameters for a PATCH request to a monitor resource. +constructor: + syntax: 'LogzMonitorResourceUpdateParameters(*, properties: _models.MonitorUpdateProperties + | None = None, tags: Dict[str, str] | None = None, **kwargs)' + keywordOnlyParameters: + - name: properties + description: 'The set of properties that can be update in a PATCH request to a + monitor + + resource.' + types: + - + - name: tags + description: The new tags of the monitor resource. + types: + - [, ] +variables: +- description: 'The set of properties that can be update in a PATCH request to a monitor + + resource.' + name: properties + types: + - +- description: The new tags of the monitor resource. + name: tags + types: + - [, ] diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzOrganizationProperties.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzOrganizationProperties.yml new file mode 100644 index 00000000..fa63c0fe --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzOrganizationProperties.yml @@ -0,0 +1,42 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.LogzOrganizationProperties +name: LogzOrganizationProperties +fullName: azure.mgmt.logz.models.LogzOrganizationProperties +module: azure.mgmt.logz.models +summary: 'LogzOrganizationProperties. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'LogzOrganizationProperties(*, company_name: str | None = None, enterprise_app_id: + str | None = None, single_sign_on_url: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: company_name + description: Name of the Logz organization. + types: + - + - name: enterprise_app_id + description: The Id of the Enterprise App used for Single sign on. + types: + - + - name: single_sign_on_url + description: The login URL specific to this Logz Organization. + types: + - +variables: +- description: Name of the Logz organization. + name: company_name + types: + - +- description: Id of the Logz organization. + name: id + types: + - +- description: The Id of the Enterprise App used for Single sign on. + name: enterprise_app_id + types: + - +- description: The login URL specific to this Logz Organization. + name: single_sign_on_url + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnProperties.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnProperties.yml new file mode 100644 index 00000000..0f5f2a3c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnProperties.yml @@ -0,0 +1,55 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.LogzSingleSignOnProperties +name: LogzSingleSignOnProperties +fullName: azure.mgmt.logz.models.LogzSingleSignOnProperties +module: azure.mgmt.logz.models +summary: 'LogzSingleSignOnProperties. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'LogzSingleSignOnProperties(*, single_sign_on_state: str | _models.SingleSignOnStates + | None = None, enterprise_app_id: str | None = None, single_sign_on_url: str | + None = None, **kwargs)' + keywordOnlyParameters: + - name: single_sign_on_state + description: 'Various states of the SSO resource. Known values are: "Initial", + + "Enable", "Disable", and "Existing".' + types: + - + - + - name: enterprise_app_id + description: The Id of the Enterprise App used for Single sign-on. + types: + - + - name: single_sign_on_url + description: The login URL specific to this Logz Organization. + types: + - +variables: +- description: 'Various states of the SSO resource. Known values are: "Initial", + + "Enable", "Disable", and "Existing".' + name: single_sign_on_state + types: + - + - +- description: The Id of the Enterprise App used for Single sign-on. + name: enterprise_app_id + types: + - +- description: The login URL specific to this Logz Organization. + name: single_sign_on_url + types: + - +- description: 'Flag specifying if the resource provisioning state as tracked by ARM. + + Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", + "Failed", + + "Canceled", "Deleted", and "NotSpecified".' + name: provisioning_state + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnResource.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnResource.yml new file mode 100644 index 00000000..48c44a62 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnResource.yml @@ -0,0 +1,36 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.LogzSingleSignOnResource +name: LogzSingleSignOnResource +fullName: azure.mgmt.logz.models.LogzSingleSignOnResource +module: azure.mgmt.logz.models +summary: 'LogzSingleSignOnResource. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'LogzSingleSignOnResource(*, properties: _models.LogzSingleSignOnProperties + | None = None, **kwargs)' + keywordOnlyParameters: + - name: properties + types: + - +variables: +- description: ARM id of the resource. + name: id + types: + - +- description: Name of the configuration. + name: name + types: + - +- description: The type of the resource. + name: type + types: + - +- description: Metadata pertaining to creation and last modification of the resource. + name: system_data + types: + - +- name: properties + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnResourceListResponse.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnResourceListResponse.yml new file mode 100644 index 00000000..ddfe13c2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnResourceListResponse.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.LogzSingleSignOnResourceListResponse +name: LogzSingleSignOnResourceListResponse +fullName: azure.mgmt.logz.models.LogzSingleSignOnResourceListResponse +module: azure.mgmt.logz.models +summary: Response of a list operation. +constructor: + syntax: 'LogzSingleSignOnResourceListResponse(*, value: List[_models.LogzSingleSignOnResource] + | None = None, next_link: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: Results of a list operation. + types: + - [] + - name: next_link + description: Link to the next set of results, if any. + types: + - +variables: +- description: Results of a list operation. + name: value + types: + - [] +- description: Link to the next set of results, if any. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ManagedIdentityTypes.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ManagedIdentityTypes.yml new file mode 100644 index 00000000..6f9eaa87 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ManagedIdentityTypes.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.logz.models.ManagedIdentityTypes +name: ManagedIdentityTypes +fullName: azure.mgmt.logz.models.ManagedIdentityTypes +summary: ManagedIdentityTypes. +module: azure.mgmt.logz.models +fields: +- name: SYSTEM_ASSIGNED + uid: azure.mgmt.logz.models.ManagedIdentityTypes.SYSTEM_ASSIGNED +- name: USER_ASSIGNED + uid: azure.mgmt.logz.models.ManagedIdentityTypes.USER_ASSIGNED diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MarketplaceSubscriptionStatus.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MarketplaceSubscriptionStatus.yml new file mode 100644 index 00000000..913df924 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MarketplaceSubscriptionStatus.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.logz.models.MarketplaceSubscriptionStatus +name: MarketplaceSubscriptionStatus +fullName: azure.mgmt.logz.models.MarketplaceSubscriptionStatus +summary: 'Flag specifying the Marketplace Subscription Status of the resource. If + payment is not made in + + time, the resource will go in Suspended state.' +module: azure.mgmt.logz.models +fields: +- name: ACTIVE + uid: azure.mgmt.logz.models.MarketplaceSubscriptionStatus.ACTIVE +- name: SUSPENDED + uid: azure.mgmt.logz.models.MarketplaceSubscriptionStatus.SUSPENDED diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitorProperties.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitorProperties.yml new file mode 100644 index 00000000..dbdd5a2e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitorProperties.yml @@ -0,0 +1,90 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.MonitorProperties +name: MonitorProperties +fullName: azure.mgmt.logz.models.MonitorProperties +module: azure.mgmt.logz.models +summary: 'Properties specific to the monitor resource. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'MonitorProperties(*, monitoring_status: str | _models.MonitoringStatus + = ''Enabled'', marketplace_subscription_status: str | _models.MarketplaceSubscriptionStatus + = ''Active'', logz_organization_properties: _models.LogzOrganizationProperties + | None = None, user_info: _models.UserInfo | None = None, plan_data: _models.PlanData + | None = None, **kwargs)' + keywordOnlyParameters: + - name: monitoring_status + description: 'Flag specifying if the resource monitoring is enabled or disabled. + + Known values are: "Enabled" and "Disabled".' + defaultValue: Enabled + types: + - + - + - name: marketplace_subscription_status + description: 'Flag specifying the Marketplace Subscription Status + + of the resource. If payment is not made in time, the resource will go in Suspended + state. Known + + values are: "Active" and "Suspended".' + defaultValue: Active + types: + - + - + - name: logz_organization_properties + types: + - + - name: user_info + types: + - + - name: plan_data + types: + - +variables: +- description: 'Flag specifying if the resource provisioning state as tracked by ARM. + + Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", + "Failed", + + "Canceled", "Deleted", and "NotSpecified".' + name: provisioning_state + types: + - + - +- description: 'Flag specifying if the resource monitoring is enabled or disabled. + + Known values are: "Enabled" and "Disabled".' + name: monitoring_status + types: + - + - +- description: 'Flag specifying the Marketplace Subscription Status of + + the resource. If payment is not made in time, the resource will go in Suspended + state. Known + + values are: "Active" and "Suspended".' + name: marketplace_subscription_status + types: + - + - +- name: logz_organization_properties + types: + - +- name: user_info + types: + - +- name: plan_data + types: + - +- description: 'Known values are: "Unknown" and "MonitorLogs".' + name: liftr_resource_category + types: + - + - +- description: The priority of the resource. + name: liftr_resource_preference + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitorUpdateProperties.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitorUpdateProperties.yml new file mode 100644 index 00000000..1d9c48e4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitorUpdateProperties.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.MonitorUpdateProperties +name: MonitorUpdateProperties +fullName: azure.mgmt.logz.models.MonitorUpdateProperties +module: azure.mgmt.logz.models +summary: The set of properties that can be update in a PATCH request to a monitor + resource. +constructor: + syntax: 'MonitorUpdateProperties(*, monitoring_status: str | _models.MonitoringStatus + = ''Enabled'', **kwargs)' + keywordOnlyParameters: + - name: monitoring_status + description: 'Flag specifying if the resource monitoring is enabled or disabled. + + Known values are: "Enabled" and "Disabled".' + defaultValue: Enabled + types: + - + - +variables: +- description: 'Flag specifying if the resource monitoring is enabled or disabled. + + Known values are: "Enabled" and "Disabled".' + name: monitoring_status + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoredResource.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoredResource.yml new file mode 100644 index 00000000..eb397014 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoredResource.yml @@ -0,0 +1,68 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.MonitoredResource +name: MonitoredResource +fullName: azure.mgmt.logz.models.MonitoredResource +module: azure.mgmt.logz.models +summary: 'The properties of a resource currently being monitored by the Logz monitor + resource. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'MonitoredResource(*, id: str | None = None, sending_metrics: bool | None + = None, reason_for_metrics_status: str | None = None, sending_logs: bool | None + = None, reason_for_logs_status: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: id + description: The ARM id of the resource. + types: + - + - name: sending_metrics + description: Flag indicating if resource is sending metrics to Logz. + types: + - + - name: reason_for_metrics_status + description: 'Reason for why the resource is sending metrics (or why it + + is not sending).' + types: + - + - name: sending_logs + description: Flag indicating if resource is sending logs to Logz. + types: + - + - name: reason_for_logs_status + description: 'Reason for why the resource is sending logs (or why it is not + + sending).' + types: + - +variables: +- description: The ARM id of the resource. + name: id + types: + - +- description: Flag indicating if resource is sending metrics to Logz. + name: sending_metrics + types: + - +- description: 'Reason for why the resource is sending metrics (or why it is + + not sending).' + name: reason_for_metrics_status + types: + - +- description: Flag indicating if resource is sending logs to Logz. + name: sending_logs + types: + - +- description: Metadata pertaining to creation and last modification of the resource. + name: system_data + types: + - +- description: 'Reason for why the resource is sending logs (or why it is not + + sending).' + name: reason_for_logs_status + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoredResourceListResponse.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoredResourceListResponse.yml new file mode 100644 index 00000000..bc316279 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoredResourceListResponse.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.MonitoredResourceListResponse +name: MonitoredResourceListResponse +fullName: azure.mgmt.logz.models.MonitoredResourceListResponse +module: azure.mgmt.logz.models +summary: Response of a list operation. +constructor: + syntax: 'MonitoredResourceListResponse(*, value: List[_models.MonitoredResource] + | None = None, next_link: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: Results of a list operation. + types: + - [] + - name: next_link + description: Link to the next set of results, if any. + types: + - +variables: +- description: Results of a list operation. + name: value + types: + - [] +- description: Link to the next set of results, if any. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringStatus.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringStatus.yml new file mode 100644 index 00000000..4021366d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringStatus.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.logz.models.MonitoringStatus +name: MonitoringStatus +fullName: azure.mgmt.logz.models.MonitoringStatus +summary: Flag specifying if the resource monitoring is enabled or disabled. +module: azure.mgmt.logz.models +fields: +- name: DISABLED + uid: azure.mgmt.logz.models.MonitoringStatus.DISABLED +- name: ENABLED + uid: azure.mgmt.logz.models.MonitoringStatus.ENABLED diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRules.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRules.yml new file mode 100644 index 00000000..b321d86e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRules.yml @@ -0,0 +1,38 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.MonitoringTagRules +name: MonitoringTagRules +fullName: azure.mgmt.logz.models.MonitoringTagRules +module: azure.mgmt.logz.models +summary: 'Capture logs and metrics of Azure resources based on ARM tags. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'MonitoringTagRules(*, properties: _models.MonitoringTagRulesProperties + | None = None, **kwargs)' + keywordOnlyParameters: + - name: properties + description: Definition of the properties for a TagRules resource. + types: + - +variables: +- description: Name of the rule set. + name: name + types: + - +- description: The id of the rule set. + name: id + types: + - +- description: The type of the rule set. + name: type + types: + - +- description: The system metadata relating to this resource. + name: system_data + types: + - +- description: Definition of the properties for a TagRules resource. + name: properties + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRulesListResponse.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRulesListResponse.yml new file mode 100644 index 00000000..7c71a71b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRulesListResponse.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.MonitoringTagRulesListResponse +name: MonitoringTagRulesListResponse +fullName: azure.mgmt.logz.models.MonitoringTagRulesListResponse +module: azure.mgmt.logz.models +summary: Response of a list operation. +constructor: + syntax: 'MonitoringTagRulesListResponse(*, value: List[_models.MonitoringTagRules] + | None = None, next_link: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: Results of a list operation. + types: + - [] + - name: next_link + description: Link to the next set of results, if any. + types: + - +variables: +- description: Results of a list operation. + name: value + types: + - [] +- description: Link to the next set of results, if any. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRulesProperties.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRulesProperties.yml new file mode 100644 index 00000000..4f2f305e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRulesProperties.yml @@ -0,0 +1,36 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.MonitoringTagRulesProperties +name: MonitoringTagRulesProperties +fullName: azure.mgmt.logz.models.MonitoringTagRulesProperties +module: azure.mgmt.logz.models +summary: 'Definition of the properties for a TagRules resource. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'MonitoringTagRulesProperties(*, log_rules: _models.LogRules | None = None, + **kwargs)' + keywordOnlyParameters: + - name: log_rules + description: Set of rules for sending logs for the Monitor resource. + types: + - +variables: +- description: 'Flag specifying if the resource provisioning state as tracked by ARM. + + Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", + "Failed", + + "Canceled", "Deleted", and "NotSpecified".' + name: provisioning_state + types: + - + - +- description: Set of rules for sending logs for the Monitor resource. + name: log_rules + types: + - +- description: Metadata pertaining to creation and last modification of the resource. + name: system_data + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationDisplay.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationDisplay.yml new file mode 100644 index 00000000..7ca11392 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationDisplay.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.OperationDisplay +name: OperationDisplay +fullName: azure.mgmt.logz.models.OperationDisplay +module: azure.mgmt.logz.models +summary: The object that represents the operation. +constructor: + syntax: 'OperationDisplay(*, provider: str | None = None, resource: str | None = + None, operation: str | None = None, description: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: provider + description: Service provider, i.e., Microsoft.Logz. + types: + - + - name: resource + description: Type on which the operation is performed, e.g., 'monitors'. + types: + - + - name: operation + description: Operation type, e.g., read, write, delete, etc. + types: + - + - name: description + description: Description of the operation, e.g., 'Write monitors'. + types: + - +variables: +- description: Service provider, i.e., Microsoft.Logz. + name: provider + types: + - +- description: Type on which the operation is performed, e.g., 'monitors'. + name: resource + types: + - +- description: Operation type, e.g., read, write, delete, etc. + name: operation + types: + - +- description: Description of the operation, e.g., 'Write monitors'. + name: description + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationListResult.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationListResult.yml new file mode 100644 index 00000000..cef0d6aa --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationListResult.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.OperationListResult +name: OperationListResult +fullName: azure.mgmt.logz.models.OperationListResult +module: azure.mgmt.logz.models +summary: Result of GET request to list the Microsoft.Logz operations. +constructor: + syntax: 'OperationListResult(*, value: List[_models.OperationResult] | None = None, + next_link: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: List of operations supported by the Microsoft.Logz provider. + types: + - [] + - name: next_link + description: URL to get the next set of operation list results if there are any. + types: + - +variables: +- description: List of operations supported by the Microsoft.Logz provider. + name: value + types: + - [] +- description: URL to get the next set of operation list results if there are any. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationResult.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationResult.yml new file mode 100644 index 00000000..079aa272 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationResult.yml @@ -0,0 +1,44 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.OperationResult +name: OperationResult +fullName: azure.mgmt.logz.models.OperationResult +module: azure.mgmt.logz.models +summary: A Microsoft.Logz REST API operation. +constructor: + syntax: 'OperationResult(*, name: str | None = None, is_data_action: bool | None + = None, display: _models.OperationDisplay | None = None, origin: str | None = + None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Operation name, i.e., {provider}/{resource}/{operation}. + types: + - + - name: is_data_action + description: Indicates whether the operation is a data action. + types: + - + - name: display + description: The object that represents the operation. + types: + - + - name: origin + description: Origin of the operation. + types: + - +variables: +- description: Operation name, i.e., {provider}/{resource}/{operation}. + name: name + types: + - +- description: Indicates whether the operation is a data action. + name: is_data_action + types: + - +- description: The object that represents the operation. + name: display + types: + - +- description: Origin of the operation. + name: origin + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.PlanData.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.PlanData.yml new file mode 100644 index 00000000..ea5aa89e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.PlanData.yml @@ -0,0 +1,44 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.PlanData +name: PlanData +fullName: azure.mgmt.logz.models.PlanData +module: azure.mgmt.logz.models +summary: PlanData. +constructor: + syntax: 'PlanData(*, usage_type: str | None = None, billing_cycle: str | None = + None, plan_details: str | None = None, effective_date: datetime | None = None, + **kwargs)' + keywordOnlyParameters: + - name: usage_type + description: different usage type like PAYG/COMMITTED. this could be enum. + types: + - + - name: billing_cycle + description: different billing cycles like MONTHLY/WEEKLY. this could be enum. + types: + - + - name: plan_details + description: plan id as published by Logz. + types: + - + - name: effective_date + description: date when plan was applied. + types: + - +variables: +- description: different usage type like PAYG/COMMITTED. this could be enum. + name: usage_type + types: + - +- description: different billing cycles like MONTHLY/WEEKLY. this could be enum. + name: billing_cycle + types: + - +- description: plan id as published by Logz. + name: plan_details + types: + - +- description: date when plan was applied. + name: effective_date + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ProvisioningState.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ProvisioningState.yml new file mode 100644 index 00000000..29ef4f14 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ProvisioningState.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.logz.models.ProvisioningState +name: ProvisioningState +fullName: azure.mgmt.logz.models.ProvisioningState +summary: Flag specifying if the resource provisioning state as tracked by ARM. +module: azure.mgmt.logz.models +fields: +- name: ACCEPTED + uid: azure.mgmt.logz.models.ProvisioningState.ACCEPTED +- name: CANCELED + uid: azure.mgmt.logz.models.ProvisioningState.CANCELED +- name: CREATING + uid: azure.mgmt.logz.models.ProvisioningState.CREATING +- name: DELETED + uid: azure.mgmt.logz.models.ProvisioningState.DELETED +- name: DELETING + uid: azure.mgmt.logz.models.ProvisioningState.DELETING +- name: FAILED + uid: azure.mgmt.logz.models.ProvisioningState.FAILED +- name: NOT_SPECIFIED + uid: azure.mgmt.logz.models.ProvisioningState.NOT_SPECIFIED +- name: SUCCEEDED + uid: azure.mgmt.logz.models.ProvisioningState.SUCCEEDED +- name: UPDATING + uid: azure.mgmt.logz.models.ProvisioningState.UPDATING diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.SingleSignOnStates.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.SingleSignOnStates.yml new file mode 100644 index 00000000..4d53708a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.SingleSignOnStates.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.logz.models.SingleSignOnStates +name: SingleSignOnStates +fullName: azure.mgmt.logz.models.SingleSignOnStates +summary: Various states of the SSO resource. +module: azure.mgmt.logz.models +fields: +- name: DISABLE + uid: azure.mgmt.logz.models.SingleSignOnStates.DISABLE +- name: ENABLE + uid: azure.mgmt.logz.models.SingleSignOnStates.ENABLE +- name: EXISTING + uid: azure.mgmt.logz.models.SingleSignOnStates.EXISTING +- name: INITIAL + uid: azure.mgmt.logz.models.SingleSignOnStates.INITIAL diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.SystemData.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.SystemData.yml new file mode 100644 index 00000000..5443e3d5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.SystemData.yml @@ -0,0 +1,73 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.SystemData +name: SystemData +fullName: azure.mgmt.logz.models.SystemData +module: azure.mgmt.logz.models +summary: Metadata pertaining to creation and last modification of the resource. +constructor: + syntax: 'SystemData(*, created_by: str | None = None, created_by_type: str | _models.CreatedByType + | None = None, created_at: datetime | None = None, last_modified_by: str | None + = None, last_modified_by_type: str | _models.CreatedByType | None = None, last_modified_at: + datetime | None = None, **kwargs)' + keywordOnlyParameters: + - name: created_by + description: The identity that created the resource. + types: + - + - name: created_by_type + description: 'The type of identity that created the resource. Known values are: + + "User", "Application", "ManagedIdentity", and "Key".' + types: + - + - + - name: created_at + description: The timestamp of resource creation (UTC). + types: + - + - name: last_modified_by + description: The identity that last modified the resource. + types: + - + - name: last_modified_by_type + description: 'The type of identity that last modified the resource. Known + + values are: "User", "Application", "ManagedIdentity", and "Key".' + types: + - + - + - name: last_modified_at + description: The timestamp of resource last modification (UTC). + types: + - +variables: +- description: The identity that created the resource. + name: created_by + types: + - +- description: 'The type of identity that created the resource. Known values are: + + "User", "Application", "ManagedIdentity", and "Key".' + name: created_by_type + types: + - + - +- description: The timestamp of resource creation (UTC). + name: created_at + types: + - +- description: The identity that last modified the resource. + name: last_modified_by + types: + - +- description: 'The type of identity that last modified the resource. Known values + + are: "User", "Application", "ManagedIdentity", and "Key".' + name: last_modified_by_type + types: + - + - +- description: The timestamp of resource last modification (UTC). + name: last_modified_at + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.TagAction.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.TagAction.yml new file mode 100644 index 00000000..d4c033f1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.TagAction.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.logz.models.TagAction +name: TagAction +fullName: azure.mgmt.logz.models.TagAction +summary: Valid actions for a filtering tag. Exclusion takes priority over inclusion. +module: azure.mgmt.logz.models +fields: +- name: EXCLUDE + uid: azure.mgmt.logz.models.TagAction.EXCLUDE +- name: INCLUDE + uid: azure.mgmt.logz.models.TagAction.INCLUDE diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserInfo.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserInfo.yml new file mode 100644 index 00000000..1e248a40 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserInfo.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.UserInfo +name: UserInfo +fullName: azure.mgmt.logz.models.UserInfo +module: azure.mgmt.logz.models +summary: UserInfo. +constructor: + syntax: 'UserInfo(*, first_name: str | None = None, last_name: str | None = None, + email_address: str | None = None, phone_number: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: first_name + description: First Name of the user. + types: + - + - name: last_name + description: Last Name of the user. + types: + - + - name: email_address + description: Email of the user used by Logz for contacting them if needed. + types: + - + - name: phone_number + description: Phone number of the user used by Logz for contacting them if needed. + types: + - +variables: +- description: First Name of the user. + name: first_name + types: + - +- description: Last Name of the user. + name: last_name + types: + - +- description: Email of the user used by Logz for contacting them if needed. + name: email_address + types: + - +- description: Phone number of the user used by Logz for contacting them if needed. + name: phone_number + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRole.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRole.yml new file mode 100644 index 00000000..6b8b44da --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRole.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.logz.models.UserRole +name: UserRole +fullName: azure.mgmt.logz.models.UserRole +summary: User roles on configured in Logz.io account. +module: azure.mgmt.logz.models +fields: +- name: ADMIN + uid: azure.mgmt.logz.models.UserRole.ADMIN +- name: NONE + uid: azure.mgmt.logz.models.UserRole.NONE +- name: USER + uid: azure.mgmt.logz.models.UserRole.USER diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleListResponse.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleListResponse.yml new file mode 100644 index 00000000..b011fec9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleListResponse.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.UserRoleListResponse +name: UserRoleListResponse +fullName: azure.mgmt.logz.models.UserRoleListResponse +module: azure.mgmt.logz.models +summary: Response for list of user's role for Logz.io account. +constructor: + syntax: 'UserRoleListResponse(*, value: List[_models.UserRoleResponse] | None = + None, next_link: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: List of user roles for Logz.io account. + types: + - [] + - name: next_link + description: Link to the next set of results, if any. + types: + - +variables: +- description: List of user roles for Logz.io account. + name: value + types: + - [] +- description: Link to the next set of results, if any. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleRequest.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleRequest.yml new file mode 100644 index 00000000..7332571e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleRequest.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.UserRoleRequest +name: UserRoleRequest +fullName: azure.mgmt.logz.models.UserRoleRequest +module: azure.mgmt.logz.models +summary: Request for checking user's role for Logz.io account. +constructor: + syntax: 'UserRoleRequest(*, email_address: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: email_address + description: Email of the user used by Logz for contacting them if needed. + types: + - +variables: +- description: Email of the user used by Logz for contacting them if needed. + name: email_address + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleResponse.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleResponse.yml new file mode 100644 index 00000000..6bc3e347 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleResponse.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.UserRoleResponse +name: UserRoleResponse +fullName: azure.mgmt.logz.models.UserRoleResponse +module: azure.mgmt.logz.models +summary: Response for checking user's role for Logz.io account. +constructor: + syntax: 'UserRoleResponse(*, role: str | _models.UserRole | None = None, **kwargs)' + keywordOnlyParameters: + - name: role + description: 'User roles on configured in Logz.io account. Known values are: "None", + "User", + + and "Admin".' + types: + - + - +variables: +- description: 'User roles on configured in Logz.io account. Known values are: "None", + "User", and + + "Admin".' + name: role + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMExtensionPayload.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMExtensionPayload.yml new file mode 100644 index 00000000..ca1c4e20 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMExtensionPayload.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.VMExtensionPayload +name: VMExtensionPayload +fullName: azure.mgmt.logz.models.VMExtensionPayload +module: azure.mgmt.logz.models +summary: Response of payload to be passed while installing VM agent. +constructor: + syntax: 'VMExtensionPayload(*, api_key: str | None = None, region: str | None = + None, **kwargs)' + keywordOnlyParameters: + - name: api_key + description: API Key corresponding to the resource. + types: + - + - name: region + description: Logz.io region where the resource has been created. + types: + - +variables: +- description: API Key corresponding to the resource. + name: api_key + types: + - +- description: Logz.io region where the resource has been created. + name: region + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMHostUpdateRequest.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMHostUpdateRequest.yml new file mode 100644 index 00000000..96fad21f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMHostUpdateRequest.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.VMHostUpdateRequest +name: VMHostUpdateRequest +fullName: azure.mgmt.logz.models.VMHostUpdateRequest +module: azure.mgmt.logz.models +summary: Request of a list VM Host Update Operation. +constructor: + syntax: 'VMHostUpdateRequest(*, vm_resource_ids: List[_models.VMResources] | None + = None, state: str | _models.VMHostUpdateStates | None = None, **kwargs)' + keywordOnlyParameters: + - name: vm_resource_ids + description: Request of a list vm host update operation. + types: + - [] + - name: state + description: 'Specifies the state of the operation - install/ delete. Known values + are: + + "Install" and "Delete".' + types: + - + - +variables: +- description: Request of a list vm host update operation. + name: vm_resource_ids + types: + - [] +- description: 'Specifies the state of the operation - install/ delete. Known values + are: + + "Install" and "Delete".' + name: state + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMHostUpdateStates.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMHostUpdateStates.yml new file mode 100644 index 00000000..6701f9a3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMHostUpdateStates.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.logz.models.VMHostUpdateStates +name: VMHostUpdateStates +fullName: azure.mgmt.logz.models.VMHostUpdateStates +summary: Various states of the updating vm extension on resource. +module: azure.mgmt.logz.models +fields: +- name: DELETE + uid: azure.mgmt.logz.models.VMHostUpdateStates.DELETE +- name: INSTALL + uid: azure.mgmt.logz.models.VMHostUpdateStates.INSTALL diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMResources.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMResources.yml new file mode 100644 index 00000000..2b64c511 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMResources.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.VMResources +name: VMResources +fullName: azure.mgmt.logz.models.VMResources +module: azure.mgmt.logz.models +summary: VM Resource Ids. +constructor: + syntax: 'VMResources(*, id: str | None = None, agent_version: str | None = None, + **kwargs)' + keywordOnlyParameters: + - name: id + description: Request of a list vm host update operation. + types: + - + - name: agent_version + description: Version of the Logz agent installed on the VM. + types: + - +variables: +- description: Request of a list vm host update operation. + name: id + types: + - +- description: Version of the Logz agent installed on the VM. + name: agent_version + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMResourcesListResponse.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMResourcesListResponse.yml new file mode 100644 index 00000000..f6f1b198 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMResourcesListResponse.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.models.VMResourcesListResponse +name: VMResourcesListResponse +fullName: azure.mgmt.logz.models.VMResourcesListResponse +module: azure.mgmt.logz.models +summary: Response of a list VM Host Update Operation. +constructor: + syntax: 'VMResourcesListResponse(*, value: List[_models.VMResources] | None = None, + next_link: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: Response of a list vm host update operation. + types: + - [] + - name: next_link + description: Link to the next set of results, if any. + types: + - +variables: +- description: Response of a list vm host update operation. + name: value + types: + - [] +- description: Link to the next set of results, if any. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.yml new file mode 100644 index 00000000..aadd5c6c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.yml @@ -0,0 +1,50 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.logz.models +name: models +fullName: azure.mgmt.logz.models +type: import +classes: +- azure.mgmt.logz.models.ErrorAdditionalInfo +- azure.mgmt.logz.models.ErrorDetail +- azure.mgmt.logz.models.ErrorResponse +- azure.mgmt.logz.models.FilteringTag +- azure.mgmt.logz.models.IdentityProperties +- azure.mgmt.logz.models.LogRules +- azure.mgmt.logz.models.LogzMonitorResource +- azure.mgmt.logz.models.LogzMonitorResourceListResponse +- azure.mgmt.logz.models.LogzMonitorResourceUpdateParameters +- azure.mgmt.logz.models.LogzOrganizationProperties +- azure.mgmt.logz.models.LogzSingleSignOnProperties +- azure.mgmt.logz.models.LogzSingleSignOnResource +- azure.mgmt.logz.models.LogzSingleSignOnResourceListResponse +- azure.mgmt.logz.models.MonitorProperties +- azure.mgmt.logz.models.MonitorUpdateProperties +- azure.mgmt.logz.models.MonitoredResource +- azure.mgmt.logz.models.MonitoredResourceListResponse +- azure.mgmt.logz.models.MonitoringTagRules +- azure.mgmt.logz.models.MonitoringTagRulesListResponse +- azure.mgmt.logz.models.MonitoringTagRulesProperties +- azure.mgmt.logz.models.OperationDisplay +- azure.mgmt.logz.models.OperationListResult +- azure.mgmt.logz.models.OperationResult +- azure.mgmt.logz.models.PlanData +- azure.mgmt.logz.models.SystemData +- azure.mgmt.logz.models.UserInfo +- azure.mgmt.logz.models.UserRoleListResponse +- azure.mgmt.logz.models.UserRoleRequest +- azure.mgmt.logz.models.UserRoleResponse +- azure.mgmt.logz.models.VMExtensionPayload +- azure.mgmt.logz.models.VMHostUpdateRequest +- azure.mgmt.logz.models.VMResources +- azure.mgmt.logz.models.VMResourcesListResponse +enums: +- azure.mgmt.logz.models.CreatedByType +- azure.mgmt.logz.models.LiftrResourceCategories +- azure.mgmt.logz.models.ManagedIdentityTypes +- azure.mgmt.logz.models.MarketplaceSubscriptionStatus +- azure.mgmt.logz.models.MonitoringStatus +- azure.mgmt.logz.models.ProvisioningState +- azure.mgmt.logz.models.SingleSignOnStates +- azure.mgmt.logz.models.TagAction +- azure.mgmt.logz.models.UserRole +- azure.mgmt.logz.models.VMHostUpdateStates diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.MonitorOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.MonitorOperations.yml new file mode 100644 index 00000000..be0a243e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.MonitorOperations.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.operations.MonitorOperations +name: MonitorOperations +fullName: azure.mgmt.logz.operations.MonitorOperations +module: azure.mgmt.logz.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: MonitorOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.logz.operations.MonitorOperations.list_vm_host_update + name: list_vm_host_update + summary: 'Sending request to update the collection when Logz.io agent has been installed + on a VM for a + + given monitor. + + + Sending request to update the collection when Logz.io agent has been installed + on a VM for a + + given monitor.' + signature: 'list_vm_host_update(resource_group_name: str, monitor_name: str, body: + _models.VMHostUpdateRequest | None = None, *, content_type: str = ''application/json'', + **kwargs: Any) -> Iterable[''_models.VMResources'']' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: body + description: 'Request body to update the collection for agent installed in the + given monitor. Is + + either a model type or a IO type. Default value is None.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either VMResources or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.MonitorOperations.list_vm_hosts + name: list_vm_hosts + summary: 'List the compute resources currently being monitored by the Logz main + account resource. + + + List the compute resources currently being monitored by the Logz main account + resource.' + signature: 'list_vm_hosts(resource_group_name: str, monitor_name: str, **kwargs: + Any) -> Iterable[VMResources]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either VMResources or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.MonitorOperations.vm_host_payload + name: vm_host_payload + summary: 'Returns the payload that needs to be passed in the request body for installing + Logz.io agent on + + a VM. + + + Returns the payload that needs to be passed in the request body for installing + Logz.io agent on + + a VM.' + signature: 'vm_host_payload(resource_group_name: str, monitor_name: str, **kwargs: + Any) -> VMExtensionPayload' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VMExtensionPayload or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.logz.operations.MonitorOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.MonitorsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.MonitorsOperations.yml new file mode 100644 index 00000000..2c67b89b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.MonitorsOperations.yml @@ -0,0 +1,347 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.operations.MonitorsOperations +name: MonitorsOperations +fullName: azure.mgmt.logz.operations.MonitorsOperations +module: azure.mgmt.logz.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: MonitorsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.logz.operations.MonitorsOperations.begin_create + name: begin_create + summary: 'Create a monitor resource. This create operation can take upto 10 minutes + to complete. + + + Create a monitor resource. This create operation can take upto 10 minutes to complete.' + signature: 'begin_create(resource_group_name: str, monitor_name: str, body: _models.LogzMonitorResource + | None = None, *, content_type: str = ''application/json'', **kwargs: Any) -> + LROPoller[_models.LogzMonitorResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: body + description: Is either a model type or a IO type. Default value is None. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of LROPoller that returns either LogzMonitorResource + or the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.MonitorsOperations.begin_delete + name: begin_delete + summary: 'Delete a monitor resource. This delete operation can take upto 10 minutes + to complete. + + + Delete a monitor resource. This delete operation can take upto 10 minutes to complete.' + signature: 'begin_delete(resource_group_name: str, monitor_name: str, **kwargs: + Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.MonitorsOperations.get + name: get + summary: 'Get the properties of a specific monitor resource. + + + Get the properties of a specific monitor resource.' + signature: 'get(resource_group_name: str, monitor_name: str, **kwargs: Any) -> LogzMonitorResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LogzMonitorResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.MonitorsOperations.list_by_resource_group + name: list_by_resource_group + summary: 'List all monitors under the specified resource group. + + + List all monitors under the specified resource group.' + signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[LogzMonitorResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either LogzMonitorResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.MonitorsOperations.list_by_subscription + name: list_by_subscription + summary: 'List all monitors under the specified subscription. + + + List all monitors under the specified subscription.' + signature: 'list_by_subscription(**kwargs: Any) -> Iterable[LogzMonitorResource]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either LogzMonitorResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.MonitorsOperations.list_monitored_resources + name: list_monitored_resources + summary: 'List the resources currently being monitored by the Logz monitor resource. + + + List the resources currently being monitored by the Logz monitor resource.' + signature: 'list_monitored_resources(resource_group_name: str, monitor_name: str, + **kwargs: Any) -> Iterable[MonitoredResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either MonitoredResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.MonitorsOperations.list_user_roles + name: list_user_roles + summary: 'List the user''s roles configured on Logz.io side for the account corresponding + to the monitor + + resource. + + + List the user''s roles configured on Logz.io side for the account corresponding + to the monitor + + resource.' + signature: 'list_user_roles(resource_group_name: str, monitor_name: str, body: _models.UserRoleRequest + | None = None, *, content_type: str = ''application/json'', **kwargs: Any) -> + Iterable[''_models.UserRoleResponse'']' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: body + description: Is either a model type or a IO type. Default value is None. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either UserRoleResponse or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.MonitorsOperations.update + name: update + summary: 'Update a monitor resource. + + + Update a monitor resource.' + signature: 'update(resource_group_name: str, monitor_name: str, body: _models.LogzMonitorResourceUpdateParameters + | None = None, *, content_type: str = ''application/json'', **kwargs: Any) -> + _models.LogzMonitorResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: body + description: Is either a model type or a IO type. Default value is None. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LogzMonitorResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.logz.operations.MonitorsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.Operations.yml new file mode 100644 index 00000000..80bcb6b2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.Operations.yml @@ -0,0 +1,34 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.operations.Operations +name: Operations +fullName: azure.mgmt.logz.operations.Operations +module: azure.mgmt.logz.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: Operations(*args, **kwargs) +methods: +- uid: azure.mgmt.logz.operations.Operations.list + name: list + summary: 'List all operations provided by Microsoft.Logz. + + + List all operations provided by Microsoft.Logz.' + signature: 'list(**kwargs: Any) -> Iterable[OperationResult]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either OperationResult or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.logz.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SingleSignOnOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SingleSignOnOperations.yml new file mode 100644 index 00000000..2ade4ef4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SingleSignOnOperations.yml @@ -0,0 +1,167 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.operations.SingleSignOnOperations +name: SingleSignOnOperations +fullName: azure.mgmt.logz.operations.SingleSignOnOperations +module: azure.mgmt.logz.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: SingleSignOnOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.logz.operations.SingleSignOnOperations.begin_create_or_update + name: begin_create_or_update + summary: 'Configures single-sign-on for this resource. This operation can take upto + 10 minutes to + + complete. + + + Configures single-sign-on for this resource. This operation can take upto 10 minutes + to + + complete.' + signature: 'begin_create_or_update(resource_group_name: str, monitor_name: str, + configuration_name: str, body: _models.LogzSingleSignOnResource | None = None, + *, content_type: str = ''application/json'', **kwargs: Any) -> LROPoller[_models.LogzSingleSignOnResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: configuration_name + description: Required. + isRequired: true + types: + - + - name: body + description: Is either a model type or a IO type. Default value is None. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of LROPoller that returns either LogzSingleSignOnResource + or the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.SingleSignOnOperations.get + name: get + summary: 'Gets the Logz single sign-on resource for the given Monitor. + + + Gets the Logz single sign-on resource for the given Monitor.' + signature: 'get(resource_group_name: str, monitor_name: str, configuration_name: + str, **kwargs: Any) -> LogzSingleSignOnResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: configuration_name + description: Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LogzSingleSignOnResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.SingleSignOnOperations.list + name: list + summary: 'List the single sign-on configurations for a given monitor resource. + + + List the single sign-on configurations for a given monitor resource.' + signature: 'list(resource_group_name: str, monitor_name: str, **kwargs: Any) -> + Iterable[LogzSingleSignOnResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either LogzSingleSignOnResource or + the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.logz.operations.SingleSignOnOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SubAccountOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SubAccountOperations.yml new file mode 100644 index 00000000..a67515cc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SubAccountOperations.yml @@ -0,0 +1,452 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.operations.SubAccountOperations +name: SubAccountOperations +fullName: azure.mgmt.logz.operations.SubAccountOperations +module: azure.mgmt.logz.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: SubAccountOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.logz.operations.SubAccountOperations.begin_create + name: begin_create + summary: 'Create sub account under a given monitor resource. This create operation + can take upto 10 + + minutes to complete. + + + Create sub account under a given monitor resource. This create operation can take + upto 10 + + minutes to complete.' + signature: 'begin_create(resource_group_name: str, monitor_name: str, sub_account_name: + str, body: _models.LogzMonitorResource | None = None, *, content_type: str = ''application/json'', + **kwargs: Any) -> LROPoller[_models.LogzMonitorResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + - name: body + description: Is either a model type or a IO type. Default value is None. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of LROPoller that returns either LogzMonitorResource + or the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.SubAccountOperations.begin_delete + name: begin_delete + summary: 'Delete a sub account resource. This delete operation can take upto 10 + minutes to complete. + + + Delete a sub account resource. This delete operation can take upto 10 minutes + to complete.' + signature: 'begin_delete(resource_group_name: str, monitor_name: str, sub_account_name: + str, **kwargs: Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.SubAccountOperations.get + name: get + summary: 'Get a sub account under a given monitor resource. + + + Get a sub account under a given monitor resource.' + signature: 'get(resource_group_name: str, monitor_name: str, sub_account_name: str, + **kwargs: Any) -> LogzMonitorResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LogzMonitorResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.SubAccountOperations.list + name: list + summary: 'List the sub account under a given monitor resource. + + + List the sub account under a given monitor resource.' + signature: 'list(resource_group_name: str, monitor_name: str, **kwargs: Any) -> + Iterable[LogzMonitorResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either LogzMonitorResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.SubAccountOperations.list_monitored_resources + name: list_monitored_resources + summary: 'List the resources currently being monitored by the Logz sub account resource. + + + List the resources currently being monitored by the Logz sub account resource.' + signature: 'list_monitored_resources(resource_group_name: str, monitor_name: str, + sub_account_name: str, **kwargs: Any) -> Iterable[MonitoredResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either MonitoredResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.SubAccountOperations.list_vm_host_update + name: list_vm_host_update + summary: 'Sending request to update the collection when Logz.io agent has been installed + on a VM for a + + given monitor. + + + Sending request to update the collection when Logz.io agent has been installed + on a VM for a + + given monitor.' + signature: 'list_vm_host_update(resource_group_name: str, monitor_name: str, sub_account_name: + str, body: _models.VMHostUpdateRequest | None = None, *, content_type: str = ''application/json'', + **kwargs: Any) -> Iterable[''_models.VMResources'']' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + - name: body + description: 'Request body to update the collection for agent installed in the + given monitor. Is + + either a model type or a IO type. Default value is None.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either VMResources or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.SubAccountOperations.list_vm_hosts + name: list_vm_hosts + summary: 'List the compute resources currently being monitored by the Logz sub account + resource. + + + List the compute resources currently being monitored by the Logz sub account resource.' + signature: 'list_vm_hosts(resource_group_name: str, monitor_name: str, sub_account_name: + str, **kwargs: Any) -> Iterable[VMResources]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either VMResources or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.SubAccountOperations.update + name: update + summary: 'Update a monitor resource. + + + Update a monitor resource.' + signature: 'update(resource_group_name: str, monitor_name: str, sub_account_name: + str, body: _models.LogzMonitorResourceUpdateParameters | None = None, *, content_type: + str = ''application/json'', **kwargs: Any) -> _models.LogzMonitorResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + - name: body + description: Is either a model type or a IO type. Default value is None. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LogzMonitorResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.SubAccountOperations.vm_host_payload + name: vm_host_payload + summary: 'Returns the payload that needs to be passed as a request for installing + Logz.io agent on a VM. + + + Returns the payload that needs to be passed as a request for installing Logz.io + agent on a VM.' + signature: 'vm_host_payload(resource_group_name: str, monitor_name: str, sub_account_name: + str, **kwargs: Any) -> VMExtensionPayload' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VMExtensionPayload or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.logz.operations.SubAccountOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SubAccountTagRulesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SubAccountTagRulesOperations.yml new file mode 100644 index 00000000..f61311b2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SubAccountTagRulesOperations.yml @@ -0,0 +1,192 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.operations.SubAccountTagRulesOperations +name: SubAccountTagRulesOperations +fullName: azure.mgmt.logz.operations.SubAccountTagRulesOperations +module: azure.mgmt.logz.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: SubAccountTagRulesOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.logz.operations.SubAccountTagRulesOperations.create_or_update + name: create_or_update + summary: 'Create or update a tag rule set for a given sub account resource. + + + Create or update a tag rule set for a given sub account resource.' + signature: 'create_or_update(resource_group_name: str, monitor_name: str, sub_account_name: + str, rule_set_name: str, body: _models.MonitoringTagRules | None = None, *, content_type: + str = ''application/json'', **kwargs: Any) -> _models.MonitoringTagRules' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + - name: rule_set_name + description: Required. + isRequired: true + types: + - + - name: body + description: Is either a model type or a IO type. Default value is None. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: MonitoringTagRules or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.SubAccountTagRulesOperations.delete + name: delete + summary: 'Delete a tag rule set for a given monitor resource. + + + Delete a tag rule set for a given monitor resource.' + signature: 'delete(resource_group_name: str, monitor_name: str, sub_account_name: + str, rule_set_name: str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + - name: rule_set_name + description: Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.SubAccountTagRulesOperations.get + name: get + summary: 'Get a tag rule set for a given monitor resource. + + + Get a tag rule set for a given monitor resource.' + signature: 'get(resource_group_name: str, monitor_name: str, sub_account_name: str, + rule_set_name: str, **kwargs: Any) -> MonitoringTagRules' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + - name: rule_set_name + description: Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: MonitoringTagRules or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.SubAccountTagRulesOperations.list + name: list + summary: 'List the tag rules for a given sub account resource. + + + List the tag rules for a given sub account resource.' + signature: 'list(resource_group_name: str, monitor_name: str, sub_account_name: + str, **kwargs: Any) -> Iterable[MonitoringTagRules]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: sub_account_name + description: Sub Account resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either MonitoringTagRules or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.logz.operations.SubAccountTagRulesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.TagRulesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.TagRulesOperations.yml new file mode 100644 index 00000000..7607c138 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.TagRulesOperations.yml @@ -0,0 +1,172 @@ +### YamlMime:PythonClass +uid: azure.mgmt.logz.operations.TagRulesOperations +name: TagRulesOperations +fullName: azure.mgmt.logz.operations.TagRulesOperations +module: azure.mgmt.logz.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: TagRulesOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.logz.operations.TagRulesOperations.create_or_update + name: create_or_update + summary: 'Create or update a tag rule set for a given monitor resource. + + + Create or update a tag rule set for a given monitor resource.' + signature: 'create_or_update(resource_group_name: str, monitor_name: str, rule_set_name: + str, body: _models.MonitoringTagRules | None = None, *, content_type: str = ''application/json'', + **kwargs: Any) -> _models.MonitoringTagRules' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: rule_set_name + description: Required. + isRequired: true + types: + - + - name: body + description: Is either a model type or a IO type. Default value is None. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: MonitoringTagRules or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.TagRulesOperations.delete + name: delete + summary: 'Delete a tag rule set for a given monitor resource. + + + Delete a tag rule set for a given monitor resource.' + signature: 'delete(resource_group_name: str, monitor_name: str, rule_set_name: str, + **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: rule_set_name + description: Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.TagRulesOperations.get + name: get + summary: 'Get a tag rule set for a given monitor resource. + + + Get a tag rule set for a given monitor resource.' + signature: 'get(resource_group_name: str, monitor_name: str, rule_set_name: str, + **kwargs: Any) -> MonitoringTagRules' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + - name: rule_set_name + description: Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: MonitoringTagRules or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.logz.operations.TagRulesOperations.list + name: list + summary: 'List the tag rules for a given monitor resource. + + + List the tag rules for a given monitor resource.' + signature: 'list(resource_group_name: str, monitor_name: str, **kwargs: Any) -> + Iterable[MonitoringTagRules]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: monitor_name + description: Monitor resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either MonitoringTagRules or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.logz.operations.TagRulesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.yml new file mode 100644 index 00000000..0a338e1c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.logz.operations +name: operations +fullName: azure.mgmt.logz.operations +type: import +classes: +- azure.mgmt.logz.operations.MonitorOperations +- azure.mgmt.logz.operations.MonitorsOperations +- azure.mgmt.logz.operations.Operations +- azure.mgmt.logz.operations.SingleSignOnOperations +- azure.mgmt.logz.operations.SubAccountOperations +- azure.mgmt.logz.operations.SubAccountTagRulesOperations +- azure.mgmt.logz.operations.TagRulesOperations diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.yml new file mode 100644 index 00000000..24aa7a14 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.logz +name: logz +fullName: azure.mgmt.logz +type: rootImport +classes: +- azure.mgmt.logz.MicrosoftLogz +packages: +- azure.mgmt.logz.aio +- azure.mgmt.logz.models +- azure.mgmt.logz.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.NetworkAnalyticsMgmtClient.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.NetworkAnalyticsMgmtClient.yml new file mode 100644 index 00000000..06c3c3a5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.NetworkAnalyticsMgmtClient.yml @@ -0,0 +1,60 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.NetworkAnalyticsMgmtClient +name: NetworkAnalyticsMgmtClient +fullName: azure.mgmt.networkanalytics.NetworkAnalyticsMgmtClient +module: azure.mgmt.networkanalytics +summary: NetworkAnalyticsMgmtClient. +constructor: + syntax: 'NetworkAnalyticsMgmtClient(credential: TokenCredential, subscription_id: + str, base_url: str = ''https://management.azure.com'', **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. Required. + isRequired: true + types: + - + - name: subscription_id + description: The ID of the target subscription. Required. + isRequired: true + types: + - + - name: base_url + description: Service URL. Default value is "`https://management.azure.com`". + defaultValue: https://management.azure.com + types: + - + keywordOnlyParameters: + - name: api_version + description: 'Api Version. Default value is "2023-11-15". Note that overriding + this + + default value may result in unsupported behavior.' + types: + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - +variables: +- description: Operations operations + name: operations + types: + - +- description: DataProductsOperations operations + name: data_products + types: + - +- description: DataProductsCatalogsOperations operations + name: data_products_catalogs + types: + - +- description: DataTypesOperations operations + name: data_types + types: + - +methods: +- uid: azure.mgmt.networkanalytics.NetworkAnalyticsMgmtClient.close + name: close + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.NetworkAnalyticsMgmtClient.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.NetworkAnalyticsMgmtClient.yml new file mode 100644 index 00000000..a636ae1d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.NetworkAnalyticsMgmtClient.yml @@ -0,0 +1,60 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.aio.NetworkAnalyticsMgmtClient +name: NetworkAnalyticsMgmtClient +fullName: azure.mgmt.networkanalytics.aio.NetworkAnalyticsMgmtClient +module: azure.mgmt.networkanalytics.aio +summary: NetworkAnalyticsMgmtClient. +constructor: + syntax: 'NetworkAnalyticsMgmtClient(credential: AsyncTokenCredential, subscription_id: + str, base_url: str = ''https://management.azure.com'', **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. Required. + isRequired: true + types: + - + - name: subscription_id + description: The ID of the target subscription. Required. + isRequired: true + types: + - + - name: base_url + description: Service URL. Default value is "`https://management.azure.com`". + defaultValue: https://management.azure.com + types: + - + keywordOnlyParameters: + - name: api_version + description: 'Api Version. Default value is "2023-11-15". Note that overriding + this + + default value may result in unsupported behavior.' + types: + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - +variables: +- description: Operations operations + name: operations + types: + - +- description: DataProductsOperations operations + name: data_products + types: + - +- description: DataProductsCatalogsOperations operations + name: data_products_catalogs + types: + - +- description: DataTypesOperations operations + name: data_types + types: + - +methods: +- uid: azure.mgmt.networkanalytics.aio.NetworkAnalyticsMgmtClient.close + name: close + signature: async close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.operations.DataProductsCatalogsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.operations.DataProductsCatalogsOperations.yml new file mode 100644 index 00000000..915e02b8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.operations.DataProductsCatalogsOperations.yml @@ -0,0 +1,78 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.aio.operations.DataProductsCatalogsOperations +name: DataProductsCatalogsOperations +fullName: azure.mgmt.networkanalytics.aio.operations.DataProductsCatalogsOperations +module: azure.mgmt.networkanalytics.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: DataProductsCatalogsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.networkanalytics.aio.operations.DataProductsCatalogsOperations.get + name: get + summary: Retrieve data type resource. + signature: 'async get(resource_group_name: str, **kwargs: Any) -> DataProductsCatalog' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DataProductsCatalog or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.aio.operations.DataProductsCatalogsOperations.list_by_resource_group + name: list_by_resource_group + summary: List data catalog by resource group. + signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[DataProductsCatalog]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either DataProductsCatalog or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.aio.operations.DataProductsCatalogsOperations.list_by_subscription + name: list_by_subscription + summary: List data catalog by subscription. + signature: 'list_by_subscription(**kwargs: Any) -> AsyncIterable[DataProductsCatalog]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either DataProductsCatalog or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.networkanalytics.aio.operations.DataProductsCatalogsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.operations.DataProductsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.operations.DataProductsOperations.yml new file mode 100644 index 00000000..fb8beffe --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.operations.DataProductsOperations.yml @@ -0,0 +1,487 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.aio.operations.DataProductsOperations +name: DataProductsOperations +fullName: azure.mgmt.networkanalytics.aio.operations.DataProductsOperations +module: azure.mgmt.networkanalytics.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: DataProductsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.networkanalytics.aio.operations.DataProductsOperations.add_user_role + name: add_user_role + summary: Assign role to the data product. + signature: 'async add_user_role(resource_group_name: str, data_product_name: str, + body: _models.RoleAssignmentCommonProperties, *, content_type: str = ''application/json'', + **kwargs: Any) -> _models.RoleAssignmentDetail' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: body + description: 'The content of the action request. Is either a RoleAssignmentCommonProperties + type + + or a IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: RoleAssignmentDetail or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.aio.operations.DataProductsOperations.begin_create + name: begin_create + summary: Create data product resource. + signature: 'async begin_create(resource_group_name: str, data_product_name: str, + resource: _models.DataProduct, *, content_type: str = ''application/json'', **kwargs: + Any) -> AsyncLROPoller[_models.DataProduct]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: resource + description: 'Resource create parameters. Is either a DataProduct type or a IO + type. + + Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of AsyncLROPoller that returns either DataProduct or + the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.aio.operations.DataProductsOperations.begin_delete + name: begin_delete + summary: Delete data product resource. + signature: 'async begin_delete(resource_group_name: str, data_product_name: str, + **kwargs: Any) -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.aio.operations.DataProductsOperations.begin_update + name: begin_update + summary: Update data product resource. + signature: 'async begin_update(resource_group_name: str, data_product_name: str, + properties: _models.DataProductUpdate, *, content_type: str = ''application/json'', + **kwargs: Any) -> AsyncLROPoller[_models.DataProduct]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: properties + description: 'The resource properties to be updated. Is either a DataProductUpdate + type or + + a IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of AsyncLROPoller that returns either DataProduct or + the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.aio.operations.DataProductsOperations.generate_storage_account_sas_token + name: generate_storage_account_sas_token + summary: Generate sas token for storage account. + signature: 'async generate_storage_account_sas_token(resource_group_name: str, data_product_name: + str, body: _models.AccountSas, *, content_type: str = ''application/json'', **kwargs: + Any) -> _models.AccountSasToken' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: body + description: 'The content of the action request. Is either a AccountSas type or + a IO type. + + Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AccountSasToken or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.aio.operations.DataProductsOperations.get + name: get + summary: Retrieve data product resource. + signature: 'async get(resource_group_name: str, data_product_name: str, **kwargs: + Any) -> DataProduct' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DataProduct or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.aio.operations.DataProductsOperations.list_by_resource_group + name: list_by_resource_group + summary: List data products by resource group. + signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[DataProduct]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either DataProduct or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.aio.operations.DataProductsOperations.list_by_subscription + name: list_by_subscription + summary: List data products by subscription. + signature: 'list_by_subscription(**kwargs: Any) -> AsyncIterable[DataProduct]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either DataProduct or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.aio.operations.DataProductsOperations.list_roles_assignments + name: list_roles_assignments + summary: List user roles associated with the data product. + signature: 'async list_roles_assignments(resource_group_name: str, data_product_name: + str, body: MutableMapping[str, Any], **kwargs: Any) -> ListRoleAssignments' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: body + description: The content of the action request. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ListRoleAssignments or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.aio.operations.DataProductsOperations.remove_user_role + name: remove_user_role + summary: Remove role from the data product. + signature: 'async remove_user_role(resource_group_name: str, data_product_name: + str, body: _models.RoleAssignmentDetail, *, content_type: str = ''application/json'', + **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: body + description: 'The content of the action request. Is either a RoleAssignmentDetail + type or a IO + + type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.aio.operations.DataProductsOperations.rotate_key + name: rotate_key + summary: Initiate key rotation on Data Product. + signature: 'async rotate_key(resource_group_name: str, data_product_name: str, body: + _models.KeyVaultInfo, *, content_type: str = ''application/json'', **kwargs: Any) + -> None' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: body + description: 'The content of the action request. Is either a KeyVaultInfo type + or a IO type. + + Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.networkanalytics.aio.operations.DataProductsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.operations.DataTypesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.operations.DataTypesOperations.yml new file mode 100644 index 00000000..218866e3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.operations.DataTypesOperations.yml @@ -0,0 +1,391 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.aio.operations.DataTypesOperations +name: DataTypesOperations +fullName: azure.mgmt.networkanalytics.aio.operations.DataTypesOperations +module: azure.mgmt.networkanalytics.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: DataTypesOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.networkanalytics.aio.operations.DataTypesOperations.begin_create + name: begin_create + summary: Create data type resource. + signature: 'async begin_create(resource_group_name: str, data_product_name: str, + data_type_name: str, resource: _models.DataType, *, content_type: str = ''application/json'', + **kwargs: Any) -> AsyncLROPoller[_models.DataType]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: data_type_name + description: The data type name. Required. + isRequired: true + types: + - + - name: resource + description: Resource create parameters. Is either a DataType type or a IO type. + Required. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of AsyncLROPoller that returns either DataType or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.aio.operations.DataTypesOperations.begin_delete + name: begin_delete + summary: Delete data type resource. + signature: 'async begin_delete(resource_group_name: str, data_product_name: str, + data_type_name: str, **kwargs: Any) -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: data_type_name + description: The data type name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.aio.operations.DataTypesOperations.begin_delete_data + name: begin_delete_data + summary: Delete data for data type. + signature: 'async begin_delete_data(resource_group_name: str, data_product_name: + str, data_type_name: str, body: MutableMapping[str, Any], **kwargs: Any) -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: data_type_name + description: The data type name. Required. + isRequired: true + types: + - + - name: body + description: The content of the action request. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.aio.operations.DataTypesOperations.begin_update + name: begin_update + summary: Update data type resource. + signature: 'async begin_update(resource_group_name: str, data_product_name: str, + data_type_name: str, properties: _models.DataTypeUpdate, *, content_type: str + = ''application/json'', **kwargs: Any) -> AsyncLROPoller[_models.DataType]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: data_type_name + description: The data type name. Required. + isRequired: true + types: + - + - name: properties + description: 'The resource properties to be updated. Is either a DataTypeUpdate + type or a + + IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of AsyncLROPoller that returns either DataType or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.aio.operations.DataTypesOperations.generate_storage_container_sas_token + name: generate_storage_container_sas_token + summary: Generate sas token for storage container. + signature: 'async generate_storage_container_sas_token(resource_group_name: str, + data_product_name: str, data_type_name: str, body: _models.ContainerSaS, *, content_type: + str = ''application/json'', **kwargs: Any) -> _models.ContainerSasToken' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: data_type_name + description: The data type name. Required. + isRequired: true + types: + - + - name: body + description: 'The content of the action request. Is either a ContainerSaS type + or a IO type. + + Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ContainerSasToken or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.aio.operations.DataTypesOperations.get + name: get + summary: Retrieve data type resource. + signature: 'async get(resource_group_name: str, data_product_name: str, data_type_name: + str, **kwargs: Any) -> DataType' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: data_type_name + description: The data type name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DataType or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.aio.operations.DataTypesOperations.list_by_data_product + name: list_by_data_product + summary: List data type by parent resource. + signature: 'list_by_data_product(resource_group_name: str, data_product_name: str, + **kwargs: Any) -> AsyncIterable[DataType]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either DataType or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.networkanalytics.aio.operations.DataTypesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.operations.Operations.yml new file mode 100644 index 00000000..574423e4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.operations.Operations.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.aio.operations.Operations +name: Operations +fullName: azure.mgmt.networkanalytics.aio.operations.Operations +module: azure.mgmt.networkanalytics.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: Operations(*args, **kwargs) +methods: +- uid: azure.mgmt.networkanalytics.aio.operations.Operations.list + name: list + summary: List the operations for the provider. + signature: 'list(**kwargs: Any) -> AsyncIterable[Operation]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either Operation or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.networkanalytics.aio.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.operations.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.operations.yml new file mode 100644 index 00000000..3e8379e9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.operations.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.networkanalytics.aio.operations +name: operations +fullName: azure.mgmt.networkanalytics.aio.operations +type: import +classes: +- azure.mgmt.networkanalytics.aio.operations.DataProductsCatalogsOperations +- azure.mgmt.networkanalytics.aio.operations.DataProductsOperations +- azure.mgmt.networkanalytics.aio.operations.DataTypesOperations +- azure.mgmt.networkanalytics.aio.operations.Operations diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.yml new file mode 100644 index 00000000..50958f36 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.aio.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.networkanalytics.aio +name: aio +fullName: azure.mgmt.networkanalytics.aio +type: import +classes: +- azure.mgmt.networkanalytics.aio.NetworkAnalyticsMgmtClient +packages: +- azure.mgmt.networkanalytics.aio.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.AccountSas.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.AccountSas.yml new file mode 100644 index 00000000..29cc9725 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.AccountSas.yml @@ -0,0 +1,38 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.AccountSas +name: AccountSas +fullName: azure.mgmt.networkanalytics.models.AccountSas +module: azure.mgmt.networkanalytics.models +summary: 'The details for storage account sas creation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AccountSas(*, start_time_stamp: datetime, expiry_time_stamp: datetime, + ip_address: str, **kwargs: Any)' + keywordOnlyParameters: + - name: start_time_stamp + description: Sas token start timestamp. Required. + types: + - + - name: expiry_time_stamp + description: Sas token expiry timestamp. Required. + types: + - + - name: ip_address + description: Ip Address. Required. + types: + - +variables: +- description: Sas token start timestamp. Required. + name: start_time_stamp + types: + - +- description: Sas token expiry timestamp. Required. + name: expiry_time_stamp + types: + - +- description: Ip Address. Required. + name: ip_address + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.AccountSasToken.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.AccountSasToken.yml new file mode 100644 index 00000000..38ce852d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.AccountSasToken.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.AccountSasToken +name: AccountSasToken +fullName: azure.mgmt.networkanalytics.models.AccountSasToken +module: azure.mgmt.networkanalytics.models +summary: 'Details of storage account sas token . + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AccountSasToken(*, storage_account_sas_token: str, **kwargs: Any)' + keywordOnlyParameters: + - name: storage_account_sas_token + description: Field to specify storage account sas token. Required. + types: + - +variables: +- description: Field to specify storage account sas token. Required. + name: storage_account_sas_token + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ActionType.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ActionType.yml new file mode 100644 index 00000000..1b1718c5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ActionType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.networkanalytics.models.ActionType +name: ActionType +fullName: azure.mgmt.networkanalytics.models.ActionType +summary: Enum. Indicates the action type. "Internal" refers to actions that are for + internal only APIs. +module: azure.mgmt.networkanalytics.models +fields: +- name: INTERNAL + uid: azure.mgmt.networkanalytics.models.ActionType.INTERNAL diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Bypass.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Bypass.yml new file mode 100644 index 00000000..41909cf2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Bypass.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.networkanalytics.models.Bypass +name: Bypass +fullName: azure.mgmt.networkanalytics.models.Bypass +summary: 'Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. + Possible values are + + any combination of Logging|Metrics|AzureServices (For example, "Logging, Metrics"), + or None to + + bypass none of those traffics.' +module: azure.mgmt.networkanalytics.models +fields: +- name: AZURE_SERVICES + uid: azure.mgmt.networkanalytics.models.Bypass.AZURE_SERVICES +- name: LOGGING + uid: azure.mgmt.networkanalytics.models.Bypass.LOGGING +- name: METRICS + uid: azure.mgmt.networkanalytics.models.Bypass.METRICS +- name: NONE + uid: azure.mgmt.networkanalytics.models.Bypass.NONE diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ConsumptionEndpointsProperties.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ConsumptionEndpointsProperties.yml new file mode 100644 index 00000000..097547ab --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ConsumptionEndpointsProperties.yml @@ -0,0 +1,36 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.ConsumptionEndpointsProperties +name: ConsumptionEndpointsProperties +fullName: azure.mgmt.networkanalytics.models.ConsumptionEndpointsProperties +module: azure.mgmt.networkanalytics.models +summary: 'Details of Consumption Properties. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'ConsumptionEndpointsProperties(**kwargs: Any)' +variables: +- description: Ingestion url to upload the data. + name: ingestion_url + types: + - +- description: Resource Id of ingestion endpoint. + name: ingestion_resource_id + types: + - +- description: Url to consume file type. + name: file_access_url + types: + - +- description: Resource Id of file access endpoint. + name: file_access_resource_id + types: + - +- description: Url to consume the processed data. + name: query_url + types: + - +- description: Resource Id of query endpoint. + name: query_resource_id + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ContainerSaS.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ContainerSaS.yml new file mode 100644 index 00000000..3b6e5e86 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ContainerSaS.yml @@ -0,0 +1,38 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.ContainerSaS +name: ContainerSaS +fullName: azure.mgmt.networkanalytics.models.ContainerSaS +module: azure.mgmt.networkanalytics.models +summary: 'The details for container sas creation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ContainerSaS(*, start_time_stamp: datetime, expiry_time_stamp: datetime, + ip_address: str, **kwargs: Any)' + keywordOnlyParameters: + - name: start_time_stamp + description: Sas token start timestamp. Required. + types: + - + - name: expiry_time_stamp + description: Sas token expiry timestamp. Required. + types: + - + - name: ip_address + description: Ip Address. Required. + types: + - +variables: +- description: Sas token start timestamp. Required. + name: start_time_stamp + types: + - +- description: Sas token expiry timestamp. Required. + name: expiry_time_stamp + types: + - +- description: Ip Address. Required. + name: ip_address + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ContainerSasToken.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ContainerSasToken.yml new file mode 100644 index 00000000..eacc0d67 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ContainerSasToken.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.ContainerSasToken +name: ContainerSasToken +fullName: azure.mgmt.networkanalytics.models.ContainerSasToken +module: azure.mgmt.networkanalytics.models +summary: 'Details of storage container account sas token . + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ContainerSasToken(*, storage_container_sas_token: str, **kwargs: Any)' + keywordOnlyParameters: + - name: storage_container_sas_token + description: Field to specify storage container sas token. Required. + types: + - +variables: +- description: Field to specify storage container sas token. Required. + name: storage_container_sas_token + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ControlState.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ControlState.yml new file mode 100644 index 00000000..06e48fec --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ControlState.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.networkanalytics.models.ControlState +name: ControlState +fullName: azure.mgmt.networkanalytics.models.ControlState +summary: The data type state. +module: azure.mgmt.networkanalytics.models +fields: +- name: DISABLED + uid: azure.mgmt.networkanalytics.models.ControlState.DISABLED +- name: ENABLED + uid: azure.mgmt.networkanalytics.models.ControlState.ENABLED diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.CreatedByType.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.CreatedByType.yml new file mode 100644 index 00000000..c81ad8f5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.CreatedByType.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.networkanalytics.models.CreatedByType +name: CreatedByType +fullName: azure.mgmt.networkanalytics.models.CreatedByType +summary: The type of identity that created the resource. +module: azure.mgmt.networkanalytics.models +fields: +- name: APPLICATION + uid: azure.mgmt.networkanalytics.models.CreatedByType.APPLICATION +- name: KEY + uid: azure.mgmt.networkanalytics.models.CreatedByType.KEY +- name: MANAGED_IDENTITY + uid: azure.mgmt.networkanalytics.models.CreatedByType.MANAGED_IDENTITY +- name: USER + uid: azure.mgmt.networkanalytics.models.CreatedByType.USER diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProduct.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProduct.yml new file mode 100644 index 00000000..fed7c0d6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProduct.yml @@ -0,0 +1,73 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.DataProduct +name: DataProduct +fullName: azure.mgmt.networkanalytics.models.DataProduct +module: azure.mgmt.networkanalytics.models +summary: 'The data product resource. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DataProduct(*, location: str, tags: Dict[str, str] | None = None, properties: + _models.DataProductProperties | None = None, identity: _models.ManagedServiceIdentity + | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: tags + description: Resource tags. + types: + - [, ] + - name: location + description: The geo-location where the resource lives. Required. + types: + - + - name: properties + description: The resource-specific properties for this resource. + types: + - + - name: identity + description: The managed service identities assigned to this resource. + types: + - +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: Resource tags. + name: tags + types: + - [, ] +- description: The geo-location where the resource lives. Required. + name: location + types: + - +- description: The resource-specific properties for this resource. + name: properties + types: + - +- description: The managed service identities assigned to this resource. + name: identity + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductInformation.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductInformation.yml new file mode 100644 index 00000000..5f1e4d01 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductInformation.yml @@ -0,0 +1,38 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.DataProductInformation +name: DataProductInformation +fullName: azure.mgmt.networkanalytics.models.DataProductInformation +module: azure.mgmt.networkanalytics.models +summary: 'Data Product Information. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DataProductInformation(*, data_product_name: str, description: str, data_product_versions: + List[_models.DataProductVersion], **kwargs: Any)' + keywordOnlyParameters: + - name: data_product_name + description: Name of data product. Required. + types: + - + - name: description + description: Description about data product. Required. + types: + - + - name: data_product_versions + description: Version information of data product. Required. + types: + - [] +variables: +- description: Name of data product. Required. + name: data_product_name + types: + - +- description: Description about data product. Required. + name: description + types: + - +- description: Version information of data product. Required. + name: data_product_versions + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductListResult.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductListResult.yml new file mode 100644 index 00000000..3b51c80a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductListResult.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.DataProductListResult +name: DataProductListResult +fullName: azure.mgmt.networkanalytics.models.DataProductListResult +module: azure.mgmt.networkanalytics.models +summary: 'The response of a DataProduct list operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DataProductListResult(*, value: List[_models.DataProduct], next_link: str + | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: value + description: The DataProduct items on this page. Required. + types: + - [] + - name: next_link + description: The link to the next page of items. + types: + - +variables: +- description: The DataProduct items on this page. Required. + name: value + types: + - [] +- description: The link to the next page of items. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductNetworkAcls.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductNetworkAcls.yml new file mode 100644 index 00000000..49b1b8d1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductNetworkAcls.yml @@ -0,0 +1,53 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.DataProductNetworkAcls +name: DataProductNetworkAcls +fullName: azure.mgmt.networkanalytics.models.DataProductNetworkAcls +module: azure.mgmt.networkanalytics.models +summary: 'Data Product Network rule set. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DataProductNetworkAcls(*, virtual_network_rule: List[_models.VirtualNetworkRule], + ip_rules: List[_models.IPRules], allowed_query_ip_range_list: List[str], default_action: + str | _models.DefaultAction, **kwargs: Any)' + keywordOnlyParameters: + - name: virtual_network_rule + description: Virtual Network Rule. Required. + types: + - [] + - name: ip_rules + description: IP rule with specific IP or IP range in CIDR format. Required. + types: + - [] + - name: allowed_query_ip_range_list + description: 'The list of query ips in the format of CIDR allowed to + + connect to query/visualization endpoint. Required.' + types: + - [] + - name: default_action + description: 'Default Action. Required. Known values are: "Allow" and "Deny".' + types: + - + - +variables: +- description: Virtual Network Rule. Required. + name: virtual_network_rule + types: + - [] +- description: IP rule with specific IP or IP range in CIDR format. Required. + name: ip_rules + types: + - [] +- description: 'The list of query ips in the format of CIDR allowed to + + connect to query/visualization endpoint. Required.' + name: allowed_query_ip_range_list + types: + - [] +- description: 'Default Action. Required. Known values are: "Allow" and "Deny".' + name: default_action + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductProperties.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductProperties.yml new file mode 100644 index 00000000..db512a70 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductProperties.yml @@ -0,0 +1,190 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.DataProductProperties +name: DataProductProperties +fullName: azure.mgmt.networkanalytics.models.DataProductProperties +module: azure.mgmt.networkanalytics.models +summary: 'The data product properties. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DataProductProperties(*, publisher: str, product: str, major_version: str, + owners: List[str] | None = None, redundancy: str | _models.ControlState | None + = None, purview_account: str | None = None, purview_collection: str | None = None, + private_links_enabled: str | _models.ControlState | None = None, public_network_access: + str | _models.ControlState | None = None, customer_managed_key_encryption_enabled: + str | _models.ControlState | None = None, customer_encryption_key: _models.EncryptionKeyDetails + | None = None, networkacls: _models.DataProductNetworkAcls | None = None, managed_resource_group_configuration: + _models.ManagedResourceGroupConfiguration | None = None, current_minor_version: + str | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: publisher + description: Data product publisher name. Required. + types: + - + - name: product + description: Product name of data product. Required. + types: + - + - name: major_version + description: Major version of data product. Required. + types: + - + - name: owners + description: List of name or email associated with data product resource deployment. + types: + - [] + - name: redundancy + description: 'Flag to enable or disable redundancy for data product. Known values + are: + + "Enabled" and "Disabled".' + types: + - + - + - name: purview_account + description: Purview account url for data product to connect to. + types: + - + - name: purview_collection + description: Purview collection url for data product to connect to. + types: + - + - name: private_links_enabled + description: 'Flag to enable or disable private link for data product + + resource. Known values are: "Enabled" and "Disabled".' + types: + - + - + - name: public_network_access + description: 'Flag to enable or disable public access of data product + + resource. Known values are: "Enabled" and "Disabled".' + types: + - + - + - name: customer_managed_key_encryption_enabled + description: 'Flag to enable customer managed key + + encryption for data product. Known values are: "Enabled" and "Disabled".' + types: + - + - + - name: customer_encryption_key + description: Customer managed encryption key details for data product. + types: + - + - name: networkacls + description: Network rule set for data product. + types: + - + - name: managed_resource_group_configuration + description: Managed resource group configuration. + types: + - + - name: current_minor_version + description: Current configured minor version of the data product resource. + types: + - +variables: +- description: The resource GUID property of the data product resource. + name: resource_guid + types: + - +- description: 'Latest provisioning state of data product. Known values are: + + "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and + "Accepted".' + name: provisioning_state + types: + - + - +- description: Data product publisher name. Required. + name: publisher + types: + - +- description: Product name of data product. Required. + name: product + types: + - +- description: Major version of data product. Required. + name: major_version + types: + - +- description: List of name or email associated with data product resource deployment. + name: owners + types: + - [] +- description: 'Flag to enable or disable redundancy for data product. Known values + are: + + "Enabled" and "Disabled".' + name: redundancy + types: + - + - +- description: Purview account url for data product to connect to. + name: purview_account + types: + - +- description: Purview collection url for data product to connect to. + name: purview_collection + types: + - +- description: 'Flag to enable or disable private link for data product resource. + + Known values are: "Enabled" and "Disabled".' + name: private_links_enabled + types: + - + - +- description: 'Flag to enable or disable public access of data product resource. + + Known values are: "Enabled" and "Disabled".' + name: public_network_access + types: + - + - +- description: 'Flag to enable customer managed key encryption + + for data product. Known values are: "Enabled" and "Disabled".' + name: customer_managed_key_encryption_enabled + types: + - + - +- description: Customer managed encryption key details for data product. + name: customer_encryption_key + types: + - +- description: Network rule set for data product. + name: networkacls + types: + - +- description: Managed resource group configuration. + name: managed_resource_group_configuration + types: + - +- description: List of available minor versions of the data product resource. + name: available_minor_versions + types: + - [] +- description: Current configured minor version of the data product resource. + name: current_minor_version + types: + - +- description: Documentation link for the data product based on definition file. + name: documentation + types: + - +- description: Resource links which exposed to the customer to query the data. + name: consumption_endpoints + types: + - +- description: Key vault url. + name: key_vault_url + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductUpdate.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductUpdate.yml new file mode 100644 index 00000000..ee9173cc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductUpdate.yml @@ -0,0 +1,36 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.DataProductUpdate +name: DataProductUpdate +fullName: azure.mgmt.networkanalytics.models.DataProductUpdate +module: azure.mgmt.networkanalytics.models +summary: The type used for update operations of the DataProduct. +constructor: + syntax: 'DataProductUpdate(*, identity: _models.ManagedServiceIdentity | None = + None, tags: Dict[str, str] | None = None, properties: _models.DataProductUpdateProperties + | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: identity + description: The managed service identities assigned to this resource. + types: + - + - name: tags + description: Resource tags. + types: + - [, ] + - name: properties + description: The updatable properties of the DataProduct. + types: + - +variables: +- description: The managed service identities assigned to this resource. + name: identity + types: + - +- description: Resource tags. + name: tags + types: + - [, ] +- description: The updatable properties of the DataProduct. + name: properties + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductUpdateProperties.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductUpdateProperties.yml new file mode 100644 index 00000000..734467c9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductUpdateProperties.yml @@ -0,0 +1,59 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.DataProductUpdateProperties +name: DataProductUpdateProperties +fullName: azure.mgmt.networkanalytics.models.DataProductUpdateProperties +module: azure.mgmt.networkanalytics.models +summary: The updatable properties of the DataProduct. +constructor: + syntax: 'DataProductUpdateProperties(*, owners: List[str] | None = None, purview_account: + str | None = None, purview_collection: str | None = None, private_links_enabled: + str | _models.ControlState | None = None, current_minor_version: str | None = + None, **kwargs: Any)' + keywordOnlyParameters: + - name: owners + description: List of name or email associated with data product resource deployment. + types: + - [] + - name: purview_account + description: Purview account url for data product to connect to. + types: + - + - name: purview_collection + description: Purview collection url for data product to connect to. + types: + - + - name: private_links_enabled + description: 'Flag to enable or disable private link for data product + + resource. Known values are: "Enabled" and "Disabled".' + types: + - + - + - name: current_minor_version + description: Current configured minor version of the data product resource. + types: + - +variables: +- description: List of name or email associated with data product resource deployment. + name: owners + types: + - [] +- description: Purview account url for data product to connect to. + name: purview_account + types: + - +- description: Purview collection url for data product to connect to. + name: purview_collection + types: + - +- description: 'Flag to enable or disable private link for data product resource. + + Known values are: "Enabled" and "Disabled".' + name: private_links_enabled + types: + - + - +- description: Current configured minor version of the data product resource. + name: current_minor_version + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductUserRole.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductUserRole.yml new file mode 100644 index 00000000..1680a924 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductUserRole.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.networkanalytics.models.DataProductUserRole +name: DataProductUserRole +fullName: azure.mgmt.networkanalytics.models.DataProductUserRole +summary: The data type state. +module: azure.mgmt.networkanalytics.models +fields: +- name: READER + uid: azure.mgmt.networkanalytics.models.DataProductUserRole.READER +- name: SENSITIVE_READER + uid: azure.mgmt.networkanalytics.models.DataProductUserRole.SENSITIVE_READER diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductVersion.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductVersion.yml new file mode 100644 index 00000000..299b81c8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductVersion.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.DataProductVersion +name: DataProductVersion +fullName: azure.mgmt.networkanalytics.models.DataProductVersion +module: azure.mgmt.networkanalytics.models +summary: 'Data Product Version. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DataProductVersion(*, version: str, **kwargs: Any)' + keywordOnlyParameters: + - name: version + description: Version of data product. Required. + types: + - +variables: +- description: Version of data product. Required. + name: version + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductsCatalog.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductsCatalog.yml new file mode 100644 index 00000000..b98c18ea --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductsCatalog.yml @@ -0,0 +1,45 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.DataProductsCatalog +name: DataProductsCatalog +fullName: azure.mgmt.networkanalytics.models.DataProductsCatalog +module: azure.mgmt.networkanalytics.models +summary: 'The data catalog resource. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'DataProductsCatalog(*, properties: _models.DataProductsCatalogProperties + | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: properties + description: The resource-specific properties for this resource. + types: + - +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: The resource-specific properties for this resource. + name: properties + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductsCatalogListResult.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductsCatalogListResult.yml new file mode 100644 index 00000000..d6efe545 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductsCatalogListResult.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.DataProductsCatalogListResult +name: DataProductsCatalogListResult +fullName: azure.mgmt.networkanalytics.models.DataProductsCatalogListResult +module: azure.mgmt.networkanalytics.models +summary: 'The response of a DataProductsCatalog list operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DataProductsCatalogListResult(*, value: List[_models.DataProductsCatalog], + next_link: str | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: value + description: The DataProductsCatalog items on this page. Required. + types: + - [] + - name: next_link + description: The link to the next page of items. + types: + - +variables: +- description: The DataProductsCatalog items on this page. Required. + name: value + types: + - [] +- description: The link to the next page of items. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductsCatalogProperties.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductsCatalogProperties.yml new file mode 100644 index 00000000..d943d662 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductsCatalogProperties.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.DataProductsCatalogProperties +name: DataProductsCatalogProperties +fullName: azure.mgmt.networkanalytics.models.DataProductsCatalogProperties +module: azure.mgmt.networkanalytics.models +summary: 'Details for data catalog properties. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DataProductsCatalogProperties(*, publishers: List[_models.PublisherInformation], + **kwargs: Any)' + keywordOnlyParameters: + - name: publishers + description: The data product publisher information. Required. + types: + - [] +variables: +- description: 'The data catalog provisioning state. Known values are: "Succeeded", + + "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".' + name: provisioning_state + types: + - + - +- description: The data product publisher information. Required. + name: publishers + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataType.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataType.yml new file mode 100644 index 00000000..80d0e60a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataType.yml @@ -0,0 +1,45 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.DataType +name: DataType +fullName: azure.mgmt.networkanalytics.models.DataType +module: azure.mgmt.networkanalytics.models +summary: 'The data type resource. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'DataType(*, properties: _models.DataTypeProperties | None = None, **kwargs: + Any)' + keywordOnlyParameters: + - name: properties + description: The resource-specific properties for this resource. + types: + - +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: The resource-specific properties for this resource. + name: properties + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeListResult.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeListResult.yml new file mode 100644 index 00000000..6945483a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeListResult.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.DataTypeListResult +name: DataTypeListResult +fullName: azure.mgmt.networkanalytics.models.DataTypeListResult +module: azure.mgmt.networkanalytics.models +summary: 'The response of a DataType list operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DataTypeListResult(*, value: List[_models.DataType], next_link: str | None + = None, **kwargs: Any)' + keywordOnlyParameters: + - name: value + description: The DataType items on this page. Required. + types: + - [] + - name: next_link + description: The link to the next page of items. + types: + - +variables: +- description: The DataType items on this page. Required. + name: value + types: + - [] +- description: The link to the next page of items. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeProperties.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeProperties.yml new file mode 100644 index 00000000..02f5828a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeProperties.yml @@ -0,0 +1,65 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.DataTypeProperties +name: DataTypeProperties +fullName: azure.mgmt.networkanalytics.models.DataTypeProperties +module: azure.mgmt.networkanalytics.models +summary: 'The data type properties. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'DataTypeProperties(*, state: str | _models.DataTypeState | None = None, + storage_output_retention: int | None = None, database_cache_retention: int | None + = None, database_retention: int | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: state + description: 'State of data type. Known values are: "Stopped" and "Running".' + types: + - + - + - name: storage_output_retention + description: Field for storage output retention in days. + types: + - + - name: database_cache_retention + description: Field for database cache retention in days. + types: + - + - name: database_retention + description: Field for database data retention in days. + types: + - +variables: +- description: 'Latest provisioning state of data product. Known values are: + + "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and + "Accepted".' + name: provisioning_state + types: + - + - +- description: 'State of data type. Known values are: "Stopped" and "Running".' + name: state + types: + - + - +- description: Reason for the state of data type. + name: state_reason + types: + - +- description: Field for storage output retention in days. + name: storage_output_retention + types: + - +- description: Field for database cache retention in days. + name: database_cache_retention + types: + - +- description: Field for database data retention in days. + name: database_retention + types: + - +- description: Url for data visualization. + name: visualization_url + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeState.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeState.yml new file mode 100644 index 00000000..9fafc3ea --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeState.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.networkanalytics.models.DataTypeState +name: DataTypeState +fullName: azure.mgmt.networkanalytics.models.DataTypeState +summary: The data type state. +module: azure.mgmt.networkanalytics.models +fields: +- name: RUNNING + uid: azure.mgmt.networkanalytics.models.DataTypeState.RUNNING +- name: STOPPED + uid: azure.mgmt.networkanalytics.models.DataTypeState.STOPPED diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeUpdate.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeUpdate.yml new file mode 100644 index 00000000..05d0afb9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeUpdate.yml @@ -0,0 +1,19 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.DataTypeUpdate +name: DataTypeUpdate +fullName: azure.mgmt.networkanalytics.models.DataTypeUpdate +module: azure.mgmt.networkanalytics.models +summary: The type used for update operations of the DataType. +constructor: + syntax: 'DataTypeUpdate(*, properties: _models.DataTypeUpdateProperties | None = + None, **kwargs: Any)' + keywordOnlyParameters: + - name: properties + description: The updatable properties of the DataType. + types: + - +variables: +- description: The updatable properties of the DataType. + name: properties + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeUpdateProperties.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeUpdateProperties.yml new file mode 100644 index 00000000..ff3a23af --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeUpdateProperties.yml @@ -0,0 +1,46 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.DataTypeUpdateProperties +name: DataTypeUpdateProperties +fullName: azure.mgmt.networkanalytics.models.DataTypeUpdateProperties +module: azure.mgmt.networkanalytics.models +summary: The updatable properties of the DataType. +constructor: + syntax: 'DataTypeUpdateProperties(*, state: str | _models.DataTypeState | None = + None, storage_output_retention: int | None = None, database_cache_retention: int + | None = None, database_retention: int | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: state + description: 'State of data type. Known values are: "Stopped" and "Running".' + types: + - + - + - name: storage_output_retention + description: Field for storage output retention in days. + types: + - + - name: database_cache_retention + description: Field for database cache retention in days. + types: + - + - name: database_retention + description: Field for database data retention in days. + types: + - +variables: +- description: 'State of data type. Known values are: "Stopped" and "Running".' + name: state + types: + - + - +- description: Field for storage output retention in days. + name: storage_output_retention + types: + - +- description: Field for database cache retention in days. + name: database_cache_retention + types: + - +- description: Field for database data retention in days. + name: database_retention + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DefaultAction.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DefaultAction.yml new file mode 100644 index 00000000..0ea1a953 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DefaultAction.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.networkanalytics.models.DefaultAction +name: DefaultAction +fullName: azure.mgmt.networkanalytics.models.DefaultAction +summary: Specifies the default action of allow or deny when no other rules match. +module: azure.mgmt.networkanalytics.models +fields: +- name: ALLOW + uid: azure.mgmt.networkanalytics.models.DefaultAction.ALLOW +- name: DENY + uid: azure.mgmt.networkanalytics.models.DefaultAction.DENY diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.EncryptionKeyDetails.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.EncryptionKeyDetails.yml new file mode 100644 index 00000000..87bc3a1f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.EncryptionKeyDetails.yml @@ -0,0 +1,38 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.EncryptionKeyDetails +name: EncryptionKeyDetails +fullName: azure.mgmt.networkanalytics.models.EncryptionKeyDetails +module: azure.mgmt.networkanalytics.models +summary: 'Encryption key details. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EncryptionKeyDetails(*, key_vault_uri: str, key_name: str, key_version: + str, **kwargs: Any)' + keywordOnlyParameters: + - name: key_vault_uri + description: The Uri of the key vault. Required. + types: + - + - name: key_name + description: The name of the key vault key. Required. + types: + - + - name: key_version + description: The version of the key vault key. Required. + types: + - +variables: +- description: The Uri of the key vault. Required. + name: key_vault_uri + types: + - +- description: The name of the key vault key. Required. + name: key_name + types: + - +- description: The version of the key vault key. Required. + name: key_version + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ErrorAdditionalInfo.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ErrorAdditionalInfo.yml new file mode 100644 index 00000000..0cf5ef5f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ErrorAdditionalInfo.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.ErrorAdditionalInfo +name: ErrorAdditionalInfo +fullName: azure.mgmt.networkanalytics.models.ErrorAdditionalInfo +module: azure.mgmt.networkanalytics.models +summary: 'The resource management error additional info. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'ErrorAdditionalInfo(**kwargs: Any)' +variables: +- description: The additional info type. + name: type + types: + - +- description: The additional info. + name: info + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ErrorDetail.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ErrorDetail.yml new file mode 100644 index 00000000..d2dda9d6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ErrorDetail.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.ErrorDetail +name: ErrorDetail +fullName: azure.mgmt.networkanalytics.models.ErrorDetail +module: azure.mgmt.networkanalytics.models +summary: 'The error detail. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'ErrorDetail(**kwargs: Any)' +variables: +- description: The error code. + name: code + types: + - +- description: The error message. + name: message + types: + - +- description: The error target. + name: target + types: + - +- description: The error details. + name: details + types: + - [] +- description: The error additional info. + name: additional_info + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ErrorResponse.yml new file mode 100644 index 00000000..dc7f3f06 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ErrorResponse.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.ErrorResponse +name: ErrorResponse +fullName: azure.mgmt.networkanalytics.models.ErrorResponse +module: azure.mgmt.networkanalytics.models +summary: 'Common error response for all Azure Resource Manager APIs to return error + details for failed + + operations. (This also follows the OData error response format.).' +constructor: + syntax: 'ErrorResponse(*, error: _models.ErrorDetail | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: error + description: The error object. + types: + - +variables: +- description: The error object. + name: error + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.IPRules.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.IPRules.yml new file mode 100644 index 00000000..7d02a185 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.IPRules.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.IPRules +name: IPRules +fullName: azure.mgmt.networkanalytics.models.IPRules +module: azure.mgmt.networkanalytics.models +summary: 'IP rule with specific IP or IP range in CIDR format. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'IPRules(*, action: str, value: str | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: value + description: IP Rules Value. + types: + - + - name: action + description: The action of virtual network rule. Required. + types: + - +variables: +- description: IP Rules Value. + name: value + types: + - +- description: The action of virtual network rule. Required. + name: action + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.KeyVaultInfo.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.KeyVaultInfo.yml new file mode 100644 index 00000000..9182304d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.KeyVaultInfo.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.KeyVaultInfo +name: KeyVaultInfo +fullName: azure.mgmt.networkanalytics.models.KeyVaultInfo +module: azure.mgmt.networkanalytics.models +summary: 'Details for KeyVault. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeyVaultInfo(*, key_vault_url: str, **kwargs: Any)' + keywordOnlyParameters: + - name: key_vault_url + description: key vault url. Required. + types: + - +variables: +- description: key vault url. Required. + name: key_vault_url + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ListRoleAssignments.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ListRoleAssignments.yml new file mode 100644 index 00000000..76a6eaf6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ListRoleAssignments.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.ListRoleAssignments +name: ListRoleAssignments +fullName: azure.mgmt.networkanalytics.models.ListRoleAssignments +module: azure.mgmt.networkanalytics.models +summary: 'list role assignments. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ListRoleAssignments(*, count: int, role_assignment_response: List[_models.RoleAssignmentDetail], + **kwargs: Any)' + keywordOnlyParameters: + - name: count + description: Count of role assignments. Required. + types: + - + - name: role_assignment_response + description: list of role assignments. Required. + types: + - [] +variables: +- description: Count of role assignments. Required. + name: count + types: + - +- description: list of role assignments. Required. + name: role_assignment_response + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ManagedResourceGroupConfiguration.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ManagedResourceGroupConfiguration.yml new file mode 100644 index 00000000..960af8e2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ManagedResourceGroupConfiguration.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.ManagedResourceGroupConfiguration +name: ManagedResourceGroupConfiguration +fullName: azure.mgmt.networkanalytics.models.ManagedResourceGroupConfiguration +module: azure.mgmt.networkanalytics.models +summary: 'ManagedResourceGroup related properties. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ManagedResourceGroupConfiguration(*, name: str, location: str, **kwargs: + Any)' + keywordOnlyParameters: + - name: name + description: Name of managed resource group. Required. + types: + - + - name: location + description: Managed Resource Group location. Required. + types: + - +variables: +- description: Name of managed resource group. Required. + name: name + types: + - +- description: Managed Resource Group location. Required. + name: location + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ManagedServiceIdentity.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ManagedServiceIdentity.yml new file mode 100644 index 00000000..e983605a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ManagedServiceIdentity.yml @@ -0,0 +1,75 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.ManagedServiceIdentity +name: ManagedServiceIdentity +fullName: azure.mgmt.networkanalytics.models.ManagedServiceIdentity +module: azure.mgmt.networkanalytics.models +summary: 'Managed service identity (system assigned and/or user assigned identities). + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ManagedServiceIdentity(*, type: str | _models.ManagedServiceIdentityType, + user_assigned_identities: Dict[str, _models.UserAssignedIdentity] | None = None, + **kwargs: Any)' + keywordOnlyParameters: + - name: type + description: 'Type of managed service identity (where both SystemAssigned and + UserAssigned + + types are allowed). Required. Known values are: "None", "SystemAssigned", "UserAssigned", + and + + "SystemAssigned, UserAssigned".' + types: + - + - + - name: user_assigned_identities + description: '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.' + types: + - [, ] +variables: +- description: 'The service principal ID of the system assigned identity. This property + + will only be provided for a system assigned identity.' + name: principal_id + types: + - +- description: 'The tenant ID of the system assigned identity. This property will + only be + + provided for a system assigned identity.' + name: tenant_id + types: + - +- description: 'Type of managed service identity (where both SystemAssigned and UserAssigned + types + + are allowed). Required. Known values are: "None", "SystemAssigned", "UserAssigned", + and + + "SystemAssigned, UserAssigned".' + name: type + types: + - + - +- description: '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.' + name: user_assigned_identities + types: + - [, ] diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ManagedServiceIdentityType.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ManagedServiceIdentityType.yml new file mode 100644 index 00000000..50f91491 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ManagedServiceIdentityType.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.networkanalytics.models.ManagedServiceIdentityType +name: ManagedServiceIdentityType +fullName: azure.mgmt.networkanalytics.models.ManagedServiceIdentityType +summary: 'Type of managed service identity (where both SystemAssigned and UserAssigned + types are + + allowed).' +module: azure.mgmt.networkanalytics.models +fields: +- name: NONE + uid: azure.mgmt.networkanalytics.models.ManagedServiceIdentityType.NONE +- name: SYSTEM_ASSIGNED + uid: azure.mgmt.networkanalytics.models.ManagedServiceIdentityType.SYSTEM_ASSIGNED +- name: SYSTEM_ASSIGNED_USER_ASSIGNED + uid: azure.mgmt.networkanalytics.models.ManagedServiceIdentityType.SYSTEM_ASSIGNED_USER_ASSIGNED +- name: USER_ASSIGNED + uid: azure.mgmt.networkanalytics.models.ManagedServiceIdentityType.USER_ASSIGNED diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Operation.yml new file mode 100644 index 00000000..95810d01 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Operation.yml @@ -0,0 +1,55 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.Operation +name: Operation +fullName: azure.mgmt.networkanalytics.models.Operation +module: azure.mgmt.networkanalytics.models +summary: 'Details of a REST API operation, returned from the Resource Provider Operations + API. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'Operation(*, display: _models.OperationDisplay | None = None, **kwargs: + Any)' + keywordOnlyParameters: + - name: display + description: Localized display information for this particular operation. + types: + - +variables: +- description: 'The name of the operation, as per Resource-Based Access Control (RBAC). + Examples: + + "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action".' + name: name + types: + - +- description: 'Whether the operation applies to data-plane. This is "true" for + + data-plane operations and "false" for ARM/control-plane operations.' + name: is_data_action + types: + - +- description: Localized display information for this particular operation. + name: display + types: + - +- description: 'The intended executor of the operation; as in Resource Based Access + Control + + (RBAC) and audit logs UX. Default value is "user,system". Known values are: "user", + "system", + + and "user,system".' + name: origin + types: + - + - +- description: 'Enum. Indicates the action type. "Internal" refers to actions that + are for + + internal only APIs. "Internal"' + name: action_type + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.OperationDisplay.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.OperationDisplay.yml new file mode 100644 index 00000000..f68e565c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.OperationDisplay.yml @@ -0,0 +1,37 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.OperationDisplay +name: OperationDisplay +fullName: azure.mgmt.networkanalytics.models.OperationDisplay +module: azure.mgmt.networkanalytics.models +summary: 'Localized display information for this particular operation. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'OperationDisplay(**kwargs: Any)' +variables: +- description: 'The localized friendly form of the resource provider name, e.g. "Microsoft + + Monitoring Insights" or "Microsoft Compute".' + name: provider + types: + - +- description: 'The localized friendly name of the resource type related to this operation. + + E.g. "Virtual Machines" or "Job Schedule Collections".' + name: resource + types: + - +- description: 'The concise, localized friendly name for the operation; suitable for + + dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine".' + name: operation + types: + - +- description: 'The short, localized friendly description of the operation; suitable + for + + tool tips and detailed views.' + name: description + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.OperationListResult.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.OperationListResult.yml new file mode 100644 index 00000000..f7b0e32b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.OperationListResult.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.OperationListResult +name: OperationListResult +fullName: azure.mgmt.networkanalytics.models.OperationListResult +module: azure.mgmt.networkanalytics.models +summary: 'A list of REST API operations supported by an Azure Resource Provider. It + contains an URL link + + to get the next set of results. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'OperationListResult(**kwargs: Any)' +variables: +- description: List of operations supported by the resource provider. + name: value + types: + - [] +- description: URL to get the next set of operation list results (if there are any). + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Origin.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Origin.yml new file mode 100644 index 00000000..d4109de0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Origin.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.networkanalytics.models.Origin +name: Origin +fullName: azure.mgmt.networkanalytics.models.Origin +summary: 'The intended executor of the operation; as in Resource Based Access Control + (RBAC) and audit + + logs UX. Default value is "user,system".' +module: azure.mgmt.networkanalytics.models +fields: +- name: SYSTEM + uid: azure.mgmt.networkanalytics.models.Origin.SYSTEM +- name: USER + uid: azure.mgmt.networkanalytics.models.Origin.USER +- name: USER_SYSTEM + uid: azure.mgmt.networkanalytics.models.Origin.USER_SYSTEM diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ProvisioningState.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ProvisioningState.yml new file mode 100644 index 00000000..bf26d279 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ProvisioningState.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.networkanalytics.models.ProvisioningState +name: ProvisioningState +fullName: azure.mgmt.networkanalytics.models.ProvisioningState +summary: The status of the current operation. +module: azure.mgmt.networkanalytics.models +fields: +- name: ACCEPTED + uid: azure.mgmt.networkanalytics.models.ProvisioningState.ACCEPTED +- name: CANCELED + uid: azure.mgmt.networkanalytics.models.ProvisioningState.CANCELED +- name: DELETING + uid: azure.mgmt.networkanalytics.models.ProvisioningState.DELETING +- name: FAILED + uid: azure.mgmt.networkanalytics.models.ProvisioningState.FAILED +- name: PROVISIONING + uid: azure.mgmt.networkanalytics.models.ProvisioningState.PROVISIONING +- name: SUCCEEDED + uid: azure.mgmt.networkanalytics.models.ProvisioningState.SUCCEEDED +- name: UPDATING + uid: azure.mgmt.networkanalytics.models.ProvisioningState.UPDATING diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ProxyResource.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ProxyResource.yml new file mode 100644 index 00000000..bd1d7a58 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ProxyResource.yml @@ -0,0 +1,38 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.ProxyResource +name: ProxyResource +fullName: azure.mgmt.networkanalytics.models.ProxyResource +module: azure.mgmt.networkanalytics.models +summary: 'The resource model definition for a Azure Resource Manager proxy resource. + It will not have + + tags and a location. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'ProxyResource(**kwargs: Any)' +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.PublisherInformation.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.PublisherInformation.yml new file mode 100644 index 00000000..c7853931 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.PublisherInformation.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.PublisherInformation +name: PublisherInformation +fullName: azure.mgmt.networkanalytics.models.PublisherInformation +module: azure.mgmt.networkanalytics.models +summary: 'Details for Publisher Information. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PublisherInformation(*, publisher_name: str, data_products: List[_models.DataProductInformation], + **kwargs: Any)' + keywordOnlyParameters: + - name: publisher_name + description: Name of the publisher. Required. + types: + - + - name: data_products + description: Data product information. Required. + types: + - [] +variables: +- description: Name of the publisher. Required. + name: publisher_name + types: + - +- description: Data product information. Required. + name: data_products + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Resource.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Resource.yml new file mode 100644 index 00000000..747a1794 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Resource.yml @@ -0,0 +1,36 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.Resource +name: Resource +fullName: azure.mgmt.networkanalytics.models.Resource +module: azure.mgmt.networkanalytics.models +summary: 'Common fields that are returned in the response for all Azure Resource Manager + resources. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'Resource(**kwargs: Any)' +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ResourceAccessRules.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ResourceAccessRules.yml new file mode 100644 index 00000000..fd242ee1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ResourceAccessRules.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.ResourceAccessRules +name: ResourceAccessRules +fullName: azure.mgmt.networkanalytics.models.ResourceAccessRules +module: azure.mgmt.networkanalytics.models +summary: 'Resource Access Rules. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ResourceAccessRules(*, tenant_id: str, resource_id: str, **kwargs: Any)' + keywordOnlyParameters: + - name: tenant_id + description: The tenant ID of resource. Required. + types: + - + - name: resource_id + description: Resource ID. Required. + types: + - +variables: +- description: The tenant ID of resource. Required. + name: tenant_id + types: + - +- description: Resource ID. Required. + name: resource_id + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.RoleAssignmentCommonProperties.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.RoleAssignmentCommonProperties.yml new file mode 100644 index 00000000..20f4142c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.RoleAssignmentCommonProperties.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.RoleAssignmentCommonProperties +name: RoleAssignmentCommonProperties +fullName: azure.mgmt.networkanalytics.models.RoleAssignmentCommonProperties +module: azure.mgmt.networkanalytics.models +summary: 'The details for role assignment common properties. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RoleAssignmentCommonProperties(*, role_id: str, principal_id: str, user_name: + str, data_type_scope: List[str], principal_type: str, role: str | _models.DataProductUserRole, + **kwargs: Any)' + keywordOnlyParameters: + - name: role_id + description: Role Id of the Built-In Role. Required. + types: + - + - name: principal_id + description: Object ID of the AAD principal or security-group. Required. + types: + - + - name: user_name + description: User name. Required. + types: + - + - name: data_type_scope + description: Data Type Scope at which the role assignment is created. Required. + types: + - [] + - name: principal_type + description: 'Type of the principal Id: User, Group or ServicePrincipal. Required.' + types: + - + - name: role + description: 'Data Product role to be assigned to a user. Required. Known values + are: "Reader" + + and "SensitiveReader".' + types: + - + - +variables: +- description: Role Id of the Built-In Role. Required. + name: role_id + types: + - +- description: Object ID of the AAD principal or security-group. Required. + name: principal_id + types: + - +- description: User name. Required. + name: user_name + types: + - +- description: Data Type Scope at which the role assignment is created. Required. + name: data_type_scope + types: + - [] +- description: 'Type of the principal Id: User, Group or ServicePrincipal. Required.' + name: principal_type + types: + - +- description: 'Data Product role to be assigned to a user. Required. Known values + are: "Reader" + + and "SensitiveReader".' + name: role + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.RoleAssignmentDetail.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.RoleAssignmentDetail.yml new file mode 100644 index 00000000..1d4a85e1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.RoleAssignmentDetail.yml @@ -0,0 +1,79 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.RoleAssignmentDetail +name: RoleAssignmentDetail +fullName: azure.mgmt.networkanalytics.models.RoleAssignmentDetail +module: azure.mgmt.networkanalytics.models +summary: 'The details for role assignment response. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RoleAssignmentDetail(*, role_id: str, principal_id: str, user_name: str, + data_type_scope: List[str], principal_type: str, role: str | _models.DataProductUserRole, + role_assignment_id: str, **kwargs: Any)' + keywordOnlyParameters: + - name: role_id + description: Role Id of the Built-In Role. Required. + types: + - + - name: principal_id + description: Object ID of the AAD principal or security-group. Required. + types: + - + - name: user_name + description: User name. Required. + types: + - + - name: data_type_scope + description: Data Type Scope at which the role assignment is created. Required. + types: + - [] + - name: principal_type + description: 'Type of the principal Id: User, Group or ServicePrincipal. Required.' + types: + - + - name: role + description: 'Data Product role to be assigned to a user. Required. Known values + are: "Reader" + + and "SensitiveReader".' + types: + - + - + - name: role_assignment_id + description: Id of role assignment request. Required. + types: + - +variables: +- description: Role Id of the Built-In Role. Required. + name: role_id + types: + - +- description: Object ID of the AAD principal or security-group. Required. + name: principal_id + types: + - +- description: User name. Required. + name: user_name + types: + - +- description: Data Type Scope at which the role assignment is created. Required. + name: data_type_scope + types: + - [] +- description: 'Type of the principal Id: User, Group or ServicePrincipal. Required.' + name: principal_type + types: + - +- description: 'Data Product role to be assigned to a user. Required. Known values + are: "Reader" + + and "SensitiveReader".' + name: role + types: + - + - +- description: Id of role assignment request. Required. + name: role_assignment_id + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.SystemData.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.SystemData.yml new file mode 100644 index 00000000..004a5d35 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.SystemData.yml @@ -0,0 +1,73 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.SystemData +name: SystemData +fullName: azure.mgmt.networkanalytics.models.SystemData +module: azure.mgmt.networkanalytics.models +summary: Metadata pertaining to creation and last modification of the resource. +constructor: + syntax: 'SystemData(*, created_by: str | None = None, created_by_type: str | _models.CreatedByType + | None = None, created_at: datetime | None = None, last_modified_by: str | None + = None, last_modified_by_type: str | _models.CreatedByType | None = None, last_modified_at: + datetime | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: created_by + description: The identity that created the resource. + types: + - + - name: created_by_type + description: 'The type of identity that created the resource. Known values are: + + "User", "Application", "ManagedIdentity", and "Key".' + types: + - + - + - name: created_at + description: The timestamp of resource creation (UTC). + types: + - + - name: last_modified_by + description: The identity that last modified the resource. + types: + - + - name: last_modified_by_type + description: 'The type of identity that last modified the resource. Known + + values are: "User", "Application", "ManagedIdentity", and "Key".' + types: + - + - + - name: last_modified_at + description: The timestamp of resource last modification (UTC). + types: + - +variables: +- description: The identity that created the resource. + name: created_by + types: + - +- description: 'The type of identity that created the resource. Known values are: + + "User", "Application", "ManagedIdentity", and "Key".' + name: created_by_type + types: + - + - +- description: The timestamp of resource creation (UTC). + name: created_at + types: + - +- description: The identity that last modified the resource. + name: last_modified_by + types: + - +- description: 'The type of identity that last modified the resource. Known values + + are: "User", "Application", "ManagedIdentity", and "Key".' + name: last_modified_by_type + types: + - + - +- description: The timestamp of resource last modification (UTC). + name: last_modified_at + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.TrackedResource.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.TrackedResource.yml new file mode 100644 index 00000000..9fced5a6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.TrackedResource.yml @@ -0,0 +1,59 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.TrackedResource +name: TrackedResource +fullName: azure.mgmt.networkanalytics.models.TrackedResource +module: azure.mgmt.networkanalytics.models +summary: 'The resource model definition for an Azure Resource Manager tracked top + level resource which + + has ''tags'' and a ''location''. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TrackedResource(*, location: str, tags: Dict[str, str] | None = None, **kwargs: + Any)' + keywordOnlyParameters: + - name: tags + description: Resource tags. + types: + - [, ] + - name: location + description: The geo-location where the resource lives. Required. + types: + - +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: Resource tags. + name: tags + types: + - [, ] +- description: The geo-location where the resource lives. Required. + name: location + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.UserAssignedIdentity.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.UserAssignedIdentity.yml new file mode 100644 index 00000000..dc28596a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.UserAssignedIdentity.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.UserAssignedIdentity +name: UserAssignedIdentity +fullName: azure.mgmt.networkanalytics.models.UserAssignedIdentity +module: azure.mgmt.networkanalytics.models +summary: 'User assigned identity properties. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'UserAssignedIdentity(**kwargs: Any)' +variables: +- description: The principal ID of the assigned identity. + name: principal_id + types: + - +- description: The client ID of the assigned identity. + name: client_id + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Versions.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Versions.yml new file mode 100644 index 00000000..e0261ef2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Versions.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.networkanalytics.models.Versions +name: Versions +fullName: azure.mgmt.networkanalytics.models.Versions +summary: The available API versions for the Microsoft.NetworkAnalytics RP. +module: azure.mgmt.networkanalytics.models +fields: +- name: V2023_11_15 + uid: azure.mgmt.networkanalytics.models.Versions.V2023_11_15 diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.VirtualNetworkRule.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.VirtualNetworkRule.yml new file mode 100644 index 00000000..1cf07156 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.VirtualNetworkRule.yml @@ -0,0 +1,38 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.models.VirtualNetworkRule +name: VirtualNetworkRule +fullName: azure.mgmt.networkanalytics.models.VirtualNetworkRule +module: azure.mgmt.networkanalytics.models +summary: 'Virtual Network Rule. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'VirtualNetworkRule(*, id: str, action: str | None = None, state: str | + None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: id + description: Resource ID of a subnet. Required. + types: + - + - name: action + description: The action of virtual network rule. + types: + - + - name: state + description: Gets the state of virtual network rule. + types: + - +variables: +- description: Resource ID of a subnet. Required. + name: id + types: + - +- description: The action of virtual network rule. + name: action + types: + - +- description: Gets the state of virtual network rule. + name: state + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.yml new file mode 100644 index 00000000..704d2c05 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.yml @@ -0,0 +1,61 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.networkanalytics.models +name: models +fullName: azure.mgmt.networkanalytics.models +type: import +classes: +- azure.mgmt.networkanalytics.models.AccountSas +- azure.mgmt.networkanalytics.models.AccountSasToken +- azure.mgmt.networkanalytics.models.ConsumptionEndpointsProperties +- azure.mgmt.networkanalytics.models.ContainerSaS +- azure.mgmt.networkanalytics.models.ContainerSasToken +- azure.mgmt.networkanalytics.models.DataProduct +- azure.mgmt.networkanalytics.models.DataProductInformation +- azure.mgmt.networkanalytics.models.DataProductListResult +- azure.mgmt.networkanalytics.models.DataProductNetworkAcls +- azure.mgmt.networkanalytics.models.DataProductProperties +- azure.mgmt.networkanalytics.models.DataProductUpdate +- azure.mgmt.networkanalytics.models.DataProductUpdateProperties +- azure.mgmt.networkanalytics.models.DataProductVersion +- azure.mgmt.networkanalytics.models.DataProductsCatalog +- azure.mgmt.networkanalytics.models.DataProductsCatalogListResult +- azure.mgmt.networkanalytics.models.DataProductsCatalogProperties +- azure.mgmt.networkanalytics.models.DataType +- azure.mgmt.networkanalytics.models.DataTypeListResult +- azure.mgmt.networkanalytics.models.DataTypeProperties +- azure.mgmt.networkanalytics.models.DataTypeUpdate +- azure.mgmt.networkanalytics.models.DataTypeUpdateProperties +- azure.mgmt.networkanalytics.models.EncryptionKeyDetails +- azure.mgmt.networkanalytics.models.ErrorAdditionalInfo +- azure.mgmt.networkanalytics.models.ErrorDetail +- azure.mgmt.networkanalytics.models.ErrorResponse +- azure.mgmt.networkanalytics.models.IPRules +- azure.mgmt.networkanalytics.models.KeyVaultInfo +- azure.mgmt.networkanalytics.models.ListRoleAssignments +- azure.mgmt.networkanalytics.models.ManagedResourceGroupConfiguration +- azure.mgmt.networkanalytics.models.ManagedServiceIdentity +- azure.mgmt.networkanalytics.models.Operation +- azure.mgmt.networkanalytics.models.OperationDisplay +- azure.mgmt.networkanalytics.models.OperationListResult +- azure.mgmt.networkanalytics.models.ProxyResource +- azure.mgmt.networkanalytics.models.PublisherInformation +- azure.mgmt.networkanalytics.models.Resource +- azure.mgmt.networkanalytics.models.ResourceAccessRules +- azure.mgmt.networkanalytics.models.RoleAssignmentCommonProperties +- azure.mgmt.networkanalytics.models.RoleAssignmentDetail +- azure.mgmt.networkanalytics.models.SystemData +- azure.mgmt.networkanalytics.models.TrackedResource +- azure.mgmt.networkanalytics.models.UserAssignedIdentity +- azure.mgmt.networkanalytics.models.VirtualNetworkRule +enums: +- azure.mgmt.networkanalytics.models.ActionType +- azure.mgmt.networkanalytics.models.Bypass +- azure.mgmt.networkanalytics.models.ControlState +- azure.mgmt.networkanalytics.models.CreatedByType +- azure.mgmt.networkanalytics.models.DataProductUserRole +- azure.mgmt.networkanalytics.models.DataTypeState +- azure.mgmt.networkanalytics.models.DefaultAction +- azure.mgmt.networkanalytics.models.ManagedServiceIdentityType +- azure.mgmt.networkanalytics.models.Origin +- azure.mgmt.networkanalytics.models.ProvisioningState +- azure.mgmt.networkanalytics.models.Versions diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.operations.DataProductsCatalogsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.operations.DataProductsCatalogsOperations.yml new file mode 100644 index 00000000..c8570515 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.operations.DataProductsCatalogsOperations.yml @@ -0,0 +1,78 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.operations.DataProductsCatalogsOperations +name: DataProductsCatalogsOperations +fullName: azure.mgmt.networkanalytics.operations.DataProductsCatalogsOperations +module: azure.mgmt.networkanalytics.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: DataProductsCatalogsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.networkanalytics.operations.DataProductsCatalogsOperations.get + name: get + summary: Retrieve data type resource. + signature: 'get(resource_group_name: str, **kwargs: Any) -> DataProductsCatalog' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DataProductsCatalog or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.operations.DataProductsCatalogsOperations.list_by_resource_group + name: list_by_resource_group + summary: List data catalog by resource group. + signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[DataProductsCatalog]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either DataProductsCatalog or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.operations.DataProductsCatalogsOperations.list_by_subscription + name: list_by_subscription + summary: List data catalog by subscription. + signature: 'list_by_subscription(**kwargs: Any) -> Iterable[DataProductsCatalog]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either DataProductsCatalog or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.networkanalytics.operations.DataProductsCatalogsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.operations.DataProductsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.operations.DataProductsOperations.yml new file mode 100644 index 00000000..6aad47d5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.operations.DataProductsOperations.yml @@ -0,0 +1,486 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.operations.DataProductsOperations +name: DataProductsOperations +fullName: azure.mgmt.networkanalytics.operations.DataProductsOperations +module: azure.mgmt.networkanalytics.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: DataProductsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.networkanalytics.operations.DataProductsOperations.add_user_role + name: add_user_role + summary: Assign role to the data product. + signature: 'add_user_role(resource_group_name: str, data_product_name: str, body: + _models.RoleAssignmentCommonProperties, *, content_type: str = ''application/json'', + **kwargs: Any) -> _models.RoleAssignmentDetail' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: body + description: 'The content of the action request. Is either a RoleAssignmentCommonProperties + type + + or a IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: RoleAssignmentDetail or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.operations.DataProductsOperations.begin_create + name: begin_create + summary: Create data product resource. + signature: 'begin_create(resource_group_name: str, data_product_name: str, resource: + _models.DataProduct, *, content_type: str = ''application/json'', **kwargs: Any) + -> LROPoller[_models.DataProduct]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: resource + description: 'Resource create parameters. Is either a DataProduct type or a IO + type. + + Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of LROPoller that returns either DataProduct or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.operations.DataProductsOperations.begin_delete + name: begin_delete + summary: Delete data product resource. + signature: 'begin_delete(resource_group_name: str, data_product_name: str, **kwargs: + Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.operations.DataProductsOperations.begin_update + name: begin_update + summary: Update data product resource. + signature: 'begin_update(resource_group_name: str, data_product_name: str, properties: + _models.DataProductUpdate, *, content_type: str = ''application/json'', **kwargs: + Any) -> LROPoller[_models.DataProduct]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: properties + description: 'The resource properties to be updated. Is either a DataProductUpdate + type or + + a IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of LROPoller that returns either DataProduct or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.operations.DataProductsOperations.generate_storage_account_sas_token + name: generate_storage_account_sas_token + summary: Generate sas token for storage account. + signature: 'generate_storage_account_sas_token(resource_group_name: str, data_product_name: + str, body: _models.AccountSas, *, content_type: str = ''application/json'', **kwargs: + Any) -> _models.AccountSasToken' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: body + description: 'The content of the action request. Is either a AccountSas type or + a IO type. + + Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AccountSasToken or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.operations.DataProductsOperations.get + name: get + summary: Retrieve data product resource. + signature: 'get(resource_group_name: str, data_product_name: str, **kwargs: Any) + -> DataProduct' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DataProduct or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.operations.DataProductsOperations.list_by_resource_group + name: list_by_resource_group + summary: List data products by resource group. + signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[DataProduct]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either DataProduct or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.operations.DataProductsOperations.list_by_subscription + name: list_by_subscription + summary: List data products by subscription. + signature: 'list_by_subscription(**kwargs: Any) -> Iterable[DataProduct]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either DataProduct or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.operations.DataProductsOperations.list_roles_assignments + name: list_roles_assignments + summary: List user roles associated with the data product. + signature: 'list_roles_assignments(resource_group_name: str, data_product_name: + str, body: MutableMapping[str, Any], **kwargs: Any) -> ListRoleAssignments' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: body + description: The content of the action request. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ListRoleAssignments or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.operations.DataProductsOperations.remove_user_role + name: remove_user_role + summary: Remove role from the data product. + signature: 'remove_user_role(resource_group_name: str, data_product_name: str, body: + _models.RoleAssignmentDetail, *, content_type: str = ''application/json'', **kwargs: + Any) -> None' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: body + description: 'The content of the action request. Is either a RoleAssignmentDetail + type or a IO + + type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.operations.DataProductsOperations.rotate_key + name: rotate_key + summary: Initiate key rotation on Data Product. + signature: 'rotate_key(resource_group_name: str, data_product_name: str, body: _models.KeyVaultInfo, + *, content_type: str = ''application/json'', **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: body + description: 'The content of the action request. Is either a KeyVaultInfo type + or a IO type. + + Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.networkanalytics.operations.DataProductsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.operations.DataTypesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.operations.DataTypesOperations.yml new file mode 100644 index 00000000..59bd732b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.operations.DataTypesOperations.yml @@ -0,0 +1,387 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.operations.DataTypesOperations +name: DataTypesOperations +fullName: azure.mgmt.networkanalytics.operations.DataTypesOperations +module: azure.mgmt.networkanalytics.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: DataTypesOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.networkanalytics.operations.DataTypesOperations.begin_create + name: begin_create + summary: Create data type resource. + signature: 'begin_create(resource_group_name: str, data_product_name: str, data_type_name: + str, resource: _models.DataType, *, content_type: str = ''application/json'', + **kwargs: Any) -> LROPoller[_models.DataType]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: data_type_name + description: The data type name. Required. + isRequired: true + types: + - + - name: resource + description: Resource create parameters. Is either a DataType type or a IO type. + Required. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of LROPoller that returns either DataType or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.operations.DataTypesOperations.begin_delete + name: begin_delete + summary: Delete data type resource. + signature: 'begin_delete(resource_group_name: str, data_product_name: str, data_type_name: + str, **kwargs: Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: data_type_name + description: The data type name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.operations.DataTypesOperations.begin_delete_data + name: begin_delete_data + summary: Delete data for data type. + signature: 'begin_delete_data(resource_group_name: str, data_product_name: str, + data_type_name: str, body: MutableMapping[str, Any], **kwargs: Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: data_type_name + description: The data type name. Required. + isRequired: true + types: + - + - name: body + description: The content of the action request. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.operations.DataTypesOperations.begin_update + name: begin_update + summary: Update data type resource. + signature: 'begin_update(resource_group_name: str, data_product_name: str, data_type_name: + str, properties: _models.DataTypeUpdate, *, content_type: str = ''application/json'', + **kwargs: Any) -> LROPoller[_models.DataType]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: data_type_name + description: The data type name. Required. + isRequired: true + types: + - + - name: properties + description: 'The resource properties to be updated. Is either a DataTypeUpdate + type or a + + IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of LROPoller that returns either DataType or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.operations.DataTypesOperations.generate_storage_container_sas_token + name: generate_storage_container_sas_token + summary: Generate sas token for storage container. + signature: 'generate_storage_container_sas_token(resource_group_name: str, data_product_name: + str, data_type_name: str, body: _models.ContainerSaS, *, content_type: str = ''application/json'', + **kwargs: Any) -> _models.ContainerSasToken' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: data_type_name + description: The data type name. Required. + isRequired: true + types: + - + - name: body + description: 'The content of the action request. Is either a ContainerSaS type + or a IO type. + + Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ContainerSasToken or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.operations.DataTypesOperations.get + name: get + summary: Retrieve data type resource. + signature: 'get(resource_group_name: str, data_product_name: str, data_type_name: + str, **kwargs: Any) -> DataType' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + - name: data_type_name + description: The data type name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DataType or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.networkanalytics.operations.DataTypesOperations.list_by_data_product + name: list_by_data_product + summary: List data type by parent resource. + signature: 'list_by_data_product(resource_group_name: str, data_product_name: str, + **kwargs: Any) -> Iterable[DataType]' + parameters: + - name: resource_group_name + description: 'The name of the resource group. The name is case insensitive. + + Required.' + isRequired: true + types: + - + - name: data_product_name + description: The data product resource name. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either DataType or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.networkanalytics.operations.DataTypesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.operations.Operations.yml new file mode 100644 index 00000000..71f2cb05 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.operations.Operations.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.networkanalytics.operations.Operations +name: Operations +fullName: azure.mgmt.networkanalytics.operations.Operations +module: azure.mgmt.networkanalytics.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: Operations(*args, **kwargs) +methods: +- uid: azure.mgmt.networkanalytics.operations.Operations.list + name: list + summary: List the operations for the provider. + signature: 'list(**kwargs: Any) -> Iterable[Operation]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either Operation or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.networkanalytics.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.operations.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.operations.yml new file mode 100644 index 00000000..2f154bf8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.operations.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.networkanalytics.operations +name: operations +fullName: azure.mgmt.networkanalytics.operations +type: import +classes: +- azure.mgmt.networkanalytics.operations.DataProductsCatalogsOperations +- azure.mgmt.networkanalytics.operations.DataProductsOperations +- azure.mgmt.networkanalytics.operations.DataTypesOperations +- azure.mgmt.networkanalytics.operations.Operations diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.yml new file mode 100644 index 00000000..d4dc54ff --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.networkanalytics +name: networkanalytics +fullName: azure.mgmt.networkanalytics +type: rootImport +classes: +- azure.mgmt.networkanalytics.NetworkAnalyticsMgmtClient +packages: +- azure.mgmt.networkanalytics.aio +- azure.mgmt.networkanalytics.models +- azure.mgmt.networkanalytics.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.PowerBIEmbeddedManagementClient.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.PowerBIEmbeddedManagementClient.yml new file mode 100644 index 00000000..c62f1b34 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.PowerBIEmbeddedManagementClient.yml @@ -0,0 +1,57 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.PowerBIEmbeddedManagementClient +name: PowerBIEmbeddedManagementClient +fullName: azure.mgmt.powerbiembedded.PowerBIEmbeddedManagementClient +module: azure.mgmt.powerbiembedded +summary: Client to manage your Power BI Embedded workspace collections and retrieve + workspaces. +constructor: + syntax: 'PowerBIEmbeddedManagementClient(credential: TokenCredential, subscription_id: + str, base_url: str = ''https://management.azure.com'', **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. Required. + isRequired: true + types: + - + - name: subscription_id + description: 'Gets subscription credentials which uniquely identify a Microsoft + Azure + + subscription. The subscription ID forms part of the URI for every service call. + Required.' + isRequired: true + types: + - + - name: base_url + description: Service URL. Default value is "`https://management.azure.com`". + defaultValue: https://management.azure.com + types: + - + keywordOnlyParameters: + - name: api_version + description: 'Api Version. Default value is "2016-01-29". Note that overriding + this + + default value may result in unsupported behavior.' + types: + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - +variables: +- description: WorkspaceCollectionsOperations operations + name: workspace_collections + types: + - +- description: WorkspacesOperations operations + name: workspaces + types: + - +methods: +- uid: azure.mgmt.powerbiembedded.PowerBIEmbeddedManagementClient.close + name: close + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.PowerBIEmbeddedManagementClient.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.PowerBIEmbeddedManagementClient.yml new file mode 100644 index 00000000..5aa43dc1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.PowerBIEmbeddedManagementClient.yml @@ -0,0 +1,57 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.aio.PowerBIEmbeddedManagementClient +name: PowerBIEmbeddedManagementClient +fullName: azure.mgmt.powerbiembedded.aio.PowerBIEmbeddedManagementClient +module: azure.mgmt.powerbiembedded.aio +summary: Client to manage your Power BI Embedded workspace collections and retrieve + workspaces. +constructor: + syntax: 'PowerBIEmbeddedManagementClient(credential: AsyncTokenCredential, subscription_id: + str, base_url: str = ''https://management.azure.com'', **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. Required. + isRequired: true + types: + - + - name: subscription_id + description: 'Gets subscription credentials which uniquely identify a Microsoft + Azure + + subscription. The subscription ID forms part of the URI for every service call. + Required.' + isRequired: true + types: + - + - name: base_url + description: Service URL. Default value is "`https://management.azure.com`". + defaultValue: https://management.azure.com + types: + - + keywordOnlyParameters: + - name: api_version + description: 'Api Version. Default value is "2016-01-29". Note that overriding + this + + default value may result in unsupported behavior.' + types: + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - +variables: +- description: WorkspaceCollectionsOperations operations + name: workspace_collections + types: + - +- description: WorkspacesOperations operations + name: workspaces + types: + - +methods: +- uid: azure.mgmt.powerbiembedded.aio.PowerBIEmbeddedManagementClient.close + name: close + signature: async close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.operations.PowerBIEmbeddedManagementClientOperationsMixin.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.operations.PowerBIEmbeddedManagementClientOperationsMixin.yml new file mode 100644 index 00000000..7cacd4c0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.operations.PowerBIEmbeddedManagementClientOperationsMixin.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.aio.operations.PowerBIEmbeddedManagementClientOperationsMixin +name: PowerBIEmbeddedManagementClientOperationsMixin +fullName: azure.mgmt.powerbiembedded.aio.operations.PowerBIEmbeddedManagementClientOperationsMixin +module: azure.mgmt.powerbiembedded.aio.operations +constructor: + syntax: PowerBIEmbeddedManagementClientOperationsMixin() +methods: +- uid: azure.mgmt.powerbiembedded.aio.operations.PowerBIEmbeddedManagementClientOperationsMixin.get_available_operations + name: get_available_operations + summary: Indicates which operations can be performed by the Power BI Resource Provider. + signature: 'async get_available_operations(**kwargs: Any) -> OperationList' + return: + description: OperationList or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.operations.WorkspaceCollectionsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.operations.WorkspaceCollectionsOperations.yml new file mode 100644 index 00000000..13f1cd22 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.operations.WorkspaceCollectionsOperations.yml @@ -0,0 +1,274 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.aio.operations.WorkspaceCollectionsOperations +name: WorkspaceCollectionsOperations +fullName: azure.mgmt.powerbiembedded.aio.operations.WorkspaceCollectionsOperations +module: azure.mgmt.powerbiembedded.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: WorkspaceCollectionsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.powerbiembedded.aio.operations.WorkspaceCollectionsOperations.begin_delete + name: begin_delete + summary: Delete a Power BI Workspace Collection. + signature: 'async begin_delete(resource_group_name: str, workspace_collection_name: + str, **kwargs: Any) -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: Azure resource group. Required. + isRequired: true + types: + - + - name: workspace_collection_name + description: Power BI Embedded Workspace Collection name. Required. + isRequired: true + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.powerbiembedded.aio.operations.WorkspaceCollectionsOperations.check_name_availability + name: check_name_availability + summary: Verify the specified Power BI Workspace Collection name is valid and not + already in use. + signature: 'async check_name_availability(location: str, body: _models.CheckNameRequest, + *, content_type: str = ''application/json'', **kwargs: Any) -> _models.CheckNameResponse' + parameters: + - name: location + description: Azure location. Required. + isRequired: true + types: + - + - name: body + description: 'Check name availability request. Is either a CheckNameRequest type + or a IO[bytes] + + type. Required.' + isRequired: true + types: + - + - [] + return: + description: CheckNameResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.powerbiembedded.aio.operations.WorkspaceCollectionsOperations.create + name: create + summary: 'Creates a new Power BI Workspace Collection with the specified properties. + A Power BI Workspace + + Collection contains one or more workspaces, and can be used to provision keys + that provide API + + access to those workspaces.' + signature: 'async create(resource_group_name: str, workspace_collection_name: str, + body: _models.CreateWorkspaceCollectionRequest, *, content_type: str = ''application/json'', + **kwargs: Any) -> _models.WorkspaceCollection' + parameters: + - name: resource_group_name + description: Azure resource group. Required. + isRequired: true + types: + - + - name: workspace_collection_name + description: Power BI Embedded Workspace Collection name. Required. + isRequired: true + types: + - + - name: body + description: 'Create workspace collection request. Is either a CreateWorkspaceCollectionRequest + + type or a IO[bytes] type. Required.' + isRequired: true + types: + - + - [] + return: + description: WorkspaceCollection or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.powerbiembedded.aio.operations.WorkspaceCollectionsOperations.get_access_keys + name: get_access_keys + summary: 'Retrieves the primary and secondary access keys for the specified Power + BI Workspace + + Collection.' + signature: 'async get_access_keys(resource_group_name: str, workspace_collection_name: + str, **kwargs: Any) -> WorkspaceCollectionAccessKeys' + parameters: + - name: resource_group_name + description: Azure resource group. Required. + isRequired: true + types: + - + - name: workspace_collection_name + description: Power BI Embedded Workspace Collection name. Required. + isRequired: true + types: + - + return: + description: WorkspaceCollectionAccessKeys or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.powerbiembedded.aio.operations.WorkspaceCollectionsOperations.get_by_name + name: get_by_name + summary: Retrieves an existing Power BI Workspace Collection. + signature: 'async get_by_name(resource_group_name: str, workspace_collection_name: + str, **kwargs: Any) -> WorkspaceCollection' + parameters: + - name: resource_group_name + description: Azure resource group. Required. + isRequired: true + types: + - + - name: workspace_collection_name + description: Power BI Embedded Workspace Collection name. Required. + isRequired: true + types: + - + return: + description: WorkspaceCollection or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.powerbiembedded.aio.operations.WorkspaceCollectionsOperations.list_by_resource_group + name: list_by_resource_group + summary: Retrieves all existing Power BI workspace collections in the specified + resource group. + signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> AsyncIterable[WorkspaceCollection]' + parameters: + - name: resource_group_name + description: Azure resource group. Required. + isRequired: true + types: + - + return: + description: An iterator like instance of either WorkspaceCollection or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.powerbiembedded.aio.operations.WorkspaceCollectionsOperations.list_by_subscription + name: list_by_subscription + summary: Retrieves all existing Power BI workspace collections in the specified + subscription. + signature: 'list_by_subscription(**kwargs: Any) -> AsyncIterable[WorkspaceCollection]' + return: + description: An iterator like instance of either WorkspaceCollection or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.powerbiembedded.aio.operations.WorkspaceCollectionsOperations.migrate + name: migrate + summary: 'Migrates an existing Power BI Workspace Collection to a different resource + group and/or + + subscription.' + signature: 'async migrate(resource_group_name: str, body: _models.MigrateWorkspaceCollectionRequest, + *, content_type: str = ''application/json'', **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: Azure resource group. Required. + isRequired: true + types: + - + - name: body + description: 'Workspace migration request. Is either a MigrateWorkspaceCollectionRequest + type or + + a IO[bytes] type. Required.' + isRequired: true + types: + - + - [] + return: + description: None or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.powerbiembedded.aio.operations.WorkspaceCollectionsOperations.regenerate_key + name: regenerate_key + summary: 'Regenerates the primary or secondary access key for the specified Power + BI Workspace + + Collection.' + signature: 'async regenerate_key(resource_group_name: str, workspace_collection_name: + str, body: _models.WorkspaceCollectionAccessKey, *, content_type: str = ''application/json'', + **kwargs: Any) -> _models.WorkspaceCollectionAccessKeys' + parameters: + - name: resource_group_name + description: Azure resource group. Required. + isRequired: true + types: + - + - name: workspace_collection_name + description: Power BI Embedded Workspace Collection name. Required. + isRequired: true + types: + - + - name: body + description: 'Access key to regenerate. Is either a WorkspaceCollectionAccessKey + type or a + + IO[bytes] type. Required.' + isRequired: true + types: + - + - [] + return: + description: WorkspaceCollectionAccessKeys or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.powerbiembedded.aio.operations.WorkspaceCollectionsOperations.update + name: update + summary: Update an existing Power BI Workspace Collection with the specified properties. + signature: 'async update(resource_group_name: str, workspace_collection_name: str, + body: _models.UpdateWorkspaceCollectionRequest, *, content_type: str = ''application/json'', + **kwargs: Any) -> _models.WorkspaceCollection' + parameters: + - name: resource_group_name + description: Azure resource group. Required. + isRequired: true + types: + - + - name: workspace_collection_name + description: Power BI Embedded Workspace Collection name. Required. + isRequired: true + types: + - + - name: body + description: 'Update workspace collection request. Is either a UpdateWorkspaceCollectionRequest + + type or a IO[bytes] type. Required.' + isRequired: true + types: + - + - [] + return: + description: WorkspaceCollection or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.powerbiembedded.aio.operations.WorkspaceCollectionsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.operations.WorkspacesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.operations.WorkspacesOperations.yml new file mode 100644 index 00000000..979c10d0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.operations.WorkspacesOperations.yml @@ -0,0 +1,37 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.aio.operations.WorkspacesOperations +name: WorkspacesOperations +fullName: azure.mgmt.powerbiembedded.aio.operations.WorkspacesOperations +module: azure.mgmt.powerbiembedded.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: WorkspacesOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.powerbiembedded.aio.operations.WorkspacesOperations.list + name: list + summary: Retrieves all existing Power BI workspaces in the specified workspace collection. + signature: 'list(resource_group_name: str, workspace_collection_name: str, **kwargs: + Any) -> AsyncIterable[Workspace]' + parameters: + - name: resource_group_name + description: Azure resource group. Required. + isRequired: true + types: + - + - name: workspace_collection_name + description: Power BI Embedded Workspace Collection name. Required. + isRequired: true + types: + - + return: + description: An iterator like instance of either Workspace or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.powerbiembedded.aio.operations.WorkspacesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.operations.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.operations.yml new file mode 100644 index 00000000..cc98a009 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.operations.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.powerbiembedded.aio.operations +name: operations +fullName: azure.mgmt.powerbiembedded.aio.operations +type: import +classes: +- azure.mgmt.powerbiembedded.aio.operations.PowerBIEmbeddedManagementClientOperationsMixin +- azure.mgmt.powerbiembedded.aio.operations.WorkspaceCollectionsOperations +- azure.mgmt.powerbiembedded.aio.operations.WorkspacesOperations diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.yml new file mode 100644 index 00000000..4998fb8b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.aio.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.powerbiembedded.aio +name: aio +fullName: azure.mgmt.powerbiembedded.aio +type: import +classes: +- azure.mgmt.powerbiembedded.aio.PowerBIEmbeddedManagementClient +packages: +- azure.mgmt.powerbiembedded.aio.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.AccessKeyName.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.AccessKeyName.yml new file mode 100644 index 00000000..3c1b371a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.AccessKeyName.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.powerbiembedded.models.AccessKeyName +name: AccessKeyName +fullName: azure.mgmt.powerbiembedded.models.AccessKeyName +summary: Key name. +module: azure.mgmt.powerbiembedded.models +fields: +- name: KEY1 + uid: azure.mgmt.powerbiembedded.models.AccessKeyName.KEY1 +- name: KEY2 + uid: azure.mgmt.powerbiembedded.models.AccessKeyName.KEY2 diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.AzureSku.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.AzureSku.yml new file mode 100644 index 00000000..fbc80528 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.AzureSku.yml @@ -0,0 +1,34 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.models.AzureSku +name: AzureSku +fullName: azure.mgmt.powerbiembedded.models.AzureSku +module: azure.mgmt.powerbiembedded.models +summary: 'AzureSku. + + + All required parameters must be populated in order to send to server.' +constructor: + syntax: 'AzureSku(*, name: str | _models.AzureSkuName, tier: str | _models.AzureSkuTier, + **kwargs: Any)' + keywordOnlyParameters: + - name: name + description: SKU name. Required. "S1" + types: + - + - + - name: tier + description: SKU tier. Required. "Standard" + types: + - + - +variables: +- description: SKU name. Required. "S1" + name: name + types: + - + - +- description: SKU tier. Required. "Standard" + name: tier + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.AzureSkuName.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.AzureSkuName.yml new file mode 100644 index 00000000..74db5cba --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.AzureSkuName.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.powerbiembedded.models.AzureSkuName +name: AzureSkuName +fullName: azure.mgmt.powerbiembedded.models.AzureSkuName +summary: SKU name. +module: azure.mgmt.powerbiembedded.models +fields: +- name: S1 + uid: azure.mgmt.powerbiembedded.models.AzureSkuName.S1 diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.AzureSkuTier.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.AzureSkuTier.yml new file mode 100644 index 00000000..1b7cce26 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.AzureSkuTier.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.powerbiembedded.models.AzureSkuTier +name: AzureSkuTier +fullName: azure.mgmt.powerbiembedded.models.AzureSkuTier +summary: SKU tier. +module: azure.mgmt.powerbiembedded.models +fields: +- name: STANDARD + uid: azure.mgmt.powerbiembedded.models.AzureSkuTier.STANDARD diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CheckNameReason.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CheckNameReason.yml new file mode 100644 index 00000000..4d1a15ec --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CheckNameReason.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.powerbiembedded.models.CheckNameReason +name: CheckNameReason +fullName: azure.mgmt.powerbiembedded.models.CheckNameReason +summary: Reason why the workspace collection name cannot be used. +module: azure.mgmt.powerbiembedded.models +fields: +- name: INVALID + uid: azure.mgmt.powerbiembedded.models.CheckNameReason.INVALID +- name: UNAVAILABLE + uid: azure.mgmt.powerbiembedded.models.CheckNameReason.UNAVAILABLE diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CheckNameRequest.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CheckNameRequest.yml new file mode 100644 index 00000000..21dc07ac --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CheckNameRequest.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.models.CheckNameRequest +name: CheckNameRequest +fullName: azure.mgmt.powerbiembedded.models.CheckNameRequest +module: azure.mgmt.powerbiembedded.models +summary: CheckNameRequest. +constructor: + syntax: 'CheckNameRequest(*, name: str | None = None, type: str = ''Microsoft.PowerBI/workspaceCollections'', + **kwargs: Any)' + keywordOnlyParameters: + - name: name + description: Workspace collection name. + types: + - + - name: type + description: Resource type. + defaultValue: Microsoft.PowerBI/workspaceCollections + types: + - +variables: +- description: Workspace collection name. + name: name + types: + - +- description: Resource type. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CheckNameResponse.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CheckNameResponse.yml new file mode 100644 index 00000000..3f5e0175 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CheckNameResponse.yml @@ -0,0 +1,54 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.models.CheckNameResponse +name: CheckNameResponse +fullName: azure.mgmt.powerbiembedded.models.CheckNameResponse +module: azure.mgmt.powerbiembedded.models +summary: CheckNameResponse. +constructor: + syntax: 'CheckNameResponse(*, name_available: bool | None = None, reason: str | + _models.CheckNameReason | None = None, message: str | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: name_available + description: 'Specifies a Boolean value that indicates whether the specified Power + + BI Workspace Collection name is available to use.' + types: + - + - name: reason + description: 'Reason why the workspace collection name cannot be used. Known values + are: + + "Unavailable" and "Invalid".' + types: + - + - + - name: message + description: 'Message indicating an unavailable name due to a conflict, or a description + of + + the naming rules that are violated.' + types: + - +variables: +- description: 'Specifies a Boolean value that indicates whether the specified Power + BI + + Workspace Collection name is available to use.' + name: name_available + types: + - +- description: 'Reason why the workspace collection name cannot be used. Known values + are: + + "Unavailable" and "Invalid".' + name: reason + types: + - + - +- description: 'Message indicating an unavailable name due to a conflict, or a description + of + + the naming rules that are violated.' + name: message + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CreateWorkspaceCollectionRequest.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CreateWorkspaceCollectionRequest.yml new file mode 100644 index 00000000..dc280308 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CreateWorkspaceCollectionRequest.yml @@ -0,0 +1,33 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.models.CreateWorkspaceCollectionRequest +name: CreateWorkspaceCollectionRequest +fullName: azure.mgmt.powerbiembedded.models.CreateWorkspaceCollectionRequest +module: azure.mgmt.powerbiembedded.models +summary: CreateWorkspaceCollectionRequest. +constructor: + syntax: 'CreateWorkspaceCollectionRequest(*, location: str | None = None, tags: + Dict[str, str] | None = None, sku: _models.AzureSku | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: location + description: Azure location. + types: + - + - name: tags + description: Dictionary of ``. + types: + - [, ] + - name: sku + types: + - +variables: +- description: Azure location. + name: location + types: + - +- description: Dictionary of ``. + name: tags + types: + - [, ] +- name: sku + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Display.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Display.yml new file mode 100644 index 00000000..f6b97225 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Display.yml @@ -0,0 +1,104 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.models.Display +name: Display +fullName: azure.mgmt.powerbiembedded.models.Display +module: azure.mgmt.powerbiembedded.models +summary: Display. +constructor: + syntax: 'Display(*, provider: str | None = None, resource: str | None = None, operation: + str | None = None, description: str | None = None, origin: str | None = None, + **kwargs: Any)' + keywordOnlyParameters: + - name: provider + description: 'The localized friendly form of the resource provider name. This + form is also + + expected to include the publisher/company responsible. Use Title Casing. Begin + with "Microsoft" + + for 1st party services.' + types: + - + - name: resource + description: 'The localized friendly form of the resource type related to this + + action/operation. This form should match the public documentation for the resource + provider. + + Use Title Casing. For examples, refer to the "name" section.' + types: + - + - name: operation + description: 'The localized friendly name for the operation as shown to the user. + This + + name should be concise (to fit in drop downs), but clear (self-documenting). + Use Title Casing + + and include the entity/resource to which it applies.' + types: + - + - name: description + description: 'The localized friendly description for the operation as shown to + the + + user. This description should be thorough, yet concise. It will be used in tool-tips + and + + detailed views.' + types: + - + - name: origin + description: 'The intended executor of the operation; governs the display of the + operation + + in the RBAC UX and the audit logs UX. Default value is ''user,system''.' + types: + - +variables: +- description: 'The localized friendly form of the resource provider name. This form + is also + + expected to include the publisher/company responsible. Use Title Casing. Begin + with "Microsoft" + + for 1st party services.' + name: provider + types: + - +- description: 'The localized friendly form of the resource type related to this + + action/operation. This form should match the public documentation for the resource + provider. + + Use Title Casing. For examples, refer to the "name" section.' + name: resource + types: + - +- description: 'The localized friendly name for the operation as shown to the user. + This name + + should be concise (to fit in drop downs), but clear (self-documenting). Use Title + Casing and + + include the entity/resource to which it applies.' + name: operation + types: + - +- description: 'The localized friendly description for the operation as shown to the + user. + + This description should be thorough, yet concise. It will be used in tool-tips + and detailed + + views.' + name: description + types: + - +- description: 'The intended executor of the operation; governs the display of the + operation in + + the RBAC UX and the audit logs UX. Default value is ''user,system''.' + name: origin + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Error.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Error.yml new file mode 100644 index 00000000..80510021 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Error.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.models.Error +name: Error +fullName: azure.mgmt.powerbiembedded.models.Error +module: azure.mgmt.powerbiembedded.models +summary: Error. +constructor: + syntax: 'Error(*, code: str | None = None, message: str | None = None, target: str + | None = None, details: List[_models.ErrorDetail] | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: code + types: + - + - name: message + types: + - + - name: target + types: + - + - name: details + types: + - [] +variables: +- name: code + types: + - +- name: message + types: + - +- name: target + types: + - +- name: details + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.ErrorDetail.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.ErrorDetail.yml new file mode 100644 index 00000000..5481d2e1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.ErrorDetail.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.models.ErrorDetail +name: ErrorDetail +fullName: azure.mgmt.powerbiembedded.models.ErrorDetail +module: azure.mgmt.powerbiembedded.models +summary: ErrorDetail. +constructor: + syntax: 'ErrorDetail(*, code: str | None = None, message: str | None = None, target: + str | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: code + types: + - + - name: message + types: + - + - name: target + types: + - +variables: +- name: code + types: + - +- name: message + types: + - +- name: target + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.MigrateWorkspaceCollectionRequest.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.MigrateWorkspaceCollectionRequest.yml new file mode 100644 index 00000000..f4fa3483 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.MigrateWorkspaceCollectionRequest.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.models.MigrateWorkspaceCollectionRequest +name: MigrateWorkspaceCollectionRequest +fullName: azure.mgmt.powerbiembedded.models.MigrateWorkspaceCollectionRequest +module: azure.mgmt.powerbiembedded.models +summary: MigrateWorkspaceCollectionRequest. +constructor: + syntax: 'MigrateWorkspaceCollectionRequest(*, target_resource_group: str | None + = None, resources: List[str] | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: target_resource_group + description: 'Name of the resource group the Power BI workspace collections + + will be migrated to.' + types: + - + - name: resources + types: + - [] +variables: +- description: 'Name of the resource group the Power BI workspace collections will + + be migrated to.' + name: target_resource_group + types: + - +- name: resources + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Operation.yml new file mode 100644 index 00000000..157d101f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Operation.yml @@ -0,0 +1,31 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.models.Operation +name: Operation +fullName: azure.mgmt.powerbiembedded.models.Operation +module: azure.mgmt.powerbiembedded.models +summary: Operation. +constructor: + syntax: 'Operation(*, name: str | None = None, display: _models.Display | None = + None, **kwargs: Any)' + keywordOnlyParameters: + - name: name + description: 'The name of the operation being performed on this particular object. + This name + + should match the action name that appears in RBAC / the event service.' + types: + - + - name: display + types: + - +variables: +- description: 'The name of the operation being performed on this particular object. + This name + + should match the action name that appears in RBAC / the event service.' + name: name + types: + - +- name: display + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.OperationList.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.OperationList.yml new file mode 100644 index 00000000..c89cfca4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.OperationList.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.models.OperationList +name: OperationList +fullName: azure.mgmt.powerbiembedded.models.OperationList +module: azure.mgmt.powerbiembedded.models +summary: OperationList. +constructor: + syntax: 'OperationList(*, value: List[_models.Operation] | None = None, **kwargs: + Any)' + keywordOnlyParameters: + - name: value + types: + - [] +variables: +- name: value + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.UpdateWorkspaceCollectionRequest.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.UpdateWorkspaceCollectionRequest.yml new file mode 100644 index 00000000..baa793e2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.UpdateWorkspaceCollectionRequest.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.models.UpdateWorkspaceCollectionRequest +name: UpdateWorkspaceCollectionRequest +fullName: azure.mgmt.powerbiembedded.models.UpdateWorkspaceCollectionRequest +module: azure.mgmt.powerbiembedded.models +summary: UpdateWorkspaceCollectionRequest. +constructor: + syntax: 'UpdateWorkspaceCollectionRequest(*, tags: Dict[str, str] | None = None, + sku: _models.AzureSku | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: tags + description: Dictionary of ``. + types: + - [, ] + - name: sku + types: + - +variables: +- description: Dictionary of ``. + name: tags + types: + - [, ] +- name: sku + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Workspace.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Workspace.yml new file mode 100644 index 00000000..78dfb759 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Workspace.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.models.Workspace +name: Workspace +fullName: azure.mgmt.powerbiembedded.models.Workspace +module: azure.mgmt.powerbiembedded.models +summary: Workspace. +constructor: + syntax: 'Workspace(*, id: str | None = None, name: str | None = None, type: str + | None = None, properties: MutableMapping[str, Any] | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: id + description: Workspace id. + types: + - + - name: name + description: Workspace name. + types: + - + - name: type + description: Resource type. + types: + - + - name: properties + description: Property bag. + types: + - +variables: +- description: Workspace id. + name: id + types: + - +- description: Workspace name. + name: name + types: + - +- description: Resource type. + name: type + types: + - +- description: Property bag. + name: properties + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollection.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollection.yml new file mode 100644 index 00000000..071d2dd3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollection.yml @@ -0,0 +1,67 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.models.WorkspaceCollection +name: WorkspaceCollection +fullName: azure.mgmt.powerbiembedded.models.WorkspaceCollection +module: azure.mgmt.powerbiembedded.models +summary: WorkspaceCollection. +constructor: + syntax: 'WorkspaceCollection(*, id: str | None = None, name: str | None = None, + type: str | None = None, location: str | None = None, tags: Dict[str, str] | None + = None, sku: _models.AzureSku | None = None, properties: MutableMapping[str, Any] + | None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: id + description: Resource id. + types: + - + - name: name + description: Workspace collection name. + types: + - + - name: type + description: Resource type. + types: + - + - name: location + description: Azure location. + types: + - + - name: tags + description: Dictionary of ``. + types: + - [, ] + - name: sku + types: + - + - name: properties + description: Properties. + types: + - +variables: +- description: Resource id. + name: id + types: + - +- description: Workspace collection name. + name: name + types: + - +- description: Resource type. + name: type + types: + - +- description: Azure location. + name: location + types: + - +- description: Dictionary of ``. + name: tags + types: + - [, ] +- name: sku + types: + - +- description: Properties. + name: properties + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKey.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKey.yml new file mode 100644 index 00000000..103f1e0d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKey.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKey +name: WorkspaceCollectionAccessKey +fullName: azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKey +module: azure.mgmt.powerbiembedded.models +summary: WorkspaceCollectionAccessKey. +constructor: + syntax: 'WorkspaceCollectionAccessKey(*, key_name: str | _models.AccessKeyName | + None = None, **kwargs: Any)' + keywordOnlyParameters: + - name: key_name + description: 'Key name. Known values are: "key1" and "key2".' + types: + - + - +variables: +- description: 'Key name. Known values are: "key1" and "key2".' + name: key_name + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKeys.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKeys.yml new file mode 100644 index 00000000..c8ffd33c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKeys.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKeys +name: WorkspaceCollectionAccessKeys +fullName: azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKeys +module: azure.mgmt.powerbiembedded.models +summary: WorkspaceCollectionAccessKeys. +constructor: + syntax: 'WorkspaceCollectionAccessKeys(*, key1: str | None = None, key2: str | None + = None, **kwargs: Any)' + keywordOnlyParameters: + - name: key1 + description: Access key 1. + types: + - + - name: key2 + description: Access key 2. + types: + - +variables: +- description: Access key 1. + name: key1 + types: + - +- description: Access key 2. + name: key2 + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionList.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionList.yml new file mode 100644 index 00000000..d5d541c6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionList.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.models.WorkspaceCollectionList +name: WorkspaceCollectionList +fullName: azure.mgmt.powerbiembedded.models.WorkspaceCollectionList +module: azure.mgmt.powerbiembedded.models +summary: WorkspaceCollectionList. +constructor: + syntax: 'WorkspaceCollectionList(*, value: List[_models.WorkspaceCollection] | None + = None, **kwargs: Any)' + keywordOnlyParameters: + - name: value + types: + - [] +variables: +- name: value + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceList.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceList.yml new file mode 100644 index 00000000..6e127e85 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceList.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.models.WorkspaceList +name: WorkspaceList +fullName: azure.mgmt.powerbiembedded.models.WorkspaceList +module: azure.mgmt.powerbiembedded.models +summary: WorkspaceList. +constructor: + syntax: 'WorkspaceList(*, value: List[_models.Workspace] | None = None, **kwargs: + Any)' + keywordOnlyParameters: + - name: value + types: + - [] +variables: +- name: value + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.yml new file mode 100644 index 00000000..29489b91 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.powerbiembedded.models +name: models +fullName: azure.mgmt.powerbiembedded.models +type: import +classes: +- azure.mgmt.powerbiembedded.models.AzureSku +- azure.mgmt.powerbiembedded.models.CheckNameRequest +- azure.mgmt.powerbiembedded.models.CheckNameResponse +- azure.mgmt.powerbiembedded.models.CreateWorkspaceCollectionRequest +- azure.mgmt.powerbiembedded.models.Display +- azure.mgmt.powerbiembedded.models.Error +- azure.mgmt.powerbiembedded.models.ErrorDetail +- azure.mgmt.powerbiembedded.models.MigrateWorkspaceCollectionRequest +- azure.mgmt.powerbiembedded.models.Operation +- azure.mgmt.powerbiembedded.models.OperationList +- azure.mgmt.powerbiembedded.models.UpdateWorkspaceCollectionRequest +- azure.mgmt.powerbiembedded.models.Workspace +- azure.mgmt.powerbiembedded.models.WorkspaceCollection +- azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKey +- azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKeys +- azure.mgmt.powerbiembedded.models.WorkspaceCollectionList +- azure.mgmt.powerbiembedded.models.WorkspaceList +enums: +- azure.mgmt.powerbiembedded.models.AccessKeyName +- azure.mgmt.powerbiembedded.models.AzureSkuName +- azure.mgmt.powerbiembedded.models.AzureSkuTier +- azure.mgmt.powerbiembedded.models.CheckNameReason diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.operations.PowerBIEmbeddedManagementClientOperationsMixin.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.operations.PowerBIEmbeddedManagementClientOperationsMixin.yml new file mode 100644 index 00000000..28303d73 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.operations.PowerBIEmbeddedManagementClientOperationsMixin.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.operations.PowerBIEmbeddedManagementClientOperationsMixin +name: PowerBIEmbeddedManagementClientOperationsMixin +fullName: azure.mgmt.powerbiembedded.operations.PowerBIEmbeddedManagementClientOperationsMixin +module: azure.mgmt.powerbiembedded.operations +constructor: + syntax: PowerBIEmbeddedManagementClientOperationsMixin() +methods: +- uid: azure.mgmt.powerbiembedded.operations.PowerBIEmbeddedManagementClientOperationsMixin.get_available_operations + name: get_available_operations + summary: Indicates which operations can be performed by the Power BI Resource Provider. + signature: 'get_available_operations(**kwargs: Any) -> OperationList' + return: + description: OperationList or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.operations.WorkspaceCollectionsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.operations.WorkspaceCollectionsOperations.yml new file mode 100644 index 00000000..1358965d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.operations.WorkspaceCollectionsOperations.yml @@ -0,0 +1,274 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.operations.WorkspaceCollectionsOperations +name: WorkspaceCollectionsOperations +fullName: azure.mgmt.powerbiembedded.operations.WorkspaceCollectionsOperations +module: azure.mgmt.powerbiembedded.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: WorkspaceCollectionsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.powerbiembedded.operations.WorkspaceCollectionsOperations.begin_delete + name: begin_delete + summary: Delete a Power BI Workspace Collection. + signature: 'begin_delete(resource_group_name: str, workspace_collection_name: str, + **kwargs: Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: Azure resource group. Required. + isRequired: true + types: + - + - name: workspace_collection_name + description: Power BI Embedded Workspace Collection name. Required. + isRequired: true + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.powerbiembedded.operations.WorkspaceCollectionsOperations.check_name_availability + name: check_name_availability + summary: Verify the specified Power BI Workspace Collection name is valid and not + already in use. + signature: 'check_name_availability(location: str, body: _models.CheckNameRequest, + *, content_type: str = ''application/json'', **kwargs: Any) -> _models.CheckNameResponse' + parameters: + - name: location + description: Azure location. Required. + isRequired: true + types: + - + - name: body + description: 'Check name availability request. Is either a CheckNameRequest type + or a IO[bytes] + + type. Required.' + isRequired: true + types: + - + - [] + return: + description: CheckNameResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.powerbiembedded.operations.WorkspaceCollectionsOperations.create + name: create + summary: 'Creates a new Power BI Workspace Collection with the specified properties. + A Power BI Workspace + + Collection contains one or more workspaces, and can be used to provision keys + that provide API + + access to those workspaces.' + signature: 'create(resource_group_name: str, workspace_collection_name: str, body: + _models.CreateWorkspaceCollectionRequest, *, content_type: str = ''application/json'', + **kwargs: Any) -> _models.WorkspaceCollection' + parameters: + - name: resource_group_name + description: Azure resource group. Required. + isRequired: true + types: + - + - name: workspace_collection_name + description: Power BI Embedded Workspace Collection name. Required. + isRequired: true + types: + - + - name: body + description: 'Create workspace collection request. Is either a CreateWorkspaceCollectionRequest + + type or a IO[bytes] type. Required.' + isRequired: true + types: + - + - [] + return: + description: WorkspaceCollection or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.powerbiembedded.operations.WorkspaceCollectionsOperations.get_access_keys + name: get_access_keys + summary: 'Retrieves the primary and secondary access keys for the specified Power + BI Workspace + + Collection.' + signature: 'get_access_keys(resource_group_name: str, workspace_collection_name: + str, **kwargs: Any) -> WorkspaceCollectionAccessKeys' + parameters: + - name: resource_group_name + description: Azure resource group. Required. + isRequired: true + types: + - + - name: workspace_collection_name + description: Power BI Embedded Workspace Collection name. Required. + isRequired: true + types: + - + return: + description: WorkspaceCollectionAccessKeys or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.powerbiembedded.operations.WorkspaceCollectionsOperations.get_by_name + name: get_by_name + summary: Retrieves an existing Power BI Workspace Collection. + signature: 'get_by_name(resource_group_name: str, workspace_collection_name: str, + **kwargs: Any) -> WorkspaceCollection' + parameters: + - name: resource_group_name + description: Azure resource group. Required. + isRequired: true + types: + - + - name: workspace_collection_name + description: Power BI Embedded Workspace Collection name. Required. + isRequired: true + types: + - + return: + description: WorkspaceCollection or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.powerbiembedded.operations.WorkspaceCollectionsOperations.list_by_resource_group + name: list_by_resource_group + summary: Retrieves all existing Power BI workspace collections in the specified + resource group. + signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[WorkspaceCollection]' + parameters: + - name: resource_group_name + description: Azure resource group. Required. + isRequired: true + types: + - + return: + description: An iterator like instance of either WorkspaceCollection or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.powerbiembedded.operations.WorkspaceCollectionsOperations.list_by_subscription + name: list_by_subscription + summary: Retrieves all existing Power BI workspace collections in the specified + subscription. + signature: 'list_by_subscription(**kwargs: Any) -> Iterable[WorkspaceCollection]' + return: + description: An iterator like instance of either WorkspaceCollection or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.powerbiembedded.operations.WorkspaceCollectionsOperations.migrate + name: migrate + summary: 'Migrates an existing Power BI Workspace Collection to a different resource + group and/or + + subscription.' + signature: 'migrate(resource_group_name: str, body: _models.MigrateWorkspaceCollectionRequest, + *, content_type: str = ''application/json'', **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: Azure resource group. Required. + isRequired: true + types: + - + - name: body + description: 'Workspace migration request. Is either a MigrateWorkspaceCollectionRequest + type or + + a IO[bytes] type. Required.' + isRequired: true + types: + - + - [] + return: + description: None or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.powerbiembedded.operations.WorkspaceCollectionsOperations.regenerate_key + name: regenerate_key + summary: 'Regenerates the primary or secondary access key for the specified Power + BI Workspace + + Collection.' + signature: 'regenerate_key(resource_group_name: str, workspace_collection_name: + str, body: _models.WorkspaceCollectionAccessKey, *, content_type: str = ''application/json'', + **kwargs: Any) -> _models.WorkspaceCollectionAccessKeys' + parameters: + - name: resource_group_name + description: Azure resource group. Required. + isRequired: true + types: + - + - name: workspace_collection_name + description: Power BI Embedded Workspace Collection name. Required. + isRequired: true + types: + - + - name: body + description: 'Access key to regenerate. Is either a WorkspaceCollectionAccessKey + type or a + + IO[bytes] type. Required.' + isRequired: true + types: + - + - [] + return: + description: WorkspaceCollectionAccessKeys or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.powerbiembedded.operations.WorkspaceCollectionsOperations.update + name: update + summary: Update an existing Power BI Workspace Collection with the specified properties. + signature: 'update(resource_group_name: str, workspace_collection_name: str, body: + _models.UpdateWorkspaceCollectionRequest, *, content_type: str = ''application/json'', + **kwargs: Any) -> _models.WorkspaceCollection' + parameters: + - name: resource_group_name + description: Azure resource group. Required. + isRequired: true + types: + - + - name: workspace_collection_name + description: Power BI Embedded Workspace Collection name. Required. + isRequired: true + types: + - + - name: body + description: 'Update workspace collection request. Is either a UpdateWorkspaceCollectionRequest + + type or a IO[bytes] type. Required.' + isRequired: true + types: + - + - [] + return: + description: WorkspaceCollection or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.powerbiembedded.operations.WorkspaceCollectionsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.operations.WorkspacesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.operations.WorkspacesOperations.yml new file mode 100644 index 00000000..e4590ba1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.operations.WorkspacesOperations.yml @@ -0,0 +1,37 @@ +### YamlMime:PythonClass +uid: azure.mgmt.powerbiembedded.operations.WorkspacesOperations +name: WorkspacesOperations +fullName: azure.mgmt.powerbiembedded.operations.WorkspacesOperations +module: azure.mgmt.powerbiembedded.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: WorkspacesOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.powerbiembedded.operations.WorkspacesOperations.list + name: list + summary: Retrieves all existing Power BI workspaces in the specified workspace collection. + signature: 'list(resource_group_name: str, workspace_collection_name: str, **kwargs: + Any) -> Iterable[Workspace]' + parameters: + - name: resource_group_name + description: Azure resource group. Required. + isRequired: true + types: + - + - name: workspace_collection_name + description: Power BI Embedded Workspace Collection name. Required. + isRequired: true + types: + - + return: + description: An iterator like instance of either Workspace or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.powerbiembedded.operations.WorkspacesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.operations.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.operations.yml new file mode 100644 index 00000000..26ada8c9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.operations.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.powerbiembedded.operations +name: operations +fullName: azure.mgmt.powerbiembedded.operations +type: import +classes: +- azure.mgmt.powerbiembedded.operations.PowerBIEmbeddedManagementClientOperationsMixin +- azure.mgmt.powerbiembedded.operations.WorkspaceCollectionsOperations +- azure.mgmt.powerbiembedded.operations.WorkspacesOperations diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.yml new file mode 100644 index 00000000..6717c3ae --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.powerbiembedded +name: powerbiembedded +fullName: azure.mgmt.powerbiembedded +type: rootImport +classes: +- azure.mgmt.powerbiembedded.PowerBIEmbeddedManagementClient +packages: +- azure.mgmt.powerbiembedded.aio +- azure.mgmt.powerbiembedded.models +- azure.mgmt.powerbiembedded.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.SchedulerManagementClient.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.SchedulerManagementClient.yml new file mode 100644 index 00000000..5ad4bd74 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.SchedulerManagementClient.yml @@ -0,0 +1,44 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.SchedulerManagementClient +name: SchedulerManagementClient +fullName: azure.mgmt.scheduler.SchedulerManagementClient +module: azure.mgmt.scheduler +summary: SchedulerManagementClient. +constructor: + syntax: 'SchedulerManagementClient(credential: ''TokenCredential'', subscription_id: + str, base_url: str | None = None, **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: subscription_id + description: The subscription id. + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - + keywordOnlyParameters: + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - +variables: +- description: JobCollectionsOperations operations + name: job_collections + types: + - +- description: JobsOperations operations + name: jobs + types: + - +methods: +- uid: azure.mgmt.scheduler.SchedulerManagementClient.close + name: close + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.aio.SchedulerManagementClient.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.aio.SchedulerManagementClient.yml new file mode 100644 index 00000000..965f266b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.aio.SchedulerManagementClient.yml @@ -0,0 +1,44 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.aio.SchedulerManagementClient +name: SchedulerManagementClient +fullName: azure.mgmt.scheduler.aio.SchedulerManagementClient +module: azure.mgmt.scheduler.aio +summary: SchedulerManagementClient. +constructor: + syntax: 'SchedulerManagementClient(credential: AsyncTokenCredential, subscription_id: + str, base_url: str | None = None, **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: subscription_id + description: The subscription id. + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - + keywordOnlyParameters: + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - +variables: +- description: JobCollectionsOperations operations + name: job_collections + types: + - +- description: JobsOperations operations + name: jobs + types: + - +methods: +- uid: azure.mgmt.scheduler.aio.SchedulerManagementClient.close + name: close + signature: async close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.aio.operations.JobCollectionsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.aio.operations.JobCollectionsOperations.yml new file mode 100644 index 00000000..a9c13cff --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.aio.operations.JobCollectionsOperations.yml @@ -0,0 +1,296 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.aio.operations.JobCollectionsOperations +name: JobCollectionsOperations +fullName: azure.mgmt.scheduler.aio.operations.JobCollectionsOperations +module: azure.mgmt.scheduler.aio.operations +summary: 'JobCollectionsOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: JobCollectionsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.scheduler.aio.operations.JobCollectionsOperations.begin_delete + name: begin_delete + summary: Deletes a job collection. + signature: 'async begin_delete(resource_group_name: str, job_collection_name: str, + **kwargs) -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.aio.operations.JobCollectionsOperations.begin_disable + name: begin_disable + summary: Disables all of the jobs in the job collection. + signature: 'async begin_disable(resource_group_name: str, job_collection_name: str, + **kwargs) -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.aio.operations.JobCollectionsOperations.begin_enable + name: begin_enable + summary: Enables all of the jobs in the job collection. + signature: 'async begin_enable(resource_group_name: str, job_collection_name: str, + **kwargs) -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.aio.operations.JobCollectionsOperations.create_or_update + name: create_or_update + summary: Provisions a new job collection or updates an existing job collection. + signature: 'async create_or_update(resource_group_name: str, job_collection_name: + str, job_collection: JobCollectionDefinition, **kwargs) -> JobCollectionDefinition' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + - name: job_collection + description: The job collection definition. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: JobCollectionDefinition, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.aio.operations.JobCollectionsOperations.get + name: get + summary: Gets a job collection. + signature: 'async get(resource_group_name: str, job_collection_name: str, **kwargs) + -> JobCollectionDefinition' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: JobCollectionDefinition, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.aio.operations.JobCollectionsOperations.list_by_resource_group + name: list_by_resource_group + summary: Gets all job collections under specified resource group. + signature: 'list_by_resource_group(resource_group_name: str, **kwargs) -> AsyncIterable[JobCollectionListResult]' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either JobCollectionListResult or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.aio.operations.JobCollectionsOperations.list_by_subscription + name: list_by_subscription + summary: Gets all job collections under specified subscription. + signature: list_by_subscription(**kwargs) -> AsyncIterable[JobCollectionListResult] + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either JobCollectionListResult or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.aio.operations.JobCollectionsOperations.patch + name: patch + summary: Patches an existing job collection. + signature: 'async patch(resource_group_name: str, job_collection_name: str, job_collection: + JobCollectionDefinition, **kwargs) -> JobCollectionDefinition' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + - name: job_collection + description: The job collection definition. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: JobCollectionDefinition, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.scheduler.aio.operations.JobCollectionsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.aio.operations.JobsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.aio.operations.JobsOperations.yml new file mode 100644 index 00000000..29fd1471 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.aio.operations.JobsOperations.yml @@ -0,0 +1,304 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.aio.operations.JobsOperations +name: JobsOperations +fullName: azure.mgmt.scheduler.aio.operations.JobsOperations +module: azure.mgmt.scheduler.aio.operations +summary: 'JobsOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: JobsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.scheduler.aio.operations.JobsOperations.create_or_update + name: create_or_update + summary: Provisions a new job or updates an existing job. + signature: 'async create_or_update(resource_group_name: str, job_collection_name: + str, job_name: str, job: JobDefinition, **kwargs) -> JobDefinition' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + - name: job_name + description: The job name. + isRequired: true + types: + - + - name: job + description: The job definition. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: JobDefinition, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.aio.operations.JobsOperations.delete + name: delete + summary: Deletes a job. + signature: 'async delete(resource_group_name: str, job_collection_name: str, job_name: + str, **kwargs) -> None' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + - name: job_name + description: The job name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.aio.operations.JobsOperations.get + name: get + summary: Gets a job. + signature: 'async get(resource_group_name: str, job_collection_name: str, job_name: + str, **kwargs) -> JobDefinition' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + - name: job_name + description: The job name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: JobDefinition, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.aio.operations.JobsOperations.list + name: list + summary: Lists all jobs under the specified job collection. + signature: 'list(resource_group_name: str, job_collection_name: str, top: int | + None = None, skip: int | None = None, filter: str | None = None, **kwargs) -> + AsyncIterable[JobListResult]' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + - name: top + description: The number of jobs to request, in the of range of [1..100]. + defaultValue: None + types: + - + - name: skip + description: 'The (0-based) index of the job history list from which to begin + requesting + + entries.' + defaultValue: None + types: + - + - name: filter + description: The filter to apply on the job state. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either JobListResult or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.aio.operations.JobsOperations.list_job_history + name: list_job_history + summary: Lists job history. + signature: 'list_job_history(resource_group_name: str, job_collection_name: str, + job_name: str, top: int | None = None, skip: int | None = None, filter: str | + None = None, **kwargs) -> AsyncIterable[JobHistoryListResult]' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + - name: job_name + description: The job name. + isRequired: true + types: + - + - name: top + description: the number of job history to request, in the of range of [1..100]. + defaultValue: None + types: + - + - name: skip + description: 'The (0-based) index of the job history list from which to begin + requesting + + entries.' + defaultValue: None + types: + - + - name: filter + description: The filter to apply on the job state. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either JobHistoryListResult or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.aio.operations.JobsOperations.patch + name: patch + summary: Patches an existing job. + signature: 'async patch(resource_group_name: str, job_collection_name: str, job_name: + str, job: JobDefinition, **kwargs) -> JobDefinition' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + - name: job_name + description: The job name. + isRequired: true + types: + - + - name: job + description: The job definition. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: JobDefinition, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.aio.operations.JobsOperations.run + name: run + summary: Runs a job. + signature: 'async run(resource_group_name: str, job_collection_name: str, job_name: + str, **kwargs) -> None' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + - name: job_name + description: The job name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.scheduler.aio.operations.JobsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.aio.operations.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.aio.operations.yml new file mode 100644 index 00000000..ae5a9127 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.aio.operations.yml @@ -0,0 +1,8 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.scheduler.aio.operations +name: operations +fullName: azure.mgmt.scheduler.aio.operations +type: import +classes: +- azure.mgmt.scheduler.aio.operations.JobCollectionsOperations +- azure.mgmt.scheduler.aio.operations.JobsOperations diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.aio.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.aio.yml new file mode 100644 index 00000000..93dfd186 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.aio.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.scheduler.aio +name: aio +fullName: azure.mgmt.scheduler.aio +type: import +classes: +- azure.mgmt.scheduler.aio.SchedulerManagementClient +packages: +- azure.mgmt.scheduler.aio.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.BasicAuthentication.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.BasicAuthentication.yml new file mode 100644 index 00000000..567d7c87 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.BasicAuthentication.yml @@ -0,0 +1,38 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.BasicAuthentication +name: BasicAuthentication +fullName: azure.mgmt.scheduler.models.BasicAuthentication +module: azure.mgmt.scheduler.models +summary: 'BasicAuthentication. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'BasicAuthentication(*, username: str | None = None, password: str | None + = None, **kwargs)' + parameters: + - name: type + description: 'Required. Gets or sets the HTTP authentication type.Constant filled + by server. + + Possible values include: "NotSpecified", "ClientCertificate", "ActiveDirectoryOAuth", + "Basic".' + isRequired: true + types: + - + - + - name: username + description: Gets or sets the username. + isRequired: true + types: + - + - name: password + description: Gets or sets the password, return value will always be empty. + isRequired: true + types: + - + keywordOnlyParameters: + - name: username + isRequired: true + - name: password + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ClientCertAuthentication.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ClientCertAuthentication.yml new file mode 100644 index 00000000..ef644dcf --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ClientCertAuthentication.yml @@ -0,0 +1,64 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.ClientCertAuthentication +name: ClientCertAuthentication +fullName: azure.mgmt.scheduler.models.ClientCertAuthentication +module: azure.mgmt.scheduler.models +summary: 'ClientCertAuthentication. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ClientCertAuthentication(*, password: str | None = None, pfx: str | None + = None, certificate_thumbprint: str | None = None, certificate_expiration_date: + datetime | None = None, certificate_subject_name: str | None = None, **kwargs)' + parameters: + - name: type + description: 'Required. Gets or sets the HTTP authentication type.Constant filled + by server. + + Possible values include: "NotSpecified", "ClientCertificate", "ActiveDirectoryOAuth", + "Basic".' + isRequired: true + types: + - + - + - name: password + description: Gets or sets the certificate password, return value will always be + empty. + isRequired: true + types: + - + - name: pfx + description: 'Gets or sets the pfx certificate. Accepts certification in base64 + encoding, return + + value will always be empty.' + isRequired: true + types: + - + - name: certificate_thumbprint + description: Gets or sets the certificate thumbprint. + isRequired: true + types: + - + - name: certificate_expiration_date + description: Gets or sets the certificate expiration date. + isRequired: true + types: + - + - name: certificate_subject_name + description: Gets or sets the certificate subject name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: password + isRequired: true + - name: pfx + isRequired: true + - name: certificate_thumbprint + isRequired: true + - name: certificate_expiration_date + isRequired: true + - name: certificate_subject_name + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.DayOfWeek.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.DayOfWeek.yml new file mode 100644 index 00000000..1e73da36 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.DayOfWeek.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.scheduler.models.DayOfWeek +name: DayOfWeek +fullName: azure.mgmt.scheduler.models.DayOfWeek +module: azure.mgmt.scheduler.models +fields: +- name: FRIDAY + uid: azure.mgmt.scheduler.models.DayOfWeek.FRIDAY +- name: MONDAY + uid: azure.mgmt.scheduler.models.DayOfWeek.MONDAY +- name: SATURDAY + uid: azure.mgmt.scheduler.models.DayOfWeek.SATURDAY +- name: SUNDAY + uid: azure.mgmt.scheduler.models.DayOfWeek.SUNDAY +- name: THURSDAY + uid: azure.mgmt.scheduler.models.DayOfWeek.THURSDAY +- name: TUESDAY + uid: azure.mgmt.scheduler.models.DayOfWeek.TUESDAY +- name: WEDNESDAY + uid: azure.mgmt.scheduler.models.DayOfWeek.WEDNESDAY diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.HttpAuthentication.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.HttpAuthentication.yml new file mode 100644 index 00000000..7ef41eaf --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.HttpAuthentication.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.HttpAuthentication +name: HttpAuthentication +fullName: azure.mgmt.scheduler.models.HttpAuthentication +module: azure.mgmt.scheduler.models +summary: 'HttpAuthentication. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: OAuthAuthentication, BasicAuthentication, ClientCertAuthentication. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: HttpAuthentication(**kwargs) + parameters: + - name: type + description: 'Required. Gets or sets the HTTP authentication type.Constant filled + by server. + + Possible values include: "NotSpecified", "ClientCertificate", "ActiveDirectoryOAuth", + "Basic".' + isRequired: true + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.HttpAuthenticationType.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.HttpAuthenticationType.yml new file mode 100644 index 00000000..56544754 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.HttpAuthenticationType.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.scheduler.models.HttpAuthenticationType +name: HttpAuthenticationType +fullName: azure.mgmt.scheduler.models.HttpAuthenticationType +summary: Gets or sets the HTTP authentication type. +module: azure.mgmt.scheduler.models +fields: +- name: ACTIVE_DIRECTORY_O_AUTH + uid: azure.mgmt.scheduler.models.HttpAuthenticationType.ACTIVE_DIRECTORY_O_AUTH +- name: BASIC + uid: azure.mgmt.scheduler.models.HttpAuthenticationType.BASIC +- name: CLIENT_CERTIFICATE + uid: azure.mgmt.scheduler.models.HttpAuthenticationType.CLIENT_CERTIFICATE +- name: NOT_SPECIFIED + uid: azure.mgmt.scheduler.models.HttpAuthenticationType.NOT_SPECIFIED diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.HttpRequest.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.HttpRequest.yml new file mode 100644 index 00000000..12e7cb4f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.HttpRequest.yml @@ -0,0 +1,47 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.HttpRequest +name: HttpRequest +fullName: azure.mgmt.scheduler.models.HttpRequest +module: azure.mgmt.scheduler.models +summary: HttpRequest. +constructor: + syntax: 'HttpRequest(*, authentication: HttpAuthentication | None = None, uri: str + | None = None, method: str | None = None, body: str | None = None, headers: Dict[str, + str] | None = None, **kwargs)' + parameters: + - name: authentication + description: Gets or sets the authentication method of the request. + isRequired: true + types: + - + - name: uri + description: Gets or sets the URI of the request. + isRequired: true + types: + - + - name: method + description: Gets or sets the method of the request. + isRequired: true + types: + - + - name: body + description: Gets or sets the request body. + isRequired: true + types: + - + - name: headers + description: Gets or sets the headers. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: authentication + isRequired: true + - name: uri + isRequired: true + - name: method + isRequired: true + - name: body + isRequired: true + - name: headers + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobAction.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobAction.yml new file mode 100644 index 00000000..02f84663 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobAction.yml @@ -0,0 +1,67 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.JobAction +name: JobAction +fullName: azure.mgmt.scheduler.models.JobAction +module: azure.mgmt.scheduler.models +summary: JobAction. +constructor: + syntax: 'JobAction(*, type: str | JobActionType | None = None, request: HttpRequest + | None = None, queue_message: StorageQueueMessage | None = None, service_bus_queue_message: + ServiceBusQueueMessage | None = None, service_bus_topic_message: ServiceBusTopicMessage + | None = None, retry_policy: RetryPolicy | None = None, error_action: JobErrorAction + | None = None, **kwargs)' + parameters: + - name: type + description: 'Gets or sets the job action type. Possible values include: "Http", + "Https", + + "StorageQueue", "ServiceBusQueue", "ServiceBusTopic".' + isRequired: true + types: + - + - + - name: request + description: Gets or sets the http requests. + isRequired: true + types: + - + - name: queue_message + description: Gets or sets the storage queue message. + isRequired: true + types: + - + - name: service_bus_queue_message + description: Gets or sets the service bus queue message. + isRequired: true + types: + - + - name: service_bus_topic_message + description: Gets or sets the service bus topic message. + isRequired: true + types: + - + - name: retry_policy + description: Gets or sets the retry policy. + isRequired: true + types: + - + - name: error_action + description: Gets or sets the error action. + isRequired: true + types: + - + keywordOnlyParameters: + - name: type + isRequired: true + - name: request + isRequired: true + - name: queue_message + isRequired: true + - name: service_bus_queue_message + isRequired: true + - name: service_bus_topic_message + isRequired: true + - name: retry_policy + isRequired: true + - name: error_action + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobActionType.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobActionType.yml new file mode 100644 index 00000000..48eeb39e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobActionType.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.scheduler.models.JobActionType +name: JobActionType +fullName: azure.mgmt.scheduler.models.JobActionType +summary: Gets or sets the job action type. +module: azure.mgmt.scheduler.models +fields: +- name: HTTP + uid: azure.mgmt.scheduler.models.JobActionType.HTTP +- name: HTTPS + uid: azure.mgmt.scheduler.models.JobActionType.HTTPS +- name: SERVICE_BUS_QUEUE + uid: azure.mgmt.scheduler.models.JobActionType.SERVICE_BUS_QUEUE +- name: SERVICE_BUS_TOPIC + uid: azure.mgmt.scheduler.models.JobActionType.SERVICE_BUS_TOPIC +- name: STORAGE_QUEUE + uid: azure.mgmt.scheduler.models.JobActionType.STORAGE_QUEUE diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionDefinition.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionDefinition.yml new file mode 100644 index 00000000..e784960a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionDefinition.yml @@ -0,0 +1,52 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.JobCollectionDefinition +name: JobCollectionDefinition +fullName: azure.mgmt.scheduler.models.JobCollectionDefinition +module: azure.mgmt.scheduler.models +summary: 'JobCollectionDefinition. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'JobCollectionDefinition(*, name: str | None = None, location: str | None + = None, tags: Dict[str, str] | None = None, properties: JobCollectionProperties + | None = None, **kwargs)' + parameters: + - name: name + description: Gets or sets the job collection resource name. + isRequired: true + types: + - + - name: location + description: Gets or sets the storage account location. + isRequired: true + types: + - + - name: tags + description: A set of tags. Gets or sets the tags. + isRequired: true + types: + - [, ] + - name: properties + description: Gets or sets the job collection properties. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: location + isRequired: true + - name: tags + isRequired: true + - name: properties + isRequired: true +variables: +- description: Gets the job collection resource identifier. + name: id + types: + - +- description: Gets the job collection resource type. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionListResult.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionListResult.yml new file mode 100644 index 00000000..46136110 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionListResult.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.JobCollectionListResult +name: JobCollectionListResult +fullName: azure.mgmt.scheduler.models.JobCollectionListResult +module: azure.mgmt.scheduler.models +summary: 'JobCollectionListResult. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'JobCollectionListResult(*, next_link: str | None = None, **kwargs)' + parameters: + - name: next_link + description: Gets or sets the URL to get the next set of job collections. + isRequired: true + types: + - + keywordOnlyParameters: + - name: next_link + isRequired: true +variables: +- description: Gets the job collections. + name: value + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionProperties.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionProperties.yml new file mode 100644 index 00000000..e7f26fd9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionProperties.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.JobCollectionProperties +name: JobCollectionProperties +fullName: azure.mgmt.scheduler.models.JobCollectionProperties +module: azure.mgmt.scheduler.models +summary: JobCollectionProperties. +constructor: + syntax: 'JobCollectionProperties(*, sku: Sku | None = None, state: str | JobCollectionState + | None = None, quota: JobCollectionQuota | None = None, **kwargs)' + parameters: + - name: sku + description: Gets or sets the SKU. + isRequired: true + types: + - + - name: state + description: 'Gets or sets the state. Possible values include: "Enabled", "Disabled", + + "Suspended", "Deleted".' + isRequired: true + types: + - + - + - name: quota + description: Gets or sets the job collection quota. + isRequired: true + types: + - + keywordOnlyParameters: + - name: sku + isRequired: true + - name: state + isRequired: true + - name: quota + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionQuota.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionQuota.yml new file mode 100644 index 00000000..f24c4d7f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionQuota.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.JobCollectionQuota +name: JobCollectionQuota +fullName: azure.mgmt.scheduler.models.JobCollectionQuota +module: azure.mgmt.scheduler.models +summary: JobCollectionQuota. +constructor: + syntax: 'JobCollectionQuota(*, max_job_count: int | None = None, max_job_occurrence: + int | None = None, max_recurrence: JobMaxRecurrence | None = None, **kwargs)' + parameters: + - name: max_job_count + description: Gets or set the maximum job count. + isRequired: true + types: + - + - name: max_job_occurrence + description: Gets or sets the maximum job occurrence. + isRequired: true + types: + - + - name: max_recurrence + description: Gets or set the maximum recurrence. + isRequired: true + types: + - + keywordOnlyParameters: + - name: max_job_count + isRequired: true + - name: max_job_occurrence + isRequired: true + - name: max_recurrence + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionState.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionState.yml new file mode 100644 index 00000000..e428c5f2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionState.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.scheduler.models.JobCollectionState +name: JobCollectionState +fullName: azure.mgmt.scheduler.models.JobCollectionState +summary: Gets or sets the state. +module: azure.mgmt.scheduler.models +fields: +- name: DELETED + uid: azure.mgmt.scheduler.models.JobCollectionState.DELETED +- name: DISABLED + uid: azure.mgmt.scheduler.models.JobCollectionState.DISABLED +- name: ENABLED + uid: azure.mgmt.scheduler.models.JobCollectionState.ENABLED +- name: SUSPENDED + uid: azure.mgmt.scheduler.models.JobCollectionState.SUSPENDED diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobDefinition.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobDefinition.yml new file mode 100644 index 00000000..de9aea47 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobDefinition.yml @@ -0,0 +1,33 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.JobDefinition +name: JobDefinition +fullName: azure.mgmt.scheduler.models.JobDefinition +module: azure.mgmt.scheduler.models +summary: 'JobDefinition. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'JobDefinition(*, properties: JobProperties | None = None, **kwargs)' + parameters: + - name: properties + description: Gets or sets the job properties. + isRequired: true + types: + - + keywordOnlyParameters: + - name: properties + isRequired: true +variables: +- description: Gets the job resource identifier. + name: id + types: + - +- description: Gets the job resource type. + name: type + types: + - +- description: Gets the job resource name. + name: name + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobErrorAction.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobErrorAction.yml new file mode 100644 index 00000000..cb99acaf --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobErrorAction.yml @@ -0,0 +1,59 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.JobErrorAction +name: JobErrorAction +fullName: azure.mgmt.scheduler.models.JobErrorAction +module: azure.mgmt.scheduler.models +summary: JobErrorAction. +constructor: + syntax: 'JobErrorAction(*, type: str | JobActionType | None = None, request: HttpRequest + | None = None, queue_message: StorageQueueMessage | None = None, service_bus_queue_message: + ServiceBusQueueMessage | None = None, service_bus_topic_message: ServiceBusTopicMessage + | None = None, retry_policy: RetryPolicy | None = None, **kwargs)' + parameters: + - name: type + description: 'Gets or sets the job error action type. Possible values include: + "Http", "Https", + + "StorageQueue", "ServiceBusQueue", "ServiceBusTopic".' + isRequired: true + types: + - + - + - name: request + description: Gets or sets the http requests. + isRequired: true + types: + - + - name: queue_message + description: Gets or sets the storage queue message. + isRequired: true + types: + - + - name: service_bus_queue_message + description: Gets or sets the service bus queue message. + isRequired: true + types: + - + - name: service_bus_topic_message + description: Gets or sets the service bus topic message. + isRequired: true + types: + - + - name: retry_policy + description: Gets or sets the retry policy. + isRequired: true + types: + - + keywordOnlyParameters: + - name: type + isRequired: true + - name: request + isRequired: true + - name: queue_message + isRequired: true + - name: service_bus_queue_message + isRequired: true + - name: service_bus_topic_message + isRequired: true + - name: retry_policy + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobExecutionStatus.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobExecutionStatus.yml new file mode 100644 index 00000000..fecfb214 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobExecutionStatus.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.scheduler.models.JobExecutionStatus +name: JobExecutionStatus +fullName: azure.mgmt.scheduler.models.JobExecutionStatus +summary: Gets the job execution status. +module: azure.mgmt.scheduler.models +fields: +- name: COMPLETED + uid: azure.mgmt.scheduler.models.JobExecutionStatus.COMPLETED +- name: FAILED + uid: azure.mgmt.scheduler.models.JobExecutionStatus.FAILED +- name: POSTPONED + uid: azure.mgmt.scheduler.models.JobExecutionStatus.POSTPONED diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryActionName.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryActionName.yml new file mode 100644 index 00000000..1df32425 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryActionName.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.scheduler.models.JobHistoryActionName +name: JobHistoryActionName +fullName: azure.mgmt.scheduler.models.JobHistoryActionName +summary: Gets the job history action name. +module: azure.mgmt.scheduler.models +fields: +- name: ERROR_ACTION + uid: azure.mgmt.scheduler.models.JobHistoryActionName.ERROR_ACTION +- name: MAIN_ACTION + uid: azure.mgmt.scheduler.models.JobHistoryActionName.MAIN_ACTION diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryDefinition.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryDefinition.yml new file mode 100644 index 00000000..d1b17119 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryDefinition.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.JobHistoryDefinition +name: JobHistoryDefinition +fullName: azure.mgmt.scheduler.models.JobHistoryDefinition +module: azure.mgmt.scheduler.models +summary: 'JobHistoryDefinition. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: JobHistoryDefinition(**kwargs) +variables: +- description: Gets the job history identifier. + name: id + types: + - +- description: Gets the job history resource type. + name: type + types: + - +- description: Gets the job history name. + name: name + types: + - +- description: Gets or sets the job history properties. + name: properties + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryDefinitionProperties.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryDefinitionProperties.yml new file mode 100644 index 00000000..c11c579d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryDefinitionProperties.yml @@ -0,0 +1,51 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.JobHistoryDefinitionProperties +name: JobHistoryDefinitionProperties +fullName: azure.mgmt.scheduler.models.JobHistoryDefinitionProperties +module: azure.mgmt.scheduler.models +summary: 'JobHistoryDefinitionProperties. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: JobHistoryDefinitionProperties(**kwargs) +variables: +- description: Gets the start time for this job. + name: start_time + types: + - +- description: Gets the end time for this job. + name: end_time + types: + - +- description: Gets the expected execution time for this job. + name: expected_execution_time + types: + - +- description: 'Gets the job history action name. Possible values include: "MainAction", + + "ErrorAction".' + name: action_name + types: + - + - +- description: 'Gets the job history status. Possible values include: "Completed", + "Failed", + + "Postponed".' + name: status + types: + - + - +- description: Gets the message for the job history. + name: message + types: + - +- description: Gets the retry count for job. + name: retry_count + types: + - +- description: Gets the repeat count for the job. + name: repeat_count + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryFilter.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryFilter.yml new file mode 100644 index 00000000..357c4e0e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryFilter.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.JobHistoryFilter +name: JobHistoryFilter +fullName: azure.mgmt.scheduler.models.JobHistoryFilter +module: azure.mgmt.scheduler.models +summary: JobHistoryFilter. +constructor: + syntax: 'JobHistoryFilter(*, status: str | JobExecutionStatus | None = None, **kwargs)' + parameters: + - name: status + description: 'Gets or sets the job execution status. Possible values include: + "Completed", + + "Failed", "Postponed".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: status + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryListResult.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryListResult.yml new file mode 100644 index 00000000..ab904a42 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryListResult.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.JobHistoryListResult +name: JobHistoryListResult +fullName: azure.mgmt.scheduler.models.JobHistoryListResult +module: azure.mgmt.scheduler.models +summary: JobHistoryListResult. +constructor: + syntax: 'JobHistoryListResult(*, value: List[JobHistoryDefinition] | None = None, + next_link: str | None = None, **kwargs)' + parameters: + - name: value + description: Gets or sets the job histories under job. + isRequired: true + types: + - [] + - name: next_link + description: Gets or sets the URL to get the next set of job histories. + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: next_link + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobListResult.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobListResult.yml new file mode 100644 index 00000000..6f3d6be6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobListResult.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.JobListResult +name: JobListResult +fullName: azure.mgmt.scheduler.models.JobListResult +module: azure.mgmt.scheduler.models +summary: JobListResult. +constructor: + syntax: 'JobListResult(*, value: List[JobDefinition] | None = None, next_link: str + | None = None, **kwargs)' + parameters: + - name: value + description: Gets or sets all jobs under job collection. + isRequired: true + types: + - [] + - name: next_link + description: Gets or sets the URL to get the next set of jobs. + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: next_link + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobMaxRecurrence.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobMaxRecurrence.yml new file mode 100644 index 00000000..a205666b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobMaxRecurrence.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.JobMaxRecurrence +name: JobMaxRecurrence +fullName: azure.mgmt.scheduler.models.JobMaxRecurrence +module: azure.mgmt.scheduler.models +summary: JobMaxRecurrence. +constructor: + syntax: 'JobMaxRecurrence(*, frequency: str | RecurrenceFrequency | None = None, + interval: int | None = None, **kwargs)' + parameters: + - name: frequency + description: 'Gets or sets the frequency of recurrence (second, minute, hour, + day, week, + + month). Possible values include: "Minute", "Hour", "Day", "Week", "Month".' + isRequired: true + types: + - + - + - name: interval + description: Gets or sets the interval between retries. + isRequired: true + types: + - + keywordOnlyParameters: + - name: frequency + isRequired: true + - name: interval + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobProperties.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobProperties.yml new file mode 100644 index 00000000..2d3939bb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobProperties.yml @@ -0,0 +1,51 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.JobProperties +name: JobProperties +fullName: azure.mgmt.scheduler.models.JobProperties +module: azure.mgmt.scheduler.models +summary: 'JobProperties. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'JobProperties(*, start_time: datetime | None = None, action: JobAction + | None = None, recurrence: JobRecurrence | None = None, state: str | JobState + | None = None, **kwargs)' + parameters: + - name: start_time + description: Gets or sets the job start time. + isRequired: true + types: + - + - name: action + description: Gets or sets the job action. + isRequired: true + types: + - + - name: recurrence + description: Gets or sets the job recurrence. + isRequired: true + types: + - + - name: state + description: 'Gets or set the job state. Possible values include: "Enabled", "Disabled", + + "Faulted", "Completed".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: start_time + isRequired: true + - name: action + isRequired: true + - name: recurrence + isRequired: true + - name: state + isRequired: true +variables: +- description: Gets the job status. + name: status + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrence.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrence.yml new file mode 100644 index 00000000..16148c08 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrence.yml @@ -0,0 +1,50 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.JobRecurrence +name: JobRecurrence +fullName: azure.mgmt.scheduler.models.JobRecurrence +module: azure.mgmt.scheduler.models +summary: JobRecurrence. +constructor: + syntax: 'JobRecurrence(*, frequency: str | RecurrenceFrequency | None = None, interval: + int | None = None, count: int | None = None, end_time: datetime | None = None, + schedule: JobRecurrenceSchedule | None = None, **kwargs)' + parameters: + - name: frequency + description: 'Gets or sets the frequency of recurrence (second, minute, hour, + day, week, + + month). Possible values include: "Minute", "Hour", "Day", "Week", "Month".' + isRequired: true + types: + - + - + - name: interval + description: Gets or sets the interval between retries. + isRequired: true + types: + - + - name: count + description: Gets or sets the maximum number of times that the job should run. + isRequired: true + types: + - + - name: end_time + description: Gets or sets the time at which the job will complete. + isRequired: true + types: + - + - name: schedule + isRequired: true + types: + - + keywordOnlyParameters: + - name: frequency + isRequired: true + - name: interval + isRequired: true + - name: count + isRequired: true + - name: end_time + isRequired: true + - name: schedule + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrenceSchedule.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrenceSchedule.yml new file mode 100644 index 00000000..249deb3d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrenceSchedule.yml @@ -0,0 +1,53 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.JobRecurrenceSchedule +name: JobRecurrenceSchedule +fullName: azure.mgmt.scheduler.models.JobRecurrenceSchedule +module: azure.mgmt.scheduler.models +summary: JobRecurrenceSchedule. +constructor: + syntax: 'JobRecurrenceSchedule(*, week_days: List[str | DayOfWeek] | None = None, + hours: List[int] | None = None, minutes: List[int] | None = None, month_days: + List[int] | None = None, monthly_occurrences: List[JobRecurrenceScheduleMonthlyOccurrence] + | None = None, **kwargs)' + parameters: + - name: week_days + description: Gets or sets the days of the week that the job should execute on. + isRequired: true + types: + - [ + - ] + - name: hours + description: Gets or sets the hours of the day that the job should execute at. + isRequired: true + types: + - [] + - name: minutes + description: Gets or sets the minutes of the hour that the job should execute + at. + isRequired: true + types: + - [] + - name: month_days + description: 'Gets or sets the days of the month that the job should execute on. + Must be + + between 1 and 31.' + isRequired: true + types: + - [] + - name: monthly_occurrences + description: Gets or sets the occurrences of days within a month. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: week_days + isRequired: true + - name: hours + isRequired: true + - name: minutes + isRequired: true + - name: month_days + isRequired: true + - name: monthly_occurrences + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrenceScheduleMonthlyOccurrence.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrenceScheduleMonthlyOccurrence.yml new file mode 100644 index 00000000..6b3bcd02 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrenceScheduleMonthlyOccurrence.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.JobRecurrenceScheduleMonthlyOccurrence +name: JobRecurrenceScheduleMonthlyOccurrence +fullName: azure.mgmt.scheduler.models.JobRecurrenceScheduleMonthlyOccurrence +module: azure.mgmt.scheduler.models +summary: JobRecurrenceScheduleMonthlyOccurrence. +constructor: + syntax: 'JobRecurrenceScheduleMonthlyOccurrence(*, day: str | JobScheduleDay | None + = None, occurrence: int | None = None, **kwargs)' + parameters: + - name: day + description: 'Gets or sets the day. Must be one of monday, tuesday, wednesday, + thursday, friday, + + saturday, sunday. Possible values include: "Monday", "Tuesday", "Wednesday", + "Thursday", + + "Friday", "Saturday", "Sunday".' + isRequired: true + types: + - + - + - name: occurrence + description: Gets or sets the occurrence. Must be between -5 and 5. + isRequired: true + types: + - + keywordOnlyParameters: + - name: day + isRequired: true + - name: occurrence + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobScheduleDay.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobScheduleDay.yml new file mode 100644 index 00000000..0a9cab49 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobScheduleDay.yml @@ -0,0 +1,24 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.scheduler.models.JobScheduleDay +name: JobScheduleDay +fullName: azure.mgmt.scheduler.models.JobScheduleDay +summary: 'Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, + friday, saturday, + + sunday.' +module: azure.mgmt.scheduler.models +fields: +- name: FRIDAY + uid: azure.mgmt.scheduler.models.JobScheduleDay.FRIDAY +- name: MONDAY + uid: azure.mgmt.scheduler.models.JobScheduleDay.MONDAY +- name: SATURDAY + uid: azure.mgmt.scheduler.models.JobScheduleDay.SATURDAY +- name: SUNDAY + uid: azure.mgmt.scheduler.models.JobScheduleDay.SUNDAY +- name: THURSDAY + uid: azure.mgmt.scheduler.models.JobScheduleDay.THURSDAY +- name: TUESDAY + uid: azure.mgmt.scheduler.models.JobScheduleDay.TUESDAY +- name: WEDNESDAY + uid: azure.mgmt.scheduler.models.JobScheduleDay.WEDNESDAY diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobState.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobState.yml new file mode 100644 index 00000000..1f6203b9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobState.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.scheduler.models.JobState +name: JobState +fullName: azure.mgmt.scheduler.models.JobState +summary: Gets or set the job state. +module: azure.mgmt.scheduler.models +fields: +- name: COMPLETED + uid: azure.mgmt.scheduler.models.JobState.COMPLETED +- name: DISABLED + uid: azure.mgmt.scheduler.models.JobState.DISABLED +- name: ENABLED + uid: azure.mgmt.scheduler.models.JobState.ENABLED +- name: FAULTED + uid: azure.mgmt.scheduler.models.JobState.FAULTED diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobStateFilter.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobStateFilter.yml new file mode 100644 index 00000000..d0df5f3a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobStateFilter.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.JobStateFilter +name: JobStateFilter +fullName: azure.mgmt.scheduler.models.JobStateFilter +module: azure.mgmt.scheduler.models +summary: JobStateFilter. +constructor: + syntax: 'JobStateFilter(*, state: str | JobState | None = None, **kwargs)' + parameters: + - name: state + description: 'Gets or sets the job state. Possible values include: "Enabled", + "Disabled", + + "Faulted", "Completed".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: state + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobStatus.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobStatus.yml new file mode 100644 index 00000000..d96eb2d5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobStatus.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.JobStatus +name: JobStatus +fullName: azure.mgmt.scheduler.models.JobStatus +module: azure.mgmt.scheduler.models +summary: 'JobStatus. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: JobStatus(**kwargs) +variables: +- description: Gets the number of times this job has executed. + name: execution_count + types: + - +- description: Gets the number of times this job has failed. + name: failure_count + types: + - +- description: 'Gets the number of faulted occurrences (occurrences that were retried + and + + failed as many times as the retry policy states).' + name: faulted_count + types: + - +- description: 'Gets the time the last occurrence executed in ISO-8601 format. + + Could be empty if job has not run yet.' + name: last_execution_time + types: + - +- description: 'Gets the time of the next occurrence in ISO-8601 format. Could be + + empty if the job is completed.' + name: next_execution_time + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.OAuthAuthentication.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.OAuthAuthentication.yml new file mode 100644 index 00000000..05b9cefd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.OAuthAuthentication.yml @@ -0,0 +1,52 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.OAuthAuthentication +name: OAuthAuthentication +fullName: azure.mgmt.scheduler.models.OAuthAuthentication +module: azure.mgmt.scheduler.models +summary: 'OAuthAuthentication. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'OAuthAuthentication(*, secret: str | None = None, tenant: str | None = + None, audience: str | None = None, client_id: str | None = None, **kwargs)' + parameters: + - name: type + description: 'Required. Gets or sets the HTTP authentication type.Constant filled + by server. + + Possible values include: "NotSpecified", "ClientCertificate", "ActiveDirectoryOAuth", + "Basic".' + isRequired: true + types: + - + - + - name: secret + description: Gets or sets the secret, return value will always be empty. + isRequired: true + types: + - + - name: tenant + description: Gets or sets the tenant. + isRequired: true + types: + - + - name: audience + description: Gets or sets the audience. + isRequired: true + types: + - + - name: client_id + description: Gets or sets the client identifier. + isRequired: true + types: + - + keywordOnlyParameters: + - name: secret + isRequired: true + - name: tenant + isRequired: true + - name: audience + isRequired: true + - name: client_id + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.RecurrenceFrequency.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.RecurrenceFrequency.yml new file mode 100644 index 00000000..0f736584 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.RecurrenceFrequency.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.scheduler.models.RecurrenceFrequency +name: RecurrenceFrequency +fullName: azure.mgmt.scheduler.models.RecurrenceFrequency +summary: Gets or sets the frequency of recurrence (second, minute, hour, day, week, + month). +module: azure.mgmt.scheduler.models +fields: +- name: DAY + uid: azure.mgmt.scheduler.models.RecurrenceFrequency.DAY +- name: HOUR + uid: azure.mgmt.scheduler.models.RecurrenceFrequency.HOUR +- name: MINUTE + uid: azure.mgmt.scheduler.models.RecurrenceFrequency.MINUTE +- name: MONTH + uid: azure.mgmt.scheduler.models.RecurrenceFrequency.MONTH +- name: WEEK + uid: azure.mgmt.scheduler.models.RecurrenceFrequency.WEEK diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.RetryPolicy.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.RetryPolicy.yml new file mode 100644 index 00000000..66c81ae6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.RetryPolicy.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.RetryPolicy +name: RetryPolicy +fullName: azure.mgmt.scheduler.models.RetryPolicy +module: azure.mgmt.scheduler.models +summary: RetryPolicy. +constructor: + syntax: 'RetryPolicy(*, retry_type: str | RetryType | None = None, retry_interval: + timedelta | None = None, retry_count: int | None = None, **kwargs)' + parameters: + - name: retry_type + description: 'Gets or sets the retry strategy to be used. Possible values include: + "None", + + "Fixed".' + isRequired: true + types: + - + - + - name: retry_interval + description: 'Gets or sets the retry interval between retries, specify duration + in ISO + + 8601 format.' + isRequired: true + types: + - + - name: retry_count + description: Gets or sets the number of times a retry should be attempted. + isRequired: true + types: + - + keywordOnlyParameters: + - name: retry_type + isRequired: true + - name: retry_interval + isRequired: true + - name: retry_count + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.RetryType.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.RetryType.yml new file mode 100644 index 00000000..ec3772ad --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.RetryType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.scheduler.models.RetryType +name: RetryType +fullName: azure.mgmt.scheduler.models.RetryType +summary: Gets or sets the retry strategy to be used. +module: azure.mgmt.scheduler.models +fields: +- name: FIXED + uid: azure.mgmt.scheduler.models.RetryType.FIXED +- name: NONE + uid: azure.mgmt.scheduler.models.RetryType.NONE diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusAuthentication.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusAuthentication.yml new file mode 100644 index 00000000..bbc6d187 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusAuthentication.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.ServiceBusAuthentication +name: ServiceBusAuthentication +fullName: azure.mgmt.scheduler.models.ServiceBusAuthentication +module: azure.mgmt.scheduler.models +summary: ServiceBusAuthentication. +constructor: + syntax: 'ServiceBusAuthentication(*, sas_key: str | None = None, sas_key_name: str + | None = None, type: str | ServiceBusAuthenticationType | None = None, **kwargs)' + parameters: + - name: sas_key + description: Gets or sets the SAS key. + isRequired: true + types: + - + - name: sas_key_name + description: Gets or sets the SAS key name. + isRequired: true + types: + - + - name: type + description: 'Gets or sets the authentication type. Possible values include: "NotSpecified", + + "SharedAccessKey".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: sas_key + isRequired: true + - name: sas_key_name + isRequired: true + - name: type + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusAuthenticationType.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusAuthenticationType.yml new file mode 100644 index 00000000..3008a008 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusAuthenticationType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.scheduler.models.ServiceBusAuthenticationType +name: ServiceBusAuthenticationType +fullName: azure.mgmt.scheduler.models.ServiceBusAuthenticationType +summary: Gets or sets the authentication type. +module: azure.mgmt.scheduler.models +fields: +- name: NOT_SPECIFIED + uid: azure.mgmt.scheduler.models.ServiceBusAuthenticationType.NOT_SPECIFIED +- name: SHARED_ACCESS_KEY + uid: azure.mgmt.scheduler.models.ServiceBusAuthenticationType.SHARED_ACCESS_KEY diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusBrokeredMessageProperties.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusBrokeredMessageProperties.yml new file mode 100644 index 00000000..065389a7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusBrokeredMessageProperties.yml @@ -0,0 +1,106 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.ServiceBusBrokeredMessageProperties +name: ServiceBusBrokeredMessageProperties +fullName: azure.mgmt.scheduler.models.ServiceBusBrokeredMessageProperties +module: azure.mgmt.scheduler.models +summary: ServiceBusBrokeredMessageProperties. +constructor: + syntax: 'ServiceBusBrokeredMessageProperties(*, content_type: str | None = None, + correlation_id: str | None = None, force_persistence: bool | None = None, label: + str | None = None, message_id: str | None = None, partition_key: str | None = + None, reply_to: str | None = None, reply_to_session_id: str | None = None, scheduled_enqueue_time_utc: + datetime | None = None, session_id: str | None = None, time_to_live: timedelta + | None = None, to: str | None = None, via_partition_key: str | None = None, **kwargs)' + parameters: + - name: content_type + description: Gets or sets the content type. + isRequired: true + types: + - + - name: correlation_id + description: Gets or sets the correlation ID. + isRequired: true + types: + - + - name: force_persistence + description: Gets or sets the force persistence. + isRequired: true + types: + - + - name: label + description: Gets or sets the label. + isRequired: true + types: + - + - name: message_id + description: Gets or sets the message ID. + isRequired: true + types: + - + - name: partition_key + description: Gets or sets the partition key. + isRequired: true + types: + - + - name: reply_to + description: Gets or sets the reply to. + isRequired: true + types: + - + - name: reply_to_session_id + description: Gets or sets the reply to session ID. + isRequired: true + types: + - + - name: scheduled_enqueue_time_utc + description: Gets or sets the scheduled enqueue time UTC. + isRequired: true + types: + - + - name: session_id + description: Gets or sets the session ID. + isRequired: true + types: + - + - name: time_to_live + description: Gets or sets the time to live. + isRequired: true + types: + - + - name: to + description: Gets or sets the to. + isRequired: true + types: + - + - name: via_partition_key + description: Gets or sets the via partition key. + isRequired: true + types: + - + keywordOnlyParameters: + - name: content_type + isRequired: true + - name: correlation_id + isRequired: true + - name: force_persistence + isRequired: true + - name: label + isRequired: true + - name: message_id + isRequired: true + - name: partition_key + isRequired: true + - name: reply_to + isRequired: true + - name: reply_to_session_id + isRequired: true + - name: scheduled_enqueue_time_utc + isRequired: true + - name: session_id + isRequired: true + - name: time_to_live + isRequired: true + - name: to + isRequired: true + - name: via_partition_key + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusMessage.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusMessage.yml new file mode 100644 index 00000000..b5d3b7a2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusMessage.yml @@ -0,0 +1,59 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.ServiceBusMessage +name: ServiceBusMessage +fullName: azure.mgmt.scheduler.models.ServiceBusMessage +module: azure.mgmt.scheduler.models +summary: ServiceBusMessage. +constructor: + syntax: 'ServiceBusMessage(*, authentication: ServiceBusAuthentication | None = + None, brokered_message_properties: ServiceBusBrokeredMessageProperties | None + = None, custom_message_properties: Dict[str, str] | None = None, message: str + | None = None, namespace: str | None = None, transport_type: str | ServiceBusTransportType + | None = None, **kwargs)' + parameters: + - name: authentication + description: Gets or sets the Service Bus authentication. + isRequired: true + types: + - + - name: brokered_message_properties + description: Gets or sets the brokered message properties. + isRequired: true + types: + - + - name: custom_message_properties + description: Gets or sets the custom message properties. + isRequired: true + types: + - [, ] + - name: message + description: Gets or sets the message. + isRequired: true + types: + - + - name: namespace + description: Gets or sets the namespace. + isRequired: true + types: + - + - name: transport_type + description: 'Gets or sets the transport type. Possible values include: + + "NotSpecified", "NetMessaging", "AMQP".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: authentication + isRequired: true + - name: brokered_message_properties + isRequired: true + - name: custom_message_properties + isRequired: true + - name: message + isRequired: true + - name: namespace + isRequired: true + - name: transport_type + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusQueueMessage.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusQueueMessage.yml new file mode 100644 index 00000000..7141716d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusQueueMessage.yml @@ -0,0 +1,66 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.ServiceBusQueueMessage +name: ServiceBusQueueMessage +fullName: azure.mgmt.scheduler.models.ServiceBusQueueMessage +module: azure.mgmt.scheduler.models +summary: ServiceBusQueueMessage. +constructor: + syntax: 'ServiceBusQueueMessage(*, authentication: ServiceBusAuthentication | None + = None, brokered_message_properties: ServiceBusBrokeredMessageProperties | None + = None, custom_message_properties: Dict[str, str] | None = None, message: str + | None = None, namespace: str | None = None, transport_type: str | ServiceBusTransportType + | None = None, queue_name: str | None = None, **kwargs)' + parameters: + - name: authentication + description: Gets or sets the Service Bus authentication. + isRequired: true + types: + - + - name: brokered_message_properties + description: Gets or sets the brokered message properties. + isRequired: true + types: + - + - name: custom_message_properties + description: Gets or sets the custom message properties. + isRequired: true + types: + - [, ] + - name: message + description: Gets or sets the message. + isRequired: true + types: + - + - name: namespace + description: Gets or sets the namespace. + isRequired: true + types: + - + - name: transport_type + description: 'Gets or sets the transport type. Possible values include: + + "NotSpecified", "NetMessaging", "AMQP".' + isRequired: true + types: + - + - + - name: queue_name + description: Gets or sets the queue name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: authentication + isRequired: true + - name: brokered_message_properties + isRequired: true + - name: custom_message_properties + isRequired: true + - name: message + isRequired: true + - name: namespace + isRequired: true + - name: transport_type + isRequired: true + - name: queue_name + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusTopicMessage.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusTopicMessage.yml new file mode 100644 index 00000000..a587e4d7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusTopicMessage.yml @@ -0,0 +1,66 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.ServiceBusTopicMessage +name: ServiceBusTopicMessage +fullName: azure.mgmt.scheduler.models.ServiceBusTopicMessage +module: azure.mgmt.scheduler.models +summary: ServiceBusTopicMessage. +constructor: + syntax: 'ServiceBusTopicMessage(*, authentication: ServiceBusAuthentication | None + = None, brokered_message_properties: ServiceBusBrokeredMessageProperties | None + = None, custom_message_properties: Dict[str, str] | None = None, message: str + | None = None, namespace: str | None = None, transport_type: str | ServiceBusTransportType + | None = None, topic_path: str | None = None, **kwargs)' + parameters: + - name: authentication + description: Gets or sets the Service Bus authentication. + isRequired: true + types: + - + - name: brokered_message_properties + description: Gets or sets the brokered message properties. + isRequired: true + types: + - + - name: custom_message_properties + description: Gets or sets the custom message properties. + isRequired: true + types: + - [, ] + - name: message + description: Gets or sets the message. + isRequired: true + types: + - + - name: namespace + description: Gets or sets the namespace. + isRequired: true + types: + - + - name: transport_type + description: 'Gets or sets the transport type. Possible values include: + + "NotSpecified", "NetMessaging", "AMQP".' + isRequired: true + types: + - + - + - name: topic_path + description: Gets or sets the topic path. + isRequired: true + types: + - + keywordOnlyParameters: + - name: authentication + isRequired: true + - name: brokered_message_properties + isRequired: true + - name: custom_message_properties + isRequired: true + - name: message + isRequired: true + - name: namespace + isRequired: true + - name: transport_type + isRequired: true + - name: topic_path + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusTransportType.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusTransportType.yml new file mode 100644 index 00000000..639bf990 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusTransportType.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.scheduler.models.ServiceBusTransportType +name: ServiceBusTransportType +fullName: azure.mgmt.scheduler.models.ServiceBusTransportType +summary: Gets or sets the transport type. +module: azure.mgmt.scheduler.models +fields: +- name: AMQP + uid: azure.mgmt.scheduler.models.ServiceBusTransportType.AMQP +- name: NET_MESSAGING + uid: azure.mgmt.scheduler.models.ServiceBusTransportType.NET_MESSAGING +- name: NOT_SPECIFIED + uid: azure.mgmt.scheduler.models.ServiceBusTransportType.NOT_SPECIFIED diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.Sku.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.Sku.yml new file mode 100644 index 00000000..0ca04c2e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.Sku.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.Sku +name: Sku +fullName: azure.mgmt.scheduler.models.Sku +module: azure.mgmt.scheduler.models +summary: Sku. +constructor: + syntax: 'Sku(*, name: str | SkuDefinition | None = None, **kwargs)' + parameters: + - name: name + description: 'Gets or set the SKU. Possible values include: "Standard", "Free", + "P10Premium", + + "P20Premium".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: name + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.SkuDefinition.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.SkuDefinition.yml new file mode 100644 index 00000000..6b81db5e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.SkuDefinition.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.scheduler.models.SkuDefinition +name: SkuDefinition +fullName: azure.mgmt.scheduler.models.SkuDefinition +summary: Gets or set the SKU. +module: azure.mgmt.scheduler.models +fields: +- name: FREE + uid: azure.mgmt.scheduler.models.SkuDefinition.FREE +- name: P10_PREMIUM + uid: azure.mgmt.scheduler.models.SkuDefinition.P10_PREMIUM +- name: P20_PREMIUM + uid: azure.mgmt.scheduler.models.SkuDefinition.P20_PREMIUM +- name: STANDARD + uid: azure.mgmt.scheduler.models.SkuDefinition.STANDARD diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.StorageQueueMessage.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.StorageQueueMessage.yml new file mode 100644 index 00000000..623f3be7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.StorageQueueMessage.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.models.StorageQueueMessage +name: StorageQueueMessage +fullName: azure.mgmt.scheduler.models.StorageQueueMessage +module: azure.mgmt.scheduler.models +summary: StorageQueueMessage. +constructor: + syntax: 'StorageQueueMessage(*, storage_account: str | None = None, queue_name: + str | None = None, sas_token: str | None = None, message: str | None = None, **kwargs)' + parameters: + - name: storage_account + description: Gets or sets the storage account name. + isRequired: true + types: + - + - name: queue_name + description: Gets or sets the queue name. + isRequired: true + types: + - + - name: sas_token + description: Gets or sets the SAS key. + isRequired: true + types: + - + - name: message + description: Gets or sets the message. + isRequired: true + types: + - + keywordOnlyParameters: + - name: storage_account + isRequired: true + - name: queue_name + isRequired: true + - name: sas_token + isRequired: true + - name: message + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.yml new file mode 100644 index 00000000..38e8f0cc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.yml @@ -0,0 +1,52 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.scheduler.models +name: models +fullName: azure.mgmt.scheduler.models +type: import +classes: +- azure.mgmt.scheduler.models.BasicAuthentication +- azure.mgmt.scheduler.models.ClientCertAuthentication +- azure.mgmt.scheduler.models.HttpAuthentication +- azure.mgmt.scheduler.models.HttpRequest +- azure.mgmt.scheduler.models.JobAction +- azure.mgmt.scheduler.models.JobCollectionDefinition +- azure.mgmt.scheduler.models.JobCollectionListResult +- azure.mgmt.scheduler.models.JobCollectionProperties +- azure.mgmt.scheduler.models.JobCollectionQuota +- azure.mgmt.scheduler.models.JobDefinition +- azure.mgmt.scheduler.models.JobErrorAction +- azure.mgmt.scheduler.models.JobHistoryDefinition +- azure.mgmt.scheduler.models.JobHistoryDefinitionProperties +- azure.mgmt.scheduler.models.JobHistoryFilter +- azure.mgmt.scheduler.models.JobHistoryListResult +- azure.mgmt.scheduler.models.JobListResult +- azure.mgmt.scheduler.models.JobMaxRecurrence +- azure.mgmt.scheduler.models.JobProperties +- azure.mgmt.scheduler.models.JobRecurrence +- azure.mgmt.scheduler.models.JobRecurrenceSchedule +- azure.mgmt.scheduler.models.JobRecurrenceScheduleMonthlyOccurrence +- azure.mgmt.scheduler.models.JobStateFilter +- azure.mgmt.scheduler.models.JobStatus +- azure.mgmt.scheduler.models.OAuthAuthentication +- azure.mgmt.scheduler.models.RetryPolicy +- azure.mgmt.scheduler.models.ServiceBusAuthentication +- azure.mgmt.scheduler.models.ServiceBusBrokeredMessageProperties +- azure.mgmt.scheduler.models.ServiceBusMessage +- azure.mgmt.scheduler.models.ServiceBusQueueMessage +- azure.mgmt.scheduler.models.ServiceBusTopicMessage +- azure.mgmt.scheduler.models.Sku +- azure.mgmt.scheduler.models.StorageQueueMessage +enums: +- azure.mgmt.scheduler.models.DayOfWeek +- azure.mgmt.scheduler.models.HttpAuthenticationType +- azure.mgmt.scheduler.models.JobActionType +- azure.mgmt.scheduler.models.JobCollectionState +- azure.mgmt.scheduler.models.JobExecutionStatus +- azure.mgmt.scheduler.models.JobHistoryActionName +- azure.mgmt.scheduler.models.JobScheduleDay +- azure.mgmt.scheduler.models.JobState +- azure.mgmt.scheduler.models.RecurrenceFrequency +- azure.mgmt.scheduler.models.RetryType +- azure.mgmt.scheduler.models.ServiceBusAuthenticationType +- azure.mgmt.scheduler.models.ServiceBusTransportType +- azure.mgmt.scheduler.models.SkuDefinition diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.operations.JobCollectionsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.operations.JobCollectionsOperations.yml new file mode 100644 index 00000000..1470af8b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.operations.JobCollectionsOperations.yml @@ -0,0 +1,296 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.operations.JobCollectionsOperations +name: JobCollectionsOperations +fullName: azure.mgmt.scheduler.operations.JobCollectionsOperations +module: azure.mgmt.scheduler.operations +summary: 'JobCollectionsOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: JobCollectionsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.scheduler.operations.JobCollectionsOperations.begin_delete + name: begin_delete + summary: Deletes a job collection. + signature: 'begin_delete(resource_group_name: str, job_collection_name: str, **kwargs: + Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.operations.JobCollectionsOperations.begin_disable + name: begin_disable + summary: Disables all of the jobs in the job collection. + signature: 'begin_disable(resource_group_name: str, job_collection_name: str, **kwargs: + Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.operations.JobCollectionsOperations.begin_enable + name: begin_enable + summary: Enables all of the jobs in the job collection. + signature: 'begin_enable(resource_group_name: str, job_collection_name: str, **kwargs: + Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.operations.JobCollectionsOperations.create_or_update + name: create_or_update + summary: Provisions a new job collection or updates an existing job collection. + signature: 'create_or_update(resource_group_name: str, job_collection_name: str, + job_collection: ''models.JobCollectionDefinition'', **kwargs: Any) -> models.JobCollectionDefinition' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + - name: job_collection + description: The job collection definition. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: JobCollectionDefinition, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.operations.JobCollectionsOperations.get + name: get + summary: Gets a job collection. + signature: 'get(resource_group_name: str, job_collection_name: str, **kwargs: Any) + -> models.JobCollectionDefinition' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: JobCollectionDefinition, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.operations.JobCollectionsOperations.list_by_resource_group + name: list_by_resource_group + summary: Gets all job collections under specified resource group. + signature: 'list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[''models.JobCollectionListResult'']' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either JobCollectionListResult or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.operations.JobCollectionsOperations.list_by_subscription + name: list_by_subscription + summary: Gets all job collections under specified subscription. + signature: 'list_by_subscription(**kwargs: Any) -> Iterable[''models.JobCollectionListResult'']' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either JobCollectionListResult or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.operations.JobCollectionsOperations.patch + name: patch + summary: Patches an existing job collection. + signature: 'patch(resource_group_name: str, job_collection_name: str, job_collection: + ''models.JobCollectionDefinition'', **kwargs: Any) -> models.JobCollectionDefinition' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + - name: job_collection + description: The job collection definition. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: JobCollectionDefinition, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.scheduler.operations.JobCollectionsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.operations.JobsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.operations.JobsOperations.yml new file mode 100644 index 00000000..cbb5fe66 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.operations.JobsOperations.yml @@ -0,0 +1,304 @@ +### YamlMime:PythonClass +uid: azure.mgmt.scheduler.operations.JobsOperations +name: JobsOperations +fullName: azure.mgmt.scheduler.operations.JobsOperations +module: azure.mgmt.scheduler.operations +summary: 'JobsOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: JobsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.scheduler.operations.JobsOperations.create_or_update + name: create_or_update + summary: Provisions a new job or updates an existing job. + signature: 'create_or_update(resource_group_name: str, job_collection_name: str, + job_name: str, job: ''models.JobDefinition'', **kwargs: Any) -> models.JobDefinition' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + - name: job_name + description: The job name. + isRequired: true + types: + - + - name: job + description: The job definition. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: JobDefinition, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.operations.JobsOperations.delete + name: delete + summary: Deletes a job. + signature: 'delete(resource_group_name: str, job_collection_name: str, job_name: + str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + - name: job_name + description: The job name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.operations.JobsOperations.get + name: get + summary: Gets a job. + signature: 'get(resource_group_name: str, job_collection_name: str, job_name: str, + **kwargs: Any) -> models.JobDefinition' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + - name: job_name + description: The job name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: JobDefinition, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.operations.JobsOperations.list + name: list + summary: Lists all jobs under the specified job collection. + signature: 'list(resource_group_name: str, job_collection_name: str, top: int | + None = None, skip: int | None = None, filter: str | None = None, **kwargs: Any) + -> Iterable[''models.JobListResult'']' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + - name: top + description: The number of jobs to request, in the of range of [1..100]. + defaultValue: None + types: + - + - name: skip + description: 'The (0-based) index of the job history list from which to begin + requesting + + entries.' + defaultValue: None + types: + - + - name: filter + description: The filter to apply on the job state. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either JobListResult or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.operations.JobsOperations.list_job_history + name: list_job_history + summary: Lists job history. + signature: 'list_job_history(resource_group_name: str, job_collection_name: str, + job_name: str, top: int | None = None, skip: int | None = None, filter: str | + None = None, **kwargs: Any) -> Iterable[''models.JobHistoryListResult'']' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + - name: job_name + description: The job name. + isRequired: true + types: + - + - name: top + description: the number of job history to request, in the of range of [1..100]. + defaultValue: None + types: + - + - name: skip + description: 'The (0-based) index of the job history list from which to begin + requesting + + entries.' + defaultValue: None + types: + - + - name: filter + description: The filter to apply on the job state. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either JobHistoryListResult or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.operations.JobsOperations.patch + name: patch + summary: Patches an existing job. + signature: 'patch(resource_group_name: str, job_collection_name: str, job_name: + str, job: ''models.JobDefinition'', **kwargs: Any) -> models.JobDefinition' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + - name: job_name + description: The job name. + isRequired: true + types: + - + - name: job + description: The job definition. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: JobDefinition, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.scheduler.operations.JobsOperations.run + name: run + summary: Runs a job. + signature: 'run(resource_group_name: str, job_collection_name: str, job_name: str, + **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The resource group name. + isRequired: true + types: + - + - name: job_collection_name + description: The job collection name. + isRequired: true + types: + - + - name: job_name + description: The job name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.scheduler.operations.JobsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.operations.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.operations.yml new file mode 100644 index 00000000..e217a867 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.operations.yml @@ -0,0 +1,8 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.scheduler.operations +name: operations +fullName: azure.mgmt.scheduler.operations +type: import +classes: +- azure.mgmt.scheduler.operations.JobCollectionsOperations +- azure.mgmt.scheduler.operations.JobsOperations diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.patch.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.patch.yml new file mode 100644 index 00000000..c2bed4cd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.patch.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonModule +uid: azure.mgmt.scheduler.patch +name: patch +fullName: azure.mgmt.scheduler.patch +functions: +- uid: azure.mgmt.scheduler.patch.deserialize_scheduler_duration + name: deserialize_scheduler_duration + signature: deserialize_scheduler_duration(attr, **kwargs) + parameters: + - name: attr + isRequired: true +- uid: azure.mgmt.scheduler.patch.from_iso8601_to_timespan + name: from_iso8601_to_timespan + signature: from_iso8601_to_timespan(iso_str) + parameters: + - name: iso_str + isRequired: true +- uid: azure.mgmt.scheduler.patch.from_timespan_to_iso8601 + name: from_timespan_to_iso8601 + signature: from_timespan_to_iso8601(timespan_str) + parameters: + - name: timespan_str + isRequired: true +- uid: azure.mgmt.scheduler.patch.patch_client + name: patch_client + signature: patch_client(client) + parameters: + - name: client + isRequired: true +- uid: azure.mgmt.scheduler.patch.serialize_scheduler_duration + name: serialize_scheduler_duration + signature: serialize_scheduler_duration(attr, **kwargs) + parameters: + - name: attr + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.yml new file mode 100644 index 00000000..2660b88d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.scheduler +name: scheduler +fullName: azure.mgmt.scheduler +type: rootImport +classes: +- azure.mgmt.scheduler.SchedulerManagementClient +packages: +- azure.mgmt.scheduler.aio +- azure.mgmt.scheduler.models +- azure.mgmt.scheduler.operations +modules: +- azure.mgmt.scheduler.patch diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.StorageImportExport.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.StorageImportExport.yml new file mode 100644 index 00000000..cb38b1fa --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.StorageImportExport.yml @@ -0,0 +1,63 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.StorageImportExport +name: StorageImportExport +fullName: azure.mgmt.storageimportexport.StorageImportExport +module: azure.mgmt.storageimportexport +summary: The Storage Import/Export Resource Provider API. +constructor: + syntax: 'StorageImportExport(credential: TokenCredential, subscription_id: str, + accept_language: str | None = None, base_url: str = ''https://management.azure.com'', + **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. Required. + isRequired: true + types: + - + - name: subscription_id + description: The subscription ID for the Azure user. Required. + isRequired: true + types: + - + - name: accept_language + description: 'Specifies the preferred language for the response. Default value + is + + None.' + defaultValue: None + types: + - + - name: base_url + description: Service URL. Default value is "`https://management.azure.com`". + defaultValue: https://management.azure.com + types: + - + keywordOnlyParameters: + - name: api_version + description: 'Api Version. Default value is "2021-01-01". Note that overriding + this + + default value may result in unsupported behavior.' + types: + - +variables: +- description: LocationsOperations operations + name: locations + types: + - +- description: JobsOperations operations + name: jobs + types: + - +- description: BitLockerKeysOperations operations + name: bit_locker_keys + types: + - +- description: Operations operations + name: operations + types: + - +methods: +- uid: azure.mgmt.storageimportexport.StorageImportExport.close + name: close + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.StorageImportExport.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.StorageImportExport.yml new file mode 100644 index 00000000..45037c58 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.StorageImportExport.yml @@ -0,0 +1,63 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.aio.StorageImportExport +name: StorageImportExport +fullName: azure.mgmt.storageimportexport.aio.StorageImportExport +module: azure.mgmt.storageimportexport.aio +summary: The Storage Import/Export Resource Provider API. +constructor: + syntax: 'StorageImportExport(credential: AsyncTokenCredential, subscription_id: + str, accept_language: str | None = None, base_url: str = ''https://management.azure.com'', + **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. Required. + isRequired: true + types: + - + - name: subscription_id + description: The subscription ID for the Azure user. Required. + isRequired: true + types: + - + - name: accept_language + description: 'Specifies the preferred language for the response. Default value + is + + None.' + defaultValue: None + types: + - + - name: base_url + description: Service URL. Default value is "`https://management.azure.com`". + defaultValue: https://management.azure.com + types: + - + keywordOnlyParameters: + - name: api_version + description: 'Api Version. Default value is "2021-01-01". Note that overriding + this + + default value may result in unsupported behavior.' + types: + - +variables: +- description: LocationsOperations operations + name: locations + types: + - +- description: JobsOperations operations + name: jobs + types: + - +- description: BitLockerKeysOperations operations + name: bit_locker_keys + types: + - +- description: Operations operations + name: operations + types: + - +methods: +- uid: azure.mgmt.storageimportexport.aio.StorageImportExport.close + name: close + signature: async close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.BitLockerKeysOperations.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.BitLockerKeysOperations.yml new file mode 100644 index 00000000..da882f81 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.BitLockerKeysOperations.yml @@ -0,0 +1,44 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.aio.operations.BitLockerKeysOperations +name: BitLockerKeysOperations +fullName: azure.mgmt.storageimportexport.aio.operations.BitLockerKeysOperations +module: azure.mgmt.storageimportexport.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: BitLockerKeysOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.storageimportexport.aio.operations.BitLockerKeysOperations.list + name: list + summary: Returns the BitLocker Keys for all drives in the specified job. + signature: 'list(job_name: str, resource_group_name: str, **kwargs: Any) -> AsyncIterable[DriveBitLockerKey]' + parameters: + - name: job_name + description: The name of the import/export job. Required. + isRequired: true + types: + - + - name: resource_group_name + description: 'The resource group name uniquely identifies the resource group + + within the user subscription. Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either DriveBitLockerKey or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.storageimportexport.aio.operations.BitLockerKeysOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.JobsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.JobsOperations.yml new file mode 100644 index 00000000..94e9df1d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.JobsOperations.yml @@ -0,0 +1,250 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.aio.operations.JobsOperations +name: JobsOperations +fullName: azure.mgmt.storageimportexport.aio.operations.JobsOperations +module: azure.mgmt.storageimportexport.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: JobsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.storageimportexport.aio.operations.JobsOperations.create + name: create + summary: Creates a new job or updates an existing job in the specified subscription. + signature: 'async create(job_name: str, resource_group_name: str, body: _models.PutJobParameters, + client_tenant_id: str | None = None, *, content_type: str = ''application/json'', + **kwargs: Any) -> _models.JobResponse' + parameters: + - name: job_name + description: The name of the import/export job. Required. + isRequired: true + types: + - + - name: resource_group_name + description: 'The resource group name uniquely identifies the resource group + + within the user subscription. Required.' + isRequired: true + types: + - + - name: body + description: 'The parameters used for creating the job. Is either a model type + or a IO type. + + Required.' + isRequired: true + types: + - + - + - name: client_tenant_id + description: The tenant ID of the client making the request. Default value is + None. + isRequired: true + types: + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: JobResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.storageimportexport.aio.operations.JobsOperations.delete + name: delete + summary: Deletes an existing job. Only jobs in the Creating or Completed states + can be deleted. + signature: 'async delete(job_name: str, resource_group_name: str, **kwargs: Any) + -> None' + parameters: + - name: job_name + description: The name of the import/export job. Required. + isRequired: true + types: + - + - name: resource_group_name + description: 'The resource group name uniquely identifies the resource group + + within the user subscription. Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.storageimportexport.aio.operations.JobsOperations.get + name: get + summary: Gets information about an existing job. + signature: 'async get(job_name: str, resource_group_name: str, **kwargs: Any) -> + JobResponse' + parameters: + - name: job_name + description: The name of the import/export job. Required. + isRequired: true + types: + - + - name: resource_group_name + description: 'The resource group name uniquely identifies the resource group + + within the user subscription. Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: JobResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.storageimportexport.aio.operations.JobsOperations.list_by_resource_group + name: list_by_resource_group + summary: Returns all active and completed jobs in a resource group. + signature: 'list_by_resource_group(resource_group_name: str, top: int | None = None, + filter: str | None = None, **kwargs: Any) -> AsyncIterable[JobResponse]' + parameters: + - name: resource_group_name + description: 'The resource group name uniquely identifies the resource group + + within the user subscription. Required.' + isRequired: true + types: + - + - name: top + description: 'An integer value that specifies how many jobs at most should be + returned. The value + + cannot exceed 100. Default value is None.' + isRequired: true + types: + - + - name: filter + description: 'Can be used to restrict the results to certain conditions. Default + value is + + None.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either JobResponse or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.storageimportexport.aio.operations.JobsOperations.list_by_subscription + name: list_by_subscription + summary: Returns all active and completed jobs in a subscription. + signature: 'list_by_subscription(top: int | None = None, filter: str | None = None, + **kwargs: Any) -> AsyncIterable[JobResponse]' + parameters: + - name: top + description: 'An integer value that specifies how many jobs at most should be + returned. The value + + cannot exceed 100. Default value is None.' + isRequired: true + types: + - + - name: filter + description: 'Can be used to restrict the results to certain conditions. Default + value is + + None.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either JobResponse or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.storageimportexport.aio.operations.JobsOperations.update + name: update + summary: 'Updates specific properties of a job. You can call this operation to notify + the Import/Export + + service that the hard drives comprising the import or export job have been shipped + to the + + Microsoft data center. It can also be used to cancel an existing job.' + signature: 'async update(job_name: str, resource_group_name: str, body: _models.UpdateJobParameters, + *, content_type: str = ''application/json'', **kwargs: Any) -> _models.JobResponse' + parameters: + - name: job_name + description: The name of the import/export job. Required. + isRequired: true + types: + - + - name: resource_group_name + description: 'The resource group name uniquely identifies the resource group + + within the user subscription. Required.' + isRequired: true + types: + - + - name: body + description: 'The parameters to update in the job. Is either a model type or a + IO type. + + Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: JobResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.storageimportexport.aio.operations.JobsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.LocationsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.LocationsOperations.yml new file mode 100644 index 00000000..c232952a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.LocationsOperations.yml @@ -0,0 +1,57 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.aio.operations.LocationsOperations +name: LocationsOperations +fullName: azure.mgmt.storageimportexport.aio.operations.LocationsOperations +module: azure.mgmt.storageimportexport.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: LocationsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.storageimportexport.aio.operations.LocationsOperations.get + name: get + summary: 'Returns the details about a location to which you can ship the disks associated + with an import + + or export job. A location is an Azure region.' + signature: 'async get(location_name: str, **kwargs: Any) -> Location' + parameters: + - name: location_name + description: The name of the location. For example, West US or westus. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Location or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.storageimportexport.aio.operations.LocationsOperations.list + name: list + summary: 'Returns a list of locations to which you can ship the disks associated + with an import or export + + job. A location is a Microsoft data center region.' + signature: 'list(**kwargs: Any) -> AsyncIterable[Location]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either Location or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.storageimportexport.aio.operations.LocationsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.Operations.yml new file mode 100644 index 00000000..a235a194 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.Operations.yml @@ -0,0 +1,31 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.aio.operations.Operations +name: Operations +fullName: azure.mgmt.storageimportexport.aio.operations.Operations +module: azure.mgmt.storageimportexport.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: Operations(*args, **kwargs) +methods: +- uid: azure.mgmt.storageimportexport.aio.operations.Operations.list + name: list + summary: Returns the list of operations supported by the import/export resource + provider. + signature: 'list(**kwargs: Any) -> AsyncIterable[Operation]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either Operation or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.storageimportexport.aio.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.yml new file mode 100644 index 00000000..b57636d9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.storageimportexport.aio.operations +name: operations +fullName: azure.mgmt.storageimportexport.aio.operations +type: import +classes: +- azure.mgmt.storageimportexport.aio.operations.BitLockerKeysOperations +- azure.mgmt.storageimportexport.aio.operations.JobsOperations +- azure.mgmt.storageimportexport.aio.operations.LocationsOperations +- azure.mgmt.storageimportexport.aio.operations.Operations diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.yml new file mode 100644 index 00000000..4abdd5d0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.storageimportexport.aio +name: aio +fullName: azure.mgmt.storageimportexport.aio +type: import +classes: +- azure.mgmt.storageimportexport.aio.StorageImportExport +packages: +- azure.mgmt.storageimportexport.aio.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.CreatedByType.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.CreatedByType.yml new file mode 100644 index 00000000..37dec5c6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.CreatedByType.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.storageimportexport.models.CreatedByType +name: CreatedByType +fullName: azure.mgmt.storageimportexport.models.CreatedByType +summary: The type of identity that created the resource. +module: azure.mgmt.storageimportexport.models +fields: +- name: APPLICATION + uid: azure.mgmt.storageimportexport.models.CreatedByType.APPLICATION +- name: KEY + uid: azure.mgmt.storageimportexport.models.CreatedByType.KEY +- name: MANAGED_IDENTITY + uid: azure.mgmt.storageimportexport.models.CreatedByType.MANAGED_IDENTITY +- name: USER + uid: azure.mgmt.storageimportexport.models.CreatedByType.USER diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DeliveryPackageInformation.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DeliveryPackageInformation.yml new file mode 100644 index 00000000..a4fb1655 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DeliveryPackageInformation.yml @@ -0,0 +1,52 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.models.DeliveryPackageInformation +name: DeliveryPackageInformation +fullName: azure.mgmt.storageimportexport.models.DeliveryPackageInformation +module: azure.mgmt.storageimportexport.models +summary: 'Contains information about the delivery package being shipped by the customer + to the Microsoft data center. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DeliveryPackageInformation(*, carrier_name: str, tracking_number: str, + drive_count: int | None = None, ship_date: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: carrier_name + description: 'The name of the carrier that is used to ship the import or export + + drives. Required.' + types: + - + - name: tracking_number + description: The tracking number of the package. Required. + types: + - + - name: drive_count + description: The number of drives included in the package. + types: + - + - name: ship_date + description: The date when the package is shipped. + types: + - +variables: +- description: 'The name of the carrier that is used to ship the import or export + drives. + + Required.' + name: carrier_name + types: + - +- description: The tracking number of the package. Required. + name: tracking_number + types: + - +- description: The number of drives included in the package. + name: drive_count + types: + - +- description: The date when the package is shipped. + name: ship_date + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DriveBitLockerKey.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DriveBitLockerKey.yml new file mode 100644 index 00000000..80f595d4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DriveBitLockerKey.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.models.DriveBitLockerKey +name: DriveBitLockerKey +fullName: azure.mgmt.storageimportexport.models.DriveBitLockerKey +module: azure.mgmt.storageimportexport.models +summary: BitLocker recovery key or password to the specified drive. +constructor: + syntax: 'DriveBitLockerKey(*, bit_locker_key: str | None = None, drive_id: str | + None = None, **kwargs)' + keywordOnlyParameters: + - name: bit_locker_key + description: BitLocker recovery key or password. + types: + - + - name: drive_id + description: Drive ID. + types: + - +variables: +- description: BitLocker recovery key or password. + name: bit_locker_key + types: + - +- description: Drive ID. + name: drive_id + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DriveState.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DriveState.yml new file mode 100644 index 00000000..ea30c61e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DriveState.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.storageimportexport.models.DriveState +name: DriveState +fullName: azure.mgmt.storageimportexport.models.DriveState +summary: The drive's current state. +module: azure.mgmt.storageimportexport.models +fields: +- name: COMPLETED + uid: azure.mgmt.storageimportexport.models.DriveState.COMPLETED +- name: COMPLETED_MORE_INFO + uid: azure.mgmt.storageimportexport.models.DriveState.COMPLETED_MORE_INFO +- name: NEVER_RECEIVED + uid: azure.mgmt.storageimportexport.models.DriveState.NEVER_RECEIVED +- name: RECEIVED + uid: azure.mgmt.storageimportexport.models.DriveState.RECEIVED +- name: SHIPPED_BACK + uid: azure.mgmt.storageimportexport.models.DriveState.SHIPPED_BACK +- name: SPECIFIED + uid: azure.mgmt.storageimportexport.models.DriveState.SPECIFIED +- name: TRANSFERRING + uid: azure.mgmt.storageimportexport.models.DriveState.TRANSFERRING diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DriveStatus.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DriveStatus.yml new file mode 100644 index 00000000..5cef2d89 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DriveStatus.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.models.DriveStatus +name: DriveStatus +fullName: azure.mgmt.storageimportexport.models.DriveStatus +module: azure.mgmt.storageimportexport.models +summary: Provides information about the drive's status. +constructor: + syntax: 'DriveStatus(*, drive_id: str | None = None, bit_locker_key: str | None + = None, manifest_file: str | None = None, manifest_hash: str | None = None, drive_header_hash: + str | None = None, state: str | _models.DriveState = ''Specified'', copy_status: + str | None = None, percent_complete: int | None = None, verbose_log_uri: str | + None = None, error_log_uri: str | None = None, manifest_uri: str | None = None, + bytes_succeeded: int | None = None, **kwargs)' + keywordOnlyParameters: + - name: drive_id + description: The drive's hardware serial number, without spaces. + types: + - + - name: bit_locker_key + description: The BitLocker key used to encrypt the drive. + types: + - + - name: manifest_file + description: The relative path of the manifest file on the drive. + types: + - + - name: manifest_hash + description: The Base16-encoded MD5 hash of the manifest file on the drive. + types: + - + - name: drive_header_hash + description: The drive header hash value. + types: + - + - name: state + description: 'The drive''s current state. Known values are: "Specified", "Received", + + "NeverReceived", "Transferring", "Completed", "CompletedMoreInfo", and "ShippedBack".' + defaultValue: Specified + types: + - + - + - name: copy_status + description: 'Detailed status about the data transfer process. This field is not + + returned in the response until the drive is in the Transferring state.' + types: + - + - name: percent_complete + description: Percentage completed for the drive. + types: + - + - name: verbose_log_uri + description: 'A URI that points to the blob containing the verbose log for the + data + + transfer operation.' + types: + - + - name: error_log_uri + description: 'A URI that points to the blob containing the error log for the data + + transfer operation.' + types: + - + - name: manifest_uri + description: A URI that points to the blob containing the drive manifest file. + types: + - + - name: bytes_succeeded + description: Bytes successfully transferred for the drive. + types: + - +variables: +- description: The drive's hardware serial number, without spaces. + name: drive_id + types: + - +- description: The BitLocker key used to encrypt the drive. + name: bit_locker_key + types: + - +- description: The relative path of the manifest file on the drive. + name: manifest_file + types: + - +- description: The Base16-encoded MD5 hash of the manifest file on the drive. + name: manifest_hash + types: + - +- description: The drive header hash value. + name: drive_header_hash + types: + - +- description: 'The drive''s current state. Known values are: "Specified", "Received", + + "NeverReceived", "Transferring", "Completed", "CompletedMoreInfo", and "ShippedBack".' + name: state + types: + - + - +- description: 'Detailed status about the data transfer process. This field is not + returned + + in the response until the drive is in the Transferring state.' + name: copy_status + types: + - +- description: Percentage completed for the drive. + name: percent_complete + types: + - +- description: 'A URI that points to the blob containing the verbose log for the data + + transfer operation.' + name: verbose_log_uri + types: + - +- description: 'A URI that points to the blob containing the error log for the data + + transfer operation.' + name: error_log_uri + types: + - +- description: A URI that points to the blob containing the drive manifest file. + name: manifest_uri + types: + - +- description: Bytes successfully transferred for the drive. + name: bytes_succeeded + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.EncryptionKekType.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.EncryptionKekType.yml new file mode 100644 index 00000000..b4b99257 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.EncryptionKekType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.storageimportexport.models.EncryptionKekType +name: EncryptionKekType +fullName: azure.mgmt.storageimportexport.models.EncryptionKekType +summary: The type of kek encryption key. +module: azure.mgmt.storageimportexport.models +fields: +- name: CUSTOMER_MANAGED + uid: azure.mgmt.storageimportexport.models.EncryptionKekType.CUSTOMER_MANAGED +- name: MICROSOFT_MANAGED + uid: azure.mgmt.storageimportexport.models.EncryptionKekType.MICROSOFT_MANAGED diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.EncryptionKeyDetails.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.EncryptionKeyDetails.yml new file mode 100644 index 00000000..bb6278fa --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.EncryptionKeyDetails.yml @@ -0,0 +1,44 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.models.EncryptionKeyDetails +name: EncryptionKeyDetails +fullName: azure.mgmt.storageimportexport.models.EncryptionKeyDetails +module: azure.mgmt.storageimportexport.models +summary: Specifies the encryption key properties. +constructor: + syntax: 'EncryptionKeyDetails(*, kek_type: str | _models.EncryptionKekType = ''MicrosoftManaged'', + kek_url: str | None = None, kek_vault_resource_id: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: kek_type + description: 'The type of kek encryption key. Known values are: "MicrosoftManaged" + and + + "CustomerManaged".' + defaultValue: MicrosoftManaged + types: + - + - + - name: kek_url + description: Specifies the url for kek encryption key. + types: + - + - name: kek_vault_resource_id + description: Specifies the keyvault resource id for kek encryption key. + types: + - +variables: +- description: 'The type of kek encryption key. Known values are: "MicrosoftManaged" + and + + "CustomerManaged".' + name: kek_type + types: + - + - +- description: Specifies the url for kek encryption key. + name: kek_url + types: + - +- description: Specifies the keyvault resource id for kek encryption key. + name: kek_vault_resource_id + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ErrorResponse.yml new file mode 100644 index 00000000..731ee1d6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ErrorResponse.yml @@ -0,0 +1,52 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.models.ErrorResponse +name: ErrorResponse +fullName: azure.mgmt.storageimportexport.models.ErrorResponse +module: azure.mgmt.storageimportexport.models +summary: Response when errors occurred. +constructor: + syntax: 'ErrorResponse(*, code: str | None = None, message: str | None = None, target: + str | None = None, details: List[_models.ErrorResponseErrorDetailsItem] | None + = None, innererror: MutableMapping[str, Any] | None = None, **kwargs)' + keywordOnlyParameters: + - name: code + description: Provides information about the error code. + types: + - + - name: message + description: Provides information about the error message. + types: + - + - name: target + description: Provides information about the error target. + types: + - + - name: details + description: Describes the error details if present. + types: + - [] + - name: innererror + description: Inner error object if present. + types: + - +variables: +- description: Provides information about the error code. + name: code + types: + - +- description: Provides information about the error message. + name: message + types: + - +- description: Provides information about the error target. + name: target + types: + - +- description: Describes the error details if present. + name: details + types: + - [] +- description: Inner error object if present. + name: innererror + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ErrorResponseErrorDetailsItem.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ErrorResponseErrorDetailsItem.yml new file mode 100644 index 00000000..20807e7c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ErrorResponseErrorDetailsItem.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.models.ErrorResponseErrorDetailsItem +name: ErrorResponseErrorDetailsItem +fullName: azure.mgmt.storageimportexport.models.ErrorResponseErrorDetailsItem +module: azure.mgmt.storageimportexport.models +summary: ErrorResponseErrorDetailsItem. +constructor: + syntax: 'ErrorResponseErrorDetailsItem(*, code: str | None = None, target: str | + None = None, message: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: code + description: Provides information about the error code. + types: + - + - name: target + description: Provides information about the error target. + types: + - + - name: message + description: Provides information about the error message. + types: + - +variables: +- description: Provides information about the error code. + name: code + types: + - +- description: Provides information about the error target. + name: target + types: + - +- description: Provides information about the error message. + name: message + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Export.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Export.yml new file mode 100644 index 00000000..545bd1cf --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Export.yml @@ -0,0 +1,47 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.models.Export +name: Export +fullName: azure.mgmt.storageimportexport.models.Export +module: azure.mgmt.storageimportexport.models +summary: A property containing information about the blobs to be exported for an export + job. This property is required for export jobs, but must not be specified for import + jobs. +constructor: + syntax: 'Export(*, blob_list_blob_path: str | None = None, blob_path: List[str] + | None = None, blob_path_prefix: List[str] | None = None, **kwargs)' + keywordOnlyParameters: + - name: blob_list_blob_path + description: 'The relative URI to the block blob that contains the list of blob + + paths or blob path prefixes as defined above, beginning with the container name. + If the blob is + + in root container, the URI must begin with $root.' + types: + - + - name: blob_path + description: A collection of blob-path strings. + types: + - [] + - name: blob_path_prefix + description: A collection of blob-prefix strings. + types: + - [] +variables: +- description: 'The relative URI to the block blob that contains the list of blob + + paths or blob path prefixes as defined above, beginning with the container name. + If the blob is + + in root container, the URI must begin with $root.' + name: blob_list_blob_path + types: + - +- description: A collection of blob-path strings. + name: blob_path + types: + - [] +- description: A collection of blob-prefix strings. + name: blob_path_prefix + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.GetBitLockerKeysResponse.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.GetBitLockerKeysResponse.yml new file mode 100644 index 00000000..a4d05db8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.GetBitLockerKeysResponse.yml @@ -0,0 +1,19 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.models.GetBitLockerKeysResponse +name: GetBitLockerKeysResponse +fullName: azure.mgmt.storageimportexport.models.GetBitLockerKeysResponse +module: azure.mgmt.storageimportexport.models +summary: GetBitLockerKeys response. +constructor: + syntax: 'GetBitLockerKeysResponse(*, value: List[_models.DriveBitLockerKey] | None + = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: drive status. + types: + - [] +variables: +- description: drive status. + name: value + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.IdentityDetails.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.IdentityDetails.yml new file mode 100644 index 00000000..a50b264e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.IdentityDetails.yml @@ -0,0 +1,38 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.models.IdentityDetails +name: IdentityDetails +fullName: azure.mgmt.storageimportexport.models.IdentityDetails +module: azure.mgmt.storageimportexport.models +summary: 'Specifies the identity properties. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'IdentityDetails(*, type: str | _models.IdentityType = ''None'', **kwargs)' + keywordOnlyParameters: + - name: type + description: 'The type of identity. Known values are: "None", "SystemAssigned", + and + + "UserAssigned".' + defaultValue: None + types: + - + - +variables: +- description: 'The type of identity. Known values are: "None", "SystemAssigned", + and + + "UserAssigned".' + name: type + types: + - + - +- description: Specifies the principal id for the identity for the job. + name: principal_id + types: + - +- description: Specifies the tenant id for the identity for the job. + name: tenant_id + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.IdentityType.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.IdentityType.yml new file mode 100644 index 00000000..75ee320f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.IdentityType.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.storageimportexport.models.IdentityType +name: IdentityType +fullName: azure.mgmt.storageimportexport.models.IdentityType +summary: The type of identity. +module: azure.mgmt.storageimportexport.models +fields: +- name: NONE + uid: azure.mgmt.storageimportexport.models.IdentityType.NONE +- name: SYSTEM_ASSIGNED + uid: azure.mgmt.storageimportexport.models.IdentityType.SYSTEM_ASSIGNED +- name: USER_ASSIGNED + uid: azure.mgmt.storageimportexport.models.IdentityType.USER_ASSIGNED diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.JobDetails.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.JobDetails.yml new file mode 100644 index 00000000..461b169f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.JobDetails.yml @@ -0,0 +1,227 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.models.JobDetails +name: JobDetails +fullName: azure.mgmt.storageimportexport.models.JobDetails +module: azure.mgmt.storageimportexport.models +summary: Specifies the job properties. +constructor: + syntax: 'JobDetails(*, storage_account_id: str | None = None, job_type: str | None + = None, return_address: _models.ReturnAddress | None = None, return_shipping: + _models.ReturnShipping | None = None, shipping_information: _models.ShippingInformation + | None = None, delivery_package: _models.DeliveryPackageInformation | None = None, + return_package: _models.PackageInformation | None = None, diagnostics_path: str + | None = None, log_level: str | None = None, backup_drive_manifest: bool = False, + state: str = ''Creating'', cancel_requested: bool = False, percent_complete: int + | None = None, incomplete_blob_list_uri: str | None = None, drive_list: List[_models.DriveStatus] + | None = None, export: _models.Export | None = None, provisioning_state: str | + None = None, encryption_key: _models.EncryptionKeyDetails | None = None, **kwargs)' + keywordOnlyParameters: + - name: storage_account_id + description: 'The resource identifier of the storage account where data will be + + imported to or exported from.' + types: + - + - name: job_type + description: The type of job. + types: + - + - name: return_address + description: Specifies the return address information for the job. + types: + - + - name: return_shipping + description: Specifies the return carrier and customer's account with the carrier. + types: + - + - name: shipping_information + description: 'Contains information about the Microsoft datacenter to which the + + drives should be shipped.' + types: + - + - name: delivery_package + description: 'Contains information about the package being shipped by the customer + + to the Microsoft data center.' + types: + - + - name: return_package + description: 'Contains information about the package being shipped from the + + Microsoft data center to the customer to return the drives. The format is the + same as the + + deliveryPackage property above. This property is not included if the drives + have not yet been + + returned.' + types: + - + - name: diagnostics_path + description: 'The virtual blob directory to which the copy logs and backups of + + drive manifest files (if enabled) will be stored.' + types: + - + - name: log_level + description: 'Default value is Error. Indicates whether error logging or verbose + logging + + will be enabled.' + types: + - + - name: backup_drive_manifest + description: 'Default value is false. Indicates whether the manifest files on + + the drives should be copied to block blobs.' + types: + - + - name: state + description: Current state of the job. + defaultValue: Creating + types: + - + - name: cancel_requested + description: Indicates whether a request has been submitted to cancel the job. + types: + - + - name: percent_complete + description: Overall percentage completed for the job. + types: + - + - name: incomplete_blob_list_uri + description: 'A blob path that points to a block blob containing a list of + + blob names that were not exported due to insufficient drive space. If all blobs + were exported + + successfully, then this element is not included in the response.' + types: + - + - name: drive_list + description: 'List of up to ten drives that comprise the job. The drive list is + a + + required element for an import job; it is not specified for export jobs.' + types: + - [] + - name: export + description: 'A property containing information about the blobs to be exported + for an export + + job. This property is included for export jobs only.' + types: + - + - name: provisioning_state + description: Specifies the provisioning state of the job. + types: + - + - name: encryption_key + description: Contains information about the encryption key. + types: + - +variables: +- description: 'The resource identifier of the storage account where data will be + + imported to or exported from.' + name: storage_account_id + types: + - +- description: The type of job. + name: job_type + types: + - +- description: Specifies the return address information for the job. + name: return_address + types: + - +- description: Specifies the return carrier and customer's account with the carrier. + name: return_shipping + types: + - +- description: 'Contains information about the Microsoft datacenter to which the + + drives should be shipped.' + name: shipping_information + types: + - +- description: 'Contains information about the package being shipped by the customer + to + + the Microsoft data center.' + name: delivery_package + types: + - +- description: 'Contains information about the package being shipped from the Microsoft + + data center to the customer to return the drives. The format is the same as the + deliveryPackage + + property above. This property is not included if the drives have not yet been + returned.' + name: return_package + types: + - +- description: 'The virtual blob directory to which the copy logs and backups of drive + + manifest files (if enabled) will be stored.' + name: diagnostics_path + types: + - +- description: 'Default value is Error. Indicates whether error logging or verbose + logging + + will be enabled.' + name: log_level + types: + - +- description: 'Default value is false. Indicates whether the manifest files on + + the drives should be copied to block blobs.' + name: backup_drive_manifest + types: + - +- description: Current state of the job. + name: state + types: + - +- description: Indicates whether a request has been submitted to cancel the job. + name: cancel_requested + types: + - +- description: Overall percentage completed for the job. + name: percent_complete + types: + - +- description: 'A blob path that points to a block blob containing a list of + + blob names that were not exported due to insufficient drive space. If all blobs + were exported + + successfully, then this element is not included in the response.' + name: incomplete_blob_list_uri + types: + - +- description: 'List of up to ten drives that comprise the job. The drive list is + a required + + element for an import job; it is not specified for export jobs.' + name: drive_list + types: + - [] +- description: 'A property containing information about the blobs to be exported for + an export + + job. This property is included for export jobs only.' + name: export + types: + - +- description: Specifies the provisioning state of the job. + name: provisioning_state + types: + - +- description: Contains information about the encryption key. + name: encryption_key + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.JobResponse.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.JobResponse.yml new file mode 100644 index 00000000..492c22aa --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.JobResponse.yml @@ -0,0 +1,63 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.models.JobResponse +name: JobResponse +fullName: azure.mgmt.storageimportexport.models.JobResponse +module: azure.mgmt.storageimportexport.models +summary: 'Contains the job information. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'JobResponse(*, location: str | None = None, tags: MutableMapping[str, Any] + | None = None, properties: _models.JobDetails | None = None, identity: _models.IdentityDetails + | None = None, **kwargs)' + keywordOnlyParameters: + - name: location + description: Specifies the Azure location where the job is created. + types: + - + - name: tags + description: Specifies the tags that are assigned to the job. + types: + - + - name: properties + description: Specifies the job properties. + types: + - + - name: identity + description: Specifies the job identity details. + types: + - +variables: +- description: SystemData of ImportExport Jobs. + name: system_data + types: + - +- description: Specifies the resource identifier of the job. + name: id + types: + - +- description: Specifies the name of the job. + name: name + types: + - +- description: Specifies the type of the job resource. + name: type + types: + - +- description: Specifies the Azure location where the job is created. + name: location + types: + - +- description: Specifies the tags that are assigned to the job. + name: tags + types: + - +- description: Specifies the job properties. + name: properties + types: + - +- description: Specifies the job identity details. + name: identity + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ListJobsResponse.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ListJobsResponse.yml new file mode 100644 index 00000000..a4cf5546 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ListJobsResponse.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.models.ListJobsResponse +name: ListJobsResponse +fullName: azure.mgmt.storageimportexport.models.ListJobsResponse +module: azure.mgmt.storageimportexport.models +summary: List jobs response. +constructor: + syntax: 'ListJobsResponse(*, next_link: str | None = None, value: List[_models.JobResponse] + | None = None, **kwargs)' + keywordOnlyParameters: + - name: next_link + description: link to next batch of jobs. + types: + - + - name: value + description: Job list. + types: + - [] +variables: +- description: link to next batch of jobs. + name: next_link + types: + - +- description: Job list. + name: value + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ListOperationsResponse.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ListOperationsResponse.yml new file mode 100644 index 00000000..f53b9b80 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ListOperationsResponse.yml @@ -0,0 +1,19 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.models.ListOperationsResponse +name: ListOperationsResponse +fullName: azure.mgmt.storageimportexport.models.ListOperationsResponse +module: azure.mgmt.storageimportexport.models +summary: List operations response. +constructor: + syntax: 'ListOperationsResponse(*, value: List[_models.Operation] | None = None, + **kwargs)' + keywordOnlyParameters: + - name: value + description: operations. + types: + - [] +variables: +- description: operations. + name: value + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Location.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Location.yml new file mode 100644 index 00000000..176ed242 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Location.yml @@ -0,0 +1,178 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.models.Location +name: Location +fullName: azure.mgmt.storageimportexport.models.Location +module: azure.mgmt.storageimportexport.models +summary: Provides information about an Azure data center location. +constructor: + syntax: 'Location(*, id: str | None = None, name: str | None = None, type: str | + None = None, recipient_name: str | None = None, street_address1: str | None = + None, street_address2: str | None = None, city: str | None = None, state_or_province: + str | None = None, postal_code: str | None = None, country_or_region: str | None + = None, phone: str | None = None, additional_shipping_information: str | None + = None, supported_carriers: List[str] | None = None, alternate_locations: List[str] + | None = None, **kwargs)' + keywordOnlyParameters: + - name: id + description: Specifies the resource identifier of the location. + types: + - + - name: name + description: 'Specifies the name of the location. Use List Locations to get all + supported + + locations.' + types: + - + - name: type + description: Specifies the type of the location. + types: + - + - name: recipient_name + description: 'The recipient name to use when shipping the drives to the Azure + data + + center.' + types: + - + - name: street_address1 + description: 'The first line of the street address to use when shipping the drives + + to the Azure data center.' + types: + - + - name: street_address2 + description: 'The second line of the street address to use when shipping the drives + + to the Azure data center.' + types: + - + - name: city + description: The city name to use when shipping the drives to the Azure data center. + types: + - + - name: state_or_province + description: 'The state or province to use when shipping the drives to the Azure + + data center.' + types: + - + - name: postal_code + description: The postal code to use when shipping the drives to the Azure data + center. + types: + - + - name: country_or_region + description: 'The country or region to use when shipping the drives to the Azure + + data center.' + types: + - + - name: phone + description: The phone number for the Azure data center. + types: + - + - name: additional_shipping_information + description: 'Additional shipping information for customer, + + specific to datacenter to which customer should send their disks.' + types: + - + - name: supported_carriers + description: A list of carriers that are supported at this location. + types: + - [] + - name: alternate_locations + description: 'A list of location IDs that should be used to ship shipping + + drives to for jobs created against the current location. If the current location + is active, it + + will be part of the list. If it is temporarily closed due to maintenance, this + list may contain + + other locations.' + types: + - [] +variables: +- description: Specifies the resource identifier of the location. + name: id + types: + - +- description: 'Specifies the name of the location. Use List Locations to get all + supported + + locations.' + name: name + types: + - +- description: Specifies the type of the location. + name: type + types: + - +- description: 'The recipient name to use when shipping the drives to the Azure data + + center.' + name: recipient_name + types: + - +- description: 'The first line of the street address to use when shipping the drives + to + + the Azure data center.' + name: street_address1 + types: + - +- description: 'The second line of the street address to use when shipping the drives + to + + the Azure data center.' + name: street_address2 + types: + - +- description: The city name to use when shipping the drives to the Azure data center. + name: city + types: + - +- description: 'The state or province to use when shipping the drives to the Azure + + data center.' + name: state_or_province + types: + - +- description: The postal code to use when shipping the drives to the Azure data center. + name: postal_code + types: + - +- description: 'The country or region to use when shipping the drives to the Azure + + data center.' + name: country_or_region + types: + - +- description: The phone number for the Azure data center. + name: phone + types: + - +- description: 'Additional shipping information for customer, specific + + to datacenter to which customer should send their disks.' + name: additional_shipping_information + types: + - +- description: A list of carriers that are supported at this location. + name: supported_carriers + types: + - [] +- description: 'A list of location IDs that should be used to ship shipping drives + + to for jobs created against the current location. If the current location is active, + it will be + + part of the list. If it is temporarily closed due to maintenance, this list may + contain other + + locations.' + name: alternate_locations + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.LocationsResponse.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.LocationsResponse.yml new file mode 100644 index 00000000..2bb34fd4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.LocationsResponse.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.models.LocationsResponse +name: LocationsResponse +fullName: azure.mgmt.storageimportexport.models.LocationsResponse +module: azure.mgmt.storageimportexport.models +summary: Locations response. +constructor: + syntax: 'LocationsResponse(*, value: List[_models.Location] | None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: locations. + types: + - [] +variables: +- description: locations. + name: value + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Operation.yml new file mode 100644 index 00000000..a579062d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Operation.yml @@ -0,0 +1,54 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.models.Operation +name: Operation +fullName: azure.mgmt.storageimportexport.models.Operation +module: azure.mgmt.storageimportexport.models +summary: 'Describes a supported operation by the Storage Import/Export job API. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Operation(*, name: str, provider: str | None = None, resource: str | None + = None, operation: str | None = None, description: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Name of the operation. Required. + types: + - + - name: provider + description: The resource provider name to which the operation belongs. + types: + - + - name: resource + description: The name of the resource to which the operation belongs. + types: + - + - name: operation + description: The display name of the operation. + types: + - + - name: description + description: Short description of the operation. + types: + - +variables: +- description: Name of the operation. Required. + name: name + types: + - +- description: The resource provider name to which the operation belongs. + name: provider + types: + - +- description: The name of the resource to which the operation belongs. + name: resource + types: + - +- description: The display name of the operation. + name: operation + types: + - +- description: Short description of the operation. + name: description + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.PackageInformation.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.PackageInformation.yml new file mode 100644 index 00000000..a1a9d0cc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.PackageInformation.yml @@ -0,0 +1,52 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.models.PackageInformation +name: PackageInformation +fullName: azure.mgmt.storageimportexport.models.PackageInformation +module: azure.mgmt.storageimportexport.models +summary: 'Contains information about the package being shipped by the customer to + the Microsoft data center. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PackageInformation(*, carrier_name: str, tracking_number: str, drive_count: + int, ship_date: str, **kwargs)' + keywordOnlyParameters: + - name: carrier_name + description: 'The name of the carrier that is used to ship the import or export + + drives. Required.' + types: + - + - name: tracking_number + description: The tracking number of the package. Required. + types: + - + - name: drive_count + description: The number of drives included in the package. Required. + types: + - + - name: ship_date + description: The date when the package is shipped. Required. + types: + - +variables: +- description: 'The name of the carrier that is used to ship the import or export + drives. + + Required.' + name: carrier_name + types: + - +- description: The tracking number of the package. Required. + name: tracking_number + types: + - +- description: The number of drives included in the package. Required. + name: drive_count + types: + - +- description: The date when the package is shipped. Required. + name: ship_date + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.PutJobParameters.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.PutJobParameters.yml new file mode 100644 index 00000000..f3ed9f8b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.PutJobParameters.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.models.PutJobParameters +name: PutJobParameters +fullName: azure.mgmt.storageimportexport.models.PutJobParameters +module: azure.mgmt.storageimportexport.models +summary: Put Job parameters. +constructor: + syntax: 'PutJobParameters(*, location: str | None = None, tags: MutableMapping[str, + Any] | None = None, properties: _models.JobDetails | None = None, **kwargs)' + keywordOnlyParameters: + - name: location + description: Specifies the supported Azure location where the job should be created. + types: + - + - name: tags + description: Specifies the tags that will be assigned to the job. + types: + - + - name: properties + description: Specifies the job properties. + types: + - +variables: +- description: Specifies the supported Azure location where the job should be created. + name: location + types: + - +- description: Specifies the tags that will be assigned to the job. + name: tags + types: + - +- description: Specifies the job properties. + name: properties + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ReturnAddress.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ReturnAddress.yml new file mode 100644 index 00000000..c83494a0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ReturnAddress.yml @@ -0,0 +1,99 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.models.ReturnAddress +name: ReturnAddress +fullName: azure.mgmt.storageimportexport.models.ReturnAddress +module: azure.mgmt.storageimportexport.models +summary: 'Specifies the return address information for the job. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ReturnAddress(*, recipient_name: str, street_address1: str, city: str, + postal_code: str, country_or_region: str, phone: str, email: str, street_address2: + str | None = None, state_or_province: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: recipient_name + description: 'The name of the recipient who will receive the hard drives when + they + + are returned. Required.' + types: + - + - name: street_address1 + description: 'The first line of the street address to use when returning the + + drives. Required.' + types: + - + - name: street_address2 + description: 'The second line of the street address to use when returning the + + drives.' + types: + - + - name: city + description: The city name to use when returning the drives. Required. + types: + - + - name: state_or_province + description: The state or province to use when returning the drives. + types: + - + - name: postal_code + description: The postal code to use when returning the drives. Required. + types: + - + - name: country_or_region + description: The country or region to use when returning the drives. Required. + types: + - + - name: phone + description: Phone number of the recipient of the returned drives. Required. + types: + - + - name: email + description: Email address of the recipient of the returned drives. Required. + types: + - +variables: +- description: 'The name of the recipient who will receive the hard drives when they + are + + returned. Required.' + name: recipient_name + types: + - +- description: 'The first line of the street address to use when returning the drives. + + Required.' + name: street_address1 + types: + - +- description: The second line of the street address to use when returning the drives. + name: street_address2 + types: + - +- description: The city name to use when returning the drives. Required. + name: city + types: + - +- description: The state or province to use when returning the drives. + name: state_or_province + types: + - +- description: The postal code to use when returning the drives. Required. + name: postal_code + types: + - +- description: The country or region to use when returning the drives. Required. + name: country_or_region + types: + - +- description: Phone number of the recipient of the returned drives. Required. + name: phone + types: + - +- description: Email address of the recipient of the returned drives. Required. + name: email + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ReturnShipping.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ReturnShipping.yml new file mode 100644 index 00000000..3f893d5d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ReturnShipping.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.models.ReturnShipping +name: ReturnShipping +fullName: azure.mgmt.storageimportexport.models.ReturnShipping +module: azure.mgmt.storageimportexport.models +summary: 'Specifies the return carrier and customer''s account with the carrier. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ReturnShipping(*, carrier_name: str, carrier_account_number: str, **kwargs)' + keywordOnlyParameters: + - name: carrier_name + description: The carrier's name. Required. + types: + - + - name: carrier_account_number + description: The customer's account number with the carrier. Required. + types: + - +variables: +- description: The carrier's name. Required. + name: carrier_name + types: + - +- description: The customer's account number with the carrier. Required. + name: carrier_account_number + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ShippingInformation.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ShippingInformation.yml new file mode 100644 index 00000000..3c2b8957 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ShippingInformation.yml @@ -0,0 +1,97 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.models.ShippingInformation +name: ShippingInformation +fullName: azure.mgmt.storageimportexport.models.ShippingInformation +module: azure.mgmt.storageimportexport.models +summary: 'Contains information about the Microsoft datacenter to which the drives + should be shipped. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'ShippingInformation(*, recipient_name: str | None = None, street_address1: + str | None = None, street_address2: str | None = None, city: str | None = None, + state_or_province: str | None = None, postal_code: str | None = None, country_or_region: + str | None = None, phone: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: recipient_name + description: 'The name of the recipient who will receive the hard drives when + they + + are returned.' + types: + - + - name: street_address1 + description: 'The first line of the street address to use when returning the + + drives.' + types: + - + - name: street_address2 + description: 'The second line of the street address to use when returning the + + drives.' + types: + - + - name: city + description: The city name to use when returning the drives. + types: + - + - name: state_or_province + description: The state or province to use when returning the drives. + types: + - + - name: postal_code + description: The postal code to use when returning the drives. + types: + - + - name: country_or_region + description: The country or region to use when returning the drives. + types: + - + - name: phone + description: Phone number of the recipient of the returned drives. + types: + - +variables: +- description: 'The name of the recipient who will receive the hard drives when they + are + + returned.' + name: recipient_name + types: + - +- description: The first line of the street address to use when returning the drives. + name: street_address1 + types: + - +- description: The second line of the street address to use when returning the drives. + name: street_address2 + types: + - +- description: The city name to use when returning the drives. + name: city + types: + - +- description: The state or province to use when returning the drives. + name: state_or_province + types: + - +- description: The postal code to use when returning the drives. + name: postal_code + types: + - +- description: The country or region to use when returning the drives. + name: country_or_region + types: + - +- description: Phone number of the recipient of the returned drives. + name: phone + types: + - +- description: 'Additional shipping information for customer, specific to + + datacenter to which customer should send their disks.' + name: additional_information + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.SystemData.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.SystemData.yml new file mode 100644 index 00000000..553a4397 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.SystemData.yml @@ -0,0 +1,73 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.models.SystemData +name: SystemData +fullName: azure.mgmt.storageimportexport.models.SystemData +module: azure.mgmt.storageimportexport.models +summary: Metadata pertaining to creation and last modification of the resource. +constructor: + syntax: 'SystemData(*, created_by: str | None = None, created_by_type: str | _models.CreatedByType + | None = None, created_at: datetime | None = None, last_modified_by: str | None + = None, last_modified_by_type: str | _models.CreatedByType | None = None, last_modified_at: + datetime | None = None, **kwargs)' + keywordOnlyParameters: + - name: created_by + description: The identity that created the resource. + types: + - + - name: created_by_type + description: 'The type of identity that created the resource. Known values are: + + "User", "Application", "ManagedIdentity", and "Key".' + types: + - + - + - name: created_at + description: The timestamp of resource creation (UTC). + types: + - + - name: last_modified_by + description: The identity that last modified the resource. + types: + - + - name: last_modified_by_type + description: 'The type of identity that last modified the resource. Known + + values are: "User", "Application", "ManagedIdentity", and "Key".' + types: + - + - + - name: last_modified_at + description: The timestamp of resource last modification (UTC). + types: + - +variables: +- description: The identity that created the resource. + name: created_by + types: + - +- description: 'The type of identity that created the resource. Known values are: + + "User", "Application", "ManagedIdentity", and "Key".' + name: created_by_type + types: + - + - +- description: The timestamp of resource creation (UTC). + name: created_at + types: + - +- description: The identity that last modified the resource. + name: last_modified_by + types: + - +- description: 'The type of identity that last modified the resource. Known values + + are: "User", "Application", "ManagedIdentity", and "Key".' + name: last_modified_by_type + types: + - + - +- description: The timestamp of resource last modification (UTC). + name: last_modified_at + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.UpdateJobParameters.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.UpdateJobParameters.yml new file mode 100644 index 00000000..51d6624a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.UpdateJobParameters.yml @@ -0,0 +1,118 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.models.UpdateJobParameters +name: UpdateJobParameters +fullName: azure.mgmt.storageimportexport.models.UpdateJobParameters +module: azure.mgmt.storageimportexport.models +summary: Update Job parameters. +constructor: + syntax: 'UpdateJobParameters(*, tags: MutableMapping[str, Any] | None = None, cancel_requested: + bool = False, state: str | None = None, return_address: _models.ReturnAddress + | None = None, return_shipping: _models.ReturnShipping | None = None, delivery_package: + _models.DeliveryPackageInformation | None = None, log_level: str | None = None, + backup_drive_manifest: bool = False, drive_list: List[_models.DriveStatus] | None + = None, **kwargs)' + keywordOnlyParameters: + - name: tags + description: Specifies the tags that will be assigned to the job. + types: + - + - name: cancel_requested + description: 'If specified, the value must be true. The service will attempt to + + cancel the job.' + types: + - + - name: state + description: 'If specified, the value must be Shipping, which tells the Import/Export + service + + that the package for the job has been shipped. The ReturnAddress and DeliveryPackage + properties + + must have been set either in this request or in a previous request, otherwise + the request will + + fail.' + types: + - + - name: return_address + description: Specifies the return address information for the job. + types: + - + - name: return_shipping + description: Specifies the return carrier and customer's account with the carrier. + types: + - + - name: delivery_package + description: 'Contains information about the package being shipped by the customer + + to the Microsoft data center.' + types: + - + - name: log_level + description: Indicates whether error logging or verbose logging is enabled. + types: + - + - name: backup_drive_manifest + description: 'Indicates whether the manifest files on the drives should be + + copied to block blobs.' + types: + - + - name: drive_list + description: List of drives that comprise the job. + types: + - [] +variables: +- description: Specifies the tags that will be assigned to the job. + name: tags + types: + - +- description: 'If specified, the value must be true. The service will attempt to + + cancel the job.' + name: cancel_requested + types: + - +- description: 'If specified, the value must be Shipping, which tells the Import/Export + service + + that the package for the job has been shipped. The ReturnAddress and DeliveryPackage + properties + + must have been set either in this request or in a previous request, otherwise + the request will + + fail.' + name: state + types: + - +- description: Specifies the return address information for the job. + name: return_address + types: + - +- description: Specifies the return carrier and customer's account with the carrier. + name: return_shipping + types: + - +- description: 'Contains information about the package being shipped by the customer + to + + the Microsoft data center.' + name: delivery_package + types: + - +- description: Indicates whether error logging or verbose logging is enabled. + name: log_level + types: + - +- description: 'Indicates whether the manifest files on the drives should be + + copied to block blobs.' + name: backup_drive_manifest + types: + - +- description: List of drives that comprise the job. + name: drive_list + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.yml new file mode 100644 index 00000000..911ea339 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.yml @@ -0,0 +1,34 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.storageimportexport.models +name: models +fullName: azure.mgmt.storageimportexport.models +type: import +classes: +- azure.mgmt.storageimportexport.models.DeliveryPackageInformation +- azure.mgmt.storageimportexport.models.DriveBitLockerKey +- azure.mgmt.storageimportexport.models.DriveStatus +- azure.mgmt.storageimportexport.models.EncryptionKeyDetails +- azure.mgmt.storageimportexport.models.ErrorResponse +- azure.mgmt.storageimportexport.models.ErrorResponseErrorDetailsItem +- azure.mgmt.storageimportexport.models.Export +- azure.mgmt.storageimportexport.models.GetBitLockerKeysResponse +- azure.mgmt.storageimportexport.models.IdentityDetails +- azure.mgmt.storageimportexport.models.JobDetails +- azure.mgmt.storageimportexport.models.JobResponse +- azure.mgmt.storageimportexport.models.ListJobsResponse +- azure.mgmt.storageimportexport.models.ListOperationsResponse +- azure.mgmt.storageimportexport.models.Location +- azure.mgmt.storageimportexport.models.LocationsResponse +- azure.mgmt.storageimportexport.models.Operation +- azure.mgmt.storageimportexport.models.PackageInformation +- azure.mgmt.storageimportexport.models.PutJobParameters +- azure.mgmt.storageimportexport.models.ReturnAddress +- azure.mgmt.storageimportexport.models.ReturnShipping +- azure.mgmt.storageimportexport.models.ShippingInformation +- azure.mgmt.storageimportexport.models.SystemData +- azure.mgmt.storageimportexport.models.UpdateJobParameters +enums: +- azure.mgmt.storageimportexport.models.CreatedByType +- azure.mgmt.storageimportexport.models.DriveState +- azure.mgmt.storageimportexport.models.EncryptionKekType +- azure.mgmt.storageimportexport.models.IdentityType diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.BitLockerKeysOperations.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.BitLockerKeysOperations.yml new file mode 100644 index 00000000..0267bf58 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.BitLockerKeysOperations.yml @@ -0,0 +1,44 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.operations.BitLockerKeysOperations +name: BitLockerKeysOperations +fullName: azure.mgmt.storageimportexport.operations.BitLockerKeysOperations +module: azure.mgmt.storageimportexport.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: BitLockerKeysOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.storageimportexport.operations.BitLockerKeysOperations.list + name: list + summary: Returns the BitLocker Keys for all drives in the specified job. + signature: 'list(job_name: str, resource_group_name: str, **kwargs: Any) -> Iterable[DriveBitLockerKey]' + parameters: + - name: job_name + description: The name of the import/export job. Required. + isRequired: true + types: + - + - name: resource_group_name + description: 'The resource group name uniquely identifies the resource group + + within the user subscription. Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either DriveBitLockerKey or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.storageimportexport.operations.BitLockerKeysOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.JobsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.JobsOperations.yml new file mode 100644 index 00000000..5e1565df --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.JobsOperations.yml @@ -0,0 +1,248 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.operations.JobsOperations +name: JobsOperations +fullName: azure.mgmt.storageimportexport.operations.JobsOperations +module: azure.mgmt.storageimportexport.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: JobsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.storageimportexport.operations.JobsOperations.create + name: create + summary: Creates a new job or updates an existing job in the specified subscription. + signature: 'create(job_name: str, resource_group_name: str, body: _models.PutJobParameters, + client_tenant_id: str | None = None, *, content_type: str = ''application/json'', + **kwargs: Any) -> _models.JobResponse' + parameters: + - name: job_name + description: The name of the import/export job. Required. + isRequired: true + types: + - + - name: resource_group_name + description: 'The resource group name uniquely identifies the resource group + + within the user subscription. Required.' + isRequired: true + types: + - + - name: body + description: 'The parameters used for creating the job. Is either a model type + or a IO type. + + Required.' + isRequired: true + types: + - + - + - name: client_tenant_id + description: The tenant ID of the client making the request. Default value is + None. + isRequired: true + types: + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: JobResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.storageimportexport.operations.JobsOperations.delete + name: delete + summary: Deletes an existing job. Only jobs in the Creating or Completed states + can be deleted. + signature: 'delete(job_name: str, resource_group_name: str, **kwargs: Any) -> None' + parameters: + - name: job_name + description: The name of the import/export job. Required. + isRequired: true + types: + - + - name: resource_group_name + description: 'The resource group name uniquely identifies the resource group + + within the user subscription. Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.storageimportexport.operations.JobsOperations.get + name: get + summary: Gets information about an existing job. + signature: 'get(job_name: str, resource_group_name: str, **kwargs: Any) -> JobResponse' + parameters: + - name: job_name + description: The name of the import/export job. Required. + isRequired: true + types: + - + - name: resource_group_name + description: 'The resource group name uniquely identifies the resource group + + within the user subscription. Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: JobResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.storageimportexport.operations.JobsOperations.list_by_resource_group + name: list_by_resource_group + summary: Returns all active and completed jobs in a resource group. + signature: 'list_by_resource_group(resource_group_name: str, top: int | None = None, + filter: str | None = None, **kwargs: Any) -> Iterable[JobResponse]' + parameters: + - name: resource_group_name + description: 'The resource group name uniquely identifies the resource group + + within the user subscription. Required.' + isRequired: true + types: + - + - name: top + description: 'An integer value that specifies how many jobs at most should be + returned. The value + + cannot exceed 100. Default value is None.' + isRequired: true + types: + - + - name: filter + description: 'Can be used to restrict the results to certain conditions. Default + value is + + None.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either JobResponse or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.storageimportexport.operations.JobsOperations.list_by_subscription + name: list_by_subscription + summary: Returns all active and completed jobs in a subscription. + signature: 'list_by_subscription(top: int | None = None, filter: str | None = None, + **kwargs: Any) -> Iterable[JobResponse]' + parameters: + - name: top + description: 'An integer value that specifies how many jobs at most should be + returned. The value + + cannot exceed 100. Default value is None.' + isRequired: true + types: + - + - name: filter + description: 'Can be used to restrict the results to certain conditions. Default + value is + + None.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either JobResponse or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.storageimportexport.operations.JobsOperations.update + name: update + summary: 'Updates specific properties of a job. You can call this operation to notify + the Import/Export + + service that the hard drives comprising the import or export job have been shipped + to the + + Microsoft data center. It can also be used to cancel an existing job.' + signature: 'update(job_name: str, resource_group_name: str, body: _models.UpdateJobParameters, + *, content_type: str = ''application/json'', **kwargs: Any) -> _models.JobResponse' + parameters: + - name: job_name + description: The name of the import/export job. Required. + isRequired: true + types: + - + - name: resource_group_name + description: 'The resource group name uniquely identifies the resource group + + within the user subscription. Required.' + isRequired: true + types: + - + - name: body + description: 'The parameters to update in the job. Is either a model type or a + IO type. + + Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: JobResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.storageimportexport.operations.JobsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.LocationsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.LocationsOperations.yml new file mode 100644 index 00000000..bf43da72 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.LocationsOperations.yml @@ -0,0 +1,57 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.operations.LocationsOperations +name: LocationsOperations +fullName: azure.mgmt.storageimportexport.operations.LocationsOperations +module: azure.mgmt.storageimportexport.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: LocationsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.storageimportexport.operations.LocationsOperations.get + name: get + summary: 'Returns the details about a location to which you can ship the disks associated + with an import + + or export job. A location is an Azure region.' + signature: 'get(location_name: str, **kwargs: Any) -> Location' + parameters: + - name: location_name + description: The name of the location. For example, West US or westus. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: Location or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.storageimportexport.operations.LocationsOperations.list + name: list + summary: 'Returns a list of locations to which you can ship the disks associated + with an import or export + + job. A location is a Microsoft data center region.' + signature: 'list(**kwargs: Any) -> Iterable[Location]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either Location or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.storageimportexport.operations.LocationsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.Operations.yml new file mode 100644 index 00000000..38e6238d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.Operations.yml @@ -0,0 +1,31 @@ +### YamlMime:PythonClass +uid: azure.mgmt.storageimportexport.operations.Operations +name: Operations +fullName: azure.mgmt.storageimportexport.operations.Operations +module: azure.mgmt.storageimportexport.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: Operations(*args, **kwargs) +methods: +- uid: azure.mgmt.storageimportexport.operations.Operations.list + name: list + summary: Returns the list of operations supported by the import/export resource + provider. + signature: 'list(**kwargs: Any) -> Iterable[Operation]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either Operation or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.storageimportexport.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.yml new file mode 100644 index 00000000..c894ee69 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.storageimportexport.operations +name: operations +fullName: azure.mgmt.storageimportexport.operations +type: import +classes: +- azure.mgmt.storageimportexport.operations.BitLockerKeysOperations +- azure.mgmt.storageimportexport.operations.JobsOperations +- azure.mgmt.storageimportexport.operations.LocationsOperations +- azure.mgmt.storageimportexport.operations.Operations diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.yml new file mode 100644 index 00000000..32e19ff3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.storageimportexport +name: storageimportexport +fullName: azure.mgmt.storageimportexport +type: rootImport +classes: +- azure.mgmt.storageimportexport.StorageImportExport +packages: +- azure.mgmt.storageimportexport.aio +- azure.mgmt.storageimportexport.models +- azure.mgmt.storageimportexport.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.TestBase.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.TestBase.yml new file mode 100644 index 00000000..afcb373b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.TestBase.yml @@ -0,0 +1,107 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.TestBase +name: TestBase +fullName: azure.mgmt.testbase.TestBase +module: azure.mgmt.testbase +summary: Test Base. +constructor: + syntax: 'TestBase(credential: TokenCredential, subscription_id: str, base_url: str + = ''https://management.azure.com'', **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. Required. + isRequired: true + types: + - + - name: subscription_id + description: The Azure subscription ID. This is a GUID-formatted string. Required. + isRequired: true + types: + - + - name: base_url + description: Service URL. Default value is "`https://management.azure.com`". + defaultValue: https://management.azure.com + types: + - + keywordOnlyParameters: + - name: api_version + description: 'Api Version. Default value is "2022-04-01-preview". Note that overriding + + this default value may result in unsupported behavior.' + types: + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - +variables: +- description: SkusOperations operations + name: skus + types: + - +- description: TestBaseAccountsOperations operations + name: test_base_accounts + types: + - +- description: UsageOperations operations + name: usage + types: + - +- description: AvailableOSOperations operations + name: available_os + types: + - +- description: FlightingRingsOperations operations + name: flighting_rings + types: + - +- description: TestTypesOperations operations + name: test_types + types: + - +- description: PackagesOperations operations + name: packages + types: + - +- description: TestSummariesOperations operations + name: test_summaries + types: + - +- description: TestResultsOperations operations + name: test_results + types: + - +- description: OSUpdatesOperations operations + name: os_updates + types: + - +- description: FavoriteProcessesOperations operations + name: favorite_processes + types: + - +- description: AnalysisResultsOperations operations + name: analysis_results + types: + - +- description: EmailEventsOperations operations + name: email_events + types: + - +- description: CustomerEventsOperations operations + name: customer_events + types: + - +- description: Operations operations + name: operations + types: + - +- description: BillingHubServiceOperations operations + name: billing_hub_service + types: + - +methods: +- uid: azure.mgmt.testbase.TestBase.close + name: close + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.TestBase.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.TestBase.yml new file mode 100644 index 00000000..6ae4e14e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.TestBase.yml @@ -0,0 +1,107 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.aio.TestBase +name: TestBase +fullName: azure.mgmt.testbase.aio.TestBase +module: azure.mgmt.testbase.aio +summary: Test Base. +constructor: + syntax: 'TestBase(credential: AsyncTokenCredential, subscription_id: str, base_url: + str = ''https://management.azure.com'', **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. Required. + isRequired: true + types: + - + - name: subscription_id + description: The Azure subscription ID. This is a GUID-formatted string. Required. + isRequired: true + types: + - + - name: base_url + description: Service URL. Default value is "`https://management.azure.com`". + defaultValue: https://management.azure.com + types: + - + keywordOnlyParameters: + - name: api_version + description: 'Api Version. Default value is "2022-04-01-preview". Note that overriding + + this default value may result in unsupported behavior.' + types: + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - +variables: +- description: SkusOperations operations + name: skus + types: + - +- description: TestBaseAccountsOperations operations + name: test_base_accounts + types: + - +- description: UsageOperations operations + name: usage + types: + - +- description: AvailableOSOperations operations + name: available_os + types: + - +- description: FlightingRingsOperations operations + name: flighting_rings + types: + - +- description: TestTypesOperations operations + name: test_types + types: + - +- description: PackagesOperations operations + name: packages + types: + - +- description: TestSummariesOperations operations + name: test_summaries + types: + - +- description: TestResultsOperations operations + name: test_results + types: + - +- description: OSUpdatesOperations operations + name: os_updates + types: + - +- description: FavoriteProcessesOperations operations + name: favorite_processes + types: + - +- description: AnalysisResultsOperations operations + name: analysis_results + types: + - +- description: EmailEventsOperations operations + name: email_events + types: + - +- description: CustomerEventsOperations operations + name: customer_events + types: + - +- description: Operations operations + name: operations + types: + - +- description: BillingHubServiceOperations operations + name: billing_hub_service + types: + - +methods: +- uid: azure.mgmt.testbase.aio.TestBase.close + name: close + signature: async close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.AnalysisResultsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.AnalysisResultsOperations.yml new file mode 100644 index 00000000..6b5cfd5a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.AnalysisResultsOperations.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.aio.operations.AnalysisResultsOperations +name: AnalysisResultsOperations +fullName: azure.mgmt.testbase.aio.operations.AnalysisResultsOperations +module: azure.mgmt.testbase.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: AnalysisResultsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.aio.operations.AnalysisResultsOperations.get + name: get + summary: Gets an Analysis Result of a Test Result by name. + signature: 'async get(resource_group_name: str, test_base_account_name: str, package_name: + str, test_result_name: str, analysis_result_name: str | AnalysisResultName, **kwargs: + Any) -> AnalysisResultSingletonResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: test_result_name + description: 'The Test Result Name. It equals to TestResult-{TestResultId} string. + + Required.' + isRequired: true + types: + - + - name: analysis_result_name + description: 'The name of the Analysis Result of a Test Result. Known values + + are: "scriptExecution", "reliability", "memoryUtilization", "cpuUtilization", + + "memoryRegression", "cpuRegression", and "testAnalysis". Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AnalysisResultSingletonResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.AnalysisResultsOperations.list + name: list + summary: 'Lists the Analysis Results of a Test Result. The result collection will + only contain one + + element as all the data will be nested in a singleton object.' + signature: 'list(resource_group_name: str, test_base_account_name: str, package_name: + str, test_result_name: str, analysis_result_type: str | AnalysisResultType, **kwargs: + Any) -> AsyncIterable[AnalysisResultSingletonResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: test_result_name + description: 'The Test Result Name. It equals to TestResult-{TestResultId} string. + + Required.' + isRequired: true + types: + - + - name: analysis_result_type + description: 'The type of the Analysis Result of a Test Result. Known values + + are: "ScriptExecution", "Reliability", "CPUUtilization", "MemoryUtilization", + "CPURegression", + + "MemoryRegression", and "TestAnalysis". Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either AnalysisResultSingletonResource + or the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.aio.operations.AnalysisResultsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.AvailableOSOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.AvailableOSOperations.yml new file mode 100644 index 00000000..62def90b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.AvailableOSOperations.yml @@ -0,0 +1,87 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.aio.operations.AvailableOSOperations +name: AvailableOSOperations +fullName: azure.mgmt.testbase.aio.operations.AvailableOSOperations +module: azure.mgmt.testbase.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: AvailableOSOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.aio.operations.AvailableOSOperations.get + name: get + summary: Gets an available OS to run a package under a Test Base Account. + signature: 'async get(resource_group_name: str, test_base_account_name: str, available_os_resource_name: + str, **kwargs: Any) -> AvailableOSResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: available_os_resource_name + description: The resource name of an Available OS. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AvailableOSResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.AvailableOSOperations.list + name: list + summary: Lists all the available OSs to run a package under a Test Base Account. + signature: 'list(resource_group_name: str, test_base_account_name: str, os_update_type: + str | OsUpdateType, **kwargs: Any) -> AsyncIterable[AvailableOSResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: os_update_type + description: 'The type of the OS Update. Known values are: "SecurityUpdate" and + + "FeatureUpdate". Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either AvailableOSResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.aio.operations.AvailableOSOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.BillingHubServiceOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.BillingHubServiceOperations.yml new file mode 100644 index 00000000..0ba966ac --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.BillingHubServiceOperations.yml @@ -0,0 +1,86 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.aio.operations.BillingHubServiceOperations +name: BillingHubServiceOperations +fullName: azure.mgmt.testbase.aio.operations.BillingHubServiceOperations +module: azure.mgmt.testbase.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: BillingHubServiceOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.aio.operations.BillingHubServiceOperations.get_free_hour_balance + name: get_free_hour_balance + summary: get_free_hour_balance. + signature: 'async get_free_hour_balance(resource_group_name: str, test_base_account_name: + str, **kwargs: Any) -> BillingHubGetFreeHourBalanceResponse' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: BillingHubGetFreeHourBalanceResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.BillingHubServiceOperations.get_usage + name: get_usage + summary: get_usage. + signature: 'async get_usage(resource_group_name: str, test_base_account_name: str, + get_usage_request: _models.BillingHubGetUsageRequest | None = None, *, content_type: + str = ''application/json'', **kwargs: Any) -> _models.BillingHubGetUsageResponse' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: get_usage_request + description: Is either a model type or a IO type. Default value is None. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: BillingHubGetUsageResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.aio.operations.BillingHubServiceOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.CustomerEventsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.CustomerEventsOperations.yml new file mode 100644 index 00000000..945ec860 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.CustomerEventsOperations.yml @@ -0,0 +1,211 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.aio.operations.CustomerEventsOperations +name: CustomerEventsOperations +fullName: azure.mgmt.testbase.aio.operations.CustomerEventsOperations +module: azure.mgmt.testbase.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: CustomerEventsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.aio.operations.CustomerEventsOperations.begin_create + name: begin_create + summary: Create or replace a Test Base Customer Event. + signature: 'async begin_create(resource_group_name: str, test_base_account_name: + str, customer_event_name: str, parameters: _models.CustomerEventResource, *, content_type: + str = ''application/json'', **kwargs: Any) -> AsyncLROPoller[_models.CustomerEventResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: customer_event_name + description: The resource name of the Test Base Customer event. Required. + isRequired: true + types: + - + - name: parameters + description: 'Parameters supplied to create a Test Base CustomerEvent. Is either + a model + + type or a IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of AsyncLROPoller that returns either CustomerEventResource + or the result + + of cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.CustomerEventsOperations.begin_delete + name: begin_delete + summary: Deletes a Test Base Customer Event. + signature: 'async begin_delete(resource_group_name: str, test_base_account_name: + str, customer_event_name: str, **kwargs: Any) -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: customer_event_name + description: The resource name of the Test Base Customer event. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.CustomerEventsOperations.get + name: get + summary: Gets a Test Base CustomerEvent. + signature: 'async get(resource_group_name: str, test_base_account_name: str, customer_event_name: + str, **kwargs: Any) -> CustomerEventResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: customer_event_name + description: The resource name of the Test Base Customer event. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: CustomerEventResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.CustomerEventsOperations.list_by_test_base_account + name: list_by_test_base_account + summary: Lists all notification events subscribed under a Test Base Account. + signature: 'list_by_test_base_account(resource_group_name: str, test_base_account_name: + str, **kwargs: Any) -> AsyncIterable[CustomerEventResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either CustomerEventResource or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.aio.operations.CustomerEventsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.EmailEventsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.EmailEventsOperations.yml new file mode 100644 index 00000000..2d82417d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.EmailEventsOperations.yml @@ -0,0 +1,79 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.aio.operations.EmailEventsOperations +name: EmailEventsOperations +fullName: azure.mgmt.testbase.aio.operations.EmailEventsOperations +module: azure.mgmt.testbase.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: EmailEventsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.aio.operations.EmailEventsOperations.get + name: get + summary: Gets a email event of a Test Base Account. + signature: 'async get(resource_group_name: str, test_base_account_name: str, email_event_resource_name: + str, **kwargs: Any) -> EmailEventResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: email_event_resource_name + description: The resource name of an email event. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: EmailEventResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.EmailEventsOperations.list + name: list + summary: Lists all the email events of a Test Base Account. + signature: 'list(resource_group_name: str, test_base_account_name: str, **kwargs: + Any) -> AsyncIterable[EmailEventResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either EmailEventResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.aio.operations.EmailEventsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.FavoriteProcessesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.FavoriteProcessesOperations.yml new file mode 100644 index 00000000..13364f35 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.FavoriteProcessesOperations.yml @@ -0,0 +1,200 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.aio.operations.FavoriteProcessesOperations +name: FavoriteProcessesOperations +fullName: azure.mgmt.testbase.aio.operations.FavoriteProcessesOperations +module: azure.mgmt.testbase.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: FavoriteProcessesOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.aio.operations.FavoriteProcessesOperations.create + name: create + summary: Create or replace a favorite process for a Test Base Package. + signature: 'async create(resource_group_name: str, test_base_account_name: str, + package_name: str, favorite_process_resource_name: str, parameters: _models.FavoriteProcessResource, + *, content_type: str = ''application/json'', **kwargs: Any) -> _models.FavoriteProcessResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: favorite_process_resource_name + description: 'The resource name of a favorite process in a package. If + + the process name contains characters that are not allowed in Azure Resource + Name, we use + + ''actualProcessName'' in request body to submit the name. Required.' + isRequired: true + types: + - + - name: parameters + description: 'Parameters supplied to create a favorite process in a package. Is + either a + + model type or a IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: FavoriteProcessResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.FavoriteProcessesOperations.delete + name: delete + summary: Deletes a favorite process for a specific package. + signature: 'async delete(resource_group_name: str, test_base_account_name: str, + package_name: str, favorite_process_resource_name: str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: favorite_process_resource_name + description: 'The resource name of a favorite process in a package. If + + the process name contains characters that are not allowed in Azure Resource + Name, we use + + ''actualProcessName'' in request body to submit the name. Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.FavoriteProcessesOperations.get + name: get + summary: Gets a favorite process for a Test Base Package. + signature: 'async get(resource_group_name: str, test_base_account_name: str, package_name: + str, favorite_process_resource_name: str, **kwargs: Any) -> FavoriteProcessResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: favorite_process_resource_name + description: 'The resource name of a favorite process in a package. If + + the process name contains characters that are not allowed in Azure Resource + Name, we use + + ''actualProcessName'' in request body to submit the name. Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: FavoriteProcessResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.FavoriteProcessesOperations.list + name: list + summary: Lists the favorite processes for a specific package. + signature: 'list(resource_group_name: str, test_base_account_name: str, package_name: + str, **kwargs: Any) -> AsyncIterable[FavoriteProcessResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either FavoriteProcessResource or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.aio.operations.FavoriteProcessesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.FlightingRingsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.FlightingRingsOperations.yml new file mode 100644 index 00000000..1524aea5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.FlightingRingsOperations.yml @@ -0,0 +1,81 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.aio.operations.FlightingRingsOperations +name: FlightingRingsOperations +fullName: azure.mgmt.testbase.aio.operations.FlightingRingsOperations +module: azure.mgmt.testbase.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: FlightingRingsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.aio.operations.FlightingRingsOperations.get + name: get + summary: Gets a flighting ring of a Test Base Account. + signature: 'async get(resource_group_name: str, test_base_account_name: str, flighting_ring_resource_name: + str, **kwargs: Any) -> FlightingRingResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: flighting_ring_resource_name + description: The resource name of a flighting ring. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: FlightingRingResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.FlightingRingsOperations.list + name: list + summary: Lists all the flighting rings of a Test Base Account. + signature: 'list(resource_group_name: str, test_base_account_name: str, **kwargs: + Any) -> AsyncIterable[FlightingRingResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either FlightingRingResource or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.aio.operations.FlightingRingsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.OSUpdatesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.OSUpdatesOperations.yml new file mode 100644 index 00000000..3a76e3f6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.OSUpdatesOperations.yml @@ -0,0 +1,97 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.aio.operations.OSUpdatesOperations +name: OSUpdatesOperations +fullName: azure.mgmt.testbase.aio.operations.OSUpdatesOperations +module: azure.mgmt.testbase.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: OSUpdatesOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.aio.operations.OSUpdatesOperations.get + name: get + summary: Gets an OS Update by name in which the package was tested before. + signature: 'async get(resource_group_name: str, test_base_account_name: str, package_name: + str, os_update_resource_name: str, **kwargs: Any) -> OSUpdateResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: os_update_resource_name + description: The resource name of an OS Update. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: OSUpdateResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.OSUpdatesOperations.list + name: list + summary: Lists the OS Updates in which the package were tested before. + signature: 'list(resource_group_name: str, test_base_account_name: str, package_name: + str, os_update_type: str | OsUpdateType, **kwargs: Any) -> AsyncIterable[OSUpdateResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: os_update_type + description: 'The type of the OS Update. Known values are: "SecurityUpdate" and + + "FeatureUpdate". Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either OSUpdateResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.aio.operations.OSUpdatesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.Operations.yml new file mode 100644 index 00000000..3578bb5b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.Operations.yml @@ -0,0 +1,31 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.aio.operations.Operations +name: Operations +fullName: azure.mgmt.testbase.aio.operations.Operations +module: azure.mgmt.testbase.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: Operations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.aio.operations.Operations.list + name: list + summary: Lists all of the available REST API operations of the Microsoft.TestBase + provider. + signature: 'list(**kwargs: Any) -> AsyncIterable[Operation]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either Operation or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.aio.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.PackagesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.PackagesOperations.yml new file mode 100644 index 00000000..67f3535d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.PackagesOperations.yml @@ -0,0 +1,424 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.aio.operations.PackagesOperations +name: PackagesOperations +fullName: azure.mgmt.testbase.aio.operations.PackagesOperations +module: azure.mgmt.testbase.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: PackagesOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.aio.operations.PackagesOperations.begin_create + name: begin_create + summary: Create or replace (overwrite/recreate, with potential downtime) a Test + Base Package. + signature: 'async begin_create(resource_group_name: str, test_base_account_name: + str, package_name: str, parameters: _models.PackageResource, *, content_type: + str = ''application/json'', **kwargs: Any) -> AsyncLROPoller[_models.PackageResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: parameters + description: 'Parameters supplied to create a Test Base Package. Is either a model + type or + + a IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of AsyncLROPoller that returns either PackageResource + or the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.PackagesOperations.begin_delete + name: begin_delete + summary: Deletes a Test Base Package. + signature: 'async begin_delete(resource_group_name: str, test_base_account_name: + str, package_name: str, **kwargs: Any) -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.PackagesOperations.begin_hard_delete + name: begin_hard_delete + summary: Hard Delete a Test Base Package. + signature: 'async begin_hard_delete(resource_group_name: str, test_base_account_name: + str, package_name: str, **kwargs: Any) -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.PackagesOperations.begin_update + name: begin_update + summary: Update an existing Test Base Package. + signature: 'async begin_update(resource_group_name: str, test_base_account_name: + str, package_name: str, parameters: _models.PackageUpdateParameters, *, content_type: + str = ''application/json'', **kwargs: Any) -> AsyncLROPoller[_models.PackageResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: parameters + description: 'Parameters supplied to update a Test Base Package. Is either a model + type or + + a IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of AsyncLROPoller that returns either PackageResource + or the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.PackagesOperations.get + name: get + summary: Gets a Test Base Package. + signature: 'async get(resource_group_name: str, test_base_account_name: str, package_name: + str, **kwargs: Any) -> PackageResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PackageResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.PackagesOperations.get_download_url + name: get_download_url + summary: Gets the download URL of a package. + signature: 'async get_download_url(resource_group_name: str, test_base_account_name: + str, package_name: str, **kwargs: Any) -> DownloadURLResponse' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DownloadURLResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.PackagesOperations.list_by_test_base_account + name: list_by_test_base_account + summary: Lists all the packages under a Test Base Account. + signature: 'list_by_test_base_account(resource_group_name: str, test_base_account_name: + str, **kwargs: Any) -> AsyncIterable[PackageResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either PackageResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.PackagesOperations.run_test + name: run_test + summary: Trigger a test run on the package. + signature: 'async run_test(resource_group_name: str, test_base_account_name: str, + package_name: str, parameters: _models.PackageRunTestParameters | None = None, + *, content_type: str = ''application/json'', **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: parameters + description: 'The parameters supplied to the Test Base Package to start a Test + Run. Is + + either a model type or a IO type. Default value is None.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.aio.operations.PackagesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.SkusOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.SkusOperations.yml new file mode 100644 index 00000000..a429e78d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.SkusOperations.yml @@ -0,0 +1,31 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.aio.operations.SkusOperations +name: SkusOperations +fullName: azure.mgmt.testbase.aio.operations.SkusOperations +module: azure.mgmt.testbase.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: SkusOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.aio.operations.SkusOperations.list + name: list + summary: Lists the available SKUs of Test Base Account in a subscription. + signature: 'list(**kwargs: Any) -> AsyncIterable[TestBaseAccountSKU]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either TestBaseAccountSKU or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.aio.operations.SkusOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestBaseAccountsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestBaseAccountsOperations.yml new file mode 100644 index 00000000..e3773612 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestBaseAccountsOperations.yml @@ -0,0 +1,449 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.aio.operations.TestBaseAccountsOperations +name: TestBaseAccountsOperations +fullName: azure.mgmt.testbase.aio.operations.TestBaseAccountsOperations +module: azure.mgmt.testbase.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: TestBaseAccountsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.aio.operations.TestBaseAccountsOperations.begin_create + name: begin_create + summary: 'Create or replace (overwrite/recreate, with potential downtime) a Test + Base Account in the + + specified subscription.' + signature: 'async begin_create(resource_group_name: str, test_base_account_name: + str, parameters: _models.TestBaseAccountResource, restore: bool | None = None, + *, content_type: str = ''application/json'', **kwargs: Any) -> AsyncLROPoller[_models.TestBaseAccountResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: parameters + description: 'Parameters supplied to create a Test Base Account. Is either a model + type or + + a IO type. Required.' + isRequired: true + types: + - + - + - name: restore + description: 'The flag indicating if we would like to restore the Test Base Accounts + which + + were soft deleted before. Default value is None.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of AsyncLROPoller that returns either TestBaseAccountResource + or the + + result of cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.TestBaseAccountsOperations.begin_delete + name: begin_delete + summary: Deletes a Test Base Account. + signature: 'async begin_delete(resource_group_name: str, test_base_account_name: + str, **kwargs: Any) -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.TestBaseAccountsOperations.begin_offboard + name: begin_offboard + summary: Offboard a Test Base Account. + signature: 'async begin_offboard(resource_group_name: str, test_base_account_name: + str, **kwargs: Any) -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.TestBaseAccountsOperations.begin_update + name: begin_update + summary: Update an existing Test Base Account. + signature: 'async begin_update(resource_group_name: str, test_base_account_name: + str, parameters: _models.TestBaseAccountUpdateParameters, *, content_type: str + = ''application/json'', **kwargs: Any) -> AsyncLROPoller[_models.TestBaseAccountResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: parameters + description: 'Parameters supplied to update a Test Base Account. Is either a model + type or + + a IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of AsyncLROPoller that returns either TestBaseAccountResource + or the + + result of cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.TestBaseAccountsOperations.check_package_name_availability + name: check_package_name_availability + summary: Checks that the Test Base Package name and version is valid and is not + already in use. + signature: 'async check_package_name_availability(resource_group_name: str, test_base_account_name: + str, parameters: _models.PackageCheckNameAvailabilityParameters, *, content_type: + str = ''application/json'', **kwargs: Any) -> _models.CheckNameAvailabilityResult' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: parameters + description: 'Parameters supplied to the Test Base Package CheckNameAvailability + + operation. Is either a model type or a IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: CheckNameAvailabilityResult or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.TestBaseAccountsOperations.get + name: get + summary: Gets a Test Base Account. + signature: 'async get(resource_group_name: str, test_base_account_name: str, **kwargs: + Any) -> TestBaseAccountResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: TestBaseAccountResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.TestBaseAccountsOperations.get_file_upload_url + name: get_file_upload_url + summary: Gets the file upload URL of a Test Base Account. + signature: 'async get_file_upload_url(resource_group_name: str, test_base_account_name: + str, parameters: _models.GetFileUploadURLParameters | None = None, *, content_type: + str = ''application/json'', **kwargs: Any) -> _models.FileUploadURLResponse' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: parameters + description: 'Parameters supplied to the Test Base Account GetFileUploadURL operation. + Is + + either a model type or a IO type. Default value is None.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: FileUploadURLResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.TestBaseAccountsOperations.list_by_resource_group + name: list_by_resource_group + summary: Lists all the Test Base Accounts in a resource group. + signature: 'list_by_resource_group(resource_group_name: str, get_deleted: bool | + None = None, **kwargs: Any) -> AsyncIterable[TestBaseAccountResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: get_deleted + description: 'The flag indicating if we need to include the Test Base Accounts + which were + + soft deleted before. Default value is None.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either TestBaseAccountResource or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.TestBaseAccountsOperations.list_by_subscription + name: list_by_subscription + summary: Lists all the Test Base Accounts in a subscription. This API is required + by ARM guidelines. + signature: 'list_by_subscription(get_deleted: bool | None = None, **kwargs: Any) + -> AsyncIterable[TestBaseAccountResource]' + parameters: + - name: get_deleted + description: 'The flag indicating if we need to include the Test Base Accounts + which were + + soft deleted before. Default value is None.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either TestBaseAccountResource or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.aio.operations.TestBaseAccountsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestResultsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestResultsOperations.yml new file mode 100644 index 00000000..fee96b25 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestResultsOperations.yml @@ -0,0 +1,248 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.aio.operations.TestResultsOperations +name: TestResultsOperations +fullName: azure.mgmt.testbase.aio.operations.TestResultsOperations +module: azure.mgmt.testbase.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: TestResultsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.aio.operations.TestResultsOperations.get + name: get + summary: Get the Test Result by Id with specified OS Update type for a Test Base + Package. + signature: 'async get(resource_group_name: str, test_base_account_name: str, package_name: + str, test_result_name: str, **kwargs: Any) -> TestResultResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: test_result_name + description: 'The Test Result Name. It equals to TestResult-{TestResultId} string. + + Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: TestResultResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.TestResultsOperations.get_console_log_download_url + name: get_console_log_download_url + summary: Gets the download URL of the test execution console log file. + signature: 'async get_console_log_download_url(resource_group_name: str, test_base_account_name: + str, package_name: str, test_result_name: str, parameters: _models.TestResultConsoleLogDownloadURLParameters, + *, content_type: str = ''application/json'', **kwargs: Any) -> _models.DownloadURLResponse' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: test_result_name + description: 'The Test Result Name. It equals to TestResult-{TestResultId} string. + + Required.' + isRequired: true + types: + - + - name: parameters + description: 'Parameters supplied to the Test Result GetConsoleLogDownloadUrl + operation. + + Is either a model type or a IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DownloadURLResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.TestResultsOperations.get_download_url + name: get_download_url + summary: Gets the download URL of the test result. + signature: 'async get_download_url(resource_group_name: str, test_base_account_name: + str, package_name: str, test_result_name: str, **kwargs: Any) -> DownloadURLResponse' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: test_result_name + description: 'The Test Result Name. It equals to TestResult-{TestResultId} string. + + Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DownloadURLResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.TestResultsOperations.get_video_download_url + name: get_video_download_url + summary: Gets the download URL of the test execution screen recording. + signature: 'async get_video_download_url(resource_group_name: str, test_base_account_name: + str, package_name: str, test_result_name: str, **kwargs: Any) -> DownloadURLResponse' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: test_result_name + description: 'The Test Result Name. It equals to TestResult-{TestResultId} string. + + Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DownloadURLResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.TestResultsOperations.list + name: list + summary: 'Lists all the Test Results with specified OS Update type for a Test Base + Package. Can be + + filtered by osName, releaseName, flightingRing, buildVersion, buildRevision.' + signature: 'list(resource_group_name: str, test_base_account_name: str, package_name: + str, os_update_type: str | OsUpdateType, filter: str | None = None, **kwargs: + Any) -> AsyncIterable[TestResultResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: os_update_type + description: 'The type of the OS Update. Known values are: "SecurityUpdate" and + + "FeatureUpdate". Required.' + isRequired: true + types: + - + - + - name: filter + description: Odata filter. Default value is None. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either TestResultResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.aio.operations.TestResultsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestSummariesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestSummariesOperations.yml new file mode 100644 index 00000000..b3489731 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestSummariesOperations.yml @@ -0,0 +1,82 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.aio.operations.TestSummariesOperations +name: TestSummariesOperations +fullName: azure.mgmt.testbase.aio.operations.TestSummariesOperations +module: azure.mgmt.testbase.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: TestSummariesOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.aio.operations.TestSummariesOperations.get + name: get + summary: 'Gets a Test Summary with specific name from all the Test Summaries of + all the packages under a + + Test Base Account.' + signature: 'async get(resource_group_name: str, test_base_account_name: str, test_summary_name: + str, **kwargs: Any) -> TestSummaryResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: test_summary_name + description: The name of the Test Summary. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: TestSummaryResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.TestSummariesOperations.list + name: list + summary: Lists the Test Summaries of all the packages under a Test Base Account. + signature: 'list(resource_group_name: str, test_base_account_name: str, **kwargs: + Any) -> AsyncIterable[TestSummaryResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either TestSummaryResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.aio.operations.TestSummariesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestTypesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestTypesOperations.yml new file mode 100644 index 00000000..a14af3f7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestTypesOperations.yml @@ -0,0 +1,79 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.aio.operations.TestTypesOperations +name: TestTypesOperations +fullName: azure.mgmt.testbase.aio.operations.TestTypesOperations +module: azure.mgmt.testbase.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: TestTypesOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.aio.operations.TestTypesOperations.get + name: get + summary: Gets a test type of a Test Base Account. + signature: 'async get(resource_group_name: str, test_base_account_name: str, test_type_resource_name: + str, **kwargs: Any) -> TestTypeResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: test_type_resource_name + description: The resource name of a test type. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: TestTypeResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.aio.operations.TestTypesOperations.list + name: list + summary: Lists all the test types of a Test Base Account. + signature: 'list(resource_group_name: str, test_base_account_name: str, **kwargs: + Any) -> AsyncIterable[TestTypeResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either TestTypeResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.aio.operations.TestTypesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.UsageOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.UsageOperations.yml new file mode 100644 index 00000000..86969ee1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.UsageOperations.yml @@ -0,0 +1,52 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.aio.operations.UsageOperations +name: UsageOperations +fullName: azure.mgmt.testbase.aio.operations.UsageOperations +module: azure.mgmt.testbase.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: UsageOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.aio.operations.UsageOperations.list + name: list + summary: Lists the usage data of a Test Base Account. + signature: 'list(resource_group_name: str, test_base_account_name: str, filter: + str | None = None, **kwargs: Any) -> AsyncIterable[TestBaseAccountUsageData]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: filter + description: Odata filter. Default value is None. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either TestBaseAccountUsageData or + the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.aio.operations.UsageOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.yml new file mode 100644 index 00000000..c9d28864 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.yml @@ -0,0 +1,22 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.testbase.aio.operations +name: operations +fullName: azure.mgmt.testbase.aio.operations +type: import +classes: +- azure.mgmt.testbase.aio.operations.AnalysisResultsOperations +- azure.mgmt.testbase.aio.operations.AvailableOSOperations +- azure.mgmt.testbase.aio.operations.BillingHubServiceOperations +- azure.mgmt.testbase.aio.operations.CustomerEventsOperations +- azure.mgmt.testbase.aio.operations.EmailEventsOperations +- azure.mgmt.testbase.aio.operations.FavoriteProcessesOperations +- azure.mgmt.testbase.aio.operations.FlightingRingsOperations +- azure.mgmt.testbase.aio.operations.OSUpdatesOperations +- azure.mgmt.testbase.aio.operations.Operations +- azure.mgmt.testbase.aio.operations.PackagesOperations +- azure.mgmt.testbase.aio.operations.SkusOperations +- azure.mgmt.testbase.aio.operations.TestBaseAccountsOperations +- azure.mgmt.testbase.aio.operations.TestResultsOperations +- azure.mgmt.testbase.aio.operations.TestSummariesOperations +- azure.mgmt.testbase.aio.operations.TestTypesOperations +- azure.mgmt.testbase.aio.operations.UsageOperations diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.yml new file mode 100644 index 00000000..d463fbf5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.testbase.aio +name: aio +fullName: azure.mgmt.testbase.aio +type: import +classes: +- azure.mgmt.testbase.aio.TestBase +packages: +- azure.mgmt.testbase.aio.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Action.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Action.yml new file mode 100644 index 00000000..476ac78c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Action.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.testbase.models.Action +name: Action +fullName: azure.mgmt.testbase.models.Action +summary: The action of the command. +module: azure.mgmt.testbase.models +fields: +- name: CLOSE + uid: azure.mgmt.testbase.models.Action.CLOSE +- name: CUSTOM + uid: azure.mgmt.testbase.models.Action.CUSTOM +- name: INSTALL + uid: azure.mgmt.testbase.models.Action.INSTALL +- name: LAUNCH + uid: azure.mgmt.testbase.models.Action.LAUNCH +- name: UNINSTALL + uid: azure.mgmt.testbase.models.Action.UNINSTALL diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultListResult.yml new file mode 100644 index 00000000..0d230660 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultListResult.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.AnalysisResultListResult +name: AnalysisResultListResult +fullName: azure.mgmt.testbase.models.AnalysisResultListResult +module: azure.mgmt.testbase.models +summary: 'A list of Analysis Results. It will only contain one element as all the + data will be nested in a singleton object. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'AnalysisResultListResult(*, value: List[_models.AnalysisResultSingletonResource] + | None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: The list of Analysis Results. + types: + - [] +variables: +- description: The list of Analysis Results. + name: value + types: + - [] +- description: 'Link to the next set of results. Not empty if value contains incomplete + list + + of results.' + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultName.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultName.yml new file mode 100644 index 00000000..e7f01ef4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultName.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.testbase.models.AnalysisResultName +name: AnalysisResultName +fullName: azure.mgmt.testbase.models.AnalysisResultName +summary: AnalysisResultName. +module: azure.mgmt.testbase.models +fields: +- name: CPU_REGRESSION + uid: azure.mgmt.testbase.models.AnalysisResultName.CPU_REGRESSION +- name: CPU_UTILIZATION + uid: azure.mgmt.testbase.models.AnalysisResultName.CPU_UTILIZATION +- name: MEMORY_REGRESSION + uid: azure.mgmt.testbase.models.AnalysisResultName.MEMORY_REGRESSION +- name: MEMORY_UTILIZATION + uid: azure.mgmt.testbase.models.AnalysisResultName.MEMORY_UTILIZATION +- name: RELIABILITY + uid: azure.mgmt.testbase.models.AnalysisResultName.RELIABILITY +- name: SCRIPT_EXECUTION + uid: azure.mgmt.testbase.models.AnalysisResultName.SCRIPT_EXECUTION +- name: TEST_ANALYSIS + uid: azure.mgmt.testbase.models.AnalysisResultName.TEST_ANALYSIS diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultSingletonResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultSingletonResource.yml new file mode 100644 index 00000000..ad86b6c0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultSingletonResource.yml @@ -0,0 +1,56 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.AnalysisResultSingletonResource +name: AnalysisResultSingletonResource +fullName: azure.mgmt.testbase.models.AnalysisResultSingletonResource +module: azure.mgmt.testbase.models +summary: 'The Analysis Result Singleton Resource. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'AnalysisResultSingletonResource(*, grade: str | _models.Grade | None = + None, **kwargs)' + keywordOnlyParameters: + - name: grade + description: 'The grade of the test. Known values are: "None", "NotAvailable", + "Pass", and + + "Fail".' + types: + - + - +variables: +- description: Resource ID. + name: id + types: + - +- description: Resource name. + name: name + types: + - +- description: Resource type. + name: type + types: + - +- description: The system metadata relating to this resource. + name: system_data + types: + - +- description: 'The grade of the test. Known values are: "None", "NotAvailable", "Pass", + and + + "Fail".' + name: grade + types: + - + - +- description: 'Type of the Analysis Result. Known values are: "ScriptExecution", + + "Reliability", "CPUUtilization", "MemoryUtilization", "CPURegression", "MemoryRegression", + and + + "TestAnalysis".' + name: analysis_result_type + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultSingletonResourceProperties.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultSingletonResourceProperties.yml new file mode 100644 index 00000000..5e3ee3bf --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultSingletonResourceProperties.yml @@ -0,0 +1,55 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.AnalysisResultSingletonResourceProperties +name: AnalysisResultSingletonResourceProperties +fullName: azure.mgmt.testbase.models.AnalysisResultSingletonResourceProperties +module: azure.mgmt.testbase.models +summary: 'The properties of Analysis Result resource. + + + You probably want to use the sub-classes and not this class directly. Known sub-classes + are: + + CPURegressionResultSingletonResourceProperties, + + CPUUtilizationResultSingletonResourceProperties, + + MemoryRegressionResultSingletonResourceProperties, + + MemoryUtilizationResultSingletonResourceProperties, + + ReliabilityResultSingletonResourceProperties, ScriptExecutionResultSingletonResourceProperties, + + TestAnalysisResultSingletonResourceProperties + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AnalysisResultSingletonResourceProperties(*, grade: str | _models.Grade + | None = None, **kwargs)' + keywordOnlyParameters: + - name: grade + description: 'The grade of the test. Known values are: "None", "NotAvailable", + "Pass", and + + "Fail".' + types: + - + - +variables: +- description: 'The grade of the test. Known values are: "None", "NotAvailable", "Pass", + and + + "Fail".' + name: grade + types: + - + - +- description: 'Type of the Analysis Result. Required. Known values are: + + "ScriptExecution", "Reliability", "CPUUtilization", "MemoryUtilization", "CPURegression", + + "MemoryRegression", and "TestAnalysis".' + name: analysis_result_type + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultType.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultType.yml new file mode 100644 index 00000000..dacab2de --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultType.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.testbase.models.AnalysisResultType +name: AnalysisResultType +fullName: azure.mgmt.testbase.models.AnalysisResultType +summary: Type of the Analysis Result. +module: azure.mgmt.testbase.models +fields: +- name: CPU_REGRESSION + uid: azure.mgmt.testbase.models.AnalysisResultType.CPU_REGRESSION +- name: CPU_UTILIZATION + uid: azure.mgmt.testbase.models.AnalysisResultType.CPU_UTILIZATION +- name: MEMORY_REGRESSION + uid: azure.mgmt.testbase.models.AnalysisResultType.MEMORY_REGRESSION +- name: MEMORY_UTILIZATION + uid: azure.mgmt.testbase.models.AnalysisResultType.MEMORY_UTILIZATION +- name: RELIABILITY + uid: azure.mgmt.testbase.models.AnalysisResultType.RELIABILITY +- name: SCRIPT_EXECUTION + uid: azure.mgmt.testbase.models.AnalysisResultType.SCRIPT_EXECUTION +- name: TEST_ANALYSIS + uid: azure.mgmt.testbase.models.AnalysisResultType.TEST_ANALYSIS diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisStatus.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisStatus.yml new file mode 100644 index 00000000..e8c806cd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisStatus.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.testbase.models.AnalysisStatus +name: AnalysisStatus +fullName: azure.mgmt.testbase.models.AnalysisStatus +summary: The analysis status. +module: azure.mgmt.testbase.models +fields: +- name: AVAILABLE + uid: azure.mgmt.testbase.models.AnalysisStatus.AVAILABLE +- name: COMPLETED + uid: azure.mgmt.testbase.models.AnalysisStatus.COMPLETED +- name: FAILED + uid: azure.mgmt.testbase.models.AnalysisStatus.FAILED +- name: IN_PROGRESS + uid: azure.mgmt.testbase.models.AnalysisStatus.IN_PROGRESS +- name: NONE + uid: azure.mgmt.testbase.models.AnalysisStatus.NONE +- name: NOT_AVAILABLE + uid: azure.mgmt.testbase.models.AnalysisStatus.NOT_AVAILABLE +- name: SUCCEEDED + uid: azure.mgmt.testbase.models.AnalysisStatus.SUCCEEDED diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AvailableOSListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AvailableOSListResult.yml new file mode 100644 index 00000000..edb477e4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AvailableOSListResult.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.AvailableOSListResult +name: AvailableOSListResult +fullName: azure.mgmt.testbase.models.AvailableOSListResult +module: azure.mgmt.testbase.models +summary: 'A list of available OSs. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'AvailableOSListResult(*, value: List[_models.AvailableOSResource] | None + = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: The list of available OSs. + types: + - [] +variables: +- description: The list of available OSs. + name: value + types: + - [] +- description: 'Link to the next set of results. Not empty if value contains incomplete + list + + of results.' + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AvailableOSResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AvailableOSResource.yml new file mode 100644 index 00000000..b377d8c3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AvailableOSResource.yml @@ -0,0 +1,79 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.AvailableOSResource +name: AvailableOSResource +fullName: azure.mgmt.testbase.models.AvailableOSResource +module: azure.mgmt.testbase.models +summary: 'The Available OS resource. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'AvailableOSResource(*, os_id: str | None = None, os_name: str | None = + None, os_version: str | None = None, insider_channel: str | None = None, os_update_type: + str | None = None, os_platform: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: os_id + description: The Id of an Available OS of a Test Base Account. + types: + - + - name: os_name + description: The name of an Available OS of a Test Base Account. + types: + - + - name: os_version + description: The version of an Available OS of a Test Base Account. + types: + - + - name: insider_channel + description: The insider channel of an Available OS of a Test Base Account. + types: + - + - name: os_update_type + description: The OS update type of an Available OS of a Test Base Account. + types: + - + - name: os_platform + description: The Platform of an Available OS of a Test Base Account. + types: + - +variables: +- description: Resource ID. + name: id + types: + - +- description: Resource name. + name: name + types: + - +- description: Resource type. + name: type + types: + - +- description: The system metadata relating to this resource. + name: system_data + types: + - +- description: The Id of an Available OS of a Test Base Account. + name: os_id + types: + - +- description: The name of an Available OS of a Test Base Account. + name: os_name + types: + - +- description: The version of an Available OS of a Test Base Account. + name: os_version + types: + - +- description: The insider channel of an Available OS of a Test Base Account. + name: insider_channel + types: + - +- description: The OS update type of an Available OS of a Test Base Account. + name: os_update_type + types: + - +- description: The Platform of an Available OS of a Test Base Account. + name: os_platform + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubExecutionUsageDetail.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubExecutionUsageDetail.yml new file mode 100644 index 00000000..ce14307f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubExecutionUsageDetail.yml @@ -0,0 +1,100 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.BillingHubExecutionUsageDetail +name: BillingHubExecutionUsageDetail +fullName: azure.mgmt.testbase.models.BillingHubExecutionUsageDetail +module: azure.mgmt.testbase.models +summary: BillingHubExecutionUsageDetail. +constructor: + syntax: 'BillingHubExecutionUsageDetail(*, application_name: str | None = None, + application_version: str | None = None, execution_request_id: str | None = None, + sku: str | None = None, meter_id: str | None = None, start_time_stamp: datetime + | None = None, end_time_stamp: datetime | None = None, os_build: str | None = + None, release: str | None = None, test_type: str | None = None, update_type: str + | None = None, used_free_hours: float | None = None, used_billable_hours: float + | None = None, billed_charges: float | None = None, **kwargs)' + keywordOnlyParameters: + - name: application_name + types: + - + - name: application_version + types: + - + - name: execution_request_id + types: + - + - name: sku + types: + - + - name: meter_id + types: + - + - name: start_time_stamp + types: + - + - name: end_time_stamp + types: + - + - name: os_build + types: + - + - name: release + types: + - + - name: test_type + types: + - + - name: update_type + types: + - + - name: used_free_hours + types: + - + - name: used_billable_hours + types: + - + - name: billed_charges + types: + - +variables: +- name: application_name + types: + - +- name: application_version + types: + - +- name: execution_request_id + types: + - +- name: sku + types: + - +- name: meter_id + types: + - +- name: start_time_stamp + types: + - +- name: end_time_stamp + types: + - +- name: os_build + types: + - +- name: release + types: + - +- name: test_type + types: + - +- name: update_type + types: + - +- name: used_free_hours + types: + - +- name: used_billable_hours + types: + - +- name: billed_charges + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubFreeHourIncrementEntry.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubFreeHourIncrementEntry.yml new file mode 100644 index 00000000..19d8ab0d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubFreeHourIncrementEntry.yml @@ -0,0 +1,36 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.BillingHubFreeHourIncrementEntry +name: BillingHubFreeHourIncrementEntry +fullName: azure.mgmt.testbase.models.BillingHubFreeHourIncrementEntry +module: azure.mgmt.testbase.models +summary: BillingHubFreeHourIncrementEntry. +constructor: + syntax: 'BillingHubFreeHourIncrementEntry(*, create_time_stamp: datetime | None + = None, expiration_time_stamp: datetime | None = None, incremental_free_hours: + float | None = None, remaining_free_hours: float | None = None, **kwargs)' + keywordOnlyParameters: + - name: create_time_stamp + types: + - + - name: expiration_time_stamp + types: + - + - name: incremental_free_hours + types: + - + - name: remaining_free_hours + types: + - +variables: +- name: create_time_stamp + types: + - +- name: expiration_time_stamp + types: + - +- name: incremental_free_hours + types: + - +- name: remaining_free_hours + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetFreeHourBalanceResponse.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetFreeHourBalanceResponse.yml new file mode 100644 index 00000000..462cdaca --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetFreeHourBalanceResponse.yml @@ -0,0 +1,24 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.BillingHubGetFreeHourBalanceResponse +name: BillingHubGetFreeHourBalanceResponse +fullName: azure.mgmt.testbase.models.BillingHubGetFreeHourBalanceResponse +module: azure.mgmt.testbase.models +summary: BillingHubGetFreeHourBalanceResponse. +constructor: + syntax: 'BillingHubGetFreeHourBalanceResponse(*, total_remaining_free_hours: float + | None = None, increment_entries: List[_models.BillingHubFreeHourIncrementEntry] + | None = None, **kwargs)' + keywordOnlyParameters: + - name: total_remaining_free_hours + types: + - + - name: increment_entries + types: + - [] +variables: +- name: total_remaining_free_hours + types: + - +- name: increment_entries + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetUsageRequest.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetUsageRequest.yml new file mode 100644 index 00000000..0efbc138 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetUsageRequest.yml @@ -0,0 +1,42 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.BillingHubGetUsageRequest +name: BillingHubGetUsageRequest +fullName: azure.mgmt.testbase.models.BillingHubGetUsageRequest +module: azure.mgmt.testbase.models +summary: 'BillingHubGetUsageRequest. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'BillingHubGetUsageRequest(*, start_time_stamp: datetime, end_time_stamp: + datetime, page_size: int | None = None, page_index: int | None = None, **kwargs)' + keywordOnlyParameters: + - name: start_time_stamp + description: Required. + types: + - + - name: end_time_stamp + description: Required. + types: + - + - name: page_size + types: + - + - name: page_index + types: + - +variables: +- description: Required. + name: start_time_stamp + types: + - +- description: Required. + name: end_time_stamp + types: + - +- name: page_size + types: + - +- name: page_index + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetUsageResponse.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetUsageResponse.yml new file mode 100644 index 00000000..8054092f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetUsageResponse.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.BillingHubGetUsageResponse +name: BillingHubGetUsageResponse +fullName: azure.mgmt.testbase.models.BillingHubGetUsageResponse +module: azure.mgmt.testbase.models +summary: BillingHubGetUsageResponse. +constructor: + syntax: 'BillingHubGetUsageResponse(*, total_used_free_hours: float | None = None, + total_used_billable_hours: float | None = None, total_charges: float | None = + None, package_usage_entries: List[_models.BillingHubPackageUsage] | None = None, + next_request: _models.BillingHubGetUsageRequest | None = None, **kwargs)' + keywordOnlyParameters: + - name: total_used_free_hours + types: + - + - name: total_used_billable_hours + types: + - + - name: total_charges + types: + - + - name: package_usage_entries + types: + - [] + - name: next_request + types: + - +variables: +- name: total_used_free_hours + types: + - +- name: total_used_billable_hours + types: + - +- name: total_charges + types: + - +- name: package_usage_entries + types: + - [] +- name: next_request + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubPackageUsage.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubPackageUsage.yml new file mode 100644 index 00000000..4bd8c07b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubPackageUsage.yml @@ -0,0 +1,56 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.BillingHubPackageUsage +name: BillingHubPackageUsage +fullName: azure.mgmt.testbase.models.BillingHubPackageUsage +module: azure.mgmt.testbase.models +summary: BillingHubPackageUsage. +constructor: + syntax: 'BillingHubPackageUsage(*, application_name: str | None = None, application_version: + str | None = None, azure_resource_uri: str | None = None, total_used_free_hours: + float | None = None, total_used_billable_hours: float | None = None, total_charges: + float | None = None, usage_entries_grouped_by_update_type: List[_models.BillingHubUsageGroupedByUpdateType] + | None = None, **kwargs)' + keywordOnlyParameters: + - name: application_name + types: + - + - name: application_version + types: + - + - name: azure_resource_uri + types: + - + - name: total_used_free_hours + types: + - + - name: total_used_billable_hours + types: + - + - name: total_charges + types: + - + - name: usage_entries_grouped_by_update_type + types: + - [] +variables: +- name: application_name + types: + - +- name: application_version + types: + - +- name: azure_resource_uri + types: + - +- name: total_used_free_hours + types: + - +- name: total_used_billable_hours + types: + - +- name: total_charges + types: + - +- name: usage_entries_grouped_by_update_type + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsage.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsage.yml new file mode 100644 index 00000000..e12039dc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsage.yml @@ -0,0 +1,56 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.BillingHubUsage +name: BillingHubUsage +fullName: azure.mgmt.testbase.models.BillingHubUsage +module: azure.mgmt.testbase.models +summary: BillingHubUsage. +constructor: + syntax: 'BillingHubUsage(*, application_name: str | None = None, application_version: + str | None = None, azure_resource_uri: str | None = None, total_used_free_hours: + float | None = None, total_used_billable_hours: float | None = None, total_charges: + float | None = None, usage_groups: List[_models.BillingHubUsageGroup] | None = + None, **kwargs)' + keywordOnlyParameters: + - name: application_name + types: + - + - name: application_version + types: + - + - name: azure_resource_uri + types: + - + - name: total_used_free_hours + types: + - + - name: total_used_billable_hours + types: + - + - name: total_charges + types: + - + - name: usage_groups + types: + - [] +variables: +- name: application_name + types: + - +- name: application_version + types: + - +- name: azure_resource_uri + types: + - +- name: total_used_free_hours + types: + - +- name: total_used_billable_hours + types: + - +- name: total_charges + types: + - +- name: usage_groups + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsageGroup.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsageGroup.yml new file mode 100644 index 00000000..ac4985d3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsageGroup.yml @@ -0,0 +1,81 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.BillingHubUsageGroup +name: BillingHubUsageGroup +fullName: azure.mgmt.testbase.models.BillingHubUsageGroup +module: azure.mgmt.testbase.models +summary: BillingHubUsageGroup. +constructor: + syntax: 'BillingHubUsageGroup(*, total_used_free_hours: float | None = None, total_used_billable_hours: + float | None = None, total_charges: float | None = None, release_build_revision: + int | None = None, release_build_number: int | None = None, release_build_date: + datetime | None = None, os_build: str | None = None, release: str | None = None, + test_type: str | None = None, product_family: str | None = None, execution_usage_details: + List[_models.BillingHubExecutionUsageDetail] | None = None, **kwargs)' + keywordOnlyParameters: + - name: total_used_free_hours + types: + - + - name: total_used_billable_hours + types: + - + - name: total_charges + types: + - + - name: release_build_revision + types: + - + - name: release_build_number + types: + - + - name: release_build_date + types: + - + - name: os_build + types: + - + - name: release + types: + - + - name: test_type + types: + - + - name: product_family + types: + - + - name: execution_usage_details + types: + - [] +variables: +- name: total_used_free_hours + types: + - +- name: total_used_billable_hours + types: + - +- name: total_charges + types: + - +- name: release_build_revision + types: + - +- name: release_build_number + types: + - +- name: release_build_date + types: + - +- name: os_build + types: + - +- name: release + types: + - +- name: test_type + types: + - +- name: product_family + types: + - +- name: execution_usage_details + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsageGroupedByUpdateType.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsageGroupedByUpdateType.yml new file mode 100644 index 00000000..50a4b8b4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsageGroupedByUpdateType.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.BillingHubUsageGroupedByUpdateType +name: BillingHubUsageGroupedByUpdateType +fullName: azure.mgmt.testbase.models.BillingHubUsageGroupedByUpdateType +module: azure.mgmt.testbase.models +summary: BillingHubUsageGroupedByUpdateType. +constructor: + syntax: 'BillingHubUsageGroupedByUpdateType(*, update_type: str | None = None, total_used_free_hours: + float | None = None, total_used_billable_hours: float | None = None, total_charges: + float | None = None, usage_groups: List[_models.BillingHubUsageGroup] | None = + None, **kwargs)' + keywordOnlyParameters: + - name: update_type + types: + - + - name: total_used_free_hours + types: + - + - name: total_used_billable_hours + types: + - + - name: total_charges + types: + - + - name: usage_groups + types: + - [] +variables: +- name: update_type + types: + - +- name: total_used_free_hours + types: + - +- name: total_used_billable_hours + types: + - +- name: total_charges + types: + - +- name: usage_groups + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CPURegressionResultSingletonResourceProperties.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CPURegressionResultSingletonResourceProperties.yml new file mode 100644 index 00000000..1a59e774 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CPURegressionResultSingletonResourceProperties.yml @@ -0,0 +1,48 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.CPURegressionResultSingletonResourceProperties +name: CPURegressionResultSingletonResourceProperties +fullName: azure.mgmt.testbase.models.CPURegressionResultSingletonResourceProperties +module: azure.mgmt.testbase.models +summary: 'The properties of CPU Regression Result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CPURegressionResultSingletonResourceProperties(*, grade: str | _models.Grade + | None = None, cpu_regression_results: List[_models.RegressionResult] | None = + None, **kwargs)' + keywordOnlyParameters: + - name: grade + description: 'The grade of the test. Known values are: "None", "NotAvailable", + "Pass", and + + "Fail".' + types: + - + - + - name: cpu_regression_results + description: The result array data. + types: + - [] +variables: +- description: 'The grade of the test. Known values are: "None", "NotAvailable", "Pass", + and + + "Fail".' + name: grade + types: + - + - +- description: 'Type of the Analysis Result. Required. Known values are: + + "ScriptExecution", "Reliability", "CPUUtilization", "MemoryUtilization", "CPURegression", + + "MemoryRegression", and "TestAnalysis".' + name: analysis_result_type + types: + - + - +- description: The result array data. + name: cpu_regression_results + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CPUUtilizationResultSingletonResourceProperties.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CPUUtilizationResultSingletonResourceProperties.yml new file mode 100644 index 00000000..63aa8cca --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CPUUtilizationResultSingletonResourceProperties.yml @@ -0,0 +1,48 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.CPUUtilizationResultSingletonResourceProperties +name: CPUUtilizationResultSingletonResourceProperties +fullName: azure.mgmt.testbase.models.CPUUtilizationResultSingletonResourceProperties +module: azure.mgmt.testbase.models +summary: 'The properties of CPU Utilization Result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CPUUtilizationResultSingletonResourceProperties(*, grade: str | _models.Grade + | None = None, cpu_utilization_results: List[_models.UtilizationResult] | None + = None, **kwargs)' + keywordOnlyParameters: + - name: grade + description: 'The grade of the test. Known values are: "None", "NotAvailable", + "Pass", and + + "Fail".' + types: + - + - + - name: cpu_utilization_results + description: The result array data. + types: + - [] +variables: +- description: 'The grade of the test. Known values are: "None", "NotAvailable", "Pass", + and + + "Fail".' + name: grade + types: + - + - +- description: 'Type of the Analysis Result. Required. Known values are: + + "ScriptExecution", "Reliability", "CPUUtilization", "MemoryUtilization", "CPURegression", + + "MemoryRegression", and "TestAnalysis".' + name: analysis_result_type + types: + - + - +- description: The result array data. + name: cpu_utilization_results + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Category.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Category.yml new file mode 100644 index 00000000..1d661df7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Category.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.testbase.models.Category +name: Category +fullName: azure.mgmt.testbase.models.Category +summary: The category of the failure. +module: azure.mgmt.testbase.models +fields: +- name: INFRASTRUCTURE + uid: azure.mgmt.testbase.models.Category.INFRASTRUCTURE +- name: NONE + uid: azure.mgmt.testbase.models.Category.NONE +- name: OS_UPDATE + uid: azure.mgmt.testbase.models.Category.OS_UPDATE +- name: PACKAGE + uid: azure.mgmt.testbase.models.Category.PACKAGE +- name: UNIDENTIFIED + uid: azure.mgmt.testbase.models.Category.UNIDENTIFIED diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CheckNameAvailabilityResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CheckNameAvailabilityResult.yml new file mode 100644 index 00000000..77dc8e4a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CheckNameAvailabilityResult.yml @@ -0,0 +1,50 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.CheckNameAvailabilityResult +name: CheckNameAvailabilityResult +fullName: azure.mgmt.testbase.models.CheckNameAvailabilityResult +module: azure.mgmt.testbase.models +summary: 'Description of a Check Name availability response properties. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'CheckNameAvailabilityResult(*, name_available: bool | None = None, reason: + str | _models.Reason | None = None, **kwargs)' + keywordOnlyParameters: + - name: name_available + description: 'Value indicating the availability of the name: true if the name + is + + available; otherwise, false.' + types: + - + - name: reason + description: 'The reason for unavailability of a name. Required if nameAvailable + == false. + + Known values are: "Invalid" and "AlreadyExists".' + types: + - + - +variables: +- description: 'Value indicating the availability of the name: true if the name is + + available; otherwise, false.' + name: name_available + types: + - +- description: 'The reason for unavailability of a name. Required if nameAvailable + == false. + + Known values are: "Invalid" and "AlreadyExists".' + name: reason + types: + - + - +- description: 'The detailed info regarding the reason associated with the name. Required + if + + nameAvailable == false.' + name: message + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Command.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Command.yml new file mode 100644 index 00000000..76dce36a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Command.yml @@ -0,0 +1,114 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.Command +name: Command +fullName: azure.mgmt.testbase.models.Command +module: azure.mgmt.testbase.models +summary: 'The command used in the test. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Command(*, name: str, action: str | _models.Action, content_type: str | + _models.ContentType, content: str, run_elevated: bool | None = None, restart_after: + bool | None = None, max_run_time: int | None = None, run_as_interactive: bool + | None = None, always_run: bool | None = None, apply_update_before: bool | None + = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: The name of the command. Required. + types: + - + - name: action + description: 'The action of the command. Required. Known values are: "Install", + "Launch", + + "Close", "Uninstall", and "Custom".' + types: + - + - + - name: content_type + description: 'The type of command content. Required. Known values are: "Inline", + + "File", and "Path".' + types: + - + - + - name: content + description: The content of the command. The content depends on source type. Required. + types: + - + - name: run_elevated + description: Specifies whether to run the command as administrator. + types: + - + - name: restart_after + description: Specifies whether to restart the VM after the command executed. + types: + - + - name: max_run_time + description: Specifies the max run time of the command. + types: + - + - name: run_as_interactive + description: Specifies whether to run the command in interactive mode. + types: + - + - name: always_run + description: Specifies whether to run the command even if a previous command is + failed. + types: + - + - name: apply_update_before + description: Specifies whether to apply update before the command. + types: + - +variables: +- description: The name of the command. Required. + name: name + types: + - +- description: 'The action of the command. Required. Known values are: "Install", + "Launch", + + "Close", "Uninstall", and "Custom".' + name: action + types: + - + - +- description: 'The type of command content. Required. Known values are: "Inline", + "File", + + and "Path".' + name: content_type + types: + - + - +- description: The content of the command. The content depends on source type. Required. + name: content + types: + - +- description: Specifies whether to run the command as administrator. + name: run_elevated + types: + - +- description: Specifies whether to restart the VM after the command executed. + name: restart_after + types: + - +- description: Specifies the max run time of the command. + name: max_run_time + types: + - +- description: Specifies whether to run the command in interactive mode. + name: run_as_interactive + types: + - +- description: Specifies whether to run the command even if a previous command is + failed. + name: always_run + types: + - +- description: Specifies whether to apply update before the command. + name: apply_update_before + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ContentType.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ContentType.yml new file mode 100644 index 00000000..e0509e59 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ContentType.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.testbase.models.ContentType +name: ContentType +fullName: azure.mgmt.testbase.models.ContentType +summary: The type of command content. +module: azure.mgmt.testbase.models +fields: +- name: FILE + uid: azure.mgmt.testbase.models.ContentType.FILE +- name: INLINE + uid: azure.mgmt.testbase.models.ContentType.INLINE +- name: PATH + uid: azure.mgmt.testbase.models.ContentType.PATH diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CreatedByType.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CreatedByType.yml new file mode 100644 index 00000000..97377e1b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CreatedByType.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.testbase.models.CreatedByType +name: CreatedByType +fullName: azure.mgmt.testbase.models.CreatedByType +summary: The type of identity that created the resource. +module: azure.mgmt.testbase.models +fields: +- name: APPLICATION + uid: azure.mgmt.testbase.models.CreatedByType.APPLICATION +- name: KEY + uid: azure.mgmt.testbase.models.CreatedByType.KEY +- name: MANAGED_IDENTITY + uid: azure.mgmt.testbase.models.CreatedByType.MANAGED_IDENTITY +- name: USER + uid: azure.mgmt.testbase.models.CreatedByType.USER diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CustomerEventListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CustomerEventListResult.yml new file mode 100644 index 00000000..ecb18104 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CustomerEventListResult.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.CustomerEventListResult +name: CustomerEventListResult +fullName: azure.mgmt.testbase.models.CustomerEventListResult +module: azure.mgmt.testbase.models +summary: 'A list of Test Base Customer Events. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'CustomerEventListResult(*, value: List[_models.CustomerEventResource] | + None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: The list of Test Base Customer Events. + types: + - [] +variables: +- description: The list of Test Base Customer Events. + name: value + types: + - [] +- description: 'Link to the next set of results. Not empty if value contains incomplete + list + + of results.' + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CustomerEventResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CustomerEventResource.yml new file mode 100644 index 00000000..6a836b3c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CustomerEventResource.yml @@ -0,0 +1,46 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.CustomerEventResource +name: CustomerEventResource +fullName: azure.mgmt.testbase.models.CustomerEventResource +module: azure.mgmt.testbase.models +summary: 'The Customer Notification Event resource. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'CustomerEventResource(*, event_name: str | None = None, receivers: List[_models.NotificationEventReceiver] + | None = None, **kwargs)' + keywordOnlyParameters: + - name: event_name + description: The name of the event subscribed to. + types: + - + - name: receivers + description: The notification event receivers. + types: + - [] +variables: +- description: Resource ID. + name: id + types: + - +- description: Resource name. + name: name + types: + - +- description: Resource type. + name: type + types: + - +- description: The system metadata relating to this resource. + name: system_data + types: + - +- description: The name of the event subscribed to. + name: event_name + types: + - +- description: The notification event receivers. + name: receivers + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.DistributionGroupListReceiverValue.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.DistributionGroupListReceiverValue.yml new file mode 100644 index 00000000..5f340f37 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.DistributionGroupListReceiverValue.yml @@ -0,0 +1,19 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.DistributionGroupListReceiverValue +name: DistributionGroupListReceiverValue +fullName: azure.mgmt.testbase.models.DistributionGroupListReceiverValue +module: azure.mgmt.testbase.models +summary: The user object receiver value. +constructor: + syntax: 'DistributionGroupListReceiverValue(*, distribution_groups: List[str] | + None = None, **kwargs)' + keywordOnlyParameters: + - name: distribution_groups + description: The list of distribution groups. + types: + - [] +variables: +- description: The list of distribution groups. + name: distribution_groups + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.DownloadURLResponse.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.DownloadURLResponse.yml new file mode 100644 index 00000000..25f6bf8d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.DownloadURLResponse.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.DownloadURLResponse +name: DownloadURLResponse +fullName: azure.mgmt.testbase.models.DownloadURLResponse +module: azure.mgmt.testbase.models +summary: 'The response of getting a download URL. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: DownloadURLResponse(**kwargs) +variables: +- description: The download URL. + name: download_url + types: + - +- description: Expiry date of the download URL. + name: expiration_time + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.EmailEventListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.EmailEventListResult.yml new file mode 100644 index 00000000..70d1bdac --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.EmailEventListResult.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.EmailEventListResult +name: EmailEventListResult +fullName: azure.mgmt.testbase.models.EmailEventListResult +module: azure.mgmt.testbase.models +summary: 'A list of email events. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'EmailEventListResult(*, value: List[_models.EmailEventResource] | None + = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: The list of email events. + types: + - [] +variables: +- description: The list of email events. + name: value + types: + - [] +- description: 'Link to the next set of results. Not empty if value contains incomplete + list + + of results.' + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.EmailEventResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.EmailEventResource.yml new file mode 100644 index 00000000..59db72d7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.EmailEventResource.yml @@ -0,0 +1,54 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.EmailEventResource +name: EmailEventResource +fullName: azure.mgmt.testbase.models.EmailEventResource +module: azure.mgmt.testbase.models +summary: 'The email event resource. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'EmailEventResource(*, event_id: str | None = None, event_name: str | None + = None, display_name: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: event_id + description: The identifier of the email event. + types: + - + - name: event_name + description: The name of the email event. + types: + - + - name: display_name + description: The display name of the email event. + types: + - +variables: +- description: Resource ID. + name: id + types: + - +- description: Resource name. + name: name + types: + - +- description: Resource type. + name: type + types: + - +- description: The system metadata relating to this resource. + name: system_data + types: + - +- description: The identifier of the email event. + name: event_id + types: + - +- description: The name of the email event. + name: event_name + types: + - +- description: The display name of the email event. + name: display_name + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ErrorDefinition.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ErrorDefinition.yml new file mode 100644 index 00000000..d3e4e879 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ErrorDefinition.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.ErrorDefinition +name: ErrorDefinition +fullName: azure.mgmt.testbase.models.ErrorDefinition +module: azure.mgmt.testbase.models +summary: 'Error definition. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: ErrorDefinition(**kwargs) +variables: +- description: The error code. + name: code + types: + - +- description: The error message. + name: message + types: + - +- description: The target of the particular error. + name: target + types: + - +- description: The error details. + name: details + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ErrorResponse.yml new file mode 100644 index 00000000..baa1e44e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ErrorResponse.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.ErrorResponse +name: ErrorResponse +fullName: azure.mgmt.testbase.models.ErrorResponse +module: azure.mgmt.testbase.models +summary: The error response send when an operation fails. +constructor: + syntax: 'ErrorResponse(*, error: _models.ErrorDefinition | None = None, **kwargs)' + keywordOnlyParameters: + - name: error + description: The error details. + types: + - +variables: +- description: The error details. + name: error + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ExecutionStatus.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ExecutionStatus.yml new file mode 100644 index 00000000..dd59430a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ExecutionStatus.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.testbase.models.ExecutionStatus +name: ExecutionStatus +fullName: azure.mgmt.testbase.models.ExecutionStatus +summary: The execution status of a test. +module: azure.mgmt.testbase.models +fields: +- name: COMPLETED + uid: azure.mgmt.testbase.models.ExecutionStatus.COMPLETED +- name: FAILED + uid: azure.mgmt.testbase.models.ExecutionStatus.FAILED +- name: INCOMPLETE + uid: azure.mgmt.testbase.models.ExecutionStatus.INCOMPLETE +- name: IN_PROGRESS + uid: azure.mgmt.testbase.models.ExecutionStatus.IN_PROGRESS +- name: NONE + uid: azure.mgmt.testbase.models.ExecutionStatus.NONE +- name: NOT_EXECUTED + uid: azure.mgmt.testbase.models.ExecutionStatus.NOT_EXECUTED +- name: PROCESSING + uid: azure.mgmt.testbase.models.ExecutionStatus.PROCESSING +- name: SUCCEEDED + uid: azure.mgmt.testbase.models.ExecutionStatus.SUCCEEDED diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FavoriteProcessListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FavoriteProcessListResult.yml new file mode 100644 index 00000000..ee37a1d1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FavoriteProcessListResult.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.FavoriteProcessListResult +name: FavoriteProcessListResult +fullName: azure.mgmt.testbase.models.FavoriteProcessListResult +module: azure.mgmt.testbase.models +summary: 'A list of favorite processes for a package. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'FavoriteProcessListResult(*, value: List[_models.FavoriteProcessResource] + | None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: The list of favorite processes for a package. + types: + - [] +variables: +- description: The list of favorite processes for a package. + name: value + types: + - [] +- description: 'Link to the next set of results. Not empty if value contains incomplete + list + + of results.' + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FavoriteProcessResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FavoriteProcessResource.yml new file mode 100644 index 00000000..f4435d41 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FavoriteProcessResource.yml @@ -0,0 +1,47 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.FavoriteProcessResource +name: FavoriteProcessResource +fullName: azure.mgmt.testbase.models.FavoriteProcessResource +module: azure.mgmt.testbase.models +summary: 'A favorite process identifier. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'FavoriteProcessResource(*, actual_process_name: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: actual_process_name + description: 'The actual name of the favorite process. It will be equal to + + resource name except for the scenario that the process name contains characters + that are not + + allowed in the resource name.' + types: + - +variables: +- description: Resource ID. + name: id + types: + - +- description: Resource name. + name: name + types: + - +- description: Resource type. + name: type + types: + - +- description: The system metadata relating to this resource. + name: system_data + types: + - +- description: 'The actual name of the favorite process. It will be equal to + + resource name except for the scenario that the process name contains characters + that are not + + allowed in the resource name.' + name: actual_process_name + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FileUploadURLResponse.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FileUploadURLResponse.yml new file mode 100644 index 00000000..36723055 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FileUploadURLResponse.yml @@ -0,0 +1,22 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.FileUploadURLResponse +name: FileUploadURLResponse +fullName: azure.mgmt.testbase.models.FileUploadURLResponse +module: azure.mgmt.testbase.models +summary: 'The URL response. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: FileUploadURLResponse(**kwargs) +variables: +- description: The URL used for uploading the package. + name: upload_url + types: + - +- description: 'The blob path of the uploaded package. It will be used as the ''blobPath'' + + property of PackageResource.' + name: blob_path + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FlightingRingListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FlightingRingListResult.yml new file mode 100644 index 00000000..8a2e24d7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FlightingRingListResult.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.FlightingRingListResult +name: FlightingRingListResult +fullName: azure.mgmt.testbase.models.FlightingRingListResult +module: azure.mgmt.testbase.models +summary: 'A list of flighting rings. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'FlightingRingListResult(*, value: List[_models.FlightingRingResource] | + None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: The list of flighting rings. + types: + - [] +variables: +- description: The list of flighting rings. + name: value + types: + - [] +- description: 'Link to the next set of results. Not empty if value contains incomplete + list + + of results.' + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FlightingRingResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FlightingRingResource.yml new file mode 100644 index 00000000..abe49cb3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FlightingRingResource.yml @@ -0,0 +1,40 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.FlightingRingResource +name: FlightingRingResource +fullName: azure.mgmt.testbase.models.FlightingRingResource +module: azure.mgmt.testbase.models +summary: 'The flighting ring resource. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'FlightingRingResource(*, actual_flighting_ring_name: str | None = None, + **kwargs)' + keywordOnlyParameters: + - name: actual_flighting_ring_name + description: 'The actual name of a flighting ring of a Test Base + + Account.' + types: + - +variables: +- description: Resource ID. + name: id + types: + - +- description: Resource name. + name: name + types: + - +- description: Resource type. + name: type + types: + - +- description: The system metadata relating to this resource. + name: system_data + types: + - +- description: The actual name of a flighting ring of a Test Base Account. + name: actual_flighting_ring_name + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.GetFileUploadURLParameters.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.GetFileUploadURLParameters.yml new file mode 100644 index 00000000..d751b41e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.GetFileUploadURLParameters.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.GetFileUploadURLParameters +name: GetFileUploadURLParameters +fullName: azure.mgmt.testbase.models.GetFileUploadURLParameters +module: azure.mgmt.testbase.models +summary: The parameters supplied to the Test Base Account GetFileUploadURL action. +constructor: + syntax: 'GetFileUploadURLParameters(*, blob_name: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: blob_name + description: The custom file name of the uploaded blob. + types: + - +variables: +- description: The custom file name of the uploaded blob. + name: blob_name + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Grade.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Grade.yml new file mode 100644 index 00000000..86d51ff3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Grade.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.testbase.models.Grade +name: Grade +fullName: azure.mgmt.testbase.models.Grade +summary: The grade of a test. +module: azure.mgmt.testbase.models +fields: +- name: FAIL + uid: azure.mgmt.testbase.models.Grade.FAIL +- name: NONE + uid: azure.mgmt.testbase.models.Grade.NONE +- name: NOT_AVAILABLE + uid: azure.mgmt.testbase.models.Grade.NOT_AVAILABLE +- name: PASS + uid: azure.mgmt.testbase.models.Grade.PASS diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.IdentifiedFailure.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.IdentifiedFailure.yml new file mode 100644 index 00000000..798db5c3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.IdentifiedFailure.yml @@ -0,0 +1,50 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.IdentifiedFailure +name: IdentifiedFailure +fullName: azure.mgmt.testbase.models.IdentifiedFailure +module: azure.mgmt.testbase.models +summary: The failure identified. +constructor: + syntax: 'IdentifiedFailure(*, failure_id: str | None = None, category: str | _models.Category + | None = None, error_message: str | None = None, guidance: str | None = None, + **kwargs)' + keywordOnlyParameters: + - name: failure_id + description: The Failure Id. + types: + - + - name: category + description: 'The category of the failure. Known values are: "None", "Unidentified", + + "Package", "OSUpdate", and "Infrastructure".' + types: + - + - + - name: error_message + description: Message that shows information about the failure. + types: + - + - name: guidance + description: Guidance that shows what the customer needs to do for this failure. + types: + - +variables: +- description: The Failure Id. + name: failure_id + types: + - +- description: 'The category of the failure. Known values are: "None", "Unidentified", + + "Package", "OSUpdate", and "Infrastructure".' + name: category + types: + - + - +- description: Message that shows information about the failure. + name: error_message + types: + - +- description: Guidance that shows what the customer needs to do for this failure. + name: guidance + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.MemoryRegressionResultSingletonResourceProperties.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.MemoryRegressionResultSingletonResourceProperties.yml new file mode 100644 index 00000000..9cd7ca57 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.MemoryRegressionResultSingletonResourceProperties.yml @@ -0,0 +1,48 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.MemoryRegressionResultSingletonResourceProperties +name: MemoryRegressionResultSingletonResourceProperties +fullName: azure.mgmt.testbase.models.MemoryRegressionResultSingletonResourceProperties +module: azure.mgmt.testbase.models +summary: 'The properties of Memory Regression Result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MemoryRegressionResultSingletonResourceProperties(*, grade: str | _models.Grade + | None = None, memory_regression_results: List[_models.RegressionResult] | None + = None, **kwargs)' + keywordOnlyParameters: + - name: grade + description: 'The grade of the test. Known values are: "None", "NotAvailable", + "Pass", and + + "Fail".' + types: + - + - + - name: memory_regression_results + description: The result array data. + types: + - [] +variables: +- description: 'The grade of the test. Known values are: "None", "NotAvailable", "Pass", + and + + "Fail".' + name: grade + types: + - + - +- description: 'Type of the Analysis Result. Required. Known values are: + + "ScriptExecution", "Reliability", "CPUUtilization", "MemoryUtilization", "CPURegression", + + "MemoryRegression", and "TestAnalysis".' + name: analysis_result_type + types: + - + - +- description: The result array data. + name: memory_regression_results + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.MemoryUtilizationResultSingletonResourceProperties.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.MemoryUtilizationResultSingletonResourceProperties.yml new file mode 100644 index 00000000..3d376b40 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.MemoryUtilizationResultSingletonResourceProperties.yml @@ -0,0 +1,48 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.MemoryUtilizationResultSingletonResourceProperties +name: MemoryUtilizationResultSingletonResourceProperties +fullName: azure.mgmt.testbase.models.MemoryUtilizationResultSingletonResourceProperties +module: azure.mgmt.testbase.models +summary: 'The properties of Memory Utilization Result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MemoryUtilizationResultSingletonResourceProperties(*, grade: str | _models.Grade + | None = None, memory_utilization_results: List[_models.UtilizationResult] | None + = None, **kwargs)' + keywordOnlyParameters: + - name: grade + description: 'The grade of the test. Known values are: "None", "NotAvailable", + "Pass", and + + "Fail".' + types: + - + - + - name: memory_utilization_results + description: The result array data. + types: + - [] +variables: +- description: 'The grade of the test. Known values are: "None", "NotAvailable", "Pass", + and + + "Fail".' + name: grade + types: + - + - +- description: 'Type of the Analysis Result. Required. Known values are: + + "ScriptExecution", "Reliability", "CPUUtilization", "MemoryUtilization", "CPURegression", + + "MemoryRegression", and "TestAnalysis".' + name: analysis_result_type + types: + - + - +- description: The result array data. + name: memory_utilization_results + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.NotificationEventReceiver.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.NotificationEventReceiver.yml new file mode 100644 index 00000000..3348352b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.NotificationEventReceiver.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.NotificationEventReceiver +name: NotificationEventReceiver +fullName: azure.mgmt.testbase.models.NotificationEventReceiver +module: azure.mgmt.testbase.models +summary: A notification event receivers. +constructor: + syntax: 'NotificationEventReceiver(*, receiver_type: str | None = None, receiver_value: + _models.NotificationReceiverValue | None = None, **kwargs)' + keywordOnlyParameters: + - name: receiver_type + description: The type of the notification event receiver. + types: + - + - name: receiver_value + description: The notification event receiver value. + types: + - +variables: +- description: The type of the notification event receiver. + name: receiver_type + types: + - +- description: The notification event receiver value. + name: receiver_value + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.NotificationReceiverValue.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.NotificationReceiverValue.yml new file mode 100644 index 00000000..597cb75a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.NotificationReceiverValue.yml @@ -0,0 +1,37 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.NotificationReceiverValue +name: NotificationReceiverValue +fullName: azure.mgmt.testbase.models.NotificationReceiverValue +module: azure.mgmt.testbase.models +summary: A notification event receiver value. +constructor: + syntax: 'NotificationReceiverValue(*, user_object_receiver_value: _models.UserObjectReceiverValue + | None = None, subscription_receiver_value: _models.SubscriptionReceiverValue + | None = None, distribution_group_list_receiver_value: _models.DistributionGroupListReceiverValue + | None = None, **kwargs)' + keywordOnlyParameters: + - name: user_object_receiver_value + description: The user object receiver value. + types: + - + - name: subscription_receiver_value + description: The user object receiver value. + types: + - + - name: distribution_group_list_receiver_value + description: The user object receiver value. + types: + - +variables: +- description: The user object receiver value. + name: user_object_receiver_value + types: + - +- description: The user object receiver value. + name: subscription_receiver_value + types: + - +- description: The user object receiver value. + name: distribution_group_list_receiver_value + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateListResult.yml new file mode 100644 index 00000000..21969b25 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateListResult.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.OSUpdateListResult +name: OSUpdateListResult +fullName: azure.mgmt.testbase.models.OSUpdateListResult +module: azure.mgmt.testbase.models +summary: 'A list of OS Updates. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'OSUpdateListResult(*, value: List[_models.OSUpdateResource] | None = None, + **kwargs)' + keywordOnlyParameters: + - name: value + description: The list of OS Updates. + types: + - [] +variables: +- description: The list of OS Updates. + name: value + types: + - [] +- description: 'Link to the next set of results. Not empty if value contains incomplete + list + + of results.' + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateResource.yml new file mode 100644 index 00000000..8c2cfbb7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateResource.yml @@ -0,0 +1,94 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.OSUpdateResource +name: OSUpdateResource +fullName: azure.mgmt.testbase.models.OSUpdateResource +module: azure.mgmt.testbase.models +summary: 'An OS Update. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'OSUpdateResource(*, os_name: str | None = None, release: str | None = None, + flighting_ring: str | None = None, build_version: str | None = None, build_revision: + str | None = None, type_properties_type: str | _models.Type | None = None, release_version_date: + datetime | None = None, **kwargs)' + keywordOnlyParameters: + - name: os_name + description: The name of the OS. + types: + - + - name: release + description: The name of tested release. + types: + - + - name: flighting_ring + description: The flighting ring, only for release of feature updates. + types: + - + - name: build_version + description: The build version of the tested release (OS update). + types: + - + - name: build_revision + description: The build revision of the tested release (OS update). + types: + - + - name: type_properties_type + description: 'The type of this release (OS update). Known values are: + + "SecurityUpdate" and "FeatureUpdate".' + types: + - + - + - name: release_version_date + description: The release version date the tested release (OS update). + types: + - +variables: +- description: Resource ID. + name: id + types: + - +- description: Resource name. + name: name + types: + - +- description: Resource type. + name: type + types: + - +- description: The system metadata relating to this resource. + name: system_data + types: + - +- description: The name of the OS. + name: os_name + types: + - +- description: The name of tested release. + name: release + types: + - +- description: The flighting ring, only for release of feature updates. + name: flighting_ring + types: + - +- description: The build version of the tested release (OS update). + name: build_version + types: + - +- description: The build revision of the tested release (OS update). + name: build_revision + types: + - +- description: 'The type of this release (OS update). Known values are: + + "SecurityUpdate" and "FeatureUpdate".' + name: type_properties_type + types: + - + - +- description: The release version date the tested release (OS update). + name: release_version_date + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateTestSummary.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateTestSummary.yml new file mode 100644 index 00000000..85a66f7c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateTestSummary.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.OSUpdateTestSummary +name: OSUpdateTestSummary +fullName: azure.mgmt.testbase.models.OSUpdateTestSummary +module: azure.mgmt.testbase.models +summary: The summary of a test. +constructor: + syntax: 'OSUpdateTestSummary(*, os_name: str | None = None, release_name: str | + None = None, build_version: str | None = None, build_revision: str | None = None, + release_version_date: datetime | None = None, flighting_ring: str | None = None, + execution_status: str | _models.ExecutionStatus | None = None, test_status: str + | _models.TestStatus | None = None, grade: str | _models.Grade | None = None, + test_run_time: str | None = None, test_type: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: os_name + description: The operating system name. e.g. Windows 10 1809. + types: + - + - name: release_name + description: The name of the tested release (OS update). + types: + - + - name: build_version + description: The build version of the tested release (OS update). + types: + - + - name: build_revision + description: The build revision of the tested release (OS update). + types: + - + - name: release_version_date + description: The release version date. + types: + - + - name: flighting_ring + description: The flighting ring, only for release of feature updates. + types: + - + - name: execution_status + description: 'The execution status of the test. Known values are: "None", + + "InProgress", "Processing", "Completed", "NotExecuted", "Incomplete", "Failed", + and + + "Succeeded".' + types: + - + - + - name: test_status + description: 'The status of the test. Known values are: "None", + + "TestExecutionInProgress", "DataProcessing", "TestFailure", "UpdateFailure", + + "TestAndUpdateFailure", "InfrastructureFailure", and "Completed".' + types: + - + - + - name: grade + description: 'The grade of the test. Known values are: "None", "NotAvailable", + "Pass", and + + "Fail".' + types: + - + - + - name: test_run_time + description: The run time of the test. + types: + - + - name: test_type + description: The test type of the package. + types: + - +variables: +- description: The operating system name. e.g. Windows 10 1809. + name: os_name + types: + - +- description: The name of the tested release (OS update). + name: release_name + types: + - +- description: The build version of the tested release (OS update). + name: build_version + types: + - +- description: The build revision of the tested release (OS update). + name: build_revision + types: + - +- description: The release version date. + name: release_version_date + types: + - +- description: The flighting ring, only for release of feature updates. + name: flighting_ring + types: + - +- description: 'The execution status of the test. Known values are: "None", + + "InProgress", "Processing", "Completed", "NotExecuted", "Incomplete", "Failed", + and + + "Succeeded".' + name: execution_status + types: + - + - +- description: 'The status of the test. Known values are: "None", "TestExecutionInProgress", + + "DataProcessing", "TestFailure", "UpdateFailure", "TestAndUpdateFailure", + + "InfrastructureFailure", and "Completed".' + name: test_status + types: + - + - +- description: 'The grade of the test. Known values are: "None", "NotAvailable", "Pass", + and + + "Fail".' + name: grade + types: + - + - +- description: The run time of the test. + name: test_run_time + types: + - +- description: The test type of the package. + name: test_type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdatesTestSummary.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdatesTestSummary.yml new file mode 100644 index 00000000..44ef6005 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdatesTestSummary.yml @@ -0,0 +1,77 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.OSUpdatesTestSummary +name: OSUpdatesTestSummary +fullName: azure.mgmt.testbase.models.OSUpdatesTestSummary +module: azure.mgmt.testbase.models +summary: The summary of some tests. +constructor: + syntax: 'OSUpdatesTestSummary(*, execution_status: str | _models.ExecutionStatus + | None = None, test_status: str | _models.TestStatus | None = None, grade: str + | _models.Grade | None = None, test_run_time: str | None = None, os_update_test_summaries: + List[_models.OSUpdateTestSummary] | None = None, **kwargs)' + keywordOnlyParameters: + - name: execution_status + description: 'The status of the last test. Known values are: "None", "InProgress", + + "Processing", "Completed", "NotExecuted", "Incomplete", "Failed", and "Succeeded".' + types: + - + - + - name: test_status + description: 'The status of last test. Known values are: "None", + + "TestExecutionInProgress", "DataProcessing", "TestFailure", "UpdateFailure", + + "TestAndUpdateFailure", "InfrastructureFailure", and "Completed".' + types: + - + - + - name: grade + description: 'The grade of last test. Known values are: "None", "NotAvailable", + "Pass", and + + "Fail".' + types: + - + - + - name: test_run_time + description: The run time of the last test. + types: + - + - name: os_update_test_summaries + description: Detailed summary for each OS update. + types: + - [] +variables: +- description: 'The status of the last test. Known values are: "None", "InProgress", + + "Processing", "Completed", "NotExecuted", "Incomplete", "Failed", and "Succeeded".' + name: execution_status + types: + - + - +- description: 'The status of last test. Known values are: "None", + + "TestExecutionInProgress", "DataProcessing", "TestFailure", "UpdateFailure", + + "TestAndUpdateFailure", "InfrastructureFailure", and "Completed".' + name: test_status + types: + - + - +- description: 'The grade of last test. Known values are: "None", "NotAvailable", + "Pass", and + + "Fail".' + name: grade + types: + - + - +- description: The run time of the last test. + name: test_run_time + types: + - +- description: Detailed summary for each OS update. + name: os_update_test_summaries + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Operation.yml new file mode 100644 index 00000000..55dd91f5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Operation.yml @@ -0,0 +1,42 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.Operation +name: Operation +fullName: azure.mgmt.testbase.models.Operation +module: azure.mgmt.testbase.models +summary: 'REST API operation. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'Operation(*, display: _models.OperationDisplay | None = None, properties: + MutableMapping[str, Any] | None = None, **kwargs)' + keywordOnlyParameters: + - name: display + description: The object that describes the operation. + types: + - + - name: properties + description: Extra properties of the operation. + types: + - +variables: +- description: 'Operation name: {provider}/{resource}/{operation}.' + name: name + types: + - +- description: Indicates whether the operation is a data action. + name: is_data_action + types: + - +- description: Origin of the operation. + name: origin + types: + - +- description: The object that describes the operation. + name: display + types: + - +- description: Extra properties of the operation. + name: properties + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OperationDisplay.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OperationDisplay.yml new file mode 100644 index 00000000..335dcf11 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OperationDisplay.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.OperationDisplay +name: OperationDisplay +fullName: azure.mgmt.testbase.models.OperationDisplay +module: azure.mgmt.testbase.models +summary: 'The object that describes the operation. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: OperationDisplay(**kwargs) +variables: +- description: 'The resource provider name: Microsoft.TestBase.' + name: provider + types: + - +- description: 'Operation type: read, write, delete, listPackages, etc.' + name: operation + types: + - +- description: Resource type on which the operation is performed. + name: resource + types: + - +- description: Friendly name of the operation. + name: description + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OperationListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OperationListResult.yml new file mode 100644 index 00000000..e14f7181 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OperationListResult.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.OperationListResult +name: OperationListResult +fullName: azure.mgmt.testbase.models.OperationListResult +module: azure.mgmt.testbase.models +summary: 'A list of operations supported by the resource provider. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'OperationListResult(*, value: List[_models.Operation] | None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: List of operations supported by the Test Base resource provider. + types: + - [] +variables: +- description: List of operations supported by the Test Base resource provider. + name: value + types: + - [] +- description: URL to get the next set of operation list results if there are any. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OsUpdateType.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OsUpdateType.yml new file mode 100644 index 00000000..8150c7b9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OsUpdateType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.testbase.models.OsUpdateType +name: OsUpdateType +fullName: azure.mgmt.testbase.models.OsUpdateType +summary: Specifies the OS update type to test against. +module: azure.mgmt.testbase.models +fields: +- name: FEATURE_UPDATE + uid: azure.mgmt.testbase.models.OsUpdateType.FEATURE_UPDATE +- name: SECURITY_UPDATE + uid: azure.mgmt.testbase.models.OsUpdateType.SECURITY_UPDATE diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageCheckNameAvailabilityParameters.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageCheckNameAvailabilityParameters.yml new file mode 100644 index 00000000..79747078 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageCheckNameAvailabilityParameters.yml @@ -0,0 +1,46 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.PackageCheckNameAvailabilityParameters +name: PackageCheckNameAvailabilityParameters +fullName: azure.mgmt.testbase.models.PackageCheckNameAvailabilityParameters +module: azure.mgmt.testbase.models +summary: 'Parameters body to pass for Test Base Package name availability check. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PackageCheckNameAvailabilityParameters(*, name: str, application_name: + str, version: str, type: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Resource name to verify. Required. + types: + - + - name: application_name + description: Application name to verify. Required. + types: + - + - name: version + description: Version name to verify. Required. + types: + - + - name: type + description: fully qualified resource type which includes provider namespace. + types: + - +variables: +- description: Resource name to verify. Required. + name: name + types: + - +- description: Application name to verify. Required. + name: application_name + types: + - +- description: Version name to verify. Required. + name: version + types: + - +- description: fully qualified resource type which includes provider namespace. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageListResult.yml new file mode 100644 index 00000000..8f0881dd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageListResult.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.PackageListResult +name: PackageListResult +fullName: azure.mgmt.testbase.models.PackageListResult +module: azure.mgmt.testbase.models +summary: 'A list of Test Base Packages. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'PackageListResult(*, value: List[_models.PackageResource] | None = None, + **kwargs)' + keywordOnlyParameters: + - name: value + description: The list of Test Base Packages. + types: + - [] +variables: +- description: The list of Test Base Packages. + name: value + types: + - [] +- description: 'Link to the next set of results. Not empty if value contains incomplete + list + + of results.' + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageResource.yml new file mode 100644 index 00000000..ffee7ea3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageResource.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.PackageResource +name: PackageResource +fullName: azure.mgmt.testbase.models.PackageResource +module: azure.mgmt.testbase.models +summary: 'The Test Base Package resource. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PackageResource(*, location: str, tags: Dict[str, str] | None = None, application_name: + str | None = None, version: str | None = None, target_os_list: List[_models.TargetOSInfo] + | None = None, flighting_ring: str | None = None, blob_path: str | None = None, + tests: List[_models.Test] | None = None, **kwargs)' + keywordOnlyParameters: + - name: tags + description: The tags of the resource. + types: + - [, ] + - name: location + description: The geo-location where the resource lives. Required. + types: + - + - name: application_name + description: Application name. + types: + - + - name: version + description: Application version. + types: + - + - name: target_os_list + description: Specifies the target OSs of specific OS Update types. + types: + - [] + - name: flighting_ring + description: The flighting ring for feature update. + types: + - + - name: blob_path + description: The file path of the package. + types: + - + - name: tests + description: The detailed test information. + types: + - [] +variables: +- description: Resource ID. + name: id + types: + - +- description: Resource name. + name: name + types: + - +- description: Resource type. + name: type + types: + - +- description: The tags of the resource. + name: tags + types: + - [, ] +- description: The geo-location where the resource lives. Required. + name: location + types: + - +- description: Resource Etag. + name: etag + types: + - +- description: The system metadata relating to this resource. + name: system_data + types: + - +- description: 'The provisioning state of the resource. Known values are: + + "Succeeded", "Failed", "Cancelled", "Creating", "Deleting", and "Updating".' + name: provisioning_state + types: + - + - +- description: Application name. + name: application_name + types: + - +- description: Application version. + name: version + types: + - +- description: OOB, functional or both. Mapped to the data in 'tests' property. + name: test_types + types: + - [ + - ] +- description: Specifies the target OSs of specific OS Update types. + name: target_os_list + types: + - [] +- description: 'The status of the package. Known values are: "Unknown", "Registered", + + "Ready", "Error", "ValidatingPackage", "PreValidationCheckPass", "Deleted", + + "ValidationLongerThanUsual", and "VerifyingPackage".' + name: package_status + types: + - + - +- description: The UTC timestamp when the package was last modified. + name: last_modified_time + types: + - +- description: The flighting ring for feature update. + name: flighting_ring + types: + - +- description: 'Flag showing that whether the package is enabled. It doesn''t schedule + test + + for package which is not enabled.' + name: is_enabled + types: + - +- description: The file path of the package. + name: blob_path + types: + - +- description: 'The validation results. There''s validation on package when it''s + + created or updated.' + name: validation_results + types: + - [] +- description: The detailed test information. + name: tests + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageRunTestParameters.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageRunTestParameters.yml new file mode 100644 index 00000000..cfc89559 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageRunTestParameters.yml @@ -0,0 +1,68 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.PackageRunTestParameters +name: PackageRunTestParameters +fullName: azure.mgmt.testbase.models.PackageRunTestParameters +module: azure.mgmt.testbase.models +summary: 'The parameters supplied to the Test Base Package to start a Test Run. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PackageRunTestParameters(*, test_type: str | _models.TestType, os_name: + str, os_update_type: str | _models.OsUpdateType | None = None, release_name: str + | None = None, flighting_ring: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: test_type + description: 'The type of the test. Required. Known values are: "OutOfBoxTest" + and + + "FunctionalTest".' + types: + - + - + - name: os_update_type + description: 'Specifies the OS update type to test against. Known values are: + + "SecurityUpdate" and "FeatureUpdate".' + types: + - + - + - name: os_name + description: The operating system name. e.g. Windows 10 1809. Required. + types: + - + - name: release_name + description: The name of the tested release (OS update). + types: + - + - name: flighting_ring + description: The flighting ring, only for release of feature updates. + types: + - +variables: +- description: 'The type of the test. Required. Known values are: "OutOfBoxTest" and + + "FunctionalTest".' + name: test_type + types: + - + - +- description: 'Specifies the OS update type to test against. Known values are: + + "SecurityUpdate" and "FeatureUpdate".' + name: os_update_type + types: + - + - +- description: The operating system name. e.g. Windows 10 1809. Required. + name: os_name + types: + - +- description: The name of the tested release (OS update). + name: release_name + types: + - +- description: The flighting ring, only for release of feature updates. + name: flighting_ring + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageStatus.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageStatus.yml new file mode 100644 index 00000000..fc65deb1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageStatus.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.testbase.models.PackageStatus +name: PackageStatus +fullName: azure.mgmt.testbase.models.PackageStatus +summary: The status of the package. +module: azure.mgmt.testbase.models +fields: +- name: DELETED + uid: azure.mgmt.testbase.models.PackageStatus.DELETED +- name: ERROR + uid: azure.mgmt.testbase.models.PackageStatus.ERROR +- name: PRE_VALIDATION_CHECK_PASS + uid: azure.mgmt.testbase.models.PackageStatus.PRE_VALIDATION_CHECK_PASS +- name: READY + uid: azure.mgmt.testbase.models.PackageStatus.READY +- name: REGISTERED + uid: azure.mgmt.testbase.models.PackageStatus.REGISTERED +- name: UNKNOWN + uid: azure.mgmt.testbase.models.PackageStatus.UNKNOWN +- name: VALIDATING_PACKAGE + uid: azure.mgmt.testbase.models.PackageStatus.VALIDATING_PACKAGE +- name: VALIDATION_LONGER_THAN_USUAL + uid: azure.mgmt.testbase.models.PackageStatus.VALIDATION_LONGER_THAN_USUAL +- name: VERIFYING_PACKAGE + uid: azure.mgmt.testbase.models.PackageStatus.VERIFYING_PACKAGE diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageUpdateParameters.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageUpdateParameters.yml new file mode 100644 index 00000000..231f53b7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageUpdateParameters.yml @@ -0,0 +1,67 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.PackageUpdateParameters +name: PackageUpdateParameters +fullName: azure.mgmt.testbase.models.PackageUpdateParameters +module: azure.mgmt.testbase.models +summary: Parameters supplied to update a Test Base Package. +constructor: + syntax: 'PackageUpdateParameters(*, tags: Dict[str, str] | None = None, target_os_list: + List[_models.TargetOSInfo] | None = None, flighting_ring: str | None = None, is_enabled: + bool | None = None, blob_path: str | None = None, tests: List[_models.Test] | + None = None, **kwargs)' + keywordOnlyParameters: + - name: tags + description: The tags of the Package. + types: + - [, ] + - name: target_os_list + description: Specifies the target OSs of specific OS Update types. + types: + - [] + - name: flighting_ring + description: The flighting ring for feature update. + types: + - + - name: is_enabled + description: 'Specifies whether the package is enabled. It doesn''t schedule test + for + + package which is not enabled.' + types: + - + - name: blob_path + description: The file name of the package. + types: + - + - name: tests + description: The detailed test information. + types: + - [] +variables: +- description: The tags of the Package. + name: tags + types: + - [, ] +- description: Specifies the target OSs of specific OS Update types. + name: target_os_list + types: + - [] +- description: The flighting ring for feature update. + name: flighting_ring + types: + - +- description: 'Specifies whether the package is enabled. It doesn''t schedule test + for + + package which is not enabled.' + name: is_enabled + types: + - +- description: The file name of the package. + name: blob_path + types: + - +- description: The detailed test information. + name: tests + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageValidationResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageValidationResult.yml new file mode 100644 index 00000000..018332b1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageValidationResult.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.PackageValidationResult +name: PackageValidationResult +fullName: azure.mgmt.testbase.models.PackageValidationResult +module: azure.mgmt.testbase.models +summary: 'The validation results. There''s validation on package when it''s created + or updated. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: PackageValidationResult(**kwargs) +variables: +- description: Validation name. + name: validation_name + types: + - +- description: Indicates whether the package passed the validation. + name: is_valid + types: + - +- description: Error information. + name: errors + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ProvisioningState.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ProvisioningState.yml new file mode 100644 index 00000000..bad1a0ba --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ProvisioningState.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.testbase.models.ProvisioningState +name: ProvisioningState +fullName: azure.mgmt.testbase.models.ProvisioningState +summary: 'ARM provisioning state, see + + [https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property](https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property).' +module: azure.mgmt.testbase.models +fields: +- name: CANCELLED + uid: azure.mgmt.testbase.models.ProvisioningState.CANCELLED +- name: CREATING + uid: azure.mgmt.testbase.models.ProvisioningState.CREATING +- name: DELETING + uid: azure.mgmt.testbase.models.ProvisioningState.DELETING +- name: FAILED + uid: azure.mgmt.testbase.models.ProvisioningState.FAILED +- name: SUCCEEDED + uid: azure.mgmt.testbase.models.ProvisioningState.SUCCEEDED +- name: UPDATING + uid: azure.mgmt.testbase.models.ProvisioningState.UPDATING diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ProxyResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ProxyResource.yml new file mode 100644 index 00000000..bb010b26 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ProxyResource.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.ProxyResource +name: ProxyResource +fullName: azure.mgmt.testbase.models.ProxyResource +module: azure.mgmt.testbase.models +summary: 'The resource model definition for an ARM proxy resource. It will have everything + other than required location and tags. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: ProxyResource(**kwargs) +variables: +- description: Resource ID. + name: id + types: + - +- description: Resource name. + name: name + types: + - +- description: Resource type. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Reason.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Reason.yml new file mode 100644 index 00000000..90fc72f8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Reason.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.testbase.models.Reason +name: Reason +fullName: azure.mgmt.testbase.models.Reason +summary: The reason for unavailability of a name. Required if nameAvailable == false. +module: azure.mgmt.testbase.models +fields: +- name: ALREADY_EXISTS + uid: azure.mgmt.testbase.models.Reason.ALREADY_EXISTS +- name: INVALID + uid: azure.mgmt.testbase.models.Reason.INVALID diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.RegressionResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.RegressionResult.yml new file mode 100644 index 00000000..d3fb79a3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.RegressionResult.yml @@ -0,0 +1,64 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.RegressionResult +name: RegressionResult +fullName: azure.mgmt.testbase.models.RegressionResult +module: azure.mgmt.testbase.models +summary: The regression result. +constructor: + syntax: 'RegressionResult(*, file_name: str | None = None, grade: str | _models.Grade + | None = None, details: str | None = None, diff: float | None = None, is_regressed: + bool | None = None, **kwargs)' + keywordOnlyParameters: + - name: file_name + description: FileName of the binary being analyzed. + types: + - + - name: grade + description: 'The grade of the test. Known values are: "None", "NotAvailable", + "Pass", and + + "Fail".' + types: + - + - + - name: details + description: 'Message that facilitates debugging a particular regression, if any + was + + inferred.' + types: + - + - name: diff + description: Difference between the two datasets being analyzed. + types: + - + - name: is_regressed + description: Indicates if a regression was inferred. + types: + - +variables: +- description: FileName of the binary being analyzed. + name: file_name + types: + - +- description: 'The grade of the test. Known values are: "None", "NotAvailable", "Pass", + and + + "Fail".' + name: grade + types: + - + - +- description: Message that facilitates debugging a particular regression, if any + was inferred. + name: details + types: + - +- description: Difference between the two datasets being analyzed. + name: diff + types: + - +- description: Indicates if a regression was inferred. + name: is_regressed + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.RegressionTestDetails.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.RegressionTestDetails.yml new file mode 100644 index 00000000..43f04704 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.RegressionTestDetails.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.RegressionTestDetails +name: RegressionTestDetails +fullName: azure.mgmt.testbase.models.RegressionTestDetails +module: azure.mgmt.testbase.models +summary: The details of a regression test. +constructor: + syntax: 'RegressionTestDetails(*, diff: float | None = None, is_regressed: bool + | None = None, **kwargs)' + keywordOnlyParameters: + - name: diff + description: Difference between the two datasets being analyzed. + types: + - + - name: is_regressed + description: Indicates if a regression was inferred. + types: + - +variables: +- description: Difference between the two datasets being analyzed. + name: diff + types: + - +- description: Indicates if a regression was inferred. + name: is_regressed + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ReliabilityResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ReliabilityResult.yml new file mode 100644 index 00000000..e2d423b9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ReliabilityResult.yml @@ -0,0 +1,105 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.ReliabilityResult +name: ReliabilityResult +fullName: azure.mgmt.testbase.models.ReliabilityResult +module: azure.mgmt.testbase.models +summary: The Reliability Result. +constructor: + syntax: 'ReliabilityResult(*, file_name: str | None = None, launch_count: int | + None = None, crash_count: int | None = None, hang_count: int | None = None, regression_grade: + str | _models.Grade | None = None, crash_regression_grade: str | _models.Grade + | None = None, crash_regression_test_details: _models.RegressionTestDetails | + None = None, hang_regression_grade: str | _models.Grade | None = None, hang_regression_test_details: + _models.RegressionTestDetails | None = None, **kwargs)' + keywordOnlyParameters: + - name: file_name + description: File name. + types: + - + - name: launch_count + description: Count of number of launches. + types: + - + - name: crash_count + description: Count of number of crashes. + types: + - + - name: hang_count + description: Count of number of hangs. + types: + - + - name: regression_grade + description: 'The regression grade. Known values are: "None", "NotAvailable", + + "Pass", and "Fail".' + types: + - + - + - name: crash_regression_grade + description: 'The statistic regression grade for crash signal. Known values + + are: "None", "NotAvailable", "Pass", and "Fail".' + types: + - + - + - name: crash_regression_test_details + description: Details related to the crash regression analysis. + types: + - + - name: hang_regression_grade + description: 'The statistic regression grade for hang signal. Known values + + are: "None", "NotAvailable", "Pass", and "Fail".' + types: + - + - + - name: hang_regression_test_details + description: Details related to the hang regression analysis. + types: + - +variables: +- description: File name. + name: file_name + types: + - +- description: Count of number of launches. + name: launch_count + types: + - +- description: Count of number of crashes. + name: crash_count + types: + - +- description: Count of number of hangs. + name: hang_count + types: + - +- description: 'The regression grade. Known values are: "None", "NotAvailable", "Pass", + + and "Fail".' + name: regression_grade + types: + - + - +- description: 'The statistic regression grade for crash signal. Known values + + are: "None", "NotAvailable", "Pass", and "Fail".' + name: crash_regression_grade + types: + - + - +- description: Details related to the crash regression analysis. + name: crash_regression_test_details + types: + - +- description: 'The statistic regression grade for hang signal. Known values are: + + "None", "NotAvailable", "Pass", and "Fail".' + name: hang_regression_grade + types: + - + - +- description: Details related to the hang regression analysis. + name: hang_regression_test_details + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ReliabilityResultSingletonResourceProperties.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ReliabilityResultSingletonResourceProperties.yml new file mode 100644 index 00000000..2dfa31bc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ReliabilityResultSingletonResourceProperties.yml @@ -0,0 +1,48 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.ReliabilityResultSingletonResourceProperties +name: ReliabilityResultSingletonResourceProperties +fullName: azure.mgmt.testbase.models.ReliabilityResultSingletonResourceProperties +module: azure.mgmt.testbase.models +summary: 'The properties of Reliability Result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ReliabilityResultSingletonResourceProperties(*, grade: str | _models.Grade + | None = None, reliability_results: List[_models.ReliabilityResult] | None = None, + **kwargs)' + keywordOnlyParameters: + - name: grade + description: 'The grade of the test. Known values are: "None", "NotAvailable", + "Pass", and + + "Fail".' + types: + - + - + - name: reliability_results + description: The result array data. + types: + - [] +variables: +- description: 'The grade of the test. Known values are: "None", "NotAvailable", "Pass", + and + + "Fail".' + name: grade + types: + - + - +- description: 'Type of the Analysis Result. Required. Known values are: + + "ScriptExecution", "Reliability", "CPUUtilization", "MemoryUtilization", "CPURegression", + + "MemoryRegression", and "TestAnalysis".' + name: analysis_result_type + types: + - + - +- description: The result array data. + name: reliability_results + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Resource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Resource.yml new file mode 100644 index 00000000..f7b58734 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Resource.yml @@ -0,0 +1,24 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.Resource +name: Resource +fullName: azure.mgmt.testbase.models.Resource +module: azure.mgmt.testbase.models +summary: 'The Resource definition. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: Resource(**kwargs) +variables: +- description: Resource ID. + name: id + types: + - +- description: Resource name. + name: name + types: + - +- description: Resource type. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ScriptExecutionResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ScriptExecutionResult.yml new file mode 100644 index 00000000..cc553ce3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ScriptExecutionResult.yml @@ -0,0 +1,69 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.ScriptExecutionResult +name: ScriptExecutionResult +fullName: azure.mgmt.testbase.models.ScriptExecutionResult +module: azure.mgmt.testbase.models +summary: The Script Execution Result. +constructor: + syntax: 'ScriptExecutionResult(*, script_name: str | None = None, start_time: datetime + | None = None, end_time: datetime | None = None, exit_code: int | None = None, + timed_out: bool | None = None, stdout_log_file_name: str | None = None, stderr_log_file_name: + str | None = None, **kwargs)' + keywordOnlyParameters: + - name: script_name + description: Name of script. + types: + - + - name: start_time + description: Start time of script execution. + types: + - + - name: end_time + description: End time of script execution. + types: + - + - name: exit_code + description: Exit code. + types: + - + - name: timed_out + description: Whether the script execution is timed out. + types: + - + - name: stdout_log_file_name + description: The stdout log file name. + types: + - + - name: stderr_log_file_name + description: The stderr log file name. + types: + - +variables: +- description: Name of script. + name: script_name + types: + - +- description: Start time of script execution. + name: start_time + types: + - +- description: End time of script execution. + name: end_time + types: + - +- description: Exit code. + name: exit_code + types: + - +- description: Whether the script execution is timed out. + name: timed_out + types: + - +- description: The stdout log file name. + name: stdout_log_file_name + types: + - +- description: The stderr log file name. + name: stderr_log_file_name + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ScriptExecutionResultSingletonResourceProperties.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ScriptExecutionResultSingletonResourceProperties.yml new file mode 100644 index 00000000..fbc49d14 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ScriptExecutionResultSingletonResourceProperties.yml @@ -0,0 +1,48 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.ScriptExecutionResultSingletonResourceProperties +name: ScriptExecutionResultSingletonResourceProperties +fullName: azure.mgmt.testbase.models.ScriptExecutionResultSingletonResourceProperties +module: azure.mgmt.testbase.models +summary: 'The properties of Script Execution Result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ScriptExecutionResultSingletonResourceProperties(*, grade: str | _models.Grade + | None = None, script_execution_results: List[_models.ScriptExecutionResult] | + None = None, **kwargs)' + keywordOnlyParameters: + - name: grade + description: 'The grade of the test. Known values are: "None", "NotAvailable", + "Pass", and + + "Fail".' + types: + - + - + - name: script_execution_results + description: The result array data. + types: + - [] +variables: +- description: 'The grade of the test. Known values are: "None", "NotAvailable", "Pass", + and + + "Fail".' + name: grade + types: + - + - +- description: 'Type of the Analysis Result. Required. Known values are: + + "ScriptExecution", "Reliability", "CPUUtilization", "MemoryUtilization", "CPURegression", + + "MemoryRegression", and "TestAnalysis".' + name: analysis_result_type + types: + - + - +- description: The result array data. + name: script_execution_results + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.SubscriptionReceiverValue.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.SubscriptionReceiverValue.yml new file mode 100644 index 00000000..701d2d23 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.SubscriptionReceiverValue.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.SubscriptionReceiverValue +name: SubscriptionReceiverValue +fullName: azure.mgmt.testbase.models.SubscriptionReceiverValue +module: azure.mgmt.testbase.models +summary: The subscription role receiver value. +constructor: + syntax: 'SubscriptionReceiverValue(*, subscription_id: str | None = None, subscription_name: + str | None = None, role: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: subscription_id + description: The subscription id of the notification receiver. + types: + - + - name: subscription_name + description: The subscription name of the notification receiver. + types: + - + - name: role + description: The role of the notification receiver. + types: + - +variables: +- description: The subscription id of the notification receiver. + name: subscription_id + types: + - +- description: The subscription name of the notification receiver. + name: subscription_name + types: + - +- description: The role of the notification receiver. + name: role + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.SystemData.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.SystemData.yml new file mode 100644 index 00000000..9dad45f8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.SystemData.yml @@ -0,0 +1,73 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.SystemData +name: SystemData +fullName: azure.mgmt.testbase.models.SystemData +module: azure.mgmt.testbase.models +summary: Metadata pertaining to creation and last modification of the resource. +constructor: + syntax: 'SystemData(*, created_by: str | None = None, created_by_type: str | _models.CreatedByType + | None = None, created_at: datetime | None = None, last_modified_by: str | None + = None, last_modified_by_type: str | _models.CreatedByType | None = None, last_modified_at: + datetime | None = None, **kwargs)' + keywordOnlyParameters: + - name: created_by + description: The identity that created the resource. + types: + - + - name: created_by_type + description: 'The type of identity that created the resource. Known values are: + + "User", "Application", "ManagedIdentity", and "Key".' + types: + - + - + - name: created_at + description: The timestamp of resource creation (UTC). + types: + - + - name: last_modified_by + description: The identity that last modified the resource. + types: + - + - name: last_modified_by_type + description: 'The type of identity that last modified the resource. Known + + values are: "User", "Application", "ManagedIdentity", and "Key".' + types: + - + - + - name: last_modified_at + description: The type of identity that last modified the resource. + types: + - +variables: +- description: The identity that created the resource. + name: created_by + types: + - +- description: 'The type of identity that created the resource. Known values are: + + "User", "Application", "ManagedIdentity", and "Key".' + name: created_by_type + types: + - + - +- description: The timestamp of resource creation (UTC). + name: created_at + types: + - +- description: The identity that last modified the resource. + name: last_modified_by + types: + - +- description: 'The type of identity that last modified the resource. Known values + + are: "User", "Application", "ManagedIdentity", and "Key".' + name: last_modified_by_type + types: + - + - +- description: The type of identity that last modified the resource. + name: last_modified_at + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TargetOSInfo.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TargetOSInfo.yml new file mode 100644 index 00000000..1baeb06d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TargetOSInfo.yml @@ -0,0 +1,43 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.TargetOSInfo +name: TargetOSInfo +fullName: azure.mgmt.testbase.models.TargetOSInfo +module: azure.mgmt.testbase.models +summary: 'The information of the target OS to be tested. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TargetOSInfo(*, os_update_type: str, target_o_ss: List[str], baseline_o_ss: + List[str] | None = None, **kwargs)' + keywordOnlyParameters: + - name: os_update_type + description: 'Specifies the OS update type to test against, e.g., ''Security updates'' + + or ''Feature updates''. Required.' + types: + - + - name: target_o_ss + description: Specifies the target OSs to be tested. Required. + types: + - [] + - name: baseline_o_ss + description: Specifies the baseline OSs to be tested. + types: + - [] +variables: +- description: 'Specifies the OS update type to test against, e.g., ''Security updates'' + or + + ''Feature updates''. Required.' + name: os_update_type + types: + - +- description: Specifies the target OSs to be tested. Required. + name: target_o_ss + types: + - [] +- description: Specifies the baseline OSs to be tested. + name: baseline_o_ss + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Test.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Test.yml new file mode 100644 index 00000000..6011cd60 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Test.yml @@ -0,0 +1,63 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.Test +name: Test +fullName: azure.mgmt.testbase.models.Test +module: azure.mgmt.testbase.models +summary: 'The definition of a Test. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Test(*, test_type: str | _models.TestType, commands: List[_models.Command], + is_active: bool | None = None, **kwargs)' + keywordOnlyParameters: + - name: test_type + description: 'The type of the test. Required. Known values are: "OutOfBoxTest" + and + + "FunctionalTest".' + types: + - + - + - name: is_active + description: 'Indicates if this test is active.It doesn''t schedule test for not + active + + Test.' + types: + - + - name: commands + description: The commands used in the test. Required. + types: + - [] +variables: +- description: 'The type of the test. Required. Known values are: "OutOfBoxTest" and + + "FunctionalTest".' + name: test_type + types: + - + - +- description: 'The status of the validation run of the package. Known values are: + + "Unknown", "Pending", "Passed", and "Failed".' + name: validation_run_status + types: + - + - +- description: Resource identifier of the validation test result. + name: validation_result_id + types: + - +- description: Indicates if this test is active.It doesn't schedule test for not active + Test. + name: is_active + types: + - +- description: The commands used in the test. Required. + name: commands + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestAnalysisResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestAnalysisResult.yml new file mode 100644 index 00000000..49c0f283 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestAnalysisResult.yml @@ -0,0 +1,42 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.TestAnalysisResult +name: TestAnalysisResult +fullName: azure.mgmt.testbase.models.TestAnalysisResult +module: azure.mgmt.testbase.models +summary: The test analysis result. +constructor: + syntax: 'TestAnalysisResult(*, blob_data: str | None = None, test_analysis_status: + str | _models.TestAnalysisStatus | None = None, identified_failures: List[_models.IdentifiedFailure] + | None = None, **kwargs)' + keywordOnlyParameters: + - name: blob_data + description: The data to provide more failure analysis information. + types: + - + - name: test_analysis_status + description: 'The status of the analysis. Known values are: "None", + + "Analyzing", "Completed", and "Failed".' + types: + - + - + - name: identified_failures + description: The array of identified failures. + types: + - [] +variables: +- description: The data to provide more failure analysis information. + name: blob_data + types: + - +- description: 'The status of the analysis. Known values are: "None", "Analyzing", + + "Completed", and "Failed".' + name: test_analysis_status + types: + - + - +- description: The array of identified failures. + name: identified_failures + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestAnalysisResultSingletonResourceProperties.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestAnalysisResultSingletonResourceProperties.yml new file mode 100644 index 00000000..2858eafd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestAnalysisResultSingletonResourceProperties.yml @@ -0,0 +1,48 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.TestAnalysisResultSingletonResourceProperties +name: TestAnalysisResultSingletonResourceProperties +fullName: azure.mgmt.testbase.models.TestAnalysisResultSingletonResourceProperties +module: azure.mgmt.testbase.models +summary: 'The properties of Test Analysis Result. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TestAnalysisResultSingletonResourceProperties(*, grade: str | _models.Grade + | None = None, test_analysis_result: _models.TestAnalysisResult | None = None, + **kwargs)' + keywordOnlyParameters: + - name: grade + description: 'The grade of the test. Known values are: "None", "NotAvailable", + "Pass", and + + "Fail".' + types: + - + - + - name: test_analysis_result + description: The result of test analysis. + types: + - +variables: +- description: 'The grade of the test. Known values are: "None", "NotAvailable", "Pass", + and + + "Fail".' + name: grade + types: + - + - +- description: 'Type of the Analysis Result. Required. Known values are: + + "ScriptExecution", "Reliability", "CPUUtilization", "MemoryUtilization", "CPURegression", + + "MemoryRegression", and "TestAnalysis".' + name: analysis_result_type + types: + - + - +- description: The result of test analysis. + name: test_analysis_result + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestAnalysisStatus.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestAnalysisStatus.yml new file mode 100644 index 00000000..1dfdd609 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestAnalysisStatus.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.testbase.models.TestAnalysisStatus +name: TestAnalysisStatus +fullName: azure.mgmt.testbase.models.TestAnalysisStatus +summary: The status of the analysis. +module: azure.mgmt.testbase.models +fields: +- name: ANALYZING + uid: azure.mgmt.testbase.models.TestAnalysisStatus.ANALYZING +- name: COMPLETED + uid: azure.mgmt.testbase.models.TestAnalysisStatus.COMPLETED +- name: FAILED + uid: azure.mgmt.testbase.models.TestAnalysisStatus.FAILED +- name: NONE + uid: azure.mgmt.testbase.models.TestAnalysisStatus.NONE diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountListResult.yml new file mode 100644 index 00000000..a05b3ec1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountListResult.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.TestBaseAccountListResult +name: TestBaseAccountListResult +fullName: azure.mgmt.testbase.models.TestBaseAccountListResult +module: azure.mgmt.testbase.models +summary: 'A list of Test Base Accounts. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'TestBaseAccountListResult(*, value: List[_models.TestBaseAccountResource] + | None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: The list of Test Base Accounts. + types: + - [] +variables: +- description: The list of Test Base Accounts. + name: value + types: + - [] +- description: 'Link to the next set of results. Not empty if value contains incomplete + list + + of results.' + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountResource.yml new file mode 100644 index 00000000..a934425e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountResource.yml @@ -0,0 +1,72 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.TestBaseAccountResource +name: TestBaseAccountResource +fullName: azure.mgmt.testbase.models.TestBaseAccountResource +module: azure.mgmt.testbase.models +summary: 'The Test Base Account resource. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TestBaseAccountResource(*, location: str, tags: Dict[str, str] | None = + None, sku: _models.TestBaseAccountSKU | None = None, **kwargs)' + keywordOnlyParameters: + - name: tags + description: The tags of the resource. + types: + - [, ] + - name: location + description: The geo-location where the resource lives. Required. + types: + - + - name: sku + description: The SKU of the Test Base Account. + types: + - +variables: +- description: Resource ID. + name: id + types: + - +- description: Resource name. + name: name + types: + - +- description: Resource type. + name: type + types: + - +- description: The tags of the resource. + name: tags + types: + - [, ] +- description: The geo-location where the resource lives. Required. + name: location + types: + - +- description: Resource Etag. + name: etag + types: + - +- description: The system metadata relating to this resource. + name: system_data + types: + - +- description: 'The provisioning state of the resource. Known values are: + + "Succeeded", "Failed", "Cancelled", "Creating", "Deleting", and "Updating".' + name: provisioning_state + types: + - + - +- description: The SKU of the Test Base Account. + name: sku + types: + - +- description: The access level of the Test Base Account. + name: access_level + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountSKU.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountSKU.yml new file mode 100644 index 00000000..bee571f3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountSKU.yml @@ -0,0 +1,61 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.TestBaseAccountSKU +name: TestBaseAccountSKU +fullName: azure.mgmt.testbase.models.TestBaseAccountSKU +module: azure.mgmt.testbase.models +summary: 'Describes a Test Base Account SKU. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TestBaseAccountSKU(*, name: str, tier: str | _models.Tier, resource_type: + str | None = None, locations: List[str] | None = None, **kwargs)' + keywordOnlyParameters: + - name: resource_type + description: The type of resource the SKU applies to. + types: + - + - name: name + description: 'The name of the SKU. This is typically a letter + number code, such + as B0 or S0. + + Required.' + types: + - + - name: tier + description: The tier of this particular SKU. Required. "Standard" + types: + - + - + - name: locations + description: The locations that the SKU is available. + types: + - [] +variables: +- description: The type of resource the SKU applies to. + name: resource_type + types: + - +- description: 'The name of the SKU. This is typically a letter + number code, such + as B0 or S0. + + Required.' + name: name + types: + - +- description: The tier of this particular SKU. Required. "Standard" + name: tier + types: + - + - +- description: The capabilities of a SKU. + name: capabilities + types: + - [] +- description: The locations that the SKU is available. + name: locations + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountSKUCapability.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountSKUCapability.yml new file mode 100644 index 00000000..38b55bd0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountSKUCapability.yml @@ -0,0 +1,31 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.TestBaseAccountSKUCapability +name: TestBaseAccountSKUCapability +fullName: azure.mgmt.testbase.models.TestBaseAccountSKUCapability +module: azure.mgmt.testbase.models +summary: 'Properties of the Test Base Account SKU Capability. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TestBaseAccountSKUCapability(*, name: str, value: str, **kwargs)' + keywordOnlyParameters: + - name: name + description: An invariant to describe the feature, such as 'SLA'. Required. + types: + - + - name: value + description: An invariant if the feature is measured by quantity, such as 99.9%. + Required. + types: + - +variables: +- description: An invariant to describe the feature, such as 'SLA'. Required. + name: name + types: + - +- description: An invariant if the feature is measured by quantity, such as 99.9%. + Required. + name: value + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountSKUListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountSKUListResult.yml new file mode 100644 index 00000000..2e24ab15 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountSKUListResult.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.TestBaseAccountSKUListResult +name: TestBaseAccountSKUListResult +fullName: azure.mgmt.testbase.models.TestBaseAccountSKUListResult +module: azure.mgmt.testbase.models +summary: 'A list of Test Base Account SKUs. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'TestBaseAccountSKUListResult(*, value: List[_models.TestBaseAccountSKU] + | None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: The list of Test Base Account SKUs. + types: + - [] +variables: +- description: The list of Test Base Account SKUs. + name: value + types: + - [] +- description: 'Link to the next set of results. Not empty if value contains incomplete + list + + of results.' + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUpdateParameters.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUpdateParameters.yml new file mode 100644 index 00000000..437ce228 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUpdateParameters.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.TestBaseAccountUpdateParameters +name: TestBaseAccountUpdateParameters +fullName: azure.mgmt.testbase.models.TestBaseAccountUpdateParameters +module: azure.mgmt.testbase.models +summary: Parameters supplied to update a Test Base Account. +constructor: + syntax: 'TestBaseAccountUpdateParameters(*, tags: Dict[str, str] | None = None, + sku: _models.TestBaseAccountSKU | None = None, **kwargs)' + keywordOnlyParameters: + - name: tags + description: The tags of the Test Base Account. + types: + - [, ] + - name: sku + description: The SKU of the Test Base Account. + types: + - +variables: +- description: The tags of the Test Base Account. + name: tags + types: + - [, ] +- description: The SKU of the Test Base Account. + name: sku + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageData.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageData.yml new file mode 100644 index 00000000..9c1965f3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageData.yml @@ -0,0 +1,64 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.TestBaseAccountUsageData +name: TestBaseAccountUsageData +fullName: azure.mgmt.testbase.models.TestBaseAccountUsageData +module: azure.mgmt.testbase.models +summary: The usage data of a Test Base Account. +constructor: + syntax: 'TestBaseAccountUsageData(*, id: str | None = None, name: _models.TestBaseAccountUsageName + | None = None, unit: str | None = None, limit: int | None = None, current_value: + int | None = None, **kwargs)' + keywordOnlyParameters: + - name: id + description: Fully qualified ARM resource id. + types: + - + - name: name + description: Localizable String object containing the name and a localized value. + types: + - + - name: unit + description: 'Representing the units of the usage quota. Possible values are: + Count, Bytes, + + Seconds, Percent, CountPerSecond, BytesPerSecond.' + types: + - + - name: limit + description: 'The maximum permitted value for the usage quota. If there is no + limit, this + + value will be -1.' + types: + - + - name: current_value + description: Current value for the usage quota. + types: + - +variables: +- description: Fully qualified ARM resource id. + name: id + types: + - +- description: Localizable String object containing the name and a localized value. + name: name + types: + - +- description: 'Representing the units of the usage quota. Possible values are: Count, + Bytes, + + Seconds, Percent, CountPerSecond, BytesPerSecond.' + name: unit + types: + - +- description: 'The maximum permitted value for the usage quota. If there is no limit, + this value + + will be -1.' + name: limit + types: + - +- description: Current value for the usage quota. + name: current_value + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageDataList.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageDataList.yml new file mode 100644 index 00000000..0569b7d0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageDataList.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.TestBaseAccountUsageDataList +name: TestBaseAccountUsageDataList +fullName: azure.mgmt.testbase.models.TestBaseAccountUsageDataList +module: azure.mgmt.testbase.models +summary: 'A list of Test Base Account usage data. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'TestBaseAccountUsageDataList(*, value: List[_models.TestBaseAccountUsageData] + | None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: The list of Test Base Account usage data. + types: + - [] +variables: +- description: The list of Test Base Account usage data. + name: value + types: + - [] +- description: 'Link to the next set of results. Not empty if value contains incomplete + list + + of results.' + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageName.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageName.yml new file mode 100644 index 00000000..a1a90aaf --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageName.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.TestBaseAccountUsageName +name: TestBaseAccountUsageName +fullName: azure.mgmt.testbase.models.TestBaseAccountUsageName +module: azure.mgmt.testbase.models +summary: Localizable String object containing the name and a localized value. +constructor: + syntax: 'TestBaseAccountUsageName(*, value: str | None = None, localized_value: + str | None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: The identifier of the usage. + types: + - + - name: localized_value + description: Localized name of the usage. + types: + - +variables: +- description: The identifier of the usage. + name: value + types: + - +- description: Localized name of the usage. + name: localized_value + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultAnalysisSummary.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultAnalysisSummary.yml new file mode 100644 index 00000000..0235136b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultAnalysisSummary.yml @@ -0,0 +1,50 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.TestResultAnalysisSummary +name: TestResultAnalysisSummary +fullName: azure.mgmt.testbase.models.TestResultAnalysisSummary +module: azure.mgmt.testbase.models +summary: The summary of a Test Analysis Result. +constructor: + syntax: 'TestResultAnalysisSummary(*, name: str | None = None, analysis_status: + str | _models.AnalysisStatus | None = None, grade: str | _models.Grade | None + = None, **kwargs)' + keywordOnlyParameters: + - name: name + description: Metric name. + types: + - + - name: analysis_status + description: 'The analysis status. Known values are: "None", "Completed", + + "InProgress", "Failed", "Succeeded", "Available", and "NotAvailable".' + types: + - + - + - name: grade + description: 'The grade of the test result. Known values are: "None", "NotAvailable", + "Pass", + + and "Fail".' + types: + - + - +variables: +- description: Metric name. + name: name + types: + - +- description: 'The analysis status. Known values are: "None", "Completed", + + "InProgress", "Failed", "Succeeded", "Available", and "NotAvailable".' + name: analysis_status + types: + - + - +- description: 'The grade of the test result. Known values are: "None", "NotAvailable", + "Pass", + + and "Fail".' + name: grade + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultConsoleLogDownloadURLParameters.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultConsoleLogDownloadURLParameters.yml new file mode 100644 index 00000000..df67d677 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultConsoleLogDownloadURLParameters.yml @@ -0,0 +1,22 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.TestResultConsoleLogDownloadURLParameters +name: TestResultConsoleLogDownloadURLParameters +fullName: azure.mgmt.testbase.models.TestResultConsoleLogDownloadURLParameters +module: azure.mgmt.testbase.models +summary: 'Parameters body to pass for getting the download URL of the test execution + console log file. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TestResultConsoleLogDownloadURLParameters(*, log_file_name: str, **kwargs)' + keywordOnlyParameters: + - name: log_file_name + description: The log file name corresponding to the download URL. Required. + types: + - +variables: +- description: The log file name corresponding to the download URL. Required. + name: log_file_name + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultListResult.yml new file mode 100644 index 00000000..9b2bc667 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultListResult.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.TestResultListResult +name: TestResultListResult +fullName: azure.mgmt.testbase.models.TestResultListResult +module: azure.mgmt.testbase.models +summary: 'A list of Test Results. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'TestResultListResult(*, value: List[_models.TestResultResource] | None + = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: The list of Test Results. + types: + - [] +variables: +- description: The list of Test Results. + name: value + types: + - [] +- description: 'Link to the next set of results. Not empty if value contains incomplete + list + + of results.' + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultResource.yml new file mode 100644 index 00000000..723ca752 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultResource.yml @@ -0,0 +1,246 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.TestResultResource +name: TestResultResource +fullName: azure.mgmt.testbase.models.TestResultResource +module: azure.mgmt.testbase.models +summary: 'The Test Result Resource. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'TestResultResource(*, baseline_test_result_id: str | None = None, package_id: + str | None = None, application_name: str | None = None, application_version: str + | None = None, os_name: str | None = None, release_name: str | None = None, release_version_date: + datetime | None = None, flighting_ring: str | None = None, build_version: str + | None = None, build_revision: str | None = None, test_type: str | None = None, + test_run_time: str | None = None, is_download_data_available: bool | None = None, + is_video_available: bool | None = None, execution_status: str | _models.ExecutionStatus + | None = None, test_status: str | _models.TestStatus | None = None, grade: str + | _models.Grade | None = None, kb_number: str | None = None, interop_media_type: + str | None = None, interop_media_version: str | None = None, package_version: + str | None = None, analysis_summaries: List[_models.TestResultAnalysisSummary] + | None = None, **kwargs)' + keywordOnlyParameters: + - name: baseline_test_result_id + description: Azure Id of the baseline test result. + types: + - + - name: package_id + description: Resource Id of the package. + types: + - + - name: application_name + description: Application name. + types: + - + - name: application_version + description: Application version. + types: + - + - name: os_name + description: The operating system name, e.g. Windows 10 1809. + types: + - + - name: release_name + description: The name of the tested release (OS update). + types: + - + - name: release_version_date + description: The release version date of the tested release. + types: + - + - name: flighting_ring + description: The flighting ring, only for release of feature updates. + types: + - + - name: build_version + description: The build version of the tested release (OS update). + types: + - + - name: build_revision + description: The build revision of the tested release (OS update). + types: + - + - name: test_type + description: Test type. E.g. 'Out of box test' or 'Functional test'. + types: + - + - name: test_run_time + description: The run time of the test. + types: + - + - name: is_download_data_available + description: Whether download data is available. + types: + - + - name: is_video_available + description: Whether video data is available. + types: + - + - name: execution_status + description: 'The execution status of the test. Known values are: "None", + + "InProgress", "Processing", "Completed", "NotExecuted", "Incomplete", "Failed", + and + + "Succeeded".' + types: + - + - + - name: test_status + description: 'The status of the test. Known values are: "None", + + "TestExecutionInProgress", "DataProcessing", "TestFailure", "UpdateFailure", + + "TestAndUpdateFailure", "InfrastructureFailure", and "Completed".' + types: + - + - + - name: grade + description: 'The grade of the test. Known values are: "None", "NotAvailable", + "Pass", and + + "Fail".' + types: + - + - + - name: kb_number + description: KB number. + types: + - + - name: interop_media_type + description: Interop media type. + types: + - + - name: interop_media_version + description: Interop media version. + types: + - + - name: package_version + description: The version of the Windows update package. + types: + - + - name: analysis_summaries + description: List of analysis summaries. + types: + - [] +variables: +- description: Resource ID. + name: id + types: + - +- description: Resource name. + name: name + types: + - +- description: Resource type. + name: type + types: + - +- description: The system metadata relating to this resource. + name: system_data + types: + - +- description: Azure Id of the baseline test result. + name: baseline_test_result_id + types: + - +- description: Resource Id of the package. + name: package_id + types: + - +- description: Application name. + name: application_name + types: + - +- description: Application version. + name: application_version + types: + - +- description: The operating system name, e.g. Windows 10 1809. + name: os_name + types: + - +- description: The name of the tested release (OS update). + name: release_name + types: + - +- description: The release version date of the tested release. + name: release_version_date + types: + - +- description: The flighting ring, only for release of feature updates. + name: flighting_ring + types: + - +- description: The build version of the tested release (OS update). + name: build_version + types: + - +- description: The build revision of the tested release (OS update). + name: build_revision + types: + - +- description: Test type. E.g. 'Out of box test' or 'Functional test'. + name: test_type + types: + - +- description: The run time of the test. + name: test_run_time + types: + - +- description: Whether download data is available. + name: is_download_data_available + types: + - +- description: Whether video data is available. + name: is_video_available + types: + - +- description: 'The execution status of the test. Known values are: "None", + + "InProgress", "Processing", "Completed", "NotExecuted", "Incomplete", "Failed", + and + + "Succeeded".' + name: execution_status + types: + - + - +- description: 'The status of the test. Known values are: "None", "TestExecutionInProgress", + + "DataProcessing", "TestFailure", "UpdateFailure", "TestAndUpdateFailure", + + "InfrastructureFailure", and "Completed".' + name: test_status + types: + - + - +- description: 'The grade of the test. Known values are: "None", "NotAvailable", "Pass", + and + + "Fail".' + name: grade + types: + - + - +- description: KB number. + name: kb_number + types: + - +- description: Interop media type. + name: interop_media_type + types: + - +- description: Interop media version. + name: interop_media_version + types: + - +- description: The version of the Windows update package. + name: package_version + types: + - +- description: List of analysis summaries. + name: analysis_summaries + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestStatus.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestStatus.yml new file mode 100644 index 00000000..1a9cd200 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestStatus.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.testbase.models.TestStatus +name: TestStatus +fullName: azure.mgmt.testbase.models.TestStatus +summary: The status of a test. +module: azure.mgmt.testbase.models +fields: +- name: COMPLETED + uid: azure.mgmt.testbase.models.TestStatus.COMPLETED +- name: DATA_PROCESSING + uid: azure.mgmt.testbase.models.TestStatus.DATA_PROCESSING +- name: INFRASTRUCTURE_FAILURE + uid: azure.mgmt.testbase.models.TestStatus.INFRASTRUCTURE_FAILURE +- name: NONE + uid: azure.mgmt.testbase.models.TestStatus.NONE +- name: TEST_AND_UPDATE_FAILURE + uid: azure.mgmt.testbase.models.TestStatus.TEST_AND_UPDATE_FAILURE +- name: TEST_EXECUTION_IN_PROGRESS + uid: azure.mgmt.testbase.models.TestStatus.TEST_EXECUTION_IN_PROGRESS +- name: TEST_FAILURE + uid: azure.mgmt.testbase.models.TestStatus.TEST_FAILURE +- name: UPDATE_FAILURE + uid: azure.mgmt.testbase.models.TestStatus.UPDATE_FAILURE diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestSummaryListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestSummaryListResult.yml new file mode 100644 index 00000000..1e1795a0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestSummaryListResult.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.TestSummaryListResult +name: TestSummaryListResult +fullName: azure.mgmt.testbase.models.TestSummaryListResult +module: azure.mgmt.testbase.models +summary: 'A list of Test Summaries. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'TestSummaryListResult(*, value: List[_models.TestSummaryResource] | None + = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: The list of Test Summaries. + types: + - [] +variables: +- description: The list of Test Summaries. + name: value + types: + - [] +- description: 'Link to the next set of results. Not empty if value contains incomplete + list + + of results.' + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestSummaryResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestSummaryResource.yml new file mode 100644 index 00000000..9fb58b28 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestSummaryResource.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.TestSummaryResource +name: TestSummaryResource +fullName: azure.mgmt.testbase.models.TestSummaryResource +module: azure.mgmt.testbase.models +summary: 'Summary of a Test. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'TestSummaryResource(*, test_summary_id: str | None = None, package_id: + str | None = None, application_name: str | None = None, application_version: str + | None = None, execution_status: str | _models.ExecutionStatus | None = None, + test_status: str | _models.TestStatus | None = None, grade: str | _models.Grade + | None = None, test_run_time: str | None = None, feature_updates_test_summary: + _models.OSUpdatesTestSummary | None = None, security_updates_test_summary: _models.OSUpdatesTestSummary + | None = None, package_tags: Dict[str, str] | None = None, **kwargs)' + keywordOnlyParameters: + - name: test_summary_id + description: The Id of the current Test Summary. + types: + - + - name: package_id + description: The Azure resource Id of package. + types: + - + - name: application_name + description: Application name. + types: + - + - name: application_version + description: Application version. + types: + - + - name: execution_status + description: 'The execution status of last test. Known values are: "None", + + "InProgress", "Processing", "Completed", "NotExecuted", "Incomplete", "Failed", + and + + "Succeeded".' + types: + - + - + - name: test_status + description: 'The status of last test. Known values are: "None", + + "TestExecutionInProgress", "DataProcessing", "TestFailure", "UpdateFailure", + + "TestAndUpdateFailure", "InfrastructureFailure", and "Completed".' + types: + - + - + - name: grade + description: 'The grade of the test. Known values are: "None", "NotAvailable", + "Pass", and + + "Fail".' + types: + - + - + - name: test_run_time + description: The run time of the last test. + types: + - + - name: feature_updates_test_summary + description: 'The result summary of tests triggered by feature + + updates.' + types: + - + - name: security_updates_test_summary + description: 'The result summary of tests triggered by security + + updates.' + types: + - + - name: package_tags + description: The tags of Package resource that are associated with the testSummary. + types: + - [, ] +variables: +- description: Resource ID. + name: id + types: + - +- description: Resource name. + name: name + types: + - +- description: Resource type. + name: type + types: + - +- description: The system metadata relating to this resource. + name: system_data + types: + - +- description: The Id of the current Test Summary. + name: test_summary_id + types: + - +- description: The Azure resource Id of package. + name: package_id + types: + - +- description: Application name. + name: application_name + types: + - +- description: Application version. + name: application_version + types: + - +- description: 'The execution status of last test. Known values are: "None", + + "InProgress", "Processing", "Completed", "NotExecuted", "Incomplete", "Failed", + and + + "Succeeded".' + name: execution_status + types: + - + - +- description: 'The status of last test. Known values are: "None", + + "TestExecutionInProgress", "DataProcessing", "TestFailure", "UpdateFailure", + + "TestAndUpdateFailure", "InfrastructureFailure", and "Completed".' + name: test_status + types: + - + - +- description: 'The grade of the test. Known values are: "None", "NotAvailable", "Pass", + and + + "Fail".' + name: grade + types: + - + - +- description: The run time of the last test. + name: test_run_time + types: + - +- description: The result summary of tests triggered by feature updates. + name: feature_updates_test_summary + types: + - +- description: The result summary of tests triggered by security updates. + name: security_updates_test_summary + types: + - +- description: The tags of Package resource that are associated with the testSummary. + name: package_tags + types: + - [, ] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestType.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestType.yml new file mode 100644 index 00000000..4d0a57f0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.testbase.models.TestType +name: TestType +fullName: azure.mgmt.testbase.models.TestType +summary: The test type. +module: azure.mgmt.testbase.models +fields: +- name: FUNCTIONAL_TEST + uid: azure.mgmt.testbase.models.TestType.FUNCTIONAL_TEST +- name: OUT_OF_BOX_TEST + uid: azure.mgmt.testbase.models.TestType.OUT_OF_BOX_TEST diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestTypeListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestTypeListResult.yml new file mode 100644 index 00000000..f6a4a3ff --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestTypeListResult.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.TestTypeListResult +name: TestTypeListResult +fullName: azure.mgmt.testbase.models.TestTypeListResult +module: azure.mgmt.testbase.models +summary: 'A list of test types. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'TestTypeListResult(*, value: List[_models.TestTypeResource] | None = None, + **kwargs)' + keywordOnlyParameters: + - name: value + description: The list of test types. + types: + - [] +variables: +- description: The list of test types. + name: value + types: + - [] +- description: 'Link to the next set of results. Not empty if value contains incomplete + list + + of results.' + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestTypeResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestTypeResource.yml new file mode 100644 index 00000000..5764f929 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestTypeResource.yml @@ -0,0 +1,37 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.TestTypeResource +name: TestTypeResource +fullName: azure.mgmt.testbase.models.TestTypeResource +module: azure.mgmt.testbase.models +summary: 'The test type resource. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'TestTypeResource(*, actual_test_type_name: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: actual_test_type_name + description: The actual name of a test type of a Test Base Account. + types: + - +variables: +- description: Resource ID. + name: id + types: + - +- description: Resource name. + name: name + types: + - +- description: Resource type. + name: type + types: + - +- description: The system metadata relating to this resource. + name: system_data + types: + - +- description: The actual name of a test type of a Test Base Account. + name: actual_test_type_name + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Tier.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Tier.yml new file mode 100644 index 00000000..27514e71 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Tier.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.testbase.models.Tier +name: Tier +fullName: azure.mgmt.testbase.models.Tier +summary: The tier of this particular SKU. +module: azure.mgmt.testbase.models +fields: +- name: STANDARD + uid: azure.mgmt.testbase.models.Tier.STANDARD diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TrackedResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TrackedResource.yml new file mode 100644 index 00000000..30b65e53 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TrackedResource.yml @@ -0,0 +1,48 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.TrackedResource +name: TrackedResource +fullName: azure.mgmt.testbase.models.TrackedResource +module: azure.mgmt.testbase.models +summary: 'The resource model definition for an ARM tracked top level resource. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TrackedResource(*, location: str, tags: Dict[str, str] | None = None, **kwargs)' + keywordOnlyParameters: + - name: tags + description: The tags of the resource. + types: + - [, ] + - name: location + description: The geo-location where the resource lives. Required. + types: + - +variables: +- description: Resource ID. + name: id + types: + - +- description: Resource name. + name: name + types: + - +- description: Resource type. + name: type + types: + - +- description: The tags of the resource. + name: tags + types: + - [, ] +- description: The geo-location where the resource lives. Required. + name: location + types: + - +- description: Resource Etag. + name: etag + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Type.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Type.yml new file mode 100644 index 00000000..58a4c866 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Type.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.testbase.models.Type +name: Type +fullName: azure.mgmt.testbase.models.Type +summary: The type of this release (OS update). +module: azure.mgmt.testbase.models +fields: +- name: FEATURE_UPDATE + uid: azure.mgmt.testbase.models.Type.FEATURE_UPDATE +- name: SECURITY_UPDATE + uid: azure.mgmt.testbase.models.Type.SECURITY_UPDATE diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UserObjectReceiverValue.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UserObjectReceiverValue.yml new file mode 100644 index 00000000..d80f055f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UserObjectReceiverValue.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.UserObjectReceiverValue +name: UserObjectReceiverValue +fullName: azure.mgmt.testbase.models.UserObjectReceiverValue +module: azure.mgmt.testbase.models +summary: The user object receiver value. +constructor: + syntax: 'UserObjectReceiverValue(*, user_object_ids: List[str] | None = None, **kwargs)' + keywordOnlyParameters: + - name: user_object_ids + description: user object ids. + types: + - [] +variables: +- description: user object ids. + name: user_object_ids + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationBound.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationBound.yml new file mode 100644 index 00000000..69a6a21a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationBound.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.UtilizationBound +name: UtilizationBound +fullName: azure.mgmt.testbase.models.UtilizationBound +module: azure.mgmt.testbase.models +summary: The bound of a utilization result. +constructor: + syntax: 'UtilizationBound(*, percentile: float | None = None, value: float | None + = None, **kwargs)' + keywordOnlyParameters: + - name: percentile + description: The percentile of the bound. + types: + - + - name: value + description: The value of the bound. + types: + - +variables: +- description: The percentile of the bound. + name: percentile + types: + - +- description: The value of the bound. + name: value + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationEntry.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationEntry.yml new file mode 100644 index 00000000..1d547714 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationEntry.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.UtilizationEntry +name: UtilizationEntry +fullName: azure.mgmt.testbase.models.UtilizationEntry +module: azure.mgmt.testbase.models +summary: The utilization entry. +constructor: + syntax: 'UtilizationEntry(*, timestamp: datetime | None = None, value: float | None + = None, **kwargs)' + keywordOnlyParameters: + - name: timestamp + description: The timestamp. + types: + - + - name: value + description: The value. + types: + - +variables: +- description: The timestamp. + name: timestamp + types: + - +- description: The value. + name: value + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationResult.yml new file mode 100644 index 00000000..d3a53264 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationResult.yml @@ -0,0 +1,44 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.models.UtilizationResult +name: UtilizationResult +fullName: azure.mgmt.testbase.models.UtilizationResult +module: azure.mgmt.testbase.models +summary: The Utilization Result. +constructor: + syntax: 'UtilizationResult(*, process: str | None = None, upper_bound: _models.UtilizationBound + | None = None, lower_bound: _models.UtilizationBound | None = None, utilization: + List[_models.UtilizationEntry] | None = None, **kwargs)' + keywordOnlyParameters: + - name: process + description: Process name, or '_total' for all processes. + types: + - + - name: upper_bound + description: Upper bound. + types: + - + - name: lower_bound + description: Lower bound. + types: + - + - name: utilization + description: Utilization data. + types: + - [] +variables: +- description: Process name, or '_total' for all processes. + name: process + types: + - +- description: Upper bound. + name: upper_bound + types: + - +- description: Lower bound. + name: lower_bound + types: + - +- description: Utilization data. + name: utilization + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ValidationRunStatus.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ValidationRunStatus.yml new file mode 100644 index 00000000..c18f9504 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ValidationRunStatus.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.testbase.models.ValidationRunStatus +name: ValidationRunStatus +fullName: azure.mgmt.testbase.models.ValidationRunStatus +summary: The status of the validation run of the package. +module: azure.mgmt.testbase.models +fields: +- name: FAILED + uid: azure.mgmt.testbase.models.ValidationRunStatus.FAILED +- name: PASSED + uid: azure.mgmt.testbase.models.ValidationRunStatus.PASSED +- name: PENDING + uid: azure.mgmt.testbase.models.ValidationRunStatus.PENDING +- name: UNKNOWN + uid: azure.mgmt.testbase.models.ValidationRunStatus.UNKNOWN diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.yml new file mode 100644 index 00000000..4bd8292b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.yml @@ -0,0 +1,112 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.testbase.models +name: models +fullName: azure.mgmt.testbase.models +type: import +classes: +- azure.mgmt.testbase.models.AnalysisResultListResult +- azure.mgmt.testbase.models.AnalysisResultSingletonResource +- azure.mgmt.testbase.models.AnalysisResultSingletonResourceProperties +- azure.mgmt.testbase.models.AvailableOSListResult +- azure.mgmt.testbase.models.AvailableOSResource +- azure.mgmt.testbase.models.BillingHubExecutionUsageDetail +- azure.mgmt.testbase.models.BillingHubFreeHourIncrementEntry +- azure.mgmt.testbase.models.BillingHubGetFreeHourBalanceResponse +- azure.mgmt.testbase.models.BillingHubGetUsageRequest +- azure.mgmt.testbase.models.BillingHubGetUsageResponse +- azure.mgmt.testbase.models.BillingHubPackageUsage +- azure.mgmt.testbase.models.BillingHubUsage +- azure.mgmt.testbase.models.BillingHubUsageGroup +- azure.mgmt.testbase.models.BillingHubUsageGroupedByUpdateType +- azure.mgmt.testbase.models.CPURegressionResultSingletonResourceProperties +- azure.mgmt.testbase.models.CPUUtilizationResultSingletonResourceProperties +- azure.mgmt.testbase.models.CheckNameAvailabilityResult +- azure.mgmt.testbase.models.Command +- azure.mgmt.testbase.models.CustomerEventListResult +- azure.mgmt.testbase.models.CustomerEventResource +- azure.mgmt.testbase.models.DistributionGroupListReceiverValue +- azure.mgmt.testbase.models.DownloadURLResponse +- azure.mgmt.testbase.models.EmailEventListResult +- azure.mgmt.testbase.models.EmailEventResource +- azure.mgmt.testbase.models.ErrorDefinition +- azure.mgmt.testbase.models.ErrorResponse +- azure.mgmt.testbase.models.FavoriteProcessListResult +- azure.mgmt.testbase.models.FavoriteProcessResource +- azure.mgmt.testbase.models.FileUploadURLResponse +- azure.mgmt.testbase.models.FlightingRingListResult +- azure.mgmt.testbase.models.FlightingRingResource +- azure.mgmt.testbase.models.GetFileUploadURLParameters +- azure.mgmt.testbase.models.IdentifiedFailure +- azure.mgmt.testbase.models.MemoryRegressionResultSingletonResourceProperties +- azure.mgmt.testbase.models.MemoryUtilizationResultSingletonResourceProperties +- azure.mgmt.testbase.models.NotificationEventReceiver +- azure.mgmt.testbase.models.NotificationReceiverValue +- azure.mgmt.testbase.models.OSUpdateListResult +- azure.mgmt.testbase.models.OSUpdateResource +- azure.mgmt.testbase.models.OSUpdateTestSummary +- azure.mgmt.testbase.models.OSUpdatesTestSummary +- azure.mgmt.testbase.models.Operation +- azure.mgmt.testbase.models.OperationDisplay +- azure.mgmt.testbase.models.OperationListResult +- azure.mgmt.testbase.models.PackageCheckNameAvailabilityParameters +- azure.mgmt.testbase.models.PackageListResult +- azure.mgmt.testbase.models.PackageResource +- azure.mgmt.testbase.models.PackageRunTestParameters +- azure.mgmt.testbase.models.PackageUpdateParameters +- azure.mgmt.testbase.models.PackageValidationResult +- azure.mgmt.testbase.models.ProxyResource +- azure.mgmt.testbase.models.RegressionResult +- azure.mgmt.testbase.models.RegressionTestDetails +- azure.mgmt.testbase.models.ReliabilityResult +- azure.mgmt.testbase.models.ReliabilityResultSingletonResourceProperties +- azure.mgmt.testbase.models.Resource +- azure.mgmt.testbase.models.ScriptExecutionResult +- azure.mgmt.testbase.models.ScriptExecutionResultSingletonResourceProperties +- azure.mgmt.testbase.models.SubscriptionReceiverValue +- azure.mgmt.testbase.models.SystemData +- azure.mgmt.testbase.models.TargetOSInfo +- azure.mgmt.testbase.models.Test +- azure.mgmt.testbase.models.TestAnalysisResult +- azure.mgmt.testbase.models.TestAnalysisResultSingletonResourceProperties +- azure.mgmt.testbase.models.TestBaseAccountListResult +- azure.mgmt.testbase.models.TestBaseAccountResource +- azure.mgmt.testbase.models.TestBaseAccountSKU +- azure.mgmt.testbase.models.TestBaseAccountSKUCapability +- azure.mgmt.testbase.models.TestBaseAccountSKUListResult +- azure.mgmt.testbase.models.TestBaseAccountUpdateParameters +- azure.mgmt.testbase.models.TestBaseAccountUsageData +- azure.mgmt.testbase.models.TestBaseAccountUsageDataList +- azure.mgmt.testbase.models.TestBaseAccountUsageName +- azure.mgmt.testbase.models.TestResultAnalysisSummary +- azure.mgmt.testbase.models.TestResultConsoleLogDownloadURLParameters +- azure.mgmt.testbase.models.TestResultListResult +- azure.mgmt.testbase.models.TestResultResource +- azure.mgmt.testbase.models.TestSummaryListResult +- azure.mgmt.testbase.models.TestSummaryResource +- azure.mgmt.testbase.models.TestTypeListResult +- azure.mgmt.testbase.models.TestTypeResource +- azure.mgmt.testbase.models.TrackedResource +- azure.mgmt.testbase.models.UserObjectReceiverValue +- azure.mgmt.testbase.models.UtilizationBound +- azure.mgmt.testbase.models.UtilizationEntry +- azure.mgmt.testbase.models.UtilizationResult +enums: +- azure.mgmt.testbase.models.Action +- azure.mgmt.testbase.models.AnalysisResultName +- azure.mgmt.testbase.models.AnalysisResultType +- azure.mgmt.testbase.models.AnalysisStatus +- azure.mgmt.testbase.models.Category +- azure.mgmt.testbase.models.ContentType +- azure.mgmt.testbase.models.CreatedByType +- azure.mgmt.testbase.models.ExecutionStatus +- azure.mgmt.testbase.models.Grade +- azure.mgmt.testbase.models.OsUpdateType +- azure.mgmt.testbase.models.PackageStatus +- azure.mgmt.testbase.models.ProvisioningState +- azure.mgmt.testbase.models.Reason +- azure.mgmt.testbase.models.TestAnalysisStatus +- azure.mgmt.testbase.models.TestStatus +- azure.mgmt.testbase.models.TestType +- azure.mgmt.testbase.models.Tier +- azure.mgmt.testbase.models.Type +- azure.mgmt.testbase.models.ValidationRunStatus diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.AnalysisResultsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.AnalysisResultsOperations.yml new file mode 100644 index 00000000..9f8412d9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.AnalysisResultsOperations.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.operations.AnalysisResultsOperations +name: AnalysisResultsOperations +fullName: azure.mgmt.testbase.operations.AnalysisResultsOperations +module: azure.mgmt.testbase.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: AnalysisResultsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.operations.AnalysisResultsOperations.get + name: get + summary: Gets an Analysis Result of a Test Result by name. + signature: 'get(resource_group_name: str, test_base_account_name: str, package_name: + str, test_result_name: str, analysis_result_name: str | AnalysisResultName, **kwargs: + Any) -> AnalysisResultSingletonResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: test_result_name + description: 'The Test Result Name. It equals to TestResult-{TestResultId} string. + + Required.' + isRequired: true + types: + - + - name: analysis_result_name + description: 'The name of the Analysis Result of a Test Result. Known values + + are: "scriptExecution", "reliability", "memoryUtilization", "cpuUtilization", + + "memoryRegression", "cpuRegression", and "testAnalysis". Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AnalysisResultSingletonResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.AnalysisResultsOperations.list + name: list + summary: 'Lists the Analysis Results of a Test Result. The result collection will + only contain one + + element as all the data will be nested in a singleton object.' + signature: 'list(resource_group_name: str, test_base_account_name: str, package_name: + str, test_result_name: str, analysis_result_type: str | AnalysisResultType, **kwargs: + Any) -> Iterable[AnalysisResultSingletonResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: test_result_name + description: 'The Test Result Name. It equals to TestResult-{TestResultId} string. + + Required.' + isRequired: true + types: + - + - name: analysis_result_type + description: 'The type of the Analysis Result of a Test Result. Known values + + are: "ScriptExecution", "Reliability", "CPUUtilization", "MemoryUtilization", + "CPURegression", + + "MemoryRegression", and "TestAnalysis". Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either AnalysisResultSingletonResource + or the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.operations.AnalysisResultsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.AvailableOSOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.AvailableOSOperations.yml new file mode 100644 index 00000000..ffa16542 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.AvailableOSOperations.yml @@ -0,0 +1,87 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.operations.AvailableOSOperations +name: AvailableOSOperations +fullName: azure.mgmt.testbase.operations.AvailableOSOperations +module: azure.mgmt.testbase.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: AvailableOSOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.operations.AvailableOSOperations.get + name: get + summary: Gets an available OS to run a package under a Test Base Account. + signature: 'get(resource_group_name: str, test_base_account_name: str, available_os_resource_name: + str, **kwargs: Any) -> AvailableOSResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: available_os_resource_name + description: The resource name of an Available OS. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AvailableOSResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.AvailableOSOperations.list + name: list + summary: Lists all the available OSs to run a package under a Test Base Account. + signature: 'list(resource_group_name: str, test_base_account_name: str, os_update_type: + str | OsUpdateType, **kwargs: Any) -> Iterable[AvailableOSResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: os_update_type + description: 'The type of the OS Update. Known values are: "SecurityUpdate" and + + "FeatureUpdate". Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either AvailableOSResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.operations.AvailableOSOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.BillingHubServiceOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.BillingHubServiceOperations.yml new file mode 100644 index 00000000..8c99b4be --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.BillingHubServiceOperations.yml @@ -0,0 +1,86 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.operations.BillingHubServiceOperations +name: BillingHubServiceOperations +fullName: azure.mgmt.testbase.operations.BillingHubServiceOperations +module: azure.mgmt.testbase.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: BillingHubServiceOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.operations.BillingHubServiceOperations.get_free_hour_balance + name: get_free_hour_balance + summary: get_free_hour_balance. + signature: 'get_free_hour_balance(resource_group_name: str, test_base_account_name: + str, **kwargs: Any) -> BillingHubGetFreeHourBalanceResponse' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: BillingHubGetFreeHourBalanceResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.BillingHubServiceOperations.get_usage + name: get_usage + summary: get_usage. + signature: 'get_usage(resource_group_name: str, test_base_account_name: str, get_usage_request: + _models.BillingHubGetUsageRequest | None = None, *, content_type: str = ''application/json'', + **kwargs: Any) -> _models.BillingHubGetUsageResponse' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: get_usage_request + description: Is either a model type or a IO type. Default value is None. + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: BillingHubGetUsageResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.operations.BillingHubServiceOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.CustomerEventsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.CustomerEventsOperations.yml new file mode 100644 index 00000000..3d80c244 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.CustomerEventsOperations.yml @@ -0,0 +1,211 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.operations.CustomerEventsOperations +name: CustomerEventsOperations +fullName: azure.mgmt.testbase.operations.CustomerEventsOperations +module: azure.mgmt.testbase.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: CustomerEventsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.operations.CustomerEventsOperations.begin_create + name: begin_create + summary: Create or replace a Test Base Customer Event. + signature: 'begin_create(resource_group_name: str, test_base_account_name: str, + customer_event_name: str, parameters: _models.CustomerEventResource, *, content_type: + str = ''application/json'', **kwargs: Any) -> LROPoller[_models.CustomerEventResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: customer_event_name + description: The resource name of the Test Base Customer event. Required. + isRequired: true + types: + - + - name: parameters + description: 'Parameters supplied to create a Test Base CustomerEvent. Is either + a model + + type or a IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of LROPoller that returns either CustomerEventResource + or the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.CustomerEventsOperations.begin_delete + name: begin_delete + summary: Deletes a Test Base Customer Event. + signature: 'begin_delete(resource_group_name: str, test_base_account_name: str, + customer_event_name: str, **kwargs: Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: customer_event_name + description: The resource name of the Test Base Customer event. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.CustomerEventsOperations.get + name: get + summary: Gets a Test Base CustomerEvent. + signature: 'get(resource_group_name: str, test_base_account_name: str, customer_event_name: + str, **kwargs: Any) -> CustomerEventResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: customer_event_name + description: The resource name of the Test Base Customer event. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: CustomerEventResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.CustomerEventsOperations.list_by_test_base_account + name: list_by_test_base_account + summary: Lists all notification events subscribed under a Test Base Account. + signature: 'list_by_test_base_account(resource_group_name: str, test_base_account_name: + str, **kwargs: Any) -> Iterable[CustomerEventResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either CustomerEventResource or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.operations.CustomerEventsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.EmailEventsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.EmailEventsOperations.yml new file mode 100644 index 00000000..e52f3e07 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.EmailEventsOperations.yml @@ -0,0 +1,79 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.operations.EmailEventsOperations +name: EmailEventsOperations +fullName: azure.mgmt.testbase.operations.EmailEventsOperations +module: azure.mgmt.testbase.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: EmailEventsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.operations.EmailEventsOperations.get + name: get + summary: Gets a email event of a Test Base Account. + signature: 'get(resource_group_name: str, test_base_account_name: str, email_event_resource_name: + str, **kwargs: Any) -> EmailEventResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: email_event_resource_name + description: The resource name of an email event. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: EmailEventResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.EmailEventsOperations.list + name: list + summary: Lists all the email events of a Test Base Account. + signature: 'list(resource_group_name: str, test_base_account_name: str, **kwargs: + Any) -> Iterable[EmailEventResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either EmailEventResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.operations.EmailEventsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.FavoriteProcessesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.FavoriteProcessesOperations.yml new file mode 100644 index 00000000..08b4e616 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.FavoriteProcessesOperations.yml @@ -0,0 +1,200 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.operations.FavoriteProcessesOperations +name: FavoriteProcessesOperations +fullName: azure.mgmt.testbase.operations.FavoriteProcessesOperations +module: azure.mgmt.testbase.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: FavoriteProcessesOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.operations.FavoriteProcessesOperations.create + name: create + summary: Create or replace a favorite process for a Test Base Package. + signature: 'create(resource_group_name: str, test_base_account_name: str, package_name: + str, favorite_process_resource_name: str, parameters: _models.FavoriteProcessResource, + *, content_type: str = ''application/json'', **kwargs: Any) -> _models.FavoriteProcessResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: favorite_process_resource_name + description: 'The resource name of a favorite process in a package. If + + the process name contains characters that are not allowed in Azure Resource + Name, we use + + ''actualProcessName'' in request body to submit the name. Required.' + isRequired: true + types: + - + - name: parameters + description: 'Parameters supplied to create a favorite process in a package. Is + either a + + model type or a IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: FavoriteProcessResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.FavoriteProcessesOperations.delete + name: delete + summary: Deletes a favorite process for a specific package. + signature: 'delete(resource_group_name: str, test_base_account_name: str, package_name: + str, favorite_process_resource_name: str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: favorite_process_resource_name + description: 'The resource name of a favorite process in a package. If + + the process name contains characters that are not allowed in Azure Resource + Name, we use + + ''actualProcessName'' in request body to submit the name. Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.FavoriteProcessesOperations.get + name: get + summary: Gets a favorite process for a Test Base Package. + signature: 'get(resource_group_name: str, test_base_account_name: str, package_name: + str, favorite_process_resource_name: str, **kwargs: Any) -> FavoriteProcessResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: favorite_process_resource_name + description: 'The resource name of a favorite process in a package. If + + the process name contains characters that are not allowed in Azure Resource + Name, we use + + ''actualProcessName'' in request body to submit the name. Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: FavoriteProcessResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.FavoriteProcessesOperations.list + name: list + summary: Lists the favorite processes for a specific package. + signature: 'list(resource_group_name: str, test_base_account_name: str, package_name: + str, **kwargs: Any) -> Iterable[FavoriteProcessResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either FavoriteProcessResource or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.operations.FavoriteProcessesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.FlightingRingsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.FlightingRingsOperations.yml new file mode 100644 index 00000000..caf80630 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.FlightingRingsOperations.yml @@ -0,0 +1,81 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.operations.FlightingRingsOperations +name: FlightingRingsOperations +fullName: azure.mgmt.testbase.operations.FlightingRingsOperations +module: azure.mgmt.testbase.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: FlightingRingsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.operations.FlightingRingsOperations.get + name: get + summary: Gets a flighting ring of a Test Base Account. + signature: 'get(resource_group_name: str, test_base_account_name: str, flighting_ring_resource_name: + str, **kwargs: Any) -> FlightingRingResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: flighting_ring_resource_name + description: The resource name of a flighting ring. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: FlightingRingResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.FlightingRingsOperations.list + name: list + summary: Lists all the flighting rings of a Test Base Account. + signature: 'list(resource_group_name: str, test_base_account_name: str, **kwargs: + Any) -> Iterable[FlightingRingResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either FlightingRingResource or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.operations.FlightingRingsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.OSUpdatesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.OSUpdatesOperations.yml new file mode 100644 index 00000000..56ae0984 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.OSUpdatesOperations.yml @@ -0,0 +1,97 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.operations.OSUpdatesOperations +name: OSUpdatesOperations +fullName: azure.mgmt.testbase.operations.OSUpdatesOperations +module: azure.mgmt.testbase.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: OSUpdatesOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.operations.OSUpdatesOperations.get + name: get + summary: Gets an OS Update by name in which the package was tested before. + signature: 'get(resource_group_name: str, test_base_account_name: str, package_name: + str, os_update_resource_name: str, **kwargs: Any) -> OSUpdateResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: os_update_resource_name + description: The resource name of an OS Update. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: OSUpdateResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.OSUpdatesOperations.list + name: list + summary: Lists the OS Updates in which the package were tested before. + signature: 'list(resource_group_name: str, test_base_account_name: str, package_name: + str, os_update_type: str | OsUpdateType, **kwargs: Any) -> Iterable[OSUpdateResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: os_update_type + description: 'The type of the OS Update. Known values are: "SecurityUpdate" and + + "FeatureUpdate". Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either OSUpdateResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.operations.OSUpdatesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.Operations.yml new file mode 100644 index 00000000..2599595c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.Operations.yml @@ -0,0 +1,31 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.operations.Operations +name: Operations +fullName: azure.mgmt.testbase.operations.Operations +module: azure.mgmt.testbase.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: Operations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.operations.Operations.list + name: list + summary: Lists all of the available REST API operations of the Microsoft.TestBase + provider. + signature: 'list(**kwargs: Any) -> Iterable[Operation]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either Operation or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.PackagesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.PackagesOperations.yml new file mode 100644 index 00000000..136e035a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.PackagesOperations.yml @@ -0,0 +1,424 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.operations.PackagesOperations +name: PackagesOperations +fullName: azure.mgmt.testbase.operations.PackagesOperations +module: azure.mgmt.testbase.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: PackagesOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.operations.PackagesOperations.begin_create + name: begin_create + summary: Create or replace (overwrite/recreate, with potential downtime) a Test + Base Package. + signature: 'begin_create(resource_group_name: str, test_base_account_name: str, + package_name: str, parameters: _models.PackageResource, *, content_type: str = + ''application/json'', **kwargs: Any) -> LROPoller[_models.PackageResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: parameters + description: 'Parameters supplied to create a Test Base Package. Is either a model + type or + + a IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of LROPoller that returns either PackageResource or + the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.PackagesOperations.begin_delete + name: begin_delete + summary: Deletes a Test Base Package. + signature: 'begin_delete(resource_group_name: str, test_base_account_name: str, + package_name: str, **kwargs: Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.PackagesOperations.begin_hard_delete + name: begin_hard_delete + summary: Hard Delete a Test Base Package. + signature: 'begin_hard_delete(resource_group_name: str, test_base_account_name: + str, package_name: str, **kwargs: Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.PackagesOperations.begin_update + name: begin_update + summary: Update an existing Test Base Package. + signature: 'begin_update(resource_group_name: str, test_base_account_name: str, + package_name: str, parameters: _models.PackageUpdateParameters, *, content_type: + str = ''application/json'', **kwargs: Any) -> LROPoller[_models.PackageResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: parameters + description: 'Parameters supplied to update a Test Base Package. Is either a model + type or + + a IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of LROPoller that returns either PackageResource or + the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.PackagesOperations.get + name: get + summary: Gets a Test Base Package. + signature: 'get(resource_group_name: str, test_base_account_name: str, package_name: + str, **kwargs: Any) -> PackageResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PackageResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.PackagesOperations.get_download_url + name: get_download_url + summary: Gets the download URL of a package. + signature: 'get_download_url(resource_group_name: str, test_base_account_name: str, + package_name: str, **kwargs: Any) -> DownloadURLResponse' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DownloadURLResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.PackagesOperations.list_by_test_base_account + name: list_by_test_base_account + summary: Lists all the packages under a Test Base Account. + signature: 'list_by_test_base_account(resource_group_name: str, test_base_account_name: + str, **kwargs: Any) -> Iterable[PackageResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either PackageResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.PackagesOperations.run_test + name: run_test + summary: Trigger a test run on the package. + signature: 'run_test(resource_group_name: str, test_base_account_name: str, package_name: + str, parameters: _models.PackageRunTestParameters | None = None, *, content_type: + str = ''application/json'', **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: parameters + description: 'The parameters supplied to the Test Base Package to start a Test + Run. Is + + either a model type or a IO type. Default value is None.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.operations.PackagesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.SkusOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.SkusOperations.yml new file mode 100644 index 00000000..c19064ef --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.SkusOperations.yml @@ -0,0 +1,31 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.operations.SkusOperations +name: SkusOperations +fullName: azure.mgmt.testbase.operations.SkusOperations +module: azure.mgmt.testbase.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: SkusOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.operations.SkusOperations.list + name: list + summary: Lists the available SKUs of Test Base Account in a subscription. + signature: 'list(**kwargs: Any) -> Iterable[TestBaseAccountSKU]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either TestBaseAccountSKU or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.operations.SkusOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestBaseAccountsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestBaseAccountsOperations.yml new file mode 100644 index 00000000..da269927 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestBaseAccountsOperations.yml @@ -0,0 +1,449 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.operations.TestBaseAccountsOperations +name: TestBaseAccountsOperations +fullName: azure.mgmt.testbase.operations.TestBaseAccountsOperations +module: azure.mgmt.testbase.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: TestBaseAccountsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.operations.TestBaseAccountsOperations.begin_create + name: begin_create + summary: 'Create or replace (overwrite/recreate, with potential downtime) a Test + Base Account in the + + specified subscription.' + signature: 'begin_create(resource_group_name: str, test_base_account_name: str, + parameters: _models.TestBaseAccountResource, restore: bool | None = None, *, content_type: + str = ''application/json'', **kwargs: Any) -> LROPoller[_models.TestBaseAccountResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: parameters + description: 'Parameters supplied to create a Test Base Account. Is either a model + type or + + a IO type. Required.' + isRequired: true + types: + - + - + - name: restore + description: 'The flag indicating if we would like to restore the Test Base Accounts + which + + were soft deleted before. Default value is None.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of LROPoller that returns either TestBaseAccountResource + or the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.TestBaseAccountsOperations.begin_delete + name: begin_delete + summary: Deletes a Test Base Account. + signature: 'begin_delete(resource_group_name: str, test_base_account_name: str, + **kwargs: Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.TestBaseAccountsOperations.begin_offboard + name: begin_offboard + summary: Offboard a Test Base Account. + signature: 'begin_offboard(resource_group_name: str, test_base_account_name: str, + **kwargs: Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.TestBaseAccountsOperations.begin_update + name: begin_update + summary: Update an existing Test Base Account. + signature: 'begin_update(resource_group_name: str, test_base_account_name: str, + parameters: _models.TestBaseAccountUpdateParameters, *, content_type: str = ''application/json'', + **kwargs: Any) -> LROPoller[_models.TestBaseAccountResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: parameters + description: 'Parameters supplied to update a Test Base Account. Is either a model + type or + + a IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. Pass in False + for this + + operation to not poll, or pass in your own initialized polling object for a + personal polling + + strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: 'An instance of LROPoller that returns either TestBaseAccountResource + or the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.TestBaseAccountsOperations.check_package_name_availability + name: check_package_name_availability + summary: Checks that the Test Base Package name and version is valid and is not + already in use. + signature: 'check_package_name_availability(resource_group_name: str, test_base_account_name: + str, parameters: _models.PackageCheckNameAvailabilityParameters, *, content_type: + str = ''application/json'', **kwargs: Any) -> _models.CheckNameAvailabilityResult' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: parameters + description: 'Parameters supplied to the Test Base Package CheckNameAvailability + + operation. Is either a model type or a IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: CheckNameAvailabilityResult or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.TestBaseAccountsOperations.get + name: get + summary: Gets a Test Base Account. + signature: 'get(resource_group_name: str, test_base_account_name: str, **kwargs: + Any) -> TestBaseAccountResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: TestBaseAccountResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.TestBaseAccountsOperations.get_file_upload_url + name: get_file_upload_url + summary: Gets the file upload URL of a Test Base Account. + signature: 'get_file_upload_url(resource_group_name: str, test_base_account_name: + str, parameters: _models.GetFileUploadURLParameters | None = None, *, content_type: + str = ''application/json'', **kwargs: Any) -> _models.FileUploadURLResponse' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: parameters + description: 'Parameters supplied to the Test Base Account GetFileUploadURL operation. + Is + + either a model type or a IO type. Default value is None.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: FileUploadURLResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.TestBaseAccountsOperations.list_by_resource_group + name: list_by_resource_group + summary: Lists all the Test Base Accounts in a resource group. + signature: 'list_by_resource_group(resource_group_name: str, get_deleted: bool | + None = None, **kwargs: Any) -> Iterable[TestBaseAccountResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: get_deleted + description: 'The flag indicating if we need to include the Test Base Accounts + which were + + soft deleted before. Default value is None.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either TestBaseAccountResource or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.TestBaseAccountsOperations.list_by_subscription + name: list_by_subscription + summary: Lists all the Test Base Accounts in a subscription. This API is required + by ARM guidelines. + signature: 'list_by_subscription(get_deleted: bool | None = None, **kwargs: Any) + -> Iterable[TestBaseAccountResource]' + parameters: + - name: get_deleted + description: 'The flag indicating if we need to include the Test Base Accounts + which were + + soft deleted before. Default value is None.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either TestBaseAccountResource or the + result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.operations.TestBaseAccountsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestResultsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestResultsOperations.yml new file mode 100644 index 00000000..2d367eda --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestResultsOperations.yml @@ -0,0 +1,248 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.operations.TestResultsOperations +name: TestResultsOperations +fullName: azure.mgmt.testbase.operations.TestResultsOperations +module: azure.mgmt.testbase.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: TestResultsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.operations.TestResultsOperations.get + name: get + summary: Get the Test Result by Id with specified OS Update type for a Test Base + Package. + signature: 'get(resource_group_name: str, test_base_account_name: str, package_name: + str, test_result_name: str, **kwargs: Any) -> TestResultResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: test_result_name + description: 'The Test Result Name. It equals to TestResult-{TestResultId} string. + + Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: TestResultResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.TestResultsOperations.get_console_log_download_url + name: get_console_log_download_url + summary: Gets the download URL of the test execution console log file. + signature: 'get_console_log_download_url(resource_group_name: str, test_base_account_name: + str, package_name: str, test_result_name: str, parameters: _models.TestResultConsoleLogDownloadURLParameters, + *, content_type: str = ''application/json'', **kwargs: Any) -> _models.DownloadURLResponse' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: test_result_name + description: 'The Test Result Name. It equals to TestResult-{TestResultId} string. + + Required.' + isRequired: true + types: + - + - name: parameters + description: 'Parameters supplied to the Test Result GetConsoleLogDownloadUrl + operation. + + Is either a model type or a IO type. Required.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: content_type + description: 'Body Parameter content-type. Known values are: ''application/json''. + + Default value is None.' + types: + - + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DownloadURLResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.TestResultsOperations.get_download_url + name: get_download_url + summary: Gets the download URL of the test result. + signature: 'get_download_url(resource_group_name: str, test_base_account_name: str, + package_name: str, test_result_name: str, **kwargs: Any) -> DownloadURLResponse' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: test_result_name + description: 'The Test Result Name. It equals to TestResult-{TestResultId} string. + + Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DownloadURLResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.TestResultsOperations.get_video_download_url + name: get_video_download_url + summary: Gets the download URL of the test execution screen recording. + signature: 'get_video_download_url(resource_group_name: str, test_base_account_name: + str, package_name: str, test_result_name: str, **kwargs: Any) -> DownloadURLResponse' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: test_result_name + description: 'The Test Result Name. It equals to TestResult-{TestResultId} string. + + Required.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DownloadURLResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.TestResultsOperations.list + name: list + summary: 'Lists all the Test Results with specified OS Update type for a Test Base + Package. Can be + + filtered by osName, releaseName, flightingRing, buildVersion, buildRevision.' + signature: 'list(resource_group_name: str, test_base_account_name: str, package_name: + str, os_update_type: str | OsUpdateType, filter: str | None = None, **kwargs: + Any) -> Iterable[TestResultResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: package_name + description: The resource name of the Test Base Package. Required. + isRequired: true + types: + - + - name: os_update_type + description: 'The type of the OS Update. Known values are: "SecurityUpdate" and + + "FeatureUpdate". Required.' + isRequired: true + types: + - + - + - name: filter + description: Odata filter. Default value is None. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either TestResultResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.operations.TestResultsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestSummariesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestSummariesOperations.yml new file mode 100644 index 00000000..e3c8d287 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestSummariesOperations.yml @@ -0,0 +1,82 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.operations.TestSummariesOperations +name: TestSummariesOperations +fullName: azure.mgmt.testbase.operations.TestSummariesOperations +module: azure.mgmt.testbase.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: TestSummariesOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.operations.TestSummariesOperations.get + name: get + summary: 'Gets a Test Summary with specific name from all the Test Summaries of + all the packages under a + + Test Base Account.' + signature: 'get(resource_group_name: str, test_base_account_name: str, test_summary_name: + str, **kwargs: Any) -> TestSummaryResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: test_summary_name + description: The name of the Test Summary. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: TestSummaryResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.TestSummariesOperations.list + name: list + summary: Lists the Test Summaries of all the packages under a Test Base Account. + signature: 'list(resource_group_name: str, test_base_account_name: str, **kwargs: + Any) -> Iterable[TestSummaryResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either TestSummaryResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.operations.TestSummariesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestTypesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestTypesOperations.yml new file mode 100644 index 00000000..8566b169 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestTypesOperations.yml @@ -0,0 +1,79 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.operations.TestTypesOperations +name: TestTypesOperations +fullName: azure.mgmt.testbase.operations.TestTypesOperations +module: azure.mgmt.testbase.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: TestTypesOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.operations.TestTypesOperations.get + name: get + summary: Gets a test type of a Test Base Account. + signature: 'get(resource_group_name: str, test_base_account_name: str, test_type_resource_name: + str, **kwargs: Any) -> TestTypeResource' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: test_type_resource_name + description: The resource name of a test type. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: TestTypeResource or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.testbase.operations.TestTypesOperations.list + name: list + summary: Lists all the test types of a Test Base Account. + signature: 'list(resource_group_name: str, test_base_account_name: str, **kwargs: + Any) -> Iterable[TestTypeResource]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either TestTypeResource or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.operations.TestTypesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.UsageOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.UsageOperations.yml new file mode 100644 index 00000000..eba3914f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.UsageOperations.yml @@ -0,0 +1,52 @@ +### YamlMime:PythonClass +uid: azure.mgmt.testbase.operations.UsageOperations +name: UsageOperations +fullName: azure.mgmt.testbase.operations.UsageOperations +module: azure.mgmt.testbase.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: UsageOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.testbase.operations.UsageOperations.list + name: list + summary: Lists the usage data of a Test Base Account. + signature: 'list(resource_group_name: str, test_base_account_name: str, filter: + str | None = None, **kwargs: Any) -> Iterable[TestBaseAccountUsageData]' + parameters: + - name: resource_group_name + description: 'The name of the resource group that contains the resource. + + Required.' + isRequired: true + types: + - + - name: test_base_account_name + description: The resource name of the Test Base Account. Required. + isRequired: true + types: + - + - name: filter + description: Odata filter. Default value is None. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either TestBaseAccountUsageData or + the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.testbase.operations.UsageOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.yml new file mode 100644 index 00000000..f6ed30dc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.yml @@ -0,0 +1,22 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.testbase.operations +name: operations +fullName: azure.mgmt.testbase.operations +type: import +classes: +- azure.mgmt.testbase.operations.AnalysisResultsOperations +- azure.mgmt.testbase.operations.AvailableOSOperations +- azure.mgmt.testbase.operations.BillingHubServiceOperations +- azure.mgmt.testbase.operations.CustomerEventsOperations +- azure.mgmt.testbase.operations.EmailEventsOperations +- azure.mgmt.testbase.operations.FavoriteProcessesOperations +- azure.mgmt.testbase.operations.FlightingRingsOperations +- azure.mgmt.testbase.operations.OSUpdatesOperations +- azure.mgmt.testbase.operations.Operations +- azure.mgmt.testbase.operations.PackagesOperations +- azure.mgmt.testbase.operations.SkusOperations +- azure.mgmt.testbase.operations.TestBaseAccountsOperations +- azure.mgmt.testbase.operations.TestResultsOperations +- azure.mgmt.testbase.operations.TestSummariesOperations +- azure.mgmt.testbase.operations.TestTypesOperations +- azure.mgmt.testbase.operations.UsageOperations diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.yml new file mode 100644 index 00000000..27bc683d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.testbase +name: testbase +fullName: azure.mgmt.testbase +type: rootImport +classes: +- azure.mgmt.testbase.TestBase +packages: +- azure.mgmt.testbase.aio +- azure.mgmt.testbase.models +- azure.mgmt.testbase.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.VideoAnalyzer.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.VideoAnalyzer.yml new file mode 100644 index 00000000..3401af7c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.VideoAnalyzer.yml @@ -0,0 +1,105 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.VideoAnalyzer +name: VideoAnalyzer +fullName: azure.mgmt.videoanalyzer.VideoAnalyzer +module: azure.mgmt.videoanalyzer +summary: Azure Video Analyzer provides a platform for you to build intelligent video + applications that span the edge and the cloud. +constructor: + syntax: 'VideoAnalyzer(credential: ''TokenCredential'', subscription_id: str, base_url: + str | None = None, **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: subscription_id + description: The ID of the target subscription. + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - + keywordOnlyParameters: + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - +variables: +- description: EdgeModulesOperations operations + name: edge_modules + types: + - +- description: PipelineTopologiesOperations operations + name: pipeline_topologies + types: + - +- description: LivePipelinesOperations operations + name: live_pipelines + types: + - +- description: PipelineJobsOperations operations + name: pipeline_jobs + types: + - +- description: LivePipelineOperationStatusesOperations operations + name: live_pipeline_operation_statuses + types: + - +- description: PipelineJobOperationStatusesOperations operations + name: pipeline_job_operation_statuses + types: + - +- description: Operations operations + name: operations + types: + - +- description: VideoAnalyzersOperations operations + name: video_analyzers + types: + - +- description: PrivateLinkResourcesOperations operations + name: private_link_resources + types: + - +- description: PrivateEndpointConnectionsOperations operations + name: private_endpoint_connections + types: + - +- description: OperationStatusesOperations operations + name: operation_statuses + types: + - +- description: OperationResultsOperations operations + name: operation_results + types: + - +- description: VideoAnalyzerOperationStatusesOperations operations + name: video_analyzer_operation_statuses + types: + - +- description: VideoAnalyzerOperationResultsOperations operations + name: video_analyzer_operation_results + types: + - +- description: LocationsOperations operations + name: locations + types: + - +- description: VideosOperations operations + name: videos + types: + - +- description: AccessPoliciesOperations operations + name: access_policies + types: + - +methods: +- uid: azure.mgmt.videoanalyzer.VideoAnalyzer.close + name: close + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.VideoAnalyzer.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.VideoAnalyzer.yml new file mode 100644 index 00000000..3aa0413d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.VideoAnalyzer.yml @@ -0,0 +1,105 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.aio.VideoAnalyzer +name: VideoAnalyzer +fullName: azure.mgmt.videoanalyzer.aio.VideoAnalyzer +module: azure.mgmt.videoanalyzer.aio +summary: Azure Video Analyzer provides a platform for you to build intelligent video + applications that span the edge and the cloud. +constructor: + syntax: 'VideoAnalyzer(credential: AsyncTokenCredential, subscription_id: str, base_url: + str | None = None, **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: subscription_id + description: The ID of the target subscription. + isRequired: true + types: + - + - name: base_url + description: Service URL + defaultValue: None + types: + - + keywordOnlyParameters: + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - +variables: +- description: EdgeModulesOperations operations + name: edge_modules + types: + - +- description: PipelineTopologiesOperations operations + name: pipeline_topologies + types: + - +- description: LivePipelinesOperations operations + name: live_pipelines + types: + - +- description: PipelineJobsOperations operations + name: pipeline_jobs + types: + - +- description: LivePipelineOperationStatusesOperations operations + name: live_pipeline_operation_statuses + types: + - +- description: PipelineJobOperationStatusesOperations operations + name: pipeline_job_operation_statuses + types: + - +- description: Operations operations + name: operations + types: + - +- description: VideoAnalyzersOperations operations + name: video_analyzers + types: + - +- description: PrivateLinkResourcesOperations operations + name: private_link_resources + types: + - +- description: PrivateEndpointConnectionsOperations operations + name: private_endpoint_connections + types: + - +- description: OperationStatusesOperations operations + name: operation_statuses + types: + - +- description: OperationResultsOperations operations + name: operation_results + types: + - +- description: VideoAnalyzerOperationStatusesOperations operations + name: video_analyzer_operation_statuses + types: + - +- description: VideoAnalyzerOperationResultsOperations operations + name: video_analyzer_operation_results + types: + - +- description: LocationsOperations operations + name: locations + types: + - +- description: VideosOperations operations + name: videos + types: + - +- description: AccessPoliciesOperations operations + name: access_policies + types: + - +methods: +- uid: azure.mgmt.videoanalyzer.aio.VideoAnalyzer.close + name: close + signature: async close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.AccessPoliciesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.AccessPoliciesOperations.yml new file mode 100644 index 00000000..132daaa6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.AccessPoliciesOperations.yml @@ -0,0 +1,229 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.aio.operations.AccessPoliciesOperations +name: AccessPoliciesOperations +fullName: azure.mgmt.videoanalyzer.aio.operations.AccessPoliciesOperations +module: azure.mgmt.videoanalyzer.aio.operations +summary: 'AccessPoliciesOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: AccessPoliciesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.aio.operations.AccessPoliciesOperations.create_or_update + name: create_or_update + summary: 'Creates a new access policy resource or updates an existing one. + + + Creates a new access policy resource or updates an existing one with the given + name.' + signature: 'async create_or_update(resource_group_name: str, account_name: str, + access_policy_name: str, parameters: AccessPolicyEntity, **kwargs: Any) -> AccessPolicyEntity' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: access_policy_name + description: The Access Policy name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AccessPolicyEntity, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.AccessPoliciesOperations.delete + name: delete + summary: 'Deletes an existing access policy resource. + + + Deletes an existing access policy resource with the given name.' + signature: 'async delete(resource_group_name: str, account_name: str, access_policy_name: + str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: access_policy_name + description: The Access Policy name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.AccessPoliciesOperations.get + name: get + summary: 'Retrieves an existing access policy resource. + + + Retrieves an existing access policy resource with the given name.' + signature: 'async get(resource_group_name: str, account_name: str, access_policy_name: + str, **kwargs: Any) -> AccessPolicyEntity' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: access_policy_name + description: The Access Policy name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AccessPolicyEntity, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.AccessPoliciesOperations.list + name: list + summary: 'List all existing access policy resources. + + + Retrieves all existing access policy resources, along with their JSON representations.' + signature: 'list(resource_group_name: str, account_name: str, top: int | None = + None, **kwargs: Any) -> AsyncIterable[AccessPolicyEntityCollection]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: top + description: 'Specifies a non-negative integer n that limits the number of items + returned from a + + collection. The service returns the number of available items up to but not + greater than the + + specified value n.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either AccessPolicyEntityCollection + or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.AccessPoliciesOperations.update + name: update + summary: 'Updates individual properties of an existing access policy resource. + + + Updates individual properties of an existing access policy resource with the given + name.' + signature: 'async update(resource_group_name: str, account_name: str, access_policy_name: + str, parameters: AccessPolicyEntity, **kwargs: Any) -> AccessPolicyEntity' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: access_policy_name + description: The Access Policy name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AccessPolicyEntity, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.aio.operations.AccessPoliciesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.EdgeModulesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.EdgeModulesOperations.yml new file mode 100644 index 00000000..3c088eed --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.EdgeModulesOperations.yml @@ -0,0 +1,269 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.aio.operations.EdgeModulesOperations +name: EdgeModulesOperations +fullName: azure.mgmt.videoanalyzer.aio.operations.EdgeModulesOperations +module: azure.mgmt.videoanalyzer.aio.operations +summary: 'EdgeModulesOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: EdgeModulesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.aio.operations.EdgeModulesOperations.create_or_update + name: create_or_update + summary: 'Creates a new edge module or updates an existing one. + + + Creates a new edge module or updates an existing one. An edge module resource + enables a single + + instance of an Azure Video Analyzer IoT edge module to interact with the Video + Analyzer + + Account. This is used for authorization and also to make sure that the particular + edge module + + instance only has access to the data it requires from the Azure Video Analyzer + service. A new + + edge module resource should be created for every new instance of an Azure Video + Analyzer edge + + module deployed to you Azure IoT edge environment. Edge module resources can be + deleted if the + + specific module is not in use anymore.' + signature: 'async create_or_update(resource_group_name: str, account_name: str, + edge_module_name: str, parameters: EdgeModuleEntity, **kwargs: Any) -> EdgeModuleEntity' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: edge_module_name + description: The Edge Module name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: EdgeModuleEntity, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.EdgeModulesOperations.delete + name: delete + summary: 'Deletes an existing edge module resource. + + + Deletes an existing edge module resource. Deleting the edge module resource will + prevent an + + Azure Video Analyzer IoT edge module which was previously initiated with the module + + provisioning token from communicating with the cloud.' + signature: 'async delete(resource_group_name: str, account_name: str, edge_module_name: + str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: edge_module_name + description: The Edge Module name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.EdgeModulesOperations.get + name: get + summary: 'Retrieves an existing edge module resource. + + + Retrieves an existing edge module resource with the given name.' + signature: 'async get(resource_group_name: str, account_name: str, edge_module_name: + str, **kwargs: Any) -> EdgeModuleEntity' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: edge_module_name + description: The Edge Module name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: EdgeModuleEntity, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.EdgeModulesOperations.list + name: list + summary: 'List all existing edge module resources. + + + List all existing edge module resources, along with their JSON representations.' + signature: 'list(resource_group_name: str, account_name: str, top: int | None = + None, **kwargs: Any) -> AsyncIterable[EdgeModuleEntityCollection]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: top + description: 'Specifies a non-negative integer n that limits the number of items + returned from a + + collection. The service returns the number of available items up to but not + greater than the + + specified value n.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either EdgeModuleEntityCollection or + the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.EdgeModulesOperations.list_provisioning_token + name: list_provisioning_token + summary: 'Creates a new provisioning token. + + + Creates a new provisioning token. A provisioning token allows for a single instance + of Azure + + Video analyzer IoT edge module to be initialized and authorized to the cloud account. + The + + provisioning token itself is short lived and it is only used for the initial handshake + between + + IoT edge module and the cloud. After the initial handshake, the IoT edge module + will agree on a + + set of authentication keys which will be auto-rotated as long as the module is + able to + + periodically connect to the cloud. A new provisioning token can be generated for + the same IoT + + edge module in case the module state lost or reset.' + signature: 'async list_provisioning_token(resource_group_name: str, account_name: + str, edge_module_name: str, parameters: ListProvisioningTokenInput, **kwargs: + Any) -> EdgeModuleProvisioningToken' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: edge_module_name + description: The Edge Module name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: EdgeModuleProvisioningToken, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.aio.operations.EdgeModulesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.LivePipelineOperationStatusesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.LivePipelineOperationStatusesOperations.yml new file mode 100644 index 00000000..9ad493f1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.LivePipelineOperationStatusesOperations.yml @@ -0,0 +1,75 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.aio.operations.LivePipelineOperationStatusesOperations +name: LivePipelineOperationStatusesOperations +fullName: azure.mgmt.videoanalyzer.aio.operations.LivePipelineOperationStatusesOperations +module: azure.mgmt.videoanalyzer.aio.operations +summary: 'LivePipelineOperationStatusesOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: LivePipelineOperationStatusesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.aio.operations.LivePipelineOperationStatusesOperations.get + name: get + summary: 'Get the operation status. + + + Get the operation status of a live pipeline.' + signature: 'async get(resource_group_name: str, account_name: str, live_pipeline_name: + str, operation_id: str, **kwargs: Any) -> LivePipelineOperationStatus' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: live_pipeline_name + description: Live pipeline unique identifier. + isRequired: true + types: + - + - name: operation_id + description: The operation ID. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LivePipelineOperationStatus, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.aio.operations.LivePipelineOperationStatusesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.LivePipelinesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.LivePipelinesOperations.yml new file mode 100644 index 00000000..eca3cd63 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.LivePipelinesOperations.yml @@ -0,0 +1,349 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.aio.operations.LivePipelinesOperations +name: LivePipelinesOperations +fullName: azure.mgmt.videoanalyzer.aio.operations.LivePipelinesOperations +module: azure.mgmt.videoanalyzer.aio.operations +summary: 'LivePipelinesOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: LivePipelinesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.aio.operations.LivePipelinesOperations.begin_activate + name: begin_activate + summary: 'Activates a live pipeline. + + + Activates a live pipeline with the given name.' + signature: 'async begin_activate(resource_group_name: str, account_name: str, live_pipeline_name: + str, **kwargs: Any) -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: live_pipeline_name + description: Live pipeline unique identifier. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.LivePipelinesOperations.begin_deactivate + name: begin_deactivate + summary: 'Deactivates a live pipeline. + + + Deactivates a live pipeline with the given name.' + signature: 'async begin_deactivate(resource_group_name: str, account_name: str, + live_pipeline_name: str, **kwargs: Any) -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: live_pipeline_name + description: Live pipeline unique identifier. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.LivePipelinesOperations.create_or_update + name: create_or_update + summary: 'Creates or updates a live pipeline. + + + Creates a new live pipeline or updates an existing one, with the given name.' + signature: 'async create_or_update(resource_group_name: str, account_name: str, + live_pipeline_name: str, parameters: LivePipeline, **kwargs: Any) -> LivePipeline' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: live_pipeline_name + description: Live pipeline unique identifier. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LivePipeline, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.LivePipelinesOperations.delete + name: delete + summary: 'Deletes a live pipeline. + + + Deletes a live pipeline with the given name.' + signature: 'async delete(resource_group_name: str, account_name: str, live_pipeline_name: + str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: live_pipeline_name + description: Live pipeline unique identifier. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.LivePipelinesOperations.get + name: get + summary: 'Retrieves a specific live pipeline by name. + + + Retrieves a specific live pipeline by name. If a live pipeline with that name + has been + + previously created, the call will return the JSON representation of that instance.' + signature: 'async get(resource_group_name: str, account_name: str, live_pipeline_name: + str, **kwargs: Any) -> LivePipeline' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: live_pipeline_name + description: Live pipeline unique identifier. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LivePipeline, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.LivePipelinesOperations.list + name: list + summary: 'Retrieves a list of live pipelines. + + + Retrieves a list of live pipelines that have been created, along with their JSON + + representations.' + signature: 'list(resource_group_name: str, account_name: str, filter: str | None + = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[LivePipelineCollection]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: filter + description: Restricts the set of items returned. + defaultValue: None + types: + - + - name: top + description: 'Specifies a non-negative integer n that limits the number of items + returned from a + + collection. The service returns the number of available items up to but not + greater than the + + specified value n.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either LivePipelineCollection or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.LivePipelinesOperations.update + name: update + summary: 'Updates an existing live pipeline. + + + Updates an existing live pipeline with the given name. Properties that can be + updated include: + + description, bitrateKbps, and parameter definitions. Only the description can + be updated while + + the live pipeline is active.' + signature: 'async update(resource_group_name: str, account_name: str, live_pipeline_name: + str, parameters: LivePipelineUpdate, **kwargs: Any) -> LivePipeline' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: live_pipeline_name + description: Live pipeline unique identifier. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LivePipeline, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.aio.operations.LivePipelinesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.LocationsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.LocationsOperations.yml new file mode 100644 index 00000000..c11e7ffb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.LocationsOperations.yml @@ -0,0 +1,65 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.aio.operations.LocationsOperations +name: LocationsOperations +fullName: azure.mgmt.videoanalyzer.aio.operations.LocationsOperations +module: azure.mgmt.videoanalyzer.aio.operations +summary: 'LocationsOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: LocationsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.aio.operations.LocationsOperations.check_name_availability + name: check_name_availability + summary: 'Check Name Availability. + + + Checks whether the Video Analyzer resource name is available.' + signature: 'async check_name_availability(location_name: str, parameters: CheckNameAvailabilityRequest, + **kwargs: Any) -> CheckNameAvailabilityResponse' + parameters: + - name: location_name + description: Location Name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: CheckNameAvailabilityResponse, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.aio.operations.LocationsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.OperationResultsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.OperationResultsOperations.yml new file mode 100644 index 00000000..43a6af16 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.OperationResultsOperations.yml @@ -0,0 +1,76 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.aio.operations.OperationResultsOperations +name: OperationResultsOperations +fullName: azure.mgmt.videoanalyzer.aio.operations.OperationResultsOperations +module: azure.mgmt.videoanalyzer.aio.operations +summary: 'OperationResultsOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: OperationResultsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.aio.operations.OperationResultsOperations.get + name: get + summary: 'Get operation result. + + + Get private endpoint connection operation result.' + signature: 'async get(resource_group_name: str, account_name: str, name: str, operation_id: + str, **kwargs: Any) -> PrivateEndpointConnection | None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + - name: name + description: Private endpoint connection name. + isRequired: true + types: + - + - name: operation_id + description: Operation Id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PrivateEndpointConnection, or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.aio.operations.OperationResultsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.OperationStatusesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.OperationStatusesOperations.yml new file mode 100644 index 00000000..26427a95 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.OperationStatusesOperations.yml @@ -0,0 +1,76 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.aio.operations.OperationStatusesOperations +name: OperationStatusesOperations +fullName: azure.mgmt.videoanalyzer.aio.operations.OperationStatusesOperations +module: azure.mgmt.videoanalyzer.aio.operations +summary: 'OperationStatusesOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: OperationStatusesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.aio.operations.OperationStatusesOperations.get + name: get + summary: 'Get operation status. + + + Get private endpoint connection operation status.' + signature: 'async get(resource_group_name: str, account_name: str, name: str, operation_id: + str, **kwargs: Any) -> VideoAnalyzerPrivateEndpointConnectionOperationStatus' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + - name: name + description: Private endpoint connection name. + isRequired: true + types: + - + - name: operation_id + description: Operation Id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VideoAnalyzerPrivateEndpointConnectionOperationStatus, or the result + of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.aio.operations.OperationStatusesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.Operations.yml new file mode 100644 index 00000000..b06b7304 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.Operations.yml @@ -0,0 +1,53 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.aio.operations.Operations +name: Operations +fullName: azure.mgmt.videoanalyzer.aio.operations.Operations +module: azure.mgmt.videoanalyzer.aio.operations +summary: 'Operations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: Operations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.aio.operations.Operations.list + name: list + summary: 'List Operations. + + + Lists all the Media operations.' + signature: 'async list(**kwargs: Any) -> OperationCollection' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: OperationCollection, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.aio.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.PipelineJobOperationStatusesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.PipelineJobOperationStatusesOperations.yml new file mode 100644 index 00000000..97afcf57 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.PipelineJobOperationStatusesOperations.yml @@ -0,0 +1,75 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.aio.operations.PipelineJobOperationStatusesOperations +name: PipelineJobOperationStatusesOperations +fullName: azure.mgmt.videoanalyzer.aio.operations.PipelineJobOperationStatusesOperations +module: azure.mgmt.videoanalyzer.aio.operations +summary: 'PipelineJobOperationStatusesOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: PipelineJobOperationStatusesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.aio.operations.PipelineJobOperationStatusesOperations.get + name: get + summary: 'Get the operation statuses. + + + Get the operation status of a pipeline job with the given operationId.' + signature: 'async get(resource_group_name: str, account_name: str, pipeline_job_name: + str, operation_id: str, **kwargs: Any) -> PipelineJobOperationStatus' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: pipeline_job_name + description: The pipeline job name. + isRequired: true + types: + - + - name: operation_id + description: The operation ID. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PipelineJobOperationStatus, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.aio.operations.PipelineJobOperationStatusesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.PipelineJobsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.PipelineJobsOperations.yml new file mode 100644 index 00000000..97692aa1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.PipelineJobsOperations.yml @@ -0,0 +1,294 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.aio.operations.PipelineJobsOperations +name: PipelineJobsOperations +fullName: azure.mgmt.videoanalyzer.aio.operations.PipelineJobsOperations +module: azure.mgmt.videoanalyzer.aio.operations +summary: 'PipelineJobsOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: PipelineJobsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.aio.operations.PipelineJobsOperations.begin_cancel + name: begin_cancel + summary: 'Cancels a pipeline job. + + + Cancels a pipeline job with the given name.' + signature: 'async begin_cancel(resource_group_name: str, account_name: str, pipeline_job_name: + str, **kwargs: Any) -> AsyncLROPoller[None]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: pipeline_job_name + description: The pipeline job name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.PipelineJobsOperations.create_or_update + name: create_or_update + summary: 'Creates or updates a pipeline job. + + + Creates a new pipeline job or updates an existing one, with the given name.' + signature: 'async create_or_update(resource_group_name: str, account_name: str, + pipeline_job_name: str, parameters: PipelineJob, **kwargs: Any) -> PipelineJob' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: pipeline_job_name + description: The pipeline job name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PipelineJob, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.PipelineJobsOperations.delete + name: delete + summary: 'Deletes a pipeline job. + + + Deletes a pipeline job with the given name.' + signature: 'async delete(resource_group_name: str, account_name: str, pipeline_job_name: + str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: pipeline_job_name + description: The pipeline job name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.PipelineJobsOperations.get + name: get + summary: 'Gets a specific pipeline job by name. + + + Retrieves a specific pipeline job by name. If a pipeline job with that name has + been previously + + created, the call will return the JSON representation of that instance.' + signature: 'async get(resource_group_name: str, account_name: str, pipeline_job_name: + str, **kwargs: Any) -> PipelineJob' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: pipeline_job_name + description: The pipeline job name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PipelineJob, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.PipelineJobsOperations.list + name: list + summary: 'Retrieves a list of pipeline jobs. + + + Retrieves a list of all live pipelines that have been created, along with their + JSON + + representations.' + signature: 'list(resource_group_name: str, account_name: str, filter: str | None + = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[PipelineJobCollection]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: filter + description: Restricts the set of items returned. + defaultValue: None + types: + - + - name: top + description: 'Specifies a non-negative integer n that limits the number of items + returned from a + + collection. The service returns the number of available items up to but not + greater than the + + specified value n.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either PipelineJobCollection or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.PipelineJobsOperations.update + name: update + summary: 'Updates an existing pipeline job. + + + Updates an existing pipeline job with the given name. Properties that can be updated + include: + + description.' + signature: 'async update(resource_group_name: str, account_name: str, pipeline_job_name: + str, parameters: PipelineJobUpdate, **kwargs: Any) -> PipelineJob' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: pipeline_job_name + description: The pipeline job name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PipelineJob, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.aio.operations.PipelineJobsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.PipelineTopologiesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.PipelineTopologiesOperations.yml new file mode 100644 index 00000000..a59addf2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.PipelineTopologiesOperations.yml @@ -0,0 +1,259 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.aio.operations.PipelineTopologiesOperations +name: PipelineTopologiesOperations +fullName: azure.mgmt.videoanalyzer.aio.operations.PipelineTopologiesOperations +module: azure.mgmt.videoanalyzer.aio.operations +summary: 'PipelineTopologiesOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: PipelineTopologiesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.aio.operations.PipelineTopologiesOperations.create_or_update + name: create_or_update + summary: 'Creates or updates a pipeline topology. + + + Creates a new pipeline topology or updates an existing one, with the given name. + A pipeline + + topology describes the processing steps to be applied when processing content + for a particular + + outcome. The topology should be defined according to the scenario to be achieved + and can be + + reused across many pipeline instances which share the same processing characteristics.' + signature: 'async create_or_update(resource_group_name: str, account_name: str, + pipeline_topology_name: str, parameters: PipelineTopology, **kwargs: Any) -> PipelineTopology' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: pipeline_topology_name + description: Pipeline topology unique identifier. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PipelineTopology, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.PipelineTopologiesOperations.delete + name: delete + summary: 'Deletes a pipeline topology. + + + Deletes a pipeline topology with the given name. This method should be called + after all + + instances of the topology have been stopped and deleted.' + signature: 'async delete(resource_group_name: str, account_name: str, pipeline_topology_name: + str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: pipeline_topology_name + description: Pipeline topology unique identifier. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.PipelineTopologiesOperations.get + name: get + summary: 'Retrieves a specific pipeline topology by name. + + + Retrieves a specific pipeline topology by name. If a topology with that name has + been + + previously created, the call will return the JSON representation of that topology.' + signature: 'async get(resource_group_name: str, account_name: str, pipeline_topology_name: + str, **kwargs: Any) -> PipelineTopology' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: pipeline_topology_name + description: Pipeline topology unique identifier. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PipelineTopology, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.PipelineTopologiesOperations.list + name: list + summary: 'Retrieves a list of pipeline topologies. + + + Retrieves a list of pipeline topologies that have been added to the account, if + any, along with + + their JSON representation.' + signature: 'list(resource_group_name: str, account_name: str, filter: str | None + = None, top: int | None = None, **kwargs: Any) -> AsyncIterable[PipelineTopologyCollection]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: filter + description: Restricts the set of items returned. + defaultValue: None + types: + - + - name: top + description: 'Specifies a non-negative integer n that limits the number of items + returned from a + + collection. The service returns the number of available items up to but not + greater than the + + specified value n.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either PipelineTopologyCollection or + the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.PipelineTopologiesOperations.update + name: update + summary: 'Updates an existing pipeline topology. + + + Updates an existing pipeline topology with the given name. If the associated live + pipelines or + + pipeline jobs are in active or processing state, respectively, then only the description + can be + + updated. Else, the properties that can be updated include: description, parameter + declarations, + + sources, processors, and sinks.' + signature: 'async update(resource_group_name: str, account_name: str, pipeline_topology_name: + str, parameters: PipelineTopologyUpdate, **kwargs: Any) -> PipelineTopology' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: pipeline_topology_name + description: Pipeline topology unique identifier. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PipelineTopology, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.aio.operations.PipelineTopologiesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.PrivateEndpointConnectionsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.PrivateEndpointConnectionsOperations.yml new file mode 100644 index 00000000..d27bbc0a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.PrivateEndpointConnectionsOperations.yml @@ -0,0 +1,175 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.aio.operations.PrivateEndpointConnectionsOperations +name: PrivateEndpointConnectionsOperations +fullName: azure.mgmt.videoanalyzer.aio.operations.PrivateEndpointConnectionsOperations +module: azure.mgmt.videoanalyzer.aio.operations +summary: 'PrivateEndpointConnectionsOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: PrivateEndpointConnectionsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.aio.operations.PrivateEndpointConnectionsOperations.create_or_update + name: create_or_update + summary: 'Update private endpoint connection. + + + Update private endpoint connection state under video analyzer account.' + signature: 'async create_or_update(resource_group_name: str, account_name: str, + name: str, parameters: PrivateEndpointConnection, **kwargs: Any) -> PrivateEndpointConnection' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + - name: name + description: Private endpoint connection name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PrivateEndpointConnection, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.PrivateEndpointConnectionsOperations.delete + name: delete + summary: 'Delete private endpoint connection. + + + Delete private endpoint connection under video analyzer account.' + signature: 'async delete(resource_group_name: str, account_name: str, name: str, + **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + - name: name + description: Private endpoint connection name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.PrivateEndpointConnectionsOperations.get + name: get + summary: 'Get private endpoint connection. + + + Get private endpoint connection under video analyzer account.' + signature: 'async get(resource_group_name: str, account_name: str, name: str, **kwargs: + Any) -> PrivateEndpointConnection' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + - name: name + description: Private endpoint connection name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PrivateEndpointConnection, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.PrivateEndpointConnectionsOperations.list + name: list + summary: 'Get all private endpoint connections. + + + Get all private endpoint connections under video analyzer account.' + signature: 'async list(resource_group_name: str, account_name: str, **kwargs: Any) + -> PrivateEndpointConnectionListResult' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PrivateEndpointConnectionListResult, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.aio.operations.PrivateEndpointConnectionsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.PrivateLinkResourcesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.PrivateLinkResourcesOperations.yml new file mode 100644 index 00000000..d1705fd8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.PrivateLinkResourcesOperations.yml @@ -0,0 +1,100 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.aio.operations.PrivateLinkResourcesOperations +name: PrivateLinkResourcesOperations +fullName: azure.mgmt.videoanalyzer.aio.operations.PrivateLinkResourcesOperations +module: azure.mgmt.videoanalyzer.aio.operations +summary: 'PrivateLinkResourcesOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: PrivateLinkResourcesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.aio.operations.PrivateLinkResourcesOperations.get + name: get + summary: 'Get group ID. + + + Get group ID for video analyzer account.' + signature: 'async get(resource_group_name: str, account_name: str, name: str, **kwargs: + Any) -> PrivateLinkResource' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + - name: name + description: Name of the private link resource (Group ID). + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PrivateLinkResource, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.PrivateLinkResourcesOperations.list + name: list + summary: 'Get list of group IDs. + + + Get list of group IDs for video analyzer account.' + signature: 'async list(resource_group_name: str, account_name: str, **kwargs: Any) + -> PrivateLinkResourceListResult' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PrivateLinkResourceListResult, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.aio.operations.PrivateLinkResourcesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzerOperationResultsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzerOperationResultsOperations.yml new file mode 100644 index 00000000..b79e5ab6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzerOperationResultsOperations.yml @@ -0,0 +1,66 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzerOperationResultsOperations +name: VideoAnalyzerOperationResultsOperations +fullName: azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzerOperationResultsOperations +module: azure.mgmt.videoanalyzer.aio.operations +summary: 'VideoAnalyzerOperationResultsOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: VideoAnalyzerOperationResultsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzerOperationResultsOperations.get + name: get + summary: 'Get operation result. + + + Get video analyzer operation result.' + signature: 'async get(location_name: str, operation_id: str, **kwargs: Any) -> VideoAnalyzer + | None' + parameters: + - name: location_name + description: Location name. + isRequired: true + types: + - + - name: operation_id + description: Operation Id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VideoAnalyzer, or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzerOperationResultsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzerOperationStatusesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzerOperationStatusesOperations.yml new file mode 100644 index 00000000..67b11c6d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzerOperationStatusesOperations.yml @@ -0,0 +1,64 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzerOperationStatusesOperations +name: VideoAnalyzerOperationStatusesOperations +fullName: azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzerOperationStatusesOperations +module: azure.mgmt.videoanalyzer.aio.operations +summary: 'VideoAnalyzerOperationStatusesOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: VideoAnalyzerOperationStatusesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzerOperationStatusesOperations.get + name: get + summary: 'Get operation status. + + + Get video analyzer operation status.' + signature: 'async get(location_name: str, operation_id: str, **kwargs: Any) -> VideoAnalyzerOperationStatus' + parameters: + - name: location_name + description: Location name. + isRequired: true + types: + - + - name: operation_id + description: Operation Id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VideoAnalyzerOperationStatus, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzerOperationStatusesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzersOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzersOperations.yml new file mode 100644 index 00000000..2a00355c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzersOperations.yml @@ -0,0 +1,243 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzersOperations +name: VideoAnalyzersOperations +fullName: azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzersOperations +module: azure.mgmt.videoanalyzer.aio.operations +summary: 'VideoAnalyzersOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: VideoAnalyzersOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzersOperations.begin_create_or_update + name: begin_create_or_update + summary: 'Create or update a Video Analyzer account. + + + Create or update an instance of a Video Analyzer account.' + signature: 'async begin_create_or_update(resource_group_name: str, account_name: + str, parameters: VideoAnalyzer, **kwargs: Any) -> AsyncLROPoller[VideoAnalyzer]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either VideoAnalyzer or + the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzersOperations.begin_update + name: begin_update + summary: 'Update a Video Analyzer account. + + + Updates an existing instance of Video Analyzer account.' + signature: 'async begin_update(resource_group_name: str, account_name: str, parameters: + VideoAnalyzerUpdate, **kwargs: Any) -> AsyncLROPoller[VideoAnalyzer]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be AsyncARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either VideoAnalyzer or + the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzersOperations.delete + name: delete + summary: 'Delete a Video Analyzer account. + + + Delete the specified Video Analyzer account.' + signature: 'async delete(resource_group_name: str, account_name: str, **kwargs: + Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzersOperations.get + name: get + summary: 'Get a Video Analyzer account. + + + Get the details of the specified Video Analyzer account.' + signature: 'async get(resource_group_name: str, account_name: str, **kwargs: Any) + -> VideoAnalyzer' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VideoAnalyzer, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzersOperations.list + name: list + summary: 'List Video Analyzer accounts. + + + Lists the Video Analyzer accounts in the specified resource group.' + signature: 'async list(resource_group_name: str, **kwargs: Any) -> VideoAnalyzerCollection' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VideoAnalyzerCollection, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzersOperations.list_by_subscription + name: list_by_subscription + summary: 'List Video Analyzer accounts. + + + List all Video Analyzer accounts in the specified subscription.' + signature: 'async list_by_subscription(**kwargs: Any) -> VideoAnalyzerCollection' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VideoAnalyzerCollection, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzersOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.VideosOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.VideosOperations.yml new file mode 100644 index 00000000..464304d9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.VideosOperations.yml @@ -0,0 +1,270 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.aio.operations.VideosOperations +name: VideosOperations +fullName: azure.mgmt.videoanalyzer.aio.operations.VideosOperations +module: azure.mgmt.videoanalyzer.aio.operations +summary: 'VideosOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: VideosOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.aio.operations.VideosOperations.create_or_update + name: create_or_update + summary: 'Creates a new video resource or updates an existing one. + + + Creates a new video resource or updates an existing video resource with the given + name.' + signature: 'async create_or_update(resource_group_name: str, account_name: str, + video_name: str, parameters: VideoEntity, **kwargs: Any) -> VideoEntity' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: video_name + description: The Video name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VideoEntity, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.VideosOperations.delete + name: delete + summary: 'Deletes an existing video resource and its underlying data. + + + Deletes an existing video resource and its underlying data. This operation is + irreversible.' + signature: 'async delete(resource_group_name: str, account_name: str, video_name: + str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: video_name + description: The Video name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.VideosOperations.get + name: get + summary: 'Retrieves an existing video resource. + + + Retrieves an existing video resource with the given name.' + signature: 'async get(resource_group_name: str, account_name: str, video_name: str, + **kwargs: Any) -> VideoEntity' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: video_name + description: The Video name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VideoEntity, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.VideosOperations.list + name: list + summary: 'Retrieves all existing video resources. + + + Retrieves a list of video resources that have been created, along with their JSON + + representations.' + signature: 'list(resource_group_name: str, account_name: str, top: int | None = + None, **kwargs: Any) -> AsyncIterable[VideoEntityCollection]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: top + description: 'Specifies a non-negative integer n that limits the number of items + returned from a + + collection. The service returns the number of available items up to but not + greater than the + + specified value n.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either VideoEntityCollection or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.VideosOperations.list_content_token + name: list_content_token + summary: 'Generates a streaming token which can be used for accessing content from + video content URLs. + + + Generates a streaming token which can be used for accessing content from video + content URLs, + + for a video resource with the given name.' + signature: 'async list_content_token(resource_group_name: str, account_name: str, + video_name: str, **kwargs: Any) -> VideoContentToken' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: video_name + description: The Video name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VideoContentToken, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.aio.operations.VideosOperations.update + name: update + summary: 'Updates individual properties of an existing video resource. + + + Updates individual properties of an existing video resource with the given name.' + signature: 'async update(resource_group_name: str, account_name: str, video_name: + str, parameters: VideoEntity, **kwargs: Any) -> VideoEntity' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: video_name + description: The Video name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VideoEntity, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.aio.operations.VideosOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.yml new file mode 100644 index 00000000..0808e3b0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.operations.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.videoanalyzer.aio.operations +name: operations +fullName: azure.mgmt.videoanalyzer.aio.operations +type: import +classes: +- azure.mgmt.videoanalyzer.aio.operations.AccessPoliciesOperations +- azure.mgmt.videoanalyzer.aio.operations.EdgeModulesOperations +- azure.mgmt.videoanalyzer.aio.operations.LivePipelineOperationStatusesOperations +- azure.mgmt.videoanalyzer.aio.operations.LivePipelinesOperations +- azure.mgmt.videoanalyzer.aio.operations.LocationsOperations +- azure.mgmt.videoanalyzer.aio.operations.OperationResultsOperations +- azure.mgmt.videoanalyzer.aio.operations.OperationStatusesOperations +- azure.mgmt.videoanalyzer.aio.operations.Operations +- azure.mgmt.videoanalyzer.aio.operations.PipelineJobOperationStatusesOperations +- azure.mgmt.videoanalyzer.aio.operations.PipelineJobsOperations +- azure.mgmt.videoanalyzer.aio.operations.PipelineTopologiesOperations +- azure.mgmt.videoanalyzer.aio.operations.PrivateEndpointConnectionsOperations +- azure.mgmt.videoanalyzer.aio.operations.PrivateLinkResourcesOperations +- azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzerOperationResultsOperations +- azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzerOperationStatusesOperations +- azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzersOperations +- azure.mgmt.videoanalyzer.aio.operations.VideosOperations diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.yml new file mode 100644 index 00000000..16dec7b6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.aio.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.videoanalyzer.aio +name: aio +fullName: azure.mgmt.videoanalyzer.aio +type: import +classes: +- azure.mgmt.videoanalyzer.aio.VideoAnalyzer +packages: +- azure.mgmt.videoanalyzer.aio.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyEccAlgo.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyEccAlgo.yml new file mode 100644 index 00000000..8b874298 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyEccAlgo.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.AccessPolicyEccAlgo +name: AccessPolicyEccAlgo +fullName: azure.mgmt.videoanalyzer.models.AccessPolicyEccAlgo +summary: 'Elliptical curve algorithm to be used: ES256, ES384 or ES512.' +module: azure.mgmt.videoanalyzer.models +fields: +- name: ES256 + uid: azure.mgmt.videoanalyzer.models.AccessPolicyEccAlgo.ES256 +- name: ES384 + uid: azure.mgmt.videoanalyzer.models.AccessPolicyEccAlgo.ES384 +- name: ES512 + uid: azure.mgmt.videoanalyzer.models.AccessPolicyEccAlgo.ES512 diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyEntity.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyEntity.yml new file mode 100644 index 00000000..ee0f8ef9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyEntity.yml @@ -0,0 +1,57 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.AccessPolicyEntity +name: AccessPolicyEntity +fullName: azure.mgmt.videoanalyzer.models.AccessPolicyEntity +module: azure.mgmt.videoanalyzer.models +summary: 'Access policies help define the authentication rules, and control access + to specific video resources. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'AccessPolicyEntity(*, role: str | AccessPolicyRole | None = None, authentication: + AuthenticationBase | None = None, **kwargs)' + parameters: + - name: role + description: 'Defines the access level granted by this policy. Possible values + include: + + "Reader".' + isRequired: true + types: + - + - + - name: authentication + description: Authentication method to be used when validating client API access. + isRequired: true + types: + - + keywordOnlyParameters: + - name: role + isRequired: true + - name: authentication + isRequired: true +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyEntityCollection.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyEntityCollection.yml new file mode 100644 index 00000000..11067131 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyEntityCollection.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.AccessPolicyEntityCollection +name: AccessPolicyEntityCollection +fullName: azure.mgmt.videoanalyzer.models.AccessPolicyEntityCollection +module: azure.mgmt.videoanalyzer.models +summary: A collection of AccessPolicyEntity items. +constructor: + syntax: 'AccessPolicyEntityCollection(*, value: List[AccessPolicyEntity] | None + = None, next_link: str | None = None, **kwargs)' + parameters: + - name: value + description: A collection of AccessPolicyEntity items. + isRequired: true + types: + - [] + - name: next_link + description: 'A link to the next page of the collection (when the collection contains + too + + many results to return in one response).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: next_link + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyRole.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyRole.yml new file mode 100644 index 00000000..9e7da2d1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyRole.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.AccessPolicyRole +name: AccessPolicyRole +fullName: azure.mgmt.videoanalyzer.models.AccessPolicyRole +summary: Defines the access level granted by this policy. +module: azure.mgmt.videoanalyzer.models +fields: +- name: READER + uid: azure.mgmt.videoanalyzer.models.AccessPolicyRole.READER diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyRsaAlgo.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyRsaAlgo.yml new file mode 100644 index 00000000..8fb878bc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyRsaAlgo.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.AccessPolicyRsaAlgo +name: AccessPolicyRsaAlgo +fullName: azure.mgmt.videoanalyzer.models.AccessPolicyRsaAlgo +summary: 'RSA algorithm to be used: RS256, RS384 or RS512.' +module: azure.mgmt.videoanalyzer.models +fields: +- name: RS256 + uid: azure.mgmt.videoanalyzer.models.AccessPolicyRsaAlgo.RS256 +- name: RS384 + uid: azure.mgmt.videoanalyzer.models.AccessPolicyRsaAlgo.RS384 +- name: RS512 + uid: azure.mgmt.videoanalyzer.models.AccessPolicyRsaAlgo.RS512 diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccountEncryption.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccountEncryption.yml new file mode 100644 index 00000000..58162592 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccountEncryption.yml @@ -0,0 +1,47 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.AccountEncryption +name: AccountEncryption +fullName: azure.mgmt.videoanalyzer.models.AccountEncryption +module: azure.mgmt.videoanalyzer.models +summary: 'Defines how the Video Analyzer account is (optionally) encrypted. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AccountEncryption(*, type: str | AccountEncryptionKeyType, key_vault_properties: + KeyVaultProperties | None = None, identity: ResourceIdentity | None = None, **kwargs)' + parameters: + - name: type + description: 'Required. The type of key used to encrypt the Account Key. Possible + values + + include: "SystemKey", "CustomerKey".' + isRequired: true + types: + - + - + - name: key_vault_properties + description: The properties of the key used to encrypt the account. + isRequired: true + types: + - + - name: identity + description: The Key Vault identity. + isRequired: true + types: + - + keywordOnlyParameters: + - name: type + isRequired: true + - name: key_vault_properties + isRequired: true + - name: identity + isRequired: true +variables: +- description: The current status of the Key Vault mapping. + name: status + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccountEncryptionKeyType.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccountEncryptionKeyType.yml new file mode 100644 index 00000000..2a208bd1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccountEncryptionKeyType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.AccountEncryptionKeyType +name: AccountEncryptionKeyType +fullName: azure.mgmt.videoanalyzer.models.AccountEncryptionKeyType +summary: The type of key used to encrypt the Account Key. +module: azure.mgmt.videoanalyzer.models +fields: +- name: CUSTOMER_KEY + uid: azure.mgmt.videoanalyzer.models.AccountEncryptionKeyType.CUSTOMER_KEY +- name: SYSTEM_KEY + uid: azure.mgmt.videoanalyzer.models.AccountEncryptionKeyType.SYSTEM_KEY diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ActionType.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ActionType.yml new file mode 100644 index 00000000..26303102 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ActionType.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.ActionType +name: ActionType +fullName: azure.mgmt.videoanalyzer.models.ActionType +summary: Indicates the action type. +module: azure.mgmt.videoanalyzer.models +fields: +- name: INTERNAL + uid: azure.mgmt.videoanalyzer.models.ActionType.INTERNAL diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AudioEncoderAac.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AudioEncoderAac.yml new file mode 100644 index 00000000..072fb46c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AudioEncoderAac.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.AudioEncoderAac +name: AudioEncoderAac +fullName: azure.mgmt.videoanalyzer.models.AudioEncoderAac +module: azure.mgmt.videoanalyzer.models +summary: 'A custom preset for encoding audio with the AAC codec. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AudioEncoderAac(*, bitrate_kbps: str | None = None, **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: bitrate_kbps + description: 'Bitrate, in kilobits per second or Kbps, at which audio should be + encoded + + (2-channel stereo audio at a sampling rate of 48 kHz). Allowed values are 96, + 112, 128, 160, + + 192, 224, and 256. If omitted, the bitrate of the input audio is used.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: bitrate_kbps + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AudioEncoderBase.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AudioEncoderBase.yml new file mode 100644 index 00000000..e302b80c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AudioEncoderBase.yml @@ -0,0 +1,38 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.AudioEncoderBase +name: AudioEncoderBase +fullName: azure.mgmt.videoanalyzer.models.AudioEncoderBase +module: azure.mgmt.videoanalyzer.models +summary: 'Base type for all audio encoder presets, which define the recipe or instructions + on how audio should be processed. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: AudioEncoderAac. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AudioEncoderBase(*, bitrate_kbps: str | None = None, **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: bitrate_kbps + description: 'Bitrate, in kilobits per second or Kbps, at which audio should be + encoded + + (2-channel stereo audio at a sampling rate of 48 kHz). Allowed values are 96, + 112, 128, 160, + + 192, 224, and 256. If omitted, the bitrate of the input audio is used.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: bitrate_kbps + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AuthenticationBase.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AuthenticationBase.yml new file mode 100644 index 00000000..dc66d11b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AuthenticationBase.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.AuthenticationBase +name: AuthenticationBase +fullName: azure.mgmt.videoanalyzer.models.AuthenticationBase +module: azure.mgmt.videoanalyzer.models +summary: 'Base class for access policies authentication methods. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: JwtAuthentication. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: AuthenticationBase(**kwargs) + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CertificateSource.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CertificateSource.yml new file mode 100644 index 00000000..7b81729a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CertificateSource.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.CertificateSource +name: CertificateSource +fullName: azure.mgmt.videoanalyzer.models.CertificateSource +module: azure.mgmt.videoanalyzer.models +summary: 'Base class for certificate sources. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: PemCertificateList. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CertificateSource(**kwargs) + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CheckNameAvailabilityReason.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CheckNameAvailabilityReason.yml new file mode 100644 index 00000000..43224855 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CheckNameAvailabilityReason.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.CheckNameAvailabilityReason +name: CheckNameAvailabilityReason +fullName: azure.mgmt.videoanalyzer.models.CheckNameAvailabilityReason +summary: The reason why the given name is not available. +module: azure.mgmt.videoanalyzer.models +fields: +- name: ALREADY_EXISTS + uid: azure.mgmt.videoanalyzer.models.CheckNameAvailabilityReason.ALREADY_EXISTS +- name: INVALID + uid: azure.mgmt.videoanalyzer.models.CheckNameAvailabilityReason.INVALID diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CheckNameAvailabilityRequest.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CheckNameAvailabilityRequest.yml new file mode 100644 index 00000000..c14d6358 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CheckNameAvailabilityRequest.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.CheckNameAvailabilityRequest +name: CheckNameAvailabilityRequest +fullName: azure.mgmt.videoanalyzer.models.CheckNameAvailabilityRequest +module: azure.mgmt.videoanalyzer.models +summary: The check availability request body. +constructor: + syntax: 'CheckNameAvailabilityRequest(*, name: str | None = None, type: str | None + = None, **kwargs)' + parameters: + - name: name + description: The name of the resource for which availability needs to be checked. + isRequired: true + types: + - + - name: type + description: The resource type. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: type + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CheckNameAvailabilityResponse.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CheckNameAvailabilityResponse.yml new file mode 100644 index 00000000..6d642550 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CheckNameAvailabilityResponse.yml @@ -0,0 +1,36 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.CheckNameAvailabilityResponse +name: CheckNameAvailabilityResponse +fullName: azure.mgmt.videoanalyzer.models.CheckNameAvailabilityResponse +module: azure.mgmt.videoanalyzer.models +summary: The check availability result. +constructor: + syntax: 'CheckNameAvailabilityResponse(*, name_available: bool | None = None, reason: + str | CheckNameAvailabilityReason | None = None, message: str | None = None, **kwargs)' + parameters: + - name: name_available + description: Indicates if the resource name is available. + isRequired: true + types: + - + - name: reason + description: 'The reason why the given name is not available. Possible values + include: + + "Invalid", "AlreadyExists".' + isRequired: true + types: + - + - + - name: message + description: Detailed reason why the given name is available. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name_available + isRequired: true + - name: reason + isRequired: true + - name: message + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CreatedByType.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CreatedByType.yml new file mode 100644 index 00000000..1c912261 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CreatedByType.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.CreatedByType +name: CreatedByType +fullName: azure.mgmt.videoanalyzer.models.CreatedByType +summary: The type of identity that created the resource. +module: azure.mgmt.videoanalyzer.models +fields: +- name: APPLICATION + uid: azure.mgmt.videoanalyzer.models.CreatedByType.APPLICATION +- name: KEY + uid: azure.mgmt.videoanalyzer.models.CreatedByType.KEY +- name: MANAGED_IDENTITY + uid: azure.mgmt.videoanalyzer.models.CreatedByType.MANAGED_IDENTITY +- name: USER + uid: azure.mgmt.videoanalyzer.models.CreatedByType.USER diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CredentialsBase.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CredentialsBase.yml new file mode 100644 index 00000000..ce2161f2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CredentialsBase.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.CredentialsBase +name: CredentialsBase +fullName: azure.mgmt.videoanalyzer.models.CredentialsBase +module: azure.mgmt.videoanalyzer.models +summary: 'Base class for credential objects. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: UsernamePasswordCredentials. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: CredentialsBase(**kwargs) + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EccTokenKey.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EccTokenKey.yml new file mode 100644 index 00000000..e08ee272 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EccTokenKey.yml @@ -0,0 +1,56 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.EccTokenKey +name: EccTokenKey +fullName: azure.mgmt.videoanalyzer.models.EccTokenKey +module: azure.mgmt.videoanalyzer.models +summary: 'Required validation properties for tokens generated with Elliptical Curve + algorithm. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EccTokenKey(*, kid: str, alg: str | AccessPolicyEccAlgo, x: str, y: str, + **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: kid + description: 'Required. JWT token key id. Validation keys are looked up based + on the key id + + present on the JWT token header.' + isRequired: true + types: + - + - name: alg + description: 'Required. Elliptical curve algorithm to be used: ES256, ES384 or + ES512. Possible + + values include: "ES256", "ES384", "ES512".' + isRequired: true + types: + - + - + - name: x + description: Required. X coordinate. + isRequired: true + types: + - + - name: y + description: Required. Y coordinate. + isRequired: true + types: + - + keywordOnlyParameters: + - name: kid + isRequired: true + - name: alg + isRequired: true + - name: x + isRequired: true + - name: y + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EdgeModuleEntity.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EdgeModuleEntity.yml new file mode 100644 index 00000000..06414638 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EdgeModuleEntity.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.EdgeModuleEntity +name: EdgeModuleEntity +fullName: azure.mgmt.videoanalyzer.models.EdgeModuleEntity +module: azure.mgmt.videoanalyzer.models +summary: 'The representation of an edge module. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: EdgeModuleEntity(**kwargs) +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: Internal ID generated for the instance of the Video Analyzer edge module. + name: edge_module_id + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EdgeModuleEntityCollection.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EdgeModuleEntityCollection.yml new file mode 100644 index 00000000..d70f752b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EdgeModuleEntityCollection.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.EdgeModuleEntityCollection +name: EdgeModuleEntityCollection +fullName: azure.mgmt.videoanalyzer.models.EdgeModuleEntityCollection +module: azure.mgmt.videoanalyzer.models +summary: A collection of EdgeModuleEntity items. +constructor: + syntax: 'EdgeModuleEntityCollection(*, value: List[EdgeModuleEntity] | None = None, + next_link: str | None = None, **kwargs)' + parameters: + - name: value + description: A collection of EdgeModuleEntity items. + isRequired: true + types: + - [] + - name: next_link + description: 'A link to the next page of the collection (when the collection contains + too + + many results to return in one response).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: next_link + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EdgeModuleProvisioningToken.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EdgeModuleProvisioningToken.yml new file mode 100644 index 00000000..e9031f27 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EdgeModuleProvisioningToken.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.EdgeModuleProvisioningToken +name: EdgeModuleProvisioningToken +fullName: azure.mgmt.videoanalyzer.models.EdgeModuleProvisioningToken +module: azure.mgmt.videoanalyzer.models +summary: 'Provisioning token properties. A provisioning token allows for a single + instance of Azure Video analyzer IoT edge module to be initialized and authorized + to the cloud account. The provisioning token itself is short lived and it is only + used for the initial handshake between IoT edge module and the cloud. After the + initial handshake, the IoT edge module will agree on a set of authentication keys + which will be auto-rotated as long as the module is able to periodically connect + to the cloud. A new provisioning token can be generated for the same IoT edge module + in case the module state lost or reset. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: EdgeModuleProvisioningToken(**kwargs) +variables: +- description: 'The expiration date of the registration token. The Azure Video Analyzer + + IoT edge module must be initialized and connected to the Internet prior to the + token expiration + + date.' + name: expiration_date + types: + - +- description: 'The token blob to be provided to the Azure Video Analyzer IoT edge + module through + + the Azure IoT Edge module twin properties.' + name: token + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderCustomPreset.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderCustomPreset.yml new file mode 100644 index 00000000..c5d4135b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderCustomPreset.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.EncoderCustomPreset +name: EncoderCustomPreset +fullName: azure.mgmt.videoanalyzer.models.EncoderCustomPreset +module: azure.mgmt.videoanalyzer.models +summary: 'Describes a custom preset for encoding the input content using the encoder + processor. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EncoderCustomPreset(*, audio_encoder: AudioEncoderBase | None = None, video_encoder: + VideoEncoderBase | None = None, **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: audio_encoder + description: Describes a custom preset for encoding audio. + isRequired: true + types: + - + - name: video_encoder + description: Describes a custom preset for encoding video. + isRequired: true + types: + - + keywordOnlyParameters: + - name: audio_encoder + isRequired: true + - name: video_encoder + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderPresetBase.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderPresetBase.yml new file mode 100644 index 00000000..6e6d5ac0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderPresetBase.yml @@ -0,0 +1,24 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.EncoderPresetBase +name: EncoderPresetBase +fullName: azure.mgmt.videoanalyzer.models.EncoderPresetBase +module: azure.mgmt.videoanalyzer.models +summary: 'Base type for all encoder presets, which define the recipe or instructions + on how the input content should be processed. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: EncoderCustomPreset, EncoderSystemPreset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: EncoderPresetBase(**kwargs) + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderProcessor.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderProcessor.yml new file mode 100644 index 00000000..81762e94 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderProcessor.yml @@ -0,0 +1,48 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.EncoderProcessor +name: EncoderProcessor +fullName: azure.mgmt.videoanalyzer.models.EncoderProcessor +module: azure.mgmt.videoanalyzer.models +summary: 'Encoder processor allows for encoding of the input content. For example, + it can used to change the resolution from 4K to 1280x720. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EncoderProcessor(*, name: str, inputs: List[NodeInput], preset: EncoderPresetBase, + **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: name + description: Required. Node name. Must be unique within the topology. + isRequired: true + types: + - + - name: inputs + description: 'Required. An array of upstream node references within the topology + to be used as + + inputs for this node.' + isRequired: true + types: + - [] + - name: preset + description: 'Required. The encoder preset, which defines the recipe or instructions + on how + + the input content should be processed.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: inputs + isRequired: true + - name: preset + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderSystemPreset.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderSystemPreset.yml new file mode 100644 index 00000000..d18f83d4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderSystemPreset.yml @@ -0,0 +1,33 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.EncoderSystemPreset +name: EncoderSystemPreset +fullName: azure.mgmt.videoanalyzer.models.EncoderSystemPreset +module: azure.mgmt.videoanalyzer.models +summary: 'Describes a built-in preset for encoding the input content using the encoder + processor. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EncoderSystemPreset(*, name: str | EncoderSystemPresetType, **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: name + description: 'Required. Name of the built-in encoding preset. Possible values + include: + + "SingleLayer_540p_H264_AAC", "SingleLayer_720p_H264_AAC", "SingleLayer_1080p_H264_AAC", + + "SingleLayer_2160p_H264_AAC".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: name + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderSystemPresetType.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderSystemPresetType.yml new file mode 100644 index 00000000..bfa0c442 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderSystemPresetType.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.EncoderSystemPresetType +name: EncoderSystemPresetType +fullName: azure.mgmt.videoanalyzer.models.EncoderSystemPresetType +summary: Name of the built-in encoding preset. +module: azure.mgmt.videoanalyzer.models +fields: +- name: SINGLE_LAYER1080_P_H264_AAC + uid: azure.mgmt.videoanalyzer.models.EncoderSystemPresetType.SINGLE_LAYER1080_P_H264_AAC +- name: SINGLE_LAYER2160_P_H264_AAC + uid: azure.mgmt.videoanalyzer.models.EncoderSystemPresetType.SINGLE_LAYER2160_P_H264_AAC +- name: SINGLE_LAYER540_P_H264_AAC + uid: azure.mgmt.videoanalyzer.models.EncoderSystemPresetType.SINGLE_LAYER540_P_H264_AAC +- name: SINGLE_LAYER720_P_H264_AAC + uid: azure.mgmt.videoanalyzer.models.EncoderSystemPresetType.SINGLE_LAYER720_P_H264_AAC diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Endpoint.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Endpoint.yml new file mode 100644 index 00000000..b9e33a84 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Endpoint.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.Endpoint +name: Endpoint +fullName: azure.mgmt.videoanalyzer.models.Endpoint +module: azure.mgmt.videoanalyzer.models +summary: 'The endpoint details. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Endpoint(*, type: str | VideoAnalyzerEndpointType, endpoint_url: str | + None = None, **kwargs)' + parameters: + - name: endpoint_url + description: The URL of the endpoint. + isRequired: true + types: + - + - name: type + description: 'Required. The type of the endpoint. Possible values include: "ClientApi".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: type + isRequired: true + - name: endpoint_url + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EndpointBase.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EndpointBase.yml new file mode 100644 index 00000000..8dec43c0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EndpointBase.yml @@ -0,0 +1,50 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.EndpointBase +name: EndpointBase +fullName: azure.mgmt.videoanalyzer.models.EndpointBase +module: azure.mgmt.videoanalyzer.models +summary: 'Base class for endpoints. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: TlsEndpoint, UnsecuredEndpoint. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EndpointBase(*, credentials: CredentialsBase, url: str, tunnel: TunnelBase + | None = None, **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: credentials + description: Required. Credentials to be presented to the endpoint. + isRequired: true + types: + - + - name: url + description: Required. The endpoint URL for Video Analyzer to connect to. + isRequired: true + types: + - + - name: tunnel + description: 'Describes the tunnel through which Video Analyzer can connect to + the endpoint + + URL. This is an optional property, typically used when the endpoint is behind + a firewall.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: credentials + isRequired: true + - name: url + isRequired: true + - name: tunnel + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ErrorAdditionalInfo.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ErrorAdditionalInfo.yml new file mode 100644 index 00000000..efc37b52 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ErrorAdditionalInfo.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.ErrorAdditionalInfo +name: ErrorAdditionalInfo +fullName: azure.mgmt.videoanalyzer.models.ErrorAdditionalInfo +module: azure.mgmt.videoanalyzer.models +summary: 'The resource management error additional info. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: ErrorAdditionalInfo(**kwargs) +variables: +- description: The additional info type. + name: type + types: + - +- description: The additional info. + name: info + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ErrorDetail.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ErrorDetail.yml new file mode 100644 index 00000000..a25fb29c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ErrorDetail.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.ErrorDetail +name: ErrorDetail +fullName: azure.mgmt.videoanalyzer.models.ErrorDetail +module: azure.mgmt.videoanalyzer.models +summary: 'The error detail. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: ErrorDetail(**kwargs) +variables: +- description: The error code. + name: code + types: + - +- description: The error message. + name: message + types: + - +- description: The error target. + name: target + types: + - +- description: The error details. + name: details + types: + - [] +- description: The error additional info. + name: additional_info + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ErrorResponse.yml new file mode 100644 index 00000000..8f86de4a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ErrorResponse.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.ErrorResponse +name: ErrorResponse +fullName: azure.mgmt.videoanalyzer.models.ErrorResponse +module: azure.mgmt.videoanalyzer.models +summary: Common error response for all Azure Resource Manager APIs to return error + details for failed operations. (This also follows the OData error response format.). +constructor: + syntax: 'ErrorResponse(*, error: ErrorDetail | None = None, **kwargs)' + parameters: + - name: error + description: The error object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: error + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.GroupLevelAccessControl.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.GroupLevelAccessControl.yml new file mode 100644 index 00000000..8138f91f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.GroupLevelAccessControl.yml @@ -0,0 +1,22 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.GroupLevelAccessControl +name: GroupLevelAccessControl +fullName: azure.mgmt.videoanalyzer.models.GroupLevelAccessControl +module: azure.mgmt.videoanalyzer.models +summary: Group level network access control. +constructor: + syntax: 'GroupLevelAccessControl(*, public_network_access: str | PublicNetworkAccess + | None = None, **kwargs)' + parameters: + - name: public_network_access + description: 'Whether or not public network access is allowed for specified + + resources under the Video Analyzer account. Possible values include: "Enabled", + "Disabled".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: public_network_access + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.IotHub.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.IotHub.yml new file mode 100644 index 00000000..4c2725ca --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.IotHub.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.IotHub +name: IotHub +fullName: azure.mgmt.videoanalyzer.models.IotHub +module: azure.mgmt.videoanalyzer.models +summary: 'The IoT Hub details. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'IotHub(*, id: str, identity: ResourceIdentity, **kwargs)' + parameters: + - name: id + description: Required. The IoT Hub resource identifier. + isRequired: true + types: + - + - name: identity + description: Required. The IoT Hub identity. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: identity + isRequired: true +variables: +- description: The current status of the Iot Hub mapping. + name: status + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.JwtAuthentication.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.JwtAuthentication.yml new file mode 100644 index 00000000..31a2bbc9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.JwtAuthentication.yml @@ -0,0 +1,64 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.JwtAuthentication +name: JwtAuthentication +fullName: azure.mgmt.videoanalyzer.models.JwtAuthentication +module: azure.mgmt.videoanalyzer.models +summary: 'Properties for access validation based on JSON Web Tokens (JWT). + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'JwtAuthentication(*, issuers: List[str] | None = None, audiences: List[str] + | None = None, claims: List[TokenClaim] | None = None, keys: List[TokenKey] | + None = None, **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: issuers + description: 'List of expected token issuers. Token issuer is valid if it matches + at least + + one of the given values.' + isRequired: true + types: + - [] + - name: audiences + description: 'List of expected token audiences. Token audience is valid if it + matches at + + least one of the given values.' + isRequired: true + types: + - [] + - name: claims + description: 'List of additional token claims to be validated. Token must contains + all claims + + and respective values for it to be valid.' + isRequired: true + types: + - [] + - name: keys + description: 'List of keys which can be used to validate access tokens. Having + multiple keys + + allow for seamless key rotation of the token signing key. Token signature must + match exactly + + one key.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: issuers + isRequired: true + - name: audiences + isRequired: true + - name: claims + isRequired: true + - name: keys + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.KeyVaultProperties.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.KeyVaultProperties.yml new file mode 100644 index 00000000..e82fd6e3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.KeyVaultProperties.yml @@ -0,0 +1,36 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.KeyVaultProperties +name: KeyVaultProperties +fullName: azure.mgmt.videoanalyzer.models.KeyVaultProperties +module: azure.mgmt.videoanalyzer.models +summary: 'The details for accessing the encryption keys in Key Vault. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'KeyVaultProperties(*, key_identifier: str, **kwargs)' + parameters: + - name: key_identifier + description: 'Required. The URL of the Key Vault key used to encrypt the account. + The + + key may either be versioned (for example [https://vault/keys/mykey/version1](https://vault/keys/mykey/version1)) + or reference a key + + without a version (for example [https://vault/keys/mykey](https://vault/keys/mykey)).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: key_identifier + isRequired: true +variables: +- description: 'The current key used to encrypt Video Analyzer account, including + + the key version.' + name: current_key_identifier + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Kind.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Kind.yml new file mode 100644 index 00000000..9f6fe525 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Kind.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.Kind +name: Kind +fullName: azure.mgmt.videoanalyzer.models.Kind +summary: Topology kind. +module: azure.mgmt.videoanalyzer.models +fields: +- name: BATCH + uid: azure.mgmt.videoanalyzer.models.Kind.BATCH +- name: LIVE + uid: azure.mgmt.videoanalyzer.models.Kind.LIVE diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ListProvisioningTokenInput.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ListProvisioningTokenInput.yml new file mode 100644 index 00000000..3bb6bf6b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ListProvisioningTokenInput.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.ListProvisioningTokenInput +name: ListProvisioningTokenInput +fullName: azure.mgmt.videoanalyzer.models.ListProvisioningTokenInput +module: azure.mgmt.videoanalyzer.models +summary: 'The input parameters to generate registration token for the Azure Video + Analyzer IoT edge module. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ListProvisioningTokenInput(*, expiration_date: datetime, **kwargs)' + parameters: + - name: expiration_date + description: 'Required. The desired expiration date of the registration token. + The + + Azure Video Analyzer IoT edge module must be initialized and connected to the + Internet prior to + + the token expiration date.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: expiration_date + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipeline.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipeline.yml new file mode 100644 index 00000000..70585783 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipeline.yml @@ -0,0 +1,105 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.LivePipeline +name: LivePipeline +fullName: azure.mgmt.videoanalyzer.models.LivePipeline +module: azure.mgmt.videoanalyzer.models +summary: 'Live pipeline represents a unique instance of a live topology, used for + real-time ingestion, archiving and publishing of content for a unique RTSP camera. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'LivePipeline(*, topology_name: str | None = None, description: str | None + = None, bitrate_kbps: int | None = None, parameters: List[ParameterDefinition] + | None = None, **kwargs)' + parameters: + - name: topology_name + description: 'The reference to an existing pipeline topology defined for real-time + + content processing. When activated, this live pipeline will process content + according to the + + pipeline topology definition.' + isRequired: true + types: + - + - name: description + description: An optional description for the pipeline. + isRequired: true + types: + - + - name: bitrate_kbps + description: 'Maximum bitrate capacity in Kbps reserved for the live pipeline. + The + + allowed range is from 500 to 3000 Kbps in increments of 100 Kbps. If the RTSP + camera exceeds + + this capacity, then the service will disconnect temporarily from the camera. + It will retry to + + re-establish connection (with exponential backoff), checking to see if the camera + bitrate is + + now below the reserved capacity. Doing so will ensure that one ''noisy neighbor'' + does not affect + + other live pipelines in your account.' + isRequired: true + types: + - + - name: parameters + description: 'List of the instance level parameter values for the user-defined + topology + + parameters. A pipeline can only define or override parameters values for parameters + which have + + been declared in the referenced topology. Topology parameters without a default + value must be + + defined. Topology parameters with a default value can be optionally be overridden.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: topology_name + isRequired: true + - name: description + isRequired: true + - name: bitrate_kbps + isRequired: true + - name: parameters + isRequired: true +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: 'Current state of the pipeline (read-only). Possible values include: + "Inactive", + + "Activating", "Active", "Deactivating".' + name: state + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineCollection.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineCollection.yml new file mode 100644 index 00000000..7e86252c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineCollection.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.LivePipelineCollection +name: LivePipelineCollection +fullName: azure.mgmt.videoanalyzer.models.LivePipelineCollection +module: azure.mgmt.videoanalyzer.models +summary: A collection of LivePipeline items. +constructor: + syntax: 'LivePipelineCollection(*, value: List[LivePipeline] | None = None, next_link: + str | None = None, **kwargs)' + parameters: + - name: value + description: A collection of LivePipeline items. + isRequired: true + types: + - [] + - name: next_link + description: 'A link to the next page of the collection (when the collection contains + too + + many results to return in one response).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: next_link + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineOperationStatus.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineOperationStatus.yml new file mode 100644 index 00000000..eb1b42e1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineOperationStatus.yml @@ -0,0 +1,24 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.LivePipelineOperationStatus +name: LivePipelineOperationStatus +fullName: azure.mgmt.videoanalyzer.models.LivePipelineOperationStatus +module: azure.mgmt.videoanalyzer.models +summary: 'Used for tracking the status of an operation on the live pipeline. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: LivePipelineOperationStatus(**kwargs) +variables: +- description: The name of the live pipeline operation. + name: name + types: + - +- description: The status of the live pipeline operation. + name: status + types: + - +- description: The error details for the live pipeline operation. + name: error + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineState.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineState.yml new file mode 100644 index 00000000..b219fac1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineState.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.LivePipelineState +name: LivePipelineState +fullName: azure.mgmt.videoanalyzer.models.LivePipelineState +summary: Current state of the pipeline (read-only). +module: azure.mgmt.videoanalyzer.models +fields: +- name: ACTIVATING + uid: azure.mgmt.videoanalyzer.models.LivePipelineState.ACTIVATING +- name: ACTIVE + uid: azure.mgmt.videoanalyzer.models.LivePipelineState.ACTIVE +- name: DEACTIVATING + uid: azure.mgmt.videoanalyzer.models.LivePipelineState.DEACTIVATING +- name: INACTIVE + uid: azure.mgmt.videoanalyzer.models.LivePipelineState.INACTIVE diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineUpdate.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineUpdate.yml new file mode 100644 index 00000000..efe1e32e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineUpdate.yml @@ -0,0 +1,105 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.LivePipelineUpdate +name: LivePipelineUpdate +fullName: azure.mgmt.videoanalyzer.models.LivePipelineUpdate +module: azure.mgmt.videoanalyzer.models +summary: 'Live pipeline represents a unique instance of a live topology, used for + real-time ingestion, archiving and publishing of content for a unique RTSP camera. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'LivePipelineUpdate(*, topology_name: str | None = None, description: str + | None = None, bitrate_kbps: int | None = None, parameters: List[ParameterDefinition] + | None = None, **kwargs)' + parameters: + - name: topology_name + description: 'The reference to an existing pipeline topology defined for real-time + + content processing. When activated, this live pipeline will process content + according to the + + pipeline topology definition.' + isRequired: true + types: + - + - name: description + description: An optional description for the pipeline. + isRequired: true + types: + - + - name: bitrate_kbps + description: 'Maximum bitrate capacity in Kbps reserved for the live pipeline. + The + + allowed range is from 500 to 3000 Kbps in increments of 100 Kbps. If the RTSP + camera exceeds + + this capacity, then the service will disconnect temporarily from the camera. + It will retry to + + re-establish connection (with exponential backoff), checking to see if the camera + bitrate is + + now below the reserved capacity. Doing so will ensure that one ''noisy neighbor'' + does not affect + + other live pipelines in your account.' + isRequired: true + types: + - + - name: parameters + description: 'List of the instance level parameter values for the user-defined + topology + + parameters. A pipeline can only define or override parameters values for parameters + which have + + been declared in the referenced topology. Topology parameters without a default + value must be + + defined. Topology parameters with a default value can be optionally be overridden.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: topology_name + isRequired: true + - name: description + isRequired: true + - name: bitrate_kbps + isRequired: true + - name: parameters + isRequired: true +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: 'Current state of the pipeline (read-only). Possible values include: + "Inactive", + + "Activating", "Active", "Deactivating".' + name: state + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LogSpecification.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LogSpecification.yml new file mode 100644 index 00000000..47bae1b0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LogSpecification.yml @@ -0,0 +1,24 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.LogSpecification +name: LogSpecification +fullName: azure.mgmt.videoanalyzer.models.LogSpecification +module: azure.mgmt.videoanalyzer.models +summary: 'A diagnostic log emitted by service. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: LogSpecification(**kwargs) +variables: +- description: The diagnostic log category name. + name: name + types: + - +- description: The diagnostic log category display name. + name: display_name + types: + - +- description: The time range for requests in each blob. + name: blob_duration + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.MetricAggregationType.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.MetricAggregationType.yml new file mode 100644 index 00000000..27213dca --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.MetricAggregationType.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.MetricAggregationType +name: MetricAggregationType +fullName: azure.mgmt.videoanalyzer.models.MetricAggregationType +summary: The metric aggregation type +module: azure.mgmt.videoanalyzer.models +fields: +- name: AVERAGE + uid: azure.mgmt.videoanalyzer.models.MetricAggregationType.AVERAGE +- name: COUNT + uid: azure.mgmt.videoanalyzer.models.MetricAggregationType.COUNT +- name: TOTAL + uid: azure.mgmt.videoanalyzer.models.MetricAggregationType.TOTAL diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.MetricDimension.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.MetricDimension.yml new file mode 100644 index 00000000..91737e44 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.MetricDimension.yml @@ -0,0 +1,24 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.MetricDimension +name: MetricDimension +fullName: azure.mgmt.videoanalyzer.models.MetricDimension +module: azure.mgmt.videoanalyzer.models +summary: 'A metric dimension. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: MetricDimension(**kwargs) +variables: +- description: The metric dimension name. + name: name + types: + - +- description: The display name for the dimension. + name: display_name + types: + - +- description: Whether to export metric to shoebox. + name: to_be_exported_for_shoebox + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.MetricSpecification.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.MetricSpecification.yml new file mode 100644 index 00000000..c30cb745 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.MetricSpecification.yml @@ -0,0 +1,73 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.MetricSpecification +name: MetricSpecification +fullName: azure.mgmt.videoanalyzer.models.MetricSpecification +module: azure.mgmt.videoanalyzer.models +summary: 'A metric emitted by service. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'MetricSpecification(*, supported_aggregation_types: List[str] | None = + None, **kwargs)' + parameters: + - name: supported_aggregation_types + description: Supported aggregation types. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: supported_aggregation_types + isRequired: true +variables: +- description: The metric name. + name: name + types: + - +- description: The metric display name. + name: display_name + types: + - +- description: The metric display description. + name: display_description + types: + - +- description: 'The metric unit. Possible values include: "Bytes", "Count", "Milliseconds".' + name: unit + types: + - + - +- description: 'The metric aggregation type. Possible values include: "Average", + + "Count", "Total".' + name: aggregation_type + types: + - + - +- description: 'The metric lock aggregation type. Possible values include: + + "Average", "Count", "Total".' + name: lock_aggregation_type + types: + - + - +- description: The metric dimensions. + name: dimensions + types: + - [] +- description: Indicates whether regional MDM account is enabled. + name: enable_regional_mdm_account + types: + - +- description: The source MDM account. + name: source_mdm_account + types: + - +- description: The source MDM namespace. + name: source_mdm_namespace + types: + - +- description: The supported time grain types. + name: supported_time_grain_types + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.MetricUnit.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.MetricUnit.yml new file mode 100644 index 00000000..c6d1c892 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.MetricUnit.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.MetricUnit +name: MetricUnit +fullName: azure.mgmt.videoanalyzer.models.MetricUnit +summary: The metric unit +module: azure.mgmt.videoanalyzer.models +fields: +- name: BYTES + uid: azure.mgmt.videoanalyzer.models.MetricUnit.BYTES +- name: COUNT + uid: azure.mgmt.videoanalyzer.models.MetricUnit.COUNT +- name: MILLISECONDS + uid: azure.mgmt.videoanalyzer.models.MetricUnit.MILLISECONDS diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.NetworkAccessControl.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.NetworkAccessControl.yml new file mode 100644 index 00000000..39502130 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.NetworkAccessControl.yml @@ -0,0 +1,33 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.NetworkAccessControl +name: NetworkAccessControl +fullName: azure.mgmt.videoanalyzer.models.NetworkAccessControl +module: azure.mgmt.videoanalyzer.models +summary: Network access control for video analyzer account. +constructor: + syntax: 'NetworkAccessControl(*, integration: GroupLevelAccessControl | None = None, + ingestion: GroupLevelAccessControl | None = None, consumption: GroupLevelAccessControl + | None = None, **kwargs)' + parameters: + - name: integration + description: Public network access for integration group. + isRequired: true + types: + - + - name: ingestion + description: Public network access for ingestion group. + isRequired: true + types: + - + - name: consumption + description: Public network access for consumption group. + isRequired: true + types: + - + keywordOnlyParameters: + - name: integration + isRequired: true + - name: ingestion + isRequired: true + - name: consumption + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.NodeBase.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.NodeBase.yml new file mode 100644 index 00000000..44acf659 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.NodeBase.yml @@ -0,0 +1,31 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.NodeBase +name: NodeBase +fullName: azure.mgmt.videoanalyzer.models.NodeBase +module: azure.mgmt.videoanalyzer.models +summary: 'Base class for nodes. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: ProcessorNodeBase, SinkNodeBase, SourceNodeBase. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'NodeBase(*, name: str, **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: name + description: Required. Node name. Must be unique within the topology. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.NodeInput.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.NodeInput.yml new file mode 100644 index 00000000..ad1c9fb4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.NodeInput.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.NodeInput +name: NodeInput +fullName: azure.mgmt.videoanalyzer.models.NodeInput +module: azure.mgmt.videoanalyzer.models +summary: 'Describes an input signal to be used on a pipeline node. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'NodeInput(*, node_name: str, **kwargs)' + parameters: + - name: node_name + description: 'Required. The name of the upstream node in the pipeline which output + is used + + as input of the current node.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: node_name + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Operation.yml new file mode 100644 index 00000000..a01a7fe7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Operation.yml @@ -0,0 +1,58 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.Operation +name: Operation +fullName: azure.mgmt.videoanalyzer.models.Operation +module: azure.mgmt.videoanalyzer.models +summary: 'An operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Operation(*, name: str, display: OperationDisplay | None = None, origin: + str | None = None, properties: Properties | None = None, is_data_action: bool + | None = None, action_type: str | ActionType | None = None, **kwargs)' + parameters: + - name: name + description: Required. The operation name. + isRequired: true + types: + - + - name: display + description: The operation display name. + isRequired: true + types: + - + - name: origin + description: Origin of the operation. + isRequired: true + types: + - + - name: properties + description: Operation properties format. + isRequired: true + types: + - + - name: is_data_action + description: Whether the operation applies to data-plane. + isRequired: true + types: + - + - name: action_type + description: 'Indicates the action type. Possible values include: "Internal".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: display + isRequired: true + - name: origin + isRequired: true + - name: properties + isRequired: true + - name: is_data_action + isRequired: true + - name: action_type + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.OperationCollection.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.OperationCollection.yml new file mode 100644 index 00000000..9373f6d7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.OperationCollection.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.OperationCollection +name: OperationCollection +fullName: azure.mgmt.videoanalyzer.models.OperationCollection +module: azure.mgmt.videoanalyzer.models +summary: A collection of Operation items. +constructor: + syntax: 'OperationCollection(*, value: List[Operation] | None = None, **kwargs)' + parameters: + - name: value + description: A collection of Operation items. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: value + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.OperationDisplay.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.OperationDisplay.yml new file mode 100644 index 00000000..f916625a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.OperationDisplay.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.OperationDisplay +name: OperationDisplay +fullName: azure.mgmt.videoanalyzer.models.OperationDisplay +module: azure.mgmt.videoanalyzer.models +summary: Operation details. +constructor: + syntax: 'OperationDisplay(*, provider: str | None = None, resource: str | None = + None, operation: str | None = None, description: str | None = None, **kwargs)' + parameters: + - name: provider + description: The service provider. + isRequired: true + types: + - + - name: resource + description: Resource on which the operation is performed. + isRequired: true + types: + - + - name: operation + description: The operation type. + isRequired: true + types: + - + - name: description + description: The operation description. + isRequired: true + types: + - + keywordOnlyParameters: + - name: provider + isRequired: true + - name: resource + isRequired: true + - name: operation + isRequired: true + - name: description + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ParameterDeclaration.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ParameterDeclaration.yml new file mode 100644 index 00000000..12d223ef --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ParameterDeclaration.yml @@ -0,0 +1,50 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.ParameterDeclaration +name: ParameterDeclaration +fullName: azure.mgmt.videoanalyzer.models.ParameterDeclaration +module: azure.mgmt.videoanalyzer.models +summary: 'Single topology parameter declaration. Declared parameters can and must + be referenced throughout the topology and can optionally have default values to + be used when they are not defined in the pipelines. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ParameterDeclaration(*, name: str, type: str | ParameterType, description: + str | None = None, default: str | None = None, **kwargs)' + parameters: + - name: name + description: Required. Name of the parameter. + isRequired: true + types: + - + - name: type + description: 'Required. Type of the parameter. Possible values include: "String", + + "SecretString", "Int", "Double", "Bool".' + isRequired: true + types: + - + - + - name: description + description: Description of the parameter. + isRequired: true + types: + - + - name: default + description: 'The default value for the parameter to be used if the pipeline does + not specify + + a value.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: type + isRequired: true + - name: description + isRequired: true + - name: default + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ParameterDefinition.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ParameterDefinition.yml new file mode 100644 index 00000000..4efa6b06 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ParameterDefinition.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.ParameterDefinition +name: ParameterDefinition +fullName: azure.mgmt.videoanalyzer.models.ParameterDefinition +module: azure.mgmt.videoanalyzer.models +summary: 'Defines the parameter value of an specific pipeline topology parameter. + See pipeline topology parameters for more information. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ParameterDefinition(*, name: str, value: str | None = None, **kwargs)' + parameters: + - name: name + description: Required. Name of the parameter declared in the pipeline topology. + isRequired: true + types: + - + - name: value + description: Parameter value to be applied on this specific pipeline. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: value + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ParameterType.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ParameterType.yml new file mode 100644 index 00000000..7f73cb1c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ParameterType.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.ParameterType +name: ParameterType +fullName: azure.mgmt.videoanalyzer.models.ParameterType +summary: Type of the parameter. +module: azure.mgmt.videoanalyzer.models +fields: +- name: BOOL + uid: azure.mgmt.videoanalyzer.models.ParameterType.BOOL +- name: DOUBLE + uid: azure.mgmt.videoanalyzer.models.ParameterType.DOUBLE +- name: INT + uid: azure.mgmt.videoanalyzer.models.ParameterType.INT +- name: SECRET_STRING + uid: azure.mgmt.videoanalyzer.models.ParameterType.SECRET_STRING +- name: STRING + uid: azure.mgmt.videoanalyzer.models.ParameterType.STRING diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PemCertificateList.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PemCertificateList.yml new file mode 100644 index 00000000..67711d3d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PemCertificateList.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.PemCertificateList +name: PemCertificateList +fullName: azure.mgmt.videoanalyzer.models.PemCertificateList +module: azure.mgmt.videoanalyzer.models +summary: 'A list of PEM formatted certificates. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PemCertificateList(*, certificates: List[str], **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: certificates + description: Required. PEM formatted public certificates. One certificate per + entry. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: certificates + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJob.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJob.yml new file mode 100644 index 00000000..74b87b94 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJob.yml @@ -0,0 +1,91 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.PipelineJob +name: PipelineJob +fullName: azure.mgmt.videoanalyzer.models.PipelineJob +module: azure.mgmt.videoanalyzer.models +summary: 'Pipeline job represents a unique instance of a batch topology, used for + offline processing of selected portions of archived content. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'PipelineJob(*, topology_name: str | None = None, description: str | None + = None, parameters: List[ParameterDefinition] | None = None, **kwargs)' + parameters: + - name: topology_name + description: 'Reference to an existing pipeline topology. When activated, this + pipeline + + job will process content according to the pipeline topology definition.' + isRequired: true + types: + - + - name: description + description: An optional description for the pipeline. + isRequired: true + types: + - + - name: parameters + description: 'List of the instance level parameter values for the user-defined + topology + + parameters. A pipeline can only define or override parameters values for parameters + which have + + been declared in the referenced topology. Topology parameters without a default + value must be + + defined. Topology parameters with a default value can be optionally be overridden.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: topology_name + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: 'Current state of the pipeline (read-only). Possible values include: + "Processing", + + "Canceled", "Completed", "Failed".' + name: state + types: + - + - +- description: 'The date-time by when this pipeline job will be automatically deleted + from + + your account.' + name: expiration + types: + - +- description: Details about the error, in case the pipeline job fails. + name: error + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobCollection.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobCollection.yml new file mode 100644 index 00000000..ff7ca1f9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobCollection.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.PipelineJobCollection +name: PipelineJobCollection +fullName: azure.mgmt.videoanalyzer.models.PipelineJobCollection +module: azure.mgmt.videoanalyzer.models +summary: A collection of PipelineJob items. +constructor: + syntax: 'PipelineJobCollection(*, value: List[PipelineJob] | None = None, next_link: + str | None = None, **kwargs)' + parameters: + - name: value + description: A collection of PipelineJob items. + isRequired: true + types: + - [] + - name: next_link + description: 'A link to the next page of the collection (when the collection contains + too + + many results to return in one response).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: next_link + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobError.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobError.yml new file mode 100644 index 00000000..46af0165 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobError.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.PipelineJobError +name: PipelineJobError +fullName: azure.mgmt.videoanalyzer.models.PipelineJobError +module: azure.mgmt.videoanalyzer.models +summary: Details about the error for a failed pipeline job. +constructor: + syntax: 'PipelineJobError(*, code: str | None = None, message: str | None = None, + **kwargs)' + parameters: + - name: code + description: The error code. + isRequired: true + types: + - + - name: message + description: The error message. + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobOperationStatus.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobOperationStatus.yml new file mode 100644 index 00000000..bafdc32c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobOperationStatus.yml @@ -0,0 +1,24 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.PipelineJobOperationStatus +name: PipelineJobOperationStatus +fullName: azure.mgmt.videoanalyzer.models.PipelineJobOperationStatus +module: azure.mgmt.videoanalyzer.models +summary: 'Used for tracking the status of an operation on the pipeline job. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: PipelineJobOperationStatus(**kwargs) +variables: +- description: The name of the pipeline job operation. + name: name + types: + - +- description: The status of the pipeline job operation. + name: status + types: + - +- description: The error details for the pipeline job operation. + name: error + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobState.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobState.yml new file mode 100644 index 00000000..424d67b1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobState.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.PipelineJobState +name: PipelineJobState +fullName: azure.mgmt.videoanalyzer.models.PipelineJobState +summary: Current state of the pipeline (read-only). +module: azure.mgmt.videoanalyzer.models +fields: +- name: CANCELED + uid: azure.mgmt.videoanalyzer.models.PipelineJobState.CANCELED +- name: COMPLETED + uid: azure.mgmt.videoanalyzer.models.PipelineJobState.COMPLETED +- name: FAILED + uid: azure.mgmt.videoanalyzer.models.PipelineJobState.FAILED +- name: PROCESSING + uid: azure.mgmt.videoanalyzer.models.PipelineJobState.PROCESSING diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobUpdate.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobUpdate.yml new file mode 100644 index 00000000..c9f9816d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobUpdate.yml @@ -0,0 +1,91 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.PipelineJobUpdate +name: PipelineJobUpdate +fullName: azure.mgmt.videoanalyzer.models.PipelineJobUpdate +module: azure.mgmt.videoanalyzer.models +summary: 'Pipeline job represents a unique instance of a batch topology, used for + offline processing of selected portions of archived content. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'PipelineJobUpdate(*, topology_name: str | None = None, description: str + | None = None, parameters: List[ParameterDefinition] | None = None, **kwargs)' + parameters: + - name: topology_name + description: 'Reference to an existing pipeline topology. When activated, this + pipeline + + job will process content according to the pipeline topology definition.' + isRequired: true + types: + - + - name: description + description: An optional description for the pipeline. + isRequired: true + types: + - + - name: parameters + description: 'List of the instance level parameter values for the user-defined + topology + + parameters. A pipeline can only define or override parameters values for parameters + which have + + been declared in the referenced topology. Topology parameters without a default + value must be + + defined. Topology parameters with a default value can be optionally be overridden.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: topology_name + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: 'Current state of the pipeline (read-only). Possible values include: + "Processing", + + "Canceled", "Completed", "Failed".' + name: state + types: + - + - +- description: 'The date-time by when this pipeline job will be automatically deleted + from + + your account.' + name: expiration + types: + - +- description: Details about the error, in case the pipeline job fails. + name: error + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopology.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopology.yml new file mode 100644 index 00000000..848ce927 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopology.yml @@ -0,0 +1,69 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.PipelineTopology +name: PipelineTopology +fullName: azure.mgmt.videoanalyzer.models.PipelineTopology +module: azure.mgmt.videoanalyzer.models +summary: "Pipeline topology describes the processing steps to be applied when processing\ + \ content for a particular outcome. The topology should be defined according to\ + \ the scenario to be achieved and can be reused across many pipeline instances which\ + \ share the same processing characteristics. For instance, a pipeline topology which\ + \ captures content from a RTSP camera and archives the content can be reused across\ + \ many different cameras, as long as the same processing is to be applied across\ + \ all the cameras. Individual instance properties can be defined through the use\ + \ of user-defined parameters, which allow for a topology to be parameterized. This\ + \ allows individual pipelines refer to different values, such as individual cameras'\ + \ RTSP endpoints and credentials. Overall a topology is composed of the following:\n\ + \n* Parameters: list of user defined parameters that can be references across the\ + \ topology nodes. \n\n* Sources: list of one or more data sources nodes such as\ + \ an RTSP source which allows for content to be ingested from cameras. \n\n* Processors:\ + \ list of nodes which perform data analysis or transformations. \n\n* Sinks: list\ + \ of one or more data sinks which allow for data to be stored or exported to other\ + \ destinations. \n\n Variables are only populated by the server, and will be\ + \ ignored when sending a request.\n\n All required parameters must be populated\ + \ in order to send to Azure.\n\n ivar id:\n Fully qualified resource\ + \ ID for the resource. Ex -\n /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\n\ + \n vartype id:\n str\n\n ivar name:\n The name of the resource.\n\ + \n vartype name:\n str\n\n ivar type:\n The type of the resource.\ + \ E.g. \"Microsoft.Compute/virtualMachines\" or\n \"Microsoft.Storage/storageAccounts\"\ + .\n\n vartype type:\n str\n\n ivar system_data:\n Azure Resource\ + \ Manager metadata containing createdBy and modifiedBy\n information.\n\n\ + \ vartype system_data:\n ~video_analyzer.models.SystemData\n\n param\ + \ kind:\n Required. Topology kind. Possible values include: \"Live\", \"\ + Batch\".\n\n type kind:\n str or ~video_analyzer.models.Kind\n\n \ + \ param sku:\n Required. Describes the properties of a SKU.\n\n type\ + \ sku:\n ~video_analyzer.models.Sku\n\n param description:\n An\ + \ optional description of the pipeline topology. It is recommended that\n \ + \ the expected use of the topology to be described here.\n\n type description:\n\ + \ str\n\n param parameters:\n List of the topology parameter declarations.\ + \ Parameters declared here can be\n referenced throughout the topology nodes\ + \ through the use of \"${PARAMETER_NAME}\" string pattern.\n Parameters can\ + \ have optional default values and can later be defined in individual instances\ + \ of\n the pipeline.\n\n type parameters:\n list[~video_analyzer.models.ParameterDeclaration]\n\ + \n param sources:\n List of the topology source nodes. Source nodes enable\ + \ external data to be\n ingested by the pipeline.\n\n type sources:\n\ + \ list[~video_analyzer.models.SourceNodeBase]\n\n param processors:\n\ + \ List of the topology processor nodes. Processor nodes enable pipeline data\n\ + \ to be analyzed, processed or transformed.\n\n type processors:\n \ + \ list[~video_analyzer.models.ProcessorNodeBase]\n\n param sinks:\n \ + \ List of the topology sink nodes. Sink nodes allow pipeline data to be stored\ + \ or\n exported.\n\n type sinks:\n list[~video_analyzer.models.SinkNodeBase]" +constructor: + syntax: 'PipelineTopology(*, kind: str | Kind, sku: Sku, description: str | None + = None, parameters: List[ParameterDeclaration] | None = None, sources: List[SourceNodeBase] + | None = None, processors: List[ProcessorNodeBase] | None = None, sinks: List[SinkNodeBase] + | None = None, **kwargs)' + keywordOnlyParameters: + - name: kind + isRequired: true + - name: sku + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: sources + isRequired: true + - name: processors + isRequired: true + - name: sinks + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopologyCollection.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopologyCollection.yml new file mode 100644 index 00000000..a2e5443a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopologyCollection.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.PipelineTopologyCollection +name: PipelineTopologyCollection +fullName: azure.mgmt.videoanalyzer.models.PipelineTopologyCollection +module: azure.mgmt.videoanalyzer.models +summary: A collection of PipelineTopology items. +constructor: + syntax: 'PipelineTopologyCollection(*, value: List[PipelineTopology] | None = None, + next_link: str | None = None, **kwargs)' + parameters: + - name: value + description: A collection of PipelineTopology items. + isRequired: true + types: + - [] + - name: next_link + description: 'A link to the next page of the collection (when the collection contains + too + + many results to return in one response).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: next_link + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopologyUpdate.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopologyUpdate.yml new file mode 100644 index 00000000..6ce8b132 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopologyUpdate.yml @@ -0,0 +1,67 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.PipelineTopologyUpdate +name: PipelineTopologyUpdate +fullName: azure.mgmt.videoanalyzer.models.PipelineTopologyUpdate +module: azure.mgmt.videoanalyzer.models +summary: "Pipeline topology describes the processing steps to be applied when processing\ + \ content for a particular outcome. The topology should be defined according to\ + \ the scenario to be achieved and can be reused across many pipeline instances which\ + \ share the same processing characteristics. For instance, a pipeline topology which\ + \ captures content from a RTSP camera and archives the content can be reused across\ + \ many different cameras, as long as the same processing is to be applied across\ + \ all the cameras. Individual instance properties can be defined through the use\ + \ of user-defined parameters, which allow for a topology to be parameterized. This\ + \ allows individual pipelines refer to different values, such as individual cameras'\ + \ RTSP endpoints and credentials. Overall a topology is composed of the following:\n\ + \n* Parameters: list of user defined parameters that can be references across the\ + \ topology nodes. \n\n* Sources: list of one or more data sources nodes such as\ + \ an RTSP source which allows for content to be ingested from cameras. \n\n* Processors:\ + \ list of nodes which perform data analysis or transformations. \n\n* Sinks: list\ + \ of one or more data sinks which allow for data to be stored or exported to other\ + \ destinations. \n\n Variables are only populated by the server, and will be\ + \ ignored when sending a request.\n\n ivar id:\n Fully qualified resource\ + \ ID for the resource. Ex -\n /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.\n\ + \n vartype id:\n str\n\n ivar name:\n The name of the resource.\n\ + \n vartype name:\n str\n\n ivar type:\n The type of the resource.\ + \ E.g. \"Microsoft.Compute/virtualMachines\" or\n \"Microsoft.Storage/storageAccounts\"\ + .\n\n vartype type:\n str\n\n ivar system_data:\n Azure Resource\ + \ Manager metadata containing createdBy and modifiedBy\n information.\n\n\ + \ vartype system_data:\n ~video_analyzer.models.SystemData\n\n param\ + \ kind:\n Topology kind. Possible values include: \"Live\", \"Batch\".\n\n\ + \ type kind:\n str or ~video_analyzer.models.Kind\n\n param sku:\n\ + \ Describes the properties of a SKU.\n\n type sku:\n ~video_analyzer.models.Sku\n\ + \n param description:\n An optional description of the pipeline topology.\ + \ It is recommended that\n the expected use of the topology to be described\ + \ here.\n\n type description:\n str\n\n param parameters:\n \ + \ List of the topology parameter declarations. Parameters declared here can be\n\ + \ referenced throughout the topology nodes through the use of \"${PARAMETER_NAME}\"\ + \ string pattern.\n Parameters can have optional default values and can later\ + \ be defined in individual instances of\n the pipeline.\n\n type parameters:\n\ + \ list[~video_analyzer.models.ParameterDeclaration]\n\n param sources:\n\ + \ List of the topology source nodes. Source nodes enable external data to\ + \ be\n ingested by the pipeline.\n\n type sources:\n list[~video_analyzer.models.SourceNodeBase]\n\ + \n param processors:\n List of the topology processor nodes. Processor\ + \ nodes enable pipeline data\n to be analyzed, processed or transformed.\n\ + \n type processors:\n list[~video_analyzer.models.ProcessorNodeBase]\n\ + \n param sinks:\n List of the topology sink nodes. Sink nodes allow pipeline\ + \ data to be stored or\n exported.\n\n type sinks:\n list[~video_analyzer.models.SinkNodeBase]" +constructor: + syntax: 'PipelineTopologyUpdate(*, kind: str | Kind | None = None, sku: Sku | None + = None, description: str | None = None, parameters: List[ParameterDeclaration] + | None = None, sources: List[SourceNodeBase] | None = None, processors: List[ProcessorNodeBase] + | None = None, sinks: List[SinkNodeBase] | None = None, **kwargs)' + keywordOnlyParameters: + - name: kind + isRequired: true + - name: sku + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: sources + isRequired: true + - name: processors + isRequired: true + - name: sinks + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpoint.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpoint.yml new file mode 100644 index 00000000..9d5b8d3e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpoint.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.PrivateEndpoint +name: PrivateEndpoint +fullName: azure.mgmt.videoanalyzer.models.PrivateEndpoint +module: azure.mgmt.videoanalyzer.models +summary: 'The Private Endpoint resource. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: PrivateEndpoint(**kwargs) +variables: +- description: The ARM identifier for Private Endpoint. + name: id + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointConnection.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointConnection.yml new file mode 100644 index 00000000..e47cba2b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointConnection.yml @@ -0,0 +1,62 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.PrivateEndpointConnection +name: PrivateEndpointConnection +fullName: azure.mgmt.videoanalyzer.models.PrivateEndpointConnection +module: azure.mgmt.videoanalyzer.models +summary: 'The Private Endpoint Connection resource. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'PrivateEndpointConnection(*, private_endpoint: PrivateEndpoint | None = + None, private_link_service_connection_state: PrivateLinkServiceConnectionState + | None = None, **kwargs)' + parameters: + - name: private_endpoint + description: The resource of private end point. + isRequired: true + types: + - + - name: private_link_service_connection_state + description: 'A collection of information about the state of + + the connection between service consumer and provider.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: private_endpoint + isRequired: true + - name: private_link_service_connection_state + isRequired: true +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: 'The provisioning state of the private endpoint connection resource. + + Possible values include: "Succeeded", "Creating", "Deleting", "Failed".' + name: provisioning_state + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionListResult.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionListResult.yml new file mode 100644 index 00000000..22d5f269 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionListResult.yml @@ -0,0 +1,19 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionListResult +name: PrivateEndpointConnectionListResult +fullName: azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionListResult +module: azure.mgmt.videoanalyzer.models +summary: List of private endpoint connection associated with the specified storage + account. +constructor: + syntax: 'PrivateEndpointConnectionListResult(*, value: List[PrivateEndpointConnection] + | None = None, **kwargs)' + parameters: + - name: value + description: Array of private endpoint connections. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: value + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionProvisioningState.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionProvisioningState.yml new file mode 100644 index 00000000..38af1794 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionProvisioningState.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionProvisioningState +name: PrivateEndpointConnectionProvisioningState +fullName: azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionProvisioningState +summary: The current provisioning state. +module: azure.mgmt.videoanalyzer.models +fields: +- name: CREATING + uid: azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionProvisioningState.CREATING +- name: DELETING + uid: azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionProvisioningState.DELETING +- name: FAILED + uid: azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionProvisioningState.FAILED +- name: SUCCEEDED + uid: azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionProvisioningState.SUCCEEDED diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointServiceConnectionStatus.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointServiceConnectionStatus.yml new file mode 100644 index 00000000..375eacd4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointServiceConnectionStatus.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.PrivateEndpointServiceConnectionStatus +name: PrivateEndpointServiceConnectionStatus +fullName: azure.mgmt.videoanalyzer.models.PrivateEndpointServiceConnectionStatus +summary: The private endpoint connection status. +module: azure.mgmt.videoanalyzer.models +fields: +- name: APPROVED + uid: azure.mgmt.videoanalyzer.models.PrivateEndpointServiceConnectionStatus.APPROVED +- name: PENDING + uid: azure.mgmt.videoanalyzer.models.PrivateEndpointServiceConnectionStatus.PENDING +- name: REJECTED + uid: azure.mgmt.videoanalyzer.models.PrivateEndpointServiceConnectionStatus.REJECTED diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkResource.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkResource.yml new file mode 100644 index 00000000..00de851f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkResource.yml @@ -0,0 +1,52 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.PrivateLinkResource +name: PrivateLinkResource +fullName: azure.mgmt.videoanalyzer.models.PrivateLinkResource +module: azure.mgmt.videoanalyzer.models +summary: 'A private link resource. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'PrivateLinkResource(*, required_zone_names: List[str] | None = None, **kwargs)' + parameters: + - name: required_zone_names + description: The private link resource Private link DNS zone name. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: required_zone_names + isRequired: true +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: The private link resource group id. + name: group_id + types: + - +- description: The private link resource required member names. + name: required_members + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkResourceListResult.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkResourceListResult.yml new file mode 100644 index 00000000..95a36cfb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkResourceListResult.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.PrivateLinkResourceListResult +name: PrivateLinkResourceListResult +fullName: azure.mgmt.videoanalyzer.models.PrivateLinkResourceListResult +module: azure.mgmt.videoanalyzer.models +summary: A list of private link resources. +constructor: + syntax: 'PrivateLinkResourceListResult(*, value: List[PrivateLinkResource] | None + = None, **kwargs)' + parameters: + - name: value + description: Array of private link resources. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: value + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkServiceConnectionState.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkServiceConnectionState.yml new file mode 100644 index 00000000..abd13d17 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkServiceConnectionState.yml @@ -0,0 +1,41 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.PrivateLinkServiceConnectionState +name: PrivateLinkServiceConnectionState +fullName: azure.mgmt.videoanalyzer.models.PrivateLinkServiceConnectionState +module: azure.mgmt.videoanalyzer.models +summary: A collection of information about the state of the connection between service + consumer and provider. +constructor: + syntax: 'PrivateLinkServiceConnectionState(*, status: str | PrivateEndpointServiceConnectionStatus + | None = None, description: str | None = None, actions_required: str | None = + None, **kwargs)' + parameters: + - name: status + description: 'Indicates whether the connection has been Approved/Rejected/Removed + by the owner + + of the service. Possible values include: "Pending", "Approved", "Rejected".' + isRequired: true + types: + - + - + - name: description + description: The reason for approval/rejection of the connection. + isRequired: true + types: + - + - name: actions_required + description: 'A message indicating if changes on the service provider require + any + + updates on the consumer.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: status + isRequired: true + - name: description + isRequired: true + - name: actions_required + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ProcessorNodeBase.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ProcessorNodeBase.yml new file mode 100644 index 00000000..c07146b5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ProcessorNodeBase.yml @@ -0,0 +1,41 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.ProcessorNodeBase +name: ProcessorNodeBase +fullName: azure.mgmt.videoanalyzer.models.ProcessorNodeBase +module: azure.mgmt.videoanalyzer.models +summary: 'Base class for topology processor nodes. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: EncoderProcessor. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ProcessorNodeBase(*, name: str, inputs: List[NodeInput], **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: name + description: Required. Node name. Must be unique within the topology. + isRequired: true + types: + - + - name: inputs + description: 'Required. An array of upstream node references within the topology + to be used as + + inputs for this node.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: name + isRequired: true + - name: inputs + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Properties.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Properties.yml new file mode 100644 index 00000000..1a16a67e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Properties.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.Properties +name: Properties +fullName: azure.mgmt.videoanalyzer.models.Properties +module: azure.mgmt.videoanalyzer.models +summary: 'Metric properties. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: Properties(**kwargs) +variables: +- description: The service specifications. + name: service_specification + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ProvisioningState.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ProvisioningState.yml new file mode 100644 index 00000000..96ce7407 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ProvisioningState.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.ProvisioningState +name: ProvisioningState +fullName: azure.mgmt.videoanalyzer.models.ProvisioningState +summary: Provisioning state of the Video Analyzer account. +module: azure.mgmt.videoanalyzer.models +fields: +- name: FAILED + uid: azure.mgmt.videoanalyzer.models.ProvisioningState.FAILED +- name: IN_PROGRESS + uid: azure.mgmt.videoanalyzer.models.ProvisioningState.IN_PROGRESS +- name: SUCCEEDED + uid: azure.mgmt.videoanalyzer.models.ProvisioningState.SUCCEEDED diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ProxyResource.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ProxyResource.yml new file mode 100644 index 00000000..8e2130fd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ProxyResource.yml @@ -0,0 +1,36 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.ProxyResource +name: ProxyResource +fullName: azure.mgmt.videoanalyzer.models.ProxyResource +module: azure.mgmt.videoanalyzer.models +summary: 'The resource model definition for a Azure Resource Manager proxy resource. + It will not have tags and a location. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: ProxyResource(**kwargs) +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PublicNetworkAccess.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PublicNetworkAccess.yml new file mode 100644 index 00000000..48492199 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PublicNetworkAccess.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.PublicNetworkAccess +name: PublicNetworkAccess +fullName: azure.mgmt.videoanalyzer.models.PublicNetworkAccess +summary: Whether or not public network access is allowed for resources under the Video + Analyzer account. +module: azure.mgmt.videoanalyzer.models +fields: +- name: DISABLED + uid: azure.mgmt.videoanalyzer.models.PublicNetworkAccess.DISABLED +- name: ENABLED + uid: azure.mgmt.videoanalyzer.models.PublicNetworkAccess.ENABLED diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Resource.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Resource.yml new file mode 100644 index 00000000..c68968b3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Resource.yml @@ -0,0 +1,36 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.Resource +name: Resource +fullName: azure.mgmt.videoanalyzer.models.Resource +module: azure.mgmt.videoanalyzer.models +summary: 'Common fields that are returned in the response for all Azure Resource Manager + resources. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: Resource(**kwargs) +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ResourceIdentity.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ResourceIdentity.yml new file mode 100644 index 00000000..99e886fe --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ResourceIdentity.yml @@ -0,0 +1,22 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.ResourceIdentity +name: ResourceIdentity +fullName: azure.mgmt.videoanalyzer.models.ResourceIdentity +module: azure.mgmt.videoanalyzer.models +summary: 'The user assigned managed identity to use when accessing a resource. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ResourceIdentity(*, user_assigned_identity: str, **kwargs)' + parameters: + - name: user_assigned_identity + description: 'Required. The user assigned managed identity''s resource + + identifier to use when accessing a resource.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: user_assigned_identity + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.RsaTokenKey.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.RsaTokenKey.yml new file mode 100644 index 00000000..1a69aee0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.RsaTokenKey.yml @@ -0,0 +1,55 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.RsaTokenKey +name: RsaTokenKey +fullName: azure.mgmt.videoanalyzer.models.RsaTokenKey +module: azure.mgmt.videoanalyzer.models +summary: 'Required validation properties for tokens generated with RSA algorithm. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RsaTokenKey(*, kid: str, alg: str | AccessPolicyRsaAlgo, n: str, e: str, + **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: kid + description: 'Required. JWT token key id. Validation keys are looked up based + on the key id + + present on the JWT token header.' + isRequired: true + types: + - + - name: alg + description: 'Required. RSA algorithm to be used: RS256, RS384 or RS512. Possible + values include: + + "RS256", "RS384", "RS512".' + isRequired: true + types: + - + - + - name: n + description: Required. RSA public key modulus. + isRequired: true + types: + - + - name: e + description: Required. RSA public key exponent. + isRequired: true + types: + - + keywordOnlyParameters: + - name: kid + isRequired: true + - name: alg + isRequired: true + - name: n + isRequired: true + - name: e + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.RtspSource.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.RtspSource.yml new file mode 100644 index 00000000..581d0723 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.RtspSource.yml @@ -0,0 +1,61 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.RtspSource +name: RtspSource +fullName: azure.mgmt.videoanalyzer.models.RtspSource +module: azure.mgmt.videoanalyzer.models +summary: 'RTSP source allows for media from an RTSP camera or generic RTSP server + to be ingested into a pipeline. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RtspSource(*, name: str, endpoint: EndpointBase, transport: str | RtspTransport + | None = None, **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: name + description: Required. Node name. Must be unique within the topology. + isRequired: true + types: + - + - name: transport + description: 'Network transport utilized by the RTSP and RTP exchange: TCP or + HTTP. When + + using TCP, the RTP packets are interleaved on the TCP RTSP connection. When + using HTTP, the + + RTSP messages are exchanged through long lived HTTP connections, and the RTP + packages are + + interleaved in the HTTP connections alongside the RTSP messages. Possible values + include: + + "Http", "Tcp".' + isRequired: true + types: + - + - + - name: endpoint + description: 'Required. RTSP endpoint information for Video Analyzer to connect + to. This + + contains the required information for Video Analyzer to connect to RTSP cameras + and/or generic + + RTSP servers.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: endpoint + isRequired: true + - name: transport + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.RtspTransport.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.RtspTransport.yml new file mode 100644 index 00000000..9afb7cd3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.RtspTransport.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.RtspTransport +name: RtspTransport +fullName: azure.mgmt.videoanalyzer.models.RtspTransport +summary: 'Network transport utilized by the RTSP and RTP exchange: TCP or HTTP. When + using TCP, the RTP + + packets are interleaved on the TCP RTSP connection. When using HTTP, the RTSP messages + are + + exchanged through long lived HTTP connections, and the RTP packages are interleaved + in the HTTP + + connections alongside the RTSP messages.' +module: azure.mgmt.videoanalyzer.models +fields: +- name: HTTP + uid: azure.mgmt.videoanalyzer.models.RtspTransport.HTTP +- name: TCP + uid: azure.mgmt.videoanalyzer.models.RtspTransport.TCP diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SecureIotDeviceRemoteTunnel.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SecureIotDeviceRemoteTunnel.yml new file mode 100644 index 00000000..99678039 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SecureIotDeviceRemoteTunnel.yml @@ -0,0 +1,36 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.SecureIotDeviceRemoteTunnel +name: SecureIotDeviceRemoteTunnel +fullName: azure.mgmt.videoanalyzer.models.SecureIotDeviceRemoteTunnel +module: azure.mgmt.videoanalyzer.models +summary: 'A remote tunnel securely established using IoT Hub device information. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SecureIotDeviceRemoteTunnel(*, iot_hub_name: str, device_id: str, **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: iot_hub_name + description: Required. Name of the IoT Hub. + isRequired: true + types: + - + - name: device_id + description: 'Required. The IoT device id to use when establishing the remote + tunnel. This + + string is case-sensitive.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: iot_hub_name + isRequired: true + - name: device_id + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ServiceSpecification.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ServiceSpecification.yml new file mode 100644 index 00000000..34c6bbda --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ServiceSpecification.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.ServiceSpecification +name: ServiceSpecification +fullName: azure.mgmt.videoanalyzer.models.ServiceSpecification +module: azure.mgmt.videoanalyzer.models +summary: 'The service metric specifications. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: ServiceSpecification(**kwargs) +variables: +- description: List of log specifications. + name: log_specifications + types: + - [] +- description: List of metric specifications. + name: metric_specifications + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SinkNodeBase.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SinkNodeBase.yml new file mode 100644 index 00000000..83ba9176 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SinkNodeBase.yml @@ -0,0 +1,41 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.SinkNodeBase +name: SinkNodeBase +fullName: azure.mgmt.videoanalyzer.models.SinkNodeBase +module: azure.mgmt.videoanalyzer.models +summary: 'Base class for topology sink nodes. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: VideoSink. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SinkNodeBase(*, name: str, inputs: List[NodeInput], **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: name + description: Required. Node name. Must be unique within the topology. + isRequired: true + types: + - + - name: inputs + description: 'Required. An array of upstream node references within the topology + to be used as + + inputs for this node.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: name + isRequired: true + - name: inputs + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Sku.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Sku.yml new file mode 100644 index 00000000..fd3baaf3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Sku.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.Sku +name: Sku +fullName: azure.mgmt.videoanalyzer.models.Sku +module: azure.mgmt.videoanalyzer.models +summary: 'The SKU details. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Sku(*, name: str | SkuName, **kwargs)' + parameters: + - name: name + description: 'Required. The SKU name. Possible values include: "Live_S1", "Batch_S1".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: name + isRequired: true +variables: +- description: 'The SKU tier. Possible values include: "Standard".' + name: tier + types: + - + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SkuName.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SkuName.yml new file mode 100644 index 00000000..aa53bb67 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SkuName.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.SkuName +name: SkuName +fullName: azure.mgmt.videoanalyzer.models.SkuName +summary: The SKU name. +module: azure.mgmt.videoanalyzer.models +fields: +- name: BATCH_S1 + uid: azure.mgmt.videoanalyzer.models.SkuName.BATCH_S1 +- name: LIVE_S1 + uid: azure.mgmt.videoanalyzer.models.SkuName.LIVE_S1 diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SkuTier.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SkuTier.yml new file mode 100644 index 00000000..db6856d3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SkuTier.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.SkuTier +name: SkuTier +fullName: azure.mgmt.videoanalyzer.models.SkuTier +summary: The SKU tier. +module: azure.mgmt.videoanalyzer.models +fields: +- name: STANDARD + uid: azure.mgmt.videoanalyzer.models.SkuTier.STANDARD diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SourceNodeBase.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SourceNodeBase.yml new file mode 100644 index 00000000..c6e10832 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SourceNodeBase.yml @@ -0,0 +1,31 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.SourceNodeBase +name: SourceNodeBase +fullName: azure.mgmt.videoanalyzer.models.SourceNodeBase +module: azure.mgmt.videoanalyzer.models +summary: 'Base class for topology source nodes. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: RtspSource, VideoSource. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SourceNodeBase(*, name: str, **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: name + description: Required. Node name. Must be unique within the topology. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.StorageAccount.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.StorageAccount.yml new file mode 100644 index 00000000..cca969fc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.StorageAccount.yml @@ -0,0 +1,42 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.StorageAccount +name: StorageAccount +fullName: azure.mgmt.videoanalyzer.models.StorageAccount +module: azure.mgmt.videoanalyzer.models +summary: 'The details about the associated storage account. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'StorageAccount(*, id: str, identity: ResourceIdentity | None = None, **kwargs)' + parameters: + - name: id + description: 'Required. The ID of the storage account resource. Video Analyzer + relies on tables, + + queues, and blobs. The primary storage account must be a Standard Storage account + (either + + Microsoft.ClassicStorage or Microsoft.Storage).' + isRequired: true + types: + - + - name: identity + description: A managed identity that Video Analyzer will use to access the storage + account. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: identity + isRequired: true +variables: +- description: The current status of the storage account mapping. + name: status + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SystemData.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SystemData.yml new file mode 100644 index 00000000..32c1be0b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SystemData.yml @@ -0,0 +1,61 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.SystemData +name: SystemData +fullName: azure.mgmt.videoanalyzer.models.SystemData +module: azure.mgmt.videoanalyzer.models +summary: Metadata pertaining to creation and last modification of the resource. +constructor: + syntax: 'SystemData(*, created_by: str | None = None, created_by_type: str | CreatedByType + | None = None, created_at: datetime | None = None, last_modified_by: str | None + = None, last_modified_by_type: str | CreatedByType | None = None, last_modified_at: + datetime | None = None, **kwargs)' + parameters: + - name: created_by + description: The identity that created the resource. + isRequired: true + types: + - + - name: created_by_type + description: 'The type of identity that created the resource. Possible values + + include: "User", "Application", "ManagedIdentity", "Key".' + isRequired: true + types: + - + - + - name: created_at + description: The timestamp of resource creation (UTC). + isRequired: true + types: + - + - name: last_modified_by + description: The identity that last modified the resource. + isRequired: true + types: + - + - name: last_modified_by_type + description: 'The type of identity that last modified the resource. Possible + + values include: "User", "Application", "ManagedIdentity", "Key".' + isRequired: true + types: + - + - + - name: last_modified_at + description: The timestamp of resource last modification (UTC). + isRequired: true + types: + - + keywordOnlyParameters: + - name: created_by + isRequired: true + - name: created_by_type + isRequired: true + - name: created_at + isRequired: true + - name: last_modified_by + isRequired: true + - name: last_modified_by_type + isRequired: true + - name: last_modified_at + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TimeSequenceBase.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TimeSequenceBase.yml new file mode 100644 index 00000000..f64f089c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TimeSequenceBase.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.TimeSequenceBase +name: TimeSequenceBase +fullName: azure.mgmt.videoanalyzer.models.TimeSequenceBase +module: azure.mgmt.videoanalyzer.models +summary: 'A sequence of datetime ranges as a string. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: VideoSequenceAbsoluteTimeMarkers. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: TimeSequenceBase(**kwargs) + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TlsEndpoint.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TlsEndpoint.yml new file mode 100644 index 00000000..09ee2d39 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TlsEndpoint.yml @@ -0,0 +1,69 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.TlsEndpoint +name: TlsEndpoint +fullName: azure.mgmt.videoanalyzer.models.TlsEndpoint +module: azure.mgmt.videoanalyzer.models +summary: 'TLS endpoint describes an endpoint that the pipeline can connect to over + TLS transport (data is encrypted in transit). + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TlsEndpoint(*, credentials: CredentialsBase, url: str, tunnel: TunnelBase + | None = None, trusted_certificates: CertificateSource | None = None, validation_options: + TlsValidationOptions | None = None, **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: credentials + description: Required. Credentials to be presented to the endpoint. + isRequired: true + types: + - + - name: url + description: Required. The endpoint URL for Video Analyzer to connect to. + isRequired: true + types: + - + - name: tunnel + description: 'Describes the tunnel through which Video Analyzer can connect to + the endpoint + + URL. This is an optional property, typically used when the endpoint is behind + a firewall.' + isRequired: true + types: + - + - name: trusted_certificates + description: 'List of trusted certificate authorities when authenticating a TLS + + connection. A null list designates that Azure Video Analyzer''s list of trusted + authorities + + should be used.' + isRequired: true + types: + - + - name: validation_options + description: 'Validation options to use when authenticating a TLS connection. + By + + default, strict validation is used.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: credentials + isRequired: true + - name: url + isRequired: true + - name: tunnel + isRequired: true + - name: trusted_certificates + isRequired: true + - name: validation_options + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TlsValidationOptions.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TlsValidationOptions.yml new file mode 100644 index 00000000..6fa7ec45 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TlsValidationOptions.yml @@ -0,0 +1,31 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.TlsValidationOptions +name: TlsValidationOptions +fullName: azure.mgmt.videoanalyzer.models.TlsValidationOptions +module: azure.mgmt.videoanalyzer.models +summary: Options for controlling the validation of TLS endpoints. +constructor: + syntax: 'TlsValidationOptions(*, ignore_hostname: str | None = None, ignore_signature: + str | None = None, **kwargs)' + parameters: + - name: ignore_hostname + description: 'When set to ''true'' causes the certificate subject name validation + to be + + skipped. Default is ''false''.' + isRequired: true + types: + - + - name: ignore_signature + description: 'When set to ''true'' causes the certificate chain trust validation + to be + + skipped. Default is ''false''.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: ignore_hostname + isRequired: true + - name: ignore_signature + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TokenClaim.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TokenClaim.yml new file mode 100644 index 00000000..c587c335 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TokenClaim.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.TokenClaim +name: TokenClaim +fullName: azure.mgmt.videoanalyzer.models.TokenClaim +module: azure.mgmt.videoanalyzer.models +summary: 'Properties for expected token claims. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TokenClaim(*, name: str, value: str, **kwargs)' + parameters: + - name: name + description: Required. Name of the claim which must be present on the token. + isRequired: true + types: + - + - name: value + description: Required. Expected value of the claim to be present on the token. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: value + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TokenKey.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TokenKey.yml new file mode 100644 index 00000000..fa3402c2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TokenKey.yml @@ -0,0 +1,34 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.TokenKey +name: TokenKey +fullName: azure.mgmt.videoanalyzer.models.TokenKey +module: azure.mgmt.videoanalyzer.models +summary: 'Key properties for JWT token validation. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: EccTokenKey, RsaTokenKey. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TokenKey(*, kid: str, **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: kid + description: 'Required. JWT token key id. Validation keys are looked up based + on the key id + + present on the JWT token header.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: kid + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TrackedResource.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TrackedResource.yml new file mode 100644 index 00000000..104d5db1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TrackedResource.yml @@ -0,0 +1,55 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.TrackedResource +name: TrackedResource +fullName: azure.mgmt.videoanalyzer.models.TrackedResource +module: azure.mgmt.videoanalyzer.models +summary: 'The resource model definition for an Azure Resource Manager tracked top + level resource which has ''tags'' and a ''location''. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TrackedResource(*, location: str, tags: Dict[str, str] | None = None, **kwargs)' + parameters: + - name: tags + description: A set of tags. Resource tags. + isRequired: true + types: + - [, ] + - name: location + description: Required. The geo-location where the resource lives. + isRequired: true + types: + - + keywordOnlyParameters: + - name: location + isRequired: true + - name: tags + isRequired: true +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TunnelBase.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TunnelBase.yml new file mode 100644 index 00000000..982ee04e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TunnelBase.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.TunnelBase +name: TunnelBase +fullName: azure.mgmt.videoanalyzer.models.TunnelBase +module: azure.mgmt.videoanalyzer.models +summary: 'Base class for tunnel objects. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: SecureIotDeviceRemoteTunnel. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: TunnelBase(**kwargs) + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.UnsecuredEndpoint.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.UnsecuredEndpoint.yml new file mode 100644 index 00000000..bd6a0de1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.UnsecuredEndpoint.yml @@ -0,0 +1,46 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.UnsecuredEndpoint +name: UnsecuredEndpoint +fullName: azure.mgmt.videoanalyzer.models.UnsecuredEndpoint +module: azure.mgmt.videoanalyzer.models +summary: 'Unsecured endpoint describes an endpoint that the pipeline can connect to + over clear transport (no encryption in transit). + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'UnsecuredEndpoint(*, credentials: CredentialsBase, url: str, tunnel: TunnelBase + | None = None, **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: credentials + description: Required. Credentials to be presented to the endpoint. + isRequired: true + types: + - + - name: url + description: Required. The endpoint URL for Video Analyzer to connect to. + isRequired: true + types: + - + - name: tunnel + description: 'Describes the tunnel through which Video Analyzer can connect to + the endpoint + + URL. This is an optional property, typically used when the endpoint is behind + a firewall.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: credentials + isRequired: true + - name: url + isRequired: true + - name: tunnel + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.UserAssignedManagedIdentity.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.UserAssignedManagedIdentity.yml new file mode 100644 index 00000000..3c9e625f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.UserAssignedManagedIdentity.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.UserAssignedManagedIdentity +name: UserAssignedManagedIdentity +fullName: azure.mgmt.videoanalyzer.models.UserAssignedManagedIdentity +module: azure.mgmt.videoanalyzer.models +summary: 'The details of the user assigned managed identity used by the Video Analyzer + resource. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: UserAssignedManagedIdentity(**kwargs) +variables: +- description: The client ID. + name: client_id + types: + - +- description: The principal ID. + name: principal_id + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.UsernamePasswordCredentials.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.UsernamePasswordCredentials.yml new file mode 100644 index 00000000..c0f90df1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.UsernamePasswordCredentials.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.UsernamePasswordCredentials +name: UsernamePasswordCredentials +fullName: azure.mgmt.videoanalyzer.models.UsernamePasswordCredentials +module: azure.mgmt.videoanalyzer.models +summary: 'Username and password credentials. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'UsernamePasswordCredentials(*, username: str, password: str, **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: username + description: Required. Username to be presented as part of the credentials. + isRequired: true + types: + - + - name: password + description: 'Required. Password to be presented as part of the credentials. It + is + + recommended that this value is parameterized as a secret string in order to + prevent this value + + to be returned as part of the resource on API requests.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: username + isRequired: true + - name: password + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzer.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzer.yml new file mode 100644 index 00000000..95f003c0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzer.yml @@ -0,0 +1,120 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.VideoAnalyzer +name: VideoAnalyzer +fullName: azure.mgmt.videoanalyzer.models.VideoAnalyzer +module: azure.mgmt.videoanalyzer.models +summary: 'The Video Analyzer account. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'VideoAnalyzer(*, location: str, tags: Dict[str, str] | None = None, identity: + VideoAnalyzerIdentity | None = None, storage_accounts: List[StorageAccount] | + None = None, encryption: AccountEncryption | None = None, iot_hubs: List[IotHub] + | None = None, public_network_access: str | PublicNetworkAccess | None = None, + network_access_control: NetworkAccessControl | None = None, **kwargs)' + parameters: + - name: tags + description: A set of tags. Resource tags. + isRequired: true + types: + - [, ] + - name: location + description: Required. The geo-location where the resource lives. + isRequired: true + types: + - + - name: identity + description: The identities associated to the Video Analyzer resource. + isRequired: true + types: + - + - name: storage_accounts + description: The storage accounts for this resource. + isRequired: true + types: + - [] + - name: encryption + description: The account encryption properties. + isRequired: true + types: + - + - name: iot_hubs + description: The IoT Hubs for this resource. + isRequired: true + types: + - [] + - name: public_network_access + description: 'Whether or not public network access is allowed for resources + + under the Video Analyzer account. Possible values include: "Enabled", "Disabled".' + isRequired: true + types: + - + - + - name: network_access_control + description: Network access control for Video Analyzer. + isRequired: true + types: + - + keywordOnlyParameters: + - name: location + isRequired: true + - name: tags + isRequired: true + - name: identity + isRequired: true + - name: storage_accounts + isRequired: true + - name: encryption + isRequired: true + - name: iot_hubs + isRequired: true + - name: public_network_access + isRequired: true + - name: network_access_control + isRequired: true +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: The endpoints associated with this resource. + name: endpoints + types: + - [] +- description: 'Provisioning state of the Video Analyzer account. Possible values + + include: "Failed", "InProgress", "Succeeded".' + name: provisioning_state + types: + - + - +- description: 'Private Endpoint Connections created under Video Analyzer + + account.' + name: private_endpoint_connections + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerCollection.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerCollection.yml new file mode 100644 index 00000000..38f37a2a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerCollection.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.VideoAnalyzerCollection +name: VideoAnalyzerCollection +fullName: azure.mgmt.videoanalyzer.models.VideoAnalyzerCollection +module: azure.mgmt.videoanalyzer.models +summary: A collection of VideoAnalyzer items. +constructor: + syntax: 'VideoAnalyzerCollection(*, value: List[VideoAnalyzer] | None = None, **kwargs)' + parameters: + - name: value + description: A collection of VideoAnalyzer items. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: value + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerEndpointType.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerEndpointType.yml new file mode 100644 index 00000000..649cd2f2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerEndpointType.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.VideoAnalyzerEndpointType +name: VideoAnalyzerEndpointType +fullName: azure.mgmt.videoanalyzer.models.VideoAnalyzerEndpointType +summary: The type of the endpoint. +module: azure.mgmt.videoanalyzer.models +fields: +- name: CLIENT_API + uid: azure.mgmt.videoanalyzer.models.VideoAnalyzerEndpointType.CLIENT_API diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerIdentity.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerIdentity.yml new file mode 100644 index 00000000..1deee509 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerIdentity.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.VideoAnalyzerIdentity +name: VideoAnalyzerIdentity +fullName: azure.mgmt.videoanalyzer.models.VideoAnalyzerIdentity +module: azure.mgmt.videoanalyzer.models +summary: 'The managed identity for the Video Analyzer resource. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'VideoAnalyzerIdentity(*, type: str, user_assigned_identities: Dict[str, + UserAssignedManagedIdentity] | None = None, **kwargs)' + parameters: + - name: type + description: Required. The identity type. + isRequired: true + types: + - + - name: user_assigned_identities + description: The User Assigned Managed Identities. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: type + isRequired: true + - name: user_assigned_identities + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerOperationStatus.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerOperationStatus.yml new file mode 100644 index 00000000..057fc6ee --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerOperationStatus.yml @@ -0,0 +1,57 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.VideoAnalyzerOperationStatus +name: VideoAnalyzerOperationStatus +fullName: azure.mgmt.videoanalyzer.models.VideoAnalyzerOperationStatus +module: azure.mgmt.videoanalyzer.models +summary: 'Status of video analyzer operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'VideoAnalyzerOperationStatus(*, name: str, id: str | None = None, start_time: + str | None = None, end_time: str | None = None, status: str | None = None, error: + ErrorDetail | None = None, **kwargs)' + parameters: + - name: name + description: Required. Operation identifier. + isRequired: true + types: + - + - name: id + description: Operation resource ID. + isRequired: true + types: + - + - name: start_time + description: Operation start time. + isRequired: true + types: + - + - name: end_time + description: Operation end time. + isRequired: true + types: + - + - name: status + description: Operation status. + isRequired: true + types: + - + - name: error + description: The error detail. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: id + isRequired: true + - name: start_time + isRequired: true + - name: end_time + isRequired: true + - name: status + isRequired: true + - name: error + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerPrivateEndpointConnectionOperationStatus.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerPrivateEndpointConnectionOperationStatus.yml new file mode 100644 index 00000000..9303c626 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerPrivateEndpointConnectionOperationStatus.yml @@ -0,0 +1,57 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.VideoAnalyzerPrivateEndpointConnectionOperationStatus +name: VideoAnalyzerPrivateEndpointConnectionOperationStatus +fullName: azure.mgmt.videoanalyzer.models.VideoAnalyzerPrivateEndpointConnectionOperationStatus +module: azure.mgmt.videoanalyzer.models +summary: 'Status of private endpoint connection operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'VideoAnalyzerPrivateEndpointConnectionOperationStatus(*, name: str, id: + str | None = None, start_time: str | None = None, end_time: str | None = None, + status: str | None = None, error: ErrorDetail | None = None, **kwargs)' + parameters: + - name: name + description: Required. Operation identifier. + isRequired: true + types: + - + - name: id + description: Operation resource ID. + isRequired: true + types: + - + - name: start_time + description: Operation start time. + isRequired: true + types: + - + - name: end_time + description: Operation end time. + isRequired: true + types: + - + - name: status + description: Operation status. + isRequired: true + types: + - + - name: error + description: The error detail. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: id + isRequired: true + - name: start_time + isRequired: true + - name: end_time + isRequired: true + - name: status + isRequired: true + - name: error + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerUpdate.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerUpdate.yml new file mode 100644 index 00000000..780d7f6b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerUpdate.yml @@ -0,0 +1,87 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.VideoAnalyzerUpdate +name: VideoAnalyzerUpdate +fullName: azure.mgmt.videoanalyzer.models.VideoAnalyzerUpdate +module: azure.mgmt.videoanalyzer.models +summary: 'The update operation for a Video Analyzer account. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'VideoAnalyzerUpdate(*, tags: Dict[str, str] | None = None, identity: VideoAnalyzerIdentity + | None = None, storage_accounts: List[StorageAccount] | None = None, encryption: + AccountEncryption | None = None, iot_hubs: List[IotHub] | None = None, public_network_access: + str | PublicNetworkAccess | None = None, network_access_control: NetworkAccessControl + | None = None, **kwargs)' + parameters: + - name: tags + description: A set of tags. Resource tags. + isRequired: true + types: + - [, ] + - name: identity + description: The identities associated to the Video Analyzer resource. + isRequired: true + types: + - + - name: storage_accounts + description: The storage accounts for this resource. + isRequired: true + types: + - [] + - name: encryption + description: The account encryption properties. + isRequired: true + types: + - + - name: iot_hubs + description: The IoT Hubs for this resource. + isRequired: true + types: + - [] + - name: public_network_access + description: 'Whether or not public network access is allowed for resources + + under the Video Analyzer account. Possible values include: "Enabled", "Disabled".' + isRequired: true + types: + - + - + - name: network_access_control + description: Network access control for Video Analyzer. + isRequired: true + types: + - + keywordOnlyParameters: + - name: tags + isRequired: true + - name: identity + isRequired: true + - name: storage_accounts + isRequired: true + - name: encryption + isRequired: true + - name: iot_hubs + isRequired: true + - name: public_network_access + isRequired: true + - name: network_access_control + isRequired: true +variables: +- description: The endpoints associated with this resource. + name: endpoints + types: + - [] +- description: 'Provisioning state of the Video Analyzer account. Possible values + + include: "Failed", "InProgress", "Succeeded".' + name: provisioning_state + types: + - + - +- description: 'Private Endpoint Connections created under Video Analyzer + + account.' + name: private_endpoint_connections + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoArchival.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoArchival.yml new file mode 100644 index 00000000..4e16424b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoArchival.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.VideoArchival +name: VideoArchival +fullName: azure.mgmt.videoanalyzer.models.VideoArchival +module: azure.mgmt.videoanalyzer.models +summary: Video archival properties. +constructor: + syntax: 'VideoArchival(*, retention_period: str | None = None, **kwargs)' + parameters: + - name: retention_period + description: 'Video retention period indicates the maximum age of the video archive + + segments which are intended to be kept in storage. It must be provided in the + ISO8601 duration + + format in the granularity of days, up to a maximum of 10 years. For example, + if this is set to + + P30D (30 days), content older than 30 days will be periodically deleted. This + value can be + + updated at any time and the new desired retention period will be effective within + 24 hours.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: retention_period + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoContentToken.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoContentToken.yml new file mode 100644 index 00000000..f9fb024d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoContentToken.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.VideoContentToken +name: VideoContentToken +fullName: azure.mgmt.videoanalyzer.models.VideoContentToken +module: azure.mgmt.videoanalyzer.models +summary: '"Video content token grants access to the video content URLs.". + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: VideoContentToken(**kwargs) +variables: +- description: 'The content token expiration date in ISO8601 format (eg. + + 2021-01-01T00:00:00Z).' + name: expiration_date + types: + - +- description: 'The content token value to be added to the video content URL as the + value for the + + "token" query string parameter. The token is specific to a single video.' + name: token + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoContentUrls.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoContentUrls.yml new file mode 100644 index 00000000..a30dcf17 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoContentUrls.yml @@ -0,0 +1,81 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.VideoContentUrls +name: VideoContentUrls +fullName: azure.mgmt.videoanalyzer.models.VideoContentUrls +module: azure.mgmt.videoanalyzer.models +summary: Set of URLs to the video content. +constructor: + syntax: 'VideoContentUrls(*, download_url: str | None = None, archive_base_url: + str | None = None, rtsp_tunnel_url: str | None = None, preview_image_urls: VideoPreviewImageUrls + | None = None, **kwargs)' + parameters: + - name: download_url + description: 'Video file download URL. This URL can be used in conjunction with + the + + video content authorization token to download the video MP4 file. The resulting + MP4 file can be + + played on any standard media player. It is available when the video type is + ''file'' and video + + file is available for consumption.' + isRequired: true + types: + - + - name: archive_base_url + description: "Video archive streaming base URL. The archived content can be\n\ + automatically played by the Azure Video Analyzer player widget. Alternatively,\ + \ this URL can be\nused in conjunction with the video content authorization\ + \ token on any compatible DASH or HLS\nplayers by appending the following to\ + \ the base URL:\n\n\n\n````default\n\n - HLSv4: /manifest(format=m3u8-aapl).m3u8\n \ + \ - HLS CMAF: /manifest(format=m3u8-cmaf)\n - DASH CMAF: /manifest(format=mpd-time-cmaf)\n\ + \n Moreover, an ongoing video recording can be played in \"live mode\" with\ + \ latencies which are\n ````\n\napproximately double of the chosen video segment\ + \ length. It is available when the video type is\n'archive' and video archiving\ + \ is enabled." + isRequired: true + types: + - + - name: rtsp_tunnel_url + description: 'Video low-latency streaming URL. The live content can be automatically + + played by the Azure Video Analyzer player widget. Alternatively, this URL can + be used in + + conjunction with the video content authorization token to expose a WebSocket + tunneled RTSP + + stream. It is available when the video type is ''archive'' and a live, low-latency + feed is + + available from the source.' + isRequired: true + types: + - + - name: preview_image_urls + description: 'Video preview image URLs. These URLs can be used in conjunction + with + + the video content authorization token to download the most recent still image + from the video + + archive in different resolutions. They are available when the video type is + ''archive'' and + + preview images are enabled.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: download_url + isRequired: true + - name: archive_base_url + isRequired: true + - name: rtsp_tunnel_url + isRequired: true + - name: preview_image_urls + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoCreationProperties.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoCreationProperties.yml new file mode 100644 index 00000000..e05ba0b4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoCreationProperties.yml @@ -0,0 +1,76 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.VideoCreationProperties +name: VideoCreationProperties +fullName: azure.mgmt.videoanalyzer.models.VideoCreationProperties +module: azure.mgmt.videoanalyzer.models +summary: Optional properties to be used in case a new video resource needs to be created + on the service. These will not take effect if the video already exists. +constructor: + syntax: 'VideoCreationProperties(*, title: str | None = None, description: str | + None = None, segment_length: str | None = None, retention_period: str | None = + None, **kwargs)' + parameters: + - name: title + description: Optional title provided by the user. Value can be up to 256 characters + long. + isRequired: true + types: + - + - name: description + description: 'Optional description provided by the user. Value can be up to 2048 + + characters long.' + isRequired: true + types: + - + - name: segment_length + description: 'Segment length indicates the length of individual content files + + (segments) which are persisted to storage. Smaller segments provide lower archive + playback + + latency but generate larger volume of storage transactions. Larger segments + reduce the amount + + of storage transactions while increasing the archive playback latency. Value + must be specified + + in ISO8601 duration format (i.e. "PT30S" equals 30 seconds) and can vary between + 30 seconds to + + 5 minutes, in 30 seconds increments. Changing this value after the initial call + to create the + + video resource can lead to errors when uploading content to the archive. Default + value is 30 + + seconds. This property is only allowed for topologies where "kind" is set to + "live".' + isRequired: true + types: + - + - name: retention_period + description: 'Video retention period indicates how long the video is kept in + + storage. Value must be specified in ISO8601 duration format (i.e. "P1D" equals + 1 day) and can + + vary between 1 day to 10 years, in 1 day increments. When absent (null), all + video content is + + retained indefinitely. This property is only allowed for topologies where "kind" + is set to + + "live".' + isRequired: true + types: + - + keywordOnlyParameters: + - name: title + isRequired: true + - name: description + isRequired: true + - name: segment_length + isRequired: true + - name: retention_period + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEncoderBase.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEncoderBase.yml new file mode 100644 index 00000000..70c02562 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEncoderBase.yml @@ -0,0 +1,62 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.VideoEncoderBase +name: VideoEncoderBase +fullName: azure.mgmt.videoanalyzer.models.VideoEncoderBase +module: azure.mgmt.videoanalyzer.models +summary: 'Base type for all video encoding presets, which define the recipe or instructions + on how the input video should be processed. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: VideoEncoderH264. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'VideoEncoderBase(*, bitrate_kbps: str | None = None, frame_rate: str | + None = None, scale: VideoScale | None = None, **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: bitrate_kbps + description: 'The maximum bitrate, in kilobits per second or Kbps, at which video + should + + be encoded. If omitted, encoder sets it automatically to try and match the quality + of the input + + video.' + isRequired: true + types: + - + - name: frame_rate + description: 'The frame rate (in frames per second) of the encoded video. The + value must + + be greater than zero, and less than or equal to 300. If omitted, the encoder + uses the average + + frame rate of the input video.' + isRequired: true + types: + - + - name: scale + description: 'Describes the resolution of the encoded video. If omitted, the encoder + uses the + + resolution of the input video.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: bitrate_kbps + isRequired: true + - name: frame_rate + isRequired: true + - name: scale + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEncoderH264.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEncoderH264.yml new file mode 100644 index 00000000..ab7b9417 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEncoderH264.yml @@ -0,0 +1,56 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.VideoEncoderH264 +name: VideoEncoderH264 +fullName: azure.mgmt.videoanalyzer.models.VideoEncoderH264 +module: azure.mgmt.videoanalyzer.models +summary: 'A custom preset for encoding video with the H.264 (AVC) codec. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'VideoEncoderH264(*, bitrate_kbps: str | None = None, frame_rate: str | + None = None, scale: VideoScale | None = None, **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: bitrate_kbps + description: 'The maximum bitrate, in kilobits per second or Kbps, at which video + should + + be encoded. If omitted, encoder sets it automatically to try and match the quality + of the input + + video.' + isRequired: true + types: + - + - name: frame_rate + description: 'The frame rate (in frames per second) of the encoded video. The + value must + + be greater than zero, and less than or equal to 300. If omitted, the encoder + uses the average + + frame rate of the input video.' + isRequired: true + types: + - + - name: scale + description: 'Describes the resolution of the encoded video. If omitted, the encoder + uses the + + resolution of the input video.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: bitrate_kbps + isRequired: true + - name: frame_rate + isRequired: true + - name: scale + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEntity.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEntity.yml new file mode 100644 index 00000000..107ef7b0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEntity.yml @@ -0,0 +1,95 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.VideoEntity +name: VideoEntity +fullName: azure.mgmt.videoanalyzer.models.VideoEntity +module: azure.mgmt.videoanalyzer.models +summary: 'Represents a video resource within Azure Video Analyzer. Videos can be ingested + from RTSP cameras through live pipelines or can be created by exporting sequences + from existing captured video through a pipeline job. Videos ingested through live + pipelines can be streamed through Azure Video Analyzer Player Widget or compatible + players. Exported videos can be downloaded as MP4 files. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'VideoEntity(*, title: str | None = None, description: str | None = None, + media_info: VideoMediaInfo | None = None, archival: VideoArchival | None = None, + **kwargs)' + parameters: + - name: title + description: 'Optional video title provided by the user. Value can be up to 256 + characters + + long.' + isRequired: true + types: + - + - name: description + description: 'Optional video description provided by the user. Value can be up + to 2048 + + characters long.' + isRequired: true + types: + - + - name: media_info + description: Contains information about the video and audio content. + isRequired: true + types: + - + - name: archival + description: Video archival properties. + isRequired: true + types: + - + keywordOnlyParameters: + - name: title + isRequired: true + - name: description + isRequired: true + - name: media_info + isRequired: true + - name: archival + isRequired: true +variables: +- description: 'Fully qualified resource ID for the resource. Ex - + + /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.' + name: id + types: + - +- description: The name of the resource. + name: name + types: + - +- description: 'The type of the resource. E.g. "Microsoft.Compute/virtualMachines" + or + + "Microsoft.Storage/storageAccounts".' + name: type + types: + - +- description: 'Azure Resource Manager metadata containing createdBy and modifiedBy + + information.' + name: system_data + types: + - +- description: 'Video content type. Different content types are suitable for + + different applications and scenarios. Possible values include: "Archive", "File".' + name: type_properties_type + types: + - + - +- description: 'Video flags contain information about the available video actions + and its dynamic + + properties based on the current video state.' + name: flags + types: + - +- description: Set of URLs to the video content. + name: content_urls + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEntityCollection.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEntityCollection.yml new file mode 100644 index 00000000..aa3942c0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEntityCollection.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.VideoEntityCollection +name: VideoEntityCollection +fullName: azure.mgmt.videoanalyzer.models.VideoEntityCollection +module: azure.mgmt.videoanalyzer.models +summary: A collection of VideoEntity items. +constructor: + syntax: 'VideoEntityCollection(*, value: List[VideoEntity] | None = None, next_link: + str | None = None, **kwargs)' + parameters: + - name: value + description: A collection of VideoEntity items. + isRequired: true + types: + - [] + - name: next_link + description: 'A link to the next page of the collection (when the collection contains + too + + many results to return in one response).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: next_link + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoFlags.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoFlags.yml new file mode 100644 index 00000000..e1175311 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoFlags.yml @@ -0,0 +1,50 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.VideoFlags +name: VideoFlags +fullName: azure.mgmt.videoanalyzer.models.VideoFlags +module: azure.mgmt.videoanalyzer.models +summary: 'Video flags contain information about the available video actions and its + dynamic properties based on the current video state. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'VideoFlags(*, can_stream: bool, has_data: bool, is_in_use: bool, **kwargs)' + parameters: + - name: can_stream + description: 'Required. Value indicating whether or not the video can be streamed. + Only + + "archive" type videos can be streamed.' + isRequired: true + types: + - + - name: has_data + description: 'Required. Value indicating whether or not there has ever been data + recorded or + + uploaded into the video. Newly created videos have this value set to false.' + isRequired: true + types: + - + - name: is_in_use + description: 'Required. Value indicating whether or not the video is currently + being + + referenced be an active pipeline. The fact that is being referenced, doesn''t + necessarily + + indicate that data is being received. For example, video recording may be gated + on events or + + camera may not be accessible at the time.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: can_stream + isRequired: true + - name: has_data + isRequired: true + - name: is_in_use + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoMediaInfo.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoMediaInfo.yml new file mode 100644 index 00000000..b2509a27 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoMediaInfo.yml @@ -0,0 +1,31 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.VideoMediaInfo +name: VideoMediaInfo +fullName: azure.mgmt.videoanalyzer.models.VideoMediaInfo +module: azure.mgmt.videoanalyzer.models +summary: Contains information about the video and audio content. +constructor: + syntax: 'VideoMediaInfo(*, segment_length: str | None = None, **kwargs)' + parameters: + - name: segment_length + description: 'Video segment length indicates the length of individual video files + + (segments) which are persisted to storage. Smaller segments provide lower archive + playback + + latency but generate larger volume of storage transactions. Larger segments + reduce the amount + + of storage transactions while increasing the archive playback latency. Value + must be specified + + in ISO8601 duration format (i.e. "PT30S" equals 30 seconds) and can vary between + 30 seconds to + + 5 minutes, in 30 seconds increments.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: segment_length + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoPreviewImageUrls.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoPreviewImageUrls.yml new file mode 100644 index 00000000..11936e7a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoPreviewImageUrls.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.VideoPreviewImageUrls +name: VideoPreviewImageUrls +fullName: azure.mgmt.videoanalyzer.models.VideoPreviewImageUrls +module: azure.mgmt.videoanalyzer.models +summary: Video preview image URLs. These URLs can be used in conjunction with the + video content authorization token to download the most recent still image from the + video archive in different resolutions. They are available when the video type is + 'archive' and preview images are enabled. +constructor: + syntax: 'VideoPreviewImageUrls(*, small: str | None = None, medium: str | None = + None, large: str | None = None, **kwargs)' + parameters: + - name: small + description: Low resolution preview image URL. + isRequired: true + types: + - + - name: medium + description: Medium resolution preview image URL. + isRequired: true + types: + - + - name: large + description: High resolution preview image URL. + isRequired: true + types: + - + keywordOnlyParameters: + - name: small + isRequired: true + - name: medium + isRequired: true + - name: large + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoPublishingOptions.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoPublishingOptions.yml new file mode 100644 index 00000000..f22461a0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoPublishingOptions.yml @@ -0,0 +1,41 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.VideoPublishingOptions +name: VideoPublishingOptions +fullName: azure.mgmt.videoanalyzer.models.VideoPublishingOptions +module: azure.mgmt.videoanalyzer.models +summary: Optional flags used to change how video is published. These are only allowed + for topologies where "kind" is set to "live". +constructor: + syntax: 'VideoPublishingOptions(*, disable_archive: str | None = None, disable_rtsp_publishing: + str | None = None, **kwargs)' + parameters: + - name: disable_archive + description: 'When set to ''true'' content will not be archived or recorded. This + is + + used, for example, when the topology is used only for low latency video streaming. + Default is + + ''false''. If set to ''true'', then "disableRtspPublishing" must be set to + ''false''.' + isRequired: true + types: + - + - name: disable_rtsp_publishing + description: 'When set to ''true'' the RTSP playback URL will not be published, + + disabling low latency streaming. This is used, for example, when the topology + is used only for + + archiving content. Default is ''false''. If set to ''true'', then "disableArchive" + must be set to + + ''false''.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: disable_archive + isRequired: true + - name: disable_rtsp_publishing + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoScale.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoScale.yml new file mode 100644 index 00000000..0302c030 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoScale.yml @@ -0,0 +1,42 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.VideoScale +name: VideoScale +fullName: azure.mgmt.videoanalyzer.models.VideoScale +module: azure.mgmt.videoanalyzer.models +summary: The video scaling information. +constructor: + syntax: 'VideoScale(*, height: str | None = None, width: str | None = None, mode: + str | VideoScaleMode | None = None, **kwargs)' + parameters: + - name: height + description: The desired output video height. + isRequired: true + types: + - + - name: width + description: The desired output video width. + isRequired: true + types: + - + - name: mode + description: 'Describes the video scaling mode to be applied. Default mode is + ''Pad''. If the mode + + is ''Pad'' or ''Stretch'' then both width and height must be specified. Else + if the mode is + + ''PreserveAspectRatio'' then only one of width or height need be provided. Possible + values + + include: "Pad", "PreserveAspectRatio", "Stretch".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: height + isRequired: true + - name: width + isRequired: true + - name: mode + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoScaleMode.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoScaleMode.yml new file mode 100644 index 00000000..e0bed6ad --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoScaleMode.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.VideoScaleMode +name: VideoScaleMode +fullName: azure.mgmt.videoanalyzer.models.VideoScaleMode +summary: 'Describes the video scaling mode to be applied. Default mode is ''Pad''. + If the mode is ''Pad'' or + + ''Stretch'' then both width and height must be specified. Else if the mode is + + ''PreserveAspectRatio'' then only one of width or height need be provided.' +module: azure.mgmt.videoanalyzer.models +fields: +- name: PAD + uid: azure.mgmt.videoanalyzer.models.VideoScaleMode.PAD +- name: PRESERVE_ASPECT_RATIO + uid: azure.mgmt.videoanalyzer.models.VideoScaleMode.PRESERVE_ASPECT_RATIO +- name: STRETCH + uid: azure.mgmt.videoanalyzer.models.VideoScaleMode.STRETCH diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoSequenceAbsoluteTimeMarkers.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoSequenceAbsoluteTimeMarkers.yml new file mode 100644 index 00000000..fe0e78ca --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoSequenceAbsoluteTimeMarkers.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.VideoSequenceAbsoluteTimeMarkers +name: VideoSequenceAbsoluteTimeMarkers +fullName: azure.mgmt.videoanalyzer.models.VideoSequenceAbsoluteTimeMarkers +module: azure.mgmt.videoanalyzer.models +summary: 'A sequence of absolute datetime ranges as a string. The datetime values + should follow IS08601, and the sum of the ranges should add up to 24 hours or less. + Currently, there can be only one range specified in the sequence. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'VideoSequenceAbsoluteTimeMarkers(*, ranges: str, **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: ranges + description: 'Required. The sequence of datetime ranges. Example: ''[["2021-10-05T03:30:00Z", + + "2021-10-05T03:40:00Z"]]''.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: ranges + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoSink.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoSink.yml new file mode 100644 index 00000000..71aa2531 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoSink.yml @@ -0,0 +1,74 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.VideoSink +name: VideoSink +fullName: azure.mgmt.videoanalyzer.models.VideoSink +module: azure.mgmt.videoanalyzer.models +summary: 'Video sink in a live topology allows for video and audio to be captured, + optionally archived, and published via a video resource. If archiving is enabled, + this results in a video of type ''archive''. If used in a batch topology, this allows + for video and audio to be stored as a file, and published via a video resource of + type ''file''. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'VideoSink(*, name: str, inputs: List[NodeInput], video_name: str, video_creation_properties: + VideoCreationProperties | None = None, video_publishing_options: VideoPublishingOptions + | None = None, **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: name + description: Required. Node name. Must be unique within the topology. + isRequired: true + types: + - + - name: inputs + description: 'Required. An array of upstream node references within the topology + to be used as + + inputs for this node.' + isRequired: true + types: + - [] + - name: video_name + description: 'Required. Name of a new or existing video resource used to capture + and + + publish content. Note: if downstream of RTSP source, and if disableArchive is + set to true, then + + no content is archived.' + isRequired: true + types: + - + - name: video_creation_properties + description: 'Optional video properties to be used in case a new video + + resource needs to be created on the service.' + isRequired: true + types: + - + - name: video_publishing_options + description: 'Options to change how the video sink publishes content via the + + video resource. This property is only allowed for topologies where "kind" is + set to "live".' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: inputs + isRequired: true + - name: video_name + isRequired: true + - name: video_creation_properties + isRequired: true + - name: video_publishing_options + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoSource.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoSource.yml new file mode 100644 index 00000000..be80ef26 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoSource.yml @@ -0,0 +1,48 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.models.VideoSource +name: VideoSource +fullName: azure.mgmt.videoanalyzer.models.VideoSource +module: azure.mgmt.videoanalyzer.models +summary: 'Video source allows for content from a Video Analyzer video resource to + be ingested into a pipeline. Currently supported only with batch pipelines. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'VideoSource(*, name: str, video_name: str, time_sequences: TimeSequenceBase, + **kwargs)' + parameters: + - name: type + description: Required. The discriminator for derived types.Constant filled by + server. + isRequired: true + types: + - + - name: name + description: Required. Node name. Must be unique within the topology. + isRequired: true + types: + - + - name: video_name + description: 'Required. Name of the Video Analyzer video resource to be used as + the + + source.' + isRequired: true + types: + - + - name: time_sequences + description: 'Required. Describes a sequence of datetime ranges. The video source + only + + picks up recorded media within these ranges.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: video_name + isRequired: true + - name: time_sequences + isRequired: true diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoType.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoType.yml new file mode 100644 index 00000000..08ae02d2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoType.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.videoanalyzer.models.VideoType +name: VideoType +fullName: azure.mgmt.videoanalyzer.models.VideoType +summary: 'Video content type. Different content types are suitable for different applications + and + + scenarios.' +module: azure.mgmt.videoanalyzer.models +fields: +- name: ARCHIVE + uid: azure.mgmt.videoanalyzer.models.VideoType.ARCHIVE +- name: FILE + uid: azure.mgmt.videoanalyzer.models.VideoType.FILE diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.yml new file mode 100644 index 00000000..66be7a5b --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.videoanalyzer.models +name: models +fullName: azure.mgmt.videoanalyzer.models +type: import +classes: +- azure.mgmt.videoanalyzer.models.AccessPolicyEntity +- azure.mgmt.videoanalyzer.models.AccessPolicyEntityCollection +- azure.mgmt.videoanalyzer.models.AccountEncryption +- azure.mgmt.videoanalyzer.models.AudioEncoderAac +- azure.mgmt.videoanalyzer.models.AudioEncoderBase +- azure.mgmt.videoanalyzer.models.AuthenticationBase +- azure.mgmt.videoanalyzer.models.CertificateSource +- azure.mgmt.videoanalyzer.models.CheckNameAvailabilityRequest +- azure.mgmt.videoanalyzer.models.CheckNameAvailabilityResponse +- azure.mgmt.videoanalyzer.models.CredentialsBase +- azure.mgmt.videoanalyzer.models.EccTokenKey +- azure.mgmt.videoanalyzer.models.EdgeModuleEntity +- azure.mgmt.videoanalyzer.models.EdgeModuleEntityCollection +- azure.mgmt.videoanalyzer.models.EdgeModuleProvisioningToken +- azure.mgmt.videoanalyzer.models.EncoderCustomPreset +- azure.mgmt.videoanalyzer.models.EncoderPresetBase +- azure.mgmt.videoanalyzer.models.EncoderProcessor +- azure.mgmt.videoanalyzer.models.EncoderSystemPreset +- azure.mgmt.videoanalyzer.models.Endpoint +- azure.mgmt.videoanalyzer.models.EndpointBase +- azure.mgmt.videoanalyzer.models.ErrorAdditionalInfo +- azure.mgmt.videoanalyzer.models.ErrorDetail +- azure.mgmt.videoanalyzer.models.ErrorResponse +- azure.mgmt.videoanalyzer.models.GroupLevelAccessControl +- azure.mgmt.videoanalyzer.models.IotHub +- azure.mgmt.videoanalyzer.models.JwtAuthentication +- azure.mgmt.videoanalyzer.models.KeyVaultProperties +- azure.mgmt.videoanalyzer.models.ListProvisioningTokenInput +- azure.mgmt.videoanalyzer.models.LivePipeline +- azure.mgmt.videoanalyzer.models.LivePipelineCollection +- azure.mgmt.videoanalyzer.models.LivePipelineOperationStatus +- azure.mgmt.videoanalyzer.models.LivePipelineUpdate +- azure.mgmt.videoanalyzer.models.LogSpecification +- azure.mgmt.videoanalyzer.models.MetricDimension +- azure.mgmt.videoanalyzer.models.MetricSpecification +- azure.mgmt.videoanalyzer.models.NetworkAccessControl +- azure.mgmt.videoanalyzer.models.NodeBase +- azure.mgmt.videoanalyzer.models.NodeInput +- azure.mgmt.videoanalyzer.models.Operation +- azure.mgmt.videoanalyzer.models.OperationCollection +- azure.mgmt.videoanalyzer.models.OperationDisplay +- azure.mgmt.videoanalyzer.models.ParameterDeclaration +- azure.mgmt.videoanalyzer.models.ParameterDefinition +- azure.mgmt.videoanalyzer.models.PemCertificateList +- azure.mgmt.videoanalyzer.models.PipelineJob +- azure.mgmt.videoanalyzer.models.PipelineJobCollection +- azure.mgmt.videoanalyzer.models.PipelineJobError +- azure.mgmt.videoanalyzer.models.PipelineJobOperationStatus +- azure.mgmt.videoanalyzer.models.PipelineJobUpdate +- azure.mgmt.videoanalyzer.models.PipelineTopology +- azure.mgmt.videoanalyzer.models.PipelineTopologyCollection +- azure.mgmt.videoanalyzer.models.PipelineTopologyUpdate +- azure.mgmt.videoanalyzer.models.PrivateEndpoint +- azure.mgmt.videoanalyzer.models.PrivateEndpointConnection +- azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionListResult +- azure.mgmt.videoanalyzer.models.PrivateLinkResource +- azure.mgmt.videoanalyzer.models.PrivateLinkResourceListResult +- azure.mgmt.videoanalyzer.models.PrivateLinkServiceConnectionState +- azure.mgmt.videoanalyzer.models.ProcessorNodeBase +- azure.mgmt.videoanalyzer.models.Properties +- azure.mgmt.videoanalyzer.models.ProxyResource +- azure.mgmt.videoanalyzer.models.Resource +- azure.mgmt.videoanalyzer.models.ResourceIdentity +- azure.mgmt.videoanalyzer.models.RsaTokenKey +- azure.mgmt.videoanalyzer.models.RtspSource +- azure.mgmt.videoanalyzer.models.SecureIotDeviceRemoteTunnel +- azure.mgmt.videoanalyzer.models.ServiceSpecification +- azure.mgmt.videoanalyzer.models.SinkNodeBase +- azure.mgmt.videoanalyzer.models.Sku +- azure.mgmt.videoanalyzer.models.SourceNodeBase +- azure.mgmt.videoanalyzer.models.StorageAccount +- azure.mgmt.videoanalyzer.models.SystemData +- azure.mgmt.videoanalyzer.models.TimeSequenceBase +- azure.mgmt.videoanalyzer.models.TlsEndpoint +- azure.mgmt.videoanalyzer.models.TlsValidationOptions +- azure.mgmt.videoanalyzer.models.TokenClaim +- azure.mgmt.videoanalyzer.models.TokenKey +- azure.mgmt.videoanalyzer.models.TrackedResource +- azure.mgmt.videoanalyzer.models.TunnelBase +- azure.mgmt.videoanalyzer.models.UnsecuredEndpoint +- azure.mgmt.videoanalyzer.models.UserAssignedManagedIdentity +- azure.mgmt.videoanalyzer.models.UsernamePasswordCredentials +- azure.mgmt.videoanalyzer.models.VideoAnalyzer +- azure.mgmt.videoanalyzer.models.VideoAnalyzerCollection +- azure.mgmt.videoanalyzer.models.VideoAnalyzerIdentity +- azure.mgmt.videoanalyzer.models.VideoAnalyzerOperationStatus +- azure.mgmt.videoanalyzer.models.VideoAnalyzerPrivateEndpointConnectionOperationStatus +- azure.mgmt.videoanalyzer.models.VideoAnalyzerUpdate +- azure.mgmt.videoanalyzer.models.VideoArchival +- azure.mgmt.videoanalyzer.models.VideoContentToken +- azure.mgmt.videoanalyzer.models.VideoContentUrls +- azure.mgmt.videoanalyzer.models.VideoCreationProperties +- azure.mgmt.videoanalyzer.models.VideoEncoderBase +- azure.mgmt.videoanalyzer.models.VideoEncoderH264 +- azure.mgmt.videoanalyzer.models.VideoEntity +- azure.mgmt.videoanalyzer.models.VideoEntityCollection +- azure.mgmt.videoanalyzer.models.VideoFlags +- azure.mgmt.videoanalyzer.models.VideoMediaInfo +- azure.mgmt.videoanalyzer.models.VideoPreviewImageUrls +- azure.mgmt.videoanalyzer.models.VideoPublishingOptions +- azure.mgmt.videoanalyzer.models.VideoScale +- azure.mgmt.videoanalyzer.models.VideoSequenceAbsoluteTimeMarkers +- azure.mgmt.videoanalyzer.models.VideoSink +- azure.mgmt.videoanalyzer.models.VideoSource +enums: +- azure.mgmt.videoanalyzer.models.AccessPolicyEccAlgo +- azure.mgmt.videoanalyzer.models.AccessPolicyRole +- azure.mgmt.videoanalyzer.models.AccessPolicyRsaAlgo +- azure.mgmt.videoanalyzer.models.AccountEncryptionKeyType +- azure.mgmt.videoanalyzer.models.ActionType +- azure.mgmt.videoanalyzer.models.CheckNameAvailabilityReason +- azure.mgmt.videoanalyzer.models.CreatedByType +- azure.mgmt.videoanalyzer.models.EncoderSystemPresetType +- azure.mgmt.videoanalyzer.models.Kind +- azure.mgmt.videoanalyzer.models.LivePipelineState +- azure.mgmt.videoanalyzer.models.MetricAggregationType +- azure.mgmt.videoanalyzer.models.MetricUnit +- azure.mgmt.videoanalyzer.models.ParameterType +- azure.mgmt.videoanalyzer.models.PipelineJobState +- azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionProvisioningState +- azure.mgmt.videoanalyzer.models.PrivateEndpointServiceConnectionStatus +- azure.mgmt.videoanalyzer.models.ProvisioningState +- azure.mgmt.videoanalyzer.models.PublicNetworkAccess +- azure.mgmt.videoanalyzer.models.RtspTransport +- azure.mgmt.videoanalyzer.models.SkuName +- azure.mgmt.videoanalyzer.models.SkuTier +- azure.mgmt.videoanalyzer.models.VideoAnalyzerEndpointType +- azure.mgmt.videoanalyzer.models.VideoScaleMode +- azure.mgmt.videoanalyzer.models.VideoType diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.AccessPoliciesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.AccessPoliciesOperations.yml new file mode 100644 index 00000000..f646ac69 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.AccessPoliciesOperations.yml @@ -0,0 +1,229 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.operations.AccessPoliciesOperations +name: AccessPoliciesOperations +fullName: azure.mgmt.videoanalyzer.operations.AccessPoliciesOperations +module: azure.mgmt.videoanalyzer.operations +summary: 'AccessPoliciesOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: AccessPoliciesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.operations.AccessPoliciesOperations.create_or_update + name: create_or_update + summary: 'Creates a new access policy resource or updates an existing one. + + + Creates a new access policy resource or updates an existing one with the given + name.' + signature: 'create_or_update(resource_group_name: str, account_name: str, access_policy_name: + str, parameters: ''_models.AccessPolicyEntity'', **kwargs: Any) -> _models.AccessPolicyEntity' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: access_policy_name + description: The Access Policy name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AccessPolicyEntity, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.AccessPoliciesOperations.delete + name: delete + summary: 'Deletes an existing access policy resource. + + + Deletes an existing access policy resource with the given name.' + signature: 'delete(resource_group_name: str, account_name: str, access_policy_name: + str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: access_policy_name + description: The Access Policy name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.AccessPoliciesOperations.get + name: get + summary: 'Retrieves an existing access policy resource. + + + Retrieves an existing access policy resource with the given name.' + signature: 'get(resource_group_name: str, account_name: str, access_policy_name: + str, **kwargs: Any) -> _models.AccessPolicyEntity' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: access_policy_name + description: The Access Policy name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AccessPolicyEntity, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.AccessPoliciesOperations.list + name: list + summary: 'List all existing access policy resources. + + + Retrieves all existing access policy resources, along with their JSON representations.' + signature: 'list(resource_group_name: str, account_name: str, top: int | None = + None, **kwargs: Any) -> Iterable[''_models.AccessPolicyEntityCollection'']' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: top + description: 'Specifies a non-negative integer n that limits the number of items + returned from a + + collection. The service returns the number of available items up to but not + greater than the + + specified value n.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either AccessPolicyEntityCollection + or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.AccessPoliciesOperations.update + name: update + summary: 'Updates individual properties of an existing access policy resource. + + + Updates individual properties of an existing access policy resource with the given + name.' + signature: 'update(resource_group_name: str, account_name: str, access_policy_name: + str, parameters: ''_models.AccessPolicyEntity'', **kwargs: Any) -> _models.AccessPolicyEntity' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: access_policy_name + description: The Access Policy name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AccessPolicyEntity, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.operations.AccessPoliciesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.EdgeModulesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.EdgeModulesOperations.yml new file mode 100644 index 00000000..e4acd3cc --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.EdgeModulesOperations.yml @@ -0,0 +1,269 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.operations.EdgeModulesOperations +name: EdgeModulesOperations +fullName: azure.mgmt.videoanalyzer.operations.EdgeModulesOperations +module: azure.mgmt.videoanalyzer.operations +summary: 'EdgeModulesOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: EdgeModulesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.operations.EdgeModulesOperations.create_or_update + name: create_or_update + summary: 'Creates a new edge module or updates an existing one. + + + Creates a new edge module or updates an existing one. An edge module resource + enables a single + + instance of an Azure Video Analyzer IoT edge module to interact with the Video + Analyzer + + Account. This is used for authorization and also to make sure that the particular + edge module + + instance only has access to the data it requires from the Azure Video Analyzer + service. A new + + edge module resource should be created for every new instance of an Azure Video + Analyzer edge + + module deployed to you Azure IoT edge environment. Edge module resources can be + deleted if the + + specific module is not in use anymore.' + signature: 'create_or_update(resource_group_name: str, account_name: str, edge_module_name: + str, parameters: ''_models.EdgeModuleEntity'', **kwargs: Any) -> _models.EdgeModuleEntity' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: edge_module_name + description: The Edge Module name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: EdgeModuleEntity, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.EdgeModulesOperations.delete + name: delete + summary: 'Deletes an existing edge module resource. + + + Deletes an existing edge module resource. Deleting the edge module resource will + prevent an + + Azure Video Analyzer IoT edge module which was previously initiated with the module + + provisioning token from communicating with the cloud.' + signature: 'delete(resource_group_name: str, account_name: str, edge_module_name: + str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: edge_module_name + description: The Edge Module name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.EdgeModulesOperations.get + name: get + summary: 'Retrieves an existing edge module resource. + + + Retrieves an existing edge module resource with the given name.' + signature: 'get(resource_group_name: str, account_name: str, edge_module_name: str, + **kwargs: Any) -> _models.EdgeModuleEntity' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: edge_module_name + description: The Edge Module name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: EdgeModuleEntity, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.EdgeModulesOperations.list + name: list + summary: 'List all existing edge module resources. + + + List all existing edge module resources, along with their JSON representations.' + signature: 'list(resource_group_name: str, account_name: str, top: int | None = + None, **kwargs: Any) -> Iterable[''_models.EdgeModuleEntityCollection'']' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: top + description: 'Specifies a non-negative integer n that limits the number of items + returned from a + + collection. The service returns the number of available items up to but not + greater than the + + specified value n.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either EdgeModuleEntityCollection or + the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.EdgeModulesOperations.list_provisioning_token + name: list_provisioning_token + summary: 'Creates a new provisioning token. + + + Creates a new provisioning token. A provisioning token allows for a single instance + of Azure + + Video analyzer IoT edge module to be initialized and authorized to the cloud account. + The + + provisioning token itself is short lived and it is only used for the initial handshake + between + + IoT edge module and the cloud. After the initial handshake, the IoT edge module + will agree on a + + set of authentication keys which will be auto-rotated as long as the module is + able to + + periodically connect to the cloud. A new provisioning token can be generated for + the same IoT + + edge module in case the module state lost or reset.' + signature: 'list_provisioning_token(resource_group_name: str, account_name: str, + edge_module_name: str, parameters: ''_models.ListProvisioningTokenInput'', **kwargs: + Any) -> _models.EdgeModuleProvisioningToken' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: edge_module_name + description: The Edge Module name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: EdgeModuleProvisioningToken, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.operations.EdgeModulesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.LivePipelineOperationStatusesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.LivePipelineOperationStatusesOperations.yml new file mode 100644 index 00000000..68423a5a --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.LivePipelineOperationStatusesOperations.yml @@ -0,0 +1,75 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.operations.LivePipelineOperationStatusesOperations +name: LivePipelineOperationStatusesOperations +fullName: azure.mgmt.videoanalyzer.operations.LivePipelineOperationStatusesOperations +module: azure.mgmt.videoanalyzer.operations +summary: 'LivePipelineOperationStatusesOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: LivePipelineOperationStatusesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.operations.LivePipelineOperationStatusesOperations.get + name: get + summary: 'Get the operation status. + + + Get the operation status of a live pipeline.' + signature: 'get(resource_group_name: str, account_name: str, live_pipeline_name: + str, operation_id: str, **kwargs: Any) -> _models.LivePipelineOperationStatus' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: live_pipeline_name + description: Live pipeline unique identifier. + isRequired: true + types: + - + - name: operation_id + description: The operation ID. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LivePipelineOperationStatus, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.operations.LivePipelineOperationStatusesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.LivePipelinesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.LivePipelinesOperations.yml new file mode 100644 index 00000000..4b9fafea --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.LivePipelinesOperations.yml @@ -0,0 +1,349 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.operations.LivePipelinesOperations +name: LivePipelinesOperations +fullName: azure.mgmt.videoanalyzer.operations.LivePipelinesOperations +module: azure.mgmt.videoanalyzer.operations +summary: 'LivePipelinesOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: LivePipelinesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.operations.LivePipelinesOperations.begin_activate + name: begin_activate + summary: 'Activates a live pipeline. + + + Activates a live pipeline with the given name.' + signature: 'begin_activate(resource_group_name: str, account_name: str, live_pipeline_name: + str, **kwargs: Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: live_pipeline_name + description: Live pipeline unique identifier. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.LivePipelinesOperations.begin_deactivate + name: begin_deactivate + summary: 'Deactivates a live pipeline. + + + Deactivates a live pipeline with the given name.' + signature: 'begin_deactivate(resource_group_name: str, account_name: str, live_pipeline_name: + str, **kwargs: Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: live_pipeline_name + description: Live pipeline unique identifier. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.LivePipelinesOperations.create_or_update + name: create_or_update + summary: 'Creates or updates a live pipeline. + + + Creates a new live pipeline or updates an existing one, with the given name.' + signature: 'create_or_update(resource_group_name: str, account_name: str, live_pipeline_name: + str, parameters: ''_models.LivePipeline'', **kwargs: Any) -> _models.LivePipeline' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: live_pipeline_name + description: Live pipeline unique identifier. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LivePipeline, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.LivePipelinesOperations.delete + name: delete + summary: 'Deletes a live pipeline. + + + Deletes a live pipeline with the given name.' + signature: 'delete(resource_group_name: str, account_name: str, live_pipeline_name: + str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: live_pipeline_name + description: Live pipeline unique identifier. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.LivePipelinesOperations.get + name: get + summary: 'Retrieves a specific live pipeline by name. + + + Retrieves a specific live pipeline by name. If a live pipeline with that name + has been + + previously created, the call will return the JSON representation of that instance.' + signature: 'get(resource_group_name: str, account_name: str, live_pipeline_name: + str, **kwargs: Any) -> _models.LivePipeline' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: live_pipeline_name + description: Live pipeline unique identifier. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LivePipeline, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.LivePipelinesOperations.list + name: list + summary: 'Retrieves a list of live pipelines. + + + Retrieves a list of live pipelines that have been created, along with their JSON + + representations.' + signature: 'list(resource_group_name: str, account_name: str, filter: str | None + = None, top: int | None = None, **kwargs: Any) -> Iterable[''_models.LivePipelineCollection'']' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: filter + description: Restricts the set of items returned. + defaultValue: None + types: + - + - name: top + description: 'Specifies a non-negative integer n that limits the number of items + returned from a + + collection. The service returns the number of available items up to but not + greater than the + + specified value n.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either LivePipelineCollection or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.LivePipelinesOperations.update + name: update + summary: 'Updates an existing live pipeline. + + + Updates an existing live pipeline with the given name. Properties that can be + updated include: + + description, bitrateKbps, and parameter definitions. Only the description can + be updated while + + the live pipeline is active.' + signature: 'update(resource_group_name: str, account_name: str, live_pipeline_name: + str, parameters: ''_models.LivePipelineUpdate'', **kwargs: Any) -> _models.LivePipeline' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: live_pipeline_name + description: Live pipeline unique identifier. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LivePipeline, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.operations.LivePipelinesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.LocationsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.LocationsOperations.yml new file mode 100644 index 00000000..636343fd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.LocationsOperations.yml @@ -0,0 +1,65 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.operations.LocationsOperations +name: LocationsOperations +fullName: azure.mgmt.videoanalyzer.operations.LocationsOperations +module: azure.mgmt.videoanalyzer.operations +summary: 'LocationsOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: LocationsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.operations.LocationsOperations.check_name_availability + name: check_name_availability + summary: 'Check Name Availability. + + + Checks whether the Video Analyzer resource name is available.' + signature: 'check_name_availability(location_name: str, parameters: ''_models.CheckNameAvailabilityRequest'', + **kwargs: Any) -> _models.CheckNameAvailabilityResponse' + parameters: + - name: location_name + description: Location Name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: CheckNameAvailabilityResponse, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.operations.LocationsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.OperationResultsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.OperationResultsOperations.yml new file mode 100644 index 00000000..0f84b3ab --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.OperationResultsOperations.yml @@ -0,0 +1,76 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.operations.OperationResultsOperations +name: OperationResultsOperations +fullName: azure.mgmt.videoanalyzer.operations.OperationResultsOperations +module: azure.mgmt.videoanalyzer.operations +summary: 'OperationResultsOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: OperationResultsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.operations.OperationResultsOperations.get + name: get + summary: 'Get operation result. + + + Get private endpoint connection operation result.' + signature: 'get(resource_group_name: str, account_name: str, name: str, operation_id: + str, **kwargs: Any) -> ''_models.PrivateEndpointConnection'' | None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + - name: name + description: Private endpoint connection name. + isRequired: true + types: + - + - name: operation_id + description: Operation Id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PrivateEndpointConnection, or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.operations.OperationResultsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.OperationStatusesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.OperationStatusesOperations.yml new file mode 100644 index 00000000..129183dd --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.OperationStatusesOperations.yml @@ -0,0 +1,76 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.operations.OperationStatusesOperations +name: OperationStatusesOperations +fullName: azure.mgmt.videoanalyzer.operations.OperationStatusesOperations +module: azure.mgmt.videoanalyzer.operations +summary: 'OperationStatusesOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: OperationStatusesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.operations.OperationStatusesOperations.get + name: get + summary: 'Get operation status. + + + Get private endpoint connection operation status.' + signature: 'get(resource_group_name: str, account_name: str, name: str, operation_id: + str, **kwargs: Any) -> _models.VideoAnalyzerPrivateEndpointConnectionOperationStatus' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + - name: name + description: Private endpoint connection name. + isRequired: true + types: + - + - name: operation_id + description: Operation Id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VideoAnalyzerPrivateEndpointConnectionOperationStatus, or the result + of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.operations.OperationStatusesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.Operations.yml new file mode 100644 index 00000000..a845ff18 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.Operations.yml @@ -0,0 +1,53 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.operations.Operations +name: Operations +fullName: azure.mgmt.videoanalyzer.operations.Operations +module: azure.mgmt.videoanalyzer.operations +summary: 'Operations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: Operations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.operations.Operations.list + name: list + summary: 'List Operations. + + + Lists all the Media operations.' + signature: 'list(**kwargs: Any) -> _models.OperationCollection' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: OperationCollection, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.PipelineJobOperationStatusesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.PipelineJobOperationStatusesOperations.yml new file mode 100644 index 00000000..6d868cb8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.PipelineJobOperationStatusesOperations.yml @@ -0,0 +1,75 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.operations.PipelineJobOperationStatusesOperations +name: PipelineJobOperationStatusesOperations +fullName: azure.mgmt.videoanalyzer.operations.PipelineJobOperationStatusesOperations +module: azure.mgmt.videoanalyzer.operations +summary: 'PipelineJobOperationStatusesOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: PipelineJobOperationStatusesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.operations.PipelineJobOperationStatusesOperations.get + name: get + summary: 'Get the operation statuses. + + + Get the operation status of a pipeline job with the given operationId.' + signature: 'get(resource_group_name: str, account_name: str, pipeline_job_name: + str, operation_id: str, **kwargs: Any) -> _models.PipelineJobOperationStatus' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: pipeline_job_name + description: The pipeline job name. + isRequired: true + types: + - + - name: operation_id + description: The operation ID. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PipelineJobOperationStatus, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.operations.PipelineJobOperationStatusesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.PipelineJobsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.PipelineJobsOperations.yml new file mode 100644 index 00000000..939e5b9f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.PipelineJobsOperations.yml @@ -0,0 +1,294 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.operations.PipelineJobsOperations +name: PipelineJobsOperations +fullName: azure.mgmt.videoanalyzer.operations.PipelineJobsOperations +module: azure.mgmt.videoanalyzer.operations +summary: 'PipelineJobsOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: PipelineJobsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.operations.PipelineJobsOperations.begin_cancel + name: begin_cancel + summary: 'Cancels a pipeline job. + + + Cancels a pipeline job with the given name.' + signature: 'begin_cancel(resource_group_name: str, account_name: str, pipeline_job_name: + str, **kwargs: Any) -> LROPoller[None]' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: pipeline_job_name + description: The pipeline job name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.PipelineJobsOperations.create_or_update + name: create_or_update + summary: 'Creates or updates a pipeline job. + + + Creates a new pipeline job or updates an existing one, with the given name.' + signature: 'create_or_update(resource_group_name: str, account_name: str, pipeline_job_name: + str, parameters: ''_models.PipelineJob'', **kwargs: Any) -> _models.PipelineJob' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: pipeline_job_name + description: The pipeline job name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PipelineJob, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.PipelineJobsOperations.delete + name: delete + summary: 'Deletes a pipeline job. + + + Deletes a pipeline job with the given name.' + signature: 'delete(resource_group_name: str, account_name: str, pipeline_job_name: + str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: pipeline_job_name + description: The pipeline job name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.PipelineJobsOperations.get + name: get + summary: 'Gets a specific pipeline job by name. + + + Retrieves a specific pipeline job by name. If a pipeline job with that name has + been previously + + created, the call will return the JSON representation of that instance.' + signature: 'get(resource_group_name: str, account_name: str, pipeline_job_name: + str, **kwargs: Any) -> _models.PipelineJob' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: pipeline_job_name + description: The pipeline job name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PipelineJob, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.PipelineJobsOperations.list + name: list + summary: 'Retrieves a list of pipeline jobs. + + + Retrieves a list of all live pipelines that have been created, along with their + JSON + + representations.' + signature: 'list(resource_group_name: str, account_name: str, filter: str | None + = None, top: int | None = None, **kwargs: Any) -> Iterable[''_models.PipelineJobCollection'']' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: filter + description: Restricts the set of items returned. + defaultValue: None + types: + - + - name: top + description: 'Specifies a non-negative integer n that limits the number of items + returned from a + + collection. The service returns the number of available items up to but not + greater than the + + specified value n.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either PipelineJobCollection or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.PipelineJobsOperations.update + name: update + summary: 'Updates an existing pipeline job. + + + Updates an existing pipeline job with the given name. Properties that can be updated + include: + + description.' + signature: 'update(resource_group_name: str, account_name: str, pipeline_job_name: + str, parameters: ''_models.PipelineJobUpdate'', **kwargs: Any) -> _models.PipelineJob' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: pipeline_job_name + description: The pipeline job name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PipelineJob, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.operations.PipelineJobsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.PipelineTopologiesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.PipelineTopologiesOperations.yml new file mode 100644 index 00000000..4d514a0d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.PipelineTopologiesOperations.yml @@ -0,0 +1,259 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.operations.PipelineTopologiesOperations +name: PipelineTopologiesOperations +fullName: azure.mgmt.videoanalyzer.operations.PipelineTopologiesOperations +module: azure.mgmt.videoanalyzer.operations +summary: 'PipelineTopologiesOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: PipelineTopologiesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.operations.PipelineTopologiesOperations.create_or_update + name: create_or_update + summary: 'Creates or updates a pipeline topology. + + + Creates a new pipeline topology or updates an existing one, with the given name. + A pipeline + + topology describes the processing steps to be applied when processing content + for a particular + + outcome. The topology should be defined according to the scenario to be achieved + and can be + + reused across many pipeline instances which share the same processing characteristics.' + signature: 'create_or_update(resource_group_name: str, account_name: str, pipeline_topology_name: + str, parameters: ''_models.PipelineTopology'', **kwargs: Any) -> _models.PipelineTopology' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: pipeline_topology_name + description: Pipeline topology unique identifier. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PipelineTopology, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.PipelineTopologiesOperations.delete + name: delete + summary: 'Deletes a pipeline topology. + + + Deletes a pipeline topology with the given name. This method should be called + after all + + instances of the topology have been stopped and deleted.' + signature: 'delete(resource_group_name: str, account_name: str, pipeline_topology_name: + str, **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: pipeline_topology_name + description: Pipeline topology unique identifier. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.PipelineTopologiesOperations.get + name: get + summary: 'Retrieves a specific pipeline topology by name. + + + Retrieves a specific pipeline topology by name. If a topology with that name has + been + + previously created, the call will return the JSON representation of that topology.' + signature: 'get(resource_group_name: str, account_name: str, pipeline_topology_name: + str, **kwargs: Any) -> _models.PipelineTopology' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: pipeline_topology_name + description: Pipeline topology unique identifier. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PipelineTopology, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.PipelineTopologiesOperations.list + name: list + summary: 'Retrieves a list of pipeline topologies. + + + Retrieves a list of pipeline topologies that have been added to the account, if + any, along with + + their JSON representation.' + signature: 'list(resource_group_name: str, account_name: str, filter: str | None + = None, top: int | None = None, **kwargs: Any) -> Iterable[''_models.PipelineTopologyCollection'']' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: filter + description: Restricts the set of items returned. + defaultValue: None + types: + - + - name: top + description: 'Specifies a non-negative integer n that limits the number of items + returned from a + + collection. The service returns the number of available items up to but not + greater than the + + specified value n.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either PipelineTopologyCollection or + the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.PipelineTopologiesOperations.update + name: update + summary: 'Updates an existing pipeline topology. + + + Updates an existing pipeline topology with the given name. If the associated live + pipelines or + + pipeline jobs are in active or processing state, respectively, then only the description + can be + + updated. Else, the properties that can be updated include: description, parameter + declarations, + + sources, processors, and sinks.' + signature: 'update(resource_group_name: str, account_name: str, pipeline_topology_name: + str, parameters: ''_models.PipelineTopologyUpdate'', **kwargs: Any) -> _models.PipelineTopology' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: pipeline_topology_name + description: Pipeline topology unique identifier. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PipelineTopology, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.operations.PipelineTopologiesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.PrivateEndpointConnectionsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.PrivateEndpointConnectionsOperations.yml new file mode 100644 index 00000000..02b0e041 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.PrivateEndpointConnectionsOperations.yml @@ -0,0 +1,175 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.operations.PrivateEndpointConnectionsOperations +name: PrivateEndpointConnectionsOperations +fullName: azure.mgmt.videoanalyzer.operations.PrivateEndpointConnectionsOperations +module: azure.mgmt.videoanalyzer.operations +summary: 'PrivateEndpointConnectionsOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: PrivateEndpointConnectionsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.operations.PrivateEndpointConnectionsOperations.create_or_update + name: create_or_update + summary: 'Update private endpoint connection. + + + Update private endpoint connection state under video analyzer account.' + signature: 'create_or_update(resource_group_name: str, account_name: str, name: + str, parameters: ''_models.PrivateEndpointConnection'', **kwargs: Any) -> _models.PrivateEndpointConnection' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + - name: name + description: Private endpoint connection name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PrivateEndpointConnection, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.PrivateEndpointConnectionsOperations.delete + name: delete + summary: 'Delete private endpoint connection. + + + Delete private endpoint connection under video analyzer account.' + signature: 'delete(resource_group_name: str, account_name: str, name: str, **kwargs: + Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + - name: name + description: Private endpoint connection name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.PrivateEndpointConnectionsOperations.get + name: get + summary: 'Get private endpoint connection. + + + Get private endpoint connection under video analyzer account.' + signature: 'get(resource_group_name: str, account_name: str, name: str, **kwargs: + Any) -> _models.PrivateEndpointConnection' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + - name: name + description: Private endpoint connection name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PrivateEndpointConnection, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.PrivateEndpointConnectionsOperations.list + name: list + summary: 'Get all private endpoint connections. + + + Get all private endpoint connections under video analyzer account.' + signature: 'list(resource_group_name: str, account_name: str, **kwargs: Any) -> + _models.PrivateEndpointConnectionListResult' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PrivateEndpointConnectionListResult, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.operations.PrivateEndpointConnectionsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.PrivateLinkResourcesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.PrivateLinkResourcesOperations.yml new file mode 100644 index 00000000..be1fe581 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.PrivateLinkResourcesOperations.yml @@ -0,0 +1,100 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.operations.PrivateLinkResourcesOperations +name: PrivateLinkResourcesOperations +fullName: azure.mgmt.videoanalyzer.operations.PrivateLinkResourcesOperations +module: azure.mgmt.videoanalyzer.operations +summary: 'PrivateLinkResourcesOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: PrivateLinkResourcesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.operations.PrivateLinkResourcesOperations.get + name: get + summary: 'Get group ID. + + + Get group ID for video analyzer account.' + signature: 'get(resource_group_name: str, account_name: str, name: str, **kwargs: + Any) -> _models.PrivateLinkResource' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + - name: name + description: Name of the private link resource (Group ID). + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PrivateLinkResource, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.PrivateLinkResourcesOperations.list + name: list + summary: 'Get list of group IDs. + + + Get list of group IDs for video analyzer account.' + signature: 'list(resource_group_name: str, account_name: str, **kwargs: Any) -> + _models.PrivateLinkResourceListResult' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PrivateLinkResourceListResult, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.operations.PrivateLinkResourcesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.VideoAnalyzerOperationResultsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.VideoAnalyzerOperationResultsOperations.yml new file mode 100644 index 00000000..7ebb42d5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.VideoAnalyzerOperationResultsOperations.yml @@ -0,0 +1,66 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.operations.VideoAnalyzerOperationResultsOperations +name: VideoAnalyzerOperationResultsOperations +fullName: azure.mgmt.videoanalyzer.operations.VideoAnalyzerOperationResultsOperations +module: azure.mgmt.videoanalyzer.operations +summary: 'VideoAnalyzerOperationResultsOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: VideoAnalyzerOperationResultsOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.operations.VideoAnalyzerOperationResultsOperations.get + name: get + summary: 'Get operation result. + + + Get video analyzer operation result.' + signature: 'get(location_name: str, operation_id: str, **kwargs: Any) -> ''_models.VideoAnalyzer'' + | None' + parameters: + - name: location_name + description: Location name. + isRequired: true + types: + - + - name: operation_id + description: Operation Id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VideoAnalyzer, or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.operations.VideoAnalyzerOperationResultsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.VideoAnalyzerOperationStatusesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.VideoAnalyzerOperationStatusesOperations.yml new file mode 100644 index 00000000..0db32288 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.VideoAnalyzerOperationStatusesOperations.yml @@ -0,0 +1,64 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.operations.VideoAnalyzerOperationStatusesOperations +name: VideoAnalyzerOperationStatusesOperations +fullName: azure.mgmt.videoanalyzer.operations.VideoAnalyzerOperationStatusesOperations +module: azure.mgmt.videoanalyzer.operations +summary: 'VideoAnalyzerOperationStatusesOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: VideoAnalyzerOperationStatusesOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.operations.VideoAnalyzerOperationStatusesOperations.get + name: get + summary: 'Get operation status. + + + Get video analyzer operation status.' + signature: 'get(location_name: str, operation_id: str, **kwargs: Any) -> _models.VideoAnalyzerOperationStatus' + parameters: + - name: location_name + description: Location name. + isRequired: true + types: + - + - name: operation_id + description: Operation Id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VideoAnalyzerOperationStatus, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.operations.VideoAnalyzerOperationStatusesOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.VideoAnalyzersOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.VideoAnalyzersOperations.yml new file mode 100644 index 00000000..a886e781 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.VideoAnalyzersOperations.yml @@ -0,0 +1,242 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.operations.VideoAnalyzersOperations +name: VideoAnalyzersOperations +fullName: azure.mgmt.videoanalyzer.operations.VideoAnalyzersOperations +module: azure.mgmt.videoanalyzer.operations +summary: 'VideoAnalyzersOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: VideoAnalyzersOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.operations.VideoAnalyzersOperations.begin_create_or_update + name: begin_create_or_update + summary: 'Create or update a Video Analyzer account. + + + Create or update an instance of a Video Analyzer account.' + signature: 'begin_create_or_update(resource_group_name: str, account_name: str, + parameters: ''_models.VideoAnalyzer'', **kwargs: Any) -> LROPoller[''_models.VideoAnalyzer'']' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either VideoAnalyzer or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.VideoAnalyzersOperations.begin_update + name: begin_update + summary: 'Update a Video Analyzer account. + + + Updates an existing instance of Video Analyzer account.' + signature: 'begin_update(resource_group_name: str, account_name: str, parameters: + ''_models.VideoAnalyzerUpdate'', **kwargs: Any) -> LROPoller[''_models.VideoAnalyzer'']' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be ARMPolling. + + Pass in False for this operation to not poll, or pass in your own initialized + polling object for a personal polling strategy.' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either VideoAnalyzer or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.VideoAnalyzersOperations.delete + name: delete + summary: 'Delete a Video Analyzer account. + + + Delete the specified Video Analyzer account.' + signature: 'delete(resource_group_name: str, account_name: str, **kwargs: Any) -> + None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.VideoAnalyzersOperations.get + name: get + summary: 'Get a Video Analyzer account. + + + Get the details of the specified Video Analyzer account.' + signature: 'get(resource_group_name: str, account_name: str, **kwargs: Any) -> _models.VideoAnalyzer' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Video Analyzer account name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VideoAnalyzer, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.VideoAnalyzersOperations.list + name: list + summary: 'List Video Analyzer accounts. + + + Lists the Video Analyzer accounts in the specified resource group.' + signature: 'list(resource_group_name: str, **kwargs: Any) -> _models.VideoAnalyzerCollection' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VideoAnalyzerCollection, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.VideoAnalyzersOperations.list_by_subscription + name: list_by_subscription + summary: 'List Video Analyzer accounts. + + + List all Video Analyzer accounts in the specified subscription.' + signature: 'list_by_subscription(**kwargs: Any) -> _models.VideoAnalyzerCollection' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VideoAnalyzerCollection, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.operations.VideoAnalyzersOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.VideosOperations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.VideosOperations.yml new file mode 100644 index 00000000..9d0a2c25 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.VideosOperations.yml @@ -0,0 +1,270 @@ +### YamlMime:PythonClass +uid: azure.mgmt.videoanalyzer.operations.VideosOperations +name: VideosOperations +fullName: azure.mgmt.videoanalyzer.operations.VideosOperations +module: azure.mgmt.videoanalyzer.operations +summary: 'VideosOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: VideosOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.mgmt.videoanalyzer.operations.VideosOperations.create_or_update + name: create_or_update + summary: 'Creates a new video resource or updates an existing one. + + + Creates a new video resource or updates an existing video resource with the given + name.' + signature: 'create_or_update(resource_group_name: str, account_name: str, video_name: + str, parameters: ''_models.VideoEntity'', **kwargs: Any) -> _models.VideoEntity' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: video_name + description: The Video name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VideoEntity, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.VideosOperations.delete + name: delete + summary: 'Deletes an existing video resource and its underlying data. + + + Deletes an existing video resource and its underlying data. This operation is + irreversible.' + signature: 'delete(resource_group_name: str, account_name: str, video_name: str, + **kwargs: Any) -> None' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: video_name + description: The Video name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.VideosOperations.get + name: get + summary: 'Retrieves an existing video resource. + + + Retrieves an existing video resource with the given name.' + signature: 'get(resource_group_name: str, account_name: str, video_name: str, **kwargs: + Any) -> _models.VideoEntity' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: video_name + description: The Video name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VideoEntity, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.VideosOperations.list + name: list + summary: 'Retrieves all existing video resources. + + + Retrieves a list of video resources that have been created, along with their JSON + + representations.' + signature: 'list(resource_group_name: str, account_name: str, top: int | None = + None, **kwargs: Any) -> Iterable[''_models.VideoEntityCollection'']' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: top + description: 'Specifies a non-negative integer n that limits the number of items + returned from a + + collection. The service returns the number of available items up to but not + greater than the + + specified value n.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either VideoEntityCollection or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.VideosOperations.list_content_token + name: list_content_token + summary: 'Generates a streaming token which can be used for accessing content from + video content URLs. + + + Generates a streaming token which can be used for accessing content from video + content URLs, + + for a video resource with the given name.' + signature: 'list_content_token(resource_group_name: str, account_name: str, video_name: + str, **kwargs: Any) -> _models.VideoContentToken' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: video_name + description: The Video name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VideoContentToken, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.videoanalyzer.operations.VideosOperations.update + name: update + summary: 'Updates individual properties of an existing video resource. + + + Updates individual properties of an existing video resource with the given name.' + signature: 'update(resource_group_name: str, account_name: str, video_name: str, + parameters: ''_models.VideoEntity'', **kwargs: Any) -> _models.VideoEntity' + parameters: + - name: resource_group_name + description: The name of the resource group. The name is case insensitive. + isRequired: true + types: + - + - name: account_name + description: The Azure Video Analyzer account name. + isRequired: true + types: + - + - name: video_name + description: The Video name. + isRequired: true + types: + - + - name: parameters + description: The request parameters. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: VideoEntity, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.videoanalyzer.operations.VideosOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.yml new file mode 100644 index 00000000..f6cb9c7c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.operations.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.videoanalyzer.operations +name: operations +fullName: azure.mgmt.videoanalyzer.operations +type: import +classes: +- azure.mgmt.videoanalyzer.operations.AccessPoliciesOperations +- azure.mgmt.videoanalyzer.operations.EdgeModulesOperations +- azure.mgmt.videoanalyzer.operations.LivePipelineOperationStatusesOperations +- azure.mgmt.videoanalyzer.operations.LivePipelinesOperations +- azure.mgmt.videoanalyzer.operations.LocationsOperations +- azure.mgmt.videoanalyzer.operations.OperationResultsOperations +- azure.mgmt.videoanalyzer.operations.OperationStatusesOperations +- azure.mgmt.videoanalyzer.operations.Operations +- azure.mgmt.videoanalyzer.operations.PipelineJobOperationStatusesOperations +- azure.mgmt.videoanalyzer.operations.PipelineJobsOperations +- azure.mgmt.videoanalyzer.operations.PipelineTopologiesOperations +- azure.mgmt.videoanalyzer.operations.PrivateEndpointConnectionsOperations +- azure.mgmt.videoanalyzer.operations.PrivateLinkResourcesOperations +- azure.mgmt.videoanalyzer.operations.VideoAnalyzerOperationResultsOperations +- azure.mgmt.videoanalyzer.operations.VideoAnalyzerOperationStatusesOperations +- azure.mgmt.videoanalyzer.operations.VideoAnalyzersOperations +- azure.mgmt.videoanalyzer.operations.VideosOperations diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.yml new file mode 100644 index 00000000..4410fe6c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.videoanalyzer +name: videoanalyzer +fullName: azure.mgmt.videoanalyzer +type: rootImport +classes: +- azure.mgmt.videoanalyzer.VideoAnalyzer +packages: +- azure.mgmt.videoanalyzer.aio +- azure.mgmt.videoanalyzer.models +- azure.mgmt.videoanalyzer.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.WorkloadMonitorAPI.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.WorkloadMonitorAPI.yml new file mode 100644 index 00000000..730eda1d --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.WorkloadMonitorAPI.yml @@ -0,0 +1,40 @@ +### YamlMime:PythonClass +uid: azure.mgmt.workloadmonitor.WorkloadMonitorAPI +name: WorkloadMonitorAPI +fullName: azure.mgmt.workloadmonitor.WorkloadMonitorAPI +module: azure.mgmt.workloadmonitor +summary: Workload Monitor API. +constructor: + syntax: 'WorkloadMonitorAPI(credential: TokenCredential, base_url: str = ''https://management.azure.com'', + **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. Required. + isRequired: true + types: + - + - name: base_url + description: Service URL. Default value is "`https://management.azure.com`". + defaultValue: https://management.azure.com + types: + - + keywordOnlyParameters: + - name: api_version + description: 'Api Version. Default value is "2020-01-13-preview". Note that overriding + + this default value may result in unsupported behavior.' + types: + - +variables: +- description: Operations operations + name: operations + types: + - +- description: HealthMonitorsOperations operations + name: health_monitors + types: + - +methods: +- uid: azure.mgmt.workloadmonitor.WorkloadMonitorAPI.close + name: close + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.WorkloadMonitorAPI.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.WorkloadMonitorAPI.yml new file mode 100644 index 00000000..c2595700 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.WorkloadMonitorAPI.yml @@ -0,0 +1,40 @@ +### YamlMime:PythonClass +uid: azure.mgmt.workloadmonitor.aio.WorkloadMonitorAPI +name: WorkloadMonitorAPI +fullName: azure.mgmt.workloadmonitor.aio.WorkloadMonitorAPI +module: azure.mgmt.workloadmonitor.aio +summary: Workload Monitor API. +constructor: + syntax: 'WorkloadMonitorAPI(credential: AsyncTokenCredential, base_url: str = ''https://management.azure.com'', + **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. Required. + isRequired: true + types: + - + - name: base_url + description: Service URL. Default value is "`https://management.azure.com`". + defaultValue: https://management.azure.com + types: + - + keywordOnlyParameters: + - name: api_version + description: 'Api Version. Default value is "2020-01-13-preview". Note that overriding + + this default value may result in unsupported behavior.' + types: + - +variables: +- description: Operations operations + name: operations + types: + - +- description: HealthMonitorsOperations operations + name: health_monitors + types: + - +methods: +- uid: azure.mgmt.workloadmonitor.aio.WorkloadMonitorAPI.close + name: close + signature: async close() -> None diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.operations.HealthMonitorsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.operations.HealthMonitorsOperations.yml new file mode 100644 index 00000000..dbcbf39e --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.operations.HealthMonitorsOperations.yml @@ -0,0 +1,329 @@ +### YamlMime:PythonClass +uid: azure.mgmt.workloadmonitor.aio.operations.HealthMonitorsOperations +name: HealthMonitorsOperations +fullName: azure.mgmt.workloadmonitor.aio.operations.HealthMonitorsOperations +module: azure.mgmt.workloadmonitor.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: HealthMonitorsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.workloadmonitor.aio.operations.HealthMonitorsOperations.get + name: get + summary: 'Get the current health status of a monitor of a virtual machine. Optional + parameter: $expand + + (retrieve the monitor''s evidence and configuration). + + + Get the current health status of a monitor of a virtual machine. Optional parameter: + $expand + + (retrieve the monitor''s evidence and configuration).' + signature: 'async get(subscription_id: str, resource_group_name: str, provider_name: + str, resource_collection_name: str, resource_name: str, monitor_id: str, expand: + str | None = None, **kwargs: Any) -> HealthMonitor' + parameters: + - name: subscription_id + description: The subscription Id of the virtual machine. Required. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group of the virtual machine. Required. + isRequired: true + types: + - + - name: provider_name + description: 'The provider name (ex: Microsoft.Compute for virtual machines). + Required.' + isRequired: true + types: + - + - name: resource_collection_name + description: 'The resource collection name (ex: virtualMachines for virtual + + machines). Required.' + isRequired: true + types: + - + - name: resource_name + description: The name of the virtual machine. Required. + isRequired: true + types: + - + - name: monitor_id + description: The monitor Id of the virtual machine. Required. + isRequired: true + types: + - + - name: expand + description: 'Optionally expand the monitor''s evidence and/or configuration. + Example: + + $expand=evidence,configuration. Default value is None.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: HealthMonitor or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.workloadmonitor.aio.operations.HealthMonitorsOperations.get_state_change + name: get_state_change + summary: 'Get the health state change of a monitor of a virtual machine at the provided + timestamp. + + Optional parameter: $expand (retrieve the monitor''s evidence and configuration). + + + Get the health state change of a monitor of a virtual machine at the provided + timestamp. + + Optional parameter: $expand (retrieve the monitor''s evidence and configuration).' + signature: 'async get_state_change(subscription_id: str, resource_group_name: str, + provider_name: str, resource_collection_name: str, resource_name: str, monitor_id: + str, timestamp_unix: str, expand: str | None = None, **kwargs: Any) -> HealthMonitorStateChange' + parameters: + - name: subscription_id + description: The subscription Id of the virtual machine. Required. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group of the virtual machine. Required. + isRequired: true + types: + - + - name: provider_name + description: 'The provider name (ex: Microsoft.Compute for virtual machines). + Required.' + isRequired: true + types: + - + - name: resource_collection_name + description: 'The resource collection name (ex: virtualMachines for virtual + + machines). Required.' + isRequired: true + types: + - + - name: resource_name + description: The name of the virtual machine. Required. + isRequired: true + types: + - + - name: monitor_id + description: The monitor Id of the virtual machine. Required. + isRequired: true + types: + - + - name: timestamp_unix + description: The timestamp of the state change (unix format). Required. + isRequired: true + types: + - + - name: expand + description: 'Optionally expand the monitor''s evidence and/or configuration. + Example: + + $expand=evidence,configuration. Default value is None.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: HealthMonitorStateChange or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.workloadmonitor.aio.operations.HealthMonitorsOperations.list + name: list + summary: 'Get the current health status of all monitors of a virtual machine. Optional + parameters: + + $expand (retrieve the monitor''s evidence and configuration) and $filter (filter + by monitor + + name). + + + Get the current health status of all monitors of a virtual machine. Optional parameters: + + $expand (retrieve the monitor''s evidence and configuration) and $filter (filter + by monitor + + name).' + signature: 'list(subscription_id: str, resource_group_name: str, provider_name: + str, resource_collection_name: str, resource_name: str, filter: str | None = None, + expand: str | None = None, **kwargs: Any) -> AsyncIterable[HealthMonitor]' + parameters: + - name: subscription_id + description: The subscription Id of the virtual machine. Required. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group of the virtual machine. Required. + isRequired: true + types: + - + - name: provider_name + description: 'The provider name (ex: Microsoft.Compute for virtual machines). + Required.' + isRequired: true + types: + - + - name: resource_collection_name + description: 'The resource collection name (ex: virtualMachines for virtual + + machines). Required.' + isRequired: true + types: + - + - name: resource_name + description: The name of the virtual machine. Required. + isRequired: true + types: + - + - name: filter + description: 'Optionally filter by monitor name. Example: $filter=monitorName + eq + + ''logical-disks|C:>>|< + - name: expand + description: 'Optionally expand the monitor''s evidence and/or configuration. + Example: + + $expand=evidence,configuration. Default value is None.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either HealthMonitor or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.workloadmonitor.aio.operations.HealthMonitorsOperations.list_state_changes + name: list_state_changes + summary: 'Get the health state changes of a monitor of a virtual machine within + the provided time window + + (default is the last 24 hours). Optional parameters: $expand (retrieve the monitor''s + evidence + + and configuration) and $filter (filter by heartbeat condition). + + + Get the health state changes of a monitor of a virtual machine within the provided + time window + + (default is the last 24 hours). Optional parameters: $expand (retrieve the monitor''s + evidence + + and configuration) and $filter (filter by heartbeat condition).' + signature: 'list_state_changes(subscription_id: str, resource_group_name: str, provider_name: + str, resource_collection_name: str, resource_name: str, monitor_id: str, filter: + str | None = None, expand: str | None = None, start_timestamp_utc: datetime | + None = None, end_timestamp_utc: datetime | None = None, **kwargs: Any) -> AsyncIterable[HealthMonitorStateChange]' + parameters: + - name: subscription_id + description: The subscription Id of the virtual machine. Required. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group of the virtual machine. Required. + isRequired: true + types: + - + - name: provider_name + description: 'The provider name (ex: Microsoft.Compute for virtual machines). + Required.' + isRequired: true + types: + - + - name: resource_collection_name + description: 'The resource collection name (ex: virtualMachines for virtual + + machines). Required.' + isRequired: true + types: + - + - name: resource_name + description: The name of the virtual machine. Required. + isRequired: true + types: + - + - name: monitor_id + description: The monitor Id of the virtual machine. Required. + isRequired: true + types: + - + - name: filter + description: 'Optionally filter by heartbeat condition. Example: $filter=isHeartbeat + eq false. + + Default value is None.' + isRequired: true + types: + - + - name: expand + description: 'Optionally expand the monitor''s evidence and/or configuration. + Example: + + $expand=evidence,configuration. Default value is None.' + isRequired: true + types: + - + - name: start_timestamp_utc + description: The start of the time window. Default value is None. + isRequired: true + types: + - + - name: end_timestamp_utc + description: The end of the time window. Default value is None. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either HealthMonitorStateChange or + the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.workloadmonitor.aio.operations.HealthMonitorsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.operations.Operations.yml new file mode 100644 index 00000000..471532b4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.operations.Operations.yml @@ -0,0 +1,33 @@ +### YamlMime:PythonClass +uid: azure.mgmt.workloadmonitor.aio.operations.Operations +name: Operations +fullName: azure.mgmt.workloadmonitor.aio.operations.Operations +module: azure.mgmt.workloadmonitor.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: Operations(*args, **kwargs) +methods: +- uid: azure.mgmt.workloadmonitor.aio.operations.Operations.list + name: list + summary: 'Get a list of all available REST API operations. + + + Get a list of all available REST API operations.' + signature: 'list(**kwargs: Any) -> AsyncIterable[Operation]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either Operation or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.workloadmonitor.aio.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.operations.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.operations.yml new file mode 100644 index 00000000..4d1963b5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.operations.yml @@ -0,0 +1,8 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.workloadmonitor.aio.operations +name: operations +fullName: azure.mgmt.workloadmonitor.aio.operations +type: import +classes: +- azure.mgmt.workloadmonitor.aio.operations.HealthMonitorsOperations +- azure.mgmt.workloadmonitor.aio.operations.Operations diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.yml new file mode 100644 index 00000000..ce5ccfdb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.workloadmonitor.aio +name: aio +fullName: azure.mgmt.workloadmonitor.aio +type: import +classes: +- azure.mgmt.workloadmonitor.aio.WorkloadMonitorAPI +packages: +- azure.mgmt.workloadmonitor.aio.operations diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorDetails.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorDetails.yml new file mode 100644 index 00000000..cb9c20fb --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorDetails.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.mgmt.workloadmonitor.models.ErrorDetails +name: ErrorDetails +fullName: azure.mgmt.workloadmonitor.models.ErrorDetails +module: azure.mgmt.workloadmonitor.models +summary: Error details. +constructor: + syntax: 'ErrorDetails(*, code: str | None = None, message: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: code + description: Error code identifying the specific error. + types: + - + - name: message + description: A human-readable error message. + types: + - +variables: +- description: Error code identifying the specific error. + name: code + types: + - +- description: A human-readable error message. + name: message + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorResponse.yml new file mode 100644 index 00000000..aed6f9e3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorResponse.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.mgmt.workloadmonitor.models.ErrorResponse +name: ErrorResponse +fullName: azure.mgmt.workloadmonitor.models.ErrorResponse +module: azure.mgmt.workloadmonitor.models +summary: Error response. +constructor: + syntax: 'ErrorResponse(*, error: _models.ErrorResponseError | None = None, **kwargs)' + keywordOnlyParameters: + - name: error + description: Error info. + types: + - +variables: +- description: Error info. + name: error + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorResponseError.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorResponseError.yml new file mode 100644 index 00000000..83e7b284 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorResponseError.yml @@ -0,0 +1,41 @@ +### YamlMime:PythonClass +uid: azure.mgmt.workloadmonitor.models.ErrorResponseError +name: ErrorResponseError +fullName: azure.mgmt.workloadmonitor.models.ErrorResponseError +module: azure.mgmt.workloadmonitor.models +summary: Error info. +constructor: + syntax: 'ErrorResponseError(*, code: str | None = None, message: str | None = None, + details: List[_models.ErrorDetails] | None = None, **kwargs)' + keywordOnlyParameters: + - name: code + description: 'Service-defined error code. This code serves as a sub-status for + the HTTP error + + code specified in the response.' + types: + - + - name: message + description: Human-readable representation of the error. + types: + - + - name: details + description: Error details. + types: + - [] +variables: +- description: 'Service-defined error code. This code serves as a sub-status for the + HTTP error + + code specified in the response.' + name: code + types: + - +- description: Human-readable representation of the error. + name: message + types: + - +- description: Error details. + name: details + types: + - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitor.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitor.yml new file mode 100644 index 00000000..e8c38152 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitor.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.mgmt.workloadmonitor.models.HealthMonitor +name: HealthMonitor +fullName: azure.mgmt.workloadmonitor.models.HealthMonitor +module: azure.mgmt.workloadmonitor.models +summary: 'Information about the monitor''s current health status. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'HealthMonitor(*, monitor_name: str | None = None, monitor_type: str | None + = None, monitored_object: str | None = None, parent_monitor_name: str | None = + None, evaluation_timestamp: str | None = None, current_state_first_observed_timestamp: + str | None = None, last_reported_timestamp: str | None = None, evidence: MutableMapping[str, + Any] | None = None, monitor_configuration: MutableMapping[str, Any] | None = None, + **kwargs)' + keywordOnlyParameters: + - name: monitor_name + description: Human-readable name of the monitor. + types: + - + - name: monitor_type + description: Type of the monitor. + types: + - + - name: monitored_object + description: Dynamic monitored object of the monitor. + types: + - + - name: parent_monitor_name + description: Name of the parent monitor. + types: + - + - name: evaluation_timestamp + description: Timestamp of the monitor's last health evaluation. + types: + - + - name: current_state_first_observed_timestamp + description: 'Timestamp of the monitor''s last health state + + change.' + types: + - + - name: last_reported_timestamp + description: Timestamp of the monitor's last reported health state. + types: + - + - name: evidence + description: Evidence validating the monitor's current health state. + types: + - + - name: monitor_configuration + description: 'The configuration settings at the time of the monitor''s health + + evaluation.' + types: + - +variables: +- description: The resource Id. + name: id + types: + - +- description: The resource name. + name: name + types: + - +- description: The resource type. + name: type + types: + - +- description: Human-readable name of the monitor. + name: monitor_name + types: + - +- description: Type of the monitor. + name: monitor_type + types: + - +- description: Dynamic monitored object of the monitor. + name: monitored_object + types: + - +- description: Name of the parent monitor. + name: parent_monitor_name + types: + - +- description: 'Previous health state of the monitor. Known values are: + + "Healthy", "Critical", "Warning", "Unknown", "Disabled", and "None".' + name: previous_monitor_state + types: + - + - +- description: 'Current health state of the monitor. Known values are: "Healthy", + + "Critical", "Warning", "Unknown", "Disabled", and "None".' + name: current_monitor_state + types: + - + - +- description: Timestamp of the monitor's last health evaluation. + name: evaluation_timestamp + types: + - +- description: 'Timestamp of the monitor''s last health state + + change.' + name: current_state_first_observed_timestamp + types: + - +- description: Timestamp of the monitor's last reported health state. + name: last_reported_timestamp + types: + - +- description: Evidence validating the monitor's current health state. + name: evidence + types: + - +- description: 'The configuration settings at the time of the monitor''s health + + evaluation.' + name: monitor_configuration + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorList.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorList.yml new file mode 100644 index 00000000..b6cf7451 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorList.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.workloadmonitor.models.HealthMonitorList +name: HealthMonitorList +fullName: azure.mgmt.workloadmonitor.models.HealthMonitorList +module: azure.mgmt.workloadmonitor.models +summary: Information about the current health statuses of the monitors. +constructor: + syntax: 'HealthMonitorList(*, value: List[_models.HealthMonitor] | None = None, + next_link: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: Array of health monitors of the virtual machine. + types: + - [] + - name: next_link + description: Link to next page if the list is too long. + types: + - +variables: +- description: Array of health monitors of the virtual machine. + name: value + types: + - [] +- description: Link to next page if the list is too long. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorStateChange.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorStateChange.yml new file mode 100644 index 00000000..9bbeb856 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorStateChange.yml @@ -0,0 +1,107 @@ +### YamlMime:PythonClass +uid: azure.mgmt.workloadmonitor.models.HealthMonitorStateChange +name: HealthMonitorStateChange +fullName: azure.mgmt.workloadmonitor.models.HealthMonitorStateChange +module: azure.mgmt.workloadmonitor.models +summary: 'Information about the monitor''s health state change at the provided timestamp. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'HealthMonitorStateChange(*, monitor_name: str | None = None, monitor_type: + str | None = None, monitored_object: str | None = None, evaluation_timestamp: + str | None = None, current_state_first_observed_timestamp: str | None = None, + evidence: MutableMapping[str, Any] | None = None, monitor_configuration: MutableMapping[str, + Any] | None = None, **kwargs)' + keywordOnlyParameters: + - name: monitor_name + description: Human-readable name of the monitor. + types: + - + - name: monitor_type + description: Type of the monitor. + types: + - + - name: monitored_object + description: Dynamic monitored object of the monitor. + types: + - + - name: evaluation_timestamp + description: Timestamp of the monitor's last health evaluation. + types: + - + - name: current_state_first_observed_timestamp + description: 'Timestamp of the monitor''s last health state + + change.' + types: + - + - name: evidence + description: Evidence validating the monitor's current health state. + types: + - + - name: monitor_configuration + description: 'The configuration settings at the time of the monitor''s health + + evaluation.' + types: + - +variables: +- description: The resource Id. + name: id + types: + - +- description: The resource name. + name: name + types: + - +- description: The resource type. + name: type + types: + - +- description: Human-readable name of the monitor. + name: monitor_name + types: + - +- description: Type of the monitor. + name: monitor_type + types: + - +- description: Dynamic monitored object of the monitor. + name: monitored_object + types: + - +- description: Timestamp of the monitor's last health evaluation. + name: evaluation_timestamp + types: + - +- description: 'Timestamp of the monitor''s last health state + + change.' + name: current_state_first_observed_timestamp + types: + - +- description: 'Previous health state of the monitor. Known values are: + + "Healthy", "Critical", "Warning", "Unknown", "Disabled", and "None".' + name: previous_monitor_state + types: + - + - +- description: 'Current health state of the monitor. Known values are: "Healthy", + + "Critical", "Warning", "Unknown", "Disabled", and "None".' + name: current_monitor_state + types: + - + - +- description: Evidence validating the monitor's current health state. + name: evidence + types: + - +- description: 'The configuration settings at the time of the monitor''s health + + evaluation.' + name: monitor_configuration + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorStateChangeList.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorStateChangeList.yml new file mode 100644 index 00000000..0c97da22 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorStateChangeList.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.mgmt.workloadmonitor.models.HealthMonitorStateChangeList +name: HealthMonitorStateChangeList +fullName: azure.mgmt.workloadmonitor.models.HealthMonitorStateChangeList +module: azure.mgmt.workloadmonitor.models +summary: Information about the health state changes of the monitor within the provided + time window. +constructor: + syntax: 'HealthMonitorStateChangeList(*, value: List[_models.HealthMonitorStateChange] + | None = None, next_link: str | None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: Array of health state changes within the specified time window. + types: + - [] + - name: next_link + description: Link to next page if the list is too long. + types: + - +variables: +- description: Array of health state changes within the specified time window. + name: value + types: + - [] +- description: Link to next page if the list is too long. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthState.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthState.yml new file mode 100644 index 00000000..3d3bacb1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthState.yml @@ -0,0 +1,19 @@ +### YamlMime:PythonEnum +uid: azure.mgmt.workloadmonitor.models.HealthState +name: HealthState +fullName: azure.mgmt.workloadmonitor.models.HealthState +summary: One of health states - healthy, critical, warning, unknown, none, disabled. +module: azure.mgmt.workloadmonitor.models +fields: +- name: CRITICAL + uid: azure.mgmt.workloadmonitor.models.HealthState.CRITICAL +- name: DISABLED + uid: azure.mgmt.workloadmonitor.models.HealthState.DISABLED +- name: HEALTHY + uid: azure.mgmt.workloadmonitor.models.HealthState.HEALTHY +- name: NONE + uid: azure.mgmt.workloadmonitor.models.HealthState.NONE +- name: UNKNOWN + uid: azure.mgmt.workloadmonitor.models.HealthState.UNKNOWN +- name: WARNING + uid: azure.mgmt.workloadmonitor.models.HealthState.WARNING diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.Operation.yml new file mode 100644 index 00000000..074c6e29 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.Operation.yml @@ -0,0 +1,46 @@ +### YamlMime:PythonClass +uid: azure.mgmt.workloadmonitor.models.Operation +name: Operation +fullName: azure.mgmt.workloadmonitor.models.Operation +module: azure.mgmt.workloadmonitor.models +summary: 'Operation supported by the resource provider. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Operation(*, name: str, display: _models.OperationDisplay, origin: str, + **kwargs)' + keywordOnlyParameters: + - name: name + description: The name of the operation being performed on this particular object. + Required. + types: + - + - name: display + description: 'The localized display information for this particular operation + or action. + + Required.' + types: + - + - name: origin + description: The intended executor of the operation. Required. + types: + - +variables: +- description: The name of the operation being performed on this particular object. + Required. + name: name + types: + - +- description: 'The localized display information for this particular operation or + action. + + Required.' + name: display + types: + - +- description: The intended executor of the operation. Required. + name: origin + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.OperationDisplay.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.OperationDisplay.yml new file mode 100644 index 00000000..a871cd0f --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.OperationDisplay.yml @@ -0,0 +1,46 @@ +### YamlMime:PythonClass +uid: azure.mgmt.workloadmonitor.models.OperationDisplay +name: OperationDisplay +fullName: azure.mgmt.workloadmonitor.models.OperationDisplay +module: azure.mgmt.workloadmonitor.models +summary: 'The localized display information for this particular operation or action. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'OperationDisplay(*, provider: str, resource: str, operation: str, description: + str, **kwargs)' + keywordOnlyParameters: + - name: provider + description: Operation resource provider name. Required. + types: + - + - name: resource + description: Resource on which the operation is performed. Required. + types: + - + - name: operation + description: Human-readable, friendly name for the operation. Required. + types: + - + - name: description + description: Operation description. Required. + types: + - +variables: +- description: Operation resource provider name. Required. + name: provider + types: + - +- description: Resource on which the operation is performed. Required. + name: resource + types: + - +- description: Human-readable, friendly name for the operation. Required. + name: operation + types: + - +- description: Operation description. Required. + name: description + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.OperationList.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.OperationList.yml new file mode 100644 index 00000000..752dff73 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.OperationList.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.mgmt.workloadmonitor.models.OperationList +name: OperationList +fullName: azure.mgmt.workloadmonitor.models.OperationList +module: azure.mgmt.workloadmonitor.models +summary: List of available REST API operations. +constructor: + syntax: 'OperationList(*, value: List[_models.Operation] | None = None, next_link: + str | None = None, **kwargs)' + keywordOnlyParameters: + - name: value + description: Array of available REST API operations. + types: + - [] + - name: next_link + description: Link to next page if the list is too long. + types: + - +variables: +- description: Array of available REST API operations. + name: value + types: + - [] +- description: Link to next page if the list is too long. + name: next_link + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.Resource.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.Resource.yml new file mode 100644 index 00000000..bef6deb3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.Resource.yml @@ -0,0 +1,24 @@ +### YamlMime:PythonClass +uid: azure.mgmt.workloadmonitor.models.Resource +name: Resource +fullName: azure.mgmt.workloadmonitor.models.Resource +module: azure.mgmt.workloadmonitor.models +summary: 'The resource model definition for the ARM proxy resource, ''microsoft.workloadmonitor/monitors''. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: Resource(**kwargs) +variables: +- description: The resource Id. + name: id + types: + - +- description: The resource name. + name: name + types: + - +- description: The resource type. + name: type + types: + - diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.yml new file mode 100644 index 00000000..e46fa314 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.yml @@ -0,0 +1,19 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.workloadmonitor.models +name: models +fullName: azure.mgmt.workloadmonitor.models +type: import +classes: +- azure.mgmt.workloadmonitor.models.ErrorDetails +- azure.mgmt.workloadmonitor.models.ErrorResponse +- azure.mgmt.workloadmonitor.models.ErrorResponseError +- azure.mgmt.workloadmonitor.models.HealthMonitor +- azure.mgmt.workloadmonitor.models.HealthMonitorList +- azure.mgmt.workloadmonitor.models.HealthMonitorStateChange +- azure.mgmt.workloadmonitor.models.HealthMonitorStateChangeList +- azure.mgmt.workloadmonitor.models.Operation +- azure.mgmt.workloadmonitor.models.OperationDisplay +- azure.mgmt.workloadmonitor.models.OperationList +- azure.mgmt.workloadmonitor.models.Resource +enums: +- azure.mgmt.workloadmonitor.models.HealthState diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.operations.HealthMonitorsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.operations.HealthMonitorsOperations.yml new file mode 100644 index 00000000..1eb677b0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.operations.HealthMonitorsOperations.yml @@ -0,0 +1,329 @@ +### YamlMime:PythonClass +uid: azure.mgmt.workloadmonitor.operations.HealthMonitorsOperations +name: HealthMonitorsOperations +fullName: azure.mgmt.workloadmonitor.operations.HealthMonitorsOperations +module: azure.mgmt.workloadmonitor.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: HealthMonitorsOperations(*args, **kwargs) +methods: +- uid: azure.mgmt.workloadmonitor.operations.HealthMonitorsOperations.get + name: get + summary: 'Get the current health status of a monitor of a virtual machine. Optional + parameter: $expand + + (retrieve the monitor''s evidence and configuration). + + + Get the current health status of a monitor of a virtual machine. Optional parameter: + $expand + + (retrieve the monitor''s evidence and configuration).' + signature: 'get(subscription_id: str, resource_group_name: str, provider_name: str, + resource_collection_name: str, resource_name: str, monitor_id: str, expand: str + | None = None, **kwargs: Any) -> HealthMonitor' + parameters: + - name: subscription_id + description: The subscription Id of the virtual machine. Required. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group of the virtual machine. Required. + isRequired: true + types: + - + - name: provider_name + description: 'The provider name (ex: Microsoft.Compute for virtual machines). + Required.' + isRequired: true + types: + - + - name: resource_collection_name + description: 'The resource collection name (ex: virtualMachines for virtual + + machines). Required.' + isRequired: true + types: + - + - name: resource_name + description: The name of the virtual machine. Required. + isRequired: true + types: + - + - name: monitor_id + description: The monitor Id of the virtual machine. Required. + isRequired: true + types: + - + - name: expand + description: 'Optionally expand the monitor''s evidence and/or configuration. + Example: + + $expand=evidence,configuration. Default value is None.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: HealthMonitor or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.workloadmonitor.operations.HealthMonitorsOperations.get_state_change + name: get_state_change + summary: 'Get the health state change of a monitor of a virtual machine at the provided + timestamp. + + Optional parameter: $expand (retrieve the monitor''s evidence and configuration). + + + Get the health state change of a monitor of a virtual machine at the provided + timestamp. + + Optional parameter: $expand (retrieve the monitor''s evidence and configuration).' + signature: 'get_state_change(subscription_id: str, resource_group_name: str, provider_name: + str, resource_collection_name: str, resource_name: str, monitor_id: str, timestamp_unix: + str, expand: str | None = None, **kwargs: Any) -> HealthMonitorStateChange' + parameters: + - name: subscription_id + description: The subscription Id of the virtual machine. Required. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group of the virtual machine. Required. + isRequired: true + types: + - + - name: provider_name + description: 'The provider name (ex: Microsoft.Compute for virtual machines). + Required.' + isRequired: true + types: + - + - name: resource_collection_name + description: 'The resource collection name (ex: virtualMachines for virtual + + machines). Required.' + isRequired: true + types: + - + - name: resource_name + description: The name of the virtual machine. Required. + isRequired: true + types: + - + - name: monitor_id + description: The monitor Id of the virtual machine. Required. + isRequired: true + types: + - + - name: timestamp_unix + description: The timestamp of the state change (unix format). Required. + isRequired: true + types: + - + - name: expand + description: 'Optionally expand the monitor''s evidence and/or configuration. + Example: + + $expand=evidence,configuration. Default value is None.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: HealthMonitorStateChange or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.workloadmonitor.operations.HealthMonitorsOperations.list + name: list + summary: 'Get the current health status of all monitors of a virtual machine. Optional + parameters: + + $expand (retrieve the monitor''s evidence and configuration) and $filter (filter + by monitor + + name). + + + Get the current health status of all monitors of a virtual machine. Optional parameters: + + $expand (retrieve the monitor''s evidence and configuration) and $filter (filter + by monitor + + name).' + signature: 'list(subscription_id: str, resource_group_name: str, provider_name: + str, resource_collection_name: str, resource_name: str, filter: str | None = None, + expand: str | None = None, **kwargs: Any) -> Iterable[HealthMonitor]' + parameters: + - name: subscription_id + description: The subscription Id of the virtual machine. Required. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group of the virtual machine. Required. + isRequired: true + types: + - + - name: provider_name + description: 'The provider name (ex: Microsoft.Compute for virtual machines). + Required.' + isRequired: true + types: + - + - name: resource_collection_name + description: 'The resource collection name (ex: virtualMachines for virtual + + machines). Required.' + isRequired: true + types: + - + - name: resource_name + description: The name of the virtual machine. Required. + isRequired: true + types: + - + - name: filter + description: 'Optionally filter by monitor name. Example: $filter=monitorName + eq + + ''logical-disks|C:>>|< + - name: expand + description: 'Optionally expand the monitor''s evidence and/or configuration. + Example: + + $expand=evidence,configuration. Default value is None.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either HealthMonitor or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.mgmt.workloadmonitor.operations.HealthMonitorsOperations.list_state_changes + name: list_state_changes + summary: 'Get the health state changes of a monitor of a virtual machine within + the provided time window + + (default is the last 24 hours). Optional parameters: $expand (retrieve the monitor''s + evidence + + and configuration) and $filter (filter by heartbeat condition). + + + Get the health state changes of a monitor of a virtual machine within the provided + time window + + (default is the last 24 hours). Optional parameters: $expand (retrieve the monitor''s + evidence + + and configuration) and $filter (filter by heartbeat condition).' + signature: 'list_state_changes(subscription_id: str, resource_group_name: str, provider_name: + str, resource_collection_name: str, resource_name: str, monitor_id: str, filter: + str | None = None, expand: str | None = None, start_timestamp_utc: datetime | + None = None, end_timestamp_utc: datetime | None = None, **kwargs: Any) -> Iterable[HealthMonitorStateChange]' + parameters: + - name: subscription_id + description: The subscription Id of the virtual machine. Required. + isRequired: true + types: + - + - name: resource_group_name + description: The resource group of the virtual machine. Required. + isRequired: true + types: + - + - name: provider_name + description: 'The provider name (ex: Microsoft.Compute for virtual machines). + Required.' + isRequired: true + types: + - + - name: resource_collection_name + description: 'The resource collection name (ex: virtualMachines for virtual + + machines). Required.' + isRequired: true + types: + - + - name: resource_name + description: The name of the virtual machine. Required. + isRequired: true + types: + - + - name: monitor_id + description: The monitor Id of the virtual machine. Required. + isRequired: true + types: + - + - name: filter + description: 'Optionally filter by heartbeat condition. Example: $filter=isHeartbeat + eq false. + + Default value is None.' + isRequired: true + types: + - + - name: expand + description: 'Optionally expand the monitor''s evidence and/or configuration. + Example: + + $expand=evidence,configuration. Default value is None.' + isRequired: true + types: + - + - name: start_timestamp_utc + description: The start of the time window. Default value is None. + isRequired: true + types: + - + - name: end_timestamp_utc + description: The end of the time window. Default value is None. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: 'An iterator like instance of either HealthMonitorStateChange or + the result of + + cls(response)' + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.workloadmonitor.operations.HealthMonitorsOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.operations.Operations.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.operations.Operations.yml new file mode 100644 index 00000000..6323f77c --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.operations.Operations.yml @@ -0,0 +1,33 @@ +### YamlMime:PythonClass +uid: azure.mgmt.workloadmonitor.operations.Operations +name: Operations +fullName: azure.mgmt.workloadmonitor.operations.Operations +module: azure.mgmt.workloadmonitor.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: Operations(*args, **kwargs) +methods: +- uid: azure.mgmt.workloadmonitor.operations.Operations.list + name: list + summary: 'Get a list of all available REST API operations. + + + Get a list of all available REST API operations.' + signature: 'list(**kwargs: Any) -> Iterable[Operation]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either Operation or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.mgmt.workloadmonitor.operations.Operations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.operations.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.operations.yml new file mode 100644 index 00000000..b4bd6ca0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.operations.yml @@ -0,0 +1,8 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.workloadmonitor.operations +name: operations +fullName: azure.mgmt.workloadmonitor.operations +type: import +classes: +- azure.mgmt.workloadmonitor.operations.HealthMonitorsOperations +- azure.mgmt.workloadmonitor.operations.Operations diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.yml new file mode 100644 index 00000000..575a1ff9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonPackage +uid: azure.mgmt.workloadmonitor +name: workloadmonitor +fullName: azure.mgmt.workloadmonitor +type: rootImport +classes: +- azure.mgmt.workloadmonitor.WorkloadMonitorAPI +packages: +- azure.mgmt.workloadmonitor.aio +- azure.mgmt.workloadmonitor.models +- azure.mgmt.workloadmonitor.operations diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.PurviewCatalogClient.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.PurviewCatalogClient.yml new file mode 100644 index 00000000..0a4a1d57 --- /dev/null +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.PurviewCatalogClient.yml @@ -0,0 +1,116 @@ +### YamlMime:PythonClass +uid: azure.purview.catalog.PurviewCatalogClient +name: PurviewCatalogClient +fullName: azure.purview.catalog.PurviewCatalogClient +module: azure.purview.catalog +summary: 'Purview Catalog Service is a fully managed cloud service whose users can + discover the data + + sources they need and understand the data sources they find. At the same time, Data + Catalog + + helps organizations get more value from their existing investments. This spec defines + REST API + + of Purview Catalog Service.' +constructor: + syntax: 'PurviewCatalogClient(endpoint: str, credential: TokenCredential, **kwargs: + Any)' + parameters: + - name: endpoint + description: 'The catalog endpoint of your Purview account. Example: + + [https:/](https:/)/{accountName}.purview.azure.com.' + isRequired: true + types: + - + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + keywordOnlyParameters: + - name: api_version + description: 'Api Version. Default value is "2022-03-01-preview". Note that overriding + + this default value may result in unsupported behavior.' + types: + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - +variables: +- description: EntityOperations operations + name: entity + types: + - +- description: GlossaryOperations operations + name: glossary + types: + - +- description: DiscoveryOperations operations + name: discovery + types: + - +- description: LineageOperations operations + name: lineage + types: + - +- description: RelationshipOperations operations + name: relationship + types: + - +- description: TypesOperations operations + name: types + types: + - +- description: CollectionOperations operations + name: collection + types: + - +methods: +- uid: azure.purview.catalog.PurviewCatalogClient.close + name: close + signature: close() -> None +- uid: azure.purview.catalog.PurviewCatalogClient.send_request + name: send_request + summary: 'Runs the network request through the client''s chained policies. + + + ``` + + + >>> from azure.core.rest import HttpRequest + + >>> request = HttpRequest("GET", "https://www.example.org/") + + + + >>> response = client.send_request(request) + + + + ``` + + + For more information on this code flow, see [https://aka.ms/azsdk/python/protocol/quickstart](https://aka.ms/azsdk/python/protocol/quickstart)' + signature: 'send_request(request: HttpRequest, **kwargs: Any) -> HttpResponse' + parameters: + - name: request + description: The network request you want to make. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: stream + description: Whether the response payload will be streamed. Defaults to False. + types: + - + return: + description: The response of your network call. Does not do error handling on + your response. + types: + - diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.PurviewCatalogClient.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.PurviewCatalogClient.yml new file mode 100644 index 00000000..9c3be59d --- /dev/null +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.PurviewCatalogClient.yml @@ -0,0 +1,116 @@ +### YamlMime:PythonClass +uid: azure.purview.catalog.aio.PurviewCatalogClient +name: PurviewCatalogClient +fullName: azure.purview.catalog.aio.PurviewCatalogClient +module: azure.purview.catalog.aio +summary: 'Purview Catalog Service is a fully managed cloud service whose users can + discover the data + + sources they need and understand the data sources they find. At the same time, Data + Catalog + + helps organizations get more value from their existing investments. This spec defines + REST API + + of Purview Catalog Service.' +constructor: + syntax: 'PurviewCatalogClient(endpoint: str, credential: AsyncTokenCredential, **kwargs: + Any)' + parameters: + - name: endpoint + description: 'The catalog endpoint of your Purview account. Example: + + [https:/](https:/)/{accountName}.purview.azure.com.' + isRequired: true + types: + - + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + keywordOnlyParameters: + - name: api_version + description: 'Api Version. Default value is "2022-03-01-preview". Note that overriding + + this default value may result in unsupported behavior.' + types: + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - +variables: +- description: EntityOperations operations + name: entity + types: + - +- description: GlossaryOperations operations + name: glossary + types: + - +- description: DiscoveryOperations operations + name: discovery + types: + - +- description: LineageOperations operations + name: lineage + types: + - +- description: RelationshipOperations operations + name: relationship + types: + - +- description: TypesOperations operations + name: types + types: + - +- description: CollectionOperations operations + name: collection + types: + - +methods: +- uid: azure.purview.catalog.aio.PurviewCatalogClient.close + name: close + signature: async close() -> None +- uid: azure.purview.catalog.aio.PurviewCatalogClient.send_request + name: send_request + summary: 'Runs the network request through the client''s chained policies. + + + ``` + + + >>> from azure.core.rest import HttpRequest + + >>> request = HttpRequest("GET", "https://www.example.org/") + + + + >>> response = await client.send_request(request) + + + + ``` + + + For more information on this code flow, see [https://aka.ms/azsdk/python/protocol/quickstart](https://aka.ms/azsdk/python/protocol/quickstart)' + signature: 'send_request(request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncHttpResponse]' + parameters: + - name: request + description: The network request you want to make. Required. + isRequired: true + types: + - + keywordOnlyParameters: + - name: stream + description: Whether the response payload will be streamed. Defaults to False. + types: + - + return: + description: The response of your network call. Does not do error handling on + your response. + types: + - diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.CollectionOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.CollectionOperations.yml new file mode 100644 index 00000000..ad75d7af --- /dev/null +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.CollectionOperations.yml @@ -0,0 +1,792 @@ +### YamlMime:PythonClass +uid: azure.purview.catalog.aio.operations.CollectionOperations +name: CollectionOperations +fullName: azure.purview.catalog.aio.operations.CollectionOperations +module: azure.purview.catalog.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: CollectionOperations(*args, **kwargs) +methods: +- uid: azure.purview.catalog.aio.operations.CollectionOperations.create_or_update + name: create_or_update + summary: 'Creates or updates an entity to a collection. + + Existing entity is matched using its unique guid if supplied or by its unique + attributes eg: + + qualifiedName. + + Map and array of collections are not well supported. E.g., array*>, + + array>.' + signature: 'async create_or_update(collection: str, entity: MutableMapping[str, + Any], **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: collection + description: the collection unique name. + isRequired: true + types: + - + - name: entity + description: Atlas entity with extended information. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n entity\ + \ = {\n \"entity\": {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \"\ + businessAttributes\": {\n \"str\": {} # Optional. Business Attributes.\n\ + \ },\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the\n struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional. The GUID of the\n\ + \ entity.\n \"entityStatus\": \"str\", \ + \ # Optional. Status of the\n entity - can be active or deleted.\ + \ Deleted entities are not removed\n from Atlas store. Known\ + \ values are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for\n concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the source who\n create the classification detail.\n\ + \ \"sourceDetails\": {\n \"str\": {} \ + \ # Optional. more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"validityPeriods\": [\n \ + \ {\n \"endTime\": \"str\", # Optional.\ + \ The\n end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n \ + \ start of the time boundary.\n \"timeZone\"\ + : \"str\" # Optional. The\n timezone of the time\ + \ boundary.\n }\n ]\n }\n\ + \ ],\n \"contacts\": {\n \"str\": [\n \ + \ {\n \"id\": \"str\", # Optional. Azure Active\n\ + \ Directory object Id.\n \"info\"\ + : \"str\" # Optional. additional\n information to describe\ + \ this contact.\n }\n ]\n },\n \ + \ \"createTime\": 0.0, # Optional. The created time of the record.\n \ + \ \"createdBy\": \"str\", # Optional. The user who created the record.\n\ + \ \"customAttributes\": {\n \"str\": \"str\" # Optional.\ + \ Custom Attribute.\n },\n \"guid\": \"str\", # Optional.\ + \ The GUID of the entity.\n \"homeId\": \"str\", # Optional. The home\ + \ ID of the entity.\n \"isIncomplete\": bool, # Optional. Whether it\ + \ is a shell entity.\n \"labels\": [\n \"str\" # Optional.\ + \ labels.\n ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"meanings\": [\n {\n\ + \ \"confidence\": 0, # Optional. The confidence of the\n \ + \ term assignment.\n \"createdBy\": \"str\"\ + , # Optional. The user who created\n the record.\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the term assignment.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n\ + \ relationship.\n \"source\": \"str\", \ + \ # Optional. The source of the term.\n \"status\": \"str\"\ + , # Optional. The status of terms\n assignment. Known values\ + \ are: \"DISCOVERED\", \"PROPOSED\", \"IMPORTED\",\n \"VALIDATED\"\ + , \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \"steward\": \"\ + str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, # Optional. Used\ + \ to record the provenance of\n an instance of an entity or relationship.\n\ + \ \"proxy\": bool, # Optional. Determines if there's a proxy.\n \ + \ \"relationshipAttributes\": {\n \"str\": {} # Optional.\ + \ The attributes of relationship.\n },\n \"source\": \"str\"\ + , # Optional. indicate the source who create the\n classification\ + \ detail.\n \"sourceDetails\": {\n \"str\": {} # Optional.\ + \ more detail on source information.\n },\n \"status\": \"\ + str\", # Optional. Status of the entity - can be active or\n deleted.\ + \ Deleted entities are not removed from Atlas store. Known values are:\n \ + \ \"ACTIVE\", \"DELETED\".\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the record.\n \"updatedBy\": \"str\", # Optional. The user\ + \ who updated the record.\n \"version\": 0.0 # Optional. The version\ + \ of the entity.\n },\n \"referredEntities\": {\n \"str\"\ + : {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"businessAttributes\"\ + : {\n \"str\": {} # Optional. Business Attributes.\n \ + \ },\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {}\ + \ # Optional. The attributes\n of the struct.\n \ + \ },\n \"entityGuid\": \"str\", #\ + \ Optional. The GUID of\n the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of\n \ + \ the entity - can be active or deleted. Deleted entities are not\n \ + \ removed from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag\n for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \"id\"\ + : \"str\", # Optional. Azure\n Active Directory object\ + \ Id.\n \"info\": \"str\" # Optional. additional\n\ + \ information to describe this contact.\n \ + \ }\n ]\n },\n \"\ + createTime\": 0.0, # Optional. The created time of the\n record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the\n\ + \ record.\n \"customAttributes\": {\n \ + \ \"str\": \"str\" # Optional. Custom Attribute.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"homeId\": \"str\", # Optional. The home ID of the entity.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a shell\n \ + \ entity.\n \"labels\": [\n \"str\"\ + \ # Optional. labels.\n ],\n \"lastModifiedTS\":\ + \ \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n }\n }\n\n # response body\ + \ for status code(s): 200\n response.json() == {\n \"guidAssignments\"\ + : {\n \"str\": \"str\" # Optional. A map of GUID assignments with entities.\n\ + \ },\n \"mutatedEntities\": {\n \"str\": [\n \ + \ {\n \"attributes\": {\n \"str\":\ + \ {} # Optional. The attributes of the\n struct.\n \ + \ },\n \"classificationNames\": [\n \ + \ \"str\" # Optional. An array of classification\n \ + \ names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n\ + \ \"str\": {} # Optional. The\n \ + \ attributes of the struct.\n },\n\ + \ \"entityGuid\": \"str\", # Optional. The\n \ + \ GUID of the entity.\n \"entityStatus\"\ + : \"str\", # Optional.\n Status of the entity - can\ + \ be active or deleted. Deleted\n entities are not\ + \ removed from Atlas store. Known values are:\n \"\ + ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional.\n ETag for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\":\n \ + \ bool, # Optional. Determines if propagations will be removed\n\ + \ on entity deletion.\n \ + \ \"source\": \"str\", # Optional.\n indicate the\ + \ source who create the classification detail.\n \"\ + sourceDetails\": {\n \"str\": {} # Optional. more\n\ + \ detail on source information.\n \ + \ },\n \"typeName\": \"str\", # Optional.\ + \ The\n name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\",\n # Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the\ + \ time boundary.\n }\n \ + \ ]\n }\n ],\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"guid\": \"str\"\ + , # Optional. The GUID of the record.\n \"isIncomplete\": bool,\ + \ # Optional. Whether it is a\n shell entity.\n \ + \ \"labels\": [\n \"str\" # Optional. labels.\n\ + \ ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for\n concurrency control.\n \"meaningNames\"\ + : [\n \"str\" # Optional. An array of meanings.\n \ + \ ],\n \"meanings\": [\n \ + \ {\n \"confidence\": 0, # Optional. The\n \ + \ confidence of the term assignment.\n \ + \ \"createdBy\": \"str\", # Optional. The\n \ + \ user who created the record.\n \"description\":\ + \ \"str\", # Optional.\n The description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional.\n\ + \ The display text.\n \"\ + expression\": \"str\", # Optional. The\n expression\ + \ of the term assignment.\n \"relationGuid\": \"str\"\ + , # Optional.\n The GUID of the relationship.\n \ + \ \"source\": \"str\", # Optional. The\n \ + \ source of the term.\n \"status\"\ + : \"str\", # Optional. The\n status of terms assignment.\ + \ Known values are: \"DISCOVERED\",\n \"PROPOSED\"\ + , \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\",\n \"\ + OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The\n steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The\n \ + \ GUID of the term.\n }\n ],\n \ + \ \"status\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\"\ + .\n \"typeName\": \"str\" # Optional. The name of the type.\n\ + \ }\n ]\n },\n \"partialUpdatedEntities\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"classificationNames\": [\n \"str\" # Optional. An\ + \ array of classification names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.CollectionOperations.create_or_update_bulk + name: create_or_update_bulk + summary: 'Creates or updates entities in bulk to a collection. + + Existing entity is matched using its unique guid if supplied or by its unique + attributes eg: + + qualifiedName. + + Map and array of collections are not well supported. E.g., array*>, + + array>.' + signature: 'async create_or_update_bulk(collection: str, entities: MutableMapping[str, + Any], **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: collection + description: the collection unique name. + isRequired: true + types: + - + - name: entities + description: Atlas entities with extended information. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n entities\ + \ = {\n \"entities\": [\n {\n \"attributes\": {\n\ + \ \"str\": {} # Optional. The attributes of the struct.\n \ + \ },\n \"businessAttributes\": {\n \ + \ \"str\": {} # Optional. Business Attributes.\n },\n \ + \ \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\n\ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of\n the entity - can be active\ + \ or deleted. Deleted entities are not\n removed from\ + \ Atlas store. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag\n \ + \ for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, #\n Optional. Determines if propagations will\ + \ be removed on entity\n deletion.\n \ + \ \"source\": \"str\", # Optional. indicate the\n \ + \ source who create the classification detail.\n \"sourceDetails\"\ + : {\n \"str\": {} # Optional. more detail on\n \ + \ source information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"validityPeriods\": [\n\ + \ {\n \"endTime\": \"\ + str\", #\n Optional. The end of the time boundary.\n\ + \ \"startTime\": \"str\", #\n \ + \ Optional. The start of the time boundary.\n \ + \ \"timeZone\": \"str\" #\n Optional.\ + \ The timezone of the time boundary.\n }\n \ + \ ]\n }\n ],\n \"contacts\"\ + : {\n \"str\": [\n {\n \ + \ \"id\": \"str\", # Optional. Azure\n \ + \ Active Directory object Id.\n \"info\": \"str\" \ + \ # Optional. additional\n information to describe\ + \ this contact.\n }\n ]\n \ + \ },\n \"createTime\": 0.0, # Optional. The created time of the\n\ + \ record.\n \"createdBy\": \"str\", # Optional.\ + \ The user who created the\n record.\n \"customAttributes\"\ + : {\n \"str\": \"str\" # Optional. Custom Attribute.\n \ + \ },\n \"guid\": \"str\", # Optional. The GUID of the\ + \ entity.\n \"homeId\": \"str\", # Optional. The home ID of the\ + \ entity.\n \"isIncomplete\": bool, # Optional. Whether it is a\ + \ shell\n entity.\n \"labels\": [\n \ + \ \"str\" # Optional. labels.\n ],\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n ],\n \"referredEntities\"\ + : {\n \"str\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"businessAttributes\": {\n \"str\": {} # Optional.\ + \ Business Attributes.\n },\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \"id\"\ + : \"str\", # Optional. Azure\n Active Directory object\ + \ Id.\n \"info\": \"str\" # Optional. additional\n\ + \ information to describe this contact.\n \ + \ }\n ]\n },\n \"\ + createTime\": 0.0, # Optional. The created time of the\n record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the\n\ + \ record.\n \"customAttributes\": {\n \ + \ \"str\": \"str\" # Optional. Custom Attribute.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"homeId\": \"str\", # Optional. The home ID of the entity.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a shell\n \ + \ entity.\n \"labels\": [\n \"str\"\ + \ # Optional. labels.\n ],\n \"lastModifiedTS\":\ + \ \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n }\n }\n\n # response body\ + \ for status code(s): 200\n response.json() == {\n \"guidAssignments\"\ + : {\n \"str\": \"str\" # Optional. A map of GUID assignments with entities.\n\ + \ },\n \"mutatedEntities\": {\n \"str\": [\n \ + \ {\n \"attributes\": {\n \"str\":\ + \ {} # Optional. The attributes of the\n struct.\n \ + \ },\n \"classificationNames\": [\n \ + \ \"str\" # Optional. An array of classification\n \ + \ names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n\ + \ \"str\": {} # Optional. The\n \ + \ attributes of the struct.\n },\n\ + \ \"entityGuid\": \"str\", # Optional. The\n \ + \ GUID of the entity.\n \"entityStatus\"\ + : \"str\", # Optional.\n Status of the entity - can\ + \ be active or deleted. Deleted\n entities are not\ + \ removed from Atlas store. Known values are:\n \"\ + ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional.\n ETag for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\":\n \ + \ bool, # Optional. Determines if propagations will be removed\n\ + \ on entity deletion.\n \ + \ \"source\": \"str\", # Optional.\n indicate the\ + \ source who create the classification detail.\n \"\ + sourceDetails\": {\n \"str\": {} # Optional. more\n\ + \ detail on source information.\n \ + \ },\n \"typeName\": \"str\", # Optional.\ + \ The\n name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\",\n # Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the\ + \ time boundary.\n }\n \ + \ ]\n }\n ],\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"guid\": \"str\"\ + , # Optional. The GUID of the record.\n \"isIncomplete\": bool,\ + \ # Optional. Whether it is a\n shell entity.\n \ + \ \"labels\": [\n \"str\" # Optional. labels.\n\ + \ ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for\n concurrency control.\n \"meaningNames\"\ + : [\n \"str\" # Optional. An array of meanings.\n \ + \ ],\n \"meanings\": [\n \ + \ {\n \"confidence\": 0, # Optional. The\n \ + \ confidence of the term assignment.\n \ + \ \"createdBy\": \"str\", # Optional. The\n \ + \ user who created the record.\n \"description\":\ + \ \"str\", # Optional.\n The description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional.\n\ + \ The display text.\n \"\ + expression\": \"str\", # Optional. The\n expression\ + \ of the term assignment.\n \"relationGuid\": \"str\"\ + , # Optional.\n The GUID of the relationship.\n \ + \ \"source\": \"str\", # Optional. The\n \ + \ source of the term.\n \"status\"\ + : \"str\", # Optional. The\n status of terms assignment.\ + \ Known values are: \"DISCOVERED\",\n \"PROPOSED\"\ + , \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\",\n \"\ + OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The\n steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The\n \ + \ GUID of the term.\n }\n ],\n \ + \ \"status\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\"\ + .\n \"typeName\": \"str\" # Optional. The name of the type.\n\ + \ }\n ]\n },\n \"partialUpdatedEntities\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"classificationNames\": [\n \"str\" # Optional. An\ + \ array of classification names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.CollectionOperations.move_entities_to_collection + name: move_entities_to_collection + summary: Move existing entities to the target collection. + signature: 'async move_entities_to_collection(collection: str, move_entities_request: + MutableMapping[str, Any], **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: collection + description: the collection unique name. + isRequired: true + types: + - + - name: move_entities_request + description: Entity guids to be moved to target collection. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n move_entities_request\ + \ = {\n \"entityGuids\": [\n \"str\" # Optional. An array of\ + \ entity guids to be moved to target\n collection.\n ]\n }\n\ + \n # response body for status code(s): 200\n response.json() == {\n \ + \ \"guidAssignments\": {\n \"str\": \"str\" # Optional. A map of GUID\ + \ assignments with entities.\n },\n \"mutatedEntities\": {\n \ + \ \"str\": [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"classificationNames\"\ + : [\n \"str\" # Optional. An array of classification\n\ + \ names.\n ],\n \"\ + classifications\": [\n {\n \"\ + attributes\": {\n \"str\": {} # Optional. The\n\ + \ attributes of the struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional.\ + \ The\n GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional.\n \ + \ Status of the entity - can be active or deleted. Deleted\n \ + \ entities are not removed from Atlas store. Known values are:\n \ + \ \"ACTIVE\", \"DELETED\".\n \ + \ \"lastModifiedTS\": \"str\", # Optional.\n ETag\ + \ for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + :\n bool, # Optional. Determines if propagations\ + \ will be removed\n on entity deletion.\n \ + \ \"source\": \"str\", # Optional.\n \ + \ indicate the source who create the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\"\ + : {} # Optional. more\n detail on source information.\n\ + \ },\n \"typeName\": \"str\"\ + , # Optional. The\n name of the type.\n \ + \ \"validityPeriods\": [\n {\n\ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\",\n \ + \ # Optional. The start of the time boundary.\n \ + \ \"timeZone\": \"str\" #\n Optional.\ + \ The timezone of the time boundary.\n }\n \ + \ ]\n }\n ],\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"guid\": \"str\", # Optional. The GUID of the record.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a\n \ + \ shell entity.\n \"labels\": [\n \ + \ \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for\n \ + \ concurrency control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n \ + \ ],\n \"meanings\": [\n {\n \ + \ \"confidence\": 0, # Optional. The\n \ + \ confidence of the term assignment.\n \"createdBy\"\ + : \"str\", # Optional. The\n user who created the\ + \ record.\n \"description\": \"str\", # Optional.\n\ + \ The description of the term assignment.\n \ + \ \"displayText\": \"str\", # Optional.\n \ + \ The display text.\n \"expression\": \"\ + str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional.\n \ + \ The GUID of the relationship.\n \ + \ \"source\": \"str\", # Optional. The\n source\ + \ of the term.\n \"status\": \"str\", # Optional. The\n\ + \ status of terms assignment. Known values are: \"\ + DISCOVERED\",\n \"PROPOSED\", \"IMPORTED\", \"VALIDATED\"\ + , \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The\n \ + \ steward of the term.\n \"termGuid\"\ + : \"str\" # Optional. The\n GUID of the term.\n \ + \ }\n ],\n \"status\"\ + : \"str\", # Optional. Status of the entity -\n can be active\ + \ or deleted. Deleted entities are not removed from Atlas\n \ + \ store. Known values are: \"ACTIVE\", \"DELETED\".\n \"typeName\"\ + : \"str\" # Optional. The name of the type.\n }\n ]\n\ + \ },\n \"partialUpdatedEntities\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"classificationNames\": [\n\ + \ \"str\" # Optional. An array of classification names.\n \ + \ ],\n \"classifications\": [\n {\n\ + \ \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes\n of the struct.\n\ + \ },\n \"entityGuid\": \"str\", #\ + \ Optional. The GUID of\n the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of\n \ + \ the entity - can be active or deleted. Deleted entities are not\n \ + \ removed from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag\n for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n ]\n }\n ````\n" diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.DiscoveryOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.DiscoveryOperations.yml new file mode 100644 index 00000000..b1bbfa26 --- /dev/null +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.DiscoveryOperations.yml @@ -0,0 +1,272 @@ +### YamlMime:PythonClass +uid: azure.purview.catalog.aio.operations.DiscoveryOperations +name: DiscoveryOperations +fullName: azure.purview.catalog.aio.operations.DiscoveryOperations +module: azure.purview.catalog.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: DiscoveryOperations(*args, **kwargs) +methods: +- uid: azure.purview.catalog.aio.operations.DiscoveryOperations.auto_complete + name: auto_complete + summary: Get auto complete options. + signature: 'async auto_complete(auto_complete_request: MutableMapping[str, Any], + **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: auto_complete_request + description: An object specifying the autocomplete criteria. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n auto_complete_request\ + \ = {\n \"filter\": {}, # Optional. The filter for the autocomplete request.\n\ + \ \"keywords\": \"str\", # Optional. The keywords applied to all fields\ + \ that\n support autocomplete operation. It must be at least 1 character,\ + \ and no more than\n 100 characters.\n \"limit\": 0 # Optional.\ + \ The number of autocomplete results we hope to return.\n The default\ + \ value is 50. The value must be a number between 1 and 100.\n }\n\n # response\ + \ body for status code(s): 200\n response.json() == {\n \"value\": [\n\ + \ {\n \"queryPlusText\": \"str\", # Optional. The completed\ + \ search\n query text.\n \"text\": \"str\" # Optional.\ + \ The completed term or phrase.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.DiscoveryOperations.browse + name: browse + summary: Browse entities by path or entity type. + signature: 'async browse(browse_request: MutableMapping[str, Any], **kwargs: Any) + -> MutableMapping[str, Any]' + parameters: + - name: browse_request + description: An object specifying the browse criteria. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n browse_request\ + \ = {\n \"entityType\": \"str\", # Optional. The entity type to browse\ + \ as the root level\n entry point.\n \"limit\": 0, # Optional.\ + \ The number of browse items we hope to return. The\n maximum value is\ + \ 10000.\n \"offset\": 0, # Optional. The offset. The default value is\ + \ 0. The maximum\n value is 100000.\n \"path\": \"str\" # Optional.\ + \ The path to browse the next level child entities.\n }\n\n # response body\ + \ for status code(s): 200\n response.json() == {\n \"@search.count\":\ + \ 0, # Optional. The total number of browse results.\n \"value\": [\n \ + \ {\n \"entityType\": \"str\", # Optional. The type name\ + \ of the\n record.\n \"id\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isLeaf\": bool, # Optional. If the\ + \ record is a leaf entity.\n \"name\": \"str\", # Optional. The\ + \ name of the record.\n \"owner\": [\n {\n \ + \ \"contactType\": \"str\", # Optional. The\n \ + \ contact type of the owner. The value will be Owner.\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the owner.\n \"id\": \"str\", #\ + \ Optional. The GUID of the\n owner.\n \ + \ \"mail\": \"str\" # Optional. The mail of the\n \ + \ owner.\n }\n ],\n \"path\"\ + : \"str\", # Optional. The path of the record.\n \"qualifiedName\"\ + : \"str\" # Optional. The qualified name of the\n record.\n \ + \ }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.DiscoveryOperations.query + name: query + summary: Gets data using search. + signature: 'async query(search_request: MutableMapping[str, Any], **kwargs: Any) + -> MutableMapping[str, Any]' + parameters: + - name: search_request + description: An object specifying the search criteria. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n search_request\ + \ = {\n \"facets\": [\n {\n \"count\": 0, # Optional.\ + \ The count of the facet item.\n \"facet\": \"str\", # Optional.\ + \ The name of the facet item.\n \"sort\": {} # Optional. Any object.\n\ + \ }\n ],\n \"filter\": {}, # Optional. The filter for the\ + \ search. See examples for the\n usage of supported filters.\n \"\ + keywords\": \"str\", # Optional. The keywords applied to all searchable\n \ + \ fields.\n \"limit\": 0, # Optional. The limit of the number of the\ + \ search result.\n default value is 50; maximum value is 1000.\n \ + \ \"offset\": 0, # Optional. The offset. The default value is 0. The maximum\n\ + \ value is 100000.\n \"taxonomySetting\": {\n \"assetTypes\"\ + : [\n \"str\" # Optional.\n ],\n \"facet\"\ + : {\n \"count\": 0, # Optional. The count of the facet item.\n\ + \ \"facet\": \"str\", # Optional. The name of the facet item.\n\ + \ \"sort\": {} # Optional. Any object.\n }\n }\n\ + \ }\n\n # response body for status code(s): 200\n response.json() == {\n\ + \ \"@search.count\": 0, # Optional. The total number of search results\ + \ (not the\n number of documents in a single page).\n \"@search.facets\"\ + : {\n \"assetType\": [\n {\n \"count\"\ + : 0, # Optional. The count of the facet item.\n \"value\":\ + \ \"str\" # Optional. The name of the facet\n item.\n \ + \ }\n ],\n \"classification\": [\n \ + \ {\n \"count\": 0, # Optional. The count of the facet item.\n\ + \ \"value\": \"str\" # Optional. The name of the facet\n \ + \ item.\n }\n ],\n \"classificationCategory\"\ + : [\n {\n \"count\": 0, # Optional. The count\ + \ of the facet item.\n \"value\": \"str\" # Optional. The name\ + \ of the facet\n item.\n }\n ],\n\ + \ \"contactId\": [\n {\n \"count\":\ + \ 0, # Optional. The count of the facet item.\n \"value\":\ + \ \"str\" # Optional. The name of the facet\n item.\n \ + \ }\n ],\n \"fileExtension\": [\n \ + \ {\n \"count\": 0, # Optional. The count of the facet item.\n\ + \ \"value\": \"str\" # Optional. The name of the facet\n \ + \ item.\n }\n ],\n \"label\"\ + : [\n {\n \"count\": 0, # Optional. The count\ + \ of the facet item.\n \"value\": \"str\" # Optional. The name\ + \ of the facet\n item.\n }\n ],\n\ + \ \"term\": [\n {\n \"count\": 0, #\ + \ Optional. The count of the facet item.\n \"value\": \"str\"\ + \ # Optional. The name of the facet\n item.\n \ + \ }\n ]\n },\n \"value\": [\n {\n \ + \ \"@search.highlights\": {\n \"description\": [\n \ + \ \"str\" # Optional. A highlight list that\n \ + \ consists of index fields id ,qualifiedName, name, description,\n\ + \ entityType. When the keyword appears in those fields,\ + \ the value\n of the field, attached with emphasis mark,\ + \ is returned as an\n element of @search.highlights.\n\ + \ ],\n \"entityType\": [\n \ + \ \"str\" # Optional. A highlight list that\n \ + \ consists of index fields id ,qualifiedName, name, description,\n \ + \ entityType. When the keyword appears in those fields, the value\n\ + \ of the field, attached with emphasis mark, is returned\ + \ as an\n element of @search.highlights.\n \ + \ ],\n \"id\": [\n \"str\" # Optional.\ + \ A highlight list that\n consists of index fields id\ + \ ,qualifiedName, name, description,\n entityType. When\ + \ the keyword appears in those fields, the value\n of\ + \ the field, attached with emphasis mark, is returned as an\n \ + \ element of @search.highlights.\n ],\n \ + \ \"name\": [\n \"str\" # Optional. A highlight list\ + \ that\n consists of index fields id ,qualifiedName, name,\ + \ description,\n entityType. When the keyword appears\ + \ in those fields, the value\n of the field, attached\ + \ with emphasis mark, is returned as an\n element of @search.highlights.\n\ + \ ],\n \"qualifiedName\": [\n \ + \ \"str\" # Optional. A highlight list that\n \ + \ consists of index fields id ,qualifiedName, name, description,\n \ + \ entityType. When the keyword appears in those fields, the value\n\ + \ of the field, attached with emphasis mark, is returned\ + \ as an\n element of @search.highlights.\n \ + \ ]\n },\n \"@search.score\": 0.0, # Optional.\ + \ The search score\n calculated by the search engine. The results\ + \ are ordered by search score\n by default.\n \"\ + @search.text\": \"str\", # Optional. The target text that\n contains\ + \ the keyword as prefix. The keyword is wrapped with emphasis\n \ + \ mark.\n \"assetType\": [\n \"str\" # Optional.\ + \ The asset types of the record.\n ],\n \"classification\"\ + : [\n \"str\" # Optional. The classifications of the record.\n\ + \ ],\n \"contact\": [\n {\n \ + \ \"contactType\": \"str\", # Optional. The type\n \ + \ of the contact. It can be Expert or Owner for an entity. It\ + \ can\n be Expert or Steward for a glossary term.\n \ + \ \"id\": \"str\", # Optional. The GUID of the\n \ + \ contact.\n \"info\": \"str\" # Optional.\ + \ The description of\n the contact.\n \ + \ }\n ],\n \"description\": \"str\", # Optional.\ + \ The description of the\n record.\n \"entityType\"\ + : \"str\", # Optional. The type name of the\n record.\n \ + \ \"id\": \"str\", # Optional. The GUID of the record.\n \ + \ \"label\": [\n \"str\" # Optional. The labels of the record.\n\ + \ ],\n \"name\": \"str\", # Optional. The name of\ + \ the record.\n \"owner\": \"str\", # Optional. The owner of the\ + \ record. This is\n an Atlas native attribute.\n \ + \ \"qualifiedName\": \"str\", # Optional. The qualified name of\n \ + \ the record.\n \"term\": [\n {\n \ + \ \"glossaryName\": \"str\", # Optional. The name\n \ + \ of the glossary which contains the term.\n \ + \ \"guid\": \"str\", # Optional. The GUID of the\n \ + \ term.\n \"name\": \"str\" # Optional. The name of the\n\ + \ term.\n }\n ]\n \ + \ }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.DiscoveryOperations.suggest + name: suggest + summary: Get search suggestions by query criteria. + signature: 'async suggest(suggest_request: MutableMapping[str, Any], **kwargs: Any) + -> MutableMapping[str, Any]' + parameters: + - name: suggest_request + description: An object specifying the suggest criteria. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n suggest_request\ + \ = {\n \"filter\": {}, # Optional. The filter for the search.\n \ + \ \"keywords\": \"str\", # Optional. The keywords applied to all fields that\n\ + \ support suggest operation. It must be at least 1 character, and no more\ + \ than 100\n characters. In the index schema we defined a default suggester\ + \ which lists all\n the supported fields and specifies a search mode.\n\ + \ \"limit\": 0 # Optional. The number of suggestions we hope to return.\ + \ The\n default value is 5. The value must be a number between 1 and 100.\n\ + \ }\n\n # response body for status code(s): 200\n response.json() == {\n\ + \ \"value\": [\n {\n \"@search.score\": 0.0, #\ + \ Optional. The search score\n calculated by the search engine.\ + \ The results are ordered by search score\n by default.\n \ + \ \"@search.text\": \"str\", # Optional. The target text that\n \ + \ contains the keyword as prefix. The keyword is wrapped with emphasis\n\ + \ mark.\n \"assetType\": [\n \"\ + str\" # Optional. The asset types of the record.\n ],\n \ + \ \"classification\": [\n \"str\" # Optional. The classifications\ + \ of the record.\n ],\n \"contact\": [\n \ + \ {\n \"contactType\": \"str\", # Optional. The\ + \ type\n of the contact. It can be Expert or Owner for\ + \ an entity. It can\n be Expert or Steward for a glossary\ + \ term.\n \"id\": \"str\", # Optional. The GUID of the\n\ + \ contact.\n \"info\": \"str\" \ + \ # Optional. The description of\n the contact.\n \ + \ }\n ],\n \"description\": \"str\"\ + , # Optional. The description of the\n record.\n \ + \ \"entityType\": \"str\", # Optional. The type name of the\n \ + \ record.\n \"id\": \"str\", # Optional. The GUID of the record.\n\ + \ \"label\": [\n \"str\" # Optional. The labels\ + \ of the record.\n ],\n \"name\": \"str\", # Optional.\ + \ The name of the record.\n \"owner\": \"str\", # Optional. The\ + \ owner of the record. This is\n an Atlas native attribute.\n\ + \ \"qualifiedName\": \"str\", # Optional. The qualified name of\n\ + \ the record.\n \"term\": [\n \ + \ {\n \"glossaryName\": \"str\", # Optional. The name\n\ + \ of the glossary which contains the term.\n \ + \ \"guid\": \"str\", # Optional. The GUID of the\n \ + \ term.\n \"name\": \"str\" # Optional. The\ + \ name of the\n term.\n }\n \ + \ ]\n }\n ]\n }\n ````\n" diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.EntityOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.EntityOperations.yml new file mode 100644 index 00000000..bf42b39b --- /dev/null +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.EntityOperations.yml @@ -0,0 +1,3117 @@ +### YamlMime:PythonClass +uid: azure.purview.catalog.aio.operations.EntityOperations +name: EntityOperations +fullName: azure.purview.catalog.aio.operations.EntityOperations +module: azure.purview.catalog.aio.operations +constructor: + syntax: EntityOperations(*args, **kwargs) +methods: +- uid: azure.purview.catalog.aio.operations.EntityOperations.add_classification + name: add_classification + summary: Associate a classification to multiple entities in bulk. + signature: 'async add_classification(request: MutableMapping[str, Any], **kwargs: + Any) -> None' + parameters: + - name: request + description: The request to associate a classification to multiple entities. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n request\ + \ = {\n \"classification\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas store.\ + \ Known\n values are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional. Determines if\n propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate the\ + \ source who create the\n classification detail.\n \"sourceDetails\"\ + : {\n \"str\": {} # Optional. more detail on source information.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name of the\ + \ type.\n \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the time\n \ + \ boundary.\n \"startTime\": \"str\", # Optional. The start\ + \ of the\n time boundary.\n \"timeZone\"\ + : \"str\" # Optional. The timezone of the\n time boundary.\n\ + \ }\n ]\n },\n \"entityGuids\": [\n \ + \ \"str\" # Optional. The GUID of the entity.\n ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.add_classifications + name: add_classifications + summary: Add classifications to an existing entity represented by a GUID. + signature: 'async add_classifications(guid: str, classifications: List[MutableMapping[str, + Any]], **kwargs: Any) -> None' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: classifications + description: An array of classifications to be added. + isRequired: true + types: + - [] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n classifications\ + \ = [\n {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"entityGuid\": \"\ + str\", # Optional. The GUID of the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of the entity - can be\n active or deleted.\ + \ Deleted entities are not removed from Atlas store. Known\n values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional. Determines if\n propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate the\ + \ source who create the\n classification detail.\n \"sourceDetails\"\ + : {\n \"str\": {} # Optional. more detail on source information.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name of the\ + \ type.\n \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the time\n \ + \ boundary.\n \"startTime\": \"str\", # Optional. The start\ + \ of the\n time boundary.\n \"timeZone\"\ + : \"str\" # Optional. The timezone of the\n time boundary.\n\ + \ }\n ]\n }\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.add_classifications_by_unique_attribute + name: add_classifications_by_unique_attribute + summary: Add classification to the entity identified by its type and unique attributes. + signature: 'async add_classifications_by_unique_attribute(type_name: str, atlas_classification_array: + List[MutableMapping[str, Any]], *, attr_qualified_name: str | None = None, **kwargs: + Any) -> None' + parameters: + - name: type_name + description: The name of the type. + isRequired: true + types: + - + - name: atlas_classification_array + description: An array of classification to be added. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: attr_qualified_name + description: The qualified name of the entity. Default value is None. + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n atlas_classification_array\ + \ = [\n {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"entityGuid\": \"\ + str\", # Optional. The GUID of the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of the entity - can be\n active or deleted.\ + \ Deleted entities are not removed from Atlas store. Known\n values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional. Determines if\n propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate the\ + \ source who create the\n classification detail.\n \"sourceDetails\"\ + : {\n \"str\": {} # Optional. more detail on source information.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name of the\ + \ type.\n \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the time\n \ + \ boundary.\n \"startTime\": \"str\", # Optional. The start\ + \ of the\n time boundary.\n \"timeZone\"\ + : \"str\" # Optional. The timezone of the\n time boundary.\n\ + \ }\n ]\n }\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.add_label + name: add_label + summary: add given labels to a given entity. + signature: 'async add_label(guid: str, body: List[str] | None = None, **kwargs: + Any) -> None' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: body + description: set of labels to be added. Default value is None. + isRequired: true + types: + - [] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n body\ + \ = [\n \"str\" # Optional.\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.add_labels_by_unique_attribute + name: add_labels_by_unique_attribute + summary: 'Add given labels to a given entity identified by its type and unique attributes, + if labels is + + null/empty, no labels will be added. In addition to the typeName path parameter, + attribute + + key-value pair(s) can be provided in the following format: + + attr:``=:code:``. NOTE: The attrName and attrValue should + be unique + + across entities, eg. qualifiedName. The REST request would look something like + this: PUT + + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.' + signature: 'async add_labels_by_unique_attribute(type_name: str, body: List[str] + | None = None, *, attr_qualified_name: str | None = None, **kwargs: Any) -> None' + parameters: + - name: type_name + description: The name of the type. + isRequired: true + types: + - + - name: body + description: set of labels to be added. Default value is None. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: attr_qualified_name + description: The qualified name of the entity. Default value is None. + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n body\ + \ = [\n \"str\" # Optional.\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.add_or_update_business_metadata + name: add_or_update_business_metadata + summary: Add business metadata to an entity. + signature: 'async add_or_update_business_metadata(guid: str, body: Dict[str, Any] + | None = None, *, is_overwrite: bool | None = None, **kwargs: Any) -> None' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: body + description: Business Metadata. Default value is None. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: is_overwrite + description: 'Whether to overwrite the existing business metadata on the entity + or + + not, default is false.' + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n body\ + \ = {\n \"str\": {} # Optional.\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.add_or_update_business_metadata_attributes + name: add_or_update_business_metadata_attributes + summary: Add or update business metadata attributes. + signature: 'async add_or_update_business_metadata_attributes(bm_name: str, guid: + str, body: Dict[str, Any] | None = None, **kwargs: Any) -> None' + parameters: + - name: bm_name + description: BusinessMetadata name. + isRequired: true + types: + - + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: body + description: BusinessMetadataAttributes. Default value is None. + isRequired: true + types: + - [, ] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n body\ + \ = {\n \"str\": {} # Optional.\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.create_or_update + name: create_or_update + summary: 'Create or update an entity in Atlas. + + Existing entity is matched using its unique guid if supplied or by its unique + attributes eg: + + qualifiedName. + + Map and array of collections are not well supported. E.g., array*>, + + array>.' + signature: 'async create_or_update(entity: MutableMapping[str, Any], **kwargs: Any) + -> MutableMapping[str, Any]' + parameters: + - name: entity + description: Atlas entity with extended information. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n entity\ + \ = {\n \"entity\": {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \"\ + businessAttributes\": {\n \"str\": {} # Optional. Business Attributes.\n\ + \ },\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the\n struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional. The GUID of the\n\ + \ entity.\n \"entityStatus\": \"str\", \ + \ # Optional. Status of the\n entity - can be active or deleted.\ + \ Deleted entities are not removed\n from Atlas store. Known\ + \ values are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for\n concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the source who\n create the classification detail.\n\ + \ \"sourceDetails\": {\n \"str\": {} \ + \ # Optional. more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"validityPeriods\": [\n \ + \ {\n \"endTime\": \"str\", # Optional.\ + \ The\n end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n \ + \ start of the time boundary.\n \"timeZone\"\ + : \"str\" # Optional. The\n timezone of the time\ + \ boundary.\n }\n ]\n }\n\ + \ ],\n \"contacts\": {\n \"str\": [\n \ + \ {\n \"id\": \"str\", # Optional. Azure Active\n\ + \ Directory object Id.\n \"info\"\ + : \"str\" # Optional. additional\n information to describe\ + \ this contact.\n }\n ]\n },\n \ + \ \"createTime\": 0.0, # Optional. The created time of the record.\n \ + \ \"createdBy\": \"str\", # Optional. The user who created the record.\n\ + \ \"customAttributes\": {\n \"str\": \"str\" # Optional.\ + \ Custom Attribute.\n },\n \"guid\": \"str\", # Optional.\ + \ The GUID of the entity.\n \"homeId\": \"str\", # Optional. The home\ + \ ID of the entity.\n \"isIncomplete\": bool, # Optional. Whether it\ + \ is a shell entity.\n \"labels\": [\n \"str\" # Optional.\ + \ labels.\n ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"meanings\": [\n {\n\ + \ \"confidence\": 0, # Optional. The confidence of the\n \ + \ term assignment.\n \"createdBy\": \"str\"\ + , # Optional. The user who created\n the record.\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the term assignment.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n\ + \ relationship.\n \"source\": \"str\", \ + \ # Optional. The source of the term.\n \"status\": \"str\"\ + , # Optional. The status of terms\n assignment. Known values\ + \ are: \"DISCOVERED\", \"PROPOSED\", \"IMPORTED\",\n \"VALIDATED\"\ + , \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \"steward\": \"\ + str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, # Optional. Used\ + \ to record the provenance of\n an instance of an entity or relationship.\n\ + \ \"proxy\": bool, # Optional. Determines if there's a proxy.\n \ + \ \"relationshipAttributes\": {\n \"str\": {} # Optional.\ + \ The attributes of relationship.\n },\n \"source\": \"str\"\ + , # Optional. indicate the source who create the\n classification\ + \ detail.\n \"sourceDetails\": {\n \"str\": {} # Optional.\ + \ more detail on source information.\n },\n \"status\": \"\ + str\", # Optional. Status of the entity - can be active or\n deleted.\ + \ Deleted entities are not removed from Atlas store. Known values are:\n \ + \ \"ACTIVE\", \"DELETED\".\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the record.\n \"updatedBy\": \"str\", # Optional. The user\ + \ who updated the record.\n \"version\": 0.0 # Optional. The version\ + \ of the entity.\n },\n \"referredEntities\": {\n \"str\"\ + : {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"businessAttributes\"\ + : {\n \"str\": {} # Optional. Business Attributes.\n \ + \ },\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {}\ + \ # Optional. The attributes\n of the struct.\n \ + \ },\n \"entityGuid\": \"str\", #\ + \ Optional. The GUID of\n the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of\n \ + \ the entity - can be active or deleted. Deleted entities are not\n \ + \ removed from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag\n for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \"id\"\ + : \"str\", # Optional. Azure\n Active Directory object\ + \ Id.\n \"info\": \"str\" # Optional. additional\n\ + \ information to describe this contact.\n \ + \ }\n ]\n },\n \"\ + createTime\": 0.0, # Optional. The created time of the\n record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the\n\ + \ record.\n \"customAttributes\": {\n \ + \ \"str\": \"str\" # Optional. Custom Attribute.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"homeId\": \"str\", # Optional. The home ID of the entity.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a shell\n \ + \ entity.\n \"labels\": [\n \"str\"\ + \ # Optional. labels.\n ],\n \"lastModifiedTS\":\ + \ \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n }\n }\n\n # response body\ + \ for status code(s): 200\n response.json() == {\n \"guidAssignments\"\ + : {\n \"str\": \"str\" # Optional. A map of GUID assignments with entities.\n\ + \ },\n \"mutatedEntities\": {\n \"str\": [\n \ + \ {\n \"attributes\": {\n \"str\":\ + \ {} # Optional. The attributes of the\n struct.\n \ + \ },\n \"classificationNames\": [\n \ + \ \"str\" # Optional. An array of classification\n \ + \ names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n\ + \ \"str\": {} # Optional. The\n \ + \ attributes of the struct.\n },\n\ + \ \"entityGuid\": \"str\", # Optional. The\n \ + \ GUID of the entity.\n \"entityStatus\"\ + : \"str\", # Optional.\n Status of the entity - can\ + \ be active or deleted. Deleted\n entities are not\ + \ removed from Atlas store. Known values are:\n \"\ + ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional.\n ETag for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\":\n \ + \ bool, # Optional. Determines if propagations will be removed\n\ + \ on entity deletion.\n \ + \ \"source\": \"str\", # Optional.\n indicate the\ + \ source who create the classification detail.\n \"\ + sourceDetails\": {\n \"str\": {} # Optional. more\n\ + \ detail on source information.\n \ + \ },\n \"typeName\": \"str\", # Optional.\ + \ The\n name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\",\n # Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the\ + \ time boundary.\n }\n \ + \ ]\n }\n ],\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"guid\": \"str\"\ + , # Optional. The GUID of the record.\n \"isIncomplete\": bool,\ + \ # Optional. Whether it is a\n shell entity.\n \ + \ \"labels\": [\n \"str\" # Optional. labels.\n\ + \ ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for\n concurrency control.\n \"meaningNames\"\ + : [\n \"str\" # Optional. An array of meanings.\n \ + \ ],\n \"meanings\": [\n \ + \ {\n \"confidence\": 0, # Optional. The\n \ + \ confidence of the term assignment.\n \ + \ \"createdBy\": \"str\", # Optional. The\n \ + \ user who created the record.\n \"description\":\ + \ \"str\", # Optional.\n The description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional.\n\ + \ The display text.\n \"\ + expression\": \"str\", # Optional. The\n expression\ + \ of the term assignment.\n \"relationGuid\": \"str\"\ + , # Optional.\n The GUID of the relationship.\n \ + \ \"source\": \"str\", # Optional. The\n \ + \ source of the term.\n \"status\"\ + : \"str\", # Optional. The\n status of terms assignment.\ + \ Known values are: \"DISCOVERED\",\n \"PROPOSED\"\ + , \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\",\n \"\ + OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The\n steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The\n \ + \ GUID of the term.\n }\n ],\n \ + \ \"status\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\"\ + .\n \"typeName\": \"str\" # Optional. The name of the type.\n\ + \ }\n ]\n },\n \"partialUpdatedEntities\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"classificationNames\": [\n \"str\" # Optional. An\ + \ array of classification names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.create_or_update_entities + name: create_or_update_entities + summary: 'Create or update entities in Atlas in bulk. + + Existing entity is matched using its unique guid if supplied or by its unique + attributes eg: + + qualifiedName. + + Map and array of collections are not well supported. E.g., array*>, + + array>.' + signature: 'async create_or_update_entities(entities: MutableMapping[str, Any], + **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: entities + description: An array of entities to create or update. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n entities\ + \ = {\n \"entities\": [\n {\n \"attributes\": {\n\ + \ \"str\": {} # Optional. The attributes of the struct.\n \ + \ },\n \"businessAttributes\": {\n \ + \ \"str\": {} # Optional. Business Attributes.\n },\n \ + \ \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\n\ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of\n the entity - can be active\ + \ or deleted. Deleted entities are not\n removed from\ + \ Atlas store. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag\n \ + \ for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, #\n Optional. Determines if propagations will\ + \ be removed on entity\n deletion.\n \ + \ \"source\": \"str\", # Optional. indicate the\n \ + \ source who create the classification detail.\n \"sourceDetails\"\ + : {\n \"str\": {} # Optional. more detail on\n \ + \ source information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"validityPeriods\": [\n\ + \ {\n \"endTime\": \"\ + str\", #\n Optional. The end of the time boundary.\n\ + \ \"startTime\": \"str\", #\n \ + \ Optional. The start of the time boundary.\n \ + \ \"timeZone\": \"str\" #\n Optional.\ + \ The timezone of the time boundary.\n }\n \ + \ ]\n }\n ],\n \"contacts\"\ + : {\n \"str\": [\n {\n \ + \ \"id\": \"str\", # Optional. Azure\n \ + \ Active Directory object Id.\n \"info\": \"str\" \ + \ # Optional. additional\n information to describe\ + \ this contact.\n }\n ]\n \ + \ },\n \"createTime\": 0.0, # Optional. The created time of the\n\ + \ record.\n \"createdBy\": \"str\", # Optional.\ + \ The user who created the\n record.\n \"customAttributes\"\ + : {\n \"str\": \"str\" # Optional. Custom Attribute.\n \ + \ },\n \"guid\": \"str\", # Optional. The GUID of the\ + \ entity.\n \"homeId\": \"str\", # Optional. The home ID of the\ + \ entity.\n \"isIncomplete\": bool, # Optional. Whether it is a\ + \ shell\n entity.\n \"labels\": [\n \ + \ \"str\" # Optional. labels.\n ],\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n ],\n \"referredEntities\"\ + : {\n \"str\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"businessAttributes\": {\n \"str\": {} # Optional.\ + \ Business Attributes.\n },\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \"id\"\ + : \"str\", # Optional. Azure\n Active Directory object\ + \ Id.\n \"info\": \"str\" # Optional. additional\n\ + \ information to describe this contact.\n \ + \ }\n ]\n },\n \"\ + createTime\": 0.0, # Optional. The created time of the\n record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the\n\ + \ record.\n \"customAttributes\": {\n \ + \ \"str\": \"str\" # Optional. Custom Attribute.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"homeId\": \"str\", # Optional. The home ID of the entity.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a shell\n \ + \ entity.\n \"labels\": [\n \"str\"\ + \ # Optional. labels.\n ],\n \"lastModifiedTS\":\ + \ \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n }\n }\n\n # response body\ + \ for status code(s): 200\n response.json() == {\n \"guidAssignments\"\ + : {\n \"str\": \"str\" # Optional. A map of GUID assignments with entities.\n\ + \ },\n \"mutatedEntities\": {\n \"str\": [\n \ + \ {\n \"attributes\": {\n \"str\":\ + \ {} # Optional. The attributes of the\n struct.\n \ + \ },\n \"classificationNames\": [\n \ + \ \"str\" # Optional. An array of classification\n \ + \ names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n\ + \ \"str\": {} # Optional. The\n \ + \ attributes of the struct.\n },\n\ + \ \"entityGuid\": \"str\", # Optional. The\n \ + \ GUID of the entity.\n \"entityStatus\"\ + : \"str\", # Optional.\n Status of the entity - can\ + \ be active or deleted. Deleted\n entities are not\ + \ removed from Atlas store. Known values are:\n \"\ + ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional.\n ETag for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\":\n \ + \ bool, # Optional. Determines if propagations will be removed\n\ + \ on entity deletion.\n \ + \ \"source\": \"str\", # Optional.\n indicate the\ + \ source who create the classification detail.\n \"\ + sourceDetails\": {\n \"str\": {} # Optional. more\n\ + \ detail on source information.\n \ + \ },\n \"typeName\": \"str\", # Optional.\ + \ The\n name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\",\n # Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the\ + \ time boundary.\n }\n \ + \ ]\n }\n ],\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"guid\": \"str\"\ + , # Optional. The GUID of the record.\n \"isIncomplete\": bool,\ + \ # Optional. Whether it is a\n shell entity.\n \ + \ \"labels\": [\n \"str\" # Optional. labels.\n\ + \ ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for\n concurrency control.\n \"meaningNames\"\ + : [\n \"str\" # Optional. An array of meanings.\n \ + \ ],\n \"meanings\": [\n \ + \ {\n \"confidence\": 0, # Optional. The\n \ + \ confidence of the term assignment.\n \ + \ \"createdBy\": \"str\", # Optional. The\n \ + \ user who created the record.\n \"description\":\ + \ \"str\", # Optional.\n The description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional.\n\ + \ The display text.\n \"\ + expression\": \"str\", # Optional. The\n expression\ + \ of the term assignment.\n \"relationGuid\": \"str\"\ + , # Optional.\n The GUID of the relationship.\n \ + \ \"source\": \"str\", # Optional. The\n \ + \ source of the term.\n \"status\"\ + : \"str\", # Optional. The\n status of terms assignment.\ + \ Known values are: \"DISCOVERED\",\n \"PROPOSED\"\ + , \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\",\n \"\ + OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The\n steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The\n \ + \ GUID of the term.\n }\n ],\n \ + \ \"status\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\"\ + .\n \"typeName\": \"str\" # Optional. The name of the type.\n\ + \ }\n ]\n },\n \"partialUpdatedEntities\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"classificationNames\": [\n \"str\" # Optional. An\ + \ array of classification names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.delete_business_metadata + name: delete_business_metadata + summary: Remove business metadata from an entity. + signature: 'async delete_business_metadata(guid: str, body: Dict[str, Any] | None + = None, **kwargs: Any) -> None' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: body + description: BusinessMetadata. Default value is None. + isRequired: true + types: + - [, ] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n body\ + \ = {\n \"str\": {} # Optional.\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.delete_business_metadata_attributes + name: delete_business_metadata_attributes + summary: Delete business metadata attributes from an entity. + signature: 'async delete_business_metadata_attributes(bm_name: str, guid: str, body: + Dict[str, Any] | None = None, **kwargs: Any) -> None' + parameters: + - name: bm_name + description: BusinessMetadata name. + isRequired: true + types: + - + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: body + description: BusinessMetadataAttributes. Default value is None. + isRequired: true + types: + - [, ] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n body\ + \ = {\n \"str\": {} # Optional.\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.delete_by_guid + name: delete_by_guid + summary: Delete an entity identified by its GUID. + signature: 'async delete_by_guid(guid: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + guidAssignments\": {\n \"str\": \"str\" # Optional. A map of GUID assignments\ + \ with entities.\n },\n \"mutatedEntities\": {\n \"str\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"classificationNames\"\ + : [\n \"str\" # Optional. An array of classification\n\ + \ names.\n ],\n \"\ + classifications\": [\n {\n \"\ + attributes\": {\n \"str\": {} # Optional. The\n\ + \ attributes of the struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional.\ + \ The\n GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional.\n \ + \ Status of the entity - can be active or deleted. Deleted\n \ + \ entities are not removed from Atlas store. Known values are:\n \ + \ \"ACTIVE\", \"DELETED\".\n \ + \ \"lastModifiedTS\": \"str\", # Optional.\n ETag\ + \ for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + :\n bool, # Optional. Determines if propagations\ + \ will be removed\n on entity deletion.\n \ + \ \"source\": \"str\", # Optional.\n \ + \ indicate the source who create the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\"\ + : {} # Optional. more\n detail on source information.\n\ + \ },\n \"typeName\": \"str\"\ + , # Optional. The\n name of the type.\n \ + \ \"validityPeriods\": [\n {\n\ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\",\n \ + \ # Optional. The start of the time boundary.\n \ + \ \"timeZone\": \"str\" #\n Optional.\ + \ The timezone of the time boundary.\n }\n \ + \ ]\n }\n ],\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"guid\": \"str\", # Optional. The GUID of the record.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a\n \ + \ shell entity.\n \"labels\": [\n \ + \ \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for\n \ + \ concurrency control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n \ + \ ],\n \"meanings\": [\n {\n \ + \ \"confidence\": 0, # Optional. The\n \ + \ confidence of the term assignment.\n \"createdBy\"\ + : \"str\", # Optional. The\n user who created the\ + \ record.\n \"description\": \"str\", # Optional.\n\ + \ The description of the term assignment.\n \ + \ \"displayText\": \"str\", # Optional.\n \ + \ The display text.\n \"expression\": \"\ + str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional.\n \ + \ The GUID of the relationship.\n \ + \ \"source\": \"str\", # Optional. The\n source\ + \ of the term.\n \"status\": \"str\", # Optional. The\n\ + \ status of terms assignment. Known values are: \"\ + DISCOVERED\",\n \"PROPOSED\", \"IMPORTED\", \"VALIDATED\"\ + , \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The\n \ + \ steward of the term.\n \"termGuid\"\ + : \"str\" # Optional. The\n GUID of the term.\n \ + \ }\n ],\n \"status\"\ + : \"str\", # Optional. Status of the entity -\n can be active\ + \ or deleted. Deleted entities are not removed from Atlas\n \ + \ store. Known values are: \"ACTIVE\", \"DELETED\".\n \"typeName\"\ + : \"str\" # Optional. The name of the type.\n }\n ]\n\ + \ },\n \"partialUpdatedEntities\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"classificationNames\": [\n\ + \ \"str\" # Optional. An array of classification names.\n \ + \ ],\n \"classifications\": [\n {\n\ + \ \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes\n of the struct.\n\ + \ },\n \"entityGuid\": \"str\", #\ + \ Optional. The GUID of\n the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of\n \ + \ the entity - can be active or deleted. Deleted entities are not\n \ + \ removed from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag\n for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.delete_by_guids + name: delete_by_guids + summary: Delete a list of entities in bulk identified by their GUIDs or unique attributes. + signature: 'async delete_by_guids(*, guids: List[str], **kwargs: Any) -> MutableMapping[str, + Any]' + keywordOnlyParameters: + - name: guids + description: An array of GUIDs of entities to delete. + types: + - [] + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + guidAssignments\": {\n \"str\": \"str\" # Optional. A map of GUID assignments\ + \ with entities.\n },\n \"mutatedEntities\": {\n \"str\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"classificationNames\"\ + : [\n \"str\" # Optional. An array of classification\n\ + \ names.\n ],\n \"\ + classifications\": [\n {\n \"\ + attributes\": {\n \"str\": {} # Optional. The\n\ + \ attributes of the struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional.\ + \ The\n GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional.\n \ + \ Status of the entity - can be active or deleted. Deleted\n \ + \ entities are not removed from Atlas store. Known values are:\n \ + \ \"ACTIVE\", \"DELETED\".\n \ + \ \"lastModifiedTS\": \"str\", # Optional.\n ETag\ + \ for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + :\n bool, # Optional. Determines if propagations\ + \ will be removed\n on entity deletion.\n \ + \ \"source\": \"str\", # Optional.\n \ + \ indicate the source who create the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\"\ + : {} # Optional. more\n detail on source information.\n\ + \ },\n \"typeName\": \"str\"\ + , # Optional. The\n name of the type.\n \ + \ \"validityPeriods\": [\n {\n\ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\",\n \ + \ # Optional. The start of the time boundary.\n \ + \ \"timeZone\": \"str\" #\n Optional.\ + \ The timezone of the time boundary.\n }\n \ + \ ]\n }\n ],\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"guid\": \"str\", # Optional. The GUID of the record.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a\n \ + \ shell entity.\n \"labels\": [\n \ + \ \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for\n \ + \ concurrency control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n \ + \ ],\n \"meanings\": [\n {\n \ + \ \"confidence\": 0, # Optional. The\n \ + \ confidence of the term assignment.\n \"createdBy\"\ + : \"str\", # Optional. The\n user who created the\ + \ record.\n \"description\": \"str\", # Optional.\n\ + \ The description of the term assignment.\n \ + \ \"displayText\": \"str\", # Optional.\n \ + \ The display text.\n \"expression\": \"\ + str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional.\n \ + \ The GUID of the relationship.\n \ + \ \"source\": \"str\", # Optional. The\n source\ + \ of the term.\n \"status\": \"str\", # Optional. The\n\ + \ status of terms assignment. Known values are: \"\ + DISCOVERED\",\n \"PROPOSED\", \"IMPORTED\", \"VALIDATED\"\ + , \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The\n \ + \ steward of the term.\n \"termGuid\"\ + : \"str\" # Optional. The\n GUID of the term.\n \ + \ }\n ],\n \"status\"\ + : \"str\", # Optional. Status of the entity -\n can be active\ + \ or deleted. Deleted entities are not removed from Atlas\n \ + \ store. Known values are: \"ACTIVE\", \"DELETED\".\n \"typeName\"\ + : \"str\" # Optional. The name of the type.\n }\n ]\n\ + \ },\n \"partialUpdatedEntities\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"classificationNames\": [\n\ + \ \"str\" # Optional. An array of classification names.\n \ + \ ],\n \"classifications\": [\n {\n\ + \ \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes\n of the struct.\n\ + \ },\n \"entityGuid\": \"str\", #\ + \ Optional. The GUID of\n the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of\n \ + \ the entity - can be active or deleted. Deleted entities are not\n \ + \ removed from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag\n for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.delete_by_unique_attribute + name: delete_by_unique_attribute + summary: 'Delete an entity identified by its type and unique attributes. + + In addition to the typeName path parameter, attribute key-value pair(s) can be + provided in the + + following format: + + attr::code:*`=:code:`*. + + NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. + + The REST request would look something like this: + + DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.' + signature: 'async delete_by_unique_attribute(type_name: str, *, attr_qualified_name: + str | None = None, **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: type_name + description: The name of the type. + isRequired: true + types: + - + keywordOnlyParameters: + - name: attr_qualified_name + description: The qualified name of the entity. Default value is None. + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + guidAssignments\": {\n \"str\": \"str\" # Optional. A map of GUID assignments\ + \ with entities.\n },\n \"mutatedEntities\": {\n \"str\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"classificationNames\"\ + : [\n \"str\" # Optional. An array of classification\n\ + \ names.\n ],\n \"\ + classifications\": [\n {\n \"\ + attributes\": {\n \"str\": {} # Optional. The\n\ + \ attributes of the struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional.\ + \ The\n GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional.\n \ + \ Status of the entity - can be active or deleted. Deleted\n \ + \ entities are not removed from Atlas store. Known values are:\n \ + \ \"ACTIVE\", \"DELETED\".\n \ + \ \"lastModifiedTS\": \"str\", # Optional.\n ETag\ + \ for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + :\n bool, # Optional. Determines if propagations\ + \ will be removed\n on entity deletion.\n \ + \ \"source\": \"str\", # Optional.\n \ + \ indicate the source who create the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\"\ + : {} # Optional. more\n detail on source information.\n\ + \ },\n \"typeName\": \"str\"\ + , # Optional. The\n name of the type.\n \ + \ \"validityPeriods\": [\n {\n\ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\",\n \ + \ # Optional. The start of the time boundary.\n \ + \ \"timeZone\": \"str\" #\n Optional.\ + \ The timezone of the time boundary.\n }\n \ + \ ]\n }\n ],\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"guid\": \"str\", # Optional. The GUID of the record.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a\n \ + \ shell entity.\n \"labels\": [\n \ + \ \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for\n \ + \ concurrency control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n \ + \ ],\n \"meanings\": [\n {\n \ + \ \"confidence\": 0, # Optional. The\n \ + \ confidence of the term assignment.\n \"createdBy\"\ + : \"str\", # Optional. The\n user who created the\ + \ record.\n \"description\": \"str\", # Optional.\n\ + \ The description of the term assignment.\n \ + \ \"displayText\": \"str\", # Optional.\n \ + \ The display text.\n \"expression\": \"\ + str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional.\n \ + \ The GUID of the relationship.\n \ + \ \"source\": \"str\", # Optional. The\n source\ + \ of the term.\n \"status\": \"str\", # Optional. The\n\ + \ status of terms assignment. Known values are: \"\ + DISCOVERED\",\n \"PROPOSED\", \"IMPORTED\", \"VALIDATED\"\ + , \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The\n \ + \ steward of the term.\n \"termGuid\"\ + : \"str\" # Optional. The\n GUID of the term.\n \ + \ }\n ],\n \"status\"\ + : \"str\", # Optional. Status of the entity -\n can be active\ + \ or deleted. Deleted entities are not removed from Atlas\n \ + \ store. Known values are: \"ACTIVE\", \"DELETED\".\n \"typeName\"\ + : \"str\" # Optional. The name of the type.\n }\n ]\n\ + \ },\n \"partialUpdatedEntities\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"classificationNames\": [\n\ + \ \"str\" # Optional. An array of classification names.\n \ + \ ],\n \"classifications\": [\n {\n\ + \ \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes\n of the struct.\n\ + \ },\n \"entityGuid\": \"str\", #\ + \ Optional. The GUID of\n the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of\n \ + \ the entity - can be active or deleted. Deleted entities are not\n \ + \ removed from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag\n for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.delete_classification + name: delete_classification + summary: Delete a given classification from an existing entity represented by a + GUID. + signature: 'async delete_classification(guid: str, classification_name: str, **kwargs: + Any) -> None' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: classification_name + description: The name of the classification. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.purview.catalog.aio.operations.EntityOperations.delete_classification_by_unique_attribute + name: delete_classification_by_unique_attribute + summary: Delete a given classification from an entity identified by its type and + unique attributes. + signature: 'async delete_classification_by_unique_attribute(type_name: str, classification_name: + str, *, attr_qualified_name: str | None = None, **kwargs: Any) -> None' + parameters: + - name: type_name + description: The name of the type. + isRequired: true + types: + - + - name: classification_name + description: The name of the classification. + isRequired: true + types: + - + keywordOnlyParameters: + - name: attr_qualified_name + description: The qualified name of the entity. Default value is None. + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.purview.catalog.aio.operations.EntityOperations.delete_labels + name: delete_labels + summary: delete given labels to a given entity. + signature: 'async delete_labels(guid: str, body: List[str] | None = None, **kwargs: + Any) -> None' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: body + description: set of labels to be deleted. Default value is None. + isRequired: true + types: + - [] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n body\ + \ = [\n \"str\" # Optional.\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.delete_labels_by_unique_attribute + name: delete_labels_by_unique_attribute + summary: 'Delete given labels to a given entity identified by its type and unique + attributes, if labels + + is null/empty, no labels will be removed. If any labels in labels set are non-existing + labels, + + they will be ignored, only existing labels will be removed. In addition to the + typeName path + + parameter, attribute key-value pair(s) can be provided in the following format: + + attr:``=:code:``. NOTE: The attrName and attrValue should + be unique + + across entities, eg. qualifiedName. The REST request would look something like + this: DELETE + + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.' + signature: 'async delete_labels_by_unique_attribute(type_name: str, body: List[str] + | None = None, *, attr_qualified_name: str | None = None, **kwargs: Any) -> None' + parameters: + - name: type_name + description: The name of the type. + isRequired: true + types: + - + - name: body + description: set of labels to be deleted. Default value is None. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: attr_qualified_name + description: The qualified name of the entity. Default value is None. + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n body\ + \ = [\n \"str\" # Optional.\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.get_by_guid + name: get_by_guid + summary: Get complete definition of an entity given its GUID. + signature: 'async get_by_guid(guid: str, *, min_ext_info: bool | None = False, ignore_relationships: + bool | None = False, **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + keywordOnlyParameters: + - name: min_ext_info + description: 'Whether to return minimal information for referred entities. Default + + value is False.' + types: + - + - name: ignore_relationships + description: 'Whether to ignore relationship attributes. Default value is + + False.' + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + entity\": {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"businessAttributes\"\ + : {\n \"str\": {} # Optional. Business Attributes.\n \ + \ },\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the\n struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the\n \ + \ entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of the\n entity - can be active or deleted. Deleted\ + \ entities are not removed\n from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag for\n concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who\n create the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional.\ + \ more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n \ + \ {\n \"endTime\": \"str\", # Optional. The\n \ + \ end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n start\ + \ of the time boundary.\n \"timeZone\": \"str\" # Optional.\ + \ The\n timezone of the time boundary.\n \ + \ }\n ]\n }\n ],\n \ + \ \"contacts\": {\n \"str\": [\n {\n \ + \ \"id\": \"str\", # Optional. Azure Active\n \ + \ Directory object Id.\n \"info\": \"str\" \ + \ # Optional. additional\n information to describe this\ + \ contact.\n }\n ]\n },\n \ + \ \"createTime\": 0.0, # Optional. The created time of the record.\n \ + \ \"createdBy\": \"str\", # Optional. The user who created the record.\n \ + \ \"customAttributes\": {\n \"str\": \"str\" # Optional.\ + \ Custom Attribute.\n },\n \"guid\": \"str\", # Optional.\ + \ The GUID of the entity.\n \"homeId\": \"str\", # Optional. The home\ + \ ID of the entity.\n \"isIncomplete\": bool, # Optional. Whether it\ + \ is a shell entity.\n \"labels\": [\n \"str\" # Optional.\ + \ labels.\n ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"meanings\": [\n {\n\ + \ \"confidence\": 0, # Optional. The confidence of the\n \ + \ term assignment.\n \"createdBy\": \"str\"\ + , # Optional. The user who created\n the record.\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the term assignment.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n\ + \ relationship.\n \"source\": \"str\", \ + \ # Optional. The source of the term.\n \"status\": \"str\"\ + , # Optional. The status of terms\n assignment. Known values\ + \ are: \"DISCOVERED\", \"PROPOSED\", \"IMPORTED\",\n \"VALIDATED\"\ + , \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \"steward\": \"\ + str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, # Optional. Used\ + \ to record the provenance of\n an instance of an entity or relationship.\n\ + \ \"proxy\": bool, # Optional. Determines if there's a proxy.\n \ + \ \"relationshipAttributes\": {\n \"str\": {} # Optional.\ + \ The attributes of relationship.\n },\n \"source\": \"str\"\ + , # Optional. indicate the source who create the\n classification\ + \ detail.\n \"sourceDetails\": {\n \"str\": {} # Optional.\ + \ more detail on source information.\n },\n \"status\": \"\ + str\", # Optional. Status of the entity - can be active or\n deleted.\ + \ Deleted entities are not removed from Atlas store. Known values are:\n \ + \ \"ACTIVE\", \"DELETED\".\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the record.\n \"updatedBy\": \"str\", # Optional. The user\ + \ who updated the record.\n \"version\": 0.0 # Optional. The version\ + \ of the entity.\n },\n \"referredEntities\": {\n \"str\"\ + : {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"businessAttributes\"\ + : {\n \"str\": {} # Optional. Business Attributes.\n \ + \ },\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {}\ + \ # Optional. The attributes\n of the struct.\n \ + \ },\n \"entityGuid\": \"str\", #\ + \ Optional. The GUID of\n the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of\n \ + \ the entity - can be active or deleted. Deleted entities are not\n \ + \ removed from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag\n for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \"id\"\ + : \"str\", # Optional. Azure\n Active Directory object\ + \ Id.\n \"info\": \"str\" # Optional. additional\n\ + \ information to describe this contact.\n \ + \ }\n ]\n },\n \"\ + createTime\": 0.0, # Optional. The created time of the\n record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the\n\ + \ record.\n \"customAttributes\": {\n \ + \ \"str\": \"str\" # Optional. Custom Attribute.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"homeId\": \"str\", # Optional. The home ID of the entity.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a shell\n \ + \ entity.\n \"labels\": [\n \"str\"\ + \ # Optional. labels.\n ],\n \"lastModifiedTS\":\ + \ \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n }\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.get_by_unique_attributes + name: get_by_unique_attributes + summary: 'Get complete definition of an entity given its type and unique attribute. + + In addition to the typeName path parameter, attribute key-value pair(s) can be + provided in the + + following format: + + attr::code:*`=:code:`*. + + NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. + + The REST request would look something like this: + + GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.' + signature: 'async get_by_unique_attributes(type_name: str, *, min_ext_info: bool + | None = False, ignore_relationships: bool | None = False, attr_qualified_name: + str | None = None, **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: type_name + description: The name of the type. + isRequired: true + types: + - + keywordOnlyParameters: + - name: min_ext_info + description: 'Whether to return minimal information for referred entities. Default + + value is False.' + types: + - + - name: ignore_relationships + description: 'Whether to ignore relationship attributes. Default value is + + False.' + types: + - + - name: attr_qualified_name + description: The qualified name of the entity. Default value is None. + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + entity\": {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"businessAttributes\"\ + : {\n \"str\": {} # Optional. Business Attributes.\n \ + \ },\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the\n struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the\n \ + \ entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of the\n entity - can be active or deleted. Deleted\ + \ entities are not removed\n from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag for\n concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who\n create the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional.\ + \ more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n \ + \ {\n \"endTime\": \"str\", # Optional. The\n \ + \ end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n start\ + \ of the time boundary.\n \"timeZone\": \"str\" # Optional.\ + \ The\n timezone of the time boundary.\n \ + \ }\n ]\n }\n ],\n \ + \ \"contacts\": {\n \"str\": [\n {\n \ + \ \"id\": \"str\", # Optional. Azure Active\n \ + \ Directory object Id.\n \"info\": \"str\" \ + \ # Optional. additional\n information to describe this\ + \ contact.\n }\n ]\n },\n \ + \ \"createTime\": 0.0, # Optional. The created time of the record.\n \ + \ \"createdBy\": \"str\", # Optional. The user who created the record.\n \ + \ \"customAttributes\": {\n \"str\": \"str\" # Optional.\ + \ Custom Attribute.\n },\n \"guid\": \"str\", # Optional.\ + \ The GUID of the entity.\n \"homeId\": \"str\", # Optional. The home\ + \ ID of the entity.\n \"isIncomplete\": bool, # Optional. Whether it\ + \ is a shell entity.\n \"labels\": [\n \"str\" # Optional.\ + \ labels.\n ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"meanings\": [\n {\n\ + \ \"confidence\": 0, # Optional. The confidence of the\n \ + \ term assignment.\n \"createdBy\": \"str\"\ + , # Optional. The user who created\n the record.\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the term assignment.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n\ + \ relationship.\n \"source\": \"str\", \ + \ # Optional. The source of the term.\n \"status\": \"str\"\ + , # Optional. The status of terms\n assignment. Known values\ + \ are: \"DISCOVERED\", \"PROPOSED\", \"IMPORTED\",\n \"VALIDATED\"\ + , \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \"steward\": \"\ + str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, # Optional. Used\ + \ to record the provenance of\n an instance of an entity or relationship.\n\ + \ \"proxy\": bool, # Optional. Determines if there's a proxy.\n \ + \ \"relationshipAttributes\": {\n \"str\": {} # Optional.\ + \ The attributes of relationship.\n },\n \"source\": \"str\"\ + , # Optional. indicate the source who create the\n classification\ + \ detail.\n \"sourceDetails\": {\n \"str\": {} # Optional.\ + \ more detail on source information.\n },\n \"status\": \"\ + str\", # Optional. Status of the entity - can be active or\n deleted.\ + \ Deleted entities are not removed from Atlas store. Known values are:\n \ + \ \"ACTIVE\", \"DELETED\".\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the record.\n \"updatedBy\": \"str\", # Optional. The user\ + \ who updated the record.\n \"version\": 0.0 # Optional. The version\ + \ of the entity.\n },\n \"referredEntities\": {\n \"str\"\ + : {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"businessAttributes\"\ + : {\n \"str\": {} # Optional. Business Attributes.\n \ + \ },\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {}\ + \ # Optional. The attributes\n of the struct.\n \ + \ },\n \"entityGuid\": \"str\", #\ + \ Optional. The GUID of\n the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of\n \ + \ the entity - can be active or deleted. Deleted entities are not\n \ + \ removed from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag\n for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \"id\"\ + : \"str\", # Optional. Azure\n Active Directory object\ + \ Id.\n \"info\": \"str\" # Optional. additional\n\ + \ information to describe this contact.\n \ + \ }\n ]\n },\n \"\ + createTime\": 0.0, # Optional. The created time of the\n record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the\n\ + \ record.\n \"customAttributes\": {\n \ + \ \"str\": \"str\" # Optional. Custom Attribute.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"homeId\": \"str\", # Optional. The home ID of the entity.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a shell\n \ + \ entity.\n \"labels\": [\n \"str\"\ + \ # Optional. labels.\n ],\n \"lastModifiedTS\":\ + \ \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n }\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.get_classification + name: get_classification + summary: List classifications for a given entity represented by a GUID. + signature: 'async get_classification(guid: str, classification_name: str, **kwargs: + Any) -> MutableMapping[str, Any]' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: classification_name + description: The name of the classification. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributes\": {\n \"str\": {} # Optional. The attributes of the struct.\n\ + \ },\n \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n\ + \ \"entityStatus\": \"str\", # Optional. Status of the entity - can be\ + \ active or\n deleted. Deleted entities are not removed from Atlas store.\ + \ Known values are:\n \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional. Determines if\n propagations will be removed on entity\ + \ deletion.\n \"source\": \"str\", # Optional. indicate the source who\ + \ create the\n classification detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on source information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \"endTime\": \"str\"\ + , # Optional. The end of the time boundary.\n \"startTime\": \"\ + str\", # Optional. The start of the time\n boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone of the time\n \ + \ boundary.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.get_classifications + name: get_classifications + summary: List classifications for a given entity represented by a GUID. + signature: 'async get_classifications(guid: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + list\": [\n {} # Optional. An array of objects.\n ],\n \ + \ \"pageSize\": 0, # Optional. The size of the page.\n \"sortBy\": \"str\"\ + , # Optional. The sorted by field.\n \"sortType\": \"str\", # Optional.\ + \ to specify whether the result should be\n sorted? If yes, whether asc\ + \ or desc. Known values are: \"NONE\", \"ASC\", \"DESC\".\n \"startIndex\"\ + : 0.0, # Optional. The start index of the page.\n \"totalCount\": 0.0 \ + \ # Optional. The total count of items.\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.get_entities_by_unique_attributes + name: get_entities_by_unique_attributes + summary: 'Bulk API to retrieve list of entities identified by its unique attributes. + + + In addition to the typeName path parameter, attribute key-value pair(s) can be + provided in the + + following format + + + typeName=:code:*`&attr_1::code:``=:code:``&attr_2::code:``=:code:``&attr_3::code:``=:code:`* + + + NOTE: The attrName should be an unique attribute for the given entity-type + + + The REST request would look something like this + + + GET + + /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_0::.' + signature: 'async get_entities_by_unique_attributes(type_name: str, *, min_ext_info: + bool | None = False, ignore_relationships: bool | None = False, attr_n_qualified_name: + str | None = None, **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: type_name + description: The name of the type. + isRequired: true + types: + - + keywordOnlyParameters: + - name: min_ext_info + description: 'Whether to return minimal information for referred entities. Default + + value is False.' + types: + - + - name: ignore_relationships + description: 'Whether to ignore relationship attributes. Default value is + + False.' + types: + - + - name: attr_n_qualified_name + description: 'Qualified name of an entity. E.g. to find 2 entities you can + + set attrs_0::. + Default value is None.' + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + entities\": [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"businessAttributes\": {\n \"str\": {} # Optional.\ + \ Business Attributes.\n },\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \"id\"\ + : \"str\", # Optional. Azure\n Active Directory object\ + \ Id.\n \"info\": \"str\" # Optional. additional\n\ + \ information to describe this contact.\n \ + \ }\n ]\n },\n \"\ + createTime\": 0.0, # Optional. The created time of the\n record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the\n\ + \ record.\n \"customAttributes\": {\n \ + \ \"str\": \"str\" # Optional. Custom Attribute.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"homeId\": \"str\", # Optional. The home ID of the entity.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a shell\n \ + \ entity.\n \"labels\": [\n \"str\"\ + \ # Optional. labels.\n ],\n \"lastModifiedTS\":\ + \ \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n ],\n \"referredEntities\"\ + : {\n \"str\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"businessAttributes\": {\n \"str\": {} # Optional.\ + \ Business Attributes.\n },\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \"id\"\ + : \"str\", # Optional. Azure\n Active Directory object\ + \ Id.\n \"info\": \"str\" # Optional. additional\n\ + \ information to describe this contact.\n \ + \ }\n ]\n },\n \"\ + createTime\": 0.0, # Optional. The created time of the\n record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the\n\ + \ record.\n \"customAttributes\": {\n \ + \ \"str\": \"str\" # Optional. Custom Attribute.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"homeId\": \"str\", # Optional. The home ID of the entity.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a shell\n \ + \ entity.\n \"labels\": [\n \"str\"\ + \ # Optional. labels.\n ],\n \"lastModifiedTS\":\ + \ \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n }\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.get_header + name: get_header + summary: Get entity header given its GUID. + signature: 'async get_header(guid: str, **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributes\": {\n \"str\": {} # Optional. The attributes of the struct.\n\ + \ },\n \"classificationNames\": [\n \"str\" # Optional.\ + \ An array of classification names.\n ],\n \"classifications\": [\n\ + \ {\n \"attributes\": {\n \"str\": {}\ + \ # Optional. The attributes of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from Atlas\n\ + \ store. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"removePropagationsOnEntityDelete\": bool,\ + \ # Optional.\n Determines if propagations will be removed on\ + \ entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"guid\": \"str\", # Optional. The GUID of the record.\n \"isIncomplete\"\ + : bool, # Optional. Whether it is a shell entity.\n \"labels\": [\n \ + \ \"str\" # Optional. labels.\n ],\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag for concurrency control.\n \"meaningNames\": [\n\ + \ \"str\" # Optional. An array of meanings.\n ],\n \"meanings\"\ + : [\n {\n \"confidence\": 0, # Optional. The confidence\ + \ of the term\n assignment.\n \"createdBy\": \"\ + str\", # Optional. The user who created the\n record.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ term assignment.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term\n assignment.\n \"relationGuid\"\ + : \"str\", # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of terms assignment.\n\ + \ Known values are: \"DISCOVERED\", \"PROPOSED\", \"IMPORTED\"\ + , \"VALIDATED\",\n \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n\ + \ \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional. Status of the\ + \ entity - can be active or\n deleted. Deleted entities are not removed\ + \ from Atlas store. Known values are:\n \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\" # Optional. The name of the type.\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.get_sample_business_metadata_template + name: get_sample_business_metadata_template + summary: Get the sample Template for uploading/creating bulk BusinessMetaData. + signature: 'async get_sample_business_metadata_template(**kwargs: Any) -> IO' + return: + description: IO + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.purview.catalog.aio.operations.EntityOperations.import_business_metadata + name: import_business_metadata + signature: async import_business_metadata(*args, **kwargs) -> MutableMapping[str, + Any] +- uid: azure.purview.catalog.aio.operations.EntityOperations.list_by_guids + name: list_by_guids + summary: List entities in bulk identified by its GUIDs. + signature: 'async list_by_guids(*, guids: List[str], min_ext_info: bool | None = + False, ignore_relationships: bool | None = False, exclude_relationship_types: + List[str] | None = None, **kwargs: Any) -> MutableMapping[str, Any]' + keywordOnlyParameters: + - name: guids + description: An array of GUIDs of entities to list. + types: + - [] + - name: min_ext_info + description: 'Whether to return minimal information for referred entities. Default + + value is False.' + types: + - + - name: ignore_relationships + description: 'Whether to ignore relationship attributes. Default value is + + False.' + types: + - + - name: exclude_relationship_types + description: 'An array of the relationship types need to be excluded + + from the response. Default value is None.' + types: + - [] + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + entities\": [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"businessAttributes\": {\n \"str\": {} # Optional.\ + \ Business Attributes.\n },\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \"id\"\ + : \"str\", # Optional. Azure\n Active Directory object\ + \ Id.\n \"info\": \"str\" # Optional. additional\n\ + \ information to describe this contact.\n \ + \ }\n ]\n },\n \"\ + createTime\": 0.0, # Optional. The created time of the\n record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the\n\ + \ record.\n \"customAttributes\": {\n \ + \ \"str\": \"str\" # Optional. Custom Attribute.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"homeId\": \"str\", # Optional. The home ID of the entity.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a shell\n \ + \ entity.\n \"labels\": [\n \"str\"\ + \ # Optional. labels.\n ],\n \"lastModifiedTS\":\ + \ \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n ],\n \"referredEntities\"\ + : {\n \"str\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"businessAttributes\": {\n \"str\": {} # Optional.\ + \ Business Attributes.\n },\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \"id\"\ + : \"str\", # Optional. Azure\n Active Directory object\ + \ Id.\n \"info\": \"str\" # Optional. additional\n\ + \ information to describe this contact.\n \ + \ }\n ]\n },\n \"\ + createTime\": 0.0, # Optional. The created time of the\n record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the\n\ + \ record.\n \"customAttributes\": {\n \ + \ \"str\": \"str\" # Optional. Custom Attribute.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"homeId\": \"str\", # Optional. The home ID of the entity.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a shell\n \ + \ entity.\n \"labels\": [\n \"str\"\ + \ # Optional. labels.\n ],\n \"lastModifiedTS\":\ + \ \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n }\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.partial_update_entity_attribute_by_guid + name: partial_update_entity_attribute_by_guid + summary: 'Update entity partially - create or update entity attribute identified + by its GUID. + + Supports only primitive attribute type and entity references. + + It does not support updating complex types like arrays, and maps. + + Null updates are not possible.' + signature: 'async partial_update_entity_attribute_by_guid(guid: str, body: Any, + *, name: str, **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: body + description: The value of the attribute. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + description: The name of the attribute. + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.purview.catalog.aio.operations.EntityOperations.partial_update_entity_by_unique_attributes + name: partial_update_entity_by_unique_attributes + summary: 'Update entity partially - Allow a subset of attributes to be updated on + + an entity which is identified by its type and unique attribute eg: + + Referenceable.qualifiedName. + + Null updates are not possible. + + In addition to the typeName path parameter, attribute key-value pair(s) can be + provided in the + + following format: + + attr:``=:code:``. + + NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. + + The REST request would look something like this: + + PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.' + signature: 'async partial_update_entity_by_unique_attributes(type_name: str, atlas_entity_with_ext_info: + MutableMapping[str, Any], *, attr_qualified_name: str | None = None, **kwargs: + Any) -> MutableMapping[str, Any]' + parameters: + - name: type_name + description: The name of the type. + isRequired: true + types: + - + - name: atlas_entity_with_ext_info + description: Atlas entity with extended information. + isRequired: true + types: + - + keywordOnlyParameters: + - name: attr_qualified_name + description: The qualified name of the entity. Default value is None. + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n atlas_entity_with_ext_info\ + \ = {\n \"entity\": {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \"\ + businessAttributes\": {\n \"str\": {} # Optional. Business Attributes.\n\ + \ },\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the\n struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional. The GUID of the\n\ + \ entity.\n \"entityStatus\": \"str\", \ + \ # Optional. Status of the\n entity - can be active or deleted.\ + \ Deleted entities are not removed\n from Atlas store. Known\ + \ values are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for\n concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the source who\n create the classification detail.\n\ + \ \"sourceDetails\": {\n \"str\": {} \ + \ # Optional. more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"validityPeriods\": [\n \ + \ {\n \"endTime\": \"str\", # Optional.\ + \ The\n end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n \ + \ start of the time boundary.\n \"timeZone\"\ + : \"str\" # Optional. The\n timezone of the time\ + \ boundary.\n }\n ]\n }\n\ + \ ],\n \"contacts\": {\n \"str\": [\n \ + \ {\n \"id\": \"str\", # Optional. Azure Active\n\ + \ Directory object Id.\n \"info\"\ + : \"str\" # Optional. additional\n information to describe\ + \ this contact.\n }\n ]\n },\n \ + \ \"createTime\": 0.0, # Optional. The created time of the record.\n \ + \ \"createdBy\": \"str\", # Optional. The user who created the record.\n\ + \ \"customAttributes\": {\n \"str\": \"str\" # Optional.\ + \ Custom Attribute.\n },\n \"guid\": \"str\", # Optional.\ + \ The GUID of the entity.\n \"homeId\": \"str\", # Optional. The home\ + \ ID of the entity.\n \"isIncomplete\": bool, # Optional. Whether it\ + \ is a shell entity.\n \"labels\": [\n \"str\" # Optional.\ + \ labels.\n ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"meanings\": [\n {\n\ + \ \"confidence\": 0, # Optional. The confidence of the\n \ + \ term assignment.\n \"createdBy\": \"str\"\ + , # Optional. The user who created\n the record.\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the term assignment.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n\ + \ relationship.\n \"source\": \"str\", \ + \ # Optional. The source of the term.\n \"status\": \"str\"\ + , # Optional. The status of terms\n assignment. Known values\ + \ are: \"DISCOVERED\", \"PROPOSED\", \"IMPORTED\",\n \"VALIDATED\"\ + , \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \"steward\": \"\ + str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, # Optional. Used\ + \ to record the provenance of\n an instance of an entity or relationship.\n\ + \ \"proxy\": bool, # Optional. Determines if there's a proxy.\n \ + \ \"relationshipAttributes\": {\n \"str\": {} # Optional.\ + \ The attributes of relationship.\n },\n \"source\": \"str\"\ + , # Optional. indicate the source who create the\n classification\ + \ detail.\n \"sourceDetails\": {\n \"str\": {} # Optional.\ + \ more detail on source information.\n },\n \"status\": \"\ + str\", # Optional. Status of the entity - can be active or\n deleted.\ + \ Deleted entities are not removed from Atlas store. Known values are:\n \ + \ \"ACTIVE\", \"DELETED\".\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the record.\n \"updatedBy\": \"str\", # Optional. The user\ + \ who updated the record.\n \"version\": 0.0 # Optional. The version\ + \ of the entity.\n },\n \"referredEntities\": {\n \"str\"\ + : {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"businessAttributes\"\ + : {\n \"str\": {} # Optional. Business Attributes.\n \ + \ },\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {}\ + \ # Optional. The attributes\n of the struct.\n \ + \ },\n \"entityGuid\": \"str\", #\ + \ Optional. The GUID of\n the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of\n \ + \ the entity - can be active or deleted. Deleted entities are not\n \ + \ removed from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag\n for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \"id\"\ + : \"str\", # Optional. Azure\n Active Directory object\ + \ Id.\n \"info\": \"str\" # Optional. additional\n\ + \ information to describe this contact.\n \ + \ }\n ]\n },\n \"\ + createTime\": 0.0, # Optional. The created time of the\n record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the\n\ + \ record.\n \"customAttributes\": {\n \ + \ \"str\": \"str\" # Optional. Custom Attribute.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"homeId\": \"str\", # Optional. The home ID of the entity.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a shell\n \ + \ entity.\n \"labels\": [\n \"str\"\ + \ # Optional. labels.\n ],\n \"lastModifiedTS\":\ + \ \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n }\n }\n\n # response body\ + \ for status code(s): 200\n response.json() == {\n \"guidAssignments\"\ + : {\n \"str\": \"str\" # Optional. A map of GUID assignments with entities.\n\ + \ },\n \"mutatedEntities\": {\n \"str\": [\n \ + \ {\n \"attributes\": {\n \"str\":\ + \ {} # Optional. The attributes of the\n struct.\n \ + \ },\n \"classificationNames\": [\n \ + \ \"str\" # Optional. An array of classification\n \ + \ names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n\ + \ \"str\": {} # Optional. The\n \ + \ attributes of the struct.\n },\n\ + \ \"entityGuid\": \"str\", # Optional. The\n \ + \ GUID of the entity.\n \"entityStatus\"\ + : \"str\", # Optional.\n Status of the entity - can\ + \ be active or deleted. Deleted\n entities are not\ + \ removed from Atlas store. Known values are:\n \"\ + ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional.\n ETag for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\":\n \ + \ bool, # Optional. Determines if propagations will be removed\n\ + \ on entity deletion.\n \ + \ \"source\": \"str\", # Optional.\n indicate the\ + \ source who create the classification detail.\n \"\ + sourceDetails\": {\n \"str\": {} # Optional. more\n\ + \ detail on source information.\n \ + \ },\n \"typeName\": \"str\", # Optional.\ + \ The\n name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\",\n # Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the\ + \ time boundary.\n }\n \ + \ ]\n }\n ],\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"guid\": \"str\"\ + , # Optional. The GUID of the record.\n \"isIncomplete\": bool,\ + \ # Optional. Whether it is a\n shell entity.\n \ + \ \"labels\": [\n \"str\" # Optional. labels.\n\ + \ ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for\n concurrency control.\n \"meaningNames\"\ + : [\n \"str\" # Optional. An array of meanings.\n \ + \ ],\n \"meanings\": [\n \ + \ {\n \"confidence\": 0, # Optional. The\n \ + \ confidence of the term assignment.\n \ + \ \"createdBy\": \"str\", # Optional. The\n \ + \ user who created the record.\n \"description\":\ + \ \"str\", # Optional.\n The description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional.\n\ + \ The display text.\n \"\ + expression\": \"str\", # Optional. The\n expression\ + \ of the term assignment.\n \"relationGuid\": \"str\"\ + , # Optional.\n The GUID of the relationship.\n \ + \ \"source\": \"str\", # Optional. The\n \ + \ source of the term.\n \"status\"\ + : \"str\", # Optional. The\n status of terms assignment.\ + \ Known values are: \"DISCOVERED\",\n \"PROPOSED\"\ + , \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\",\n \"\ + OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The\n steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The\n \ + \ GUID of the term.\n }\n ],\n \ + \ \"status\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\"\ + .\n \"typeName\": \"str\" # Optional. The name of the type.\n\ + \ }\n ]\n },\n \"partialUpdatedEntities\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"classificationNames\": [\n \"str\" # Optional. An\ + \ array of classification names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.set_classifications + name: set_classifications + summary: Set classifications on entities in bulk. + signature: 'async set_classifications(entity_headers: MutableMapping[str, Any], + **kwargs: Any) -> List[str]' + parameters: + - name: entity_headers + description: Atlas entity headers. + isRequired: true + types: + - + return: + description: list of str + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n entity_headers\ + \ = {\n \"guidHeaderMap\": {\n \"str\": {\n \"attributes\"\ + : {\n \"str\": {} # Optional. The attributes of the struct.\n\ + \ },\n \"classificationNames\": [\n \ + \ \"str\" # Optional. An array of classification names.\n ],\n\ + \ \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes\n of the struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional. The\ + \ GUID of\n the entity.\n \"entityStatus\"\ + : \"str\", # Optional. Status of\n the entity - can be\ + \ active or deleted. Deleted entities are not\n removed\ + \ from Atlas store. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag\n \ + \ for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, #\n Optional. Determines if propagations will\ + \ be removed on entity\n deletion.\n \ + \ \"source\": \"str\", # Optional. indicate the\n \ + \ source who create the classification detail.\n \"sourceDetails\"\ + : {\n \"str\": {} # Optional. more detail on\n \ + \ source information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"validityPeriods\": [\n\ + \ {\n \"endTime\": \"\ + str\", #\n Optional. The end of the time boundary.\n\ + \ \"startTime\": \"str\", #\n \ + \ Optional. The start of the time boundary.\n \ + \ \"timeZone\": \"str\" #\n Optional.\ + \ The timezone of the time boundary.\n }\n \ + \ ]\n }\n ],\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"guid\": \"str\", \ + \ # Optional. The GUID of the record.\n \"isIncomplete\": bool,\ + \ # Optional. Whether it is a shell\n entity.\n \ + \ \"labels\": [\n \"str\" # Optional. labels.\n \ + \ ],\n \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n }\n }\n\n # response body for status code(s):\ + \ 200\n response.json() == [\n \"str\" # Optional.\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.set_labels + name: set_labels + summary: Set labels to a given entity. + signature: 'async set_labels(guid: str, body: List[str] | None = None, **kwargs: + Any) -> None' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: body + description: set of labels to be set to the entity. Default value is None. + isRequired: true + types: + - [] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n body\ + \ = [\n \"str\" # Optional.\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.set_labels_by_unique_attribute + name: set_labels_by_unique_attribute + summary: 'Set labels to a given entity identified by its type and unique attributes, + if labels is + + null/empty, existing labels will all be removed. In addition to the typeName path + parameter, + + attribute key-value pair(s) can be provided in the following format: + + attr:``=:code:``. NOTE: The attrName and attrValue should + be unique + + across entities, eg. qualifiedName. The REST request would look something like + this: POST + + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.' + signature: 'async set_labels_by_unique_attribute(type_name: str, body: List[str] + | None = None, *, attr_qualified_name: str | None = None, **kwargs: Any) -> None' + parameters: + - name: type_name + description: The name of the type. + isRequired: true + types: + - + - name: body + description: set of labels to be set. Default value is None. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: attr_qualified_name + description: The qualified name of the entity. Default value is None. + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n body\ + \ = [\n \"str\" # Optional.\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.update_classifications + name: update_classifications + summary: Update classifications to an existing entity represented by a guid. + signature: 'async update_classifications(guid: str, classifications: List[MutableMapping[str, + Any]], **kwargs: Any) -> None' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: classifications + description: An array of classifications to be updated. + isRequired: true + types: + - [] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n classifications\ + \ = [\n {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"entityGuid\": \"\ + str\", # Optional. The GUID of the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of the entity - can be\n active or deleted.\ + \ Deleted entities are not removed from Atlas store. Known\n values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional. Determines if\n propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate the\ + \ source who create the\n classification detail.\n \"sourceDetails\"\ + : {\n \"str\": {} # Optional. more detail on source information.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name of the\ + \ type.\n \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the time\n \ + \ boundary.\n \"startTime\": \"str\", # Optional. The start\ + \ of the\n time boundary.\n \"timeZone\"\ + : \"str\" # Optional. The timezone of the\n time boundary.\n\ + \ }\n ]\n }\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.EntityOperations.update_classifications_by_unique_attribute + name: update_classifications_by_unique_attribute + summary: Update classification on an entity identified by its type and unique attributes. + signature: 'async update_classifications_by_unique_attribute(type_name: str, atlas_classification_array: + List[MutableMapping[str, Any]], *, attr_qualified_name: str | None = None, **kwargs: + Any) -> None' + parameters: + - name: type_name + description: The name of the type. + isRequired: true + types: + - + - name: atlas_classification_array + description: An array of classification to be updated. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: attr_qualified_name + description: The qualified name of the entity. Default value is None. + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n atlas_classification_array\ + \ = [\n {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"entityGuid\": \"\ + str\", # Optional. The GUID of the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of the entity - can be\n active or deleted.\ + \ Deleted entities are not removed from Atlas store. Known\n values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional. Determines if\n propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate the\ + \ source who create the\n classification detail.\n \"sourceDetails\"\ + : {\n \"str\": {} # Optional. more detail on source information.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name of the\ + \ type.\n \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the time\n \ + \ boundary.\n \"startTime\": \"str\", # Optional. The start\ + \ of the\n time boundary.\n \"timeZone\"\ + : \"str\" # Optional. The timezone of the\n time boundary.\n\ + \ }\n ]\n }\n ]\n ````\n" diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.GlossaryOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.GlossaryOperations.yml new file mode 100644 index 00000000..ea4cfdbb --- /dev/null +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.GlossaryOperations.yml @@ -0,0 +1,4767 @@ +### YamlMime:PythonClass +uid: azure.purview.catalog.aio.operations.GlossaryOperations +name: GlossaryOperations +fullName: azure.purview.catalog.aio.operations.GlossaryOperations +module: azure.purview.catalog.aio.operations +constructor: + syntax: GlossaryOperations(*args, **kwargs) +methods: +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.assign_term_to_entities + name: assign_term_to_entities + summary: Assign the given term to the provided list of related objects. + signature: 'async assign_term_to_entities(term_guid: str, related_object_ids: List[MutableMapping[str, + Any]], **kwargs: Any) -> None' + parameters: + - name: term_guid + description: The globally unique identifier for glossary term. + isRequired: true + types: + - + - name: related_object_ids + description: 'An array of related object IDs to which the term has to be + + associated.' + isRequired: true + types: + - [] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n related_object_ids\ + \ = [\n {\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"entityStatus\": \"str\", # Optional. Status of the entity\ + \ - can be\n active or deleted. Deleted entities are not removed from\ + \ Atlas store. Known\n values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \"\ + relationshipAttributes\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"typeName\": \"str\" # Optional.\ + \ The name of the type.\n },\n \"relationshipGuid\": \"str\"\ + , # Optional. The GUID of the relationship.\n \"relationshipStatus\"\ + : \"str\", # Optional. The enum of relationship\n status. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"relationshipType\": \"str\", #\ + \ Optional.\n \"typeName\": \"str\", # Optional. The name of the type.\n\ + \ \"uniqueAttributes\": {\n \"str\": {} # Optional. The\ + \ unique attributes of the object.\n }\n }\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.begin_import_glossary_terms_via_csv + name: begin_import_glossary_terms_via_csv + signature: 'async begin_import_glossary_terms_via_csv(glossary_guid: str, files: + Dict[str, Any], *, include_term_hierarchy: bool | None = False, **kwargs: Any) + -> AsyncLROPoller[MutableMapping[str, Any]]' + parameters: + - name: glossary_guid + isRequired: true + - name: files + isRequired: true + keywordOnlyParameters: + - name: include_term_hierarchy + isRequired: true +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.begin_import_glossary_terms_via_csv_by_glossary_name + name: begin_import_glossary_terms_via_csv_by_glossary_name + summary: Import Glossary Terms from local csv file by glossaryName. + signature: 'async begin_import_glossary_terms_via_csv_by_glossary_name(glossary_name: + str, files: Dict[str, Any], *, include_term_hierarchy: bool | None = False, **kwargs: + Any) -> AsyncLROPoller[MutableMapping[str, Any]]' + parameters: + - name: glossary_name + description: The name of the glossary. + isRequired: true + types: + - + - name: files + description: 'Multipart input for files. See the template in our example to find + the input + + shape.' + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: include_term_hierarchy + description: Whether include term hierarchy. Default value is False. + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be LROBasePolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of LROPoller that returns JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # multipart input template you can fill out and use as your `files` input.\n\ + \ files = {\n \"file\": b'bytes' # The csv file to import glossary terms\ + \ from.\n }\n\n # response body for status code(s): 202\n response.json()\ + \ == {\n \"createTime\": \"str\", # Optional. The created time of the record.\n\ + \ \"error\": {\n \"errorCode\": 0, # Optional. Error code from\ + \ async import job if\n fail.\n \"errorMessage\": \"str\"\ + \ # Optional. Error message from async import\n job if fail.\n \ + \ },\n \"id\": \"str\", # Optional. guid string.\n \"lastUpdateTime\"\ + : \"str\", # Optional. The last updated time of the record.\n \"properties\"\ + : {\n \"importedTerms\": \"str\", # Optional. Term numbers that already\n\ + \ imported successfully.\n \"totalTermsDetected\": \"str\"\ + \ # Optional. Total term numbers that\n detected in csv.\n \ + \ },\n \"status\": \"str\" # Optional. Enum of the status of import csv\ + \ operation.\n Possible values include: \"NotStarted\", \"Succeeded\"\ + , \"Failed\", \"Running\".\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.create_glossary + name: create_glossary + summary: Create a glossary. + signature: 'async create_glossary(atlas_glossary: MutableMapping[str, Any], **kwargs: + Any) -> MutableMapping[str, Any]' + parameters: + - name: atlas_glossary + description: 'Glossary definition, terms & categories can be anchored to a glossary. + + Using the anchor attribute when creating the Term/Category.' + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n atlas_glossary\ + \ = {\n \"categories\": [\n {\n \"categoryGuid\"\ + : \"str\", # Optional. The GUID of the category.\n \"description\"\ + : \"str\", # Optional. The description of the\n category header.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"parentCategoryGuid\": \"str\", # Optional. The GUID of the\n \ + \ parent category.\n \"relationGuid\": \"str\" #\ + \ Optional. The GUID of the\n relationship.\n }\n \ + \ ],\n \"classifications\": [\n {\n \"attributes\"\ + : {\n \"str\": {} # Optional. The attributes of the struct.\n\ + \ },\n \"entityGuid\": \"str\", # Optional. The GUID\ + \ of the entity.\n \"entityStatus\": \"str\", # Optional. Status\ + \ of the entity -\n can be active or deleted. Deleted entities\ + \ are not removed from Atlas\n store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional. ETag\ + \ for concurrency\n control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional.\n Determines if propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"language\": \"str\", # Optional. The language of the glossary.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"qualifiedName\": \"str\", # Optional. The qualified name of the glossary\n\ + \ object.\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"terms\": [\n {\n \"\ + description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"expression\": \"str\", # Optional. The expression of\ + \ the term.\n \"relationGuid\": \"str\", # Optional. The GUID of\ + \ the\n relationship.\n \"source\": \"str\", #\ + \ Optional. The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"DRAFT\"\ + , \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"usage\": \"str\" # Optional. The usage of the glossary.\n\ + \ }\n\n # response body for status code(s): 200\n response.json() == {\n\ + \ \"categories\": [\n {\n \"categoryGuid\": \"str\"\ + , # Optional. The GUID of the category.\n \"description\": \"str\"\ + , # Optional. The description of the\n category header.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"parentCategoryGuid\": \"str\", # Optional. The GUID of the\n \ + \ parent category.\n \"relationGuid\": \"str\" # Optional.\ + \ The GUID of the\n relationship.\n }\n ],\n \ + \ \"classifications\": [\n {\n \"attributes\": {\n\ + \ \"str\": {} # Optional. The attributes of the struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional. The GUID\ + \ of the entity.\n \"entityStatus\": \"str\", # Optional. Status\ + \ of the entity -\n can be active or deleted. Deleted entities\ + \ are not removed from Atlas\n store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional. ETag\ + \ for concurrency\n control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional.\n Determines if propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"language\": \"str\", # Optional. The language of the glossary.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"qualifiedName\": \"str\", # Optional. The qualified name of the glossary\n\ + \ object.\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"terms\": [\n {\n \"\ + description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"expression\": \"str\", # Optional. The expression of\ + \ the term.\n \"relationGuid\": \"str\", # Optional. The GUID of\ + \ the\n relationship.\n \"source\": \"str\", #\ + \ Optional. The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"DRAFT\"\ + , \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"usage\": \"str\" # Optional. The usage of the glossary.\n\ + \ }\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.create_glossary_categories + name: create_glossary_categories + summary: Create glossary category in bulk. + signature: 'async create_glossary_categories(glossary_category: List[MutableMapping[str, + Any]], **kwargs: Any) -> List[MutableMapping[str, Any]]' + parameters: + - name: glossary_category + description: An array of glossary category definitions to be created. + isRequired: true + types: + - [] + return: + description: list of JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n glossary_category\ + \ = [\n {\n \"anchor\": {\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"glossaryGuid\": \"str\"\ + , # Optional. The GUID of the glossary.\n \"relationGuid\": \"\ + str\" # Optional. The GUID of the\n relationship.\n \ + \ },\n \"childrenCategories\": [\n {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the\n \ + \ category.\n \"description\": \"str\", # Optional. The\ + \ description of\n the category header.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"parentCategoryGuid\": \"str\", # Optional. The GUID of\n \ + \ the parent category.\n \"relationGuid\": \"str\" #\ + \ Optional. The GUID of the\n relationship.\n \ + \ }\n ],\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the\n struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional. The GUID of the\n\ + \ entity.\n \"entityStatus\": \"str\", \ + \ # Optional. Status of the\n entity - can be active or deleted.\ + \ Deleted entities are not removed\n from Atlas store. Known\ + \ values are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for\n concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the source who\n create the classification detail.\n\ + \ \"sourceDetails\": {\n \"str\": {} \ + \ # Optional. more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"validityPeriods\": [\n \ + \ {\n \"endTime\": \"str\", # Optional.\ + \ The\n end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n \ + \ start of the time boundary.\n \"timeZone\"\ + : \"str\" # Optional. The\n timezone of the time\ + \ boundary.\n }\n ]\n }\n\ + \ ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n\ + \ \"parentCategory\": {\n \"categoryGuid\": \"str\", \ + \ # Optional. The GUID of the category.\n \"description\": \"str\"\ + , # Optional. The description of the\n category header.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"parentCategoryGuid\": \"str\", # Optional. The GUID of the\n \ + \ parent category.\n \"relationGuid\": \"str\" # Optional.\ + \ The GUID of the\n relationship.\n },\n \"\ + qualifiedName\": \"str\", # Optional. The qualified name of the\n \ + \ glossary object.\n \"shortDescription\": \"str\", # Optional. The\ + \ short version of\n description.\n \"terms\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description\ + \ of\n the related term.\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"expression\":\ + \ \"str\", # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", #\ + \ Optional. The source of the term.\n \"status\": \"str\", \ + \ # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of the\n term.\n \"termGuid\": \"str\"\ + \ # Optional. The GUID of the term.\n }\n ]\n }\n\ + \ ]\n\n # response body for status code(s): 200\n response.json() == [\n\ + \ {\n \"anchor\": {\n \"displayText\": \"str\",\ + \ # Optional. The display text.\n \"glossaryGuid\": \"str\", #\ + \ Optional. The GUID of the glossary.\n \"relationGuid\": \"str\"\ + \ # Optional. The GUID of the\n relationship.\n },\n\ + \ \"childrenCategories\": [\n {\n \"\ + categoryGuid\": \"str\", # Optional. The GUID of the\n category.\n\ + \ \"description\": \"str\", # Optional. The description of\n\ + \ the category header.\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"parentCategoryGuid\"\ + : \"str\", # Optional. The GUID of\n the parent category.\n\ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ],\n \ + \ \"classifications\": [\n {\n \"attributes\"\ + : {\n \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"\ + entityGuid\": \"str\", # Optional. The GUID of the\n entity.\n\ + \ \"entityStatus\": \"str\", # Optional. Status of the\n \ + \ entity - can be active or deleted. Deleted entities are not\ + \ removed\n from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional. ETag\ + \ for\n concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, #\n Optional. Determines if propagations will be\ + \ removed on entity\n deletion.\n \"source\"\ + : \"str\", # Optional. indicate the source who\n create the\ + \ classification detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on source\n \ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of the type.\n \"validityPeriods\"\ + : [\n {\n \"endTime\": \"str\"\ + , # Optional. The\n end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n \ + \ start of the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The\n timezone\ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID\ + \ of the object.\n \"lastModifiedTS\": \"str\", # Optional. ETag for\ + \ concurrency control.\n \"longDescription\": \"str\", # Optional.\ + \ The long version description.\n \"name\": \"str\", # Optional. The\ + \ name of the glossary object.\n \"parentCategory\": {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the category.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ category header.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"parentCategoryGuid\": \"str\", # Optional.\ + \ The GUID of the\n parent category.\n \"relationGuid\"\ + : \"str\" # Optional. The GUID of the\n relationship.\n \ + \ },\n \"qualifiedName\": \"str\", # Optional. The qualified name\ + \ of the\n glossary object.\n \"shortDescription\": \"str\"\ + , # Optional. The short version of\n description.\n \"\ + terms\": [\n {\n \"description\": \"str\", #\ + \ Optional. The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", #\ + \ Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ]\n }\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.create_glossary_category + name: create_glossary_category + summary: Create a glossary category. + signature: 'async create_glossary_category(glossary_category: MutableMapping[str, + Any], **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: glossary_category + description: 'The glossary category definition. A category must be anchored to + a + + Glossary when creating. + + Optionally, terms belonging to the category and the hierarchy can also be defined + during + + creation.' + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n glossary_category\ + \ = {\n \"anchor\": {\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"glossaryGuid\": \"str\", # Optional. The GUID\ + \ of the glossary.\n \"relationGuid\": \"str\" # Optional. The GUID\ + \ of the relationship.\n },\n \"childrenCategories\": [\n \ + \ {\n \"categoryGuid\": \"str\", # Optional. The GUID of the\ + \ category.\n \"description\": \"str\", # Optional. The description\ + \ of the\n category header.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"parentCategoryGuid\":\ + \ \"str\", # Optional. The GUID of the\n parent category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional.\n Determines if propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"parentCategory\": {\n \"categoryGuid\": \"str\", # Optional.\ + \ The GUID of the category.\n \"description\": \"str\", # Optional.\ + \ The description of the category\n header.\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"parentCategoryGuid\":\ + \ \"str\", # Optional. The GUID of the parent\n category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the relationship.\n\ + \ },\n \"qualifiedName\": \"str\", # Optional. The qualified name\ + \ of the glossary\n object.\n \"shortDescription\": \"str\", #\ + \ Optional. The short version of description.\n \"terms\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description of\ + \ the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ]\n }\n\n # response body for status code(s):\ + \ 200\n response.json() == {\n \"anchor\": {\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"glossaryGuid\": \"str\"\ + , # Optional. The GUID of the glossary.\n \"relationGuid\": \"str\"\ + \ # Optional. The GUID of the relationship.\n },\n \"childrenCategories\"\ + : [\n {\n \"categoryGuid\": \"str\", # Optional. The\ + \ GUID of the category.\n \"description\": \"str\", # Optional.\ + \ The description of the\n category header.\n \"\ + displayText\": \"str\", # Optional. The display text.\n \"parentCategoryGuid\"\ + : \"str\", # Optional. The GUID of the\n parent category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional.\n Determines if propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"parentCategory\": {\n \"categoryGuid\": \"str\", # Optional.\ + \ The GUID of the category.\n \"description\": \"str\", # Optional.\ + \ The description of the category\n header.\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"parentCategoryGuid\":\ + \ \"str\", # Optional. The GUID of the parent\n category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the relationship.\n\ + \ },\n \"qualifiedName\": \"str\", # Optional. The qualified name\ + \ of the glossary\n object.\n \"shortDescription\": \"str\", #\ + \ Optional. The short version of description.\n \"terms\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description of\ + \ the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.create_glossary_term + name: create_glossary_term + summary: Create a glossary term. + signature: 'async create_glossary_term(glossary_term: MutableMapping[str, Any], + *, include_term_hierarchy: bool | None = False, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: glossary_term + description: 'The glossary term definition. A term must be anchored to a Glossary + at + + the time of creation. + + Optionally it can be categorized as well.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: include_term_hierarchy + description: Whether include term hierarchy. Default value is False. + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n glossary_term\ + \ = {\n \"abbreviation\": \"str\", # Optional. The abbreviation of the\ + \ term.\n \"anchor\": {\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"glossaryGuid\": \"str\", # Optional. The GUID\ + \ of the glossary.\n \"relationGuid\": \"str\" # Optional. The GUID\ + \ of the relationship.\n },\n \"antonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"assignedEntities\": [\n {\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n\ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \ + \ \"relationshipAttributes\": {\n \"attributes\":\ + \ {\n \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"\ + lastModifiedTS\": \"str\", # Optional. ETag for\n concurrency\ + \ control.\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n },\n \"relationshipGuid\": \"str\",\ + \ # Optional. The GUID of the\n relationship.\n \ + \ \"relationshipStatus\": \"str\", # Optional. The enum of\n \ + \ relationship status. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"relationshipType\": \"str\", # Optional. An array of related\n \ + \ object IDs.\n \"typeName\": \"str\", # Optional. The\ + \ name of the type.\n \"uniqueAttributes\": {\n \ + \ \"str\": {} # Optional. The unique attributes of the\n \ + \ object.\n }\n }\n ],\n \"attributes\"\ + : {\n \"str\": {\n \"str\": {} # Optional. The custom\ + \ attributes of the term,\n which is map>.\"\ + nThe key of the first layer map\n is term template name.\n \ + \ }\n },\n \"categories\": [\n {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the category.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ record.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"status\": \"str\" \ + \ # Optional. The status of term relationship.\n Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \ + \ }\n ],\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"entityGuid\": \"str\", \ + \ # Optional. The GUID of the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of the entity -\n can be active or deleted.\ + \ Deleted entities are not removed from Atlas\n store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\", \ + \ # Optional. ETag for concurrency\n control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, # Optional.\n Determines\ + \ if propagations will be removed on entity deletion.\n \"source\"\ + : \"str\", # Optional. indicate the source who create\n the classification\ + \ detail.\n \"sourceDetails\": {\n \"str\": {}\ + \ # Optional. more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"\ + str\", # Optional. The start of\n the time boundary.\n\ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n \ + \ ]\n }\n ],\n \"classifies\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"contacts\": {\n \"str\":\ + \ [\n {\n \"id\": \"str\", # Optional. Azure\ + \ Active Directory\n object Id.\n \"info\"\ + : \"str\" # Optional. additional information to\n describe\ + \ this contact.\n }\n ]\n },\n \"createTime\"\ + : 0.0, # Optional. The created time of the record.\n \"createdBy\": \"\ + str\", # Optional. The user who created the record.\n \"examples\": [\n\ + \ \"str\" # Optional. An array of examples.\n ],\n \"guid\"\ + : \"str\", # Optional. The GUID of the object.\n \"isA\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description of\ + \ the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"longDescription\": \"str\", # Optional.\ + \ The long version description.\n \"name\": \"str\", # Optional. The name\ + \ of the glossary object.\n \"preferredTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"preferredToTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"qualifiedName\": \"str\", # Optional.\ + \ The qualified name of the glossary\n object.\n \"replacedBy\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"replacementTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"resources\": [\n {\n \ + \ \"displayName\": \"str\", # Optional. Display name for url.\n \ + \ \"url\": \"str\" # Optional. web url. http or https.\n \ + \ }\n ],\n \"seeAlso\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"status\": \"str\", # Optional. Status of\ + \ the AtlasGlossaryTerm. Known values\n are: \"Draft\", \"Approved\",\ + \ \"Alert\", \"Expired\".\n \"synonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"templateName\": [\n {} # Optional.\n\ + \ ],\n \"translatedTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"translationTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"updateTime\": 0.0, # Optional. The\ + \ update time of the record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the record.\n \"usage\": \"str\", # Optional. The usage\ + \ of the term.\n \"validValues\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"validValuesFor\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ]\n }\n\n # response body for status code(s): 200\n response.json()\ + \ == {\n \"abbreviation\": \"str\", # Optional. The abbreviation of the\ + \ term.\n \"anchor\": {\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"glossaryGuid\": \"str\", # Optional. The GUID\ + \ of the glossary.\n \"relationGuid\": \"str\" # Optional. The GUID\ + \ of the relationship.\n },\n \"antonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"assignedEntities\": [\n {\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n\ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \ + \ \"relationshipAttributes\": {\n \"attributes\":\ + \ {\n \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"\ + lastModifiedTS\": \"str\", # Optional. ETag for\n concurrency\ + \ control.\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n },\n \"relationshipGuid\": \"str\",\ + \ # Optional. The GUID of the\n relationship.\n \ + \ \"relationshipStatus\": \"str\", # Optional. The enum of\n \ + \ relationship status. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"relationshipType\": \"str\", # Optional. An array of related\n \ + \ object IDs.\n \"typeName\": \"str\", # Optional. The\ + \ name of the type.\n \"uniqueAttributes\": {\n \ + \ \"str\": {} # Optional. The unique attributes of the\n \ + \ object.\n }\n }\n ],\n \"attributes\"\ + : {\n \"str\": {\n \"str\": {} # Optional. The custom\ + \ attributes of the term,\n which is map>.\"\ + nThe key of the first layer map\n is term template name.\n \ + \ }\n },\n \"categories\": [\n {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the category.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ record.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"status\": \"str\" \ + \ # Optional. The status of term relationship.\n Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \ + \ }\n ],\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"entityGuid\": \"str\", \ + \ # Optional. The GUID of the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of the entity -\n can be active or deleted.\ + \ Deleted entities are not removed from Atlas\n store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\", \ + \ # Optional. ETag for concurrency\n control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, # Optional.\n Determines\ + \ if propagations will be removed on entity deletion.\n \"source\"\ + : \"str\", # Optional. indicate the source who create\n the classification\ + \ detail.\n \"sourceDetails\": {\n \"str\": {}\ + \ # Optional. more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"\ + str\", # Optional. The start of\n the time boundary.\n\ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n \ + \ ]\n }\n ],\n \"classifies\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"contacts\": {\n \"str\":\ + \ [\n {\n \"id\": \"str\", # Optional. Azure\ + \ Active Directory\n object Id.\n \"info\"\ + : \"str\" # Optional. additional information to\n describe\ + \ this contact.\n }\n ]\n },\n \"createTime\"\ + : 0.0, # Optional. The created time of the record.\n \"createdBy\": \"\ + str\", # Optional. The user who created the record.\n \"examples\": [\n\ + \ \"str\" # Optional. An array of examples.\n ],\n \"guid\"\ + : \"str\", # Optional. The GUID of the object.\n \"isA\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description of\ + \ the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"longDescription\": \"str\", # Optional.\ + \ The long version description.\n \"name\": \"str\", # Optional. The name\ + \ of the glossary object.\n \"preferredTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"preferredToTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"qualifiedName\": \"str\", # Optional.\ + \ The qualified name of the glossary\n object.\n \"replacedBy\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"replacementTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"resources\": [\n {\n \ + \ \"displayName\": \"str\", # Optional. Display name for url.\n \ + \ \"url\": \"str\" # Optional. web url. http or https.\n \ + \ }\n ],\n \"seeAlso\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"status\": \"str\", # Optional. Status of\ + \ the AtlasGlossaryTerm. Known values\n are: \"Draft\", \"Approved\",\ + \ \"Alert\", \"Expired\".\n \"synonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"templateName\": [\n {} # Optional.\n\ + \ ],\n \"translatedTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"translationTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"updateTime\": 0.0, # Optional. The\ + \ update time of the record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the record.\n \"usage\": \"str\", # Optional. The usage\ + \ of the term.\n \"validValues\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"validValuesFor\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.create_glossary_terms + name: create_glossary_terms + summary: Create glossary terms in bulk. + signature: 'async create_glossary_terms(glossary_term: List[MutableMapping[str, + Any]], *, include_term_hierarchy: bool | None = False, **kwargs: Any) -> List[MutableMapping[str, + Any]]' + parameters: + - name: glossary_term + description: An array of glossary term definitions to be created in bulk. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: include_term_hierarchy + description: Whether include term hierarchy. Default value is False. + types: + - + return: + description: list of JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n glossary_term\ + \ = [\n {\n \"abbreviation\": \"str\", # Optional. The abbreviation\ + \ of the term.\n \"anchor\": {\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"glossaryGuid\": \"str\", #\ + \ Optional. The GUID of the glossary.\n \"relationGuid\": \"str\"\ + \ # Optional. The GUID of the\n relationship.\n },\n\ + \ \"antonyms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"assignedEntities\": [\n \ + \ {\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"entityStatus\": \"str\", # Optional. Status of\ + \ the\n entity - can be active or deleted. Deleted entities\ + \ are not removed\n from Atlas store. Known values are: \"\ + ACTIVE\", \"DELETED\".\n \"guid\": \"str\", # Optional. The\ + \ GUID of the object.\n \"relationshipAttributes\": {\n \ + \ \"attributes\": {\n \"str\": {}\ + \ # Optional. The attributes\n of the struct.\n \ + \ },\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag\n for concurrency control.\n \ + \ \"typeName\": \"str\" # Optional. The name of\n \ + \ the type.\n },\n \"relationshipGuid\"\ + : \"str\", # Optional. The GUID of\n the relationship.\n\ + \ \"relationshipStatus\": \"str\", # Optional. The enum of\n\ + \ relationship status. Known values are: \"ACTIVE\", \"DELETED\"\ + .\n \"relationshipType\": \"str\", # Optional. An array of\n\ + \ related object IDs.\n \"typeName\": \"\ + str\", # Optional. The name of the type.\n \"uniqueAttributes\"\ + : {\n \"str\": {} # Optional. The unique attributes\n \ + \ of the object.\n }\n \ + \ }\n ],\n \"attributes\": {\n \"str\": {\n\ + \ \"str\": {} # Optional. The custom attributes of the\n \ + \ term, which is map>.\"nThe key of\ + \ the first\n layer map is term template name.\n \ + \ }\n },\n \"categories\": [\n {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the\n \ + \ category.\n \"description\": \"str\", # Optional.\ + \ The description of\n the record.\n \"\ + displayText\": \"str\", # Optional. The display text.\n \"\ + relationGuid\": \"str\", # Optional. The GUID of the\n relationship.\n\ + \ \"status\": \"str\" # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n }\n \ + \ ],\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the\n struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the\n \ + \ entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of the\n entity - can be active or deleted. Deleted\ + \ entities are not removed\n from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag for\n concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who\n create the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional.\ + \ more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n \ + \ {\n \"endTime\": \"str\", # Optional. The\n \ + \ end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n start\ + \ of the time boundary.\n \"timeZone\": \"str\" # Optional.\ + \ The\n timezone of the time boundary.\n \ + \ }\n ]\n }\n ],\n \ + \ \"classifies\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"contacts\": {\n \"str\"\ + : [\n {\n \"id\": \"str\", # Optional.\ + \ Azure Active\n Directory object Id.\n \ + \ \"info\": \"str\" # Optional. additional\n \ + \ information to describe this contact.\n }\n \ + \ ]\n },\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who\ + \ created the record.\n \"examples\": [\n \"str\" # Optional.\ + \ An array of examples.\n ],\n \"guid\": \"str\", # Optional.\ + \ The GUID of the object.\n \"isA\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\",\ + \ # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency control.\n \"longDescription\"\ + : \"str\", # Optional. The long version description.\n \"name\": \"\ + str\", # Optional. The name of the glossary object.\n \"preferredTerms\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"preferredToTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"qualifiedName\": \"str\", # Optional.\ + \ The qualified name of the\n glossary object.\n \"replacedBy\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"replacementTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"resources\": [\n {\n\ + \ \"displayName\": \"str\", # Optional. Display name for\n\ + \ url.\n \"url\": \"str\" # Optional. web\ + \ url. http or https.\n }\n ],\n \"seeAlso\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"shortDescription\": \"str\", # Optional. The short version of\n\ + \ description.\n \"status\": \"str\", # Optional. Status\ + \ of the AtlasGlossaryTerm. Known\n values are: \"Draft\", \"Approved\"\ + , \"Alert\", \"Expired\".\n \"synonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the related term.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"templateName\"\ + : [\n {} # Optional.\n ],\n \"translatedTerms\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"translationTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"updateTime\": 0.0, # Optional. The\ + \ update time of the record.\n \"updatedBy\": \"str\", # Optional.\ + \ The user who updated the record.\n \"usage\": \"str\", # Optional.\ + \ The usage of the term.\n \"validValues\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n\ + \ the related term.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"validValuesFor\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ]\n\ + \ }\n ]\n\n # response body for status code(s): 200\n response.json()\ + \ == [\n {\n \"abbreviation\": \"str\", # Optional. The abbreviation\ + \ of the term.\n \"anchor\": {\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"glossaryGuid\": \"str\", #\ + \ Optional. The GUID of the glossary.\n \"relationGuid\": \"str\"\ + \ # Optional. The GUID of the\n relationship.\n },\n\ + \ \"antonyms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"assignedEntities\": [\n \ + \ {\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"entityStatus\": \"str\", # Optional. Status of\ + \ the\n entity - can be active or deleted. Deleted entities\ + \ are not removed\n from Atlas store. Known values are: \"\ + ACTIVE\", \"DELETED\".\n \"guid\": \"str\", # Optional. The\ + \ GUID of the object.\n \"relationshipAttributes\": {\n \ + \ \"attributes\": {\n \"str\": {}\ + \ # Optional. The attributes\n of the struct.\n \ + \ },\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag\n for concurrency control.\n \ + \ \"typeName\": \"str\" # Optional. The name of\n \ + \ the type.\n },\n \"relationshipGuid\"\ + : \"str\", # Optional. The GUID of\n the relationship.\n\ + \ \"relationshipStatus\": \"str\", # Optional. The enum of\n\ + \ relationship status. Known values are: \"ACTIVE\", \"DELETED\"\ + .\n \"relationshipType\": \"str\", # Optional. An array of\n\ + \ related object IDs.\n \"typeName\": \"\ + str\", # Optional. The name of the type.\n \"uniqueAttributes\"\ + : {\n \"str\": {} # Optional. The unique attributes\n \ + \ of the object.\n }\n \ + \ }\n ],\n \"attributes\": {\n \"str\": {\n\ + \ \"str\": {} # Optional. The custom attributes of the\n \ + \ term, which is map>.\"nThe key of\ + \ the first\n layer map is term template name.\n \ + \ }\n },\n \"categories\": [\n {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the\n \ + \ category.\n \"description\": \"str\", # Optional.\ + \ The description of\n the record.\n \"\ + displayText\": \"str\", # Optional. The display text.\n \"\ + relationGuid\": \"str\", # Optional. The GUID of the\n relationship.\n\ + \ \"status\": \"str\" # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n }\n \ + \ ],\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the\n struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the\n \ + \ entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of the\n entity - can be active or deleted. Deleted\ + \ entities are not removed\n from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag for\n concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who\n create the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional.\ + \ more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n \ + \ {\n \"endTime\": \"str\", # Optional. The\n \ + \ end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n start\ + \ of the time boundary.\n \"timeZone\": \"str\" # Optional.\ + \ The\n timezone of the time boundary.\n \ + \ }\n ]\n }\n ],\n \ + \ \"classifies\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"contacts\": {\n \"str\"\ + : [\n {\n \"id\": \"str\", # Optional.\ + \ Azure Active\n Directory object Id.\n \ + \ \"info\": \"str\" # Optional. additional\n \ + \ information to describe this contact.\n }\n \ + \ ]\n },\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who\ + \ created the record.\n \"examples\": [\n \"str\" # Optional.\ + \ An array of examples.\n ],\n \"guid\": \"str\", # Optional.\ + \ The GUID of the object.\n \"isA\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\",\ + \ # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency control.\n \"longDescription\"\ + : \"str\", # Optional. The long version description.\n \"name\": \"\ + str\", # Optional. The name of the glossary object.\n \"preferredTerms\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"preferredToTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"qualifiedName\": \"str\", # Optional.\ + \ The qualified name of the\n glossary object.\n \"replacedBy\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"replacementTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"resources\": [\n {\n\ + \ \"displayName\": \"str\", # Optional. Display name for\n\ + \ url.\n \"url\": \"str\" # Optional. web\ + \ url. http or https.\n }\n ],\n \"seeAlso\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"shortDescription\": \"str\", # Optional. The short version of\n\ + \ description.\n \"status\": \"str\", # Optional. Status\ + \ of the AtlasGlossaryTerm. Known\n values are: \"Draft\", \"Approved\"\ + , \"Alert\", \"Expired\".\n \"synonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the related term.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"templateName\"\ + : [\n {} # Optional.\n ],\n \"translatedTerms\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"translationTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"updateTime\": 0.0, # Optional. The\ + \ update time of the record.\n \"updatedBy\": \"str\", # Optional.\ + \ The user who updated the record.\n \"usage\": \"str\", # Optional.\ + \ The usage of the term.\n \"validValues\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n\ + \ the related term.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"validValuesFor\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ]\n\ + \ }\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.delete_glossary + name: delete_glossary + summary: Delete a glossary. + signature: 'async delete_glossary(glossary_guid: str, **kwargs: Any) -> None' + parameters: + - name: glossary_guid + description: The globally unique identifier for glossary. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.delete_glossary_category + name: delete_glossary_category + summary: Delete a glossary category. + signature: 'async delete_glossary_category(category_guid: str, **kwargs: Any) -> + None' + parameters: + - name: category_guid + description: The globally unique identifier of the category. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.delete_glossary_term + name: delete_glossary_term + summary: Delete a glossary term. + signature: 'async delete_glossary_term(term_guid: str, **kwargs: Any) -> None' + parameters: + - name: term_guid + description: The globally unique identifier for glossary term. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.delete_term_assignment_from_entities + name: delete_term_assignment_from_entities + summary: Delete the term assignment for the given list of related objects. + signature: 'async delete_term_assignment_from_entities(term_guid: str, related_object_ids: + List[MutableMapping[str, Any]], **kwargs: Any) -> None' + parameters: + - name: term_guid + description: The globally unique identifier for glossary term. + isRequired: true + types: + - + - name: related_object_ids + description: 'An array of related object IDs from which the term has to be + + dissociated.' + isRequired: true + types: + - [] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n related_object_ids\ + \ = [\n {\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"entityStatus\": \"str\", # Optional. Status of the entity\ + \ - can be\n active or deleted. Deleted entities are not removed from\ + \ Atlas store. Known\n values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \"\ + relationshipAttributes\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"typeName\": \"str\" # Optional.\ + \ The name of the type.\n },\n \"relationshipGuid\": \"str\"\ + , # Optional. The GUID of the relationship.\n \"relationshipStatus\"\ + : \"str\", # Optional. The enum of relationship\n status. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"relationshipType\": \"str\", #\ + \ Optional.\n \"typeName\": \"str\", # Optional. The name of the type.\n\ + \ \"uniqueAttributes\": {\n \"str\": {} # Optional. The\ + \ unique attributes of the object.\n }\n }\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.export_glossary_terms_as_csv + name: export_glossary_terms_as_csv + summary: Export Glossary Terms as csv file. + signature: 'async export_glossary_terms_as_csv(glossary_guid: str, term_guids: List[str], + *, include_term_hierarchy: bool | None = False, **kwargs: Any) -> IO' + parameters: + - name: glossary_guid + description: The globally unique identifier for glossary. + isRequired: true + types: + - + - name: term_guids + description: An array of term guids. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: include_term_hierarchy + description: Whether include term hierarchy. Default value is False. + types: + - + return: + description: IO + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n term_guids\ + \ = [\n \"str\" # Optional.\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.get_detailed_glossary + name: get_detailed_glossary + summary: Get a specific glossary with detailed information. + signature: 'async get_detailed_glossary(glossary_guid: str, *, include_term_hierarchy: + bool | None = False, **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: glossary_guid + description: The globally unique identifier for glossary. + isRequired: true + types: + - + keywordOnlyParameters: + - name: include_term_hierarchy + description: Whether include term hierarchy. Default value is False. + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + categories\": [\n {\n \"categoryGuid\": \"str\", # Optional.\ + \ The GUID of the category.\n \"description\": \"str\", # Optional.\ + \ The description of the\n category header.\n \"\ + displayText\": \"str\", # Optional. The display text.\n \"parentCategoryGuid\"\ + : \"str\", # Optional. The GUID of the\n parent category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ],\n \"categoryInfo\": {\n\ + \ \"str\": {\n \"anchor\": {\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"glossaryGuid\"\ + : \"str\", # Optional. The GUID of the\n glossary.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n },\n \"childrenCategories\"\ + : [\n {\n \"categoryGuid\": \"str\", \ + \ # Optional. The GUID\n of the category.\n \ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the category header.\n \"displayText\"\ + : \"str\", # Optional. The\n display text.\n \ + \ \"parentCategoryGuid\": \"str\", # Optional. The\n \ + \ GUID of the parent category.\n \"relationGuid\"\ + : \"str\" # Optional. The GUID\n of the relationship.\n\ + \ }\n ],\n \"classifications\":\ + \ [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional.\ + \ The GUID of the object.\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency\n control.\n \"longDescription\"\ + : \"str\", # Optional. The long version\n description.\n \ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n\ + \ \"parentCategory\": {\n \"categoryGuid\": \"\ + str\", # Optional. The GUID of the\n category.\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the category header.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"parentCategoryGuid\": \"\ + str\", # Optional. The GUID of\n the parent category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n },\n \"qualifiedName\"\ + : \"str\", # Optional. The qualified name of\n the glossary object.\n\ + \ \"shortDescription\": \"str\", # Optional. The short version\ + \ of\n description.\n \"terms\": [\n \ + \ {\n \"description\": \"str\", # Optional. The\n\ + \ description of the related term.\n \ + \ \"displayText\": \"str\", # Optional. The\n display\ + \ text.\n \"expression\": \"str\", # Optional. The\n \ + \ expression of the term.\n \"relationGuid\"\ + : \"str\", # Optional. The GUID\n of the relationship.\n\ + \ \"source\": \"str\", # Optional. The source of\n \ + \ the term.\n \"status\": \"str\", \ + \ # Optional. The status of\n term relationship. Known\ + \ values are: \"DRAFT\", \"ACTIVE\",\n \"DEPRECATED\"\ + , \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of\n the term.\n \"\ + termGuid\": \"str\" # Optional. The GUID of\n the term.\n\ + \ }\n ]\n }\n },\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional.\n Determines if propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"language\": \"str\", # Optional. The language of the glossary.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"qualifiedName\": \"str\", # Optional. The qualified name of the glossary\n\ + \ object.\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"termInfo\": {\n \"str\": {\n \ + \ \"abbreviation\": \"str\", # Optional. The abbreviation of the\n\ + \ term.\n \"anchor\": {\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"glossaryGuid\"\ + : \"str\", # Optional. The GUID of the\n glossary.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n },\n \"antonyms\"\ + : [\n {\n \"description\": \"str\", #\ + \ Optional. The\n description of the related term.\n \ + \ \"displayText\": \"str\", # Optional. The\n \ + \ display text.\n \"expression\": \"str\"\ + , # Optional. The\n expression of the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\": \"str\"\ + , # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ term relationship. Known values are: \"DRAFT\", \"ACTIVE\",\n \ + \ \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of\n \ + \ the term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of\n the term.\n }\n \ + \ ],\n \"assignedEntities\": [\n {\n\ + \ \"displayText\": \"str\", # Optional. The\n \ + \ display text.\n \"entityStatus\": \"str\"\ + , # Optional. Status of\n the entity - can be active\ + \ or deleted. Deleted entities are not\n removed from\ + \ Atlas store. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"guid\": \"str\", # Optional. The GUID of the\n \ + \ object.\n \"relationshipAttributes\": {\n \ + \ \"attributes\": {\n \"str\": {}\ + \ # Optional. The\n attributes of the struct.\n\ + \ },\n \"lastModifiedTS\"\ + : \"str\", # Optional.\n ETag for concurrency control.\n\ + \ \"typeName\": \"str\" # Optional. The\n \ + \ name of the type.\n },\n \ + \ \"relationshipGuid\": \"str\", # Optional. The\n \ + \ GUID of the relationship.\n \"relationshipStatus\"\ + : \"str\", # Optional. The\n enum of relationship status.\ + \ Known values are: \"ACTIVE\",\n \"DELETED\".\n \ + \ \"relationshipType\": \"str\", # Optional. An\n \ + \ array of related object IDs.\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"uniqueAttributes\": {\n \"str\"\ + : {} # Optional. The unique\n attributes of the object.\n\ + \ }\n }\n ],\n \ + \ \"attributes\": {\n \"str\": {\n \ + \ \"str\": {} # Optional. The custom attributes\n of\ + \ the term, which is map>.\"nThe key of\n \ + \ the first layer map is term template name.\n \ + \ }\n },\n \"categories\": [\n \ + \ {\n \"categoryGuid\": \"str\", # Optional. The GUID\n\ + \ of the category.\n \"description\"\ + : \"str\", # Optional. The\n description of the record.\n\ + \ \"displayText\": \"str\", # Optional. The\n \ + \ display text.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID\n of the relationship.\n \ + \ \"status\": \"str\" # Optional. The status of\n \ + \ term relationship. Known values are: \"DRAFT\", \"ACTIVE\",\n\ + \ \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \ + \ }\n ],\n \"classifications\": [\n \ + \ {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \"entityGuid\"\ + : \"str\", # Optional. The GUID of\n the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of\n \ + \ the entity - can be active or deleted. Deleted entities\ + \ are not\n removed from Atlas store. Known values are:\ + \ \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag\n for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"classifies\": [\n \ + \ {\n \"description\": \"str\", # Optional. The\n\ + \ description of the related term.\n \ + \ \"displayText\": \"str\", # Optional. The\n display\ + \ text.\n \"expression\": \"str\", # Optional. The\n \ + \ expression of the term.\n \"relationGuid\"\ + : \"str\", # Optional. The GUID\n of the relationship.\n\ + \ \"source\": \"str\", # Optional. The source of\n \ + \ the term.\n \"status\": \"str\", \ + \ # Optional. The status of\n term relationship. Known\ + \ values are: \"DRAFT\", \"ACTIVE\",\n \"DEPRECATED\"\ + , \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of\n the term.\n \"\ + termGuid\": \"str\" # Optional. The GUID of\n the term.\n\ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \ + \ \"id\": \"str\", # Optional. Azure\n Active\ + \ Directory object Id.\n \"info\": \"str\" # Optional.\ + \ additional\n information to describe this contact.\n\ + \ }\n ]\n },\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who\ + \ created the\n record.\n \"examples\": [\n \ + \ \"str\" # Optional. An array of examples.\n ],\n\ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \ + \ \"isA\": [\n {\n \"description\"\ + : \"str\", # Optional. The\n description of the related\ + \ term.\n \"displayText\": \"str\", # Optional. The\n \ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ term relationship. Known values are: \"DRAFT\", \"ACTIVE\"\ + ,\n \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of\n \ + \ the term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of\n the term.\n }\n \ + \ ],\n \"lastModifiedTS\": \"str\", # Optional. ETag\ + \ for concurrency\n control.\n \"longDescription\"\ + : \"str\", # Optional. The long version\n description.\n \ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n\ + \ \"preferredTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The\n description\ + \ of the related term.\n \"displayText\": \"str\", # Optional.\ + \ The\n display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ term relationship. Known values are: \"DRAFT\", \"ACTIVE\"\ + ,\n \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of\n \ + \ the term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of\n the term.\n }\n \ + \ ],\n \"preferredToTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the related term.\n \"displayText\"\ + : \"str\", # Optional. The\n display text.\n \ + \ \"expression\": \"str\", # Optional. The\n \ + \ expression of the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID\n of the relationship.\n \ + \ \"source\": \"str\", # Optional. The source of\n \ + \ the term.\n \"status\": \"str\", # Optional.\ + \ The status of\n term relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\",\n \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"qualifiedName\": \"str\"\ + , # Optional. The qualified name of\n the glossary object.\n\ + \ \"replacedBy\": [\n {\n \ + \ \"description\": \"str\", # Optional. The\n description\ + \ of the related term.\n \"displayText\": \"str\", # Optional.\ + \ The\n display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ term relationship. Known values are: \"DRAFT\", \"ACTIVE\"\ + ,\n \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of\n \ + \ the term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of\n the term.\n }\n \ + \ ],\n \"replacementTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the related term.\n \"displayText\"\ + : \"str\", # Optional. The\n display text.\n \ + \ \"expression\": \"str\", # Optional. The\n \ + \ expression of the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID\n of the relationship.\n \ + \ \"source\": \"str\", # Optional. The source of\n \ + \ the term.\n \"status\": \"str\", # Optional.\ + \ The status of\n term relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\",\n \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"resources\": [\n \ + \ {\n \"displayName\": \"str\", # Optional.\ + \ Display\n name for url.\n \"url\"\ + : \"str\" # Optional. web url. http or\n https.\n \ + \ }\n ],\n \"seeAlso\": [\n \ + \ {\n \"description\": \"str\", # Optional.\ + \ The\n description of the related term.\n \ + \ \"displayText\": \"str\", # Optional. The\n \ + \ display text.\n \"expression\": \"str\", # Optional.\ + \ The\n expression of the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\": \"str\", # Optional.\ + \ The source of\n the term.\n \"\ + status\": \"str\", # Optional. The status of\n term relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\",\n \"DEPRECATED\"\ + , \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of\n the term.\n \"\ + termGuid\": \"str\" # Optional. The GUID of\n the term.\n\ + \ }\n ],\n \"shortDescription\"\ + : \"str\", # Optional. The short version of\n description.\n\ + \ \"status\": \"str\", # Optional. Status of the\n \ + \ AtlasGlossaryTerm. Known values are: \"Draft\", \"Approved\", \"Alert\"\ + ,\n \"Expired\".\n \"synonyms\": [\n \ + \ {\n \"description\": \"str\", # Optional. The\n\ + \ description of the related term.\n \ + \ \"displayText\": \"str\", # Optional. The\n display\ + \ text.\n \"expression\": \"str\", # Optional. The\n \ + \ expression of the term.\n \"relationGuid\"\ + : \"str\", # Optional. The GUID\n of the relationship.\n\ + \ \"source\": \"str\", # Optional. The source of\n \ + \ the term.\n \"status\": \"str\", \ + \ # Optional. The status of\n term relationship. Known\ + \ values are: \"DRAFT\", \"ACTIVE\",\n \"DEPRECATED\"\ + , \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of\n the term.\n \"\ + termGuid\": \"str\" # Optional. The GUID of\n the term.\n\ + \ }\n ],\n \"templateName\": [\n\ + \ {} # Optional. The glossary term information.\n \ + \ ],\n \"translatedTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the related term.\n \"displayText\"\ + : \"str\", # Optional. The\n display text.\n \ + \ \"expression\": \"str\", # Optional. The\n \ + \ expression of the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID\n of the relationship.\n \ + \ \"source\": \"str\", # Optional. The source of\n \ + \ the term.\n \"status\": \"str\", # Optional.\ + \ The status of\n term relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\",\n \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"translationTerms\": [\n\ + \ {\n \"description\": \"str\", # Optional.\ + \ The\n description of the related term.\n \ + \ \"displayText\": \"str\", # Optional. The\n \ + \ display text.\n \"expression\": \"str\", # Optional.\ + \ The\n expression of the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\": \"str\", # Optional.\ + \ The source of\n the term.\n \"\ + status\": \"str\", # Optional. The status of\n term relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\",\n \"DEPRECATED\"\ + , \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of\n the term.\n \"\ + termGuid\": \"str\" # Optional. The GUID of\n the term.\n\ + \ }\n ],\n \"updateTime\": 0.0,\ + \ # Optional. The update time of the\n record.\n \ + \ \"updatedBy\": \"str\", # Optional. The user who updated the\n \ + \ record.\n \"usage\": \"str\", # Optional. The usage of\ + \ the term.\n \"validValues\": [\n {\n \ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the related term.\n \"displayText\"\ + : \"str\", # Optional. The\n display text.\n \ + \ \"expression\": \"str\", # Optional. The\n \ + \ expression of the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID\n of the relationship.\n \ + \ \"source\": \"str\", # Optional. The source of\n \ + \ the term.\n \"status\": \"str\", # Optional.\ + \ The status of\n term relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\",\n \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"validValuesFor\": [\n \ + \ {\n \"description\": \"str\", # Optional.\ + \ The\n description of the related term.\n \ + \ \"displayText\": \"str\", # Optional. The\n \ + \ display text.\n \"expression\": \"str\", # Optional.\ + \ The\n expression of the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\": \"str\", # Optional.\ + \ The source of\n the term.\n \"\ + status\": \"str\", # Optional. The status of\n term relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\",\n \"DEPRECATED\"\ + , \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of\n the term.\n \"\ + termGuid\": \"str\" # Optional. The GUID of\n the term.\n\ + \ }\n ]\n }\n },\n \"terms\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"usage\": \"str\" # Optional. The usage\ + \ of the glossary.\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.get_entities_assigned_with_term + name: get_entities_assigned_with_term + summary: Get all related objects assigned with the specified term. + signature: 'async get_entities_assigned_with_term(term_guid: str, *, limit: int + | None = None, offset: int | None = None, sort: str | None = ''ASC'', **kwargs: + Any) -> List[MutableMapping[str, Any]]' + parameters: + - name: term_guid + description: The globally unique identifier for glossary term. + isRequired: true + types: + - + keywordOnlyParameters: + - name: limit + description: The page size - by default there is no paging. Default value is None. + types: + - + - name: offset + description: The offset for pagination purpose. Default value is None. + types: + - + - name: sort + description: The sort order, ASC (default) or DESC. Default value is "ASC". + types: + - + return: + description: list of JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == [\n {\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity - can be\n \ + \ active or deleted. Deleted entities are not removed from Atlas store.\ + \ Known\n values are: \"ACTIVE\", \"DELETED\".\n \"guid\"\ + : \"str\", # Optional. The GUID of the object.\n \"relationshipAttributes\"\ + : {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"typeName\": \"str\" # Optional. The name of the type.\n \ + \ },\n \"relationshipGuid\": \"str\", # Optional. The GUID of the\ + \ relationship.\n \"relationshipStatus\": \"str\", # Optional. The\ + \ enum of relationship\n status. Known values are: \"ACTIVE\", \"\ + DELETED\".\n \"relationshipType\": \"str\", # Optional.\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \"uniqueAttributes\"\ + : {\n \"str\": {} # Optional. The unique attributes of the object.\n\ + \ }\n }\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.get_glossary + name: get_glossary + summary: Get a specific Glossary by its GUID. + signature: 'async get_glossary(glossary_guid: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: glossary_guid + description: The globally unique identifier for glossary. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + categories\": [\n {\n \"categoryGuid\": \"str\", # Optional.\ + \ The GUID of the category.\n \"description\": \"str\", # Optional.\ + \ The description of the\n category header.\n \"\ + displayText\": \"str\", # Optional. The display text.\n \"parentCategoryGuid\"\ + : \"str\", # Optional. The GUID of the\n parent category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional.\n Determines if propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"language\": \"str\", # Optional. The language of the glossary.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"qualifiedName\": \"str\", # Optional. The qualified name of the glossary\n\ + \ object.\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"terms\": [\n {\n \"\ + description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"expression\": \"str\", # Optional. The expression of\ + \ the term.\n \"relationGuid\": \"str\", # Optional. The GUID of\ + \ the\n relationship.\n \"source\": \"str\", #\ + \ Optional. The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"DRAFT\"\ + , \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"usage\": \"str\" # Optional. The usage of the glossary.\n\ + \ }\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.get_glossary_category + name: get_glossary_category + summary: Get specific glossary category by its GUID. + signature: 'async get_glossary_category(category_guid: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: category_guid + description: The globally unique identifier of the category. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + anchor\": {\n \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"glossaryGuid\": \"str\", # Optional. The GUID of the glossary.\n\ + \ \"relationGuid\": \"str\" # Optional. The GUID of the relationship.\n\ + \ },\n \"childrenCategories\": [\n {\n \"\ + categoryGuid\": \"str\", # Optional. The GUID of the category.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ category header.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"parentCategoryGuid\": \"str\", # Optional.\ + \ The GUID of the\n parent category.\n \"relationGuid\"\ + : \"str\" # Optional. The GUID of the\n relationship.\n \ + \ }\n ],\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"entityGuid\": \"str\", \ + \ # Optional. The GUID of the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of the entity -\n can be active or deleted.\ + \ Deleted entities are not removed from Atlas\n store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\", \ + \ # Optional. ETag for concurrency\n control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, # Optional.\n Determines\ + \ if propagations will be removed on entity deletion.\n \"source\"\ + : \"str\", # Optional. indicate the source who create\n the classification\ + \ detail.\n \"sourceDetails\": {\n \"str\": {}\ + \ # Optional. more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"\ + str\", # Optional. The start of\n the time boundary.\n\ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n \ + \ ]\n }\n ],\n \"guid\": \"str\", # Optional. The GUID\ + \ of the object.\n \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\ + \ control.\n \"longDescription\": \"str\", # Optional. The long version\ + \ description.\n \"name\": \"str\", # Optional. The name of the glossary\ + \ object.\n \"parentCategory\": {\n \"categoryGuid\": \"str\"\ + , # Optional. The GUID of the category.\n \"description\": \"str\"\ + , # Optional. The description of the category\n header.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \"parentCategoryGuid\"\ + : \"str\", # Optional. The GUID of the parent\n category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the relationship.\n\ + \ },\n \"qualifiedName\": \"str\", # Optional. The qualified name\ + \ of the glossary\n object.\n \"shortDescription\": \"str\", #\ + \ Optional. The short version of description.\n \"terms\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description of\ + \ the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.get_glossary_term + name: get_glossary_term + summary: Get a specific glossary term by its GUID. + signature: 'async get_glossary_term(term_guid: str, *, include_term_hierarchy: bool + | None = False, exclude_relationship_type_list: List[str] | None = None, **kwargs: + Any) -> MutableMapping[str, Any]' + parameters: + - name: term_guid + description: The globally unique identifier for glossary term. + isRequired: true + types: + - + keywordOnlyParameters: + - name: include_term_hierarchy + description: Whether include term hierarchy. Default value is False. + types: + - + - name: exclude_relationship_type_list + description: 'An array of relationship types which need to be + + excluded. Default value is None.' + types: + - [] + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + abbreviation\": \"str\", # Optional. The abbreviation of the term.\n \"\ + anchor\": {\n \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"glossaryGuid\": \"str\", # Optional. The GUID of the glossary.\n\ + \ \"relationGuid\": \"str\" # Optional. The GUID of the relationship.\n\ + \ },\n \"antonyms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"assignedEntities\": [\n {\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from Atlas\n\ + \ store. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \ + \ \"relationshipAttributes\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for\n concurrency control.\n\ + \ \"typeName\": \"str\" # Optional. The name of the type.\n\ + \ },\n \"relationshipGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"relationshipStatus\"\ + : \"str\", # Optional. The enum of\n relationship status. Known\ + \ values are: \"ACTIVE\", \"DELETED\".\n \"relationshipType\": \"\ + str\", # Optional. An array of related\n object IDs.\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"uniqueAttributes\": {\n \"str\": {} # Optional. The\ + \ unique attributes of the\n object.\n }\n \ + \ }\n ],\n \"attributes\": {\n \"str\": {\n \ + \ \"str\": {} # Optional. The custom attributes of the term,\n \ + \ which is map>.\"nThe key of the first\ + \ layer map\n is term template name.\n }\n },\n\ + \ \"categories\": [\n {\n \"categoryGuid\": \"str\"\ + , # Optional. The GUID of the category.\n \"description\": \"str\"\ + , # Optional. The description of the\n record.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \"\ + relationGuid\": \"str\", # Optional. The GUID of the\n relationship.\n\ + \ \"status\": \"str\" # Optional. The status of term relationship.\n\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\", \"\ + OBSOLETE\", \"OTHER\".\n }\n ],\n \"classifications\": [\n\ + \ {\n \"attributes\": {\n \"str\": {}\ + \ # Optional. The attributes of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from Atlas\n\ + \ store. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"removePropagationsOnEntityDelete\": bool,\ + \ # Optional.\n Determines if propagations will be removed on\ + \ entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"classifies\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"contacts\": {\n \"str\": [\n \ + \ {\n \"id\": \"str\", # Optional. Azure Active Directory\n\ + \ object Id.\n \"info\": \"str\" # Optional.\ + \ additional information to\n describe this contact.\n \ + \ }\n ]\n },\n \"createTime\": 0.0, # Optional.\ + \ The created time of the record.\n \"createdBy\": \"str\", # Optional.\ + \ The user who created the record.\n \"examples\": [\n \"str\"\ + \ # Optional. An array of examples.\n ],\n \"guid\": \"str\", #\ + \ Optional. The GUID of the object.\n \"isA\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"longDescription\": \"str\", # Optional.\ + \ The long version description.\n \"name\": \"str\", # Optional. The name\ + \ of the glossary object.\n \"preferredTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"preferredToTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"qualifiedName\": \"str\", # Optional.\ + \ The qualified name of the glossary\n object.\n \"replacedBy\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"replacementTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"resources\": [\n {\n \ + \ \"displayName\": \"str\", # Optional. Display name for url.\n \ + \ \"url\": \"str\" # Optional. web url. http or https.\n \ + \ }\n ],\n \"seeAlso\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"status\": \"str\", # Optional. Status of\ + \ the AtlasGlossaryTerm. Known values\n are: \"Draft\", \"Approved\",\ + \ \"Alert\", \"Expired\".\n \"synonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"templateName\": [\n {} # Optional.\n\ + \ ],\n \"translatedTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"translationTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"updateTime\": 0.0, # Optional. The\ + \ update time of the record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the record.\n \"usage\": \"str\", # Optional. The usage\ + \ of the term.\n \"validValues\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"validValuesFor\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.get_import_csv_operation_status + name: get_import_csv_operation_status + summary: Get the status of import csv operation. + signature: 'async get_import_csv_operation_status(operation_guid: str, **kwargs: + Any) -> MutableMapping[str, Any]' + parameters: + - name: operation_guid + description: The globally unique identifier for async operation/job. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + createTime\": \"str\", # Optional. The created time of the record.\n \"\ + error\": {\n \"errorCode\": 0, # Optional. Error code from async import\ + \ job if\n fail.\n \"errorMessage\": \"str\" # Optional.\ + \ Error message from async import\n job if fail.\n },\n \ + \ \"id\": \"str\", # Optional. guid string.\n \"lastUpdateTime\": \"\ + str\", # Optional. The last updated time of the record.\n \"properties\"\ + : {\n \"importedTerms\": \"str\", # Optional. Term numbers that already\n\ + \ imported successfully.\n \"totalTermsDetected\": \"str\"\ + \ # Optional. Total term numbers that\n detected in csv.\n \ + \ },\n \"status\": \"str\" # Optional. Enum of the status of import csv\ + \ operation.\n Known values are: \"NotStarted\", \"Succeeded\", \"Failed\"\ + , \"Running\".\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.list_category_terms + name: list_category_terms + summary: Get all terms associated with the specific category. + signature: 'async list_category_terms(category_guid: str, *, limit: int | None = + None, offset: int | None = None, sort: str | None = ''ASC'', **kwargs: Any) -> + List[MutableMapping[str, Any]]' + parameters: + - name: category_guid + description: The globally unique identifier of the category. + isRequired: true + types: + - + keywordOnlyParameters: + - name: limit + description: The page size - by default there is no paging. Default value is None. + types: + - + - name: offset + description: The offset for pagination purpose. Default value is None. + types: + - + - name: sort + description: The sort order, ASC (default) or DESC. Default value is "ASC". + types: + - + return: + description: list of JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the related\n\ + \ term.\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"expression\": \"str\", # Optional. The expression of the\ + \ term.\n \"relationGuid\": \"str\", # Optional. The GUID of the relationship.\n\ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term relationship. Known\n\ + \ values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of the\ + \ term.\n \"termGuid\": \"str\" # Optional. The GUID of the term.\n\ + \ }\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.list_glossaries + name: list_glossaries + summary: Get all glossaries registered with Atlas. + signature: 'async list_glossaries(*, limit: int | None = None, offset: int | None + = None, sort: str | None = ''ASC'', ignore_terms_and_categories: bool | None = + False, **kwargs: Any) -> List[MutableMapping[str, Any]]' + keywordOnlyParameters: + - name: limit + description: The page size - by default there is no paging. Default value is None. + types: + - + - name: offset + description: The offset for pagination purpose. Default value is None. + types: + - + - name: sort + description: The sort order, ASC (default) or DESC. Default value is "ASC". + types: + - + - name: ignore_terms_and_categories + description: 'Whether ignore terms and categories. Default value is + + False.' + types: + - + return: + description: list of JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == [\n {\n\ + \ \"categories\": [\n {\n \"categoryGuid\"\ + : \"str\", # Optional. The GUID of the\n category.\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the category header.\n \"displayText\":\ + \ \"str\", # Optional. The display text.\n \"parentCategoryGuid\"\ + : \"str\", # Optional. The GUID of\n the parent category.\n\ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ],\n \ + \ \"classifications\": [\n {\n \"attributes\"\ + : {\n \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"\ + entityGuid\": \"str\", # Optional. The GUID of the\n entity.\n\ + \ \"entityStatus\": \"str\", # Optional. Status of the\n \ + \ entity - can be active or deleted. Deleted entities are not\ + \ removed\n from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional. ETag\ + \ for\n concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, #\n Optional. Determines if propagations will be\ + \ removed on entity\n deletion.\n \"source\"\ + : \"str\", # Optional. indicate the source who\n create the\ + \ classification detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on source\n \ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of the type.\n \"validityPeriods\"\ + : [\n {\n \"endTime\": \"str\"\ + , # Optional. The\n end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n \ + \ start of the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The\n timezone\ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID\ + \ of the object.\n \"language\": \"str\", # Optional. The language\ + \ of the glossary.\n \"lastModifiedTS\": \"str\", # Optional. ETag\ + \ for concurrency control.\n \"longDescription\": \"str\", # Optional.\ + \ The long version description.\n \"name\": \"str\", # Optional. The\ + \ name of the glossary object.\n \"qualifiedName\": \"str\", # Optional.\ + \ The qualified name of the\n glossary object.\n \"shortDescription\"\ + : \"str\", # Optional. The short version of\n description.\n \ + \ \"terms\": [\n {\n \"description\": \"\ + str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"usage\": \"str\" # Optional. The usage\ + \ of the glossary.\n }\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.list_glossary_categories + name: list_glossary_categories + summary: Get the categories belonging to a specific glossary. + signature: 'async list_glossary_categories(glossary_guid: str, *, limit: int | None + = None, offset: int | None = None, sort: str | None = ''ASC'', **kwargs: Any) + -> List[MutableMapping[str, Any]]' + parameters: + - name: glossary_guid + description: The globally unique identifier for glossary. + isRequired: true + types: + - + keywordOnlyParameters: + - name: limit + description: The page size - by default there is no paging. Default value is None. + types: + - + - name: offset + description: The offset for pagination purpose. Default value is None. + types: + - + - name: sort + description: The sort order, ASC (default) or DESC. Default value is "ASC". + types: + - + return: + description: list of JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == [\n {\n\ + \ \"anchor\": {\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"glossaryGuid\": \"str\", # Optional. The\ + \ GUID of the glossary.\n \"relationGuid\": \"str\" # Optional.\ + \ The GUID of the\n relationship.\n },\n \"\ + childrenCategories\": [\n {\n \"categoryGuid\"\ + : \"str\", # Optional. The GUID of the\n category.\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the category header.\n \"displayText\":\ + \ \"str\", # Optional. The display text.\n \"parentCategoryGuid\"\ + : \"str\", # Optional. The GUID of\n the parent category.\n\ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ],\n \ + \ \"classifications\": [\n {\n \"attributes\"\ + : {\n \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"\ + entityGuid\": \"str\", # Optional. The GUID of the\n entity.\n\ + \ \"entityStatus\": \"str\", # Optional. Status of the\n \ + \ entity - can be active or deleted. Deleted entities are not\ + \ removed\n from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional. ETag\ + \ for\n concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, #\n Optional. Determines if propagations will be\ + \ removed on entity\n deletion.\n \"source\"\ + : \"str\", # Optional. indicate the source who\n create the\ + \ classification detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on source\n \ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of the type.\n \"validityPeriods\"\ + : [\n {\n \"endTime\": \"str\"\ + , # Optional. The\n end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n \ + \ start of the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The\n timezone\ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID\ + \ of the object.\n \"lastModifiedTS\": \"str\", # Optional. ETag for\ + \ concurrency control.\n \"longDescription\": \"str\", # Optional.\ + \ The long version description.\n \"name\": \"str\", # Optional. The\ + \ name of the glossary object.\n \"parentCategory\": {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the category.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ category header.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"parentCategoryGuid\": \"str\", # Optional.\ + \ The GUID of the\n parent category.\n \"relationGuid\"\ + : \"str\" # Optional. The GUID of the\n relationship.\n \ + \ },\n \"qualifiedName\": \"str\", # Optional. The qualified name\ + \ of the\n glossary object.\n \"shortDescription\": \"str\"\ + , # Optional. The short version of\n description.\n \"\ + terms\": [\n {\n \"description\": \"str\", #\ + \ Optional. The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", #\ + \ Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ]\n }\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.list_glossary_categories_headers + name: list_glossary_categories_headers + summary: Get the category headers belonging to a specific glossary. + signature: 'async list_glossary_categories_headers(glossary_guid: str, *, limit: + int | None = None, offset: int | None = None, sort: str | None = ''ASC'', **kwargs: + Any) -> List[MutableMapping[str, Any]]' + parameters: + - name: glossary_guid + description: The globally unique identifier for glossary. + isRequired: true + types: + - + keywordOnlyParameters: + - name: limit + description: The page size - by default there is no paging. Default value is None. + types: + - + - name: offset + description: The offset for pagination purpose. Default value is None. + types: + - + - name: sort + description: The sort order, ASC (default) or DESC. Default value is "ASC". + types: + - + return: + description: list of JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == [\n {\n\ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the category.\n\ + \ \"description\": \"str\", # Optional. The description of the category\n\ + \ header.\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"parentCategoryGuid\": \"str\", # Optional. The GUID of\ + \ the parent\n category.\n \"relationGuid\": \"str\" #\ + \ Optional. The GUID of the relationship.\n }\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.list_glossary_term_headers + name: list_glossary_term_headers + summary: Get term headers belonging to a specific glossary. + signature: 'async list_glossary_term_headers(glossary_guid: str, *, limit: int | + None = None, offset: int | None = None, sort: str | None = ''ASC'', **kwargs: + Any) -> List[MutableMapping[str, Any]]' + parameters: + - name: glossary_guid + description: The globally unique identifier for glossary. + isRequired: true + types: + - + keywordOnlyParameters: + - name: limit + description: The page size - by default there is no paging. Default value is None. + types: + - + - name: offset + description: The offset for pagination purpose. Default value is None. + types: + - + - name: sort + description: The sort order, ASC (default) or DESC. Default value is "ASC". + types: + - + return: + description: list of JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the related\n\ + \ term.\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"expression\": \"str\", # Optional. The expression of the\ + \ term.\n \"relationGuid\": \"str\", # Optional. The GUID of the relationship.\n\ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term relationship. Known\n\ + \ values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of the\ + \ term.\n \"termGuid\": \"str\" # Optional. The GUID of the term.\n\ + \ }\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.list_glossary_terms + name: list_glossary_terms + summary: Get terms belonging to a specific glossary. + signature: 'async list_glossary_terms(glossary_guid: str, *, include_term_hierarchy: + bool | None = False, limit: int | None = None, offset: int | None = None, sort: + str | None = ''ASC'', **kwargs: Any) -> List[MutableMapping[str, Any]]' + parameters: + - name: glossary_guid + description: The globally unique identifier for glossary. + isRequired: true + types: + - + keywordOnlyParameters: + - name: include_term_hierarchy + description: Whether include term hierarchy. Default value is False. + types: + - + - name: limit + description: The page size - by default there is no paging. Default value is None. + types: + - + - name: offset + description: The offset for pagination purpose. Default value is None. + types: + - + - name: sort + description: The sort order, ASC (default) or DESC. Default value is "ASC". + types: + - + return: + description: list of JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == [\n {\n\ + \ \"abbreviation\": \"str\", # Optional. The abbreviation of the term.\n\ + \ \"anchor\": {\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"glossaryGuid\": \"str\", # Optional. The\ + \ GUID of the glossary.\n \"relationGuid\": \"str\" # Optional.\ + \ The GUID of the\n relationship.\n },\n \"\ + antonyms\": [\n {\n \"description\": \"str\",\ + \ # Optional. The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\",\ + \ # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"assignedEntities\": [\n \ + \ {\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"entityStatus\": \"str\", # Optional. Status of\ + \ the\n entity - can be active or deleted. Deleted entities\ + \ are not removed\n from Atlas store. Known values are: \"\ + ACTIVE\", \"DELETED\".\n \"guid\": \"str\", # Optional. The\ + \ GUID of the object.\n \"relationshipAttributes\": {\n \ + \ \"attributes\": {\n \"str\": {}\ + \ # Optional. The attributes\n of the struct.\n \ + \ },\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag\n for concurrency control.\n \ + \ \"typeName\": \"str\" # Optional. The name of\n \ + \ the type.\n },\n \"relationshipGuid\"\ + : \"str\", # Optional. The GUID of\n the relationship.\n\ + \ \"relationshipStatus\": \"str\", # Optional. The enum of\n\ + \ relationship status. Known values are: \"ACTIVE\", \"DELETED\"\ + .\n \"relationshipType\": \"str\", # Optional. An array of\n\ + \ related object IDs.\n \"typeName\": \"\ + str\", # Optional. The name of the type.\n \"uniqueAttributes\"\ + : {\n \"str\": {} # Optional. The unique attributes\n \ + \ of the object.\n }\n \ + \ }\n ],\n \"attributes\": {\n \"str\": {\n\ + \ \"str\": {} # Optional. The custom attributes of the\n \ + \ term, which is map>.\"nThe key of\ + \ the first\n layer map is term template name.\n \ + \ }\n },\n \"categories\": [\n {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the\n \ + \ category.\n \"description\": \"str\", # Optional.\ + \ The description of\n the record.\n \"\ + displayText\": \"str\", # Optional. The display text.\n \"\ + relationGuid\": \"str\", # Optional. The GUID of the\n relationship.\n\ + \ \"status\": \"str\" # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n }\n \ + \ ],\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the\n struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the\n \ + \ entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of the\n entity - can be active or deleted. Deleted\ + \ entities are not removed\n from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag for\n concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who\n create the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional.\ + \ more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n \ + \ {\n \"endTime\": \"str\", # Optional. The\n \ + \ end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n start\ + \ of the time boundary.\n \"timeZone\": \"str\" # Optional.\ + \ The\n timezone of the time boundary.\n \ + \ }\n ]\n }\n ],\n \ + \ \"classifies\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"contacts\": {\n \"str\"\ + : [\n {\n \"id\": \"str\", # Optional.\ + \ Azure Active\n Directory object Id.\n \ + \ \"info\": \"str\" # Optional. additional\n \ + \ information to describe this contact.\n }\n \ + \ ]\n },\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who\ + \ created the record.\n \"examples\": [\n \"str\" # Optional.\ + \ An array of examples.\n ],\n \"guid\": \"str\", # Optional.\ + \ The GUID of the object.\n \"isA\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\",\ + \ # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency control.\n \"longDescription\"\ + : \"str\", # Optional. The long version description.\n \"name\": \"\ + str\", # Optional. The name of the glossary object.\n \"preferredTerms\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"preferredToTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"qualifiedName\": \"str\", # Optional.\ + \ The qualified name of the\n glossary object.\n \"replacedBy\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"replacementTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"resources\": [\n {\n\ + \ \"displayName\": \"str\", # Optional. Display name for\n\ + \ url.\n \"url\": \"str\" # Optional. web\ + \ url. http or https.\n }\n ],\n \"seeAlso\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"shortDescription\": \"str\", # Optional. The short version of\n\ + \ description.\n \"status\": \"str\", # Optional. Status\ + \ of the AtlasGlossaryTerm. Known\n values are: \"Draft\", \"Approved\"\ + , \"Alert\", \"Expired\".\n \"synonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the related term.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"templateName\"\ + : [\n {} # Optional.\n ],\n \"translatedTerms\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"translationTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"updateTime\": 0.0, # Optional. The\ + \ update time of the record.\n \"updatedBy\": \"str\", # Optional.\ + \ The user who updated the record.\n \"usage\": \"str\", # Optional.\ + \ The usage of the term.\n \"validValues\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n\ + \ the related term.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"validValuesFor\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ]\n\ + \ }\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.list_related_categories + name: list_related_categories + summary: 'Get all related categories (parent and children). Limit, offset, and sort + parameters are + + currently not being enabled and won''t work even they are passed.' + signature: 'async list_related_categories(category_guid: str, *, limit: int | None + = None, offset: int | None = None, sort: str | None = ''ASC'', **kwargs: Any) + -> Dict[str, List[MutableMapping[str, Any]]]' + parameters: + - name: category_guid + description: The globally unique identifier of the category. + isRequired: true + types: + - + keywordOnlyParameters: + - name: limit + description: The page size - by default there is no paging. Default value is None. + types: + - + - name: offset + description: The offset for pagination purpose. Default value is None. + types: + - + - name: sort + description: The sort order, ASC (default) or DESC. Default value is "ASC". + types: + - + return: + description: dict mapping str to list of JSON object + types: + - [, []] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + str\": [\n {\n \"categoryGuid\": \"str\", # Optional.\ + \ The GUID of the category.\n \"description\": \"str\", # Optional.\ + \ The description of the\n category header.\n \"\ + displayText\": \"str\", # Optional. The display text.\n \"parentCategoryGuid\"\ + : \"str\", # Optional. The GUID of the\n parent category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.list_related_terms + name: list_related_terms + summary: 'Get all related terms for a specific term by its GUID. Limit, offset, + and sort parameters are + + currently not being enabled and won''t work even they are passed.' + signature: 'async list_related_terms(term_guid: str, *, limit: int | None = None, + offset: int | None = None, sort: str | None = ''ASC'', **kwargs: Any) -> Dict[str, + List[MutableMapping[str, Any]]]' + parameters: + - name: term_guid + description: The globally unique identifier for glossary term. + isRequired: true + types: + - + keywordOnlyParameters: + - name: limit + description: The page size - by default there is no paging. Default value is None. + types: + - + - name: offset + description: The offset for pagination purpose. Default value is None. + types: + - + - name: sort + description: The sort order, ASC (default) or DESC. Default value is "ASC". + types: + - + return: + description: dict mapping str to list of JSON object + types: + - [, []] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + str\": [\n {\n \"description\": \"str\", # Optional.\ + \ The description of the\n related term.\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of the term.\n \"relationGuid\": \"\ + str\", # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"\ + OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional. The\ + \ steward of the term.\n \"termGuid\": \"str\" # Optional. The\ + \ GUID of the term.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.list_terms_by_glossary_name + name: list_terms_by_glossary_name + summary: Get terms by glossary name. + signature: 'async list_terms_by_glossary_name(glossary_name: str, *, limit: int + | None = None, offset: int | None = None, include_term_hierarchy: bool | None + = False, **kwargs: Any) -> List[MutableMapping[str, Any]]' + parameters: + - name: glossary_name + description: The name of the glossary. + isRequired: true + types: + - + keywordOnlyParameters: + - name: limit + description: The page size - by default there is no paging. Default value is None. + types: + - + - name: offset + description: The offset for pagination purpose. Default value is None. + types: + - + - name: include_term_hierarchy + description: Whether include term hierarchy. Default value is False. + types: + - + return: + description: list of JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == [\n {\n\ + \ \"abbreviation\": \"str\", # Optional. The abbreviation of the term.\n\ + \ \"anchor\": {\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"glossaryGuid\": \"str\", # Optional. The\ + \ GUID of the glossary.\n \"relationGuid\": \"str\" # Optional.\ + \ The GUID of the\n relationship.\n },\n \"\ + antonyms\": [\n {\n \"description\": \"str\",\ + \ # Optional. The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\",\ + \ # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"assignedEntities\": [\n \ + \ {\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"entityStatus\": \"str\", # Optional. Status of\ + \ the\n entity - can be active or deleted. Deleted entities\ + \ are not removed\n from Atlas store. Known values are: \"\ + ACTIVE\", \"DELETED\".\n \"guid\": \"str\", # Optional. The\ + \ GUID of the object.\n \"relationshipAttributes\": {\n \ + \ \"attributes\": {\n \"str\": {}\ + \ # Optional. The attributes\n of the struct.\n \ + \ },\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag\n for concurrency control.\n \ + \ \"typeName\": \"str\" # Optional. The name of\n \ + \ the type.\n },\n \"relationshipGuid\"\ + : \"str\", # Optional. The GUID of\n the relationship.\n\ + \ \"relationshipStatus\": \"str\", # Optional. The enum of\n\ + \ relationship status. Known values are: \"ACTIVE\", \"DELETED\"\ + .\n \"relationshipType\": \"str\", # Optional. An array of\n\ + \ related object IDs.\n \"typeName\": \"\ + str\", # Optional. The name of the type.\n \"uniqueAttributes\"\ + : {\n \"str\": {} # Optional. The unique attributes\n \ + \ of the object.\n }\n \ + \ }\n ],\n \"attributes\": {\n \"str\": {\n\ + \ \"str\": {} # Optional. The custom attributes of the\n \ + \ term, which is map>.\"nThe key of\ + \ the first\n layer map is term template name.\n \ + \ }\n },\n \"categories\": [\n {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the\n \ + \ category.\n \"description\": \"str\", # Optional.\ + \ The description of\n the record.\n \"\ + displayText\": \"str\", # Optional. The display text.\n \"\ + relationGuid\": \"str\", # Optional. The GUID of the\n relationship.\n\ + \ \"status\": \"str\" # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n }\n \ + \ ],\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the\n struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the\n \ + \ entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of the\n entity - can be active or deleted. Deleted\ + \ entities are not removed\n from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag for\n concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who\n create the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional.\ + \ more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n \ + \ {\n \"endTime\": \"str\", # Optional. The\n \ + \ end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n start\ + \ of the time boundary.\n \"timeZone\": \"str\" # Optional.\ + \ The\n timezone of the time boundary.\n \ + \ }\n ]\n }\n ],\n \ + \ \"classifies\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"contacts\": {\n \"str\"\ + : [\n {\n \"id\": \"str\", # Optional.\ + \ Azure Active\n Directory object Id.\n \ + \ \"info\": \"str\" # Optional. additional\n \ + \ information to describe this contact.\n }\n \ + \ ]\n },\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who\ + \ created the record.\n \"examples\": [\n \"str\" # Optional.\ + \ An array of examples.\n ],\n \"guid\": \"str\", # Optional.\ + \ The GUID of the object.\n \"isA\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\",\ + \ # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency control.\n \"longDescription\"\ + : \"str\", # Optional. The long version description.\n \"name\": \"\ + str\", # Optional. The name of the glossary object.\n \"preferredTerms\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"preferredToTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"qualifiedName\": \"str\", # Optional.\ + \ The qualified name of the\n glossary object.\n \"replacedBy\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"replacementTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"resources\": [\n {\n\ + \ \"displayName\": \"str\", # Optional. Display name for\n\ + \ url.\n \"url\": \"str\" # Optional. web\ + \ url. http or https.\n }\n ],\n \"seeAlso\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"shortDescription\": \"str\", # Optional. The short version of\n\ + \ description.\n \"status\": \"str\", # Optional. Status\ + \ of the AtlasGlossaryTerm. Known\n values are: \"Draft\", \"Approved\"\ + , \"Alert\", \"Expired\".\n \"synonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the related term.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"templateName\"\ + : [\n {} # Optional.\n ],\n \"translatedTerms\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"translationTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"updateTime\": 0.0, # Optional. The\ + \ update time of the record.\n \"updatedBy\": \"str\", # Optional.\ + \ The user who updated the record.\n \"usage\": \"str\", # Optional.\ + \ The usage of the term.\n \"validValues\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n\ + \ the related term.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"validValuesFor\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ]\n\ + \ }\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.partial_update_glossary + name: partial_update_glossary + summary: 'Update the glossary partially. Some properties such as qualifiedName are + not allowed to be + + updated.' + signature: 'async partial_update_glossary(glossary_guid: str, partial_updates: Dict[str, + str], *, include_term_hierarchy: bool | None = False, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: glossary_guid + description: The globally unique identifier for glossary. + isRequired: true + types: + - + - name: partial_updates + description: 'A map containing keys as attribute names and values as corresponding + + attribute values.' + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: include_term_hierarchy + description: Whether include term hierarchy. Default value is False. + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n partial_updates\ + \ = {\n \"str\": \"str\" # Optional.\n }\n\n # response body for status\ + \ code(s): 200\n response.json() == {\n \"categories\": [\n \ + \ {\n \"categoryGuid\": \"str\", # Optional. The GUID of the category.\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ category header.\n \"displayText\": \"str\", \ + \ # Optional. The display text.\n \"parentCategoryGuid\": \"str\"\ + , # Optional. The GUID of the\n parent category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ],\n \"classifications\": [\n \ + \ {\n \"attributes\": {\n \"str\": {} \ + \ # Optional. The attributes of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from Atlas\n\ + \ store. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"removePropagationsOnEntityDelete\": bool,\ + \ # Optional.\n Determines if propagations will be removed on\ + \ entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"language\": \"str\", # Optional. The language of the glossary.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"qualifiedName\": \"str\", # Optional. The qualified name of the glossary\n\ + \ object.\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"terms\": [\n {\n \"\ + description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"expression\": \"str\", # Optional. The expression of\ + \ the term.\n \"relationGuid\": \"str\", # Optional. The GUID of\ + \ the\n relationship.\n \"source\": \"str\", #\ + \ Optional. The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"DRAFT\"\ + , \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"usage\": \"str\" # Optional. The usage of the glossary.\n\ + \ }\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.partial_update_glossary_category + name: partial_update_glossary_category + summary: Update the glossary category partially. + signature: 'async partial_update_glossary_category(category_guid: str, partial_updates: + Dict[str, str], **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: category_guid + description: The globally unique identifier of the category. + isRequired: true + types: + - + - name: partial_updates + description: 'A map containing keys as attribute names and values as corresponding + + attribute values for partial update.' + isRequired: true + types: + - [, ] + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n partial_updates\ + \ = {\n \"str\": \"str\" # Optional.\n }\n\n # response body for status\ + \ code(s): 200\n response.json() == {\n \"anchor\": {\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"glossaryGuid\": \"str\"\ + , # Optional. The GUID of the glossary.\n \"relationGuid\": \"str\"\ + \ # Optional. The GUID of the relationship.\n },\n \"childrenCategories\"\ + : [\n {\n \"categoryGuid\": \"str\", # Optional. The\ + \ GUID of the category.\n \"description\": \"str\", # Optional.\ + \ The description of the\n category header.\n \"\ + displayText\": \"str\", # Optional. The display text.\n \"parentCategoryGuid\"\ + : \"str\", # Optional. The GUID of the\n parent category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional.\n Determines if propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"parentCategory\": {\n \"categoryGuid\": \"str\", # Optional.\ + \ The GUID of the category.\n \"description\": \"str\", # Optional.\ + \ The description of the category\n header.\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"parentCategoryGuid\":\ + \ \"str\", # Optional. The GUID of the parent\n category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the relationship.\n\ + \ },\n \"qualifiedName\": \"str\", # Optional. The qualified name\ + \ of the glossary\n object.\n \"shortDescription\": \"str\", #\ + \ Optional. The short version of description.\n \"terms\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description of\ + \ the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.partial_update_glossary_term + name: partial_update_glossary_term + summary: Update the glossary term partially. + signature: 'async partial_update_glossary_term(term_guid: str, partial_updates: + Dict[str, str], *, include_term_hierarchy: bool | None = False, **kwargs: Any) + -> MutableMapping[str, Any]' + parameters: + - name: term_guid + description: The globally unique identifier for glossary term. + isRequired: true + types: + - + - name: partial_updates + description: 'A map containing keys as attribute names and values as corresponding + + attribute values to be updated.' + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: include_term_hierarchy + description: Whether include term hierarchy. Default value is False. + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n partial_updates\ + \ = {\n \"str\": \"str\" # Optional.\n }\n\n # response body for status\ + \ code(s): 200\n response.json() == {\n \"abbreviation\": \"str\", #\ + \ Optional. The abbreviation of the term.\n \"anchor\": {\n \"\ + displayText\": \"str\", # Optional. The display text.\n \"glossaryGuid\"\ + : \"str\", # Optional. The GUID of the glossary.\n \"relationGuid\"\ + : \"str\" # Optional. The GUID of the relationship.\n },\n \"antonyms\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"assignedEntities\": [\n {\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n\ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \ + \ \"relationshipAttributes\": {\n \"attributes\":\ + \ {\n \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"\ + lastModifiedTS\": \"str\", # Optional. ETag for\n concurrency\ + \ control.\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n },\n \"relationshipGuid\": \"str\",\ + \ # Optional. The GUID of the\n relationship.\n \ + \ \"relationshipStatus\": \"str\", # Optional. The enum of\n \ + \ relationship status. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"relationshipType\": \"str\", # Optional. An array of related\n \ + \ object IDs.\n \"typeName\": \"str\", # Optional. The\ + \ name of the type.\n \"uniqueAttributes\": {\n \ + \ \"str\": {} # Optional. The unique attributes of the\n \ + \ object.\n }\n }\n ],\n \"attributes\"\ + : {\n \"str\": {\n \"str\": {} # Optional. The custom\ + \ attributes of the term,\n which is map>.\"\ + nThe key of the first layer map\n is term template name.\n \ + \ }\n },\n \"categories\": [\n {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the category.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ record.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"status\": \"str\" \ + \ # Optional. The status of term relationship.\n Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \ + \ }\n ],\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"entityGuid\": \"str\", \ + \ # Optional. The GUID of the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of the entity -\n can be active or deleted.\ + \ Deleted entities are not removed from Atlas\n store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\", \ + \ # Optional. ETag for concurrency\n control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, # Optional.\n Determines\ + \ if propagations will be removed on entity deletion.\n \"source\"\ + : \"str\", # Optional. indicate the source who create\n the classification\ + \ detail.\n \"sourceDetails\": {\n \"str\": {}\ + \ # Optional. more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"\ + str\", # Optional. The start of\n the time boundary.\n\ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n \ + \ ]\n }\n ],\n \"classifies\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"contacts\": {\n \"str\":\ + \ [\n {\n \"id\": \"str\", # Optional. Azure\ + \ Active Directory\n object Id.\n \"info\"\ + : \"str\" # Optional. additional information to\n describe\ + \ this contact.\n }\n ]\n },\n \"createTime\"\ + : 0.0, # Optional. The created time of the record.\n \"createdBy\": \"\ + str\", # Optional. The user who created the record.\n \"examples\": [\n\ + \ \"str\" # Optional. An array of examples.\n ],\n \"guid\"\ + : \"str\", # Optional. The GUID of the object.\n \"isA\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description of\ + \ the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"longDescription\": \"str\", # Optional.\ + \ The long version description.\n \"name\": \"str\", # Optional. The name\ + \ of the glossary object.\n \"preferredTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"preferredToTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"qualifiedName\": \"str\", # Optional.\ + \ The qualified name of the glossary\n object.\n \"replacedBy\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"replacementTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"resources\": [\n {\n \ + \ \"displayName\": \"str\", # Optional. Display name for url.\n \ + \ \"url\": \"str\" # Optional. web url. http or https.\n \ + \ }\n ],\n \"seeAlso\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"status\": \"str\", # Optional. Status of\ + \ the AtlasGlossaryTerm. Known values\n are: \"Draft\", \"Approved\",\ + \ \"Alert\", \"Expired\".\n \"synonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"templateName\": [\n {} # Optional.\n\ + \ ],\n \"translatedTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"translationTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"updateTime\": 0.0, # Optional. The\ + \ update time of the record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the record.\n \"usage\": \"str\", # Optional. The usage\ + \ of the term.\n \"validValues\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"validValuesFor\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.remove_term_assignment_from_entities + name: remove_term_assignment_from_entities + summary: Delete the term assignment for the given list of related objects. + signature: 'async remove_term_assignment_from_entities(term_guid: str, related_object_ids: + List[MutableMapping[str, Any]], **kwargs: Any) -> None' + parameters: + - name: term_guid + description: The globally unique identifier for glossary term. + isRequired: true + types: + - + - name: related_object_ids + description: 'An array of related object IDs from which the term has to be + + dissociated.' + isRequired: true + types: + - [] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n related_object_ids\ + \ = [\n {\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"entityStatus\": \"str\", # Optional. Status of the entity\ + \ - can be\n active or deleted. Deleted entities are not removed from\ + \ Atlas store. Known\n values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \"\ + relationshipAttributes\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"typeName\": \"str\" # Optional.\ + \ The name of the type.\n },\n \"relationshipGuid\": \"str\"\ + , # Optional. The GUID of the relationship.\n \"relationshipStatus\"\ + : \"str\", # Optional. The enum of relationship\n status. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"relationshipType\": \"str\", #\ + \ Optional.\n \"typeName\": \"str\", # Optional. The name of the type.\n\ + \ \"uniqueAttributes\": {\n \"str\": {} # Optional. The\ + \ unique attributes of the object.\n }\n }\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.update_glossary + name: update_glossary + summary: Update the given glossary. + signature: 'async update_glossary(glossary_guid: str, updated_glossary: MutableMapping[str, + Any], **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: glossary_guid + description: The globally unique identifier for glossary. + isRequired: true + types: + - + - name: updated_glossary + description: The glossary definition to be updated. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n updated_glossary\ + \ = {\n \"categories\": [\n {\n \"categoryGuid\"\ + : \"str\", # Optional. The GUID of the category.\n \"description\"\ + : \"str\", # Optional. The description of the\n category header.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"parentCategoryGuid\": \"str\", # Optional. The GUID of the\n \ + \ parent category.\n \"relationGuid\": \"str\" #\ + \ Optional. The GUID of the\n relationship.\n }\n \ + \ ],\n \"classifications\": [\n {\n \"attributes\"\ + : {\n \"str\": {} # Optional. The attributes of the struct.\n\ + \ },\n \"entityGuid\": \"str\", # Optional. The GUID\ + \ of the entity.\n \"entityStatus\": \"str\", # Optional. Status\ + \ of the entity -\n can be active or deleted. Deleted entities\ + \ are not removed from Atlas\n store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional. ETag\ + \ for concurrency\n control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional.\n Determines if propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"language\": \"str\", # Optional. The language of the glossary.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"qualifiedName\": \"str\", # Optional. The qualified name of the glossary\n\ + \ object.\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"terms\": [\n {\n \"\ + description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"expression\": \"str\", # Optional. The expression of\ + \ the term.\n \"relationGuid\": \"str\", # Optional. The GUID of\ + \ the\n relationship.\n \"source\": \"str\", #\ + \ Optional. The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"DRAFT\"\ + , \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"usage\": \"str\" # Optional. The usage of the glossary.\n\ + \ }\n\n # response body for status code(s): 200\n response.json() == {\n\ + \ \"categories\": [\n {\n \"categoryGuid\": \"str\"\ + , # Optional. The GUID of the category.\n \"description\": \"str\"\ + , # Optional. The description of the\n category header.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"parentCategoryGuid\": \"str\", # Optional. The GUID of the\n \ + \ parent category.\n \"relationGuid\": \"str\" # Optional.\ + \ The GUID of the\n relationship.\n }\n ],\n \ + \ \"classifications\": [\n {\n \"attributes\": {\n\ + \ \"str\": {} # Optional. The attributes of the struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional. The GUID\ + \ of the entity.\n \"entityStatus\": \"str\", # Optional. Status\ + \ of the entity -\n can be active or deleted. Deleted entities\ + \ are not removed from Atlas\n store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional. ETag\ + \ for concurrency\n control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional.\n Determines if propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"language\": \"str\", # Optional. The language of the glossary.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"qualifiedName\": \"str\", # Optional. The qualified name of the glossary\n\ + \ object.\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"terms\": [\n {\n \"\ + description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"expression\": \"str\", # Optional. The expression of\ + \ the term.\n \"relationGuid\": \"str\", # Optional. The GUID of\ + \ the\n relationship.\n \"source\": \"str\", #\ + \ Optional. The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"DRAFT\"\ + , \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"usage\": \"str\" # Optional. The usage of the glossary.\n\ + \ }\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.update_glossary_category + name: update_glossary_category + summary: Update the given glossary category by its GUID. + signature: 'async update_glossary_category(category_guid: str, glossary_category: + MutableMapping[str, Any], **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: category_guid + description: The globally unique identifier of the category. + isRequired: true + types: + - + - name: glossary_category + description: The glossary category to be updated. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n glossary_category\ + \ = {\n \"anchor\": {\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"glossaryGuid\": \"str\", # Optional. The GUID\ + \ of the glossary.\n \"relationGuid\": \"str\" # Optional. The GUID\ + \ of the relationship.\n },\n \"childrenCategories\": [\n \ + \ {\n \"categoryGuid\": \"str\", # Optional. The GUID of the\ + \ category.\n \"description\": \"str\", # Optional. The description\ + \ of the\n category header.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"parentCategoryGuid\":\ + \ \"str\", # Optional. The GUID of the\n parent category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional.\n Determines if propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"parentCategory\": {\n \"categoryGuid\": \"str\", # Optional.\ + \ The GUID of the category.\n \"description\": \"str\", # Optional.\ + \ The description of the category\n header.\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"parentCategoryGuid\":\ + \ \"str\", # Optional. The GUID of the parent\n category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the relationship.\n\ + \ },\n \"qualifiedName\": \"str\", # Optional. The qualified name\ + \ of the glossary\n object.\n \"shortDescription\": \"str\", #\ + \ Optional. The short version of description.\n \"terms\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description of\ + \ the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ]\n }\n\n # response body for status code(s):\ + \ 200\n response.json() == {\n \"anchor\": {\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"glossaryGuid\": \"str\"\ + , # Optional. The GUID of the glossary.\n \"relationGuid\": \"str\"\ + \ # Optional. The GUID of the relationship.\n },\n \"childrenCategories\"\ + : [\n {\n \"categoryGuid\": \"str\", # Optional. The\ + \ GUID of the category.\n \"description\": \"str\", # Optional.\ + \ The description of the\n category header.\n \"\ + displayText\": \"str\", # Optional. The display text.\n \"parentCategoryGuid\"\ + : \"str\", # Optional. The GUID of the\n parent category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional.\n Determines if propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"parentCategory\": {\n \"categoryGuid\": \"str\", # Optional.\ + \ The GUID of the category.\n \"description\": \"str\", # Optional.\ + \ The description of the category\n header.\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"parentCategoryGuid\":\ + \ \"str\", # Optional. The GUID of the parent\n category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the relationship.\n\ + \ },\n \"qualifiedName\": \"str\", # Optional. The qualified name\ + \ of the glossary\n object.\n \"shortDescription\": \"str\", #\ + \ Optional. The short version of description.\n \"terms\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description of\ + \ the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.GlossaryOperations.update_glossary_term + name: update_glossary_term + summary: Update the given glossary term by its GUID. + signature: 'async update_glossary_term(term_guid: str, glossary_term: MutableMapping[str, + Any], *, include_term_hierarchy: bool | None = False, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: term_guid + description: The globally unique identifier for glossary term. + isRequired: true + types: + - + - name: glossary_term + description: The glossary term to be updated. + isRequired: true + types: + - + keywordOnlyParameters: + - name: include_term_hierarchy + description: Whether include term hierarchy. Default value is False. + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n glossary_term\ + \ = {\n \"abbreviation\": \"str\", # Optional. The abbreviation of the\ + \ term.\n \"anchor\": {\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"glossaryGuid\": \"str\", # Optional. The GUID\ + \ of the glossary.\n \"relationGuid\": \"str\" # Optional. The GUID\ + \ of the relationship.\n },\n \"antonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"assignedEntities\": [\n {\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n\ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \ + \ \"relationshipAttributes\": {\n \"attributes\":\ + \ {\n \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"\ + lastModifiedTS\": \"str\", # Optional. ETag for\n concurrency\ + \ control.\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n },\n \"relationshipGuid\": \"str\",\ + \ # Optional. The GUID of the\n relationship.\n \ + \ \"relationshipStatus\": \"str\", # Optional. The enum of\n \ + \ relationship status. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"relationshipType\": \"str\", # Optional. An array of related\n \ + \ object IDs.\n \"typeName\": \"str\", # Optional. The\ + \ name of the type.\n \"uniqueAttributes\": {\n \ + \ \"str\": {} # Optional. The unique attributes of the\n \ + \ object.\n }\n }\n ],\n \"attributes\"\ + : {\n \"str\": {\n \"str\": {} # Optional. The custom\ + \ attributes of the term,\n which is map>.\"\ + nThe key of the first layer map\n is term template name.\n \ + \ }\n },\n \"categories\": [\n {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the category.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ record.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"status\": \"str\" \ + \ # Optional. The status of term relationship.\n Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \ + \ }\n ],\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"entityGuid\": \"str\", \ + \ # Optional. The GUID of the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of the entity -\n can be active or deleted.\ + \ Deleted entities are not removed from Atlas\n store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\", \ + \ # Optional. ETag for concurrency\n control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, # Optional.\n Determines\ + \ if propagations will be removed on entity deletion.\n \"source\"\ + : \"str\", # Optional. indicate the source who create\n the classification\ + \ detail.\n \"sourceDetails\": {\n \"str\": {}\ + \ # Optional. more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"\ + str\", # Optional. The start of\n the time boundary.\n\ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n \ + \ ]\n }\n ],\n \"classifies\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"contacts\": {\n \"str\":\ + \ [\n {\n \"id\": \"str\", # Optional. Azure\ + \ Active Directory\n object Id.\n \"info\"\ + : \"str\" # Optional. additional information to\n describe\ + \ this contact.\n }\n ]\n },\n \"createTime\"\ + : 0.0, # Optional. The created time of the record.\n \"createdBy\": \"\ + str\", # Optional. The user who created the record.\n \"examples\": [\n\ + \ \"str\" # Optional. An array of examples.\n ],\n \"guid\"\ + : \"str\", # Optional. The GUID of the object.\n \"isA\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description of\ + \ the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"longDescription\": \"str\", # Optional.\ + \ The long version description.\n \"name\": \"str\", # Optional. The name\ + \ of the glossary object.\n \"preferredTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"preferredToTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"qualifiedName\": \"str\", # Optional.\ + \ The qualified name of the glossary\n object.\n \"replacedBy\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"replacementTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"resources\": [\n {\n \ + \ \"displayName\": \"str\", # Optional. Display name for url.\n \ + \ \"url\": \"str\" # Optional. web url. http or https.\n \ + \ }\n ],\n \"seeAlso\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"status\": \"str\", # Optional. Status of\ + \ the AtlasGlossaryTerm. Known values\n are: \"Draft\", \"Approved\",\ + \ \"Alert\", \"Expired\".\n \"synonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"templateName\": [\n {} # Optional.\n\ + \ ],\n \"translatedTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"translationTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"updateTime\": 0.0, # Optional. The\ + \ update time of the record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the record.\n \"usage\": \"str\", # Optional. The usage\ + \ of the term.\n \"validValues\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"validValuesFor\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ]\n }\n\n # response body for status code(s): 200\n response.json()\ + \ == {\n \"abbreviation\": \"str\", # Optional. The abbreviation of the\ + \ term.\n \"anchor\": {\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"glossaryGuid\": \"str\", # Optional. The GUID\ + \ of the glossary.\n \"relationGuid\": \"str\" # Optional. The GUID\ + \ of the relationship.\n },\n \"antonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"assignedEntities\": [\n {\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n\ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \ + \ \"relationshipAttributes\": {\n \"attributes\":\ + \ {\n \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"\ + lastModifiedTS\": \"str\", # Optional. ETag for\n concurrency\ + \ control.\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n },\n \"relationshipGuid\": \"str\",\ + \ # Optional. The GUID of the\n relationship.\n \ + \ \"relationshipStatus\": \"str\", # Optional. The enum of\n \ + \ relationship status. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"relationshipType\": \"str\", # Optional. An array of related\n \ + \ object IDs.\n \"typeName\": \"str\", # Optional. The\ + \ name of the type.\n \"uniqueAttributes\": {\n \ + \ \"str\": {} # Optional. The unique attributes of the\n \ + \ object.\n }\n }\n ],\n \"attributes\"\ + : {\n \"str\": {\n \"str\": {} # Optional. The custom\ + \ attributes of the term,\n which is map>.\"\ + nThe key of the first layer map\n is term template name.\n \ + \ }\n },\n \"categories\": [\n {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the category.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ record.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"status\": \"str\" \ + \ # Optional. The status of term relationship.\n Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \ + \ }\n ],\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"entityGuid\": \"str\", \ + \ # Optional. The GUID of the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of the entity -\n can be active or deleted.\ + \ Deleted entities are not removed from Atlas\n store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\", \ + \ # Optional. ETag for concurrency\n control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, # Optional.\n Determines\ + \ if propagations will be removed on entity deletion.\n \"source\"\ + : \"str\", # Optional. indicate the source who create\n the classification\ + \ detail.\n \"sourceDetails\": {\n \"str\": {}\ + \ # Optional. more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"\ + str\", # Optional. The start of\n the time boundary.\n\ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n \ + \ ]\n }\n ],\n \"classifies\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"contacts\": {\n \"str\":\ + \ [\n {\n \"id\": \"str\", # Optional. Azure\ + \ Active Directory\n object Id.\n \"info\"\ + : \"str\" # Optional. additional information to\n describe\ + \ this contact.\n }\n ]\n },\n \"createTime\"\ + : 0.0, # Optional. The created time of the record.\n \"createdBy\": \"\ + str\", # Optional. The user who created the record.\n \"examples\": [\n\ + \ \"str\" # Optional. An array of examples.\n ],\n \"guid\"\ + : \"str\", # Optional. The GUID of the object.\n \"isA\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description of\ + \ the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"longDescription\": \"str\", # Optional.\ + \ The long version description.\n \"name\": \"str\", # Optional. The name\ + \ of the glossary object.\n \"preferredTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"preferredToTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"qualifiedName\": \"str\", # Optional.\ + \ The qualified name of the glossary\n object.\n \"replacedBy\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"replacementTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"resources\": [\n {\n \ + \ \"displayName\": \"str\", # Optional. Display name for url.\n \ + \ \"url\": \"str\" # Optional. web url. http or https.\n \ + \ }\n ],\n \"seeAlso\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"status\": \"str\", # Optional. Status of\ + \ the AtlasGlossaryTerm. Known values\n are: \"Draft\", \"Approved\",\ + \ \"Alert\", \"Expired\".\n \"synonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"templateName\": [\n {} # Optional.\n\ + \ ],\n \"translatedTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"translationTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"updateTime\": 0.0, # Optional. The\ + \ update time of the record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the record.\n \"usage\": \"str\", # Optional. The usage\ + \ of the term.\n \"validValues\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"validValuesFor\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ]\n }\n ````\n" diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.LineageOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.LineageOperations.yml new file mode 100644 index 00000000..5a526e92 --- /dev/null +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.LineageOperations.yml @@ -0,0 +1,401 @@ +### YamlMime:PythonClass +uid: azure.purview.catalog.aio.operations.LineageOperations +name: LineageOperations +fullName: azure.purview.catalog.aio.operations.LineageOperations +module: azure.purview.catalog.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: LineageOperations(*args, **kwargs) +methods: +- uid: azure.purview.catalog.aio.operations.LineageOperations.get_lineage_by_unique_attribute + name: get_lineage_by_unique_attribute + summary: 'Returns lineage info about entity. + + + In addition to the typeName path parameter, attribute key-value pair(s) can be + provided in the + + following format + + + attr:[attrName]=[attrValue] + + + NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.' + signature: 'async get_lineage_by_unique_attribute(type_name: str, *, direction: + str, depth: int | None = 3, width: int | None = 10, include_parent: bool | None + = None, get_derived_lineage: bool | None = None, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: type_name + description: The name of the type. + isRequired: true + types: + - + keywordOnlyParameters: + - name: direction + description: 'The direction of the lineage, which could be INPUT, OUTPUT or BOTH. + Known + + values are: "BOTH", "INPUT", and "OUTPUT".' + types: + - + - name: depth + description: The number of hops for lineage. Default value is 3. + types: + - + - name: width + description: The number of max expanding width in lineage. Default value is 10. + types: + - + - name: include_parent + description: 'True to include the parent chain in the response. Default value + is + + None.' + types: + - + - name: get_derived_lineage + description: 'True to include derived lineage in the response. Default value is + + None.' + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + baseEntityGuid\": \"str\", # Optional. The GUID of the base entity.\n \"\ + childrenCount\": 0, # Optional. The number of children node.\n \"guidEntityMap\"\ + : {\n \"str\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"classificationNames\": [\n \"str\" # Optional.\ + \ An array of classification names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n },\n \"includeParent\": bool, # Optional.\ + \ True to return the parent of the base\n entity.\n \"lineageDepth\"\ + : 0, # Optional. The depth of lineage.\n \"lineageDirection\": \"str\"\ + , # Optional. The enum of lineage direction. Known\n values are: \"INPUT\"\ + , \"OUTPUT\", \"BOTH\".\n \"lineageWidth\": 0, # Optional. The width of\ + \ lineage.\n \"parentRelations\": [\n {\n \"childEntityId\"\ + : \"str\", # Optional. The GUID of child\n entity.\n \ + \ \"parentEntityId\": \"str\", # Optional. The GUID of parent\n \ + \ entity.\n \"relationshipId\": \"str\" # Optional. The\ + \ GUID of\n relationship.\n }\n ],\n \"\ + relations\": [\n {\n \"fromEntityId\": \"str\", # Optional.\ + \ The GUID of from-entity.\n \"relationshipId\": \"str\", # Optional.\ + \ The GUID of\n relationship.\n \"toEntityId\":\ + \ \"str\" # Optional. The GUID of to-entity.\n }\n ],\n \ + \ \"widthCounts\": {\n \"str\": {\n \"str\": {} # Optional.\ + \ The entity count in specific\n direction.\n }\n \ + \ }\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.LineageOperations.get_lineage_graph + name: get_lineage_graph + summary: Get lineage info of the entity specified by GUID. + signature: 'async get_lineage_graph(guid: str, *, direction: str, depth: int | None + = 3, width: int | None = 10, include_parent: bool | None = None, get_derived_lineage: + bool | None = None, **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + keywordOnlyParameters: + - name: direction + description: 'The direction of the lineage, which could be INPUT, OUTPUT or BOTH. + Known + + values are: "BOTH", "INPUT", and "OUTPUT".' + types: + - + - name: depth + description: The number of hops for lineage. Default value is 3. + types: + - + - name: width + description: The number of max expanding width in lineage. Default value is 10. + types: + - + - name: include_parent + description: 'True to include the parent chain in the response. Default value + is + + None.' + types: + - + - name: get_derived_lineage + description: 'True to include derived lineage in the response. Default value is + + None.' + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + baseEntityGuid\": \"str\", # Optional. The GUID of the base entity.\n \"\ + childrenCount\": 0, # Optional. The number of children node.\n \"guidEntityMap\"\ + : {\n \"str\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"classificationNames\": [\n \"str\" # Optional.\ + \ An array of classification names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n },\n \"includeParent\": bool, # Optional.\ + \ True to return the parent of the base\n entity.\n \"lineageDepth\"\ + : 0, # Optional. The depth of lineage.\n \"lineageDirection\": \"str\"\ + , # Optional. The enum of lineage direction. Known\n values are: \"INPUT\"\ + , \"OUTPUT\", \"BOTH\".\n \"lineageWidth\": 0, # Optional. The width of\ + \ lineage.\n \"parentRelations\": [\n {\n \"childEntityId\"\ + : \"str\", # Optional. The GUID of child\n entity.\n \ + \ \"parentEntityId\": \"str\", # Optional. The GUID of parent\n \ + \ entity.\n \"relationshipId\": \"str\" # Optional. The\ + \ GUID of\n relationship.\n }\n ],\n \"\ + relations\": [\n {\n \"fromEntityId\": \"str\", # Optional.\ + \ The GUID of from-entity.\n \"relationshipId\": \"str\", # Optional.\ + \ The GUID of\n relationship.\n \"toEntityId\":\ + \ \"str\" # Optional. The GUID of to-entity.\n }\n ],\n \ + \ \"widthCounts\": {\n \"str\": {\n \"str\": {} # Optional.\ + \ The entity count in specific\n direction.\n }\n \ + \ }\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.LineageOperations.next_page_lineage + name: next_page_lineage + summary: Return immediate next page lineage info about entity with pagination. + signature: 'async next_page_lineage(guid: str, *, direction: str, get_derived_lineage: + bool | None = None, offset: int | None = None, limit: int | None = None, **kwargs: + Any) -> MutableMapping[str, Any]' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + keywordOnlyParameters: + - name: direction + description: 'The direction of the lineage, which could be INPUT, OUTPUT or BOTH. + Known + + values are: "BOTH", "INPUT", and "OUTPUT".' + types: + - + - name: get_derived_lineage + description: 'True to include derived lineage in the response. Default value is + + None.' + types: + - + - name: offset + description: The offset for pagination purpose. Default value is None. + types: + - + - name: limit + description: The page size - by default there is no paging. Default value is None. + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + baseEntityGuid\": \"str\", # Optional. The GUID of the base entity.\n \"\ + childrenCount\": 0, # Optional. The number of children node.\n \"guidEntityMap\"\ + : {\n \"str\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"classificationNames\": [\n \"str\" # Optional.\ + \ An array of classification names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n },\n \"includeParent\": bool, # Optional.\ + \ True to return the parent of the base\n entity.\n \"lineageDepth\"\ + : 0, # Optional. The depth of lineage.\n \"lineageDirection\": \"str\"\ + , # Optional. The enum of lineage direction. Known\n values are: \"INPUT\"\ + , \"OUTPUT\", \"BOTH\".\n \"lineageWidth\": 0, # Optional. The width of\ + \ lineage.\n \"parentRelations\": [\n {\n \"childEntityId\"\ + : \"str\", # Optional. The GUID of child\n entity.\n \ + \ \"parentEntityId\": \"str\", # Optional. The GUID of parent\n \ + \ entity.\n \"relationshipId\": \"str\" # Optional. The\ + \ GUID of\n relationship.\n }\n ],\n \"\ + relations\": [\n {\n \"fromEntityId\": \"str\", # Optional.\ + \ The GUID of from-entity.\n \"relationshipId\": \"str\", # Optional.\ + \ The GUID of\n relationship.\n \"toEntityId\":\ + \ \"str\" # Optional. The GUID of to-entity.\n }\n ],\n \ + \ \"widthCounts\": {\n \"str\": {\n \"str\": {} # Optional.\ + \ The entity count in specific\n direction.\n }\n \ + \ }\n }\n ````\n" diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.RelationshipOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.RelationshipOperations.yml new file mode 100644 index 00000000..4d177805 --- /dev/null +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.RelationshipOperations.yml @@ -0,0 +1,274 @@ +### YamlMime:PythonClass +uid: azure.purview.catalog.aio.operations.RelationshipOperations +name: RelationshipOperations +fullName: azure.purview.catalog.aio.operations.RelationshipOperations +module: azure.purview.catalog.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: RelationshipOperations(*args, **kwargs) +methods: +- uid: azure.purview.catalog.aio.operations.RelationshipOperations.create + name: create + summary: Create a new relationship between entities. + signature: 'async create(relationship: MutableMapping[str, Any], **kwargs: Any) + -> MutableMapping[str, Any]' + parameters: + - name: relationship + description: 'The AtlasRelationship object containing the information for the + + relationship to be created.' + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n relationship\ + \ = {\n \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"createTime\": 0.0, # Optional. The created\ + \ time of the record.\n \"createdBy\": \"str\", # Optional. The user who\ + \ created the record.\n \"end1\": {\n \"guid\": \"str\", # Optional.\ + \ The GUID of the object.\n \"typeName\": \"str\", # Optional. The\ + \ name of the type.\n \"uniqueAttributes\": {\n \"str\"\ + : {} # Optional. The unique attributes of the object.\n }\n },\n\ + \ \"end2\": {\n \"guid\": \"str\", # Optional. The GUID of the\ + \ object.\n \"typeName\": \"str\", # Optional. The name of the type.\n\ + \ \"uniqueAttributes\": {\n \"str\": {} # Optional. The\ + \ unique attributes of the object.\n }\n },\n \"guid\":\ + \ \"str\", # Optional. The GUID of the relationship.\n \"homeId\": \"str\"\ + , # Optional. The home ID of the relationship.\n \"label\": \"str\", #\ + \ Optional. The label of the relationship.\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag for concurrency control.\n \"provenanceType\": 0.0,\ + \ # Optional. Used to record the provenance of an\n instance of an entity\ + \ or relationship.\n \"status\": \"str\", # Optional. The enum of relationship\ + \ status. Known values\n are: \"ACTIVE\", \"DELETED\".\n \"typeName\"\ + : \"str\", # Optional. The name of the type.\n \"updateTime\": 0.0, #\ + \ Optional. The update time of the record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the record.\n \"version\": 0.0 # Optional.\ + \ The version of the relationship.\n }\n\n # response body for status code(s):\ + \ 200\n response.json() == {\n \"attributes\": {\n \"str\":\ + \ {} # Optional. The attributes of the struct.\n },\n \"createTime\"\ + : 0.0, # Optional. The created time of the record.\n \"createdBy\": \"\ + str\", # Optional. The user who created the record.\n \"end1\": {\n \ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \"\ + typeName\": \"str\", # Optional. The name of the type.\n \"uniqueAttributes\"\ + : {\n \"str\": {} # Optional. The unique attributes of the object.\n\ + \ }\n },\n \"end2\": {\n \"guid\": \"str\", #\ + \ Optional. The GUID of the object.\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"uniqueAttributes\": {\n \"\ + str\": {} # Optional. The unique attributes of the object.\n }\n \ + \ },\n \"guid\": \"str\", # Optional. The GUID of the relationship.\n\ + \ \"homeId\": \"str\", # Optional. The home ID of the relationship.\n \ + \ \"label\": \"str\", # Optional. The label of the relationship.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n \ + \ \"provenanceType\": 0.0, # Optional. Used to record the provenance of\ + \ an\n instance of an entity or relationship.\n \"status\": \"str\"\ + , # Optional. The enum of relationship status. Known values\n are: \"\ + ACTIVE\", \"DELETED\".\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"updateTime\": 0.0, # Optional. The update time of the record.\n\ + \ \"updatedBy\": \"str\", # Optional. The user who updated the record.\n\ + \ \"version\": 0.0 # Optional. The version of the relationship.\n }\n\ + \ ````\n" +- uid: azure.purview.catalog.aio.operations.RelationshipOperations.delete + name: delete + summary: Delete a relationship between entities by its GUID. + signature: 'async delete(guid: str, **kwargs: Any) -> None' + parameters: + - name: guid + description: The globally unique identifier of the relationship. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.purview.catalog.aio.operations.RelationshipOperations.get + name: get + summary: Get relationship information between entities by its GUID. + signature: 'async get(guid: str, *, extended_info: bool | None = None, **kwargs: + Any) -> MutableMapping[str, Any]' + parameters: + - name: guid + description: The globally unique identifier of the relationship. + isRequired: true + types: + - + keywordOnlyParameters: + - name: extended_info + description: Limits whether includes extended information. Default value is None. + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + referredEntities\": {\n \"str\": {\n \"attributes\": {\n\ + \ \"str\": {} # Optional. The attributes of the struct.\n \ + \ },\n \"classificationNames\": [\n \ + \ \"str\" # Optional. An array of classification names.\n ],\n\ + \ \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes\n of the struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional. The\ + \ GUID of\n the entity.\n \"entityStatus\"\ + : \"str\", # Optional. Status of\n the entity - can be\ + \ active or deleted. Deleted entities are not\n removed\ + \ from Atlas store. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag\n \ + \ for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, #\n Optional. Determines if propagations will\ + \ be removed on entity\n deletion.\n \ + \ \"source\": \"str\", # Optional. indicate the\n \ + \ source who create the classification detail.\n \"sourceDetails\"\ + : {\n \"str\": {} # Optional. more detail on\n \ + \ source information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"validityPeriods\": [\n\ + \ {\n \"endTime\": \"\ + str\", #\n Optional. The end of the time boundary.\n\ + \ \"startTime\": \"str\", #\n \ + \ Optional. The start of the time boundary.\n \ + \ \"timeZone\": \"str\" #\n Optional.\ + \ The timezone of the time boundary.\n }\n \ + \ ]\n }\n ],\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"guid\": \"str\", \ + \ # Optional. The GUID of the record.\n \"isIncomplete\": bool,\ + \ # Optional. Whether it is a shell\n entity.\n \ + \ \"labels\": [\n \"str\" # Optional. labels.\n \ + \ ],\n \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n },\n \"relationship\": {\n \"\ + attributes\": {\n \"str\": {} # Optional. The attributes of the\ + \ struct.\n },\n \"createTime\": 0.0, # Optional. The created\ + \ time of the record.\n \"createdBy\": \"str\", # Optional. The user\ + \ who created the record.\n \"end1\": {\n \"guid\": \"\ + str\", # Optional. The GUID of the object.\n \"typeName\": \"str\"\ + , # Optional. The name of the type.\n \"uniqueAttributes\": {\n\ + \ \"str\": {} # Optional. The unique attributes of the\n \ + \ object.\n }\n },\n \"end2\"\ + : {\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"uniqueAttributes\": {\n \"str\": {} # Optional.\ + \ The unique attributes of the\n object.\n }\n\ + \ },\n \"guid\": \"str\", # Optional. The GUID of the relationship.\n\ + \ \"homeId\": \"str\", # Optional. The home ID of the relationship.\n\ + \ \"label\": \"str\", # Optional. The label of the relationship.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"provenanceType\": 0.0, # Optional. Used to record the provenance\ + \ of\n an instance of an entity or relationship.\n \"status\"\ + : \"str\", # Optional. The enum of relationship status. Known\n values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the record.\n \"updatedBy\": \"str\", # Optional. The user\ + \ who updated the record.\n \"version\": 0.0 # Optional. The version\ + \ of the relationship.\n }\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.RelationshipOperations.update + name: update + summary: Update an existing relationship between entities. + signature: 'async update(relationship: MutableMapping[str, Any], **kwargs: Any) + -> MutableMapping[str, Any]' + parameters: + - name: relationship + description: 'The AtlasRelationship object containing the information for the + + relationship to be created.' + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n relationship\ + \ = {\n \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"createTime\": 0.0, # Optional. The created\ + \ time of the record.\n \"createdBy\": \"str\", # Optional. The user who\ + \ created the record.\n \"end1\": {\n \"guid\": \"str\", # Optional.\ + \ The GUID of the object.\n \"typeName\": \"str\", # Optional. The\ + \ name of the type.\n \"uniqueAttributes\": {\n \"str\"\ + : {} # Optional. The unique attributes of the object.\n }\n },\n\ + \ \"end2\": {\n \"guid\": \"str\", # Optional. The GUID of the\ + \ object.\n \"typeName\": \"str\", # Optional. The name of the type.\n\ + \ \"uniqueAttributes\": {\n \"str\": {} # Optional. The\ + \ unique attributes of the object.\n }\n },\n \"guid\":\ + \ \"str\", # Optional. The GUID of the relationship.\n \"homeId\": \"str\"\ + , # Optional. The home ID of the relationship.\n \"label\": \"str\", #\ + \ Optional. The label of the relationship.\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag for concurrency control.\n \"provenanceType\": 0.0,\ + \ # Optional. Used to record the provenance of an\n instance of an entity\ + \ or relationship.\n \"status\": \"str\", # Optional. The enum of relationship\ + \ status. Known values\n are: \"ACTIVE\", \"DELETED\".\n \"typeName\"\ + : \"str\", # Optional. The name of the type.\n \"updateTime\": 0.0, #\ + \ Optional. The update time of the record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the record.\n \"version\": 0.0 # Optional.\ + \ The version of the relationship.\n }\n\n # response body for status code(s):\ + \ 200\n response.json() == {\n \"attributes\": {\n \"str\":\ + \ {} # Optional. The attributes of the struct.\n },\n \"createTime\"\ + : 0.0, # Optional. The created time of the record.\n \"createdBy\": \"\ + str\", # Optional. The user who created the record.\n \"end1\": {\n \ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \"\ + typeName\": \"str\", # Optional. The name of the type.\n \"uniqueAttributes\"\ + : {\n \"str\": {} # Optional. The unique attributes of the object.\n\ + \ }\n },\n \"end2\": {\n \"guid\": \"str\", #\ + \ Optional. The GUID of the object.\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"uniqueAttributes\": {\n \"\ + str\": {} # Optional. The unique attributes of the object.\n }\n \ + \ },\n \"guid\": \"str\", # Optional. The GUID of the relationship.\n\ + \ \"homeId\": \"str\", # Optional. The home ID of the relationship.\n \ + \ \"label\": \"str\", # Optional. The label of the relationship.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n \ + \ \"provenanceType\": 0.0, # Optional. Used to record the provenance of\ + \ an\n instance of an entity or relationship.\n \"status\": \"str\"\ + , # Optional. The enum of relationship status. Known values\n are: \"\ + ACTIVE\", \"DELETED\".\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"updateTime\": 0.0, # Optional. The update time of the record.\n\ + \ \"updatedBy\": \"str\", # Optional. The user who updated the record.\n\ + \ \"version\": 0.0 # Optional. The version of the relationship.\n }\n\ + \ ````\n" diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.TypesOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.TypesOperations.yml new file mode 100644 index 00000000..239c3630 --- /dev/null +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.TypesOperations.yml @@ -0,0 +1,5787 @@ +### YamlMime:PythonClass +uid: azure.purview.catalog.aio.operations.TypesOperations +name: TypesOperations +fullName: azure.purview.catalog.aio.operations.TypesOperations +module: azure.purview.catalog.aio.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: TypesOperations(*args, **kwargs) +methods: +- uid: azure.purview.catalog.aio.operations.TypesOperations.create_type_definitions + name: create_type_definitions + summary: 'Create all atlas type definitions in bulk, only new definitions will be + created. + + Any changes to the existing definitions will be discarded.' + signature: 'async create_type_definitions(types_def: MutableMapping[str, Any], **kwargs: + Any) -> MutableMapping[str, Any]' + parameters: + - name: types_def + description: A composite wrapper object with corresponding lists of the type definition. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n types_def\ + \ = {\n \"businessMetadataDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"classificationDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + entityTypes\": [\n \"str\" # Optional. Specifying a list of\ + \ entityType\n names in the classificationDef, ensures that\ + \ classifications\n can\"nonly be applied to those entityTypes.\"\ + n\"n\"n.. raw:: html\"n\"n\n
    \"n
  • Any subtypes of\ + \ the entity types inherit the\n restriction
  • \"n
  • Any\ + \ classificationDef subtypes inherit the\n parents entityTypes\ + \ restrictions
  • \"n
  • Any classificationDef\n subtypes\ + \ can further restrict the parents entityTypes restrictions by\n \ + \ specifying a subset of the entityTypes
  • \"n
  • An empty\n \ + \ entityTypes list when there are no parent restrictions means\ + \ there\n are no restrictions
  • \"n
  • An empty entityTypes\ + \ list when there\n are parent restrictions means that the\ + \ subtype picks up the parents\n restrictions
  • \"n
  • If\ + \ a list of entityTypes are supplied,\n where one inherits\ + \ from another, this will be rejected. This should\n encourage\ + \ cleaner classificationsDefs
  • \"n
.\n ],\n \ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name\ + \ of the type definition.\n \"options\": {\n \"\ + str\": \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"subTypes\": [\n \"str\" #\ + \ Optional. An array of sub types.\n ],\n \"superTypes\"\ + : [\n \"str\" # Optional. An array of super types.\n \ + \ ],\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"entityDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"relationshipAttributeDefs\": [\n \ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isLegacyAttribute\"\ + : bool, # Optional.\n Determines if it is a legacy attribute.\n\ + \ \"isOptional\": bool, # Optional. Determines\n \ + \ if it is optional.\n \"isUnique\": bool,\ + \ # Optional. Determines if\n it unique.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"relationshipTypeName\": \"str\", # Optional.\n \ + \ The name of the relationship type.\n \"typeName\": \"\ + str\", # Optional. The name of\n the type.\n \ + \ \"valuesMaxCount\": 0, # Optional. The maximum\n \ + \ count of the values.\n \"valuesMinCount\"\ + : 0 # Optional. The minimum\n count of the values.\n\ + \ }\n ],\n \"serviceType\": \"str\"\ + , # Optional. The service type.\n \"subTypes\": [\n \ + \ \"str\" # Optional. An array of sub types.\n ],\n \ + \ \"superTypes\": [\n \"str\" # Optional. An array\ + \ of super types.\n ],\n \"typeVersion\": \"str\"\ + , # Optional. The version of the type.\n \"updateTime\": 0.0, \ + \ # Optional. The update time of the\n record.\n \ + \ \"updatedBy\": \"str\", # Optional. The user who updated the\n \ + \ record.\n \"version\": 0.0 # Optional. The version of the\ + \ record.\n }\n ],\n \"enumDefs\": [\n {\n \ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"defaultValue\": \"str\", # Optional.\ + \ The default value.\n \"description\": \"str\", # Optional. The\ + \ description of the\n type definition.\n \"elementDefs\"\ + : [\n {\n \"description\": \"str\", #\ + \ Optional. The\n description of the enum element definition.\n\ + \ \"ordinal\": 0.0, # Optional. The ordinal of\n \ + \ the enum element definition.\n \"value\"\ + : \"str\" # Optional. The value of the\n enum element\ + \ definition.\n }\n ],\n \"guid\"\ + : \"str\", # Optional. The GUID of the type definition.\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"name\": \"str\", # Optional. The name of the type definition.\n\ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options for the type\n definition.\n },\n\ + \ \"serviceType\": \"str\", # Optional. The service type.\n \ + \ \"typeVersion\": \"str\", # Optional. The version of the type.\n\ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the\n record.\n \"version\":\ + \ 0.0 # Optional. The version of the record.\n }\n ],\n \ + \ \"relationshipDefs\": [\n {\n \"attributeDefs\": [\n\ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isOptional\"\ + : bool, # Optional. Determines\n if it is optional.\n\ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", #\ + \ Optional. The name of the\n attribute.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options\n for the attribute.\n \ + \ },\n \"typeName\": \"str\", # Optional. The\ + \ name of\n the type.\n \"valuesMaxCount\"\ + : 0, # Optional. The maximum\n count of the values.\n\ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n \ + \ ],\n \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + endDef1\": {\n \"cardinality\": \"str\", # Optional. single-valued\n\ + \ attribute or multi-valued attribute. Known values are: \"\ + SINGLE\",\n \"LIST\", \"SET\".\n \"description\"\ + : \"str\", # Optional. The description of\n the relationship\ + \ end definition.\n \"isContainer\": bool, # Optional. Determines\ + \ if it is\n container.\n \"isLegacyAttribute\"\ + : bool, # Optional. Determines if\n it is a legacy attribute.\n\ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\"\ + \ # Optional. The type of the\n relationship end.\n \ + \ },\n \"endDef2\": {\n \"cardinality\"\ + : \"str\", # Optional. single-valued\n attribute or multi-valued\ + \ attribute. Known values are: \"SINGLE\",\n \"LIST\", \"\ + SET\".\n \"description\": \"str\", # Optional. The description\ + \ of\n the relationship end definition.\n \ + \ \"isContainer\": bool, # Optional. Determines if it is\n \ + \ container.\n \"isLegacyAttribute\": bool, # Optional.\ + \ Determines if\n it is a legacy attribute.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\" # Optional.\ + \ The type of the\n relationship end.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"name\": \"str\", # Optional. The\ + \ name of the type definition.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the type\n \ + \ definition.\n },\n \"relationshipCategory\"\ + : \"str\", # Optional. The Relationship\n category determines\ + \ the style of relationship around containment and\n lifecycle.\"\ + nUML terminology is used for the\n values.\"n\"n:code:`

`\"\ + nASSOCIATION is a relationship with no\n containment. :code:`
`\"\ + nCOMPOSITION and AGGREGATION are containment\n relationships.\"\ + n\"n:code:`

`\"nThe difference being in the lifecycles of\n \ + \ the container and its children. In the COMPOSITION case,\"nthe children\n \ + \ cannot exist without the container. For AGGREGATION, the life\ + \ cycles\"nof\n the container and children are totally independent.\ + \ Known values are:\n \"ASSOCIATION\", \"AGGREGATION\", \"COMPOSITION\"\ + .\n \"relationshipLabel\": \"str\", # Optional. The label of the\n\ + \ relationship.\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The\ + \ version of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the\n record.\n \"updatedBy\": \"str\"\ + , # Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n\ + \ ],\n \"structDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"termTemplateDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ]\n }\n\n # response body for status code(s): 200\n response.json()\ + \ == {\n \"businessMetadataDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"classificationDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + entityTypes\": [\n \"str\" # Optional. Specifying a list of\ + \ entityType\n names in the classificationDef, ensures that\ + \ classifications\n can\"nonly be applied to those entityTypes.\"\ + n\"n\"n.. raw:: html\"n\"n\n

    \"n
  • Any subtypes of\ + \ the entity types inherit the\n restriction
  • \"n
  • Any\ + \ classificationDef subtypes inherit the\n parents entityTypes\ + \ restrictions
  • \"n
  • Any classificationDef\n subtypes\ + \ can further restrict the parents entityTypes restrictions by\n \ + \ specifying a subset of the entityTypes
  • \"n
  • An empty\n \ + \ entityTypes list when there are no parent restrictions means\ + \ there\n are no restrictions
  • \"n
  • An empty entityTypes\ + \ list when there\n are parent restrictions means that the\ + \ subtype picks up the parents\n restrictions
  • \"n
  • If\ + \ a list of entityTypes are supplied,\n where one inherits\ + \ from another, this will be rejected. This should\n encourage\ + \ cleaner classificationsDefs
  • \"n
.\n ],\n \ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name\ + \ of the type definition.\n \"options\": {\n \"\ + str\": \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"subTypes\": [\n \"str\" #\ + \ Optional. An array of sub types.\n ],\n \"superTypes\"\ + : [\n \"str\" # Optional. An array of super types.\n \ + \ ],\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"entityDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"relationshipAttributeDefs\": [\n \ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isLegacyAttribute\"\ + : bool, # Optional.\n Determines if it is a legacy attribute.\n\ + \ \"isOptional\": bool, # Optional. Determines\n \ + \ if it is optional.\n \"isUnique\": bool,\ + \ # Optional. Determines if\n it unique.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"relationshipTypeName\": \"str\", # Optional.\n \ + \ The name of the relationship type.\n \"typeName\": \"\ + str\", # Optional. The name of\n the type.\n \ + \ \"valuesMaxCount\": 0, # Optional. The maximum\n \ + \ count of the values.\n \"valuesMinCount\"\ + : 0 # Optional. The minimum\n count of the values.\n\ + \ }\n ],\n \"serviceType\": \"str\"\ + , # Optional. The service type.\n \"subTypes\": [\n \ + \ \"str\" # Optional. An array of sub types.\n ],\n \ + \ \"superTypes\": [\n \"str\" # Optional. An array\ + \ of super types.\n ],\n \"typeVersion\": \"str\"\ + , # Optional. The version of the type.\n \"updateTime\": 0.0, \ + \ # Optional. The update time of the\n record.\n \ + \ \"updatedBy\": \"str\", # Optional. The user who updated the\n \ + \ record.\n \"version\": 0.0 # Optional. The version of the\ + \ record.\n }\n ],\n \"enumDefs\": [\n {\n \ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"defaultValue\": \"str\", # Optional.\ + \ The default value.\n \"description\": \"str\", # Optional. The\ + \ description of the\n type definition.\n \"elementDefs\"\ + : [\n {\n \"description\": \"str\", #\ + \ Optional. The\n description of the enum element definition.\n\ + \ \"ordinal\": 0.0, # Optional. The ordinal of\n \ + \ the enum element definition.\n \"value\"\ + : \"str\" # Optional. The value of the\n enum element\ + \ definition.\n }\n ],\n \"guid\"\ + : \"str\", # Optional. The GUID of the type definition.\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"name\": \"str\", # Optional. The name of the type definition.\n\ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options for the type\n definition.\n },\n\ + \ \"serviceType\": \"str\", # Optional. The service type.\n \ + \ \"typeVersion\": \"str\", # Optional. The version of the type.\n\ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the\n record.\n \"version\":\ + \ 0.0 # Optional. The version of the record.\n }\n ],\n \ + \ \"relationshipDefs\": [\n {\n \"attributeDefs\": [\n\ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isOptional\"\ + : bool, # Optional. Determines\n if it is optional.\n\ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", #\ + \ Optional. The name of the\n attribute.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options\n for the attribute.\n \ + \ },\n \"typeName\": \"str\", # Optional. The\ + \ name of\n the type.\n \"valuesMaxCount\"\ + : 0, # Optional. The maximum\n count of the values.\n\ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n \ + \ ],\n \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + endDef1\": {\n \"cardinality\": \"str\", # Optional. single-valued\n\ + \ attribute or multi-valued attribute. Known values are: \"\ + SINGLE\",\n \"LIST\", \"SET\".\n \"description\"\ + : \"str\", # Optional. The description of\n the relationship\ + \ end definition.\n \"isContainer\": bool, # Optional. Determines\ + \ if it is\n container.\n \"isLegacyAttribute\"\ + : bool, # Optional. Determines if\n it is a legacy attribute.\n\ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\"\ + \ # Optional. The type of the\n relationship end.\n \ + \ },\n \"endDef2\": {\n \"cardinality\"\ + : \"str\", # Optional. single-valued\n attribute or multi-valued\ + \ attribute. Known values are: \"SINGLE\",\n \"LIST\", \"\ + SET\".\n \"description\": \"str\", # Optional. The description\ + \ of\n the relationship end definition.\n \ + \ \"isContainer\": bool, # Optional. Determines if it is\n \ + \ container.\n \"isLegacyAttribute\": bool, # Optional.\ + \ Determines if\n it is a legacy attribute.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\" # Optional.\ + \ The type of the\n relationship end.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"name\": \"str\", # Optional. The\ + \ name of the type definition.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the type\n \ + \ definition.\n },\n \"relationshipCategory\"\ + : \"str\", # Optional. The Relationship\n category determines\ + \ the style of relationship around containment and\n lifecycle.\"\ + nUML terminology is used for the\n values.\"n\"n:code:`

`\"\ + nASSOCIATION is a relationship with no\n containment. :code:`
`\"\ + nCOMPOSITION and AGGREGATION are containment\n relationships.\"\ + n\"n:code:`

`\"nThe difference being in the lifecycles of\n \ + \ the container and its children. In the COMPOSITION case,\"nthe children\n \ + \ cannot exist without the container. For AGGREGATION, the life\ + \ cycles\"nof\n the container and children are totally independent.\ + \ Known values are:\n \"ASSOCIATION\", \"AGGREGATION\", \"COMPOSITION\"\ + .\n \"relationshipLabel\": \"str\", # Optional. The label of the\n\ + \ relationship.\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The\ + \ version of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the\n record.\n \"updatedBy\": \"str\"\ + , # Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n\ + \ ],\n \"structDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"termTemplateDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.TypesOperations.delete_type_by_name + name: delete_type_by_name + summary: Delete API for type identified by its name. + signature: 'async delete_type_by_name(name: str, **kwargs: Any) -> None' + parameters: + - name: name + description: The name of the type. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.purview.catalog.aio.operations.TypesOperations.delete_type_definitions + name: delete_type_definitions + summary: Delete API for all types in bulk. + signature: 'async delete_type_definitions(types_def: MutableMapping[str, Any], **kwargs: + Any) -> None' + parameters: + - name: types_def + description: A composite object that captures all types to be deleted. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n types_def\ + \ = {\n \"businessMetadataDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"classificationDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + entityTypes\": [\n \"str\" # Optional. Specifying a list of\ + \ entityType\n names in the classificationDef, ensures that\ + \ classifications\n can\"nonly be applied to those entityTypes.\"\ + n\"n\"n.. raw:: html\"n\"n\n

    \"n
  • Any subtypes of\ + \ the entity types inherit the\n restriction
  • \"n
  • Any\ + \ classificationDef subtypes inherit the\n parents entityTypes\ + \ restrictions
  • \"n
  • Any classificationDef\n subtypes\ + \ can further restrict the parents entityTypes restrictions by\n \ + \ specifying a subset of the entityTypes
  • \"n
  • An empty\n \ + \ entityTypes list when there are no parent restrictions means\ + \ there\n are no restrictions
  • \"n
  • An empty entityTypes\ + \ list when there\n are parent restrictions means that the\ + \ subtype picks up the parents\n restrictions
  • \"n
  • If\ + \ a list of entityTypes are supplied,\n where one inherits\ + \ from another, this will be rejected. This should\n encourage\ + \ cleaner classificationsDefs
  • \"n
.\n ],\n \ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name\ + \ of the type definition.\n \"options\": {\n \"\ + str\": \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"subTypes\": [\n \"str\" #\ + \ Optional. An array of sub types.\n ],\n \"superTypes\"\ + : [\n \"str\" # Optional. An array of super types.\n \ + \ ],\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"entityDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"relationshipAttributeDefs\": [\n \ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isLegacyAttribute\"\ + : bool, # Optional.\n Determines if it is a legacy attribute.\n\ + \ \"isOptional\": bool, # Optional. Determines\n \ + \ if it is optional.\n \"isUnique\": bool,\ + \ # Optional. Determines if\n it unique.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"relationshipTypeName\": \"str\", # Optional.\n \ + \ The name of the relationship type.\n \"typeName\": \"\ + str\", # Optional. The name of\n the type.\n \ + \ \"valuesMaxCount\": 0, # Optional. The maximum\n \ + \ count of the values.\n \"valuesMinCount\"\ + : 0 # Optional. The minimum\n count of the values.\n\ + \ }\n ],\n \"serviceType\": \"str\"\ + , # Optional. The service type.\n \"subTypes\": [\n \ + \ \"str\" # Optional. An array of sub types.\n ],\n \ + \ \"superTypes\": [\n \"str\" # Optional. An array\ + \ of super types.\n ],\n \"typeVersion\": \"str\"\ + , # Optional. The version of the type.\n \"updateTime\": 0.0, \ + \ # Optional. The update time of the\n record.\n \ + \ \"updatedBy\": \"str\", # Optional. The user who updated the\n \ + \ record.\n \"version\": 0.0 # Optional. The version of the\ + \ record.\n }\n ],\n \"enumDefs\": [\n {\n \ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"defaultValue\": \"str\", # Optional.\ + \ The default value.\n \"description\": \"str\", # Optional. The\ + \ description of the\n type definition.\n \"elementDefs\"\ + : [\n {\n \"description\": \"str\", #\ + \ Optional. The\n description of the enum element definition.\n\ + \ \"ordinal\": 0.0, # Optional. The ordinal of\n \ + \ the enum element definition.\n \"value\"\ + : \"str\" # Optional. The value of the\n enum element\ + \ definition.\n }\n ],\n \"guid\"\ + : \"str\", # Optional. The GUID of the type definition.\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"name\": \"str\", # Optional. The name of the type definition.\n\ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options for the type\n definition.\n },\n\ + \ \"serviceType\": \"str\", # Optional. The service type.\n \ + \ \"typeVersion\": \"str\", # Optional. The version of the type.\n\ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the\n record.\n \"version\":\ + \ 0.0 # Optional. The version of the record.\n }\n ],\n \ + \ \"relationshipDefs\": [\n {\n \"attributeDefs\": [\n\ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isOptional\"\ + : bool, # Optional. Determines\n if it is optional.\n\ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", #\ + \ Optional. The name of the\n attribute.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options\n for the attribute.\n \ + \ },\n \"typeName\": \"str\", # Optional. The\ + \ name of\n the type.\n \"valuesMaxCount\"\ + : 0, # Optional. The maximum\n count of the values.\n\ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n \ + \ ],\n \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + endDef1\": {\n \"cardinality\": \"str\", # Optional. single-valued\n\ + \ attribute or multi-valued attribute. Known values are: \"\ + SINGLE\",\n \"LIST\", \"SET\".\n \"description\"\ + : \"str\", # Optional. The description of\n the relationship\ + \ end definition.\n \"isContainer\": bool, # Optional. Determines\ + \ if it is\n container.\n \"isLegacyAttribute\"\ + : bool, # Optional. Determines if\n it is a legacy attribute.\n\ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\"\ + \ # Optional. The type of the\n relationship end.\n \ + \ },\n \"endDef2\": {\n \"cardinality\"\ + : \"str\", # Optional. single-valued\n attribute or multi-valued\ + \ attribute. Known values are: \"SINGLE\",\n \"LIST\", \"\ + SET\".\n \"description\": \"str\", # Optional. The description\ + \ of\n the relationship end definition.\n \ + \ \"isContainer\": bool, # Optional. Determines if it is\n \ + \ container.\n \"isLegacyAttribute\": bool, # Optional.\ + \ Determines if\n it is a legacy attribute.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\" # Optional.\ + \ The type of the\n relationship end.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"name\": \"str\", # Optional. The\ + \ name of the type definition.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the type\n \ + \ definition.\n },\n \"relationshipCategory\"\ + : \"str\", # Optional. The Relationship\n category determines\ + \ the style of relationship around containment and\n lifecycle.\"\ + nUML terminology is used for the\n values.\"n\"n:code:`

`\"\ + nASSOCIATION is a relationship with no\n containment. :code:`
`\"\ + nCOMPOSITION and AGGREGATION are containment\n relationships.\"\ + n\"n:code:`

`\"nThe difference being in the lifecycles of\n \ + \ the container and its children. In the COMPOSITION case,\"nthe children\n \ + \ cannot exist without the container. For AGGREGATION, the life\ + \ cycles\"nof\n the container and children are totally independent.\ + \ Known values are:\n \"ASSOCIATION\", \"AGGREGATION\", \"COMPOSITION\"\ + .\n \"relationshipLabel\": \"str\", # Optional. The label of the\n\ + \ relationship.\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The\ + \ version of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the\n record.\n \"updatedBy\": \"str\"\ + , # Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n\ + \ ],\n \"structDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"termTemplateDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.TypesOperations.get_all_type_definitions + name: get_all_type_definitions + summary: Get all type definitions in Atlas in bulk. + signature: 'async get_all_type_definitions(*, include_term_template: bool | None + = False, type: str | None = None, **kwargs: Any) -> MutableMapping[str, Any]' + keywordOnlyParameters: + - name: include_term_template + description: 'Whether include termtemplatedef when return all typedefs. + + This is always true when search filter type=term_template. Default value is + False.' + types: + - + - name: type + description: 'Typedef name as search filter when get typedefs. Known values are: + "enum", + + "entity", "classification", "relationship", "struct", and "term_template". Default + value is + + None.' + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + businessMetadataDefs\": [\n {\n \"attributeDefs\": [\n\ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isOptional\"\ + : bool, # Optional. Determines\n if it is optional.\n\ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", #\ + \ Optional. The name of the\n attribute.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options\n for the attribute.\n \ + \ },\n \"typeName\": \"str\", # Optional. The\ + \ name of\n the type.\n \"valuesMaxCount\"\ + : 0, # Optional. The maximum\n count of the values.\n\ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n \ + \ ],\n \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"classificationDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + entityTypes\": [\n \"str\" # Optional. Specifying a list of\ + \ entityType\n names in the classificationDef, ensures that\ + \ classifications\n can\"nonly be applied to those entityTypes.\"\ + n\"n\"n.. raw:: html\"n\"n\n

    \"n
  • Any subtypes of\ + \ the entity types inherit the\n restriction
  • \"n
  • Any\ + \ classificationDef subtypes inherit the\n parents entityTypes\ + \ restrictions
  • \"n
  • Any classificationDef\n subtypes\ + \ can further restrict the parents entityTypes restrictions by\n \ + \ specifying a subset of the entityTypes
  • \"n
  • An empty\n \ + \ entityTypes list when there are no parent restrictions means\ + \ there\n are no restrictions
  • \"n
  • An empty entityTypes\ + \ list when there\n are parent restrictions means that the\ + \ subtype picks up the parents\n restrictions
  • \"n
  • If\ + \ a list of entityTypes are supplied,\n where one inherits\ + \ from another, this will be rejected. This should\n encourage\ + \ cleaner classificationsDefs
  • \"n
.\n ],\n \ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name\ + \ of the type definition.\n \"options\": {\n \"\ + str\": \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"subTypes\": [\n \"str\" #\ + \ Optional. An array of sub types.\n ],\n \"superTypes\"\ + : [\n \"str\" # Optional. An array of super types.\n \ + \ ],\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"entityDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"relationshipAttributeDefs\": [\n \ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isLegacyAttribute\"\ + : bool, # Optional.\n Determines if it is a legacy attribute.\n\ + \ \"isOptional\": bool, # Optional. Determines\n \ + \ if it is optional.\n \"isUnique\": bool,\ + \ # Optional. Determines if\n it unique.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"relationshipTypeName\": \"str\", # Optional.\n \ + \ The name of the relationship type.\n \"typeName\": \"\ + str\", # Optional. The name of\n the type.\n \ + \ \"valuesMaxCount\": 0, # Optional. The maximum\n \ + \ count of the values.\n \"valuesMinCount\"\ + : 0 # Optional. The minimum\n count of the values.\n\ + \ }\n ],\n \"serviceType\": \"str\"\ + , # Optional. The service type.\n \"subTypes\": [\n \ + \ \"str\" # Optional. An array of sub types.\n ],\n \ + \ \"superTypes\": [\n \"str\" # Optional. An array\ + \ of super types.\n ],\n \"typeVersion\": \"str\"\ + , # Optional. The version of the type.\n \"updateTime\": 0.0, \ + \ # Optional. The update time of the\n record.\n \ + \ \"updatedBy\": \"str\", # Optional. The user who updated the\n \ + \ record.\n \"version\": 0.0 # Optional. The version of the\ + \ record.\n }\n ],\n \"enumDefs\": [\n {\n \ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"defaultValue\": \"str\", # Optional.\ + \ The default value.\n \"description\": \"str\", # Optional. The\ + \ description of the\n type definition.\n \"elementDefs\"\ + : [\n {\n \"description\": \"str\", #\ + \ Optional. The\n description of the enum element definition.\n\ + \ \"ordinal\": 0.0, # Optional. The ordinal of\n \ + \ the enum element definition.\n \"value\"\ + : \"str\" # Optional. The value of the\n enum element\ + \ definition.\n }\n ],\n \"guid\"\ + : \"str\", # Optional. The GUID of the type definition.\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"name\": \"str\", # Optional. The name of the type definition.\n\ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options for the type\n definition.\n },\n\ + \ \"serviceType\": \"str\", # Optional. The service type.\n \ + \ \"typeVersion\": \"str\", # Optional. The version of the type.\n\ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the\n record.\n \"version\":\ + \ 0.0 # Optional. The version of the record.\n }\n ],\n \ + \ \"relationshipDefs\": [\n {\n \"attributeDefs\": [\n\ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isOptional\"\ + : bool, # Optional. Determines\n if it is optional.\n\ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", #\ + \ Optional. The name of the\n attribute.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options\n for the attribute.\n \ + \ },\n \"typeName\": \"str\", # Optional. The\ + \ name of\n the type.\n \"valuesMaxCount\"\ + : 0, # Optional. The maximum\n count of the values.\n\ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n \ + \ ],\n \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + endDef1\": {\n \"cardinality\": \"str\", # Optional. single-valued\n\ + \ attribute or multi-valued attribute. Known values are: \"\ + SINGLE\",\n \"LIST\", \"SET\".\n \"description\"\ + : \"str\", # Optional. The description of\n the relationship\ + \ end definition.\n \"isContainer\": bool, # Optional. Determines\ + \ if it is\n container.\n \"isLegacyAttribute\"\ + : bool, # Optional. Determines if\n it is a legacy attribute.\n\ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\"\ + \ # Optional. The type of the\n relationship end.\n \ + \ },\n \"endDef2\": {\n \"cardinality\"\ + : \"str\", # Optional. single-valued\n attribute or multi-valued\ + \ attribute. Known values are: \"SINGLE\",\n \"LIST\", \"\ + SET\".\n \"description\": \"str\", # Optional. The description\ + \ of\n the relationship end definition.\n \ + \ \"isContainer\": bool, # Optional. Determines if it is\n \ + \ container.\n \"isLegacyAttribute\": bool, # Optional.\ + \ Determines if\n it is a legacy attribute.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\" # Optional.\ + \ The type of the\n relationship end.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"name\": \"str\", # Optional. The\ + \ name of the type definition.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the type\n \ + \ definition.\n },\n \"relationshipCategory\"\ + : \"str\", # Optional. The Relationship\n category determines\ + \ the style of relationship around containment and\n lifecycle.\"\ + nUML terminology is used for the\n values.\"n\"n:code:`

`\"\ + nASSOCIATION is a relationship with no\n containment. :code:`
`\"\ + nCOMPOSITION and AGGREGATION are containment\n relationships.\"\ + n\"n:code:`

`\"nThe difference being in the lifecycles of\n \ + \ the container and its children. In the COMPOSITION case,\"nthe children\n \ + \ cannot exist without the container. For AGGREGATION, the life\ + \ cycles\"nof\n the container and children are totally independent.\ + \ Known values are:\n \"ASSOCIATION\", \"AGGREGATION\", \"COMPOSITION\"\ + .\n \"relationshipLabel\": \"str\", # Optional. The label of the\n\ + \ relationship.\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The\ + \ version of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the\n record.\n \"updatedBy\": \"str\"\ + , # Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n\ + \ ],\n \"structDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"termTemplateDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ]\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.TypesOperations.get_business_metadata_def_by_guid + name: get_business_metadata_def_by_guid + summary: Get the businessMetadata definition for the given guid. + signature: 'async get_business_metadata_def_by_guid(guid: str, **kwargs: Any) -> + MutableMapping[str, Any]' + parameters: + - name: guid + description: businessMetadata guid. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time of the\ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who updated the\ + \ record.\n \"version\": 0.0 # Optional. The version of the record.\n \ + \ }\n ````\n" +- uid: azure.purview.catalog.aio.operations.TypesOperations.get_business_metadata_def_by_name + name: get_business_metadata_def_by_name + summary: Get the businessMetadata definition by it's name (unique). + signature: 'async get_business_metadata_def_by_name(name: str, **kwargs: Any) -> + MutableMapping[str, Any]' + parameters: + - name: name + description: businessMetadata name. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time of the\ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who updated the\ + \ record.\n \"version\": 0.0 # Optional. The version of the record.\n \ + \ }\n ````\n" +- uid: azure.purview.catalog.aio.operations.TypesOperations.get_classification_def_by_guid + name: get_classification_def_by_guid + summary: Get the classification definition for the given GUID. + signature: 'async get_classification_def_by_guid(guid: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: guid + description: The globally unique identifier of the classification. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"entityTypes\": [\n \"str\" # Optional. Specifying a list\ + \ of entityType names in the\n classificationDef, ensures that classifications\ + \ can\"nonly be applied to those\n entityTypes.\"n\"n\"n.. raw:: html\"\ + n\"n

    \"n
  • Any subtypes of the entity\n types inherit the\ + \ restriction
  • \"n
  • Any classificationDef subtypes\n inherit\ + \ the parents entityTypes restrictions
  • \"n
  • Any\n classificationDef\ + \ subtypes can further restrict the parents entityTypes\n restrictions\ + \ by specifying a subset of the entityTypes
  • \"n
  • An empty\n \ + \ entityTypes list when there are no parent restrictions means there are no\n\ + \ restrictions
  • \"n
  • An empty entityTypes list when there\ + \ are parent\n restrictions means that the subtype picks up the parents\ + \ restrictions
  • \"n\n
  • If a list of entityTypes are supplied,\ + \ where one inherits from another,\n this will be rejected. This should\ + \ encourage cleaner\n classificationsDefs
  • \"n
.\n \ + \ ],\n \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"subTypes\": [\n \"str\" # Optional. An\ + \ array of sub types.\n ],\n \"superTypes\": [\n \"str\"\ + \ # Optional. An array of super types.\n ],\n \"typeVersion\": \"\ + str\", # Optional. The version of the type.\n \"updateTime\": 0.0, # Optional.\ + \ The update time of the record.\n \"updatedBy\": \"str\", # Optional.\ + \ The user who updated the record.\n \"version\": 0.0 # Optional. The version\ + \ of the record.\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.TypesOperations.get_classification_def_by_name + name: get_classification_def_by_name + summary: Get the classification definition by its name (unique). + signature: 'async get_classification_def_by_name(name: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: name + description: The name of the classification. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"entityTypes\": [\n \"str\" # Optional. Specifying a list\ + \ of entityType names in the\n classificationDef, ensures that classifications\ + \ can\"nonly be applied to those\n entityTypes.\"n\"n\"n.. raw:: html\"\ + n\"n
    \"n
  • Any subtypes of the entity\n types inherit the\ + \ restriction
  • \"n
  • Any classificationDef subtypes\n inherit\ + \ the parents entityTypes restrictions
  • \"n
  • Any\n classificationDef\ + \ subtypes can further restrict the parents entityTypes\n restrictions\ + \ by specifying a subset of the entityTypes
  • \"n
  • An empty\n \ + \ entityTypes list when there are no parent restrictions means there are no\n\ + \ restrictions
  • \"n
  • An empty entityTypes list when there\ + \ are parent\n restrictions means that the subtype picks up the parents\ + \ restrictions
  • \"n\n
  • If a list of entityTypes are supplied,\ + \ where one inherits from another,\n this will be rejected. This should\ + \ encourage cleaner\n classificationsDefs
  • \"n
.\n \ + \ ],\n \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"subTypes\": [\n \"str\" # Optional. An\ + \ array of sub types.\n ],\n \"superTypes\": [\n \"str\"\ + \ # Optional. An array of super types.\n ],\n \"typeVersion\": \"\ + str\", # Optional. The version of the type.\n \"updateTime\": 0.0, # Optional.\ + \ The update time of the record.\n \"updatedBy\": \"str\", # Optional.\ + \ The user who updated the record.\n \"version\": 0.0 # Optional. The version\ + \ of the record.\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.TypesOperations.get_entity_definition_by_guid + name: get_entity_definition_by_guid + summary: Get the Entity definition for the given GUID. + signature: 'async get_entity_definition_by_guid(guid: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"relationshipAttributeDefs\": [\n \ + \ {\n \"cardinality\": \"str\", # Optional. single-valued\ + \ attribute or\n multi-valued attribute. Known values are: \"\ + SINGLE\", \"LIST\", \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \"\ + str\": {} # Optional. The parameters\n of the constraint\ + \ definition.\n },\n \"type\": \"\ + str\" # Optional. The type of the\n constraint.\n \ + \ }\n ],\n \"defaultValue\": \"str\"\ + , # Optional. The default value of the\n attribute.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ attribute.\n \"includeInNotification\": bool, # Optional.\ + \ Determines if it\n is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isLegacyAttribute\": bool, # Optional. Determines\ + \ if it is a\n legacy attribute.\n \"isOptional\"\ + : bool, # Optional. Determines if it is\n optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if it unique.\n \ + \ \"name\": \"str\", # Optional. The name of the attribute.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options\ + \ for the\n attribute.\n },\n \ + \ \"relationshipTypeName\": \"str\", # Optional. The name of the\n \ + \ relationship type.\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"valuesMaxCount\": 0, # Optional. The\ + \ maximum count of the\n values.\n \"valuesMinCount\"\ + : 0 # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"serviceType\": \"str\", # Optional. The service type.\n\ + \ \"subTypes\": [\n \"str\" # Optional. An array of sub types.\n\ + \ ],\n \"superTypes\": [\n \"str\" # Optional. An array\ + \ of super types.\n ],\n \"typeVersion\": \"str\", # Optional. The\ + \ version of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the record.\n \"updatedBy\": \"str\", # Optional. The user who updated\ + \ the record.\n \"version\": 0.0 # Optional. The version of the record.\n\ + \ }\n ````\n" +- uid: azure.purview.catalog.aio.operations.TypesOperations.get_entity_definition_by_name + name: get_entity_definition_by_name + summary: Get the entity definition by its name (unique). + signature: 'async get_entity_definition_by_name(name: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: name + description: The name of the entity. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"relationshipAttributeDefs\": [\n \ + \ {\n \"cardinality\": \"str\", # Optional. single-valued\ + \ attribute or\n multi-valued attribute. Known values are: \"\ + SINGLE\", \"LIST\", \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \"\ + str\": {} # Optional. The parameters\n of the constraint\ + \ definition.\n },\n \"type\": \"\ + str\" # Optional. The type of the\n constraint.\n \ + \ }\n ],\n \"defaultValue\": \"str\"\ + , # Optional. The default value of the\n attribute.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ attribute.\n \"includeInNotification\": bool, # Optional.\ + \ Determines if it\n is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isLegacyAttribute\": bool, # Optional. Determines\ + \ if it is a\n legacy attribute.\n \"isOptional\"\ + : bool, # Optional. Determines if it is\n optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if it unique.\n \ + \ \"name\": \"str\", # Optional. The name of the attribute.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options\ + \ for the\n attribute.\n },\n \ + \ \"relationshipTypeName\": \"str\", # Optional. The name of the\n \ + \ relationship type.\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"valuesMaxCount\": 0, # Optional. The\ + \ maximum count of the\n values.\n \"valuesMinCount\"\ + : 0 # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"serviceType\": \"str\", # Optional. The service type.\n\ + \ \"subTypes\": [\n \"str\" # Optional. An array of sub types.\n\ + \ ],\n \"superTypes\": [\n \"str\" # Optional. An array\ + \ of super types.\n ],\n \"typeVersion\": \"str\", # Optional. The\ + \ version of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the record.\n \"updatedBy\": \"str\", # Optional. The user who updated\ + \ the record.\n \"version\": 0.0 # Optional. The version of the record.\n\ + \ }\n ````\n" +- uid: azure.purview.catalog.aio.operations.TypesOperations.get_enum_def_by_guid + name: get_enum_def_by_guid + summary: Get the enum definition for the given GUID. + signature: 'async get_enum_def_by_guid(guid: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: guid + description: The globally unique identifier of the enum. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + category\": \"str\", # Optional. The enum of type category. Known values are:\n\ + \ \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"STRUCT\", \"CLASSIFICATION\"\ + , \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\", \"TERM_TEMPLATE\"\ + .\n \"createTime\": 0.0, # Optional. The created time of the record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the record.\n\ + \ \"dateFormatter\": {\n \"availableLocales\": [\n \ + \ \"str\" # Optional. An array of available locales.\n ],\n \ + \ \"calendar\": 0.0, # Optional. The date format.\n \"dateInstance\"\ + : ...,\n \"dateTimeInstance\": ...,\n \"instance\": ...,\n\ + \ \"lenient\": bool, # Optional. Determines the leniency of the date\n\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional. The currency.\n \ + \ \"currencyInstance\": ...,\n \"groupingUsed\": bool,\ + \ # Optional. Determines if grouping is\n used.\n \ + \ \"instance\": ...,\n \"integerInstance\": ...,\n \ + \ \"maximumFractionDigits\": 0, # Optional. The maximum of\n \ + \ fraction digits.\n \"maximumIntegerDigits\": 0, # Optional.\ + \ The maximum of\n integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The minimum of\n fraction digits.\n \ + \ \"minimumIntegerDigits\": 0, # Optional. The minimum of\n \ + \ integer digits.\n \"numberInstance\": ...,\n \ + \ \"parseIntegerOnly\": bool, # Optional. Determines if only\n \ + \ integer is parsed.\n \"percentInstance\": ...,\n \ + \ \"roundingMode\": \"str\" # Optional. The enum of rounding mode.\n \ + \ Known values are: \"UP\", \"DOWN\", \"CEILING\", \"FLOOR\", \"\ + HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n\ + \ },\n \"timeInstance\": ...,\n \"timeZone\": {\n\ + \ \"availableIds\": [\n \"str\" # Optional. An\ + \ array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"defaultValue\": \"str\", # Optional. The default value.\n \"description\"\ + : \"str\", # Optional. The description of the type definition.\n \"elementDefs\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n enum element definition.\n \"ordinal\"\ + : 0.0, # Optional. The ordinal of the enum element\n definition.\n\ + \ \"value\": \"str\" # Optional. The value of the enum element\n\ + \ definition.\n }\n ],\n \"guid\": \"str\"\ + , # Optional. The GUID of the type definition.\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag for concurrency control.\n \"name\": \"str\", \ + \ # Optional. The name of the type definition.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the type definition.\n \ + \ },\n \"serviceType\": \"str\", # Optional. The service type.\n \ + \ \"typeVersion\": \"str\", # Optional. The version of the type.\n \"\ + updateTime\": 0.0, # Optional. The update time of the record.\n \"updatedBy\"\ + : \"str\", # Optional. The user who updated the record.\n \"version\":\ + \ 0.0 # Optional. The version of the record.\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.TypesOperations.get_enum_def_by_name + name: get_enum_def_by_name + summary: Get the enum definition by its name (unique). + signature: 'async get_enum_def_by_name(name: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: name + description: The name of the enum. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + category\": \"str\", # Optional. The enum of type category. Known values are:\n\ + \ \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"STRUCT\", \"CLASSIFICATION\"\ + , \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\", \"TERM_TEMPLATE\"\ + .\n \"createTime\": 0.0, # Optional. The created time of the record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the record.\n\ + \ \"dateFormatter\": {\n \"availableLocales\": [\n \ + \ \"str\" # Optional. An array of available locales.\n ],\n \ + \ \"calendar\": 0.0, # Optional. The date format.\n \"dateInstance\"\ + : ...,\n \"dateTimeInstance\": ...,\n \"instance\": ...,\n\ + \ \"lenient\": bool, # Optional. Determines the leniency of the date\n\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional. The currency.\n \ + \ \"currencyInstance\": ...,\n \"groupingUsed\": bool,\ + \ # Optional. Determines if grouping is\n used.\n \ + \ \"instance\": ...,\n \"integerInstance\": ...,\n \ + \ \"maximumFractionDigits\": 0, # Optional. The maximum of\n \ + \ fraction digits.\n \"maximumIntegerDigits\": 0, # Optional.\ + \ The maximum of\n integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The minimum of\n fraction digits.\n \ + \ \"minimumIntegerDigits\": 0, # Optional. The minimum of\n \ + \ integer digits.\n \"numberInstance\": ...,\n \ + \ \"parseIntegerOnly\": bool, # Optional. Determines if only\n \ + \ integer is parsed.\n \"percentInstance\": ...,\n \ + \ \"roundingMode\": \"str\" # Optional. The enum of rounding mode.\n \ + \ Known values are: \"UP\", \"DOWN\", \"CEILING\", \"FLOOR\", \"\ + HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n\ + \ },\n \"timeInstance\": ...,\n \"timeZone\": {\n\ + \ \"availableIds\": [\n \"str\" # Optional. An\ + \ array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"defaultValue\": \"str\", # Optional. The default value.\n \"description\"\ + : \"str\", # Optional. The description of the type definition.\n \"elementDefs\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n enum element definition.\n \"ordinal\"\ + : 0.0, # Optional. The ordinal of the enum element\n definition.\n\ + \ \"value\": \"str\" # Optional. The value of the enum element\n\ + \ definition.\n }\n ],\n \"guid\": \"str\"\ + , # Optional. The GUID of the type definition.\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag for concurrency control.\n \"name\": \"str\", \ + \ # Optional. The name of the type definition.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the type definition.\n \ + \ },\n \"serviceType\": \"str\", # Optional. The service type.\n \ + \ \"typeVersion\": \"str\", # Optional. The version of the type.\n \"\ + updateTime\": 0.0, # Optional. The update time of the record.\n \"updatedBy\"\ + : \"str\", # Optional. The user who updated the record.\n \"version\":\ + \ 0.0 # Optional. The version of the record.\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.TypesOperations.get_relationship_def_by_guid + name: get_relationship_def_by_guid + summary: Get the relationship definition for the given GUID. + signature: 'async get_relationship_def_by_guid(guid: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: guid + description: The globally unique identifier of the relationship. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"endDef1\": {\n \"cardinality\": \"str\", # Optional. single-valued\ + \ attribute or\n multi-valued attribute. Known values are: \"SINGLE\"\ + , \"LIST\", \"SET\".\n \"description\": \"str\", # Optional. The description\ + \ of the\n relationship end definition.\n \"isContainer\"\ + : bool, # Optional. Determines if it is container.\n \"isLegacyAttribute\"\ + : bool, # Optional. Determines if it is a legacy\n attribute.\n \ + \ \"name\": \"str\", # Optional. The name of the relationship end\n\ + \ definition.\n \"type\": \"str\" # Optional. The type\ + \ of the relationship end.\n },\n \"endDef2\": {\n \"cardinality\"\ + : \"str\", # Optional. single-valued attribute or\n multi-valued\ + \ attribute. Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"description\"\ + : \"str\", # Optional. The description of the\n relationship end\ + \ definition.\n \"isContainer\": bool, # Optional. Determines if it\ + \ is container.\n \"isLegacyAttribute\": bool, # Optional. Determines\ + \ if it is a legacy\n attribute.\n \"name\": \"str\", #\ + \ Optional. The name of the relationship end\n definition.\n \ + \ \"type\": \"str\" # Optional. The type of the relationship end.\n \ + \ },\n \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"relationshipCategory\": \"str\", \ + \ # Optional. The Relationship category\n determines the style of relationship\ + \ around containment and lifecycle.\"nUML\n terminology is used for the\ + \ values.\"n\"n:code:`

`\"nASSOCIATION is a relationship\n with no containment.\ + \ :code:`
`\"nCOMPOSITION and AGGREGATION are containment\n relationships.\"\ + n\"n:code:`

`\"nThe difference being in the lifecycles of the\n container\ + \ and its children. In the COMPOSITION case,\"nthe children cannot exist\n \ + \ without the container. For AGGREGATION, the life cycles\"nof the container\ + \ and\n children are totally independent. Known values are: \"ASSOCIATION\"\ + , \"AGGREGATION\",\n \"COMPOSITION\".\n \"relationshipLabel\": \"\ + str\", # Optional. The label of the relationship.\n \"serviceType\": \"\ + str\", # Optional. The service type.\n \"typeVersion\": \"str\", # Optional.\ + \ The version of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the record.\n \"version\": 0.0 # Optional. The version of the\ + \ record.\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.TypesOperations.get_relationship_def_by_name + name: get_relationship_def_by_name + summary: Get the relationship definition by its name (unique). + signature: 'async get_relationship_def_by_name(name: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: name + description: The name of the relationship. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"endDef1\": {\n \"cardinality\": \"str\", # Optional. single-valued\ + \ attribute or\n multi-valued attribute. Known values are: \"SINGLE\"\ + , \"LIST\", \"SET\".\n \"description\": \"str\", # Optional. The description\ + \ of the\n relationship end definition.\n \"isContainer\"\ + : bool, # Optional. Determines if it is container.\n \"isLegacyAttribute\"\ + : bool, # Optional. Determines if it is a legacy\n attribute.\n \ + \ \"name\": \"str\", # Optional. The name of the relationship end\n\ + \ definition.\n \"type\": \"str\" # Optional. The type\ + \ of the relationship end.\n },\n \"endDef2\": {\n \"cardinality\"\ + : \"str\", # Optional. single-valued attribute or\n multi-valued\ + \ attribute. Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"description\"\ + : \"str\", # Optional. The description of the\n relationship end\ + \ definition.\n \"isContainer\": bool, # Optional. Determines if it\ + \ is container.\n \"isLegacyAttribute\": bool, # Optional. Determines\ + \ if it is a legacy\n attribute.\n \"name\": \"str\", #\ + \ Optional. The name of the relationship end\n definition.\n \ + \ \"type\": \"str\" # Optional. The type of the relationship end.\n \ + \ },\n \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"relationshipCategory\": \"str\", \ + \ # Optional. The Relationship category\n determines the style of relationship\ + \ around containment and lifecycle.\"nUML\n terminology is used for the\ + \ values.\"n\"n:code:`

`\"nASSOCIATION is a relationship\n with no containment.\ + \ :code:`
`\"nCOMPOSITION and AGGREGATION are containment\n relationships.\"\ + n\"n:code:`

`\"nThe difference being in the lifecycles of the\n container\ + \ and its children. In the COMPOSITION case,\"nthe children cannot exist\n \ + \ without the container. For AGGREGATION, the life cycles\"nof the container\ + \ and\n children are totally independent. Known values are: \"ASSOCIATION\"\ + , \"AGGREGATION\",\n \"COMPOSITION\".\n \"relationshipLabel\": \"\ + str\", # Optional. The label of the relationship.\n \"serviceType\": \"\ + str\", # Optional. The service type.\n \"typeVersion\": \"str\", # Optional.\ + \ The version of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the record.\n \"version\": 0.0 # Optional. The version of the\ + \ record.\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.TypesOperations.get_struct_def_by_guid + name: get_struct_def_by_guid + summary: Get the struct definition for the given GUID. + signature: 'async get_struct_def_by_guid(guid: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: guid + description: The globally unique identifier of the struct. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time of the\ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who updated the\ + \ record.\n \"version\": 0.0 # Optional. The version of the record.\n \ + \ }\n ````\n" +- uid: azure.purview.catalog.aio.operations.TypesOperations.get_struct_def_by_name + name: get_struct_def_by_name + summary: Get the struct definition by its name (unique). + signature: 'async get_struct_def_by_name(name: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: name + description: The name of the struct. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time of the\ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who updated the\ + \ record.\n \"version\": 0.0 # Optional. The version of the record.\n \ + \ }\n ````\n" +- uid: azure.purview.catalog.aio.operations.TypesOperations.get_term_template_def_by_guid + name: get_term_template_def_by_guid + summary: Get the term template definition for the given GUID. + signature: 'async get_term_template_def_by_guid(guid: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: guid + description: The globally unique identifier of the term template. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time of the\ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who updated the\ + \ record.\n \"version\": 0.0 # Optional. The version of the record.\n \ + \ }\n ````\n" +- uid: azure.purview.catalog.aio.operations.TypesOperations.get_term_template_def_by_name + name: get_term_template_def_by_name + summary: Get the term template definition by its name (unique). + signature: 'async get_term_template_def_by_name(name: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: name + description: The name of the term template. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time of the\ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who updated the\ + \ record.\n \"version\": 0.0 # Optional. The version of the record.\n \ + \ }\n ````\n" +- uid: azure.purview.catalog.aio.operations.TypesOperations.get_type_definition_by_guid + name: get_type_definition_by_guid + summary: Get the type definition for the given GUID. + signature: 'async get_type_definition_by_guid(guid: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: guid + description: The globally unique identifier of the type. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"defaultValue\": \"str\", # Optional. The default value.\n \"description\"\ + : \"str\", # Optional. The description of the type definition.\n \"elementDefs\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n enum element definition.\n \"ordinal\"\ + : 0.0, # Optional. The ordinal of the enum element\n definition.\n\ + \ \"value\": \"str\" # Optional. The value of the enum element\n\ + \ definition.\n }\n ],\n \"endDef1\": {\n\ + \ \"cardinality\": \"str\", # Optional. single-valued attribute or\n\ + \ multi-valued attribute. Known values are: \"SINGLE\", \"LIST\",\ + \ \"SET\".\n \"description\": \"str\", # Optional. The description\ + \ of the\n relationship end definition.\n \"isContainer\"\ + : bool, # Optional. Determines if it is container.\n \"isLegacyAttribute\"\ + : bool, # Optional. Determines if it is a legacy\n attribute.\n \ + \ \"name\": \"str\", # Optional. The name of the relationship end\n\ + \ definition.\n \"type\": \"str\" # Optional. The type\ + \ of the relationship end.\n },\n \"endDef2\": {\n \"cardinality\"\ + : \"str\", # Optional. single-valued attribute or\n multi-valued\ + \ attribute. Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"description\"\ + : \"str\", # Optional. The description of the\n relationship end\ + \ definition.\n \"isContainer\": bool, # Optional. Determines if it\ + \ is container.\n \"isLegacyAttribute\": bool, # Optional. Determines\ + \ if it is a legacy\n attribute.\n \"name\": \"str\", #\ + \ Optional. The name of the relationship end\n definition.\n \ + \ \"type\": \"str\" # Optional. The type of the relationship end.\n \ + \ },\n \"entityTypes\": [\n \"str\" # Optional. Specifying\ + \ a list of entityType names in the\n classificationDef, ensures that\ + \ classifications can\"nonly be applied to those\n entityTypes.\"\ + n\"n\"n.. raw:: html\"n\"n

    \"n
  • Any subtypes of the entity\n \ + \ types inherit the restriction
  • \"n
  • Any classificationDef subtypes\n\ + \ inherit the parents entityTypes restrictions
  • \"n
  • Any\n\ + \ classificationDef subtypes can further restrict the parents entityTypes\n\ + \ restrictions by specifying a subset of the entityTypes
  • \"n \ + \
  • An empty\n entityTypes list when there are no parent restrictions\ + \ means there are no\n restrictions
  • \"n
  • An empty entityTypes\ + \ list when there are parent\n restrictions means that the subtype\ + \ picks up the parents restrictions
  • \"n\n
  • If a list of entityTypes\ + \ are supplied, where one inherits from another,\n this will be rejected.\ + \ This should encourage cleaner\n classificationsDefs
  • \"n
.\n\ + \ ],\n \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"relationshipAttributeDefs\": [\n \ + \ {\n \"cardinality\": \"str\", # Optional. single-valued\ + \ attribute or\n multi-valued attribute. Known values are: \"\ + SINGLE\", \"LIST\", \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \"\ + str\": {} # Optional. The parameters\n of the constraint\ + \ definition.\n },\n \"type\": \"\ + str\" # Optional. The type of the\n constraint.\n \ + \ }\n ],\n \"defaultValue\": \"str\"\ + , # Optional. The default value of the\n attribute.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ attribute.\n \"includeInNotification\": bool, # Optional.\ + \ Determines if it\n is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isLegacyAttribute\": bool, # Optional. Determines\ + \ if it is a\n legacy attribute.\n \"isOptional\"\ + : bool, # Optional. Determines if it is\n optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if it unique.\n \ + \ \"name\": \"str\", # Optional. The name of the attribute.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options\ + \ for the\n attribute.\n },\n \ + \ \"relationshipTypeName\": \"str\", # Optional. The name of the\n \ + \ relationship type.\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"valuesMaxCount\": 0, # Optional. The\ + \ maximum count of the\n values.\n \"valuesMinCount\"\ + : 0 # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"relationshipCategory\": \"str\", # Optional. The Relationship\ + \ category\n determines the style of relationship around containment and\ + \ lifecycle.\"nUML\n terminology is used for the values.\"n\"n:code:`

`\"\ + nASSOCIATION is a relationship\n with no containment. :code:`
`\"nCOMPOSITION\ + \ and AGGREGATION are containment\n relationships.\"n\"n:code:`

`\"\ + nThe difference being in the lifecycles of the\n container and its children.\ + \ In the COMPOSITION case,\"nthe children cannot exist\n without the container.\ + \ For AGGREGATION, the life cycles\"nof the container and\n children are\ + \ totally independent. Known values are: \"ASSOCIATION\", \"AGGREGATION\",\n \ + \ \"COMPOSITION\".\n \"relationshipLabel\": \"str\", # Optional.\ + \ The label of the relationship.\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"subTypes\": [\n \"str\" # Optional. An\ + \ array of sub types.\n ],\n \"superTypes\": [\n \"str\"\ + \ # Optional. An array of super types.\n ],\n \"typeVersion\": \"\ + str\", # Optional. The version of the type.\n \"updateTime\": 0.0, # Optional.\ + \ The update time of the record.\n \"updatedBy\": \"str\", # Optional.\ + \ The user who updated the record.\n \"version\": 0.0 # Optional. The version\ + \ of the record.\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.TypesOperations.get_type_definition_by_name + name: get_type_definition_by_name + summary: Get the type definition by its name (unique). + signature: 'async get_type_definition_by_name(name: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: name + description: The name of the type. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"defaultValue\": \"str\", # Optional. The default value.\n \"description\"\ + : \"str\", # Optional. The description of the type definition.\n \"elementDefs\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n enum element definition.\n \"ordinal\"\ + : 0.0, # Optional. The ordinal of the enum element\n definition.\n\ + \ \"value\": \"str\" # Optional. The value of the enum element\n\ + \ definition.\n }\n ],\n \"endDef1\": {\n\ + \ \"cardinality\": \"str\", # Optional. single-valued attribute or\n\ + \ multi-valued attribute. Known values are: \"SINGLE\", \"LIST\",\ + \ \"SET\".\n \"description\": \"str\", # Optional. The description\ + \ of the\n relationship end definition.\n \"isContainer\"\ + : bool, # Optional. Determines if it is container.\n \"isLegacyAttribute\"\ + : bool, # Optional. Determines if it is a legacy\n attribute.\n \ + \ \"name\": \"str\", # Optional. The name of the relationship end\n\ + \ definition.\n \"type\": \"str\" # Optional. The type\ + \ of the relationship end.\n },\n \"endDef2\": {\n \"cardinality\"\ + : \"str\", # Optional. single-valued attribute or\n multi-valued\ + \ attribute. Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"description\"\ + : \"str\", # Optional. The description of the\n relationship end\ + \ definition.\n \"isContainer\": bool, # Optional. Determines if it\ + \ is container.\n \"isLegacyAttribute\": bool, # Optional. Determines\ + \ if it is a legacy\n attribute.\n \"name\": \"str\", #\ + \ Optional. The name of the relationship end\n definition.\n \ + \ \"type\": \"str\" # Optional. The type of the relationship end.\n \ + \ },\n \"entityTypes\": [\n \"str\" # Optional. Specifying\ + \ a list of entityType names in the\n classificationDef, ensures that\ + \ classifications can\"nonly be applied to those\n entityTypes.\"\ + n\"n\"n.. raw:: html\"n\"n

    \"n
  • Any subtypes of the entity\n \ + \ types inherit the restriction
  • \"n
  • Any classificationDef subtypes\n\ + \ inherit the parents entityTypes restrictions
  • \"n
  • Any\n\ + \ classificationDef subtypes can further restrict the parents entityTypes\n\ + \ restrictions by specifying a subset of the entityTypes
  • \"n \ + \
  • An empty\n entityTypes list when there are no parent restrictions\ + \ means there are no\n restrictions
  • \"n
  • An empty entityTypes\ + \ list when there are parent\n restrictions means that the subtype\ + \ picks up the parents restrictions
  • \"n\n
  • If a list of entityTypes\ + \ are supplied, where one inherits from another,\n this will be rejected.\ + \ This should encourage cleaner\n classificationsDefs
  • \"n
.\n\ + \ ],\n \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"relationshipAttributeDefs\": [\n \ + \ {\n \"cardinality\": \"str\", # Optional. single-valued\ + \ attribute or\n multi-valued attribute. Known values are: \"\ + SINGLE\", \"LIST\", \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \"\ + str\": {} # Optional. The parameters\n of the constraint\ + \ definition.\n },\n \"type\": \"\ + str\" # Optional. The type of the\n constraint.\n \ + \ }\n ],\n \"defaultValue\": \"str\"\ + , # Optional. The default value of the\n attribute.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ attribute.\n \"includeInNotification\": bool, # Optional.\ + \ Determines if it\n is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isLegacyAttribute\": bool, # Optional. Determines\ + \ if it is a\n legacy attribute.\n \"isOptional\"\ + : bool, # Optional. Determines if it is\n optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if it unique.\n \ + \ \"name\": \"str\", # Optional. The name of the attribute.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options\ + \ for the\n attribute.\n },\n \ + \ \"relationshipTypeName\": \"str\", # Optional. The name of the\n \ + \ relationship type.\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"valuesMaxCount\": 0, # Optional. The\ + \ maximum count of the\n values.\n \"valuesMinCount\"\ + : 0 # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"relationshipCategory\": \"str\", # Optional. The Relationship\ + \ category\n determines the style of relationship around containment and\ + \ lifecycle.\"nUML\n terminology is used for the values.\"n\"n:code:`

`\"\ + nASSOCIATION is a relationship\n with no containment. :code:`
`\"nCOMPOSITION\ + \ and AGGREGATION are containment\n relationships.\"n\"n:code:`

`\"\ + nThe difference being in the lifecycles of the\n container and its children.\ + \ In the COMPOSITION case,\"nthe children cannot exist\n without the container.\ + \ For AGGREGATION, the life cycles\"nof the container and\n children are\ + \ totally independent. Known values are: \"ASSOCIATION\", \"AGGREGATION\",\n \ + \ \"COMPOSITION\".\n \"relationshipLabel\": \"str\", # Optional.\ + \ The label of the relationship.\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"subTypes\": [\n \"str\" # Optional. An\ + \ array of sub types.\n ],\n \"superTypes\": [\n \"str\"\ + \ # Optional. An array of super types.\n ],\n \"typeVersion\": \"\ + str\", # Optional. The version of the type.\n \"updateTime\": 0.0, # Optional.\ + \ The update time of the record.\n \"updatedBy\": \"str\", # Optional.\ + \ The user who updated the record.\n \"version\": 0.0 # Optional. The version\ + \ of the record.\n }\n ````\n" +- uid: azure.purview.catalog.aio.operations.TypesOperations.list_type_definition_headers + name: list_type_definition_headers + summary: List all type definitions returned as a list of minimal information header. + signature: 'async list_type_definition_headers(*, include_term_template: bool | + None = False, type: str | None = None, **kwargs: Any) -> List[MutableMapping[str, + Any]]' + keywordOnlyParameters: + - name: include_term_template + description: 'Whether include termtemplatedef when return all typedefs. + + This is always true when search filter type=term_template. Default value is + False.' + types: + - + - name: type + description: 'Typedef name as search filter when get typedefs. Known values are: + "enum", + + "entity", "classification", "relationship", "struct", and "term_template". Default + value is + + None.' + types: + - + return: + description: list of JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == [\n {\n\ + \ \"category\": \"str\", # Optional. The enum of type category. Known\n\ + \ values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"STRUCT\"\ + ,\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"guid\": \"str\", # Optional. The GUID of the\ + \ type definition.\n \"name\": \"str\" # Optional. The name of the\ + \ type definition.\n }\n ]\n ````\n" +- uid: azure.purview.catalog.aio.operations.TypesOperations.update_atlas_type_definitions + name: update_atlas_type_definitions + summary: Update all types in bulk, changes detected in the type definitions would + be persisted. + signature: 'async update_atlas_type_definitions(types_def: MutableMapping[str, Any], + **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: types_def + description: A composite object that captures all type definition changes. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n types_def\ + \ = {\n \"businessMetadataDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"classificationDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + entityTypes\": [\n \"str\" # Optional. Specifying a list of\ + \ entityType\n names in the classificationDef, ensures that\ + \ classifications\n can\"nonly be applied to those entityTypes.\"\ + n\"n\"n.. raw:: html\"n\"n\n

    \"n
  • Any subtypes of\ + \ the entity types inherit the\n restriction
  • \"n
  • Any\ + \ classificationDef subtypes inherit the\n parents entityTypes\ + \ restrictions
  • \"n
  • Any classificationDef\n subtypes\ + \ can further restrict the parents entityTypes restrictions by\n \ + \ specifying a subset of the entityTypes
  • \"n
  • An empty\n \ + \ entityTypes list when there are no parent restrictions means\ + \ there\n are no restrictions
  • \"n
  • An empty entityTypes\ + \ list when there\n are parent restrictions means that the\ + \ subtype picks up the parents\n restrictions
  • \"n
  • If\ + \ a list of entityTypes are supplied,\n where one inherits\ + \ from another, this will be rejected. This should\n encourage\ + \ cleaner classificationsDefs
  • \"n
.\n ],\n \ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name\ + \ of the type definition.\n \"options\": {\n \"\ + str\": \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"subTypes\": [\n \"str\" #\ + \ Optional. An array of sub types.\n ],\n \"superTypes\"\ + : [\n \"str\" # Optional. An array of super types.\n \ + \ ],\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"entityDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"relationshipAttributeDefs\": [\n \ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isLegacyAttribute\"\ + : bool, # Optional.\n Determines if it is a legacy attribute.\n\ + \ \"isOptional\": bool, # Optional. Determines\n \ + \ if it is optional.\n \"isUnique\": bool,\ + \ # Optional. Determines if\n it unique.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"relationshipTypeName\": \"str\", # Optional.\n \ + \ The name of the relationship type.\n \"typeName\": \"\ + str\", # Optional. The name of\n the type.\n \ + \ \"valuesMaxCount\": 0, # Optional. The maximum\n \ + \ count of the values.\n \"valuesMinCount\"\ + : 0 # Optional. The minimum\n count of the values.\n\ + \ }\n ],\n \"serviceType\": \"str\"\ + , # Optional. The service type.\n \"subTypes\": [\n \ + \ \"str\" # Optional. An array of sub types.\n ],\n \ + \ \"superTypes\": [\n \"str\" # Optional. An array\ + \ of super types.\n ],\n \"typeVersion\": \"str\"\ + , # Optional. The version of the type.\n \"updateTime\": 0.0, \ + \ # Optional. The update time of the\n record.\n \ + \ \"updatedBy\": \"str\", # Optional. The user who updated the\n \ + \ record.\n \"version\": 0.0 # Optional. The version of the\ + \ record.\n }\n ],\n \"enumDefs\": [\n {\n \ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"defaultValue\": \"str\", # Optional.\ + \ The default value.\n \"description\": \"str\", # Optional. The\ + \ description of the\n type definition.\n \"elementDefs\"\ + : [\n {\n \"description\": \"str\", #\ + \ Optional. The\n description of the enum element definition.\n\ + \ \"ordinal\": 0.0, # Optional. The ordinal of\n \ + \ the enum element definition.\n \"value\"\ + : \"str\" # Optional. The value of the\n enum element\ + \ definition.\n }\n ],\n \"guid\"\ + : \"str\", # Optional. The GUID of the type definition.\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"name\": \"str\", # Optional. The name of the type definition.\n\ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options for the type\n definition.\n },\n\ + \ \"serviceType\": \"str\", # Optional. The service type.\n \ + \ \"typeVersion\": \"str\", # Optional. The version of the type.\n\ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the\n record.\n \"version\":\ + \ 0.0 # Optional. The version of the record.\n }\n ],\n \ + \ \"relationshipDefs\": [\n {\n \"attributeDefs\": [\n\ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isOptional\"\ + : bool, # Optional. Determines\n if it is optional.\n\ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", #\ + \ Optional. The name of the\n attribute.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options\n for the attribute.\n \ + \ },\n \"typeName\": \"str\", # Optional. The\ + \ name of\n the type.\n \"valuesMaxCount\"\ + : 0, # Optional. The maximum\n count of the values.\n\ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n \ + \ ],\n \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + endDef1\": {\n \"cardinality\": \"str\", # Optional. single-valued\n\ + \ attribute or multi-valued attribute. Known values are: \"\ + SINGLE\",\n \"LIST\", \"SET\".\n \"description\"\ + : \"str\", # Optional. The description of\n the relationship\ + \ end definition.\n \"isContainer\": bool, # Optional. Determines\ + \ if it is\n container.\n \"isLegacyAttribute\"\ + : bool, # Optional. Determines if\n it is a legacy attribute.\n\ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\"\ + \ # Optional. The type of the\n relationship end.\n \ + \ },\n \"endDef2\": {\n \"cardinality\"\ + : \"str\", # Optional. single-valued\n attribute or multi-valued\ + \ attribute. Known values are: \"SINGLE\",\n \"LIST\", \"\ + SET\".\n \"description\": \"str\", # Optional. The description\ + \ of\n the relationship end definition.\n \ + \ \"isContainer\": bool, # Optional. Determines if it is\n \ + \ container.\n \"isLegacyAttribute\": bool, # Optional.\ + \ Determines if\n it is a legacy attribute.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\" # Optional.\ + \ The type of the\n relationship end.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"name\": \"str\", # Optional. The\ + \ name of the type definition.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the type\n \ + \ definition.\n },\n \"relationshipCategory\"\ + : \"str\", # Optional. The Relationship\n category determines\ + \ the style of relationship around containment and\n lifecycle.\"\ + nUML terminology is used for the\n values.\"n\"n:code:`

`\"\ + nASSOCIATION is a relationship with no\n containment. :code:`
`\"\ + nCOMPOSITION and AGGREGATION are containment\n relationships.\"\ + n\"n:code:`

`\"nThe difference being in the lifecycles of\n \ + \ the container and its children. In the COMPOSITION case,\"nthe children\n \ + \ cannot exist without the container. For AGGREGATION, the life\ + \ cycles\"nof\n the container and children are totally independent.\ + \ Known values are:\n \"ASSOCIATION\", \"AGGREGATION\", \"COMPOSITION\"\ + .\n \"relationshipLabel\": \"str\", # Optional. The label of the\n\ + \ relationship.\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The\ + \ version of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the\n record.\n \"updatedBy\": \"str\"\ + , # Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n\ + \ ],\n \"structDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"termTemplateDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ]\n }\n\n # response body for status code(s): 200\n response.json()\ + \ == {\n \"businessMetadataDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"classificationDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + entityTypes\": [\n \"str\" # Optional. Specifying a list of\ + \ entityType\n names in the classificationDef, ensures that\ + \ classifications\n can\"nonly be applied to those entityTypes.\"\ + n\"n\"n.. raw:: html\"n\"n\n

    \"n
  • Any subtypes of\ + \ the entity types inherit the\n restriction
  • \"n
  • Any\ + \ classificationDef subtypes inherit the\n parents entityTypes\ + \ restrictions
  • \"n
  • Any classificationDef\n subtypes\ + \ can further restrict the parents entityTypes restrictions by\n \ + \ specifying a subset of the entityTypes
  • \"n
  • An empty\n \ + \ entityTypes list when there are no parent restrictions means\ + \ there\n are no restrictions
  • \"n
  • An empty entityTypes\ + \ list when there\n are parent restrictions means that the\ + \ subtype picks up the parents\n restrictions
  • \"n
  • If\ + \ a list of entityTypes are supplied,\n where one inherits\ + \ from another, this will be rejected. This should\n encourage\ + \ cleaner classificationsDefs
  • \"n
.\n ],\n \ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name\ + \ of the type definition.\n \"options\": {\n \"\ + str\": \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"subTypes\": [\n \"str\" #\ + \ Optional. An array of sub types.\n ],\n \"superTypes\"\ + : [\n \"str\" # Optional. An array of super types.\n \ + \ ],\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"entityDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"relationshipAttributeDefs\": [\n \ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isLegacyAttribute\"\ + : bool, # Optional.\n Determines if it is a legacy attribute.\n\ + \ \"isOptional\": bool, # Optional. Determines\n \ + \ if it is optional.\n \"isUnique\": bool,\ + \ # Optional. Determines if\n it unique.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"relationshipTypeName\": \"str\", # Optional.\n \ + \ The name of the relationship type.\n \"typeName\": \"\ + str\", # Optional. The name of\n the type.\n \ + \ \"valuesMaxCount\": 0, # Optional. The maximum\n \ + \ count of the values.\n \"valuesMinCount\"\ + : 0 # Optional. The minimum\n count of the values.\n\ + \ }\n ],\n \"serviceType\": \"str\"\ + , # Optional. The service type.\n \"subTypes\": [\n \ + \ \"str\" # Optional. An array of sub types.\n ],\n \ + \ \"superTypes\": [\n \"str\" # Optional. An array\ + \ of super types.\n ],\n \"typeVersion\": \"str\"\ + , # Optional. The version of the type.\n \"updateTime\": 0.0, \ + \ # Optional. The update time of the\n record.\n \ + \ \"updatedBy\": \"str\", # Optional. The user who updated the\n \ + \ record.\n \"version\": 0.0 # Optional. The version of the\ + \ record.\n }\n ],\n \"enumDefs\": [\n {\n \ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"defaultValue\": \"str\", # Optional.\ + \ The default value.\n \"description\": \"str\", # Optional. The\ + \ description of the\n type definition.\n \"elementDefs\"\ + : [\n {\n \"description\": \"str\", #\ + \ Optional. The\n description of the enum element definition.\n\ + \ \"ordinal\": 0.0, # Optional. The ordinal of\n \ + \ the enum element definition.\n \"value\"\ + : \"str\" # Optional. The value of the\n enum element\ + \ definition.\n }\n ],\n \"guid\"\ + : \"str\", # Optional. The GUID of the type definition.\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"name\": \"str\", # Optional. The name of the type definition.\n\ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options for the type\n definition.\n },\n\ + \ \"serviceType\": \"str\", # Optional. The service type.\n \ + \ \"typeVersion\": \"str\", # Optional. The version of the type.\n\ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the\n record.\n \"version\":\ + \ 0.0 # Optional. The version of the record.\n }\n ],\n \ + \ \"relationshipDefs\": [\n {\n \"attributeDefs\": [\n\ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isOptional\"\ + : bool, # Optional. Determines\n if it is optional.\n\ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", #\ + \ Optional. The name of the\n attribute.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options\n for the attribute.\n \ + \ },\n \"typeName\": \"str\", # Optional. The\ + \ name of\n the type.\n \"valuesMaxCount\"\ + : 0, # Optional. The maximum\n count of the values.\n\ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n \ + \ ],\n \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + endDef1\": {\n \"cardinality\": \"str\", # Optional. single-valued\n\ + \ attribute or multi-valued attribute. Known values are: \"\ + SINGLE\",\n \"LIST\", \"SET\".\n \"description\"\ + : \"str\", # Optional. The description of\n the relationship\ + \ end definition.\n \"isContainer\": bool, # Optional. Determines\ + \ if it is\n container.\n \"isLegacyAttribute\"\ + : bool, # Optional. Determines if\n it is a legacy attribute.\n\ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\"\ + \ # Optional. The type of the\n relationship end.\n \ + \ },\n \"endDef2\": {\n \"cardinality\"\ + : \"str\", # Optional. single-valued\n attribute or multi-valued\ + \ attribute. Known values are: \"SINGLE\",\n \"LIST\", \"\ + SET\".\n \"description\": \"str\", # Optional. The description\ + \ of\n the relationship end definition.\n \ + \ \"isContainer\": bool, # Optional. Determines if it is\n \ + \ container.\n \"isLegacyAttribute\": bool, # Optional.\ + \ Determines if\n it is a legacy attribute.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\" # Optional.\ + \ The type of the\n relationship end.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"name\": \"str\", # Optional. The\ + \ name of the type definition.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the type\n \ + \ definition.\n },\n \"relationshipCategory\"\ + : \"str\", # Optional. The Relationship\n category determines\ + \ the style of relationship around containment and\n lifecycle.\"\ + nUML terminology is used for the\n values.\"n\"n:code:`

`\"\ + nASSOCIATION is a relationship with no\n containment. :code:`
`\"\ + nCOMPOSITION and AGGREGATION are containment\n relationships.\"\ + n\"n:code:`

`\"nThe difference being in the lifecycles of\n \ + \ the container and its children. In the COMPOSITION case,\"nthe children\n \ + \ cannot exist without the container. For AGGREGATION, the life\ + \ cycles\"nof\n the container and children are totally independent.\ + \ Known values are:\n \"ASSOCIATION\", \"AGGREGATION\", \"COMPOSITION\"\ + .\n \"relationshipLabel\": \"str\", # Optional. The label of the\n\ + \ relationship.\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The\ + \ version of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the\n record.\n \"updatedBy\": \"str\"\ + , # Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n\ + \ ],\n \"structDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"termTemplateDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ]\n }\n ````\n" diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.yml new file mode 100644 index 00000000..47b193a3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.purview.catalog.aio.operations +name: operations +fullName: azure.purview.catalog.aio.operations +type: import +classes: +- azure.purview.catalog.aio.operations.CollectionOperations +- azure.purview.catalog.aio.operations.DiscoveryOperations +- azure.purview.catalog.aio.operations.EntityOperations +- azure.purview.catalog.aio.operations.GlossaryOperations +- azure.purview.catalog.aio.operations.LineageOperations +- azure.purview.catalog.aio.operations.RelationshipOperations +- azure.purview.catalog.aio.operations.TypesOperations diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.yml new file mode 100644 index 00000000..f11c1978 --- /dev/null +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.purview.catalog.aio +name: aio +fullName: azure.purview.catalog.aio +type: import +classes: +- azure.purview.catalog.aio.PurviewCatalogClient +packages: +- azure.purview.catalog.aio.operations diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.CollectionOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.CollectionOperations.yml new file mode 100644 index 00000000..d3b9e738 --- /dev/null +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.CollectionOperations.yml @@ -0,0 +1,792 @@ +### YamlMime:PythonClass +uid: azure.purview.catalog.operations.CollectionOperations +name: CollectionOperations +fullName: azure.purview.catalog.operations.CollectionOperations +module: azure.purview.catalog.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: CollectionOperations(*args, **kwargs) +methods: +- uid: azure.purview.catalog.operations.CollectionOperations.create_or_update + name: create_or_update + summary: 'Creates or updates an entity to a collection. + + Existing entity is matched using its unique guid if supplied or by its unique + attributes eg: + + qualifiedName. + + Map and array of collections are not well supported. E.g., array*>, + + array>.' + signature: 'create_or_update(collection: str, entity: MutableMapping[str, Any], + **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: collection + description: the collection unique name. + isRequired: true + types: + - + - name: entity + description: Atlas entity with extended information. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n entity\ + \ = {\n \"entity\": {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \"\ + businessAttributes\": {\n \"str\": {} # Optional. Business Attributes.\n\ + \ },\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the\n struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional. The GUID of the\n\ + \ entity.\n \"entityStatus\": \"str\", \ + \ # Optional. Status of the\n entity - can be active or deleted.\ + \ Deleted entities are not removed\n from Atlas store. Known\ + \ values are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for\n concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the source who\n create the classification detail.\n\ + \ \"sourceDetails\": {\n \"str\": {} \ + \ # Optional. more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"validityPeriods\": [\n \ + \ {\n \"endTime\": \"str\", # Optional.\ + \ The\n end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n \ + \ start of the time boundary.\n \"timeZone\"\ + : \"str\" # Optional. The\n timezone of the time\ + \ boundary.\n }\n ]\n }\n\ + \ ],\n \"contacts\": {\n \"str\": [\n \ + \ {\n \"id\": \"str\", # Optional. Azure Active\n\ + \ Directory object Id.\n \"info\"\ + : \"str\" # Optional. additional\n information to describe\ + \ this contact.\n }\n ]\n },\n \ + \ \"createTime\": 0.0, # Optional. The created time of the record.\n \ + \ \"createdBy\": \"str\", # Optional. The user who created the record.\n\ + \ \"customAttributes\": {\n \"str\": \"str\" # Optional.\ + \ Custom Attribute.\n },\n \"guid\": \"str\", # Optional.\ + \ The GUID of the entity.\n \"homeId\": \"str\", # Optional. The home\ + \ ID of the entity.\n \"isIncomplete\": bool, # Optional. Whether it\ + \ is a shell entity.\n \"labels\": [\n \"str\" # Optional.\ + \ labels.\n ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"meanings\": [\n {\n\ + \ \"confidence\": 0, # Optional. The confidence of the\n \ + \ term assignment.\n \"createdBy\": \"str\"\ + , # Optional. The user who created\n the record.\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the term assignment.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n\ + \ relationship.\n \"source\": \"str\", \ + \ # Optional. The source of the term.\n \"status\": \"str\"\ + , # Optional. The status of terms\n assignment. Known values\ + \ are: \"DISCOVERED\", \"PROPOSED\", \"IMPORTED\",\n \"VALIDATED\"\ + , \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \"steward\": \"\ + str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, # Optional. Used\ + \ to record the provenance of\n an instance of an entity or relationship.\n\ + \ \"proxy\": bool, # Optional. Determines if there's a proxy.\n \ + \ \"relationshipAttributes\": {\n \"str\": {} # Optional.\ + \ The attributes of relationship.\n },\n \"source\": \"str\"\ + , # Optional. indicate the source who create the\n classification\ + \ detail.\n \"sourceDetails\": {\n \"str\": {} # Optional.\ + \ more detail on source information.\n },\n \"status\": \"\ + str\", # Optional. Status of the entity - can be active or\n deleted.\ + \ Deleted entities are not removed from Atlas store. Known values are:\n \ + \ \"ACTIVE\", \"DELETED\".\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the record.\n \"updatedBy\": \"str\", # Optional. The user\ + \ who updated the record.\n \"version\": 0.0 # Optional. The version\ + \ of the entity.\n },\n \"referredEntities\": {\n \"str\"\ + : {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"businessAttributes\"\ + : {\n \"str\": {} # Optional. Business Attributes.\n \ + \ },\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {}\ + \ # Optional. The attributes\n of the struct.\n \ + \ },\n \"entityGuid\": \"str\", #\ + \ Optional. The GUID of\n the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of\n \ + \ the entity - can be active or deleted. Deleted entities are not\n \ + \ removed from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag\n for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \"id\"\ + : \"str\", # Optional. Azure\n Active Directory object\ + \ Id.\n \"info\": \"str\" # Optional. additional\n\ + \ information to describe this contact.\n \ + \ }\n ]\n },\n \"\ + createTime\": 0.0, # Optional. The created time of the\n record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the\n\ + \ record.\n \"customAttributes\": {\n \ + \ \"str\": \"str\" # Optional. Custom Attribute.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"homeId\": \"str\", # Optional. The home ID of the entity.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a shell\n \ + \ entity.\n \"labels\": [\n \"str\"\ + \ # Optional. labels.\n ],\n \"lastModifiedTS\":\ + \ \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n }\n }\n\n # response body\ + \ for status code(s): 200\n response.json() == {\n \"guidAssignments\"\ + : {\n \"str\": \"str\" # Optional. A map of GUID assignments with entities.\n\ + \ },\n \"mutatedEntities\": {\n \"str\": [\n \ + \ {\n \"attributes\": {\n \"str\":\ + \ {} # Optional. The attributes of the\n struct.\n \ + \ },\n \"classificationNames\": [\n \ + \ \"str\" # Optional. An array of classification\n \ + \ names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n\ + \ \"str\": {} # Optional. The\n \ + \ attributes of the struct.\n },\n\ + \ \"entityGuid\": \"str\", # Optional. The\n \ + \ GUID of the entity.\n \"entityStatus\"\ + : \"str\", # Optional.\n Status of the entity - can\ + \ be active or deleted. Deleted\n entities are not\ + \ removed from Atlas store. Known values are:\n \"\ + ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional.\n ETag for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\":\n \ + \ bool, # Optional. Determines if propagations will be removed\n\ + \ on entity deletion.\n \ + \ \"source\": \"str\", # Optional.\n indicate the\ + \ source who create the classification detail.\n \"\ + sourceDetails\": {\n \"str\": {} # Optional. more\n\ + \ detail on source information.\n \ + \ },\n \"typeName\": \"str\", # Optional.\ + \ The\n name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\",\n # Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the\ + \ time boundary.\n }\n \ + \ ]\n }\n ],\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"guid\": \"str\"\ + , # Optional. The GUID of the record.\n \"isIncomplete\": bool,\ + \ # Optional. Whether it is a\n shell entity.\n \ + \ \"labels\": [\n \"str\" # Optional. labels.\n\ + \ ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for\n concurrency control.\n \"meaningNames\"\ + : [\n \"str\" # Optional. An array of meanings.\n \ + \ ],\n \"meanings\": [\n \ + \ {\n \"confidence\": 0, # Optional. The\n \ + \ confidence of the term assignment.\n \ + \ \"createdBy\": \"str\", # Optional. The\n \ + \ user who created the record.\n \"description\":\ + \ \"str\", # Optional.\n The description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional.\n\ + \ The display text.\n \"\ + expression\": \"str\", # Optional. The\n expression\ + \ of the term assignment.\n \"relationGuid\": \"str\"\ + , # Optional.\n The GUID of the relationship.\n \ + \ \"source\": \"str\", # Optional. The\n \ + \ source of the term.\n \"status\"\ + : \"str\", # Optional. The\n status of terms assignment.\ + \ Known values are: \"DISCOVERED\",\n \"PROPOSED\"\ + , \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\",\n \"\ + OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The\n steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The\n \ + \ GUID of the term.\n }\n ],\n \ + \ \"status\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\"\ + .\n \"typeName\": \"str\" # Optional. The name of the type.\n\ + \ }\n ]\n },\n \"partialUpdatedEntities\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"classificationNames\": [\n \"str\" # Optional. An\ + \ array of classification names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.CollectionOperations.create_or_update_bulk + name: create_or_update_bulk + summary: 'Creates or updates entities in bulk to a collection. + + Existing entity is matched using its unique guid if supplied or by its unique + attributes eg: + + qualifiedName. + + Map and array of collections are not well supported. E.g., array*>, + + array>.' + signature: 'create_or_update_bulk(collection: str, entities: MutableMapping[str, + Any], **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: collection + description: the collection unique name. + isRequired: true + types: + - + - name: entities + description: Atlas entities with extended information. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n entities\ + \ = {\n \"entities\": [\n {\n \"attributes\": {\n\ + \ \"str\": {} # Optional. The attributes of the struct.\n \ + \ },\n \"businessAttributes\": {\n \ + \ \"str\": {} # Optional. Business Attributes.\n },\n \ + \ \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\n\ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of\n the entity - can be active\ + \ or deleted. Deleted entities are not\n removed from\ + \ Atlas store. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag\n \ + \ for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, #\n Optional. Determines if propagations will\ + \ be removed on entity\n deletion.\n \ + \ \"source\": \"str\", # Optional. indicate the\n \ + \ source who create the classification detail.\n \"sourceDetails\"\ + : {\n \"str\": {} # Optional. more detail on\n \ + \ source information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"validityPeriods\": [\n\ + \ {\n \"endTime\": \"\ + str\", #\n Optional. The end of the time boundary.\n\ + \ \"startTime\": \"str\", #\n \ + \ Optional. The start of the time boundary.\n \ + \ \"timeZone\": \"str\" #\n Optional.\ + \ The timezone of the time boundary.\n }\n \ + \ ]\n }\n ],\n \"contacts\"\ + : {\n \"str\": [\n {\n \ + \ \"id\": \"str\", # Optional. Azure\n \ + \ Active Directory object Id.\n \"info\": \"str\" \ + \ # Optional. additional\n information to describe\ + \ this contact.\n }\n ]\n \ + \ },\n \"createTime\": 0.0, # Optional. The created time of the\n\ + \ record.\n \"createdBy\": \"str\", # Optional.\ + \ The user who created the\n record.\n \"customAttributes\"\ + : {\n \"str\": \"str\" # Optional. Custom Attribute.\n \ + \ },\n \"guid\": \"str\", # Optional. The GUID of the\ + \ entity.\n \"homeId\": \"str\", # Optional. The home ID of the\ + \ entity.\n \"isIncomplete\": bool, # Optional. Whether it is a\ + \ shell\n entity.\n \"labels\": [\n \ + \ \"str\" # Optional. labels.\n ],\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n ],\n \"referredEntities\"\ + : {\n \"str\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"businessAttributes\": {\n \"str\": {} # Optional.\ + \ Business Attributes.\n },\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \"id\"\ + : \"str\", # Optional. Azure\n Active Directory object\ + \ Id.\n \"info\": \"str\" # Optional. additional\n\ + \ information to describe this contact.\n \ + \ }\n ]\n },\n \"\ + createTime\": 0.0, # Optional. The created time of the\n record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the\n\ + \ record.\n \"customAttributes\": {\n \ + \ \"str\": \"str\" # Optional. Custom Attribute.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"homeId\": \"str\", # Optional. The home ID of the entity.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a shell\n \ + \ entity.\n \"labels\": [\n \"str\"\ + \ # Optional. labels.\n ],\n \"lastModifiedTS\":\ + \ \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n }\n }\n\n # response body\ + \ for status code(s): 200\n response.json() == {\n \"guidAssignments\"\ + : {\n \"str\": \"str\" # Optional. A map of GUID assignments with entities.\n\ + \ },\n \"mutatedEntities\": {\n \"str\": [\n \ + \ {\n \"attributes\": {\n \"str\":\ + \ {} # Optional. The attributes of the\n struct.\n \ + \ },\n \"classificationNames\": [\n \ + \ \"str\" # Optional. An array of classification\n \ + \ names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n\ + \ \"str\": {} # Optional. The\n \ + \ attributes of the struct.\n },\n\ + \ \"entityGuid\": \"str\", # Optional. The\n \ + \ GUID of the entity.\n \"entityStatus\"\ + : \"str\", # Optional.\n Status of the entity - can\ + \ be active or deleted. Deleted\n entities are not\ + \ removed from Atlas store. Known values are:\n \"\ + ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional.\n ETag for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\":\n \ + \ bool, # Optional. Determines if propagations will be removed\n\ + \ on entity deletion.\n \ + \ \"source\": \"str\", # Optional.\n indicate the\ + \ source who create the classification detail.\n \"\ + sourceDetails\": {\n \"str\": {} # Optional. more\n\ + \ detail on source information.\n \ + \ },\n \"typeName\": \"str\", # Optional.\ + \ The\n name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\",\n # Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the\ + \ time boundary.\n }\n \ + \ ]\n }\n ],\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"guid\": \"str\"\ + , # Optional. The GUID of the record.\n \"isIncomplete\": bool,\ + \ # Optional. Whether it is a\n shell entity.\n \ + \ \"labels\": [\n \"str\" # Optional. labels.\n\ + \ ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for\n concurrency control.\n \"meaningNames\"\ + : [\n \"str\" # Optional. An array of meanings.\n \ + \ ],\n \"meanings\": [\n \ + \ {\n \"confidence\": 0, # Optional. The\n \ + \ confidence of the term assignment.\n \ + \ \"createdBy\": \"str\", # Optional. The\n \ + \ user who created the record.\n \"description\":\ + \ \"str\", # Optional.\n The description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional.\n\ + \ The display text.\n \"\ + expression\": \"str\", # Optional. The\n expression\ + \ of the term assignment.\n \"relationGuid\": \"str\"\ + , # Optional.\n The GUID of the relationship.\n \ + \ \"source\": \"str\", # Optional. The\n \ + \ source of the term.\n \"status\"\ + : \"str\", # Optional. The\n status of terms assignment.\ + \ Known values are: \"DISCOVERED\",\n \"PROPOSED\"\ + , \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\",\n \"\ + OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The\n steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The\n \ + \ GUID of the term.\n }\n ],\n \ + \ \"status\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\"\ + .\n \"typeName\": \"str\" # Optional. The name of the type.\n\ + \ }\n ]\n },\n \"partialUpdatedEntities\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"classificationNames\": [\n \"str\" # Optional. An\ + \ array of classification names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.CollectionOperations.move_entities_to_collection + name: move_entities_to_collection + summary: Move existing entities to the target collection. + signature: 'move_entities_to_collection(collection: str, move_entities_request: + MutableMapping[str, Any], **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: collection + description: the collection unique name. + isRequired: true + types: + - + - name: move_entities_request + description: Entity guids to be moved to target collection. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n move_entities_request\ + \ = {\n \"entityGuids\": [\n \"str\" # Optional. An array of\ + \ entity guids to be moved to target\n collection.\n ]\n }\n\ + \n # response body for status code(s): 200\n response.json() == {\n \ + \ \"guidAssignments\": {\n \"str\": \"str\" # Optional. A map of GUID\ + \ assignments with entities.\n },\n \"mutatedEntities\": {\n \ + \ \"str\": [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"classificationNames\"\ + : [\n \"str\" # Optional. An array of classification\n\ + \ names.\n ],\n \"\ + classifications\": [\n {\n \"\ + attributes\": {\n \"str\": {} # Optional. The\n\ + \ attributes of the struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional.\ + \ The\n GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional.\n \ + \ Status of the entity - can be active or deleted. Deleted\n \ + \ entities are not removed from Atlas store. Known values are:\n \ + \ \"ACTIVE\", \"DELETED\".\n \ + \ \"lastModifiedTS\": \"str\", # Optional.\n ETag\ + \ for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + :\n bool, # Optional. Determines if propagations\ + \ will be removed\n on entity deletion.\n \ + \ \"source\": \"str\", # Optional.\n \ + \ indicate the source who create the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\"\ + : {} # Optional. more\n detail on source information.\n\ + \ },\n \"typeName\": \"str\"\ + , # Optional. The\n name of the type.\n \ + \ \"validityPeriods\": [\n {\n\ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\",\n \ + \ # Optional. The start of the time boundary.\n \ + \ \"timeZone\": \"str\" #\n Optional.\ + \ The timezone of the time boundary.\n }\n \ + \ ]\n }\n ],\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"guid\": \"str\", # Optional. The GUID of the record.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a\n \ + \ shell entity.\n \"labels\": [\n \ + \ \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for\n \ + \ concurrency control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n \ + \ ],\n \"meanings\": [\n {\n \ + \ \"confidence\": 0, # Optional. The\n \ + \ confidence of the term assignment.\n \"createdBy\"\ + : \"str\", # Optional. The\n user who created the\ + \ record.\n \"description\": \"str\", # Optional.\n\ + \ The description of the term assignment.\n \ + \ \"displayText\": \"str\", # Optional.\n \ + \ The display text.\n \"expression\": \"\ + str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional.\n \ + \ The GUID of the relationship.\n \ + \ \"source\": \"str\", # Optional. The\n source\ + \ of the term.\n \"status\": \"str\", # Optional. The\n\ + \ status of terms assignment. Known values are: \"\ + DISCOVERED\",\n \"PROPOSED\", \"IMPORTED\", \"VALIDATED\"\ + , \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The\n \ + \ steward of the term.\n \"termGuid\"\ + : \"str\" # Optional. The\n GUID of the term.\n \ + \ }\n ],\n \"status\"\ + : \"str\", # Optional. Status of the entity -\n can be active\ + \ or deleted. Deleted entities are not removed from Atlas\n \ + \ store. Known values are: \"ACTIVE\", \"DELETED\".\n \"typeName\"\ + : \"str\" # Optional. The name of the type.\n }\n ]\n\ + \ },\n \"partialUpdatedEntities\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"classificationNames\": [\n\ + \ \"str\" # Optional. An array of classification names.\n \ + \ ],\n \"classifications\": [\n {\n\ + \ \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes\n of the struct.\n\ + \ },\n \"entityGuid\": \"str\", #\ + \ Optional. The GUID of\n the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of\n \ + \ the entity - can be active or deleted. Deleted entities are not\n \ + \ removed from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag\n for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n ]\n }\n ````\n" diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.DiscoveryOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.DiscoveryOperations.yml new file mode 100644 index 00000000..8c9886bb --- /dev/null +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.DiscoveryOperations.yml @@ -0,0 +1,272 @@ +### YamlMime:PythonClass +uid: azure.purview.catalog.operations.DiscoveryOperations +name: DiscoveryOperations +fullName: azure.purview.catalog.operations.DiscoveryOperations +module: azure.purview.catalog.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: DiscoveryOperations(*args, **kwargs) +methods: +- uid: azure.purview.catalog.operations.DiscoveryOperations.auto_complete + name: auto_complete + summary: Get auto complete options. + signature: 'auto_complete(auto_complete_request: MutableMapping[str, Any], **kwargs: + Any) -> MutableMapping[str, Any]' + parameters: + - name: auto_complete_request + description: An object specifying the autocomplete criteria. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n auto_complete_request\ + \ = {\n \"filter\": {}, # Optional. The filter for the autocomplete request.\n\ + \ \"keywords\": \"str\", # Optional. The keywords applied to all fields\ + \ that\n support autocomplete operation. It must be at least 1 character,\ + \ and no more than\n 100 characters.\n \"limit\": 0 # Optional.\ + \ The number of autocomplete results we hope to return.\n The default\ + \ value is 50. The value must be a number between 1 and 100.\n }\n\n # response\ + \ body for status code(s): 200\n response.json() == {\n \"value\": [\n\ + \ {\n \"queryPlusText\": \"str\", # Optional. The completed\ + \ search\n query text.\n \"text\": \"str\" # Optional.\ + \ The completed term or phrase.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.DiscoveryOperations.browse + name: browse + summary: Browse entities by path or entity type. + signature: 'browse(browse_request: MutableMapping[str, Any], **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: browse_request + description: An object specifying the browse criteria. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n browse_request\ + \ = {\n \"entityType\": \"str\", # Optional. The entity type to browse\ + \ as the root level\n entry point.\n \"limit\": 0, # Optional.\ + \ The number of browse items we hope to return. The\n maximum value is\ + \ 10000.\n \"offset\": 0, # Optional. The offset. The default value is\ + \ 0. The maximum\n value is 100000.\n \"path\": \"str\" # Optional.\ + \ The path to browse the next level child entities.\n }\n\n # response body\ + \ for status code(s): 200\n response.json() == {\n \"@search.count\":\ + \ 0, # Optional. The total number of browse results.\n \"value\": [\n \ + \ {\n \"entityType\": \"str\", # Optional. The type name\ + \ of the\n record.\n \"id\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isLeaf\": bool, # Optional. If the\ + \ record is a leaf entity.\n \"name\": \"str\", # Optional. The\ + \ name of the record.\n \"owner\": [\n {\n \ + \ \"contactType\": \"str\", # Optional. The\n \ + \ contact type of the owner. The value will be Owner.\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the owner.\n \"id\": \"str\", #\ + \ Optional. The GUID of the\n owner.\n \ + \ \"mail\": \"str\" # Optional. The mail of the\n \ + \ owner.\n }\n ],\n \"path\"\ + : \"str\", # Optional. The path of the record.\n \"qualifiedName\"\ + : \"str\" # Optional. The qualified name of the\n record.\n \ + \ }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.DiscoveryOperations.query + name: query + summary: Gets data using search. + signature: 'query(search_request: MutableMapping[str, Any], **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: search_request + description: An object specifying the search criteria. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n search_request\ + \ = {\n \"facets\": [\n {\n \"count\": 0, # Optional.\ + \ The count of the facet item.\n \"facet\": \"str\", # Optional.\ + \ The name of the facet item.\n \"sort\": {} # Optional. Any object.\n\ + \ }\n ],\n \"filter\": {}, # Optional. The filter for the\ + \ search. See examples for the\n usage of supported filters.\n \"\ + keywords\": \"str\", # Optional. The keywords applied to all searchable\n \ + \ fields.\n \"limit\": 0, # Optional. The limit of the number of the\ + \ search result.\n default value is 50; maximum value is 1000.\n \ + \ \"offset\": 0, # Optional. The offset. The default value is 0. The maximum\n\ + \ value is 100000.\n \"taxonomySetting\": {\n \"assetTypes\"\ + : [\n \"str\" # Optional.\n ],\n \"facet\"\ + : {\n \"count\": 0, # Optional. The count of the facet item.\n\ + \ \"facet\": \"str\", # Optional. The name of the facet item.\n\ + \ \"sort\": {} # Optional. Any object.\n }\n }\n\ + \ }\n\n # response body for status code(s): 200\n response.json() == {\n\ + \ \"@search.count\": 0, # Optional. The total number of search results\ + \ (not the\n number of documents in a single page).\n \"@search.facets\"\ + : {\n \"assetType\": [\n {\n \"count\"\ + : 0, # Optional. The count of the facet item.\n \"value\":\ + \ \"str\" # Optional. The name of the facet\n item.\n \ + \ }\n ],\n \"classification\": [\n \ + \ {\n \"count\": 0, # Optional. The count of the facet item.\n\ + \ \"value\": \"str\" # Optional. The name of the facet\n \ + \ item.\n }\n ],\n \"classificationCategory\"\ + : [\n {\n \"count\": 0, # Optional. The count\ + \ of the facet item.\n \"value\": \"str\" # Optional. The name\ + \ of the facet\n item.\n }\n ],\n\ + \ \"contactId\": [\n {\n \"count\":\ + \ 0, # Optional. The count of the facet item.\n \"value\":\ + \ \"str\" # Optional. The name of the facet\n item.\n \ + \ }\n ],\n \"fileExtension\": [\n \ + \ {\n \"count\": 0, # Optional. The count of the facet item.\n\ + \ \"value\": \"str\" # Optional. The name of the facet\n \ + \ item.\n }\n ],\n \"label\"\ + : [\n {\n \"count\": 0, # Optional. The count\ + \ of the facet item.\n \"value\": \"str\" # Optional. The name\ + \ of the facet\n item.\n }\n ],\n\ + \ \"term\": [\n {\n \"count\": 0, #\ + \ Optional. The count of the facet item.\n \"value\": \"str\"\ + \ # Optional. The name of the facet\n item.\n \ + \ }\n ]\n },\n \"value\": [\n {\n \ + \ \"@search.highlights\": {\n \"description\": [\n \ + \ \"str\" # Optional. A highlight list that\n \ + \ consists of index fields id ,qualifiedName, name, description,\n\ + \ entityType. When the keyword appears in those fields,\ + \ the value\n of the field, attached with emphasis mark,\ + \ is returned as an\n element of @search.highlights.\n\ + \ ],\n \"entityType\": [\n \ + \ \"str\" # Optional. A highlight list that\n \ + \ consists of index fields id ,qualifiedName, name, description,\n \ + \ entityType. When the keyword appears in those fields, the value\n\ + \ of the field, attached with emphasis mark, is returned\ + \ as an\n element of @search.highlights.\n \ + \ ],\n \"id\": [\n \"str\" # Optional.\ + \ A highlight list that\n consists of index fields id\ + \ ,qualifiedName, name, description,\n entityType. When\ + \ the keyword appears in those fields, the value\n of\ + \ the field, attached with emphasis mark, is returned as an\n \ + \ element of @search.highlights.\n ],\n \ + \ \"name\": [\n \"str\" # Optional. A highlight list\ + \ that\n consists of index fields id ,qualifiedName, name,\ + \ description,\n entityType. When the keyword appears\ + \ in those fields, the value\n of the field, attached\ + \ with emphasis mark, is returned as an\n element of @search.highlights.\n\ + \ ],\n \"qualifiedName\": [\n \ + \ \"str\" # Optional. A highlight list that\n \ + \ consists of index fields id ,qualifiedName, name, description,\n \ + \ entityType. When the keyword appears in those fields, the value\n\ + \ of the field, attached with emphasis mark, is returned\ + \ as an\n element of @search.highlights.\n \ + \ ]\n },\n \"@search.score\": 0.0, # Optional.\ + \ The search score\n calculated by the search engine. The results\ + \ are ordered by search score\n by default.\n \"\ + @search.text\": \"str\", # Optional. The target text that\n contains\ + \ the keyword as prefix. The keyword is wrapped with emphasis\n \ + \ mark.\n \"assetType\": [\n \"str\" # Optional.\ + \ The asset types of the record.\n ],\n \"classification\"\ + : [\n \"str\" # Optional. The classifications of the record.\n\ + \ ],\n \"contact\": [\n {\n \ + \ \"contactType\": \"str\", # Optional. The type\n \ + \ of the contact. It can be Expert or Owner for an entity. It\ + \ can\n be Expert or Steward for a glossary term.\n \ + \ \"id\": \"str\", # Optional. The GUID of the\n \ + \ contact.\n \"info\": \"str\" # Optional.\ + \ The description of\n the contact.\n \ + \ }\n ],\n \"description\": \"str\", # Optional.\ + \ The description of the\n record.\n \"entityType\"\ + : \"str\", # Optional. The type name of the\n record.\n \ + \ \"id\": \"str\", # Optional. The GUID of the record.\n \ + \ \"label\": [\n \"str\" # Optional. The labels of the record.\n\ + \ ],\n \"name\": \"str\", # Optional. The name of\ + \ the record.\n \"owner\": \"str\", # Optional. The owner of the\ + \ record. This is\n an Atlas native attribute.\n \ + \ \"qualifiedName\": \"str\", # Optional. The qualified name of\n \ + \ the record.\n \"term\": [\n {\n \ + \ \"glossaryName\": \"str\", # Optional. The name\n \ + \ of the glossary which contains the term.\n \ + \ \"guid\": \"str\", # Optional. The GUID of the\n \ + \ term.\n \"name\": \"str\" # Optional. The name of the\n\ + \ term.\n }\n ]\n \ + \ }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.DiscoveryOperations.suggest + name: suggest + summary: Get search suggestions by query criteria. + signature: 'suggest(suggest_request: MutableMapping[str, Any], **kwargs: Any) -> + MutableMapping[str, Any]' + parameters: + - name: suggest_request + description: An object specifying the suggest criteria. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n suggest_request\ + \ = {\n \"filter\": {}, # Optional. The filter for the search.\n \ + \ \"keywords\": \"str\", # Optional. The keywords applied to all fields that\n\ + \ support suggest operation. It must be at least 1 character, and no more\ + \ than 100\n characters. In the index schema we defined a default suggester\ + \ which lists all\n the supported fields and specifies a search mode.\n\ + \ \"limit\": 0 # Optional. The number of suggestions we hope to return.\ + \ The\n default value is 5. The value must be a number between 1 and 100.\n\ + \ }\n\n # response body for status code(s): 200\n response.json() == {\n\ + \ \"value\": [\n {\n \"@search.score\": 0.0, #\ + \ Optional. The search score\n calculated by the search engine.\ + \ The results are ordered by search score\n by default.\n \ + \ \"@search.text\": \"str\", # Optional. The target text that\n \ + \ contains the keyword as prefix. The keyword is wrapped with emphasis\n\ + \ mark.\n \"assetType\": [\n \"\ + str\" # Optional. The asset types of the record.\n ],\n \ + \ \"classification\": [\n \"str\" # Optional. The classifications\ + \ of the record.\n ],\n \"contact\": [\n \ + \ {\n \"contactType\": \"str\", # Optional. The\ + \ type\n of the contact. It can be Expert or Owner for\ + \ an entity. It can\n be Expert or Steward for a glossary\ + \ term.\n \"id\": \"str\", # Optional. The GUID of the\n\ + \ contact.\n \"info\": \"str\" \ + \ # Optional. The description of\n the contact.\n \ + \ }\n ],\n \"description\": \"str\"\ + , # Optional. The description of the\n record.\n \ + \ \"entityType\": \"str\", # Optional. The type name of the\n \ + \ record.\n \"id\": \"str\", # Optional. The GUID of the record.\n\ + \ \"label\": [\n \"str\" # Optional. The labels\ + \ of the record.\n ],\n \"name\": \"str\", # Optional.\ + \ The name of the record.\n \"owner\": \"str\", # Optional. The\ + \ owner of the record. This is\n an Atlas native attribute.\n\ + \ \"qualifiedName\": \"str\", # Optional. The qualified name of\n\ + \ the record.\n \"term\": [\n \ + \ {\n \"glossaryName\": \"str\", # Optional. The name\n\ + \ of the glossary which contains the term.\n \ + \ \"guid\": \"str\", # Optional. The GUID of the\n \ + \ term.\n \"name\": \"str\" # Optional. The\ + \ name of the\n term.\n }\n \ + \ ]\n }\n ]\n }\n ````\n" diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.EntityOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.EntityOperations.yml new file mode 100644 index 00000000..94a912cb --- /dev/null +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.EntityOperations.yml @@ -0,0 +1,3115 @@ +### YamlMime:PythonClass +uid: azure.purview.catalog.operations.EntityOperations +name: EntityOperations +fullName: azure.purview.catalog.operations.EntityOperations +module: azure.purview.catalog.operations +constructor: + syntax: EntityOperations(*args, **kwargs) +methods: +- uid: azure.purview.catalog.operations.EntityOperations.add_classification + name: add_classification + summary: Associate a classification to multiple entities in bulk. + signature: 'add_classification(request: MutableMapping[str, Any], **kwargs: Any) + -> None' + parameters: + - name: request + description: The request to associate a classification to multiple entities. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n request\ + \ = {\n \"classification\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas store.\ + \ Known\n values are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional. Determines if\n propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate the\ + \ source who create the\n classification detail.\n \"sourceDetails\"\ + : {\n \"str\": {} # Optional. more detail on source information.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name of the\ + \ type.\n \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the time\n \ + \ boundary.\n \"startTime\": \"str\", # Optional. The start\ + \ of the\n time boundary.\n \"timeZone\"\ + : \"str\" # Optional. The timezone of the\n time boundary.\n\ + \ }\n ]\n },\n \"entityGuids\": [\n \ + \ \"str\" # Optional. The GUID of the entity.\n ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.add_classifications + name: add_classifications + summary: Add classifications to an existing entity represented by a GUID. + signature: 'add_classifications(guid: str, classifications: List[MutableMapping[str, + Any]], **kwargs: Any) -> None' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: classifications + description: An array of classifications to be added. + isRequired: true + types: + - [] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n classifications\ + \ = [\n {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"entityGuid\": \"\ + str\", # Optional. The GUID of the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of the entity - can be\n active or deleted.\ + \ Deleted entities are not removed from Atlas store. Known\n values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional. Determines if\n propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate the\ + \ source who create the\n classification detail.\n \"sourceDetails\"\ + : {\n \"str\": {} # Optional. more detail on source information.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name of the\ + \ type.\n \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the time\n \ + \ boundary.\n \"startTime\": \"str\", # Optional. The start\ + \ of the\n time boundary.\n \"timeZone\"\ + : \"str\" # Optional. The timezone of the\n time boundary.\n\ + \ }\n ]\n }\n ]\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.add_classifications_by_unique_attribute + name: add_classifications_by_unique_attribute + summary: Add classification to the entity identified by its type and unique attributes. + signature: 'add_classifications_by_unique_attribute(type_name: str, atlas_classification_array: + List[MutableMapping[str, Any]], *, attr_qualified_name: str | None = None, **kwargs: + Any) -> None' + parameters: + - name: type_name + description: The name of the type. + isRequired: true + types: + - + - name: atlas_classification_array + description: An array of classification to be added. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: attr_qualified_name + description: The qualified name of the entity. Default value is None. + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n atlas_classification_array\ + \ = [\n {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"entityGuid\": \"\ + str\", # Optional. The GUID of the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of the entity - can be\n active or deleted.\ + \ Deleted entities are not removed from Atlas store. Known\n values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional. Determines if\n propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate the\ + \ source who create the\n classification detail.\n \"sourceDetails\"\ + : {\n \"str\": {} # Optional. more detail on source information.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name of the\ + \ type.\n \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the time\n \ + \ boundary.\n \"startTime\": \"str\", # Optional. The start\ + \ of the\n time boundary.\n \"timeZone\"\ + : \"str\" # Optional. The timezone of the\n time boundary.\n\ + \ }\n ]\n }\n ]\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.add_label + name: add_label + summary: add given labels to a given entity. + signature: 'add_label(guid: str, body: List[str] | None = None, **kwargs: Any) -> + None' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: body + description: set of labels to be added. Default value is None. + isRequired: true + types: + - [] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n body\ + \ = [\n \"str\" # Optional.\n ]\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.add_labels_by_unique_attribute + name: add_labels_by_unique_attribute + summary: 'Add given labels to a given entity identified by its type and unique attributes, + if labels is + + null/empty, no labels will be added. In addition to the typeName path parameter, + attribute + + key-value pair(s) can be provided in the following format: + + attr:``=:code:``. NOTE: The attrName and attrValue should + be unique + + across entities, eg. qualifiedName. The REST request would look something like + this: PUT + + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.' + signature: 'add_labels_by_unique_attribute(type_name: str, body: List[str] | None + = None, *, attr_qualified_name: str | None = None, **kwargs: Any) -> None' + parameters: + - name: type_name + description: The name of the type. + isRequired: true + types: + - + - name: body + description: set of labels to be added. Default value is None. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: attr_qualified_name + description: The qualified name of the entity. Default value is None. + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n body\ + \ = [\n \"str\" # Optional.\n ]\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.add_or_update_business_metadata + name: add_or_update_business_metadata + summary: Add business metadata to an entity. + signature: 'add_or_update_business_metadata(guid: str, body: Dict[str, Any] | None + = None, *, is_overwrite: bool | None = None, **kwargs: Any) -> None' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: body + description: Business Metadata. Default value is None. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: is_overwrite + description: 'Whether to overwrite the existing business metadata on the entity + or + + not, default is false.' + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n body\ + \ = {\n \"str\": {} # Optional.\n }\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.add_or_update_business_metadata_attributes + name: add_or_update_business_metadata_attributes + summary: Add or update business metadata attributes. + signature: 'add_or_update_business_metadata_attributes(bm_name: str, guid: str, + body: Dict[str, Any] | None = None, **kwargs: Any) -> None' + parameters: + - name: bm_name + description: BusinessMetadata name. + isRequired: true + types: + - + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: body + description: BusinessMetadataAttributes. Default value is None. + isRequired: true + types: + - [, ] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n body\ + \ = {\n \"str\": {} # Optional.\n }\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.create_or_update + name: create_or_update + summary: 'Create or update an entity in Atlas. + + Existing entity is matched using its unique guid if supplied or by its unique + attributes eg: + + qualifiedName. + + Map and array of collections are not well supported. E.g., array*>, + + array>.' + signature: 'create_or_update(entity: MutableMapping[str, Any], **kwargs: Any) -> + MutableMapping[str, Any]' + parameters: + - name: entity + description: Atlas entity with extended information. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n entity\ + \ = {\n \"entity\": {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \"\ + businessAttributes\": {\n \"str\": {} # Optional. Business Attributes.\n\ + \ },\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the\n struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional. The GUID of the\n\ + \ entity.\n \"entityStatus\": \"str\", \ + \ # Optional. Status of the\n entity - can be active or deleted.\ + \ Deleted entities are not removed\n from Atlas store. Known\ + \ values are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for\n concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the source who\n create the classification detail.\n\ + \ \"sourceDetails\": {\n \"str\": {} \ + \ # Optional. more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"validityPeriods\": [\n \ + \ {\n \"endTime\": \"str\", # Optional.\ + \ The\n end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n \ + \ start of the time boundary.\n \"timeZone\"\ + : \"str\" # Optional. The\n timezone of the time\ + \ boundary.\n }\n ]\n }\n\ + \ ],\n \"contacts\": {\n \"str\": [\n \ + \ {\n \"id\": \"str\", # Optional. Azure Active\n\ + \ Directory object Id.\n \"info\"\ + : \"str\" # Optional. additional\n information to describe\ + \ this contact.\n }\n ]\n },\n \ + \ \"createTime\": 0.0, # Optional. The created time of the record.\n \ + \ \"createdBy\": \"str\", # Optional. The user who created the record.\n\ + \ \"customAttributes\": {\n \"str\": \"str\" # Optional.\ + \ Custom Attribute.\n },\n \"guid\": \"str\", # Optional.\ + \ The GUID of the entity.\n \"homeId\": \"str\", # Optional. The home\ + \ ID of the entity.\n \"isIncomplete\": bool, # Optional. Whether it\ + \ is a shell entity.\n \"labels\": [\n \"str\" # Optional.\ + \ labels.\n ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"meanings\": [\n {\n\ + \ \"confidence\": 0, # Optional. The confidence of the\n \ + \ term assignment.\n \"createdBy\": \"str\"\ + , # Optional. The user who created\n the record.\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the term assignment.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n\ + \ relationship.\n \"source\": \"str\", \ + \ # Optional. The source of the term.\n \"status\": \"str\"\ + , # Optional. The status of terms\n assignment. Known values\ + \ are: \"DISCOVERED\", \"PROPOSED\", \"IMPORTED\",\n \"VALIDATED\"\ + , \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \"steward\": \"\ + str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, # Optional. Used\ + \ to record the provenance of\n an instance of an entity or relationship.\n\ + \ \"proxy\": bool, # Optional. Determines if there's a proxy.\n \ + \ \"relationshipAttributes\": {\n \"str\": {} # Optional.\ + \ The attributes of relationship.\n },\n \"source\": \"str\"\ + , # Optional. indicate the source who create the\n classification\ + \ detail.\n \"sourceDetails\": {\n \"str\": {} # Optional.\ + \ more detail on source information.\n },\n \"status\": \"\ + str\", # Optional. Status of the entity - can be active or\n deleted.\ + \ Deleted entities are not removed from Atlas store. Known values are:\n \ + \ \"ACTIVE\", \"DELETED\".\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the record.\n \"updatedBy\": \"str\", # Optional. The user\ + \ who updated the record.\n \"version\": 0.0 # Optional. The version\ + \ of the entity.\n },\n \"referredEntities\": {\n \"str\"\ + : {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"businessAttributes\"\ + : {\n \"str\": {} # Optional. Business Attributes.\n \ + \ },\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {}\ + \ # Optional. The attributes\n of the struct.\n \ + \ },\n \"entityGuid\": \"str\", #\ + \ Optional. The GUID of\n the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of\n \ + \ the entity - can be active or deleted. Deleted entities are not\n \ + \ removed from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag\n for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \"id\"\ + : \"str\", # Optional. Azure\n Active Directory object\ + \ Id.\n \"info\": \"str\" # Optional. additional\n\ + \ information to describe this contact.\n \ + \ }\n ]\n },\n \"\ + createTime\": 0.0, # Optional. The created time of the\n record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the\n\ + \ record.\n \"customAttributes\": {\n \ + \ \"str\": \"str\" # Optional. Custom Attribute.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"homeId\": \"str\", # Optional. The home ID of the entity.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a shell\n \ + \ entity.\n \"labels\": [\n \"str\"\ + \ # Optional. labels.\n ],\n \"lastModifiedTS\":\ + \ \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n }\n }\n\n # response body\ + \ for status code(s): 200\n response.json() == {\n \"guidAssignments\"\ + : {\n \"str\": \"str\" # Optional. A map of GUID assignments with entities.\n\ + \ },\n \"mutatedEntities\": {\n \"str\": [\n \ + \ {\n \"attributes\": {\n \"str\":\ + \ {} # Optional. The attributes of the\n struct.\n \ + \ },\n \"classificationNames\": [\n \ + \ \"str\" # Optional. An array of classification\n \ + \ names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n\ + \ \"str\": {} # Optional. The\n \ + \ attributes of the struct.\n },\n\ + \ \"entityGuid\": \"str\", # Optional. The\n \ + \ GUID of the entity.\n \"entityStatus\"\ + : \"str\", # Optional.\n Status of the entity - can\ + \ be active or deleted. Deleted\n entities are not\ + \ removed from Atlas store. Known values are:\n \"\ + ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional.\n ETag for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\":\n \ + \ bool, # Optional. Determines if propagations will be removed\n\ + \ on entity deletion.\n \ + \ \"source\": \"str\", # Optional.\n indicate the\ + \ source who create the classification detail.\n \"\ + sourceDetails\": {\n \"str\": {} # Optional. more\n\ + \ detail on source information.\n \ + \ },\n \"typeName\": \"str\", # Optional.\ + \ The\n name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\",\n # Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the\ + \ time boundary.\n }\n \ + \ ]\n }\n ],\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"guid\": \"str\"\ + , # Optional. The GUID of the record.\n \"isIncomplete\": bool,\ + \ # Optional. Whether it is a\n shell entity.\n \ + \ \"labels\": [\n \"str\" # Optional. labels.\n\ + \ ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for\n concurrency control.\n \"meaningNames\"\ + : [\n \"str\" # Optional. An array of meanings.\n \ + \ ],\n \"meanings\": [\n \ + \ {\n \"confidence\": 0, # Optional. The\n \ + \ confidence of the term assignment.\n \ + \ \"createdBy\": \"str\", # Optional. The\n \ + \ user who created the record.\n \"description\":\ + \ \"str\", # Optional.\n The description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional.\n\ + \ The display text.\n \"\ + expression\": \"str\", # Optional. The\n expression\ + \ of the term assignment.\n \"relationGuid\": \"str\"\ + , # Optional.\n The GUID of the relationship.\n \ + \ \"source\": \"str\", # Optional. The\n \ + \ source of the term.\n \"status\"\ + : \"str\", # Optional. The\n status of terms assignment.\ + \ Known values are: \"DISCOVERED\",\n \"PROPOSED\"\ + , \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\",\n \"\ + OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The\n steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The\n \ + \ GUID of the term.\n }\n ],\n \ + \ \"status\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\"\ + .\n \"typeName\": \"str\" # Optional. The name of the type.\n\ + \ }\n ]\n },\n \"partialUpdatedEntities\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"classificationNames\": [\n \"str\" # Optional. An\ + \ array of classification names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.create_or_update_entities + name: create_or_update_entities + summary: 'Create or update entities in Atlas in bulk. + + Existing entity is matched using its unique guid if supplied or by its unique + attributes eg: + + qualifiedName. + + Map and array of collections are not well supported. E.g., array*>, + + array>.' + signature: 'create_or_update_entities(entities: MutableMapping[str, Any], **kwargs: + Any) -> MutableMapping[str, Any]' + parameters: + - name: entities + description: An array of entities to create or update. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n entities\ + \ = {\n \"entities\": [\n {\n \"attributes\": {\n\ + \ \"str\": {} # Optional. The attributes of the struct.\n \ + \ },\n \"businessAttributes\": {\n \ + \ \"str\": {} # Optional. Business Attributes.\n },\n \ + \ \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\n\ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of\n the entity - can be active\ + \ or deleted. Deleted entities are not\n removed from\ + \ Atlas store. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag\n \ + \ for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, #\n Optional. Determines if propagations will\ + \ be removed on entity\n deletion.\n \ + \ \"source\": \"str\", # Optional. indicate the\n \ + \ source who create the classification detail.\n \"sourceDetails\"\ + : {\n \"str\": {} # Optional. more detail on\n \ + \ source information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"validityPeriods\": [\n\ + \ {\n \"endTime\": \"\ + str\", #\n Optional. The end of the time boundary.\n\ + \ \"startTime\": \"str\", #\n \ + \ Optional. The start of the time boundary.\n \ + \ \"timeZone\": \"str\" #\n Optional.\ + \ The timezone of the time boundary.\n }\n \ + \ ]\n }\n ],\n \"contacts\"\ + : {\n \"str\": [\n {\n \ + \ \"id\": \"str\", # Optional. Azure\n \ + \ Active Directory object Id.\n \"info\": \"str\" \ + \ # Optional. additional\n information to describe\ + \ this contact.\n }\n ]\n \ + \ },\n \"createTime\": 0.0, # Optional. The created time of the\n\ + \ record.\n \"createdBy\": \"str\", # Optional.\ + \ The user who created the\n record.\n \"customAttributes\"\ + : {\n \"str\": \"str\" # Optional. Custom Attribute.\n \ + \ },\n \"guid\": \"str\", # Optional. The GUID of the\ + \ entity.\n \"homeId\": \"str\", # Optional. The home ID of the\ + \ entity.\n \"isIncomplete\": bool, # Optional. Whether it is a\ + \ shell\n entity.\n \"labels\": [\n \ + \ \"str\" # Optional. labels.\n ],\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n ],\n \"referredEntities\"\ + : {\n \"str\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"businessAttributes\": {\n \"str\": {} # Optional.\ + \ Business Attributes.\n },\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \"id\"\ + : \"str\", # Optional. Azure\n Active Directory object\ + \ Id.\n \"info\": \"str\" # Optional. additional\n\ + \ information to describe this contact.\n \ + \ }\n ]\n },\n \"\ + createTime\": 0.0, # Optional. The created time of the\n record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the\n\ + \ record.\n \"customAttributes\": {\n \ + \ \"str\": \"str\" # Optional. Custom Attribute.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"homeId\": \"str\", # Optional. The home ID of the entity.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a shell\n \ + \ entity.\n \"labels\": [\n \"str\"\ + \ # Optional. labels.\n ],\n \"lastModifiedTS\":\ + \ \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n }\n }\n\n # response body\ + \ for status code(s): 200\n response.json() == {\n \"guidAssignments\"\ + : {\n \"str\": \"str\" # Optional. A map of GUID assignments with entities.\n\ + \ },\n \"mutatedEntities\": {\n \"str\": [\n \ + \ {\n \"attributes\": {\n \"str\":\ + \ {} # Optional. The attributes of the\n struct.\n \ + \ },\n \"classificationNames\": [\n \ + \ \"str\" # Optional. An array of classification\n \ + \ names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n\ + \ \"str\": {} # Optional. The\n \ + \ attributes of the struct.\n },\n\ + \ \"entityGuid\": \"str\", # Optional. The\n \ + \ GUID of the entity.\n \"entityStatus\"\ + : \"str\", # Optional.\n Status of the entity - can\ + \ be active or deleted. Deleted\n entities are not\ + \ removed from Atlas store. Known values are:\n \"\ + ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional.\n ETag for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\":\n \ + \ bool, # Optional. Determines if propagations will be removed\n\ + \ on entity deletion.\n \ + \ \"source\": \"str\", # Optional.\n indicate the\ + \ source who create the classification detail.\n \"\ + sourceDetails\": {\n \"str\": {} # Optional. more\n\ + \ detail on source information.\n \ + \ },\n \"typeName\": \"str\", # Optional.\ + \ The\n name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\",\n # Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the\ + \ time boundary.\n }\n \ + \ ]\n }\n ],\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"guid\": \"str\"\ + , # Optional. The GUID of the record.\n \"isIncomplete\": bool,\ + \ # Optional. Whether it is a\n shell entity.\n \ + \ \"labels\": [\n \"str\" # Optional. labels.\n\ + \ ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for\n concurrency control.\n \"meaningNames\"\ + : [\n \"str\" # Optional. An array of meanings.\n \ + \ ],\n \"meanings\": [\n \ + \ {\n \"confidence\": 0, # Optional. The\n \ + \ confidence of the term assignment.\n \ + \ \"createdBy\": \"str\", # Optional. The\n \ + \ user who created the record.\n \"description\":\ + \ \"str\", # Optional.\n The description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional.\n\ + \ The display text.\n \"\ + expression\": \"str\", # Optional. The\n expression\ + \ of the term assignment.\n \"relationGuid\": \"str\"\ + , # Optional.\n The GUID of the relationship.\n \ + \ \"source\": \"str\", # Optional. The\n \ + \ source of the term.\n \"status\"\ + : \"str\", # Optional. The\n status of terms assignment.\ + \ Known values are: \"DISCOVERED\",\n \"PROPOSED\"\ + , \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\",\n \"\ + OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The\n steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The\n \ + \ GUID of the term.\n }\n ],\n \ + \ \"status\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\"\ + .\n \"typeName\": \"str\" # Optional. The name of the type.\n\ + \ }\n ]\n },\n \"partialUpdatedEntities\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"classificationNames\": [\n \"str\" # Optional. An\ + \ array of classification names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.delete_business_metadata + name: delete_business_metadata + summary: Remove business metadata from an entity. + signature: 'delete_business_metadata(guid: str, body: Dict[str, Any] | None = None, + **kwargs: Any) -> None' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: body + description: BusinessMetadata. Default value is None. + isRequired: true + types: + - [, ] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n body\ + \ = {\n \"str\": {} # Optional.\n }\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.delete_business_metadata_attributes + name: delete_business_metadata_attributes + summary: Delete business metadata attributes from an entity. + signature: 'delete_business_metadata_attributes(bm_name: str, guid: str, body: Dict[str, + Any] | None = None, **kwargs: Any) -> None' + parameters: + - name: bm_name + description: BusinessMetadata name. + isRequired: true + types: + - + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: body + description: BusinessMetadataAttributes. Default value is None. + isRequired: true + types: + - [, ] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n body\ + \ = {\n \"str\": {} # Optional.\n }\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.delete_by_guid + name: delete_by_guid + summary: Delete an entity identified by its GUID. + signature: 'delete_by_guid(guid: str, **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + guidAssignments\": {\n \"str\": \"str\" # Optional. A map of GUID assignments\ + \ with entities.\n },\n \"mutatedEntities\": {\n \"str\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"classificationNames\"\ + : [\n \"str\" # Optional. An array of classification\n\ + \ names.\n ],\n \"\ + classifications\": [\n {\n \"\ + attributes\": {\n \"str\": {} # Optional. The\n\ + \ attributes of the struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional.\ + \ The\n GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional.\n \ + \ Status of the entity - can be active or deleted. Deleted\n \ + \ entities are not removed from Atlas store. Known values are:\n \ + \ \"ACTIVE\", \"DELETED\".\n \ + \ \"lastModifiedTS\": \"str\", # Optional.\n ETag\ + \ for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + :\n bool, # Optional. Determines if propagations\ + \ will be removed\n on entity deletion.\n \ + \ \"source\": \"str\", # Optional.\n \ + \ indicate the source who create the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\"\ + : {} # Optional. more\n detail on source information.\n\ + \ },\n \"typeName\": \"str\"\ + , # Optional. The\n name of the type.\n \ + \ \"validityPeriods\": [\n {\n\ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\",\n \ + \ # Optional. The start of the time boundary.\n \ + \ \"timeZone\": \"str\" #\n Optional.\ + \ The timezone of the time boundary.\n }\n \ + \ ]\n }\n ],\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"guid\": \"str\", # Optional. The GUID of the record.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a\n \ + \ shell entity.\n \"labels\": [\n \ + \ \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for\n \ + \ concurrency control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n \ + \ ],\n \"meanings\": [\n {\n \ + \ \"confidence\": 0, # Optional. The\n \ + \ confidence of the term assignment.\n \"createdBy\"\ + : \"str\", # Optional. The\n user who created the\ + \ record.\n \"description\": \"str\", # Optional.\n\ + \ The description of the term assignment.\n \ + \ \"displayText\": \"str\", # Optional.\n \ + \ The display text.\n \"expression\": \"\ + str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional.\n \ + \ The GUID of the relationship.\n \ + \ \"source\": \"str\", # Optional. The\n source\ + \ of the term.\n \"status\": \"str\", # Optional. The\n\ + \ status of terms assignment. Known values are: \"\ + DISCOVERED\",\n \"PROPOSED\", \"IMPORTED\", \"VALIDATED\"\ + , \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The\n \ + \ steward of the term.\n \"termGuid\"\ + : \"str\" # Optional. The\n GUID of the term.\n \ + \ }\n ],\n \"status\"\ + : \"str\", # Optional. Status of the entity -\n can be active\ + \ or deleted. Deleted entities are not removed from Atlas\n \ + \ store. Known values are: \"ACTIVE\", \"DELETED\".\n \"typeName\"\ + : \"str\" # Optional. The name of the type.\n }\n ]\n\ + \ },\n \"partialUpdatedEntities\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"classificationNames\": [\n\ + \ \"str\" # Optional. An array of classification names.\n \ + \ ],\n \"classifications\": [\n {\n\ + \ \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes\n of the struct.\n\ + \ },\n \"entityGuid\": \"str\", #\ + \ Optional. The GUID of\n the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of\n \ + \ the entity - can be active or deleted. Deleted entities are not\n \ + \ removed from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag\n for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.delete_by_guids + name: delete_by_guids + summary: Delete a list of entities in bulk identified by their GUIDs or unique attributes. + signature: 'delete_by_guids(*, guids: List[str], **kwargs: Any) -> MutableMapping[str, + Any]' + keywordOnlyParameters: + - name: guids + description: An array of GUIDs of entities to delete. + types: + - [] + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + guidAssignments\": {\n \"str\": \"str\" # Optional. A map of GUID assignments\ + \ with entities.\n },\n \"mutatedEntities\": {\n \"str\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"classificationNames\"\ + : [\n \"str\" # Optional. An array of classification\n\ + \ names.\n ],\n \"\ + classifications\": [\n {\n \"\ + attributes\": {\n \"str\": {} # Optional. The\n\ + \ attributes of the struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional.\ + \ The\n GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional.\n \ + \ Status of the entity - can be active or deleted. Deleted\n \ + \ entities are not removed from Atlas store. Known values are:\n \ + \ \"ACTIVE\", \"DELETED\".\n \ + \ \"lastModifiedTS\": \"str\", # Optional.\n ETag\ + \ for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + :\n bool, # Optional. Determines if propagations\ + \ will be removed\n on entity deletion.\n \ + \ \"source\": \"str\", # Optional.\n \ + \ indicate the source who create the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\"\ + : {} # Optional. more\n detail on source information.\n\ + \ },\n \"typeName\": \"str\"\ + , # Optional. The\n name of the type.\n \ + \ \"validityPeriods\": [\n {\n\ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\",\n \ + \ # Optional. The start of the time boundary.\n \ + \ \"timeZone\": \"str\" #\n Optional.\ + \ The timezone of the time boundary.\n }\n \ + \ ]\n }\n ],\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"guid\": \"str\", # Optional. The GUID of the record.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a\n \ + \ shell entity.\n \"labels\": [\n \ + \ \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for\n \ + \ concurrency control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n \ + \ ],\n \"meanings\": [\n {\n \ + \ \"confidence\": 0, # Optional. The\n \ + \ confidence of the term assignment.\n \"createdBy\"\ + : \"str\", # Optional. The\n user who created the\ + \ record.\n \"description\": \"str\", # Optional.\n\ + \ The description of the term assignment.\n \ + \ \"displayText\": \"str\", # Optional.\n \ + \ The display text.\n \"expression\": \"\ + str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional.\n \ + \ The GUID of the relationship.\n \ + \ \"source\": \"str\", # Optional. The\n source\ + \ of the term.\n \"status\": \"str\", # Optional. The\n\ + \ status of terms assignment. Known values are: \"\ + DISCOVERED\",\n \"PROPOSED\", \"IMPORTED\", \"VALIDATED\"\ + , \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The\n \ + \ steward of the term.\n \"termGuid\"\ + : \"str\" # Optional. The\n GUID of the term.\n \ + \ }\n ],\n \"status\"\ + : \"str\", # Optional. Status of the entity -\n can be active\ + \ or deleted. Deleted entities are not removed from Atlas\n \ + \ store. Known values are: \"ACTIVE\", \"DELETED\".\n \"typeName\"\ + : \"str\" # Optional. The name of the type.\n }\n ]\n\ + \ },\n \"partialUpdatedEntities\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"classificationNames\": [\n\ + \ \"str\" # Optional. An array of classification names.\n \ + \ ],\n \"classifications\": [\n {\n\ + \ \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes\n of the struct.\n\ + \ },\n \"entityGuid\": \"str\", #\ + \ Optional. The GUID of\n the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of\n \ + \ the entity - can be active or deleted. Deleted entities are not\n \ + \ removed from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag\n for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.delete_by_unique_attribute + name: delete_by_unique_attribute + summary: 'Delete an entity identified by its type and unique attributes. + + In addition to the typeName path parameter, attribute key-value pair(s) can be + provided in the + + following format: + + attr::code:*`=:code:`*. + + NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. + + The REST request would look something like this: + + DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.' + signature: 'delete_by_unique_attribute(type_name: str, *, attr_qualified_name: str + | None = None, **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: type_name + description: The name of the type. + isRequired: true + types: + - + keywordOnlyParameters: + - name: attr_qualified_name + description: The qualified name of the entity. Default value is None. + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + guidAssignments\": {\n \"str\": \"str\" # Optional. A map of GUID assignments\ + \ with entities.\n },\n \"mutatedEntities\": {\n \"str\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"classificationNames\"\ + : [\n \"str\" # Optional. An array of classification\n\ + \ names.\n ],\n \"\ + classifications\": [\n {\n \"\ + attributes\": {\n \"str\": {} # Optional. The\n\ + \ attributes of the struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional.\ + \ The\n GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional.\n \ + \ Status of the entity - can be active or deleted. Deleted\n \ + \ entities are not removed from Atlas store. Known values are:\n \ + \ \"ACTIVE\", \"DELETED\".\n \ + \ \"lastModifiedTS\": \"str\", # Optional.\n ETag\ + \ for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + :\n bool, # Optional. Determines if propagations\ + \ will be removed\n on entity deletion.\n \ + \ \"source\": \"str\", # Optional.\n \ + \ indicate the source who create the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\"\ + : {} # Optional. more\n detail on source information.\n\ + \ },\n \"typeName\": \"str\"\ + , # Optional. The\n name of the type.\n \ + \ \"validityPeriods\": [\n {\n\ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\",\n \ + \ # Optional. The start of the time boundary.\n \ + \ \"timeZone\": \"str\" #\n Optional.\ + \ The timezone of the time boundary.\n }\n \ + \ ]\n }\n ],\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"guid\": \"str\", # Optional. The GUID of the record.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a\n \ + \ shell entity.\n \"labels\": [\n \ + \ \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for\n \ + \ concurrency control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n \ + \ ],\n \"meanings\": [\n {\n \ + \ \"confidence\": 0, # Optional. The\n \ + \ confidence of the term assignment.\n \"createdBy\"\ + : \"str\", # Optional. The\n user who created the\ + \ record.\n \"description\": \"str\", # Optional.\n\ + \ The description of the term assignment.\n \ + \ \"displayText\": \"str\", # Optional.\n \ + \ The display text.\n \"expression\": \"\ + str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional.\n \ + \ The GUID of the relationship.\n \ + \ \"source\": \"str\", # Optional. The\n source\ + \ of the term.\n \"status\": \"str\", # Optional. The\n\ + \ status of terms assignment. Known values are: \"\ + DISCOVERED\",\n \"PROPOSED\", \"IMPORTED\", \"VALIDATED\"\ + , \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The\n \ + \ steward of the term.\n \"termGuid\"\ + : \"str\" # Optional. The\n GUID of the term.\n \ + \ }\n ],\n \"status\"\ + : \"str\", # Optional. Status of the entity -\n can be active\ + \ or deleted. Deleted entities are not removed from Atlas\n \ + \ store. Known values are: \"ACTIVE\", \"DELETED\".\n \"typeName\"\ + : \"str\" # Optional. The name of the type.\n }\n ]\n\ + \ },\n \"partialUpdatedEntities\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"classificationNames\": [\n\ + \ \"str\" # Optional. An array of classification names.\n \ + \ ],\n \"classifications\": [\n {\n\ + \ \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes\n of the struct.\n\ + \ },\n \"entityGuid\": \"str\", #\ + \ Optional. The GUID of\n the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of\n \ + \ the entity - can be active or deleted. Deleted entities are not\n \ + \ removed from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag\n for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.delete_classification + name: delete_classification + summary: Delete a given classification from an existing entity represented by a + GUID. + signature: 'delete_classification(guid: str, classification_name: str, **kwargs: + Any) -> None' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: classification_name + description: The name of the classification. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.purview.catalog.operations.EntityOperations.delete_classification_by_unique_attribute + name: delete_classification_by_unique_attribute + summary: Delete a given classification from an entity identified by its type and + unique attributes. + signature: 'delete_classification_by_unique_attribute(type_name: str, classification_name: + str, *, attr_qualified_name: str | None = None, **kwargs: Any) -> None' + parameters: + - name: type_name + description: The name of the type. + isRequired: true + types: + - + - name: classification_name + description: The name of the classification. + isRequired: true + types: + - + keywordOnlyParameters: + - name: attr_qualified_name + description: The qualified name of the entity. Default value is None. + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.purview.catalog.operations.EntityOperations.delete_labels + name: delete_labels + summary: delete given labels to a given entity. + signature: 'delete_labels(guid: str, body: List[str] | None = None, **kwargs: Any) + -> None' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: body + description: set of labels to be deleted. Default value is None. + isRequired: true + types: + - [] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n body\ + \ = [\n \"str\" # Optional.\n ]\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.delete_labels_by_unique_attribute + name: delete_labels_by_unique_attribute + summary: 'Delete given labels to a given entity identified by its type and unique + attributes, if labels + + is null/empty, no labels will be removed. If any labels in labels set are non-existing + labels, + + they will be ignored, only existing labels will be removed. In addition to the + typeName path + + parameter, attribute key-value pair(s) can be provided in the following format: + + attr:``=:code:``. NOTE: The attrName and attrValue should + be unique + + across entities, eg. qualifiedName. The REST request would look something like + this: DELETE + + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.' + signature: 'delete_labels_by_unique_attribute(type_name: str, body: List[str] | + None = None, *, attr_qualified_name: str | None = None, **kwargs: Any) -> None' + parameters: + - name: type_name + description: The name of the type. + isRequired: true + types: + - + - name: body + description: set of labels to be deleted. Default value is None. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: attr_qualified_name + description: The qualified name of the entity. Default value is None. + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n body\ + \ = [\n \"str\" # Optional.\n ]\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.get_by_guid + name: get_by_guid + summary: Get complete definition of an entity given its GUID. + signature: 'get_by_guid(guid: str, *, min_ext_info: bool | None = False, ignore_relationships: + bool | None = False, **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + keywordOnlyParameters: + - name: min_ext_info + description: 'Whether to return minimal information for referred entities. Default + + value is False.' + types: + - + - name: ignore_relationships + description: 'Whether to ignore relationship attributes. Default value is + + False.' + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + entity\": {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"businessAttributes\"\ + : {\n \"str\": {} # Optional. Business Attributes.\n \ + \ },\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the\n struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the\n \ + \ entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of the\n entity - can be active or deleted. Deleted\ + \ entities are not removed\n from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag for\n concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who\n create the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional.\ + \ more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n \ + \ {\n \"endTime\": \"str\", # Optional. The\n \ + \ end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n start\ + \ of the time boundary.\n \"timeZone\": \"str\" # Optional.\ + \ The\n timezone of the time boundary.\n \ + \ }\n ]\n }\n ],\n \ + \ \"contacts\": {\n \"str\": [\n {\n \ + \ \"id\": \"str\", # Optional. Azure Active\n \ + \ Directory object Id.\n \"info\": \"str\" \ + \ # Optional. additional\n information to describe this\ + \ contact.\n }\n ]\n },\n \ + \ \"createTime\": 0.0, # Optional. The created time of the record.\n \ + \ \"createdBy\": \"str\", # Optional. The user who created the record.\n \ + \ \"customAttributes\": {\n \"str\": \"str\" # Optional.\ + \ Custom Attribute.\n },\n \"guid\": \"str\", # Optional.\ + \ The GUID of the entity.\n \"homeId\": \"str\", # Optional. The home\ + \ ID of the entity.\n \"isIncomplete\": bool, # Optional. Whether it\ + \ is a shell entity.\n \"labels\": [\n \"str\" # Optional.\ + \ labels.\n ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"meanings\": [\n {\n\ + \ \"confidence\": 0, # Optional. The confidence of the\n \ + \ term assignment.\n \"createdBy\": \"str\"\ + , # Optional. The user who created\n the record.\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the term assignment.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n\ + \ relationship.\n \"source\": \"str\", \ + \ # Optional. The source of the term.\n \"status\": \"str\"\ + , # Optional. The status of terms\n assignment. Known values\ + \ are: \"DISCOVERED\", \"PROPOSED\", \"IMPORTED\",\n \"VALIDATED\"\ + , \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \"steward\": \"\ + str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, # Optional. Used\ + \ to record the provenance of\n an instance of an entity or relationship.\n\ + \ \"proxy\": bool, # Optional. Determines if there's a proxy.\n \ + \ \"relationshipAttributes\": {\n \"str\": {} # Optional.\ + \ The attributes of relationship.\n },\n \"source\": \"str\"\ + , # Optional. indicate the source who create the\n classification\ + \ detail.\n \"sourceDetails\": {\n \"str\": {} # Optional.\ + \ more detail on source information.\n },\n \"status\": \"\ + str\", # Optional. Status of the entity - can be active or\n deleted.\ + \ Deleted entities are not removed from Atlas store. Known values are:\n \ + \ \"ACTIVE\", \"DELETED\".\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the record.\n \"updatedBy\": \"str\", # Optional. The user\ + \ who updated the record.\n \"version\": 0.0 # Optional. The version\ + \ of the entity.\n },\n \"referredEntities\": {\n \"str\"\ + : {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"businessAttributes\"\ + : {\n \"str\": {} # Optional. Business Attributes.\n \ + \ },\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {}\ + \ # Optional. The attributes\n of the struct.\n \ + \ },\n \"entityGuid\": \"str\", #\ + \ Optional. The GUID of\n the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of\n \ + \ the entity - can be active or deleted. Deleted entities are not\n \ + \ removed from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag\n for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \"id\"\ + : \"str\", # Optional. Azure\n Active Directory object\ + \ Id.\n \"info\": \"str\" # Optional. additional\n\ + \ information to describe this contact.\n \ + \ }\n ]\n },\n \"\ + createTime\": 0.0, # Optional. The created time of the\n record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the\n\ + \ record.\n \"customAttributes\": {\n \ + \ \"str\": \"str\" # Optional. Custom Attribute.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"homeId\": \"str\", # Optional. The home ID of the entity.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a shell\n \ + \ entity.\n \"labels\": [\n \"str\"\ + \ # Optional. labels.\n ],\n \"lastModifiedTS\":\ + \ \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n }\n }\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.get_by_unique_attributes + name: get_by_unique_attributes + summary: 'Get complete definition of an entity given its type and unique attribute. + + In addition to the typeName path parameter, attribute key-value pair(s) can be + provided in the + + following format: + + attr::code:*`=:code:`*. + + NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. + + The REST request would look something like this: + + GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.' + signature: 'get_by_unique_attributes(type_name: str, *, min_ext_info: bool | None + = False, ignore_relationships: bool | None = False, attr_qualified_name: str | + None = None, **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: type_name + description: The name of the type. + isRequired: true + types: + - + keywordOnlyParameters: + - name: min_ext_info + description: 'Whether to return minimal information for referred entities. Default + + value is False.' + types: + - + - name: ignore_relationships + description: 'Whether to ignore relationship attributes. Default value is + + False.' + types: + - + - name: attr_qualified_name + description: The qualified name of the entity. Default value is None. + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + entity\": {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"businessAttributes\"\ + : {\n \"str\": {} # Optional. Business Attributes.\n \ + \ },\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the\n struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the\n \ + \ entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of the\n entity - can be active or deleted. Deleted\ + \ entities are not removed\n from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag for\n concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who\n create the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional.\ + \ more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n \ + \ {\n \"endTime\": \"str\", # Optional. The\n \ + \ end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n start\ + \ of the time boundary.\n \"timeZone\": \"str\" # Optional.\ + \ The\n timezone of the time boundary.\n \ + \ }\n ]\n }\n ],\n \ + \ \"contacts\": {\n \"str\": [\n {\n \ + \ \"id\": \"str\", # Optional. Azure Active\n \ + \ Directory object Id.\n \"info\": \"str\" \ + \ # Optional. additional\n information to describe this\ + \ contact.\n }\n ]\n },\n \ + \ \"createTime\": 0.0, # Optional. The created time of the record.\n \ + \ \"createdBy\": \"str\", # Optional. The user who created the record.\n \ + \ \"customAttributes\": {\n \"str\": \"str\" # Optional.\ + \ Custom Attribute.\n },\n \"guid\": \"str\", # Optional.\ + \ The GUID of the entity.\n \"homeId\": \"str\", # Optional. The home\ + \ ID of the entity.\n \"isIncomplete\": bool, # Optional. Whether it\ + \ is a shell entity.\n \"labels\": [\n \"str\" # Optional.\ + \ labels.\n ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"meanings\": [\n {\n\ + \ \"confidence\": 0, # Optional. The confidence of the\n \ + \ term assignment.\n \"createdBy\": \"str\"\ + , # Optional. The user who created\n the record.\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the term assignment.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n\ + \ relationship.\n \"source\": \"str\", \ + \ # Optional. The source of the term.\n \"status\": \"str\"\ + , # Optional. The status of terms\n assignment. Known values\ + \ are: \"DISCOVERED\", \"PROPOSED\", \"IMPORTED\",\n \"VALIDATED\"\ + , \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \"steward\": \"\ + str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, # Optional. Used\ + \ to record the provenance of\n an instance of an entity or relationship.\n\ + \ \"proxy\": bool, # Optional. Determines if there's a proxy.\n \ + \ \"relationshipAttributes\": {\n \"str\": {} # Optional.\ + \ The attributes of relationship.\n },\n \"source\": \"str\"\ + , # Optional. indicate the source who create the\n classification\ + \ detail.\n \"sourceDetails\": {\n \"str\": {} # Optional.\ + \ more detail on source information.\n },\n \"status\": \"\ + str\", # Optional. Status of the entity - can be active or\n deleted.\ + \ Deleted entities are not removed from Atlas store. Known values are:\n \ + \ \"ACTIVE\", \"DELETED\".\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the record.\n \"updatedBy\": \"str\", # Optional. The user\ + \ who updated the record.\n \"version\": 0.0 # Optional. The version\ + \ of the entity.\n },\n \"referredEntities\": {\n \"str\"\ + : {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"businessAttributes\"\ + : {\n \"str\": {} # Optional. Business Attributes.\n \ + \ },\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {}\ + \ # Optional. The attributes\n of the struct.\n \ + \ },\n \"entityGuid\": \"str\", #\ + \ Optional. The GUID of\n the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of\n \ + \ the entity - can be active or deleted. Deleted entities are not\n \ + \ removed from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag\n for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \"id\"\ + : \"str\", # Optional. Azure\n Active Directory object\ + \ Id.\n \"info\": \"str\" # Optional. additional\n\ + \ information to describe this contact.\n \ + \ }\n ]\n },\n \"\ + createTime\": 0.0, # Optional. The created time of the\n record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the\n\ + \ record.\n \"customAttributes\": {\n \ + \ \"str\": \"str\" # Optional. Custom Attribute.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"homeId\": \"str\", # Optional. The home ID of the entity.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a shell\n \ + \ entity.\n \"labels\": [\n \"str\"\ + \ # Optional. labels.\n ],\n \"lastModifiedTS\":\ + \ \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n }\n }\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.get_classification + name: get_classification + summary: List classifications for a given entity represented by a GUID. + signature: 'get_classification(guid: str, classification_name: str, **kwargs: Any) + -> MutableMapping[str, Any]' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: classification_name + description: The name of the classification. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributes\": {\n \"str\": {} # Optional. The attributes of the struct.\n\ + \ },\n \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n\ + \ \"entityStatus\": \"str\", # Optional. Status of the entity - can be\ + \ active or\n deleted. Deleted entities are not removed from Atlas store.\ + \ Known values are:\n \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional. Determines if\n propagations will be removed on entity\ + \ deletion.\n \"source\": \"str\", # Optional. indicate the source who\ + \ create the\n classification detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on source information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \"endTime\": \"str\"\ + , # Optional. The end of the time boundary.\n \"startTime\": \"\ + str\", # Optional. The start of the time\n boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone of the time\n \ + \ boundary.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.get_classifications + name: get_classifications + summary: List classifications for a given entity represented by a GUID. + signature: 'get_classifications(guid: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + list\": [\n {} # Optional. An array of objects.\n ],\n \ + \ \"pageSize\": 0, # Optional. The size of the page.\n \"sortBy\": \"str\"\ + , # Optional. The sorted by field.\n \"sortType\": \"str\", # Optional.\ + \ to specify whether the result should be\n sorted? If yes, whether asc\ + \ or desc. Known values are: \"NONE\", \"ASC\", \"DESC\".\n \"startIndex\"\ + : 0.0, # Optional. The start index of the page.\n \"totalCount\": 0.0 \ + \ # Optional. The total count of items.\n }\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.get_entities_by_unique_attributes + name: get_entities_by_unique_attributes + summary: 'Bulk API to retrieve list of entities identified by its unique attributes. + + + In addition to the typeName path parameter, attribute key-value pair(s) can be + provided in the + + following format + + + typeName=:code:*`&attr_1::code:``=:code:``&attr_2::code:``=:code:``&attr_3::code:``=:code:`* + + + NOTE: The attrName should be an unique attribute for the given entity-type + + + The REST request would look something like this + + + GET + + /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_0::.' + signature: 'get_entities_by_unique_attributes(type_name: str, *, min_ext_info: bool + | None = False, ignore_relationships: bool | None = False, attr_n_qualified_name: + str | None = None, **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: type_name + description: The name of the type. + isRequired: true + types: + - + keywordOnlyParameters: + - name: min_ext_info + description: 'Whether to return minimal information for referred entities. Default + + value is False.' + types: + - + - name: ignore_relationships + description: 'Whether to ignore relationship attributes. Default value is + + False.' + types: + - + - name: attr_n_qualified_name + description: 'Qualified name of an entity. E.g. to find 2 entities you can + + set attrs_0::. + Default value is None.' + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + entities\": [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"businessAttributes\": {\n \"str\": {} # Optional.\ + \ Business Attributes.\n },\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \"id\"\ + : \"str\", # Optional. Azure\n Active Directory object\ + \ Id.\n \"info\": \"str\" # Optional. additional\n\ + \ information to describe this contact.\n \ + \ }\n ]\n },\n \"\ + createTime\": 0.0, # Optional. The created time of the\n record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the\n\ + \ record.\n \"customAttributes\": {\n \ + \ \"str\": \"str\" # Optional. Custom Attribute.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"homeId\": \"str\", # Optional. The home ID of the entity.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a shell\n \ + \ entity.\n \"labels\": [\n \"str\"\ + \ # Optional. labels.\n ],\n \"lastModifiedTS\":\ + \ \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n ],\n \"referredEntities\"\ + : {\n \"str\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"businessAttributes\": {\n \"str\": {} # Optional.\ + \ Business Attributes.\n },\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \"id\"\ + : \"str\", # Optional. Azure\n Active Directory object\ + \ Id.\n \"info\": \"str\" # Optional. additional\n\ + \ information to describe this contact.\n \ + \ }\n ]\n },\n \"\ + createTime\": 0.0, # Optional. The created time of the\n record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the\n\ + \ record.\n \"customAttributes\": {\n \ + \ \"str\": \"str\" # Optional. Custom Attribute.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"homeId\": \"str\", # Optional. The home ID of the entity.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a shell\n \ + \ entity.\n \"labels\": [\n \"str\"\ + \ # Optional. labels.\n ],\n \"lastModifiedTS\":\ + \ \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n }\n }\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.get_header + name: get_header + summary: Get entity header given its GUID. + signature: 'get_header(guid: str, **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributes\": {\n \"str\": {} # Optional. The attributes of the struct.\n\ + \ },\n \"classificationNames\": [\n \"str\" # Optional.\ + \ An array of classification names.\n ],\n \"classifications\": [\n\ + \ {\n \"attributes\": {\n \"str\": {}\ + \ # Optional. The attributes of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from Atlas\n\ + \ store. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"removePropagationsOnEntityDelete\": bool,\ + \ # Optional.\n Determines if propagations will be removed on\ + \ entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"guid\": \"str\", # Optional. The GUID of the record.\n \"isIncomplete\"\ + : bool, # Optional. Whether it is a shell entity.\n \"labels\": [\n \ + \ \"str\" # Optional. labels.\n ],\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag for concurrency control.\n \"meaningNames\": [\n\ + \ \"str\" # Optional. An array of meanings.\n ],\n \"meanings\"\ + : [\n {\n \"confidence\": 0, # Optional. The confidence\ + \ of the term\n assignment.\n \"createdBy\": \"\ + str\", # Optional. The user who created the\n record.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ term assignment.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term\n assignment.\n \"relationGuid\"\ + : \"str\", # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of terms assignment.\n\ + \ Known values are: \"DISCOVERED\", \"PROPOSED\", \"IMPORTED\"\ + , \"VALIDATED\",\n \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n\ + \ \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional. Status of the\ + \ entity - can be active or\n deleted. Deleted entities are not removed\ + \ from Atlas store. Known values are:\n \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\" # Optional. The name of the type.\n }\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.get_sample_business_metadata_template + name: get_sample_business_metadata_template + summary: Get the sample Template for uploading/creating bulk BusinessMetaData. + signature: 'get_sample_business_metadata_template(**kwargs: Any) -> IO' + return: + description: IO + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.purview.catalog.operations.EntityOperations.import_business_metadata + name: import_business_metadata + signature: import_business_metadata(*args, **kwargs) -> MutableMapping[str, Any] +- uid: azure.purview.catalog.operations.EntityOperations.list_by_guids + name: list_by_guids + summary: List entities in bulk identified by its GUIDs. + signature: 'list_by_guids(*, guids: List[str], min_ext_info: bool | None = False, + ignore_relationships: bool | None = False, exclude_relationship_types: List[str] + | None = None, **kwargs: Any) -> MutableMapping[str, Any]' + keywordOnlyParameters: + - name: guids + description: An array of GUIDs of entities to list. + types: + - [] + - name: min_ext_info + description: 'Whether to return minimal information for referred entities. Default + + value is False.' + types: + - + - name: ignore_relationships + description: 'Whether to ignore relationship attributes. Default value is + + False.' + types: + - + - name: exclude_relationship_types + description: 'An array of the relationship types need to be excluded + + from the response. Default value is None.' + types: + - [] + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + entities\": [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"businessAttributes\": {\n \"str\": {} # Optional.\ + \ Business Attributes.\n },\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \"id\"\ + : \"str\", # Optional. Azure\n Active Directory object\ + \ Id.\n \"info\": \"str\" # Optional. additional\n\ + \ information to describe this contact.\n \ + \ }\n ]\n },\n \"\ + createTime\": 0.0, # Optional. The created time of the\n record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the\n\ + \ record.\n \"customAttributes\": {\n \ + \ \"str\": \"str\" # Optional. Custom Attribute.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"homeId\": \"str\", # Optional. The home ID of the entity.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a shell\n \ + \ entity.\n \"labels\": [\n \"str\"\ + \ # Optional. labels.\n ],\n \"lastModifiedTS\":\ + \ \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n ],\n \"referredEntities\"\ + : {\n \"str\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"businessAttributes\": {\n \"str\": {} # Optional.\ + \ Business Attributes.\n },\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \"id\"\ + : \"str\", # Optional. Azure\n Active Directory object\ + \ Id.\n \"info\": \"str\" # Optional. additional\n\ + \ information to describe this contact.\n \ + \ }\n ]\n },\n \"\ + createTime\": 0.0, # Optional. The created time of the\n record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the\n\ + \ record.\n \"customAttributes\": {\n \ + \ \"str\": \"str\" # Optional. Custom Attribute.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"homeId\": \"str\", # Optional. The home ID of the entity.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a shell\n \ + \ entity.\n \"labels\": [\n \"str\"\ + \ # Optional. labels.\n ],\n \"lastModifiedTS\":\ + \ \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n }\n }\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.partial_update_entity_attribute_by_guid + name: partial_update_entity_attribute_by_guid + summary: 'Update entity partially - create or update entity attribute identified + by its GUID. + + Supports only primitive attribute type and entity references. + + It does not support updating complex types like arrays, and maps. + + Null updates are not possible.' + signature: 'partial_update_entity_attribute_by_guid(guid: str, body: Any, *, name: + str, **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: body + description: The value of the attribute. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + description: The name of the attribute. + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.purview.catalog.operations.EntityOperations.partial_update_entity_by_unique_attributes + name: partial_update_entity_by_unique_attributes + summary: 'Update entity partially - Allow a subset of attributes to be updated on + + an entity which is identified by its type and unique attribute eg: + + Referenceable.qualifiedName. + + Null updates are not possible. + + In addition to the typeName path parameter, attribute key-value pair(s) can be + provided in the + + following format: + + attr:``=:code:``. + + NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName. + + The REST request would look something like this: + + PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.' + signature: 'partial_update_entity_by_unique_attributes(type_name: str, atlas_entity_with_ext_info: + MutableMapping[str, Any], *, attr_qualified_name: str | None = None, **kwargs: + Any) -> MutableMapping[str, Any]' + parameters: + - name: type_name + description: The name of the type. + isRequired: true + types: + - + - name: atlas_entity_with_ext_info + description: Atlas entity with extended information. + isRequired: true + types: + - + keywordOnlyParameters: + - name: attr_qualified_name + description: The qualified name of the entity. Default value is None. + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n atlas_entity_with_ext_info\ + \ = {\n \"entity\": {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \"\ + businessAttributes\": {\n \"str\": {} # Optional. Business Attributes.\n\ + \ },\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the\n struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional. The GUID of the\n\ + \ entity.\n \"entityStatus\": \"str\", \ + \ # Optional. Status of the\n entity - can be active or deleted.\ + \ Deleted entities are not removed\n from Atlas store. Known\ + \ values are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for\n concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the source who\n create the classification detail.\n\ + \ \"sourceDetails\": {\n \"str\": {} \ + \ # Optional. more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"validityPeriods\": [\n \ + \ {\n \"endTime\": \"str\", # Optional.\ + \ The\n end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n \ + \ start of the time boundary.\n \"timeZone\"\ + : \"str\" # Optional. The\n timezone of the time\ + \ boundary.\n }\n ]\n }\n\ + \ ],\n \"contacts\": {\n \"str\": [\n \ + \ {\n \"id\": \"str\", # Optional. Azure Active\n\ + \ Directory object Id.\n \"info\"\ + : \"str\" # Optional. additional\n information to describe\ + \ this contact.\n }\n ]\n },\n \ + \ \"createTime\": 0.0, # Optional. The created time of the record.\n \ + \ \"createdBy\": \"str\", # Optional. The user who created the record.\n\ + \ \"customAttributes\": {\n \"str\": \"str\" # Optional.\ + \ Custom Attribute.\n },\n \"guid\": \"str\", # Optional.\ + \ The GUID of the entity.\n \"homeId\": \"str\", # Optional. The home\ + \ ID of the entity.\n \"isIncomplete\": bool, # Optional. Whether it\ + \ is a shell entity.\n \"labels\": [\n \"str\" # Optional.\ + \ labels.\n ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"meanings\": [\n {\n\ + \ \"confidence\": 0, # Optional. The confidence of the\n \ + \ term assignment.\n \"createdBy\": \"str\"\ + , # Optional. The user who created\n the record.\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the term assignment.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n\ + \ relationship.\n \"source\": \"str\", \ + \ # Optional. The source of the term.\n \"status\": \"str\"\ + , # Optional. The status of terms\n assignment. Known values\ + \ are: \"DISCOVERED\", \"PROPOSED\", \"IMPORTED\",\n \"VALIDATED\"\ + , \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \"steward\": \"\ + str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, # Optional. Used\ + \ to record the provenance of\n an instance of an entity or relationship.\n\ + \ \"proxy\": bool, # Optional. Determines if there's a proxy.\n \ + \ \"relationshipAttributes\": {\n \"str\": {} # Optional.\ + \ The attributes of relationship.\n },\n \"source\": \"str\"\ + , # Optional. indicate the source who create the\n classification\ + \ detail.\n \"sourceDetails\": {\n \"str\": {} # Optional.\ + \ more detail on source information.\n },\n \"status\": \"\ + str\", # Optional. Status of the entity - can be active or\n deleted.\ + \ Deleted entities are not removed from Atlas store. Known values are:\n \ + \ \"ACTIVE\", \"DELETED\".\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the record.\n \"updatedBy\": \"str\", # Optional. The user\ + \ who updated the record.\n \"version\": 0.0 # Optional. The version\ + \ of the entity.\n },\n \"referredEntities\": {\n \"str\"\ + : {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"businessAttributes\"\ + : {\n \"str\": {} # Optional. Business Attributes.\n \ + \ },\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {}\ + \ # Optional. The attributes\n of the struct.\n \ + \ },\n \"entityGuid\": \"str\", #\ + \ Optional. The GUID of\n the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of\n \ + \ the entity - can be active or deleted. Deleted entities are not\n \ + \ removed from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag\n for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \"id\"\ + : \"str\", # Optional. Azure\n Active Directory object\ + \ Id.\n \"info\": \"str\" # Optional. additional\n\ + \ information to describe this contact.\n \ + \ }\n ]\n },\n \"\ + createTime\": 0.0, # Optional. The created time of the\n record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the\n\ + \ record.\n \"customAttributes\": {\n \ + \ \"str\": \"str\" # Optional. Custom Attribute.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"homeId\": \"str\", # Optional. The home ID of the entity.\n \ + \ \"isIncomplete\": bool, # Optional. Whether it is a shell\n \ + \ entity.\n \"labels\": [\n \"str\"\ + \ # Optional. labels.\n ],\n \"lastModifiedTS\":\ + \ \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"provenanceType\": 0.0, \ + \ # Optional. Used to record the\n provenance of an instance of\ + \ an entity or relationship.\n \"proxy\": bool, # Optional. Determines\ + \ if there's a proxy.\n \"relationshipAttributes\": {\n \ + \ \"str\": {} # Optional. The attributes of\n relationship.\n\ + \ },\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"status\": \"str\", # Optional. Status of the entity - can be\n\ + \ active or deleted. Deleted entities are not removed from Atlas\ + \ store.\n Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the\n record.\n \"version\": 0.0 # Optional.\ + \ The version of the entity.\n }\n }\n }\n\n # response body\ + \ for status code(s): 200\n response.json() == {\n \"guidAssignments\"\ + : {\n \"str\": \"str\" # Optional. A map of GUID assignments with entities.\n\ + \ },\n \"mutatedEntities\": {\n \"str\": [\n \ + \ {\n \"attributes\": {\n \"str\":\ + \ {} # Optional. The attributes of the\n struct.\n \ + \ },\n \"classificationNames\": [\n \ + \ \"str\" # Optional. An array of classification\n \ + \ names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n\ + \ \"str\": {} # Optional. The\n \ + \ attributes of the struct.\n },\n\ + \ \"entityGuid\": \"str\", # Optional. The\n \ + \ GUID of the entity.\n \"entityStatus\"\ + : \"str\", # Optional.\n Status of the entity - can\ + \ be active or deleted. Deleted\n entities are not\ + \ removed from Atlas store. Known values are:\n \"\ + ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional.\n ETag for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\":\n \ + \ bool, # Optional. Determines if propagations will be removed\n\ + \ on entity deletion.\n \ + \ \"source\": \"str\", # Optional.\n indicate the\ + \ source who create the classification detail.\n \"\ + sourceDetails\": {\n \"str\": {} # Optional. more\n\ + \ detail on source information.\n \ + \ },\n \"typeName\": \"str\", # Optional.\ + \ The\n name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\",\n # Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the\ + \ time boundary.\n }\n \ + \ ]\n }\n ],\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"guid\": \"str\"\ + , # Optional. The GUID of the record.\n \"isIncomplete\": bool,\ + \ # Optional. Whether it is a\n shell entity.\n \ + \ \"labels\": [\n \"str\" # Optional. labels.\n\ + \ ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for\n concurrency control.\n \"meaningNames\"\ + : [\n \"str\" # Optional. An array of meanings.\n \ + \ ],\n \"meanings\": [\n \ + \ {\n \"confidence\": 0, # Optional. The\n \ + \ confidence of the term assignment.\n \ + \ \"createdBy\": \"str\", # Optional. The\n \ + \ user who created the record.\n \"description\":\ + \ \"str\", # Optional.\n The description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional.\n\ + \ The display text.\n \"\ + expression\": \"str\", # Optional. The\n expression\ + \ of the term assignment.\n \"relationGuid\": \"str\"\ + , # Optional.\n The GUID of the relationship.\n \ + \ \"source\": \"str\", # Optional. The\n \ + \ source of the term.\n \"status\"\ + : \"str\", # Optional. The\n status of terms assignment.\ + \ Known values are: \"DISCOVERED\",\n \"PROPOSED\"\ + , \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\",\n \"\ + OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The\n steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The\n \ + \ GUID of the term.\n }\n ],\n \ + \ \"status\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\"\ + .\n \"typeName\": \"str\" # Optional. The name of the type.\n\ + \ }\n ]\n },\n \"partialUpdatedEntities\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"classificationNames\": [\n \"str\" # Optional. An\ + \ array of classification names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.set_classifications + name: set_classifications + summary: Set classifications on entities in bulk. + signature: 'set_classifications(entity_headers: MutableMapping[str, Any], **kwargs: + Any) -> List[str]' + parameters: + - name: entity_headers + description: Atlas entity headers. + isRequired: true + types: + - + return: + description: list of str + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n entity_headers\ + \ = {\n \"guidHeaderMap\": {\n \"str\": {\n \"attributes\"\ + : {\n \"str\": {} # Optional. The attributes of the struct.\n\ + \ },\n \"classificationNames\": [\n \ + \ \"str\" # Optional. An array of classification names.\n ],\n\ + \ \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes\n of the struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional. The\ + \ GUID of\n the entity.\n \"entityStatus\"\ + : \"str\", # Optional. Status of\n the entity - can be\ + \ active or deleted. Deleted entities are not\n removed\ + \ from Atlas store. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag\n \ + \ for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, #\n Optional. Determines if propagations will\ + \ be removed on entity\n deletion.\n \ + \ \"source\": \"str\", # Optional. indicate the\n \ + \ source who create the classification detail.\n \"sourceDetails\"\ + : {\n \"str\": {} # Optional. more detail on\n \ + \ source information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"validityPeriods\": [\n\ + \ {\n \"endTime\": \"\ + str\", #\n Optional. The end of the time boundary.\n\ + \ \"startTime\": \"str\", #\n \ + \ Optional. The start of the time boundary.\n \ + \ \"timeZone\": \"str\" #\n Optional.\ + \ The timezone of the time boundary.\n }\n \ + \ ]\n }\n ],\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"guid\": \"str\", \ + \ # Optional. The GUID of the record.\n \"isIncomplete\": bool,\ + \ # Optional. Whether it is a shell\n entity.\n \ + \ \"labels\": [\n \"str\" # Optional. labels.\n \ + \ ],\n \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n }\n }\n\n # response body for status code(s):\ + \ 200\n response.json() == [\n \"str\" # Optional.\n ]\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.set_labels + name: set_labels + summary: Set labels to a given entity. + signature: 'set_labels(guid: str, body: List[str] | None = None, **kwargs: Any) + -> None' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: body + description: set of labels to be set to the entity. Default value is None. + isRequired: true + types: + - [] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n body\ + \ = [\n \"str\" # Optional.\n ]\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.set_labels_by_unique_attribute + name: set_labels_by_unique_attribute + summary: 'Set labels to a given entity identified by its type and unique attributes, + if labels is + + null/empty, existing labels will all be removed. In addition to the typeName path + parameter, + + attribute key-value pair(s) can be provided in the following format: + + attr:``=:code:``. NOTE: The attrName and attrValue should + be unique + + across entities, eg. qualifiedName. The REST request would look something like + this: POST + + /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue.' + signature: 'set_labels_by_unique_attribute(type_name: str, body: List[str] | None + = None, *, attr_qualified_name: str | None = None, **kwargs: Any) -> None' + parameters: + - name: type_name + description: The name of the type. + isRequired: true + types: + - + - name: body + description: set of labels to be set. Default value is None. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: attr_qualified_name + description: The qualified name of the entity. Default value is None. + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n body\ + \ = [\n \"str\" # Optional.\n ]\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.update_classifications + name: update_classifications + summary: Update classifications to an existing entity represented by a guid. + signature: 'update_classifications(guid: str, classifications: List[MutableMapping[str, + Any]], **kwargs: Any) -> None' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + - name: classifications + description: An array of classifications to be updated. + isRequired: true + types: + - [] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n classifications\ + \ = [\n {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"entityGuid\": \"\ + str\", # Optional. The GUID of the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of the entity - can be\n active or deleted.\ + \ Deleted entities are not removed from Atlas store. Known\n values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional. Determines if\n propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate the\ + \ source who create the\n classification detail.\n \"sourceDetails\"\ + : {\n \"str\": {} # Optional. more detail on source information.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name of the\ + \ type.\n \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the time\n \ + \ boundary.\n \"startTime\": \"str\", # Optional. The start\ + \ of the\n time boundary.\n \"timeZone\"\ + : \"str\" # Optional. The timezone of the\n time boundary.\n\ + \ }\n ]\n }\n ]\n ````\n" +- uid: azure.purview.catalog.operations.EntityOperations.update_classifications_by_unique_attribute + name: update_classifications_by_unique_attribute + summary: Update classification on an entity identified by its type and unique attributes. + signature: 'update_classifications_by_unique_attribute(type_name: str, atlas_classification_array: + List[MutableMapping[str, Any]], *, attr_qualified_name: str | None = None, **kwargs: + Any) -> None' + parameters: + - name: type_name + description: The name of the type. + isRequired: true + types: + - + - name: atlas_classification_array + description: An array of classification to be updated. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: attr_qualified_name + description: The qualified name of the entity. Default value is None. + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n atlas_classification_array\ + \ = [\n {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"entityGuid\": \"\ + str\", # Optional. The GUID of the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of the entity - can be\n active or deleted.\ + \ Deleted entities are not removed from Atlas store. Known\n values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional. Determines if\n propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate the\ + \ source who create the\n classification detail.\n \"sourceDetails\"\ + : {\n \"str\": {} # Optional. more detail on source information.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name of the\ + \ type.\n \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the time\n \ + \ boundary.\n \"startTime\": \"str\", # Optional. The start\ + \ of the\n time boundary.\n \"timeZone\"\ + : \"str\" # Optional. The timezone of the\n time boundary.\n\ + \ }\n ]\n }\n ]\n ````\n" diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.GlossaryOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.GlossaryOperations.yml new file mode 100644 index 00000000..e8f01801 --- /dev/null +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.GlossaryOperations.yml @@ -0,0 +1,4765 @@ +### YamlMime:PythonClass +uid: azure.purview.catalog.operations.GlossaryOperations +name: GlossaryOperations +fullName: azure.purview.catalog.operations.GlossaryOperations +module: azure.purview.catalog.operations +constructor: + syntax: GlossaryOperations(*args, **kwargs) +methods: +- uid: azure.purview.catalog.operations.GlossaryOperations.assign_term_to_entities + name: assign_term_to_entities + summary: Assign the given term to the provided list of related objects. + signature: 'assign_term_to_entities(term_guid: str, related_object_ids: List[MutableMapping[str, + Any]], **kwargs: Any) -> None' + parameters: + - name: term_guid + description: The globally unique identifier for glossary term. + isRequired: true + types: + - + - name: related_object_ids + description: 'An array of related object IDs to which the term has to be + + associated.' + isRequired: true + types: + - [] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n related_object_ids\ + \ = [\n {\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"entityStatus\": \"str\", # Optional. Status of the entity\ + \ - can be\n active or deleted. Deleted entities are not removed from\ + \ Atlas store. Known\n values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \"\ + relationshipAttributes\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"typeName\": \"str\" # Optional.\ + \ The name of the type.\n },\n \"relationshipGuid\": \"str\"\ + , # Optional. The GUID of the relationship.\n \"relationshipStatus\"\ + : \"str\", # Optional. The enum of relationship\n status. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"relationshipType\": \"str\", #\ + \ Optional.\n \"typeName\": \"str\", # Optional. The name of the type.\n\ + \ \"uniqueAttributes\": {\n \"str\": {} # Optional. The\ + \ unique attributes of the object.\n }\n }\n ]\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.begin_import_glossary_terms_via_csv + name: begin_import_glossary_terms_via_csv + signature: 'begin_import_glossary_terms_via_csv(glossary_guid: str, files: Dict[str, + Any], *, include_term_hierarchy: bool | None = False, **kwargs: Any) -> LROPoller[MutableMapping[str, + Any]]' + parameters: + - name: glossary_guid + isRequired: true + - name: files + isRequired: true + keywordOnlyParameters: + - name: include_term_hierarchy + isRequired: true +- uid: azure.purview.catalog.operations.GlossaryOperations.begin_import_glossary_terms_via_csv_by_glossary_name + name: begin_import_glossary_terms_via_csv_by_glossary_name + summary: Import Glossary Terms from local csv file by glossaryName. + signature: 'begin_import_glossary_terms_via_csv_by_glossary_name(glossary_name: + str, files: Dict[str, Any], *, include_term_hierarchy: bool | None = False, **kwargs: + Any) -> LROPoller[MutableMapping[str, Any]]' + parameters: + - name: glossary_name + description: The name of the glossary. + isRequired: true + types: + - + - name: files + description: 'Multipart input for files. See the template in our example to find + the input + + shape.' + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: include_term_hierarchy + description: Whether include term hierarchy. Default value is False. + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'By default, your polling method will be LROBasePolling. Pass in + False for + + this operation to not poll, or pass in your own initialized polling object for + a personal + + polling strategy.' + types: + - + - + - name: polling_interval + description: 'Default waiting time between two polls for LRO operations if no + + Retry-After header is present.' + types: + - + return: + description: An instance of LROPoller that returns JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # multipart input template you can fill out and use as your `files` input.\n\ + \ files = {\n \"file\": b'bytes' # The csv file to import glossary terms\ + \ from.\n }\n\n # response body for status code(s): 202\n response.json()\ + \ == {\n \"createTime\": \"str\", # Optional. The created time of the record.\n\ + \ \"error\": {\n \"errorCode\": 0, # Optional. Error code from\ + \ async import job if\n fail.\n \"errorMessage\": \"str\"\ + \ # Optional. Error message from async import\n job if fail.\n \ + \ },\n \"id\": \"str\", # Optional. guid string.\n \"lastUpdateTime\"\ + : \"str\", # Optional. The last updated time of the record.\n \"properties\"\ + : {\n \"importedTerms\": \"str\", # Optional. Term numbers that already\n\ + \ imported successfully.\n \"totalTermsDetected\": \"str\"\ + \ # Optional. Total term numbers that\n detected in csv.\n \ + \ },\n \"status\": \"str\" # Optional. Enum of the status of import csv\ + \ operation.\n Possible values include: \"NotStarted\", \"Succeeded\"\ + , \"Failed\", \"Running\".\n }\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.create_glossary + name: create_glossary + summary: Create a glossary. + signature: 'create_glossary(atlas_glossary: MutableMapping[str, Any], **kwargs: + Any) -> MutableMapping[str, Any]' + parameters: + - name: atlas_glossary + description: 'Glossary definition, terms & categories can be anchored to a glossary. + + Using the anchor attribute when creating the Term/Category.' + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n atlas_glossary\ + \ = {\n \"categories\": [\n {\n \"categoryGuid\"\ + : \"str\", # Optional. The GUID of the category.\n \"description\"\ + : \"str\", # Optional. The description of the\n category header.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"parentCategoryGuid\": \"str\", # Optional. The GUID of the\n \ + \ parent category.\n \"relationGuid\": \"str\" #\ + \ Optional. The GUID of the\n relationship.\n }\n \ + \ ],\n \"classifications\": [\n {\n \"attributes\"\ + : {\n \"str\": {} # Optional. The attributes of the struct.\n\ + \ },\n \"entityGuid\": \"str\", # Optional. The GUID\ + \ of the entity.\n \"entityStatus\": \"str\", # Optional. Status\ + \ of the entity -\n can be active or deleted. Deleted entities\ + \ are not removed from Atlas\n store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional. ETag\ + \ for concurrency\n control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional.\n Determines if propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"language\": \"str\", # Optional. The language of the glossary.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"qualifiedName\": \"str\", # Optional. The qualified name of the glossary\n\ + \ object.\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"terms\": [\n {\n \"\ + description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"expression\": \"str\", # Optional. The expression of\ + \ the term.\n \"relationGuid\": \"str\", # Optional. The GUID of\ + \ the\n relationship.\n \"source\": \"str\", #\ + \ Optional. The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"DRAFT\"\ + , \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"usage\": \"str\" # Optional. The usage of the glossary.\n\ + \ }\n\n # response body for status code(s): 200\n response.json() == {\n\ + \ \"categories\": [\n {\n \"categoryGuid\": \"str\"\ + , # Optional. The GUID of the category.\n \"description\": \"str\"\ + , # Optional. The description of the\n category header.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"parentCategoryGuid\": \"str\", # Optional. The GUID of the\n \ + \ parent category.\n \"relationGuid\": \"str\" # Optional.\ + \ The GUID of the\n relationship.\n }\n ],\n \ + \ \"classifications\": [\n {\n \"attributes\": {\n\ + \ \"str\": {} # Optional. The attributes of the struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional. The GUID\ + \ of the entity.\n \"entityStatus\": \"str\", # Optional. Status\ + \ of the entity -\n can be active or deleted. Deleted entities\ + \ are not removed from Atlas\n store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional. ETag\ + \ for concurrency\n control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional.\n Determines if propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"language\": \"str\", # Optional. The language of the glossary.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"qualifiedName\": \"str\", # Optional. The qualified name of the glossary\n\ + \ object.\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"terms\": [\n {\n \"\ + description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"expression\": \"str\", # Optional. The expression of\ + \ the term.\n \"relationGuid\": \"str\", # Optional. The GUID of\ + \ the\n relationship.\n \"source\": \"str\", #\ + \ Optional. The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"DRAFT\"\ + , \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"usage\": \"str\" # Optional. The usage of the glossary.\n\ + \ }\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.create_glossary_categories + name: create_glossary_categories + summary: Create glossary category in bulk. + signature: 'create_glossary_categories(glossary_category: List[MutableMapping[str, + Any]], **kwargs: Any) -> List[MutableMapping[str, Any]]' + parameters: + - name: glossary_category + description: An array of glossary category definitions to be created. + isRequired: true + types: + - [] + return: + description: list of JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n glossary_category\ + \ = [\n {\n \"anchor\": {\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"glossaryGuid\": \"str\"\ + , # Optional. The GUID of the glossary.\n \"relationGuid\": \"\ + str\" # Optional. The GUID of the\n relationship.\n \ + \ },\n \"childrenCategories\": [\n {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the\n \ + \ category.\n \"description\": \"str\", # Optional. The\ + \ description of\n the category header.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"parentCategoryGuid\": \"str\", # Optional. The GUID of\n \ + \ the parent category.\n \"relationGuid\": \"str\" #\ + \ Optional. The GUID of the\n relationship.\n \ + \ }\n ],\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the\n struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional. The GUID of the\n\ + \ entity.\n \"entityStatus\": \"str\", \ + \ # Optional. Status of the\n entity - can be active or deleted.\ + \ Deleted entities are not removed\n from Atlas store. Known\ + \ values are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for\n concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\", # Optional.\ + \ indicate the source who\n create the classification detail.\n\ + \ \"sourceDetails\": {\n \"str\": {} \ + \ # Optional. more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"validityPeriods\": [\n \ + \ {\n \"endTime\": \"str\", # Optional.\ + \ The\n end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n \ + \ start of the time boundary.\n \"timeZone\"\ + : \"str\" # Optional. The\n timezone of the time\ + \ boundary.\n }\n ]\n }\n\ + \ ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n\ + \ \"parentCategory\": {\n \"categoryGuid\": \"str\", \ + \ # Optional. The GUID of the category.\n \"description\": \"str\"\ + , # Optional. The description of the\n category header.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"parentCategoryGuid\": \"str\", # Optional. The GUID of the\n \ + \ parent category.\n \"relationGuid\": \"str\" # Optional.\ + \ The GUID of the\n relationship.\n },\n \"\ + qualifiedName\": \"str\", # Optional. The qualified name of the\n \ + \ glossary object.\n \"shortDescription\": \"str\", # Optional. The\ + \ short version of\n description.\n \"terms\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description\ + \ of\n the related term.\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"expression\":\ + \ \"str\", # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", #\ + \ Optional. The source of the term.\n \"status\": \"str\", \ + \ # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of the\n term.\n \"termGuid\": \"str\"\ + \ # Optional. The GUID of the term.\n }\n ]\n }\n\ + \ ]\n\n # response body for status code(s): 200\n response.json() == [\n\ + \ {\n \"anchor\": {\n \"displayText\": \"str\",\ + \ # Optional. The display text.\n \"glossaryGuid\": \"str\", #\ + \ Optional. The GUID of the glossary.\n \"relationGuid\": \"str\"\ + \ # Optional. The GUID of the\n relationship.\n },\n\ + \ \"childrenCategories\": [\n {\n \"\ + categoryGuid\": \"str\", # Optional. The GUID of the\n category.\n\ + \ \"description\": \"str\", # Optional. The description of\n\ + \ the category header.\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"parentCategoryGuid\"\ + : \"str\", # Optional. The GUID of\n the parent category.\n\ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ],\n \ + \ \"classifications\": [\n {\n \"attributes\"\ + : {\n \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"\ + entityGuid\": \"str\", # Optional. The GUID of the\n entity.\n\ + \ \"entityStatus\": \"str\", # Optional. Status of the\n \ + \ entity - can be active or deleted. Deleted entities are not\ + \ removed\n from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional. ETag\ + \ for\n concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, #\n Optional. Determines if propagations will be\ + \ removed on entity\n deletion.\n \"source\"\ + : \"str\", # Optional. indicate the source who\n create the\ + \ classification detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on source\n \ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of the type.\n \"validityPeriods\"\ + : [\n {\n \"endTime\": \"str\"\ + , # Optional. The\n end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n \ + \ start of the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The\n timezone\ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID\ + \ of the object.\n \"lastModifiedTS\": \"str\", # Optional. ETag for\ + \ concurrency control.\n \"longDescription\": \"str\", # Optional.\ + \ The long version description.\n \"name\": \"str\", # Optional. The\ + \ name of the glossary object.\n \"parentCategory\": {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the category.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ category header.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"parentCategoryGuid\": \"str\", # Optional.\ + \ The GUID of the\n parent category.\n \"relationGuid\"\ + : \"str\" # Optional. The GUID of the\n relationship.\n \ + \ },\n \"qualifiedName\": \"str\", # Optional. The qualified name\ + \ of the\n glossary object.\n \"shortDescription\": \"str\"\ + , # Optional. The short version of\n description.\n \"\ + terms\": [\n {\n \"description\": \"str\", #\ + \ Optional. The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", #\ + \ Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ]\n }\n ]\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.create_glossary_category + name: create_glossary_category + summary: Create a glossary category. + signature: 'create_glossary_category(glossary_category: MutableMapping[str, Any], + **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: glossary_category + description: 'The glossary category definition. A category must be anchored to + a + + Glossary when creating. + + Optionally, terms belonging to the category and the hierarchy can also be defined + during + + creation.' + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n glossary_category\ + \ = {\n \"anchor\": {\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"glossaryGuid\": \"str\", # Optional. The GUID\ + \ of the glossary.\n \"relationGuid\": \"str\" # Optional. The GUID\ + \ of the relationship.\n },\n \"childrenCategories\": [\n \ + \ {\n \"categoryGuid\": \"str\", # Optional. The GUID of the\ + \ category.\n \"description\": \"str\", # Optional. The description\ + \ of the\n category header.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"parentCategoryGuid\":\ + \ \"str\", # Optional. The GUID of the\n parent category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional.\n Determines if propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"parentCategory\": {\n \"categoryGuid\": \"str\", # Optional.\ + \ The GUID of the category.\n \"description\": \"str\", # Optional.\ + \ The description of the category\n header.\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"parentCategoryGuid\":\ + \ \"str\", # Optional. The GUID of the parent\n category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the relationship.\n\ + \ },\n \"qualifiedName\": \"str\", # Optional. The qualified name\ + \ of the glossary\n object.\n \"shortDescription\": \"str\", #\ + \ Optional. The short version of description.\n \"terms\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description of\ + \ the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ]\n }\n\n # response body for status code(s):\ + \ 200\n response.json() == {\n \"anchor\": {\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"glossaryGuid\": \"str\"\ + , # Optional. The GUID of the glossary.\n \"relationGuid\": \"str\"\ + \ # Optional. The GUID of the relationship.\n },\n \"childrenCategories\"\ + : [\n {\n \"categoryGuid\": \"str\", # Optional. The\ + \ GUID of the category.\n \"description\": \"str\", # Optional.\ + \ The description of the\n category header.\n \"\ + displayText\": \"str\", # Optional. The display text.\n \"parentCategoryGuid\"\ + : \"str\", # Optional. The GUID of the\n parent category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional.\n Determines if propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"parentCategory\": {\n \"categoryGuid\": \"str\", # Optional.\ + \ The GUID of the category.\n \"description\": \"str\", # Optional.\ + \ The description of the category\n header.\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"parentCategoryGuid\":\ + \ \"str\", # Optional. The GUID of the parent\n category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the relationship.\n\ + \ },\n \"qualifiedName\": \"str\", # Optional. The qualified name\ + \ of the glossary\n object.\n \"shortDescription\": \"str\", #\ + \ Optional. The short version of description.\n \"terms\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description of\ + \ the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.create_glossary_term + name: create_glossary_term + summary: Create a glossary term. + signature: 'create_glossary_term(glossary_term: MutableMapping[str, Any], *, include_term_hierarchy: + bool | None = False, **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: glossary_term + description: 'The glossary term definition. A term must be anchored to a Glossary + at + + the time of creation. + + Optionally it can be categorized as well.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: include_term_hierarchy + description: Whether include term hierarchy. Default value is False. + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n glossary_term\ + \ = {\n \"abbreviation\": \"str\", # Optional. The abbreviation of the\ + \ term.\n \"anchor\": {\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"glossaryGuid\": \"str\", # Optional. The GUID\ + \ of the glossary.\n \"relationGuid\": \"str\" # Optional. The GUID\ + \ of the relationship.\n },\n \"antonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"assignedEntities\": [\n {\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n\ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \ + \ \"relationshipAttributes\": {\n \"attributes\":\ + \ {\n \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"\ + lastModifiedTS\": \"str\", # Optional. ETag for\n concurrency\ + \ control.\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n },\n \"relationshipGuid\": \"str\",\ + \ # Optional. The GUID of the\n relationship.\n \ + \ \"relationshipStatus\": \"str\", # Optional. The enum of\n \ + \ relationship status. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"relationshipType\": \"str\", # Optional. An array of related\n \ + \ object IDs.\n \"typeName\": \"str\", # Optional. The\ + \ name of the type.\n \"uniqueAttributes\": {\n \ + \ \"str\": {} # Optional. The unique attributes of the\n \ + \ object.\n }\n }\n ],\n \"attributes\"\ + : {\n \"str\": {\n \"str\": {} # Optional. The custom\ + \ attributes of the term,\n which is map>.\"\ + nThe key of the first layer map\n is term template name.\n \ + \ }\n },\n \"categories\": [\n {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the category.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ record.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"status\": \"str\" \ + \ # Optional. The status of term relationship.\n Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \ + \ }\n ],\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"entityGuid\": \"str\", \ + \ # Optional. The GUID of the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of the entity -\n can be active or deleted.\ + \ Deleted entities are not removed from Atlas\n store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\", \ + \ # Optional. ETag for concurrency\n control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, # Optional.\n Determines\ + \ if propagations will be removed on entity deletion.\n \"source\"\ + : \"str\", # Optional. indicate the source who create\n the classification\ + \ detail.\n \"sourceDetails\": {\n \"str\": {}\ + \ # Optional. more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"\ + str\", # Optional. The start of\n the time boundary.\n\ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n \ + \ ]\n }\n ],\n \"classifies\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"contacts\": {\n \"str\":\ + \ [\n {\n \"id\": \"str\", # Optional. Azure\ + \ Active Directory\n object Id.\n \"info\"\ + : \"str\" # Optional. additional information to\n describe\ + \ this contact.\n }\n ]\n },\n \"createTime\"\ + : 0.0, # Optional. The created time of the record.\n \"createdBy\": \"\ + str\", # Optional. The user who created the record.\n \"examples\": [\n\ + \ \"str\" # Optional. An array of examples.\n ],\n \"guid\"\ + : \"str\", # Optional. The GUID of the object.\n \"isA\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description of\ + \ the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"longDescription\": \"str\", # Optional.\ + \ The long version description.\n \"name\": \"str\", # Optional. The name\ + \ of the glossary object.\n \"preferredTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"preferredToTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"qualifiedName\": \"str\", # Optional.\ + \ The qualified name of the glossary\n object.\n \"replacedBy\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"replacementTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"resources\": [\n {\n \ + \ \"displayName\": \"str\", # Optional. Display name for url.\n \ + \ \"url\": \"str\" # Optional. web url. http or https.\n \ + \ }\n ],\n \"seeAlso\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"status\": \"str\", # Optional. Status of\ + \ the AtlasGlossaryTerm. Known values\n are: \"Draft\", \"Approved\",\ + \ \"Alert\", \"Expired\".\n \"synonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"templateName\": [\n {} # Optional.\n\ + \ ],\n \"translatedTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"translationTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"updateTime\": 0.0, # Optional. The\ + \ update time of the record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the record.\n \"usage\": \"str\", # Optional. The usage\ + \ of the term.\n \"validValues\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"validValuesFor\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ]\n }\n\n # response body for status code(s): 200\n response.json()\ + \ == {\n \"abbreviation\": \"str\", # Optional. The abbreviation of the\ + \ term.\n \"anchor\": {\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"glossaryGuid\": \"str\", # Optional. The GUID\ + \ of the glossary.\n \"relationGuid\": \"str\" # Optional. The GUID\ + \ of the relationship.\n },\n \"antonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"assignedEntities\": [\n {\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n\ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \ + \ \"relationshipAttributes\": {\n \"attributes\":\ + \ {\n \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"\ + lastModifiedTS\": \"str\", # Optional. ETag for\n concurrency\ + \ control.\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n },\n \"relationshipGuid\": \"str\",\ + \ # Optional. The GUID of the\n relationship.\n \ + \ \"relationshipStatus\": \"str\", # Optional. The enum of\n \ + \ relationship status. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"relationshipType\": \"str\", # Optional. An array of related\n \ + \ object IDs.\n \"typeName\": \"str\", # Optional. The\ + \ name of the type.\n \"uniqueAttributes\": {\n \ + \ \"str\": {} # Optional. The unique attributes of the\n \ + \ object.\n }\n }\n ],\n \"attributes\"\ + : {\n \"str\": {\n \"str\": {} # Optional. The custom\ + \ attributes of the term,\n which is map>.\"\ + nThe key of the first layer map\n is term template name.\n \ + \ }\n },\n \"categories\": [\n {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the category.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ record.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"status\": \"str\" \ + \ # Optional. The status of term relationship.\n Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \ + \ }\n ],\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"entityGuid\": \"str\", \ + \ # Optional. The GUID of the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of the entity -\n can be active or deleted.\ + \ Deleted entities are not removed from Atlas\n store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\", \ + \ # Optional. ETag for concurrency\n control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, # Optional.\n Determines\ + \ if propagations will be removed on entity deletion.\n \"source\"\ + : \"str\", # Optional. indicate the source who create\n the classification\ + \ detail.\n \"sourceDetails\": {\n \"str\": {}\ + \ # Optional. more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"\ + str\", # Optional. The start of\n the time boundary.\n\ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n \ + \ ]\n }\n ],\n \"classifies\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"contacts\": {\n \"str\":\ + \ [\n {\n \"id\": \"str\", # Optional. Azure\ + \ Active Directory\n object Id.\n \"info\"\ + : \"str\" # Optional. additional information to\n describe\ + \ this contact.\n }\n ]\n },\n \"createTime\"\ + : 0.0, # Optional. The created time of the record.\n \"createdBy\": \"\ + str\", # Optional. The user who created the record.\n \"examples\": [\n\ + \ \"str\" # Optional. An array of examples.\n ],\n \"guid\"\ + : \"str\", # Optional. The GUID of the object.\n \"isA\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description of\ + \ the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"longDescription\": \"str\", # Optional.\ + \ The long version description.\n \"name\": \"str\", # Optional. The name\ + \ of the glossary object.\n \"preferredTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"preferredToTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"qualifiedName\": \"str\", # Optional.\ + \ The qualified name of the glossary\n object.\n \"replacedBy\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"replacementTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"resources\": [\n {\n \ + \ \"displayName\": \"str\", # Optional. Display name for url.\n \ + \ \"url\": \"str\" # Optional. web url. http or https.\n \ + \ }\n ],\n \"seeAlso\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"status\": \"str\", # Optional. Status of\ + \ the AtlasGlossaryTerm. Known values\n are: \"Draft\", \"Approved\",\ + \ \"Alert\", \"Expired\".\n \"synonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"templateName\": [\n {} # Optional.\n\ + \ ],\n \"translatedTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"translationTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"updateTime\": 0.0, # Optional. The\ + \ update time of the record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the record.\n \"usage\": \"str\", # Optional. The usage\ + \ of the term.\n \"validValues\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"validValuesFor\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.create_glossary_terms + name: create_glossary_terms + summary: Create glossary terms in bulk. + signature: 'create_glossary_terms(glossary_term: List[MutableMapping[str, Any]], + *, include_term_hierarchy: bool | None = False, **kwargs: Any) -> List[MutableMapping[str, + Any]]' + parameters: + - name: glossary_term + description: An array of glossary term definitions to be created in bulk. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: include_term_hierarchy + description: Whether include term hierarchy. Default value is False. + types: + - + return: + description: list of JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n glossary_term\ + \ = [\n {\n \"abbreviation\": \"str\", # Optional. The abbreviation\ + \ of the term.\n \"anchor\": {\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"glossaryGuid\": \"str\", #\ + \ Optional. The GUID of the glossary.\n \"relationGuid\": \"str\"\ + \ # Optional. The GUID of the\n relationship.\n },\n\ + \ \"antonyms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"assignedEntities\": [\n \ + \ {\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"entityStatus\": \"str\", # Optional. Status of\ + \ the\n entity - can be active or deleted. Deleted entities\ + \ are not removed\n from Atlas store. Known values are: \"\ + ACTIVE\", \"DELETED\".\n \"guid\": \"str\", # Optional. The\ + \ GUID of the object.\n \"relationshipAttributes\": {\n \ + \ \"attributes\": {\n \"str\": {}\ + \ # Optional. The attributes\n of the struct.\n \ + \ },\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag\n for concurrency control.\n \ + \ \"typeName\": \"str\" # Optional. The name of\n \ + \ the type.\n },\n \"relationshipGuid\"\ + : \"str\", # Optional. The GUID of\n the relationship.\n\ + \ \"relationshipStatus\": \"str\", # Optional. The enum of\n\ + \ relationship status. Known values are: \"ACTIVE\", \"DELETED\"\ + .\n \"relationshipType\": \"str\", # Optional. An array of\n\ + \ related object IDs.\n \"typeName\": \"\ + str\", # Optional. The name of the type.\n \"uniqueAttributes\"\ + : {\n \"str\": {} # Optional. The unique attributes\n \ + \ of the object.\n }\n \ + \ }\n ],\n \"attributes\": {\n \"str\": {\n\ + \ \"str\": {} # Optional. The custom attributes of the\n \ + \ term, which is map>.\"nThe key of\ + \ the first\n layer map is term template name.\n \ + \ }\n },\n \"categories\": [\n {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the\n \ + \ category.\n \"description\": \"str\", # Optional.\ + \ The description of\n the record.\n \"\ + displayText\": \"str\", # Optional. The display text.\n \"\ + relationGuid\": \"str\", # Optional. The GUID of the\n relationship.\n\ + \ \"status\": \"str\" # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n }\n \ + \ ],\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the\n struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the\n \ + \ entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of the\n entity - can be active or deleted. Deleted\ + \ entities are not removed\n from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag for\n concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who\n create the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional.\ + \ more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n \ + \ {\n \"endTime\": \"str\", # Optional. The\n \ + \ end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n start\ + \ of the time boundary.\n \"timeZone\": \"str\" # Optional.\ + \ The\n timezone of the time boundary.\n \ + \ }\n ]\n }\n ],\n \ + \ \"classifies\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"contacts\": {\n \"str\"\ + : [\n {\n \"id\": \"str\", # Optional.\ + \ Azure Active\n Directory object Id.\n \ + \ \"info\": \"str\" # Optional. additional\n \ + \ information to describe this contact.\n }\n \ + \ ]\n },\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who\ + \ created the record.\n \"examples\": [\n \"str\" # Optional.\ + \ An array of examples.\n ],\n \"guid\": \"str\", # Optional.\ + \ The GUID of the object.\n \"isA\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\",\ + \ # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency control.\n \"longDescription\"\ + : \"str\", # Optional. The long version description.\n \"name\": \"\ + str\", # Optional. The name of the glossary object.\n \"preferredTerms\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"preferredToTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"qualifiedName\": \"str\", # Optional.\ + \ The qualified name of the\n glossary object.\n \"replacedBy\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"replacementTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"resources\": [\n {\n\ + \ \"displayName\": \"str\", # Optional. Display name for\n\ + \ url.\n \"url\": \"str\" # Optional. web\ + \ url. http or https.\n }\n ],\n \"seeAlso\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"shortDescription\": \"str\", # Optional. The short version of\n\ + \ description.\n \"status\": \"str\", # Optional. Status\ + \ of the AtlasGlossaryTerm. Known\n values are: \"Draft\", \"Approved\"\ + , \"Alert\", \"Expired\".\n \"synonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the related term.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"templateName\"\ + : [\n {} # Optional.\n ],\n \"translatedTerms\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"translationTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"updateTime\": 0.0, # Optional. The\ + \ update time of the record.\n \"updatedBy\": \"str\", # Optional.\ + \ The user who updated the record.\n \"usage\": \"str\", # Optional.\ + \ The usage of the term.\n \"validValues\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n\ + \ the related term.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"validValuesFor\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ]\n\ + \ }\n ]\n\n # response body for status code(s): 200\n response.json()\ + \ == [\n {\n \"abbreviation\": \"str\", # Optional. The abbreviation\ + \ of the term.\n \"anchor\": {\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"glossaryGuid\": \"str\", #\ + \ Optional. The GUID of the glossary.\n \"relationGuid\": \"str\"\ + \ # Optional. The GUID of the\n relationship.\n },\n\ + \ \"antonyms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"assignedEntities\": [\n \ + \ {\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"entityStatus\": \"str\", # Optional. Status of\ + \ the\n entity - can be active or deleted. Deleted entities\ + \ are not removed\n from Atlas store. Known values are: \"\ + ACTIVE\", \"DELETED\".\n \"guid\": \"str\", # Optional. The\ + \ GUID of the object.\n \"relationshipAttributes\": {\n \ + \ \"attributes\": {\n \"str\": {}\ + \ # Optional. The attributes\n of the struct.\n \ + \ },\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag\n for concurrency control.\n \ + \ \"typeName\": \"str\" # Optional. The name of\n \ + \ the type.\n },\n \"relationshipGuid\"\ + : \"str\", # Optional. The GUID of\n the relationship.\n\ + \ \"relationshipStatus\": \"str\", # Optional. The enum of\n\ + \ relationship status. Known values are: \"ACTIVE\", \"DELETED\"\ + .\n \"relationshipType\": \"str\", # Optional. An array of\n\ + \ related object IDs.\n \"typeName\": \"\ + str\", # Optional. The name of the type.\n \"uniqueAttributes\"\ + : {\n \"str\": {} # Optional. The unique attributes\n \ + \ of the object.\n }\n \ + \ }\n ],\n \"attributes\": {\n \"str\": {\n\ + \ \"str\": {} # Optional. The custom attributes of the\n \ + \ term, which is map>.\"nThe key of\ + \ the first\n layer map is term template name.\n \ + \ }\n },\n \"categories\": [\n {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the\n \ + \ category.\n \"description\": \"str\", # Optional.\ + \ The description of\n the record.\n \"\ + displayText\": \"str\", # Optional. The display text.\n \"\ + relationGuid\": \"str\", # Optional. The GUID of the\n relationship.\n\ + \ \"status\": \"str\" # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n }\n \ + \ ],\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the\n struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the\n \ + \ entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of the\n entity - can be active or deleted. Deleted\ + \ entities are not removed\n from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag for\n concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who\n create the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional.\ + \ more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n \ + \ {\n \"endTime\": \"str\", # Optional. The\n \ + \ end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n start\ + \ of the time boundary.\n \"timeZone\": \"str\" # Optional.\ + \ The\n timezone of the time boundary.\n \ + \ }\n ]\n }\n ],\n \ + \ \"classifies\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"contacts\": {\n \"str\"\ + : [\n {\n \"id\": \"str\", # Optional.\ + \ Azure Active\n Directory object Id.\n \ + \ \"info\": \"str\" # Optional. additional\n \ + \ information to describe this contact.\n }\n \ + \ ]\n },\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who\ + \ created the record.\n \"examples\": [\n \"str\" # Optional.\ + \ An array of examples.\n ],\n \"guid\": \"str\", # Optional.\ + \ The GUID of the object.\n \"isA\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\",\ + \ # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency control.\n \"longDescription\"\ + : \"str\", # Optional. The long version description.\n \"name\": \"\ + str\", # Optional. The name of the glossary object.\n \"preferredTerms\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"preferredToTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"qualifiedName\": \"str\", # Optional.\ + \ The qualified name of the\n glossary object.\n \"replacedBy\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"replacementTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"resources\": [\n {\n\ + \ \"displayName\": \"str\", # Optional. Display name for\n\ + \ url.\n \"url\": \"str\" # Optional. web\ + \ url. http or https.\n }\n ],\n \"seeAlso\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"shortDescription\": \"str\", # Optional. The short version of\n\ + \ description.\n \"status\": \"str\", # Optional. Status\ + \ of the AtlasGlossaryTerm. Known\n values are: \"Draft\", \"Approved\"\ + , \"Alert\", \"Expired\".\n \"synonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the related term.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"templateName\"\ + : [\n {} # Optional.\n ],\n \"translatedTerms\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"translationTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"updateTime\": 0.0, # Optional. The\ + \ update time of the record.\n \"updatedBy\": \"str\", # Optional.\ + \ The user who updated the record.\n \"usage\": \"str\", # Optional.\ + \ The usage of the term.\n \"validValues\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n\ + \ the related term.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"validValuesFor\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ]\n\ + \ }\n ]\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.delete_glossary + name: delete_glossary + summary: Delete a glossary. + signature: 'delete_glossary(glossary_guid: str, **kwargs: Any) -> None' + parameters: + - name: glossary_guid + description: The globally unique identifier for glossary. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.purview.catalog.operations.GlossaryOperations.delete_glossary_category + name: delete_glossary_category + summary: Delete a glossary category. + signature: 'delete_glossary_category(category_guid: str, **kwargs: Any) -> None' + parameters: + - name: category_guid + description: The globally unique identifier of the category. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.purview.catalog.operations.GlossaryOperations.delete_glossary_term + name: delete_glossary_term + summary: Delete a glossary term. + signature: 'delete_glossary_term(term_guid: str, **kwargs: Any) -> None' + parameters: + - name: term_guid + description: The globally unique identifier for glossary term. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.purview.catalog.operations.GlossaryOperations.delete_term_assignment_from_entities + name: delete_term_assignment_from_entities + summary: Delete the term assignment for the given list of related objects. + signature: 'delete_term_assignment_from_entities(term_guid: str, related_object_ids: + List[MutableMapping[str, Any]], **kwargs: Any) -> None' + parameters: + - name: term_guid + description: The globally unique identifier for glossary term. + isRequired: true + types: + - + - name: related_object_ids + description: 'An array of related object IDs from which the term has to be + + dissociated.' + isRequired: true + types: + - [] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n related_object_ids\ + \ = [\n {\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"entityStatus\": \"str\", # Optional. Status of the entity\ + \ - can be\n active or deleted. Deleted entities are not removed from\ + \ Atlas store. Known\n values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \"\ + relationshipAttributes\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"typeName\": \"str\" # Optional.\ + \ The name of the type.\n },\n \"relationshipGuid\": \"str\"\ + , # Optional. The GUID of the relationship.\n \"relationshipStatus\"\ + : \"str\", # Optional. The enum of relationship\n status. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"relationshipType\": \"str\", #\ + \ Optional.\n \"typeName\": \"str\", # Optional. The name of the type.\n\ + \ \"uniqueAttributes\": {\n \"str\": {} # Optional. The\ + \ unique attributes of the object.\n }\n }\n ]\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.export_glossary_terms_as_csv + name: export_glossary_terms_as_csv + summary: Export Glossary Terms as csv file. + signature: 'export_glossary_terms_as_csv(glossary_guid: str, term_guids: List[str], + *, include_term_hierarchy: bool | None = False, **kwargs: Any) -> IO' + parameters: + - name: glossary_guid + description: The globally unique identifier for glossary. + isRequired: true + types: + - + - name: term_guids + description: An array of term guids. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: include_term_hierarchy + description: Whether include term hierarchy. Default value is False. + types: + - + return: + description: IO + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n term_guids\ + \ = [\n \"str\" # Optional.\n ]\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.get_detailed_glossary + name: get_detailed_glossary + summary: Get a specific glossary with detailed information. + signature: 'get_detailed_glossary(glossary_guid: str, *, include_term_hierarchy: + bool | None = False, **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: glossary_guid + description: The globally unique identifier for glossary. + isRequired: true + types: + - + keywordOnlyParameters: + - name: include_term_hierarchy + description: Whether include term hierarchy. Default value is False. + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + categories\": [\n {\n \"categoryGuid\": \"str\", # Optional.\ + \ The GUID of the category.\n \"description\": \"str\", # Optional.\ + \ The description of the\n category header.\n \"\ + displayText\": \"str\", # Optional. The display text.\n \"parentCategoryGuid\"\ + : \"str\", # Optional. The GUID of the\n parent category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ],\n \"categoryInfo\": {\n\ + \ \"str\": {\n \"anchor\": {\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"glossaryGuid\"\ + : \"str\", # Optional. The GUID of the\n glossary.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n },\n \"childrenCategories\"\ + : [\n {\n \"categoryGuid\": \"str\", \ + \ # Optional. The GUID\n of the category.\n \ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the category header.\n \"displayText\"\ + : \"str\", # Optional. The\n display text.\n \ + \ \"parentCategoryGuid\": \"str\", # Optional. The\n \ + \ GUID of the parent category.\n \"relationGuid\"\ + : \"str\" # Optional. The GUID\n of the relationship.\n\ + \ }\n ],\n \"classifications\":\ + \ [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional.\ + \ The GUID of the object.\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency\n control.\n \"longDescription\"\ + : \"str\", # Optional. The long version\n description.\n \ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n\ + \ \"parentCategory\": {\n \"categoryGuid\": \"\ + str\", # Optional. The GUID of the\n category.\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the category header.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"parentCategoryGuid\": \"\ + str\", # Optional. The GUID of\n the parent category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n },\n \"qualifiedName\"\ + : \"str\", # Optional. The qualified name of\n the glossary object.\n\ + \ \"shortDescription\": \"str\", # Optional. The short version\ + \ of\n description.\n \"terms\": [\n \ + \ {\n \"description\": \"str\", # Optional. The\n\ + \ description of the related term.\n \ + \ \"displayText\": \"str\", # Optional. The\n display\ + \ text.\n \"expression\": \"str\", # Optional. The\n \ + \ expression of the term.\n \"relationGuid\"\ + : \"str\", # Optional. The GUID\n of the relationship.\n\ + \ \"source\": \"str\", # Optional. The source of\n \ + \ the term.\n \"status\": \"str\", \ + \ # Optional. The status of\n term relationship. Known\ + \ values are: \"DRAFT\", \"ACTIVE\",\n \"DEPRECATED\"\ + , \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of\n the term.\n \"\ + termGuid\": \"str\" # Optional. The GUID of\n the term.\n\ + \ }\n ]\n }\n },\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional.\n Determines if propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"language\": \"str\", # Optional. The language of the glossary.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"qualifiedName\": \"str\", # Optional. The qualified name of the glossary\n\ + \ object.\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"termInfo\": {\n \"str\": {\n \ + \ \"abbreviation\": \"str\", # Optional. The abbreviation of the\n\ + \ term.\n \"anchor\": {\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"glossaryGuid\"\ + : \"str\", # Optional. The GUID of the\n glossary.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n },\n \"antonyms\"\ + : [\n {\n \"description\": \"str\", #\ + \ Optional. The\n description of the related term.\n \ + \ \"displayText\": \"str\", # Optional. The\n \ + \ display text.\n \"expression\": \"str\"\ + , # Optional. The\n expression of the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\": \"str\"\ + , # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ term relationship. Known values are: \"DRAFT\", \"ACTIVE\",\n \ + \ \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of\n \ + \ the term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of\n the term.\n }\n \ + \ ],\n \"assignedEntities\": [\n {\n\ + \ \"displayText\": \"str\", # Optional. The\n \ + \ display text.\n \"entityStatus\": \"str\"\ + , # Optional. Status of\n the entity - can be active\ + \ or deleted. Deleted entities are not\n removed from\ + \ Atlas store. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"guid\": \"str\", # Optional. The GUID of the\n \ + \ object.\n \"relationshipAttributes\": {\n \ + \ \"attributes\": {\n \"str\": {}\ + \ # Optional. The\n attributes of the struct.\n\ + \ },\n \"lastModifiedTS\"\ + : \"str\", # Optional.\n ETag for concurrency control.\n\ + \ \"typeName\": \"str\" # Optional. The\n \ + \ name of the type.\n },\n \ + \ \"relationshipGuid\": \"str\", # Optional. The\n \ + \ GUID of the relationship.\n \"relationshipStatus\"\ + : \"str\", # Optional. The\n enum of relationship status.\ + \ Known values are: \"ACTIVE\",\n \"DELETED\".\n \ + \ \"relationshipType\": \"str\", # Optional. An\n \ + \ array of related object IDs.\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"uniqueAttributes\": {\n \"str\"\ + : {} # Optional. The unique\n attributes of the object.\n\ + \ }\n }\n ],\n \ + \ \"attributes\": {\n \"str\": {\n \ + \ \"str\": {} # Optional. The custom attributes\n of\ + \ the term, which is map>.\"nThe key of\n \ + \ the first layer map is term template name.\n \ + \ }\n },\n \"categories\": [\n \ + \ {\n \"categoryGuid\": \"str\", # Optional. The GUID\n\ + \ of the category.\n \"description\"\ + : \"str\", # Optional. The\n description of the record.\n\ + \ \"displayText\": \"str\", # Optional. The\n \ + \ display text.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID\n of the relationship.\n \ + \ \"status\": \"str\" # Optional. The status of\n \ + \ term relationship. Known values are: \"DRAFT\", \"ACTIVE\",\n\ + \ \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \ + \ }\n ],\n \"classifications\": [\n \ + \ {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \"entityGuid\"\ + : \"str\", # Optional. The GUID of\n the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of\n \ + \ the entity - can be active or deleted. Deleted entities\ + \ are not\n removed from Atlas store. Known values are:\ + \ \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag\n for concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"classifies\": [\n \ + \ {\n \"description\": \"str\", # Optional. The\n\ + \ description of the related term.\n \ + \ \"displayText\": \"str\", # Optional. The\n display\ + \ text.\n \"expression\": \"str\", # Optional. The\n \ + \ expression of the term.\n \"relationGuid\"\ + : \"str\", # Optional. The GUID\n of the relationship.\n\ + \ \"source\": \"str\", # Optional. The source of\n \ + \ the term.\n \"status\": \"str\", \ + \ # Optional. The status of\n term relationship. Known\ + \ values are: \"DRAFT\", \"ACTIVE\",\n \"DEPRECATED\"\ + , \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of\n the term.\n \"\ + termGuid\": \"str\" # Optional. The GUID of\n the term.\n\ + \ }\n ],\n \"contacts\": {\n \ + \ \"str\": [\n {\n \ + \ \"id\": \"str\", # Optional. Azure\n Active\ + \ Directory object Id.\n \"info\": \"str\" # Optional.\ + \ additional\n information to describe this contact.\n\ + \ }\n ]\n },\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who\ + \ created the\n record.\n \"examples\": [\n \ + \ \"str\" # Optional. An array of examples.\n ],\n\ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \ + \ \"isA\": [\n {\n \"description\"\ + : \"str\", # Optional. The\n description of the related\ + \ term.\n \"displayText\": \"str\", # Optional. The\n \ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ term relationship. Known values are: \"DRAFT\", \"ACTIVE\"\ + ,\n \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of\n \ + \ the term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of\n the term.\n }\n \ + \ ],\n \"lastModifiedTS\": \"str\", # Optional. ETag\ + \ for concurrency\n control.\n \"longDescription\"\ + : \"str\", # Optional. The long version\n description.\n \ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n\ + \ \"preferredTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The\n description\ + \ of the related term.\n \"displayText\": \"str\", # Optional.\ + \ The\n display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ term relationship. Known values are: \"DRAFT\", \"ACTIVE\"\ + ,\n \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of\n \ + \ the term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of\n the term.\n }\n \ + \ ],\n \"preferredToTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the related term.\n \"displayText\"\ + : \"str\", # Optional. The\n display text.\n \ + \ \"expression\": \"str\", # Optional. The\n \ + \ expression of the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID\n of the relationship.\n \ + \ \"source\": \"str\", # Optional. The source of\n \ + \ the term.\n \"status\": \"str\", # Optional.\ + \ The status of\n term relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\",\n \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"qualifiedName\": \"str\"\ + , # Optional. The qualified name of\n the glossary object.\n\ + \ \"replacedBy\": [\n {\n \ + \ \"description\": \"str\", # Optional. The\n description\ + \ of the related term.\n \"displayText\": \"str\", # Optional.\ + \ The\n display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ term relationship. Known values are: \"DRAFT\", \"ACTIVE\"\ + ,\n \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of\n \ + \ the term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of\n the term.\n }\n \ + \ ],\n \"replacementTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the related term.\n \"displayText\"\ + : \"str\", # Optional. The\n display text.\n \ + \ \"expression\": \"str\", # Optional. The\n \ + \ expression of the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID\n of the relationship.\n \ + \ \"source\": \"str\", # Optional. The source of\n \ + \ the term.\n \"status\": \"str\", # Optional.\ + \ The status of\n term relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\",\n \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"resources\": [\n \ + \ {\n \"displayName\": \"str\", # Optional.\ + \ Display\n name for url.\n \"url\"\ + : \"str\" # Optional. web url. http or\n https.\n \ + \ }\n ],\n \"seeAlso\": [\n \ + \ {\n \"description\": \"str\", # Optional.\ + \ The\n description of the related term.\n \ + \ \"displayText\": \"str\", # Optional. The\n \ + \ display text.\n \"expression\": \"str\", # Optional.\ + \ The\n expression of the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\": \"str\", # Optional.\ + \ The source of\n the term.\n \"\ + status\": \"str\", # Optional. The status of\n term relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\",\n \"DEPRECATED\"\ + , \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of\n the term.\n \"\ + termGuid\": \"str\" # Optional. The GUID of\n the term.\n\ + \ }\n ],\n \"shortDescription\"\ + : \"str\", # Optional. The short version of\n description.\n\ + \ \"status\": \"str\", # Optional. Status of the\n \ + \ AtlasGlossaryTerm. Known values are: \"Draft\", \"Approved\", \"Alert\"\ + ,\n \"Expired\".\n \"synonyms\": [\n \ + \ {\n \"description\": \"str\", # Optional. The\n\ + \ description of the related term.\n \ + \ \"displayText\": \"str\", # Optional. The\n display\ + \ text.\n \"expression\": \"str\", # Optional. The\n \ + \ expression of the term.\n \"relationGuid\"\ + : \"str\", # Optional. The GUID\n of the relationship.\n\ + \ \"source\": \"str\", # Optional. The source of\n \ + \ the term.\n \"status\": \"str\", \ + \ # Optional. The status of\n term relationship. Known\ + \ values are: \"DRAFT\", \"ACTIVE\",\n \"DEPRECATED\"\ + , \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of\n the term.\n \"\ + termGuid\": \"str\" # Optional. The GUID of\n the term.\n\ + \ }\n ],\n \"templateName\": [\n\ + \ {} # Optional. The glossary term information.\n \ + \ ],\n \"translatedTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the related term.\n \"displayText\"\ + : \"str\", # Optional. The\n display text.\n \ + \ \"expression\": \"str\", # Optional. The\n \ + \ expression of the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID\n of the relationship.\n \ + \ \"source\": \"str\", # Optional. The source of\n \ + \ the term.\n \"status\": \"str\", # Optional.\ + \ The status of\n term relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\",\n \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"translationTerms\": [\n\ + \ {\n \"description\": \"str\", # Optional.\ + \ The\n description of the related term.\n \ + \ \"displayText\": \"str\", # Optional. The\n \ + \ display text.\n \"expression\": \"str\", # Optional.\ + \ The\n expression of the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\": \"str\", # Optional.\ + \ The source of\n the term.\n \"\ + status\": \"str\", # Optional. The status of\n term relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\",\n \"DEPRECATED\"\ + , \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of\n the term.\n \"\ + termGuid\": \"str\" # Optional. The GUID of\n the term.\n\ + \ }\n ],\n \"updateTime\": 0.0,\ + \ # Optional. The update time of the\n record.\n \ + \ \"updatedBy\": \"str\", # Optional. The user who updated the\n \ + \ record.\n \"usage\": \"str\", # Optional. The usage of\ + \ the term.\n \"validValues\": [\n {\n \ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the related term.\n \"displayText\"\ + : \"str\", # Optional. The\n display text.\n \ + \ \"expression\": \"str\", # Optional. The\n \ + \ expression of the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID\n of the relationship.\n \ + \ \"source\": \"str\", # Optional. The source of\n \ + \ the term.\n \"status\": \"str\", # Optional.\ + \ The status of\n term relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\",\n \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"validValuesFor\": [\n \ + \ {\n \"description\": \"str\", # Optional.\ + \ The\n description of the related term.\n \ + \ \"displayText\": \"str\", # Optional. The\n \ + \ display text.\n \"expression\": \"str\", # Optional.\ + \ The\n expression of the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\": \"str\", # Optional.\ + \ The source of\n the term.\n \"\ + status\": \"str\", # Optional. The status of\n term relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\",\n \"DEPRECATED\"\ + , \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of\n the term.\n \"\ + termGuid\": \"str\" # Optional. The GUID of\n the term.\n\ + \ }\n ]\n }\n },\n \"terms\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"usage\": \"str\" # Optional. The usage\ + \ of the glossary.\n }\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.get_entities_assigned_with_term + name: get_entities_assigned_with_term + summary: Get all related objects assigned with the specified term. + signature: 'get_entities_assigned_with_term(term_guid: str, *, limit: int | None + = None, offset: int | None = None, sort: str | None = ''ASC'', **kwargs: Any) + -> List[MutableMapping[str, Any]]' + parameters: + - name: term_guid + description: The globally unique identifier for glossary term. + isRequired: true + types: + - + keywordOnlyParameters: + - name: limit + description: The page size - by default there is no paging. Default value is None. + types: + - + - name: offset + description: The offset for pagination purpose. Default value is None. + types: + - + - name: sort + description: The sort order, ASC (default) or DESC. Default value is "ASC". + types: + - + return: + description: list of JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == [\n {\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity - can be\n \ + \ active or deleted. Deleted entities are not removed from Atlas store.\ + \ Known\n values are: \"ACTIVE\", \"DELETED\".\n \"guid\"\ + : \"str\", # Optional. The GUID of the object.\n \"relationshipAttributes\"\ + : {\n \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes of the struct.\n },\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"typeName\": \"str\" # Optional. The name of the type.\n \ + \ },\n \"relationshipGuid\": \"str\", # Optional. The GUID of the\ + \ relationship.\n \"relationshipStatus\": \"str\", # Optional. The\ + \ enum of relationship\n status. Known values are: \"ACTIVE\", \"\ + DELETED\".\n \"relationshipType\": \"str\", # Optional.\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \"uniqueAttributes\"\ + : {\n \"str\": {} # Optional. The unique attributes of the object.\n\ + \ }\n }\n ]\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.get_glossary + name: get_glossary + summary: Get a specific Glossary by its GUID. + signature: 'get_glossary(glossary_guid: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: glossary_guid + description: The globally unique identifier for glossary. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + categories\": [\n {\n \"categoryGuid\": \"str\", # Optional.\ + \ The GUID of the category.\n \"description\": \"str\", # Optional.\ + \ The description of the\n category header.\n \"\ + displayText\": \"str\", # Optional. The display text.\n \"parentCategoryGuid\"\ + : \"str\", # Optional. The GUID of the\n parent category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional.\n Determines if propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"language\": \"str\", # Optional. The language of the glossary.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"qualifiedName\": \"str\", # Optional. The qualified name of the glossary\n\ + \ object.\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"terms\": [\n {\n \"\ + description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"expression\": \"str\", # Optional. The expression of\ + \ the term.\n \"relationGuid\": \"str\", # Optional. The GUID of\ + \ the\n relationship.\n \"source\": \"str\", #\ + \ Optional. The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"DRAFT\"\ + , \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"usage\": \"str\" # Optional. The usage of the glossary.\n\ + \ }\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.get_glossary_category + name: get_glossary_category + summary: Get specific glossary category by its GUID. + signature: 'get_glossary_category(category_guid: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: category_guid + description: The globally unique identifier of the category. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + anchor\": {\n \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"glossaryGuid\": \"str\", # Optional. The GUID of the glossary.\n\ + \ \"relationGuid\": \"str\" # Optional. The GUID of the relationship.\n\ + \ },\n \"childrenCategories\": [\n {\n \"\ + categoryGuid\": \"str\", # Optional. The GUID of the category.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ category header.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"parentCategoryGuid\": \"str\", # Optional.\ + \ The GUID of the\n parent category.\n \"relationGuid\"\ + : \"str\" # Optional. The GUID of the\n relationship.\n \ + \ }\n ],\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"entityGuid\": \"str\", \ + \ # Optional. The GUID of the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of the entity -\n can be active or deleted.\ + \ Deleted entities are not removed from Atlas\n store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\", \ + \ # Optional. ETag for concurrency\n control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, # Optional.\n Determines\ + \ if propagations will be removed on entity deletion.\n \"source\"\ + : \"str\", # Optional. indicate the source who create\n the classification\ + \ detail.\n \"sourceDetails\": {\n \"str\": {}\ + \ # Optional. more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"\ + str\", # Optional. The start of\n the time boundary.\n\ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n \ + \ ]\n }\n ],\n \"guid\": \"str\", # Optional. The GUID\ + \ of the object.\n \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\ + \ control.\n \"longDescription\": \"str\", # Optional. The long version\ + \ description.\n \"name\": \"str\", # Optional. The name of the glossary\ + \ object.\n \"parentCategory\": {\n \"categoryGuid\": \"str\"\ + , # Optional. The GUID of the category.\n \"description\": \"str\"\ + , # Optional. The description of the category\n header.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \"parentCategoryGuid\"\ + : \"str\", # Optional. The GUID of the parent\n category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the relationship.\n\ + \ },\n \"qualifiedName\": \"str\", # Optional. The qualified name\ + \ of the glossary\n object.\n \"shortDescription\": \"str\", #\ + \ Optional. The short version of description.\n \"terms\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description of\ + \ the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.get_glossary_term + name: get_glossary_term + summary: Get a specific glossary term by its GUID. + signature: 'get_glossary_term(term_guid: str, *, include_term_hierarchy: bool | + None = False, exclude_relationship_type_list: List[str] | None = None, **kwargs: + Any) -> MutableMapping[str, Any]' + parameters: + - name: term_guid + description: The globally unique identifier for glossary term. + isRequired: true + types: + - + keywordOnlyParameters: + - name: include_term_hierarchy + description: Whether include term hierarchy. Default value is False. + types: + - + - name: exclude_relationship_type_list + description: 'An array of relationship types which need to be + + excluded. Default value is None.' + types: + - [] + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + abbreviation\": \"str\", # Optional. The abbreviation of the term.\n \"\ + anchor\": {\n \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"glossaryGuid\": \"str\", # Optional. The GUID of the glossary.\n\ + \ \"relationGuid\": \"str\" # Optional. The GUID of the relationship.\n\ + \ },\n \"antonyms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"assignedEntities\": [\n {\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from Atlas\n\ + \ store. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \ + \ \"relationshipAttributes\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for\n concurrency control.\n\ + \ \"typeName\": \"str\" # Optional. The name of the type.\n\ + \ },\n \"relationshipGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"relationshipStatus\"\ + : \"str\", # Optional. The enum of\n relationship status. Known\ + \ values are: \"ACTIVE\", \"DELETED\".\n \"relationshipType\": \"\ + str\", # Optional. An array of related\n object IDs.\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"uniqueAttributes\": {\n \"str\": {} # Optional. The\ + \ unique attributes of the\n object.\n }\n \ + \ }\n ],\n \"attributes\": {\n \"str\": {\n \ + \ \"str\": {} # Optional. The custom attributes of the term,\n \ + \ which is map>.\"nThe key of the first\ + \ layer map\n is term template name.\n }\n },\n\ + \ \"categories\": [\n {\n \"categoryGuid\": \"str\"\ + , # Optional. The GUID of the category.\n \"description\": \"str\"\ + , # Optional. The description of the\n record.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \"\ + relationGuid\": \"str\", # Optional. The GUID of the\n relationship.\n\ + \ \"status\": \"str\" # Optional. The status of term relationship.\n\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\", \"\ + OBSOLETE\", \"OTHER\".\n }\n ],\n \"classifications\": [\n\ + \ {\n \"attributes\": {\n \"str\": {}\ + \ # Optional. The attributes of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from Atlas\n\ + \ store. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"removePropagationsOnEntityDelete\": bool,\ + \ # Optional.\n Determines if propagations will be removed on\ + \ entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"classifies\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"contacts\": {\n \"str\": [\n \ + \ {\n \"id\": \"str\", # Optional. Azure Active Directory\n\ + \ object Id.\n \"info\": \"str\" # Optional.\ + \ additional information to\n describe this contact.\n \ + \ }\n ]\n },\n \"createTime\": 0.0, # Optional.\ + \ The created time of the record.\n \"createdBy\": \"str\", # Optional.\ + \ The user who created the record.\n \"examples\": [\n \"str\"\ + \ # Optional. An array of examples.\n ],\n \"guid\": \"str\", #\ + \ Optional. The GUID of the object.\n \"isA\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"longDescription\": \"str\", # Optional.\ + \ The long version description.\n \"name\": \"str\", # Optional. The name\ + \ of the glossary object.\n \"preferredTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"preferredToTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"qualifiedName\": \"str\", # Optional.\ + \ The qualified name of the glossary\n object.\n \"replacedBy\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"replacementTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"resources\": [\n {\n \ + \ \"displayName\": \"str\", # Optional. Display name for url.\n \ + \ \"url\": \"str\" # Optional. web url. http or https.\n \ + \ }\n ],\n \"seeAlso\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"status\": \"str\", # Optional. Status of\ + \ the AtlasGlossaryTerm. Known values\n are: \"Draft\", \"Approved\",\ + \ \"Alert\", \"Expired\".\n \"synonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"templateName\": [\n {} # Optional.\n\ + \ ],\n \"translatedTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"translationTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"updateTime\": 0.0, # Optional. The\ + \ update time of the record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the record.\n \"usage\": \"str\", # Optional. The usage\ + \ of the term.\n \"validValues\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"validValuesFor\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.get_import_csv_operation_status + name: get_import_csv_operation_status + summary: Get the status of import csv operation. + signature: 'get_import_csv_operation_status(operation_guid: str, **kwargs: Any) + -> MutableMapping[str, Any]' + parameters: + - name: operation_guid + description: The globally unique identifier for async operation/job. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + createTime\": \"str\", # Optional. The created time of the record.\n \"\ + error\": {\n \"errorCode\": 0, # Optional. Error code from async import\ + \ job if\n fail.\n \"errorMessage\": \"str\" # Optional.\ + \ Error message from async import\n job if fail.\n },\n \ + \ \"id\": \"str\", # Optional. guid string.\n \"lastUpdateTime\": \"\ + str\", # Optional. The last updated time of the record.\n \"properties\"\ + : {\n \"importedTerms\": \"str\", # Optional. Term numbers that already\n\ + \ imported successfully.\n \"totalTermsDetected\": \"str\"\ + \ # Optional. Total term numbers that\n detected in csv.\n \ + \ },\n \"status\": \"str\" # Optional. Enum of the status of import csv\ + \ operation.\n Known values are: \"NotStarted\", \"Succeeded\", \"Failed\"\ + , \"Running\".\n }\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.list_category_terms + name: list_category_terms + summary: Get all terms associated with the specific category. + signature: 'list_category_terms(category_guid: str, *, limit: int | None = None, + offset: int | None = None, sort: str | None = ''ASC'', **kwargs: Any) -> List[MutableMapping[str, + Any]]' + parameters: + - name: category_guid + description: The globally unique identifier of the category. + isRequired: true + types: + - + keywordOnlyParameters: + - name: limit + description: The page size - by default there is no paging. Default value is None. + types: + - + - name: offset + description: The offset for pagination purpose. Default value is None. + types: + - + - name: sort + description: The sort order, ASC (default) or DESC. Default value is "ASC". + types: + - + return: + description: list of JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the related\n\ + \ term.\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"expression\": \"str\", # Optional. The expression of the\ + \ term.\n \"relationGuid\": \"str\", # Optional. The GUID of the relationship.\n\ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term relationship. Known\n\ + \ values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of the\ + \ term.\n \"termGuid\": \"str\" # Optional. The GUID of the term.\n\ + \ }\n ]\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.list_glossaries + name: list_glossaries + summary: Get all glossaries registered with Atlas. + signature: 'list_glossaries(*, limit: int | None = None, offset: int | None = None, + sort: str | None = ''ASC'', ignore_terms_and_categories: bool | None = False, + **kwargs: Any) -> List[MutableMapping[str, Any]]' + keywordOnlyParameters: + - name: limit + description: The page size - by default there is no paging. Default value is None. + types: + - + - name: offset + description: The offset for pagination purpose. Default value is None. + types: + - + - name: sort + description: The sort order, ASC (default) or DESC. Default value is "ASC". + types: + - + - name: ignore_terms_and_categories + description: 'Whether ignore terms and categories. Default value is + + False.' + types: + - + return: + description: list of JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == [\n {\n\ + \ \"categories\": [\n {\n \"categoryGuid\"\ + : \"str\", # Optional. The GUID of the\n category.\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the category header.\n \"displayText\":\ + \ \"str\", # Optional. The display text.\n \"parentCategoryGuid\"\ + : \"str\", # Optional. The GUID of\n the parent category.\n\ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ],\n \ + \ \"classifications\": [\n {\n \"attributes\"\ + : {\n \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"\ + entityGuid\": \"str\", # Optional. The GUID of the\n entity.\n\ + \ \"entityStatus\": \"str\", # Optional. Status of the\n \ + \ entity - can be active or deleted. Deleted entities are not\ + \ removed\n from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional. ETag\ + \ for\n concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, #\n Optional. Determines if propagations will be\ + \ removed on entity\n deletion.\n \"source\"\ + : \"str\", # Optional. indicate the source who\n create the\ + \ classification detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on source\n \ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of the type.\n \"validityPeriods\"\ + : [\n {\n \"endTime\": \"str\"\ + , # Optional. The\n end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n \ + \ start of the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The\n timezone\ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID\ + \ of the object.\n \"language\": \"str\", # Optional. The language\ + \ of the glossary.\n \"lastModifiedTS\": \"str\", # Optional. ETag\ + \ for concurrency control.\n \"longDescription\": \"str\", # Optional.\ + \ The long version description.\n \"name\": \"str\", # Optional. The\ + \ name of the glossary object.\n \"qualifiedName\": \"str\", # Optional.\ + \ The qualified name of the\n glossary object.\n \"shortDescription\"\ + : \"str\", # Optional. The short version of\n description.\n \ + \ \"terms\": [\n {\n \"description\": \"\ + str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"usage\": \"str\" # Optional. The usage\ + \ of the glossary.\n }\n ]\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.list_glossary_categories + name: list_glossary_categories + summary: Get the categories belonging to a specific glossary. + signature: 'list_glossary_categories(glossary_guid: str, *, limit: int | None = + None, offset: int | None = None, sort: str | None = ''ASC'', **kwargs: Any) -> + List[MutableMapping[str, Any]]' + parameters: + - name: glossary_guid + description: The globally unique identifier for glossary. + isRequired: true + types: + - + keywordOnlyParameters: + - name: limit + description: The page size - by default there is no paging. Default value is None. + types: + - + - name: offset + description: The offset for pagination purpose. Default value is None. + types: + - + - name: sort + description: The sort order, ASC (default) or DESC. Default value is "ASC". + types: + - + return: + description: list of JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == [\n {\n\ + \ \"anchor\": {\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"glossaryGuid\": \"str\", # Optional. The\ + \ GUID of the glossary.\n \"relationGuid\": \"str\" # Optional.\ + \ The GUID of the\n relationship.\n },\n \"\ + childrenCategories\": [\n {\n \"categoryGuid\"\ + : \"str\", # Optional. The GUID of the\n category.\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the category header.\n \"displayText\":\ + \ \"str\", # Optional. The display text.\n \"parentCategoryGuid\"\ + : \"str\", # Optional. The GUID of\n the parent category.\n\ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ],\n \ + \ \"classifications\": [\n {\n \"attributes\"\ + : {\n \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"\ + entityGuid\": \"str\", # Optional. The GUID of the\n entity.\n\ + \ \"entityStatus\": \"str\", # Optional. Status of the\n \ + \ entity - can be active or deleted. Deleted entities are not\ + \ removed\n from Atlas store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional. ETag\ + \ for\n concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, #\n Optional. Determines if propagations will be\ + \ removed on entity\n deletion.\n \"source\"\ + : \"str\", # Optional. indicate the source who\n create the\ + \ classification detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on source\n \ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of the type.\n \"validityPeriods\"\ + : [\n {\n \"endTime\": \"str\"\ + , # Optional. The\n end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n \ + \ start of the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The\n timezone\ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID\ + \ of the object.\n \"lastModifiedTS\": \"str\", # Optional. ETag for\ + \ concurrency control.\n \"longDescription\": \"str\", # Optional.\ + \ The long version description.\n \"name\": \"str\", # Optional. The\ + \ name of the glossary object.\n \"parentCategory\": {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the category.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ category header.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"parentCategoryGuid\": \"str\", # Optional.\ + \ The GUID of the\n parent category.\n \"relationGuid\"\ + : \"str\" # Optional. The GUID of the\n relationship.\n \ + \ },\n \"qualifiedName\": \"str\", # Optional. The qualified name\ + \ of the\n glossary object.\n \"shortDescription\": \"str\"\ + , # Optional. The short version of\n description.\n \"\ + terms\": [\n {\n \"description\": \"str\", #\ + \ Optional. The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", #\ + \ Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ]\n }\n ]\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.list_glossary_categories_headers + name: list_glossary_categories_headers + summary: Get the category headers belonging to a specific glossary. + signature: 'list_glossary_categories_headers(glossary_guid: str, *, limit: int | + None = None, offset: int | None = None, sort: str | None = ''ASC'', **kwargs: + Any) -> List[MutableMapping[str, Any]]' + parameters: + - name: glossary_guid + description: The globally unique identifier for glossary. + isRequired: true + types: + - + keywordOnlyParameters: + - name: limit + description: The page size - by default there is no paging. Default value is None. + types: + - + - name: offset + description: The offset for pagination purpose. Default value is None. + types: + - + - name: sort + description: The sort order, ASC (default) or DESC. Default value is "ASC". + types: + - + return: + description: list of JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == [\n {\n\ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the category.\n\ + \ \"description\": \"str\", # Optional. The description of the category\n\ + \ header.\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"parentCategoryGuid\": \"str\", # Optional. The GUID of\ + \ the parent\n category.\n \"relationGuid\": \"str\" #\ + \ Optional. The GUID of the relationship.\n }\n ]\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.list_glossary_term_headers + name: list_glossary_term_headers + summary: Get term headers belonging to a specific glossary. + signature: 'list_glossary_term_headers(glossary_guid: str, *, limit: int | None + = None, offset: int | None = None, sort: str | None = ''ASC'', **kwargs: Any) + -> List[MutableMapping[str, Any]]' + parameters: + - name: glossary_guid + description: The globally unique identifier for glossary. + isRequired: true + types: + - + keywordOnlyParameters: + - name: limit + description: The page size - by default there is no paging. Default value is None. + types: + - + - name: offset + description: The offset for pagination purpose. Default value is None. + types: + - + - name: sort + description: The sort order, ASC (default) or DESC. Default value is "ASC". + types: + - + return: + description: list of JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the related\n\ + \ term.\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"expression\": \"str\", # Optional. The expression of the\ + \ term.\n \"relationGuid\": \"str\", # Optional. The GUID of the relationship.\n\ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term relationship. Known\n\ + \ values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of the\ + \ term.\n \"termGuid\": \"str\" # Optional. The GUID of the term.\n\ + \ }\n ]\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.list_glossary_terms + name: list_glossary_terms + summary: Get terms belonging to a specific glossary. + signature: 'list_glossary_terms(glossary_guid: str, *, include_term_hierarchy: bool + | None = False, limit: int | None = None, offset: int | None = None, sort: str + | None = ''ASC'', **kwargs: Any) -> List[MutableMapping[str, Any]]' + parameters: + - name: glossary_guid + description: The globally unique identifier for glossary. + isRequired: true + types: + - + keywordOnlyParameters: + - name: include_term_hierarchy + description: Whether include term hierarchy. Default value is False. + types: + - + - name: limit + description: The page size - by default there is no paging. Default value is None. + types: + - + - name: offset + description: The offset for pagination purpose. Default value is None. + types: + - + - name: sort + description: The sort order, ASC (default) or DESC. Default value is "ASC". + types: + - + return: + description: list of JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == [\n {\n\ + \ \"abbreviation\": \"str\", # Optional. The abbreviation of the term.\n\ + \ \"anchor\": {\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"glossaryGuid\": \"str\", # Optional. The\ + \ GUID of the glossary.\n \"relationGuid\": \"str\" # Optional.\ + \ The GUID of the\n relationship.\n },\n \"\ + antonyms\": [\n {\n \"description\": \"str\",\ + \ # Optional. The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\",\ + \ # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"assignedEntities\": [\n \ + \ {\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"entityStatus\": \"str\", # Optional. Status of\ + \ the\n entity - can be active or deleted. Deleted entities\ + \ are not removed\n from Atlas store. Known values are: \"\ + ACTIVE\", \"DELETED\".\n \"guid\": \"str\", # Optional. The\ + \ GUID of the object.\n \"relationshipAttributes\": {\n \ + \ \"attributes\": {\n \"str\": {}\ + \ # Optional. The attributes\n of the struct.\n \ + \ },\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag\n for concurrency control.\n \ + \ \"typeName\": \"str\" # Optional. The name of\n \ + \ the type.\n },\n \"relationshipGuid\"\ + : \"str\", # Optional. The GUID of\n the relationship.\n\ + \ \"relationshipStatus\": \"str\", # Optional. The enum of\n\ + \ relationship status. Known values are: \"ACTIVE\", \"DELETED\"\ + .\n \"relationshipType\": \"str\", # Optional. An array of\n\ + \ related object IDs.\n \"typeName\": \"\ + str\", # Optional. The name of the type.\n \"uniqueAttributes\"\ + : {\n \"str\": {} # Optional. The unique attributes\n \ + \ of the object.\n }\n \ + \ }\n ],\n \"attributes\": {\n \"str\": {\n\ + \ \"str\": {} # Optional. The custom attributes of the\n \ + \ term, which is map>.\"nThe key of\ + \ the first\n layer map is term template name.\n \ + \ }\n },\n \"categories\": [\n {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the\n \ + \ category.\n \"description\": \"str\", # Optional.\ + \ The description of\n the record.\n \"\ + displayText\": \"str\", # Optional. The display text.\n \"\ + relationGuid\": \"str\", # Optional. The GUID of the\n relationship.\n\ + \ \"status\": \"str\" # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n }\n \ + \ ],\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the\n struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the\n \ + \ entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of the\n entity - can be active or deleted. Deleted\ + \ entities are not removed\n from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag for\n concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who\n create the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional.\ + \ more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n \ + \ {\n \"endTime\": \"str\", # Optional. The\n \ + \ end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n start\ + \ of the time boundary.\n \"timeZone\": \"str\" # Optional.\ + \ The\n timezone of the time boundary.\n \ + \ }\n ]\n }\n ],\n \ + \ \"classifies\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"contacts\": {\n \"str\"\ + : [\n {\n \"id\": \"str\", # Optional.\ + \ Azure Active\n Directory object Id.\n \ + \ \"info\": \"str\" # Optional. additional\n \ + \ information to describe this contact.\n }\n \ + \ ]\n },\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who\ + \ created the record.\n \"examples\": [\n \"str\" # Optional.\ + \ An array of examples.\n ],\n \"guid\": \"str\", # Optional.\ + \ The GUID of the object.\n \"isA\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\",\ + \ # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency control.\n \"longDescription\"\ + : \"str\", # Optional. The long version description.\n \"name\": \"\ + str\", # Optional. The name of the glossary object.\n \"preferredTerms\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"preferredToTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"qualifiedName\": \"str\", # Optional.\ + \ The qualified name of the\n glossary object.\n \"replacedBy\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"replacementTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"resources\": [\n {\n\ + \ \"displayName\": \"str\", # Optional. Display name for\n\ + \ url.\n \"url\": \"str\" # Optional. web\ + \ url. http or https.\n }\n ],\n \"seeAlso\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"shortDescription\": \"str\", # Optional. The short version of\n\ + \ description.\n \"status\": \"str\", # Optional. Status\ + \ of the AtlasGlossaryTerm. Known\n values are: \"Draft\", \"Approved\"\ + , \"Alert\", \"Expired\".\n \"synonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the related term.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"templateName\"\ + : [\n {} # Optional.\n ],\n \"translatedTerms\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"translationTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"updateTime\": 0.0, # Optional. The\ + \ update time of the record.\n \"updatedBy\": \"str\", # Optional.\ + \ The user who updated the record.\n \"usage\": \"str\", # Optional.\ + \ The usage of the term.\n \"validValues\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n\ + \ the related term.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"validValuesFor\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ]\n\ + \ }\n ]\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.list_related_categories + name: list_related_categories + summary: 'Get all related categories (parent and children). Limit, offset, and sort + parameters are + + currently not being enabled and won''t work even they are passed.' + signature: 'list_related_categories(category_guid: str, *, limit: int | None = None, + offset: int | None = None, sort: str | None = ''ASC'', **kwargs: Any) -> Dict[str, + List[MutableMapping[str, Any]]]' + parameters: + - name: category_guid + description: The globally unique identifier of the category. + isRequired: true + types: + - + keywordOnlyParameters: + - name: limit + description: The page size - by default there is no paging. Default value is None. + types: + - + - name: offset + description: The offset for pagination purpose. Default value is None. + types: + - + - name: sort + description: The sort order, ASC (default) or DESC. Default value is "ASC". + types: + - + return: + description: dict mapping str to list of JSON object + types: + - [, []] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + str\": [\n {\n \"categoryGuid\": \"str\", # Optional.\ + \ The GUID of the category.\n \"description\": \"str\", # Optional.\ + \ The description of the\n category header.\n \"\ + displayText\": \"str\", # Optional. The display text.\n \"parentCategoryGuid\"\ + : \"str\", # Optional. The GUID of the\n parent category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.list_related_terms + name: list_related_terms + summary: 'Get all related terms for a specific term by its GUID. Limit, offset, + and sort parameters are + + currently not being enabled and won''t work even they are passed.' + signature: 'list_related_terms(term_guid: str, *, limit: int | None = None, offset: + int | None = None, sort: str | None = ''ASC'', **kwargs: Any) -> Dict[str, List[MutableMapping[str, + Any]]]' + parameters: + - name: term_guid + description: The globally unique identifier for glossary term. + isRequired: true + types: + - + keywordOnlyParameters: + - name: limit + description: The page size - by default there is no paging. Default value is None. + types: + - + - name: offset + description: The offset for pagination purpose. Default value is None. + types: + - + - name: sort + description: The sort order, ASC (default) or DESC. Default value is "ASC". + types: + - + return: + description: dict mapping str to list of JSON object + types: + - [, []] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + str\": [\n {\n \"description\": \"str\", # Optional.\ + \ The description of the\n related term.\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of the term.\n \"relationGuid\": \"\ + str\", # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"\ + OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional. The\ + \ steward of the term.\n \"termGuid\": \"str\" # Optional. The\ + \ GUID of the term.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.list_terms_by_glossary_name + name: list_terms_by_glossary_name + summary: Get terms by glossary name. + signature: 'list_terms_by_glossary_name(glossary_name: str, *, limit: int | None + = None, offset: int | None = None, include_term_hierarchy: bool | None = False, + **kwargs: Any) -> List[MutableMapping[str, Any]]' + parameters: + - name: glossary_name + description: The name of the glossary. + isRequired: true + types: + - + keywordOnlyParameters: + - name: limit + description: The page size - by default there is no paging. Default value is None. + types: + - + - name: offset + description: The offset for pagination purpose. Default value is None. + types: + - + - name: include_term_hierarchy + description: Whether include term hierarchy. Default value is False. + types: + - + return: + description: list of JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == [\n {\n\ + \ \"abbreviation\": \"str\", # Optional. The abbreviation of the term.\n\ + \ \"anchor\": {\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"glossaryGuid\": \"str\", # Optional. The\ + \ GUID of the glossary.\n \"relationGuid\": \"str\" # Optional.\ + \ The GUID of the\n relationship.\n },\n \"\ + antonyms\": [\n {\n \"description\": \"str\",\ + \ # Optional. The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\",\ + \ # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"assignedEntities\": [\n \ + \ {\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"entityStatus\": \"str\", # Optional. Status of\ + \ the\n entity - can be active or deleted. Deleted entities\ + \ are not removed\n from Atlas store. Known values are: \"\ + ACTIVE\", \"DELETED\".\n \"guid\": \"str\", # Optional. The\ + \ GUID of the object.\n \"relationshipAttributes\": {\n \ + \ \"attributes\": {\n \"str\": {}\ + \ # Optional. The attributes\n of the struct.\n \ + \ },\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag\n for concurrency control.\n \ + \ \"typeName\": \"str\" # Optional. The name of\n \ + \ the type.\n },\n \"relationshipGuid\"\ + : \"str\", # Optional. The GUID of\n the relationship.\n\ + \ \"relationshipStatus\": \"str\", # Optional. The enum of\n\ + \ relationship status. Known values are: \"ACTIVE\", \"DELETED\"\ + .\n \"relationshipType\": \"str\", # Optional. An array of\n\ + \ related object IDs.\n \"typeName\": \"\ + str\", # Optional. The name of the type.\n \"uniqueAttributes\"\ + : {\n \"str\": {} # Optional. The unique attributes\n \ + \ of the object.\n }\n \ + \ }\n ],\n \"attributes\": {\n \"str\": {\n\ + \ \"str\": {} # Optional. The custom attributes of the\n \ + \ term, which is map>.\"nThe key of\ + \ the first\n layer map is term template name.\n \ + \ }\n },\n \"categories\": [\n {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the\n \ + \ category.\n \"description\": \"str\", # Optional.\ + \ The description of\n the record.\n \"\ + displayText\": \"str\", # Optional. The display text.\n \"\ + relationGuid\": \"str\", # Optional. The GUID of the\n relationship.\n\ + \ \"status\": \"str\" # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n }\n \ + \ ],\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the\n struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the\n \ + \ entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of the\n entity - can be active or deleted. Deleted\ + \ entities are not removed\n from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag for\n concurrency control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n \ + \ deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who\n create the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional.\ + \ more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n \ + \ {\n \"endTime\": \"str\", # Optional. The\n \ + \ end of the time boundary.\n \ + \ \"startTime\": \"str\", # Optional. The\n start\ + \ of the time boundary.\n \"timeZone\": \"str\" # Optional.\ + \ The\n timezone of the time boundary.\n \ + \ }\n ]\n }\n ],\n \ + \ \"classifies\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"contacts\": {\n \"str\"\ + : [\n {\n \"id\": \"str\", # Optional.\ + \ Azure Active\n Directory object Id.\n \ + \ \"info\": \"str\" # Optional. additional\n \ + \ information to describe this contact.\n }\n \ + \ ]\n },\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who\ + \ created the record.\n \"examples\": [\n \"str\" # Optional.\ + \ An array of examples.\n ],\n \"guid\": \"str\", # Optional.\ + \ The GUID of the object.\n \"isA\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\",\ + \ # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency control.\n \"longDescription\"\ + : \"str\", # Optional. The long version description.\n \"name\": \"\ + str\", # Optional. The name of the glossary object.\n \"preferredTerms\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"preferredToTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"qualifiedName\": \"str\", # Optional.\ + \ The qualified name of the\n glossary object.\n \"replacedBy\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"replacementTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"resources\": [\n {\n\ + \ \"displayName\": \"str\", # Optional. Display name for\n\ + \ url.\n \"url\": \"str\" # Optional. web\ + \ url. http or https.\n }\n ],\n \"seeAlso\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"shortDescription\": \"str\", # Optional. The short version of\n\ + \ description.\n \"status\": \"str\", # Optional. Status\ + \ of the AtlasGlossaryTerm. Known\n values are: \"Draft\", \"Approved\"\ + , \"Alert\", \"Expired\".\n \"synonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n \ + \ the related term.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"templateName\"\ + : [\n {} # Optional.\n ],\n \"translatedTerms\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ],\n\ + \ \"translationTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of\n the related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n\ + \ \"expression\": \"str\", # Optional. The expression of\n\ + \ the term.\n \"relationGuid\": \"str\"\ + , # Optional. The GUID of the\n relationship.\n \ + \ \"source\": \"str\", # Optional. The source of the term.\n \ + \ \"status\": \"str\", # Optional. The status of term\n \ + \ relationship. Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\"\ + ,\n \"OBSOLETE\", \"OTHER\".\n \"steward\"\ + : \"str\", # Optional. The steward of the\n term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"updateTime\": 0.0, # Optional. The\ + \ update time of the record.\n \"updatedBy\": \"str\", # Optional.\ + \ The user who updated the record.\n \"usage\": \"str\", # Optional.\ + \ The usage of the term.\n \"validValues\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of\n\ + \ the related term.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"expression\": \"str\"\ + , # Optional. The expression of\n the term.\n \ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"\ + DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the\n\ + \ term.\n \"termGuid\": \"str\" # Optional.\ + \ The GUID of the term.\n }\n ],\n \"validValuesFor\"\ + : [\n {\n \"description\": \"str\", # Optional.\ + \ The description of\n the related term.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of\n \ + \ the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\"\ + : \"str\", # Optional. The source of the term.\n \"status\"\ + : \"str\", # Optional. The status of term\n relationship.\ + \ Known values are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \ + \ \"OBSOLETE\", \"OTHER\".\n \"steward\": \"str\", # Optional.\ + \ The steward of the\n term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of the term.\n }\n ]\n\ + \ }\n ]\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.partial_update_glossary + name: partial_update_glossary + summary: 'Update the glossary partially. Some properties such as qualifiedName are + not allowed to be + + updated.' + signature: 'partial_update_glossary(glossary_guid: str, partial_updates: Dict[str, + str], *, include_term_hierarchy: bool | None = False, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: glossary_guid + description: The globally unique identifier for glossary. + isRequired: true + types: + - + - name: partial_updates + description: 'A map containing keys as attribute names and values as corresponding + + attribute values.' + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: include_term_hierarchy + description: Whether include term hierarchy. Default value is False. + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n partial_updates\ + \ = {\n \"str\": \"str\" # Optional.\n }\n\n # response body for status\ + \ code(s): 200\n response.json() == {\n \"categories\": [\n \ + \ {\n \"categoryGuid\": \"str\", # Optional. The GUID of the category.\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ category header.\n \"displayText\": \"str\", \ + \ # Optional. The display text.\n \"parentCategoryGuid\": \"str\"\ + , # Optional. The GUID of the\n parent category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ],\n \"classifications\": [\n \ + \ {\n \"attributes\": {\n \"str\": {} \ + \ # Optional. The attributes of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from Atlas\n\ + \ store. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"removePropagationsOnEntityDelete\": bool,\ + \ # Optional.\n Determines if propagations will be removed on\ + \ entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"language\": \"str\", # Optional. The language of the glossary.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"qualifiedName\": \"str\", # Optional. The qualified name of the glossary\n\ + \ object.\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"terms\": [\n {\n \"\ + description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"expression\": \"str\", # Optional. The expression of\ + \ the term.\n \"relationGuid\": \"str\", # Optional. The GUID of\ + \ the\n relationship.\n \"source\": \"str\", #\ + \ Optional. The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"DRAFT\"\ + , \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"usage\": \"str\" # Optional. The usage of the glossary.\n\ + \ }\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.partial_update_glossary_category + name: partial_update_glossary_category + summary: Update the glossary category partially. + signature: 'partial_update_glossary_category(category_guid: str, partial_updates: + Dict[str, str], **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: category_guid + description: The globally unique identifier of the category. + isRequired: true + types: + - + - name: partial_updates + description: 'A map containing keys as attribute names and values as corresponding + + attribute values for partial update.' + isRequired: true + types: + - [, ] + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n partial_updates\ + \ = {\n \"str\": \"str\" # Optional.\n }\n\n # response body for status\ + \ code(s): 200\n response.json() == {\n \"anchor\": {\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"glossaryGuid\": \"str\"\ + , # Optional. The GUID of the glossary.\n \"relationGuid\": \"str\"\ + \ # Optional. The GUID of the relationship.\n },\n \"childrenCategories\"\ + : [\n {\n \"categoryGuid\": \"str\", # Optional. The\ + \ GUID of the category.\n \"description\": \"str\", # Optional.\ + \ The description of the\n category header.\n \"\ + displayText\": \"str\", # Optional. The display text.\n \"parentCategoryGuid\"\ + : \"str\", # Optional. The GUID of the\n parent category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional.\n Determines if propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"parentCategory\": {\n \"categoryGuid\": \"str\", # Optional.\ + \ The GUID of the category.\n \"description\": \"str\", # Optional.\ + \ The description of the category\n header.\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"parentCategoryGuid\":\ + \ \"str\", # Optional. The GUID of the parent\n category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the relationship.\n\ + \ },\n \"qualifiedName\": \"str\", # Optional. The qualified name\ + \ of the glossary\n object.\n \"shortDescription\": \"str\", #\ + \ Optional. The short version of description.\n \"terms\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description of\ + \ the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.partial_update_glossary_term + name: partial_update_glossary_term + summary: Update the glossary term partially. + signature: 'partial_update_glossary_term(term_guid: str, partial_updates: Dict[str, + str], *, include_term_hierarchy: bool | None = False, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: term_guid + description: The globally unique identifier for glossary term. + isRequired: true + types: + - + - name: partial_updates + description: 'A map containing keys as attribute names and values as corresponding + + attribute values to be updated.' + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: include_term_hierarchy + description: Whether include term hierarchy. Default value is False. + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n partial_updates\ + \ = {\n \"str\": \"str\" # Optional.\n }\n\n # response body for status\ + \ code(s): 200\n response.json() == {\n \"abbreviation\": \"str\", #\ + \ Optional. The abbreviation of the term.\n \"anchor\": {\n \"\ + displayText\": \"str\", # Optional. The display text.\n \"glossaryGuid\"\ + : \"str\", # Optional. The GUID of the glossary.\n \"relationGuid\"\ + : \"str\" # Optional. The GUID of the relationship.\n },\n \"antonyms\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"assignedEntities\": [\n {\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n\ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \ + \ \"relationshipAttributes\": {\n \"attributes\":\ + \ {\n \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"\ + lastModifiedTS\": \"str\", # Optional. ETag for\n concurrency\ + \ control.\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n },\n \"relationshipGuid\": \"str\",\ + \ # Optional. The GUID of the\n relationship.\n \ + \ \"relationshipStatus\": \"str\", # Optional. The enum of\n \ + \ relationship status. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"relationshipType\": \"str\", # Optional. An array of related\n \ + \ object IDs.\n \"typeName\": \"str\", # Optional. The\ + \ name of the type.\n \"uniqueAttributes\": {\n \ + \ \"str\": {} # Optional. The unique attributes of the\n \ + \ object.\n }\n }\n ],\n \"attributes\"\ + : {\n \"str\": {\n \"str\": {} # Optional. The custom\ + \ attributes of the term,\n which is map>.\"\ + nThe key of the first layer map\n is term template name.\n \ + \ }\n },\n \"categories\": [\n {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the category.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ record.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"status\": \"str\" \ + \ # Optional. The status of term relationship.\n Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \ + \ }\n ],\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"entityGuid\": \"str\", \ + \ # Optional. The GUID of the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of the entity -\n can be active or deleted.\ + \ Deleted entities are not removed from Atlas\n store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\", \ + \ # Optional. ETag for concurrency\n control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, # Optional.\n Determines\ + \ if propagations will be removed on entity deletion.\n \"source\"\ + : \"str\", # Optional. indicate the source who create\n the classification\ + \ detail.\n \"sourceDetails\": {\n \"str\": {}\ + \ # Optional. more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"\ + str\", # Optional. The start of\n the time boundary.\n\ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n \ + \ ]\n }\n ],\n \"classifies\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"contacts\": {\n \"str\":\ + \ [\n {\n \"id\": \"str\", # Optional. Azure\ + \ Active Directory\n object Id.\n \"info\"\ + : \"str\" # Optional. additional information to\n describe\ + \ this contact.\n }\n ]\n },\n \"createTime\"\ + : 0.0, # Optional. The created time of the record.\n \"createdBy\": \"\ + str\", # Optional. The user who created the record.\n \"examples\": [\n\ + \ \"str\" # Optional. An array of examples.\n ],\n \"guid\"\ + : \"str\", # Optional. The GUID of the object.\n \"isA\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description of\ + \ the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"longDescription\": \"str\", # Optional.\ + \ The long version description.\n \"name\": \"str\", # Optional. The name\ + \ of the glossary object.\n \"preferredTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"preferredToTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"qualifiedName\": \"str\", # Optional.\ + \ The qualified name of the glossary\n object.\n \"replacedBy\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"replacementTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"resources\": [\n {\n \ + \ \"displayName\": \"str\", # Optional. Display name for url.\n \ + \ \"url\": \"str\" # Optional. web url. http or https.\n \ + \ }\n ],\n \"seeAlso\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"status\": \"str\", # Optional. Status of\ + \ the AtlasGlossaryTerm. Known values\n are: \"Draft\", \"Approved\",\ + \ \"Alert\", \"Expired\".\n \"synonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"templateName\": [\n {} # Optional.\n\ + \ ],\n \"translatedTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"translationTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"updateTime\": 0.0, # Optional. The\ + \ update time of the record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the record.\n \"usage\": \"str\", # Optional. The usage\ + \ of the term.\n \"validValues\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"validValuesFor\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.remove_term_assignment_from_entities + name: remove_term_assignment_from_entities + summary: Delete the term assignment for the given list of related objects. + signature: 'remove_term_assignment_from_entities(term_guid: str, related_object_ids: + List[MutableMapping[str, Any]], **kwargs: Any) -> None' + parameters: + - name: term_guid + description: The globally unique identifier for glossary term. + isRequired: true + types: + - + - name: related_object_ids + description: 'An array of related object IDs from which the term has to be + + dissociated.' + isRequired: true + types: + - [] + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n related_object_ids\ + \ = [\n {\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"entityStatus\": \"str\", # Optional. Status of the entity\ + \ - can be\n active or deleted. Deleted entities are not removed from\ + \ Atlas store. Known\n values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \"\ + relationshipAttributes\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"typeName\": \"str\" # Optional.\ + \ The name of the type.\n },\n \"relationshipGuid\": \"str\"\ + , # Optional. The GUID of the relationship.\n \"relationshipStatus\"\ + : \"str\", # Optional. The enum of relationship\n status. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"relationshipType\": \"str\", #\ + \ Optional.\n \"typeName\": \"str\", # Optional. The name of the type.\n\ + \ \"uniqueAttributes\": {\n \"str\": {} # Optional. The\ + \ unique attributes of the object.\n }\n }\n ]\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.update_glossary + name: update_glossary + summary: Update the given glossary. + signature: 'update_glossary(glossary_guid: str, updated_glossary: MutableMapping[str, + Any], **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: glossary_guid + description: The globally unique identifier for glossary. + isRequired: true + types: + - + - name: updated_glossary + description: The glossary definition to be updated. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n updated_glossary\ + \ = {\n \"categories\": [\n {\n \"categoryGuid\"\ + : \"str\", # Optional. The GUID of the category.\n \"description\"\ + : \"str\", # Optional. The description of the\n category header.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"parentCategoryGuid\": \"str\", # Optional. The GUID of the\n \ + \ parent category.\n \"relationGuid\": \"str\" #\ + \ Optional. The GUID of the\n relationship.\n }\n \ + \ ],\n \"classifications\": [\n {\n \"attributes\"\ + : {\n \"str\": {} # Optional. The attributes of the struct.\n\ + \ },\n \"entityGuid\": \"str\", # Optional. The GUID\ + \ of the entity.\n \"entityStatus\": \"str\", # Optional. Status\ + \ of the entity -\n can be active or deleted. Deleted entities\ + \ are not removed from Atlas\n store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional. ETag\ + \ for concurrency\n control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional.\n Determines if propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"language\": \"str\", # Optional. The language of the glossary.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"qualifiedName\": \"str\", # Optional. The qualified name of the glossary\n\ + \ object.\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"terms\": [\n {\n \"\ + description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"expression\": \"str\", # Optional. The expression of\ + \ the term.\n \"relationGuid\": \"str\", # Optional. The GUID of\ + \ the\n relationship.\n \"source\": \"str\", #\ + \ Optional. The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"DRAFT\"\ + , \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"usage\": \"str\" # Optional. The usage of the glossary.\n\ + \ }\n\n # response body for status code(s): 200\n response.json() == {\n\ + \ \"categories\": [\n {\n \"categoryGuid\": \"str\"\ + , # Optional. The GUID of the category.\n \"description\": \"str\"\ + , # Optional. The description of the\n category header.\n \ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"parentCategoryGuid\": \"str\", # Optional. The GUID of the\n \ + \ parent category.\n \"relationGuid\": \"str\" # Optional.\ + \ The GUID of the\n relationship.\n }\n ],\n \ + \ \"classifications\": [\n {\n \"attributes\": {\n\ + \ \"str\": {} # Optional. The attributes of the struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional. The GUID\ + \ of the entity.\n \"entityStatus\": \"str\", # Optional. Status\ + \ of the entity -\n can be active or deleted. Deleted entities\ + \ are not removed from Atlas\n store. Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"lastModifiedTS\": \"str\", # Optional. ETag\ + \ for concurrency\n control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional.\n Determines if propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"language\": \"str\", # Optional. The language of the glossary.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"qualifiedName\": \"str\", # Optional. The qualified name of the glossary\n\ + \ object.\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"terms\": [\n {\n \"\ + description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The display\ + \ text.\n \"expression\": \"str\", # Optional. The expression of\ + \ the term.\n \"relationGuid\": \"str\", # Optional. The GUID of\ + \ the\n relationship.\n \"source\": \"str\", #\ + \ Optional. The source of the term.\n \"status\": \"str\", # Optional.\ + \ The status of term\n relationship. Known values are: \"DRAFT\"\ + , \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"usage\": \"str\" # Optional. The usage of the glossary.\n\ + \ }\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.update_glossary_category + name: update_glossary_category + summary: Update the given glossary category by its GUID. + signature: 'update_glossary_category(category_guid: str, glossary_category: MutableMapping[str, + Any], **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: category_guid + description: The globally unique identifier of the category. + isRequired: true + types: + - + - name: glossary_category + description: The glossary category to be updated. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n glossary_category\ + \ = {\n \"anchor\": {\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"glossaryGuid\": \"str\", # Optional. The GUID\ + \ of the glossary.\n \"relationGuid\": \"str\" # Optional. The GUID\ + \ of the relationship.\n },\n \"childrenCategories\": [\n \ + \ {\n \"categoryGuid\": \"str\", # Optional. The GUID of the\ + \ category.\n \"description\": \"str\", # Optional. The description\ + \ of the\n category header.\n \"displayText\": \"\ + str\", # Optional. The display text.\n \"parentCategoryGuid\":\ + \ \"str\", # Optional. The GUID of the\n parent category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional.\n Determines if propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"parentCategory\": {\n \"categoryGuid\": \"str\", # Optional.\ + \ The GUID of the category.\n \"description\": \"str\", # Optional.\ + \ The description of the category\n header.\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"parentCategoryGuid\":\ + \ \"str\", # Optional. The GUID of the parent\n category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the relationship.\n\ + \ },\n \"qualifiedName\": \"str\", # Optional. The qualified name\ + \ of the glossary\n object.\n \"shortDescription\": \"str\", #\ + \ Optional. The short version of description.\n \"terms\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description of\ + \ the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ]\n }\n\n # response body for status code(s):\ + \ 200\n response.json() == {\n \"anchor\": {\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"glossaryGuid\": \"str\"\ + , # Optional. The GUID of the glossary.\n \"relationGuid\": \"str\"\ + \ # Optional. The GUID of the relationship.\n },\n \"childrenCategories\"\ + : [\n {\n \"categoryGuid\": \"str\", # Optional. The\ + \ GUID of the category.\n \"description\": \"str\", # Optional.\ + \ The description of the\n category header.\n \"\ + displayText\": \"str\", # Optional. The display text.\n \"parentCategoryGuid\"\ + : \"str\", # Optional. The GUID of the\n parent category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the\n \ + \ relationship.\n }\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \"str\"\ + : {} # Optional. The attributes of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of the entity.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n \ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"removePropagationsOnEntityDelete\"\ + : bool, # Optional.\n Determines if propagations will be removed\ + \ on entity deletion.\n \"source\": \"str\", # Optional. indicate\ + \ the source who create\n the classification detail.\n \ + \ \"sourceDetails\": {\n \"str\": {} # Optional. more\ + \ detail on source\n information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"str\", # Optional.\ + \ The start of\n the time boundary.\n \ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n ]\n \ + \ }\n ],\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"longDescription\": \"str\", # Optional. The long version description.\n\ + \ \"name\": \"str\", # Optional. The name of the glossary object.\n \ + \ \"parentCategory\": {\n \"categoryGuid\": \"str\", # Optional.\ + \ The GUID of the category.\n \"description\": \"str\", # Optional.\ + \ The description of the category\n header.\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"parentCategoryGuid\":\ + \ \"str\", # Optional. The GUID of the parent\n category.\n \ + \ \"relationGuid\": \"str\" # Optional. The GUID of the relationship.\n\ + \ },\n \"qualifiedName\": \"str\", # Optional. The qualified name\ + \ of the glossary\n object.\n \"shortDescription\": \"str\", #\ + \ Optional. The short version of description.\n \"terms\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description of\ + \ the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.GlossaryOperations.update_glossary_term + name: update_glossary_term + summary: Update the given glossary term by its GUID. + signature: 'update_glossary_term(term_guid: str, glossary_term: MutableMapping[str, + Any], *, include_term_hierarchy: bool | None = False, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: term_guid + description: The globally unique identifier for glossary term. + isRequired: true + types: + - + - name: glossary_term + description: The glossary term to be updated. + isRequired: true + types: + - + keywordOnlyParameters: + - name: include_term_hierarchy + description: Whether include term hierarchy. Default value is False. + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n glossary_term\ + \ = {\n \"abbreviation\": \"str\", # Optional. The abbreviation of the\ + \ term.\n \"anchor\": {\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"glossaryGuid\": \"str\", # Optional. The GUID\ + \ of the glossary.\n \"relationGuid\": \"str\" # Optional. The GUID\ + \ of the relationship.\n },\n \"antonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"assignedEntities\": [\n {\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n\ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \ + \ \"relationshipAttributes\": {\n \"attributes\":\ + \ {\n \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"\ + lastModifiedTS\": \"str\", # Optional. ETag for\n concurrency\ + \ control.\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n },\n \"relationshipGuid\": \"str\",\ + \ # Optional. The GUID of the\n relationship.\n \ + \ \"relationshipStatus\": \"str\", # Optional. The enum of\n \ + \ relationship status. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"relationshipType\": \"str\", # Optional. An array of related\n \ + \ object IDs.\n \"typeName\": \"str\", # Optional. The\ + \ name of the type.\n \"uniqueAttributes\": {\n \ + \ \"str\": {} # Optional. The unique attributes of the\n \ + \ object.\n }\n }\n ],\n \"attributes\"\ + : {\n \"str\": {\n \"str\": {} # Optional. The custom\ + \ attributes of the term,\n which is map>.\"\ + nThe key of the first layer map\n is term template name.\n \ + \ }\n },\n \"categories\": [\n {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the category.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ record.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"status\": \"str\" \ + \ # Optional. The status of term relationship.\n Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \ + \ }\n ],\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"entityGuid\": \"str\", \ + \ # Optional. The GUID of the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of the entity -\n can be active or deleted.\ + \ Deleted entities are not removed from Atlas\n store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\", \ + \ # Optional. ETag for concurrency\n control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, # Optional.\n Determines\ + \ if propagations will be removed on entity deletion.\n \"source\"\ + : \"str\", # Optional. indicate the source who create\n the classification\ + \ detail.\n \"sourceDetails\": {\n \"str\": {}\ + \ # Optional. more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"\ + str\", # Optional. The start of\n the time boundary.\n\ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n \ + \ ]\n }\n ],\n \"classifies\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"contacts\": {\n \"str\":\ + \ [\n {\n \"id\": \"str\", # Optional. Azure\ + \ Active Directory\n object Id.\n \"info\"\ + : \"str\" # Optional. additional information to\n describe\ + \ this contact.\n }\n ]\n },\n \"createTime\"\ + : 0.0, # Optional. The created time of the record.\n \"createdBy\": \"\ + str\", # Optional. The user who created the record.\n \"examples\": [\n\ + \ \"str\" # Optional. An array of examples.\n ],\n \"guid\"\ + : \"str\", # Optional. The GUID of the object.\n \"isA\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description of\ + \ the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"longDescription\": \"str\", # Optional.\ + \ The long version description.\n \"name\": \"str\", # Optional. The name\ + \ of the glossary object.\n \"preferredTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"preferredToTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"qualifiedName\": \"str\", # Optional.\ + \ The qualified name of the glossary\n object.\n \"replacedBy\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"replacementTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"resources\": [\n {\n \ + \ \"displayName\": \"str\", # Optional. Display name for url.\n \ + \ \"url\": \"str\" # Optional. web url. http or https.\n \ + \ }\n ],\n \"seeAlso\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"status\": \"str\", # Optional. Status of\ + \ the AtlasGlossaryTerm. Known values\n are: \"Draft\", \"Approved\",\ + \ \"Alert\", \"Expired\".\n \"synonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"templateName\": [\n {} # Optional.\n\ + \ ],\n \"translatedTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"translationTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"updateTime\": 0.0, # Optional. The\ + \ update time of the record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the record.\n \"usage\": \"str\", # Optional. The usage\ + \ of the term.\n \"validValues\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"validValuesFor\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ]\n }\n\n # response body for status code(s): 200\n response.json()\ + \ == {\n \"abbreviation\": \"str\", # Optional. The abbreviation of the\ + \ term.\n \"anchor\": {\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"glossaryGuid\": \"str\", # Optional. The GUID\ + \ of the glossary.\n \"relationGuid\": \"str\" # Optional. The GUID\ + \ of the relationship.\n },\n \"antonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"assignedEntities\": [\n {\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"entityStatus\": \"str\", # Optional. Status of the entity -\n\ + \ can be active or deleted. Deleted entities are not removed from\ + \ Atlas\n store. Known values are: \"ACTIVE\", \"DELETED\".\n\ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \ + \ \"relationshipAttributes\": {\n \"attributes\":\ + \ {\n \"str\": {} # Optional. The attributes of the\n \ + \ struct.\n },\n \"\ + lastModifiedTS\": \"str\", # Optional. ETag for\n concurrency\ + \ control.\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n },\n \"relationshipGuid\": \"str\",\ + \ # Optional. The GUID of the\n relationship.\n \ + \ \"relationshipStatus\": \"str\", # Optional. The enum of\n \ + \ relationship status. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"relationshipType\": \"str\", # Optional. An array of related\n \ + \ object IDs.\n \"typeName\": \"str\", # Optional. The\ + \ name of the type.\n \"uniqueAttributes\": {\n \ + \ \"str\": {} # Optional. The unique attributes of the\n \ + \ object.\n }\n }\n ],\n \"attributes\"\ + : {\n \"str\": {\n \"str\": {} # Optional. The custom\ + \ attributes of the term,\n which is map>.\"\ + nThe key of the first layer map\n is term template name.\n \ + \ }\n },\n \"categories\": [\n {\n \ + \ \"categoryGuid\": \"str\", # Optional. The GUID of the category.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ record.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"status\": \"str\" \ + \ # Optional. The status of term relationship.\n Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\", \"OBSOLETE\", \"OTHER\".\n \ + \ }\n ],\n \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"entityGuid\": \"str\", \ + \ # Optional. The GUID of the entity.\n \"entityStatus\": \"str\"\ + , # Optional. Status of the entity -\n can be active or deleted.\ + \ Deleted entities are not removed from Atlas\n store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"str\", \ + \ # Optional. ETag for concurrency\n control.\n \ + \ \"removePropagationsOnEntityDelete\": bool, # Optional.\n Determines\ + \ if propagations will be removed on entity deletion.\n \"source\"\ + : \"str\", # Optional. indicate the source who create\n the classification\ + \ detail.\n \"sourceDetails\": {\n \"str\": {}\ + \ # Optional. more detail on source\n information.\n \ + \ },\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", # Optional. The end of the\n \ + \ time boundary.\n \"startTime\": \"\ + str\", # Optional. The start of\n the time boundary.\n\ + \ \"timeZone\": \"str\" # Optional. The timezone\n \ + \ of the time boundary.\n }\n \ + \ ]\n }\n ],\n \"classifies\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"contacts\": {\n \"str\":\ + \ [\n {\n \"id\": \"str\", # Optional. Azure\ + \ Active Directory\n object Id.\n \"info\"\ + : \"str\" # Optional. additional information to\n describe\ + \ this contact.\n }\n ]\n },\n \"createTime\"\ + : 0.0, # Optional. The created time of the record.\n \"createdBy\": \"\ + str\", # Optional. The user who created the record.\n \"examples\": [\n\ + \ \"str\" # Optional. An array of examples.\n ],\n \"guid\"\ + : \"str\", # Optional. The GUID of the object.\n \"isA\": [\n \ + \ {\n \"description\": \"str\", # Optional. The description of\ + \ the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"lastModifiedTS\": \"str\", # Optional.\ + \ ETag for concurrency control.\n \"longDescription\": \"str\", # Optional.\ + \ The long version description.\n \"name\": \"str\", # Optional. The name\ + \ of the glossary object.\n \"preferredTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"preferredToTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"qualifiedName\": \"str\", # Optional.\ + \ The qualified name of the glossary\n object.\n \"replacedBy\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n related term.\n \"displayText\": \"str\"\ + , # Optional. The display text.\n \"expression\": \"str\", # Optional.\ + \ The expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"replacementTerms\": [\n {\n\ + \ \"description\": \"str\", # Optional. The description of the\n\ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"resources\": [\n {\n \ + \ \"displayName\": \"str\", # Optional. Display name for url.\n \ + \ \"url\": \"str\" # Optional. web url. http or https.\n \ + \ }\n ],\n \"seeAlso\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"shortDescription\": \"str\", # Optional. The short\ + \ version of description.\n \"status\": \"str\", # Optional. Status of\ + \ the AtlasGlossaryTerm. Known values\n are: \"Draft\", \"Approved\",\ + \ \"Alert\", \"Expired\".\n \"synonyms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"templateName\": [\n {} # Optional.\n\ + \ ],\n \"translatedTerms\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"translationTerms\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional.\ + \ The display text.\n \"expression\": \"str\", # Optional. The\ + \ expression of the term.\n \"relationGuid\": \"str\", # Optional.\ + \ The GUID of the\n relationship.\n \"source\":\ + \ \"str\", # Optional. The source of the term.\n \"status\": \"\ + str\", # Optional. The status of term\n relationship. Known values\ + \ are: \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\",\ + \ \"OTHER\".\n \"steward\": \"str\", # Optional. The steward of\ + \ the term.\n \"termGuid\": \"str\" # Optional. The GUID of the\ + \ term.\n }\n ],\n \"updateTime\": 0.0, # Optional. The\ + \ update time of the record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the record.\n \"usage\": \"str\", # Optional. The usage\ + \ of the term.\n \"validValues\": [\n {\n \"description\"\ + : \"str\", # Optional. The description of the\n related term.\n\ + \ \"displayText\": \"str\", # Optional. The display text.\n \ + \ \"expression\": \"str\", # Optional. The expression of the term.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID of the\n \ + \ relationship.\n \"source\": \"str\", # Optional.\ + \ The source of the term.\n \"status\": \"str\", # Optional. The\ + \ status of term\n relationship. Known values are: \"DRAFT\",\ + \ \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\".\n \ + \ \"steward\": \"str\", # Optional. The steward of the term.\n \ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ],\n \"validValuesFor\": [\n {\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ related term.\n \"displayText\": \"str\", # Optional. The\ + \ display text.\n \"expression\": \"str\", # Optional. The expression\ + \ of the term.\n \"relationGuid\": \"str\", # Optional. The GUID\ + \ of the\n relationship.\n \"source\": \"str\",\ + \ # Optional. The source of the term.\n \"status\": \"str\", #\ + \ Optional. The status of term\n relationship. Known values are:\ + \ \"DRAFT\", \"ACTIVE\", \"DEPRECATED\",\n \"OBSOLETE\", \"OTHER\"\ + .\n \"steward\": \"str\", # Optional. The steward of the term.\n\ + \ \"termGuid\": \"str\" # Optional. The GUID of the term.\n \ + \ }\n ]\n }\n ````\n" diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.LineageOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.LineageOperations.yml new file mode 100644 index 00000000..dae00240 --- /dev/null +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.LineageOperations.yml @@ -0,0 +1,400 @@ +### YamlMime:PythonClass +uid: azure.purview.catalog.operations.LineageOperations +name: LineageOperations +fullName: azure.purview.catalog.operations.LineageOperations +module: azure.purview.catalog.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: LineageOperations(*args, **kwargs) +methods: +- uid: azure.purview.catalog.operations.LineageOperations.get_lineage_by_unique_attribute + name: get_lineage_by_unique_attribute + summary: 'Returns lineage info about entity. + + + In addition to the typeName path parameter, attribute key-value pair(s) can be + provided in the + + following format + + + attr:[attrName]=[attrValue] + + + NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName.' + signature: 'get_lineage_by_unique_attribute(type_name: str, *, direction: str, depth: + int | None = 3, width: int | None = 10, include_parent: bool | None = None, get_derived_lineage: + bool | None = None, **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: type_name + description: The name of the type. + isRequired: true + types: + - + keywordOnlyParameters: + - name: direction + description: 'The direction of the lineage, which could be INPUT, OUTPUT or BOTH. + Known + + values are: "BOTH", "INPUT", and "OUTPUT".' + types: + - + - name: depth + description: The number of hops for lineage. Default value is 3. + types: + - + - name: width + description: The number of max expanding width in lineage. Default value is 10. + types: + - + - name: include_parent + description: 'True to include the parent chain in the response. Default value + is + + None.' + types: + - + - name: get_derived_lineage + description: 'True to include derived lineage in the response. Default value is + + None.' + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + baseEntityGuid\": \"str\", # Optional. The GUID of the base entity.\n \"\ + childrenCount\": 0, # Optional. The number of children node.\n \"guidEntityMap\"\ + : {\n \"str\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"classificationNames\": [\n \"str\" # Optional.\ + \ An array of classification names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n },\n \"includeParent\": bool, # Optional.\ + \ True to return the parent of the base\n entity.\n \"lineageDepth\"\ + : 0, # Optional. The depth of lineage.\n \"lineageDirection\": \"str\"\ + , # Optional. The enum of lineage direction. Known\n values are: \"INPUT\"\ + , \"OUTPUT\", \"BOTH\".\n \"lineageWidth\": 0, # Optional. The width of\ + \ lineage.\n \"parentRelations\": [\n {\n \"childEntityId\"\ + : \"str\", # Optional. The GUID of child\n entity.\n \ + \ \"parentEntityId\": \"str\", # Optional. The GUID of parent\n \ + \ entity.\n \"relationshipId\": \"str\" # Optional. The\ + \ GUID of\n relationship.\n }\n ],\n \"\ + relations\": [\n {\n \"fromEntityId\": \"str\", # Optional.\ + \ The GUID of from-entity.\n \"relationshipId\": \"str\", # Optional.\ + \ The GUID of\n relationship.\n \"toEntityId\":\ + \ \"str\" # Optional. The GUID of to-entity.\n }\n ],\n \ + \ \"widthCounts\": {\n \"str\": {\n \"str\": {} # Optional.\ + \ The entity count in specific\n direction.\n }\n \ + \ }\n }\n ````\n" +- uid: azure.purview.catalog.operations.LineageOperations.get_lineage_graph + name: get_lineage_graph + summary: Get lineage info of the entity specified by GUID. + signature: 'get_lineage_graph(guid: str, *, direction: str, depth: int | None = + 3, width: int | None = 10, include_parent: bool | None = None, get_derived_lineage: + bool | None = None, **kwargs: Any) -> MutableMapping[str, Any]' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + keywordOnlyParameters: + - name: direction + description: 'The direction of the lineage, which could be INPUT, OUTPUT or BOTH. + Known + + values are: "BOTH", "INPUT", and "OUTPUT".' + types: + - + - name: depth + description: The number of hops for lineage. Default value is 3. + types: + - + - name: width + description: The number of max expanding width in lineage. Default value is 10. + types: + - + - name: include_parent + description: 'True to include the parent chain in the response. Default value + is + + None.' + types: + - + - name: get_derived_lineage + description: 'True to include derived lineage in the response. Default value is + + None.' + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + baseEntityGuid\": \"str\", # Optional. The GUID of the base entity.\n \"\ + childrenCount\": 0, # Optional. The number of children node.\n \"guidEntityMap\"\ + : {\n \"str\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"classificationNames\": [\n \"str\" # Optional.\ + \ An array of classification names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n },\n \"includeParent\": bool, # Optional.\ + \ True to return the parent of the base\n entity.\n \"lineageDepth\"\ + : 0, # Optional. The depth of lineage.\n \"lineageDirection\": \"str\"\ + , # Optional. The enum of lineage direction. Known\n values are: \"INPUT\"\ + , \"OUTPUT\", \"BOTH\".\n \"lineageWidth\": 0, # Optional. The width of\ + \ lineage.\n \"parentRelations\": [\n {\n \"childEntityId\"\ + : \"str\", # Optional. The GUID of child\n entity.\n \ + \ \"parentEntityId\": \"str\", # Optional. The GUID of parent\n \ + \ entity.\n \"relationshipId\": \"str\" # Optional. The\ + \ GUID of\n relationship.\n }\n ],\n \"\ + relations\": [\n {\n \"fromEntityId\": \"str\", # Optional.\ + \ The GUID of from-entity.\n \"relationshipId\": \"str\", # Optional.\ + \ The GUID of\n relationship.\n \"toEntityId\":\ + \ \"str\" # Optional. The GUID of to-entity.\n }\n ],\n \ + \ \"widthCounts\": {\n \"str\": {\n \"str\": {} # Optional.\ + \ The entity count in specific\n direction.\n }\n \ + \ }\n }\n ````\n" +- uid: azure.purview.catalog.operations.LineageOperations.next_page_lineage + name: next_page_lineage + summary: Return immediate next page lineage info about entity with pagination. + signature: 'next_page_lineage(guid: str, *, direction: str, get_derived_lineage: + bool | None = None, offset: int | None = None, limit: int | None = None, **kwargs: + Any) -> MutableMapping[str, Any]' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + keywordOnlyParameters: + - name: direction + description: 'The direction of the lineage, which could be INPUT, OUTPUT or BOTH. + Known + + values are: "BOTH", "INPUT", and "OUTPUT".' + types: + - + - name: get_derived_lineage + description: 'True to include derived lineage in the response. Default value is + + None.' + types: + - + - name: offset + description: The offset for pagination purpose. Default value is None. + types: + - + - name: limit + description: The page size - by default there is no paging. Default value is None. + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + baseEntityGuid\": \"str\", # Optional. The GUID of the base entity.\n \"\ + childrenCount\": 0, # Optional. The number of children node.\n \"guidEntityMap\"\ + : {\n \"str\": {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes of the struct.\n },\n\ + \ \"classificationNames\": [\n \"str\" # Optional.\ + \ An array of classification names.\n ],\n \"classifications\"\ + : [\n {\n \"attributes\": {\n \ + \ \"str\": {} # Optional. The attributes\n \ + \ of the struct.\n },\n \ + \ \"entityGuid\": \"str\", # Optional. The GUID of\n \ + \ the entity.\n \"entityStatus\": \"str\", # Optional.\ + \ Status of\n the entity - can be active or deleted. Deleted\ + \ entities are not\n removed from Atlas store. Known values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag\n for concurrency control.\n\ + \ \"removePropagationsOnEntityDelete\": bool, #\n \ + \ Optional. Determines if propagations will be removed on entity\n\ + \ deletion.\n \"source\": \"str\"\ + , # Optional. indicate the\n source who create the classification\ + \ detail.\n \"sourceDetails\": {\n \ + \ \"str\": {} # Optional. more detail on\n source\ + \ information.\n },\n \"typeName\"\ + : \"str\", # Optional. The name of\n the type.\n \ + \ \"validityPeriods\": [\n {\n \ + \ \"endTime\": \"str\", #\n \ + \ Optional. The end of the time boundary.\n \ + \ \"startTime\": \"str\", #\n Optional.\ + \ The start of the time boundary.\n \"timeZone\"\ + : \"str\" #\n Optional. The timezone of the time\ + \ boundary.\n }\n ]\n \ + \ }\n ],\n \"displayText\": \"str\", #\ + \ Optional. The display text.\n \"guid\": \"str\", # Optional.\ + \ The GUID of the record.\n \"isIncomplete\": bool, # Optional.\ + \ Whether it is a shell\n entity.\n \"labels\":\ + \ [\n \"str\" # Optional. labels.\n ],\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n },\n \"includeParent\": bool, # Optional.\ + \ True to return the parent of the base\n entity.\n \"lineageDepth\"\ + : 0, # Optional. The depth of lineage.\n \"lineageDirection\": \"str\"\ + , # Optional. The enum of lineage direction. Known\n values are: \"INPUT\"\ + , \"OUTPUT\", \"BOTH\".\n \"lineageWidth\": 0, # Optional. The width of\ + \ lineage.\n \"parentRelations\": [\n {\n \"childEntityId\"\ + : \"str\", # Optional. The GUID of child\n entity.\n \ + \ \"parentEntityId\": \"str\", # Optional. The GUID of parent\n \ + \ entity.\n \"relationshipId\": \"str\" # Optional. The\ + \ GUID of\n relationship.\n }\n ],\n \"\ + relations\": [\n {\n \"fromEntityId\": \"str\", # Optional.\ + \ The GUID of from-entity.\n \"relationshipId\": \"str\", # Optional.\ + \ The GUID of\n relationship.\n \"toEntityId\":\ + \ \"str\" # Optional. The GUID of to-entity.\n }\n ],\n \ + \ \"widthCounts\": {\n \"str\": {\n \"str\": {} # Optional.\ + \ The entity count in specific\n direction.\n }\n \ + \ }\n }\n ````\n" diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.RelationshipOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.RelationshipOperations.yml new file mode 100644 index 00000000..28ff6c25 --- /dev/null +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.RelationshipOperations.yml @@ -0,0 +1,274 @@ +### YamlMime:PythonClass +uid: azure.purview.catalog.operations.RelationshipOperations +name: RelationshipOperations +fullName: azure.purview.catalog.operations.RelationshipOperations +module: azure.purview.catalog.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: RelationshipOperations(*args, **kwargs) +methods: +- uid: azure.purview.catalog.operations.RelationshipOperations.create + name: create + summary: Create a new relationship between entities. + signature: 'create(relationship: MutableMapping[str, Any], **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: relationship + description: 'The AtlasRelationship object containing the information for the + + relationship to be created.' + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n relationship\ + \ = {\n \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"createTime\": 0.0, # Optional. The created\ + \ time of the record.\n \"createdBy\": \"str\", # Optional. The user who\ + \ created the record.\n \"end1\": {\n \"guid\": \"str\", # Optional.\ + \ The GUID of the object.\n \"typeName\": \"str\", # Optional. The\ + \ name of the type.\n \"uniqueAttributes\": {\n \"str\"\ + : {} # Optional. The unique attributes of the object.\n }\n },\n\ + \ \"end2\": {\n \"guid\": \"str\", # Optional. The GUID of the\ + \ object.\n \"typeName\": \"str\", # Optional. The name of the type.\n\ + \ \"uniqueAttributes\": {\n \"str\": {} # Optional. The\ + \ unique attributes of the object.\n }\n },\n \"guid\":\ + \ \"str\", # Optional. The GUID of the relationship.\n \"homeId\": \"str\"\ + , # Optional. The home ID of the relationship.\n \"label\": \"str\", #\ + \ Optional. The label of the relationship.\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag for concurrency control.\n \"provenanceType\": 0.0,\ + \ # Optional. Used to record the provenance of an\n instance of an entity\ + \ or relationship.\n \"status\": \"str\", # Optional. The enum of relationship\ + \ status. Known values\n are: \"ACTIVE\", \"DELETED\".\n \"typeName\"\ + : \"str\", # Optional. The name of the type.\n \"updateTime\": 0.0, #\ + \ Optional. The update time of the record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the record.\n \"version\": 0.0 # Optional.\ + \ The version of the relationship.\n }\n\n # response body for status code(s):\ + \ 200\n response.json() == {\n \"attributes\": {\n \"str\":\ + \ {} # Optional. The attributes of the struct.\n },\n \"createTime\"\ + : 0.0, # Optional. The created time of the record.\n \"createdBy\": \"\ + str\", # Optional. The user who created the record.\n \"end1\": {\n \ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \"\ + typeName\": \"str\", # Optional. The name of the type.\n \"uniqueAttributes\"\ + : {\n \"str\": {} # Optional. The unique attributes of the object.\n\ + \ }\n },\n \"end2\": {\n \"guid\": \"str\", #\ + \ Optional. The GUID of the object.\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"uniqueAttributes\": {\n \"\ + str\": {} # Optional. The unique attributes of the object.\n }\n \ + \ },\n \"guid\": \"str\", # Optional. The GUID of the relationship.\n\ + \ \"homeId\": \"str\", # Optional. The home ID of the relationship.\n \ + \ \"label\": \"str\", # Optional. The label of the relationship.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n \ + \ \"provenanceType\": 0.0, # Optional. Used to record the provenance of\ + \ an\n instance of an entity or relationship.\n \"status\": \"str\"\ + , # Optional. The enum of relationship status. Known values\n are: \"\ + ACTIVE\", \"DELETED\".\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"updateTime\": 0.0, # Optional. The update time of the record.\n\ + \ \"updatedBy\": \"str\", # Optional. The user who updated the record.\n\ + \ \"version\": 0.0 # Optional. The version of the relationship.\n }\n\ + \ ````\n" +- uid: azure.purview.catalog.operations.RelationshipOperations.delete + name: delete + summary: Delete a relationship between entities by its GUID. + signature: 'delete(guid: str, **kwargs: Any) -> None' + parameters: + - name: guid + description: The globally unique identifier of the relationship. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.purview.catalog.operations.RelationshipOperations.get + name: get + summary: Get relationship information between entities by its GUID. + signature: 'get(guid: str, *, extended_info: bool | None = None, **kwargs: Any) + -> MutableMapping[str, Any]' + parameters: + - name: guid + description: The globally unique identifier of the relationship. + isRequired: true + types: + - + keywordOnlyParameters: + - name: extended_info + description: Limits whether includes extended information. Default value is None. + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + referredEntities\": {\n \"str\": {\n \"attributes\": {\n\ + \ \"str\": {} # Optional. The attributes of the struct.\n \ + \ },\n \"classificationNames\": [\n \ + \ \"str\" # Optional. An array of classification names.\n ],\n\ + \ \"classifications\": [\n {\n \ + \ \"attributes\": {\n \"str\": {} # Optional.\ + \ The attributes\n of the struct.\n \ + \ },\n \"entityGuid\": \"str\", # Optional. The\ + \ GUID of\n the entity.\n \"entityStatus\"\ + : \"str\", # Optional. Status of\n the entity - can be\ + \ active or deleted. Deleted entities are not\n removed\ + \ from Atlas store. Known values are: \"ACTIVE\", \"DELETED\".\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag\n \ + \ for concurrency control.\n \"removePropagationsOnEntityDelete\"\ + : bool, #\n Optional. Determines if propagations will\ + \ be removed on entity\n deletion.\n \ + \ \"source\": \"str\", # Optional. indicate the\n \ + \ source who create the classification detail.\n \"sourceDetails\"\ + : {\n \"str\": {} # Optional. more detail on\n \ + \ source information.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"validityPeriods\": [\n\ + \ {\n \"endTime\": \"\ + str\", #\n Optional. The end of the time boundary.\n\ + \ \"startTime\": \"str\", #\n \ + \ Optional. The start of the time boundary.\n \ + \ \"timeZone\": \"str\" #\n Optional.\ + \ The timezone of the time boundary.\n }\n \ + \ ]\n }\n ],\n \"displayText\"\ + : \"str\", # Optional. The display text.\n \"guid\": \"str\", \ + \ # Optional. The GUID of the record.\n \"isIncomplete\": bool,\ + \ # Optional. Whether it is a shell\n entity.\n \ + \ \"labels\": [\n \"str\" # Optional. labels.\n \ + \ ],\n \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"meaningNames\": [\n \ + \ \"str\" # Optional. An array of meanings.\n ],\n \ + \ \"meanings\": [\n {\n \"confidence\"\ + : 0, # Optional. The confidence\n of the term assignment.\n\ + \ \"createdBy\": \"str\", # Optional. The user who\n \ + \ created the record.\n \"description\"\ + : \"str\", # Optional. The\n description of the term\ + \ assignment.\n \"displayText\": \"str\", # Optional. The\n\ + \ display text.\n \"expression\"\ + : \"str\", # Optional. The\n expression of the term assignment.\n\ + \ \"relationGuid\": \"str\", # Optional. The GUID\n \ + \ of the relationship.\n \"source\"\ + : \"str\", # Optional. The source of\n the term.\n \ + \ \"status\": \"str\", # Optional. The status of\n \ + \ terms assignment. Known values are: \"DISCOVERED\", \"PROPOSED\"\ + ,\n \"IMPORTED\", \"VALIDATED\", \"DEPRECATED\", \"OBSOLETE\"\ + , \"OTHER\".\n \"steward\": \"str\", # Optional. The steward\ + \ of\n the term.\n \"termGuid\"\ + : \"str\" # Optional. The GUID of\n the term.\n \ + \ }\n ],\n \"status\": \"str\", # Optional.\ + \ Status of the entity - can be\n active or deleted. Deleted entities\ + \ are not removed from Atlas store.\n Known values are: \"ACTIVE\"\ + , \"DELETED\".\n \"typeName\": \"str\" # Optional. The name of\ + \ the type.\n }\n },\n \"relationship\": {\n \"\ + attributes\": {\n \"str\": {} # Optional. The attributes of the\ + \ struct.\n },\n \"createTime\": 0.0, # Optional. The created\ + \ time of the record.\n \"createdBy\": \"str\", # Optional. The user\ + \ who created the record.\n \"end1\": {\n \"guid\": \"\ + str\", # Optional. The GUID of the object.\n \"typeName\": \"str\"\ + , # Optional. The name of the type.\n \"uniqueAttributes\": {\n\ + \ \"str\": {} # Optional. The unique attributes of the\n \ + \ object.\n }\n },\n \"end2\"\ + : {\n \"guid\": \"str\", # Optional. The GUID of the object.\n\ + \ \"typeName\": \"str\", # Optional. The name of the type.\n \ + \ \"uniqueAttributes\": {\n \"str\": {} # Optional.\ + \ The unique attributes of the\n object.\n }\n\ + \ },\n \"guid\": \"str\", # Optional. The GUID of the relationship.\n\ + \ \"homeId\": \"str\", # Optional. The home ID of the relationship.\n\ + \ \"label\": \"str\", # Optional. The label of the relationship.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"provenanceType\": 0.0, # Optional. Used to record the provenance\ + \ of\n an instance of an entity or relationship.\n \"status\"\ + : \"str\", # Optional. The enum of relationship status. Known\n values\ + \ are: \"ACTIVE\", \"DELETED\".\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the record.\n \"updatedBy\": \"str\", # Optional. The user\ + \ who updated the record.\n \"version\": 0.0 # Optional. The version\ + \ of the relationship.\n }\n }\n ````\n" +- uid: azure.purview.catalog.operations.RelationshipOperations.update + name: update + summary: Update an existing relationship between entities. + signature: 'update(relationship: MutableMapping[str, Any], **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: relationship + description: 'The AtlasRelationship object containing the information for the + + relationship to be created.' + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n relationship\ + \ = {\n \"attributes\": {\n \"str\": {} # Optional. The attributes\ + \ of the struct.\n },\n \"createTime\": 0.0, # Optional. The created\ + \ time of the record.\n \"createdBy\": \"str\", # Optional. The user who\ + \ created the record.\n \"end1\": {\n \"guid\": \"str\", # Optional.\ + \ The GUID of the object.\n \"typeName\": \"str\", # Optional. The\ + \ name of the type.\n \"uniqueAttributes\": {\n \"str\"\ + : {} # Optional. The unique attributes of the object.\n }\n },\n\ + \ \"end2\": {\n \"guid\": \"str\", # Optional. The GUID of the\ + \ object.\n \"typeName\": \"str\", # Optional. The name of the type.\n\ + \ \"uniqueAttributes\": {\n \"str\": {} # Optional. The\ + \ unique attributes of the object.\n }\n },\n \"guid\":\ + \ \"str\", # Optional. The GUID of the relationship.\n \"homeId\": \"str\"\ + , # Optional. The home ID of the relationship.\n \"label\": \"str\", #\ + \ Optional. The label of the relationship.\n \"lastModifiedTS\": \"str\"\ + , # Optional. ETag for concurrency control.\n \"provenanceType\": 0.0,\ + \ # Optional. Used to record the provenance of an\n instance of an entity\ + \ or relationship.\n \"status\": \"str\", # Optional. The enum of relationship\ + \ status. Known values\n are: \"ACTIVE\", \"DELETED\".\n \"typeName\"\ + : \"str\", # Optional. The name of the type.\n \"updateTime\": 0.0, #\ + \ Optional. The update time of the record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the record.\n \"version\": 0.0 # Optional.\ + \ The version of the relationship.\n }\n\n # response body for status code(s):\ + \ 200\n response.json() == {\n \"attributes\": {\n \"str\":\ + \ {} # Optional. The attributes of the struct.\n },\n \"createTime\"\ + : 0.0, # Optional. The created time of the record.\n \"createdBy\": \"\ + str\", # Optional. The user who created the record.\n \"end1\": {\n \ + \ \"guid\": \"str\", # Optional. The GUID of the object.\n \"\ + typeName\": \"str\", # Optional. The name of the type.\n \"uniqueAttributes\"\ + : {\n \"str\": {} # Optional. The unique attributes of the object.\n\ + \ }\n },\n \"end2\": {\n \"guid\": \"str\", #\ + \ Optional. The GUID of the object.\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"uniqueAttributes\": {\n \"\ + str\": {} # Optional. The unique attributes of the object.\n }\n \ + \ },\n \"guid\": \"str\", # Optional. The GUID of the relationship.\n\ + \ \"homeId\": \"str\", # Optional. The home ID of the relationship.\n \ + \ \"label\": \"str\", # Optional. The label of the relationship.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n \ + \ \"provenanceType\": 0.0, # Optional. Used to record the provenance of\ + \ an\n instance of an entity or relationship.\n \"status\": \"str\"\ + , # Optional. The enum of relationship status. Known values\n are: \"\ + ACTIVE\", \"DELETED\".\n \"typeName\": \"str\", # Optional. The name of\ + \ the type.\n \"updateTime\": 0.0, # Optional. The update time of the record.\n\ + \ \"updatedBy\": \"str\", # Optional. The user who updated the record.\n\ + \ \"version\": 0.0 # Optional. The version of the relationship.\n }\n\ + \ ````\n" diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.TypesOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.TypesOperations.yml new file mode 100644 index 00000000..023acf4d --- /dev/null +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.TypesOperations.yml @@ -0,0 +1,5786 @@ +### YamlMime:PythonClass +uid: azure.purview.catalog.operations.TypesOperations +name: TypesOperations +fullName: azure.purview.catalog.operations.TypesOperations +module: azure.purview.catalog.operations +summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\ + \ you should access the following operations through\n>\n> 's\n\ + >\n> attribute.\n>" +constructor: + syntax: TypesOperations(*args, **kwargs) +methods: +- uid: azure.purview.catalog.operations.TypesOperations.create_type_definitions + name: create_type_definitions + summary: 'Create all atlas type definitions in bulk, only new definitions will be + created. + + Any changes to the existing definitions will be discarded.' + signature: 'create_type_definitions(types_def: MutableMapping[str, Any], **kwargs: + Any) -> MutableMapping[str, Any]' + parameters: + - name: types_def + description: A composite wrapper object with corresponding lists of the type definition. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n types_def\ + \ = {\n \"businessMetadataDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"classificationDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + entityTypes\": [\n \"str\" # Optional. Specifying a list of\ + \ entityType\n names in the classificationDef, ensures that\ + \ classifications\n can\"nonly be applied to those entityTypes.\"\ + n\"n\"n.. raw:: html\"n\"n\n

    \"n
  • Any subtypes of\ + \ the entity types inherit the\n restriction
  • \"n
  • Any\ + \ classificationDef subtypes inherit the\n parents entityTypes\ + \ restrictions
  • \"n
  • Any classificationDef\n subtypes\ + \ can further restrict the parents entityTypes restrictions by\n \ + \ specifying a subset of the entityTypes
  • \"n
  • An empty\n \ + \ entityTypes list when there are no parent restrictions means\ + \ there\n are no restrictions
  • \"n
  • An empty entityTypes\ + \ list when there\n are parent restrictions means that the\ + \ subtype picks up the parents\n restrictions
  • \"n
  • If\ + \ a list of entityTypes are supplied,\n where one inherits\ + \ from another, this will be rejected. This should\n encourage\ + \ cleaner classificationsDefs
  • \"n
.\n ],\n \ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name\ + \ of the type definition.\n \"options\": {\n \"\ + str\": \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"subTypes\": [\n \"str\" #\ + \ Optional. An array of sub types.\n ],\n \"superTypes\"\ + : [\n \"str\" # Optional. An array of super types.\n \ + \ ],\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"entityDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"relationshipAttributeDefs\": [\n \ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isLegacyAttribute\"\ + : bool, # Optional.\n Determines if it is a legacy attribute.\n\ + \ \"isOptional\": bool, # Optional. Determines\n \ + \ if it is optional.\n \"isUnique\": bool,\ + \ # Optional. Determines if\n it unique.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"relationshipTypeName\": \"str\", # Optional.\n \ + \ The name of the relationship type.\n \"typeName\": \"\ + str\", # Optional. The name of\n the type.\n \ + \ \"valuesMaxCount\": 0, # Optional. The maximum\n \ + \ count of the values.\n \"valuesMinCount\"\ + : 0 # Optional. The minimum\n count of the values.\n\ + \ }\n ],\n \"serviceType\": \"str\"\ + , # Optional. The service type.\n \"subTypes\": [\n \ + \ \"str\" # Optional. An array of sub types.\n ],\n \ + \ \"superTypes\": [\n \"str\" # Optional. An array\ + \ of super types.\n ],\n \"typeVersion\": \"str\"\ + , # Optional. The version of the type.\n \"updateTime\": 0.0, \ + \ # Optional. The update time of the\n record.\n \ + \ \"updatedBy\": \"str\", # Optional. The user who updated the\n \ + \ record.\n \"version\": 0.0 # Optional. The version of the\ + \ record.\n }\n ],\n \"enumDefs\": [\n {\n \ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"defaultValue\": \"str\", # Optional.\ + \ The default value.\n \"description\": \"str\", # Optional. The\ + \ description of the\n type definition.\n \"elementDefs\"\ + : [\n {\n \"description\": \"str\", #\ + \ Optional. The\n description of the enum element definition.\n\ + \ \"ordinal\": 0.0, # Optional. The ordinal of\n \ + \ the enum element definition.\n \"value\"\ + : \"str\" # Optional. The value of the\n enum element\ + \ definition.\n }\n ],\n \"guid\"\ + : \"str\", # Optional. The GUID of the type definition.\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"name\": \"str\", # Optional. The name of the type definition.\n\ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options for the type\n definition.\n },\n\ + \ \"serviceType\": \"str\", # Optional. The service type.\n \ + \ \"typeVersion\": \"str\", # Optional. The version of the type.\n\ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the\n record.\n \"version\":\ + \ 0.0 # Optional. The version of the record.\n }\n ],\n \ + \ \"relationshipDefs\": [\n {\n \"attributeDefs\": [\n\ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isOptional\"\ + : bool, # Optional. Determines\n if it is optional.\n\ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", #\ + \ Optional. The name of the\n attribute.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options\n for the attribute.\n \ + \ },\n \"typeName\": \"str\", # Optional. The\ + \ name of\n the type.\n \"valuesMaxCount\"\ + : 0, # Optional. The maximum\n count of the values.\n\ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n \ + \ ],\n \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + endDef1\": {\n \"cardinality\": \"str\", # Optional. single-valued\n\ + \ attribute or multi-valued attribute. Known values are: \"\ + SINGLE\",\n \"LIST\", \"SET\".\n \"description\"\ + : \"str\", # Optional. The description of\n the relationship\ + \ end definition.\n \"isContainer\": bool, # Optional. Determines\ + \ if it is\n container.\n \"isLegacyAttribute\"\ + : bool, # Optional. Determines if\n it is a legacy attribute.\n\ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\"\ + \ # Optional. The type of the\n relationship end.\n \ + \ },\n \"endDef2\": {\n \"cardinality\"\ + : \"str\", # Optional. single-valued\n attribute or multi-valued\ + \ attribute. Known values are: \"SINGLE\",\n \"LIST\", \"\ + SET\".\n \"description\": \"str\", # Optional. The description\ + \ of\n the relationship end definition.\n \ + \ \"isContainer\": bool, # Optional. Determines if it is\n \ + \ container.\n \"isLegacyAttribute\": bool, # Optional.\ + \ Determines if\n it is a legacy attribute.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\" # Optional.\ + \ The type of the\n relationship end.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"name\": \"str\", # Optional. The\ + \ name of the type definition.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the type\n \ + \ definition.\n },\n \"relationshipCategory\"\ + : \"str\", # Optional. The Relationship\n category determines\ + \ the style of relationship around containment and\n lifecycle.\"\ + nUML terminology is used for the\n values.\"n\"n:code:`

`\"\ + nASSOCIATION is a relationship with no\n containment. :code:`
`\"\ + nCOMPOSITION and AGGREGATION are containment\n relationships.\"\ + n\"n:code:`

`\"nThe difference being in the lifecycles of\n \ + \ the container and its children. In the COMPOSITION case,\"nthe children\n \ + \ cannot exist without the container. For AGGREGATION, the life\ + \ cycles\"nof\n the container and children are totally independent.\ + \ Known values are:\n \"ASSOCIATION\", \"AGGREGATION\", \"COMPOSITION\"\ + .\n \"relationshipLabel\": \"str\", # Optional. The label of the\n\ + \ relationship.\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The\ + \ version of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the\n record.\n \"updatedBy\": \"str\"\ + , # Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n\ + \ ],\n \"structDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"termTemplateDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ]\n }\n\n # response body for status code(s): 200\n response.json()\ + \ == {\n \"businessMetadataDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"classificationDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + entityTypes\": [\n \"str\" # Optional. Specifying a list of\ + \ entityType\n names in the classificationDef, ensures that\ + \ classifications\n can\"nonly be applied to those entityTypes.\"\ + n\"n\"n.. raw:: html\"n\"n\n

    \"n
  • Any subtypes of\ + \ the entity types inherit the\n restriction
  • \"n
  • Any\ + \ classificationDef subtypes inherit the\n parents entityTypes\ + \ restrictions
  • \"n
  • Any classificationDef\n subtypes\ + \ can further restrict the parents entityTypes restrictions by\n \ + \ specifying a subset of the entityTypes
  • \"n
  • An empty\n \ + \ entityTypes list when there are no parent restrictions means\ + \ there\n are no restrictions
  • \"n
  • An empty entityTypes\ + \ list when there\n are parent restrictions means that the\ + \ subtype picks up the parents\n restrictions
  • \"n
  • If\ + \ a list of entityTypes are supplied,\n where one inherits\ + \ from another, this will be rejected. This should\n encourage\ + \ cleaner classificationsDefs
  • \"n
.\n ],\n \ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name\ + \ of the type definition.\n \"options\": {\n \"\ + str\": \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"subTypes\": [\n \"str\" #\ + \ Optional. An array of sub types.\n ],\n \"superTypes\"\ + : [\n \"str\" # Optional. An array of super types.\n \ + \ ],\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"entityDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"relationshipAttributeDefs\": [\n \ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isLegacyAttribute\"\ + : bool, # Optional.\n Determines if it is a legacy attribute.\n\ + \ \"isOptional\": bool, # Optional. Determines\n \ + \ if it is optional.\n \"isUnique\": bool,\ + \ # Optional. Determines if\n it unique.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"relationshipTypeName\": \"str\", # Optional.\n \ + \ The name of the relationship type.\n \"typeName\": \"\ + str\", # Optional. The name of\n the type.\n \ + \ \"valuesMaxCount\": 0, # Optional. The maximum\n \ + \ count of the values.\n \"valuesMinCount\"\ + : 0 # Optional. The minimum\n count of the values.\n\ + \ }\n ],\n \"serviceType\": \"str\"\ + , # Optional. The service type.\n \"subTypes\": [\n \ + \ \"str\" # Optional. An array of sub types.\n ],\n \ + \ \"superTypes\": [\n \"str\" # Optional. An array\ + \ of super types.\n ],\n \"typeVersion\": \"str\"\ + , # Optional. The version of the type.\n \"updateTime\": 0.0, \ + \ # Optional. The update time of the\n record.\n \ + \ \"updatedBy\": \"str\", # Optional. The user who updated the\n \ + \ record.\n \"version\": 0.0 # Optional. The version of the\ + \ record.\n }\n ],\n \"enumDefs\": [\n {\n \ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"defaultValue\": \"str\", # Optional.\ + \ The default value.\n \"description\": \"str\", # Optional. The\ + \ description of the\n type definition.\n \"elementDefs\"\ + : [\n {\n \"description\": \"str\", #\ + \ Optional. The\n description of the enum element definition.\n\ + \ \"ordinal\": 0.0, # Optional. The ordinal of\n \ + \ the enum element definition.\n \"value\"\ + : \"str\" # Optional. The value of the\n enum element\ + \ definition.\n }\n ],\n \"guid\"\ + : \"str\", # Optional. The GUID of the type definition.\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"name\": \"str\", # Optional. The name of the type definition.\n\ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options for the type\n definition.\n },\n\ + \ \"serviceType\": \"str\", # Optional. The service type.\n \ + \ \"typeVersion\": \"str\", # Optional. The version of the type.\n\ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the\n record.\n \"version\":\ + \ 0.0 # Optional. The version of the record.\n }\n ],\n \ + \ \"relationshipDefs\": [\n {\n \"attributeDefs\": [\n\ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isOptional\"\ + : bool, # Optional. Determines\n if it is optional.\n\ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", #\ + \ Optional. The name of the\n attribute.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options\n for the attribute.\n \ + \ },\n \"typeName\": \"str\", # Optional. The\ + \ name of\n the type.\n \"valuesMaxCount\"\ + : 0, # Optional. The maximum\n count of the values.\n\ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n \ + \ ],\n \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + endDef1\": {\n \"cardinality\": \"str\", # Optional. single-valued\n\ + \ attribute or multi-valued attribute. Known values are: \"\ + SINGLE\",\n \"LIST\", \"SET\".\n \"description\"\ + : \"str\", # Optional. The description of\n the relationship\ + \ end definition.\n \"isContainer\": bool, # Optional. Determines\ + \ if it is\n container.\n \"isLegacyAttribute\"\ + : bool, # Optional. Determines if\n it is a legacy attribute.\n\ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\"\ + \ # Optional. The type of the\n relationship end.\n \ + \ },\n \"endDef2\": {\n \"cardinality\"\ + : \"str\", # Optional. single-valued\n attribute or multi-valued\ + \ attribute. Known values are: \"SINGLE\",\n \"LIST\", \"\ + SET\".\n \"description\": \"str\", # Optional. The description\ + \ of\n the relationship end definition.\n \ + \ \"isContainer\": bool, # Optional. Determines if it is\n \ + \ container.\n \"isLegacyAttribute\": bool, # Optional.\ + \ Determines if\n it is a legacy attribute.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\" # Optional.\ + \ The type of the\n relationship end.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"name\": \"str\", # Optional. The\ + \ name of the type definition.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the type\n \ + \ definition.\n },\n \"relationshipCategory\"\ + : \"str\", # Optional. The Relationship\n category determines\ + \ the style of relationship around containment and\n lifecycle.\"\ + nUML terminology is used for the\n values.\"n\"n:code:`

`\"\ + nASSOCIATION is a relationship with no\n containment. :code:`
`\"\ + nCOMPOSITION and AGGREGATION are containment\n relationships.\"\ + n\"n:code:`

`\"nThe difference being in the lifecycles of\n \ + \ the container and its children. In the COMPOSITION case,\"nthe children\n \ + \ cannot exist without the container. For AGGREGATION, the life\ + \ cycles\"nof\n the container and children are totally independent.\ + \ Known values are:\n \"ASSOCIATION\", \"AGGREGATION\", \"COMPOSITION\"\ + .\n \"relationshipLabel\": \"str\", # Optional. The label of the\n\ + \ relationship.\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The\ + \ version of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the\n record.\n \"updatedBy\": \"str\"\ + , # Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n\ + \ ],\n \"structDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"termTemplateDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.TypesOperations.delete_type_by_name + name: delete_type_by_name + summary: Delete API for type identified by its name. + signature: 'delete_type_by_name(name: str, **kwargs: Any) -> None' + parameters: + - name: name + description: The name of the type. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.purview.catalog.operations.TypesOperations.delete_type_definitions + name: delete_type_definitions + summary: Delete API for all types in bulk. + signature: 'delete_type_definitions(types_def: MutableMapping[str, Any], **kwargs: + Any) -> None' + parameters: + - name: types_def + description: A composite object that captures all types to be deleted. + isRequired: true + types: + - + return: + description: None + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n types_def\ + \ = {\n \"businessMetadataDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"classificationDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + entityTypes\": [\n \"str\" # Optional. Specifying a list of\ + \ entityType\n names in the classificationDef, ensures that\ + \ classifications\n can\"nonly be applied to those entityTypes.\"\ + n\"n\"n.. raw:: html\"n\"n\n

    \"n
  • Any subtypes of\ + \ the entity types inherit the\n restriction
  • \"n
  • Any\ + \ classificationDef subtypes inherit the\n parents entityTypes\ + \ restrictions
  • \"n
  • Any classificationDef\n subtypes\ + \ can further restrict the parents entityTypes restrictions by\n \ + \ specifying a subset of the entityTypes
  • \"n
  • An empty\n \ + \ entityTypes list when there are no parent restrictions means\ + \ there\n are no restrictions
  • \"n
  • An empty entityTypes\ + \ list when there\n are parent restrictions means that the\ + \ subtype picks up the parents\n restrictions
  • \"n
  • If\ + \ a list of entityTypes are supplied,\n where one inherits\ + \ from another, this will be rejected. This should\n encourage\ + \ cleaner classificationsDefs
  • \"n
.\n ],\n \ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name\ + \ of the type definition.\n \"options\": {\n \"\ + str\": \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"subTypes\": [\n \"str\" #\ + \ Optional. An array of sub types.\n ],\n \"superTypes\"\ + : [\n \"str\" # Optional. An array of super types.\n \ + \ ],\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"entityDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"relationshipAttributeDefs\": [\n \ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isLegacyAttribute\"\ + : bool, # Optional.\n Determines if it is a legacy attribute.\n\ + \ \"isOptional\": bool, # Optional. Determines\n \ + \ if it is optional.\n \"isUnique\": bool,\ + \ # Optional. Determines if\n it unique.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"relationshipTypeName\": \"str\", # Optional.\n \ + \ The name of the relationship type.\n \"typeName\": \"\ + str\", # Optional. The name of\n the type.\n \ + \ \"valuesMaxCount\": 0, # Optional. The maximum\n \ + \ count of the values.\n \"valuesMinCount\"\ + : 0 # Optional. The minimum\n count of the values.\n\ + \ }\n ],\n \"serviceType\": \"str\"\ + , # Optional. The service type.\n \"subTypes\": [\n \ + \ \"str\" # Optional. An array of sub types.\n ],\n \ + \ \"superTypes\": [\n \"str\" # Optional. An array\ + \ of super types.\n ],\n \"typeVersion\": \"str\"\ + , # Optional. The version of the type.\n \"updateTime\": 0.0, \ + \ # Optional. The update time of the\n record.\n \ + \ \"updatedBy\": \"str\", # Optional. The user who updated the\n \ + \ record.\n \"version\": 0.0 # Optional. The version of the\ + \ record.\n }\n ],\n \"enumDefs\": [\n {\n \ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"defaultValue\": \"str\", # Optional.\ + \ The default value.\n \"description\": \"str\", # Optional. The\ + \ description of the\n type definition.\n \"elementDefs\"\ + : [\n {\n \"description\": \"str\", #\ + \ Optional. The\n description of the enum element definition.\n\ + \ \"ordinal\": 0.0, # Optional. The ordinal of\n \ + \ the enum element definition.\n \"value\"\ + : \"str\" # Optional. The value of the\n enum element\ + \ definition.\n }\n ],\n \"guid\"\ + : \"str\", # Optional. The GUID of the type definition.\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"name\": \"str\", # Optional. The name of the type definition.\n\ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options for the type\n definition.\n },\n\ + \ \"serviceType\": \"str\", # Optional. The service type.\n \ + \ \"typeVersion\": \"str\", # Optional. The version of the type.\n\ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the\n record.\n \"version\":\ + \ 0.0 # Optional. The version of the record.\n }\n ],\n \ + \ \"relationshipDefs\": [\n {\n \"attributeDefs\": [\n\ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isOptional\"\ + : bool, # Optional. Determines\n if it is optional.\n\ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", #\ + \ Optional. The name of the\n attribute.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options\n for the attribute.\n \ + \ },\n \"typeName\": \"str\", # Optional. The\ + \ name of\n the type.\n \"valuesMaxCount\"\ + : 0, # Optional. The maximum\n count of the values.\n\ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n \ + \ ],\n \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + endDef1\": {\n \"cardinality\": \"str\", # Optional. single-valued\n\ + \ attribute or multi-valued attribute. Known values are: \"\ + SINGLE\",\n \"LIST\", \"SET\".\n \"description\"\ + : \"str\", # Optional. The description of\n the relationship\ + \ end definition.\n \"isContainer\": bool, # Optional. Determines\ + \ if it is\n container.\n \"isLegacyAttribute\"\ + : bool, # Optional. Determines if\n it is a legacy attribute.\n\ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\"\ + \ # Optional. The type of the\n relationship end.\n \ + \ },\n \"endDef2\": {\n \"cardinality\"\ + : \"str\", # Optional. single-valued\n attribute or multi-valued\ + \ attribute. Known values are: \"SINGLE\",\n \"LIST\", \"\ + SET\".\n \"description\": \"str\", # Optional. The description\ + \ of\n the relationship end definition.\n \ + \ \"isContainer\": bool, # Optional. Determines if it is\n \ + \ container.\n \"isLegacyAttribute\": bool, # Optional.\ + \ Determines if\n it is a legacy attribute.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\" # Optional.\ + \ The type of the\n relationship end.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"name\": \"str\", # Optional. The\ + \ name of the type definition.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the type\n \ + \ definition.\n },\n \"relationshipCategory\"\ + : \"str\", # Optional. The Relationship\n category determines\ + \ the style of relationship around containment and\n lifecycle.\"\ + nUML terminology is used for the\n values.\"n\"n:code:`

`\"\ + nASSOCIATION is a relationship with no\n containment. :code:`
`\"\ + nCOMPOSITION and AGGREGATION are containment\n relationships.\"\ + n\"n:code:`

`\"nThe difference being in the lifecycles of\n \ + \ the container and its children. In the COMPOSITION case,\"nthe children\n \ + \ cannot exist without the container. For AGGREGATION, the life\ + \ cycles\"nof\n the container and children are totally independent.\ + \ Known values are:\n \"ASSOCIATION\", \"AGGREGATION\", \"COMPOSITION\"\ + .\n \"relationshipLabel\": \"str\", # Optional. The label of the\n\ + \ relationship.\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The\ + \ version of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the\n record.\n \"updatedBy\": \"str\"\ + , # Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n\ + \ ],\n \"structDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"termTemplateDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.TypesOperations.get_all_type_definitions + name: get_all_type_definitions + summary: Get all type definitions in Atlas in bulk. + signature: 'get_all_type_definitions(*, include_term_template: bool | None = False, + type: str | None = None, **kwargs: Any) -> MutableMapping[str, Any]' + keywordOnlyParameters: + - name: include_term_template + description: 'Whether include termtemplatedef when return all typedefs. + + This is always true when search filter type=term_template. Default value is + False.' + types: + - + - name: type + description: 'Typedef name as search filter when get typedefs. Known values are: + "enum", + + "entity", "classification", "relationship", "struct", and "term_template". Default + value is + + None.' + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + businessMetadataDefs\": [\n {\n \"attributeDefs\": [\n\ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isOptional\"\ + : bool, # Optional. Determines\n if it is optional.\n\ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", #\ + \ Optional. The name of the\n attribute.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options\n for the attribute.\n \ + \ },\n \"typeName\": \"str\", # Optional. The\ + \ name of\n the type.\n \"valuesMaxCount\"\ + : 0, # Optional. The maximum\n count of the values.\n\ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n \ + \ ],\n \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"classificationDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + entityTypes\": [\n \"str\" # Optional. Specifying a list of\ + \ entityType\n names in the classificationDef, ensures that\ + \ classifications\n can\"nonly be applied to those entityTypes.\"\ + n\"n\"n.. raw:: html\"n\"n\n

    \"n
  • Any subtypes of\ + \ the entity types inherit the\n restriction
  • \"n
  • Any\ + \ classificationDef subtypes inherit the\n parents entityTypes\ + \ restrictions
  • \"n
  • Any classificationDef\n subtypes\ + \ can further restrict the parents entityTypes restrictions by\n \ + \ specifying a subset of the entityTypes
  • \"n
  • An empty\n \ + \ entityTypes list when there are no parent restrictions means\ + \ there\n are no restrictions
  • \"n
  • An empty entityTypes\ + \ list when there\n are parent restrictions means that the\ + \ subtype picks up the parents\n restrictions
  • \"n
  • If\ + \ a list of entityTypes are supplied,\n where one inherits\ + \ from another, this will be rejected. This should\n encourage\ + \ cleaner classificationsDefs
  • \"n
.\n ],\n \ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name\ + \ of the type definition.\n \"options\": {\n \"\ + str\": \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"subTypes\": [\n \"str\" #\ + \ Optional. An array of sub types.\n ],\n \"superTypes\"\ + : [\n \"str\" # Optional. An array of super types.\n \ + \ ],\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"entityDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"relationshipAttributeDefs\": [\n \ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isLegacyAttribute\"\ + : bool, # Optional.\n Determines if it is a legacy attribute.\n\ + \ \"isOptional\": bool, # Optional. Determines\n \ + \ if it is optional.\n \"isUnique\": bool,\ + \ # Optional. Determines if\n it unique.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"relationshipTypeName\": \"str\", # Optional.\n \ + \ The name of the relationship type.\n \"typeName\": \"\ + str\", # Optional. The name of\n the type.\n \ + \ \"valuesMaxCount\": 0, # Optional. The maximum\n \ + \ count of the values.\n \"valuesMinCount\"\ + : 0 # Optional. The minimum\n count of the values.\n\ + \ }\n ],\n \"serviceType\": \"str\"\ + , # Optional. The service type.\n \"subTypes\": [\n \ + \ \"str\" # Optional. An array of sub types.\n ],\n \ + \ \"superTypes\": [\n \"str\" # Optional. An array\ + \ of super types.\n ],\n \"typeVersion\": \"str\"\ + , # Optional. The version of the type.\n \"updateTime\": 0.0, \ + \ # Optional. The update time of the\n record.\n \ + \ \"updatedBy\": \"str\", # Optional. The user who updated the\n \ + \ record.\n \"version\": 0.0 # Optional. The version of the\ + \ record.\n }\n ],\n \"enumDefs\": [\n {\n \ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"defaultValue\": \"str\", # Optional.\ + \ The default value.\n \"description\": \"str\", # Optional. The\ + \ description of the\n type definition.\n \"elementDefs\"\ + : [\n {\n \"description\": \"str\", #\ + \ Optional. The\n description of the enum element definition.\n\ + \ \"ordinal\": 0.0, # Optional. The ordinal of\n \ + \ the enum element definition.\n \"value\"\ + : \"str\" # Optional. The value of the\n enum element\ + \ definition.\n }\n ],\n \"guid\"\ + : \"str\", # Optional. The GUID of the type definition.\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"name\": \"str\", # Optional. The name of the type definition.\n\ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options for the type\n definition.\n },\n\ + \ \"serviceType\": \"str\", # Optional. The service type.\n \ + \ \"typeVersion\": \"str\", # Optional. The version of the type.\n\ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the\n record.\n \"version\":\ + \ 0.0 # Optional. The version of the record.\n }\n ],\n \ + \ \"relationshipDefs\": [\n {\n \"attributeDefs\": [\n\ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isOptional\"\ + : bool, # Optional. Determines\n if it is optional.\n\ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", #\ + \ Optional. The name of the\n attribute.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options\n for the attribute.\n \ + \ },\n \"typeName\": \"str\", # Optional. The\ + \ name of\n the type.\n \"valuesMaxCount\"\ + : 0, # Optional. The maximum\n count of the values.\n\ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n \ + \ ],\n \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + endDef1\": {\n \"cardinality\": \"str\", # Optional. single-valued\n\ + \ attribute or multi-valued attribute. Known values are: \"\ + SINGLE\",\n \"LIST\", \"SET\".\n \"description\"\ + : \"str\", # Optional. The description of\n the relationship\ + \ end definition.\n \"isContainer\": bool, # Optional. Determines\ + \ if it is\n container.\n \"isLegacyAttribute\"\ + : bool, # Optional. Determines if\n it is a legacy attribute.\n\ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\"\ + \ # Optional. The type of the\n relationship end.\n \ + \ },\n \"endDef2\": {\n \"cardinality\"\ + : \"str\", # Optional. single-valued\n attribute or multi-valued\ + \ attribute. Known values are: \"SINGLE\",\n \"LIST\", \"\ + SET\".\n \"description\": \"str\", # Optional. The description\ + \ of\n the relationship end definition.\n \ + \ \"isContainer\": bool, # Optional. Determines if it is\n \ + \ container.\n \"isLegacyAttribute\": bool, # Optional.\ + \ Determines if\n it is a legacy attribute.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\" # Optional.\ + \ The type of the\n relationship end.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"name\": \"str\", # Optional. The\ + \ name of the type definition.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the type\n \ + \ definition.\n },\n \"relationshipCategory\"\ + : \"str\", # Optional. The Relationship\n category determines\ + \ the style of relationship around containment and\n lifecycle.\"\ + nUML terminology is used for the\n values.\"n\"n:code:`

`\"\ + nASSOCIATION is a relationship with no\n containment. :code:`
`\"\ + nCOMPOSITION and AGGREGATION are containment\n relationships.\"\ + n\"n:code:`

`\"nThe difference being in the lifecycles of\n \ + \ the container and its children. In the COMPOSITION case,\"nthe children\n \ + \ cannot exist without the container. For AGGREGATION, the life\ + \ cycles\"nof\n the container and children are totally independent.\ + \ Known values are:\n \"ASSOCIATION\", \"AGGREGATION\", \"COMPOSITION\"\ + .\n \"relationshipLabel\": \"str\", # Optional. The label of the\n\ + \ relationship.\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The\ + \ version of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the\n record.\n \"updatedBy\": \"str\"\ + , # Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n\ + \ ],\n \"structDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"termTemplateDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ]\n }\n ````\n" +- uid: azure.purview.catalog.operations.TypesOperations.get_business_metadata_def_by_guid + name: get_business_metadata_def_by_guid + summary: Get the businessMetadata definition for the given guid. + signature: 'get_business_metadata_def_by_guid(guid: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: guid + description: businessMetadata guid. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time of the\ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who updated the\ + \ record.\n \"version\": 0.0 # Optional. The version of the record.\n \ + \ }\n ````\n" +- uid: azure.purview.catalog.operations.TypesOperations.get_business_metadata_def_by_name + name: get_business_metadata_def_by_name + summary: Get the businessMetadata definition by it's name (unique). + signature: 'get_business_metadata_def_by_name(name: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: name + description: businessMetadata name. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time of the\ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who updated the\ + \ record.\n \"version\": 0.0 # Optional. The version of the record.\n \ + \ }\n ````\n" +- uid: azure.purview.catalog.operations.TypesOperations.get_classification_def_by_guid + name: get_classification_def_by_guid + summary: Get the classification definition for the given GUID. + signature: 'get_classification_def_by_guid(guid: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: guid + description: The globally unique identifier of the classification. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"entityTypes\": [\n \"str\" # Optional. Specifying a list\ + \ of entityType names in the\n classificationDef, ensures that classifications\ + \ can\"nonly be applied to those\n entityTypes.\"n\"n\"n.. raw:: html\"\ + n\"n

    \"n
  • Any subtypes of the entity\n types inherit the\ + \ restriction
  • \"n
  • Any classificationDef subtypes\n inherit\ + \ the parents entityTypes restrictions
  • \"n
  • Any\n classificationDef\ + \ subtypes can further restrict the parents entityTypes\n restrictions\ + \ by specifying a subset of the entityTypes
  • \"n
  • An empty\n \ + \ entityTypes list when there are no parent restrictions means there are no\n\ + \ restrictions
  • \"n
  • An empty entityTypes list when there\ + \ are parent\n restrictions means that the subtype picks up the parents\ + \ restrictions
  • \"n\n
  • If a list of entityTypes are supplied,\ + \ where one inherits from another,\n this will be rejected. This should\ + \ encourage cleaner\n classificationsDefs
  • \"n
.\n \ + \ ],\n \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"subTypes\": [\n \"str\" # Optional. An\ + \ array of sub types.\n ],\n \"superTypes\": [\n \"str\"\ + \ # Optional. An array of super types.\n ],\n \"typeVersion\": \"\ + str\", # Optional. The version of the type.\n \"updateTime\": 0.0, # Optional.\ + \ The update time of the record.\n \"updatedBy\": \"str\", # Optional.\ + \ The user who updated the record.\n \"version\": 0.0 # Optional. The version\ + \ of the record.\n }\n ````\n" +- uid: azure.purview.catalog.operations.TypesOperations.get_classification_def_by_name + name: get_classification_def_by_name + summary: Get the classification definition by its name (unique). + signature: 'get_classification_def_by_name(name: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: name + description: The name of the classification. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"entityTypes\": [\n \"str\" # Optional. Specifying a list\ + \ of entityType names in the\n classificationDef, ensures that classifications\ + \ can\"nonly be applied to those\n entityTypes.\"n\"n\"n.. raw:: html\"\ + n\"n
    \"n
  • Any subtypes of the entity\n types inherit the\ + \ restriction
  • \"n
  • Any classificationDef subtypes\n inherit\ + \ the parents entityTypes restrictions
  • \"n
  • Any\n classificationDef\ + \ subtypes can further restrict the parents entityTypes\n restrictions\ + \ by specifying a subset of the entityTypes
  • \"n
  • An empty\n \ + \ entityTypes list when there are no parent restrictions means there are no\n\ + \ restrictions
  • \"n
  • An empty entityTypes list when there\ + \ are parent\n restrictions means that the subtype picks up the parents\ + \ restrictions
  • \"n\n
  • If a list of entityTypes are supplied,\ + \ where one inherits from another,\n this will be rejected. This should\ + \ encourage cleaner\n classificationsDefs
  • \"n
.\n \ + \ ],\n \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"subTypes\": [\n \"str\" # Optional. An\ + \ array of sub types.\n ],\n \"superTypes\": [\n \"str\"\ + \ # Optional. An array of super types.\n ],\n \"typeVersion\": \"\ + str\", # Optional. The version of the type.\n \"updateTime\": 0.0, # Optional.\ + \ The update time of the record.\n \"updatedBy\": \"str\", # Optional.\ + \ The user who updated the record.\n \"version\": 0.0 # Optional. The version\ + \ of the record.\n }\n ````\n" +- uid: azure.purview.catalog.operations.TypesOperations.get_entity_definition_by_guid + name: get_entity_definition_by_guid + summary: Get the Entity definition for the given GUID. + signature: 'get_entity_definition_by_guid(guid: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: guid + description: The globally unique identifier of the entity. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"relationshipAttributeDefs\": [\n \ + \ {\n \"cardinality\": \"str\", # Optional. single-valued\ + \ attribute or\n multi-valued attribute. Known values are: \"\ + SINGLE\", \"LIST\", \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \"\ + str\": {} # Optional. The parameters\n of the constraint\ + \ definition.\n },\n \"type\": \"\ + str\" # Optional. The type of the\n constraint.\n \ + \ }\n ],\n \"defaultValue\": \"str\"\ + , # Optional. The default value of the\n attribute.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ attribute.\n \"includeInNotification\": bool, # Optional.\ + \ Determines if it\n is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isLegacyAttribute\": bool, # Optional. Determines\ + \ if it is a\n legacy attribute.\n \"isOptional\"\ + : bool, # Optional. Determines if it is\n optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if it unique.\n \ + \ \"name\": \"str\", # Optional. The name of the attribute.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options\ + \ for the\n attribute.\n },\n \ + \ \"relationshipTypeName\": \"str\", # Optional. The name of the\n \ + \ relationship type.\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"valuesMaxCount\": 0, # Optional. The\ + \ maximum count of the\n values.\n \"valuesMinCount\"\ + : 0 # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"serviceType\": \"str\", # Optional. The service type.\n\ + \ \"subTypes\": [\n \"str\" # Optional. An array of sub types.\n\ + \ ],\n \"superTypes\": [\n \"str\" # Optional. An array\ + \ of super types.\n ],\n \"typeVersion\": \"str\", # Optional. The\ + \ version of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the record.\n \"updatedBy\": \"str\", # Optional. The user who updated\ + \ the record.\n \"version\": 0.0 # Optional. The version of the record.\n\ + \ }\n ````\n" +- uid: azure.purview.catalog.operations.TypesOperations.get_entity_definition_by_name + name: get_entity_definition_by_name + summary: Get the entity definition by its name (unique). + signature: 'get_entity_definition_by_name(name: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: name + description: The name of the entity. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"relationshipAttributeDefs\": [\n \ + \ {\n \"cardinality\": \"str\", # Optional. single-valued\ + \ attribute or\n multi-valued attribute. Known values are: \"\ + SINGLE\", \"LIST\", \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \"\ + str\": {} # Optional. The parameters\n of the constraint\ + \ definition.\n },\n \"type\": \"\ + str\" # Optional. The type of the\n constraint.\n \ + \ }\n ],\n \"defaultValue\": \"str\"\ + , # Optional. The default value of the\n attribute.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ attribute.\n \"includeInNotification\": bool, # Optional.\ + \ Determines if it\n is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isLegacyAttribute\": bool, # Optional. Determines\ + \ if it is a\n legacy attribute.\n \"isOptional\"\ + : bool, # Optional. Determines if it is\n optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if it unique.\n \ + \ \"name\": \"str\", # Optional. The name of the attribute.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options\ + \ for the\n attribute.\n },\n \ + \ \"relationshipTypeName\": \"str\", # Optional. The name of the\n \ + \ relationship type.\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"valuesMaxCount\": 0, # Optional. The\ + \ maximum count of the\n values.\n \"valuesMinCount\"\ + : 0 # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"serviceType\": \"str\", # Optional. The service type.\n\ + \ \"subTypes\": [\n \"str\" # Optional. An array of sub types.\n\ + \ ],\n \"superTypes\": [\n \"str\" # Optional. An array\ + \ of super types.\n ],\n \"typeVersion\": \"str\", # Optional. The\ + \ version of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the record.\n \"updatedBy\": \"str\", # Optional. The user who updated\ + \ the record.\n \"version\": 0.0 # Optional. The version of the record.\n\ + \ }\n ````\n" +- uid: azure.purview.catalog.operations.TypesOperations.get_enum_def_by_guid + name: get_enum_def_by_guid + summary: Get the enum definition for the given GUID. + signature: 'get_enum_def_by_guid(guid: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: guid + description: The globally unique identifier of the enum. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + category\": \"str\", # Optional. The enum of type category. Known values are:\n\ + \ \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"STRUCT\", \"CLASSIFICATION\"\ + , \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\", \"TERM_TEMPLATE\"\ + .\n \"createTime\": 0.0, # Optional. The created time of the record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the record.\n\ + \ \"dateFormatter\": {\n \"availableLocales\": [\n \ + \ \"str\" # Optional. An array of available locales.\n ],\n \ + \ \"calendar\": 0.0, # Optional. The date format.\n \"dateInstance\"\ + : ...,\n \"dateTimeInstance\": ...,\n \"instance\": ...,\n\ + \ \"lenient\": bool, # Optional. Determines the leniency of the date\n\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional. The currency.\n \ + \ \"currencyInstance\": ...,\n \"groupingUsed\": bool,\ + \ # Optional. Determines if grouping is\n used.\n \ + \ \"instance\": ...,\n \"integerInstance\": ...,\n \ + \ \"maximumFractionDigits\": 0, # Optional. The maximum of\n \ + \ fraction digits.\n \"maximumIntegerDigits\": 0, # Optional.\ + \ The maximum of\n integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The minimum of\n fraction digits.\n \ + \ \"minimumIntegerDigits\": 0, # Optional. The minimum of\n \ + \ integer digits.\n \"numberInstance\": ...,\n \ + \ \"parseIntegerOnly\": bool, # Optional. Determines if only\n \ + \ integer is parsed.\n \"percentInstance\": ...,\n \ + \ \"roundingMode\": \"str\" # Optional. The enum of rounding mode.\n \ + \ Known values are: \"UP\", \"DOWN\", \"CEILING\", \"FLOOR\", \"\ + HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n\ + \ },\n \"timeInstance\": ...,\n \"timeZone\": {\n\ + \ \"availableIds\": [\n \"str\" # Optional. An\ + \ array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"defaultValue\": \"str\", # Optional. The default value.\n \"description\"\ + : \"str\", # Optional. The description of the type definition.\n \"elementDefs\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n enum element definition.\n \"ordinal\"\ + : 0.0, # Optional. The ordinal of the enum element\n definition.\n\ + \ \"value\": \"str\" # Optional. The value of the enum element\n\ + \ definition.\n }\n ],\n \"guid\": \"str\"\ + , # Optional. The GUID of the type definition.\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag for concurrency control.\n \"name\": \"str\", \ + \ # Optional. The name of the type definition.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the type definition.\n \ + \ },\n \"serviceType\": \"str\", # Optional. The service type.\n \ + \ \"typeVersion\": \"str\", # Optional. The version of the type.\n \"\ + updateTime\": 0.0, # Optional. The update time of the record.\n \"updatedBy\"\ + : \"str\", # Optional. The user who updated the record.\n \"version\":\ + \ 0.0 # Optional. The version of the record.\n }\n ````\n" +- uid: azure.purview.catalog.operations.TypesOperations.get_enum_def_by_name + name: get_enum_def_by_name + summary: Get the enum definition by its name (unique). + signature: 'get_enum_def_by_name(name: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: name + description: The name of the enum. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + category\": \"str\", # Optional. The enum of type category. Known values are:\n\ + \ \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"STRUCT\", \"CLASSIFICATION\"\ + , \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\", \"TERM_TEMPLATE\"\ + .\n \"createTime\": 0.0, # Optional. The created time of the record.\n\ + \ \"createdBy\": \"str\", # Optional. The user who created the record.\n\ + \ \"dateFormatter\": {\n \"availableLocales\": [\n \ + \ \"str\" # Optional. An array of available locales.\n ],\n \ + \ \"calendar\": 0.0, # Optional. The date format.\n \"dateInstance\"\ + : ...,\n \"dateTimeInstance\": ...,\n \"instance\": ...,\n\ + \ \"lenient\": bool, # Optional. Determines the leniency of the date\n\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional. The currency.\n \ + \ \"currencyInstance\": ...,\n \"groupingUsed\": bool,\ + \ # Optional. Determines if grouping is\n used.\n \ + \ \"instance\": ...,\n \"integerInstance\": ...,\n \ + \ \"maximumFractionDigits\": 0, # Optional. The maximum of\n \ + \ fraction digits.\n \"maximumIntegerDigits\": 0, # Optional.\ + \ The maximum of\n integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The minimum of\n fraction digits.\n \ + \ \"minimumIntegerDigits\": 0, # Optional. The minimum of\n \ + \ integer digits.\n \"numberInstance\": ...,\n \ + \ \"parseIntegerOnly\": bool, # Optional. Determines if only\n \ + \ integer is parsed.\n \"percentInstance\": ...,\n \ + \ \"roundingMode\": \"str\" # Optional. The enum of rounding mode.\n \ + \ Known values are: \"UP\", \"DOWN\", \"CEILING\", \"FLOOR\", \"\ + HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n\ + \ },\n \"timeInstance\": ...,\n \"timeZone\": {\n\ + \ \"availableIds\": [\n \"str\" # Optional. An\ + \ array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"defaultValue\": \"str\", # Optional. The default value.\n \"description\"\ + : \"str\", # Optional. The description of the type definition.\n \"elementDefs\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n enum element definition.\n \"ordinal\"\ + : 0.0, # Optional. The ordinal of the enum element\n definition.\n\ + \ \"value\": \"str\" # Optional. The value of the enum element\n\ + \ definition.\n }\n ],\n \"guid\": \"str\"\ + , # Optional. The GUID of the type definition.\n \"lastModifiedTS\": \"\ + str\", # Optional. ETag for concurrency control.\n \"name\": \"str\", \ + \ # Optional. The name of the type definition.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the type definition.\n \ + \ },\n \"serviceType\": \"str\", # Optional. The service type.\n \ + \ \"typeVersion\": \"str\", # Optional. The version of the type.\n \"\ + updateTime\": 0.0, # Optional. The update time of the record.\n \"updatedBy\"\ + : \"str\", # Optional. The user who updated the record.\n \"version\":\ + \ 0.0 # Optional. The version of the record.\n }\n ````\n" +- uid: azure.purview.catalog.operations.TypesOperations.get_relationship_def_by_guid + name: get_relationship_def_by_guid + summary: Get the relationship definition for the given GUID. + signature: 'get_relationship_def_by_guid(guid: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: guid + description: The globally unique identifier of the relationship. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"endDef1\": {\n \"cardinality\": \"str\", # Optional. single-valued\ + \ attribute or\n multi-valued attribute. Known values are: \"SINGLE\"\ + , \"LIST\", \"SET\".\n \"description\": \"str\", # Optional. The description\ + \ of the\n relationship end definition.\n \"isContainer\"\ + : bool, # Optional. Determines if it is container.\n \"isLegacyAttribute\"\ + : bool, # Optional. Determines if it is a legacy\n attribute.\n \ + \ \"name\": \"str\", # Optional. The name of the relationship end\n\ + \ definition.\n \"type\": \"str\" # Optional. The type\ + \ of the relationship end.\n },\n \"endDef2\": {\n \"cardinality\"\ + : \"str\", # Optional. single-valued attribute or\n multi-valued\ + \ attribute. Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"description\"\ + : \"str\", # Optional. The description of the\n relationship end\ + \ definition.\n \"isContainer\": bool, # Optional. Determines if it\ + \ is container.\n \"isLegacyAttribute\": bool, # Optional. Determines\ + \ if it is a legacy\n attribute.\n \"name\": \"str\", #\ + \ Optional. The name of the relationship end\n definition.\n \ + \ \"type\": \"str\" # Optional. The type of the relationship end.\n \ + \ },\n \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"relationshipCategory\": \"str\", \ + \ # Optional. The Relationship category\n determines the style of relationship\ + \ around containment and lifecycle.\"nUML\n terminology is used for the\ + \ values.\"n\"n:code:`

`\"nASSOCIATION is a relationship\n with no containment.\ + \ :code:`
`\"nCOMPOSITION and AGGREGATION are containment\n relationships.\"\ + n\"n:code:`

`\"nThe difference being in the lifecycles of the\n container\ + \ and its children. In the COMPOSITION case,\"nthe children cannot exist\n \ + \ without the container. For AGGREGATION, the life cycles\"nof the container\ + \ and\n children are totally independent. Known values are: \"ASSOCIATION\"\ + , \"AGGREGATION\",\n \"COMPOSITION\".\n \"relationshipLabel\": \"\ + str\", # Optional. The label of the relationship.\n \"serviceType\": \"\ + str\", # Optional. The service type.\n \"typeVersion\": \"str\", # Optional.\ + \ The version of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the record.\n \"version\": 0.0 # Optional. The version of the\ + \ record.\n }\n ````\n" +- uid: azure.purview.catalog.operations.TypesOperations.get_relationship_def_by_name + name: get_relationship_def_by_name + summary: Get the relationship definition by its name (unique). + signature: 'get_relationship_def_by_name(name: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: name + description: The name of the relationship. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"endDef1\": {\n \"cardinality\": \"str\", # Optional. single-valued\ + \ attribute or\n multi-valued attribute. Known values are: \"SINGLE\"\ + , \"LIST\", \"SET\".\n \"description\": \"str\", # Optional. The description\ + \ of the\n relationship end definition.\n \"isContainer\"\ + : bool, # Optional. Determines if it is container.\n \"isLegacyAttribute\"\ + : bool, # Optional. Determines if it is a legacy\n attribute.\n \ + \ \"name\": \"str\", # Optional. The name of the relationship end\n\ + \ definition.\n \"type\": \"str\" # Optional. The type\ + \ of the relationship end.\n },\n \"endDef2\": {\n \"cardinality\"\ + : \"str\", # Optional. single-valued attribute or\n multi-valued\ + \ attribute. Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"description\"\ + : \"str\", # Optional. The description of the\n relationship end\ + \ definition.\n \"isContainer\": bool, # Optional. Determines if it\ + \ is container.\n \"isLegacyAttribute\": bool, # Optional. Determines\ + \ if it is a legacy\n attribute.\n \"name\": \"str\", #\ + \ Optional. The name of the relationship end\n definition.\n \ + \ \"type\": \"str\" # Optional. The type of the relationship end.\n \ + \ },\n \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"relationshipCategory\": \"str\", \ + \ # Optional. The Relationship category\n determines the style of relationship\ + \ around containment and lifecycle.\"nUML\n terminology is used for the\ + \ values.\"n\"n:code:`

`\"nASSOCIATION is a relationship\n with no containment.\ + \ :code:`
`\"nCOMPOSITION and AGGREGATION are containment\n relationships.\"\ + n\"n:code:`

`\"nThe difference being in the lifecycles of the\n container\ + \ and its children. In the COMPOSITION case,\"nthe children cannot exist\n \ + \ without the container. For AGGREGATION, the life cycles\"nof the container\ + \ and\n children are totally independent. Known values are: \"ASSOCIATION\"\ + , \"AGGREGATION\",\n \"COMPOSITION\".\n \"relationshipLabel\": \"\ + str\", # Optional. The label of the relationship.\n \"serviceType\": \"\ + str\", # Optional. The service type.\n \"typeVersion\": \"str\", # Optional.\ + \ The version of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the record.\n \"updatedBy\": \"str\", # Optional. The user who\ + \ updated the record.\n \"version\": 0.0 # Optional. The version of the\ + \ record.\n }\n ````\n" +- uid: azure.purview.catalog.operations.TypesOperations.get_struct_def_by_guid + name: get_struct_def_by_guid + summary: Get the struct definition for the given GUID. + signature: 'get_struct_def_by_guid(guid: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: guid + description: The globally unique identifier of the struct. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time of the\ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who updated the\ + \ record.\n \"version\": 0.0 # Optional. The version of the record.\n \ + \ }\n ````\n" +- uid: azure.purview.catalog.operations.TypesOperations.get_struct_def_by_name + name: get_struct_def_by_name + summary: Get the struct definition by its name (unique). + signature: 'get_struct_def_by_name(name: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: name + description: The name of the struct. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time of the\ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who updated the\ + \ record.\n \"version\": 0.0 # Optional. The version of the record.\n \ + \ }\n ````\n" +- uid: azure.purview.catalog.operations.TypesOperations.get_term_template_def_by_guid + name: get_term_template_def_by_guid + summary: Get the term template definition for the given GUID. + signature: 'get_term_template_def_by_guid(guid: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: guid + description: The globally unique identifier of the term template. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time of the\ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who updated the\ + \ record.\n \"version\": 0.0 # Optional. The version of the record.\n \ + \ }\n ````\n" +- uid: azure.purview.catalog.operations.TypesOperations.get_term_template_def_by_name + name: get_term_template_def_by_name + summary: Get the term template definition by its name (unique). + signature: 'get_term_template_def_by_name(name: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: name + description: The name of the term template. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"description\": \"str\", # Optional. The description of the type definition.\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time of the\ + \ record.\n \"updatedBy\": \"str\", # Optional. The user who updated the\ + \ record.\n \"version\": 0.0 # Optional. The version of the record.\n \ + \ }\n ````\n" +- uid: azure.purview.catalog.operations.TypesOperations.get_type_definition_by_guid + name: get_type_definition_by_guid + summary: Get the type definition for the given GUID. + signature: 'get_type_definition_by_guid(guid: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: guid + description: The globally unique identifier of the type. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"defaultValue\": \"str\", # Optional. The default value.\n \"description\"\ + : \"str\", # Optional. The description of the type definition.\n \"elementDefs\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n enum element definition.\n \"ordinal\"\ + : 0.0, # Optional. The ordinal of the enum element\n definition.\n\ + \ \"value\": \"str\" # Optional. The value of the enum element\n\ + \ definition.\n }\n ],\n \"endDef1\": {\n\ + \ \"cardinality\": \"str\", # Optional. single-valued attribute or\n\ + \ multi-valued attribute. Known values are: \"SINGLE\", \"LIST\",\ + \ \"SET\".\n \"description\": \"str\", # Optional. The description\ + \ of the\n relationship end definition.\n \"isContainer\"\ + : bool, # Optional. Determines if it is container.\n \"isLegacyAttribute\"\ + : bool, # Optional. Determines if it is a legacy\n attribute.\n \ + \ \"name\": \"str\", # Optional. The name of the relationship end\n\ + \ definition.\n \"type\": \"str\" # Optional. The type\ + \ of the relationship end.\n },\n \"endDef2\": {\n \"cardinality\"\ + : \"str\", # Optional. single-valued attribute or\n multi-valued\ + \ attribute. Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"description\"\ + : \"str\", # Optional. The description of the\n relationship end\ + \ definition.\n \"isContainer\": bool, # Optional. Determines if it\ + \ is container.\n \"isLegacyAttribute\": bool, # Optional. Determines\ + \ if it is a legacy\n attribute.\n \"name\": \"str\", #\ + \ Optional. The name of the relationship end\n definition.\n \ + \ \"type\": \"str\" # Optional. The type of the relationship end.\n \ + \ },\n \"entityTypes\": [\n \"str\" # Optional. Specifying\ + \ a list of entityType names in the\n classificationDef, ensures that\ + \ classifications can\"nonly be applied to those\n entityTypes.\"\ + n\"n\"n.. raw:: html\"n\"n

    \"n
  • Any subtypes of the entity\n \ + \ types inherit the restriction
  • \"n
  • Any classificationDef subtypes\n\ + \ inherit the parents entityTypes restrictions
  • \"n
  • Any\n\ + \ classificationDef subtypes can further restrict the parents entityTypes\n\ + \ restrictions by specifying a subset of the entityTypes
  • \"n \ + \
  • An empty\n entityTypes list when there are no parent restrictions\ + \ means there are no\n restrictions
  • \"n
  • An empty entityTypes\ + \ list when there are parent\n restrictions means that the subtype\ + \ picks up the parents restrictions
  • \"n\n
  • If a list of entityTypes\ + \ are supplied, where one inherits from another,\n this will be rejected.\ + \ This should encourage cleaner\n classificationsDefs
  • \"n
.\n\ + \ ],\n \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"relationshipAttributeDefs\": [\n \ + \ {\n \"cardinality\": \"str\", # Optional. single-valued\ + \ attribute or\n multi-valued attribute. Known values are: \"\ + SINGLE\", \"LIST\", \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \"\ + str\": {} # Optional. The parameters\n of the constraint\ + \ definition.\n },\n \"type\": \"\ + str\" # Optional. The type of the\n constraint.\n \ + \ }\n ],\n \"defaultValue\": \"str\"\ + , # Optional. The default value of the\n attribute.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ attribute.\n \"includeInNotification\": bool, # Optional.\ + \ Determines if it\n is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isLegacyAttribute\": bool, # Optional. Determines\ + \ if it is a\n legacy attribute.\n \"isOptional\"\ + : bool, # Optional. Determines if it is\n optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if it unique.\n \ + \ \"name\": \"str\", # Optional. The name of the attribute.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options\ + \ for the\n attribute.\n },\n \ + \ \"relationshipTypeName\": \"str\", # Optional. The name of the\n \ + \ relationship type.\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"valuesMaxCount\": 0, # Optional. The\ + \ maximum count of the\n values.\n \"valuesMinCount\"\ + : 0 # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"relationshipCategory\": \"str\", # Optional. The Relationship\ + \ category\n determines the style of relationship around containment and\ + \ lifecycle.\"nUML\n terminology is used for the values.\"n\"n:code:`

`\"\ + nASSOCIATION is a relationship\n with no containment. :code:`
`\"nCOMPOSITION\ + \ and AGGREGATION are containment\n relationships.\"n\"n:code:`

`\"\ + nThe difference being in the lifecycles of the\n container and its children.\ + \ In the COMPOSITION case,\"nthe children cannot exist\n without the container.\ + \ For AGGREGATION, the life cycles\"nof the container and\n children are\ + \ totally independent. Known values are: \"ASSOCIATION\", \"AGGREGATION\",\n \ + \ \"COMPOSITION\".\n \"relationshipLabel\": \"str\", # Optional.\ + \ The label of the relationship.\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"subTypes\": [\n \"str\" # Optional. An\ + \ array of sub types.\n ],\n \"superTypes\": [\n \"str\"\ + \ # Optional. An array of super types.\n ],\n \"typeVersion\": \"\ + str\", # Optional. The version of the type.\n \"updateTime\": 0.0, # Optional.\ + \ The update time of the record.\n \"updatedBy\": \"str\", # Optional.\ + \ The user who updated the record.\n \"version\": 0.0 # Optional. The version\ + \ of the record.\n }\n ````\n" +- uid: azure.purview.catalog.operations.TypesOperations.get_type_definition_by_name + name: get_type_definition_by_name + summary: Get the type definition by its name (unique). + signature: 'get_type_definition_by_name(name: str, **kwargs: Any) -> MutableMapping[str, + Any]' + parameters: + - name: name + description: The name of the type. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == {\n \"\ + attributeDefs\": [\n {\n \"cardinality\": \"str\", #\ + \ Optional. single-valued attribute or\n multi-valued attribute.\ + \ Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"constraints\"\ + : [\n {\n \"params\": {\n \ + \ \"str\": {} # Optional. The parameters\n \ + \ of the constraint definition.\n },\n \ + \ \"type\": \"str\" # Optional. The type of the\n \ + \ constraint.\n }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The default value of the\n \ + \ attribute.\n \"description\": \"str\", # Optional.\ + \ The description of the\n attribute.\n \"includeInNotification\"\ + : bool, # Optional. Determines if it\n is included in notification.\n\ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isOptional\": bool, # Optional. Determines\ + \ if it is\n optional.\n \"isUnique\": bool, #\ + \ Optional. Determines if it unique.\n \"name\": \"str\", # Optional.\ + \ The name of the attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the\n attribute.\n\ + \ },\n \"typeName\": \"str\", # Optional. The name\ + \ of the type.\n \"valuesMaxCount\": 0, # Optional. The maximum\ + \ count of the\n values.\n \"valuesMinCount\": 0\ + \ # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"category\": \"str\", # Optional. The enum of type category.\ + \ Known values are:\n \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"\ + STRUCT\", \"CLASSIFICATION\", \"ENTITY\",\n \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"createTime\": 0.0, # Optional. The created time\ + \ of the record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the record.\n \"dateFormatter\": {\n \"availableLocales\": [\n\ + \ \"str\" # Optional. An array of available locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\": ...,\n \ + \ \"instance\": ...,\n \"lenient\": bool, # Optional. Determines the\ + \ leniency of the date\n format.\n \"numberFormat\": {\n\ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ The number format.\n ],\n \"currency\": \"str\"\ + , # Optional. The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines if grouping is\n \ + \ used.\n \"instance\": ...,\n \"integerInstance\"\ + : ...,\n \"maximumFractionDigits\": 0, # Optional. The maximum\ + \ of\n fraction digits.\n \"maximumIntegerDigits\"\ + : 0, # Optional. The maximum of\n integer digits.\n \ + \ \"minimumFractionDigits\": 0, # Optional. The minimum of\n \ + \ fraction digits.\n \"minimumIntegerDigits\": 0, # Optional.\ + \ The minimum of\n integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional. Determines if\ + \ only\n integer is parsed.\n \"percentInstance\"\ + : ...,\n \"roundingMode\": \"str\" # Optional. The enum of rounding\ + \ mode.\n Known values are: \"UP\", \"DOWN\", \"CEILING\", \"\ + FLOOR\", \"HALF_UP\",\n \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\"\ + .\n },\n \"timeInstance\": ...,\n \"timeZone\":\ + \ {\n \"availableIds\": [\n \"str\" # Optional.\ + \ An array of available IDs.\n ],\n \"default\": ...,\n\ + \ \"displayName\": \"str\", # Optional. The display name of the\n\ + \ timezone.\n \"dstSavings\": 0, # Optional. The\ + \ value of the daylight\n saving time.\n \"id\"\ + : \"str\", # Optional. The ID of the timezone.\n \"rawOffset\"\ + : 0 # Optional. The raw offset of the timezone.\n }\n },\n \ + \ \"defaultValue\": \"str\", # Optional. The default value.\n \"description\"\ + : \"str\", # Optional. The description of the type definition.\n \"elementDefs\"\ + : [\n {\n \"description\": \"str\", # Optional. The description\ + \ of the\n enum element definition.\n \"ordinal\"\ + : 0.0, # Optional. The ordinal of the enum element\n definition.\n\ + \ \"value\": \"str\" # Optional. The value of the enum element\n\ + \ definition.\n }\n ],\n \"endDef1\": {\n\ + \ \"cardinality\": \"str\", # Optional. single-valued attribute or\n\ + \ multi-valued attribute. Known values are: \"SINGLE\", \"LIST\",\ + \ \"SET\".\n \"description\": \"str\", # Optional. The description\ + \ of the\n relationship end definition.\n \"isContainer\"\ + : bool, # Optional. Determines if it is container.\n \"isLegacyAttribute\"\ + : bool, # Optional. Determines if it is a legacy\n attribute.\n \ + \ \"name\": \"str\", # Optional. The name of the relationship end\n\ + \ definition.\n \"type\": \"str\" # Optional. The type\ + \ of the relationship end.\n },\n \"endDef2\": {\n \"cardinality\"\ + : \"str\", # Optional. single-valued attribute or\n multi-valued\ + \ attribute. Known values are: \"SINGLE\", \"LIST\", \"SET\".\n \"description\"\ + : \"str\", # Optional. The description of the\n relationship end\ + \ definition.\n \"isContainer\": bool, # Optional. Determines if it\ + \ is container.\n \"isLegacyAttribute\": bool, # Optional. Determines\ + \ if it is a legacy\n attribute.\n \"name\": \"str\", #\ + \ Optional. The name of the relationship end\n definition.\n \ + \ \"type\": \"str\" # Optional. The type of the relationship end.\n \ + \ },\n \"entityTypes\": [\n \"str\" # Optional. Specifying\ + \ a list of entityType names in the\n classificationDef, ensures that\ + \ classifications can\"nonly be applied to those\n entityTypes.\"\ + n\"n\"n.. raw:: html\"n\"n

    \"n
  • Any subtypes of the entity\n \ + \ types inherit the restriction
  • \"n
  • Any classificationDef subtypes\n\ + \ inherit the parents entityTypes restrictions
  • \"n
  • Any\n\ + \ classificationDef subtypes can further restrict the parents entityTypes\n\ + \ restrictions by specifying a subset of the entityTypes
  • \"n \ + \
  • An empty\n entityTypes list when there are no parent restrictions\ + \ means there are no\n restrictions
  • \"n
  • An empty entityTypes\ + \ list when there are parent\n restrictions means that the subtype\ + \ picks up the parents restrictions
  • \"n\n
  • If a list of entityTypes\ + \ are supplied, where one inherits from another,\n this will be rejected.\ + \ This should encourage cleaner\n classificationsDefs
  • \"n
.\n\ + \ ],\n \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency control.\n\ + \ \"name\": \"str\", # Optional. The name of the type definition.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options for\ + \ the type definition.\n },\n \"relationshipAttributeDefs\": [\n \ + \ {\n \"cardinality\": \"str\", # Optional. single-valued\ + \ attribute or\n multi-valued attribute. Known values are: \"\ + SINGLE\", \"LIST\", \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \"\ + str\": {} # Optional. The parameters\n of the constraint\ + \ definition.\n },\n \"type\": \"\ + str\" # Optional. The type of the\n constraint.\n \ + \ }\n ],\n \"defaultValue\": \"str\"\ + , # Optional. The default value of the\n attribute.\n \ + \ \"description\": \"str\", # Optional. The description of the\n \ + \ attribute.\n \"includeInNotification\": bool, # Optional.\ + \ Determines if it\n is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines if it is\n \ + \ indexable.\n \"isLegacyAttribute\": bool, # Optional. Determines\ + \ if it is a\n legacy attribute.\n \"isOptional\"\ + : bool, # Optional. Determines if it is\n optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if it unique.\n \ + \ \"name\": \"str\", # Optional. The name of the attribute.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional. The options\ + \ for the\n attribute.\n },\n \ + \ \"relationshipTypeName\": \"str\", # Optional. The name of the\n \ + \ relationship type.\n \"typeName\": \"str\", # Optional.\ + \ The name of the type.\n \"valuesMaxCount\": 0, # Optional. The\ + \ maximum count of the\n values.\n \"valuesMinCount\"\ + : 0 # Optional. The minimum count of the\n values.\n \ + \ }\n ],\n \"relationshipCategory\": \"str\", # Optional. The Relationship\ + \ category\n determines the style of relationship around containment and\ + \ lifecycle.\"nUML\n terminology is used for the values.\"n\"n:code:`

`\"\ + nASSOCIATION is a relationship\n with no containment. :code:`
`\"nCOMPOSITION\ + \ and AGGREGATION are containment\n relationships.\"n\"n:code:`

`\"\ + nThe difference being in the lifecycles of the\n container and its children.\ + \ In the COMPOSITION case,\"nthe children cannot exist\n without the container.\ + \ For AGGREGATION, the life cycles\"nof the container and\n children are\ + \ totally independent. Known values are: \"ASSOCIATION\", \"AGGREGATION\",\n \ + \ \"COMPOSITION\".\n \"relationshipLabel\": \"str\", # Optional.\ + \ The label of the relationship.\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"subTypes\": [\n \"str\" # Optional. An\ + \ array of sub types.\n ],\n \"superTypes\": [\n \"str\"\ + \ # Optional. An array of super types.\n ],\n \"typeVersion\": \"\ + str\", # Optional. The version of the type.\n \"updateTime\": 0.0, # Optional.\ + \ The update time of the record.\n \"updatedBy\": \"str\", # Optional.\ + \ The user who updated the record.\n \"version\": 0.0 # Optional. The version\ + \ of the record.\n }\n ````\n" +- uid: azure.purview.catalog.operations.TypesOperations.list_type_definition_headers + name: list_type_definition_headers + summary: List all type definitions returned as a list of minimal information header. + signature: 'list_type_definition_headers(*, include_term_template: bool | None = + False, type: str | None = None, **kwargs: Any) -> List[MutableMapping[str, Any]]' + keywordOnlyParameters: + - name: include_term_template + description: 'Whether include termtemplatedef when return all typedefs. + + This is always true when search filter type=term_template. Default value is + False.' + types: + - + - name: type + description: 'Typedef name as search filter when get typedefs. Known values are: + "enum", + + "entity", "classification", "relationship", "struct", and "term_template". Default + value is + + None.' + types: + - + return: + description: list of JSON object + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # response body for status code(s): 200\n response.json() == [\n {\n\ + \ \"category\": \"str\", # Optional. The enum of type category. Known\n\ + \ values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\", \"STRUCT\"\ + ,\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"MAP\", \"RELATIONSHIP\"\ + , \"TERM_TEMPLATE\".\n \"guid\": \"str\", # Optional. The GUID of the\ + \ type definition.\n \"name\": \"str\" # Optional. The name of the\ + \ type definition.\n }\n ]\n ````\n" +- uid: azure.purview.catalog.operations.TypesOperations.update_atlas_type_definitions + name: update_atlas_type_definitions + summary: Update all types in bulk, changes detected in the type definitions would + be persisted. + signature: 'update_atlas_type_definitions(types_def: MutableMapping[str, Any], **kwargs: + Any) -> MutableMapping[str, Any]' + parameters: + - name: types_def + description: A composite object that captures all type definition changes. + isRequired: true + types: + - + return: + description: JSON object + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError + examples: + - "\n\n````python\n\n\ + \ # JSON input template you can fill out and use as your body input.\n types_def\ + \ = {\n \"businessMetadataDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"classificationDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + entityTypes\": [\n \"str\" # Optional. Specifying a list of\ + \ entityType\n names in the classificationDef, ensures that\ + \ classifications\n can\"nonly be applied to those entityTypes.\"\ + n\"n\"n.. raw:: html\"n\"n\n

    \"n
  • Any subtypes of\ + \ the entity types inherit the\n restriction
  • \"n
  • Any\ + \ classificationDef subtypes inherit the\n parents entityTypes\ + \ restrictions
  • \"n
  • Any classificationDef\n subtypes\ + \ can further restrict the parents entityTypes restrictions by\n \ + \ specifying a subset of the entityTypes
  • \"n
  • An empty\n \ + \ entityTypes list when there are no parent restrictions means\ + \ there\n are no restrictions
  • \"n
  • An empty entityTypes\ + \ list when there\n are parent restrictions means that the\ + \ subtype picks up the parents\n restrictions
  • \"n
  • If\ + \ a list of entityTypes are supplied,\n where one inherits\ + \ from another, this will be rejected. This should\n encourage\ + \ cleaner classificationsDefs
  • \"n
.\n ],\n \ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name\ + \ of the type definition.\n \"options\": {\n \"\ + str\": \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"subTypes\": [\n \"str\" #\ + \ Optional. An array of sub types.\n ],\n \"superTypes\"\ + : [\n \"str\" # Optional. An array of super types.\n \ + \ ],\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"entityDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"relationshipAttributeDefs\": [\n \ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isLegacyAttribute\"\ + : bool, # Optional.\n Determines if it is a legacy attribute.\n\ + \ \"isOptional\": bool, # Optional. Determines\n \ + \ if it is optional.\n \"isUnique\": bool,\ + \ # Optional. Determines if\n it unique.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"relationshipTypeName\": \"str\", # Optional.\n \ + \ The name of the relationship type.\n \"typeName\": \"\ + str\", # Optional. The name of\n the type.\n \ + \ \"valuesMaxCount\": 0, # Optional. The maximum\n \ + \ count of the values.\n \"valuesMinCount\"\ + : 0 # Optional. The minimum\n count of the values.\n\ + \ }\n ],\n \"serviceType\": \"str\"\ + , # Optional. The service type.\n \"subTypes\": [\n \ + \ \"str\" # Optional. An array of sub types.\n ],\n \ + \ \"superTypes\": [\n \"str\" # Optional. An array\ + \ of super types.\n ],\n \"typeVersion\": \"str\"\ + , # Optional. The version of the type.\n \"updateTime\": 0.0, \ + \ # Optional. The update time of the\n record.\n \ + \ \"updatedBy\": \"str\", # Optional. The user who updated the\n \ + \ record.\n \"version\": 0.0 # Optional. The version of the\ + \ record.\n }\n ],\n \"enumDefs\": [\n {\n \ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"defaultValue\": \"str\", # Optional.\ + \ The default value.\n \"description\": \"str\", # Optional. The\ + \ description of the\n type definition.\n \"elementDefs\"\ + : [\n {\n \"description\": \"str\", #\ + \ Optional. The\n description of the enum element definition.\n\ + \ \"ordinal\": 0.0, # Optional. The ordinal of\n \ + \ the enum element definition.\n \"value\"\ + : \"str\" # Optional. The value of the\n enum element\ + \ definition.\n }\n ],\n \"guid\"\ + : \"str\", # Optional. The GUID of the type definition.\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"name\": \"str\", # Optional. The name of the type definition.\n\ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options for the type\n definition.\n },\n\ + \ \"serviceType\": \"str\", # Optional. The service type.\n \ + \ \"typeVersion\": \"str\", # Optional. The version of the type.\n\ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the\n record.\n \"version\":\ + \ 0.0 # Optional. The version of the record.\n }\n ],\n \ + \ \"relationshipDefs\": [\n {\n \"attributeDefs\": [\n\ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isOptional\"\ + : bool, # Optional. Determines\n if it is optional.\n\ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", #\ + \ Optional. The name of the\n attribute.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options\n for the attribute.\n \ + \ },\n \"typeName\": \"str\", # Optional. The\ + \ name of\n the type.\n \"valuesMaxCount\"\ + : 0, # Optional. The maximum\n count of the values.\n\ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n \ + \ ],\n \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + endDef1\": {\n \"cardinality\": \"str\", # Optional. single-valued\n\ + \ attribute or multi-valued attribute. Known values are: \"\ + SINGLE\",\n \"LIST\", \"SET\".\n \"description\"\ + : \"str\", # Optional. The description of\n the relationship\ + \ end definition.\n \"isContainer\": bool, # Optional. Determines\ + \ if it is\n container.\n \"isLegacyAttribute\"\ + : bool, # Optional. Determines if\n it is a legacy attribute.\n\ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\"\ + \ # Optional. The type of the\n relationship end.\n \ + \ },\n \"endDef2\": {\n \"cardinality\"\ + : \"str\", # Optional. single-valued\n attribute or multi-valued\ + \ attribute. Known values are: \"SINGLE\",\n \"LIST\", \"\ + SET\".\n \"description\": \"str\", # Optional. The description\ + \ of\n the relationship end definition.\n \ + \ \"isContainer\": bool, # Optional. Determines if it is\n \ + \ container.\n \"isLegacyAttribute\": bool, # Optional.\ + \ Determines if\n it is a legacy attribute.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\" # Optional.\ + \ The type of the\n relationship end.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"name\": \"str\", # Optional. The\ + \ name of the type definition.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the type\n \ + \ definition.\n },\n \"relationshipCategory\"\ + : \"str\", # Optional. The Relationship\n category determines\ + \ the style of relationship around containment and\n lifecycle.\"\ + nUML terminology is used for the\n values.\"n\"n:code:`

`\"\ + nASSOCIATION is a relationship with no\n containment. :code:`
`\"\ + nCOMPOSITION and AGGREGATION are containment\n relationships.\"\ + n\"n:code:`

`\"nThe difference being in the lifecycles of\n \ + \ the container and its children. In the COMPOSITION case,\"nthe children\n \ + \ cannot exist without the container. For AGGREGATION, the life\ + \ cycles\"nof\n the container and children are totally independent.\ + \ Known values are:\n \"ASSOCIATION\", \"AGGREGATION\", \"COMPOSITION\"\ + .\n \"relationshipLabel\": \"str\", # Optional. The label of the\n\ + \ relationship.\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The\ + \ version of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the\n record.\n \"updatedBy\": \"str\"\ + , # Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n\ + \ ],\n \"structDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"termTemplateDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ]\n }\n\n # response body for status code(s): 200\n response.json()\ + \ == {\n \"businessMetadataDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"classificationDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + entityTypes\": [\n \"str\" # Optional. Specifying a list of\ + \ entityType\n names in the classificationDef, ensures that\ + \ classifications\n can\"nonly be applied to those entityTypes.\"\ + n\"n\"n.. raw:: html\"n\"n\n

    \"n
  • Any subtypes of\ + \ the entity types inherit the\n restriction
  • \"n
  • Any\ + \ classificationDef subtypes inherit the\n parents entityTypes\ + \ restrictions
  • \"n
  • Any classificationDef\n subtypes\ + \ can further restrict the parents entityTypes restrictions by\n \ + \ specifying a subset of the entityTypes
  • \"n
  • An empty\n \ + \ entityTypes list when there are no parent restrictions means\ + \ there\n are no restrictions
  • \"n
  • An empty entityTypes\ + \ list when there\n are parent restrictions means that the\ + \ subtype picks up the parents\n restrictions
  • \"n
  • If\ + \ a list of entityTypes are supplied,\n where one inherits\ + \ from another, this will be rejected. This should\n encourage\ + \ cleaner classificationsDefs
  • \"n
.\n ],\n \ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name\ + \ of the type definition.\n \"options\": {\n \"\ + str\": \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"subTypes\": [\n \"str\" #\ + \ Optional. An array of sub types.\n ],\n \"superTypes\"\ + : [\n \"str\" # Optional. An array of super types.\n \ + \ ],\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"entityDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"relationshipAttributeDefs\": [\n \ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isLegacyAttribute\"\ + : bool, # Optional.\n Determines if it is a legacy attribute.\n\ + \ \"isOptional\": bool, # Optional. Determines\n \ + \ if it is optional.\n \"isUnique\": bool,\ + \ # Optional. Determines if\n it unique.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ attribute.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"relationshipTypeName\": \"str\", # Optional.\n \ + \ The name of the relationship type.\n \"typeName\": \"\ + str\", # Optional. The name of\n the type.\n \ + \ \"valuesMaxCount\": 0, # Optional. The maximum\n \ + \ count of the values.\n \"valuesMinCount\"\ + : 0 # Optional. The minimum\n count of the values.\n\ + \ }\n ],\n \"serviceType\": \"str\"\ + , # Optional. The service type.\n \"subTypes\": [\n \ + \ \"str\" # Optional. An array of sub types.\n ],\n \ + \ \"superTypes\": [\n \"str\" # Optional. An array\ + \ of super types.\n ],\n \"typeVersion\": \"str\"\ + , # Optional. The version of the type.\n \"updateTime\": 0.0, \ + \ # Optional. The update time of the\n record.\n \ + \ \"updatedBy\": \"str\", # Optional. The user who updated the\n \ + \ record.\n \"version\": 0.0 # Optional. The version of the\ + \ record.\n }\n ],\n \"enumDefs\": [\n {\n \ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"defaultValue\": \"str\", # Optional.\ + \ The default value.\n \"description\": \"str\", # Optional. The\ + \ description of the\n type definition.\n \"elementDefs\"\ + : [\n {\n \"description\": \"str\", #\ + \ Optional. The\n description of the enum element definition.\n\ + \ \"ordinal\": 0.0, # Optional. The ordinal of\n \ + \ the enum element definition.\n \"value\"\ + : \"str\" # Optional. The value of the\n enum element\ + \ definition.\n }\n ],\n \"guid\"\ + : \"str\", # Optional. The GUID of the type definition.\n \"lastModifiedTS\"\ + : \"str\", # Optional. ETag for concurrency\n control.\n \ + \ \"name\": \"str\", # Optional. The name of the type definition.\n\ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options for the type\n definition.\n },\n\ + \ \"serviceType\": \"str\", # Optional. The service type.\n \ + \ \"typeVersion\": \"str\", # Optional. The version of the type.\n\ + \ \"updateTime\": 0.0, # Optional. The update time of the\n \ + \ record.\n \"updatedBy\": \"str\", # Optional. The\ + \ user who updated the\n record.\n \"version\":\ + \ 0.0 # Optional. The version of the record.\n }\n ],\n \ + \ \"relationshipDefs\": [\n {\n \"attributeDefs\": [\n\ + \ {\n \"cardinality\": \"str\", # Optional.\n\ + \ single-valued attribute or multi-valued attribute. Known\ + \ values\n are: \"SINGLE\", \"LIST\", \"SET\".\n \ + \ \"constraints\": [\n {\n \ + \ \"params\": {\n \"str\"\ + : {} #\n Optional. The parameters of the\ + \ constraint\n definition.\n \ + \ },\n \"type\": \"str\" # Optional.\n\ + \ The type of the constraint.\n \ + \ }\n ],\n \"defaultValue\"\ + : \"str\", # Optional. The\n default value of the attribute.\n\ + \ \"description\": \"str\", # Optional. The\n \ + \ description of the attribute.\n \"includeInNotification\"\ + : bool, # Optional.\n Determines if it is included in\ + \ notification.\n \"isIndexable\": bool, # Optional. Determines\n\ + \ if it is indexable.\n \"isOptional\"\ + : bool, # Optional. Determines\n if it is optional.\n\ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", #\ + \ Optional. The name of the\n attribute.\n \ + \ \"options\": {\n \"str\": \"str\" # Optional.\ + \ The options\n for the attribute.\n \ + \ },\n \"typeName\": \"str\", # Optional. The\ + \ name of\n the type.\n \"valuesMaxCount\"\ + : 0, # Optional. The maximum\n count of the values.\n\ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n \ + \ ],\n \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + endDef1\": {\n \"cardinality\": \"str\", # Optional. single-valued\n\ + \ attribute or multi-valued attribute. Known values are: \"\ + SINGLE\",\n \"LIST\", \"SET\".\n \"description\"\ + : \"str\", # Optional. The description of\n the relationship\ + \ end definition.\n \"isContainer\": bool, # Optional. Determines\ + \ if it is\n container.\n \"isLegacyAttribute\"\ + : bool, # Optional. Determines if\n it is a legacy attribute.\n\ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\"\ + \ # Optional. The type of the\n relationship end.\n \ + \ },\n \"endDef2\": {\n \"cardinality\"\ + : \"str\", # Optional. single-valued\n attribute or multi-valued\ + \ attribute. Known values are: \"SINGLE\",\n \"LIST\", \"\ + SET\".\n \"description\": \"str\", # Optional. The description\ + \ of\n the relationship end definition.\n \ + \ \"isContainer\": bool, # Optional. Determines if it is\n \ + \ container.\n \"isLegacyAttribute\": bool, # Optional.\ + \ Determines if\n it is a legacy attribute.\n \ + \ \"name\": \"str\", # Optional. The name of the\n \ + \ relationship end definition.\n \"type\": \"str\" # Optional.\ + \ The type of the\n relationship end.\n },\n\ + \ \"guid\": \"str\", # Optional. The GUID of the type definition.\n\ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n\ + \ control.\n \"name\": \"str\", # Optional. The\ + \ name of the type definition.\n \"options\": {\n \ + \ \"str\": \"str\" # Optional. The options for the type\n \ + \ definition.\n },\n \"relationshipCategory\"\ + : \"str\", # Optional. The Relationship\n category determines\ + \ the style of relationship around containment and\n lifecycle.\"\ + nUML terminology is used for the\n values.\"n\"n:code:`

`\"\ + nASSOCIATION is a relationship with no\n containment. :code:`
`\"\ + nCOMPOSITION and AGGREGATION are containment\n relationships.\"\ + n\"n:code:`

`\"nThe difference being in the lifecycles of\n \ + \ the container and its children. In the COMPOSITION case,\"nthe children\n \ + \ cannot exist without the container. For AGGREGATION, the life\ + \ cycles\"nof\n the container and children are totally independent.\ + \ Known values are:\n \"ASSOCIATION\", \"AGGREGATION\", \"COMPOSITION\"\ + .\n \"relationshipLabel\": \"str\", # Optional. The label of the\n\ + \ relationship.\n \"serviceType\": \"str\", # Optional.\ + \ The service type.\n \"typeVersion\": \"str\", # Optional. The\ + \ version of the type.\n \"updateTime\": 0.0, # Optional. The update\ + \ time of the\n record.\n \"updatedBy\": \"str\"\ + , # Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n\ + \ ],\n \"structDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ],\n \"termTemplateDefs\": [\n {\n \"attributeDefs\"\ + : [\n {\n \"cardinality\": \"str\", #\ + \ Optional.\n single-valued attribute or multi-valued\ + \ attribute. Known values\n are: \"SINGLE\", \"LIST\"\ + , \"SET\".\n \"constraints\": [\n \ + \ {\n \"params\": {\n \ + \ \"str\": {} #\n Optional. The\ + \ parameters of the constraint\n definition.\n\ + \ },\n \"type\": \"\ + str\" # Optional.\n The type of the constraint.\n\ + \ }\n ],\n \ + \ \"defaultValue\": \"str\", # Optional. The\n default\ + \ value of the attribute.\n \"description\": \"str\", #\ + \ Optional. The\n description of the attribute.\n \ + \ \"includeInNotification\": bool, # Optional.\n \ + \ Determines if it is included in notification.\n \ + \ \"isIndexable\": bool, # Optional. Determines\n \ + \ if it is indexable.\n \"isOptional\": bool, # Optional.\ + \ Determines\n if it is optional.\n \ + \ \"isUnique\": bool, # Optional. Determines if\n \ + \ it unique.\n \"name\": \"str\", # Optional. The name\ + \ of the\n attribute.\n \"options\"\ + : {\n \"str\": \"str\" # Optional. The options\n \ + \ for the attribute.\n },\n \ + \ \"typeName\": \"str\", # Optional. The name of\n \ + \ the type.\n \"valuesMaxCount\": 0, \ + \ # Optional. The maximum\n count of the values.\n \ + \ \"valuesMinCount\": 0 # Optional. The minimum\n \ + \ count of the values.\n }\n ],\n\ + \ \"category\": \"str\", # Optional. The enum of type category.\n\ + \ Known values are: \"PRIMITIVE\", \"OBJECT_ID_TYPE\", \"ENUM\"\ + , \"STRUCT\",\n \"CLASSIFICATION\", \"ENTITY\", \"ARRAY\", \"\ + MAP\", \"RELATIONSHIP\",\n \"TERM_TEMPLATE\".\n \ + \ \"createTime\": 0.0, # Optional. The created time of the\n \ + \ record.\n \"createdBy\": \"str\", # Optional. The user who created\ + \ the\n record.\n \"dateFormatter\": {\n \ + \ \"availableLocales\": [\n \"str\" # Optional.\ + \ An array of available\n locales.\n \ + \ ],\n \"calendar\": 0.0, # Optional. The date format.\n \ + \ \"dateInstance\": ...,\n \"dateTimeInstance\"\ + : ...,\n \"instance\": ...,\n \"lenient\"\ + : bool, # Optional. Determines the leniency\n of the date\ + \ format.\n \"numberFormat\": {\n \"availableLocales\"\ + : [\n \"str\" # Optional. The number format.\n \ + \ ],\n \"currency\": \"str\", # Optional.\ + \ The currency.\n \"currencyInstance\": ...,\n \ + \ \"groupingUsed\": bool, # Optional. Determines\n \ + \ if grouping is used.\n \"instance\": ...,\n\ + \ \"integerInstance\": ...,\n \"maximumFractionDigits\"\ + : 0, # Optional. The\n maximum of fraction digits.\n\ + \ \"maximumIntegerDigits\": 0, # Optional. The\n \ + \ maximum of integer digits.\n \"minimumFractionDigits\"\ + : 0, # Optional. The\n minimum of fraction digits.\n\ + \ \"minimumIntegerDigits\": 0, # Optional. The\n \ + \ minimum of integer digits.\n \"numberInstance\"\ + : ...,\n \"parseIntegerOnly\": bool, # Optional.\n \ + \ Determines if only integer is parsed.\n \ + \ \"percentInstance\": ...,\n \"roundingMode\": \"\ + str\" # Optional. The enum\n of rounding mode. Known\ + \ values are: \"UP\", \"DOWN\", \"CEILING\",\n \"FLOOR\"\ + , \"HALF_UP\", \"HALF_DOWN\", \"HALF_EVEN\", \"UNNECESSARY\".\n \ + \ },\n \"timeInstance\": ...,\n \"timeZone\"\ + : {\n \"availableIds\": [\n \"\ + str\" # Optional. An array of\n available IDs.\n\ + \ ],\n \"default\": ...,\n \ + \ \"displayName\": \"str\", # Optional. The\n \ + \ display name of the timezone.\n \"dstSavings\"\ + : 0, # Optional. The value of\n the daylight saving time.\n\ + \ \"id\": \"str\", # Optional. The ID of the\n \ + \ timezone.\n \"rawOffset\": 0 # Optional.\ + \ The raw offset of\n the timezone.\n \ + \ }\n },\n \"description\": \"str\", # Optional.\ + \ The description of the\n type definition.\n \"\ + guid\": \"str\", # Optional. The GUID of the type definition.\n \ + \ \"lastModifiedTS\": \"str\", # Optional. ETag for concurrency\n \ + \ control.\n \"name\": \"str\", # Optional. The name of the\ + \ type definition.\n \"options\": {\n \"str\"\ + : \"str\" # Optional. The options for the type\n definition.\n\ + \ },\n \"serviceType\": \"str\", # Optional. The\ + \ service type.\n \"typeVersion\": \"str\", # Optional. The version\ + \ of the type.\n \"updateTime\": 0.0, # Optional. The update time\ + \ of the\n record.\n \"updatedBy\": \"str\", #\ + \ Optional. The user who updated the\n record.\n \ + \ \"version\": 0.0 # Optional. The version of the record.\n }\n \ + \ ]\n }\n ````\n" diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.yml new file mode 100644 index 00000000..6c4e55c6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.purview.catalog.operations +name: operations +fullName: azure.purview.catalog.operations +type: import +classes: +- azure.purview.catalog.operations.CollectionOperations +- azure.purview.catalog.operations.DiscoveryOperations +- azure.purview.catalog.operations.EntityOperations +- azure.purview.catalog.operations.GlossaryOperations +- azure.purview.catalog.operations.LineageOperations +- azure.purview.catalog.operations.RelationshipOperations +- azure.purview.catalog.operations.TypesOperations diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.yml new file mode 100644 index 00000000..fd2a1912 --- /dev/null +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonPackage +uid: azure.purview.catalog +name: catalog +fullName: azure.purview.catalog +type: rootImport +classes: +- azure.purview.catalog.PurviewCatalogClient +packages: +- azure.purview.catalog.aio +- azure.purview.catalog.operations diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.constants.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.constants.yml new file mode 100644 index 00000000..33a3a5fc --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.constants.yml @@ -0,0 +1,4 @@ +### YamlMime:PythonModule +uid: azure.servicemanagement.constants +name: constants +fullName: azure.servicemanagement.constants diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AdditionalUnattendContent.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AdditionalUnattendContent.yml new file mode 100644 index 00000000..6f5d8a76 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AdditionalUnattendContent.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.AdditionalUnattendContent +name: AdditionalUnattendContent +fullName: azure.servicemanagement.models.AdditionalUnattendContent +module: azure.servicemanagement.models +constructor: + syntax: AdditionalUnattendContent() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AffinityGroup.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AffinityGroup.yml new file mode 100644 index 00000000..e2fa8845 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AffinityGroup.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.AffinityGroup +name: AffinityGroup +fullName: azure.servicemanagement.models.AffinityGroup +module: azure.servicemanagement.models +constructor: + syntax: AffinityGroup() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AffinityGroups.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AffinityGroups.yml new file mode 100644 index 00000000..9a3c3c26 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AffinityGroups.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.AffinityGroups +name: AffinityGroups +fullName: azure.servicemanagement.models.AffinityGroups +module: azure.servicemanagement.models +constructor: + syntax: AffinityGroups() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AsynchronousOperationResult.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AsynchronousOperationResult.yml new file mode 100644 index 00000000..0418751b --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AsynchronousOperationResult.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.AsynchronousOperationResult +name: AsynchronousOperationResult +fullName: azure.servicemanagement.models.AsynchronousOperationResult +module: azure.servicemanagement.models +constructor: + syntax: AsynchronousOperationResult(request_id=None) + parameters: + - name: request_id + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AttachedTo.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AttachedTo.yml new file mode 100644 index 00000000..a0feac34 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AttachedTo.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.AttachedTo +name: AttachedTo +fullName: azure.servicemanagement.models.AttachedTo +module: azure.servicemanagement.models +constructor: + syntax: AttachedTo() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AuthorizationRule.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AuthorizationRule.yml new file mode 100644 index 00000000..b4018a29 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AuthorizationRule.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.AuthorizationRule +name: AuthorizationRule +fullName: azure.servicemanagement.models.AuthorizationRule +module: azure.servicemanagement.models +constructor: + syntax: AuthorizationRule() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AuthorizationRules.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AuthorizationRules.yml new file mode 100644 index 00000000..7e9e9bed --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AuthorizationRules.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.AuthorizationRules +name: AuthorizationRules +fullName: azure.servicemanagement.models.AuthorizationRules +module: azure.servicemanagement.models +constructor: + syntax: AuthorizationRules() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AvailabilityResponse.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AvailabilityResponse.yml new file mode 100644 index 00000000..5547ad94 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AvailabilityResponse.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.AvailabilityResponse +name: AvailabilityResponse +fullName: azure.servicemanagement.models.AvailabilityResponse +module: azure.servicemanagement.models +constructor: + syntax: AvailabilityResponse() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AzureAsyncOperationHttpError.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AzureAsyncOperationHttpError.yml new file mode 100644 index 00000000..f154cebf --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.AzureAsyncOperationHttpError.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.AzureAsyncOperationHttpError +name: AzureAsyncOperationHttpError +fullName: azure.servicemanagement.models.AzureAsyncOperationHttpError +module: azure.servicemanagement.models +summary: Indicates that a batch operation failed +constructor: + syntax: AzureAsyncOperationHttpError(message, status_code, *args, **kwargs) + parameters: + - name: message + isRequired: true + - name: status_code + isRequired: true + - name: result + isRequired: true +methods: +- uid: azure.servicemanagement.models.AzureAsyncOperationHttpError.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.servicemanagement.models.AzureAsyncOperationHttpError.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.servicemanagement.models.AzureAsyncOperationHttpError.args + name: args diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CaptureRoleAsVMImage.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CaptureRoleAsVMImage.yml new file mode 100644 index 00000000..504a5dc0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CaptureRoleAsVMImage.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.CaptureRoleAsVMImage +name: CaptureRoleAsVMImage +fullName: azure.servicemanagement.models.CaptureRoleAsVMImage +module: azure.servicemanagement.models +constructor: + syntax: CaptureRoleAsVMImage(os_state=None, vm_image_name=None, vm_image_label=None, + description=None, language=None, image_family=None, recommended_vm_size=None) + parameters: + - name: os_state + defaultValue: None + - name: vm_image_name + defaultValue: None + - name: vm_image_label + defaultValue: None + - name: description + defaultValue: None + - name: language + defaultValue: None + - name: image_family + defaultValue: None + - name: recommended_vm_size + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Certificate.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Certificate.yml new file mode 100644 index 00000000..21077df7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Certificate.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Certificate +name: Certificate +fullName: azure.servicemanagement.models.Certificate +module: azure.servicemanagement.models +constructor: + syntax: Certificate() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CertificateSetting.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CertificateSetting.yml new file mode 100644 index 00000000..98c89792 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CertificateSetting.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.CertificateSetting +name: CertificateSetting +fullName: azure.servicemanagement.models.CertificateSetting +module: azure.servicemanagement.models +summary: "Initializes a certificate setting.\n\nthumbprint:\n Specifies the thumbprint\ + \ of the certificate to be provisioned. The\n thumbprint must specify an existing\ + \ service certificate.\n\nstore_name:\n Specifies the name of the certificate\ + \ store from which retrieve\n certificate.\n\nstore_location:\n Specifies the\ + \ target certificate store location on the virtual machine.\n The only supported\ + \ value is LocalMachine." +constructor: + syntax: CertificateSetting(thumbprint='', store_name='', store_location='') + parameters: + - name: thumbprint + - name: store_name + - name: store_location diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Certificates.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Certificates.yml new file mode 100644 index 00000000..41673a88 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Certificates.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Certificates +name: Certificates +fullName: azure.servicemanagement.models.Certificates +module: azure.servicemanagement.models +constructor: + syntax: Certificates() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CloudService.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CloudService.yml new file mode 100644 index 00000000..17367615 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CloudService.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.CloudService +name: CloudService +fullName: azure.servicemanagement.models.CloudService +module: azure.servicemanagement.models +constructor: + syntax: CloudService() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CloudServices.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CloudServices.yml new file mode 100644 index 00000000..811ff318 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CloudServices.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.CloudServices +name: CloudServices +fullName: azure.servicemanagement.models.CloudServices +module: azure.servicemanagement.models +constructor: + syntax: CloudServices() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ComponentSetting.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ComponentSetting.yml new file mode 100644 index 00000000..35c7ac73 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ComponentSetting.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.ComponentSetting +name: ComponentSetting +fullName: azure.servicemanagement.models.ComponentSetting +module: azure.servicemanagement.models +constructor: + syntax: ComponentSetting() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ComponentSettings.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ComponentSettings.yml new file mode 100644 index 00000000..89378442 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ComponentSettings.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.ComponentSettings +name: ComponentSettings +fullName: azure.servicemanagement.models.ComponentSettings +module: azure.servicemanagement.models +constructor: + syntax: ComponentSettings() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Components.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Components.yml new file mode 100644 index 00000000..af527a9d --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Components.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Components +name: Components +fullName: azure.servicemanagement.models.Components +module: azure.servicemanagement.models +constructor: + syntax: Components() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ComputeCapabilities.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ComputeCapabilities.yml new file mode 100644 index 00000000..13942f3a --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ComputeCapabilities.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.ComputeCapabilities +name: ComputeCapabilities +fullName: azure.servicemanagement.models.ComputeCapabilities +module: azure.servicemanagement.models +constructor: + syntax: ComputeCapabilities() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ConfigurationSet.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ConfigurationSet.yml new file mode 100644 index 00000000..52915791 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ConfigurationSet.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.ConfigurationSet +name: ConfigurationSet +fullName: azure.servicemanagement.models.ConfigurationSet +module: azure.servicemanagement.models +constructor: + syntax: ConfigurationSet() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ConfigurationSetInputEndpoint.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ConfigurationSetInputEndpoint.yml new file mode 100644 index 00000000..ce124e30 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ConfigurationSetInputEndpoint.yml @@ -0,0 +1,29 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.ConfigurationSetInputEndpoint +name: ConfigurationSetInputEndpoint +fullName: azure.servicemanagement.models.ConfigurationSetInputEndpoint +module: azure.servicemanagement.models +summary: "Initializes a network configuration input endpoint.\n\nname:\n Specifies\ + \ the name for the external endpoint.\n\nprotocol:\n Specifies the protocol to\ + \ use to inspect the virtual machine\n availability status. Possible values are:\ + \ HTTP, TCP.\n\nport:\n Specifies the external port to use for the endpoint.\n\ + \nlocal_port:\n Specifies the internal port on which the virtual machine is listening\n\ + \ to serve the endpoint.\n\nload_balanced_endpoint_set_name:\n Specifies a name\ + \ for a set of load-balanced endpoints. Specifying this\n element for a given\ + \ endpoint adds it to the set. If you are setting an\n endpoint to use to connect\ + \ to the virtual machine via the Remote\n Desktop, do not set this property.\n\ + \nenable_direct_server_return:\n Specifies whether direct server return load balancing\ + \ is enabled." +constructor: + syntax: ConfigurationSetInputEndpoint(name='', protocol='', port='', local_port='', + load_balanced_endpoint_set_name='', enable_direct_server_return=False, idle_timeout_in_minutes=4) + parameters: + - name: name + - name: protocol + - name: port + - name: local_port + - name: load_balanced_endpoint_set_name + - name: enable_direct_server_return + defaultValue: 'False' + - name: idle_timeout_in_minutes + defaultValue: '4' diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ConfigurationSetInputEndpoints.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ConfigurationSetInputEndpoints.yml new file mode 100644 index 00000000..c3989aed --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ConfigurationSetInputEndpoints.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.ConfigurationSetInputEndpoints +name: ConfigurationSetInputEndpoints +fullName: azure.servicemanagement.models.ConfigurationSetInputEndpoints +module: azure.servicemanagement.models +constructor: + syntax: ConfigurationSetInputEndpoints() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ConfigurationSets.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ConfigurationSets.yml new file mode 100644 index 00000000..e5f649a0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ConfigurationSets.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.ConfigurationSets +name: ConfigurationSets +fullName: azure.servicemanagement.models.ConfigurationSets +module: azure.servicemanagement.models +constructor: + syntax: ConfigurationSets() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CountDetails.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CountDetails.yml new file mode 100644 index 00000000..46bfb799 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CountDetails.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.CountDetails +name: CountDetails +fullName: azure.servicemanagement.models.CountDetails +module: azure.servicemanagement.models +constructor: + syntax: CountDetails() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CreateServerResponse.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CreateServerResponse.yml new file mode 100644 index 00000000..321ce308 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.CreateServerResponse.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.CreateServerResponse +name: CreateServerResponse +fullName: azure.servicemanagement.models.CreateServerResponse +module: azure.servicemanagement.models +constructor: + syntax: CreateServerResponse() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Credentials.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Credentials.yml new file mode 100644 index 00000000..906ce11b --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Credentials.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Credentials +name: Credentials +fullName: azure.servicemanagement.models.Credentials +module: azure.servicemanagement.models +constructor: + syntax: Credentials() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Data.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Data.yml new file mode 100644 index 00000000..ad58f21e --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Data.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Data +name: Data +fullName: azure.servicemanagement.models.Data +module: azure.servicemanagement.models +constructor: + syntax: Data() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DataDiskConfiguration.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DataDiskConfiguration.yml new file mode 100644 index 00000000..b57fde13 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DataDiskConfiguration.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.DataDiskConfiguration +name: DataDiskConfiguration +fullName: azure.servicemanagement.models.DataDiskConfiguration +module: azure.servicemanagement.models +constructor: + syntax: DataDiskConfiguration() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DataDiskConfigurations.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DataDiskConfigurations.yml new file mode 100644 index 00000000..fc0fec42 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DataDiskConfigurations.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.DataDiskConfigurations +name: DataDiskConfigurations +fullName: azure.servicemanagement.models.DataDiskConfigurations +module: azure.servicemanagement.models +constructor: + syntax: DataDiskConfigurations() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DataVirtualHardDisk.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DataVirtualHardDisk.yml new file mode 100644 index 00000000..8907e092 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DataVirtualHardDisk.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.DataVirtualHardDisk +name: DataVirtualHardDisk +fullName: azure.servicemanagement.models.DataVirtualHardDisk +module: azure.servicemanagement.models +constructor: + syntax: DataVirtualHardDisk(media_link='', host_caching=None, disk_label='', disk_name='', + lun=0, logical_disk_size_in_gb=0, source_media_link=None) + parameters: + - name: media_link + - name: host_caching + defaultValue: None + - name: disk_label + - name: disk_name + - name: lun + defaultValue: '0' + - name: logical_disk_size_in_gb + defaultValue: '0' + - name: source_media_link + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DataVirtualHardDisks.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DataVirtualHardDisks.yml new file mode 100644 index 00000000..1600a7cd --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DataVirtualHardDisks.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.DataVirtualHardDisks +name: DataVirtualHardDisks +fullName: azure.servicemanagement.models.DataVirtualHardDisks +module: azure.servicemanagement.models +constructor: + syntax: DataVirtualHardDisks() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Database.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Database.yml new file mode 100644 index 00000000..54704cc4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Database.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Database +name: Database +fullName: azure.servicemanagement.models.Database +module: azure.servicemanagement.models +constructor: + syntax: Database() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Deployment.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Deployment.yml new file mode 100644 index 00000000..502dc6d8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Deployment.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Deployment +name: Deployment +fullName: azure.servicemanagement.models.Deployment +module: azure.servicemanagement.models +constructor: + syntax: Deployment() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Deployments.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Deployments.yml new file mode 100644 index 00000000..9ed03b98 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Deployments.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Deployments +name: Deployments +fullName: azure.servicemanagement.models.Deployments +module: azure.servicemanagement.models +constructor: + syntax: Deployments() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Disk.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Disk.yml new file mode 100644 index 00000000..4542e09d --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Disk.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Disk +name: Disk +fullName: azure.servicemanagement.models.Disk +module: azure.servicemanagement.models +constructor: + syntax: Disk() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Disks.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Disks.yml new file mode 100644 index 00000000..558c0209 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Disks.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Disks +name: Disks +fullName: azure.servicemanagement.models.Disks +module: azure.servicemanagement.models +constructor: + syntax: Disks() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DnsServer.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DnsServer.yml new file mode 100644 index 00000000..138845bf --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DnsServer.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.DnsServer +name: DnsServer +fullName: azure.servicemanagement.models.DnsServer +module: azure.servicemanagement.models +constructor: + syntax: DnsServer() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DomainJoin.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DomainJoin.yml new file mode 100644 index 00000000..6fce58b2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.DomainJoin.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.DomainJoin +name: DomainJoin +fullName: azure.servicemanagement.models.DomainJoin +module: azure.servicemanagement.models +constructor: + syntax: DomainJoin() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.EventLog.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.EventLog.yml new file mode 100644 index 00000000..7547509c --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.EventLog.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.EventLog +name: EventLog +fullName: azure.servicemanagement.models.EventLog +module: azure.servicemanagement.models +constructor: + syntax: EventLog() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.FirewallRule.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.FirewallRule.yml new file mode 100644 index 00000000..b0d0ff37 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.FirewallRule.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.FirewallRule +name: FirewallRule +fullName: azure.servicemanagement.models.FirewallRule +module: azure.servicemanagement.models +constructor: + syntax: FirewallRule() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.HostNameSslState.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.HostNameSslState.yml new file mode 100644 index 00000000..79848e0b --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.HostNameSslState.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.HostNameSslState +name: HostNameSslState +fullName: azure.servicemanagement.models.HostNameSslState +module: azure.servicemanagement.models +constructor: + syntax: HostNameSslState() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.HostNameSslStates.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.HostNameSslStates.yml new file mode 100644 index 00000000..2374dd03 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.HostNameSslStates.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.HostNameSslStates +name: HostNameSslStates +fullName: azure.servicemanagement.models.HostNameSslStates +module: azure.servicemanagement.models +constructor: + syntax: HostNameSslStates() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.HostedService.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.HostedService.yml new file mode 100644 index 00000000..eb835c65 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.HostedService.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.HostedService +name: HostedService +fullName: azure.servicemanagement.models.HostedService +module: azure.servicemanagement.models +constructor: + syntax: HostedService() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.HostedServiceProperties.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.HostedServiceProperties.yml new file mode 100644 index 00000000..6a5406ac --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.HostedServiceProperties.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.HostedServiceProperties +name: HostedServiceProperties +fullName: azure.servicemanagement.models.HostedServiceProperties +module: azure.servicemanagement.models +constructor: + syntax: HostedServiceProperties() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.HostedServices.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.HostedServices.yml new file mode 100644 index 00000000..18c2aacd --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.HostedServices.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.HostedServices +name: HostedServices +fullName: azure.servicemanagement.models.HostedServices +module: azure.servicemanagement.models +constructor: + syntax: HostedServices() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Images.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Images.yml new file mode 100644 index 00000000..410fdf8c --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Images.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Images +name: Images +fullName: azure.servicemanagement.models.Images +module: azure.servicemanagement.models +constructor: + syntax: Images() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.InputEndpoint.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.InputEndpoint.yml new file mode 100644 index 00000000..dc0e36b0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.InputEndpoint.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.InputEndpoint +name: InputEndpoint +fullName: azure.servicemanagement.models.InputEndpoint +module: azure.servicemanagement.models +constructor: + syntax: InputEndpoint() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.InputEndpoints.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.InputEndpoints.yml new file mode 100644 index 00000000..ae549bdf --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.InputEndpoints.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.InputEndpoints +name: InputEndpoints +fullName: azure.servicemanagement.models.InputEndpoints +module: azure.servicemanagement.models +constructor: + syntax: InputEndpoints() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.InstanceEndpoint.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.InstanceEndpoint.yml new file mode 100644 index 00000000..36dc023e --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.InstanceEndpoint.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.InstanceEndpoint +name: InstanceEndpoint +fullName: azure.servicemanagement.models.InstanceEndpoint +module: azure.servicemanagement.models +constructor: + syntax: InstanceEndpoint() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.InstanceEndpoints.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.InstanceEndpoints.yml new file mode 100644 index 00000000..441b8441 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.InstanceEndpoints.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.InstanceEndpoints +name: InstanceEndpoints +fullName: azure.servicemanagement.models.InstanceEndpoints +module: azure.servicemanagement.models +constructor: + syntax: InstanceEndpoints() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.IntrinsicSettings.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.IntrinsicSettings.yml new file mode 100644 index 00000000..6d4c0a23 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.IntrinsicSettings.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.IntrinsicSettings +name: IntrinsicSettings +fullName: azure.servicemanagement.models.IntrinsicSettings +module: azure.servicemanagement.models +constructor: + syntax: IntrinsicSettings() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.KeyPair.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.KeyPair.yml new file mode 100644 index 00000000..52d2d7ee --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.KeyPair.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.KeyPair +name: KeyPair +fullName: azure.servicemanagement.models.KeyPair +module: azure.servicemanagement.models +constructor: + syntax: KeyPair(fingerprint='', path='') + parameters: + - name: fingerprint + - name: path diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.KeyPairs.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.KeyPairs.yml new file mode 100644 index 00000000..bf37ab61 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.KeyPairs.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.KeyPairs +name: KeyPairs +fullName: azure.servicemanagement.models.KeyPairs +module: azure.servicemanagement.models +constructor: + syntax: KeyPairs() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.LinuxConfigurationSet.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.LinuxConfigurationSet.yml new file mode 100644 index 00000000..6cb90100 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.LinuxConfigurationSet.yml @@ -0,0 +1,19 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.LinuxConfigurationSet +name: LinuxConfigurationSet +fullName: azure.servicemanagement.models.LinuxConfigurationSet +module: azure.servicemanagement.models +constructor: + syntax: LinuxConfigurationSet(host_name=None, user_name=None, user_password=None, + disable_ssh_password_authentication=None, custom_data=None) + parameters: + - name: host_name + defaultValue: None + - name: user_name + defaultValue: None + - name: user_password + defaultValue: None + - name: disable_ssh_password_authentication + defaultValue: None + - name: custom_data + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Listener.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Listener.yml new file mode 100644 index 00000000..53ad9d6c --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Listener.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Listener +name: Listener +fullName: azure.servicemanagement.models.Listener +module: azure.servicemanagement.models +summary: "Specifies the protocol and certificate information for the listener.\n\n\ + protocol:\n Specifies the protocol of listener. Possible values are: Http, Https.\n\ + \ The value is case sensitive.\n\ncertificate_thumbprint:\n Optional. Specifies\ + \ the certificate thumbprint for the secure\n connection. If this value is not\ + \ specified, a self-signed certificate is\n generated and used for the Virtual\ + \ Machine." +constructor: + syntax: Listener(protocol='', certificate_thumbprint='') + parameters: + - name: protocol + - name: certificate_thumbprint diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Listeners.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Listeners.yml new file mode 100644 index 00000000..305c8421 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Listeners.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Listeners +name: Listeners +fullName: azure.servicemanagement.models.Listeners +module: azure.servicemanagement.models +constructor: + syntax: Listeners() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.LoadBalancerProbe.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.LoadBalancerProbe.yml new file mode 100644 index 00000000..449050ea --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.LoadBalancerProbe.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.LoadBalancerProbe +name: LoadBalancerProbe +fullName: azure.servicemanagement.models.LoadBalancerProbe +module: azure.servicemanagement.models +constructor: + syntax: LoadBalancerProbe() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Location.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Location.yml new file mode 100644 index 00000000..e61b688d --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Location.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Location +name: Location +fullName: azure.servicemanagement.models.Location +module: azure.servicemanagement.models +constructor: + syntax: Location() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Locations.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Locations.yml new file mode 100644 index 00000000..35dbaa1c --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Locations.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Locations +name: Locations +fullName: azure.servicemanagement.models.Locations +module: azure.servicemanagement.models +constructor: + syntax: Locations() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MaxRecurrence.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MaxRecurrence.yml new file mode 100644 index 00000000..6f3dac52 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MaxRecurrence.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.MaxRecurrence +name: MaxRecurrence +fullName: azure.servicemanagement.models.MaxRecurrence +module: azure.servicemanagement.models +constructor: + syntax: MaxRecurrence() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricAvailabilities.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricAvailabilities.yml new file mode 100644 index 00000000..c060dc33 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricAvailabilities.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.MetricAvailabilities +name: MetricAvailabilities +fullName: azure.servicemanagement.models.MetricAvailabilities +module: azure.servicemanagement.models +constructor: + syntax: MetricAvailabilities() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricAvailability.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricAvailability.yml new file mode 100644 index 00000000..47c27d11 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricAvailability.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.MetricAvailability +name: MetricAvailability +fullName: azure.servicemanagement.models.MetricAvailability +module: azure.servicemanagement.models +constructor: + syntax: MetricAvailability() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricDefinition.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricDefinition.yml new file mode 100644 index 00000000..a640c37f --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricDefinition.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.MetricDefinition +name: MetricDefinition +fullName: azure.servicemanagement.models.MetricDefinition +module: azure.servicemanagement.models +constructor: + syntax: MetricDefinition() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricDefinitions.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricDefinitions.yml new file mode 100644 index 00000000..d15a1b02 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricDefinitions.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.MetricDefinitions +name: MetricDefinitions +fullName: azure.servicemanagement.models.MetricDefinitions +module: azure.servicemanagement.models +constructor: + syntax: MetricDefinitions() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricProperties.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricProperties.yml new file mode 100644 index 00000000..59ff1f72 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricProperties.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.MetricProperties +name: MetricProperties +fullName: azure.servicemanagement.models.MetricProperties +module: azure.servicemanagement.models +constructor: + syntax: MetricProperties() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricResponse.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricResponse.yml new file mode 100644 index 00000000..48e8da28 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricResponse.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.MetricResponse +name: MetricResponse +fullName: azure.servicemanagement.models.MetricResponse +module: azure.servicemanagement.models +constructor: + syntax: MetricResponse() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricResponses.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricResponses.yml new file mode 100644 index 00000000..fe9f44b6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricResponses.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.MetricResponses +name: MetricResponses +fullName: azure.servicemanagement.models.MetricResponses +module: azure.servicemanagement.models +constructor: + syntax: MetricResponses() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricRollups.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricRollups.yml new file mode 100644 index 00000000..796da135 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricRollups.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.MetricRollups +name: MetricRollups +fullName: azure.servicemanagement.models.MetricRollups +module: azure.servicemanagement.models +constructor: + syntax: MetricRollups() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricSample.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricSample.yml new file mode 100644 index 00000000..083dc4b2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricSample.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.MetricSample +name: MetricSample +fullName: azure.servicemanagement.models.MetricSample +module: azure.servicemanagement.models +constructor: + syntax: MetricSample() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricValues.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricValues.yml new file mode 100644 index 00000000..9839fbb1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.MetricValues.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.MetricValues +name: MetricValues +fullName: azure.servicemanagement.models.MetricValues +module: azure.servicemanagement.models +constructor: + syntax: MetricValues() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.NotificationHubDescription.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.NotificationHubDescription.yml new file mode 100644 index 00000000..db69b8a8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.NotificationHubDescription.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.NotificationHubDescription +name: NotificationHubDescription +fullName: azure.servicemanagement.models.NotificationHubDescription +module: azure.servicemanagement.models +constructor: + syntax: NotificationHubDescription() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OSDiskConfiguration.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OSDiskConfiguration.yml new file mode 100644 index 00000000..1b371a93 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OSDiskConfiguration.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.OSDiskConfiguration +name: OSDiskConfiguration +fullName: azure.servicemanagement.models.OSDiskConfiguration +module: azure.servicemanagement.models +constructor: + syntax: OSDiskConfiguration() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OSImage.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OSImage.yml new file mode 100644 index 00000000..3f7dfa52 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OSImage.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.OSImage +name: OSImage +fullName: azure.servicemanagement.models.OSImage +module: azure.servicemanagement.models +constructor: + syntax: OSImage() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OSImageDetails.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OSImageDetails.yml new file mode 100644 index 00000000..b502aca8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OSImageDetails.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.OSImageDetails +name: OSImageDetails +fullName: azure.servicemanagement.models.OSImageDetails +module: azure.servicemanagement.models +constructor: + syntax: OSImageDetails() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OSVirtualHardDisk.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OSVirtualHardDisk.yml new file mode 100644 index 00000000..10fc5ae6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OSVirtualHardDisk.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.OSVirtualHardDisk +name: OSVirtualHardDisk +fullName: azure.servicemanagement.models.OSVirtualHardDisk +module: azure.servicemanagement.models +constructor: + syntax: OSVirtualHardDisk(source_image_name=None, media_link=None, host_caching=None, + disk_label=None, disk_name=None, os=None, remote_source_image_link=None) + parameters: + - name: source_image_name + defaultValue: None + - name: media_link + defaultValue: None + - name: host_caching + defaultValue: None + - name: disk_label + defaultValue: None + - name: disk_name + defaultValue: None + - name: os + defaultValue: None + - name: remote_source_image_link + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperatingSystem.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperatingSystem.yml new file mode 100644 index 00000000..92ef3fdf --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperatingSystem.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.OperatingSystem +name: OperatingSystem +fullName: azure.servicemanagement.models.OperatingSystem +module: azure.servicemanagement.models +constructor: + syntax: OperatingSystem() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperatingSystemFamilies.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperatingSystemFamilies.yml new file mode 100644 index 00000000..e469db6b --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperatingSystemFamilies.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.OperatingSystemFamilies +name: OperatingSystemFamilies +fullName: azure.servicemanagement.models.OperatingSystemFamilies +module: azure.servicemanagement.models +constructor: + syntax: OperatingSystemFamilies() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperatingSystemFamily.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperatingSystemFamily.yml new file mode 100644 index 00000000..102a6223 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperatingSystemFamily.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.OperatingSystemFamily +name: OperatingSystemFamily +fullName: azure.servicemanagement.models.OperatingSystemFamily +module: azure.servicemanagement.models +constructor: + syntax: OperatingSystemFamily() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperatingSystems.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperatingSystems.yml new file mode 100644 index 00000000..7dd4bb22 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperatingSystems.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.OperatingSystems +name: OperatingSystems +fullName: azure.servicemanagement.models.OperatingSystems +module: azure.servicemanagement.models +constructor: + syntax: OperatingSystems() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Operation.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Operation.yml new file mode 100644 index 00000000..2de3ce9b --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Operation.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Operation +name: Operation +fullName: azure.servicemanagement.models.Operation +module: azure.servicemanagement.models +constructor: + syntax: Operation() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperationCaller.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperationCaller.yml new file mode 100644 index 00000000..6711b904 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperationCaller.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.OperationCaller +name: OperationCaller +fullName: azure.servicemanagement.models.OperationCaller +module: azure.servicemanagement.models +constructor: + syntax: OperationCaller() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperationError.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperationError.yml new file mode 100644 index 00000000..29a995ba --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperationError.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.OperationError +name: OperationError +fullName: azure.servicemanagement.models.OperationError +module: azure.servicemanagement.models +constructor: + syntax: OperationError() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperationStatus.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperationStatus.yml new file mode 100644 index 00000000..8d1b806f --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.OperationStatus.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.OperationStatus +name: OperationStatus +fullName: azure.servicemanagement.models.OperationStatus +module: azure.servicemanagement.models +constructor: + syntax: OperationStatus() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Passes.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Passes.yml new file mode 100644 index 00000000..9131bab6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Passes.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Passes +name: Passes +fullName: azure.servicemanagement.models.Passes +module: azure.servicemanagement.models +constructor: + syntax: Passes() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PersistentVMDowntimeInfo.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PersistentVMDowntimeInfo.yml new file mode 100644 index 00000000..ee2af088 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PersistentVMDowntimeInfo.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.PersistentVMDowntimeInfo +name: PersistentVMDowntimeInfo +fullName: azure.servicemanagement.models.PersistentVMDowntimeInfo +module: azure.servicemanagement.models +constructor: + syntax: PersistentVMDowntimeInfo() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PersistentVMRole.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PersistentVMRole.yml new file mode 100644 index 00000000..54ba0ffa --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PersistentVMRole.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.PersistentVMRole +name: PersistentVMRole +fullName: azure.servicemanagement.models.PersistentVMRole +module: azure.servicemanagement.models +constructor: + syntax: PersistentVMRole() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublicIP.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublicIP.yml new file mode 100644 index 00000000..3f473897 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublicIP.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.PublicIP +name: PublicIP +fullName: azure.servicemanagement.models.PublicIP +module: azure.servicemanagement.models +constructor: + syntax: PublicIP(name='') + parameters: + - name: name diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublicIPs.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublicIPs.yml new file mode 100644 index 00000000..94779af3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublicIPs.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.PublicIPs +name: PublicIPs +fullName: azure.servicemanagement.models.PublicIPs +module: azure.servicemanagement.models +constructor: + syntax: PublicIPs() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublicKey.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublicKey.yml new file mode 100644 index 00000000..ad303ce3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublicKey.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.PublicKey +name: PublicKey +fullName: azure.servicemanagement.models.PublicKey +module: azure.servicemanagement.models +constructor: + syntax: PublicKey(fingerprint='', path='') + parameters: + - name: fingerprint + - name: path diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublicKeys.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublicKeys.yml new file mode 100644 index 00000000..ae9a0d67 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublicKeys.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.PublicKeys +name: PublicKeys +fullName: azure.servicemanagement.models.PublicKeys +module: azure.servicemanagement.models +constructor: + syntax: PublicKeys() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublishData.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublishData.yml new file mode 100644 index 00000000..e3501d9f --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublishData.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.PublishData +name: PublishData +fullName: azure.servicemanagement.models.PublishData +module: azure.servicemanagement.models +constructor: + syntax: PublishData() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublishProfile.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublishProfile.yml new file mode 100644 index 00000000..3ed8ccb4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.PublishProfile.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.PublishProfile +name: PublishProfile +fullName: azure.servicemanagement.models.PublishProfile +module: azure.servicemanagement.models +constructor: + syntax: PublishProfile() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.QueueDescription.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.QueueDescription.yml new file mode 100644 index 00000000..1cb348ed --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.QueueDescription.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.QueueDescription +name: QueueDescription +fullName: azure.servicemanagement.models.QueueDescription +module: azure.servicemanagement.models +constructor: + syntax: QueueDescription() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Quota.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Quota.yml new file mode 100644 index 00000000..bc433528 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Quota.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Quota +name: Quota +fullName: azure.servicemanagement.models.Quota +module: azure.servicemanagement.models +constructor: + syntax: Quota() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RelayDescription.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RelayDescription.yml new file mode 100644 index 00000000..75dae233 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RelayDescription.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.RelayDescription +name: RelayDescription +fullName: azure.servicemanagement.models.RelayDescription +module: azure.servicemanagement.models +constructor: + syntax: RelayDescription() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ReplicationProgress.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ReplicationProgress.yml new file mode 100644 index 00000000..544a4f4d --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ReplicationProgress.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.ReplicationProgress +name: ReplicationProgress +fullName: azure.servicemanagement.models.ReplicationProgress +module: azure.servicemanagement.models +constructor: + syntax: ReplicationProgress() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ReplicationProgressElement.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ReplicationProgressElement.yml new file mode 100644 index 00000000..3f8de64e --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ReplicationProgressElement.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.ReplicationProgressElement +name: ReplicationProgressElement +fullName: azure.servicemanagement.models.ReplicationProgressElement +module: azure.servicemanagement.models +constructor: + syntax: ReplicationProgressElement() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ReservedIP.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ReservedIP.yml new file mode 100644 index 00000000..8ed082c9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ReservedIP.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.ReservedIP +name: ReservedIP +fullName: azure.servicemanagement.models.ReservedIP +module: azure.servicemanagement.models +constructor: + syntax: ReservedIP() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ReservedIPs.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ReservedIPs.yml new file mode 100644 index 00000000..d3ff9aae --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ReservedIPs.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.ReservedIPs +name: ReservedIPs +fullName: azure.servicemanagement.models.ReservedIPs +module: azure.servicemanagement.models +constructor: + syntax: ReservedIPs() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Resource.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Resource.yml new file mode 100644 index 00000000..643b01c4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Resource.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Resource +name: Resource +fullName: azure.servicemanagement.models.Resource +module: azure.servicemanagement.models +constructor: + syntax: Resource() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtension.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtension.yml new file mode 100644 index 00000000..9368608c --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtension.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.ResourceExtension +name: ResourceExtension +fullName: azure.servicemanagement.models.ResourceExtension +module: azure.servicemanagement.models +constructor: + syntax: ResourceExtension() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtensionParameterValue.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtensionParameterValue.yml new file mode 100644 index 00000000..02eec75d --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtensionParameterValue.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.ResourceExtensionParameterValue +name: ResourceExtensionParameterValue +fullName: azure.servicemanagement.models.ResourceExtensionParameterValue +module: azure.servicemanagement.models +constructor: + syntax: ResourceExtensionParameterValue() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtensionParameterValues.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtensionParameterValues.yml new file mode 100644 index 00000000..1403e60c --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtensionParameterValues.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.ResourceExtensionParameterValues +name: ResourceExtensionParameterValues +fullName: azure.servicemanagement.models.ResourceExtensionParameterValues +module: azure.servicemanagement.models +constructor: + syntax: ResourceExtensionParameterValues() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtensionReference.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtensionReference.yml new file mode 100644 index 00000000..1a9ef849 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtensionReference.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.ResourceExtensionReference +name: ResourceExtensionReference +fullName: azure.servicemanagement.models.ResourceExtensionReference +module: azure.servicemanagement.models +constructor: + syntax: ResourceExtensionReference(reference_name='', publisher='', name='', version='') + parameters: + - name: reference_name + - name: publisher + - name: name + - name: version diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtensionReferences.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtensionReferences.yml new file mode 100644 index 00000000..196892cc --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtensionReferences.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.ResourceExtensionReferences +name: ResourceExtensionReferences +fullName: azure.servicemanagement.models.ResourceExtensionReferences +module: azure.servicemanagement.models +constructor: + syntax: ResourceExtensionReferences() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtensions.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtensions.yml new file mode 100644 index 00000000..26133371 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ResourceExtensions.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.ResourceExtensions +name: ResourceExtensions +fullName: azure.servicemanagement.models.ResourceExtensions +module: azure.servicemanagement.models +constructor: + syntax: ResourceExtensions() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Resources.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Resources.yml new file mode 100644 index 00000000..2838cc87 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Resources.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Resources +name: Resources +fullName: azure.servicemanagement.models.Resources +module: azure.servicemanagement.models +constructor: + syntax: Resources() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Role.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Role.yml new file mode 100644 index 00000000..0592b393 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Role.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Role +name: Role +fullName: azure.servicemanagement.models.Role +module: azure.servicemanagement.models +constructor: + syntax: Role() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RoleInstance.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RoleInstance.yml new file mode 100644 index 00000000..5b9b7f70 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RoleInstance.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.RoleInstance +name: RoleInstance +fullName: azure.servicemanagement.models.RoleInstance +module: azure.servicemanagement.models +constructor: + syntax: RoleInstance() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RoleInstanceList.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RoleInstanceList.yml new file mode 100644 index 00000000..6dcf3136 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RoleInstanceList.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.RoleInstanceList +name: RoleInstanceList +fullName: azure.servicemanagement.models.RoleInstanceList +module: azure.servicemanagement.models +constructor: + syntax: RoleInstanceList() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RoleList.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RoleList.yml new file mode 100644 index 00000000..66a1a200 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RoleList.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.RoleList +name: RoleList +fullName: azure.servicemanagement.models.RoleList +module: azure.servicemanagement.models +constructor: + syntax: RoleList() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RoleSize.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RoleSize.yml new file mode 100644 index 00000000..49d48533 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RoleSize.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.RoleSize +name: RoleSize +fullName: azure.servicemanagement.models.RoleSize +module: azure.servicemanagement.models +constructor: + syntax: RoleSize() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RoleSizes.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RoleSizes.yml new file mode 100644 index 00000000..bcdc4710 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.RoleSizes.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.RoleSizes +name: RoleSizes +fullName: azure.servicemanagement.models.RoleSizes +module: azure.servicemanagement.models +constructor: + syntax: RoleSizes() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SSH.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SSH.yml new file mode 100644 index 00000000..cf3b9850 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SSH.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.SSH +name: SSH +fullName: azure.servicemanagement.models.SSH +module: azure.servicemanagement.models +constructor: + syntax: SSH() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Server.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Server.yml new file mode 100644 index 00000000..a4fdd8a9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Server.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Server +name: Server +fullName: azure.servicemanagement.models.Server +module: azure.servicemanagement.models +constructor: + syntax: Server() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ServerQuota.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ServerQuota.yml new file mode 100644 index 00000000..12f631a9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ServerQuota.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.ServerQuota +name: ServerQuota +fullName: azure.servicemanagement.models.ServerQuota +module: azure.servicemanagement.models +constructor: + syntax: ServerQuota() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Servers.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Servers.yml new file mode 100644 index 00000000..590d1cce --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Servers.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Servers +name: Servers +fullName: azure.servicemanagement.models.Servers +module: azure.servicemanagement.models +constructor: + syntax: Servers() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ServiceBusNamespace.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ServiceBusNamespace.yml new file mode 100644 index 00000000..a880f934 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ServiceBusNamespace.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.ServiceBusNamespace +name: ServiceBusNamespace +fullName: azure.servicemanagement.models.ServiceBusNamespace +module: azure.servicemanagement.models +constructor: + syntax: ServiceBusNamespace() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ServiceBusRegion.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ServiceBusRegion.yml new file mode 100644 index 00000000..52e19b98 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ServiceBusRegion.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.ServiceBusRegion +name: ServiceBusRegion +fullName: azure.servicemanagement.models.ServiceBusRegion +module: azure.servicemanagement.models +constructor: + syntax: ServiceBusRegion() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ServiceObjective.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ServiceObjective.yml new file mode 100644 index 00000000..ff2199a5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.ServiceObjective.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.ServiceObjective +name: ServiceObjective +fullName: azure.servicemanagement.models.ServiceObjective +module: azure.servicemanagement.models +constructor: + syntax: ServiceObjective() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Site.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Site.yml new file mode 100644 index 00000000..1081dd2e --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Site.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Site +name: Site +fullName: azure.servicemanagement.models.Site +module: azure.servicemanagement.models +constructor: + syntax: Site() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Sites.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Sites.yml new file mode 100644 index 00000000..2d216566 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Sites.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Sites +name: Sites +fullName: azure.servicemanagement.models.Sites +module: azure.servicemanagement.models +constructor: + syntax: Sites() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.StorageAccountProperties.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.StorageAccountProperties.yml new file mode 100644 index 00000000..3e4d5417 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.StorageAccountProperties.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.StorageAccountProperties +name: StorageAccountProperties +fullName: azure.servicemanagement.models.StorageAccountProperties +module: azure.servicemanagement.models +constructor: + syntax: StorageAccountProperties() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.StorageService.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.StorageService.yml new file mode 100644 index 00000000..77746e6b --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.StorageService.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.StorageService +name: StorageService +fullName: azure.servicemanagement.models.StorageService +module: azure.servicemanagement.models +constructor: + syntax: StorageService() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.StorageServiceKeys.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.StorageServiceKeys.yml new file mode 100644 index 00000000..980b7950 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.StorageServiceKeys.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.StorageServiceKeys +name: StorageServiceKeys +fullName: azure.servicemanagement.models.StorageServiceKeys +module: azure.servicemanagement.models +constructor: + syntax: StorageServiceKeys() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.StorageServices.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.StorageServices.yml new file mode 100644 index 00000000..0821c55f --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.StorageServices.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.StorageServices +name: StorageServices +fullName: azure.servicemanagement.models.StorageServices +module: azure.servicemanagement.models +constructor: + syntax: StorageServices() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.StoredCertificateSettings.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.StoredCertificateSettings.yml new file mode 100644 index 00000000..605b409b --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.StoredCertificateSettings.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.StoredCertificateSettings +name: StoredCertificateSettings +fullName: azure.servicemanagement.models.StoredCertificateSettings +module: azure.servicemanagement.models +constructor: + syntax: StoredCertificateSettings() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Subnet.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Subnet.yml new file mode 100644 index 00000000..9868cf5f --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Subnet.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Subnet +name: Subnet +fullName: azure.servicemanagement.models.Subnet +module: azure.servicemanagement.models +constructor: + syntax: Subnet() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Subnets.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Subnets.yml new file mode 100644 index 00000000..9229e566 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Subnets.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Subnets +name: Subnets +fullName: azure.servicemanagement.models.Subnets +module: azure.servicemanagement.models +constructor: + syntax: Subnets() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Subscription.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Subscription.yml new file mode 100644 index 00000000..7726849d --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Subscription.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Subscription +name: Subscription +fullName: azure.servicemanagement.models.Subscription +module: azure.servicemanagement.models +constructor: + syntax: Subscription() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionCertificate.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionCertificate.yml new file mode 100644 index 00000000..44f2b083 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionCertificate.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.SubscriptionCertificate +name: SubscriptionCertificate +fullName: azure.servicemanagement.models.SubscriptionCertificate +module: azure.servicemanagement.models +constructor: + syntax: SubscriptionCertificate() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionCertificates.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionCertificates.yml new file mode 100644 index 00000000..7dad8d22 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionCertificates.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.SubscriptionCertificates +name: SubscriptionCertificates +fullName: azure.servicemanagement.models.SubscriptionCertificates +module: azure.servicemanagement.models +constructor: + syntax: SubscriptionCertificates() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionOperation.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionOperation.yml new file mode 100644 index 00000000..17ac9d53 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionOperation.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.SubscriptionOperation +name: SubscriptionOperation +fullName: azure.servicemanagement.models.SubscriptionOperation +module: azure.servicemanagement.models +constructor: + syntax: SubscriptionOperation() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionOperationCollection.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionOperationCollection.yml new file mode 100644 index 00000000..02d8d817 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionOperationCollection.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.SubscriptionOperationCollection +name: SubscriptionOperationCollection +fullName: azure.servicemanagement.models.SubscriptionOperationCollection +module: azure.servicemanagement.models +constructor: + syntax: SubscriptionOperationCollection() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionOperationStatus.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionOperationStatus.yml new file mode 100644 index 00000000..6a3a23bf --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionOperationStatus.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.SubscriptionOperationStatus +name: SubscriptionOperationStatus +fullName: azure.servicemanagement.models.SubscriptionOperationStatus +module: azure.servicemanagement.models +constructor: + syntax: SubscriptionOperationStatus() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionOperations.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionOperations.yml new file mode 100644 index 00000000..71591d65 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.SubscriptionOperations.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.SubscriptionOperations +name: SubscriptionOperations +fullName: azure.servicemanagement.models.SubscriptionOperations +module: azure.servicemanagement.models +constructor: + syntax: SubscriptionOperations() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Subscriptions.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Subscriptions.yml new file mode 100644 index 00000000..c2f192b6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Subscriptions.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Subscriptions +name: Subscriptions +fullName: azure.servicemanagement.models.Subscriptions +module: azure.servicemanagement.models +constructor: + syntax: Subscriptions() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.TopicDescription.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.TopicDescription.yml new file mode 100644 index 00000000..4dfd8075 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.TopicDescription.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.TopicDescription +name: TopicDescription +fullName: azure.servicemanagement.models.TopicDescription +module: azure.servicemanagement.models +constructor: + syntax: TopicDescription() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.UnattendComponent.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.UnattendComponent.yml new file mode 100644 index 00000000..09dd6d0a --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.UnattendComponent.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.UnattendComponent +name: UnattendComponent +fullName: azure.servicemanagement.models.UnattendComponent +module: azure.servicemanagement.models +constructor: + syntax: UnattendComponent() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.UnattendPass.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.UnattendPass.yml new file mode 100644 index 00000000..ac79fded --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.UnattendPass.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.UnattendPass +name: UnattendPass +fullName: azure.servicemanagement.models.UnattendPass +module: azure.servicemanagement.models +constructor: + syntax: UnattendPass() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.UpgradeStatus.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.UpgradeStatus.yml new file mode 100644 index 00000000..f744cc19 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.UpgradeStatus.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.UpgradeStatus +name: UpgradeStatus +fullName: azure.servicemanagement.models.UpgradeStatus +module: azure.servicemanagement.models +constructor: + syntax: UpgradeStatus() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VMImage.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VMImage.yml new file mode 100644 index 00000000..5fe3d98f --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VMImage.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.VMImage +name: VMImage +fullName: azure.servicemanagement.models.VMImage +module: azure.servicemanagement.models +constructor: + syntax: VMImage(name=None, label=None, description=None) + parameters: + - name: name + defaultValue: None + - name: label + defaultValue: None + - name: description + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VMImages.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VMImages.yml new file mode 100644 index 00000000..08239e83 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VMImages.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.VMImages +name: VMImages +fullName: azure.servicemanagement.models.VMImages +module: azure.servicemanagement.models +constructor: + syntax: VMImages() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Values.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Values.yml new file mode 100644 index 00000000..18098faf --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.Values.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.Values +name: Values +fullName: azure.servicemanagement.models.Values +module: azure.servicemanagement.models +constructor: + syntax: Values() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VirtualIP.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VirtualIP.yml new file mode 100644 index 00000000..a2654dc7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VirtualIP.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.VirtualIP +name: VirtualIP +fullName: azure.servicemanagement.models.VirtualIP +module: azure.servicemanagement.models +constructor: + syntax: VirtualIP() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VirtualIPs.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VirtualIPs.yml new file mode 100644 index 00000000..e341c2df --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VirtualIPs.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.VirtualIPs +name: VirtualIPs +fullName: azure.servicemanagement.models.VirtualIPs +module: azure.servicemanagement.models +constructor: + syntax: VirtualIPs() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VirtualNetworkSite.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VirtualNetworkSite.yml new file mode 100644 index 00000000..fba95f1b --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VirtualNetworkSite.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.VirtualNetworkSite +name: VirtualNetworkSite +fullName: azure.servicemanagement.models.VirtualNetworkSite +module: azure.servicemanagement.models +constructor: + syntax: VirtualNetworkSite() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VirtualNetworkSites.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VirtualNetworkSites.yml new file mode 100644 index 00000000..4c6fa462 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.VirtualNetworkSites.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.VirtualNetworkSites +name: VirtualNetworkSites +fullName: azure.servicemanagement.models.VirtualNetworkSites +module: azure.servicemanagement.models +constructor: + syntax: VirtualNetworkSites() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.WebSpace.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.WebSpace.yml new file mode 100644 index 00000000..6f538b86 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.WebSpace.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.WebSpace +name: WebSpace +fullName: azure.servicemanagement.models.WebSpace +module: azure.servicemanagement.models +constructor: + syntax: WebSpace() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.WebSpaces.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.WebSpaces.yml new file mode 100644 index 00000000..51d5db62 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.WebSpaces.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.WebSpaces +name: WebSpaces +fullName: azure.servicemanagement.models.WebSpaces +module: azure.servicemanagement.models +constructor: + syntax: WebSpaces() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.WinRM.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.WinRM.yml new file mode 100644 index 00000000..76083b10 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.WinRM.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.WinRM +name: WinRM +fullName: azure.servicemanagement.models.WinRM +module: azure.servicemanagement.models +summary: 'Contains configuration settings for the Windows Remote Management service + on + + the Virtual Machine.' +constructor: + syntax: WinRM() diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.WindowsConfigurationSet.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.WindowsConfigurationSet.yml new file mode 100644 index 00000000..7ef7df78 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.WindowsConfigurationSet.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.models.WindowsConfigurationSet +name: WindowsConfigurationSet +fullName: azure.servicemanagement.models.WindowsConfigurationSet +module: azure.servicemanagement.models +constructor: + syntax: WindowsConfigurationSet(computer_name=None, admin_password=None, reset_password_on_first_logon=None, + enable_automatic_updates=None, time_zone=None, admin_username=None, custom_data=None) + parameters: + - name: computer_name + defaultValue: None + - name: admin_password + defaultValue: None + - name: reset_password_on_first_logon + defaultValue: None + - name: enable_automatic_updates + defaultValue: None + - name: time_zone + defaultValue: None + - name: admin_username + defaultValue: None + - name: custom_data + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.yml new file mode 100644 index 00000000..70694d9e --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.models.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonModule +uid: azure.servicemanagement.models +name: models +fullName: azure.servicemanagement.models +classes: +- azure.servicemanagement.models.AdditionalUnattendContent +- azure.servicemanagement.models.AffinityGroup +- azure.servicemanagement.models.AffinityGroups +- azure.servicemanagement.models.AsynchronousOperationResult +- azure.servicemanagement.models.AttachedTo +- azure.servicemanagement.models.AuthorizationRule +- azure.servicemanagement.models.AuthorizationRules +- azure.servicemanagement.models.AvailabilityResponse +- azure.servicemanagement.models.AzureAsyncOperationHttpError +- azure.servicemanagement.models.CaptureRoleAsVMImage +- azure.servicemanagement.models.Certificate +- azure.servicemanagement.models.CertificateSetting +- azure.servicemanagement.models.Certificates +- azure.servicemanagement.models.CloudService +- azure.servicemanagement.models.CloudServices +- azure.servicemanagement.models.ComponentSetting +- azure.servicemanagement.models.ComponentSettings +- azure.servicemanagement.models.Components +- azure.servicemanagement.models.ComputeCapabilities +- azure.servicemanagement.models.ConfigurationSet +- azure.servicemanagement.models.ConfigurationSetInputEndpoint +- azure.servicemanagement.models.ConfigurationSetInputEndpoints +- azure.servicemanagement.models.ConfigurationSets +- azure.servicemanagement.models.CountDetails +- azure.servicemanagement.models.CreateServerResponse +- azure.servicemanagement.models.Credentials +- azure.servicemanagement.models.Data +- azure.servicemanagement.models.DataDiskConfiguration +- azure.servicemanagement.models.DataDiskConfigurations +- azure.servicemanagement.models.DataVirtualHardDisk +- azure.servicemanagement.models.DataVirtualHardDisks +- azure.servicemanagement.models.Database +- azure.servicemanagement.models.Deployment +- azure.servicemanagement.models.Deployments +- azure.servicemanagement.models.Disk +- azure.servicemanagement.models.Disks +- azure.servicemanagement.models.DnsServer +- azure.servicemanagement.models.DomainJoin +- azure.servicemanagement.models.EventLog +- azure.servicemanagement.models.FirewallRule +- azure.servicemanagement.models.HostNameSslState +- azure.servicemanagement.models.HostNameSslStates +- azure.servicemanagement.models.HostedService +- azure.servicemanagement.models.HostedServiceProperties +- azure.servicemanagement.models.HostedServices +- azure.servicemanagement.models.Images +- azure.servicemanagement.models.InputEndpoint +- azure.servicemanagement.models.InputEndpoints +- azure.servicemanagement.models.InstanceEndpoint +- azure.servicemanagement.models.InstanceEndpoints +- azure.servicemanagement.models.IntrinsicSettings +- azure.servicemanagement.models.KeyPair +- azure.servicemanagement.models.KeyPairs +- azure.servicemanagement.models.LinuxConfigurationSet +- azure.servicemanagement.models.Listener +- azure.servicemanagement.models.Listeners +- azure.servicemanagement.models.LoadBalancerProbe +- azure.servicemanagement.models.Location +- azure.servicemanagement.models.Locations +- azure.servicemanagement.models.MaxRecurrence +- azure.servicemanagement.models.MetricAvailabilities +- azure.servicemanagement.models.MetricAvailability +- azure.servicemanagement.models.MetricDefinition +- azure.servicemanagement.models.MetricDefinitions +- azure.servicemanagement.models.MetricProperties +- azure.servicemanagement.models.MetricResponse +- azure.servicemanagement.models.MetricResponses +- azure.servicemanagement.models.MetricRollups +- azure.servicemanagement.models.MetricSample +- azure.servicemanagement.models.MetricValues +- azure.servicemanagement.models.NotificationHubDescription +- azure.servicemanagement.models.OSDiskConfiguration +- azure.servicemanagement.models.OSImage +- azure.servicemanagement.models.OSImageDetails +- azure.servicemanagement.models.OSVirtualHardDisk +- azure.servicemanagement.models.OperatingSystem +- azure.servicemanagement.models.OperatingSystemFamilies +- azure.servicemanagement.models.OperatingSystemFamily +- azure.servicemanagement.models.OperatingSystems +- azure.servicemanagement.models.Operation +- azure.servicemanagement.models.OperationCaller +- azure.servicemanagement.models.OperationError +- azure.servicemanagement.models.OperationStatus +- azure.servicemanagement.models.Passes +- azure.servicemanagement.models.PersistentVMDowntimeInfo +- azure.servicemanagement.models.PersistentVMRole +- azure.servicemanagement.models.PublicIP +- azure.servicemanagement.models.PublicIPs +- azure.servicemanagement.models.PublicKey +- azure.servicemanagement.models.PublicKeys +- azure.servicemanagement.models.PublishData +- azure.servicemanagement.models.PublishProfile +- azure.servicemanagement.models.QueueDescription +- azure.servicemanagement.models.Quota +- azure.servicemanagement.models.RelayDescription +- azure.servicemanagement.models.ReplicationProgress +- azure.servicemanagement.models.ReplicationProgressElement +- azure.servicemanagement.models.ReservedIP +- azure.servicemanagement.models.ReservedIPs +- azure.servicemanagement.models.Resource +- azure.servicemanagement.models.ResourceExtension +- azure.servicemanagement.models.ResourceExtensionParameterValue +- azure.servicemanagement.models.ResourceExtensionParameterValues +- azure.servicemanagement.models.ResourceExtensionReference +- azure.servicemanagement.models.ResourceExtensionReferences +- azure.servicemanagement.models.ResourceExtensions +- azure.servicemanagement.models.Resources +- azure.servicemanagement.models.Role +- azure.servicemanagement.models.RoleInstance +- azure.servicemanagement.models.RoleInstanceList +- azure.servicemanagement.models.RoleList +- azure.servicemanagement.models.RoleSize +- azure.servicemanagement.models.RoleSizes +- azure.servicemanagement.models.SSH +- azure.servicemanagement.models.Server +- azure.servicemanagement.models.ServerQuota +- azure.servicemanagement.models.Servers +- azure.servicemanagement.models.ServiceBusNamespace +- azure.servicemanagement.models.ServiceBusRegion +- azure.servicemanagement.models.ServiceObjective +- azure.servicemanagement.models.Site +- azure.servicemanagement.models.Sites +- azure.servicemanagement.models.StorageAccountProperties +- azure.servicemanagement.models.StorageService +- azure.servicemanagement.models.StorageServiceKeys +- azure.servicemanagement.models.StorageServices +- azure.servicemanagement.models.StoredCertificateSettings +- azure.servicemanagement.models.Subnet +- azure.servicemanagement.models.Subnets +- azure.servicemanagement.models.Subscription +- azure.servicemanagement.models.SubscriptionCertificate +- azure.servicemanagement.models.SubscriptionCertificates +- azure.servicemanagement.models.SubscriptionOperation +- azure.servicemanagement.models.SubscriptionOperationCollection +- azure.servicemanagement.models.SubscriptionOperationStatus +- azure.servicemanagement.models.SubscriptionOperations +- azure.servicemanagement.models.Subscriptions +- azure.servicemanagement.models.TopicDescription +- azure.servicemanagement.models.UnattendComponent +- azure.servicemanagement.models.UnattendPass +- azure.servicemanagement.models.UpgradeStatus +- azure.servicemanagement.models.VMImage +- azure.servicemanagement.models.VMImages +- azure.servicemanagement.models.Values +- azure.servicemanagement.models.VirtualIP +- azure.servicemanagement.models.VirtualIPs +- azure.servicemanagement.models.VirtualNetworkSite +- azure.servicemanagement.models.VirtualNetworkSites +- azure.servicemanagement.models.WebSpace +- azure.servicemanagement.models.WebSpaces +- azure.servicemanagement.models.WinRM +- azure.servicemanagement.models.WindowsConfigurationSet diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.publishsettings.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.publishsettings.yml new file mode 100644 index 00000000..a0f417d5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.publishsettings.yml @@ -0,0 +1,22 @@ +### YamlMime:PythonModule +uid: azure.servicemanagement.publishsettings +name: publishsettings +fullName: azure.servicemanagement.publishsettings +functions: +- uid: azure.servicemanagement.publishsettings.get_certificate_from_publish_settings + name: get_certificate_from_publish_settings + summary: "Writes a certificate file to the specified location. This can then be\ + \ used\nto instantiate ServiceManagementService. Returns the subscription ID.\n\ + \npublish_settings_path:\n Path to subscription file downloaded from\n [http://go.microsoft.com/fwlink/?LinkID=301775](http://go.microsoft.com/fwlink/?LinkID=301775)\n\ + \npath_to_write_certificate:\n Path to write the certificate file.\n\nsubscription_id:\n\ + \ (optional) Provide a subscription id here if you wish to use a\n specific\ + \ subscription under the publish settings file." + signature: get_certificate_from_publish_settings(publish_settings_path, path_to_write_certificate, + subscription_id=None) + parameters: + - name: publish_settings_path + isRequired: true + - name: path_to_write_certificate + isRequired: true + - name: subscription_id + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.yml new file mode 100644 index 00000000..988850b8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.yml @@ -0,0 +1,333 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService +name: SchedulerManagementService +fullName: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService +module: azure.servicemanagement.schedulermanagementservice +summary: "Note that this class is a preliminary work on Scheduler\nmanagement. Since\ + \ it lack a lot a features, final version\ncan be slightly different from the current\ + \ one.\n\nInitializes the scheduler management service.\n\nsubscription_id:\n \ + \ Subscription to manage.\n\ncert_file:\n Path to .pem certificate file (httplib),\ + \ or location of the\n certificate in your Personal certificate store (winhttp)\ + \ in the\n CURRENT_USERmyCertificateName format.\n If a request_session is specified,\ + \ then this is unused.\n\nhost:\n Live ServiceClient URL. Defaults to Azure public\ + \ cloud.\n\nrequest_session:\n Session object to use for http requests. If this\ + \ is specified, it\n replaces the default use of httplib or winhttp. Also, the\ + \ cert_file\n parameter is unused when a session is passed in.\n The session\ + \ object handles authentication, and as such can support\n multiple types of authentication:\ + \ .pem certificate, oauth.\n For example, you can pass in a Session instance from\ + \ the requests\n library. To use .pem certificate authentication with requests\n\ + \ library, set the path to the .pem file on the session.cert\n attribute.\n\n\ + timeout:\n Optional. Timeout for the http request, in seconds." +constructor: + syntax: SchedulerManagementService(subscription_id=None, cert_file=None, host='management.core.windows.net', + request_session=None, timeout=65) + parameters: + - name: subscription_id + defaultValue: None + - name: cert_file + defaultValue: None + - name: host + defaultValue: management.core.windows.net + - name: request_session + defaultValue: None + - name: timeout + defaultValue: '65' +methods: +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.check_job_collection_name + name: check_job_collection_name + summary: "The Check Name Availability operation checks if a new job collection with\n\ + the given name may be created, or if it is unavailable. The result of the\noperation\ + \ is a Boolean true or false.\n\ncloud_service_id:\n The cloud service id\n\n\ + job_collection_id:\n The name of the job_collection_id." + signature: check_job_collection_name(cloud_service_id, job_collection_id) + parameters: + - name: cloud_service_id + isRequired: true + - name: job_collection_id + isRequired: true +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.create_cloud_service + name: create_cloud_service + summary: "The Create Cloud Service request creates a new cloud service. When job\n\ + collections are created, they are hosted within a cloud service.\nA cloud service\ + \ groups job collections together in a given region.\nOnce a cloud service has\ + \ been created, job collections can then be\ncreated and contained within it.\n\ + \ncloud_service_id:\n The cloud service id\n\nlabel:\n The name of the cloud\ + \ service.\n\ndescription:\n The description of the cloud service.\n\ngeo_region:\n\ + \ The geographical region of the webspace that will be created." + signature: create_cloud_service(cloud_service_id, label, description, geo_region) + parameters: + - name: cloud_service_id + isRequired: true + - name: label + isRequired: true + - name: description + isRequired: true + - name: geo_region + isRequired: true +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.create_job + name: create_job + summary: "The Create Job request creates a new job.\ncloud_service_id:\n\n The\ + \ cloud service id\n\njob_collection_id:\n Name of the hosted service.\n\njob_id:\n\ + \ The job id you wish to create.\n\njob:\n A dictionary of the payload" + signature: create_job(cloud_service_id, job_collection_id, job_id, job) + parameters: + - name: cloud_service_id + isRequired: true + - name: job_collection_id + isRequired: true + - name: job_id + isRequired: true + - name: job + isRequired: true +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.create_job_collection + name: create_job_collection + summary: "The Create Job Collection request is specified as follows. Replace \n\ + with your subscription ID, with your cloud service ID, and\n\ + with the ID of the job collection you'd like to create.\n\ + There are no \"default\" pre-existing job collections every job collection\nmust\ + \ be manually created.\n\ncloud_service_id:\n The cloud service id\n\njob_collection_id:\n\ + \ Name of the hosted service." + signature: create_job_collection(cloud_service_id, job_collection_id, plan='Standard') + parameters: + - name: cloud_service_id + isRequired: true + - name: job_collection_id + isRequired: true + - name: plan + defaultValue: Standard +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.delete_cloud_service + name: delete_cloud_service + summary: "The Get Cloud Service operation gets all the resources (job collections)\n\ + in the cloud service.\n\ncloud_service_id:\n The cloud service id" + signature: delete_cloud_service(cloud_service_id) + parameters: + - name: cloud_service_id + isRequired: true +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.delete_job + name: delete_job + summary: "The Delete Job request creates a new job.\ncloud_service_id:\n\n The\ + \ cloud service id\n\njob_collection_id:\n Name of the hosted service.\n\njob_id:\n\ + \ The job id you wish to create." + signature: delete_job(cloud_service_id, job_collection_id, job_id) + parameters: + - name: cloud_service_id + isRequired: true + - name: job_collection_id + isRequired: true + - name: job_id + isRequired: true +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.delete_job_collection + name: delete_job_collection + summary: "The Delete Job Collection request is specified as follows. Replace \n\ + with your subscription ID, with your cloud service ID, and\n\ + with the ID of the job collection you'd like to delete.\n\n\ + cloud_service_id:\n The cloud service id\n\njob_collection_id:\n Name of the\ + \ hosted service." + signature: delete_job_collection(cloud_service_id, job_collection_id) + parameters: + - name: cloud_service_id + isRequired: true + - name: job_collection_id + isRequired: true +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.get_all_jobs + name: get_all_jobs + summary: "The Get All Jobs operation gets all the jobs in a job collection.\nThe\ + \ full list of jobs can be accessed by excluding any job ID in the\nGET call (i.e.\ + \ /jobs.)\n\nThe return type is\n\ncloud_service_id:\n The cloud service id\n\ + \njob_collection_id:\n Name of the hosted service." + signature: get_all_jobs(cloud_service_id, job_collection_id) + parameters: + - name: cloud_service_id + isRequired: true + - name: job_collection_id + isRequired: true +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.get_cloud_service + name: get_cloud_service + summary: "The Get Cloud Service operation gets all the resources (job collections)\n\ + in the cloud service.\n\ncloud_service_id:\n The cloud service id" + signature: get_cloud_service(cloud_service_id) + parameters: + - name: cloud_service_id + isRequired: true +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.get_job + name: get_job + summary: "The Get Job operation gets the details (including the current job status)\n\ + of the specified job from the specified job collection.\n\nThe return type is\n\ + \ncloud_service_id:\n The cloud service id\n\njob_collection_id:\n Name of\ + \ the hosted service.\n\njob_id:\n The job id you wish to create." + signature: get_job(cloud_service_id, job_collection_id, job_id) + parameters: + - name: cloud_service_id + isRequired: true + - name: job_collection_id + isRequired: true + - name: job_id + isRequired: true +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.get_job_collection + name: get_job_collection + summary: "The Get Job Collection operation gets the details of a job collection\n\ + \ncloud_service_id:\n The cloud service id\n\njob_collection_id:\n Name of\ + \ the hosted service." + signature: get_job_collection(cloud_service_id, job_collection_id) + parameters: + - name: cloud_service_id + isRequired: true + - name: job_collection_id + isRequired: true +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.get_operation_status + name: get_operation_status + summary: "Returns the status of the specified operation. After calling an\nasynchronous\ + \ operation, you can call Get Operation Status to determine\nwhether the operation\ + \ has succeeded, failed, or is still in progress.\n\nrequest_id:\n The request\ + \ ID for the request you wish to track." + signature: get_operation_status(request_id) + parameters: + - name: request_id + isRequired: true +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.list_cloud_services + name: list_cloud_services + summary: List the cloud services for scheduling defined on the account. + signature: list_cloud_services() +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.perform_delete + name: perform_delete + summary: "Performs a DELETE request and returns the response.\n\npath:\n Path\ + \ to the resource.\n Ex: '//services/hostedservices/'\n\ + \nx_ms_version:\n If specified, this is used for the x-ms-version header.\n\ + \ Otherwise, self.x_ms_version is used." + signature: perform_delete(path, x_ms_version=None) + parameters: + - name: path + isRequired: true + - name: x_ms_version + defaultValue: None +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.perform_get + name: perform_get + summary: "Performs a GET request and returns the response.\n\npath:\n Path to\ + \ the resource.\n Ex: '//services/hostedservices/'\n\ + \nx_ms_version:\n If specified, this is used for the x-ms-version header.\n\ + \ Otherwise, self.x_ms_version is used." + signature: perform_get(path, x_ms_version=None) + parameters: + - name: path + isRequired: true + - name: x_ms_version + defaultValue: None +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.perform_post + name: perform_post + summary: "Performs a POST request and returns the response.\n\npath:\n Path to\ + \ the resource.\n Ex: '//services/hostedservices/'\n\ + \nbody:\n Body for the POST request.\n\nx_ms_version:\n If specified, this\ + \ is used for the x-ms-version header.\n Otherwise, self.x_ms_version is used." + signature: perform_post(path, body, x_ms_version=None) + parameters: + - name: path + isRequired: true + - name: body + isRequired: true + - name: x_ms_version + defaultValue: None +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.perform_put + name: perform_put + summary: "Performs a PUT request and returns the response.\n\npath:\n Path to\ + \ the resource.\n Ex: '//services/hostedservices/'\n\ + \nbody:\n Body for the PUT request.\n\nx_ms_version:\n If specified, this\ + \ is used for the x-ms-version header.\n Otherwise, self.x_ms_version is used." + signature: perform_put(path, body, x_ms_version=None) + parameters: + - name: path + isRequired: true + - name: body + isRequired: true + - name: x_ms_version + defaultValue: None +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.set_proxy + name: set_proxy + summary: "Sets the proxy server host and port for the HTTP CONNECT Tunnelling.\n\ + \nhost:\n Address of the proxy. Ex: '192.168.0.100'\n\nport:\n Port of the\ + \ proxy. Ex: 6000\n\nuser:\n User for proxy authorization.\n\npassword:\n \ + \ Password for proxy authorization." + signature: set_proxy(host, port, user=None, password=None) + parameters: + - name: host + isRequired: true + - name: port + isRequired: true + - name: user + defaultValue: None + - name: password + defaultValue: None +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.should_use_requests + name: should_use_requests + signature: static should_use_requests(cert_file) + parameters: + - name: cert_file + isRequired: true +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.wait_for_operation_status + name: wait_for_operation_status + summary: "Waits for an asynchronous operation to complete.\n\nThis calls get_operation_status\ + \ in a loop and returns when the expected\nstatus is reached. The result of get_operation_status\ + \ is returned. By\ndefault, an exception is raised on timeout or error status.\n\ + \nrequest_id:\n The request ID for the request you wish to track.\n\nwait_for_status:\n\ + \ Status to wait for. Default is 'Succeeded'.\n\ntimeout:\n Total timeout\ + \ in seconds. Default is 30s.\n\nsleep_interval:\n Sleep time in seconds for\ + \ each iteration. Default is 5s.\n\nprogress_callback:\n Callback for each iteration.\n\ + \ Default prints '.'.\n Set it to None for no progress notification.\n\nsuccess_callback:\n\ + \ Callback on success. Default prints newline.\n Set it to None for no success\ + \ notification.\n\nfailure_callback:\n Callback on failure. Default prints newline+error\ + \ details then\n raises exception.\n Set it to None for no failure notification." + signature: wait_for_operation_status(request_id, wait_for_status='Succeeded', timeout=30, + sleep_interval=5, progress_callback=, + success_callback=, + failure_callback=) + parameters: + - name: request_id + isRequired: true + - name: wait_for_status + defaultValue: Succeeded + - name: timeout + defaultValue: '30' + - name: sleep_interval + defaultValue: '5' + - name: progress_callback + - name: success_callback + - name: failure_callback +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.wait_for_operation_status_failure_default_callback + name: wait_for_operation_status_failure_default_callback + signature: wait_for_operation_status_failure_default_callback(ex) + parameters: + - name: elapsed + isRequired: true + - name: ex + isRequired: true +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.wait_for_operation_status_progress_default_callback + name: wait_for_operation_status_progress_default_callback + signature: wait_for_operation_status_progress_default_callback() + parameters: + - name: elapsed + isRequired: true +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.wait_for_operation_status_success_default_callback + name: wait_for_operation_status_success_default_callback + signature: wait_for_operation_status_success_default_callback() + parameters: + - name: elapsed + isRequired: true +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.with_filter + name: with_filter + summary: 'Returns a new service which will process requests with the + + specified filter. Filtering operations can include logging, automatic + + retrying, etc... The filter is a lambda which receives the HTTPRequest + + and another lambda. The filter can perform any pre-processing on the + + request, pass it off to the next lambda, and then perform any + + post-processing on the response.' + signature: with_filter(filter) + parameters: + - name: filter + isRequired: true +attributes: +- uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService.timeout + name: timeout diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.schedulermanagementservice.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.schedulermanagementservice.yml new file mode 100644 index 00000000..6e9f0b27 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.schedulermanagementservice.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.servicemanagement.schedulermanagementservice +name: schedulermanagementservice +fullName: azure.servicemanagement.schedulermanagementservice +classes: +- azure.servicemanagement.schedulermanagementservice.SchedulerManagementService diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.yml new file mode 100644 index 00000000..40e9dc10 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.yml @@ -0,0 +1,441 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService +name: ServiceBusManagementService +fullName: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService +module: azure.servicemanagement.servicebusmanagementservice +summary: "Initializes the service bus management service.\n\nsubscription_id:\n \ + \ Subscription to manage.\n\ncert_file:\n Path to .pem certificate file (httplib),\ + \ or location of the\n certificate in your Personal certificate store (winhttp)\ + \ in the\n CURRENT_USERmyCertificateName format.\n If a request_session is specified,\ + \ then this is unused.\n\nhost:\n Live ServiceClient URL. Defaults to Azure public\ + \ cloud.\n\nrequest_session:\n Session object to use for http requests. If this\ + \ is specified, it\n replaces the default use of httplib or winhttp. Also, the\ + \ cert_file\n parameter is unused when a session is passed in.\n The session\ + \ object handles authentication, and as such can support\n multiple types of authentication:\ + \ .pem certificate, oauth.\n For example, you can pass in a Session instance from\ + \ the requests\n library. To use .pem certificate authentication with requests\n\ + \ library, set the path to the .pem file on the session.cert\n attribute.\n\n\ + timeout:\n Optional. Timeout for the http request, in seconds." +constructor: + syntax: ServiceBusManagementService(subscription_id=None, cert_file=None, host='management.core.windows.net', + request_session=None, timeout=65) + parameters: + - name: subscription_id + defaultValue: None + - name: cert_file + defaultValue: None + - name: host + defaultValue: management.core.windows.net + - name: request_session + defaultValue: None + - name: timeout + defaultValue: '65' +methods: +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.check_namespace_availability + name: check_namespace_availability + summary: "Checks to see if the specified service bus namespace is available, or\n\ + if it has already been taken.\n\nname:\n Name of the service bus namespace to\ + \ validate." + signature: check_namespace_availability(name) + parameters: + - name: name + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.create_namespace + name: create_namespace + summary: "Create a new service bus namespace.\n\nname:\n Name of the service bus\ + \ namespace to create.\n\nregion:\n Region to create the namespace in." + signature: create_namespace(name, region) + parameters: + - name: name + isRequired: true + - name: region + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.delete_namespace + name: delete_namespace + summary: "Delete a service bus namespace.\n\nname:\n Name of the service bus namespace\ + \ to delete." + signature: delete_namespace(name) + parameters: + - name: name + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.get_metrics_data_notification_hub + name: get_metrics_data_notification_hub + summary: "Retrieves the list of supported metrics for this namespace and topic\n\ + \nname:\n Name of the service bus namespace.\n\nhub_name:\n Name of the service\ + \ bus notification hub in this namespace.\n\nmetric:\n name of a supported metric\n\ + \nrollup:\n name of a supported rollup\n\nfilter_expression:\n filter, for\ + \ instance \"$filter=Timestamp gt datetime'2014-10-01T00:00:00Z'\"" + signature: get_metrics_data_notification_hub(name, hub_name, metric, rollup, filter_expresssion) + parameters: + - name: name + isRequired: true + - name: hub_name + isRequired: true + - name: metric + isRequired: true + - name: rollup + isRequired: true + - name: filter_expresssion + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.get_metrics_data_queue + name: get_metrics_data_queue + summary: "Retrieves the list of supported metrics for this namespace and queue\n\ + \nname:\n Name of the service bus namespace.\n\nqueue_name:\n Name of the\ + \ service bus queue in this namespace.\n\nmetric:\n name of a supported metric\n\ + \nrollup:\n name of a supported rollup\n\nfilter_expression:\n filter, for\ + \ instance \"$filter=Timestamp gt datetime'2014-10-01T00:00:00Z'\"" + signature: get_metrics_data_queue(name, queue_name, metric, rollup, filter_expresssion) + parameters: + - name: name + isRequired: true + - name: queue_name + isRequired: true + - name: metric + isRequired: true + - name: rollup + isRequired: true + - name: filter_expresssion + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.get_metrics_data_relay + name: get_metrics_data_relay + summary: "Retrieves the list of supported metrics for this namespace and relay\n\ + \nname:\n Name of the service bus namespace.\n\nrelay_name:\n Name of the\ + \ service bus relay in this namespace.\n\nmetric:\n name of a supported metric\n\ + \nrollup:\n name of a supported rollup\n\nfilter_expression:\n filter, for\ + \ instance \"$filter=Timestamp gt datetime'2014-10-01T00:00:00Z'\"" + signature: get_metrics_data_relay(name, relay_name, metric, rollup, filter_expresssion) + parameters: + - name: name + isRequired: true + - name: relay_name + isRequired: true + - name: metric + isRequired: true + - name: rollup + isRequired: true + - name: filter_expresssion + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.get_metrics_data_topic + name: get_metrics_data_topic + summary: "Retrieves the list of supported metrics for this namespace and topic\n\ + \nname:\n Name of the service bus namespace.\n\ntopic_name:\n Name of the\ + \ service bus queue in this namespace.\n\nmetric:\n name of a supported metric\n\ + \nrollup:\n name of a supported rollup\n\nfilter_expression:\n filter, for\ + \ instance \"$filter=Timestamp gt datetime'2014-10-01T00:00:00Z'\"" + signature: get_metrics_data_topic(name, topic_name, metric, rollup, filter_expresssion) + parameters: + - name: name + isRequired: true + - name: topic_name + isRequired: true + - name: metric + isRequired: true + - name: rollup + isRequired: true + - name: filter_expresssion + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.get_metrics_rollups_notification_hub + name: get_metrics_rollups_notification_hub + summary: "This operation gets rollup data for Service Bus metrics notification hub.\n\ + Rollup data includes the time granularity for the telemetry aggregation as well\ + \ as\nthe retention settings for each time granularity.\n\nname:\n Name of the\ + \ service bus namespace.\n\nhub_name:\n Name of the service bus notification\ + \ hub in this namespace.\n\nmetric:\n name of a supported metric" + signature: get_metrics_rollups_notification_hub(name, hub_name, metric) + parameters: + - name: name + isRequired: true + - name: hub_name + isRequired: true + - name: metric + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.get_metrics_rollups_queue + name: get_metrics_rollups_queue + summary: "This operation gets rollup data for Service Bus metrics queue.\nRollup\ + \ data includes the time granularity for the telemetry aggregation as well as\n\ + the retention settings for each time granularity.\n\nname:\n Name of the service\ + \ bus namespace.\n\nqueue_name:\n Name of the service bus queue in this namespace.\n\ + \nmetric:\n name of a supported metric" + signature: get_metrics_rollups_queue(name, queue_name, metric) + parameters: + - name: name + isRequired: true + - name: queue_name + isRequired: true + - name: metric + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.get_metrics_rollups_relay + name: get_metrics_rollups_relay + summary: "This operation gets rollup data for Service Bus metrics relay.\nRollup\ + \ data includes the time granularity for the telemetry aggregation as well as\n\ + the retention settings for each time granularity.\n\nname:\n Name of the service\ + \ bus namespace.\n\nrelay_name:\n Name of the service bus relay in this namespace.\n\ + \nmetric:\n name of a supported metric" + signature: get_metrics_rollups_relay(name, relay_name, metric) + parameters: + - name: name + isRequired: true + - name: relay_name + isRequired: true + - name: metric + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.get_metrics_rollups_topic + name: get_metrics_rollups_topic + summary: "This operation gets rollup data for Service Bus metrics topic.\nRollup\ + \ data includes the time granularity for the telemetry aggregation as well as\n\ + the retention settings for each time granularity.\n\nname:\n Name of the service\ + \ bus namespace.\n\ntopic_name:\n Name of the service bus queue in this namespace.\n\ + \nmetric:\n name of a supported metric" + signature: get_metrics_rollups_topic(name, topic_name, metric) + parameters: + - name: name + isRequired: true + - name: topic_name + isRequired: true + - name: metric + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.get_namespace + name: get_namespace + summary: "Get details about a specific namespace.\n\nname:\n Name of the service\ + \ bus namespace." + signature: get_namespace(name) + parameters: + - name: name + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.get_operation_status + name: get_operation_status + summary: "Returns the status of the specified operation. After calling an\nasynchronous\ + \ operation, you can call Get Operation Status to determine\nwhether the operation\ + \ has succeeded, failed, or is still in progress.\n\nrequest_id:\n The request\ + \ ID for the request you wish to track." + signature: get_operation_status(request_id) + parameters: + - name: request_id + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.get_regions + name: get_regions + summary: Get list of available service bus regions. + signature: get_regions() +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.get_supported_metrics_notification_hub + name: get_supported_metrics_notification_hub + summary: "Retrieves the list of supported metrics for this namespace and topic\n\ + \nname:\n Name of the service bus namespace.\n\nhub_name:\n Name of the service\ + \ bus notification hub in this namespace." + signature: get_supported_metrics_notification_hub(name, hub_name) + parameters: + - name: name + isRequired: true + - name: hub_name + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.get_supported_metrics_queue + name: get_supported_metrics_queue + summary: "Retrieves the list of supported metrics for this namespace and queue\n\ + \nname:\n Name of the service bus namespace.\n\nqueue_name:\n Name of the\ + \ service bus queue in this namespace." + signature: get_supported_metrics_queue(name, queue_name) + parameters: + - name: name + isRequired: true + - name: queue_name + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.get_supported_metrics_relay + name: get_supported_metrics_relay + summary: "Retrieves the list of supported metrics for this namespace and relay\n\ + \nname:\n Name of the service bus namespace.\n\nrelay_name:\n Name of the\ + \ service bus relay in this namespace." + signature: get_supported_metrics_relay(name, relay_name) + parameters: + - name: name + isRequired: true + - name: relay_name + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.get_supported_metrics_topic + name: get_supported_metrics_topic + summary: "Retrieves the list of supported metrics for this namespace and topic\n\ + \nname:\n Name of the service bus namespace.\n\ntopic_name:\n Name of the\ + \ service bus queue in this namespace." + signature: get_supported_metrics_topic(name, topic_name) + parameters: + - name: name + isRequired: true + - name: topic_name + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.list_namespaces + name: list_namespaces + summary: List the service bus namespaces defined on the account. + signature: list_namespaces() +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.list_notification_hubs + name: list_notification_hubs + summary: "Retrieves the notification hubs in the service namespace.\n\nname:\n \ + \ Name of the service bus namespace." + signature: list_notification_hubs(name) + parameters: + - name: name + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.list_queues + name: list_queues + summary: "Enumerates the queues in the service namespace.\n\nname:\n Name of the\ + \ service bus namespace." + signature: list_queues(name) + parameters: + - name: name + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.list_relays + name: list_relays + summary: "Retrieves the relays in the service namespace.\n\nname:\n Name of the\ + \ service bus namespace." + signature: list_relays(name) + parameters: + - name: name + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.list_topics + name: list_topics + summary: "Retrieves the topics in the service namespace.\n\nname:\n Name of the\ + \ service bus namespace." + signature: list_topics(name) + parameters: + - name: name + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.perform_delete + name: perform_delete + summary: "Performs a DELETE request and returns the response.\n\npath:\n Path\ + \ to the resource.\n Ex: '//services/hostedservices/'\n\ + \nx_ms_version:\n If specified, this is used for the x-ms-version header.\n\ + \ Otherwise, self.x_ms_version is used." + signature: perform_delete(path, x_ms_version=None) + parameters: + - name: path + isRequired: true + - name: x_ms_version + defaultValue: None +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.perform_get + name: perform_get + summary: "Performs a GET request and returns the response.\n\npath:\n Path to\ + \ the resource.\n Ex: '//services/hostedservices/'\n\ + \nx_ms_version:\n If specified, this is used for the x-ms-version header.\n\ + \ Otherwise, self.x_ms_version is used." + signature: perform_get(path, x_ms_version=None) + parameters: + - name: path + isRequired: true + - name: x_ms_version + defaultValue: None +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.perform_post + name: perform_post + summary: "Performs a POST request and returns the response.\n\npath:\n Path to\ + \ the resource.\n Ex: '//services/hostedservices/'\n\ + \nbody:\n Body for the POST request.\n\nx_ms_version:\n If specified, this\ + \ is used for the x-ms-version header.\n Otherwise, self.x_ms_version is used." + signature: perform_post(path, body, x_ms_version=None) + parameters: + - name: path + isRequired: true + - name: body + isRequired: true + - name: x_ms_version + defaultValue: None +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.perform_put + name: perform_put + summary: "Performs a PUT request and returns the response.\n\npath:\n Path to\ + \ the resource.\n Ex: '//services/hostedservices/'\n\ + \nbody:\n Body for the PUT request.\n\nx_ms_version:\n If specified, this\ + \ is used for the x-ms-version header.\n Otherwise, self.x_ms_version is used." + signature: perform_put(path, body, x_ms_version=None) + parameters: + - name: path + isRequired: true + - name: body + isRequired: true + - name: x_ms_version + defaultValue: None +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.set_proxy + name: set_proxy + summary: "Sets the proxy server host and port for the HTTP CONNECT Tunnelling.\n\ + \nhost:\n Address of the proxy. Ex: '192.168.0.100'\n\nport:\n Port of the\ + \ proxy. Ex: 6000\n\nuser:\n User for proxy authorization.\n\npassword:\n \ + \ Password for proxy authorization." + signature: set_proxy(host, port, user=None, password=None) + parameters: + - name: host + isRequired: true + - name: port + isRequired: true + - name: user + defaultValue: None + - name: password + defaultValue: None +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.should_use_requests + name: should_use_requests + signature: static should_use_requests(cert_file) + parameters: + - name: cert_file + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.wait_for_operation_status + name: wait_for_operation_status + summary: "Waits for an asynchronous operation to complete.\n\nThis calls get_operation_status\ + \ in a loop and returns when the expected\nstatus is reached. The result of get_operation_status\ + \ is returned. By\ndefault, an exception is raised on timeout or error status.\n\ + \nrequest_id:\n The request ID for the request you wish to track.\n\nwait_for_status:\n\ + \ Status to wait for. Default is 'Succeeded'.\n\ntimeout:\n Total timeout\ + \ in seconds. Default is 30s.\n\nsleep_interval:\n Sleep time in seconds for\ + \ each iteration. Default is 5s.\n\nprogress_callback:\n Callback for each iteration.\n\ + \ Default prints '.'.\n Set it to None for no progress notification.\n\nsuccess_callback:\n\ + \ Callback on success. Default prints newline.\n Set it to None for no success\ + \ notification.\n\nfailure_callback:\n Callback on failure. Default prints newline+error\ + \ details then\n raises exception.\n Set it to None for no failure notification." + signature: wait_for_operation_status(request_id, wait_for_status='Succeeded', timeout=30, + sleep_interval=5, progress_callback=, + success_callback=, + failure_callback=) + parameters: + - name: request_id + isRequired: true + - name: wait_for_status + defaultValue: Succeeded + - name: timeout + defaultValue: '30' + - name: sleep_interval + defaultValue: '5' + - name: progress_callback + - name: success_callback + - name: failure_callback +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.wait_for_operation_status_failure_default_callback + name: wait_for_operation_status_failure_default_callback + signature: wait_for_operation_status_failure_default_callback(ex) + parameters: + - name: elapsed + isRequired: true + - name: ex + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.wait_for_operation_status_progress_default_callback + name: wait_for_operation_status_progress_default_callback + signature: wait_for_operation_status_progress_default_callback() + parameters: + - name: elapsed + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.wait_for_operation_status_success_default_callback + name: wait_for_operation_status_success_default_callback + signature: wait_for_operation_status_success_default_callback() + parameters: + - name: elapsed + isRequired: true +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.with_filter + name: with_filter + summary: 'Returns a new service which will process requests with the + + specified filter. Filtering operations can include logging, automatic + + retrying, etc... The filter is a lambda which receives the HTTPRequest + + and another lambda. The filter can perform any pre-processing on the + + request, pass it off to the next lambda, and then perform any + + post-processing on the response.' + signature: with_filter(filter) + parameters: + - name: filter + isRequired: true +attributes: +- uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService.timeout + name: timeout diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.servicebusmanagementservice.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.servicebusmanagementservice.yml new file mode 100644 index 00000000..25eabbcc --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.servicebusmanagementservice.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.servicemanagement.servicebusmanagementservice +name: servicebusmanagementservice +fullName: azure.servicemanagement.servicebusmanagementservice +classes: +- azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.servicemanagementclient.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.servicemanagementclient.yml new file mode 100644 index 00000000..916f6329 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.servicemanagementclient.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonModule +uid: azure.servicemanagement.servicemanagementclient +name: servicemanagementclient +fullName: azure.servicemanagement.servicemanagementclient +functions: +- uid: azure.servicemanagement.servicemanagementclient.parse_response_for_async_op + name: parse_response_for_async_op + summary: Extracts request id from response header. + signature: parse_response_for_async_op(response) + parameters: + - name: response + isRequired: true diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.servicemanagementservice.ServiceManagementService.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.servicemanagementservice.ServiceManagementService.yml new file mode 100644 index 00000000..e5658ac9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.servicemanagementservice.ServiceManagementService.yml @@ -0,0 +1,1936 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService +name: ServiceManagementService +fullName: azure.servicemanagement.servicemanagementservice.ServiceManagementService +module: azure.servicemanagement.servicemanagementservice +summary: "Initializes the management service.\n\nsubscription_id:\n Subscription\ + \ to manage.\n\ncert_file:\n Path to .pem certificate file (httplib), or location\ + \ of the\n certificate in your Personal certificate store (winhttp) in the\n \ + \ CURRENT_USERmyCertificateName format.\n If a request_session is specified,\ + \ then this is unused.\n\nhost:\n Live ServiceClient URL. Defaults to Azure public\ + \ cloud.\n\nrequest_session:\n Session object to use for http requests. If this\ + \ is specified, it\n replaces the default use of httplib or winhttp. Also, the\ + \ cert_file\n parameter is unused when a session is passed in.\n The session\ + \ object handles authentication, and as such can support\n multiple types of authentication:\ + \ .pem certificate, oauth.\n For example, you can pass in a Session instance from\ + \ the requests\n library. To use .pem certificate authentication with requests\n\ + \ library, set the path to the .pem file on the session.cert\n attribute.\n\n\ + timeout:\n Optional. Timeout for the http request, in seconds." +constructor: + syntax: ServiceManagementService(subscription_id=None, cert_file=None, host='management.core.windows.net', + request_session=None, timeout=65) + parameters: + - name: subscription_id + defaultValue: None + - name: cert_file + defaultValue: None + - name: host + defaultValue: management.core.windows.net + - name: request_session + defaultValue: None + - name: timeout + defaultValue: '65' +methods: +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.add_data_disk + name: add_data_disk + summary: "Adds a data disk to a virtual machine.\n\nservice_name:\n The name of\ + \ the service.\n\ndeployment_name:\n The name of the deployment.\n\nrole_name:\n\ + \ The name of the role.\n\nlun:\n Specifies the Logical Unit Number (LUN)\ + \ for the disk. The LUN\n specifies the slot in which the data drive appears\ + \ when mounted\n for usage by the virtual machine. Valid LUN values are 0 through\ + \ 15.\n\nhost_caching:\n Specifies the platform caching behavior of data disk\ + \ blob for\n read/write efficiency. The default vault is ReadOnly. Possible\n\ + \ values are: None, ReadOnly, ReadWrite\n\nmedia_link:\n Specifies the location\ + \ of the blob in Windows Azure blob store\n where the media for the disk is\ + \ located. The blob location must\n belong to the storage account in the subscription\ + \ specified by the\n value in the operation call. Example:\n\ + \ [http://example.blob.core.windows.net/disks/mydisk.vhd](http://example.blob.core.windows.net/disks/mydisk.vhd)\n\ + \ndisk_label:\n Specifies the description of the data disk. When you attach\ + \ a disk,\n either by directly referencing a media using the MediaLink element\n\ + \ or specifying the target disk size, you can use the DiskLabel\n element\ + \ to customize the name property of the target data disk.\n\ndisk_name:\n Specifies\ + \ the name of the disk. Windows Azure uses the specified\n disk to create the\ + \ data disk for the machine and populates this\n field with the disk name.\n\ + \nlogical_disk_size_in_gb:\n Specifies the size, in GB, of an empty disk to\ + \ be attached to the\n role. The disk can be created as part of disk attach\ + \ or create VM\n role call by specifying the value for this property. Windows\ + \ Azure\n creates the empty disk based on size preference and attaches the\n\ + \ newly created disk to the Role.\n\nsource_media_link:\n Specifies the location\ + \ of a blob in account storage which is\n mounted as a data disk when the virtual\ + \ machine is created." + signature: add_data_disk(service_name, deployment_name, role_name, lun, host_caching=None, + media_link=None, disk_label=None, disk_name=None, logical_disk_size_in_gb=None, + source_media_link=None) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: role_name + isRequired: true + - name: lun + isRequired: true + - name: host_caching + defaultValue: None + - name: media_link + defaultValue: None + - name: disk_label + defaultValue: None + - name: disk_name + defaultValue: None + - name: logical_disk_size_in_gb + defaultValue: None + - name: source_media_link + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.add_disk + name: add_disk + summary: "Adds a disk to the user image repository. The disk can be an OS disk\n\ + or a data disk.\n\nhas_operating_system:\n Deprecated.\n\nlabel:\n Specifies\ + \ the description of the disk.\n\nmedia_link:\n Specifies the location of the\ + \ blob in Windows Azure blob store\n where the media for the disk is located.\ + \ The blob location must\n belong to the storage account in the current subscription\ + \ specified\n by the value in the operation call. Example:\n\ + \ [http://example.blob.core.windows.net/disks/mydisk.vhd](http://example.blob.core.windows.net/disks/mydisk.vhd)\n\ + \nname:\n Specifies a name for the disk. Windows Azure uses the name to\n \ + \ identify the disk when creating virtual machines from the disk.\n\nos:\n The\ + \ OS type of the disk. Possible values are: Linux, Windows" + signature: add_disk(has_operating_system, label, media_link, name, os) + parameters: + - name: has_operating_system + isRequired: true + - name: label + isRequired: true + - name: media_link + isRequired: true + - name: name + isRequired: true + - name: os + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.add_dns_server + name: add_dns_server + summary: "Adds a DNS server definition to an existing deployment.\n\nservice_name:\n\ + \ The name of the service.\n\ndeployment_name:\n The name of the deployment.\n\ + \ndns_server_name:\n Specifies the name of the DNS server.\n\naddress:\n Specifies\ + \ the IP address of the DNS server." + signature: add_dns_server(service_name, deployment_name, dns_server_name, address) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: dns_server_name + isRequired: true + - name: address + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.add_management_certificate + name: add_management_certificate + summary: "The Add Management Certificate operation adds a certificate to the\nlist\ + \ of management certificates. Management certificates, which are\nalso known as\ + \ subscription certificates, authenticate clients\nattempting to connect to resources\ + \ associated with your Windows Azure\nsubscription.\n\npublic_key:\n A base64\ + \ representation of the management certificate public key.\n\nthumbprint:\n \ + \ The thumb print that uniquely identifies the management\n certificate.\n\n\ + data:\n The certificate's raw data in base-64 encoded .cer format." + signature: add_management_certificate(public_key, thumbprint, data) + parameters: + - name: public_key + isRequired: true + - name: thumbprint + isRequired: true + - name: data + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.add_os_image + name: add_os_image + summary: "Adds an OS image that is currently stored in a storage account in your\n\ + subscription to the image repository.\n\nlabel:\n Specifies the friendly name\ + \ of the image.\n\nmedia_link:\n Specifies the location of the blob in Windows\ + \ Azure blob store\n where the media for the image is located. The blob location\ + \ must\n belong to a storage account in the subscription specified by the\n\ + \ value in the operation call. Example:\n [http://example.blob.core.windows.net/disks/mydisk.vhd](http://example.blob.core.windows.net/disks/mydisk.vhd)\n\ + \nname:\n Specifies a name for the OS image that Windows Azure uses to\n identify\ + \ the image when creating one or more virtual machines.\n\nos:\n The operating\ + \ system type of the OS image. Possible values are:\n Linux, Windows" + signature: add_os_image(label, media_link, name, os) + parameters: + - name: label + isRequired: true + - name: media_link + isRequired: true + - name: name + isRequired: true + - name: os + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.add_role + name: add_role + summary: "Adds a virtual machine to an existing deployment.\n\nservice_name:\n \ + \ The name of the service.\n\ndeployment_name:\n The name of the deployment.\n\ + \nrole_name:\n The name of the role.\n\nsystem_config:\n Contains the metadata\ + \ required to provision a virtual machine from\n a Windows or Linux OS image.\ + \ Use an instance of\n WindowsConfigurationSet or LinuxConfigurationSet.\n\n\ + os_virtual_hard_disk:\n Contains the parameters Windows Azure uses to create\ + \ the operating\n system disk for the virtual machine. If you are creating a\ + \ Virtual\n Machine by using a VM Image, this parameter is not used.\n\nnetwork_config:\n\ + \ Encapsulates the metadata required to create the virtual network\n configuration\ + \ for a virtual machine. If you do not include a\n network configuration set\ + \ you will not be able to access the VM\n through VIPs over the internet. If\ + \ your virtual machine belongs to\n a virtual network you can not specify which\ + \ subnet address space\n it resides under.\n\navailability_set_name:\n Specifies\ + \ the name of an availability set to which to add the\n virtual machine. This\ + \ value controls the virtual machine allocation\n in the Windows Azure environment.\ + \ Virtual machines specified in the\n same availability set are allocated to\ + \ different nodes to maximize\n availability.\n\ndata_virtual_hard_disks:\n\ + \ Contains the parameters Windows Azure uses to create a data disk\n for a\ + \ virtual machine.\n\nrole_size:\n The size of the virtual machine to allocate.\ + \ The default value is\n Small. Possible values are: ExtraSmall, Small, Medium,\ + \ Large,\n ExtraLarge. The specified value must be compatible with the disk\n\ + \ selected in the OSVirtualHardDisk values.\n\nrole_type:\n The type of the\ + \ role for the virtual machine. The only supported\n value is PersistentVMRole.\n\ + \nresource_extension_references:\n Optional. Contains a collection of resource\ + \ extensions that are to\n be installed on the Virtual Machine. This element\ + \ is used if\n provision_guest_agent is set to True.\n\nprovision_guest_agent:\n\ + \ Optional. Indicates whether the VM Agent is installed on the\n Virtual Machine.\ + \ To run a resource extension in a Virtual Machine,\n this service must be installed.\n\ + \nvm_image_name:\n Optional. Specifies the name of the VM Image that is to be\ + \ used to\n create the Virtual Machine. If this is specified, the\n system_config\ + \ and network_config parameters are not used.\n\nmedia_location:\n Optional.\ + \ Required if the Virtual Machine is being created from a\n published VM Image.\ + \ Specifies the location of the VHD file that is\n created when VMImageName\ + \ specifies a published VM Image." + signature: add_role(service_name, deployment_name, role_name, system_config, os_virtual_hard_disk, + network_config=None, availability_set_name=None, data_virtual_hard_disks=None, + role_size=None, role_type='PersistentVMRole', resource_extension_references=None, + provision_guest_agent=None, vm_image_name=None, media_location=None) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: role_name + isRequired: true + - name: system_config + isRequired: true + - name: os_virtual_hard_disk + isRequired: true + - name: network_config + defaultValue: None + - name: availability_set_name + defaultValue: None + - name: data_virtual_hard_disks + defaultValue: None + - name: role_size + defaultValue: None + - name: role_type + defaultValue: PersistentVMRole + - name: resource_extension_references + defaultValue: None + - name: provision_guest_agent + defaultValue: None + - name: vm_image_name + defaultValue: None + - name: media_location + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.add_service_certificate + name: add_service_certificate + summary: "Adds a certificate to a hosted service.\n\nservice_name:\n Name of the\ + \ hosted service.\n\ndata:\n The base-64 encoded form of the pfx/cer file.\n\ + \ncertificate_format:\n The service certificate format.\n\npassword:\n The\ + \ certificate password. Default to None when using cer format." + signature: add_service_certificate(service_name, data, certificate_format, password=None) + parameters: + - name: service_name + isRequired: true + - name: data + isRequired: true + - name: certificate_format + isRequired: true + - name: password + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.associate_reserved_ip_address + name: associate_reserved_ip_address + summary: "Associate an existing reservedIP to a deployment.\n\nname:\n Required.\ + \ Name of the reserved IP address.\n\nservice_name:\n Required. Name of the\ + \ hosted service.\n\ndeployment_name:\n Required. Name of the deployment.\n\n\ + virtual_ip_name:\n Optional. Name of the VirtualIP in case of multi Vip tenant.\n\ + \ If this value is not specified default virtualIP is used\n for this operation." + signature: associate_reserved_ip_address(name, service_name, deployment_name, virtual_ip_name=None) + parameters: + - name: name + isRequired: true + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: virtual_ip_name + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.capture_role + name: capture_role + summary: "The Capture Role operation captures a virtual machine image to your\n\ + image gallery. From the captured image, you can create additional\ncustomized\ + \ virtual machines.\n\nservice_name:\n The name of the service.\n\ndeployment_name:\n\ + \ The name of the deployment.\n\nrole_name:\n The name of the role.\n\npost_capture_action:\n\ + \ Specifies the action after capture operation completes. Possible\n values\ + \ are: Delete, Reprovision.\n\ntarget_image_name:\n Specifies the image name\ + \ of the captured virtual machine.\n\ntarget_image_label:\n Specifies the friendly\ + \ name of the captured virtual machine.\n\nprovisioning_configuration:\n Use\ + \ an instance of WindowsConfigurationSet or LinuxConfigurationSet." + signature: capture_role(service_name, deployment_name, role_name, post_capture_action, + target_image_name, target_image_label, provisioning_configuration=None) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: role_name + isRequired: true + - name: post_capture_action + isRequired: true + - name: target_image_name + isRequired: true + - name: target_image_label + isRequired: true + - name: provisioning_configuration + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.capture_vm_image + name: capture_vm_image + summary: "Creates a copy of the operating system virtual hard disk (VHD) and all\n\ + of the data VHDs that are associated with the Virtual Machine, saves\nthe VHD\ + \ copies in the same storage location as the original VHDs, and\nregisters the\ + \ copies as a VM Image in the image repository that is\nassociated with the specified\ + \ subscription.\n\nservice_name:\n The name of the service.\n\ndeployment_name:\n\ + \ The name of the deployment.\n\nrole_name:\n The name of the role.\n\noptions:\n\ + \ An instance of CaptureRoleAsVMImage class.\n\noptions.os_state:\n Required.\ + \ Specifies the state of the operating system in the image.\n Possible values\ + \ are: Generalized, Specialized\n A Virtual Machine that is fully configured\ + \ and running contains a\n Specialized operating system. A Virtual Machine on\ + \ which the\n Sysprep command has been run with the generalize option contains\ + \ a\n Generalized operating system. If you capture an image from a\n generalized\ + \ Virtual Machine, the machine is deleted after the image\n is captured. It\ + \ is recommended that all Virtual Machines are shut\n down before capturing\ + \ an image.\n\noptions.vm_image_name:\n Required. Specifies the name of the\ + \ VM Image.\n\noptions.vm_image_label:\n Required. Specifies the label of the\ + \ VM Image.\n\noptions.description:\n Optional. Specifies the description of\ + \ the VM Image.\n\noptions.language:\n Optional. Specifies the language of the\ + \ VM Image.\n\noptions.image_family:\n Optional. Specifies a value that can\ + \ be used to group VM Images.\n\noptions.recommended_vm_size:\n Optional. Specifies\ + \ the size to use for the Virtual Machine that\n is created from the VM Image." + signature: capture_vm_image(service_name, deployment_name, role_name, options) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: role_name + isRequired: true + - name: options + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.change_deployment_configuration + name: change_deployment_configuration + summary: "Initiates a change to the deployment configuration.\n\nservice_name:\n\ + \ Name of the hosted service.\n\ndeployment_name:\n The name of the deployment.\n\ + \nconfiguration:\n The base-64 encoded service configuration file for the deployment.\n\ + \ntreat_warnings_as_error:\n Indicates whether to treat package validation warnings\ + \ as errors.\n If set to true, the Created Deployment operation fails if there\n\ + \ are validation warnings on the service package.\n\nmode:\n If set to Manual,\ + \ WalkUpgradeDomain must be called to apply the\n update. If set to Auto, the\ + \ Windows Azure platform will\n automatically apply the update To each upgrade\ + \ domain for the\n service. Possible values are: Auto, Manual\n\nextended_properties:\n\ + \ Dictionary containing name/value pairs of storage account\n properties.\ + \ You can have a maximum of 50 extended property\n name/value pairs. The maximum\ + \ length of the Name element is 64\n characters, only alphanumeric characters\ + \ and underscores are valid\n in the Name, and the name must start with a letter.\ + \ The value has\n a maximum length of 255 characters." + signature: change_deployment_configuration(service_name, deployment_name, configuration, + treat_warnings_as_error=False, mode='Auto', extended_properties=None) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: configuration + isRequired: true + - name: treat_warnings_as_error + defaultValue: 'False' + - name: mode + defaultValue: Auto + - name: extended_properties + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.check_hosted_service_name_availability + name: check_hosted_service_name_availability + summary: "Checks to see if the specified hosted service name is available, or if\n\ + it has already been taken.\n\nservice_name:\n Name of the hosted service." + signature: check_hosted_service_name_availability(service_name) + parameters: + - name: service_name + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.check_storage_account_name_availability + name: check_storage_account_name_availability + summary: "Checks to see if the specified storage account name is available, or\n\ + if it has already been taken.\n\nservice_name:\n Name of the storage service\ + \ account." + signature: check_storage_account_name_availability(service_name) + parameters: + - name: service_name + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.create_affinity_group + name: create_affinity_group + summary: "Creates a new affinity group for the specified subscription.\n\nname:\n\ + \ A name for the affinity group that is unique to the subscription.\n\nlabel:\n\ + \ A name for the affinity group. The name can be up to 100 characters\n in\ + \ length.\n\nlocation:\n The data center location where the affinity group will\ + \ be created.\n To list available locations, use the list_location function.\n\ + \ndescription:\n A description for the affinity group. The description can be\ + \ up to\n 1024 characters in length." + signature: create_affinity_group(name, label, location, description=None) + parameters: + - name: name + isRequired: true + - name: label + isRequired: true + - name: location + isRequired: true + - name: description + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.create_deployment + name: create_deployment + summary: "Uploads a new service package and creates a new deployment on staging\n\ + or production.\n\nservice_name:\n Name of the hosted service.\n\ndeployment_slot:\n\ + \ The environment to which the hosted service is deployed. Valid\n values\ + \ are: staging, production\n\nname:\n The name for the deployment. The deployment\ + \ name must be unique\n among other deployments for the hosted service.\n\n\ + package_url:\n A URL that refers to the location of the service package in the\n\ + \ Blob service. The service package can be located either in a\n storage account\ + \ beneath the same subscription or a Shared Access\n Signature (SAS) URI from\ + \ any storage account.\n\nlabel:\n A name for the hosted service. The name can\ + \ be up to 100 characters\n in length. It is recommended that the label be unique\ + \ within the\n subscription. The name can be used to identify the hosted service\n\ + \ for your tracking purposes.\n\nconfiguration:\n The base-64 encoded service\ + \ configuration file for the deployment.\n\nstart_deployment:\n Indicates whether\ + \ to start the deployment immediately after it is\n created. If false, the service\ + \ model is still deployed to the\n virtual machines but the code is not run\ + \ immediately. Instead, the\n service is Suspended until you call Update Deployment\ + \ Status and\n set the status to Running, at which time the service will be\n\ + \ started. A deployed service still incurs charges, even if it is\n suspended.\n\ + \ntreat_warnings_as_error:\n Indicates whether to treat package validation warnings\ + \ as errors.\n If set to true, the Created Deployment operation fails if there\n\ + \ are validation warnings on the service package.\n\nextended_properties:\n\ + \ Dictionary containing name/value pairs of storage account\n properties.\ + \ You can have a maximum of 50 extended property\n name/value pairs. The maximum\ + \ length of the Name element is 64\n characters, only alphanumeric characters\ + \ and underscores are valid\n in the Name, and the name must start with a letter.\ + \ The value has\n a maximum length of 255 characters." + signature: create_deployment(service_name, deployment_slot, name, package_url, label, + configuration, start_deployment=False, treat_warnings_as_error=False, extended_properties=None) + parameters: + - name: service_name + isRequired: true + - name: deployment_slot + isRequired: true + - name: name + isRequired: true + - name: package_url + isRequired: true + - name: label + isRequired: true + - name: configuration + isRequired: true + - name: start_deployment + defaultValue: 'False' + - name: treat_warnings_as_error + defaultValue: 'False' + - name: extended_properties + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.create_hosted_service + name: create_hosted_service + summary: "Creates a new hosted service in Windows Azure.\n\nservice_name:\n A\ + \ name for the hosted service that is unique within Windows Azure.\n This name\ + \ is the DNS prefix name and can be used to access the\n hosted service.\n\n\ + label:\n A name for the hosted service. The name can be up to 100 characters\n\ + \ in length. The name can be used to identify the storage account for\n your\ + \ tracking purposes.\n\ndescription:\n A description for the hosted service.\ + \ The description can be up to\n 1024 characters in length.\n\nlocation:\n \ + \ The location where the hosted service will be created. You can\n specify\ + \ either a location or affinity_group, but not both.\n\naffinity_group:\n The\ + \ name of an existing affinity group associated with this\n subscription. This\ + \ name is a GUID and can be retrieved by examining\n the name element of the\ + \ response body returned by\n list_affinity_groups. You can specify either a\ + \ location or\n affinity_group, but not both.\n\nextended_properties:\n Dictionary\ + \ containing name/value pairs of storage account\n properties. You can have\ + \ a maximum of 50 extended property\n name/value pairs. The maximum length of\ + \ the Name element is 64\n characters, only alphanumeric characters and underscores\ + \ are valid\n in the Name, and the name must start with a letter. The value\ + \ has\n a maximum length of 255 characters." + signature: create_hosted_service(service_name, label, description=None, location=None, + affinity_group=None, extended_properties=None) + parameters: + - name: service_name + isRequired: true + - name: label + isRequired: true + - name: description + defaultValue: None + - name: location + defaultValue: None + - name: affinity_group + defaultValue: None + - name: extended_properties + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.create_reserved_ip_address + name: create_reserved_ip_address + summary: "Reserves an IPv4 address for the specified subscription.\n\nname:\n \ + \ Required. Specifies the name for the reserved IP address.\n\nlabel:\n Optional.\ + \ Specifies a label for the reserved IP address. The label\n can be up to 100\ + \ characters long and can be used for your tracking\n purposes.\n\nlocation:\n\ + \ Required. Specifies the location of the reserved IP address. This\n should\ + \ be the same location that is assigned to the cloud service\n containing the\ + \ deployment that will use the reserved IP address.\n To see the available locations,\ + \ you can use list_locations." + signature: create_reserved_ip_address(name, label=None, location=None) + parameters: + - name: name + isRequired: true + - name: label + defaultValue: None + - name: location + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.create_storage_account + name: create_storage_account + summary: "Creates a new storage account in Windows Azure.\n\nservice_name:\n A\ + \ name for the storage account that is unique within Windows Azure.\n Storage\ + \ account names must be between 3 and 24 characters in length\n and use numbers\ + \ and lower-case letters only.\n\ndescription:\n A description for the storage\ + \ account. The description may be up\n to 1024 characters in length.\n\nlabel:\n\ + \ A name for the storage account. The name may be up to 100\n characters in\ + \ length. The name can be used to identify the storage\n account for your tracking\ + \ purposes.\n\naffinity_group:\n The name of an existing affinity group in the\ + \ specified\n subscription. You can specify either a location or affinity_group,\n\ + \ but not both.\n\nlocation:\n The location where the storage account is created.\ + \ You can specify\n either a location or affinity_group, but not both.\n\ngeo_replication_enabled:\n\ + \ Deprecated. Replaced by the account_type parameter.\n\nextended_properties:\n\ + \ Dictionary containing name/value pairs of storage account\n properties.\ + \ You can have a maximum of 50 extended property\n name/value pairs. The maximum\ + \ length of the Name element is 64\n characters, only alphanumeric characters\ + \ and underscores are valid\n in the Name, and the name must start with a letter.\ + \ The value has\n a maximum length of 255 characters.\n\naccount_type:\n Specifies\ + \ whether the account supports locally-redundant storage,\n geo-redundant storage,\ + \ zone-redundant storage, or read access\n geo-redundant storage.\n Possible\ + \ values are:\n\n Standard_LRS, Standard_ZRS, Standard_GRS, Standard_RAGRS" + signature: create_storage_account(service_name, description, label, affinity_group=None, + location=None, geo_replication_enabled=None, extended_properties=None, account_type='Standard_GRS') + parameters: + - name: service_name + isRequired: true + - name: description + isRequired: true + - name: label + isRequired: true + - name: affinity_group + defaultValue: None + - name: location + defaultValue: None + - name: geo_replication_enabled + defaultValue: None + - name: extended_properties + defaultValue: None + - name: account_type + defaultValue: Standard_GRS +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.create_virtual_machine_deployment + name: create_virtual_machine_deployment + summary: "Provisions a virtual machine based on the supplied configuration.\n\n\ + service_name:\n Name of the hosted service.\n\ndeployment_name:\n The name\ + \ for the deployment. The deployment name must be unique\n among other deployments\ + \ for the hosted service.\n\ndeployment_slot:\n The environment to which the\ + \ hosted service is deployed. Valid\n values are: staging, production\n\nlabel:\n\ + \ Specifies an identifier for the deployment. The label can be up to\n 100\ + \ characters long. The label can be used for tracking purposes.\n\nrole_name:\n\ + \ The name of the role.\n\nsystem_config:\n Contains the metadata required\ + \ to provision a virtual machine from\n a Windows or Linux OS image. Use an\ + \ instance of\n WindowsConfigurationSet or LinuxConfigurationSet.\n\nos_virtual_hard_disk:\n\ + \ Contains the parameters Windows Azure uses to create the operating\n system\ + \ disk for the virtual machine. If you are creating a Virtual\n Machine by using\ + \ a VM Image, this parameter is not used.\n\nnetwork_config:\n Encapsulates\ + \ the metadata required to create the virtual network\n configuration for a\ + \ virtual machine. If you do not include a\n network configuration set you will\ + \ not be able to access the VM\n through VIPs over the internet. If your virtual\ + \ machine belongs to\n a virtual network you can not specify which subnet address\ + \ space\n it resides under. Use an instance of ConfigurationSet.\n\navailability_set_name:\n\ + \ Specifies the name of an availability set to which to add the\n virtual\ + \ machine. This value controls the virtual machine\n allocation in the Windows\ + \ Azure environment. Virtual machines\n specified in the same availability set\ + \ are allocated to different\n nodes to maximize availability.\n\ndata_virtual_hard_disks:\n\ + \ Contains the parameters Windows Azure uses to create a data disk\n for a\ + \ virtual machine.\n\nrole_size:\n The size of the virtual machine to allocate.\ + \ The default value is\n Small. Possible values are: ExtraSmall,Small,Medium,Large,\n\ + \ ExtraLarge,A5,A6,A7,A8,A9,Basic_A0,Basic_A1,Basic_A2,Basic_A3,\n Basic_A4,Standard_D1,Standard_D2,Standard_D3,Standard_D4,\n\ + \ Standard_D11,Standard_D12,Standard_D13,Standard_D14,Standard_G1,\n Standard_G2,Sandard_G3,Standard_G4,Standard_G5.\ + \ The specified\n value must be compatible with the disk selected in the\n \ + \ OSVirtualHardDisk values.\n\nrole_type:\n The type of the role for the virtual\ + \ machine. The only supported\n value is PersistentVMRole.\n\nvirtual_network_name:\n\ + \ Specifies the name of an existing virtual network to which the\n deployment\ + \ will belong.\n\nresource_extension_references:\n Optional. Contains a collection\ + \ of resource extensions that are to\n be installed on the Virtual Machine.\ + \ This element is used if\n provision_guest_agent is set to True. Use an iterable\ + \ of instances\n of ResourceExtensionReference.\n\nprovision_guest_agent:\n\ + \ Optional. Indicates whether the VM Agent is installed on the\n Virtual Machine.\ + \ To run a resource extension in a Virtual Machine,\n this service must be installed.\n\ + \nvm_image_name:\n Optional. Specifies the name of the VM Image that is to be\ + \ used to\n create the Virtual Machine. If this is specified, the\n system_config\ + \ and network_config parameters are not used.\n\nmedia_location:\n Optional.\ + \ Required if the Virtual Machine is being created from a\n published VM Image.\ + \ Specifies the location of the VHD file that is\n created when VMImageName\ + \ specifies a published VM Image.\n\ndns_servers:\n Optional. List of DNS servers\ + \ (use DnsServer class) to associate\n with the Virtual Machine.\n\nreserved_ip_name:\n\ + \ Optional. Specifies the name of a reserved IP address that is to be\n assigned\ + \ to the deployment. You must run create_reserved_ip_address\n before you can\ + \ assign the address to the deployment using this\n element." + signature: create_virtual_machine_deployment(service_name, deployment_name, deployment_slot, + label, role_name, system_config, os_virtual_hard_disk, network_config=None, availability_set_name=None, + data_virtual_hard_disks=None, role_size=None, role_type='PersistentVMRole', virtual_network_name=None, + resource_extension_references=None, provision_guest_agent=None, vm_image_name=None, + media_location=None, dns_servers=None, reserved_ip_name=None) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: deployment_slot + isRequired: true + - name: label + isRequired: true + - name: role_name + isRequired: true + - name: system_config + isRequired: true + - name: os_virtual_hard_disk + isRequired: true + - name: network_config + defaultValue: None + - name: availability_set_name + defaultValue: None + - name: data_virtual_hard_disks + defaultValue: None + - name: role_size + defaultValue: None + - name: role_type + defaultValue: PersistentVMRole + - name: virtual_network_name + defaultValue: None + - name: resource_extension_references + defaultValue: None + - name: provision_guest_agent + defaultValue: None + - name: vm_image_name + defaultValue: None + - name: media_location + defaultValue: None + - name: dns_servers + defaultValue: None + - name: reserved_ip_name + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.create_vm_image + name: create_vm_image + summary: "Creates a VM Image in the image repository that is associated with the\n\ + specified subscription using a specified set of virtual hard disks.\n\nvm_image:\n\ + \ An instance of VMImage class.\n\nvm_image.name: Required. Specifies the name\ + \ of the image.\nvm_image.label: Required. Specifies an identifier for the image.\n\ + vm_image.description: Optional. Specifies the description of the image.\nvm_image.os_disk_configuration:\n\ + \n Required. Specifies configuration information for the operating\n system\ + \ disk that is associated with the image.\n\nvm_image.os_disk_configuration.host_caching:\n\ + \ Optional. Specifies the caching behavior of the operating system disk.\n \ + \ Possible values are: None, ReadOnly, ReadWrite\n\nvm_image.os_disk_configuration.os_state:\n\ + \ Required. Specifies the state of the operating system in the image.\n Possible\ + \ values are: Generalized, Specialized\n A Virtual Machine that is fully configured\ + \ and running contains a\n Specialized operating system. A Virtual Machine on\ + \ which the\n Sysprep command has been run with the generalize option contains\ + \ a\n Generalized operating system.\n\nvm_image.os_disk_configuration.os:\n\ + \ Required. Specifies the operating system type of the image.\n\nvm_image.os_disk_configuration.media_link:\n\ + \ Required. Specifies the location of the blob in Windows Azure\n storage.\ + \ The blob location belongs to a storage account in the\n subscription specified\ + \ by the value in the\n operation call.\n\nvm_image.data_disk_configurations:\n\ + \ Optional. Specifies configuration information for the data disks\n that\ + \ are associated with the image. A VM Image might not have data\n disks associated\ + \ with it.\n\nvm_image.data_disk_configurations[].host_caching:\n Optional.\ + \ Specifies the caching behavior of the data disk.\n Possible values are: None,\ + \ ReadOnly, ReadWrite\n\nvm_image.data_disk_configurations[].lun:\n Optional\ + \ if the lun for the disk is 0. Specifies the Logical Unit\n Number (LUN) for\ + \ the data disk.\n\nvm_image.data_disk_configurations[].media_link:\n Required.\ + \ Specifies the location of the blob in Windows Azure\n storage. The blob location\ + \ belongs to a storage account in the\n subscription specified by the \ + \ value in the\n operation call.\n\nvm_image.data_disk_configurations[].logical_size_in_gb:\n\ + \ Required. Specifies the size, in GB, of the data disk.\n\nvm_image.language:\ + \ Optional. Specifies the language of the image.\nvm_image.image_family:\n\n \ + \ Optional. Specifies a value that can be used to group VM Images.\n\nvm_image.recommended_vm_size:\n\ + \ Optional. Specifies the size to use for the Virtual Machine that\n is created\ + \ from the VM Image.\n\nvm_image.eula:\n Optional. Specifies the End User License\ + \ Agreement that is\n associated with the image. The value for this element\ + \ is a string,\n but it is recommended that the value be a URL that points to\ + \ a EULA.\n\nvm_image.icon_uri:\n Optional. Specifies the URI to the icon that\ + \ is displayed for the\n image in the Management Portal.\n\nvm_image.small_icon_uri:\n\ + \ Optional. Specifies the URI to the small icon that is displayed for\n the\ + \ image in the Management Portal.\n\nvm_image.privacy_uri:\n Optional. Specifies\ + \ the URI that points to a document that contains\n the privacy policy related\ + \ to the image.\n\nvm_image.published_date:\n Optional. Specifies the date when\ + \ the image was added to the image\n repository.\n\nvm_image.show_in_gui:\n\ + \ Optional. Indicates whether the VM Images should be listed in the\n portal." + signature: create_vm_image(vm_image) + parameters: + - name: vm_image + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.delete_affinity_group + name: delete_affinity_group + summary: "Deletes an affinity group in the specified subscription.\n\naffinity_group_name:\n\ + \ The name of the affinity group." + signature: delete_affinity_group(affinity_group_name) + parameters: + - name: affinity_group_name + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.delete_data_disk + name: delete_data_disk + summary: "Removes the specified data disk from a virtual machine.\n\nservice_name:\n\ + \ The name of the service.\n\ndeployment_name:\n The name of the deployment.\n\ + \nrole_name:\n The name of the role.\n\nlun:\n The Logical Unit Number (LUN)\ + \ for the disk.\n\ndelete_vhd:\n Deletes the underlying vhd blob in Azure storage." + signature: delete_data_disk(service_name, deployment_name, role_name, lun, delete_vhd=False) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: role_name + isRequired: true + - name: lun + isRequired: true + - name: delete_vhd + defaultValue: 'False' +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.delete_deployment + name: delete_deployment + summary: "Deletes the specified deployment.\n\nservice_name:\n Name of the hosted\ + \ service.\n\ndeployment_name:\n The name of the deployment." + signature: delete_deployment(service_name, deployment_name, delete_vhd=False) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: delete_vhd + defaultValue: 'False' +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.delete_disk + name: delete_disk + summary: "Deletes the specified data or operating system disk from your image\n\ + repository.\n\ndisk_name:\n The name of the disk to delete.\n\ndelete_vhd:\n\ + \ Deletes the underlying vhd blob in Azure storage." + signature: delete_disk(disk_name, delete_vhd=False) + parameters: + - name: disk_name + isRequired: true + - name: delete_vhd + defaultValue: 'False' +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.delete_dns_server + name: delete_dns_server + summary: "Deletes a DNS server from a deployment.\n\nservice_name:\n The name\ + \ of the service.\n\ndeployment_name:\n The name of the deployment.\n\ndns_server_name:\n\ + \ Name of the DNS server that you want to delete." + signature: delete_dns_server(service_name, deployment_name, dns_server_name) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: dns_server_name + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.delete_hosted_service + name: delete_hosted_service + summary: "Deletes the specified hosted service from Windows Azure.\n\nservice_name:\n\ + \ Name of the hosted service.\n\ncomplete:\n True if all OS/data disks and\ + \ the source blobs for the disks should\n also be deleted from storage." + signature: delete_hosted_service(service_name, complete=False) + parameters: + - name: service_name + isRequired: true + - name: complete + defaultValue: 'False' +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.delete_management_certificate + name: delete_management_certificate + summary: "The Delete Management Certificate operation deletes a certificate from\n\ + the list of management certificates. Management certificates, which\nare also\ + \ known as subscription certificates, authenticate clients\nattempting to connect\ + \ to resources associated with your Windows Azure\nsubscription.\n\nthumbprint:\n\ + \ The thumb print that uniquely identifies the management\n certificate." + signature: delete_management_certificate(thumbprint) + parameters: + - name: thumbprint + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.delete_os_image + name: delete_os_image + summary: "Deletes the specified OS image from your image repository.\n\nimage_name:\n\ + \ The name of the image.\n\ndelete_vhd:\n Deletes the underlying vhd blob\ + \ in Azure storage." + signature: delete_os_image(image_name, delete_vhd=False) + parameters: + - name: image_name + isRequired: true + - name: delete_vhd + defaultValue: 'False' +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.delete_reserved_ip_address + name: delete_reserved_ip_address + summary: "Deletes a reserved IP address from the specified subscription.\n\nname:\n\ + \ Required. Name of the reserved IP address." + signature: delete_reserved_ip_address(name) + parameters: + - name: name + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.delete_role + name: delete_role + summary: "Deletes the specified virtual machine.\n\nservice_name:\n The name of\ + \ the service.\n\ndeployment_name:\n The name of the deployment.\n\nrole_name:\n\ + \ The name of the role.\n\ncomplete:\n True if all OS/data disks and the source\ + \ blobs for the disks should\n also be deleted from storage." + signature: delete_role(service_name, deployment_name, role_name, complete=False) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: role_name + isRequired: true + - name: complete + defaultValue: 'False' +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.delete_role_instances + name: delete_role_instances + summary: "Reinstalls the operating system on instances of web roles or worker\n\ + roles and initializes the storage resources that are used by them. If\nyou do\ + \ not want to initialize storage resources, you can use\nreimage_role_instance.\n\ + \nservice_name:\n Name of the hosted service.\n\ndeployment_name:\n The name\ + \ of the deployment.\n\nrole_instance_names:\n List of role instance names." + signature: delete_role_instances(service_name, deployment_name, role_instance_names) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: role_instance_names + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.delete_service_certificate + name: delete_service_certificate + summary: "Deletes a service certificate from the certificate store of a hosted\n\ + service.\n\nservice_name:\n Name of the hosted service.\n\nthumbalgorithm:\n\ + \ The algorithm for the certificate's thumbprint.\n\nthumbprint:\n The hexadecimal\ + \ representation of the thumbprint." + signature: delete_service_certificate(service_name, thumbalgorithm, thumbprint) + parameters: + - name: service_name + isRequired: true + - name: thumbalgorithm + isRequired: true + - name: thumbprint + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.delete_storage_account + name: delete_storage_account + summary: "Deletes the specified storage account from Windows Azure.\n\nservice_name:\n\ + \ Name of the storage service account." + signature: delete_storage_account(service_name) + parameters: + - name: service_name + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.delete_vm_image + name: delete_vm_image + summary: "Deletes the specified VM Image from the image repository that is\nassociated\ + \ with the specified subscription.\n\nvm_image_name:\n The name of the image.\n\ + \ndelete_vhd:\n Deletes the underlying vhd blob in Azure storage." + signature: delete_vm_image(vm_image_name, delete_vhd=False) + parameters: + - name: vm_image_name + isRequired: true + - name: delete_vhd + defaultValue: 'False' +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.disassociate_reserved_ip_address + name: disassociate_reserved_ip_address + summary: "Disassociate an existing reservedIP from the given deployment.\n\nname:\n\ + \ Required. Name of the reserved IP address.\n\nservice_name:\n Required.\ + \ Name of the hosted service.\n\ndeployment_name:\n Required. Name of the deployment.\n\ + \nvirtual_ip_name:\n Optional. Name of the VirtualIP in case of multi Vip tenant.\n\ + \ If this value is not specified default virtualIP is used\n for this operation." + signature: disassociate_reserved_ip_address(name, service_name, deployment_name, + virtual_ip_name=None) + parameters: + - name: name + isRequired: true + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: virtual_ip_name + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.get_affinity_group_properties + name: get_affinity_group_properties + summary: "Returns the system properties associated with the specified affinity\n\ + group.\n\naffinity_group_name:\n The name of the affinity group." + signature: get_affinity_group_properties(affinity_group_name) + parameters: + - name: affinity_group_name + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.get_data_disk + name: get_data_disk + summary: "Retrieves the specified data disk from a virtual machine.\n\nservice_name:\n\ + \ The name of the service.\n\ndeployment_name:\n The name of the deployment.\n\ + \nrole_name:\n The name of the role.\n\nlun:\n The Logical Unit Number (LUN)\ + \ for the disk." + signature: get_data_disk(service_name, deployment_name, role_name, lun) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: role_name + isRequired: true + - name: lun + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.get_deployment_by_name + name: get_deployment_by_name + summary: "Returns configuration information, status, and system properties for a\n\ + deployment.\n\nservice_name:\n Name of the hosted service.\n\ndeployment_name:\n\ + \ The name of the deployment." + signature: get_deployment_by_name(service_name, deployment_name) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.get_deployment_by_slot + name: get_deployment_by_slot + summary: "Returns configuration information, status, and system properties for\n\ + a deployment.\n\nservice_name:\n Name of the hosted service.\n\ndeployment_slot:\n\ + \ The environment to which the hosted service is deployed. Valid\n values\ + \ are: staging, production" + signature: get_deployment_by_slot(service_name, deployment_slot) + parameters: + - name: service_name + isRequired: true + - name: deployment_slot + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.get_disk + name: get_disk + summary: Retrieves a disk from your image repository. + signature: get_disk(disk_name) + parameters: + - name: disk_name + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.get_hosted_service_properties + name: get_hosted_service_properties + summary: "Retrieves system properties for the specified hosted service. These\n\ + properties include the service name and service type; the name of the\naffinity\ + \ group to which the service belongs, or its location if it is\nnot part of an\ + \ affinity group; and optionally, information on the\nservice's deployments.\n\ + \nservice_name:\n Name of the hosted service.\n\nembed_detail:\n When True,\ + \ the management service returns properties for all\n deployments of the service,\ + \ as well as for the service itself." + signature: get_hosted_service_properties(service_name, embed_detail=False) + parameters: + - name: service_name + isRequired: true + - name: embed_detail + defaultValue: 'False' +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.get_management_certificate + name: get_management_certificate + summary: "The Get Management Certificate operation retrieves information about\n\ + the management certificate with the specified thumbprint. Management\ncertificates,\ + \ which are also known as subscription certificates,\nauthenticate clients attempting\ + \ to connect to resources associated\nwith your Windows Azure subscription.\n\n\ + thumbprint:\n The thumbprint value of the certificate." + signature: get_management_certificate(thumbprint) + parameters: + - name: thumbprint + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.get_operation_status + name: get_operation_status + summary: "Returns the status of the specified operation. After calling an\nasynchronous\ + \ operation, you can call Get Operation Status to determine\nwhether the operation\ + \ has succeeded, failed, or is still in progress.\n\nrequest_id:\n The request\ + \ ID for the request you wish to track." + signature: get_operation_status(request_id) + parameters: + - name: request_id + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.get_os_image + name: get_os_image + summary: Retrieves an OS image from the image repository. + signature: get_os_image(image_name) + parameters: + - name: image_name + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.get_os_image_details + name: get_os_image_details + summary: 'Retrieves an OS image from the image repository, including replication + + progress.' + signature: get_os_image_details(image_name) + parameters: + - name: image_name + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.get_reserved_ip_address + name: get_reserved_ip_address + summary: "Retrieves information about the specified reserved IP address.\n\nname:\n\ + \ Required. Name of the reserved IP address." + signature: get_reserved_ip_address(name) + parameters: + - name: name + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.get_role + name: get_role + summary: "Retrieves the specified virtual machine.\n\nservice_name:\n The name\ + \ of the service.\n\ndeployment_name:\n The name of the deployment.\n\nrole_name:\n\ + \ The name of the role." + signature: get_role(service_name, deployment_name, role_name) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: role_name + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.get_service_certificate + name: get_service_certificate + summary: "Returns the public data for the specified X.509 certificate associated\n\ + with a hosted service.\n\nservice_name:\n Name of the hosted service.\n\nthumbalgorithm:\n\ + \ The algorithm for the certificate's thumbprint.\n\nthumbprint:\n The hexadecimal\ + \ representation of the thumbprint." + signature: get_service_certificate(service_name, thumbalgorithm, thumbprint) + parameters: + - name: service_name + isRequired: true + - name: thumbalgorithm + isRequired: true + - name: thumbprint + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.get_storage_account_keys + name: get_storage_account_keys + summary: "Returns the primary and secondary access keys for the specified\nstorage\ + \ account.\n\nservice_name:\n Name of the storage service account." + signature: get_storage_account_keys(service_name) + parameters: + - name: service_name + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.get_storage_account_properties + name: get_storage_account_properties + summary: "Returns system properties for the specified storage account.\n\nservice_name:\n\ + \ Name of the storage service account." + signature: get_storage_account_properties(service_name) + parameters: + - name: service_name + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.get_subscription + name: get_subscription + summary: 'Returns account and resource allocation information on the specified + + subscription.' + signature: get_subscription() +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.list_affinity_groups + name: list_affinity_groups + summary: Lists the affinity groups associated with the specified subscription. + signature: list_affinity_groups() +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.list_disks + name: list_disks + summary: Retrieves a list of the disks in your image repository. + signature: list_disks() +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.list_hosted_services + name: list_hosted_services + summary: 'Lists the hosted services available under the current subscription. + + + Note that you will receive a list of HostedService instances, without + + all details inside. For instance, deployments will be None. If you + + want deployments information for a specific host service, you have to + + call get_hosted_service_properties with embed_detail=True.' + signature: list_hosted_services() +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.list_locations + name: list_locations + summary: 'Lists all of the data center locations that are valid for your + + subscription.' + signature: list_locations() +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.list_management_certificates + name: list_management_certificates + summary: 'The List Management Certificates operation lists and returns basic + + information about all of the management certificates associated with + + the specified subscription. Management certificates, which are also + + known as subscription certificates, authenticate clients attempting to + + connect to resources associated with your Windows Azure subscription.' + signature: list_management_certificates() +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.list_operating_system_families + name: list_operating_system_families + summary: 'Lists the guest operating system families available in Windows Azure, + + and also lists the operating system versions available for each family.' + signature: list_operating_system_families() +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.list_operating_systems + name: list_operating_systems + summary: 'Lists the versions of the guest operating system that are currently + + available in Windows Azure.' + signature: list_operating_systems() +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.list_os_images + name: list_os_images + summary: Retrieves a list of the OS images from the image repository. + signature: list_os_images() +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.list_reserved_ip_addresses + name: list_reserved_ip_addresses + summary: 'Lists the IP addresses that have been reserved for the specified + + subscription.' + signature: list_reserved_ip_addresses() +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.list_resource_extension_versions + name: list_resource_extension_versions + summary: "Lists the versions of a resource extension that are available to add\n\ + to a Virtual Machine.\n\npublisher_name:\n Name of the resource extension publisher.\n\ + \nextension_name:\n Name of the resource extension." + signature: list_resource_extension_versions(publisher_name, extension_name) + parameters: + - name: publisher_name + isRequired: true + - name: extension_name + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.list_resource_extensions + name: list_resource_extensions + summary: 'Lists the resource extensions that are available to add to a + + Virtual Machine.' + signature: list_resource_extensions() +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.list_role_sizes + name: list_role_sizes + summary: 'Lists the role sizes that are available under the specified + + subscription.' + signature: list_role_sizes() +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.list_service_certificates + name: list_service_certificates + summary: "Lists all of the service certificates associated with the specified\n\ + hosted service.\n\nservice_name:\n Name of the hosted service." + signature: list_service_certificates(service_name) + parameters: + - name: service_name + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.list_storage_accounts + name: list_storage_accounts + summary: Lists the storage accounts available under the current subscription. + signature: list_storage_accounts() +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.list_subscription_operations + name: list_subscription_operations + summary: 'List subscription operations. + + + start_time: Required. An ISO8601 date. + + end_time: Required. An ISO8601 date. + + object_id_filter: Optional. Returns subscription operations only for the specified + object type and object ID + + operation_result_filter: Optional. Returns subscription operations only for the + specified result status, either Succeeded, Failed, or InProgress. + + continuation_token: Optional. + + More information at: + + [https://msdn.microsoft.com/en-us/library/azure/gg715318.aspx](https://msdn.microsoft.com/en-us/library/azure/gg715318.aspx)' + signature: list_subscription_operations(start_time=None, end_time=None, object_id_filter=None, + operation_result_filter=None, continuation_token=None) + parameters: + - name: start_time + defaultValue: None + - name: end_time + defaultValue: None + - name: object_id_filter + defaultValue: None + - name: operation_result_filter + defaultValue: None + - name: continuation_token + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.list_subscriptions + name: list_subscriptions + summary: 'Returns a list of subscriptions that you can access. + + + You must make sure that the request that is made to the management + + service is secure using an Active Directory access token.' + signature: list_subscriptions() +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.list_virtual_network_sites + name: list_virtual_network_sites + summary: Retrieves a list of the virtual networks. + signature: list_virtual_network_sites() +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.list_vm_images + name: list_vm_images + summary: 'Retrieves a list of the VM Images from the image repository that is + + associated with the specified subscription.' + signature: list_vm_images(location=None, publisher=None, category=None) + parameters: + - name: location + defaultValue: None + - name: publisher + defaultValue: None + - name: category + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.perform_delete + name: perform_delete + summary: "Performs a DELETE request and returns the response.\n\npath:\n Path\ + \ to the resource.\n Ex: '//services/hostedservices/'\n\ + \nx_ms_version:\n If specified, this is used for the x-ms-version header.\n\ + \ Otherwise, self.x_ms_version is used." + signature: perform_delete(path, x_ms_version=None) + parameters: + - name: path + isRequired: true + - name: x_ms_version + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.perform_get + name: perform_get + summary: "Performs a GET request and returns the response.\n\npath:\n Path to\ + \ the resource.\n Ex: '//services/hostedservices/'\n\ + \nx_ms_version:\n If specified, this is used for the x-ms-version header.\n\ + \ Otherwise, self.x_ms_version is used." + signature: perform_get(path, x_ms_version=None) + parameters: + - name: path + isRequired: true + - name: x_ms_version + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.perform_post + name: perform_post + summary: "Performs a POST request and returns the response.\n\npath:\n Path to\ + \ the resource.\n Ex: '//services/hostedservices/'\n\ + \nbody:\n Body for the POST request.\n\nx_ms_version:\n If specified, this\ + \ is used for the x-ms-version header.\n Otherwise, self.x_ms_version is used." + signature: perform_post(path, body, x_ms_version=None) + parameters: + - name: path + isRequired: true + - name: body + isRequired: true + - name: x_ms_version + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.perform_put + name: perform_put + summary: "Performs a PUT request and returns the response.\n\npath:\n Path to\ + \ the resource.\n Ex: '//services/hostedservices/'\n\ + \nbody:\n Body for the PUT request.\n\nx_ms_version:\n If specified, this\ + \ is used for the x-ms-version header.\n Otherwise, self.x_ms_version is used." + signature: perform_put(path, body, x_ms_version=None) + parameters: + - name: path + isRequired: true + - name: body + isRequired: true + - name: x_ms_version + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.reboot_role_instance + name: reboot_role_instance + summary: "Requests a reboot of a role instance that is running in a deployment.\n\ + \nservice_name:\n Name of the hosted service.\n\ndeployment_name:\n The name\ + \ of the deployment.\n\nrole_instance_name:\n The name of the role instance." + signature: reboot_role_instance(service_name, deployment_name, role_instance_name) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: role_instance_name + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.rebuild_role_instance + name: rebuild_role_instance + summary: "Reinstalls the operating system on instances of web roles or worker\n\ + roles and initializes the storage resources that are used by them. If\nyou do\ + \ not want to initialize storage resources, you can use\nreimage_role_instance.\n\ + \nservice_name:\n Name of the hosted service.\n\ndeployment_name:\n The name\ + \ of the deployment.\n\nrole_instance_name:\n The name of the role instance." + signature: rebuild_role_instance(service_name, deployment_name, role_instance_name) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: role_instance_name + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.regenerate_storage_account_keys + name: regenerate_storage_account_keys + summary: "Regenerates the primary or secondary access key for the specified\nstorage\ + \ account.\n\nservice_name:\n Name of the storage service account.\n\nkey_type:\n\ + \ Specifies which key to regenerate. Valid values are:\n Primary, Secondary" + signature: regenerate_storage_account_keys(service_name, key_type) + parameters: + - name: service_name + isRequired: true + - name: key_type + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.reimage_role_instance + name: reimage_role_instance + summary: "Requests a reimage of a role instance that is running in a deployment.\n\ + \nservice_name:\n Name of the hosted service.\n\ndeployment_name:\n The name\ + \ of the deployment.\n\nrole_instance_name:\n The name of the role instance." + signature: reimage_role_instance(service_name, deployment_name, role_instance_name) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: role_instance_name + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.replicate_vm_image + name: replicate_vm_image + summary: "Replicate a VM image to multiple target locations. This operation\nis\ + \ only for publishers. You have to be registered as image publisher\nwith Microsoft\ + \ Azure to be able to call this.\n\nvm_image_name:\n Specifies the name of the\ + \ VM Image that is to be used for\n replication\n\nregions:\n Specified a\ + \ list of regions to replicate the image to\n Note: The regions in the request\ + \ body are not additive. If a VM\n Image has already been replicated to Regions\ + \ A, B, and C, and\n a request is made to replicate to Regions A and D, the\ + \ VM\n Image will remain in Region A, will be replicated in Region D,\n and\ + \ will be unreplicated from Regions B and C\n\noffer:\n Specifies the publisher\ + \ defined name of the offer. The allowed\n characters are uppercase or lowercase\ + \ letters, digit,\n hyphen(-), period (.).The maximum allowed length is 64 characters.\n\ + \nsku:\n Specifies the publisher defined name of the Sku. The allowed\n characters\ + \ are uppercase or lowercase letters, digit,\n hyphen(-), period (.). The maximum\ + \ allowed length is 64 characters.\n\nversion:\n Specifies the publisher defined\ + \ version of the image.\n The allowed characters are digit and period.\n Format:\ + \ ..\n Example: '1.0.0' or '1.1.0' The 3\ + \ version number to\n follow standard of most of the RPs. See [http://semver.org](http://semver.org)" + signature: replicate_vm_image(vm_image_name, regions, offer, sku, version) + parameters: + - name: vm_image_name + isRequired: true + - name: regions + isRequired: true + - name: offer + isRequired: true + - name: sku + isRequired: true + - name: version + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.restart_role + name: restart_role + summary: "Restarts the specified virtual machine.\n\nservice_name:\n The name\ + \ of the service.\n\ndeployment_name:\n The name of the deployment.\n\nrole_name:\n\ + \ The name of the role." + signature: restart_role(service_name, deployment_name, role_name) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: role_name + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.rollback_update_or_upgrade + name: rollback_update_or_upgrade + summary: "Cancels an in progress configuration change (update) or upgrade and\n\ + returns the deployment to its state before the upgrade or\nconfiguration change\ + \ was started.\n\nservice_name:\n Name of the hosted service.\n\ndeployment_name:\n\ + \ The name of the deployment.\n\nmode:\n Specifies whether the rollback should\ + \ proceed automatically.\n auto - The rollback proceeds without further user\ + \ input.\n manual - You must call the Walk Upgrade Domain operation to\n\n\ + \ apply the rollback to each upgrade domain.\n\nforce:\n Specifies whether\ + \ the rollback should proceed even when it will\n cause local data to be lost\ + \ from some role instances. True if the\n rollback should proceed; otherwise\ + \ false if the rollback should\n fail." + signature: rollback_update_or_upgrade(service_name, deployment_name, mode, force) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: mode + isRequired: true + - name: force + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.set_proxy + name: set_proxy + summary: "Sets the proxy server host and port for the HTTP CONNECT Tunnelling.\n\ + \nhost:\n Address of the proxy. Ex: '192.168.0.100'\n\nport:\n Port of the\ + \ proxy. Ex: 6000\n\nuser:\n User for proxy authorization.\n\npassword:\n \ + \ Password for proxy authorization." + signature: set_proxy(host, port, user=None, password=None) + parameters: + - name: host + isRequired: true + - name: port + isRequired: true + - name: user + defaultValue: None + - name: password + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.share_vm_image + name: share_vm_image + summary: "Share an already replicated OS image. This operation is only for\npublishers.\ + \ You have to be registered as image publisher with Windows\nAzure to be able\ + \ to call this.\n\nvm_image_name:\n The name of the virtual machine image to\ + \ share\n\npermission:\n The sharing permission: public, msdn, or private" + signature: share_vm_image(vm_image_name, permission) + parameters: + - name: vm_image_name + isRequired: true + - name: permission + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.should_use_requests + name: should_use_requests + signature: static should_use_requests(cert_file) + parameters: + - name: cert_file + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.shutdown_role + name: shutdown_role + summary: "Shuts down the specified virtual machine.\n\nservice_name:\n The name\ + \ of the service.\n\ndeployment_name:\n The name of the deployment.\n\nrole_name:\n\ + \ The name of the role.\n\npost_shutdown_action:\n Specifies how the Virtual\ + \ Machine should be shut down. Values are:\n Stopped\n Shuts down\ + \ the Virtual Machine but retains the compute\n resources. You will continue\ + \ to be billed for the resources\n that the stopped machine uses.\n\n\ + \ StoppedDeallocated\n Shuts down the Virtual Machine and releases\ + \ the compute\n resources. You are not billed for the compute resources\ + \ that\n this Virtual Machine uses. If a static Virtual Network IP\n \ + \ address is assigned to the Virtual Machine, it is reserved." + signature: shutdown_role(service_name, deployment_name, role_name, post_shutdown_action='Stopped') + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: role_name + isRequired: true + - name: post_shutdown_action + defaultValue: Stopped +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.shutdown_roles + name: shutdown_roles + summary: "Shuts down the specified virtual machines.\n\nservice_name:\n The name\ + \ of the service.\n\ndeployment_name:\n The name of the deployment.\n\nrole_names:\n\ + \ The names of the roles, as an enumerable of strings.\n\npost_shutdown_action:\n\ + \ Specifies how the Virtual Machine should be shut down. Values are:\n \ + \ Stopped\n Shuts down the Virtual Machine but retains the compute\n \ + \ resources. You will continue to be billed for the resources\n \ + \ that the stopped machine uses.\n\n StoppedDeallocated\n Shuts\ + \ down the Virtual Machine and releases the compute\n resources. You are\ + \ not billed for the compute resources that\n this Virtual Machine uses.\ + \ If a static Virtual Network IP\n address is assigned to the Virtual\ + \ Machine, it is reserved." + signature: shutdown_roles(service_name, deployment_name, role_names, post_shutdown_action='Stopped') + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: role_names + isRequired: true + - name: post_shutdown_action + defaultValue: Stopped +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.start_role + name: start_role + summary: "Starts the specified virtual machine.\n\nservice_name:\n The name of\ + \ the service.\n\ndeployment_name:\n The name of the deployment.\n\nrole_name:\n\ + \ The name of the role." + signature: start_role(service_name, deployment_name, role_name) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: role_name + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.start_roles + name: start_roles + summary: "Starts the specified virtual machines.\n\nservice_name:\n The name of\ + \ the service.\n\ndeployment_name:\n The name of the deployment.\n\nrole_names:\n\ + \ The names of the roles, as an enumerable of strings." + signature: start_roles(service_name, deployment_name, role_names) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: role_names + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.swap_deployment + name: swap_deployment + summary: "Initiates a virtual IP swap between the staging and production\ndeployment\ + \ environments for a service. If the service is currently\nrunning in the staging\ + \ environment, it will be swapped to the\nproduction environment. If it is running\ + \ in the production\nenvironment, it will be swapped to staging.\n\nservice_name:\n\ + \ Name of the hosted service.\n\nproduction:\n The name of the production\ + \ deployment.\n\nsource_deployment:\n The name of the source deployment." + signature: swap_deployment(service_name, production, source_deployment) + parameters: + - name: service_name + isRequired: true + - name: production + isRequired: true + - name: source_deployment + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.unreplicate_vm_image + name: unreplicate_vm_image + summary: "Unreplicate a VM image from all regions This operation\nis only for publishers.\ + \ You have to be registered as image publisher\nwith Microsoft Azure to be able\ + \ to call this\n\nvm_image_name:\n Specifies the name of the VM Image that is\ + \ to be used for\n unreplication. The VM Image Name should be the user VM Image,\n\ + \ not the published name of the VM Image." + signature: unreplicate_vm_image(vm_image_name) + parameters: + - name: vm_image_name + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.update_affinity_group + name: update_affinity_group + summary: "Updates the label and/or the description for an affinity group for the\n\ + specified subscription.\n\naffinity_group_name:\n The name of the affinity group.\n\ + \nlabel:\n A name for the affinity group. The name can be up to 100 characters\n\ + \ in length.\n\ndescription:\n A description for the affinity group. The description\ + \ can be up to\n 1024 characters in length." + signature: update_affinity_group(affinity_group_name, label, description=None) + parameters: + - name: affinity_group_name + isRequired: true + - name: label + isRequired: true + - name: description + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.update_data_disk + name: update_data_disk + summary: "Updates the specified data disk attached to the specified virtual\nmachine.\n\ + \nservice_name:\n The name of the service.\n\ndeployment_name:\n The name\ + \ of the deployment.\n\nrole_name:\n The name of the role.\n\nlun:\n Specifies\ + \ the Logical Unit Number (LUN) for the disk. The LUN\n specifies the slot in\ + \ which the data drive appears when mounted\n for usage by the virtual machine.\ + \ Valid LUN values are 0 through\n 15.\n\nhost_caching:\n Specifies the platform\ + \ caching behavior of data disk blob for\n read/write efficiency. The default\ + \ vault is ReadOnly. Possible\n values are: None, ReadOnly, ReadWrite\n\nmedia_link:\n\ + \ Specifies the location of the blob in Windows Azure blob store\n where the\ + \ media for the disk is located. The blob location must\n belong to the storage\ + \ account in the subscription specified by\n the value in\ + \ the operation call. Example:\n [http://example.blob.core.windows.net/disks/mydisk.vhd](http://example.blob.core.windows.net/disks/mydisk.vhd)\n\ + \nupdated_lun:\n Specifies the Logical Unit Number (LUN) for the disk. The LUN\n\ + \ specifies the slot in which the data drive appears when mounted\n for usage\ + \ by the virtual machine. Valid LUN values are 0 through 15.\n\ndisk_label:\n\ + \ Specifies the description of the data disk. When you attach a disk,\n either\ + \ by directly referencing a media using the MediaLink element\n or specifying\ + \ the target disk size, you can use the DiskLabel\n element to customize the\ + \ name property of the target data disk.\n\ndisk_name:\n Specifies the name\ + \ of the disk. Windows Azure uses the specified\n disk to create the data disk\ + \ for the machine and populates this\n field with the disk name.\n\nlogical_disk_size_in_gb:\n\ + \ Specifies the size, in GB, of an empty disk to be attached to the\n role.\ + \ The disk can be created as part of disk attach or create VM\n role call by\ + \ specifying the value for this property. Windows Azure\n creates the empty\ + \ disk based on size preference and attaches the\n newly created disk to the\ + \ Role." + signature: update_data_disk(service_name, deployment_name, role_name, lun, host_caching=None, + media_link=None, updated_lun=None, disk_label=None, disk_name=None, logical_disk_size_in_gb=None) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: role_name + isRequired: true + - name: lun + isRequired: true + - name: host_caching + defaultValue: None + - name: media_link + defaultValue: None + - name: updated_lun + defaultValue: None + - name: disk_label + defaultValue: None + - name: disk_name + defaultValue: None + - name: logical_disk_size_in_gb + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.update_deployment_status + name: update_deployment_status + summary: "Initiates a change in deployment status.\n\nservice_name:\n Name of\ + \ the hosted service.\n\ndeployment_name:\n The name of the deployment.\n\n\ + status:\n The change to initiate to the deployment status. Possible values\n\ + \ include:\n\n Running, Suspended" + signature: update_deployment_status(service_name, deployment_name, status) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: status + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.update_disk + name: update_disk + summary: "Updates an existing disk in your image repository.\n\ndisk_name:\n The\ + \ name of the disk to update.\n\nhas_operating_system:\n Deprecated.\n\nlabel:\n\ + \ Specifies the description of the disk.\n\nmedia_link:\n Deprecated.\n\n\ + name:\n Deprecated.\n\nos:\n Deprecated." + signature: update_disk(disk_name, has_operating_system=None, label=None, media_link=None, + name=None, os=None) + parameters: + - name: disk_name + isRequired: true + - name: has_operating_system + defaultValue: None + - name: label + defaultValue: None + - name: media_link + defaultValue: None + - name: name + defaultValue: None + - name: os + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.update_dns_server + name: update_dns_server + summary: "Updates the ip address of a DNS server.\n\nservice_name:\n The name\ + \ of the service.\n\ndeployment_name:\n The name of the deployment.\n\ndns_server_name:\n\ + \ Specifies the name of the DNS server.\n\naddress:\n Specifies the IP address\ + \ of the DNS server." + signature: update_dns_server(service_name, deployment_name, dns_server_name, address) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: dns_server_name + isRequired: true + - name: address + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.update_hosted_service + name: update_hosted_service + summary: "Updates the label and/or the description for a hosted service in\nWindows\ + \ Azure.\n\nservice_name:\n Name of the hosted service.\n\nlabel:\n A name\ + \ for the hosted service. The name may be up to 100 characters\n in length.\ + \ You must specify a value for either Label or\n Description, or for both. It\ + \ is recommended that the label be\n unique within the subscription. The name\ + \ can be used\n identify the hosted service for your tracking purposes.\n\n\ + description:\n A description for the hosted service. The description may be\ + \ up to\n 1024 characters in length. You must specify a value for either\n \ + \ Label or Description, or for both.\n\nextended_properties:\n Dictionary containing\ + \ name/value pairs of storage account\n properties. You can have a maximum of\ + \ 50 extended property\n name/value pairs. The maximum length of the Name element\ + \ is 64\n characters, only alphanumeric characters and underscores are valid\n\ + \ in the Name, and the name must start with a letter. The value has\n a maximum\ + \ length of 255 characters." + signature: update_hosted_service(service_name, label=None, description=None, extended_properties=None) + parameters: + - name: service_name + isRequired: true + - name: label + defaultValue: None + - name: description + defaultValue: None + - name: extended_properties + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.update_os_image + name: update_os_image + summary: "Updates an OS image that in your image repository.\n\nimage_name:\n \ + \ The name of the image to update.\n\nlabel:\n Specifies the friendly name of\ + \ the image to be updated. You cannot\n use this operation to update images\ + \ provided by the Windows Azure\n platform.\n\nmedia_link:\n Specifies the\ + \ location of the blob in Windows Azure blob store\n where the media for the\ + \ image is located. The blob location must\n belong to a storage account in\ + \ the subscription specified by the\n value in the operation\ + \ call. Example:\n [http://example.blob.core.windows.net/disks/mydisk.vhd](http://example.blob.core.windows.net/disks/mydisk.vhd)\n\ + \nname:\n Specifies a name for the OS image that Windows Azure uses to\n identify\ + \ the image when creating one or more VM Roles.\n\nos:\n The operating system\ + \ type of the OS image. Possible values are:\n Linux, Windows" + signature: update_os_image(image_name, label, media_link, name, os) + parameters: + - name: image_name + isRequired: true + - name: label + isRequired: true + - name: media_link + isRequired: true + - name: name + isRequired: true + - name: os + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.update_os_image_from_image_reference + name: update_os_image_from_image_reference + summary: "Updates metadata elements from a given OS image reference.\n\nimage_name:\n\ + \ The name of the image to update.\n\nos_image:\n An instance of OSImage class.\n\ + \nos_image.label: Optional. Specifies an identifier for the image.\nos_image.description:\ + \ Optional. Specifies the description of the image.\nos_image.language: Optional.\ + \ Specifies the language of the image.\nos_image.image_family:\n\n Optional.\ + \ Specifies a value that can be used to group VM Images.\n\nos_image.recommended_vm_size:\n\ + \ Optional. Specifies the size to use for the Virtual Machine that\n is created\ + \ from the VM Image.\n\nos_image.eula:\n Optional. Specifies the End User License\ + \ Agreement that is\n associated with the image. The value for this element\ + \ is a string,\n but it is recommended that the value be a URL that points to\ + \ a EULA.\n\nos_image.icon_uri:\n Optional. Specifies the URI to the icon that\ + \ is displayed for the\n image in the Management Portal.\n\nos_image.small_icon_uri:\n\ + \ Optional. Specifies the URI to the small icon that is displayed for\n the\ + \ image in the Management Portal.\n\nos_image.privacy_uri:\n Optional. Specifies\ + \ the URI that points to a document that contains\n the privacy policy related\ + \ to the image.\n\nos_image.published_date:\n Optional. Specifies the date when\ + \ the image was added to the image\n repository.\n\nos.image.media_link:\n \ + \ Required: Specifies the location of the blob in Windows Azure\n blob store\ + \ where the media for the image is located. The blob\n location must belong\ + \ to a storage account in the subscription\n specified by the \ + \ value in the operation call.\n Example:\n [http://example.blob.core.windows.net/disks/mydisk.vhd](http://example.blob.core.windows.net/disks/mydisk.vhd)\n\ + \nos_image.name:\n Specifies a name for the OS image that Windows Azure uses\ + \ to\n identify the image when creating one or more VM Roles.\n\nos_image.os:\n\ + \ The operating system type of the OS image. Possible values are:\n Linux,\ + \ Windows" + signature: update_os_image_from_image_reference(image_name, os_image) + parameters: + - name: image_name + isRequired: true + - name: os_image + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.update_role + name: update_role + summary: "Updates the specified virtual machine.\n\nservice_name:\n The name of\ + \ the service.\n\ndeployment_name:\n The name of the deployment.\n\nrole_name:\n\ + \ The name of the role.\n\nos_virtual_hard_disk:\n Contains the parameters\ + \ Windows Azure uses to create the operating\n system disk for the virtual machine.\n\ + \nnetwork_config:\n Encapsulates the metadata required to create the virtual\ + \ network\n configuration for a virtual machine. If you do not include a\n \ + \ network configuration set you will not be able to access the VM\n through\ + \ VIPs over the internet. If your virtual machine belongs to\n a virtual network\ + \ you can not specify which subnet address space\n it resides under.\n\navailability_set_name:\n\ + \ Specifies the name of an availability set to which to add the\n virtual\ + \ machine. This value controls the virtual machine allocation\n in the Windows\ + \ Azure environment. Virtual machines specified in the\n same availability set\ + \ are allocated to different nodes to maximize\n availability.\n\ndata_virtual_hard_disks:\n\ + \ Contains the parameters Windows Azure uses to create a data disk\n for a\ + \ virtual machine.\n\nrole_size:\n The size of the virtual machine to allocate.\ + \ The default value is\n Small. Possible values are: ExtraSmall, Small, Medium,\ + \ Large,\n ExtraLarge. The specified value must be compatible with the disk\n\ + \ selected in the OSVirtualHardDisk values.\n\nrole_type:\n The type of the\ + \ role for the virtual machine. The only supported\n value is PersistentVMRole.\n\ + \nresource_extension_references:\n Optional. Contains a collection of resource\ + \ extensions that are to\n be installed on the Virtual Machine. This element\ + \ is used if\n provision_guest_agent is set to True.\n\nprovision_guest_agent:\n\ + \ Optional. Indicates whether the VM Agent is installed on the\n Virtual Machine.\ + \ To run a resource extension in a Virtual Machine,\n this service must be installed." + signature: update_role(service_name, deployment_name, role_name, os_virtual_hard_disk=None, + network_config=None, availability_set_name=None, data_virtual_hard_disks=None, + role_size=None, role_type='PersistentVMRole', resource_extension_references=None, + provision_guest_agent=None) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: role_name + isRequired: true + - name: os_virtual_hard_disk + defaultValue: None + - name: network_config + defaultValue: None + - name: availability_set_name + defaultValue: None + - name: data_virtual_hard_disks + defaultValue: None + - name: role_size + defaultValue: None + - name: role_type + defaultValue: PersistentVMRole + - name: resource_extension_references + defaultValue: None + - name: provision_guest_agent + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.update_storage_account + name: update_storage_account + summary: "Updates the label, the description, and enables or disables the\ngeo-replication\ + \ status for a storage account in Windows Azure.\n\nservice_name:\n Name of\ + \ the storage service account.\n\ndescription:\n A description for the storage\ + \ account. The description may be up\n to 1024 characters in length.\n\nlabel:\n\ + \ A name for the storage account. The name may be up to 100\n characters in\ + \ length. The name can be used to identify the storage\n account for your tracking\ + \ purposes.\n\ngeo_replication_enabled:\n Deprecated. Replaced by the account_type\ + \ parameter.\n\nextended_properties:\n Dictionary containing name/value pairs\ + \ of storage account\n properties. You can have a maximum of 50 extended property\n\ + \ name/value pairs. The maximum length of the Name element is 64\n characters,\ + \ only alphanumeric characters and underscores are valid\n in the Name, and\ + \ the name must start with a letter. The value has\n a maximum length of 255\ + \ characters.\n\naccount_type:\n Specifies whether the account supports locally-redundant\ + \ storage,\n geo-redundant storage, zone-redundant storage, or read access\n\ + \ geo-redundant storage.\n Possible values are:\n\n Standard_LRS, Standard_ZRS,\ + \ Standard_GRS, Standard_RAGRS" + signature: update_storage_account(service_name, description=None, label=None, geo_replication_enabled=None, + extended_properties=None, account_type='Standard_GRS') + parameters: + - name: service_name + isRequired: true + - name: description + defaultValue: None + - name: label + defaultValue: None + - name: geo_replication_enabled + defaultValue: None + - name: extended_properties + defaultValue: None + - name: account_type + defaultValue: Standard_GRS +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.update_vm_image + name: update_vm_image + summary: "Updates a VM Image in the image repository that is associated with the\n\ + specified subscription.\n\nvm_image_name:\n Name of image to update.\n\nvm_image:\n\ + \ An instance of VMImage class.\n\nvm_image.label: Optional. Specifies an identifier\ + \ for the image.\nvm_image.os_disk_configuration:\n\n Required. Specifies configuration\ + \ information for the operating\n system disk that is associated with the image.\n\ + \nvm_image.os_disk_configuration.host_caching:\n Optional. Specifies the caching\ + \ behavior of the operating system disk.\n Possible values are: None, ReadOnly,\ + \ ReadWrite\n\nvm_image.data_disk_configurations:\n Optional. Specifies configuration\ + \ information for the data disks\n that are associated with the image. A VM\ + \ Image might not have data\n disks associated with it.\n\nvm_image.data_disk_configurations[].name:\n\ + \ Required. Specifies the name of the data disk.\n\nvm_image.data_disk_configurations[].host_caching:\n\ + \ Optional. Specifies the caching behavior of the data disk.\n Possible values\ + \ are: None, ReadOnly, ReadWrite\n\nvm_image.data_disk_configurations[].lun:\n\ + \ Optional if the lun for the disk is 0. Specifies the Logical Unit\n Number\ + \ (LUN) for the data disk.\n\nvm_image.description: Optional. Specifies the description\ + \ of the image.\nvm_image.language: Optional. Specifies the language of the image.\n\ + vm_image.image_family:\n\n Optional. Specifies a value that can be used to group\ + \ VM Images.\n\nvm_image.recommended_vm_size:\n Optional. Specifies the size\ + \ to use for the Virtual Machine that\n is created from the VM Image.\n\nvm_image.eula:\n\ + \ Optional. Specifies the End User License Agreement that is\n associated\ + \ with the image. The value for this element is a string,\n but it is recommended\ + \ that the value be a URL that points to a EULA.\n\nvm_image.icon_uri:\n Optional.\ + \ Specifies the URI to the icon that is displayed for the\n image in the Management\ + \ Portal.\n\nvm_image.small_icon_uri:\n Optional. Specifies the URI to the small\ + \ icon that is displayed for\n the image in the Management Portal.\n\nvm_image.privacy_uri:\n\ + \ Optional. Specifies the URI that points to a document that contains\n the\ + \ privacy policy related to the image.\n\nvm_image.published_date:\n Optional.\ + \ Specifies the date when the image was added to the image\n repository.\n\n\ + vm_image.show_in_gui:\n Optional. Indicates whether the VM Images should be\ + \ listed in the\n portal." + signature: update_vm_image(vm_image_name, vm_image) + parameters: + - name: vm_image_name + isRequired: true + - name: vm_image + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.upgrade_deployment + name: upgrade_deployment + summary: "Initiates an upgrade.\n\nservice_name:\n Name of the hosted service.\n\ + \ndeployment_name:\n The name of the deployment.\n\nmode:\n If set to Manual,\ + \ WalkUpgradeDomain must be called to apply the\n update. If set to Auto, the\ + \ Windows Azure platform will\n automatically apply the update To each upgrade\ + \ domain for the\n service. Possible values are: Auto, Manual\n\npackage_url:\n\ + \ A URL that refers to the location of the service package in the\n Blob service.\ + \ The service package can be located either in a\n storage account beneath the\ + \ same subscription or a Shared Access\n Signature (SAS) URI from any storage\ + \ account.\n\nconfiguration:\n The base-64 encoded service configuration file\ + \ for the deployment.\n\nlabel:\n A name for the hosted service. The name can\ + \ be up to 100 characters\n in length. It is recommended that the label be unique\ + \ within the\n subscription. The name can be used to identify the hosted service\n\ + \ for your tracking purposes.\n\nforce:\n Specifies whether the rollback should\ + \ proceed even when it will\n cause local data to be lost from some role instances.\ + \ True if the\n rollback should proceed; otherwise false if the rollback should\n\ + \ fail.\n\nrole_to_upgrade:\n The name of the specific role to upgrade.\n\n\ + extended_properties:\n Dictionary containing name/value pairs of storage account\n\ + \ properties. You can have a maximum of 50 extended property\n name/value\ + \ pairs. The maximum length of the Name element is 64\n characters, only alphanumeric\ + \ characters and underscores are valid\n in the Name, and the name must start\ + \ with a letter. The value has\n a maximum length of 255 characters." + signature: upgrade_deployment(service_name, deployment_name, mode, package_url, + configuration, label, force, role_to_upgrade=None, extended_properties=None) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: mode + isRequired: true + - name: package_url + isRequired: true + - name: configuration + isRequired: true + - name: label + isRequired: true + - name: force + isRequired: true + - name: role_to_upgrade + defaultValue: None + - name: extended_properties + defaultValue: None +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.wait_for_operation_status + name: wait_for_operation_status + summary: "Waits for an asynchronous operation to complete.\n\nThis calls get_operation_status\ + \ in a loop and returns when the expected\nstatus is reached. The result of get_operation_status\ + \ is returned. By\ndefault, an exception is raised on timeout or error status.\n\ + \nrequest_id:\n The request ID for the request you wish to track.\n\nwait_for_status:\n\ + \ Status to wait for. Default is 'Succeeded'.\n\ntimeout:\n Total timeout\ + \ in seconds. Default is 30s.\n\nsleep_interval:\n Sleep time in seconds for\ + \ each iteration. Default is 5s.\n\nprogress_callback:\n Callback for each iteration.\n\ + \ Default prints '.'.\n Set it to None for no progress notification.\n\nsuccess_callback:\n\ + \ Callback on success. Default prints newline.\n Set it to None for no success\ + \ notification.\n\nfailure_callback:\n Callback on failure. Default prints newline+error\ + \ details then\n raises exception.\n Set it to None for no failure notification." + signature: wait_for_operation_status(request_id, wait_for_status='Succeeded', timeout=30, + sleep_interval=5, progress_callback=, + success_callback=, + failure_callback=) + parameters: + - name: request_id + isRequired: true + - name: wait_for_status + defaultValue: Succeeded + - name: timeout + defaultValue: '30' + - name: sleep_interval + defaultValue: '5' + - name: progress_callback + - name: success_callback + - name: failure_callback +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.wait_for_operation_status_failure_default_callback + name: wait_for_operation_status_failure_default_callback + signature: wait_for_operation_status_failure_default_callback(ex) + parameters: + - name: elapsed + isRequired: true + - name: ex + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.wait_for_operation_status_progress_default_callback + name: wait_for_operation_status_progress_default_callback + signature: wait_for_operation_status_progress_default_callback() + parameters: + - name: elapsed + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.wait_for_operation_status_success_default_callback + name: wait_for_operation_status_success_default_callback + signature: wait_for_operation_status_success_default_callback() + parameters: + - name: elapsed + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.walk_upgrade_domain + name: walk_upgrade_domain + summary: "Specifies the next upgrade domain to be walked during manual in-place\n\ + upgrade or configuration change.\n\nservice_name:\n Name of the hosted service.\n\ + \ndeployment_name:\n The name of the deployment.\n\nupgrade_domain:\n An integer\ + \ value that identifies the upgrade domain to walk.\n Upgrade domains are identified\ + \ with a zero-based index: the first\n upgrade domain has an ID of 0, the second\ + \ has an ID of 1, and so on." + signature: walk_upgrade_domain(service_name, deployment_name, upgrade_domain) + parameters: + - name: service_name + isRequired: true + - name: deployment_name + isRequired: true + - name: upgrade_domain + isRequired: true +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.with_filter + name: with_filter + summary: 'Returns a new service which will process requests with the + + specified filter. Filtering operations can include logging, automatic + + retrying, etc... The filter is a lambda which receives the HTTPRequest + + and another lambda. The filter can perform any pre-processing on the + + request, pass it off to the next lambda, and then perform any + + post-processing on the response.' + signature: with_filter(filter) + parameters: + - name: filter + isRequired: true +attributes: +- uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService.timeout + name: timeout diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.servicemanagementservice.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.servicemanagementservice.yml new file mode 100644 index 00000000..8a3abea8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.servicemanagementservice.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.servicemanagement.servicemanagementservice +name: servicemanagementservice +fullName: azure.servicemanagement.servicemanagementservice +classes: +- azure.servicemanagement.servicemanagementservice.ServiceManagementService diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.yml new file mode 100644 index 00000000..bc79cb0c --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.yml @@ -0,0 +1,403 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService +name: SqlDatabaseManagementService +fullName: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService +module: azure.servicemanagement.sqldatabasemanagementservice +summary: "Note that this class is a preliminary work on SQL Database\nmanagement.\ + \ Since it lack a lot a features, final version\ncan be slightly different from\ + \ the current one.\n\nInitializes the sql database management service.\n\nsubscription_id:\n\ + \ Subscription to manage.\n\ncert_file:\n Path to .pem certificate file (httplib),\ + \ or location of the\n certificate in your Personal certificate store (winhttp)\ + \ in the\n CURRENT_USERmyCertificateName format.\n If a request_session is specified,\ + \ then this is unused.\n\nhost:\n Live ServiceClient URL. Defaults to Azure public\ + \ cloud.\n\nrequest_session:\n Session object to use for http requests. If this\ + \ is specified, it\n replaces the default use of httplib or winhttp. Also, the\ + \ cert_file\n parameter is unused when a session is passed in.\n The session\ + \ object handles authentication, and as such can support\n multiple types of authentication:\ + \ .pem certificate, oauth.\n For example, you can pass in a Session instance from\ + \ the requests\n library. To use .pem certificate authentication with requests\n\ + \ library, set the path to the .pem file on the session.cert\n attribute.\n\n\ + timeout:\n Optional. Timeout for the http request, in seconds." +constructor: + syntax: SqlDatabaseManagementService(subscription_id=None, cert_file=None, host='management.core.windows.net', + request_session=None, timeout=65) + parameters: + - name: subscription_id + defaultValue: None + - name: cert_file + defaultValue: None + - name: host + defaultValue: management.core.windows.net + - name: request_session + defaultValue: None + - name: timeout + defaultValue: '65' +methods: +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.create_database + name: create_database + summary: "Creates a new Azure SQL Database.\n\nserver_name:\n Name of the server\ + \ to contain the new database.\n\nname:\n Required. The name for the new database.\ + \ See Naming Requirements\n in Azure SQL Database General Guidelines and Limitations\ + \ and\n Database Identifiers for more information.\n\nservice_objective_id:\n\ + \ Required. The GUID corresponding to the performance level for\n Edition.\ + \ See List Service Level Objectives for current values.\n\nedition:\n Optional.\ + \ The Service Tier (Edition) for the new database. If\n omitted, the default\ + \ is Web. Valid values are Web, Business,\n Basic, Standard, and Premium. See\ + \ Azure SQL Database Service Tiers\n (Editions) and Web and Business Edition\ + \ Sunset FAQ for more\n information.\n\ncollation_name:\n Optional. The database\ + \ collation. This can be any collation\n supported by SQL. If omitted, the default\ + \ collation is used. See\n SQL Server Collation Support in Azure SQL Database\ + \ General\n Guidelines and Limitations for more information.\n\nmax_size_bytes:\n\ + \ Optional. Sets the maximum size, in bytes, for the database. This\n value\ + \ must be within the range of allowed values for Edition. If\n omitted, the\ + \ default value for the edition is used. See Azure SQL\n Database Service Tiers\ + \ (Editions) for current maximum databases\n sizes. Convert MB or GB values\ + \ to bytes.\n 1 MB = 1048576 bytes. 1 GB = 1073741824 bytes." + signature: create_database(server_name, name, service_objective_id, edition=None, + collation_name=None, max_size_bytes=None) + parameters: + - name: server_name + isRequired: true + - name: name + isRequired: true + - name: service_objective_id + isRequired: true + - name: edition + defaultValue: None + - name: collation_name + defaultValue: None + - name: max_size_bytes + defaultValue: None +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.create_firewall_rule + name: create_firewall_rule + summary: "Creates an Azure SQL Database server firewall rule.\n\nserver_name:\n\ + \ Name of the server to set the firewall rule on.\n\nname:\n The name of the\ + \ new firewall rule.\n\nstart_ip_address:\n The lowest IP address in the range\ + \ of the server-level firewall\n setting. IP addresses equal to or greater than\ + \ this can attempt to\n connect to the server. The lowest possible IP address\ + \ is 0.0.0.0.\n\nend_ip_address:\n The highest IP address in the range of the\ + \ server-level firewall\n setting. IP addresses equal to or less than this can\ + \ attempt to\n connect to the server. The highest possible IP address is\n \ + \ 255.255.255.255." + signature: create_firewall_rule(server_name, name, start_ip_address, end_ip_address) + parameters: + - name: server_name + isRequired: true + - name: name + isRequired: true + - name: start_ip_address + isRequired: true + - name: end_ip_address + isRequired: true +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.create_server + name: create_server + summary: "Create a new Azure SQL Database server.\n\nadmin_login:\n The administrator\ + \ login name for the new server.\n\nadmin_password:\n The administrator login\ + \ password for the new server.\n\nlocation:\n The region to deploy the new server." + signature: create_server(admin_login, admin_password, location) + parameters: + - name: admin_login + isRequired: true + - name: admin_password + isRequired: true + - name: location + isRequired: true +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.delete_database + name: delete_database + summary: "Deletes an Azure SQL Database.\n\nserver_name:\n Name of the server\ + \ where the database is located.\n\nname:\n Name of the database to delete." + signature: delete_database(server_name, name) + parameters: + - name: server_name + isRequired: true + - name: name + isRequired: true +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.delete_firewall_rule + name: delete_firewall_rule + summary: "Deletes an Azure SQL Database server firewall rule.\n\nserver_name:\n\ + \ Name of the server with the firewall rule you want to delete.\n\nname:\n \ + \ Name of the firewall rule you want to delete." + signature: delete_firewall_rule(server_name, name) + parameters: + - name: server_name + isRequired: true + - name: name + isRequired: true +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.delete_server + name: delete_server + summary: "Deletes an Azure SQL Database server (including all its databases).\n\n\ + server_name:\n Name of the server you want to delete." + signature: delete_server(server_name) + parameters: + - name: server_name + isRequired: true +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.get_operation_status + name: get_operation_status + summary: "Returns the status of the specified operation. After calling an\nasynchronous\ + \ operation, you can call Get Operation Status to determine\nwhether the operation\ + \ has succeeded, failed, or is still in progress.\n\nrequest_id:\n The request\ + \ ID for the request you wish to track." + signature: get_operation_status(request_id) + parameters: + - name: request_id + isRequired: true +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.get_server_event_logs + name: get_server_event_logs + summary: "Gets the event logs for an Azure SQL Database Server.\n\nserver_name:\n\ + \ Name of the server to retrieve the event logs from.\n\nstart_date:\n The\ + \ starting date and time of the events to retrieve in UTC format,\n for example\ + \ '2011-09-28 16:05:00'.\n\ninterval_size_in_minutes:\n Size of the event logs\ + \ to retrieve (in minutes).\n Valid values are: 5, 60, or 1440.\n\nevent_types:\n\ + \ The event type of the log entries you want to retrieve.\n Valid values are:\n\ + \n * connection_successful \n\n * connection_failed \n\n * connection_terminated\ + \ \n\n * deadlock \n\n * throttling \n\n * throttling_long_transaction\ + \ \n\n To return all event types pass in an empty string." + signature: get_server_event_logs(server_name, start_date, interval_size_in_minutes, + event_types='') + parameters: + - name: server_name + isRequired: true + - name: start_date + isRequired: true + - name: interval_size_in_minutes + isRequired: true + - name: event_types +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.list_databases + name: list_databases + summary: List the SQL databases defined on the specified server name + signature: list_databases(name) + parameters: + - name: name + isRequired: true +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.list_firewall_rules + name: list_firewall_rules + summary: "Retrieves the set of firewall rules for an Azure SQL Database Server.\n\ + \nserver_name:\n Name of the server." + signature: list_firewall_rules(server_name) + parameters: + - name: server_name + isRequired: true +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.list_quotas + name: list_quotas + summary: "Gets quotas for an Azure SQL Database Server.\n\nserver_name:\n Name\ + \ of the server." + signature: list_quotas(server_name) + parameters: + - name: server_name + isRequired: true +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.list_servers + name: list_servers + summary: List the SQL servers defined on the account. + signature: list_servers() +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.list_service_level_objectives + name: list_service_level_objectives + summary: "Gets the service level objectives for an Azure SQL Database server.\n\n\ + server_name:\n Name of the server." + signature: list_service_level_objectives(server_name) + parameters: + - name: server_name + isRequired: true +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.perform_delete + name: perform_delete + summary: "Performs a DELETE request and returns the response.\n\npath:\n Path\ + \ to the resource.\n Ex: '//services/hostedservices/'\n\ + \nx_ms_version:\n If specified, this is used for the x-ms-version header.\n\ + \ Otherwise, self.x_ms_version is used." + signature: perform_delete(path, x_ms_version=None) + parameters: + - name: path + isRequired: true + - name: x_ms_version + defaultValue: None +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.perform_get + name: perform_get + summary: "Performs a GET request and returns the response.\n\npath:\n Path to\ + \ the resource.\n Ex: '//services/hostedservices/'\n\ + \nx_ms_version:\n If specified, this is used for the x-ms-version header.\n\ + \ Otherwise, self.x_ms_version is used." + signature: perform_get(path, x_ms_version=None) + parameters: + - name: path + isRequired: true + - name: x_ms_version + defaultValue: None +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.perform_post + name: perform_post + summary: "Performs a POST request and returns the response.\n\npath:\n Path to\ + \ the resource.\n Ex: '//services/hostedservices/'\n\ + \nbody:\n Body for the POST request.\n\nx_ms_version:\n If specified, this\ + \ is used for the x-ms-version header.\n Otherwise, self.x_ms_version is used." + signature: perform_post(path, body, x_ms_version=None) + parameters: + - name: path + isRequired: true + - name: body + isRequired: true + - name: x_ms_version + defaultValue: None +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.perform_put + name: perform_put + summary: "Performs a PUT request and returns the response.\n\npath:\n Path to\ + \ the resource.\n Ex: '//services/hostedservices/'\n\ + \nbody:\n Body for the PUT request.\n\nx_ms_version:\n If specified, this\ + \ is used for the x-ms-version header.\n Otherwise, self.x_ms_version is used." + signature: perform_put(path, body, x_ms_version=None) + parameters: + - name: path + isRequired: true + - name: body + isRequired: true + - name: x_ms_version + defaultValue: None +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.set_proxy + name: set_proxy + summary: "Sets the proxy server host and port for the HTTP CONNECT Tunnelling.\n\ + \nhost:\n Address of the proxy. Ex: '192.168.0.100'\n\nport:\n Port of the\ + \ proxy. Ex: 6000\n\nuser:\n User for proxy authorization.\n\npassword:\n \ + \ Password for proxy authorization." + signature: set_proxy(host, port, user=None, password=None) + parameters: + - name: host + isRequired: true + - name: port + isRequired: true + - name: user + defaultValue: None + - name: password + defaultValue: None +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.set_server_admin_password + name: set_server_admin_password + summary: "Reset the administrator password for a server.\n\nserver_name:\n Name\ + \ of the server to change the password.\n\nadmin_password:\n The new administrator\ + \ password for the server." + signature: set_server_admin_password(server_name, admin_password) + parameters: + - name: server_name + isRequired: true + - name: admin_password + isRequired: true +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.should_use_requests + name: should_use_requests + signature: static should_use_requests(cert_file) + parameters: + - name: cert_file + isRequired: true +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.update_database + name: update_database + summary: "Updates existing database details.\n\nserver_name:\n Name of the server\ + \ to contain the new database.\n\nname:\n Required. The name for the new database.\ + \ See Naming Requirements\n in Azure SQL Database General Guidelines and Limitations\ + \ and\n Database Identifiers for more information.\n\nnew_database_name:\n \ + \ Optional. The new name for the new database.\n\nservice_objective_id:\n Optional.\ + \ The new service level to apply to the database. For more\n information about\ + \ service levels, see Azure SQL Database Service\n Tiers and Performance Levels.\ + \ Use List Service Level Objectives to\n get the correct ID for the desired\ + \ service objective.\n\nedition:\n Optional. The new edition for the new database.\n\ + \nmax_size_bytes:\n Optional. The new size of the database in bytes. For information\ + \ on\n available sizes for each edition, see Azure SQL Database Service\n \ + \ Tiers (Editions)." + signature: update_database(server_name, name, new_database_name=None, service_objective_id=None, + edition=None, max_size_bytes=None) + parameters: + - name: server_name + isRequired: true + - name: name + isRequired: true + - name: new_database_name + defaultValue: None + - name: service_objective_id + defaultValue: None + - name: edition + defaultValue: None + - name: max_size_bytes + defaultValue: None +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.update_firewall_rule + name: update_firewall_rule + summary: "Update a firewall rule for an Azure SQL Database server.\n\nserver_name:\n\ + \ Name of the server to set the firewall rule on.\n\nname:\n The name of the\ + \ firewall rule to update.\n\nstart_ip_address:\n The lowest IP address in the\ + \ range of the server-level firewall\n setting. IP addresses equal to or greater\ + \ than this can attempt to\n connect to the server. The lowest possible IP address\ + \ is 0.0.0.0.\n\nend_ip_address:\n The highest IP address in the range of the\ + \ server-level firewall\n setting. IP addresses equal to or less than this can\ + \ attempt to\n connect to the server. The highest possible IP address is\n \ + \ 255.255.255.255." + signature: update_firewall_rule(server_name, name, start_ip_address, end_ip_address) + parameters: + - name: server_name + isRequired: true + - name: name + isRequired: true + - name: start_ip_address + isRequired: true + - name: end_ip_address + isRequired: true +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.wait_for_operation_status + name: wait_for_operation_status + summary: "Waits for an asynchronous operation to complete.\n\nThis calls get_operation_status\ + \ in a loop and returns when the expected\nstatus is reached. The result of get_operation_status\ + \ is returned. By\ndefault, an exception is raised on timeout or error status.\n\ + \nrequest_id:\n The request ID for the request you wish to track.\n\nwait_for_status:\n\ + \ Status to wait for. Default is 'Succeeded'.\n\ntimeout:\n Total timeout\ + \ in seconds. Default is 30s.\n\nsleep_interval:\n Sleep time in seconds for\ + \ each iteration. Default is 5s.\n\nprogress_callback:\n Callback for each iteration.\n\ + \ Default prints '.'.\n Set it to None for no progress notification.\n\nsuccess_callback:\n\ + \ Callback on success. Default prints newline.\n Set it to None for no success\ + \ notification.\n\nfailure_callback:\n Callback on failure. Default prints newline+error\ + \ details then\n raises exception.\n Set it to None for no failure notification." + signature: wait_for_operation_status(request_id, wait_for_status='Succeeded', timeout=30, + sleep_interval=5, progress_callback=, + success_callback=, + failure_callback=) + parameters: + - name: request_id + isRequired: true + - name: wait_for_status + defaultValue: Succeeded + - name: timeout + defaultValue: '30' + - name: sleep_interval + defaultValue: '5' + - name: progress_callback + - name: success_callback + - name: failure_callback +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.wait_for_operation_status_failure_default_callback + name: wait_for_operation_status_failure_default_callback + signature: wait_for_operation_status_failure_default_callback(ex) + parameters: + - name: elapsed + isRequired: true + - name: ex + isRequired: true +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.wait_for_operation_status_progress_default_callback + name: wait_for_operation_status_progress_default_callback + signature: wait_for_operation_status_progress_default_callback() + parameters: + - name: elapsed + isRequired: true +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.wait_for_operation_status_success_default_callback + name: wait_for_operation_status_success_default_callback + signature: wait_for_operation_status_success_default_callback() + parameters: + - name: elapsed + isRequired: true +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.with_filter + name: with_filter + summary: 'Returns a new service which will process requests with the + + specified filter. Filtering operations can include logging, automatic + + retrying, etc... The filter is a lambda which receives the HTTPRequest + + and another lambda. The filter can perform any pre-processing on the + + request, pass it off to the next lambda, and then perform any + + post-processing on the response.' + signature: with_filter(filter) + parameters: + - name: filter + isRequired: true +attributes: +- uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService.timeout + name: timeout diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.sqldatabasemanagementservice.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.sqldatabasemanagementservice.yml new file mode 100644 index 00000000..d219ee28 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.sqldatabasemanagementservice.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.servicemanagement.sqldatabasemanagementservice +name: sqldatabasemanagementservice +fullName: azure.servicemanagement.sqldatabasemanagementservice +classes: +- azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.websitemanagementservice.WebsiteManagementService.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.websitemanagementservice.WebsiteManagementService.yml new file mode 100644 index 00000000..0bf79fb9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.websitemanagementservice.WebsiteManagementService.yml @@ -0,0 +1,349 @@ +### YamlMime:PythonClass +uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService +name: WebsiteManagementService +fullName: azure.servicemanagement.websitemanagementservice.WebsiteManagementService +module: azure.servicemanagement.websitemanagementservice +summary: "Note that this class is a preliminary work on WebSite\nmanagement. Since\ + \ it lack a lot a features, final version\ncan be slightly different from the current\ + \ one.\n\nInitializes the website management service.\n\nsubscription_id:\n Subscription\ + \ to manage.\n\ncert_file:\n Path to .pem certificate file (httplib), or location\ + \ of the\n certificate in your Personal certificate store (winhttp) in the\n \ + \ CURRENT_USERmyCertificateName format.\n If a request_session is specified,\ + \ then this is unused.\n\nhost:\n Live ServiceClient URL. Defaults to Azure public\ + \ cloud.\n\nrequest_session:\n Session object to use for http requests. If this\ + \ is specified, it\n replaces the default use of httplib or winhttp. Also, the\ + \ cert_file\n parameter is unused when a session is passed in.\n The session\ + \ object handles authentication, and as such can support\n multiple types of authentication:\ + \ .pem certificate, oauth.\n For example, you can pass in a Session instance from\ + \ the requests\n library. To use .pem certificate authentication with requests\n\ + \ library, set the path to the .pem file on the session.cert\n attribute.\n\n\ + timeout:\n Optional. Timeout for the http request, in seconds." +constructor: + syntax: WebsiteManagementService(subscription_id=None, cert_file=None, host='management.core.windows.net', + request_session=None, timeout=65) + parameters: + - name: subscription_id + defaultValue: None + - name: cert_file + defaultValue: None + - name: host + defaultValue: management.core.windows.net + - name: request_session + defaultValue: None + - name: timeout + defaultValue: '65' +methods: +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.create_site + name: create_site + summary: "Create a website.\n\nwebspace_name:\n The name of the webspace.\n\n\ + website_name:\n The name of the website.\n\ngeo_region:\n The geographical\ + \ region of the webspace that will be created.\n\nhost_names:\n An array of\ + \ fully qualified domain names for website. Only one\n hostname can be specified\ + \ in the azurewebsites.net domain.\n The hostname should match the name of the\ + \ website. Custom domains\n can only be specified for Shared or Standard websites.\n\ + \nplan:\n This value must be 'VirtualDedicatedPlan'.\n\ncompute_mode:\n This\ + \ value should be 'Shared' for the Free or Paid Shared\n offerings, or 'Dedicated'\ + \ for the Standard offering. The default\n value is 'Shared'. If you set it\ + \ to 'Dedicated', you must specify\n a value for the server_farm parameter.\n\ + \nserver_farm:\n The name of the Server Farm associated with this website. This\ + \ is\n a required value for Standard mode.\n\nsite_mode:\n Can be None, 'Limited'\ + \ or 'Basic'. This value is 'Limited' for the\n Free offering, and 'Basic' for\ + \ the Paid Shared offering. Standard\n mode does not use the site_mode parameter;\ + \ it uses the compute_mode\n parameter." + signature: create_site(webspace_name, website_name, geo_region, host_names, plan='VirtualDedicatedPlan', + compute_mode='Shared', server_farm=None, site_mode=None) + parameters: + - name: webspace_name + isRequired: true + - name: website_name + isRequired: true + - name: geo_region + isRequired: true + - name: host_names + isRequired: true + - name: plan + defaultValue: VirtualDedicatedPlan + - name: compute_mode + defaultValue: Shared + - name: server_farm + defaultValue: None + - name: site_mode + defaultValue: None +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.delete_site + name: delete_site + summary: "Delete a website.\n\nwebspace_name:\n The name of the webspace.\n\n\ + website_name:\n The name of the website.\n\ndelete_empty_server_farm:\n If\ + \ the site being deleted is the last web site in a server farm,\n you can delete\ + \ the server farm by setting this to True.\n\ndelete_metrics:\n To also delete\ + \ the metrics for the site that you are deleting, you\n can set this to True." + signature: delete_site(webspace_name, website_name, delete_empty_server_farm=False, + delete_metrics=False) + parameters: + - name: webspace_name + isRequired: true + - name: website_name + isRequired: true + - name: delete_empty_server_farm + defaultValue: 'False' + - name: delete_metrics + defaultValue: 'False' +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.get_historical_usage_metrics + name: get_historical_usage_metrics + summary: "Get historical usage metrics.\n\nwebspace_name:\n The name of the webspace.\n\ + \nwebsite_name:\n The name of the website.\n\nmetrics:\n Optional. List of\ + \ metrics name. Otherwise, all metrics returned.\n\nstart_time:\n Optional.\ + \ An ISO8601 date. Otherwise, current hour is used.\n\nend_time:\n Optional.\ + \ An ISO8601 date. Otherwise, current time is used.\n\ntime_grain:\n Optional.\ + \ A rollup name, as P1D. OTherwise, default rollup for the metrics is used.\n\n\ + More information and metrics name at:\n[http://msdn.microsoft.com/en-us/library/azure/dn166964.aspx](http://msdn.microsoft.com/en-us/library/azure/dn166964.aspx)" + signature: get_historical_usage_metrics(webspace_name, website_name, metrics=None, + start_time=None, end_time=None, time_grain=None) + parameters: + - name: webspace_name + isRequired: true + - name: website_name + isRequired: true + - name: metrics + defaultValue: None + - name: start_time + defaultValue: None + - name: end_time + defaultValue: None + - name: time_grain + defaultValue: None +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.get_metric_definitions + name: get_metric_definitions + summary: "Get metric definitions of metrics available of this web site.\n\nwebspace_name:\n\ + \ The name of the webspace.\n\nwebsite_name:\n The name of the website." + signature: get_metric_definitions(webspace_name, website_name) + parameters: + - name: webspace_name + isRequired: true + - name: website_name + isRequired: true +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.get_operation_status + name: get_operation_status + summary: "Returns the status of the specified operation. After calling an\nasynchronous\ + \ operation, you can call Get Operation Status to determine\nwhether the operation\ + \ has succeeded, failed, or is still in progress.\n\nrequest_id:\n The request\ + \ ID for the request you wish to track." + signature: get_operation_status(request_id) + parameters: + - name: request_id + isRequired: true +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.get_publish_profile + name: get_publish_profile + summary: "Get a site's publish profile as an object\n\nwebspace_name:\n The name\ + \ of the webspace.\n\nwebsite_name:\n The name of the website." + signature: get_publish_profile(webspace_name, website_name) + parameters: + - name: webspace_name + isRequired: true + - name: website_name + isRequired: true +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.get_publish_profile_xml + name: get_publish_profile_xml + summary: "Get a site's publish profile as a string\n\nwebspace_name:\n The name\ + \ of the webspace.\n\nwebsite_name:\n The name of the website." + signature: get_publish_profile_xml(webspace_name, website_name) + parameters: + - name: webspace_name + isRequired: true + - name: website_name + isRequired: true +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.get_site + name: get_site + summary: "List the web sites defined on this webspace.\n\nwebspace_name:\n The\ + \ name of the webspace.\n\nwebsite_name:\n The name of the website." + signature: get_site(webspace_name, website_name) + parameters: + - name: webspace_name + isRequired: true + - name: website_name + isRequired: true +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.get_webspace + name: get_webspace + summary: "Get details of a specific webspace.\n\nwebspace_name:\n The name of\ + \ the webspace." + signature: get_webspace(webspace_name) + parameters: + - name: webspace_name + isRequired: true +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.list_sites + name: list_sites + summary: "List the web sites defined on this webspace.\n\nwebspace_name:\n The\ + \ name of the webspace." + signature: list_sites(webspace_name) + parameters: + - name: webspace_name + isRequired: true +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.list_webspaces + name: list_webspaces + summary: List the webspaces defined on the account. + signature: list_webspaces() +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.perform_delete + name: perform_delete + summary: "Performs a DELETE request and returns the response.\n\npath:\n Path\ + \ to the resource.\n Ex: '//services/hostedservices/'\n\ + \nx_ms_version:\n If specified, this is used for the x-ms-version header.\n\ + \ Otherwise, self.x_ms_version is used." + signature: perform_delete(path, x_ms_version=None) + parameters: + - name: path + isRequired: true + - name: x_ms_version + defaultValue: None +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.perform_get + name: perform_get + summary: "Performs a GET request and returns the response.\n\npath:\n Path to\ + \ the resource.\n Ex: '//services/hostedservices/'\n\ + \nx_ms_version:\n If specified, this is used for the x-ms-version header.\n\ + \ Otherwise, self.x_ms_version is used." + signature: perform_get(path, x_ms_version=None) + parameters: + - name: path + isRequired: true + - name: x_ms_version + defaultValue: None +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.perform_post + name: perform_post + summary: "Performs a POST request and returns the response.\n\npath:\n Path to\ + \ the resource.\n Ex: '//services/hostedservices/'\n\ + \nbody:\n Body for the POST request.\n\nx_ms_version:\n If specified, this\ + \ is used for the x-ms-version header.\n Otherwise, self.x_ms_version is used." + signature: perform_post(path, body, x_ms_version=None) + parameters: + - name: path + isRequired: true + - name: body + isRequired: true + - name: x_ms_version + defaultValue: None +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.perform_put + name: perform_put + summary: "Performs a PUT request and returns the response.\n\npath:\n Path to\ + \ the resource.\n Ex: '//services/hostedservices/'\n\ + \nbody:\n Body for the PUT request.\n\nx_ms_version:\n If specified, this\ + \ is used for the x-ms-version header.\n Otherwise, self.x_ms_version is used." + signature: perform_put(path, body, x_ms_version=None) + parameters: + - name: path + isRequired: true + - name: body + isRequired: true + - name: x_ms_version + defaultValue: None +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.restart_site + name: restart_site + summary: "Restart a web site.\n\nwebspace_name:\n The name of the webspace.\n\n\ + website_name:\n The name of the website." + signature: restart_site(webspace_name, website_name) + parameters: + - name: webspace_name + isRequired: true + - name: website_name + isRequired: true +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.set_proxy + name: set_proxy + summary: "Sets the proxy server host and port for the HTTP CONNECT Tunnelling.\n\ + \nhost:\n Address of the proxy. Ex: '192.168.0.100'\n\nport:\n Port of the\ + \ proxy. Ex: 6000\n\nuser:\n User for proxy authorization.\n\npassword:\n \ + \ Password for proxy authorization." + signature: set_proxy(host, port, user=None, password=None) + parameters: + - name: host + isRequired: true + - name: port + isRequired: true + - name: user + defaultValue: None + - name: password + defaultValue: None +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.should_use_requests + name: should_use_requests + signature: static should_use_requests(cert_file) + parameters: + - name: cert_file + isRequired: true +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.update_site + name: update_site + summary: "Update a web site.\n\nwebspace_name:\n The name of the webspace.\n\n\ + website_name:\n The name of the website.\n\nstate:\n The wanted state ('Running'\ + \ or 'Stopped' accepted)" + signature: update_site(webspace_name, website_name, state=None) + parameters: + - name: webspace_name + isRequired: true + - name: website_name + isRequired: true + - name: state + defaultValue: None +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.wait_for_operation_status + name: wait_for_operation_status + summary: "Waits for an asynchronous operation to complete.\n\nThis calls get_operation_status\ + \ in a loop and returns when the expected\nstatus is reached. The result of get_operation_status\ + \ is returned. By\ndefault, an exception is raised on timeout or error status.\n\ + \nrequest_id:\n The request ID for the request you wish to track.\n\nwait_for_status:\n\ + \ Status to wait for. Default is 'Succeeded'.\n\ntimeout:\n Total timeout\ + \ in seconds. Default is 30s.\n\nsleep_interval:\n Sleep time in seconds for\ + \ each iteration. Default is 5s.\n\nprogress_callback:\n Callback for each iteration.\n\ + \ Default prints '.'.\n Set it to None for no progress notification.\n\nsuccess_callback:\n\ + \ Callback on success. Default prints newline.\n Set it to None for no success\ + \ notification.\n\nfailure_callback:\n Callback on failure. Default prints newline+error\ + \ details then\n raises exception.\n Set it to None for no failure notification." + signature: wait_for_operation_status(request_id, wait_for_status='Succeeded', timeout=30, + sleep_interval=5, progress_callback=, + success_callback=, + failure_callback=) + parameters: + - name: request_id + isRequired: true + - name: wait_for_status + defaultValue: Succeeded + - name: timeout + defaultValue: '30' + - name: sleep_interval + defaultValue: '5' + - name: progress_callback + - name: success_callback + - name: failure_callback +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.wait_for_operation_status_failure_default_callback + name: wait_for_operation_status_failure_default_callback + signature: wait_for_operation_status_failure_default_callback(ex) + parameters: + - name: elapsed + isRequired: true + - name: ex + isRequired: true +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.wait_for_operation_status_progress_default_callback + name: wait_for_operation_status_progress_default_callback + signature: wait_for_operation_status_progress_default_callback() + parameters: + - name: elapsed + isRequired: true +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.wait_for_operation_status_success_default_callback + name: wait_for_operation_status_success_default_callback + signature: wait_for_operation_status_success_default_callback() + parameters: + - name: elapsed + isRequired: true +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.with_filter + name: with_filter + summary: 'Returns a new service which will process requests with the + + specified filter. Filtering operations can include logging, automatic + + retrying, etc... The filter is a lambda which receives the HTTPRequest + + and another lambda. The filter can perform any pre-processing on the + + request, pass it off to the next lambda, and then perform any + + post-processing on the response.' + signature: with_filter(filter) + parameters: + - name: filter + isRequired: true +attributes: +- uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService.timeout + name: timeout diff --git a/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.websitemanagementservice.yml b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.websitemanagementservice.yml new file mode 100644 index 00000000..40ae460d --- /dev/null +++ b/previous/docs-ref-autogen/azure-servicemanagement-legacy/azure.servicemanagement.websitemanagementservice.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.servicemanagement.websitemanagementservice +name: websitemanagementservice +fullName: azure.servicemanagement.websitemanagementservice +classes: +- azure.servicemanagement.websitemanagementservice.WebsiteManagementService diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.appendblobservice.AppendBlobService.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.appendblobservice.AppendBlobService.yml new file mode 100644 index 00000000..eb412641 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.appendblobservice.AppendBlobService.yml @@ -0,0 +1,4880 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.appendblobservice.AppendBlobService +name: AppendBlobService +fullName: azure.storage.blob.appendblobservice.AppendBlobService +module: azure.storage.blob.appendblobservice +summary: 'An append blob is comprised of blocks and is optimized for append operations. + + When you modify an append blob, blocks are added to the end of the blob only, + + via the append_block operation. Updating or deleting of existing blocks is not + + supported. Unlike a block blob, an append blob does not expose its block IDs. + + + Each block in an append blob can be a different size, up to a maximum of 4 MB, + + and an append blob can include up to 50,000 blocks. The maximum size of an + + append blob is therefore slightly more than 195 GB (4 MB X 50,000 blocks). + + + :type *~azure.storage.common.TokenCredential*' +constructor: + syntax: AppendBlobService(account_name=None, account_key=None, sas_token=None, is_emulated=False, + protocol='https', endpoint_suffix='core.windows.net', custom_domain=None, request_session=None, + connection_string=None, socket_timeout=None, token_credential=None) + parameters: + - name: account_name + description: 'The storage account name. This is used to authenticate requests + + signed with an account key and to construct the storage endpoint. It + + is required unless a connection string is given, or if a custom + + domain is used with anonymous authentication.' + defaultValue: None + types: + - + - name: account_key + description: 'The storage account key. This is used for shared key authentication. + + If neither account key or sas token is specified, anonymous access + + will be used.' + defaultValue: None + types: + - + - name: sas_token + description: 'A shared access signature token to use to authenticate requests + + instead of the account key. If account key and sas token are both + + specified, account key will be used to sign. If neither are + + specified, anonymous access will be used.' + defaultValue: None + types: + - + - name: is_emulated + description: 'Whether to use the emulator. Defaults to False. If specified, will + + override all other parameters besides connection string and request + + session.' + defaultValue: 'False' + types: + - + - name: protocol + description: The protocol to use for requests. Defaults to https. + defaultValue: https + types: + - + - name: endpoint_suffix + description: 'The host base component of the url, minus the account name. Defaults + + to Azure (core.windows.net). Override this to use the China cloud + + (core.chinacloudapi.cn).' + defaultValue: core.windows.net + types: + - + - name: custom_domain + description: 'The custom domain to use. This can be set in the Azure Portal. For + + example, ''www.mydomain.com''.' + defaultValue: None + types: + - + - name: request_session + description: The session object to use for http requests. + defaultValue: None + types: + - + - name: connection_string + description: 'If specified, this will override all other parameters besides + + request session. See + + [http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/](http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/) + + for the connection string format.' + defaultValue: None + types: + - + - name: socket_timeout + description: 'If specified, this will override the default socket timeout. The + timeout specified is in seconds. + + See DEFAULT_SOCKET_TIMEOUT in _constants.py for the default value.' + defaultValue: None + types: + - + - name: token_credential + description: 'A token credential used to authenticate HTTPS requests. The token + value + + should be updated before its expiration.' + defaultValue: None +variables: +- description: 'The size of the blocks put by append_blob_from_* methods. Smaller + blocks + + may be put if there is less data provided. The maximum block size the service + + supports is 4MB.' + name: MAX_BLOCK_SIZE + types: + - +methods: +- uid: azure.storage.blob.appendblobservice.AppendBlobService.abort_copy_blob + name: abort_copy_blob + summary: 'Aborts a pending copy_blob operation, and leaves a destination blob + + with zero length and full metadata.' + signature: abort_copy_blob(container_name, blob_name, copy_id, lease_id=None, timeout=None) + parameters: + - name: container_name + description: Name of destination container. + isRequired: true + types: + - + - name: blob_name + description: Name of destination blob. + isRequired: true + types: + - + - name: copy_id + description: 'Copy identifier provided in the copy.id of the original + + copy_blob operation.' + isRequired: true + types: + - + - name: lease_id + description: Required if the destination blob has an active infinite lease. + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.acquire_blob_lease + name: acquire_blob_lease + summary: 'Requests a new lease. If the blob does not have an active lease, the Blob + + service creates a lease on the blob and returns a new lease ID.' + signature: acquire_blob_lease(container_name, blob_name, lease_duration=-1, proposed_lease_id=None, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: lease_duration + description: 'Specifies the duration of the lease, in seconds, or negative one + + (-1) for a lease that never expires. A non-infinite lease can be + + between 15 and 60 seconds. A lease duration cannot be changed + + using renew or change. Default is -1 (infinite lease).' + defaultValue: '-1' + types: + - + - name: proposed_lease_id + description: 'Proposed lease ID, in a GUID string format. The Blob service + + returns 400 (Invalid request) if the proposed lease ID is not + + in the correct format.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: str +- uid: azure.storage.blob.appendblobservice.AppendBlobService.acquire_container_lease + name: acquire_container_lease + summary: 'Requests a new lease. If the container does not have an active lease, + + the Blob service creates a lease on the container and returns a new + + lease ID.' + signature: acquire_container_lease(container_name, lease_duration=-1, proposed_lease_id=None, + if_modified_since=None, if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_duration + description: 'Specifies the duration of the lease, in seconds, or negative one + + (-1) for a lease that never expires. A non-infinite lease can be + + between 15 and 60 seconds. A lease duration cannot be changed + + using renew or change. Default is -1 (infinite lease).' + defaultValue: '-1' + types: + - + - name: proposed_lease_id + description: 'Proposed lease ID, in a GUID string format. The Blob service returns + + 400 (Invalid request) if the proposed lease ID is not in the correct format.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: str +- uid: azure.storage.blob.appendblobservice.AppendBlobService.append_blob_from_bytes + name: append_blob_from_bytes + summary: 'Appends to the content of an existing blob from an array of bytes, with + + automatic chunking and progress notifications.' + signature: append_blob_from_bytes(container_name, blob_name, blob, index=0, count=None, + validate_content=False, maxsize_condition=None, progress_callback=None, lease_id=None, + timeout=None, if_modified_since=None, if_unmodified_since=None, if_match=None, + if_none_match=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob to create or update. + isRequired: true + types: + - + - name: blob + description: Content of blob as an array of bytes. + isRequired: true + types: + - + - name: index + description: Start index in the array of bytes. + defaultValue: '0' + types: + - + - name: count + description: 'Number of bytes to upload. Set to None or negative value to upload + + all bytes starting from index.' + defaultValue: None + types: + - + - name: validate_content + description: 'If true, calculates an MD5 hash for each chunk of the blob. The + storage + + service checks the hash of the content that has arrived with the hash + + that was sent. This is primarily valuable for detecting bitflips on + + the wire if using http instead of https as https (the default) will + + already validate. Note that this MD5 hash is not stored with the + + blob.' + defaultValue: 'False' + types: + - + - name: maxsize_condition + description: 'Optional conditional header. The max length in bytes permitted for + + the append blob. If the Append Block operation would cause the blob + + to exceed that limit or if the blob size is already greater than the + + value specified in this header, the request will fail with + + MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed).' + defaultValue: None + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) where + + current is the number of bytes transfered so far, and total is the + + size of the blob, or None if the total size is unknown.' + defaultValue: None + types: + - (, ) + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetime will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetime will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the Append Blob + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.append_blob_from_path + name: append_blob_from_path + summary: 'Appends to the content of an existing blob from a file path, with automatic + + chunking and progress notifications.' + signature: append_blob_from_path(container_name, blob_name, file_path, validate_content=False, + maxsize_condition=None, progress_callback=None, lease_id=None, timeout=None, if_modified_since=None, + if_unmodified_since=None, if_match=None, if_none_match=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob to create or update. + isRequired: true + types: + - + - name: file_path + description: Path of the file to upload as the blob content. + isRequired: true + types: + - + - name: validate_content + description: 'If true, calculates an MD5 hash for each chunk of the blob. The + storage + + service checks the hash of the content that has arrived with the hash + + that was sent. This is primarily valuable for detecting bitflips on + + the wire if using http instead of https as https (the default) will + + already validate. Note that this MD5 hash is not stored with the + + blob.' + defaultValue: 'False' + types: + - + - name: maxsize_condition + description: 'Optional conditional header. The max length in bytes permitted for + + the append blob. If the Append Block operation would cause the blob + + to exceed that limit or if the blob size is already greater than the + + value specified in this header, the request will fail with + + MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed).' + defaultValue: None + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) where + + current is the number of bytes transfered so far, and total is the + + size of the blob, or None if the total size is unknown.' + defaultValue: None + types: + - (, ) + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetime will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetime will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the Append Blob + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.append_blob_from_stream + name: append_blob_from_stream + summary: 'Appends to the content of an existing blob from a file/stream, with + + automatic chunking and progress notifications.' + signature: append_blob_from_stream(container_name, blob_name, stream, count=None, + validate_content=False, maxsize_condition=None, progress_callback=None, lease_id=None, + timeout=None, if_modified_since=None, if_unmodified_since=None, if_match=None, + if_none_match=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob to create or update. + isRequired: true + types: + - + - name: stream + description: Opened stream to upload as the blob content. + isRequired: true + types: + - + - name: count + description: 'Number of bytes to read from the stream. This is optional, but + + should be supplied for optimal performance.' + defaultValue: None + types: + - + - name: validate_content + description: 'If true, calculates an MD5 hash for each chunk of the blob. The + storage + + service checks the hash of the content that has arrived with the hash + + that was sent. This is primarily valuable for detecting bitflips on + + the wire if using http instead of https as https (the default) will + + already validate. Note that this MD5 hash is not stored with the + + blob.' + defaultValue: 'False' + types: + - + - name: maxsize_condition + description: 'Conditional header. The max length in bytes permitted for + + the append blob. If the Append Block operation would cause the blob + + to exceed that limit or if the blob size is already greater than the + + value specified in this header, the request will fail with + + MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed).' + defaultValue: None + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) where + + current is the number of bytes transfered so far, and total is the + + size of the blob, or None if the total size is unknown.' + defaultValue: None + types: + - (, ) + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetime will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetime will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the Append Blob + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.append_blob_from_text + name: append_blob_from_text + summary: 'Appends to the content of an existing blob from str/unicode, with + + automatic chunking and progress notifications.' + signature: append_blob_from_text(container_name, blob_name, text, encoding='utf-8', + validate_content=False, maxsize_condition=None, progress_callback=None, lease_id=None, + timeout=None, if_modified_since=None, if_unmodified_since=None, if_match=None, + if_none_match=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob to create or update. + isRequired: true + types: + - + - name: text + description: Text to upload to the blob. + isRequired: true + types: + - + - name: encoding + description: Python encoding to use to convert the text to bytes. + defaultValue: utf-8 + types: + - + - name: validate_content + description: 'If true, calculates an MD5 hash for each chunk of the blob. The + storage + + service checks the hash of the content that has arrived with the hash + + that was sent. This is primarily valuable for detecting bitflips on + + the wire if using http instead of https as https (the default) will + + already validate. Note that this MD5 hash is not stored with the + + blob.' + defaultValue: 'False' + types: + - + - name: maxsize_condition + description: 'Optional conditional header. The max length in bytes permitted for + + the append blob. If the Append Block operation would cause the blob + + to exceed that limit or if the blob size is already greater than the + + value specified in this header, the request will fail with + + MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed).' + defaultValue: None + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) where + + current is the number of bytes transfered so far, and total is the + + size of the blob, or None if the total size is unknown.' + defaultValue: None + types: + - (, ) + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetime will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetime will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the Append Blob + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.append_block + name: append_block + summary: Commits a new block of data to the end of an existing append blob. + signature: append_block(container_name, blob_name, block, validate_content=False, + maxsize_condition=None, appendpos_condition=None, lease_id=None, if_modified_since=None, + if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: block + description: Content of the block in bytes. + isRequired: true + types: + - + - name: validate_content + description: 'If true, calculates an MD5 hash of the block content. The storage + + service checks the hash of the content that has arrived + + with the hash that was sent. This is primarily valuable for detecting + + bitflips on the wire if using http instead of https as https (the default) + + will already validate. Note that this MD5 hash is not stored with the + + blob.' + defaultValue: 'False' + types: + - + - name: maxsize_condition + description: 'Optional conditional header. The max length in bytes permitted for + + the append blob. If the Append Block operation would cause the blob + + to exceed that limit or if the blob size is already greater than the + + value specified in this header, the request will fail with + + MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed).' + defaultValue: None + types: + - + - name: appendpos_condition + description: 'Optional conditional header, used only for the Append Block operation. + + A number indicating the byte offset to compare. Append Block will + + succeed only if the append position is equal to this number. If it + + is not, the request will fail with the + + AppendPositionConditionNotMet error + + (HTTP status code 412 - Precondition Failed).' + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: 'ETag, last modified, append offset, and committed block count + + properties for the updated Append Blob' + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.append_block_from_url + name: append_block_from_url + summary: Creates a new block to be committed as part of a blob, where the contents + are read from a source url. + signature: append_block_from_url(container_name, blob_name, copy_source_url, source_range_start=None, + source_range_end=None, source_content_md5=None, source_if_modified_since=None, + source_if_unmodified_since=None, source_if_match=None, source_if_none_match=None, + maxsize_condition=None, appendpos_condition=None, lease_id=None, if_modified_since=None, + if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob. + isRequired: true + types: + - + - name: copy_source_url + description: 'The URL of the source data. It can point to any Azure Blob or File, + that is either public or has a + + shared access signature attached.' + isRequired: true + types: + - + - name: source_range_start + description: This indicates the start of the range of bytes(inclusive) that has + to be taken from the copy source. + defaultValue: None + types: + - + - name: source_range_end + description: This indicates the end of the range of bytes(inclusive) that has + to be taken from the copy source. + defaultValue: None + types: + - + - name: source_content_md5 + description: If given, the service will calculate the MD5 hash of the block content + and compare against this value. + defaultValue: None + types: + - + - name: source_if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the source resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: source_if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the source resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: source_if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the source resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: source_if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the source resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the source resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: maxsize_condition + description: 'Optional conditional header. The max length in bytes permitted for + + the append blob. If the Append Block operation would cause the blob + + to exceed that limit or if the blob size is already greater than the + + value specified in this header, the request will fail with + + MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed).' + defaultValue: None + types: + - + - name: appendpos_condition + description: 'Optional conditional header, used only for the Append Block operation. + + A number indicating the byte offset to compare. Append Block will + + succeed only if the append position is equal to this number. If it + + is not, the request will fail with the + + AppendPositionConditionNotMet error + + (HTTP status code 412 - Precondition Failed).' + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.batch_delete_blobs + name: batch_delete_blobs + summary: 'Sends a batch of multiple blob delete requests. + + + The blob delete method deletes the specified blob or snapshot. Note that deleting + a blob also deletes all its + + snapshots. For more information, see [https://docs.microsoft.com/rest/api/storageservices/delete-blob](https://docs.microsoft.com/rest/api/storageservices/delete-blob)' + signature: batch_delete_blobs(batch_delete_sub_requests, timeout=None) + parameters: + - name: batch_delete_sub_requests + description: The blob delete requests to send as a batch. + isRequired: true + types: + - () + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: parsed batch delete HTTP response + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.break_blob_lease + name: break_blob_lease + summary: 'Breaks the lease, if the blob has an active lease. Once a lease is broken, + + it cannot be renewed. Any authorized request can break the lease; the request + + is not required to specify a matching lease ID. When a lease is broken, + + the lease break period is allowed to elapse, during which time no lease operation + + except break and release can be performed on the blob. When a lease is successfully + + broken, the response indicates the interval in seconds until a new lease can be + acquired. + + + A lease that has been broken can also be released, in which case another client + may + + immediately acquire the lease on the blob.' + signature: break_blob_lease(container_name, blob_name, lease_break_period=None, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: lease_break_period + description: 'For a break operation, this is the proposed duration of + + seconds that the lease should continue before it is broken, between + + 0 and 60 seconds. This break period is only used if it is shorter + + than the time remaining on the lease. If longer, the time remaining + + on the lease is used. A new lease will not be available before the + + break period has expired, but the lease may be held for longer than + + the break period. If this header does not appear with a break + + operation, a fixed-duration lease breaks after the remaining lease + + period elapses, and an infinite lease breaks immediately.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: int +- uid: azure.storage.blob.appendblobservice.AppendBlobService.break_container_lease + name: break_container_lease + summary: 'Break the lease, if the container has an active lease. Once a lease is + + broken, it cannot be renewed. Any authorized request can break the lease; + + the request is not required to specify a matching lease ID. When a lease + + is broken, the lease break period is allowed to elapse, during which time + + no lease operation except break and release can be performed on the container. + + When a lease is successfully broken, the response indicates the interval + + in seconds until a new lease can be acquired.' + signature: break_container_lease(container_name, lease_break_period=None, if_modified_since=None, + if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_break_period + description: 'This is the proposed duration of seconds that the lease + + should continue before it is broken, between 0 and 60 seconds. This + + break period is only used if it is shorter than the time remaining + + on the lease. If longer, the time remaining on the lease is used. + + A new lease will not be available before the break period has + + expired, but the lease may be held for longer than the break + + period. If this header does not appear with a break + + operation, a fixed-duration lease breaks after the remaining lease + + period elapses, and an infinite lease breaks immediately.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: int +- uid: azure.storage.blob.appendblobservice.AppendBlobService.change_blob_lease + name: change_blob_lease + summary: 'Changes the lease ID of an active lease. A change must include the current + + lease ID and a new lease ID.' + signature: change_blob_lease(container_name, blob_name, lease_id, proposed_lease_id, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: lease_id + description: Required if the blob has an active lease. + isRequired: true + types: + - + - name: proposed_lease_id + description: 'Proposed lease ID, in a GUID string format. The Blob service returns + + 400 (Invalid request) if the proposed lease ID is not in the correct format.' + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.change_container_lease + name: change_container_lease + summary: 'Change the lease ID of an active lease. A change must include the current + + lease ID and a new lease ID.' + signature: change_container_lease(container_name, lease_id, proposed_lease_id, if_modified_since=None, + if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: Lease ID for active lease. + isRequired: true + types: + - + - name: proposed_lease_id + description: 'Proposed lease ID, in a GUID string format. The Blob service returns + 400 + + (Invalid request) if the proposed lease ID is not in the correct format.' + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.copy_blob + name: copy_blob + summary: 'Copies a blob asynchronously. This operation returns a copy operation + + properties object, including a copy ID you can use to check or abort the + + copy operation. The Blob service copies blobs on a best-effort basis. + + + The source blob for a copy operation may be a block blob, an append blob, + + or a page blob. If the destination blob already exists, it must be of the + + same blob type as the source blob. Any existing destination blob will be + + overwritten. The destination blob cannot be modified while a copy operation + + is in progress. + + + When copying from a page blob, the Blob service creates a destination page + + blob of the source blob''s length, initially containing all zeroes. Then + + the source page ranges are enumerated, and non-empty ranges are copied. + + + For a block blob or an append blob, the Blob service creates a committed + + blob of zero length before returning from this operation. When copying + + from a block blob, all committed blocks and their block IDs are copied. + + Uncommitted blocks are not copied. At the end of the copy operation, the + + destination blob will have the same committed block count as the source. + + + When copying from an append blob, all committed blocks are copied. At the + + end of the copy operation, the destination blob will have the same committed + + block count as the source. + + + For all blob types, you can call get_blob_properties on the destination + + blob to check the status of the copy operation. The final blob will be + + committed when the copy completes.' + signature: copy_blob(container_name, blob_name, copy_source, metadata=None, source_if_modified_since=None, + source_if_unmodified_since=None, source_if_match=None, source_if_none_match=None, + destination_if_modified_since=None, destination_if_unmodified_since=None, destination_if_match=None, + destination_if_none_match=None, destination_lease_id=None, source_lease_id=None, + timeout=None) + parameters: + - name: container_name + description: Name of the destination container. The container must exist. + isRequired: true + types: + - + - name: blob_name + description: 'Name of the destination blob. If the destination blob exists, it + will + + be overwritten. Otherwise, it will be created.' + isRequired: true + types: + - + - name: copy_source + description: 'A URL of up to 2 KB in length that specifies an Azure file or blob. + + The value should be URL-encoded as it would appear in a request URI. + + If the source is in another account, the source must either be public + + or must be authenticated via a shared access signature. If the source + + is public, no authentication is required. + + Examples: + + [https://myaccount.blob.core.windows.net/mycontainer/myblob](https://myaccount.blob.core.windows.net/mycontainer/myblob) + + [https://myaccount.blob.core.windows.net/mycontainer/myblob](https://myaccount.blob.core.windows.net/mycontainer/myblob)?snapshot= + + [https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken](https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken)' + isRequired: true + types: + - + - name: metadata + description: 'Name-value pairs associated with the blob as metadata. If no name-value + + pairs are specified, the operation will copy the metadata from the + + source blob or file to the destination blob. If one or more name-value + + pairs are specified, the destination blob is created with the specified + + metadata, and metadata is not copied from the source blob or file.' + defaultValue: None + types: + - (, ) + - name: source_if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this conditional header to copy the blob only if the source + + blob has been modified since the specified date/time.' + defaultValue: None + types: + - + - name: source_if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this conditional header to copy the blob only if the source blob + + has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: source_if_match + description: 'An ETag value, or the wildcard character (*). Specify this conditional + + header to copy the source blob only if its ETag matches the value + + specified. If the ETag values do not match, the Blob service returns + + status code 412 (Precondition Failed). This header cannot be specified + + if the source is an Azure File.' + defaultValue: None + types: + - + - name: source_if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this conditional + + header to copy the blob only if its ETag does not match the value + + specified. If the values are identical, the Blob service returns status + + code 412 (Precondition Failed). This header cannot be specified if the + + source is an Azure File.' + defaultValue: None + types: + - + - name: destination_if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this conditional header to copy the blob only + + if the destination blob has been modified since the specified date/time. + + If the destination blob has not been modified, the Blob service returns + + status code 412 (Precondition Failed).' + defaultValue: None + types: + - + - name: destination_if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this conditional header to copy the blob only + + if the destination blob has not been modified since the specified + + date/time. If the destination blob has been modified, the Blob service + + returns status code 412 (Precondition Failed).' + defaultValue: None + types: + - + - name: destination_if_match + description: 'An ETag value, or the wildcard character (*). Specify an ETag value + for + + this conditional header to copy the blob only if the specified ETag value + + matches the ETag value for an existing destination blob. If the ETag for + + the destination blob does not match the ETag specified for If-Match, the + + Blob service returns status code 412 (Precondition Failed).' + defaultValue: None + types: + - + - name: destination_if_none_match + description: 'An ETag value, or the wildcard character (*). Specify an ETag value + for + + this conditional header to copy the blob only if the specified ETag value + + does not match the ETag value for the destination blob. Specify the wildcard + + character (*) to perform the operation only if the destination blob does not + + exist. If the specified condition isn''t met, the Blob service returns status + + code 412 (Precondition Failed).' + defaultValue: None + types: + - + - name: destination_lease_id + description: 'The lease ID specified for this header must match the lease ID of + the + + destination blob. If the request does not include the lease ID or it is not + + valid, the operation fails with status code 412 (Precondition Failed).' + defaultValue: None + types: + - + - name: source_lease_id + description: 'Specify this to perform the Copy Blob operation only if + + the lease ID given matches the active lease ID of the source blob.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: Copy operation properties such as status, source, and ID. + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.create_blob + name: create_blob + summary: 'Creates a blob or overrides an existing blob. Use if_none_match=* to + + prevent overriding an existing blob. + + + See create_blob_from_* for high level + + functions that handle the creation and upload of large blobs with + + automatic chunking and progress notifications.' + signature: create_blob(container_name, blob_name, content_settings=None, metadata=None, + lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, + if_none_match=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob to create or update. + isRequired: true + types: + - + - name: content_settings + description: ContentSettings object used to set blob properties. + defaultValue: None + types: + - + - name: metadata + description: Name-value pairs associated with the blob as metadata. + defaultValue: None + types: + - (, ) + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to + + perform the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the updated Append Blob + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.create_container + name: create_container + summary: 'Creates a new container under the specified account. If the container + + with the same name already exists, the operation fails if + + fail_on_exist is True.' + signature: create_container(container_name, metadata=None, public_access=None, fail_on_exist=False, + timeout=None) + parameters: + - name: container_name + description: 'Name of container to create. + + The container name may only contain lowercase letters, numbers, and hyphens, + and must begin with a letter or + + a number. Each hyphen must be preceded and followed by a non-hyphen character. + The name must also be + + between 3 and 63 characters long.' + isRequired: true + types: + - + - name: metadata + description: 'A dict with name_value pairs to associate with the + + container as metadata. Example:{''Category'':''test''}' + defaultValue: None + types: + - (, ) + - name: public_access + description: 'Possible values include: container, blob.' + defaultValue: None + types: + - + - name: fail_on_exist + description: Specify whether to throw an exception when the container exists. + defaultValue: 'False' + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: True if container is created, False if container already exists. + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.delete_blob + name: delete_blob + summary: 'Marks the specified blob or snapshot for deletion. + + The blob is later deleted during garbage collection. + + + Note that in order to delete a blob, you must delete all of its + + snapshots. You can delete both at the same time with the Delete + + Blob operation. + + + If a delete retention policy is enabled for the service, then this operation soft + deletes the blob or snapshot + + and retains the blob or snapshot for specified number of days. + + After specified number of days, blob''s data is removed from the service during + garbage collection. + + Soft deleted blob or snapshot is accessible through List Blobs API specifying + include=Include.Deleted option. + + Soft-deleted blob or snapshot can be restored using Undelete API.' + signature: delete_blob(container_name, blob_name, snapshot=None, lease_id=None, + delete_snapshots=None, if_modified_since=None, if_unmodified_since=None, if_match=None, + if_none_match=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to delete.' + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: delete_snapshots + description: Required if the blob has associated snapshots. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.delete_container + name: delete_container + summary: 'Marks the specified container for deletion. The container and any blobs + + contained within it are later deleted during garbage collection.' + signature: delete_container(container_name, fail_not_exist=False, lease_id=None, + if_modified_since=None, if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of container to delete. + isRequired: true + types: + - + - name: fail_not_exist + description: 'Specify whether to throw an exception when the container doesn''t + + exist.' + defaultValue: 'False' + types: + - + - name: lease_id + description: 'If specified, delete_container only succeeds if the + + container''s lease is active and matches this ID. + + Required if the container has an active lease.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: True if container is deleted, False container doesn't exist. + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.exists + name: exists + summary: 'Returns a boolean indicating whether the container exists (if blob_name + + is None), or otherwise a boolean indicating whether the blob exists.' + signature: exists(container_name, blob_name=None, snapshot=None, timeout=None) + parameters: + - name: container_name + description: Name of a container. + isRequired: true + types: + - + - name: blob_name + description: Name of a blob. If None, the container will be checked for existence. + defaultValue: None + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the snapshot.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: A boolean indicating whether the resource exists. + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.extract_date_and_request_id + name: extract_date_and_request_id + signature: static extract_date_and_request_id(retry_context) + parameters: + - name: retry_context + isRequired: true +- uid: azure.storage.blob.appendblobservice.AppendBlobService.generate_account_shared_access_signature + name: generate_account_shared_access_signature + summary: 'Generates a shared access signature for the blob service. + + Use the returned signature with the sas_token parameter of any BlobService.' + signature: generate_account_shared_access_signature(resource_types, permission, + expiry, start=None, ip=None, protocol=None) + parameters: + - name: resource_types + description: Specifies the resource types that are accessible with the account + SAS. + isRequired: true + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy.' + isRequired: true + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + isRequired: true + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. The default + value + + is https,http. See for possible + values.' + defaultValue: None + types: + - + return: + description: A Shared Access Signature (sas) token. + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.generate_blob_shared_access_signature + name: generate_blob_shared_access_signature + summary: 'Generates a shared access signature for the blob or one of its snapshots. + + Use the returned signature with the sas_token parameter of any BlobService.' + signature: generate_blob_shared_access_signature(container_name, blob_name, snapshot=None, + permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, + content_disposition=None, content_encoding=None, content_language=None, content_type=None, + user_delegation_key=None) + parameters: + - name: container_name + description: Name of container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to grant permission.' + defaultValue: None + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Permissions must be ordered read, write, delete, list. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy.' + defaultValue: None + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + defaultValue: None + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: id + description: 'A unique value up to 64 characters in length that correlates to + a + + stored access policy. To create a stored access policy, use .' + defaultValue: None + types: + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. The default + value + + is https,http. See for possible + values.' + defaultValue: None + types: + - + - name: cache_control + description: 'Response header value for Cache-Control when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_disposition + description: 'Response header value for Content-Disposition when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_encoding + description: 'Response header value for Content-Encoding when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_language + description: 'Response header value for Content-Language when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_type + description: 'Response header value for Content-Type when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: user_delegation_key + description: 'Instead of an account key, the user could pass in a user delegation + key. + + A user delegation key can be obtained from the service by authenticating with + an AAD identity; + + this can be accomplished by calling get_user_delegation_key. + + When present, the SAS is signed with the user delegation key instead.' + defaultValue: None + types: + - + return: + description: A Shared Access Signature (sas) token. + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.generate_container_shared_access_signature + name: generate_container_shared_access_signature + summary: 'Generates a shared access signature for the container. + + Use the returned signature with the sas_token parameter of any BlobService.' + signature: generate_container_shared_access_signature(container_name, permission=None, + expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, + content_disposition=None, content_encoding=None, content_language=None, content_type=None, + user_delegation_key=None) + parameters: + - name: container_name + description: Name of container. + isRequired: true + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Permissions must be ordered read, write, delete, list. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy.' + defaultValue: None + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + defaultValue: None + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: id + description: 'A unique value up to 64 characters in length that correlates to + a + + stored access policy. To create a stored access policy, use + + set_blob_service_properties.' + defaultValue: None + types: + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. The default + value + + is https,http. See for possible + values.' + defaultValue: None + types: + - + - name: cache_control + description: 'Response header value for Cache-Control when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_disposition + description: 'Response header value for Content-Disposition when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_encoding + description: 'Response header value for Content-Encoding when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_language + description: 'Response header value for Content-Language when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_type + description: 'Response header value for Content-Type when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: user_delegation_key + description: 'Instead of an account key, the user could pass in a user delegation + key. + + A user delegation key can be obtained from the service by authenticating with + an AAD identity; + + this can be accomplished by calling get_user_delegation_key. + + When present, the SAS is signed with the user delegation key instead.' + defaultValue: None + types: + - + return: + description: A Shared Access Signature (sas) token. + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_blob_account_information + name: get_blob_account_information + summary: 'Gets information related to the storage account. + + The information can also be retrieved if the user has a SAS to a container or + blob.' + signature: get_blob_account_information(container_name=None, blob_name=None, timeout=None) + parameters: + - name: container_name + description: 'Name of existing container. + + Optional, unless using a SAS token to a specific container or blob, in which + case it''s required.' + defaultValue: None + types: + - + - name: blob_name + description: 'Name of existing blob. + + Optional, unless using a SAS token to a specific blob, in which case it''s required.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: The . +- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_blob_metadata + name: get_blob_metadata + summary: Returns all user-defined metadata for the specified blob or snapshot. + signature: get_blob_metadata(container_name, blob_name, snapshot=None, lease_id=None, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: A dictionary representing the blob metadata name, value pairs. + types: + - (, ) +- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_blob_properties + name: get_blob_properties + summary: 'Returns all user-defined metadata, standard HTTP properties, and + + system properties for the blob. It does not return the content of the blob. + + Returns + + with and a metadata dict.' + signature: get_blob_properties(container_name, blob_name, snapshot=None, lease_id=None, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: a blob object including properties and metadata. + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_blob_service_properties + name: get_blob_service_properties + summary: 'Gets the properties of a storage account''s Blob service, including + + Azure Storage Analytics.' + signature: get_blob_service_properties(timeout=None) + parameters: + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: 'The blob with + an attached + + target_version property.' +- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_blob_service_stats + name: get_blob_service_stats + summary: 'Retrieves statistics related to replication for the Blob service. It is + + only available when read-access geo-redundant replication is enabled for + + the storage account. + + + With geo-redundant replication, Azure Storage maintains your data durable + + in two locations. In both locations, Azure Storage constantly maintains + + multiple healthy replicas of your data. The location where you read, + + create, update, or delete data is the primary storage account location. + + The primary location exists in the region you choose at the time you + + create an account via the Azure Management Azure classic portal, for + + example, North Central US. The location to which your data is replicated + + is the secondary location. The secondary location is automatically + + determined based on the location of the primary; it is in a second data + + center that resides in the same region as the primary location. Read-only + + access is available from the secondary location, if read-access geo-redundant + + replication is enabled for your storage account.' + signature: get_blob_service_stats(timeout=None) + parameters: + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: The blob service stats. + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_blob_to_bytes + name: get_blob_to_bytes + summary: 'Downloads a blob as an array of bytes, with automatic chunking and + + progress notifications. Returns an instance of + with + + properties, metadata, and content.' + signature: get_blob_to_bytes(container_name, blob_name, snapshot=None, start_range=None, + end_range=None, validate_content=False, progress_callback=None, max_connections=2, + lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, + if_none_match=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: start_range + description: 'Start of byte range to use for downloading a section of the blob. + + If no end_range is given, all bytes after the start_range will be downloaded. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: end_range + description: 'End of byte range to use for downloading a section of the blob. + + If end_range is given, start_range must be provided. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: validate_content + description: 'If set to true, validates an MD5 hash for each retrieved portion + of + + the blob. This is primarily valuable for detecting bitflips on the wire + + if using http instead of https as https (the default) will already + + validate. Note that the service will only return transactional MD5s + + for chunks 4MB or less so the first get request will be of size + + self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If + + self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be + + thrown. As computing the MD5 takes processing time and more requests + + will need to be done due to the reduced chunk size there may be some + + increase in latency.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) + + where current is the number of bytes transfered so far, and total is + + the size of the blob if known.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'If set to 2 or greater, an initial get will be done for the first + + self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob, + + the method returns at this point. If it is not, it will download the + + remaining data parallel using the number of threads equal to + + max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. + + If set to 1, a single large get request will be done. This is not + + generally recommended but available if very few threads should be + + used, network requests are very expensive, or a non-seekable stream + + prevents parallel download. This may also be useful if many blobs are + + expected to be empty as an extra request is required for empty blobs + + if max_connections is greater than 1.' + defaultValue: '2' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + return: + description: 'A Blob with properties and metadata. If max_connections is greater + + than 1, the content_md5 (if set on the blob) will not be returned. If you + + require this value, either use get_blob_properties or set max_connections + + to 1.' + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_blob_to_path + name: get_blob_to_path + summary: 'Downloads a blob to a file path, with automatic chunking and progress + + notifications. Returns an instance of with + + properties and metadata.' + signature: get_blob_to_path(container_name, blob_name, file_path, open_mode='wb', + snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, + max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, + if_match=None, if_none_match=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: file_path + description: Path of file to write out to. + isRequired: true + types: + - + - name: open_mode + description: 'Mode to use when opening the file. Note that specifying append only + + open_mode prevents parallel download. So, max_connections must be set + + to 1 if this open_mode is used.' + defaultValue: wb + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: start_range + description: 'Start of byte range to use for downloading a section of the blob. + + If no end_range is given, all bytes after the start_range will be downloaded. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: end_range + description: 'End of byte range to use for downloading a section of the blob. + + If end_range is given, start_range must be provided. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: validate_content + description: 'If set to true, validates an MD5 hash for each retrieved portion + of + + the blob. This is primarily valuable for detecting bitflips on the wire + + if using http instead of https as https (the default) will already + + validate. Note that the service will only return transactional MD5s + + for chunks 4MB or less so the first get request will be of size + + self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If + + self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be + + thrown. As computing the MD5 takes processing time and more requests + + will need to be done due to the reduced chunk size there may be some + + increase in latency.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) + + where current is the number of bytes transfered so far, and total is + + the size of the blob if known.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'If set to 2 or greater, an initial get will be done for the first + + self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob, + + the method returns at this point. If it is not, it will download the + + remaining data parallel using the number of threads equal to + + max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. + + If set to 1, a single large get request will be done. This is not + + generally recommended but available if very few threads should be + + used, network requests are very expensive, or a non-seekable stream + + prevents parallel download. This may also be useful if many blobs are + + expected to be empty as an extra request is required for empty blobs + + if max_connections is greater than 1.' + defaultValue: '2' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + return: + description: 'A Blob with properties and metadata. If max_connections is greater + + than 1, the content_md5 (if set on the blob) will not be returned. If you + + require this value, either use get_blob_properties or set max_connections + + to 1.' + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_blob_to_stream + name: get_blob_to_stream + summary: 'Downloads a blob to a stream, with automatic chunking and progress + + notifications. Returns an instance of with + + properties and metadata.' + signature: get_blob_to_stream(container_name, blob_name, stream, snapshot=None, + start_range=None, end_range=None, validate_content=False, progress_callback=None, + max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, + if_match=None, if_none_match=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: stream + description: Opened stream to write to. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: start_range + description: 'Start of byte range to use for downloading a section of the blob. + + If no end_range is given, all bytes after the start_range will be downloaded. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: end_range + description: 'End of byte range to use for downloading a section of the blob. + + If end_range is given, start_range must be provided. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: validate_content + description: 'If set to true, validates an MD5 hash for each retrieved portion + of + + the blob. This is primarily valuable for detecting bitflips on the wire + + if using http instead of https as https (the default) will already + + validate. Note that the service will only return transactional MD5s + + for chunks 4MB or less so the first get request will be of size + + self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If + + self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be + + thrown. As computing the MD5 takes processing time and more requests + + will need to be done due to the reduced chunk size there may be some + + increase in latency.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) + + where current is the number of bytes transfered so far, and total is + + the size of the blob if known.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'If set to 2 or greater, an initial get will be done for the first + + self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob, + + the method returns at this point. If it is not, it will download the + + remaining data parallel using the number of threads equal to + + max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. + + If set to 1, a single large get request will be done. This is not + + generally recommended but available if very few threads should be + + used, network requests are very expensive, or a non-seekable stream + + prevents parallel download. This may also be useful if many blobs are + + expected to be empty as an extra request is required for empty blobs + + if max_connections is greater than 1.' + defaultValue: '2' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + return: + description: 'A Blob with properties and metadata. If max_connections is greater + + than 1, the content_md5 (if set on the blob) will not be returned. If you + + require this value, either use get_blob_properties or set max_connections + + to 1.' + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_blob_to_text + name: get_blob_to_text + summary: 'Downloads a blob as unicode text, with automatic chunking and progress + + notifications. Returns an instance of with + + properties, metadata, and content.' + signature: get_blob_to_text(container_name, blob_name, encoding='utf-8', snapshot=None, + start_range=None, end_range=None, validate_content=False, progress_callback=None, + max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, + if_match=None, if_none_match=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: encoding + description: Python encoding to use when decoding the blob data. + defaultValue: utf-8 + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: start_range + description: 'Start of byte range to use for downloading a section of the blob. + + If no end_range is given, all bytes after the start_range will be downloaded. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: end_range + description: 'End of byte range to use for downloading a section of the blob. + + If end_range is given, start_range must be provided. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: validate_content + description: 'If set to true, validates an MD5 hash for each retrieved portion + of + + the blob. This is primarily valuable for detecting bitflips on the wire + + if using http instead of https as https (the default) will already + + validate. Note that the service will only return transactional MD5s + + for chunks 4MB or less so the first get request will be of size + + self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If + + self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be + + thrown. As computing the MD5 takes processing time and more requests + + will need to be done due to the reduced chunk size there may be some + + increase in latency.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) + + where current is the number of bytes transfered so far, and total is + + the size of the blob if known.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'If set to 2 or greater, an initial get will be done for the first + + self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob, + + the method returns at this point. If it is not, it will download the + + remaining data parallel using the number of threads equal to + + max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. + + If set to 1, a single large get request will be done. This is not + + generally recommended but available if very few threads should be + + used, network requests are very expensive, or a non-seekable stream + + prevents parallel download. This may also be useful if many blobs are + + expected to be empty as an extra request is required for empty blobs + + if max_connections is greater than 1.' + defaultValue: '2' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + return: + description: 'A Blob with properties and metadata. If max_connections is greater + + than 1, the content_md5 (if set on the blob) will not be returned. If you + + require this value, either use get_blob_properties or set max_connections + + to 1.' + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_container_acl + name: get_container_acl + summary: 'Gets the permissions for the specified container. + + The permissions indicate whether container data may be accessed publicly.' + signature: get_container_acl(container_name, lease_id=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: 'If specified, get_container_acl only succeeds if the + + container''s lease is active and matches this ID.' + defaultValue: None + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: 'A dictionary of access policies associated with the container. dict + of str to + + and a public_access property + + if public access is turned on' +- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_container_metadata + name: get_container_metadata + summary: Returns all user-defined metadata for the specified container. + signature: get_container_metadata(container_name, lease_id=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: 'If specified, get_container_metadata only succeeds if the + + container''s lease is active and matches this ID.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: A dictionary representing the container metadata name, value pairs. + types: + - (, ) +- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_container_properties + name: get_container_properties + summary: 'Returns all user-defined metadata and system properties for the specified + + container. The data returned does not include the container''s list of blobs.' + signature: get_container_properties(container_name, lease_id=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: 'If specified, get_container_properties only succeeds if the + + container''s lease is active and matches this ID.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: properties for the specified container within a container object. + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_user_delegation_key + name: get_user_delegation_key + summary: 'Obtain a user delegation key for the purpose of signing SAS tokens. + + A token credential must be present on the service object for this request to succeed.' + signature: get_user_delegation_key(key_start_time, key_expiry_time, timeout=None) + parameters: + - name: key_start_time + description: A DateTime value. Indicates when the key becomes valid. + isRequired: true + types: + - + - name: key_expiry_time + description: A DateTime value. Indicates when the key stops being valid. + isRequired: true + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: The user delegation key. + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.list_blob_names + name: list_blob_names + summary: 'Returns a generator to list the blob names under the specified container. + + The generator will lazily follow the continuation tokens returned by + + the service and stop when all blobs have been returned or num_results is reached. + + + If num_results is specified and the account has more than that number of + + blobs, the generator will have a populated next_marker field once it + + finishes. This marker can be used to create a new generator if more + + results are desired.' + signature: list_blob_names(container_name, prefix=None, num_results=None, include=None, + delimiter=None, marker=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: prefix + description: 'Filters the results to return only blobs whose names + + begin with the specified prefix.' + defaultValue: None + types: + - + - name: num_results + description: 'Specifies the maximum number of blobs to return, + + including all elements. + If the request does not specify + + num_results or specifies a value greater than 5,000, the server will + + return up to 5,000 items. Setting num_results to a value less than + + or equal to zero results in error response code 400 (Bad Request).' + defaultValue: None + types: + - + - name: include + description: Specifies one or more additional datasets to include in the response. + defaultValue: None + types: + - + - name: delimiter + description: 'When the request includes this parameter, the operation + + returns a element in the + + result list that acts as a placeholder for all blobs whose names begin + + with the same substring up to the appearance of the delimiter character. + + The delimiter may be a single character or a string.' + defaultValue: None + types: + - + - name: marker + description: 'An opaque continuation token. This value can be retrieved from the + + next_marker field of a previous generator object if num_results was + + specified and that generator has finished enumerating results. If + + specified, this generator will begin returning results from the point + + where the previous generator stopped.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.list_blobs + name: list_blobs + summary: 'Returns a generator to list the blobs under the specified container. + + The generator will lazily follow the continuation tokens returned by + + the service and stop when all blobs have been returned or num_results is reached. + + + If num_results is specified and the account has more than that number of + + blobs, the generator will have a populated next_marker field once it + + finishes. This marker can be used to create a new generator if more + + results are desired.' + signature: list_blobs(container_name, prefix=None, num_results=None, include=None, + delimiter=None, marker=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: prefix + description: 'Filters the results to return only blobs whose names + + begin with the specified prefix.' + defaultValue: None + types: + - + - name: num_results + description: 'Specifies the maximum number of blobs to return, + + including all elements. + If the request does not specify + + num_results or specifies a value greater than 5,000, the server will + + return up to 5,000 items. Setting num_results to a value less than + + or equal to zero results in error response code 400 (Bad Request).' + defaultValue: None + types: + - + - name: include + description: Specifies one or more additional datasets to include in the response. + defaultValue: None + types: + - + - name: delimiter + description: 'When the request includes this parameter, the operation + + returns a element in the + + result list that acts as a placeholder for all blobs whose names begin + + with the same substring up to the appearance of the delimiter character. + + The delimiter may be a single character or a string.' + defaultValue: None + types: + - + - name: marker + description: 'An opaque continuation token. This value can be retrieved from the + + next_marker field of a previous generator object if num_results was + + specified and that generator has finished enumerating results. If + + specified, this generator will begin returning results from the point + + where the previous generator stopped.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.list_containers + name: list_containers + summary: 'Returns a generator to list the containers under the specified account. + + The generator will lazily follow the continuation tokens returned by + + the service and stop when all containers have been returned or num_results is + reached. + + + If num_results is specified and the account has more than that number of + + containers, the generator will have a populated next_marker field once it + + finishes. This marker can be used to create a new generator if more + + results are desired.' + signature: list_containers(prefix=None, num_results=None, include_metadata=False, + marker=None, timeout=None) + parameters: + - name: prefix + description: 'Filters the results to return only containers whose names + + begin with the specified prefix.' + defaultValue: None + types: + - + - name: num_results + description: 'Specifies the maximum number of containers to return. A single list + + request may return up to 1000 contianers and potentially a continuation + + token which should be followed to get additional resutls.' + defaultValue: None + types: + - + - name: include_metadata + description: Specifies that container metadata be returned in the response. + defaultValue: 'False' + types: + - + - name: marker + description: 'An opaque continuation token. This value can be retrieved from the + + next_marker field of a previous generator object if num_results was + + specified and that generator has finished enumerating results. If + + specified, this generator will begin returning results from the point + + where the previous generator stopped.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.make_blob_url + name: make_blob_url + summary: Creates the url to access a blob. + signature: make_blob_url(container_name, blob_name, protocol=None, sas_token=None, + snapshot=None) + parameters: + - name: container_name + description: Name of container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob. + isRequired: true + types: + - + - name: protocol + description: 'Protocol to use: ''http'' or ''https''. If not specified, uses the + + protocol specified when BaseBlobService was initialized.' + defaultValue: None + types: + - + - name: sas_token + description: 'Shared access signature token created with + + generate_shared_access_signature.' + defaultValue: None + types: + - + - name: snapshot + description: 'An string value that uniquely identifies the snapshot. The value + of + + this query parameter indicates the snapshot version.' + defaultValue: None + types: + - + return: + description: blob access URL. + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.make_container_url + name: make_container_url + summary: Creates the url to access a container. + signature: make_container_url(container_name, protocol=None, sas_token=None) + parameters: + - name: container_name + description: Name of container. + isRequired: true + types: + - + - name: protocol + description: 'Protocol to use: ''http'' or ''https''. If not specified, uses the + + protocol specified when BaseBlobService was initialized.' + defaultValue: None + types: + - + - name: sas_token + description: 'Shared access signature token created with + + generate_shared_access_signature.' + defaultValue: None + types: + - + return: + description: container access URL. + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.release_blob_lease + name: release_blob_lease + summary: 'Releases the lease. The lease may be released if the lease ID specified + on the + + request matches that associated with the blob. Releasing the lease allows another + + client to immediately acquire the lease for the blob as soon as the release is + complete.' + signature: release_blob_lease(container_name, blob_name, lease_id, if_modified_since=None, + if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: lease_id + description: Lease ID for active lease. + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.release_container_lease + name: release_container_lease + summary: 'Release the lease. The lease may be released if the lease_id specified + matches + + that associated with the container. Releasing the lease allows another client + + to immediately acquire the lease for the container as soon as the release is complete.' + signature: release_container_lease(container_name, lease_id, if_modified_since=None, + if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: Lease ID for active lease. + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.renew_blob_lease + name: renew_blob_lease + summary: 'Renews the lease. The lease can be renewed if the lease ID specified on + + the request matches that associated with the blob. Note that the lease may + + be renewed even if it has expired as long as the blob has not been modified + + or leased again since the expiration of that lease. When you renew a lease, + + the lease duration clock resets.' + signature: renew_blob_lease(container_name, blob_name, lease_id, if_modified_since=None, + if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: lease_id + description: Lease ID for active lease. + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: str +- uid: azure.storage.blob.appendblobservice.AppendBlobService.renew_container_lease + name: renew_container_lease + summary: 'Renews the lease. The lease can be renewed if the lease ID specified + + matches that associated with the container. Note that + + the lease may be renewed even if it has expired as long as the container + + has not been leased again since the expiration of that lease. When you + + renew a lease, the lease duration clock resets.' + signature: renew_container_lease(container_name, lease_id, if_modified_since=None, + if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: Lease ID for active lease. + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: str +- uid: azure.storage.blob.appendblobservice.AppendBlobService.set_blob_metadata + name: set_blob_metadata + summary: 'Sets user-defined metadata for the specified blob as one or more + + name-value pairs.' + signature: set_blob_metadata(container_name, blob_name, metadata=None, lease_id=None, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: metadata + description: 'Dict containing name and value pairs. Each call to this operation + + replaces all existing metadata attached to the blob. To remove all + + metadata from the blob, call this operation with no metadata headers.' + defaultValue: None + types: + - (, ) + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the updated Blob + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.set_blob_properties + name: set_blob_properties + summary: 'Sets system properties on the blob. If one property is set for the + + content_settings, all properties will be overriden.' + signature: set_blob_properties(container_name, blob_name, content_settings=None, + lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, + if_none_match=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: content_settings + description: ContentSettings object used to set blob properties. + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the updated Blob + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.set_blob_service_properties + name: set_blob_service_properties + summary: 'Sets the properties of a storage account''s Blob service, including + + Azure Storage Analytics. If an element (ex Logging) is left as None, the + + existing settings on the service for that functionality are preserved.' + signature: set_blob_service_properties(logging=None, hour_metrics=None, minute_metrics=None, + cors=None, target_version=None, timeout=None, delete_retention_policy=None, static_website=None) + parameters: + - name: logging + description: Groups the Azure Analytics Logging settings. + defaultValue: None + types: + - + - name: hour_metrics + description: 'The hour metrics settings provide a summary of request + + statistics grouped by API in hourly aggregates for blobs.' + defaultValue: None + types: + - + - name: minute_metrics + description: 'The minute metrics settings provide request statistics + + for each minute for blobs.' + defaultValue: None + types: + - + - name: cors + description: 'You can include up to five CorsRule elements in the + + list. If an empty list is specified, all CORS rules will be deleted, + + and CORS will be disabled for the service.' + defaultValue: None + types: + - list() + - name: target_version + description: 'Indicates the default version to use for requests if an incoming + + request''s version is not specified.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + - name: delete_retention_policy + description: 'The delete retention policy specifies whether to retain deleted + blobs. + + It also specifies the number of days and versions of blob to keep.' + defaultValue: None + types: + - + - name: static_website + description: 'Specifies whether the static website feature is enabled, + + and if yes, indicates the index document and 404 error document to use.' + defaultValue: None + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.set_container_acl + name: set_container_acl + summary: 'Sets the permissions for the specified container or stored access + + policies that may be used with Shared Access Signatures. The permissions + + indicate whether blobs in a container may be accessed publicly.' + signature: set_container_acl(container_name, signed_identifiers=None, public_access=None, + lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: signed_identifiers + description: 'A dictionary of access policies to associate with the container. + The + + dictionary may contain up to 5 elements. An empty dictionary + + will clear the access policies set on the service.' + defaultValue: None + types: + - dict(str, ) + - name: public_access + description: 'Possible values include: container, blob.' + defaultValue: None + types: + - + - name: lease_id + description: 'If specified, set_container_acl only succeeds if the + + container''s lease is active and matches this ID.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A datetime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A datetime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the updated Container + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.set_container_metadata + name: set_container_metadata + summary: 'Sets one or more user-defined name-value pairs for the specified + + container. Each call to this operation replaces all existing metadata + + attached to the container. To remove all metadata from the container, + + call this operation with no metadata dict.' + signature: set_container_metadata(container_name, metadata=None, lease_id=None, + if_modified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: metadata + description: 'A dict containing name-value pairs to associate with the container + as + + metadata. Example: {''category'':''test''}' + defaultValue: None + types: + - (, ) + - name: lease_id + description: 'If specified, set_container_metadata only succeeds if the + + container''s lease is active and matches this ID.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the updated Container + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.set_proxy + name: set_proxy + summary: Sets the proxy server host and port for the HTTP CONNECT Tunnelling. + signature: set_proxy(host, port, user=None, password=None) + parameters: + - name: host + description: 'Address of the proxy. Ex: ''192.168.0.100''' + isRequired: true + types: + - + - name: port + description: 'Port of the proxy. Ex: 6000' + isRequired: true + types: + - + - name: user + description: User for proxy authorization. + defaultValue: None + types: + - + - name: password + description: Password for proxy authorization. + defaultValue: None + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.snapshot_blob + name: snapshot_blob + summary: Creates a read-only snapshot of a blob. + signature: snapshot_blob(container_name, blob_name, metadata=None, if_modified_since=None, + if_unmodified_since=None, if_match=None, if_none_match=None, lease_id=None, timeout=None, + cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: metadata + description: 'Specifies a user-defined name-value pair associated with the blob. + + If no name-value pairs are specified, the operation will copy the + + base blob metadata to the snapshot. If one or more name-value pairs + + are specified, the snapshot is created with the specified metadata, + + and metadata is not copied from the base blob.' + defaultValue: None + types: + - (, ) + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: snapshot properties + types: + - +- uid: azure.storage.blob.appendblobservice.AppendBlobService.undelete_blob + name: undelete_blob + summary: 'The undelete Blob operation restores the contents and metadata of soft + deleted blob or snapshot. + + Attempting to undelete a blob or snapshot that is not soft deleted will succeed + without any changes.' + signature: undelete_blob(container_name, blob_name, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +attributes: +- uid: azure.storage.blob.appendblobservice.AppendBlobService.protocol + name: protocol +- uid: azure.storage.blob.appendblobservice.AppendBlobService.request_session + name: request_session +- uid: azure.storage.blob.appendblobservice.AppendBlobService.socket_timeout + name: socket_timeout +- uid: azure.storage.blob.appendblobservice.AppendBlobService.MAX_BLOCK_SIZE + name: MAX_BLOCK_SIZE + signature: MAX_BLOCK_SIZE = 4194304 +- uid: azure.storage.blob.appendblobservice.AppendBlobService.MAX_CHUNK_GET_SIZE + name: MAX_CHUNK_GET_SIZE + signature: MAX_CHUNK_GET_SIZE = 4194304 +- uid: azure.storage.blob.appendblobservice.AppendBlobService.MAX_SINGLE_GET_SIZE + name: MAX_SINGLE_GET_SIZE + signature: MAX_SINGLE_GET_SIZE = 33554432 diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.appendblobservice.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.appendblobservice.yml new file mode 100644 index 00000000..93fd9b58 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.appendblobservice.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.storage.blob.appendblobservice +name: appendblobservice +fullName: azure.storage.blob.appendblobservice +classes: +- azure.storage.blob.appendblobservice.AppendBlobService diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.baseblobservice.BaseBlobService.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.baseblobservice.BaseBlobService.yml new file mode 100644 index 00000000..0e01d8cc --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.baseblobservice.BaseBlobService.yml @@ -0,0 +1,3913 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.baseblobservice.BaseBlobService +name: BaseBlobService +fullName: azure.storage.blob.baseblobservice.BaseBlobService +module: azure.storage.blob.baseblobservice +summary: 'This is the main class managing Blob resources. + + + The Blob service stores text and binary data as blobs in the cloud. + + The Blob service offers the following three resources: the storage account, + + containers, and blobs. Within your storage account, containers provide a + + way to organize sets of blobs. For more information please see: + + [https://msdn.microsoft.com/en-us/library/azure/ee691964.aspx](https://msdn.microsoft.com/en-us/library/azure/ee691964.aspx) + + + :type *~azure.storage.common.TokenCredential*' +constructor: + syntax: BaseBlobService(account_name=None, account_key=None, sas_token=None, is_emulated=False, + protocol='https', endpoint_suffix='core.windows.net', custom_domain=None, request_session=None, + connection_string=None, socket_timeout=None, token_credential=None) + parameters: + - name: account_name + description: 'The storage account name. This is used to authenticate requests + + signed with an account key and to construct the storage endpoint. It + + is required unless a connection string is given, or if a custom + + domain is used with anonymous authentication.' + defaultValue: None + types: + - + - name: account_key + description: 'The storage account key. This is used for shared key authentication. + + If neither account key or sas token is specified, anonymous access + + will be used.' + defaultValue: None + types: + - + - name: sas_token + description: 'A shared access signature token to use to authenticate requests + + instead of the account key. If account key and sas token are both + + specified, account key will be used to sign. If neither are + + specified, anonymous access will be used.' + defaultValue: None + types: + - + - name: is_emulated + description: 'Whether to use the emulator. Defaults to False. If specified, will + + override all other parameters besides connection string and request + + session.' + defaultValue: 'False' + types: + - + - name: protocol + description: The protocol to use for requests. Defaults to https. + defaultValue: https + types: + - + - name: endpoint_suffix + description: 'The host base component of the url, minus the account name. Defaults + + to Azure (core.windows.net). Override this to use the China cloud + + (core.chinacloudapi.cn).' + defaultValue: core.windows.net + types: + - + - name: custom_domain + description: 'The custom domain to use. This can be set in the Azure Portal. For + + example, ''www.mydomain.com''.' + defaultValue: None + types: + - + - name: request_session + description: The session object to use for http requests. + defaultValue: None + types: + - + - name: connection_string + description: 'If specified, this will override all other parameters besides + + request session. See + + [http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/](http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/) + + for the connection string format' + defaultValue: None + types: + - + - name: socket_timeout + description: 'If specified, this will override the default socket timeout. The + timeout specified is in seconds. + + See DEFAULT_SOCKET_TIMEOUT in _constants.py for the default value.' + defaultValue: None + types: + - + - name: token_credential + description: 'A token credential used to authenticate HTTPS requests. The token + value + + should be updated before its expiration.' + defaultValue: None +variables: +- description: 'The size of the first range get performed by get_blob_to_* methods + if + + max_connections is greater than 1. Less data will be returned if the + + blob is smaller than this.' + name: MAX_SINGLE_GET_SIZE + types: + - +- description: 'The size of subsequent range gets performed by get_blob_to_* methods + if + + max_connections is greater than 1 and the blob is larger than MAX_SINGLE_GET_SIZE. + + Less data will be returned if the remainder of the blob is smaller than + + this. If this is set to larger than 4MB, content_validation will throw an + + error if enabled. However, if content_validation is not desired a size + + greater than 4MB may be optimal. Setting this below 4MB is not recommended.' + name: MAX_CHUNK_GET_SIZE + types: + - +- description: "The key-encryption-key optionally provided by the user. If provided,\ + \ will be used to\nencrypt/decrypt in supported methods.\nFor methods requiring\ + \ decryption, either the key_encryption_key OR the resolver must be provided.\n\ + If both are provided, the resolver will take precedence.\nMust implement the following\ + \ methods for APIs requiring encryption:\nwrap_key(key)\u2013wraps the specified\ + \ key (bytes) using an algorithm of the user's choice. Returns the encrypted key\ + \ as bytes.\nget_key_wrap_algorithm()\u2013returns the algorithm used to wrap\ + \ the specified symmetric key.\nget_kid()\u2013returns a string key id for this\ + \ key-encryption-key.\nMust implement the following methods for APIs requiring\ + \ decryption:\nunwrap_key(key, algorithm)\u2013returns the unwrapped form of the\ + \ specified symmetric key using the string-specified algorithm.\nget_kid()\u2013\ + returns a string key id for this key-encryption-key." + name: key_encryption_key + types: + - +- description: 'A function to resolve keys optionally provided by the user. If provided, + will be used to decrypt in supported methods. + + For methods requiring decryption, either the key_encryption_key OR + + the resolver must be provided. If both are provided, the resolver will take precedence. + + It uses the kid string to return a key-encryption-key implementing the interface + defined above.' + name: key_resolver_function + types: + - kid) ( +- description: 'A flag that may be set to ensure that all messages successfully uploaded + to the queue and all those downloaded and + + successfully read from the queue are/were encrypted while on the server. If this + flag is set, all required + + parameters for encryption/decryption must be provided. See the above comments + on the key_encryption_key and resolver.' + name: require_encryption + types: + - +methods: +- uid: azure.storage.blob.baseblobservice.BaseBlobService.abort_copy_blob + name: abort_copy_blob + summary: 'Aborts a pending copy_blob operation, and leaves a destination blob + + with zero length and full metadata.' + signature: abort_copy_blob(container_name, blob_name, copy_id, lease_id=None, timeout=None) + parameters: + - name: container_name + description: Name of destination container. + isRequired: true + types: + - + - name: blob_name + description: Name of destination blob. + isRequired: true + types: + - + - name: copy_id + description: 'Copy identifier provided in the copy.id of the original + + copy_blob operation.' + isRequired: true + types: + - + - name: lease_id + description: Required if the destination blob has an active infinite lease. + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.acquire_blob_lease + name: acquire_blob_lease + summary: 'Requests a new lease. If the blob does not have an active lease, the Blob + + service creates a lease on the blob and returns a new lease ID.' + signature: acquire_blob_lease(container_name, blob_name, lease_duration=-1, proposed_lease_id=None, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: lease_duration + description: 'Specifies the duration of the lease, in seconds, or negative one + + (-1) for a lease that never expires. A non-infinite lease can be + + between 15 and 60 seconds. A lease duration cannot be changed + + using renew or change. Default is -1 (infinite lease).' + defaultValue: '-1' + types: + - + - name: proposed_lease_id + description: 'Proposed lease ID, in a GUID string format. The Blob service + + returns 400 (Invalid request) if the proposed lease ID is not + + in the correct format.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: str +- uid: azure.storage.blob.baseblobservice.BaseBlobService.acquire_container_lease + name: acquire_container_lease + summary: 'Requests a new lease. If the container does not have an active lease, + + the Blob service creates a lease on the container and returns a new + + lease ID.' + signature: acquire_container_lease(container_name, lease_duration=-1, proposed_lease_id=None, + if_modified_since=None, if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_duration + description: 'Specifies the duration of the lease, in seconds, or negative one + + (-1) for a lease that never expires. A non-infinite lease can be + + between 15 and 60 seconds. A lease duration cannot be changed + + using renew or change. Default is -1 (infinite lease).' + defaultValue: '-1' + types: + - + - name: proposed_lease_id + description: 'Proposed lease ID, in a GUID string format. The Blob service returns + + 400 (Invalid request) if the proposed lease ID is not in the correct format.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: str +- uid: azure.storage.blob.baseblobservice.BaseBlobService.batch_delete_blobs + name: batch_delete_blobs + summary: 'Sends a batch of multiple blob delete requests. + + + The blob delete method deletes the specified blob or snapshot. Note that deleting + a blob also deletes all its + + snapshots. For more information, see [https://docs.microsoft.com/rest/api/storageservices/delete-blob](https://docs.microsoft.com/rest/api/storageservices/delete-blob)' + signature: batch_delete_blobs(batch_delete_sub_requests, timeout=None) + parameters: + - name: batch_delete_sub_requests + description: The blob delete requests to send as a batch. + isRequired: true + types: + - () + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: parsed batch delete HTTP response + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.break_blob_lease + name: break_blob_lease + summary: 'Breaks the lease, if the blob has an active lease. Once a lease is broken, + + it cannot be renewed. Any authorized request can break the lease; the request + + is not required to specify a matching lease ID. When a lease is broken, + + the lease break period is allowed to elapse, during which time no lease operation + + except break and release can be performed on the blob. When a lease is successfully + + broken, the response indicates the interval in seconds until a new lease can be + acquired. + + + A lease that has been broken can also be released, in which case another client + may + + immediately acquire the lease on the blob.' + signature: break_blob_lease(container_name, blob_name, lease_break_period=None, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: lease_break_period + description: 'For a break operation, this is the proposed duration of + + seconds that the lease should continue before it is broken, between + + 0 and 60 seconds. This break period is only used if it is shorter + + than the time remaining on the lease. If longer, the time remaining + + on the lease is used. A new lease will not be available before the + + break period has expired, but the lease may be held for longer than + + the break period. If this header does not appear with a break + + operation, a fixed-duration lease breaks after the remaining lease + + period elapses, and an infinite lease breaks immediately.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: int +- uid: azure.storage.blob.baseblobservice.BaseBlobService.break_container_lease + name: break_container_lease + summary: 'Break the lease, if the container has an active lease. Once a lease is + + broken, it cannot be renewed. Any authorized request can break the lease; + + the request is not required to specify a matching lease ID. When a lease + + is broken, the lease break period is allowed to elapse, during which time + + no lease operation except break and release can be performed on the container. + + When a lease is successfully broken, the response indicates the interval + + in seconds until a new lease can be acquired.' + signature: break_container_lease(container_name, lease_break_period=None, if_modified_since=None, + if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_break_period + description: 'This is the proposed duration of seconds that the lease + + should continue before it is broken, between 0 and 60 seconds. This + + break period is only used if it is shorter than the time remaining + + on the lease. If longer, the time remaining on the lease is used. + + A new lease will not be available before the break period has + + expired, but the lease may be held for longer than the break + + period. If this header does not appear with a break + + operation, a fixed-duration lease breaks after the remaining lease + + period elapses, and an infinite lease breaks immediately.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: int +- uid: azure.storage.blob.baseblobservice.BaseBlobService.change_blob_lease + name: change_blob_lease + summary: 'Changes the lease ID of an active lease. A change must include the current + + lease ID and a new lease ID.' + signature: change_blob_lease(container_name, blob_name, lease_id, proposed_lease_id, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: lease_id + description: Required if the blob has an active lease. + isRequired: true + types: + - + - name: proposed_lease_id + description: 'Proposed lease ID, in a GUID string format. The Blob service returns + + 400 (Invalid request) if the proposed lease ID is not in the correct format.' + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.change_container_lease + name: change_container_lease + summary: 'Change the lease ID of an active lease. A change must include the current + + lease ID and a new lease ID.' + signature: change_container_lease(container_name, lease_id, proposed_lease_id, if_modified_since=None, + if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: Lease ID for active lease. + isRequired: true + types: + - + - name: proposed_lease_id + description: 'Proposed lease ID, in a GUID string format. The Blob service returns + 400 + + (Invalid request) if the proposed lease ID is not in the correct format.' + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.copy_blob + name: copy_blob + summary: 'Copies a blob asynchronously. This operation returns a copy operation + + properties object, including a copy ID you can use to check or abort the + + copy operation. The Blob service copies blobs on a best-effort basis. + + + The source blob for a copy operation may be a block blob, an append blob, + + or a page blob. If the destination blob already exists, it must be of the + + same blob type as the source blob. Any existing destination blob will be + + overwritten. The destination blob cannot be modified while a copy operation + + is in progress. + + + When copying from a page blob, the Blob service creates a destination page + + blob of the source blob''s length, initially containing all zeroes. Then + + the source page ranges are enumerated, and non-empty ranges are copied. + + + For a block blob or an append blob, the Blob service creates a committed + + blob of zero length before returning from this operation. When copying + + from a block blob, all committed blocks and their block IDs are copied. + + Uncommitted blocks are not copied. At the end of the copy operation, the + + destination blob will have the same committed block count as the source. + + + When copying from an append blob, all committed blocks are copied. At the + + end of the copy operation, the destination blob will have the same committed + + block count as the source. + + + For all blob types, you can call get_blob_properties on the destination + + blob to check the status of the copy operation. The final blob will be + + committed when the copy completes.' + signature: copy_blob(container_name, blob_name, copy_source, metadata=None, source_if_modified_since=None, + source_if_unmodified_since=None, source_if_match=None, source_if_none_match=None, + destination_if_modified_since=None, destination_if_unmodified_since=None, destination_if_match=None, + destination_if_none_match=None, destination_lease_id=None, source_lease_id=None, + timeout=None) + parameters: + - name: container_name + description: Name of the destination container. The container must exist. + isRequired: true + types: + - + - name: blob_name + description: 'Name of the destination blob. If the destination blob exists, it + will + + be overwritten. Otherwise, it will be created.' + isRequired: true + types: + - + - name: copy_source + description: 'A URL of up to 2 KB in length that specifies an Azure file or blob. + + The value should be URL-encoded as it would appear in a request URI. + + If the source is in another account, the source must either be public + + or must be authenticated via a shared access signature. If the source + + is public, no authentication is required. + + Examples: + + [https://myaccount.blob.core.windows.net/mycontainer/myblob](https://myaccount.blob.core.windows.net/mycontainer/myblob) + + [https://myaccount.blob.core.windows.net/mycontainer/myblob](https://myaccount.blob.core.windows.net/mycontainer/myblob)?snapshot= + + [https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken](https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken)' + isRequired: true + types: + - + - name: metadata + description: 'Name-value pairs associated with the blob as metadata. If no name-value + + pairs are specified, the operation will copy the metadata from the + + source blob or file to the destination blob. If one or more name-value + + pairs are specified, the destination blob is created with the specified + + metadata, and metadata is not copied from the source blob or file.' + defaultValue: None + types: + - (, ) + - name: source_if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this conditional header to copy the blob only if the source + + blob has been modified since the specified date/time.' + defaultValue: None + types: + - + - name: source_if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this conditional header to copy the blob only if the source blob + + has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: source_if_match + description: 'An ETag value, or the wildcard character (*). Specify this conditional + + header to copy the source blob only if its ETag matches the value + + specified. If the ETag values do not match, the Blob service returns + + status code 412 (Precondition Failed). This header cannot be specified + + if the source is an Azure File.' + defaultValue: None + types: + - + - name: source_if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this conditional + + header to copy the blob only if its ETag does not match the value + + specified. If the values are identical, the Blob service returns status + + code 412 (Precondition Failed). This header cannot be specified if the + + source is an Azure File.' + defaultValue: None + types: + - + - name: destination_if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this conditional header to copy the blob only + + if the destination blob has been modified since the specified date/time. + + If the destination blob has not been modified, the Blob service returns + + status code 412 (Precondition Failed).' + defaultValue: None + types: + - + - name: destination_if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this conditional header to copy the blob only + + if the destination blob has not been modified since the specified + + date/time. If the destination blob has been modified, the Blob service + + returns status code 412 (Precondition Failed).' + defaultValue: None + types: + - + - name: destination_if_match + description: 'An ETag value, or the wildcard character (*). Specify an ETag value + for + + this conditional header to copy the blob only if the specified ETag value + + matches the ETag value for an existing destination blob. If the ETag for + + the destination blob does not match the ETag specified for If-Match, the + + Blob service returns status code 412 (Precondition Failed).' + defaultValue: None + types: + - + - name: destination_if_none_match + description: 'An ETag value, or the wildcard character (*). Specify an ETag value + for + + this conditional header to copy the blob only if the specified ETag value + + does not match the ETag value for the destination blob. Specify the wildcard + + character (*) to perform the operation only if the destination blob does not + + exist. If the specified condition isn''t met, the Blob service returns status + + code 412 (Precondition Failed).' + defaultValue: None + types: + - + - name: destination_lease_id + description: 'The lease ID specified for this header must match the lease ID of + the + + destination blob. If the request does not include the lease ID or it is not + + valid, the operation fails with status code 412 (Precondition Failed).' + defaultValue: None + types: + - + - name: source_lease_id + description: 'Specify this to perform the Copy Blob operation only if + + the lease ID given matches the active lease ID of the source blob.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: Copy operation properties such as status, source, and ID. + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.create_container + name: create_container + summary: 'Creates a new container under the specified account. If the container + + with the same name already exists, the operation fails if + + fail_on_exist is True.' + signature: create_container(container_name, metadata=None, public_access=None, fail_on_exist=False, + timeout=None) + parameters: + - name: container_name + description: 'Name of container to create. + + The container name may only contain lowercase letters, numbers, and hyphens, + and must begin with a letter or + + a number. Each hyphen must be preceded and followed by a non-hyphen character. + The name must also be + + between 3 and 63 characters long.' + isRequired: true + types: + - + - name: metadata + description: 'A dict with name_value pairs to associate with the + + container as metadata. Example:{''Category'':''test''}' + defaultValue: None + types: + - (, ) + - name: public_access + description: 'Possible values include: container, blob.' + defaultValue: None + types: + - + - name: fail_on_exist + description: Specify whether to throw an exception when the container exists. + defaultValue: 'False' + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: True if container is created, False if container already exists. + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.delete_blob + name: delete_blob + summary: 'Marks the specified blob or snapshot for deletion. + + The blob is later deleted during garbage collection. + + + Note that in order to delete a blob, you must delete all of its + + snapshots. You can delete both at the same time with the Delete + + Blob operation. + + + If a delete retention policy is enabled for the service, then this operation soft + deletes the blob or snapshot + + and retains the blob or snapshot for specified number of days. + + After specified number of days, blob''s data is removed from the service during + garbage collection. + + Soft deleted blob or snapshot is accessible through List Blobs API specifying + include=Include.Deleted option. + + Soft-deleted blob or snapshot can be restored using Undelete API.' + signature: delete_blob(container_name, blob_name, snapshot=None, lease_id=None, + delete_snapshots=None, if_modified_since=None, if_unmodified_since=None, if_match=None, + if_none_match=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to delete.' + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: delete_snapshots + description: Required if the blob has associated snapshots. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.delete_container + name: delete_container + summary: 'Marks the specified container for deletion. The container and any blobs + + contained within it are later deleted during garbage collection.' + signature: delete_container(container_name, fail_not_exist=False, lease_id=None, + if_modified_since=None, if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of container to delete. + isRequired: true + types: + - + - name: fail_not_exist + description: 'Specify whether to throw an exception when the container doesn''t + + exist.' + defaultValue: 'False' + types: + - + - name: lease_id + description: 'If specified, delete_container only succeeds if the + + container''s lease is active and matches this ID. + + Required if the container has an active lease.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: True if container is deleted, False container doesn't exist. + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.exists + name: exists + summary: 'Returns a boolean indicating whether the container exists (if blob_name + + is None), or otherwise a boolean indicating whether the blob exists.' + signature: exists(container_name, blob_name=None, snapshot=None, timeout=None) + parameters: + - name: container_name + description: Name of a container. + isRequired: true + types: + - + - name: blob_name + description: Name of a blob. If None, the container will be checked for existence. + defaultValue: None + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the snapshot.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: A boolean indicating whether the resource exists. + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.extract_date_and_request_id + name: extract_date_and_request_id + signature: static extract_date_and_request_id(retry_context) + parameters: + - name: retry_context + isRequired: true +- uid: azure.storage.blob.baseblobservice.BaseBlobService.generate_account_shared_access_signature + name: generate_account_shared_access_signature + summary: 'Generates a shared access signature for the blob service. + + Use the returned signature with the sas_token parameter of any BlobService.' + signature: generate_account_shared_access_signature(resource_types, permission, + expiry, start=None, ip=None, protocol=None) + parameters: + - name: resource_types + description: Specifies the resource types that are accessible with the account + SAS. + isRequired: true + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy.' + isRequired: true + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + isRequired: true + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. The default + value + + is https,http. See for possible + values.' + defaultValue: None + types: + - + return: + description: A Shared Access Signature (sas) token. + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.generate_blob_shared_access_signature + name: generate_blob_shared_access_signature + summary: 'Generates a shared access signature for the blob or one of its snapshots. + + Use the returned signature with the sas_token parameter of any BlobService.' + signature: generate_blob_shared_access_signature(container_name, blob_name, snapshot=None, + permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, + content_disposition=None, content_encoding=None, content_language=None, content_type=None, + user_delegation_key=None) + parameters: + - name: container_name + description: Name of container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to grant permission.' + defaultValue: None + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Permissions must be ordered read, write, delete, list. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy.' + defaultValue: None + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + defaultValue: None + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: id + description: 'A unique value up to 64 characters in length that correlates to + a + + stored access policy. To create a stored access policy, use .' + defaultValue: None + types: + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. The default + value + + is https,http. See for possible + values.' + defaultValue: None + types: + - + - name: cache_control + description: 'Response header value for Cache-Control when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_disposition + description: 'Response header value for Content-Disposition when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_encoding + description: 'Response header value for Content-Encoding when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_language + description: 'Response header value for Content-Language when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_type + description: 'Response header value for Content-Type when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: user_delegation_key + description: 'Instead of an account key, the user could pass in a user delegation + key. + + A user delegation key can be obtained from the service by authenticating with + an AAD identity; + + this can be accomplished by calling get_user_delegation_key. + + When present, the SAS is signed with the user delegation key instead.' + defaultValue: None + types: + - + return: + description: A Shared Access Signature (sas) token. + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.generate_container_shared_access_signature + name: generate_container_shared_access_signature + summary: 'Generates a shared access signature for the container. + + Use the returned signature with the sas_token parameter of any BlobService.' + signature: generate_container_shared_access_signature(container_name, permission=None, + expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, + content_disposition=None, content_encoding=None, content_language=None, content_type=None, + user_delegation_key=None) + parameters: + - name: container_name + description: Name of container. + isRequired: true + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Permissions must be ordered read, write, delete, list. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy.' + defaultValue: None + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + defaultValue: None + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: id + description: 'A unique value up to 64 characters in length that correlates to + a + + stored access policy. To create a stored access policy, use + + set_blob_service_properties.' + defaultValue: None + types: + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. The default + value + + is https,http. See for possible + values.' + defaultValue: None + types: + - + - name: cache_control + description: 'Response header value for Cache-Control when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_disposition + description: 'Response header value for Content-Disposition when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_encoding + description: 'Response header value for Content-Encoding when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_language + description: 'Response header value for Content-Language when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_type + description: 'Response header value for Content-Type when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: user_delegation_key + description: 'Instead of an account key, the user could pass in a user delegation + key. + + A user delegation key can be obtained from the service by authenticating with + an AAD identity; + + this can be accomplished by calling get_user_delegation_key. + + When present, the SAS is signed with the user delegation key instead.' + defaultValue: None + types: + - + return: + description: A Shared Access Signature (sas) token. + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.get_blob_account_information + name: get_blob_account_information + summary: 'Gets information related to the storage account. + + The information can also be retrieved if the user has a SAS to a container or + blob.' + signature: get_blob_account_information(container_name=None, blob_name=None, timeout=None) + parameters: + - name: container_name + description: 'Name of existing container. + + Optional, unless using a SAS token to a specific container or blob, in which + case it''s required.' + defaultValue: None + types: + - + - name: blob_name + description: 'Name of existing blob. + + Optional, unless using a SAS token to a specific blob, in which case it''s required.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: The . +- uid: azure.storage.blob.baseblobservice.BaseBlobService.get_blob_metadata + name: get_blob_metadata + summary: Returns all user-defined metadata for the specified blob or snapshot. + signature: get_blob_metadata(container_name, blob_name, snapshot=None, lease_id=None, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: A dictionary representing the blob metadata name, value pairs. + types: + - (, ) +- uid: azure.storage.blob.baseblobservice.BaseBlobService.get_blob_properties + name: get_blob_properties + summary: 'Returns all user-defined metadata, standard HTTP properties, and + + system properties for the blob. It does not return the content of the blob. + + Returns + + with and a metadata dict.' + signature: get_blob_properties(container_name, blob_name, snapshot=None, lease_id=None, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: a blob object including properties and metadata. + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.get_blob_service_properties + name: get_blob_service_properties + summary: 'Gets the properties of a storage account''s Blob service, including + + Azure Storage Analytics.' + signature: get_blob_service_properties(timeout=None) + parameters: + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: 'The blob with + an attached + + target_version property.' +- uid: azure.storage.blob.baseblobservice.BaseBlobService.get_blob_service_stats + name: get_blob_service_stats + summary: 'Retrieves statistics related to replication for the Blob service. It is + + only available when read-access geo-redundant replication is enabled for + + the storage account. + + + With geo-redundant replication, Azure Storage maintains your data durable + + in two locations. In both locations, Azure Storage constantly maintains + + multiple healthy replicas of your data. The location where you read, + + create, update, or delete data is the primary storage account location. + + The primary location exists in the region you choose at the time you + + create an account via the Azure Management Azure classic portal, for + + example, North Central US. The location to which your data is replicated + + is the secondary location. The secondary location is automatically + + determined based on the location of the primary; it is in a second data + + center that resides in the same region as the primary location. Read-only + + access is available from the secondary location, if read-access geo-redundant + + replication is enabled for your storage account.' + signature: get_blob_service_stats(timeout=None) + parameters: + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: The blob service stats. + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.get_blob_to_bytes + name: get_blob_to_bytes + summary: 'Downloads a blob as an array of bytes, with automatic chunking and + + progress notifications. Returns an instance of + with + + properties, metadata, and content.' + signature: get_blob_to_bytes(container_name, blob_name, snapshot=None, start_range=None, + end_range=None, validate_content=False, progress_callback=None, max_connections=2, + lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, + if_none_match=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: start_range + description: 'Start of byte range to use for downloading a section of the blob. + + If no end_range is given, all bytes after the start_range will be downloaded. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: end_range + description: 'End of byte range to use for downloading a section of the blob. + + If end_range is given, start_range must be provided. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: validate_content + description: 'If set to true, validates an MD5 hash for each retrieved portion + of + + the blob. This is primarily valuable for detecting bitflips on the wire + + if using http instead of https as https (the default) will already + + validate. Note that the service will only return transactional MD5s + + for chunks 4MB or less so the first get request will be of size + + self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If + + self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be + + thrown. As computing the MD5 takes processing time and more requests + + will need to be done due to the reduced chunk size there may be some + + increase in latency.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) + + where current is the number of bytes transfered so far, and total is + + the size of the blob if known.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'If set to 2 or greater, an initial get will be done for the first + + self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob, + + the method returns at this point. If it is not, it will download the + + remaining data parallel using the number of threads equal to + + max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. + + If set to 1, a single large get request will be done. This is not + + generally recommended but available if very few threads should be + + used, network requests are very expensive, or a non-seekable stream + + prevents parallel download. This may also be useful if many blobs are + + expected to be empty as an extra request is required for empty blobs + + if max_connections is greater than 1.' + defaultValue: '2' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + return: + description: 'A Blob with properties and metadata. If max_connections is greater + + than 1, the content_md5 (if set on the blob) will not be returned. If you + + require this value, either use get_blob_properties or set max_connections + + to 1.' + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.get_blob_to_path + name: get_blob_to_path + summary: 'Downloads a blob to a file path, with automatic chunking and progress + + notifications. Returns an instance of with + + properties and metadata.' + signature: get_blob_to_path(container_name, blob_name, file_path, open_mode='wb', + snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, + max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, + if_match=None, if_none_match=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: file_path + description: Path of file to write out to. + isRequired: true + types: + - + - name: open_mode + description: 'Mode to use when opening the file. Note that specifying append only + + open_mode prevents parallel download. So, max_connections must be set + + to 1 if this open_mode is used.' + defaultValue: wb + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: start_range + description: 'Start of byte range to use for downloading a section of the blob. + + If no end_range is given, all bytes after the start_range will be downloaded. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: end_range + description: 'End of byte range to use for downloading a section of the blob. + + If end_range is given, start_range must be provided. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: validate_content + description: 'If set to true, validates an MD5 hash for each retrieved portion + of + + the blob. This is primarily valuable for detecting bitflips on the wire + + if using http instead of https as https (the default) will already + + validate. Note that the service will only return transactional MD5s + + for chunks 4MB or less so the first get request will be of size + + self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If + + self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be + + thrown. As computing the MD5 takes processing time and more requests + + will need to be done due to the reduced chunk size there may be some + + increase in latency.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) + + where current is the number of bytes transfered so far, and total is + + the size of the blob if known.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'If set to 2 or greater, an initial get will be done for the first + + self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob, + + the method returns at this point. If it is not, it will download the + + remaining data parallel using the number of threads equal to + + max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. + + If set to 1, a single large get request will be done. This is not + + generally recommended but available if very few threads should be + + used, network requests are very expensive, or a non-seekable stream + + prevents parallel download. This may also be useful if many blobs are + + expected to be empty as an extra request is required for empty blobs + + if max_connections is greater than 1.' + defaultValue: '2' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + return: + description: 'A Blob with properties and metadata. If max_connections is greater + + than 1, the content_md5 (if set on the blob) will not be returned. If you + + require this value, either use get_blob_properties or set max_connections + + to 1.' + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.get_blob_to_stream + name: get_blob_to_stream + summary: 'Downloads a blob to a stream, with automatic chunking and progress + + notifications. Returns an instance of with + + properties and metadata.' + signature: get_blob_to_stream(container_name, blob_name, stream, snapshot=None, + start_range=None, end_range=None, validate_content=False, progress_callback=None, + max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, + if_match=None, if_none_match=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: stream + description: Opened stream to write to. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: start_range + description: 'Start of byte range to use for downloading a section of the blob. + + If no end_range is given, all bytes after the start_range will be downloaded. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: end_range + description: 'End of byte range to use for downloading a section of the blob. + + If end_range is given, start_range must be provided. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: validate_content + description: 'If set to true, validates an MD5 hash for each retrieved portion + of + + the blob. This is primarily valuable for detecting bitflips on the wire + + if using http instead of https as https (the default) will already + + validate. Note that the service will only return transactional MD5s + + for chunks 4MB or less so the first get request will be of size + + self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If + + self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be + + thrown. As computing the MD5 takes processing time and more requests + + will need to be done due to the reduced chunk size there may be some + + increase in latency.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) + + where current is the number of bytes transfered so far, and total is + + the size of the blob if known.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'If set to 2 or greater, an initial get will be done for the first + + self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob, + + the method returns at this point. If it is not, it will download the + + remaining data parallel using the number of threads equal to + + max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. + + If set to 1, a single large get request will be done. This is not + + generally recommended but available if very few threads should be + + used, network requests are very expensive, or a non-seekable stream + + prevents parallel download. This may also be useful if many blobs are + + expected to be empty as an extra request is required for empty blobs + + if max_connections is greater than 1.' + defaultValue: '2' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + return: + description: 'A Blob with properties and metadata. If max_connections is greater + + than 1, the content_md5 (if set on the blob) will not be returned. If you + + require this value, either use get_blob_properties or set max_connections + + to 1.' + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.get_blob_to_text + name: get_blob_to_text + summary: 'Downloads a blob as unicode text, with automatic chunking and progress + + notifications. Returns an instance of with + + properties, metadata, and content.' + signature: get_blob_to_text(container_name, blob_name, encoding='utf-8', snapshot=None, + start_range=None, end_range=None, validate_content=False, progress_callback=None, + max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, + if_match=None, if_none_match=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: encoding + description: Python encoding to use when decoding the blob data. + defaultValue: utf-8 + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: start_range + description: 'Start of byte range to use for downloading a section of the blob. + + If no end_range is given, all bytes after the start_range will be downloaded. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: end_range + description: 'End of byte range to use for downloading a section of the blob. + + If end_range is given, start_range must be provided. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: validate_content + description: 'If set to true, validates an MD5 hash for each retrieved portion + of + + the blob. This is primarily valuable for detecting bitflips on the wire + + if using http instead of https as https (the default) will already + + validate. Note that the service will only return transactional MD5s + + for chunks 4MB or less so the first get request will be of size + + self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If + + self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be + + thrown. As computing the MD5 takes processing time and more requests + + will need to be done due to the reduced chunk size there may be some + + increase in latency.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) + + where current is the number of bytes transfered so far, and total is + + the size of the blob if known.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'If set to 2 or greater, an initial get will be done for the first + + self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob, + + the method returns at this point. If it is not, it will download the + + remaining data parallel using the number of threads equal to + + max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. + + If set to 1, a single large get request will be done. This is not + + generally recommended but available if very few threads should be + + used, network requests are very expensive, or a non-seekable stream + + prevents parallel download. This may also be useful if many blobs are + + expected to be empty as an extra request is required for empty blobs + + if max_connections is greater than 1.' + defaultValue: '2' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + return: + description: 'A Blob with properties and metadata. If max_connections is greater + + than 1, the content_md5 (if set on the blob) will not be returned. If you + + require this value, either use get_blob_properties or set max_connections + + to 1.' + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.get_container_acl + name: get_container_acl + summary: 'Gets the permissions for the specified container. + + The permissions indicate whether container data may be accessed publicly.' + signature: get_container_acl(container_name, lease_id=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: 'If specified, get_container_acl only succeeds if the + + container''s lease is active and matches this ID.' + defaultValue: None + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: 'A dictionary of access policies associated with the container. dict + of str to + + and a public_access property + + if public access is turned on' +- uid: azure.storage.blob.baseblobservice.BaseBlobService.get_container_metadata + name: get_container_metadata + summary: Returns all user-defined metadata for the specified container. + signature: get_container_metadata(container_name, lease_id=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: 'If specified, get_container_metadata only succeeds if the + + container''s lease is active and matches this ID.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: A dictionary representing the container metadata name, value pairs. + types: + - (, ) +- uid: azure.storage.blob.baseblobservice.BaseBlobService.get_container_properties + name: get_container_properties + summary: 'Returns all user-defined metadata and system properties for the specified + + container. The data returned does not include the container''s list of blobs.' + signature: get_container_properties(container_name, lease_id=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: 'If specified, get_container_properties only succeeds if the + + container''s lease is active and matches this ID.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: properties for the specified container within a container object. + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.get_user_delegation_key + name: get_user_delegation_key + summary: 'Obtain a user delegation key for the purpose of signing SAS tokens. + + A token credential must be present on the service object for this request to succeed.' + signature: get_user_delegation_key(key_start_time, key_expiry_time, timeout=None) + parameters: + - name: key_start_time + description: A DateTime value. Indicates when the key becomes valid. + isRequired: true + types: + - + - name: key_expiry_time + description: A DateTime value. Indicates when the key stops being valid. + isRequired: true + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: The user delegation key. + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.list_blob_names + name: list_blob_names + summary: 'Returns a generator to list the blob names under the specified container. + + The generator will lazily follow the continuation tokens returned by + + the service and stop when all blobs have been returned or num_results is reached. + + + If num_results is specified and the account has more than that number of + + blobs, the generator will have a populated next_marker field once it + + finishes. This marker can be used to create a new generator if more + + results are desired.' + signature: list_blob_names(container_name, prefix=None, num_results=None, include=None, + delimiter=None, marker=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: prefix + description: 'Filters the results to return only blobs whose names + + begin with the specified prefix.' + defaultValue: None + types: + - + - name: num_results + description: 'Specifies the maximum number of blobs to return, + + including all elements. + If the request does not specify + + num_results or specifies a value greater than 5,000, the server will + + return up to 5,000 items. Setting num_results to a value less than + + or equal to zero results in error response code 400 (Bad Request).' + defaultValue: None + types: + - + - name: include + description: Specifies one or more additional datasets to include in the response. + defaultValue: None + types: + - + - name: delimiter + description: 'When the request includes this parameter, the operation + + returns a element in the + + result list that acts as a placeholder for all blobs whose names begin + + with the same substring up to the appearance of the delimiter character. + + The delimiter may be a single character or a string.' + defaultValue: None + types: + - + - name: marker + description: 'An opaque continuation token. This value can be retrieved from the + + next_marker field of a previous generator object if num_results was + + specified and that generator has finished enumerating results. If + + specified, this generator will begin returning results from the point + + where the previous generator stopped.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.list_blobs + name: list_blobs + summary: 'Returns a generator to list the blobs under the specified container. + + The generator will lazily follow the continuation tokens returned by + + the service and stop when all blobs have been returned or num_results is reached. + + + If num_results is specified and the account has more than that number of + + blobs, the generator will have a populated next_marker field once it + + finishes. This marker can be used to create a new generator if more + + results are desired.' + signature: list_blobs(container_name, prefix=None, num_results=None, include=None, + delimiter=None, marker=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: prefix + description: 'Filters the results to return only blobs whose names + + begin with the specified prefix.' + defaultValue: None + types: + - + - name: num_results + description: 'Specifies the maximum number of blobs to return, + + including all elements. + If the request does not specify + + num_results or specifies a value greater than 5,000, the server will + + return up to 5,000 items. Setting num_results to a value less than + + or equal to zero results in error response code 400 (Bad Request).' + defaultValue: None + types: + - + - name: include + description: Specifies one or more additional datasets to include in the response. + defaultValue: None + types: + - + - name: delimiter + description: 'When the request includes this parameter, the operation + + returns a element in the + + result list that acts as a placeholder for all blobs whose names begin + + with the same substring up to the appearance of the delimiter character. + + The delimiter may be a single character or a string.' + defaultValue: None + types: + - + - name: marker + description: 'An opaque continuation token. This value can be retrieved from the + + next_marker field of a previous generator object if num_results was + + specified and that generator has finished enumerating results. If + + specified, this generator will begin returning results from the point + + where the previous generator stopped.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.list_containers + name: list_containers + summary: 'Returns a generator to list the containers under the specified account. + + The generator will lazily follow the continuation tokens returned by + + the service and stop when all containers have been returned or num_results is + reached. + + + If num_results is specified and the account has more than that number of + + containers, the generator will have a populated next_marker field once it + + finishes. This marker can be used to create a new generator if more + + results are desired.' + signature: list_containers(prefix=None, num_results=None, include_metadata=False, + marker=None, timeout=None) + parameters: + - name: prefix + description: 'Filters the results to return only containers whose names + + begin with the specified prefix.' + defaultValue: None + types: + - + - name: num_results + description: 'Specifies the maximum number of containers to return. A single list + + request may return up to 1000 contianers and potentially a continuation + + token which should be followed to get additional resutls.' + defaultValue: None + types: + - + - name: include_metadata + description: Specifies that container metadata be returned in the response. + defaultValue: 'False' + types: + - + - name: marker + description: 'An opaque continuation token. This value can be retrieved from the + + next_marker field of a previous generator object if num_results was + + specified and that generator has finished enumerating results. If + + specified, this generator will begin returning results from the point + + where the previous generator stopped.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.make_blob_url + name: make_blob_url + summary: Creates the url to access a blob. + signature: make_blob_url(container_name, blob_name, protocol=None, sas_token=None, + snapshot=None) + parameters: + - name: container_name + description: Name of container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob. + isRequired: true + types: + - + - name: protocol + description: 'Protocol to use: ''http'' or ''https''. If not specified, uses the + + protocol specified when BaseBlobService was initialized.' + defaultValue: None + types: + - + - name: sas_token + description: 'Shared access signature token created with + + generate_shared_access_signature.' + defaultValue: None + types: + - + - name: snapshot + description: 'An string value that uniquely identifies the snapshot. The value + of + + this query parameter indicates the snapshot version.' + defaultValue: None + types: + - + return: + description: blob access URL. + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.make_container_url + name: make_container_url + summary: Creates the url to access a container. + signature: make_container_url(container_name, protocol=None, sas_token=None) + parameters: + - name: container_name + description: Name of container. + isRequired: true + types: + - + - name: protocol + description: 'Protocol to use: ''http'' or ''https''. If not specified, uses the + + protocol specified when BaseBlobService was initialized.' + defaultValue: None + types: + - + - name: sas_token + description: 'Shared access signature token created with + + generate_shared_access_signature.' + defaultValue: None + types: + - + return: + description: container access URL. + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.release_blob_lease + name: release_blob_lease + summary: 'Releases the lease. The lease may be released if the lease ID specified + on the + + request matches that associated with the blob. Releasing the lease allows another + + client to immediately acquire the lease for the blob as soon as the release is + complete.' + signature: release_blob_lease(container_name, blob_name, lease_id, if_modified_since=None, + if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: lease_id + description: Lease ID for active lease. + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.release_container_lease + name: release_container_lease + summary: 'Release the lease. The lease may be released if the lease_id specified + matches + + that associated with the container. Releasing the lease allows another client + + to immediately acquire the lease for the container as soon as the release is complete.' + signature: release_container_lease(container_name, lease_id, if_modified_since=None, + if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: Lease ID for active lease. + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.renew_blob_lease + name: renew_blob_lease + summary: 'Renews the lease. The lease can be renewed if the lease ID specified on + + the request matches that associated with the blob. Note that the lease may + + be renewed even if it has expired as long as the blob has not been modified + + or leased again since the expiration of that lease. When you renew a lease, + + the lease duration clock resets.' + signature: renew_blob_lease(container_name, blob_name, lease_id, if_modified_since=None, + if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: lease_id + description: Lease ID for active lease. + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: str +- uid: azure.storage.blob.baseblobservice.BaseBlobService.renew_container_lease + name: renew_container_lease + summary: 'Renews the lease. The lease can be renewed if the lease ID specified + + matches that associated with the container. Note that + + the lease may be renewed even if it has expired as long as the container + + has not been leased again since the expiration of that lease. When you + + renew a lease, the lease duration clock resets.' + signature: renew_container_lease(container_name, lease_id, if_modified_since=None, + if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: Lease ID for active lease. + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: str +- uid: azure.storage.blob.baseblobservice.BaseBlobService.set_blob_metadata + name: set_blob_metadata + summary: 'Sets user-defined metadata for the specified blob as one or more + + name-value pairs.' + signature: set_blob_metadata(container_name, blob_name, metadata=None, lease_id=None, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: metadata + description: 'Dict containing name and value pairs. Each call to this operation + + replaces all existing metadata attached to the blob. To remove all + + metadata from the blob, call this operation with no metadata headers.' + defaultValue: None + types: + - (, ) + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the updated Blob + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.set_blob_properties + name: set_blob_properties + summary: 'Sets system properties on the blob. If one property is set for the + + content_settings, all properties will be overriden.' + signature: set_blob_properties(container_name, blob_name, content_settings=None, + lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, + if_none_match=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: content_settings + description: ContentSettings object used to set blob properties. + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the updated Blob + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.set_blob_service_properties + name: set_blob_service_properties + summary: 'Sets the properties of a storage account''s Blob service, including + + Azure Storage Analytics. If an element (ex Logging) is left as None, the + + existing settings on the service for that functionality are preserved.' + signature: set_blob_service_properties(logging=None, hour_metrics=None, minute_metrics=None, + cors=None, target_version=None, timeout=None, delete_retention_policy=None, static_website=None) + parameters: + - name: logging + description: Groups the Azure Analytics Logging settings. + defaultValue: None + types: + - + - name: hour_metrics + description: 'The hour metrics settings provide a summary of request + + statistics grouped by API in hourly aggregates for blobs.' + defaultValue: None + types: + - + - name: minute_metrics + description: 'The minute metrics settings provide request statistics + + for each minute for blobs.' + defaultValue: None + types: + - + - name: cors + description: 'You can include up to five CorsRule elements in the + + list. If an empty list is specified, all CORS rules will be deleted, + + and CORS will be disabled for the service.' + defaultValue: None + types: + - list() + - name: target_version + description: 'Indicates the default version to use for requests if an incoming + + request''s version is not specified.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + - name: delete_retention_policy + description: 'The delete retention policy specifies whether to retain deleted + blobs. + + It also specifies the number of days and versions of blob to keep.' + defaultValue: None + types: + - + - name: static_website + description: 'Specifies whether the static website feature is enabled, + + and if yes, indicates the index document and 404 error document to use.' + defaultValue: None + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.set_container_acl + name: set_container_acl + summary: 'Sets the permissions for the specified container or stored access + + policies that may be used with Shared Access Signatures. The permissions + + indicate whether blobs in a container may be accessed publicly.' + signature: set_container_acl(container_name, signed_identifiers=None, public_access=None, + lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: signed_identifiers + description: 'A dictionary of access policies to associate with the container. + The + + dictionary may contain up to 5 elements. An empty dictionary + + will clear the access policies set on the service.' + defaultValue: None + types: + - dict(str, ) + - name: public_access + description: 'Possible values include: container, blob.' + defaultValue: None + types: + - + - name: lease_id + description: 'If specified, set_container_acl only succeeds if the + + container''s lease is active and matches this ID.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A datetime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A datetime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the updated Container + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.set_container_metadata + name: set_container_metadata + summary: 'Sets one or more user-defined name-value pairs for the specified + + container. Each call to this operation replaces all existing metadata + + attached to the container. To remove all metadata from the container, + + call this operation with no metadata dict.' + signature: set_container_metadata(container_name, metadata=None, lease_id=None, + if_modified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: metadata + description: 'A dict containing name-value pairs to associate with the container + as + + metadata. Example: {''category'':''test''}' + defaultValue: None + types: + - (, ) + - name: lease_id + description: 'If specified, set_container_metadata only succeeds if the + + container''s lease is active and matches this ID.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the updated Container + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.set_proxy + name: set_proxy + summary: Sets the proxy server host and port for the HTTP CONNECT Tunnelling. + signature: set_proxy(host, port, user=None, password=None) + parameters: + - name: host + description: 'Address of the proxy. Ex: ''192.168.0.100''' + isRequired: true + types: + - + - name: port + description: 'Port of the proxy. Ex: 6000' + isRequired: true + types: + - + - name: user + description: User for proxy authorization. + defaultValue: None + types: + - + - name: password + description: Password for proxy authorization. + defaultValue: None + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.snapshot_blob + name: snapshot_blob + summary: Creates a read-only snapshot of a blob. + signature: snapshot_blob(container_name, blob_name, metadata=None, if_modified_since=None, + if_unmodified_since=None, if_match=None, if_none_match=None, lease_id=None, timeout=None, + cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: metadata + description: 'Specifies a user-defined name-value pair associated with the blob. + + If no name-value pairs are specified, the operation will copy the + + base blob metadata to the snapshot. If one or more name-value pairs + + are specified, the snapshot is created with the specified metadata, + + and metadata is not copied from the base blob.' + defaultValue: None + types: + - (, ) + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: snapshot properties + types: + - +- uid: azure.storage.blob.baseblobservice.BaseBlobService.undelete_blob + name: undelete_blob + summary: 'The undelete Blob operation restores the contents and metadata of soft + deleted blob or snapshot. + + Attempting to undelete a blob or snapshot that is not soft deleted will succeed + without any changes.' + signature: undelete_blob(container_name, blob_name, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +attributes: +- uid: azure.storage.blob.baseblobservice.BaseBlobService.protocol + name: protocol +- uid: azure.storage.blob.baseblobservice.BaseBlobService.request_session + name: request_session +- uid: azure.storage.blob.baseblobservice.BaseBlobService.socket_timeout + name: socket_timeout +- uid: azure.storage.blob.baseblobservice.BaseBlobService.MAX_CHUNK_GET_SIZE + name: MAX_CHUNK_GET_SIZE + signature: MAX_CHUNK_GET_SIZE = 4194304 +- uid: azure.storage.blob.baseblobservice.BaseBlobService.MAX_SINGLE_GET_SIZE + name: MAX_SINGLE_GET_SIZE + signature: MAX_SINGLE_GET_SIZE = 33554432 diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.baseblobservice.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.baseblobservice.yml new file mode 100644 index 00000000..fb873eba --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.baseblobservice.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.storage.blob.baseblobservice +name: baseblobservice +fullName: azure.storage.blob.baseblobservice +classes: +- azure.storage.blob.baseblobservice.BaseBlobService diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.blockblobservice.BlockBlobService.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.blockblobservice.BlockBlobService.yml new file mode 100644 index 00000000..fbc19c4c --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.blockblobservice.BlockBlobService.yml @@ -0,0 +1,4996 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.blockblobservice.BlockBlobService +name: BlockBlobService +fullName: azure.storage.blob.blockblobservice.BlockBlobService +module: azure.storage.blob.blockblobservice +summary: 'Block blobs let you upload large blobs efficiently. Block blobs are comprised + + of blocks, each of which is identified by a block ID. You create or modify a + + block blob by writing a set of blocks and committing them by their block IDs. + + Each block can be a different size, up to a maximum of 100 MB, and a block blob + + can include up to 50,000 blocks. The maximum size of a block blob is therefore + + approximately 4.75 TB (100 MB X 50,000 blocks). If you are writing a block + + blob that is no more than 64 MB in size, you can upload it in its entirety with + + a single write operation; see create_blob_from_bytes. + + + :type *~azure.storage.common.TokenCredential*' +constructor: + syntax: BlockBlobService(account_name=None, account_key=None, sas_token=None, is_emulated=False, + protocol='https', endpoint_suffix='core.windows.net', custom_domain=None, request_session=None, + connection_string=None, socket_timeout=None, token_credential=None) + parameters: + - name: account_name + description: 'The storage account name. This is used to authenticate requests + + signed with an account key and to construct the storage endpoint. It + + is required unless a connection string is given, or if a custom + + domain is used with anonymous authentication.' + defaultValue: None + types: + - + - name: account_key + description: 'The storage account key. This is used for shared key authentication. + + If neither account key or sas token is specified, anonymous access + + will be used.' + defaultValue: None + types: + - + - name: sas_token + description: 'A shared access signature token to use to authenticate requests + + instead of the account key. If account key and sas token are both + + specified, account key will be used to sign. If neither are + + specified, anonymous access will be used.' + defaultValue: None + types: + - + - name: is_emulated + description: 'Whether to use the emulator. Defaults to False. If specified, will + + override all other parameters besides connection string and request + + session.' + defaultValue: 'False' + types: + - + - name: protocol + description: The protocol to use for requests. Defaults to https. + defaultValue: https + types: + - + - name: endpoint_suffix + description: 'The host base component of the url, minus the account name. Defaults + + to Azure (core.windows.net). Override this to use the China cloud + + (core.chinacloudapi.cn).' + defaultValue: core.windows.net + types: + - + - name: custom_domain + description: 'The custom domain to use. This can be set in the Azure Portal. For + + example, ''www.mydomain.com''.' + defaultValue: None + types: + - + - name: request_session + description: The session object to use for http requests. + defaultValue: None + types: + - + - name: connection_string + description: 'If specified, this will override all other parameters besides + + request session. See + + [http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/](http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/) + + for the connection string format.' + defaultValue: None + types: + - + - name: socket_timeout + description: 'If specified, this will override the default socket timeout. The + timeout specified is in seconds. + + See DEFAULT_SOCKET_TIMEOUT in _constants.py for the default value.' + defaultValue: None + types: + - + - name: token_credential + description: 'A token credential used to authenticate HTTPS requests. The token + value + + should be updated before its expiration.' + defaultValue: None +variables: +- description: 'The largest size upload supported in a single put call. This is used + by + + the create_blob_from_* methods if the content length is known and is less + + than this value.' + name: MAX_SINGLE_PUT_SIZE + types: + - +- description: 'The size of the blocks put by create_blob_from_* methods if the content + + length is unknown or is larger than MAX_SINGLE_PUT_SIZE. Smaller blocks + + may be put. The maximum block size the service supports is 100MB.' + name: MAX_BLOCK_SIZE + types: + - +- description: 'The minimum block size at which the the memory-optimized, block upload + + algorithm is considered. This algorithm is only applicable to the create_blob_from_file + and + + create_blob_from_stream methods and will prevent the full buffering of blocks. + + In addition to the block size, ContentMD5 validation and Encryption must be disabled + as + + these options require the blocks to be buffered.' + name: MIN_LARGE_BLOCK_UPLOAD_THRESHOLD + types: + - +methods: +- uid: azure.storage.blob.blockblobservice.BlockBlobService.abort_copy_blob + name: abort_copy_blob + summary: 'Aborts a pending copy_blob operation, and leaves a destination blob + + with zero length and full metadata.' + signature: abort_copy_blob(container_name, blob_name, copy_id, lease_id=None, timeout=None) + parameters: + - name: container_name + description: Name of destination container. + isRequired: true + types: + - + - name: blob_name + description: Name of destination blob. + isRequired: true + types: + - + - name: copy_id + description: 'Copy identifier provided in the copy.id of the original + + copy_blob operation.' + isRequired: true + types: + - + - name: lease_id + description: Required if the destination blob has an active infinite lease. + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.acquire_blob_lease + name: acquire_blob_lease + summary: 'Requests a new lease. If the blob does not have an active lease, the Blob + + service creates a lease on the blob and returns a new lease ID.' + signature: acquire_blob_lease(container_name, blob_name, lease_duration=-1, proposed_lease_id=None, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: lease_duration + description: 'Specifies the duration of the lease, in seconds, or negative one + + (-1) for a lease that never expires. A non-infinite lease can be + + between 15 and 60 seconds. A lease duration cannot be changed + + using renew or change. Default is -1 (infinite lease).' + defaultValue: '-1' + types: + - + - name: proposed_lease_id + description: 'Proposed lease ID, in a GUID string format. The Blob service + + returns 400 (Invalid request) if the proposed lease ID is not + + in the correct format.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: str +- uid: azure.storage.blob.blockblobservice.BlockBlobService.acquire_container_lease + name: acquire_container_lease + summary: 'Requests a new lease. If the container does not have an active lease, + + the Blob service creates a lease on the container and returns a new + + lease ID.' + signature: acquire_container_lease(container_name, lease_duration=-1, proposed_lease_id=None, + if_modified_since=None, if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_duration + description: 'Specifies the duration of the lease, in seconds, or negative one + + (-1) for a lease that never expires. A non-infinite lease can be + + between 15 and 60 seconds. A lease duration cannot be changed + + using renew or change. Default is -1 (infinite lease).' + defaultValue: '-1' + types: + - + - name: proposed_lease_id + description: 'Proposed lease ID, in a GUID string format. The Blob service returns + + 400 (Invalid request) if the proposed lease ID is not in the correct format.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: str +- uid: azure.storage.blob.blockblobservice.BlockBlobService.batch_delete_blobs + name: batch_delete_blobs + summary: 'Sends a batch of multiple blob delete requests. + + + The blob delete method deletes the specified blob or snapshot. Note that deleting + a blob also deletes all its + + snapshots. For more information, see [https://docs.microsoft.com/rest/api/storageservices/delete-blob](https://docs.microsoft.com/rest/api/storageservices/delete-blob)' + signature: batch_delete_blobs(batch_delete_sub_requests, timeout=None) + parameters: + - name: batch_delete_sub_requests + description: The blob delete requests to send as a batch. + isRequired: true + types: + - () + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: parsed batch delete HTTP response + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.batch_set_standard_blob_tier + name: batch_set_standard_blob_tier + summary: 'Sends a batch of multiple set block blob tiers requests. + + This API is only supported for block blobs on standard storage accounts.' + signature: batch_set_standard_blob_tier(batch_set_blob_tier_sub_requests, timeout=None) + parameters: + - name: batch_set_blob_tier_sub_requests + description: The set block blob tier requests to send as a batch. + isRequired: true + types: + - () + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + return: + description: parsed batch set tier HTTP response which indicates if each sub-request + is successful. + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.break_blob_lease + name: break_blob_lease + summary: 'Breaks the lease, if the blob has an active lease. Once a lease is broken, + + it cannot be renewed. Any authorized request can break the lease; the request + + is not required to specify a matching lease ID. When a lease is broken, + + the lease break period is allowed to elapse, during which time no lease operation + + except break and release can be performed on the blob. When a lease is successfully + + broken, the response indicates the interval in seconds until a new lease can be + acquired. + + + A lease that has been broken can also be released, in which case another client + may + + immediately acquire the lease on the blob.' + signature: break_blob_lease(container_name, blob_name, lease_break_period=None, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: lease_break_period + description: 'For a break operation, this is the proposed duration of + + seconds that the lease should continue before it is broken, between + + 0 and 60 seconds. This break period is only used if it is shorter + + than the time remaining on the lease. If longer, the time remaining + + on the lease is used. A new lease will not be available before the + + break period has expired, but the lease may be held for longer than + + the break period. If this header does not appear with a break + + operation, a fixed-duration lease breaks after the remaining lease + + period elapses, and an infinite lease breaks immediately.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: int +- uid: azure.storage.blob.blockblobservice.BlockBlobService.break_container_lease + name: break_container_lease + summary: 'Break the lease, if the container has an active lease. Once a lease is + + broken, it cannot be renewed. Any authorized request can break the lease; + + the request is not required to specify a matching lease ID. When a lease + + is broken, the lease break period is allowed to elapse, during which time + + no lease operation except break and release can be performed on the container. + + When a lease is successfully broken, the response indicates the interval + + in seconds until a new lease can be acquired.' + signature: break_container_lease(container_name, lease_break_period=None, if_modified_since=None, + if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_break_period + description: 'This is the proposed duration of seconds that the lease + + should continue before it is broken, between 0 and 60 seconds. This + + break period is only used if it is shorter than the time remaining + + on the lease. If longer, the time remaining on the lease is used. + + A new lease will not be available before the break period has + + expired, but the lease may be held for longer than the break + + period. If this header does not appear with a break + + operation, a fixed-duration lease breaks after the remaining lease + + period elapses, and an infinite lease breaks immediately.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: int +- uid: azure.storage.blob.blockblobservice.BlockBlobService.change_blob_lease + name: change_blob_lease + summary: 'Changes the lease ID of an active lease. A change must include the current + + lease ID and a new lease ID.' + signature: change_blob_lease(container_name, blob_name, lease_id, proposed_lease_id, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: lease_id + description: Required if the blob has an active lease. + isRequired: true + types: + - + - name: proposed_lease_id + description: 'Proposed lease ID, in a GUID string format. The Blob service returns + + 400 (Invalid request) if the proposed lease ID is not in the correct format.' + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.change_container_lease + name: change_container_lease + summary: 'Change the lease ID of an active lease. A change must include the current + + lease ID and a new lease ID.' + signature: change_container_lease(container_name, lease_id, proposed_lease_id, if_modified_since=None, + if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: Lease ID for active lease. + isRequired: true + types: + - + - name: proposed_lease_id + description: 'Proposed lease ID, in a GUID string format. The Blob service returns + 400 + + (Invalid request) if the proposed lease ID is not in the correct format.' + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.copy_blob + name: copy_blob + summary: 'Copies a blob. This operation returns a copy operation + + properties object. The copy operation may be configured to either be an + + asynchronous, best-effort operation, or a synchronous operation. + + + The source must be a block blob if requires_sync is true. Any existing + + destination blob will be overwritten. The destination blob cannot be + + modified while a copy operation is in progress. + + + When copying from a block blob, all committed blocks and their block IDs are + + copied. Uncommitted blocks are not copied. At the end of the copy operation, + + the destination blob will have the same committed block count as the source. + + + You can call get_blob_properties on the destination blob to check the status + + of the copy operation. The final blob will be committed when the copy completes. + + + Name of the destination container. The container must exist. + + :param str blob_name: + + Name of the destination blob. If the destination blob exists, it will + + be overwritten. Otherwise, it will be created. + + :param str copy_source: + + A URL of up to 2 KB in length that specifies an Azure file or blob. + + The value should be URL-encoded as it would appear in a request URI. + + If the source is in another account, the source must either be public + + or must be authenticated via a shared access signature. If the source + + is public, no authentication is required. + + Examples: + + [https://myaccount.blob.core.windows.net/mycontainer/myblob](https://myaccount.blob.core.windows.net/mycontainer/myblob) + + [https://myaccount.blob.core.windows.net/mycontainer/myblob](https://myaccount.blob.core.windows.net/mycontainer/myblob)?snapshot= + + [https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken](https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken) + + :param metadata: + + Name-value pairs associated with the blob as metadata. If no name-value + + pairs are specified, the operation will copy the metadata from the + + source blob or file to the destination blob. If one or more name-value + + pairs are specified, the destination blob is created with the specified + + metadata, and metadata is not copied from the source blob or file. + + :type metadata: dict(str, str) + + :param datetime source_if_modified_since: + + A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this conditional header to copy the blob only if the source + + blob has been modified since the specified date/time. + + :param datetime source_if_unmodified_since: + + A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this conditional header to copy the blob only if the source blob + + has not been modified since the specified date/time. + + :param ETag source_if_match: + + An ETag value, or the wildcard character (*). Specify this conditional + + header to copy the source blob only if its ETag matches the value + + specified. If the ETag values do not match, the Blob service returns + + status code 412 (Precondition Failed). This header cannot be specified + + if the source is an Azure File. + + :param ETag source_if_none_match: + + An ETag value, or the wildcard character (*). Specify this conditional + + header to copy the blob only if its ETag does not match the value + + specified. If the values are identical, the Blob service returns status + + code 412 (Precondition Failed). This header cannot be specified if the + + source is an Azure File. + + :param datetime destination_if_modified_since: + + A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this conditional header to copy the blob only + + if the destination blob has been modified since the specified date/time. + + If the destination blob has not been modified, the Blob service returns + + status code 412 (Precondition Failed). + + :param datetime destination_if_unmodified_since: + + A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this conditional header to copy the blob only + + if the destination blob has not been modified since the specified + + date/time. If the destination blob has been modified, the Blob service + + returns status code 412 (Precondition Failed). + + :param ETag destination_if_match: + + An ETag value, or the wildcard character (*). Specify an ETag value for + + this conditional header to copy the blob only if the specified ETag value + + matches the ETag value for an existing destination blob. If the ETag for + + the destination blob does not match the ETag specified for If-Match, the + + Blob service returns status code 412 (Precondition Failed). + + :param ETag destination_if_none_match: + + An ETag value, or the wildcard character (*). Specify an ETag value for + + this conditional header to copy the blob only if the specified ETag value + + does not match the ETag value for the destination blob. Specify the wildcard + + character (*) to perform the operation only if the destination blob does not + + exist. If the specified condition isn''t met, the Blob service returns status + + code 412 (Precondition Failed). + + :param str destination_lease_id: + + The lease ID specified for this header must match the lease ID of the + + destination blob. If the request does not include the lease ID or it is not + + valid, the operation fails with status code 412 (Precondition Failed). + + :param str source_lease_id: + + Specify this to perform the Copy Blob operation only if + + the lease ID given matches the active lease ID of the source blob. + + :param int timeout: + + The timeout parameter is expressed in seconds. + + :param bool requires_sync: + + Enforces that the service will not return a response until the copy is complete. + + :param StandardBlobTier standard_blob_tier: + + A standard blob tier value to set the blob to. For this version of the library, + + this is only applicable to block blobs on standard storage accounts. + + :param rehydrate_priority: + + Indicates the priority with which to rehydrate an archived blob + + :return: Copy operation properties such as status, source, and ID. + + :rtype: ' + signature: copy_blob(container_name, blob_name, copy_source, metadata=None, source_if_modified_since=None, + source_if_unmodified_since=None, source_if_match=None, source_if_none_match=None, + destination_if_modified_since=None, destination_if_unmodified_since=None, destination_if_match=None, + destination_if_none_match=None, destination_lease_id=None, source_lease_id=None, + timeout=None, requires_sync=None, standard_blob_tier=None, rehydrate_priority=None) + parameters: + - name: container_name + isRequired: true + types: + - + - name: blob_name + isRequired: true + - name: copy_source + isRequired: true + - name: metadata + defaultValue: None + - name: source_if_modified_since + defaultValue: None + - name: source_if_unmodified_since + defaultValue: None + - name: source_if_match + defaultValue: None + - name: source_if_none_match + defaultValue: None + - name: destination_if_modified_since + defaultValue: None + - name: destination_if_unmodified_since + defaultValue: None + - name: destination_if_match + defaultValue: None + - name: destination_if_none_match + defaultValue: None + - name: destination_lease_id + defaultValue: None + - name: source_lease_id + defaultValue: None + - name: timeout + defaultValue: None + - name: requires_sync + defaultValue: None + - name: standard_blob_tier + defaultValue: None + - name: rehydrate_priority + defaultValue: None +- uid: azure.storage.blob.blockblobservice.BlockBlobService.create_blob_from_bytes + name: create_blob_from_bytes + summary: 'Creates a new blob from an array of bytes, or updates the content + + of an existing blob, with automatic chunking and progress + + notifications.' + signature: create_blob_from_bytes(container_name, blob_name, blob, index=0, count=None, + content_settings=None, metadata=None, validate_content=False, progress_callback=None, + max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, + if_match=None, if_none_match=None, timeout=None, standard_blob_tier=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob to create or update. + isRequired: true + types: + - + - name: blob + description: Content of blob as an array of bytes. + isRequired: true + types: + - + - name: index + description: Start index in the array of bytes. + defaultValue: '0' + types: + - + - name: count + description: 'Number of bytes to upload. Set to None or negative value to upload + + all bytes starting from index.' + defaultValue: None + types: + - + - name: content_settings + description: ContentSettings object used to set blob properties. + defaultValue: None + types: + - + - name: metadata + description: Name-value pairs associated with the blob as metadata. + defaultValue: None + types: + - (, ) + - name: validate_content + description: 'If true, calculates an MD5 hash for each chunk of the blob. The + storage + + service checks the hash of the content that has arrived with the hash + + that was sent. This is primarily valuable for detecting bitflips on + + the wire if using http instead of https as https (the default) will + + already validate. Note that this MD5 hash is not stored with the + + blob.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) where + + current is the number of bytes transfered so far, and total is the + + size of the blob, or None if the total size is unknown.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'Maximum number of parallel connections to use when the blob size + exceeds + + 64MB.' + defaultValue: '2' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + - name: standard_blob_tier + description: 'A standard blob tier value to set the blob to. For this version + of the library, + + this is only applicable to block blobs on standard storage accounts.' + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the Block Blob + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.create_blob_from_path + name: create_blob_from_path + summary: 'Creates a new blob from a file path, or updates the content of an + + existing blob, with automatic chunking and progress notifications.' + signature: create_blob_from_path(container_name, blob_name, file_path, content_settings=None, + metadata=None, validate_content=False, progress_callback=None, max_connections=2, + lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, + if_none_match=None, timeout=None, standard_blob_tier=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob to create or update. + isRequired: true + types: + - + - name: file_path + description: Path of the file to upload as the blob content. + isRequired: true + types: + - + - name: content_settings + description: ContentSettings object used to set blob properties. + defaultValue: None + types: + - + - name: metadata + description: Name-value pairs associated with the blob as metadata. + defaultValue: None + types: + - (, ) + - name: validate_content + description: 'If true, calculates an MD5 hash for each chunk of the blob. The + storage + + service checks the hash of the content that has arrived with the hash + + that was sent. This is primarily valuable for detecting bitflips on + + the wire if using http instead of https as https (the default) will + + already validate. Note that this MD5 hash is not stored with the + + blob. Also note that if enabled, the memory-efficient upload algorithm + + will not be used, because computing the MD5 hash requires buffering + + entire blocks, and doing so defeats the purpose of the memory-efficient algorithm.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) where + + current is the number of bytes transfered so far, and total is the + + size of the blob, or None if the total size is unknown.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'Maximum number of parallel connections to use when the blob size + exceeds + + 64MB.' + defaultValue: '2' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + - name: standard_blob_tier + description: 'A standard blob tier value to set the blob to. For this version + of the library, + + this is only applicable to block blobs on standard storage accounts.' + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the Block Blob + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.create_blob_from_stream + name: create_blob_from_stream + summary: 'Creates a new blob from a file/stream, or updates the content of + + an existing blob, with automatic chunking and progress + + notifications.' + signature: create_blob_from_stream(container_name, blob_name, stream, count=None, + content_settings=None, metadata=None, validate_content=False, progress_callback=None, + max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, + if_match=None, if_none_match=None, timeout=None, use_byte_buffer=False, standard_blob_tier=None, + cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob to create or update. + isRequired: true + types: + - + - name: stream + description: Opened file/stream to upload as the blob content. + isRequired: true + types: + - + - name: count + description: 'Number of bytes to read from the stream. This is optional, but + + should be supplied for optimal performance.' + defaultValue: None + types: + - + - name: content_settings + description: ContentSettings object used to set blob properties. + defaultValue: None + types: + - + - name: metadata + description: Name-value pairs associated with the blob as metadata. + defaultValue: None + types: + - (, ) + - name: validate_content + description: 'If true, calculates an MD5 hash for each chunk of the blob. The + storage + + service checks the hash of the content that has arrived with the hash + + that was sent. This is primarily valuable for detecting bitflips on + + the wire if using http instead of https as https (the default) will + + already validate. Note that this MD5 hash is not stored with the + + blob. Also note that if enabled, the memory-efficient upload algorithm + + will not be used, because computing the MD5 hash requires buffering + + entire blocks, and doing so defeats the purpose of the memory-efficient algorithm.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) where + + current is the number of bytes transfered so far, and total is the + + size of the blob, or None if the total size is unknown.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'Maximum number of parallel connections to use when the blob size + exceeds + + 64MB. Note that parallel upload requires the stream to be seekable.' + defaultValue: '2' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + - name: use_byte_buffer + description: 'If True, this will force usage of the original full block buffering + upload path. + + By default, this value is False and will employ a memory-efficient, + + streaming upload algorithm under the following conditions: + + The provided stream is seekable, ''require_encryption'' is False, and + + MAX_BLOCK_SIZE >= MIN_LARGE_BLOCK_UPLOAD_THRESHOLD. + + One should consider the drawbacks of using this approach. In order to achieve + + memory-efficiency, a IOBase stream or file-like object is segmented into logical + blocks + + using a SubStream wrapper. In order to read the correct data, each SubStream + must acquire + + a lock so that it can safely seek to the right position on the shared, underlying + stream. + + If max_connections > 1, the concurrency will result in a considerable amount + of seeking on + + the underlying stream. For the most common inputs such as a file-like stream + object, seeking + + is an inexpensive operation and this is not much of a concern. However, for + other variants of streams + + this may not be the case. The trade-off for memory-efficiency must be weighed + against the cost of seeking + + with your input stream. + + The SubStream class will attempt to buffer up to 4 MB internally to reduce the + amount of + + seek and read calls to the underlying stream. This is particularly beneficial + when uploading larger blocks.' + defaultValue: 'False' + types: + - + - name: standard_blob_tier + description: 'A standard blob tier value to set the blob to. For this version + of the library, + + this is only applicable to block blobs on standard storage accounts.' + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the Block Blob + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.create_blob_from_text + name: create_blob_from_text + summary: 'Creates a new blob from str/unicode, or updates the content of an + + existing blob, with automatic chunking and progress notifications.' + signature: create_blob_from_text(container_name, blob_name, text, encoding='utf-8', + content_settings=None, metadata=None, validate_content=False, progress_callback=None, + max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, + if_match=None, if_none_match=None, timeout=None, standard_blob_tier=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob to create or update. + isRequired: true + types: + - + - name: text + description: Text to upload to the blob. + isRequired: true + types: + - + - name: encoding + description: Python encoding to use to convert the text to bytes. + defaultValue: utf-8 + types: + - + - name: content_settings + description: ContentSettings object used to set blob properties. + defaultValue: None + types: + - + - name: metadata + description: Name-value pairs associated with the blob as metadata. + defaultValue: None + types: + - (, ) + - name: validate_content + description: 'If true, calculates an MD5 hash for each chunk of the blob. The + storage + + service checks the hash of the content that has arrived with the hash + + that was sent. This is primarily valuable for detecting bitflips on + + the wire if using http instead of https as https (the default) will + + already validate. Note that this MD5 hash is not stored with the + + blob.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) where + + current is the number of bytes transfered so far, and total is the + + size of the blob, or None if the total size is unknown.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'Maximum number of parallel connections to use when the blob size + exceeds + + 64MB.' + defaultValue: '2' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + - name: standard_blob_tier + description: 'A standard blob tier value to set the blob to. For this version + of the library, + + this is only applicable to block blobs on standard storage accounts.' + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the Block Blob + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.create_container + name: create_container + summary: 'Creates a new container under the specified account. If the container + + with the same name already exists, the operation fails if + + fail_on_exist is True.' + signature: create_container(container_name, metadata=None, public_access=None, fail_on_exist=False, + timeout=None) + parameters: + - name: container_name + description: 'Name of container to create. + + The container name may only contain lowercase letters, numbers, and hyphens, + and must begin with a letter or + + a number. Each hyphen must be preceded and followed by a non-hyphen character. + The name must also be + + between 3 and 63 characters long.' + isRequired: true + types: + - + - name: metadata + description: 'A dict with name_value pairs to associate with the + + container as metadata. Example:{''Category'':''test''}' + defaultValue: None + types: + - (, ) + - name: public_access + description: 'Possible values include: container, blob.' + defaultValue: None + types: + - + - name: fail_on_exist + description: Specify whether to throw an exception when the container exists. + defaultValue: 'False' + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: True if container is created, False if container already exists. + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.delete_blob + name: delete_blob + summary: 'Marks the specified blob or snapshot for deletion. + + The blob is later deleted during garbage collection. + + + Note that in order to delete a blob, you must delete all of its + + snapshots. You can delete both at the same time with the Delete + + Blob operation. + + + If a delete retention policy is enabled for the service, then this operation soft + deletes the blob or snapshot + + and retains the blob or snapshot for specified number of days. + + After specified number of days, blob''s data is removed from the service during + garbage collection. + + Soft deleted blob or snapshot is accessible through List Blobs API specifying + include=Include.Deleted option. + + Soft-deleted blob or snapshot can be restored using Undelete API.' + signature: delete_blob(container_name, blob_name, snapshot=None, lease_id=None, + delete_snapshots=None, if_modified_since=None, if_unmodified_since=None, if_match=None, + if_none_match=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to delete.' + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: delete_snapshots + description: Required if the blob has associated snapshots. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.delete_container + name: delete_container + summary: 'Marks the specified container for deletion. The container and any blobs + + contained within it are later deleted during garbage collection.' + signature: delete_container(container_name, fail_not_exist=False, lease_id=None, + if_modified_since=None, if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of container to delete. + isRequired: true + types: + - + - name: fail_not_exist + description: 'Specify whether to throw an exception when the container doesn''t + + exist.' + defaultValue: 'False' + types: + - + - name: lease_id + description: 'If specified, delete_container only succeeds if the + + container''s lease is active and matches this ID. + + Required if the container has an active lease.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: True if container is deleted, False container doesn't exist. + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.exists + name: exists + summary: 'Returns a boolean indicating whether the container exists (if blob_name + + is None), or otherwise a boolean indicating whether the blob exists.' + signature: exists(container_name, blob_name=None, snapshot=None, timeout=None) + parameters: + - name: container_name + description: Name of a container. + isRequired: true + types: + - + - name: blob_name + description: Name of a blob. If None, the container will be checked for existence. + defaultValue: None + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the snapshot.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: A boolean indicating whether the resource exists. + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.extract_date_and_request_id + name: extract_date_and_request_id + signature: static extract_date_and_request_id(retry_context) + parameters: + - name: retry_context + isRequired: true +- uid: azure.storage.blob.blockblobservice.BlockBlobService.generate_account_shared_access_signature + name: generate_account_shared_access_signature + summary: 'Generates a shared access signature for the blob service. + + Use the returned signature with the sas_token parameter of any BlobService.' + signature: generate_account_shared_access_signature(resource_types, permission, + expiry, start=None, ip=None, protocol=None) + parameters: + - name: resource_types + description: Specifies the resource types that are accessible with the account + SAS. + isRequired: true + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy.' + isRequired: true + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + isRequired: true + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. The default + value + + is https,http. See for possible + values.' + defaultValue: None + types: + - + return: + description: A Shared Access Signature (sas) token. + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.generate_blob_shared_access_signature + name: generate_blob_shared_access_signature + summary: 'Generates a shared access signature for the blob or one of its snapshots. + + Use the returned signature with the sas_token parameter of any BlobService.' + signature: generate_blob_shared_access_signature(container_name, blob_name, snapshot=None, + permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, + content_disposition=None, content_encoding=None, content_language=None, content_type=None, + user_delegation_key=None) + parameters: + - name: container_name + description: Name of container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to grant permission.' + defaultValue: None + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Permissions must be ordered read, write, delete, list. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy.' + defaultValue: None + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + defaultValue: None + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: id + description: 'A unique value up to 64 characters in length that correlates to + a + + stored access policy. To create a stored access policy, use .' + defaultValue: None + types: + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. The default + value + + is https,http. See for possible + values.' + defaultValue: None + types: + - + - name: cache_control + description: 'Response header value for Cache-Control when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_disposition + description: 'Response header value for Content-Disposition when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_encoding + description: 'Response header value for Content-Encoding when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_language + description: 'Response header value for Content-Language when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_type + description: 'Response header value for Content-Type when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: user_delegation_key + description: 'Instead of an account key, the user could pass in a user delegation + key. + + A user delegation key can be obtained from the service by authenticating with + an AAD identity; + + this can be accomplished by calling get_user_delegation_key. + + When present, the SAS is signed with the user delegation key instead.' + defaultValue: None + types: + - + return: + description: A Shared Access Signature (sas) token. + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.generate_container_shared_access_signature + name: generate_container_shared_access_signature + summary: 'Generates a shared access signature for the container. + + Use the returned signature with the sas_token parameter of any BlobService.' + signature: generate_container_shared_access_signature(container_name, permission=None, + expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, + content_disposition=None, content_encoding=None, content_language=None, content_type=None, + user_delegation_key=None) + parameters: + - name: container_name + description: Name of container. + isRequired: true + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Permissions must be ordered read, write, delete, list. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy.' + defaultValue: None + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + defaultValue: None + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: id + description: 'A unique value up to 64 characters in length that correlates to + a + + stored access policy. To create a stored access policy, use + + set_blob_service_properties.' + defaultValue: None + types: + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. The default + value + + is https,http. See for possible + values.' + defaultValue: None + types: + - + - name: cache_control + description: 'Response header value for Cache-Control when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_disposition + description: 'Response header value for Content-Disposition when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_encoding + description: 'Response header value for Content-Encoding when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_language + description: 'Response header value for Content-Language when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_type + description: 'Response header value for Content-Type when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: user_delegation_key + description: 'Instead of an account key, the user could pass in a user delegation + key. + + A user delegation key can be obtained from the service by authenticating with + an AAD identity; + + this can be accomplished by calling get_user_delegation_key. + + When present, the SAS is signed with the user delegation key instead.' + defaultValue: None + types: + - + return: + description: A Shared Access Signature (sas) token. + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.get_blob_account_information + name: get_blob_account_information + summary: 'Gets information related to the storage account. + + The information can also be retrieved if the user has a SAS to a container or + blob.' + signature: get_blob_account_information(container_name=None, blob_name=None, timeout=None) + parameters: + - name: container_name + description: 'Name of existing container. + + Optional, unless using a SAS token to a specific container or blob, in which + case it''s required.' + defaultValue: None + types: + - + - name: blob_name + description: 'Name of existing blob. + + Optional, unless using a SAS token to a specific blob, in which case it''s required.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: The . +- uid: azure.storage.blob.blockblobservice.BlockBlobService.get_blob_metadata + name: get_blob_metadata + summary: Returns all user-defined metadata for the specified blob or snapshot. + signature: get_blob_metadata(container_name, blob_name, snapshot=None, lease_id=None, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: A dictionary representing the blob metadata name, value pairs. + types: + - (, ) +- uid: azure.storage.blob.blockblobservice.BlockBlobService.get_blob_properties + name: get_blob_properties + summary: 'Returns all user-defined metadata, standard HTTP properties, and + + system properties for the blob. It does not return the content of the blob. + + Returns + + with and a metadata dict.' + signature: get_blob_properties(container_name, blob_name, snapshot=None, lease_id=None, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: a blob object including properties and metadata. + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.get_blob_service_properties + name: get_blob_service_properties + summary: 'Gets the properties of a storage account''s Blob service, including + + Azure Storage Analytics.' + signature: get_blob_service_properties(timeout=None) + parameters: + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: 'The blob with + an attached + + target_version property.' +- uid: azure.storage.blob.blockblobservice.BlockBlobService.get_blob_service_stats + name: get_blob_service_stats + summary: 'Retrieves statistics related to replication for the Blob service. It is + + only available when read-access geo-redundant replication is enabled for + + the storage account. + + + With geo-redundant replication, Azure Storage maintains your data durable + + in two locations. In both locations, Azure Storage constantly maintains + + multiple healthy replicas of your data. The location where you read, + + create, update, or delete data is the primary storage account location. + + The primary location exists in the region you choose at the time you + + create an account via the Azure Management Azure classic portal, for + + example, North Central US. The location to which your data is replicated + + is the secondary location. The secondary location is automatically + + determined based on the location of the primary; it is in a second data + + center that resides in the same region as the primary location. Read-only + + access is available from the secondary location, if read-access geo-redundant + + replication is enabled for your storage account.' + signature: get_blob_service_stats(timeout=None) + parameters: + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: The blob service stats. + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.get_blob_to_bytes + name: get_blob_to_bytes + summary: 'Downloads a blob as an array of bytes, with automatic chunking and + + progress notifications. Returns an instance of + with + + properties, metadata, and content.' + signature: get_blob_to_bytes(container_name, blob_name, snapshot=None, start_range=None, + end_range=None, validate_content=False, progress_callback=None, max_connections=2, + lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, + if_none_match=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: start_range + description: 'Start of byte range to use for downloading a section of the blob. + + If no end_range is given, all bytes after the start_range will be downloaded. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: end_range + description: 'End of byte range to use for downloading a section of the blob. + + If end_range is given, start_range must be provided. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: validate_content + description: 'If set to true, validates an MD5 hash for each retrieved portion + of + + the blob. This is primarily valuable for detecting bitflips on the wire + + if using http instead of https as https (the default) will already + + validate. Note that the service will only return transactional MD5s + + for chunks 4MB or less so the first get request will be of size + + self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If + + self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be + + thrown. As computing the MD5 takes processing time and more requests + + will need to be done due to the reduced chunk size there may be some + + increase in latency.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) + + where current is the number of bytes transfered so far, and total is + + the size of the blob if known.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'If set to 2 or greater, an initial get will be done for the first + + self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob, + + the method returns at this point. If it is not, it will download the + + remaining data parallel using the number of threads equal to + + max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. + + If set to 1, a single large get request will be done. This is not + + generally recommended but available if very few threads should be + + used, network requests are very expensive, or a non-seekable stream + + prevents parallel download. This may also be useful if many blobs are + + expected to be empty as an extra request is required for empty blobs + + if max_connections is greater than 1.' + defaultValue: '2' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + return: + description: 'A Blob with properties and metadata. If max_connections is greater + + than 1, the content_md5 (if set on the blob) will not be returned. If you + + require this value, either use get_blob_properties or set max_connections + + to 1.' + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.get_blob_to_path + name: get_blob_to_path + summary: 'Downloads a blob to a file path, with automatic chunking and progress + + notifications. Returns an instance of with + + properties and metadata.' + signature: get_blob_to_path(container_name, blob_name, file_path, open_mode='wb', + snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, + max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, + if_match=None, if_none_match=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: file_path + description: Path of file to write out to. + isRequired: true + types: + - + - name: open_mode + description: 'Mode to use when opening the file. Note that specifying append only + + open_mode prevents parallel download. So, max_connections must be set + + to 1 if this open_mode is used.' + defaultValue: wb + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: start_range + description: 'Start of byte range to use for downloading a section of the blob. + + If no end_range is given, all bytes after the start_range will be downloaded. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: end_range + description: 'End of byte range to use for downloading a section of the blob. + + If end_range is given, start_range must be provided. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: validate_content + description: 'If set to true, validates an MD5 hash for each retrieved portion + of + + the blob. This is primarily valuable for detecting bitflips on the wire + + if using http instead of https as https (the default) will already + + validate. Note that the service will only return transactional MD5s + + for chunks 4MB or less so the first get request will be of size + + self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If + + self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be + + thrown. As computing the MD5 takes processing time and more requests + + will need to be done due to the reduced chunk size there may be some + + increase in latency.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) + + where current is the number of bytes transfered so far, and total is + + the size of the blob if known.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'If set to 2 or greater, an initial get will be done for the first + + self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob, + + the method returns at this point. If it is not, it will download the + + remaining data parallel using the number of threads equal to + + max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. + + If set to 1, a single large get request will be done. This is not + + generally recommended but available if very few threads should be + + used, network requests are very expensive, or a non-seekable stream + + prevents parallel download. This may also be useful if many blobs are + + expected to be empty as an extra request is required for empty blobs + + if max_connections is greater than 1.' + defaultValue: '2' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + return: + description: 'A Blob with properties and metadata. If max_connections is greater + + than 1, the content_md5 (if set on the blob) will not be returned. If you + + require this value, either use get_blob_properties or set max_connections + + to 1.' + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.get_blob_to_stream + name: get_blob_to_stream + summary: 'Downloads a blob to a stream, with automatic chunking and progress + + notifications. Returns an instance of with + + properties and metadata.' + signature: get_blob_to_stream(container_name, blob_name, stream, snapshot=None, + start_range=None, end_range=None, validate_content=False, progress_callback=None, + max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, + if_match=None, if_none_match=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: stream + description: Opened stream to write to. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: start_range + description: 'Start of byte range to use for downloading a section of the blob. + + If no end_range is given, all bytes after the start_range will be downloaded. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: end_range + description: 'End of byte range to use for downloading a section of the blob. + + If end_range is given, start_range must be provided. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: validate_content + description: 'If set to true, validates an MD5 hash for each retrieved portion + of + + the blob. This is primarily valuable for detecting bitflips on the wire + + if using http instead of https as https (the default) will already + + validate. Note that the service will only return transactional MD5s + + for chunks 4MB or less so the first get request will be of size + + self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If + + self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be + + thrown. As computing the MD5 takes processing time and more requests + + will need to be done due to the reduced chunk size there may be some + + increase in latency.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) + + where current is the number of bytes transfered so far, and total is + + the size of the blob if known.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'If set to 2 or greater, an initial get will be done for the first + + self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob, + + the method returns at this point. If it is not, it will download the + + remaining data parallel using the number of threads equal to + + max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. + + If set to 1, a single large get request will be done. This is not + + generally recommended but available if very few threads should be + + used, network requests are very expensive, or a non-seekable stream + + prevents parallel download. This may also be useful if many blobs are + + expected to be empty as an extra request is required for empty blobs + + if max_connections is greater than 1.' + defaultValue: '2' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + return: + description: 'A Blob with properties and metadata. If max_connections is greater + + than 1, the content_md5 (if set on the blob) will not be returned. If you + + require this value, either use get_blob_properties or set max_connections + + to 1.' + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.get_blob_to_text + name: get_blob_to_text + summary: 'Downloads a blob as unicode text, with automatic chunking and progress + + notifications. Returns an instance of with + + properties, metadata, and content.' + signature: get_blob_to_text(container_name, blob_name, encoding='utf-8', snapshot=None, + start_range=None, end_range=None, validate_content=False, progress_callback=None, + max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, + if_match=None, if_none_match=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: encoding + description: Python encoding to use when decoding the blob data. + defaultValue: utf-8 + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: start_range + description: 'Start of byte range to use for downloading a section of the blob. + + If no end_range is given, all bytes after the start_range will be downloaded. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: end_range + description: 'End of byte range to use for downloading a section of the blob. + + If end_range is given, start_range must be provided. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: validate_content + description: 'If set to true, validates an MD5 hash for each retrieved portion + of + + the blob. This is primarily valuable for detecting bitflips on the wire + + if using http instead of https as https (the default) will already + + validate. Note that the service will only return transactional MD5s + + for chunks 4MB or less so the first get request will be of size + + self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If + + self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be + + thrown. As computing the MD5 takes processing time and more requests + + will need to be done due to the reduced chunk size there may be some + + increase in latency.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) + + where current is the number of bytes transfered so far, and total is + + the size of the blob if known.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'If set to 2 or greater, an initial get will be done for the first + + self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob, + + the method returns at this point. If it is not, it will download the + + remaining data parallel using the number of threads equal to + + max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. + + If set to 1, a single large get request will be done. This is not + + generally recommended but available if very few threads should be + + used, network requests are very expensive, or a non-seekable stream + + prevents parallel download. This may also be useful if many blobs are + + expected to be empty as an extra request is required for empty blobs + + if max_connections is greater than 1.' + defaultValue: '2' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + return: + description: 'A Blob with properties and metadata. If max_connections is greater + + than 1, the content_md5 (if set on the blob) will not be returned. If you + + require this value, either use get_blob_properties or set max_connections + + to 1.' + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.get_block_list + name: get_block_list + summary: "Retrieves the list of blocks that have been uploaded as part of a\nblock\ + \ blob. There are two block lists maintained for a blob:\n\n Committed Block\ + \ List:\n The list of blocks that have been successfully committed to a\n\ + \ given blob with Put Block List.\n\n Uncommitted Block List:\n The\ + \ list of blocks that have been uploaded for a blob using\n Put Block, but\ + \ that have not yet been committed. These blocks\n are stored in Azure in\ + \ association with a blob, but do not yet\n form part of the blob." + signature: get_block_list(container_name, blob_name, snapshot=None, block_list_type=None, + lease_id=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: snapshot + description: Datetime to determine the time to retrieve the blocks. + defaultValue: None + types: + - + - name: block_list_type + description: 'Specifies whether to return the list of committed blocks, the list + + of uncommitted blocks, or both lists together. Valid values are: + + committed, uncommitted, or all.' + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: list committed and/or uncommitted blocks for Block Blob + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.get_container_acl + name: get_container_acl + summary: 'Gets the permissions for the specified container. + + The permissions indicate whether container data may be accessed publicly.' + signature: get_container_acl(container_name, lease_id=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: 'If specified, get_container_acl only succeeds if the + + container''s lease is active and matches this ID.' + defaultValue: None + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: 'A dictionary of access policies associated with the container. dict + of str to + + and a public_access property + + if public access is turned on' +- uid: azure.storage.blob.blockblobservice.BlockBlobService.get_container_metadata + name: get_container_metadata + summary: Returns all user-defined metadata for the specified container. + signature: get_container_metadata(container_name, lease_id=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: 'If specified, get_container_metadata only succeeds if the + + container''s lease is active and matches this ID.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: A dictionary representing the container metadata name, value pairs. + types: + - (, ) +- uid: azure.storage.blob.blockblobservice.BlockBlobService.get_container_properties + name: get_container_properties + summary: 'Returns all user-defined metadata and system properties for the specified + + container. The data returned does not include the container''s list of blobs.' + signature: get_container_properties(container_name, lease_id=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: 'If specified, get_container_properties only succeeds if the + + container''s lease is active and matches this ID.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: properties for the specified container within a container object. + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.get_user_delegation_key + name: get_user_delegation_key + summary: 'Obtain a user delegation key for the purpose of signing SAS tokens. + + A token credential must be present on the service object for this request to succeed.' + signature: get_user_delegation_key(key_start_time, key_expiry_time, timeout=None) + parameters: + - name: key_start_time + description: A DateTime value. Indicates when the key becomes valid. + isRequired: true + types: + - + - name: key_expiry_time + description: A DateTime value. Indicates when the key stops being valid. + isRequired: true + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: The user delegation key. + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.list_blob_names + name: list_blob_names + summary: 'Returns a generator to list the blob names under the specified container. + + The generator will lazily follow the continuation tokens returned by + + the service and stop when all blobs have been returned or num_results is reached. + + + If num_results is specified and the account has more than that number of + + blobs, the generator will have a populated next_marker field once it + + finishes. This marker can be used to create a new generator if more + + results are desired.' + signature: list_blob_names(container_name, prefix=None, num_results=None, include=None, + delimiter=None, marker=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: prefix + description: 'Filters the results to return only blobs whose names + + begin with the specified prefix.' + defaultValue: None + types: + - + - name: num_results + description: 'Specifies the maximum number of blobs to return, + + including all elements. + If the request does not specify + + num_results or specifies a value greater than 5,000, the server will + + return up to 5,000 items. Setting num_results to a value less than + + or equal to zero results in error response code 400 (Bad Request).' + defaultValue: None + types: + - + - name: include + description: Specifies one or more additional datasets to include in the response. + defaultValue: None + types: + - + - name: delimiter + description: 'When the request includes this parameter, the operation + + returns a element in the + + result list that acts as a placeholder for all blobs whose names begin + + with the same substring up to the appearance of the delimiter character. + + The delimiter may be a single character or a string.' + defaultValue: None + types: + - + - name: marker + description: 'An opaque continuation token. This value can be retrieved from the + + next_marker field of a previous generator object if num_results was + + specified and that generator has finished enumerating results. If + + specified, this generator will begin returning results from the point + + where the previous generator stopped.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.list_blobs + name: list_blobs + summary: 'Returns a generator to list the blobs under the specified container. + + The generator will lazily follow the continuation tokens returned by + + the service and stop when all blobs have been returned or num_results is reached. + + + If num_results is specified and the account has more than that number of + + blobs, the generator will have a populated next_marker field once it + + finishes. This marker can be used to create a new generator if more + + results are desired.' + signature: list_blobs(container_name, prefix=None, num_results=None, include=None, + delimiter=None, marker=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: prefix + description: 'Filters the results to return only blobs whose names + + begin with the specified prefix.' + defaultValue: None + types: + - + - name: num_results + description: 'Specifies the maximum number of blobs to return, + + including all elements. + If the request does not specify + + num_results or specifies a value greater than 5,000, the server will + + return up to 5,000 items. Setting num_results to a value less than + + or equal to zero results in error response code 400 (Bad Request).' + defaultValue: None + types: + - + - name: include + description: Specifies one or more additional datasets to include in the response. + defaultValue: None + types: + - + - name: delimiter + description: 'When the request includes this parameter, the operation + + returns a element in the + + result list that acts as a placeholder for all blobs whose names begin + + with the same substring up to the appearance of the delimiter character. + + The delimiter may be a single character or a string.' + defaultValue: None + types: + - + - name: marker + description: 'An opaque continuation token. This value can be retrieved from the + + next_marker field of a previous generator object if num_results was + + specified and that generator has finished enumerating results. If + + specified, this generator will begin returning results from the point + + where the previous generator stopped.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.list_containers + name: list_containers + summary: 'Returns a generator to list the containers under the specified account. + + The generator will lazily follow the continuation tokens returned by + + the service and stop when all containers have been returned or num_results is + reached. + + + If num_results is specified and the account has more than that number of + + containers, the generator will have a populated next_marker field once it + + finishes. This marker can be used to create a new generator if more + + results are desired.' + signature: list_containers(prefix=None, num_results=None, include_metadata=False, + marker=None, timeout=None) + parameters: + - name: prefix + description: 'Filters the results to return only containers whose names + + begin with the specified prefix.' + defaultValue: None + types: + - + - name: num_results + description: 'Specifies the maximum number of containers to return. A single list + + request may return up to 1000 contianers and potentially a continuation + + token which should be followed to get additional resutls.' + defaultValue: None + types: + - + - name: include_metadata + description: Specifies that container metadata be returned in the response. + defaultValue: 'False' + types: + - + - name: marker + description: 'An opaque continuation token. This value can be retrieved from the + + next_marker field of a previous generator object if num_results was + + specified and that generator has finished enumerating results. If + + specified, this generator will begin returning results from the point + + where the previous generator stopped.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.make_blob_url + name: make_blob_url + summary: Creates the url to access a blob. + signature: make_blob_url(container_name, blob_name, protocol=None, sas_token=None, + snapshot=None) + parameters: + - name: container_name + description: Name of container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob. + isRequired: true + types: + - + - name: protocol + description: 'Protocol to use: ''http'' or ''https''. If not specified, uses the + + protocol specified when BaseBlobService was initialized.' + defaultValue: None + types: + - + - name: sas_token + description: 'Shared access signature token created with + + generate_shared_access_signature.' + defaultValue: None + types: + - + - name: snapshot + description: 'An string value that uniquely identifies the snapshot. The value + of + + this query parameter indicates the snapshot version.' + defaultValue: None + types: + - + return: + description: blob access URL. + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.make_container_url + name: make_container_url + summary: Creates the url to access a container. + signature: make_container_url(container_name, protocol=None, sas_token=None) + parameters: + - name: container_name + description: Name of container. + isRequired: true + types: + - + - name: protocol + description: 'Protocol to use: ''http'' or ''https''. If not specified, uses the + + protocol specified when BaseBlobService was initialized.' + defaultValue: None + types: + - + - name: sas_token + description: 'Shared access signature token created with + + generate_shared_access_signature.' + defaultValue: None + types: + - + return: + description: container access URL. + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.put_block + name: put_block + summary: Creates a new block to be committed as part of a blob. + signature: put_block(container_name, blob_name, block, block_id, validate_content=False, + lease_id=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob. + isRequired: true + types: + - + - name: block + description: Content of the block. + isRequired: true + types: + - + - of > + - name: block_id + description: 'A string value that identifies the block. The string should be less + than + + or equal to 64 bytes in size. + + For a given blob, the block_id must be the same size for each block.' + isRequired: true + types: + - + - name: validate_content + description: 'If true, calculates an MD5 hash of the block content. The storage + + service checks the hash of the content that has arrived + + with the hash that was sent. This is primarily valuable for detecting + + bitflips on the wire if using http instead of https as https (the default) + + will already validate. Note that this MD5 hash is not stored with the + + blob.' + defaultValue: 'False' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.put_block_from_url + name: put_block_from_url + summary: Creates a new block to be committed as part of a blob. + signature: put_block_from_url(container_name, blob_name, copy_source_url, block_id, + source_range_start=None, source_range_end=None, source_content_md5=None, lease_id=None, + timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob. + isRequired: true + types: + - + - name: copy_source_url + description: 'The URL of the source data. It can point to any Azure Blob or File, + that is either public or has a + + shared access signature attached.' + isRequired: true + types: + - + - name: source_range_start + description: This indicates the start of the range of bytes(inclusive) that has + to be taken from the copy source. + defaultValue: None + types: + - + - name: source_range_end + description: This indicates the end of the range of bytes(inclusive) that has + to be taken from the copy source. + defaultValue: None + types: + - + - name: block_id + description: 'A string value that identifies the block. The string should be less + than + + or equal to 64 bytes in size. + + For a given blob, the block_id must be the same size for each block.' + isRequired: true + types: + - + - name: source_content_md5 + description: If given, the service will calculate the MD5 hash of the block content + and compare against this value. + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.put_block_list + name: put_block_list + summary: 'Writes a blob by specifying the list of block IDs that make up the blob. + + In order to be written as part of a blob, a block must have been + + successfully written to the server in a prior Put Block operation. + + + You can call Put Block List to update a blob by uploading only those + + blocks that have changed, then committing the new and existing blocks + + together. You can do this by specifying whether to commit a block from + + the committed block list or from the uncommitted block list, or to commit + + the most recently uploaded version of the block, whichever list it may + + belong to.' + signature: put_block_list(container_name, blob_name, block_list, content_settings=None, + metadata=None, validate_content=False, lease_id=None, if_modified_since=None, + if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, standard_blob_tier=None, + cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: block_list + description: A list of containing + the block ids and block state. + isRequired: true + types: + - list() + - name: content_settings + description: ContentSettings object used to set properties on the blob. + defaultValue: None + types: + - + - name: metadata + description: Name-value pairs associated with the blob as metadata. + defaultValue: None + types: + - (, ) + - name: validate_content + description: 'If true, calculates an MD5 hash of the block list content. The storage + + service checks the hash of the block list content that has arrived + + with the hash that was sent. This is primarily valuable for detecting + + bitflips on the wire if using http instead of https as https (the default) + + will already validate. Note that this check is associated with + + the block list content, and not with the content of the blob itself.' + defaultValue: 'False' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + - name: standard_blob_tier + description: 'A standard blob tier value to set the blob to. For this version + of the library, + + this is only applicable to block blobs on standard storage accounts.' + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the updated Block Blob + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.release_blob_lease + name: release_blob_lease + summary: 'Releases the lease. The lease may be released if the lease ID specified + on the + + request matches that associated with the blob. Releasing the lease allows another + + client to immediately acquire the lease for the blob as soon as the release is + complete.' + signature: release_blob_lease(container_name, blob_name, lease_id, if_modified_since=None, + if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: lease_id + description: Lease ID for active lease. + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.release_container_lease + name: release_container_lease + summary: 'Release the lease. The lease may be released if the lease_id specified + matches + + that associated with the container. Releasing the lease allows another client + + to immediately acquire the lease for the container as soon as the release is complete.' + signature: release_container_lease(container_name, lease_id, if_modified_since=None, + if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: Lease ID for active lease. + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.renew_blob_lease + name: renew_blob_lease + summary: 'Renews the lease. The lease can be renewed if the lease ID specified on + + the request matches that associated with the blob. Note that the lease may + + be renewed even if it has expired as long as the blob has not been modified + + or leased again since the expiration of that lease. When you renew a lease, + + the lease duration clock resets.' + signature: renew_blob_lease(container_name, blob_name, lease_id, if_modified_since=None, + if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: lease_id + description: Lease ID for active lease. + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: str +- uid: azure.storage.blob.blockblobservice.BlockBlobService.renew_container_lease + name: renew_container_lease + summary: 'Renews the lease. The lease can be renewed if the lease ID specified + + matches that associated with the container. Note that + + the lease may be renewed even if it has expired as long as the container + + has not been leased again since the expiration of that lease. When you + + renew a lease, the lease duration clock resets.' + signature: renew_container_lease(container_name, lease_id, if_modified_since=None, + if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: Lease ID for active lease. + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: str +- uid: azure.storage.blob.blockblobservice.BlockBlobService.set_blob_metadata + name: set_blob_metadata + summary: 'Sets user-defined metadata for the specified blob as one or more + + name-value pairs.' + signature: set_blob_metadata(container_name, blob_name, metadata=None, lease_id=None, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: metadata + description: 'Dict containing name and value pairs. Each call to this operation + + replaces all existing metadata attached to the blob. To remove all + + metadata from the blob, call this operation with no metadata headers.' + defaultValue: None + types: + - (, ) + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the updated Blob + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.set_blob_properties + name: set_blob_properties + summary: 'Sets system properties on the blob. If one property is set for the + + content_settings, all properties will be overriden.' + signature: set_blob_properties(container_name, blob_name, content_settings=None, + lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, + if_none_match=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: content_settings + description: ContentSettings object used to set blob properties. + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the updated Blob + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.set_blob_service_properties + name: set_blob_service_properties + summary: 'Sets the properties of a storage account''s Blob service, including + + Azure Storage Analytics. If an element (ex Logging) is left as None, the + + existing settings on the service for that functionality are preserved.' + signature: set_blob_service_properties(logging=None, hour_metrics=None, minute_metrics=None, + cors=None, target_version=None, timeout=None, delete_retention_policy=None, static_website=None) + parameters: + - name: logging + description: Groups the Azure Analytics Logging settings. + defaultValue: None + types: + - + - name: hour_metrics + description: 'The hour metrics settings provide a summary of request + + statistics grouped by API in hourly aggregates for blobs.' + defaultValue: None + types: + - + - name: minute_metrics + description: 'The minute metrics settings provide request statistics + + for each minute for blobs.' + defaultValue: None + types: + - + - name: cors + description: 'You can include up to five CorsRule elements in the + + list. If an empty list is specified, all CORS rules will be deleted, + + and CORS will be disabled for the service.' + defaultValue: None + types: + - list() + - name: target_version + description: 'Indicates the default version to use for requests if an incoming + + request''s version is not specified.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + - name: delete_retention_policy + description: 'The delete retention policy specifies whether to retain deleted + blobs. + + It also specifies the number of days and versions of blob to keep.' + defaultValue: None + types: + - + - name: static_website + description: 'Specifies whether the static website feature is enabled, + + and if yes, indicates the index document and 404 error document to use.' + defaultValue: None + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.set_container_acl + name: set_container_acl + summary: 'Sets the permissions for the specified container or stored access + + policies that may be used with Shared Access Signatures. The permissions + + indicate whether blobs in a container may be accessed publicly.' + signature: set_container_acl(container_name, signed_identifiers=None, public_access=None, + lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: signed_identifiers + description: 'A dictionary of access policies to associate with the container. + The + + dictionary may contain up to 5 elements. An empty dictionary + + will clear the access policies set on the service.' + defaultValue: None + types: + - dict(str, ) + - name: public_access + description: 'Possible values include: container, blob.' + defaultValue: None + types: + - + - name: lease_id + description: 'If specified, set_container_acl only succeeds if the + + container''s lease is active and matches this ID.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A datetime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A datetime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the updated Container + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.set_container_metadata + name: set_container_metadata + summary: 'Sets one or more user-defined name-value pairs for the specified + + container. Each call to this operation replaces all existing metadata + + attached to the container. To remove all metadata from the container, + + call this operation with no metadata dict.' + signature: set_container_metadata(container_name, metadata=None, lease_id=None, + if_modified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: metadata + description: 'A dict containing name-value pairs to associate with the container + as + + metadata. Example: {''category'':''test''}' + defaultValue: None + types: + - (, ) + - name: lease_id + description: 'If specified, set_container_metadata only succeeds if the + + container''s lease is active and matches this ID.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the updated Container + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.set_proxy + name: set_proxy + summary: Sets the proxy server host and port for the HTTP CONNECT Tunnelling. + signature: set_proxy(host, port, user=None, password=None) + parameters: + - name: host + description: 'Address of the proxy. Ex: ''192.168.0.100''' + isRequired: true + types: + - + - name: port + description: 'Port of the proxy. Ex: 6000' + isRequired: true + types: + - + - name: user + description: User for proxy authorization. + defaultValue: None + types: + - + - name: password + description: Password for proxy authorization. + defaultValue: None + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.set_standard_blob_tier + name: set_standard_blob_tier + summary: "Sets the block blob tiers on the blob. This API is only supported for\ + \ block blobs on standard storage accounts.\n\n:param \ + \ rehydrate_priority:\n Indicates the priority with which to rehydrate an archived\ + \ blob" + signature: set_standard_blob_tier(container_name, blob_name, standard_blob_tier, + timeout=None, rehydrate_priority=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob to update. + isRequired: true + types: + - + - name: standard_blob_tier + description: 'A standard blob tier value to set the blob to. For this version + of the library, + + this is only applicable to block blobs on standard storage accounts.' + isRequired: true + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + - name: rehydrate_priority + defaultValue: None +- uid: azure.storage.blob.blockblobservice.BlockBlobService.snapshot_blob + name: snapshot_blob + summary: Creates a read-only snapshot of a blob. + signature: snapshot_blob(container_name, blob_name, metadata=None, if_modified_since=None, + if_unmodified_since=None, if_match=None, if_none_match=None, lease_id=None, timeout=None, + cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: metadata + description: 'Specifies a user-defined name-value pair associated with the blob. + + If no name-value pairs are specified, the operation will copy the + + base blob metadata to the snapshot. If one or more name-value pairs + + are specified, the snapshot is created with the specified metadata, + + and metadata is not copied from the base blob.' + defaultValue: None + types: + - (, ) + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: snapshot properties + types: + - +- uid: azure.storage.blob.blockblobservice.BlockBlobService.undelete_blob + name: undelete_blob + summary: 'The undelete Blob operation restores the contents and metadata of soft + deleted blob or snapshot. + + Attempting to undelete a blob or snapshot that is not soft deleted will succeed + without any changes.' + signature: undelete_blob(container_name, blob_name, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +attributes: +- uid: azure.storage.blob.blockblobservice.BlockBlobService.protocol + name: protocol +- uid: azure.storage.blob.blockblobservice.BlockBlobService.request_session + name: request_session +- uid: azure.storage.blob.blockblobservice.BlockBlobService.socket_timeout + name: socket_timeout +- uid: azure.storage.blob.blockblobservice.BlockBlobService.MAX_BLOCK_SIZE + name: MAX_BLOCK_SIZE + signature: MAX_BLOCK_SIZE = 4194304 +- uid: azure.storage.blob.blockblobservice.BlockBlobService.MAX_CHUNK_GET_SIZE + name: MAX_CHUNK_GET_SIZE + signature: MAX_CHUNK_GET_SIZE = 4194304 +- uid: azure.storage.blob.blockblobservice.BlockBlobService.MAX_SINGLE_GET_SIZE + name: MAX_SINGLE_GET_SIZE + signature: MAX_SINGLE_GET_SIZE = 33554432 +- uid: azure.storage.blob.blockblobservice.BlockBlobService.MAX_SINGLE_PUT_SIZE + name: MAX_SINGLE_PUT_SIZE + signature: MAX_SINGLE_PUT_SIZE = 67108864 +- uid: azure.storage.blob.blockblobservice.BlockBlobService.MIN_LARGE_BLOCK_UPLOAD_THRESHOLD + name: MIN_LARGE_BLOCK_UPLOAD_THRESHOLD + signature: MIN_LARGE_BLOCK_UPLOAD_THRESHOLD = 4194305 diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.blockblobservice.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.blockblobservice.yml new file mode 100644 index 00000000..eb3c7adc --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.blockblobservice.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.storage.blob.blockblobservice +name: blockblobservice +fullName: azure.storage.blob.blockblobservice +classes: +- azure.storage.blob.blockblobservice.BlockBlobService diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.AccountInformation.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.AccountInformation.yml new file mode 100644 index 00000000..6f8f3abf --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.AccountInformation.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.AccountInformation +name: AccountInformation +fullName: azure.storage.blob.models.AccountInformation +module: azure.storage.blob.models +summary: Holds information related to the storage account. +constructor: + syntax: AccountInformation() +variables: +- description: 'Name of the storage SKU, also known as account type. + + Example: Standard_LRS, Standard_ZRS, Standard_GRS, Standard_RAGRS, Premium_LRS, + Premium_ZRS' + name: sku_name + types: + - +- description: 'Describes the flavour of the storage account, also known as account + kind. + + Example: Storage, StorageV2, BlobStorage' + name: account_kind + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.AppendBlockProperties.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.AppendBlockProperties.yml new file mode 100644 index 00000000..8a7f4e52 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.AppendBlockProperties.yml @@ -0,0 +1,24 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.AppendBlockProperties +name: AppendBlockProperties +fullName: azure.storage.blob.models.AppendBlockProperties +module: azure.storage.blob.models +summary: Response for an append block request. +constructor: + syntax: AppendBlockProperties() +variables: +- description: Position to start next append. + name: append_offset + types: + - +- description: Number of committed append blocks. + name: committed_block_count + types: + - +methods: +- uid: azure.storage.blob.models.AppendBlockProperties.clone + name: clone + signature: clone(src) + parameters: + - name: src + isRequired: true diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BatchDeleteSubRequest.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BatchDeleteSubRequest.yml new file mode 100644 index 00000000..09e9d03b --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BatchDeleteSubRequest.yml @@ -0,0 +1,99 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.BatchDeleteSubRequest +name: BatchDeleteSubRequest +fullName: azure.storage.blob.models.BatchDeleteSubRequest +module: azure.storage.blob.models +summary: 'Represents one request in batch of multiple blob delete requests + + + Organizes HttpRequest objects together for batch REST operations to a single host + endpoint.' +constructor: + syntax: BatchDeleteSubRequest(container_name, blob_name, snapshot=None, lease_id=None, + delete_snapshots=None, if_modified_since=None, if_unmodified_since=None, if_match=None, + if_none_match=None) + parameters: + - name: container_name + isRequired: true + - name: blob_name + isRequired: true + - name: snapshot + defaultValue: None + - name: lease_id + defaultValue: None + - name: delete_snapshots + defaultValue: None + - name: if_modified_since + defaultValue: None + - name: if_unmodified_since + defaultValue: None + - name: if_match + defaultValue: None + - name: if_none_match + defaultValue: None +variables: +- description: Name of existing container. + name: container_name + types: + - +- description: Name of existing blob. + name: blob_name + types: + - +- description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to delete.' + name: snapshot + types: + - +- description: Required if the blob has an active lease. + name: lease_id + types: + - +- description: Required if the blob has associated snapshots. + name: delete_snapshots + types: + - +- description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + name: if_modified_since + types: + - +- description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + name: if_unmodified_since + types: + - +- description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + name: if_match + types: + - +- description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + name: if_none_match + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BatchSetBlobTierSubRequest.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BatchSetBlobTierSubRequest.yml new file mode 100644 index 00000000..c3b3945b --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BatchSetBlobTierSubRequest.yml @@ -0,0 +1,38 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.BatchSetBlobTierSubRequest +name: BatchSetBlobTierSubRequest +fullName: azure.storage.blob.models.BatchSetBlobTierSubRequest +module: azure.storage.blob.models +summary: 'Represents one request in batch of multiple set block blob tier requests + + + Organizes HttpRequest objects together for batch REST operations to a single host + endpoint.' +constructor: + syntax: BatchSetBlobTierSubRequest(container_name, blob_name, standard_blob_tier, + rehydrate_priority=None) + parameters: + - name: container_name + isRequired: true + - name: blob_name + isRequired: true + - name: standard_blob_tier + isRequired: true + - name: rehydrate_priority + defaultValue: None +variables: +- description: Name of existing container. + name: container_name + types: + - +- description: Name of existing blob. + name: blob_name + types: + - +- description: 'A standard blob tier value to set the blob to. For this version of + the library, + + this is only applicable to block blobs on standard storage accounts.' + name: standard_blob_tier + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BatchSubResponse.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BatchSubResponse.yml new file mode 100644 index 00000000..2f384a64 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BatchSubResponse.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.BatchSubResponse +name: BatchSubResponse +fullName: azure.storage.blob.models.BatchSubResponse +module: azure.storage.blob.models +summary: "Sub-response parsed from batch http sub-response\n\nOrganizes batch sub-response\ + \ info and batch sub-request together for easier processing\n\n:ivar [HTTPResponse](azure.storage.common._http.HTTPResponse)\ + \ http_response:\n Parsed batch sub-response, in HTTPResponse format" +constructor: + syntax: BatchSubResponse(is_successful, http_response, batch_sub_request) + parameters: + - name: is_successful + isRequired: true + - name: http_response + isRequired: true + - name: batch_sub_request + isRequired: true +variables: +- description: Represent if the batch sub-request is successful + name: is_successful + types: + - +- description: 'Represent the batch sub-request corresponding to the batch sub-response. + + This could be any type of sub-request. One example is class: ~azure.storage.blob.models.BatchDeleteSubRequest' + name: batch_sub_request diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.Blob.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.Blob.yml new file mode 100644 index 00000000..ed99b9a8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.Blob.yml @@ -0,0 +1,58 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.Blob +name: Blob +fullName: azure.storage.blob.models.Blob +module: azure.storage.blob.models +summary: Blob class. +constructor: + syntax: Blob(name=None, snapshot=None, content=None, props=None, metadata=None, + deleted=False) + parameters: + - name: name + defaultValue: None + - name: snapshot + defaultValue: None + - name: content + defaultValue: None + - name: props + defaultValue: None + - name: metadata + defaultValue: None + - name: deleted + defaultValue: 'False' +variables: +- description: Name of blob. + name: name + types: + - +- description: 'A DateTime value that uniquely identifies the snapshot. The value + of + + this header indicates the snapshot version, and may be used in + + subsequent requests to access the snapshot.' + name: snapshot + types: + - +- description: Blob content. + name: content + types: + - + - +- description: Stores all the system properties for the blob. + name: properties + types: + - +- description: Name-value pairs associated with the blob as metadata. + name: metadata +- description: 'Specify whether the blob was soft deleted. + + In other words, if the blob is being retained by the delete retention policy, + + this field would be True. The blob could be undeleted or it will be garbage collected + after the specified + + time period.' + name: deleted + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobBlock.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobBlock.yml new file mode 100644 index 00000000..e2ec5bdb --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobBlock.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.BlobBlock +name: BlobBlock +fullName: azure.storage.blob.models.BlobBlock +module: azure.storage.blob.models +summary: BlockBlob Block class. +constructor: + syntax: BlobBlock(id=None, state='Latest') + parameters: + - name: id + defaultValue: None + - name: state + defaultValue: Latest +variables: +- description: Block id. + name: id + types: + - +- description: 'Block state. + + Possible valuse: committed|uncommitted' + name: state + types: + - +- description: Block size in bytes. + name: size + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobBlockList.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobBlockList.yml new file mode 100644 index 00000000..697fffcd --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobBlockList.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.BlobBlockList +name: BlobBlockList +fullName: azure.storage.blob.models.BlobBlockList +module: azure.storage.blob.models +summary: Blob Block List class. +constructor: + syntax: BlobBlockList() +variables: +- description: List of committed blocks. + name: committed_blocks + types: + - list() +- description: List of uncommitted blocks. + name: uncommitted_blocks + types: + - list() diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobBlockState.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobBlockState.yml new file mode 100644 index 00000000..bee17c99 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobBlockState.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.BlobBlockState +name: BlobBlockState +fullName: azure.storage.blob.models.BlobBlockState +module: azure.storage.blob.models +summary: Block blob block types. +constructor: + syntax: BlobBlockState() +attributes: +- uid: azure.storage.blob.models.BlobBlockState.Committed + name: Committed + summary: Committed blocks. + signature: Committed = 'Committed' +- uid: azure.storage.blob.models.BlobBlockState.Latest + name: Latest + summary: Latest blocks. + signature: Latest = 'Latest' +- uid: azure.storage.blob.models.BlobBlockState.Uncommitted + name: Uncommitted + summary: Uncommitted blocks. + signature: Uncommitted = 'Uncommitted' diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobPermissions.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobPermissions.yml new file mode 100644 index 00000000..8d64260e --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobPermissions.yml @@ -0,0 +1,94 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.BlobPermissions +name: BlobPermissions +fullName: azure.storage.blob.models.BlobPermissions +module: azure.storage.blob.models +summary: 'BlobPermissions class to be used with + + + API.' +constructor: + syntax: BlobPermissions(read=False, add=False, create=False, write=False, delete=False, + _str=None) + parameters: + - name: read + description: 'Read the content, properties, metadata and block list. Use the blob + as + + the source of a copy operation.' + defaultValue: 'False' + types: + - + - name: add + description: Add a block to an append blob. + defaultValue: 'False' + types: + - + - name: create + description: Write a new blob, snapshot a blob, or copy a blob to a new blob. + defaultValue: 'False' + types: + - + - name: write + description: 'Create or write content, properties, metadata, or block list. Snapshot + + or lease the blob. Resize the blob (page blob only). Use the blob as the + + destination of a copy operation within the same account.' + defaultValue: 'False' + types: + - + - name: delete + description: Delete the blob. + defaultValue: 'False' + types: + - + - name: _str + description: A string representing the permissions. + defaultValue: None + types: + - +variables: +- description: Add a block to an append blob. + name: BlobPermissions.ADD + types: + - +- description: Write a new blob, snapshot a blob, or copy a blob to a new blob. + name: BlobPermissions.CREATE + types: + - +- description: Delete the blob. + name: BlobPermissions.DELETE + types: + - +- description: Read the content, properties, metadata and block list. Use the blob + as the source of a copy operation. + name: BlobPermissions.READ + types: + - +- description: 'Create or write content, properties, metadata, or block list. Snapshot + or lease + + the blob. Resize the blob (page blob only). Use the blob as the destination of + a + + copy operation within the same account.' + name: BlobPermissions.WRITE + types: + - +attributes: +- uid: azure.storage.blob.models.BlobPermissions.ADD + name: ADD + signature: ADD = +- uid: azure.storage.blob.models.BlobPermissions.CREATE + name: CREATE + signature: CREATE = +- uid: azure.storage.blob.models.BlobPermissions.DELETE + name: DELETE + signature: DELETE = +- uid: azure.storage.blob.models.BlobPermissions.READ + name: READ + signature: READ = +- uid: azure.storage.blob.models.BlobPermissions.WRITE + name: WRITE + signature: WRITE = diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobPrefix.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobPrefix.yml new file mode 100644 index 00000000..e8c4d688 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobPrefix.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.BlobPrefix +name: BlobPrefix +fullName: azure.storage.blob.models.BlobPrefix +module: azure.storage.blob.models +summary: 'BlobPrefix objects may potentially returned in the blob list when + + is + + used with a delimiter. Prefixes can be thought of as virtual blob directories.' +constructor: + syntax: BlobPrefix() +variables: +- description: The name of the blob prefix. + name: name + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobProperties.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobProperties.yml new file mode 100644 index 00000000..c9450643 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlobProperties.yml @@ -0,0 +1,107 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.BlobProperties +name: BlobProperties +fullName: azure.storage.blob.models.BlobProperties +module: azure.storage.blob.models +summary: Blob Properties +constructor: + syntax: BlobProperties() +variables: +- description: String indicating this blob's type. + name: blob_type + types: + - +- description: A datetime object representing the last time the blob was modified. + name: last_modified + types: + - +- description: 'The ETag contains a value that you can use to perform operations + + conditionally.' + name: etag + types: + - +- description: 'The length of the content returned. If the entire blob was requested, + + the length of blob in bytes. If a subset of the blob was requested, the + + length of the returned subset.' + name: content_length + types: + - +- description: 'Indicates the range of bytes returned in the event that the client + + requested a subset of the blob.' + name: content_range + types: + - +- description: (For Append Blobs) Number of committed blocks in the blob. + name: append_blob_committed_block_count + types: + - +- description: '(For Page Blobs) Sequence number for page blob used for coordinating + + concurrent writes.' + name: page_blob_sequence_number + types: + - +- description: Set to true if the blob is encrypted on the server. + name: server_encrypted + types: + - +- description: 'The server will echo the SHA256 of the customer-provided encryption + key + + to validate the key used in the operation.' + name: encryption_key_sha256 + types: + - +- description: Stores all the copy properties for the blob. + name: copy + types: + - +- description: Stores all the content settings for the blob. + name: content_settings + types: + - +- description: Stores all the lease information for the blob. + name: lease + types: + - +- description: 'Indicates the access tier of the blob. The hot tier is optimized + + for storing data that is accessed frequently. The cool storage tier + + is optimized for storing data that is infrequently accessed and stored + + for at least a month. The archive tier is optimized for storing + + data that is rarely accessed and stored for at least six months + + with flexible latency requirements.' + name: blob_tier + types: + - +- description: Indicates when the access tier was last changed. + name: blob_tier_change_time + types: + - +- description: 'Indicates whether the access tier was inferred by the service. + + If false, it indicates that the tier was set explicitly.' + name: blob_tier_inferred + types: + - +- description: A datetime object representing the time at which the blob was deleted. + name: deleted_time + types: + - +- description: The number of days that the blob will be retained before being permanently + deleted by the service. + name: remaining_retention_days + types: + - +- description: Indicates when the blob was created, in UTC. + name: creation_time + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlockListType.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlockListType.yml new file mode 100644 index 00000000..b4f288d1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.BlockListType.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.BlockListType +name: BlockListType +fullName: azure.storage.blob.models.BlockListType +module: azure.storage.blob.models +summary: 'Specifies whether to return the list of committed blocks, the list of uncommitted + + blocks, or both lists together.' +constructor: + syntax: BlockListType() +attributes: +- uid: azure.storage.blob.models.BlockListType.All + name: All + summary: Both committed and uncommitted blocks. + signature: All = 'all' +- uid: azure.storage.blob.models.BlockListType.Committed + name: Committed + summary: Committed blocks. + signature: Committed = 'committed' +- uid: azure.storage.blob.models.BlockListType.Uncommitted + name: Uncommitted + summary: Uncommitted blocks. + signature: Uncommitted = 'uncommitted' diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.Container.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.Container.yml new file mode 100644 index 00000000..1afad3f1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.Container.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.Container +name: Container +fullName: azure.storage.blob.models.Container +module: azure.storage.blob.models +summary: Blob container class. +constructor: + syntax: Container(name=None, props=None, metadata=None) + parameters: + - name: name + defaultValue: None + - name: props + defaultValue: None + - name: metadata + defaultValue: None +variables: +- description: The name of the container. + name: name + types: + - +- description: 'A dict containing name-value pairs associated with the container as + metadata. + + This var is set to None unless the include=metadata param was included + + for the list containers operation. If this parameter was specified but the + + container has no metadata, metadata will be set to an empty dictionary.' + name: metadata + types: + - (, ) +- description: System properties for the container. + name: properties + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.ContainerPermissions.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.ContainerPermissions.yml new file mode 100644 index 00000000..790e3bc6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.ContainerPermissions.yml @@ -0,0 +1,121 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.ContainerPermissions +name: ContainerPermissions +fullName: azure.storage.blob.models.ContainerPermissions +module: azure.storage.blob.models +summary: 'ContainerPermissions class to be used with + + API and for the AccessPolicies used with .' +constructor: + syntax: ContainerPermissions(read=False, add=False, create=False, write=False, delete=False, + list=False, _str=None) + parameters: + - name: read + description: 'Read the content, properties, metadata or block list of any blob + in the + + container. Use any blob in the container as the source of a copy operation.' + defaultValue: 'False' + types: + - + - name: add + description: Add a block to any append blob in the container. + defaultValue: 'False' + types: + - + - name: create + description: 'Write a new blob to the container, snapshot any blob in the container, + or copy a blob to + + a new blob in the container. Note: You cannot grant permissions to create a + container + + with a container SAS. Use an account SAS to create a container instead.' + defaultValue: 'False' + types: + - + - name: write + description: 'For any blob in the container, create or write content, properties, + + metadata, or block list. Snapshot or lease the blob. Resize the blob + + (page blob only). Use the blob as the destination of a copy operation + + within the same account. Note: You cannot grant permissions to read or + + write container properties or metadata, nor to lease a container, with + + a container SAS. Use an account SAS instead.' + defaultValue: 'False' + types: + - + - name: delete + description: 'Delete any blob in the container. Note: You cannot grant permissions + to + + delete a container with a container SAS. Use an account SAS instead.' + defaultValue: 'False' + types: + - + - name: list + description: List blobs in the container. + defaultValue: 'False' + types: + - + - name: _str + description: A string representing the permissions. + defaultValue: None + types: + - +variables: +- description: 'Delete any blob in the container. Note: You cannot grant permissions + to + + delete a container with a container SAS. Use an account SAS instead.' + name: ContainerPermissions.DELETE + types: + - +- description: List blobs in the container. + name: ContainerPermissions.LIST + types: + - +- description: 'Read the content, properties, metadata or block list of any blob in + the + + container. Use any blob in the container as the source of a copy operation.' + name: ContainerPermissions.READ + types: + - +- description: 'For any blob in the container, create or write content, properties, + + metadata, or block list. Snapshot or lease the blob. Resize the blob + + (page blob only). Use the blob as the destination of a copy operation + + within the same account. Note: You cannot grant permissions to read or + + write container properties or metadata, nor to lease a container, with + + a container SAS. Use an account SAS instead.' + name: ContainerPermissions.WRITE + types: + - +attributes: +- uid: azure.storage.blob.models.ContainerPermissions.ADD + name: ADD + signature: ADD = +- uid: azure.storage.blob.models.ContainerPermissions.CREATE + name: CREATE + signature: CREATE = +- uid: azure.storage.blob.models.ContainerPermissions.DELETE + name: DELETE + signature: DELETE = +- uid: azure.storage.blob.models.ContainerPermissions.LIST + name: LIST + signature: LIST = +- uid: azure.storage.blob.models.ContainerPermissions.READ + name: READ + signature: READ = +- uid: azure.storage.blob.models.ContainerPermissions.WRITE + name: WRITE + signature: WRITE = diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.ContainerProperties.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.ContainerProperties.yml new file mode 100644 index 00000000..0a5608ab --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.ContainerProperties.yml @@ -0,0 +1,31 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.ContainerProperties +name: ContainerProperties +fullName: azure.storage.blob.models.ContainerProperties +module: azure.storage.blob.models +summary: Blob container's properties class. +constructor: + syntax: ContainerProperties() +variables: +- description: A datetime object representing the last time the container was modified. + name: last_modified + types: + - +- description: 'The ETag contains a value that you can use to perform operations + + conditionally.' + name: etag + types: + - +- description: Stores all the lease information for the container. + name: lease + types: + - +- description: Represents whether the container has an immutability policy. + name: has_immutability_policy + types: + - +- description: Represents whether the container has a legal hold. + name: has_legal_hold + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.ContentSettings.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.ContentSettings.yml new file mode 100644 index 00000000..cd2d924a --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.ContentSettings.yml @@ -0,0 +1,65 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.ContentSettings +name: ContentSettings +fullName: azure.storage.blob.models.ContentSettings +module: azure.storage.blob.models +summary: Used to store the content settings of a blob. +constructor: + syntax: ContentSettings(content_type=None, content_encoding=None, content_language=None, + content_disposition=None, cache_control=None, content_md5=None) + parameters: + - name: content_type + defaultValue: None + - name: content_encoding + defaultValue: None + - name: content_language + defaultValue: None + - name: content_disposition + defaultValue: None + - name: cache_control + defaultValue: None + - name: content_md5 + defaultValue: None +variables: +- description: 'The content type specified for the blob. If no content type was + + specified, the default content type is application/octet-stream.' + name: content_type + types: + - +- description: 'If the content_encoding has previously been set + + for the blob, that value is stored.' + name: content_encoding + types: + - +- description: 'If the content_language has previously been set + + for the blob, that value is stored.' + name: content_language + types: + - +- description: 'content_disposition conveys additional information about how to + + process the response payload, and also can be used to attach + + additional metadata. If content_disposition has previously been set + + for the blob, that value is stored.' + name: content_disposition + types: + - +- description: 'If the cache_control has previously been set for + + the blob, that value is stored.' + name: cache_control + types: + - +- description: 'If the content_md5 has been set for the blob, this response + + header is stored so that the client can check for message content + + integrity.' + name: content_md5 + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.CopyProperties.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.CopyProperties.yml new file mode 100644 index 00000000..30d9827c --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.CopyProperties.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.CopyProperties +name: CopyProperties +fullName: azure.storage.blob.models.CopyProperties +module: azure.storage.blob.models +summary: Blob Copy Properties. +constructor: + syntax: CopyProperties() +variables: +- description: 'String identifier for the last attempted Copy Blob operation where + this blob + + was the destination blob. This header does not appear if this blob has never + + been the destination in a Copy Blob operation, or if this blob has been + + modified after a concluded Copy Blob operation using Set Blob Properties, + + Put Blob, or Put Block List.' + name: id + types: + - +- description: 'URL up to 2 KB in length that specifies the source blob used in the + last attempted + + Copy Blob operation where this blob was the destination blob. This header does + not + + appear if this blob has never been the destination in a Copy Blob operation, or + if + + this blob has been modified after a concluded Copy Blob operation using + + Set Blob Properties, Put Blob, or Put Block List.' + name: source + types: + - +- description: "State of the copy operation identified by Copy ID, with these values:\n\ + \ success:\n Copy completed successfully.\n\n pending:\n Copy is\ + \ in progress. Check copy_status_description if intermittent,\n non-fatal\ + \ errors impede copy progress but don't cause failure.\n\n aborted:\n Copy\ + \ was ended by Abort Copy Blob.\n\n failed:\n Copy failed. See copy_status_description\ + \ for failure details." + name: status + types: + - +- description: 'Contains the number of bytes copied and the total bytes in the source + in the last + + attempted Copy Blob operation where this blob was the destination blob. Can show + + between 0 and Content-Length bytes copied.' + name: progress + types: + - +- description: 'Conclusion time of the last attempted Copy Blob operation where this + blob was the + + destination blob. This value can specify the time of a completed, aborted, or + + failed copy attempt.' + name: completion_time + types: + - +- description: 'only appears when x-ms-copy-status is failed or pending. Describes + cause of fatal + + or non-fatal copy operation failure.' + name: status_description + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.CustomerProvidedEncryptionKey.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.CustomerProvidedEncryptionKey.yml new file mode 100644 index 00000000..36553716 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.CustomerProvidedEncryptionKey.yml @@ -0,0 +1,55 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.CustomerProvidedEncryptionKey +name: CustomerProvidedEncryptionKey +fullName: azure.storage.blob.models.CustomerProvidedEncryptionKey +module: azure.storage.blob.models +summary: 'All data in Azure Storage is encrypted at-rest using an account-level encryption + key. + + In versions 2018-06-17 and newer, you can manage the key used to encrypt blob contents + + and application metadata per-blob by providing an AES-256 encryption key in requests + to the storage service. + + + When you use a customer-provided key, Azure Storage does not manage or persist your + key. + + When writing data to a blob, the provided key is used to encrypt your data before + writing it to disk. + + A SHA-256 hash of the encryption key is written alongside the blob contents, + + and is used to verify that all subsequent operations against the blob use the same + encryption key. + + This hash cannot be used to retrieve the encryption key or decrypt the contents + of the blob. + + When reading a blob, the provided key is used to decrypt your data after reading + it from disk. + + In both cases, the provided encryption key is securely discarded + + as soon as the encryption or decryption process completes.' +constructor: + syntax: CustomerProvidedEncryptionKey(key_value, key_hash) + parameters: + - name: key_value + isRequired: true + - name: key_hash + isRequired: true +variables: +- description: Base64-encoded AES-256 encryption key value. + name: key_value + types: + - +- description: Base64-encoded SHA256 of the encryption key. + name: key_hash + types: + - +- description: Specifies the algorithm to use when encrypting data using the given + key. Must be AES256. + name: algorithm + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.DeleteSnapshot.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.DeleteSnapshot.yml new file mode 100644 index 00000000..adb7432e --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.DeleteSnapshot.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.DeleteSnapshot +name: DeleteSnapshot +fullName: azure.storage.blob.models.DeleteSnapshot +module: azure.storage.blob.models +summary: Required if the blob has associated snapshots. Specifies how to handle the + snapshots. +constructor: + syntax: DeleteSnapshot() +attributes: +- uid: azure.storage.blob.models.DeleteSnapshot.Include + name: Include + summary: Delete the base blob and all of its snapshots. + signature: Include = 'include' +- uid: azure.storage.blob.models.DeleteSnapshot.Only + name: Only + summary: Delete only the blob's snapshots and not the blob itself. + signature: Only = 'only' diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.Include.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.Include.yml new file mode 100644 index 00000000..3f340c00 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.Include.yml @@ -0,0 +1,89 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.Include +name: Include +fullName: azure.storage.blob.models.Include +module: azure.storage.blob.models +summary: Specifies the datasets to include in the blob list response. +constructor: + syntax: Include(snapshots=False, metadata=False, uncommitted_blobs=False, copy=False, + deleted=False, _str=None) + parameters: + - name: snapshots + description: Specifies that snapshots should be included in the enumeration. + defaultValue: 'False' + types: + - + - name: metadata + description: Specifies that metadata be returned in the response. + defaultValue: 'False' + types: + - + - name: uncommitted_blobs + description: 'Specifies that blobs for which blocks have been uploaded, but which + have + + not been committed using Put Block List, be included in the response.' + defaultValue: 'False' + types: + - + - name: copy + description: 'Specifies that metadata related to any current or previous Copy + Blob + + operation should be included in the response.' + defaultValue: 'False' + types: + - + - name: deleted + description: Specifies that deleted blobs should be returned in the response. + defaultValue: 'False' + types: + - + - name: _str + description: A string representing the includes. + defaultValue: None + types: + - +variables: +- description: 'Specifies that metadata related to any current or previous Copy Blob + operation + + should be included in the response.' + name: Include.COPY + types: + - +- description: Specifies that metadata be returned in the response. + name: Include.METADATA + types: + - +- description: Specifies that snapshots should be included in the enumeration. + name: Include.SNAPSHOTS + types: + - +- description: 'Specifies that blobs for which blocks have been uploaded, but which + have not + + been committed using Put Block List, be included in the response.' + name: Include.UNCOMMITTED_BLOBS + types: + - +- description: Specifies that deleted blobs should be returned in the response. + name: Include.DELETED + types: + - +attributes: +- uid: azure.storage.blob.models.Include.COPY + name: COPY + signature: COPY = +- uid: azure.storage.blob.models.Include.DELETED + name: DELETED + signature: DELETED = +- uid: azure.storage.blob.models.Include.METADATA + name: METADATA + signature: METADATA = +- uid: azure.storage.blob.models.Include.SNAPSHOTS + name: SNAPSHOTS + signature: SNAPSHOTS = +- uid: azure.storage.blob.models.Include.UNCOMMITTED_BLOBS + name: UNCOMMITTED_BLOBS + signature: UNCOMMITTED_BLOBS = diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.LeaseProperties.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.LeaseProperties.yml new file mode 100644 index 00000000..8208cca2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.LeaseProperties.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.LeaseProperties +name: LeaseProperties +fullName: azure.storage.blob.models.LeaseProperties +module: azure.storage.blob.models +summary: Blob Lease Properties. +constructor: + syntax: LeaseProperties() +variables: +- description: 'The lease status of the blob. + + Possible values: locked|unlocked' + name: status + types: + - +- description: 'Lease state of the blob. + + Possible values: available|leased|expired|breaking|broken' + name: state + types: + - +- description: When a blob is leased, specifies whether the lease is of infinite or + fixed duration. + name: duration + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.PageBlobProperties.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.PageBlobProperties.yml new file mode 100644 index 00000000..d4ac82c9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.PageBlobProperties.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.PageBlobProperties +name: PageBlobProperties +fullName: azure.storage.blob.models.PageBlobProperties +module: azure.storage.blob.models +summary: Response for a page request. +constructor: + syntax: PageBlobProperties() +variables: +- description: Identifer for page blobs to help handle concurrent writes. + name: sequence_number + types: + - +methods: +- uid: azure.storage.blob.models.PageBlobProperties.clone + name: clone + signature: clone(src) + parameters: + - name: src + isRequired: true diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.PageRange.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.PageRange.yml new file mode 100644 index 00000000..8fe45e8b --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.PageRange.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.PageRange +name: PageRange +fullName: azure.storage.blob.models.PageRange +module: azure.storage.blob.models +summary: Page Range for page blob. +constructor: + syntax: PageRange(start=None, end=None, is_cleared=False) + parameters: + - name: start + defaultValue: None + - name: end + defaultValue: None + - name: is_cleared + defaultValue: 'False' +variables: +- description: Start of page range in bytes. + name: start + types: + - +- description: End of page range in bytes. + name: end + types: + - +- description: 'Indicates if a page range is cleared or not. Only applicable + + for get_page_range_diff API.' + name: is_cleared + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.PremiumPageBlobTier.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.PremiumPageBlobTier.yml new file mode 100644 index 00000000..ada893e7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.PremiumPageBlobTier.yml @@ -0,0 +1,48 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.PremiumPageBlobTier +name: PremiumPageBlobTier +fullName: azure.storage.blob.models.PremiumPageBlobTier +module: azure.storage.blob.models +summary: 'Specifies the page blob tier to set the blob to. This is only applicable + to page + + blobs on premium storage accounts. + + Please take a look at [https://docs.microsoft.com/en-us/azure/storage/storage-premium-storage#scalability-and-performance-targets](https://docs.microsoft.com/en-us/azure/storage/storage-premium-storage#scalability-and-performance-targets) + + for detailed information on the corresponding IOPS and throughtput per PageBlobTier.' +constructor: + syntax: PremiumPageBlobTier() +attributes: +- uid: azure.storage.blob.models.PremiumPageBlobTier.P10 + name: P10 + summary: P10 Tier + signature: P10 = 'P10' +- uid: azure.storage.blob.models.PremiumPageBlobTier.P20 + name: P20 + summary: P20 Tier + signature: P20 = 'P20' +- uid: azure.storage.blob.models.PremiumPageBlobTier.P30 + name: P30 + summary: P30 Tier + signature: P30 = 'P30' +- uid: azure.storage.blob.models.PremiumPageBlobTier.P4 + name: P4 + summary: P4 Tier + signature: P4 = 'P4' +- uid: azure.storage.blob.models.PremiumPageBlobTier.P40 + name: P40 + summary: P40 Tier + signature: P40 = 'P40' +- uid: azure.storage.blob.models.PremiumPageBlobTier.P50 + name: P50 + summary: P50 Tier + signature: P50 = 'P50' +- uid: azure.storage.blob.models.PremiumPageBlobTier.P6 + name: P6 + summary: P6 Tier + signature: P6 = 'P6' +- uid: azure.storage.blob.models.PremiumPageBlobTier.P60 + name: P60 + summary: P60 Tier + signature: P60 = 'P60' diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.PublicAccess.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.PublicAccess.yml new file mode 100644 index 00000000..5cf41388 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.PublicAccess.yml @@ -0,0 +1,36 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.PublicAccess +name: PublicAccess +fullName: azure.storage.blob.models.PublicAccess +module: azure.storage.blob.models +summary: Specifies whether data in the container may be accessed publicly and the + level of access. +constructor: + syntax: PublicAccess() +attributes: +- uid: azure.storage.blob.models.PublicAccess.Blob + name: Blob + summary: 'Specifies public read access for blobs. Blob data within this container + can be read + + via anonymous request, but container data is not available. Clients cannot enumerate + + blobs within the container via anonymous request.' + signature: Blob = 'blob' +- uid: azure.storage.blob.models.PublicAccess.Container + name: Container + summary: 'Specifies full public read access for container and blob data. Clients + can enumerate + + blobs within the container via anonymous request, but cannot enumerate containers + + within the storage account.' + signature: Container = 'container' +- uid: azure.storage.blob.models.PublicAccess.OFF + name: 'OFF' + summary: 'Specifies that there is no public read access for both the container and + blobs within the container. + + Clients cannot enumerate the containers within the storage account as well as + the blobs within the container.' + signature: OFF = 'off' diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.RehydratePriority.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.RehydratePriority.yml new file mode 100644 index 00000000..309a05a7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.RehydratePriority.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.RehydratePriority +name: RehydratePriority +fullName: azure.storage.blob.models.RehydratePriority +module: azure.storage.blob.models +summary: Indicates the priority with which to rehydrate an archived blob +constructor: + syntax: RehydratePriority() +attributes: +- uid: azure.storage.blob.models.RehydratePriority.High + name: High + summary: The rehydrate priority is high. + signature: High = 'High' +- uid: azure.storage.blob.models.RehydratePriority.Standard + name: Standard + summary: The rehydrate priority is standard. + signature: Standard = 'Standard' diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.ResourceProperties.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.ResourceProperties.yml new file mode 100644 index 00000000..ef40b7ce --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.ResourceProperties.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.ResourceProperties +name: ResourceProperties +fullName: azure.storage.blob.models.ResourceProperties +module: azure.storage.blob.models +summary: Base response for a resource request. +constructor: + syntax: ResourceProperties() +variables: +- description: 'Opaque etag value that can be used to check if resource + + has been modified.' + name: etag + types: + - +- description: Datetime for last time resource was modified. + name: last_modified + types: + - +- description: 'The value is set to true if the contents of the request are successfully + + encrypted using the specified algorithm.' + name: server_encrypted + types: + - +- description: 'The server will echo the SHA256 of the customer-provided encryption + key + + to validate the key used in the operation.' + name: encryption_key_sha256 + types: + - +methods: +- uid: azure.storage.blob.models.ResourceProperties.clone + name: clone + signature: clone(src) + parameters: + - name: src + isRequired: true diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.SequenceNumberAction.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.SequenceNumberAction.yml new file mode 100644 index 00000000..2084d2a7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.SequenceNumberAction.yml @@ -0,0 +1,25 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.SequenceNumberAction +name: SequenceNumberAction +fullName: azure.storage.blob.models.SequenceNumberAction +module: azure.storage.blob.models +summary: Sequence number actions. +constructor: + syntax: SequenceNumberAction() +attributes: +- uid: azure.storage.blob.models.SequenceNumberAction.Increment + name: Increment + summary: 'Increments the value of the sequence number by 1. If specifying this option, + + do not include the x-ms-blob-sequence-number header.' + signature: Increment = 'increment' +- uid: azure.storage.blob.models.SequenceNumberAction.Max + name: Max + summary: 'Sets the sequence number to be the higher of the value included with the + + request and the value currently stored for the blob.' + signature: Max = 'max' +- uid: azure.storage.blob.models.SequenceNumberAction.Update + name: Update + summary: Sets the sequence number to the value included with the request. + signature: Update = 'update' diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.StandardBlobTier.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.StandardBlobTier.yml new file mode 100644 index 00000000..83c41eee --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.StandardBlobTier.yml @@ -0,0 +1,22 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.StandardBlobTier +name: StandardBlobTier +fullName: azure.storage.blob.models.StandardBlobTier +module: azure.storage.blob.models +summary: Specifies the blob tier to set the blob to. This is only applicable for block + blobs on standard storage accounts. +constructor: + syntax: StandardBlobTier() +attributes: +- uid: azure.storage.blob.models.StandardBlobTier.Archive + name: Archive + summary: Archive + signature: Archive = 'Archive' +- uid: azure.storage.blob.models.StandardBlobTier.Cool + name: Cool + summary: Cool + signature: Cool = 'Cool' +- uid: azure.storage.blob.models.StandardBlobTier.Hot + name: Hot + summary: Hot + signature: Hot = 'Hot' diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.UserDelegationKey.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.UserDelegationKey.yml new file mode 100644 index 00000000..0bb78051 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.UserDelegationKey.yml @@ -0,0 +1,45 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.models.UserDelegationKey +name: UserDelegationKey +fullName: azure.storage.blob.models.UserDelegationKey +module: azure.storage.blob.models +summary: 'Represents a user delegation key, provided to the user by Azure Storage + + based on their Azure Active Directory access token. + + + The fields are saved as simple strings since the user does not have to interact + with this object; + + to generate an identify SAS, the user can simply pass it to the right API.' +constructor: + syntax: UserDelegationKey() +variables: +- description: Object ID of this token. + name: signed_oid + types: + - +- description: Tenant ID of the tenant that issued this token. + name: signed_tid + types: + - +- description: The datetime this token becomes valid. + name: signed_start + types: + - +- description: The datetime this token expires. + name: signed_expiry + types: + - +- description: What service this key is valid for. + name: signed_service + types: + - +- description: The version identifier of the REST service that created this token. + name: signed_version + types: + - +- description: The user delegation key. + name: value + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.yml new file mode 100644 index 00000000..87540eaa --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.models.yml @@ -0,0 +1,36 @@ +### YamlMime:PythonModule +uid: azure.storage.blob.models +name: models +fullName: azure.storage.blob.models +classes: +- azure.storage.blob.models.AccountInformation +- azure.storage.blob.models.AppendBlockProperties +- azure.storage.blob.models.BatchDeleteSubRequest +- azure.storage.blob.models.BatchSetBlobTierSubRequest +- azure.storage.blob.models.BatchSubResponse +- azure.storage.blob.models.Blob +- azure.storage.blob.models.BlobBlock +- azure.storage.blob.models.BlobBlockList +- azure.storage.blob.models.BlobBlockState +- azure.storage.blob.models.BlobPermissions +- azure.storage.blob.models.BlobPrefix +- azure.storage.blob.models.BlobProperties +- azure.storage.blob.models.BlockListType +- azure.storage.blob.models.Container +- azure.storage.blob.models.ContainerPermissions +- azure.storage.blob.models.ContainerProperties +- azure.storage.blob.models.ContentSettings +- azure.storage.blob.models.CopyProperties +- azure.storage.blob.models.CustomerProvidedEncryptionKey +- azure.storage.blob.models.DeleteSnapshot +- azure.storage.blob.models.Include +- azure.storage.blob.models.LeaseProperties +- azure.storage.blob.models.PageBlobProperties +- azure.storage.blob.models.PageRange +- azure.storage.blob.models.PremiumPageBlobTier +- azure.storage.blob.models.PublicAccess +- azure.storage.blob.models.RehydratePriority +- azure.storage.blob.models.ResourceProperties +- azure.storage.blob.models.SequenceNumberAction +- azure.storage.blob.models.StandardBlobTier +- azure.storage.blob.models.UserDelegationKey diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.pageblobservice.PageBlobService.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.pageblobservice.PageBlobService.yml new file mode 100644 index 00000000..0edcf3e9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.pageblobservice.PageBlobService.yml @@ -0,0 +1,5576 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.pageblobservice.PageBlobService +name: PageBlobService +fullName: azure.storage.blob.pageblobservice.PageBlobService +module: azure.storage.blob.pageblobservice +summary: 'Page blobs are a collection of 512-byte pages optimized for random read + and + + write operations. To create a page blob, you initialize the page blob and + + specify the maximum size the page blob will grow. To add or update the + + contents of a page blob, you write a page or pages by specifying an offset + + and a range that align to 512-byte page boundaries. A write to a page blob + + can overwrite just one page, some pages, or up to 4 MB of the page blob. + + Writes to page blobs happen in-place and are immediately committed to the + + blob. The maximum size for a page blob is 8 TB. + + + :type *~azure.storage.common.TokenCredential*' +constructor: + syntax: PageBlobService(account_name=None, account_key=None, sas_token=None, is_emulated=False, + protocol='https', endpoint_suffix='core.windows.net', custom_domain=None, request_session=None, + connection_string=None, socket_timeout=None, token_credential=None) + parameters: + - name: account_name + description: 'The storage account name. This is used to authenticate requests + + signed with an account key and to construct the storage endpoint. It + + is required unless a connection string is given, or if a custom + + domain is used with anonymous authentication.' + defaultValue: None + types: + - + - name: account_key + description: 'The storage account key. This is used for shared key authentication. + + If neither account key or sas token is specified, anonymous access + + will be used.' + defaultValue: None + types: + - + - name: sas_token + description: 'A shared access signature token to use to authenticate requests + + instead of the account key. If account key and sas token are both + + specified, account key will be used to sign. If neither are + + specified, anonymous access will be used.' + defaultValue: None + types: + - + - name: is_emulated + description: 'Whether to use the emulator. Defaults to False. If specified, will + + override all other parameters besides connection string and request + + session.' + defaultValue: 'False' + types: + - + - name: protocol + description: The protocol to use for requests. Defaults to https. + defaultValue: https + types: + - + - name: endpoint_suffix + description: 'The host base component of the url, minus the account name. Defaults + + to Azure (core.windows.net). Override this to use the China cloud + + (core.chinacloudapi.cn).' + defaultValue: core.windows.net + types: + - + - name: custom_domain + description: 'The custom domain to use. This can be set in the Azure Portal. For + + example, ''www.mydomain.com''.' + defaultValue: None + types: + - + - name: request_session + description: The session object to use for http requests. + defaultValue: None + types: + - + - name: connection_string + description: 'If specified, this will override all other parameters besides + + request session. See + + [http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/](http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/) + + for the connection string format.' + defaultValue: None + types: + - + - name: socket_timeout + description: 'If specified, this will override the default socket timeout. The + timeout specified is in seconds. + + See DEFAULT_SOCKET_TIMEOUT in _constants.py for the default value.' + defaultValue: None + types: + - + - name: token_credential + description: 'A token credential used to authenticate HTTPS requests. The token + value + + should be updated before its expiration.' + defaultValue: None +variables: +- description: 'The size of the pages put by create_blob_from_* methods. Smaller pages + + may be put if there is less data provided. The maximum page size the service + + supports is 4MB. When using the create_blob_from_* methods, empty pages are skipped.' + name: MAX_PAGE_SIZE + types: + - +methods: +- uid: azure.storage.blob.pageblobservice.PageBlobService.abort_copy_blob + name: abort_copy_blob + summary: 'Aborts a pending copy_blob operation, and leaves a destination blob + + with zero length and full metadata.' + signature: abort_copy_blob(container_name, blob_name, copy_id, lease_id=None, timeout=None) + parameters: + - name: container_name + description: Name of destination container. + isRequired: true + types: + - + - name: blob_name + description: Name of destination blob. + isRequired: true + types: + - + - name: copy_id + description: 'Copy identifier provided in the copy.id of the original + + copy_blob operation.' + isRequired: true + types: + - + - name: lease_id + description: Required if the destination blob has an active infinite lease. + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.acquire_blob_lease + name: acquire_blob_lease + summary: 'Requests a new lease. If the blob does not have an active lease, the Blob + + service creates a lease on the blob and returns a new lease ID.' + signature: acquire_blob_lease(container_name, blob_name, lease_duration=-1, proposed_lease_id=None, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: lease_duration + description: 'Specifies the duration of the lease, in seconds, or negative one + + (-1) for a lease that never expires. A non-infinite lease can be + + between 15 and 60 seconds. A lease duration cannot be changed + + using renew or change. Default is -1 (infinite lease).' + defaultValue: '-1' + types: + - + - name: proposed_lease_id + description: 'Proposed lease ID, in a GUID string format. The Blob service + + returns 400 (Invalid request) if the proposed lease ID is not + + in the correct format.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: str +- uid: azure.storage.blob.pageblobservice.PageBlobService.acquire_container_lease + name: acquire_container_lease + summary: 'Requests a new lease. If the container does not have an active lease, + + the Blob service creates a lease on the container and returns a new + + lease ID.' + signature: acquire_container_lease(container_name, lease_duration=-1, proposed_lease_id=None, + if_modified_since=None, if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_duration + description: 'Specifies the duration of the lease, in seconds, or negative one + + (-1) for a lease that never expires. A non-infinite lease can be + + between 15 and 60 seconds. A lease duration cannot be changed + + using renew or change. Default is -1 (infinite lease).' + defaultValue: '-1' + types: + - + - name: proposed_lease_id + description: 'Proposed lease ID, in a GUID string format. The Blob service returns + + 400 (Invalid request) if the proposed lease ID is not in the correct format.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: str +- uid: azure.storage.blob.pageblobservice.PageBlobService.batch_delete_blobs + name: batch_delete_blobs + summary: 'Sends a batch of multiple blob delete requests. + + + The blob delete method deletes the specified blob or snapshot. Note that deleting + a blob also deletes all its + + snapshots. For more information, see [https://docs.microsoft.com/rest/api/storageservices/delete-blob](https://docs.microsoft.com/rest/api/storageservices/delete-blob)' + signature: batch_delete_blobs(batch_delete_sub_requests, timeout=None) + parameters: + - name: batch_delete_sub_requests + description: The blob delete requests to send as a batch. + isRequired: true + types: + - () + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: parsed batch delete HTTP response + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.break_blob_lease + name: break_blob_lease + summary: 'Breaks the lease, if the blob has an active lease. Once a lease is broken, + + it cannot be renewed. Any authorized request can break the lease; the request + + is not required to specify a matching lease ID. When a lease is broken, + + the lease break period is allowed to elapse, during which time no lease operation + + except break and release can be performed on the blob. When a lease is successfully + + broken, the response indicates the interval in seconds until a new lease can be + acquired. + + + A lease that has been broken can also be released, in which case another client + may + + immediately acquire the lease on the blob.' + signature: break_blob_lease(container_name, blob_name, lease_break_period=None, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: lease_break_period + description: 'For a break operation, this is the proposed duration of + + seconds that the lease should continue before it is broken, between + + 0 and 60 seconds. This break period is only used if it is shorter + + than the time remaining on the lease. If longer, the time remaining + + on the lease is used. A new lease will not be available before the + + break period has expired, but the lease may be held for longer than + + the break period. If this header does not appear with a break + + operation, a fixed-duration lease breaks after the remaining lease + + period elapses, and an infinite lease breaks immediately.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: int +- uid: azure.storage.blob.pageblobservice.PageBlobService.break_container_lease + name: break_container_lease + summary: 'Break the lease, if the container has an active lease. Once a lease is + + broken, it cannot be renewed. Any authorized request can break the lease; + + the request is not required to specify a matching lease ID. When a lease + + is broken, the lease break period is allowed to elapse, during which time + + no lease operation except break and release can be performed on the container. + + When a lease is successfully broken, the response indicates the interval + + in seconds until a new lease can be acquired.' + signature: break_container_lease(container_name, lease_break_period=None, if_modified_since=None, + if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_break_period + description: 'This is the proposed duration of seconds that the lease + + should continue before it is broken, between 0 and 60 seconds. This + + break period is only used if it is shorter than the time remaining + + on the lease. If longer, the time remaining on the lease is used. + + A new lease will not be available before the break period has + + expired, but the lease may be held for longer than the break + + period. If this header does not appear with a break + + operation, a fixed-duration lease breaks after the remaining lease + + period elapses, and an infinite lease breaks immediately.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: int +- uid: azure.storage.blob.pageblobservice.PageBlobService.change_blob_lease + name: change_blob_lease + summary: 'Changes the lease ID of an active lease. A change must include the current + + lease ID and a new lease ID.' + signature: change_blob_lease(container_name, blob_name, lease_id, proposed_lease_id, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: lease_id + description: Required if the blob has an active lease. + isRequired: true + types: + - + - name: proposed_lease_id + description: 'Proposed lease ID, in a GUID string format. The Blob service returns + + 400 (Invalid request) if the proposed lease ID is not in the correct format.' + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.change_container_lease + name: change_container_lease + summary: 'Change the lease ID of an active lease. A change must include the current + + lease ID and a new lease ID.' + signature: change_container_lease(container_name, lease_id, proposed_lease_id, if_modified_since=None, + if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: Lease ID for active lease. + isRequired: true + types: + - + - name: proposed_lease_id + description: 'Proposed lease ID, in a GUID string format. The Blob service returns + 400 + + (Invalid request) if the proposed lease ID is not in the correct format.' + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.clear_page + name: clear_page + summary: Clears a range of pages. + signature: clear_page(container_name, blob_name, start_range, end_range, lease_id=None, + if_sequence_number_lte=None, if_sequence_number_lt=None, if_sequence_number_eq=None, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: start_range + description: 'Start of byte range to use for writing to a section of the blob. + + Pages must be aligned with 512-byte boundaries, the start offset + + must be a modulus of 512 and the end offset must be a modulus of + + 512-1. Examples of valid byte ranges are 0-511, 512-1023, etc.' + isRequired: true + types: + - + - name: end_range + description: 'End of byte range to use for writing to a section of the blob. + + Pages must be aligned with 512-byte boundaries, the start offset + + must be a modulus of 512 and the end offset must be a modulus of + + 512-1. Examples of valid byte ranges are 0-511, 512-1023, etc.' + isRequired: true + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_sequence_number_lte + description: 'If the blob''s sequence number is less than or equal to + + the specified value, the request proceeds; otherwise it fails.' + defaultValue: None + types: + - + - name: if_sequence_number_lt + description: 'If the blob''s sequence number is less than the specified + + value, the request proceeds; otherwise it fails.' + defaultValue: None + types: + - + - name: if_sequence_number_eq + description: 'If the blob''s sequence number is equal to the specified + + value, the request proceeds; otherwise it fails.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify an ETag value + for this conditional + + header to write the page only if the blob''s ETag value matches the + + value specified. If the values do not match, the Blob service fails.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify an ETag value + for this conditional + + header to write the page only if the blob''s ETag value does not + + match the value specified. If the values are identical, the Blob + + service fails.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the updated Page Blob + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.copy_blob + name: copy_blob + summary: 'Copies a blob asynchronously. This operation returns a copy operation + + properties object, including a copy ID you can use to check or abort the + + copy operation. The Blob service copies blobs on a best-effort basis. + + + The source blob for a copy operation must be a page blob. If the destination + + blob already exists, it must be of the same blob type as the source blob. + + Any existing destination blob will be overwritten. + + The destination blob cannot be modified while a copy operation is in progress. + + + When copying from a page blob, the Blob service creates a destination page + + blob of the source blob''s length, initially containing all zeroes. Then + + the source page ranges are enumerated, and non-empty ranges are copied. + + + If the tier on the source blob is larger than the tier being passed to this + + copy operation or if the size of the blob exceeds the tier being passed to + + this copy operation then the operation will fail. + + + You can call get_blob_properties on the destination + + blob to check the status of the copy operation. The final blob will be + + committed when the copy completes.' + signature: copy_blob(container_name, blob_name, copy_source, metadata=None, source_if_modified_since=None, + source_if_unmodified_since=None, source_if_match=None, source_if_none_match=None, + destination_if_modified_since=None, destination_if_unmodified_since=None, destination_if_match=None, + destination_if_none_match=None, destination_lease_id=None, source_lease_id=None, + timeout=None, premium_page_blob_tier=None) + parameters: + - name: container_name + description: Name of the destination container. The container must exist. + isRequired: true + types: + - + - name: blob_name + description: 'Name of the destination blob. If the destination blob exists, it + will + + be overwritten. Otherwise, it will be created.' + isRequired: true + types: + - + - name: copy_source + description: 'A URL of up to 2 KB in length that specifies an Azure file or blob. + + The value should be URL-encoded as it would appear in a request URI. + + If the source is in another account, the source must either be public + + or must be authenticated via a shared access signature. If the source + + is public, no authentication is required. + + Examples: + + [https://myaccount.blob.core.windows.net/mycontainer/myblob](https://myaccount.blob.core.windows.net/mycontainer/myblob) + + [https://myaccount.blob.core.windows.net/mycontainer/myblob](https://myaccount.blob.core.windows.net/mycontainer/myblob)?snapshot= + + [https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken](https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken)' + isRequired: true + types: + - + - name: metadata + description: 'Name-value pairs associated with the blob as metadata. If no name-value + + pairs are specified, the operation will copy the metadata from the + + source blob or file to the destination blob. If one or more name-value + + pairs are specified, the destination blob is created with the specified + + metadata, and metadata is not copied from the source blob or file.' + defaultValue: None + types: + - (, ) + - name: source_if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this conditional header to copy the blob only if the source + + blob has been modified since the specified date/time.' + defaultValue: None + types: + - + - name: source_if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this conditional header to copy the blob only if the source blob + + has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: source_if_match + description: 'An ETag value, or the wildcard character (*). Specify this conditional + + header to copy the source blob only if its ETag matches the value + + specified. If the ETag values do not match, the Blob service returns + + status code 412 (Precondition Failed). This header cannot be specified + + if the source is an Azure File.' + defaultValue: None + types: + - + - name: source_if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this conditional + + header to copy the blob only if its ETag does not match the value + + specified. If the values are identical, the Blob service returns status + + code 412 (Precondition Failed). This header cannot be specified if the + + source is an Azure File.' + defaultValue: None + types: + - + - name: destination_if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this conditional header to copy the blob only + + if the destination blob has been modified since the specified date/time. + + If the destination blob has not been modified, the Blob service returns + + status code 412 (Precondition Failed).' + defaultValue: None + types: + - + - name: destination_if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this conditional header to copy the blob only + + if the destination blob has not been modified since the specified + + date/time. If the destination blob has been modified, the Blob service + + returns status code 412 (Precondition Failed).' + defaultValue: None + types: + - + - name: destination_if_match + description: 'An ETag value, or the wildcard character (*). Specify an ETag value + for + + this conditional header to copy the blob only if the specified ETag value + + matches the ETag value for an existing destination blob. If the ETag for + + the destination blob does not match the ETag specified for If-Match, the + + Blob service returns status code 412 (Precondition Failed).' + defaultValue: None + types: + - + - name: destination_if_none_match + description: 'An ETag value, or the wildcard character (*). Specify an ETag value + for + + this conditional header to copy the blob only if the specified ETag value + + does not match the ETag value for the destination blob. Specify the wildcard + + character (*) to perform the operation only if the destination blob does not + + exist. If the specified condition isn''t met, the Blob service returns status + + code 412 (Precondition Failed).' + defaultValue: None + types: + - + - name: destination_lease_id + description: 'The lease ID specified for this header must match the lease ID of + the + + destination blob. If the request does not include the lease ID or it is not + + valid, the operation fails with status code 412 (Precondition Failed).' + defaultValue: None + types: + - + - name: source_lease_id + description: 'Specify this to perform the Copy Blob operation only if + + the lease ID given matches the active lease ID of the source blob.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + - name: premium_page_blob_tier + description: 'A page blob tier value to set on the destination blob. The tier + correlates to + + the size of the blob and number of allowed IOPS. This is only applicable to + + page blobs on premium storage accounts. + + If the tier on the source blob is larger than the tier being passed to this + + copy operation or if the size of the blob exceeds the tier being passed to + + this copy operation then the operation will fail.' + defaultValue: None + types: + - + return: + description: Copy operation properties such as status, source, and ID. + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.create_blob + name: create_blob + summary: 'Creates a new Page Blob. + + + See create_blob_from_* for high level functions that handle the + + creation and upload of large blobs with automatic chunking and + + progress notifications.' + signature: create_blob(container_name, blob_name, content_length, content_settings=None, + sequence_number=None, metadata=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, + if_match=None, if_none_match=None, timeout=None, premium_page_blob_tier=None, + cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob to create or update. + isRequired: true + types: + - + - name: content_length + description: 'Required. This header specifies the maximum size + + for the page blob, up to 1 TB. The page blob size must be aligned + + to a 512-byte boundary.' + isRequired: true + types: + - + - name: content_settings + description: ContentSettings object used to set properties on the blob. + defaultValue: None + types: + - + - name: sequence_number + description: 'The sequence number is a user-controlled value that you can use + to + + track requests. The value of the sequence number must be between 0 + + and 2^63 - 1.The default value is 0.' + defaultValue: None + types: + - + - name: metadata + description: Name-value pairs associated with the blob as metadata. + defaultValue: None + types: + - (, ) + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + - name: premium_page_blob_tier + description: 'A page blob tier value to set the blob to. The tier correlates to + the size of the + + blob and number of allowed IOPS. This is only applicable to page blobs on + + premium storage accounts.' + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the new Page Blob + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.create_blob_from_bytes + name: create_blob_from_bytes + summary: 'Creates a new blob from an array of bytes, or updates the content + + of an existing blob, with automatic chunking and progress + + notifications. Empty chunks are skipped, while non-emtpy ones(even if only partly + filled) are uploaded.' + signature: create_blob_from_bytes(container_name, blob_name, blob, index=0, count=None, + content_settings=None, metadata=None, validate_content=False, progress_callback=None, + max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, + if_match=None, if_none_match=None, timeout=None, premium_page_blob_tier=None, + cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob to create or update. + isRequired: true + types: + - + - name: blob + description: Content of blob as an array of bytes. + isRequired: true + types: + - + - name: index + description: Start index in the byte array. + defaultValue: '0' + types: + - + - name: count + description: 'Number of bytes to upload. Set to None or negative value to upload + + all bytes starting from index.' + defaultValue: None + types: + - + - name: content_settings + description: ContentSettings object used to set blob properties. + defaultValue: None + types: + - + - name: metadata + description: Name-value pairs associated with the blob as metadata. + defaultValue: None + types: + - (, ) + - name: validate_content + description: 'If true, calculates an MD5 hash for each page of the blob. The storage + + service checks the hash of the content that has arrived with the hash + + that was sent. This is primarily valuable for detecting bitflips on + + the wire if using http instead of https as https (the default) will + + already validate. Note that this MD5 hash is not stored with the + + blob.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) where + + current is the number of bytes transfered so far, and total is the + + size of the blob, or None if the total size is unknown.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: Maximum number of parallel connections to use. + defaultValue: '2' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + - name: premium_page_blob_tier + description: 'A page blob tier value to set the blob to. The tier correlates to + the size of the + + blob and number of allowed IOPS. This is only applicable to page blobs on + + premium storage accounts.' + defaultValue: None + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the Page Blob + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.create_blob_from_path + name: create_blob_from_path + summary: 'Creates a new blob from a file path, or updates the content of an + + existing blob, with automatic chunking and progress notifications. + + Empty chunks are skipped, while non-emtpy ones(even if only partly filled) are + uploaded.' + signature: create_blob_from_path(container_name, blob_name, file_path, content_settings=None, + metadata=None, validate_content=False, progress_callback=None, max_connections=2, + lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, + if_none_match=None, timeout=None, premium_page_blob_tier=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob to create or update. + isRequired: true + types: + - + - name: file_path + description: Path of the file to upload as the blob content. + isRequired: true + types: + - + - name: content_settings + description: ContentSettings object used to set blob properties. + defaultValue: None + types: + - + - name: metadata + description: Name-value pairs associated with the blob as metadata. + defaultValue: None + types: + - (, ) + - name: validate_content + description: 'If true, calculates an MD5 hash for each page of the blob. The storage + + service checks the hash of the content that has arrived with the hash + + that was sent. This is primarily valuable for detecting bitflips on + + the wire if using http instead of https as https (the default) will + + already validate. Note that this MD5 hash is not stored with the + + blob.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) where + + current is the number of bytes transfered so far, and total is the + + size of the blob, or None if the total size is unknown.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: Maximum number of parallel connections to use. + defaultValue: '2' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + - name: premium_page_blob_tier + description: 'A page blob tier value to set the blob to. The tier correlates to + the size of the + + blob and number of allowed IOPS. This is only applicable to page blobs on + + premium storage accounts.' + defaultValue: None + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the Page Blob + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.create_blob_from_stream + name: create_blob_from_stream + summary: 'Creates a new blob from a file/stream, or updates the content of an + + existing blob, with automatic chunking and progress notifications. + + Empty chunks are skipped, while non-emtpy ones(even if only partly filled) are + uploaded.' + signature: create_blob_from_stream(container_name, blob_name, stream, count, content_settings=None, + metadata=None, validate_content=False, progress_callback=None, max_connections=2, + lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, + if_none_match=None, timeout=None, premium_page_blob_tier=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob to create or update. + isRequired: true + types: + - + - name: stream + description: Opened file/stream to upload as the blob content. + isRequired: true + types: + - + - name: count + description: 'Number of bytes to read from the stream. This is required, a page + + blob cannot be created if the count is unknown.' + isRequired: true + types: + - + - name: content_settings + description: ContentSettings object used to set the blob properties. + defaultValue: None + types: + - + - name: metadata + description: Name-value pairs associated with the blob as metadata. + defaultValue: None + types: + - (, ) + - name: validate_content + description: 'If true, calculates an MD5 hash for each page of the blob. The storage + + service checks the hash of the content that has arrived with the hash + + that was sent. This is primarily valuable for detecting bitflips on + + the wire if using http instead of https as https (the default) will + + already validate. Note that this MD5 hash is not stored with the + + blob.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) where + + current is the number of bytes transfered so far, and total is the + + size of the blob, or None if the total size is unknown.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'Maximum number of parallel connections to use. Note that parallel + upload + + requires the stream to be seekable.' + defaultValue: '2' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + - name: premium_page_blob_tier + description: 'A page blob tier value to set the blob to. The tier correlates to + the size of the + + blob and number of allowed IOPS. This is only applicable to page blobs on + + premium storage accounts.' + defaultValue: None + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the Page Blob + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.create_container + name: create_container + summary: 'Creates a new container under the specified account. If the container + + with the same name already exists, the operation fails if + + fail_on_exist is True.' + signature: create_container(container_name, metadata=None, public_access=None, fail_on_exist=False, + timeout=None) + parameters: + - name: container_name + description: 'Name of container to create. + + The container name may only contain lowercase letters, numbers, and hyphens, + and must begin with a letter or + + a number. Each hyphen must be preceded and followed by a non-hyphen character. + The name must also be + + between 3 and 63 characters long.' + isRequired: true + types: + - + - name: metadata + description: 'A dict with name_value pairs to associate with the + + container as metadata. Example:{''Category'':''test''}' + defaultValue: None + types: + - (, ) + - name: public_access + description: 'Possible values include: container, blob.' + defaultValue: None + types: + - + - name: fail_on_exist + description: Specify whether to throw an exception when the container exists. + defaultValue: 'False' + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: True if container is created, False if container already exists. + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.delete_blob + name: delete_blob + summary: 'Marks the specified blob or snapshot for deletion. + + The blob is later deleted during garbage collection. + + + Note that in order to delete a blob, you must delete all of its + + snapshots. You can delete both at the same time with the Delete + + Blob operation. + + + If a delete retention policy is enabled for the service, then this operation soft + deletes the blob or snapshot + + and retains the blob or snapshot for specified number of days. + + After specified number of days, blob''s data is removed from the service during + garbage collection. + + Soft deleted blob or snapshot is accessible through List Blobs API specifying + include=Include.Deleted option. + + Soft-deleted blob or snapshot can be restored using Undelete API.' + signature: delete_blob(container_name, blob_name, snapshot=None, lease_id=None, + delete_snapshots=None, if_modified_since=None, if_unmodified_since=None, if_match=None, + if_none_match=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to delete.' + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: delete_snapshots + description: Required if the blob has associated snapshots. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.delete_container + name: delete_container + summary: 'Marks the specified container for deletion. The container and any blobs + + contained within it are later deleted during garbage collection.' + signature: delete_container(container_name, fail_not_exist=False, lease_id=None, + if_modified_since=None, if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of container to delete. + isRequired: true + types: + - + - name: fail_not_exist + description: 'Specify whether to throw an exception when the container doesn''t + + exist.' + defaultValue: 'False' + types: + - + - name: lease_id + description: 'If specified, delete_container only succeeds if the + + container''s lease is active and matches this ID. + + Required if the container has an active lease.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: True if container is deleted, False container doesn't exist. + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.exists + name: exists + summary: 'Returns a boolean indicating whether the container exists (if blob_name + + is None), or otherwise a boolean indicating whether the blob exists.' + signature: exists(container_name, blob_name=None, snapshot=None, timeout=None) + parameters: + - name: container_name + description: Name of a container. + isRequired: true + types: + - + - name: blob_name + description: Name of a blob. If None, the container will be checked for existence. + defaultValue: None + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the snapshot.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: A boolean indicating whether the resource exists. + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.extract_date_and_request_id + name: extract_date_and_request_id + signature: static extract_date_and_request_id(retry_context) + parameters: + - name: retry_context + isRequired: true +- uid: azure.storage.blob.pageblobservice.PageBlobService.generate_account_shared_access_signature + name: generate_account_shared_access_signature + summary: 'Generates a shared access signature for the blob service. + + Use the returned signature with the sas_token parameter of any BlobService.' + signature: generate_account_shared_access_signature(resource_types, permission, + expiry, start=None, ip=None, protocol=None) + parameters: + - name: resource_types + description: Specifies the resource types that are accessible with the account + SAS. + isRequired: true + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy.' + isRequired: true + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + isRequired: true + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. The default + value + + is https,http. See for possible + values.' + defaultValue: None + types: + - + return: + description: A Shared Access Signature (sas) token. + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.generate_blob_shared_access_signature + name: generate_blob_shared_access_signature + summary: 'Generates a shared access signature for the blob or one of its snapshots. + + Use the returned signature with the sas_token parameter of any BlobService.' + signature: generate_blob_shared_access_signature(container_name, blob_name, snapshot=None, + permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, + content_disposition=None, content_encoding=None, content_language=None, content_type=None, + user_delegation_key=None) + parameters: + - name: container_name + description: Name of container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to grant permission.' + defaultValue: None + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Permissions must be ordered read, write, delete, list. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy.' + defaultValue: None + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + defaultValue: None + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: id + description: 'A unique value up to 64 characters in length that correlates to + a + + stored access policy. To create a stored access policy, use .' + defaultValue: None + types: + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. The default + value + + is https,http. See for possible + values.' + defaultValue: None + types: + - + - name: cache_control + description: 'Response header value for Cache-Control when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_disposition + description: 'Response header value for Content-Disposition when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_encoding + description: 'Response header value for Content-Encoding when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_language + description: 'Response header value for Content-Language when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_type + description: 'Response header value for Content-Type when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: user_delegation_key + description: 'Instead of an account key, the user could pass in a user delegation + key. + + A user delegation key can be obtained from the service by authenticating with + an AAD identity; + + this can be accomplished by calling get_user_delegation_key. + + When present, the SAS is signed with the user delegation key instead.' + defaultValue: None + types: + - + return: + description: A Shared Access Signature (sas) token. + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.generate_container_shared_access_signature + name: generate_container_shared_access_signature + summary: 'Generates a shared access signature for the container. + + Use the returned signature with the sas_token parameter of any BlobService.' + signature: generate_container_shared_access_signature(container_name, permission=None, + expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, + content_disposition=None, content_encoding=None, content_language=None, content_type=None, + user_delegation_key=None) + parameters: + - name: container_name + description: Name of container. + isRequired: true + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Permissions must be ordered read, write, delete, list. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy.' + defaultValue: None + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + defaultValue: None + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: id + description: 'A unique value up to 64 characters in length that correlates to + a + + stored access policy. To create a stored access policy, use + + set_blob_service_properties.' + defaultValue: None + types: + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. The default + value + + is https,http. See for possible + values.' + defaultValue: None + types: + - + - name: cache_control + description: 'Response header value for Cache-Control when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_disposition + description: 'Response header value for Content-Disposition when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_encoding + description: 'Response header value for Content-Encoding when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_language + description: 'Response header value for Content-Language when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_type + description: 'Response header value for Content-Type when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: user_delegation_key + description: 'Instead of an account key, the user could pass in a user delegation + key. + + A user delegation key can be obtained from the service by authenticating with + an AAD identity; + + this can be accomplished by calling get_user_delegation_key. + + When present, the SAS is signed with the user delegation key instead.' + defaultValue: None + types: + - + return: + description: A Shared Access Signature (sas) token. + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.get_blob_account_information + name: get_blob_account_information + summary: 'Gets information related to the storage account. + + The information can also be retrieved if the user has a SAS to a container or + blob.' + signature: get_blob_account_information(container_name=None, blob_name=None, timeout=None) + parameters: + - name: container_name + description: 'Name of existing container. + + Optional, unless using a SAS token to a specific container or blob, in which + case it''s required.' + defaultValue: None + types: + - + - name: blob_name + description: 'Name of existing blob. + + Optional, unless using a SAS token to a specific blob, in which case it''s required.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: The . +- uid: azure.storage.blob.pageblobservice.PageBlobService.get_blob_metadata + name: get_blob_metadata + summary: Returns all user-defined metadata for the specified blob or snapshot. + signature: get_blob_metadata(container_name, blob_name, snapshot=None, lease_id=None, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: A dictionary representing the blob metadata name, value pairs. + types: + - (, ) +- uid: azure.storage.blob.pageblobservice.PageBlobService.get_blob_properties + name: get_blob_properties + summary: 'Returns all user-defined metadata, standard HTTP properties, and + + system properties for the blob. It does not return the content of the blob. + + Returns + + with and a metadata dict.' + signature: get_blob_properties(container_name, blob_name, snapshot=None, lease_id=None, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: a blob object including properties and metadata. + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.get_blob_service_properties + name: get_blob_service_properties + summary: 'Gets the properties of a storage account''s Blob service, including + + Azure Storage Analytics.' + signature: get_blob_service_properties(timeout=None) + parameters: + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: 'The blob with + an attached + + target_version property.' +- uid: azure.storage.blob.pageblobservice.PageBlobService.get_blob_service_stats + name: get_blob_service_stats + summary: 'Retrieves statistics related to replication for the Blob service. It is + + only available when read-access geo-redundant replication is enabled for + + the storage account. + + + With geo-redundant replication, Azure Storage maintains your data durable + + in two locations. In both locations, Azure Storage constantly maintains + + multiple healthy replicas of your data. The location where you read, + + create, update, or delete data is the primary storage account location. + + The primary location exists in the region you choose at the time you + + create an account via the Azure Management Azure classic portal, for + + example, North Central US. The location to which your data is replicated + + is the secondary location. The secondary location is automatically + + determined based on the location of the primary; it is in a second data + + center that resides in the same region as the primary location. Read-only + + access is available from the secondary location, if read-access geo-redundant + + replication is enabled for your storage account.' + signature: get_blob_service_stats(timeout=None) + parameters: + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: The blob service stats. + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.get_blob_to_bytes + name: get_blob_to_bytes + summary: 'Downloads a blob as an array of bytes, with automatic chunking and + + progress notifications. Returns an instance of + with + + properties, metadata, and content.' + signature: get_blob_to_bytes(container_name, blob_name, snapshot=None, start_range=None, + end_range=None, validate_content=False, progress_callback=None, max_connections=2, + lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, + if_none_match=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: start_range + description: 'Start of byte range to use for downloading a section of the blob. + + If no end_range is given, all bytes after the start_range will be downloaded. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: end_range + description: 'End of byte range to use for downloading a section of the blob. + + If end_range is given, start_range must be provided. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: validate_content + description: 'If set to true, validates an MD5 hash for each retrieved portion + of + + the blob. This is primarily valuable for detecting bitflips on the wire + + if using http instead of https as https (the default) will already + + validate. Note that the service will only return transactional MD5s + + for chunks 4MB or less so the first get request will be of size + + self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If + + self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be + + thrown. As computing the MD5 takes processing time and more requests + + will need to be done due to the reduced chunk size there may be some + + increase in latency.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) + + where current is the number of bytes transfered so far, and total is + + the size of the blob if known.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'If set to 2 or greater, an initial get will be done for the first + + self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob, + + the method returns at this point. If it is not, it will download the + + remaining data parallel using the number of threads equal to + + max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. + + If set to 1, a single large get request will be done. This is not + + generally recommended but available if very few threads should be + + used, network requests are very expensive, or a non-seekable stream + + prevents parallel download. This may also be useful if many blobs are + + expected to be empty as an extra request is required for empty blobs + + if max_connections is greater than 1.' + defaultValue: '2' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + return: + description: 'A Blob with properties and metadata. If max_connections is greater + + than 1, the content_md5 (if set on the blob) will not be returned. If you + + require this value, either use get_blob_properties or set max_connections + + to 1.' + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.get_blob_to_path + name: get_blob_to_path + summary: 'Downloads a blob to a file path, with automatic chunking and progress + + notifications. Returns an instance of with + + properties and metadata.' + signature: get_blob_to_path(container_name, blob_name, file_path, open_mode='wb', + snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None, + max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, + if_match=None, if_none_match=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: file_path + description: Path of file to write out to. + isRequired: true + types: + - + - name: open_mode + description: 'Mode to use when opening the file. Note that specifying append only + + open_mode prevents parallel download. So, max_connections must be set + + to 1 if this open_mode is used.' + defaultValue: wb + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: start_range + description: 'Start of byte range to use for downloading a section of the blob. + + If no end_range is given, all bytes after the start_range will be downloaded. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: end_range + description: 'End of byte range to use for downloading a section of the blob. + + If end_range is given, start_range must be provided. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: validate_content + description: 'If set to true, validates an MD5 hash for each retrieved portion + of + + the blob. This is primarily valuable for detecting bitflips on the wire + + if using http instead of https as https (the default) will already + + validate. Note that the service will only return transactional MD5s + + for chunks 4MB or less so the first get request will be of size + + self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If + + self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be + + thrown. As computing the MD5 takes processing time and more requests + + will need to be done due to the reduced chunk size there may be some + + increase in latency.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) + + where current is the number of bytes transfered so far, and total is + + the size of the blob if known.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'If set to 2 or greater, an initial get will be done for the first + + self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob, + + the method returns at this point. If it is not, it will download the + + remaining data parallel using the number of threads equal to + + max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. + + If set to 1, a single large get request will be done. This is not + + generally recommended but available if very few threads should be + + used, network requests are very expensive, or a non-seekable stream + + prevents parallel download. This may also be useful if many blobs are + + expected to be empty as an extra request is required for empty blobs + + if max_connections is greater than 1.' + defaultValue: '2' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + return: + description: 'A Blob with properties and metadata. If max_connections is greater + + than 1, the content_md5 (if set on the blob) will not be returned. If you + + require this value, either use get_blob_properties or set max_connections + + to 1.' + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.get_blob_to_stream + name: get_blob_to_stream + summary: 'Downloads a blob to a stream, with automatic chunking and progress + + notifications. Returns an instance of with + + properties and metadata.' + signature: get_blob_to_stream(container_name, blob_name, stream, snapshot=None, + start_range=None, end_range=None, validate_content=False, progress_callback=None, + max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, + if_match=None, if_none_match=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: stream + description: Opened stream to write to. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: start_range + description: 'Start of byte range to use for downloading a section of the blob. + + If no end_range is given, all bytes after the start_range will be downloaded. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: end_range + description: 'End of byte range to use for downloading a section of the blob. + + If end_range is given, start_range must be provided. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: validate_content + description: 'If set to true, validates an MD5 hash for each retrieved portion + of + + the blob. This is primarily valuable for detecting bitflips on the wire + + if using http instead of https as https (the default) will already + + validate. Note that the service will only return transactional MD5s + + for chunks 4MB or less so the first get request will be of size + + self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If + + self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be + + thrown. As computing the MD5 takes processing time and more requests + + will need to be done due to the reduced chunk size there may be some + + increase in latency.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) + + where current is the number of bytes transfered so far, and total is + + the size of the blob if known.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'If set to 2 or greater, an initial get will be done for the first + + self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob, + + the method returns at this point. If it is not, it will download the + + remaining data parallel using the number of threads equal to + + max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. + + If set to 1, a single large get request will be done. This is not + + generally recommended but available if very few threads should be + + used, network requests are very expensive, or a non-seekable stream + + prevents parallel download. This may also be useful if many blobs are + + expected to be empty as an extra request is required for empty blobs + + if max_connections is greater than 1.' + defaultValue: '2' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + return: + description: 'A Blob with properties and metadata. If max_connections is greater + + than 1, the content_md5 (if set on the blob) will not be returned. If you + + require this value, either use get_blob_properties or set max_connections + + to 1.' + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.get_blob_to_text + name: get_blob_to_text + summary: 'Downloads a blob as unicode text, with automatic chunking and progress + + notifications. Returns an instance of with + + properties, metadata, and content.' + signature: get_blob_to_text(container_name, blob_name, encoding='utf-8', snapshot=None, + start_range=None, end_range=None, validate_content=False, progress_callback=None, + max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None, + if_match=None, if_none_match=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: encoding + description: Python encoding to use when decoding the blob data. + defaultValue: utf-8 + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to retrieve.' + defaultValue: None + types: + - + - name: start_range + description: 'Start of byte range to use for downloading a section of the blob. + + If no end_range is given, all bytes after the start_range will be downloaded. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: end_range + description: 'End of byte range to use for downloading a section of the blob. + + If end_range is given, start_range must be provided. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of blob.' + defaultValue: None + types: + - + - name: validate_content + description: 'If set to true, validates an MD5 hash for each retrieved portion + of + + the blob. This is primarily valuable for detecting bitflips on the wire + + if using http instead of https as https (the default) will already + + validate. Note that the service will only return transactional MD5s + + for chunks 4MB or less so the first get request will be of size + + self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If + + self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be + + thrown. As computing the MD5 takes processing time and more requests + + will need to be done due to the reduced chunk size there may be some + + increase in latency.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) + + where current is the number of bytes transfered so far, and total is + + the size of the blob if known.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'If set to 2 or greater, an initial get will be done for the first + + self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob, + + the method returns at this point. If it is not, it will download the + + remaining data parallel using the number of threads equal to + + max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. + + If set to 1, a single large get request will be done. This is not + + generally recommended but available if very few threads should be + + used, network requests are very expensive, or a non-seekable stream + + prevents parallel download. This may also be useful if many blobs are + + expected to be empty as an extra request is required for empty blobs + + if max_connections is greater than 1.' + defaultValue: '2' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Decrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + return: + description: 'A Blob with properties and metadata. If max_connections is greater + + than 1, the content_md5 (if set on the blob) will not be returned. If you + + require this value, either use get_blob_properties or set max_connections + + to 1.' + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.get_container_acl + name: get_container_acl + summary: 'Gets the permissions for the specified container. + + The permissions indicate whether container data may be accessed publicly.' + signature: get_container_acl(container_name, lease_id=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: 'If specified, get_container_acl only succeeds if the + + container''s lease is active and matches this ID.' + defaultValue: None + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: 'A dictionary of access policies associated with the container. dict + of str to + + and a public_access property + + if public access is turned on' +- uid: azure.storage.blob.pageblobservice.PageBlobService.get_container_metadata + name: get_container_metadata + summary: Returns all user-defined metadata for the specified container. + signature: get_container_metadata(container_name, lease_id=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: 'If specified, get_container_metadata only succeeds if the + + container''s lease is active and matches this ID.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: A dictionary representing the container metadata name, value pairs. + types: + - (, ) +- uid: azure.storage.blob.pageblobservice.PageBlobService.get_container_properties + name: get_container_properties + summary: 'Returns all user-defined metadata and system properties for the specified + + container. The data returned does not include the container''s list of blobs.' + signature: get_container_properties(container_name, lease_id=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: 'If specified, get_container_properties only succeeds if the + + container''s lease is active and matches this ID.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: properties for the specified container within a container object. + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.get_page_ranges + name: get_page_ranges + summary: 'Returns the list of valid page ranges for a Page Blob or snapshot + + of a page blob.' + signature: get_page_ranges(container_name, blob_name, snapshot=None, start_range=None, + end_range=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, + if_match=None, if_none_match=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to retrieve information + + from.' + defaultValue: None + types: + - + - name: start_range + description: 'Start of byte range to use for getting valid page ranges. + + If no end_range is given, all bytes after the start_range will be searched. + + Pages must be aligned with 512-byte boundaries, the start offset + + must be a modulus of 512 and the end offset must be a modulus of + + 512-1. Examples of valid byte ranges are 0-511, 512-, etc.' + defaultValue: None + types: + - + - name: end_range + description: 'End of byte range to use for getting valid page ranges. + + If end_range is given, start_range must be provided. + + This range will return valid page ranges for from the offset start up to + + offset end. + + Pages must be aligned with 512-byte boundaries, the start offset + + must be a modulus of 512 and the end offset must be a modulus of + + 512-1. Examples of valid byte ranges are 0-511, 512-, etc.' + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: A list of valid Page Ranges for the Page Blob. + types: + - () +- uid: azure.storage.blob.pageblobservice.PageBlobService.get_page_ranges_diff + name: get_page_ranges_diff + summary: 'The response will include only the pages that are different between either + a + + recent snapshot or the current blob and a previous snapshot, including pages + + that were cleared.' + signature: get_page_ranges_diff(container_name, blob_name, previous_snapshot, snapshot=None, + start_range=None, end_range=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, + if_match=None, if_none_match=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: previous_snapshot + description: 'The snapshot parameter is an opaque DateTime value that + + specifies a previous blob snapshot to be compared + + against a more recent snapshot or the current blob.' + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that + + specifies a more recent blob snapshot to be compared + + against a previous snapshot (previous_snapshot).' + defaultValue: None + types: + - + - name: start_range + description: 'Start of byte range to use for getting different page ranges. + + If no end_range is given, all bytes after the start_range will be searched. + + Pages must be aligned with 512-byte boundaries, the start offset + + must be a modulus of 512 and the end offset must be a modulus of + + 512-1. Examples of valid byte ranges are 0-511, 512-, etc.' + defaultValue: None + types: + - + - name: end_range + description: 'End of byte range to use for getting different page ranges. + + If end_range is given, start_range must be provided. + + This range will return valid page ranges for from the offset start up to + + offset end. + + Pages must be aligned with 512-byte boundaries, the start offset + + must be a modulus of 512 and the end offset must be a modulus of + + 512-1. Examples of valid byte ranges are 0-511, 512-, etc.' + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: A list of different Page Ranges for the Page Blob. + types: + - () +- uid: azure.storage.blob.pageblobservice.PageBlobService.get_user_delegation_key + name: get_user_delegation_key + summary: 'Obtain a user delegation key for the purpose of signing SAS tokens. + + A token credential must be present on the service object for this request to succeed.' + signature: get_user_delegation_key(key_start_time, key_expiry_time, timeout=None) + parameters: + - name: key_start_time + description: A DateTime value. Indicates when the key becomes valid. + isRequired: true + types: + - + - name: key_expiry_time + description: A DateTime value. Indicates when the key stops being valid. + isRequired: true + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: The user delegation key. + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.incremental_copy_blob + name: incremental_copy_blob + summary: 'Copies an incremental copy of a blob asynchronously. This operation returns + a copy operation + + properties object, including a copy ID you can use to check or abort the + + copy operation. The Blob service copies blobs on a best-effort basis. + + + The source blob for an incremental copy operation must be a page blob. + + Call get_blob_properties on the destination blob to check the status of the copy + operation. + + The final blob will be committed when the copy completes.' + signature: incremental_copy_blob(container_name, blob_name, copy_source, metadata=None, + destination_if_modified_since=None, destination_if_unmodified_since=None, destination_if_match=None, + destination_if_none_match=None, destination_lease_id=None, source_lease_id=None, + timeout=None) + parameters: + - name: container_name + description: Name of the destination container. The container must exist. + isRequired: true + types: + - + - name: blob_name + description: 'Name of the destination blob. If the destination blob exists, it + will + + be overwritten. Otherwise, it will be created.' + isRequired: true + types: + - + - name: copy_source + description: 'A URL of up to 2 KB in length that specifies an Azure page blob. + + The value should be URL-encoded as it would appear in a request URI. + + The copy source must be a snapshot and include a valid SAS token or be public. + + Example: + + [https://myaccount.blob.core.windows.net/mycontainer/myblob](https://myaccount.blob.core.windows.net/mycontainer/myblob)?snapshot=&sastoken' + isRequired: true + types: + - + - name: metadata + description: 'Name-value pairs associated with the blob as metadata. If no name-value + + pairs are specified, the operation will copy the metadata from the + + source blob or file to the destination blob. If one or more name-value + + pairs are specified, the destination blob is created with the specified + + metadata, and metadata is not copied from the source blob or file.' + defaultValue: None + types: + - (, ) + - name: destination_if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this conditional header to copy the blob only + + if the destination blob has been modified since the specified date/time. + + If the destination blob has not been modified, the Blob service returns + + status code 412 (Precondition Failed).' + defaultValue: None + types: + - + - name: destination_if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this conditional header to copy the blob only if the destination blob + + has not been modified since the specified ate/time. If the destination blob + + has been modified, the Blob service returns status code 412 (Precondition Failed).' + defaultValue: None + types: + - + - name: destination_if_match + description: 'An ETag value, or the wildcard character (*). Specify an ETag value + for + + this conditional header to copy the blob only if the specified ETag value + + matches the ETag value for an existing destination blob. If the ETag for + + the destination blob does not match the ETag specified for If-Match, the + + Blob service returns status code 412 (Precondition Failed).' + defaultValue: None + types: + - + - name: destination_if_none_match + description: 'An ETag value, or the wildcard character (*). Specify an ETag value + for + + this conditional header to copy the blob only if the specified ETag value + + does not match the ETag value for the destination blob. Specify the wildcard + + character (*) to perform the operation only if the destination blob does not + + exist. If the specified condition isn''t met, the Blob service returns status + + code 412 (Precondition Failed).' + defaultValue: None + types: + - + - name: destination_lease_id + description: 'The lease ID specified for this header must match the lease ID of + the + + destination blob. If the request does not include the lease ID or it is not + + valid, the operation fails with status code 412 (Precondition Failed).' + defaultValue: None + types: + - + - name: source_lease_id + description: 'Specify this to perform the Copy Blob operation only if + + the lease ID given matches the active lease ID of the source blob.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: Copy operation properties such as status, source, and ID. + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.list_blob_names + name: list_blob_names + summary: 'Returns a generator to list the blob names under the specified container. + + The generator will lazily follow the continuation tokens returned by + + the service and stop when all blobs have been returned or num_results is reached. + + + If num_results is specified and the account has more than that number of + + blobs, the generator will have a populated next_marker field once it + + finishes. This marker can be used to create a new generator if more + + results are desired.' + signature: list_blob_names(container_name, prefix=None, num_results=None, include=None, + delimiter=None, marker=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: prefix + description: 'Filters the results to return only blobs whose names + + begin with the specified prefix.' + defaultValue: None + types: + - + - name: num_results + description: 'Specifies the maximum number of blobs to return, + + including all elements. + If the request does not specify + + num_results or specifies a value greater than 5,000, the server will + + return up to 5,000 items. Setting num_results to a value less than + + or equal to zero results in error response code 400 (Bad Request).' + defaultValue: None + types: + - + - name: include + description: Specifies one or more additional datasets to include in the response. + defaultValue: None + types: + - + - name: delimiter + description: 'When the request includes this parameter, the operation + + returns a element in the + + result list that acts as a placeholder for all blobs whose names begin + + with the same substring up to the appearance of the delimiter character. + + The delimiter may be a single character or a string.' + defaultValue: None + types: + - + - name: marker + description: 'An opaque continuation token. This value can be retrieved from the + + next_marker field of a previous generator object if num_results was + + specified and that generator has finished enumerating results. If + + specified, this generator will begin returning results from the point + + where the previous generator stopped.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.list_blobs + name: list_blobs + summary: 'Returns a generator to list the blobs under the specified container. + + The generator will lazily follow the continuation tokens returned by + + the service and stop when all blobs have been returned or num_results is reached. + + + If num_results is specified and the account has more than that number of + + blobs, the generator will have a populated next_marker field once it + + finishes. This marker can be used to create a new generator if more + + results are desired.' + signature: list_blobs(container_name, prefix=None, num_results=None, include=None, + delimiter=None, marker=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: prefix + description: 'Filters the results to return only blobs whose names + + begin with the specified prefix.' + defaultValue: None + types: + - + - name: num_results + description: 'Specifies the maximum number of blobs to return, + + including all elements. + If the request does not specify + + num_results or specifies a value greater than 5,000, the server will + + return up to 5,000 items. Setting num_results to a value less than + + or equal to zero results in error response code 400 (Bad Request).' + defaultValue: None + types: + - + - name: include + description: Specifies one or more additional datasets to include in the response. + defaultValue: None + types: + - + - name: delimiter + description: 'When the request includes this parameter, the operation + + returns a element in the + + result list that acts as a placeholder for all blobs whose names begin + + with the same substring up to the appearance of the delimiter character. + + The delimiter may be a single character or a string.' + defaultValue: None + types: + - + - name: marker + description: 'An opaque continuation token. This value can be retrieved from the + + next_marker field of a previous generator object if num_results was + + specified and that generator has finished enumerating results. If + + specified, this generator will begin returning results from the point + + where the previous generator stopped.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.list_containers + name: list_containers + summary: 'Returns a generator to list the containers under the specified account. + + The generator will lazily follow the continuation tokens returned by + + the service and stop when all containers have been returned or num_results is + reached. + + + If num_results is specified and the account has more than that number of + + containers, the generator will have a populated next_marker field once it + + finishes. This marker can be used to create a new generator if more + + results are desired.' + signature: list_containers(prefix=None, num_results=None, include_metadata=False, + marker=None, timeout=None) + parameters: + - name: prefix + description: 'Filters the results to return only containers whose names + + begin with the specified prefix.' + defaultValue: None + types: + - + - name: num_results + description: 'Specifies the maximum number of containers to return. A single list + + request may return up to 1000 contianers and potentially a continuation + + token which should be followed to get additional resutls.' + defaultValue: None + types: + - + - name: include_metadata + description: Specifies that container metadata be returned in the response. + defaultValue: 'False' + types: + - + - name: marker + description: 'An opaque continuation token. This value can be retrieved from the + + next_marker field of a previous generator object if num_results was + + specified and that generator has finished enumerating results. If + + specified, this generator will begin returning results from the point + + where the previous generator stopped.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.make_blob_url + name: make_blob_url + summary: Creates the url to access a blob. + signature: make_blob_url(container_name, blob_name, protocol=None, sas_token=None, + snapshot=None) + parameters: + - name: container_name + description: Name of container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob. + isRequired: true + types: + - + - name: protocol + description: 'Protocol to use: ''http'' or ''https''. If not specified, uses the + + protocol specified when BaseBlobService was initialized.' + defaultValue: None + types: + - + - name: sas_token + description: 'Shared access signature token created with + + generate_shared_access_signature.' + defaultValue: None + types: + - + - name: snapshot + description: 'An string value that uniquely identifies the snapshot. The value + of + + this query parameter indicates the snapshot version.' + defaultValue: None + types: + - + return: + description: blob access URL. + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.make_container_url + name: make_container_url + summary: Creates the url to access a container. + signature: make_container_url(container_name, protocol=None, sas_token=None) + parameters: + - name: container_name + description: Name of container. + isRequired: true + types: + - + - name: protocol + description: 'Protocol to use: ''http'' or ''https''. If not specified, uses the + + protocol specified when BaseBlobService was initialized.' + defaultValue: None + types: + - + - name: sas_token + description: 'Shared access signature token created with + + generate_shared_access_signature.' + defaultValue: None + types: + - + return: + description: container access URL. + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.release_blob_lease + name: release_blob_lease + summary: 'Releases the lease. The lease may be released if the lease ID specified + on the + + request matches that associated with the blob. Releasing the lease allows another + + client to immediately acquire the lease for the blob as soon as the release is + complete.' + signature: release_blob_lease(container_name, blob_name, lease_id, if_modified_since=None, + if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: lease_id + description: Lease ID for active lease. + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.release_container_lease + name: release_container_lease + summary: 'Release the lease. The lease may be released if the lease_id specified + matches + + that associated with the container. Releasing the lease allows another client + + to immediately acquire the lease for the container as soon as the release is complete.' + signature: release_container_lease(container_name, lease_id, if_modified_since=None, + if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: Lease ID for active lease. + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.renew_blob_lease + name: renew_blob_lease + summary: 'Renews the lease. The lease can be renewed if the lease ID specified on + + the request matches that associated with the blob. Note that the lease may + + be renewed even if it has expired as long as the blob has not been modified + + or leased again since the expiration of that lease. When you renew a lease, + + the lease duration clock resets.' + signature: renew_blob_lease(container_name, blob_name, lease_id, if_modified_since=None, + if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: lease_id + description: Lease ID for active lease. + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: str +- uid: azure.storage.blob.pageblobservice.PageBlobService.renew_container_lease + name: renew_container_lease + summary: 'Renews the lease. The lease can be renewed if the lease ID specified + + matches that associated with the container. Note that + + the lease may be renewed even if it has expired as long as the container + + has not been leased again since the expiration of that lease. When you + + renew a lease, the lease duration clock resets.' + signature: renew_container_lease(container_name, lease_id, if_modified_since=None, + if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: lease_id + description: Lease ID for active lease. + isRequired: true + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: str +- uid: azure.storage.blob.pageblobservice.PageBlobService.resize_blob + name: resize_blob + summary: 'Resizes a page blob to the specified size. If the specified value is less + + than the current size of the blob, then all pages above the specified value + + are cleared.' + signature: resize_blob(container_name, blob_name, content_length, lease_id=None, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: content_length + description: Size to resize blob to. + isRequired: true + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the updated Page Blob + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.set_blob_metadata + name: set_blob_metadata + summary: 'Sets user-defined metadata for the specified blob as one or more + + name-value pairs.' + signature: set_blob_metadata(container_name, blob_name, metadata=None, lease_id=None, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: metadata + description: 'Dict containing name and value pairs. Each call to this operation + + replaces all existing metadata attached to the blob. To remove all + + metadata from the blob, call this operation with no metadata headers.' + defaultValue: None + types: + - (, ) + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the updated Blob + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.set_blob_properties + name: set_blob_properties + summary: 'Sets system properties on the blob. If one property is set for the + + content_settings, all properties will be overriden.' + signature: set_blob_properties(container_name, blob_name, content_settings=None, + lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None, + if_none_match=None, timeout=None, cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: content_settings + description: ContentSettings object used to set blob properties. + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the updated Blob + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.set_blob_service_properties + name: set_blob_service_properties + summary: 'Sets the properties of a storage account''s Blob service, including + + Azure Storage Analytics. If an element (ex Logging) is left as None, the + + existing settings on the service for that functionality are preserved.' + signature: set_blob_service_properties(logging=None, hour_metrics=None, minute_metrics=None, + cors=None, target_version=None, timeout=None, delete_retention_policy=None, static_website=None) + parameters: + - name: logging + description: Groups the Azure Analytics Logging settings. + defaultValue: None + types: + - + - name: hour_metrics + description: 'The hour metrics settings provide a summary of request + + statistics grouped by API in hourly aggregates for blobs.' + defaultValue: None + types: + - + - name: minute_metrics + description: 'The minute metrics settings provide request statistics + + for each minute for blobs.' + defaultValue: None + types: + - + - name: cors + description: 'You can include up to five CorsRule elements in the + + list. If an empty list is specified, all CORS rules will be deleted, + + and CORS will be disabled for the service.' + defaultValue: None + types: + - list() + - name: target_version + description: 'Indicates the default version to use for requests if an incoming + + request''s version is not specified.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + - name: delete_retention_policy + description: 'The delete retention policy specifies whether to retain deleted + blobs. + + It also specifies the number of days and versions of blob to keep.' + defaultValue: None + types: + - + - name: static_website + description: 'Specifies whether the static website feature is enabled, + + and if yes, indicates the index document and 404 error document to use.' + defaultValue: None + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.set_container_acl + name: set_container_acl + summary: 'Sets the permissions for the specified container or stored access + + policies that may be used with Shared Access Signatures. The permissions + + indicate whether blobs in a container may be accessed publicly.' + signature: set_container_acl(container_name, signed_identifiers=None, public_access=None, + lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: signed_identifiers + description: 'A dictionary of access policies to associate with the container. + The + + dictionary may contain up to 5 elements. An empty dictionary + + will clear the access policies set on the service.' + defaultValue: None + types: + - dict(str, ) + - name: public_access + description: 'Possible values include: container, blob.' + defaultValue: None + types: + - + - name: lease_id + description: 'If specified, set_container_acl only succeeds if the + + container''s lease is active and matches this ID.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A datetime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A datetime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the updated Container + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.set_container_metadata + name: set_container_metadata + summary: 'Sets one or more user-defined name-value pairs for the specified + + container. Each call to this operation replaces all existing metadata + + attached to the container. To remove all metadata from the container, + + call this operation with no metadata dict.' + signature: set_container_metadata(container_name, metadata=None, lease_id=None, + if_modified_since=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: metadata + description: 'A dict containing name-value pairs to associate with the container + as + + metadata. Example: {''category'':''test''}' + defaultValue: None + types: + - (, ) + - name: lease_id + description: 'If specified, set_container_metadata only succeeds if the + + container''s lease is active and matches this ID.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the updated Container + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.set_premium_page_blob_tier + name: set_premium_page_blob_tier + summary: Sets the page blob tiers on the blob. This API is only supported for page + blobs on premium accounts. + signature: set_premium_page_blob_tier(container_name, blob_name, premium_page_blob_tier, + timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob to update. + isRequired: true + types: + - + - name: premium_page_blob_tier + description: 'A page blob tier value to set the blob to. The tier correlates to + the size of the + + blob and number of allowed IOPS. This is only applicable to page blobs on + + premium storage accounts.' + isRequired: true + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.set_proxy + name: set_proxy + summary: Sets the proxy server host and port for the HTTP CONNECT Tunnelling. + signature: set_proxy(host, port, user=None, password=None) + parameters: + - name: host + description: 'Address of the proxy. Ex: ''192.168.0.100''' + isRequired: true + types: + - + - name: port + description: 'Port of the proxy. Ex: 6000' + isRequired: true + types: + - + - name: user + description: User for proxy authorization. + defaultValue: None + types: + - + - name: password + description: Password for proxy authorization. + defaultValue: None + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.set_sequence_number + name: set_sequence_number + summary: Sets the blob sequence number. + signature: set_sequence_number(container_name, blob_name, sequence_number_action, + sequence_number=None, lease_id=None, if_modified_since=None, if_unmodified_since=None, + if_match=None, if_none_match=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: sequence_number_action + description: 'This property indicates how the service should modify the blob''s + sequence + + number. See for more information.' + isRequired: true + types: + - + - name: sequence_number + description: 'This property sets the blob''s sequence number. The sequence number + is a + + user-controlled property that you can use to track requests and manage + + concurrency issues.' + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the updated Page Blob + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.snapshot_blob + name: snapshot_blob + summary: Creates a read-only snapshot of a blob. + signature: snapshot_blob(container_name, blob_name, metadata=None, if_modified_since=None, + if_unmodified_since=None, if_match=None, if_none_match=None, lease_id=None, timeout=None, + cpk=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: metadata + description: 'Specifies a user-defined name-value pair associated with the blob. + + If no name-value pairs are specified, the operation will copy the + + base blob metadata to the snapshot. If one or more name-value pairs + + are specified, the snapshot is created with the specified metadata, + + and metadata is not copied from the base blob.' + defaultValue: None + types: + - (, ) + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: snapshot properties + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.undelete_blob + name: undelete_blob + summary: 'The undelete Blob operation restores the contents and metadata of soft + deleted blob or snapshot. + + Attempting to undelete a blob or snapshot that is not soft deleted will succeed + without any changes.' + signature: undelete_blob(container_name, blob_name, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.update_page + name: update_page + summary: Updates a range of pages. + signature: update_page(container_name, blob_name, page, start_range, end_range, + validate_content=False, lease_id=None, if_sequence_number_lte=None, if_sequence_number_lt=None, + if_sequence_number_eq=None, if_modified_since=None, if_unmodified_since=None, + if_match=None, if_none_match=None, cpk=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of existing blob. + isRequired: true + types: + - + - name: page + description: Content of the page. + isRequired: true + types: + - + - name: start_range + description: 'Start of byte range to use for writing to a section of the blob. + + Pages must be aligned with 512-byte boundaries, the start offset + + must be a modulus of 512 and the end offset must be a modulus of + + 512-1. Examples of valid byte ranges are 0-511, 512-1023, etc.' + isRequired: true + types: + - + - name: end_range + description: 'End of byte range to use for writing to a section of the blob. + + Pages must be aligned with 512-byte boundaries, the start offset + + must be a modulus of 512 and the end offset must be a modulus of + + 512-1. Examples of valid byte ranges are 0-511, 512-1023, etc.' + isRequired: true + types: + - + - name: validate_content + description: 'If true, calculates an MD5 hash of the page content. The storage + + service checks the hash of the content that has arrived + + with the hash that was sent. This is primarily valuable for detecting + + bitflips on the wire if using http instead of https as https (the default) + + will already validate. Note that this MD5 hash is not stored with the + + blob.' + defaultValue: 'False' + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_sequence_number_lte + description: 'If the blob''s sequence number is less than or equal to + + the specified value, the request proceeds; otherwise it fails.' + defaultValue: None + types: + - + - name: if_sequence_number_lt + description: 'If the blob''s sequence number is less than the specified + + value, the request proceeds; otherwise it fails.' + defaultValue: None + types: + - + - name: if_sequence_number_eq + description: 'If the blob''s sequence number is equal to the specified + + value, the request proceeds; otherwise it fails.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify an ETag value + for this conditional + + header to write the page only if the blob''s ETag value matches the + + value specified. If the values do not match, the Blob service fails.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify an ETag value + for this conditional + + header to write the page only if the blob''s ETag value does not + + match the value specified. If the values are identical, the Blob + + service fails.' + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: ETag and last modified properties for the updated Page Blob + types: + - +- uid: azure.storage.blob.pageblobservice.PageBlobService.update_page_from_url + name: update_page_from_url + summary: Updates a range of pages to a page blob where the contents are read from + a URL. + signature: update_page_from_url(container_name, blob_name, start_range, end_range, + copy_source_url, source_range_start, source_content_md5=None, source_if_modified_since=None, + source_if_unmodified_since=None, source_if_match=None, source_if_none_match=None, + lease_id=None, if_sequence_number_lte=None, if_sequence_number_lt=None, if_sequence_number_eq=None, + if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None, + cpk=None, timeout=None) + parameters: + - name: container_name + description: Name of existing container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob. + isRequired: true + types: + - + - name: start_range + description: 'Start of byte range to use for writing to a section of the blob. + + Pages must be aligned with 512-byte boundaries, the start offset + + must be a modulus of 512 and the end offset must be a modulus of + + 512-1. Examples of valid byte ranges are 0-511, 512-1023, etc.' + isRequired: true + types: + - + - name: end_range + description: 'End of byte range to use for writing to a section of the blob. + + Pages must be aligned with 512-byte boundaries, the start offset + + must be a modulus of 512 and the end offset must be a modulus of + + 512-1. Examples of valid byte ranges are 0-511, 512-1023, etc.' + isRequired: true + types: + - + - name: copy_source_url + description: 'The URL of the source data. It can point to any Azure Blob or File, + that is either public or has a + + shared access signature attached.' + isRequired: true + types: + - + - name: source_range_start + description: 'This indicates the start of the range of bytes(inclusive) that has + to be taken from the copy source. + + The service will read the same number of bytes as the destination range (end_range-start_range).' + isRequired: true + types: + - + - name: source_content_md5 + description: If given, the service will calculate the MD5 hash of the block content + and compare against this value. + defaultValue: None + types: + - + - name: source_if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the source resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: source_if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the source resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: source_if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the source resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: source_if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the source resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the source resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: lease_id + description: Required if the blob has an active lease. + defaultValue: None + types: + - + - name: if_sequence_number_lte + description: 'If the blob''s sequence number is less than or equal to + + the specified value, the request proceeds; otherwise it fails.' + defaultValue: None + types: + - + - name: if_sequence_number_lt + description: 'If the blob''s sequence number is less than the specified + + value, the request proceeds; otherwise it fails.' + defaultValue: None + types: + - + - name: if_sequence_number_eq + description: 'If the blob''s sequence number is equal to the specified + + value, the request proceeds; otherwise it fails.' + defaultValue: None + types: + - + - name: if_modified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only + + if the resource has been modified since the specified time.' + defaultValue: None + types: + - + - name: if_unmodified_since + description: 'A DateTime value. Azure expects the date value passed in to be UTC. + + If timezone is included, any non-UTC datetimes will be converted to UTC. + + If a date is passed in without timezone info, it is assumed to be UTC. + + Specify this header to perform the operation only if + + the resource has not been modified since the specified date/time.' + defaultValue: None + types: + - + - name: if_match + description: 'An ETag value, or the wildcard character (*). Specify this header + to perform + + the operation only if the resource''s ETag matches the value specified.' + defaultValue: None + types: + - + - name: if_none_match + description: 'An ETag value, or the wildcard character (*). Specify this header + + to perform the operation only if the resource''s ETag does not match + + the value specified. Specify the wildcard character (*) to perform + + the operation only if the resource does not exist, and fail the + + operation if it does exist.' + defaultValue: None + types: + - + - name: cpk + description: 'Encrypts the data on the service-side with the given key. + + Use of customer-provided keys must be done over HTTPS. + + As the encryption key itself is provided in the request, + + a secure connection must be established to transfer the key.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +attributes: +- uid: azure.storage.blob.pageblobservice.PageBlobService.protocol + name: protocol +- uid: azure.storage.blob.pageblobservice.PageBlobService.request_session + name: request_session +- uid: azure.storage.blob.pageblobservice.PageBlobService.socket_timeout + name: socket_timeout +- uid: azure.storage.blob.pageblobservice.PageBlobService.MAX_CHUNK_GET_SIZE + name: MAX_CHUNK_GET_SIZE + signature: MAX_CHUNK_GET_SIZE = 4194304 +- uid: azure.storage.blob.pageblobservice.PageBlobService.MAX_PAGE_SIZE + name: MAX_PAGE_SIZE + signature: MAX_PAGE_SIZE = 4194304 +- uid: azure.storage.blob.pageblobservice.PageBlobService.MAX_SINGLE_GET_SIZE + name: MAX_SINGLE_GET_SIZE + signature: MAX_SINGLE_GET_SIZE = 33554432 diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.pageblobservice.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.pageblobservice.yml new file mode 100644 index 00000000..daeeb2d7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.pageblobservice.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.storage.blob.pageblobservice +name: pageblobservice +fullName: azure.storage.blob.pageblobservice +classes: +- azure.storage.blob.pageblobservice.PageBlobService diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.sharedaccesssignature.BlobSharedAccessSignature.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.sharedaccesssignature.BlobSharedAccessSignature.yml new file mode 100644 index 00000000..2b0063f0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.sharedaccesssignature.BlobSharedAccessSignature.yml @@ -0,0 +1,398 @@ +### YamlMime:PythonClass +uid: azure.storage.blob.sharedaccesssignature.BlobSharedAccessSignature +name: BlobSharedAccessSignature +fullName: azure.storage.blob.sharedaccesssignature.BlobSharedAccessSignature +module: azure.storage.blob.sharedaccesssignature +summary: 'Provides a factory for creating blob and container access + + signature tokens with a common account name and account key. Users can either + + use the factory or can construct the appropriate service and use the + + generate_*_shared_access_signature method directly.' +constructor: + syntax: BlobSharedAccessSignature(account_name, account_key=None, user_delegation_key=None) + parameters: + - name: account_name + description: The storage account name used to generate the shared access signatures. + isRequired: true + types: + - + - name: account_key + description: The access key to generate the shares access signatures. + defaultValue: None + types: + - + - name: user_delegation_key + description: 'Instead of an account key, the user could pass in a user delegation + key. + + A user delegation key can be obtained from the service by authenticating with + an AAD identity; + + this can be accomplished by calling get_user_delegation_key on any Blob service + object.' + defaultValue: None + types: + - +methods: +- uid: azure.storage.blob.sharedaccesssignature.BlobSharedAccessSignature.generate_account + name: generate_account + summary: 'Generates a shared access signature for the account. + + Use the returned signature with the sas_token parameter of the service + + or to create a new account object.' + signature: generate_account(services, resource_types, permission, expiry, start=None, + ip=None, protocol=None) + parameters: + - name: services + description: 'Specifies the services accessible with the account SAS. You can + + combine values to provide access to more than one service.' + isRequired: true + types: + - + - name: resource_types + description: 'Specifies the resource types that are accessible with the account + + SAS. You can combine values to provide access to more than one + + resource type.' + isRequired: true + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy. You can combine + + values to provide more than one permission.' + isRequired: true + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + isRequired: true + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. The default + value + + is https,http. See for possible + values.' + defaultValue: None + types: + - +- uid: azure.storage.blob.sharedaccesssignature.BlobSharedAccessSignature.generate_blob + name: generate_blob + summary: 'Generates a shared access signature for the blob or one of its snapshots. + + Use the returned signature with the sas_token parameter of any BlobService.' + signature: generate_blob(container_name, blob_name, snapshot=None, permission=None, + expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, + content_disposition=None, content_encoding=None, content_language=None, content_type=None) + parameters: + - name: container_name + description: Name of container. + isRequired: true + types: + - + - name: blob_name + description: Name of blob. + isRequired: true + types: + - + - name: snapshot + description: 'The snapshot parameter is an opaque DateTime value that, + + when present, specifies the blob snapshot to grant permission.' + defaultValue: None + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Permissions must be ordered read, write, delete, list. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy.' + defaultValue: None + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + defaultValue: None + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: id + description: 'A unique value up to 64 characters in length that correlates to + a + + stored access policy. To create a stored access policy, use + + set_blob_service_properties.' + defaultValue: None + types: + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. The default + value + + is https,http. See for possible + values.' + defaultValue: None + types: + - + - name: cache_control + description: 'Response header value for Cache-Control when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_disposition + description: 'Response header value for Content-Disposition when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_encoding + description: 'Response header value for Content-Encoding when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_language + description: 'Response header value for Content-Language when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_type + description: 'Response header value for Content-Type when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - +- uid: azure.storage.blob.sharedaccesssignature.BlobSharedAccessSignature.generate_container + name: generate_container + summary: 'Generates a shared access signature for the container. + + Use the returned signature with the sas_token parameter of any BlobService.' + signature: generate_container(container_name, permission=None, expiry=None, start=None, + id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, + content_encoding=None, content_language=None, content_type=None) + parameters: + - name: container_name + description: Name of container. + isRequired: true + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Permissions must be ordered read, write, delete, list. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy.' + defaultValue: None + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + defaultValue: None + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: id + description: 'A unique value up to 64 characters in length that correlates to + a + + stored access policy. To create a stored access policy, use + + set_blob_service_properties.' + defaultValue: None + types: + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. The default + value + + is https,http. See for possible + values.' + defaultValue: None + types: + - + - name: cache_control + description: 'Response header value for Cache-Control when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_disposition + description: 'Response header value for Content-Disposition when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_encoding + description: 'Response header value for Content-Encoding when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_language + description: 'Response header value for Content-Language when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_type + description: 'Response header value for Content-Type when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.sharedaccesssignature.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.sharedaccesssignature.yml new file mode 100644 index 00000000..f5c3cd11 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.sharedaccesssignature.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.storage.blob.sharedaccesssignature +name: sharedaccesssignature +fullName: azure.storage.blob.sharedaccesssignature +classes: +- azure.storage.blob.sharedaccesssignature.BlobSharedAccessSignature diff --git a/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.yml b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.yml new file mode 100644 index 00000000..0c99574a --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-blob/azure.storage.blob.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonPackage +uid: azure.storage.blob +name: blob +fullName: azure.storage.blob +type: rootImport +modules: +- azure.storage.blob.appendblobservice +- azure.storage.blob.baseblobservice +- azure.storage.blob.blockblobservice +- azure.storage.blob.models +- azure.storage.blob.pageblobservice +- azure.storage.blob.sharedaccesssignature diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.cloudstorageaccount.CloudStorageAccount.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.cloudstorageaccount.CloudStorageAccount.yml new file mode 100644 index 00000000..be6ea409 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.cloudstorageaccount.CloudStorageAccount.yml @@ -0,0 +1,197 @@ +### YamlMime:PythonClass +uid: azure.storage.common.cloudstorageaccount.CloudStorageAccount +name: CloudStorageAccount +fullName: azure.storage.common.cloudstorageaccount.CloudStorageAccount +module: azure.storage.common.cloudstorageaccount +summary: 'Provides a factory for creating the blob, queue, and file services + + with a common account name and account key or sas token. Users can either + + use the factory or can construct the appropriate service directly.' +constructor: + syntax: CloudStorageAccount(account_name=None, account_key=None, sas_token=None, + is_emulated=None, endpoint_suffix=None) + parameters: + - name: account_name + description: 'The storage account name. This is used to authenticate requests + + signed with an account key and to construct the storage endpoint. It + + is required unless is_emulated is used.' + defaultValue: None + types: + - + - name: account_key + description: The storage account key. This is used for shared key authentication. + defaultValue: None + types: + - + - name: sas_token + description: 'A shared access signature token to use to authenticate requests + + instead of the account key. If account key and sas token are both + + specified, account key will be used to sign.' + defaultValue: None + types: + - + - name: is_emulated + description: 'Whether to use the emulator. Defaults to False. If specified, will + + override all other parameters.' + defaultValue: None + types: + - + - name: endpoint_suffix + description: 'The host base component of the url, minus the account name. Defaults + + to Azure (core.windows.net). Override this to use a sovereign cloud.' + defaultValue: None + types: + - +methods: +- uid: azure.storage.common.cloudstorageaccount.CloudStorageAccount.create_append_blob_service + name: create_append_blob_service + summary: 'Creates a AppendBlobService object with the settings specified in the + + CloudStorageAccount.' + signature: create_append_blob_service() + return: + description: A service object. + types: + - +- uid: azure.storage.common.cloudstorageaccount.CloudStorageAccount.create_block_blob_service + name: create_block_blob_service + summary: 'Creates a BlockBlobService object with the settings specified in the + + CloudStorageAccount.' + signature: create_block_blob_service() + return: + description: A service object. + types: + - +- uid: azure.storage.common.cloudstorageaccount.CloudStorageAccount.create_file_service + name: create_file_service + summary: 'Creates a FileService object with the settings specified in the + + CloudStorageAccount.' + signature: create_file_service() + return: + description: A service object. + types: + - +- uid: azure.storage.common.cloudstorageaccount.CloudStorageAccount.create_page_blob_service + name: create_page_blob_service + summary: 'Creates a PageBlobService object with the settings specified in the + + CloudStorageAccount.' + signature: create_page_blob_service() + return: + description: A service object. + types: + - +- uid: azure.storage.common.cloudstorageaccount.CloudStorageAccount.create_queue_service + name: create_queue_service + summary: 'Creates a QueueService object with the settings specified in the + + CloudStorageAccount.' + signature: create_queue_service() + return: + description: A service object. + types: + - +- uid: azure.storage.common.cloudstorageaccount.CloudStorageAccount.generate_shared_access_signature + name: generate_shared_access_signature + summary: 'Generates a shared access signature for the account. + + Use the returned signature with the sas_token parameter of the service + + or to create a new account object.' + signature: generate_shared_access_signature(services, resource_types, permission, + expiry, start=None, ip=None, protocol=None) + parameters: + - name: services + description: 'Specifies the services accessible with the account SAS. You can + + combine values to provide access to more than one service.' + isRequired: true + types: + - + - name: resource_types + description: 'Specifies the resource types that are accessible with the account + + SAS. You can combine values to provide access to more than one + + resource type.' + isRequired: true + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy. You can combine + + values to provide more than one permission.' + isRequired: true + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + isRequired: true + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. Possible values + are + + both HTTPS and HTTP (https,http) or HTTPS only (https). The default value + + is https,http. Note that HTTP only is not a permitted value.' + defaultValue: None + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.cloudstorageaccount.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.cloudstorageaccount.yml new file mode 100644 index 00000000..9dec7f4d --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.cloudstorageaccount.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.storage.common.cloudstorageaccount +name: cloudstorageaccount +fullName: azure.storage.common.cloudstorageaccount +classes: +- azure.storage.common.cloudstorageaccount.CloudStorageAccount diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.AccessPolicy.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.AccessPolicy.yml new file mode 100644 index 00000000..2648bfe2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.AccessPolicy.yml @@ -0,0 +1,84 @@ +### YamlMime:PythonClass +uid: azure.storage.common.models.AccessPolicy +name: AccessPolicy +fullName: azure.storage.common.models.AccessPolicy +module: azure.storage.common.models +summary: 'Access Policy class used by the set and get acl methods in each service. + + + A stored access policy can specify the start time, expiry time, and + + permissions for the Shared Access Signatures with which it''s associated. + + Depending on how you want to control access to your resource, you can + + specify all of these parameters within the stored access policy, and omit + + them from the URL for the Shared Access Signature. Doing so permits you to + + modify the associated signature''s behavior at any time, as well as to revoke + + it. Or you can specify one or more of the access policy parameters within + + the stored access policy, and the others on the URL. Finally, you can + + specify all of the parameters on the URL. In this case, you can use the + + stored access policy to revoke the signature, but not to modify its behavior. + + + Together the Shared Access Signature and the stored access policy must + + include all fields required to authenticate the signature. If any required + + fields are missing, the request will fail. Likewise, if a field is specified + + both in the Shared Access Signature URL and in the stored access policy, the + + request will fail with status code 400 (Bad Request).' +constructor: + syntax: AccessPolicy(permission=None, expiry=None, start=None) + parameters: + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy.' + defaultValue: None + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + defaultValue: None + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.AccountPermissions.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.AccountPermissions.yml new file mode 100644 index 00000000..4fe39cd3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.AccountPermissions.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.storage.common.models.AccountPermissions +name: AccountPermissions +fullName: azure.storage.common.models.AccountPermissions +module: azure.storage.common.models +summary: ' class to be used with generate_shared_access_signature + + method and for the AccessPolicies used with set_*_acl. There are two types of + + SAS which may be used to grant resource access. One is to grant access to a + + specific resource (resource-specific). Another is to grant access to the + + entire service for a specific account and allow certain operations based on + + perms found here.' +constructor: + syntax: AccountPermissions(read=False, write=False, delete=False, list=False, add=False, + create=False, update=False, process=False, _str=None) + parameters: + - name: read + description: 'Valid for all signed resources types (Service, Container, and Object). + + Permits read permissions to the specified resource type.' + defaultValue: 'False' + types: + - + - name: write + description: 'Valid for all signed resources types (Service, Container, and Object). + + Permits write permissions to the specified resource type.' + defaultValue: 'False' + types: + - + - name: delete + description: Valid for Container and Object resource types, except for queue messages. + defaultValue: 'False' + types: + - + - name: list + description: Valid for Service and Container resource types only. + defaultValue: 'False' + types: + - + - name: add + description: 'Valid for the following Object resource types only: queue messages, + and append blobs.' + defaultValue: 'False' + types: + - + - name: create + description: 'Valid for the following Object resource types only: blobs and files. + + Users can create new blobs or files, but may not overwrite existing + + blobs or files.' + defaultValue: 'False' + types: + - + - name: update + description: 'Valid for the following Object resource types only: queue messages.' + defaultValue: 'False' + types: + - + - name: process + description: 'Valid for the following Object resource type only: queue messages.' + defaultValue: 'False' + types: + - + - name: _str + description: A string representing the permissions. + defaultValue: None + types: + - +variables: +- description: 'Valid for the following Object resource types only: queue messages + and append blobs.' + name: AccountPermissions.ADD + types: + - +- description: 'Valid for the following Object resource types only: blobs and files. + Users + + can create new blobs or files, but may not overwrite existing blobs or files.' + name: AccountPermissions.CREATE + types: + - +- description: Valid for Container and Object resource types, except for queue messages. + name: AccountPermissions.DELETE + types: + - +- description: Valid for Service and Container resource types only. + name: AccountPermissions.LIST + types: + - +- description: 'Valid for the following Object resource type only: queue messages.' + name: AccountPermissions.PROCESS + types: + - +- description: 'Valid for all signed resources types (Service, Container, and Object). + + Permits read permissions to the specified resource type.' + name: AccountPermissions.READ + types: + - +- description: 'Valid for the following Object resource types only: queue messages.' + name: AccountPermissions.UPDATE + types: + - +- description: 'Valid for all signed resources types (Service, Container, and Object). + + Permits write permissions to the specified resource type.' + name: AccountPermissions.WRITE + types: + - +attributes: +- uid: azure.storage.common.models.AccountPermissions.ADD + name: ADD + signature: ADD = +- uid: azure.storage.common.models.AccountPermissions.CREATE + name: CREATE + signature: CREATE = +- uid: azure.storage.common.models.AccountPermissions.DELETE + name: DELETE + signature: DELETE = +- uid: azure.storage.common.models.AccountPermissions.LIST + name: LIST + signature: LIST = +- uid: azure.storage.common.models.AccountPermissions.PROCESS + name: PROCESS + signature: PROCESS = +- uid: azure.storage.common.models.AccountPermissions.READ + name: READ + signature: READ = +- uid: azure.storage.common.models.AccountPermissions.UPDATE + name: UPDATE + signature: UPDATE = +- uid: azure.storage.common.models.AccountPermissions.WRITE + name: WRITE + signature: WRITE = diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.CorsRule.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.CorsRule.yml new file mode 100644 index 00000000..02bb813b --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.CorsRule.yml @@ -0,0 +1,68 @@ +### YamlMime:PythonClass +uid: azure.storage.common.models.CorsRule +name: CorsRule +fullName: azure.storage.common.models.CorsRule +module: azure.storage.common.models +summary: 'CORS is an HTTP feature that enables a web application running under one + domain + + to access resources in another domain. Web browsers implement a security + + restriction known as same-origin policy that prevents a web page from calling + + APIs in a different domain; CORS provides a secure way to allow one domain + + (the origin domain) to call APIs in another domain. + + + For more information, see [https://msdn.microsoft.com/en-us/library/azure/dn535601.aspx](https://msdn.microsoft.com/en-us/library/azure/dn535601.aspx)' +constructor: + syntax: CorsRule(allowed_origins, allowed_methods, max_age_in_seconds=0, exposed_headers=None, + allowed_headers=None) + parameters: + - name: allowed_origins + description: 'A list of origin domains that will be allowed via CORS, or "*" to + allow + + all domains. The list of must contain at least one entry. Limited to 64 + + origin domains. Each allowed origin can have up to 256 characters.' + isRequired: true + types: + - () + - name: allowed_methods + description: 'A list of HTTP methods that are allowed to be executed by the origin. + + The list of must contain at least one entry. For Azure Storage, + + permitted methods are DELETE, GET, HEAD, MERGE, POST, OPTIONS or PUT.' + isRequired: true + types: + - () + - name: max_age_in_seconds + description: 'The number of seconds that the client/browser should cache a + + preflight response.' + defaultValue: '0' + types: + - + - name: exposed_headers + description: 'Defaults to an empty list. A list of response headers to expose + to CORS + + clients. Limited to 64 defined headers and two prefixed headers. Each + + header can be up to 256 characters.' + defaultValue: None + types: + - () + - name: allowed_headers + description: 'Defaults to an empty list. A list of headers allowed to be part + of + + the cross-origin request. Limited to 64 defined headers and 2 prefixed + + headers. Each header can be up to 256 characters.' + defaultValue: None + types: + - () diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.DeleteRetentionPolicy.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.DeleteRetentionPolicy.yml new file mode 100644 index 00000000..fb89a681 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.DeleteRetentionPolicy.yml @@ -0,0 +1,28 @@ +### YamlMime:PythonClass +uid: azure.storage.common.models.DeleteRetentionPolicy +name: DeleteRetentionPolicy +fullName: azure.storage.common.models.DeleteRetentionPolicy +module: azure.storage.common.models +summary: 'To set DeleteRetentionPolicy, you must call Set Blob Service Properties + using version 2017-07-29 or later. + + This class groups the settings related to delete retention policy.' +constructor: + syntax: DeleteRetentionPolicy(enabled=False, days=None) + parameters: + - name: enabled + description: Required. Indicates whether a deleted blob or snapshot is retained + or immediately removed by delete operation. + defaultValue: 'False' + types: + - + - name: days + description: 'Required only if Enabled is true. Indicates the number of days that + deleted blob be retained. + + All data older than this value will be permanently deleted. + + The minimum value you can specify is 1; the largest value is 365.' + defaultValue: None + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.GeoReplication.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.GeoReplication.yml new file mode 100644 index 00000000..b1e11c17 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.GeoReplication.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.storage.common.models.GeoReplication +name: GeoReplication +fullName: azure.storage.common.models.GeoReplication +module: azure.storage.common.models +summary: Contains statistics related to replication for the given service. +constructor: + syntax: GeoReplication() +variables: +- description: "The status of the secondary location. Possible values are:\n live:\ + \ Indicates that the secondary location is active and operational.\n bootstrap:\ + \ Indicates initial synchronization from the primary location\n\n to the\ + \ secondary location is in progress. This typically occurs\n when replication\ + \ is first enabled.\n\n unavailable: Indicates that the secondary location is\ + \ temporarily\n unavailable." + name: status + types: + - +- description: 'A GMT date value, to the second. All primary writes preceding this + value + + are guaranteed to be available for read operations at the secondary. + + Primary writes after this point in time may or may not be available for + + reads. The value may be empty if LastSyncTime is not available. This can + + happen if the replication status is bootstrap or unavailable. Although + + geo-replication is continuously enabled, the LastSyncTime result may + + reflect a cached value from the service that is refreshed every few minutes.' + name: last_sync_time + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.ListGenerator.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.ListGenerator.yml new file mode 100644 index 00000000..08b32078 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.ListGenerator.yml @@ -0,0 +1,30 @@ +### YamlMime:PythonClass +uid: azure.storage.common.models.ListGenerator +name: ListGenerator +fullName: azure.storage.common.models.ListGenerator +module: azure.storage.common.models +summary: 'A generator object used to list storage resources. The generator will lazily + + follow the continuation tokens returned by the service and stop when all + + resources have been returned or max_results is reached. + + + If max_results is specified and the account has more than that number of + + resources, the generator will have a populated next_marker field once it + + finishes. This marker can be used to create a new generator if more + + results are desired.' +constructor: + syntax: ListGenerator(resources, list_method, list_args, list_kwargs) + parameters: + - name: resources + isRequired: true + - name: list_method + isRequired: true + - name: list_args + isRequired: true + - name: list_kwargs + isRequired: true diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.LocationMode.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.LocationMode.yml new file mode 100644 index 00000000..a76443ad --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.LocationMode.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonClass +uid: azure.storage.common.models.LocationMode +name: LocationMode +fullName: azure.storage.common.models.LocationMode +module: azure.storage.common.models +summary: 'Specifies the location the request should be sent to. This mode only applies + + for RA-GRS accounts which allow secondary read access. All other account types + + must use PRIMARY.' +constructor: + syntax: LocationMode() +attributes: +- uid: azure.storage.common.models.LocationMode.PRIMARY + name: PRIMARY + summary: Requests should be sent to the primary location. + signature: PRIMARY = 'primary' +- uid: azure.storage.common.models.LocationMode.SECONDARY + name: SECONDARY + summary: Requests should be sent to the secondary location, if possible. + signature: SECONDARY = 'secondary' diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.Logging.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.Logging.yml new file mode 100644 index 00000000..06748f14 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.Logging.yml @@ -0,0 +1,50 @@ +### YamlMime:PythonClass +uid: azure.storage.common.models.Logging +name: Logging +fullName: azure.storage.common.models.Logging +module: azure.storage.common.models +summary: 'Storage Analytics logs detailed information about successful and failed + requests + + to a storage service. This information can be used to monitor individual requests + + and to diagnose issues with a storage service. Requests are logged on a best-effort + + basis. + + + All logs are stored in block blobs in a container named $logs, which is + + automatically created when Storage Analytics is enabled for a storage account. + + The $logs container is located in the blob namespace of the storage account. + + This container cannot be deleted once Storage Analytics has been enabled, though + + its contents can be deleted. + + + For more information, see [https://msdn.microsoft.com/en-us/library/azure/hh343262.aspx](https://msdn.microsoft.com/en-us/library/azure/hh343262.aspx)' +constructor: + syntax: Logging(delete=False, read=False, write=False, retention_policy=None) + parameters: + - name: delete + description: Indicates whether all delete requests should be logged. + defaultValue: 'False' + types: + - + - name: read + description: Indicates whether all read requests should be logged. + defaultValue: 'False' + types: + - + - name: write + description: Indicates whether all write requests should be logged. + defaultValue: 'False' + types: + - + - name: retention_policy + description: The retention policy for the metrics. + defaultValue: None + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.Metrics.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.Metrics.yml new file mode 100644 index 00000000..43ed3fcd --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.Metrics.yml @@ -0,0 +1,42 @@ +### YamlMime:PythonClass +uid: azure.storage.common.models.Metrics +name: Metrics +fullName: azure.storage.common.models.Metrics +module: azure.storage.common.models +summary: 'Metrics include aggregated transaction statistics and capacity data about + requests + + to a storage service. Transactions are reported at both the API operation level + + as well as at the storage service level, and capacity is reported at the storage + + service level. Metrics data can be used to analyze storage service usage, diagnose + + issues with requests made against the storage service, and to improve the + + performance of applications that use a service. + + + For more information, see [https://msdn.microsoft.com/en-us/library/azure/hh343258.aspx](https://msdn.microsoft.com/en-us/library/azure/hh343258.aspx)' +constructor: + syntax: Metrics(enabled=False, include_apis=None, retention_policy=None) + parameters: + - name: enabled + description: 'Indicates whether metrics are enabled for + + the service.' + defaultValue: 'False' + types: + - + - name: include_apis + description: 'Required if enabled is True. Indicates whether metrics + + should generate summary statistics for called API operations.' + defaultValue: None + types: + - + - name: retention_policy + description: The retention policy for the metrics. + defaultValue: None + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.Protocol.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.Protocol.yml new file mode 100644 index 00000000..b7288610 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.Protocol.yml @@ -0,0 +1,19 @@ +### YamlMime:PythonClass +uid: azure.storage.common.models.Protocol +name: Protocol +fullName: azure.storage.common.models.Protocol +module: azure.storage.common.models +summary: 'Specifies the protocol permitted for a SAS token. Note that HTTP only is + + not allowed.' +constructor: + syntax: Protocol() +attributes: +- uid: azure.storage.common.models.Protocol.HTTPS + name: HTTPS + summary: Allow HTTPS requests only. + signature: HTTPS = 'https' +- uid: azure.storage.common.models.Protocol.HTTPS_HTTP + name: HTTPS_HTTP + summary: Allow HTTP and HTTPS requests. + signature: HTTPS_HTTP = 'https,http' diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.ResourceTypes.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.ResourceTypes.yml new file mode 100644 index 00000000..eb68527d --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.ResourceTypes.yml @@ -0,0 +1,68 @@ +### YamlMime:PythonClass +uid: azure.storage.common.models.ResourceTypes +name: ResourceTypes +fullName: azure.storage.common.models.ResourceTypes +module: azure.storage.common.models +summary: Specifies the resource types that are accessible with the account SAS. +constructor: + syntax: ResourceTypes(service=False, container=False, object=False, _str=None) + parameters: + - name: service + description: 'Access to service-level APIs (e.g., Get/Set Service Properties, + + Get Service Stats, List Containers/Queues/Shares)' + defaultValue: 'False' + types: + - + - name: container + description: 'Access to container-level APIs (e.g., Create/Delete Container, + + Create/Delete Queue, Create/Delete Share, + + List Blobs/Files and Directories)' + defaultValue: 'False' + types: + - + - name: object + description: 'Access to object-level APIs for blobs, queue messages, and + + files(e.g. Put Blob, Query Entity, Get Messages, Create File, etc.)' + defaultValue: 'False' + types: + - + - name: _str + description: A string representing the resource types. + defaultValue: None + types: + - +variables: +- description: 'Access to container-level APIs (e.g., Create/Delete Container, + + Create/Delete Queue, Create/Delete Share, + + List Blobs/Files and Directories)' + name: ResourceTypes.CONTAINER + types: + - +- description: 'Access to object-level APIs for blobs, queue messages, and + + files(e.g. Put Blob, Query Entity, Get Messages, Create File, etc.)' + name: ResourceTypes.OBJECT + types: + - +- description: 'Access to service-level APIs (e.g., Get/Set Service Properties, + + Get Service Stats, List Containers/Queues/Shares)' + name: ResourceTypes.SERVICE + types: + - +attributes: +- uid: azure.storage.common.models.ResourceTypes.CONTAINER + name: CONTAINER + signature: CONTAINER = +- uid: azure.storage.common.models.ResourceTypes.OBJECT + name: OBJECT + signature: OBJECT = +- uid: azure.storage.common.models.ResourceTypes.SERVICE + name: SERVICE + signature: SERVICE = diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.RetentionPolicy.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.RetentionPolicy.yml new file mode 100644 index 00000000..3dbaef58 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.RetentionPolicy.yml @@ -0,0 +1,47 @@ +### YamlMime:PythonClass +uid: azure.storage.common.models.RetentionPolicy +name: RetentionPolicy +fullName: azure.storage.common.models.RetentionPolicy +module: azure.storage.common.models +summary: 'By default, Storage Analytics will not delete any logging or metrics data. + Blobs + + will continue to be written until the shared 20TB limit is + + reached. Once the 20TB limit is reached, Storage Analytics will stop writing + + new data and will not resume until free space is available. This 20TB limit + + is independent of the total limit for your storage account. + + + There are two ways to delete Storage Analytics data: by manually making deletion + + requests or by setting a data retention policy. Manual requests to delete Storage + + Analytics data are billable, but delete requests resulting from a retention policy + + are not billable.' +constructor: + syntax: RetentionPolicy(enabled=False, days=None) + parameters: + - name: enabled + description: 'Indicates whether a retention policy is enabled for the + + storage service. If disabled, logging and metrics data will be retained + + infinitely by the service unless explicitly deleted.' + defaultValue: 'False' + types: + - + - name: days + description: 'Required if enabled is true. Indicates the number of + + days that metrics or logging data should be retained. All data older + + than this value will be deleted. The minimum value you can specify is 1; + + the largest value is 365 (one year).' + defaultValue: None + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.RetryContext.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.RetryContext.yml new file mode 100644 index 00000000..c3d6d436 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.RetryContext.yml @@ -0,0 +1,42 @@ +### YamlMime:PythonClass +uid: azure.storage.common.models.RetryContext +name: RetryContext +fullName: azure.storage.common.models.RetryContext +module: azure.storage.common.models +summary: 'Contains the request and response information that can be used to determine + + whether and how to retry. This context is stored across retries and may be + + used to store other information relevant to the retry strategy.' +constructor: + syntax: RetryContext() +variables: +- description: The request sent to the storage service. + name: request + types: + - +- description: The response returned by the storage service. + name: response + types: + - +- description: The location the request was sent to. + name: location_mode + types: + - +- description: 'The exception that just occurred. The type could either be AzureException + (for HTTP errors), + + or other Exception types from lower layers, which are kept unwrapped for easier + processing.' + name: exception + types: + - +- description: Whether retry is targeting the emulator. The default value is False. + name: is_emulated + types: + - +- description: The initial position of the body stream. It is useful when retries + happen and we need to rewind the stream. + name: body_position + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.ServiceProperties.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.ServiceProperties.yml new file mode 100644 index 00000000..360b8433 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.ServiceProperties.yml @@ -0,0 +1,37 @@ +### YamlMime:PythonClass +uid: azure.storage.common.models.ServiceProperties +name: ServiceProperties +fullName: azure.storage.common.models.ServiceProperties +module: azure.storage.common.models +summary: 'Returned by get_*_service_properties functions. Contains the properties + of a + + storage service, including Analytics and CORS rules. + + + Azure Storage Analytics performs logging and provides metrics data for a storage + + account. You can use this data to trace requests, analyze usage trends, and + + diagnose issues with your storage account. To use Storage Analytics, you must + + enable it individually for each service you want to monitor. + + + The aggregated data is stored in a well-known blob (for logging) and in well-known + + tables (for metrics), which may be accessed using the Blob service and Table + + service APIs. + + + For an in-depth guide on using Storage Analytics and other tools to identify, + + diagnose, and troubleshoot Azure Storage-related issues, see + + [http://azure.microsoft.com/documentation/articles/storage-monitoring-diagnosing-troubleshooting/](http://azure.microsoft.com/documentation/articles/storage-monitoring-diagnosing-troubleshooting/) + + + For more information on CORS, see [https://msdn.microsoft.com/en-us/library/azure/dn535601.aspx](https://msdn.microsoft.com/en-us/library/azure/dn535601.aspx)' +constructor: + syntax: ServiceProperties() diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.ServiceStats.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.ServiceStats.yml new file mode 100644 index 00000000..8850ca3c --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.ServiceStats.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonClass +uid: azure.storage.common.models.ServiceStats +name: ServiceStats +fullName: azure.storage.common.models.ServiceStats +module: azure.storage.common.models +summary: 'Returned by get_*_service_stats functions. Contains statistics related to + + replication for the given service. It is only available when read-access + + geo-redundant replication is enabled for the storage account.' +constructor: + syntax: ServiceStats() +variables: +- description: An object containing statistics related to replication for the given + service. + name: geo_replication + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.Services.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.Services.yml new file mode 100644 index 00000000..e66672d3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.Services.yml @@ -0,0 +1,64 @@ +### YamlMime:PythonClass +uid: azure.storage.common.models.Services +name: Services +fullName: azure.storage.common.models.Services +module: azure.storage.common.models +summary: Specifies the services accessible with the account SAS. +constructor: + syntax: Services(blob=False, queue=False, file=False, table=False, _str=None) + parameters: + - name: blob + description: Access to any blob service, for example, the *.BlockBlobService* + defaultValue: 'False' + types: + - + - name: queue + description: Access to the *.QueueService* + defaultValue: 'False' + types: + - + - name: file + description: Access to the *.FileService* + defaultValue: 'False' + types: + - + - name: table + description: Access to the TableService + defaultValue: 'False' + types: + - + - name: _str + description: A string representing the services. + defaultValue: None + types: + - +variables: +- description: The blob service. + name: Services.BLOB + types: + - +- description: The file service + name: Services.FILE + types: + - +- description: The queue service. + name: Services.QUEUE + types: + - +- description: The table service. + name: Services.TABLE + types: + - +attributes: +- uid: azure.storage.common.models.Services.BLOB + name: BLOB + signature: BLOB = +- uid: azure.storage.common.models.Services.FILE + name: FILE + signature: FILE = +- uid: azure.storage.common.models.Services.QUEUE + name: QUEUE + signature: QUEUE = +- uid: azure.storage.common.models.Services.TABLE + name: TABLE + signature: TABLE = diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.StaticWebsite.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.StaticWebsite.yml new file mode 100644 index 00000000..1ef4b912 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.StaticWebsite.yml @@ -0,0 +1,31 @@ +### YamlMime:PythonClass +uid: azure.storage.common.models.StaticWebsite +name: StaticWebsite +fullName: azure.storage.common.models.StaticWebsite +module: azure.storage.common.models +summary: 'Class representing the service properties pertaining to static websites. + + To set StaticWebsite, you must call Set Blob Service Properties using version 2018-03-28 + or later.' +constructor: + syntax: StaticWebsite(enabled=False, index_document=None, error_document_404_path=None) + parameters: + - name: enabled + description: Required. True if static websites should be enabled on the blob service + for the corresponding Storage Account. + defaultValue: 'False' + types: + - + - name: index_document + description: Represents the name of the index document. This is commonly "index.html". + defaultValue: None + types: + - + - name: error_document_404_path + description: 'Represents the path to the error document that should be shown when + an error 404 is issued, + + in other words, when a browser requests a page that does not exist.' + defaultValue: None + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.yml new file mode 100644 index 00000000..5d05e2ab --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.models.yml @@ -0,0 +1,22 @@ +### YamlMime:PythonModule +uid: azure.storage.common.models +name: models +fullName: azure.storage.common.models +classes: +- azure.storage.common.models.AccessPolicy +- azure.storage.common.models.AccountPermissions +- azure.storage.common.models.CorsRule +- azure.storage.common.models.DeleteRetentionPolicy +- azure.storage.common.models.GeoReplication +- azure.storage.common.models.ListGenerator +- azure.storage.common.models.LocationMode +- azure.storage.common.models.Logging +- azure.storage.common.models.Metrics +- azure.storage.common.models.Protocol +- azure.storage.common.models.ResourceTypes +- azure.storage.common.models.RetentionPolicy +- azure.storage.common.models.RetryContext +- azure.storage.common.models.ServiceProperties +- azure.storage.common.models.ServiceStats +- azure.storage.common.models.Services +- azure.storage.common.models.StaticWebsite diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.retry.ExponentialRetry.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.retry.ExponentialRetry.yml new file mode 100644 index 00000000..91ecb449 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.retry.ExponentialRetry.yml @@ -0,0 +1,65 @@ +### YamlMime:PythonClass +uid: azure.storage.common.retry.ExponentialRetry +name: ExponentialRetry +fullName: azure.storage.common.retry.ExponentialRetry +module: azure.storage.common.retry +summary: 'Exponential retry. + + + Constructs an Exponential retry object. The initial_backoff is used for + + the first retry. Subsequent retries are retried after initial_backoff + + + increment_power^retry_count seconds. For example, by default the first retry + + occurs after 15 seconds, the second after (15+3^1) = 18 seconds, and the + + third after (15+3^2) = 24 seconds.' +constructor: + syntax: ExponentialRetry(initial_backoff=15, increment_base=3, max_attempts=3, retry_to_secondary=False, + random_jitter_range=3) + parameters: + - name: initial_backoff + description: The initial backoff interval, in seconds, for the first retry. + defaultValue: '15' + types: + - + - name: increment_base + description: 'The base, in seconds, to increment the initial_backoff by after + the + + first retry.' + defaultValue: '3' + types: + - + - name: max_attempts + description: The maximum number of retry attempts. + defaultValue: '3' + types: + - + - name: retry_to_secondary + description: 'Whether the request should be retried to secondary, if able. This + should + + only be enabled of RA-GRS accounts are used and potentially stale data + + can be handled.' + defaultValue: 'False' + types: + - + - name: random_jitter_range + description: 'A number in seconds which indicates a range to jitter/randomize + for the back-off interval. + + For example, a random_jitter_range of 3 results in the back-off interval x to + vary between x+3 and x-3.' + defaultValue: '3' + types: + - +methods: +- uid: azure.storage.common.retry.ExponentialRetry.retry + name: retry + signature: retry(context) + parameters: + - name: context + isRequired: true diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.retry.LinearRetry.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.retry.LinearRetry.yml new file mode 100644 index 00000000..caf7634a --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.retry.LinearRetry.yml @@ -0,0 +1,48 @@ +### YamlMime:PythonClass +uid: azure.storage.common.retry.LinearRetry +name: LinearRetry +fullName: azure.storage.common.retry.LinearRetry +module: azure.storage.common.retry +summary: 'Linear retry. + + + Constructs a Linear retry object.' +constructor: + syntax: LinearRetry(backoff=15, max_attempts=3, retry_to_secondary=False, random_jitter_range=3) + parameters: + - name: backoff + description: The backoff interval, in seconds, between retries. + defaultValue: '15' + types: + - + - name: max_attempts + description: The maximum number of retry attempts. + defaultValue: '3' + types: + - + - name: retry_to_secondary + description: 'Whether the request should be retried to secondary, if able. This + should + + only be enabled of RA-GRS accounts are used and potentially stale data + + can be handled.' + defaultValue: 'False' + types: + - + - name: random_jitter_range + description: 'A number in seconds which indicates a range to jitter/randomize + for the back-off interval. + + For example, a random_jitter_range of 3 results in the back-off interval x to + vary between x+3 and x-3.' + defaultValue: '3' + types: + - +methods: +- uid: azure.storage.common.retry.LinearRetry.retry + name: retry + signature: retry(context) + parameters: + - name: context + isRequired: true diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.retry.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.retry.yml new file mode 100644 index 00000000..07312a3a --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.retry.yml @@ -0,0 +1,22 @@ +### YamlMime:PythonModule +uid: azure.storage.common.retry +name: retry +fullName: azure.storage.common.retry +functions: +- uid: azure.storage.common.retry.no_retry + name: no_retry + summary: Specifies never to retry. + signature: no_retry(context) + parameters: + - name: context + description: The retry context. + isRequired: true + types: + - + return: + description: Always returns None to indicate never to retry. + types: + - +classes: +- azure.storage.common.retry.ExponentialRetry +- azure.storage.common.retry.LinearRetry diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.sharedaccesssignature.SharedAccessSignature.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.sharedaccesssignature.SharedAccessSignature.yml new file mode 100644 index 00000000..1074d85f --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.sharedaccesssignature.SharedAccessSignature.yml @@ -0,0 +1,125 @@ +### YamlMime:PythonClass +uid: azure.storage.common.sharedaccesssignature.SharedAccessSignature +name: SharedAccessSignature +fullName: azure.storage.common.sharedaccesssignature.SharedAccessSignature +module: azure.storage.common.sharedaccesssignature +summary: 'Provides a factory for creating account access + + signature tokens with an account name and account key. Users can either + + use the factory or can construct the appropriate service and use the + + generate_*_shared_access_signature method directly.' +constructor: + syntax: SharedAccessSignature(account_name, account_key, x_ms_version='2019-02-02') + parameters: + - name: account_name + description: The storage account name used to generate the shared access signatures. + isRequired: true + types: + - + - name: account_key + description: The access key to generate the shares access signatures. + isRequired: true + types: + - + - name: x_ms_version + description: The service version used to generate the shared access signatures. + defaultValue: '2019-02-02' + types: + - +methods: +- uid: azure.storage.common.sharedaccesssignature.SharedAccessSignature.generate_account + name: generate_account + summary: 'Generates a shared access signature for the account. + + Use the returned signature with the sas_token parameter of the service + + or to create a new account object.' + signature: generate_account(services, resource_types, permission, expiry, start=None, + ip=None, protocol=None) + parameters: + - name: services + description: 'Specifies the services accessible with the account SAS. You can + + combine values to provide access to more than one service.' + isRequired: true + types: + - + - name: resource_types + description: 'Specifies the resource types that are accessible with the account + + SAS. You can combine values to provide access to more than one + + resource type.' + isRequired: true + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy. You can combine + + values to provide more than one permission.' + isRequired: true + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + isRequired: true + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. The default + value + + is https,http. See for possible + values.' + defaultValue: None + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.sharedaccesssignature.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.sharedaccesssignature.yml new file mode 100644 index 00000000..ed63f38d --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.sharedaccesssignature.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.storage.common.sharedaccesssignature +name: sharedaccesssignature +fullName: azure.storage.common.sharedaccesssignature +classes: +- azure.storage.common.sharedaccesssignature.SharedAccessSignature diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.storageclient.StorageClient.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.storageclient.StorageClient.yml new file mode 100644 index 00000000..daecba86 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.storageclient.StorageClient.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.storage.common.storageclient.StorageClient +name: StorageClient +fullName: azure.storage.common.storageclient.StorageClient +module: azure.storage.common.storageclient +summary: 'This is the base class for service objects. Service objects are used to + do + + all requests to Storage. This class cannot be instantiated directly.' +constructor: + syntax: StorageClient(connection_params) + parameters: + - name: connection_params + description: The parameters to use to construct the client. + isRequired: true + types: + - +variables: +- description: 'The storage account name. This is used to authenticate requests + + signed with an account key and to construct the storage endpoint. It + + is required unless a connection string is given, or if a custom + + domain is used with anonymous authentication.' + name: account_name + types: + - +- description: 'The storage account key. This is used for shared key authentication. + + If neither account key or sas token is specified, anonymous access + + will be used.' + name: account_key + types: + - +- description: 'A shared access signature token to use to authenticate requests + + instead of the account key. If account key and sas token are both + + specified, account key will be used to sign. If neither are + + specified, anonymous access will be used.' + name: sas_token + types: + - +- description: The endpoint to send storage requests to. + name: primary_endpoint + types: + - +- description: 'The secondary endpoint to read storage data from. This will only be + a + + valid endpoint if the storage account used is RA-GRS and thus allows + + reading from secondary.' + name: secondary_endpoint + types: + - +- description: 'A function which determines whether to retry. Takes as a parameter + a + + object. Returns the number + + of seconds to wait before retrying the request, or None to indicate not + + to retry.' + name: retry + types: + - () +- description: 'The host location to use to make requests. Defaults to LocationMode.PRIMARY. + + Note that this setting only applies to RA-GRS accounts as other account + + types do not allow reading from secondary. If the location_mode is set to + + LocationMode.SECONDARY, read requests will be sent to the secondary endpoint. + + Write requests will continue to be sent to primary.' + name: location_mode + types: + - +- description: The protocol to use for requests. Defaults to https. + name: protocol + types: + - +- description: The session object to use for http requests. + name: request_session + types: + - +- description: 'A function called immediately before each request is sent. This function + + takes as a parameter the request object and returns nothing. It may be + + used to added custom headers or log request data.' + name: request_callback + types: + - () +- description: 'A function called immediately after each response is received. This + + function takes as a parameter the response object and returns nothing. + + It may be used to log response data.' + name: response_callback + types: + - () +- description: 'A function called immediately after retry evaluation is performed. + This + + function takes as a parameter the retry context object and returns nothing. + + It may be used to detect retries and log context information.' + name: retry_callback + types: + - () +methods: +- uid: azure.storage.common.storageclient.StorageClient.extract_date_and_request_id + name: extract_date_and_request_id + signature: static extract_date_and_request_id(retry_context) + parameters: + - name: retry_context + isRequired: true +- uid: azure.storage.common.storageclient.StorageClient.set_proxy + name: set_proxy + summary: Sets the proxy server host and port for the HTTP CONNECT Tunnelling. + signature: set_proxy(host, port, user=None, password=None) + parameters: + - name: host + description: 'Address of the proxy. Ex: ''192.168.0.100''' + isRequired: true + types: + - + - name: port + description: 'Port of the proxy. Ex: 6000' + isRequired: true + types: + - + - name: user + description: User for proxy authorization. + defaultValue: None + types: + - + - name: password + description: Password for proxy authorization. + defaultValue: None + types: + - +attributes: +- uid: azure.storage.common.storageclient.StorageClient.protocol + name: protocol +- uid: azure.storage.common.storageclient.StorageClient.request_session + name: request_session +- uid: azure.storage.common.storageclient.StorageClient.socket_timeout + name: socket_timeout diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.storageclient.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.storageclient.yml new file mode 100644 index 00000000..42556bf8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.storageclient.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.storage.common.storageclient +name: storageclient +fullName: azure.storage.common.storageclient +classes: +- azure.storage.common.storageclient.StorageClient diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.tokencredential.TokenCredential.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.tokencredential.TokenCredential.yml new file mode 100644 index 00000000..01c4ed30 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.tokencredential.TokenCredential.yml @@ -0,0 +1,47 @@ +### YamlMime:PythonClass +uid: azure.storage.common.tokencredential.TokenCredential +name: TokenCredential +fullName: azure.storage.common.tokencredential.TokenCredential +module: azure.storage.common.tokencredential +summary: 'Represents a token credential that is used to authorize HTTPS requests. + + The token can be updated by the user.' +constructor: + syntax: TokenCredential(initial_value=None) + parameters: + - name: initial_value + description: initial value for the token. + defaultValue: None +variables: +- description: The authorization token. It can be set by the user at any point in + a thread-safe way. + name: token + types: + - +methods: +- uid: azure.storage.common.tokencredential.TokenCredential.signed_session + name: signed_session + summary: "Sign requests session with the token. This method is called every time\ + \ a request is going on the wire.\nThe user is responsible for updating the token\ + \ with the preferred tool/SDK.\nIn general there are two options:\n\n * override\ + \ this method to update the token in a preferred way and set Authorization header\ + \ on session \n\n * not override this method, and have a timer that triggers\ + \ periodically to update the token on this class \n\nThe second option is recommended\ + \ as it tends to be more performance-friendly." + signature: signed_session(session=None) + parameters: + - name: session + description: The session to configure for authentication + defaultValue: None + types: + - + return: + types: + - +- uid: azure.storage.common.tokencredential.TokenCredential.token + name: token + signature: token(new_value) + parameters: + - name: new_value + description: new value to be set as the token. + isRequired: true diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.tokencredential.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.tokencredential.yml new file mode 100644 index 00000000..bc465611 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.tokencredential.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.storage.common.tokencredential +name: tokencredential +fullName: azure.storage.common.tokencredential +classes: +- azure.storage.common.tokencredential.TokenCredential diff --git a/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.yml b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.yml new file mode 100644 index 00000000..c1ac39b8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-common/azure.storage.common.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonPackage +uid: azure.storage.common +name: common +fullName: azure.storage.common +type: rootImport +modules: +- azure.storage.common.cloudstorageaccount +- azure.storage.common.models +- azure.storage.common.retry +- azure.storage.common.sharedaccesssignature +- azure.storage.common.storageclient +- azure.storage.common.tokencredential diff --git a/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.fileservice.FileService.yml b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.fileservice.FileService.yml new file mode 100644 index 00000000..a4d61a47 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.fileservice.FileService.yml @@ -0,0 +1,3066 @@ +### YamlMime:PythonClass +uid: azure.storage.file.fileservice.FileService +name: FileService +fullName: azure.storage.file.fileservice.FileService +module: azure.storage.file.fileservice +summary: 'The Server Message Block (SMB) protocol is the preferred file share protocol + + used on premise today. The Microsoft Azure File service enables customers to + + leverage the availability and scalability of Azure''s Cloud Infrastructure as + + a Service (IaaS) SMB without having to rewrite SMB client applications. + + + The Azure File service also offers a compelling alternative to traditional + + Direct Attached Storage (DAS) and Storage Area Network (SAN) solutions, which + + are often complex and expensive to install, configure, and operate.' +constructor: + syntax: FileService(account_name=None, account_key=None, sas_token=None, protocol='https', + endpoint_suffix='core.windows.net', request_session=None, connection_string=None, + socket_timeout=None) + parameters: + - name: account_name + description: 'The storage account name. This is used to authenticate requests + + signed with an account key and to construct the storage endpoint. It + + is required unless a connection string is given.' + defaultValue: None + types: + - + - name: account_key + description: The storage account key. This is used for shared key authentication. + defaultValue: None + types: + - + - name: sas_token + description: 'A shared access signature token to use to authenticate requests + + instead of the account key. If account key and sas token are both + + specified, account key will be used to sign.' + defaultValue: None + types: + - + - name: protocol + description: The protocol to use for requests. Defaults to https. + defaultValue: https + types: + - + - name: endpoint_suffix + description: 'The host base component of the url, minus the account name. Defaults + + to Azure (core.windows.net). Override this to use the China cloud + + (core.chinacloudapi.cn).' + defaultValue: core.windows.net + types: + - + - name: request_session + description: The session object to use for http requests. + defaultValue: None + types: + - + - name: connection_string + description: 'If specified, this will override all other parameters besides + + request session. See + + [http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/](http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/) + + for the connection string format.' + defaultValue: None + types: + - + - name: socket_timeout + description: 'If specified, this will override the default socket timeout. The + timeout specified is in seconds. + + See DEFAULT_SOCKET_TIMEOUT in _constants.py for the default value.' + defaultValue: None + types: + - +variables: +- description: 'The size of the first range get performed by get_file_to_* methods + if + + max_connections is greater than 1. Less data will be returned if the + + file is smaller than this.' + name: MAX_SINGLE_GET_SIZE + types: + - +- description: 'The size of subsequent range gets performed by get_file_to_* methods + if + + max_connections is greater than 1 and the file is larger than MAX_SINGLE_GET_SIZE. + + Less data will be returned if the remainder of the file is smaller than + + this. If this is set to larger than 4MB, content_validation will throw an + + error if enabled. However, if content_validation is not desired a size + + greater than 4MB may be optimal. Setting this below 4MB is not recommended.' + name: MAX_CHUNK_GET_SIZE + types: + - +- description: 'The size of the ranges put by create_file_from_* methods. Smaller + ranges + + may be put if there is less data provided. The maximum range size the service + + supports is 4MB.' + name: MAX_RANGE_SIZE + types: + - +methods: +- uid: azure.storage.file.fileservice.FileService.abort_copy_file + name: abort_copy_file + summary: "Aborts a pending copy_file operation, and leaves a destination file\n\ + \ with zero length and full metadata." + signature: abort_copy_file(share_name, directory_name, file_name, copy_id, timeout=None) + parameters: + - name: share_name + description: Name of destination share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + isRequired: true + types: + - + - name: file_name + description: Name of destination file. + isRequired: true + types: + - + - name: copy_id + description: 'Copy identifier provided in the copy.id of the original + + copy_file operation.' + isRequired: true + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.file.fileservice.FileService.clear_range + name: clear_range + summary: 'Clears the specified range and releases the space used in storage for + + that range.' + signature: clear_range(share_name, directory_name, file_name, start_range, end_range, + timeout=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + isRequired: true + types: + - + - name: file_name + description: Name of existing file. + isRequired: true + types: + - + - name: start_range + description: 'Start of byte range to use for clearing a section of the file. + + The range can be up to 4 MB in size. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of file.' + isRequired: true + types: + - + - name: end_range + description: 'End of byte range to use for clearing a section of the file. + + The range can be up to 4 MB in size. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of file.' + isRequired: true + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.file.fileservice.FileService.close_handles + name: close_handles + summary: 'Returns a generator to close opened handles on a directory or a file under + the specified share. + + The generator will lazily follow the continuation tokens returned by + + the service and stop when all handles have been closed. + + The yielded values represent the number of handles that were closed in each transaction.' + signature: close_handles(share_name, directory_name=None, file_name=None, recursive=None, + handle_id=None, marker=None, snapshot=None, timeout=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + defaultValue: None + types: + - + - name: file_name + description: Name of existing file. + defaultValue: None + types: + - + - name: recursive + description: 'Boolean that specifies if operation should apply to the directory + specified in the URI, + + its files, its subdirectories and their files.' + defaultValue: None + types: + - + - name: handle_id + description: 'Required. Specifies handle ID opened on the file or directory to + be closed. + + Astrix (''*'') is a wildcard that specifies all handles.' + defaultValue: None + types: + - + - name: marker + description: 'An opaque continuation token. This value can be retrieved from the + + next_marker field of a previous generator object if it has not finished closing + handles. If + + specified, this generator will begin closing handles from the point + + where the previous generator stopped.' + defaultValue: None + types: + - + - name: snapshot + description: A string that represents the snapshot version, if applicable. + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.file.fileservice.FileService.copy_file + name: copy_file + summary: 'Copies a file asynchronously. This operation returns a copy operation + + properties object, including a copy ID you can use to check or abort the + + copy operation. The File service copies files on a best-effort basis. + + + If the destination file exists, it will be overwritten. The destination + + file cannot be modified while the copy operation is in progress.' + signature: copy_file(share_name, directory_name, file_name, copy_source, metadata=None, + timeout=None) + parameters: + - name: share_name + description: Name of the destination share. The share must exist. + isRequired: true + types: + - + - name: directory_name + description: Name of the destination directory. The directory must exist. + isRequired: true + types: + - + - name: file_name + description: 'Name of the destination file. If the destination file exists, it + will + + be overwritten. Otherwise, it will be created.' + isRequired: true + types: + - + - name: copy_source + description: 'A URL of up to 2 KB in length that specifies an Azure file or blob. + + The value should be URL-encoded as it would appear in a request URI. + + If the source is in another account, the source must either be public + + or must be authenticated via a shared access signature. If the source + + is public, no authentication is required. + + Examples: + + [https://myaccount.file.core.windows.net/myshare/mydir/myfile](https://myaccount.file.core.windows.net/myshare/mydir/myfile) + + [https://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken](https://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken)' + isRequired: true + types: + - + - name: metadata + description: 'Name-value pairs associated with the file as metadata. If no name-value + + pairs are specified, the operation will copy the metadata from the + + source blob or file to the destination file. If one or more name-value + + pairs are specified, the destination file is created with the specified + + metadata, and the metadata is not copied from the source blob or file.' + defaultValue: None + types: + - (, ) + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: Copy operation properties such as status, source, and ID. + types: + - +- uid: azure.storage.file.fileservice.FileService.create_directory + name: create_directory + summary: 'Creates a new directory under the specified share or parent directory. + + If the directory with the same name already exists, the operation fails + + on the service. By default, the exception is swallowed by the client. + + To expose the exception, specify True for fail_on_exists.' + signature: create_directory(share_name, directory_name, metadata=None, fail_on_exist=False, + timeout=None, file_permission=None, smb_properties=) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: 'Name of directory to create, including the path to the parent + + directory.' + isRequired: true + types: + - + - name: metadata + description: 'A dict with name_value pairs to associate with the + + share as metadata. Example:{''Category'':''test''}' + defaultValue: None + types: + - (, ) + - name: fail_on_exist + description: 'specify whether to throw an exception when the directory exists. + + False by default.' + defaultValue: 'False' + types: + - + - name: file_permission + description: File permission, a portable SDDL + defaultValue: None + types: + - + - name: smb_properties + description: Sets the SMB related file properties + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: True if directory is created, False if directory already exists. + types: + - +- uid: azure.storage.file.fileservice.FileService.create_file + name: create_file + summary: 'Creates a new file. + + + See create_file_from_* for high level functions that handle the + + creation and upload of large files with automatic chunking and + + progress notifications.' + signature: create_file(share_name, directory_name, file_name, content_length, content_settings=None, + metadata=None, timeout=None, file_permission=None, smb_properties=) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + isRequired: true + types: + - + - name: file_name + description: Name of file to create or update. + isRequired: true + types: + - + - name: content_length + description: Length of the file in bytes. + isRequired: true + types: + - + - name: content_settings + description: ContentSettings object used to set file properties. + defaultValue: None + types: + - + - name: metadata + description: Name-value pairs associated with the file as metadata. + defaultValue: None + types: + - (, ) + - name: file_permission + description: File permission, a portable SDDL + defaultValue: None + types: + - + - name: smb_properties + description: Sets the SMB related file properties + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.file.fileservice.FileService.create_file_from_bytes + name: create_file_from_bytes + summary: 'Creates a new file from an array of bytes, or updates the content + + of an existing file, with automatic chunking and progress + + notifications.' + signature: create_file_from_bytes(share_name, directory_name, file_name, file, index=0, + count=None, content_settings=None, metadata=None, validate_content=False, progress_callback=None, + max_connections=2, timeout=None, file_permission=None, smb_properties=) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + isRequired: true + types: + - + - name: file_name + description: Name of file to create or update. + isRequired: true + types: + - + - name: file + description: Content of file as an array of bytes. + isRequired: true + types: + - + - name: index + description: Start index in the array of bytes. + defaultValue: '0' + types: + - + - name: count + description: 'Number of bytes to upload. Set to None or negative value to upload + + all bytes starting from index.' + defaultValue: None + types: + - + - name: content_settings + description: ContentSettings object used to set file properties. + defaultValue: None + types: + - + - name: metadata + description: Name-value pairs associated with the file as metadata. + defaultValue: None + types: + - (, ) + - name: validate_content + description: 'If true, calculates an MD5 hash for each range of the file. The + storage + + service checks the hash of the content that has arrived with the hash + + that was sent. This is primarily valuable for detecting bitflips on + + the wire if using http instead of https as https (the default) will + + already validate. Note that this MD5 hash is not stored with the + + file.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) where + + current is the number of bytes transfered so far and total is the + + size of the file, or None if the total size is unknown.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: Maximum number of parallel connections to use. + defaultValue: '2' + types: + - + - name: file_permission + description: File permission, a portable SDDL + defaultValue: None + types: + - + - name: smb_properties + description: Sets the SMB related file properties + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - +- uid: azure.storage.file.fileservice.FileService.create_file_from_path + name: create_file_from_path + summary: 'Creates a new azure file from a local file path, or updates the content + of an + + existing file, with automatic chunking and progress notifications.' + signature: create_file_from_path(share_name, directory_name, file_name, local_file_path, + content_settings=None, metadata=None, validate_content=False, progress_callback=None, + max_connections=2, file_permission=None, smb_properties=, timeout=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + isRequired: true + types: + - + - name: file_name + description: Name of file to create or update. + isRequired: true + types: + - + - name: local_file_path + description: Path of the local file to upload as the file content. + isRequired: true + types: + - + - name: content_settings + description: ContentSettings object used for setting file properties. + defaultValue: None + types: + - + - name: metadata + description: Name-value pairs associated with the file as metadata. + defaultValue: None + types: + - (, ) + - name: validate_content + description: 'If true, calculates an MD5 hash for each range of the file. The + storage + + service checks the hash of the content that has arrived with the hash + + that was sent. This is primarily valuable for detecting bitflips on + + the wire if using http instead of https as https (the default) will + + already validate. Note that this MD5 hash is not stored with the + + file.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) where + + current is the number of bytes transfered so far and total is the + + size of the file, or None if the total size is unknown.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: Maximum number of parallel connections to use. + defaultValue: '2' + types: + - + - name: file_permission + description: File permission, a portable SDDL + defaultValue: None + types: + - + - name: smb_properties + description: Sets the SMB related file properties + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - +- uid: azure.storage.file.fileservice.FileService.create_file_from_stream + name: create_file_from_stream + summary: 'Creates a new file from a file/stream, or updates the content of an + + existing file, with automatic chunking and progress notifications.' + signature: create_file_from_stream(share_name, directory_name, file_name, stream, + count, content_settings=None, metadata=None, validate_content=False, progress_callback=None, + max_connections=2, timeout=None, file_permission=None, smb_properties=) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + isRequired: true + types: + - + - name: file_name + description: Name of file to create or update. + isRequired: true + types: + - + - name: stream + description: Opened file/stream to upload as the file content. + isRequired: true + types: + - + - name: count + description: 'Number of bytes to read from the stream. This is required, a + + file cannot be created if the count is unknown.' + isRequired: true + types: + - + - name: content_settings + description: ContentSettings object used to set file properties. + defaultValue: None + types: + - + - name: metadata + description: Name-value pairs associated with the file as metadata. + defaultValue: None + types: + - (, ) + - name: validate_content + description: 'If true, calculates an MD5 hash for each range of the file. The + storage + + service checks the hash of the content that has arrived with the hash + + that was sent. This is primarily valuable for detecting bitflips on + + the wire if using http instead of https as https (the default) will + + already validate. Note that this MD5 hash is not stored with the + + file.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) where + + current is the number of bytes transfered so far and total is the + + size of the file, or None if the total size is unknown.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'Maximum number of parallel connections to use. Note that parallel + upload + + requires the stream to be seekable.' + defaultValue: '2' + types: + - + - name: file_permission + description: File permission, a portable SDDL + defaultValue: None + types: + - + - name: smb_properties + description: Sets the SMB related file properties + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - +- uid: azure.storage.file.fileservice.FileService.create_file_from_text + name: create_file_from_text + summary: 'Creates a new file from str/unicode, or updates the content of an + + existing file, with automatic chunking and progress notifications.' + signature: create_file_from_text(share_name, directory_name, file_name, text, encoding='utf-8', + content_settings=None, metadata=None, validate_content=False, timeout=None, file_permission=None, + smb_properties=) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + isRequired: true + types: + - + - name: file_name + description: Name of file to create or update. + isRequired: true + types: + - + - name: text + description: Text to upload to the file. + isRequired: true + types: + - + - name: encoding + description: Python encoding to use to convert the text to bytes. + defaultValue: utf-8 + types: + - + - name: content_settings + description: ContentSettings object used to set file properties. + defaultValue: None + types: + - + - name: metadata + description: Name-value pairs associated with the file as metadata. + defaultValue: None + types: + - (, ) + - name: validate_content + description: 'If true, calculates an MD5 hash for each range of the file. The + storage + + service checks the hash of the content that has arrived with the hash + + that was sent. This is primarily valuable for detecting bitflips on + + the wire if using http instead of https as https (the default) will + + already validate. Note that this MD5 hash is not stored with the + + file.' + defaultValue: 'False' + types: + - + - name: file_permission + description: File permission, a portable SDDL + defaultValue: None + types: + - + - name: smb_properties + description: Sets the SMB related file properties + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - +- uid: azure.storage.file.fileservice.FileService.create_permission_for_share + name: create_permission_for_share + summary: 'Create a permission(a security descriptor) at the share level. + + This ''permission'' can be used for the files/directories in the share. + + If a ''permission'' already exists, it shall return the key of it, else + + creates a new permission at the share level and return its key. + + + :returns a file permission key + + :rtype str' + signature: create_permission_for_share(share_name, file_permission, timeout=None) + parameters: + - name: share_name + description: Name of share. + isRequired: true + - name: file_permission + description: File permission, a Portable SDDL + isRequired: true + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None +- uid: azure.storage.file.fileservice.FileService.create_share + name: create_share + summary: 'Creates a new share under the specified account. If the share + + with the same name already exists, the operation fails on the + + service. By default, the exception is swallowed by the client. + + To expose the exception, specify True for fail_on_exists.' + signature: create_share(share_name, metadata=None, quota=None, fail_on_exist=False, + timeout=None) + parameters: + - name: share_name + description: Name of share to create. + isRequired: true + types: + - + - name: metadata + description: 'A dict with name_value pairs to associate with the + + share as metadata. Example:{''Category'':''test''}' + defaultValue: None + types: + - (, ) + - name: quota + description: 'Specifies the maximum size of the share, in gigabytes. Must be + + greater than 0, and less than or equal to 5TB (5120).' + defaultValue: None + types: + - + - name: fail_on_exist + description: 'Specify whether to throw an exception when the share exists. + + False by default.' + defaultValue: 'False' + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: True if share is created, False if share already exists. + types: + - +- uid: azure.storage.file.fileservice.FileService.delete_directory + name: delete_directory + summary: 'Deletes the specified empty directory. Note that the directory must + + be empty before it can be deleted. Attempting to delete directories + + that are not empty will fail. + + + If the directory does not exist, the operation fails on the + + service. By default, the exception is swallowed by the client. + + To expose the exception, specify True for fail_not_exist.' + signature: delete_directory(share_name, directory_name, fail_not_exist=False, timeout=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: 'Name of directory to delete, including the path to the parent + + directory.' + isRequired: true + types: + - + - name: fail_not_exist + description: 'Specify whether to throw an exception when the directory doesn''t + + exist.' + defaultValue: 'False' + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: True if directory is deleted, False otherwise. + types: + - +- uid: azure.storage.file.fileservice.FileService.delete_file + name: delete_file + summary: 'Marks the specified file for deletion. The file is later + + deleted during garbage collection.' + signature: delete_file(share_name, directory_name, file_name, timeout=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + isRequired: true + types: + - + - name: file_name + description: Name of existing file. + isRequired: true + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.file.fileservice.FileService.delete_share + name: delete_share + summary: 'Marks the specified share for deletion. If the share + + does not exist, the operation fails on the service. By + + default, the exception is swallowed by the client. + + To expose the exception, specify True for fail_not_exist.' + signature: delete_share(share_name, fail_not_exist=False, timeout=None, snapshot=None, + delete_snapshots=None) + parameters: + - name: share_name + description: Name of share to delete. + isRequired: true + types: + - + - name: fail_not_exist + description: 'Specify whether to throw an exception when the share doesn''t + + exist. False by default.' + defaultValue: 'False' + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + - name: snapshot + description: 'A string that represents the snapshot version, if applicable. + + Specify this argument to delete a specific snapshot only. + + delete_snapshots must be None if this is specified.' + defaultValue: None + types: + - + - name: delete_snapshots + description: To delete a share that has snapshots, this must be specified as DeleteSnapshot.Include. + defaultValue: None + types: + - + return: + description: True if share is deleted, False share doesn't exist. + types: + - +- uid: azure.storage.file.fileservice.FileService.exists + name: exists + summary: 'Returns a boolean indicating whether the share exists if only share name + is + + given. If directory_name is specificed a boolean will be returned indicating + + if the directory exists. If file_name is specified as well, a boolean will be + + returned indicating if the file exists.' + signature: exists(share_name, directory_name=None, file_name=None, timeout=None, + snapshot=None) + parameters: + - name: share_name + description: Name of a share. + isRequired: true + types: + - + - name: directory_name + description: The path to a directory. + defaultValue: None + types: + - + - name: file_name + description: Name of a file. + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + - name: snapshot + description: A string that represents the snapshot version, if applicable. + defaultValue: None + types: + - + return: + description: A boolean indicating whether the resource exists. + types: + - +- uid: azure.storage.file.fileservice.FileService.extract_date_and_request_id + name: extract_date_and_request_id + signature: static extract_date_and_request_id(retry_context) + parameters: + - name: retry_context + isRequired: true +- uid: azure.storage.file.fileservice.FileService.generate_account_shared_access_signature + name: generate_account_shared_access_signature + summary: 'Generates a shared access signature for the file service. + + Use the returned signature with the sas_token parameter of the FileService.' + signature: generate_account_shared_access_signature(resource_types, permission, + expiry, start=None, ip=None, protocol=None) + parameters: + - name: resource_types + description: Specifies the resource types that are accessible with the account + SAS. + isRequired: true + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy.' + isRequired: true + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + isRequired: true + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. Possible values + are + + both HTTPS and HTTP (https,http) or HTTPS only (https). The default value + + is https,http. Note that HTTP only is not a permitted value.' + defaultValue: None + types: + - + return: + description: A Shared Access Signature (sas) token. + types: + - +- uid: azure.storage.file.fileservice.FileService.generate_file_shared_access_signature + name: generate_file_shared_access_signature + summary: 'Generates a shared access signature for the file. + + Use the returned signature with the sas_token parameter of FileService.' + signature: generate_file_shared_access_signature(share_name, directory_name=None, + file_name=None, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, + cache_control=None, content_disposition=None, content_encoding=None, content_language=None, + content_type=None) + parameters: + - name: share_name + description: Name of share. + isRequired: true + types: + - + - name: directory_name + description: 'Name of directory. SAS tokens cannot be created for directories, + so + + this parameter should only be present if file_name is provided.' + defaultValue: None + types: + - + - name: file_name + description: Name of file. + defaultValue: None + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Permissions must be ordered read, create, write, delete, list. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy.' + defaultValue: None + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + defaultValue: None + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: id + description: 'A unique value up to 64 characters in length that correlates to + a + + stored access policy. To create a stored access policy, use + + set_file_service_properties.' + defaultValue: None + types: + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. Possible values + are + + both HTTPS and HTTP (https,http) or HTTPS only (https). The default value + + is https,http. Note that HTTP only is not a permitted value.' + defaultValue: None + types: + - + - name: cache_control + description: 'Response header value for Cache-Control when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_disposition + description: 'Response header value for Content-Disposition when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_encoding + description: 'Response header value for Content-Encoding when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_language + description: 'Response header value for Content-Language when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_type + description: 'Response header value for Content-Type when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + return: + description: A Shared Access Signature (sas) token. + types: + - +- uid: azure.storage.file.fileservice.FileService.generate_share_shared_access_signature + name: generate_share_shared_access_signature + summary: 'Generates a shared access signature for the share. + + Use the returned signature with the sas_token parameter of FileService.' + signature: generate_share_shared_access_signature(share_name, permission=None, expiry=None, + start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, + content_encoding=None, content_language=None, content_type=None) + parameters: + - name: share_name + description: Name of share. + isRequired: true + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Permissions must be ordered read, create, write, delete, list. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy.' + defaultValue: None + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + defaultValue: None + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: id + description: 'A unique value up to 64 characters in length that correlates to + a + + stored access policy. To create a stored access policy, use .' + defaultValue: None + types: + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. Possible values + are + + both HTTPS and HTTP (https,http) or HTTPS only (https). The default value + + is https,http. Note that HTTP only is not a permitted value.' + defaultValue: None + types: + - + - name: cache_control + description: 'Response header value for Cache-Control when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_disposition + description: 'Response header value for Content-Disposition when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_encoding + description: 'Response header value for Content-Encoding when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_language + description: 'Response header value for Content-Language when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_type + description: 'Response header value for Content-Type when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + return: + description: A Shared Access Signature (sas) token. + types: + - +- uid: azure.storage.file.fileservice.FileService.get_directory_metadata + name: get_directory_metadata + summary: Returns all user-defined metadata for the specified directory. + signature: get_directory_metadata(share_name, directory_name, timeout=None, snapshot=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + isRequired: true + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + - name: snapshot + description: A string that represents the snapshot version, if applicable. + defaultValue: None + types: + - + return: + description: A dictionary representing the directory metadata name, value pairs. + types: + - (, ) +- uid: azure.storage.file.fileservice.FileService.get_directory_properties + name: get_directory_properties + summary: 'Returns all user-defined metadata and system properties for the + + specified directory. The data returned does not include the directory''s + + list of files.' + signature: get_directory_properties(share_name, directory_name, timeout=None, snapshot=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to an existing directory. + isRequired: true + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + - name: snapshot + description: A string that represents the snapshot version, if applicable. + defaultValue: None + types: + - + return: + description: properties for the specified directory within a directory object. + types: + - +- uid: azure.storage.file.fileservice.FileService.get_file_metadata + name: get_file_metadata + summary: Returns all user-defined metadata for the specified file. + signature: get_file_metadata(share_name, directory_name, file_name, timeout=None, + snapshot=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + isRequired: true + types: + - + - name: file_name + description: Name of existing file. + isRequired: true + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + - name: snapshot + description: A string that represents the snapshot version, if applicable. + defaultValue: None + types: + - + return: + description: A dictionary representing the file metadata name, value pairs. + types: + - (, ) +- uid: azure.storage.file.fileservice.FileService.get_file_properties + name: get_file_properties + summary: 'Returns all user-defined metadata, standard HTTP properties, and + + system properties for the file. Returns an instance of + with + + and a metadata dict.' + signature: get_file_properties(share_name, directory_name, file_name, timeout=None, + snapshot=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + isRequired: true + types: + - + - name: file_name + description: Name of existing file. + isRequired: true + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + - name: snapshot + description: A string that represents the snapshot version, if applicable. + defaultValue: None + types: + - + return: + description: a file object including properties and metadata. + types: + - +- uid: azure.storage.file.fileservice.FileService.get_file_service_properties + name: get_file_service_properties + summary: 'Gets the properties of a storage account''s File service, including + + Azure Storage Analytics.' + signature: get_file_service_properties(timeout=None) + parameters: + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: The file service properties. + types: + - +- uid: azure.storage.file.fileservice.FileService.get_file_to_bytes + name: get_file_to_bytes + summary: 'Downloads a file as an array of bytes, with automatic chunking and + + progress notifications. Returns an instance of + with + + properties, metadata, and content.' + signature: get_file_to_bytes(share_name, directory_name, file_name, start_range=None, + end_range=None, validate_content=False, progress_callback=None, max_connections=2, + timeout=None, snapshot=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + isRequired: true + types: + - + - name: file_name + description: Name of existing file. + isRequired: true + types: + - + - name: start_range + description: 'Start of byte range to use for downloading a section of the file. + + If no end_range is given, all bytes after the start_range will be downloaded. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of file.' + defaultValue: None + types: + - + - name: end_range + description: 'End of byte range to use for downloading a section of the file. + + If end_range is given, start_range must be provided. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of file.' + defaultValue: None + types: + - + - name: validate_content + description: 'If set to true, validates an MD5 hash for each retrieved portion + of + + the file. This is primarily valuable for detecting bitflips on the wire + + if using http instead of https as https (the default) will already + + validate. Note that the service will only return transactional MD5s + + for chunks 4MB or less so the first get request will be of size + + self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If + + self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be + + thrown. As computing the MD5 takes processing time and more requests + + will need to be done due to the reduced chunk size there may be some + + increase in latency.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) + + where current is the number of bytes transfered so far, and total is + + the size of the file if known.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'If set to 2 or greater, an initial get will be done for the first + + self.MAX_SINGLE_GET_SIZE bytes of the file. If this is the entire file, + + the method returns at this point. If it is not, it will download the + + remaining data parallel using the number of threads equal to + + max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. + + If set to 1, a single large get request will be done. This is not + + generally recommended but available if very few threads should be + + used, network requests are very expensive, or a non-seekable stream + + prevents parallel download. This may also be valuable if the file is + + being concurrently modified to enforce atomicity or if many files are + + expected to be empty as an extra request is required for empty files + + if max_connections is greater than 1.' + defaultValue: '2' + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + - name: snapshot + description: A string that represents the snapshot version, if applicable. + defaultValue: None + types: + - + return: + description: A File with properties, content, and metadata. + types: + - +- uid: azure.storage.file.fileservice.FileService.get_file_to_path + name: get_file_to_path + summary: 'Downloads a file to a file path, with automatic chunking and progress + + notifications. Returns an instance of File with properties and metadata.' + signature: get_file_to_path(share_name, directory_name, file_name, file_path, open_mode='wb', + start_range=None, end_range=None, validate_content=False, progress_callback=None, + max_connections=2, timeout=None, snapshot=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + isRequired: true + types: + - + - name: file_name + description: Name of existing file. + isRequired: true + types: + - + - name: file_path + description: Path of file to write to. + isRequired: true + types: + - + - name: open_mode + description: 'Mode to use when opening the file. Note that specifying append only + + open_mode prevents parallel download. So, max_connections must be set + + to 1 if this open_mode is used.' + defaultValue: wb + types: + - + - name: start_range + description: 'Start of byte range to use for downloading a section of the file. + + If no end_range is given, all bytes after the start_range will be downloaded. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of file.' + defaultValue: None + types: + - + - name: end_range + description: 'End of byte range to use for downloading a section of the file. + + If end_range is given, start_range must be provided. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of file.' + defaultValue: None + types: + - + - name: validate_content + description: 'If set to true, validates an MD5 hash for each retrieved portion + of + + the file. This is primarily valuable for detecting bitflips on the wire + + if using http instead of https as https (the default) will already + + validate. Note that the service will only return transactional MD5s + + for chunks 4MB or less so the first get request will be of size + + self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If + + self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be + + thrown. As computing the MD5 takes processing time and more requests + + will need to be done due to the reduced chunk size there may be some + + increase in latency.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) + + where current is the number of bytes transfered so far, and total is + + the size of the file if known.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'If set to 2 or greater, an initial get will be done for the first + + self.MAX_SINGLE_GET_SIZE bytes of the file. If this is the entire file, + + the method returns at this point. If it is not, it will download the + + remaining data parallel using the number of threads equal to + + max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. + + If set to 1, a single large get request will be done. This is not + + generally recommended but available if very few threads should be + + used, network requests are very expensive, or a non-seekable stream + + prevents parallel download. This may also be valuable if the file is + + being concurrently modified to enforce atomicity or if many files are + + expected to be empty as an extra request is required for empty files + + if max_connections is greater than 1.' + defaultValue: '2' + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + - name: snapshot + description: A string that represents the snapshot version, if applicable. + defaultValue: None + types: + - + return: + description: A File with properties and metadata. + types: + - +- uid: azure.storage.file.fileservice.FileService.get_file_to_stream + name: get_file_to_stream + summary: 'Downloads a file to a stream, with automatic chunking and progress + + notifications. Returns an instance of with + properties + + and metadata.' + signature: get_file_to_stream(share_name, directory_name, file_name, stream, start_range=None, + end_range=None, validate_content=False, progress_callback=None, max_connections=2, + timeout=None, snapshot=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + isRequired: true + types: + - + - name: file_name + description: Name of existing file. + isRequired: true + types: + - + - name: stream + description: Opened file/stream to write to. + isRequired: true + types: + - + - name: start_range + description: 'Start of byte range to use for downloading a section of the file. + + If no end_range is given, all bytes after the start_range will be downloaded. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of file.' + defaultValue: None + types: + - + - name: end_range + description: 'End of byte range to use for downloading a section of the file. + + If end_range is given, start_range must be provided. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of file.' + defaultValue: None + types: + - + - name: validate_content + description: 'If set to true, validates an MD5 hash for each retrieved portion + of + + the file. This is primarily valuable for detecting bitflips on the wire + + if using http instead of https as https (the default) will already + + validate. Note that the service will only return transactional MD5s + + for chunks 4MB or less so the first get request will be of size + + self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If + + self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be + + thrown. As computing the MD5 takes processing time and more requests + + will need to be done due to the reduced chunk size there may be some + + increase in latency.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) + + where current is the number of bytes transfered so far, and total is + + the size of the file if known.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'If set to 2 or greater, an initial get will be done for the first + + self.MAX_SINGLE_GET_SIZE bytes of the file. If this is the entire file, + + the method returns at this point. If it is not, it will download the + + remaining data parallel using the number of threads equal to + + max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. + + If set to 1, a single large get request will be done. This is not + + generally recommended but available if very few threads should be + + used, network requests are very expensive, or a non-seekable stream + + prevents parallel download. This may also be valuable if the file is + + being concurrently modified to enforce atomicity or if many files are + + expected to be empty as an extra request is required for empty files + + if max_connections is greater than 1.' + defaultValue: '2' + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + - name: snapshot + description: A string that represents the snapshot version, if applicable. + defaultValue: None + types: + - + return: + description: A File with properties and metadata. + types: + - +- uid: azure.storage.file.fileservice.FileService.get_file_to_text + name: get_file_to_text + summary: 'Downloads a file as unicode text, with automatic chunking and progress + + notifications. Returns an instance of with + properties, + + metadata, and content.' + signature: get_file_to_text(share_name, directory_name, file_name, encoding='utf-8', + start_range=None, end_range=None, validate_content=False, progress_callback=None, + max_connections=2, timeout=None, snapshot=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + isRequired: true + types: + - + - name: file_name + description: Name of existing file. + isRequired: true + types: + - + - name: encoding + description: Python encoding to use when decoding the file data. + defaultValue: utf-8 + types: + - + - name: start_range + description: 'Start of byte range to use for downloading a section of the file. + + If no end_range is given, all bytes after the start_range will be downloaded. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of file.' + defaultValue: None + types: + - + - name: end_range + description: 'End of byte range to use for downloading a section of the file. + + If end_range is given, start_range must be provided. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of file.' + defaultValue: None + types: + - + - name: validate_content + description: 'If set to true, validates an MD5 hash for each retrieved portion + of + + the file. This is primarily valuable for detecting bitflips on the wire + + if using http instead of https as https (the default) will already + + validate. Note that the service will only return transactional MD5s + + for chunks 4MB or less so the first get request will be of size + + self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If + + self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be + + thrown. As computing the MD5 takes processing time and more requests + + will need to be done due to the reduced chunk size there may be some + + increase in latency.' + defaultValue: 'False' + types: + - + - name: progress_callback + description: 'Callback for progress with signature function(current, total) + + where current is the number of bytes transfered so far, and total is + + the size of the file if known.' + defaultValue: None + types: + - (, ) + - name: max_connections + description: 'If set to 2 or greater, an initial get will be done for the first + + self.MAX_SINGLE_GET_SIZE bytes of the file. If this is the entire file, + + the method returns at this point. If it is not, it will download the + + remaining data parallel using the number of threads equal to + + max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE. + + If set to 1, a single large get request will be done. This is not + + generally recommended but available if very few threads should be + + used, network requests are very expensive, or a non-seekable stream + + prevents parallel download. This may also be valuable if the file is + + being concurrently modified to enforce atomicity or if many files are + + expected to be empty as an extra request is required for empty files + + if max_connections is greater than 1.' + defaultValue: '2' + types: + - + - name: timeout + description: 'The timeout parameter is expressed in seconds. This method may make + + multiple calls to the Azure service and the timeout will apply to + + each call individually.' + defaultValue: None + types: + - + - name: snapshot + description: A string that represents the snapshot version, if applicable. + defaultValue: None + types: + - + return: + description: A File with properties, content, and metadata. + types: + - +- uid: azure.storage.file.fileservice.FileService.get_permission_for_share + name: get_permission_for_share + summary: 'Create a permission(a security descriptor) at the share level. + + This ''permission'' can be used for the files/directories in the share. + + If a ''permission'' already exists, it shall return the key of it, else + + creates a new permission at the share level and return its key. + + + :returns a file permission(a portable SDDL) + + :rtype str' + signature: get_permission_for_share(share_name, file_permission_key, timeout=None) + parameters: + - name: share_name + description: Name of share. + isRequired: true + - name: file_permission_key + description: Key of the file permission to retrieve + isRequired: true + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None +- uid: azure.storage.file.fileservice.FileService.get_share_acl + name: get_share_acl + summary: Gets the permissions for the specified share. + signature: get_share_acl(share_name, timeout=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: A dictionary of access policies associated with the share. + types: + - (, ) +- uid: azure.storage.file.fileservice.FileService.get_share_metadata + name: get_share_metadata + summary: Returns all user-defined metadata for the specified share. + signature: get_share_metadata(share_name, timeout=None, snapshot=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + - name: snapshot + description: A string that represents the snapshot version, if applicable. + defaultValue: None + types: + - + return: + description: A dictionary representing the share metadata name, value pairs. + types: + - (, ) +- uid: azure.storage.file.fileservice.FileService.get_share_properties + name: get_share_properties + summary: 'Returns all user-defined metadata and system properties for the + + specified share. The data returned does not include the shares''s + + list of files or directories.' + signature: get_share_properties(share_name, timeout=None, snapshot=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + - name: snapshot + description: A string that represents the snapshot version, if applicable. + defaultValue: None + types: + - + return: + description: A Share that exposes properties and metadata. + types: + - +- uid: azure.storage.file.fileservice.FileService.get_share_stats + name: get_share_stats + summary: 'Gets the approximate size of the data stored on the share, + + rounded up to the nearest gigabyte. + + + Note that this value may not include all recently created + + or recently re-sized files.' + signature: get_share_stats(share_name, timeout=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: the approximate size of the data stored on the share. + types: + - +- uid: azure.storage.file.fileservice.FileService.get_share_stats_in_bytes + name: get_share_stats_in_bytes + summary: 'Gets the approximate size of the data stored on the share in bytes. + + + Note that this value may not include all recently created + + or recently re-sized files.' + signature: get_share_stats_in_bytes(share_name, timeout=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: the approximate size of the data stored on the share. + types: + - +- uid: azure.storage.file.fileservice.FileService.list_directories_and_files + name: list_directories_and_files + summary: 'Returns a generator to list the directories and files under the specified + share. + + The generator will lazily follow the continuation tokens returned by + + the service and stop when all directories and files have been returned or + + num_results is reached. + + + If num_results is specified and the share has more than that number of + + files and directories, the generator will have a populated next_marker + + field once it finishes. This marker can be used to create a new generator + + if more results are desired.' + signature: list_directories_and_files(share_name, directory_name=None, num_results=None, + marker=None, timeout=None, prefix=None, snapshot=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + defaultValue: None + types: + - + - name: num_results + description: 'Specifies the maximum number of files to return, + + including all directory elements. If the request does not specify + + num_results or specifies a value greater than 5,000, the server will + + return up to 5,000 items. Setting num_results to a value less than + + or equal to zero results in error response code 400 (Bad Request).' + defaultValue: None + types: + - + - name: marker + description: 'An opaque continuation token. This value can be retrieved from the + + next_marker field of a previous generator object if num_results was + + specified and that generator has finished enumerating results. If + + specified, this generator will begin returning results from the point + + where the previous generator stopped.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + - name: prefix + description: List only the files and/or directories with the given prefix. + defaultValue: None + types: + - + - name: snapshot + description: A string that represents the snapshot version, if applicable. + defaultValue: None + types: + - +- uid: azure.storage.file.fileservice.FileService.list_handles + name: list_handles + summary: 'Returns a generator to list opened handles on a directory or a file under + the specified share. + + The generator will lazily follow the continuation tokens returned by + + the service and stop when all handles have been returned or + + num_results is reached. + + + If num_results is specified and the share has more than that number of + + files and directories, the generator will have a populated next_marker + + field once it finishes. This marker can be used to create a new generator + + if more results are desired.' + signature: list_handles(share_name, directory_name=None, file_name=None, recursive=None, + max_results=None, marker=None, snapshot=None, timeout=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + defaultValue: None + types: + - + - name: file_name + description: Name of existing file. + defaultValue: None + types: + - + - name: recursive + description: 'Boolean that specifies if operation should apply to the directory + specified in the URI, + + its files, its subdirectories and their files.' + defaultValue: None + types: + - + - name: max_results + description: 'Specifies the maximum number of handles taken on files and/or directories + to return. + + If the request does not specify max_results or specifies a value greater than + 5,000, + + the server will return up to 5,000 items. + + Setting max_results to a value less than or equal to zero results in error response + code 400 (Bad Request).' + defaultValue: None + types: + - + - name: marker + description: 'An opaque continuation token. This value can be retrieved from the + + next_marker field of a previous generator object if max_results was + + specified and that generator has finished enumerating results. If + + specified, this generator will begin returning results from the point + + where the previous generator stopped.' + defaultValue: None + types: + - + - name: snapshot + description: A string that represents the snapshot version, if applicable. + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.file.fileservice.FileService.list_ranges + name: list_ranges + summary: Retrieves the valid ranges for a file. + signature: list_ranges(share_name, directory_name, file_name, start_range=None, + end_range=None, timeout=None, snapshot=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + isRequired: true + types: + - + - name: file_name + description: Name of existing file. + isRequired: true + types: + - + - name: start_range + description: 'Specifies the start offset of bytes over which to list ranges. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of file.' + defaultValue: None + types: + - + - name: end_range + description: 'Specifies the end offset of bytes over which to list ranges. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of file.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + - name: snapshot + description: A string that represents the snapshot version, if applicable. + defaultValue: None + types: + - + return: + description: a list of valid ranges + types: + - +- uid: azure.storage.file.fileservice.FileService.list_shares + name: list_shares + summary: 'Returns a generator to list the shares under the specified account. + + The generator will lazily follow the continuation tokens returned by + + the service and stop when all shares have been returned or num_results + + is reached. + + + If num_results is specified and the account has more than that number of + + shares, the generator will have a populated next_marker field once it + + finishes. This marker can be used to create a new generator if more + + results are desired.' + signature: list_shares(prefix=None, marker=None, num_results=None, include_metadata=False, + timeout=None, include_snapshots=False) + parameters: + - name: prefix + description: 'Filters the results to return only shares whose names + + begin with the specified prefix.' + defaultValue: None + types: + - + - name: num_results + description: Specifies the maximum number of shares to return. + defaultValue: None + types: + - + - name: include_metadata + description: Specifies that share metadata be returned in the response. + defaultValue: 'False' + types: + - + - name: marker + description: 'An opaque continuation token. This value can be retrieved from the + + next_marker field of a previous generator object if num_results was + + specified and that generator has finished enumerating results. If + + specified, this generator will begin returning results from the point + + where the previous generator stopped.' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + - name: include_snapshots + description: Specifies that share snapshots be returned in the response. + defaultValue: 'False' + types: + - +- uid: azure.storage.file.fileservice.FileService.make_file_url + name: make_file_url + summary: Creates the url to access a file. + signature: make_file_url(share_name, directory_name, file_name, protocol=None, sas_token=None) + parameters: + - name: share_name + description: Name of share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + isRequired: true + types: + - + - name: file_name + description: Name of file. + isRequired: true + types: + - + - name: protocol + description: 'Protocol to use: ''http'' or ''https''. If not specified, uses the + + protocol specified when FileService was initialized.' + defaultValue: None + types: + - + - name: sas_token + description: 'Shared access signature token created with + + generate_shared_access_signature.' + defaultValue: None + types: + - + return: + description: file access URL. + types: + - +- uid: azure.storage.file.fileservice.FileService.resize_file + name: resize_file + summary: 'Resizes a file to the specified size. If the specified byte + + value is less than the current size of the file, then all + + ranges above the specified byte value are cleared.' + signature: resize_file(share_name, directory_name, file_name, content_length, timeout=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + isRequired: true + types: + - + - name: file_name + description: Name of existing file. + isRequired: true + types: + - + - name: content_length + description: The length to resize the file to. + isRequired: true + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.file.fileservice.FileService.set_directory_metadata + name: set_directory_metadata + summary: 'Sets one or more user-defined name-value pairs for the specified + + directory. Each call to this operation replaces all existing metadata + + attached to the directory. To remove all metadata from the directory, + + call this operation with no metadata dict.' + signature: set_directory_metadata(share_name, directory_name, metadata=None, timeout=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + isRequired: true + types: + - + - name: metadata + description: 'A dict containing name-value pairs to associate with the directory + + as metadata. Example: {''category'':''test''}' + defaultValue: None + types: + - (, ) + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.file.fileservice.FileService.set_directory_properties + name: set_directory_properties + signature: set_directory_properties(share_name, directory_name, file_permission=None, + smb_properties=, timeout=None) + parameters: + - name: share_name + description: Name of the share + isRequired: true + - name: directory_name + description: Name of the directory + isRequired: true + - name: file_permission + description: File permission, a portable SDDL + defaultValue: None + types: + - + - name: smb_properties + description: Sets the SMB related file properties + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.file.fileservice.FileService.set_file_metadata + name: set_file_metadata + summary: 'Sets user-defined metadata for the specified file as one or more + + name-value pairs.' + signature: set_file_metadata(share_name, directory_name, file_name, metadata=None, + timeout=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + isRequired: true + types: + - + - name: file_name + description: Name of existing file. + isRequired: true + types: + - + - name: metadata + description: 'Dict containing name and value pairs. Each call to this operation + + replaces all existing metadata attached to the file. To remove all + + metadata from the file, call this operation with no metadata headers.' + defaultValue: None + types: + - (, ) + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.file.fileservice.FileService.set_file_properties + name: set_file_properties + summary: 'Sets system properties on the file. If one property is set for the + + content_settings, all properties will be overriden.' + signature: set_file_properties(share_name, directory_name, file_name, content_settings, + timeout=None, file_permission=None, smb_properties=) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + isRequired: true + types: + - + - name: file_name + description: Name of existing file. + isRequired: true + types: + - + - name: content_settings + description: ContentSettings object used to set the file properties. + isRequired: true + types: + - + - name: file_permission + description: File permission, a portable SDDL + defaultValue: None + types: + - + - name: smb_properties + description: Sets the SMB related file properties + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.file.fileservice.FileService.set_file_service_properties + name: set_file_service_properties + summary: 'Sets the properties of a storage account''s File service, including + + Azure Storage Analytics. If an element (ex HourMetrics) is left as None, the + + existing settings on the service for that functionality are preserved.' + signature: set_file_service_properties(hour_metrics=None, minute_metrics=None, cors=None, + timeout=None) + parameters: + - name: hour_metrics + description: 'The hour metrics settings provide a summary of request + + statistics grouped by API in hourly aggregates for files.' + defaultValue: None + types: + - + - name: minute_metrics + description: 'The minute metrics settings provide request statistics + + for each minute for files.' + defaultValue: None + types: + - + - name: cors + description: 'You can include up to five CorsRule elements in the + + list. If an empty list is specified, all CORS rules will be deleted, + + and CORS will be disabled for the service.' + defaultValue: None + types: + - list() + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.file.fileservice.FileService.set_proxy + name: set_proxy + summary: Sets the proxy server host and port for the HTTP CONNECT Tunnelling. + signature: set_proxy(host, port, user=None, password=None) + parameters: + - name: host + description: 'Address of the proxy. Ex: ''192.168.0.100''' + isRequired: true + types: + - + - name: port + description: 'Port of the proxy. Ex: 6000' + isRequired: true + types: + - + - name: user + description: User for proxy authorization. + defaultValue: None + types: + - + - name: password + description: Password for proxy authorization. + defaultValue: None + types: + - +- uid: azure.storage.file.fileservice.FileService.set_share_acl + name: set_share_acl + summary: 'Sets the permissions for the specified share or stored access + + policies that may be used with Shared Access Signatures.' + signature: set_share_acl(share_name, signed_identifiers=None, timeout=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: signed_identifiers + description: 'A dictionary of access policies to associate with the share. The + + dictionary may contain up to 5 elements. An empty dictionary + + will clear the access policies set on the service.' + defaultValue: None + types: + - dict(str, ) + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.file.fileservice.FileService.set_share_metadata + name: set_share_metadata + summary: 'Sets one or more user-defined name-value pairs for the specified + + share. Each call to this operation replaces all existing metadata + + attached to the share. To remove all metadata from the share, + + call this operation with no metadata dict.' + signature: set_share_metadata(share_name, metadata=None, timeout=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: metadata + description: 'A dict containing name-value pairs to associate with the share as + + metadata. Example: {''category'':''test''}' + defaultValue: None + types: + - (, ) + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.file.fileservice.FileService.set_share_properties + name: set_share_properties + summary: Sets service-defined properties for the specified share. + signature: set_share_properties(share_name, quota, timeout=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: quota + description: 'Specifies the maximum size of the share, in gigabytes. Must be + + greater than 0, and less than or equal to 5 TB (5120 GB).' + isRequired: true + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.file.fileservice.FileService.snapshot_share + name: snapshot_share + summary: Creates a snapshot of an existing share under the specified account. + signature: snapshot_share(share_name, metadata=None, quota=None, timeout=None) + parameters: + - name: share_name + description: The name of the share to create a snapshot of. + isRequired: true + types: + - + - name: metadata + description: 'A dict with name_value pairs to associate with the + + share as metadata. Example:{''Category'':''test''}' + defaultValue: None + types: + - of > + - name: quota + description: 'Specifies the maximum size of the share, in gigabytes. Must be + + greater than 0, and less than or equal to 5TB (5120).' + defaultValue: None + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: snapshot properties + types: + - +- uid: azure.storage.file.fileservice.FileService.update_range + name: update_range + summary: Writes the bytes specified by the request body into the specified range. + signature: update_range(share_name, directory_name, file_name, data, start_range, + end_range, validate_content=False, timeout=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + isRequired: true + types: + - + - name: file_name + description: Name of existing file. + isRequired: true + types: + - + - name: data + description: Content of the range. + isRequired: true + types: + - + - name: start_range + description: 'Start of byte range to use for updating a section of the file. + + The range can be up to 4 MB in size. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of file.' + isRequired: true + types: + - + - name: end_range + description: 'End of byte range to use for updating a section of the file. + + The range can be up to 4 MB in size. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of file.' + isRequired: true + types: + - + - name: validate_content + description: 'If true, calculates an MD5 hash of the page content. The storage + + service checks the hash of the content that has arrived + + with the hash that was sent. This is primarily valuable for detecting + + bitflips on the wire if using http instead of https as https (the default) + + will already validate. Note that this MD5 hash is not stored with the + + file.' + defaultValue: 'False' + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.file.fileservice.FileService.update_range_from_file_url + name: update_range_from_file_url + summary: Writes the bytes from one Azure File endpoint into the specified range + of another Azure File endpoint. + signature: update_range_from_file_url(share_name, directory_name, file_name, start_range, + end_range, source, source_start_range, timeout=None) + parameters: + - name: share_name + description: Name of existing share. + isRequired: true + types: + - + - name: directory_name + description: The path to the directory. + isRequired: true + types: + - + - name: file_name + description: Name of existing file. + isRequired: true + types: + - + - name: start_range + description: 'Start of byte range to use for updating a section of the file. + + The range can be up to 4 MB in size. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of file.' + isRequired: true + types: + - + - name: end_range + description: 'End of byte range to use for updating a section of the file. + + The range can be up to 4 MB in size. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of file.' + isRequired: true + types: + - + - name: source + description: 'A URL of up to 2 KB in length that specifies an Azure file or blob. + + The value should be URL-encoded as it would appear in a request URI. + + If the source is in another account, the source must either be public + + or must be authenticated via a shared access signature. If the source + + is public, no authentication is required. + + Examples: + + [https://myaccount.file.core.windows.net/myshare/mydir/myfile](https://myaccount.file.core.windows.net/myshare/mydir/myfile) + + [https://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken](https://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken)' + isRequired: true + types: + - + - name: source_start_range + description: 'Start of byte range to use for updating a section of the file. + + The range can be up to 4 MB in size. + + The start_range and end_range params are inclusive. + + Ex: start_range=0, end_range=511 will download first 512 bytes of file.' + isRequired: true + types: + - + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - +attributes: +- uid: azure.storage.file.fileservice.FileService.protocol + name: protocol +- uid: azure.storage.file.fileservice.FileService.request_session + name: request_session +- uid: azure.storage.file.fileservice.FileService.socket_timeout + name: socket_timeout +- uid: azure.storage.file.fileservice.FileService.MAX_CHUNK_GET_SIZE + name: MAX_CHUNK_GET_SIZE + signature: MAX_CHUNK_GET_SIZE = 8388608 +- uid: azure.storage.file.fileservice.FileService.MAX_RANGE_SIZE + name: MAX_RANGE_SIZE + signature: MAX_RANGE_SIZE = 4194304 +- uid: azure.storage.file.fileservice.FileService.MAX_SINGLE_GET_SIZE + name: MAX_SINGLE_GET_SIZE + signature: MAX_SINGLE_GET_SIZE = 33554432 diff --git a/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.fileservice.yml b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.fileservice.yml new file mode 100644 index 00000000..44c4c9f1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.fileservice.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.storage.file.fileservice +name: fileservice +fullName: azure.storage.file.fileservice +classes: +- azure.storage.file.fileservice.FileService diff --git a/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.ContentSettings.yml b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.ContentSettings.yml new file mode 100644 index 00000000..da3db9fc --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.ContentSettings.yml @@ -0,0 +1,65 @@ +### YamlMime:PythonClass +uid: azure.storage.file.models.ContentSettings +name: ContentSettings +fullName: azure.storage.file.models.ContentSettings +module: azure.storage.file.models +summary: Used to store the content settings of a file. +constructor: + syntax: ContentSettings(content_type=None, content_encoding=None, content_language=None, + content_disposition=None, cache_control=None, content_md5=None) + parameters: + - name: content_type + defaultValue: None + - name: content_encoding + defaultValue: None + - name: content_language + defaultValue: None + - name: content_disposition + defaultValue: None + - name: cache_control + defaultValue: None + - name: content_md5 + defaultValue: None +variables: +- description: 'The content type specified for the file. If no content type was + + specified, the default content type is application/octet-stream.' + name: content_type + types: + - +- description: 'If content_encoding has previously been set + + for the file, that value is stored.' + name: content_encoding + types: + - +- description: 'If content_language has previously been set + + for the file, that value is stored.' + name: content_language + types: + - +- description: 'content_disposition conveys additional information about how to + + process the response payload, and also can be used to attach + + additional metadata. If content_disposition has previously been set + + for the file, that value is stored.' + name: content_disposition + types: + - +- description: 'If cache_control has previously been set for + + the file, that value is stored.' + name: cache_control + types: + - +- description: 'If the content_md5 has been set for the file, this response + + header is stored so that the client can check for message content + + integrity.' + name: content_md5 + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.CopyProperties.yml b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.CopyProperties.yml new file mode 100644 index 00000000..8928d8ee --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.CopyProperties.yml @@ -0,0 +1,71 @@ +### YamlMime:PythonClass +uid: azure.storage.file.models.CopyProperties +name: CopyProperties +fullName: azure.storage.file.models.CopyProperties +module: azure.storage.file.models +summary: File Copy Properties. +constructor: + syntax: CopyProperties() +variables: +- description: 'String identifier for the last attempted Copy File operation where + this file + + was the destination file. This header does not appear if this file has never + + been the destination in a Copy File operation, or if this file has been + + modified after a concluded Copy File operation using Set File Properties or + + Put File.' + name: id + types: + - +- description: 'URL up to 2 KB in length that specifies the source file used in the + last attempted + + Copy File operation where this file was the destination file. This header does + not + + appear if this file has never been the destination in a Copy File operation, or + if + + this file has been modified after a concluded Copy File operation using + + Set File Properties or Put File.' + name: source + types: + - +- description: "State of the copy operation identified by Copy ID, with these values:\n\ + \ success:\n Copy completed successfully.\n\n pending:\n Copy is\ + \ in progress. Check copy_status_description if intermittent,\n non-fatal\ + \ errors impede copy progress but don't cause failure.\n\n aborted:\n Copy\ + \ was ended by Abort Copy File.\n\n failed:\n Copy failed. See copy_status_description\ + \ for failure details." + name: status + types: + - +- description: 'Contains the number of bytes copied and the total bytes in the source + in the last + + attempted Copy File operation where this file was the destination file. Can show + + between 0 and Content-Length bytes copied.' + name: progress + types: + - +- description: 'Conclusion time of the last attempted Copy File operation where this + file was the + + destination file. This value can specify the time of a completed, aborted, or + + failed copy attempt.' + name: completion_time + types: + - +- description: 'Only appears when x-ms-copy-status is failed or pending. Describes + cause of fatal + + or non-fatal copy operation failure.' + name: status_description + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.DeleteSnapshot.yml b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.DeleteSnapshot.yml new file mode 100644 index 00000000..03f6e41d --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.DeleteSnapshot.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonClass +uid: azure.storage.file.models.DeleteSnapshot +name: DeleteSnapshot +fullName: azure.storage.file.models.DeleteSnapshot +module: azure.storage.file.models +summary: Required if the Share has associated snapshots. Specifies how to handle the + snapshots. +constructor: + syntax: DeleteSnapshot() +attributes: +- uid: azure.storage.file.models.DeleteSnapshot.Include + name: Include + summary: Delete the share and all of its snapshots. + signature: Include = 'include' diff --git a/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.Directory.yml b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.Directory.yml new file mode 100644 index 00000000..66aaa54e --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.Directory.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.storage.file.models.Directory +name: Directory +fullName: azure.storage.file.models.Directory +module: azure.storage.file.models +summary: Directory class. +constructor: + syntax: Directory(name=None, props=None, metadata=None) + parameters: + - name: name + defaultValue: None + - name: props + defaultValue: None + - name: metadata + defaultValue: None +variables: +- description: The name of the directory. + name: name + types: + - +- description: System properties for the directory. + name: properties + types: + - +- description: 'A dict containing name-value pairs associated with the directory as + metadata. + + This var is set to None unless the include=metadata param was included + + for the list directory operation. If this parameter was specified but the + + directory has no metadata, metadata will be set to an empty dictionary.' + name: metadata + types: + - (, ) diff --git a/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.DirectoryProperties.yml b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.DirectoryProperties.yml new file mode 100644 index 00000000..8b192863 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.DirectoryProperties.yml @@ -0,0 +1,27 @@ +### YamlMime:PythonClass +uid: azure.storage.file.models.DirectoryProperties +name: DirectoryProperties +fullName: azure.storage.file.models.DirectoryProperties +module: azure.storage.file.models +summary: File directory's properties class. +constructor: + syntax: DirectoryProperties() +variables: +- description: A datetime object representing the last time the directory was modified. + name: last_modified + types: + - +- description: 'The ETag contains a value that you can use to perform operations + + conditionally.' + name: etag + types: + - +- description: Set to true if the directory metadata is encrypted on the server. + name: server_encrypted + types: + - +- description: SMB related file properties + name: smb_properties + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.File.yml b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.File.yml new file mode 100644 index 00000000..70a05d2b --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.File.yml @@ -0,0 +1,41 @@ +### YamlMime:PythonClass +uid: azure.storage.file.models.File +name: File +fullName: azure.storage.file.models.File +module: azure.storage.file.models +summary: File class. +constructor: + syntax: File(name=None, content=None, props=None, metadata=None) + parameters: + - name: name + defaultValue: None + - name: content + defaultValue: None + - name: props + defaultValue: None + - name: metadata + defaultValue: None +variables: +- description: The name of the file. + name: name + types: + - +- description: File content. + name: content + types: + - + - +- description: System properties for the file. + name: properties + types: + - +- description: 'A dict containing name-value pairs associated with the file as metadata. + + This var is set to None unless the include=metadata param was included + + for the list file operation. If this parameter was specified but the + + file has no metadata, metadata will be set to an empty dictionary.' + name: metadata + types: + - (, ) diff --git a/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.FilePermissions.yml b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.FilePermissions.yml new file mode 100644 index 00000000..5263a5be --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.FilePermissions.yml @@ -0,0 +1,79 @@ +### YamlMime:PythonClass +uid: azure.storage.file.models.FilePermissions +name: FilePermissions +fullName: azure.storage.file.models.FilePermissions +module: azure.storage.file.models +summary: 'FilePermissions class to be used with + + + API.' +constructor: + syntax: FilePermissions(read=False, create=False, write=False, delete=False, _str=None) + parameters: + - name: read + description: 'Read the content, properties, metadata. Use the file as the source + of a copy + + operation.' + defaultValue: 'False' + types: + - + - name: create + description: Create a new file or copy a file to a new file. + defaultValue: 'False' + types: + - + - name: write + description: 'Create or write content, properties, metadata. Resize the file. + Use the file + + as the destination of a copy operation within the same account.' + defaultValue: 'False' + types: + - + - name: delete + description: Delete the file. + defaultValue: 'False' + types: + - + - name: _str + description: A string representing the permissions. + defaultValue: None + types: + - +variables: +- description: Create a new file or copy a file to a new file. + name: FilePermissions.CREATE + types: + - +- description: Delete the file. + name: FilePermissions.DELETE + types: + - +- description: 'Read the content, properties, metadata. Use the file as the source + of a copy + + operation.' + name: FilePermissions.READ + types: + - +- description: 'Create or write content, properties, metadata. Resize the file. Use + the file + + as the destination of a copy operation within the same account.' + name: FilePermissions.WRITE + types: + - +attributes: +- uid: azure.storage.file.models.FilePermissions.CREATE + name: CREATE + signature: CREATE = +- uid: azure.storage.file.models.FilePermissions.DELETE + name: DELETE + signature: DELETE = +- uid: azure.storage.file.models.FilePermissions.READ + name: READ + signature: READ = +- uid: azure.storage.file.models.FilePermissions.WRITE + name: WRITE + signature: WRITE = diff --git a/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.FileProperties.yml b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.FileProperties.yml new file mode 100644 index 00000000..a2e3d033 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.FileProperties.yml @@ -0,0 +1,54 @@ +### YamlMime:PythonClass +uid: azure.storage.file.models.FileProperties +name: FileProperties +fullName: azure.storage.file.models.FileProperties +module: azure.storage.file.models +summary: File Properties. +constructor: + syntax: FileProperties() +variables: +- description: A datetime object representing the last time the file was modified. + name: last_modified + types: + - +- description: 'The ETag contains a value that you can use to perform operations + + conditionally.' + name: etag + types: + - +- description: 'The length of the content returned. If the entire blob was requested, + + the length of blob in bytes. If a subset of the blob was requested, the + + length of the returned subset.' + name: content_length + types: + - +- description: 'Indicates the range of bytes returned in the event that the client + + requested a subset of the blob.' + name: content_range + types: + - +- description: Stores all the content settings for the file. + name: content_settings + types: + - +- description: Stores all the copy properties for the file. + name: copy + types: + - +- description: Set to true if the file data and application metadata are completely + encrypted. + name: server_encrypted + types: + - +- description: SMB related file properties + name: smb_properties + types: + - +- description: Stores all the lease information for the file. + name: lease + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.FileRange.yml b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.FileRange.yml new file mode 100644 index 00000000..e95a9cd6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.FileRange.yml @@ -0,0 +1,22 @@ +### YamlMime:PythonClass +uid: azure.storage.file.models.FileRange +name: FileRange +fullName: azure.storage.file.models.FileRange +module: azure.storage.file.models +summary: File Range. +constructor: + syntax: FileRange(start=None, end=None) + parameters: + - name: start + defaultValue: None + - name: end + defaultValue: None +variables: +- description: Byte index for start of file range. + name: start + types: + - +- description: Byte index for end of file range. + name: end + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.Handle.yml b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.Handle.yml new file mode 100644 index 00000000..754e502d --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.Handle.yml @@ -0,0 +1,68 @@ +### YamlMime:PythonClass +uid: azure.storage.file.models.Handle +name: Handle +fullName: azure.storage.file.models.Handle +module: azure.storage.file.models +summary: Represents a file handle. +constructor: + syntax: Handle(handle_id=None, path=None, file_id=None, parent_id=None, session_id=None, + client_ip=None, open_time=None, last_reconnect_time=None) + parameters: + - name: handle_id + defaultValue: None + - name: path + defaultValue: None + - name: file_id + defaultValue: None + - name: parent_id + defaultValue: None + - name: session_id + defaultValue: None + - name: client_ip + defaultValue: None + - name: open_time + defaultValue: None + - name: last_reconnect_time + defaultValue: None +variables: +- description: Used to identify handle. + name: handle_id + types: + - +- description: Used to identify the name of the object for which the handle is open. + name: path + types: + - +- description: 'Uniquely identifies the file. + + This is useful when renames are happening as the file ID does not change.' + name: file_id + types: + - +- description: 'Uniquely identifies the parent directory. + + This is useful when renames are happening as the parent ID does not change.' + name: parent_id + types: + - +- description: Session ID in context of which the file handle was opened. + name: session_id + types: + - +- description: 'Used to identify client that has opened the handle. + + The field is included only if client IP is known by the service.' + name: client_ip + types: + - +- description: Used to decide if handle may have been leaked. + name: open_time + types: + - +- description: 'Used to decide if handle was reopened after client/server disconnect + due to networking or other faults. + + The field is included only if disconnect event occurred and handle was reopened.' + name: last_reconnect_time + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.LeaseProperties.yml b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.LeaseProperties.yml new file mode 100644 index 00000000..28c45e7d --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.LeaseProperties.yml @@ -0,0 +1,26 @@ +### YamlMime:PythonClass +uid: azure.storage.file.models.LeaseProperties +name: LeaseProperties +fullName: azure.storage.file.models.LeaseProperties +module: azure.storage.file.models +summary: File Lease Properties. +constructor: + syntax: LeaseProperties() +variables: +- description: 'The lease status of the file. + + Possible values: locked|unlocked' + name: status + types: + - +- description: 'Lease state of the file. + + Possible values: available|leased|expired|breaking|broken' + name: state + types: + - +- description: When a file is leased, specifies whether the lease is of infinite or + fixed duration. + name: duration + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.NTFSAttributes.yml b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.NTFSAttributes.yml new file mode 100644 index 00000000..73fc9164 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.NTFSAttributes.yml @@ -0,0 +1,109 @@ +### YamlMime:PythonClass +uid: azure.storage.file.models.NTFSAttributes +name: NTFSAttributes +fullName: azure.storage.file.models.NTFSAttributes +module: azure.storage.file.models +summary: 'Valid set of attributes to set for file or directory. + + To set attribute for directory, ''Directory'' should always be enabled except setting + ''None'' for directory.' +constructor: + syntax: NTFSAttributes(read_only=False, hidden=False, system=False, none=False, + directory=False, archive=False, temporary=False, offline=False, not_content_indexed=False, + no_scrub_data=False, _str=None) + parameters: + - name: read_only + defaultValue: 'False' + - name: hidden + defaultValue: 'False' + - name: system + defaultValue: 'False' + - name: none + defaultValue: 'False' + - name: directory + defaultValue: 'False' + - name: archive + defaultValue: 'False' + - name: temporary + defaultValue: 'False' + - name: offline + defaultValue: 'False' + - name: not_content_indexed + defaultValue: 'False' + - name: no_scrub_data + defaultValue: 'False' + - name: _str + defaultValue: None +variables: +- description: Enable/disable 'ReadOnly' attribute for DIRECTORY or FILE + name: read_only + types: + - +- description: Enable/disable 'Hidden' attribute for DIRECTORY or FILE + name: hidden + types: + - +- description: Enable/disable 'System' attribute for DIRECTORY or FILE + name: system + types: + - +- description: Enable/disable 'None' attribute for DIRECTORY or FILE to clear all + attributes of FILE/DIRECTORY + name: none + types: + - +- description: Enable/disable 'Directory' attribute for DIRECTORY + name: directory + types: + - +- description: Enable/disable 'Archive' attribute for DIRECTORY or FILE + name: archive + types: + - +- description: Enable/disable 'Temporary' attribute for FILE + name: temporary + types: + - +- description: Enable/disable 'Offline' attribute for DIRECTORY or FILE + name: offline + types: + - +- description: Enable/disable 'NotContentIndexed' attribute for DIRECTORY or FILE + name: not_content_indexed + types: + - +- description: Enable/disable 'NoScrubData' attribute for DIRECTORY or FILE + name: no_scrub_data + types: + - +attributes: +- uid: azure.storage.file.models.NTFSAttributes.ARCHIVE + name: ARCHIVE + signature: ARCHIVE = +- uid: azure.storage.file.models.NTFSAttributes.DIRECTORY + name: DIRECTORY + signature: DIRECTORY = +- uid: azure.storage.file.models.NTFSAttributes.HIDDEN + name: HIDDEN + signature: HIDDEN = +- uid: azure.storage.file.models.NTFSAttributes.NONE + name: NONE + signature: NONE = +- uid: azure.storage.file.models.NTFSAttributes.NOT_CONTENT_INDEXED + name: NOT_CONTENT_INDEXED + signature: NOT_CONTENT_INDEXED = +- uid: azure.storage.file.models.NTFSAttributes.NO_SCRUB_DATA + name: NO_SCRUB_DATA + signature: NO_SCRUB_DATA = +- uid: azure.storage.file.models.NTFSAttributes.OFFLINE + name: OFFLINE + signature: OFFLINE = +- uid: azure.storage.file.models.NTFSAttributes.READ_ONLY + name: READ_ONLY + signature: READ_ONLY = +- uid: azure.storage.file.models.NTFSAttributes.SYSTEM + name: SYSTEM + signature: SYSTEM = +- uid: azure.storage.file.models.NTFSAttributes.TEMPORARY + name: TEMPORARY + signature: TEMPORARY = diff --git a/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.SMBProperties.yml b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.SMBProperties.yml new file mode 100644 index 00000000..75587c17 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.SMBProperties.yml @@ -0,0 +1,55 @@ +### YamlMime:PythonClass +uid: azure.storage.file.models.SMBProperties +name: SMBProperties +fullName: azure.storage.file.models.SMBProperties +module: azure.storage.file.models +summary: "SMB related properties to get/set for for file/directory\n\n:ivar str or\ + \ ntfs_attributes:\n The file\ + \ system attributes for files and directories.\n If not set, indicates preservation\ + \ of existing values.\n Here is an example for when the var type is str: 'Temporary|Archive'" +constructor: + syntax: SMBProperties(ntfs_attributes=None, creation_time=None, last_write_time=None, + permission_key=None) + parameters: + - name: ntfs_attributes + defaultValue: None + - name: creation_time + defaultValue: None + - name: last_write_time + defaultValue: None + - name: permission_key + defaultValue: None +variables: +- description: 'When the File or Directory was created. + + If it is a string type, time should have 7 decimal digits, eg. ''2019-07-07T02:52:46.5540162Z''' + name: creation_time + types: + - + - +- description: 'When the File or Directory was last modified. eg. ''2019-07-07T02:52:46.5540162Z'' + + If it is a string type, time should have 7 decimal digits, eg. ''2019-07-07T02:52:46.5540162Z''' + name: last_write_time + types: + - + - +- description: The file's File Permission Key + name: permission_key + types: + - +- description: When the File was last changed. This is what will be returned by service. + Users don't need to specify. + name: change_time + types: + - +- description: The Id of this directory. This is what will be returned by service. + Users don't need to specify. + name: file_id + types: + - +- description: The Id of this directory's parent. This is what will be returned by + service. Users don't need to specify. + name: parent_id + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.Share.yml b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.Share.yml new file mode 100644 index 00000000..17282510 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.Share.yml @@ -0,0 +1,45 @@ +### YamlMime:PythonClass +uid: azure.storage.file.models.Share +name: Share +fullName: azure.storage.file.models.Share +module: azure.storage.file.models +summary: File share class. +constructor: + syntax: Share(name=None, props=None, metadata=None, snapshot=None) + parameters: + - name: name + defaultValue: None + - name: props + defaultValue: None + - name: metadata + defaultValue: None + - name: snapshot + defaultValue: None +variables: +- description: The name of the share. + name: name + types: + - +- description: System properties for the share. + name: properties + types: + - +- description: 'A dict containing name-value pairs associated with the share as metadata. + + This var is set to None unless the include=metadata param was included + + for the list shares operation. If this parameter was specified but the + + share has no metadata, metadata will be set to an empty dictionary.' + name: metadata + types: + - (, ) +- description: 'A DateTime value that uniquely identifies the snapshot. The value + of + + this header indicates the snapshot version, and may be used in + + subsequent requests to access the snapshot.' + name: snapshot + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.SharePermissions.yml b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.SharePermissions.yml new file mode 100644 index 00000000..116cc8a4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.SharePermissions.yml @@ -0,0 +1,98 @@ +### YamlMime:PythonClass +uid: azure.storage.file.models.SharePermissions +name: SharePermissions +fullName: azure.storage.file.models.SharePermissions +module: azure.storage.file.models +summary: 'SharePermissions class to be used with *azure.storage.file.FileService.generate_share_shared_access_signature* + + method and for the AccessPolicies used with *azure.storage.file.FileService.set_share_acl*.' +constructor: + syntax: SharePermissions(read=False, write=False, delete=False, list=False, _str=None) + parameters: + - name: read + description: 'Read the content, properties or metadata of any file in the share. + Use any + + file in the share as the source of a copy operation.' + defaultValue: 'False' + types: + - + - name: write + description: 'For any file in the share, create or write content, properties or + metadata. + + Resize the file. Use the file as the destination of a copy operation within + + the same account. + + Note: You cannot grant permissions to read or write share properties or + + metadata with a service SAS. Use an account SAS instead.' + defaultValue: 'False' + types: + - + - name: delete + description: 'Delete any file in the share. + + Note: You cannot grant permissions to delete a share with a service SAS. Use + + an account SAS instead.' + defaultValue: 'False' + types: + - + - name: list + description: List files and directories in the share. + defaultValue: 'False' + types: + - + - name: _str + description: A string representing the permissions + defaultValue: None + types: + - +variables: +- description: 'Delete any file in the share. + + Note: You cannot grant permissions to delete a share with a service SAS. Use + + an account SAS instead.' + name: FilePermissions.DELETE + types: + - +- description: List files and directories in the share. + name: FilePermissions.LIST + types: + - +- description: 'Read the content, properties or metadata of any file in the share. + Use any + + file in the share as the source of a copy operation.' + name: FilePermissions.READ + types: + - +- description: 'For any file in the share, create or write content, properties or + metadata. + + Resize the file. Use the file as the destination of a copy operation within + + the same account. + + Note: You cannot grant permissions to read or write share properties or + + metadata with a service SAS. Use an account SAS instead.' + name: FilePermissions.WRITE + types: + - +attributes: +- uid: azure.storage.file.models.SharePermissions.DELETE + name: DELETE + signature: DELETE = +- uid: azure.storage.file.models.SharePermissions.LIST + name: LIST + signature: LIST = +- uid: azure.storage.file.models.SharePermissions.READ + name: READ + signature: READ = +- uid: azure.storage.file.models.SharePermissions.WRITE + name: WRITE + signature: WRITE = diff --git a/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.ShareProperties.yml b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.ShareProperties.yml new file mode 100644 index 00000000..4b81e5cc --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.ShareProperties.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonClass +uid: azure.storage.file.models.ShareProperties +name: ShareProperties +fullName: azure.storage.file.models.ShareProperties +module: azure.storage.file.models +summary: File share's properties class. +constructor: + syntax: ShareProperties() +variables: +- description: A datetime object representing the last time the share was modified. + name: last_modified + types: + - +- description: 'The ETag contains a value that you can use to perform operations + + conditionally.' + name: etag + types: + - +- description: Returns the current share quota in GB. + name: quote + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.yml b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.yml new file mode 100644 index 00000000..ff5872d1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.models.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonModule +uid: azure.storage.file.models +name: models +fullName: azure.storage.file.models +classes: +- azure.storage.file.models.ContentSettings +- azure.storage.file.models.CopyProperties +- azure.storage.file.models.DeleteSnapshot +- azure.storage.file.models.Directory +- azure.storage.file.models.DirectoryProperties +- azure.storage.file.models.File +- azure.storage.file.models.FilePermissions +- azure.storage.file.models.FileProperties +- azure.storage.file.models.FileRange +- azure.storage.file.models.Handle +- azure.storage.file.models.LeaseProperties +- azure.storage.file.models.NTFSAttributes +- azure.storage.file.models.SMBProperties +- azure.storage.file.models.Share +- azure.storage.file.models.SharePermissions +- azure.storage.file.models.ShareProperties diff --git a/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.sharedaccesssignature.FileSharedAccessSignature.yml b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.sharedaccesssignature.FileSharedAccessSignature.yml new file mode 100644 index 00000000..d9ff6e0d --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.sharedaccesssignature.FileSharedAccessSignature.yml @@ -0,0 +1,387 @@ +### YamlMime:PythonClass +uid: azure.storage.file.sharedaccesssignature.FileSharedAccessSignature +name: FileSharedAccessSignature +fullName: azure.storage.file.sharedaccesssignature.FileSharedAccessSignature +module: azure.storage.file.sharedaccesssignature +summary: 'Provides a factory for creating file and share access + + signature tokens with a common account name and account key. Users can either + + use the factory or can construct the appropriate service and use the + + generate_*_shared_access_signature method directly.' +constructor: + syntax: FileSharedAccessSignature(account_name, account_key) + parameters: + - name: account_name + description: The storage account name used to generate the shared access signatures. + isRequired: true + types: + - + - name: account_key + description: The access key to generate the shares access signatures. + isRequired: true + types: + - +methods: +- uid: azure.storage.file.sharedaccesssignature.FileSharedAccessSignature.generate_account + name: generate_account + summary: 'Generates a shared access signature for the account. + + Use the returned signature with the sas_token parameter of the service + + or to create a new account object.' + signature: generate_account(services, resource_types, permission, expiry, start=None, + ip=None, protocol=None) + parameters: + - name: services + description: 'Specifies the services accessible with the account SAS. You can + + combine values to provide access to more than one service.' + isRequired: true + types: + - + - name: resource_types + description: 'Specifies the resource types that are accessible with the account + + SAS. You can combine values to provide access to more than one + + resource type.' + isRequired: true + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy. You can combine + + values to provide more than one permission.' + isRequired: true + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + isRequired: true + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. The default + value + + is https,http. See for possible + values.' + defaultValue: None + types: + - +- uid: azure.storage.file.sharedaccesssignature.FileSharedAccessSignature.generate_file + name: generate_file + summary: 'Generates a shared access signature for the file. + + Use the returned signature with the sas_token parameter of FileService.' + signature: generate_file(share_name, directory_name=None, file_name=None, permission=None, + expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, + content_disposition=None, content_encoding=None, content_language=None, content_type=None) + parameters: + - name: share_name + description: Name of share. + isRequired: true + types: + - + - name: directory_name + description: 'Name of directory. SAS tokens cannot be created for directories, + so + + this parameter should only be present if file_name is provided.' + defaultValue: None + types: + - + - name: file_name + description: Name of file. + defaultValue: None + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Permissions must be ordered read, create, write, delete, list. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy.' + defaultValue: None + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + defaultValue: None + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: id + description: 'A unique value up to 64 characters in length that correlates to + a + + stored access policy. To create a stored access policy, use + + set_file_service_properties.' + defaultValue: None + types: + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. The default + value + + is https,http. See for possible + values.' + defaultValue: None + types: + - + - name: cache_control + description: 'Response header value for Cache-Control when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_disposition + description: 'Response header value for Content-Disposition when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_encoding + description: 'Response header value for Content-Encoding when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_language + description: 'Response header value for Content-Language when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_type + description: 'Response header value for Content-Type when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - +- uid: azure.storage.file.sharedaccesssignature.FileSharedAccessSignature.generate_share + name: generate_share + summary: 'Generates a shared access signature for the share. + + Use the returned signature with the sas_token parameter of FileService.' + signature: generate_share(share_name, permission=None, expiry=None, start=None, + id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, + content_encoding=None, content_language=None, content_type=None) + parameters: + - name: share_name + description: Name of share. + isRequired: true + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Permissions must be ordered read, create, write, delete, list. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy.' + defaultValue: None + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + defaultValue: None + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: id + description: 'A unique value up to 64 characters in length that correlates to + a + + stored access policy. To create a stored access policy, use + + set_file_service_properties.' + defaultValue: None + types: + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. The default + value + + is https,http. See for possible + values.' + defaultValue: None + types: + - + - name: cache_control + description: 'Response header value for Cache-Control when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_disposition + description: 'Response header value for Content-Disposition when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_encoding + description: 'Response header value for Content-Encoding when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_language + description: 'Response header value for Content-Language when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - + - name: content_type + description: 'Response header value for Content-Type when resource is accessed + + using this shared access signature.' + defaultValue: None + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.sharedaccesssignature.yml b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.sharedaccesssignature.yml new file mode 100644 index 00000000..388064c9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.sharedaccesssignature.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.storage.file.sharedaccesssignature +name: sharedaccesssignature +fullName: azure.storage.file.sharedaccesssignature +classes: +- azure.storage.file.sharedaccesssignature.FileSharedAccessSignature diff --git a/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.yml b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.yml new file mode 100644 index 00000000..8b9a75c8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-file/azure.storage.file.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.storage.file +name: file +fullName: azure.storage.file +type: rootImport +modules: +- azure.storage.file.fileservice +- azure.storage.file.models +- azure.storage.file.sharedaccesssignature diff --git a/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.models.Queue.yml b/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.models.Queue.yml new file mode 100644 index 00000000..a4de1abb --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.models.Queue.yml @@ -0,0 +1,23 @@ +### YamlMime:PythonClass +uid: azure.storage.queue.models.Queue +name: Queue +fullName: azure.storage.queue.models.Queue +module: azure.storage.queue.models +summary: Queue class. +constructor: + syntax: Queue() +variables: +- description: The name of the queue. + name: name + types: + - +- description: 'A dict containing name-value pairs associated with the queue as metadata. + + This var is set to None unless the include=metadata param was included + + for the list queues operation. If this parameter was specified but the + + queue has no metadata, metadata will be set to an empty dictionary.' + name: metadata + types: + - (, ) diff --git a/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.models.QueueMessage.yml b/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.models.QueueMessage.yml new file mode 100644 index 00000000..28832ba8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.models.QueueMessage.yml @@ -0,0 +1,57 @@ +### YamlMime:PythonClass +uid: azure.storage.queue.models.QueueMessage +name: QueueMessage +fullName: azure.storage.queue.models.QueueMessage +module: azure.storage.queue.models +summary: Queue message class. +constructor: + syntax: QueueMessage() +variables: +- description: 'A GUID value assigned to the message by the Queue service that + + identifies the message in the queue. This value may be used together + + with the value of pop_receipt to delete a message from the queue after + + it has been retrieved with the get messages operation.' + name: id + types: + - +- description: A UTC date value representing the time the messages was inserted. + name: insertion_time + types: + - +- description: A UTC date value representing the time the message expires. + name: expiration_time + types: + - +- description: 'Begins with a value of 1 the first time the message is dequeued. This + + value is incremented each time the message is subsequently dequeued.' + name: dequeue_count + types: + - +- description: 'The message content. Type is determined by the decode_function set + on + + the service. Default is str.' + name: content + types: + - +- description: 'A receipt str which can be used together with the message_id element + to + + delete a message from the queue after it has been retrieved with the get + + messages operation. Only returned by get messages operations. Set to + + None for peek messages.' + name: pop_receipt + types: + - +- description: 'A UTC date value representing the time the message will next be visible. + + Only returned by get messages operations. Set to None for peek messages.' + name: time_next_visible + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.models.QueueMessageFormat.yml b/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.models.QueueMessageFormat.yml new file mode 100644 index 00000000..b14fa6ba --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.models.QueueMessageFormat.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.storage.queue.models.QueueMessageFormat +name: QueueMessageFormat +fullName: azure.storage.queue.models.QueueMessageFormat +module: azure.storage.queue.models +summary: 'Encoding and decoding methods which can be used to modify how the queue + service + + encodes and decodes queue messages. Set these to queueservice.encode_function + + and queueservice.decode_function to modify the behavior. The defaults are + + text_xmlencode and text_xmldecode, respectively.' +constructor: + syntax: QueueMessageFormat() +methods: +- uid: azure.storage.queue.models.QueueMessageFormat.binary_base64decode + name: binary_base64decode + summary: Base64 decode to byte string. + signature: static binary_base64decode(data) + parameters: + - name: data + description: Data to decode to a byte string. + isRequired: true + types: + - + return: + description: Base64 decoded data. + types: + - +- uid: azure.storage.queue.models.QueueMessageFormat.binary_base64encode + name: binary_base64encode + summary: Base64 encode byte strings. + signature: static binary_base64encode(data) + parameters: + - name: data + description: Binary string to encode. + isRequired: true + types: + - + return: + description: Base64 encoded data. + types: + - +- uid: azure.storage.queue.models.QueueMessageFormat.nodecode + name: nodecode + summary: Do no decoding. + signature: static nodecode(data) + parameters: + - name: data + description: Data. + isRequired: true + types: + - + return: + description: The data passed in is returned unmodified. + types: + - +- uid: azure.storage.queue.models.QueueMessageFormat.noencode + name: noencode + summary: Do no encoding. + signature: static noencode(data) + parameters: + - name: data + description: Data. + isRequired: true + types: + - + return: + description: The data passed in is returned unmodified. + types: + - +- uid: azure.storage.queue.models.QueueMessageFormat.text_base64decode + name: text_base64decode + summary: Base64 decode to unicode text. + signature: static text_base64decode(data) + parameters: + - name: data + description: String data to decode to unicode. + isRequired: true + types: + - + return: + description: Base64 decoded string. + types: + - +- uid: azure.storage.queue.models.QueueMessageFormat.text_base64encode + name: text_base64encode + summary: Base64 encode unicode text. + signature: static text_base64encode(data) + parameters: + - name: data + description: String to encode. + isRequired: true + types: + - + return: + description: Base64 encoded string. + types: + - +- uid: azure.storage.queue.models.QueueMessageFormat.text_xmldecode + name: text_xmldecode + summary: XML decode to unicode text. + signature: static text_xmldecode(data) + parameters: + - name: data + description: Data to decode to unicode. + isRequired: true + types: + - + return: + description: XML decoded data. + types: + - +- uid: azure.storage.queue.models.QueueMessageFormat.text_xmlencode + name: text_xmlencode + summary: XML encode unicode text. + signature: static text_xmlencode(data) + parameters: + - name: data + description: Unicode string to encode + isRequired: true + types: + - + return: + description: XML encoded data. + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.models.QueuePermissions.yml b/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.models.QueuePermissions.yml new file mode 100644 index 00000000..69bad564 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.models.QueuePermissions.yml @@ -0,0 +1,72 @@ +### YamlMime:PythonClass +uid: azure.storage.queue.models.QueuePermissions +name: QueuePermissions +fullName: azure.storage.queue.models.QueuePermissions +module: azure.storage.queue.models +summary: 'QueuePermissions class to be used with + + method and for the AccessPolicies used with .' +constructor: + syntax: QueuePermissions(read=False, add=False, update=False, process=False, _str=None) + parameters: + - name: read + description: Read metadata and properties, including message count. Peek at messages. + defaultValue: 'False' + types: + - + - name: add + description: Add messages to the queue. + defaultValue: 'False' + types: + - + - name: update + description: 'Update messages in the queue. Note: Use the Process permission with + + Update so you can first get the message you want to update.' + defaultValue: 'False' + types: + - + - name: process + description: Get and delete messages from the queue. + defaultValue: 'False' + types: + - + - name: _str + description: A string representing the permissions. + defaultValue: None + types: + - +variables: +- description: Read metadata and properties, including message count. Peek at messages. + name: QueuePermissions.READ + types: + - +- description: Add messages to the queue. + name: QueuePermissions.ADD + types: + - +- description: 'Update messages in the queue. Note: Use the Process permission with + + Update so you can first get the message you want to update.' + name: QueuePermissions.UPDATE + types: + - +- description: 'Delete entities. + + Get and delete messages from the queue.' + name: QueuePermissions.PROCESS + types: + - +attributes: +- uid: azure.storage.queue.models.QueuePermissions.ADD + name: ADD + signature: ADD = +- uid: azure.storage.queue.models.QueuePermissions.PROCESS + name: PROCESS + signature: PROCESS = +- uid: azure.storage.queue.models.QueuePermissions.READ + name: READ + signature: READ = +- uid: azure.storage.queue.models.QueuePermissions.UPDATE + name: UPDATE + signature: UPDATE = diff --git a/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.models.yml b/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.models.yml new file mode 100644 index 00000000..4158f5c5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.models.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonModule +uid: azure.storage.queue.models +name: models +fullName: azure.storage.queue.models +classes: +- azure.storage.queue.models.Queue +- azure.storage.queue.models.QueueMessage +- azure.storage.queue.models.QueueMessageFormat +- azure.storage.queue.models.QueuePermissions diff --git a/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.queueservice.QueueService.yml b/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.queueservice.QueueService.yml new file mode 100644 index 00000000..074548a6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.queueservice.QueueService.yml @@ -0,0 +1,1116 @@ +### YamlMime:PythonClass +uid: azure.storage.queue.queueservice.QueueService +name: QueueService +fullName: azure.storage.queue.queueservice.QueueService +module: azure.storage.queue.queueservice +summary: 'This is the main class managing queue resources. + + + The Queue service stores messages. A queue can contain an unlimited number of + + messages, each of which can be up to 64KB in size. Messages are generally added + + to the end of the queue and retrieved from the front of the queue, although + + first in, first out (FIFO) behavior is not guaranteed. + + + :type *~azure.storage.common.TokenCredential*' +constructor: + syntax: QueueService(account_name=None, account_key=None, sas_token=None, is_emulated=False, + protocol='https', endpoint_suffix='core.windows.net', request_session=None, connection_string=None, + socket_timeout=None, token_credential=None) + parameters: + - name: account_name + description: 'The storage account name. This is used to authenticate requests + + signed with an account key and to construct the storage endpoint. It + + is required unless a connection string is given.' + defaultValue: None + types: + - + - name: account_key + description: The storage account key. This is used for shared key authentication. + defaultValue: None + types: + - + - name: sas_token + description: 'A shared access signature token to use to authenticate requests + + instead of the account key. If account key and sas token are both + + specified, account key will be used to sign.' + defaultValue: None + types: + - + - name: is_emulated + description: 'Whether to use the emulator. Defaults to False. If specified, will + + override all other parameters besides connection string and request + + session.' + defaultValue: 'False' + types: + - + - name: protocol + description: The protocol to use for requests. Defaults to https. + defaultValue: https + types: + - + - name: endpoint_suffix + description: 'The host base component of the url, minus the account name. Defaults + + to Azure (core.windows.net). Override this to use the China cloud + + (core.chinacloudapi.cn).' + defaultValue: core.windows.net + types: + - + - name: request_session + description: The session object to use for http requests. + defaultValue: None + types: + - + - name: connection_string + description: 'If specified, this will override all other parameters besides + + request session. See + + [http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/](http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/) + + for the connection string format.' + defaultValue: None + types: + - + - name: socket_timeout + description: 'If specified, this will override the default socket timeout. The + timeout specified is in seconds. + + See DEFAULT_SOCKET_TIMEOUT in _constants.py for the default value.' + defaultValue: None + types: + - + - name: token_credential + description: 'A token credential used to authenticate HTTPS requests. The token + value + + should be updated before its expiration.' + defaultValue: None +variables: +- description: 'A function used to encode queue messages. Takes as + + a parameter the data passed to the put_message API and returns the encoded + + message. Defaults to take text and xml encode, but bytes and other + + encodings can be used. For example, base64 may be preferable for developing + + across multiple Azure Storage libraries in different languages. See the + + for xml, base64 and + + no encoding methods as well as binary equivalents.' + name: encode_function + types: + - () +- description: 'A function used to encode decode messages. Takes as + + a parameter the data returned by the get_messages and peek_messages APIs and + + returns the decoded message. Defaults to return text and xml decode, but + + bytes and other decodings can be used. For example, base64 may be preferable + + for developing across multiple Azure Storage libraries in different languages. + + See the for xml, base64 + + and no decoding methods as well as binary equivalents.' + name: decode_function + types: + - () +- description: "The key-encryption-key optionally provided by the user. If provided,\ + \ will be used to\nencrypt/decrypt in supported methods.\nFor methods requiring\ + \ decryption, either the key_encryption_key OR the resolver must be provided.\n\ + If both are provided, the resolver will take precedence.\nMust implement the following\ + \ methods for APIs requiring encryption:\nwrap_key(key)\u2013wraps the specified\ + \ key (bytes) using an algorithm of the user's choice. Returns the encrypted key\ + \ as bytes.\nget_key_wrap_algorithm()\u2013returns the algorithm used to wrap\ + \ the specified symmetric key.\nget_kid()\u2013returns a string key id for this\ + \ key-encryption-key.\nMust implement the following methods for APIs requiring\ + \ decryption:\nunwrap_key(key, algorithm)\u2013returns the unwrapped form of the\ + \ specified symmetric key using the string-specified algorithm.\nget_kid()\u2013\ + returns a string key id for this key-encryption-key." + name: key_encryption_key + types: + - +- description: 'A function to resolve keys optionally provided by the user. If provided, + will be used to decrypt in supported methods. + + For methods requiring decryption, either the key_encryption_key OR + + the resolver must be provided. If both are provided, the resolver will take precedence. + + It uses the kid string to return a key-encryption-key implementing the interface + defined above.' + name: key_resolver_function + types: + - kid) ( +- description: 'A flag that may be set to ensure that all messages successfully uploaded + to the queue and all those downloaded and + + successfully read from the queue are/were encrypted while on the server. If this + flag is set, all required + + parameters for encryption/decryption must be provided. See the above comments + on the key_encryption_key and resolver.' + name: require_encryption + types: + - +methods: +- uid: azure.storage.queue.queueservice.QueueService.clear_messages + name: clear_messages + summary: Deletes all messages from the specified queue. + signature: clear_messages(queue_name, timeout=None) + parameters: + - name: queue_name + description: The name of the queue whose messages to clear. + isRequired: true + types: + - + - name: timeout + description: The server timeout, expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.queue.queueservice.QueueService.create_queue + name: create_queue + summary: Creates a queue under the given account. + signature: create_queue(queue_name, metadata=None, fail_on_exist=False, timeout=None) + parameters: + - name: queue_name + description: 'The name of the queue to create. A queue name must be from 3 through + + 63 characters long and may only contain lowercase letters, numbers, + + and the dash (-) character. The first and last letters in the queue + + must be alphanumeric. The dash (-) character cannot be the first or + + last character. Consecutive dash characters are not permitted in the + + queue name.' + isRequired: true + types: + - + - name: metadata + description: 'A dict containing name-value pairs to associate with the queue as + + metadata. Note that metadata names preserve the case with which they + + were created, but are case-insensitive when set or read.' + defaultValue: None + types: + - (, ) + - name: fail_on_exist + description: Specifies whether to throw an exception if the queue already exists. + defaultValue: 'False' + types: + - + - name: timeout + description: The server timeout, expressed in seconds. + defaultValue: None + types: + - + return: + description: 'A boolean indicating whether the queue was created. If fail_on_exist + + was set to True, this will throw instead of returning false.' + types: + - +- uid: azure.storage.queue.queueservice.QueueService.delete_message + name: delete_message + summary: 'Deletes the specified message. + + + Normally after a client retrieves a message with the get_messages operation, + + the client is expected to process and delete the message. To delete the + + message, you must have two items of data: id and pop_receipt. The + + id is returned from the previous get_messages operation. The + + pop_receipt is returned from the most recent + or + + operation. + In order for the delete_message operation + + to succeed, the pop_receipt specified on the request must match the + + pop_receipt returned from the + or + + operation.' + signature: delete_message(queue_name, message_id, pop_receipt, timeout=None) + parameters: + - name: queue_name + description: The name of the queue from which to delete the message. + isRequired: true + types: + - + - name: message_id + description: The message id identifying the message to delete. + isRequired: true + types: + - + - name: pop_receipt + description: 'A valid pop receipt value returned from an earlier call + + to the or + .' + isRequired: true + types: + - + - name: timeout + description: The server timeout, expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.queue.queueservice.QueueService.delete_queue + name: delete_queue + summary: 'Deletes the specified queue and any messages it contains. + + + When a queue is successfully deleted, it is immediately marked for deletion + + and is no longer accessible to clients. The queue is later removed from + + the Queue service during garbage collection. + + + Note that deleting a queue is likely to take at least 40 seconds to complete. + + If an operation is attempted against the queue while it was being deleted, + + an will be thrown.' + signature: delete_queue(queue_name, fail_not_exist=False, timeout=None) + parameters: + - name: queue_name + description: The name of the queue to delete. + isRequired: true + types: + - + - name: fail_not_exist + description: Specifies whether to throw an exception if the queue doesn't exist. + defaultValue: 'False' + types: + - + - name: timeout + description: The server timeout, expressed in seconds. + defaultValue: None + types: + - + return: + description: 'A boolean indicating whether the queue was deleted. If fail_not_exist + + was set to True, this will throw instead of returning false.' + types: + - +- uid: azure.storage.queue.queueservice.QueueService.exists + name: exists + summary: Returns a boolean indicating whether the queue exists. + signature: exists(queue_name, timeout=None) + parameters: + - name: queue_name + description: The name of queue to check for existence. + isRequired: true + types: + - + - name: timeout + description: The server timeout, expressed in seconds. + defaultValue: None + types: + - + return: + description: A boolean indicating whether the queue exists. + types: + - +- uid: azure.storage.queue.queueservice.QueueService.extract_date_and_request_id + name: extract_date_and_request_id + signature: static extract_date_and_request_id(retry_context) + parameters: + - name: retry_context + isRequired: true +- uid: azure.storage.queue.queueservice.QueueService.generate_account_shared_access_signature + name: generate_account_shared_access_signature + summary: 'Generates a shared access signature for the queue service. + + Use the returned signature with the sas_token parameter of QueueService.' + signature: generate_account_shared_access_signature(resource_types, permission, + expiry, start=None, ip=None, protocol=None) + parameters: + - name: resource_types + description: Specifies the resource types that are accessible with the account + SAS. + isRequired: true + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy.' + isRequired: true + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + isRequired: true + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. The default + value + + is https,http. See for possible + values.' + defaultValue: None + types: + - + return: + description: A Shared Access Signature (sas) token. + types: + - +- uid: azure.storage.queue.queueservice.QueueService.generate_queue_shared_access_signature + name: generate_queue_shared_access_signature + summary: 'Generates a shared access signature for the queue. + + Use the returned signature with the sas_token parameter of QueueService.' + signature: generate_queue_shared_access_signature(queue_name, permission=None, expiry=None, + start=None, id=None, ip=None, protocol=None) + parameters: + - name: queue_name + description: The name of the queue to create a SAS token for. + isRequired: true + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy.' + defaultValue: None + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + defaultValue: None + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: id + description: 'A unique value up to 64 characters in length that correlates to + a + + stored access policy. To create a stored access policy, use .' + defaultValue: None + types: + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=''168.1.5.65'' or sip=''168.1.5.60-168.1.5.70'' + on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. The default + value + + is https,http. See for possible + values.' + defaultValue: None + types: + - + return: + description: A Shared Access Signature (sas) token. + types: + - +- uid: azure.storage.queue.queueservice.QueueService.get_messages + name: get_messages + summary: 'Retrieves one or more messages from the front of the queue. + + + When a message is retrieved from the queue, the response includes the message + + content and a pop_receipt value, which is required to delete the message. + + The message is not automatically deleted from the queue, but after it has + + been retrieved, it is not visible to other clients for the time interval + + specified by the visibility_timeout parameter. + + + If the key-encryption-key or resolver field is set on the local service object, + the messages will be + + decrypted before being returned.' + signature: get_messages(queue_name, num_messages=None, visibility_timeout=None, + timeout=None) + parameters: + - name: queue_name + description: The name of the queue to get messages from. + isRequired: true + types: + - + - name: num_messages + description: 'A nonzero integer value that specifies the number of + + messages to retrieve from the queue, up to a maximum of 32. If + + fewer are visible, the visible messages are returned. By default, + + a single message is retrieved from the queue with this operation.' + defaultValue: None + types: + - + - name: visibility_timeout + description: 'Specifies the new visibility timeout value, in seconds, relative + + to server time. The new value must be larger than or equal to 1 + + second, and cannot be larger than 7 days. The visibility timeout of + + a message can be set to a value later than the expiry time.' + defaultValue: None + types: + - + - name: timeout + description: The server timeout, expressed in seconds. + defaultValue: None + types: + - + return: + description: A object representing + the information passed. + types: + - () +- uid: azure.storage.queue.queueservice.QueueService.get_queue_acl + name: get_queue_acl + summary: 'Returns details about any stored access policies specified on the + + queue that may be used with Shared Access Signatures.' + signature: get_queue_acl(queue_name, timeout=None) + parameters: + - name: queue_name + description: The name of an existing queue. + isRequired: true + types: + - + - name: timeout + description: The server timeout, expressed in seconds. + defaultValue: None + types: + - + return: + description: A dictionary of access policies associated with the queue. + types: + - (, ) +- uid: azure.storage.queue.queueservice.QueueService.get_queue_metadata + name: get_queue_metadata + summary: 'Retrieves user-defined metadata and queue properties on the specified + + queue. Metadata is associated with the queue as name-value pairs.' + signature: get_queue_metadata(queue_name, timeout=None) + parameters: + - name: queue_name + description: The name of an existing queue. + isRequired: true + types: + - + - name: timeout + description: The server timeout, expressed in seconds. + defaultValue: None + types: + - + return: + description: 'A dictionary representing the queue metadata with an + + approximate_message_count int property on the dict estimating the + + number of messages in the queue.' + types: + - (, ) +- uid: azure.storage.queue.queueservice.QueueService.get_queue_service_properties + name: get_queue_service_properties + summary: 'Gets the properties of a storage account''s Queue service, including + + logging, analytics and CORS rules.' + signature: get_queue_service_properties(timeout=None) + parameters: + - name: timeout + description: The server timeout, expressed in seconds. + defaultValue: None + types: + - + return: + description: The queue service properties. + types: + - +- uid: azure.storage.queue.queueservice.QueueService.get_queue_service_stats + name: get_queue_service_stats + summary: 'Retrieves statistics related to replication for the Queue service. It + is + + only available when read-access geo-redundant replication is enabled for + + the storage account. + + + With geo-redundant replication, Azure Storage maintains your data durable + + in two locations. In both locations, Azure Storage constantly maintains + + multiple healthy replicas of your data. The location where you read, + + create, update, or delete data is the primary storage account location. + + The primary location exists in the region you choose at the time you + + create an account via the Azure Management Azure classic portal, for + + example, North Central US. The location to which your data is replicated + + is the secondary location. The secondary location is automatically + + determined based on the location of the primary; it is in a second data + + center that resides in the same region as the primary location. Read-only + + access is available from the secondary location, if read-access geo-redundant + + replication is enabled for your storage account.' + signature: get_queue_service_stats(timeout=None) + parameters: + - name: timeout + description: The timeout parameter is expressed in seconds. + defaultValue: None + types: + - + return: + description: The queue service stats. + types: + - +- uid: azure.storage.queue.queueservice.QueueService.list_queues + name: list_queues + summary: 'Returns a generator to list the queues. The generator will lazily follow + + the continuation tokens returned by the service and stop when all queues + + have been returned or num_results is reached. + + + If num_results is specified and the account has more than that number of + + queues, the generator will have a populated next_marker field once it + + finishes. This marker can be used to create a new generator if more + + results are desired.' + signature: list_queues(prefix=None, num_results=None, include_metadata=False, marker=None, + timeout=None) + parameters: + - name: prefix + description: 'Filters the results to return only queues with names that begin + + with the specified prefix.' + defaultValue: None + types: + - + - name: num_results + description: The maximum number of queues to return. + defaultValue: None + types: + - + - name: include_metadata + description: Specifies that container metadata be returned in the response. + defaultValue: 'False' + types: + - + - name: marker + description: 'An opaque continuation token. This value can be retrieved from the + + next_marker field of a previous generator object if num_results was + + specified and that generator has finished enumerating results. If + + specified, this generator will begin returning results from the point + + where the previous generator stopped.' + defaultValue: None + types: + - + - name: timeout + description: 'The server timeout, expressed in seconds. This function may make + multiple + + calls to the service in which case the timeout value specified will be + + applied to each individual call.' + defaultValue: None + types: + - +- uid: azure.storage.queue.queueservice.QueueService.peek_messages + name: peek_messages + summary: 'Retrieves one or more messages from the front of the queue, but does + + not alter the visibility of the message. + + + Only messages that are visible may be retrieved. When a message is retrieved + + for the first time with a call to get_messages, its dequeue_count property + + is set to 1. If it is not deleted and is subsequently retrieved again, the + + dequeue_count property is incremented. The client may use this value to + + determine how many times a message has been retrieved. Note that a call + + to peek_messages does not increment the value of DequeueCount, but returns + + this value for the client to read. + + + If the key-encryption-key or resolver field is set on the local service object, + the messages will be + + decrypted before being returned.' + signature: peek_messages(queue_name, num_messages=None, timeout=None) + parameters: + - name: queue_name + description: The name of the queue to peek messages from. + isRequired: true + types: + - + - name: num_messages + description: 'A nonzero integer value that specifies the number of + + messages to peek from the queue, up to a maximum of 32. By default, + + a single message is peeked from the queue with this operation.' + defaultValue: None + types: + - + - name: timeout + description: The server timeout, expressed in seconds. + defaultValue: None + types: + - + return: + description: 'A list of objects. + Note that + + time_next_visible and pop_receipt will not be populated as peek does + + not pop the message and can only retrieve already visible messages.' + types: + - () +- uid: azure.storage.queue.queueservice.QueueService.put_message + name: put_message + summary: 'Adds a new message to the back of the message queue. + + + The visibility timeout specifies the time that the message will be + + invisible. After the timeout expires, the message will become visible. + + If a visibility timeout is not specified, the default value of 0 is used. + + + The message time-to-live specifies how long a message will remain in the + + queue. The message will be deleted from the queue when the time-to-live + + period expires. + + + If the key-encryption-key field is set on the local service object, this method + will + + encrypt the content before uploading.' + signature: put_message(queue_name, content, visibility_timeout=None, time_to_live=None, + timeout=None) + parameters: + - name: queue_name + description: The name of the queue to put the message into. + isRequired: true + types: + - + - name: content + description: 'Message content. Allowed type is determined by the encode_function + + set on the service. Default is str. The encoded message can be up to + + 64KB in size.' + isRequired: true + types: + - + - name: visibility_timeout + description: 'If not specified, the default value is 0. Specifies the + + new visibility timeout value, in seconds, relative to server time. + + The value must be larger than or equal to 0, and cannot be + + larger than 7 days. The visibility timeout of a message cannot be + + set to a value later than the expiry time. visibility_timeout + + should be set to a value smaller than the time-to-live value.' + defaultValue: None + types: + - + - name: time_to_live + description: 'Specifies the time-to-live interval for the message, in + + seconds. The time-to-live may be any positive number or -1 for infinity. If + this + + parameter is omitted, the default time-to-live is 7 days.' + defaultValue: None + types: + - + - name: timeout + description: The server timeout, expressed in seconds. + defaultValue: None + types: + - + return: + description: 'A object. + + This object is also populated with the content although it is not + + returned from the service.' + types: + - +- uid: azure.storage.queue.queueservice.QueueService.set_proxy + name: set_proxy + summary: Sets the proxy server host and port for the HTTP CONNECT Tunnelling. + signature: set_proxy(host, port, user=None, password=None) + parameters: + - name: host + description: 'Address of the proxy. Ex: ''192.168.0.100''' + isRequired: true + types: + - + - name: port + description: 'Port of the proxy. Ex: 6000' + isRequired: true + types: + - + - name: user + description: User for proxy authorization. + defaultValue: None + types: + - + - name: password + description: Password for proxy authorization. + defaultValue: None + types: + - +- uid: azure.storage.queue.queueservice.QueueService.set_queue_acl + name: set_queue_acl + summary: 'Sets stored access policies for the queue that may be used with Shared + + Access Signatures. + + + When you set permissions for a queue, the existing permissions are replaced. + + To update the queue''s permissions, call + to fetch + + all access policies associated with the queue, modify the access policy + + that you wish to change, and then call this function with the complete + + set of data to perform the update. + + + When you establish a stored access policy on a queue, it may take up to + + 30 seconds to take effect. During this interval, a shared access signature + + that is associated with the stored access policy will throw an + + until the access policy + becomes active.' + signature: set_queue_acl(queue_name, signed_identifiers=None, timeout=None) + parameters: + - name: queue_name + description: The name of an existing queue. + isRequired: true + types: + - + - name: signed_identifiers + description: 'A dictionary of access policies to associate with the queue. The + + dictionary may contain up to 5 elements. An empty dictionary + + will clear the access policies set on the service.' + defaultValue: None + types: + - dict(str, ) + - name: timeout + description: The server timeout, expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.queue.queueservice.QueueService.set_queue_metadata + name: set_queue_metadata + summary: 'Sets user-defined metadata on the specified queue. Metadata is + + associated with the queue as name-value pairs.' + signature: set_queue_metadata(queue_name, metadata=None, timeout=None) + parameters: + - name: queue_name + description: The name of an existing queue. + isRequired: true + types: + - + - name: metadata + description: 'A dict containing name-value pairs to associate with the + + queue as metadata.' + defaultValue: None + types: + - + - name: timeout + description: The server timeout, expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.queue.queueservice.QueueService.set_queue_service_properties + name: set_queue_service_properties + summary: 'Sets the properties of a storage account''s Queue service, including + + Azure Storage Analytics. If an element (ex Logging) is left as None, the + + existing settings on the service for that functionality are preserved. + + For more information on Azure Storage Analytics, see + + [https://msdn.microsoft.com/en-us/library/azure/hh343270.aspx](https://msdn.microsoft.com/en-us/library/azure/hh343270.aspx).' + signature: set_queue_service_properties(logging=None, hour_metrics=None, minute_metrics=None, + cors=None, timeout=None) + parameters: + - name: logging + description: The logging settings provide request logs. + defaultValue: None + types: + - + - name: hour_metrics + description: 'The hour metrics settings provide a summary of request + + statistics grouped by API in hourly aggregates for queuess.' + defaultValue: None + types: + - + - name: minute_metrics + description: 'The minute metrics settings provide request statistics + + for each minute for queues.' + defaultValue: None + types: + - + - name: cors + description: 'You can include up to five CorsRule elements in the + + list. If an empty list is specified, all CORS rules will be deleted, + + and CORS will be disabled for the service. For detailed information + + about CORS rules and evaluation logic, see + + [https://msdn.microsoft.com/en-us/library/azure/dn535601.aspx](https://msdn.microsoft.com/en-us/library/azure/dn535601.aspx).' + defaultValue: None + types: + - list() + - name: timeout + description: The server timeout, expressed in seconds. + defaultValue: None + types: + - +- uid: azure.storage.queue.queueservice.QueueService.update_message + name: update_message + summary: 'Updates the visibility timeout of a message. You can also use this + + operation to update the contents of a message. + + + This operation can be used to continually extend the invisibility of a + + queue message. This functionality can be useful if you want a worker role + + to "lease" a queue message. For example, if a worker role calls get_messages + + and recognizes that it needs more time to process a message, it can + + continually extend the message''s invisibility until it is processed. If + + the worker role were to fail during processing, eventually the message + + would become visible again and another worker role could process it. + + + If the key-encryption-key field is set on the local service object, this method + will + + encrypt the content before uploading.' + signature: update_message(queue_name, message_id, pop_receipt, visibility_timeout, + content=None, timeout=None) + parameters: + - name: queue_name + description: The name of the queue containing the message to update. + isRequired: true + types: + - + - name: message_id + description: The message id identifying the message to update. + isRequired: true + types: + - + - name: pop_receipt + description: 'A valid pop receipt value returned from an earlier call + + to the or + operation.' + isRequired: true + types: + - + - name: visibility_timeout + description: 'Specifies the new visibility timeout value, in seconds, + + relative to server time. The new value must be larger than or equal + + to 0, and cannot be larger than 7 days. The visibility timeout of a + + message cannot be set to a value later than the expiry time. A + + message can be updated until it has been deleted or has expired.' + isRequired: true + types: + - + - name: content + description: 'Message content. Allowed type is determined by the encode_function + + set on the service. Default is str.' + defaultValue: None + types: + - + - name: timeout + description: The server timeout, expressed in seconds. + defaultValue: None + types: + - + return: + description: 'A list of objects. + For convenience, + + this object is also populated with the content, although it is not returned + by the service.' + types: + - () +attributes: +- uid: azure.storage.queue.queueservice.QueueService.protocol + name: protocol +- uid: azure.storage.queue.queueservice.QueueService.request_session + name: request_session +- uid: azure.storage.queue.queueservice.QueueService.socket_timeout + name: socket_timeout diff --git a/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.queueservice.yml b/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.queueservice.yml new file mode 100644 index 00000000..e6d53a41 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.queueservice.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.storage.queue.queueservice +name: queueservice +fullName: azure.storage.queue.queueservice +classes: +- azure.storage.queue.queueservice.QueueService diff --git a/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.sharedaccesssignature.QueueSharedAccessSignature.yml b/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.sharedaccesssignature.QueueSharedAccessSignature.yml new file mode 100644 index 00000000..f37fcad7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.sharedaccesssignature.QueueSharedAccessSignature.yml @@ -0,0 +1,211 @@ +### YamlMime:PythonClass +uid: azure.storage.queue.sharedaccesssignature.QueueSharedAccessSignature +name: QueueSharedAccessSignature +fullName: azure.storage.queue.sharedaccesssignature.QueueSharedAccessSignature +module: azure.storage.queue.sharedaccesssignature +summary: 'Provides a factory for creating queue shares access + + signature tokens with a common account name and account key. Users can either + + use the factory or can construct the appropriate service and use the + + generate_*_shared_access_signature method directly.' +constructor: + syntax: QueueSharedAccessSignature(account_name, account_key) + parameters: + - name: account_name + description: The storage account name used to generate the shared access signatures. + isRequired: true + types: + - + - name: account_key + description: The access key to generate the shares access signatures. + isRequired: true + types: + - +methods: +- uid: azure.storage.queue.sharedaccesssignature.QueueSharedAccessSignature.generate_account + name: generate_account + summary: 'Generates a shared access signature for the account. + + Use the returned signature with the sas_token parameter of the service + + or to create a new account object.' + signature: generate_account(services, resource_types, permission, expiry, start=None, + ip=None, protocol=None) + parameters: + - name: services + description: 'Specifies the services accessible with the account SAS. You can + + combine values to provide access to more than one service.' + isRequired: true + types: + - + - name: resource_types + description: 'Specifies the resource types that are accessible with the account + + SAS. You can combine values to provide access to more than one + + resource type.' + isRequired: true + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy. You can combine + + values to provide more than one permission.' + isRequired: true + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + isRequired: true + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. The default + value + + is https,http. See for possible + values.' + defaultValue: None + types: + - +- uid: azure.storage.queue.sharedaccesssignature.QueueSharedAccessSignature.generate_queue + name: generate_queue + summary: 'Generates a shared access signature for the queue. + + Use the returned signature with the sas_token parameter of QueueService.' + signature: generate_queue(queue_name, permission=None, expiry=None, start=None, + id=None, ip=None, protocol=None) + parameters: + - name: queue_name + description: Name of queue. + isRequired: true + types: + - + - name: permission + description: 'The permissions associated with the shared access signature. The + + user is restricted to operations allowed by the permissions. + + Permissions must be ordered read, add, update, process. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has been + + specified in an associated stored access policy.' + defaultValue: None + types: + - + - name: expiry + description: 'The time at which the shared access signature becomes invalid. + + Required unless an id is given referencing a stored access policy + + which contains this field. This field must be omitted if it has + + been specified in an associated stored access policy. Azure will always + + convert values to UTC. If a date is passed in without timezone info, it + + is assumed to be UTC.' + defaultValue: None + types: + - + - + - name: start + description: 'The time at which the shared access signature becomes valid. If + + omitted, start time for this call is assumed to be the time when the + + storage service receives the request. Azure will always convert values + + to UTC. If a date is passed in without timezone info, it is assumed to + + be UTC.' + defaultValue: None + types: + - + - + - name: id + description: 'A unique value up to 64 characters in length that correlates to + a + + stored access policy. To create a stored access policy, use + + set_blob_service_properties.' + defaultValue: None + types: + - + - name: ip + description: 'Specifies an IP address or a range of IP addresses from which to + accept requests. + + If the IP address from which the request originates does not match the IP address + + or address range specified on the SAS token, the request is not authenticated. + + For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS + + restricts the request to those IP addresses.' + defaultValue: None + types: + - + - name: protocol + description: 'Specifies the protocol permitted for a request made. The default + value + + is https,http. See for possible + values.' + defaultValue: None + types: + - diff --git a/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.sharedaccesssignature.yml b/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.sharedaccesssignature.yml new file mode 100644 index 00000000..be6af125 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.sharedaccesssignature.yml @@ -0,0 +1,6 @@ +### YamlMime:PythonModule +uid: azure.storage.queue.sharedaccesssignature +name: sharedaccesssignature +fullName: azure.storage.queue.sharedaccesssignature +classes: +- azure.storage.queue.sharedaccesssignature.QueueSharedAccessSignature diff --git a/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.yml b/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.yml new file mode 100644 index 00000000..1419f4d7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-storage-queue/azure.storage.queue.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.storage.queue +name: queue +fullName: azure.storage.queue +type: rootImport +modules: +- azure.storage.queue.models +- azure.storage.queue.queueservice +- azure.storage.queue.sharedaccesssignature diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.SynapseClient.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.SynapseClient.yml new file mode 100644 index 00000000..3b304b38 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.SynapseClient.yml @@ -0,0 +1,46 @@ +### YamlMime:PythonClass +uid: azure.synapse.SynapseClient +name: SynapseClient +fullName: azure.synapse.SynapseClient +module: azure.synapse +constructor: + syntax: 'SynapseClient(credential: ''TokenCredential'', synapse_dns_suffix: str + = ''dev.azuresynapse.net'', livy_api_version: str = ''2019-11-01-preview'', **kwargs: + Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: synapse_dns_suffix + description: Gets the DNS suffix used as the base for all Synapse service requests. + defaultValue: dev.azuresynapse.net + types: + - + - name: livy_api_version + description: Valid api-version for the request. + defaultValue: 2019-11-01-preview + types: + - +variables: +- description: MonitoringOperations operations + name: monitoring + types: + - +- description: SparkBatchOperations operations + name: spark_batch + types: + - +- description: SparkSessionOperations operations + name: spark_session + types: + - +- description: WorkspaceAclOperations operations + name: workspace_acl + types: + - +methods: +- uid: azure.synapse.SynapseClient.close + name: close + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.AccessControlClient.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.AccessControlClient.yml new file mode 100644 index 00000000..9d03db50 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.AccessControlClient.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.synapse.accesscontrol.AccessControlClient +name: AccessControlClient +fullName: azure.synapse.accesscontrol.AccessControlClient +module: azure.synapse.accesscontrol +summary: AccessControlClient. +constructor: + syntax: 'AccessControlClient(credential: ''TokenCredential'', endpoint: str, **kwargs: + Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: endpoint + description: The workspace development endpoint, for example [https://myworkspace.dev.azuresynapse.net](https://myworkspace.dev.azuresynapse.net). + isRequired: true + types: + - + keywordOnlyParameters: + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - +variables: +- description: AccessControlOperations operations + name: access_control + types: + - +methods: +- uid: azure.synapse.accesscontrol.AccessControlClient.close + name: close + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.AccessControlClient.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.AccessControlClient.yml new file mode 100644 index 00000000..901897d0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.AccessControlClient.yml @@ -0,0 +1,35 @@ +### YamlMime:PythonClass +uid: azure.synapse.accesscontrol.aio.AccessControlClient +name: AccessControlClient +fullName: azure.synapse.accesscontrol.aio.AccessControlClient +module: azure.synapse.accesscontrol.aio +summary: AccessControlClient. +constructor: + syntax: 'AccessControlClient(credential: AsyncTokenCredential, endpoint: str, **kwargs: + Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: endpoint + description: The workspace development endpoint, for example [https://myworkspace.dev.azuresynapse.net](https://myworkspace.dev.azuresynapse.net). + isRequired: true + types: + - + keywordOnlyParameters: + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - +variables: +- description: AccessControlOperations operations + name: access_control + types: + - +methods: +- uid: azure.synapse.accesscontrol.aio.AccessControlClient.close + name: close + signature: async close() -> None diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.operations_async.AccessControlOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.operations_async.AccessControlOperations.yml new file mode 100644 index 00000000..06ff35bc --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.operations_async.AccessControlOperations.yml @@ -0,0 +1,186 @@ +### YamlMime:PythonClass +uid: azure.synapse.accesscontrol.aio.operations_async.AccessControlOperations +name: AccessControlOperations +fullName: azure.synapse.accesscontrol.aio.operations_async.AccessControlOperations +module: azure.synapse.accesscontrol.aio.operations_async +summary: 'AccessControlOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: AccessControlOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.accesscontrol.aio.operations_async.AccessControlOperations.create_role_assignment + name: create_role_assignment + summary: Create role assignment. + signature: 'async create_role_assignment(create_role_assignment_options: RoleAssignmentOptions, + **kwargs) -> RoleAssignmentDetails' + parameters: + - name: create_role_assignment_options + description: Details of role id and object id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: RoleAssignmentDetails, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.accesscontrol.aio.operations_async.AccessControlOperations.delete_role_assignment_by_id + name: delete_role_assignment_by_id + summary: Delete role assignment by role assignment Id. + signature: 'async delete_role_assignment_by_id(role_assignment_id: str, **kwargs) + -> None' + parameters: + - name: role_assignment_id + description: The ID of the role assignment. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.accesscontrol.aio.operations_async.AccessControlOperations.get_caller_role_assignments + name: get_caller_role_assignments + summary: List role assignments of the caller. + signature: async get_caller_role_assignments(**kwargs) -> List[str] + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: list of str, or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.accesscontrol.aio.operations_async.AccessControlOperations.get_role_assignment_by_id + name: get_role_assignment_by_id + summary: Get role assignment by role assignment Id. + signature: 'async get_role_assignment_by_id(role_assignment_id: str, **kwargs) -> + RoleAssignmentDetails' + parameters: + - name: role_assignment_id + description: The ID of the role assignment. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: RoleAssignmentDetails, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.accesscontrol.aio.operations_async.AccessControlOperations.get_role_assignments + name: get_role_assignments + summary: List role assignments. + signature: 'async get_role_assignments(role_id: str | None = None, principal_id: + str | None = None, continuation_token_parameter: str | None = None, **kwargs) + -> List[RoleAssignmentDetails]' + parameters: + - name: role_id + description: Synapse Built-In Role Id. + defaultValue: None + types: + - + - name: principal_id + description: Object ID of the AAD principal or security-group. + defaultValue: None + types: + - + - name: continuation_token_parameter + description: Continuation token. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: list of RoleAssignmentDetails, or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.accesscontrol.aio.operations_async.AccessControlOperations.get_role_definition_by_id + name: get_role_definition_by_id + summary: Get role by role Id. + signature: 'async get_role_definition_by_id(role_id: str, **kwargs) -> SynapseRole' + parameters: + - name: role_id + description: Synapse Built-In Role Id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SynapseRole, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.accesscontrol.aio.operations_async.AccessControlOperations.get_role_definitions + name: get_role_definitions + summary: List roles. + signature: get_role_definitions(**kwargs) -> AsyncIterable[RolesListResponse] + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either RolesListResponse or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.accesscontrol.aio.operations_async.AccessControlOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.operations_async.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.operations_async.yml new file mode 100644 index 00000000..06ce1d27 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.operations_async.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonPackage +uid: azure.synapse.accesscontrol.aio.operations_async +name: operations_async +fullName: azure.synapse.accesscontrol.aio.operations_async +type: import +classes: +- azure.synapse.accesscontrol.aio.operations_async.AccessControlOperations diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.yml new file mode 100644 index 00000000..f44befd7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.aio.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.synapse.accesscontrol.aio +name: aio +fullName: azure.synapse.accesscontrol.aio +type: import +classes: +- azure.synapse.accesscontrol.aio.AccessControlClient +packages: +- azure.synapse.accesscontrol.aio.operations_async diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorContract.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorContract.yml new file mode 100644 index 00000000..0343b165 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorContract.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.synapse.accesscontrol.models.ErrorContract +name: ErrorContract +fullName: azure.synapse.accesscontrol.models.ErrorContract +module: azure.synapse.accesscontrol.models +summary: Contains details when the response code indicates an error. +constructor: + syntax: 'ErrorContract(*, error: ErrorResponse | None = None, **kwargs)' + parameters: + - name: error + description: The error details. + isRequired: true + types: + - + keywordOnlyParameters: + - name: error + isRequired: true +methods: +- uid: azure.synapse.accesscontrol.models.ErrorContract.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.accesscontrol.models.ErrorContract.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.accesscontrol.models.ErrorContract.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.accesscontrol.models.ErrorContract.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.accesscontrol.models.ErrorContract.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.accesscontrol.models.ErrorContract.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.accesscontrol.models.ErrorContract.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorDetail.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorDetail.yml new file mode 100644 index 00000000..d370516a --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorDetail.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.synapse.accesscontrol.models.ErrorDetail +name: ErrorDetail +fullName: azure.synapse.accesscontrol.models.ErrorDetail +module: azure.synapse.accesscontrol.models +summary: 'ErrorDetail. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ErrorDetail(*, code: str, message: str, target: str | None = None, **kwargs)' + parameters: + - name: code + description: Required. + isRequired: true + types: + - + - name: message + description: Required. + isRequired: true + types: + - + - name: target + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true + - name: target + isRequired: true +methods: +- uid: azure.synapse.accesscontrol.models.ErrorDetail.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.accesscontrol.models.ErrorDetail.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.accesscontrol.models.ErrorDetail.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.accesscontrol.models.ErrorDetail.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.accesscontrol.models.ErrorDetail.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.accesscontrol.models.ErrorDetail.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.accesscontrol.models.ErrorDetail.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorResponse.yml new file mode 100644 index 00000000..620748f8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorResponse.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.synapse.accesscontrol.models.ErrorResponse +name: ErrorResponse +fullName: azure.synapse.accesscontrol.models.ErrorResponse +module: azure.synapse.accesscontrol.models +summary: 'ErrorResponse. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ErrorResponse(*, code: str, message: str, target: str | None = None, details: + List[ErrorDetail] | None = None, **kwargs)' + parameters: + - name: code + description: Required. + isRequired: true + types: + - + - name: message + description: Required. + isRequired: true + types: + - + - name: target + isRequired: true + types: + - + - name: details + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true + - name: target + isRequired: true + - name: details + isRequired: true +methods: +- uid: azure.synapse.accesscontrol.models.ErrorResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.accesscontrol.models.ErrorResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.accesscontrol.models.ErrorResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.accesscontrol.models.ErrorResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.accesscontrol.models.ErrorResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.accesscontrol.models.ErrorResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.accesscontrol.models.ErrorResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentDetails.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentDetails.yml new file mode 100644 index 00000000..e4ce252f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentDetails.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.synapse.accesscontrol.models.RoleAssignmentDetails +name: RoleAssignmentDetails +fullName: azure.synapse.accesscontrol.models.RoleAssignmentDetails +module: azure.synapse.accesscontrol.models +summary: Role Assignment response details. +constructor: + syntax: 'RoleAssignmentDetails(*, id: str | None = None, role_id: str | None = None, + principal_id: str | None = None, **kwargs)' + parameters: + - name: id + description: Role Assignment ID. + isRequired: true + types: + - + - name: role_id + description: Role ID of the Synapse Built-In Role. + isRequired: true + types: + - + - name: principal_id + description: Object ID of the AAD principal or security-group. + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: role_id + isRequired: true + - name: principal_id + isRequired: true +methods: +- uid: azure.synapse.accesscontrol.models.RoleAssignmentDetails.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.accesscontrol.models.RoleAssignmentDetails.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.accesscontrol.models.RoleAssignmentDetails.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.accesscontrol.models.RoleAssignmentDetails.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.accesscontrol.models.RoleAssignmentDetails.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.accesscontrol.models.RoleAssignmentDetails.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.accesscontrol.models.RoleAssignmentDetails.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentOptions.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentOptions.yml new file mode 100644 index 00000000..adbf3440 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentOptions.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.synapse.accesscontrol.models.RoleAssignmentOptions +name: RoleAssignmentOptions +fullName: azure.synapse.accesscontrol.models.RoleAssignmentOptions +module: azure.synapse.accesscontrol.models +summary: 'Role Assignment request details. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RoleAssignmentOptions(*, role_id: str, principal_id: str, **kwargs)' + parameters: + - name: role_id + description: Required. Role ID of the Synapse Built-In Role. + isRequired: true + types: + - + - name: principal_id + description: Required. Object ID of the AAD principal or security-group. + isRequired: true + types: + - + keywordOnlyParameters: + - name: role_id + isRequired: true + - name: principal_id + isRequired: true +methods: +- uid: azure.synapse.accesscontrol.models.RoleAssignmentOptions.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.accesscontrol.models.RoleAssignmentOptions.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.accesscontrol.models.RoleAssignmentOptions.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.accesscontrol.models.RoleAssignmentOptions.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.accesscontrol.models.RoleAssignmentOptions.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.accesscontrol.models.RoleAssignmentOptions.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.accesscontrol.models.RoleAssignmentOptions.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RolesListResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RolesListResponse.yml new file mode 100644 index 00000000..04a1a1b0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RolesListResponse.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.synapse.accesscontrol.models.RolesListResponse +name: RolesListResponse +fullName: azure.synapse.accesscontrol.models.RolesListResponse +module: azure.synapse.accesscontrol.models +summary: 'A list of Synapse roles available. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RolesListResponse(*, value: List[SynapseRole], next_link: str | None = + None, **kwargs)' + parameters: + - name: value + description: Required. List of Synapse roles. + isRequired: true + types: + - [] + - name: next_link + description: The link to the next page of results, if any remaining results exist. + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: next_link + isRequired: true +methods: +- uid: azure.synapse.accesscontrol.models.RolesListResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.accesscontrol.models.RolesListResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.accesscontrol.models.RolesListResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.accesscontrol.models.RolesListResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.accesscontrol.models.RolesListResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.accesscontrol.models.RolesListResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.accesscontrol.models.RolesListResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.SynapseRole.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.SynapseRole.yml new file mode 100644 index 00000000..e749c59a --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.SynapseRole.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.synapse.accesscontrol.models.SynapseRole +name: SynapseRole +fullName: azure.synapse.accesscontrol.models.SynapseRole +module: azure.synapse.accesscontrol.models +summary: 'Synapse role details. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SynapseRole(*, is_built_in: bool, id: str | None = None, name: str | None + = None, **kwargs)' + parameters: + - name: id + description: Role ID. + isRequired: true + types: + - + - name: name + description: Name of the Synapse role. + isRequired: true + types: + - + - name: is_built_in + description: Required. Is a built-in role or not. + isRequired: true + types: + - + keywordOnlyParameters: + - name: is_built_in + isRequired: true + - name: id + isRequired: true + - name: name + isRequired: true +methods: +- uid: azure.synapse.accesscontrol.models.SynapseRole.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.accesscontrol.models.SynapseRole.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.accesscontrol.models.SynapseRole.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.accesscontrol.models.SynapseRole.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.accesscontrol.models.SynapseRole.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.accesscontrol.models.SynapseRole.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.accesscontrol.models.SynapseRole.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.yml new file mode 100644 index 00000000..7d990b77 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonPackage +uid: azure.synapse.accesscontrol.models +name: models +fullName: azure.synapse.accesscontrol.models +type: import +classes: +- azure.synapse.accesscontrol.models.ErrorContract +- azure.synapse.accesscontrol.models.ErrorDetail +- azure.synapse.accesscontrol.models.ErrorResponse +- azure.synapse.accesscontrol.models.RoleAssignmentDetails +- azure.synapse.accesscontrol.models.RoleAssignmentOptions +- azure.synapse.accesscontrol.models.RolesListResponse +- azure.synapse.accesscontrol.models.SynapseRole diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.operations.AccessControlOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.operations.AccessControlOperations.yml new file mode 100644 index 00000000..e06e50c7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.operations.AccessControlOperations.yml @@ -0,0 +1,186 @@ +### YamlMime:PythonClass +uid: azure.synapse.accesscontrol.operations.AccessControlOperations +name: AccessControlOperations +fullName: azure.synapse.accesscontrol.operations.AccessControlOperations +module: azure.synapse.accesscontrol.operations +summary: 'AccessControlOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: AccessControlOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.accesscontrol.operations.AccessControlOperations.create_role_assignment + name: create_role_assignment + summary: Create role assignment. + signature: 'create_role_assignment(create_role_assignment_options: ''models.RoleAssignmentOptions'', + **kwargs: Any) -> models.RoleAssignmentDetails' + parameters: + - name: create_role_assignment_options + description: Details of role id and object id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: RoleAssignmentDetails, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.accesscontrol.operations.AccessControlOperations.delete_role_assignment_by_id + name: delete_role_assignment_by_id + summary: Delete role assignment by role assignment Id. + signature: 'delete_role_assignment_by_id(role_assignment_id: str, **kwargs: Any) + -> None' + parameters: + - name: role_assignment_id + description: The ID of the role assignment. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.accesscontrol.operations.AccessControlOperations.get_caller_role_assignments + name: get_caller_role_assignments + summary: List role assignments of the caller. + signature: 'get_caller_role_assignments(**kwargs: Any) -> List[str]' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: list of str, or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.accesscontrol.operations.AccessControlOperations.get_role_assignment_by_id + name: get_role_assignment_by_id + summary: Get role assignment by role assignment Id. + signature: 'get_role_assignment_by_id(role_assignment_id: str, **kwargs: Any) -> + models.RoleAssignmentDetails' + parameters: + - name: role_assignment_id + description: The ID of the role assignment. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: RoleAssignmentDetails, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.accesscontrol.operations.AccessControlOperations.get_role_assignments + name: get_role_assignments + summary: List role assignments. + signature: 'get_role_assignments(role_id: str | None = None, principal_id: str | + None = None, continuation_token_parameter: str | None = None, **kwargs: Any) -> + List[''models.RoleAssignmentDetails'']' + parameters: + - name: role_id + description: Synapse Built-In Role Id. + defaultValue: None + types: + - + - name: principal_id + description: Object ID of the AAD principal or security-group. + defaultValue: None + types: + - + - name: continuation_token_parameter + description: Continuation token. + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: list of RoleAssignmentDetails, or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.accesscontrol.operations.AccessControlOperations.get_role_definition_by_id + name: get_role_definition_by_id + summary: Get role by role Id. + signature: 'get_role_definition_by_id(role_id: str, **kwargs: Any) -> models.SynapseRole' + parameters: + - name: role_id + description: Synapse Built-In Role Id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SynapseRole, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.accesscontrol.operations.AccessControlOperations.get_role_definitions + name: get_role_definitions + summary: List roles. + signature: 'get_role_definitions(**kwargs: Any) -> Iterable[''models.RolesListResponse'']' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either RolesListResponse or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.accesscontrol.operations.AccessControlOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.operations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.operations.yml new file mode 100644 index 00000000..12155ffa --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.operations.yml @@ -0,0 +1,7 @@ +### YamlMime:PythonPackage +uid: azure.synapse.accesscontrol.operations +name: operations +fullName: azure.synapse.accesscontrol.operations +type: import +classes: +- azure.synapse.accesscontrol.operations.AccessControlOperations diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.yml new file mode 100644 index 00000000..be6772a3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonPackage +uid: azure.synapse.accesscontrol +name: accesscontrol +fullName: azure.synapse.accesscontrol +type: import +classes: +- azure.synapse.accesscontrol.AccessControlClient +packages: +- azure.synapse.accesscontrol.aio +- azure.synapse.accesscontrol.models +- azure.synapse.accesscontrol.operations diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.SynapseClient.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.SynapseClient.yml new file mode 100644 index 00000000..8a2a7860 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.SynapseClient.yml @@ -0,0 +1,45 @@ +### YamlMime:PythonClass +uid: azure.synapse.aio.SynapseClient +name: SynapseClient +fullName: azure.synapse.aio.SynapseClient +module: azure.synapse.aio +constructor: + syntax: 'SynapseClient(credential: TokenCredential, synapse_dns_suffix: str = ''dev.azuresynapse.net'', + livy_api_version: str = ''2019-11-01-preview'', **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: synapse_dns_suffix + description: Gets the DNS suffix used as the base for all Synapse service requests. + defaultValue: dev.azuresynapse.net + types: + - + - name: livy_api_version + description: Valid api-version for the request. + defaultValue: 2019-11-01-preview + types: + - +variables: +- description: MonitoringOperations operations + name: monitoring + types: + - +- description: SparkBatchOperations operations + name: spark_batch + types: + - +- description: SparkSessionOperations operations + name: spark_session + types: + - +- description: WorkspaceAclOperations operations + name: workspace_acl + types: + - +methods: +- uid: azure.synapse.aio.SynapseClient.close + name: close + signature: async close() -> None diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.operations_async.MonitoringOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.operations_async.MonitoringOperations.yml new file mode 100644 index 00000000..6088e98e --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.operations_async.MonitoringOperations.yml @@ -0,0 +1,244 @@ +### YamlMime:PythonClass +uid: azure.synapse.aio.operations_async.MonitoringOperations +name: MonitoringOperations +fullName: azure.synapse.aio.operations_async.MonitoringOperations +module: azure.synapse.aio.operations_async +summary: 'MonitoringOperations async operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: MonitoringOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.aio.operations_async.MonitoringOperations.get_application_details + name: get_application_details + summary: Get one spark application details given the workspace name, pool name and + livyid. + signature: 'async get_application_details(workspace_name: str, pool_name: str, livy_id: + str, **kwargs) -> SparkJobListViewResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: pool_name + description: The spark pool name. + isRequired: true + types: + - + - name: livy_id + description: The livy id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkJobListViewResponse or or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.aio.operations_async.MonitoringOperations.get_history_server_data + name: get_history_server_data + summary: Get History Server Data for a given workspace, pool, livyid, appid and + attemptId. + signature: 'async get_history_server_data(workspace_name: str, pool_name: str, livy_id: + str, app_id: str, attempt_id: str, **kwargs) -> HistoryServerDataResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: pool_name + description: The spark pool name. + isRequired: true + types: + - + - name: livy_id + description: The livy id. + isRequired: true + types: + - + - name: app_id + description: The application id. + isRequired: true + types: + - + - name: attempt_id + description: The attempt id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: HistoryServerDataResponse or or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.aio.operations_async.MonitoringOperations.get_history_server_diagnostic + name: get_history_server_diagnostic + summary: Get History Server Diagnostic Data for a given workspace, pool, livyid, + appid and attemptId. + signature: 'async get_history_server_diagnostic(workspace_name: str, pool_name: + str, livy_id: str, app_id: str, attempt_id: str, **kwargs) -> HistoryServerDiagnosticResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: pool_name + description: The spark pool name. + isRequired: true + types: + - + - name: livy_id + description: The livy id. + isRequired: true + types: + - + - name: app_id + description: The application id. + isRequired: true + types: + - + - name: attempt_id + description: The attempt id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: HistoryServerDiagnosticResponse or or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.aio.operations_async.MonitoringOperations.get_history_server_graph + name: get_history_server_graph + summary: Get History Server Graph Data for a given workspace, pool, livyid, appid + and attemptId. + signature: 'async get_history_server_graph(workspace_name: str, pool_name: str, + livy_id: str, app_id: str, attempt_id: str, **kwargs) -> HistoryServerGraphResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: pool_name + description: The spark pool name. + isRequired: true + types: + - + - name: livy_id + description: The livy id. + isRequired: true + types: + - + - name: app_id + description: The application id. + isRequired: true + types: + - + - name: attempt_id + description: The attempt id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: HistoryServerGraphResponse or or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.aio.operations_async.MonitoringOperations.get_history_server_properties + name: get_history_server_properties + summary: Get History server properties. + signature: 'async get_history_server_properties(workspace_name: str, **kwargs) -> + HistoryServerPropertiesResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: HistoryServerPropertiesResponse or or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.aio.operations_async.MonitoringOperations.get_spark_job_list + name: get_spark_job_list + summary: Get list of spark applications for the workspace. + signature: 'async get_spark_job_list(workspace_name: str, **kwargs) -> SparkJobListViewResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkJobListViewResponse or or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.aio.operations_async.MonitoringOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.operations_async.SparkBatchOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.operations_async.SparkBatchOperations.yml new file mode 100644 index 00000000..8a96dacf --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.operations_async.SparkBatchOperations.yml @@ -0,0 +1,193 @@ +### YamlMime:PythonClass +uid: azure.synapse.aio.operations_async.SparkBatchOperations +name: SparkBatchOperations +fullName: azure.synapse.aio.operations_async.SparkBatchOperations +module: azure.synapse.aio.operations_async +summary: 'SparkBatchOperations async operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: SparkBatchOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.aio.operations_async.SparkBatchOperations.create + name: create + summary: Create new spark batch job. + signature: 'async create(workspace_name: str, spark_pool_name: str, livy_request: + ExtendedLivyBatchRequest, detailed: bool | None = None, **kwargs) -> ExtendedLivyBatchResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: livy_request + description: Livy compatible batch job request payload. + isRequired: true + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ExtendedLivyBatchResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.aio.operations_async.SparkBatchOperations.delete + name: delete + summary: Cancels a running spark batch job. + signature: 'async delete(workspace_name: str, spark_pool_name: str, batch_id: int, + **kwargs) -> None' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: batch_id + description: Identifier for the batch job. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.aio.operations_async.SparkBatchOperations.get + name: get + summary: Gets a single spark batch job. + signature: 'async get(workspace_name: str, spark_pool_name: str, batch_id: int, + detailed: bool | None = None, **kwargs) -> ExtendedLivyBatchResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: batch_id + description: Identifier for the batch job. + isRequired: true + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ExtendedLivyBatchResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.aio.operations_async.SparkBatchOperations.list + name: list + summary: List all spark batch jobs which are running under a particular spark pool. + signature: 'async list(workspace_name: str, spark_pool_name: str, from_parameter: + int | None = None, size: int | None = None, detailed: bool | None = None, **kwargs) + -> ExtendedLivyListBatchResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: from_parameter + description: Optional param specifying which index the list should begin from. + defaultValue: None + types: + - + - name: size + description: 'Optional param specifying the size of the returned list. + + By default it is 20 and that is the maximum.' + defaultValue: None + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ExtendedLivyListBatchResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.aio.operations_async.SparkBatchOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.operations_async.SparkSessionOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.operations_async.SparkSessionOperations.yml new file mode 100644 index 00000000..195f165d --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.operations_async.SparkSessionOperations.yml @@ -0,0 +1,368 @@ +### YamlMime:PythonClass +uid: azure.synapse.aio.operations_async.SparkSessionOperations +name: SparkSessionOperations +fullName: azure.synapse.aio.operations_async.SparkSessionOperations +module: azure.synapse.aio.operations_async +summary: 'SparkSessionOperations async operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: SparkSessionOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.aio.operations_async.SparkSessionOperations.create + name: create + summary: Create new spark session. + signature: 'async create(workspace_name: str, spark_pool_name: str, livy_request: + ExtendedLivySessionRequest, detailed: bool | None = None, **kwargs) -> ExtendedLivySessionResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: livy_request + description: Livy compatible batch job request payload. + isRequired: true + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ExtendedLivySessionResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.aio.operations_async.SparkSessionOperations.create_statement + name: create_statement + summary: Create statement within a spark session. + signature: 'async create_statement(workspace_name: str, spark_pool_name: str, session_id: + int, livy_request: LivyStatementRequestBody, **kwargs) -> LivyStatementResponseBody' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + - name: livy_request + description: Livy compatible batch job request payload. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LivyStatementResponseBody or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.aio.operations_async.SparkSessionOperations.delete + name: delete + summary: Cancels a running spark session. + signature: 'async delete(workspace_name: str, spark_pool_name: str, session_id: + int, **kwargs) -> None' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.aio.operations_async.SparkSessionOperations.delete_statement + name: delete_statement + summary: Kill a statement within a session. + signature: 'async delete_statement(workspace_name: str, spark_pool_name: str, session_id: + int, statement_id: int, **kwargs) -> LivyStatementCancellationResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + - name: statement_id + description: Identifier for the statement. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LivyStatementCancellationResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.aio.operations_async.SparkSessionOperations.get + name: get + summary: Gets a single spark session. + signature: 'async get(workspace_name: str, spark_pool_name: str, session_id: int, + detailed: bool | None = None, **kwargs) -> ExtendedLivySessionResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ExtendedLivySessionResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.aio.operations_async.SparkSessionOperations.get_statement + name: get_statement + summary: Gets a single statement within a spark session. + signature: 'async get_statement(workspace_name: str, spark_pool_name: str, session_id: + int, statement_id: int, **kwargs) -> LivyStatementResponseBody' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + - name: statement_id + description: Identifier for the statement. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LivyStatementResponseBody or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.aio.operations_async.SparkSessionOperations.list + name: list + summary: List all spark sessions which are running under a particular spark pool. + signature: 'async list(workspace_name: str, spark_pool_name: str, from_parameter: + int | None = None, size: int | None = None, detailed: bool | None = None, **kwargs) + -> ExtendedLivyListSessionResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: from_parameter + description: Optional param specifying which index the list should begin from. + defaultValue: None + types: + - + - name: size + description: 'Optional param specifying the size of the returned list. + + By default it is 20 and that is the maximum.' + defaultValue: None + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ExtendedLivyListSessionResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.aio.operations_async.SparkSessionOperations.list_statements + name: list_statements + summary: Gets a list of statements within a spark session. + signature: 'async list_statements(workspace_name: str, spark_pool_name: str, session_id: + int, **kwargs) -> LivyStatementsResponseBody' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LivyStatementsResponseBody or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.aio.operations_async.SparkSessionOperations.reset_timeout + name: reset_timeout + summary: Sends a keep alive call to the current session to reset the session timeout. + signature: 'async reset_timeout(workspace_name: str, spark_pool_name: str, session_id: + int, **kwargs) -> None' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.aio.operations_async.SparkSessionOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.operations_async.WorkspaceAclOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.operations_async.WorkspaceAclOperations.yml new file mode 100644 index 00000000..3add5e53 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.operations_async.WorkspaceAclOperations.yml @@ -0,0 +1,85 @@ +### YamlMime:PythonClass +uid: azure.synapse.aio.operations_async.WorkspaceAclOperations +name: WorkspaceAclOperations +fullName: azure.synapse.aio.operations_async.WorkspaceAclOperations +module: azure.synapse.aio.operations_async +summary: 'WorkspaceAclOperations async operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: WorkspaceAclOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.aio.operations_async.WorkspaceAclOperations.get_access_control_info + name: get_access_control_info + summary: Get access control info. + signature: 'async get_access_control_info(workspace_name: str, artifact_name: str + | None = None, **kwargs) -> WorkspaceAccessControlResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: artifact_name + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: WorkspaceAccessControlResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.aio.operations_async.WorkspaceAclOperations.set_workspace_administrators + name: set_workspace_administrators + summary: Replace Admins of the Workspace. + signature: 'async set_workspace_administrators(workspace_name: str, administrators: + List[str] | None = None, **kwargs) -> WorkspaceAccessControlResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: administrators + defaultValue: None + types: + - [] + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: WorkspaceAccessControlResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.aio.operations_async.WorkspaceAclOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.operations_async.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.operations_async.yml new file mode 100644 index 00000000..be196cbb --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.operations_async.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonPackage +uid: azure.synapse.aio.operations_async +name: operations_async +fullName: azure.synapse.aio.operations_async +type: import +classes: +- azure.synapse.aio.operations_async.MonitoringOperations +- azure.synapse.aio.operations_async.SparkBatchOperations +- azure.synapse.aio.operations_async.SparkSessionOperations +- azure.synapse.aio.operations_async.WorkspaceAclOperations diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.yml new file mode 100644 index 00000000..941416bf --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.aio.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.synapse.aio +name: aio +fullName: azure.synapse.aio +type: import +classes: +- azure.synapse.aio.SynapseClient +packages: +- azure.synapse.aio.operations_async diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.ArtifactsClient.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.ArtifactsClient.yml new file mode 100644 index 00000000..2869ed83 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.ArtifactsClient.yml @@ -0,0 +1,75 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.ArtifactsClient +name: ArtifactsClient +fullName: azure.synapse.artifacts.ArtifactsClient +module: azure.synapse.artifacts +summary: ArtifactsClient. +constructor: + syntax: 'ArtifactsClient(credential: ''TokenCredential'', endpoint: str, **kwargs: + Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: endpoint + description: The workspace development endpoint, for example [https://myworkspace.dev.azuresynapse.net](https://myworkspace.dev.azuresynapse.net). + isRequired: true + types: + - + keywordOnlyParameters: + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - +variables: +- description: LinkedServiceOperations operations + name: linked_service + types: + - +- description: DatasetOperations operations + name: dataset + types: + - +- description: PipelineOperations operations + name: pipeline + types: + - +- description: PipelineRunOperations operations + name: pipeline_run + types: + - +- description: TriggerOperations operations + name: trigger + types: + - +- description: TriggerRunOperations operations + name: trigger_run + types: + - +- description: DataFlowOperations operations + name: data_flow + types: + - +- description: DataFlowDebugSessionOperations operations + name: data_flow_debug_session + types: + - +- description: SqlScriptOperations operations + name: sql_script + types: + - +- description: SparkJobDefinitionOperations operations + name: spark_job_definition + types: + - +- description: NotebookOperations operations + name: notebook + types: + - +methods: +- uid: azure.synapse.artifacts.ArtifactsClient.close + name: close + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.ArtifactsClient.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.ArtifactsClient.yml new file mode 100644 index 00000000..4eb3ff53 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.ArtifactsClient.yml @@ -0,0 +1,75 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.aio.ArtifactsClient +name: ArtifactsClient +fullName: azure.synapse.artifacts.aio.ArtifactsClient +module: azure.synapse.artifacts.aio +summary: ArtifactsClient. +constructor: + syntax: 'ArtifactsClient(credential: AsyncTokenCredential, endpoint: str, **kwargs: + Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: endpoint + description: The workspace development endpoint, for example [https://myworkspace.dev.azuresynapse.net](https://myworkspace.dev.azuresynapse.net). + isRequired: true + types: + - + keywordOnlyParameters: + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - +variables: +- description: LinkedServiceOperations operations + name: linked_service + types: + - +- description: DatasetOperations operations + name: dataset + types: + - +- description: PipelineOperations operations + name: pipeline + types: + - +- description: PipelineRunOperations operations + name: pipeline_run + types: + - +- description: TriggerOperations operations + name: trigger + types: + - +- description: TriggerRunOperations operations + name: trigger_run + types: + - +- description: DataFlowOperations operations + name: data_flow + types: + - +- description: DataFlowDebugSessionOperations operations + name: data_flow_debug_session + types: + - +- description: SqlScriptOperations operations + name: sql_script + types: + - +- description: SparkJobDefinitionOperations operations + name: spark_job_definition + types: + - +- description: NotebookOperations operations + name: notebook + types: + - +methods: +- uid: azure.synapse.artifacts.aio.ArtifactsClient.close + name: close + signature: async close() -> None diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.DataFlowDebugSessionOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.DataFlowDebugSessionOperations.yml new file mode 100644 index 00000000..26e7b0fa --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.DataFlowDebugSessionOperations.yml @@ -0,0 +1,172 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.aio.operations_async.DataFlowDebugSessionOperations +name: DataFlowDebugSessionOperations +fullName: azure.synapse.artifacts.aio.operations_async.DataFlowDebugSessionOperations +module: azure.synapse.artifacts.aio.operations_async +summary: 'DataFlowDebugSessionOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: DataFlowDebugSessionOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.artifacts.aio.operations_async.DataFlowDebugSessionOperations.add_data_flow + name: add_data_flow + summary: Add a data flow into debug session. + signature: 'async add_data_flow(request: DataFlowDebugPackage, **kwargs) -> AddDataFlowToDebugSessionResponse' + parameters: + - name: request + description: Data flow debug session definition with debug content. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AddDataFlowToDebugSessionResponse, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.DataFlowDebugSessionOperations.begin_create_data_flow_debug_session + name: begin_create_data_flow_debug_session + summary: Creates a data flow debug session. + signature: 'async begin_create_data_flow_debug_session(request: CreateDataFlowDebugSessionRequest, + **kwargs) -> AsyncLROPoller[CreateDataFlowDebugSessionResponse]' + parameters: + - name: request + description: Data flow debug session definition. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either CreateDataFlowDebugSessionResponse + or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.DataFlowDebugSessionOperations.begin_execute_command + name: begin_execute_command + summary: Execute a data flow debug command. + signature: 'async begin_execute_command(request: DataFlowDebugCommandRequest, **kwargs) + -> AsyncLROPoller[DataFlowDebugCommandResponse]' + parameters: + - name: request + description: Data flow debug command definition. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either DataFlowDebugCommandResponse + or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.DataFlowDebugSessionOperations.delete_data_flow_debug_session + name: delete_data_flow_debug_session + summary: Deletes a data flow debug session. + signature: 'async delete_data_flow_debug_session(request: DeleteDataFlowDebugSessionRequest, + **kwargs) -> None' + parameters: + - name: request + description: Data flow debug session definition for deletion. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.DataFlowDebugSessionOperations.query_data_flow_debug_sessions_by_workspace + name: query_data_flow_debug_sessions_by_workspace + summary: Query all active data flow debug sessions. + signature: query_data_flow_debug_sessions_by_workspace(**kwargs) -> AsyncIterable[QueryDataFlowDebugSessionsResponse] + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either QueryDataFlowDebugSessionsResponse + or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.artifacts.aio.operations_async.DataFlowDebugSessionOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.DataFlowOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.DataFlowOperations.yml new file mode 100644 index 00000000..be8d6c80 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.DataFlowOperations.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.aio.operations_async.DataFlowOperations +name: DataFlowOperations +fullName: azure.synapse.artifacts.aio.operations_async.DataFlowOperations +module: azure.synapse.artifacts.aio.operations_async +summary: 'DataFlowOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: DataFlowOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.artifacts.aio.operations_async.DataFlowOperations.create_or_update_data_flow + name: create_or_update_data_flow + summary: Creates or updates a data flow. + signature: 'async create_or_update_data_flow(data_flow_name: str, properties: DataFlow, + if_match: str | None = None, **kwargs) -> DataFlowResource' + parameters: + - name: data_flow_name + description: The data flow name. + isRequired: true + types: + - + - name: properties + description: Data flow properties. + isRequired: true + types: + - + - name: if_match + description: 'ETag of the data flow entity. Should only be specified for update, + for which + + it should match existing entity or can be * for unconditional update.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DataFlowResource, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.DataFlowOperations.delete_data_flow + name: delete_data_flow + summary: Deletes a data flow. + signature: 'async delete_data_flow(data_flow_name: str, **kwargs) -> None' + parameters: + - name: data_flow_name + description: The data flow name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.DataFlowOperations.get_data_flow + name: get_data_flow + summary: Gets a data flow. + signature: 'async get_data_flow(data_flow_name: str, if_none_match: str | None = + None, **kwargs) -> DataFlowResource' + parameters: + - name: data_flow_name + description: The data flow name. + isRequired: true + types: + - + - name: if_none_match + description: 'ETag of the data flow entity. Should only be specified for get. + If the + + ETag matches the existing entity tag, or if * was provided, then no content + will be returned.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DataFlowResource, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.DataFlowOperations.get_data_flows_by_workspace + name: get_data_flows_by_workspace + summary: Lists data flows. + signature: get_data_flows_by_workspace(**kwargs) -> AsyncIterable[DataFlowListResponse] + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either DataFlowListResponse or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.artifacts.aio.operations_async.DataFlowOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.DatasetOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.DatasetOperations.yml new file mode 100644 index 00000000..a9a49305 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.DatasetOperations.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.aio.operations_async.DatasetOperations +name: DatasetOperations +fullName: azure.synapse.artifacts.aio.operations_async.DatasetOperations +module: azure.synapse.artifacts.aio.operations_async +summary: 'DatasetOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: DatasetOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.artifacts.aio.operations_async.DatasetOperations.create_or_update_dataset + name: create_or_update_dataset + summary: Creates or updates a dataset. + signature: 'async create_or_update_dataset(dataset_name: str, properties: Dataset, + if_match: str | None = None, **kwargs) -> DatasetResource' + parameters: + - name: dataset_name + description: The dataset name. + isRequired: true + types: + - + - name: properties + description: Dataset properties. + isRequired: true + types: + - + - name: if_match + description: 'ETag of the dataset entity. Should only be specified for update, + for which it + + should match existing entity or can be * for unconditional update.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DatasetResource, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.DatasetOperations.delete_dataset + name: delete_dataset + summary: Deletes a dataset. + signature: 'async delete_dataset(dataset_name: str, **kwargs) -> None' + parameters: + - name: dataset_name + description: The dataset name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.DatasetOperations.get_dataset + name: get_dataset + summary: Gets a dataset. + signature: 'async get_dataset(dataset_name: str, if_none_match: str | None = None, + **kwargs) -> DatasetResource | None' + parameters: + - name: dataset_name + description: The dataset name. + isRequired: true + types: + - + - name: if_none_match + description: 'ETag of the dataset entity. Should only be specified for get. If + the ETag + + matches the existing entity tag, or if * was provided, then no content will + be returned.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DatasetResource, or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.DatasetOperations.get_datasets_by_workspace + name: get_datasets_by_workspace + summary: Lists datasets. + signature: get_datasets_by_workspace(**kwargs) -> AsyncIterable[DatasetListResponse] + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either DatasetListResponse or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.artifacts.aio.operations_async.DatasetOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.LinkedServiceOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.LinkedServiceOperations.yml new file mode 100644 index 00000000..95b767b3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.LinkedServiceOperations.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.aio.operations_async.LinkedServiceOperations +name: LinkedServiceOperations +fullName: azure.synapse.artifacts.aio.operations_async.LinkedServiceOperations +module: azure.synapse.artifacts.aio.operations_async +summary: 'LinkedServiceOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: LinkedServiceOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.artifacts.aio.operations_async.LinkedServiceOperations.create_or_update_linked_service + name: create_or_update_linked_service + summary: Creates or updates a linked service. + signature: 'async create_or_update_linked_service(linked_service_name: str, properties: + LinkedService, if_match: str | None = None, **kwargs) -> LinkedServiceResource' + parameters: + - name: linked_service_name + description: The linked service name. + isRequired: true + types: + - + - name: properties + description: Properties of linked service. + isRequired: true + types: + - + - name: if_match + description: 'ETag of the linkedService entity. Should only be specified for + update, for + + which it should match existing entity or can be * for unconditional update.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LinkedServiceResource, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.LinkedServiceOperations.delete_linked_service + name: delete_linked_service + summary: Deletes a linked service. + signature: 'async delete_linked_service(linked_service_name: str, **kwargs) -> None' + parameters: + - name: linked_service_name + description: The linked service name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.LinkedServiceOperations.get_linked_service + name: get_linked_service + summary: Gets a linked service. + signature: 'async get_linked_service(linked_service_name: str, if_none_match: str + | None = None, **kwargs) -> LinkedServiceResource | None' + parameters: + - name: linked_service_name + description: The linked service name. + isRequired: true + types: + - + - name: if_none_match + description: 'ETag of the linked service entity. Should only be specified for + get. If + + the ETag matches the existing entity tag, or if * was provided, then no content + will be + + returned.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LinkedServiceResource, or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.LinkedServiceOperations.get_linked_services_by_workspace + name: get_linked_services_by_workspace + summary: Lists linked services. + signature: get_linked_services_by_workspace(**kwargs) -> AsyncIterable[LinkedServiceListResponse] + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either LinkedServiceListResponse or + the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.artifacts.aio.operations_async.LinkedServiceOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.NotebookOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.NotebookOperations.yml new file mode 100644 index 00000000..dd3b3815 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.NotebookOperations.yml @@ -0,0 +1,155 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.aio.operations_async.NotebookOperations +name: NotebookOperations +fullName: azure.synapse.artifacts.aio.operations_async.NotebookOperations +module: azure.synapse.artifacts.aio.operations_async +summary: 'NotebookOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: NotebookOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.artifacts.aio.operations_async.NotebookOperations.create_or_update_notebook + name: create_or_update_notebook + summary: Creates or updates a Note Book. + signature: 'async create_or_update_notebook(notebook_name: str, properties: Notebook, + if_match: str | None = None, **kwargs) -> NotebookResource' + parameters: + - name: notebook_name + description: The notebook name. + isRequired: true + types: + - + - name: properties + description: Properties of Notebook. + isRequired: true + types: + - + - name: if_match + description: 'ETag of the Note book entity. Should only be specified for update, + for which + + it should match existing entity or can be * for unconditional update.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: NotebookResource, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.NotebookOperations.delete_notebook + name: delete_notebook + summary: Deletes a Note book. + signature: 'async delete_notebook(notebook_name: str, **kwargs) -> None' + parameters: + - name: notebook_name + description: The notebook name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.NotebookOperations.get_notebook + name: get_notebook + summary: Gets a Note Book. + signature: 'async get_notebook(notebook_name: str, if_none_match: str | None = None, + **kwargs) -> NotebookResource | None' + parameters: + - name: notebook_name + description: The notebook name. + isRequired: true + types: + - + - name: if_none_match + description: 'ETag of the Notebook entity. Should only be specified for get. If + the + + ETag matches the existing entity tag, or if * was provided, then no content + will be returned.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: NotebookResource, or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.NotebookOperations.get_notebook_summary_by_work_space + name: get_notebook_summary_by_work_space + summary: Lists a summary of Notebooks. + signature: get_notebook_summary_by_work_space(**kwargs) -> AsyncIterable[NotebookListResponse] + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either NotebookListResponse or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.NotebookOperations.get_notebooks_by_workspace + name: get_notebooks_by_workspace + summary: Lists Notebooks. + signature: get_notebooks_by_workspace(**kwargs) -> AsyncIterable[NotebookListResponse] + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either NotebookListResponse or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.artifacts.aio.operations_async.NotebookOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.PipelineOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.PipelineOperations.yml new file mode 100644 index 00000000..56704161 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.PipelineOperations.yml @@ -0,0 +1,191 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.aio.operations_async.PipelineOperations +name: PipelineOperations +fullName: azure.synapse.artifacts.aio.operations_async.PipelineOperations +module: azure.synapse.artifacts.aio.operations_async +summary: 'PipelineOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: PipelineOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.artifacts.aio.operations_async.PipelineOperations.create_or_update_pipeline + name: create_or_update_pipeline + summary: Creates or updates a pipeline. + signature: 'async create_or_update_pipeline(pipeline_name: str, pipeline: PipelineResource, + if_match: str | None = None, **kwargs) -> PipelineResource' + parameters: + - name: pipeline_name + description: The pipeline name. + isRequired: true + types: + - + - name: pipeline + description: Pipeline resource definition. + isRequired: true + types: + - + - name: if_match + description: 'ETag of the pipeline entity. Should only be specified for update, + for which + + it should match existing entity or can be * for unconditional update.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PipelineResource, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.PipelineOperations.create_pipeline_run + name: create_pipeline_run + summary: Creates a run of a pipeline. + signature: 'async create_pipeline_run(pipeline_name: str, reference_pipeline_run_id: + str | None = None, is_recovery: bool | None = None, start_activity_name: str | + None = None, parameters: Dict[str, object] | None = None, **kwargs) -> CreateRunResponse' + parameters: + - name: pipeline_name + description: The pipeline name. + isRequired: true + types: + - + - name: reference_pipeline_run_id + description: 'The pipeline run identifier. If run ID is specified the + + parameters of the specified run will be used to create a new run.' + defaultValue: None + types: + - + - name: is_recovery + description: 'Recovery mode flag. If recovery mode is set to true, the specified + + referenced pipeline run and the new run will be grouped under the same groupId.' + defaultValue: None + types: + - + - name: start_activity_name + description: 'In recovery mode, the rerun will start from this activity. If not + + specified, all activities will run.' + defaultValue: None + types: + - + - name: parameters + description: 'Parameters of the pipeline run. These parameters will be used only + if the + + runId is not specified.' + defaultValue: None + types: + - [, ] + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: CreateRunResponse, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.PipelineOperations.delete_pipeline + name: delete_pipeline + summary: Deletes a pipeline. + signature: 'async delete_pipeline(pipeline_name: str, **kwargs) -> None' + parameters: + - name: pipeline_name + description: The pipeline name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.PipelineOperations.get_pipeline + name: get_pipeline + summary: Gets a pipeline. + signature: 'async get_pipeline(pipeline_name: str, if_none_match: str | None = None, + **kwargs) -> PipelineResource | None' + parameters: + - name: pipeline_name + description: The pipeline name. + isRequired: true + types: + - + - name: if_none_match + description: 'ETag of the pipeline entity. Should only be specified for get. If + the + + ETag matches the existing entity tag, or if * was provided, then no content + will be returned.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PipelineResource, or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.PipelineOperations.get_pipelines_by_workspace + name: get_pipelines_by_workspace + summary: Lists pipelines. + signature: get_pipelines_by_workspace(**kwargs) -> AsyncIterable[PipelineListResponse] + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either PipelineListResponse or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.artifacts.aio.operations_async.PipelineOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.PipelineRunOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.PipelineRunOperations.yml new file mode 100644 index 00000000..c1ac90ab --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.PipelineRunOperations.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.aio.operations_async.PipelineRunOperations +name: PipelineRunOperations +fullName: azure.synapse.artifacts.aio.operations_async.PipelineRunOperations +module: azure.synapse.artifacts.aio.operations_async +summary: 'PipelineRunOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: PipelineRunOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.artifacts.aio.operations_async.PipelineRunOperations.cancel_pipeline_run + name: cancel_pipeline_run + summary: Cancel a pipeline run by its run ID. + signature: 'async cancel_pipeline_run(run_id: str, is_recursive: bool | None = None, + **kwargs) -> None' + parameters: + - name: run_id + description: The pipeline run identifier. + isRequired: true + types: + - + - name: is_recursive + description: 'If true, cancel all the Child pipelines that are triggered by the + current + + pipeline.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.PipelineRunOperations.get_pipeline_run + name: get_pipeline_run + summary: Get a pipeline run by its run ID. + signature: 'async get_pipeline_run(run_id: str, **kwargs) -> PipelineRun' + parameters: + - name: run_id + description: The pipeline run identifier. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PipelineRun, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.PipelineRunOperations.query_activity_runs + name: query_activity_runs + summary: Query activity runs based on input filter conditions. + signature: 'async query_activity_runs(pipeline_name: str, run_id: str, filter_parameters: + RunFilterParameters, **kwargs) -> ActivityRunsQueryResponse' + parameters: + - name: pipeline_name + description: The pipeline name. + isRequired: true + types: + - + - name: run_id + description: The pipeline run identifier. + isRequired: true + types: + - + - name: filter_parameters + description: Parameters to filter the activity runs. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ActivityRunsQueryResponse, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.PipelineRunOperations.query_pipeline_runs_by_workspace + name: query_pipeline_runs_by_workspace + summary: Query pipeline runs in the workspace based on input filter conditions. + signature: 'async query_pipeline_runs_by_workspace(filter_parameters: RunFilterParameters, + **kwargs) -> PipelineRunsQueryResponse' + parameters: + - name: filter_parameters + description: Parameters to filter the pipeline run. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PipelineRunsQueryResponse, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.artifacts.aio.operations_async.PipelineRunOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.SparkJobDefinitionOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.SparkJobDefinitionOperations.yml new file mode 100644 index 00000000..ccc0adc7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.SparkJobDefinitionOperations.yml @@ -0,0 +1,221 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.aio.operations_async.SparkJobDefinitionOperations +name: SparkJobDefinitionOperations +fullName: azure.synapse.artifacts.aio.operations_async.SparkJobDefinitionOperations +module: azure.synapse.artifacts.aio.operations_async +summary: 'SparkJobDefinitionOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: SparkJobDefinitionOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.artifacts.aio.operations_async.SparkJobDefinitionOperations.begin_debug_spark_job_definition + name: begin_debug_spark_job_definition + summary: Debug the spark job definition. + signature: 'async begin_debug_spark_job_definition(properties: SparkJobDefinition, + **kwargs) -> AsyncLROPoller[SparkBatchJob]' + parameters: + - name: properties + description: Properties of spark job definition. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either SparkBatchJob or + the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.SparkJobDefinitionOperations.begin_execute_spark_job_definition + name: begin_execute_spark_job_definition + summary: Executes the spark job definition. + signature: 'async begin_execute_spark_job_definition(spark_job_definition_name: + str, **kwargs) -> AsyncLROPoller[SparkBatchJob]' + parameters: + - name: spark_job_definition_name + description: The spark job definition name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either SparkBatchJob or + the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.SparkJobDefinitionOperations.create_or_update_spark_job_definition + name: create_or_update_spark_job_definition + summary: Creates or updates a Spark Job Definition. + signature: 'async create_or_update_spark_job_definition(spark_job_definition_name: + str, properties: SparkJobDefinition, if_match: str | None = None, **kwargs) -> + SparkJobDefinitionResource' + parameters: + - name: spark_job_definition_name + description: The spark job definition name. + isRequired: true + types: + - + - name: properties + description: Properties of spark job definition. + isRequired: true + types: + - + - name: if_match + description: 'ETag of the Spark Job Definition entity. Should only be specified + for update, + + for which it should match existing entity or can be * for unconditional update.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkJobDefinitionResource, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.SparkJobDefinitionOperations.delete_spark_job_definition + name: delete_spark_job_definition + summary: Deletes a Spark Job Definition. + signature: 'async delete_spark_job_definition(spark_job_definition_name: str, **kwargs) + -> None' + parameters: + - name: spark_job_definition_name + description: The spark job definition name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.SparkJobDefinitionOperations.get_spark_job_definition + name: get_spark_job_definition + summary: Gets a Spark Job Definition. + signature: 'async get_spark_job_definition(spark_job_definition_name: str, if_none_match: + str | None = None, **kwargs) -> SparkJobDefinitionResource | None' + parameters: + - name: spark_job_definition_name + description: The spark job definition name. + isRequired: true + types: + - + - name: if_none_match + description: 'ETag of the Spark Job Definition entity. Should only be specified + for + + get. If the ETag matches the existing entity tag, or if * was provided, then + no content will be + + returned.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkJobDefinitionResource, or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.SparkJobDefinitionOperations.get_spark_job_definitions_by_workspace + name: get_spark_job_definitions_by_workspace + summary: Lists spark job definitions. + signature: get_spark_job_definitions_by_workspace(**kwargs) -> AsyncIterable[SparkJobDefinitionsListResponse] + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either SparkJobDefinitionsListResponse + or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.artifacts.aio.operations_async.SparkJobDefinitionOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.SqlScriptOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.SqlScriptOperations.yml new file mode 100644 index 00000000..bad28bc7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.SqlScriptOperations.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.aio.operations_async.SqlScriptOperations +name: SqlScriptOperations +fullName: azure.synapse.artifacts.aio.operations_async.SqlScriptOperations +module: azure.synapse.artifacts.aio.operations_async +summary: 'SqlScriptOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: SqlScriptOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.artifacts.aio.operations_async.SqlScriptOperations.create_or_update_sql_script + name: create_or_update_sql_script + summary: Creates or updates a Sql Script. + signature: 'async create_or_update_sql_script(sql_script_name: str, properties: + SqlScript, if_match: str | None = None, **kwargs) -> SqlScriptResource' + parameters: + - name: sql_script_name + description: The sql script name. + isRequired: true + types: + - + - name: properties + description: Properties of sql script. + isRequired: true + types: + - + - name: if_match + description: 'ETag of the SQL script entity. Should only be specified for update, + for which + + it should match existing entity or can be * for unconditional update.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SqlScriptResource, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.SqlScriptOperations.delete_sql_script + name: delete_sql_script + summary: Deletes a Sql Script. + signature: 'async delete_sql_script(sql_script_name: str, **kwargs) -> None' + parameters: + - name: sql_script_name + description: The sql script name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.SqlScriptOperations.get_sql_script + name: get_sql_script + summary: Gets a sql script. + signature: 'async get_sql_script(sql_script_name: str, if_none_match: str | None + = None, **kwargs) -> SqlScriptResource | None' + parameters: + - name: sql_script_name + description: The sql script name. + isRequired: true + types: + - + - name: if_none_match + description: 'ETag of the sql compute entity. Should only be specified for get. + If the + + ETag matches the existing entity tag, or if * was provided, then no content + will be returned.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SqlScriptResource, or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.SqlScriptOperations.get_sql_scripts_by_workspace + name: get_sql_scripts_by_workspace + summary: Lists sql scripts. + signature: get_sql_scripts_by_workspace(**kwargs) -> AsyncIterable[SqlScriptsListResponse] + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either SqlScriptsListResponse or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.artifacts.aio.operations_async.SqlScriptOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.TriggerOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.TriggerOperations.yml new file mode 100644 index 00000000..4657850d --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.TriggerOperations.yml @@ -0,0 +1,315 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.aio.operations_async.TriggerOperations +name: TriggerOperations +fullName: azure.synapse.artifacts.aio.operations_async.TriggerOperations +module: azure.synapse.artifacts.aio.operations_async +summary: 'TriggerOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: TriggerOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.artifacts.aio.operations_async.TriggerOperations.begin_start_trigger + name: begin_start_trigger + summary: Starts a trigger. + signature: 'async begin_start_trigger(trigger_name: str, **kwargs) -> AsyncLROPoller[None]' + parameters: + - name: trigger_name + description: The trigger name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.TriggerOperations.begin_stop_trigger + name: begin_stop_trigger + summary: Stops a trigger. + signature: 'async begin_stop_trigger(trigger_name: str, **kwargs) -> AsyncLROPoller[None]' + parameters: + - name: trigger_name + description: The trigger name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either None or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.TriggerOperations.begin_subscribe_trigger_to_events + name: begin_subscribe_trigger_to_events + summary: Subscribe event trigger to events. + signature: 'async begin_subscribe_trigger_to_events(trigger_name: str, **kwargs) + -> AsyncLROPoller[TriggerSubscriptionOperationStatus]' + parameters: + - name: trigger_name + description: The trigger name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either TriggerSubscriptionOperationStatus + or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.TriggerOperations.begin_unsubscribe_trigger_from_events + name: begin_unsubscribe_trigger_from_events + summary: Unsubscribe event trigger from events. + signature: 'async begin_unsubscribe_trigger_from_events(trigger_name: str, **kwargs) + -> AsyncLROPoller[TriggerSubscriptionOperationStatus]' + parameters: + - name: trigger_name + description: The trigger name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of AsyncLROPoller that returns either TriggerSubscriptionOperationStatus + or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.TriggerOperations.create_or_update_trigger + name: create_or_update_trigger + summary: Creates or updates a trigger. + signature: 'async create_or_update_trigger(trigger_name: str, properties: Trigger, + if_match: str | None = None, **kwargs) -> TriggerResource' + parameters: + - name: trigger_name + description: The trigger name. + isRequired: true + types: + - + - name: properties + description: Properties of the trigger. + isRequired: true + types: + - + - name: if_match + description: 'ETag of the trigger entity. Should only be specified for update, + for which it + + should match existing entity or can be * for unconditional update.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: TriggerResource, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.TriggerOperations.delete_trigger + name: delete_trigger + summary: Deletes a trigger. + signature: 'async delete_trigger(trigger_name: str, **kwargs) -> None' + parameters: + - name: trigger_name + description: The trigger name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.TriggerOperations.get_event_subscription_status + name: get_event_subscription_status + summary: Get a trigger's event subscription status. + signature: 'async get_event_subscription_status(trigger_name: str, **kwargs) -> + TriggerSubscriptionOperationStatus' + parameters: + - name: trigger_name + description: The trigger name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: TriggerSubscriptionOperationStatus, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.TriggerOperations.get_trigger + name: get_trigger + summary: Gets a trigger. + signature: 'async get_trigger(trigger_name: str, if_none_match: str | None = None, + **kwargs) -> TriggerResource | None' + parameters: + - name: trigger_name + description: The trigger name. + isRequired: true + types: + - + - name: if_none_match + description: 'ETag of the trigger entity. Should only be specified for get. If + the ETag + + matches the existing entity tag, or if * was provided, then no content will + be returned.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: TriggerResource, or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.TriggerOperations.get_triggers_by_workspace + name: get_triggers_by_workspace + summary: Lists triggers. + signature: get_triggers_by_workspace(**kwargs) -> AsyncIterable[TriggerListResponse] + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either TriggerListResponse or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.artifacts.aio.operations_async.TriggerOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.TriggerRunOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.TriggerRunOperations.yml new file mode 100644 index 00000000..3a08bba1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.TriggerRunOperations.yml @@ -0,0 +1,84 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.aio.operations_async.TriggerRunOperations +name: TriggerRunOperations +fullName: azure.synapse.artifacts.aio.operations_async.TriggerRunOperations +module: azure.synapse.artifacts.aio.operations_async +summary: 'TriggerRunOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: TriggerRunOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.artifacts.aio.operations_async.TriggerRunOperations.query_trigger_runs_by_workspace + name: query_trigger_runs_by_workspace + summary: Query trigger runs. + signature: 'async query_trigger_runs_by_workspace(filter_parameters: RunFilterParameters, + **kwargs) -> TriggerRunsQueryResponse' + parameters: + - name: filter_parameters + description: Parameters to filter the pipeline run. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: TriggerRunsQueryResponse, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.aio.operations_async.TriggerRunOperations.rerun_trigger_instance + name: rerun_trigger_instance + summary: Rerun single trigger instance by runId. + signature: 'async rerun_trigger_instance(trigger_name: str, run_id: str, **kwargs) + -> None' + parameters: + - name: trigger_name + description: The trigger name. + isRequired: true + types: + - + - name: run_id + description: The pipeline run identifier. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.artifacts.aio.operations_async.TriggerRunOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.yml new file mode 100644 index 00000000..cbfc5101 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.operations_async.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonPackage +uid: azure.synapse.artifacts.aio.operations_async +name: operations_async +fullName: azure.synapse.artifacts.aio.operations_async +type: import +classes: +- azure.synapse.artifacts.aio.operations_async.DataFlowDebugSessionOperations +- azure.synapse.artifacts.aio.operations_async.DataFlowOperations +- azure.synapse.artifacts.aio.operations_async.DatasetOperations +- azure.synapse.artifacts.aio.operations_async.LinkedServiceOperations +- azure.synapse.artifacts.aio.operations_async.NotebookOperations +- azure.synapse.artifacts.aio.operations_async.PipelineOperations +- azure.synapse.artifacts.aio.operations_async.PipelineRunOperations +- azure.synapse.artifacts.aio.operations_async.SparkJobDefinitionOperations +- azure.synapse.artifacts.aio.operations_async.SqlScriptOperations +- azure.synapse.artifacts.aio.operations_async.TriggerOperations +- azure.synapse.artifacts.aio.operations_async.TriggerRunOperations diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.yml new file mode 100644 index 00000000..11034f45 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.aio.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.synapse.artifacts.aio +name: aio +fullName: azure.synapse.artifacts.aio +type: import +classes: +- azure.synapse.artifacts.aio.ArtifactsClient +packages: +- azure.synapse.artifacts.aio.operations_async diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Activity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Activity.yml new file mode 100644 index 00000000..966e8898 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Activity.yml @@ -0,0 +1,170 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.Activity +name: Activity +fullName: azure.synapse.artifacts.models.Activity +module: azure.synapse.artifacts.models +summary: 'A pipeline activity. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: AppendVariableActivity, ControlActivity, ExecutePipelineActivity, + ExecutionActivity, FilterActivity, ForEachActivity, IfConditionActivity, SetVariableActivity, + SwitchActivity, UntilActivity, ValidationActivity, WaitActivity, WebHookActivity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Activity(*, name: str, additional_properties: Dict[str, object] | None + = None, description: str | None = None, depends_on: List[ActivityDependency] | + None = None, user_properties: List[UserProperty] | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.Activity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Activity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Activity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.Activity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Activity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.Activity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Activity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityDependency.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityDependency.yml new file mode 100644 index 00000000..2d8d8053 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityDependency.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ActivityDependency +name: ActivityDependency +fullName: azure.synapse.artifacts.models.ActivityDependency +module: azure.synapse.artifacts.models +summary: 'Activity dependency information. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ActivityDependency(*, activity: str, dependency_conditions: List[str | + DependencyCondition], additional_properties: Dict[str, object] | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: activity + description: Required. Activity name. + isRequired: true + types: + - + - name: dependency_conditions + description: Required. Match-Condition for the dependency. + isRequired: true + types: + - [ + - ] + keywordOnlyParameters: + - name: activity + isRequired: true + - name: dependency_conditions + isRequired: true + - name: additional_properties + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ActivityDependency.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ActivityDependency.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ActivityDependency.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ActivityDependency.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ActivityDependency.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ActivityDependency.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ActivityDependency.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityPolicy.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityPolicy.yml new file mode 100644 index 00000000..5672e836 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityPolicy.yml @@ -0,0 +1,179 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ActivityPolicy +name: ActivityPolicy +fullName: azure.synapse.artifacts.models.ActivityPolicy +module: azure.synapse.artifacts.models +summary: Execution policy for an activity. +constructor: + syntax: 'ActivityPolicy(*, additional_properties: Dict[str, object] | None = None, + timeout: object | None = None, retry: object | None = None, retry_interval_in_seconds: + int | None = None, secure_input: bool | None = None, secure_output: bool | None + = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: timeout + description: 'Specifies the timeout for the activity to run. The default timeout + is 7 days. + + Type: string (or Expression with resultType string), pattern: + + ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).' + isRequired: true + types: + - + - name: retry + description: 'Maximum ordinary retry attempts. Default is 0. Type: integer (or + Expression with + + resultType integer), minimum: 0.' + isRequired: true + types: + - + - name: retry_interval_in_seconds + description: 'Interval between each retry attempt (in seconds). The default + + is 30 sec.' + isRequired: true + types: + - + - name: secure_input + description: 'When set to true, Input from activity is considered as secure and + will not + + be logged to monitoring.' + isRequired: true + types: + - + - name: secure_output + description: 'When set to true, Output from activity is considered as secure and + will + + not be logged to monitoring.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: timeout + isRequired: true + - name: retry + isRequired: true + - name: retry_interval_in_seconds + isRequired: true + - name: secure_input + isRequired: true + - name: secure_output + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ActivityPolicy.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ActivityPolicy.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ActivityPolicy.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ActivityPolicy.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ActivityPolicy.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ActivityPolicy.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ActivityPolicy.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRun.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRun.yml new file mode 100644 index 00000000..3692dd91 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRun.yml @@ -0,0 +1,182 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ActivityRun +name: ActivityRun +fullName: azure.synapse.artifacts.models.ActivityRun +module: azure.synapse.artifacts.models +summary: 'Information about an activity run in a pipeline. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'ActivityRun(*, additional_properties: Dict[str, object] | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: additional_properties + isRequired: true +variables: +- description: The name of the pipeline. + name: pipeline_name + types: + - +- description: The id of the pipeline run. + name: pipeline_run_id + types: + - +- description: The name of the activity. + name: activity_name + types: + - +- description: The type of the activity. + name: activity_type + types: + - +- description: The id of the activity run. + name: activity_run_id + types: + - +- description: The name of the compute linked service. + name: linked_service_name + types: + - +- description: The status of the activity run. + name: status + types: + - +- description: The start time of the activity run in 'ISO 8601' format. + name: activity_run_start + types: + - +- description: The end time of the activity run in 'ISO 8601' format. + name: activity_run_end + types: + - +- description: The duration of the activity run. + name: duration_in_ms + types: + - +- description: The input for the activity. + name: input + types: + - +- description: The output for the activity. + name: output + types: + - +- description: The error if any from the activity run. + name: error + types: + - +methods: +- uid: azure.synapse.artifacts.models.ActivityRun.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ActivityRun.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ActivityRun.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ActivityRun.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ActivityRun.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ActivityRun.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ActivityRun.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRunsQueryResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRunsQueryResponse.yml new file mode 100644 index 00000000..3abfe7fb --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRunsQueryResponse.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ActivityRunsQueryResponse +name: ActivityRunsQueryResponse +fullName: azure.synapse.artifacts.models.ActivityRunsQueryResponse +module: azure.synapse.artifacts.models +summary: 'A list activity runs. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ActivityRunsQueryResponse(*, value: List[ActivityRun], continuation_token: + str | None = None, **kwargs)' + parameters: + - name: value + description: Required. List of activity runs. + isRequired: true + types: + - [] + - name: continuation_token + description: 'The continuation token for getting the next page of results, if + any + + remaining results exist, null otherwise.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: continuation_token + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ActivityRunsQueryResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ActivityRunsQueryResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ActivityRunsQueryResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ActivityRunsQueryResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ActivityRunsQueryResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ActivityRunsQueryResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ActivityRunsQueryResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse.yml new file mode 100644 index 00000000..b1d8b2d9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse +name: AddDataFlowToDebugSessionResponse +fullName: azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse +module: azure.synapse.artifacts.models +summary: Response body structure for starting data flow debug session. +constructor: + syntax: 'AddDataFlowToDebugSessionResponse(*, job_version: str | None = None, **kwargs)' + parameters: + - name: job_version + description: The ID of data flow debug job version. + isRequired: true + types: + - + keywordOnlyParameters: + - name: job_version + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSLinkedService.yml new file mode 100644 index 00000000..2f88f202 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSLinkedService.yml @@ -0,0 +1,260 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AmazonMWSLinkedService +name: AmazonMWSLinkedService +fullName: azure.synapse.artifacts.models.AmazonMWSLinkedService +module: azure.synapse.artifacts.models +summary: 'Amazon Marketplace Web Service linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AmazonMWSLinkedService(*, endpoint: object, marketplace_id: object, seller_id: + object, access_key_id: object, additional_properties: Dict[str, object] | None + = None, connect_via: IntegrationRuntimeReference | None = None, description: str + | None = None, parameters: Dict[str, ParameterSpecification] | None = None, annotations: + List[object] | None = None, mws_auth_token: SecretBase | None = None, secret_key: + SecretBase | None = None, use_encrypted_endpoints: object | None = None, use_host_verification: + object | None = None, use_peer_verification: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: endpoint + description: 'Required. The endpoint of the Amazon MWS server, (i.e. + + mws.amazonservices.com).' + isRequired: true + types: + - + - name: marketplace_id + description: 'Required. The Amazon Marketplace ID you want to retrieve data from. + To + + retrieve data from multiple Marketplace IDs, separate them with a comma (,). + (i.e. + + A2EUQ1WTGCTBG2).' + isRequired: true + types: + - + - name: seller_id + description: Required. The Amazon seller ID. + isRequired: true + types: + - + - name: mws_auth_token + description: The Amazon MWS authentication token. + isRequired: true + types: + - + - name: access_key_id + description: Required. The access key id used to access data. + isRequired: true + types: + - + - name: secret_key + description: The secret key used to access data. + isRequired: true + types: + - + - name: use_encrypted_endpoints + description: 'Specifies whether the data source endpoints are encrypted using + + HTTPS. The default value is true.' + isRequired: true + types: + - + - name: use_host_verification + description: 'Specifies whether to require the host name in the server''s + + certificate to match the host name of the server when connecting over SSL. The + default value is + + true.' + isRequired: true + types: + - + - name: use_peer_verification + description: 'Specifies whether to verify the identity of the server when + + connecting over SSL. The default value is true.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: endpoint + isRequired: true + - name: marketplace_id + isRequired: true + - name: seller_id + isRequired: true + - name: access_key_id + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: mws_auth_token + isRequired: true + - name: secret_key + isRequired: true + - name: use_encrypted_endpoints + isRequired: true + - name: use_host_verification + isRequired: true + - name: use_peer_verification + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AmazonMWSLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AmazonMWSLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AmazonMWSLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AmazonMWSLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AmazonMWSLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AmazonMWSLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AmazonMWSLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSObjectDataset.yml new file mode 100644 index 00000000..2493baa4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSObjectDataset.yml @@ -0,0 +1,203 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AmazonMWSObjectDataset +name: AmazonMWSObjectDataset +fullName: azure.synapse.artifacts.models.AmazonMWSObjectDataset +module: azure.synapse.artifacts.models +summary: 'Amazon Marketplace Web Service dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AmazonMWSObjectDataset(*, linked_service_name: LinkedServiceReference, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, structure: object | None = None, schema: object | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, folder: DatasetFolder | None = None, table_name: object | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AmazonMWSObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AmazonMWSObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AmazonMWSObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AmazonMWSObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AmazonMWSObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AmazonMWSObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AmazonMWSObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftLinkedService.yml new file mode 100644 index 00000000..0aa5916e --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftLinkedService.yml @@ -0,0 +1,226 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AmazonRedshiftLinkedService +name: AmazonRedshiftLinkedService +fullName: azure.synapse.artifacts.models.AmazonRedshiftLinkedService +module: azure.synapse.artifacts.models +summary: 'Linked service for Amazon Redshift. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AmazonRedshiftLinkedService(*, server: object, database: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, username: object | None + = None, password: SecretBase | None = None, port: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: server + description: 'Required. The name of the Amazon Redshift server. Type: string (or + Expression + + with resultType string).' + isRequired: true + types: + - + - name: username + description: 'The username of the Amazon Redshift source. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: password + description: The password of the Amazon Redshift source. + isRequired: true + types: + - + - name: database + description: 'Required. The database name of the Amazon Redshift source. Type: + string (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: port + description: 'The TCP port number that the Amazon Redshift server uses to listen + for client + + connections. The default value is 5439. Type: integer (or Expression with resultType + integer).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: server + isRequired: true + - name: database + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: username + isRequired: true + - name: password + isRequired: true + - name: port + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AmazonRedshiftLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AmazonRedshiftLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AmazonRedshiftLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AmazonRedshiftLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AmazonRedshiftLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AmazonRedshiftLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AmazonRedshiftLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftTableDataset.yml new file mode 100644 index 00000000..508fd0ca --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftTableDataset.yml @@ -0,0 +1,225 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AmazonRedshiftTableDataset +name: AmazonRedshiftTableDataset +fullName: azure.synapse.artifacts.models.AmazonRedshiftTableDataset +module: azure.synapse.artifacts.models +summary: 'The Amazon Redshift table dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AmazonRedshiftTableDataset(*, linked_service_name: LinkedServiceReference, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, structure: object | None = None, schema: object | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, folder: DatasetFolder | None = None, table_name: object | None = None, + table: object | None = None, schema_type_properties_schema: object | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'This property will be retired. Please consider using schema + table + + properties instead.' + isRequired: true + types: + - + - name: table + description: 'The Amazon Redshift table name. Type: string (or Expression with + resultType + + string).' + isRequired: true + types: + - + - name: schema_type_properties_schema + description: 'The Amazon Redshift schema name. Type: string (or + + Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true + - name: table + isRequired: true + - name: schema_type_properties_schema + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AmazonRedshiftTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AmazonRedshiftTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AmazonRedshiftTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AmazonRedshiftTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AmazonRedshiftTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AmazonRedshiftTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AmazonRedshiftTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonS3LinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonS3LinkedService.yml new file mode 100644 index 00000000..a025676a --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonS3LinkedService.yml @@ -0,0 +1,209 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AmazonS3LinkedService +name: AmazonS3LinkedService +fullName: azure.synapse.artifacts.models.AmazonS3LinkedService +module: azure.synapse.artifacts.models +summary: 'Linked service for Amazon S3. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AmazonS3LinkedService(*, additional_properties: Dict[str, object] | None + = None, connect_via: IntegrationRuntimeReference | None = None, description: str + | None = None, parameters: Dict[str, ParameterSpecification] | None = None, annotations: + List[object] | None = None, access_key_id: object | None = None, secret_access_key: + SecretBase | None = None, service_url: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: access_key_id + description: 'The access key identifier of the Amazon S3 Identity and Access Management + + (IAM) user. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: secret_access_key + description: 'The secret access key of the Amazon S3 Identity and Access Management + + (IAM) user.' + isRequired: true + types: + - + - name: service_url + description: 'This value specifies the endpoint to access with the S3 Connector. + This is + + an optional property; change it only if you want to try a different service + endpoint or want to + + switch between https and http. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: access_key_id + isRequired: true + - name: secret_access_key + isRequired: true + - name: service_url + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AmazonS3LinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AmazonS3LinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AmazonS3LinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AmazonS3LinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AmazonS3LinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AmazonS3LinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AmazonS3LinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AppendVariableActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AppendVariableActivity.yml new file mode 100644 index 00000000..2902e7ce --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AppendVariableActivity.yml @@ -0,0 +1,178 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AppendVariableActivity +name: AppendVariableActivity +fullName: azure.synapse.artifacts.models.AppendVariableActivity +module: azure.synapse.artifacts.models +summary: 'Append value for a Variable of type Array. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AppendVariableActivity(*, name: str, additional_properties: Dict[str, object] + | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, variable_name: + str | None = None, value: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: variable_name + description: Name of the variable whose value needs to be appended to. + isRequired: true + types: + - + - name: value + description: Value to be appended. Could be a static value or Expression. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: variable_name + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AppendVariableActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AppendVariableActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AppendVariableActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AppendVariableActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AppendVariableActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AppendVariableActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AppendVariableActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroCompressionCodec.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroCompressionCodec.yml new file mode 100644 index 00000000..305ffff6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroCompressionCodec.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.AvroCompressionCodec +name: AvroCompressionCodec +fullName: azure.synapse.artifacts.models.AvroCompressionCodec +module: azure.synapse.artifacts.models +fields: +- name: bzip2 + uid: azure.synapse.artifacts.models.AvroCompressionCodec.bzip2 +- name: deflate + uid: azure.synapse.artifacts.models.AvroCompressionCodec.deflate +- name: none + uid: azure.synapse.artifacts.models.AvroCompressionCodec.none +- name: snappy + uid: azure.synapse.artifacts.models.AvroCompressionCodec.snappy +- name: xz + uid: azure.synapse.artifacts.models.AvroCompressionCodec.xz diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroDataset.yml new file mode 100644 index 00000000..b08d3506 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroDataset.yml @@ -0,0 +1,220 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AvroDataset +name: AvroDataset +fullName: azure.synapse.artifacts.models.AvroDataset +module: azure.synapse.artifacts.models +summary: 'Avro dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AvroDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, location: DatasetLocation | None = None, avro_compression_codec: + str | AvroCompressionCodec | None = None, avro_compression_level: int | None = + None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: location + description: The location of the avro storage. + isRequired: true + types: + - + - name: avro_compression_codec + description: 'Possible values include: "none", "deflate", "snappy", "xz", + + "bzip2".' + isRequired: true + types: + - + - + - name: avro_compression_level + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: location + isRequired: true + - name: avro_compression_codec + isRequired: true + - name: avro_compression_level + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AvroDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AvroDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AvroDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AvroDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AvroDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AvroDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AvroDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBatchLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBatchLinkedService.yml new file mode 100644 index 00000000..374ef312 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBatchLinkedService.yml @@ -0,0 +1,222 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureBatchLinkedService +name: AzureBatchLinkedService +fullName: azure.synapse.artifacts.models.AzureBatchLinkedService +module: azure.synapse.artifacts.models +summary: 'Azure Batch linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureBatchLinkedService(*, account_name: object, batch_uri: object, pool_name: + object, linked_service_name: LinkedServiceReference, additional_properties: Dict[str, + object] | None = None, connect_via: IntegrationRuntimeReference | None = None, + description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, access_key: SecretBase + | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: account_name + description: 'Required. The Azure Batch account name. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: access_key + description: The Azure Batch account access key. + isRequired: true + types: + - + - name: batch_uri + description: 'Required. The Azure Batch URI. Type: string (or Expression with + resultType + + string).' + isRequired: true + types: + - + - name: pool_name + description: 'Required. The Azure Batch pool name. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: linked_service_name + description: Required. The Azure Storage linked service reference. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: account_name + isRequired: true + - name: batch_uri + isRequired: true + - name: pool_name + isRequired: true + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: access_key + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureBatchLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureBatchLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureBatchLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureBatchLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureBatchLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureBatchLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureBatchLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSLinkedService.yml new file mode 100644 index 00000000..2c75acd6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSLinkedService.yml @@ -0,0 +1,228 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureBlobFSLinkedService +name: AzureBlobFSLinkedService +fullName: azure.synapse.artifacts.models.AzureBlobFSLinkedService +module: azure.synapse.artifacts.models +summary: 'Azure Data Lake Storage Gen2 linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureBlobFSLinkedService(*, url: object, additional_properties: Dict[str, + object] | None = None, connect_via: IntegrationRuntimeReference | None = None, + description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, account_key: object | + None = None, service_principal_id: object | None = None, service_principal_key: + SecretBase | None = None, tenant: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: url + description: 'Required. Endpoint for the Azure Data Lake Storage Gen2 service. + Type: string (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: account_key + description: 'Account key for the Azure Data Lake Storage Gen2 service. Type: + string (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: service_principal_id + description: 'The ID of the application used to authenticate against the Azure + + Data Lake Storage Gen2 account. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: service_principal_key + description: 'The Key of the application used to authenticate against the Azure + + Data Lake Storage Gen2 account.' + isRequired: true + types: + - + - name: tenant + description: 'The name or ID of the tenant to which the service principal belongs. + Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: url + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: account_key + isRequired: true + - name: service_principal_id + isRequired: true + - name: service_principal_key + isRequired: true + - name: tenant + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureBlobFSLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureBlobFSLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureBlobFSLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureBlobFSLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureBlobFSLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureBlobFSLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureBlobFSLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobStorageLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobStorageLinkedService.yml new file mode 100644 index 00000000..f74482d7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobStorageLinkedService.yml @@ -0,0 +1,254 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureBlobStorageLinkedService +name: AzureBlobStorageLinkedService +fullName: azure.synapse.artifacts.models.AzureBlobStorageLinkedService +module: azure.synapse.artifacts.models +summary: 'The azure blob storage linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureBlobStorageLinkedService(*, additional_properties: Dict[str, object] + | None = None, connect_via: IntegrationRuntimeReference | None = None, description: + str | None = None, parameters: Dict[str, ParameterSpecification] | None = None, + annotations: List[object] | None = None, connection_string: object | None = None, + account_key: AzureKeyVaultSecretReference | None = None, sas_uri: object | None + = None, sas_token: AzureKeyVaultSecretReference | None = None, service_endpoint: + str | None = None, service_principal_id: object | None = None, service_principal_key: + SecretBase | None = None, tenant: object | None = None, encrypted_credential: + str | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'The connection string. It is mutually exclusive with sasUri, + + serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: account_key + description: The Azure key vault secret reference of accountKey in connection + string. + isRequired: true + types: + - + - name: sas_uri + description: 'SAS URI of the Azure Blob Storage resource. It is mutually exclusive + with + + connectionString, serviceEndpoint property. Type: string, SecureString or + + AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: sas_token + description: The Azure key vault secret reference of sasToken in sas uri. + isRequired: true + types: + - + - name: service_endpoint + description: 'Blob service endpoint of the Azure Blob Storage resource. It is + + mutually exclusive with connectionString, sasUri property.' + isRequired: true + types: + - + - name: service_principal_id + description: 'The ID of the service principal used to authenticate against Azure + + SQL Data Warehouse. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: service_principal_key + description: 'The key of the service principal used to authenticate against + + Azure SQL Data Warehouse.' + isRequired: true + types: + - + - name: tenant + description: 'The name or ID of the tenant to which the service principal belongs. + Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: connection_string + isRequired: true + - name: account_key + isRequired: true + - name: sas_uri + isRequired: true + - name: sas_token + isRequired: true + - name: service_endpoint + isRequired: true + - name: service_principal_id + isRequired: true + - name: service_principal_key + isRequired: true + - name: tenant + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureBlobStorageLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureBlobStorageLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureBlobStorageLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureBlobStorageLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureBlobStorageLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureBlobStorageLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureBlobStorageLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerCommandActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerCommandActivity.yml new file mode 100644 index 00000000..fb082c47 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerCommandActivity.yml @@ -0,0 +1,198 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureDataExplorerCommandActivity +name: AzureDataExplorerCommandActivity +fullName: azure.synapse.artifacts.models.AzureDataExplorerCommandActivity +module: azure.synapse.artifacts.models +summary: 'Azure Data Explorer command activity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureDataExplorerCommandActivity(*, name: str, command: object, additional_properties: + Dict[str, object] | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, linked_service_name: + LinkedServiceReference | None = None, policy: ActivityPolicy | None = None, command_timeout: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + - name: command + description: 'Required. A control command, according to the Azure Data Explorer + command + + syntax. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: command_timeout + description: 'Control command timeout. Type: string (or Expression with resultType + + string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9]))..).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: command + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true + - name: command_timeout + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureDataExplorerCommandActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureDataExplorerCommandActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureDataExplorerCommandActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureDataExplorerCommandActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureDataExplorerCommandActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureDataExplorerCommandActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureDataExplorerCommandActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerLinkedService.yml new file mode 100644 index 00000000..e11bdd37 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerLinkedService.yml @@ -0,0 +1,215 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureDataExplorerLinkedService +name: AzureDataExplorerLinkedService +fullName: azure.synapse.artifacts.models.AzureDataExplorerLinkedService +module: azure.synapse.artifacts.models +summary: 'Azure Data Explorer (Kusto) linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureDataExplorerLinkedService(*, endpoint: object, service_principal_id: + object, service_principal_key: SecretBase, database: object, tenant: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: endpoint + description: 'Required. The endpoint of Azure Data Explorer (the engine''s endpoint). + URL + + will be in the format [https://](https://)``.:code:**.kusto.windows.net. + + Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: service_principal_id + description: 'Required. The ID of the service principal used to authenticate + + against Azure Data Explorer. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: service_principal_key + description: 'Required. The key of the service principal used to authenticate + + against Kusto.' + isRequired: true + types: + - + - name: database + description: 'Required. Database name for connection. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: tenant + description: 'Required. The name or ID of the tenant to which the service principal + belongs. + + Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: endpoint + isRequired: true + - name: service_principal_id + isRequired: true + - name: service_principal_key + isRequired: true + - name: database + isRequired: true + - name: tenant + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureDataExplorerLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureDataExplorerLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureDataExplorerLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureDataExplorerLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureDataExplorerLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureDataExplorerLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureDataExplorerLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerTableDataset.yml new file mode 100644 index 00000000..e5fe1579 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerTableDataset.yml @@ -0,0 +1,205 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureDataExplorerTableDataset +name: AzureDataExplorerTableDataset +fullName: azure.synapse.artifacts.models.AzureDataExplorerTableDataset +module: azure.synapse.artifacts.models +summary: 'The Azure Data Explorer (Kusto) dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureDataExplorerTableDataset(*, linked_service_name: LinkedServiceReference, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, structure: object | None = None, schema: object | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, folder: DatasetFolder | None = None, table: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table + description: 'The table name of the Azure Data Explorer database. Type: string + (or Expression + + with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureDataExplorerTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureDataExplorerTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureDataExplorerTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureDataExplorerTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureDataExplorerTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureDataExplorerTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureDataExplorerTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService.yml new file mode 100644 index 00000000..80161016 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService.yml @@ -0,0 +1,244 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService +name: AzureDataLakeAnalyticsLinkedService +fullName: azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService +module: azure.synapse.artifacts.models +summary: 'Azure Data Lake Analytics linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureDataLakeAnalyticsLinkedService(*, account_name: object, tenant: object, + additional_properties: Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference + | None = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, service_principal_id: + object | None = None, service_principal_key: SecretBase | None = None, subscription_id: + object | None = None, resource_group_name: object | None = None, data_lake_analytics_uri: + object | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: account_name + description: 'Required. The Azure Data Lake Analytics account name. Type: string + (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: service_principal_id + description: 'The ID of the application used to authenticate against the Azure + + Data Lake Analytics account. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: service_principal_key + description: 'The Key of the application used to authenticate against the Azure + + Data Lake Analytics account.' + isRequired: true + types: + - + - name: tenant + description: 'Required. The name or ID of the tenant to which the service principal + belongs. + + Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: subscription_id + description: 'Data Lake Analytics account subscription ID (if different from Data + + Factory account). Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: resource_group_name + description: 'Data Lake Analytics account resource group name (if different from + + Data Factory account). Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: data_lake_analytics_uri + description: 'Azure Data Lake Analytics URI Type: string (or Expression with + + resultType string).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: account_name + isRequired: true + - name: tenant + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: service_principal_id + isRequired: true + - name: service_principal_key + isRequired: true + - name: subscription_id + isRequired: true + - name: resource_group_name + isRequired: true + - name: data_lake_analytics_uri + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService.yml new file mode 100644 index 00000000..8b69fa45 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService.yml @@ -0,0 +1,245 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService +name: AzureDataLakeStoreLinkedService +fullName: azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService +module: azure.synapse.artifacts.models +summary: 'Azure Data Lake Store linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureDataLakeStoreLinkedService(*, data_lake_store_uri: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, service_principal_id: + object | None = None, service_principal_key: SecretBase | None = None, tenant: + object | None = None, account_name: object | None = None, subscription_id: object + | None = None, resource_group_name: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: data_lake_store_uri + description: 'Required. Data Lake Store service URI. Type: string (or Expression + + with resultType string).' + isRequired: true + types: + - + - name: service_principal_id + description: 'The ID of the application used to authenticate against the Azure + + Data Lake Store account. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: service_principal_key + description: 'The Key of the application used to authenticate against the Azure + + Data Lake Store account.' + isRequired: true + types: + - + - name: tenant + description: 'The name or ID of the tenant to which the service principal belongs. + Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: account_name + description: 'Data Lake Store account name. Type: string (or Expression with resultType + + string).' + isRequired: true + types: + - + - name: subscription_id + description: 'Data Lake Store account subscription ID (if different from Data + Factory + + account). Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: resource_group_name + description: 'Data Lake Store account resource group name (if different from Data + + Factory account). Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: data_lake_store_uri + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: service_principal_id + isRequired: true + - name: service_principal_key + isRequired: true + - name: tenant + isRequired: true + - name: account_name + isRequired: true + - name: subscription_id + isRequired: true + - name: resource_group_name + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksLinkedService.yml new file mode 100644 index 00000000..0fd06f8e --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksLinkedService.yml @@ -0,0 +1,333 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureDatabricksLinkedService +name: AzureDatabricksLinkedService +fullName: azure.synapse.artifacts.models.AzureDatabricksLinkedService +module: azure.synapse.artifacts.models +summary: 'Azure Databricks linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureDatabricksLinkedService(*, domain: object, access_token: SecretBase, + additional_properties: Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference + | None = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, existing_cluster_id: object + | None = None, instance_pool_id: object | None = None, new_cluster_version: object + | None = None, new_cluster_num_of_worker: object | None = None, new_cluster_node_type: + object | None = None, new_cluster_spark_conf: Dict[str, object] | None = None, + new_cluster_spark_env_vars: Dict[str, object] | None = None, new_cluster_custom_tags: + Dict[str, object] | None = None, new_cluster_driver_node_type: object | None = + None, new_cluster_init_scripts: object | None = None, new_cluster_enable_elastic_disk: + object | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: domain + description: 'Required. ``.azuredatabricks.net, domain name of your Databricks + + deployment. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: access_token + description: 'Required. Access token for databricks REST API. Refer to + + [https://docs.azuredatabricks.net/api/latest/authentication.html](https://docs.azuredatabricks.net/api/latest/authentication.html). + Type: string (or Expression + + with resultType string).' + isRequired: true + types: + - + - name: existing_cluster_id + description: 'The id of an existing interactive cluster that will be used for + all + + runs of this activity. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: instance_pool_id + description: 'The id of an existing instance pool that will be used for all runs + of + + this activity. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: new_cluster_version + description: 'If not using an existing interactive cluster, this specifies the + + Spark version of a new job cluster or instance pool nodes created for each run + of this + + activity. Required if instancePoolId is specified. Type: string (or Expression + with resultType + + string).' + isRequired: true + types: + - + - name: new_cluster_num_of_worker + description: 'If not using an existing interactive cluster, this specifies + + the number of worker nodes to use for the new job cluster or instance pool. + For new job + + clusters, this a string-formatted Int32, like ''1'' means numOfWorker is 1 or + ''1:10'' means auto- + + scale from 1 (min) to 10 (max). For instance pools, this is a string-formatted + Int32, and can + + only specify a fixed number of worker nodes, such as ''2''. Required if newClusterVersion + is + + specified. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: new_cluster_node_type + description: 'The node type of the new job cluster. This property is required + + if newClusterVersion is specified and instancePoolId is not specified. If instancePoolId + is + + specified, this property is ignored. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: new_cluster_spark_conf + description: 'A set of optional, user-specified Spark configuration key-value + + pairs.' + isRequired: true + types: + - [, ] + - name: new_cluster_spark_env_vars + description: 'A set of optional, user-specified Spark environment + + variables key-value pairs.' + isRequired: true + types: + - [, ] + - name: new_cluster_custom_tags + description: 'Additional tags for cluster resources. This property is ignored + + in instance pool configurations.' + isRequired: true + types: + - [, ] + - name: new_cluster_driver_node_type + description: 'The driver node type for the new job cluster. This + + property is ignored in instance pool configurations. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: new_cluster_init_scripts + description: 'User-defined initialization scripts for the new cluster. Type: + + array of strings (or Expression with resultType array of strings).' + isRequired: true + types: + - + - name: new_cluster_enable_elastic_disk + description: 'Enable the elastic disk on the new cluster. This + + property is now ignored, and takes the default elastic disk behavior in Databricks + (elastic + + disks are always enabled). Type: boolean (or Expression with resultType boolean).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: domain + isRequired: true + - name: access_token + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: existing_cluster_id + isRequired: true + - name: instance_pool_id + isRequired: true + - name: new_cluster_version + isRequired: true + - name: new_cluster_num_of_worker + isRequired: true + - name: new_cluster_node_type + isRequired: true + - name: new_cluster_spark_conf + isRequired: true + - name: new_cluster_spark_env_vars + isRequired: true + - name: new_cluster_custom_tags + isRequired: true + - name: new_cluster_driver_node_type + isRequired: true + - name: new_cluster_init_scripts + isRequired: true + - name: new_cluster_enable_elastic_disk + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureDatabricksLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureDatabricksLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureDatabricksLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureDatabricksLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureDatabricksLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureDatabricksLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureDatabricksLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFileStorageLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFileStorageLinkedService.yml new file mode 100644 index 00000000..a9838e84 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFileStorageLinkedService.yml @@ -0,0 +1,204 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureFileStorageLinkedService +name: AzureFileStorageLinkedService +fullName: azure.synapse.artifacts.models.AzureFileStorageLinkedService +module: azure.synapse.artifacts.models +summary: 'Azure File Storage linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureFileStorageLinkedService(*, host: object, additional_properties: Dict[str, + object] | None = None, connect_via: IntegrationRuntimeReference | None = None, + description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, user_id: object | None + = None, password: SecretBase | None = None, encrypted_credential: object | None + = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: host + description: 'Required. Host name of the server. Type: string (or Expression with + resultType + + string).' + isRequired: true + types: + - + - name: user_id + description: 'User ID to logon the server. Type: string (or Expression with resultType + + string).' + isRequired: true + types: + - + - name: password + description: Password to logon the server. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: host + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: user_id + isRequired: true + - name: password + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureFileStorageLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureFileStorageLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureFileStorageLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureFileStorageLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureFileStorageLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureFileStorageLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureFileStorageLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionActivity.yml new file mode 100644 index 00000000..bbe566eb --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionActivity.yml @@ -0,0 +1,225 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureFunctionActivity +name: AzureFunctionActivity +fullName: azure.synapse.artifacts.models.AzureFunctionActivity +module: azure.synapse.artifacts.models +summary: 'Azure Function activity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureFunctionActivity(*, name: str, method: str | AzureFunctionActivityMethod, + function_name: object, additional_properties: Dict[str, object] | None = None, + description: str | None = None, depends_on: List[ActivityDependency] | None = + None, user_properties: List[UserProperty] | None = None, linked_service_name: + LinkedServiceReference | None = None, policy: ActivityPolicy | None = None, headers: + object | None = None, body: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + - name: method + description: 'Required. Rest API method for target endpoint. Possible values include: + "GET", + + "POST", "PUT", "DELETE", "OPTIONS", "HEAD", "TRACE".' + isRequired: true + types: + - + - + - name: function_name + description: 'Required. Name of the Function that the Azure Function Activity + will + + call. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: headers + description: 'Represents the headers that will be sent to the request. For example, + to set + + the language and type on a request: "headers" : { "Accept-Language": "en-us", + "Content-Type": + + "application/json" }. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: body + description: 'Represents the payload that will be sent to the endpoint. Required + for POST/PUT + + method, not allowed for GET method Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: method + isRequired: true + - name: function_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true + - name: headers + isRequired: true + - name: body + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureFunctionActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureFunctionActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureFunctionActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureFunctionActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureFunctionActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureFunctionActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureFunctionActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionActivityMethod.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionActivityMethod.yml new file mode 100644 index 00000000..bcb13ce0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionActivityMethod.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.AzureFunctionActivityMethod +name: AzureFunctionActivityMethod +fullName: azure.synapse.artifacts.models.AzureFunctionActivityMethod +summary: The list of HTTP methods supported by a AzureFunctionActivity. +module: azure.synapse.artifacts.models +fields: +- name: delete + uid: azure.synapse.artifacts.models.AzureFunctionActivityMethod.delete +- name: get + uid: azure.synapse.artifacts.models.AzureFunctionActivityMethod.get +- name: head + uid: azure.synapse.artifacts.models.AzureFunctionActivityMethod.head +- name: options + uid: azure.synapse.artifacts.models.AzureFunctionActivityMethod.options +- name: post + uid: azure.synapse.artifacts.models.AzureFunctionActivityMethod.post +- name: put + uid: azure.synapse.artifacts.models.AzureFunctionActivityMethod.put +- name: trace + uid: azure.synapse.artifacts.models.AzureFunctionActivityMethod.trace diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionLinkedService.yml new file mode 100644 index 00000000..f72458cf --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionLinkedService.yml @@ -0,0 +1,194 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureFunctionLinkedService +name: AzureFunctionLinkedService +fullName: azure.synapse.artifacts.models.AzureFunctionLinkedService +module: azure.synapse.artifacts.models +summary: 'Azure Function linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureFunctionLinkedService(*, function_app_url: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, function_key: SecretBase + | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: function_app_url + description: 'Required. The endpoint of the Azure Function App. URL will be in + the + + format [https://](https://)``.azurewebsites.net.' + isRequired: true + types: + - + - name: function_key + description: Function or Host key for Azure Function App. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: function_app_url + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: function_key + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureFunctionLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureFunctionLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureFunctionLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureFunctionLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureFunctionLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureFunctionLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureFunctionLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultLinkedService.yml new file mode 100644 index 00000000..40d985d3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultLinkedService.yml @@ -0,0 +1,174 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureKeyVaultLinkedService +name: AzureKeyVaultLinkedService +fullName: azure.synapse.artifacts.models.AzureKeyVaultLinkedService +module: azure.synapse.artifacts.models +summary: 'Azure Key Vault linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureKeyVaultLinkedService(*, base_url: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: base_url + description: 'Required. The base URL of the Azure Key Vault. e.g. + + [https://myakv.vault.azure.net](https://myakv.vault.azure.net) Type: string + (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: base_url + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureKeyVaultLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureKeyVaultLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureKeyVaultLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureKeyVaultLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureKeyVaultLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureKeyVaultLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureKeyVaultLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultSecretReference.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultSecretReference.yml new file mode 100644 index 00000000..ebc4d3f9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultSecretReference.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureKeyVaultSecretReference +name: AzureKeyVaultSecretReference +fullName: azure.synapse.artifacts.models.AzureKeyVaultSecretReference +module: azure.synapse.artifacts.models +summary: 'Azure Key Vault secret reference. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureKeyVaultSecretReference(*, store: LinkedServiceReference, secret_name: + object, secret_version: object | None = None, **kwargs)' + parameters: + - name: type + description: Required. Type of the secret.Constant filled by server. + isRequired: true + types: + - + - name: store + description: Required. The Azure Key Vault linked service reference. + isRequired: true + types: + - + - name: secret_name + description: 'Required. The name of the secret in Azure Key Vault. Type: string + (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: secret_version + description: 'The version of the secret in Azure Key Vault. The default value + is the + + latest version of the secret. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: store + isRequired: true + - name: secret_name + isRequired: true + - name: secret_version + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureKeyVaultSecretReference.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureKeyVaultSecretReference.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureKeyVaultSecretReference.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureKeyVaultSecretReference.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureKeyVaultSecretReference.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureKeyVaultSecretReference.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureKeyVaultSecretReference.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLBatchExecutionActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLBatchExecutionActivity.yml new file mode 100644 index 00000000..4ee1eb4b --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLBatchExecutionActivity.yml @@ -0,0 +1,226 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureMLBatchExecutionActivity +name: AzureMLBatchExecutionActivity +fullName: azure.synapse.artifacts.models.AzureMLBatchExecutionActivity +module: azure.synapse.artifacts.models +summary: 'Azure ML Batch Execution activity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureMLBatchExecutionActivity(*, name: str, additional_properties: Dict[str, + object] | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, linked_service_name: + LinkedServiceReference | None = None, policy: ActivityPolicy | None = None, global_parameters: + Dict[str, object] | None = None, web_service_outputs: Dict[str, AzureMLWebServiceFile] + | None = None, web_service_inputs: Dict[str, AzureMLWebServiceFile] | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + - name: global_parameters + description: 'Key,Value pairs to be passed to the Azure ML Batch Execution Service + + endpoint. Keys must match the names of web service parameters defined in the + published Azure ML + + web service. Values will be passed in the GlobalParameters property of the Azure + ML batch + + execution request.' + isRequired: true + types: + - [, ] + - name: web_service_outputs + description: 'Key,Value pairs, mapping the names of Azure ML endpoint''s Web + + Service Outputs to AzureMLWebServiceFile objects specifying the output Blob + locations. This + + information will be passed in the WebServiceOutputs property of the Azure ML + batch execution + + request.' + isRequired: true + types: + - [, ] + - name: web_service_inputs + description: 'Key,Value pairs, mapping the names of Azure ML endpoint''s Web + + Service Inputs to AzureMLWebServiceFile objects specifying the input Blob locations.. + This + + information will be passed in the WebServiceInputs property of the Azure ML + batch execution + + request.' + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true + - name: global_parameters + isRequired: true + - name: web_service_outputs + isRequired: true + - name: web_service_inputs + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureMLBatchExecutionActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureMLBatchExecutionActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureMLBatchExecutionActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureMLBatchExecutionActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureMLBatchExecutionActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureMLBatchExecutionActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureMLBatchExecutionActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLExecutePipelineActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLExecutePipelineActivity.yml new file mode 100644 index 00000000..10c477d5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLExecutePipelineActivity.yml @@ -0,0 +1,244 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureMLExecutePipelineActivity +name: AzureMLExecutePipelineActivity +fullName: azure.synapse.artifacts.models.AzureMLExecutePipelineActivity +module: azure.synapse.artifacts.models +summary: 'Azure ML Execute Pipeline activity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureMLExecutePipelineActivity(*, name: str, ml_pipeline_id: object, additional_properties: + Dict[str, object] | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, linked_service_name: + LinkedServiceReference | None = None, policy: ActivityPolicy | None = None, experiment_name: + object | None = None, ml_pipeline_parameters: object | None = None, ml_parent_run_id: + object | None = None, continue_on_step_failure: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + - name: ml_pipeline_id + description: 'Required. ID of the published Azure ML pipeline. Type: string (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: experiment_name + description: 'Run history experiment name of the pipeline run. This information + will + + be passed in the ExperimentName property of the published pipeline execution + request. Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: ml_pipeline_parameters + description: 'Key,Value pairs to be passed to the published Azure ML pipeline + + endpoint. Keys must match the names of pipeline parameters defined in the published + pipeline. + + Values will be passed in the ParameterAssignments property of the published + pipeline execution + + request. Type: object with key value pairs (or Expression with resultType object).' + isRequired: true + types: + - + - name: ml_parent_run_id + description: 'The parent Azure ML Service pipeline run id. This information will + be + + passed in the ParentRunId property of the published pipeline execution request. + Type: string + + (or Expression with resultType string).' + isRequired: true + types: + - + - name: continue_on_step_failure + description: 'Whether to continue execution of other steps in the + + PipelineRun if a step fails. This information will be passed in the continueOnStepFailure + + property of the published pipeline execution request. Type: boolean (or Expression + with + + resultType boolean).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: ml_pipeline_id + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true + - name: experiment_name + isRequired: true + - name: ml_pipeline_parameters + isRequired: true + - name: ml_parent_run_id + isRequired: true + - name: continue_on_step_failure + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureMLExecutePipelineActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureMLExecutePipelineActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureMLExecutePipelineActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureMLExecutePipelineActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureMLExecutePipelineActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureMLExecutePipelineActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureMLExecutePipelineActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLLinkedService.yml new file mode 100644 index 00000000..cdbfc1de --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLLinkedService.yml @@ -0,0 +1,236 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureMLLinkedService +name: AzureMLLinkedService +fullName: azure.synapse.artifacts.models.AzureMLLinkedService +module: azure.synapse.artifacts.models +summary: 'Azure ML Studio Web Service linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureMLLinkedService(*, ml_endpoint: object, api_key: SecretBase, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, update_resource_endpoint: + object | None = None, service_principal_id: object | None = None, service_principal_key: + SecretBase | None = None, tenant: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: ml_endpoint + description: 'Required. The Batch Execution REST URL for an Azure ML Studio Web + Service + + endpoint. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: api_key + description: Required. The API key for accessing the Azure ML model endpoint. + isRequired: true + types: + - + - name: update_resource_endpoint + description: 'The Update Resource REST URL for an Azure ML Studio Web + + Service endpoint. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: service_principal_id + description: 'The ID of the service principal used to authenticate against the + + ARM-based updateResourceEndpoint of an Azure ML Studio web service. Type: string + (or Expression + + with resultType string).' + isRequired: true + types: + - + - name: service_principal_key + description: 'The key of the service principal used to authenticate against the + + ARM-based updateResourceEndpoint of an Azure ML Studio web service.' + isRequired: true + types: + - + - name: tenant + description: 'The name or ID of the tenant to which the service principal belongs. + Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: ml_endpoint + isRequired: true + - name: api_key + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: update_resource_endpoint + isRequired: true + - name: service_principal_id + isRequired: true + - name: service_principal_key + isRequired: true + - name: tenant + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureMLLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureMLLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureMLLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureMLLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureMLLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureMLLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureMLLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLServiceLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLServiceLinkedService.yml new file mode 100644 index 00000000..23ede041 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLServiceLinkedService.yml @@ -0,0 +1,238 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureMLServiceLinkedService +name: AzureMLServiceLinkedService +fullName: azure.synapse.artifacts.models.AzureMLServiceLinkedService +module: azure.synapse.artifacts.models +summary: 'Azure ML Service linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureMLServiceLinkedService(*, subscription_id: object, resource_group_name: + object, ml_workspace_name: object, additional_properties: Dict[str, object] | + None = None, connect_via: IntegrationRuntimeReference | None = None, description: + str | None = None, parameters: Dict[str, ParameterSpecification] | None = None, + annotations: List[object] | None = None, service_principal_id: object | None = + None, service_principal_key: SecretBase | None = None, tenant: object | None = + None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: subscription_id + description: 'Required. Azure ML Service workspace subscription ID. Type: string + (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: resource_group_name + description: 'Required. Azure ML Service workspace resource group name. Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: ml_workspace_name + description: 'Required. Azure ML Service workspace name. Type: string (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: service_principal_id + description: 'The ID of the service principal used to authenticate against the + + endpoint of a published Azure ML Service pipeline. Type: string (or Expression + with resultType + + string).' + isRequired: true + types: + - + - name: service_principal_key + description: 'The key of the service principal used to authenticate against the + + endpoint of a published Azure ML Service pipeline.' + isRequired: true + types: + - + - name: tenant + description: 'The name or ID of the tenant to which the service principal belongs. + Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: subscription_id + isRequired: true + - name: resource_group_name + isRequired: true + - name: ml_workspace_name + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: service_principal_id + isRequired: true + - name: service_principal_key + isRequired: true + - name: tenant + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureMLServiceLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureMLServiceLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureMLServiceLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureMLServiceLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureMLServiceLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureMLServiceLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureMLServiceLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLUpdateResourceActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLUpdateResourceActivity.yml new file mode 100644 index 00000000..6af33e31 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLUpdateResourceActivity.yml @@ -0,0 +1,210 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureMLUpdateResourceActivity +name: AzureMLUpdateResourceActivity +fullName: azure.synapse.artifacts.models.AzureMLUpdateResourceActivity +module: azure.synapse.artifacts.models +summary: 'Azure ML Update Resource management activity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureMLUpdateResourceActivity(*, name: str, trained_model_name: object, + trained_model_linked_service_name: LinkedServiceReference, trained_model_file_path: + object, additional_properties: Dict[str, object] | None = None, description: str + | None = None, depends_on: List[ActivityDependency] | None = None, user_properties: + List[UserProperty] | None = None, linked_service_name: LinkedServiceReference + | None = None, policy: ActivityPolicy | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + - name: trained_model_name + description: 'Required. Name of the Trained Model module in the Web Service + + experiment to be updated. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: trained_model_linked_service_name + description: 'Required. Name of Azure Storage linked service + + holding the .ilearner file that will be uploaded by the update operation.' + isRequired: true + types: + - + - name: trained_model_file_path + description: 'Required. The relative file path in trainedModelLinkedService + + to represent the .ilearner file that will be uploaded by the update operation. Type: + string + + (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: trained_model_name + isRequired: true + - name: trained_model_linked_service_name + isRequired: true + - name: trained_model_file_path + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureMLUpdateResourceActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureMLUpdateResourceActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureMLUpdateResourceActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureMLUpdateResourceActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureMLUpdateResourceActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureMLUpdateResourceActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureMLUpdateResourceActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLWebServiceFile.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLWebServiceFile.yml new file mode 100644 index 00000000..b736c408 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLWebServiceFile.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureMLWebServiceFile +name: AzureMLWebServiceFile +fullName: azure.synapse.artifacts.models.AzureMLWebServiceFile +module: azure.synapse.artifacts.models +summary: 'Azure ML WebService Input/Output file. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureMLWebServiceFile(*, file_path: object, linked_service_name: LinkedServiceReference, + **kwargs)' + parameters: + - name: file_path + description: 'Required. The relative file path, including container name, in the + Azure Blob + + Storage specified by the LinkedService. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: linked_service_name + description: 'Required. Reference to an Azure Storage LinkedService, where Azure + + ML WebService Input/Output file located.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: file_path + isRequired: true + - name: linked_service_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureMLWebServiceFile.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureMLWebServiceFile.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureMLWebServiceFile.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureMLWebServiceFile.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureMLWebServiceFile.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureMLWebServiceFile.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureMLWebServiceFile.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBLinkedService.yml new file mode 100644 index 00000000..f6302ad5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBLinkedService.yml @@ -0,0 +1,194 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureMariaDBLinkedService +name: AzureMariaDBLinkedService +fullName: azure.synapse.artifacts.models.AzureMariaDBLinkedService +module: azure.synapse.artifacts.models +summary: 'Azure Database for MariaDB linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureMariaDBLinkedService(*, additional_properties: Dict[str, object] | + None = None, connect_via: IntegrationRuntimeReference | None = None, description: + str | None = None, parameters: Dict[str, ParameterSpecification] | None = None, + annotations: List[object] | None = None, connection_string: object | None = None, + pwd: AzureKeyVaultSecretReference | None = None, encrypted_credential: object + | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'An ODBC connection string. Type: string, SecureString or + + AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: pwd + description: The Azure key vault secret reference of password in connection string. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: connection_string + isRequired: true + - name: pwd + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureMariaDBLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureMariaDBLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureMariaDBLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureMariaDBLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureMariaDBLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureMariaDBLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureMariaDBLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBTableDataset.yml new file mode 100644 index 00000000..c05611eb --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBTableDataset.yml @@ -0,0 +1,203 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureMariaDBTableDataset +name: AzureMariaDBTableDataset +fullName: azure.synapse.artifacts.models.AzureMariaDBTableDataset +module: azure.synapse.artifacts.models +summary: 'Azure Database for MariaDB dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureMariaDBTableDataset(*, linked_service_name: LinkedServiceReference, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, structure: object | None = None, schema: object | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, folder: DatasetFolder | None = None, table_name: object | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureMariaDBTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureMariaDBTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureMariaDBTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureMariaDBTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureMariaDBTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureMariaDBTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureMariaDBTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlLinkedService.yml new file mode 100644 index 00000000..17bf1922 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlLinkedService.yml @@ -0,0 +1,193 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureMySqlLinkedService +name: AzureMySqlLinkedService +fullName: azure.synapse.artifacts.models.AzureMySqlLinkedService +module: azure.synapse.artifacts.models +summary: 'Azure MySQL database linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureMySqlLinkedService(*, connection_string: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, password: AzureKeyVaultSecretReference + | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'Required. The connection string. Type: string, SecureString or + + AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: password + description: The Azure key vault secret reference of password in connection string. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: connection_string + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: password + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureMySqlLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureMySqlLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureMySqlLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureMySqlLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureMySqlLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureMySqlLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureMySqlLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlTableDataset.yml new file mode 100644 index 00000000..18af7bc9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlTableDataset.yml @@ -0,0 +1,216 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureMySqlTableDataset +name: AzureMySqlTableDataset +fullName: azure.synapse.artifacts.models.AzureMySqlTableDataset +module: azure.synapse.artifacts.models +summary: 'The Azure MySQL database dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureMySqlTableDataset(*, linked_service_name: LinkedServiceReference, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, structure: object | None = None, schema: object | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, folder: DatasetFolder | None = None, table_name: object | None = None, + table: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The Azure MySQL database table name. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: table + description: 'The name of Azure MySQL database table. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true + - name: table + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureMySqlTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureMySqlTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureMySqlTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureMySqlTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureMySqlTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureMySqlTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureMySqlTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlLinkedService.yml new file mode 100644 index 00000000..14e3b27e --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlLinkedService.yml @@ -0,0 +1,194 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzurePostgreSqlLinkedService +name: AzurePostgreSqlLinkedService +fullName: azure.synapse.artifacts.models.AzurePostgreSqlLinkedService +module: azure.synapse.artifacts.models +summary: 'Azure PostgreSQL linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzurePostgreSqlLinkedService(*, additional_properties: Dict[str, object] + | None = None, connect_via: IntegrationRuntimeReference | None = None, description: + str | None = None, parameters: Dict[str, ParameterSpecification] | None = None, + annotations: List[object] | None = None, connection_string: object | None = None, + password: AzureKeyVaultSecretReference | None = None, encrypted_credential: object + | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'An ODBC connection string. Type: string, SecureString or + + AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: password + description: The Azure key vault secret reference of password in connection string. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: connection_string + isRequired: true + - name: password + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzurePostgreSqlLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzurePostgreSqlLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzurePostgreSqlLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzurePostgreSqlLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzurePostgreSqlLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzurePostgreSqlLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzurePostgreSqlLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlTableDataset.yml new file mode 100644 index 00000000..6ac20e54 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlTableDataset.yml @@ -0,0 +1,226 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzurePostgreSqlTableDataset +name: AzurePostgreSqlTableDataset +fullName: azure.synapse.artifacts.models.AzurePostgreSqlTableDataset +module: azure.synapse.artifacts.models +summary: 'Azure PostgreSQL dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzurePostgreSqlTableDataset(*, linked_service_name: LinkedServiceReference, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, structure: object | None = None, schema: object | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, folder: DatasetFolder | None = None, table_name: object | None = None, + table: object | None = None, schema_type_properties_schema: object | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name of the Azure PostgreSQL database which includes both + schema + + and table. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: table + description: 'The table name of the Azure PostgreSQL database. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + - name: schema_type_properties_schema + description: 'The schema name of the Azure PostgreSQL database. Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true + - name: table + isRequired: true + - name: schema_type_properties_schema + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzurePostgreSqlTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzurePostgreSqlTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzurePostgreSqlTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzurePostgreSqlTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzurePostgreSqlTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzurePostgreSqlTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzurePostgreSqlTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchIndexDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchIndexDataset.yml new file mode 100644 index 00000000..de47c043 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchIndexDataset.yml @@ -0,0 +1,204 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureSearchIndexDataset +name: AzureSearchIndexDataset +fullName: azure.synapse.artifacts.models.AzureSearchIndexDataset +module: azure.synapse.artifacts.models +summary: 'The Azure Search Index. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureSearchIndexDataset(*, linked_service_name: LinkedServiceReference, + index_name: object, additional_properties: Dict[str, object] | None = None, description: + str | None = None, structure: object | None = None, schema: object | None = None, + parameters: Dict[str, ParameterSpecification] | None = None, annotations: List[object] + | None = None, folder: DatasetFolder | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: index_name + description: 'Required. The name of the Azure Search Index. Type: string (or Expression + + with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: index_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureSearchIndexDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureSearchIndexDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureSearchIndexDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureSearchIndexDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureSearchIndexDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureSearchIndexDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureSearchIndexDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchLinkedService.yml new file mode 100644 index 00000000..2e0f16e9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchLinkedService.yml @@ -0,0 +1,194 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureSearchLinkedService +name: AzureSearchLinkedService +fullName: azure.synapse.artifacts.models.AzureSearchLinkedService +module: azure.synapse.artifacts.models +summary: 'Linked service for Windows Azure Search Service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureSearchLinkedService(*, url: object, additional_properties: Dict[str, + object] | None = None, connect_via: IntegrationRuntimeReference | None = None, + description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, key: SecretBase | None + = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: url + description: 'Required. URL for Azure Search service. Type: string (or Expression + with resultType + + string).' + isRequired: true + types: + - + - name: key + description: Admin Key for Azure Search service. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: url + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: key + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureSearchLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureSearchLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureSearchLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureSearchLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureSearchLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureSearchLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureSearchLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWLinkedService.yml new file mode 100644 index 00000000..8cf43203 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWLinkedService.yml @@ -0,0 +1,223 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureSqlDWLinkedService +name: AzureSqlDWLinkedService +fullName: azure.synapse.artifacts.models.AzureSqlDWLinkedService +module: azure.synapse.artifacts.models +summary: 'Azure SQL Data Warehouse linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureSqlDWLinkedService(*, connection_string: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, password: AzureKeyVaultSecretReference + | None = None, service_principal_id: object | None = None, service_principal_key: + SecretBase | None = None, tenant: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'Required. The connection string. Type: string, SecureString or + + AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: password + description: The Azure key vault secret reference of password in connection string. + isRequired: true + types: + - + - name: service_principal_id + description: 'The ID of the service principal used to authenticate against Azure + + SQL Data Warehouse. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: service_principal_key + description: 'The key of the service principal used to authenticate against + + Azure SQL Data Warehouse.' + isRequired: true + types: + - + - name: tenant + description: 'The name or ID of the tenant to which the service principal belongs. + Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: connection_string + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: password + isRequired: true + - name: service_principal_id + isRequired: true + - name: service_principal_key + isRequired: true + - name: tenant + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureSqlDWLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureSqlDWLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureSqlDWLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureSqlDWLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureSqlDWLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureSqlDWLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureSqlDWLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWTableDataset.yml new file mode 100644 index 00000000..0bed02ab --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWTableDataset.yml @@ -0,0 +1,225 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureSqlDWTableDataset +name: AzureSqlDWTableDataset +fullName: azure.synapse.artifacts.models.AzureSqlDWTableDataset +module: azure.synapse.artifacts.models +summary: 'The Azure SQL Data Warehouse dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureSqlDWTableDataset(*, linked_service_name: LinkedServiceReference, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, structure: object | None = None, schema: object | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, folder: DatasetFolder | None = None, table_name: object | None = None, + schema_type_properties_schema: object | None = None, table: object | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'This property will be retired. Please consider using schema + table + + properties instead.' + isRequired: true + types: + - + - name: schema_type_properties_schema + description: 'The schema name of the Azure SQL Data Warehouse. Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: table + description: 'The table name of the Azure SQL Data Warehouse. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true + - name: schema_type_properties_schema + isRequired: true + - name: table + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureSqlDWTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureSqlDWTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureSqlDWTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureSqlDWTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureSqlDWTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureSqlDWTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureSqlDWTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService.yml new file mode 100644 index 00000000..fbba934e --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService.yml @@ -0,0 +1,223 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService +name: AzureSqlDatabaseLinkedService +fullName: azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService +module: azure.synapse.artifacts.models +summary: 'Microsoft Azure SQL Database linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureSqlDatabaseLinkedService(*, connection_string: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, password: AzureKeyVaultSecretReference + | None = None, service_principal_id: object | None = None, service_principal_key: + SecretBase | None = None, tenant: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'Required. The connection string. Type: string, SecureString or + + AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: password + description: The Azure key vault secret reference of password in connection string. + isRequired: true + types: + - + - name: service_principal_id + description: 'The ID of the service principal used to authenticate against Azure + + SQL Database. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: service_principal_key + description: 'The key of the service principal used to authenticate against + + Azure SQL Database.' + isRequired: true + types: + - + - name: tenant + description: 'The name or ID of the tenant to which the service principal belongs. + Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: connection_string + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: password + isRequired: true + - name: service_principal_id + isRequired: true + - name: service_principal_key + isRequired: true + - name: tenant + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMILinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMILinkedService.yml new file mode 100644 index 00000000..b98feb12 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMILinkedService.yml @@ -0,0 +1,223 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureSqlMILinkedService +name: AzureSqlMILinkedService +fullName: azure.synapse.artifacts.models.AzureSqlMILinkedService +module: azure.synapse.artifacts.models +summary: 'Azure SQL Managed Instance linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureSqlMILinkedService(*, connection_string: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, password: AzureKeyVaultSecretReference + | None = None, service_principal_id: object | None = None, service_principal_key: + SecretBase | None = None, tenant: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'Required. The connection string. Type: string, SecureString or + + AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: password + description: The Azure key vault secret reference of password in connection string. + isRequired: true + types: + - + - name: service_principal_id + description: 'The ID of the service principal used to authenticate against Azure + + SQL Managed Instance. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: service_principal_key + description: 'The key of the service principal used to authenticate against + + Azure SQL Managed Instance.' + isRequired: true + types: + - + - name: tenant + description: 'The name or ID of the tenant to which the service principal belongs. + Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: connection_string + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: password + isRequired: true + - name: service_principal_id + isRequired: true + - name: service_principal_key + isRequired: true + - name: tenant + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureSqlMILinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureSqlMILinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureSqlMILinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureSqlMILinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureSqlMILinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureSqlMILinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureSqlMILinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMITableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMITableDataset.yml new file mode 100644 index 00000000..a5e41b43 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMITableDataset.yml @@ -0,0 +1,225 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureSqlMITableDataset +name: AzureSqlMITableDataset +fullName: azure.synapse.artifacts.models.AzureSqlMITableDataset +module: azure.synapse.artifacts.models +summary: 'The Azure SQL Managed Instance dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureSqlMITableDataset(*, linked_service_name: LinkedServiceReference, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, structure: object | None = None, schema: object | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, folder: DatasetFolder | None = None, table_name: object | None = None, + schema_type_properties_schema: object | None = None, table: object | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'This property will be retired. Please consider using schema + table + + properties instead.' + isRequired: true + types: + - + - name: schema_type_properties_schema + description: 'The schema name of the Azure SQL Managed Instance. Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: table + description: 'The table name of the Azure SQL Managed Instance dataset. Type: + string (or + + Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true + - name: schema_type_properties_schema + isRequired: true + - name: table + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureSqlMITableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureSqlMITableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureSqlMITableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureSqlMITableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureSqlMITableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureSqlMITableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureSqlMITableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlTableDataset.yml new file mode 100644 index 00000000..e8bc17f6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlTableDataset.yml @@ -0,0 +1,224 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureSqlTableDataset +name: AzureSqlTableDataset +fullName: azure.synapse.artifacts.models.AzureSqlTableDataset +module: azure.synapse.artifacts.models +summary: 'The Azure SQL Server database dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureSqlTableDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, schema_type_properties_schema: + object | None = None, table: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'This property will be retired. Please consider using schema + table + + properties instead.' + isRequired: true + types: + - + - name: schema_type_properties_schema + description: 'The schema name of the Azure SQL database. Type: string + + (or Expression with resultType string).' + isRequired: true + types: + - + - name: table + description: 'The table name of the Azure SQL database. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true + - name: schema_type_properties_schema + isRequired: true + - name: table + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureSqlTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureSqlTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureSqlTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureSqlTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureSqlTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureSqlTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureSqlTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureStorageLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureStorageLinkedService.yml new file mode 100644 index 00000000..18e50127 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureStorageLinkedService.yml @@ -0,0 +1,213 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureStorageLinkedService +name: AzureStorageLinkedService +fullName: azure.synapse.artifacts.models.AzureStorageLinkedService +module: azure.synapse.artifacts.models +summary: 'The storage account linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureStorageLinkedService(*, additional_properties: Dict[str, object] | + None = None, connect_via: IntegrationRuntimeReference | None = None, description: + str | None = None, parameters: Dict[str, ParameterSpecification] | None = None, + annotations: List[object] | None = None, connection_string: object | None = None, + account_key: AzureKeyVaultSecretReference | None = None, sas_uri: object | None + = None, sas_token: AzureKeyVaultSecretReference | None = None, encrypted_credential: + str | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'The connection string. It is mutually exclusive with sasUri property. + + Type: string, SecureString or AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: account_key + description: The Azure key vault secret reference of accountKey in connection + string. + isRequired: true + types: + - + - name: sas_uri + description: 'SAS URI of the Azure Storage resource. It is mutually exclusive + with + + connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: sas_token + description: The Azure key vault secret reference of sasToken in sas uri. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: connection_string + isRequired: true + - name: account_key + isRequired: true + - name: sas_uri + isRequired: true + - name: sas_token + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureStorageLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureStorageLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureStorageLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureStorageLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureStorageLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureStorageLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureStorageLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableDataset.yml new file mode 100644 index 00000000..4e659781 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableDataset.yml @@ -0,0 +1,205 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureTableDataset +name: AzureTableDataset +fullName: azure.synapse.artifacts.models.AzureTableDataset +module: azure.synapse.artifacts.models +summary: 'The Azure Table storage dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureTableDataset(*, linked_service_name: LinkedServiceReference, table_name: + object, additional_properties: Dict[str, object] | None = None, description: str + | None = None, structure: object | None = None, schema: object | None = None, + parameters: Dict[str, ParameterSpecification] | None = None, annotations: List[object] + | None = None, folder: DatasetFolder | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'Required. The table name of the Azure Table storage. Type: string + (or + + Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: table_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableStorageLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableStorageLinkedService.yml new file mode 100644 index 00000000..8f7a373c --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableStorageLinkedService.yml @@ -0,0 +1,213 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.AzureTableStorageLinkedService +name: AzureTableStorageLinkedService +fullName: azure.synapse.artifacts.models.AzureTableStorageLinkedService +module: azure.synapse.artifacts.models +summary: 'The azure table storage linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'AzureTableStorageLinkedService(*, additional_properties: Dict[str, object] + | None = None, connect_via: IntegrationRuntimeReference | None = None, description: + str | None = None, parameters: Dict[str, ParameterSpecification] | None = None, + annotations: List[object] | None = None, connection_string: object | None = None, + account_key: AzureKeyVaultSecretReference | None = None, sas_uri: object | None + = None, sas_token: AzureKeyVaultSecretReference | None = None, encrypted_credential: + str | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'The connection string. It is mutually exclusive with sasUri property. + + Type: string, SecureString or AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: account_key + description: The Azure key vault secret reference of accountKey in connection + string. + isRequired: true + types: + - + - name: sas_uri + description: 'SAS URI of the Azure Storage resource. It is mutually exclusive + with + + connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: sas_token + description: The Azure key vault secret reference of sasToken in sas uri. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: connection_string + isRequired: true + - name: account_key + isRequired: true + - name: sas_uri + isRequired: true + - name: sas_token + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.AzureTableStorageLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureTableStorageLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureTableStorageLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.AzureTableStorageLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.AzureTableStorageLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.AzureTableStorageLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.AzureTableStorageLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BigDataPoolReference.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BigDataPoolReference.yml new file mode 100644 index 00000000..cac4a64f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BigDataPoolReference.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.BigDataPoolReference +name: BigDataPoolReference +fullName: azure.synapse.artifacts.models.BigDataPoolReference +module: azure.synapse.artifacts.models +summary: 'Big data pool reference. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'BigDataPoolReference(*, reference_name: str, **kwargs)' + parameters: + - name: reference_name + description: Required. Reference big data pool name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: reference_name + isRequired: true +variables: +- description: 'Required. Big data pool reference type. Default value: "BigDataPoolReference".' + name: type + types: + - +methods: +- uid: azure.synapse.artifacts.models.BigDataPoolReference.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.BigDataPoolReference.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.BigDataPoolReference.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.BigDataPoolReference.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.BigDataPoolReference.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.BigDataPoolReference.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.BigDataPoolReference.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +attributes: +- uid: azure.synapse.artifacts.models.BigDataPoolReference.type + name: type + signature: type = 'BigDataPoolReference' diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BinaryDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BinaryDataset.yml new file mode 100644 index 00000000..91fd22e8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BinaryDataset.yml @@ -0,0 +1,210 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.BinaryDataset +name: BinaryDataset +fullName: azure.synapse.artifacts.models.BinaryDataset +module: azure.synapse.artifacts.models +summary: 'Binary dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'BinaryDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, location: DatasetLocation | None = None, compression: DatasetCompression + | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: location + description: The location of the Binary storage. + isRequired: true + types: + - + - name: compression + description: The data compression method used for the binary dataset. + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: location + isRequired: true + - name: compression + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.BinaryDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.BinaryDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.BinaryDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.BinaryDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.BinaryDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.BinaryDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.BinaryDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraLinkedService.yml new file mode 100644 index 00000000..659347e2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraLinkedService.yml @@ -0,0 +1,222 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.CassandraLinkedService +name: CassandraLinkedService +fullName: azure.synapse.artifacts.models.CassandraLinkedService +module: azure.synapse.artifacts.models +summary: 'Linked service for Cassandra data source. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CassandraLinkedService(*, host: object, additional_properties: Dict[str, + object] | None = None, connect_via: IntegrationRuntimeReference | None = None, + description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, authentication_type: object + | None = None, port: object | None = None, username: object | None = None, password: + SecretBase | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: host + description: 'Required. Host name for connection. Type: string (or Expression + with resultType + + string).' + isRequired: true + types: + - + - name: authentication_type + description: 'AuthenticationType to be used for connection. Type: string (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: port + description: 'The port for the connection. Type: integer (or Expression with resultType + + integer).' + isRequired: true + types: + - + - name: username + description: 'Username for authentication. Type: string (or Expression with resultType + + string).' + isRequired: true + types: + - + - name: password + description: Password for authentication. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: host + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: authentication_type + isRequired: true + - name: port + isRequired: true + - name: username + isRequired: true + - name: password + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.CassandraLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CassandraLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CassandraLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.CassandraLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CassandraLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.CassandraLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CassandraLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraTableDataset.yml new file mode 100644 index 00000000..7d25c2b2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraTableDataset.yml @@ -0,0 +1,216 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.CassandraTableDataset +name: CassandraTableDataset +fullName: azure.synapse.artifacts.models.CassandraTableDataset +module: azure.synapse.artifacts.models +summary: 'The Cassandra database dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CassandraTableDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, keyspace: object | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name of the Cassandra database. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: keyspace + description: 'The keyspace of the Cassandra database. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true + - name: keyspace + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.CassandraTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CassandraTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CassandraTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.CassandraTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CassandraTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.CassandraTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CassandraTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CellOutputType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CellOutputType.yml new file mode 100644 index 00000000..dcfac680 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CellOutputType.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.CellOutputType +name: CellOutputType +fullName: azure.synapse.artifacts.models.CellOutputType +summary: Execution, display, or stream outputs. +module: azure.synapse.artifacts.models +fields: +- name: display_data + uid: azure.synapse.artifacts.models.CellOutputType.display_data +- name: error + uid: azure.synapse.artifacts.models.CellOutputType.error +- name: execute_result + uid: azure.synapse.artifacts.models.CellOutputType.execute_result +- name: stream + uid: azure.synapse.artifacts.models.CellOutputType.stream diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CloudError.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CloudError.yml new file mode 100644 index 00000000..81dfa48d --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CloudError.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.CloudError +name: CloudError +fullName: azure.synapse.artifacts.models.CloudError +module: azure.synapse.artifacts.models +summary: 'The object that defines the structure of an Azure Synapse error response. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CloudError(*, code: str, message: str, target: str | None = None, details: + List[CloudError] | None = None, **kwargs)' + parameters: + - name: code + description: Required. Error code. + isRequired: true + types: + - + - name: message + description: Required. Error message. + isRequired: true + types: + - + - name: target + description: Property name/path in request associated with error. + isRequired: true + types: + - + - name: details + description: Array with additional error details. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true + - name: target + isRequired: true + - name: details + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.CloudError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CloudError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CloudError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.CloudError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CloudError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.CloudError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CloudError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset.yml new file mode 100644 index 00000000..5640b7f9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset.yml @@ -0,0 +1,206 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset +name: CommonDataServiceForAppsEntityDataset +fullName: azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset +module: azure.synapse.artifacts.models +summary: 'The Common Data Service for Apps entity dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CommonDataServiceForAppsEntityDataset(*, linked_service_name: LinkedServiceReference, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, structure: object | None = None, schema: object | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, folder: DatasetFolder | None = None, entity_name: object | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: entity_name + description: 'The logical name of the entity. Type: string (or Expression with + resultType + + string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: entity_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService.yml new file mode 100644 index 00000000..4de2f1ad --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService.yml @@ -0,0 +1,329 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService +name: CommonDataServiceForAppsLinkedService +fullName: azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService +module: azure.synapse.artifacts.models +summary: 'Common Data Service for Apps linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CommonDataServiceForAppsLinkedService(*, deployment_type: str | DynamicsDeploymentType, + authentication_type: str | DynamicsAuthenticationType, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, host_name: object | None + = None, port: object | None = None, service_uri: object | None = None, organization_name: + object | None = None, username: object | None = None, password: SecretBase | None + = None, service_principal_id: object | None = None, service_principal_credential_type: + str | DynamicsServicePrincipalCredentialType | None = None, service_principal_credential: + SecretBase | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: deployment_type + description: 'Required. The deployment type of the Common Data Service for Apps + + instance. ''Online'' for Common Data Service for Apps Online and ''OnPremisesWithIfd'' + for Common + + Data Service for Apps on-premises with Ifd. Type: string (or Expression with + resultType + + string). Possible values include: "Online", "OnPremisesWithIfd".' + isRequired: true + types: + - + - + - name: host_name + description: 'The host name of the on-premises Common Data Service for Apps server. + The + + property is required for on-prem and not allowed for online. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + - name: port + description: 'The port of on-premises Common Data Service for Apps server. The + property is + + required for on-prem and not allowed for online. Default is 443. Type: integer + (or Expression + + with resultType integer), minimum: 0.' + isRequired: true + types: + - + - name: service_uri + description: 'The URL to the Microsoft Common Data Service for Apps server. The + property + + is required for on-line and not allowed for on-prem. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: organization_name + description: 'The organization name of the Common Data Service for Apps instance. + + The property is required for on-prem and required for online when there are + more than one + + Common Data Service for Apps instances associated with the user. Type: string + (or Expression + + with resultType string).' + isRequired: true + types: + - + - name: authentication_type + description: 'Required. The authentication type to connect to Common Data Service + + for Apps server. ''Office365'' for online scenario, ''Ifd'' for on-premises + with Ifd scenario. + + ''AADServicePrincipal'' for Server-To-Server authentication in online scenario. + Type: string (or + + Expression with resultType string). Possible values include: "Office365", "Ifd", + + "AADServicePrincipal".' + isRequired: true + types: + - + - + - name: username + description: 'User name to access the Common Data Service for Apps instance. Type: + string + + (or Expression with resultType string).' + isRequired: true + types: + - + - name: password + description: Password to access the Common Data Service for Apps instance. + isRequired: true + types: + - + - name: service_principal_id + description: 'The client ID of the application in Azure Active Directory used + + for Server-To-Server authentication. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: service_principal_credential_type + description: 'The service principal credential type to use in + + Server-To-Server authentication. ''ServicePrincipalKey'' for key/secret, ''ServicePrincipalCert'' + + for certificate. Type: string (or Expression with resultType string). Possible + values include: + + "ServicePrincipalKey", "ServicePrincipalCert".' + isRequired: true + types: + - + - + - name: service_principal_credential + description: 'The credential of the service principal object in Azure + + Active Directory. If servicePrincipalCredentialType is ''ServicePrincipalKey'', + + servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. + If + + servicePrincipalCredentialType is ''ServicePrincipalCert'', servicePrincipalCredential + can only + + be AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: deployment_type + isRequired: true + - name: authentication_type + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: host_name + isRequired: true + - name: port + isRequired: true + - name: service_uri + isRequired: true + - name: organization_name + isRequired: true + - name: username + isRequired: true + - name: password + isRequired: true + - name: service_principal_id + isRequired: true + - name: service_principal_credential_type + isRequired: true + - name: service_principal_credential + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurLinkedService.yml new file mode 100644 index 00000000..8b133ac7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurLinkedService.yml @@ -0,0 +1,233 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ConcurLinkedService +name: ConcurLinkedService +fullName: azure.synapse.artifacts.models.ConcurLinkedService +module: azure.synapse.artifacts.models +summary: 'Concur Service linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ConcurLinkedService(*, client_id: object, username: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, password: SecretBase | + None = None, use_encrypted_endpoints: object | None = None, use_host_verification: + object | None = None, use_peer_verification: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: client_id + description: Required. Application client_id supplied by Concur App Management. + isRequired: true + types: + - + - name: username + description: Required. The user name that you use to access Concur Service. + isRequired: true + types: + - + - name: password + description: 'The password corresponding to the user name that you provided in + the username + + field.' + isRequired: true + types: + - + - name: use_encrypted_endpoints + description: 'Specifies whether the data source endpoints are encrypted using + + HTTPS. The default value is true.' + isRequired: true + types: + - + - name: use_host_verification + description: 'Specifies whether to require the host name in the server''s + + certificate to match the host name of the server when connecting over SSL. The + default value is + + true.' + isRequired: true + types: + - + - name: use_peer_verification + description: 'Specifies whether to verify the identity of the server when + + connecting over SSL. The default value is true.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: client_id + isRequired: true + - name: username + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: password + isRequired: true + - name: use_encrypted_endpoints + isRequired: true + - name: use_host_verification + isRequired: true + - name: use_peer_verification + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ConcurLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ConcurLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ConcurLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ConcurLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ConcurLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ConcurLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ConcurLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurObjectDataset.yml new file mode 100644 index 00000000..8f4295d8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurObjectDataset.yml @@ -0,0 +1,202 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ConcurObjectDataset +name: ConcurObjectDataset +fullName: azure.synapse.artifacts.models.ConcurObjectDataset +module: azure.synapse.artifacts.models +summary: 'Concur Service dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ConcurObjectDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ConcurObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ConcurObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ConcurObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ConcurObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ConcurObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ConcurObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ConcurObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ControlActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ControlActivity.yml new file mode 100644 index 00000000..1c89fd4c --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ControlActivity.yml @@ -0,0 +1,163 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ControlActivity +name: ControlActivity +fullName: azure.synapse.artifacts.models.ControlActivity +module: azure.synapse.artifacts.models +summary: 'Base class for all control activities like IfCondition, ForEach , Until. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ControlActivity(*, name: str, additional_properties: Dict[str, object] + | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ControlActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ControlActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ControlActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ControlActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ControlActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ControlActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ControlActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopyActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopyActivity.yml new file mode 100644 index 00000000..1fec369b --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopyActivity.yml @@ -0,0 +1,293 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.CopyActivity +name: CopyActivity +fullName: azure.synapse.artifacts.models.CopyActivity +module: azure.synapse.artifacts.models +summary: 'Copy activity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CopyActivity(*, name: str, source: CopySource, sink: CopySink, additional_properties: + Dict[str, object] | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, linked_service_name: + LinkedServiceReference | None = None, policy: ActivityPolicy | None = None, inputs: + List[DatasetReference] | None = None, outputs: List[DatasetReference] | None = + None, translator: object | None = None, enable_staging: object | None = None, + staging_settings: StagingSettings | None = None, parallel_copies: object | None + = None, data_integration_units: object | None = None, enable_skip_incompatible_row: + object | None = None, redirect_incompatible_row_settings: RedirectIncompatibleRowSettings + | None = None, preserve_rules: List[object] | None = None, preserve: List[object] + | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + - name: inputs + description: List of inputs for the activity. + isRequired: true + types: + - [] + - name: outputs + description: List of outputs for the activity. + isRequired: true + types: + - [] + - name: source + description: Required. Copy activity source. + isRequired: true + types: + - + - name: sink + description: Required. Copy activity sink. + isRequired: true + types: + - + - name: translator + description: Copy activity translator. If not specified, tabular translator is + used. + isRequired: true + types: + - + - name: enable_staging + description: 'Specifies whether to copy data via an interim staging. Default value + is + + false. Type: boolean (or Expression with resultType boolean).' + isRequired: true + types: + - + - name: staging_settings + description: Specifies interim staging settings when EnableStaging is true. + isRequired: true + types: + - + - name: parallel_copies + description: 'Maximum number of concurrent sessions opened on the source or sink + to + + avoid overloading the data store. Type: integer (or Expression with resultType + integer), + + minimum: 0.' + isRequired: true + types: + - + - name: data_integration_units + description: 'Maximum number of data integration units that can be used to + + perform this data movement. Type: integer (or Expression with resultType integer), + minimum: 0.' + isRequired: true + types: + - + - name: enable_skip_incompatible_row + description: 'Whether to skip incompatible row. Default value is false. + + Type: boolean (or Expression with resultType boolean).' + isRequired: true + types: + - + - name: redirect_incompatible_row_settings + description: 'Redirect incompatible row settings when + + EnableSkipIncompatibleRow is true.' + isRequired: true + types: + - + - name: preserve_rules + description: Preserve Rules. + isRequired: true + types: + - [] + - name: preserve + description: Preserve rules. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: name + isRequired: true + - name: source + isRequired: true + - name: sink + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true + - name: inputs + isRequired: true + - name: outputs + isRequired: true + - name: translator + isRequired: true + - name: enable_staging + isRequired: true + - name: staging_settings + isRequired: true + - name: parallel_copies + isRequired: true + - name: data_integration_units + isRequired: true + - name: enable_skip_incompatible_row + isRequired: true + - name: redirect_incompatible_row_settings + isRequired: true + - name: preserve_rules + isRequired: true + - name: preserve + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.CopyActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CopyActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CopyActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.CopyActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CopyActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.CopyActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CopyActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySink.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySink.yml new file mode 100644 index 00000000..37067a85 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySink.yml @@ -0,0 +1,186 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.CopySink +name: CopySink +fullName: azure.synapse.artifacts.models.CopySink +module: azure.synapse.artifacts.models +summary: 'A copy activity sink. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: . + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CopySink(*, additional_properties: Dict[str, object] | None = None, write_batch_size: + object | None = None, write_batch_timeout: object | None = None, sink_retry_count: + object | None = None, sink_retry_wait: object | None = None, max_concurrent_connections: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Copy sink type.Constant filled by server. + isRequired: true + types: + - + - name: write_batch_size + description: 'Write batch size. Type: integer (or Expression with resultType + + integer), minimum: 0.' + isRequired: true + types: + - + - name: write_batch_timeout + description: 'Write batch timeout. Type: string (or Expression with resultType + + string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).' + isRequired: true + types: + - + - name: sink_retry_count + description: 'Sink retry count. Type: integer (or Expression with resultType + + integer).' + isRequired: true + types: + - + - name: sink_retry_wait + description: 'Sink retry wait. Type: string (or Expression with resultType string), + + pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).' + isRequired: true + types: + - + - name: max_concurrent_connections + description: 'The maximum concurrent connection count for the sink data + + store. Type: integer (or Expression with resultType integer).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: write_batch_size + isRequired: true + - name: write_batch_timeout + isRequired: true + - name: sink_retry_count + isRequired: true + - name: sink_retry_wait + isRequired: true + - name: max_concurrent_connections + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.CopySink.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CopySink.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CopySink.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.CopySink.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CopySink.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.CopySink.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CopySink.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySource.yml new file mode 100644 index 00000000..58629736 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySource.yml @@ -0,0 +1,167 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.CopySource +name: CopySource +fullName: azure.synapse.artifacts.models.CopySource +module: azure.synapse.artifacts.models +summary: 'A copy activity source. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: . + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CopySource(*, additional_properties: Dict[str, object] | None = None, source_retry_count: + object | None = None, source_retry_wait: object | None = None, max_concurrent_connections: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Copy source type.Constant filled by server. + isRequired: true + types: + - + - name: source_retry_count + description: 'Source retry count. Type: integer (or Expression with resultType + + integer).' + isRequired: true + types: + - + - name: source_retry_wait + description: 'Source retry wait. Type: string (or Expression with resultType + + string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).' + isRequired: true + types: + - + - name: max_concurrent_connections + description: 'The maximum concurrent connection count for the source data + + store. Type: integer (or Expression with resultType integer).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: source_retry_count + isRequired: true + - name: source_retry_wait + isRequired: true + - name: max_concurrent_connections + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.CopySource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CopySource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CopySource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.CopySource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CopySource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.CopySource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CopySource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbLinkedService.yml new file mode 100644 index 00000000..f8125a78 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbLinkedService.yml @@ -0,0 +1,214 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.CosmosDbLinkedService +name: CosmosDbLinkedService +fullName: azure.synapse.artifacts.models.CosmosDbLinkedService +module: azure.synapse.artifacts.models +summary: 'Microsoft Azure Cosmos Database (CosmosDB) linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CosmosDbLinkedService(*, additional_properties: Dict[str, object] | None + = None, connect_via: IntegrationRuntimeReference | None = None, description: str + | None = None, parameters: Dict[str, ParameterSpecification] | None = None, annotations: + List[object] | None = None, connection_string: object | None = None, account_endpoint: + object | None = None, database: object | None = None, account_key: SecretBase + | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'The connection string. Type: string, SecureString or + + AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: account_endpoint + description: 'The endpoint of the Azure CosmosDB account. Type: string (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: database + description: 'The name of the database. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: account_key + description: 'The account key of the Azure CosmosDB account. Type: SecureString + or + + AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: connection_string + isRequired: true + - name: account_endpoint + isRequired: true + - name: database + isRequired: true + - name: account_key + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.CosmosDbLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CosmosDbLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CosmosDbLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.CosmosDbLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CosmosDbLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.CosmosDbLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CosmosDbLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset.yml new file mode 100644 index 00000000..ac1c16e3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset.yml @@ -0,0 +1,205 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset +name: CosmosDbMongoDbApiCollectionDataset +fullName: azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset +module: azure.synapse.artifacts.models +summary: 'The CosmosDB (MongoDB API) database dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CosmosDbMongoDbApiCollectionDataset(*, linked_service_name: LinkedServiceReference, + collection: object, additional_properties: Dict[str, object] | None = None, description: + str | None = None, structure: object | None = None, schema: object | None = None, + parameters: Dict[str, ParameterSpecification] | None = None, annotations: List[object] + | None = None, folder: DatasetFolder | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: collection + description: 'Required. The collection name of the CosmosDB (MongoDB API) database. + Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: collection + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService.yml new file mode 100644 index 00000000..f58c87fd --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService.yml @@ -0,0 +1,185 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService +name: CosmosDbMongoDbApiLinkedService +fullName: azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService +module: azure.synapse.artifacts.models +summary: 'Linked service for CosmosDB (MongoDB API) data source. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CosmosDbMongoDbApiLinkedService(*, connection_string: object, database: + object, additional_properties: Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference + | None = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'Required. The CosmosDB (MongoDB API) connection string. Type: string, + + SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or + + AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: database + description: 'Required. The name of the CosmosDB (MongoDB API) database that you + want to + + access. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: connection_string + isRequired: true + - name: database + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset.yml new file mode 100644 index 00000000..c43b3906 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset.yml @@ -0,0 +1,204 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset +name: CosmosDbSqlApiCollectionDataset +fullName: azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset +module: azure.synapse.artifacts.models +summary: 'Microsoft Azure CosmosDB (SQL API) Collection dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CosmosDbSqlApiCollectionDataset(*, linked_service_name: LinkedServiceReference, + collection_name: object, additional_properties: Dict[str, object] | None = None, + description: str | None = None, structure: object | None = None, schema: object + | None = None, parameters: Dict[str, ParameterSpecification] | None = None, annotations: + List[object] | None = None, folder: DatasetFolder | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: collection_name + description: 'Required. CosmosDB (SQL API) collection name. Type: string (or + + Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: collection_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseLinkedService.yml new file mode 100644 index 00000000..926217da --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseLinkedService.yml @@ -0,0 +1,195 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.CouchbaseLinkedService +name: CouchbaseLinkedService +fullName: azure.synapse.artifacts.models.CouchbaseLinkedService +module: azure.synapse.artifacts.models +summary: 'Couchbase server linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CouchbaseLinkedService(*, additional_properties: Dict[str, object] | None + = None, connect_via: IntegrationRuntimeReference | None = None, description: str + | None = None, parameters: Dict[str, ParameterSpecification] | None = None, annotations: + List[object] | None = None, connection_string: object | None = None, cred_string: + AzureKeyVaultSecretReference | None = None, encrypted_credential: object | None + = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'An ODBC connection string. Type: string, SecureString or + + AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: cred_string + description: The Azure key vault secret reference of credString in connection + string. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: connection_string + isRequired: true + - name: cred_string + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.CouchbaseLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CouchbaseLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CouchbaseLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.CouchbaseLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CouchbaseLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.CouchbaseLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CouchbaseLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseTableDataset.yml new file mode 100644 index 00000000..6b230af0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseTableDataset.yml @@ -0,0 +1,202 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.CouchbaseTableDataset +name: CouchbaseTableDataset +fullName: azure.synapse.artifacts.models.CouchbaseTableDataset +module: azure.synapse.artifacts.models +summary: 'Couchbase server dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CouchbaseTableDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.CouchbaseTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CouchbaseTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CouchbaseTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.CouchbaseTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CouchbaseTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.CouchbaseTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CouchbaseTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest.yml new file mode 100644 index 00000000..a6544c0d --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest.yml @@ -0,0 +1,161 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest +name: CreateDataFlowDebugSessionRequest +fullName: azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest +module: azure.synapse.artifacts.models +summary: Request body structure for creating data flow debug session. +constructor: + syntax: 'CreateDataFlowDebugSessionRequest(*, data_flow_name: str | None = None, + existing_cluster_id: str | None = None, cluster_timeout: int | None = None, new_cluster_name: + str | None = None, new_cluster_node_type: str | None = None, data_bricks_linked_service: + LinkedServiceResource | None = None, **kwargs)' + parameters: + - name: data_flow_name + description: The name of the data flow. + isRequired: true + types: + - + - name: existing_cluster_id + description: The ID of existing Databricks cluster. + isRequired: true + types: + - + - name: cluster_timeout + description: Timeout setting for Databricks cluster. + isRequired: true + types: + - + - name: new_cluster_name + description: The name of new Databricks cluster. + isRequired: true + types: + - + - name: new_cluster_node_type + description: The type of new Databricks cluster. + isRequired: true + types: + - + - name: data_bricks_linked_service + description: Data bricks linked service. + isRequired: true + types: + - + keywordOnlyParameters: + - name: data_flow_name + isRequired: true + - name: existing_cluster_id + isRequired: true + - name: cluster_timeout + isRequired: true + - name: new_cluster_name + isRequired: true + - name: new_cluster_node_type + isRequired: true + - name: data_bricks_linked_service + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse.yml new file mode 100644 index 00000000..dfae48d9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse +name: CreateDataFlowDebugSessionResponse +fullName: azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse +module: azure.synapse.artifacts.models +summary: Response body structure for creating data flow debug session. +constructor: + syntax: 'CreateDataFlowDebugSessionResponse(*, session_id: str | None = None, **kwargs)' + parameters: + - name: session_id + description: The ID of data flow debug session. + isRequired: true + types: + - + keywordOnlyParameters: + - name: session_id + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateRunResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateRunResponse.yml new file mode 100644 index 00000000..431a17ef --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateRunResponse.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.CreateRunResponse +name: CreateRunResponse +fullName: azure.synapse.artifacts.models.CreateRunResponse +module: azure.synapse.artifacts.models +summary: 'Response body with a run identifier. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CreateRunResponse(*, run_id: str, **kwargs)' + parameters: + - name: run_id + description: Required. Identifier of a run. + isRequired: true + types: + - + keywordOnlyParameters: + - name: run_id + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.CreateRunResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CreateRunResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CreateRunResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.CreateRunResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CreateRunResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.CreateRunResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CreateRunResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivity.yml new file mode 100644 index 00000000..22d904dd --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivity.yml @@ -0,0 +1,236 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.CustomActivity +name: CustomActivity +fullName: azure.synapse.artifacts.models.CustomActivity +module: azure.synapse.artifacts.models +summary: 'Custom activity type. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CustomActivity(*, name: str, command: object, additional_properties: Dict[str, + object] | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, linked_service_name: + LinkedServiceReference | None = None, policy: ActivityPolicy | None = None, resource_linked_service: + LinkedServiceReference | None = None, folder_path: object | None = None, reference_objects: + CustomActivityReferenceObject | None = None, extended_properties: Dict[str, object] + | None = None, retention_time_in_days: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + - name: command + description: 'Required. Command for custom activity Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: resource_linked_service + description: Resource linked service reference. + isRequired: true + types: + - + - name: folder_path + description: 'Folder path for resource files Type: string (or Expression with + resultType + + string).' + isRequired: true + types: + - + - name: reference_objects + description: Reference objects. + isRequired: true + types: + - + - name: extended_properties + description: 'User defined property bag. There is no restriction on the keys or + + values that can be used. The user specified custom activity has the full responsibility + to + + consume and interpret the content defined.' + isRequired: true + types: + - [, ] + - name: retention_time_in_days + description: 'The retention time for the files submitted for custom activity. + + Type: double (or Expression with resultType double).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: command + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true + - name: resource_linked_service + isRequired: true + - name: folder_path + isRequired: true + - name: reference_objects + isRequired: true + - name: extended_properties + isRequired: true + - name: retention_time_in_days + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.CustomActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CustomActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CustomActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.CustomActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CustomActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.CustomActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CustomActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivityReferenceObject.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivityReferenceObject.yml new file mode 100644 index 00000000..20046c13 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivityReferenceObject.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.CustomActivityReferenceObject +name: CustomActivityReferenceObject +fullName: azure.synapse.artifacts.models.CustomActivityReferenceObject +module: azure.synapse.artifacts.models +summary: Reference objects for custom activity. +constructor: + syntax: 'CustomActivityReferenceObject(*, linked_services: List[LinkedServiceReference] + | None = None, datasets: List[DatasetReference] | None = None, **kwargs)' + parameters: + - name: linked_services + description: Linked service references. + isRequired: true + types: + - [] + - name: datasets + description: Dataset references. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: linked_services + isRequired: true + - name: datasets + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.CustomActivityReferenceObject.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CustomActivityReferenceObject.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CustomActivityReferenceObject.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.CustomActivityReferenceObject.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CustomActivityReferenceObject.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.CustomActivityReferenceObject.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CustomActivityReferenceObject.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomDataSourceLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomDataSourceLinkedService.yml new file mode 100644 index 00000000..7a3cdc67 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomDataSourceLinkedService.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.CustomDataSourceLinkedService +name: CustomDataSourceLinkedService +fullName: azure.synapse.artifacts.models.CustomDataSourceLinkedService +module: azure.synapse.artifacts.models +summary: 'Custom linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'CustomDataSourceLinkedService(*, type_properties: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: type_properties + description: Required. Custom linked service properties. + isRequired: true + types: + - + keywordOnlyParameters: + - name: type_properties + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.CustomDataSourceLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CustomDataSourceLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CustomDataSourceLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.CustomDataSourceLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.CustomDataSourceLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.CustomDataSourceLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.CustomDataSourceLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlow.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlow.yml new file mode 100644 index 00000000..3d9e3e90 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlow.yml @@ -0,0 +1,155 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DataFlow +name: DataFlow +fullName: azure.synapse.artifacts.models.DataFlow +module: azure.synapse.artifacts.models +summary: 'Azure Synapse nested object which contains a flow with data movements and + transformations. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: MappingDataFlow. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DataFlow(*, description: str | None = None, annotations: List[object] | + None = None, folder: DataFlowFolder | None = None, **kwargs)' + parameters: + - name: type + description: Required. Type of data flow.Constant filled by server. + isRequired: true + types: + - + - name: description + description: The description of the data flow. + isRequired: true + types: + - + - name: annotations + description: List of tags that can be used for describing the data flow. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this data flow is in. If not specified, Data flow + will appear at + + the root level.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: description + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DataFlow.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlow.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlow.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DataFlow.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlow.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DataFlow.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlow.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowComputeType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowComputeType.yml new file mode 100644 index 00000000..d9bff670 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowComputeType.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.DataFlowComputeType +name: DataFlowComputeType +fullName: azure.synapse.artifacts.models.DataFlowComputeType +summary: Compute type of the cluster which will execute data flow job. +module: azure.synapse.artifacts.models +fields: +- name: compute_optimized + uid: azure.synapse.artifacts.models.DataFlowComputeType.compute_optimized +- name: general + uid: azure.synapse.artifacts.models.DataFlowComputeType.general +- name: memory_optimized + uid: azure.synapse.artifacts.models.DataFlowComputeType.memory_optimized diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandRequest.yml new file mode 100644 index 00000000..89c1b029 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandRequest.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DataFlowDebugCommandRequest +name: DataFlowDebugCommandRequest +fullName: azure.synapse.artifacts.models.DataFlowDebugCommandRequest +module: azure.synapse.artifacts.models +summary: Request body structure for data flow expression preview. +constructor: + syntax: 'DataFlowDebugCommandRequest(*, session_id: str | None = None, data_flow_name: + str | None = None, command_name: str | None = None, command_payload: object | + None = None, **kwargs)' + parameters: + - name: session_id + description: The ID of data flow debug session. + isRequired: true + types: + - + - name: data_flow_name + description: The data flow which contains the debug session. + isRequired: true + types: + - + - name: command_name + description: The command name. + isRequired: true + types: + - + - name: command_payload + description: The command payload object. + isRequired: true + types: + - + keywordOnlyParameters: + - name: session_id + isRequired: true + - name: data_flow_name + isRequired: true + - name: command_name + isRequired: true + - name: command_payload + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DataFlowDebugCommandRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowDebugCommandRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowDebugCommandRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DataFlowDebugCommandRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowDebugCommandRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DataFlowDebugCommandRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowDebugCommandRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandResponse.yml new file mode 100644 index 00000000..b6963632 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandResponse.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DataFlowDebugCommandResponse +name: DataFlowDebugCommandResponse +fullName: azure.synapse.artifacts.models.DataFlowDebugCommandResponse +module: azure.synapse.artifacts.models +summary: Response body structure of data flow result for data preview, statistics + or expression preview. +constructor: + syntax: 'DataFlowDebugCommandResponse(*, status: str | None = None, data: str | + None = None, **kwargs)' + parameters: + - name: status + description: The run status of data preview, statistics or expression preview. + isRequired: true + types: + - + - name: data + description: The result data of data preview, statistics or expression preview. + isRequired: true + types: + - + keywordOnlyParameters: + - name: status + isRequired: true + - name: data + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DataFlowDebugCommandResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowDebugCommandResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowDebugCommandResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DataFlowDebugCommandResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowDebugCommandResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DataFlowDebugCommandResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowDebugCommandResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackage.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackage.yml new file mode 100644 index 00000000..86dcde64 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackage.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DataFlowDebugPackage +name: DataFlowDebugPackage +fullName: azure.synapse.artifacts.models.DataFlowDebugPackage +module: azure.synapse.artifacts.models +summary: Request body structure for starting data flow debug session. +constructor: + syntax: 'DataFlowDebugPackage(*, additional_properties: Dict[str, object] | None + = None, session_id: str | None = None, data_flow: DataFlowDebugResource | None + = None, datasets: List[DatasetDebugResource] | None = None, linked_services: List[LinkedServiceDebugResource] + | None = None, staging: DataFlowStagingInfo | None = None, debug_settings: DataFlowDebugPackageDebugSettings + | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: session_id + description: The ID of data flow debug session. + isRequired: true + types: + - + - name: data_flow + description: Data flow instance. + isRequired: true + types: + - + - name: datasets + description: List of datasets. + isRequired: true + types: + - [] + - name: linked_services + description: List of linked services. + isRequired: true + types: + - [] + - name: staging + description: Staging info for debug session. + isRequired: true + types: + - + - name: debug_settings + description: Data flow debug settings. + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: session_id + isRequired: true + - name: data_flow + isRequired: true + - name: datasets + isRequired: true + - name: linked_services + isRequired: true + - name: staging + isRequired: true + - name: debug_settings + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DataFlowDebugPackage.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowDebugPackage.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowDebugPackage.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DataFlowDebugPackage.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowDebugPackage.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DataFlowDebugPackage.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowDebugPackage.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings.yml new file mode 100644 index 00000000..5da2c2a2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings +name: DataFlowDebugPackageDebugSettings +fullName: azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings +module: azure.synapse.artifacts.models +summary: Data flow debug settings. +constructor: + syntax: 'DataFlowDebugPackageDebugSettings(*, source_settings: List[DataFlowSourceSetting] + | None = None, parameters: Dict[str, object] | None = None, dataset_parameters: + object | None = None, **kwargs)' + parameters: + - name: source_settings + description: Source setting for data flow debug. + isRequired: true + types: + - [] + - name: parameters + description: Data flow parameters. + isRequired: true + types: + - [, ] + - name: dataset_parameters + description: Parameters for dataset. + isRequired: true + types: + - + keywordOnlyParameters: + - name: source_settings + isRequired: true + - name: parameters + isRequired: true + - name: dataset_parameters + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest.yml new file mode 100644 index 00000000..805a5196 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest +name: DataFlowDebugPreviewDataRequest +fullName: azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest +module: azure.synapse.artifacts.models +summary: Request body structure for data flow preview data. +constructor: + syntax: 'DataFlowDebugPreviewDataRequest(*, session_id: str | None = None, data_flow_name: + str | None = None, stream_name: str | None = None, row_limits: int | None = None, + **kwargs)' + parameters: + - name: session_id + description: The ID of data flow debug session. + isRequired: true + types: + - + - name: data_flow_name + description: The data flow which contains the debug session. + isRequired: true + types: + - + - name: stream_name + description: The output stream name. + isRequired: true + types: + - + - name: row_limits + description: The row limit for preview request. + isRequired: true + types: + - + keywordOnlyParameters: + - name: session_id + isRequired: true + - name: data_flow_name + isRequired: true + - name: stream_name + isRequired: true + - name: row_limits + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugQueryResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugQueryResponse.yml new file mode 100644 index 00000000..1d454baa --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugQueryResponse.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DataFlowDebugQueryResponse +name: DataFlowDebugQueryResponse +fullName: azure.synapse.artifacts.models.DataFlowDebugQueryResponse +module: azure.synapse.artifacts.models +summary: Response body structure of data flow query for data preview, statistics or + expression preview. +constructor: + syntax: 'DataFlowDebugQueryResponse(*, run_id: str | None = None, **kwargs)' + parameters: + - name: run_id + description: The run ID of data flow debug session. + isRequired: true + types: + - + keywordOnlyParameters: + - name: run_id + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DataFlowDebugQueryResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowDebugQueryResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowDebugQueryResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DataFlowDebugQueryResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowDebugQueryResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DataFlowDebugQueryResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowDebugQueryResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResource.yml new file mode 100644 index 00000000..e17ef9e4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResource.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DataFlowDebugResource +name: DataFlowDebugResource +fullName: azure.synapse.artifacts.models.DataFlowDebugResource +module: azure.synapse.artifacts.models +summary: 'Data flow debug resource. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DataFlowDebugResource(*, properties: DataFlow, name: str | None = None, + **kwargs)' + parameters: + - name: name + description: The resource name. + isRequired: true + types: + - + - name: properties + description: Required. Data flow properties. + isRequired: true + types: + - + keywordOnlyParameters: + - name: properties + isRequired: true + - name: name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DataFlowDebugResource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowDebugResource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowDebugResource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DataFlowDebugResource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowDebugResource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DataFlowDebugResource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowDebugResource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResultResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResultResponse.yml new file mode 100644 index 00000000..3f0ccc2e --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResultResponse.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DataFlowDebugResultResponse +name: DataFlowDebugResultResponse +fullName: azure.synapse.artifacts.models.DataFlowDebugResultResponse +module: azure.synapse.artifacts.models +summary: Response body structure of data flow result for data preview, statistics + or expression preview. +constructor: + syntax: 'DataFlowDebugResultResponse(*, status: str | None = None, data: str | None + = None, **kwargs)' + parameters: + - name: status + description: The run status of data preview, statistics or expression preview. + isRequired: true + types: + - + - name: data + description: The result data of data preview, statistics or expression preview. + isRequired: true + types: + - + keywordOnlyParameters: + - name: status + isRequired: true + - name: data + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DataFlowDebugResultResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowDebugResultResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowDebugResultResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DataFlowDebugResultResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowDebugResultResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DataFlowDebugResultResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowDebugResultResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugSessionInfo.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugSessionInfo.yml new file mode 100644 index 00000000..0c093c3c --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugSessionInfo.yml @@ -0,0 +1,193 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DataFlowDebugSessionInfo +name: DataFlowDebugSessionInfo +fullName: azure.synapse.artifacts.models.DataFlowDebugSessionInfo +module: azure.synapse.artifacts.models +summary: Data flow debug session info. +constructor: + syntax: 'DataFlowDebugSessionInfo(*, additional_properties: Dict[str, object] | + None = None, data_flow_name: str | None = None, compute_type: str | None = None, + core_count: int | None = None, node_count: int | None = None, integration_runtime_name: + str | None = None, session_id: str | None = None, start_time: str | None = None, + time_to_live_in_minutes: int | None = None, last_activity_time: str | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: data_flow_name + description: The name of the data flow. + isRequired: true + types: + - + - name: compute_type + description: Compute type of the cluster. + isRequired: true + types: + - + - name: core_count + description: Core count of the cluster. + isRequired: true + types: + - + - name: node_count + description: Node count of the cluster. (deprecated property). + isRequired: true + types: + - + - name: integration_runtime_name + description: Attached integration runtime name of data flow debug session. + isRequired: true + types: + - + - name: session_id + description: The ID of data flow debug session. + isRequired: true + types: + - + - name: start_time + description: Start time of data flow debug session. + isRequired: true + types: + - + - name: time_to_live_in_minutes + description: Compute type of the cluster. + isRequired: true + types: + - + - name: last_activity_time + description: Last activity time of data flow debug session. + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: data_flow_name + isRequired: true + - name: compute_type + isRequired: true + - name: core_count + isRequired: true + - name: node_count + isRequired: true + - name: integration_runtime_name + isRequired: true + - name: session_id + isRequired: true + - name: start_time + isRequired: true + - name: time_to_live_in_minutes + isRequired: true + - name: last_activity_time + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DataFlowDebugSessionInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowDebugSessionInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowDebugSessionInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DataFlowDebugSessionInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowDebugSessionInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DataFlowDebugSessionInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowDebugSessionInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest.yml new file mode 100644 index 00000000..d9e190a5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest +name: DataFlowDebugStatisticsRequest +fullName: azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest +module: azure.synapse.artifacts.models +summary: Request body structure for data flow statistics. +constructor: + syntax: 'DataFlowDebugStatisticsRequest(*, session_id: str | None = None, data_flow_name: + str | None = None, stream_name: str | None = None, columns: List[str] | None = + None, **kwargs)' + parameters: + - name: session_id + description: The ID of data flow debug session. + isRequired: true + types: + - + - name: data_flow_name + description: The data flow which contains the debug session. + isRequired: true + types: + - + - name: stream_name + description: The output stream name. + isRequired: true + types: + - + - name: columns + description: List of column names. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: session_id + isRequired: true + - name: data_flow_name + isRequired: true + - name: stream_name + isRequired: true + - name: columns + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowFolder.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowFolder.yml new file mode 100644 index 00000000..aae22b42 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowFolder.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DataFlowFolder +name: DataFlowFolder +fullName: azure.synapse.artifacts.models.DataFlowFolder +module: azure.synapse.artifacts.models +summary: The folder that this data flow is in. If not specified, Data flow will appear + at the root level. +constructor: + syntax: 'DataFlowFolder(*, name: str | None = None, **kwargs)' + parameters: + - name: name + description: The name of the folder that this data flow is in. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DataFlowFolder.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowFolder.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowFolder.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DataFlowFolder.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowFolder.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DataFlowFolder.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowFolder.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowListResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowListResponse.yml new file mode 100644 index 00000000..e78126a7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowListResponse.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DataFlowListResponse +name: DataFlowListResponse +fullName: azure.synapse.artifacts.models.DataFlowListResponse +module: azure.synapse.artifacts.models +summary: 'A list of data flow resources. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DataFlowListResponse(*, value: List[DataFlowResource], next_link: str | + None = None, **kwargs)' + parameters: + - name: value + description: Required. List of data flows. + isRequired: true + types: + - [] + - name: next_link + description: The link to the next page of results, if any remaining results exist. + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: next_link + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DataFlowListResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowListResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowListResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DataFlowListResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowListResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DataFlowListResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowListResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowReference.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowReference.yml new file mode 100644 index 00000000..c1129d6b --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowReference.yml @@ -0,0 +1,155 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DataFlowReference +name: DataFlowReference +fullName: azure.synapse.artifacts.models.DataFlowReference +module: azure.synapse.artifacts.models +summary: 'Data flow reference type. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DataFlowReference(*, reference_name: str, additional_properties: Dict[str, + object] | None = None, dataset_parameters: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: reference_name + description: Required. Reference data flow name. + isRequired: true + types: + - + - name: dataset_parameters + description: Reference data flow parameters from dataset. + isRequired: true + types: + - + keywordOnlyParameters: + - name: reference_name + isRequired: true + - name: additional_properties + isRequired: true + - name: dataset_parameters + isRequired: true +variables: +- description: 'Required. Data flow reference type. Default value: "DataFlowReference".' + name: type + types: + - +methods: +- uid: azure.synapse.artifacts.models.DataFlowReference.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowReference.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowReference.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DataFlowReference.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowReference.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DataFlowReference.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowReference.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +attributes: +- uid: azure.synapse.artifacts.models.DataFlowReference.type + name: type + signature: type = 'DataFlowReference' diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowResource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowResource.yml new file mode 100644 index 00000000..ca007f30 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowResource.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DataFlowResource +name: DataFlowResource +fullName: azure.synapse.artifacts.models.DataFlowResource +module: azure.synapse.artifacts.models +summary: 'Data flow resource type. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DataFlowResource(*, properties: DataFlow, **kwargs)' + parameters: + - name: properties + description: Required. Data flow properties. + isRequired: true + types: + - + keywordOnlyParameters: + - name: properties + isRequired: true +variables: +- description: The resource identifier. + name: id + types: + - +- description: The resource name. + name: name + types: + - +- description: The resource type. + name: type + types: + - +- description: Etag identifies change in the resource. + name: etag + types: + - +methods: +- uid: azure.synapse.artifacts.models.DataFlowResource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowResource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowResource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DataFlowResource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowResource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DataFlowResource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowResource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSink.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSink.yml new file mode 100644 index 00000000..6fbd4989 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSink.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DataFlowSink +name: DataFlowSink +fullName: azure.synapse.artifacts.models.DataFlowSink +module: azure.synapse.artifacts.models +summary: 'Transformation for data flow sink. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DataFlowSink(*, name: str, description: str | None = None, dataset: DatasetReference + | None = None, **kwargs)' + parameters: + - name: name + description: Required. Transformation name. + isRequired: true + types: + - + - name: description + description: Transformation description. + isRequired: true + types: + - + - name: dataset + description: Dataset reference. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: description + isRequired: true + - name: dataset + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DataFlowSink.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowSink.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowSink.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DataFlowSink.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowSink.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DataFlowSink.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowSink.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSource.yml new file mode 100644 index 00000000..bbf99069 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSource.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DataFlowSource +name: DataFlowSource +fullName: azure.synapse.artifacts.models.DataFlowSource +module: azure.synapse.artifacts.models +summary: 'Transformation for data flow source. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DataFlowSource(*, name: str, description: str | None = None, dataset: DatasetReference + | None = None, **kwargs)' + parameters: + - name: name + description: Required. Transformation name. + isRequired: true + types: + - + - name: description + description: Transformation description. + isRequired: true + types: + - + - name: dataset + description: Dataset reference. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: description + isRequired: true + - name: dataset + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DataFlowSource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowSource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowSource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DataFlowSource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowSource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DataFlowSource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowSource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSourceSetting.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSourceSetting.yml new file mode 100644 index 00000000..ea0611de --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSourceSetting.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DataFlowSourceSetting +name: DataFlowSourceSetting +fullName: azure.synapse.artifacts.models.DataFlowSourceSetting +module: azure.synapse.artifacts.models +summary: Definition of data flow source setting for debug. +constructor: + syntax: 'DataFlowSourceSetting(*, additional_properties: Dict[str, object] | None + = None, source_name: str | None = None, row_limit: int | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: source_name + description: The data flow source name. + isRequired: true + types: + - + - name: row_limit + description: Defines the row limit of data flow source in debug. + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: source_name + isRequired: true + - name: row_limit + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DataFlowSourceSetting.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowSourceSetting.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowSourceSetting.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DataFlowSourceSetting.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowSourceSetting.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DataFlowSourceSetting.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowSourceSetting.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowStagingInfo.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowStagingInfo.yml new file mode 100644 index 00000000..8f1dfe63 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowStagingInfo.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DataFlowStagingInfo +name: DataFlowStagingInfo +fullName: azure.synapse.artifacts.models.DataFlowStagingInfo +module: azure.synapse.artifacts.models +summary: Staging info for execute data flow activity. +constructor: + syntax: 'DataFlowStagingInfo(*, linked_service: LinkedServiceReference | None = + None, folder_path: str | None = None, **kwargs)' + parameters: + - name: linked_service + description: Staging linked service reference. + isRequired: true + types: + - + - name: folder_path + description: Folder path for staging blob. + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service + isRequired: true + - name: folder_path + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DataFlowStagingInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowStagingInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowStagingInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DataFlowStagingInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataFlowStagingInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DataFlowStagingInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataFlowStagingInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity.yml new file mode 100644 index 00000000..30ebb74f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity.yml @@ -0,0 +1,247 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity +name: DataLakeAnalyticsUSQLActivity +fullName: azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity +module: azure.synapse.artifacts.models +summary: 'Data Lake Analytics U-SQL activity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DataLakeAnalyticsUSQLActivity(*, name: str, script_path: object, script_linked_service: + LinkedServiceReference, additional_properties: Dict[str, object] | None = None, + description: str | None = None, depends_on: List[ActivityDependency] | None = + None, user_properties: List[UserProperty] | None = None, linked_service_name: + LinkedServiceReference | None = None, policy: ActivityPolicy | None = None, degree_of_parallelism: + object | None = None, priority: object | None = None, parameters: Dict[str, object] + | None = None, runtime_version: object | None = None, compilation_mode: object + | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + - name: script_path + description: 'Required. Case-sensitive path to folder that contains the U-SQL + script. + + Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: script_linked_service + description: Required. Script linked service reference. + isRequired: true + types: + - + - name: degree_of_parallelism + description: 'The maximum number of nodes simultaneously used to run the job. + + Default value is 1. Type: integer (or Expression with resultType integer), minimum: + 1.' + isRequired: true + types: + - + - name: priority + description: 'Determines which jobs out of all that are queued should be selected + to run + + first. The lower the number, the higher the priority. Default value is 1000. + Type: integer (or + + Expression with resultType integer), minimum: 1.' + isRequired: true + types: + - + - name: parameters + description: Parameters for U-SQL job request. + isRequired: true + types: + - [, ] + - name: runtime_version + description: 'Runtime version of the U-SQL engine to use. Type: string (or Expression + + with resultType string).' + isRequired: true + types: + - + - name: compilation_mode + description: 'Compilation mode of U-SQL. Must be one of these values : Semantic, + + Full and SingleBox. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: script_path + isRequired: true + - name: script_linked_service + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true + - name: degree_of_parallelism + isRequired: true + - name: priority + isRequired: true + - name: parameters + isRequired: true + - name: runtime_version + isRequired: true + - name: compilation_mode + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksNotebookActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksNotebookActivity.yml new file mode 100644 index 00000000..14f7848b --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksNotebookActivity.yml @@ -0,0 +1,210 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DatabricksNotebookActivity +name: DatabricksNotebookActivity +fullName: azure.synapse.artifacts.models.DatabricksNotebookActivity +module: azure.synapse.artifacts.models +summary: 'DatabricksNotebook activity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DatabricksNotebookActivity(*, name: str, notebook_path: object, additional_properties: + Dict[str, object] | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, linked_service_name: + LinkedServiceReference | None = None, policy: ActivityPolicy | None = None, base_parameters: + Dict[str, object] | None = None, libraries: List[Dict[str, object]] | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + - name: notebook_path + description: 'Required. The absolute path of the notebook to be run in the Databricks + + Workspace. This path must begin with a slash. Type: string (or Expression with + resultType + + string).' + isRequired: true + types: + - + - name: base_parameters + description: 'Base parameters to be used for each run of this job.If the notebook + + takes a parameter that is not specified, the default value from the notebook + will be used.' + isRequired: true + types: + - [, ] + - name: libraries + description: A list of libraries to be installed on the cluster that will execute + the job. + isRequired: true + types: + - [[, ]] + keywordOnlyParameters: + - name: name + isRequired: true + - name: notebook_path + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true + - name: base_parameters + isRequired: true + - name: libraries + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DatabricksNotebookActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatabricksNotebookActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatabricksNotebookActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DatabricksNotebookActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatabricksNotebookActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DatabricksNotebookActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatabricksNotebookActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkJarActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkJarActivity.yml new file mode 100644 index 00000000..f48f634f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkJarActivity.yml @@ -0,0 +1,208 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DatabricksSparkJarActivity +name: DatabricksSparkJarActivity +fullName: azure.synapse.artifacts.models.DatabricksSparkJarActivity +module: azure.synapse.artifacts.models +summary: 'DatabricksSparkJar activity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DatabricksSparkJarActivity(*, name: str, main_class_name: object, additional_properties: + Dict[str, object] | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, linked_service_name: + LinkedServiceReference | None = None, policy: ActivityPolicy | None = None, parameters: + List[object] | None = None, libraries: List[Dict[str, object]] | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + - name: main_class_name + description: 'Required. The full name of the class containing the main method + to be + + executed. This class must be contained in a JAR provided as a library. Type: + string (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: parameters + description: Parameters that will be passed to the main method. + isRequired: true + types: + - [] + - name: libraries + description: A list of libraries to be installed on the cluster that will execute + the job. + isRequired: true + types: + - [[, ]] + keywordOnlyParameters: + - name: name + isRequired: true + - name: main_class_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true + - name: parameters + isRequired: true + - name: libraries + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DatabricksSparkJarActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatabricksSparkJarActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatabricksSparkJarActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DatabricksSparkJarActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatabricksSparkJarActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DatabricksSparkJarActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatabricksSparkJarActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkPythonActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkPythonActivity.yml new file mode 100644 index 00000000..d816e633 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkPythonActivity.yml @@ -0,0 +1,205 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DatabricksSparkPythonActivity +name: DatabricksSparkPythonActivity +fullName: azure.synapse.artifacts.models.DatabricksSparkPythonActivity +module: azure.synapse.artifacts.models +summary: 'DatabricksSparkPython activity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DatabricksSparkPythonActivity(*, name: str, python_file: object, additional_properties: + Dict[str, object] | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, linked_service_name: + LinkedServiceReference | None = None, policy: ActivityPolicy | None = None, parameters: + List[object] | None = None, libraries: List[Dict[str, object]] | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + - name: python_file + description: 'Required. The URI of the Python file to be executed. DBFS paths + are + + supported. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: parameters + description: Command line parameters that will be passed to the Python file. + isRequired: true + types: + - [] + - name: libraries + description: A list of libraries to be installed on the cluster that will execute + the job. + isRequired: true + types: + - [[, ]] + keywordOnlyParameters: + - name: name + isRequired: true + - name: python_file + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true + - name: parameters + isRequired: true + - name: libraries + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DatabricksSparkPythonActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatabricksSparkPythonActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatabricksSparkPythonActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DatabricksSparkPythonActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatabricksSparkPythonActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DatabricksSparkPythonActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatabricksSparkPythonActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Dataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Dataset.yml new file mode 100644 index 00000000..989033fc --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Dataset.yml @@ -0,0 +1,221 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.Dataset +name: Dataset +fullName: azure.synapse.artifacts.models.Dataset +module: azure.synapse.artifacts.models +summary: 'The Azure Data Factory nested object which identifies data within different + data stores, such as tables, files, folders, and documents. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: AmazonMWSObjectDataset, AmazonRedshiftTableDataset, AvroDataset, + AzureDataExplorerTableDataset, AzureMariaDBTableDataset, AzureMySqlTableDataset, + AzurePostgreSqlTableDataset, AzureSearchIndexDataset, AzureSqlDWTableDataset, AzureSqlMITableDataset, + AzureSqlTableDataset, AzureTableDataset, BinaryDataset, CassandraTableDataset, CommonDataServiceForAppsEntityDataset, + ConcurObjectDataset, CosmosDbMongoDbApiCollectionDataset, CosmosDbSqlApiCollectionDataset, + CouchbaseTableDataset, Db2TableDataset, DelimitedTextDataset, DocumentDbCollectionDataset, + DrillTableDataset, DynamicsAXResourceDataset, DynamicsCrmEntityDataset, DynamicsEntityDataset, + EloquaObjectDataset, GoogleAdWordsObjectDataset, GoogleBigQueryObjectDataset, GreenplumTableDataset, + HBaseObjectDataset, HiveObjectDataset, HubspotObjectDataset, ImpalaObjectDataset, + InformixTableDataset, JiraObjectDataset, JsonDataset, MagentoObjectDataset, MariaDBTableDataset, + MarketoObjectDataset, MicrosoftAccessTableDataset, MongoDbCollectionDataset, MongoDbV2CollectionDataset, + MySqlTableDataset, NetezzaTableDataset, ODataResourceDataset, OdbcTableDataset, + Office365Dataset, OracleServiceCloudObjectDataset, OracleTableDataset, OrcDataset, + ParquetDataset, PaypalObjectDataset, PhoenixObjectDataset, PostgreSqlTableDataset, + PrestoObjectDataset, QuickBooksObjectDataset, RelationalTableDataset, ResponsysObjectDataset, + RestResourceDataset, SalesforceMarketingCloudObjectDataset, SalesforceObjectDataset, + SalesforceServiceCloudObjectDataset, SapBwCubeDataset, SapCloudForCustomerResourceDataset, + SapEccResourceDataset, SapHanaTableDataset, SapOpenHubTableDataset, SapTableResourceDataset, + ServiceNowObjectDataset, ShopifyObjectDataset, SparkObjectDataset, SqlServerTableDataset, + SquareObjectDataset, SybaseTableDataset, TeradataTableDataset, VerticaTableDataset, + WebTableDataset, XeroObjectDataset, ZohoObjectDataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Dataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.Dataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Dataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Dataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.Dataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Dataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.Dataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Dataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetBZip2Compression.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetBZip2Compression.yml new file mode 100644 index 00000000..895563d3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetBZip2Compression.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DatasetBZip2Compression +name: DatasetBZip2Compression +fullName: azure.synapse.artifacts.models.DatasetBZip2Compression +module: azure.synapse.artifacts.models +summary: 'The BZip2 compression method used on a dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DatasetBZip2Compression(*, additional_properties: Dict[str, object] | None + = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset compression.Constant filled by server. + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DatasetBZip2Compression.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatasetBZip2Compression.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatasetBZip2Compression.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DatasetBZip2Compression.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatasetBZip2Compression.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DatasetBZip2Compression.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatasetBZip2Compression.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetCompression.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetCompression.yml new file mode 100644 index 00000000..ce5c062d --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetCompression.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DatasetCompression +name: DatasetCompression +fullName: azure.synapse.artifacts.models.DatasetCompression +module: azure.synapse.artifacts.models +summary: 'The compression method used on a dataset. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: DatasetBZip2Compression, DatasetDeflateCompression, DatasetGZipCompression, + DatasetZipDeflateCompression. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DatasetCompression(*, additional_properties: Dict[str, object] | None = + None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset compression.Constant filled by server. + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DatasetCompression.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatasetCompression.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatasetCompression.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DatasetCompression.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatasetCompression.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DatasetCompression.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatasetCompression.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetCompressionLevel.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetCompressionLevel.yml new file mode 100644 index 00000000..286dde27 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetCompressionLevel.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.DatasetCompressionLevel +name: DatasetCompressionLevel +fullName: azure.synapse.artifacts.models.DatasetCompressionLevel +summary: All available compression levels. +module: azure.synapse.artifacts.models +fields: +- name: fastest + uid: azure.synapse.artifacts.models.DatasetCompressionLevel.fastest +- name: optimal + uid: azure.synapse.artifacts.models.DatasetCompressionLevel.optimal diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDebugResource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDebugResource.yml new file mode 100644 index 00000000..5ccef6a0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDebugResource.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DatasetDebugResource +name: DatasetDebugResource +fullName: azure.synapse.artifacts.models.DatasetDebugResource +module: azure.synapse.artifacts.models +summary: 'Dataset debug resource. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DatasetDebugResource(*, properties: Dataset, name: str | None = None, **kwargs)' + parameters: + - name: name + description: The resource name. + isRequired: true + types: + - + - name: properties + description: Required. Dataset properties. + isRequired: true + types: + - + keywordOnlyParameters: + - name: properties + isRequired: true + - name: name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DatasetDebugResource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatasetDebugResource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatasetDebugResource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DatasetDebugResource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatasetDebugResource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DatasetDebugResource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatasetDebugResource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDeflateCompression.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDeflateCompression.yml new file mode 100644 index 00000000..04487761 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDeflateCompression.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DatasetDeflateCompression +name: DatasetDeflateCompression +fullName: azure.synapse.artifacts.models.DatasetDeflateCompression +module: azure.synapse.artifacts.models +summary: 'The Deflate compression method used on a dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DatasetDeflateCompression(*, additional_properties: Dict[str, object] | + None = None, level: str | DatasetCompressionLevel | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset compression.Constant filled by server. + isRequired: true + types: + - + - name: level + description: 'The Deflate compression level. Possible values include: "Optimal", + "Fastest".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: level + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DatasetDeflateCompression.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatasetDeflateCompression.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatasetDeflateCompression.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DatasetDeflateCompression.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatasetDeflateCompression.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DatasetDeflateCompression.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatasetDeflateCompression.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetFolder.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetFolder.yml new file mode 100644 index 00000000..a22a5254 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetFolder.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DatasetFolder +name: DatasetFolder +fullName: azure.synapse.artifacts.models.DatasetFolder +module: azure.synapse.artifacts.models +summary: The folder that this Dataset is in. If not specified, Dataset will appear + at the root level. +constructor: + syntax: 'DatasetFolder(*, name: str | None = None, **kwargs)' + parameters: + - name: name + description: The name of the folder that this Dataset is in. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DatasetFolder.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatasetFolder.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatasetFolder.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DatasetFolder.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatasetFolder.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DatasetFolder.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatasetFolder.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetGZipCompression.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetGZipCompression.yml new file mode 100644 index 00000000..34872761 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetGZipCompression.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DatasetGZipCompression +name: DatasetGZipCompression +fullName: azure.synapse.artifacts.models.DatasetGZipCompression +module: azure.synapse.artifacts.models +summary: 'The GZip compression method used on a dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DatasetGZipCompression(*, additional_properties: Dict[str, object] | None + = None, level: str | DatasetCompressionLevel | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset compression.Constant filled by server. + isRequired: true + types: + - + - name: level + description: 'The GZip compression level. Possible values include: "Optimal", + "Fastest".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: level + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DatasetGZipCompression.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatasetGZipCompression.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatasetGZipCompression.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DatasetGZipCompression.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatasetGZipCompression.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DatasetGZipCompression.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatasetGZipCompression.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetListResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetListResponse.yml new file mode 100644 index 00000000..b1020145 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetListResponse.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DatasetListResponse +name: DatasetListResponse +fullName: azure.synapse.artifacts.models.DatasetListResponse +module: azure.synapse.artifacts.models +summary: 'A list of dataset resources. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DatasetListResponse(*, value: List[DatasetResource], next_link: str | None + = None, **kwargs)' + parameters: + - name: value + description: Required. List of datasets. + isRequired: true + types: + - [] + - name: next_link + description: The link to the next page of results, if any remaining results exist. + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: next_link + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DatasetListResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatasetListResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatasetListResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DatasetListResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatasetListResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DatasetListResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatasetListResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetLocation.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetLocation.yml new file mode 100644 index 00000000..e2ae9af7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetLocation.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DatasetLocation +name: DatasetLocation +fullName: azure.synapse.artifacts.models.DatasetLocation +module: azure.synapse.artifacts.models +summary: 'Dataset location. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: . + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DatasetLocation(*, additional_properties: Dict[str, object] | None = None, + folder_path: object | None = None, file_name: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset storage location.Constant filled by server. + isRequired: true + types: + - + - name: folder_path + description: 'Specify the folder path of dataset. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: file_name + description: 'Specify the file name of dataset. Type: string (or Expression with + resultType + + string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: folder_path + isRequired: true + - name: file_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DatasetLocation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatasetLocation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatasetLocation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DatasetLocation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatasetLocation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DatasetLocation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatasetLocation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetReference.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetReference.yml new file mode 100644 index 00000000..1e4eea29 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetReference.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DatasetReference +name: DatasetReference +fullName: azure.synapse.artifacts.models.DatasetReference +module: azure.synapse.artifacts.models +summary: 'Dataset reference type. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DatasetReference(*, reference_name: str, parameters: Dict[str, object] + | None = None, **kwargs)' + parameters: + - name: reference_name + description: Required. Reference dataset name. + isRequired: true + types: + - + - name: parameters + description: Arguments for dataset. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: reference_name + isRequired: true + - name: parameters + isRequired: true +variables: +- description: 'Required. Dataset reference type. Default value: "DatasetReference".' + name: type + types: + - +methods: +- uid: azure.synapse.artifacts.models.DatasetReference.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatasetReference.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatasetReference.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DatasetReference.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatasetReference.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DatasetReference.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatasetReference.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +attributes: +- uid: azure.synapse.artifacts.models.DatasetReference.type + name: type + signature: type = 'DatasetReference' diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetResource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetResource.yml new file mode 100644 index 00000000..6cf86a4c --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetResource.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DatasetResource +name: DatasetResource +fullName: azure.synapse.artifacts.models.DatasetResource +module: azure.synapse.artifacts.models +summary: 'Dataset resource type. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DatasetResource(*, properties: Dataset, **kwargs)' + parameters: + - name: properties + description: Required. Dataset properties. + isRequired: true + types: + - + keywordOnlyParameters: + - name: properties + isRequired: true +variables: +- description: The resource identifier. + name: id + types: + - +- description: The resource name. + name: name + types: + - +- description: The resource type. + name: type + types: + - +- description: Etag identifies change in the resource. + name: etag + types: + - +methods: +- uid: azure.synapse.artifacts.models.DatasetResource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatasetResource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatasetResource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DatasetResource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatasetResource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DatasetResource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatasetResource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetZipDeflateCompression.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetZipDeflateCompression.yml new file mode 100644 index 00000000..91a970ae --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetZipDeflateCompression.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DatasetZipDeflateCompression +name: DatasetZipDeflateCompression +fullName: azure.synapse.artifacts.models.DatasetZipDeflateCompression +module: azure.synapse.artifacts.models +summary: 'The ZipDeflate compression method used on a dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DatasetZipDeflateCompression(*, additional_properties: Dict[str, object] + | None = None, level: str | DatasetCompressionLevel | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset compression.Constant filled by server. + isRequired: true + types: + - + - name: level + description: 'The ZipDeflate compression level. Possible values include: "Optimal", + "Fastest".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: level + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DatasetZipDeflateCompression.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatasetZipDeflateCompression.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatasetZipDeflateCompression.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DatasetZipDeflateCompression.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DatasetZipDeflateCompression.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DatasetZipDeflateCompression.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DatasetZipDeflateCompression.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2LinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2LinkedService.yml new file mode 100644 index 00000000..a58c0248 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2LinkedService.yml @@ -0,0 +1,247 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.Db2LinkedService +name: Db2LinkedService +fullName: azure.synapse.artifacts.models.Db2LinkedService +module: azure.synapse.artifacts.models +summary: 'Linked service for DB2 data source. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Db2LinkedService(*, server: object, database: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, username: object | None + = None, password: SecretBase | None = None, package_collection: object | None + = None, certificate_common_name: object | None = None, encrypted_credential: object + | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: server + description: 'Required. Server name for connection. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: database + description: 'Required. Database name for connection. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: username + description: 'Username for authentication. Type: string (or Expression with resultType + + string).' + isRequired: true + types: + - + - name: password + description: Password for authentication. + isRequired: true + types: + - + - name: package_collection + description: 'Under where packages are created when querying database. Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: certificate_common_name + description: 'Certificate Common Name when TLS is enabled. Type: string (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: server + isRequired: true + - name: database + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: username + isRequired: true + - name: password + isRequired: true + - name: package_collection + isRequired: true + - name: certificate_common_name + isRequired: true + - name: encrypted_credential + isRequired: true +variables: +- description: 'AuthenticationType to be used for connection. Default value: + + "Basic".' + name: authentication_type + types: + - +methods: +- uid: azure.synapse.artifacts.models.Db2LinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Db2LinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Db2LinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.Db2LinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Db2LinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.Db2LinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Db2LinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +attributes: +- uid: azure.synapse.artifacts.models.Db2LinkedService.authentication_type + name: authentication_type + signature: authentication_type = 'Basic' diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2TableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2TableDataset.yml new file mode 100644 index 00000000..64ecf3ea --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2TableDataset.yml @@ -0,0 +1,222 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.Db2TableDataset +name: Db2TableDataset +fullName: azure.synapse.artifacts.models.Db2TableDataset +module: azure.synapse.artifacts.models +summary: 'The Db2 table dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Db2TableDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, schema_type_properties_schema: + object | None = None, table: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'This property will be retired. Please consider using schema + table + + properties instead.' + isRequired: true + types: + - + - name: schema_type_properties_schema + description: 'The Db2 schema name. Type: string (or Expression with + + resultType string).' + isRequired: true + types: + - + - name: table + description: 'The Db2 table name. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true + - name: schema_type_properties_schema + isRequired: true + - name: table + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.Db2TableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Db2TableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Db2TableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.Db2TableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Db2TableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.Db2TableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Db2TableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteActivity.yml new file mode 100644 index 00000000..db507846 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteActivity.yml @@ -0,0 +1,226 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DeleteActivity +name: DeleteActivity +fullName: azure.synapse.artifacts.models.DeleteActivity +module: azure.synapse.artifacts.models +summary: 'Delete activity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DeleteActivity(*, name: str, dataset: DatasetReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, linked_service_name: + LinkedServiceReference | None = None, policy: ActivityPolicy | None = None, recursive: + object | None = None, max_concurrent_connections: int | None = None, enable_logging: + object | None = None, log_storage_settings: LogStorageSettings | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + - name: recursive + description: 'If true, files or sub-folders under current folder path will be + deleted + + recursively. Default is false. Type: boolean (or Expression with resultType + boolean).' + isRequired: true + types: + - + - name: max_concurrent_connections + description: 'The max concurrent connections to connect data source at the + + same time.' + isRequired: true + types: + - + - name: enable_logging + description: 'Whether to record detailed logs of delete-activity execution. Default + + value is false. Type: boolean (or Expression with resultType boolean).' + isRequired: true + types: + - + - name: log_storage_settings + description: 'Log storage settings customer need to provide when enableLogging + + is true.' + isRequired: true + types: + - + - name: dataset + description: Required. Delete activity dataset reference. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: dataset + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true + - name: recursive + isRequired: true + - name: max_concurrent_connections + isRequired: true + - name: enable_logging + isRequired: true + - name: log_storage_settings + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DeleteActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DeleteActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DeleteActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DeleteActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DeleteActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DeleteActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DeleteActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest.yml new file mode 100644 index 00000000..b56495f8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest +name: DeleteDataFlowDebugSessionRequest +fullName: azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest +module: azure.synapse.artifacts.models +summary: Request body structure for deleting data flow debug session. +constructor: + syntax: 'DeleteDataFlowDebugSessionRequest(*, session_id: str | None = None, data_flow_name: + str | None = None, **kwargs)' + parameters: + - name: session_id + description: The ID of data flow debug session. + isRequired: true + types: + - + - name: data_flow_name + description: The data flow which contains the debug session. + isRequired: true + types: + - + keywordOnlyParameters: + - name: session_id + isRequired: true + - name: data_flow_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextCompressionCodec.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextCompressionCodec.yml new file mode 100644 index 00000000..77f7b4ac --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextCompressionCodec.yml @@ -0,0 +1,18 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.DelimitedTextCompressionCodec +name: DelimitedTextCompressionCodec +fullName: azure.synapse.artifacts.models.DelimitedTextCompressionCodec +module: azure.synapse.artifacts.models +fields: +- name: bzip2 + uid: azure.synapse.artifacts.models.DelimitedTextCompressionCodec.bzip2 +- name: deflate + uid: azure.synapse.artifacts.models.DelimitedTextCompressionCodec.deflate +- name: gzip + uid: azure.synapse.artifacts.models.DelimitedTextCompressionCodec.gzip +- name: lz4 + uid: azure.synapse.artifacts.models.DelimitedTextCompressionCodec.lz4 +- name: snappy + uid: azure.synapse.artifacts.models.DelimitedTextCompressionCodec.snappy +- name: zip_deflate + uid: azure.synapse.artifacts.models.DelimitedTextCompressionCodec.zip_deflate diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextDataset.yml new file mode 100644 index 00000000..82b41095 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextDataset.yml @@ -0,0 +1,297 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DelimitedTextDataset +name: DelimitedTextDataset +fullName: azure.synapse.artifacts.models.DelimitedTextDataset +module: azure.synapse.artifacts.models +summary: 'Delimited text dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DelimitedTextDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, location: DatasetLocation | None = None, column_delimiter: object + | None = None, row_delimiter: object | None = None, encoding_name: object | None + = None, compression_codec: str | DelimitedTextCompressionCodec | None = None, + compression_level: str | DatasetCompressionLevel | None = None, quote_char: object + | None = None, escape_char: object | None = None, first_row_as_header: object + | None = None, null_value: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: location + description: The location of the delimited text storage. + isRequired: true + types: + - + - name: column_delimiter + description: 'The column delimiter. Type: string (or Expression with resultType + + string).' + isRequired: true + types: + - + - name: row_delimiter + description: 'The row delimiter. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: encoding_name + description: 'The code page name of the preferred encoding. If miss, the default + value + + is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column + of the table in + + the following link to set supported values: + + [https://msdn.microsoft.com/library/system.text.encoding.aspx](https://msdn.microsoft.com/library/system.text.encoding.aspx). + Type: string (or Expression with + + resultType string).' + isRequired: true + types: + - + - name: compression_codec + description: 'Possible values include: "bzip2", "gzip", "deflate", "zipDeflate", + + "snappy", "lz4".' + isRequired: true + types: + - + - + - name: compression_level + description: 'The data compression method used for DelimitedText. Possible values + + include: "Optimal", "Fastest".' + isRequired: true + types: + - + - + - name: quote_char + description: 'The quote character. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: escape_char + description: 'The escape character. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: first_row_as_header + description: 'When used as input, treat the first row of data as headers. When + + used as output,write the headers into the output as the first row of data. The + default value is + + false. Type: boolean (or Expression with resultType boolean).' + isRequired: true + types: + - + - name: null_value + description: 'The null value string. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: location + isRequired: true + - name: column_delimiter + isRequired: true + - name: row_delimiter + isRequired: true + - name: encoding_name + isRequired: true + - name: compression_codec + isRequired: true + - name: compression_level + isRequired: true + - name: quote_char + isRequired: true + - name: escape_char + isRequired: true + - name: first_row_as_header + isRequired: true + - name: null_value + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DelimitedTextDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DelimitedTextDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DelimitedTextDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DelimitedTextDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DelimitedTextDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DelimitedTextDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DelimitedTextDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DependencyCondition.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DependencyCondition.yml new file mode 100644 index 00000000..5fe2fcf3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DependencyCondition.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.DependencyCondition +name: DependencyCondition +fullName: azure.synapse.artifacts.models.DependencyCondition +module: azure.synapse.artifacts.models +fields: +- name: completed + uid: azure.synapse.artifacts.models.DependencyCondition.completed +- name: failed + uid: azure.synapse.artifacts.models.DependencyCondition.failed +- name: skipped + uid: azure.synapse.artifacts.models.DependencyCondition.skipped +- name: succeeded + uid: azure.synapse.artifacts.models.DependencyCondition.succeeded diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DocumentDbCollectionDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DocumentDbCollectionDataset.yml new file mode 100644 index 00000000..c13186ba --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DocumentDbCollectionDataset.yml @@ -0,0 +1,204 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DocumentDbCollectionDataset +name: DocumentDbCollectionDataset +fullName: azure.synapse.artifacts.models.DocumentDbCollectionDataset +module: azure.synapse.artifacts.models +summary: 'Microsoft Azure Document Database Collection dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DocumentDbCollectionDataset(*, linked_service_name: LinkedServiceReference, + collection_name: object, additional_properties: Dict[str, object] | None = None, + description: str | None = None, structure: object | None = None, schema: object + | None = None, parameters: Dict[str, ParameterSpecification] | None = None, annotations: + List[object] | None = None, folder: DatasetFolder | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: collection_name + description: 'Required. Document Database collection name. Type: string (or + + Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: collection_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DocumentDbCollectionDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DocumentDbCollectionDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DocumentDbCollectionDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DocumentDbCollectionDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DocumentDbCollectionDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DocumentDbCollectionDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DocumentDbCollectionDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillLinkedService.yml new file mode 100644 index 00000000..99e3b8ed --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillLinkedService.yml @@ -0,0 +1,193 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DrillLinkedService +name: DrillLinkedService +fullName: azure.synapse.artifacts.models.DrillLinkedService +module: azure.synapse.artifacts.models +summary: 'Drill server linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DrillLinkedService(*, additional_properties: Dict[str, object] | None = + None, connect_via: IntegrationRuntimeReference | None = None, description: str + | None = None, parameters: Dict[str, ParameterSpecification] | None = None, annotations: + List[object] | None = None, connection_string: object | None = None, pwd: AzureKeyVaultSecretReference + | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'An ODBC connection string. Type: string, SecureString or + + AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: pwd + description: The Azure key vault secret reference of password in connection string. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: connection_string + isRequired: true + - name: pwd + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DrillLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DrillLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DrillLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DrillLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DrillLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DrillLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DrillLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillTableDataset.yml new file mode 100644 index 00000000..87a163c8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillTableDataset.yml @@ -0,0 +1,222 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DrillTableDataset +name: DrillTableDataset +fullName: azure.synapse.artifacts.models.DrillTableDataset +module: azure.synapse.artifacts.models +summary: 'Drill server dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DrillTableDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, table: object | None = None, + schema_type_properties_schema: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'This property will be retired. Please consider using schema + table + + properties instead.' + isRequired: true + types: + - + - name: table + description: 'The table name of the Drill. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: schema_type_properties_schema + description: 'The schema name of the Drill. Type: string (or Expression + + with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true + - name: table + isRequired: true + - name: schema_type_properties_schema + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DrillTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DrillTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DrillTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DrillTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DrillTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DrillTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DrillTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXLinkedService.yml new file mode 100644 index 00000000..09abdbdd --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXLinkedService.yml @@ -0,0 +1,232 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DynamicsAXLinkedService +name: DynamicsAXLinkedService +fullName: azure.synapse.artifacts.models.DynamicsAXLinkedService +module: azure.synapse.artifacts.models +summary: 'Dynamics AX linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DynamicsAXLinkedService(*, url: object, service_principal_id: object, service_principal_key: + SecretBase, tenant: object, aad_resource_id: object, additional_properties: Dict[str, + object] | None = None, connect_via: IntegrationRuntimeReference | None = None, + description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: url + description: 'Required. The Dynamics AX (or Dynamics 365 Finance and Operations) + instance OData + + endpoint.' + isRequired: true + types: + - + - name: service_principal_id + description: 'Required. Specify the application''s client ID. Type: string (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: service_principal_key + description: 'Required. Specify the application''s key. Mark this field as a + + SecureString to store it securely in Data Factory, or reference a secret stored + in Azure Key + + Vault. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: tenant + description: 'Required. Specify the tenant information (domain name or tenant + ID) under which + + your application resides. Retrieve it by hovering the mouse in the top-right + corner of the + + Azure portal. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: aad_resource_id + description: 'Required. Specify the resource you are requesting authorization. + Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: url + isRequired: true + - name: service_principal_id + isRequired: true + - name: service_principal_key + isRequired: true + - name: tenant + isRequired: true + - name: aad_resource_id + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DynamicsAXLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DynamicsAXLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DynamicsAXLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DynamicsAXLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DynamicsAXLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DynamicsAXLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DynamicsAXLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXResourceDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXResourceDataset.yml new file mode 100644 index 00000000..2161590d --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXResourceDataset.yml @@ -0,0 +1,205 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DynamicsAXResourceDataset +name: DynamicsAXResourceDataset +fullName: azure.synapse.artifacts.models.DynamicsAXResourceDataset +module: azure.synapse.artifacts.models +summary: 'The path of the Dynamics AX OData entity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DynamicsAXResourceDataset(*, linked_service_name: LinkedServiceReference, + path: object, additional_properties: Dict[str, object] | None = None, description: + str | None = None, structure: object | None = None, schema: object | None = None, + parameters: Dict[str, ParameterSpecification] | None = None, annotations: List[object] + | None = None, folder: DatasetFolder | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: path + description: 'Required. The path of the Dynamics AX OData entity. Type: string + (or Expression + + with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: path + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DynamicsAXResourceDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DynamicsAXResourceDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DynamicsAXResourceDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DynamicsAXResourceDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DynamicsAXResourceDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DynamicsAXResourceDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DynamicsAXResourceDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAuthenticationType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAuthenticationType.yml new file mode 100644 index 00000000..bdd225e2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAuthenticationType.yml @@ -0,0 +1,19 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.DynamicsAuthenticationType +name: DynamicsAuthenticationType +fullName: azure.synapse.artifacts.models.DynamicsAuthenticationType +summary: 'The authentication type to connect to Dynamics server. ''Office365'' for + online scenario, ''Ifd'' + + for on-premises with Ifd scenario, ''AADServicePrincipal'' for Server-To-Server + authentication in + + online scenario. Type: string (or Expression with resultType string).' +module: azure.synapse.artifacts.models +fields: +- name: aad_service_principal + uid: azure.synapse.artifacts.models.DynamicsAuthenticationType.aad_service_principal +- name: ifd + uid: azure.synapse.artifacts.models.DynamicsAuthenticationType.ifd +- name: office365 + uid: azure.synapse.artifacts.models.DynamicsAuthenticationType.office365 diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmEntityDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmEntityDataset.yml new file mode 100644 index 00000000..f1383ac3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmEntityDataset.yml @@ -0,0 +1,206 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DynamicsCrmEntityDataset +name: DynamicsCrmEntityDataset +fullName: azure.synapse.artifacts.models.DynamicsCrmEntityDataset +module: azure.synapse.artifacts.models +summary: 'The Dynamics CRM entity dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DynamicsCrmEntityDataset(*, linked_service_name: LinkedServiceReference, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, structure: object | None = None, schema: object | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, folder: DatasetFolder | None = None, entity_name: object | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: entity_name + description: 'The logical name of the entity. Type: string (or Expression with + resultType + + string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: entity_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DynamicsCrmEntityDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DynamicsCrmEntityDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DynamicsCrmEntityDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DynamicsCrmEntityDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DynamicsCrmEntityDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DynamicsCrmEntityDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DynamicsCrmEntityDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmLinkedService.yml new file mode 100644 index 00000000..56212835 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmLinkedService.yml @@ -0,0 +1,325 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DynamicsCrmLinkedService +name: DynamicsCrmLinkedService +fullName: azure.synapse.artifacts.models.DynamicsCrmLinkedService +module: azure.synapse.artifacts.models +summary: 'Dynamics CRM linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DynamicsCrmLinkedService(*, deployment_type: str | DynamicsDeploymentType, + authentication_type: str | DynamicsAuthenticationType, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, host_name: object | None + = None, port: object | None = None, service_uri: object | None = None, organization_name: + object | None = None, username: object | None = None, password: SecretBase | None + = None, service_principal_id: object | None = None, service_principal_credential_type: + str | DynamicsServicePrincipalCredentialType | None = None, service_principal_credential: + SecretBase | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: deployment_type + description: 'Required. The deployment type of the Dynamics CRM instance. ''Online'' + + for Dynamics CRM Online and ''OnPremisesWithIfd'' for Dynamics CRM on-premises + with Ifd. Type: + + string (or Expression with resultType string). Possible values include: "Online", + + "OnPremisesWithIfd".' + isRequired: true + types: + - + - + - name: host_name + description: 'The host name of the on-premises Dynamics CRM server. The property + is + + required for on-prem and not allowed for online. Type: string (or Expression + with resultType + + string).' + isRequired: true + types: + - + - name: port + description: 'The port of on-premises Dynamics CRM server. The property is required + for on-prem + + and not allowed for online. Default is 443. Type: integer (or Expression with + resultType + + integer), minimum: 0.' + isRequired: true + types: + - + - name: service_uri + description: 'The URL to the Microsoft Dynamics CRM server. The property is required + for + + on-line and not allowed for on-prem. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: organization_name + description: 'The organization name of the Dynamics CRM instance. The property + is + + required for on-prem and required for online when there are more than one Dynamics + CRM + + instances associated with the user. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: authentication_type + description: 'Required. The authentication type to connect to Dynamics CRM + + server. ''Office365'' for online scenario, ''Ifd'' for on-premises with Ifd + scenario, + + ''AADServicePrincipal'' for Server-To-Server authentication in online scenario. + Type: string (or + + Expression with resultType string). Possible values include: "Office365", "Ifd", + + "AADServicePrincipal".' + isRequired: true + types: + - + - + - name: username + description: 'User name to access the Dynamics CRM instance. Type: string (or + Expression + + with resultType string).' + isRequired: true + types: + - + - name: password + description: Password to access the Dynamics CRM instance. + isRequired: true + types: + - + - name: service_principal_id + description: 'The client ID of the application in Azure Active Directory used + + for Server-To-Server authentication. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: service_principal_credential_type + description: 'The service principal credential type to use in + + Server-To-Server authentication. ''ServicePrincipalKey'' for key/secret, ''ServicePrincipalCert'' + + for certificate. Type: string (or Expression with resultType string). Possible + values include: + + "ServicePrincipalKey", "ServicePrincipalCert".' + isRequired: true + types: + - + - + - name: service_principal_credential + description: 'The credential of the service principal object in Azure + + Active Directory. If servicePrincipalCredentialType is ''ServicePrincipalKey'', + + servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. + If + + servicePrincipalCredentialType is ''ServicePrincipalCert'', servicePrincipalCredential + can only + + be AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: deployment_type + isRequired: true + - name: authentication_type + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: host_name + isRequired: true + - name: port + isRequired: true + - name: service_uri + isRequired: true + - name: organization_name + isRequired: true + - name: username + isRequired: true + - name: password + isRequired: true + - name: service_principal_id + isRequired: true + - name: service_principal_credential_type + isRequired: true + - name: service_principal_credential + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DynamicsCrmLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DynamicsCrmLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DynamicsCrmLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DynamicsCrmLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DynamicsCrmLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DynamicsCrmLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DynamicsCrmLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsDeploymentType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsDeploymentType.yml new file mode 100644 index 00000000..de0733c0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsDeploymentType.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.DynamicsDeploymentType +name: DynamicsDeploymentType +fullName: azure.synapse.artifacts.models.DynamicsDeploymentType +summary: 'The deployment type of the Dynamics instance. ''Online'' for Dynamics Online + and + + ''OnPremisesWithIfd'' for Dynamics on-premises with Ifd. Type: string (or Expression + with + + resultType string).' +module: azure.synapse.artifacts.models +fields: +- name: on_premises_with_ifd + uid: azure.synapse.artifacts.models.DynamicsDeploymentType.on_premises_with_ifd +- name: online + uid: azure.synapse.artifacts.models.DynamicsDeploymentType.online diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsEntityDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsEntityDataset.yml new file mode 100644 index 00000000..c59d2ce6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsEntityDataset.yml @@ -0,0 +1,205 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DynamicsEntityDataset +name: DynamicsEntityDataset +fullName: azure.synapse.artifacts.models.DynamicsEntityDataset +module: azure.synapse.artifacts.models +summary: 'The Dynamics entity dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DynamicsEntityDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, entity_name: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: entity_name + description: 'The logical name of the entity. Type: string (or Expression with + resultType + + string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: entity_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DynamicsEntityDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DynamicsEntityDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DynamicsEntityDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DynamicsEntityDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DynamicsEntityDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DynamicsEntityDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DynamicsEntityDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsLinkedService.yml new file mode 100644 index 00000000..673abfe3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsLinkedService.yml @@ -0,0 +1,318 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.DynamicsLinkedService +name: DynamicsLinkedService +fullName: azure.synapse.artifacts.models.DynamicsLinkedService +module: azure.synapse.artifacts.models +summary: 'Dynamics linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'DynamicsLinkedService(*, deployment_type: str | DynamicsDeploymentType, + authentication_type: str | DynamicsAuthenticationType, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, host_name: str | None + = None, port: str | None = None, service_uri: str | None = None, organization_name: + str | None = None, username: object | None = None, password: SecretBase | None + = None, service_principal_id: object | None = None, service_principal_credential_type: + str | DynamicsServicePrincipalCredentialType | None = None, service_principal_credential: + SecretBase | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: deployment_type + description: 'Required. The deployment type of the Dynamics instance. ''Online'' + for + + Dynamics Online and ''OnPremisesWithIfd'' for Dynamics on-premises with Ifd. + Type: string (or + + Expression with resultType string). Possible values include: "Online", "OnPremisesWithIfd".' + isRequired: true + types: + - + - + - name: host_name + description: 'The host name of the on-premises Dynamics server. The property is + required + + for on-prem and not allowed for online. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: port + description: 'The port of on-premises Dynamics server. The property is required + for on-prem and + + not allowed for online. Default is 443. Type: integer (or Expression with resultType + integer), + + minimum: 0.' + isRequired: true + types: + - + - name: service_uri + description: 'The URL to the Microsoft Dynamics server. The property is required + for on- + + line and not allowed for on-prem. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: organization_name + description: 'The organization name of the Dynamics instance. The property is + + required for on-prem and required for online when there are more than one Dynamics + instances + + associated with the user. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: authentication_type + description: 'Required. The authentication type to connect to Dynamics server. + + ''Office365'' for online scenario, ''Ifd'' for on-premises with Ifd scenario, + ''AADServicePrincipal'' + + for Server-To-Server authentication in online scenario. Type: string (or Expression + with + + resultType string). Possible values include: "Office365", "Ifd", "AADServicePrincipal".' + isRequired: true + types: + - + - + - name: username + description: 'User name to access the Dynamics instance. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: password + description: Password to access the Dynamics instance. + isRequired: true + types: + - + - name: service_principal_id + description: 'The client ID of the application in Azure Active Directory used + + for Server-To-Server authentication. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: service_principal_credential_type + description: 'The service principal credential type to use in + + Server-To-Server authentication. ''ServicePrincipalKey'' for key/secret, ''ServicePrincipalCert'' + + for certificate. Type: string (or Expression with resultType string). Possible + values include: + + "ServicePrincipalKey", "ServicePrincipalCert".' + isRequired: true + types: + - + - + - name: service_principal_credential + description: 'The credential of the service principal object in Azure + + Active Directory. If servicePrincipalCredentialType is ''ServicePrincipalKey'', + + servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. + If + + servicePrincipalCredentialType is ''ServicePrincipalCert'', servicePrincipalCredential + can only + + be AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: deployment_type + isRequired: true + - name: authentication_type + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: host_name + isRequired: true + - name: port + isRequired: true + - name: service_uri + isRequired: true + - name: organization_name + isRequired: true + - name: username + isRequired: true + - name: password + isRequired: true + - name: service_principal_id + isRequired: true + - name: service_principal_credential_type + isRequired: true + - name: service_principal_credential + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.DynamicsLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DynamicsLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DynamicsLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.DynamicsLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.DynamicsLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.DynamicsLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.DynamicsLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsServicePrincipalCredentialType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsServicePrincipalCredentialType.yml new file mode 100644 index 00000000..4f301a41 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsServicePrincipalCredentialType.yml @@ -0,0 +1,16 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.DynamicsServicePrincipalCredentialType +name: DynamicsServicePrincipalCredentialType +fullName: azure.synapse.artifacts.models.DynamicsServicePrincipalCredentialType +summary: 'The service principal credential type to use in Server-To-Server authentication. + + ''ServicePrincipalKey'' for key/secret, ''ServicePrincipalCert'' for certificate. + Type: string (or + + Expression with resultType string).' +module: azure.synapse.artifacts.models +fields: +- name: service_principal_cert + uid: azure.synapse.artifacts.models.DynamicsServicePrincipalCredentialType.service_principal_cert +- name: service_principal_key + uid: azure.synapse.artifacts.models.DynamicsServicePrincipalCredentialType.service_principal_key diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaLinkedService.yml new file mode 100644 index 00000000..30952584 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaLinkedService.yml @@ -0,0 +1,233 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.EloquaLinkedService +name: EloquaLinkedService +fullName: azure.synapse.artifacts.models.EloquaLinkedService +module: azure.synapse.artifacts.models +summary: 'Eloqua server linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EloquaLinkedService(*, endpoint: object, username: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, password: SecretBase | + None = None, use_encrypted_endpoints: object | None = None, use_host_verification: + object | None = None, use_peer_verification: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: endpoint + description: Required. The endpoint of the Eloqua server. (i.e. eloqua.example.com). + isRequired: true + types: + - + - name: username + description: 'Required. The site name and user name of your Eloqua account in + the form: + + sitename/username. (i.e. Eloqua/Alice).' + isRequired: true + types: + - + - name: password + description: The password corresponding to the user name. + isRequired: true + types: + - + - name: use_encrypted_endpoints + description: 'Specifies whether the data source endpoints are encrypted using + + HTTPS. The default value is true.' + isRequired: true + types: + - + - name: use_host_verification + description: 'Specifies whether to require the host name in the server''s + + certificate to match the host name of the server when connecting over SSL. The + default value is + + true.' + isRequired: true + types: + - + - name: use_peer_verification + description: 'Specifies whether to verify the identity of the server when + + connecting over SSL. The default value is true.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: endpoint + isRequired: true + - name: username + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: password + isRequired: true + - name: use_encrypted_endpoints + isRequired: true + - name: use_host_verification + isRequired: true + - name: use_peer_verification + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.EloquaLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.EloquaLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.EloquaLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.EloquaLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.EloquaLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.EloquaLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.EloquaLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaObjectDataset.yml new file mode 100644 index 00000000..e554ffdd --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaObjectDataset.yml @@ -0,0 +1,202 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.EloquaObjectDataset +name: EloquaObjectDataset +fullName: azure.synapse.artifacts.models.EloquaObjectDataset +module: azure.synapse.artifacts.models +summary: 'Eloqua server dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'EloquaObjectDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.EloquaObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.EloquaObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.EloquaObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.EloquaObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.EloquaObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.EloquaObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.EloquaObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest.yml new file mode 100644 index 00000000..5625ee9c --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest.yml @@ -0,0 +1,153 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest +name: EvaluateDataFlowExpressionRequest +fullName: azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest +module: azure.synapse.artifacts.models +summary: Request body structure for data flow expression preview. +constructor: + syntax: 'EvaluateDataFlowExpressionRequest(*, session_id: str | None = None, data_flow_name: + str | None = None, stream_name: str | None = None, row_limits: int | None = None, + expression: str | None = None, **kwargs)' + parameters: + - name: session_id + description: The ID of data flow debug session. + isRequired: true + types: + - + - name: data_flow_name + description: The data flow which contains the debug session. + isRequired: true + types: + - + - name: stream_name + description: The output stream name. + isRequired: true + types: + - + - name: row_limits + description: The row limit for preview request. + isRequired: true + types: + - + - name: expression + description: The expression for preview. + isRequired: true + types: + - + keywordOnlyParameters: + - name: session_id + isRequired: true + - name: data_flow_name + isRequired: true + - name: stream_name + isRequired: true + - name: row_limits + isRequired: true + - name: expression + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EventSubscriptionStatus.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EventSubscriptionStatus.yml new file mode 100644 index 00000000..4b6ea377 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EventSubscriptionStatus.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.EventSubscriptionStatus +name: EventSubscriptionStatus +fullName: azure.synapse.artifacts.models.EventSubscriptionStatus +summary: Event Subscription Status. +module: azure.synapse.artifacts.models +fields: +- name: deprovisioning + uid: azure.synapse.artifacts.models.EventSubscriptionStatus.deprovisioning +- name: disabled + uid: azure.synapse.artifacts.models.EventSubscriptionStatus.disabled +- name: enabled + uid: azure.synapse.artifacts.models.EventSubscriptionStatus.enabled +- name: provisioning + uid: azure.synapse.artifacts.models.EventSubscriptionStatus.provisioning +- name: unknown + uid: azure.synapse.artifacts.models.EventSubscriptionStatus.unknown diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivity.yml new file mode 100644 index 00000000..f177102e --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivity.yml @@ -0,0 +1,209 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ExecuteDataFlowActivity +name: ExecuteDataFlowActivity +fullName: azure.synapse.artifacts.models.ExecuteDataFlowActivity +module: azure.synapse.artifacts.models +summary: 'Execute data flow activity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ExecuteDataFlowActivity(*, name: str, data_flow: DataFlowReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, linked_service_name: + LinkedServiceReference | None = None, policy: ActivityPolicy | None = None, staging: + DataFlowStagingInfo | None = None, integration_runtime: IntegrationRuntimeReference + | None = None, compute: ExecuteDataFlowActivityTypePropertiesCompute | None = + None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + - name: data_flow + description: Required. Data flow reference. + isRequired: true + types: + - + - name: staging + description: Staging info for execute data flow activity. + isRequired: true + types: + - + - name: integration_runtime + description: The integration runtime reference. + isRequired: true + types: + - + - name: compute + description: Compute properties for data flow activity. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: data_flow + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true + - name: staging + isRequired: true + - name: integration_runtime + isRequired: true + - name: compute + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ExecuteDataFlowActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ExecuteDataFlowActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ExecuteDataFlowActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ExecuteDataFlowActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ExecuteDataFlowActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ExecuteDataFlowActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ExecuteDataFlowActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute.yml new file mode 100644 index 00000000..140cb3c8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute +name: ExecuteDataFlowActivityTypePropertiesCompute +fullName: azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute +module: azure.synapse.artifacts.models +summary: Compute properties for data flow activity. +constructor: + syntax: 'ExecuteDataFlowActivityTypePropertiesCompute(*, compute_type: str | DataFlowComputeType + | None = None, core_count: int | None = None, **kwargs)' + parameters: + - name: compute_type + description: 'Compute type of the cluster which will execute data flow job. Possible + + values include: "General", "MemoryOptimized", "ComputeOptimized".' + isRequired: true + types: + - + - + - name: core_count + description: 'Core count of the cluster which will execute data flow job. Supported + values + + are: 8, 16, 32, 48, 80, 144 and 272.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: compute_type + isRequired: true + - name: core_count + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutePipelineActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutePipelineActivity.yml new file mode 100644 index 00000000..78c24818 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutePipelineActivity.yml @@ -0,0 +1,187 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ExecutePipelineActivity +name: ExecutePipelineActivity +fullName: azure.synapse.artifacts.models.ExecutePipelineActivity +module: azure.synapse.artifacts.models +summary: 'Execute pipeline activity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ExecutePipelineActivity(*, name: str, pipeline: PipelineReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, parameters: + Dict[str, object] | None = None, wait_on_completion: bool | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: pipeline + description: Required. Pipeline reference. + isRequired: true + types: + - + - name: parameters + description: Pipeline parameters. + isRequired: true + types: + - [, ] + - name: wait_on_completion + description: 'Defines whether activity execution will wait for the dependent + + pipeline execution to finish. Default is false.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: pipeline + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: parameters + isRequired: true + - name: wait_on_completion + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ExecutePipelineActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ExecutePipelineActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ExecutePipelineActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ExecutePipelineActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ExecutePipelineActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ExecutePipelineActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ExecutePipelineActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteSSISPackageActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteSSISPackageActivity.yml new file mode 100644 index 00000000..553ca1f3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteSSISPackageActivity.yml @@ -0,0 +1,281 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ExecuteSSISPackageActivity +name: ExecuteSSISPackageActivity +fullName: azure.synapse.artifacts.models.ExecuteSSISPackageActivity +module: azure.synapse.artifacts.models +summary: 'Execute SSIS package activity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ExecuteSSISPackageActivity(*, name: str, package_location: SSISPackageLocation, + connect_via: IntegrationRuntimeReference, additional_properties: Dict[str, object] + | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, linked_service_name: + LinkedServiceReference | None = None, policy: ActivityPolicy | None = None, runtime: + object | None = None, logging_level: object | None = None, environment_path: object + | None = None, execution_credential: SSISExecutionCredential | None = None, project_parameters: + Dict[str, SSISExecutionParameter] | None = None, package_parameters: Dict[str, + SSISExecutionParameter] | None = None, project_connection_managers: Dict[str, + object] | None = None, package_connection_managers: Dict[str, object] | None = + None, property_overrides: Dict[str, SSISPropertyOverride] | None = None, log_location: + SSISLogLocation | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + - name: package_location + description: Required. SSIS package location. + isRequired: true + types: + - + - name: runtime + description: 'Specifies the runtime to execute SSIS package. The value should + be "x86" or + + "x64". Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: logging_level + description: 'The logging level of SSIS package execution. Type: string (or Expression + + with resultType string).' + isRequired: true + types: + - + - name: environment_path + description: 'The environment path to execute the SSIS package. Type: string (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: execution_credential + description: The package execution credential. + isRequired: true + types: + - + - name: connect_via + description: Required. The integration runtime reference. + isRequired: true + types: + - + - name: project_parameters + description: The project level parameters to execute the SSIS package. + isRequired: true + types: + - [, ] + - name: package_parameters + description: The package level parameters to execute the SSIS package. + isRequired: true + types: + - [, ] + - name: project_connection_managers + description: 'The project level connection managers to execute the SSIS + + package.' + isRequired: true + types: + - [, ] + - name: package_connection_managers + description: 'The package level connection managers to execute the SSIS + + package.' + isRequired: true + types: + - [, ] + - name: property_overrides + description: The property overrides to execute the SSIS package. + isRequired: true + types: + - [, ] + - name: log_location + description: SSIS package execution log location. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: package_location + isRequired: true + - name: connect_via + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true + - name: runtime + isRequired: true + - name: logging_level + isRequired: true + - name: environment_path + isRequired: true + - name: execution_credential + isRequired: true + - name: project_parameters + isRequired: true + - name: package_parameters + isRequired: true + - name: project_connection_managers + isRequired: true + - name: package_connection_managers + isRequired: true + - name: property_overrides + isRequired: true + - name: log_location + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ExecuteSSISPackageActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ExecuteSSISPackageActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ExecuteSSISPackageActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ExecuteSSISPackageActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ExecuteSSISPackageActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ExecuteSSISPackageActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ExecuteSSISPackageActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutionActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutionActivity.yml new file mode 100644 index 00000000..c5f173c0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutionActivity.yml @@ -0,0 +1,189 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ExecutionActivity +name: ExecutionActivity +fullName: azure.synapse.artifacts.models.ExecutionActivity +module: azure.synapse.artifacts.models +summary: 'Base class for all execution activities. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: AzureDataExplorerCommandActivity, AzureFunctionActivity, AzureMLBatchExecutionActivity, + AzureMLExecutePipelineActivity, AzureMLUpdateResourceActivity, CopyActivity, CustomActivity, + DataLakeAnalyticsUSQLActivity, DatabricksNotebookActivity, DatabricksSparkJarActivity, + DatabricksSparkPythonActivity, DeleteActivity, ExecuteDataFlowActivity, ExecuteSSISPackageActivity, + GetMetadataActivity, HDInsightHiveActivity, HDInsightMapReduceActivity, HDInsightPigActivity, + HDInsightSparkActivity, HDInsightStreamingActivity, LookupActivity, SqlServerStoredProcedureActivity, + WebActivity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ExecutionActivity(*, name: str, additional_properties: Dict[str, object] + | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, linked_service_name: + LinkedServiceReference | None = None, policy: ActivityPolicy | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ExecutionActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ExecutionActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ExecutionActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ExecutionActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ExecutionActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ExecutionActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ExecutionActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExposureControlRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExposureControlRequest.yml new file mode 100644 index 00000000..c34e7e94 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExposureControlRequest.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ExposureControlRequest +name: ExposureControlRequest +fullName: azure.synapse.artifacts.models.ExposureControlRequest +module: azure.synapse.artifacts.models +summary: The exposure control request. +constructor: + syntax: 'ExposureControlRequest(*, feature_name: str | None = None, feature_type: + str | None = None, **kwargs)' + parameters: + - name: feature_name + description: The feature name. + isRequired: true + types: + - + - name: feature_type + description: The feature type. + isRequired: true + types: + - + keywordOnlyParameters: + - name: feature_name + isRequired: true + - name: feature_type + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ExposureControlRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ExposureControlRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ExposureControlRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ExposureControlRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ExposureControlRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ExposureControlRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ExposureControlRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExposureControlResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExposureControlResponse.yml new file mode 100644 index 00000000..a5d1ca1b --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExposureControlResponse.yml @@ -0,0 +1,126 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ExposureControlResponse +name: ExposureControlResponse +fullName: azure.synapse.artifacts.models.ExposureControlResponse +module: azure.synapse.artifacts.models +summary: 'The exposure control response. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: ExposureControlResponse(**kwargs) +variables: +- description: The feature name. + name: feature_name + types: + - +- description: The feature value. + name: value + types: + - +methods: +- uid: azure.synapse.artifacts.models.ExposureControlResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ExposureControlResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ExposureControlResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ExposureControlResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ExposureControlResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ExposureControlResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ExposureControlResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Expression.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Expression.yml new file mode 100644 index 00000000..bb6a4166 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Expression.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.Expression +name: Expression +fullName: azure.synapse.artifacts.models.Expression +module: azure.synapse.artifacts.models +summary: 'Azure Synapse expression definition. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Expression(*, value: str, **kwargs)' + parameters: + - name: value + description: Required. Expression value. + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true +variables: +- description: 'Required. Expression type. Default value: "Expression".' + name: type + types: + - +methods: +- uid: azure.synapse.artifacts.models.Expression.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Expression.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Expression.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.Expression.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Expression.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.Expression.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Expression.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +attributes: +- uid: azure.synapse.artifacts.models.Expression.type + name: type + signature: type = 'Expression' diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileServerLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileServerLinkedService.yml new file mode 100644 index 00000000..6d28acd0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileServerLinkedService.yml @@ -0,0 +1,204 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.FileServerLinkedService +name: FileServerLinkedService +fullName: azure.synapse.artifacts.models.FileServerLinkedService +module: azure.synapse.artifacts.models +summary: 'File system linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'FileServerLinkedService(*, host: object, additional_properties: Dict[str, + object] | None = None, connect_via: IntegrationRuntimeReference | None = None, + description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, user_id: object | None + = None, password: SecretBase | None = None, encrypted_credential: object | None + = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: host + description: 'Required. Host name of the server. Type: string (or Expression with + resultType + + string).' + isRequired: true + types: + - + - name: user_id + description: 'User ID to logon the server. Type: string (or Expression with resultType + + string).' + isRequired: true + types: + - + - name: password + description: Password to logon the server. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: host + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: user_id + isRequired: true + - name: password + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.FileServerLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.FileServerLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.FileServerLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.FileServerLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.FileServerLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.FileServerLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.FileServerLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FilterActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FilterActivity.yml new file mode 100644 index 00000000..3e4eec4a --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FilterActivity.yml @@ -0,0 +1,178 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.FilterActivity +name: FilterActivity +fullName: azure.synapse.artifacts.models.FilterActivity +module: azure.synapse.artifacts.models +summary: 'Filter and return results from input array based on the conditions. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'FilterActivity(*, name: str, items: Expression, condition: Expression, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, depends_on: List[ActivityDependency] | None = None, user_properties: List[UserProperty] + | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: items + description: Required. Input array on which filter should be applied. + isRequired: true + types: + - + - name: condition + description: Required. Condition to be used for filtering the input. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: items + isRequired: true + - name: condition + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.FilterActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.FilterActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.FilterActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.FilterActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.FilterActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.FilterActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.FilterActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ForEachActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ForEachActivity.yml new file mode 100644 index 00000000..e444fddd --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ForEachActivity.yml @@ -0,0 +1,196 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ForEachActivity +name: ForEachActivity +fullName: azure.synapse.artifacts.models.ForEachActivity +module: azure.synapse.artifacts.models +summary: 'This activity is used for iterating over a collection and execute given + activities. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ForEachActivity(*, name: str, items: Expression, activities: List[Activity], + additional_properties: Dict[str, object] | None = None, description: str | None + = None, depends_on: List[ActivityDependency] | None = None, user_properties: List[UserProperty] + | None = None, is_sequential: bool | None = None, batch_count: int | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: is_sequential + description: Should the loop be executed in sequence or in parallel (max 50). + isRequired: true + types: + - + - name: batch_count + description: 'Batch count to be used for controlling the number of parallel execution + + (when isSequential is set to false).' + isRequired: true + types: + - + - name: items + description: Required. Collection to iterate. + isRequired: true + types: + - + - name: activities + description: Required. List of activities to execute . + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: name + isRequired: true + - name: items + isRequired: true + - name: activities + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: is_sequential + isRequired: true + - name: batch_count + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ForEachActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ForEachActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ForEachActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ForEachActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ForEachActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ForEachActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ForEachActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpAuthenticationType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpAuthenticationType.yml new file mode 100644 index 00000000..72b41a74 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpAuthenticationType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.FtpAuthenticationType +name: FtpAuthenticationType +fullName: azure.synapse.artifacts.models.FtpAuthenticationType +summary: The authentication type to be used to connect to the FTP server. +module: azure.synapse.artifacts.models +fields: +- name: anonymous + uid: azure.synapse.artifacts.models.FtpAuthenticationType.anonymous +- name: basic + uid: azure.synapse.artifacts.models.FtpAuthenticationType.basic diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpServerLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpServerLinkedService.yml new file mode 100644 index 00000000..48bec8f1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpServerLinkedService.yml @@ -0,0 +1,250 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.FtpServerLinkedService +name: FtpServerLinkedService +fullName: azure.synapse.artifacts.models.FtpServerLinkedService +module: azure.synapse.artifacts.models +summary: 'A FTP server Linked Service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'FtpServerLinkedService(*, host: object, additional_properties: Dict[str, + object] | None = None, connect_via: IntegrationRuntimeReference | None = None, + description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, port: object | None = + None, authentication_type: str | FtpAuthenticationType | None = None, user_name: + object | None = None, password: SecretBase | None = None, encrypted_credential: + object | None = None, enable_ssl: object | None = None, enable_server_certificate_validation: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: host + description: 'Required. Host name of the FTP server. Type: string (or Expression + with resultType + + string).' + isRequired: true + types: + - + - name: port + description: 'The TCP port number that the FTP server uses to listen for client + connections. + + Default value is 21. Type: integer (or Expression with resultType integer), + minimum: 0.' + isRequired: true + types: + - + - name: authentication_type + description: 'The authentication type to be used to connect to the FTP server. + + Possible values include: "Basic", "Anonymous".' + isRequired: true + types: + - + - + - name: user_name + description: 'Username to logon the FTP server. Type: string (or Expression with + resultType + + string).' + isRequired: true + types: + - + - name: password + description: Password to logon the FTP server. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + - name: enable_ssl + description: 'If true, connect to the FTP server over SSL/TLS channel. Default + value is + + true. Type: boolean (or Expression with resultType boolean).' + isRequired: true + types: + - + - name: enable_server_certificate_validation + description: 'If true, validate the FTP server SSL certificate + + when connect over SSL/TLS channel. Default value is true. Type: boolean (or + Expression with + + resultType boolean).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: host + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: port + isRequired: true + - name: authentication_type + isRequired: true + - name: user_name + isRequired: true + - name: password + isRequired: true + - name: encrypted_credential + isRequired: true + - name: enable_ssl + isRequired: true + - name: enable_server_certificate_validation + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.FtpServerLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.FtpServerLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.FtpServerLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.FtpServerLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.FtpServerLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.FtpServerLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.FtpServerLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetMetadataActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetMetadataActivity.yml new file mode 100644 index 00000000..831ab99f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetMetadataActivity.yml @@ -0,0 +1,193 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.GetMetadataActivity +name: GetMetadataActivity +fullName: azure.synapse.artifacts.models.GetMetadataActivity +module: azure.synapse.artifacts.models +summary: 'Activity to get metadata of dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'GetMetadataActivity(*, name: str, dataset: DatasetReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, linked_service_name: + LinkedServiceReference | None = None, policy: ActivityPolicy | None = None, field_list: + List[object] | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + - name: dataset + description: Required. GetMetadata activity dataset reference. + isRequired: true + types: + - + - name: field_list + description: Fields of metadata to get from dataset. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: name + isRequired: true + - name: dataset + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true + - name: field_list + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.GetMetadataActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.GetMetadataActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.GetMetadataActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.GetMetadataActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.GetMetadataActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.GetMetadataActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.GetMetadataActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetSsisObjectMetadataRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetSsisObjectMetadataRequest.yml new file mode 100644 index 00000000..f6e0cabf --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetSsisObjectMetadataRequest.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.GetSsisObjectMetadataRequest +name: GetSsisObjectMetadataRequest +fullName: azure.synapse.artifacts.models.GetSsisObjectMetadataRequest +module: azure.synapse.artifacts.models +summary: The request payload of get SSIS object metadata. +constructor: + syntax: 'GetSsisObjectMetadataRequest(*, metadata_path: str | None = None, **kwargs)' + parameters: + - name: metadata_path + description: Metadata path. + isRequired: true + types: + - + keywordOnlyParameters: + - name: metadata_path + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.GetSsisObjectMetadataRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.GetSsisObjectMetadataRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.GetSsisObjectMetadataRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.GetSsisObjectMetadataRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.GetSsisObjectMetadataRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.GetSsisObjectMetadataRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.GetSsisObjectMetadataRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsAuthenticationType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsAuthenticationType.yml new file mode 100644 index 00000000..2a2fa5d9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsAuthenticationType.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.GoogleAdWordsAuthenticationType +name: GoogleAdWordsAuthenticationType +fullName: azure.synapse.artifacts.models.GoogleAdWordsAuthenticationType +summary: 'The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication + can only + + be used on self-hosted IR.' +module: azure.synapse.artifacts.models +fields: +- name: service_authentication + uid: azure.synapse.artifacts.models.GoogleAdWordsAuthenticationType.service_authentication +- name: user_authentication + uid: azure.synapse.artifacts.models.GoogleAdWordsAuthenticationType.user_authentication diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsLinkedService.yml new file mode 100644 index 00000000..00608e99 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsLinkedService.yml @@ -0,0 +1,286 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.GoogleAdWordsLinkedService +name: GoogleAdWordsLinkedService +fullName: azure.synapse.artifacts.models.GoogleAdWordsLinkedService +module: azure.synapse.artifacts.models +summary: 'Google AdWords service linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'GoogleAdWordsLinkedService(*, client_customer_id: object, developer_token: + SecretBase, authentication_type: str | GoogleAdWordsAuthenticationType, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, refresh_token: SecretBase + | None = None, client_id: object | None = None, client_secret: SecretBase | None + = None, email: object | None = None, key_file_path: object | None = None, trusted_cert_path: + object | None = None, use_system_trust_store: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: client_customer_id + description: 'Required. The Client customer ID of the AdWords account that you + + want to fetch report data for.' + isRequired: true + types: + - + - name: developer_token + description: 'Required. The developer token associated with the manager account + that + + you use to grant access to the AdWords API.' + isRequired: true + types: + - + - name: authentication_type + description: 'Required. The OAuth 2.0 authentication mechanism used for + + authentication. ServiceAuthentication can only be used on self-hosted IR. Possible + values + + include: "ServiceAuthentication", "UserAuthentication".' + isRequired: true + types: + - + - + - name: refresh_token + description: 'The refresh token obtained from Google for authorizing access to + AdWords + + for UserAuthentication.' + isRequired: true + types: + - + - name: client_id + description: 'The client id of the google application used to acquire the refresh + token. + + Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: client_secret + description: 'The client secret of the google application used to acquire the + refresh + + token.' + isRequired: true + types: + - + - name: email + description: 'The service account email ID that is used for ServiceAuthentication + and can only + + be used on self-hosted IR.' + isRequired: true + types: + - + - name: key_file_path + description: 'The full path to the .p12 key file that is used to authenticate + the + + service account email address and can only be used on self-hosted IR.' + isRequired: true + types: + - + - name: trusted_cert_path + description: 'The full path of the .pem file containing trusted CA certificates + for + + verifying the server when connecting over SSL. This property can only be set + when using SSL on + + self-hosted IR. The default value is the cacerts.pem file installed with the + IR.' + isRequired: true + types: + - + - name: use_system_trust_store + description: 'Specifies whether to use a CA certificate from the system trust + + store or from a specified PEM file. The default value is false.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: client_customer_id + isRequired: true + - name: developer_token + isRequired: true + - name: authentication_type + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: refresh_token + isRequired: true + - name: client_id + isRequired: true + - name: client_secret + isRequired: true + - name: email + isRequired: true + - name: key_file_path + isRequired: true + - name: trusted_cert_path + isRequired: true + - name: use_system_trust_store + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.GoogleAdWordsLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.GoogleAdWordsLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.GoogleAdWordsLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.GoogleAdWordsLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.GoogleAdWordsLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.GoogleAdWordsLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.GoogleAdWordsLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsObjectDataset.yml new file mode 100644 index 00000000..7b47af2d --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsObjectDataset.yml @@ -0,0 +1,203 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.GoogleAdWordsObjectDataset +name: GoogleAdWordsObjectDataset +fullName: azure.synapse.artifacts.models.GoogleAdWordsObjectDataset +module: azure.synapse.artifacts.models +summary: 'Google AdWords service dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'GoogleAdWordsObjectDataset(*, linked_service_name: LinkedServiceReference, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, structure: object | None = None, schema: object | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, folder: DatasetFolder | None = None, table_name: object | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.GoogleAdWordsObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.GoogleAdWordsObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.GoogleAdWordsObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.GoogleAdWordsObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.GoogleAdWordsObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.GoogleAdWordsObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.GoogleAdWordsObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryAuthenticationType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryAuthenticationType.yml new file mode 100644 index 00000000..6b6b7788 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryAuthenticationType.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.GoogleBigQueryAuthenticationType +name: GoogleBigQueryAuthenticationType +fullName: azure.synapse.artifacts.models.GoogleBigQueryAuthenticationType +summary: 'The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication + can only + + be used on self-hosted IR.' +module: azure.synapse.artifacts.models +fields: +- name: service_authentication + uid: azure.synapse.artifacts.models.GoogleBigQueryAuthenticationType.service_authentication +- name: user_authentication + uid: azure.synapse.artifacts.models.GoogleBigQueryAuthenticationType.user_authentication diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryLinkedService.yml new file mode 100644 index 00000000..d5dd2afb --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryLinkedService.yml @@ -0,0 +1,294 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.GoogleBigQueryLinkedService +name: GoogleBigQueryLinkedService +fullName: azure.synapse.artifacts.models.GoogleBigQueryLinkedService +module: azure.synapse.artifacts.models +summary: 'Google BigQuery service linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'GoogleBigQueryLinkedService(*, project: object, authentication_type: str + | GoogleBigQueryAuthenticationType, additional_properties: Dict[str, object] | + None = None, connect_via: IntegrationRuntimeReference | None = None, description: + str | None = None, parameters: Dict[str, ParameterSpecification] | None = None, + annotations: List[object] | None = None, additional_projects: object | None = + None, request_google_drive_scope: object | None = None, refresh_token: SecretBase + | None = None, client_id: object | None = None, client_secret: SecretBase | None + = None, email: object | None = None, key_file_path: object | None = None, trusted_cert_path: + object | None = None, use_system_trust_store: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: project + description: Required. The default BigQuery project to query against. + isRequired: true + types: + - + - name: additional_projects + description: A comma-separated list of public BigQuery projects to access. + isRequired: true + types: + - + - name: request_google_drive_scope + description: 'Whether to request access to Google Drive. Allowing Google + + Drive access enables support for federated tables that combine BigQuery data + with data from + + Google Drive. The default value is false.' + isRequired: true + types: + - + - name: authentication_type + description: 'Required. The OAuth 2.0 authentication mechanism used for + + authentication. ServiceAuthentication can only be used on self-hosted IR. Possible + values + + include: "ServiceAuthentication", "UserAuthentication".' + isRequired: true + types: + - + - + - name: refresh_token + description: 'The refresh token obtained from Google for authorizing access to + BigQuery + + for UserAuthentication.' + isRequired: true + types: + - + - name: client_id + description: 'The client id of the google application used to acquire the refresh + token. + + Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: client_secret + description: 'The client secret of the google application used to acquire the + refresh + + token.' + isRequired: true + types: + - + - name: email + description: 'The service account email ID that is used for ServiceAuthentication + and can only + + be used on self-hosted IR.' + isRequired: true + types: + - + - name: key_file_path + description: 'The full path to the .p12 key file that is used to authenticate + the + + service account email address and can only be used on self-hosted IR.' + isRequired: true + types: + - + - name: trusted_cert_path + description: 'The full path of the .pem file containing trusted CA certificates + for + + verifying the server when connecting over SSL. This property can only be set + when using SSL on + + self-hosted IR. The default value is the cacerts.pem file installed with the + IR.' + isRequired: true + types: + - + - name: use_system_trust_store + description: 'Specifies whether to use a CA certificate from the system trust + + store or from a specified PEM file. The default value is false.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: project + isRequired: true + - name: authentication_type + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: additional_projects + isRequired: true + - name: request_google_drive_scope + isRequired: true + - name: refresh_token + isRequired: true + - name: client_id + isRequired: true + - name: client_secret + isRequired: true + - name: email + isRequired: true + - name: key_file_path + isRequired: true + - name: trusted_cert_path + isRequired: true + - name: use_system_trust_store + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.GoogleBigQueryLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.GoogleBigQueryLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.GoogleBigQueryLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.GoogleBigQueryLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.GoogleBigQueryLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.GoogleBigQueryLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.GoogleBigQueryLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryObjectDataset.yml new file mode 100644 index 00000000..76cde782 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryObjectDataset.yml @@ -0,0 +1,226 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.GoogleBigQueryObjectDataset +name: GoogleBigQueryObjectDataset +fullName: azure.synapse.artifacts.models.GoogleBigQueryObjectDataset +module: azure.synapse.artifacts.models +summary: 'Google BigQuery service dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'GoogleBigQueryObjectDataset(*, linked_service_name: LinkedServiceReference, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, structure: object | None = None, schema: object | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, folder: DatasetFolder | None = None, table_name: object | None = None, + table: object | None = None, dataset: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'This property will be retired. Please consider using database + + table + + properties instead.' + isRequired: true + types: + - + - name: table + description: 'The table name of the Google BigQuery. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: dataset + description: 'The database name of the Google BigQuery. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true + - name: table + isRequired: true + - name: dataset + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.GoogleBigQueryObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.GoogleBigQueryObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.GoogleBigQueryObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.GoogleBigQueryObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.GoogleBigQueryObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.GoogleBigQueryObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.GoogleBigQueryObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleCloudStorageLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleCloudStorageLinkedService.yml new file mode 100644 index 00000000..1ead3429 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleCloudStorageLinkedService.yml @@ -0,0 +1,213 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.GoogleCloudStorageLinkedService +name: GoogleCloudStorageLinkedService +fullName: azure.synapse.artifacts.models.GoogleCloudStorageLinkedService +module: azure.synapse.artifacts.models +summary: 'Linked service for Google Cloud Storage. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'GoogleCloudStorageLinkedService(*, additional_properties: Dict[str, object] + | None = None, connect_via: IntegrationRuntimeReference | None = None, description: + str | None = None, parameters: Dict[str, ParameterSpecification] | None = None, + annotations: List[object] | None = None, access_key_id: object | None = None, + secret_access_key: SecretBase | None = None, service_url: object | None = None, + encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: access_key_id + description: 'The access key identifier of the Google Cloud Storage Identity and + Access + + Management (IAM) user. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: secret_access_key + description: 'The secret access key of the Google Cloud Storage Identity and Access + + Management (IAM) user.' + isRequired: true + types: + - + - name: service_url + description: 'This value specifies the endpoint to access with the Google Cloud + Storage + + Connector. This is an optional property; change it only if you want to try a + different service + + endpoint or want to switch between https and http. Type: string (or Expression + with resultType + + string).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: access_key_id + isRequired: true + - name: secret_access_key + isRequired: true + - name: service_url + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.GoogleCloudStorageLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.GoogleCloudStorageLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.GoogleCloudStorageLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.GoogleCloudStorageLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.GoogleCloudStorageLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.GoogleCloudStorageLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.GoogleCloudStorageLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumLinkedService.yml new file mode 100644 index 00000000..4f4d73f7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumLinkedService.yml @@ -0,0 +1,193 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.GreenplumLinkedService +name: GreenplumLinkedService +fullName: azure.synapse.artifacts.models.GreenplumLinkedService +module: azure.synapse.artifacts.models +summary: 'Greenplum Database linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'GreenplumLinkedService(*, additional_properties: Dict[str, object] | None + = None, connect_via: IntegrationRuntimeReference | None = None, description: str + | None = None, parameters: Dict[str, ParameterSpecification] | None = None, annotations: + List[object] | None = None, connection_string: object | None = None, pwd: AzureKeyVaultSecretReference + | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'An ODBC connection string. Type: string, SecureString or + + AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: pwd + description: The Azure key vault secret reference of password in connection string. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: connection_string + isRequired: true + - name: pwd + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.GreenplumLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.GreenplumLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.GreenplumLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.GreenplumLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.GreenplumLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.GreenplumLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.GreenplumLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumTableDataset.yml new file mode 100644 index 00000000..5e8e07dc --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumTableDataset.yml @@ -0,0 +1,222 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.GreenplumTableDataset +name: GreenplumTableDataset +fullName: azure.synapse.artifacts.models.GreenplumTableDataset +module: azure.synapse.artifacts.models +summary: 'Greenplum Database dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'GreenplumTableDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, table: object | None = None, + schema_type_properties_schema: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'This property will be retired. Please consider using schema + table + + properties instead.' + isRequired: true + types: + - + - name: table + description: 'The table name of Greenplum. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: schema_type_properties_schema + description: 'The schema name of Greenplum. Type: string (or Expression + + with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true + - name: table + isRequired: true + - name: schema_type_properties_schema + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.GreenplumTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.GreenplumTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.GreenplumTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.GreenplumTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.GreenplumTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.GreenplumTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.GreenplumTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseAuthenticationType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseAuthenticationType.yml new file mode 100644 index 00000000..d3b1fca8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseAuthenticationType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.HBaseAuthenticationType +name: HBaseAuthenticationType +fullName: azure.synapse.artifacts.models.HBaseAuthenticationType +summary: The authentication mechanism to use to connect to the HBase server. +module: azure.synapse.artifacts.models +fields: +- name: anonymous + uid: azure.synapse.artifacts.models.HBaseAuthenticationType.anonymous +- name: basic + uid: azure.synapse.artifacts.models.HBaseAuthenticationType.basic diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseLinkedService.yml new file mode 100644 index 00000000..15aa1cee --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseLinkedService.yml @@ -0,0 +1,274 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.HBaseLinkedService +name: HBaseLinkedService +fullName: azure.synapse.artifacts.models.HBaseLinkedService +module: azure.synapse.artifacts.models +summary: 'HBase server linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'HBaseLinkedService(*, host: object, authentication_type: str | HBaseAuthenticationType, + additional_properties: Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference + | None = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, port: object | None = + None, http_path: object | None = None, username: object | None = None, password: + SecretBase | None = None, enable_ssl: object | None = None, trusted_cert_path: + object | None = None, allow_host_name_cn_mismatch: object | None = None, allow_self_signed_server_cert: + object | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: host + description: Required. The IP address or host name of the HBase server. (i.e. + 192.168.222.160). + isRequired: true + types: + - + - name: port + description: 'The TCP port that the HBase instance uses to listen for client connections. + The + + default value is 9090.' + isRequired: true + types: + - + - name: http_path + description: 'The partial URL corresponding to the HBase server. (i.e. + + /gateway/sandbox/hbase/version).' + isRequired: true + types: + - + - name: authentication_type + description: 'Required. The authentication mechanism to use to connect to the + + HBase server. Possible values include: "Anonymous", "Basic".' + isRequired: true + types: + - + - + - name: username + description: The user name used to connect to the HBase instance. + isRequired: true + types: + - + - name: password + description: The password corresponding to the user name. + isRequired: true + types: + - + - name: enable_ssl + description: 'Specifies whether the connections to the server are encrypted using + SSL. The + + default value is false.' + isRequired: true + types: + - + - name: trusted_cert_path + description: 'The full path of the .pem file containing trusted CA certificates + for + + verifying the server when connecting over SSL. This property can only be set + when using SSL on + + self-hosted IR. The default value is the cacerts.pem file installed with the + IR.' + isRequired: true + types: + - + - name: allow_host_name_cn_mismatch + description: 'Specifies whether to require a CA-issued SSL certificate + + name to match the host name of the server when connecting over SSL. The default + value is false.' + isRequired: true + types: + - + - name: allow_self_signed_server_cert + description: 'Specifies whether to allow self-signed certificates from + + the server. The default value is false.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: host + isRequired: true + - name: authentication_type + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: port + isRequired: true + - name: http_path + isRequired: true + - name: username + isRequired: true + - name: password + isRequired: true + - name: enable_ssl + isRequired: true + - name: trusted_cert_path + isRequired: true + - name: allow_host_name_cn_mismatch + isRequired: true + - name: allow_self_signed_server_cert + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.HBaseLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HBaseLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HBaseLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.HBaseLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HBaseLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.HBaseLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HBaseLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseObjectDataset.yml new file mode 100644 index 00000000..e052e9cf --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseObjectDataset.yml @@ -0,0 +1,202 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.HBaseObjectDataset +name: HBaseObjectDataset +fullName: azure.synapse.artifacts.models.HBaseObjectDataset +module: azure.synapse.artifacts.models +summary: 'HBase server dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'HBaseObjectDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.HBaseObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HBaseObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HBaseObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.HBaseObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HBaseObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.HBaseObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HBaseObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption.yml new file mode 100644 index 00000000..fd5ac563 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption +name: HDInsightActivityDebugInfoOption +fullName: azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption +summary: The HDInsightActivityDebugInfoOption settings to use. +module: azure.synapse.artifacts.models +fields: +- name: always + uid: azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption.always +- name: failure + uid: azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption.failure +- name: none + uid: azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption.none diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightHiveActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightHiveActivity.yml new file mode 100644 index 00000000..65d3d9bc --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightHiveActivity.yml @@ -0,0 +1,243 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.HDInsightHiveActivity +name: HDInsightHiveActivity +fullName: azure.synapse.artifacts.models.HDInsightHiveActivity +module: azure.synapse.artifacts.models +summary: 'HDInsight Hive activity type. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'HDInsightHiveActivity(*, name: str, additional_properties: Dict[str, object] + | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, linked_service_name: + LinkedServiceReference | None = None, policy: ActivityPolicy | None = None, storage_linked_services: + List[LinkedServiceReference] | None = None, arguments: List[object] | None = None, + get_debug_info: str | HDInsightActivityDebugInfoOption | None = None, script_path: + object | None = None, script_linked_service: LinkedServiceReference | None = None, + defines: Dict[str, object] | None = None, variables: List[object] | None = None, + query_timeout: int | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + - name: storage_linked_services + description: Storage linked service references. + isRequired: true + types: + - [] + - name: arguments + description: User specified arguments to HDInsightActivity. + isRequired: true + types: + - [] + - name: get_debug_info + description: 'Debug info option. Possible values include: "None", "Always", "Failure".' + isRequired: true + types: + - + - + - name: script_path + description: 'Script path. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: script_linked_service + description: Script linked service reference. + isRequired: true + types: + - + - name: defines + description: Allows user to specify defines for Hive job request. + isRequired: true + types: + - [, ] + - name: variables + description: User specified arguments under hivevar namespace. + isRequired: true + types: + - [] + - name: query_timeout + description: 'Query timeout value (in minutes). Effective when the HDInsight + cluster + + is with ESP (Enterprise Security Package).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true + - name: storage_linked_services + isRequired: true + - name: arguments + isRequired: true + - name: get_debug_info + isRequired: true + - name: script_path + isRequired: true + - name: script_linked_service + isRequired: true + - name: defines + isRequired: true + - name: variables + isRequired: true + - name: query_timeout + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.HDInsightHiveActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HDInsightHiveActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HDInsightHiveActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.HDInsightHiveActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HDInsightHiveActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.HDInsightHiveActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HDInsightHiveActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightLinkedService.yml new file mode 100644 index 00000000..ab27e28d --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightLinkedService.yml @@ -0,0 +1,240 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.HDInsightLinkedService +name: HDInsightLinkedService +fullName: azure.synapse.artifacts.models.HDInsightLinkedService +module: azure.synapse.artifacts.models +summary: 'HDInsight linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'HDInsightLinkedService(*, cluster_uri: object, additional_properties: Dict[str, + object] | None = None, connect_via: IntegrationRuntimeReference | None = None, + description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, user_name: object | None + = None, password: SecretBase | None = None, linked_service_name: LinkedServiceReference + | None = None, hcatalog_linked_service_name: LinkedServiceReference | None = None, + encrypted_credential: object | None = None, is_esp_enabled: object | None = None, + file_system: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: cluster_uri + description: 'Required. HDInsight cluster URI. Type: string (or Expression with + + resultType string).' + isRequired: true + types: + - + - name: user_name + description: 'HDInsight cluster user name. Type: string (or Expression with resultType + + string).' + isRequired: true + types: + - + - name: password + description: HDInsight cluster password. + isRequired: true + types: + - + - name: linked_service_name + description: The Azure Storage linked service reference. + isRequired: true + types: + - + - name: hcatalog_linked_service_name + description: 'A reference to the Azure SQL linked service that points to + + the HCatalog database.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + - name: is_esp_enabled + description: 'Specify if the HDInsight is created with ESP (Enterprise Security + + Package). Type: Boolean.' + isRequired: true + types: + - + - name: file_system + description: 'Specify the FileSystem if the main storage for the HDInsight is + ADLS Gen2. + + Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cluster_uri + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: user_name + isRequired: true + - name: password + isRequired: true + - name: linked_service_name + isRequired: true + - name: hcatalog_linked_service_name + isRequired: true + - name: encrypted_credential + isRequired: true + - name: is_esp_enabled + isRequired: true + - name: file_system + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.HDInsightLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HDInsightLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HDInsightLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.HDInsightLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HDInsightLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.HDInsightLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HDInsightLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightMapReduceActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightMapReduceActivity.yml new file mode 100644 index 00000000..551c78e0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightMapReduceActivity.yml @@ -0,0 +1,242 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.HDInsightMapReduceActivity +name: HDInsightMapReduceActivity +fullName: azure.synapse.artifacts.models.HDInsightMapReduceActivity +module: azure.synapse.artifacts.models +summary: 'HDInsight MapReduce activity type. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'HDInsightMapReduceActivity(*, name: str, class_name: object, jar_file_path: + object, additional_properties: Dict[str, object] | None = None, description: str + | None = None, depends_on: List[ActivityDependency] | None = None, user_properties: + List[UserProperty] | None = None, linked_service_name: LinkedServiceReference + | None = None, policy: ActivityPolicy | None = None, storage_linked_services: + List[LinkedServiceReference] | None = None, arguments: List[object] | None = None, + get_debug_info: str | HDInsightActivityDebugInfoOption | None = None, jar_linked_service: + LinkedServiceReference | None = None, jar_libs: List[object] | None = None, defines: + Dict[str, object] | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + - name: storage_linked_services + description: Storage linked service references. + isRequired: true + types: + - [] + - name: arguments + description: User specified arguments to HDInsightActivity. + isRequired: true + types: + - [] + - name: get_debug_info + description: 'Debug info option. Possible values include: "None", "Always", "Failure".' + isRequired: true + types: + - + - + - name: class_name + description: 'Required. Class name. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: jar_file_path + description: 'Required. Jar path. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: jar_linked_service + description: Jar linked service reference. + isRequired: true + types: + - + - name: jar_libs + description: Jar libs. + isRequired: true + types: + - [] + - name: defines + description: Allows user to specify defines for the MapReduce job request. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: name + isRequired: true + - name: class_name + isRequired: true + - name: jar_file_path + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true + - name: storage_linked_services + isRequired: true + - name: arguments + isRequired: true + - name: get_debug_info + isRequired: true + - name: jar_linked_service + isRequired: true + - name: jar_libs + isRequired: true + - name: defines + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.HDInsightMapReduceActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HDInsightMapReduceActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HDInsightMapReduceActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.HDInsightMapReduceActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HDInsightMapReduceActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.HDInsightMapReduceActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HDInsightMapReduceActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightOnDemandLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightOnDemandLinkedService.yml new file mode 100644 index 00000000..51cd06e2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightOnDemandLinkedService.yml @@ -0,0 +1,490 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.HDInsightOnDemandLinkedService +name: HDInsightOnDemandLinkedService +fullName: azure.synapse.artifacts.models.HDInsightOnDemandLinkedService +module: azure.synapse.artifacts.models +summary: 'HDInsight ondemand linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'HDInsightOnDemandLinkedService(*, cluster_size: object, time_to_live: object, + version: object, linked_service_name: LinkedServiceReference, host_subscription_id: + object, tenant: object, cluster_resource_group: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, service_principal_id: + object | None = None, service_principal_key: SecretBase | None = None, cluster_name_prefix: + object | None = None, cluster_user_name: object | None = None, cluster_password: + SecretBase | None = None, cluster_ssh_user_name: object | None = None, cluster_ssh_password: + SecretBase | None = None, additional_linked_service_names: List[LinkedServiceReference] + | None = None, hcatalog_linked_service_name: LinkedServiceReference | None = None, + cluster_type: object | None = None, spark_version: object | None = None, core_configuration: + object | None = None, h_base_configuration: object | None = None, hdfs_configuration: + object | None = None, hive_configuration: object | None = None, map_reduce_configuration: + object | None = None, oozie_configuration: object | None = None, storm_configuration: + object | None = None, yarn_configuration: object | None = None, encrypted_credential: + object | None = None, head_node_size: object | None = None, data_node_size: object + | None = None, zookeeper_node_size: object | None = None, script_actions: List[ScriptAction] + | None = None, virtual_network_id: object | None = None, subnet_name: object | + None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: cluster_size + description: 'Required. Number of worker/data nodes in the cluster. Suggestion + value: 4. + + Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: time_to_live + description: 'Required. The allowed idle time for the on-demand HDInsight cluster. + + Specifies how long the on-demand HDInsight cluster stays alive after completion + of an activity + + run if there are no other active jobs in the cluster. The minimum value is 5 + mins. Type: string + + (or Expression with resultType string).' + isRequired: true + types: + - + - name: version + description: "Required. Version of the HDInsight cluster.\_ Type: string (or Expression\ + \ with\nresultType string)." + isRequired: true + types: + - + - name: linked_service_name + description: 'Required. Azure Storage linked service to be used by the on-demand + + cluster for storing and processing data.' + isRequired: true + types: + - + - name: host_subscription_id + description: 'Required. The customer''s subscription to host the cluster. Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: service_principal_id + description: 'The service principal id for the hostSubscriptionId. Type: string + + (or Expression with resultType string).' + isRequired: true + types: + - + - name: service_principal_key + description: The key for the service principal id. + isRequired: true + types: + - + - name: tenant + description: 'Required. The Tenant id/name to which the service principal belongs. + Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: cluster_resource_group + description: 'Required. The resource group where the cluster belongs. Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: cluster_name_prefix + description: 'The prefix of cluster name, postfix will be distinct with + + timestamp. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: cluster_user_name + description: 'The username to access the cluster. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: cluster_password + description: The password to access the cluster. + isRequired: true + types: + - + - name: cluster_ssh_user_name + description: 'The username to SSH remotely connect to cluster''s node (for + + Linux). Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: cluster_ssh_password + description: The password to SSH remotely connect cluster's node (for Linux). + isRequired: true + types: + - + - name: additional_linked_service_names + description: 'Specifies additional storage accounts for the HDInsight + + linked service so that the Data Factory service can register them on your behalf.' + isRequired: true + types: + - [] + - name: hcatalog_linked_service_name + description: 'The name of Azure SQL linked service that point to the + + HCatalog database. The on-demand HDInsight cluster is created by using the Azure + SQL database + + as the metastore.' + isRequired: true + types: + - + - name: cluster_type + description: 'The cluster type. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: spark_version + description: 'The version of spark if the cluster type is ''spark''. Type: string + (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: core_configuration + description: 'Specifies the core configuration parameters (as in core-site.xml) + + for the HDInsight cluster to be created.' + isRequired: true + types: + - + - name: h_base_configuration + description: 'Specifies the HBase configuration parameters (hbase-site.xml) for + + the HDInsight cluster.' + isRequired: true + types: + - + - name: hdfs_configuration + description: 'Specifies the HDFS configuration parameters (hdfs-site.xml) for + the + + HDInsight cluster.' + isRequired: true + types: + - + - name: hive_configuration + description: 'Specifies the hive configuration parameters (hive-site.xml) for + the + + HDInsight cluster.' + isRequired: true + types: + - + - name: map_reduce_configuration + description: 'Specifies the MapReduce configuration parameters (mapred- + + site.xml) for the HDInsight cluster.' + isRequired: true + types: + - + - name: oozie_configuration + description: 'Specifies the Oozie configuration parameters (oozie-site.xml) for + + the HDInsight cluster.' + isRequired: true + types: + - + - name: storm_configuration + description: 'Specifies the Storm configuration parameters (storm-site.xml) for + + the HDInsight cluster.' + isRequired: true + types: + - + - name: yarn_configuration + description: 'Specifies the Yarn configuration parameters (yarn-site.xml) for + the + + HDInsight cluster.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + - name: head_node_size + description: Specifies the size of the head node for the HDInsight cluster. + isRequired: true + types: + - + - name: data_node_size + description: Specifies the size of the data node for the HDInsight cluster. + isRequired: true + types: + - + - name: zookeeper_node_size + description: 'Specifies the size of the Zoo Keeper node for the HDInsight + + cluster.' + isRequired: true + types: + - + - name: script_actions + description: 'Custom script actions to run on HDI ondemand cluster once it''s + up. + + Please refer to [https://docs.microsoft.com/en-us/azure/hdinsight/hdinsight-hadoop-customize](https://docs.microsoft.com/en-us/azure/hdinsight/hdinsight-hadoop-customize)- + + cluster-linux?toc=%2Fen-us%2Fazure%2Fhdinsight%2Fr-server%2FTOC.json&bc=%2Fen- + + us%2Fazure%2Fbread%2Ftoc.json#understanding-script-actions.' + isRequired: true + types: + - [] + - name: virtual_network_id + description: 'The ARM resource ID for the vNet to which the cluster should be + + joined after creation. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: subnet_name + description: 'The ARM resource ID for the subnet in the vNet. If virtualNetworkId + was + + specified, then this property is required. Type: string (or Expression with + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: cluster_size + isRequired: true + - name: time_to_live + isRequired: true + - name: version + isRequired: true + - name: linked_service_name + isRequired: true + - name: host_subscription_id + isRequired: true + - name: tenant + isRequired: true + - name: cluster_resource_group + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: service_principal_id + isRequired: true + - name: service_principal_key + isRequired: true + - name: cluster_name_prefix + isRequired: true + - name: cluster_user_name + isRequired: true + - name: cluster_password + isRequired: true + - name: cluster_ssh_user_name + isRequired: true + - name: cluster_ssh_password + isRequired: true + - name: additional_linked_service_names + isRequired: true + - name: hcatalog_linked_service_name + isRequired: true + - name: cluster_type + isRequired: true + - name: spark_version + isRequired: true + - name: core_configuration + isRequired: true + - name: h_base_configuration + isRequired: true + - name: hdfs_configuration + isRequired: true + - name: hive_configuration + isRequired: true + - name: map_reduce_configuration + isRequired: true + - name: oozie_configuration + isRequired: true + - name: storm_configuration + isRequired: true + - name: yarn_configuration + isRequired: true + - name: encrypted_credential + isRequired: true + - name: head_node_size + isRequired: true + - name: data_node_size + isRequired: true + - name: zookeeper_node_size + isRequired: true + - name: script_actions + isRequired: true + - name: virtual_network_id + isRequired: true + - name: subnet_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.HDInsightOnDemandLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HDInsightOnDemandLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HDInsightOnDemandLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.HDInsightOnDemandLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HDInsightOnDemandLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.HDInsightOnDemandLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HDInsightOnDemandLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightPigActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightPigActivity.yml new file mode 100644 index 00000000..00329241 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightPigActivity.yml @@ -0,0 +1,227 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.HDInsightPigActivity +name: HDInsightPigActivity +fullName: azure.synapse.artifacts.models.HDInsightPigActivity +module: azure.synapse.artifacts.models +summary: 'HDInsight Pig activity type. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'HDInsightPigActivity(*, name: str, additional_properties: Dict[str, object] + | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, linked_service_name: + LinkedServiceReference | None = None, policy: ActivityPolicy | None = None, storage_linked_services: + List[LinkedServiceReference] | None = None, arguments: object | None = None, get_debug_info: + str | HDInsightActivityDebugInfoOption | None = None, script_path: object | None + = None, script_linked_service: LinkedServiceReference | None = None, defines: + Dict[str, object] | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + - name: storage_linked_services + description: Storage linked service references. + isRequired: true + types: + - [] + - name: arguments + description: 'User specified arguments to HDInsightActivity. Type: array (or Expression + + with resultType array).' + isRequired: true + types: + - + - name: get_debug_info + description: 'Debug info option. Possible values include: "None", "Always", "Failure".' + isRequired: true + types: + - + - + - name: script_path + description: 'Script path. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: script_linked_service + description: Script linked service reference. + isRequired: true + types: + - + - name: defines + description: Allows user to specify defines for Pig job request. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true + - name: storage_linked_services + isRequired: true + - name: arguments + isRequired: true + - name: get_debug_info + isRequired: true + - name: script_path + isRequired: true + - name: script_linked_service + isRequired: true + - name: defines + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.HDInsightPigActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HDInsightPigActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HDInsightPigActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.HDInsightPigActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HDInsightPigActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.HDInsightPigActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HDInsightPigActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightSparkActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightSparkActivity.yml new file mode 100644 index 00000000..d2b89847 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightSparkActivity.yml @@ -0,0 +1,251 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.HDInsightSparkActivity +name: HDInsightSparkActivity +fullName: azure.synapse.artifacts.models.HDInsightSparkActivity +module: azure.synapse.artifacts.models +summary: 'HDInsight Spark activity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'HDInsightSparkActivity(*, name: str, root_path: object, entry_file_path: + object, additional_properties: Dict[str, object] | None = None, description: str + | None = None, depends_on: List[ActivityDependency] | None = None, user_properties: + List[UserProperty] | None = None, linked_service_name: LinkedServiceReference + | None = None, policy: ActivityPolicy | None = None, arguments: List[object] | + None = None, get_debug_info: str | HDInsightActivityDebugInfoOption | None = None, + spark_job_linked_service: LinkedServiceReference | None = None, class_name: str + | None = None, proxy_user: object | None = None, spark_config: Dict[str, object] + | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + - name: root_path + description: 'Required. The root path in ''sparkJobLinkedService'' for all the + job''s files. + + Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: entry_file_path + description: 'Required. The relative path to the root folder of the code/package + to + + be executed. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: arguments + description: The user-specified arguments to HDInsightSparkActivity. + isRequired: true + types: + - [] + - name: get_debug_info + description: 'Debug info option. Possible values include: "None", "Always", "Failure".' + isRequired: true + types: + - + - + - name: spark_job_linked_service + description: 'The storage linked service for uploading the entry file and + + dependencies, and for receiving logs.' + isRequired: true + types: + - + - name: class_name + description: The application's Java/Spark main class. + isRequired: true + types: + - + - name: proxy_user + description: 'The user to impersonate that will execute the job. Type: string + (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: spark_config + description: Spark configuration property. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: name + isRequired: true + - name: root_path + isRequired: true + - name: entry_file_path + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true + - name: arguments + isRequired: true + - name: get_debug_info + isRequired: true + - name: spark_job_linked_service + isRequired: true + - name: class_name + isRequired: true + - name: proxy_user + isRequired: true + - name: spark_config + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.HDInsightSparkActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HDInsightSparkActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HDInsightSparkActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.HDInsightSparkActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HDInsightSparkActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.HDInsightSparkActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HDInsightSparkActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightStreamingActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightStreamingActivity.yml new file mode 100644 index 00000000..02d50426 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightStreamingActivity.yml @@ -0,0 +1,277 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.HDInsightStreamingActivity +name: HDInsightStreamingActivity +fullName: azure.synapse.artifacts.models.HDInsightStreamingActivity +module: azure.synapse.artifacts.models +summary: 'HDInsight streaming activity type. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'HDInsightStreamingActivity(*, name: str, mapper: object, reducer: object, + input: object, output: object, file_paths: List[object], additional_properties: + Dict[str, object] | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, linked_service_name: + LinkedServiceReference | None = None, policy: ActivityPolicy | None = None, storage_linked_services: + List[LinkedServiceReference] | None = None, arguments: List[object] | None = None, + get_debug_info: str | HDInsightActivityDebugInfoOption | None = None, file_linked_service: + LinkedServiceReference | None = None, combiner: object | None = None, command_environment: + List[object] | None = None, defines: Dict[str, object] | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + - name: storage_linked_services + description: Storage linked service references. + isRequired: true + types: + - [] + - name: arguments + description: User specified arguments to HDInsightActivity. + isRequired: true + types: + - [] + - name: get_debug_info + description: 'Debug info option. Possible values include: "None", "Always", "Failure".' + isRequired: true + types: + - + - + - name: mapper + description: 'Required. Mapper executable name. Type: string (or Expression with + resultType + + string).' + isRequired: true + types: + - + - name: reducer + description: 'Required. Reducer executable name. Type: string (or Expression with + resultType + + string).' + isRequired: true + types: + - + - name: input + description: 'Required. Input blob path. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: output + description: 'Required. Output blob path. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: file_paths + description: Required. Paths to streaming job files. Can be directories. + isRequired: true + types: + - [] + - name: file_linked_service + description: Linked service reference where the files are located. + isRequired: true + types: + - + - name: combiner + description: 'Combiner executable name. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: command_environment + description: Command line environment values. + isRequired: true + types: + - [] + - name: defines + description: Allows user to specify defines for streaming job request. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: name + isRequired: true + - name: mapper + isRequired: true + - name: reducer + isRequired: true + - name: input + isRequired: true + - name: output + isRequired: true + - name: file_paths + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true + - name: storage_linked_services + isRequired: true + - name: arguments + isRequired: true + - name: get_debug_info + isRequired: true + - name: file_linked_service + isRequired: true + - name: combiner + isRequired: true + - name: command_environment + isRequired: true + - name: defines + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.HDInsightStreamingActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HDInsightStreamingActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HDInsightStreamingActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.HDInsightStreamingActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HDInsightStreamingActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.HDInsightStreamingActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HDInsightStreamingActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdfsLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdfsLinkedService.yml new file mode 100644 index 00000000..c34c919a --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdfsLinkedService.yml @@ -0,0 +1,214 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.HdfsLinkedService +name: HdfsLinkedService +fullName: azure.synapse.artifacts.models.HdfsLinkedService +module: azure.synapse.artifacts.models +summary: 'Hadoop Distributed File System (HDFS) linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'HdfsLinkedService(*, url: object, additional_properties: Dict[str, object] + | None = None, connect_via: IntegrationRuntimeReference | None = None, description: + str | None = None, parameters: Dict[str, ParameterSpecification] | None = None, + annotations: List[object] | None = None, authentication_type: object | None = + None, encrypted_credential: object | None = None, user_name: object | None = None, + password: SecretBase | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: url + description: 'Required. The URL of the HDFS service endpoint, e.g. + + [http://myhostname:50070/webhdfs/v1](http://myhostname:50070/webhdfs/v1) . Type: + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: authentication_type + description: 'Type of authentication used to connect to the HDFS. Possible values + + are: Anonymous and Windows. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + - name: user_name + description: 'User name for Windows authentication. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: password + description: Password for Windows authentication. + isRequired: true + types: + - + keywordOnlyParameters: + - name: url + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: authentication_type + isRequired: true + - name: encrypted_credential + isRequired: true + - name: user_name + isRequired: true + - name: password + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.HdfsLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HdfsLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HdfsLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.HdfsLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HdfsLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.HdfsLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HdfsLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdiNodeTypes.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdiNodeTypes.yml new file mode 100644 index 00000000..9cd39cd5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdiNodeTypes.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.HdiNodeTypes +name: HdiNodeTypes +fullName: azure.synapse.artifacts.models.HdiNodeTypes +summary: The node types on which the script action should be executed. +module: azure.synapse.artifacts.models +fields: +- name: headnode + uid: azure.synapse.artifacts.models.HdiNodeTypes.headnode +- name: workernode + uid: azure.synapse.artifacts.models.HdiNodeTypes.workernode +- name: zookeeper + uid: azure.synapse.artifacts.models.HdiNodeTypes.zookeeper diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveAuthenticationType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveAuthenticationType.yml new file mode 100644 index 00000000..7a2209cc --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveAuthenticationType.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.HiveAuthenticationType +name: HiveAuthenticationType +fullName: azure.synapse.artifacts.models.HiveAuthenticationType +summary: The authentication method used to access the Hive server. +module: azure.synapse.artifacts.models +fields: +- name: anonymous + uid: azure.synapse.artifacts.models.HiveAuthenticationType.anonymous +- name: username + uid: azure.synapse.artifacts.models.HiveAuthenticationType.username +- name: username_and_password + uid: azure.synapse.artifacts.models.HiveAuthenticationType.username_and_password +- name: windows_azure_hd_insight_service + uid: azure.synapse.artifacts.models.HiveAuthenticationType.windows_azure_hd_insight_service diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveLinkedService.yml new file mode 100644 index 00000000..8f93696f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveLinkedService.yml @@ -0,0 +1,334 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.HiveLinkedService +name: HiveLinkedService +fullName: azure.synapse.artifacts.models.HiveLinkedService +module: azure.synapse.artifacts.models +summary: 'Hive Server linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'HiveLinkedService(*, host: object, authentication_type: str | HiveAuthenticationType, + additional_properties: Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference + | None = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, port: object | None = + None, server_type: str | HiveServerType | None = None, thrift_transport_protocol: + str | HiveThriftTransportProtocol | None = None, service_discovery_mode: object + | None = None, zoo_keeper_name_space: object | None = None, use_native_query: + object | None = None, username: object | None = None, password: SecretBase | None + = None, http_path: object | None = None, enable_ssl: object | None = None, trusted_cert_path: + object | None = None, use_system_trust_store: object | None = None, allow_host_name_cn_mismatch: + object | None = None, allow_self_signed_server_cert: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: host + description: 'Required. IP address or host name of the Hive server, separated + by '';'' for + + multiple hosts (only when serviceDiscoveryMode is enable).' + isRequired: true + types: + - + - name: port + description: The TCP port that the Hive server uses to listen for client connections. + isRequired: true + types: + - + - name: server_type + description: 'The type of Hive server. Possible values include: "HiveServer1", + + "HiveServer2", "HiveThriftServer".' + isRequired: true + types: + - + - + - name: thrift_transport_protocol + description: 'The transport protocol to use in the Thrift layer. Possible + + values include: "Binary", "SASL", "HTTP ".' + isRequired: true + types: + - + - + - name: authentication_type + description: 'Required. The authentication method used to access the Hive server. + + Possible values include: "Anonymous", "Username", "UsernameAndPassword", + + "WindowsAzureHDInsightService".' + isRequired: true + types: + - + - + - name: service_discovery_mode + description: true to indicate using the ZooKeeper service, false not. + isRequired: true + types: + - + - name: zoo_keeper_name_space + description: 'The namespace on ZooKeeper under which Hive Server 2 nodes are + + added.' + isRequired: true + types: + - + - name: use_native_query + description: 'Specifies whether the driver uses native HiveQL queries,or converts + + them into an equivalent form in HiveQL.' + isRequired: true + types: + - + - name: username + description: The user name that you use to access Hive Server. + isRequired: true + types: + - + - name: password + description: 'The password corresponding to the user name that you provided in + the Username + + field.' + isRequired: true + types: + - + - name: http_path + description: The partial URL corresponding to the Hive server. + isRequired: true + types: + - + - name: enable_ssl + description: 'Specifies whether the connections to the server are encrypted using + SSL. The + + default value is false.' + isRequired: true + types: + - + - name: trusted_cert_path + description: 'The full path of the .pem file containing trusted CA certificates + for + + verifying the server when connecting over SSL. This property can only be set + when using SSL on + + self-hosted IR. The default value is the cacerts.pem file installed with the + IR.' + isRequired: true + types: + - + - name: use_system_trust_store + description: 'Specifies whether to use a CA certificate from the system trust + + store or from a specified PEM file. The default value is false.' + isRequired: true + types: + - + - name: allow_host_name_cn_mismatch + description: 'Specifies whether to require a CA-issued SSL certificate + + name to match the host name of the server when connecting over SSL. The default + value is false.' + isRequired: true + types: + - + - name: allow_self_signed_server_cert + description: 'Specifies whether to allow self-signed certificates from + + the server. The default value is false.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: host + isRequired: true + - name: authentication_type + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: port + isRequired: true + - name: server_type + isRequired: true + - name: thrift_transport_protocol + isRequired: true + - name: service_discovery_mode + isRequired: true + - name: zoo_keeper_name_space + isRequired: true + - name: use_native_query + isRequired: true + - name: username + isRequired: true + - name: password + isRequired: true + - name: http_path + isRequired: true + - name: enable_ssl + isRequired: true + - name: trusted_cert_path + isRequired: true + - name: use_system_trust_store + isRequired: true + - name: allow_host_name_cn_mismatch + isRequired: true + - name: allow_self_signed_server_cert + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.HiveLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HiveLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HiveLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.HiveLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HiveLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.HiveLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HiveLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveObjectDataset.yml new file mode 100644 index 00000000..44c59e13 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveObjectDataset.yml @@ -0,0 +1,222 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.HiveObjectDataset +name: HiveObjectDataset +fullName: azure.synapse.artifacts.models.HiveObjectDataset +module: azure.synapse.artifacts.models +summary: 'Hive Server dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'HiveObjectDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, table: object | None = None, + schema_type_properties_schema: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'This property will be retired. Please consider using schema + table + + properties instead.' + isRequired: true + types: + - + - name: table + description: 'The table name of the Hive. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: schema_type_properties_schema + description: 'The schema name of the Hive. Type: string (or Expression + + with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true + - name: table + isRequired: true + - name: schema_type_properties_schema + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.HiveObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HiveObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HiveObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.HiveObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HiveObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.HiveObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HiveObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveServerType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveServerType.yml new file mode 100644 index 00000000..4200306f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveServerType.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.HiveServerType +name: HiveServerType +fullName: azure.synapse.artifacts.models.HiveServerType +summary: The type of Hive server. +module: azure.synapse.artifacts.models +fields: +- name: hive_server1 + uid: azure.synapse.artifacts.models.HiveServerType.hive_server1 +- name: hive_server2 + uid: azure.synapse.artifacts.models.HiveServerType.hive_server2 +- name: hive_thrift_server + uid: azure.synapse.artifacts.models.HiveServerType.hive_thrift_server diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveThriftTransportProtocol.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveThriftTransportProtocol.yml new file mode 100644 index 00000000..c2d9acf2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveThriftTransportProtocol.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.HiveThriftTransportProtocol +name: HiveThriftTransportProtocol +fullName: azure.synapse.artifacts.models.HiveThriftTransportProtocol +summary: The transport protocol to use in the Thrift layer. +module: azure.synapse.artifacts.models +fields: +- name: binary + uid: azure.synapse.artifacts.models.HiveThriftTransportProtocol.binary +- name: http + uid: azure.synapse.artifacts.models.HiveThriftTransportProtocol.http +- name: sasl + uid: azure.synapse.artifacts.models.HiveThriftTransportProtocol.sasl diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpAuthenticationType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpAuthenticationType.yml new file mode 100644 index 00000000..781f273c --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpAuthenticationType.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.HttpAuthenticationType +name: HttpAuthenticationType +fullName: azure.synapse.artifacts.models.HttpAuthenticationType +summary: The authentication type to be used to connect to the HTTP server. +module: azure.synapse.artifacts.models +fields: +- name: anonymous + uid: azure.synapse.artifacts.models.HttpAuthenticationType.anonymous +- name: basic + uid: azure.synapse.artifacts.models.HttpAuthenticationType.basic +- name: client_certificate + uid: azure.synapse.artifacts.models.HttpAuthenticationType.client_certificate +- name: digest + uid: azure.synapse.artifacts.models.HttpAuthenticationType.digest +- name: windows + uid: azure.synapse.artifacts.models.HttpAuthenticationType.windows diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpLinkedService.yml new file mode 100644 index 00000000..fbc6c163 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpLinkedService.yml @@ -0,0 +1,260 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.HttpLinkedService +name: HttpLinkedService +fullName: azure.synapse.artifacts.models.HttpLinkedService +module: azure.synapse.artifacts.models +summary: 'Linked service for an HTTP source. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'HttpLinkedService(*, url: object, additional_properties: Dict[str, object] + | None = None, connect_via: IntegrationRuntimeReference | None = None, description: + str | None = None, parameters: Dict[str, ParameterSpecification] | None = None, + annotations: List[object] | None = None, authentication_type: str | HttpAuthenticationType + | None = None, user_name: object | None = None, password: SecretBase | None = + None, embedded_cert_data: object | None = None, cert_thumbprint: object | None + = None, encrypted_credential: object | None = None, enable_server_certificate_validation: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: url + description: 'Required. The base URL of the HTTP endpoint, e.g. [http://www.microsoft.com](http://www.microsoft.com). + Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: authentication_type + description: 'The authentication type to be used to connect to the HTTP server. + + Possible values include: "Basic", "Anonymous", "Digest", "Windows", "ClientCertificate".' + isRequired: true + types: + - + - + - name: user_name + description: 'User name for Basic, Digest, or Windows authentication. Type: string + (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: password + description: 'Password for Basic, Digest, Windows, or ClientCertificate with + + EmbeddedCertData authentication.' + isRequired: true + types: + - + - name: embedded_cert_data + description: 'Base64 encoded certificate data for ClientCertificate + + authentication. For on-premises copy with ClientCertificate authentication, + either + + CertThumbprint or EmbeddedCertData/Password should be specified. Type: string + (or Expression + + with resultType string).' + isRequired: true + types: + - + - name: cert_thumbprint + description: 'Thumbprint of certificate for ClientCertificate authentication. + Only + + valid for on-premises copy. For on-premises copy with ClientCertificate authentication, + either + + CertThumbprint or EmbeddedCertData/Password should be specified. Type: string + (or Expression + + with resultType string).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + - name: enable_server_certificate_validation + description: 'If true, validate the HTTPS server SSL + + certificate. Default value is true. Type: boolean (or Expression with resultType + boolean).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: url + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: authentication_type + isRequired: true + - name: user_name + isRequired: true + - name: password + isRequired: true + - name: embedded_cert_data + isRequired: true + - name: cert_thumbprint + isRequired: true + - name: encrypted_credential + isRequired: true + - name: enable_server_certificate_validation + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.HttpLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HttpLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HttpLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.HttpLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HttpLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.HttpLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HttpLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotLinkedService.yml new file mode 100644 index 00000000..5615cafc --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotLinkedService.yml @@ -0,0 +1,240 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.HubspotLinkedService +name: HubspotLinkedService +fullName: azure.synapse.artifacts.models.HubspotLinkedService +module: azure.synapse.artifacts.models +summary: 'Hubspot Service linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'HubspotLinkedService(*, client_id: object, additional_properties: Dict[str, + object] | None = None, connect_via: IntegrationRuntimeReference | None = None, + description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, client_secret: SecretBase + | None = None, access_token: SecretBase | None = None, refresh_token: SecretBase + | None = None, use_encrypted_endpoints: object | None = None, use_host_verification: + object | None = None, use_peer_verification: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: client_id + description: Required. The client ID associated with your Hubspot application. + isRequired: true + types: + - + - name: client_secret + description: The client secret associated with your Hubspot application. + isRequired: true + types: + - + - name: access_token + description: "The access token obtained when initially\_authenticating\_your\_\ + OAuth\nintegration." + isRequired: true + types: + - + - name: refresh_token + description: "The refresh token obtained when initially\_authenticating\_your\_\ + OAuth\nintegration." + isRequired: true + types: + - + - name: use_encrypted_endpoints + description: 'Specifies whether the data source endpoints are encrypted using + + HTTPS. The default value is true.' + isRequired: true + types: + - + - name: use_host_verification + description: 'Specifies whether to require the host name in the server''s + + certificate to match the host name of the server when connecting over SSL. The + default value is + + true.' + isRequired: true + types: + - + - name: use_peer_verification + description: 'Specifies whether to verify the identity of the server when + + connecting over SSL. The default value is true.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: client_id + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: client_secret + isRequired: true + - name: access_token + isRequired: true + - name: refresh_token + isRequired: true + - name: use_encrypted_endpoints + isRequired: true + - name: use_host_verification + isRequired: true + - name: use_peer_verification + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.HubspotLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HubspotLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HubspotLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.HubspotLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HubspotLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.HubspotLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HubspotLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotObjectDataset.yml new file mode 100644 index 00000000..f0896837 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotObjectDataset.yml @@ -0,0 +1,202 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.HubspotObjectDataset +name: HubspotObjectDataset +fullName: azure.synapse.artifacts.models.HubspotObjectDataset +module: azure.synapse.artifacts.models +summary: 'Hubspot Service dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'HubspotObjectDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.HubspotObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HubspotObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HubspotObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.HubspotObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.HubspotObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.HubspotObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.HubspotObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IfConditionActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IfConditionActivity.yml new file mode 100644 index 00000000..d7baab74 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IfConditionActivity.yml @@ -0,0 +1,200 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.IfConditionActivity +name: IfConditionActivity +fullName: azure.synapse.artifacts.models.IfConditionActivity +module: azure.synapse.artifacts.models +summary: 'This activity evaluates a boolean expression and executes either the activities + under the ifTrueActivities property or the ifFalseActivities property depending + on the result of the expression. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'IfConditionActivity(*, name: str, expression: Expression, additional_properties: + Dict[str, object] | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, if_true_activities: + List[Activity] | None = None, if_false_activities: List[Activity] | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: expression + description: 'Required. An expression that would evaluate to Boolean. This is + used to + + determine the block of activities (ifTrueActivities or ifFalseActivities) that + will be + + executed.' + isRequired: true + types: + - + - name: if_true_activities + description: 'List of activities to execute if expression is evaluated to true. + + This is an optional property and if not provided, the activity will exit without + any action.' + isRequired: true + types: + - [] + - name: if_false_activities + description: 'List of activities to execute if expression is evaluated to false. + + This is an optional property and if not provided, the activity will exit without + any action.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: name + isRequired: true + - name: expression + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: if_true_activities + isRequired: true + - name: if_false_activities + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.IfConditionActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.IfConditionActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.IfConditionActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.IfConditionActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.IfConditionActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.IfConditionActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.IfConditionActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaAuthenticationType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaAuthenticationType.yml new file mode 100644 index 00000000..800c88e8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaAuthenticationType.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.ImpalaAuthenticationType +name: ImpalaAuthenticationType +fullName: azure.synapse.artifacts.models.ImpalaAuthenticationType +summary: The authentication type to use. +module: azure.synapse.artifacts.models +fields: +- name: anonymous + uid: azure.synapse.artifacts.models.ImpalaAuthenticationType.anonymous +- name: sasl_username + uid: azure.synapse.artifacts.models.ImpalaAuthenticationType.sasl_username +- name: username_and_password + uid: azure.synapse.artifacts.models.ImpalaAuthenticationType.username_and_password diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaLinkedService.yml new file mode 100644 index 00000000..c84c3a6c --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaLinkedService.yml @@ -0,0 +1,278 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ImpalaLinkedService +name: ImpalaLinkedService +fullName: azure.synapse.artifacts.models.ImpalaLinkedService +module: azure.synapse.artifacts.models +summary: 'Impala server linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ImpalaLinkedService(*, host: object, authentication_type: str | ImpalaAuthenticationType, + additional_properties: Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference + | None = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, port: object | None = + None, username: object | None = None, password: SecretBase | None = None, enable_ssl: + object | None = None, trusted_cert_path: object | None = None, use_system_trust_store: + object | None = None, allow_host_name_cn_mismatch: object | None = None, allow_self_signed_server_cert: + object | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: host + description: 'Required. The IP address or host name of the Impala server. (i.e. + + 192.168.222.160).' + isRequired: true + types: + - + - name: port + description: 'The TCP port that the Impala server uses to listen for client connections. + The + + default value is 21050.' + isRequired: true + types: + - + - name: authentication_type + description: 'Required. The authentication type to use. Possible values include: + + "Anonymous", "SASLUsername", "UsernameAndPassword".' + isRequired: true + types: + - + - + - name: username + description: 'The user name used to access the Impala server. The default value + is anonymous + + when using SASLUsername.' + isRequired: true + types: + - + - name: password + description: The password corresponding to the user name when using UsernameAndPassword. + isRequired: true + types: + - + - name: enable_ssl + description: 'Specifies whether the connections to the server are encrypted using + SSL. The + + default value is false.' + isRequired: true + types: + - + - name: trusted_cert_path + description: 'The full path of the .pem file containing trusted CA certificates + for + + verifying the server when connecting over SSL. This property can only be set + when using SSL on + + self-hosted IR. The default value is the cacerts.pem file installed with the + IR.' + isRequired: true + types: + - + - name: use_system_trust_store + description: 'Specifies whether to use a CA certificate from the system trust + + store or from a specified PEM file. The default value is false.' + isRequired: true + types: + - + - name: allow_host_name_cn_mismatch + description: 'Specifies whether to require a CA-issued SSL certificate + + name to match the host name of the server when connecting over SSL. The default + value is false.' + isRequired: true + types: + - + - name: allow_self_signed_server_cert + description: 'Specifies whether to allow self-signed certificates from + + the server. The default value is false.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: host + isRequired: true + - name: authentication_type + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: port + isRequired: true + - name: username + isRequired: true + - name: password + isRequired: true + - name: enable_ssl + isRequired: true + - name: trusted_cert_path + isRequired: true + - name: use_system_trust_store + isRequired: true + - name: allow_host_name_cn_mismatch + isRequired: true + - name: allow_self_signed_server_cert + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ImpalaLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ImpalaLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ImpalaLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ImpalaLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ImpalaLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ImpalaLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ImpalaLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaObjectDataset.yml new file mode 100644 index 00000000..54cc8087 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaObjectDataset.yml @@ -0,0 +1,223 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ImpalaObjectDataset +name: ImpalaObjectDataset +fullName: azure.synapse.artifacts.models.ImpalaObjectDataset +module: azure.synapse.artifacts.models +summary: 'Impala server dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ImpalaObjectDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, table: object | None = None, + schema_type_properties_schema: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'This property will be retired. Please consider using schema + table + + properties instead.' + isRequired: true + types: + - + - name: table + description: 'The table name of the Impala. Type: string (or Expression with resultType + + string).' + isRequired: true + types: + - + - name: schema_type_properties_schema + description: 'The schema name of the Impala. Type: string (or + + Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true + - name: table + isRequired: true + - name: schema_type_properties_schema + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ImpalaObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ImpalaObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ImpalaObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ImpalaObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ImpalaObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ImpalaObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ImpalaObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixLinkedService.yml new file mode 100644 index 00000000..71b76ced --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixLinkedService.yml @@ -0,0 +1,229 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.InformixLinkedService +name: InformixLinkedService +fullName: azure.synapse.artifacts.models.InformixLinkedService +module: azure.synapse.artifacts.models +summary: 'Informix linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'InformixLinkedService(*, connection_string: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, authentication_type: object + | None = None, credential: SecretBase | None = None, user_name: object | None + = None, password: SecretBase | None = None, encrypted_credential: object | None + = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'Required. The non-access credential portion of the connection string + + as well as an optional encrypted credential. Type: string, SecureString or + + AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: authentication_type + description: 'Type of authentication used to connect to the Informix as ODBC data + + store. Possible values are: Anonymous and Basic. Type: string (or Expression + with resultType + + string).' + isRequired: true + types: + - + - name: credential + description: 'The access credential portion of the connection string specified + in driver- + + specific property-value format.' + isRequired: true + types: + - + - name: user_name + description: 'User name for Basic authentication. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: password + description: Password for Basic authentication. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: connection_string + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: authentication_type + isRequired: true + - name: credential + isRequired: true + - name: user_name + isRequired: true + - name: password + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.InformixLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.InformixLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.InformixLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.InformixLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.InformixLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.InformixLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.InformixLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixTableDataset.yml new file mode 100644 index 00000000..9bb14530 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixTableDataset.yml @@ -0,0 +1,204 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.InformixTableDataset +name: InformixTableDataset +fullName: azure.synapse.artifacts.models.InformixTableDataset +module: azure.synapse.artifacts.models +summary: 'The Informix table dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'InformixTableDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The Informix table name. Type: string (or Expression with resultType + + string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.InformixTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.InformixTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.InformixTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.InformixTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.InformixTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.InformixTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.InformixTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeReference.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeReference.yml new file mode 100644 index 00000000..cb05d0a5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeReference.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.IntegrationRuntimeReference +name: IntegrationRuntimeReference +fullName: azure.synapse.artifacts.models.IntegrationRuntimeReference +module: azure.synapse.artifacts.models +summary: 'Integration runtime reference type. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'IntegrationRuntimeReference(*, reference_name: str, parameters: Dict[str, + object] | None = None, **kwargs)' + parameters: + - name: reference_name + description: Required. Reference integration runtime name. + isRequired: true + types: + - + - name: parameters + description: Arguments for integration runtime. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: reference_name + isRequired: true + - name: parameters + isRequired: true +variables: +- description: 'Required. Type of integration runtime. Default value: + + "IntegrationRuntimeReference".' + name: type + types: + - +methods: +- uid: azure.synapse.artifacts.models.IntegrationRuntimeReference.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.IntegrationRuntimeReference.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.IntegrationRuntimeReference.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.IntegrationRuntimeReference.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.IntegrationRuntimeReference.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.IntegrationRuntimeReference.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.IntegrationRuntimeReference.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +attributes: +- uid: azure.synapse.artifacts.models.IntegrationRuntimeReference.type + name: type + signature: type = 'IntegrationRuntimeReference' diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraLinkedService.yml new file mode 100644 index 00000000..e2a5bec4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraLinkedService.yml @@ -0,0 +1,246 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.JiraLinkedService +name: JiraLinkedService +fullName: azure.synapse.artifacts.models.JiraLinkedService +module: azure.synapse.artifacts.models +summary: 'Jira Service linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'JiraLinkedService(*, host: object, username: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, port: object | None = + None, password: SecretBase | None = None, use_encrypted_endpoints: object | None + = None, use_host_verification: object | None = None, use_peer_verification: object + | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: host + description: 'Required. The IP address or host name of the Jira service. (e.g. + + jira.example.com).' + isRequired: true + types: + - + - name: port + description: 'The TCP port that the Jira server uses to listen for client connections. + The + + default value is 443 if connecting through HTTPS, or 8080 if connecting through + HTTP.' + isRequired: true + types: + - + - name: username + description: Required. The user name that you use to access Jira Service. + isRequired: true + types: + - + - name: password + description: 'The password corresponding to the user name that you provided in + the username + + field.' + isRequired: true + types: + - + - name: use_encrypted_endpoints + description: 'Specifies whether the data source endpoints are encrypted using + + HTTPS. The default value is true.' + isRequired: true + types: + - + - name: use_host_verification + description: 'Specifies whether to require the host name in the server''s + + certificate to match the host name of the server when connecting over SSL. The + default value is + + true.' + isRequired: true + types: + - + - name: use_peer_verification + description: 'Specifies whether to verify the identity of the server when + + connecting over SSL. The default value is true.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: host + isRequired: true + - name: username + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: port + isRequired: true + - name: password + isRequired: true + - name: use_encrypted_endpoints + isRequired: true + - name: use_host_verification + isRequired: true + - name: use_peer_verification + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.JiraLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.JiraLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.JiraLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.JiraLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.JiraLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.JiraLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.JiraLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraObjectDataset.yml new file mode 100644 index 00000000..0a21e381 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraObjectDataset.yml @@ -0,0 +1,202 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.JiraObjectDataset +name: JiraObjectDataset +fullName: azure.synapse.artifacts.models.JiraObjectDataset +module: azure.synapse.artifacts.models +summary: 'Jira Service dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'JiraObjectDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.JiraObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.JiraObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.JiraObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.JiraObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.JiraObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.JiraObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.JiraObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonDataset.yml new file mode 100644 index 00000000..6d7f9412 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonDataset.yml @@ -0,0 +1,228 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.JsonDataset +name: JsonDataset +fullName: azure.synapse.artifacts.models.JsonDataset +module: azure.synapse.artifacts.models +summary: 'Json dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'JsonDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, location: DatasetLocation | None = None, encoding_name: object + | None = None, compression: DatasetCompression | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: location + description: The location of the json data storage. + isRequired: true + types: + - + - name: encoding_name + description: 'The code page name of the preferred encoding. If not specified, + the + + default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to + the name column + + of the table in the following link to set supported values: + + [https://msdn.microsoft.com/library/system.text.encoding.aspx](https://msdn.microsoft.com/library/system.text.encoding.aspx). + Type: string (or Expression with + + resultType string).' + isRequired: true + types: + - + - name: compression + description: The data compression method used for the json dataset. + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: location + isRequired: true + - name: encoding_name + isRequired: true + - name: compression + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.JsonDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.JsonDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.JsonDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.JsonDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.JsonDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.JsonDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.JsonDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedService.yml new file mode 100644 index 00000000..25bdb2bf --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedService.yml @@ -0,0 +1,195 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.LinkedService +name: LinkedService +fullName: azure.synapse.artifacts.models.LinkedService +module: azure.synapse.artifacts.models +summary: 'The Azure Synapse nested object which contains the information and credential + which can be used to connect with related store or compute resource. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: AmazonMWSLinkedService, AmazonRedshiftLinkedService, AmazonS3LinkedService, + AzureBatchLinkedService, AzureBlobFSLinkedService, AzureBlobStorageLinkedService, + AzureDataExplorerLinkedService, AzureDataLakeAnalyticsLinkedService, AzureDataLakeStoreLinkedService, + AzureDatabricksLinkedService, AzureFileStorageLinkedService, AzureFunctionLinkedService, + AzureKeyVaultLinkedService, AzureMLLinkedService, AzureMLServiceLinkedService, AzureMariaDBLinkedService, + AzureMySqlLinkedService, AzurePostgreSqlLinkedService, AzureSearchLinkedService, + AzureSqlDWLinkedService, AzureSqlDatabaseLinkedService, AzureSqlMILinkedService, + AzureStorageLinkedService, AzureTableStorageLinkedService, CassandraLinkedService, + CommonDataServiceForAppsLinkedService, ConcurLinkedService, CosmosDbLinkedService, + CosmosDbMongoDbApiLinkedService, CouchbaseLinkedService, CustomDataSourceLinkedService, + Db2LinkedService, DrillLinkedService, DynamicsLinkedService, DynamicsAXLinkedService, + DynamicsCrmLinkedService, EloquaLinkedService, FileServerLinkedService, FtpServerLinkedService, + GoogleAdWordsLinkedService, GoogleBigQueryLinkedService, GoogleCloudStorageLinkedService, + GreenplumLinkedService, HBaseLinkedService, HDInsightLinkedService, HDInsightOnDemandLinkedService, + HdfsLinkedService, HiveLinkedService, HttpLinkedService, HubspotLinkedService, ImpalaLinkedService, + InformixLinkedService, JiraLinkedService, MagentoLinkedService, MariaDBLinkedService, + MarketoLinkedService, MicrosoftAccessLinkedService, MongoDbLinkedService, MongoDbV2LinkedService, + MySqlLinkedService, NetezzaLinkedService, ODataLinkedService, OdbcLinkedService, + Office365LinkedService, OracleLinkedService, OracleServiceCloudLinkedService, PaypalLinkedService, + PhoenixLinkedService, PostgreSqlLinkedService, PrestoLinkedService, QuickBooksLinkedService, + ResponsysLinkedService, RestServiceLinkedService, SalesforceLinkedService, SalesforceMarketingCloudLinkedService, + SalesforceServiceCloudLinkedService, SapBWLinkedService, SapCloudForCustomerLinkedService, + SapEccLinkedService, SapHanaLinkedService, SapOpenHubLinkedService, SapTableLinkedService, + ServiceNowLinkedService, SftpServerLinkedService, ShopifyLinkedService, SparkLinkedService, + SqlServerLinkedService, SquareLinkedService, SybaseLinkedService, TeradataLinkedService, + VerticaLinkedService, WebLinkedService, XeroLinkedService, ZohoLinkedService. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'LinkedService(*, additional_properties: Dict[str, object] | None = None, + connect_via: IntegrationRuntimeReference | None = None, description: str | None + = None, parameters: Dict[str, ParameterSpecification] | None = None, annotations: + List[object] | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.LinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.LinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.LinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.LinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.LinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.LinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.LinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceDebugResource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceDebugResource.yml new file mode 100644 index 00000000..07ea66df --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceDebugResource.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.LinkedServiceDebugResource +name: LinkedServiceDebugResource +fullName: azure.synapse.artifacts.models.LinkedServiceDebugResource +module: azure.synapse.artifacts.models +summary: 'Linked service debug resource. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'LinkedServiceDebugResource(*, properties: LinkedService, name: str | None + = None, **kwargs)' + parameters: + - name: name + description: The resource name. + isRequired: true + types: + - + - name: properties + description: Required. Properties of linked service. + isRequired: true + types: + - + keywordOnlyParameters: + - name: properties + isRequired: true + - name: name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.LinkedServiceDebugResource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.LinkedServiceDebugResource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.LinkedServiceDebugResource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.LinkedServiceDebugResource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.LinkedServiceDebugResource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.LinkedServiceDebugResource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.LinkedServiceDebugResource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceListResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceListResponse.yml new file mode 100644 index 00000000..43b714c1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceListResponse.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.LinkedServiceListResponse +name: LinkedServiceListResponse +fullName: azure.synapse.artifacts.models.LinkedServiceListResponse +module: azure.synapse.artifacts.models +summary: 'A list of linked service resources. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'LinkedServiceListResponse(*, value: List[LinkedServiceResource], next_link: + str | None = None, **kwargs)' + parameters: + - name: value + description: Required. List of linked services. + isRequired: true + types: + - [] + - name: next_link + description: The link to the next page of results, if any remaining results exist. + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: next_link + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.LinkedServiceListResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.LinkedServiceListResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.LinkedServiceListResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.LinkedServiceListResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.LinkedServiceListResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.LinkedServiceListResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.LinkedServiceListResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceReference.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceReference.yml new file mode 100644 index 00000000..691ae2e8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceReference.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.LinkedServiceReference +name: LinkedServiceReference +fullName: azure.synapse.artifacts.models.LinkedServiceReference +module: azure.synapse.artifacts.models +summary: 'Linked service reference type. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'LinkedServiceReference(*, reference_name: str, parameters: Dict[str, object] + | None = None, **kwargs)' + parameters: + - name: reference_name + description: Required. Reference LinkedService name. + isRequired: true + types: + - + - name: parameters + description: Arguments for LinkedService. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: reference_name + isRequired: true + - name: parameters + isRequired: true +variables: +- description: 'Required. Linked service reference type. Default value: "LinkedServiceReference".' + name: type + types: + - +methods: +- uid: azure.synapse.artifacts.models.LinkedServiceReference.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.LinkedServiceReference.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.LinkedServiceReference.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.LinkedServiceReference.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.LinkedServiceReference.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.LinkedServiceReference.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.LinkedServiceReference.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +attributes: +- uid: azure.synapse.artifacts.models.LinkedServiceReference.type + name: type + signature: type = 'LinkedServiceReference' diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceResource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceResource.yml new file mode 100644 index 00000000..67605471 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceResource.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.LinkedServiceResource +name: LinkedServiceResource +fullName: azure.synapse.artifacts.models.LinkedServiceResource +module: azure.synapse.artifacts.models +summary: 'Linked service resource type. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'LinkedServiceResource(*, properties: LinkedService, **kwargs)' + parameters: + - name: properties + description: Required. Properties of linked service. + isRequired: true + types: + - + keywordOnlyParameters: + - name: properties + isRequired: true +variables: +- description: The resource identifier. + name: id + types: + - +- description: The resource name. + name: name + types: + - +- description: The resource type. + name: type + types: + - +- description: Etag identifies change in the resource. + name: etag + types: + - +methods: +- uid: azure.synapse.artifacts.models.LinkedServiceResource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.LinkedServiceResource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.LinkedServiceResource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.LinkedServiceResource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.LinkedServiceResource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.LinkedServiceResource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.LinkedServiceResource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LogStorageSettings.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LogStorageSettings.yml new file mode 100644 index 00000000..df71bc8e --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LogStorageSettings.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.LogStorageSettings +name: LogStorageSettings +fullName: azure.synapse.artifacts.models.LogStorageSettings +module: azure.synapse.artifacts.models +summary: 'Log storage settings. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'LogStorageSettings(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, path: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: linked_service_name + description: Required. Log storage linked service reference. + isRequired: true + types: + - + - name: path + description: 'The path to storage for storing detailed logs of activity execution. + Type: string + + (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: path + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.LogStorageSettings.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.LogStorageSettings.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.LogStorageSettings.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.LogStorageSettings.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.LogStorageSettings.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.LogStorageSettings.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.LogStorageSettings.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LookupActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LookupActivity.yml new file mode 100644 index 00000000..b07bd2b1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LookupActivity.yml @@ -0,0 +1,204 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.LookupActivity +name: LookupActivity +fullName: azure.synapse.artifacts.models.LookupActivity +module: azure.synapse.artifacts.models +summary: 'Lookup activity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'LookupActivity(*, name: str, source: CopySource, dataset: DatasetReference, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, depends_on: List[ActivityDependency] | None = None, user_properties: List[UserProperty] + | None = None, linked_service_name: LinkedServiceReference | None = None, policy: + ActivityPolicy | None = None, first_row_only: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + - name: source + description: Required. Dataset-specific source properties, same as copy activity + source. + isRequired: true + types: + - + - name: dataset + description: Required. Lookup activity dataset reference. + isRequired: true + types: + - + - name: first_row_only + description: 'Whether to return first row or all rows. Default value is true. + Type: + + boolean (or Expression with resultType boolean).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: source + isRequired: true + - name: dataset + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true + - name: first_row_only + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.LookupActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.LookupActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.LookupActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.LookupActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.LookupActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.LookupActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.LookupActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoLinkedService.yml new file mode 100644 index 00000000..361667cf --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoLinkedService.yml @@ -0,0 +1,223 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.MagentoLinkedService +name: MagentoLinkedService +fullName: azure.synapse.artifacts.models.MagentoLinkedService +module: azure.synapse.artifacts.models +summary: 'Magento server linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MagentoLinkedService(*, host: object, additional_properties: Dict[str, + object] | None = None, connect_via: IntegrationRuntimeReference | None = None, + description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, access_token: SecretBase + | None = None, use_encrypted_endpoints: object | None = None, use_host_verification: + object | None = None, use_peer_verification: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: host + description: Required. The URL of the Magento instance. (i.e. 192.168.222.110/magento3). + isRequired: true + types: + - + - name: access_token + description: The access token from Magento. + isRequired: true + types: + - + - name: use_encrypted_endpoints + description: 'Specifies whether the data source endpoints are encrypted using + + HTTPS. The default value is true.' + isRequired: true + types: + - + - name: use_host_verification + description: 'Specifies whether to require the host name in the server''s + + certificate to match the host name of the server when connecting over SSL. The + default value is + + true.' + isRequired: true + types: + - + - name: use_peer_verification + description: 'Specifies whether to verify the identity of the server when + + connecting over SSL. The default value is true.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: host + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: access_token + isRequired: true + - name: use_encrypted_endpoints + isRequired: true + - name: use_host_verification + isRequired: true + - name: use_peer_verification + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.MagentoLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MagentoLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MagentoLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.MagentoLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MagentoLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.MagentoLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MagentoLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoObjectDataset.yml new file mode 100644 index 00000000..5b031458 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoObjectDataset.yml @@ -0,0 +1,202 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.MagentoObjectDataset +name: MagentoObjectDataset +fullName: azure.synapse.artifacts.models.MagentoObjectDataset +module: azure.synapse.artifacts.models +summary: 'Magento server dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MagentoObjectDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.MagentoObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MagentoObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MagentoObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.MagentoObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MagentoObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.MagentoObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MagentoObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MappingDataFlow.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MappingDataFlow.yml new file mode 100644 index 00000000..ec389c67 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MappingDataFlow.yml @@ -0,0 +1,179 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.MappingDataFlow +name: MappingDataFlow +fullName: azure.synapse.artifacts.models.MappingDataFlow +module: azure.synapse.artifacts.models +summary: 'Mapping data flow. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MappingDataFlow(*, description: str | None = None, annotations: List[object] + | None = None, folder: DataFlowFolder | None = None, sources: List[DataFlowSource] + | None = None, sinks: List[DataFlowSink] | None = None, transformations: List[Transformation] + | None = None, script: str | None = None, **kwargs)' + parameters: + - name: type + description: Required. Type of data flow.Constant filled by server. + isRequired: true + types: + - + - name: description + description: The description of the data flow. + isRequired: true + types: + - + - name: annotations + description: List of tags that can be used for describing the data flow. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this data flow is in. If not specified, Data flow + will appear at + + the root level.' + isRequired: true + types: + - + - name: sources + description: List of sources in data flow. + isRequired: true + types: + - [] + - name: sinks + description: List of sinks in data flow. + isRequired: true + types: + - [] + - name: transformations + description: List of transformations in data flow. + isRequired: true + types: + - [] + - name: script + description: DataFlow script. + isRequired: true + types: + - + keywordOnlyParameters: + - name: description + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: sources + isRequired: true + - name: sinks + isRequired: true + - name: transformations + isRequired: true + - name: script + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.MappingDataFlow.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MappingDataFlow.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MappingDataFlow.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.MappingDataFlow.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MappingDataFlow.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.MappingDataFlow.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MappingDataFlow.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBLinkedService.yml new file mode 100644 index 00000000..eb28118d --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBLinkedService.yml @@ -0,0 +1,193 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.MariaDBLinkedService +name: MariaDBLinkedService +fullName: azure.synapse.artifacts.models.MariaDBLinkedService +module: azure.synapse.artifacts.models +summary: 'MariaDB server linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MariaDBLinkedService(*, additional_properties: Dict[str, object] | None + = None, connect_via: IntegrationRuntimeReference | None = None, description: str + | None = None, parameters: Dict[str, ParameterSpecification] | None = None, annotations: + List[object] | None = None, connection_string: object | None = None, pwd: AzureKeyVaultSecretReference + | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'An ODBC connection string. Type: string, SecureString or + + AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: pwd + description: The Azure key vault secret reference of password in connection string. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: connection_string + isRequired: true + - name: pwd + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.MariaDBLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MariaDBLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MariaDBLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.MariaDBLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MariaDBLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.MariaDBLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MariaDBLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBTableDataset.yml new file mode 100644 index 00000000..3666512d --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBTableDataset.yml @@ -0,0 +1,202 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.MariaDBTableDataset +name: MariaDBTableDataset +fullName: azure.synapse.artifacts.models.MariaDBTableDataset +module: azure.synapse.artifacts.models +summary: 'MariaDB server dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MariaDBTableDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.MariaDBTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MariaDBTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MariaDBTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.MariaDBTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MariaDBTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.MariaDBTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MariaDBTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoLinkedService.yml new file mode 100644 index 00000000..f7c94b9a --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoLinkedService.yml @@ -0,0 +1,230 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.MarketoLinkedService +name: MarketoLinkedService +fullName: azure.synapse.artifacts.models.MarketoLinkedService +module: azure.synapse.artifacts.models +summary: 'Marketo server linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MarketoLinkedService(*, endpoint: object, client_id: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, client_secret: SecretBase + | None = None, use_encrypted_endpoints: object | None = None, use_host_verification: + object | None = None, use_peer_verification: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: endpoint + description: Required. The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com). + isRequired: true + types: + - + - name: client_id + description: Required. The client Id of your Marketo service. + isRequired: true + types: + - + - name: client_secret + description: The client secret of your Marketo service. + isRequired: true + types: + - + - name: use_encrypted_endpoints + description: 'Specifies whether the data source endpoints are encrypted using + + HTTPS. The default value is true.' + isRequired: true + types: + - + - name: use_host_verification + description: 'Specifies whether to require the host name in the server''s + + certificate to match the host name of the server when connecting over SSL. The + default value is + + true.' + isRequired: true + types: + - + - name: use_peer_verification + description: 'Specifies whether to verify the identity of the server when + + connecting over SSL. The default value is true.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: endpoint + isRequired: true + - name: client_id + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: client_secret + isRequired: true + - name: use_encrypted_endpoints + isRequired: true + - name: use_host_verification + isRequired: true + - name: use_peer_verification + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.MarketoLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MarketoLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MarketoLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.MarketoLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MarketoLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.MarketoLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MarketoLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoObjectDataset.yml new file mode 100644 index 00000000..0403749d --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoObjectDataset.yml @@ -0,0 +1,202 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.MarketoObjectDataset +name: MarketoObjectDataset +fullName: azure.synapse.artifacts.models.MarketoObjectDataset +module: azure.synapse.artifacts.models +summary: 'Marketo server dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MarketoObjectDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.MarketoObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MarketoObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MarketoObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.MarketoObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MarketoObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.MarketoObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MarketoObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessLinkedService.yml new file mode 100644 index 00000000..dc2349ca --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessLinkedService.yml @@ -0,0 +1,229 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.MicrosoftAccessLinkedService +name: MicrosoftAccessLinkedService +fullName: azure.synapse.artifacts.models.MicrosoftAccessLinkedService +module: azure.synapse.artifacts.models +summary: 'Microsoft Access linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MicrosoftAccessLinkedService(*, connection_string: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, authentication_type: object + | None = None, credential: SecretBase | None = None, user_name: object | None + = None, password: SecretBase | None = None, encrypted_credential: object | None + = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'Required. The non-access credential portion of the connection string + + as well as an optional encrypted credential. Type: string, SecureString or + + AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: authentication_type + description: 'Type of authentication used to connect to the Microsoft Access as + + ODBC data store. Possible values are: Anonymous and Basic. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + - name: credential + description: 'The access credential portion of the connection string specified + in driver- + + specific property-value format.' + isRequired: true + types: + - + - name: user_name + description: 'User name for Basic authentication. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: password + description: Password for Basic authentication. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: connection_string + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: authentication_type + isRequired: true + - name: credential + isRequired: true + - name: user_name + isRequired: true + - name: password + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.MicrosoftAccessLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MicrosoftAccessLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MicrosoftAccessLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.MicrosoftAccessLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MicrosoftAccessLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.MicrosoftAccessLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MicrosoftAccessLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessTableDataset.yml new file mode 100644 index 00000000..75b0fc52 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessTableDataset.yml @@ -0,0 +1,206 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.MicrosoftAccessTableDataset +name: MicrosoftAccessTableDataset +fullName: azure.synapse.artifacts.models.MicrosoftAccessTableDataset +module: azure.synapse.artifacts.models +summary: 'The Microsoft Access table dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MicrosoftAccessTableDataset(*, linked_service_name: LinkedServiceReference, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, structure: object | None = None, schema: object | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, folder: DatasetFolder | None = None, table_name: object | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The Microsoft Access table name. Type: string (or Expression with + resultType + + string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.MicrosoftAccessTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MicrosoftAccessTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MicrosoftAccessTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.MicrosoftAccessTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MicrosoftAccessTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.MicrosoftAccessTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MicrosoftAccessTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbAuthenticationType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbAuthenticationType.yml new file mode 100644 index 00000000..798c03cc --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbAuthenticationType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.MongoDbAuthenticationType +name: MongoDbAuthenticationType +fullName: azure.synapse.artifacts.models.MongoDbAuthenticationType +summary: The authentication type to be used to connect to the MongoDB database. +module: azure.synapse.artifacts.models +fields: +- name: anonymous + uid: azure.synapse.artifacts.models.MongoDbAuthenticationType.anonymous +- name: basic + uid: azure.synapse.artifacts.models.MongoDbAuthenticationType.basic diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbCollectionDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbCollectionDataset.yml new file mode 100644 index 00000000..721f0fba --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbCollectionDataset.yml @@ -0,0 +1,204 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.MongoDbCollectionDataset +name: MongoDbCollectionDataset +fullName: azure.synapse.artifacts.models.MongoDbCollectionDataset +module: azure.synapse.artifacts.models +summary: 'The MongoDB database dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MongoDbCollectionDataset(*, linked_service_name: LinkedServiceReference, + collection_name: object, additional_properties: Dict[str, object] | None = None, + description: str | None = None, structure: object | None = None, schema: object + | None = None, parameters: Dict[str, ParameterSpecification] | None = None, annotations: + List[object] | None = None, folder: DatasetFolder | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: collection_name + description: 'Required. The table name of the MongoDB database. Type: string (or + + Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: collection_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.MongoDbCollectionDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MongoDbCollectionDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MongoDbCollectionDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.MongoDbCollectionDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MongoDbCollectionDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.MongoDbCollectionDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MongoDbCollectionDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbLinkedService.yml new file mode 100644 index 00000000..bfac9369 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbLinkedService.yml @@ -0,0 +1,266 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.MongoDbLinkedService +name: MongoDbLinkedService +fullName: azure.synapse.artifacts.models.MongoDbLinkedService +module: azure.synapse.artifacts.models +summary: 'Linked service for MongoDb data source. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MongoDbLinkedService(*, server: object, database_name: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, authentication_type: str + | MongoDbAuthenticationType | None = None, username: object | None = None, password: + SecretBase | None = None, auth_source: object | None = None, port: object | None + = None, enable_ssl: object | None = None, allow_self_signed_server_cert: object + | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: server + description: 'Required. The IP address or server name of the MongoDB server. Type: + string (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: authentication_type + description: 'The authentication type to be used to connect to the MongoDB + + database. Possible values include: "Basic", "Anonymous".' + isRequired: true + types: + - + - + - name: database_name + description: 'Required. The name of the MongoDB database that you want to access. + Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: username + description: 'Username for authentication. Type: string (or Expression with resultType + + string).' + isRequired: true + types: + - + - name: password + description: Password for authentication. + isRequired: true + types: + - + - name: auth_source + description: 'Database to verify the username and password. Type: string (or Expression + + with resultType string).' + isRequired: true + types: + - + - name: port + description: 'The TCP port number that the MongoDB server uses to listen for client + connections. + + The default value is 27017. Type: integer (or Expression with resultType integer), + minimum: 0.' + isRequired: true + types: + - + - name: enable_ssl + description: 'Specifies whether the connections to the server are encrypted using + SSL. The + + default value is false. Type: boolean (or Expression with resultType boolean).' + isRequired: true + types: + - + - name: allow_self_signed_server_cert + description: 'Specifies whether to allow self-signed certificates from + + the server. The default value is false. Type: boolean (or Expression with resultType + boolean).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: server + isRequired: true + - name: database_name + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: authentication_type + isRequired: true + - name: username + isRequired: true + - name: password + isRequired: true + - name: auth_source + isRequired: true + - name: port + isRequired: true + - name: enable_ssl + isRequired: true + - name: allow_self_signed_server_cert + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.MongoDbLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MongoDbLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MongoDbLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.MongoDbLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MongoDbLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.MongoDbLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MongoDbLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2CollectionDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2CollectionDataset.yml new file mode 100644 index 00000000..9df1dd97 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2CollectionDataset.yml @@ -0,0 +1,205 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.MongoDbV2CollectionDataset +name: MongoDbV2CollectionDataset +fullName: azure.synapse.artifacts.models.MongoDbV2CollectionDataset +module: azure.synapse.artifacts.models +summary: 'The MongoDB database dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MongoDbV2CollectionDataset(*, linked_service_name: LinkedServiceReference, + collection: object, additional_properties: Dict[str, object] | None = None, description: + str | None = None, structure: object | None = None, schema: object | None = None, + parameters: Dict[str, ParameterSpecification] | None = None, annotations: List[object] + | None = None, folder: DatasetFolder | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: collection + description: 'Required. The collection name of the MongoDB database. Type: string + (or + + Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: collection + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.MongoDbV2CollectionDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MongoDbV2CollectionDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MongoDbV2CollectionDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.MongoDbV2CollectionDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MongoDbV2CollectionDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.MongoDbV2CollectionDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MongoDbV2CollectionDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2LinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2LinkedService.yml new file mode 100644 index 00000000..0e24130a --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2LinkedService.yml @@ -0,0 +1,183 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.MongoDbV2LinkedService +name: MongoDbV2LinkedService +fullName: azure.synapse.artifacts.models.MongoDbV2LinkedService +module: azure.synapse.artifacts.models +summary: 'Linked service for MongoDB data source. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MongoDbV2LinkedService(*, connection_string: object, database: object, + additional_properties: Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference + | None = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'Required. The MongoDB connection string. Type: string, SecureString + + or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: database + description: 'Required. The name of the MongoDB database that you want to access. + Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: connection_string + isRequired: true + - name: database + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.MongoDbV2LinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MongoDbV2LinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MongoDbV2LinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.MongoDbV2LinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MongoDbV2LinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.MongoDbV2LinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MongoDbV2LinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MultiplePipelineTrigger.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MultiplePipelineTrigger.yml new file mode 100644 index 00000000..d850ea39 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MultiplePipelineTrigger.yml @@ -0,0 +1,169 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.MultiplePipelineTrigger +name: MultiplePipelineTrigger +fullName: azure.synapse.artifacts.models.MultiplePipelineTrigger +module: azure.synapse.artifacts.models +summary: 'Base class for all triggers that support one to many model for trigger to + pipeline. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MultiplePipelineTrigger(*, additional_properties: Dict[str, object] | None + = None, description: str | None = None, annotations: List[object] | None = None, + pipelines: List[TriggerPipelineReference] | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Trigger type.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Trigger description. + isRequired: true + types: + - + - name: annotations + description: List of tags that can be used for describing the trigger. + isRequired: true + types: + - [] + - name: pipelines + description: Pipelines that need to be started. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: annotations + isRequired: true + - name: pipelines + isRequired: true +variables: +- description: 'Indicates if trigger is running or not. Updated when Start/Stop APIs + are + + called on the Trigger. Possible values include: "Started", "Stopped", "Disabled".' + name: runtime_state + types: + - + - +methods: +- uid: azure.synapse.artifacts.models.MultiplePipelineTrigger.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MultiplePipelineTrigger.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MultiplePipelineTrigger.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.MultiplePipelineTrigger.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MultiplePipelineTrigger.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.MultiplePipelineTrigger.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MultiplePipelineTrigger.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlLinkedService.yml new file mode 100644 index 00000000..377d0083 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlLinkedService.yml @@ -0,0 +1,191 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.MySqlLinkedService +name: MySqlLinkedService +fullName: azure.synapse.artifacts.models.MySqlLinkedService +module: azure.synapse.artifacts.models +summary: 'Linked service for MySQL data source. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MySqlLinkedService(*, connection_string: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, password: AzureKeyVaultSecretReference + | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: Required. The connection string. + isRequired: true + types: + - + - name: password + description: The Azure key vault secret reference of password in connection string. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: connection_string + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: password + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.MySqlLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MySqlLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MySqlLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.MySqlLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MySqlLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.MySqlLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MySqlLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlTableDataset.yml new file mode 100644 index 00000000..305f22e4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlTableDataset.yml @@ -0,0 +1,203 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.MySqlTableDataset +name: MySqlTableDataset +fullName: azure.synapse.artifacts.models.MySqlTableDataset +module: azure.synapse.artifacts.models +summary: 'The MySQL table dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'MySqlTableDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The MySQL table name. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.MySqlTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MySqlTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MySqlTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.MySqlTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.MySqlTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.MySqlTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.MySqlTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaLinkedService.yml new file mode 100644 index 00000000..e8a13f43 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaLinkedService.yml @@ -0,0 +1,193 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.NetezzaLinkedService +name: NetezzaLinkedService +fullName: azure.synapse.artifacts.models.NetezzaLinkedService +module: azure.synapse.artifacts.models +summary: 'Netezza linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'NetezzaLinkedService(*, additional_properties: Dict[str, object] | None + = None, connect_via: IntegrationRuntimeReference | None = None, description: str + | None = None, parameters: Dict[str, ParameterSpecification] | None = None, annotations: + List[object] | None = None, connection_string: object | None = None, pwd: AzureKeyVaultSecretReference + | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'An ODBC connection string. Type: string, SecureString or + + AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: pwd + description: The Azure key vault secret reference of password in connection string. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: connection_string + isRequired: true + - name: pwd + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.NetezzaLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.NetezzaLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.NetezzaLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.NetezzaLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.NetezzaLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.NetezzaLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.NetezzaLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaTableDataset.yml new file mode 100644 index 00000000..5e88d1dd --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaTableDataset.yml @@ -0,0 +1,224 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.NetezzaTableDataset +name: NetezzaTableDataset +fullName: azure.synapse.artifacts.models.NetezzaTableDataset +module: azure.synapse.artifacts.models +summary: 'Netezza dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'NetezzaTableDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, table: object | None = None, + schema_type_properties_schema: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'This property will be retired. Please consider using schema + table + + properties instead.' + isRequired: true + types: + - + - name: table + description: 'The table name of the Netezza. Type: string (or Expression with + resultType + + string).' + isRequired: true + types: + - + - name: schema_type_properties_schema + description: 'The schema name of the Netezza. Type: string (or + + Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true + - name: table + isRequired: true + - name: schema_type_properties_schema + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.NetezzaTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.NetezzaTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.NetezzaTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.NetezzaTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.NetezzaTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.NetezzaTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.NetezzaTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Notebook.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Notebook.yml new file mode 100644 index 00000000..38626610 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Notebook.yml @@ -0,0 +1,184 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.Notebook +name: Notebook +fullName: azure.synapse.artifacts.models.Notebook +module: azure.synapse.artifacts.models +summary: 'Notebook. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Notebook(*, metadata: NotebookMetadata, nbformat: int, nbformat_minor: + int, cells: List[NotebookCell], additional_properties: Dict[str, object] | None + = None, description: str | None = None, big_data_pool: BigDataPoolReference | + None = None, session_properties: NotebookSessionProperties | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: description + description: The description of the notebook. + isRequired: true + types: + - + - name: big_data_pool + description: Big data pool reference. + isRequired: true + types: + - + - name: session_properties + description: Session properties. + isRequired: true + types: + - + - name: metadata + description: Required. Notebook root-level metadata. + isRequired: true + types: + - + - name: nbformat + description: 'Required. Notebook format (major number). Incremented between backwards + + incompatible changes to the notebook format.' + isRequired: true + types: + - + - name: nbformat_minor + description: 'Required. Notebook format (minor number). Incremented for backward + + compatible changes to the notebook format.' + isRequired: true + types: + - + - name: cells + description: Required. Array of cells of the current notebook. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: metadata + isRequired: true + - name: nbformat + isRequired: true + - name: nbformat_minor + isRequired: true + - name: cells + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: big_data_pool + isRequired: true + - name: session_properties + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.Notebook.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Notebook.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Notebook.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.Notebook.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Notebook.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.Notebook.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Notebook.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCell.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCell.yml new file mode 100644 index 00000000..0843198c --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCell.yml @@ -0,0 +1,165 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.NotebookCell +name: NotebookCell +fullName: azure.synapse.artifacts.models.NotebookCell +module: azure.synapse.artifacts.models +summary: 'Notebook cell. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'NotebookCell(*, cell_type: str, metadata: object, source: List[str], additional_properties: + Dict[str, object] | None = None, attachments: object | None = None, outputs: List[NotebookCellOutputItem] + | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: cell_type + description: Required. String identifying the type of cell. + isRequired: true + types: + - + - name: metadata + description: Required. Cell-level metadata. + isRequired: true + types: + - + - name: source + description: Required. Contents of the cell, represented as an array of lines. + isRequired: true + types: + - [] + - name: attachments + description: Attachments associated with the cell. + isRequired: true + types: + - + - name: outputs + description: Cell-level output items. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: cell_type + isRequired: true + - name: metadata + isRequired: true + - name: source + isRequired: true + - name: additional_properties + isRequired: true + - name: attachments + isRequired: true + - name: outputs + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.NotebookCell.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.NotebookCell.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.NotebookCell.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.NotebookCell.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.NotebookCell.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.NotebookCell.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.NotebookCell.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCellOutputItem.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCellOutputItem.yml new file mode 100644 index 00000000..62c8c23b --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCellOutputItem.yml @@ -0,0 +1,170 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.NotebookCellOutputItem +name: NotebookCellOutputItem +fullName: azure.synapse.artifacts.models.NotebookCellOutputItem +module: azure.synapse.artifacts.models +summary: 'An item of the notebook cell execution output. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'NotebookCellOutputItem(*, output_type: str | CellOutputType, name: str + | None = None, execution_count: int | None = None, text: object | None = None, + data: object | None = None, metadata: object | None = None, **kwargs)' + parameters: + - name: name + description: For output_type=stream, determines the name of stream (stdout / stderr). + isRequired: true + types: + - + - name: execution_count + description: Execution sequence number. + isRequired: true + types: + - + - name: output_type + description: 'Required. Execution, display, or stream outputs. Possible values + include: + + "execute_result", "display_data", "stream", "error".' + isRequired: true + types: + - + - + - name: text + description: 'For output_type=stream, the stream''s text output, represented as + a string or an + + array of strings.' + isRequired: true + types: + - + - name: data + description: Output data. Use MIME type as key, and content as value. + isRequired: true + types: + - + - name: metadata + description: Metadata for the output item. + isRequired: true + types: + - + keywordOnlyParameters: + - name: output_type + isRequired: true + - name: name + isRequired: true + - name: execution_count + isRequired: true + - name: text + isRequired: true + - name: data + isRequired: true + - name: metadata + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.NotebookCellOutputItem.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.NotebookCellOutputItem.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.NotebookCellOutputItem.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.NotebookCellOutputItem.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.NotebookCellOutputItem.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.NotebookCellOutputItem.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.NotebookCellOutputItem.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookKernelSpec.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookKernelSpec.yml new file mode 100644 index 00000000..88b280f3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookKernelSpec.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.NotebookKernelSpec +name: NotebookKernelSpec +fullName: azure.synapse.artifacts.models.NotebookKernelSpec +module: azure.synapse.artifacts.models +summary: 'Kernel information. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'NotebookKernelSpec(*, name: str, display_name: str, additional_properties: + Dict[str, object] | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Name of the kernel specification. + isRequired: true + types: + - + - name: display_name + description: Required. Name to display in UI. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: display_name + isRequired: true + - name: additional_properties + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.NotebookKernelSpec.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.NotebookKernelSpec.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.NotebookKernelSpec.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.NotebookKernelSpec.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.NotebookKernelSpec.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.NotebookKernelSpec.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.NotebookKernelSpec.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookLanguageInfo.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookLanguageInfo.yml new file mode 100644 index 00000000..83950bfb --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookLanguageInfo.yml @@ -0,0 +1,143 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.NotebookLanguageInfo +name: NotebookLanguageInfo +fullName: azure.synapse.artifacts.models.NotebookLanguageInfo +module: azure.synapse.artifacts.models +summary: 'Language info. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'NotebookLanguageInfo(*, name: str, additional_properties: Dict[str, object] + | None = None, codemirror_mode: str | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. The programming language which this kernel runs. + isRequired: true + types: + - + - name: codemirror_mode + description: The codemirror mode to use for code in this language. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: additional_properties + isRequired: true + - name: codemirror_mode + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.NotebookLanguageInfo.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.NotebookLanguageInfo.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.NotebookLanguageInfo.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.NotebookLanguageInfo.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.NotebookLanguageInfo.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.NotebookLanguageInfo.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.NotebookLanguageInfo.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookListResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookListResponse.yml new file mode 100644 index 00000000..866b656d --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookListResponse.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.NotebookListResponse +name: NotebookListResponse +fullName: azure.synapse.artifacts.models.NotebookListResponse +module: azure.synapse.artifacts.models +summary: 'A list of Notebook resources. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'NotebookListResponse(*, value: List[NotebookResource], next_link: str | + None = None, **kwargs)' + parameters: + - name: value + description: Required. List of Notebooks. + isRequired: true + types: + - [] + - name: next_link + description: The link to the next page of results, if any remaining results exist. + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: next_link + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.NotebookListResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.NotebookListResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.NotebookListResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.NotebookListResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.NotebookListResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.NotebookListResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.NotebookListResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookMetadata.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookMetadata.yml new file mode 100644 index 00000000..ac7d10b7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookMetadata.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.NotebookMetadata +name: NotebookMetadata +fullName: azure.synapse.artifacts.models.NotebookMetadata +module: azure.synapse.artifacts.models +summary: Notebook root-level metadata. +constructor: + syntax: 'NotebookMetadata(*, additional_properties: Dict[str, object] | None = None, + kernelspec: NotebookKernelSpec | None = None, language_info: NotebookLanguageInfo + | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: kernelspec + description: Kernel information. + isRequired: true + types: + - + - name: language_info + description: Language info. + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: kernelspec + isRequired: true + - name: language_info + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.NotebookMetadata.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.NotebookMetadata.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.NotebookMetadata.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.NotebookMetadata.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.NotebookMetadata.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.NotebookMetadata.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.NotebookMetadata.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookResource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookResource.yml new file mode 100644 index 00000000..9a598d2a --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookResource.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.NotebookResource +name: NotebookResource +fullName: azure.synapse.artifacts.models.NotebookResource +module: azure.synapse.artifacts.models +summary: 'Notebook resource type. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'NotebookResource(*, properties: Notebook, **kwargs)' + parameters: + - name: properties + description: Required. Properties of Notebook. + isRequired: true + types: + - + keywordOnlyParameters: + - name: properties + isRequired: true +variables: +- description: The resource identifier. + name: id + types: + - +- description: The resource name. + name: name + types: + - +- description: The resource type. + name: type + types: + - +- description: Etag identifies change in the resource. + name: etag + types: + - +methods: +- uid: azure.synapse.artifacts.models.NotebookResource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.NotebookResource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.NotebookResource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.NotebookResource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.NotebookResource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.NotebookResource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.NotebookResource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookSessionProperties.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookSessionProperties.yml new file mode 100644 index 00000000..24ad3650 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookSessionProperties.yml @@ -0,0 +1,155 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.NotebookSessionProperties +name: NotebookSessionProperties +fullName: azure.synapse.artifacts.models.NotebookSessionProperties +module: azure.synapse.artifacts.models +summary: 'Session properties. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'NotebookSessionProperties(*, driver_memory: str, driver_cores: int, executor_memory: + str, executor_cores: int, num_executors: int, **kwargs)' + parameters: + - name: driver_memory + description: Required. Amount of memory to use for the driver process. + isRequired: true + types: + - + - name: driver_cores + description: Required. Number of cores to use for the driver. + isRequired: true + types: + - + - name: executor_memory + description: Required. Amount of memory to use per executor process. + isRequired: true + types: + - + - name: executor_cores + description: Required. Number of cores to use for each executor. + isRequired: true + types: + - + - name: num_executors + description: Required. Number of executors to launch for this session. + isRequired: true + types: + - + keywordOnlyParameters: + - name: driver_memory + isRequired: true + - name: driver_cores + isRequired: true + - name: executor_memory + isRequired: true + - name: executor_cores + isRequired: true + - name: num_executors + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.NotebookSessionProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.NotebookSessionProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.NotebookSessionProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.NotebookSessionProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.NotebookSessionProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.NotebookSessionProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.NotebookSessionProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataAadServicePrincipalCredentialType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataAadServicePrincipalCredentialType.yml new file mode 100644 index 00000000..3ccd7385 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataAadServicePrincipalCredentialType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.ODataAadServicePrincipalCredentialType +name: ODataAadServicePrincipalCredentialType +fullName: azure.synapse.artifacts.models.ODataAadServicePrincipalCredentialType +summary: Specify the credential type (key or cert) is used for service principal. +module: azure.synapse.artifacts.models +fields: +- name: service_principal_cert + uid: azure.synapse.artifacts.models.ODataAadServicePrincipalCredentialType.service_principal_cert +- name: service_principal_key + uid: azure.synapse.artifacts.models.ODataAadServicePrincipalCredentialType.service_principal_key diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataAuthenticationType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataAuthenticationType.yml new file mode 100644 index 00000000..0ffa4a4a --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataAuthenticationType.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.ODataAuthenticationType +name: ODataAuthenticationType +fullName: azure.synapse.artifacts.models.ODataAuthenticationType +summary: Type of authentication used to connect to the OData service. +module: azure.synapse.artifacts.models +fields: +- name: aad_service_principal + uid: azure.synapse.artifacts.models.ODataAuthenticationType.aad_service_principal +- name: anonymous + uid: azure.synapse.artifacts.models.ODataAuthenticationType.anonymous +- name: basic + uid: azure.synapse.artifacts.models.ODataAuthenticationType.basic +- name: managed_service_identity + uid: azure.synapse.artifacts.models.ODataAuthenticationType.managed_service_identity +- name: windows + uid: azure.synapse.artifacts.models.ODataAuthenticationType.windows diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataLinkedService.yml new file mode 100644 index 00000000..9ca15bee --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataLinkedService.yml @@ -0,0 +1,293 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ODataLinkedService +name: ODataLinkedService +fullName: azure.synapse.artifacts.models.ODataLinkedService +module: azure.synapse.artifacts.models +summary: 'Open Data Protocol (OData) linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ODataLinkedService(*, url: object, additional_properties: Dict[str, object] + | None = None, connect_via: IntegrationRuntimeReference | None = None, description: + str | None = None, parameters: Dict[str, ParameterSpecification] | None = None, + annotations: List[object] | None = None, authentication_type: str | ODataAuthenticationType + | None = None, user_name: object | None = None, password: SecretBase | None = + None, tenant: object | None = None, service_principal_id: object | None = None, + aad_resource_id: object | None = None, aad_service_principal_credential_type: + str | ODataAadServicePrincipalCredentialType | None = None, service_principal_key: + SecretBase | None = None, service_principal_embedded_cert: SecretBase | None = + None, service_principal_embedded_cert_password: SecretBase | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: url + description: 'Required. The URL of the OData service endpoint. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + - name: authentication_type + description: 'Type of authentication used to connect to the OData service. + + Possible values include: "Basic", "Anonymous", "Windows", "AadServicePrincipal", + + "ManagedServiceIdentity".' + isRequired: true + types: + - + - + - name: user_name + description: 'User name of the OData service. Type: string (or Expression with + resultType + + string).' + isRequired: true + types: + - + - name: password + description: Password of the OData service. + isRequired: true + types: + - + - name: tenant + description: 'Specify the tenant information (domain name or tenant ID) under + which your + + application resides. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: service_principal_id + description: 'Specify the application id of your application registered in Azure + + Active Directory. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: aad_resource_id + description: 'Specify the resource you are requesting authorization to use Directory. + + Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: aad_service_principal_credential_type + description: 'Specify the credential type (key or cert) is used + + for service principal. Possible values include: "ServicePrincipalKey", "ServicePrincipalCert".' + isRequired: true + types: + - + - + - name: service_principal_key + description: 'Specify the secret of your application registered in Azure Active + + Directory. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: service_principal_embedded_cert + description: 'Specify the base64 encoded certificate of your + + application registered in Azure Active Directory. Type: string (or Expression + with resultType + + string).' + isRequired: true + types: + - + - name: service_principal_embedded_cert_password + description: 'Specify the password of your certificate if + + your certificate has a password and you are using AadServicePrincipal authentication. + Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: url + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: authentication_type + isRequired: true + - name: user_name + isRequired: true + - name: password + isRequired: true + - name: tenant + isRequired: true + - name: service_principal_id + isRequired: true + - name: aad_resource_id + isRequired: true + - name: aad_service_principal_credential_type + isRequired: true + - name: service_principal_key + isRequired: true + - name: service_principal_embedded_cert + isRequired: true + - name: service_principal_embedded_cert_password + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ODataLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ODataLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ODataLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ODataLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ODataLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ODataLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ODataLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataResourceDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataResourceDataset.yml new file mode 100644 index 00000000..ca562863 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataResourceDataset.yml @@ -0,0 +1,203 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ODataResourceDataset +name: ODataResourceDataset +fullName: azure.synapse.artifacts.models.ODataResourceDataset +module: azure.synapse.artifacts.models +summary: 'The Open Data Protocol (OData) resource dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ODataResourceDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, path: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: path + description: 'The OData resource path. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: path + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ODataResourceDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ODataResourceDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ODataResourceDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ODataResourceDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ODataResourceDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ODataResourceDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ODataResourceDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcLinkedService.yml new file mode 100644 index 00000000..85712a12 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcLinkedService.yml @@ -0,0 +1,227 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.OdbcLinkedService +name: OdbcLinkedService +fullName: azure.synapse.artifacts.models.OdbcLinkedService +module: azure.synapse.artifacts.models +summary: 'Open Database Connectivity (ODBC) linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'OdbcLinkedService(*, connection_string: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, authentication_type: object + | None = None, credential: SecretBase | None = None, user_name: object | None + = None, password: SecretBase | None = None, encrypted_credential: object | None + = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'Required. The non-access credential portion of the connection string + + as well as an optional encrypted credential. Type: string, SecureString or + + AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: authentication_type + description: 'Type of authentication used to connect to the ODBC data store. + + Possible values are: Anonymous and Basic. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: credential + description: 'The access credential portion of the connection string specified + in driver- + + specific property-value format.' + isRequired: true + types: + - + - name: user_name + description: 'User name for Basic authentication. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: password + description: Password for Basic authentication. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: connection_string + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: authentication_type + isRequired: true + - name: credential + isRequired: true + - name: user_name + isRequired: true + - name: password + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.OdbcLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.OdbcLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.OdbcLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.OdbcLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.OdbcLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.OdbcLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.OdbcLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcTableDataset.yml new file mode 100644 index 00000000..433ba289 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcTableDataset.yml @@ -0,0 +1,203 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.OdbcTableDataset +name: OdbcTableDataset +fullName: azure.synapse.artifacts.models.OdbcTableDataset +module: azure.synapse.artifacts.models +summary: 'The ODBC table dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'OdbcTableDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The ODBC table name. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.OdbcTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.OdbcTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.OdbcTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.OdbcTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.OdbcTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.OdbcTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.OdbcTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365Dataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365Dataset.yml new file mode 100644 index 00000000..924c6f3f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365Dataset.yml @@ -0,0 +1,216 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.Office365Dataset +name: Office365Dataset +fullName: azure.synapse.artifacts.models.Office365Dataset +module: azure.synapse.artifacts.models +summary: 'The Office365 account. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Office365Dataset(*, linked_service_name: LinkedServiceReference, table_name: + object, additional_properties: Dict[str, object] | None = None, description: str + | None = None, structure: object | None = None, schema: object | None = None, + parameters: Dict[str, ParameterSpecification] | None = None, annotations: List[object] + | None = None, folder: DatasetFolder | None = None, predicate: object | None = + None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'Required. Name of the dataset to extract from Office 365. Type: + string (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: predicate + description: 'A predicate expression that can be used to filter the specific rows + to + + extract from Office 365. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: table_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: predicate + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.Office365Dataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Office365Dataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Office365Dataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.Office365Dataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Office365Dataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.Office365Dataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Office365Dataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365LinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365LinkedService.yml new file mode 100644 index 00000000..bf891fe0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365LinkedService.yml @@ -0,0 +1,213 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.Office365LinkedService +name: Office365LinkedService +fullName: azure.synapse.artifacts.models.Office365LinkedService +module: azure.synapse.artifacts.models +summary: 'Office365 linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Office365LinkedService(*, office365_tenant_id: object, service_principal_tenant_id: + object, service_principal_id: object, service_principal_key: SecretBase, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: office365_tenant_id + description: 'Required. Azure tenant ID to which the Office 365 account belongs. + + Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: service_principal_tenant_id + description: 'Required. Specify the tenant information under which your + + Azure AD web application resides. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: service_principal_id + description: 'Required. Specify the application''s client ID. Type: string (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: service_principal_key + description: Required. Specify the application's key. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: office365_tenant_id + isRequired: true + - name: service_principal_tenant_id + isRequired: true + - name: service_principal_id + isRequired: true + - name: service_principal_key + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.Office365LinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Office365LinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Office365LinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.Office365LinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Office365LinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.Office365LinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Office365LinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleLinkedService.yml new file mode 100644 index 00000000..aee2e629 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleLinkedService.yml @@ -0,0 +1,193 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.OracleLinkedService +name: OracleLinkedService +fullName: azure.synapse.artifacts.models.OracleLinkedService +module: azure.synapse.artifacts.models +summary: 'Oracle database. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'OracleLinkedService(*, connection_string: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, password: AzureKeyVaultSecretReference + | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'Required. The connection string. Type: string, SecureString or + + AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: password + description: The Azure key vault secret reference of password in connection string. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: connection_string + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: password + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.OracleLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.OracleLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.OracleLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.OracleLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.OracleLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.OracleLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.OracleLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudLinkedService.yml new file mode 100644 index 00000000..258e7e5d --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudLinkedService.yml @@ -0,0 +1,238 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.OracleServiceCloudLinkedService +name: OracleServiceCloudLinkedService +fullName: azure.synapse.artifacts.models.OracleServiceCloudLinkedService +module: azure.synapse.artifacts.models +summary: 'Oracle Service Cloud linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'OracleServiceCloudLinkedService(*, host: object, username: object, password: + SecretBase, additional_properties: Dict[str, object] | None = None, connect_via: + IntegrationRuntimeReference | None = None, description: str | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, use_encrypted_endpoints: object | None = None, use_host_verification: + object | None = None, use_peer_verification: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: host + description: Required. The URL of the Oracle Service Cloud instance. + isRequired: true + types: + - + - name: username + description: Required. The user name that you use to access Oracle Service Cloud + server. + isRequired: true + types: + - + - name: password + description: 'Required. The password corresponding to the user name that you provided + in the + + username key.' + isRequired: true + types: + - + - name: use_encrypted_endpoints + description: 'Specifies whether the data source endpoints are encrypted using + + HTTPS. The default value is true. Type: boolean (or Expression with resultType + boolean).' + isRequired: true + types: + - + - name: use_host_verification + description: 'Specifies whether to require the host name in the server''s + + certificate to match the host name of the server when connecting over SSL. The + default value is + + true. Type: boolean (or Expression with resultType boolean).' + isRequired: true + types: + - + - name: use_peer_verification + description: 'Specifies whether to verify the identity of the server when + + connecting over SSL. The default value is true. Type: boolean (or Expression + with resultType + + boolean).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: host + isRequired: true + - name: username + isRequired: true + - name: password + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: use_encrypted_endpoints + isRequired: true + - name: use_host_verification + isRequired: true + - name: use_peer_verification + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.OracleServiceCloudLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.OracleServiceCloudLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.OracleServiceCloudLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.OracleServiceCloudLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.OracleServiceCloudLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.OracleServiceCloudLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.OracleServiceCloudLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudObjectDataset.yml new file mode 100644 index 00000000..06d9210d --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudObjectDataset.yml @@ -0,0 +1,203 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.OracleServiceCloudObjectDataset +name: OracleServiceCloudObjectDataset +fullName: azure.synapse.artifacts.models.OracleServiceCloudObjectDataset +module: azure.synapse.artifacts.models +summary: 'Oracle Service Cloud dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'OracleServiceCloudObjectDataset(*, linked_service_name: LinkedServiceReference, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, structure: object | None = None, schema: object | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, folder: DatasetFolder | None = None, table_name: object | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.OracleServiceCloudObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.OracleServiceCloudObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.OracleServiceCloudObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.OracleServiceCloudObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.OracleServiceCloudObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.OracleServiceCloudObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.OracleServiceCloudObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleTableDataset.yml new file mode 100644 index 00000000..4923c75f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleTableDataset.yml @@ -0,0 +1,224 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.OracleTableDataset +name: OracleTableDataset +fullName: azure.synapse.artifacts.models.OracleTableDataset +module: azure.synapse.artifacts.models +summary: 'The on-premises Oracle database dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'OracleTableDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, schema_type_properties_schema: + object | None = None, table: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'This property will be retired. Please consider using schema + table + + properties instead.' + isRequired: true + types: + - + - name: schema_type_properties_schema + description: 'The schema name of the on-premises Oracle database. Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: table + description: 'The table name of the on-premises Oracle database. Type: string + (or Expression + + with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true + - name: schema_type_properties_schema + isRequired: true + - name: table + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.OracleTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.OracleTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.OracleTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.OracleTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.OracleTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.OracleTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.OracleTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcCompressionCodec.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcCompressionCodec.yml new file mode 100644 index 00000000..a6f7e784 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcCompressionCodec.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.OrcCompressionCodec +name: OrcCompressionCodec +fullName: azure.synapse.artifacts.models.OrcCompressionCodec +module: azure.synapse.artifacts.models +fields: +- name: none + uid: azure.synapse.artifacts.models.OrcCompressionCodec.none +- name: snappy + uid: azure.synapse.artifacts.models.OrcCompressionCodec.snappy +- name: zlib + uid: azure.synapse.artifacts.models.OrcCompressionCodec.zlib diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcDataset.yml new file mode 100644 index 00000000..ea48e658 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcDataset.yml @@ -0,0 +1,211 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.OrcDataset +name: OrcDataset +fullName: azure.synapse.artifacts.models.OrcDataset +module: azure.synapse.artifacts.models +summary: 'ORC dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'OrcDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, location: DatasetLocation | None = None, orc_compression_codec: + str | OrcCompressionCodec | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: location + description: The location of the ORC data storage. + isRequired: true + types: + - + - name: orc_compression_codec + description: 'Possible values include: "none", "zlib", "snappy".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: location + isRequired: true + - name: orc_compression_codec + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.OrcDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.OrcDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.OrcDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.OrcDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.OrcDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.OrcDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.OrcDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParameterSpecification.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParameterSpecification.yml new file mode 100644 index 00000000..a74d3d7b --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParameterSpecification.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ParameterSpecification +name: ParameterSpecification +fullName: azure.synapse.artifacts.models.ParameterSpecification +module: azure.synapse.artifacts.models +summary: 'Definition of a single parameter for an entity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ParameterSpecification(*, type: str | ParameterType, default_value: object + | None = None, **kwargs)' + parameters: + - name: type + description: 'Required. Parameter type. Possible values include: "Object", "String", + "Int", + + "Float", "Bool", "Array", "SecureString".' + isRequired: true + types: + - + - + - name: default_value + description: Default value of parameter. + isRequired: true + types: + - + keywordOnlyParameters: + - name: type + isRequired: true + - name: default_value + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ParameterSpecification.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ParameterSpecification.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ParameterSpecification.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ParameterSpecification.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ParameterSpecification.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ParameterSpecification.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ParameterSpecification.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParameterType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParameterType.yml new file mode 100644 index 00000000..4c089bfd --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParameterType.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.ParameterType +name: ParameterType +fullName: azure.synapse.artifacts.models.ParameterType +summary: Parameter type. +module: azure.synapse.artifacts.models +fields: +- name: array + uid: azure.synapse.artifacts.models.ParameterType.array +- name: bool + uid: azure.synapse.artifacts.models.ParameterType.bool +- name: float + uid: azure.synapse.artifacts.models.ParameterType.float +- name: int + uid: azure.synapse.artifacts.models.ParameterType.int +- name: object + uid: azure.synapse.artifacts.models.ParameterType.object +- name: secure_string + uid: azure.synapse.artifacts.models.ParameterType.secure_string +- name: string + uid: azure.synapse.artifacts.models.ParameterType.string diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetCompressionCodec.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetCompressionCodec.yml new file mode 100644 index 00000000..cf306e42 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetCompressionCodec.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.ParquetCompressionCodec +name: ParquetCompressionCodec +fullName: azure.synapse.artifacts.models.ParquetCompressionCodec +module: azure.synapse.artifacts.models +fields: +- name: gzip + uid: azure.synapse.artifacts.models.ParquetCompressionCodec.gzip +- name: lzo + uid: azure.synapse.artifacts.models.ParquetCompressionCodec.lzo +- name: none + uid: azure.synapse.artifacts.models.ParquetCompressionCodec.none +- name: snappy + uid: azure.synapse.artifacts.models.ParquetCompressionCodec.snappy diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetDataset.yml new file mode 100644 index 00000000..09e0143e --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetDataset.yml @@ -0,0 +1,211 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ParquetDataset +name: ParquetDataset +fullName: azure.synapse.artifacts.models.ParquetDataset +module: azure.synapse.artifacts.models +summary: 'Parquet dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ParquetDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, location: DatasetLocation | None = None, compression_codec: str + | ParquetCompressionCodec | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: location + description: The location of the parquet storage. + isRequired: true + types: + - + - name: compression_codec + description: 'Possible values include: "none", "gzip", "snappy", "lzo".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: location + isRequired: true + - name: compression_codec + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ParquetDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ParquetDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ParquetDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ParquetDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ParquetDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ParquetDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ParquetDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalLinkedService.yml new file mode 100644 index 00000000..50243cb4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalLinkedService.yml @@ -0,0 +1,230 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.PaypalLinkedService +name: PaypalLinkedService +fullName: azure.synapse.artifacts.models.PaypalLinkedService +module: azure.synapse.artifacts.models +summary: 'Paypal Service linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PaypalLinkedService(*, host: object, client_id: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, client_secret: SecretBase + | None = None, use_encrypted_endpoints: object | None = None, use_host_verification: + object | None = None, use_peer_verification: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: host + description: "Required. The URL\_of the PayPal instance. (i.e. api.sandbox.paypal.com)." + isRequired: true + types: + - + - name: client_id + description: Required. The client ID associated with your PayPal application. + isRequired: true + types: + - + - name: client_secret + description: The client secret associated with your PayPal application. + isRequired: true + types: + - + - name: use_encrypted_endpoints + description: 'Specifies whether the data source endpoints are encrypted using + + HTTPS. The default value is true.' + isRequired: true + types: + - + - name: use_host_verification + description: 'Specifies whether to require the host name in the server''s + + certificate to match the host name of the server when connecting over SSL. The + default value is + + true.' + isRequired: true + types: + - + - name: use_peer_verification + description: 'Specifies whether to verify the identity of the server when + + connecting over SSL. The default value is true.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: host + isRequired: true + - name: client_id + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: client_secret + isRequired: true + - name: use_encrypted_endpoints + isRequired: true + - name: use_host_verification + isRequired: true + - name: use_peer_verification + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.PaypalLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PaypalLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PaypalLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.PaypalLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PaypalLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.PaypalLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PaypalLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalObjectDataset.yml new file mode 100644 index 00000000..3a31175e --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalObjectDataset.yml @@ -0,0 +1,202 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.PaypalObjectDataset +name: PaypalObjectDataset +fullName: azure.synapse.artifacts.models.PaypalObjectDataset +module: azure.synapse.artifacts.models +summary: 'Paypal Service dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PaypalObjectDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.PaypalObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PaypalObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PaypalObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.PaypalObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PaypalObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.PaypalObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PaypalObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixAuthenticationType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixAuthenticationType.yml new file mode 100644 index 00000000..714f1264 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixAuthenticationType.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.PhoenixAuthenticationType +name: PhoenixAuthenticationType +fullName: azure.synapse.artifacts.models.PhoenixAuthenticationType +summary: The authentication mechanism used to connect to the Phoenix server. +module: azure.synapse.artifacts.models +fields: +- name: anonymous + uid: azure.synapse.artifacts.models.PhoenixAuthenticationType.anonymous +- name: username_and_password + uid: azure.synapse.artifacts.models.PhoenixAuthenticationType.username_and_password +- name: windows_azure_hd_insight_service + uid: azure.synapse.artifacts.models.PhoenixAuthenticationType.windows_azure_hd_insight_service diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixLinkedService.yml new file mode 100644 index 00000000..1cb7705c --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixLinkedService.yml @@ -0,0 +1,289 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.PhoenixLinkedService +name: PhoenixLinkedService +fullName: azure.synapse.artifacts.models.PhoenixLinkedService +module: azure.synapse.artifacts.models +summary: 'Phoenix server linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PhoenixLinkedService(*, host: object, authentication_type: str | PhoenixAuthenticationType, + additional_properties: Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference + | None = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, port: object | None = + None, http_path: object | None = None, username: object | None = None, password: + SecretBase | None = None, enable_ssl: object | None = None, trusted_cert_path: + object | None = None, use_system_trust_store: object | None = None, allow_host_name_cn_mismatch: + object | None = None, allow_self_signed_server_cert: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: host + description: 'Required. The IP address or host name of the Phoenix server. (i.e. + + 192.168.222.160).' + isRequired: true + types: + - + - name: port + description: 'The TCP port that the Phoenix server uses to listen for client connections. + The + + default value is 8765.' + isRequired: true + types: + - + - name: http_path + description: 'The partial URL corresponding to the Phoenix server. (i.e. + + /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using + + WindowsAzureHDInsightService.' + isRequired: true + types: + - + - name: authentication_type + description: 'Required. The authentication mechanism used to connect to the + + Phoenix server. Possible values include: "Anonymous", "UsernameAndPassword", + + "WindowsAzureHDInsightService".' + isRequired: true + types: + - + - + - name: username + description: The user name used to connect to the Phoenix server. + isRequired: true + types: + - + - name: password + description: The password corresponding to the user name. + isRequired: true + types: + - + - name: enable_ssl + description: 'Specifies whether the connections to the server are encrypted using + SSL. The + + default value is false.' + isRequired: true + types: + - + - name: trusted_cert_path + description: 'The full path of the .pem file containing trusted CA certificates + for + + verifying the server when connecting over SSL. This property can only be set + when using SSL on + + self-hosted IR. The default value is the cacerts.pem file installed with the + IR.' + isRequired: true + types: + - + - name: use_system_trust_store + description: 'Specifies whether to use a CA certificate from the system trust + + store or from a specified PEM file. The default value is false.' + isRequired: true + types: + - + - name: allow_host_name_cn_mismatch + description: 'Specifies whether to require a CA-issued SSL certificate + + name to match the host name of the server when connecting over SSL. The default + value is false.' + isRequired: true + types: + - + - name: allow_self_signed_server_cert + description: 'Specifies whether to allow self-signed certificates from + + the server. The default value is false.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: host + isRequired: true + - name: authentication_type + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: port + isRequired: true + - name: http_path + isRequired: true + - name: username + isRequired: true + - name: password + isRequired: true + - name: enable_ssl + isRequired: true + - name: trusted_cert_path + isRequired: true + - name: use_system_trust_store + isRequired: true + - name: allow_host_name_cn_mismatch + isRequired: true + - name: allow_self_signed_server_cert + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.PhoenixLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PhoenixLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PhoenixLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.PhoenixLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PhoenixLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.PhoenixLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PhoenixLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixObjectDataset.yml new file mode 100644 index 00000000..064881e6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixObjectDataset.yml @@ -0,0 +1,224 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.PhoenixObjectDataset +name: PhoenixObjectDataset +fullName: azure.synapse.artifacts.models.PhoenixObjectDataset +module: azure.synapse.artifacts.models +summary: 'Phoenix server dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PhoenixObjectDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, table: object | None = None, + schema_type_properties_schema: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'This property will be retired. Please consider using schema + table + + properties instead.' + isRequired: true + types: + - + - name: table + description: 'The table name of the Phoenix. Type: string (or Expression with + resultType + + string).' + isRequired: true + types: + - + - name: schema_type_properties_schema + description: 'The schema name of the Phoenix. Type: string (or + + Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true + - name: table + isRequired: true + - name: schema_type_properties_schema + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.PhoenixObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PhoenixObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PhoenixObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.PhoenixObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PhoenixObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.PhoenixObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PhoenixObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineFolder.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineFolder.yml new file mode 100644 index 00000000..efe61e9c --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineFolder.yml @@ -0,0 +1,124 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.PipelineFolder +name: PipelineFolder +fullName: azure.synapse.artifacts.models.PipelineFolder +module: azure.synapse.artifacts.models +summary: The folder that this Pipeline is in. If not specified, Pipeline will appear + at the root level. +constructor: + syntax: 'PipelineFolder(*, name: str | None = None, **kwargs)' + parameters: + - name: name + description: The name of the folder that this Pipeline is in. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.PipelineFolder.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PipelineFolder.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PipelineFolder.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.PipelineFolder.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PipelineFolder.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.PipelineFolder.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PipelineFolder.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineListResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineListResponse.yml new file mode 100644 index 00000000..54b5f7ea --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineListResponse.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.PipelineListResponse +name: PipelineListResponse +fullName: azure.synapse.artifacts.models.PipelineListResponse +module: azure.synapse.artifacts.models +summary: 'A list of pipeline resources. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PipelineListResponse(*, value: List[PipelineResource], next_link: str | + None = None, **kwargs)' + parameters: + - name: value + description: Required. List of pipelines. + isRequired: true + types: + - [] + - name: next_link + description: The link to the next page of results, if any remaining results exist. + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: next_link + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.PipelineListResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PipelineListResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PipelineListResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.PipelineListResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PipelineListResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.PipelineListResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PipelineListResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineReference.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineReference.yml new file mode 100644 index 00000000..940685ee --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineReference.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.PipelineReference +name: PipelineReference +fullName: azure.synapse.artifacts.models.PipelineReference +module: azure.synapse.artifacts.models +summary: 'Pipeline reference type. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PipelineReference(*, reference_name: str, name: str | None = None, **kwargs)' + parameters: + - name: reference_name + description: Required. Reference pipeline name. + isRequired: true + types: + - + - name: name + description: Reference name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: reference_name + isRequired: true + - name: name + isRequired: true +variables: +- description: 'Required. Pipeline reference type. Default value: "PipelineReference".' + name: type + types: + - +methods: +- uid: azure.synapse.artifacts.models.PipelineReference.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PipelineReference.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PipelineReference.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.PipelineReference.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PipelineReference.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.PipelineReference.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PipelineReference.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +attributes: +- uid: azure.synapse.artifacts.models.PipelineReference.type + name: type + signature: type = 'PipelineReference' diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineResource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineResource.yml new file mode 100644 index 00000000..eb789d6a --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineResource.yml @@ -0,0 +1,209 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.PipelineResource +name: PipelineResource +fullName: azure.synapse.artifacts.models.PipelineResource +module: azure.synapse.artifacts.models +summary: 'Pipeline resource type. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'PipelineResource(*, additional_properties: Dict[str, object] | None = None, + description: str | None = None, activities: List[Activity] | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, variables: Dict[str, VariableSpecification] + | None = None, concurrency: int | None = None, annotations: List[object] | None + = None, run_dimensions: Dict[str, object] | None = None, folder: PipelineFolder + | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: description + description: The description of the pipeline. + isRequired: true + types: + - + - name: activities + description: List of activities in pipeline. + isRequired: true + types: + - [] + - name: parameters + description: List of parameters for pipeline. + isRequired: true + types: + - [, ] + - name: variables + description: List of variables for pipeline. + isRequired: true + types: + - [, ] + - name: concurrency + description: The max number of concurrent runs for the pipeline. + isRequired: true + types: + - + - name: annotations + description: List of tags that can be used for describing the Pipeline. + isRequired: true + types: + - [] + - name: run_dimensions + description: Dimensions emitted by Pipeline. + isRequired: true + types: + - [, ] + - name: folder + description: 'The folder that this Pipeline is in. If not specified, Pipeline + will appear at + + the root level.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: activities + isRequired: true + - name: parameters + isRequired: true + - name: variables + isRequired: true + - name: concurrency + isRequired: true + - name: annotations + isRequired: true + - name: run_dimensions + isRequired: true + - name: folder + isRequired: true +variables: +- description: The resource identifier. + name: id + types: + - +- description: The resource name. + name: name + types: + - +- description: The resource type. + name: type + types: + - +- description: Etag identifies change in the resource. + name: etag + types: + - +methods: +- uid: azure.synapse.artifacts.models.PipelineResource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PipelineResource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PipelineResource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.PipelineResource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PipelineResource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.PipelineResource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PipelineResource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRun.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRun.yml new file mode 100644 index 00000000..1e19e34f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRun.yml @@ -0,0 +1,181 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.PipelineRun +name: PipelineRun +fullName: azure.synapse.artifacts.models.PipelineRun +module: azure.synapse.artifacts.models +summary: 'Information about a pipeline run. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'PipelineRun(*, additional_properties: Dict[str, object] | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: additional_properties + isRequired: true +variables: +- description: Identifier of a run. + name: run_id + types: + - +- description: Identifier that correlates all the recovery runs of a pipeline run. + name: run_group_id + types: + - +- description: Indicates if the recovered pipeline run is the latest in its group. + name: is_latest + types: + - +- description: The pipeline name. + name: pipeline_name + types: + - +- description: 'The full or partial list of parameter name, value pair used in the + pipeline + + run.' + name: parameters + types: + - [, ] +- description: Entity that started the pipeline run. + name: invoked_by + types: + - +- description: The last updated timestamp for the pipeline run event in ISO8601 format. + name: last_updated + types: + - +- description: The start time of a pipeline run in ISO8601 format. + name: run_start + types: + - +- description: The end time of a pipeline run in ISO8601 format. + name: run_end + types: + - +- description: The duration of a pipeline run. + name: duration_in_ms + types: + - +- description: The status of a pipeline run. + name: status + types: + - +- description: The message from a pipeline run. + name: message + types: + - +methods: +- uid: azure.synapse.artifacts.models.PipelineRun.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PipelineRun.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PipelineRun.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.PipelineRun.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PipelineRun.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.PipelineRun.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PipelineRun.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRunInvokedBy.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRunInvokedBy.yml new file mode 100644 index 00000000..b40114fc --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRunInvokedBy.yml @@ -0,0 +1,130 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.PipelineRunInvokedBy +name: PipelineRunInvokedBy +fullName: azure.synapse.artifacts.models.PipelineRunInvokedBy +module: azure.synapse.artifacts.models +summary: 'Provides entity name and id that started the pipeline run. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: PipelineRunInvokedBy(**kwargs) +variables: +- description: Name of the entity that started the pipeline run. + name: name + types: + - +- description: The ID of the entity that started the run. + name: id + types: + - +- description: The type of the entity that started the run. + name: invoked_by_type + types: + - +methods: +- uid: azure.synapse.artifacts.models.PipelineRunInvokedBy.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PipelineRunInvokedBy.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PipelineRunInvokedBy.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.PipelineRunInvokedBy.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PipelineRunInvokedBy.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.PipelineRunInvokedBy.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PipelineRunInvokedBy.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRunsQueryResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRunsQueryResponse.yml new file mode 100644 index 00000000..5cf77bb3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRunsQueryResponse.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.PipelineRunsQueryResponse +name: PipelineRunsQueryResponse +fullName: azure.synapse.artifacts.models.PipelineRunsQueryResponse +module: azure.synapse.artifacts.models +summary: 'A list pipeline runs. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PipelineRunsQueryResponse(*, value: List[PipelineRun], continuation_token: + str | None = None, **kwargs)' + parameters: + - name: value + description: Required. List of pipeline runs. + isRequired: true + types: + - [] + - name: continuation_token + description: 'The continuation token for getting the next page of results, if + any + + remaining results exist, null otherwise.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: continuation_token + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.PipelineRunsQueryResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PipelineRunsQueryResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PipelineRunsQueryResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.PipelineRunsQueryResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PipelineRunsQueryResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.PipelineRunsQueryResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PipelineRunsQueryResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PluginCurrentState.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PluginCurrentState.yml new file mode 100644 index 00000000..964b6e50 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PluginCurrentState.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.PluginCurrentState +name: PluginCurrentState +fullName: azure.synapse.artifacts.models.PluginCurrentState +module: azure.synapse.artifacts.models +fields: +- name: cleanup + uid: azure.synapse.artifacts.models.PluginCurrentState.cleanup +- name: ended + uid: azure.synapse.artifacts.models.PluginCurrentState.ended +- name: monitoring + uid: azure.synapse.artifacts.models.PluginCurrentState.monitoring +- name: preparation + uid: azure.synapse.artifacts.models.PluginCurrentState.preparation +- name: queued + uid: azure.synapse.artifacts.models.PluginCurrentState.queued +- name: resource_acquisition + uid: azure.synapse.artifacts.models.PluginCurrentState.resource_acquisition +- name: submission + uid: azure.synapse.artifacts.models.PluginCurrentState.submission diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlLinkedService.yml new file mode 100644 index 00000000..79517939 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlLinkedService.yml @@ -0,0 +1,191 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.PostgreSqlLinkedService +name: PostgreSqlLinkedService +fullName: azure.synapse.artifacts.models.PostgreSqlLinkedService +module: azure.synapse.artifacts.models +summary: 'Linked service for PostgreSQL data source. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PostgreSqlLinkedService(*, connection_string: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, password: AzureKeyVaultSecretReference + | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: Required. The connection string. + isRequired: true + types: + - + - name: password + description: The Azure key vault secret reference of password in connection string. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: connection_string + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: password + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.PostgreSqlLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PostgreSqlLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PostgreSqlLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.PostgreSqlLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PostgreSqlLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.PostgreSqlLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PostgreSqlLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlTableDataset.yml new file mode 100644 index 00000000..000a2299 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlTableDataset.yml @@ -0,0 +1,223 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.PostgreSqlTableDataset +name: PostgreSqlTableDataset +fullName: azure.synapse.artifacts.models.PostgreSqlTableDataset +module: azure.synapse.artifacts.models +summary: 'The PostgreSQL table dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PostgreSqlTableDataset(*, linked_service_name: LinkedServiceReference, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, structure: object | None = None, schema: object | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, folder: DatasetFolder | None = None, table_name: object | None = None, + table: object | None = None, schema_type_properties_schema: object | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'This property will be retired. Please consider using schema + table + + properties instead.' + isRequired: true + types: + - + - name: table + description: 'The PostgreSQL table name. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: schema_type_properties_schema + description: 'The PostgreSQL schema name. Type: string (or Expression + + with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true + - name: table + isRequired: true + - name: schema_type_properties_schema + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.PostgreSqlTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PostgreSqlTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PostgreSqlTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.PostgreSqlTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PostgreSqlTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.PostgreSqlTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PostgreSqlTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoAuthenticationType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoAuthenticationType.yml new file mode 100644 index 00000000..a639ce90 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoAuthenticationType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.PrestoAuthenticationType +name: PrestoAuthenticationType +fullName: azure.synapse.artifacts.models.PrestoAuthenticationType +summary: The authentication mechanism used to connect to the Presto server. +module: azure.synapse.artifacts.models +fields: +- name: anonymous + uid: azure.synapse.artifacts.models.PrestoAuthenticationType.anonymous +- name: ldap + uid: azure.synapse.artifacts.models.PrestoAuthenticationType.ldap diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoLinkedService.yml new file mode 100644 index 00000000..5a009be0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoLinkedService.yml @@ -0,0 +1,302 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.PrestoLinkedService +name: PrestoLinkedService +fullName: azure.synapse.artifacts.models.PrestoLinkedService +module: azure.synapse.artifacts.models +summary: 'Presto server linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PrestoLinkedService(*, host: object, server_version: object, catalog: object, + authentication_type: str | PrestoAuthenticationType, additional_properties: Dict[str, + object] | None = None, connect_via: IntegrationRuntimeReference | None = None, + description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, port: object | None = + None, username: object | None = None, password: SecretBase | None = None, enable_ssl: + object | None = None, trusted_cert_path: object | None = None, use_system_trust_store: + object | None = None, allow_host_name_cn_mismatch: object | None = None, allow_self_signed_server_cert: + object | None = None, time_zone_id: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: host + description: 'Required. The IP address or host name of the Presto server. (i.e. + + 192.168.222.160).' + isRequired: true + types: + - + - name: server_version + description: Required. The version of the Presto server. (i.e. 0.148-t). + isRequired: true + types: + - + - name: catalog + description: Required. The catalog context for all request against the server. + isRequired: true + types: + - + - name: port + description: 'The TCP port that the Presto server uses to listen for client connections. + The + + default value is 8080.' + isRequired: true + types: + - + - name: authentication_type + description: 'Required. The authentication mechanism used to connect to the + + Presto server. Possible values include: "Anonymous", "LDAP".' + isRequired: true + types: + - + - + - name: username + description: The user name used to connect to the Presto server. + isRequired: true + types: + - + - name: password + description: The password corresponding to the user name. + isRequired: true + types: + - + - name: enable_ssl + description: 'Specifies whether the connections to the server are encrypted using + SSL. The + + default value is false.' + isRequired: true + types: + - + - name: trusted_cert_path + description: 'The full path of the .pem file containing trusted CA certificates + for + + verifying the server when connecting over SSL. This property can only be set + when using SSL on + + self-hosted IR. The default value is the cacerts.pem file installed with the + IR.' + isRequired: true + types: + - + - name: use_system_trust_store + description: 'Specifies whether to use a CA certificate from the system trust + + store or from a specified PEM file. The default value is false.' + isRequired: true + types: + - + - name: allow_host_name_cn_mismatch + description: 'Specifies whether to require a CA-issued SSL certificate + + name to match the host name of the server when connecting over SSL. The default + value is false.' + isRequired: true + types: + - + - name: allow_self_signed_server_cert + description: 'Specifies whether to allow self-signed certificates from + + the server. The default value is false.' + isRequired: true + types: + - + - name: time_zone_id + description: 'The local time zone used by the connection. Valid values for this + option + + are specified in the IANA Time Zone Database. The default value is the system + time zone.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: host + isRequired: true + - name: server_version + isRequired: true + - name: catalog + isRequired: true + - name: authentication_type + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: port + isRequired: true + - name: username + isRequired: true + - name: password + isRequired: true + - name: enable_ssl + isRequired: true + - name: trusted_cert_path + isRequired: true + - name: use_system_trust_store + isRequired: true + - name: allow_host_name_cn_mismatch + isRequired: true + - name: allow_self_signed_server_cert + isRequired: true + - name: time_zone_id + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.PrestoLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PrestoLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PrestoLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.PrestoLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PrestoLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.PrestoLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PrestoLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoObjectDataset.yml new file mode 100644 index 00000000..f34e3098 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoObjectDataset.yml @@ -0,0 +1,223 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.PrestoObjectDataset +name: PrestoObjectDataset +fullName: azure.synapse.artifacts.models.PrestoObjectDataset +module: azure.synapse.artifacts.models +summary: 'Presto server dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'PrestoObjectDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, table: object | None = None, + schema_type_properties_schema: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'This property will be retired. Please consider using schema + table + + properties instead.' + isRequired: true + types: + - + - name: table + description: 'The table name of the Presto. Type: string (or Expression with resultType + + string).' + isRequired: true + types: + - + - name: schema_type_properties_schema + description: 'The schema name of the Presto. Type: string (or + + Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true + - name: table + isRequired: true + - name: schema_type_properties_schema + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.PrestoObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PrestoObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PrestoObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.PrestoObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.PrestoObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.PrestoObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.PrestoObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse.yml new file mode 100644 index 00000000..023f1fb6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse +name: QueryDataFlowDebugSessionsResponse +fullName: azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse +module: azure.synapse.artifacts.models +summary: A list of active debug sessions. +constructor: + syntax: 'QueryDataFlowDebugSessionsResponse(*, value: List[DataFlowDebugSessionInfo] + | None = None, next_link: str | None = None, **kwargs)' + parameters: + - name: value + description: Array with all active debug sessions. + isRequired: true + types: + - [] + - name: next_link + description: The link to the next page of results, if any remaining results exist. + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: next_link + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksLinkedService.yml new file mode 100644 index 00000000..4c18056e --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksLinkedService.yml @@ -0,0 +1,232 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.QuickBooksLinkedService +name: QuickBooksLinkedService +fullName: azure.synapse.artifacts.models.QuickBooksLinkedService +module: azure.synapse.artifacts.models +summary: 'QuickBooks server linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'QuickBooksLinkedService(*, endpoint: object, company_id: object, consumer_key: + object, consumer_secret: SecretBase, access_token: SecretBase, access_token_secret: + SecretBase, additional_properties: Dict[str, object] | None = None, connect_via: + IntegrationRuntimeReference | None = None, description: str | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, use_encrypted_endpoints: object | None = None, encrypted_credential: object + | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: endpoint + description: 'Required. The endpoint of the QuickBooks server. (i.e. + + quickbooks.api.intuit.com).' + isRequired: true + types: + - + - name: company_id + description: Required. The company ID of the QuickBooks company to authorize. + isRequired: true + types: + - + - name: consumer_key + description: Required. The consumer key for OAuth 1.0 authentication. + isRequired: true + types: + - + - name: consumer_secret + description: Required. The consumer secret for OAuth 1.0 authentication. + isRequired: true + types: + - + - name: access_token + description: Required. The access token for OAuth 1.0 authentication. + isRequired: true + types: + - + - name: access_token_secret + description: Required. The access token secret for OAuth 1.0 authentication. + isRequired: true + types: + - + - name: use_encrypted_endpoints + description: 'Specifies whether the data source endpoints are encrypted using + + HTTPS. The default value is true.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: endpoint + isRequired: true + - name: company_id + isRequired: true + - name: consumer_key + isRequired: true + - name: consumer_secret + isRequired: true + - name: access_token + isRequired: true + - name: access_token_secret + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: use_encrypted_endpoints + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.QuickBooksLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.QuickBooksLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.QuickBooksLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.QuickBooksLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.QuickBooksLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.QuickBooksLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.QuickBooksLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksObjectDataset.yml new file mode 100644 index 00000000..aeb32976 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksObjectDataset.yml @@ -0,0 +1,203 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.QuickBooksObjectDataset +name: QuickBooksObjectDataset +fullName: azure.synapse.artifacts.models.QuickBooksObjectDataset +module: azure.synapse.artifacts.models +summary: 'QuickBooks server dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'QuickBooksObjectDataset(*, linked_service_name: LinkedServiceReference, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, structure: object | None = None, schema: object | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, folder: DatasetFolder | None = None, table_name: object | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.QuickBooksObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.QuickBooksObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.QuickBooksObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.QuickBooksObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.QuickBooksObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.QuickBooksObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.QuickBooksObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RedirectIncompatibleRowSettings.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RedirectIncompatibleRowSettings.yml new file mode 100644 index 00000000..745c053f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RedirectIncompatibleRowSettings.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.RedirectIncompatibleRowSettings +name: RedirectIncompatibleRowSettings +fullName: azure.synapse.artifacts.models.RedirectIncompatibleRowSettings +module: azure.synapse.artifacts.models +summary: 'Redirect incompatible row settings. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RedirectIncompatibleRowSettings(*, linked_service_name: object, additional_properties: + Dict[str, object] | None = None, path: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: linked_service_name + description: 'Required. Name of the Azure Storage, Storage SAS, or Azure Data + + Lake Store linked service used for redirecting incompatible row. Must be specified + if + + redirectIncompatibleRowSettings is specified. Type: string (or Expression with + resultType + + string).' + isRequired: true + types: + - + - name: path + description: 'The path for storing the redirect incompatible row data. Type: string + (or + + Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: path + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.RedirectIncompatibleRowSettings.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.RedirectIncompatibleRowSettings.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.RedirectIncompatibleRowSettings.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.RedirectIncompatibleRowSettings.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.RedirectIncompatibleRowSettings.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.RedirectIncompatibleRowSettings.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.RedirectIncompatibleRowSettings.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RelationalTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RelationalTableDataset.yml new file mode 100644 index 00000000..209c014c --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RelationalTableDataset.yml @@ -0,0 +1,205 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.RelationalTableDataset +name: RelationalTableDataset +fullName: azure.synapse.artifacts.models.RelationalTableDataset +module: azure.synapse.artifacts.models +summary: 'The relational table dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RelationalTableDataset(*, linked_service_name: LinkedServiceReference, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, structure: object | None = None, schema: object | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, folder: DatasetFolder | None = None, table_name: object | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The relational table name. Type: string (or Expression with resultType + + string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.RelationalTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.RelationalTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.RelationalTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.RelationalTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.RelationalTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.RelationalTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.RelationalTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTriggerListResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTriggerListResponse.yml new file mode 100644 index 00000000..c8df7b38 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTriggerListResponse.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.RerunTriggerListResponse +name: RerunTriggerListResponse +fullName: azure.synapse.artifacts.models.RerunTriggerListResponse +module: azure.synapse.artifacts.models +summary: 'A list of rerun triggers. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RerunTriggerListResponse(*, value: List[RerunTriggerResource], **kwargs)' + parameters: + - name: value + description: Required. List of rerun triggers. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: value + isRequired: true +variables: +- description: 'The continuation token for getting the next page of results, if any + remaining + + results exist, null otherwise.' + name: next_link + types: + - +methods: +- uid: azure.synapse.artifacts.models.RerunTriggerListResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.RerunTriggerListResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.RerunTriggerListResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.RerunTriggerListResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.RerunTriggerListResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.RerunTriggerListResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.RerunTriggerListResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTriggerResource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTriggerResource.yml new file mode 100644 index 00000000..740b09da --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTriggerResource.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.RerunTriggerResource +name: RerunTriggerResource +fullName: azure.synapse.artifacts.models.RerunTriggerResource +module: azure.synapse.artifacts.models +summary: 'RerunTrigger resource type. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RerunTriggerResource(*, properties: RerunTumblingWindowTrigger, **kwargs)' + parameters: + - name: properties + description: Required. Properties of the rerun trigger. + isRequired: true + types: + - + keywordOnlyParameters: + - name: properties + isRequired: true +variables: +- description: The resource identifier. + name: id + types: + - +- description: The resource name. + name: name + types: + - +- description: The resource type. + name: type + types: + - +- description: Etag identifies change in the resource. + name: etag + types: + - +methods: +- uid: azure.synapse.artifacts.models.RerunTriggerResource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.RerunTriggerResource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.RerunTriggerResource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.RerunTriggerResource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.RerunTriggerResource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.RerunTriggerResource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.RerunTriggerResource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTumblingWindowTrigger.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTumblingWindowTrigger.yml new file mode 100644 index 00000000..e5ee0fa8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTumblingWindowTrigger.yml @@ -0,0 +1,198 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.RerunTumblingWindowTrigger +name: RerunTumblingWindowTrigger +fullName: azure.synapse.artifacts.models.RerunTumblingWindowTrigger +module: azure.synapse.artifacts.models +summary: 'Trigger that schedules pipeline reruns for all fixed time interval windows + from a requested start time to requested end time. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RerunTumblingWindowTrigger(*, requested_start_time: datetime, requested_end_time: + datetime, max_concurrency: int, additional_properties: Dict[str, object] | None + = None, description: str | None = None, annotations: List[object] | None = None, + parent_trigger: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Trigger type.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Trigger description. + isRequired: true + types: + - + - name: annotations + description: List of tags that can be used for describing the trigger. + isRequired: true + types: + - [] + - name: parent_trigger + description: The parent trigger reference. + isRequired: true + types: + - + - name: requested_start_time + description: 'Required. The start time for the time period for which restatement + + is initiated. Only UTC time is currently supported.' + isRequired: true + types: + - + - name: requested_end_time + description: 'Required. The end time for the time period for which restatement + is + + initiated. Only UTC time is currently supported.' + isRequired: true + types: + - + - name: max_concurrency + description: 'Required. The max number of parallel time windows (ready for execution) + + for which a rerun is triggered.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: requested_start_time + isRequired: true + - name: requested_end_time + isRequired: true + - name: max_concurrency + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: annotations + isRequired: true + - name: parent_trigger + isRequired: true +variables: +- description: 'Indicates if trigger is running or not. Updated when Start/Stop APIs + are + + called on the Trigger. Possible values include: "Started", "Stopped", "Disabled".' + name: runtime_state + types: + - + - +methods: +- uid: azure.synapse.artifacts.models.RerunTumblingWindowTrigger.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.RerunTumblingWindowTrigger.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.RerunTumblingWindowTrigger.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.RerunTumblingWindowTrigger.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.RerunTumblingWindowTrigger.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.RerunTumblingWindowTrigger.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.RerunTumblingWindowTrigger.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTumblingWindowTriggerActionParameters.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTumblingWindowTriggerActionParameters.yml new file mode 100644 index 00000000..b7e61a14 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTumblingWindowTriggerActionParameters.yml @@ -0,0 +1,149 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.RerunTumblingWindowTriggerActionParameters +name: RerunTumblingWindowTriggerActionParameters +fullName: azure.synapse.artifacts.models.RerunTumblingWindowTriggerActionParameters +module: azure.synapse.artifacts.models +summary: 'Rerun tumbling window trigger Parameters. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RerunTumblingWindowTriggerActionParameters(*, start_time: datetime, end_time: + datetime, max_concurrency: int, **kwargs)' + parameters: + - name: start_time + description: 'Required. The start time for the time period for which restatement + is + + initiated. Only UTC time is currently supported.' + isRequired: true + types: + - + - name: end_time + description: 'Required. The end time for the time period for which restatement + is initiated. + + Only UTC time is currently supported.' + isRequired: true + types: + - + - name: max_concurrency + description: 'Required. The max number of parallel time windows (ready for execution) + + for which a rerun is triggered.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: start_time + isRequired: true + - name: end_time + isRequired: true + - name: max_concurrency + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.RerunTumblingWindowTriggerActionParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.RerunTumblingWindowTriggerActionParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.RerunTumblingWindowTriggerActionParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.RerunTumblingWindowTriggerActionParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.RerunTumblingWindowTriggerActionParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.RerunTumblingWindowTriggerActionParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.RerunTumblingWindowTriggerActionParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Resource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Resource.yml new file mode 100644 index 00000000..f87a748f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Resource.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.Resource +name: Resource +fullName: azure.synapse.artifacts.models.Resource +module: azure.synapse.artifacts.models +summary: 'Azure Synapse top-level resource. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'Resource(*, location: str | None = None, tags: Dict[str, str] | None = + None, **kwargs)' + parameters: + - name: location + description: The resource location. + isRequired: true + types: + - + - name: tags + description: A set of tags. The resource tags. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: location + isRequired: true + - name: tags + isRequired: true +variables: +- description: The resource identifier. + name: id + types: + - +- description: The resource name. + name: name + types: + - +- description: The resource type. + name: type + types: + - +- description: Etag identifies change in the resource. + name: e_tag + types: + - +methods: +- uid: azure.synapse.artifacts.models.Resource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Resource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Resource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.Resource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Resource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.Resource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Resource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysLinkedService.yml new file mode 100644 index 00000000..6a66b922 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysLinkedService.yml @@ -0,0 +1,240 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ResponsysLinkedService +name: ResponsysLinkedService +fullName: azure.synapse.artifacts.models.ResponsysLinkedService +module: azure.synapse.artifacts.models +summary: 'Responsys linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ResponsysLinkedService(*, endpoint: object, client_id: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, client_secret: SecretBase + | None = None, use_encrypted_endpoints: object | None = None, use_host_verification: + object | None = None, use_peer_verification: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: endpoint + description: Required. The endpoint of the Responsys server. + isRequired: true + types: + - + - name: client_id + description: 'Required. The client ID associated with the Responsys application. + Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: client_secret + description: 'The client secret associated with the Responsys application. Type: + string + + (or Expression with resultType string).' + isRequired: true + types: + - + - name: use_encrypted_endpoints + description: 'Specifies whether the data source endpoints are encrypted using + + HTTPS. The default value is true. Type: boolean (or Expression with resultType + boolean).' + isRequired: true + types: + - + - name: use_host_verification + description: 'Specifies whether to require the host name in the server''s + + certificate to match the host name of the server when connecting over SSL. The + default value is + + true. Type: boolean (or Expression with resultType boolean).' + isRequired: true + types: + - + - name: use_peer_verification + description: 'Specifies whether to verify the identity of the server when + + connecting over SSL. The default value is true. Type: boolean (or Expression + with resultType + + boolean).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: endpoint + isRequired: true + - name: client_id + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: client_secret + isRequired: true + - name: use_encrypted_endpoints + isRequired: true + - name: use_host_verification + isRequired: true + - name: use_peer_verification + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ResponsysLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ResponsysLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ResponsysLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ResponsysLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ResponsysLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ResponsysLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ResponsysLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysObjectDataset.yml new file mode 100644 index 00000000..6fdaacc8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysObjectDataset.yml @@ -0,0 +1,203 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ResponsysObjectDataset +name: ResponsysObjectDataset +fullName: azure.synapse.artifacts.models.ResponsysObjectDataset +module: azure.synapse.artifacts.models +summary: 'Responsys dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ResponsysObjectDataset(*, linked_service_name: LinkedServiceReference, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, structure: object | None = None, schema: object | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, folder: DatasetFolder | None = None, table_name: object | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ResponsysObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ResponsysObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ResponsysObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ResponsysObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ResponsysObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ResponsysObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ResponsysObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestResourceDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestResourceDataset.yml new file mode 100644 index 00000000..137b917e --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestResourceDataset.yml @@ -0,0 +1,246 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.RestResourceDataset +name: RestResourceDataset +fullName: azure.synapse.artifacts.models.RestResourceDataset +module: azure.synapse.artifacts.models +summary: 'A Rest service dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RestResourceDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, relative_url: object | None = None, request_method: object | None + = None, request_body: object | None = None, additional_headers: object | None + = None, pagination_rules: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: relative_url + description: 'The relative URL to the resource that the RESTful API provides. + Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: request_method + description: 'The HTTP method used to call the RESTful API. The default is GET. + Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: request_body + description: 'The HTTP request body to the RESTful API if requestMethod is POST. + Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: additional_headers + description: 'The additional HTTP headers in the request to the RESTful API. Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: pagination_rules + description: 'The pagination rules to compose next page requests. Type: string + (or + + Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: relative_url + isRequired: true + - name: request_method + isRequired: true + - name: request_body + isRequired: true + - name: additional_headers + isRequired: true + - name: pagination_rules + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.RestResourceDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.RestResourceDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.RestResourceDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.RestResourceDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.RestResourceDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.RestResourceDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.RestResourceDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestServiceAuthenticationType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestServiceAuthenticationType.yml new file mode 100644 index 00000000..270df26e --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestServiceAuthenticationType.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.RestServiceAuthenticationType +name: RestServiceAuthenticationType +fullName: azure.synapse.artifacts.models.RestServiceAuthenticationType +summary: Type of authentication used to connect to the REST service. +module: azure.synapse.artifacts.models +fields: +- name: aad_service_principal + uid: azure.synapse.artifacts.models.RestServiceAuthenticationType.aad_service_principal +- name: anonymous + uid: azure.synapse.artifacts.models.RestServiceAuthenticationType.anonymous +- name: basic + uid: azure.synapse.artifacts.models.RestServiceAuthenticationType.basic +- name: managed_service_identity + uid: azure.synapse.artifacts.models.RestServiceAuthenticationType.managed_service_identity diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestServiceLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestServiceLinkedService.yml new file mode 100644 index 00000000..72b8135e --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestServiceLinkedService.yml @@ -0,0 +1,259 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.RestServiceLinkedService +name: RestServiceLinkedService +fullName: azure.synapse.artifacts.models.RestServiceLinkedService +module: azure.synapse.artifacts.models +summary: 'Rest Service linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RestServiceLinkedService(*, url: object, authentication_type: str | RestServiceAuthenticationType, + additional_properties: Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference + | None = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, enable_server_certificate_validation: + object | None = None, user_name: object | None = None, password: SecretBase | + None = None, service_principal_id: object | None = None, service_principal_key: + SecretBase | None = None, tenant: object | None = None, aad_resource_id: object + | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: url + description: Required. The base URL of the REST service. + isRequired: true + types: + - + - name: enable_server_certificate_validation + description: 'Whether to validate server side SSL certificate + + when connecting to the endpoint.The default value is true. Type: boolean (or + Expression with + + resultType boolean).' + isRequired: true + types: + - + - name: authentication_type + description: 'Required. Type of authentication used to connect to the REST + + service. Possible values include: "Anonymous", "Basic", "AadServicePrincipal", + + "ManagedServiceIdentity".' + isRequired: true + types: + - + - + - name: user_name + description: The user name used in Basic authentication type. + isRequired: true + types: + - + - name: password + description: The password used in Basic authentication type. + isRequired: true + types: + - + - name: service_principal_id + description: 'The application''s client ID used in AadServicePrincipal + + authentication type.' + isRequired: true + types: + - + - name: service_principal_key + description: 'The application''s key used in AadServicePrincipal authentication + + type.' + isRequired: true + types: + - + - name: tenant + description: 'The tenant information (domain name or tenant ID) used in AadServicePrincipal + + authentication type under which your application resides.' + isRequired: true + types: + - + - name: aad_resource_id + description: The resource you are requesting authorization to use. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: url + isRequired: true + - name: authentication_type + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: enable_server_certificate_validation + isRequired: true + - name: user_name + isRequired: true + - name: password + isRequired: true + - name: service_principal_id + isRequired: true + - name: service_principal_key + isRequired: true + - name: tenant + isRequired: true + - name: aad_resource_id + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.RestServiceLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.RestServiceLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.RestServiceLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.RestServiceLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.RestServiceLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.RestServiceLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.RestServiceLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunFilterParameters.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunFilterParameters.yml new file mode 100644 index 00000000..d3174352 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunFilterParameters.yml @@ -0,0 +1,163 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.RunFilterParameters +name: RunFilterParameters +fullName: azure.synapse.artifacts.models.RunFilterParameters +module: azure.synapse.artifacts.models +summary: 'Query parameters for listing runs. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RunFilterParameters(*, last_updated_after: datetime, last_updated_before: + datetime, continuation_token: str | None = None, filters: List[RunQueryFilter] + | None = None, order_by: List[RunQueryOrderBy] | None = None, **kwargs)' + parameters: + - name: continuation_token + description: 'The continuation token for getting the next page of results. Null + + for first page.' + isRequired: true + types: + - + - name: last_updated_after + description: 'Required. The time at or after which the run event was updated in + + ''ISO 8601'' format.' + isRequired: true + types: + - + - name: last_updated_before + description: 'Required. The time at or before which the run event was updated + in + + ''ISO 8601'' format.' + isRequired: true + types: + - + - name: filters + description: List of filters. + isRequired: true + types: + - [] + - name: order_by + description: List of OrderBy option. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: last_updated_after + isRequired: true + - name: last_updated_before + isRequired: true + - name: continuation_token + isRequired: true + - name: filters + isRequired: true + - name: order_by + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.RunFilterParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.RunFilterParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.RunFilterParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.RunFilterParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.RunFilterParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.RunFilterParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.RunFilterParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilter.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilter.yml new file mode 100644 index 00000000..f248e52b --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilter.yml @@ -0,0 +1,160 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.RunQueryFilter +name: RunQueryFilter +fullName: azure.synapse.artifacts.models.RunQueryFilter +module: azure.synapse.artifacts.models +summary: 'Query filter option for listing runs. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RunQueryFilter(*, operand: str | RunQueryFilterOperand, operator: str | + RunQueryFilterOperator, values: List[str], **kwargs)' + parameters: + - name: operand + description: 'Required. Parameter name to be used for filter. The allowed operands + to query + + pipeline runs are PipelineName, RunStart, RunEnd and Status; to query activity + runs are + + ActivityName, ActivityRunStart, ActivityRunEnd, ActivityType and Status, and + to query trigger + + runs are TriggerName, TriggerRunTimestamp and Status. Possible values include: + "PipelineName", + + "Status", "RunStart", "RunEnd", "ActivityName", "ActivityRunStart", "ActivityRunEnd", + + "ActivityType", "TriggerName", "TriggerRunTimestamp", "RunGroupId", "LatestOnly".' + isRequired: true + types: + - + - + - name: operator + description: 'Required. Operator to be used for filter. Possible values include: + "Equals", + + "NotEquals", "In", "NotIn".' + isRequired: true + types: + - + - + - name: values + description: Required. List of filter values. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: operand + isRequired: true + - name: operator + isRequired: true + - name: values + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.RunQueryFilter.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.RunQueryFilter.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.RunQueryFilter.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.RunQueryFilter.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.RunQueryFilter.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.RunQueryFilter.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.RunQueryFilter.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilterOperand.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilterOperand.yml new file mode 100644 index 00000000..c29c4e59 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilterOperand.yml @@ -0,0 +1,39 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.RunQueryFilterOperand +name: RunQueryFilterOperand +fullName: azure.synapse.artifacts.models.RunQueryFilterOperand +summary: 'Parameter name to be used for filter. The allowed operands to query pipeline + runs are + + PipelineName, RunStart, RunEnd and Status; to query activity runs are ActivityName, + + ActivityRunStart, ActivityRunEnd, ActivityType and Status, and to query trigger + runs are + + TriggerName, TriggerRunTimestamp and Status.' +module: azure.synapse.artifacts.models +fields: +- name: activity_name + uid: azure.synapse.artifacts.models.RunQueryFilterOperand.activity_name +- name: activity_run_end + uid: azure.synapse.artifacts.models.RunQueryFilterOperand.activity_run_end +- name: activity_run_start + uid: azure.synapse.artifacts.models.RunQueryFilterOperand.activity_run_start +- name: activity_type + uid: azure.synapse.artifacts.models.RunQueryFilterOperand.activity_type +- name: latest_only + uid: azure.synapse.artifacts.models.RunQueryFilterOperand.latest_only +- name: pipeline_name + uid: azure.synapse.artifacts.models.RunQueryFilterOperand.pipeline_name +- name: run_end + uid: azure.synapse.artifacts.models.RunQueryFilterOperand.run_end +- name: run_group_id + uid: azure.synapse.artifacts.models.RunQueryFilterOperand.run_group_id +- name: run_start + uid: azure.synapse.artifacts.models.RunQueryFilterOperand.run_start +- name: status + uid: azure.synapse.artifacts.models.RunQueryFilterOperand.status +- name: trigger_name + uid: azure.synapse.artifacts.models.RunQueryFilterOperand.trigger_name +- name: trigger_run_timestamp + uid: azure.synapse.artifacts.models.RunQueryFilterOperand.trigger_run_timestamp diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilterOperator.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilterOperator.yml new file mode 100644 index 00000000..99a7f408 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryFilterOperator.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.RunQueryFilterOperator +name: RunQueryFilterOperator +fullName: azure.synapse.artifacts.models.RunQueryFilterOperator +summary: Operator to be used for filter. +module: azure.synapse.artifacts.models +fields: +- name: equals + uid: azure.synapse.artifacts.models.RunQueryFilterOperator.equals +- name: in_enum + uid: azure.synapse.artifacts.models.RunQueryFilterOperator.in_enum +- name: not_equals + uid: azure.synapse.artifacts.models.RunQueryFilterOperator.not_equals +- name: not_in + uid: azure.synapse.artifacts.models.RunQueryFilterOperator.not_in diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrder.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrder.yml new file mode 100644 index 00000000..219c836e --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrder.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.RunQueryOrder +name: RunQueryOrder +fullName: azure.synapse.artifacts.models.RunQueryOrder +summary: Sorting order of the parameter. +module: azure.synapse.artifacts.models +fields: +- name: asc + uid: azure.synapse.artifacts.models.RunQueryOrder.asc +- name: desc + uid: azure.synapse.artifacts.models.RunQueryOrder.desc diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrderBy.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrderBy.yml new file mode 100644 index 00000000..9353e3db --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrderBy.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.RunQueryOrderBy +name: RunQueryOrderBy +fullName: azure.synapse.artifacts.models.RunQueryOrderBy +module: azure.synapse.artifacts.models +summary: 'An object to provide order by options for listing runs. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'RunQueryOrderBy(*, order_by: str | RunQueryOrderByField, order: str | RunQueryOrder, + **kwargs)' + parameters: + - name: order_by + description: 'Required. Parameter name to be used for order by. The allowed parameters + to + + order by for pipeline runs are PipelineName, RunStart, RunEnd and Status; for + activity runs are + + ActivityName, ActivityRunStart, ActivityRunEnd and Status; for trigger runs + are TriggerName, + + TriggerRunTimestamp and Status. Possible values include: "RunStart", "RunEnd", + "PipelineName", + + "Status", "ActivityName", "ActivityRunStart", "ActivityRunEnd", "TriggerName", + + "TriggerRunTimestamp".' + isRequired: true + types: + - + - + - name: order + description: 'Required. Sorting order of the parameter. Possible values include: + "ASC", "DESC".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: order_by + isRequired: true + - name: order + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.RunQueryOrderBy.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.RunQueryOrderBy.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.RunQueryOrderBy.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.RunQueryOrderBy.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.RunQueryOrderBy.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.RunQueryOrderBy.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.RunQueryOrderBy.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrderByField.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrderByField.yml new file mode 100644 index 00000000..22958f94 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunQueryOrderByField.yml @@ -0,0 +1,32 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.RunQueryOrderByField +name: RunQueryOrderByField +fullName: azure.synapse.artifacts.models.RunQueryOrderByField +summary: 'Parameter name to be used for order by. The allowed parameters to order + by for pipeline runs + + are PipelineName, RunStart, RunEnd and Status; for activity runs are ActivityName, + + ActivityRunStart, ActivityRunEnd and Status; for trigger runs are TriggerName, + + TriggerRunTimestamp and Status.' +module: azure.synapse.artifacts.models +fields: +- name: activity_name + uid: azure.synapse.artifacts.models.RunQueryOrderByField.activity_name +- name: activity_run_end + uid: azure.synapse.artifacts.models.RunQueryOrderByField.activity_run_end +- name: activity_run_start + uid: azure.synapse.artifacts.models.RunQueryOrderByField.activity_run_start +- name: pipeline_name + uid: azure.synapse.artifacts.models.RunQueryOrderByField.pipeline_name +- name: run_end + uid: azure.synapse.artifacts.models.RunQueryOrderByField.run_end +- name: run_start + uid: azure.synapse.artifacts.models.RunQueryOrderByField.run_start +- name: status + uid: azure.synapse.artifacts.models.RunQueryOrderByField.status +- name: trigger_name + uid: azure.synapse.artifacts.models.RunQueryOrderByField.trigger_name +- name: trigger_run_timestamp + uid: azure.synapse.artifacts.models.RunQueryOrderByField.trigger_run_timestamp diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISAccessCredential.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISAccessCredential.yml new file mode 100644 index 00000000..35bca338 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISAccessCredential.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SSISAccessCredential +name: SSISAccessCredential +fullName: azure.synapse.artifacts.models.SSISAccessCredential +module: azure.synapse.artifacts.models +summary: 'SSIS access credential. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SSISAccessCredential(*, domain: object, user_name: object, password: SecretBase, + **kwargs)' + parameters: + - name: domain + description: Required. Domain for windows authentication. + isRequired: true + types: + - + - name: user_name + description: Required. UseName for windows authentication. + isRequired: true + types: + - + - name: password + description: Required. Password for windows authentication. + isRequired: true + types: + - + keywordOnlyParameters: + - name: domain + isRequired: true + - name: user_name + isRequired: true + - name: password + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SSISAccessCredential.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SSISAccessCredential.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SSISAccessCredential.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SSISAccessCredential.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SSISAccessCredential.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SSISAccessCredential.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SSISAccessCredential.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISChildPackage.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISChildPackage.yml new file mode 100644 index 00000000..e9909d63 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISChildPackage.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SSISChildPackage +name: SSISChildPackage +fullName: azure.synapse.artifacts.models.SSISChildPackage +module: azure.synapse.artifacts.models +summary: 'SSIS embedded child package. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SSISChildPackage(*, package_path: object, package_content: object, package_name: + str | None = None, package_last_modified_date: str | None = None, **kwargs)' + parameters: + - name: package_path + description: 'Required. Path for embedded child package. Type: string (or Expression + + with resultType string).' + isRequired: true + types: + - + - name: package_name + description: Name for embedded child package. + isRequired: true + types: + - + - name: package_content + description: 'Required. Content for embedded child package. Type: string (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: package_last_modified_date + description: Last modified date for embedded child package. + isRequired: true + types: + - + keywordOnlyParameters: + - name: package_path + isRequired: true + - name: package_content + isRequired: true + - name: package_name + isRequired: true + - name: package_last_modified_date + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SSISChildPackage.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SSISChildPackage.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SSISChildPackage.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SSISChildPackage.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SSISChildPackage.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SSISChildPackage.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SSISChildPackage.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISExecutionCredential.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISExecutionCredential.yml new file mode 100644 index 00000000..7fcd2e17 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISExecutionCredential.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SSISExecutionCredential +name: SSISExecutionCredential +fullName: azure.synapse.artifacts.models.SSISExecutionCredential +module: azure.synapse.artifacts.models +summary: 'SSIS package execution credential. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SSISExecutionCredential(*, domain: object, user_name: object, password: + SecureString, **kwargs)' + parameters: + - name: domain + description: Required. Domain for windows authentication. + isRequired: true + types: + - + - name: user_name + description: Required. UseName for windows authentication. + isRequired: true + types: + - + - name: password + description: Required. Password for windows authentication. + isRequired: true + types: + - + keywordOnlyParameters: + - name: domain + isRequired: true + - name: user_name + isRequired: true + - name: password + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SSISExecutionCredential.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SSISExecutionCredential.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SSISExecutionCredential.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SSISExecutionCredential.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SSISExecutionCredential.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SSISExecutionCredential.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SSISExecutionCredential.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISExecutionParameter.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISExecutionParameter.yml new file mode 100644 index 00000000..17ec0bd4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISExecutionParameter.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SSISExecutionParameter +name: SSISExecutionParameter +fullName: azure.synapse.artifacts.models.SSISExecutionParameter +module: azure.synapse.artifacts.models +summary: 'SSIS execution parameter. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SSISExecutionParameter(*, value: object, **kwargs)' + parameters: + - name: value + description: 'Required. SSIS package execution parameter value. Type: string (or + Expression + + with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SSISExecutionParameter.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SSISExecutionParameter.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SSISExecutionParameter.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SSISExecutionParameter.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SSISExecutionParameter.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SSISExecutionParameter.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SSISExecutionParameter.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISLogLocation.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISLogLocation.yml new file mode 100644 index 00000000..27f9fb33 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISLogLocation.yml @@ -0,0 +1,160 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SSISLogLocation +name: SSISLogLocation +fullName: azure.synapse.artifacts.models.SSISLogLocation +module: azure.synapse.artifacts.models +summary: 'SSIS package execution log location. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SSISLogLocation(*, log_path: object, access_credential: SSISAccessCredential + | None = None, log_refresh_interval: object | None = None, **kwargs)' + parameters: + - name: log_path + description: 'Required. The SSIS package execution log path. Type: string (or + Expression + + with resultType string).' + isRequired: true + types: + - + - name: access_credential + description: The package execution log access credential. + isRequired: true + types: + - + - name: log_refresh_interval + description: 'Specifies the interval to refresh log. The default interval is 5 + + minutes. Type: string (or Expression with resultType string), pattern: + + ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: log_path + isRequired: true + - name: access_credential + isRequired: true + - name: log_refresh_interval + isRequired: true +variables: +- description: 'Required. The type of SSIS log location. Default value: "File".' + name: type + types: + - +methods: +- uid: azure.synapse.artifacts.models.SSISLogLocation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SSISLogLocation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SSISLogLocation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SSISLogLocation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SSISLogLocation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SSISLogLocation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SSISLogLocation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +attributes: +- uid: azure.synapse.artifacts.models.SSISLogLocation.type + name: type + signature: type = 'File' diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPackageLocation.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPackageLocation.yml new file mode 100644 index 00000000..f7e5b2cb --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPackageLocation.yml @@ -0,0 +1,194 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SSISPackageLocation +name: SSISPackageLocation +fullName: azure.synapse.artifacts.models.SSISPackageLocation +module: azure.synapse.artifacts.models +summary: SSIS package location. +constructor: + syntax: 'SSISPackageLocation(*, package_path: object | None = None, type: str | + SsisPackageLocationType | None = None, package_password: SecretBase | None = None, + access_credential: SSISAccessCredential | None = None, configuration_path: object + | None = None, package_name: str | None = None, package_content: object | None + = None, package_last_modified_date: str | None = None, child_packages: List[SSISChildPackage] + | None = None, **kwargs)' + parameters: + - name: package_path + description: 'The SSIS package path. Type: string (or Expression with resultType + + string).' + isRequired: true + types: + - + - name: type + description: 'The type of SSIS package location. Possible values include: "SSISDB", + "File", + + "InlinePackage".' + isRequired: true + types: + - + - + - name: package_password + description: Password of the package. + isRequired: true + types: + - + - name: access_credential + description: The package access credential. + isRequired: true + types: + - + - name: configuration_path + description: 'The configuration file of the package execution. Type: string (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: package_name + description: The package name. + isRequired: true + types: + - + - name: package_content + description: 'The embedded package content. Type: string (or Expression with + + resultType string).' + isRequired: true + types: + - + - name: package_last_modified_date + description: The embedded package last modified date. + isRequired: true + types: + - + - name: child_packages + description: The embedded child package list. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: package_path + isRequired: true + - name: type + isRequired: true + - name: package_password + isRequired: true + - name: access_credential + isRequired: true + - name: configuration_path + isRequired: true + - name: package_name + isRequired: true + - name: package_content + isRequired: true + - name: package_last_modified_date + isRequired: true + - name: child_packages + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SSISPackageLocation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SSISPackageLocation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SSISPackageLocation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SSISPackageLocation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SSISPackageLocation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SSISPackageLocation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SSISPackageLocation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPropertyOverride.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPropertyOverride.yml new file mode 100644 index 00000000..76a8fbc5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPropertyOverride.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SSISPropertyOverride +name: SSISPropertyOverride +fullName: azure.synapse.artifacts.models.SSISPropertyOverride +module: azure.synapse.artifacts.models +summary: 'SSIS property override. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SSISPropertyOverride(*, value: object, is_sensitive: bool | None = None, + **kwargs)' + parameters: + - name: value + description: 'Required. SSIS package property override value. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + - name: is_sensitive + description: 'Whether SSIS package property override value is sensitive data. + Value will + + be encrypted in SSISDB if it is true.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: is_sensitive + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SSISPropertyOverride.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SSISPropertyOverride.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SSISPropertyOverride.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SSISPropertyOverride.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SSISPropertyOverride.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SSISPropertyOverride.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SSISPropertyOverride.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceLinkedService.yml new file mode 100644 index 00000000..7b60c987 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceLinkedService.yml @@ -0,0 +1,218 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SalesforceLinkedService +name: SalesforceLinkedService +fullName: azure.synapse.artifacts.models.SalesforceLinkedService +module: azure.synapse.artifacts.models +summary: 'Linked service for Salesforce. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SalesforceLinkedService(*, additional_properties: Dict[str, object] | None + = None, connect_via: IntegrationRuntimeReference | None = None, description: str + | None = None, parameters: Dict[str, ParameterSpecification] | None = None, annotations: + List[object] | None = None, environment_url: object | None = None, username: object + | None = None, password: SecretBase | None = None, security_token: SecretBase + | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: environment_url + description: 'The URL of Salesforce instance. Default is + + ''[https://login.salesforce.com](https://login.salesforce.com)''. To copy data + from sandbox, specify + + ''[https://test.salesforce.com](https://test.salesforce.com)''. To copy data + from custom domain, specify, for example, + + ''[https://[domain].my.salesforce.com](https://[domain].my.salesforce.com)''. + Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: username + description: 'The username for Basic authentication of the Salesforce instance. + Type: string + + (or Expression with resultType string).' + isRequired: true + types: + - + - name: password + description: The password for Basic authentication of the Salesforce instance. + isRequired: true + types: + - + - name: security_token + description: The security token is required to remotely access Salesforce instance. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: environment_url + isRequired: true + - name: username + isRequired: true + - name: password + isRequired: true + - name: security_token + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SalesforceLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SalesforceLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SalesforceLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SalesforceLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SalesforceLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SalesforceLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SalesforceLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService.yml new file mode 100644 index 00000000..8df126ec --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService.yml @@ -0,0 +1,232 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService +name: SalesforceMarketingCloudLinkedService +fullName: azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService +module: azure.synapse.artifacts.models +summary: 'Salesforce Marketing Cloud linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SalesforceMarketingCloudLinkedService(*, client_id: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, client_secret: SecretBase + | None = None, use_encrypted_endpoints: object | None = None, use_host_verification: + object | None = None, use_peer_verification: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: client_id + description: 'Required. The client ID associated with the Salesforce Marketing + Cloud + + application. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: client_secret + description: 'The client secret associated with the Salesforce Marketing Cloud + + application. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: use_encrypted_endpoints + description: 'Specifies whether the data source endpoints are encrypted using + + HTTPS. The default value is true. Type: boolean (or Expression with resultType + boolean).' + isRequired: true + types: + - + - name: use_host_verification + description: 'Specifies whether to require the host name in the server''s + + certificate to match the host name of the server when connecting over SSL. The + default value is + + true. Type: boolean (or Expression with resultType boolean).' + isRequired: true + types: + - + - name: use_peer_verification + description: 'Specifies whether to verify the identity of the server when + + connecting over SSL. The default value is true. Type: boolean (or Expression + with resultType + + boolean).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: client_id + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: client_secret + isRequired: true + - name: use_encrypted_endpoints + isRequired: true + - name: use_host_verification + isRequired: true + - name: use_peer_verification + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset.yml new file mode 100644 index 00000000..af92420a --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset.yml @@ -0,0 +1,203 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset +name: SalesforceMarketingCloudObjectDataset +fullName: azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset +module: azure.synapse.artifacts.models +summary: 'Salesforce Marketing Cloud dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SalesforceMarketingCloudObjectDataset(*, linked_service_name: LinkedServiceReference, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, structure: object | None = None, schema: object | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, folder: DatasetFolder | None = None, table_name: object | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceObjectDataset.yml new file mode 100644 index 00000000..345a01ef --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceObjectDataset.yml @@ -0,0 +1,205 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SalesforceObjectDataset +name: SalesforceObjectDataset +fullName: azure.synapse.artifacts.models.SalesforceObjectDataset +module: azure.synapse.artifacts.models +summary: 'The Salesforce object dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SalesforceObjectDataset(*, linked_service_name: LinkedServiceReference, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, structure: object | None = None, schema: object | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, folder: DatasetFolder | None = None, object_api_name: object | None = + None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: object_api_name + description: 'The Salesforce object API name. Type: string (or Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: object_api_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SalesforceObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SalesforceObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SalesforceObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SalesforceObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SalesforceObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SalesforceObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SalesforceObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService.yml new file mode 100644 index 00000000..ef57f652 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService.yml @@ -0,0 +1,228 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService +name: SalesforceServiceCloudLinkedService +fullName: azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService +module: azure.synapse.artifacts.models +summary: 'Linked service for Salesforce Service Cloud. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SalesforceServiceCloudLinkedService(*, additional_properties: Dict[str, + object] | None = None, connect_via: IntegrationRuntimeReference | None = None, + description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, environment_url: object + | None = None, username: object | None = None, password: SecretBase | None = None, + security_token: SecretBase | None = None, extended_properties: object | None = + None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: environment_url + description: 'The URL of Salesforce Service Cloud instance. Default is + + ''[https://login.salesforce.com](https://login.salesforce.com)''. To copy data + from sandbox, specify + + ''[https://test.salesforce.com](https://test.salesforce.com)''. To copy data + from custom domain, specify, for example, + + ''[https://[domain].my.salesforce.com](https://[domain].my.salesforce.com)''. + Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: username + description: 'The username for Basic authentication of the Salesforce instance. + Type: string + + (or Expression with resultType string).' + isRequired: true + types: + - + - name: password + description: The password for Basic authentication of the Salesforce instance. + isRequired: true + types: + - + - name: security_token + description: The security token is required to remotely access Salesforce instance. + isRequired: true + types: + - + - name: extended_properties + description: 'Extended properties appended to the connection string. Type: string + + (or Expression with resultType string).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: environment_url + isRequired: true + - name: username + isRequired: true + - name: password + isRequired: true + - name: security_token + isRequired: true + - name: extended_properties + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset.yml new file mode 100644 index 00000000..3b015ad8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset.yml @@ -0,0 +1,205 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset +name: SalesforceServiceCloudObjectDataset +fullName: azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset +module: azure.synapse.artifacts.models +summary: 'The Salesforce Service Cloud object dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SalesforceServiceCloudObjectDataset(*, linked_service_name: LinkedServiceReference, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, structure: object | None = None, schema: object | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, folder: DatasetFolder | None = None, object_api_name: object | None = + None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: object_api_name + description: 'The Salesforce Service Cloud object API name. Type: string (or + + Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: object_api_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBWLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBWLinkedService.yml new file mode 100644 index 00000000..3d73df8f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBWLinkedService.yml @@ -0,0 +1,225 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SapBWLinkedService +name: SapBWLinkedService +fullName: azure.synapse.artifacts.models.SapBWLinkedService +module: azure.synapse.artifacts.models +summary: 'SAP Business Warehouse Linked Service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SapBWLinkedService(*, server: object, system_number: object, client_id: + object, additional_properties: Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference + | None = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, user_name: object | None + = None, password: SecretBase | None = None, encrypted_credential: object | None + = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: server + description: 'Required. Host name of the SAP BW instance. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: system_number + description: 'Required. System number of the BW system. (Usually a two-digit decimal + + number represented as a string.) Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: client_id + description: 'Required. Client ID of the client on the BW system. (Usually a three-digit + + decimal number represented as a string) Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: user_name + description: 'Username to access the SAP BW server. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: password + description: Password to access the SAP BW server. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: server + isRequired: true + - name: system_number + isRequired: true + - name: client_id + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: user_name + isRequired: true + - name: password + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SapBWLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapBWLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapBWLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SapBWLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapBWLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SapBWLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapBWLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBwCubeDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBwCubeDataset.yml new file mode 100644 index 00000000..81563e3e --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBwCubeDataset.yml @@ -0,0 +1,195 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SapBwCubeDataset +name: SapBwCubeDataset +fullName: azure.synapse.artifacts.models.SapBwCubeDataset +module: azure.synapse.artifacts.models +summary: 'The SAP BW cube dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SapBwCubeDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SapBwCubeDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapBwCubeDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapBwCubeDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SapBwCubeDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapBwCubeDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SapBwCubeDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapBwCubeDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerLinkedService.yml new file mode 100644 index 00000000..10b741c6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerLinkedService.yml @@ -0,0 +1,208 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SapCloudForCustomerLinkedService +name: SapCloudForCustomerLinkedService +fullName: azure.synapse.artifacts.models.SapCloudForCustomerLinkedService +module: azure.synapse.artifacts.models +summary: 'Linked service for SAP Cloud for Customer. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SapCloudForCustomerLinkedService(*, url: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, username: object | None + = None, password: SecretBase | None = None, encrypted_credential: object | None + = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: url + description: 'Required. The URL of SAP Cloud for Customer OData API. For example, + + ''[[https://[tenantname].crm.ondemand.com/sap/c4c/odata/v1](https://[tenantname].crm.ondemand.com/sap/c4c/odata/v1)]''. + Type: string (or Expression with + + resultType string).' + isRequired: true + types: + - + - name: username + description: 'The username for Basic authentication. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: password + description: The password for Basic authentication. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Either encryptedCredential + or + + username/password must be provided. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: url + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: username + isRequired: true + - name: password + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SapCloudForCustomerLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapCloudForCustomerLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapCloudForCustomerLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SapCloudForCustomerLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapCloudForCustomerLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SapCloudForCustomerLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapCloudForCustomerLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset.yml new file mode 100644 index 00000000..f8397dbc --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset.yml @@ -0,0 +1,205 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset +name: SapCloudForCustomerResourceDataset +fullName: azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset +module: azure.synapse.artifacts.models +summary: 'The path of the SAP Cloud for Customer OData entity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SapCloudForCustomerResourceDataset(*, linked_service_name: LinkedServiceReference, + path: object, additional_properties: Dict[str, object] | None = None, description: + str | None = None, structure: object | None = None, schema: object | None = None, + parameters: Dict[str, ParameterSpecification] | None = None, annotations: List[object] + | None = None, folder: DatasetFolder | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: path + description: 'Required. The path of the SAP Cloud for Customer OData entity. Type: + string (or + + Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: path + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccLinkedService.yml new file mode 100644 index 00000000..ede87b10 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccLinkedService.yml @@ -0,0 +1,207 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SapEccLinkedService +name: SapEccLinkedService +fullName: azure.synapse.artifacts.models.SapEccLinkedService +module: azure.synapse.artifacts.models +summary: 'Linked service for SAP ERP Central Component(SAP ECC). + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SapEccLinkedService(*, url: str, additional_properties: Dict[str, object] + | None = None, connect_via: IntegrationRuntimeReference | None = None, description: + str | None = None, parameters: Dict[str, ParameterSpecification] | None = None, + annotations: List[object] | None = None, username: str | None = None, password: + SecretBase | None = None, encrypted_credential: str | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: url + description: 'Required. The URL of SAP ECC OData API. For example, + + ''[[https://hostname:port/sap/opu/odata/sap/servicename/](https://hostname:port/sap/opu/odata/sap/servicename/)]''. + Type: string (or Expression with + + resultType string).' + isRequired: true + types: + - + - name: username + description: 'The username for Basic authentication. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: password + description: The password for Basic authentication. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Either encryptedCredential + or + + username/password must be provided. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: url + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: username + isRequired: true + - name: password + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SapEccLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapEccLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapEccLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SapEccLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapEccLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SapEccLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapEccLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccResourceDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccResourceDataset.yml new file mode 100644 index 00000000..9ca8e99a --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccResourceDataset.yml @@ -0,0 +1,205 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SapEccResourceDataset +name: SapEccResourceDataset +fullName: azure.synapse.artifacts.models.SapEccResourceDataset +module: azure.synapse.artifacts.models +summary: 'The path of the SAP ECC OData entity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SapEccResourceDataset(*, linked_service_name: LinkedServiceReference, path: + object, additional_properties: Dict[str, object] | None = None, description: str + | None = None, structure: object | None = None, schema: object | None = None, + parameters: Dict[str, ParameterSpecification] | None = None, annotations: List[object] + | None = None, folder: DatasetFolder | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: path + description: 'Required. The path of the SAP ECC OData entity. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: path + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SapEccResourceDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapEccResourceDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapEccResourceDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SapEccResourceDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapEccResourceDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SapEccResourceDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapEccResourceDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaAuthenticationType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaAuthenticationType.yml new file mode 100644 index 00000000..841fb3f9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaAuthenticationType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.SapHanaAuthenticationType +name: SapHanaAuthenticationType +fullName: azure.synapse.artifacts.models.SapHanaAuthenticationType +summary: The authentication type to be used to connect to the SAP HANA server. +module: azure.synapse.artifacts.models +fields: +- name: basic + uid: azure.synapse.artifacts.models.SapHanaAuthenticationType.basic +- name: windows + uid: azure.synapse.artifacts.models.SapHanaAuthenticationType.windows diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaLinkedService.yml new file mode 100644 index 00000000..22ed0a34 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaLinkedService.yml @@ -0,0 +1,225 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SapHanaLinkedService +name: SapHanaLinkedService +fullName: azure.synapse.artifacts.models.SapHanaLinkedService +module: azure.synapse.artifacts.models +summary: 'SAP HANA Linked Service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SapHanaLinkedService(*, server: object, additional_properties: Dict[str, + object] | None = None, connect_via: IntegrationRuntimeReference | None = None, + description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, connection_string: object + | None = None, authentication_type: str | SapHanaAuthenticationType | None = None, + user_name: object | None = None, password: SecretBase | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'SAP HANA ODBC connection string. Type: string, SecureString or + + AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: server + description: 'Required. Host name of the SAP HANA server. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: authentication_type + description: 'The authentication type to be used to connect to the SAP HANA + + server. Possible values include: "Basic", "Windows".' + isRequired: true + types: + - + - + - name: user_name + description: 'Username to access the SAP HANA server. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: password + description: Password to access the SAP HANA server. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: server + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: connection_string + isRequired: true + - name: authentication_type + isRequired: true + - name: user_name + isRequired: true + - name: password + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SapHanaLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapHanaLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapHanaLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SapHanaLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapHanaLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SapHanaLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapHanaLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaTableDataset.yml new file mode 100644 index 00000000..0bfa7f45 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaTableDataset.yml @@ -0,0 +1,213 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SapHanaTableDataset +name: SapHanaTableDataset +fullName: azure.synapse.artifacts.models.SapHanaTableDataset +module: azure.synapse.artifacts.models +summary: 'SAP HANA Table properties. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SapHanaTableDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, schema_type_properties_schema: object | None = None, table: object + | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: schema_type_properties_schema + description: 'The schema name of SAP HANA. Type: string (or Expression + + with resultType string).' + isRequired: true + types: + - + - name: table + description: 'The table name of SAP HANA. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: schema_type_properties_schema + isRequired: true + - name: table + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SapHanaTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapHanaTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapHanaTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SapHanaTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapHanaTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SapHanaTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapHanaTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubLinkedService.yml new file mode 100644 index 00000000..7a75dc3d --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubLinkedService.yml @@ -0,0 +1,243 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SapOpenHubLinkedService +name: SapOpenHubLinkedService +fullName: azure.synapse.artifacts.models.SapOpenHubLinkedService +module: azure.synapse.artifacts.models +summary: 'SAP Business Warehouse Open Hub Destination Linked Service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SapOpenHubLinkedService(*, server: object, system_number: object, client_id: + object, additional_properties: Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference + | None = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, language: object | None + = None, user_name: object | None = None, password: SecretBase | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: server + description: 'Required. Host name of the SAP BW instance where the open hub destination + is + + located. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: system_number + description: 'Required. System number of the BW system where the open hub destination + + is located. (Usually a two-digit decimal number represented as a string.) Type: + string (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: client_id + description: 'Required. Client ID of the client on the BW system where the open + hub + + destination is located. (Usually a three-digit decimal number represented as + a string) Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: language + description: 'Language of the BW system where the open hub destination is located. + The + + default value is EN. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: user_name + description: 'Username to access the SAP BW server where the open hub destination + is + + located. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: password + description: 'Password to access the SAP BW server where the open hub destination + is + + located.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: server + isRequired: true + - name: system_number + isRequired: true + - name: client_id + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: language + isRequired: true + - name: user_name + isRequired: true + - name: password + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SapOpenHubLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapOpenHubLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapOpenHubLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SapOpenHubLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapOpenHubLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SapOpenHubLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapOpenHubLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubTableDataset.yml new file mode 100644 index 00000000..e67adcb5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubTableDataset.yml @@ -0,0 +1,228 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SapOpenHubTableDataset +name: SapOpenHubTableDataset +fullName: azure.synapse.artifacts.models.SapOpenHubTableDataset +module: azure.synapse.artifacts.models +summary: 'Sap Business Warehouse Open Hub Destination Table properties. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SapOpenHubTableDataset(*, linked_service_name: LinkedServiceReference, + open_hub_destination_name: object, additional_properties: Dict[str, object] | + None = None, description: str | None = None, structure: object | None = None, + schema: object | None = None, parameters: Dict[str, ParameterSpecification] | + None = None, annotations: List[object] | None = None, folder: DatasetFolder | + None = None, exclude_last_request: object | None = None, base_request_id: object + | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: open_hub_destination_name + description: 'Required. The name of the Open Hub Destination with + + destination type as Database Table. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: exclude_last_request + description: 'Whether to exclude the records of the last request. The default + + value is true. Type: boolean (or Expression with resultType boolean).' + isRequired: true + types: + - + - name: base_request_id + description: 'The ID of request for delta loading. Once it is set, only data with + + requestId larger than the value of this property will be retrieved. The default + value is 0. + + Type: integer (or Expression with resultType integer ).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: open_hub_destination_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: exclude_last_request + isRequired: true + - name: base_request_id + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SapOpenHubTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapOpenHubTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapOpenHubTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SapOpenHubTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapOpenHubTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SapOpenHubTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapOpenHubTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableLinkedService.yml new file mode 100644 index 00000000..1e57ae4c --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableLinkedService.yml @@ -0,0 +1,335 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SapTableLinkedService +name: SapTableLinkedService +fullName: azure.synapse.artifacts.models.SapTableLinkedService +module: azure.synapse.artifacts.models +summary: 'SAP Table Linked Service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SapTableLinkedService(*, additional_properties: Dict[str, object] | None + = None, connect_via: IntegrationRuntimeReference | None = None, description: str + | None = None, parameters: Dict[str, ParameterSpecification] | None = None, annotations: + List[object] | None = None, server: object | None = None, system_number: object + | None = None, client_id: object | None = None, language: object | None = None, + system_id: object | None = None, user_name: object | None = None, password: SecretBase + | None = None, message_server: object | None = None, message_server_service: object + | None = None, snc_mode: object | None = None, snc_my_name: object | None = None, + snc_partner_name: object | None = None, snc_library_path: object | None = None, + snc_qop: object | None = None, logon_group: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: server + description: 'Host name of the SAP instance where the table is located. Type: + string (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: system_number + description: 'System number of the SAP system where the table is located. (Usually + a + + two-digit decimal number represented as a string.) Type: string (or Expression + with resultType + + string).' + isRequired: true + types: + - + - name: client_id + description: 'Client ID of the client on the SAP system where the table is located. + + (Usually a three-digit decimal number represented as a string) Type: string + (or Expression with + + resultType string).' + isRequired: true + types: + - + - name: language + description: 'Language of the SAP system where the table is located. The default + value is + + EN. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: system_id + description: 'SystemID of the SAP system where the table is located. Type: string + (or + + Expression with resultType string).' + isRequired: true + types: + - + - name: user_name + description: 'Username to access the SAP server where the table is located. Type: + string + + (or Expression with resultType string).' + isRequired: true + types: + - + - name: password + description: Password to access the SAP server where the table is located. + isRequired: true + types: + - + - name: message_server + description: 'The hostname of the SAP Message Server. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: message_server_service + description: 'The service name or port number of the Message Server. Type: + + string (or Expression with resultType string).' + isRequired: true + types: + - + - name: snc_mode + description: 'SNC activation indicator to access the SAP server where the table + is located. + + Must be either 0 (off) or 1 (on). Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: snc_my_name + description: 'Initiator''s SNC name to access the SAP server where the table is + located. + + Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: snc_partner_name + description: 'Communication partner''s SNC name to access the SAP server where + the + + table is located. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: snc_library_path + description: 'External security product''s library to access the SAP server where + the + + table is located. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: snc_qop + description: 'SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. + Type: string + + (or Expression with resultType string).' + isRequired: true + types: + - + - name: logon_group + description: 'The Logon Group for the SAP System. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: server + isRequired: true + - name: system_number + isRequired: true + - name: client_id + isRequired: true + - name: language + isRequired: true + - name: system_id + isRequired: true + - name: user_name + isRequired: true + - name: password + isRequired: true + - name: message_server + isRequired: true + - name: message_server_service + isRequired: true + - name: snc_mode + isRequired: true + - name: snc_my_name + isRequired: true + - name: snc_partner_name + isRequired: true + - name: snc_library_path + isRequired: true + - name: snc_qop + isRequired: true + - name: logon_group + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SapTableLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapTableLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapTableLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SapTableLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapTableLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SapTableLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapTableLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableResourceDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableResourceDataset.yml new file mode 100644 index 00000000..cc6539ee --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableResourceDataset.yml @@ -0,0 +1,205 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SapTableResourceDataset +name: SapTableResourceDataset +fullName: azure.synapse.artifacts.models.SapTableResourceDataset +module: azure.synapse.artifacts.models +summary: 'SAP Table Resource properties. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SapTableResourceDataset(*, linked_service_name: LinkedServiceReference, + table_name: object, additional_properties: Dict[str, object] | None = None, description: + str | None = None, structure: object | None = None, schema: object | None = None, + parameters: Dict[str, ParameterSpecification] | None = None, annotations: List[object] + | None = None, folder: DatasetFolder | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'Required. The name of the SAP Table. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: table_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SapTableResourceDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapTableResourceDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapTableResourceDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SapTableResourceDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SapTableResourceDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SapTableResourceDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SapTableResourceDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SchedulerCurrentState.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SchedulerCurrentState.yml new file mode 100644 index 00000000..70f4066d --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SchedulerCurrentState.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.SchedulerCurrentState +name: SchedulerCurrentState +fullName: azure.synapse.artifacts.models.SchedulerCurrentState +module: azure.synapse.artifacts.models +fields: +- name: ended + uid: azure.synapse.artifacts.models.SchedulerCurrentState.ended +- name: queued + uid: azure.synapse.artifacts.models.SchedulerCurrentState.queued +- name: scheduled + uid: azure.synapse.artifacts.models.SchedulerCurrentState.scheduled diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptAction.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptAction.yml new file mode 100644 index 00000000..8d822a38 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptAction.yml @@ -0,0 +1,152 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ScriptAction +name: ScriptAction +fullName: azure.synapse.artifacts.models.ScriptAction +module: azure.synapse.artifacts.models +summary: 'Custom script action to run on HDI ondemand cluster once it''s up. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ScriptAction(*, name: str, uri: str, roles: str | HdiNodeTypes, parameters: + str | None = None, **kwargs)' + parameters: + - name: name + description: Required. The user provided name of the script action. + isRequired: true + types: + - + - name: uri + description: Required. The URI for the script action. + isRequired: true + types: + - + - name: roles + description: 'Required. The node types on which the script action should be executed. + Possible + + values include: "Headnode", "Workernode", "Zookeeper".' + isRequired: true + types: + - + - + - name: parameters + description: The parameters for the script action. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: uri + isRequired: true + - name: roles + isRequired: true + - name: parameters + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ScriptAction.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ScriptAction.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ScriptAction.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ScriptAction.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ScriptAction.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ScriptAction.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ScriptAction.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SecretBase.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SecretBase.yml new file mode 100644 index 00000000..7b509b4c --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SecretBase.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SecretBase +name: SecretBase +fullName: azure.synapse.artifacts.models.SecretBase +module: azure.synapse.artifacts.models +summary: 'The base definition of a secret type. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: AzureKeyVaultSecretReference, SecureString. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: SecretBase(**kwargs) + parameters: + - name: type + description: Required. Type of the secret.Constant filled by server. + isRequired: true + types: + - +methods: +- uid: azure.synapse.artifacts.models.SecretBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SecretBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SecretBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SecretBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SecretBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SecretBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SecretBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SecureString.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SecureString.yml new file mode 100644 index 00000000..0a1ddd24 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SecureString.yml @@ -0,0 +1,132 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SecureString +name: SecureString +fullName: azure.synapse.artifacts.models.SecureString +module: azure.synapse.artifacts.models +summary: 'Azure Synapse secure string definition. The string value will be masked + with asterisks ''*'' during Get or List API calls. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SecureString(*, value: str, **kwargs)' + parameters: + - name: type + description: Required. Type of the secret.Constant filled by server. + isRequired: true + types: + - + - name: value + description: Required. Value of secure string. + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SecureString.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SecureString.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SecureString.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SecureString.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SecureString.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SecureString.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SecureString.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowAuthenticationType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowAuthenticationType.yml new file mode 100644 index 00000000..f419859b --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowAuthenticationType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.ServiceNowAuthenticationType +name: ServiceNowAuthenticationType +fullName: azure.synapse.artifacts.models.ServiceNowAuthenticationType +summary: The authentication type to use. +module: azure.synapse.artifacts.models +fields: +- name: basic + uid: azure.synapse.artifacts.models.ServiceNowAuthenticationType.basic +- name: o_auth2 + uid: azure.synapse.artifacts.models.ServiceNowAuthenticationType.o_auth2 diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowLinkedService.yml new file mode 100644 index 00000000..1d742586 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowLinkedService.yml @@ -0,0 +1,263 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ServiceNowLinkedService +name: ServiceNowLinkedService +fullName: azure.synapse.artifacts.models.ServiceNowLinkedService +module: azure.synapse.artifacts.models +summary: 'ServiceNow server linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ServiceNowLinkedService(*, endpoint: object, authentication_type: str | + ServiceNowAuthenticationType, additional_properties: Dict[str, object] | None + = None, connect_via: IntegrationRuntimeReference | None = None, description: str + | None = None, parameters: Dict[str, ParameterSpecification] | None = None, annotations: + List[object] | None = None, username: object | None = None, password: SecretBase + | None = None, client_id: object | None = None, client_secret: SecretBase | None + = None, use_encrypted_endpoints: object | None = None, use_host_verification: + object | None = None, use_peer_verification: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: endpoint + description: 'Required. The endpoint of the ServiceNow server. (i.e. + + ``.service-now.com).' + isRequired: true + types: + - + - name: authentication_type + description: 'Required. The authentication type to use. Possible values include: + + "Basic", "OAuth2".' + isRequired: true + types: + - + - + - name: username + description: 'The user name used to connect to the ServiceNow server for Basic + and OAuth2 + + authentication.' + isRequired: true + types: + - + - name: password + description: 'The password corresponding to the user name for Basic and OAuth2 + + authentication.' + isRequired: true + types: + - + - name: client_id + description: The client id for OAuth2 authentication. + isRequired: true + types: + - + - name: client_secret + description: The client secret for OAuth2 authentication. + isRequired: true + types: + - + - name: use_encrypted_endpoints + description: 'Specifies whether the data source endpoints are encrypted using + + HTTPS. The default value is true.' + isRequired: true + types: + - + - name: use_host_verification + description: 'Specifies whether to require the host name in the server''s + + certificate to match the host name of the server when connecting over SSL. The + default value is + + true.' + isRequired: true + types: + - + - name: use_peer_verification + description: 'Specifies whether to verify the identity of the server when + + connecting over SSL. The default value is true.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: endpoint + isRequired: true + - name: authentication_type + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: username + isRequired: true + - name: password + isRequired: true + - name: client_id + isRequired: true + - name: client_secret + isRequired: true + - name: use_encrypted_endpoints + isRequired: true + - name: use_host_verification + isRequired: true + - name: use_peer_verification + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ServiceNowLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ServiceNowLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ServiceNowLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ServiceNowLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ServiceNowLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ServiceNowLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ServiceNowLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowObjectDataset.yml new file mode 100644 index 00000000..e05316f0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowObjectDataset.yml @@ -0,0 +1,203 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ServiceNowObjectDataset +name: ServiceNowObjectDataset +fullName: azure.synapse.artifacts.models.ServiceNowObjectDataset +module: azure.synapse.artifacts.models +summary: 'ServiceNow server dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ServiceNowObjectDataset(*, linked_service_name: LinkedServiceReference, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, structure: object | None = None, schema: object | None = None, parameters: + Dict[str, ParameterSpecification] | None = None, annotations: List[object] | None + = None, folder: DatasetFolder | None = None, table_name: object | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ServiceNowObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ServiceNowObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ServiceNowObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ServiceNowObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ServiceNowObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ServiceNowObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ServiceNowObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SetVariableActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SetVariableActivity.yml new file mode 100644 index 00000000..9d1fd8bf --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SetVariableActivity.yml @@ -0,0 +1,178 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SetVariableActivity +name: SetVariableActivity +fullName: azure.synapse.artifacts.models.SetVariableActivity +module: azure.synapse.artifacts.models +summary: 'Set value for a Variable. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SetVariableActivity(*, name: str, additional_properties: Dict[str, object] + | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, variable_name: + str | None = None, value: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: variable_name + description: Name of the variable whose value needs to be set. + isRequired: true + types: + - + - name: value + description: Value to be set. Could be a static value or Expression. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: variable_name + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SetVariableActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SetVariableActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SetVariableActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SetVariableActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SetVariableActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SetVariableActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SetVariableActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpAuthenticationType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpAuthenticationType.yml new file mode 100644 index 00000000..1e170dd3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpAuthenticationType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.SftpAuthenticationType +name: SftpAuthenticationType +fullName: azure.synapse.artifacts.models.SftpAuthenticationType +summary: The authentication type to be used to connect to the FTP server. +module: azure.synapse.artifacts.models +fields: +- name: basic + uid: azure.synapse.artifacts.models.SftpAuthenticationType.basic +- name: ssh_public_key + uid: azure.synapse.artifacts.models.SftpAuthenticationType.ssh_public_key diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpServerLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpServerLinkedService.yml new file mode 100644 index 00000000..872619c2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpServerLinkedService.yml @@ -0,0 +1,287 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SftpServerLinkedService +name: SftpServerLinkedService +fullName: azure.synapse.artifacts.models.SftpServerLinkedService +module: azure.synapse.artifacts.models +summary: 'A linked service for an SSH File Transfer Protocol (SFTP) server. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SftpServerLinkedService(*, host: object, additional_properties: Dict[str, + object] | None = None, connect_via: IntegrationRuntimeReference | None = None, + description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, port: object | None = + None, authentication_type: str | SftpAuthenticationType | None = None, user_name: + object | None = None, password: SecretBase | None = None, encrypted_credential: + object | None = None, private_key_path: object | None = None, private_key_content: + SecretBase | None = None, pass_phrase: SecretBase | None = None, skip_host_key_validation: + object | None = None, host_key_fingerprint: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: host + description: 'Required. The SFTP server host name. Type: string (or Expression + with resultType + + string).' + isRequired: true + types: + - + - name: port + description: 'The TCP port number that the SFTP server uses to listen for client + connections. + + Default value is 22. Type: integer (or Expression with resultType integer), + minimum: 0.' + isRequired: true + types: + - + - name: authentication_type + description: 'The authentication type to be used to connect to the FTP server. + + Possible values include: "Basic", "SshPublicKey".' + isRequired: true + types: + - + - + - name: user_name + description: 'The username used to log on to the SFTP server. Type: string (or + Expression + + with resultType string).' + isRequired: true + types: + - + - name: password + description: Password to logon the SFTP server for Basic authentication. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + - name: private_key_path + description: 'The SSH private key file path for SshPublicKey authentication. Only + + valid for on-premises copy. For on-premises copy with SshPublicKey authentication, + either + + PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should + be OpenSSH + + format. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: private_key_content + description: 'Base64 encoded SSH private key content for SshPublicKey + + authentication. For on-premises copy with SshPublicKey authentication, either + PrivateKeyPath or + + PrivateKeyContent should be specified. SSH private key should be OpenSSH format.' + isRequired: true + types: + - + - name: pass_phrase + description: 'The password to decrypt the SSH private key if the SSH private key + is + + encrypted.' + isRequired: true + types: + - + - name: skip_host_key_validation + description: 'If true, skip the SSH host key validation. Default value is + + false. Type: boolean (or Expression with resultType boolean).' + isRequired: true + types: + - + - name: host_key_fingerprint + description: 'The host key finger-print of the SFTP server. When + + SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: + string (or + + Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: host + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: port + isRequired: true + - name: authentication_type + isRequired: true + - name: user_name + isRequired: true + - name: password + isRequired: true + - name: encrypted_credential + isRequired: true + - name: private_key_path + isRequired: true + - name: private_key_content + isRequired: true + - name: pass_phrase + isRequired: true + - name: skip_host_key_validation + isRequired: true + - name: host_key_fingerprint + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SftpServerLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SftpServerLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SftpServerLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SftpServerLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SftpServerLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SftpServerLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SftpServerLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyLinkedService.yml new file mode 100644 index 00000000..780f5a16 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyLinkedService.yml @@ -0,0 +1,226 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ShopifyLinkedService +name: ShopifyLinkedService +fullName: azure.synapse.artifacts.models.ShopifyLinkedService +module: azure.synapse.artifacts.models +summary: 'Shopify Service linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ShopifyLinkedService(*, host: object, additional_properties: Dict[str, + object] | None = None, connect_via: IntegrationRuntimeReference | None = None, + description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, access_token: SecretBase + | None = None, use_encrypted_endpoints: object | None = None, use_host_verification: + object | None = None, use_peer_verification: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: host + description: Required. The endpoint of the Shopify server. (i.e. mystore.myshopify.com). + isRequired: true + types: + - + - name: access_token + description: 'The API access token that can be used to access Shopify''s data. + The token + + won''t expire if it is offline mode.' + isRequired: true + types: + - + - name: use_encrypted_endpoints + description: 'Specifies whether the data source endpoints are encrypted using + + HTTPS. The default value is true.' + isRequired: true + types: + - + - name: use_host_verification + description: 'Specifies whether to require the host name in the server''s + + certificate to match the host name of the server when connecting over SSL. The + default value is + + true.' + isRequired: true + types: + - + - name: use_peer_verification + description: 'Specifies whether to verify the identity of the server when + + connecting over SSL. The default value is true.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: host + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: access_token + isRequired: true + - name: use_encrypted_endpoints + isRequired: true + - name: use_host_verification + isRequired: true + - name: use_peer_verification + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ShopifyLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ShopifyLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ShopifyLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ShopifyLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ShopifyLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ShopifyLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ShopifyLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyObjectDataset.yml new file mode 100644 index 00000000..d8f0c3b2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyObjectDataset.yml @@ -0,0 +1,202 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ShopifyObjectDataset +name: ShopifyObjectDataset +fullName: azure.synapse.artifacts.models.ShopifyObjectDataset +module: azure.synapse.artifacts.models +summary: 'Shopify Service dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ShopifyObjectDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ShopifyObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ShopifyObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ShopifyObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ShopifyObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ShopifyObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ShopifyObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ShopifyObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkAuthenticationType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkAuthenticationType.yml new file mode 100644 index 00000000..6163f943 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkAuthenticationType.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.SparkAuthenticationType +name: SparkAuthenticationType +fullName: azure.synapse.artifacts.models.SparkAuthenticationType +summary: The authentication method used to access the Spark server. +module: azure.synapse.artifacts.models +fields: +- name: anonymous + uid: azure.synapse.artifacts.models.SparkAuthenticationType.anonymous +- name: username + uid: azure.synapse.artifacts.models.SparkAuthenticationType.username +- name: username_and_password + uid: azure.synapse.artifacts.models.SparkAuthenticationType.username_and_password +- name: windows_azure_hd_insight_service + uid: azure.synapse.artifacts.models.SparkAuthenticationType.windows_azure_hd_insight_service diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJob.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJob.yml new file mode 100644 index 00000000..294ee337 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJob.yml @@ -0,0 +1,257 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SparkBatchJob +name: SparkBatchJob +fullName: azure.synapse.artifacts.models.SparkBatchJob +module: azure.synapse.artifacts.models +summary: 'SparkBatchJob. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SparkBatchJob(*, id: int, livy_info: SparkBatchJobState | None = None, + name: str | None = None, workspace_name: str | None = None, spark_pool_name: str + | None = None, submitter_name: str | None = None, submitter_id: str | None = None, + artifact_id: str | None = None, job_type: str | SparkJobType | None = None, result: + str | SparkBatchJobResultType | None = None, scheduler: SparkScheduler | None + = None, plugin: SparkServicePlugin | None = None, errors: List[SparkServiceError] + | None = None, tags: Dict[str, str] | None = None, app_id: str | None = None, + app_info: Dict[str, str] | None = None, state: str | None = None, log_lines: List[str] + | None = None, **kwargs)' + parameters: + - name: livy_info + isRequired: true + types: + - + - name: name + description: The batch name. + isRequired: true + types: + - + - name: workspace_name + description: The workspace name. + isRequired: true + types: + - + - name: spark_pool_name + description: The Spark pool name. + isRequired: true + types: + - + - name: submitter_name + description: The submitter name. + isRequired: true + types: + - + - name: submitter_id + description: The submitter identifier. + isRequired: true + types: + - + - name: artifact_id + description: The artifact identifier. + isRequired: true + types: + - + - name: job_type + description: 'The job type. Possible values include: "SparkBatch", "SparkSession".' + isRequired: true + types: + - + - + - name: result + description: 'The Spark batch job result. Possible values include: "Uncertain", + "Succeeded", + + "Failed", "Cancelled".' + isRequired: true + types: + - + - + - name: scheduler + description: The scheduler information. + isRequired: true + types: + - + - name: plugin + description: The plugin information. + isRequired: true + types: + - + - name: errors + description: The error information. + isRequired: true + types: + - [] + - name: tags + description: A set of tags. The tags. + isRequired: true + types: + - [, ] + - name: id + description: Required. The session Id. + isRequired: true + types: + - + - name: app_id + description: The application id of this session. + isRequired: true + types: + - + - name: app_info + description: The detailed application info. + isRequired: true + types: + - [, ] + - name: state + description: The batch state. + isRequired: true + types: + - + - name: log_lines + description: The log lines. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: livy_info + isRequired: true + - name: name + isRequired: true + - name: workspace_name + isRequired: true + - name: spark_pool_name + isRequired: true + - name: submitter_name + isRequired: true + - name: submitter_id + isRequired: true + - name: artifact_id + isRequired: true + - name: job_type + isRequired: true + - name: result + isRequired: true + - name: scheduler + isRequired: true + - name: plugin + isRequired: true + - name: errors + isRequired: true + - name: tags + isRequired: true + - name: app_id + isRequired: true + - name: app_info + isRequired: true + - name: state + isRequired: true + - name: log_lines + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SparkBatchJob.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkBatchJob.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkBatchJob.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SparkBatchJob.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkBatchJob.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SparkBatchJob.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkBatchJob.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJobResultType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJobResultType.yml new file mode 100644 index 00000000..2bb08ba5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJobResultType.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.SparkBatchJobResultType +name: SparkBatchJobResultType +fullName: azure.synapse.artifacts.models.SparkBatchJobResultType +summary: The Spark batch job result. +module: azure.synapse.artifacts.models +fields: +- name: cancelled + uid: azure.synapse.artifacts.models.SparkBatchJobResultType.cancelled +- name: failed + uid: azure.synapse.artifacts.models.SparkBatchJobResultType.failed +- name: succeeded + uid: azure.synapse.artifacts.models.SparkBatchJobResultType.succeeded +- name: uncertain + uid: azure.synapse.artifacts.models.SparkBatchJobResultType.uncertain diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJobState.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJobState.yml new file mode 100644 index 00000000..a595aa8c --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJobState.yml @@ -0,0 +1,182 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SparkBatchJobState +name: SparkBatchJobState +fullName: azure.synapse.artifacts.models.SparkBatchJobState +module: azure.synapse.artifacts.models +summary: SparkBatchJobState. +constructor: + syntax: 'SparkBatchJobState(*, not_started_at: datetime | None = None, starting_at: + datetime | None = None, running_at: datetime | None = None, dead_at: datetime + | None = None, success_at: datetime | None = None, terminated_at: datetime | None + = None, recovering_at: datetime | None = None, current_state: str | None = None, + job_creation_request: SparkRequest | None = None, **kwargs)' + parameters: + - name: not_started_at + description: the time that at which "not_started" livy state was first seen. + isRequired: true + types: + - + - name: starting_at + description: the time that at which "starting" livy state was first seen. + isRequired: true + types: + - + - name: running_at + description: the time that at which "running" livy state was first seen. + isRequired: true + types: + - + - name: dead_at + description: time that at which "dead" livy state was first seen. + isRequired: true + types: + - + - name: success_at + description: the time that at which "success" livy state was first seen. + isRequired: true + types: + - + - name: terminated_at + description: the time that at which "killed" livy state was first seen. + isRequired: true + types: + - + - name: recovering_at + description: the time that at which "recovering" livy state was first seen. + isRequired: true + types: + - + - name: current_state + description: the Spark job state. + isRequired: true + types: + - + - name: job_creation_request + isRequired: true + types: + - + keywordOnlyParameters: + - name: not_started_at + isRequired: true + - name: starting_at + isRequired: true + - name: running_at + isRequired: true + - name: dead_at + isRequired: true + - name: success_at + isRequired: true + - name: terminated_at + isRequired: true + - name: recovering_at + isRequired: true + - name: current_state + isRequired: true + - name: job_creation_request + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SparkBatchJobState.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkBatchJobState.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkBatchJobState.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SparkBatchJobState.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkBatchJobState.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SparkBatchJobState.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkBatchJobState.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkErrorSource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkErrorSource.yml new file mode 100644 index 00000000..ad0f8ddd --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkErrorSource.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.SparkErrorSource +name: SparkErrorSource +fullName: azure.synapse.artifacts.models.SparkErrorSource +module: azure.synapse.artifacts.models +fields: +- name: dependency + uid: azure.synapse.artifacts.models.SparkErrorSource.dependency +- name: system + uid: azure.synapse.artifacts.models.SparkErrorSource.system +- name: unknown + uid: azure.synapse.artifacts.models.SparkErrorSource.unknown +- name: user + uid: azure.synapse.artifacts.models.SparkErrorSource.user diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinition.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinition.yml new file mode 100644 index 00000000..d86d4bb3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinition.yml @@ -0,0 +1,166 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SparkJobDefinition +name: SparkJobDefinition +fullName: azure.synapse.artifacts.models.SparkJobDefinition +module: azure.synapse.artifacts.models +summary: 'Spark job definition. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SparkJobDefinition(*, target_big_data_pool: BigDataPoolReference, job_properties: + SparkJobProperties, additional_properties: Dict[str, object] | None = None, description: + str | None = None, required_spark_version: str | None = None, language: str | + None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: description + description: The description of the Spark job definition. + isRequired: true + types: + - + - name: target_big_data_pool + description: Required. Big data pool reference. + isRequired: true + types: + - + - name: required_spark_version + description: The required Spark version of the application. + isRequired: true + types: + - + - name: language + description: The language of the Spark application. + isRequired: true + types: + - + - name: job_properties + description: Required. The properties of the Spark job. + isRequired: true + types: + - + keywordOnlyParameters: + - name: target_big_data_pool + isRequired: true + - name: job_properties + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: required_spark_version + isRequired: true + - name: language + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SparkJobDefinition.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkJobDefinition.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkJobDefinition.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SparkJobDefinition.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkJobDefinition.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SparkJobDefinition.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkJobDefinition.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinitionResource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinitionResource.yml new file mode 100644 index 00000000..0921c997 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinitionResource.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SparkJobDefinitionResource +name: SparkJobDefinitionResource +fullName: azure.synapse.artifacts.models.SparkJobDefinitionResource +module: azure.synapse.artifacts.models +summary: 'Spark job definition resource type. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SparkJobDefinitionResource(*, properties: SparkJobDefinition, **kwargs)' + parameters: + - name: properties + description: Required. Properties of spark job definition. + isRequired: true + types: + - + keywordOnlyParameters: + - name: properties + isRequired: true +variables: +- description: The resource identifier. + name: id + types: + - +- description: The resource name. + name: name + types: + - +- description: The resource type. + name: type + types: + - +- description: Etag identifies change in the resource. + name: etag + types: + - +methods: +- uid: azure.synapse.artifacts.models.SparkJobDefinitionResource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkJobDefinitionResource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkJobDefinitionResource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SparkJobDefinitionResource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkJobDefinitionResource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SparkJobDefinitionResource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkJobDefinitionResource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinitionsListResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinitionsListResponse.yml new file mode 100644 index 00000000..35fa0b58 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinitionsListResponse.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SparkJobDefinitionsListResponse +name: SparkJobDefinitionsListResponse +fullName: azure.synapse.artifacts.models.SparkJobDefinitionsListResponse +module: azure.synapse.artifacts.models +summary: 'A list of spark job definitions resources. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SparkJobDefinitionsListResponse(*, value: List[SparkJobDefinitionResource], + next_link: str | None = None, **kwargs)' + parameters: + - name: value + description: Required. List of spark job definitions. + isRequired: true + types: + - [] + - name: next_link + description: The link to the next page of results, if any remaining results exist. + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: next_link + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SparkJobDefinitionsListResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkJobDefinitionsListResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkJobDefinitionsListResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SparkJobDefinitionsListResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkJobDefinitionsListResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SparkJobDefinitionsListResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkJobDefinitionsListResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobProperties.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobProperties.yml new file mode 100644 index 00000000..0f5b15b2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobProperties.yml @@ -0,0 +1,224 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SparkJobProperties +name: SparkJobProperties +fullName: azure.synapse.artifacts.models.SparkJobProperties +module: azure.synapse.artifacts.models +summary: 'The properties of the Spark job. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SparkJobProperties(*, file: str, driver_memory: str, driver_cores: int, + executor_memory: str, executor_cores: int, num_executors: int, additional_properties: + Dict[str, object] | None = None, name: str | None = None, class_name: str | None + = None, conf: object | None = None, args: List[str] | None = None, jars: List[str] + | None = None, files: List[str] | None = None, archives: List[str] | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: The name of the job. + isRequired: true + types: + - + - name: file + description: Required. File containing the application to execute. + isRequired: true + types: + - + - name: class_name + description: Main class for Java/Scala application. + isRequired: true + types: + - + - name: conf + description: Spark configuration properties. + isRequired: true + types: + - + - name: args + description: Command line arguments for the application. + isRequired: true + types: + - [] + - name: jars + description: Jars to be used in this job. + isRequired: true + types: + - [] + - name: files + description: files to be used in this job. + isRequired: true + types: + - [] + - name: archives + description: Archives to be used in this job. + isRequired: true + types: + - [] + - name: driver_memory + description: Required. Amount of memory to use for the driver process. + isRequired: true + types: + - + - name: driver_cores + description: Required. Number of cores to use for the driver. + isRequired: true + types: + - + - name: executor_memory + description: Required. Amount of memory to use per executor process. + isRequired: true + types: + - + - name: executor_cores + description: Required. Number of cores to use for each executor. + isRequired: true + types: + - + - name: num_executors + description: Required. Number of executors to launch for this job. + isRequired: true + types: + - + keywordOnlyParameters: + - name: file + isRequired: true + - name: driver_memory + isRequired: true + - name: driver_cores + isRequired: true + - name: executor_memory + isRequired: true + - name: executor_cores + isRequired: true + - name: num_executors + isRequired: true + - name: additional_properties + isRequired: true + - name: name + isRequired: true + - name: class_name + isRequired: true + - name: conf + isRequired: true + - name: args + isRequired: true + - name: jars + isRequired: true + - name: files + isRequired: true + - name: archives + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SparkJobProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkJobProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkJobProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SparkJobProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkJobProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SparkJobProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkJobProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobType.yml new file mode 100644 index 00000000..fed7e3e0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.SparkJobType +name: SparkJobType +fullName: azure.synapse.artifacts.models.SparkJobType +summary: The job type. +module: azure.synapse.artifacts.models +fields: +- name: spark_batch + uid: azure.synapse.artifacts.models.SparkJobType.spark_batch +- name: spark_session + uid: azure.synapse.artifacts.models.SparkJobType.spark_session diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkLinkedService.yml new file mode 100644 index 00000000..6213ea6d --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkLinkedService.yml @@ -0,0 +1,308 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SparkLinkedService +name: SparkLinkedService +fullName: azure.synapse.artifacts.models.SparkLinkedService +module: azure.synapse.artifacts.models +summary: 'Spark Server linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SparkLinkedService(*, host: object, port: object, authentication_type: + str | SparkAuthenticationType, additional_properties: Dict[str, object] | None + = None, connect_via: IntegrationRuntimeReference | None = None, description: str + | None = None, parameters: Dict[str, ParameterSpecification] | None = None, annotations: + List[object] | None = None, server_type: str | SparkServerType | None = None, + thrift_transport_protocol: str | SparkThriftTransportProtocol | None = None, username: + object | None = None, password: SecretBase | None = None, http_path: object | + None = None, enable_ssl: object | None = None, trusted_cert_path: object | None + = None, use_system_trust_store: object | None = None, allow_host_name_cn_mismatch: + object | None = None, allow_self_signed_server_cert: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: host + description: Required. IP address or host name of the Spark server. + isRequired: true + types: + - + - name: port + description: 'Required. The TCP port that the Spark server uses to listen for + client + + connections.' + isRequired: true + types: + - + - name: server_type + description: 'The type of Spark server. Possible values include: "SharkServer", + + "SharkServer2", "SparkThriftServer".' + isRequired: true + types: + - + - + - name: thrift_transport_protocol + description: 'The transport protocol to use in the Thrift layer. Possible + + values include: "Binary", "SASL", "HTTP ".' + isRequired: true + types: + - + - + - name: authentication_type + description: 'Required. The authentication method used to access the Spark + + server. Possible values include: "Anonymous", "Username", "UsernameAndPassword", + + "WindowsAzureHDInsightService".' + isRequired: true + types: + - + - + - name: username + description: The user name that you use to access Spark Server. + isRequired: true + types: + - + - name: password + description: 'The password corresponding to the user name that you provided in + the Username + + field.' + isRequired: true + types: + - + - name: http_path + description: The partial URL corresponding to the Spark server. + isRequired: true + types: + - + - name: enable_ssl + description: 'Specifies whether the connections to the server are encrypted using + SSL. The + + default value is false.' + isRequired: true + types: + - + - name: trusted_cert_path + description: 'The full path of the .pem file containing trusted CA certificates + for + + verifying the server when connecting over SSL. This property can only be set + when using SSL on + + self-hosted IR. The default value is the cacerts.pem file installed with the + IR.' + isRequired: true + types: + - + - name: use_system_trust_store + description: 'Specifies whether to use a CA certificate from the system trust + + store or from a specified PEM file. The default value is false.' + isRequired: true + types: + - + - name: allow_host_name_cn_mismatch + description: 'Specifies whether to require a CA-issued SSL certificate + + name to match the host name of the server when connecting over SSL. The default + value is false.' + isRequired: true + types: + - + - name: allow_self_signed_server_cert + description: 'Specifies whether to allow self-signed certificates from + + the server. The default value is false.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: host + isRequired: true + - name: port + isRequired: true + - name: authentication_type + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: server_type + isRequired: true + - name: thrift_transport_protocol + isRequired: true + - name: username + isRequired: true + - name: password + isRequired: true + - name: http_path + isRequired: true + - name: enable_ssl + isRequired: true + - name: trusted_cert_path + isRequired: true + - name: use_system_trust_store + isRequired: true + - name: allow_host_name_cn_mismatch + isRequired: true + - name: allow_self_signed_server_cert + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SparkLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SparkLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SparkLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkObjectDataset.yml new file mode 100644 index 00000000..e5e276ba --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkObjectDataset.yml @@ -0,0 +1,222 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SparkObjectDataset +name: SparkObjectDataset +fullName: azure.synapse.artifacts.models.SparkObjectDataset +module: azure.synapse.artifacts.models +summary: 'Spark Server dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SparkObjectDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, table: object | None = None, + schema_type_properties_schema: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'This property will be retired. Please consider using schema + table + + properties instead.' + isRequired: true + types: + - + - name: table + description: 'The table name of the Spark. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: schema_type_properties_schema + description: 'The schema name of the Spark. Type: string (or Expression + + with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true + - name: table + isRequired: true + - name: schema_type_properties_schema + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SparkObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SparkObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SparkObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkRequest.yml new file mode 100644 index 00000000..4c451c8e --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkRequest.yml @@ -0,0 +1,207 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SparkRequest +name: SparkRequest +fullName: azure.synapse.artifacts.models.SparkRequest +module: azure.synapse.artifacts.models +summary: SparkRequest. +constructor: + syntax: 'SparkRequest(*, name: str | None = None, file: str | None = None, class_name: + str | None = None, arguments: List[str] | None = None, jars: List[str] | None + = None, python_files: List[str] | None = None, files: List[str] | None = None, + archives: List[str] | None = None, configuration: Dict[str, str] | None = None, + driver_memory: str | None = None, driver_cores: int | None = None, executor_memory: + str | None = None, executor_cores: int | None = None, executor_count: int | None + = None, **kwargs)' + parameters: + - name: name + isRequired: true + types: + - + - name: file + isRequired: true + types: + - + - name: class_name + isRequired: true + types: + - + - name: arguments + isRequired: true + types: + - [] + - name: jars + isRequired: true + types: + - [] + - name: python_files + isRequired: true + types: + - [] + - name: files + isRequired: true + types: + - [] + - name: archives + isRequired: true + types: + - [] + - name: configuration + description: Dictionary of ``. + isRequired: true + types: + - [, ] + - name: driver_memory + isRequired: true + types: + - + - name: driver_cores + isRequired: true + types: + - + - name: executor_memory + isRequired: true + types: + - + - name: executor_cores + isRequired: true + types: + - + - name: executor_count + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: file + isRequired: true + - name: class_name + isRequired: true + - name: arguments + isRequired: true + - name: jars + isRequired: true + - name: python_files + isRequired: true + - name: files + isRequired: true + - name: archives + isRequired: true + - name: configuration + isRequired: true + - name: driver_memory + isRequired: true + - name: driver_cores + isRequired: true + - name: executor_memory + isRequired: true + - name: executor_cores + isRequired: true + - name: executor_count + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SparkRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SparkRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SparkRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkScheduler.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkScheduler.yml new file mode 100644 index 00000000..e3d6d980 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkScheduler.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SparkScheduler +name: SparkScheduler +fullName: azure.synapse.artifacts.models.SparkScheduler +module: azure.synapse.artifacts.models +summary: SparkScheduler. +constructor: + syntax: 'SparkScheduler(*, submitted_at: datetime | None = None, scheduled_at: datetime + | None = None, ended_at: datetime | None = None, cancellation_requested_at: datetime + | None = None, current_state: str | SchedulerCurrentState | None = None, **kwargs)' + parameters: + - name: submitted_at + isRequired: true + types: + - + - name: scheduled_at + isRequired: true + types: + - + - name: ended_at + isRequired: true + types: + - + - name: cancellation_requested_at + isRequired: true + types: + - + - name: current_state + description: 'Possible values include: "Queued", "Scheduled", "Ended".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: submitted_at + isRequired: true + - name: scheduled_at + isRequired: true + - name: ended_at + isRequired: true + - name: cancellation_requested_at + isRequired: true + - name: current_state + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SparkScheduler.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkScheduler.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkScheduler.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SparkScheduler.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkScheduler.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SparkScheduler.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkScheduler.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServerType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServerType.yml new file mode 100644 index 00000000..76999edd --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServerType.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.SparkServerType +name: SparkServerType +fullName: azure.synapse.artifacts.models.SparkServerType +summary: The type of Spark server. +module: azure.synapse.artifacts.models +fields: +- name: shark_server + uid: azure.synapse.artifacts.models.SparkServerType.shark_server +- name: shark_server2 + uid: azure.synapse.artifacts.models.SparkServerType.shark_server2 +- name: spark_thrift_server + uid: azure.synapse.artifacts.models.SparkServerType.spark_thrift_server diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServiceError.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServiceError.yml new file mode 100644 index 00000000..5abf3af2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServiceError.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SparkServiceError +name: SparkServiceError +fullName: azure.synapse.artifacts.models.SparkServiceError +module: azure.synapse.artifacts.models +summary: SparkServiceError. +constructor: + syntax: 'SparkServiceError(*, message: str | None = None, error_code: str | None + = None, source: str | SparkErrorSource | None = None, **kwargs)' + parameters: + - name: message + isRequired: true + types: + - + - name: error_code + isRequired: true + types: + - + - name: source + description: 'Possible values include: "System", "User", "Unknown", "Dependency".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: message + isRequired: true + - name: error_code + isRequired: true + - name: source + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SparkServiceError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkServiceError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkServiceError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SparkServiceError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkServiceError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SparkServiceError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkServiceError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServicePlugin.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServicePlugin.yml new file mode 100644 index 00000000..71be8cef --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServicePlugin.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SparkServicePlugin +name: SparkServicePlugin +fullName: azure.synapse.artifacts.models.SparkServicePlugin +module: azure.synapse.artifacts.models +summary: SparkServicePlugin. +constructor: + syntax: 'SparkServicePlugin(*, preparation_started_at: datetime | None = None, resource_acquisition_started_at: + datetime | None = None, submission_started_at: datetime | None = None, monitoring_started_at: + datetime | None = None, cleanup_started_at: datetime | None = None, current_state: + str | PluginCurrentState | None = None, **kwargs)' + parameters: + - name: preparation_started_at + isRequired: true + types: + - + - name: resource_acquisition_started_at + isRequired: true + types: + - + - name: submission_started_at + isRequired: true + types: + - + - name: monitoring_started_at + isRequired: true + types: + - + - name: cleanup_started_at + isRequired: true + types: + - + - name: current_state + description: 'Possible values include: "Preparation", "ResourceAcquisition", "Queued", + + "Submission", "Monitoring", "Cleanup", "Ended".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: preparation_started_at + isRequired: true + - name: resource_acquisition_started_at + isRequired: true + - name: submission_started_at + isRequired: true + - name: monitoring_started_at + isRequired: true + - name: cleanup_started_at + isRequired: true + - name: current_state + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SparkServicePlugin.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkServicePlugin.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkServicePlugin.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SparkServicePlugin.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SparkServicePlugin.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SparkServicePlugin.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SparkServicePlugin.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkThriftTransportProtocol.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkThriftTransportProtocol.yml new file mode 100644 index 00000000..a3d7a55f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkThriftTransportProtocol.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.SparkThriftTransportProtocol +name: SparkThriftTransportProtocol +fullName: azure.synapse.artifacts.models.SparkThriftTransportProtocol +summary: The transport protocol to use in the Thrift layer. +module: azure.synapse.artifacts.models +fields: +- name: binary + uid: azure.synapse.artifacts.models.SparkThriftTransportProtocol.binary +- name: http + uid: azure.synapse.artifacts.models.SparkThriftTransportProtocol.http +- name: sasl + uid: azure.synapse.artifacts.models.SparkThriftTransportProtocol.sasl diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlConnection.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlConnection.yml new file mode 100644 index 00000000..d35f3667 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlConnection.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SqlConnection +name: SqlConnection +fullName: azure.synapse.artifacts.models.SqlConnection +module: azure.synapse.artifacts.models +summary: 'The connection used to execute the SQL script. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SqlConnection(*, type: str | SqlConnectionType, name: str, additional_properties: + Dict[str, object] | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: 'Required. The type of the connection. Possible values include: "SqlOnDemand", + + "SqlPool".' + isRequired: true + types: + - + - + - name: name + description: Required. The identifier of the connection. + isRequired: true + types: + - + keywordOnlyParameters: + - name: type + isRequired: true + - name: name + isRequired: true + - name: additional_properties + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SqlConnection.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SqlConnection.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SqlConnection.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SqlConnection.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SqlConnection.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SqlConnection.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SqlConnection.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlConnectionType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlConnectionType.yml new file mode 100644 index 00000000..f6d60926 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlConnectionType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.SqlConnectionType +name: SqlConnectionType +fullName: azure.synapse.artifacts.models.SqlConnectionType +summary: The type of the connection. +module: azure.synapse.artifacts.models +fields: +- name: sql_on_demand + uid: azure.synapse.artifacts.models.SqlConnectionType.sql_on_demand +- name: sql_pool + uid: azure.synapse.artifacts.models.SqlConnectionType.sql_pool diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScript.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScript.yml new file mode 100644 index 00000000..b9225fa6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScript.yml @@ -0,0 +1,155 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SqlScript +name: SqlScript +fullName: azure.synapse.artifacts.models.SqlScript +module: azure.synapse.artifacts.models +summary: 'SQL script. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SqlScript(*, content: SqlScriptContent, additional_properties: Dict[str, + object] | None = None, description: str | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: description + description: The description of the SQL script. + isRequired: true + types: + - + - name: content + description: Required. The content of the SQL script. + isRequired: true + types: + - + keywordOnlyParameters: + - name: content + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true +variables: +- description: 'The type of the SQL script. Default value: "SqlQuery".' + name: type + types: + - +methods: +- uid: azure.synapse.artifacts.models.SqlScript.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SqlScript.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SqlScript.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SqlScript.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SqlScript.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SqlScript.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SqlScript.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +attributes: +- uid: azure.synapse.artifacts.models.SqlScript.type + name: type + signature: type = 'SqlQuery' diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptContent.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptContent.yml new file mode 100644 index 00000000..745c1644 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptContent.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SqlScriptContent +name: SqlScriptContent +fullName: azure.synapse.artifacts.models.SqlScriptContent +module: azure.synapse.artifacts.models +summary: 'The content of the SQL script. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SqlScriptContent(*, query: str, current_connection: SqlConnection, additional_properties: + Dict[str, object] | None = None, metadata: SqlScriptMetadata | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: query + description: Required. SQL query to execute. + isRequired: true + types: + - + - name: current_connection + description: Required. The connection used to execute the SQL script. + isRequired: true + types: + - + - name: metadata + description: The metadata of the SQL script. + isRequired: true + types: + - + keywordOnlyParameters: + - name: query + isRequired: true + - name: current_connection + isRequired: true + - name: additional_properties + isRequired: true + - name: metadata + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SqlScriptContent.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SqlScriptContent.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SqlScriptContent.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SqlScriptContent.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SqlScriptContent.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SqlScriptContent.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SqlScriptContent.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptMetadata.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptMetadata.yml new file mode 100644 index 00000000..127f319f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptMetadata.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SqlScriptMetadata +name: SqlScriptMetadata +fullName: azure.synapse.artifacts.models.SqlScriptMetadata +module: azure.synapse.artifacts.models +summary: The metadata of the SQL script. +constructor: + syntax: 'SqlScriptMetadata(*, additional_properties: Dict[str, object] | None = + None, language: str | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: language + description: The language of the SQL script. + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: language + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SqlScriptMetadata.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SqlScriptMetadata.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SqlScriptMetadata.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SqlScriptMetadata.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SqlScriptMetadata.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SqlScriptMetadata.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SqlScriptMetadata.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptResource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptResource.yml new file mode 100644 index 00000000..f904467f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptResource.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SqlScriptResource +name: SqlScriptResource +fullName: azure.synapse.artifacts.models.SqlScriptResource +module: azure.synapse.artifacts.models +summary: 'Sql Script resource type. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SqlScriptResource(*, properties: SqlScript, **kwargs)' + parameters: + - name: properties + description: Required. Properties of sql script. + isRequired: true + types: + - + keywordOnlyParameters: + - name: properties + isRequired: true +variables: +- description: The resource identifier. + name: id + types: + - +- description: The resource name. + name: name + types: + - +- description: The resource type. + name: type + types: + - +- description: Etag identifies change in the resource. + name: etag + types: + - +methods: +- uid: azure.synapse.artifacts.models.SqlScriptResource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SqlScriptResource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SqlScriptResource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SqlScriptResource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SqlScriptResource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SqlScriptResource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SqlScriptResource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptsListResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptsListResponse.yml new file mode 100644 index 00000000..b9eaf22e --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptsListResponse.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SqlScriptsListResponse +name: SqlScriptsListResponse +fullName: azure.synapse.artifacts.models.SqlScriptsListResponse +module: azure.synapse.artifacts.models +summary: 'A list of sql scripts resources. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SqlScriptsListResponse(*, value: List[SqlScriptResource], next_link: str + | None = None, **kwargs)' + parameters: + - name: value + description: Required. List of sql scripts. + isRequired: true + types: + - [] + - name: next_link + description: The link to the next page of results, if any remaining results exist. + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: next_link + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SqlScriptsListResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SqlScriptsListResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SqlScriptsListResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SqlScriptsListResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SqlScriptsListResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SqlScriptsListResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SqlScriptsListResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerLinkedService.yml new file mode 100644 index 00000000..295867d5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerLinkedService.yml @@ -0,0 +1,204 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SqlServerLinkedService +name: SqlServerLinkedService +fullName: azure.synapse.artifacts.models.SqlServerLinkedService +module: azure.synapse.artifacts.models +summary: 'SQL Server linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SqlServerLinkedService(*, connection_string: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, user_name: object | None + = None, password: SecretBase | None = None, encrypted_credential: object | None + = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'Required. The connection string. Type: string, SecureString or + + AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: user_name + description: 'The on-premises Windows authentication user name. Type: string (or + Expression + + with resultType string).' + isRequired: true + types: + - + - name: password + description: The on-premises Windows authentication password. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: connection_string + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: user_name + isRequired: true + - name: password + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SqlServerLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SqlServerLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SqlServerLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SqlServerLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SqlServerLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SqlServerLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SqlServerLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerStoredProcedureActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerStoredProcedureActivity.yml new file mode 100644 index 00000000..23cfb57a --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerStoredProcedureActivity.yml @@ -0,0 +1,198 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SqlServerStoredProcedureActivity +name: SqlServerStoredProcedureActivity +fullName: azure.synapse.artifacts.models.SqlServerStoredProcedureActivity +module: azure.synapse.artifacts.models +summary: 'SQL stored procedure activity type. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SqlServerStoredProcedureActivity(*, name: str, stored_procedure_name: object, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, depends_on: List[ActivityDependency] | None = None, user_properties: List[UserProperty] + | None = None, linked_service_name: LinkedServiceReference | None = None, policy: + ActivityPolicy | None = None, stored_procedure_parameters: Dict[str, StoredProcedureParameter] + | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + - name: stored_procedure_name + description: 'Required. Stored procedure name. Type: string (or Expression with + + resultType string).' + isRequired: true + types: + - + - name: stored_procedure_parameters + description: 'Value and type setting for stored procedure parameters. + + Example: "{Parameter1: {value: "1", type: "int"}}".' + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: name + isRequired: true + - name: stored_procedure_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true + - name: stored_procedure_parameters + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SqlServerStoredProcedureActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SqlServerStoredProcedureActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SqlServerStoredProcedureActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SqlServerStoredProcedureActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SqlServerStoredProcedureActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SqlServerStoredProcedureActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SqlServerStoredProcedureActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerTableDataset.yml new file mode 100644 index 00000000..43f4445c --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerTableDataset.yml @@ -0,0 +1,224 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SqlServerTableDataset +name: SqlServerTableDataset +fullName: azure.synapse.artifacts.models.SqlServerTableDataset +module: azure.synapse.artifacts.models +summary: 'The on-premises SQL Server dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SqlServerTableDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, schema_type_properties_schema: + object | None = None, table: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'This property will be retired. Please consider using schema + table + + properties instead.' + isRequired: true + types: + - + - name: schema_type_properties_schema + description: 'The schema name of the SQL Server dataset. Type: string + + (or Expression with resultType string).' + isRequired: true + types: + - + - name: table + description: 'The table name of the SQL Server dataset. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true + - name: schema_type_properties_schema + isRequired: true + - name: table + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SqlServerTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SqlServerTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SqlServerTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SqlServerTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SqlServerTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SqlServerTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SqlServerTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareLinkedService.yml new file mode 100644 index 00000000..46291a8b --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareLinkedService.yml @@ -0,0 +1,239 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SquareLinkedService +name: SquareLinkedService +fullName: azure.synapse.artifacts.models.SquareLinkedService +module: azure.synapse.artifacts.models +summary: 'Square Service linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SquareLinkedService(*, host: object, client_id: object, redirect_uri: object, + additional_properties: Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference + | None = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, client_secret: SecretBase + | None = None, use_encrypted_endpoints: object | None = None, use_host_verification: + object | None = None, use_peer_verification: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: host + description: "Required. The URL\_of the Square instance. (i.e. mystore.mysquare.com)." + isRequired: true + types: + - + - name: client_id + description: Required. The client ID associated with your Square application. + isRequired: true + types: + - + - name: client_secret + description: The client secret associated with your Square application. + isRequired: true + types: + - + - name: redirect_uri + description: 'Required. The redirect URL assigned in the Square application dashboard. + + (i.e. [http://localhost:2500](http://localhost:2500)).' + isRequired: true + types: + - + - name: use_encrypted_endpoints + description: 'Specifies whether the data source endpoints are encrypted using + + HTTPS. The default value is true.' + isRequired: true + types: + - + - name: use_host_verification + description: 'Specifies whether to require the host name in the server''s + + certificate to match the host name of the server when connecting over SSL. The + default value is + + true.' + isRequired: true + types: + - + - name: use_peer_verification + description: 'Specifies whether to verify the identity of the server when + + connecting over SSL. The default value is true.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: host + isRequired: true + - name: client_id + isRequired: true + - name: redirect_uri + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: client_secret + isRequired: true + - name: use_encrypted_endpoints + isRequired: true + - name: use_host_verification + isRequired: true + - name: use_peer_verification + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SquareLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SquareLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SquareLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SquareLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SquareLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SquareLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SquareLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareObjectDataset.yml new file mode 100644 index 00000000..78e76455 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareObjectDataset.yml @@ -0,0 +1,202 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SquareObjectDataset +name: SquareObjectDataset +fullName: azure.synapse.artifacts.models.SquareObjectDataset +module: azure.synapse.artifacts.models +summary: 'Square Service dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SquareObjectDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SquareObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SquareObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SquareObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SquareObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SquareObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SquareObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SquareObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse.yml new file mode 100644 index 00000000..3c20a3f0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse +name: SsisObjectMetadataStatusResponse +fullName: azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse +module: azure.synapse.artifacts.models +summary: The status of the operation. +constructor: + syntax: 'SsisObjectMetadataStatusResponse(*, status: str | None = None, name: str + | None = None, properties: str | None = None, error: str | None = None, **kwargs)' + parameters: + - name: status + description: The status of the operation. + isRequired: true + types: + - + - name: name + description: The operation name. + isRequired: true + types: + - + - name: properties + description: The operation properties. + isRequired: true + types: + - + - name: error + description: The operation error message. + isRequired: true + types: + - + keywordOnlyParameters: + - name: status + isRequired: true + - name: name + isRequired: true + - name: properties + isRequired: true + - name: error + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SsisPackageLocationType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SsisPackageLocationType.yml new file mode 100644 index 00000000..99d14576 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SsisPackageLocationType.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.SsisPackageLocationType +name: SsisPackageLocationType +fullName: azure.synapse.artifacts.models.SsisPackageLocationType +summary: The type of SSIS package location. +module: azure.synapse.artifacts.models +fields: +- name: file + uid: azure.synapse.artifacts.models.SsisPackageLocationType.file +- name: inline_package + uid: azure.synapse.artifacts.models.SsisPackageLocationType.inline_package +- name: ssisdb + uid: azure.synapse.artifacts.models.SsisPackageLocationType.ssisdb diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StagingSettings.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StagingSettings.yml new file mode 100644 index 00000000..8949e5a7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StagingSettings.yml @@ -0,0 +1,157 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.StagingSettings +name: StagingSettings +fullName: azure.synapse.artifacts.models.StagingSettings +module: azure.synapse.artifacts.models +summary: 'Staging settings. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'StagingSettings(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, path: object | None = None, enable_compression: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: linked_service_name + description: Required. Staging linked service reference. + isRequired: true + types: + - + - name: path + description: 'The path to storage for storing the interim data. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + - name: enable_compression + description: 'Specifies whether to use compression when copying data via an + + interim staging. Default value is false. Type: boolean (or Expression with resultType + boolean).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: path + isRequired: true + - name: enable_compression + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.StagingSettings.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.StagingSettings.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.StagingSettings.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.StagingSettings.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.StagingSettings.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.StagingSettings.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.StagingSettings.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest.yml new file mode 100644 index 00000000..661a5323 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest.yml @@ -0,0 +1,169 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest +name: StartDataFlowDebugSessionRequest +fullName: azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest +module: azure.synapse.artifacts.models +summary: Request body structure for starting data flow debug session. +constructor: + syntax: 'StartDataFlowDebugSessionRequest(*, session_id: str | None = None, data_flow: + DataFlowResource | None = None, datasets: List[DatasetResource] | None = None, + linked_services: List[LinkedServiceResource] | None = None, staging: object | + None = None, debug_settings: object | None = None, incremental_debug: bool | None + = None, **kwargs)' + parameters: + - name: session_id + description: The ID of data flow debug session. + isRequired: true + types: + - + - name: data_flow + description: Data flow instance. + isRequired: true + types: + - + - name: datasets + description: List of datasets. + isRequired: true + types: + - [] + - name: linked_services + description: List of linked services. + isRequired: true + types: + - [] + - name: staging + description: Staging info for debug session. + isRequired: true + types: + - + - name: debug_settings + description: Data flow debug settings. + isRequired: true + types: + - + - name: incremental_debug + description: The type of new Databricks cluster. + isRequired: true + types: + - + keywordOnlyParameters: + - name: session_id + isRequired: true + - name: data_flow + isRequired: true + - name: datasets + isRequired: true + - name: linked_services + isRequired: true + - name: staging + isRequired: true + - name: debug_settings + isRequired: true + - name: incremental_debug + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse.yml new file mode 100644 index 00000000..58d63365 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse +name: StartDataFlowDebugSessionResponse +fullName: azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse +module: azure.synapse.artifacts.models +summary: Response body structure for starting data flow debug session. +constructor: + syntax: 'StartDataFlowDebugSessionResponse(*, job_version: str | None = None, **kwargs)' + parameters: + - name: job_version + description: The ID of data flow debug job version. + isRequired: true + types: + - + keywordOnlyParameters: + - name: job_version + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoredProcedureParameter.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoredProcedureParameter.yml new file mode 100644 index 00000000..4208f6a4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoredProcedureParameter.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.StoredProcedureParameter +name: StoredProcedureParameter +fullName: azure.synapse.artifacts.models.StoredProcedureParameter +module: azure.synapse.artifacts.models +summary: SQL stored procedure parameter. +constructor: + syntax: 'StoredProcedureParameter(*, value: object | None = None, type: str | StoredProcedureParameterType + | None = None, **kwargs)' + parameters: + - name: value + description: 'Stored procedure parameter value. Type: string (or Expression with + resultType + + string).' + isRequired: true + types: + - + - name: type + description: 'Stored procedure parameter type. Possible values include: "String", + "Int", + + "Int64", "Decimal", "Guid", "Boolean", "Date".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: type + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.StoredProcedureParameter.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.StoredProcedureParameter.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.StoredProcedureParameter.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.StoredProcedureParameter.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.StoredProcedureParameter.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.StoredProcedureParameter.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.StoredProcedureParameter.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoredProcedureParameterType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoredProcedureParameterType.yml new file mode 100644 index 00000000..34a21691 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoredProcedureParameterType.yml @@ -0,0 +1,21 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.StoredProcedureParameterType +name: StoredProcedureParameterType +fullName: azure.synapse.artifacts.models.StoredProcedureParameterType +summary: Stored procedure parameter type. +module: azure.synapse.artifacts.models +fields: +- name: boolean + uid: azure.synapse.artifacts.models.StoredProcedureParameterType.boolean +- name: date + uid: azure.synapse.artifacts.models.StoredProcedureParameterType.date +- name: decimal + uid: azure.synapse.artifacts.models.StoredProcedureParameterType.decimal +- name: guid + uid: azure.synapse.artifacts.models.StoredProcedureParameterType.guid +- name: int + uid: azure.synapse.artifacts.models.StoredProcedureParameterType.int +- name: int64 + uid: azure.synapse.artifacts.models.StoredProcedureParameterType.int64 +- name: string + uid: azure.synapse.artifacts.models.StoredProcedureParameterType.string diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SubResource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SubResource.yml new file mode 100644 index 00000000..aa6e82d2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SubResource.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SubResource +name: SubResource +fullName: azure.synapse.artifacts.models.SubResource +module: azure.synapse.artifacts.models +summary: 'Azure Synapse nested resource, which belongs to a workspace. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: SubResource(**kwargs) +variables: +- description: The resource identifier. + name: id + types: + - +- description: The resource name. + name: name + types: + - +- description: The resource type. + name: type + types: + - +- description: Etag identifies change in the resource. + name: etag + types: + - +methods: +- uid: azure.synapse.artifacts.models.SubResource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SubResource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SubResource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SubResource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SubResource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SubResource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SubResource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SubResourceDebugResource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SubResourceDebugResource.yml new file mode 100644 index 00000000..ca450e4a --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SubResourceDebugResource.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SubResourceDebugResource +name: SubResourceDebugResource +fullName: azure.synapse.artifacts.models.SubResourceDebugResource +module: azure.synapse.artifacts.models +summary: Azure Synapse nested debug resource. +constructor: + syntax: 'SubResourceDebugResource(*, name: str | None = None, **kwargs)' + parameters: + - name: name + description: The resource name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SubResourceDebugResource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SubResourceDebugResource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SubResourceDebugResource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SubResourceDebugResource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SubResourceDebugResource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SubResourceDebugResource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SubResourceDebugResource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchActivity.yml new file mode 100644 index 00000000..07f19eb5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchActivity.yml @@ -0,0 +1,199 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SwitchActivity +name: SwitchActivity +fullName: azure.synapse.artifacts.models.SwitchActivity +module: azure.synapse.artifacts.models +summary: 'This activity evaluates an expression and executes activities under the + cases property that correspond to the expression evaluation expected in the equals + property. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SwitchActivity(*, name: str, on: Expression, additional_properties: Dict[str, + object] | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, cases: List[SwitchCase] + | None = None, default_activities: List[Activity] | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: 'on' + description: 'Required. An expression that would evaluate to a string or integer. + This is used to + + determine the block of activities in cases that will be executed.' + isRequired: true + types: + - + - name: cases + description: 'List of cases that correspond to expected values of the ''on'' property. + This is an + + optional property and if not provided, the activity will execute activities + provided in + + defaultActivities.' + isRequired: true + types: + - [] + - name: default_activities + description: 'List of activities to execute if no case condition is satisfied. + + This is an optional property and if not provided, the activity will exit without + any action.' + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: name + isRequired: true + - name: 'on' + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: cases + isRequired: true + - name: default_activities + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SwitchActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SwitchActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SwitchActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SwitchActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SwitchActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SwitchActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SwitchActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchCase.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchCase.yml new file mode 100644 index 00000000..bf994543 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchCase.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SwitchCase +name: SwitchCase +fullName: azure.synapse.artifacts.models.SwitchCase +module: azure.synapse.artifacts.models +summary: Switch cases with have a value and corresponding activities. +constructor: + syntax: 'SwitchCase(*, value: str | None = None, activities: List[Activity] | None + = None, **kwargs)' + parameters: + - name: value + description: Expected value that satisfies the expression result of the 'on' property. + isRequired: true + types: + - + - name: activities + description: List of activities to execute for satisfied case condition. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: value + isRequired: true + - name: activities + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SwitchCase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SwitchCase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SwitchCase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SwitchCase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SwitchCase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SwitchCase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SwitchCase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseAuthenticationType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseAuthenticationType.yml new file mode 100644 index 00000000..d04b3ca7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseAuthenticationType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.SybaseAuthenticationType +name: SybaseAuthenticationType +fullName: azure.synapse.artifacts.models.SybaseAuthenticationType +summary: AuthenticationType to be used for connection. +module: azure.synapse.artifacts.models +fields: +- name: basic + uid: azure.synapse.artifacts.models.SybaseAuthenticationType.basic +- name: windows + uid: azure.synapse.artifacts.models.SybaseAuthenticationType.windows diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseLinkedService.yml new file mode 100644 index 00000000..709fe889 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseLinkedService.yml @@ -0,0 +1,233 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SybaseLinkedService +name: SybaseLinkedService +fullName: azure.synapse.artifacts.models.SybaseLinkedService +module: azure.synapse.artifacts.models +summary: 'Linked service for Sybase data source. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SybaseLinkedService(*, server: object, database: object, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, schema: object | None + = None, authentication_type: str | SybaseAuthenticationType | None = None, username: + object | None = None, password: SecretBase | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: server + description: 'Required. Server name for connection. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: database + description: 'Required. Database name for connection. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: schema + description: 'Schema name for connection. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: authentication_type + description: 'AuthenticationType to be used for connection. Possible values + + include: "Basic", "Windows".' + isRequired: true + types: + - + - + - name: username + description: 'Username for authentication. Type: string (or Expression with resultType + + string).' + isRequired: true + types: + - + - name: password + description: Password for authentication. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: server + isRequired: true + - name: database + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: schema + isRequired: true + - name: authentication_type + isRequired: true + - name: username + isRequired: true + - name: password + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SybaseLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SybaseLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SybaseLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SybaseLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SybaseLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SybaseLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SybaseLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseTableDataset.yml new file mode 100644 index 00000000..e3f159c6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseTableDataset.yml @@ -0,0 +1,203 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.SybaseTableDataset +name: SybaseTableDataset +fullName: azure.synapse.artifacts.models.SybaseTableDataset +module: azure.synapse.artifacts.models +summary: 'The Sybase table dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SybaseTableDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The Sybase table name. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.SybaseTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SybaseTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SybaseTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.SybaseTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.SybaseTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.SybaseTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.SybaseTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataAuthenticationType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataAuthenticationType.yml new file mode 100644 index 00000000..58817545 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataAuthenticationType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.TeradataAuthenticationType +name: TeradataAuthenticationType +fullName: azure.synapse.artifacts.models.TeradataAuthenticationType +summary: AuthenticationType to be used for connection. +module: azure.synapse.artifacts.models +fields: +- name: basic + uid: azure.synapse.artifacts.models.TeradataAuthenticationType.basic +- name: windows + uid: azure.synapse.artifacts.models.TeradataAuthenticationType.windows diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataLinkedService.yml new file mode 100644 index 00000000..b814566c --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataLinkedService.yml @@ -0,0 +1,222 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.TeradataLinkedService +name: TeradataLinkedService +fullName: azure.synapse.artifacts.models.TeradataLinkedService +module: azure.synapse.artifacts.models +summary: 'Linked service for Teradata data source. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TeradataLinkedService(*, additional_properties: Dict[str, object] | None + = None, connect_via: IntegrationRuntimeReference | None = None, description: str + | None = None, parameters: Dict[str, ParameterSpecification] | None = None, annotations: + List[object] | None = None, connection_string: object | None = None, server: object + | None = None, authentication_type: str | TeradataAuthenticationType | None = + None, username: object | None = None, password: SecretBase | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'Teradata ODBC connection string. Type: string, SecureString or + + AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: server + description: 'Server name for connection. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: authentication_type + description: 'AuthenticationType to be used for connection. Possible values + + include: "Basic", "Windows".' + isRequired: true + types: + - + - + - name: username + description: 'Username for authentication. Type: string (or Expression with resultType + + string).' + isRequired: true + types: + - + - name: password + description: Password for authentication. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: connection_string + isRequired: true + - name: server + isRequired: true + - name: authentication_type + isRequired: true + - name: username + isRequired: true + - name: password + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.TeradataLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.TeradataLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.TeradataLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.TeradataLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.TeradataLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.TeradataLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.TeradataLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataTableDataset.yml new file mode 100644 index 00000000..4eb686cc --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataTableDataset.yml @@ -0,0 +1,213 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.TeradataTableDataset +name: TeradataTableDataset +fullName: azure.synapse.artifacts.models.TeradataTableDataset +module: azure.synapse.artifacts.models +summary: 'The Teradata database dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TeradataTableDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, database: object | None = None, table: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: database + description: 'The database name of Teradata. Type: string (or Expression with + resultType + + string).' + isRequired: true + types: + - + - name: table + description: 'The table name of Teradata. Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: database + isRequired: true + - name: table + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.TeradataTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.TeradataTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.TeradataTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.TeradataTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.TeradataTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.TeradataTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.TeradataTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Transformation.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Transformation.yml new file mode 100644 index 00000000..d9f8e7de --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Transformation.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.Transformation +name: Transformation +fullName: azure.synapse.artifacts.models.Transformation +module: azure.synapse.artifacts.models +summary: 'A data flow transformation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Transformation(*, name: str, description: str | None = None, **kwargs)' + parameters: + - name: name + description: Required. Transformation name. + isRequired: true + types: + - + - name: description + description: Transformation description. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: description + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.Transformation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Transformation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Transformation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.Transformation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Transformation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.Transformation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Transformation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Trigger.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Trigger.yml new file mode 100644 index 00000000..f3352756 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Trigger.yml @@ -0,0 +1,166 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.Trigger +name: Trigger +fullName: azure.synapse.artifacts.models.Trigger +module: azure.synapse.artifacts.models +summary: 'Azure Synapse nested object which contains information about creating pipeline + run. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: MultiplePipelineTrigger, RerunTumblingWindowTrigger. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'Trigger(*, additional_properties: Dict[str, object] | None = None, description: + str | None = None, annotations: List[object] | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Trigger type.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Trigger description. + isRequired: true + types: + - + - name: annotations + description: List of tags that can be used for describing the trigger. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: annotations + isRequired: true +variables: +- description: 'Indicates if trigger is running or not. Updated when Start/Stop APIs + are + + called on the Trigger. Possible values include: "Started", "Stopped", "Disabled".' + name: runtime_state + types: + - + - +methods: +- uid: azure.synapse.artifacts.models.Trigger.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Trigger.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Trigger.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.Trigger.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Trigger.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.Trigger.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Trigger.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus.yml new file mode 100644 index 00000000..a5ad4187 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus +name: TriggerDependencyProvisioningStatus +fullName: azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus +module: azure.synapse.artifacts.models +summary: 'Defines the response of a provision trigger dependency operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TriggerDependencyProvisioningStatus(*, trigger_name: str, provisioning_status: + str, **kwargs)' + parameters: + - name: trigger_name + description: Required. Trigger name. + isRequired: true + types: + - + - name: provisioning_status + description: Required. Provisioning status. + isRequired: true + types: + - + keywordOnlyParameters: + - name: trigger_name + isRequired: true + - name: provisioning_status + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerListResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerListResponse.yml new file mode 100644 index 00000000..fcc870e2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerListResponse.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.TriggerListResponse +name: TriggerListResponse +fullName: azure.synapse.artifacts.models.TriggerListResponse +module: azure.synapse.artifacts.models +summary: 'A list of trigger resources. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TriggerListResponse(*, value: List[TriggerResource], next_link: str | None + = None, **kwargs)' + parameters: + - name: value + description: Required. List of triggers. + isRequired: true + types: + - [] + - name: next_link + description: The link to the next page of results, if any remaining results exist. + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: next_link + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.TriggerListResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.TriggerListResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.TriggerListResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.TriggerListResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.TriggerListResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.TriggerListResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.TriggerListResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerPipelineReference.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerPipelineReference.yml new file mode 100644 index 00000000..9d8a2197 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerPipelineReference.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.TriggerPipelineReference +name: TriggerPipelineReference +fullName: azure.synapse.artifacts.models.TriggerPipelineReference +module: azure.synapse.artifacts.models +summary: Pipeline that needs to be triggered with the given parameters. +constructor: + syntax: 'TriggerPipelineReference(*, pipeline_reference: PipelineReference | None + = None, parameters: Dict[str, object] | None = None, **kwargs)' + parameters: + - name: pipeline_reference + description: Pipeline reference. + isRequired: true + types: + - + - name: parameters + description: Pipeline parameters. + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: pipeline_reference + isRequired: true + - name: parameters + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.TriggerPipelineReference.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.TriggerPipelineReference.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.TriggerPipelineReference.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.TriggerPipelineReference.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.TriggerPipelineReference.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.TriggerPipelineReference.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.TriggerPipelineReference.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerResource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerResource.yml new file mode 100644 index 00000000..ba89173d --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerResource.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.TriggerResource +name: TriggerResource +fullName: azure.synapse.artifacts.models.TriggerResource +module: azure.synapse.artifacts.models +summary: 'Trigger resource type. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TriggerResource(*, properties: Trigger, **kwargs)' + parameters: + - name: properties + description: Required. Properties of the trigger. + isRequired: true + types: + - + keywordOnlyParameters: + - name: properties + isRequired: true +variables: +- description: The resource identifier. + name: id + types: + - +- description: The resource name. + name: name + types: + - +- description: The resource type. + name: type + types: + - +- description: Etag identifies change in the resource. + name: etag + types: + - +methods: +- uid: azure.synapse.artifacts.models.TriggerResource.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.TriggerResource.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.TriggerResource.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.TriggerResource.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.TriggerResource.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.TriggerResource.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.TriggerResource.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRun.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRun.yml new file mode 100644 index 00000000..4b0f3392 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRun.yml @@ -0,0 +1,166 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.TriggerRun +name: TriggerRun +fullName: azure.synapse.artifacts.models.TriggerRun +module: azure.synapse.artifacts.models +summary: 'Trigger runs. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'TriggerRun(*, additional_properties: Dict[str, object] | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + keywordOnlyParameters: + - name: additional_properties + isRequired: true +variables: +- description: Trigger run id. + name: trigger_run_id + types: + - +- description: Trigger name. + name: trigger_name + types: + - +- description: Trigger type. + name: trigger_type + types: + - +- description: Trigger run start time. + name: trigger_run_timestamp + types: + - +- description: 'Trigger run status. Possible values include: "Succeeded", "Failed", + "Inprogress".' + name: status + types: + - + - +- description: Trigger error message. + name: message + types: + - +- description: 'List of property name and value related to trigger run. Name, value + pair + + depends on type of trigger.' + name: properties + types: + - [, ] +- description: List of pipeline name and run Id triggered by the trigger run. + name: triggered_pipelines + types: + - [, ] +methods: +- uid: azure.synapse.artifacts.models.TriggerRun.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.TriggerRun.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.TriggerRun.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.TriggerRun.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.TriggerRun.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.TriggerRun.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.TriggerRun.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRunStatus.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRunStatus.yml new file mode 100644 index 00000000..976ee367 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRunStatus.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.TriggerRunStatus +name: TriggerRunStatus +fullName: azure.synapse.artifacts.models.TriggerRunStatus +summary: Trigger run status. +module: azure.synapse.artifacts.models +fields: +- name: failed + uid: azure.synapse.artifacts.models.TriggerRunStatus.failed +- name: inprogress + uid: azure.synapse.artifacts.models.TriggerRunStatus.inprogress +- name: succeeded + uid: azure.synapse.artifacts.models.TriggerRunStatus.succeeded diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRunsQueryResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRunsQueryResponse.yml new file mode 100644 index 00000000..0aa95eff --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRunsQueryResponse.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.TriggerRunsQueryResponse +name: TriggerRunsQueryResponse +fullName: azure.synapse.artifacts.models.TriggerRunsQueryResponse +module: azure.synapse.artifacts.models +summary: 'A list of trigger runs. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'TriggerRunsQueryResponse(*, value: List[TriggerRun], continuation_token: + str | None = None, **kwargs)' + parameters: + - name: value + description: Required. List of trigger runs. + isRequired: true + types: + - [] + - name: continuation_token + description: 'The continuation token for getting the next page of results, if + any + + remaining results exist, null otherwise.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: value + isRequired: true + - name: continuation_token + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.TriggerRunsQueryResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.TriggerRunsQueryResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.TriggerRunsQueryResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.TriggerRunsQueryResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.TriggerRunsQueryResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.TriggerRunsQueryResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.TriggerRunsQueryResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRuntimeState.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRuntimeState.yml new file mode 100644 index 00000000..0f08969c --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRuntimeState.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.TriggerRuntimeState +name: TriggerRuntimeState +fullName: azure.synapse.artifacts.models.TriggerRuntimeState +summary: Enumerates possible state of Triggers. +module: azure.synapse.artifacts.models +fields: +- name: disabled + uid: azure.synapse.artifacts.models.TriggerRuntimeState.disabled +- name: started + uid: azure.synapse.artifacts.models.TriggerRuntimeState.started +- name: stopped + uid: azure.synapse.artifacts.models.TriggerRuntimeState.stopped diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus.yml new file mode 100644 index 00000000..1bfb06c7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus +name: TriggerSubscriptionOperationStatus +fullName: azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus +module: azure.synapse.artifacts.models +summary: 'Defines the response of a trigger subscription operation. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: TriggerSubscriptionOperationStatus(**kwargs) +variables: +- description: Trigger name. + name: trigger_name + types: + - +- description: 'Event Subscription Status. Possible values include: "Enabled", "Provisioning", + + "Deprovisioning", "Disabled", "Unknown".' + name: status + types: + - + - +methods: +- uid: azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.UntilActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.UntilActivity.yml new file mode 100644 index 00000000..bc03befe --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.UntilActivity.yml @@ -0,0 +1,200 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.UntilActivity +name: UntilActivity +fullName: azure.synapse.artifacts.models.UntilActivity +module: azure.synapse.artifacts.models +summary: 'This activity executes inner activities until the specified boolean expression + results to true or timeout is reached, whichever is earlier. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'UntilActivity(*, name: str, expression: Expression, activities: List[Activity], + additional_properties: Dict[str, object] | None = None, description: str | None + = None, depends_on: List[ActivityDependency] | None = None, user_properties: List[UserProperty] + | None = None, timeout: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: expression + description: 'Required. An expression that would evaluate to Boolean. The loop + will + + continue until this expression evaluates to true.' + isRequired: true + types: + - + - name: timeout + description: 'Specifies the timeout for the activity to run. If there is no value + specified, + + it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: + string (or + + Expression with resultType string), pattern: + + ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])). Type: string (or Expression + with + + resultType string), pattern: ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).' + isRequired: true + types: + - + - name: activities + description: Required. List of activities to execute. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: name + isRequired: true + - name: expression + isRequired: true + - name: activities + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: timeout + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.UntilActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.UntilActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.UntilActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.UntilActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.UntilActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.UntilActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.UntilActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.UserProperty.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.UserProperty.yml new file mode 100644 index 00000000..0f80f73d --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.UserProperty.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.UserProperty +name: UserProperty +fullName: azure.synapse.artifacts.models.UserProperty +module: azure.synapse.artifacts.models +summary: 'User property. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'UserProperty(*, name: str, value: object, **kwargs)' + parameters: + - name: name + description: Required. User property name. + isRequired: true + types: + - + - name: value + description: 'Required. User property value. Type: string (or Expression with + resultType + + string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: value + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.UserProperty.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.UserProperty.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.UserProperty.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.UserProperty.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.UserProperty.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.UserProperty.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.UserProperty.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ValidationActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ValidationActivity.yml new file mode 100644 index 00000000..d28296c5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ValidationActivity.yml @@ -0,0 +1,222 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ValidationActivity +name: ValidationActivity +fullName: azure.synapse.artifacts.models.ValidationActivity +module: azure.synapse.artifacts.models +summary: 'This activity verifies that an external resource exists. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ValidationActivity(*, name: str, dataset: DatasetReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, timeout: object + | None = None, sleep: object | None = None, minimum_size: object | None = None, + child_items: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: timeout + description: 'Specifies the timeout for the activity to run. If there is no value + specified, + + it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: + string (or + + Expression with resultType string), pattern: + + ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).' + isRequired: true + types: + - + - name: sleep + description: 'A delay in seconds between validation attempts. If no value is specified, + 10 + + seconds will be used as the default. Type: integer (or Expression with resultType + integer).' + isRequired: true + types: + - + - name: minimum_size + description: 'Can be used if dataset points to a file. The file must be greater + than or + + equal in size to the value specified. Type: integer (or Expression with resultType + integer).' + isRequired: true + types: + - + - name: child_items + description: 'Can be used if dataset points to a folder. If set to true, the folder + must + + have at least one file. If set to false, the folder must be empty. Type: boolean + (or Expression + + with resultType boolean).' + isRequired: true + types: + - + - name: dataset + description: Required. Validation activity dataset reference. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: dataset + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: timeout + isRequired: true + - name: sleep + isRequired: true + - name: minimum_size + isRequired: true + - name: child_items + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ValidationActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ValidationActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ValidationActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ValidationActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ValidationActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ValidationActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ValidationActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VariableSpecification.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VariableSpecification.yml new file mode 100644 index 00000000..d62c7891 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VariableSpecification.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.VariableSpecification +name: VariableSpecification +fullName: azure.synapse.artifacts.models.VariableSpecification +module: azure.synapse.artifacts.models +summary: 'Definition of a single variable for a Pipeline. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'VariableSpecification(*, type: str | VariableType, default_value: object + | None = None, **kwargs)' + parameters: + - name: type + description: 'Required. Variable type. Possible values include: "String", "Bool", + "Boolean", + + "Array".' + isRequired: true + types: + - + - + - name: default_value + description: Default value of variable. + isRequired: true + types: + - + keywordOnlyParameters: + - name: type + isRequired: true + - name: default_value + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.VariableSpecification.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.VariableSpecification.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.VariableSpecification.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.VariableSpecification.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.VariableSpecification.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.VariableSpecification.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.VariableSpecification.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VariableType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VariableType.yml new file mode 100644 index 00000000..dc822f15 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VariableType.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.VariableType +name: VariableType +fullName: azure.synapse.artifacts.models.VariableType +summary: Variable type. +module: azure.synapse.artifacts.models +fields: +- name: array + uid: azure.synapse.artifacts.models.VariableType.array +- name: bool + uid: azure.synapse.artifacts.models.VariableType.bool +- name: boolean + uid: azure.synapse.artifacts.models.VariableType.boolean +- name: string + uid: azure.synapse.artifacts.models.VariableType.string diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaLinkedService.yml new file mode 100644 index 00000000..dd4a3fbd --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaLinkedService.yml @@ -0,0 +1,193 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.VerticaLinkedService +name: VerticaLinkedService +fullName: azure.synapse.artifacts.models.VerticaLinkedService +module: azure.synapse.artifacts.models +summary: 'Vertica linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'VerticaLinkedService(*, additional_properties: Dict[str, object] | None + = None, connect_via: IntegrationRuntimeReference | None = None, description: str + | None = None, parameters: Dict[str, ParameterSpecification] | None = None, annotations: + List[object] | None = None, connection_string: object | None = None, pwd: AzureKeyVaultSecretReference + | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: connection_string + description: 'An ODBC connection string. Type: string, SecureString or + + AzureKeyVaultSecretReference.' + isRequired: true + types: + - + - name: pwd + description: The Azure key vault secret reference of password in connection string. + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: connection_string + isRequired: true + - name: pwd + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.VerticaLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.VerticaLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.VerticaLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.VerticaLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.VerticaLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.VerticaLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.VerticaLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaTableDataset.yml new file mode 100644 index 00000000..0ef394b5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaTableDataset.yml @@ -0,0 +1,224 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.VerticaTableDataset +name: VerticaTableDataset +fullName: azure.synapse.artifacts.models.VerticaTableDataset +module: azure.synapse.artifacts.models +summary: 'Vertica dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'VerticaTableDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, table: object | None = None, + schema_type_properties_schema: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'This property will be retired. Please consider using schema + table + + properties instead.' + isRequired: true + types: + - + - name: table + description: 'The table name of the Vertica. Type: string (or Expression with + resultType + + string).' + isRequired: true + types: + - + - name: schema_type_properties_schema + description: 'The schema name of the Vertica. Type: string (or + + Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true + - name: table + isRequired: true + - name: schema_type_properties_schema + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.VerticaTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.VerticaTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.VerticaTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.VerticaTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.VerticaTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.VerticaTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.VerticaTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WaitActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WaitActivity.yml new file mode 100644 index 00000000..be11a9c0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WaitActivity.yml @@ -0,0 +1,170 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.WaitActivity +name: WaitActivity +fullName: azure.synapse.artifacts.models.WaitActivity +module: azure.synapse.artifacts.models +summary: 'This activity suspends pipeline execution for the specified interval. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'WaitActivity(*, name: str, wait_time_in_seconds: int, additional_properties: + Dict[str, object] | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: wait_time_in_seconds + description: Required. Duration in seconds. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: wait_time_in_seconds + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.WaitActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WaitActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WaitActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.WaitActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WaitActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.WaitActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WaitActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivity.yml new file mode 100644 index 00000000..6a43b4af --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivity.yml @@ -0,0 +1,255 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.WebActivity +name: WebActivity +fullName: azure.synapse.artifacts.models.WebActivity +module: azure.synapse.artifacts.models +summary: 'Web activity. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'WebActivity(*, name: str, method: str | WebActivityMethod, url: object, + additional_properties: Dict[str, object] | None = None, description: str | None + = None, depends_on: List[ActivityDependency] | None = None, user_properties: List[UserProperty] + | None = None, linked_service_name: LinkedServiceReference | None = None, policy: + ActivityPolicy | None = None, headers: object | None = None, body: object | None + = None, authentication: WebActivityAuthentication | None = None, datasets: List[DatasetReference] + | None = None, linked_services: List[LinkedServiceReference] | None = None, connect_via: + IntegrationRuntimeReference | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: linked_service_name + description: Linked service reference. + isRequired: true + types: + - + - name: policy + description: Activity policy. + isRequired: true + types: + - + - name: method + description: 'Required. Rest API method for target endpoint. Possible values include: + "GET", + + "POST", "PUT", "DELETE".' + isRequired: true + types: + - + - + - name: url + description: 'Required. Web activity target endpoint and path. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + - name: headers + description: 'Represents the headers that will be sent to the request. For example, + to set + + the language and type on a request: "headers" : { "Accept-Language": "en-us", + "Content-Type": + + "application/json" }. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: body + description: 'Represents the payload that will be sent to the endpoint. Required + for POST/PUT + + method, not allowed for GET method Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: authentication + description: Authentication method used for calling the endpoint. + isRequired: true + types: + - + - name: datasets + description: List of datasets passed to web endpoint. + isRequired: true + types: + - [] + - name: linked_services + description: List of linked services passed to web endpoint. + isRequired: true + types: + - [] + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: method + isRequired: true + - name: url + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: linked_service_name + isRequired: true + - name: policy + isRequired: true + - name: headers + isRequired: true + - name: body + isRequired: true + - name: authentication + isRequired: true + - name: datasets + isRequired: true + - name: linked_services + isRequired: true + - name: connect_via + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.WebActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WebActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WebActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.WebActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WebActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.WebActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WebActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivityAuthentication.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivityAuthentication.yml new file mode 100644 index 00000000..02602d9e --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivityAuthentication.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.WebActivityAuthentication +name: WebActivityAuthentication +fullName: azure.synapse.artifacts.models.WebActivityAuthentication +module: azure.synapse.artifacts.models +summary: 'Web activity authentication properties. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'WebActivityAuthentication(*, type: str, pfx: SecretBase | None = None, + username: str | None = None, password: SecretBase | None = None, resource: str + | None = None, **kwargs)' + parameters: + - name: type + description: Required. Web activity authentication (Basic/ClientCertificate/MSI). + isRequired: true + types: + - + - name: pfx + description: Base64-encoded contents of a PFX file. + isRequired: true + types: + - + - name: username + description: Web activity authentication user name for basic authentication. + isRequired: true + types: + - + - name: password + description: Password for the PFX file or basic authentication. + isRequired: true + types: + - + - name: resource + description: 'Resource for which Azure Auth token will be requested when using + MSI + + Authentication.' + isRequired: true + types: + - + keywordOnlyParameters: + - name: type + isRequired: true + - name: pfx + isRequired: true + - name: username + isRequired: true + - name: password + isRequired: true + - name: resource + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.WebActivityAuthentication.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WebActivityAuthentication.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WebActivityAuthentication.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.WebActivityAuthentication.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WebActivityAuthentication.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.WebActivityAuthentication.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WebActivityAuthentication.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivityMethod.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivityMethod.yml new file mode 100644 index 00000000..b17190c9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivityMethod.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.WebActivityMethod +name: WebActivityMethod +fullName: azure.synapse.artifacts.models.WebActivityMethod +summary: The list of HTTP methods supported by a WebActivity. +module: azure.synapse.artifacts.models +fields: +- name: delete + uid: azure.synapse.artifacts.models.WebActivityMethod.delete +- name: get + uid: azure.synapse.artifacts.models.WebActivityMethod.get +- name: post + uid: azure.synapse.artifacts.models.WebActivityMethod.post +- name: put + uid: azure.synapse.artifacts.models.WebActivityMethod.put diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebAnonymousAuthentication.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebAnonymousAuthentication.yml new file mode 100644 index 00000000..0a085e14 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebAnonymousAuthentication.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.WebAnonymousAuthentication +name: WebAnonymousAuthentication +fullName: azure.synapse.artifacts.models.WebAnonymousAuthentication +module: azure.synapse.artifacts.models +summary: 'A WebLinkedService that uses anonymous authentication to communicate with + an HTTP endpoint. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'WebAnonymousAuthentication(*, url: object, **kwargs)' + parameters: + - name: url + description: 'Required. The URL of the web service endpoint, e.g. [http://www.microsoft.com](http://www.microsoft.com) + . + + Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: authentication_type + description: 'Required. Type of authentication used to connect to the web table + + source.Constant filled by server. Possible values include: "Basic", "Anonymous", + + "ClientCertificate".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: url + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.WebAnonymousAuthentication.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WebAnonymousAuthentication.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WebAnonymousAuthentication.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.WebAnonymousAuthentication.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WebAnonymousAuthentication.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.WebAnonymousAuthentication.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WebAnonymousAuthentication.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebAuthenticationType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebAuthenticationType.yml new file mode 100644 index 00000000..fe990f36 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebAuthenticationType.yml @@ -0,0 +1,13 @@ +### YamlMime:PythonEnum +uid: azure.synapse.artifacts.models.WebAuthenticationType +name: WebAuthenticationType +fullName: azure.synapse.artifacts.models.WebAuthenticationType +summary: Type of authentication used to connect to the web table source. +module: azure.synapse.artifacts.models +fields: +- name: anonymous + uid: azure.synapse.artifacts.models.WebAuthenticationType.anonymous +- name: basic + uid: azure.synapse.artifacts.models.WebAuthenticationType.basic +- name: client_certificate + uid: azure.synapse.artifacts.models.WebAuthenticationType.client_certificate diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebBasicAuthentication.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebBasicAuthentication.yml new file mode 100644 index 00000000..d2965260 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebBasicAuthentication.yml @@ -0,0 +1,158 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.WebBasicAuthentication +name: WebBasicAuthentication +fullName: azure.synapse.artifacts.models.WebBasicAuthentication +module: azure.synapse.artifacts.models +summary: 'A WebLinkedService that uses basic authentication to communicate with an + HTTP endpoint. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'WebBasicAuthentication(*, url: object, username: object, password: SecretBase, + **kwargs)' + parameters: + - name: url + description: 'Required. The URL of the web service endpoint, e.g. [http://www.microsoft.com](http://www.microsoft.com) + . + + Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: authentication_type + description: 'Required. Type of authentication used to connect to the web table + + source.Constant filled by server. Possible values include: "Basic", "Anonymous", + + "ClientCertificate".' + isRequired: true + types: + - + - + - name: username + description: 'Required. User name for Basic authentication. Type: string (or Expression + with + + resultType string).' + isRequired: true + types: + - + - name: password + description: Required. The password for Basic authentication. + isRequired: true + types: + - + keywordOnlyParameters: + - name: url + isRequired: true + - name: username + isRequired: true + - name: password + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.WebBasicAuthentication.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WebBasicAuthentication.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WebBasicAuthentication.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.WebBasicAuthentication.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WebBasicAuthentication.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.WebBasicAuthentication.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WebBasicAuthentication.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebClientCertificateAuthentication.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebClientCertificateAuthentication.yml new file mode 100644 index 00000000..e2756fe1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebClientCertificateAuthentication.yml @@ -0,0 +1,156 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.WebClientCertificateAuthentication +name: WebClientCertificateAuthentication +fullName: azure.synapse.artifacts.models.WebClientCertificateAuthentication +module: azure.synapse.artifacts.models +summary: 'A WebLinkedService that uses client certificate based authentication to + communicate with an HTTP endpoint. This scheme follows mutual authentication; the + server must also provide valid credentials to the client. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'WebClientCertificateAuthentication(*, url: object, pfx: SecretBase, password: + SecretBase, **kwargs)' + parameters: + - name: url + description: 'Required. The URL of the web service endpoint, e.g. [http://www.microsoft.com](http://www.microsoft.com) + . + + Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: authentication_type + description: 'Required. Type of authentication used to connect to the web table + + source.Constant filled by server. Possible values include: "Basic", "Anonymous", + + "ClientCertificate".' + isRequired: true + types: + - + - + - name: pfx + description: Required. Base64-encoded contents of a PFX file. + isRequired: true + types: + - + - name: password + description: Required. Password for the PFX file. + isRequired: true + types: + - + keywordOnlyParameters: + - name: url + isRequired: true + - name: pfx + isRequired: true + - name: password + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.WebClientCertificateAuthentication.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WebClientCertificateAuthentication.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WebClientCertificateAuthentication.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.WebClientCertificateAuthentication.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WebClientCertificateAuthentication.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.WebClientCertificateAuthentication.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WebClientCertificateAuthentication.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebHookActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebHookActivity.yml new file mode 100644 index 00000000..24993869 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebHookActivity.yml @@ -0,0 +1,241 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.WebHookActivity +name: WebHookActivity +fullName: azure.synapse.artifacts.models.WebHookActivity +module: azure.synapse.artifacts.models +summary: 'WebHook activity. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'WebHookActivity(*, name: str, url: object, additional_properties: Dict[str, + object] | None = None, description: str | None = None, depends_on: List[ActivityDependency] + | None = None, user_properties: List[UserProperty] | None = None, timeout: str + | None = None, headers: object | None = None, body: object | None = None, authentication: + WebActivityAuthentication | None = None, report_status_on_call_back: object | + None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: name + description: Required. Activity name. + isRequired: true + types: + - + - name: type + description: Required. Type of activity.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Activity description. + isRequired: true + types: + - + - name: depends_on + description: Activity depends on condition. + isRequired: true + types: + - [] + - name: user_properties + description: Activity user properties. + isRequired: true + types: + - [] + - name: url + description: 'Required. WebHook activity target endpoint and path. Type: string + (or Expression + + with resultType string).' + isRequired: true + types: + - + - name: timeout + description: 'The timeout within which the webhook should be called back. If there + is no + + value specified, it defaults to 10 minutes. Type: string. Pattern: + + ((d+).)?(dd):(60|([0-5][0-9])):(60|([0-5][0-9])).' + isRequired: true + types: + - + - name: headers + description: 'Represents the headers that will be sent to the request. For example, + to set + + the language and type on a request: "headers" : { "Accept-Language": "en-us", + "Content-Type": + + "application/json" }. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: body + description: 'Represents the payload that will be sent to the endpoint. Required + for POST/PUT + + method, not allowed for GET method Type: string (or Expression with resultType + string).' + isRequired: true + types: + - + - name: authentication + description: Authentication method used for calling the endpoint. + isRequired: true + types: + - + - name: report_status_on_call_back + description: "When set to true,\nstatusCode,\_output\_and\_error\_in\_callback\_\ + request\_body\_will be\nconsumed\_by\_activity.\_The\_activity\_can be marked\ + \ as failed by\_setting\_statusCode\_>=\_400 in\ncallback request. Default is\ + \ false. Type: boolean (or Expression with resultType boolean)." + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: url + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: depends_on + isRequired: true + - name: user_properties + isRequired: true + - name: timeout + isRequired: true + - name: headers + isRequired: true + - name: body + isRequired: true + - name: authentication + isRequired: true + - name: report_status_on_call_back + isRequired: true +variables: +- description: 'Required. Rest API method for target endpoint. Default value: "POST".' + name: method + types: + - +methods: +- uid: azure.synapse.artifacts.models.WebHookActivity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WebHookActivity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WebHookActivity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.WebHookActivity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WebHookActivity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.WebHookActivity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WebHookActivity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +attributes: +- uid: azure.synapse.artifacts.models.WebHookActivity.method + name: method + signature: method = 'POST' diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebLinkedService.yml new file mode 100644 index 00000000..fc73ced0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebLinkedService.yml @@ -0,0 +1,171 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.WebLinkedService +name: WebLinkedService +fullName: azure.synapse.artifacts.models.WebLinkedService +module: azure.synapse.artifacts.models +summary: 'Web linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'WebLinkedService(*, type_properties: WebLinkedServiceTypeProperties, additional_properties: + Dict[str, object] | None = None, connect_via: IntegrationRuntimeReference | None + = None, description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: type_properties + description: Required. Web linked service properties. + isRequired: true + types: + - + keywordOnlyParameters: + - name: type_properties + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.WebLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WebLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WebLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.WebLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WebLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.WebLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WebLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebLinkedServiceTypeProperties.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebLinkedServiceTypeProperties.yml new file mode 100644 index 00000000..f0d951bc --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebLinkedServiceTypeProperties.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.WebLinkedServiceTypeProperties +name: WebLinkedServiceTypeProperties +fullName: azure.synapse.artifacts.models.WebLinkedServiceTypeProperties +module: azure.synapse.artifacts.models +summary: 'Base definition of WebLinkedServiceTypeProperties, this typeProperties is + polymorphic based on authenticationType, so not flattened in SDK models. + + + You probably want to use the sub-classes and not this class directly. Known + + sub-classes are: WebAnonymousAuthentication, WebBasicAuthentication, WebClientCertificateAuthentication. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'WebLinkedServiceTypeProperties(*, url: object, **kwargs)' + parameters: + - name: url + description: 'Required. The URL of the web service endpoint, e.g. [http://www.microsoft.com](http://www.microsoft.com) + . + + Type: string (or Expression with resultType string).' + isRequired: true + types: + - + - name: authentication_type + description: 'Required. Type of authentication used to connect to the web table + + source.Constant filled by server. Possible values include: "Basic", "Anonymous", + + "ClientCertificate".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: url + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.WebLinkedServiceTypeProperties.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WebLinkedServiceTypeProperties.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WebLinkedServiceTypeProperties.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.WebLinkedServiceTypeProperties.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WebLinkedServiceTypeProperties.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.WebLinkedServiceTypeProperties.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WebLinkedServiceTypeProperties.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebTableDataset.yml new file mode 100644 index 00000000..8025e438 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebTableDataset.yml @@ -0,0 +1,216 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.WebTableDataset +name: WebTableDataset +fullName: azure.synapse.artifacts.models.WebTableDataset +module: azure.synapse.artifacts.models +summary: 'The dataset points to a HTML table in the web page. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'WebTableDataset(*, linked_service_name: LinkedServiceReference, index: + object, additional_properties: Dict[str, object] | None = None, description: str + | None = None, structure: object | None = None, schema: object | None = None, + parameters: Dict[str, ParameterSpecification] | None = None, annotations: List[object] + | None = None, folder: DatasetFolder | None = None, path: object | None = None, + **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: index + description: 'Required. The zero-based index of the table in the web page. Type: + integer (or + + Expression with resultType integer), minimum: 0.' + isRequired: true + types: + - + - name: path + description: 'The relative URL to the web page from the linked service URL. Type: + string (or + + Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: index + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: path + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.WebTableDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WebTableDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WebTableDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.WebTableDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WebTableDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.WebTableDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WebTableDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Workspace.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Workspace.yml new file mode 100644 index 00000000..28023f85 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Workspace.yml @@ -0,0 +1,195 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.Workspace +name: Workspace +fullName: azure.synapse.artifacts.models.Workspace +module: azure.synapse.artifacts.models +summary: 'Workspace resource type. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'Workspace(*, location: str | None = None, tags: Dict[str, str] | None = + None, additional_properties: Dict[str, object] | None = None, identity: WorkspaceIdentity + | None = None, default_storage: LinkedServiceReference | None = None, default_sql_server: + LinkedServiceReference | None = None, **kwargs)' + parameters: + - name: location + description: The resource location. + isRequired: true + types: + - + - name: tags + description: A set of tags. The resource tags. + isRequired: true + types: + - [, ] + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: identity + description: Managed service identity of the workspace. + isRequired: true + types: + - + - name: default_storage + description: Linked service reference. + isRequired: true + types: + - + - name: default_sql_server + description: Linked service reference. + isRequired: true + types: + - + keywordOnlyParameters: + - name: location + isRequired: true + - name: tags + isRequired: true + - name: additional_properties + isRequired: true + - name: identity + isRequired: true + - name: default_storage + isRequired: true + - name: default_sql_server + isRequired: true +variables: +- description: The resource identifier. + name: id + types: + - +- description: The resource name. + name: name + types: + - +- description: The resource type. + name: type + types: + - +- description: Etag identifies change in the resource. + name: e_tag + types: + - +- description: Workspace provisioning state, example Succeeded. + name: provisioning_state + types: + - +- description: Time the workspace was created in ISO8601 format. + name: create_time + types: + - +- description: Version of the workspace. + name: version + types: + - +methods: +- uid: azure.synapse.artifacts.models.Workspace.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Workspace.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Workspace.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.Workspace.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.Workspace.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.Workspace.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.Workspace.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceIdentity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceIdentity.yml new file mode 100644 index 00000000..151d8d86 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceIdentity.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.WorkspaceIdentity +name: WorkspaceIdentity +fullName: azure.synapse.artifacts.models.WorkspaceIdentity +module: azure.synapse.artifacts.models +summary: 'Identity properties of the workspace resource. + + + Variables are only populated by the server, and will be ignored when sending a request. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: WorkspaceIdentity(**kwargs) +variables: +- description: 'Required. The identity type. Currently the only supported type is + ''SystemAssigned''. + + Default value: "SystemAssigned".' + name: type + types: + - +- description: The principal id of the identity. + name: principal_id + types: + - +- description: The client tenant id of the identity. + name: tenant_id + types: + - +methods: +- uid: azure.synapse.artifacts.models.WorkspaceIdentity.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WorkspaceIdentity.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WorkspaceIdentity.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.WorkspaceIdentity.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WorkspaceIdentity.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.WorkspaceIdentity.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WorkspaceIdentity.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +attributes: +- uid: azure.synapse.artifacts.models.WorkspaceIdentity.type + name: type + signature: type = 'SystemAssigned' diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceUpdateParameters.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceUpdateParameters.yml new file mode 100644 index 00000000..b5b8273f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceUpdateParameters.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.WorkspaceUpdateParameters +name: WorkspaceUpdateParameters +fullName: azure.synapse.artifacts.models.WorkspaceUpdateParameters +module: azure.synapse.artifacts.models +summary: Parameters for updating a workspace resource. +constructor: + syntax: 'WorkspaceUpdateParameters(*, tags: Dict[str, str] | None = None, identity: + WorkspaceIdentity | None = None, **kwargs)' + parameters: + - name: tags + description: A set of tags. The resource tags. + isRequired: true + types: + - [, ] + - name: identity + description: Managed service identity of the workspace. + isRequired: true + types: + - + keywordOnlyParameters: + - name: tags + isRequired: true + - name: identity + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.WorkspaceUpdateParameters.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WorkspaceUpdateParameters.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WorkspaceUpdateParameters.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.WorkspaceUpdateParameters.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.WorkspaceUpdateParameters.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.WorkspaceUpdateParameters.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.WorkspaceUpdateParameters.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroLinkedService.yml new file mode 100644 index 00000000..f4c03993 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroLinkedService.yml @@ -0,0 +1,236 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.XeroLinkedService +name: XeroLinkedService +fullName: azure.synapse.artifacts.models.XeroLinkedService +module: azure.synapse.artifacts.models +summary: 'Xero Service linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'XeroLinkedService(*, host: object, additional_properties: Dict[str, object] + | None = None, connect_via: IntegrationRuntimeReference | None = None, description: + str | None = None, parameters: Dict[str, ParameterSpecification] | None = None, + annotations: List[object] | None = None, consumer_key: SecretBase | None = None, + private_key: SecretBase | None = None, use_encrypted_endpoints: object | None + = None, use_host_verification: object | None = None, use_peer_verification: object + | None = None, encrypted_credential: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: host + description: Required. The endpoint of the Xero server. (i.e. api.xero.com). + isRequired: true + types: + - + - name: consumer_key + description: The consumer key associated with the Xero application. + isRequired: true + types: + - + - name: private_key + description: 'The private key from the .pem file that was generated for your Xero + private + + application. You must include all the text from the .pem file, including the + Unix line endings( + + ).' + isRequired: true + types: + - + - name: use_encrypted_endpoints + description: 'Specifies whether the data source endpoints are encrypted using + + HTTPS. The default value is true.' + isRequired: true + types: + - + - name: use_host_verification + description: 'Specifies whether to require the host name in the server''s + + certificate to match the host name of the server when connecting over SSL. The + default value is + + true.' + isRequired: true + types: + - + - name: use_peer_verification + description: 'Specifies whether to verify the identity of the server when + + connecting over SSL. The default value is true.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: host + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: consumer_key + isRequired: true + - name: private_key + isRequired: true + - name: use_encrypted_endpoints + isRequired: true + - name: use_host_verification + isRequired: true + - name: use_peer_verification + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.XeroLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.XeroLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.XeroLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.XeroLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.XeroLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.XeroLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.XeroLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroObjectDataset.yml new file mode 100644 index 00000000..9fdb6568 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroObjectDataset.yml @@ -0,0 +1,202 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.XeroObjectDataset +name: XeroObjectDataset +fullName: azure.synapse.artifacts.models.XeroObjectDataset +module: azure.synapse.artifacts.models +summary: 'Xero Service dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'XeroObjectDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.XeroObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.XeroObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.XeroObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.XeroObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.XeroObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.XeroObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.XeroObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoLinkedService.yml new file mode 100644 index 00000000..608f1e5f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoLinkedService.yml @@ -0,0 +1,223 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ZohoLinkedService +name: ZohoLinkedService +fullName: azure.synapse.artifacts.models.ZohoLinkedService +module: azure.synapse.artifacts.models +summary: 'Zoho server linked service. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ZohoLinkedService(*, endpoint: object, additional_properties: Dict[str, + object] | None = None, connect_via: IntegrationRuntimeReference | None = None, + description: str | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, access_token: SecretBase + | None = None, use_encrypted_endpoints: object | None = None, use_host_verification: + object | None = None, use_peer_verification: object | None = None, encrypted_credential: + object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of linked service.Constant filled by server. + isRequired: true + types: + - + - name: connect_via + description: The integration runtime reference. + isRequired: true + types: + - + - name: description + description: Linked service description. + isRequired: true + types: + - + - name: parameters + description: Parameters for linked service. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the linked service. + isRequired: true + types: + - [] + - name: endpoint + description: Required. The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private). + isRequired: true + types: + - + - name: access_token + description: The access token for Zoho authentication. + isRequired: true + types: + - + - name: use_encrypted_endpoints + description: 'Specifies whether the data source endpoints are encrypted using + + HTTPS. The default value is true.' + isRequired: true + types: + - + - name: use_host_verification + description: 'Specifies whether to require the host name in the server''s + + certificate to match the host name of the server when connecting over SSL. The + default value is + + true.' + isRequired: true + types: + - + - name: use_peer_verification + description: 'Specifies whether to verify the identity of the server when + + connecting over SSL. The default value is true.' + isRequired: true + types: + - + - name: encrypted_credential + description: 'The encrypted credential used for authentication. Credentials are + + encrypted using the integration runtime credential manager. Type: string (or + Expression with + + resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: endpoint + isRequired: true + - name: additional_properties + isRequired: true + - name: connect_via + isRequired: true + - name: description + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: access_token + isRequired: true + - name: use_encrypted_endpoints + isRequired: true + - name: use_host_verification + isRequired: true + - name: use_peer_verification + isRequired: true + - name: encrypted_credential + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ZohoLinkedService.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ZohoLinkedService.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ZohoLinkedService.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ZohoLinkedService.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ZohoLinkedService.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ZohoLinkedService.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ZohoLinkedService.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoObjectDataset.yml new file mode 100644 index 00000000..ba1373d9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoObjectDataset.yml @@ -0,0 +1,202 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.models.ZohoObjectDataset +name: ZohoObjectDataset +fullName: azure.synapse.artifacts.models.ZohoObjectDataset +module: azure.synapse.artifacts.models +summary: 'Zoho server dataset. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ZohoObjectDataset(*, linked_service_name: LinkedServiceReference, additional_properties: + Dict[str, object] | None = None, description: str | None = None, structure: object + | None = None, schema: object | None = None, parameters: Dict[str, ParameterSpecification] + | None = None, annotations: List[object] | None = None, folder: DatasetFolder + | None = None, table_name: object | None = None, **kwargs)' + parameters: + - name: additional_properties + description: 'Unmatched properties from the message are deserialized to this + + collection.' + isRequired: true + types: + - [, ] + - name: type + description: Required. Type of dataset.Constant filled by server. + isRequired: true + types: + - + - name: description + description: Dataset description. + isRequired: true + types: + - + - name: structure + description: 'Columns that define the structure of the dataset. Type: array (or + Expression + + with resultType array), itemType: DatasetDataElement.' + isRequired: true + types: + - + - name: schema + description: 'Columns that define the physical type schema of the dataset. Type: + array (or + + Expression with resultType array), itemType: DatasetSchemaDataElement.' + isRequired: true + types: + - + - name: linked_service_name + description: Required. Linked service reference. + isRequired: true + types: + - + - name: parameters + description: Parameters for dataset. + isRequired: true + types: + - [, ] + - name: annotations + description: List of tags that can be used for describing the Dataset. + isRequired: true + types: + - [] + - name: folder + description: 'The folder that this Dataset is in. If not specified, Dataset will + appear at the + + root level.' + isRequired: true + types: + - + - name: table_name + description: 'The table name. Type: string (or Expression with resultType string).' + isRequired: true + types: + - + keywordOnlyParameters: + - name: linked_service_name + isRequired: true + - name: additional_properties + isRequired: true + - name: description + isRequired: true + - name: structure + isRequired: true + - name: schema + isRequired: true + - name: parameters + isRequired: true + - name: annotations + isRequired: true + - name: folder + isRequired: true + - name: table_name + isRequired: true +methods: +- uid: azure.synapse.artifacts.models.ZohoObjectDataset.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ZohoObjectDataset.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ZohoObjectDataset.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.artifacts.models.ZohoObjectDataset.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.artifacts.models.ZohoObjectDataset.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.artifacts.models.ZohoObjectDataset.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.artifacts.models.ZohoObjectDataset.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.yml new file mode 100644 index 00000000..c63dfbda --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.yml @@ -0,0 +1,416 @@ +### YamlMime:PythonPackage +uid: azure.synapse.artifacts.models +name: models +fullName: azure.synapse.artifacts.models +type: import +classes: +- azure.synapse.artifacts.models.Activity +- azure.synapse.artifacts.models.ActivityDependency +- azure.synapse.artifacts.models.ActivityPolicy +- azure.synapse.artifacts.models.ActivityRun +- azure.synapse.artifacts.models.ActivityRunsQueryResponse +- azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse +- azure.synapse.artifacts.models.AmazonMWSLinkedService +- azure.synapse.artifacts.models.AmazonMWSObjectDataset +- azure.synapse.artifacts.models.AmazonRedshiftLinkedService +- azure.synapse.artifacts.models.AmazonRedshiftTableDataset +- azure.synapse.artifacts.models.AmazonS3LinkedService +- azure.synapse.artifacts.models.AppendVariableActivity +- azure.synapse.artifacts.models.AvroDataset +- azure.synapse.artifacts.models.AzureBatchLinkedService +- azure.synapse.artifacts.models.AzureBlobFSLinkedService +- azure.synapse.artifacts.models.AzureBlobStorageLinkedService +- azure.synapse.artifacts.models.AzureDataExplorerCommandActivity +- azure.synapse.artifacts.models.AzureDataExplorerLinkedService +- azure.synapse.artifacts.models.AzureDataExplorerTableDataset +- azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService +- azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService +- azure.synapse.artifacts.models.AzureDatabricksLinkedService +- azure.synapse.artifacts.models.AzureFileStorageLinkedService +- azure.synapse.artifacts.models.AzureFunctionActivity +- azure.synapse.artifacts.models.AzureFunctionLinkedService +- azure.synapse.artifacts.models.AzureKeyVaultLinkedService +- azure.synapse.artifacts.models.AzureKeyVaultSecretReference +- azure.synapse.artifacts.models.AzureMLBatchExecutionActivity +- azure.synapse.artifacts.models.AzureMLExecutePipelineActivity +- azure.synapse.artifacts.models.AzureMLLinkedService +- azure.synapse.artifacts.models.AzureMLServiceLinkedService +- azure.synapse.artifacts.models.AzureMLUpdateResourceActivity +- azure.synapse.artifacts.models.AzureMLWebServiceFile +- azure.synapse.artifacts.models.AzureMariaDBLinkedService +- azure.synapse.artifacts.models.AzureMariaDBTableDataset +- azure.synapse.artifacts.models.AzureMySqlLinkedService +- azure.synapse.artifacts.models.AzureMySqlTableDataset +- azure.synapse.artifacts.models.AzurePostgreSqlLinkedService +- azure.synapse.artifacts.models.AzurePostgreSqlTableDataset +- azure.synapse.artifacts.models.AzureSearchIndexDataset +- azure.synapse.artifacts.models.AzureSearchLinkedService +- azure.synapse.artifacts.models.AzureSqlDWLinkedService +- azure.synapse.artifacts.models.AzureSqlDWTableDataset +- azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService +- azure.synapse.artifacts.models.AzureSqlMILinkedService +- azure.synapse.artifacts.models.AzureSqlMITableDataset +- azure.synapse.artifacts.models.AzureSqlTableDataset +- azure.synapse.artifacts.models.AzureStorageLinkedService +- azure.synapse.artifacts.models.AzureTableDataset +- azure.synapse.artifacts.models.AzureTableStorageLinkedService +- azure.synapse.artifacts.models.BigDataPoolReference +- azure.synapse.artifacts.models.BinaryDataset +- azure.synapse.artifacts.models.CassandraLinkedService +- azure.synapse.artifacts.models.CassandraTableDataset +- azure.synapse.artifacts.models.CloudError +- azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset +- azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService +- azure.synapse.artifacts.models.ConcurLinkedService +- azure.synapse.artifacts.models.ConcurObjectDataset +- azure.synapse.artifacts.models.ControlActivity +- azure.synapse.artifacts.models.CopyActivity +- azure.synapse.artifacts.models.CopySink +- azure.synapse.artifacts.models.CopySource +- azure.synapse.artifacts.models.CosmosDbLinkedService +- azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset +- azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService +- azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset +- azure.synapse.artifacts.models.CouchbaseLinkedService +- azure.synapse.artifacts.models.CouchbaseTableDataset +- azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest +- azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse +- azure.synapse.artifacts.models.CreateRunResponse +- azure.synapse.artifacts.models.CustomActivity +- azure.synapse.artifacts.models.CustomActivityReferenceObject +- azure.synapse.artifacts.models.CustomDataSourceLinkedService +- azure.synapse.artifacts.models.DataFlow +- azure.synapse.artifacts.models.DataFlowDebugCommandRequest +- azure.synapse.artifacts.models.DataFlowDebugCommandResponse +- azure.synapse.artifacts.models.DataFlowDebugPackage +- azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings +- azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest +- azure.synapse.artifacts.models.DataFlowDebugQueryResponse +- azure.synapse.artifacts.models.DataFlowDebugResource +- azure.synapse.artifacts.models.DataFlowDebugResultResponse +- azure.synapse.artifacts.models.DataFlowDebugSessionInfo +- azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest +- azure.synapse.artifacts.models.DataFlowFolder +- azure.synapse.artifacts.models.DataFlowListResponse +- azure.synapse.artifacts.models.DataFlowReference +- azure.synapse.artifacts.models.DataFlowResource +- azure.synapse.artifacts.models.DataFlowSink +- azure.synapse.artifacts.models.DataFlowSource +- azure.synapse.artifacts.models.DataFlowSourceSetting +- azure.synapse.artifacts.models.DataFlowStagingInfo +- azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity +- azure.synapse.artifacts.models.DatabricksNotebookActivity +- azure.synapse.artifacts.models.DatabricksSparkJarActivity +- azure.synapse.artifacts.models.DatabricksSparkPythonActivity +- azure.synapse.artifacts.models.Dataset +- azure.synapse.artifacts.models.DatasetBZip2Compression +- azure.synapse.artifacts.models.DatasetCompression +- azure.synapse.artifacts.models.DatasetDebugResource +- azure.synapse.artifacts.models.DatasetDeflateCompression +- azure.synapse.artifacts.models.DatasetFolder +- azure.synapse.artifacts.models.DatasetGZipCompression +- azure.synapse.artifacts.models.DatasetListResponse +- azure.synapse.artifacts.models.DatasetLocation +- azure.synapse.artifacts.models.DatasetReference +- azure.synapse.artifacts.models.DatasetResource +- azure.synapse.artifacts.models.DatasetZipDeflateCompression +- azure.synapse.artifacts.models.Db2LinkedService +- azure.synapse.artifacts.models.Db2TableDataset +- azure.synapse.artifacts.models.DeleteActivity +- azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest +- azure.synapse.artifacts.models.DelimitedTextDataset +- azure.synapse.artifacts.models.DocumentDbCollectionDataset +- azure.synapse.artifacts.models.DrillLinkedService +- azure.synapse.artifacts.models.DrillTableDataset +- azure.synapse.artifacts.models.DynamicsAXLinkedService +- azure.synapse.artifacts.models.DynamicsAXResourceDataset +- azure.synapse.artifacts.models.DynamicsCrmEntityDataset +- azure.synapse.artifacts.models.DynamicsCrmLinkedService +- azure.synapse.artifacts.models.DynamicsEntityDataset +- azure.synapse.artifacts.models.DynamicsLinkedService +- azure.synapse.artifacts.models.EloquaLinkedService +- azure.synapse.artifacts.models.EloquaObjectDataset +- azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest +- azure.synapse.artifacts.models.ExecuteDataFlowActivity +- azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute +- azure.synapse.artifacts.models.ExecutePipelineActivity +- azure.synapse.artifacts.models.ExecuteSSISPackageActivity +- azure.synapse.artifacts.models.ExecutionActivity +- azure.synapse.artifacts.models.ExposureControlRequest +- azure.synapse.artifacts.models.ExposureControlResponse +- azure.synapse.artifacts.models.Expression +- azure.synapse.artifacts.models.FileServerLinkedService +- azure.synapse.artifacts.models.FilterActivity +- azure.synapse.artifacts.models.ForEachActivity +- azure.synapse.artifacts.models.FtpServerLinkedService +- azure.synapse.artifacts.models.GetMetadataActivity +- azure.synapse.artifacts.models.GetSsisObjectMetadataRequest +- azure.synapse.artifacts.models.GoogleAdWordsLinkedService +- azure.synapse.artifacts.models.GoogleAdWordsObjectDataset +- azure.synapse.artifacts.models.GoogleBigQueryLinkedService +- azure.synapse.artifacts.models.GoogleBigQueryObjectDataset +- azure.synapse.artifacts.models.GoogleCloudStorageLinkedService +- azure.synapse.artifacts.models.GreenplumLinkedService +- azure.synapse.artifacts.models.GreenplumTableDataset +- azure.synapse.artifacts.models.HBaseLinkedService +- azure.synapse.artifacts.models.HBaseObjectDataset +- azure.synapse.artifacts.models.HDInsightHiveActivity +- azure.synapse.artifacts.models.HDInsightLinkedService +- azure.synapse.artifacts.models.HDInsightMapReduceActivity +- azure.synapse.artifacts.models.HDInsightOnDemandLinkedService +- azure.synapse.artifacts.models.HDInsightPigActivity +- azure.synapse.artifacts.models.HDInsightSparkActivity +- azure.synapse.artifacts.models.HDInsightStreamingActivity +- azure.synapse.artifacts.models.HdfsLinkedService +- azure.synapse.artifacts.models.HiveLinkedService +- azure.synapse.artifacts.models.HiveObjectDataset +- azure.synapse.artifacts.models.HttpLinkedService +- azure.synapse.artifacts.models.HubspotLinkedService +- azure.synapse.artifacts.models.HubspotObjectDataset +- azure.synapse.artifacts.models.IfConditionActivity +- azure.synapse.artifacts.models.ImpalaLinkedService +- azure.synapse.artifacts.models.ImpalaObjectDataset +- azure.synapse.artifacts.models.InformixLinkedService +- azure.synapse.artifacts.models.InformixTableDataset +- azure.synapse.artifacts.models.IntegrationRuntimeReference +- azure.synapse.artifacts.models.JiraLinkedService +- azure.synapse.artifacts.models.JiraObjectDataset +- azure.synapse.artifacts.models.JsonDataset +- azure.synapse.artifacts.models.LinkedService +- azure.synapse.artifacts.models.LinkedServiceDebugResource +- azure.synapse.artifacts.models.LinkedServiceListResponse +- azure.synapse.artifacts.models.LinkedServiceReference +- azure.synapse.artifacts.models.LinkedServiceResource +- azure.synapse.artifacts.models.LogStorageSettings +- azure.synapse.artifacts.models.LookupActivity +- azure.synapse.artifacts.models.MagentoLinkedService +- azure.synapse.artifacts.models.MagentoObjectDataset +- azure.synapse.artifacts.models.MappingDataFlow +- azure.synapse.artifacts.models.MariaDBLinkedService +- azure.synapse.artifacts.models.MariaDBTableDataset +- azure.synapse.artifacts.models.MarketoLinkedService +- azure.synapse.artifacts.models.MarketoObjectDataset +- azure.synapse.artifacts.models.MicrosoftAccessLinkedService +- azure.synapse.artifacts.models.MicrosoftAccessTableDataset +- azure.synapse.artifacts.models.MongoDbCollectionDataset +- azure.synapse.artifacts.models.MongoDbLinkedService +- azure.synapse.artifacts.models.MongoDbV2CollectionDataset +- azure.synapse.artifacts.models.MongoDbV2LinkedService +- azure.synapse.artifacts.models.MultiplePipelineTrigger +- azure.synapse.artifacts.models.MySqlLinkedService +- azure.synapse.artifacts.models.MySqlTableDataset +- azure.synapse.artifacts.models.NetezzaLinkedService +- azure.synapse.artifacts.models.NetezzaTableDataset +- azure.synapse.artifacts.models.Notebook +- azure.synapse.artifacts.models.NotebookCell +- azure.synapse.artifacts.models.NotebookCellOutputItem +- azure.synapse.artifacts.models.NotebookKernelSpec +- azure.synapse.artifacts.models.NotebookLanguageInfo +- azure.synapse.artifacts.models.NotebookListResponse +- azure.synapse.artifacts.models.NotebookMetadata +- azure.synapse.artifacts.models.NotebookResource +- azure.synapse.artifacts.models.NotebookSessionProperties +- azure.synapse.artifacts.models.ODataLinkedService +- azure.synapse.artifacts.models.ODataResourceDataset +- azure.synapse.artifacts.models.OdbcLinkedService +- azure.synapse.artifacts.models.OdbcTableDataset +- azure.synapse.artifacts.models.Office365Dataset +- azure.synapse.artifacts.models.Office365LinkedService +- azure.synapse.artifacts.models.OracleLinkedService +- azure.synapse.artifacts.models.OracleServiceCloudLinkedService +- azure.synapse.artifacts.models.OracleServiceCloudObjectDataset +- azure.synapse.artifacts.models.OracleTableDataset +- azure.synapse.artifacts.models.OrcDataset +- azure.synapse.artifacts.models.ParameterSpecification +- azure.synapse.artifacts.models.ParquetDataset +- azure.synapse.artifacts.models.PaypalLinkedService +- azure.synapse.artifacts.models.PaypalObjectDataset +- azure.synapse.artifacts.models.PhoenixLinkedService +- azure.synapse.artifacts.models.PhoenixObjectDataset +- azure.synapse.artifacts.models.PipelineFolder +- azure.synapse.artifacts.models.PipelineListResponse +- azure.synapse.artifacts.models.PipelineReference +- azure.synapse.artifacts.models.PipelineResource +- azure.synapse.artifacts.models.PipelineRun +- azure.synapse.artifacts.models.PipelineRunInvokedBy +- azure.synapse.artifacts.models.PipelineRunsQueryResponse +- azure.synapse.artifacts.models.PostgreSqlLinkedService +- azure.synapse.artifacts.models.PostgreSqlTableDataset +- azure.synapse.artifacts.models.PrestoLinkedService +- azure.synapse.artifacts.models.PrestoObjectDataset +- azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse +- azure.synapse.artifacts.models.QuickBooksLinkedService +- azure.synapse.artifacts.models.QuickBooksObjectDataset +- azure.synapse.artifacts.models.RedirectIncompatibleRowSettings +- azure.synapse.artifacts.models.RelationalTableDataset +- azure.synapse.artifacts.models.RerunTriggerListResponse +- azure.synapse.artifacts.models.RerunTriggerResource +- azure.synapse.artifacts.models.RerunTumblingWindowTrigger +- azure.synapse.artifacts.models.RerunTumblingWindowTriggerActionParameters +- azure.synapse.artifacts.models.Resource +- azure.synapse.artifacts.models.ResponsysLinkedService +- azure.synapse.artifacts.models.ResponsysObjectDataset +- azure.synapse.artifacts.models.RestResourceDataset +- azure.synapse.artifacts.models.RestServiceLinkedService +- azure.synapse.artifacts.models.RunFilterParameters +- azure.synapse.artifacts.models.RunQueryFilter +- azure.synapse.artifacts.models.RunQueryOrderBy +- azure.synapse.artifacts.models.SSISAccessCredential +- azure.synapse.artifacts.models.SSISChildPackage +- azure.synapse.artifacts.models.SSISExecutionCredential +- azure.synapse.artifacts.models.SSISExecutionParameter +- azure.synapse.artifacts.models.SSISLogLocation +- azure.synapse.artifacts.models.SSISPackageLocation +- azure.synapse.artifacts.models.SSISPropertyOverride +- azure.synapse.artifacts.models.SalesforceLinkedService +- azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService +- azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset +- azure.synapse.artifacts.models.SalesforceObjectDataset +- azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService +- azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset +- azure.synapse.artifacts.models.SapBWLinkedService +- azure.synapse.artifacts.models.SapBwCubeDataset +- azure.synapse.artifacts.models.SapCloudForCustomerLinkedService +- azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset +- azure.synapse.artifacts.models.SapEccLinkedService +- azure.synapse.artifacts.models.SapEccResourceDataset +- azure.synapse.artifacts.models.SapHanaLinkedService +- azure.synapse.artifacts.models.SapHanaTableDataset +- azure.synapse.artifacts.models.SapOpenHubLinkedService +- azure.synapse.artifacts.models.SapOpenHubTableDataset +- azure.synapse.artifacts.models.SapTableLinkedService +- azure.synapse.artifacts.models.SapTableResourceDataset +- azure.synapse.artifacts.models.ScriptAction +- azure.synapse.artifacts.models.SecretBase +- azure.synapse.artifacts.models.SecureString +- azure.synapse.artifacts.models.ServiceNowLinkedService +- azure.synapse.artifacts.models.ServiceNowObjectDataset +- azure.synapse.artifacts.models.SetVariableActivity +- azure.synapse.artifacts.models.SftpServerLinkedService +- azure.synapse.artifacts.models.ShopifyLinkedService +- azure.synapse.artifacts.models.ShopifyObjectDataset +- azure.synapse.artifacts.models.SparkBatchJob +- azure.synapse.artifacts.models.SparkBatchJobState +- azure.synapse.artifacts.models.SparkJobDefinition +- azure.synapse.artifacts.models.SparkJobDefinitionResource +- azure.synapse.artifacts.models.SparkJobDefinitionsListResponse +- azure.synapse.artifacts.models.SparkJobProperties +- azure.synapse.artifacts.models.SparkLinkedService +- azure.synapse.artifacts.models.SparkObjectDataset +- azure.synapse.artifacts.models.SparkRequest +- azure.synapse.artifacts.models.SparkScheduler +- azure.synapse.artifacts.models.SparkServiceError +- azure.synapse.artifacts.models.SparkServicePlugin +- azure.synapse.artifacts.models.SqlConnection +- azure.synapse.artifacts.models.SqlScript +- azure.synapse.artifacts.models.SqlScriptContent +- azure.synapse.artifacts.models.SqlScriptMetadata +- azure.synapse.artifacts.models.SqlScriptResource +- azure.synapse.artifacts.models.SqlScriptsListResponse +- azure.synapse.artifacts.models.SqlServerLinkedService +- azure.synapse.artifacts.models.SqlServerStoredProcedureActivity +- azure.synapse.artifacts.models.SqlServerTableDataset +- azure.synapse.artifacts.models.SquareLinkedService +- azure.synapse.artifacts.models.SquareObjectDataset +- azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse +- azure.synapse.artifacts.models.StagingSettings +- azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest +- azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse +- azure.synapse.artifacts.models.StoredProcedureParameter +- azure.synapse.artifacts.models.SubResource +- azure.synapse.artifacts.models.SubResourceDebugResource +- azure.synapse.artifacts.models.SwitchActivity +- azure.synapse.artifacts.models.SwitchCase +- azure.synapse.artifacts.models.SybaseLinkedService +- azure.synapse.artifacts.models.SybaseTableDataset +- azure.synapse.artifacts.models.TeradataLinkedService +- azure.synapse.artifacts.models.TeradataTableDataset +- azure.synapse.artifacts.models.Transformation +- azure.synapse.artifacts.models.Trigger +- azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus +- azure.synapse.artifacts.models.TriggerListResponse +- azure.synapse.artifacts.models.TriggerPipelineReference +- azure.synapse.artifacts.models.TriggerResource +- azure.synapse.artifacts.models.TriggerRun +- azure.synapse.artifacts.models.TriggerRunsQueryResponse +- azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus +- azure.synapse.artifacts.models.UntilActivity +- azure.synapse.artifacts.models.UserProperty +- azure.synapse.artifacts.models.ValidationActivity +- azure.synapse.artifacts.models.VariableSpecification +- azure.synapse.artifacts.models.VerticaLinkedService +- azure.synapse.artifacts.models.VerticaTableDataset +- azure.synapse.artifacts.models.WaitActivity +- azure.synapse.artifacts.models.WebActivity +- azure.synapse.artifacts.models.WebActivityAuthentication +- azure.synapse.artifacts.models.WebAnonymousAuthentication +- azure.synapse.artifacts.models.WebBasicAuthentication +- azure.synapse.artifacts.models.WebClientCertificateAuthentication +- azure.synapse.artifacts.models.WebHookActivity +- azure.synapse.artifacts.models.WebLinkedService +- azure.synapse.artifacts.models.WebLinkedServiceTypeProperties +- azure.synapse.artifacts.models.WebTableDataset +- azure.synapse.artifacts.models.Workspace +- azure.synapse.artifacts.models.WorkspaceIdentity +- azure.synapse.artifacts.models.WorkspaceUpdateParameters +- azure.synapse.artifacts.models.XeroLinkedService +- azure.synapse.artifacts.models.XeroObjectDataset +- azure.synapse.artifacts.models.ZohoLinkedService +- azure.synapse.artifacts.models.ZohoObjectDataset +enums: +- azure.synapse.artifacts.models.AvroCompressionCodec +- azure.synapse.artifacts.models.AzureFunctionActivityMethod +- azure.synapse.artifacts.models.CellOutputType +- azure.synapse.artifacts.models.DataFlowComputeType +- azure.synapse.artifacts.models.DatasetCompressionLevel +- azure.synapse.artifacts.models.DelimitedTextCompressionCodec +- azure.synapse.artifacts.models.DependencyCondition +- azure.synapse.artifacts.models.DynamicsAuthenticationType +- azure.synapse.artifacts.models.DynamicsDeploymentType +- azure.synapse.artifacts.models.DynamicsServicePrincipalCredentialType +- azure.synapse.artifacts.models.EventSubscriptionStatus +- azure.synapse.artifacts.models.FtpAuthenticationType +- azure.synapse.artifacts.models.GoogleAdWordsAuthenticationType +- azure.synapse.artifacts.models.GoogleBigQueryAuthenticationType +- azure.synapse.artifacts.models.HBaseAuthenticationType +- azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption +- azure.synapse.artifacts.models.HdiNodeTypes +- azure.synapse.artifacts.models.HiveAuthenticationType +- azure.synapse.artifacts.models.HiveServerType +- azure.synapse.artifacts.models.HiveThriftTransportProtocol +- azure.synapse.artifacts.models.HttpAuthenticationType +- azure.synapse.artifacts.models.ImpalaAuthenticationType +- azure.synapse.artifacts.models.MongoDbAuthenticationType +- azure.synapse.artifacts.models.ODataAadServicePrincipalCredentialType +- azure.synapse.artifacts.models.ODataAuthenticationType +- azure.synapse.artifacts.models.OrcCompressionCodec +- azure.synapse.artifacts.models.ParameterType +- azure.synapse.artifacts.models.ParquetCompressionCodec +- azure.synapse.artifacts.models.PhoenixAuthenticationType +- azure.synapse.artifacts.models.PluginCurrentState +- azure.synapse.artifacts.models.PrestoAuthenticationType +- azure.synapse.artifacts.models.RestServiceAuthenticationType +- azure.synapse.artifacts.models.RunQueryFilterOperand +- azure.synapse.artifacts.models.RunQueryFilterOperator +- azure.synapse.artifacts.models.RunQueryOrder +- azure.synapse.artifacts.models.RunQueryOrderByField +- azure.synapse.artifacts.models.SapHanaAuthenticationType +- azure.synapse.artifacts.models.SchedulerCurrentState +- azure.synapse.artifacts.models.ServiceNowAuthenticationType +- azure.synapse.artifacts.models.SftpAuthenticationType +- azure.synapse.artifacts.models.SparkAuthenticationType +- azure.synapse.artifacts.models.SparkBatchJobResultType +- azure.synapse.artifacts.models.SparkErrorSource +- azure.synapse.artifacts.models.SparkJobType +- azure.synapse.artifacts.models.SparkServerType +- azure.synapse.artifacts.models.SparkThriftTransportProtocol +- azure.synapse.artifacts.models.SqlConnectionType +- azure.synapse.artifacts.models.SsisPackageLocationType +- azure.synapse.artifacts.models.StoredProcedureParameterType +- azure.synapse.artifacts.models.SybaseAuthenticationType +- azure.synapse.artifacts.models.TeradataAuthenticationType +- azure.synapse.artifacts.models.TriggerRunStatus +- azure.synapse.artifacts.models.TriggerRuntimeState +- azure.synapse.artifacts.models.VariableType +- azure.synapse.artifacts.models.WebActivityMethod +- azure.synapse.artifacts.models.WebAuthenticationType diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DataFlowDebugSessionOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DataFlowDebugSessionOperations.yml new file mode 100644 index 00000000..4dc0aea6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DataFlowDebugSessionOperations.yml @@ -0,0 +1,173 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.operations.DataFlowDebugSessionOperations +name: DataFlowDebugSessionOperations +fullName: azure.synapse.artifacts.operations.DataFlowDebugSessionOperations +module: azure.synapse.artifacts.operations +summary: 'DataFlowDebugSessionOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: DataFlowDebugSessionOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.artifacts.operations.DataFlowDebugSessionOperations.add_data_flow + name: add_data_flow + summary: Add a data flow into debug session. + signature: 'add_data_flow(request: ''models.DataFlowDebugPackage'', **kwargs: Any) + -> models.AddDataFlowToDebugSessionResponse' + parameters: + - name: request + description: Data flow debug session definition with debug content. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: AddDataFlowToDebugSessionResponse, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.DataFlowDebugSessionOperations.begin_create_data_flow_debug_session + name: begin_create_data_flow_debug_session + summary: Creates a data flow debug session. + signature: 'begin_create_data_flow_debug_session(request: ''models.CreateDataFlowDebugSessionRequest'', + **kwargs: Any) -> LROPoller[''models.CreateDataFlowDebugSessionResponse'']' + parameters: + - name: request + description: Data flow debug session definition. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either CreateDataFlowDebugSessionResponse + or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.DataFlowDebugSessionOperations.begin_execute_command + name: begin_execute_command + summary: Execute a data flow debug command. + signature: 'begin_execute_command(request: ''models.DataFlowDebugCommandRequest'', + **kwargs: Any) -> LROPoller[''models.DataFlowDebugCommandResponse'']' + parameters: + - name: request + description: Data flow debug command definition. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either DataFlowDebugCommandResponse + or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.DataFlowDebugSessionOperations.delete_data_flow_debug_session + name: delete_data_flow_debug_session + summary: Deletes a data flow debug session. + signature: 'delete_data_flow_debug_session(request: ''models.DeleteDataFlowDebugSessionRequest'', + **kwargs: Any) -> None' + parameters: + - name: request + description: Data flow debug session definition for deletion. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.DataFlowDebugSessionOperations.query_data_flow_debug_sessions_by_workspace + name: query_data_flow_debug_sessions_by_workspace + summary: Query all active data flow debug sessions. + signature: 'query_data_flow_debug_sessions_by_workspace(**kwargs: Any) -> Iterable[''models.QueryDataFlowDebugSessionsResponse'']' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either QueryDataFlowDebugSessionsResponse + or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.artifacts.operations.DataFlowDebugSessionOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DataFlowOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DataFlowOperations.yml new file mode 100644 index 00000000..577f5419 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DataFlowOperations.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.operations.DataFlowOperations +name: DataFlowOperations +fullName: azure.synapse.artifacts.operations.DataFlowOperations +module: azure.synapse.artifacts.operations +summary: 'DataFlowOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: DataFlowOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.artifacts.operations.DataFlowOperations.create_or_update_data_flow + name: create_or_update_data_flow + summary: Creates or updates a data flow. + signature: 'create_or_update_data_flow(data_flow_name: str, properties: ''models.DataFlow'', + if_match: str | None = None, **kwargs: Any) -> models.DataFlowResource' + parameters: + - name: data_flow_name + description: The data flow name. + isRequired: true + types: + - + - name: properties + description: Data flow properties. + isRequired: true + types: + - + - name: if_match + description: 'ETag of the data flow entity. Should only be specified for update, + for which + + it should match existing entity or can be * for unconditional update.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DataFlowResource, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.DataFlowOperations.delete_data_flow + name: delete_data_flow + summary: Deletes a data flow. + signature: 'delete_data_flow(data_flow_name: str, **kwargs: Any) -> None' + parameters: + - name: data_flow_name + description: The data flow name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.DataFlowOperations.get_data_flow + name: get_data_flow + summary: Gets a data flow. + signature: 'get_data_flow(data_flow_name: str, if_none_match: str | None = None, + **kwargs: Any) -> models.DataFlowResource' + parameters: + - name: data_flow_name + description: The data flow name. + isRequired: true + types: + - + - name: if_none_match + description: 'ETag of the data flow entity. Should only be specified for get. + If the + + ETag matches the existing entity tag, or if * was provided, then no content + will be returned.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DataFlowResource, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.DataFlowOperations.get_data_flows_by_workspace + name: get_data_flows_by_workspace + summary: Lists data flows. + signature: 'get_data_flows_by_workspace(**kwargs: Any) -> Iterable[''models.DataFlowListResponse'']' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either DataFlowListResponse or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.artifacts.operations.DataFlowOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DatasetOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DatasetOperations.yml new file mode 100644 index 00000000..c11983f2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.DatasetOperations.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.operations.DatasetOperations +name: DatasetOperations +fullName: azure.synapse.artifacts.operations.DatasetOperations +module: azure.synapse.artifacts.operations +summary: 'DatasetOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: DatasetOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.artifacts.operations.DatasetOperations.create_or_update_dataset + name: create_or_update_dataset + summary: Creates or updates a dataset. + signature: 'create_or_update_dataset(dataset_name: str, properties: ''models.Dataset'', + if_match: str | None = None, **kwargs: Any) -> models.DatasetResource' + parameters: + - name: dataset_name + description: The dataset name. + isRequired: true + types: + - + - name: properties + description: Dataset properties. + isRequired: true + types: + - + - name: if_match + description: 'ETag of the dataset entity. Should only be specified for update, + for which it + + should match existing entity or can be * for unconditional update.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DatasetResource, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.DatasetOperations.delete_dataset + name: delete_dataset + summary: Deletes a dataset. + signature: 'delete_dataset(dataset_name: str, **kwargs: Any) -> None' + parameters: + - name: dataset_name + description: The dataset name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.DatasetOperations.get_dataset + name: get_dataset + summary: Gets a dataset. + signature: 'get_dataset(dataset_name: str, if_none_match: str | None = None, **kwargs: + Any) -> ''models.DatasetResource'' | None' + parameters: + - name: dataset_name + description: The dataset name. + isRequired: true + types: + - + - name: if_none_match + description: 'ETag of the dataset entity. Should only be specified for get. If + the ETag + + matches the existing entity tag, or if * was provided, then no content will + be returned.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: DatasetResource, or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.DatasetOperations.get_datasets_by_workspace + name: get_datasets_by_workspace + summary: Lists datasets. + signature: 'get_datasets_by_workspace(**kwargs: Any) -> Iterable[''models.DatasetListResponse'']' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either DatasetListResponse or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.artifacts.operations.DatasetOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.LinkedServiceOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.LinkedServiceOperations.yml new file mode 100644 index 00000000..aa6c056b --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.LinkedServiceOperations.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.operations.LinkedServiceOperations +name: LinkedServiceOperations +fullName: azure.synapse.artifacts.operations.LinkedServiceOperations +module: azure.synapse.artifacts.operations +summary: 'LinkedServiceOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: LinkedServiceOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.artifacts.operations.LinkedServiceOperations.create_or_update_linked_service + name: create_or_update_linked_service + summary: Creates or updates a linked service. + signature: 'create_or_update_linked_service(linked_service_name: str, properties: + ''models.LinkedService'', if_match: str | None = None, **kwargs: Any) -> models.LinkedServiceResource' + parameters: + - name: linked_service_name + description: The linked service name. + isRequired: true + types: + - + - name: properties + description: Properties of linked service. + isRequired: true + types: + - + - name: if_match + description: 'ETag of the linkedService entity. Should only be specified for + update, for + + which it should match existing entity or can be * for unconditional update.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LinkedServiceResource, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.LinkedServiceOperations.delete_linked_service + name: delete_linked_service + summary: Deletes a linked service. + signature: 'delete_linked_service(linked_service_name: str, **kwargs: Any) -> None' + parameters: + - name: linked_service_name + description: The linked service name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.LinkedServiceOperations.get_linked_service + name: get_linked_service + summary: Gets a linked service. + signature: 'get_linked_service(linked_service_name: str, if_none_match: str | None + = None, **kwargs: Any) -> ''models.LinkedServiceResource'' | None' + parameters: + - name: linked_service_name + description: The linked service name. + isRequired: true + types: + - + - name: if_none_match + description: 'ETag of the linked service entity. Should only be specified for + get. If + + the ETag matches the existing entity tag, or if * was provided, then no content + will be + + returned.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LinkedServiceResource, or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.LinkedServiceOperations.get_linked_services_by_workspace + name: get_linked_services_by_workspace + summary: Lists linked services. + signature: 'get_linked_services_by_workspace(**kwargs: Any) -> Iterable[''models.LinkedServiceListResponse'']' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either LinkedServiceListResponse or + the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.artifacts.operations.LinkedServiceOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.NotebookOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.NotebookOperations.yml new file mode 100644 index 00000000..d74a509c --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.NotebookOperations.yml @@ -0,0 +1,155 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.operations.NotebookOperations +name: NotebookOperations +fullName: azure.synapse.artifacts.operations.NotebookOperations +module: azure.synapse.artifacts.operations +summary: 'NotebookOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: NotebookOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.artifacts.operations.NotebookOperations.create_or_update_notebook + name: create_or_update_notebook + summary: Creates or updates a Note Book. + signature: 'create_or_update_notebook(notebook_name: str, properties: ''models.Notebook'', + if_match: str | None = None, **kwargs: Any) -> models.NotebookResource' + parameters: + - name: notebook_name + description: The notebook name. + isRequired: true + types: + - + - name: properties + description: Properties of Notebook. + isRequired: true + types: + - + - name: if_match + description: 'ETag of the Note book entity. Should only be specified for update, + for which + + it should match existing entity or can be * for unconditional update.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: NotebookResource, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.NotebookOperations.delete_notebook + name: delete_notebook + summary: Deletes a Note book. + signature: 'delete_notebook(notebook_name: str, **kwargs: Any) -> None' + parameters: + - name: notebook_name + description: The notebook name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.NotebookOperations.get_notebook + name: get_notebook + summary: Gets a Note Book. + signature: 'get_notebook(notebook_name: str, if_none_match: str | None = None, **kwargs: + Any) -> ''models.NotebookResource'' | None' + parameters: + - name: notebook_name + description: The notebook name. + isRequired: true + types: + - + - name: if_none_match + description: 'ETag of the Notebook entity. Should only be specified for get. If + the + + ETag matches the existing entity tag, or if * was provided, then no content + will be returned.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: NotebookResource, or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.NotebookOperations.get_notebook_summary_by_work_space + name: get_notebook_summary_by_work_space + summary: Lists a summary of Notebooks. + signature: 'get_notebook_summary_by_work_space(**kwargs: Any) -> Iterable[''models.NotebookListResponse'']' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either NotebookListResponse or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.NotebookOperations.get_notebooks_by_workspace + name: get_notebooks_by_workspace + summary: Lists Notebooks. + signature: 'get_notebooks_by_workspace(**kwargs: Any) -> Iterable[''models.NotebookListResponse'']' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either NotebookListResponse or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.artifacts.operations.NotebookOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.PipelineOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.PipelineOperations.yml new file mode 100644 index 00000000..e2d6dd85 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.PipelineOperations.yml @@ -0,0 +1,191 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.operations.PipelineOperations +name: PipelineOperations +fullName: azure.synapse.artifacts.operations.PipelineOperations +module: azure.synapse.artifacts.operations +summary: 'PipelineOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: PipelineOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.artifacts.operations.PipelineOperations.create_or_update_pipeline + name: create_or_update_pipeline + summary: Creates or updates a pipeline. + signature: 'create_or_update_pipeline(pipeline_name: str, pipeline: ''models.PipelineResource'', + if_match: str | None = None, **kwargs: Any) -> models.PipelineResource' + parameters: + - name: pipeline_name + description: The pipeline name. + isRequired: true + types: + - + - name: pipeline + description: Pipeline resource definition. + isRequired: true + types: + - + - name: if_match + description: 'ETag of the pipeline entity. Should only be specified for update, + for which + + it should match existing entity or can be * for unconditional update.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PipelineResource, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.PipelineOperations.create_pipeline_run + name: create_pipeline_run + summary: Creates a run of a pipeline. + signature: 'create_pipeline_run(pipeline_name: str, reference_pipeline_run_id: str + | None = None, is_recovery: bool | None = None, start_activity_name: str | None + = None, parameters: Dict[str, object] | None = None, **kwargs: Any) -> models.CreateRunResponse' + parameters: + - name: pipeline_name + description: The pipeline name. + isRequired: true + types: + - + - name: reference_pipeline_run_id + description: 'The pipeline run identifier. If run ID is specified the + + parameters of the specified run will be used to create a new run.' + defaultValue: None + types: + - + - name: is_recovery + description: 'Recovery mode flag. If recovery mode is set to true, the specified + + referenced pipeline run and the new run will be grouped under the same groupId.' + defaultValue: None + types: + - + - name: start_activity_name + description: 'In recovery mode, the rerun will start from this activity. If not + + specified, all activities will run.' + defaultValue: None + types: + - + - name: parameters + description: 'Parameters of the pipeline run. These parameters will be used only + if the + + runId is not specified.' + defaultValue: None + types: + - [, ] + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: CreateRunResponse, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.PipelineOperations.delete_pipeline + name: delete_pipeline + summary: Deletes a pipeline. + signature: 'delete_pipeline(pipeline_name: str, **kwargs: Any) -> None' + parameters: + - name: pipeline_name + description: The pipeline name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.PipelineOperations.get_pipeline + name: get_pipeline + summary: Gets a pipeline. + signature: 'get_pipeline(pipeline_name: str, if_none_match: str | None = None, **kwargs: + Any) -> ''models.PipelineResource'' | None' + parameters: + - name: pipeline_name + description: The pipeline name. + isRequired: true + types: + - + - name: if_none_match + description: 'ETag of the pipeline entity. Should only be specified for get. If + the + + ETag matches the existing entity tag, or if * was provided, then no content + will be returned.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PipelineResource, or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.PipelineOperations.get_pipelines_by_workspace + name: get_pipelines_by_workspace + summary: Lists pipelines. + signature: 'get_pipelines_by_workspace(**kwargs: Any) -> Iterable[''models.PipelineListResponse'']' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either PipelineListResponse or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.artifacts.operations.PipelineOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.PipelineRunOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.PipelineRunOperations.yml new file mode 100644 index 00000000..f4a70bab --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.PipelineRunOperations.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.operations.PipelineRunOperations +name: PipelineRunOperations +fullName: azure.synapse.artifacts.operations.PipelineRunOperations +module: azure.synapse.artifacts.operations +summary: 'PipelineRunOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: PipelineRunOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.artifacts.operations.PipelineRunOperations.cancel_pipeline_run + name: cancel_pipeline_run + summary: Cancel a pipeline run by its run ID. + signature: 'cancel_pipeline_run(run_id: str, is_recursive: bool | None = None, **kwargs: + Any) -> None' + parameters: + - name: run_id + description: The pipeline run identifier. + isRequired: true + types: + - + - name: is_recursive + description: 'If true, cancel all the Child pipelines that are triggered by the + current + + pipeline.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.PipelineRunOperations.get_pipeline_run + name: get_pipeline_run + summary: Get a pipeline run by its run ID. + signature: 'get_pipeline_run(run_id: str, **kwargs: Any) -> models.PipelineRun' + parameters: + - name: run_id + description: The pipeline run identifier. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PipelineRun, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.PipelineRunOperations.query_activity_runs + name: query_activity_runs + summary: Query activity runs based on input filter conditions. + signature: 'query_activity_runs(pipeline_name: str, run_id: str, filter_parameters: + ''models.RunFilterParameters'', **kwargs: Any) -> models.ActivityRunsQueryResponse' + parameters: + - name: pipeline_name + description: The pipeline name. + isRequired: true + types: + - + - name: run_id + description: The pipeline run identifier. + isRequired: true + types: + - + - name: filter_parameters + description: Parameters to filter the activity runs. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ActivityRunsQueryResponse, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.PipelineRunOperations.query_pipeline_runs_by_workspace + name: query_pipeline_runs_by_workspace + summary: Query pipeline runs in the workspace based on input filter conditions. + signature: 'query_pipeline_runs_by_workspace(filter_parameters: ''models.RunFilterParameters'', + **kwargs: Any) -> models.PipelineRunsQueryResponse' + parameters: + - name: filter_parameters + description: Parameters to filter the pipeline run. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: PipelineRunsQueryResponse, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.artifacts.operations.PipelineRunOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.SparkJobDefinitionOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.SparkJobDefinitionOperations.yml new file mode 100644 index 00000000..24aa2a64 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.SparkJobDefinitionOperations.yml @@ -0,0 +1,221 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.operations.SparkJobDefinitionOperations +name: SparkJobDefinitionOperations +fullName: azure.synapse.artifacts.operations.SparkJobDefinitionOperations +module: azure.synapse.artifacts.operations +summary: 'SparkJobDefinitionOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: SparkJobDefinitionOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.artifacts.operations.SparkJobDefinitionOperations.begin_debug_spark_job_definition + name: begin_debug_spark_job_definition + summary: Debug the spark job definition. + signature: 'begin_debug_spark_job_definition(properties: ''models.SparkJobDefinition'', + **kwargs: Any) -> LROPoller[''models.SparkBatchJob'']' + parameters: + - name: properties + description: Properties of spark job definition. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either SparkBatchJob or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.SparkJobDefinitionOperations.begin_execute_spark_job_definition + name: begin_execute_spark_job_definition + summary: Executes the spark job definition. + signature: 'begin_execute_spark_job_definition(spark_job_definition_name: str, **kwargs: + Any) -> LROPoller[''models.SparkBatchJob'']' + parameters: + - name: spark_job_definition_name + description: The spark job definition name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either SparkBatchJob or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.SparkJobDefinitionOperations.create_or_update_spark_job_definition + name: create_or_update_spark_job_definition + summary: Creates or updates a Spark Job Definition. + signature: 'create_or_update_spark_job_definition(spark_job_definition_name: str, + properties: ''models.SparkJobDefinition'', if_match: str | None = None, **kwargs: + Any) -> models.SparkJobDefinitionResource' + parameters: + - name: spark_job_definition_name + description: The spark job definition name. + isRequired: true + types: + - + - name: properties + description: Properties of spark job definition. + isRequired: true + types: + - + - name: if_match + description: 'ETag of the Spark Job Definition entity. Should only be specified + for update, + + for which it should match existing entity or can be * for unconditional update.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkJobDefinitionResource, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.SparkJobDefinitionOperations.delete_spark_job_definition + name: delete_spark_job_definition + summary: Deletes a Spark Job Definition. + signature: 'delete_spark_job_definition(spark_job_definition_name: str, **kwargs: + Any) -> None' + parameters: + - name: spark_job_definition_name + description: The spark job definition name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.SparkJobDefinitionOperations.get_spark_job_definition + name: get_spark_job_definition + summary: Gets a Spark Job Definition. + signature: 'get_spark_job_definition(spark_job_definition_name: str, if_none_match: + str | None = None, **kwargs: Any) -> ''models.SparkJobDefinitionResource'' | None' + parameters: + - name: spark_job_definition_name + description: The spark job definition name. + isRequired: true + types: + - + - name: if_none_match + description: 'ETag of the Spark Job Definition entity. Should only be specified + for + + get. If the ETag matches the existing entity tag, or if * was provided, then + no content will be + + returned.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkJobDefinitionResource, or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.SparkJobDefinitionOperations.get_spark_job_definitions_by_workspace + name: get_spark_job_definitions_by_workspace + summary: Lists spark job definitions. + signature: 'get_spark_job_definitions_by_workspace(**kwargs: Any) -> Iterable[''models.SparkJobDefinitionsListResponse'']' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either SparkJobDefinitionsListResponse + or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.artifacts.operations.SparkJobDefinitionOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.SqlScriptOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.SqlScriptOperations.yml new file mode 100644 index 00000000..68335dc2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.SqlScriptOperations.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.operations.SqlScriptOperations +name: SqlScriptOperations +fullName: azure.synapse.artifacts.operations.SqlScriptOperations +module: azure.synapse.artifacts.operations +summary: 'SqlScriptOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: SqlScriptOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.artifacts.operations.SqlScriptOperations.create_or_update_sql_script + name: create_or_update_sql_script + summary: Creates or updates a Sql Script. + signature: 'create_or_update_sql_script(sql_script_name: str, properties: ''models.SqlScript'', + if_match: str | None = None, **kwargs: Any) -> models.SqlScriptResource' + parameters: + - name: sql_script_name + description: The sql script name. + isRequired: true + types: + - + - name: properties + description: Properties of sql script. + isRequired: true + types: + - + - name: if_match + description: 'ETag of the SQL script entity. Should only be specified for update, + for which + + it should match existing entity or can be * for unconditional update.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SqlScriptResource, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.SqlScriptOperations.delete_sql_script + name: delete_sql_script + summary: Deletes a Sql Script. + signature: 'delete_sql_script(sql_script_name: str, **kwargs: Any) -> None' + parameters: + - name: sql_script_name + description: The sql script name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.SqlScriptOperations.get_sql_script + name: get_sql_script + summary: Gets a sql script. + signature: 'get_sql_script(sql_script_name: str, if_none_match: str | None = None, + **kwargs: Any) -> ''models.SqlScriptResource'' | None' + parameters: + - name: sql_script_name + description: The sql script name. + isRequired: true + types: + - + - name: if_none_match + description: 'ETag of the sql compute entity. Should only be specified for get. + If the + + ETag matches the existing entity tag, or if * was provided, then no content + will be returned.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SqlScriptResource, or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.SqlScriptOperations.get_sql_scripts_by_workspace + name: get_sql_scripts_by_workspace + summary: Lists sql scripts. + signature: 'get_sql_scripts_by_workspace(**kwargs: Any) -> Iterable[''models.SqlScriptsListResponse'']' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either SqlScriptsListResponse or the + result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.artifacts.operations.SqlScriptOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.TriggerOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.TriggerOperations.yml new file mode 100644 index 00000000..b6013a9e --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.TriggerOperations.yml @@ -0,0 +1,314 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.operations.TriggerOperations +name: TriggerOperations +fullName: azure.synapse.artifacts.operations.TriggerOperations +module: azure.synapse.artifacts.operations +summary: 'TriggerOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: TriggerOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.artifacts.operations.TriggerOperations.begin_start_trigger + name: begin_start_trigger + summary: Starts a trigger. + signature: 'begin_start_trigger(trigger_name: str, **kwargs: Any) -> LROPoller[None]' + parameters: + - name: trigger_name + description: The trigger name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.TriggerOperations.begin_stop_trigger + name: begin_stop_trigger + summary: Stops a trigger. + signature: 'begin_stop_trigger(trigger_name: str, **kwargs: Any) -> LROPoller[None]' + parameters: + - name: trigger_name + description: The trigger name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either None or the result of + cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.TriggerOperations.begin_subscribe_trigger_to_events + name: begin_subscribe_trigger_to_events + summary: Subscribe event trigger to events. + signature: 'begin_subscribe_trigger_to_events(trigger_name: str, **kwargs: Any) + -> LROPoller[''models.TriggerSubscriptionOperationStatus'']' + parameters: + - name: trigger_name + description: The trigger name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either TriggerSubscriptionOperationStatus + or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.TriggerOperations.begin_unsubscribe_trigger_from_events + name: begin_unsubscribe_trigger_from_events + summary: Unsubscribe event trigger from events. + signature: 'begin_unsubscribe_trigger_from_events(trigger_name: str, **kwargs: Any) + -> LROPoller[''models.TriggerSubscriptionOperationStatus'']' + parameters: + - name: trigger_name + description: The trigger name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + - name: continuation_token + description: A continuation token to restart a poller from a saved state. + types: + - + - name: polling + description: 'True for ARMPolling, False for no polling, or a + + polling object for personal polling strategy' + types: + - + - + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - + return: + description: An instance of LROPoller that returns either TriggerSubscriptionOperationStatus + or the result of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.TriggerOperations.create_or_update_trigger + name: create_or_update_trigger + summary: Creates or updates a trigger. + signature: 'create_or_update_trigger(trigger_name: str, properties: ''models.Trigger'', + if_match: str | None = None, **kwargs: Any) -> models.TriggerResource' + parameters: + - name: trigger_name + description: The trigger name. + isRequired: true + types: + - + - name: properties + description: Properties of the trigger. + isRequired: true + types: + - + - name: if_match + description: 'ETag of the trigger entity. Should only be specified for update, + for which it + + should match existing entity or can be * for unconditional update.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: TriggerResource, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.TriggerOperations.delete_trigger + name: delete_trigger + summary: Deletes a trigger. + signature: 'delete_trigger(trigger_name: str, **kwargs: Any) -> None' + parameters: + - name: trigger_name + description: The trigger name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.TriggerOperations.get_event_subscription_status + name: get_event_subscription_status + summary: Get a trigger's event subscription status. + signature: 'get_event_subscription_status(trigger_name: str, **kwargs: Any) -> models.TriggerSubscriptionOperationStatus' + parameters: + - name: trigger_name + description: The trigger name. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: TriggerSubscriptionOperationStatus, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.TriggerOperations.get_trigger + name: get_trigger + summary: Gets a trigger. + signature: 'get_trigger(trigger_name: str, if_none_match: str | None = None, **kwargs: + Any) -> ''models.TriggerResource'' | None' + parameters: + - name: trigger_name + description: The trigger name. + isRequired: true + types: + - + - name: if_none_match + description: 'ETag of the trigger entity. Should only be specified for get. If + the ETag + + matches the existing entity tag, or if * was provided, then no content will + be returned.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: TriggerResource, or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.TriggerOperations.get_triggers_by_workspace + name: get_triggers_by_workspace + summary: Lists triggers. + signature: 'get_triggers_by_workspace(**kwargs: Any) -> Iterable[''models.TriggerListResponse'']' + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: An iterator like instance of either TriggerListResponse or the result + of cls(response) + types: + - [] + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.artifacts.operations.TriggerOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.TriggerRunOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.TriggerRunOperations.yml new file mode 100644 index 00000000..73a458ce --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.TriggerRunOperations.yml @@ -0,0 +1,84 @@ +### YamlMime:PythonClass +uid: azure.synapse.artifacts.operations.TriggerRunOperations +name: TriggerRunOperations +fullName: azure.synapse.artifacts.operations.TriggerRunOperations +module: azure.synapse.artifacts.operations +summary: 'TriggerRunOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: TriggerRunOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.artifacts.operations.TriggerRunOperations.query_trigger_runs_by_workspace + name: query_trigger_runs_by_workspace + summary: Query trigger runs. + signature: 'query_trigger_runs_by_workspace(filter_parameters: ''models.RunFilterParameters'', + **kwargs: Any) -> models.TriggerRunsQueryResponse' + parameters: + - name: filter_parameters + description: Parameters to filter the pipeline run. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: TriggerRunsQueryResponse, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.artifacts.operations.TriggerRunOperations.rerun_trigger_instance + name: rerun_trigger_instance + summary: Rerun single trigger instance by runId. + signature: 'rerun_trigger_instance(trigger_name: str, run_id: str, **kwargs: Any) + -> None' + parameters: + - name: trigger_name + description: The trigger name. + isRequired: true + types: + - + - name: run_id + description: The pipeline run identifier. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.artifacts.operations.TriggerRunOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.yml new file mode 100644 index 00000000..5d99c46c --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.operations.yml @@ -0,0 +1,17 @@ +### YamlMime:PythonPackage +uid: azure.synapse.artifacts.operations +name: operations +fullName: azure.synapse.artifacts.operations +type: import +classes: +- azure.synapse.artifacts.operations.DataFlowDebugSessionOperations +- azure.synapse.artifacts.operations.DataFlowOperations +- azure.synapse.artifacts.operations.DatasetOperations +- azure.synapse.artifacts.operations.LinkedServiceOperations +- azure.synapse.artifacts.operations.NotebookOperations +- azure.synapse.artifacts.operations.PipelineOperations +- azure.synapse.artifacts.operations.PipelineRunOperations +- azure.synapse.artifacts.operations.SparkJobDefinitionOperations +- azure.synapse.artifacts.operations.SqlScriptOperations +- azure.synapse.artifacts.operations.TriggerOperations +- azure.synapse.artifacts.operations.TriggerRunOperations diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.yml new file mode 100644 index 00000000..0433f70a --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonPackage +uid: azure.synapse.artifacts +name: artifacts +fullName: azure.synapse.artifacts +type: import +classes: +- azure.synapse.artifacts.ArtifactsClient +packages: +- azure.synapse.artifacts.aio +- azure.synapse.artifacts.models +- azure.synapse.artifacts.operations diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Config.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Config.yml new file mode 100644 index 00000000..28e398e0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Config.yml @@ -0,0 +1,122 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.Config +name: Config +fullName: azure.synapse.models.Config +module: azure.synapse.models +summary: Config. +constructor: + syntax: 'Config(*, is_hive_enabled: bool | None = None, **kwargs)' + parameters: + - name: is_hive_enabled + isRequired: true + types: + - + keywordOnlyParameters: + - name: is_hive_enabled + isRequired: true +methods: +- uid: azure.synapse.models.Config.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.Config.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.Config.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.Config.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.Config.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.Config.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.Config.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Data.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Data.yml new file mode 100644 index 00000000..c38233e3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Data.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.Data +name: Data +fullName: azure.synapse.models.Data +module: azure.synapse.models +summary: Data. +constructor: + syntax: 'Data(*, handler_path: str | None = None, inputs: List[str] | None = None, + outputs: List[str] | None = None, tables: Tables | None = None, config: Config + | None = None, **kwargs)' + parameters: + - name: handler_path + isRequired: true + types: + - + - name: inputs + isRequired: true + types: + - [] + - name: outputs + isRequired: true + types: + - [] + - name: tables + isRequired: true + types: + - + - name: config + isRequired: true + types: + - + keywordOnlyParameters: + - name: handler_path + isRequired: true + - name: inputs + isRequired: true + - name: outputs + isRequired: true + - name: tables + isRequired: true + - name: config + isRequired: true +methods: +- uid: azure.synapse.models.Data.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.Data.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.Data.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.Data.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.Data.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.Data.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.Data.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Edge.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Edge.yml new file mode 100644 index 00000000..899486f8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Edge.yml @@ -0,0 +1,128 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.Edge +name: Edge +fullName: azure.synapse.models.Edge +module: azure.synapse.models +summary: Edge. +constructor: + syntax: 'Edge(*, id: int | None = None, child_id: int | None = None, **kwargs)' + parameters: + - name: id + isRequired: true + types: + - + - name: child_id + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: child_id + isRequired: true +methods: +- uid: azure.synapse.models.Edge.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.Edge.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.Edge.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.Edge.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.Edge.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.Edge.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.Edge.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorDetail.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorDetail.yml new file mode 100644 index 00000000..d6addc8c --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorDetail.yml @@ -0,0 +1,139 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.ErrorDetail +name: ErrorDetail +fullName: azure.synapse.models.ErrorDetail +module: azure.synapse.models +summary: 'ErrorDetail. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ErrorDetail(*, code: str, message: str, target: str | None = None, **kwargs)' + parameters: + - name: code + description: Required. + isRequired: true + types: + - + - name: message + description: Required. + isRequired: true + types: + - + - name: target + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true + - name: target + isRequired: true +methods: +- uid: azure.synapse.models.ErrorDetail.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.ErrorDetail.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.ErrorDetail.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.ErrorDetail.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.ErrorDetail.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.ErrorDetail.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.ErrorDetail.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorInformation.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorInformation.yml new file mode 100644 index 00000000..54cdbcbc --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorInformation.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.ErrorInformation +name: ErrorInformation +fullName: azure.synapse.models.ErrorInformation +module: azure.synapse.models +summary: ErrorInformation. +constructor: + syntax: 'ErrorInformation(*, message: str | None = None, error_code: str | None + = None, source: str | ErrorSource | None = None, **kwargs)' + parameters: + - name: message + isRequired: true + types: + - + - name: error_code + isRequired: true + types: + - + - name: source + description: 'Possible values include: ''System'', ''User'', ''Unknown'', ''Dependency''.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: message + isRequired: true + - name: error_code + isRequired: true + - name: source + isRequired: true +methods: +- uid: azure.synapse.models.ErrorInformation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.ErrorInformation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.ErrorInformation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.ErrorInformation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.ErrorInformation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.ErrorInformation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.ErrorInformation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorResponse.yml new file mode 100644 index 00000000..a553e917 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorResponse.yml @@ -0,0 +1,146 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.ErrorResponse +name: ErrorResponse +fullName: azure.synapse.models.ErrorResponse +module: azure.synapse.models +summary: 'ErrorResponse. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'ErrorResponse(*, code: str, message: str, target: str | None = None, details: + List[ErrorDetail] | None = None, **kwargs)' + parameters: + - name: code + description: Required. + isRequired: true + types: + - + - name: message + description: Required. + isRequired: true + types: + - + - name: target + isRequired: true + types: + - + - name: details + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: code + isRequired: true + - name: message + isRequired: true + - name: target + isRequired: true + - name: details + isRequired: true +methods: +- uid: azure.synapse.models.ErrorResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.ErrorResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.ErrorResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.ErrorResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.ErrorResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.ErrorResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.ErrorResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorResponseException.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorResponseException.yml new file mode 100644 index 00000000..7276755c --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorResponseException.yml @@ -0,0 +1,47 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.ErrorResponseException +name: ErrorResponseException +fullName: azure.synapse.models.ErrorResponseException +module: azure.synapse.models +summary: 'Server responded with exception of type: ''ErrorResponse''.' +constructor: + syntax: ErrorResponseException(response, error_model) + parameters: + - name: response + description: Server response to be deserialized. + isRequired: true + - name: error_model + description: A deserialized model of the response body as model. + isRequired: true +methods: +- uid: azure.synapse.models.ErrorResponseException.add_note + name: add_note + summary: "Exception.add_note(note) \u2013\nadd a note to the exception" + signature: add_note() +- uid: azure.synapse.models.ErrorResponseException.from_response + name: from_response + summary: Deserialize this response as this exception, or a subclass of this exception. + signature: from_response(response, deserialize) + parameters: + - name: response + description: Server response to be deserialized. + isRequired: true + - name: deserialize + description: A deserializer + isRequired: true +- uid: azure.synapse.models.ErrorResponseException.raise_with_traceback + name: raise_with_traceback + summary: 'Raise the exception with the existing traceback. + + + *Deprecated since version 1.22.0:* This method is deprecated as we don''t support + Python 2 anymore. Use raise/from instead.' + signature: raise_with_traceback() -> None +- uid: azure.synapse.models.ErrorResponseException.with_traceback + name: with_traceback + summary: "Exception.with_traceback(tb) \u2013\nset self.__traceback__ to tb and\ + \ return self." + signature: with_traceback() +attributes: +- uid: azure.synapse.models.ErrorResponseException.args + name: args diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorSource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorSource.yml new file mode 100644 index 00000000..05f461fa --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorSource.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.synapse.models.ErrorSource +name: ErrorSource +fullName: azure.synapse.models.ErrorSource +module: azure.synapse.models +fields: +- name: dependency + uid: azure.synapse.models.ErrorSource.dependency +- name: system + uid: azure.synapse.models.ErrorSource.system +- name: unknown + uid: azure.synapse.models.ErrorSource.unknown +- name: user + uid: azure.synapse.models.ErrorSource.user diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Executors.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Executors.yml new file mode 100644 index 00000000..30b65571 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Executors.yml @@ -0,0 +1,161 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.Executors +name: Executors +fullName: azure.synapse.models.Executors +module: azure.synapse.models +summary: Executors. +constructor: + syntax: 'Executors(*, is_dynamic_allocation_on: bool | None = None, executor_instances: + int | None = None, start_time: int | None = None, end_time: int | None = None, + events: List[int] | None = None, executor_cores: str | None = None, executor_memory: + str | None = None, **kwargs)' + parameters: + - name: is_dynamic_allocation_on + isRequired: true + types: + - + - name: executor_instances + isRequired: true + types: + - + - name: start_time + isRequired: true + types: + - + - name: end_time + isRequired: true + types: + - + - name: events + isRequired: true + types: + - [] + - name: executor_cores + isRequired: true + types: + - + - name: executor_memory + isRequired: true + types: + - + keywordOnlyParameters: + - name: is_dynamic_allocation_on + isRequired: true + - name: executor_instances + isRequired: true + - name: start_time + isRequired: true + - name: end_time + isRequired: true + - name: events + isRequired: true + - name: executor_cores + isRequired: true + - name: executor_memory + isRequired: true +methods: +- uid: azure.synapse.models.Executors.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.Executors.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.Executors.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.Executors.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.Executors.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.Executors.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.Executors.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyBatchRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyBatchRequest.yml new file mode 100644 index 00000000..e2c5e87e --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyBatchRequest.yml @@ -0,0 +1,214 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.ExtendedLivyBatchRequest +name: ExtendedLivyBatchRequest +fullName: azure.synapse.models.ExtendedLivyBatchRequest +module: azure.synapse.models +summary: ExtendedLivyBatchRequest. +constructor: + syntax: 'ExtendedLivyBatchRequest(*, tags: Dict[str, str] | None = None, artifact_id: + str | None = None, name: str | None = None, file: str | None = None, class_name: + str | None = None, args: List[str] | None = None, jars: List[str] | None = None, + files: List[str] | None = None, archives: List[str] | None = None, conf: Dict[str, + str] | None = None, driver_memory: str | None = None, driver_cores: int | None + = None, executor_memory: str | None = None, executor_cores: int | None = None, + num_executors: int | None = None, **kwargs)' + parameters: + - name: tags + description: A set of tags. Dictionary of ``. + isRequired: true + types: + - [, ] + - name: artifact_id + isRequired: true + types: + - + - name: name + isRequired: true + types: + - + - name: file + isRequired: true + types: + - + - name: class_name + isRequired: true + types: + - + - name: args + isRequired: true + types: + - [] + - name: jars + isRequired: true + types: + - [] + - name: files + isRequired: true + types: + - [] + - name: archives + isRequired: true + types: + - [] + - name: conf + description: Dictionary of ``. + isRequired: true + types: + - [, ] + - name: driver_memory + isRequired: true + types: + - + - name: driver_cores + isRequired: true + types: + - + - name: executor_memory + isRequired: true + types: + - + - name: executor_cores + isRequired: true + types: + - + - name: num_executors + isRequired: true + types: + - + keywordOnlyParameters: + - name: tags + isRequired: true + - name: artifact_id + isRequired: true + - name: name + isRequired: true + - name: file + isRequired: true + - name: class_name + isRequired: true + - name: args + isRequired: true + - name: jars + isRequired: true + - name: files + isRequired: true + - name: archives + isRequired: true + - name: conf + isRequired: true + - name: driver_memory + isRequired: true + - name: driver_cores + isRequired: true + - name: executor_memory + isRequired: true + - name: executor_cores + isRequired: true + - name: num_executors + isRequired: true +methods: +- uid: azure.synapse.models.ExtendedLivyBatchRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.ExtendedLivyBatchRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.ExtendedLivyBatchRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.ExtendedLivyBatchRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.ExtendedLivyBatchRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.ExtendedLivyBatchRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.ExtendedLivyBatchRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyBatchResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyBatchResponse.yml new file mode 100644 index 00000000..54e4a3cf --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyBatchResponse.yml @@ -0,0 +1,239 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.ExtendedLivyBatchResponse +name: ExtendedLivyBatchResponse +fullName: azure.synapse.models.ExtendedLivyBatchResponse +module: azure.synapse.models +summary: ExtendedLivyBatchResponse. +constructor: + syntax: 'ExtendedLivyBatchResponse(*, livy_info: LivyBatchStateInformation | None + = None, name: str | None = None, workspace_name: str | None = None, spark_pool_name: + str | None = None, submitter_name: str | None = None, submitter_id: str | None + = None, artifact_id: str | None = None, job_type: str | JobType | None = None, + result: str | JobResult | None = None, scheduler_info: SchedulerInformation | + None = None, plugin_info: SparkServicePluginInformation | None = None, error_info: + List[ErrorInformation] | None = None, tags: Dict[str, str] | None = None, id: + int | None = None, app_id: str | None = None, app_info: Dict[str, str] | None + = None, state: str | None = None, log: List[str] | None = None, **kwargs)' + parameters: + - name: livy_info + isRequired: true + types: + - + - name: name + isRequired: true + types: + - + - name: workspace_name + isRequired: true + types: + - + - name: spark_pool_name + isRequired: true + types: + - + - name: submitter_name + isRequired: true + types: + - + - name: submitter_id + isRequired: true + types: + - + - name: artifact_id + isRequired: true + types: + - + - name: job_type + description: 'Possible values include: ''SparkBatch'', ''SparkSession''.' + isRequired: true + types: + - + - + - name: result + description: 'Possible values include: ''Uncertain'', ''Succeeded'', ''Failed'', + ''Cancelled''.' + isRequired: true + types: + - + - + - name: scheduler_info + isRequired: true + types: + - + - name: plugin_info + isRequired: true + types: + - + - name: error_info + isRequired: true + types: + - [] + - name: tags + description: A set of tags. Dictionary of ``. + isRequired: true + types: + - [, ] + - name: id + isRequired: true + types: + - + - name: app_id + isRequired: true + types: + - + - name: app_info + description: Dictionary of ``. + isRequired: true + types: + - [, ] + - name: state + isRequired: true + types: + - + - name: log + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: livy_info + isRequired: true + - name: name + isRequired: true + - name: workspace_name + isRequired: true + - name: spark_pool_name + isRequired: true + - name: submitter_name + isRequired: true + - name: submitter_id + isRequired: true + - name: artifact_id + isRequired: true + - name: job_type + isRequired: true + - name: result + isRequired: true + - name: scheduler_info + isRequired: true + - name: plugin_info + isRequired: true + - name: error_info + isRequired: true + - name: tags + isRequired: true + - name: id + isRequired: true + - name: app_id + isRequired: true + - name: app_info + isRequired: true + - name: state + isRequired: true + - name: log + isRequired: true +methods: +- uid: azure.synapse.models.ExtendedLivyBatchResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.ExtendedLivyBatchResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.ExtendedLivyBatchResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.ExtendedLivyBatchResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.ExtendedLivyBatchResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.ExtendedLivyBatchResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.ExtendedLivyBatchResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyListBatchResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyListBatchResponse.yml new file mode 100644 index 00000000..142a4276 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyListBatchResponse.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.ExtendedLivyListBatchResponse +name: ExtendedLivyListBatchResponse +fullName: azure.synapse.models.ExtendedLivyListBatchResponse +module: azure.synapse.models +summary: ExtendedLivyListBatchResponse. +constructor: + syntax: 'ExtendedLivyListBatchResponse(*, from_property: int | None = None, total: + int | None = None, sessions: List[ExtendedLivyBatchResponse] | None = None, **kwargs)' + parameters: + - name: from_property + isRequired: true + types: + - + - name: total + isRequired: true + types: + - + - name: sessions + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: from_property + isRequired: true + - name: total + isRequired: true + - name: sessions + isRequired: true +methods: +- uid: azure.synapse.models.ExtendedLivyListBatchResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.ExtendedLivyListBatchResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.ExtendedLivyListBatchResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.ExtendedLivyListBatchResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.ExtendedLivyListBatchResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.ExtendedLivyListBatchResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.ExtendedLivyListBatchResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyListSessionResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyListSessionResponse.yml new file mode 100644 index 00000000..c8e76537 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyListSessionResponse.yml @@ -0,0 +1,136 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.ExtendedLivyListSessionResponse +name: ExtendedLivyListSessionResponse +fullName: azure.synapse.models.ExtendedLivyListSessionResponse +module: azure.synapse.models +summary: ExtendedLivyListSessionResponse. +constructor: + syntax: 'ExtendedLivyListSessionResponse(*, from_property: int | None = None, total: + int | None = None, sessions: List[ExtendedLivySessionResponse] | None = None, + **kwargs)' + parameters: + - name: from_property + isRequired: true + types: + - + - name: total + isRequired: true + types: + - + - name: sessions + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: from_property + isRequired: true + - name: total + isRequired: true + - name: sessions + isRequired: true +methods: +- uid: azure.synapse.models.ExtendedLivyListSessionResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.ExtendedLivyListSessionResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.ExtendedLivyListSessionResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.ExtendedLivyListSessionResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.ExtendedLivyListSessionResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.ExtendedLivyListSessionResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.ExtendedLivyListSessionResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivySessionRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivySessionRequest.yml new file mode 100644 index 00000000..03672d39 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivySessionRequest.yml @@ -0,0 +1,214 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.ExtendedLivySessionRequest +name: ExtendedLivySessionRequest +fullName: azure.synapse.models.ExtendedLivySessionRequest +module: azure.synapse.models +summary: ExtendedLivySessionRequest. +constructor: + syntax: 'ExtendedLivySessionRequest(*, tags: Dict[str, str] | None = None, artifact_id: + str | None = None, name: str | None = None, file: str | None = None, class_name: + str | None = None, args: List[str] | None = None, jars: List[str] | None = None, + files: List[str] | None = None, archives: List[str] | None = None, conf: Dict[str, + str] | None = None, driver_memory: str | None = None, driver_cores: int | None + = None, executor_memory: str | None = None, executor_cores: int | None = None, + num_executors: int | None = None, **kwargs)' + parameters: + - name: tags + description: A set of tags. Dictionary of ``. + isRequired: true + types: + - [, ] + - name: artifact_id + isRequired: true + types: + - + - name: name + isRequired: true + types: + - + - name: file + isRequired: true + types: + - + - name: class_name + isRequired: true + types: + - + - name: args + isRequired: true + types: + - [] + - name: jars + isRequired: true + types: + - [] + - name: files + isRequired: true + types: + - [] + - name: archives + isRequired: true + types: + - [] + - name: conf + description: Dictionary of ``. + isRequired: true + types: + - [, ] + - name: driver_memory + isRequired: true + types: + - + - name: driver_cores + isRequired: true + types: + - + - name: executor_memory + isRequired: true + types: + - + - name: executor_cores + isRequired: true + types: + - + - name: num_executors + isRequired: true + types: + - + keywordOnlyParameters: + - name: tags + isRequired: true + - name: artifact_id + isRequired: true + - name: name + isRequired: true + - name: file + isRequired: true + - name: class_name + isRequired: true + - name: args + isRequired: true + - name: jars + isRequired: true + - name: files + isRequired: true + - name: archives + isRequired: true + - name: conf + isRequired: true + - name: driver_memory + isRequired: true + - name: driver_cores + isRequired: true + - name: executor_memory + isRequired: true + - name: executor_cores + isRequired: true + - name: num_executors + isRequired: true +methods: +- uid: azure.synapse.models.ExtendedLivySessionRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.ExtendedLivySessionRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.ExtendedLivySessionRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.ExtendedLivySessionRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.ExtendedLivySessionRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.ExtendedLivySessionRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.ExtendedLivySessionRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivySessionResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivySessionResponse.yml new file mode 100644 index 00000000..7728a981 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivySessionResponse.yml @@ -0,0 +1,239 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.ExtendedLivySessionResponse +name: ExtendedLivySessionResponse +fullName: azure.synapse.models.ExtendedLivySessionResponse +module: azure.synapse.models +summary: ExtendedLivySessionResponse. +constructor: + syntax: 'ExtendedLivySessionResponse(*, livy_info: LivySessionStateInformation | + None = None, name: str | None = None, workspace_name: str | None = None, spark_pool_name: + str | None = None, submitter_name: str | None = None, submitter_id: str | None + = None, artifact_id: str | None = None, job_type: str | JobType | None = None, + result: str | JobResult | None = None, scheduler_info: SchedulerInformation | + None = None, plugin_info: SparkServicePluginInformation | None = None, error_info: + List[ErrorInformation] | None = None, tags: Dict[str, str] | None = None, id: + int | None = None, app_id: str | None = None, app_info: Dict[str, str] | None + = None, state: str | None = None, log: List[str] | None = None, **kwargs)' + parameters: + - name: livy_info + isRequired: true + types: + - + - name: name + isRequired: true + types: + - + - name: workspace_name + isRequired: true + types: + - + - name: spark_pool_name + isRequired: true + types: + - + - name: submitter_name + isRequired: true + types: + - + - name: submitter_id + isRequired: true + types: + - + - name: artifact_id + isRequired: true + types: + - + - name: job_type + description: 'Possible values include: ''SparkBatch'', ''SparkSession''.' + isRequired: true + types: + - + - + - name: result + description: 'Possible values include: ''Uncertain'', ''Succeeded'', ''Failed'', + ''Cancelled''.' + isRequired: true + types: + - + - + - name: scheduler_info + isRequired: true + types: + - + - name: plugin_info + isRequired: true + types: + - + - name: error_info + isRequired: true + types: + - [] + - name: tags + description: A set of tags. Dictionary of ``. + isRequired: true + types: + - [, ] + - name: id + isRequired: true + types: + - + - name: app_id + isRequired: true + types: + - + - name: app_info + description: Dictionary of ``. + isRequired: true + types: + - [, ] + - name: state + isRequired: true + types: + - + - name: log + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: livy_info + isRequired: true + - name: name + isRequired: true + - name: workspace_name + isRequired: true + - name: spark_pool_name + isRequired: true + - name: submitter_name + isRequired: true + - name: submitter_id + isRequired: true + - name: artifact_id + isRequired: true + - name: job_type + isRequired: true + - name: result + isRequired: true + - name: scheduler_info + isRequired: true + - name: plugin_info + isRequired: true + - name: error_info + isRequired: true + - name: tags + isRequired: true + - name: id + isRequired: true + - name: app_id + isRequired: true + - name: app_info + isRequired: true + - name: state + isRequired: true + - name: log + isRequired: true +methods: +- uid: azure.synapse.models.ExtendedLivySessionResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.ExtendedLivySessionResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.ExtendedLivySessionResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.ExtendedLivySessionResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.ExtendedLivySessionResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.ExtendedLivySessionResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.ExtendedLivySessionResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.GetAccessControlInfoRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.GetAccessControlInfoRequest.yml new file mode 100644 index 00000000..65c6564f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.GetAccessControlInfoRequest.yml @@ -0,0 +1,134 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.GetAccessControlInfoRequest +name: GetAccessControlInfoRequest +fullName: azure.synapse.models.GetAccessControlInfoRequest +module: azure.synapse.models +summary: 'GetAccessControlInfoRequest. + + + Variables are only populated by the server, and will be ignored when sending a request.' +constructor: + syntax: 'GetAccessControlInfoRequest(*, artifact_name: str | None = None, **kwargs)' + parameters: + - name: artifact_name + isRequired: true + types: + - + keywordOnlyParameters: + - name: artifact_name + isRequired: true +variables: +- description: 'Default value: "Workspace".' + name: artifact_type + types: + - +methods: +- uid: azure.synapse.models.GetAccessControlInfoRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.GetAccessControlInfoRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.GetAccessControlInfoRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.GetAccessControlInfoRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.GetAccessControlInfoRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.GetAccessControlInfoRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.GetAccessControlInfoRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - +attributes: +- uid: azure.synapse.models.GetAccessControlInfoRequest.artifact_type + name: artifact_type + signature: artifact_type = 'Workspace' diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDataResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDataResponse.yml new file mode 100644 index 00000000..854a6f91 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDataResponse.yml @@ -0,0 +1,122 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.HistoryServerDataResponse +name: HistoryServerDataResponse +fullName: azure.synapse.models.HistoryServerDataResponse +module: azure.synapse.models +summary: HistoryServerDataResponse. +constructor: + syntax: 'HistoryServerDataResponse(*, data: Data | None = None, **kwargs)' + parameters: + - name: data + isRequired: true + types: + - + keywordOnlyParameters: + - name: data + isRequired: true +methods: +- uid: azure.synapse.models.HistoryServerDataResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.HistoryServerDataResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.HistoryServerDataResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.HistoryServerDataResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.HistoryServerDataResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.HistoryServerDataResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.HistoryServerDataResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDiagnosticResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDiagnosticResponse.yml new file mode 100644 index 00000000..4d74eab7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDiagnosticResponse.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.HistoryServerDiagnosticResponse +name: HistoryServerDiagnosticResponse +fullName: azure.synapse.models.HistoryServerDiagnosticResponse +module: azure.synapse.models +summary: HistoryServerDiagnosticResponse. +constructor: + syntax: 'HistoryServerDiagnosticResponse(*, data: HistoryServerDiagnosticResponseData + | None = None, **kwargs)' + parameters: + - name: data + isRequired: true + types: + - + keywordOnlyParameters: + - name: data + isRequired: true +methods: +- uid: azure.synapse.models.HistoryServerDiagnosticResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.HistoryServerDiagnosticResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.HistoryServerDiagnosticResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.HistoryServerDiagnosticResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.HistoryServerDiagnosticResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.HistoryServerDiagnosticResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.HistoryServerDiagnosticResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDiagnosticResponseData.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDiagnosticResponseData.yml new file mode 100644 index 00000000..6b757e1e --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDiagnosticResponseData.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.HistoryServerDiagnosticResponseData +name: HistoryServerDiagnosticResponseData +fullName: azure.synapse.models.HistoryServerDiagnosticResponseData +module: azure.synapse.models +summary: HistoryServerDiagnosticResponseData. +constructor: + syntax: 'HistoryServerDiagnosticResponseData(*, stages: Stages | None = None, executors: + Executors | None = None, **kwargs)' + parameters: + - name: stages + isRequired: true + types: + - + - name: executors + isRequired: true + types: + - + keywordOnlyParameters: + - name: stages + isRequired: true + - name: executors + isRequired: true +methods: +- uid: azure.synapse.models.HistoryServerDiagnosticResponseData.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.HistoryServerDiagnosticResponseData.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.HistoryServerDiagnosticResponseData.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.HistoryServerDiagnosticResponseData.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.HistoryServerDiagnosticResponseData.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.HistoryServerDiagnosticResponseData.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.HistoryServerDiagnosticResponseData.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerGraphResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerGraphResponse.yml new file mode 100644 index 00000000..971b3c7d --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerGraphResponse.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.HistoryServerGraphResponse +name: HistoryServerGraphResponse +fullName: azure.synapse.models.HistoryServerGraphResponse +module: azure.synapse.models +summary: HistoryServerGraphResponse. +constructor: + syntax: 'HistoryServerGraphResponse(*, data: HistoryServerGraphResponseData | None + = None, **kwargs)' + parameters: + - name: data + isRequired: true + types: + - + keywordOnlyParameters: + - name: data + isRequired: true +methods: +- uid: azure.synapse.models.HistoryServerGraphResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.HistoryServerGraphResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.HistoryServerGraphResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.HistoryServerGraphResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.HistoryServerGraphResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.HistoryServerGraphResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.HistoryServerGraphResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerGraphResponseData.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerGraphResponseData.yml new file mode 100644 index 00000000..cf769b91 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerGraphResponseData.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.HistoryServerGraphResponseData +name: HistoryServerGraphResponseData +fullName: azure.synapse.models.HistoryServerGraphResponseData +module: azure.synapse.models +summary: HistoryServerGraphResponseData. +constructor: + syntax: 'HistoryServerGraphResponseData(*, is_app_finished: bool | None = None, + jobs: Jobs | None = None, stages: Stages | None = None, **kwargs)' + parameters: + - name: is_app_finished + isRequired: true + types: + - + - name: jobs + isRequired: true + types: + - + - name: stages + isRequired: true + types: + - + keywordOnlyParameters: + - name: is_app_finished + isRequired: true + - name: jobs + isRequired: true + - name: stages + isRequired: true +methods: +- uid: azure.synapse.models.HistoryServerGraphResponseData.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.HistoryServerGraphResponseData.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.HistoryServerGraphResponseData.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.HistoryServerGraphResponseData.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.HistoryServerGraphResponseData.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.HistoryServerGraphResponseData.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.HistoryServerGraphResponseData.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerPropertiesResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerPropertiesResponse.yml new file mode 100644 index 00000000..bae0276e --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerPropertiesResponse.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.HistoryServerPropertiesResponse +name: HistoryServerPropertiesResponse +fullName: azure.synapse.models.HistoryServerPropertiesResponse +module: azure.synapse.models +summary: HistoryServerPropertiesResponse. +constructor: + syntax: 'HistoryServerPropertiesResponse(*, web_proxy_endpoint: str | None = None, + **kwargs)' + parameters: + - name: web_proxy_endpoint + isRequired: true + types: + - + keywordOnlyParameters: + - name: web_proxy_endpoint + isRequired: true +methods: +- uid: azure.synapse.models.HistoryServerPropertiesResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.HistoryServerPropertiesResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.HistoryServerPropertiesResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.HistoryServerPropertiesResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.HistoryServerPropertiesResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.HistoryServerPropertiesResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.HistoryServerPropertiesResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.JobResult.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.JobResult.yml new file mode 100644 index 00000000..0030d707 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.JobResult.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.synapse.models.JobResult +name: JobResult +fullName: azure.synapse.models.JobResult +module: azure.synapse.models +fields: +- name: cancelled + uid: azure.synapse.models.JobResult.cancelled +- name: failed + uid: azure.synapse.models.JobResult.failed +- name: succeeded + uid: azure.synapse.models.JobResult.succeeded +- name: uncertain + uid: azure.synapse.models.JobResult.uncertain diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.JobType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.JobType.yml new file mode 100644 index 00000000..a74920dc --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.JobType.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonEnum +uid: azure.synapse.models.JobType +name: JobType +fullName: azure.synapse.models.JobType +module: azure.synapse.models +fields: +- name: spark_batch + uid: azure.synapse.models.JobType.spark_batch +- name: spark_session + uid: azure.synapse.models.JobType.spark_session diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Jobs.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Jobs.yml new file mode 100644 index 00000000..447415a8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Jobs.yml @@ -0,0 +1,148 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.Jobs +name: Jobs +fullName: azure.synapse.models.Jobs +module: azure.synapse.models +summary: Jobs. +constructor: + syntax: 'Jobs(*, time: int | None = None, start_time: int | None = None, id: int + | None = None, edges: List[Edge] | None = None, nodes: List[int] | None = None, + **kwargs)' + parameters: + - name: time + isRequired: true + types: + - + - name: start_time + isRequired: true + types: + - + - name: id + isRequired: true + types: + - + - name: edges + isRequired: true + types: + - [] + - name: nodes + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: time + isRequired: true + - name: start_time + isRequired: true + - name: id + isRequired: true + - name: edges + isRequired: true + - name: nodes + isRequired: true +methods: +- uid: azure.synapse.models.Jobs.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.Jobs.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.Jobs.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.Jobs.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.Jobs.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.Jobs.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.Jobs.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyBatchStateInformation.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyBatchStateInformation.yml new file mode 100644 index 00000000..53f7b709 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyBatchStateInformation.yml @@ -0,0 +1,174 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.LivyBatchStateInformation +name: LivyBatchStateInformation +fullName: azure.synapse.models.LivyBatchStateInformation +module: azure.synapse.models +summary: LivyBatchStateInformation. +constructor: + syntax: 'LivyBatchStateInformation(*, not_started_at: datetime | None = None, starting_at: + datetime | None = None, running_at: datetime | None = None, dead_at: datetime + | None = None, success_at: datetime | None = None, killed_at: datetime | None + = None, recovering_at: datetime | None = None, current_state: str | None = None, + job_creation_request: LivyRequestBase | None = None, **kwargs)' + parameters: + - name: not_started_at + isRequired: true + types: + - + - name: starting_at + isRequired: true + types: + - + - name: running_at + isRequired: true + types: + - + - name: dead_at + isRequired: true + types: + - + - name: success_at + isRequired: true + types: + - + - name: killed_at + isRequired: true + types: + - + - name: recovering_at + isRequired: true + types: + - + - name: current_state + isRequired: true + types: + - + - name: job_creation_request + isRequired: true + types: + - + keywordOnlyParameters: + - name: not_started_at + isRequired: true + - name: starting_at + isRequired: true + - name: running_at + isRequired: true + - name: dead_at + isRequired: true + - name: success_at + isRequired: true + - name: killed_at + isRequired: true + - name: recovering_at + isRequired: true + - name: current_state + isRequired: true + - name: job_creation_request + isRequired: true +methods: +- uid: azure.synapse.models.LivyBatchStateInformation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.LivyBatchStateInformation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.LivyBatchStateInformation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.LivyBatchStateInformation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.LivyBatchStateInformation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.LivyBatchStateInformation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.LivyBatchStateInformation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyRequestBase.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyRequestBase.yml new file mode 100644 index 00000000..4dce6e89 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyRequestBase.yml @@ -0,0 +1,200 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.LivyRequestBase +name: LivyRequestBase +fullName: azure.synapse.models.LivyRequestBase +module: azure.synapse.models +summary: LivyRequestBase. +constructor: + syntax: 'LivyRequestBase(*, name: str | None = None, file: str | None = None, class_name: + str | None = None, args: List[str] | None = None, jars: List[str] | None = None, + files: List[str] | None = None, archives: List[str] | None = None, conf: Dict[str, + str] | None = None, driver_memory: str | None = None, driver_cores: int | None + = None, executor_memory: str | None = None, executor_cores: int | None = None, + num_executors: int | None = None, **kwargs)' + parameters: + - name: name + isRequired: true + types: + - + - name: file + isRequired: true + types: + - + - name: class_name + isRequired: true + types: + - + - name: args + isRequired: true + types: + - [] + - name: jars + isRequired: true + types: + - [] + - name: files + isRequired: true + types: + - [] + - name: archives + isRequired: true + types: + - [] + - name: conf + description: Dictionary of ``. + isRequired: true + types: + - [, ] + - name: driver_memory + isRequired: true + types: + - + - name: driver_cores + isRequired: true + types: + - + - name: executor_memory + isRequired: true + types: + - + - name: executor_cores + isRequired: true + types: + - + - name: num_executors + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: file + isRequired: true + - name: class_name + isRequired: true + - name: args + isRequired: true + - name: jars + isRequired: true + - name: files + isRequired: true + - name: archives + isRequired: true + - name: conf + isRequired: true + - name: driver_memory + isRequired: true + - name: driver_cores + isRequired: true + - name: executor_memory + isRequired: true + - name: executor_cores + isRequired: true + - name: num_executors + isRequired: true +methods: +- uid: azure.synapse.models.LivyRequestBase.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.LivyRequestBase.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.LivyRequestBase.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.LivyRequestBase.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.LivyRequestBase.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.LivyRequestBase.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.LivyRequestBase.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivySessionStateInformation.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivySessionStateInformation.yml new file mode 100644 index 00000000..820fcb56 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivySessionStateInformation.yml @@ -0,0 +1,187 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.LivySessionStateInformation +name: LivySessionStateInformation +fullName: azure.synapse.models.LivySessionStateInformation +module: azure.synapse.models +summary: LivySessionStateInformation. +constructor: + syntax: 'LivySessionStateInformation(*, not_started_at: datetime | None = None, + starting_at: datetime | None = None, idle_at: datetime | None = None, dead_at: + datetime | None = None, shutting_down_at: datetime | None = None, killed_at: datetime + | None = None, recovering_at: datetime | None = None, busy_at: datetime | None + = None, error_at: datetime | None = None, current_state: str | None = None, job_creation_request: + LivyRequestBase | None = None, **kwargs)' + parameters: + - name: not_started_at + isRequired: true + types: + - + - name: starting_at + isRequired: true + types: + - + - name: idle_at + isRequired: true + types: + - + - name: dead_at + isRequired: true + types: + - + - name: shutting_down_at + isRequired: true + types: + - + - name: killed_at + isRequired: true + types: + - + - name: recovering_at + isRequired: true + types: + - + - name: busy_at + isRequired: true + types: + - + - name: error_at + isRequired: true + types: + - + - name: current_state + isRequired: true + types: + - + - name: job_creation_request + isRequired: true + types: + - + keywordOnlyParameters: + - name: not_started_at + isRequired: true + - name: starting_at + isRequired: true + - name: idle_at + isRequired: true + - name: dead_at + isRequired: true + - name: shutting_down_at + isRequired: true + - name: killed_at + isRequired: true + - name: recovering_at + isRequired: true + - name: busy_at + isRequired: true + - name: error_at + isRequired: true + - name: current_state + isRequired: true + - name: job_creation_request + isRequired: true +methods: +- uid: azure.synapse.models.LivySessionStateInformation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.LivySessionStateInformation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.LivySessionStateInformation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.LivySessionStateInformation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.LivySessionStateInformation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.LivySessionStateInformation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.LivySessionStateInformation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementCancellationResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementCancellationResponse.yml new file mode 100644 index 00000000..ebeddb80 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementCancellationResponse.yml @@ -0,0 +1,122 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.LivyStatementCancellationResponse +name: LivyStatementCancellationResponse +fullName: azure.synapse.models.LivyStatementCancellationResponse +module: azure.synapse.models +summary: LivyStatementCancellationResponse. +constructor: + syntax: 'LivyStatementCancellationResponse(*, msg: str | None = None, **kwargs)' + parameters: + - name: msg + isRequired: true + types: + - + keywordOnlyParameters: + - name: msg + isRequired: true +methods: +- uid: azure.synapse.models.LivyStatementCancellationResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.LivyStatementCancellationResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.LivyStatementCancellationResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.LivyStatementCancellationResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.LivyStatementCancellationResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.LivyStatementCancellationResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.LivyStatementCancellationResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementOutput.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementOutput.yml new file mode 100644 index 00000000..ba90a8c2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementOutput.yml @@ -0,0 +1,154 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.LivyStatementOutput +name: LivyStatementOutput +fullName: azure.synapse.models.LivyStatementOutput +module: azure.synapse.models +summary: LivyStatementOutput. +constructor: + syntax: 'LivyStatementOutput(*, status: str | None = None, execution_count: int + | None = None, data: object | None = None, ename: str | None = None, evalue: str + | None = None, traceback: List[str] | None = None, **kwargs)' + parameters: + - name: status + isRequired: true + types: + - + - name: execution_count + isRequired: true + types: + - + - name: data + isRequired: true + types: + - + - name: ename + isRequired: true + types: + - + - name: evalue + isRequired: true + types: + - + - name: traceback + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: status + isRequired: true + - name: execution_count + isRequired: true + - name: data + isRequired: true + - name: ename + isRequired: true + - name: evalue + isRequired: true + - name: traceback + isRequired: true +methods: +- uid: azure.synapse.models.LivyStatementOutput.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.LivyStatementOutput.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.LivyStatementOutput.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.LivyStatementOutput.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.LivyStatementOutput.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.LivyStatementOutput.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.LivyStatementOutput.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementRequestBody.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementRequestBody.yml new file mode 100644 index 00000000..057de47f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementRequestBody.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.LivyStatementRequestBody +name: LivyStatementRequestBody +fullName: azure.synapse.models.LivyStatementRequestBody +module: azure.synapse.models +summary: LivyStatementRequestBody. +constructor: + syntax: 'LivyStatementRequestBody(*, code: str | None = None, kind: str | None = + None, **kwargs)' + parameters: + - name: code + isRequired: true + types: + - + - name: kind + isRequired: true + types: + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: kind + isRequired: true +methods: +- uid: azure.synapse.models.LivyStatementRequestBody.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.LivyStatementRequestBody.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.LivyStatementRequestBody.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.LivyStatementRequestBody.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.LivyStatementRequestBody.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.LivyStatementRequestBody.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.LivyStatementRequestBody.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementResponseBody.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementResponseBody.yml new file mode 100644 index 00000000..5d849fb2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementResponseBody.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.LivyStatementResponseBody +name: LivyStatementResponseBody +fullName: azure.synapse.models.LivyStatementResponseBody +module: azure.synapse.models +summary: LivyStatementResponseBody. +constructor: + syntax: 'LivyStatementResponseBody(*, id: int | None = None, code: str | None = + None, state: str | None = None, output: LivyStatementOutput | None = None, **kwargs)' + parameters: + - name: id + isRequired: true + types: + - + - name: code + isRequired: true + types: + - + - name: state + isRequired: true + types: + - + - name: output + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: code + isRequired: true + - name: state + isRequired: true + - name: output + isRequired: true +methods: +- uid: azure.synapse.models.LivyStatementResponseBody.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.LivyStatementResponseBody.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.LivyStatementResponseBody.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.LivyStatementResponseBody.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.LivyStatementResponseBody.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.LivyStatementResponseBody.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.LivyStatementResponseBody.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementsResponseBody.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementsResponseBody.yml new file mode 100644 index 00000000..3c0d5eae --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementsResponseBody.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.LivyStatementsResponseBody +name: LivyStatementsResponseBody +fullName: azure.synapse.models.LivyStatementsResponseBody +module: azure.synapse.models +summary: LivyStatementsResponseBody. +constructor: + syntax: 'LivyStatementsResponseBody(*, total_statements: int | None = None, statements: + List[LivyStatementResponseBody] | None = None, **kwargs)' + parameters: + - name: total_statements + isRequired: true + types: + - + - name: statements + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: total_statements + isRequired: true + - name: statements + isRequired: true +methods: +- uid: azure.synapse.models.LivyStatementsResponseBody.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.LivyStatementsResponseBody.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.LivyStatementsResponseBody.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.LivyStatementsResponseBody.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.LivyStatementsResponseBody.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.LivyStatementsResponseBody.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.LivyStatementsResponseBody.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Option.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Option.yml new file mode 100644 index 00000000..579901c3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Option.yml @@ -0,0 +1,135 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.Option +name: Option +fullName: azure.synapse.models.Option +module: azure.synapse.models +summary: Option. +constructor: + syntax: 'Option(*, additional_prop1: str | None = None, additional_prop2: str | + None = None, additional_prop3: str | None = None, **kwargs)' + parameters: + - name: additional_prop1 + isRequired: true + types: + - + - name: additional_prop2 + isRequired: true + types: + - + - name: additional_prop3 + isRequired: true + types: + - + keywordOnlyParameters: + - name: additional_prop1 + isRequired: true + - name: additional_prop2 + isRequired: true + - name: additional_prop3 + isRequired: true +methods: +- uid: azure.synapse.models.Option.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.Option.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.Option.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.Option.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.Option.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.Option.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.Option.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.PluginCurrentState.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.PluginCurrentState.yml new file mode 100644 index 00000000..0f70c15a --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.PluginCurrentState.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonEnum +uid: azure.synapse.models.PluginCurrentState +name: PluginCurrentState +fullName: azure.synapse.models.PluginCurrentState +module: azure.synapse.models +fields: +- name: cleanup + uid: azure.synapse.models.PluginCurrentState.cleanup +- name: ended + uid: azure.synapse.models.PluginCurrentState.ended +- name: monitoring + uid: azure.synapse.models.PluginCurrentState.monitoring +- name: preparation + uid: azure.synapse.models.PluginCurrentState.preparation +- name: queued + uid: azure.synapse.models.PluginCurrentState.queued +- name: resource_acquisition + uid: azure.synapse.models.PluginCurrentState.resource_acquisition +- name: submission + uid: azure.synapse.models.PluginCurrentState.submission diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SchedulerCurrentState.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SchedulerCurrentState.yml new file mode 100644 index 00000000..df2edd71 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SchedulerCurrentState.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.synapse.models.SchedulerCurrentState +name: SchedulerCurrentState +fullName: azure.synapse.models.SchedulerCurrentState +module: azure.synapse.models +fields: +- name: ended + uid: azure.synapse.models.SchedulerCurrentState.ended +- name: queued + uid: azure.synapse.models.SchedulerCurrentState.queued +- name: scheduled + uid: azure.synapse.models.SchedulerCurrentState.scheduled diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SchedulerInformation.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SchedulerInformation.yml new file mode 100644 index 00000000..dbd46257 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SchedulerInformation.yml @@ -0,0 +1,151 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.SchedulerInformation +name: SchedulerInformation +fullName: azure.synapse.models.SchedulerInformation +module: azure.synapse.models +summary: SchedulerInformation. +constructor: + syntax: 'SchedulerInformation(*, submitted_at: datetime | None = None, scheduled_at: + datetime | None = None, ended_at: datetime | None = None, cancellation_requested_at: + datetime | None = None, current_state: str | SchedulerCurrentState | None = None, + **kwargs)' + parameters: + - name: submitted_at + isRequired: true + types: + - + - name: scheduled_at + isRequired: true + types: + - + - name: ended_at + isRequired: true + types: + - + - name: cancellation_requested_at + isRequired: true + types: + - + - name: current_state + description: 'Possible values include: ''Queued'', ''Scheduled'', ''Ended''.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: submitted_at + isRequired: true + - name: scheduled_at + isRequired: true + - name: ended_at + isRequired: true + - name: cancellation_requested_at + isRequired: true + - name: current_state + isRequired: true +methods: +- uid: azure.synapse.models.SchedulerInformation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.SchedulerInformation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.SchedulerInformation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.SchedulerInformation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.SchedulerInformation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.SchedulerInformation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.SchedulerInformation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SetWorkspaceAdministratorsRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SetWorkspaceAdministratorsRequest.yml new file mode 100644 index 00000000..7dcfe3f2 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SetWorkspaceAdministratorsRequest.yml @@ -0,0 +1,123 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.SetWorkspaceAdministratorsRequest +name: SetWorkspaceAdministratorsRequest +fullName: azure.synapse.models.SetWorkspaceAdministratorsRequest +module: azure.synapse.models +summary: SetWorkspaceAdministratorsRequest. +constructor: + syntax: 'SetWorkspaceAdministratorsRequest(*, administrators: List[str] | None = + None, **kwargs)' + parameters: + - name: administrators + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: administrators + isRequired: true +methods: +- uid: azure.synapse.models.SetWorkspaceAdministratorsRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.SetWorkspaceAdministratorsRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.SetWorkspaceAdministratorsRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.SetWorkspaceAdministratorsRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.SetWorkspaceAdministratorsRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.SetWorkspaceAdministratorsRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.SetWorkspaceAdministratorsRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkJob.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkJob.yml new file mode 100644 index 00000000..e87ea4ec --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkJob.yml @@ -0,0 +1,212 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.SparkJob +name: SparkJob +fullName: azure.synapse.models.SparkJob +module: azure.synapse.models +summary: SparkJob. +constructor: + syntax: 'SparkJob(*, state: str | None = None, name: str | None = None, submitter: + str | None = None, compute: str | None = None, spark_application_id: str | None + = None, livy_id: str | None = None, timing: List[str] | None = None, spark_job_definition: + str | None = None, pipeline: List[SparkJob] | None = None, job_type: str | None + = None, submit_time: datetime | None = None, end_time: datetime | None = None, + queued_duration: str | None = None, running_duration: str | None = None, total_duration: + str | None = None, **kwargs)' + parameters: + - name: state + isRequired: true + types: + - + - name: name + isRequired: true + types: + - + - name: submitter + isRequired: true + types: + - + - name: compute + isRequired: true + types: + - + - name: spark_application_id + isRequired: true + types: + - + - name: livy_id + isRequired: true + types: + - + - name: timing + isRequired: true + types: + - [] + - name: spark_job_definition + isRequired: true + types: + - + - name: pipeline + isRequired: true + types: + - [] + - name: job_type + isRequired: true + types: + - + - name: submit_time + isRequired: true + types: + - + - name: end_time + isRequired: true + types: + - + - name: queued_duration + isRequired: true + types: + - + - name: running_duration + isRequired: true + types: + - + - name: total_duration + isRequired: true + types: + - + keywordOnlyParameters: + - name: state + isRequired: true + - name: name + isRequired: true + - name: submitter + isRequired: true + - name: compute + isRequired: true + - name: spark_application_id + isRequired: true + - name: livy_id + isRequired: true + - name: timing + isRequired: true + - name: spark_job_definition + isRequired: true + - name: pipeline + isRequired: true + - name: job_type + isRequired: true + - name: submit_time + isRequired: true + - name: end_time + isRequired: true + - name: queued_duration + isRequired: true + - name: running_duration + isRequired: true + - name: total_duration + isRequired: true +methods: +- uid: azure.synapse.models.SparkJob.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.SparkJob.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.SparkJob.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.SparkJob.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.SparkJob.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.SparkJob.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.SparkJob.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkJobListViewResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkJobListViewResponse.yml new file mode 100644 index 00000000..a30e5754 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkJobListViewResponse.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.SparkJobListViewResponse +name: SparkJobListViewResponse +fullName: azure.synapse.models.SparkJobListViewResponse +module: azure.synapse.models +summary: SparkJobListViewResponse. +constructor: + syntax: 'SparkJobListViewResponse(*, n_jobs: int | None = None, spark_jobs: List[SparkJob] + | None = None, **kwargs)' + parameters: + - name: n_jobs + isRequired: true + types: + - + - name: spark_jobs + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: n_jobs + isRequired: true + - name: spark_jobs + isRequired: true +methods: +- uid: azure.synapse.models.SparkJobListViewResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.SparkJobListViewResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.SparkJobListViewResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.SparkJobListViewResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.SparkJobListViewResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.SparkJobListViewResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.SparkJobListViewResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkServicePluginInformation.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkServicePluginInformation.yml new file mode 100644 index 00000000..63061b2f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkServicePluginInformation.yml @@ -0,0 +1,161 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.SparkServicePluginInformation +name: SparkServicePluginInformation +fullName: azure.synapse.models.SparkServicePluginInformation +module: azure.synapse.models +summary: SparkServicePluginInformation. +constructor: + syntax: 'SparkServicePluginInformation(*, preparation_started_at: datetime | None + = None, resource_acquisition_started_at: datetime | None = None, submission_started_at: + datetime | None = None, monitoring_started_at: datetime | None = None, cleanup_started_at: + datetime | None = None, current_state: str | PluginCurrentState | None = None, + **kwargs)' + parameters: + - name: preparation_started_at + isRequired: true + types: + - + - name: resource_acquisition_started_at + isRequired: true + types: + - + - name: submission_started_at + isRequired: true + types: + - + - name: monitoring_started_at + isRequired: true + types: + - + - name: cleanup_started_at + isRequired: true + types: + - + - name: current_state + description: 'Possible values include: ''Preparation'', ''ResourceAcquisition'', + ''Queued'', + + ''Submission'', ''Monitoring'', ''Cleanup'', ''Ended''.' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: preparation_started_at + isRequired: true + - name: resource_acquisition_started_at + isRequired: true + - name: submission_started_at + isRequired: true + - name: monitoring_started_at + isRequired: true + - name: cleanup_started_at + isRequired: true + - name: current_state + isRequired: true +methods: +- uid: azure.synapse.models.SparkServicePluginInformation.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.SparkServicePluginInformation.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.SparkServicePluginInformation.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.SparkServicePluginInformation.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.SparkServicePluginInformation.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.SparkServicePluginInformation.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.SparkServicePluginInformation.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Stages.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Stages.yml new file mode 100644 index 00000000..71039ea7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Stages.yml @@ -0,0 +1,167 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.Stages +name: Stages +fullName: azure.synapse.models.Stages +module: azure.synapse.models +summary: Stages. +constructor: + syntax: 'Stages(*, data_avg: int | None = None, time_avg: int | None = None, id: + int | None = None, attempt_id: int | None = None, name: str | None = None, data_skew_task: + List[int] | None = None, time_skew_task: List[int] | None = None, tasks: List[int] + | None = None, **kwargs)' + parameters: + - name: data_avg + isRequired: true + types: + - + - name: time_avg + isRequired: true + types: + - + - name: id + isRequired: true + types: + - + - name: attempt_id + isRequired: true + types: + - + - name: name + isRequired: true + types: + - + - name: data_skew_task + isRequired: true + types: + - [] + - name: time_skew_task + isRequired: true + types: + - [] + - name: tasks + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: data_avg + isRequired: true + - name: time_avg + isRequired: true + - name: id + isRequired: true + - name: attempt_id + isRequired: true + - name: name + isRequired: true + - name: data_skew_task + isRequired: true + - name: time_skew_task + isRequired: true + - name: tasks + isRequired: true +methods: +- uid: azure.synapse.models.Stages.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.Stages.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.Stages.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.Stages.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.Stages.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.Stages.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.Stages.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Tables.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Tables.yml new file mode 100644 index 00000000..9dac27eb --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Tables.yml @@ -0,0 +1,129 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.Tables +name: Tables +fullName: azure.synapse.models.Tables +module: azure.synapse.models +summary: Tables. +constructor: + syntax: 'Tables(*, operation: str | None = None, options: List[Option] | None = + None, **kwargs)' + parameters: + - name: operation + isRequired: true + types: + - + - name: options + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: operation + isRequired: true + - name: options + isRequired: true +methods: +- uid: azure.synapse.models.Tables.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.Tables.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.Tables.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.Tables.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.Tables.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.Tables.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.Tables.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.WorkspaceAccessControlResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.WorkspaceAccessControlResponse.yml new file mode 100644 index 00000000..a2646494 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.WorkspaceAccessControlResponse.yml @@ -0,0 +1,138 @@ +### YamlMime:PythonClass +uid: azure.synapse.models.WorkspaceAccessControlResponse +name: WorkspaceAccessControlResponse +fullName: azure.synapse.models.WorkspaceAccessControlResponse +module: azure.synapse.models +summary: WorkspaceAccessControlResponse. +constructor: + syntax: 'WorkspaceAccessControlResponse(*, administrators: List[str] | None = None, + etag: str | None = None, access_control_list: Dict[str, List[str]] | None = None, + **kwargs)' + parameters: + - name: administrators + isRequired: true + types: + - [] + - name: etag + isRequired: true + types: + - + - name: access_control_list + description: "Dictionary of\n." + isRequired: true + types: + - [, []] + keywordOnlyParameters: + - name: administrators + isRequired: true + - name: etag + isRequired: true + - name: access_control_list + isRequired: true +methods: +- uid: azure.synapse.models.WorkspaceAccessControlResponse.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.WorkspaceAccessControlResponse.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.WorkspaceAccessControlResponse.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.models.WorkspaceAccessControlResponse.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.models.WorkspaceAccessControlResponse.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.models.WorkspaceAccessControlResponse.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.models.WorkspaceAccessControlResponse.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.yml new file mode 100644 index 00000000..e2b9b9d4 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.yml @@ -0,0 +1,51 @@ +### YamlMime:PythonPackage +uid: azure.synapse.models +name: models +fullName: azure.synapse.models +type: import +classes: +- azure.synapse.models.Config +- azure.synapse.models.Data +- azure.synapse.models.Edge +- azure.synapse.models.ErrorDetail +- azure.synapse.models.ErrorInformation +- azure.synapse.models.ErrorResponse +- azure.synapse.models.ErrorResponseException +- azure.synapse.models.Executors +- azure.synapse.models.ExtendedLivyBatchRequest +- azure.synapse.models.ExtendedLivyBatchResponse +- azure.synapse.models.ExtendedLivyListBatchResponse +- azure.synapse.models.ExtendedLivyListSessionResponse +- azure.synapse.models.ExtendedLivySessionRequest +- azure.synapse.models.ExtendedLivySessionResponse +- azure.synapse.models.GetAccessControlInfoRequest +- azure.synapse.models.HistoryServerDataResponse +- azure.synapse.models.HistoryServerDiagnosticResponse +- azure.synapse.models.HistoryServerDiagnosticResponseData +- azure.synapse.models.HistoryServerGraphResponse +- azure.synapse.models.HistoryServerGraphResponseData +- azure.synapse.models.HistoryServerPropertiesResponse +- azure.synapse.models.Jobs +- azure.synapse.models.LivyBatchStateInformation +- azure.synapse.models.LivyRequestBase +- azure.synapse.models.LivySessionStateInformation +- azure.synapse.models.LivyStatementCancellationResponse +- azure.synapse.models.LivyStatementOutput +- azure.synapse.models.LivyStatementRequestBody +- azure.synapse.models.LivyStatementResponseBody +- azure.synapse.models.LivyStatementsResponseBody +- azure.synapse.models.Option +- azure.synapse.models.SchedulerInformation +- azure.synapse.models.SetWorkspaceAdministratorsRequest +- azure.synapse.models.SparkJob +- azure.synapse.models.SparkJobListViewResponse +- azure.synapse.models.SparkServicePluginInformation +- azure.synapse.models.Stages +- azure.synapse.models.Tables +- azure.synapse.models.WorkspaceAccessControlResponse +enums: +- azure.synapse.models.ErrorSource +- azure.synapse.models.JobResult +- azure.synapse.models.JobType +- azure.synapse.models.PluginCurrentState +- azure.synapse.models.SchedulerCurrentState diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.operations.MonitoringOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.operations.MonitoringOperations.yml new file mode 100644 index 00000000..6e653e5d --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.operations.MonitoringOperations.yml @@ -0,0 +1,244 @@ +### YamlMime:PythonClass +uid: azure.synapse.operations.MonitoringOperations +name: MonitoringOperations +fullName: azure.synapse.operations.MonitoringOperations +module: azure.synapse.operations +summary: 'MonitoringOperations operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: MonitoringOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.operations.MonitoringOperations.get_application_details + name: get_application_details + summary: Get one spark application details given the workspace name, pool name and + livyid. + signature: 'get_application_details(workspace_name: str, pool_name: str, livy_id: + str, **kwargs: Any) -> SparkJobListViewResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: pool_name + description: The spark pool name. + isRequired: true + types: + - + - name: livy_id + description: The livy id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkJobListViewResponse or or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.operations.MonitoringOperations.get_history_server_data + name: get_history_server_data + summary: Get History Server Data for a given workspace, pool, livyid, appid and + attemptId. + signature: 'get_history_server_data(workspace_name: str, pool_name: str, livy_id: + str, app_id: str, attempt_id: str, **kwargs: Any) -> HistoryServerDataResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: pool_name + description: The spark pool name. + isRequired: true + types: + - + - name: livy_id + description: The livy id. + isRequired: true + types: + - + - name: app_id + description: The application id. + isRequired: true + types: + - + - name: attempt_id + description: The attempt id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: HistoryServerDataResponse or or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.operations.MonitoringOperations.get_history_server_diagnostic + name: get_history_server_diagnostic + summary: Get History Server Diagnostic Data for a given workspace, pool, livyid, + appid and attemptId. + signature: 'get_history_server_diagnostic(workspace_name: str, pool_name: str, livy_id: + str, app_id: str, attempt_id: str, **kwargs: Any) -> HistoryServerDiagnosticResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: pool_name + description: The spark pool name. + isRequired: true + types: + - + - name: livy_id + description: The livy id. + isRequired: true + types: + - + - name: app_id + description: The application id. + isRequired: true + types: + - + - name: attempt_id + description: The attempt id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: HistoryServerDiagnosticResponse or or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.operations.MonitoringOperations.get_history_server_graph + name: get_history_server_graph + summary: Get History Server Graph Data for a given workspace, pool, livyid, appid + and attemptId. + signature: 'get_history_server_graph(workspace_name: str, pool_name: str, livy_id: + str, app_id: str, attempt_id: str, **kwargs: Any) -> HistoryServerGraphResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: pool_name + description: The spark pool name. + isRequired: true + types: + - + - name: livy_id + description: The livy id. + isRequired: true + types: + - + - name: app_id + description: The application id. + isRequired: true + types: + - + - name: attempt_id + description: The attempt id. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: HistoryServerGraphResponse or or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.operations.MonitoringOperations.get_history_server_properties + name: get_history_server_properties + summary: Get History server properties. + signature: 'get_history_server_properties(workspace_name: str, **kwargs: Any) -> + HistoryServerPropertiesResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: HistoryServerPropertiesResponse or or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.operations.MonitoringOperations.get_spark_job_list + name: get_spark_job_list + summary: Get list of spark applications for the workspace. + signature: 'get_spark_job_list(workspace_name: str, **kwargs: Any) -> SparkJobListViewResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkJobListViewResponse or or the result of cls(response) + types: + - + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.operations.MonitoringOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.operations.SparkBatchOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.operations.SparkBatchOperations.yml new file mode 100644 index 00000000..e59934d7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.operations.SparkBatchOperations.yml @@ -0,0 +1,193 @@ +### YamlMime:PythonClass +uid: azure.synapse.operations.SparkBatchOperations +name: SparkBatchOperations +fullName: azure.synapse.operations.SparkBatchOperations +module: azure.synapse.operations +summary: 'SparkBatchOperations operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: SparkBatchOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.operations.SparkBatchOperations.create + name: create + summary: Create new spark batch job. + signature: 'create(workspace_name: str, spark_pool_name: str, livy_request: ExtendedLivyBatchRequest, + detailed: bool | None = None, **kwargs: Any) -> ExtendedLivyBatchResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: livy_request + description: Livy compatible batch job request payload. + isRequired: true + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ExtendedLivyBatchResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.operations.SparkBatchOperations.delete + name: delete + summary: Cancels a running spark batch job. + signature: 'delete(workspace_name: str, spark_pool_name: str, batch_id: int, **kwargs: + Any) -> None' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: batch_id + description: Identifier for the batch job. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.operations.SparkBatchOperations.get + name: get + summary: Gets a single spark batch job. + signature: 'get(workspace_name: str, spark_pool_name: str, batch_id: int, detailed: + bool | None = None, **kwargs: Any) -> ExtendedLivyBatchResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: batch_id + description: Identifier for the batch job. + isRequired: true + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ExtendedLivyBatchResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.operations.SparkBatchOperations.list + name: list + summary: List all spark batch jobs which are running under a particular spark pool. + signature: 'list(workspace_name: str, spark_pool_name: str, from_parameter: int + | None = None, size: int | None = None, detailed: bool | None = None, **kwargs: + Any) -> ExtendedLivyListBatchResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: from_parameter + description: Optional param specifying which index the list should begin from. + defaultValue: None + types: + - + - name: size + description: 'Optional param specifying the size of the returned list. + + By default it is 20 and that is the maximum.' + defaultValue: None + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ExtendedLivyListBatchResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.operations.SparkBatchOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.operations.SparkSessionOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.operations.SparkSessionOperations.yml new file mode 100644 index 00000000..523fc41a --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.operations.SparkSessionOperations.yml @@ -0,0 +1,368 @@ +### YamlMime:PythonClass +uid: azure.synapse.operations.SparkSessionOperations +name: SparkSessionOperations +fullName: azure.synapse.operations.SparkSessionOperations +module: azure.synapse.operations +summary: 'SparkSessionOperations operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: SparkSessionOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.operations.SparkSessionOperations.create + name: create + summary: Create new spark session. + signature: 'create(workspace_name: str, spark_pool_name: str, livy_request: ExtendedLivySessionRequest, + detailed: bool | None = None, **kwargs: Any) -> ExtendedLivySessionResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: livy_request + description: Livy compatible batch job request payload. + isRequired: true + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ExtendedLivySessionResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.operations.SparkSessionOperations.create_statement + name: create_statement + summary: Create statement within a spark session. + signature: 'create_statement(workspace_name: str, spark_pool_name: str, session_id: + int, livy_request: LivyStatementRequestBody, **kwargs: Any) -> LivyStatementResponseBody' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + - name: livy_request + description: Livy compatible batch job request payload. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LivyStatementResponseBody or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.operations.SparkSessionOperations.delete + name: delete + summary: Cancels a running spark session. + signature: 'delete(workspace_name: str, spark_pool_name: str, session_id: int, **kwargs: + Any) -> None' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.operations.SparkSessionOperations.delete_statement + name: delete_statement + summary: Kill a statement within a session. + signature: 'delete_statement(workspace_name: str, spark_pool_name: str, session_id: + int, statement_id: int, **kwargs: Any) -> LivyStatementCancellationResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + - name: statement_id + description: Identifier for the statement. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LivyStatementCancellationResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.operations.SparkSessionOperations.get + name: get + summary: Gets a single spark session. + signature: 'get(workspace_name: str, spark_pool_name: str, session_id: int, detailed: + bool | None = None, **kwargs: Any) -> ExtendedLivySessionResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ExtendedLivySessionResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.operations.SparkSessionOperations.get_statement + name: get_statement + summary: Gets a single statement within a spark session. + signature: 'get_statement(workspace_name: str, spark_pool_name: str, session_id: + int, statement_id: int, **kwargs: Any) -> LivyStatementResponseBody' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + - name: statement_id + description: Identifier for the statement. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LivyStatementResponseBody or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.operations.SparkSessionOperations.list + name: list + summary: List all spark sessions which are running under a particular spark pool. + signature: 'list(workspace_name: str, spark_pool_name: str, from_parameter: int + | None = None, size: int | None = None, detailed: bool | None = None, **kwargs: + Any) -> ExtendedLivyListSessionResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: from_parameter + description: Optional param specifying which index the list should begin from. + defaultValue: None + types: + - + - name: size + description: 'Optional param specifying the size of the returned list. + + By default it is 20 and that is the maximum.' + defaultValue: None + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: ExtendedLivyListSessionResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.operations.SparkSessionOperations.list_statements + name: list_statements + summary: Gets a list of statements within a spark session. + signature: 'list_statements(workspace_name: str, spark_pool_name: str, session_id: + int, **kwargs: Any) -> LivyStatementsResponseBody' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: LivyStatementsResponseBody or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.operations.SparkSessionOperations.reset_timeout + name: reset_timeout + summary: Sends a keep alive call to the current session to reset the session timeout. + signature: 'reset_timeout(workspace_name: str, spark_pool_name: str, session_id: + int, **kwargs: Any) -> None' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. "ondemand" targets the ondemand pool. + isRequired: true + types: + - + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.operations.SparkSessionOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.operations.WorkspaceAclOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.operations.WorkspaceAclOperations.yml new file mode 100644 index 00000000..fdb0b8ad --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.operations.WorkspaceAclOperations.yml @@ -0,0 +1,85 @@ +### YamlMime:PythonClass +uid: azure.synapse.operations.WorkspaceAclOperations +name: WorkspaceAclOperations +fullName: azure.synapse.operations.WorkspaceAclOperations +module: azure.synapse.operations +summary: 'WorkspaceAclOperations operations. + + + You should not instantiate directly this class, but create a Client instance that + will create it for you and attach it as attribute.' +constructor: + syntax: WorkspaceAclOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.operations.WorkspaceAclOperations.get_access_control_info + name: get_access_control_info + summary: Get access control info. + signature: 'get_access_control_info(workspace_name: str, artifact_name: str | None + = None, **kwargs: Any) -> WorkspaceAccessControlResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: artifact_name + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: WorkspaceAccessControlResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.operations.WorkspaceAclOperations.set_workspace_administrators + name: set_workspace_administrators + summary: Replace Admins of the Workspace. + signature: 'set_workspace_administrators(workspace_name: str, administrators: List[str] + | None = None, **kwargs: Any) -> WorkspaceAccessControlResponse' + parameters: + - name: workspace_name + description: The name of the workspace to execute operations on. + isRequired: true + types: + - + - name: administrators + defaultValue: None + types: + - [] + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: WorkspaceAccessControlResponse or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.operations.WorkspaceAclOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.operations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.operations.yml new file mode 100644 index 00000000..1c6e2b93 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.operations.yml @@ -0,0 +1,10 @@ +### YamlMime:PythonPackage +uid: azure.synapse.operations +name: operations +fullName: azure.synapse.operations +type: import +classes: +- azure.synapse.operations.MonitoringOperations +- azure.synapse.operations.SparkBatchOperations +- azure.synapse.operations.SparkSessionOperations +- azure.synapse.operations.WorkspaceAclOperations diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.SparkClient.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.SparkClient.yml new file mode 100644 index 00000000..cd51f6e6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.SparkClient.yml @@ -0,0 +1,49 @@ +### YamlMime:PythonClass +uid: azure.synapse.spark.SparkClient +name: SparkClient +fullName: azure.synapse.spark.SparkClient +module: azure.synapse.spark +summary: SparkClient. +constructor: + syntax: 'SparkClient(credential: ''TokenCredential'', endpoint: str, spark_pool_name: + str, livy_api_version: str = ''2019-11-01-preview'', **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: endpoint + description: The workspace development endpoint, for example [https://myworkspace.dev.azuresynapse.net](https://myworkspace.dev.azuresynapse.net). + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. + isRequired: true + types: + - + - name: livy_api_version + description: Valid api-version for the request. + defaultValue: 2019-11-01-preview + types: + - + keywordOnlyParameters: + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - +variables: +- description: SparkBatchOperations operations + name: spark_batch + types: + - +- description: SparkSessionOperations operations + name: spark_session + types: + - +methods: +- uid: azure.synapse.spark.SparkClient.close + name: close + signature: close() -> None diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.SparkClient.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.SparkClient.yml new file mode 100644 index 00000000..e2b70385 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.SparkClient.yml @@ -0,0 +1,49 @@ +### YamlMime:PythonClass +uid: azure.synapse.spark.aio.SparkClient +name: SparkClient +fullName: azure.synapse.spark.aio.SparkClient +module: azure.synapse.spark.aio +summary: SparkClient. +constructor: + syntax: 'SparkClient(credential: AsyncTokenCredential, endpoint: str, spark_pool_name: + str, livy_api_version: str = ''2019-11-01-preview'', **kwargs: Any)' + parameters: + - name: credential + description: Credential needed for the client to connect to Azure. + isRequired: true + types: + - + - name: endpoint + description: The workspace development endpoint, for example [https://myworkspace.dev.azuresynapse.net](https://myworkspace.dev.azuresynapse.net). + isRequired: true + types: + - + - name: spark_pool_name + description: Name of the spark pool. + isRequired: true + types: + - + - name: livy_api_version + description: Valid api-version for the request. + defaultValue: 2019-11-01-preview + types: + - + keywordOnlyParameters: + - name: polling_interval + description: Default waiting time between two polls for LRO operations if no Retry-After + header is present. + types: + - +variables: +- description: SparkBatchOperations operations + name: spark_batch + types: + - +- description: SparkSessionOperations operations + name: spark_session + types: + - +methods: +- uid: azure.synapse.spark.aio.SparkClient.close + name: close + signature: async close() -> None diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.operations_async.SparkBatchOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.operations_async.SparkBatchOperations.yml new file mode 100644 index 00000000..febbf54d --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.operations_async.SparkBatchOperations.yml @@ -0,0 +1,153 @@ +### YamlMime:PythonClass +uid: azure.synapse.spark.aio.operations_async.SparkBatchOperations +name: SparkBatchOperations +fullName: azure.synapse.spark.aio.operations_async.SparkBatchOperations +module: azure.synapse.spark.aio.operations_async +summary: 'SparkBatchOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: SparkBatchOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.spark.aio.operations_async.SparkBatchOperations.cancel_spark_batch_job + name: cancel_spark_batch_job + summary: Cancels a running spark batch job. + signature: 'async cancel_spark_batch_job(batch_id: int, **kwargs) -> None' + parameters: + - name: batch_id + description: Identifier for the batch job. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.spark.aio.operations_async.SparkBatchOperations.create_spark_batch_job + name: create_spark_batch_job + summary: Create new spark batch job. + signature: 'async create_spark_batch_job(spark_batch_job_options: SparkBatchJobOptions, + detailed: bool | None = None, **kwargs) -> SparkBatchJob' + parameters: + - name: spark_batch_job_options + description: Livy compatible batch job request payload. + isRequired: true + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkBatchJob, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.spark.aio.operations_async.SparkBatchOperations.get_spark_batch_job + name: get_spark_batch_job + summary: Gets a single spark batch job. + signature: 'async get_spark_batch_job(batch_id: int, detailed: bool | None = None, + **kwargs) -> SparkBatchJob' + parameters: + - name: batch_id + description: Identifier for the batch job. + isRequired: true + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkBatchJob, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.spark.aio.operations_async.SparkBatchOperations.get_spark_batch_jobs + name: get_spark_batch_jobs + summary: List all spark batch jobs which are running under a particular spark pool. + signature: 'async get_spark_batch_jobs(from_parameter: int | None = None, size: + int | None = None, detailed: bool | None = None, **kwargs) -> SparkBatchJobCollection' + parameters: + - name: from_parameter + description: Optional param specifying which index the list should begin from. + defaultValue: None + types: + - + - name: size + description: 'Optional param specifying the size of the returned list. + + By default it is 20 and that is the maximum.' + defaultValue: None + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkBatchJobCollection, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.spark.aio.operations_async.SparkBatchOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.operations_async.SparkSessionOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.operations_async.SparkSessionOperations.yml new file mode 100644 index 00000000..ab09e1f1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.operations_async.SparkSessionOperations.yml @@ -0,0 +1,276 @@ +### YamlMime:PythonClass +uid: azure.synapse.spark.aio.operations_async.SparkSessionOperations +name: SparkSessionOperations +fullName: azure.synapse.spark.aio.operations_async.SparkSessionOperations +module: azure.synapse.spark.aio.operations_async +summary: 'SparkSessionOperations async operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: SparkSessionOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.spark.aio.operations_async.SparkSessionOperations.cancel_spark_session + name: cancel_spark_session + summary: Cancels a running spark session. + signature: 'async cancel_spark_session(session_id: int, **kwargs) -> None' + parameters: + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.spark.aio.operations_async.SparkSessionOperations.cancel_spark_statement + name: cancel_spark_statement + summary: Kill a statement within a session. + signature: 'async cancel_spark_statement(session_id: int, statement_id: int, **kwargs) + -> SparkStatementCancellationResult' + parameters: + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + - name: statement_id + description: Identifier for the statement. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkStatementCancellationResult, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.spark.aio.operations_async.SparkSessionOperations.create_spark_session + name: create_spark_session + summary: Create new spark session. + signature: 'async create_spark_session(spark_session_options: SparkSessionOptions, + detailed: bool | None = None, **kwargs) -> SparkSession' + parameters: + - name: spark_session_options + description: Livy compatible batch job request payload. + isRequired: true + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkSession, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.spark.aio.operations_async.SparkSessionOperations.create_spark_statement + name: create_spark_statement + summary: Create statement within a spark session. + signature: 'async create_spark_statement(session_id: int, spark_statement_options: + SparkStatementOptions, **kwargs) -> SparkStatement' + parameters: + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + - name: spark_statement_options + description: Livy compatible batch job request payload. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkStatement, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.spark.aio.operations_async.SparkSessionOperations.get_spark_session + name: get_spark_session + summary: Gets a single spark session. + signature: 'async get_spark_session(session_id: int, detailed: bool | None = None, + **kwargs) -> SparkSession' + parameters: + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkSession, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.spark.aio.operations_async.SparkSessionOperations.get_spark_sessions + name: get_spark_sessions + summary: List all spark sessions which are running under a particular spark pool. + signature: 'async get_spark_sessions(from_parameter: int | None = None, size: int + | None = None, detailed: bool | None = None, **kwargs) -> SparkSessionCollection' + parameters: + - name: from_parameter + description: Optional param specifying which index the list should begin from. + defaultValue: None + types: + - + - name: size + description: 'Optional param specifying the size of the returned list. + + By default it is 20 and that is the maximum.' + defaultValue: None + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkSessionCollection, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.spark.aio.operations_async.SparkSessionOperations.get_spark_statement + name: get_spark_statement + summary: Gets a single statement within a spark session. + signature: 'async get_spark_statement(session_id: int, statement_id: int, **kwargs) + -> SparkStatement' + parameters: + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + - name: statement_id + description: Identifier for the statement. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkStatement, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.spark.aio.operations_async.SparkSessionOperations.get_spark_statements + name: get_spark_statements + summary: Gets a list of statements within a spark session. + signature: 'async get_spark_statements(session_id: int, **kwargs) -> SparkStatementCollection' + parameters: + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkStatementCollection, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.spark.aio.operations_async.SparkSessionOperations.reset_spark_session_timeout + name: reset_spark_session_timeout + summary: Sends a keep alive call to the current session to reset the session timeout. + signature: 'async reset_spark_session_timeout(session_id: int, **kwargs) -> None' + parameters: + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.spark.aio.operations_async.SparkSessionOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.operations_async.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.operations_async.yml new file mode 100644 index 00000000..95278624 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.operations_async.yml @@ -0,0 +1,8 @@ +### YamlMime:PythonPackage +uid: azure.synapse.spark.aio.operations_async +name: operations_async +fullName: azure.synapse.spark.aio.operations_async +type: import +classes: +- azure.synapse.spark.aio.operations_async.SparkBatchOperations +- azure.synapse.spark.aio.operations_async.SparkSessionOperations diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.yml new file mode 100644 index 00000000..42af040f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.aio.yml @@ -0,0 +1,9 @@ +### YamlMime:PythonPackage +uid: azure.synapse.spark.aio +name: aio +fullName: azure.synapse.spark.aio +type: import +classes: +- azure.synapse.spark.aio.SparkClient +packages: +- azure.synapse.spark.aio.operations_async diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.PluginCurrentState.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.PluginCurrentState.yml new file mode 100644 index 00000000..e578b84f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.PluginCurrentState.yml @@ -0,0 +1,20 @@ +### YamlMime:PythonEnum +uid: azure.synapse.spark.models.PluginCurrentState +name: PluginCurrentState +fullName: azure.synapse.spark.models.PluginCurrentState +module: azure.synapse.spark.models +fields: +- name: cleanup + uid: azure.synapse.spark.models.PluginCurrentState.cleanup +- name: ended + uid: azure.synapse.spark.models.PluginCurrentState.ended +- name: monitoring + uid: azure.synapse.spark.models.PluginCurrentState.monitoring +- name: preparation + uid: azure.synapse.spark.models.PluginCurrentState.preparation +- name: queued + uid: azure.synapse.spark.models.PluginCurrentState.queued +- name: resource_acquisition + uid: azure.synapse.spark.models.PluginCurrentState.resource_acquisition +- name: submission + uid: azure.synapse.spark.models.PluginCurrentState.submission diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SchedulerCurrentState.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SchedulerCurrentState.yml new file mode 100644 index 00000000..69071835 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SchedulerCurrentState.yml @@ -0,0 +1,12 @@ +### YamlMime:PythonEnum +uid: azure.synapse.spark.models.SchedulerCurrentState +name: SchedulerCurrentState +fullName: azure.synapse.spark.models.SchedulerCurrentState +module: azure.synapse.spark.models +fields: +- name: ended + uid: azure.synapse.spark.models.SchedulerCurrentState.ended +- name: queued + uid: azure.synapse.spark.models.SchedulerCurrentState.queued +- name: scheduled + uid: azure.synapse.spark.models.SchedulerCurrentState.scheduled diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJob.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJob.yml new file mode 100644 index 00000000..4e7da4b7 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJob.yml @@ -0,0 +1,257 @@ +### YamlMime:PythonClass +uid: azure.synapse.spark.models.SparkBatchJob +name: SparkBatchJob +fullName: azure.synapse.spark.models.SparkBatchJob +module: azure.synapse.spark.models +summary: 'SparkBatchJob. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SparkBatchJob(*, id: int, livy_info: SparkBatchJobState | None = None, + name: str | None = None, workspace_name: str | None = None, spark_pool_name: str + | None = None, submitter_name: str | None = None, submitter_id: str | None = None, + artifact_id: str | None = None, job_type: str | SparkJobType | None = None, result: + str | SparkBatchJobResultType | None = None, scheduler: SparkScheduler | None + = None, plugin: SparkServicePlugin | None = None, errors: List[SparkServiceError] + | None = None, tags: Dict[str, str] | None = None, app_id: str | None = None, + app_info: Dict[str, str] | None = None, state: str | None = None, log_lines: List[str] + | None = None, **kwargs)' + parameters: + - name: livy_info + isRequired: true + types: + - + - name: name + description: The batch name. + isRequired: true + types: + - + - name: workspace_name + description: The workspace name. + isRequired: true + types: + - + - name: spark_pool_name + description: The Spark pool name. + isRequired: true + types: + - + - name: submitter_name + description: The submitter name. + isRequired: true + types: + - + - name: submitter_id + description: The submitter identifier. + isRequired: true + types: + - + - name: artifact_id + description: The artifact identifier. + isRequired: true + types: + - + - name: job_type + description: 'The job type. Possible values include: "SparkBatch", "SparkSession".' + isRequired: true + types: + - + - + - name: result + description: 'The Spark batch job result. Possible values include: "Uncertain", + "Succeeded", + + "Failed", "Cancelled".' + isRequired: true + types: + - + - + - name: scheduler + description: The scheduler information. + isRequired: true + types: + - + - name: plugin + description: The plugin information. + isRequired: true + types: + - + - name: errors + description: The error information. + isRequired: true + types: + - [] + - name: tags + description: A set of tags. The tags. + isRequired: true + types: + - [, ] + - name: id + description: Required. The session Id. + isRequired: true + types: + - + - name: app_id + description: The application id of this session. + isRequired: true + types: + - + - name: app_info + description: The detailed application info. + isRequired: true + types: + - [, ] + - name: state + description: The batch state. + isRequired: true + types: + - + - name: log_lines + description: The log lines. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: livy_info + isRequired: true + - name: name + isRequired: true + - name: workspace_name + isRequired: true + - name: spark_pool_name + isRequired: true + - name: submitter_name + isRequired: true + - name: submitter_id + isRequired: true + - name: artifact_id + isRequired: true + - name: job_type + isRequired: true + - name: result + isRequired: true + - name: scheduler + isRequired: true + - name: plugin + isRequired: true + - name: errors + isRequired: true + - name: tags + isRequired: true + - name: app_id + isRequired: true + - name: app_info + isRequired: true + - name: state + isRequired: true + - name: log_lines + isRequired: true +methods: +- uid: azure.synapse.spark.models.SparkBatchJob.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkBatchJob.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkBatchJob.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.spark.models.SparkBatchJob.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkBatchJob.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.spark.models.SparkBatchJob.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkBatchJob.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobCollection.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobCollection.yml new file mode 100644 index 00000000..0aa9cded --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobCollection.yml @@ -0,0 +1,141 @@ +### YamlMime:PythonClass +uid: azure.synapse.spark.models.SparkBatchJobCollection +name: SparkBatchJobCollection +fullName: azure.synapse.spark.models.SparkBatchJobCollection +module: azure.synapse.spark.models +summary: 'Response for batch list operation. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SparkBatchJobCollection(*, from_property: int, total: int, sessions: List[SparkBatchJob] + | None = None, **kwargs)' + parameters: + - name: from_property + description: Required. The start index of fetched sessions. + isRequired: true + types: + - + - name: total + description: Required. Number of sessions fetched. + isRequired: true + types: + - + - name: sessions + description: Batch list. + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: from_property + isRequired: true + - name: total + isRequired: true + - name: sessions + isRequired: true +methods: +- uid: azure.synapse.spark.models.SparkBatchJobCollection.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkBatchJobCollection.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkBatchJobCollection.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.spark.models.SparkBatchJobCollection.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkBatchJobCollection.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.spark.models.SparkBatchJobCollection.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkBatchJobCollection.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobOptions.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobOptions.yml new file mode 100644 index 00000000..2460be24 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobOptions.yml @@ -0,0 +1,225 @@ +### YamlMime:PythonClass +uid: azure.synapse.spark.models.SparkBatchJobOptions +name: SparkBatchJobOptions +fullName: azure.synapse.spark.models.SparkBatchJobOptions +module: azure.synapse.spark.models +summary: 'SparkBatchJobOptions. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SparkBatchJobOptions(*, name: str, file: str, tags: Dict[str, str] | None + = None, artifact_id: str | None = None, class_name: str | None = None, arguments: + List[str] | None = None, jars: List[str] | None = None, python_files: List[str] + | None = None, files: List[str] | None = None, archives: List[str] | None = None, + configuration: Dict[str, str] | None = None, driver_memory: str | None = None, + driver_cores: int | None = None, executor_memory: str | None = None, executor_cores: + int | None = None, executor_count: int | None = None, **kwargs)' + parameters: + - name: tags + description: A set of tags. Dictionary of ``. + isRequired: true + types: + - [, ] + - name: artifact_id + isRequired: true + types: + - + - name: name + description: Required. + isRequired: true + types: + - + - name: file + description: Required. + isRequired: true + types: + - + - name: class_name + isRequired: true + types: + - + - name: arguments + isRequired: true + types: + - [] + - name: jars + isRequired: true + types: + - [] + - name: python_files + isRequired: true + types: + - [] + - name: files + isRequired: true + types: + - [] + - name: archives + isRequired: true + types: + - [] + - name: configuration + description: Dictionary of ``. + isRequired: true + types: + - [, ] + - name: driver_memory + isRequired: true + types: + - + - name: driver_cores + isRequired: true + types: + - + - name: executor_memory + isRequired: true + types: + - + - name: executor_cores + isRequired: true + types: + - + - name: executor_count + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: file + isRequired: true + - name: tags + isRequired: true + - name: artifact_id + isRequired: true + - name: class_name + isRequired: true + - name: arguments + isRequired: true + - name: jars + isRequired: true + - name: python_files + isRequired: true + - name: files + isRequired: true + - name: archives + isRequired: true + - name: configuration + isRequired: true + - name: driver_memory + isRequired: true + - name: driver_cores + isRequired: true + - name: executor_memory + isRequired: true + - name: executor_cores + isRequired: true + - name: executor_count + isRequired: true +methods: +- uid: azure.synapse.spark.models.SparkBatchJobOptions.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkBatchJobOptions.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkBatchJobOptions.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.spark.models.SparkBatchJobOptions.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkBatchJobOptions.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.spark.models.SparkBatchJobOptions.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkBatchJobOptions.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobResultType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobResultType.yml new file mode 100644 index 00000000..df2e27f6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobResultType.yml @@ -0,0 +1,15 @@ +### YamlMime:PythonEnum +uid: azure.synapse.spark.models.SparkBatchJobResultType +name: SparkBatchJobResultType +fullName: azure.synapse.spark.models.SparkBatchJobResultType +summary: The Spark batch job result. +module: azure.synapse.spark.models +fields: +- name: cancelled + uid: azure.synapse.spark.models.SparkBatchJobResultType.cancelled +- name: failed + uid: azure.synapse.spark.models.SparkBatchJobResultType.failed +- name: succeeded + uid: azure.synapse.spark.models.SparkBatchJobResultType.succeeded +- name: uncertain + uid: azure.synapse.spark.models.SparkBatchJobResultType.uncertain diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobState.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobState.yml new file mode 100644 index 00000000..3ab8b8e1 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobState.yml @@ -0,0 +1,182 @@ +### YamlMime:PythonClass +uid: azure.synapse.spark.models.SparkBatchJobState +name: SparkBatchJobState +fullName: azure.synapse.spark.models.SparkBatchJobState +module: azure.synapse.spark.models +summary: SparkBatchJobState. +constructor: + syntax: 'SparkBatchJobState(*, not_started_at: datetime | None = None, starting_at: + datetime | None = None, running_at: datetime | None = None, dead_at: datetime + | None = None, success_at: datetime | None = None, terminated_at: datetime | None + = None, recovering_at: datetime | None = None, current_state: str | None = None, + job_creation_request: SparkRequest | None = None, **kwargs)' + parameters: + - name: not_started_at + description: the time that at which "not_started" livy state was first seen. + isRequired: true + types: + - + - name: starting_at + description: the time that at which "starting" livy state was first seen. + isRequired: true + types: + - + - name: running_at + description: the time that at which "running" livy state was first seen. + isRequired: true + types: + - + - name: dead_at + description: time that at which "dead" livy state was first seen. + isRequired: true + types: + - + - name: success_at + description: the time that at which "success" livy state was first seen. + isRequired: true + types: + - + - name: terminated_at + description: the time that at which "killed" livy state was first seen. + isRequired: true + types: + - + - name: recovering_at + description: the time that at which "recovering" livy state was first seen. + isRequired: true + types: + - + - name: current_state + description: the Spark job state. + isRequired: true + types: + - + - name: job_creation_request + isRequired: true + types: + - + keywordOnlyParameters: + - name: not_started_at + isRequired: true + - name: starting_at + isRequired: true + - name: running_at + isRequired: true + - name: dead_at + isRequired: true + - name: success_at + isRequired: true + - name: terminated_at + isRequired: true + - name: recovering_at + isRequired: true + - name: current_state + isRequired: true + - name: job_creation_request + isRequired: true +methods: +- uid: azure.synapse.spark.models.SparkBatchJobState.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkBatchJobState.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkBatchJobState.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.spark.models.SparkBatchJobState.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkBatchJobState.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.spark.models.SparkBatchJobState.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkBatchJobState.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkErrorSource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkErrorSource.yml new file mode 100644 index 00000000..862009b3 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkErrorSource.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.synapse.spark.models.SparkErrorSource +name: SparkErrorSource +fullName: azure.synapse.spark.models.SparkErrorSource +module: azure.synapse.spark.models +fields: +- name: dependency + uid: azure.synapse.spark.models.SparkErrorSource.dependency +- name: system + uid: azure.synapse.spark.models.SparkErrorSource.system +- name: unknown + uid: azure.synapse.spark.models.SparkErrorSource.unknown +- name: user + uid: azure.synapse.spark.models.SparkErrorSource.user diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkJobType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkJobType.yml new file mode 100644 index 00000000..d5763efc --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkJobType.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonEnum +uid: azure.synapse.spark.models.SparkJobType +name: SparkJobType +fullName: azure.synapse.spark.models.SparkJobType +summary: The job type. +module: azure.synapse.spark.models +fields: +- name: spark_batch + uid: azure.synapse.spark.models.SparkJobType.spark_batch +- name: spark_session + uid: azure.synapse.spark.models.SparkJobType.spark_session diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkRequest.yml new file mode 100644 index 00000000..05f26e01 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkRequest.yml @@ -0,0 +1,207 @@ +### YamlMime:PythonClass +uid: azure.synapse.spark.models.SparkRequest +name: SparkRequest +fullName: azure.synapse.spark.models.SparkRequest +module: azure.synapse.spark.models +summary: SparkRequest. +constructor: + syntax: 'SparkRequest(*, name: str | None = None, file: str | None = None, class_name: + str | None = None, arguments: List[str] | None = None, jars: List[str] | None + = None, python_files: List[str] | None = None, files: List[str] | None = None, + archives: List[str] | None = None, configuration: Dict[str, str] | None = None, + driver_memory: str | None = None, driver_cores: int | None = None, executor_memory: + str | None = None, executor_cores: int | None = None, executor_count: int | None + = None, **kwargs)' + parameters: + - name: name + isRequired: true + types: + - + - name: file + isRequired: true + types: + - + - name: class_name + isRequired: true + types: + - + - name: arguments + isRequired: true + types: + - [] + - name: jars + isRequired: true + types: + - [] + - name: python_files + isRequired: true + types: + - [] + - name: files + isRequired: true + types: + - [] + - name: archives + isRequired: true + types: + - [] + - name: configuration + description: Dictionary of ``. + isRequired: true + types: + - [, ] + - name: driver_memory + isRequired: true + types: + - + - name: driver_cores + isRequired: true + types: + - + - name: executor_memory + isRequired: true + types: + - + - name: executor_cores + isRequired: true + types: + - + - name: executor_count + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: file + isRequired: true + - name: class_name + isRequired: true + - name: arguments + isRequired: true + - name: jars + isRequired: true + - name: python_files + isRequired: true + - name: files + isRequired: true + - name: archives + isRequired: true + - name: configuration + isRequired: true + - name: driver_memory + isRequired: true + - name: driver_cores + isRequired: true + - name: executor_memory + isRequired: true + - name: executor_cores + isRequired: true + - name: executor_count + isRequired: true +methods: +- uid: azure.synapse.spark.models.SparkRequest.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkRequest.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkRequest.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.spark.models.SparkRequest.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkRequest.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.spark.models.SparkRequest.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkRequest.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkScheduler.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkScheduler.yml new file mode 100644 index 00000000..2d44df4f --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkScheduler.yml @@ -0,0 +1,150 @@ +### YamlMime:PythonClass +uid: azure.synapse.spark.models.SparkScheduler +name: SparkScheduler +fullName: azure.synapse.spark.models.SparkScheduler +module: azure.synapse.spark.models +summary: SparkScheduler. +constructor: + syntax: 'SparkScheduler(*, submitted_at: datetime | None = None, scheduled_at: datetime + | None = None, ended_at: datetime | None = None, cancellation_requested_at: datetime + | None = None, current_state: str | SchedulerCurrentState | None = None, **kwargs)' + parameters: + - name: submitted_at + isRequired: true + types: + - + - name: scheduled_at + isRequired: true + types: + - + - name: ended_at + isRequired: true + types: + - + - name: cancellation_requested_at + isRequired: true + types: + - + - name: current_state + description: 'Possible values include: "Queued", "Scheduled", "Ended".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: submitted_at + isRequired: true + - name: scheduled_at + isRequired: true + - name: ended_at + isRequired: true + - name: cancellation_requested_at + isRequired: true + - name: current_state + isRequired: true +methods: +- uid: azure.synapse.spark.models.SparkScheduler.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkScheduler.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkScheduler.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.spark.models.SparkScheduler.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkScheduler.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.spark.models.SparkScheduler.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkScheduler.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkServiceError.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkServiceError.yml new file mode 100644 index 00000000..4ec4d151 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkServiceError.yml @@ -0,0 +1,137 @@ +### YamlMime:PythonClass +uid: azure.synapse.spark.models.SparkServiceError +name: SparkServiceError +fullName: azure.synapse.spark.models.SparkServiceError +module: azure.synapse.spark.models +summary: SparkServiceError. +constructor: + syntax: 'SparkServiceError(*, message: str | None = None, error_code: str | None + = None, source: str | SparkErrorSource | None = None, **kwargs)' + parameters: + - name: message + isRequired: true + types: + - + - name: error_code + isRequired: true + types: + - + - name: source + description: 'Possible values include: "System", "User", "Unknown", "Dependency".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: message + isRequired: true + - name: error_code + isRequired: true + - name: source + isRequired: true +methods: +- uid: azure.synapse.spark.models.SparkServiceError.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkServiceError.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkServiceError.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.spark.models.SparkServiceError.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkServiceError.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.spark.models.SparkServiceError.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkServiceError.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkServicePlugin.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkServicePlugin.yml new file mode 100644 index 00000000..3d1c5287 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkServicePlugin.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.synapse.spark.models.SparkServicePlugin +name: SparkServicePlugin +fullName: azure.synapse.spark.models.SparkServicePlugin +module: azure.synapse.spark.models +summary: SparkServicePlugin. +constructor: + syntax: 'SparkServicePlugin(*, preparation_started_at: datetime | None = None, resource_acquisition_started_at: + datetime | None = None, submission_started_at: datetime | None = None, monitoring_started_at: + datetime | None = None, cleanup_started_at: datetime | None = None, current_state: + str | PluginCurrentState | None = None, **kwargs)' + parameters: + - name: preparation_started_at + isRequired: true + types: + - + - name: resource_acquisition_started_at + isRequired: true + types: + - + - name: submission_started_at + isRequired: true + types: + - + - name: monitoring_started_at + isRequired: true + types: + - + - name: cleanup_started_at + isRequired: true + types: + - + - name: current_state + description: 'Possible values include: "Preparation", "ResourceAcquisition", "Queued", + + "Submission", "Monitoring", "Cleanup", "Ended".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: preparation_started_at + isRequired: true + - name: resource_acquisition_started_at + isRequired: true + - name: submission_started_at + isRequired: true + - name: monitoring_started_at + isRequired: true + - name: cleanup_started_at + isRequired: true + - name: current_state + isRequired: true +methods: +- uid: azure.synapse.spark.models.SparkServicePlugin.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkServicePlugin.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkServicePlugin.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.spark.models.SparkServicePlugin.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkServicePlugin.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.spark.models.SparkServicePlugin.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkServicePlugin.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSession.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSession.yml new file mode 100644 index 00000000..21b7f2a0 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSession.yml @@ -0,0 +1,241 @@ +### YamlMime:PythonClass +uid: azure.synapse.spark.models.SparkSession +name: SparkSession +fullName: azure.synapse.spark.models.SparkSession +module: azure.synapse.spark.models +summary: 'SparkSession. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SparkSession(*, id: int, livy_info: SparkSessionState | None = None, name: + str | None = None, workspace_name: str | None = None, spark_pool_name: str | None + = None, submitter_name: str | None = None, submitter_id: str | None = None, artifact_id: + str | None = None, job_type: str | SparkJobType | None = None, result: str | SparkSessionResultType + | None = None, scheduler: SparkScheduler | None = None, plugin: SparkServicePlugin + | None = None, errors: List[SparkServiceError] | None = None, tags: Dict[str, + str] | None = None, app_id: str | None = None, app_info: Dict[str, str] | None + = None, state: str | None = None, log_lines: List[str] | None = None, **kwargs)' + parameters: + - name: livy_info + isRequired: true + types: + - + - name: name + isRequired: true + types: + - + - name: workspace_name + isRequired: true + types: + - + - name: spark_pool_name + isRequired: true + types: + - + - name: submitter_name + isRequired: true + types: + - + - name: submitter_id + isRequired: true + types: + - + - name: artifact_id + isRequired: true + types: + - + - name: job_type + description: 'The job type. Possible values include: "SparkBatch", "SparkSession".' + isRequired: true + types: + - + - + - name: result + description: 'Possible values include: "Uncertain", "Succeeded", "Failed", "Cancelled".' + isRequired: true + types: + - + - + - name: scheduler + isRequired: true + types: + - + - name: plugin + isRequired: true + types: + - + - name: errors + isRequired: true + types: + - [] + - name: tags + description: A set of tags. Dictionary of ``. + isRequired: true + types: + - [, ] + - name: id + description: Required. + isRequired: true + types: + - + - name: app_id + isRequired: true + types: + - + - name: app_info + description: Dictionary of ``. + isRequired: true + types: + - [, ] + - name: state + isRequired: true + types: + - + - name: log_lines + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: id + isRequired: true + - name: livy_info + isRequired: true + - name: name + isRequired: true + - name: workspace_name + isRequired: true + - name: spark_pool_name + isRequired: true + - name: submitter_name + isRequired: true + - name: submitter_id + isRequired: true + - name: artifact_id + isRequired: true + - name: job_type + isRequired: true + - name: result + isRequired: true + - name: scheduler + isRequired: true + - name: plugin + isRequired: true + - name: errors + isRequired: true + - name: tags + isRequired: true + - name: app_id + isRequired: true + - name: app_info + isRequired: true + - name: state + isRequired: true + - name: log_lines + isRequired: true +methods: +- uid: azure.synapse.spark.models.SparkSession.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkSession.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkSession.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.spark.models.SparkSession.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkSession.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.spark.models.SparkSession.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkSession.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionCollection.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionCollection.yml new file mode 100644 index 00000000..7ebec536 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionCollection.yml @@ -0,0 +1,140 @@ +### YamlMime:PythonClass +uid: azure.synapse.spark.models.SparkSessionCollection +name: SparkSessionCollection +fullName: azure.synapse.spark.models.SparkSessionCollection +module: azure.synapse.spark.models +summary: 'SparkSessionCollection. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SparkSessionCollection(*, from_property: int, total: int, sessions: List[SparkSession] + | None = None, **kwargs)' + parameters: + - name: from_property + description: Required. + isRequired: true + types: + - + - name: total + description: Required. + isRequired: true + types: + - + - name: sessions + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: from_property + isRequired: true + - name: total + isRequired: true + - name: sessions + isRequired: true +methods: +- uid: azure.synapse.spark.models.SparkSessionCollection.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkSessionCollection.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkSessionCollection.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.spark.models.SparkSessionCollection.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkSessionCollection.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.spark.models.SparkSessionCollection.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkSessionCollection.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionOptions.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionOptions.yml new file mode 100644 index 00000000..17f399e5 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionOptions.yml @@ -0,0 +1,224 @@ +### YamlMime:PythonClass +uid: azure.synapse.spark.models.SparkSessionOptions +name: SparkSessionOptions +fullName: azure.synapse.spark.models.SparkSessionOptions +module: azure.synapse.spark.models +summary: 'SparkSessionOptions. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SparkSessionOptions(*, name: str, tags: Dict[str, str] | None = None, artifact_id: + str | None = None, file: str | None = None, class_name: str | None = None, arguments: + List[str] | None = None, jars: List[str] | None = None, python_files: List[str] + | None = None, files: List[str] | None = None, archives: List[str] | None = None, + configuration: Dict[str, str] | None = None, driver_memory: str | None = None, + driver_cores: int | None = None, executor_memory: str | None = None, executor_cores: + int | None = None, executor_count: int | None = None, **kwargs)' + parameters: + - name: tags + description: A set of tags. Dictionary of ``. + isRequired: true + types: + - [, ] + - name: artifact_id + isRequired: true + types: + - + - name: name + description: Required. + isRequired: true + types: + - + - name: file + isRequired: true + types: + - + - name: class_name + isRequired: true + types: + - + - name: arguments + isRequired: true + types: + - [] + - name: jars + isRequired: true + types: + - [] + - name: python_files + isRequired: true + types: + - [] + - name: files + isRequired: true + types: + - [] + - name: archives + isRequired: true + types: + - [] + - name: configuration + description: Dictionary of ``. + isRequired: true + types: + - [, ] + - name: driver_memory + isRequired: true + types: + - + - name: driver_cores + isRequired: true + types: + - + - name: executor_memory + isRequired: true + types: + - + - name: executor_cores + isRequired: true + types: + - + - name: executor_count + isRequired: true + types: + - + keywordOnlyParameters: + - name: name + isRequired: true + - name: tags + isRequired: true + - name: artifact_id + isRequired: true + - name: file + isRequired: true + - name: class_name + isRequired: true + - name: arguments + isRequired: true + - name: jars + isRequired: true + - name: python_files + isRequired: true + - name: files + isRequired: true + - name: archives + isRequired: true + - name: configuration + isRequired: true + - name: driver_memory + isRequired: true + - name: driver_cores + isRequired: true + - name: executor_memory + isRequired: true + - name: executor_cores + isRequired: true + - name: executor_count + isRequired: true +methods: +- uid: azure.synapse.spark.models.SparkSessionOptions.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkSessionOptions.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkSessionOptions.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.spark.models.SparkSessionOptions.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkSessionOptions.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.spark.models.SparkSessionOptions.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkSessionOptions.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionResultType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionResultType.yml new file mode 100644 index 00000000..91f6b0cb --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionResultType.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.synapse.spark.models.SparkSessionResultType +name: SparkSessionResultType +fullName: azure.synapse.spark.models.SparkSessionResultType +module: azure.synapse.spark.models +fields: +- name: cancelled + uid: azure.synapse.spark.models.SparkSessionResultType.cancelled +- name: failed + uid: azure.synapse.spark.models.SparkSessionResultType.failed +- name: succeeded + uid: azure.synapse.spark.models.SparkSessionResultType.succeeded +- name: uncertain + uid: azure.synapse.spark.models.SparkSessionResultType.uncertain diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionState.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionState.yml new file mode 100644 index 00000000..a910cdb9 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionState.yml @@ -0,0 +1,187 @@ +### YamlMime:PythonClass +uid: azure.synapse.spark.models.SparkSessionState +name: SparkSessionState +fullName: azure.synapse.spark.models.SparkSessionState +module: azure.synapse.spark.models +summary: SparkSessionState. +constructor: + syntax: 'SparkSessionState(*, not_started_at: datetime | None = None, starting_at: + datetime | None = None, idle_at: datetime | None = None, dead_at: datetime | None + = None, shutting_down_at: datetime | None = None, terminated_at: datetime | None + = None, recovering_at: datetime | None = None, busy_at: datetime | None = None, + error_at: datetime | None = None, current_state: str | None = None, job_creation_request: + SparkRequest | None = None, **kwargs)' + parameters: + - name: not_started_at + isRequired: true + types: + - + - name: starting_at + isRequired: true + types: + - + - name: idle_at + isRequired: true + types: + - + - name: dead_at + isRequired: true + types: + - + - name: shutting_down_at + isRequired: true + types: + - + - name: terminated_at + isRequired: true + types: + - + - name: recovering_at + isRequired: true + types: + - + - name: busy_at + isRequired: true + types: + - + - name: error_at + isRequired: true + types: + - + - name: current_state + isRequired: true + types: + - + - name: job_creation_request + isRequired: true + types: + - + keywordOnlyParameters: + - name: not_started_at + isRequired: true + - name: starting_at + isRequired: true + - name: idle_at + isRequired: true + - name: dead_at + isRequired: true + - name: shutting_down_at + isRequired: true + - name: terminated_at + isRequired: true + - name: recovering_at + isRequired: true + - name: busy_at + isRequired: true + - name: error_at + isRequired: true + - name: current_state + isRequired: true + - name: job_creation_request + isRequired: true +methods: +- uid: azure.synapse.spark.models.SparkSessionState.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkSessionState.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkSessionState.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.spark.models.SparkSessionState.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkSessionState.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.spark.models.SparkSessionState.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkSessionState.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatement.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatement.yml new file mode 100644 index 00000000..56ee358b --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatement.yml @@ -0,0 +1,145 @@ +### YamlMime:PythonClass +uid: azure.synapse.spark.models.SparkStatement +name: SparkStatement +fullName: azure.synapse.spark.models.SparkStatement +module: azure.synapse.spark.models +summary: 'SparkStatement. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SparkStatement(*, id: int, code: str | None = None, state: str | None = + None, output: SparkStatementOutput | None = None, **kwargs)' + parameters: + - name: id + description: Required. + isRequired: true + types: + - + - name: code + isRequired: true + types: + - + - name: state + isRequired: true + types: + - + - name: output + isRequired: true + types: + - + keywordOnlyParameters: + - name: id + isRequired: true + - name: code + isRequired: true + - name: state + isRequired: true + - name: output + isRequired: true +methods: +- uid: azure.synapse.spark.models.SparkStatement.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkStatement.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkStatement.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.spark.models.SparkStatement.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkStatement.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.spark.models.SparkStatement.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkStatement.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementCancellationResult.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementCancellationResult.yml new file mode 100644 index 00000000..3aac6a84 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementCancellationResult.yml @@ -0,0 +1,122 @@ +### YamlMime:PythonClass +uid: azure.synapse.spark.models.SparkStatementCancellationResult +name: SparkStatementCancellationResult +fullName: azure.synapse.spark.models.SparkStatementCancellationResult +module: azure.synapse.spark.models +summary: SparkStatementCancellationResult. +constructor: + syntax: 'SparkStatementCancellationResult(*, msg: str | None = None, **kwargs)' + parameters: + - name: msg + isRequired: true + types: + - + keywordOnlyParameters: + - name: msg + isRequired: true +methods: +- uid: azure.synapse.spark.models.SparkStatementCancellationResult.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkStatementCancellationResult.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkStatementCancellationResult.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.spark.models.SparkStatementCancellationResult.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkStatementCancellationResult.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.spark.models.SparkStatementCancellationResult.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkStatementCancellationResult.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementCollection.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementCollection.yml new file mode 100644 index 00000000..a6b394fd --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementCollection.yml @@ -0,0 +1,133 @@ +### YamlMime:PythonClass +uid: azure.synapse.spark.models.SparkStatementCollection +name: SparkStatementCollection +fullName: azure.synapse.spark.models.SparkStatementCollection +module: azure.synapse.spark.models +summary: 'SparkStatementCollection. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SparkStatementCollection(*, total: int, statements: List[SparkStatement] + | None = None, **kwargs)' + parameters: + - name: total + description: Required. + isRequired: true + types: + - + - name: statements + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: total + isRequired: true + - name: statements + isRequired: true +methods: +- uid: azure.synapse.spark.models.SparkStatementCollection.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkStatementCollection.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkStatementCollection.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.spark.models.SparkStatementCollection.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkStatementCollection.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.spark.models.SparkStatementCollection.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkStatementCollection.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementLanguageType.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementLanguageType.yml new file mode 100644 index 00000000..3bc508f8 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementLanguageType.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonEnum +uid: azure.synapse.spark.models.SparkStatementLanguageType +name: SparkStatementLanguageType +fullName: azure.synapse.spark.models.SparkStatementLanguageType +module: azure.synapse.spark.models +fields: +- name: dotnetspark + uid: azure.synapse.spark.models.SparkStatementLanguageType.dotnetspark +- name: pyspark + uid: azure.synapse.spark.models.SparkStatementLanguageType.pyspark +- name: spark + uid: azure.synapse.spark.models.SparkStatementLanguageType.spark +- name: sql + uid: azure.synapse.spark.models.SparkStatementLanguageType.sql diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementOptions.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementOptions.yml new file mode 100644 index 00000000..68fc0d76 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementOptions.yml @@ -0,0 +1,131 @@ +### YamlMime:PythonClass +uid: azure.synapse.spark.models.SparkStatementOptions +name: SparkStatementOptions +fullName: azure.synapse.spark.models.SparkStatementOptions +module: azure.synapse.spark.models +summary: SparkStatementOptions. +constructor: + syntax: 'SparkStatementOptions(*, code: str | None = None, kind: str | SparkStatementLanguageType + | None = None, **kwargs)' + parameters: + - name: code + isRequired: true + types: + - + - name: kind + description: 'Possible values include: "spark", "pyspark", "dotnetspark", "sql".' + isRequired: true + types: + - + - + keywordOnlyParameters: + - name: code + isRequired: true + - name: kind + isRequired: true +methods: +- uid: azure.synapse.spark.models.SparkStatementOptions.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkStatementOptions.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkStatementOptions.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.spark.models.SparkStatementOptions.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkStatementOptions.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.spark.models.SparkStatementOptions.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkStatementOptions.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementOutput.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementOutput.yml new file mode 100644 index 00000000..12b733a6 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementOutput.yml @@ -0,0 +1,159 @@ +### YamlMime:PythonClass +uid: azure.synapse.spark.models.SparkStatementOutput +name: SparkStatementOutput +fullName: azure.synapse.spark.models.SparkStatementOutput +module: azure.synapse.spark.models +summary: 'SparkStatementOutput. + + + All required parameters must be populated in order to send to Azure.' +constructor: + syntax: 'SparkStatementOutput(*, execution_count: int, status: str | None = None, + data: object | None = None, error_name: str | None = None, error_value: str | + None = None, traceback: List[str] | None = None, **kwargs)' + parameters: + - name: status + isRequired: true + types: + - + - name: execution_count + description: Required. + isRequired: true + types: + - + - name: data + description: Any object. + isRequired: true + types: + - + - name: error_name + isRequired: true + types: + - + - name: error_value + isRequired: true + types: + - + - name: traceback + isRequired: true + types: + - [] + keywordOnlyParameters: + - name: execution_count + isRequired: true + - name: status + isRequired: true + - name: data + isRequired: true + - name: error_name + isRequired: true + - name: error_value + isRequired: true + - name: traceback + isRequired: true +methods: +- uid: azure.synapse.spark.models.SparkStatementOutput.as_dict + name: as_dict + summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\ + \ optionally use a callback as parameter:\n\nKey is the attribute name used in\ + \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\ + msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\ + \ in this object.\n\nThe string returned will be used to serialize the key.\n\ + If the return type is a list, this is considered hierarchical\nresult dict.\n\n\ + See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\ + \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\ + \ pass the kwargs is_xml=True." + signature: as_dict(keep_readonly=True, key_transformer=, + **kwargs) + parameters: + - name: key_transformer + description: A key transformer function. + types: + - + - name: keep_readonly + defaultValue: 'True' + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkStatementOutput.deserialize + name: deserialize + summary: Parse a str using the RestAPI syntax and return a model. + signature: deserialize(data, content_type=None) + parameters: + - name: data + description: A str using RestAPI structure. JSON by default. + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkStatementOutput.enable_additional_properties_sending + name: enable_additional_properties_sending + signature: enable_additional_properties_sending() +- uid: azure.synapse.spark.models.SparkStatementOutput.from_dict + name: from_dict + summary: 'Parse a dict using given key extractor return a model. + + + By default consider key + + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + + and last_rest_key_case_insensitive_extractor)' + signature: from_dict(data, key_extractors=None, content_type=None) + parameters: + - name: data + description: A dict using RestAPI structure + isRequired: true + types: + - + - name: content_type + description: JSON by default, set application/xml if XML. + defaultValue: None + types: + - + - name: key_extractors + defaultValue: None + return: + description: An instance of this model + exceptions: + - type: DeserializationError if something went wrong +- uid: azure.synapse.spark.models.SparkStatementOutput.is_xml_model + name: is_xml_model + signature: is_xml_model() +- uid: azure.synapse.spark.models.SparkStatementOutput.serialize + name: serialize + summary: 'Return the JSON that would be sent to azure from this model. + + + This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*. + + + If you want XML serialization, you can pass the kwargs is_xml=True.' + signature: serialize(keep_readonly=False, **kwargs) + parameters: + - name: keep_readonly + description: If you want to serialize the readonly attributes + defaultValue: 'False' + types: + - + return: + description: A dict JSON compatible object + types: + - +- uid: azure.synapse.spark.models.SparkStatementOutput.validate + name: validate + summary: Validate this model recursively and return a list of ValidationError. + signature: validate() + return: + description: A list of validation error + types: + - diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.yml new file mode 100644 index 00000000..309fa81a --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.yml @@ -0,0 +1,31 @@ +### YamlMime:PythonPackage +uid: azure.synapse.spark.models +name: models +fullName: azure.synapse.spark.models +type: import +classes: +- azure.synapse.spark.models.SparkBatchJob +- azure.synapse.spark.models.SparkBatchJobCollection +- azure.synapse.spark.models.SparkBatchJobOptions +- azure.synapse.spark.models.SparkBatchJobState +- azure.synapse.spark.models.SparkRequest +- azure.synapse.spark.models.SparkScheduler +- azure.synapse.spark.models.SparkServiceError +- azure.synapse.spark.models.SparkServicePlugin +- azure.synapse.spark.models.SparkSession +- azure.synapse.spark.models.SparkSessionCollection +- azure.synapse.spark.models.SparkSessionOptions +- azure.synapse.spark.models.SparkSessionState +- azure.synapse.spark.models.SparkStatement +- azure.synapse.spark.models.SparkStatementCancellationResult +- azure.synapse.spark.models.SparkStatementCollection +- azure.synapse.spark.models.SparkStatementOptions +- azure.synapse.spark.models.SparkStatementOutput +enums: +- azure.synapse.spark.models.PluginCurrentState +- azure.synapse.spark.models.SchedulerCurrentState +- azure.synapse.spark.models.SparkBatchJobResultType +- azure.synapse.spark.models.SparkErrorSource +- azure.synapse.spark.models.SparkJobType +- azure.synapse.spark.models.SparkSessionResultType +- azure.synapse.spark.models.SparkStatementLanguageType diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.operations.SparkBatchOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.operations.SparkBatchOperations.yml new file mode 100644 index 00000000..49eadd4b --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.operations.SparkBatchOperations.yml @@ -0,0 +1,153 @@ +### YamlMime:PythonClass +uid: azure.synapse.spark.operations.SparkBatchOperations +name: SparkBatchOperations +fullName: azure.synapse.spark.operations.SparkBatchOperations +module: azure.synapse.spark.operations +summary: 'SparkBatchOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: SparkBatchOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.spark.operations.SparkBatchOperations.cancel_spark_batch_job + name: cancel_spark_batch_job + summary: Cancels a running spark batch job. + signature: 'cancel_spark_batch_job(batch_id: int, **kwargs: Any) -> None' + parameters: + - name: batch_id + description: Identifier for the batch job. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.spark.operations.SparkBatchOperations.create_spark_batch_job + name: create_spark_batch_job + summary: Create new spark batch job. + signature: 'create_spark_batch_job(spark_batch_job_options: ''models.SparkBatchJobOptions'', + detailed: bool | None = None, **kwargs: Any) -> models.SparkBatchJob' + parameters: + - name: spark_batch_job_options + description: Livy compatible batch job request payload. + isRequired: true + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkBatchJob, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.spark.operations.SparkBatchOperations.get_spark_batch_job + name: get_spark_batch_job + summary: Gets a single spark batch job. + signature: 'get_spark_batch_job(batch_id: int, detailed: bool | None = None, **kwargs: + Any) -> models.SparkBatchJob' + parameters: + - name: batch_id + description: Identifier for the batch job. + isRequired: true + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkBatchJob, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.spark.operations.SparkBatchOperations.get_spark_batch_jobs + name: get_spark_batch_jobs + summary: List all spark batch jobs which are running under a particular spark pool. + signature: 'get_spark_batch_jobs(from_parameter: int | None = None, size: int | + None = None, detailed: bool | None = None, **kwargs: Any) -> models.SparkBatchJobCollection' + parameters: + - name: from_parameter + description: Optional param specifying which index the list should begin from. + defaultValue: None + types: + - + - name: size + description: 'Optional param specifying the size of the returned list. + + By default it is 20 and that is the maximum.' + defaultValue: None + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkBatchJobCollection, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.spark.operations.SparkBatchOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.operations.SparkSessionOperations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.operations.SparkSessionOperations.yml new file mode 100644 index 00000000..6b914761 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.operations.SparkSessionOperations.yml @@ -0,0 +1,276 @@ +### YamlMime:PythonClass +uid: azure.synapse.spark.operations.SparkSessionOperations +name: SparkSessionOperations +fullName: azure.synapse.spark.operations.SparkSessionOperations +module: azure.synapse.spark.operations +summary: 'SparkSessionOperations operations. + + + You should not instantiate this class directly. Instead, you should create a Client + instance that + + instantiates it for you and attaches it as an attribute.' +constructor: + syntax: SparkSessionOperations(client, config, serializer, deserializer) + parameters: + - name: client + description: Client for service requests. + isRequired: true + - name: config + description: Configuration of service client. + isRequired: true + - name: serializer + description: An object model serializer. + isRequired: true + - name: deserializer + description: An object model deserializer. + isRequired: true +variables: +- description: Alias to model classes used in this operation group. + name: models +methods: +- uid: azure.synapse.spark.operations.SparkSessionOperations.cancel_spark_session + name: cancel_spark_session + summary: Cancels a running spark session. + signature: 'cancel_spark_session(session_id: int, **kwargs: Any) -> None' + parameters: + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.spark.operations.SparkSessionOperations.cancel_spark_statement + name: cancel_spark_statement + summary: Kill a statement within a session. + signature: 'cancel_spark_statement(session_id: int, statement_id: int, **kwargs: + Any) -> models.SparkStatementCancellationResult' + parameters: + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + - name: statement_id + description: Identifier for the statement. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkStatementCancellationResult, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.spark.operations.SparkSessionOperations.create_spark_session + name: create_spark_session + summary: Create new spark session. + signature: 'create_spark_session(spark_session_options: ''models.SparkSessionOptions'', + detailed: bool | None = None, **kwargs: Any) -> models.SparkSession' + parameters: + - name: spark_session_options + description: Livy compatible batch job request payload. + isRequired: true + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkSession, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.spark.operations.SparkSessionOperations.create_spark_statement + name: create_spark_statement + summary: Create statement within a spark session. + signature: 'create_spark_statement(session_id: int, spark_statement_options: ''models.SparkStatementOptions'', + **kwargs: Any) -> models.SparkStatement' + parameters: + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + - name: spark_statement_options + description: Livy compatible batch job request payload. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkStatement, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.spark.operations.SparkSessionOperations.get_spark_session + name: get_spark_session + summary: Gets a single spark session. + signature: 'get_spark_session(session_id: int, detailed: bool | None = None, **kwargs: + Any) -> models.SparkSession' + parameters: + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkSession, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.spark.operations.SparkSessionOperations.get_spark_sessions + name: get_spark_sessions + summary: List all spark sessions which are running under a particular spark pool. + signature: 'get_spark_sessions(from_parameter: int | None = None, size: int | None + = None, detailed: bool | None = None, **kwargs: Any) -> models.SparkSessionCollection' + parameters: + - name: from_parameter + description: Optional param specifying which index the list should begin from. + defaultValue: None + types: + - + - name: size + description: 'Optional param specifying the size of the returned list. + + By default it is 20 and that is the maximum.' + defaultValue: None + types: + - + - name: detailed + description: 'Optional query param specifying whether detailed response is returned + beyond + + plain livy.' + defaultValue: None + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkSessionCollection, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.spark.operations.SparkSessionOperations.get_spark_statement + name: get_spark_statement + summary: Gets a single statement within a spark session. + signature: 'get_spark_statement(session_id: int, statement_id: int, **kwargs: Any) + -> models.SparkStatement' + parameters: + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + - name: statement_id + description: Identifier for the statement. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkStatement, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.spark.operations.SparkSessionOperations.get_spark_statements + name: get_spark_statements + summary: Gets a list of statements within a spark session. + signature: 'get_spark_statements(session_id: int, **kwargs: Any) -> models.SparkStatementCollection' + parameters: + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: SparkStatementCollection, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +- uid: azure.synapse.spark.operations.SparkSessionOperations.reset_spark_session_timeout + name: reset_spark_session_timeout + summary: Sends a keep alive call to the current session to reset the session timeout. + signature: 'reset_spark_session_timeout(session_id: int, **kwargs: Any) -> None' + parameters: + - name: session_id + description: Identifier for the session. + isRequired: true + types: + - + keywordOnlyParameters: + - name: cls + description: A custom type or function that will be passed the direct response + types: + - + return: + description: None, or the result of cls(response) + types: + - + exceptions: + - type: azure.core.exceptions.HttpResponseError +attributes: +- uid: azure.synapse.spark.operations.SparkSessionOperations.models + name: models + signature: models = diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.operations.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.operations.yml new file mode 100644 index 00000000..311ff72a --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.operations.yml @@ -0,0 +1,8 @@ +### YamlMime:PythonPackage +uid: azure.synapse.spark.operations +name: operations +fullName: azure.synapse.spark.operations +type: import +classes: +- azure.synapse.spark.operations.SparkBatchOperations +- azure.synapse.spark.operations.SparkSessionOperations diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.yml new file mode 100644 index 00000000..f7a4ae65 --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.yml @@ -0,0 +1,11 @@ +### YamlMime:PythonPackage +uid: azure.synapse.spark +name: spark +fullName: azure.synapse.spark +type: import +classes: +- azure.synapse.spark.SparkClient +packages: +- azure.synapse.spark.aio +- azure.synapse.spark.models +- azure.synapse.spark.operations diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.yml new file mode 100644 index 00000000..7f422cda --- /dev/null +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.yml @@ -0,0 +1,14 @@ +### YamlMime:PythonPackage +uid: azure.synapse +name: synapse +fullName: azure.synapse +type: rootImport +classes: +- azure.synapse.SynapseClient +packages: +- azure.synapse.accesscontrol +- azure.synapse.aio +- azure.synapse.artifacts +- azure.synapse.models +- azure.synapse.operations +- azure.synapse.spark diff --git a/previous/docs-ref-autogen/toc.yml b/previous/docs-ref-autogen/toc.yml index 774f42ba..031e1f17 100644 --- a/previous/docs-ref-autogen/toc.yml +++ b/previous/docs-ref-autogen/toc.yml @@ -1,4 +1,12938 @@ -- name: Sample - items: - - uid: azure.batch.BatchServiceClient - name: azure.batch.BatchServiceClient \ No newline at end of file +- items: + - name: Overview + uid: azure.datalake.store + - items: + - name: Overview + uid: azure.datalake.store.core + - name: AzureDLFile + uid: azure.datalake.store.core.AzureDLFile + - name: AzureDLFileSystem + uid: azure.datalake.store.core.AzureDLFileSystem + - name: AzureDLPath + uid: azure.datalake.store.core.AzureDLPath + name: core + - items: + - name: Overview + uid: azure.datalake.store.enums + - name: ExpiryOptionType + uid: azure.datalake.store.enums.ExpiryOptionType + name: enums + - items: + - name: Overview + uid: azure.datalake.store.exceptions + - name: DatalakeBadOffsetException + uid: azure.datalake.store.exceptions.DatalakeBadOffsetException + - name: DatalakeIncompleteTransferException + uid: azure.datalake.store.exceptions.DatalakeIncompleteTransferException + - name: DatalakeRESTException + uid: azure.datalake.store.exceptions.DatalakeRESTException + name: exceptions + - items: + - name: Overview + uid: azure.datalake.store.lib + - name: DatalakeRESTInterface + uid: azure.datalake.store.lib.DatalakeRESTInterface + name: lib + - name: multiprocessor + uid: azure.datalake.store.multiprocessor + - items: + - name: Overview + uid: azure.datalake.store.multithread + - name: ADLDownloader + uid: azure.datalake.store.multithread.ADLDownloader + - name: ADLUploader + uid: azure.datalake.store.multithread.ADLUploader + name: multithread + - items: + - name: Overview + uid: azure.datalake.store.retry + - name: ExponentialRetryPolicy + uid: azure.datalake.store.retry.ExponentialRetryPolicy + - name: NoRetryPolicy + uid: azure.datalake.store.retry.NoRetryPolicy + - name: RetryPolicy + uid: azure.datalake.store.retry.RetryPolicy + name: retry + - items: + - name: Overview + uid: azure.datalake.store.transfer + - name: ADLTransferClient + uid: azure.datalake.store.transfer.ADLTransferClient + - name: Chunk + uid: azure.datalake.store.transfer.Chunk + - name: File + uid: azure.datalake.store.transfer.File + - name: StateManager + uid: azure.datalake.store.transfer.StateManager + name: transfer + - items: + - name: Overview + uid: azure.datalake.store.utils + - name: CountUpDownLatch + uid: azure.datalake.store.utils.CountUpDownLatch + name: utils + name: azure.datalake.store +- items: + - name: Overview + uid: azure.ai.metricsadvisor + - items: + - name: Overview + uid: azure.ai.metricsadvisor.aio + - name: MetricsAdvisorAdministrationClient + uid: azure.ai.metricsadvisor.aio.MetricsAdvisorAdministrationClient + - name: MetricsAdvisorClient + uid: azure.ai.metricsadvisor.aio.MetricsAdvisorClient + name: aio + - items: + - name: Overview + uid: azure.ai.metricsadvisor.models + - name: AlertQueryTimeMode + uid: azure.ai.metricsadvisor.models.AlertQueryTimeMode + - name: AnomalyAlert + uid: azure.ai.metricsadvisor.models.AnomalyAlert + - name: AnomalyAlertConfiguration + uid: azure.ai.metricsadvisor.models.AnomalyAlertConfiguration + - name: AnomalyDetectionConfiguration + uid: azure.ai.metricsadvisor.models.AnomalyDetectionConfiguration + - name: AnomalyDetectorDirection + uid: azure.ai.metricsadvisor.models.AnomalyDetectorDirection + - name: AnomalyFeedback + uid: azure.ai.metricsadvisor.models.AnomalyFeedback + - name: AnomalyIncident + uid: azure.ai.metricsadvisor.models.AnomalyIncident + - name: AnomalyIncidentStatus + uid: azure.ai.metricsadvisor.models.AnomalyIncidentStatus + - name: AnomalySeverity + uid: azure.ai.metricsadvisor.models.AnomalySeverity + - name: AnomalyValue + uid: azure.ai.metricsadvisor.models.AnomalyValue + - name: AzureApplicationInsightsDataFeedSource + uid: azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource + - name: AzureBlobDataFeedSource + uid: azure.ai.metricsadvisor.models.AzureBlobDataFeedSource + - name: AzureCosmosDbDataFeedSource + uid: azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource + - name: AzureDataExplorerDataFeedSource + uid: azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource + - name: AzureDataLakeStorageGen2DataFeedSource + uid: azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource + - name: AzureEventHubsDataFeedSource + uid: azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource + - name: AzureLogAnalyticsDataFeedSource + uid: azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource + - name: AzureTableDataFeedSource + uid: azure.ai.metricsadvisor.models.AzureTableDataFeedSource + - name: ChangePointFeedback + uid: azure.ai.metricsadvisor.models.ChangePointFeedback + - name: ChangePointValue + uid: azure.ai.metricsadvisor.models.ChangePointValue + - name: ChangeThresholdCondition + uid: azure.ai.metricsadvisor.models.ChangeThresholdCondition + - name: CommentFeedback + uid: azure.ai.metricsadvisor.models.CommentFeedback + - name: DataFeed + uid: azure.ai.metricsadvisor.models.DataFeed + - name: DataFeedAccessMode + uid: azure.ai.metricsadvisor.models.DataFeedAccessMode + - name: DataFeedAutoRollupMethod + uid: azure.ai.metricsadvisor.models.DataFeedAutoRollupMethod + - name: DataFeedDimension + uid: azure.ai.metricsadvisor.models.DataFeedDimension + - name: DataFeedGranularity + uid: azure.ai.metricsadvisor.models.DataFeedGranularity + - name: DataFeedGranularityType + uid: azure.ai.metricsadvisor.models.DataFeedGranularityType + - name: DataFeedIngestionProgress + uid: azure.ai.metricsadvisor.models.DataFeedIngestionProgress + - name: DataFeedIngestionSettings + uid: azure.ai.metricsadvisor.models.DataFeedIngestionSettings + - name: DataFeedIngestionStatus + uid: azure.ai.metricsadvisor.models.DataFeedIngestionStatus + - name: DataFeedMetric + uid: azure.ai.metricsadvisor.models.DataFeedMetric + - name: DataFeedMissingDataPointFillSettings + uid: azure.ai.metricsadvisor.models.DataFeedMissingDataPointFillSettings + - name: DataFeedRollupSettings + uid: azure.ai.metricsadvisor.models.DataFeedRollupSettings + - name: DataFeedRollupType + uid: azure.ai.metricsadvisor.models.DataFeedRollupType + - name: DataFeedSchema + uid: azure.ai.metricsadvisor.models.DataFeedSchema + - name: DataFeedSource + uid: azure.ai.metricsadvisor.models.DataFeedSource + - name: DataFeedStatus + uid: azure.ai.metricsadvisor.models.DataFeedStatus + - name: DataPointAnomaly + uid: azure.ai.metricsadvisor.models.DataPointAnomaly + - name: DatasourceAuthenticationType + uid: azure.ai.metricsadvisor.models.DatasourceAuthenticationType + - name: DatasourceCredential + uid: azure.ai.metricsadvisor.models.DatasourceCredential + - name: DatasourceCredentialType + uid: azure.ai.metricsadvisor.models.DatasourceCredentialType + - name: DatasourceDataLakeGen2SharedKey + uid: azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey + - name: DatasourceMissingDataPointFillType + uid: azure.ai.metricsadvisor.models.DatasourceMissingDataPointFillType + - name: DatasourceServicePrincipal + uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipal + - name: DatasourceServicePrincipalInKeyVault + uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault + - name: DatasourceSqlConnectionString + uid: azure.ai.metricsadvisor.models.DatasourceSqlConnectionString + - name: DatasourceType + uid: azure.ai.metricsadvisor.models.DatasourceType + - name: DetectionAnomalyFilterCondition + uid: azure.ai.metricsadvisor.models.DetectionAnomalyFilterCondition + - name: DetectionConditionOperator + uid: azure.ai.metricsadvisor.models.DetectionConditionOperator + - name: DetectionIncidentFilterCondition + uid: azure.ai.metricsadvisor.models.DetectionIncidentFilterCondition + - name: DimensionGroupIdentity + uid: azure.ai.metricsadvisor.models.DimensionGroupIdentity + - name: EmailNotificationHook + uid: azure.ai.metricsadvisor.models.EmailNotificationHook + - name: EnrichmentStatus + uid: azure.ai.metricsadvisor.models.EnrichmentStatus + - name: FeedbackQueryTimeMode + uid: azure.ai.metricsadvisor.models.FeedbackQueryTimeMode + - name: FeedbackType + uid: azure.ai.metricsadvisor.models.FeedbackType + - name: HardThresholdCondition + uid: azure.ai.metricsadvisor.models.HardThresholdCondition + - name: IncidentRootCause + uid: azure.ai.metricsadvisor.models.IncidentRootCause + - name: InfluxDbDataFeedSource + uid: azure.ai.metricsadvisor.models.InfluxDbDataFeedSource + - name: MetricAlertConfiguration + uid: azure.ai.metricsadvisor.models.MetricAlertConfiguration + - name: MetricAnomalyAlertConditions + uid: azure.ai.metricsadvisor.models.MetricAnomalyAlertConditions + - name: MetricAnomalyAlertConfigurationsOperator + uid: azure.ai.metricsadvisor.models.MetricAnomalyAlertConfigurationsOperator + - name: MetricAnomalyAlertScope + uid: azure.ai.metricsadvisor.models.MetricAnomalyAlertScope + - name: MetricAnomalyAlertScopeType + uid: azure.ai.metricsadvisor.models.MetricAnomalyAlertScopeType + - name: MetricAnomalyAlertSnoozeCondition + uid: azure.ai.metricsadvisor.models.MetricAnomalyAlertSnoozeCondition + - name: MetricBoundaryCondition + uid: azure.ai.metricsadvisor.models.MetricBoundaryCondition + - name: MetricDetectionCondition + uid: azure.ai.metricsadvisor.models.MetricDetectionCondition + - name: MetricEnrichedSeriesData + uid: azure.ai.metricsadvisor.models.MetricEnrichedSeriesData + - name: MetricFeedback + uid: azure.ai.metricsadvisor.models.MetricFeedback + - name: MetricSeriesData + uid: azure.ai.metricsadvisor.models.MetricSeriesData + - name: MetricSeriesDefinition + uid: azure.ai.metricsadvisor.models.MetricSeriesDefinition + - name: MetricSeriesGroupDetectionCondition + uid: azure.ai.metricsadvisor.models.MetricSeriesGroupDetectionCondition + - name: MetricSingleSeriesDetectionCondition + uid: azure.ai.metricsadvisor.models.MetricSingleSeriesDetectionCondition + - name: MongoDbDataFeedSource + uid: azure.ai.metricsadvisor.models.MongoDbDataFeedSource + - name: MySqlDataFeedSource + uid: azure.ai.metricsadvisor.models.MySqlDataFeedSource + - name: NotificationHook + uid: azure.ai.metricsadvisor.models.NotificationHook + - name: PeriodFeedback + uid: azure.ai.metricsadvisor.models.PeriodFeedback + - name: PeriodType + uid: azure.ai.metricsadvisor.models.PeriodType + - name: PostgreSqlDataFeedSource + uid: azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource + - name: SeriesIdentity + uid: azure.ai.metricsadvisor.models.SeriesIdentity + - name: SeverityCondition + uid: azure.ai.metricsadvisor.models.SeverityCondition + - name: SeverityFilterCondition + uid: azure.ai.metricsadvisor.models.SeverityFilterCondition + - name: SmartDetectionCondition + uid: azure.ai.metricsadvisor.models.SmartDetectionCondition + - name: SnoozeScope + uid: azure.ai.metricsadvisor.models.SnoozeScope + - name: SqlServerDataFeedSource + uid: azure.ai.metricsadvisor.models.SqlServerDataFeedSource + - name: SuppressCondition + uid: azure.ai.metricsadvisor.models.SuppressCondition + - name: TopNGroupScope + uid: azure.ai.metricsadvisor.models.TopNGroupScope + - name: WebNotificationHook + uid: azure.ai.metricsadvisor.models.WebNotificationHook + name: models + - name: MetricsAdvisorAdministrationClient + uid: azure.ai.metricsadvisor.MetricsAdvisorAdministrationClient + - name: MetricsAdvisorClient + uid: azure.ai.metricsadvisor.MetricsAdvisorClient + - name: MetricsAdvisorKeyCredential + uid: azure.ai.metricsadvisor.MetricsAdvisorKeyCredential + name: azure.ai.metricsadvisor +- items: + - name: Overview + uid: azure.ai.vision + - name: diagnostics_logging + uid: azure.ai.vision.diagnostics_logging + - items: + - name: Overview + uid: azure.ai.vision.enums + - name: ImageAnalysisErrorReason + uid: azure.ai.vision.enums.ImageAnalysisErrorReason + - name: ImageAnalysisFeature + uid: azure.ai.vision.enums.ImageAnalysisFeature + - name: ImageAnalysisResultReason + uid: azure.ai.vision.enums.ImageAnalysisResultReason + - name: ImageSegmentationMode + uid: azure.ai.vision.enums.ImageSegmentationMode + - name: SessionResultReason + uid: azure.ai.vision.enums.SessionResultReason + - name: SessionStoppedErrorReason + uid: azure.ai.vision.enums.SessionStoppedErrorReason + - name: SessionStoppedReason + uid: azure.ai.vision.enums.SessionStoppedReason + - name: VisionOption + uid: azure.ai.vision.enums.VisionOption + name: enums + - name: image_analysis_client + uid: azure.ai.vision.image_analysis_client + - items: + - name: Overview + uid: azure.ai.vision.image_analysis_data + - name: ContentCaption + uid: azure.ai.vision.image_analysis_data.ContentCaption + - name: ContentTag + uid: azure.ai.vision.image_analysis_data.ContentTag + - name: ContentTags + uid: azure.ai.vision.image_analysis_data.ContentTags + - name: CropSuggestion + uid: azure.ai.vision.image_analysis_data.CropSuggestion + - name: CropSuggestions + uid: azure.ai.vision.image_analysis_data.CropSuggestions + - name: DenseCaptions + uid: azure.ai.vision.image_analysis_data.DenseCaptions + - name: DetectedObject + uid: azure.ai.vision.image_analysis_data.DetectedObject + - name: DetectedObjects + uid: azure.ai.vision.image_analysis_data.DetectedObjects + - name: DetectedPeople + uid: azure.ai.vision.image_analysis_data.DetectedPeople + - name: DetectedPerson + uid: azure.ai.vision.image_analysis_data.DetectedPerson + - name: DetectedText + uid: azure.ai.vision.image_analysis_data.DetectedText + - name: DetectedTextLine + uid: azure.ai.vision.image_analysis_data.DetectedTextLine + - name: DetectedTextWord + uid: azure.ai.vision.image_analysis_data.DetectedTextWord + - name: Rectangle + uid: azure.ai.vision.image_analysis_data.Rectangle + - name: SegmentationResult + uid: azure.ai.vision.image_analysis_data.SegmentationResult + name: image_analysis_data + - name: interop + uid: azure.ai.vision.interop + - items: + - name: Overview + uid: azure.ai.vision.properties + - name: PropertyCollection + uid: azure.ai.vision.properties.PropertyCollection + name: properties + - name: version + uid: azure.ai.vision.version + - items: + - name: Overview + uid: azure.ai.vision.vision_base_client + - name: EventSignal + uid: azure.ai.vision.vision_base_client.EventSignal + - name: SessionStartedEventArgs + uid: azure.ai.vision.vision_base_client.SessionStartedEventArgs + - name: SessionStoppedEventArgs + uid: azure.ai.vision.vision_base_client.SessionStoppedEventArgs + - name: VisionServiceAdvancedOptions + uid: azure.ai.vision.vision_base_client.VisionServiceAdvancedOptions + - name: VisionSession + uid: azure.ai.vision.vision_base_client.VisionSession + - name: VisionSessionOptions + uid: azure.ai.vision.vision_base_client.VisionSessionOptions + name: vision_base_client + - name: ConsoleLogger + uid: azure.ai.vision.ConsoleLogger + - name: FileLogger + uid: azure.ai.vision.FileLogger + - name: Frame + uid: azure.ai.vision.Frame + - name: FrameFormat + uid: azure.ai.vision.FrameFormat + - name: FrameSource + uid: azure.ai.vision.FrameSource + - name: FrameSourceCallback + uid: azure.ai.vision.FrameSourceCallback + - name: FrameWriter + uid: azure.ai.vision.FrameWriter + - name: ImageAnalysisErrorDetails + uid: azure.ai.vision.ImageAnalysisErrorDetails + - name: ImageAnalysisEventArgs + uid: azure.ai.vision.ImageAnalysisEventArgs + - name: ImageAnalysisOptions + uid: azure.ai.vision.ImageAnalysisOptions + - name: ImageAnalysisResult + uid: azure.ai.vision.ImageAnalysisResult + - name: ImageAnalysisResultDetails + uid: azure.ai.vision.ImageAnalysisResultDetails + - name: ImageAnalyzer + uid: azure.ai.vision.ImageAnalyzer + - name: ImageSourceBuffer + uid: azure.ai.vision.ImageSourceBuffer + - name: ImageSourceBufferCallback + uid: azure.ai.vision.ImageSourceBufferCallback + - name: ImageWriter + uid: azure.ai.vision.ImageWriter + - name: MemoryLogger + uid: azure.ai.vision.MemoryLogger + - name: VisionServiceOptions + uid: azure.ai.vision.VisionServiceOptions + - name: VisionSource + uid: azure.ai.vision.VisionSource + name: azure.ai.vision +- items: + - name: Overview + uid: azure.applicationinsights + - items: + - name: Overview + uid: azure.applicationinsights.models + - items: + - name: Overview + uid: azure.applicationinsights.models.application_insights_data_client_enums + - name: EventType + uid: azure.applicationinsights.models.application_insights_data_client_enums.EventType + - name: MetricId + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricId + - name: MetricsAggregation + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsAggregation + - name: MetricsSegment + uid: azure.applicationinsights.models.application_insights_data_client_enums.MetricsSegment + name: application_insights_data_client_enums + - items: + - name: Overview + uid: azure.applicationinsights.models.column + - name: Column + uid: azure.applicationinsights.models.column.Column + name: column + - items: + - name: Overview + uid: azure.applicationinsights.models.column_py3 + - name: Column + uid: azure.applicationinsights.models.column_py3.Column + name: column_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.error_detail + - name: ErrorDetail + uid: azure.applicationinsights.models.error_detail.ErrorDetail + name: error_detail + - items: + - name: Overview + uid: azure.applicationinsights.models.error_detail_py3 + - name: ErrorDetail + uid: azure.applicationinsights.models.error_detail_py3.ErrorDetail + name: error_detail_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.error_info + - name: ErrorInfo + uid: azure.applicationinsights.models.error_info.ErrorInfo + name: error_info + - items: + - name: Overview + uid: azure.applicationinsights.models.error_info_py3 + - name: ErrorInfo + uid: azure.applicationinsights.models.error_info_py3.ErrorInfo + name: error_info_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.error_response + - name: ErrorResponse + uid: azure.applicationinsights.models.error_response.ErrorResponse + - name: ErrorResponseException + uid: azure.applicationinsights.models.error_response.ErrorResponseException + name: error_response + - items: + - name: Overview + uid: azure.applicationinsights.models.error_response_py3 + - name: ErrorResponse + uid: azure.applicationinsights.models.error_response_py3.ErrorResponse + - name: ErrorResponseException + uid: azure.applicationinsights.models.error_response_py3.ErrorResponseException + name: error_response_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_ai_info + - name: EventsAiInfo + uid: azure.applicationinsights.models.events_ai_info.EventsAiInfo + name: events_ai_info + - items: + - name: Overview + uid: azure.applicationinsights.models.events_ai_info_py3 + - name: EventsAiInfo + uid: azure.applicationinsights.models.events_ai_info_py3.EventsAiInfo + name: events_ai_info_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_application_info + - name: EventsApplicationInfo + uid: azure.applicationinsights.models.events_application_info.EventsApplicationInfo + name: events_application_info + - items: + - name: Overview + uid: azure.applicationinsights.models.events_application_info_py3 + - name: EventsApplicationInfo + uid: azure.applicationinsights.models.events_application_info_py3.EventsApplicationInfo + name: events_application_info_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_availability_result_info + - name: EventsAvailabilityResultInfo + uid: azure.applicationinsights.models.events_availability_result_info.EventsAvailabilityResultInfo + name: events_availability_result_info + - items: + - name: Overview + uid: azure.applicationinsights.models.events_availability_result_info_py3 + - name: EventsAvailabilityResultInfo + uid: azure.applicationinsights.models.events_availability_result_info_py3.EventsAvailabilityResultInfo + name: events_availability_result_info_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_availability_result_result + - name: EventsAvailabilityResultResult + uid: azure.applicationinsights.models.events_availability_result_result.EventsAvailabilityResultResult + name: events_availability_result_result + - items: + - name: Overview + uid: azure.applicationinsights.models.events_availability_result_result_py3 + - name: EventsAvailabilityResultResult + uid: azure.applicationinsights.models.events_availability_result_result_py3.EventsAvailabilityResultResult + name: events_availability_result_result_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_browser_timing_info + - name: EventsBrowserTimingInfo + uid: azure.applicationinsights.models.events_browser_timing_info.EventsBrowserTimingInfo + name: events_browser_timing_info + - items: + - name: Overview + uid: azure.applicationinsights.models.events_browser_timing_info_py3 + - name: EventsBrowserTimingInfo + uid: azure.applicationinsights.models.events_browser_timing_info_py3.EventsBrowserTimingInfo + name: events_browser_timing_info_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_browser_timing_result + - name: EventsBrowserTimingResult + uid: azure.applicationinsights.models.events_browser_timing_result.EventsBrowserTimingResult + name: events_browser_timing_result + - items: + - name: Overview + uid: azure.applicationinsights.models.events_browser_timing_result_py3 + - name: EventsBrowserTimingResult + uid: azure.applicationinsights.models.events_browser_timing_result_py3.EventsBrowserTimingResult + name: events_browser_timing_result_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_client_info + - name: EventsClientInfo + uid: azure.applicationinsights.models.events_client_info.EventsClientInfo + name: events_client_info + - items: + - name: Overview + uid: azure.applicationinsights.models.events_client_info_py3 + - name: EventsClientInfo + uid: azure.applicationinsights.models.events_client_info_py3.EventsClientInfo + name: events_client_info_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_client_performance_info + - name: EventsClientPerformanceInfo + uid: azure.applicationinsights.models.events_client_performance_info.EventsClientPerformanceInfo + name: events_client_performance_info + - items: + - name: Overview + uid: azure.applicationinsights.models.events_client_performance_info_py3 + - name: EventsClientPerformanceInfo + uid: azure.applicationinsights.models.events_client_performance_info_py3.EventsClientPerformanceInfo + name: events_client_performance_info_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_cloud_info + - name: EventsCloudInfo + uid: azure.applicationinsights.models.events_cloud_info.EventsCloudInfo + name: events_cloud_info + - items: + - name: Overview + uid: azure.applicationinsights.models.events_cloud_info_py3 + - name: EventsCloudInfo + uid: azure.applicationinsights.models.events_cloud_info_py3.EventsCloudInfo + name: events_cloud_info_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_custom_event_info + - name: EventsCustomEventInfo + uid: azure.applicationinsights.models.events_custom_event_info.EventsCustomEventInfo + name: events_custom_event_info + - items: + - name: Overview + uid: azure.applicationinsights.models.events_custom_event_info_py3 + - name: EventsCustomEventInfo + uid: azure.applicationinsights.models.events_custom_event_info_py3.EventsCustomEventInfo + name: events_custom_event_info_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_custom_event_result + - name: EventsCustomEventResult + uid: azure.applicationinsights.models.events_custom_event_result.EventsCustomEventResult + name: events_custom_event_result + - items: + - name: Overview + uid: azure.applicationinsights.models.events_custom_event_result_py3 + - name: EventsCustomEventResult + uid: azure.applicationinsights.models.events_custom_event_result_py3.EventsCustomEventResult + name: events_custom_event_result_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_custom_metric_info + - name: EventsCustomMetricInfo + uid: azure.applicationinsights.models.events_custom_metric_info.EventsCustomMetricInfo + name: events_custom_metric_info + - items: + - name: Overview + uid: azure.applicationinsights.models.events_custom_metric_info_py3 + - name: EventsCustomMetricInfo + uid: azure.applicationinsights.models.events_custom_metric_info_py3.EventsCustomMetricInfo + name: events_custom_metric_info_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_custom_metric_result + - name: EventsCustomMetricResult + uid: azure.applicationinsights.models.events_custom_metric_result.EventsCustomMetricResult + name: events_custom_metric_result + - items: + - name: Overview + uid: azure.applicationinsights.models.events_custom_metric_result_py3 + - name: EventsCustomMetricResult + uid: azure.applicationinsights.models.events_custom_metric_result_py3.EventsCustomMetricResult + name: events_custom_metric_result_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_dependency_info + - name: EventsDependencyInfo + uid: azure.applicationinsights.models.events_dependency_info.EventsDependencyInfo + name: events_dependency_info + - items: + - name: Overview + uid: azure.applicationinsights.models.events_dependency_info_py3 + - name: EventsDependencyInfo + uid: azure.applicationinsights.models.events_dependency_info_py3.EventsDependencyInfo + name: events_dependency_info_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_dependency_result + - name: EventsDependencyResult + uid: azure.applicationinsights.models.events_dependency_result.EventsDependencyResult + name: events_dependency_result + - items: + - name: Overview + uid: azure.applicationinsights.models.events_dependency_result_py3 + - name: EventsDependencyResult + uid: azure.applicationinsights.models.events_dependency_result_py3.EventsDependencyResult + name: events_dependency_result_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_exception_detail + - name: EventsExceptionDetail + uid: azure.applicationinsights.models.events_exception_detail.EventsExceptionDetail + name: events_exception_detail + - items: + - name: Overview + uid: azure.applicationinsights.models.events_exception_detail_py3 + - name: EventsExceptionDetail + uid: azure.applicationinsights.models.events_exception_detail_py3.EventsExceptionDetail + name: events_exception_detail_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_exception_details_parsed_stack + - name: EventsExceptionDetailsParsedStack + uid: azure.applicationinsights.models.events_exception_details_parsed_stack.EventsExceptionDetailsParsedStack + name: events_exception_details_parsed_stack + - items: + - name: Overview + uid: azure.applicationinsights.models.events_exception_details_parsed_stack_py3 + - name: EventsExceptionDetailsParsedStack + uid: azure.applicationinsights.models.events_exception_details_parsed_stack_py3.EventsExceptionDetailsParsedStack + name: events_exception_details_parsed_stack_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_exception_info + - name: EventsExceptionInfo + uid: azure.applicationinsights.models.events_exception_info.EventsExceptionInfo + name: events_exception_info + - items: + - name: Overview + uid: azure.applicationinsights.models.events_exception_info_py3 + - name: EventsExceptionInfo + uid: azure.applicationinsights.models.events_exception_info_py3.EventsExceptionInfo + name: events_exception_info_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_exception_result + - name: EventsExceptionResult + uid: azure.applicationinsights.models.events_exception_result.EventsExceptionResult + name: events_exception_result + - items: + - name: Overview + uid: azure.applicationinsights.models.events_exception_result_py3 + - name: EventsExceptionResult + uid: azure.applicationinsights.models.events_exception_result_py3.EventsExceptionResult + name: events_exception_result_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_operation_info + - name: EventsOperationInfo + uid: azure.applicationinsights.models.events_operation_info.EventsOperationInfo + name: events_operation_info + - items: + - name: Overview + uid: azure.applicationinsights.models.events_operation_info_py3 + - name: EventsOperationInfo + uid: azure.applicationinsights.models.events_operation_info_py3.EventsOperationInfo + name: events_operation_info_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_page_view_info + - name: EventsPageViewInfo + uid: azure.applicationinsights.models.events_page_view_info.EventsPageViewInfo + name: events_page_view_info + - items: + - name: Overview + uid: azure.applicationinsights.models.events_page_view_info_py3 + - name: EventsPageViewInfo + uid: azure.applicationinsights.models.events_page_view_info_py3.EventsPageViewInfo + name: events_page_view_info_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_page_view_result + - name: EventsPageViewResult + uid: azure.applicationinsights.models.events_page_view_result.EventsPageViewResult + name: events_page_view_result + - items: + - name: Overview + uid: azure.applicationinsights.models.events_page_view_result_py3 + - name: EventsPageViewResult + uid: azure.applicationinsights.models.events_page_view_result_py3.EventsPageViewResult + name: events_page_view_result_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_performance_counter_info + - name: EventsPerformanceCounterInfo + uid: azure.applicationinsights.models.events_performance_counter_info.EventsPerformanceCounterInfo + name: events_performance_counter_info + - items: + - name: Overview + uid: azure.applicationinsights.models.events_performance_counter_info_py3 + - name: EventsPerformanceCounterInfo + uid: azure.applicationinsights.models.events_performance_counter_info_py3.EventsPerformanceCounterInfo + name: events_performance_counter_info_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_performance_counter_result + - name: EventsPerformanceCounterResult + uid: azure.applicationinsights.models.events_performance_counter_result.EventsPerformanceCounterResult + name: events_performance_counter_result + - items: + - name: Overview + uid: azure.applicationinsights.models.events_performance_counter_result_py3 + - name: EventsPerformanceCounterResult + uid: azure.applicationinsights.models.events_performance_counter_result_py3.EventsPerformanceCounterResult + name: events_performance_counter_result_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_request_info + - name: EventsRequestInfo + uid: azure.applicationinsights.models.events_request_info.EventsRequestInfo + name: events_request_info + - items: + - name: Overview + uid: azure.applicationinsights.models.events_request_info_py3 + - name: EventsRequestInfo + uid: azure.applicationinsights.models.events_request_info_py3.EventsRequestInfo + name: events_request_info_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_request_result + - name: EventsRequestResult + uid: azure.applicationinsights.models.events_request_result.EventsRequestResult + name: events_request_result + - items: + - name: Overview + uid: azure.applicationinsights.models.events_request_result_py3 + - name: EventsRequestResult + uid: azure.applicationinsights.models.events_request_result_py3.EventsRequestResult + name: events_request_result_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_result + - name: EventsResult + uid: azure.applicationinsights.models.events_result.EventsResult + name: events_result + - items: + - name: Overview + uid: azure.applicationinsights.models.events_result_data + - name: EventsResultData + uid: azure.applicationinsights.models.events_result_data.EventsResultData + name: events_result_data + - items: + - name: Overview + uid: azure.applicationinsights.models.events_result_data_custom_dimensions + - name: EventsResultDataCustomDimensions + uid: azure.applicationinsights.models.events_result_data_custom_dimensions.EventsResultDataCustomDimensions + name: events_result_data_custom_dimensions + - items: + - name: Overview + uid: azure.applicationinsights.models.events_result_data_custom_dimensions_py3 + - name: EventsResultDataCustomDimensions + uid: azure.applicationinsights.models.events_result_data_custom_dimensions_py3.EventsResultDataCustomDimensions + name: events_result_data_custom_dimensions_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_result_data_custom_measurements + - name: EventsResultDataCustomMeasurements + uid: azure.applicationinsights.models.events_result_data_custom_measurements.EventsResultDataCustomMeasurements + name: events_result_data_custom_measurements + - items: + - name: Overview + uid: azure.applicationinsights.models.events_result_data_custom_measurements_py3 + - name: EventsResultDataCustomMeasurements + uid: azure.applicationinsights.models.events_result_data_custom_measurements_py3.EventsResultDataCustomMeasurements + name: events_result_data_custom_measurements_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_result_data_py3 + - name: EventsResultData + uid: azure.applicationinsights.models.events_result_data_py3.EventsResultData + name: events_result_data_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_result_py3 + - name: EventsResult + uid: azure.applicationinsights.models.events_result_py3.EventsResult + name: events_result_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_results + - name: EventsResults + uid: azure.applicationinsights.models.events_results.EventsResults + name: events_results + - items: + - name: Overview + uid: azure.applicationinsights.models.events_results_py3 + - name: EventsResults + uid: azure.applicationinsights.models.events_results_py3.EventsResults + name: events_results_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_session_info + - name: EventsSessionInfo + uid: azure.applicationinsights.models.events_session_info.EventsSessionInfo + name: events_session_info + - items: + - name: Overview + uid: azure.applicationinsights.models.events_session_info_py3 + - name: EventsSessionInfo + uid: azure.applicationinsights.models.events_session_info_py3.EventsSessionInfo + name: events_session_info_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_trace_info + - name: EventsTraceInfo + uid: azure.applicationinsights.models.events_trace_info.EventsTraceInfo + name: events_trace_info + - items: + - name: Overview + uid: azure.applicationinsights.models.events_trace_info_py3 + - name: EventsTraceInfo + uid: azure.applicationinsights.models.events_trace_info_py3.EventsTraceInfo + name: events_trace_info_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_trace_result + - name: EventsTraceResult + uid: azure.applicationinsights.models.events_trace_result.EventsTraceResult + name: events_trace_result + - items: + - name: Overview + uid: azure.applicationinsights.models.events_trace_result_py3 + - name: EventsTraceResult + uid: azure.applicationinsights.models.events_trace_result_py3.EventsTraceResult + name: events_trace_result_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.events_user_info + - name: EventsUserInfo + uid: azure.applicationinsights.models.events_user_info.EventsUserInfo + name: events_user_info + - items: + - name: Overview + uid: azure.applicationinsights.models.events_user_info_py3 + - name: EventsUserInfo + uid: azure.applicationinsights.models.events_user_info_py3.EventsUserInfo + name: events_user_info_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.metrics_post_body_schema + - name: MetricsPostBodySchema + uid: azure.applicationinsights.models.metrics_post_body_schema.MetricsPostBodySchema + name: metrics_post_body_schema + - items: + - name: Overview + uid: azure.applicationinsights.models.metrics_post_body_schema_parameters + - name: MetricsPostBodySchemaParameters + uid: azure.applicationinsights.models.metrics_post_body_schema_parameters.MetricsPostBodySchemaParameters + name: metrics_post_body_schema_parameters + - items: + - name: Overview + uid: azure.applicationinsights.models.metrics_post_body_schema_parameters_py3 + - name: MetricsPostBodySchemaParameters + uid: azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.MetricsPostBodySchemaParameters + name: metrics_post_body_schema_parameters_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.metrics_post_body_schema_py3 + - name: MetricsPostBodySchema + uid: azure.applicationinsights.models.metrics_post_body_schema_py3.MetricsPostBodySchema + name: metrics_post_body_schema_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.metrics_result + - name: MetricsResult + uid: azure.applicationinsights.models.metrics_result.MetricsResult + name: metrics_result + - items: + - name: Overview + uid: azure.applicationinsights.models.metrics_result_info + - name: MetricsResultInfo + uid: azure.applicationinsights.models.metrics_result_info.MetricsResultInfo + name: metrics_result_info + - items: + - name: Overview + uid: azure.applicationinsights.models.metrics_result_info_py3 + - name: MetricsResultInfo + uid: azure.applicationinsights.models.metrics_result_info_py3.MetricsResultInfo + name: metrics_result_info_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.metrics_result_py3 + - name: MetricsResult + uid: azure.applicationinsights.models.metrics_result_py3.MetricsResult + name: metrics_result_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.metrics_results_item + - name: MetricsResultsItem + uid: azure.applicationinsights.models.metrics_results_item.MetricsResultsItem + name: metrics_results_item + - items: + - name: Overview + uid: azure.applicationinsights.models.metrics_results_item_py3 + - name: MetricsResultsItem + uid: azure.applicationinsights.models.metrics_results_item_py3.MetricsResultsItem + name: metrics_results_item_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.metrics_segment_info + - name: MetricsSegmentInfo + uid: azure.applicationinsights.models.metrics_segment_info.MetricsSegmentInfo + name: metrics_segment_info + - items: + - name: Overview + uid: azure.applicationinsights.models.metrics_segment_info_py3 + - name: MetricsSegmentInfo + uid: azure.applicationinsights.models.metrics_segment_info_py3.MetricsSegmentInfo + name: metrics_segment_info_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.query_body + - name: QueryBody + uid: azure.applicationinsights.models.query_body.QueryBody + name: query_body + - items: + - name: Overview + uid: azure.applicationinsights.models.query_body_py3 + - name: QueryBody + uid: azure.applicationinsights.models.query_body_py3.QueryBody + name: query_body_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.query_results + - name: QueryResults + uid: azure.applicationinsights.models.query_results.QueryResults + name: query_results + - items: + - name: Overview + uid: azure.applicationinsights.models.query_results_py3 + - name: QueryResults + uid: azure.applicationinsights.models.query_results_py3.QueryResults + name: query_results_py3 + - items: + - name: Overview + uid: azure.applicationinsights.models.table + - name: Table + uid: azure.applicationinsights.models.table.Table + name: table + - items: + - name: Overview + uid: azure.applicationinsights.models.table_py3 + - name: Table + uid: azure.applicationinsights.models.table_py3.Table + name: table_py3 + - name: Column + uid: azure.applicationinsights.models.Column + - name: ErrorDetail + uid: azure.applicationinsights.models.ErrorDetail + - name: ErrorInfo + uid: azure.applicationinsights.models.ErrorInfo + - name: ErrorResponse + uid: azure.applicationinsights.models.ErrorResponse + - name: ErrorResponseException + uid: azure.applicationinsights.models.ErrorResponseException + - name: EventType + uid: azure.applicationinsights.models.EventType + - name: EventsAiInfo + uid: azure.applicationinsights.models.EventsAiInfo + - name: EventsApplicationInfo + uid: azure.applicationinsights.models.EventsApplicationInfo + - name: EventsAvailabilityResultInfo + uid: azure.applicationinsights.models.EventsAvailabilityResultInfo + - name: EventsAvailabilityResultResult + uid: azure.applicationinsights.models.EventsAvailabilityResultResult + - name: EventsBrowserTimingInfo + uid: azure.applicationinsights.models.EventsBrowserTimingInfo + - name: EventsBrowserTimingResult + uid: azure.applicationinsights.models.EventsBrowserTimingResult + - name: EventsClientInfo + uid: azure.applicationinsights.models.EventsClientInfo + - name: EventsClientPerformanceInfo + uid: azure.applicationinsights.models.EventsClientPerformanceInfo + - name: EventsCloudInfo + uid: azure.applicationinsights.models.EventsCloudInfo + - name: EventsCustomEventInfo + uid: azure.applicationinsights.models.EventsCustomEventInfo + - name: EventsCustomEventResult + uid: azure.applicationinsights.models.EventsCustomEventResult + - name: EventsCustomMetricInfo + uid: azure.applicationinsights.models.EventsCustomMetricInfo + - name: EventsCustomMetricResult + uid: azure.applicationinsights.models.EventsCustomMetricResult + - name: EventsDependencyInfo + uid: azure.applicationinsights.models.EventsDependencyInfo + - name: EventsDependencyResult + uid: azure.applicationinsights.models.EventsDependencyResult + - name: EventsExceptionDetail + uid: azure.applicationinsights.models.EventsExceptionDetail + - name: EventsExceptionDetailsParsedStack + uid: azure.applicationinsights.models.EventsExceptionDetailsParsedStack + - name: EventsExceptionInfo + uid: azure.applicationinsights.models.EventsExceptionInfo + - name: EventsExceptionResult + uid: azure.applicationinsights.models.EventsExceptionResult + - name: EventsOperationInfo + uid: azure.applicationinsights.models.EventsOperationInfo + - name: EventsPageViewInfo + uid: azure.applicationinsights.models.EventsPageViewInfo + - name: EventsPageViewResult + uid: azure.applicationinsights.models.EventsPageViewResult + - name: EventsPerformanceCounterInfo + uid: azure.applicationinsights.models.EventsPerformanceCounterInfo + - name: EventsPerformanceCounterResult + uid: azure.applicationinsights.models.EventsPerformanceCounterResult + - name: EventsRequestInfo + uid: azure.applicationinsights.models.EventsRequestInfo + - name: EventsRequestResult + uid: azure.applicationinsights.models.EventsRequestResult + - name: EventsResult + uid: azure.applicationinsights.models.EventsResult + - name: EventsResultData + uid: azure.applicationinsights.models.EventsResultData + - name: EventsResultDataCustomDimensions + uid: azure.applicationinsights.models.EventsResultDataCustomDimensions + - name: EventsResultDataCustomMeasurements + uid: azure.applicationinsights.models.EventsResultDataCustomMeasurements + - name: EventsResults + uid: azure.applicationinsights.models.EventsResults + - name: EventsSessionInfo + uid: azure.applicationinsights.models.EventsSessionInfo + - name: EventsTraceInfo + uid: azure.applicationinsights.models.EventsTraceInfo + - name: EventsTraceResult + uid: azure.applicationinsights.models.EventsTraceResult + - name: EventsUserInfo + uid: azure.applicationinsights.models.EventsUserInfo + - name: MetricId + uid: azure.applicationinsights.models.MetricId + - name: MetricsAggregation + uid: azure.applicationinsights.models.MetricsAggregation + - name: MetricsPostBodySchema + uid: azure.applicationinsights.models.MetricsPostBodySchema + - name: MetricsPostBodySchemaParameters + uid: azure.applicationinsights.models.MetricsPostBodySchemaParameters + - name: MetricsResult + uid: azure.applicationinsights.models.MetricsResult + - name: MetricsResultInfo + uid: azure.applicationinsights.models.MetricsResultInfo + - name: MetricsResultsItem + uid: azure.applicationinsights.models.MetricsResultsItem + - name: MetricsSegment + uid: azure.applicationinsights.models.MetricsSegment + - name: MetricsSegmentInfo + uid: azure.applicationinsights.models.MetricsSegmentInfo + - name: QueryBody + uid: azure.applicationinsights.models.QueryBody + - name: QueryResults + uid: azure.applicationinsights.models.QueryResults + - name: Table + uid: azure.applicationinsights.models.Table + name: models + - items: + - name: Overview + uid: azure.applicationinsights.operations + - items: + - name: Overview + uid: azure.applicationinsights.operations.events_operations + - name: EventsOperations + uid: azure.applicationinsights.operations.events_operations.EventsOperations + name: events_operations + - items: + - name: Overview + uid: azure.applicationinsights.operations.metrics_operations + - name: MetricsOperations + uid: azure.applicationinsights.operations.metrics_operations.MetricsOperations + name: metrics_operations + - items: + - name: Overview + uid: azure.applicationinsights.operations.query_operations + - name: QueryOperations + uid: azure.applicationinsights.operations.query_operations.QueryOperations + name: query_operations + - name: EventsOperations + uid: azure.applicationinsights.operations.EventsOperations + - name: MetricsOperations + uid: azure.applicationinsights.operations.MetricsOperations + - name: QueryOperations + uid: azure.applicationinsights.operations.QueryOperations + name: operations + - items: + - name: Overview + uid: azure.applicationinsights.application_insights_data_client + - name: ApplicationInsightsDataClient + uid: azure.applicationinsights.application_insights_data_client.ApplicationInsightsDataClient + - name: ApplicationInsightsDataClientConfiguration + uid: azure.applicationinsights.application_insights_data_client.ApplicationInsightsDataClientConfiguration + name: application_insights_data_client + - name: version + uid: azure.applicationinsights.version + - name: ApplicationInsightsDataClient + uid: azure.applicationinsights.ApplicationInsightsDataClient + name: azure.applicationinsights +- items: + - name: Overview + uid: azure.cognitiveservices.anomalydetector + - items: + - name: Overview + uid: azure.cognitiveservices.anomalydetector.models + - name: APIError + uid: azure.cognitiveservices.anomalydetector.models.APIError + - name: APIErrorException + uid: azure.cognitiveservices.anomalydetector.models.APIErrorException + - name: ChangePointDetectRequest + uid: azure.cognitiveservices.anomalydetector.models.ChangePointDetectRequest + - name: ChangePointDetectResponse + uid: azure.cognitiveservices.anomalydetector.models.ChangePointDetectResponse + - name: EntireDetectResponse + uid: azure.cognitiveservices.anomalydetector.models.EntireDetectResponse + - name: Granularity + uid: azure.cognitiveservices.anomalydetector.models.Granularity + - name: LastDetectResponse + uid: azure.cognitiveservices.anomalydetector.models.LastDetectResponse + - name: Point + uid: azure.cognitiveservices.anomalydetector.models.Point + - name: Request + uid: azure.cognitiveservices.anomalydetector.models.Request + name: models + - items: + - name: Overview + uid: azure.cognitiveservices.anomalydetector.operations + - name: AnomalyDetectorClientOperationsMixin + uid: azure.cognitiveservices.anomalydetector.operations.AnomalyDetectorClientOperationsMixin + name: operations + - name: version + uid: azure.cognitiveservices.anomalydetector.version + - name: AnomalyDetectorClient + uid: azure.cognitiveservices.anomalydetector.AnomalyDetectorClient + - name: AnomalyDetectorClientConfiguration + uid: azure.cognitiveservices.anomalydetector.AnomalyDetectorClientConfiguration + name: azure.cognitiveservices.anomalydetector +- items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto + - name: ActiveLearningSettingsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto.ActiveLearningSettingsDTO + name: active_learning_settings_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3 + - name: ActiveLearningSettingsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.ActiveLearningSettingsDTO + name: active_learning_settings_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto + - name: AlterationsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto.AlterationsDTO + name: alterations_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3 + - name: AlterationsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.alterations_dto_py3.AlterationsDTO + name: alterations_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto + - name: AnswerSpanRequestDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto.AnswerSpanRequestDTO + name: answer_span_request_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3 + - name: AnswerSpanRequestDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.AnswerSpanRequestDTO + name: answer_span_request_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto + - name: AnswerSpanResponseDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto.AnswerSpanResponseDTO + name: answer_span_response_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3 + - name: AnswerSpanResponseDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.AnswerSpanResponseDTO + name: answer_span_response_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.context_dto + - name: ContextDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.context_dto.ContextDTO + name: context_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3 + - name: ContextDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.ContextDTO + name: context_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto + - name: CreateKbDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto.CreateKbDTO + name: create_kb_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3 + - name: CreateKbDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.CreateKbDTO + name: create_kb_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto + - name: CreateKbInputDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto.CreateKbInputDTO + name: create_kb_input_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3 + - name: CreateKbInputDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.CreateKbInputDTO + name: create_kb_input_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto + - name: DeleteKbContentsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto.DeleteKbContentsDTO + name: delete_kb_contents_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3 + - name: DeleteKbContentsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.DeleteKbContentsDTO + name: delete_kb_contents_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto + - name: EndpointKeysDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto.EndpointKeysDTO + name: endpoint_keys_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3 + - name: EndpointKeysDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.EndpointKeysDTO + name: endpoint_keys_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto + - name: EndpointSettingsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto.EndpointSettingsDTO + name: endpoint_settings_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning + - name: EndpointSettingsDTOActiveLearning + uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning.EndpointSettingsDTOActiveLearning + name: endpoint_settings_dto_active_learning + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3 + - name: EndpointSettingsDTOActiveLearning + uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.EndpointSettingsDTOActiveLearning + name: endpoint_settings_dto_active_learning_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3 + - name: EndpointSettingsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.EndpointSettingsDTO + name: endpoint_settings_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.error + - name: Error + uid: azure.cognitiveservices.knowledge.qnamaker.models.error.Error + name: error + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.error_py3 + - name: Error + uid: azure.cognitiveservices.knowledge.qnamaker.models.error_py3.Error + name: error_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response + - name: ErrorResponse + uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponse + - name: ErrorResponseException + uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response.ErrorResponseException + name: error_response + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error + - name: ErrorResponseError + uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error.ErrorResponseError + name: error_response_error + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3 + - name: ErrorResponseError + uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.ErrorResponseError + name: error_response_error_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3 + - name: ErrorResponse + uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponse + - name: ErrorResponseException + uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponseException + name: error_response_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto + - name: FeedbackRecordDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto.FeedbackRecordDTO + name: feedback_record_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3 + - name: FeedbackRecordDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.FeedbackRecordDTO + name: feedback_record_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto + - name: FeedbackRecordsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto.FeedbackRecordsDTO + name: feedback_records_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3 + - name: FeedbackRecordsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.FeedbackRecordsDTO + name: feedback_records_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.file_dto + - name: FileDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.file_dto.FileDTO + name: file_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3 + - name: FileDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.file_dto_py3.FileDTO + name: file_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model + - name: InnerErrorModel + uid: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model.InnerErrorModel + name: inner_error_model + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3 + - name: InnerErrorModel + uid: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.InnerErrorModel + name: inner_error_model_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto + - name: KnowledgebaseDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto.KnowledgebaseDTO + name: knowledgebase_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3 + - name: KnowledgebaseDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.KnowledgebaseDTO + name: knowledgebase_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto + - name: KnowledgebasesDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto.KnowledgebasesDTO + name: knowledgebases_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3 + - name: KnowledgebasesDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.KnowledgebasesDTO + name: knowledgebases_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto + - name: MetadataDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto.MetadataDTO + name: metadata_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3 + - name: MetadataDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.metadata_dto_py3.MetadataDTO + name: metadata_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.operation + - name: Operation + uid: azure.cognitiveservices.knowledge.qnamaker.models.operation.Operation + name: operation + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.operation_py3 + - name: Operation + uid: azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.Operation + name: operation_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto + - name: PromptDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto.PromptDTO + name: prompt_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3 + - name: PromptDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.PromptDTO + name: prompt_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna + - name: PromptDTOQna + uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna.PromptDTOQna + name: prompt_dto_qna + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3 + - name: PromptDTOQna + uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.PromptDTOQna + name: prompt_dto_qna_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto + - name: QnADocumentsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto.QnADocumentsDTO + name: qn_adocuments_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3 + - name: QnADocumentsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.QnADocumentsDTO + name: qn_adocuments_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto + - name: QnADTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto.QnADTO + name: qn_adto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context + - name: QnADTOContext + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context.QnADTOContext + name: qn_adto_context + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3 + - name: QnADTOContext + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.QnADTOContext + name: qn_adto_context_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3 + - name: QnADTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.QnADTO + name: qn_adto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums + - name: EnvironmentType + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.EnvironmentType + - name: ErrorCodeType + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.ErrorCodeType + - name: OperationStateType + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.OperationStateType + - name: StrictFiltersCompoundOperationType + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_amaker_client_enums.StrictFiltersCompoundOperationType + name: qn_amaker_client_enums + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result + - name: QnASearchResult + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result.QnASearchResult + name: qn_asearch_result + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span + - name: QnASearchResultAnswerSpan + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span.QnASearchResultAnswerSpan + name: qn_asearch_result_answer_span + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3 + - name: QnASearchResultAnswerSpan + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.QnASearchResultAnswerSpan + name: qn_asearch_result_answer_span_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context + - name: QnASearchResultContext + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context.QnASearchResultContext + name: qn_asearch_result_context + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3 + - name: QnASearchResultContext + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.QnASearchResultContext + name: qn_asearch_result_context_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list + - name: QnASearchResultList + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list.QnASearchResultList + name: qn_asearch_result_list + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3 + - name: QnASearchResultList + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.QnASearchResultList + name: qn_asearch_result_list_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3 + - name: QnASearchResult + uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.QnASearchResult + name: qn_asearch_result_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto + - name: QueryContextDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto.QueryContextDTO + name: query_context_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3 + - name: QueryContextDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.QueryContextDTO + name: query_context_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto + - name: QueryDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto.QueryDTO + name: query_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request + - name: QueryDTOAnswerSpanRequest + uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request.QueryDTOAnswerSpanRequest + name: query_dto_answer_span_request + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3 + - name: QueryDTOAnswerSpanRequest + uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.QueryDTOAnswerSpanRequest + name: query_dto_answer_span_request_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context + - name: QueryDTOContext + uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context.QueryDTOContext + name: query_dto_context + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3 + - name: QueryDTOContext + uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.QueryDTOContext + name: query_dto_context_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3 + - name: QueryDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.QueryDTO + name: query_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto + - name: ReplaceKbDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto.ReplaceKbDTO + name: replace_kb_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3 + - name: ReplaceKbDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.replace_kb_dto_py3.ReplaceKbDTO + name: replace_kb_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto + - name: UpdateContextDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto.UpdateContextDTO + name: update_context_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3 + - name: UpdateContextDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.UpdateContextDTO + name: update_context_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto + - name: UpdateKbContentsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto.UpdateKbContentsDTO + name: update_kb_contents_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3 + - name: UpdateKbContentsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.UpdateKbContentsDTO + name: update_kb_contents_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto + - name: UpdateKbOperationDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto.UpdateKbOperationDTO + name: update_kb_operation_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add + - name: UpdateKbOperationDTOAdd + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add.UpdateKbOperationDTOAdd + name: update_kb_operation_dto_add + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3 + - name: UpdateKbOperationDTOAdd + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.UpdateKbOperationDTOAdd + name: update_kb_operation_dto_add_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete + - name: UpdateKbOperationDTODelete + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete.UpdateKbOperationDTODelete + name: update_kb_operation_dto_delete + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3 + - name: UpdateKbOperationDTODelete + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.UpdateKbOperationDTODelete + name: update_kb_operation_dto_delete_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3 + - name: UpdateKbOperationDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.UpdateKbOperationDTO + name: update_kb_operation_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update + - name: UpdateKbOperationDTOUpdate + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update.UpdateKbOperationDTOUpdate + name: update_kb_operation_dto_update + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3 + - name: UpdateKbOperationDTOUpdate + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.UpdateKbOperationDTOUpdate + name: update_kb_operation_dto_update_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto + - name: UpdateMetadataDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto.UpdateMetadataDTO + name: update_metadata_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3 + - name: UpdateMetadataDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.UpdateMetadataDTO + name: update_metadata_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto + - name: UpdateQnaDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto.UpdateQnaDTO + name: update_qna_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context + - name: UpdateQnaDTOContext + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context.UpdateQnaDTOContext + name: update_qna_dto_context + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3 + - name: UpdateQnaDTOContext + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.UpdateQnaDTOContext + name: update_qna_dto_context_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata + - name: UpdateQnaDTOMetadata + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata.UpdateQnaDTOMetadata + name: update_qna_dto_metadata + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3 + - name: UpdateQnaDTOMetadata + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.UpdateQnaDTOMetadata + name: update_qna_dto_metadata_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3 + - name: UpdateQnaDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.UpdateQnaDTO + name: update_qna_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions + - name: UpdateQnaDTOQuestions + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions.UpdateQnaDTOQuestions + name: update_qna_dto_questions + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3 + - name: UpdateQnaDTOQuestions + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.UpdateQnaDTOQuestions + name: update_qna_dto_questions_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto + - name: UpdateQuestionsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto.UpdateQuestionsDTO + name: update_questions_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3 + - name: UpdateQuestionsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.UpdateQuestionsDTO + name: update_questions_dto_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto + - name: WordAlterationsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto.WordAlterationsDTO + name: word_alterations_dto + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3 + - name: WordAlterationsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.word_alterations_dto_py3.WordAlterationsDTO + name: word_alterations_dto_py3 + - name: ActiveLearningSettingsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.ActiveLearningSettingsDTO + - name: AlterationsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.AlterationsDTO + - name: AnswerSpanRequestDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanRequestDTO + - name: AnswerSpanResponseDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanResponseDTO + - name: ContextDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.ContextDTO + - name: CreateKbDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.CreateKbDTO + - name: CreateKbInputDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.CreateKbInputDTO + - name: DeleteKbContentsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.DeleteKbContentsDTO + - name: EndpointKeysDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointKeysDTO + - name: EndpointSettingsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTO + - name: EndpointSettingsDTOActiveLearning + uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTOActiveLearning + - name: EnvironmentType + uid: azure.cognitiveservices.knowledge.qnamaker.models.EnvironmentType + - name: Error + uid: azure.cognitiveservices.knowledge.qnamaker.models.Error + - name: ErrorCodeType + uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorCodeType + - name: ErrorResponse + uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponse + - name: ErrorResponseError + uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseError + - name: ErrorResponseException + uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseException + - name: FeedbackRecordDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordDTO + - name: FeedbackRecordsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordsDTO + - name: FileDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.FileDTO + - name: InnerErrorModel + uid: azure.cognitiveservices.knowledge.qnamaker.models.InnerErrorModel + - name: KnowledgebaseDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebaseDTO + - name: KnowledgebasesDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebasesDTO + - name: MetadataDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.MetadataDTO + - name: Operation + uid: azure.cognitiveservices.knowledge.qnamaker.models.Operation + - name: OperationStateType + uid: azure.cognitiveservices.knowledge.qnamaker.models.OperationStateType + - name: PromptDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.PromptDTO + - name: PromptDTOQna + uid: azure.cognitiveservices.knowledge.qnamaker.models.PromptDTOQna + - name: QnADTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADTO + - name: QnADTOContext + uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADTOContext + - name: QnADocumentsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADocumentsDTO + - name: QnASearchResult + uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResult + - name: QnASearchResultAnswerSpan + uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultAnswerSpan + - name: QnASearchResultContext + uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultContext + - name: QnASearchResultList + uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultList + - name: QueryContextDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryContextDTO + - name: QueryDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTO + - name: QueryDTOAnswerSpanRequest + uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOAnswerSpanRequest + - name: QueryDTOContext + uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOContext + - name: ReplaceKbDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.ReplaceKbDTO + - name: StrictFiltersCompoundOperationType + uid: azure.cognitiveservices.knowledge.qnamaker.models.StrictFiltersCompoundOperationType + - name: UpdateContextDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateContextDTO + - name: UpdateKbContentsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbContentsDTO + - name: UpdateKbOperationDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTO + - name: UpdateKbOperationDTOAdd + uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOAdd + - name: UpdateKbOperationDTODelete + uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTODelete + - name: UpdateKbOperationDTOUpdate + uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOUpdate + - name: UpdateMetadataDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateMetadataDTO + - name: UpdateQnaDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTO + - name: UpdateQnaDTOContext + uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOContext + - name: UpdateQnaDTOMetadata + uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOMetadata + - name: UpdateQnaDTOQuestions + uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOQuestions + - name: UpdateQuestionsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQuestionsDTO + - name: WordAlterationsDTO + uid: azure.cognitiveservices.knowledge.qnamaker.models.WordAlterationsDTO + name: models + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.operations + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.operations.alterations_operations + - name: AlterationsOperations + uid: azure.cognitiveservices.knowledge.qnamaker.operations.alterations_operations.AlterationsOperations + name: alterations_operations + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_keys_operations + - name: EndpointKeysOperations + uid: azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_keys_operations.EndpointKeysOperations + name: endpoint_keys_operations + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_settings_operations + - name: EndpointSettingsOperations + uid: azure.cognitiveservices.knowledge.qnamaker.operations.endpoint_settings_operations.EndpointSettingsOperations + name: endpoint_settings_operations + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations + - name: KnowledgebaseOperations + uid: azure.cognitiveservices.knowledge.qnamaker.operations.knowledgebase_operations.KnowledgebaseOperations + name: knowledgebase_operations + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.operations.operations + - name: Operations + uid: azure.cognitiveservices.knowledge.qnamaker.operations.operations.Operations + name: operations + - name: AlterationsOperations + uid: azure.cognitiveservices.knowledge.qnamaker.operations.AlterationsOperations + - name: EndpointKeysOperations + uid: azure.cognitiveservices.knowledge.qnamaker.operations.EndpointKeysOperations + - name: EndpointSettingsOperations + uid: azure.cognitiveservices.knowledge.qnamaker.operations.EndpointSettingsOperations + - name: KnowledgebaseOperations + uid: azure.cognitiveservices.knowledge.qnamaker.operations.KnowledgebaseOperations + - name: Operations + uid: azure.cognitiveservices.knowledge.qnamaker.operations.Operations + name: operations + - items: + - name: Overview + uid: azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client + - name: QnAMakerClient + uid: azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.QnAMakerClient + - name: QnAMakerClientConfiguration + uid: azure.cognitiveservices.knowledge.qnamaker.qn_amaker_client.QnAMakerClientConfiguration + name: qn_amaker_client + - name: version + uid: azure.cognitiveservices.knowledge.qnamaker.version + - name: QnAMakerClient + uid: azure.cognitiveservices.knowledge.qnamaker.QnAMakerClient + name: azure.cognitiveservices.knowledge.qnamaker +- items: + - name: Overview + uid: azure.cognitiveservices.language.luis + - items: + - name: Overview + uid: azure.cognitiveservices.language.luis.authoring + - items: + - name: Overview + uid: azure.cognitiveservices.language.luis.authoring.models + - name: AppVersionSettingObject + uid: azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject + - name: ApplicationCreateObject + uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject + - name: ApplicationInfoResponse + uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse + - name: ApplicationPublishObject + uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject + - name: ApplicationSettingUpdateObject + uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject + - name: ApplicationSettings + uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettings + - name: ApplicationUpdateObject + uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject + - name: AvailableCulture + uid: azure.cognitiveservices.language.luis.authoring.models.AvailableCulture + - name: AvailablePrebuiltEntityModel + uid: azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel + - name: AzureAccountInfoObject + uid: azure.cognitiveservices.language.luis.authoring.models.AzureAccountInfoObject + - name: BatchLabelExample + uid: azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample + - name: ChildEntity + uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntity + - name: ChildEntityModelCreateObject + uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject + - name: ClosedList + uid: azure.cognitiveservices.language.luis.authoring.models.ClosedList + - name: ClosedListEntityExtractor + uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor + - name: ClosedListModelCreateObject + uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject + - name: ClosedListModelPatchObject + uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject + - name: ClosedListModelUpdateObject + uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject + - name: CollaboratorsArray + uid: azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray + - name: CompositeChildModelCreateObject + uid: azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject + - name: CompositeEntityExtractor + uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor + - name: CompositeEntityModel + uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel + - name: CustomPrebuiltModel + uid: azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel + - name: EndpointInfo + uid: azure.cognitiveservices.language.luis.authoring.models.EndpointInfo + - name: EnqueueTrainingResponse + uid: azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse + - name: EntitiesSuggestionExample + uid: azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample + - name: EntityExtractor + uid: azure.cognitiveservices.language.luis.authoring.models.EntityExtractor + - name: EntityLabel + uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabel + - name: EntityLabelObject + uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject + - name: EntityModelCreateObject + uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject + - name: EntityModelInfo + uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo + - name: EntityModelUpdateObject + uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject + - name: EntityPrediction + uid: azure.cognitiveservices.language.luis.authoring.models.EntityPrediction + - name: EntityRole + uid: azure.cognitiveservices.language.luis.authoring.models.EntityRole + - name: EntityRoleCreateObject + uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject + - name: EntityRoleUpdateObject + uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject + - name: ErrorResponse + uid: azure.cognitiveservices.language.luis.authoring.models.ErrorResponse + - name: ErrorResponseException + uid: azure.cognitiveservices.language.luis.authoring.models.ErrorResponseException + - name: ExampleLabelObject + uid: azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject + - name: ExplicitListItem + uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem + - name: ExplicitListItemCreateObject + uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject + - name: ExplicitListItemUpdateObject + uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject + - name: FeatureInfoObject + uid: azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject + - name: FeaturesResponseObject + uid: azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject + - name: HierarchicalChildEntity + uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity + - name: HierarchicalChildModelUpdateObject + uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject + - name: HierarchicalEntityExtractor + uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor + - name: HierarchicalModel + uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel + - name: HierarchicalModelV2 + uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2 + - name: IntentClassifier + uid: azure.cognitiveservices.language.luis.authoring.models.IntentClassifier + - name: IntentPrediction + uid: azure.cognitiveservices.language.luis.authoring.models.IntentPrediction + - name: IntentsSuggestionExample + uid: azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample + - name: JSONEntity + uid: azure.cognitiveservices.language.luis.authoring.models.JSONEntity + - name: JSONModelFeature + uid: azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature + - name: JSONRegexFeature + uid: azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature + - name: JSONUtterance + uid: azure.cognitiveservices.language.luis.authoring.models.JSONUtterance + - name: JsonChild + uid: azure.cognitiveservices.language.luis.authoring.models.JsonChild + - name: JsonModelFeatureInformation + uid: azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation + - name: LabelExampleResponse + uid: azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse + - name: LabelTextObject + uid: azure.cognitiveservices.language.luis.authoring.models.LabelTextObject + - name: LabeledUtterance + uid: azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance + - name: LuisApp + uid: azure.cognitiveservices.language.luis.authoring.models.LuisApp + - name: LuisAppV2 + uid: azure.cognitiveservices.language.luis.authoring.models.LuisAppV2 + - name: ModelCreateObject + uid: azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject + - name: ModelFeatureInformation + uid: azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation + - name: ModelInfo + uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfo + - name: ModelInfoResponse + uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse + - name: ModelTrainingDetails + uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails + - name: ModelTrainingInfo + uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo + - name: ModelUpdateObject + uid: azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject + - name: NDepthEntityExtractor + uid: azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor + - name: OperationError + uid: azure.cognitiveservices.language.luis.authoring.models.OperationError + - name: OperationStatus + uid: azure.cognitiveservices.language.luis.authoring.models.OperationStatus + - name: OperationStatusType + uid: azure.cognitiveservices.language.luis.authoring.models.OperationStatusType + - name: PatternAny + uid: azure.cognitiveservices.language.luis.authoring.models.PatternAny + - name: PatternAnyEntityExtractor + uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor + - name: PatternAnyModelCreateObject + uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject + - name: PatternAnyModelUpdateObject + uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject + - name: PatternFeatureInfo + uid: azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo + - name: PatternRule + uid: azure.cognitiveservices.language.luis.authoring.models.PatternRule + - name: PatternRuleCreateObject + uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject + - name: PatternRuleInfo + uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo + - name: PatternRuleUpdateObject + uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject + - name: PersonalAssistantsResponse + uid: azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse + - name: PhraseListFeatureInfo + uid: azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo + - name: PhraselistCreateObject + uid: azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject + - name: PhraselistUpdateObject + uid: azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject + - name: PrebuiltDomain + uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain + - name: PrebuiltDomainCreateBaseObject + uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject + - name: PrebuiltDomainCreateObject + uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject + - name: PrebuiltDomainItem + uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem + - name: PrebuiltDomainModelCreateObject + uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject + - name: PrebuiltDomainObject + uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject + - name: PrebuiltEntity + uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity + - name: PrebuiltEntityExtractor + uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor + - name: ProductionOrStagingEndpointInfo + uid: azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo + - name: PublishSettingUpdateObject + uid: azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject + - name: PublishSettings + uid: azure.cognitiveservices.language.luis.authoring.models.PublishSettings + - name: RegexEntity + uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntity + - name: RegexEntityExtractor + uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor + - name: RegexModelCreateObject + uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject + - name: RegexModelUpdateObject + uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject + - name: SubClosedList + uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedList + - name: SubClosedListResponse + uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse + - name: TaskUpdateObject + uid: azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject + - name: TrainingStatus + uid: azure.cognitiveservices.language.luis.authoring.models.TrainingStatus + - name: UserAccessList + uid: azure.cognitiveservices.language.luis.authoring.models.UserAccessList + - name: UserCollaborator + uid: azure.cognitiveservices.language.luis.authoring.models.UserCollaborator + - name: VersionInfo + uid: azure.cognitiveservices.language.luis.authoring.models.VersionInfo + - name: WordListBaseUpdateObject + uid: azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject + - name: WordListObject + uid: azure.cognitiveservices.language.luis.authoring.models.WordListObject + name: models + - items: + - name: Overview + uid: azure.cognitiveservices.language.luis.authoring.operations + - name: AppsOperations + uid: azure.cognitiveservices.language.luis.authoring.operations.AppsOperations + - name: AzureAccountsOperations + uid: azure.cognitiveservices.language.luis.authoring.operations.AzureAccountsOperations + - name: ExamplesOperations + uid: azure.cognitiveservices.language.luis.authoring.operations.ExamplesOperations + - name: FeaturesOperations + uid: azure.cognitiveservices.language.luis.authoring.operations.FeaturesOperations + - name: ModelOperations + uid: azure.cognitiveservices.language.luis.authoring.operations.ModelOperations + - name: PatternOperations + uid: azure.cognitiveservices.language.luis.authoring.operations.PatternOperations + - name: SettingsOperations + uid: azure.cognitiveservices.language.luis.authoring.operations.SettingsOperations + - name: TrainOperations + uid: azure.cognitiveservices.language.luis.authoring.operations.TrainOperations + - name: VersionsOperations + uid: azure.cognitiveservices.language.luis.authoring.operations.VersionsOperations + name: operations + - name: version + uid: azure.cognitiveservices.language.luis.authoring.version + - name: LUISAuthoringClient + uid: azure.cognitiveservices.language.luis.authoring.LUISAuthoringClient + - name: LUISAuthoringClientConfiguration + uid: azure.cognitiveservices.language.luis.authoring.LUISAuthoringClientConfiguration + name: authoring + - items: + - name: Overview + uid: azure.cognitiveservices.language.luis.runtime + - items: + - name: Overview + uid: azure.cognitiveservices.language.luis.runtime.models + - name: DynamicList + uid: azure.cognitiveservices.language.luis.runtime.models.DynamicList + - name: Error + uid: azure.cognitiveservices.language.luis.runtime.models.Error + - name: ErrorBody + uid: azure.cognitiveservices.language.luis.runtime.models.ErrorBody + - name: ErrorException + uid: azure.cognitiveservices.language.luis.runtime.models.ErrorException + - name: ExternalEntity + uid: azure.cognitiveservices.language.luis.runtime.models.ExternalEntity + - name: Intent + uid: azure.cognitiveservices.language.luis.runtime.models.Intent + - name: Prediction + uid: azure.cognitiveservices.language.luis.runtime.models.Prediction + - name: PredictionRequest + uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequest + - name: PredictionRequestOptions + uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions + - name: PredictionResponse + uid: azure.cognitiveservices.language.luis.runtime.models.PredictionResponse + - name: RequestList + uid: azure.cognitiveservices.language.luis.runtime.models.RequestList + - name: Sentiment + uid: azure.cognitiveservices.language.luis.runtime.models.Sentiment + name: models + - items: + - name: Overview + uid: azure.cognitiveservices.language.luis.runtime.operations + - name: PredictionOperations + uid: azure.cognitiveservices.language.luis.runtime.operations.PredictionOperations + name: operations + - name: version + uid: azure.cognitiveservices.language.luis.runtime.version + - name: LUISRuntimeClient + uid: azure.cognitiveservices.language.luis.runtime.LUISRuntimeClient + - name: LUISRuntimeClientConfiguration + uid: azure.cognitiveservices.language.luis.runtime.LUISRuntimeClientConfiguration + name: runtime + - name: version + uid: azure.cognitiveservices.language.luis.version + name: azure.cognitiveservices.language.luis +- items: + - name: Overview + uid: azure.cognitiveservices.language.spellcheck + - items: + - name: Overview + uid: azure.cognitiveservices.language.spellcheck.models + - name: ActionType + uid: azure.cognitiveservices.language.spellcheck.models.ActionType + - name: Answer + uid: azure.cognitiveservices.language.spellcheck.models.Answer + - name: Error + uid: azure.cognitiveservices.language.spellcheck.models.Error + - name: ErrorCode + uid: azure.cognitiveservices.language.spellcheck.models.ErrorCode + - name: ErrorResponse + uid: azure.cognitiveservices.language.spellcheck.models.ErrorResponse + - name: ErrorResponseException + uid: azure.cognitiveservices.language.spellcheck.models.ErrorResponseException + - name: ErrorSubCode + uid: azure.cognitiveservices.language.spellcheck.models.ErrorSubCode + - name: ErrorType + uid: azure.cognitiveservices.language.spellcheck.models.ErrorType + - name: Identifiable + uid: azure.cognitiveservices.language.spellcheck.models.Identifiable + - name: Mode + uid: azure.cognitiveservices.language.spellcheck.models.Mode + - name: Response + uid: azure.cognitiveservices.language.spellcheck.models.Response + - name: ResponseBase + uid: azure.cognitiveservices.language.spellcheck.models.ResponseBase + - name: SpellCheck + uid: azure.cognitiveservices.language.spellcheck.models.SpellCheck + - name: SpellingFlaggedToken + uid: azure.cognitiveservices.language.spellcheck.models.SpellingFlaggedToken + - name: SpellingTokenSuggestion + uid: azure.cognitiveservices.language.spellcheck.models.SpellingTokenSuggestion + name: models + - items: + - name: Overview + uid: azure.cognitiveservices.language.spellcheck.operations + - name: SpellCheckClientOperationsMixin + uid: azure.cognitiveservices.language.spellcheck.operations.SpellCheckClientOperationsMixin + name: operations + - name: version + uid: azure.cognitiveservices.language.spellcheck.version + - name: SpellCheckClient + uid: azure.cognitiveservices.language.spellcheck.SpellCheckClient + - name: SpellCheckClientConfiguration + uid: azure.cognitiveservices.language.spellcheck.SpellCheckClientConfiguration + name: azure.cognitiveservices.language.spellcheck +- items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.detected_language + - name: DetectedLanguage + uid: azure.cognitiveservices.language.textanalytics.models.detected_language.DetectedLanguage + name: detected_language + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.detected_language_py3 + - name: DetectedLanguage + uid: azure.cognitiveservices.language.textanalytics.models.detected_language_py3.DetectedLanguage + name: detected_language_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.document_statistics + - name: DocumentStatistics + uid: azure.cognitiveservices.language.textanalytics.models.document_statistics.DocumentStatistics + name: document_statistics + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.document_statistics_py3 + - name: DocumentStatistics + uid: azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.DocumentStatistics + name: document_statistics_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result + - name: EntitiesBatchResult + uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result.EntitiesBatchResult + name: entities_batch_result + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item + - name: EntitiesBatchResultItem + uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item.EntitiesBatchResultItem + name: entities_batch_result_item + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3 + - name: EntitiesBatchResultItem + uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3.EntitiesBatchResultItem + name: entities_batch_result_item_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3 + - name: EntitiesBatchResult + uid: azure.cognitiveservices.language.textanalytics.models.entities_batch_result_py3.EntitiesBatchResult + name: entities_batch_result_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.entity_record + - name: EntityRecord + uid: azure.cognitiveservices.language.textanalytics.models.entity_record.EntityRecord + name: entity_record + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.entity_record_py3 + - name: EntityRecord + uid: azure.cognitiveservices.language.textanalytics.models.entity_record_py3.EntityRecord + name: entity_record_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.error_record + - name: ErrorRecord + uid: azure.cognitiveservices.language.textanalytics.models.error_record.ErrorRecord + name: error_record + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.error_record_py3 + - name: ErrorRecord + uid: azure.cognitiveservices.language.textanalytics.models.error_record_py3.ErrorRecord + name: error_record_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.error_response + - name: ErrorResponse + uid: azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponse + - name: ErrorResponseException + uid: azure.cognitiveservices.language.textanalytics.models.error_response.ErrorResponseException + name: error_response + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.error_response_py3 + - name: ErrorResponse + uid: azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponse + - name: ErrorResponseException + uid: azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponseException + name: error_response_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.internal_error + - name: InternalError + uid: azure.cognitiveservices.language.textanalytics.models.internal_error.InternalError + name: internal_error + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.internal_error_py3 + - name: InternalError + uid: azure.cognitiveservices.language.textanalytics.models.internal_error_py3.InternalError + name: internal_error_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result + - name: KeyPhraseBatchResult + uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result.KeyPhraseBatchResult + name: key_phrase_batch_result + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item + - name: KeyPhraseBatchResultItem + uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item.KeyPhraseBatchResultItem + name: key_phrase_batch_result_item + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3 + - name: KeyPhraseBatchResultItem + uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3.KeyPhraseBatchResultItem + name: key_phrase_batch_result_item_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3 + - name: KeyPhraseBatchResult + uid: azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_py3.KeyPhraseBatchResult + name: key_phrase_batch_result_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.language_batch_input + - name: LanguageBatchInput + uid: azure.cognitiveservices.language.textanalytics.models.language_batch_input.LanguageBatchInput + name: language_batch_input + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3 + - name: LanguageBatchInput + uid: azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.LanguageBatchInput + name: language_batch_input_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result + - name: LanguageBatchResult + uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result.LanguageBatchResult + name: language_batch_result + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item + - name: LanguageBatchResultItem + uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item.LanguageBatchResultItem + name: language_batch_result_item + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3 + - name: LanguageBatchResultItem + uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.LanguageBatchResultItem + name: language_batch_result_item_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3 + - name: LanguageBatchResult + uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_py3.LanguageBatchResult + name: language_batch_result_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.language_input + - name: LanguageInput + uid: azure.cognitiveservices.language.textanalytics.models.language_input.LanguageInput + name: language_input + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.language_input_py3 + - name: LanguageInput + uid: azure.cognitiveservices.language.textanalytics.models.language_input_py3.LanguageInput + name: language_input_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.match_record + - name: MatchRecord + uid: azure.cognitiveservices.language.textanalytics.models.match_record.MatchRecord + name: match_record + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.match_record_py3 + - name: MatchRecord + uid: azure.cognitiveservices.language.textanalytics.models.match_record_py3.MatchRecord + name: match_record_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input + - name: MultiLanguageBatchInput + uid: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input.MultiLanguageBatchInput + name: multi_language_batch_input + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3 + - name: MultiLanguageBatchInput + uid: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.MultiLanguageBatchInput + name: multi_language_batch_input_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.multi_language_input + - name: MultiLanguageInput + uid: azure.cognitiveservices.language.textanalytics.models.multi_language_input.MultiLanguageInput + name: multi_language_input + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3 + - name: MultiLanguageInput + uid: azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.MultiLanguageInput + name: multi_language_input_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.request_statistics + - name: RequestStatistics + uid: azure.cognitiveservices.language.textanalytics.models.request_statistics.RequestStatistics + name: request_statistics + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.request_statistics_py3 + - name: RequestStatistics + uid: azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.RequestStatistics + name: request_statistics_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result + - name: SentimentBatchResult + uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result.SentimentBatchResult + name: sentiment_batch_result + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item + - name: SentimentBatchResultItem + uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item.SentimentBatchResultItem + name: sentiment_batch_result_item + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3 + - name: SentimentBatchResultItem + uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.SentimentBatchResultItem + name: sentiment_batch_result_item_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3 + - name: SentimentBatchResult + uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_py3.SentimentBatchResult + name: sentiment_batch_result_py3 + - name: DetectedLanguage + uid: azure.cognitiveservices.language.textanalytics.models.DetectedLanguage + - name: DocumentStatistics + uid: azure.cognitiveservices.language.textanalytics.models.DocumentStatistics + - name: EntitiesBatchResult + uid: azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResult + - name: EntitiesBatchResultItem + uid: azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResultItem + - name: EntityRecord + uid: azure.cognitiveservices.language.textanalytics.models.EntityRecord + - name: ErrorRecord + uid: azure.cognitiveservices.language.textanalytics.models.ErrorRecord + - name: ErrorResponse + uid: azure.cognitiveservices.language.textanalytics.models.ErrorResponse + - name: ErrorResponseException + uid: azure.cognitiveservices.language.textanalytics.models.ErrorResponseException + - name: InternalError + uid: azure.cognitiveservices.language.textanalytics.models.InternalError + - name: KeyPhraseBatchResult + uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResult + - name: KeyPhraseBatchResultItem + uid: azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResultItem + - name: LanguageBatchInput + uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchInput + - name: LanguageBatchResult + uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchResult + - name: LanguageBatchResultItem + uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchResultItem + - name: LanguageInput + uid: azure.cognitiveservices.language.textanalytics.models.LanguageInput + - name: MatchRecord + uid: azure.cognitiveservices.language.textanalytics.models.MatchRecord + - name: MultiLanguageBatchInput + uid: azure.cognitiveservices.language.textanalytics.models.MultiLanguageBatchInput + - name: MultiLanguageInput + uid: azure.cognitiveservices.language.textanalytics.models.MultiLanguageInput + - name: RequestStatistics + uid: azure.cognitiveservices.language.textanalytics.models.RequestStatistics + - name: SentimentBatchResult + uid: azure.cognitiveservices.language.textanalytics.models.SentimentBatchResult + - name: SentimentBatchResultItem + uid: azure.cognitiveservices.language.textanalytics.models.SentimentBatchResultItem + name: models + - items: + - name: Overview + uid: azure.cognitiveservices.language.textanalytics.text_analytics_client + - name: TextAnalyticsClient + uid: azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClient + - name: TextAnalyticsClientConfiguration + uid: azure.cognitiveservices.language.textanalytics.text_analytics_client.TextAnalyticsClientConfiguration + name: text_analytics_client + - name: version + uid: azure.cognitiveservices.language.textanalytics.version + - name: TextAnalyticsClient + uid: azure.cognitiveservices.language.textanalytics.TextAnalyticsClient + name: azure.cognitiveservices.language.textanalytics +- items: + - name: Overview + uid: azure.cognitiveservices.search.newssearch + - items: + - name: Overview + uid: azure.cognitiveservices.search.newssearch.models + - name: Answer + uid: azure.cognitiveservices.search.newssearch.models.Answer + - name: Article + uid: azure.cognitiveservices.search.newssearch.models.Article + - name: CreativeWork + uid: azure.cognitiveservices.search.newssearch.models.CreativeWork + - name: Error + uid: azure.cognitiveservices.search.newssearch.models.Error + - name: ErrorCode + uid: azure.cognitiveservices.search.newssearch.models.ErrorCode + - name: ErrorResponse + uid: azure.cognitiveservices.search.newssearch.models.ErrorResponse + - name: ErrorResponseException + uid: azure.cognitiveservices.search.newssearch.models.ErrorResponseException + - name: ErrorSubCode + uid: azure.cognitiveservices.search.newssearch.models.ErrorSubCode + - name: Freshness + uid: azure.cognitiveservices.search.newssearch.models.Freshness + - name: Identifiable + uid: azure.cognitiveservices.search.newssearch.models.Identifiable + - name: ImageObject + uid: azure.cognitiveservices.search.newssearch.models.ImageObject + - name: MediaObject + uid: azure.cognitiveservices.search.newssearch.models.MediaObject + - name: News + uid: azure.cognitiveservices.search.newssearch.models.News + - name: NewsArticle + uid: azure.cognitiveservices.search.newssearch.models.NewsArticle + - name: NewsTopic + uid: azure.cognitiveservices.search.newssearch.models.NewsTopic + - name: Organization + uid: azure.cognitiveservices.search.newssearch.models.Organization + - name: Query + uid: azure.cognitiveservices.search.newssearch.models.Query + - name: Response + uid: azure.cognitiveservices.search.newssearch.models.Response + - name: ResponseBase + uid: azure.cognitiveservices.search.newssearch.models.ResponseBase + - name: SafeSearch + uid: azure.cognitiveservices.search.newssearch.models.SafeSearch + - name: SearchResultsAnswer + uid: azure.cognitiveservices.search.newssearch.models.SearchResultsAnswer + - name: TextFormat + uid: azure.cognitiveservices.search.newssearch.models.TextFormat + - name: Thing + uid: azure.cognitiveservices.search.newssearch.models.Thing + - name: TrendingTopics + uid: azure.cognitiveservices.search.newssearch.models.TrendingTopics + - name: VideoObject + uid: azure.cognitiveservices.search.newssearch.models.VideoObject + name: models + - items: + - name: Overview + uid: azure.cognitiveservices.search.newssearch.operations + - name: NewsOperations + uid: azure.cognitiveservices.search.newssearch.operations.NewsOperations + name: operations + - name: version + uid: azure.cognitiveservices.search.newssearch.version + - name: NewsSearchClient + uid: azure.cognitiveservices.search.newssearch.NewsSearchClient + - name: NewsSearchClientConfiguration + uid: azure.cognitiveservices.search.newssearch.NewsSearchClientConfiguration + name: azure.cognitiveservices.search.newssearch +- items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.action + - name: Action + uid: azure.cognitiveservices.search.visualsearch.models.action.Action + name: action + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.action_py3 + - name: Action + uid: azure.cognitiveservices.search.visualsearch.models.action_py3.Action + name: action_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.aggregate_offer + - name: AggregateOffer + uid: azure.cognitiveservices.search.visualsearch.models.aggregate_offer.AggregateOffer + name: aggregate_offer + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3 + - name: AggregateOffer + uid: azure.cognitiveservices.search.visualsearch.models.aggregate_offer_py3.AggregateOffer + name: aggregate_offer_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.aggregate_rating + - name: AggregateRating + uid: azure.cognitiveservices.search.visualsearch.models.aggregate_rating.AggregateRating + name: aggregate_rating + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3 + - name: AggregateRating + uid: azure.cognitiveservices.search.visualsearch.models.aggregate_rating_py3.AggregateRating + name: aggregate_rating_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.creative_work + - name: CreativeWork + uid: azure.cognitiveservices.search.visualsearch.models.creative_work.CreativeWork + name: creative_work + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.creative_work_py3 + - name: CreativeWork + uid: azure.cognitiveservices.search.visualsearch.models.creative_work_py3.CreativeWork + name: creative_work_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.crop_area + - name: CropArea + uid: azure.cognitiveservices.search.visualsearch.models.crop_area.CropArea + name: crop_area + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.crop_area_py3 + - name: CropArea + uid: azure.cognitiveservices.search.visualsearch.models.crop_area_py3.CropArea + name: crop_area_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.error + - name: Error + uid: azure.cognitiveservices.search.visualsearch.models.error.Error + name: error + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.error_py3 + - name: Error + uid: azure.cognitiveservices.search.visualsearch.models.error_py3.Error + name: error_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.error_response + - name: ErrorResponse + uid: azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponse + - name: ErrorResponseException + uid: azure.cognitiveservices.search.visualsearch.models.error_response.ErrorResponseException + name: error_response + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.error_response_py3 + - name: ErrorResponse + uid: azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponse + - name: ErrorResponseException + uid: azure.cognitiveservices.search.visualsearch.models.error_response_py3.ErrorResponseException + name: error_response_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.filters + - name: Filters + uid: azure.cognitiveservices.search.visualsearch.models.filters.Filters + name: filters + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.filters_py3 + - name: Filters + uid: azure.cognitiveservices.search.visualsearch.models.filters_py3.Filters + name: filters_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.identifiable + - name: Identifiable + uid: azure.cognitiveservices.search.visualsearch.models.identifiable.Identifiable + name: identifiable + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.identifiable_py3 + - name: Identifiable + uid: azure.cognitiveservices.search.visualsearch.models.identifiable_py3.Identifiable + name: identifiable_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.image_action + - name: ImageAction + uid: azure.cognitiveservices.search.visualsearch.models.image_action.ImageAction + name: image_action + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.image_action_py3 + - name: ImageAction + uid: azure.cognitiveservices.search.visualsearch.models.image_action_py3.ImageAction + name: image_action_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.image_entity_action + - name: ImageEntityAction + uid: azure.cognitiveservices.search.visualsearch.models.image_entity_action.ImageEntityAction + name: image_entity_action + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3 + - name: ImageEntityAction + uid: azure.cognitiveservices.search.visualsearch.models.image_entity_action_py3.ImageEntityAction + name: image_entity_action_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.image_info + - name: ImageInfo + uid: azure.cognitiveservices.search.visualsearch.models.image_info.ImageInfo + name: image_info + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.image_info_py3 + - name: ImageInfo + uid: azure.cognitiveservices.search.visualsearch.models.image_info_py3.ImageInfo + name: image_info_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.image_knowledge + - name: ImageKnowledge + uid: azure.cognitiveservices.search.visualsearch.models.image_knowledge.ImageKnowledge + name: image_knowledge + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3 + - name: ImageKnowledge + uid: azure.cognitiveservices.search.visualsearch.models.image_knowledge_py3.ImageKnowledge + name: image_knowledge_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.image_module_action + - name: ImageModuleAction + uid: azure.cognitiveservices.search.visualsearch.models.image_module_action.ImageModuleAction + name: image_module_action + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.image_module_action_py3 + - name: ImageModuleAction + uid: azure.cognitiveservices.search.visualsearch.models.image_module_action_py3.ImageModuleAction + name: image_module_action_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.image_object + - name: ImageObject + uid: azure.cognitiveservices.search.visualsearch.models.image_object.ImageObject + name: image_object + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.image_object_py3 + - name: ImageObject + uid: azure.cognitiveservices.search.visualsearch.models.image_object_py3.ImageObject + name: image_object_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.image_recipes_action + - name: ImageRecipesAction + uid: azure.cognitiveservices.search.visualsearch.models.image_recipes_action.ImageRecipesAction + name: image_recipes_action + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3 + - name: ImageRecipesAction + uid: azure.cognitiveservices.search.visualsearch.models.image_recipes_action_py3.ImageRecipesAction + name: image_recipes_action_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action + - name: ImageRelatedSearchesAction + uid: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action.ImageRelatedSearchesAction + name: image_related_searches_action + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3 + - name: ImageRelatedSearchesAction + uid: azure.cognitiveservices.search.visualsearch.models.image_related_searches_action_py3.ImageRelatedSearchesAction + name: image_related_searches_action_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action + - name: ImageShoppingSourcesAction + uid: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action.ImageShoppingSourcesAction + name: image_shopping_sources_action + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3 + - name: ImageShoppingSourcesAction + uid: azure.cognitiveservices.search.visualsearch.models.image_shopping_sources_action_py3.ImageShoppingSourcesAction + name: image_shopping_sources_action_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.image_tag + - name: ImageTag + uid: azure.cognitiveservices.search.visualsearch.models.image_tag.ImageTag + name: image_tag + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.image_tag_py3 + - name: ImageTag + uid: azure.cognitiveservices.search.visualsearch.models.image_tag_py3.ImageTag + name: image_tag_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.image_tag_region + - name: ImageTagRegion + uid: azure.cognitiveservices.search.visualsearch.models.image_tag_region.ImageTagRegion + name: image_tag_region + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3 + - name: ImageTagRegion + uid: azure.cognitiveservices.search.visualsearch.models.image_tag_region_py3.ImageTagRegion + name: image_tag_region_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.images_image_metadata + - name: ImagesImageMetadata + uid: azure.cognitiveservices.search.visualsearch.models.images_image_metadata.ImagesImageMetadata + name: images_image_metadata + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3 + - name: ImagesImageMetadata + uid: azure.cognitiveservices.search.visualsearch.models.images_image_metadata_py3.ImagesImageMetadata + name: images_image_metadata_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.images_module + - name: ImagesModule + uid: azure.cognitiveservices.search.visualsearch.models.images_module.ImagesModule + name: images_module + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.images_module_py3 + - name: ImagesModule + uid: azure.cognitiveservices.search.visualsearch.models.images_module_py3.ImagesModule + name: images_module_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.intangible + - name: Intangible + uid: azure.cognitiveservices.search.visualsearch.models.intangible.Intangible + name: intangible + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.intangible_py3 + - name: Intangible + uid: azure.cognitiveservices.search.visualsearch.models.intangible_py3.Intangible + name: intangible_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.knowledge_request + - name: KnowledgeRequest + uid: azure.cognitiveservices.search.visualsearch.models.knowledge_request.KnowledgeRequest + name: knowledge_request + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3 + - name: KnowledgeRequest + uid: azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.KnowledgeRequest + name: knowledge_request_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.media_object + - name: MediaObject + uid: azure.cognitiveservices.search.visualsearch.models.media_object.MediaObject + name: media_object + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.media_object_py3 + - name: MediaObject + uid: azure.cognitiveservices.search.visualsearch.models.media_object_py3.MediaObject + name: media_object_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral + - name: NormalizedQuadrilateral + uid: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral.NormalizedQuadrilateral + name: normalized_quadrilateral + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3 + - name: NormalizedQuadrilateral + uid: azure.cognitiveservices.search.visualsearch.models.normalized_quadrilateral_py3.NormalizedQuadrilateral + name: normalized_quadrilateral_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.offer + - name: Offer + uid: azure.cognitiveservices.search.visualsearch.models.offer.Offer + name: offer + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.offer_py3 + - name: Offer + uid: azure.cognitiveservices.search.visualsearch.models.offer_py3.Offer + name: offer_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.organization + - name: Organization + uid: azure.cognitiveservices.search.visualsearch.models.organization.Organization + name: organization + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.organization_py3 + - name: Organization + uid: azure.cognitiveservices.search.visualsearch.models.organization_py3.Organization + name: organization_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.person + - name: Person + uid: azure.cognitiveservices.search.visualsearch.models.person.Person + name: person + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.person_py3 + - name: Person + uid: azure.cognitiveservices.search.visualsearch.models.person_py3.Person + name: person_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.point2_d + - name: Point2D + uid: azure.cognitiveservices.search.visualsearch.models.point2_d.Point2D + name: point2_d + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.point2_d_py3 + - name: Point2D + uid: azure.cognitiveservices.search.visualsearch.models.point2_d_py3.Point2D + name: point2_d_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.properties_item + - name: PropertiesItem + uid: azure.cognitiveservices.search.visualsearch.models.properties_item.PropertiesItem + name: properties_item + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.properties_item_py3 + - name: PropertiesItem + uid: azure.cognitiveservices.search.visualsearch.models.properties_item_py3.PropertiesItem + name: properties_item_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.query + - name: Query + uid: azure.cognitiveservices.search.visualsearch.models.query.Query + name: query + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.query_py3 + - name: Query + uid: azure.cognitiveservices.search.visualsearch.models.query_py3.Query + name: query_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.rating + - name: Rating + uid: azure.cognitiveservices.search.visualsearch.models.rating.Rating + name: rating + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.rating_py3 + - name: Rating + uid: azure.cognitiveservices.search.visualsearch.models.rating_py3.Rating + name: rating_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.recipe + - name: Recipe + uid: azure.cognitiveservices.search.visualsearch.models.recipe.Recipe + name: recipe + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.recipe_py3 + - name: Recipe + uid: azure.cognitiveservices.search.visualsearch.models.recipe_py3.Recipe + name: recipe_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.recipes_module + - name: RecipesModule + uid: azure.cognitiveservices.search.visualsearch.models.recipes_module.RecipesModule + name: recipes_module + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.recipes_module_py3 + - name: RecipesModule + uid: azure.cognitiveservices.search.visualsearch.models.recipes_module_py3.RecipesModule + name: recipes_module_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.related_searches_module + - name: RelatedSearchesModule + uid: azure.cognitiveservices.search.visualsearch.models.related_searches_module.RelatedSearchesModule + name: related_searches_module + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3 + - name: RelatedSearchesModule + uid: azure.cognitiveservices.search.visualsearch.models.related_searches_module_py3.RelatedSearchesModule + name: related_searches_module_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.response + - name: Response + uid: azure.cognitiveservices.search.visualsearch.models.response.Response + name: response + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.response_base + - name: ResponseBase + uid: azure.cognitiveservices.search.visualsearch.models.response_base.ResponseBase + name: response_base + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.response_base_py3 + - name: ResponseBase + uid: azure.cognitiveservices.search.visualsearch.models.response_base_py3.ResponseBase + name: response_base_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.response_py3 + - name: Response + uid: azure.cognitiveservices.search.visualsearch.models.response_py3.Response + name: response_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.structured_value + - name: StructuredValue + uid: azure.cognitiveservices.search.visualsearch.models.structured_value.StructuredValue + name: structured_value + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.structured_value_py3 + - name: StructuredValue + uid: azure.cognitiveservices.search.visualsearch.models.structured_value_py3.StructuredValue + name: structured_value_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.thing + - name: Thing + uid: azure.cognitiveservices.search.visualsearch.models.thing.Thing + name: thing + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.thing_py3 + - name: Thing + uid: azure.cognitiveservices.search.visualsearch.models.thing_py3.Thing + name: thing_py3 + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums + - name: Currency + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.Currency + - name: ErrorCode + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorCode + - name: ErrorSubCode + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ErrorSubCode + - name: ItemAvailability + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.ItemAvailability + - name: SafeSearch + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_client_enums.SafeSearch + name: visual_search_client_enums + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_request + - name: VisualSearchRequest + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_request.VisualSearchRequest + name: visual_search_request + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3 + - name: VisualSearchRequest + uid: azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.VisualSearchRequest + name: visual_search_request_py3 + - name: Action + uid: azure.cognitiveservices.search.visualsearch.models.Action + - name: AggregateOffer + uid: azure.cognitiveservices.search.visualsearch.models.AggregateOffer + - name: AggregateRating + uid: azure.cognitiveservices.search.visualsearch.models.AggregateRating + - name: CreativeWork + uid: azure.cognitiveservices.search.visualsearch.models.CreativeWork + - name: CropArea + uid: azure.cognitiveservices.search.visualsearch.models.CropArea + - name: Currency + uid: azure.cognitiveservices.search.visualsearch.models.Currency + - name: Error + uid: azure.cognitiveservices.search.visualsearch.models.Error + - name: ErrorCode + uid: azure.cognitiveservices.search.visualsearch.models.ErrorCode + - name: ErrorResponse + uid: azure.cognitiveservices.search.visualsearch.models.ErrorResponse + - name: ErrorResponseException + uid: azure.cognitiveservices.search.visualsearch.models.ErrorResponseException + - name: ErrorSubCode + uid: azure.cognitiveservices.search.visualsearch.models.ErrorSubCode + - name: Filters + uid: azure.cognitiveservices.search.visualsearch.models.Filters + - name: Identifiable + uid: azure.cognitiveservices.search.visualsearch.models.Identifiable + - name: ImageAction + uid: azure.cognitiveservices.search.visualsearch.models.ImageAction + - name: ImageEntityAction + uid: azure.cognitiveservices.search.visualsearch.models.ImageEntityAction + - name: ImageInfo + uid: azure.cognitiveservices.search.visualsearch.models.ImageInfo + - name: ImageKnowledge + uid: azure.cognitiveservices.search.visualsearch.models.ImageKnowledge + - name: ImageModuleAction + uid: azure.cognitiveservices.search.visualsearch.models.ImageModuleAction + - name: ImageObject + uid: azure.cognitiveservices.search.visualsearch.models.ImageObject + - name: ImageRecipesAction + uid: azure.cognitiveservices.search.visualsearch.models.ImageRecipesAction + - name: ImageRelatedSearchesAction + uid: azure.cognitiveservices.search.visualsearch.models.ImageRelatedSearchesAction + - name: ImageShoppingSourcesAction + uid: azure.cognitiveservices.search.visualsearch.models.ImageShoppingSourcesAction + - name: ImageTag + uid: azure.cognitiveservices.search.visualsearch.models.ImageTag + - name: ImageTagRegion + uid: azure.cognitiveservices.search.visualsearch.models.ImageTagRegion + - name: ImagesImageMetadata + uid: azure.cognitiveservices.search.visualsearch.models.ImagesImageMetadata + - name: ImagesModule + uid: azure.cognitiveservices.search.visualsearch.models.ImagesModule + - name: Intangible + uid: azure.cognitiveservices.search.visualsearch.models.Intangible + - name: ItemAvailability + uid: azure.cognitiveservices.search.visualsearch.models.ItemAvailability + - name: KnowledgeRequest + uid: azure.cognitiveservices.search.visualsearch.models.KnowledgeRequest + - name: MediaObject + uid: azure.cognitiveservices.search.visualsearch.models.MediaObject + - name: NormalizedQuadrilateral + uid: azure.cognitiveservices.search.visualsearch.models.NormalizedQuadrilateral + - name: Offer + uid: azure.cognitiveservices.search.visualsearch.models.Offer + - name: Organization + uid: azure.cognitiveservices.search.visualsearch.models.Organization + - name: Person + uid: azure.cognitiveservices.search.visualsearch.models.Person + - name: Point2D + uid: azure.cognitiveservices.search.visualsearch.models.Point2D + - name: PropertiesItem + uid: azure.cognitiveservices.search.visualsearch.models.PropertiesItem + - name: Query + uid: azure.cognitiveservices.search.visualsearch.models.Query + - name: Rating + uid: azure.cognitiveservices.search.visualsearch.models.Rating + - name: Recipe + uid: azure.cognitiveservices.search.visualsearch.models.Recipe + - name: RecipesModule + uid: azure.cognitiveservices.search.visualsearch.models.RecipesModule + - name: RelatedSearchesModule + uid: azure.cognitiveservices.search.visualsearch.models.RelatedSearchesModule + - name: Response + uid: azure.cognitiveservices.search.visualsearch.models.Response + - name: ResponseBase + uid: azure.cognitiveservices.search.visualsearch.models.ResponseBase + - name: SafeSearch + uid: azure.cognitiveservices.search.visualsearch.models.SafeSearch + - name: StructuredValue + uid: azure.cognitiveservices.search.visualsearch.models.StructuredValue + - name: Thing + uid: azure.cognitiveservices.search.visualsearch.models.Thing + - name: VisualSearchRequest + uid: azure.cognitiveservices.search.visualsearch.models.VisualSearchRequest + name: models + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.operations + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.operations.images_operations + - name: ImagesOperations + uid: azure.cognitiveservices.search.visualsearch.operations.images_operations.ImagesOperations + name: images_operations + - name: ImagesOperations + uid: azure.cognitiveservices.search.visualsearch.operations.ImagesOperations + name: operations + - name: version + uid: azure.cognitiveservices.search.visualsearch.version + - items: + - name: Overview + uid: azure.cognitiveservices.search.visualsearch.visual_search_client + - name: VisualSearchClient + uid: azure.cognitiveservices.search.visualsearch.visual_search_client.VisualSearchClient + - name: VisualSearchClientConfiguration + uid: azure.cognitiveservices.search.visualsearch.visual_search_client.VisualSearchClientConfiguration + name: visual_search_client + - name: VisualSearchClient + uid: azure.cognitiveservices.search.visualsearch.VisualSearchClient + name: azure.cognitiveservices.search.visualsearch +- items: + - name: Overview + uid: azure.cognitiveservices.vision.computervision + - items: + - name: Overview + uid: azure.cognitiveservices.vision.computervision.models + - name: AdultInfo + uid: azure.cognitiveservices.vision.computervision.models.AdultInfo + - name: AnalyzeResults + uid: azure.cognitiveservices.vision.computervision.models.AnalyzeResults + - name: Appearance + uid: azure.cognitiveservices.vision.computervision.models.Appearance + - name: AreaOfInterestResult + uid: azure.cognitiveservices.vision.computervision.models.AreaOfInterestResult + - name: BoundingRect + uid: azure.cognitiveservices.vision.computervision.models.BoundingRect + - name: Category + uid: azure.cognitiveservices.vision.computervision.models.Category + - name: CategoryDetail + uid: azure.cognitiveservices.vision.computervision.models.CategoryDetail + - name: CelebritiesModel + uid: azure.cognitiveservices.vision.computervision.models.CelebritiesModel + - name: ColorInfo + uid: azure.cognitiveservices.vision.computervision.models.ColorInfo + - name: ComputerVisionError + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionError + - name: ComputerVisionErrorCodes + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorCodes + - name: ComputerVisionErrorResponse + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponse + - name: ComputerVisionErrorResponseException + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionErrorResponseException + - name: ComputerVisionInnerError + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerError + - name: ComputerVisionInnerErrorCodeValue + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionInnerErrorCodeValue + - name: ComputerVisionOcrError + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrError + - name: ComputerVisionOcrErrorException + uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrErrorException + - name: DescriptionExclude + uid: azure.cognitiveservices.vision.computervision.models.DescriptionExclude + - name: Details + uid: azure.cognitiveservices.vision.computervision.models.Details + - name: DetectResult + uid: azure.cognitiveservices.vision.computervision.models.DetectResult + - name: DetectedBrand + uid: azure.cognitiveservices.vision.computervision.models.DetectedBrand + - name: DetectedObject + uid: azure.cognitiveservices.vision.computervision.models.DetectedObject + - name: DomainModelResults + uid: azure.cognitiveservices.vision.computervision.models.DomainModelResults + - name: FaceDescription + uid: azure.cognitiveservices.vision.computervision.models.FaceDescription + - name: FaceRectangle + uid: azure.cognitiveservices.vision.computervision.models.FaceRectangle + - name: Gender + uid: azure.cognitiveservices.vision.computervision.models.Gender + - name: ImageAnalysis + uid: azure.cognitiveservices.vision.computervision.models.ImageAnalysis + - name: ImageCaption + uid: azure.cognitiveservices.vision.computervision.models.ImageCaption + - name: ImageDescription + uid: azure.cognitiveservices.vision.computervision.models.ImageDescription + - name: ImageDescriptionDetails + uid: azure.cognitiveservices.vision.computervision.models.ImageDescriptionDetails + - name: ImageMetadata + uid: azure.cognitiveservices.vision.computervision.models.ImageMetadata + - name: ImageTag + uid: azure.cognitiveservices.vision.computervision.models.ImageTag + - name: ImageType + uid: azure.cognitiveservices.vision.computervision.models.ImageType + - name: ImageUrl + uid: azure.cognitiveservices.vision.computervision.models.ImageUrl + - name: LandmarksModel + uid: azure.cognitiveservices.vision.computervision.models.LandmarksModel + - name: Line + uid: azure.cognitiveservices.vision.computervision.models.Line + - name: ListModelsResult + uid: azure.cognitiveservices.vision.computervision.models.ListModelsResult + - name: ModelDescription + uid: azure.cognitiveservices.vision.computervision.models.ModelDescription + - name: ObjectHierarchy + uid: azure.cognitiveservices.vision.computervision.models.ObjectHierarchy + - name: OcrDetectionLanguage + uid: azure.cognitiveservices.vision.computervision.models.OcrDetectionLanguage + - name: OcrLanguages + uid: azure.cognitiveservices.vision.computervision.models.OcrLanguages + - name: OcrLine + uid: azure.cognitiveservices.vision.computervision.models.OcrLine + - name: OcrRegion + uid: azure.cognitiveservices.vision.computervision.models.OcrRegion + - name: OcrResult + uid: azure.cognitiveservices.vision.computervision.models.OcrResult + - name: OcrWord + uid: azure.cognitiveservices.vision.computervision.models.OcrWord + - name: OperationStatusCodes + uid: azure.cognitiveservices.vision.computervision.models.OperationStatusCodes + - name: ReadOperationResult + uid: azure.cognitiveservices.vision.computervision.models.ReadOperationResult + - name: ReadResult + uid: azure.cognitiveservices.vision.computervision.models.ReadResult + - name: Style + uid: azure.cognitiveservices.vision.computervision.models.Style + - name: TagResult + uid: azure.cognitiveservices.vision.computervision.models.TagResult + - name: TextRecognitionResultDimensionUnit + uid: azure.cognitiveservices.vision.computervision.models.TextRecognitionResultDimensionUnit + - name: TextStyle + uid: azure.cognitiveservices.vision.computervision.models.TextStyle + - name: VisualFeatureTypes + uid: azure.cognitiveservices.vision.computervision.models.VisualFeatureTypes + - name: Word + uid: azure.cognitiveservices.vision.computervision.models.Word + name: models + - items: + - name: Overview + uid: azure.cognitiveservices.vision.computervision.operations + - name: ComputerVisionClientOperationsMixin + uid: azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin + name: operations + - name: version + uid: azure.cognitiveservices.vision.computervision.version + - name: ComputerVisionClient + uid: azure.cognitiveservices.vision.computervision.ComputerVisionClient + - name: ComputerVisionClientConfiguration + uid: azure.cognitiveservices.vision.computervision.ComputerVisionClientConfiguration + name: azure.cognitiveservices.vision.computervision +- items: + - name: Overview + uid: azure.cognitiveservices.vision.contentmoderator + - items: + - name: Overview + uid: azure.cognitiveservices.vision.contentmoderator.models + - name: APIError + uid: azure.cognitiveservices.vision.contentmoderator.models.APIError + - name: APIErrorException + uid: azure.cognitiveservices.vision.contentmoderator.models.APIErrorException + - name: Address + uid: azure.cognitiveservices.vision.contentmoderator.models.Address + - name: Body + uid: azure.cognitiveservices.vision.contentmoderator.models.Body + - name: BodyModel + uid: azure.cognitiveservices.vision.contentmoderator.models.BodyModel + - name: Candidate + uid: azure.cognitiveservices.vision.contentmoderator.models.Candidate + - name: Classification + uid: azure.cognitiveservices.vision.contentmoderator.models.Classification + - name: ClassificationCategory1 + uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory1 + - name: ClassificationCategory2 + uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory2 + - name: ClassificationCategory3 + uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory3 + - name: Content + uid: azure.cognitiveservices.vision.contentmoderator.models.Content + - name: CreateReviewBodyItem + uid: azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItem + - name: CreateReviewBodyItemMetadataItem + uid: azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItemMetadataItem + - name: CreateVideoReviewsBodyItem + uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItem + - name: CreateVideoReviewsBodyItemMetadataItem + uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemMetadataItem + - name: CreateVideoReviewsBodyItemVideoFramesItem + uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItem + - name: CreateVideoReviewsBodyItemVideoFramesItemMetadataItem + uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemMetadataItem + - name: CreateVideoReviewsBodyItemVideoFramesItemReviewerResultTagsItem + uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItemReviewerResultTagsItem + - name: DetectedLanguage + uid: azure.cognitiveservices.vision.contentmoderator.models.DetectedLanguage + - name: DetectedTerms + uid: azure.cognitiveservices.vision.contentmoderator.models.DetectedTerms + - name: Email + uid: azure.cognitiveservices.vision.contentmoderator.models.Email + - name: Error + uid: azure.cognitiveservices.vision.contentmoderator.models.Error + - name: Evaluate + uid: azure.cognitiveservices.vision.contentmoderator.models.Evaluate + - name: Face + uid: azure.cognitiveservices.vision.contentmoderator.models.Face + - name: FoundFaces + uid: azure.cognitiveservices.vision.contentmoderator.models.FoundFaces + - name: Frame + uid: azure.cognitiveservices.vision.contentmoderator.models.Frame + - name: Frames + uid: azure.cognitiveservices.vision.contentmoderator.models.Frames + - name: IPA + uid: azure.cognitiveservices.vision.contentmoderator.models.IPA + - name: Image + uid: azure.cognitiveservices.vision.contentmoderator.models.Image + - name: ImageAdditionalInfoItem + uid: azure.cognitiveservices.vision.contentmoderator.models.ImageAdditionalInfoItem + - name: ImageIds + uid: azure.cognitiveservices.vision.contentmoderator.models.ImageIds + - name: ImageList + uid: azure.cognitiveservices.vision.contentmoderator.models.ImageList + - name: Job + uid: azure.cognitiveservices.vision.contentmoderator.models.Job + - name: JobExecutionReportDetails + uid: azure.cognitiveservices.vision.contentmoderator.models.JobExecutionReportDetails + - name: JobId + uid: azure.cognitiveservices.vision.contentmoderator.models.JobId + - name: JobListResult + uid: azure.cognitiveservices.vision.contentmoderator.models.JobListResult + - name: KeyValuePair + uid: azure.cognitiveservices.vision.contentmoderator.models.KeyValuePair + - name: Match + uid: azure.cognitiveservices.vision.contentmoderator.models.Match + - name: MatchResponse + uid: azure.cognitiveservices.vision.contentmoderator.models.MatchResponse + - name: OCR + uid: azure.cognitiveservices.vision.contentmoderator.models.OCR + - name: PII + uid: azure.cognitiveservices.vision.contentmoderator.models.PII + - name: Phone + uid: azure.cognitiveservices.vision.contentmoderator.models.Phone + - name: RefreshIndex + uid: azure.cognitiveservices.vision.contentmoderator.models.RefreshIndex + - name: Review + uid: azure.cognitiveservices.vision.contentmoderator.models.Review + - name: SSN + uid: azure.cognitiveservices.vision.contentmoderator.models.SSN + - name: Screen + uid: azure.cognitiveservices.vision.contentmoderator.models.Screen + - name: Status + uid: azure.cognitiveservices.vision.contentmoderator.models.Status + - name: Tag + uid: azure.cognitiveservices.vision.contentmoderator.models.Tag + - name: TermList + uid: azure.cognitiveservices.vision.contentmoderator.models.TermList + - name: Terms + uid: azure.cognitiveservices.vision.contentmoderator.models.Terms + - name: TermsData + uid: azure.cognitiveservices.vision.contentmoderator.models.TermsData + - name: TermsInList + uid: azure.cognitiveservices.vision.contentmoderator.models.TermsInList + - name: TermsPaging + uid: azure.cognitiveservices.vision.contentmoderator.models.TermsPaging + - name: TranscriptModerationBodyItem + uid: azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItem + - name: TranscriptModerationBodyItemTermsItem + uid: azure.cognitiveservices.vision.contentmoderator.models.TranscriptModerationBodyItemTermsItem + - name: VideoFrameBodyItem + uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItem + - name: VideoFrameBodyItemMetadataItem + uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemMetadataItem + - name: VideoFrameBodyItemReviewerResultTagsItem + uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItemReviewerResultTagsItem + name: models + - items: + - name: Overview + uid: azure.cognitiveservices.vision.contentmoderator.operations + - items: + - name: Overview + uid: azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations + - name: ImageModerationOperations + uid: azure.cognitiveservices.vision.contentmoderator.operations.image_moderation_operations.ImageModerationOperations + name: image_moderation_operations + - items: + - name: Overview + uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations + - name: ListManagementImageListsOperations + uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_lists_operations.ListManagementImageListsOperations + name: list_management_image_lists_operations + - items: + - name: Overview + uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations + - name: ListManagementImageOperations + uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_image_operations.ListManagementImageOperations + name: list_management_image_operations + - items: + - name: Overview + uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations + - name: ListManagementTermListsOperations + uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_lists_operations.ListManagementTermListsOperations + name: list_management_term_lists_operations + - items: + - name: Overview + uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_operations + - name: ListManagementTermOperations + uid: azure.cognitiveservices.vision.contentmoderator.operations.list_management_term_operations.ListManagementTermOperations + name: list_management_term_operations + - items: + - name: Overview + uid: azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations + - name: ReviewsOperations + uid: azure.cognitiveservices.vision.contentmoderator.operations.reviews_operations.ReviewsOperations + name: reviews_operations + - items: + - name: Overview + uid: azure.cognitiveservices.vision.contentmoderator.operations.text_moderation_operations + - name: TextModerationOperations + uid: azure.cognitiveservices.vision.contentmoderator.operations.text_moderation_operations.TextModerationOperations + name: text_moderation_operations + - name: ImageModerationOperations + uid: azure.cognitiveservices.vision.contentmoderator.operations.ImageModerationOperations + - name: ListManagementImageListsOperations + uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageListsOperations + - name: ListManagementImageOperations + uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementImageOperations + - name: ListManagementTermListsOperations + uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermListsOperations + - name: ListManagementTermOperations + uid: azure.cognitiveservices.vision.contentmoderator.operations.ListManagementTermOperations + - name: ReviewsOperations + uid: azure.cognitiveservices.vision.contentmoderator.operations.ReviewsOperations + - name: TextModerationOperations + uid: azure.cognitiveservices.vision.contentmoderator.operations.TextModerationOperations + name: operations + - items: + - name: Overview + uid: azure.cognitiveservices.vision.contentmoderator.content_moderator_client + - name: ContentModeratorClient + uid: azure.cognitiveservices.vision.contentmoderator.content_moderator_client.ContentModeratorClient + - name: ContentModeratorClientConfiguration + uid: azure.cognitiveservices.vision.contentmoderator.content_moderator_client.ContentModeratorClientConfiguration + name: content_moderator_client + - name: version + uid: azure.cognitiveservices.vision.contentmoderator.version + - name: ContentModeratorClient + uid: azure.cognitiveservices.vision.contentmoderator.ContentModeratorClient + name: azure.cognitiveservices.vision.contentmoderator +- items: + - name: Overview + uid: azure.cognitiveservices.vision.customvision + - items: + - name: Overview + uid: azure.cognitiveservices.vision.customvision.prediction + - items: + - name: Overview + uid: azure.cognitiveservices.vision.customvision.prediction.models + - name: BoundingBox + uid: azure.cognitiveservices.vision.customvision.prediction.models.BoundingBox + - name: CustomVisionError + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionError + - name: CustomVisionErrorCodes + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorCodes + - name: CustomVisionErrorException + uid: azure.cognitiveservices.vision.customvision.prediction.models.CustomVisionErrorException + - name: ImagePrediction + uid: azure.cognitiveservices.vision.customvision.prediction.models.ImagePrediction + - name: ImageUrl + uid: azure.cognitiveservices.vision.customvision.prediction.models.ImageUrl + - name: Prediction + uid: azure.cognitiveservices.vision.customvision.prediction.models.Prediction + - name: TagType + uid: azure.cognitiveservices.vision.customvision.prediction.models.TagType + name: models + - items: + - name: Overview + uid: azure.cognitiveservices.vision.customvision.prediction.operations + - name: CustomVisionPredictionClientOperationsMixin + uid: azure.cognitiveservices.vision.customvision.prediction.operations.CustomVisionPredictionClientOperationsMixin + name: operations + - name: version + uid: azure.cognitiveservices.vision.customvision.prediction.version + - name: CustomVisionPredictionClient + uid: azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClient + - name: CustomVisionPredictionClientConfiguration + uid: azure.cognitiveservices.vision.customvision.prediction.CustomVisionPredictionClientConfiguration + name: prediction + - items: + - name: Overview + uid: azure.cognitiveservices.vision.customvision.training + - items: + - name: Overview + uid: azure.cognitiveservices.vision.customvision.training.models + - name: BoundingBox + uid: azure.cognitiveservices.vision.customvision.training.models.BoundingBox + - name: Classifier + uid: azure.cognitiveservices.vision.customvision.training.models.Classifier + - name: CreateProjectOptions + uid: azure.cognitiveservices.vision.customvision.training.models.CreateProjectOptions + - name: CustomBaseModelInfo + uid: azure.cognitiveservices.vision.customvision.training.models.CustomBaseModelInfo + - name: CustomVisionError + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionError + - name: CustomVisionErrorCodes + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorCodes + - name: CustomVisionErrorException + uid: azure.cognitiveservices.vision.customvision.training.models.CustomVisionErrorException + - name: Domain + uid: azure.cognitiveservices.vision.customvision.training.models.Domain + - name: DomainType + uid: azure.cognitiveservices.vision.customvision.training.models.DomainType + - name: Export + uid: azure.cognitiveservices.vision.customvision.training.models.Export + - name: ExportFlavor + uid: azure.cognitiveservices.vision.customvision.training.models.ExportFlavor + - name: ExportPlatform + uid: azure.cognitiveservices.vision.customvision.training.models.ExportPlatform + - name: ExportStatus + uid: azure.cognitiveservices.vision.customvision.training.models.ExportStatus + - name: Image + uid: azure.cognitiveservices.vision.customvision.training.models.Image + - name: ImageCreateResult + uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateResult + - name: ImageCreateStatus + uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateStatus + - name: ImageCreateSummary + uid: azure.cognitiveservices.vision.customvision.training.models.ImageCreateSummary + - name: ImageFileCreateBatch + uid: azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateBatch + - name: ImageFileCreateEntry + uid: azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateEntry + - name: ImageIdCreateBatch + uid: azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateBatch + - name: ImageIdCreateEntry + uid: azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateEntry + - name: ImageMetadataUpdateEntry + uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateEntry + - name: ImageMetadataUpdateStatus + uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateStatus + - name: ImageMetadataUpdateSummary + uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateSummary + - name: ImagePerformance + uid: azure.cognitiveservices.vision.customvision.training.models.ImagePerformance + - name: ImagePrediction + uid: azure.cognitiveservices.vision.customvision.training.models.ImagePrediction + - name: ImageProcessingSettings + uid: azure.cognitiveservices.vision.customvision.training.models.ImageProcessingSettings + - name: ImageRegion + uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegion + - name: ImageRegionCreateBatch + uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateBatch + - name: ImageRegionCreateEntry + uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateEntry + - name: ImageRegionCreateResult + uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateResult + - name: ImageRegionCreateSummary + uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateSummary + - name: ImageRegionProposal + uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionProposal + - name: ImageTag + uid: azure.cognitiveservices.vision.customvision.training.models.ImageTag + - name: ImageTagCreateBatch + uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateBatch + - name: ImageTagCreateEntry + uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateEntry + - name: ImageTagCreateSummary + uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateSummary + - name: ImageUrl + uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrl + - name: ImageUrlCreateBatch + uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateBatch + - name: ImageUrlCreateEntry + uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateEntry + - name: Iteration + uid: azure.cognitiveservices.vision.customvision.training.models.Iteration + - name: IterationPerformance + uid: azure.cognitiveservices.vision.customvision.training.models.IterationPerformance + - name: ModelInformation + uid: azure.cognitiveservices.vision.customvision.training.models.ModelInformation + - name: OrderBy + uid: azure.cognitiveservices.vision.customvision.training.models.OrderBy + - name: Prediction + uid: azure.cognitiveservices.vision.customvision.training.models.Prediction + - name: PredictionQueryResult + uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryResult + - name: PredictionQueryTag + uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryTag + - name: PredictionQueryToken + uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryToken + - name: Project + uid: azure.cognitiveservices.vision.customvision.training.models.Project + - name: ProjectExport + uid: azure.cognitiveservices.vision.customvision.training.models.ProjectExport + - name: ProjectSettings + uid: azure.cognitiveservices.vision.customvision.training.models.ProjectSettings + - name: ProjectStatus + uid: azure.cognitiveservices.vision.customvision.training.models.ProjectStatus + - name: Region + uid: azure.cognitiveservices.vision.customvision.training.models.Region + - name: RegionProposal + uid: azure.cognitiveservices.vision.customvision.training.models.RegionProposal + - name: SortBy + uid: azure.cognitiveservices.vision.customvision.training.models.SortBy + - name: StoredImagePrediction + uid: azure.cognitiveservices.vision.customvision.training.models.StoredImagePrediction + - name: StoredSuggestedTagAndRegion + uid: azure.cognitiveservices.vision.customvision.training.models.StoredSuggestedTagAndRegion + - name: SuggestedTagAndRegion + uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegion + - name: SuggestedTagAndRegionQuery + uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQuery + - name: SuggestedTagAndRegionQueryToken + uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQueryToken + - name: Tag + uid: azure.cognitiveservices.vision.customvision.training.models.Tag + - name: TagFilter + uid: azure.cognitiveservices.vision.customvision.training.models.TagFilter + - name: TagPerformance + uid: azure.cognitiveservices.vision.customvision.training.models.TagPerformance + - name: TagType + uid: azure.cognitiveservices.vision.customvision.training.models.TagType + - name: TrainingParameters + uid: azure.cognitiveservices.vision.customvision.training.models.TrainingParameters + - name: TrainingType + uid: azure.cognitiveservices.vision.customvision.training.models.TrainingType + name: models + - items: + - name: Overview + uid: azure.cognitiveservices.vision.customvision.training.operations + - name: CustomVisionTrainingClientOperationsMixin + uid: azure.cognitiveservices.vision.customvision.training.operations.CustomVisionTrainingClientOperationsMixin + name: operations + - name: version + uid: azure.cognitiveservices.vision.customvision.training.version + - name: CustomVisionTrainingClient + uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClient + - name: CustomVisionTrainingClientConfiguration + uid: azure.cognitiveservices.vision.customvision.training.CustomVisionTrainingClientConfiguration + name: training + - name: version + uid: azure.cognitiveservices.vision.customvision.version + name: azure.cognitiveservices.vision.customvision +- items: + - name: Overview + uid: azure.cognitiveservices.vision.face + - items: + - name: Overview + uid: azure.cognitiveservices.vision.face.models + - name: APIError + uid: azure.cognitiveservices.vision.face.models.APIError + - name: APIErrorException + uid: azure.cognitiveservices.vision.face.models.APIErrorException + - name: Accessory + uid: azure.cognitiveservices.vision.face.models.Accessory + - name: AccessoryType + uid: azure.cognitiveservices.vision.face.models.AccessoryType + - name: ApplySnapshotRequest + uid: azure.cognitiveservices.vision.face.models.ApplySnapshotRequest + - name: Blur + uid: azure.cognitiveservices.vision.face.models.Blur + - name: BlurLevel + uid: azure.cognitiveservices.vision.face.models.BlurLevel + - name: Coordinate + uid: azure.cognitiveservices.vision.face.models.Coordinate + - name: DetectedFace + uid: azure.cognitiveservices.vision.face.models.DetectedFace + - name: DetectionModel + uid: azure.cognitiveservices.vision.face.models.DetectionModel + - name: Emotion + uid: azure.cognitiveservices.vision.face.models.Emotion + - name: Error + uid: azure.cognitiveservices.vision.face.models.Error + - name: Exposure + uid: azure.cognitiveservices.vision.face.models.Exposure + - name: ExposureLevel + uid: azure.cognitiveservices.vision.face.models.ExposureLevel + - name: FaceAttributeType + uid: azure.cognitiveservices.vision.face.models.FaceAttributeType + - name: FaceAttributes + uid: azure.cognitiveservices.vision.face.models.FaceAttributes + - name: FaceLandmarks + uid: azure.cognitiveservices.vision.face.models.FaceLandmarks + - name: FaceList + uid: azure.cognitiveservices.vision.face.models.FaceList + - name: FaceRectangle + uid: azure.cognitiveservices.vision.face.models.FaceRectangle + - name: FacialHair + uid: azure.cognitiveservices.vision.face.models.FacialHair + - name: FindSimilarMatchMode + uid: azure.cognitiveservices.vision.face.models.FindSimilarMatchMode + - name: FindSimilarRequest + uid: azure.cognitiveservices.vision.face.models.FindSimilarRequest + - name: Gender + uid: azure.cognitiveservices.vision.face.models.Gender + - name: GlassesType + uid: azure.cognitiveservices.vision.face.models.GlassesType + - name: GroupRequest + uid: azure.cognitiveservices.vision.face.models.GroupRequest + - name: GroupResult + uid: azure.cognitiveservices.vision.face.models.GroupResult + - name: Hair + uid: azure.cognitiveservices.vision.face.models.Hair + - name: HairColor + uid: azure.cognitiveservices.vision.face.models.HairColor + - name: HairColorType + uid: azure.cognitiveservices.vision.face.models.HairColorType + - name: HeadPose + uid: azure.cognitiveservices.vision.face.models.HeadPose + - name: IdentifyCandidate + uid: azure.cognitiveservices.vision.face.models.IdentifyCandidate + - name: IdentifyRequest + uid: azure.cognitiveservices.vision.face.models.IdentifyRequest + - name: IdentifyResult + uid: azure.cognitiveservices.vision.face.models.IdentifyResult + - name: ImageUrl + uid: azure.cognitiveservices.vision.face.models.ImageUrl + - name: LargeFaceList + uid: azure.cognitiveservices.vision.face.models.LargeFaceList + - name: LargePersonGroup + uid: azure.cognitiveservices.vision.face.models.LargePersonGroup + - name: Makeup + uid: azure.cognitiveservices.vision.face.models.Makeup + - name: Mask + uid: azure.cognitiveservices.vision.face.models.Mask + - name: MaskType + uid: azure.cognitiveservices.vision.face.models.MaskType + - name: MetaDataContract + uid: azure.cognitiveservices.vision.face.models.MetaDataContract + - name: NameAndUserDataContract + uid: azure.cognitiveservices.vision.face.models.NameAndUserDataContract + - name: Noise + uid: azure.cognitiveservices.vision.face.models.Noise + - name: NoiseLevel + uid: azure.cognitiveservices.vision.face.models.NoiseLevel + - name: Occlusion + uid: azure.cognitiveservices.vision.face.models.Occlusion + - name: OperationStatus + uid: azure.cognitiveservices.vision.face.models.OperationStatus + - name: OperationStatusType + uid: azure.cognitiveservices.vision.face.models.OperationStatusType + - name: PersistedFace + uid: azure.cognitiveservices.vision.face.models.PersistedFace + - name: Person + uid: azure.cognitiveservices.vision.face.models.Person + - name: PersonGroup + uid: azure.cognitiveservices.vision.face.models.PersonGroup + - name: QualityForRecognition + uid: azure.cognitiveservices.vision.face.models.QualityForRecognition + - name: RecognitionModel + uid: azure.cognitiveservices.vision.face.models.RecognitionModel + - name: SimilarFace + uid: azure.cognitiveservices.vision.face.models.SimilarFace + - name: Snapshot + uid: azure.cognitiveservices.vision.face.models.Snapshot + - name: SnapshotApplyMode + uid: azure.cognitiveservices.vision.face.models.SnapshotApplyMode + - name: SnapshotObjectType + uid: azure.cognitiveservices.vision.face.models.SnapshotObjectType + - name: TakeSnapshotRequest + uid: azure.cognitiveservices.vision.face.models.TakeSnapshotRequest + - name: TrainingStatus + uid: azure.cognitiveservices.vision.face.models.TrainingStatus + - name: TrainingStatusType + uid: azure.cognitiveservices.vision.face.models.TrainingStatusType + - name: UpdateFaceRequest + uid: azure.cognitiveservices.vision.face.models.UpdateFaceRequest + - name: UpdateSnapshotRequest + uid: azure.cognitiveservices.vision.face.models.UpdateSnapshotRequest + - name: VerifyFaceToFaceRequest + uid: azure.cognitiveservices.vision.face.models.VerifyFaceToFaceRequest + - name: VerifyFaceToPersonRequest + uid: azure.cognitiveservices.vision.face.models.VerifyFaceToPersonRequest + - name: VerifyResult + uid: azure.cognitiveservices.vision.face.models.VerifyResult + name: models + - items: + - name: Overview + uid: azure.cognitiveservices.vision.face.operations + - name: FaceListOperations + uid: azure.cognitiveservices.vision.face.operations.FaceListOperations + - name: FaceOperations + uid: azure.cognitiveservices.vision.face.operations.FaceOperations + - name: LargeFaceListOperations + uid: azure.cognitiveservices.vision.face.operations.LargeFaceListOperations + - name: LargePersonGroupOperations + uid: azure.cognitiveservices.vision.face.operations.LargePersonGroupOperations + - name: LargePersonGroupPersonOperations + uid: azure.cognitiveservices.vision.face.operations.LargePersonGroupPersonOperations + - name: PersonGroupOperations + uid: azure.cognitiveservices.vision.face.operations.PersonGroupOperations + - name: PersonGroupPersonOperations + uid: azure.cognitiveservices.vision.face.operations.PersonGroupPersonOperations + - name: SnapshotOperations + uid: azure.cognitiveservices.vision.face.operations.SnapshotOperations + name: operations + - name: version + uid: azure.cognitiveservices.vision.face.version + - name: FaceClient + uid: azure.cognitiveservices.vision.face.FaceClient + - name: FaceClientConfiguration + uid: azure.cognitiveservices.vision.face.FaceClientConfiguration + name: azure.cognitiveservices.vision.face +- items: + - name: Overview + uid: azure.common + - name: client_factory + uid: azure.common.client_factory + - name: cloud + uid: azure.common.cloud + - name: credentials + uid: azure.common.credentials + - name: exceptions + uid: azure.common.exceptions + - name: AzureConflictHttpError + uid: azure.common.AzureConflictHttpError + - name: AzureException + uid: azure.common.AzureException + - name: AzureHttpError + uid: azure.common.AzureHttpError + - name: AzureMissingResourceHttpError + uid: azure.common.AzureMissingResourceHttpError + name: azure.common +- items: + - name: Overview + uid: azure.profiles + - items: + - name: Overview + uid: azure.profiles.multiapiclient + - name: InvalidMultiApiClientError + uid: azure.profiles.multiapiclient.InvalidMultiApiClientError + - name: MultiApiClientMixin + uid: azure.profiles.multiapiclient.MultiApiClientMixin + name: multiapiclient + - name: DefaultProfile + uid: azure.profiles.DefaultProfile + - name: KnownProfiles + uid: azure.profiles.KnownProfiles + - name: ProfileDefinition + uid: azure.profiles.ProfileDefinition + name: azure.profiles +- items: + - name: Overview + uid: azure.communication.networktraversal + - items: + - name: Overview + uid: azure.communication.networktraversal.aio + - name: CommunicationRelayClient + uid: azure.communication.networktraversal.aio.CommunicationRelayClient + name: aio + name: azure.communication.networktraversal +- items: + - name: Overview + uid: azure.cosmos + - items: + - name: Overview + uid: azure.cosmos.execution_context + - name: aggregators + uid: azure.cosmos.execution_context.aggregators + - name: base_execution_context + uid: azure.cosmos.execution_context.base_execution_context + - name: document_producer + uid: azure.cosmos.execution_context.document_producer + - name: endpoint_component + uid: azure.cosmos.execution_context.endpoint_component + - name: execution_dispatcher + uid: azure.cosmos.execution_context.execution_dispatcher + - name: multi_execution_aggregator + uid: azure.cosmos.execution_context.multi_execution_aggregator + - name: query_execution_info + uid: azure.cosmos.execution_context.query_execution_info + name: execution_context + - items: + - name: Overview + uid: azure.cosmos.routing + - name: collection_routing_map + uid: azure.cosmos.routing.collection_routing_map + - name: routing_map_provider + uid: azure.cosmos.routing.routing_map_provider + - name: routing_range + uid: azure.cosmos.routing.routing_range + name: routing + - name: auth + uid: azure.cosmos.auth + - name: base + uid: azure.cosmos.base + - name: consistent_hash_ring + uid: azure.cosmos.consistent_hash_ring + - name: constants + uid: azure.cosmos.constants + - items: + - name: Overview + uid: azure.cosmos.cosmos_client + - name: CosmosClient + uid: azure.cosmos.cosmos_client.CosmosClient + name: cosmos_client + - name: default_retry_policy + uid: azure.cosmos.default_retry_policy + - items: + - name: Overview + uid: azure.cosmos.documents + - name: ConnectionMode + uid: azure.cosmos.documents.ConnectionMode + - name: ConnectionPolicy + uid: azure.cosmos.documents.ConnectionPolicy + - name: ConsistencyLevel + uid: azure.cosmos.documents.ConsistencyLevel + - name: DataType + uid: azure.cosmos.documents.DataType + - name: DatabaseAccount + uid: azure.cosmos.documents.DatabaseAccount + - name: IndexKind + uid: azure.cosmos.documents.IndexKind + - name: IndexingDirective + uid: azure.cosmos.documents.IndexingDirective + - name: IndexingMode + uid: azure.cosmos.documents.IndexingMode + - name: MediaReadMode + uid: azure.cosmos.documents.MediaReadMode + - name: PartitionKind + uid: azure.cosmos.documents.PartitionKind + - name: PermissionMode + uid: azure.cosmos.documents.PermissionMode + - name: ProxyConfiguration + uid: azure.cosmos.documents.ProxyConfiguration + - name: SSLConfiguration + uid: azure.cosmos.documents.SSLConfiguration + - name: TriggerOperation + uid: azure.cosmos.documents.TriggerOperation + - name: TriggerType + uid: azure.cosmos.documents.TriggerType + - name: Undefined + uid: azure.cosmos.documents.Undefined + name: documents + - name: endpoint_discovery_retry_policy + uid: azure.cosmos.endpoint_discovery_retry_policy + - items: + - name: Overview + uid: azure.cosmos.errors + - name: CosmosError + uid: azure.cosmos.errors.CosmosError + - name: HTTPFailure + uid: azure.cosmos.errors.HTTPFailure + - name: JSONParseFailure + uid: azure.cosmos.errors.JSONParseFailure + - name: UnexpectedDataType + uid: azure.cosmos.errors.UnexpectedDataType + name: errors + - name: global_endpoint_manager + uid: azure.cosmos.global_endpoint_manager + - items: + - name: Overview + uid: azure.cosmos.hash_partition_resolver + - name: HashPartitionResolver + uid: azure.cosmos.hash_partition_resolver.HashPartitionResolver + name: hash_partition_resolver + - items: + - name: Overview + uid: azure.cosmos.http_constants + - name: CookieHeaders + uid: azure.cosmos.http_constants.CookieHeaders + - name: Delimiters + uid: azure.cosmos.http_constants.Delimiters + - name: HttpContextProperties + uid: azure.cosmos.http_constants.HttpContextProperties + - name: HttpHeaderPreferenceTokens + uid: azure.cosmos.http_constants.HttpHeaderPreferenceTokens + - name: HttpHeaders + uid: azure.cosmos.http_constants.HttpHeaders + - name: HttpListenerErrorCodes + uid: azure.cosmos.http_constants.HttpListenerErrorCodes + - name: HttpMethods + uid: azure.cosmos.http_constants.HttpMethods + - name: HttpStatusDescriptions + uid: azure.cosmos.http_constants.HttpStatusDescriptions + - name: QueryStrings + uid: azure.cosmos.http_constants.QueryStrings + - name: ResourceType + uid: azure.cosmos.http_constants.ResourceType + - name: StatusCodes + uid: azure.cosmos.http_constants.StatusCodes + - name: SubStatusCodes + uid: azure.cosmos.http_constants.SubStatusCodes + - name: Versions + uid: azure.cosmos.http_constants.Versions + name: http_constants + - items: + - name: Overview + uid: azure.cosmos.location_cache + - name: EndpointOperationType + uid: azure.cosmos.location_cache.EndpointOperationType + - name: LocationCache + uid: azure.cosmos.location_cache.LocationCache + name: location_cache + - name: murmur_hash + uid: azure.cosmos.murmur_hash + - name: partition + uid: azure.cosmos.partition + - items: + - name: Overview + uid: azure.cosmos.query_iterable + - items: + - name: Overview + uid: azure.cosmos.query_iterable.QueryIterable + - name: Iterator + uid: azure.cosmos.query_iterable.QueryIterable.Iterator + name: QueryIterable + name: query_iterable + - items: + - name: Overview + uid: azure.cosmos.range + - name: Range + uid: azure.cosmos.range.Range + name: range + - items: + - name: Overview + uid: azure.cosmos.range_partition_resolver + - name: RangePartitionResolver + uid: azure.cosmos.range_partition_resolver.RangePartitionResolver + name: range_partition_resolver + - name: request_object + uid: azure.cosmos.request_object + - name: resource_throttle_retry_policy + uid: azure.cosmos.resource_throttle_retry_policy + - items: + - name: Overview + uid: azure.cosmos.retry_options + - name: RetryOptions + uid: azure.cosmos.retry_options.RetryOptions + name: retry_options + - name: retry_utility + uid: azure.cosmos.retry_utility + - items: + - name: Overview + uid: azure.cosmos.runtime_constants + - name: MediaTypes + uid: azure.cosmos.runtime_constants.MediaTypes + name: runtime_constants + - items: + - name: Overview + uid: azure.cosmos.session + - name: Session + uid: azure.cosmos.session.Session + - name: SessionContainer + uid: azure.cosmos.session.SessionContainer + name: session + - name: session_retry_policy + uid: azure.cosmos.session_retry_policy + - name: synchronized_request + uid: azure.cosmos.synchronized_request + - name: utils + uid: azure.cosmos.utils + - items: + - name: Overview + uid: azure.cosmos.vector_session_token + - name: VectorSessionToken + uid: azure.cosmos.vector_session_token.VectorSessionToken + name: vector_session_token + name: azure.cosmos +- items: + - name: Overview + uid: azure.graphrbac + - items: + - name: Overview + uid: azure.graphrbac.models + - items: + - name: Overview + uid: azure.graphrbac.models.ad_group + - name: ADGroup + uid: azure.graphrbac.models.ad_group.ADGroup + name: ad_group + - items: + - name: Overview + uid: azure.graphrbac.models.ad_group_paged + - name: ADGroupPaged + uid: azure.graphrbac.models.ad_group_paged.ADGroupPaged + name: ad_group_paged + - items: + - name: Overview + uid: azure.graphrbac.models.ad_group_py3 + - name: ADGroup + uid: azure.graphrbac.models.ad_group_py3.ADGroup + name: ad_group_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.add_owner_parameters + - name: AddOwnerParameters + uid: azure.graphrbac.models.add_owner_parameters.AddOwnerParameters + name: add_owner_parameters + - items: + - name: Overview + uid: azure.graphrbac.models.add_owner_parameters_py3 + - name: AddOwnerParameters + uid: azure.graphrbac.models.add_owner_parameters_py3.AddOwnerParameters + name: add_owner_parameters_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.app_role + - name: AppRole + uid: azure.graphrbac.models.app_role.AppRole + name: app_role + - items: + - name: Overview + uid: azure.graphrbac.models.app_role_py3 + - name: AppRole + uid: azure.graphrbac.models.app_role_py3.AppRole + name: app_role_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.application + - name: Application + uid: azure.graphrbac.models.application.Application + name: application + - items: + - name: Overview + uid: azure.graphrbac.models.application_base + - name: ApplicationBase + uid: azure.graphrbac.models.application_base.ApplicationBase + name: application_base + - items: + - name: Overview + uid: azure.graphrbac.models.application_base_py3 + - name: ApplicationBase + uid: azure.graphrbac.models.application_base_py3.ApplicationBase + name: application_base_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.application_create_parameters + - name: ApplicationCreateParameters + uid: azure.graphrbac.models.application_create_parameters.ApplicationCreateParameters + name: application_create_parameters + - items: + - name: Overview + uid: azure.graphrbac.models.application_create_parameters_py3 + - name: ApplicationCreateParameters + uid: azure.graphrbac.models.application_create_parameters_py3.ApplicationCreateParameters + name: application_create_parameters_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.application_paged + - name: ApplicationPaged + uid: azure.graphrbac.models.application_paged.ApplicationPaged + name: application_paged + - items: + - name: Overview + uid: azure.graphrbac.models.application_py3 + - name: Application + uid: azure.graphrbac.models.application_py3.Application + name: application_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.application_update_parameters + - name: ApplicationUpdateParameters + uid: azure.graphrbac.models.application_update_parameters.ApplicationUpdateParameters + name: application_update_parameters + - items: + - name: Overview + uid: azure.graphrbac.models.application_update_parameters_py3 + - name: ApplicationUpdateParameters + uid: azure.graphrbac.models.application_update_parameters_py3.ApplicationUpdateParameters + name: application_update_parameters_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.check_group_membership_parameters + - name: CheckGroupMembershipParameters + uid: azure.graphrbac.models.check_group_membership_parameters.CheckGroupMembershipParameters + name: check_group_membership_parameters + - items: + - name: Overview + uid: azure.graphrbac.models.check_group_membership_parameters_py3 + - name: CheckGroupMembershipParameters + uid: azure.graphrbac.models.check_group_membership_parameters_py3.CheckGroupMembershipParameters + name: check_group_membership_parameters_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.check_group_membership_result + - name: CheckGroupMembershipResult + uid: azure.graphrbac.models.check_group_membership_result.CheckGroupMembershipResult + name: check_group_membership_result + - items: + - name: Overview + uid: azure.graphrbac.models.check_group_membership_result_py3 + - name: CheckGroupMembershipResult + uid: azure.graphrbac.models.check_group_membership_result_py3.CheckGroupMembershipResult + name: check_group_membership_result_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.directory_object + - name: DirectoryObject + uid: azure.graphrbac.models.directory_object.DirectoryObject + name: directory_object + - items: + - name: Overview + uid: azure.graphrbac.models.directory_object_paged + - name: DirectoryObjectPaged + uid: azure.graphrbac.models.directory_object_paged.DirectoryObjectPaged + name: directory_object_paged + - items: + - name: Overview + uid: azure.graphrbac.models.directory_object_py3 + - name: DirectoryObject + uid: azure.graphrbac.models.directory_object_py3.DirectoryObject + name: directory_object_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.domain + - name: Domain + uid: azure.graphrbac.models.domain.Domain + name: domain + - items: + - name: Overview + uid: azure.graphrbac.models.domain_paged + - name: DomainPaged + uid: azure.graphrbac.models.domain_paged.DomainPaged + name: domain_paged + - items: + - name: Overview + uid: azure.graphrbac.models.domain_py3 + - name: Domain + uid: azure.graphrbac.models.domain_py3.Domain + name: domain_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.get_objects_parameters + - name: GetObjectsParameters + uid: azure.graphrbac.models.get_objects_parameters.GetObjectsParameters + name: get_objects_parameters + - items: + - name: Overview + uid: azure.graphrbac.models.get_objects_parameters_py3 + - name: GetObjectsParameters + uid: azure.graphrbac.models.get_objects_parameters_py3.GetObjectsParameters + name: get_objects_parameters_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.graph_error + - name: GraphError + uid: azure.graphrbac.models.graph_error.GraphError + - name: GraphErrorException + uid: azure.graphrbac.models.graph_error.GraphErrorException + name: graph_error + - items: + - name: Overview + uid: azure.graphrbac.models.graph_error_py3 + - name: GraphError + uid: azure.graphrbac.models.graph_error_py3.GraphError + - name: GraphErrorException + uid: azure.graphrbac.models.graph_error_py3.GraphErrorException + name: graph_error_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.graph_rbac_management_client_enums + - name: ConsentType + uid: azure.graphrbac.models.graph_rbac_management_client_enums.ConsentType + - name: UserType + uid: azure.graphrbac.models.graph_rbac_management_client_enums.UserType + name: graph_rbac_management_client_enums + - items: + - name: Overview + uid: azure.graphrbac.models.group_add_member_parameters + - name: GroupAddMemberParameters + uid: azure.graphrbac.models.group_add_member_parameters.GroupAddMemberParameters + name: group_add_member_parameters + - items: + - name: Overview + uid: azure.graphrbac.models.group_add_member_parameters_py3 + - name: GroupAddMemberParameters + uid: azure.graphrbac.models.group_add_member_parameters_py3.GroupAddMemberParameters + name: group_add_member_parameters_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.group_create_parameters + - name: GroupCreateParameters + uid: azure.graphrbac.models.group_create_parameters.GroupCreateParameters + name: group_create_parameters + - items: + - name: Overview + uid: azure.graphrbac.models.group_create_parameters_py3 + - name: GroupCreateParameters + uid: azure.graphrbac.models.group_create_parameters_py3.GroupCreateParameters + name: group_create_parameters_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.group_get_member_groups_parameters + - name: GroupGetMemberGroupsParameters + uid: azure.graphrbac.models.group_get_member_groups_parameters.GroupGetMemberGroupsParameters + name: group_get_member_groups_parameters + - items: + - name: Overview + uid: azure.graphrbac.models.group_get_member_groups_parameters_py3 + - name: GroupGetMemberGroupsParameters + uid: azure.graphrbac.models.group_get_member_groups_parameters_py3.GroupGetMemberGroupsParameters + name: group_get_member_groups_parameters_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.informational_url + - name: InformationalUrl + uid: azure.graphrbac.models.informational_url.InformationalUrl + name: informational_url + - items: + - name: Overview + uid: azure.graphrbac.models.informational_url_py3 + - name: InformationalUrl + uid: azure.graphrbac.models.informational_url_py3.InformationalUrl + name: informational_url_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.key_credential + - name: KeyCredential + uid: azure.graphrbac.models.key_credential.KeyCredential + name: key_credential + - items: + - name: Overview + uid: azure.graphrbac.models.key_credential_paged + - name: KeyCredentialPaged + uid: azure.graphrbac.models.key_credential_paged.KeyCredentialPaged + name: key_credential_paged + - items: + - name: Overview + uid: azure.graphrbac.models.key_credential_py3 + - name: KeyCredential + uid: azure.graphrbac.models.key_credential_py3.KeyCredential + name: key_credential_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.key_credentials_update_parameters + - name: KeyCredentialsUpdateParameters + uid: azure.graphrbac.models.key_credentials_update_parameters.KeyCredentialsUpdateParameters + name: key_credentials_update_parameters + - items: + - name: Overview + uid: azure.graphrbac.models.key_credentials_update_parameters_py3 + - name: KeyCredentialsUpdateParameters + uid: azure.graphrbac.models.key_credentials_update_parameters_py3.KeyCredentialsUpdateParameters + name: key_credentials_update_parameters_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.oauth2_permission + - name: OAuth2Permission + uid: azure.graphrbac.models.oauth2_permission.OAuth2Permission + name: oauth2_permission + - items: + - name: Overview + uid: azure.graphrbac.models.oauth2_permission_grant + - name: OAuth2PermissionGrant + uid: azure.graphrbac.models.oauth2_permission_grant.OAuth2PermissionGrant + name: oauth2_permission_grant + - items: + - name: Overview + uid: azure.graphrbac.models.oauth2_permission_grant_paged + - name: OAuth2PermissionGrantPaged + uid: azure.graphrbac.models.oauth2_permission_grant_paged.OAuth2PermissionGrantPaged + name: oauth2_permission_grant_paged + - items: + - name: Overview + uid: azure.graphrbac.models.oauth2_permission_grant_py3 + - name: OAuth2PermissionGrant + uid: azure.graphrbac.models.oauth2_permission_grant_py3.OAuth2PermissionGrant + name: oauth2_permission_grant_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.oauth2_permission_py3 + - name: OAuth2Permission + uid: azure.graphrbac.models.oauth2_permission_py3.OAuth2Permission + name: oauth2_permission_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.optional_claim + - name: OptionalClaim + uid: azure.graphrbac.models.optional_claim.OptionalClaim + name: optional_claim + - items: + - name: Overview + uid: azure.graphrbac.models.optional_claim_py3 + - name: OptionalClaim + uid: azure.graphrbac.models.optional_claim_py3.OptionalClaim + name: optional_claim_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.optional_claims + - name: OptionalClaims + uid: azure.graphrbac.models.optional_claims.OptionalClaims + name: optional_claims + - items: + - name: Overview + uid: azure.graphrbac.models.optional_claims_py3 + - name: OptionalClaims + uid: azure.graphrbac.models.optional_claims_py3.OptionalClaims + name: optional_claims_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.password_credential + - name: PasswordCredential + uid: azure.graphrbac.models.password_credential.PasswordCredential + name: password_credential + - items: + - name: Overview + uid: azure.graphrbac.models.password_credential_paged + - name: PasswordCredentialPaged + uid: azure.graphrbac.models.password_credential_paged.PasswordCredentialPaged + name: password_credential_paged + - items: + - name: Overview + uid: azure.graphrbac.models.password_credential_py3 + - name: PasswordCredential + uid: azure.graphrbac.models.password_credential_py3.PasswordCredential + name: password_credential_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.password_credentials_update_parameters + - name: PasswordCredentialsUpdateParameters + uid: azure.graphrbac.models.password_credentials_update_parameters.PasswordCredentialsUpdateParameters + name: password_credentials_update_parameters + - items: + - name: Overview + uid: azure.graphrbac.models.password_credentials_update_parameters_py3 + - name: PasswordCredentialsUpdateParameters + uid: azure.graphrbac.models.password_credentials_update_parameters_py3.PasswordCredentialsUpdateParameters + name: password_credentials_update_parameters_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.password_profile + - name: PasswordProfile + uid: azure.graphrbac.models.password_profile.PasswordProfile + name: password_profile + - items: + - name: Overview + uid: azure.graphrbac.models.password_profile_py3 + - name: PasswordProfile + uid: azure.graphrbac.models.password_profile_py3.PasswordProfile + name: password_profile_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.pre_authorized_application + - name: PreAuthorizedApplication + uid: azure.graphrbac.models.pre_authorized_application.PreAuthorizedApplication + name: pre_authorized_application + - items: + - name: Overview + uid: azure.graphrbac.models.pre_authorized_application_extension + - name: PreAuthorizedApplicationExtension + uid: azure.graphrbac.models.pre_authorized_application_extension.PreAuthorizedApplicationExtension + name: pre_authorized_application_extension + - items: + - name: Overview + uid: azure.graphrbac.models.pre_authorized_application_extension_py3 + - name: PreAuthorizedApplicationExtension + uid: azure.graphrbac.models.pre_authorized_application_extension_py3.PreAuthorizedApplicationExtension + name: pre_authorized_application_extension_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.pre_authorized_application_permission + - name: PreAuthorizedApplicationPermission + uid: azure.graphrbac.models.pre_authorized_application_permission.PreAuthorizedApplicationPermission + name: pre_authorized_application_permission + - items: + - name: Overview + uid: azure.graphrbac.models.pre_authorized_application_permission_py3 + - name: PreAuthorizedApplicationPermission + uid: azure.graphrbac.models.pre_authorized_application_permission_py3.PreAuthorizedApplicationPermission + name: pre_authorized_application_permission_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.pre_authorized_application_py3 + - name: PreAuthorizedApplication + uid: azure.graphrbac.models.pre_authorized_application_py3.PreAuthorizedApplication + name: pre_authorized_application_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.required_resource_access + - name: RequiredResourceAccess + uid: azure.graphrbac.models.required_resource_access.RequiredResourceAccess + name: required_resource_access + - items: + - name: Overview + uid: azure.graphrbac.models.required_resource_access_py3 + - name: RequiredResourceAccess + uid: azure.graphrbac.models.required_resource_access_py3.RequiredResourceAccess + name: required_resource_access_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.resource_access + - name: ResourceAccess + uid: azure.graphrbac.models.resource_access.ResourceAccess + name: resource_access + - items: + - name: Overview + uid: azure.graphrbac.models.resource_access_py3 + - name: ResourceAccess + uid: azure.graphrbac.models.resource_access_py3.ResourceAccess + name: resource_access_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.service_principal + - name: ServicePrincipal + uid: azure.graphrbac.models.service_principal.ServicePrincipal + name: service_principal + - items: + - name: Overview + uid: azure.graphrbac.models.service_principal_base + - name: ServicePrincipalBase + uid: azure.graphrbac.models.service_principal_base.ServicePrincipalBase + name: service_principal_base + - items: + - name: Overview + uid: azure.graphrbac.models.service_principal_base_py3 + - name: ServicePrincipalBase + uid: azure.graphrbac.models.service_principal_base_py3.ServicePrincipalBase + name: service_principal_base_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.service_principal_create_parameters + - name: ServicePrincipalCreateParameters + uid: azure.graphrbac.models.service_principal_create_parameters.ServicePrincipalCreateParameters + name: service_principal_create_parameters + - items: + - name: Overview + uid: azure.graphrbac.models.service_principal_create_parameters_py3 + - name: ServicePrincipalCreateParameters + uid: azure.graphrbac.models.service_principal_create_parameters_py3.ServicePrincipalCreateParameters + name: service_principal_create_parameters_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.service_principal_object_result + - name: ServicePrincipalObjectResult + uid: azure.graphrbac.models.service_principal_object_result.ServicePrincipalObjectResult + name: service_principal_object_result + - items: + - name: Overview + uid: azure.graphrbac.models.service_principal_object_result_py3 + - name: ServicePrincipalObjectResult + uid: azure.graphrbac.models.service_principal_object_result_py3.ServicePrincipalObjectResult + name: service_principal_object_result_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.service_principal_paged + - name: ServicePrincipalPaged + uid: azure.graphrbac.models.service_principal_paged.ServicePrincipalPaged + name: service_principal_paged + - items: + - name: Overview + uid: azure.graphrbac.models.service_principal_py3 + - name: ServicePrincipal + uid: azure.graphrbac.models.service_principal_py3.ServicePrincipal + name: service_principal_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.service_principal_update_parameters + - name: ServicePrincipalUpdateParameters + uid: azure.graphrbac.models.service_principal_update_parameters.ServicePrincipalUpdateParameters + name: service_principal_update_parameters + - items: + - name: Overview + uid: azure.graphrbac.models.service_principal_update_parameters_py3 + - name: ServicePrincipalUpdateParameters + uid: azure.graphrbac.models.service_principal_update_parameters_py3.ServicePrincipalUpdateParameters + name: service_principal_update_parameters_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.sign_in_name + - name: SignInName + uid: azure.graphrbac.models.sign_in_name.SignInName + name: sign_in_name + - items: + - name: Overview + uid: azure.graphrbac.models.sign_in_name_py3 + - name: SignInName + uid: azure.graphrbac.models.sign_in_name_py3.SignInName + name: sign_in_name_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.str_paged + - name: StrPaged + uid: azure.graphrbac.models.str_paged.StrPaged + name: str_paged + - items: + - name: Overview + uid: azure.graphrbac.models.user + - name: User + uid: azure.graphrbac.models.user.User + name: user + - items: + - name: Overview + uid: azure.graphrbac.models.user_base + - name: UserBase + uid: azure.graphrbac.models.user_base.UserBase + name: user_base + - items: + - name: Overview + uid: azure.graphrbac.models.user_base_py3 + - name: UserBase + uid: azure.graphrbac.models.user_base_py3.UserBase + name: user_base_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.user_create_parameters + - name: UserCreateParameters + uid: azure.graphrbac.models.user_create_parameters.UserCreateParameters + name: user_create_parameters + - items: + - name: Overview + uid: azure.graphrbac.models.user_create_parameters_py3 + - name: UserCreateParameters + uid: azure.graphrbac.models.user_create_parameters_py3.UserCreateParameters + name: user_create_parameters_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.user_get_member_groups_parameters + - name: UserGetMemberGroupsParameters + uid: azure.graphrbac.models.user_get_member_groups_parameters.UserGetMemberGroupsParameters + name: user_get_member_groups_parameters + - items: + - name: Overview + uid: azure.graphrbac.models.user_get_member_groups_parameters_py3 + - name: UserGetMemberGroupsParameters + uid: azure.graphrbac.models.user_get_member_groups_parameters_py3.UserGetMemberGroupsParameters + name: user_get_member_groups_parameters_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.user_paged + - name: UserPaged + uid: azure.graphrbac.models.user_paged.UserPaged + name: user_paged + - items: + - name: Overview + uid: azure.graphrbac.models.user_py3 + - name: User + uid: azure.graphrbac.models.user_py3.User + name: user_py3 + - items: + - name: Overview + uid: azure.graphrbac.models.user_update_parameters + - name: UserUpdateParameters + uid: azure.graphrbac.models.user_update_parameters.UserUpdateParameters + name: user_update_parameters + - items: + - name: Overview + uid: azure.graphrbac.models.user_update_parameters_py3 + - name: UserUpdateParameters + uid: azure.graphrbac.models.user_update_parameters_py3.UserUpdateParameters + name: user_update_parameters_py3 + - name: ADGroup + uid: azure.graphrbac.models.ADGroup + - name: ADGroupPaged + uid: azure.graphrbac.models.ADGroupPaged + - name: AddOwnerParameters + uid: azure.graphrbac.models.AddOwnerParameters + - name: AppRole + uid: azure.graphrbac.models.AppRole + - name: Application + uid: azure.graphrbac.models.Application + - name: ApplicationBase + uid: azure.graphrbac.models.ApplicationBase + - name: ApplicationCreateParameters + uid: azure.graphrbac.models.ApplicationCreateParameters + - name: ApplicationPaged + uid: azure.graphrbac.models.ApplicationPaged + - name: ApplicationUpdateParameters + uid: azure.graphrbac.models.ApplicationUpdateParameters + - name: CheckGroupMembershipParameters + uid: azure.graphrbac.models.CheckGroupMembershipParameters + - name: CheckGroupMembershipResult + uid: azure.graphrbac.models.CheckGroupMembershipResult + - name: ConsentType + uid: azure.graphrbac.models.ConsentType + - name: DirectoryObject + uid: azure.graphrbac.models.DirectoryObject + - name: DirectoryObjectPaged + uid: azure.graphrbac.models.DirectoryObjectPaged + - name: Domain + uid: azure.graphrbac.models.Domain + - name: DomainPaged + uid: azure.graphrbac.models.DomainPaged + - name: GetObjectsParameters + uid: azure.graphrbac.models.GetObjectsParameters + - name: GraphError + uid: azure.graphrbac.models.GraphError + - name: GraphErrorException + uid: azure.graphrbac.models.GraphErrorException + - name: GroupAddMemberParameters + uid: azure.graphrbac.models.GroupAddMemberParameters + - name: GroupCreateParameters + uid: azure.graphrbac.models.GroupCreateParameters + - name: GroupGetMemberGroupsParameters + uid: azure.graphrbac.models.GroupGetMemberGroupsParameters + - name: InformationalUrl + uid: azure.graphrbac.models.InformationalUrl + - name: KeyCredential + uid: azure.graphrbac.models.KeyCredential + - name: KeyCredentialPaged + uid: azure.graphrbac.models.KeyCredentialPaged + - name: KeyCredentialsUpdateParameters + uid: azure.graphrbac.models.KeyCredentialsUpdateParameters + - name: OAuth2Permission + uid: azure.graphrbac.models.OAuth2Permission + - name: OAuth2PermissionGrant + uid: azure.graphrbac.models.OAuth2PermissionGrant + - name: OAuth2PermissionGrantPaged + uid: azure.graphrbac.models.OAuth2PermissionGrantPaged + - name: OptionalClaim + uid: azure.graphrbac.models.OptionalClaim + - name: OptionalClaims + uid: azure.graphrbac.models.OptionalClaims + - name: PasswordCredential + uid: azure.graphrbac.models.PasswordCredential + - name: PasswordCredentialPaged + uid: azure.graphrbac.models.PasswordCredentialPaged + - name: PasswordCredentialsUpdateParameters + uid: azure.graphrbac.models.PasswordCredentialsUpdateParameters + - name: PasswordProfile + uid: azure.graphrbac.models.PasswordProfile + - name: PreAuthorizedApplication + uid: azure.graphrbac.models.PreAuthorizedApplication + - name: PreAuthorizedApplicationExtension + uid: azure.graphrbac.models.PreAuthorizedApplicationExtension + - name: PreAuthorizedApplicationPermission + uid: azure.graphrbac.models.PreAuthorizedApplicationPermission + - name: RequiredResourceAccess + uid: azure.graphrbac.models.RequiredResourceAccess + - name: ResourceAccess + uid: azure.graphrbac.models.ResourceAccess + - name: ServicePrincipal + uid: azure.graphrbac.models.ServicePrincipal + - name: ServicePrincipalBase + uid: azure.graphrbac.models.ServicePrincipalBase + - name: ServicePrincipalCreateParameters + uid: azure.graphrbac.models.ServicePrincipalCreateParameters + - name: ServicePrincipalObjectResult + uid: azure.graphrbac.models.ServicePrincipalObjectResult + - name: ServicePrincipalPaged + uid: azure.graphrbac.models.ServicePrincipalPaged + - name: ServicePrincipalUpdateParameters + uid: azure.graphrbac.models.ServicePrincipalUpdateParameters + - name: SignInName + uid: azure.graphrbac.models.SignInName + - name: StrPaged + uid: azure.graphrbac.models.StrPaged + - name: User + uid: azure.graphrbac.models.User + - name: UserBase + uid: azure.graphrbac.models.UserBase + - name: UserCreateParameters + uid: azure.graphrbac.models.UserCreateParameters + - name: UserGetMemberGroupsParameters + uid: azure.graphrbac.models.UserGetMemberGroupsParameters + - name: UserPaged + uid: azure.graphrbac.models.UserPaged + - name: UserType + uid: azure.graphrbac.models.UserType + - name: UserUpdateParameters + uid: azure.graphrbac.models.UserUpdateParameters + name: models + - items: + - name: Overview + uid: azure.graphrbac.operations + - items: + - name: Overview + uid: azure.graphrbac.operations.applications_operations + - name: ApplicationsOperations + uid: azure.graphrbac.operations.applications_operations.ApplicationsOperations + name: applications_operations + - items: + - name: Overview + uid: azure.graphrbac.operations.deleted_applications_operations + - name: DeletedApplicationsOperations + uid: azure.graphrbac.operations.deleted_applications_operations.DeletedApplicationsOperations + name: deleted_applications_operations + - items: + - name: Overview + uid: azure.graphrbac.operations.domains_operations + - name: DomainsOperations + uid: azure.graphrbac.operations.domains_operations.DomainsOperations + name: domains_operations + - items: + - name: Overview + uid: azure.graphrbac.operations.groups_operations + - name: GroupsOperations + uid: azure.graphrbac.operations.groups_operations.GroupsOperations + name: groups_operations + - items: + - name: Overview + uid: azure.graphrbac.operations.oauth2_permission_grant_operations + - name: OAuth2PermissionGrantOperations + uid: azure.graphrbac.operations.oauth2_permission_grant_operations.OAuth2PermissionGrantOperations + name: oauth2_permission_grant_operations + - items: + - name: Overview + uid: azure.graphrbac.operations.objects_operations + - name: ObjectsOperations + uid: azure.graphrbac.operations.objects_operations.ObjectsOperations + name: objects_operations + - items: + - name: Overview + uid: azure.graphrbac.operations.service_principals_operations + - name: ServicePrincipalsOperations + uid: azure.graphrbac.operations.service_principals_operations.ServicePrincipalsOperations + name: service_principals_operations + - items: + - name: Overview + uid: azure.graphrbac.operations.signed_in_user_operations + - name: SignedInUserOperations + uid: azure.graphrbac.operations.signed_in_user_operations.SignedInUserOperations + name: signed_in_user_operations + - items: + - name: Overview + uid: azure.graphrbac.operations.users_operations + - name: UsersOperations + uid: azure.graphrbac.operations.users_operations.UsersOperations + name: users_operations + - name: ApplicationsOperations + uid: azure.graphrbac.operations.ApplicationsOperations + - name: DeletedApplicationsOperations + uid: azure.graphrbac.operations.DeletedApplicationsOperations + - name: DomainsOperations + uid: azure.graphrbac.operations.DomainsOperations + - name: GroupsOperations + uid: azure.graphrbac.operations.GroupsOperations + - name: OAuth2PermissionGrantOperations + uid: azure.graphrbac.operations.OAuth2PermissionGrantOperations + - name: ObjectsOperations + uid: azure.graphrbac.operations.ObjectsOperations + - name: ServicePrincipalsOperations + uid: azure.graphrbac.operations.ServicePrincipalsOperations + - name: SignedInUserOperations + uid: azure.graphrbac.operations.SignedInUserOperations + - name: UsersOperations + uid: azure.graphrbac.operations.UsersOperations + name: operations + - items: + - name: Overview + uid: azure.graphrbac.graph_rbac_management_client + - name: GraphRbacManagementClient + uid: azure.graphrbac.graph_rbac_management_client.GraphRbacManagementClient + - name: GraphRbacManagementClientConfiguration + uid: azure.graphrbac.graph_rbac_management_client.GraphRbacManagementClientConfiguration + name: graph_rbac_management_client + - name: version + uid: azure.graphrbac.version + - name: GraphRbacManagementClient + uid: azure.graphrbac.GraphRbacManagementClient + name: azure.graphrbac +- items: + - name: Overview + uid: azure.iot.modelsrepository + - name: dtmi_conventions + uid: azure.iot.modelsrepository.dtmi_conventions + - items: + - name: Overview + uid: azure.iot.modelsrepository.exceptions + - name: ModelError + uid: azure.iot.modelsrepository.exceptions.ModelError + name: exceptions + - name: ModelError + uid: azure.iot.modelsrepository.ModelError + - name: ModelsRepositoryClient + uid: azure.iot.modelsrepository.ModelsRepositoryClient + name: azure.iot.modelsrepository +- items: + - name: Overview + uid: azure.keyvault + - name: http_bearer_challenge_cache + uid: azure.keyvault.http_bearer_challenge_cache + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.action + - name: Action + uid: azure.keyvault.v2016_10_01.models.action.Action + name: action + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.action_py3 + - name: Action + uid: azure.keyvault.v2016_10_01.models.action_py3.Action + name: action_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.administrator_details + - name: AdministratorDetails + uid: azure.keyvault.v2016_10_01.models.administrator_details.AdministratorDetails + name: administrator_details + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.administrator_details_py3 + - name: AdministratorDetails + uid: azure.keyvault.v2016_10_01.models.administrator_details_py3.AdministratorDetails + name: administrator_details_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.attributes + - name: Attributes + uid: azure.keyvault.v2016_10_01.models.attributes.Attributes + name: attributes + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.attributes_py3 + - name: Attributes + uid: azure.keyvault.v2016_10_01.models.attributes_py3.Attributes + name: attributes_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.backup_key_result + - name: BackupKeyResult + uid: azure.keyvault.v2016_10_01.models.backup_key_result.BackupKeyResult + name: backup_key_result + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.backup_key_result_py3 + - name: BackupKeyResult + uid: azure.keyvault.v2016_10_01.models.backup_key_result_py3.BackupKeyResult + name: backup_key_result_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.backup_secret_result + - name: BackupSecretResult + uid: azure.keyvault.v2016_10_01.models.backup_secret_result.BackupSecretResult + name: backup_secret_result + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.backup_secret_result_py3 + - name: BackupSecretResult + uid: azure.keyvault.v2016_10_01.models.backup_secret_result_py3.BackupSecretResult + name: backup_secret_result_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_attributes + - name: CertificateAttributes + uid: azure.keyvault.v2016_10_01.models.certificate_attributes.CertificateAttributes + name: certificate_attributes + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_attributes_py3 + - name: CertificateAttributes + uid: azure.keyvault.v2016_10_01.models.certificate_attributes_py3.CertificateAttributes + name: certificate_attributes_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_bundle + - name: CertificateBundle + uid: azure.keyvault.v2016_10_01.models.certificate_bundle.CertificateBundle + name: certificate_bundle + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_bundle_py3 + - name: CertificateBundle + uid: azure.keyvault.v2016_10_01.models.certificate_bundle_py3.CertificateBundle + name: certificate_bundle_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_create_parameters + - name: CertificateCreateParameters + uid: azure.keyvault.v2016_10_01.models.certificate_create_parameters.CertificateCreateParameters + name: certificate_create_parameters + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3 + - name: CertificateCreateParameters + uid: azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.CertificateCreateParameters + name: certificate_create_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_import_parameters + - name: CertificateImportParameters + uid: azure.keyvault.v2016_10_01.models.certificate_import_parameters.CertificateImportParameters + name: certificate_import_parameters + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3 + - name: CertificateImportParameters + uid: azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.CertificateImportParameters + name: certificate_import_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item + - name: CertificateIssuerItem + uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item.CertificateIssuerItem + name: certificate_issuer_item + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged + - name: CertificateIssuerItemPaged + uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item_paged.CertificateIssuerItemPaged + name: certificate_issuer_item_paged + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3 + - name: CertificateIssuerItem + uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.CertificateIssuerItem + name: certificate_issuer_item_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters + - name: CertificateIssuerSetParameters + uid: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters + name: certificate_issuer_set_parameters + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3 + - name: CertificateIssuerSetParameters + uid: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters + name: certificate_issuer_set_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters + - name: CertificateIssuerUpdateParameters + uid: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters + name: certificate_issuer_update_parameters + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3 + - name: CertificateIssuerUpdateParameters + uid: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters + name: certificate_issuer_update_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_item + - name: CertificateItem + uid: azure.keyvault.v2016_10_01.models.certificate_item.CertificateItem + name: certificate_item + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_item_paged + - name: CertificateItemPaged + uid: azure.keyvault.v2016_10_01.models.certificate_item_paged.CertificateItemPaged + name: certificate_item_paged + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_item_py3 + - name: CertificateItem + uid: azure.keyvault.v2016_10_01.models.certificate_item_py3.CertificateItem + name: certificate_item_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_merge_parameters + - name: CertificateMergeParameters + uid: azure.keyvault.v2016_10_01.models.certificate_merge_parameters.CertificateMergeParameters + name: certificate_merge_parameters + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3 + - name: CertificateMergeParameters + uid: azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.CertificateMergeParameters + name: certificate_merge_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_operation + - name: CertificateOperation + uid: azure.keyvault.v2016_10_01.models.certificate_operation.CertificateOperation + name: certificate_operation + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_operation_py3 + - name: CertificateOperation + uid: azure.keyvault.v2016_10_01.models.certificate_operation_py3.CertificateOperation + name: certificate_operation_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter + - name: CertificateOperationUpdateParameter + uid: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter + name: certificate_operation_update_parameter + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3 + - name: CertificateOperationUpdateParameter + uid: azure.keyvault.v2016_10_01.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter + name: certificate_operation_update_parameter_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_policy + - name: CertificatePolicy + uid: azure.keyvault.v2016_10_01.models.certificate_policy.CertificatePolicy + name: certificate_policy + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_policy_py3 + - name: CertificatePolicy + uid: azure.keyvault.v2016_10_01.models.certificate_policy_py3.CertificatePolicy + name: certificate_policy_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_update_parameters + - name: CertificateUpdateParameters + uid: azure.keyvault.v2016_10_01.models.certificate_update_parameters.CertificateUpdateParameters + name: certificate_update_parameters + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3 + - name: CertificateUpdateParameters + uid: azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.CertificateUpdateParameters + name: certificate_update_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.contact + - name: Contact + uid: azure.keyvault.v2016_10_01.models.contact.Contact + name: contact + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.contact_py3 + - name: Contact + uid: azure.keyvault.v2016_10_01.models.contact_py3.Contact + name: contact_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.contacts + - name: Contacts + uid: azure.keyvault.v2016_10_01.models.contacts.Contacts + name: contacts + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.contacts_py3 + - name: Contacts + uid: azure.keyvault.v2016_10_01.models.contacts_py3.Contacts + name: contacts_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle + - name: DeletedCertificateBundle + uid: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle.DeletedCertificateBundle + name: deleted_certificate_bundle + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3 + - name: DeletedCertificateBundle + uid: azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3.DeletedCertificateBundle + name: deleted_certificate_bundle_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item + - name: DeletedCertificateItem + uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item.DeletedCertificateItem + name: deleted_certificate_item + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged + - name: DeletedCertificateItemPaged + uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item_paged.DeletedCertificateItemPaged + name: deleted_certificate_item_paged + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3 + - name: DeletedCertificateItem + uid: azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3.DeletedCertificateItem + name: deleted_certificate_item_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.deleted_key_bundle + - name: DeletedKeyBundle + uid: azure.keyvault.v2016_10_01.models.deleted_key_bundle.DeletedKeyBundle + name: deleted_key_bundle + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3 + - name: DeletedKeyBundle + uid: azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3.DeletedKeyBundle + name: deleted_key_bundle_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.deleted_key_item + - name: DeletedKeyItem + uid: azure.keyvault.v2016_10_01.models.deleted_key_item.DeletedKeyItem + name: deleted_key_item + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.deleted_key_item_paged + - name: DeletedKeyItemPaged + uid: azure.keyvault.v2016_10_01.models.deleted_key_item_paged.DeletedKeyItemPaged + name: deleted_key_item_paged + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.deleted_key_item_py3 + - name: DeletedKeyItem + uid: azure.keyvault.v2016_10_01.models.deleted_key_item_py3.DeletedKeyItem + name: deleted_key_item_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.deleted_secret_bundle + - name: DeletedSecretBundle + uid: azure.keyvault.v2016_10_01.models.deleted_secret_bundle.DeletedSecretBundle + name: deleted_secret_bundle + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3 + - name: DeletedSecretBundle + uid: azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3.DeletedSecretBundle + name: deleted_secret_bundle_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.deleted_secret_item + - name: DeletedSecretItem + uid: azure.keyvault.v2016_10_01.models.deleted_secret_item.DeletedSecretItem + name: deleted_secret_item + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.deleted_secret_item_paged + - name: DeletedSecretItemPaged + uid: azure.keyvault.v2016_10_01.models.deleted_secret_item_paged.DeletedSecretItemPaged + name: deleted_secret_item_paged + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.deleted_secret_item_py3 + - name: DeletedSecretItem + uid: azure.keyvault.v2016_10_01.models.deleted_secret_item_py3.DeletedSecretItem + name: deleted_secret_item_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.error + - name: Error + uid: azure.keyvault.v2016_10_01.models.error.Error + name: error + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.error_py3 + - name: Error + uid: azure.keyvault.v2016_10_01.models.error_py3.Error + name: error_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.issuer_attributes + - name: IssuerAttributes + uid: azure.keyvault.v2016_10_01.models.issuer_attributes.IssuerAttributes + name: issuer_attributes + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.issuer_attributes_py3 + - name: IssuerAttributes + uid: azure.keyvault.v2016_10_01.models.issuer_attributes_py3.IssuerAttributes + name: issuer_attributes_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.issuer_bundle + - name: IssuerBundle + uid: azure.keyvault.v2016_10_01.models.issuer_bundle.IssuerBundle + name: issuer_bundle + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.issuer_bundle_py3 + - name: IssuerBundle + uid: azure.keyvault.v2016_10_01.models.issuer_bundle_py3.IssuerBundle + name: issuer_bundle_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.issuer_credentials + - name: IssuerCredentials + uid: azure.keyvault.v2016_10_01.models.issuer_credentials.IssuerCredentials + name: issuer_credentials + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.issuer_credentials_py3 + - name: IssuerCredentials + uid: azure.keyvault.v2016_10_01.models.issuer_credentials_py3.IssuerCredentials + name: issuer_credentials_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.issuer_parameters + - name: IssuerParameters + uid: azure.keyvault.v2016_10_01.models.issuer_parameters.IssuerParameters + name: issuer_parameters + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.issuer_parameters_py3 + - name: IssuerParameters + uid: azure.keyvault.v2016_10_01.models.issuer_parameters_py3.IssuerParameters + name: issuer_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.json_web_key + - name: JsonWebKey + uid: azure.keyvault.v2016_10_01.models.json_web_key.JsonWebKey + name: json_web_key + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.json_web_key_py3 + - name: JsonWebKey + uid: azure.keyvault.v2016_10_01.models.json_web_key_py3.JsonWebKey + name: json_web_key_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_attributes + - name: KeyAttributes + uid: azure.keyvault.v2016_10_01.models.key_attributes.KeyAttributes + name: key_attributes + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_attributes_py3 + - name: KeyAttributes + uid: azure.keyvault.v2016_10_01.models.key_attributes_py3.KeyAttributes + name: key_attributes_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_bundle + - name: KeyBundle + uid: azure.keyvault.v2016_10_01.models.key_bundle.KeyBundle + name: key_bundle + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_bundle_py3 + - name: KeyBundle + uid: azure.keyvault.v2016_10_01.models.key_bundle_py3.KeyBundle + name: key_bundle_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_create_parameters + - name: KeyCreateParameters + uid: azure.keyvault.v2016_10_01.models.key_create_parameters.KeyCreateParameters + name: key_create_parameters + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_create_parameters_py3 + - name: KeyCreateParameters + uid: azure.keyvault.v2016_10_01.models.key_create_parameters_py3.KeyCreateParameters + name: key_create_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_import_parameters + - name: KeyImportParameters + uid: azure.keyvault.v2016_10_01.models.key_import_parameters.KeyImportParameters + name: key_import_parameters + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_import_parameters_py3 + - name: KeyImportParameters + uid: azure.keyvault.v2016_10_01.models.key_import_parameters_py3.KeyImportParameters + name: key_import_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_item + - name: KeyItem + uid: azure.keyvault.v2016_10_01.models.key_item.KeyItem + name: key_item + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_item_paged + - name: KeyItemPaged + uid: azure.keyvault.v2016_10_01.models.key_item_paged.KeyItemPaged + name: key_item_paged + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_item_py3 + - name: KeyItem + uid: azure.keyvault.v2016_10_01.models.key_item_py3.KeyItem + name: key_item_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_operation_result + - name: KeyOperationResult + uid: azure.keyvault.v2016_10_01.models.key_operation_result.KeyOperationResult + name: key_operation_result + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_operation_result_py3 + - name: KeyOperationResult + uid: azure.keyvault.v2016_10_01.models.key_operation_result_py3.KeyOperationResult + name: key_operation_result_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_operations_parameters + - name: KeyOperationsParameters + uid: azure.keyvault.v2016_10_01.models.key_operations_parameters.KeyOperationsParameters + name: key_operations_parameters + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_operations_parameters_py3 + - name: KeyOperationsParameters + uid: azure.keyvault.v2016_10_01.models.key_operations_parameters_py3.KeyOperationsParameters + name: key_operations_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_properties + - name: KeyProperties + uid: azure.keyvault.v2016_10_01.models.key_properties.KeyProperties + name: key_properties + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_properties_py3 + - name: KeyProperties + uid: azure.keyvault.v2016_10_01.models.key_properties_py3.KeyProperties + name: key_properties_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_restore_parameters + - name: KeyRestoreParameters + uid: azure.keyvault.v2016_10_01.models.key_restore_parameters.KeyRestoreParameters + name: key_restore_parameters + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_restore_parameters_py3 + - name: KeyRestoreParameters + uid: azure.keyvault.v2016_10_01.models.key_restore_parameters_py3.KeyRestoreParameters + name: key_restore_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_sign_parameters + - name: KeySignParameters + uid: azure.keyvault.v2016_10_01.models.key_sign_parameters.KeySignParameters + name: key_sign_parameters + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_sign_parameters_py3 + - name: KeySignParameters + uid: azure.keyvault.v2016_10_01.models.key_sign_parameters_py3.KeySignParameters + name: key_sign_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_update_parameters + - name: KeyUpdateParameters + uid: azure.keyvault.v2016_10_01.models.key_update_parameters.KeyUpdateParameters + name: key_update_parameters + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_update_parameters_py3 + - name: KeyUpdateParameters + uid: azure.keyvault.v2016_10_01.models.key_update_parameters_py3.KeyUpdateParameters + name: key_update_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums + - name: ActionType + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.ActionType + - name: DeletionRecoveryLevel + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.DeletionRecoveryLevel + - name: JsonWebKeyCurveName + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyCurveName + - name: JsonWebKeyEncryptionAlgorithm + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyEncryptionAlgorithm + - name: JsonWebKeyOperation + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyOperation + - name: JsonWebKeySignatureAlgorithm + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm + - name: JsonWebKeyType + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.JsonWebKeyType + - name: KeyUsageType + uid: azure.keyvault.v2016_10_01.models.key_vault_client_enums.KeyUsageType + name: key_vault_client_enums + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_vault_error + - name: KeyVaultError + uid: azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultError + - name: KeyVaultErrorException + uid: azure.keyvault.v2016_10_01.models.key_vault_error.KeyVaultErrorException + name: key_vault_error + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_vault_error_py3 + - name: KeyVaultError + uid: azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultError + - name: KeyVaultErrorException + uid: azure.keyvault.v2016_10_01.models.key_vault_error_py3.KeyVaultErrorException + name: key_vault_error_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_verify_parameters + - name: KeyVerifyParameters + uid: azure.keyvault.v2016_10_01.models.key_verify_parameters.KeyVerifyParameters + name: key_verify_parameters + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_verify_parameters_py3 + - name: KeyVerifyParameters + uid: azure.keyvault.v2016_10_01.models.key_verify_parameters_py3.KeyVerifyParameters + name: key_verify_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_verify_result + - name: KeyVerifyResult + uid: azure.keyvault.v2016_10_01.models.key_verify_result.KeyVerifyResult + name: key_verify_result + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.key_verify_result_py3 + - name: KeyVerifyResult + uid: azure.keyvault.v2016_10_01.models.key_verify_result_py3.KeyVerifyResult + name: key_verify_result_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.lifetime_action + - name: LifetimeAction + uid: azure.keyvault.v2016_10_01.models.lifetime_action.LifetimeAction + name: lifetime_action + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.lifetime_action_py3 + - name: LifetimeAction + uid: azure.keyvault.v2016_10_01.models.lifetime_action_py3.LifetimeAction + name: lifetime_action_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.organization_details + - name: OrganizationDetails + uid: azure.keyvault.v2016_10_01.models.organization_details.OrganizationDetails + name: organization_details + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.organization_details_py3 + - name: OrganizationDetails + uid: azure.keyvault.v2016_10_01.models.organization_details_py3.OrganizationDetails + name: organization_details_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result + - name: PendingCertificateSigningRequestResult + uid: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult + name: pending_certificate_signing_request_result + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3 + - name: PendingCertificateSigningRequestResult + uid: azure.keyvault.v2016_10_01.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult + name: pending_certificate_signing_request_result_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.sas_definition_attributes + - name: SasDefinitionAttributes + uid: azure.keyvault.v2016_10_01.models.sas_definition_attributes.SasDefinitionAttributes + name: sas_definition_attributes + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3 + - name: SasDefinitionAttributes + uid: azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3.SasDefinitionAttributes + name: sas_definition_attributes_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.sas_definition_bundle + - name: SasDefinitionBundle + uid: azure.keyvault.v2016_10_01.models.sas_definition_bundle.SasDefinitionBundle + name: sas_definition_bundle + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3 + - name: SasDefinitionBundle + uid: azure.keyvault.v2016_10_01.models.sas_definition_bundle_py3.SasDefinitionBundle + name: sas_definition_bundle_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters + - name: SasDefinitionCreateParameters + uid: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters.SasDefinitionCreateParameters + name: sas_definition_create_parameters + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3 + - name: SasDefinitionCreateParameters + uid: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters + name: sas_definition_create_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.sas_definition_item + - name: SasDefinitionItem + uid: azure.keyvault.v2016_10_01.models.sas_definition_item.SasDefinitionItem + name: sas_definition_item + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.sas_definition_item_paged + - name: SasDefinitionItemPaged + uid: azure.keyvault.v2016_10_01.models.sas_definition_item_paged.SasDefinitionItemPaged + name: sas_definition_item_paged + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.sas_definition_item_py3 + - name: SasDefinitionItem + uid: azure.keyvault.v2016_10_01.models.sas_definition_item_py3.SasDefinitionItem + name: sas_definition_item_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters + - name: SasDefinitionUpdateParameters + uid: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters.SasDefinitionUpdateParameters + name: sas_definition_update_parameters + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3 + - name: SasDefinitionUpdateParameters + uid: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters + name: sas_definition_update_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.secret_attributes + - name: SecretAttributes + uid: azure.keyvault.v2016_10_01.models.secret_attributes.SecretAttributes + name: secret_attributes + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.secret_attributes_py3 + - name: SecretAttributes + uid: azure.keyvault.v2016_10_01.models.secret_attributes_py3.SecretAttributes + name: secret_attributes_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.secret_bundle + - name: SecretBundle + uid: azure.keyvault.v2016_10_01.models.secret_bundle.SecretBundle + name: secret_bundle + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.secret_bundle_py3 + - name: SecretBundle + uid: azure.keyvault.v2016_10_01.models.secret_bundle_py3.SecretBundle + name: secret_bundle_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.secret_item + - name: SecretItem + uid: azure.keyvault.v2016_10_01.models.secret_item.SecretItem + name: secret_item + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.secret_item_paged + - name: SecretItemPaged + uid: azure.keyvault.v2016_10_01.models.secret_item_paged.SecretItemPaged + name: secret_item_paged + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.secret_item_py3 + - name: SecretItem + uid: azure.keyvault.v2016_10_01.models.secret_item_py3.SecretItem + name: secret_item_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.secret_properties + - name: SecretProperties + uid: azure.keyvault.v2016_10_01.models.secret_properties.SecretProperties + name: secret_properties + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.secret_properties_py3 + - name: SecretProperties + uid: azure.keyvault.v2016_10_01.models.secret_properties_py3.SecretProperties + name: secret_properties_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.secret_restore_parameters + - name: SecretRestoreParameters + uid: azure.keyvault.v2016_10_01.models.secret_restore_parameters.SecretRestoreParameters + name: secret_restore_parameters + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3 + - name: SecretRestoreParameters + uid: azure.keyvault.v2016_10_01.models.secret_restore_parameters_py3.SecretRestoreParameters + name: secret_restore_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.secret_set_parameters + - name: SecretSetParameters + uid: azure.keyvault.v2016_10_01.models.secret_set_parameters.SecretSetParameters + name: secret_set_parameters + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.secret_set_parameters_py3 + - name: SecretSetParameters + uid: azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.SecretSetParameters + name: secret_set_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.secret_update_parameters + - name: SecretUpdateParameters + uid: azure.keyvault.v2016_10_01.models.secret_update_parameters.SecretUpdateParameters + name: secret_update_parameters + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.secret_update_parameters_py3 + - name: SecretUpdateParameters + uid: azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.SecretUpdateParameters + name: secret_update_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.storage_account_attributes + - name: StorageAccountAttributes + uid: azure.keyvault.v2016_10_01.models.storage_account_attributes.StorageAccountAttributes + name: storage_account_attributes + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.storage_account_attributes_py3 + - name: StorageAccountAttributes + uid: azure.keyvault.v2016_10_01.models.storage_account_attributes_py3.StorageAccountAttributes + name: storage_account_attributes_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.storage_account_create_parameters + - name: StorageAccountCreateParameters + uid: azure.keyvault.v2016_10_01.models.storage_account_create_parameters.StorageAccountCreateParameters + name: storage_account_create_parameters + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3 + - name: StorageAccountCreateParameters + uid: azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.StorageAccountCreateParameters + name: storage_account_create_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.storage_account_item + - name: StorageAccountItem + uid: azure.keyvault.v2016_10_01.models.storage_account_item.StorageAccountItem + name: storage_account_item + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.storage_account_item_paged + - name: StorageAccountItemPaged + uid: azure.keyvault.v2016_10_01.models.storage_account_item_paged.StorageAccountItemPaged + name: storage_account_item_paged + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.storage_account_item_py3 + - name: StorageAccountItem + uid: azure.keyvault.v2016_10_01.models.storage_account_item_py3.StorageAccountItem + name: storage_account_item_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters + - name: StorageAccountRegenerteKeyParameters + uid: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters + name: storage_account_regenerte_key_parameters + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3 + - name: StorageAccountRegenerteKeyParameters + uid: azure.keyvault.v2016_10_01.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters + name: storage_account_regenerte_key_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.storage_account_update_parameters + - name: StorageAccountUpdateParameters + uid: azure.keyvault.v2016_10_01.models.storage_account_update_parameters.StorageAccountUpdateParameters + name: storage_account_update_parameters + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3 + - name: StorageAccountUpdateParameters + uid: azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters + name: storage_account_update_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.storage_bundle + - name: StorageBundle + uid: azure.keyvault.v2016_10_01.models.storage_bundle.StorageBundle + name: storage_bundle + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.storage_bundle_py3 + - name: StorageBundle + uid: azure.keyvault.v2016_10_01.models.storage_bundle_py3.StorageBundle + name: storage_bundle_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.subject_alternative_names + - name: SubjectAlternativeNames + uid: azure.keyvault.v2016_10_01.models.subject_alternative_names.SubjectAlternativeNames + name: subject_alternative_names + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.subject_alternative_names_py3 + - name: SubjectAlternativeNames + uid: azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.SubjectAlternativeNames + name: subject_alternative_names_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.trigger + - name: Trigger + uid: azure.keyvault.v2016_10_01.models.trigger.Trigger + name: trigger + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.trigger_py3 + - name: Trigger + uid: azure.keyvault.v2016_10_01.models.trigger_py3.Trigger + name: trigger_py3 + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.x509_certificate_properties + - name: X509CertificateProperties + uid: azure.keyvault.v2016_10_01.models.x509_certificate_properties.X509CertificateProperties + name: x509_certificate_properties + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3 + - name: X509CertificateProperties + uid: azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.X509CertificateProperties + name: x509_certificate_properties_py3 + - name: Action + uid: azure.keyvault.v2016_10_01.models.Action + - name: ActionType + uid: azure.keyvault.v2016_10_01.models.ActionType + - name: AdministratorDetails + uid: azure.keyvault.v2016_10_01.models.AdministratorDetails + - name: Attributes + uid: azure.keyvault.v2016_10_01.models.Attributes + - name: BackupKeyResult + uid: azure.keyvault.v2016_10_01.models.BackupKeyResult + - name: BackupSecretResult + uid: azure.keyvault.v2016_10_01.models.BackupSecretResult + - name: CertificateAttributes + uid: azure.keyvault.v2016_10_01.models.CertificateAttributes + - name: CertificateBundle + uid: azure.keyvault.v2016_10_01.models.CertificateBundle + - name: CertificateCreateParameters + uid: azure.keyvault.v2016_10_01.models.CertificateCreateParameters + - name: CertificateImportParameters + uid: azure.keyvault.v2016_10_01.models.CertificateImportParameters + - name: CertificateIssuerItem + uid: azure.keyvault.v2016_10_01.models.CertificateIssuerItem + - name: CertificateIssuerItemPaged + uid: azure.keyvault.v2016_10_01.models.CertificateIssuerItemPaged + - name: CertificateIssuerSetParameters + uid: azure.keyvault.v2016_10_01.models.CertificateIssuerSetParameters + - name: CertificateIssuerUpdateParameters + uid: azure.keyvault.v2016_10_01.models.CertificateIssuerUpdateParameters + - name: CertificateItem + uid: azure.keyvault.v2016_10_01.models.CertificateItem + - name: CertificateItemPaged + uid: azure.keyvault.v2016_10_01.models.CertificateItemPaged + - name: CertificateMergeParameters + uid: azure.keyvault.v2016_10_01.models.CertificateMergeParameters + - name: CertificateOperation + uid: azure.keyvault.v2016_10_01.models.CertificateOperation + - name: CertificateOperationUpdateParameter + uid: azure.keyvault.v2016_10_01.models.CertificateOperationUpdateParameter + - name: CertificatePolicy + uid: azure.keyvault.v2016_10_01.models.CertificatePolicy + - name: CertificateUpdateParameters + uid: azure.keyvault.v2016_10_01.models.CertificateUpdateParameters + - name: Contact + uid: azure.keyvault.v2016_10_01.models.Contact + - name: Contacts + uid: azure.keyvault.v2016_10_01.models.Contacts + - name: DeletedCertificateBundle + uid: azure.keyvault.v2016_10_01.models.DeletedCertificateBundle + - name: DeletedCertificateItem + uid: azure.keyvault.v2016_10_01.models.DeletedCertificateItem + - name: DeletedCertificateItemPaged + uid: azure.keyvault.v2016_10_01.models.DeletedCertificateItemPaged + - name: DeletedKeyBundle + uid: azure.keyvault.v2016_10_01.models.DeletedKeyBundle + - name: DeletedKeyItem + uid: azure.keyvault.v2016_10_01.models.DeletedKeyItem + - name: DeletedKeyItemPaged + uid: azure.keyvault.v2016_10_01.models.DeletedKeyItemPaged + - name: DeletedSecretBundle + uid: azure.keyvault.v2016_10_01.models.DeletedSecretBundle + - name: DeletedSecretItem + uid: azure.keyvault.v2016_10_01.models.DeletedSecretItem + - name: DeletedSecretItemPaged + uid: azure.keyvault.v2016_10_01.models.DeletedSecretItemPaged + - name: DeletionRecoveryLevel + uid: azure.keyvault.v2016_10_01.models.DeletionRecoveryLevel + - name: Error + uid: azure.keyvault.v2016_10_01.models.Error + - name: IssuerAttributes + uid: azure.keyvault.v2016_10_01.models.IssuerAttributes + - name: IssuerBundle + uid: azure.keyvault.v2016_10_01.models.IssuerBundle + - name: IssuerCredentials + uid: azure.keyvault.v2016_10_01.models.IssuerCredentials + - name: IssuerParameters + uid: azure.keyvault.v2016_10_01.models.IssuerParameters + - name: JsonWebKey + uid: azure.keyvault.v2016_10_01.models.JsonWebKey + - name: JsonWebKeyCurveName + uid: azure.keyvault.v2016_10_01.models.JsonWebKeyCurveName + - name: JsonWebKeyEncryptionAlgorithm + uid: azure.keyvault.v2016_10_01.models.JsonWebKeyEncryptionAlgorithm + - name: JsonWebKeyOperation + uid: azure.keyvault.v2016_10_01.models.JsonWebKeyOperation + - name: JsonWebKeySignatureAlgorithm + uid: azure.keyvault.v2016_10_01.models.JsonWebKeySignatureAlgorithm + - name: JsonWebKeyType + uid: azure.keyvault.v2016_10_01.models.JsonWebKeyType + - name: KeyAttributes + uid: azure.keyvault.v2016_10_01.models.KeyAttributes + - name: KeyBundle + uid: azure.keyvault.v2016_10_01.models.KeyBundle + - name: KeyCreateParameters + uid: azure.keyvault.v2016_10_01.models.KeyCreateParameters + - name: KeyImportParameters + uid: azure.keyvault.v2016_10_01.models.KeyImportParameters + - name: KeyItem + uid: azure.keyvault.v2016_10_01.models.KeyItem + - name: KeyItemPaged + uid: azure.keyvault.v2016_10_01.models.KeyItemPaged + - name: KeyOperationResult + uid: azure.keyvault.v2016_10_01.models.KeyOperationResult + - name: KeyOperationsParameters + uid: azure.keyvault.v2016_10_01.models.KeyOperationsParameters + - name: KeyProperties + uid: azure.keyvault.v2016_10_01.models.KeyProperties + - name: KeyRestoreParameters + uid: azure.keyvault.v2016_10_01.models.KeyRestoreParameters + - name: KeySignParameters + uid: azure.keyvault.v2016_10_01.models.KeySignParameters + - name: KeyUpdateParameters + uid: azure.keyvault.v2016_10_01.models.KeyUpdateParameters + - name: KeyUsageType + uid: azure.keyvault.v2016_10_01.models.KeyUsageType + - name: KeyVaultError + uid: azure.keyvault.v2016_10_01.models.KeyVaultError + - name: KeyVaultErrorException + uid: azure.keyvault.v2016_10_01.models.KeyVaultErrorException + - name: KeyVerifyParameters + uid: azure.keyvault.v2016_10_01.models.KeyVerifyParameters + - name: KeyVerifyResult + uid: azure.keyvault.v2016_10_01.models.KeyVerifyResult + - name: LifetimeAction + uid: azure.keyvault.v2016_10_01.models.LifetimeAction + - name: OrganizationDetails + uid: azure.keyvault.v2016_10_01.models.OrganizationDetails + - name: PendingCertificateSigningRequestResult + uid: azure.keyvault.v2016_10_01.models.PendingCertificateSigningRequestResult + - name: SasDefinitionAttributes + uid: azure.keyvault.v2016_10_01.models.SasDefinitionAttributes + - name: SasDefinitionBundle + uid: azure.keyvault.v2016_10_01.models.SasDefinitionBundle + - name: SasDefinitionCreateParameters + uid: azure.keyvault.v2016_10_01.models.SasDefinitionCreateParameters + - name: SasDefinitionItem + uid: azure.keyvault.v2016_10_01.models.SasDefinitionItem + - name: SasDefinitionItemPaged + uid: azure.keyvault.v2016_10_01.models.SasDefinitionItemPaged + - name: SasDefinitionUpdateParameters + uid: azure.keyvault.v2016_10_01.models.SasDefinitionUpdateParameters + - name: SecretAttributes + uid: azure.keyvault.v2016_10_01.models.SecretAttributes + - name: SecretBundle + uid: azure.keyvault.v2016_10_01.models.SecretBundle + - name: SecretItem + uid: azure.keyvault.v2016_10_01.models.SecretItem + - name: SecretItemPaged + uid: azure.keyvault.v2016_10_01.models.SecretItemPaged + - name: SecretProperties + uid: azure.keyvault.v2016_10_01.models.SecretProperties + - name: SecretRestoreParameters + uid: azure.keyvault.v2016_10_01.models.SecretRestoreParameters + - name: SecretSetParameters + uid: azure.keyvault.v2016_10_01.models.SecretSetParameters + - name: SecretUpdateParameters + uid: azure.keyvault.v2016_10_01.models.SecretUpdateParameters + - name: StorageAccountAttributes + uid: azure.keyvault.v2016_10_01.models.StorageAccountAttributes + - name: StorageAccountCreateParameters + uid: azure.keyvault.v2016_10_01.models.StorageAccountCreateParameters + - name: StorageAccountItem + uid: azure.keyvault.v2016_10_01.models.StorageAccountItem + - name: StorageAccountItemPaged + uid: azure.keyvault.v2016_10_01.models.StorageAccountItemPaged + - name: StorageAccountRegenerteKeyParameters + uid: azure.keyvault.v2016_10_01.models.StorageAccountRegenerteKeyParameters + - name: StorageAccountUpdateParameters + uid: azure.keyvault.v2016_10_01.models.StorageAccountUpdateParameters + - name: StorageBundle + uid: azure.keyvault.v2016_10_01.models.StorageBundle + - name: SubjectAlternativeNames + uid: azure.keyvault.v2016_10_01.models.SubjectAlternativeNames + - name: Trigger + uid: azure.keyvault.v2016_10_01.models.Trigger + - name: X509CertificateProperties + uid: azure.keyvault.v2016_10_01.models.X509CertificateProperties + name: models + - items: + - name: Overview + uid: azure.keyvault.v2016_10_01.key_vault_client + - name: KeyVaultClient + uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClient + - name: KeyVaultClientConfiguration + uid: azure.keyvault.v2016_10_01.key_vault_client.KeyVaultClientConfiguration + name: key_vault_client + - name: version + uid: azure.keyvault.v2016_10_01.version + - name: KeyVaultClient + uid: azure.keyvault.v2016_10_01.KeyVaultClient + name: v2016_10_01 + - items: + - name: Overview + uid: azure.keyvault.v7_0 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.action + - name: Action + uid: azure.keyvault.v7_0.models.action.Action + name: action + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.action_py3 + - name: Action + uid: azure.keyvault.v7_0.models.action_py3.Action + name: action_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.administrator_details + - name: AdministratorDetails + uid: azure.keyvault.v7_0.models.administrator_details.AdministratorDetails + name: administrator_details + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.administrator_details_py3 + - name: AdministratorDetails + uid: azure.keyvault.v7_0.models.administrator_details_py3.AdministratorDetails + name: administrator_details_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.attributes + - name: Attributes + uid: azure.keyvault.v7_0.models.attributes.Attributes + name: attributes + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.attributes_py3 + - name: Attributes + uid: azure.keyvault.v7_0.models.attributes_py3.Attributes + name: attributes_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.backup_certificate_result + - name: BackupCertificateResult + uid: azure.keyvault.v7_0.models.backup_certificate_result.BackupCertificateResult + name: backup_certificate_result + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.backup_certificate_result_py3 + - name: BackupCertificateResult + uid: azure.keyvault.v7_0.models.backup_certificate_result_py3.BackupCertificateResult + name: backup_certificate_result_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.backup_key_result + - name: BackupKeyResult + uid: azure.keyvault.v7_0.models.backup_key_result.BackupKeyResult + name: backup_key_result + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.backup_key_result_py3 + - name: BackupKeyResult + uid: azure.keyvault.v7_0.models.backup_key_result_py3.BackupKeyResult + name: backup_key_result_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.backup_secret_result + - name: BackupSecretResult + uid: azure.keyvault.v7_0.models.backup_secret_result.BackupSecretResult + name: backup_secret_result + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.backup_secret_result_py3 + - name: BackupSecretResult + uid: azure.keyvault.v7_0.models.backup_secret_result_py3.BackupSecretResult + name: backup_secret_result_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.backup_storage_result + - name: BackupStorageResult + uid: azure.keyvault.v7_0.models.backup_storage_result.BackupStorageResult + name: backup_storage_result + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.backup_storage_result_py3 + - name: BackupStorageResult + uid: azure.keyvault.v7_0.models.backup_storage_result_py3.BackupStorageResult + name: backup_storage_result_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_attributes + - name: CertificateAttributes + uid: azure.keyvault.v7_0.models.certificate_attributes.CertificateAttributes + name: certificate_attributes + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_attributes_py3 + - name: CertificateAttributes + uid: azure.keyvault.v7_0.models.certificate_attributes_py3.CertificateAttributes + name: certificate_attributes_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_bundle + - name: CertificateBundle + uid: azure.keyvault.v7_0.models.certificate_bundle.CertificateBundle + name: certificate_bundle + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_bundle_py3 + - name: CertificateBundle + uid: azure.keyvault.v7_0.models.certificate_bundle_py3.CertificateBundle + name: certificate_bundle_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_create_parameters + - name: CertificateCreateParameters + uid: azure.keyvault.v7_0.models.certificate_create_parameters.CertificateCreateParameters + name: certificate_create_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_create_parameters_py3 + - name: CertificateCreateParameters + uid: azure.keyvault.v7_0.models.certificate_create_parameters_py3.CertificateCreateParameters + name: certificate_create_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_import_parameters + - name: CertificateImportParameters + uid: azure.keyvault.v7_0.models.certificate_import_parameters.CertificateImportParameters + name: certificate_import_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_import_parameters_py3 + - name: CertificateImportParameters + uid: azure.keyvault.v7_0.models.certificate_import_parameters_py3.CertificateImportParameters + name: certificate_import_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_issuer_item + - name: CertificateIssuerItem + uid: azure.keyvault.v7_0.models.certificate_issuer_item.CertificateIssuerItem + name: certificate_issuer_item + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_issuer_item_paged + - name: CertificateIssuerItemPaged + uid: azure.keyvault.v7_0.models.certificate_issuer_item_paged.CertificateIssuerItemPaged + name: certificate_issuer_item_paged + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_issuer_item_py3 + - name: CertificateIssuerItem + uid: azure.keyvault.v7_0.models.certificate_issuer_item_py3.CertificateIssuerItem + name: certificate_issuer_item_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_issuer_set_parameters + - name: CertificateIssuerSetParameters + uid: azure.keyvault.v7_0.models.certificate_issuer_set_parameters.CertificateIssuerSetParameters + name: certificate_issuer_set_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3 + - name: CertificateIssuerSetParameters + uid: azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters + name: certificate_issuer_set_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_issuer_update_parameters + - name: CertificateIssuerUpdateParameters + uid: azure.keyvault.v7_0.models.certificate_issuer_update_parameters.CertificateIssuerUpdateParameters + name: certificate_issuer_update_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3 + - name: CertificateIssuerUpdateParameters + uid: azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters + name: certificate_issuer_update_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_item + - name: CertificateItem + uid: azure.keyvault.v7_0.models.certificate_item.CertificateItem + name: certificate_item + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_item_paged + - name: CertificateItemPaged + uid: azure.keyvault.v7_0.models.certificate_item_paged.CertificateItemPaged + name: certificate_item_paged + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_item_py3 + - name: CertificateItem + uid: azure.keyvault.v7_0.models.certificate_item_py3.CertificateItem + name: certificate_item_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_merge_parameters + - name: CertificateMergeParameters + uid: azure.keyvault.v7_0.models.certificate_merge_parameters.CertificateMergeParameters + name: certificate_merge_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_merge_parameters_py3 + - name: CertificateMergeParameters + uid: azure.keyvault.v7_0.models.certificate_merge_parameters_py3.CertificateMergeParameters + name: certificate_merge_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_operation + - name: CertificateOperation + uid: azure.keyvault.v7_0.models.certificate_operation.CertificateOperation + name: certificate_operation + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_operation_py3 + - name: CertificateOperation + uid: azure.keyvault.v7_0.models.certificate_operation_py3.CertificateOperation + name: certificate_operation_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_operation_update_parameter + - name: CertificateOperationUpdateParameter + uid: azure.keyvault.v7_0.models.certificate_operation_update_parameter.CertificateOperationUpdateParameter + name: certificate_operation_update_parameter + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3 + - name: CertificateOperationUpdateParameter + uid: azure.keyvault.v7_0.models.certificate_operation_update_parameter_py3.CertificateOperationUpdateParameter + name: certificate_operation_update_parameter_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_policy + - name: CertificatePolicy + uid: azure.keyvault.v7_0.models.certificate_policy.CertificatePolicy + name: certificate_policy + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_policy_py3 + - name: CertificatePolicy + uid: azure.keyvault.v7_0.models.certificate_policy_py3.CertificatePolicy + name: certificate_policy_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_restore_parameters + - name: CertificateRestoreParameters + uid: azure.keyvault.v7_0.models.certificate_restore_parameters.CertificateRestoreParameters + name: certificate_restore_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_restore_parameters_py3 + - name: CertificateRestoreParameters + uid: azure.keyvault.v7_0.models.certificate_restore_parameters_py3.CertificateRestoreParameters + name: certificate_restore_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_update_parameters + - name: CertificateUpdateParameters + uid: azure.keyvault.v7_0.models.certificate_update_parameters.CertificateUpdateParameters + name: certificate_update_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.certificate_update_parameters_py3 + - name: CertificateUpdateParameters + uid: azure.keyvault.v7_0.models.certificate_update_parameters_py3.CertificateUpdateParameters + name: certificate_update_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.contact + - name: Contact + uid: azure.keyvault.v7_0.models.contact.Contact + name: contact + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.contact_py3 + - name: Contact + uid: azure.keyvault.v7_0.models.contact_py3.Contact + name: contact_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.contacts + - name: Contacts + uid: azure.keyvault.v7_0.models.contacts.Contacts + name: contacts + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.contacts_py3 + - name: Contacts + uid: azure.keyvault.v7_0.models.contacts_py3.Contacts + name: contacts_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_certificate_bundle + - name: DeletedCertificateBundle + uid: azure.keyvault.v7_0.models.deleted_certificate_bundle.DeletedCertificateBundle + name: deleted_certificate_bundle + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_certificate_bundle_py3 + - name: DeletedCertificateBundle + uid: azure.keyvault.v7_0.models.deleted_certificate_bundle_py3.DeletedCertificateBundle + name: deleted_certificate_bundle_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_certificate_item + - name: DeletedCertificateItem + uid: azure.keyvault.v7_0.models.deleted_certificate_item.DeletedCertificateItem + name: deleted_certificate_item + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_certificate_item_paged + - name: DeletedCertificateItemPaged + uid: azure.keyvault.v7_0.models.deleted_certificate_item_paged.DeletedCertificateItemPaged + name: deleted_certificate_item_paged + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_certificate_item_py3 + - name: DeletedCertificateItem + uid: azure.keyvault.v7_0.models.deleted_certificate_item_py3.DeletedCertificateItem + name: deleted_certificate_item_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_key_bundle + - name: DeletedKeyBundle + uid: azure.keyvault.v7_0.models.deleted_key_bundle.DeletedKeyBundle + name: deleted_key_bundle + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_key_bundle_py3 + - name: DeletedKeyBundle + uid: azure.keyvault.v7_0.models.deleted_key_bundle_py3.DeletedKeyBundle + name: deleted_key_bundle_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_key_item + - name: DeletedKeyItem + uid: azure.keyvault.v7_0.models.deleted_key_item.DeletedKeyItem + name: deleted_key_item + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_key_item_paged + - name: DeletedKeyItemPaged + uid: azure.keyvault.v7_0.models.deleted_key_item_paged.DeletedKeyItemPaged + name: deleted_key_item_paged + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_key_item_py3 + - name: DeletedKeyItem + uid: azure.keyvault.v7_0.models.deleted_key_item_py3.DeletedKeyItem + name: deleted_key_item_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_sas_definition_bundle + - name: DeletedSasDefinitionBundle + uid: azure.keyvault.v7_0.models.deleted_sas_definition_bundle.DeletedSasDefinitionBundle + name: deleted_sas_definition_bundle + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3 + - name: DeletedSasDefinitionBundle + uid: azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3.DeletedSasDefinitionBundle + name: deleted_sas_definition_bundle_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_sas_definition_item + - name: DeletedSasDefinitionItem + uid: azure.keyvault.v7_0.models.deleted_sas_definition_item.DeletedSasDefinitionItem + name: deleted_sas_definition_item + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_sas_definition_item_paged + - name: DeletedSasDefinitionItemPaged + uid: azure.keyvault.v7_0.models.deleted_sas_definition_item_paged.DeletedSasDefinitionItemPaged + name: deleted_sas_definition_item_paged + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_sas_definition_item_py3 + - name: DeletedSasDefinitionItem + uid: azure.keyvault.v7_0.models.deleted_sas_definition_item_py3.DeletedSasDefinitionItem + name: deleted_sas_definition_item_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_secret_bundle + - name: DeletedSecretBundle + uid: azure.keyvault.v7_0.models.deleted_secret_bundle.DeletedSecretBundle + name: deleted_secret_bundle + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_secret_bundle_py3 + - name: DeletedSecretBundle + uid: azure.keyvault.v7_0.models.deleted_secret_bundle_py3.DeletedSecretBundle + name: deleted_secret_bundle_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_secret_item + - name: DeletedSecretItem + uid: azure.keyvault.v7_0.models.deleted_secret_item.DeletedSecretItem + name: deleted_secret_item + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_secret_item_paged + - name: DeletedSecretItemPaged + uid: azure.keyvault.v7_0.models.deleted_secret_item_paged.DeletedSecretItemPaged + name: deleted_secret_item_paged + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_secret_item_py3 + - name: DeletedSecretItem + uid: azure.keyvault.v7_0.models.deleted_secret_item_py3.DeletedSecretItem + name: deleted_secret_item_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_storage_account_item + - name: DeletedStorageAccountItem + uid: azure.keyvault.v7_0.models.deleted_storage_account_item.DeletedStorageAccountItem + name: deleted_storage_account_item + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_storage_account_item_paged + - name: DeletedStorageAccountItemPaged + uid: azure.keyvault.v7_0.models.deleted_storage_account_item_paged.DeletedStorageAccountItemPaged + name: deleted_storage_account_item_paged + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_storage_account_item_py3 + - name: DeletedStorageAccountItem + uid: azure.keyvault.v7_0.models.deleted_storage_account_item_py3.DeletedStorageAccountItem + name: deleted_storage_account_item_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_storage_bundle + - name: DeletedStorageBundle + uid: azure.keyvault.v7_0.models.deleted_storage_bundle.DeletedStorageBundle + name: deleted_storage_bundle + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.deleted_storage_bundle_py3 + - name: DeletedStorageBundle + uid: azure.keyvault.v7_0.models.deleted_storage_bundle_py3.DeletedStorageBundle + name: deleted_storage_bundle_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.error + - name: Error + uid: azure.keyvault.v7_0.models.error.Error + name: error + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.error_py3 + - name: Error + uid: azure.keyvault.v7_0.models.error_py3.Error + name: error_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.issuer_attributes + - name: IssuerAttributes + uid: azure.keyvault.v7_0.models.issuer_attributes.IssuerAttributes + name: issuer_attributes + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.issuer_attributes_py3 + - name: IssuerAttributes + uid: azure.keyvault.v7_0.models.issuer_attributes_py3.IssuerAttributes + name: issuer_attributes_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.issuer_bundle + - name: IssuerBundle + uid: azure.keyvault.v7_0.models.issuer_bundle.IssuerBundle + name: issuer_bundle + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.issuer_bundle_py3 + - name: IssuerBundle + uid: azure.keyvault.v7_0.models.issuer_bundle_py3.IssuerBundle + name: issuer_bundle_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.issuer_credentials + - name: IssuerCredentials + uid: azure.keyvault.v7_0.models.issuer_credentials.IssuerCredentials + name: issuer_credentials + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.issuer_credentials_py3 + - name: IssuerCredentials + uid: azure.keyvault.v7_0.models.issuer_credentials_py3.IssuerCredentials + name: issuer_credentials_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.issuer_parameters + - name: IssuerParameters + uid: azure.keyvault.v7_0.models.issuer_parameters.IssuerParameters + name: issuer_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.issuer_parameters_py3 + - name: IssuerParameters + uid: azure.keyvault.v7_0.models.issuer_parameters_py3.IssuerParameters + name: issuer_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.json_web_key + - name: JsonWebKey + uid: azure.keyvault.v7_0.models.json_web_key.JsonWebKey + name: json_web_key + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.json_web_key_py3 + - name: JsonWebKey + uid: azure.keyvault.v7_0.models.json_web_key_py3.JsonWebKey + name: json_web_key_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_attributes + - name: KeyAttributes + uid: azure.keyvault.v7_0.models.key_attributes.KeyAttributes + name: key_attributes + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_attributes_py3 + - name: KeyAttributes + uid: azure.keyvault.v7_0.models.key_attributes_py3.KeyAttributes + name: key_attributes_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_bundle + - name: KeyBundle + uid: azure.keyvault.v7_0.models.key_bundle.KeyBundle + name: key_bundle + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_bundle_py3 + - name: KeyBundle + uid: azure.keyvault.v7_0.models.key_bundle_py3.KeyBundle + name: key_bundle_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_create_parameters + - name: KeyCreateParameters + uid: azure.keyvault.v7_0.models.key_create_parameters.KeyCreateParameters + name: key_create_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_create_parameters_py3 + - name: KeyCreateParameters + uid: azure.keyvault.v7_0.models.key_create_parameters_py3.KeyCreateParameters + name: key_create_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_import_parameters + - name: KeyImportParameters + uid: azure.keyvault.v7_0.models.key_import_parameters.KeyImportParameters + name: key_import_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_import_parameters_py3 + - name: KeyImportParameters + uid: azure.keyvault.v7_0.models.key_import_parameters_py3.KeyImportParameters + name: key_import_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_item + - name: KeyItem + uid: azure.keyvault.v7_0.models.key_item.KeyItem + name: key_item + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_item_paged + - name: KeyItemPaged + uid: azure.keyvault.v7_0.models.key_item_paged.KeyItemPaged + name: key_item_paged + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_item_py3 + - name: KeyItem + uid: azure.keyvault.v7_0.models.key_item_py3.KeyItem + name: key_item_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_operation_result + - name: KeyOperationResult + uid: azure.keyvault.v7_0.models.key_operation_result.KeyOperationResult + name: key_operation_result + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_operation_result_py3 + - name: KeyOperationResult + uid: azure.keyvault.v7_0.models.key_operation_result_py3.KeyOperationResult + name: key_operation_result_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_operations_parameters + - name: KeyOperationsParameters + uid: azure.keyvault.v7_0.models.key_operations_parameters.KeyOperationsParameters + name: key_operations_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_operations_parameters_py3 + - name: KeyOperationsParameters + uid: azure.keyvault.v7_0.models.key_operations_parameters_py3.KeyOperationsParameters + name: key_operations_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_properties + - name: KeyProperties + uid: azure.keyvault.v7_0.models.key_properties.KeyProperties + name: key_properties + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_properties_py3 + - name: KeyProperties + uid: azure.keyvault.v7_0.models.key_properties_py3.KeyProperties + name: key_properties_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_restore_parameters + - name: KeyRestoreParameters + uid: azure.keyvault.v7_0.models.key_restore_parameters.KeyRestoreParameters + name: key_restore_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_restore_parameters_py3 + - name: KeyRestoreParameters + uid: azure.keyvault.v7_0.models.key_restore_parameters_py3.KeyRestoreParameters + name: key_restore_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_sign_parameters + - name: KeySignParameters + uid: azure.keyvault.v7_0.models.key_sign_parameters.KeySignParameters + name: key_sign_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_sign_parameters_py3 + - name: KeySignParameters + uid: azure.keyvault.v7_0.models.key_sign_parameters_py3.KeySignParameters + name: key_sign_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_update_parameters + - name: KeyUpdateParameters + uid: azure.keyvault.v7_0.models.key_update_parameters.KeyUpdateParameters + name: key_update_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_update_parameters_py3 + - name: KeyUpdateParameters + uid: azure.keyvault.v7_0.models.key_update_parameters_py3.KeyUpdateParameters + name: key_update_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_vault_client_enums + - name: ActionType + uid: azure.keyvault.v7_0.models.key_vault_client_enums.ActionType + - name: DeletionRecoveryLevel + uid: azure.keyvault.v7_0.models.key_vault_client_enums.DeletionRecoveryLevel + - name: JsonWebKeyCurveName + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyCurveName + - name: JsonWebKeyEncryptionAlgorithm + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyEncryptionAlgorithm + - name: JsonWebKeyOperation + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyOperation + - name: JsonWebKeySignatureAlgorithm + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeySignatureAlgorithm + - name: JsonWebKeyType + uid: azure.keyvault.v7_0.models.key_vault_client_enums.JsonWebKeyType + - name: KeyUsageType + uid: azure.keyvault.v7_0.models.key_vault_client_enums.KeyUsageType + - name: SasTokenType + uid: azure.keyvault.v7_0.models.key_vault_client_enums.SasTokenType + name: key_vault_client_enums + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_vault_error + - name: KeyVaultError + uid: azure.keyvault.v7_0.models.key_vault_error.KeyVaultError + - name: KeyVaultErrorException + uid: azure.keyvault.v7_0.models.key_vault_error.KeyVaultErrorException + name: key_vault_error + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_vault_error_py3 + - name: KeyVaultError + uid: azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultError + - name: KeyVaultErrorException + uid: azure.keyvault.v7_0.models.key_vault_error_py3.KeyVaultErrorException + name: key_vault_error_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_verify_parameters + - name: KeyVerifyParameters + uid: azure.keyvault.v7_0.models.key_verify_parameters.KeyVerifyParameters + name: key_verify_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_verify_parameters_py3 + - name: KeyVerifyParameters + uid: azure.keyvault.v7_0.models.key_verify_parameters_py3.KeyVerifyParameters + name: key_verify_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_verify_result + - name: KeyVerifyResult + uid: azure.keyvault.v7_0.models.key_verify_result.KeyVerifyResult + name: key_verify_result + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.key_verify_result_py3 + - name: KeyVerifyResult + uid: azure.keyvault.v7_0.models.key_verify_result_py3.KeyVerifyResult + name: key_verify_result_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.lifetime_action + - name: LifetimeAction + uid: azure.keyvault.v7_0.models.lifetime_action.LifetimeAction + name: lifetime_action + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.lifetime_action_py3 + - name: LifetimeAction + uid: azure.keyvault.v7_0.models.lifetime_action_py3.LifetimeAction + name: lifetime_action_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.organization_details + - name: OrganizationDetails + uid: azure.keyvault.v7_0.models.organization_details.OrganizationDetails + name: organization_details + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.organization_details_py3 + - name: OrganizationDetails + uid: azure.keyvault.v7_0.models.organization_details_py3.OrganizationDetails + name: organization_details_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.pending_certificate_signing_request_result + - name: PendingCertificateSigningRequestResult + uid: azure.keyvault.v7_0.models.pending_certificate_signing_request_result.PendingCertificateSigningRequestResult + name: pending_certificate_signing_request_result + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3 + - name: PendingCertificateSigningRequestResult + uid: azure.keyvault.v7_0.models.pending_certificate_signing_request_result_py3.PendingCertificateSigningRequestResult + name: pending_certificate_signing_request_result_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.sas_definition_attributes + - name: SasDefinitionAttributes + uid: azure.keyvault.v7_0.models.sas_definition_attributes.SasDefinitionAttributes + name: sas_definition_attributes + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.sas_definition_attributes_py3 + - name: SasDefinitionAttributes + uid: azure.keyvault.v7_0.models.sas_definition_attributes_py3.SasDefinitionAttributes + name: sas_definition_attributes_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.sas_definition_bundle + - name: SasDefinitionBundle + uid: azure.keyvault.v7_0.models.sas_definition_bundle.SasDefinitionBundle + name: sas_definition_bundle + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.sas_definition_bundle_py3 + - name: SasDefinitionBundle + uid: azure.keyvault.v7_0.models.sas_definition_bundle_py3.SasDefinitionBundle + name: sas_definition_bundle_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.sas_definition_create_parameters + - name: SasDefinitionCreateParameters + uid: azure.keyvault.v7_0.models.sas_definition_create_parameters.SasDefinitionCreateParameters + name: sas_definition_create_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.sas_definition_create_parameters_py3 + - name: SasDefinitionCreateParameters + uid: azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters + name: sas_definition_create_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.sas_definition_item + - name: SasDefinitionItem + uid: azure.keyvault.v7_0.models.sas_definition_item.SasDefinitionItem + name: sas_definition_item + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.sas_definition_item_paged + - name: SasDefinitionItemPaged + uid: azure.keyvault.v7_0.models.sas_definition_item_paged.SasDefinitionItemPaged + name: sas_definition_item_paged + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.sas_definition_item_py3 + - name: SasDefinitionItem + uid: azure.keyvault.v7_0.models.sas_definition_item_py3.SasDefinitionItem + name: sas_definition_item_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.sas_definition_update_parameters + - name: SasDefinitionUpdateParameters + uid: azure.keyvault.v7_0.models.sas_definition_update_parameters.SasDefinitionUpdateParameters + name: sas_definition_update_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.sas_definition_update_parameters_py3 + - name: SasDefinitionUpdateParameters + uid: azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters + name: sas_definition_update_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.secret_attributes + - name: SecretAttributes + uid: azure.keyvault.v7_0.models.secret_attributes.SecretAttributes + name: secret_attributes + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.secret_attributes_py3 + - name: SecretAttributes + uid: azure.keyvault.v7_0.models.secret_attributes_py3.SecretAttributes + name: secret_attributes_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.secret_bundle + - name: SecretBundle + uid: azure.keyvault.v7_0.models.secret_bundle.SecretBundle + name: secret_bundle + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.secret_bundle_py3 + - name: SecretBundle + uid: azure.keyvault.v7_0.models.secret_bundle_py3.SecretBundle + name: secret_bundle_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.secret_item + - name: SecretItem + uid: azure.keyvault.v7_0.models.secret_item.SecretItem + name: secret_item + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.secret_item_paged + - name: SecretItemPaged + uid: azure.keyvault.v7_0.models.secret_item_paged.SecretItemPaged + name: secret_item_paged + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.secret_item_py3 + - name: SecretItem + uid: azure.keyvault.v7_0.models.secret_item_py3.SecretItem + name: secret_item_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.secret_properties + - name: SecretProperties + uid: azure.keyvault.v7_0.models.secret_properties.SecretProperties + name: secret_properties + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.secret_properties_py3 + - name: SecretProperties + uid: azure.keyvault.v7_0.models.secret_properties_py3.SecretProperties + name: secret_properties_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.secret_restore_parameters + - name: SecretRestoreParameters + uid: azure.keyvault.v7_0.models.secret_restore_parameters.SecretRestoreParameters + name: secret_restore_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.secret_restore_parameters_py3 + - name: SecretRestoreParameters + uid: azure.keyvault.v7_0.models.secret_restore_parameters_py3.SecretRestoreParameters + name: secret_restore_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.secret_set_parameters + - name: SecretSetParameters + uid: azure.keyvault.v7_0.models.secret_set_parameters.SecretSetParameters + name: secret_set_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.secret_set_parameters_py3 + - name: SecretSetParameters + uid: azure.keyvault.v7_0.models.secret_set_parameters_py3.SecretSetParameters + name: secret_set_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.secret_update_parameters + - name: SecretUpdateParameters + uid: azure.keyvault.v7_0.models.secret_update_parameters.SecretUpdateParameters + name: secret_update_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.secret_update_parameters_py3 + - name: SecretUpdateParameters + uid: azure.keyvault.v7_0.models.secret_update_parameters_py3.SecretUpdateParameters + name: secret_update_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.storage_account_attributes + - name: StorageAccountAttributes + uid: azure.keyvault.v7_0.models.storage_account_attributes.StorageAccountAttributes + name: storage_account_attributes + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.storage_account_attributes_py3 + - name: StorageAccountAttributes + uid: azure.keyvault.v7_0.models.storage_account_attributes_py3.StorageAccountAttributes + name: storage_account_attributes_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.storage_account_create_parameters + - name: StorageAccountCreateParameters + uid: azure.keyvault.v7_0.models.storage_account_create_parameters.StorageAccountCreateParameters + name: storage_account_create_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.storage_account_create_parameters_py3 + - name: StorageAccountCreateParameters + uid: azure.keyvault.v7_0.models.storage_account_create_parameters_py3.StorageAccountCreateParameters + name: storage_account_create_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.storage_account_item + - name: StorageAccountItem + uid: azure.keyvault.v7_0.models.storage_account_item.StorageAccountItem + name: storage_account_item + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.storage_account_item_paged + - name: StorageAccountItemPaged + uid: azure.keyvault.v7_0.models.storage_account_item_paged.StorageAccountItemPaged + name: storage_account_item_paged + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.storage_account_item_py3 + - name: StorageAccountItem + uid: azure.keyvault.v7_0.models.storage_account_item_py3.StorageAccountItem + name: storage_account_item_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters + - name: StorageAccountRegenerteKeyParameters + uid: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters.StorageAccountRegenerteKeyParameters + name: storage_account_regenerte_key_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3 + - name: StorageAccountRegenerteKeyParameters + uid: azure.keyvault.v7_0.models.storage_account_regenerte_key_parameters_py3.StorageAccountRegenerteKeyParameters + name: storage_account_regenerte_key_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.storage_account_update_parameters + - name: StorageAccountUpdateParameters + uid: azure.keyvault.v7_0.models.storage_account_update_parameters.StorageAccountUpdateParameters + name: storage_account_update_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.storage_account_update_parameters_py3 + - name: StorageAccountUpdateParameters + uid: azure.keyvault.v7_0.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters + name: storage_account_update_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.storage_bundle + - name: StorageBundle + uid: azure.keyvault.v7_0.models.storage_bundle.StorageBundle + name: storage_bundle + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.storage_bundle_py3 + - name: StorageBundle + uid: azure.keyvault.v7_0.models.storage_bundle_py3.StorageBundle + name: storage_bundle_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.storage_restore_parameters + - name: StorageRestoreParameters + uid: azure.keyvault.v7_0.models.storage_restore_parameters.StorageRestoreParameters + name: storage_restore_parameters + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.storage_restore_parameters_py3 + - name: StorageRestoreParameters + uid: azure.keyvault.v7_0.models.storage_restore_parameters_py3.StorageRestoreParameters + name: storage_restore_parameters_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.subject_alternative_names + - name: SubjectAlternativeNames + uid: azure.keyvault.v7_0.models.subject_alternative_names.SubjectAlternativeNames + name: subject_alternative_names + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.subject_alternative_names_py3 + - name: SubjectAlternativeNames + uid: azure.keyvault.v7_0.models.subject_alternative_names_py3.SubjectAlternativeNames + name: subject_alternative_names_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.trigger + - name: Trigger + uid: azure.keyvault.v7_0.models.trigger.Trigger + name: trigger + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.trigger_py3 + - name: Trigger + uid: azure.keyvault.v7_0.models.trigger_py3.Trigger + name: trigger_py3 + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.x509_certificate_properties + - name: X509CertificateProperties + uid: azure.keyvault.v7_0.models.x509_certificate_properties.X509CertificateProperties + name: x509_certificate_properties + - items: + - name: Overview + uid: azure.keyvault.v7_0.models.x509_certificate_properties_py3 + - name: X509CertificateProperties + uid: azure.keyvault.v7_0.models.x509_certificate_properties_py3.X509CertificateProperties + name: x509_certificate_properties_py3 + - name: Action + uid: azure.keyvault.v7_0.models.Action + - name: ActionType + uid: azure.keyvault.v7_0.models.ActionType + - name: AdministratorDetails + uid: azure.keyvault.v7_0.models.AdministratorDetails + - name: Attributes + uid: azure.keyvault.v7_0.models.Attributes + - name: BackupCertificateResult + uid: azure.keyvault.v7_0.models.BackupCertificateResult + - name: BackupKeyResult + uid: azure.keyvault.v7_0.models.BackupKeyResult + - name: BackupSecretResult + uid: azure.keyvault.v7_0.models.BackupSecretResult + - name: BackupStorageResult + uid: azure.keyvault.v7_0.models.BackupStorageResult + - name: CertificateAttributes + uid: azure.keyvault.v7_0.models.CertificateAttributes + - name: CertificateBundle + uid: azure.keyvault.v7_0.models.CertificateBundle + - name: CertificateCreateParameters + uid: azure.keyvault.v7_0.models.CertificateCreateParameters + - name: CertificateImportParameters + uid: azure.keyvault.v7_0.models.CertificateImportParameters + - name: CertificateIssuerItem + uid: azure.keyvault.v7_0.models.CertificateIssuerItem + - name: CertificateIssuerItemPaged + uid: azure.keyvault.v7_0.models.CertificateIssuerItemPaged + - name: CertificateIssuerSetParameters + uid: azure.keyvault.v7_0.models.CertificateIssuerSetParameters + - name: CertificateIssuerUpdateParameters + uid: azure.keyvault.v7_0.models.CertificateIssuerUpdateParameters + - name: CertificateItem + uid: azure.keyvault.v7_0.models.CertificateItem + - name: CertificateItemPaged + uid: azure.keyvault.v7_0.models.CertificateItemPaged + - name: CertificateMergeParameters + uid: azure.keyvault.v7_0.models.CertificateMergeParameters + - name: CertificateOperation + uid: azure.keyvault.v7_0.models.CertificateOperation + - name: CertificateOperationUpdateParameter + uid: azure.keyvault.v7_0.models.CertificateOperationUpdateParameter + - name: CertificatePolicy + uid: azure.keyvault.v7_0.models.CertificatePolicy + - name: CertificateRestoreParameters + uid: azure.keyvault.v7_0.models.CertificateRestoreParameters + - name: CertificateUpdateParameters + uid: azure.keyvault.v7_0.models.CertificateUpdateParameters + - name: Contact + uid: azure.keyvault.v7_0.models.Contact + - name: Contacts + uid: azure.keyvault.v7_0.models.Contacts + - name: DeletedCertificateBundle + uid: azure.keyvault.v7_0.models.DeletedCertificateBundle + - name: DeletedCertificateItem + uid: azure.keyvault.v7_0.models.DeletedCertificateItem + - name: DeletedCertificateItemPaged + uid: azure.keyvault.v7_0.models.DeletedCertificateItemPaged + - name: DeletedKeyBundle + uid: azure.keyvault.v7_0.models.DeletedKeyBundle + - name: DeletedKeyItem + uid: azure.keyvault.v7_0.models.DeletedKeyItem + - name: DeletedKeyItemPaged + uid: azure.keyvault.v7_0.models.DeletedKeyItemPaged + - name: DeletedSasDefinitionBundle + uid: azure.keyvault.v7_0.models.DeletedSasDefinitionBundle + - name: DeletedSasDefinitionItem + uid: azure.keyvault.v7_0.models.DeletedSasDefinitionItem + - name: DeletedSasDefinitionItemPaged + uid: azure.keyvault.v7_0.models.DeletedSasDefinitionItemPaged + - name: DeletedSecretBundle + uid: azure.keyvault.v7_0.models.DeletedSecretBundle + - name: DeletedSecretItem + uid: azure.keyvault.v7_0.models.DeletedSecretItem + - name: DeletedSecretItemPaged + uid: azure.keyvault.v7_0.models.DeletedSecretItemPaged + - name: DeletedStorageAccountItem + uid: azure.keyvault.v7_0.models.DeletedStorageAccountItem + - name: DeletedStorageAccountItemPaged + uid: azure.keyvault.v7_0.models.DeletedStorageAccountItemPaged + - name: DeletedStorageBundle + uid: azure.keyvault.v7_0.models.DeletedStorageBundle + - name: DeletionRecoveryLevel + uid: azure.keyvault.v7_0.models.DeletionRecoveryLevel + - name: Error + uid: azure.keyvault.v7_0.models.Error + - name: IssuerAttributes + uid: azure.keyvault.v7_0.models.IssuerAttributes + - name: IssuerBundle + uid: azure.keyvault.v7_0.models.IssuerBundle + - name: IssuerCredentials + uid: azure.keyvault.v7_0.models.IssuerCredentials + - name: IssuerParameters + uid: azure.keyvault.v7_0.models.IssuerParameters + - name: JsonWebKey + uid: azure.keyvault.v7_0.models.JsonWebKey + - name: JsonWebKeyCurveName + uid: azure.keyvault.v7_0.models.JsonWebKeyCurveName + - name: JsonWebKeyEncryptionAlgorithm + uid: azure.keyvault.v7_0.models.JsonWebKeyEncryptionAlgorithm + - name: JsonWebKeyOperation + uid: azure.keyvault.v7_0.models.JsonWebKeyOperation + - name: JsonWebKeySignatureAlgorithm + uid: azure.keyvault.v7_0.models.JsonWebKeySignatureAlgorithm + - name: JsonWebKeyType + uid: azure.keyvault.v7_0.models.JsonWebKeyType + - name: KeyAttributes + uid: azure.keyvault.v7_0.models.KeyAttributes + - name: KeyBundle + uid: azure.keyvault.v7_0.models.KeyBundle + - name: KeyCreateParameters + uid: azure.keyvault.v7_0.models.KeyCreateParameters + - name: KeyImportParameters + uid: azure.keyvault.v7_0.models.KeyImportParameters + - name: KeyItem + uid: azure.keyvault.v7_0.models.KeyItem + - name: KeyItemPaged + uid: azure.keyvault.v7_0.models.KeyItemPaged + - name: KeyOperationResult + uid: azure.keyvault.v7_0.models.KeyOperationResult + - name: KeyOperationsParameters + uid: azure.keyvault.v7_0.models.KeyOperationsParameters + - name: KeyProperties + uid: azure.keyvault.v7_0.models.KeyProperties + - name: KeyRestoreParameters + uid: azure.keyvault.v7_0.models.KeyRestoreParameters + - name: KeySignParameters + uid: azure.keyvault.v7_0.models.KeySignParameters + - name: KeyUpdateParameters + uid: azure.keyvault.v7_0.models.KeyUpdateParameters + - name: KeyUsageType + uid: azure.keyvault.v7_0.models.KeyUsageType + - name: KeyVaultError + uid: azure.keyvault.v7_0.models.KeyVaultError + - name: KeyVaultErrorException + uid: azure.keyvault.v7_0.models.KeyVaultErrorException + - name: KeyVerifyParameters + uid: azure.keyvault.v7_0.models.KeyVerifyParameters + - name: KeyVerifyResult + uid: azure.keyvault.v7_0.models.KeyVerifyResult + - name: LifetimeAction + uid: azure.keyvault.v7_0.models.LifetimeAction + - name: OrganizationDetails + uid: azure.keyvault.v7_0.models.OrganizationDetails + - name: PendingCertificateSigningRequestResult + uid: azure.keyvault.v7_0.models.PendingCertificateSigningRequestResult + - name: SasDefinitionAttributes + uid: azure.keyvault.v7_0.models.SasDefinitionAttributes + - name: SasDefinitionBundle + uid: azure.keyvault.v7_0.models.SasDefinitionBundle + - name: SasDefinitionCreateParameters + uid: azure.keyvault.v7_0.models.SasDefinitionCreateParameters + - name: SasDefinitionItem + uid: azure.keyvault.v7_0.models.SasDefinitionItem + - name: SasDefinitionItemPaged + uid: azure.keyvault.v7_0.models.SasDefinitionItemPaged + - name: SasDefinitionUpdateParameters + uid: azure.keyvault.v7_0.models.SasDefinitionUpdateParameters + - name: SasTokenType + uid: azure.keyvault.v7_0.models.SasTokenType + - name: SecretAttributes + uid: azure.keyvault.v7_0.models.SecretAttributes + - name: SecretBundle + uid: azure.keyvault.v7_0.models.SecretBundle + - name: SecretItem + uid: azure.keyvault.v7_0.models.SecretItem + - name: SecretItemPaged + uid: azure.keyvault.v7_0.models.SecretItemPaged + - name: SecretProperties + uid: azure.keyvault.v7_0.models.SecretProperties + - name: SecretRestoreParameters + uid: azure.keyvault.v7_0.models.SecretRestoreParameters + - name: SecretSetParameters + uid: azure.keyvault.v7_0.models.SecretSetParameters + - name: SecretUpdateParameters + uid: azure.keyvault.v7_0.models.SecretUpdateParameters + - name: StorageAccountAttributes + uid: azure.keyvault.v7_0.models.StorageAccountAttributes + - name: StorageAccountCreateParameters + uid: azure.keyvault.v7_0.models.StorageAccountCreateParameters + - name: StorageAccountItem + uid: azure.keyvault.v7_0.models.StorageAccountItem + - name: StorageAccountItemPaged + uid: azure.keyvault.v7_0.models.StorageAccountItemPaged + - name: StorageAccountRegenerteKeyParameters + uid: azure.keyvault.v7_0.models.StorageAccountRegenerteKeyParameters + - name: StorageAccountUpdateParameters + uid: azure.keyvault.v7_0.models.StorageAccountUpdateParameters + - name: StorageBundle + uid: azure.keyvault.v7_0.models.StorageBundle + - name: StorageRestoreParameters + uid: azure.keyvault.v7_0.models.StorageRestoreParameters + - name: SubjectAlternativeNames + uid: azure.keyvault.v7_0.models.SubjectAlternativeNames + - name: Trigger + uid: azure.keyvault.v7_0.models.Trigger + - name: X509CertificateProperties + uid: azure.keyvault.v7_0.models.X509CertificateProperties + name: models + - items: + - name: Overview + uid: azure.keyvault.v7_0.key_vault_client + - name: KeyVaultClient + uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClient + - name: KeyVaultClientConfiguration + uid: azure.keyvault.v7_0.key_vault_client.KeyVaultClientConfiguration + name: key_vault_client + - name: version + uid: azure.keyvault.v7_0.version + - name: KeyVaultClient + uid: azure.keyvault.v7_0.KeyVaultClient + name: v7_0 + - items: + - name: Overview + uid: azure.keyvault.http_bearer_challenge + - name: HttpBearerChallenge + uid: azure.keyvault.http_bearer_challenge.HttpBearerChallenge + name: http_bearer_challenge + - items: + - name: Overview + uid: azure.keyvault.http_challenge + - name: HttpChallenge + uid: azure.keyvault.http_challenge.HttpChallenge + name: http_challenge + - items: + - name: Overview + uid: azure.keyvault.http_message_security + - name: HttpMessageSecurity + uid: azure.keyvault.http_message_security.HttpMessageSecurity + name: http_message_security + - items: + - name: Overview + uid: azure.keyvault.key_vault_authentication + - name: AccessToken + uid: azure.keyvault.key_vault_authentication.AccessToken + - name: KeyVaultAuthBase + uid: azure.keyvault.key_vault_authentication.KeyVaultAuthBase + - name: KeyVaultAuthentication + uid: azure.keyvault.key_vault_authentication.KeyVaultAuthentication + name: key_vault_authentication + - items: + - name: Overview + uid: azure.keyvault.key_vault_client + - name: KeyVaultClient + uid: azure.keyvault.key_vault_client.KeyVaultClient + - name: KeyVaultClientConfiguration + uid: azure.keyvault.key_vault_client.KeyVaultClientConfiguration + name: key_vault_client + - items: + - name: Overview + uid: azure.keyvault.key_vault_id + - name: CertificateId + uid: azure.keyvault.key_vault_id.CertificateId + - name: CertificateIssuerId + uid: azure.keyvault.key_vault_id.CertificateIssuerId + - name: CertificateOperationId + uid: azure.keyvault.key_vault_id.CertificateOperationId + - name: KeyId + uid: azure.keyvault.key_vault_id.KeyId + - name: KeyVaultCollectionType + uid: azure.keyvault.key_vault_id.KeyVaultCollectionType + - name: KeyVaultId + uid: azure.keyvault.key_vault_id.KeyVaultId + - name: KeyVaultIdentifier + uid: azure.keyvault.key_vault_id.KeyVaultIdentifier + - name: SecretId + uid: azure.keyvault.key_vault_id.SecretId + - name: StorageAccountId + uid: azure.keyvault.key_vault_id.StorageAccountId + - name: StorageSasDefinitionId + uid: azure.keyvault.key_vault_id.StorageSasDefinitionId + name: key_vault_id + - name: models + uid: azure.keyvault.models + - name: version + uid: azure.keyvault.version + - name: AccessToken + uid: azure.keyvault.AccessToken + - name: CertificateId + uid: azure.keyvault.CertificateId + - name: CertificateIssuerId + uid: azure.keyvault.CertificateIssuerId + - name: CertificateOperationId + uid: azure.keyvault.CertificateOperationId + - name: HttpBearerChallenge + uid: azure.keyvault.HttpBearerChallenge + - name: HttpChallenge + uid: azure.keyvault.HttpChallenge + - name: KeyId + uid: azure.keyvault.KeyId + - name: KeyVaultAuthBase + uid: azure.keyvault.KeyVaultAuthBase + - name: KeyVaultAuthentication + uid: azure.keyvault.KeyVaultAuthentication + - name: KeyVaultClient + uid: azure.keyvault.KeyVaultClient + - name: KeyVaultId + uid: azure.keyvault.KeyVaultId + - name: SecretId + uid: azure.keyvault.SecretId + - name: StorageAccountId + uid: azure.keyvault.StorageAccountId + - name: StorageSasDefinitionId + uid: azure.keyvault.StorageSasDefinitionId + name: azure.keyvault +- items: + - name: Overview + uid: azure.loganalytics + - items: + - name: Overview + uid: azure.loganalytics.models + - items: + - name: Overview + uid: azure.loganalytics.models.column + - name: Column + uid: azure.loganalytics.models.column.Column + name: column + - items: + - name: Overview + uid: azure.loganalytics.models.column_py3 + - name: Column + uid: azure.loganalytics.models.column_py3.Column + name: column_py3 + - items: + - name: Overview + uid: azure.loganalytics.models.error_detail + - name: ErrorDetail + uid: azure.loganalytics.models.error_detail.ErrorDetail + name: error_detail + - items: + - name: Overview + uid: azure.loganalytics.models.error_detail_py3 + - name: ErrorDetail + uid: azure.loganalytics.models.error_detail_py3.ErrorDetail + name: error_detail_py3 + - items: + - name: Overview + uid: azure.loganalytics.models.error_info + - name: ErrorInfo + uid: azure.loganalytics.models.error_info.ErrorInfo + name: error_info + - items: + - name: Overview + uid: azure.loganalytics.models.error_info_py3 + - name: ErrorInfo + uid: azure.loganalytics.models.error_info_py3.ErrorInfo + name: error_info_py3 + - items: + - name: Overview + uid: azure.loganalytics.models.error_response + - name: ErrorResponse + uid: azure.loganalytics.models.error_response.ErrorResponse + - name: ErrorResponseException + uid: azure.loganalytics.models.error_response.ErrorResponseException + name: error_response + - items: + - name: Overview + uid: azure.loganalytics.models.error_response_py3 + - name: ErrorResponse + uid: azure.loganalytics.models.error_response_py3.ErrorResponse + - name: ErrorResponseException + uid: azure.loganalytics.models.error_response_py3.ErrorResponseException + name: error_response_py3 + - items: + - name: Overview + uid: azure.loganalytics.models.query_body + - name: QueryBody + uid: azure.loganalytics.models.query_body.QueryBody + name: query_body + - items: + - name: Overview + uid: azure.loganalytics.models.query_body_py3 + - name: QueryBody + uid: azure.loganalytics.models.query_body_py3.QueryBody + name: query_body_py3 + - items: + - name: Overview + uid: azure.loganalytics.models.query_results + - name: QueryResults + uid: azure.loganalytics.models.query_results.QueryResults + name: query_results + - items: + - name: Overview + uid: azure.loganalytics.models.query_results_py3 + - name: QueryResults + uid: azure.loganalytics.models.query_results_py3.QueryResults + name: query_results_py3 + - items: + - name: Overview + uid: azure.loganalytics.models.table + - name: Table + uid: azure.loganalytics.models.table.Table + name: table + - items: + - name: Overview + uid: azure.loganalytics.models.table_py3 + - name: Table + uid: azure.loganalytics.models.table_py3.Table + name: table_py3 + - name: Column + uid: azure.loganalytics.models.Column + - name: ErrorDetail + uid: azure.loganalytics.models.ErrorDetail + - name: ErrorInfo + uid: azure.loganalytics.models.ErrorInfo + - name: ErrorResponse + uid: azure.loganalytics.models.ErrorResponse + - name: ErrorResponseException + uid: azure.loganalytics.models.ErrorResponseException + - name: QueryBody + uid: azure.loganalytics.models.QueryBody + - name: QueryResults + uid: azure.loganalytics.models.QueryResults + - name: Table + uid: azure.loganalytics.models.Table + name: models + - items: + - name: Overview + uid: azure.loganalytics.log_analytics_data_client + - name: LogAnalyticsDataClient + uid: azure.loganalytics.log_analytics_data_client.LogAnalyticsDataClient + - name: LogAnalyticsDataClientConfiguration + uid: azure.loganalytics.log_analytics_data_client.LogAnalyticsDataClientConfiguration + name: log_analytics_data_client + - name: version + uid: azure.loganalytics.version + - name: LogAnalyticsDataClient + uid: azure.loganalytics.LogAnalyticsDataClient + name: azure.loganalytics +- items: + - name: Overview + uid: azure.media.videoanalyzeredge + - name: CertificateSource + uid: azure.media.videoanalyzeredge.CertificateSource + - name: CognitiveServicesVisionProcessor + uid: azure.media.videoanalyzeredge.CognitiveServicesVisionProcessor + - name: CredentialsBase + uid: azure.media.videoanalyzeredge.CredentialsBase + - name: DiscoveredOnvifDevice + uid: azure.media.videoanalyzeredge.DiscoveredOnvifDevice + - name: DiscoveredOnvifDeviceCollection + uid: azure.media.videoanalyzeredge.DiscoveredOnvifDeviceCollection + - name: EndpointBase + uid: azure.media.videoanalyzeredge.EndpointBase + - name: ExtensionProcessorBase + uid: azure.media.videoanalyzeredge.ExtensionProcessorBase + - name: FileSink + uid: azure.media.videoanalyzeredge.FileSink + - name: GrpcExtension + uid: azure.media.videoanalyzeredge.GrpcExtension + - name: GrpcExtensionDataTransfer + uid: azure.media.videoanalyzeredge.GrpcExtensionDataTransfer + - name: GrpcExtensionDataTransferMode + uid: azure.media.videoanalyzeredge.GrpcExtensionDataTransferMode + - name: H264Configuration + uid: azure.media.videoanalyzeredge.H264Configuration + - name: H264Profile + uid: azure.media.videoanalyzeredge.H264Profile + - name: HttpExtension + uid: azure.media.videoanalyzeredge.HttpExtension + - name: HttpHeaderCredentials + uid: azure.media.videoanalyzeredge.HttpHeaderCredentials + - name: ImageFormatBmp + uid: azure.media.videoanalyzeredge.ImageFormatBmp + - name: ImageFormatJpeg + uid: azure.media.videoanalyzeredge.ImageFormatJpeg + - name: ImageFormatPng + uid: azure.media.videoanalyzeredge.ImageFormatPng + - name: ImageFormatProperties + uid: azure.media.videoanalyzeredge.ImageFormatProperties + - name: ImageFormatRaw + uid: azure.media.videoanalyzeredge.ImageFormatRaw + - name: ImageFormatRawPixelFormat + uid: azure.media.videoanalyzeredge.ImageFormatRawPixelFormat + - name: ImageProperties + uid: azure.media.videoanalyzeredge.ImageProperties + - name: ImageScale + uid: azure.media.videoanalyzeredge.ImageScale + - name: ImageScaleMode + uid: azure.media.videoanalyzeredge.ImageScaleMode + - name: IotHubDeviceConnection + uid: azure.media.videoanalyzeredge.IotHubDeviceConnection + - name: IotHubMessageSink + uid: azure.media.videoanalyzeredge.IotHubMessageSink + - name: IotHubMessageSource + uid: azure.media.videoanalyzeredge.IotHubMessageSource + - name: LineCrossingProcessor + uid: azure.media.videoanalyzeredge.LineCrossingProcessor + - name: LivePipeline + uid: azure.media.videoanalyzeredge.LivePipeline + - name: LivePipelineActivateRequest + uid: azure.media.videoanalyzeredge.LivePipelineActivateRequest + - name: LivePipelineCollection + uid: azure.media.videoanalyzeredge.LivePipelineCollection + - name: LivePipelineDeactivateRequest + uid: azure.media.videoanalyzeredge.LivePipelineDeactivateRequest + - name: LivePipelineDeleteRequest + uid: azure.media.videoanalyzeredge.LivePipelineDeleteRequest + - name: LivePipelineGetRequest + uid: azure.media.videoanalyzeredge.LivePipelineGetRequest + - name: LivePipelineListRequest + uid: azure.media.videoanalyzeredge.LivePipelineListRequest + - name: LivePipelineProperties + uid: azure.media.videoanalyzeredge.LivePipelineProperties + - name: LivePipelineSetRequest + uid: azure.media.videoanalyzeredge.LivePipelineSetRequest + - name: LivePipelineSetRequestBody + uid: azure.media.videoanalyzeredge.LivePipelineSetRequestBody + - name: LivePipelineState + uid: azure.media.videoanalyzeredge.LivePipelineState + - name: MPEG4Configuration + uid: azure.media.videoanalyzeredge.MPEG4Configuration + - name: MPEG4Profile + uid: azure.media.videoanalyzeredge.MPEG4Profile + - name: MediaProfile + uid: azure.media.videoanalyzeredge.MediaProfile + - name: MediaUri + uid: azure.media.videoanalyzeredge.MediaUri + - name: MethodRequest + uid: azure.media.videoanalyzeredge.MethodRequest + - name: MethodRequestEmptyBodyBase + uid: azure.media.videoanalyzeredge.MethodRequestEmptyBodyBase + - name: MotionDetectionProcessor + uid: azure.media.videoanalyzeredge.MotionDetectionProcessor + - name: MotionDetectionSensitivity + uid: azure.media.videoanalyzeredge.MotionDetectionSensitivity + - name: NamedLineBase + uid: azure.media.videoanalyzeredge.NamedLineBase + - name: NamedLineString + uid: azure.media.videoanalyzeredge.NamedLineString + - name: NamedPolygonBase + uid: azure.media.videoanalyzeredge.NamedPolygonBase + - name: NamedPolygonString + uid: azure.media.videoanalyzeredge.NamedPolygonString + - name: NodeInput + uid: azure.media.videoanalyzeredge.NodeInput + - name: ObjectTrackingAccuracy + uid: azure.media.videoanalyzeredge.ObjectTrackingAccuracy + - name: ObjectTrackingProcessor + uid: azure.media.videoanalyzeredge.ObjectTrackingProcessor + - name: OnvifDevice + uid: azure.media.videoanalyzeredge.OnvifDevice + - name: OnvifDeviceDiscoverRequest + uid: azure.media.videoanalyzeredge.OnvifDeviceDiscoverRequest + - name: OnvifDeviceGetRequest + uid: azure.media.videoanalyzeredge.OnvifDeviceGetRequest + - name: OnvifDns + uid: azure.media.videoanalyzeredge.OnvifDns + - name: OnvifHostName + uid: azure.media.videoanalyzeredge.OnvifHostName + - name: OnvifSystemDateTime + uid: azure.media.videoanalyzeredge.OnvifSystemDateTime + - name: OnvifSystemDateTimeType + uid: azure.media.videoanalyzeredge.OnvifSystemDateTimeType + - name: OutputSelector + uid: azure.media.videoanalyzeredge.OutputSelector + - name: OutputSelectorOperator + uid: azure.media.videoanalyzeredge.OutputSelectorOperator + - name: OutputSelectorProperty + uid: azure.media.videoanalyzeredge.OutputSelectorProperty + - name: ParameterDeclaration + uid: azure.media.videoanalyzeredge.ParameterDeclaration + - name: ParameterDefinition + uid: azure.media.videoanalyzeredge.ParameterDefinition + - name: ParameterType + uid: azure.media.videoanalyzeredge.ParameterType + - name: PemCertificateList + uid: azure.media.videoanalyzeredge.PemCertificateList + - name: PipelineTopology + uid: azure.media.videoanalyzeredge.PipelineTopology + - name: PipelineTopologyCollection + uid: azure.media.videoanalyzeredge.PipelineTopologyCollection + - name: PipelineTopologyDeleteRequest + uid: azure.media.videoanalyzeredge.PipelineTopologyDeleteRequest + - name: PipelineTopologyGetRequest + uid: azure.media.videoanalyzeredge.PipelineTopologyGetRequest + - name: PipelineTopologyListRequest + uid: azure.media.videoanalyzeredge.PipelineTopologyListRequest + - name: PipelineTopologyProperties + uid: azure.media.videoanalyzeredge.PipelineTopologyProperties + - name: PipelineTopologySetRequest + uid: azure.media.videoanalyzeredge.PipelineTopologySetRequest + - name: PipelineTopologySetRequestBody + uid: azure.media.videoanalyzeredge.PipelineTopologySetRequestBody + - name: ProcessorNodeBase + uid: azure.media.videoanalyzeredge.ProcessorNodeBase + - name: RateControl + uid: azure.media.videoanalyzeredge.RateControl + - name: RemoteDeviceAdapter + uid: azure.media.videoanalyzeredge.RemoteDeviceAdapter + - name: RemoteDeviceAdapterCollection + uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterCollection + - name: RemoteDeviceAdapterDeleteRequest + uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterDeleteRequest + - name: RemoteDeviceAdapterGetRequest + uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterGetRequest + - name: RemoteDeviceAdapterListRequest + uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterListRequest + - name: RemoteDeviceAdapterProperties + uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterProperties + - name: RemoteDeviceAdapterSetRequest + uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequest + - name: RemoteDeviceAdapterSetRequestBody + uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequestBody + - name: RemoteDeviceAdapterTarget + uid: azure.media.videoanalyzeredge.RemoteDeviceAdapterTarget + - name: RtspSource + uid: azure.media.videoanalyzeredge.RtspSource + - name: RtspTransport + uid: azure.media.videoanalyzeredge.RtspTransport + - name: SamplingOptions + uid: azure.media.videoanalyzeredge.SamplingOptions + - name: SignalGateProcessor + uid: azure.media.videoanalyzeredge.SignalGateProcessor + - name: SinkNodeBase + uid: azure.media.videoanalyzeredge.SinkNodeBase + - name: SourceNodeBase + uid: azure.media.videoanalyzeredge.SourceNodeBase + - name: SpatialAnalysisCustomOperation + uid: azure.media.videoanalyzeredge.SpatialAnalysisCustomOperation + - name: SpatialAnalysisOperationBase + uid: azure.media.videoanalyzeredge.SpatialAnalysisOperationBase + - name: SpatialAnalysisOperationEventBase + uid: azure.media.videoanalyzeredge.SpatialAnalysisOperationEventBase + - name: SpatialAnalysisOperationFocus + uid: azure.media.videoanalyzeredge.SpatialAnalysisOperationFocus + - name: SpatialAnalysisPersonCountEvent + uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEvent + - name: SpatialAnalysisPersonCountEventTrigger + uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEventTrigger + - name: SpatialAnalysisPersonCountOperation + uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountOperation + - name: SpatialAnalysisPersonCountZoneEvents + uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonCountZoneEvents + - name: SpatialAnalysisPersonDistanceEvent + uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEvent + - name: SpatialAnalysisPersonDistanceEventTrigger + uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEventTrigger + - name: SpatialAnalysisPersonDistanceOperation + uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceOperation + - name: SpatialAnalysisPersonDistanceZoneEvents + uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceZoneEvents + - name: SpatialAnalysisPersonLineCrossingEvent + uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingEvent + - name: SpatialAnalysisPersonLineCrossingLineEvents + uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingLineEvents + - name: SpatialAnalysisPersonLineCrossingOperation + uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingOperation + - name: SpatialAnalysisPersonZoneCrossingEvent + uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEvent + - name: SpatialAnalysisPersonZoneCrossingEventType + uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEventType + - name: SpatialAnalysisPersonZoneCrossingOperation + uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingOperation + - name: SpatialAnalysisPersonZoneCrossingZoneEvents + uid: azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingZoneEvents + - name: SpatialAnalysisTypedOperationBase + uid: azure.media.videoanalyzeredge.SpatialAnalysisTypedOperationBase + - name: SymmetricKeyCredentials + uid: azure.media.videoanalyzeredge.SymmetricKeyCredentials + - name: SystemData + uid: azure.media.videoanalyzeredge.SystemData + - name: TlsEndpoint + uid: azure.media.videoanalyzeredge.TlsEndpoint + - name: TlsValidationOptions + uid: azure.media.videoanalyzeredge.TlsValidationOptions + - name: UnsecuredEndpoint + uid: azure.media.videoanalyzeredge.UnsecuredEndpoint + - name: UsernamePasswordCredentials + uid: azure.media.videoanalyzeredge.UsernamePasswordCredentials + - name: VideoCreationProperties + uid: azure.media.videoanalyzeredge.VideoCreationProperties + - name: VideoEncoderConfiguration + uid: azure.media.videoanalyzeredge.VideoEncoderConfiguration + - name: VideoEncoding + uid: azure.media.videoanalyzeredge.VideoEncoding + - name: VideoPublishingOptions + uid: azure.media.videoanalyzeredge.VideoPublishingOptions + - name: VideoResolution + uid: azure.media.videoanalyzeredge.VideoResolution + - name: VideoSink + uid: azure.media.videoanalyzeredge.VideoSink + name: azure.media.videoanalyzeredge +- items: + - name: Overview + uid: azure.mgmt.agfood + - items: + - name: Overview + uid: azure.mgmt.agfood.aio + - items: + - name: Overview + uid: azure.mgmt.agfood.aio.operations + - name: ExtensionsOperations + uid: azure.mgmt.agfood.aio.operations.ExtensionsOperations + - name: FarmBeatsExtensionsOperations + uid: azure.mgmt.agfood.aio.operations.FarmBeatsExtensionsOperations + - name: FarmBeatsModelsOperations + uid: azure.mgmt.agfood.aio.operations.FarmBeatsModelsOperations + - name: LocationsOperations + uid: azure.mgmt.agfood.aio.operations.LocationsOperations + - name: Operations + uid: azure.mgmt.agfood.aio.operations.Operations + name: operations + - name: AzureAgFoodPlatformRPService + uid: azure.mgmt.agfood.aio.AzureAgFoodPlatformRPService + name: aio + - items: + - name: Overview + uid: azure.mgmt.agfood.models + - name: ActionType + uid: azure.mgmt.agfood.models.ActionType + - name: CheckNameAvailabilityReason + uid: azure.mgmt.agfood.models.CheckNameAvailabilityReason + - name: CheckNameAvailabilityRequest + uid: azure.mgmt.agfood.models.CheckNameAvailabilityRequest + - name: CheckNameAvailabilityResponse + uid: azure.mgmt.agfood.models.CheckNameAvailabilityResponse + - name: CreatedByType + uid: azure.mgmt.agfood.models.CreatedByType + - name: DetailedInformation + uid: azure.mgmt.agfood.models.DetailedInformation + - name: ErrorAdditionalInfo + uid: azure.mgmt.agfood.models.ErrorAdditionalInfo + - name: ErrorDetail + uid: azure.mgmt.agfood.models.ErrorDetail + - name: ErrorResponse + uid: azure.mgmt.agfood.models.ErrorResponse + - name: Extension + uid: azure.mgmt.agfood.models.Extension + - name: ExtensionListResponse + uid: azure.mgmt.agfood.models.ExtensionListResponse + - name: FarmBeats + uid: azure.mgmt.agfood.models.FarmBeats + - name: FarmBeatsExtension + uid: azure.mgmt.agfood.models.FarmBeatsExtension + - name: FarmBeatsExtensionListResponse + uid: azure.mgmt.agfood.models.FarmBeatsExtensionListResponse + - name: FarmBeatsListResponse + uid: azure.mgmt.agfood.models.FarmBeatsListResponse + - name: FarmBeatsUpdateRequestModel + uid: azure.mgmt.agfood.models.FarmBeatsUpdateRequestModel + - name: Operation + uid: azure.mgmt.agfood.models.Operation + - name: OperationDisplay + uid: azure.mgmt.agfood.models.OperationDisplay + - name: OperationListResult + uid: azure.mgmt.agfood.models.OperationListResult + - name: Origin + uid: azure.mgmt.agfood.models.Origin + - name: ProvisioningState + uid: azure.mgmt.agfood.models.ProvisioningState + - name: ProxyResource + uid: azure.mgmt.agfood.models.ProxyResource + - name: Resource + uid: azure.mgmt.agfood.models.Resource + - name: SystemData + uid: azure.mgmt.agfood.models.SystemData + - name: TrackedResource + uid: azure.mgmt.agfood.models.TrackedResource + - name: UnitSystemsInfo + uid: azure.mgmt.agfood.models.UnitSystemsInfo + name: models + - items: + - name: Overview + uid: azure.mgmt.agfood.operations + - name: ExtensionsOperations + uid: azure.mgmt.agfood.operations.ExtensionsOperations + - name: FarmBeatsExtensionsOperations + uid: azure.mgmt.agfood.operations.FarmBeatsExtensionsOperations + - name: FarmBeatsModelsOperations + uid: azure.mgmt.agfood.operations.FarmBeatsModelsOperations + - name: LocationsOperations + uid: azure.mgmt.agfood.operations.LocationsOperations + - name: Operations + uid: azure.mgmt.agfood.operations.Operations + name: operations + - name: AzureAgFoodPlatformRPService + uid: azure.mgmt.agfood.AzureAgFoodPlatformRPService + name: azure.mgmt.agfood +- items: + - name: Overview + uid: azure.mgmt.app + - items: + - name: Overview + uid: azure.mgmt.app.aio + - items: + - name: Overview + uid: azure.mgmt.app.aio.operations + - name: CertificatesOperations + uid: azure.mgmt.app.aio.operations.CertificatesOperations + - name: ContainerAppsAuthConfigsOperations + uid: azure.mgmt.app.aio.operations.ContainerAppsAuthConfigsOperations + - name: ContainerAppsOperations + uid: azure.mgmt.app.aio.operations.ContainerAppsOperations + - name: ContainerAppsRevisionReplicasOperations + uid: azure.mgmt.app.aio.operations.ContainerAppsRevisionReplicasOperations + - name: ContainerAppsRevisionsOperations + uid: azure.mgmt.app.aio.operations.ContainerAppsRevisionsOperations + - name: ContainerAppsSourceControlsOperations + uid: azure.mgmt.app.aio.operations.ContainerAppsSourceControlsOperations + - name: DaprComponentsOperations + uid: azure.mgmt.app.aio.operations.DaprComponentsOperations + - name: ManagedEnvironmentsOperations + uid: azure.mgmt.app.aio.operations.ManagedEnvironmentsOperations + - name: ManagedEnvironmentsStoragesOperations + uid: azure.mgmt.app.aio.operations.ManagedEnvironmentsStoragesOperations + - name: Operations + uid: azure.mgmt.app.aio.operations.Operations + name: operations + - name: ContainerAppsAPIClient + uid: azure.mgmt.app.aio.ContainerAppsAPIClient + name: aio + - items: + - name: Overview + uid: azure.mgmt.app.models + - name: AccessMode + uid: azure.mgmt.app.models.AccessMode + - name: ActiveRevisionsMode + uid: azure.mgmt.app.models.ActiveRevisionsMode + - name: AllowedAudiencesValidation + uid: azure.mgmt.app.models.AllowedAudiencesValidation + - name: AllowedPrincipals + uid: azure.mgmt.app.models.AllowedPrincipals + - name: AppLogsConfiguration + uid: azure.mgmt.app.models.AppLogsConfiguration + - name: AppProtocol + uid: azure.mgmt.app.models.AppProtocol + - name: AppRegistration + uid: azure.mgmt.app.models.AppRegistration + - name: Apple + uid: azure.mgmt.app.models.Apple + - name: AppleRegistration + uid: azure.mgmt.app.models.AppleRegistration + - name: AuthConfig + uid: azure.mgmt.app.models.AuthConfig + - name: AuthConfigCollection + uid: azure.mgmt.app.models.AuthConfigCollection + - name: AuthPlatform + uid: azure.mgmt.app.models.AuthPlatform + - name: AvailableOperations + uid: azure.mgmt.app.models.AvailableOperations + - name: AzureActiveDirectory + uid: azure.mgmt.app.models.AzureActiveDirectory + - name: AzureActiveDirectoryLogin + uid: azure.mgmt.app.models.AzureActiveDirectoryLogin + - name: AzureActiveDirectoryRegistration + uid: azure.mgmt.app.models.AzureActiveDirectoryRegistration + - name: AzureActiveDirectoryValidation + uid: azure.mgmt.app.models.AzureActiveDirectoryValidation + - name: AzureCredentials + uid: azure.mgmt.app.models.AzureCredentials + - name: AzureFileProperties + uid: azure.mgmt.app.models.AzureFileProperties + - name: AzureStaticWebApps + uid: azure.mgmt.app.models.AzureStaticWebApps + - name: AzureStaticWebAppsRegistration + uid: azure.mgmt.app.models.AzureStaticWebAppsRegistration + - name: BindingType + uid: azure.mgmt.app.models.BindingType + - name: Certificate + uid: azure.mgmt.app.models.Certificate + - name: CertificateCollection + uid: azure.mgmt.app.models.CertificateCollection + - name: CertificatePatch + uid: azure.mgmt.app.models.CertificatePatch + - name: CertificateProperties + uid: azure.mgmt.app.models.CertificateProperties + - name: CertificateProvisioningState + uid: azure.mgmt.app.models.CertificateProvisioningState + - name: ClientRegistration + uid: azure.mgmt.app.models.ClientRegistration + - name: Configuration + uid: azure.mgmt.app.models.Configuration + - name: Container + uid: azure.mgmt.app.models.Container + - name: ContainerApp + uid: azure.mgmt.app.models.ContainerApp + - name: ContainerAppCollection + uid: azure.mgmt.app.models.ContainerAppCollection + - name: ContainerAppPatch + uid: azure.mgmt.app.models.ContainerAppPatch + - name: ContainerAppProbe + uid: azure.mgmt.app.models.ContainerAppProbe + - name: ContainerAppProbeHttpGet + uid: azure.mgmt.app.models.ContainerAppProbeHttpGet + - name: ContainerAppProbeHttpGetHttpHeadersItem + uid: azure.mgmt.app.models.ContainerAppProbeHttpGetHttpHeadersItem + - name: ContainerAppProbeTcpSocket + uid: azure.mgmt.app.models.ContainerAppProbeTcpSocket + - name: ContainerAppProvisioningState + uid: azure.mgmt.app.models.ContainerAppProvisioningState + - name: ContainerAppSecret + uid: azure.mgmt.app.models.ContainerAppSecret + - name: ContainerResources + uid: azure.mgmt.app.models.ContainerResources + - name: CookieExpiration + uid: azure.mgmt.app.models.CookieExpiration + - name: CookieExpirationConvention + uid: azure.mgmt.app.models.CookieExpirationConvention + - name: CreatedByType + uid: azure.mgmt.app.models.CreatedByType + - name: CustomDomain + uid: azure.mgmt.app.models.CustomDomain + - name: CustomHostnameAnalysisResult + uid: azure.mgmt.app.models.CustomHostnameAnalysisResult + - name: CustomOpenIdConnectProvider + uid: azure.mgmt.app.models.CustomOpenIdConnectProvider + - name: CustomScaleRule + uid: azure.mgmt.app.models.CustomScaleRule + - name: Dapr + uid: azure.mgmt.app.models.Dapr + - name: DaprComponent + uid: azure.mgmt.app.models.DaprComponent + - name: DaprComponentsCollection + uid: azure.mgmt.app.models.DaprComponentsCollection + - name: DaprMetadata + uid: azure.mgmt.app.models.DaprMetadata + - name: DefaultAuthorizationPolicy + uid: azure.mgmt.app.models.DefaultAuthorizationPolicy + - name: DefaultErrorResponse + uid: azure.mgmt.app.models.DefaultErrorResponse + - name: DefaultErrorResponseError + uid: azure.mgmt.app.models.DefaultErrorResponseError + - name: DefaultErrorResponseErrorDetailsItem + uid: azure.mgmt.app.models.DefaultErrorResponseErrorDetailsItem + - name: DnsVerificationTestResult + uid: azure.mgmt.app.models.DnsVerificationTestResult + - name: EnvironmentProvisioningState + uid: azure.mgmt.app.models.EnvironmentProvisioningState + - name: EnvironmentVar + uid: azure.mgmt.app.models.EnvironmentVar + - name: Facebook + uid: azure.mgmt.app.models.Facebook + - name: ForwardProxy + uid: azure.mgmt.app.models.ForwardProxy + - name: ForwardProxyConvention + uid: azure.mgmt.app.models.ForwardProxyConvention + - name: GitHub + uid: azure.mgmt.app.models.GitHub + - name: GithubActionConfiguration + uid: azure.mgmt.app.models.GithubActionConfiguration + - name: GlobalValidation + uid: azure.mgmt.app.models.GlobalValidation + - name: Google + uid: azure.mgmt.app.models.Google + - name: HttpScaleRule + uid: azure.mgmt.app.models.HttpScaleRule + - name: HttpSettings + uid: azure.mgmt.app.models.HttpSettings + - name: HttpSettingsRoutes + uid: azure.mgmt.app.models.HttpSettingsRoutes + - name: IdentityProviders + uid: azure.mgmt.app.models.IdentityProviders + - name: Ingress + uid: azure.mgmt.app.models.Ingress + - name: IngressTransportMethod + uid: azure.mgmt.app.models.IngressTransportMethod + - name: JwtClaimChecks + uid: azure.mgmt.app.models.JwtClaimChecks + - name: LogAnalyticsConfiguration + uid: azure.mgmt.app.models.LogAnalyticsConfiguration + - name: Login + uid: azure.mgmt.app.models.Login + - name: LoginRoutes + uid: azure.mgmt.app.models.LoginRoutes + - name: LoginScopes + uid: azure.mgmt.app.models.LoginScopes + - name: ManagedEnvironment + uid: azure.mgmt.app.models.ManagedEnvironment + - name: ManagedEnvironmentPatch + uid: azure.mgmt.app.models.ManagedEnvironmentPatch + - name: ManagedEnvironmentStorage + uid: azure.mgmt.app.models.ManagedEnvironmentStorage + - name: ManagedEnvironmentStorageProperties + uid: azure.mgmt.app.models.ManagedEnvironmentStorageProperties + - name: ManagedEnvironmentStoragesCollection + uid: azure.mgmt.app.models.ManagedEnvironmentStoragesCollection + - name: ManagedEnvironmentsCollection + uid: azure.mgmt.app.models.ManagedEnvironmentsCollection + - name: ManagedServiceIdentity + uid: azure.mgmt.app.models.ManagedServiceIdentity + - name: ManagedServiceIdentityType + uid: azure.mgmt.app.models.ManagedServiceIdentityType + - name: Nonce + uid: azure.mgmt.app.models.Nonce + - name: OpenIdConnectClientCredential + uid: azure.mgmt.app.models.OpenIdConnectClientCredential + - name: OpenIdConnectConfig + uid: azure.mgmt.app.models.OpenIdConnectConfig + - name: OpenIdConnectLogin + uid: azure.mgmt.app.models.OpenIdConnectLogin + - name: OpenIdConnectRegistration + uid: azure.mgmt.app.models.OpenIdConnectRegistration + - name: OperationDetail + uid: azure.mgmt.app.models.OperationDetail + - name: OperationDisplay + uid: azure.mgmt.app.models.OperationDisplay + - name: ProxyResource + uid: azure.mgmt.app.models.ProxyResource + - name: QueueScaleRule + uid: azure.mgmt.app.models.QueueScaleRule + - name: RegistryCredentials + uid: azure.mgmt.app.models.RegistryCredentials + - name: RegistryInfo + uid: azure.mgmt.app.models.RegistryInfo + - name: Replica + uid: azure.mgmt.app.models.Replica + - name: ReplicaCollection + uid: azure.mgmt.app.models.ReplicaCollection + - name: ReplicaContainer + uid: azure.mgmt.app.models.ReplicaContainer + - name: Resource + uid: azure.mgmt.app.models.Resource + - name: Revision + uid: azure.mgmt.app.models.Revision + - name: RevisionCollection + uid: azure.mgmt.app.models.RevisionCollection + - name: RevisionHealthState + uid: azure.mgmt.app.models.RevisionHealthState + - name: RevisionProvisioningState + uid: azure.mgmt.app.models.RevisionProvisioningState + - name: Scale + uid: azure.mgmt.app.models.Scale + - name: ScaleRule + uid: azure.mgmt.app.models.ScaleRule + - name: ScaleRuleAuth + uid: azure.mgmt.app.models.ScaleRuleAuth + - name: Secret + uid: azure.mgmt.app.models.Secret + - name: SecretsCollection + uid: azure.mgmt.app.models.SecretsCollection + - name: SourceControl + uid: azure.mgmt.app.models.SourceControl + - name: SourceControlCollection + uid: azure.mgmt.app.models.SourceControlCollection + - name: SourceControlOperationState + uid: azure.mgmt.app.models.SourceControlOperationState + - name: StorageType + uid: azure.mgmt.app.models.StorageType + - name: SystemData + uid: azure.mgmt.app.models.SystemData + - name: Template + uid: azure.mgmt.app.models.Template + - name: TrackedResource + uid: azure.mgmt.app.models.TrackedResource + - name: TrafficWeight + uid: azure.mgmt.app.models.TrafficWeight + - name: Twitter + uid: azure.mgmt.app.models.Twitter + - name: TwitterRegistration + uid: azure.mgmt.app.models.TwitterRegistration + - name: Type + uid: azure.mgmt.app.models.Type + - name: UnauthenticatedClientActionV2 + uid: azure.mgmt.app.models.UnauthenticatedClientActionV2 + - name: UserAssignedIdentity + uid: azure.mgmt.app.models.UserAssignedIdentity + - name: VnetConfiguration + uid: azure.mgmt.app.models.VnetConfiguration + - name: Volume + uid: azure.mgmt.app.models.Volume + - name: VolumeMount + uid: azure.mgmt.app.models.VolumeMount + name: models + - items: + - name: Overview + uid: azure.mgmt.app.operations + - name: CertificatesOperations + uid: azure.mgmt.app.operations.CertificatesOperations + - name: ContainerAppsAuthConfigsOperations + uid: azure.mgmt.app.operations.ContainerAppsAuthConfigsOperations + - name: ContainerAppsOperations + uid: azure.mgmt.app.operations.ContainerAppsOperations + - name: ContainerAppsRevisionReplicasOperations + uid: azure.mgmt.app.operations.ContainerAppsRevisionReplicasOperations + - name: ContainerAppsRevisionsOperations + uid: azure.mgmt.app.operations.ContainerAppsRevisionsOperations + - name: ContainerAppsSourceControlsOperations + uid: azure.mgmt.app.operations.ContainerAppsSourceControlsOperations + - name: DaprComponentsOperations + uid: azure.mgmt.app.operations.DaprComponentsOperations + - name: ManagedEnvironmentsOperations + uid: azure.mgmt.app.operations.ManagedEnvironmentsOperations + - name: ManagedEnvironmentsStoragesOperations + uid: azure.mgmt.app.operations.ManagedEnvironmentsStoragesOperations + - name: Operations + uid: azure.mgmt.app.operations.Operations + name: operations + - name: ContainerAppsAPIClient + uid: azure.mgmt.app.ContainerAppsAPIClient + name: azure.mgmt.app +- items: + - name: Overview + uid: azure.mgmt.azureadb2c + - items: + - name: Overview + uid: azure.mgmt.azureadb2c.aio + - name: CPIMConfigurationClient + uid: azure.mgmt.azureadb2c.aio.CPIMConfigurationClient + name: aio + - items: + - name: Overview + uid: azure.mgmt.azureadb2c.v2019_01_01_preview + - items: + - name: Overview + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio + - items: + - name: Overview + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations + - name: B2CTenantsOperations + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.B2CTenantsOperations + - name: Operations + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.operations.Operations + name: operations + - name: CPIMConfigurationClient + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.aio.CPIMConfigurationClient + name: aio + - items: + - name: Overview + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models + - name: AsyncOperationStatus + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatus + - name: AsyncOperationStatusError + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatusError + - name: B2CResourceSKU + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKU + - name: B2CResourceSKUName + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKUName + - name: B2CTenantResource + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResource + - name: B2CTenantResourceList + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResourceList + - name: B2CTenantResourcePropertiesBillingConfig + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResourcePropertiesBillingConfig + - name: B2CTenantUpdateRequest + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantUpdateRequest + - name: BillingType + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.BillingType + - name: CheckNameAvailabilityRequestBody + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.CheckNameAvailabilityRequestBody + - name: CreateTenantRequestBody + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBody + - name: CreateTenantRequestBodyProperties + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBodyProperties + - name: ErrorAdditionalInfo + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.ErrorAdditionalInfo + - name: ErrorResponse + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.ErrorResponse + - name: NameAvailabilityReasonType + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.NameAvailabilityReasonType + - name: NameAvailabilityResponse + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.NameAvailabilityResponse + - name: Operation + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.Operation + - name: OperationDisplay + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.OperationDisplay + - name: OperationListResult + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.OperationListResult + - name: StatusType + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.models.StatusType + name: models + - items: + - name: Overview + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.operations + - name: B2CTenantsOperations + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.operations.B2CTenantsOperations + - name: Operations + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.operations.Operations + name: operations + - name: CPIMConfigurationClient + uid: azure.mgmt.azureadb2c.v2019_01_01_preview.CPIMConfigurationClient + name: v2019_01_01_preview + - items: + - name: Overview + uid: azure.mgmt.azureadb2c.v2020_05_01_preview + - items: + - name: Overview + uid: azure.mgmt.azureadb2c.v2020_05_01_preview.aio + - items: + - name: Overview + uid: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations + - name: GuestUsagesOperations + uid: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.GuestUsagesOperations + - name: Operations + uid: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.operations.Operations + name: operations + - name: CPIMConfigurationClient + uid: azure.mgmt.azureadb2c.v2020_05_01_preview.aio.CPIMConfigurationClient + name: aio + - items: + - name: Overview + uid: azure.mgmt.azureadb2c.v2020_05_01_preview.models + - name: ErrorAdditionalInfo + uid: azure.mgmt.azureadb2c.v2020_05_01_preview.models.ErrorAdditionalInfo + - name: ErrorResponse + uid: azure.mgmt.azureadb2c.v2020_05_01_preview.models.ErrorResponse + - name: GuestUsagesResource + uid: azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResource + - name: GuestUsagesResourceList + uid: azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResourceList + - name: GuestUsagesResourcePatch + uid: azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResourcePatch + - name: Operation + uid: azure.mgmt.azureadb2c.v2020_05_01_preview.models.Operation + - name: OperationDisplay + uid: azure.mgmt.azureadb2c.v2020_05_01_preview.models.OperationDisplay + - name: OperationListResult + uid: azure.mgmt.azureadb2c.v2020_05_01_preview.models.OperationListResult + name: models + - items: + - name: Overview + uid: azure.mgmt.azureadb2c.v2020_05_01_preview.operations + - name: GuestUsagesOperations + uid: azure.mgmt.azureadb2c.v2020_05_01_preview.operations.GuestUsagesOperations + - name: Operations + uid: azure.mgmt.azureadb2c.v2020_05_01_preview.operations.Operations + name: operations + - name: CPIMConfigurationClient + uid: azure.mgmt.azureadb2c.v2020_05_01_preview.CPIMConfigurationClient + name: v2020_05_01_preview + - name: models + uid: azure.mgmt.azureadb2c.models + - name: CPIMConfigurationClient + uid: azure.mgmt.azureadb2c.CPIMConfigurationClient + name: azure.mgmt.azureadb2c +- items: + - name: Overview + uid: azure.mgmt.azurelargeinstance + - items: + - name: Overview + uid: azure.mgmt.azurelargeinstance.aio + - items: + - name: Overview + uid: azure.mgmt.azurelargeinstance.aio.operations + - name: AzureLargeInstanceOperations + uid: azure.mgmt.azurelargeinstance.aio.operations.AzureLargeInstanceOperations + - name: AzureLargeStorageInstanceOperations + uid: azure.mgmt.azurelargeinstance.aio.operations.AzureLargeStorageInstanceOperations + - name: Operations + uid: azure.mgmt.azurelargeinstance.aio.operations.Operations + name: operations + - name: LargeInstanceMgmtClient + uid: azure.mgmt.azurelargeinstance.aio.LargeInstanceMgmtClient + name: aio + - items: + - name: Overview + uid: azure.mgmt.azurelargeinstance.models + - name: ActionType + uid: azure.mgmt.azurelargeinstance.models.ActionType + - name: AzureLargeInstance + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstance + - name: AzureLargeInstanceForcePowerState + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceForcePowerState + - name: AzureLargeInstanceHardwareTypeNamesEnum + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceHardwareTypeNamesEnum + - name: AzureLargeInstanceListResult + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceListResult + - name: AzureLargeInstancePowerStateEnum + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstancePowerStateEnum + - name: AzureLargeInstanceProperties + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProperties + - name: AzureLargeInstanceProvisioningStatesEnum + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProvisioningStatesEnum + - name: AzureLargeInstanceSizeNamesEnum + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceSizeNamesEnum + - name: AzureLargeInstanceTagsUpdate + uid: azure.mgmt.azurelargeinstance.models.AzureLargeInstanceTagsUpdate + - name: AzureLargeStorageInstance + uid: azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstance + - name: AzureLargeStorageInstanceListResult + uid: azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceListResult + - name: AzureLargeStorageInstanceProperties + uid: azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceProperties + - name: AzureLargeStorageInstanceTagsUpdate + uid: azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceTagsUpdate + - name: CreatedByType + uid: azure.mgmt.azurelargeinstance.models.CreatedByType + - name: Disk + uid: azure.mgmt.azurelargeinstance.models.Disk + - name: ErrorAdditionalInfo + uid: azure.mgmt.azurelargeinstance.models.ErrorAdditionalInfo + - name: ErrorDetail + uid: azure.mgmt.azurelargeinstance.models.ErrorDetail + - name: ErrorResponse + uid: azure.mgmt.azurelargeinstance.models.ErrorResponse + - name: ForceState + uid: azure.mgmt.azurelargeinstance.models.ForceState + - name: HardwareProfile + uid: azure.mgmt.azurelargeinstance.models.HardwareProfile + - name: IpAddress + uid: azure.mgmt.azurelargeinstance.models.IpAddress + - name: NetworkProfile + uid: azure.mgmt.azurelargeinstance.models.NetworkProfile + - name: Operation + uid: azure.mgmt.azurelargeinstance.models.Operation + - name: OperationDisplay + uid: azure.mgmt.azurelargeinstance.models.OperationDisplay + - name: OperationListResult + uid: azure.mgmt.azurelargeinstance.models.OperationListResult + - name: OperationStatusResult + uid: azure.mgmt.azurelargeinstance.models.OperationStatusResult + - name: Origin + uid: azure.mgmt.azurelargeinstance.models.Origin + - name: OsProfile + uid: azure.mgmt.azurelargeinstance.models.OsProfile + - name: ProvisioningState + uid: azure.mgmt.azurelargeinstance.models.ProvisioningState + - name: Resource + uid: azure.mgmt.azurelargeinstance.models.Resource + - name: StorageBillingProperties + uid: azure.mgmt.azurelargeinstance.models.StorageBillingProperties + - name: StorageProfile + uid: azure.mgmt.azurelargeinstance.models.StorageProfile + - name: StorageProperties + uid: azure.mgmt.azurelargeinstance.models.StorageProperties + - name: SystemData + uid: azure.mgmt.azurelargeinstance.models.SystemData + - name: Tags + uid: azure.mgmt.azurelargeinstance.models.Tags + - name: TrackedResource + uid: azure.mgmt.azurelargeinstance.models.TrackedResource + - name: Versions + uid: azure.mgmt.azurelargeinstance.models.Versions + name: models + - items: + - name: Overview + uid: azure.mgmt.azurelargeinstance.operations + - name: AzureLargeInstanceOperations + uid: azure.mgmt.azurelargeinstance.operations.AzureLargeInstanceOperations + - name: AzureLargeStorageInstanceOperations + uid: azure.mgmt.azurelargeinstance.operations.AzureLargeStorageInstanceOperations + - name: Operations + uid: azure.mgmt.azurelargeinstance.operations.Operations + name: operations + - name: LargeInstanceMgmtClient + uid: azure.mgmt.azurelargeinstance.LargeInstanceMgmtClient + name: azure.mgmt.azurelargeinstance +- items: + - name: Overview + uid: azure.mgmt.batchai + - items: + - name: Overview + uid: azure.mgmt.batchai.aio + - items: + - name: Overview + uid: azure.mgmt.batchai.aio.operations + - name: ClustersOperations + uid: azure.mgmt.batchai.aio.operations.ClustersOperations + - name: ExperimentsOperations + uid: azure.mgmt.batchai.aio.operations.ExperimentsOperations + - name: FileServersOperations + uid: azure.mgmt.batchai.aio.operations.FileServersOperations + - name: JobsOperations + uid: azure.mgmt.batchai.aio.operations.JobsOperations + - name: Operations + uid: azure.mgmt.batchai.aio.operations.Operations + - name: UsagesOperations + uid: azure.mgmt.batchai.aio.operations.UsagesOperations + - name: WorkspacesOperations + uid: azure.mgmt.batchai.aio.operations.WorkspacesOperations + name: operations + - name: BatchAI + uid: azure.mgmt.batchai.aio.BatchAI + name: aio + - items: + - name: Overview + uid: azure.mgmt.batchai.models + - name: AllocationState + uid: azure.mgmt.batchai.models.AllocationState + - name: AppInsightsReference + uid: azure.mgmt.batchai.models.AppInsightsReference + - name: AutoScaleSettings + uid: azure.mgmt.batchai.models.AutoScaleSettings + - name: AzureBlobFileSystemReference + uid: azure.mgmt.batchai.models.AzureBlobFileSystemReference + - name: AzureFileShareReference + uid: azure.mgmt.batchai.models.AzureFileShareReference + - name: AzureStorageCredentialsInfo + uid: azure.mgmt.batchai.models.AzureStorageCredentialsInfo + - name: BatchAIError + uid: azure.mgmt.batchai.models.BatchAIError + - name: CNTKsettings + uid: azure.mgmt.batchai.models.CNTKsettings + - name: CachingType + uid: azure.mgmt.batchai.models.CachingType + - name: Caffe2Settings + uid: azure.mgmt.batchai.models.Caffe2Settings + - name: CaffeSettings + uid: azure.mgmt.batchai.models.CaffeSettings + - name: ChainerSettings + uid: azure.mgmt.batchai.models.ChainerSettings + - name: CloudErrorBody + uid: azure.mgmt.batchai.models.CloudErrorBody + - name: Cluster + uid: azure.mgmt.batchai.models.Cluster + - name: ClusterCreateParameters + uid: azure.mgmt.batchai.models.ClusterCreateParameters + - name: ClusterListResult + uid: azure.mgmt.batchai.models.ClusterListResult + - name: ClusterUpdateParameters + uid: azure.mgmt.batchai.models.ClusterUpdateParameters + - name: ClustersListByWorkspaceOptions + uid: azure.mgmt.batchai.models.ClustersListByWorkspaceOptions + - name: ContainerSettings + uid: azure.mgmt.batchai.models.ContainerSettings + - name: CustomMpiSettings + uid: azure.mgmt.batchai.models.CustomMpiSettings + - name: CustomToolkitSettings + uid: azure.mgmt.batchai.models.CustomToolkitSettings + - name: DataDisks + uid: azure.mgmt.batchai.models.DataDisks + - name: DeallocationOption + uid: azure.mgmt.batchai.models.DeallocationOption + - name: EnvironmentVariable + uid: azure.mgmt.batchai.models.EnvironmentVariable + - name: EnvironmentVariableWithSecretValue + uid: azure.mgmt.batchai.models.EnvironmentVariableWithSecretValue + - name: ExecutionState + uid: azure.mgmt.batchai.models.ExecutionState + - name: Experiment + uid: azure.mgmt.batchai.models.Experiment + - name: ExperimentListResult + uid: azure.mgmt.batchai.models.ExperimentListResult + - name: ExperimentsListByWorkspaceOptions + uid: azure.mgmt.batchai.models.ExperimentsListByWorkspaceOptions + - name: File + uid: azure.mgmt.batchai.models.File + - name: FileListResult + uid: azure.mgmt.batchai.models.FileListResult + - name: FileServer + uid: azure.mgmt.batchai.models.FileServer + - name: FileServerCreateParameters + uid: azure.mgmt.batchai.models.FileServerCreateParameters + - name: FileServerListResult + uid: azure.mgmt.batchai.models.FileServerListResult + - name: FileServerProvisioningState + uid: azure.mgmt.batchai.models.FileServerProvisioningState + - name: FileServerReference + uid: azure.mgmt.batchai.models.FileServerReference + - name: FileServersListByWorkspaceOptions + uid: azure.mgmt.batchai.models.FileServersListByWorkspaceOptions + - name: FileType + uid: azure.mgmt.batchai.models.FileType + - name: HorovodSettings + uid: azure.mgmt.batchai.models.HorovodSettings + - name: ImageReference + uid: azure.mgmt.batchai.models.ImageReference + - name: ImageSourceRegistry + uid: azure.mgmt.batchai.models.ImageSourceRegistry + - name: InputDirectory + uid: azure.mgmt.batchai.models.InputDirectory + - name: Job + uid: azure.mgmt.batchai.models.Job + - name: JobBasePropertiesConstraints + uid: azure.mgmt.batchai.models.JobBasePropertiesConstraints + - name: JobCreateParameters + uid: azure.mgmt.batchai.models.JobCreateParameters + - name: JobListResult + uid: azure.mgmt.batchai.models.JobListResult + - name: JobPreparation + uid: azure.mgmt.batchai.models.JobPreparation + - name: JobPriority + uid: azure.mgmt.batchai.models.JobPriority + - name: JobPropertiesConstraints + uid: azure.mgmt.batchai.models.JobPropertiesConstraints + - name: JobPropertiesExecutionInfo + uid: azure.mgmt.batchai.models.JobPropertiesExecutionInfo + - name: JobsListByExperimentOptions + uid: azure.mgmt.batchai.models.JobsListByExperimentOptions + - name: JobsListOutputFilesOptions + uid: azure.mgmt.batchai.models.JobsListOutputFilesOptions + - name: KeyVaultSecretReference + uid: azure.mgmt.batchai.models.KeyVaultSecretReference + - name: ListUsagesResult + uid: azure.mgmt.batchai.models.ListUsagesResult + - name: ManualScaleSettings + uid: azure.mgmt.batchai.models.ManualScaleSettings + - name: MountSettings + uid: azure.mgmt.batchai.models.MountSettings + - name: MountVolumes + uid: azure.mgmt.batchai.models.MountVolumes + - name: NameValuePair + uid: azure.mgmt.batchai.models.NameValuePair + - name: NodeSetup + uid: azure.mgmt.batchai.models.NodeSetup + - name: NodeStateCounts + uid: azure.mgmt.batchai.models.NodeStateCounts + - name: Operation + uid: azure.mgmt.batchai.models.Operation + - name: OperationDisplay + uid: azure.mgmt.batchai.models.OperationDisplay + - name: OperationListResult + uid: azure.mgmt.batchai.models.OperationListResult + - name: OutputDirectory + uid: azure.mgmt.batchai.models.OutputDirectory + - name: PerformanceCountersSettings + uid: azure.mgmt.batchai.models.PerformanceCountersSettings + - name: PrivateRegistryCredentials + uid: azure.mgmt.batchai.models.PrivateRegistryCredentials + - name: ProvisioningState + uid: azure.mgmt.batchai.models.ProvisioningState + - name: ProxyResource + uid: azure.mgmt.batchai.models.ProxyResource + - name: PyTorchSettings + uid: azure.mgmt.batchai.models.PyTorchSettings + - name: RemoteLoginInformation + uid: azure.mgmt.batchai.models.RemoteLoginInformation + - name: RemoteLoginInformationListResult + uid: azure.mgmt.batchai.models.RemoteLoginInformationListResult + - name: Resource + uid: azure.mgmt.batchai.models.Resource + - name: ResourceId + uid: azure.mgmt.batchai.models.ResourceId + - name: ScaleSettings + uid: azure.mgmt.batchai.models.ScaleSettings + - name: SetupTask + uid: azure.mgmt.batchai.models.SetupTask + - name: SshConfiguration + uid: azure.mgmt.batchai.models.SshConfiguration + - name: StorageAccountType + uid: azure.mgmt.batchai.models.StorageAccountType + - name: TensorFlowSettings + uid: azure.mgmt.batchai.models.TensorFlowSettings + - name: ToolType + uid: azure.mgmt.batchai.models.ToolType + - name: UnmanagedFileSystemReference + uid: azure.mgmt.batchai.models.UnmanagedFileSystemReference + - name: Usage + uid: azure.mgmt.batchai.models.Usage + - name: UsageName + uid: azure.mgmt.batchai.models.UsageName + - name: UsageUnit + uid: azure.mgmt.batchai.models.UsageUnit + - name: UserAccountSettings + uid: azure.mgmt.batchai.models.UserAccountSettings + - name: VirtualMachineConfiguration + uid: azure.mgmt.batchai.models.VirtualMachineConfiguration + - name: VmPriority + uid: azure.mgmt.batchai.models.VmPriority + - name: Workspace + uid: azure.mgmt.batchai.models.Workspace + - name: WorkspaceCreateParameters + uid: azure.mgmt.batchai.models.WorkspaceCreateParameters + - name: WorkspaceListResult + uid: azure.mgmt.batchai.models.WorkspaceListResult + - name: WorkspaceUpdateParameters + uid: azure.mgmt.batchai.models.WorkspaceUpdateParameters + - name: WorkspacesListByResourceGroupOptions + uid: azure.mgmt.batchai.models.WorkspacesListByResourceGroupOptions + - name: WorkspacesListOptions + uid: azure.mgmt.batchai.models.WorkspacesListOptions + name: models + - items: + - name: Overview + uid: azure.mgmt.batchai.operations + - name: ClustersOperations + uid: azure.mgmt.batchai.operations.ClustersOperations + - name: ExperimentsOperations + uid: azure.mgmt.batchai.operations.ExperimentsOperations + - name: FileServersOperations + uid: azure.mgmt.batchai.operations.FileServersOperations + - name: JobsOperations + uid: azure.mgmt.batchai.operations.JobsOperations + - name: Operations + uid: azure.mgmt.batchai.operations.Operations + - name: UsagesOperations + uid: azure.mgmt.batchai.operations.UsagesOperations + - name: WorkspacesOperations + uid: azure.mgmt.batchai.operations.WorkspacesOperations + name: operations + - name: BatchAI + uid: azure.mgmt.batchai.BatchAI + name: azure.mgmt.batchai +- items: + - name: Overview + uid: azure.mgmt.edgegateway + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.address + - name: Address + uid: azure.mgmt.edgegateway.models.address.Address + name: address + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.address_py3 + - name: Address + uid: azure.mgmt.edgegateway.models.address_py3.Address + name: address_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.alert + - name: Alert + uid: azure.mgmt.edgegateway.models.alert.Alert + name: alert + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.alert_error_details + - name: AlertErrorDetails + uid: azure.mgmt.edgegateway.models.alert_error_details.AlertErrorDetails + name: alert_error_details + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.alert_error_details_py3 + - name: AlertErrorDetails + uid: azure.mgmt.edgegateway.models.alert_error_details_py3.AlertErrorDetails + name: alert_error_details_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.alert_paged + - name: AlertPaged + uid: azure.mgmt.edgegateway.models.alert_paged.AlertPaged + name: alert_paged + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.alert_py3 + - name: Alert + uid: azure.mgmt.edgegateway.models.alert_py3.Alert + name: alert_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.arm_base_model + - name: ARMBaseModel + uid: azure.mgmt.edgegateway.models.arm_base_model.ARMBaseModel + name: arm_base_model + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.arm_base_model_py3 + - name: ARMBaseModel + uid: azure.mgmt.edgegateway.models.arm_base_model_py3.ARMBaseModel + name: arm_base_model_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.asymmetric_encrypted_secret + - name: AsymmetricEncryptedSecret + uid: azure.mgmt.edgegateway.models.asymmetric_encrypted_secret.AsymmetricEncryptedSecret + name: asymmetric_encrypted_secret + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.asymmetric_encrypted_secret_py3 + - name: AsymmetricEncryptedSecret + uid: azure.mgmt.edgegateway.models.asymmetric_encrypted_secret_py3.AsymmetricEncryptedSecret + name: asymmetric_encrypted_secret_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.authentication + - name: Authentication + uid: azure.mgmt.edgegateway.models.authentication.Authentication + name: authentication + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.authentication_py3 + - name: Authentication + uid: azure.mgmt.edgegateway.models.authentication_py3.Authentication + name: authentication_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.azure_container_info + - name: AzureContainerInfo + uid: azure.mgmt.edgegateway.models.azure_container_info.AzureContainerInfo + name: azure_container_info + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.azure_container_info_py3 + - name: AzureContainerInfo + uid: azure.mgmt.edgegateway.models.azure_container_info_py3.AzureContainerInfo + name: azure_container_info_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.bandwidth_schedule + - name: BandwidthSchedule + uid: azure.mgmt.edgegateway.models.bandwidth_schedule.BandwidthSchedule + name: bandwidth_schedule + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.bandwidth_schedule_paged + - name: BandwidthSchedulePaged + uid: azure.mgmt.edgegateway.models.bandwidth_schedule_paged.BandwidthSchedulePaged + name: bandwidth_schedule_paged + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.bandwidth_schedule_py3 + - name: BandwidthSchedule + uid: azure.mgmt.edgegateway.models.bandwidth_schedule_py3.BandwidthSchedule + name: bandwidth_schedule_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.client_access_right + - name: ClientAccessRight + uid: azure.mgmt.edgegateway.models.client_access_right.ClientAccessRight + name: client_access_right + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.client_access_right_py3 + - name: ClientAccessRight + uid: azure.mgmt.edgegateway.models.client_access_right_py3.ClientAccessRight + name: client_access_right_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.contact_details + - name: ContactDetails + uid: azure.mgmt.edgegateway.models.contact_details.ContactDetails + name: contact_details + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.contact_details_py3 + - name: ContactDetails + uid: azure.mgmt.edgegateway.models.contact_details_py3.ContactDetails + name: contact_details_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.data_box_edge_device + - name: DataBoxEdgeDevice + uid: azure.mgmt.edgegateway.models.data_box_edge_device.DataBoxEdgeDevice + name: data_box_edge_device + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.data_box_edge_device_extended_info + - name: DataBoxEdgeDeviceExtendedInfo + uid: azure.mgmt.edgegateway.models.data_box_edge_device_extended_info.DataBoxEdgeDeviceExtendedInfo + name: data_box_edge_device_extended_info + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.data_box_edge_device_extended_info_py3 + - name: DataBoxEdgeDeviceExtendedInfo + uid: azure.mgmt.edgegateway.models.data_box_edge_device_extended_info_py3.DataBoxEdgeDeviceExtendedInfo + name: data_box_edge_device_extended_info_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.data_box_edge_device_paged + - name: DataBoxEdgeDevicePaged + uid: azure.mgmt.edgegateway.models.data_box_edge_device_paged.DataBoxEdgeDevicePaged + name: data_box_edge_device_paged + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.data_box_edge_device_patch + - name: DataBoxEdgeDevicePatch + uid: azure.mgmt.edgegateway.models.data_box_edge_device_patch.DataBoxEdgeDevicePatch + name: data_box_edge_device_patch + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.data_box_edge_device_patch_py3 + - name: DataBoxEdgeDevicePatch + uid: azure.mgmt.edgegateway.models.data_box_edge_device_patch_py3.DataBoxEdgeDevicePatch + name: data_box_edge_device_patch_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.data_box_edge_device_py3 + - name: DataBoxEdgeDevice + uid: azure.mgmt.edgegateway.models.data_box_edge_device_py3.DataBoxEdgeDevice + name: data_box_edge_device_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums + - name: AccountType + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AccountType + - name: AlertSeverity + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AlertSeverity + - name: AuthenticationType + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AuthenticationType + - name: AzureContainerDataFormat + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.AzureContainerDataFormat + - name: ClientPermissionType + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ClientPermissionType + - name: DataBoxEdgeDeviceStatus + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataBoxEdgeDeviceStatus + - name: DataPolicy + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DataPolicy + - name: DayOfWeek + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DayOfWeek + - name: DeviceType + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DeviceType + - name: DownloadPhase + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.DownloadPhase + - name: EncryptionAlgorithm + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.EncryptionAlgorithm + - name: InstallRebootBehavior + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.InstallRebootBehavior + - name: JobStatus + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobStatus + - name: JobType + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.JobType + - name: MetricAggregationType + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricAggregationType + - name: MetricCategory + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricCategory + - name: MetricUnit + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MetricUnit + - name: MonitoringStatus + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.MonitoringStatus + - name: NetworkAdapterDHCPStatus + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterDHCPStatus + - name: NetworkAdapterRDMAStatus + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterRDMAStatus + - name: NetworkAdapterStatus + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkAdapterStatus + - name: NetworkGroup + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.NetworkGroup + - name: OrderState + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.OrderState + - name: PlatformType + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.PlatformType + - name: RoleStatus + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.RoleStatus + - name: RoleTypes + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.RoleTypes + - name: SSLStatus + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SSLStatus + - name: ShareAccessProtocol + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareAccessProtocol + - name: ShareAccessType + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareAccessType + - name: ShareStatus + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.ShareStatus + - name: SkuName + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SkuName + - name: SkuTier + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.SkuTier + - name: TimeGrain + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.TimeGrain + - name: UpdateOperation + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperation + - name: UpdateOperationStage + uid: azure.mgmt.edgegateway.models.data_box_edge_management_client_enums.UpdateOperationStage + name: data_box_edge_management_client_enums + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.file_event_trigger + - name: FileEventTrigger + uid: azure.mgmt.edgegateway.models.file_event_trigger.FileEventTrigger + name: file_event_trigger + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.file_event_trigger_py3 + - name: FileEventTrigger + uid: azure.mgmt.edgegateway.models.file_event_trigger_py3.FileEventTrigger + name: file_event_trigger_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.file_source_info + - name: FileSourceInfo + uid: azure.mgmt.edgegateway.models.file_source_info.FileSourceInfo + name: file_source_info + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.file_source_info_py3 + - name: FileSourceInfo + uid: azure.mgmt.edgegateway.models.file_source_info_py3.FileSourceInfo + name: file_source_info_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.io_tdevice_info + - name: IoTDeviceInfo + uid: azure.mgmt.edgegateway.models.io_tdevice_info.IoTDeviceInfo + name: io_tdevice_info + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.io_tdevice_info_py3 + - name: IoTDeviceInfo + uid: azure.mgmt.edgegateway.models.io_tdevice_info_py3.IoTDeviceInfo + name: io_tdevice_info_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.io_trole + - name: IoTRole + uid: azure.mgmt.edgegateway.models.io_trole.IoTRole + name: io_trole + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.io_trole_py3 + - name: IoTRole + uid: azure.mgmt.edgegateway.models.io_trole_py3.IoTRole + name: io_trole_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.ipv4_config + - name: Ipv4Config + uid: azure.mgmt.edgegateway.models.ipv4_config.Ipv4Config + name: ipv4_config + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.ipv4_config_py3 + - name: Ipv4Config + uid: azure.mgmt.edgegateway.models.ipv4_config_py3.Ipv4Config + name: ipv4_config_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.ipv6_config + - name: Ipv6Config + uid: azure.mgmt.edgegateway.models.ipv6_config.Ipv6Config + name: ipv6_config + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.ipv6_config_py3 + - name: Ipv6Config + uid: azure.mgmt.edgegateway.models.ipv6_config_py3.Ipv6Config + name: ipv6_config_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.job + - name: Job + uid: azure.mgmt.edgegateway.models.job.Job + name: job + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.job_error_details + - name: JobErrorDetails + uid: azure.mgmt.edgegateway.models.job_error_details.JobErrorDetails + name: job_error_details + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.job_error_details_py3 + - name: JobErrorDetails + uid: azure.mgmt.edgegateway.models.job_error_details_py3.JobErrorDetails + name: job_error_details_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.job_error_item + - name: JobErrorItem + uid: azure.mgmt.edgegateway.models.job_error_item.JobErrorItem + name: job_error_item + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.job_error_item_py3 + - name: JobErrorItem + uid: azure.mgmt.edgegateway.models.job_error_item_py3.JobErrorItem + name: job_error_item_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.job_py3 + - name: Job + uid: azure.mgmt.edgegateway.models.job_py3.Job + name: job_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.metric_dimension_v1 + - name: MetricDimensionV1 + uid: azure.mgmt.edgegateway.models.metric_dimension_v1.MetricDimensionV1 + name: metric_dimension_v1 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.metric_dimension_v1_py3 + - name: MetricDimensionV1 + uid: azure.mgmt.edgegateway.models.metric_dimension_v1_py3.MetricDimensionV1 + name: metric_dimension_v1_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.metric_specification_v1 + - name: MetricSpecificationV1 + uid: azure.mgmt.edgegateway.models.metric_specification_v1.MetricSpecificationV1 + name: metric_specification_v1 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.metric_specification_v1_py3 + - name: MetricSpecificationV1 + uid: azure.mgmt.edgegateway.models.metric_specification_v1_py3.MetricSpecificationV1 + name: metric_specification_v1_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.mount_point_map + - name: MountPointMap + uid: azure.mgmt.edgegateway.models.mount_point_map.MountPointMap + name: mount_point_map + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.mount_point_map_py3 + - name: MountPointMap + uid: azure.mgmt.edgegateway.models.mount_point_map_py3.MountPointMap + name: mount_point_map_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.network_adapter + - name: NetworkAdapter + uid: azure.mgmt.edgegateway.models.network_adapter.NetworkAdapter + name: network_adapter + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.network_adapter_position + - name: NetworkAdapterPosition + uid: azure.mgmt.edgegateway.models.network_adapter_position.NetworkAdapterPosition + name: network_adapter_position + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.network_adapter_position_py3 + - name: NetworkAdapterPosition + uid: azure.mgmt.edgegateway.models.network_adapter_position_py3.NetworkAdapterPosition + name: network_adapter_position_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.network_adapter_py3 + - name: NetworkAdapter + uid: azure.mgmt.edgegateway.models.network_adapter_py3.NetworkAdapter + name: network_adapter_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.network_settings + - name: NetworkSettings + uid: azure.mgmt.edgegateway.models.network_settings.NetworkSettings + name: network_settings + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.network_settings_py3 + - name: NetworkSettings + uid: azure.mgmt.edgegateway.models.network_settings_py3.NetworkSettings + name: network_settings_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.operation + - name: Operation + uid: azure.mgmt.edgegateway.models.operation.Operation + name: operation + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.operation_display + - name: OperationDisplay + uid: azure.mgmt.edgegateway.models.operation_display.OperationDisplay + name: operation_display + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.operation_display_py3 + - name: OperationDisplay + uid: azure.mgmt.edgegateway.models.operation_display_py3.OperationDisplay + name: operation_display_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.operation_paged + - name: OperationPaged + uid: azure.mgmt.edgegateway.models.operation_paged.OperationPaged + name: operation_paged + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.operation_py3 + - name: Operation + uid: azure.mgmt.edgegateway.models.operation_py3.Operation + name: operation_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.order + - name: Order + uid: azure.mgmt.edgegateway.models.order.Order + name: order + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.order_paged + - name: OrderPaged + uid: azure.mgmt.edgegateway.models.order_paged.OrderPaged + name: order_paged + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.order_py3 + - name: Order + uid: azure.mgmt.edgegateway.models.order_py3.Order + name: order_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.order_status + - name: OrderStatus + uid: azure.mgmt.edgegateway.models.order_status.OrderStatus + name: order_status + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.order_status_py3 + - name: OrderStatus + uid: azure.mgmt.edgegateway.models.order_status_py3.OrderStatus + name: order_status_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.periodic_timer_event_trigger + - name: PeriodicTimerEventTrigger + uid: azure.mgmt.edgegateway.models.periodic_timer_event_trigger.PeriodicTimerEventTrigger + name: periodic_timer_event_trigger + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.periodic_timer_event_trigger_py3 + - name: PeriodicTimerEventTrigger + uid: azure.mgmt.edgegateway.models.periodic_timer_event_trigger_py3.PeriodicTimerEventTrigger + name: periodic_timer_event_trigger_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.periodic_timer_source_info + - name: PeriodicTimerSourceInfo + uid: azure.mgmt.edgegateway.models.periodic_timer_source_info.PeriodicTimerSourceInfo + name: periodic_timer_source_info + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.periodic_timer_source_info_py3 + - name: PeriodicTimerSourceInfo + uid: azure.mgmt.edgegateway.models.periodic_timer_source_info_py3.PeriodicTimerSourceInfo + name: periodic_timer_source_info_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.refresh_details + - name: RefreshDetails + uid: azure.mgmt.edgegateway.models.refresh_details.RefreshDetails + name: refresh_details + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.refresh_details_py3 + - name: RefreshDetails + uid: azure.mgmt.edgegateway.models.refresh_details_py3.RefreshDetails + name: refresh_details_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.role + - name: Role + uid: azure.mgmt.edgegateway.models.role.Role + name: role + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.role_paged + - name: RolePaged + uid: azure.mgmt.edgegateway.models.role_paged.RolePaged + name: role_paged + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.role_py3 + - name: Role + uid: azure.mgmt.edgegateway.models.role_py3.Role + name: role_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.role_sink_info + - name: RoleSinkInfo + uid: azure.mgmt.edgegateway.models.role_sink_info.RoleSinkInfo + name: role_sink_info + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.role_sink_info_py3 + - name: RoleSinkInfo + uid: azure.mgmt.edgegateway.models.role_sink_info_py3.RoleSinkInfo + name: role_sink_info_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.security_settings + - name: SecuritySettings + uid: azure.mgmt.edgegateway.models.security_settings.SecuritySettings + name: security_settings + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.security_settings_py3 + - name: SecuritySettings + uid: azure.mgmt.edgegateway.models.security_settings_py3.SecuritySettings + name: security_settings_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.service_specification + - name: ServiceSpecification + uid: azure.mgmt.edgegateway.models.service_specification.ServiceSpecification + name: service_specification + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.service_specification_py3 + - name: ServiceSpecification + uid: azure.mgmt.edgegateway.models.service_specification_py3.ServiceSpecification + name: service_specification_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.share + - name: Share + uid: azure.mgmt.edgegateway.models.share.Share + name: share + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.share_access_right + - name: ShareAccessRight + uid: azure.mgmt.edgegateway.models.share_access_right.ShareAccessRight + name: share_access_right + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.share_access_right_py3 + - name: ShareAccessRight + uid: azure.mgmt.edgegateway.models.share_access_right_py3.ShareAccessRight + name: share_access_right_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.share_paged + - name: SharePaged + uid: azure.mgmt.edgegateway.models.share_paged.SharePaged + name: share_paged + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.share_py3 + - name: Share + uid: azure.mgmt.edgegateway.models.share_py3.Share + name: share_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.sku + - name: Sku + uid: azure.mgmt.edgegateway.models.sku.Sku + name: sku + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.sku_py3 + - name: Sku + uid: azure.mgmt.edgegateway.models.sku_py3.Sku + name: sku_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.storage_account_credential + - name: StorageAccountCredential + uid: azure.mgmt.edgegateway.models.storage_account_credential.StorageAccountCredential + name: storage_account_credential + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.storage_account_credential_paged + - name: StorageAccountCredentialPaged + uid: azure.mgmt.edgegateway.models.storage_account_credential_paged.StorageAccountCredentialPaged + name: storage_account_credential_paged + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.storage_account_credential_py3 + - name: StorageAccountCredential + uid: azure.mgmt.edgegateway.models.storage_account_credential_py3.StorageAccountCredential + name: storage_account_credential_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.symmetric_key + - name: SymmetricKey + uid: azure.mgmt.edgegateway.models.symmetric_key.SymmetricKey + name: symmetric_key + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.symmetric_key_py3 + - name: SymmetricKey + uid: azure.mgmt.edgegateway.models.symmetric_key_py3.SymmetricKey + name: symmetric_key_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.tracking_info + - name: TrackingInfo + uid: azure.mgmt.edgegateway.models.tracking_info.TrackingInfo + name: tracking_info + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.tracking_info_py3 + - name: TrackingInfo + uid: azure.mgmt.edgegateway.models.tracking_info_py3.TrackingInfo + name: tracking_info_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.trigger + - name: Trigger + uid: azure.mgmt.edgegateway.models.trigger.Trigger + name: trigger + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.trigger_paged + - name: TriggerPaged + uid: azure.mgmt.edgegateway.models.trigger_paged.TriggerPaged + name: trigger_paged + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.trigger_py3 + - name: Trigger + uid: azure.mgmt.edgegateway.models.trigger_py3.Trigger + name: trigger_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.update_download_progress + - name: UpdateDownloadProgress + uid: azure.mgmt.edgegateway.models.update_download_progress.UpdateDownloadProgress + name: update_download_progress + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.update_download_progress_py3 + - name: UpdateDownloadProgress + uid: azure.mgmt.edgegateway.models.update_download_progress_py3.UpdateDownloadProgress + name: update_download_progress_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.update_install_progress + - name: UpdateInstallProgress + uid: azure.mgmt.edgegateway.models.update_install_progress.UpdateInstallProgress + name: update_install_progress + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.update_install_progress_py3 + - name: UpdateInstallProgress + uid: azure.mgmt.edgegateway.models.update_install_progress_py3.UpdateInstallProgress + name: update_install_progress_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.update_summary + - name: UpdateSummary + uid: azure.mgmt.edgegateway.models.update_summary.UpdateSummary + name: update_summary + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.update_summary_py3 + - name: UpdateSummary + uid: azure.mgmt.edgegateway.models.update_summary_py3.UpdateSummary + name: update_summary_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.upload_certificate_request + - name: UploadCertificateRequest + uid: azure.mgmt.edgegateway.models.upload_certificate_request.UploadCertificateRequest + name: upload_certificate_request + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.upload_certificate_request_py3 + - name: UploadCertificateRequest + uid: azure.mgmt.edgegateway.models.upload_certificate_request_py3.UploadCertificateRequest + name: upload_certificate_request_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.upload_certificate_response + - name: UploadCertificateResponse + uid: azure.mgmt.edgegateway.models.upload_certificate_response.UploadCertificateResponse + name: upload_certificate_response + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.upload_certificate_response_py3 + - name: UploadCertificateResponse + uid: azure.mgmt.edgegateway.models.upload_certificate_response_py3.UploadCertificateResponse + name: upload_certificate_response_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.user + - name: User + uid: azure.mgmt.edgegateway.models.user.User + name: user + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.user_access_right + - name: UserAccessRight + uid: azure.mgmt.edgegateway.models.user_access_right.UserAccessRight + name: user_access_right + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.user_access_right_py3 + - name: UserAccessRight + uid: azure.mgmt.edgegateway.models.user_access_right_py3.UserAccessRight + name: user_access_right_py3 + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.user_paged + - name: UserPaged + uid: azure.mgmt.edgegateway.models.user_paged.UserPaged + name: user_paged + - items: + - name: Overview + uid: azure.mgmt.edgegateway.models.user_py3 + - name: User + uid: azure.mgmt.edgegateway.models.user_py3.User + name: user_py3 + - name: ARMBaseModel + uid: azure.mgmt.edgegateway.models.ARMBaseModel + - name: AccountType + uid: azure.mgmt.edgegateway.models.AccountType + - name: Address + uid: azure.mgmt.edgegateway.models.Address + - name: Alert + uid: azure.mgmt.edgegateway.models.Alert + - name: AlertErrorDetails + uid: azure.mgmt.edgegateway.models.AlertErrorDetails + - name: AlertPaged + uid: azure.mgmt.edgegateway.models.AlertPaged + - name: AlertSeverity + uid: azure.mgmt.edgegateway.models.AlertSeverity + - name: AsymmetricEncryptedSecret + uid: azure.mgmt.edgegateway.models.AsymmetricEncryptedSecret + - name: Authentication + uid: azure.mgmt.edgegateway.models.Authentication + - name: AuthenticationType + uid: azure.mgmt.edgegateway.models.AuthenticationType + - name: AzureContainerDataFormat + uid: azure.mgmt.edgegateway.models.AzureContainerDataFormat + - name: AzureContainerInfo + uid: azure.mgmt.edgegateway.models.AzureContainerInfo + - name: BandwidthSchedule + uid: azure.mgmt.edgegateway.models.BandwidthSchedule + - name: BandwidthSchedulePaged + uid: azure.mgmt.edgegateway.models.BandwidthSchedulePaged + - name: ClientAccessRight + uid: azure.mgmt.edgegateway.models.ClientAccessRight + - name: ClientPermissionType + uid: azure.mgmt.edgegateway.models.ClientPermissionType + - name: ContactDetails + uid: azure.mgmt.edgegateway.models.ContactDetails + - name: DataBoxEdgeDevice + uid: azure.mgmt.edgegateway.models.DataBoxEdgeDevice + - name: DataBoxEdgeDeviceExtendedInfo + uid: azure.mgmt.edgegateway.models.DataBoxEdgeDeviceExtendedInfo + - name: DataBoxEdgeDevicePaged + uid: azure.mgmt.edgegateway.models.DataBoxEdgeDevicePaged + - name: DataBoxEdgeDevicePatch + uid: azure.mgmt.edgegateway.models.DataBoxEdgeDevicePatch + - name: DataBoxEdgeDeviceStatus + uid: azure.mgmt.edgegateway.models.DataBoxEdgeDeviceStatus + - name: DataPolicy + uid: azure.mgmt.edgegateway.models.DataPolicy + - name: DayOfWeek + uid: azure.mgmt.edgegateway.models.DayOfWeek + - name: DeviceType + uid: azure.mgmt.edgegateway.models.DeviceType + - name: DownloadPhase + uid: azure.mgmt.edgegateway.models.DownloadPhase + - name: EncryptionAlgorithm + uid: azure.mgmt.edgegateway.models.EncryptionAlgorithm + - name: FileEventTrigger + uid: azure.mgmt.edgegateway.models.FileEventTrigger + - name: FileSourceInfo + uid: azure.mgmt.edgegateway.models.FileSourceInfo + - name: InstallRebootBehavior + uid: azure.mgmt.edgegateway.models.InstallRebootBehavior + - name: IoTDeviceInfo + uid: azure.mgmt.edgegateway.models.IoTDeviceInfo + - name: IoTRole + uid: azure.mgmt.edgegateway.models.IoTRole + - name: Ipv4Config + uid: azure.mgmt.edgegateway.models.Ipv4Config + - name: Ipv6Config + uid: azure.mgmt.edgegateway.models.Ipv6Config + - name: Job + uid: azure.mgmt.edgegateway.models.Job + - name: JobErrorDetails + uid: azure.mgmt.edgegateway.models.JobErrorDetails + - name: JobErrorItem + uid: azure.mgmt.edgegateway.models.JobErrorItem + - name: JobStatus + uid: azure.mgmt.edgegateway.models.JobStatus + - name: JobType + uid: azure.mgmt.edgegateway.models.JobType + - name: MetricAggregationType + uid: azure.mgmt.edgegateway.models.MetricAggregationType + - name: MetricCategory + uid: azure.mgmt.edgegateway.models.MetricCategory + - name: MetricDimensionV1 + uid: azure.mgmt.edgegateway.models.MetricDimensionV1 + - name: MetricSpecificationV1 + uid: azure.mgmt.edgegateway.models.MetricSpecificationV1 + - name: MetricUnit + uid: azure.mgmt.edgegateway.models.MetricUnit + - name: MonitoringStatus + uid: azure.mgmt.edgegateway.models.MonitoringStatus + - name: MountPointMap + uid: azure.mgmt.edgegateway.models.MountPointMap + - name: NetworkAdapter + uid: azure.mgmt.edgegateway.models.NetworkAdapter + - name: NetworkAdapterDHCPStatus + uid: azure.mgmt.edgegateway.models.NetworkAdapterDHCPStatus + - name: NetworkAdapterPosition + uid: azure.mgmt.edgegateway.models.NetworkAdapterPosition + - name: NetworkAdapterRDMAStatus + uid: azure.mgmt.edgegateway.models.NetworkAdapterRDMAStatus + - name: NetworkAdapterStatus + uid: azure.mgmt.edgegateway.models.NetworkAdapterStatus + - name: NetworkGroup + uid: azure.mgmt.edgegateway.models.NetworkGroup + - name: NetworkSettings + uid: azure.mgmt.edgegateway.models.NetworkSettings + - name: Operation + uid: azure.mgmt.edgegateway.models.Operation + - name: OperationDisplay + uid: azure.mgmt.edgegateway.models.OperationDisplay + - name: OperationPaged + uid: azure.mgmt.edgegateway.models.OperationPaged + - name: Order + uid: azure.mgmt.edgegateway.models.Order + - name: OrderPaged + uid: azure.mgmt.edgegateway.models.OrderPaged + - name: OrderState + uid: azure.mgmt.edgegateway.models.OrderState + - name: OrderStatus + uid: azure.mgmt.edgegateway.models.OrderStatus + - name: PeriodicTimerEventTrigger + uid: azure.mgmt.edgegateway.models.PeriodicTimerEventTrigger + - name: PeriodicTimerSourceInfo + uid: azure.mgmt.edgegateway.models.PeriodicTimerSourceInfo + - name: PlatformType + uid: azure.mgmt.edgegateway.models.PlatformType + - name: RefreshDetails + uid: azure.mgmt.edgegateway.models.RefreshDetails + - name: Role + uid: azure.mgmt.edgegateway.models.Role + - name: RolePaged + uid: azure.mgmt.edgegateway.models.RolePaged + - name: RoleSinkInfo + uid: azure.mgmt.edgegateway.models.RoleSinkInfo + - name: RoleStatus + uid: azure.mgmt.edgegateway.models.RoleStatus + - name: RoleTypes + uid: azure.mgmt.edgegateway.models.RoleTypes + - name: SSLStatus + uid: azure.mgmt.edgegateway.models.SSLStatus + - name: SecuritySettings + uid: azure.mgmt.edgegateway.models.SecuritySettings + - name: ServiceSpecification + uid: azure.mgmt.edgegateway.models.ServiceSpecification + - name: Share + uid: azure.mgmt.edgegateway.models.Share + - name: ShareAccessProtocol + uid: azure.mgmt.edgegateway.models.ShareAccessProtocol + - name: ShareAccessRight + uid: azure.mgmt.edgegateway.models.ShareAccessRight + - name: ShareAccessType + uid: azure.mgmt.edgegateway.models.ShareAccessType + - name: SharePaged + uid: azure.mgmt.edgegateway.models.SharePaged + - name: ShareStatus + uid: azure.mgmt.edgegateway.models.ShareStatus + - name: Sku + uid: azure.mgmt.edgegateway.models.Sku + - name: SkuName + uid: azure.mgmt.edgegateway.models.SkuName + - name: SkuTier + uid: azure.mgmt.edgegateway.models.SkuTier + - name: StorageAccountCredential + uid: azure.mgmt.edgegateway.models.StorageAccountCredential + - name: StorageAccountCredentialPaged + uid: azure.mgmt.edgegateway.models.StorageAccountCredentialPaged + - name: SymmetricKey + uid: azure.mgmt.edgegateway.models.SymmetricKey + - name: TimeGrain + uid: azure.mgmt.edgegateway.models.TimeGrain + - name: TrackingInfo + uid: azure.mgmt.edgegateway.models.TrackingInfo + - name: Trigger + uid: azure.mgmt.edgegateway.models.Trigger + - name: TriggerPaged + uid: azure.mgmt.edgegateway.models.TriggerPaged + - name: UpdateDownloadProgress + uid: azure.mgmt.edgegateway.models.UpdateDownloadProgress + - name: UpdateInstallProgress + uid: azure.mgmt.edgegateway.models.UpdateInstallProgress + - name: UpdateOperation + uid: azure.mgmt.edgegateway.models.UpdateOperation + - name: UpdateOperationStage + uid: azure.mgmt.edgegateway.models.UpdateOperationStage + - name: UpdateSummary + uid: azure.mgmt.edgegateway.models.UpdateSummary + - name: UploadCertificateRequest + uid: azure.mgmt.edgegateway.models.UploadCertificateRequest + - name: UploadCertificateResponse + uid: azure.mgmt.edgegateway.models.UploadCertificateResponse + - name: User + uid: azure.mgmt.edgegateway.models.User + - name: UserAccessRight + uid: azure.mgmt.edgegateway.models.UserAccessRight + - name: UserPaged + uid: azure.mgmt.edgegateway.models.UserPaged + name: models + - items: + - name: Overview + uid: azure.mgmt.edgegateway.operations + - items: + - name: Overview + uid: azure.mgmt.edgegateway.operations.alerts_operations + - name: AlertsOperations + uid: azure.mgmt.edgegateway.operations.alerts_operations.AlertsOperations + name: alerts_operations + - items: + - name: Overview + uid: azure.mgmt.edgegateway.operations.bandwidth_schedules_operations + - name: BandwidthSchedulesOperations + uid: azure.mgmt.edgegateway.operations.bandwidth_schedules_operations.BandwidthSchedulesOperations + name: bandwidth_schedules_operations + - items: + - name: Overview + uid: azure.mgmt.edgegateway.operations.devices_operations + - name: DevicesOperations + uid: azure.mgmt.edgegateway.operations.devices_operations.DevicesOperations + name: devices_operations + - items: + - name: Overview + uid: azure.mgmt.edgegateway.operations.jobs_operations + - name: JobsOperations + uid: azure.mgmt.edgegateway.operations.jobs_operations.JobsOperations + name: jobs_operations + - items: + - name: Overview + uid: azure.mgmt.edgegateway.operations.operations + - name: Operations + uid: azure.mgmt.edgegateway.operations.operations.Operations + name: operations + - items: + - name: Overview + uid: azure.mgmt.edgegateway.operations.operations_status_operations + - name: OperationsStatusOperations + uid: azure.mgmt.edgegateway.operations.operations_status_operations.OperationsStatusOperations + name: operations_status_operations + - items: + - name: Overview + uid: azure.mgmt.edgegateway.operations.orders_operations + - name: OrdersOperations + uid: azure.mgmt.edgegateway.operations.orders_operations.OrdersOperations + name: orders_operations + - items: + - name: Overview + uid: azure.mgmt.edgegateway.operations.roles_operations + - name: RolesOperations + uid: azure.mgmt.edgegateway.operations.roles_operations.RolesOperations + name: roles_operations + - items: + - name: Overview + uid: azure.mgmt.edgegateway.operations.shares_operations + - name: SharesOperations + uid: azure.mgmt.edgegateway.operations.shares_operations.SharesOperations + name: shares_operations + - items: + - name: Overview + uid: azure.mgmt.edgegateway.operations.storage_account_credentials_operations + - name: StorageAccountCredentialsOperations + uid: azure.mgmt.edgegateway.operations.storage_account_credentials_operations.StorageAccountCredentialsOperations + name: storage_account_credentials_operations + - items: + - name: Overview + uid: azure.mgmt.edgegateway.operations.triggers_operations + - name: TriggersOperations + uid: azure.mgmt.edgegateway.operations.triggers_operations.TriggersOperations + name: triggers_operations + - items: + - name: Overview + uid: azure.mgmt.edgegateway.operations.users_operations + - name: UsersOperations + uid: azure.mgmt.edgegateway.operations.users_operations.UsersOperations + name: users_operations + - name: AlertsOperations + uid: azure.mgmt.edgegateway.operations.AlertsOperations + - name: BandwidthSchedulesOperations + uid: azure.mgmt.edgegateway.operations.BandwidthSchedulesOperations + - name: DevicesOperations + uid: azure.mgmt.edgegateway.operations.DevicesOperations + - name: JobsOperations + uid: azure.mgmt.edgegateway.operations.JobsOperations + - name: Operations + uid: azure.mgmt.edgegateway.operations.Operations + - name: OperationsStatusOperations + uid: azure.mgmt.edgegateway.operations.OperationsStatusOperations + - name: OrdersOperations + uid: azure.mgmt.edgegateway.operations.OrdersOperations + - name: RolesOperations + uid: azure.mgmt.edgegateway.operations.RolesOperations + - name: SharesOperations + uid: azure.mgmt.edgegateway.operations.SharesOperations + - name: StorageAccountCredentialsOperations + uid: azure.mgmt.edgegateway.operations.StorageAccountCredentialsOperations + - name: TriggersOperations + uid: azure.mgmt.edgegateway.operations.TriggersOperations + - name: UsersOperations + uid: azure.mgmt.edgegateway.operations.UsersOperations + name: operations + - items: + - name: Overview + uid: azure.mgmt.edgegateway.data_box_edge_management_client + - name: DataBoxEdgeManagementClient + uid: azure.mgmt.edgegateway.data_box_edge_management_client.DataBoxEdgeManagementClient + - name: DataBoxEdgeManagementClientConfiguration + uid: azure.mgmt.edgegateway.data_box_edge_management_client.DataBoxEdgeManagementClientConfiguration + name: data_box_edge_management_client + - name: version + uid: azure.mgmt.edgegateway.version + - name: DataBoxEdgeManagementClient + uid: azure.mgmt.edgegateway.DataBoxEdgeManagementClient + name: azure.mgmt.edgegateway +- items: + - name: Overview + uid: azure.mgmt.logz + - items: + - name: Overview + uid: azure.mgmt.logz.aio + - items: + - name: Overview + uid: azure.mgmt.logz.aio.operations + - name: MonitorOperations + uid: azure.mgmt.logz.aio.operations.MonitorOperations + - name: MonitorsOperations + uid: azure.mgmt.logz.aio.operations.MonitorsOperations + - name: Operations + uid: azure.mgmt.logz.aio.operations.Operations + - name: SingleSignOnOperations + uid: azure.mgmt.logz.aio.operations.SingleSignOnOperations + - name: SubAccountOperations + uid: azure.mgmt.logz.aio.operations.SubAccountOperations + - name: SubAccountTagRulesOperations + uid: azure.mgmt.logz.aio.operations.SubAccountTagRulesOperations + - name: TagRulesOperations + uid: azure.mgmt.logz.aio.operations.TagRulesOperations + name: operations + - name: MicrosoftLogz + uid: azure.mgmt.logz.aio.MicrosoftLogz + name: aio + - items: + - name: Overview + uid: azure.mgmt.logz.models + - name: CreatedByType + uid: azure.mgmt.logz.models.CreatedByType + - name: ErrorAdditionalInfo + uid: azure.mgmt.logz.models.ErrorAdditionalInfo + - name: ErrorDetail + uid: azure.mgmt.logz.models.ErrorDetail + - name: ErrorResponse + uid: azure.mgmt.logz.models.ErrorResponse + - name: FilteringTag + uid: azure.mgmt.logz.models.FilteringTag + - name: IdentityProperties + uid: azure.mgmt.logz.models.IdentityProperties + - name: LiftrResourceCategories + uid: azure.mgmt.logz.models.LiftrResourceCategories + - name: LogRules + uid: azure.mgmt.logz.models.LogRules + - name: LogzMonitorResource + uid: azure.mgmt.logz.models.LogzMonitorResource + - name: LogzMonitorResourceListResponse + uid: azure.mgmt.logz.models.LogzMonitorResourceListResponse + - name: LogzMonitorResourceUpdateParameters + uid: azure.mgmt.logz.models.LogzMonitorResourceUpdateParameters + - name: LogzOrganizationProperties + uid: azure.mgmt.logz.models.LogzOrganizationProperties + - name: LogzSingleSignOnProperties + uid: azure.mgmt.logz.models.LogzSingleSignOnProperties + - name: LogzSingleSignOnResource + uid: azure.mgmt.logz.models.LogzSingleSignOnResource + - name: LogzSingleSignOnResourceListResponse + uid: azure.mgmt.logz.models.LogzSingleSignOnResourceListResponse + - name: ManagedIdentityTypes + uid: azure.mgmt.logz.models.ManagedIdentityTypes + - name: MarketplaceSubscriptionStatus + uid: azure.mgmt.logz.models.MarketplaceSubscriptionStatus + - name: MonitorProperties + uid: azure.mgmt.logz.models.MonitorProperties + - name: MonitorUpdateProperties + uid: azure.mgmt.logz.models.MonitorUpdateProperties + - name: MonitoredResource + uid: azure.mgmt.logz.models.MonitoredResource + - name: MonitoredResourceListResponse + uid: azure.mgmt.logz.models.MonitoredResourceListResponse + - name: MonitoringStatus + uid: azure.mgmt.logz.models.MonitoringStatus + - name: MonitoringTagRules + uid: azure.mgmt.logz.models.MonitoringTagRules + - name: MonitoringTagRulesListResponse + uid: azure.mgmt.logz.models.MonitoringTagRulesListResponse + - name: MonitoringTagRulesProperties + uid: azure.mgmt.logz.models.MonitoringTagRulesProperties + - name: OperationDisplay + uid: azure.mgmt.logz.models.OperationDisplay + - name: OperationListResult + uid: azure.mgmt.logz.models.OperationListResult + - name: OperationResult + uid: azure.mgmt.logz.models.OperationResult + - name: PlanData + uid: azure.mgmt.logz.models.PlanData + - name: ProvisioningState + uid: azure.mgmt.logz.models.ProvisioningState + - name: SingleSignOnStates + uid: azure.mgmt.logz.models.SingleSignOnStates + - name: SystemData + uid: azure.mgmt.logz.models.SystemData + - name: TagAction + uid: azure.mgmt.logz.models.TagAction + - name: UserInfo + uid: azure.mgmt.logz.models.UserInfo + - name: UserRole + uid: azure.mgmt.logz.models.UserRole + - name: UserRoleListResponse + uid: azure.mgmt.logz.models.UserRoleListResponse + - name: UserRoleRequest + uid: azure.mgmt.logz.models.UserRoleRequest + - name: UserRoleResponse + uid: azure.mgmt.logz.models.UserRoleResponse + - name: VMExtensionPayload + uid: azure.mgmt.logz.models.VMExtensionPayload + - name: VMHostUpdateRequest + uid: azure.mgmt.logz.models.VMHostUpdateRequest + - name: VMHostUpdateStates + uid: azure.mgmt.logz.models.VMHostUpdateStates + - name: VMResources + uid: azure.mgmt.logz.models.VMResources + - name: VMResourcesListResponse + uid: azure.mgmt.logz.models.VMResourcesListResponse + name: models + - items: + - name: Overview + uid: azure.mgmt.logz.operations + - name: MonitorOperations + uid: azure.mgmt.logz.operations.MonitorOperations + - name: MonitorsOperations + uid: azure.mgmt.logz.operations.MonitorsOperations + - name: Operations + uid: azure.mgmt.logz.operations.Operations + - name: SingleSignOnOperations + uid: azure.mgmt.logz.operations.SingleSignOnOperations + - name: SubAccountOperations + uid: azure.mgmt.logz.operations.SubAccountOperations + - name: SubAccountTagRulesOperations + uid: azure.mgmt.logz.operations.SubAccountTagRulesOperations + - name: TagRulesOperations + uid: azure.mgmt.logz.operations.TagRulesOperations + name: operations + - name: MicrosoftLogz + uid: azure.mgmt.logz.MicrosoftLogz + name: azure.mgmt.logz +- items: + - name: Overview + uid: azure.mgmt.networkanalytics + - items: + - name: Overview + uid: azure.mgmt.networkanalytics.aio + - items: + - name: Overview + uid: azure.mgmt.networkanalytics.aio.operations + - name: DataProductsCatalogsOperations + uid: azure.mgmt.networkanalytics.aio.operations.DataProductsCatalogsOperations + - name: DataProductsOperations + uid: azure.mgmt.networkanalytics.aio.operations.DataProductsOperations + - name: DataTypesOperations + uid: azure.mgmt.networkanalytics.aio.operations.DataTypesOperations + - name: Operations + uid: azure.mgmt.networkanalytics.aio.operations.Operations + name: operations + - name: NetworkAnalyticsMgmtClient + uid: azure.mgmt.networkanalytics.aio.NetworkAnalyticsMgmtClient + name: aio + - items: + - name: Overview + uid: azure.mgmt.networkanalytics.models + - name: AccountSas + uid: azure.mgmt.networkanalytics.models.AccountSas + - name: AccountSasToken + uid: azure.mgmt.networkanalytics.models.AccountSasToken + - name: ActionType + uid: azure.mgmt.networkanalytics.models.ActionType + - name: Bypass + uid: azure.mgmt.networkanalytics.models.Bypass + - name: ConsumptionEndpointsProperties + uid: azure.mgmt.networkanalytics.models.ConsumptionEndpointsProperties + - name: ContainerSaS + uid: azure.mgmt.networkanalytics.models.ContainerSaS + - name: ContainerSasToken + uid: azure.mgmt.networkanalytics.models.ContainerSasToken + - name: ControlState + uid: azure.mgmt.networkanalytics.models.ControlState + - name: CreatedByType + uid: azure.mgmt.networkanalytics.models.CreatedByType + - name: DataProduct + uid: azure.mgmt.networkanalytics.models.DataProduct + - name: DataProductInformation + uid: azure.mgmt.networkanalytics.models.DataProductInformation + - name: DataProductListResult + uid: azure.mgmt.networkanalytics.models.DataProductListResult + - name: DataProductNetworkAcls + uid: azure.mgmt.networkanalytics.models.DataProductNetworkAcls + - name: DataProductProperties + uid: azure.mgmt.networkanalytics.models.DataProductProperties + - name: DataProductUpdate + uid: azure.mgmt.networkanalytics.models.DataProductUpdate + - name: DataProductUpdateProperties + uid: azure.mgmt.networkanalytics.models.DataProductUpdateProperties + - name: DataProductUserRole + uid: azure.mgmt.networkanalytics.models.DataProductUserRole + - name: DataProductVersion + uid: azure.mgmt.networkanalytics.models.DataProductVersion + - name: DataProductsCatalog + uid: azure.mgmt.networkanalytics.models.DataProductsCatalog + - name: DataProductsCatalogListResult + uid: azure.mgmt.networkanalytics.models.DataProductsCatalogListResult + - name: DataProductsCatalogProperties + uid: azure.mgmt.networkanalytics.models.DataProductsCatalogProperties + - name: DataType + uid: azure.mgmt.networkanalytics.models.DataType + - name: DataTypeListResult + uid: azure.mgmt.networkanalytics.models.DataTypeListResult + - name: DataTypeProperties + uid: azure.mgmt.networkanalytics.models.DataTypeProperties + - name: DataTypeState + uid: azure.mgmt.networkanalytics.models.DataTypeState + - name: DataTypeUpdate + uid: azure.mgmt.networkanalytics.models.DataTypeUpdate + - name: DataTypeUpdateProperties + uid: azure.mgmt.networkanalytics.models.DataTypeUpdateProperties + - name: DefaultAction + uid: azure.mgmt.networkanalytics.models.DefaultAction + - name: EncryptionKeyDetails + uid: azure.mgmt.networkanalytics.models.EncryptionKeyDetails + - name: ErrorAdditionalInfo + uid: azure.mgmt.networkanalytics.models.ErrorAdditionalInfo + - name: ErrorDetail + uid: azure.mgmt.networkanalytics.models.ErrorDetail + - name: ErrorResponse + uid: azure.mgmt.networkanalytics.models.ErrorResponse + - name: IPRules + uid: azure.mgmt.networkanalytics.models.IPRules + - name: KeyVaultInfo + uid: azure.mgmt.networkanalytics.models.KeyVaultInfo + - name: ListRoleAssignments + uid: azure.mgmt.networkanalytics.models.ListRoleAssignments + - name: ManagedResourceGroupConfiguration + uid: azure.mgmt.networkanalytics.models.ManagedResourceGroupConfiguration + - name: ManagedServiceIdentity + uid: azure.mgmt.networkanalytics.models.ManagedServiceIdentity + - name: ManagedServiceIdentityType + uid: azure.mgmt.networkanalytics.models.ManagedServiceIdentityType + - name: Operation + uid: azure.mgmt.networkanalytics.models.Operation + - name: OperationDisplay + uid: azure.mgmt.networkanalytics.models.OperationDisplay + - name: OperationListResult + uid: azure.mgmt.networkanalytics.models.OperationListResult + - name: Origin + uid: azure.mgmt.networkanalytics.models.Origin + - name: ProvisioningState + uid: azure.mgmt.networkanalytics.models.ProvisioningState + - name: ProxyResource + uid: azure.mgmt.networkanalytics.models.ProxyResource + - name: PublisherInformation + uid: azure.mgmt.networkanalytics.models.PublisherInformation + - name: Resource + uid: azure.mgmt.networkanalytics.models.Resource + - name: ResourceAccessRules + uid: azure.mgmt.networkanalytics.models.ResourceAccessRules + - name: RoleAssignmentCommonProperties + uid: azure.mgmt.networkanalytics.models.RoleAssignmentCommonProperties + - name: RoleAssignmentDetail + uid: azure.mgmt.networkanalytics.models.RoleAssignmentDetail + - name: SystemData + uid: azure.mgmt.networkanalytics.models.SystemData + - name: TrackedResource + uid: azure.mgmt.networkanalytics.models.TrackedResource + - name: UserAssignedIdentity + uid: azure.mgmt.networkanalytics.models.UserAssignedIdentity + - name: Versions + uid: azure.mgmt.networkanalytics.models.Versions + - name: VirtualNetworkRule + uid: azure.mgmt.networkanalytics.models.VirtualNetworkRule + name: models + - items: + - name: Overview + uid: azure.mgmt.networkanalytics.operations + - name: DataProductsCatalogsOperations + uid: azure.mgmt.networkanalytics.operations.DataProductsCatalogsOperations + - name: DataProductsOperations + uid: azure.mgmt.networkanalytics.operations.DataProductsOperations + - name: DataTypesOperations + uid: azure.mgmt.networkanalytics.operations.DataTypesOperations + - name: Operations + uid: azure.mgmt.networkanalytics.operations.Operations + name: operations + - name: NetworkAnalyticsMgmtClient + uid: azure.mgmt.networkanalytics.NetworkAnalyticsMgmtClient + name: azure.mgmt.networkanalytics +- items: + - name: Overview + uid: azure.mgmt.powerbiembedded + - items: + - name: Overview + uid: azure.mgmt.powerbiembedded.aio + - items: + - name: Overview + uid: azure.mgmt.powerbiembedded.aio.operations + - name: PowerBIEmbeddedManagementClientOperationsMixin + uid: azure.mgmt.powerbiembedded.aio.operations.PowerBIEmbeddedManagementClientOperationsMixin + - name: WorkspaceCollectionsOperations + uid: azure.mgmt.powerbiembedded.aio.operations.WorkspaceCollectionsOperations + - name: WorkspacesOperations + uid: azure.mgmt.powerbiembedded.aio.operations.WorkspacesOperations + name: operations + - name: PowerBIEmbeddedManagementClient + uid: azure.mgmt.powerbiembedded.aio.PowerBIEmbeddedManagementClient + name: aio + - items: + - name: Overview + uid: azure.mgmt.powerbiembedded.models + - name: AccessKeyName + uid: azure.mgmt.powerbiembedded.models.AccessKeyName + - name: AzureSku + uid: azure.mgmt.powerbiembedded.models.AzureSku + - name: AzureSkuName + uid: azure.mgmt.powerbiembedded.models.AzureSkuName + - name: AzureSkuTier + uid: azure.mgmt.powerbiembedded.models.AzureSkuTier + - name: CheckNameReason + uid: azure.mgmt.powerbiembedded.models.CheckNameReason + - name: CheckNameRequest + uid: azure.mgmt.powerbiembedded.models.CheckNameRequest + - name: CheckNameResponse + uid: azure.mgmt.powerbiembedded.models.CheckNameResponse + - name: CreateWorkspaceCollectionRequest + uid: azure.mgmt.powerbiembedded.models.CreateWorkspaceCollectionRequest + - name: Display + uid: azure.mgmt.powerbiembedded.models.Display + - name: Error + uid: azure.mgmt.powerbiembedded.models.Error + - name: ErrorDetail + uid: azure.mgmt.powerbiembedded.models.ErrorDetail + - name: MigrateWorkspaceCollectionRequest + uid: azure.mgmt.powerbiembedded.models.MigrateWorkspaceCollectionRequest + - name: Operation + uid: azure.mgmt.powerbiembedded.models.Operation + - name: OperationList + uid: azure.mgmt.powerbiembedded.models.OperationList + - name: UpdateWorkspaceCollectionRequest + uid: azure.mgmt.powerbiembedded.models.UpdateWorkspaceCollectionRequest + - name: Workspace + uid: azure.mgmt.powerbiembedded.models.Workspace + - name: WorkspaceCollection + uid: azure.mgmt.powerbiembedded.models.WorkspaceCollection + - name: WorkspaceCollectionAccessKey + uid: azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKey + - name: WorkspaceCollectionAccessKeys + uid: azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKeys + - name: WorkspaceCollectionList + uid: azure.mgmt.powerbiembedded.models.WorkspaceCollectionList + - name: WorkspaceList + uid: azure.mgmt.powerbiembedded.models.WorkspaceList + name: models + - items: + - name: Overview + uid: azure.mgmt.powerbiembedded.operations + - name: PowerBIEmbeddedManagementClientOperationsMixin + uid: azure.mgmt.powerbiembedded.operations.PowerBIEmbeddedManagementClientOperationsMixin + - name: WorkspaceCollectionsOperations + uid: azure.mgmt.powerbiembedded.operations.WorkspaceCollectionsOperations + - name: WorkspacesOperations + uid: azure.mgmt.powerbiembedded.operations.WorkspacesOperations + name: operations + - name: PowerBIEmbeddedManagementClient + uid: azure.mgmt.powerbiembedded.PowerBIEmbeddedManagementClient + name: azure.mgmt.powerbiembedded +- items: + - name: Overview + uid: azure.mgmt.scheduler + - items: + - name: Overview + uid: azure.mgmt.scheduler.aio + - items: + - name: Overview + uid: azure.mgmt.scheduler.aio.operations + - name: JobCollectionsOperations + uid: azure.mgmt.scheduler.aio.operations.JobCollectionsOperations + - name: JobsOperations + uid: azure.mgmt.scheduler.aio.operations.JobsOperations + name: operations + - name: SchedulerManagementClient + uid: azure.mgmt.scheduler.aio.SchedulerManagementClient + name: aio + - items: + - name: Overview + uid: azure.mgmt.scheduler.models + - name: BasicAuthentication + uid: azure.mgmt.scheduler.models.BasicAuthentication + - name: ClientCertAuthentication + uid: azure.mgmt.scheduler.models.ClientCertAuthentication + - name: DayOfWeek + uid: azure.mgmt.scheduler.models.DayOfWeek + - name: HttpAuthentication + uid: azure.mgmt.scheduler.models.HttpAuthentication + - name: HttpAuthenticationType + uid: azure.mgmt.scheduler.models.HttpAuthenticationType + - name: HttpRequest + uid: azure.mgmt.scheduler.models.HttpRequest + - name: JobAction + uid: azure.mgmt.scheduler.models.JobAction + - name: JobActionType + uid: azure.mgmt.scheduler.models.JobActionType + - name: JobCollectionDefinition + uid: azure.mgmt.scheduler.models.JobCollectionDefinition + - name: JobCollectionListResult + uid: azure.mgmt.scheduler.models.JobCollectionListResult + - name: JobCollectionProperties + uid: azure.mgmt.scheduler.models.JobCollectionProperties + - name: JobCollectionQuota + uid: azure.mgmt.scheduler.models.JobCollectionQuota + - name: JobCollectionState + uid: azure.mgmt.scheduler.models.JobCollectionState + - name: JobDefinition + uid: azure.mgmt.scheduler.models.JobDefinition + - name: JobErrorAction + uid: azure.mgmt.scheduler.models.JobErrorAction + - name: JobExecutionStatus + uid: azure.mgmt.scheduler.models.JobExecutionStatus + - name: JobHistoryActionName + uid: azure.mgmt.scheduler.models.JobHistoryActionName + - name: JobHistoryDefinition + uid: azure.mgmt.scheduler.models.JobHistoryDefinition + - name: JobHistoryDefinitionProperties + uid: azure.mgmt.scheduler.models.JobHistoryDefinitionProperties + - name: JobHistoryFilter + uid: azure.mgmt.scheduler.models.JobHistoryFilter + - name: JobHistoryListResult + uid: azure.mgmt.scheduler.models.JobHistoryListResult + - name: JobListResult + uid: azure.mgmt.scheduler.models.JobListResult + - name: JobMaxRecurrence + uid: azure.mgmt.scheduler.models.JobMaxRecurrence + - name: JobProperties + uid: azure.mgmt.scheduler.models.JobProperties + - name: JobRecurrence + uid: azure.mgmt.scheduler.models.JobRecurrence + - name: JobRecurrenceSchedule + uid: azure.mgmt.scheduler.models.JobRecurrenceSchedule + - name: JobRecurrenceScheduleMonthlyOccurrence + uid: azure.mgmt.scheduler.models.JobRecurrenceScheduleMonthlyOccurrence + - name: JobScheduleDay + uid: azure.mgmt.scheduler.models.JobScheduleDay + - name: JobState + uid: azure.mgmt.scheduler.models.JobState + - name: JobStateFilter + uid: azure.mgmt.scheduler.models.JobStateFilter + - name: JobStatus + uid: azure.mgmt.scheduler.models.JobStatus + - name: OAuthAuthentication + uid: azure.mgmt.scheduler.models.OAuthAuthentication + - name: RecurrenceFrequency + uid: azure.mgmt.scheduler.models.RecurrenceFrequency + - name: RetryPolicy + uid: azure.mgmt.scheduler.models.RetryPolicy + - name: RetryType + uid: azure.mgmt.scheduler.models.RetryType + - name: ServiceBusAuthentication + uid: azure.mgmt.scheduler.models.ServiceBusAuthentication + - name: ServiceBusAuthenticationType + uid: azure.mgmt.scheduler.models.ServiceBusAuthenticationType + - name: ServiceBusBrokeredMessageProperties + uid: azure.mgmt.scheduler.models.ServiceBusBrokeredMessageProperties + - name: ServiceBusMessage + uid: azure.mgmt.scheduler.models.ServiceBusMessage + - name: ServiceBusQueueMessage + uid: azure.mgmt.scheduler.models.ServiceBusQueueMessage + - name: ServiceBusTopicMessage + uid: azure.mgmt.scheduler.models.ServiceBusTopicMessage + - name: ServiceBusTransportType + uid: azure.mgmt.scheduler.models.ServiceBusTransportType + - name: Sku + uid: azure.mgmt.scheduler.models.Sku + - name: SkuDefinition + uid: azure.mgmt.scheduler.models.SkuDefinition + - name: StorageQueueMessage + uid: azure.mgmt.scheduler.models.StorageQueueMessage + name: models + - items: + - name: Overview + uid: azure.mgmt.scheduler.operations + - name: JobCollectionsOperations + uid: azure.mgmt.scheduler.operations.JobCollectionsOperations + - name: JobsOperations + uid: azure.mgmt.scheduler.operations.JobsOperations + name: operations + - name: patch + uid: azure.mgmt.scheduler.patch + - name: SchedulerManagementClient + uid: azure.mgmt.scheduler.SchedulerManagementClient + name: azure.mgmt.scheduler +- items: + - name: Overview + uid: azure.mgmt.storageimportexport + - items: + - name: Overview + uid: azure.mgmt.storageimportexport.aio + - items: + - name: Overview + uid: azure.mgmt.storageimportexport.aio.operations + - name: BitLockerKeysOperations + uid: azure.mgmt.storageimportexport.aio.operations.BitLockerKeysOperations + - name: JobsOperations + uid: azure.mgmt.storageimportexport.aio.operations.JobsOperations + - name: LocationsOperations + uid: azure.mgmt.storageimportexport.aio.operations.LocationsOperations + - name: Operations + uid: azure.mgmt.storageimportexport.aio.operations.Operations + name: operations + - name: StorageImportExport + uid: azure.mgmt.storageimportexport.aio.StorageImportExport + name: aio + - items: + - name: Overview + uid: azure.mgmt.storageimportexport.models + - name: CreatedByType + uid: azure.mgmt.storageimportexport.models.CreatedByType + - name: DeliveryPackageInformation + uid: azure.mgmt.storageimportexport.models.DeliveryPackageInformation + - name: DriveBitLockerKey + uid: azure.mgmt.storageimportexport.models.DriveBitLockerKey + - name: DriveState + uid: azure.mgmt.storageimportexport.models.DriveState + - name: DriveStatus + uid: azure.mgmt.storageimportexport.models.DriveStatus + - name: EncryptionKekType + uid: azure.mgmt.storageimportexport.models.EncryptionKekType + - name: EncryptionKeyDetails + uid: azure.mgmt.storageimportexport.models.EncryptionKeyDetails + - name: ErrorResponse + uid: azure.mgmt.storageimportexport.models.ErrorResponse + - name: ErrorResponseErrorDetailsItem + uid: azure.mgmt.storageimportexport.models.ErrorResponseErrorDetailsItem + - name: Export + uid: azure.mgmt.storageimportexport.models.Export + - name: GetBitLockerKeysResponse + uid: azure.mgmt.storageimportexport.models.GetBitLockerKeysResponse + - name: IdentityDetails + uid: azure.mgmt.storageimportexport.models.IdentityDetails + - name: IdentityType + uid: azure.mgmt.storageimportexport.models.IdentityType + - name: JobDetails + uid: azure.mgmt.storageimportexport.models.JobDetails + - name: JobResponse + uid: azure.mgmt.storageimportexport.models.JobResponse + - name: ListJobsResponse + uid: azure.mgmt.storageimportexport.models.ListJobsResponse + - name: ListOperationsResponse + uid: azure.mgmt.storageimportexport.models.ListOperationsResponse + - name: Location + uid: azure.mgmt.storageimportexport.models.Location + - name: LocationsResponse + uid: azure.mgmt.storageimportexport.models.LocationsResponse + - name: Operation + uid: azure.mgmt.storageimportexport.models.Operation + - name: PackageInformation + uid: azure.mgmt.storageimportexport.models.PackageInformation + - name: PutJobParameters + uid: azure.mgmt.storageimportexport.models.PutJobParameters + - name: ReturnAddress + uid: azure.mgmt.storageimportexport.models.ReturnAddress + - name: ReturnShipping + uid: azure.mgmt.storageimportexport.models.ReturnShipping + - name: ShippingInformation + uid: azure.mgmt.storageimportexport.models.ShippingInformation + - name: SystemData + uid: azure.mgmt.storageimportexport.models.SystemData + - name: UpdateJobParameters + uid: azure.mgmt.storageimportexport.models.UpdateJobParameters + name: models + - items: + - name: Overview + uid: azure.mgmt.storageimportexport.operations + - name: BitLockerKeysOperations + uid: azure.mgmt.storageimportexport.operations.BitLockerKeysOperations + - name: JobsOperations + uid: azure.mgmt.storageimportexport.operations.JobsOperations + - name: LocationsOperations + uid: azure.mgmt.storageimportexport.operations.LocationsOperations + - name: Operations + uid: azure.mgmt.storageimportexport.operations.Operations + name: operations + - name: StorageImportExport + uid: azure.mgmt.storageimportexport.StorageImportExport + name: azure.mgmt.storageimportexport +- items: + - name: Overview + uid: azure.mgmt.testbase + - items: + - name: Overview + uid: azure.mgmt.testbase.aio + - items: + - name: Overview + uid: azure.mgmt.testbase.aio.operations + - name: AnalysisResultsOperations + uid: azure.mgmt.testbase.aio.operations.AnalysisResultsOperations + - name: AvailableOSOperations + uid: azure.mgmt.testbase.aio.operations.AvailableOSOperations + - name: BillingHubServiceOperations + uid: azure.mgmt.testbase.aio.operations.BillingHubServiceOperations + - name: CustomerEventsOperations + uid: azure.mgmt.testbase.aio.operations.CustomerEventsOperations + - name: EmailEventsOperations + uid: azure.mgmt.testbase.aio.operations.EmailEventsOperations + - name: FavoriteProcessesOperations + uid: azure.mgmt.testbase.aio.operations.FavoriteProcessesOperations + - name: FlightingRingsOperations + uid: azure.mgmt.testbase.aio.operations.FlightingRingsOperations + - name: OSUpdatesOperations + uid: azure.mgmt.testbase.aio.operations.OSUpdatesOperations + - name: Operations + uid: azure.mgmt.testbase.aio.operations.Operations + - name: PackagesOperations + uid: azure.mgmt.testbase.aio.operations.PackagesOperations + - name: SkusOperations + uid: azure.mgmt.testbase.aio.operations.SkusOperations + - name: TestBaseAccountsOperations + uid: azure.mgmt.testbase.aio.operations.TestBaseAccountsOperations + - name: TestResultsOperations + uid: azure.mgmt.testbase.aio.operations.TestResultsOperations + - name: TestSummariesOperations + uid: azure.mgmt.testbase.aio.operations.TestSummariesOperations + - name: TestTypesOperations + uid: azure.mgmt.testbase.aio.operations.TestTypesOperations + - name: UsageOperations + uid: azure.mgmt.testbase.aio.operations.UsageOperations + name: operations + - name: TestBase + uid: azure.mgmt.testbase.aio.TestBase + name: aio + - items: + - name: Overview + uid: azure.mgmt.testbase.models + - name: Action + uid: azure.mgmt.testbase.models.Action + - name: AnalysisResultListResult + uid: azure.mgmt.testbase.models.AnalysisResultListResult + - name: AnalysisResultName + uid: azure.mgmt.testbase.models.AnalysisResultName + - name: AnalysisResultSingletonResource + uid: azure.mgmt.testbase.models.AnalysisResultSingletonResource + - name: AnalysisResultSingletonResourceProperties + uid: azure.mgmt.testbase.models.AnalysisResultSingletonResourceProperties + - name: AnalysisResultType + uid: azure.mgmt.testbase.models.AnalysisResultType + - name: AnalysisStatus + uid: azure.mgmt.testbase.models.AnalysisStatus + - name: AvailableOSListResult + uid: azure.mgmt.testbase.models.AvailableOSListResult + - name: AvailableOSResource + uid: azure.mgmt.testbase.models.AvailableOSResource + - name: BillingHubExecutionUsageDetail + uid: azure.mgmt.testbase.models.BillingHubExecutionUsageDetail + - name: BillingHubFreeHourIncrementEntry + uid: azure.mgmt.testbase.models.BillingHubFreeHourIncrementEntry + - name: BillingHubGetFreeHourBalanceResponse + uid: azure.mgmt.testbase.models.BillingHubGetFreeHourBalanceResponse + - name: BillingHubGetUsageRequest + uid: azure.mgmt.testbase.models.BillingHubGetUsageRequest + - name: BillingHubGetUsageResponse + uid: azure.mgmt.testbase.models.BillingHubGetUsageResponse + - name: BillingHubPackageUsage + uid: azure.mgmt.testbase.models.BillingHubPackageUsage + - name: BillingHubUsage + uid: azure.mgmt.testbase.models.BillingHubUsage + - name: BillingHubUsageGroup + uid: azure.mgmt.testbase.models.BillingHubUsageGroup + - name: BillingHubUsageGroupedByUpdateType + uid: azure.mgmt.testbase.models.BillingHubUsageGroupedByUpdateType + - name: CPURegressionResultSingletonResourceProperties + uid: azure.mgmt.testbase.models.CPURegressionResultSingletonResourceProperties + - name: CPUUtilizationResultSingletonResourceProperties + uid: azure.mgmt.testbase.models.CPUUtilizationResultSingletonResourceProperties + - name: Category + uid: azure.mgmt.testbase.models.Category + - name: CheckNameAvailabilityResult + uid: azure.mgmt.testbase.models.CheckNameAvailabilityResult + - name: Command + uid: azure.mgmt.testbase.models.Command + - name: ContentType + uid: azure.mgmt.testbase.models.ContentType + - name: CreatedByType + uid: azure.mgmt.testbase.models.CreatedByType + - name: CustomerEventListResult + uid: azure.mgmt.testbase.models.CustomerEventListResult + - name: CustomerEventResource + uid: azure.mgmt.testbase.models.CustomerEventResource + - name: DistributionGroupListReceiverValue + uid: azure.mgmt.testbase.models.DistributionGroupListReceiverValue + - name: DownloadURLResponse + uid: azure.mgmt.testbase.models.DownloadURLResponse + - name: EmailEventListResult + uid: azure.mgmt.testbase.models.EmailEventListResult + - name: EmailEventResource + uid: azure.mgmt.testbase.models.EmailEventResource + - name: ErrorDefinition + uid: azure.mgmt.testbase.models.ErrorDefinition + - name: ErrorResponse + uid: azure.mgmt.testbase.models.ErrorResponse + - name: ExecutionStatus + uid: azure.mgmt.testbase.models.ExecutionStatus + - name: FavoriteProcessListResult + uid: azure.mgmt.testbase.models.FavoriteProcessListResult + - name: FavoriteProcessResource + uid: azure.mgmt.testbase.models.FavoriteProcessResource + - name: FileUploadURLResponse + uid: azure.mgmt.testbase.models.FileUploadURLResponse + - name: FlightingRingListResult + uid: azure.mgmt.testbase.models.FlightingRingListResult + - name: FlightingRingResource + uid: azure.mgmt.testbase.models.FlightingRingResource + - name: GetFileUploadURLParameters + uid: azure.mgmt.testbase.models.GetFileUploadURLParameters + - name: Grade + uid: azure.mgmt.testbase.models.Grade + - name: IdentifiedFailure + uid: azure.mgmt.testbase.models.IdentifiedFailure + - name: MemoryRegressionResultSingletonResourceProperties + uid: azure.mgmt.testbase.models.MemoryRegressionResultSingletonResourceProperties + - name: MemoryUtilizationResultSingletonResourceProperties + uid: azure.mgmt.testbase.models.MemoryUtilizationResultSingletonResourceProperties + - name: NotificationEventReceiver + uid: azure.mgmt.testbase.models.NotificationEventReceiver + - name: NotificationReceiverValue + uid: azure.mgmt.testbase.models.NotificationReceiverValue + - name: OSUpdateListResult + uid: azure.mgmt.testbase.models.OSUpdateListResult + - name: OSUpdateResource + uid: azure.mgmt.testbase.models.OSUpdateResource + - name: OSUpdateTestSummary + uid: azure.mgmt.testbase.models.OSUpdateTestSummary + - name: OSUpdatesTestSummary + uid: azure.mgmt.testbase.models.OSUpdatesTestSummary + - name: Operation + uid: azure.mgmt.testbase.models.Operation + - name: OperationDisplay + uid: azure.mgmt.testbase.models.OperationDisplay + - name: OperationListResult + uid: azure.mgmt.testbase.models.OperationListResult + - name: OsUpdateType + uid: azure.mgmt.testbase.models.OsUpdateType + - name: PackageCheckNameAvailabilityParameters + uid: azure.mgmt.testbase.models.PackageCheckNameAvailabilityParameters + - name: PackageListResult + uid: azure.mgmt.testbase.models.PackageListResult + - name: PackageResource + uid: azure.mgmt.testbase.models.PackageResource + - name: PackageRunTestParameters + uid: azure.mgmt.testbase.models.PackageRunTestParameters + - name: PackageStatus + uid: azure.mgmt.testbase.models.PackageStatus + - name: PackageUpdateParameters + uid: azure.mgmt.testbase.models.PackageUpdateParameters + - name: PackageValidationResult + uid: azure.mgmt.testbase.models.PackageValidationResult + - name: ProvisioningState + uid: azure.mgmt.testbase.models.ProvisioningState + - name: ProxyResource + uid: azure.mgmt.testbase.models.ProxyResource + - name: Reason + uid: azure.mgmt.testbase.models.Reason + - name: RegressionResult + uid: azure.mgmt.testbase.models.RegressionResult + - name: RegressionTestDetails + uid: azure.mgmt.testbase.models.RegressionTestDetails + - name: ReliabilityResult + uid: azure.mgmt.testbase.models.ReliabilityResult + - name: ReliabilityResultSingletonResourceProperties + uid: azure.mgmt.testbase.models.ReliabilityResultSingletonResourceProperties + - name: Resource + uid: azure.mgmt.testbase.models.Resource + - name: ScriptExecutionResult + uid: azure.mgmt.testbase.models.ScriptExecutionResult + - name: ScriptExecutionResultSingletonResourceProperties + uid: azure.mgmt.testbase.models.ScriptExecutionResultSingletonResourceProperties + - name: SubscriptionReceiverValue + uid: azure.mgmt.testbase.models.SubscriptionReceiverValue + - name: SystemData + uid: azure.mgmt.testbase.models.SystemData + - name: TargetOSInfo + uid: azure.mgmt.testbase.models.TargetOSInfo + - name: Test + uid: azure.mgmt.testbase.models.Test + - name: TestAnalysisResult + uid: azure.mgmt.testbase.models.TestAnalysisResult + - name: TestAnalysisResultSingletonResourceProperties + uid: azure.mgmt.testbase.models.TestAnalysisResultSingletonResourceProperties + - name: TestAnalysisStatus + uid: azure.mgmt.testbase.models.TestAnalysisStatus + - name: TestBaseAccountListResult + uid: azure.mgmt.testbase.models.TestBaseAccountListResult + - name: TestBaseAccountResource + uid: azure.mgmt.testbase.models.TestBaseAccountResource + - name: TestBaseAccountSKU + uid: azure.mgmt.testbase.models.TestBaseAccountSKU + - name: TestBaseAccountSKUCapability + uid: azure.mgmt.testbase.models.TestBaseAccountSKUCapability + - name: TestBaseAccountSKUListResult + uid: azure.mgmt.testbase.models.TestBaseAccountSKUListResult + - name: TestBaseAccountUpdateParameters + uid: azure.mgmt.testbase.models.TestBaseAccountUpdateParameters + - name: TestBaseAccountUsageData + uid: azure.mgmt.testbase.models.TestBaseAccountUsageData + - name: TestBaseAccountUsageDataList + uid: azure.mgmt.testbase.models.TestBaseAccountUsageDataList + - name: TestBaseAccountUsageName + uid: azure.mgmt.testbase.models.TestBaseAccountUsageName + - name: TestResultAnalysisSummary + uid: azure.mgmt.testbase.models.TestResultAnalysisSummary + - name: TestResultConsoleLogDownloadURLParameters + uid: azure.mgmt.testbase.models.TestResultConsoleLogDownloadURLParameters + - name: TestResultListResult + uid: azure.mgmt.testbase.models.TestResultListResult + - name: TestResultResource + uid: azure.mgmt.testbase.models.TestResultResource + - name: TestStatus + uid: azure.mgmt.testbase.models.TestStatus + - name: TestSummaryListResult + uid: azure.mgmt.testbase.models.TestSummaryListResult + - name: TestSummaryResource + uid: azure.mgmt.testbase.models.TestSummaryResource + - name: TestType + uid: azure.mgmt.testbase.models.TestType + - name: TestTypeListResult + uid: azure.mgmt.testbase.models.TestTypeListResult + - name: TestTypeResource + uid: azure.mgmt.testbase.models.TestTypeResource + - name: Tier + uid: azure.mgmt.testbase.models.Tier + - name: TrackedResource + uid: azure.mgmt.testbase.models.TrackedResource + - name: Type + uid: azure.mgmt.testbase.models.Type + - name: UserObjectReceiverValue + uid: azure.mgmt.testbase.models.UserObjectReceiverValue + - name: UtilizationBound + uid: azure.mgmt.testbase.models.UtilizationBound + - name: UtilizationEntry + uid: azure.mgmt.testbase.models.UtilizationEntry + - name: UtilizationResult + uid: azure.mgmt.testbase.models.UtilizationResult + - name: ValidationRunStatus + uid: azure.mgmt.testbase.models.ValidationRunStatus + name: models + - items: + - name: Overview + uid: azure.mgmt.testbase.operations + - name: AnalysisResultsOperations + uid: azure.mgmt.testbase.operations.AnalysisResultsOperations + - name: AvailableOSOperations + uid: azure.mgmt.testbase.operations.AvailableOSOperations + - name: BillingHubServiceOperations + uid: azure.mgmt.testbase.operations.BillingHubServiceOperations + - name: CustomerEventsOperations + uid: azure.mgmt.testbase.operations.CustomerEventsOperations + - name: EmailEventsOperations + uid: azure.mgmt.testbase.operations.EmailEventsOperations + - name: FavoriteProcessesOperations + uid: azure.mgmt.testbase.operations.FavoriteProcessesOperations + - name: FlightingRingsOperations + uid: azure.mgmt.testbase.operations.FlightingRingsOperations + - name: OSUpdatesOperations + uid: azure.mgmt.testbase.operations.OSUpdatesOperations + - name: Operations + uid: azure.mgmt.testbase.operations.Operations + - name: PackagesOperations + uid: azure.mgmt.testbase.operations.PackagesOperations + - name: SkusOperations + uid: azure.mgmt.testbase.operations.SkusOperations + - name: TestBaseAccountsOperations + uid: azure.mgmt.testbase.operations.TestBaseAccountsOperations + - name: TestResultsOperations + uid: azure.mgmt.testbase.operations.TestResultsOperations + - name: TestSummariesOperations + uid: azure.mgmt.testbase.operations.TestSummariesOperations + - name: TestTypesOperations + uid: azure.mgmt.testbase.operations.TestTypesOperations + - name: UsageOperations + uid: azure.mgmt.testbase.operations.UsageOperations + name: operations + - name: TestBase + uid: azure.mgmt.testbase.TestBase + name: azure.mgmt.testbase +- items: + - name: Overview + uid: azure.mgmt.videoanalyzer + - items: + - name: Overview + uid: azure.mgmt.videoanalyzer.aio + - items: + - name: Overview + uid: azure.mgmt.videoanalyzer.aio.operations + - name: AccessPoliciesOperations + uid: azure.mgmt.videoanalyzer.aio.operations.AccessPoliciesOperations + - name: EdgeModulesOperations + uid: azure.mgmt.videoanalyzer.aio.operations.EdgeModulesOperations + - name: LivePipelineOperationStatusesOperations + uid: azure.mgmt.videoanalyzer.aio.operations.LivePipelineOperationStatusesOperations + - name: LivePipelinesOperations + uid: azure.mgmt.videoanalyzer.aio.operations.LivePipelinesOperations + - name: LocationsOperations + uid: azure.mgmt.videoanalyzer.aio.operations.LocationsOperations + - name: OperationResultsOperations + uid: azure.mgmt.videoanalyzer.aio.operations.OperationResultsOperations + - name: OperationStatusesOperations + uid: azure.mgmt.videoanalyzer.aio.operations.OperationStatusesOperations + - name: Operations + uid: azure.mgmt.videoanalyzer.aio.operations.Operations + - name: PipelineJobOperationStatusesOperations + uid: azure.mgmt.videoanalyzer.aio.operations.PipelineJobOperationStatusesOperations + - name: PipelineJobsOperations + uid: azure.mgmt.videoanalyzer.aio.operations.PipelineJobsOperations + - name: PipelineTopologiesOperations + uid: azure.mgmt.videoanalyzer.aio.operations.PipelineTopologiesOperations + - name: PrivateEndpointConnectionsOperations + uid: azure.mgmt.videoanalyzer.aio.operations.PrivateEndpointConnectionsOperations + - name: PrivateLinkResourcesOperations + uid: azure.mgmt.videoanalyzer.aio.operations.PrivateLinkResourcesOperations + - name: VideoAnalyzerOperationResultsOperations + uid: azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzerOperationResultsOperations + - name: VideoAnalyzerOperationStatusesOperations + uid: azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzerOperationStatusesOperations + - name: VideoAnalyzersOperations + uid: azure.mgmt.videoanalyzer.aio.operations.VideoAnalyzersOperations + - name: VideosOperations + uid: azure.mgmt.videoanalyzer.aio.operations.VideosOperations + name: operations + - name: VideoAnalyzer + uid: azure.mgmt.videoanalyzer.aio.VideoAnalyzer + name: aio + - items: + - name: Overview + uid: azure.mgmt.videoanalyzer.models + - name: AccessPolicyEccAlgo + uid: azure.mgmt.videoanalyzer.models.AccessPolicyEccAlgo + - name: AccessPolicyEntity + uid: azure.mgmt.videoanalyzer.models.AccessPolicyEntity + - name: AccessPolicyEntityCollection + uid: azure.mgmt.videoanalyzer.models.AccessPolicyEntityCollection + - name: AccessPolicyRole + uid: azure.mgmt.videoanalyzer.models.AccessPolicyRole + - name: AccessPolicyRsaAlgo + uid: azure.mgmt.videoanalyzer.models.AccessPolicyRsaAlgo + - name: AccountEncryption + uid: azure.mgmt.videoanalyzer.models.AccountEncryption + - name: AccountEncryptionKeyType + uid: azure.mgmt.videoanalyzer.models.AccountEncryptionKeyType + - name: ActionType + uid: azure.mgmt.videoanalyzer.models.ActionType + - name: AudioEncoderAac + uid: azure.mgmt.videoanalyzer.models.AudioEncoderAac + - name: AudioEncoderBase + uid: azure.mgmt.videoanalyzer.models.AudioEncoderBase + - name: AuthenticationBase + uid: azure.mgmt.videoanalyzer.models.AuthenticationBase + - name: CertificateSource + uid: azure.mgmt.videoanalyzer.models.CertificateSource + - name: CheckNameAvailabilityReason + uid: azure.mgmt.videoanalyzer.models.CheckNameAvailabilityReason + - name: CheckNameAvailabilityRequest + uid: azure.mgmt.videoanalyzer.models.CheckNameAvailabilityRequest + - name: CheckNameAvailabilityResponse + uid: azure.mgmt.videoanalyzer.models.CheckNameAvailabilityResponse + - name: CreatedByType + uid: azure.mgmt.videoanalyzer.models.CreatedByType + - name: CredentialsBase + uid: azure.mgmt.videoanalyzer.models.CredentialsBase + - name: EccTokenKey + uid: azure.mgmt.videoanalyzer.models.EccTokenKey + - name: EdgeModuleEntity + uid: azure.mgmt.videoanalyzer.models.EdgeModuleEntity + - name: EdgeModuleEntityCollection + uid: azure.mgmt.videoanalyzer.models.EdgeModuleEntityCollection + - name: EdgeModuleProvisioningToken + uid: azure.mgmt.videoanalyzer.models.EdgeModuleProvisioningToken + - name: EncoderCustomPreset + uid: azure.mgmt.videoanalyzer.models.EncoderCustomPreset + - name: EncoderPresetBase + uid: azure.mgmt.videoanalyzer.models.EncoderPresetBase + - name: EncoderProcessor + uid: azure.mgmt.videoanalyzer.models.EncoderProcessor + - name: EncoderSystemPreset + uid: azure.mgmt.videoanalyzer.models.EncoderSystemPreset + - name: EncoderSystemPresetType + uid: azure.mgmt.videoanalyzer.models.EncoderSystemPresetType + - name: Endpoint + uid: azure.mgmt.videoanalyzer.models.Endpoint + - name: EndpointBase + uid: azure.mgmt.videoanalyzer.models.EndpointBase + - name: ErrorAdditionalInfo + uid: azure.mgmt.videoanalyzer.models.ErrorAdditionalInfo + - name: ErrorDetail + uid: azure.mgmt.videoanalyzer.models.ErrorDetail + - name: ErrorResponse + uid: azure.mgmt.videoanalyzer.models.ErrorResponse + - name: GroupLevelAccessControl + uid: azure.mgmt.videoanalyzer.models.GroupLevelAccessControl + - name: IotHub + uid: azure.mgmt.videoanalyzer.models.IotHub + - name: JwtAuthentication + uid: azure.mgmt.videoanalyzer.models.JwtAuthentication + - name: KeyVaultProperties + uid: azure.mgmt.videoanalyzer.models.KeyVaultProperties + - name: Kind + uid: azure.mgmt.videoanalyzer.models.Kind + - name: ListProvisioningTokenInput + uid: azure.mgmt.videoanalyzer.models.ListProvisioningTokenInput + - name: LivePipeline + uid: azure.mgmt.videoanalyzer.models.LivePipeline + - name: LivePipelineCollection + uid: azure.mgmt.videoanalyzer.models.LivePipelineCollection + - name: LivePipelineOperationStatus + uid: azure.mgmt.videoanalyzer.models.LivePipelineOperationStatus + - name: LivePipelineState + uid: azure.mgmt.videoanalyzer.models.LivePipelineState + - name: LivePipelineUpdate + uid: azure.mgmt.videoanalyzer.models.LivePipelineUpdate + - name: LogSpecification + uid: azure.mgmt.videoanalyzer.models.LogSpecification + - name: MetricAggregationType + uid: azure.mgmt.videoanalyzer.models.MetricAggregationType + - name: MetricDimension + uid: azure.mgmt.videoanalyzer.models.MetricDimension + - name: MetricSpecification + uid: azure.mgmt.videoanalyzer.models.MetricSpecification + - name: MetricUnit + uid: azure.mgmt.videoanalyzer.models.MetricUnit + - name: NetworkAccessControl + uid: azure.mgmt.videoanalyzer.models.NetworkAccessControl + - name: NodeBase + uid: azure.mgmt.videoanalyzer.models.NodeBase + - name: NodeInput + uid: azure.mgmt.videoanalyzer.models.NodeInput + - name: Operation + uid: azure.mgmt.videoanalyzer.models.Operation + - name: OperationCollection + uid: azure.mgmt.videoanalyzer.models.OperationCollection + - name: OperationDisplay + uid: azure.mgmt.videoanalyzer.models.OperationDisplay + - name: ParameterDeclaration + uid: azure.mgmt.videoanalyzer.models.ParameterDeclaration + - name: ParameterDefinition + uid: azure.mgmt.videoanalyzer.models.ParameterDefinition + - name: ParameterType + uid: azure.mgmt.videoanalyzer.models.ParameterType + - name: PemCertificateList + uid: azure.mgmt.videoanalyzer.models.PemCertificateList + - name: PipelineJob + uid: azure.mgmt.videoanalyzer.models.PipelineJob + - name: PipelineJobCollection + uid: azure.mgmt.videoanalyzer.models.PipelineJobCollection + - name: PipelineJobError + uid: azure.mgmt.videoanalyzer.models.PipelineJobError + - name: PipelineJobOperationStatus + uid: azure.mgmt.videoanalyzer.models.PipelineJobOperationStatus + - name: PipelineJobState + uid: azure.mgmt.videoanalyzer.models.PipelineJobState + - name: PipelineJobUpdate + uid: azure.mgmt.videoanalyzer.models.PipelineJobUpdate + - name: PipelineTopology + uid: azure.mgmt.videoanalyzer.models.PipelineTopology + - name: PipelineTopologyCollection + uid: azure.mgmt.videoanalyzer.models.PipelineTopologyCollection + - name: PipelineTopologyUpdate + uid: azure.mgmt.videoanalyzer.models.PipelineTopologyUpdate + - name: PrivateEndpoint + uid: azure.mgmt.videoanalyzer.models.PrivateEndpoint + - name: PrivateEndpointConnection + uid: azure.mgmt.videoanalyzer.models.PrivateEndpointConnection + - name: PrivateEndpointConnectionListResult + uid: azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionListResult + - name: PrivateEndpointConnectionProvisioningState + uid: azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionProvisioningState + - name: PrivateEndpointServiceConnectionStatus + uid: azure.mgmt.videoanalyzer.models.PrivateEndpointServiceConnectionStatus + - name: PrivateLinkResource + uid: azure.mgmt.videoanalyzer.models.PrivateLinkResource + - name: PrivateLinkResourceListResult + uid: azure.mgmt.videoanalyzer.models.PrivateLinkResourceListResult + - name: PrivateLinkServiceConnectionState + uid: azure.mgmt.videoanalyzer.models.PrivateLinkServiceConnectionState + - name: ProcessorNodeBase + uid: azure.mgmt.videoanalyzer.models.ProcessorNodeBase + - name: Properties + uid: azure.mgmt.videoanalyzer.models.Properties + - name: ProvisioningState + uid: azure.mgmt.videoanalyzer.models.ProvisioningState + - name: ProxyResource + uid: azure.mgmt.videoanalyzer.models.ProxyResource + - name: PublicNetworkAccess + uid: azure.mgmt.videoanalyzer.models.PublicNetworkAccess + - name: Resource + uid: azure.mgmt.videoanalyzer.models.Resource + - name: ResourceIdentity + uid: azure.mgmt.videoanalyzer.models.ResourceIdentity + - name: RsaTokenKey + uid: azure.mgmt.videoanalyzer.models.RsaTokenKey + - name: RtspSource + uid: azure.mgmt.videoanalyzer.models.RtspSource + - name: RtspTransport + uid: azure.mgmt.videoanalyzer.models.RtspTransport + - name: SecureIotDeviceRemoteTunnel + uid: azure.mgmt.videoanalyzer.models.SecureIotDeviceRemoteTunnel + - name: ServiceSpecification + uid: azure.mgmt.videoanalyzer.models.ServiceSpecification + - name: SinkNodeBase + uid: azure.mgmt.videoanalyzer.models.SinkNodeBase + - name: Sku + uid: azure.mgmt.videoanalyzer.models.Sku + - name: SkuName + uid: azure.mgmt.videoanalyzer.models.SkuName + - name: SkuTier + uid: azure.mgmt.videoanalyzer.models.SkuTier + - name: SourceNodeBase + uid: azure.mgmt.videoanalyzer.models.SourceNodeBase + - name: StorageAccount + uid: azure.mgmt.videoanalyzer.models.StorageAccount + - name: SystemData + uid: azure.mgmt.videoanalyzer.models.SystemData + - name: TimeSequenceBase + uid: azure.mgmt.videoanalyzer.models.TimeSequenceBase + - name: TlsEndpoint + uid: azure.mgmt.videoanalyzer.models.TlsEndpoint + - name: TlsValidationOptions + uid: azure.mgmt.videoanalyzer.models.TlsValidationOptions + - name: TokenClaim + uid: azure.mgmt.videoanalyzer.models.TokenClaim + - name: TokenKey + uid: azure.mgmt.videoanalyzer.models.TokenKey + - name: TrackedResource + uid: azure.mgmt.videoanalyzer.models.TrackedResource + - name: TunnelBase + uid: azure.mgmt.videoanalyzer.models.TunnelBase + - name: UnsecuredEndpoint + uid: azure.mgmt.videoanalyzer.models.UnsecuredEndpoint + - name: UserAssignedManagedIdentity + uid: azure.mgmt.videoanalyzer.models.UserAssignedManagedIdentity + - name: UsernamePasswordCredentials + uid: azure.mgmt.videoanalyzer.models.UsernamePasswordCredentials + - name: VideoAnalyzer + uid: azure.mgmt.videoanalyzer.models.VideoAnalyzer + - name: VideoAnalyzerCollection + uid: azure.mgmt.videoanalyzer.models.VideoAnalyzerCollection + - name: VideoAnalyzerEndpointType + uid: azure.mgmt.videoanalyzer.models.VideoAnalyzerEndpointType + - name: VideoAnalyzerIdentity + uid: azure.mgmt.videoanalyzer.models.VideoAnalyzerIdentity + - name: VideoAnalyzerOperationStatus + uid: azure.mgmt.videoanalyzer.models.VideoAnalyzerOperationStatus + - name: VideoAnalyzerPrivateEndpointConnectionOperationStatus + uid: azure.mgmt.videoanalyzer.models.VideoAnalyzerPrivateEndpointConnectionOperationStatus + - name: VideoAnalyzerUpdate + uid: azure.mgmt.videoanalyzer.models.VideoAnalyzerUpdate + - name: VideoArchival + uid: azure.mgmt.videoanalyzer.models.VideoArchival + - name: VideoContentToken + uid: azure.mgmt.videoanalyzer.models.VideoContentToken + - name: VideoContentUrls + uid: azure.mgmt.videoanalyzer.models.VideoContentUrls + - name: VideoCreationProperties + uid: azure.mgmt.videoanalyzer.models.VideoCreationProperties + - name: VideoEncoderBase + uid: azure.mgmt.videoanalyzer.models.VideoEncoderBase + - name: VideoEncoderH264 + uid: azure.mgmt.videoanalyzer.models.VideoEncoderH264 + - name: VideoEntity + uid: azure.mgmt.videoanalyzer.models.VideoEntity + - name: VideoEntityCollection + uid: azure.mgmt.videoanalyzer.models.VideoEntityCollection + - name: VideoFlags + uid: azure.mgmt.videoanalyzer.models.VideoFlags + - name: VideoMediaInfo + uid: azure.mgmt.videoanalyzer.models.VideoMediaInfo + - name: VideoPreviewImageUrls + uid: azure.mgmt.videoanalyzer.models.VideoPreviewImageUrls + - name: VideoPublishingOptions + uid: azure.mgmt.videoanalyzer.models.VideoPublishingOptions + - name: VideoScale + uid: azure.mgmt.videoanalyzer.models.VideoScale + - name: VideoScaleMode + uid: azure.mgmt.videoanalyzer.models.VideoScaleMode + - name: VideoSequenceAbsoluteTimeMarkers + uid: azure.mgmt.videoanalyzer.models.VideoSequenceAbsoluteTimeMarkers + - name: VideoSink + uid: azure.mgmt.videoanalyzer.models.VideoSink + - name: VideoSource + uid: azure.mgmt.videoanalyzer.models.VideoSource + - name: VideoType + uid: azure.mgmt.videoanalyzer.models.VideoType + name: models + - items: + - name: Overview + uid: azure.mgmt.videoanalyzer.operations + - name: AccessPoliciesOperations + uid: azure.mgmt.videoanalyzer.operations.AccessPoliciesOperations + - name: EdgeModulesOperations + uid: azure.mgmt.videoanalyzer.operations.EdgeModulesOperations + - name: LivePipelineOperationStatusesOperations + uid: azure.mgmt.videoanalyzer.operations.LivePipelineOperationStatusesOperations + - name: LivePipelinesOperations + uid: azure.mgmt.videoanalyzer.operations.LivePipelinesOperations + - name: LocationsOperations + uid: azure.mgmt.videoanalyzer.operations.LocationsOperations + - name: OperationResultsOperations + uid: azure.mgmt.videoanalyzer.operations.OperationResultsOperations + - name: OperationStatusesOperations + uid: azure.mgmt.videoanalyzer.operations.OperationStatusesOperations + - name: Operations + uid: azure.mgmt.videoanalyzer.operations.Operations + - name: PipelineJobOperationStatusesOperations + uid: azure.mgmt.videoanalyzer.operations.PipelineJobOperationStatusesOperations + - name: PipelineJobsOperations + uid: azure.mgmt.videoanalyzer.operations.PipelineJobsOperations + - name: PipelineTopologiesOperations + uid: azure.mgmt.videoanalyzer.operations.PipelineTopologiesOperations + - name: PrivateEndpointConnectionsOperations + uid: azure.mgmt.videoanalyzer.operations.PrivateEndpointConnectionsOperations + - name: PrivateLinkResourcesOperations + uid: azure.mgmt.videoanalyzer.operations.PrivateLinkResourcesOperations + - name: VideoAnalyzerOperationResultsOperations + uid: azure.mgmt.videoanalyzer.operations.VideoAnalyzerOperationResultsOperations + - name: VideoAnalyzerOperationStatusesOperations + uid: azure.mgmt.videoanalyzer.operations.VideoAnalyzerOperationStatusesOperations + - name: VideoAnalyzersOperations + uid: azure.mgmt.videoanalyzer.operations.VideoAnalyzersOperations + - name: VideosOperations + uid: azure.mgmt.videoanalyzer.operations.VideosOperations + name: operations + - name: VideoAnalyzer + uid: azure.mgmt.videoanalyzer.VideoAnalyzer + name: azure.mgmt.videoanalyzer +- items: + - name: Overview + uid: azure.mgmt.workloadmonitor + - items: + - name: Overview + uid: azure.mgmt.workloadmonitor.aio + - items: + - name: Overview + uid: azure.mgmt.workloadmonitor.aio.operations + - name: HealthMonitorsOperations + uid: azure.mgmt.workloadmonitor.aio.operations.HealthMonitorsOperations + - name: Operations + uid: azure.mgmt.workloadmonitor.aio.operations.Operations + name: operations + - name: WorkloadMonitorAPI + uid: azure.mgmt.workloadmonitor.aio.WorkloadMonitorAPI + name: aio + - items: + - name: Overview + uid: azure.mgmt.workloadmonitor.models + - name: ErrorDetails + uid: azure.mgmt.workloadmonitor.models.ErrorDetails + - name: ErrorResponse + uid: azure.mgmt.workloadmonitor.models.ErrorResponse + - name: ErrorResponseError + uid: azure.mgmt.workloadmonitor.models.ErrorResponseError + - name: HealthMonitor + uid: azure.mgmt.workloadmonitor.models.HealthMonitor + - name: HealthMonitorList + uid: azure.mgmt.workloadmonitor.models.HealthMonitorList + - name: HealthMonitorStateChange + uid: azure.mgmt.workloadmonitor.models.HealthMonitorStateChange + - name: HealthMonitorStateChangeList + uid: azure.mgmt.workloadmonitor.models.HealthMonitorStateChangeList + - name: HealthState + uid: azure.mgmt.workloadmonitor.models.HealthState + - name: Operation + uid: azure.mgmt.workloadmonitor.models.Operation + - name: OperationDisplay + uid: azure.mgmt.workloadmonitor.models.OperationDisplay + - name: OperationList + uid: azure.mgmt.workloadmonitor.models.OperationList + - name: Resource + uid: azure.mgmt.workloadmonitor.models.Resource + name: models + - items: + - name: Overview + uid: azure.mgmt.workloadmonitor.operations + - name: HealthMonitorsOperations + uid: azure.mgmt.workloadmonitor.operations.HealthMonitorsOperations + - name: Operations + uid: azure.mgmt.workloadmonitor.operations.Operations + name: operations + - name: WorkloadMonitorAPI + uid: azure.mgmt.workloadmonitor.WorkloadMonitorAPI + name: azure.mgmt.workloadmonitor +- items: + - name: Overview + uid: azure.purview.catalog + - items: + - name: Overview + uid: azure.purview.catalog.aio + - items: + - name: Overview + uid: azure.purview.catalog.aio.operations + - name: CollectionOperations + uid: azure.purview.catalog.aio.operations.CollectionOperations + - name: DiscoveryOperations + uid: azure.purview.catalog.aio.operations.DiscoveryOperations + - name: EntityOperations + uid: azure.purview.catalog.aio.operations.EntityOperations + - name: GlossaryOperations + uid: azure.purview.catalog.aio.operations.GlossaryOperations + - name: LineageOperations + uid: azure.purview.catalog.aio.operations.LineageOperations + - name: RelationshipOperations + uid: azure.purview.catalog.aio.operations.RelationshipOperations + - name: TypesOperations + uid: azure.purview.catalog.aio.operations.TypesOperations + name: operations + - name: PurviewCatalogClient + uid: azure.purview.catalog.aio.PurviewCatalogClient + name: aio + - items: + - name: Overview + uid: azure.purview.catalog.operations + - name: CollectionOperations + uid: azure.purview.catalog.operations.CollectionOperations + - name: DiscoveryOperations + uid: azure.purview.catalog.operations.DiscoveryOperations + - name: EntityOperations + uid: azure.purview.catalog.operations.EntityOperations + - name: GlossaryOperations + uid: azure.purview.catalog.operations.GlossaryOperations + - name: LineageOperations + uid: azure.purview.catalog.operations.LineageOperations + - name: RelationshipOperations + uid: azure.purview.catalog.operations.RelationshipOperations + - name: TypesOperations + uid: azure.purview.catalog.operations.TypesOperations + name: operations + - name: PurviewCatalogClient + uid: azure.purview.catalog.PurviewCatalogClient + name: azure.purview.catalog +- name: azure.servicemanagement.constants + uid: azure.servicemanagement.constants +- items: + - name: Overview + uid: azure.servicemanagement.models + - name: AdditionalUnattendContent + uid: azure.servicemanagement.models.AdditionalUnattendContent + - name: AffinityGroup + uid: azure.servicemanagement.models.AffinityGroup + - name: AffinityGroups + uid: azure.servicemanagement.models.AffinityGroups + - name: AsynchronousOperationResult + uid: azure.servicemanagement.models.AsynchronousOperationResult + - name: AttachedTo + uid: azure.servicemanagement.models.AttachedTo + - name: AuthorizationRule + uid: azure.servicemanagement.models.AuthorizationRule + - name: AuthorizationRules + uid: azure.servicemanagement.models.AuthorizationRules + - name: AvailabilityResponse + uid: azure.servicemanagement.models.AvailabilityResponse + - name: AzureAsyncOperationHttpError + uid: azure.servicemanagement.models.AzureAsyncOperationHttpError + - name: CaptureRoleAsVMImage + uid: azure.servicemanagement.models.CaptureRoleAsVMImage + - name: Certificate + uid: azure.servicemanagement.models.Certificate + - name: CertificateSetting + uid: azure.servicemanagement.models.CertificateSetting + - name: Certificates + uid: azure.servicemanagement.models.Certificates + - name: CloudService + uid: azure.servicemanagement.models.CloudService + - name: CloudServices + uid: azure.servicemanagement.models.CloudServices + - name: ComponentSetting + uid: azure.servicemanagement.models.ComponentSetting + - name: ComponentSettings + uid: azure.servicemanagement.models.ComponentSettings + - name: Components + uid: azure.servicemanagement.models.Components + - name: ComputeCapabilities + uid: azure.servicemanagement.models.ComputeCapabilities + - name: ConfigurationSet + uid: azure.servicemanagement.models.ConfigurationSet + - name: ConfigurationSetInputEndpoint + uid: azure.servicemanagement.models.ConfigurationSetInputEndpoint + - name: ConfigurationSetInputEndpoints + uid: azure.servicemanagement.models.ConfigurationSetInputEndpoints + - name: ConfigurationSets + uid: azure.servicemanagement.models.ConfigurationSets + - name: CountDetails + uid: azure.servicemanagement.models.CountDetails + - name: CreateServerResponse + uid: azure.servicemanagement.models.CreateServerResponse + - name: Credentials + uid: azure.servicemanagement.models.Credentials + - name: Data + uid: azure.servicemanagement.models.Data + - name: DataDiskConfiguration + uid: azure.servicemanagement.models.DataDiskConfiguration + - name: DataDiskConfigurations + uid: azure.servicemanagement.models.DataDiskConfigurations + - name: DataVirtualHardDisk + uid: azure.servicemanagement.models.DataVirtualHardDisk + - name: DataVirtualHardDisks + uid: azure.servicemanagement.models.DataVirtualHardDisks + - name: Database + uid: azure.servicemanagement.models.Database + - name: Deployment + uid: azure.servicemanagement.models.Deployment + - name: Deployments + uid: azure.servicemanagement.models.Deployments + - name: Disk + uid: azure.servicemanagement.models.Disk + - name: Disks + uid: azure.servicemanagement.models.Disks + - name: DnsServer + uid: azure.servicemanagement.models.DnsServer + - name: DomainJoin + uid: azure.servicemanagement.models.DomainJoin + - name: EventLog + uid: azure.servicemanagement.models.EventLog + - name: FirewallRule + uid: azure.servicemanagement.models.FirewallRule + - name: HostNameSslState + uid: azure.servicemanagement.models.HostNameSslState + - name: HostNameSslStates + uid: azure.servicemanagement.models.HostNameSslStates + - name: HostedService + uid: azure.servicemanagement.models.HostedService + - name: HostedServiceProperties + uid: azure.servicemanagement.models.HostedServiceProperties + - name: HostedServices + uid: azure.servicemanagement.models.HostedServices + - name: Images + uid: azure.servicemanagement.models.Images + - name: InputEndpoint + uid: azure.servicemanagement.models.InputEndpoint + - name: InputEndpoints + uid: azure.servicemanagement.models.InputEndpoints + - name: InstanceEndpoint + uid: azure.servicemanagement.models.InstanceEndpoint + - name: InstanceEndpoints + uid: azure.servicemanagement.models.InstanceEndpoints + - name: IntrinsicSettings + uid: azure.servicemanagement.models.IntrinsicSettings + - name: KeyPair + uid: azure.servicemanagement.models.KeyPair + - name: KeyPairs + uid: azure.servicemanagement.models.KeyPairs + - name: LinuxConfigurationSet + uid: azure.servicemanagement.models.LinuxConfigurationSet + - name: Listener + uid: azure.servicemanagement.models.Listener + - name: Listeners + uid: azure.servicemanagement.models.Listeners + - name: LoadBalancerProbe + uid: azure.servicemanagement.models.LoadBalancerProbe + - name: Location + uid: azure.servicemanagement.models.Location + - name: Locations + uid: azure.servicemanagement.models.Locations + - name: MaxRecurrence + uid: azure.servicemanagement.models.MaxRecurrence + - name: MetricAvailabilities + uid: azure.servicemanagement.models.MetricAvailabilities + - name: MetricAvailability + uid: azure.servicemanagement.models.MetricAvailability + - name: MetricDefinition + uid: azure.servicemanagement.models.MetricDefinition + - name: MetricDefinitions + uid: azure.servicemanagement.models.MetricDefinitions + - name: MetricProperties + uid: azure.servicemanagement.models.MetricProperties + - name: MetricResponse + uid: azure.servicemanagement.models.MetricResponse + - name: MetricResponses + uid: azure.servicemanagement.models.MetricResponses + - name: MetricRollups + uid: azure.servicemanagement.models.MetricRollups + - name: MetricSample + uid: azure.servicemanagement.models.MetricSample + - name: MetricValues + uid: azure.servicemanagement.models.MetricValues + - name: NotificationHubDescription + uid: azure.servicemanagement.models.NotificationHubDescription + - name: OSDiskConfiguration + uid: azure.servicemanagement.models.OSDiskConfiguration + - name: OSImage + uid: azure.servicemanagement.models.OSImage + - name: OSImageDetails + uid: azure.servicemanagement.models.OSImageDetails + - name: OSVirtualHardDisk + uid: azure.servicemanagement.models.OSVirtualHardDisk + - name: OperatingSystem + uid: azure.servicemanagement.models.OperatingSystem + - name: OperatingSystemFamilies + uid: azure.servicemanagement.models.OperatingSystemFamilies + - name: OperatingSystemFamily + uid: azure.servicemanagement.models.OperatingSystemFamily + - name: OperatingSystems + uid: azure.servicemanagement.models.OperatingSystems + - name: Operation + uid: azure.servicemanagement.models.Operation + - name: OperationCaller + uid: azure.servicemanagement.models.OperationCaller + - name: OperationError + uid: azure.servicemanagement.models.OperationError + - name: OperationStatus + uid: azure.servicemanagement.models.OperationStatus + - name: Passes + uid: azure.servicemanagement.models.Passes + - name: PersistentVMDowntimeInfo + uid: azure.servicemanagement.models.PersistentVMDowntimeInfo + - name: PersistentVMRole + uid: azure.servicemanagement.models.PersistentVMRole + - name: PublicIP + uid: azure.servicemanagement.models.PublicIP + - name: PublicIPs + uid: azure.servicemanagement.models.PublicIPs + - name: PublicKey + uid: azure.servicemanagement.models.PublicKey + - name: PublicKeys + uid: azure.servicemanagement.models.PublicKeys + - name: PublishData + uid: azure.servicemanagement.models.PublishData + - name: PublishProfile + uid: azure.servicemanagement.models.PublishProfile + - name: QueueDescription + uid: azure.servicemanagement.models.QueueDescription + - name: Quota + uid: azure.servicemanagement.models.Quota + - name: RelayDescription + uid: azure.servicemanagement.models.RelayDescription + - name: ReplicationProgress + uid: azure.servicemanagement.models.ReplicationProgress + - name: ReplicationProgressElement + uid: azure.servicemanagement.models.ReplicationProgressElement + - name: ReservedIP + uid: azure.servicemanagement.models.ReservedIP + - name: ReservedIPs + uid: azure.servicemanagement.models.ReservedIPs + - name: Resource + uid: azure.servicemanagement.models.Resource + - name: ResourceExtension + uid: azure.servicemanagement.models.ResourceExtension + - name: ResourceExtensionParameterValue + uid: azure.servicemanagement.models.ResourceExtensionParameterValue + - name: ResourceExtensionParameterValues + uid: azure.servicemanagement.models.ResourceExtensionParameterValues + - name: ResourceExtensionReference + uid: azure.servicemanagement.models.ResourceExtensionReference + - name: ResourceExtensionReferences + uid: azure.servicemanagement.models.ResourceExtensionReferences + - name: ResourceExtensions + uid: azure.servicemanagement.models.ResourceExtensions + - name: Resources + uid: azure.servicemanagement.models.Resources + - name: Role + uid: azure.servicemanagement.models.Role + - name: RoleInstance + uid: azure.servicemanagement.models.RoleInstance + - name: RoleInstanceList + uid: azure.servicemanagement.models.RoleInstanceList + - name: RoleList + uid: azure.servicemanagement.models.RoleList + - name: RoleSize + uid: azure.servicemanagement.models.RoleSize + - name: RoleSizes + uid: azure.servicemanagement.models.RoleSizes + - name: SSH + uid: azure.servicemanagement.models.SSH + - name: Server + uid: azure.servicemanagement.models.Server + - name: ServerQuota + uid: azure.servicemanagement.models.ServerQuota + - name: Servers + uid: azure.servicemanagement.models.Servers + - name: ServiceBusNamespace + uid: azure.servicemanagement.models.ServiceBusNamespace + - name: ServiceBusRegion + uid: azure.servicemanagement.models.ServiceBusRegion + - name: ServiceObjective + uid: azure.servicemanagement.models.ServiceObjective + - name: Site + uid: azure.servicemanagement.models.Site + - name: Sites + uid: azure.servicemanagement.models.Sites + - name: StorageAccountProperties + uid: azure.servicemanagement.models.StorageAccountProperties + - name: StorageService + uid: azure.servicemanagement.models.StorageService + - name: StorageServiceKeys + uid: azure.servicemanagement.models.StorageServiceKeys + - name: StorageServices + uid: azure.servicemanagement.models.StorageServices + - name: StoredCertificateSettings + uid: azure.servicemanagement.models.StoredCertificateSettings + - name: Subnet + uid: azure.servicemanagement.models.Subnet + - name: Subnets + uid: azure.servicemanagement.models.Subnets + - name: Subscription + uid: azure.servicemanagement.models.Subscription + - name: SubscriptionCertificate + uid: azure.servicemanagement.models.SubscriptionCertificate + - name: SubscriptionCertificates + uid: azure.servicemanagement.models.SubscriptionCertificates + - name: SubscriptionOperation + uid: azure.servicemanagement.models.SubscriptionOperation + - name: SubscriptionOperationCollection + uid: azure.servicemanagement.models.SubscriptionOperationCollection + - name: SubscriptionOperationStatus + uid: azure.servicemanagement.models.SubscriptionOperationStatus + - name: SubscriptionOperations + uid: azure.servicemanagement.models.SubscriptionOperations + - name: Subscriptions + uid: azure.servicemanagement.models.Subscriptions + - name: TopicDescription + uid: azure.servicemanagement.models.TopicDescription + - name: UnattendComponent + uid: azure.servicemanagement.models.UnattendComponent + - name: UnattendPass + uid: azure.servicemanagement.models.UnattendPass + - name: UpgradeStatus + uid: azure.servicemanagement.models.UpgradeStatus + - name: VMImage + uid: azure.servicemanagement.models.VMImage + - name: VMImages + uid: azure.servicemanagement.models.VMImages + - name: Values + uid: azure.servicemanagement.models.Values + - name: VirtualIP + uid: azure.servicemanagement.models.VirtualIP + - name: VirtualIPs + uid: azure.servicemanagement.models.VirtualIPs + - name: VirtualNetworkSite + uid: azure.servicemanagement.models.VirtualNetworkSite + - name: VirtualNetworkSites + uid: azure.servicemanagement.models.VirtualNetworkSites + - name: WebSpace + uid: azure.servicemanagement.models.WebSpace + - name: WebSpaces + uid: azure.servicemanagement.models.WebSpaces + - name: WinRM + uid: azure.servicemanagement.models.WinRM + - name: WindowsConfigurationSet + uid: azure.servicemanagement.models.WindowsConfigurationSet + name: azure.servicemanagement.models +- name: azure.servicemanagement.publishsettings + uid: azure.servicemanagement.publishsettings +- items: + - name: Overview + uid: azure.servicemanagement.schedulermanagementservice + - name: SchedulerManagementService + uid: azure.servicemanagement.schedulermanagementservice.SchedulerManagementService + name: azure.servicemanagement.schedulermanagementservice +- items: + - name: Overview + uid: azure.servicemanagement.servicebusmanagementservice + - name: ServiceBusManagementService + uid: azure.servicemanagement.servicebusmanagementservice.ServiceBusManagementService + name: azure.servicemanagement.servicebusmanagementservice +- name: azure.servicemanagement.servicemanagementclient + uid: azure.servicemanagement.servicemanagementclient +- items: + - name: Overview + uid: azure.servicemanagement.servicemanagementservice + - name: ServiceManagementService + uid: azure.servicemanagement.servicemanagementservice.ServiceManagementService + name: azure.servicemanagement.servicemanagementservice +- items: + - name: Overview + uid: azure.servicemanagement.sqldatabasemanagementservice + - name: SqlDatabaseManagementService + uid: azure.servicemanagement.sqldatabasemanagementservice.SqlDatabaseManagementService + name: azure.servicemanagement.sqldatabasemanagementservice +- items: + - name: Overview + uid: azure.servicemanagement.websitemanagementservice + - name: WebsiteManagementService + uid: azure.servicemanagement.websitemanagementservice.WebsiteManagementService + name: azure.servicemanagement.websitemanagementservice +- items: + - name: Overview + uid: azure.storage.blob + - items: + - name: Overview + uid: azure.storage.blob.appendblobservice + - name: AppendBlobService + uid: azure.storage.blob.appendblobservice.AppendBlobService + name: appendblobservice + - items: + - name: Overview + uid: azure.storage.blob.baseblobservice + - name: BaseBlobService + uid: azure.storage.blob.baseblobservice.BaseBlobService + name: baseblobservice + - items: + - name: Overview + uid: azure.storage.blob.blockblobservice + - name: BlockBlobService + uid: azure.storage.blob.blockblobservice.BlockBlobService + name: blockblobservice + - items: + - name: Overview + uid: azure.storage.blob.models + - name: AccountInformation + uid: azure.storage.blob.models.AccountInformation + - name: AppendBlockProperties + uid: azure.storage.blob.models.AppendBlockProperties + - name: BatchDeleteSubRequest + uid: azure.storage.blob.models.BatchDeleteSubRequest + - name: BatchSetBlobTierSubRequest + uid: azure.storage.blob.models.BatchSetBlobTierSubRequest + - name: BatchSubResponse + uid: azure.storage.blob.models.BatchSubResponse + - name: Blob + uid: azure.storage.blob.models.Blob + - name: BlobBlock + uid: azure.storage.blob.models.BlobBlock + - name: BlobBlockList + uid: azure.storage.blob.models.BlobBlockList + - name: BlobBlockState + uid: azure.storage.blob.models.BlobBlockState + - name: BlobPermissions + uid: azure.storage.blob.models.BlobPermissions + - name: BlobPrefix + uid: azure.storage.blob.models.BlobPrefix + - name: BlobProperties + uid: azure.storage.blob.models.BlobProperties + - name: BlockListType + uid: azure.storage.blob.models.BlockListType + - name: Container + uid: azure.storage.blob.models.Container + - name: ContainerPermissions + uid: azure.storage.blob.models.ContainerPermissions + - name: ContainerProperties + uid: azure.storage.blob.models.ContainerProperties + - name: ContentSettings + uid: azure.storage.blob.models.ContentSettings + - name: CopyProperties + uid: azure.storage.blob.models.CopyProperties + - name: CustomerProvidedEncryptionKey + uid: azure.storage.blob.models.CustomerProvidedEncryptionKey + - name: DeleteSnapshot + uid: azure.storage.blob.models.DeleteSnapshot + - name: Include + uid: azure.storage.blob.models.Include + - name: LeaseProperties + uid: azure.storage.blob.models.LeaseProperties + - name: PageBlobProperties + uid: azure.storage.blob.models.PageBlobProperties + - name: PageRange + uid: azure.storage.blob.models.PageRange + - name: PremiumPageBlobTier + uid: azure.storage.blob.models.PremiumPageBlobTier + - name: PublicAccess + uid: azure.storage.blob.models.PublicAccess + - name: RehydratePriority + uid: azure.storage.blob.models.RehydratePriority + - name: ResourceProperties + uid: azure.storage.blob.models.ResourceProperties + - name: SequenceNumberAction + uid: azure.storage.blob.models.SequenceNumberAction + - name: StandardBlobTier + uid: azure.storage.blob.models.StandardBlobTier + - name: UserDelegationKey + uid: azure.storage.blob.models.UserDelegationKey + name: models + - items: + - name: Overview + uid: azure.storage.blob.pageblobservice + - name: PageBlobService + uid: azure.storage.blob.pageblobservice.PageBlobService + name: pageblobservice + - items: + - name: Overview + uid: azure.storage.blob.sharedaccesssignature + - name: BlobSharedAccessSignature + uid: azure.storage.blob.sharedaccesssignature.BlobSharedAccessSignature + name: sharedaccesssignature + name: azure.storage.blob +- items: + - name: Overview + uid: azure.storage.common + - items: + - name: Overview + uid: azure.storage.common.cloudstorageaccount + - name: CloudStorageAccount + uid: azure.storage.common.cloudstorageaccount.CloudStorageAccount + name: cloudstorageaccount + - items: + - name: Overview + uid: azure.storage.common.models + - name: AccessPolicy + uid: azure.storage.common.models.AccessPolicy + - name: AccountPermissions + uid: azure.storage.common.models.AccountPermissions + - name: CorsRule + uid: azure.storage.common.models.CorsRule + - name: DeleteRetentionPolicy + uid: azure.storage.common.models.DeleteRetentionPolicy + - name: GeoReplication + uid: azure.storage.common.models.GeoReplication + - name: ListGenerator + uid: azure.storage.common.models.ListGenerator + - name: LocationMode + uid: azure.storage.common.models.LocationMode + - name: Logging + uid: azure.storage.common.models.Logging + - name: Metrics + uid: azure.storage.common.models.Metrics + - name: Protocol + uid: azure.storage.common.models.Protocol + - name: ResourceTypes + uid: azure.storage.common.models.ResourceTypes + - name: RetentionPolicy + uid: azure.storage.common.models.RetentionPolicy + - name: RetryContext + uid: azure.storage.common.models.RetryContext + - name: ServiceProperties + uid: azure.storage.common.models.ServiceProperties + - name: ServiceStats + uid: azure.storage.common.models.ServiceStats + - name: Services + uid: azure.storage.common.models.Services + - name: StaticWebsite + uid: azure.storage.common.models.StaticWebsite + name: models + - items: + - name: Overview + uid: azure.storage.common.retry + - name: ExponentialRetry + uid: azure.storage.common.retry.ExponentialRetry + - name: LinearRetry + uid: azure.storage.common.retry.LinearRetry + name: retry + - items: + - name: Overview + uid: azure.storage.common.sharedaccesssignature + - name: SharedAccessSignature + uid: azure.storage.common.sharedaccesssignature.SharedAccessSignature + name: sharedaccesssignature + - items: + - name: Overview + uid: azure.storage.common.storageclient + - name: StorageClient + uid: azure.storage.common.storageclient.StorageClient + name: storageclient + - items: + - name: Overview + uid: azure.storage.common.tokencredential + - name: TokenCredential + uid: azure.storage.common.tokencredential.TokenCredential + name: tokencredential + name: azure.storage.common +- items: + - name: Overview + uid: azure.storage.file + - items: + - name: Overview + uid: azure.storage.file.fileservice + - name: FileService + uid: azure.storage.file.fileservice.FileService + name: fileservice + - items: + - name: Overview + uid: azure.storage.file.models + - name: ContentSettings + uid: azure.storage.file.models.ContentSettings + - name: CopyProperties + uid: azure.storage.file.models.CopyProperties + - name: DeleteSnapshot + uid: azure.storage.file.models.DeleteSnapshot + - name: Directory + uid: azure.storage.file.models.Directory + - name: DirectoryProperties + uid: azure.storage.file.models.DirectoryProperties + - name: File + uid: azure.storage.file.models.File + - name: FilePermissions + uid: azure.storage.file.models.FilePermissions + - name: FileProperties + uid: azure.storage.file.models.FileProperties + - name: FileRange + uid: azure.storage.file.models.FileRange + - name: Handle + uid: azure.storage.file.models.Handle + - name: LeaseProperties + uid: azure.storage.file.models.LeaseProperties + - name: NTFSAttributes + uid: azure.storage.file.models.NTFSAttributes + - name: SMBProperties + uid: azure.storage.file.models.SMBProperties + - name: Share + uid: azure.storage.file.models.Share + - name: SharePermissions + uid: azure.storage.file.models.SharePermissions + - name: ShareProperties + uid: azure.storage.file.models.ShareProperties + name: models + - items: + - name: Overview + uid: azure.storage.file.sharedaccesssignature + - name: FileSharedAccessSignature + uid: azure.storage.file.sharedaccesssignature.FileSharedAccessSignature + name: sharedaccesssignature + name: azure.storage.file +- items: + - name: Overview + uid: azure.storage.queue + - items: + - name: Overview + uid: azure.storage.queue.models + - name: Queue + uid: azure.storage.queue.models.Queue + - name: QueueMessage + uid: azure.storage.queue.models.QueueMessage + - name: QueueMessageFormat + uid: azure.storage.queue.models.QueueMessageFormat + - name: QueuePermissions + uid: azure.storage.queue.models.QueuePermissions + name: models + - items: + - name: Overview + uid: azure.storage.queue.queueservice + - name: QueueService + uid: azure.storage.queue.queueservice.QueueService + name: queueservice + - items: + - name: Overview + uid: azure.storage.queue.sharedaccesssignature + - name: QueueSharedAccessSignature + uid: azure.storage.queue.sharedaccesssignature.QueueSharedAccessSignature + name: sharedaccesssignature + name: azure.storage.queue +- items: + - name: Overview + uid: azure.synapse + - items: + - name: Overview + uid: azure.synapse.accesscontrol + - items: + - name: Overview + uid: azure.synapse.accesscontrol.aio + - items: + - name: Overview + uid: azure.synapse.accesscontrol.aio.operations_async + - name: AccessControlOperations + uid: azure.synapse.accesscontrol.aio.operations_async.AccessControlOperations + name: operations_async + - name: AccessControlClient + uid: azure.synapse.accesscontrol.aio.AccessControlClient + name: aio + - items: + - name: Overview + uid: azure.synapse.accesscontrol.models + - name: ErrorContract + uid: azure.synapse.accesscontrol.models.ErrorContract + - name: ErrorDetail + uid: azure.synapse.accesscontrol.models.ErrorDetail + - name: ErrorResponse + uid: azure.synapse.accesscontrol.models.ErrorResponse + - name: RoleAssignmentDetails + uid: azure.synapse.accesscontrol.models.RoleAssignmentDetails + - name: RoleAssignmentOptions + uid: azure.synapse.accesscontrol.models.RoleAssignmentOptions + - name: RolesListResponse + uid: azure.synapse.accesscontrol.models.RolesListResponse + - name: SynapseRole + uid: azure.synapse.accesscontrol.models.SynapseRole + name: models + - items: + - name: Overview + uid: azure.synapse.accesscontrol.operations + - name: AccessControlOperations + uid: azure.synapse.accesscontrol.operations.AccessControlOperations + name: operations + - name: AccessControlClient + uid: azure.synapse.accesscontrol.AccessControlClient + name: accesscontrol + - items: + - name: Overview + uid: azure.synapse.aio + - items: + - name: Overview + uid: azure.synapse.aio.operations_async + - name: MonitoringOperations + uid: azure.synapse.aio.operations_async.MonitoringOperations + - name: SparkBatchOperations + uid: azure.synapse.aio.operations_async.SparkBatchOperations + - name: SparkSessionOperations + uid: azure.synapse.aio.operations_async.SparkSessionOperations + - name: WorkspaceAclOperations + uid: azure.synapse.aio.operations_async.WorkspaceAclOperations + name: operations_async + - name: SynapseClient + uid: azure.synapse.aio.SynapseClient + name: aio + - items: + - name: Overview + uid: azure.synapse.artifacts + - items: + - name: Overview + uid: azure.synapse.artifacts.aio + - items: + - name: Overview + uid: azure.synapse.artifacts.aio.operations_async + - name: DataFlowDebugSessionOperations + uid: azure.synapse.artifacts.aio.operations_async.DataFlowDebugSessionOperations + - name: DataFlowOperations + uid: azure.synapse.artifacts.aio.operations_async.DataFlowOperations + - name: DatasetOperations + uid: azure.synapse.artifacts.aio.operations_async.DatasetOperations + - name: LinkedServiceOperations + uid: azure.synapse.artifacts.aio.operations_async.LinkedServiceOperations + - name: NotebookOperations + uid: azure.synapse.artifacts.aio.operations_async.NotebookOperations + - name: PipelineOperations + uid: azure.synapse.artifacts.aio.operations_async.PipelineOperations + - name: PipelineRunOperations + uid: azure.synapse.artifacts.aio.operations_async.PipelineRunOperations + - name: SparkJobDefinitionOperations + uid: azure.synapse.artifacts.aio.operations_async.SparkJobDefinitionOperations + - name: SqlScriptOperations + uid: azure.synapse.artifacts.aio.operations_async.SqlScriptOperations + - name: TriggerOperations + uid: azure.synapse.artifacts.aio.operations_async.TriggerOperations + - name: TriggerRunOperations + uid: azure.synapse.artifacts.aio.operations_async.TriggerRunOperations + name: operations_async + - name: ArtifactsClient + uid: azure.synapse.artifacts.aio.ArtifactsClient + name: aio + - items: + - name: Overview + uid: azure.synapse.artifacts.models + - name: Activity + uid: azure.synapse.artifacts.models.Activity + - name: ActivityDependency + uid: azure.synapse.artifacts.models.ActivityDependency + - name: ActivityPolicy + uid: azure.synapse.artifacts.models.ActivityPolicy + - name: ActivityRun + uid: azure.synapse.artifacts.models.ActivityRun + - name: ActivityRunsQueryResponse + uid: azure.synapse.artifacts.models.ActivityRunsQueryResponse + - name: AddDataFlowToDebugSessionResponse + uid: azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse + - name: AmazonMWSLinkedService + uid: azure.synapse.artifacts.models.AmazonMWSLinkedService + - name: AmazonMWSObjectDataset + uid: azure.synapse.artifacts.models.AmazonMWSObjectDataset + - name: AmazonRedshiftLinkedService + uid: azure.synapse.artifacts.models.AmazonRedshiftLinkedService + - name: AmazonRedshiftTableDataset + uid: azure.synapse.artifacts.models.AmazonRedshiftTableDataset + - name: AmazonS3LinkedService + uid: azure.synapse.artifacts.models.AmazonS3LinkedService + - name: AppendVariableActivity + uid: azure.synapse.artifacts.models.AppendVariableActivity + - name: AvroCompressionCodec + uid: azure.synapse.artifacts.models.AvroCompressionCodec + - name: AvroDataset + uid: azure.synapse.artifacts.models.AvroDataset + - name: AzureBatchLinkedService + uid: azure.synapse.artifacts.models.AzureBatchLinkedService + - name: AzureBlobFSLinkedService + uid: azure.synapse.artifacts.models.AzureBlobFSLinkedService + - name: AzureBlobStorageLinkedService + uid: azure.synapse.artifacts.models.AzureBlobStorageLinkedService + - name: AzureDataExplorerCommandActivity + uid: azure.synapse.artifacts.models.AzureDataExplorerCommandActivity + - name: AzureDataExplorerLinkedService + uid: azure.synapse.artifacts.models.AzureDataExplorerLinkedService + - name: AzureDataExplorerTableDataset + uid: azure.synapse.artifacts.models.AzureDataExplorerTableDataset + - name: AzureDataLakeAnalyticsLinkedService + uid: azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService + - name: AzureDataLakeStoreLinkedService + uid: azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService + - name: AzureDatabricksLinkedService + uid: azure.synapse.artifacts.models.AzureDatabricksLinkedService + - name: AzureFileStorageLinkedService + uid: azure.synapse.artifacts.models.AzureFileStorageLinkedService + - name: AzureFunctionActivity + uid: azure.synapse.artifacts.models.AzureFunctionActivity + - name: AzureFunctionActivityMethod + uid: azure.synapse.artifacts.models.AzureFunctionActivityMethod + - name: AzureFunctionLinkedService + uid: azure.synapse.artifacts.models.AzureFunctionLinkedService + - name: AzureKeyVaultLinkedService + uid: azure.synapse.artifacts.models.AzureKeyVaultLinkedService + - name: AzureKeyVaultSecretReference + uid: azure.synapse.artifacts.models.AzureKeyVaultSecretReference + - name: AzureMLBatchExecutionActivity + uid: azure.synapse.artifacts.models.AzureMLBatchExecutionActivity + - name: AzureMLExecutePipelineActivity + uid: azure.synapse.artifacts.models.AzureMLExecutePipelineActivity + - name: AzureMLLinkedService + uid: azure.synapse.artifacts.models.AzureMLLinkedService + - name: AzureMLServiceLinkedService + uid: azure.synapse.artifacts.models.AzureMLServiceLinkedService + - name: AzureMLUpdateResourceActivity + uid: azure.synapse.artifacts.models.AzureMLUpdateResourceActivity + - name: AzureMLWebServiceFile + uid: azure.synapse.artifacts.models.AzureMLWebServiceFile + - name: AzureMariaDBLinkedService + uid: azure.synapse.artifacts.models.AzureMariaDBLinkedService + - name: AzureMariaDBTableDataset + uid: azure.synapse.artifacts.models.AzureMariaDBTableDataset + - name: AzureMySqlLinkedService + uid: azure.synapse.artifacts.models.AzureMySqlLinkedService + - name: AzureMySqlTableDataset + uid: azure.synapse.artifacts.models.AzureMySqlTableDataset + - name: AzurePostgreSqlLinkedService + uid: azure.synapse.artifacts.models.AzurePostgreSqlLinkedService + - name: AzurePostgreSqlTableDataset + uid: azure.synapse.artifacts.models.AzurePostgreSqlTableDataset + - name: AzureSearchIndexDataset + uid: azure.synapse.artifacts.models.AzureSearchIndexDataset + - name: AzureSearchLinkedService + uid: azure.synapse.artifacts.models.AzureSearchLinkedService + - name: AzureSqlDWLinkedService + uid: azure.synapse.artifacts.models.AzureSqlDWLinkedService + - name: AzureSqlDWTableDataset + uid: azure.synapse.artifacts.models.AzureSqlDWTableDataset + - name: AzureSqlDatabaseLinkedService + uid: azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService + - name: AzureSqlMILinkedService + uid: azure.synapse.artifacts.models.AzureSqlMILinkedService + - name: AzureSqlMITableDataset + uid: azure.synapse.artifacts.models.AzureSqlMITableDataset + - name: AzureSqlTableDataset + uid: azure.synapse.artifacts.models.AzureSqlTableDataset + - name: AzureStorageLinkedService + uid: azure.synapse.artifacts.models.AzureStorageLinkedService + - name: AzureTableDataset + uid: azure.synapse.artifacts.models.AzureTableDataset + - name: AzureTableStorageLinkedService + uid: azure.synapse.artifacts.models.AzureTableStorageLinkedService + - name: BigDataPoolReference + uid: azure.synapse.artifacts.models.BigDataPoolReference + - name: BinaryDataset + uid: azure.synapse.artifacts.models.BinaryDataset + - name: CassandraLinkedService + uid: azure.synapse.artifacts.models.CassandraLinkedService + - name: CassandraTableDataset + uid: azure.synapse.artifacts.models.CassandraTableDataset + - name: CellOutputType + uid: azure.synapse.artifacts.models.CellOutputType + - name: CloudError + uid: azure.synapse.artifacts.models.CloudError + - name: CommonDataServiceForAppsEntityDataset + uid: azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset + - name: CommonDataServiceForAppsLinkedService + uid: azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService + - name: ConcurLinkedService + uid: azure.synapse.artifacts.models.ConcurLinkedService + - name: ConcurObjectDataset + uid: azure.synapse.artifacts.models.ConcurObjectDataset + - name: ControlActivity + uid: azure.synapse.artifacts.models.ControlActivity + - name: CopyActivity + uid: azure.synapse.artifacts.models.CopyActivity + - name: CopySink + uid: azure.synapse.artifacts.models.CopySink + - name: CopySource + uid: azure.synapse.artifacts.models.CopySource + - name: CosmosDbLinkedService + uid: azure.synapse.artifacts.models.CosmosDbLinkedService + - name: CosmosDbMongoDbApiCollectionDataset + uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset + - name: CosmosDbMongoDbApiLinkedService + uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService + - name: CosmosDbSqlApiCollectionDataset + uid: azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset + - name: CouchbaseLinkedService + uid: azure.synapse.artifacts.models.CouchbaseLinkedService + - name: CouchbaseTableDataset + uid: azure.synapse.artifacts.models.CouchbaseTableDataset + - name: CreateDataFlowDebugSessionRequest + uid: azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest + - name: CreateDataFlowDebugSessionResponse + uid: azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse + - name: CreateRunResponse + uid: azure.synapse.artifacts.models.CreateRunResponse + - name: CustomActivity + uid: azure.synapse.artifacts.models.CustomActivity + - name: CustomActivityReferenceObject + uid: azure.synapse.artifacts.models.CustomActivityReferenceObject + - name: CustomDataSourceLinkedService + uid: azure.synapse.artifacts.models.CustomDataSourceLinkedService + - name: DataFlow + uid: azure.synapse.artifacts.models.DataFlow + - name: DataFlowComputeType + uid: azure.synapse.artifacts.models.DataFlowComputeType + - name: DataFlowDebugCommandRequest + uid: azure.synapse.artifacts.models.DataFlowDebugCommandRequest + - name: DataFlowDebugCommandResponse + uid: azure.synapse.artifacts.models.DataFlowDebugCommandResponse + - name: DataFlowDebugPackage + uid: azure.synapse.artifacts.models.DataFlowDebugPackage + - name: DataFlowDebugPackageDebugSettings + uid: azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings + - name: DataFlowDebugPreviewDataRequest + uid: azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest + - name: DataFlowDebugQueryResponse + uid: azure.synapse.artifacts.models.DataFlowDebugQueryResponse + - name: DataFlowDebugResource + uid: azure.synapse.artifacts.models.DataFlowDebugResource + - name: DataFlowDebugResultResponse + uid: azure.synapse.artifacts.models.DataFlowDebugResultResponse + - name: DataFlowDebugSessionInfo + uid: azure.synapse.artifacts.models.DataFlowDebugSessionInfo + - name: DataFlowDebugStatisticsRequest + uid: azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest + - name: DataFlowFolder + uid: azure.synapse.artifacts.models.DataFlowFolder + - name: DataFlowListResponse + uid: azure.synapse.artifacts.models.DataFlowListResponse + - name: DataFlowReference + uid: azure.synapse.artifacts.models.DataFlowReference + - name: DataFlowResource + uid: azure.synapse.artifacts.models.DataFlowResource + - name: DataFlowSink + uid: azure.synapse.artifacts.models.DataFlowSink + - name: DataFlowSource + uid: azure.synapse.artifacts.models.DataFlowSource + - name: DataFlowSourceSetting + uid: azure.synapse.artifacts.models.DataFlowSourceSetting + - name: DataFlowStagingInfo + uid: azure.synapse.artifacts.models.DataFlowStagingInfo + - name: DataLakeAnalyticsUSQLActivity + uid: azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity + - name: DatabricksNotebookActivity + uid: azure.synapse.artifacts.models.DatabricksNotebookActivity + - name: DatabricksSparkJarActivity + uid: azure.synapse.artifacts.models.DatabricksSparkJarActivity + - name: DatabricksSparkPythonActivity + uid: azure.synapse.artifacts.models.DatabricksSparkPythonActivity + - name: Dataset + uid: azure.synapse.artifacts.models.Dataset + - name: DatasetBZip2Compression + uid: azure.synapse.artifacts.models.DatasetBZip2Compression + - name: DatasetCompression + uid: azure.synapse.artifacts.models.DatasetCompression + - name: DatasetCompressionLevel + uid: azure.synapse.artifacts.models.DatasetCompressionLevel + - name: DatasetDebugResource + uid: azure.synapse.artifacts.models.DatasetDebugResource + - name: DatasetDeflateCompression + uid: azure.synapse.artifacts.models.DatasetDeflateCompression + - name: DatasetFolder + uid: azure.synapse.artifacts.models.DatasetFolder + - name: DatasetGZipCompression + uid: azure.synapse.artifacts.models.DatasetGZipCompression + - name: DatasetListResponse + uid: azure.synapse.artifacts.models.DatasetListResponse + - name: DatasetLocation + uid: azure.synapse.artifacts.models.DatasetLocation + - name: DatasetReference + uid: azure.synapse.artifacts.models.DatasetReference + - name: DatasetResource + uid: azure.synapse.artifacts.models.DatasetResource + - name: DatasetZipDeflateCompression + uid: azure.synapse.artifacts.models.DatasetZipDeflateCompression + - name: Db2LinkedService + uid: azure.synapse.artifacts.models.Db2LinkedService + - name: Db2TableDataset + uid: azure.synapse.artifacts.models.Db2TableDataset + - name: DeleteActivity + uid: azure.synapse.artifacts.models.DeleteActivity + - name: DeleteDataFlowDebugSessionRequest + uid: azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest + - name: DelimitedTextCompressionCodec + uid: azure.synapse.artifacts.models.DelimitedTextCompressionCodec + - name: DelimitedTextDataset + uid: azure.synapse.artifacts.models.DelimitedTextDataset + - name: DependencyCondition + uid: azure.synapse.artifacts.models.DependencyCondition + - name: DocumentDbCollectionDataset + uid: azure.synapse.artifacts.models.DocumentDbCollectionDataset + - name: DrillLinkedService + uid: azure.synapse.artifacts.models.DrillLinkedService + - name: DrillTableDataset + uid: azure.synapse.artifacts.models.DrillTableDataset + - name: DynamicsAXLinkedService + uid: azure.synapse.artifacts.models.DynamicsAXLinkedService + - name: DynamicsAXResourceDataset + uid: azure.synapse.artifacts.models.DynamicsAXResourceDataset + - name: DynamicsAuthenticationType + uid: azure.synapse.artifacts.models.DynamicsAuthenticationType + - name: DynamicsCrmEntityDataset + uid: azure.synapse.artifacts.models.DynamicsCrmEntityDataset + - name: DynamicsCrmLinkedService + uid: azure.synapse.artifacts.models.DynamicsCrmLinkedService + - name: DynamicsDeploymentType + uid: azure.synapse.artifacts.models.DynamicsDeploymentType + - name: DynamicsEntityDataset + uid: azure.synapse.artifacts.models.DynamicsEntityDataset + - name: DynamicsLinkedService + uid: azure.synapse.artifacts.models.DynamicsLinkedService + - name: DynamicsServicePrincipalCredentialType + uid: azure.synapse.artifacts.models.DynamicsServicePrincipalCredentialType + - name: EloquaLinkedService + uid: azure.synapse.artifacts.models.EloquaLinkedService + - name: EloquaObjectDataset + uid: azure.synapse.artifacts.models.EloquaObjectDataset + - name: EvaluateDataFlowExpressionRequest + uid: azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest + - name: EventSubscriptionStatus + uid: azure.synapse.artifacts.models.EventSubscriptionStatus + - name: ExecuteDataFlowActivity + uid: azure.synapse.artifacts.models.ExecuteDataFlowActivity + - name: ExecuteDataFlowActivityTypePropertiesCompute + uid: azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute + - name: ExecutePipelineActivity + uid: azure.synapse.artifacts.models.ExecutePipelineActivity + - name: ExecuteSSISPackageActivity + uid: azure.synapse.artifacts.models.ExecuteSSISPackageActivity + - name: ExecutionActivity + uid: azure.synapse.artifacts.models.ExecutionActivity + - name: ExposureControlRequest + uid: azure.synapse.artifacts.models.ExposureControlRequest + - name: ExposureControlResponse + uid: azure.synapse.artifacts.models.ExposureControlResponse + - name: Expression + uid: azure.synapse.artifacts.models.Expression + - name: FileServerLinkedService + uid: azure.synapse.artifacts.models.FileServerLinkedService + - name: FilterActivity + uid: azure.synapse.artifacts.models.FilterActivity + - name: ForEachActivity + uid: azure.synapse.artifacts.models.ForEachActivity + - name: FtpAuthenticationType + uid: azure.synapse.artifacts.models.FtpAuthenticationType + - name: FtpServerLinkedService + uid: azure.synapse.artifacts.models.FtpServerLinkedService + - name: GetMetadataActivity + uid: azure.synapse.artifacts.models.GetMetadataActivity + - name: GetSsisObjectMetadataRequest + uid: azure.synapse.artifacts.models.GetSsisObjectMetadataRequest + - name: GoogleAdWordsAuthenticationType + uid: azure.synapse.artifacts.models.GoogleAdWordsAuthenticationType + - name: GoogleAdWordsLinkedService + uid: azure.synapse.artifacts.models.GoogleAdWordsLinkedService + - name: GoogleAdWordsObjectDataset + uid: azure.synapse.artifacts.models.GoogleAdWordsObjectDataset + - name: GoogleBigQueryAuthenticationType + uid: azure.synapse.artifacts.models.GoogleBigQueryAuthenticationType + - name: GoogleBigQueryLinkedService + uid: azure.synapse.artifacts.models.GoogleBigQueryLinkedService + - name: GoogleBigQueryObjectDataset + uid: azure.synapse.artifacts.models.GoogleBigQueryObjectDataset + - name: GoogleCloudStorageLinkedService + uid: azure.synapse.artifacts.models.GoogleCloudStorageLinkedService + - name: GreenplumLinkedService + uid: azure.synapse.artifacts.models.GreenplumLinkedService + - name: GreenplumTableDataset + uid: azure.synapse.artifacts.models.GreenplumTableDataset + - name: HBaseAuthenticationType + uid: azure.synapse.artifacts.models.HBaseAuthenticationType + - name: HBaseLinkedService + uid: azure.synapse.artifacts.models.HBaseLinkedService + - name: HBaseObjectDataset + uid: azure.synapse.artifacts.models.HBaseObjectDataset + - name: HDInsightActivityDebugInfoOption + uid: azure.synapse.artifacts.models.HDInsightActivityDebugInfoOption + - name: HDInsightHiveActivity + uid: azure.synapse.artifacts.models.HDInsightHiveActivity + - name: HDInsightLinkedService + uid: azure.synapse.artifacts.models.HDInsightLinkedService + - name: HDInsightMapReduceActivity + uid: azure.synapse.artifacts.models.HDInsightMapReduceActivity + - name: HDInsightOnDemandLinkedService + uid: azure.synapse.artifacts.models.HDInsightOnDemandLinkedService + - name: HDInsightPigActivity + uid: azure.synapse.artifacts.models.HDInsightPigActivity + - name: HDInsightSparkActivity + uid: azure.synapse.artifacts.models.HDInsightSparkActivity + - name: HDInsightStreamingActivity + uid: azure.synapse.artifacts.models.HDInsightStreamingActivity + - name: HdfsLinkedService + uid: azure.synapse.artifacts.models.HdfsLinkedService + - name: HdiNodeTypes + uid: azure.synapse.artifacts.models.HdiNodeTypes + - name: HiveAuthenticationType + uid: azure.synapse.artifacts.models.HiveAuthenticationType + - name: HiveLinkedService + uid: azure.synapse.artifacts.models.HiveLinkedService + - name: HiveObjectDataset + uid: azure.synapse.artifacts.models.HiveObjectDataset + - name: HiveServerType + uid: azure.synapse.artifacts.models.HiveServerType + - name: HiveThriftTransportProtocol + uid: azure.synapse.artifacts.models.HiveThriftTransportProtocol + - name: HttpAuthenticationType + uid: azure.synapse.artifacts.models.HttpAuthenticationType + - name: HttpLinkedService + uid: azure.synapse.artifacts.models.HttpLinkedService + - name: HubspotLinkedService + uid: azure.synapse.artifacts.models.HubspotLinkedService + - name: HubspotObjectDataset + uid: azure.synapse.artifacts.models.HubspotObjectDataset + - name: IfConditionActivity + uid: azure.synapse.artifacts.models.IfConditionActivity + - name: ImpalaAuthenticationType + uid: azure.synapse.artifacts.models.ImpalaAuthenticationType + - name: ImpalaLinkedService + uid: azure.synapse.artifacts.models.ImpalaLinkedService + - name: ImpalaObjectDataset + uid: azure.synapse.artifacts.models.ImpalaObjectDataset + - name: InformixLinkedService + uid: azure.synapse.artifacts.models.InformixLinkedService + - name: InformixTableDataset + uid: azure.synapse.artifacts.models.InformixTableDataset + - name: IntegrationRuntimeReference + uid: azure.synapse.artifacts.models.IntegrationRuntimeReference + - name: JiraLinkedService + uid: azure.synapse.artifacts.models.JiraLinkedService + - name: JiraObjectDataset + uid: azure.synapse.artifacts.models.JiraObjectDataset + - name: JsonDataset + uid: azure.synapse.artifacts.models.JsonDataset + - name: LinkedService + uid: azure.synapse.artifacts.models.LinkedService + - name: LinkedServiceDebugResource + uid: azure.synapse.artifacts.models.LinkedServiceDebugResource + - name: LinkedServiceListResponse + uid: azure.synapse.artifacts.models.LinkedServiceListResponse + - name: LinkedServiceReference + uid: azure.synapse.artifacts.models.LinkedServiceReference + - name: LinkedServiceResource + uid: azure.synapse.artifacts.models.LinkedServiceResource + - name: LogStorageSettings + uid: azure.synapse.artifacts.models.LogStorageSettings + - name: LookupActivity + uid: azure.synapse.artifacts.models.LookupActivity + - name: MagentoLinkedService + uid: azure.synapse.artifacts.models.MagentoLinkedService + - name: MagentoObjectDataset + uid: azure.synapse.artifacts.models.MagentoObjectDataset + - name: MappingDataFlow + uid: azure.synapse.artifacts.models.MappingDataFlow + - name: MariaDBLinkedService + uid: azure.synapse.artifacts.models.MariaDBLinkedService + - name: MariaDBTableDataset + uid: azure.synapse.artifacts.models.MariaDBTableDataset + - name: MarketoLinkedService + uid: azure.synapse.artifacts.models.MarketoLinkedService + - name: MarketoObjectDataset + uid: azure.synapse.artifacts.models.MarketoObjectDataset + - name: MicrosoftAccessLinkedService + uid: azure.synapse.artifacts.models.MicrosoftAccessLinkedService + - name: MicrosoftAccessTableDataset + uid: azure.synapse.artifacts.models.MicrosoftAccessTableDataset + - name: MongoDbAuthenticationType + uid: azure.synapse.artifacts.models.MongoDbAuthenticationType + - name: MongoDbCollectionDataset + uid: azure.synapse.artifacts.models.MongoDbCollectionDataset + - name: MongoDbLinkedService + uid: azure.synapse.artifacts.models.MongoDbLinkedService + - name: MongoDbV2CollectionDataset + uid: azure.synapse.artifacts.models.MongoDbV2CollectionDataset + - name: MongoDbV2LinkedService + uid: azure.synapse.artifacts.models.MongoDbV2LinkedService + - name: MultiplePipelineTrigger + uid: azure.synapse.artifacts.models.MultiplePipelineTrigger + - name: MySqlLinkedService + uid: azure.synapse.artifacts.models.MySqlLinkedService + - name: MySqlTableDataset + uid: azure.synapse.artifacts.models.MySqlTableDataset + - name: NetezzaLinkedService + uid: azure.synapse.artifacts.models.NetezzaLinkedService + - name: NetezzaTableDataset + uid: azure.synapse.artifacts.models.NetezzaTableDataset + - name: Notebook + uid: azure.synapse.artifacts.models.Notebook + - name: NotebookCell + uid: azure.synapse.artifacts.models.NotebookCell + - name: NotebookCellOutputItem + uid: azure.synapse.artifacts.models.NotebookCellOutputItem + - name: NotebookKernelSpec + uid: azure.synapse.artifacts.models.NotebookKernelSpec + - name: NotebookLanguageInfo + uid: azure.synapse.artifacts.models.NotebookLanguageInfo + - name: NotebookListResponse + uid: azure.synapse.artifacts.models.NotebookListResponse + - name: NotebookMetadata + uid: azure.synapse.artifacts.models.NotebookMetadata + - name: NotebookResource + uid: azure.synapse.artifacts.models.NotebookResource + - name: NotebookSessionProperties + uid: azure.synapse.artifacts.models.NotebookSessionProperties + - name: ODataAadServicePrincipalCredentialType + uid: azure.synapse.artifacts.models.ODataAadServicePrincipalCredentialType + - name: ODataAuthenticationType + uid: azure.synapse.artifacts.models.ODataAuthenticationType + - name: ODataLinkedService + uid: azure.synapse.artifacts.models.ODataLinkedService + - name: ODataResourceDataset + uid: azure.synapse.artifacts.models.ODataResourceDataset + - name: OdbcLinkedService + uid: azure.synapse.artifacts.models.OdbcLinkedService + - name: OdbcTableDataset + uid: azure.synapse.artifacts.models.OdbcTableDataset + - name: Office365Dataset + uid: azure.synapse.artifacts.models.Office365Dataset + - name: Office365LinkedService + uid: azure.synapse.artifacts.models.Office365LinkedService + - name: OracleLinkedService + uid: azure.synapse.artifacts.models.OracleLinkedService + - name: OracleServiceCloudLinkedService + uid: azure.synapse.artifacts.models.OracleServiceCloudLinkedService + - name: OracleServiceCloudObjectDataset + uid: azure.synapse.artifacts.models.OracleServiceCloudObjectDataset + - name: OracleTableDataset + uid: azure.synapse.artifacts.models.OracleTableDataset + - name: OrcCompressionCodec + uid: azure.synapse.artifacts.models.OrcCompressionCodec + - name: OrcDataset + uid: azure.synapse.artifacts.models.OrcDataset + - name: ParameterSpecification + uid: azure.synapse.artifacts.models.ParameterSpecification + - name: ParameterType + uid: azure.synapse.artifacts.models.ParameterType + - name: ParquetCompressionCodec + uid: azure.synapse.artifacts.models.ParquetCompressionCodec + - name: ParquetDataset + uid: azure.synapse.artifacts.models.ParquetDataset + - name: PaypalLinkedService + uid: azure.synapse.artifacts.models.PaypalLinkedService + - name: PaypalObjectDataset + uid: azure.synapse.artifacts.models.PaypalObjectDataset + - name: PhoenixAuthenticationType + uid: azure.synapse.artifacts.models.PhoenixAuthenticationType + - name: PhoenixLinkedService + uid: azure.synapse.artifacts.models.PhoenixLinkedService + - name: PhoenixObjectDataset + uid: azure.synapse.artifacts.models.PhoenixObjectDataset + - name: PipelineFolder + uid: azure.synapse.artifacts.models.PipelineFolder + - name: PipelineListResponse + uid: azure.synapse.artifacts.models.PipelineListResponse + - name: PipelineReference + uid: azure.synapse.artifacts.models.PipelineReference + - name: PipelineResource + uid: azure.synapse.artifacts.models.PipelineResource + - name: PipelineRun + uid: azure.synapse.artifacts.models.PipelineRun + - name: PipelineRunInvokedBy + uid: azure.synapse.artifacts.models.PipelineRunInvokedBy + - name: PipelineRunsQueryResponse + uid: azure.synapse.artifacts.models.PipelineRunsQueryResponse + - name: PluginCurrentState + uid: azure.synapse.artifacts.models.PluginCurrentState + - name: PostgreSqlLinkedService + uid: azure.synapse.artifacts.models.PostgreSqlLinkedService + - name: PostgreSqlTableDataset + uid: azure.synapse.artifacts.models.PostgreSqlTableDataset + - name: PrestoAuthenticationType + uid: azure.synapse.artifacts.models.PrestoAuthenticationType + - name: PrestoLinkedService + uid: azure.synapse.artifacts.models.PrestoLinkedService + - name: PrestoObjectDataset + uid: azure.synapse.artifacts.models.PrestoObjectDataset + - name: QueryDataFlowDebugSessionsResponse + uid: azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse + - name: QuickBooksLinkedService + uid: azure.synapse.artifacts.models.QuickBooksLinkedService + - name: QuickBooksObjectDataset + uid: azure.synapse.artifacts.models.QuickBooksObjectDataset + - name: RedirectIncompatibleRowSettings + uid: azure.synapse.artifacts.models.RedirectIncompatibleRowSettings + - name: RelationalTableDataset + uid: azure.synapse.artifacts.models.RelationalTableDataset + - name: RerunTriggerListResponse + uid: azure.synapse.artifacts.models.RerunTriggerListResponse + - name: RerunTriggerResource + uid: azure.synapse.artifacts.models.RerunTriggerResource + - name: RerunTumblingWindowTrigger + uid: azure.synapse.artifacts.models.RerunTumblingWindowTrigger + - name: RerunTumblingWindowTriggerActionParameters + uid: azure.synapse.artifacts.models.RerunTumblingWindowTriggerActionParameters + - name: Resource + uid: azure.synapse.artifacts.models.Resource + - name: ResponsysLinkedService + uid: azure.synapse.artifacts.models.ResponsysLinkedService + - name: ResponsysObjectDataset + uid: azure.synapse.artifacts.models.ResponsysObjectDataset + - name: RestResourceDataset + uid: azure.synapse.artifacts.models.RestResourceDataset + - name: RestServiceAuthenticationType + uid: azure.synapse.artifacts.models.RestServiceAuthenticationType + - name: RestServiceLinkedService + uid: azure.synapse.artifacts.models.RestServiceLinkedService + - name: RunFilterParameters + uid: azure.synapse.artifacts.models.RunFilterParameters + - name: RunQueryFilter + uid: azure.synapse.artifacts.models.RunQueryFilter + - name: RunQueryFilterOperand + uid: azure.synapse.artifacts.models.RunQueryFilterOperand + - name: RunQueryFilterOperator + uid: azure.synapse.artifacts.models.RunQueryFilterOperator + - name: RunQueryOrder + uid: azure.synapse.artifacts.models.RunQueryOrder + - name: RunQueryOrderBy + uid: azure.synapse.artifacts.models.RunQueryOrderBy + - name: RunQueryOrderByField + uid: azure.synapse.artifacts.models.RunQueryOrderByField + - name: SSISAccessCredential + uid: azure.synapse.artifacts.models.SSISAccessCredential + - name: SSISChildPackage + uid: azure.synapse.artifacts.models.SSISChildPackage + - name: SSISExecutionCredential + uid: azure.synapse.artifacts.models.SSISExecutionCredential + - name: SSISExecutionParameter + uid: azure.synapse.artifacts.models.SSISExecutionParameter + - name: SSISLogLocation + uid: azure.synapse.artifacts.models.SSISLogLocation + - name: SSISPackageLocation + uid: azure.synapse.artifacts.models.SSISPackageLocation + - name: SSISPropertyOverride + uid: azure.synapse.artifacts.models.SSISPropertyOverride + - name: SalesforceLinkedService + uid: azure.synapse.artifacts.models.SalesforceLinkedService + - name: SalesforceMarketingCloudLinkedService + uid: azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService + - name: SalesforceMarketingCloudObjectDataset + uid: azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset + - name: SalesforceObjectDataset + uid: azure.synapse.artifacts.models.SalesforceObjectDataset + - name: SalesforceServiceCloudLinkedService + uid: azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService + - name: SalesforceServiceCloudObjectDataset + uid: azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset + - name: SapBWLinkedService + uid: azure.synapse.artifacts.models.SapBWLinkedService + - name: SapBwCubeDataset + uid: azure.synapse.artifacts.models.SapBwCubeDataset + - name: SapCloudForCustomerLinkedService + uid: azure.synapse.artifacts.models.SapCloudForCustomerLinkedService + - name: SapCloudForCustomerResourceDataset + uid: azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset + - name: SapEccLinkedService + uid: azure.synapse.artifacts.models.SapEccLinkedService + - name: SapEccResourceDataset + uid: azure.synapse.artifacts.models.SapEccResourceDataset + - name: SapHanaAuthenticationType + uid: azure.synapse.artifacts.models.SapHanaAuthenticationType + - name: SapHanaLinkedService + uid: azure.synapse.artifacts.models.SapHanaLinkedService + - name: SapHanaTableDataset + uid: azure.synapse.artifacts.models.SapHanaTableDataset + - name: SapOpenHubLinkedService + uid: azure.synapse.artifacts.models.SapOpenHubLinkedService + - name: SapOpenHubTableDataset + uid: azure.synapse.artifacts.models.SapOpenHubTableDataset + - name: SapTableLinkedService + uid: azure.synapse.artifacts.models.SapTableLinkedService + - name: SapTableResourceDataset + uid: azure.synapse.artifacts.models.SapTableResourceDataset + - name: SchedulerCurrentState + uid: azure.synapse.artifacts.models.SchedulerCurrentState + - name: ScriptAction + uid: azure.synapse.artifacts.models.ScriptAction + - name: SecretBase + uid: azure.synapse.artifacts.models.SecretBase + - name: SecureString + uid: azure.synapse.artifacts.models.SecureString + - name: ServiceNowAuthenticationType + uid: azure.synapse.artifacts.models.ServiceNowAuthenticationType + - name: ServiceNowLinkedService + uid: azure.synapse.artifacts.models.ServiceNowLinkedService + - name: ServiceNowObjectDataset + uid: azure.synapse.artifacts.models.ServiceNowObjectDataset + - name: SetVariableActivity + uid: azure.synapse.artifacts.models.SetVariableActivity + - name: SftpAuthenticationType + uid: azure.synapse.artifacts.models.SftpAuthenticationType + - name: SftpServerLinkedService + uid: azure.synapse.artifacts.models.SftpServerLinkedService + - name: ShopifyLinkedService + uid: azure.synapse.artifacts.models.ShopifyLinkedService + - name: ShopifyObjectDataset + uid: azure.synapse.artifacts.models.ShopifyObjectDataset + - name: SparkAuthenticationType + uid: azure.synapse.artifacts.models.SparkAuthenticationType + - name: SparkBatchJob + uid: azure.synapse.artifacts.models.SparkBatchJob + - name: SparkBatchJobResultType + uid: azure.synapse.artifacts.models.SparkBatchJobResultType + - name: SparkBatchJobState + uid: azure.synapse.artifacts.models.SparkBatchJobState + - name: SparkErrorSource + uid: azure.synapse.artifacts.models.SparkErrorSource + - name: SparkJobDefinition + uid: azure.synapse.artifacts.models.SparkJobDefinition + - name: SparkJobDefinitionResource + uid: azure.synapse.artifacts.models.SparkJobDefinitionResource + - name: SparkJobDefinitionsListResponse + uid: azure.synapse.artifacts.models.SparkJobDefinitionsListResponse + - name: SparkJobProperties + uid: azure.synapse.artifacts.models.SparkJobProperties + - name: SparkJobType + uid: azure.synapse.artifacts.models.SparkJobType + - name: SparkLinkedService + uid: azure.synapse.artifacts.models.SparkLinkedService + - name: SparkObjectDataset + uid: azure.synapse.artifacts.models.SparkObjectDataset + - name: SparkRequest + uid: azure.synapse.artifacts.models.SparkRequest + - name: SparkScheduler + uid: azure.synapse.artifacts.models.SparkScheduler + - name: SparkServerType + uid: azure.synapse.artifacts.models.SparkServerType + - name: SparkServiceError + uid: azure.synapse.artifacts.models.SparkServiceError + - name: SparkServicePlugin + uid: azure.synapse.artifacts.models.SparkServicePlugin + - name: SparkThriftTransportProtocol + uid: azure.synapse.artifacts.models.SparkThriftTransportProtocol + - name: SqlConnection + uid: azure.synapse.artifacts.models.SqlConnection + - name: SqlConnectionType + uid: azure.synapse.artifacts.models.SqlConnectionType + - name: SqlScript + uid: azure.synapse.artifacts.models.SqlScript + - name: SqlScriptContent + uid: azure.synapse.artifacts.models.SqlScriptContent + - name: SqlScriptMetadata + uid: azure.synapse.artifacts.models.SqlScriptMetadata + - name: SqlScriptResource + uid: azure.synapse.artifacts.models.SqlScriptResource + - name: SqlScriptsListResponse + uid: azure.synapse.artifacts.models.SqlScriptsListResponse + - name: SqlServerLinkedService + uid: azure.synapse.artifacts.models.SqlServerLinkedService + - name: SqlServerStoredProcedureActivity + uid: azure.synapse.artifacts.models.SqlServerStoredProcedureActivity + - name: SqlServerTableDataset + uid: azure.synapse.artifacts.models.SqlServerTableDataset + - name: SquareLinkedService + uid: azure.synapse.artifacts.models.SquareLinkedService + - name: SquareObjectDataset + uid: azure.synapse.artifacts.models.SquareObjectDataset + - name: SsisObjectMetadataStatusResponse + uid: azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse + - name: SsisPackageLocationType + uid: azure.synapse.artifacts.models.SsisPackageLocationType + - name: StagingSettings + uid: azure.synapse.artifacts.models.StagingSettings + - name: StartDataFlowDebugSessionRequest + uid: azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest + - name: StartDataFlowDebugSessionResponse + uid: azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse + - name: StoredProcedureParameter + uid: azure.synapse.artifacts.models.StoredProcedureParameter + - name: StoredProcedureParameterType + uid: azure.synapse.artifacts.models.StoredProcedureParameterType + - name: SubResource + uid: azure.synapse.artifacts.models.SubResource + - name: SubResourceDebugResource + uid: azure.synapse.artifacts.models.SubResourceDebugResource + - name: SwitchActivity + uid: azure.synapse.artifacts.models.SwitchActivity + - name: SwitchCase + uid: azure.synapse.artifacts.models.SwitchCase + - name: SybaseAuthenticationType + uid: azure.synapse.artifacts.models.SybaseAuthenticationType + - name: SybaseLinkedService + uid: azure.synapse.artifacts.models.SybaseLinkedService + - name: SybaseTableDataset + uid: azure.synapse.artifacts.models.SybaseTableDataset + - name: TeradataAuthenticationType + uid: azure.synapse.artifacts.models.TeradataAuthenticationType + - name: TeradataLinkedService + uid: azure.synapse.artifacts.models.TeradataLinkedService + - name: TeradataTableDataset + uid: azure.synapse.artifacts.models.TeradataTableDataset + - name: Transformation + uid: azure.synapse.artifacts.models.Transformation + - name: Trigger + uid: azure.synapse.artifacts.models.Trigger + - name: TriggerDependencyProvisioningStatus + uid: azure.synapse.artifacts.models.TriggerDependencyProvisioningStatus + - name: TriggerListResponse + uid: azure.synapse.artifacts.models.TriggerListResponse + - name: TriggerPipelineReference + uid: azure.synapse.artifacts.models.TriggerPipelineReference + - name: TriggerResource + uid: azure.synapse.artifacts.models.TriggerResource + - name: TriggerRun + uid: azure.synapse.artifacts.models.TriggerRun + - name: TriggerRunStatus + uid: azure.synapse.artifacts.models.TriggerRunStatus + - name: TriggerRunsQueryResponse + uid: azure.synapse.artifacts.models.TriggerRunsQueryResponse + - name: TriggerRuntimeState + uid: azure.synapse.artifacts.models.TriggerRuntimeState + - name: TriggerSubscriptionOperationStatus + uid: azure.synapse.artifacts.models.TriggerSubscriptionOperationStatus + - name: UntilActivity + uid: azure.synapse.artifacts.models.UntilActivity + - name: UserProperty + uid: azure.synapse.artifacts.models.UserProperty + - name: ValidationActivity + uid: azure.synapse.artifacts.models.ValidationActivity + - name: VariableSpecification + uid: azure.synapse.artifacts.models.VariableSpecification + - name: VariableType + uid: azure.synapse.artifacts.models.VariableType + - name: VerticaLinkedService + uid: azure.synapse.artifacts.models.VerticaLinkedService + - name: VerticaTableDataset + uid: azure.synapse.artifacts.models.VerticaTableDataset + - name: WaitActivity + uid: azure.synapse.artifacts.models.WaitActivity + - name: WebActivity + uid: azure.synapse.artifacts.models.WebActivity + - name: WebActivityAuthentication + uid: azure.synapse.artifacts.models.WebActivityAuthentication + - name: WebActivityMethod + uid: azure.synapse.artifacts.models.WebActivityMethod + - name: WebAnonymousAuthentication + uid: azure.synapse.artifacts.models.WebAnonymousAuthentication + - name: WebAuthenticationType + uid: azure.synapse.artifacts.models.WebAuthenticationType + - name: WebBasicAuthentication + uid: azure.synapse.artifacts.models.WebBasicAuthentication + - name: WebClientCertificateAuthentication + uid: azure.synapse.artifacts.models.WebClientCertificateAuthentication + - name: WebHookActivity + uid: azure.synapse.artifacts.models.WebHookActivity + - name: WebLinkedService + uid: azure.synapse.artifacts.models.WebLinkedService + - name: WebLinkedServiceTypeProperties + uid: azure.synapse.artifacts.models.WebLinkedServiceTypeProperties + - name: WebTableDataset + uid: azure.synapse.artifacts.models.WebTableDataset + - name: Workspace + uid: azure.synapse.artifacts.models.Workspace + - name: WorkspaceIdentity + uid: azure.synapse.artifacts.models.WorkspaceIdentity + - name: WorkspaceUpdateParameters + uid: azure.synapse.artifacts.models.WorkspaceUpdateParameters + - name: XeroLinkedService + uid: azure.synapse.artifacts.models.XeroLinkedService + - name: XeroObjectDataset + uid: azure.synapse.artifacts.models.XeroObjectDataset + - name: ZohoLinkedService + uid: azure.synapse.artifacts.models.ZohoLinkedService + - name: ZohoObjectDataset + uid: azure.synapse.artifacts.models.ZohoObjectDataset + name: models + - items: + - name: Overview + uid: azure.synapse.artifacts.operations + - name: DataFlowDebugSessionOperations + uid: azure.synapse.artifacts.operations.DataFlowDebugSessionOperations + - name: DataFlowOperations + uid: azure.synapse.artifacts.operations.DataFlowOperations + - name: DatasetOperations + uid: azure.synapse.artifacts.operations.DatasetOperations + - name: LinkedServiceOperations + uid: azure.synapse.artifacts.operations.LinkedServiceOperations + - name: NotebookOperations + uid: azure.synapse.artifacts.operations.NotebookOperations + - name: PipelineOperations + uid: azure.synapse.artifacts.operations.PipelineOperations + - name: PipelineRunOperations + uid: azure.synapse.artifacts.operations.PipelineRunOperations + - name: SparkJobDefinitionOperations + uid: azure.synapse.artifacts.operations.SparkJobDefinitionOperations + - name: SqlScriptOperations + uid: azure.synapse.artifacts.operations.SqlScriptOperations + - name: TriggerOperations + uid: azure.synapse.artifacts.operations.TriggerOperations + - name: TriggerRunOperations + uid: azure.synapse.artifacts.operations.TriggerRunOperations + name: operations + - name: ArtifactsClient + uid: azure.synapse.artifacts.ArtifactsClient + name: artifacts + - items: + - name: Overview + uid: azure.synapse.models + - name: Config + uid: azure.synapse.models.Config + - name: Data + uid: azure.synapse.models.Data + - name: Edge + uid: azure.synapse.models.Edge + - name: ErrorDetail + uid: azure.synapse.models.ErrorDetail + - name: ErrorInformation + uid: azure.synapse.models.ErrorInformation + - name: ErrorResponse + uid: azure.synapse.models.ErrorResponse + - name: ErrorResponseException + uid: azure.synapse.models.ErrorResponseException + - name: ErrorSource + uid: azure.synapse.models.ErrorSource + - name: Executors + uid: azure.synapse.models.Executors + - name: ExtendedLivyBatchRequest + uid: azure.synapse.models.ExtendedLivyBatchRequest + - name: ExtendedLivyBatchResponse + uid: azure.synapse.models.ExtendedLivyBatchResponse + - name: ExtendedLivyListBatchResponse + uid: azure.synapse.models.ExtendedLivyListBatchResponse + - name: ExtendedLivyListSessionResponse + uid: azure.synapse.models.ExtendedLivyListSessionResponse + - name: ExtendedLivySessionRequest + uid: azure.synapse.models.ExtendedLivySessionRequest + - name: ExtendedLivySessionResponse + uid: azure.synapse.models.ExtendedLivySessionResponse + - name: GetAccessControlInfoRequest + uid: azure.synapse.models.GetAccessControlInfoRequest + - name: HistoryServerDataResponse + uid: azure.synapse.models.HistoryServerDataResponse + - name: HistoryServerDiagnosticResponse + uid: azure.synapse.models.HistoryServerDiagnosticResponse + - name: HistoryServerDiagnosticResponseData + uid: azure.synapse.models.HistoryServerDiagnosticResponseData + - name: HistoryServerGraphResponse + uid: azure.synapse.models.HistoryServerGraphResponse + - name: HistoryServerGraphResponseData + uid: azure.synapse.models.HistoryServerGraphResponseData + - name: HistoryServerPropertiesResponse + uid: azure.synapse.models.HistoryServerPropertiesResponse + - name: JobResult + uid: azure.synapse.models.JobResult + - name: JobType + uid: azure.synapse.models.JobType + - name: Jobs + uid: azure.synapse.models.Jobs + - name: LivyBatchStateInformation + uid: azure.synapse.models.LivyBatchStateInformation + - name: LivyRequestBase + uid: azure.synapse.models.LivyRequestBase + - name: LivySessionStateInformation + uid: azure.synapse.models.LivySessionStateInformation + - name: LivyStatementCancellationResponse + uid: azure.synapse.models.LivyStatementCancellationResponse + - name: LivyStatementOutput + uid: azure.synapse.models.LivyStatementOutput + - name: LivyStatementRequestBody + uid: azure.synapse.models.LivyStatementRequestBody + - name: LivyStatementResponseBody + uid: azure.synapse.models.LivyStatementResponseBody + - name: LivyStatementsResponseBody + uid: azure.synapse.models.LivyStatementsResponseBody + - name: Option + uid: azure.synapse.models.Option + - name: PluginCurrentState + uid: azure.synapse.models.PluginCurrentState + - name: SchedulerCurrentState + uid: azure.synapse.models.SchedulerCurrentState + - name: SchedulerInformation + uid: azure.synapse.models.SchedulerInformation + - name: SetWorkspaceAdministratorsRequest + uid: azure.synapse.models.SetWorkspaceAdministratorsRequest + - name: SparkJob + uid: azure.synapse.models.SparkJob + - name: SparkJobListViewResponse + uid: azure.synapse.models.SparkJobListViewResponse + - name: SparkServicePluginInformation + uid: azure.synapse.models.SparkServicePluginInformation + - name: Stages + uid: azure.synapse.models.Stages + - name: Tables + uid: azure.synapse.models.Tables + - name: WorkspaceAccessControlResponse + uid: azure.synapse.models.WorkspaceAccessControlResponse + name: models + - items: + - name: Overview + uid: azure.synapse.operations + - name: MonitoringOperations + uid: azure.synapse.operations.MonitoringOperations + - name: SparkBatchOperations + uid: azure.synapse.operations.SparkBatchOperations + - name: SparkSessionOperations + uid: azure.synapse.operations.SparkSessionOperations + - name: WorkspaceAclOperations + uid: azure.synapse.operations.WorkspaceAclOperations + name: operations + - items: + - name: Overview + uid: azure.synapse.spark + - items: + - name: Overview + uid: azure.synapse.spark.aio + - items: + - name: Overview + uid: azure.synapse.spark.aio.operations_async + - name: SparkBatchOperations + uid: azure.synapse.spark.aio.operations_async.SparkBatchOperations + - name: SparkSessionOperations + uid: azure.synapse.spark.aio.operations_async.SparkSessionOperations + name: operations_async + - name: SparkClient + uid: azure.synapse.spark.aio.SparkClient + name: aio + - items: + - name: Overview + uid: azure.synapse.spark.models + - name: PluginCurrentState + uid: azure.synapse.spark.models.PluginCurrentState + - name: SchedulerCurrentState + uid: azure.synapse.spark.models.SchedulerCurrentState + - name: SparkBatchJob + uid: azure.synapse.spark.models.SparkBatchJob + - name: SparkBatchJobCollection + uid: azure.synapse.spark.models.SparkBatchJobCollection + - name: SparkBatchJobOptions + uid: azure.synapse.spark.models.SparkBatchJobOptions + - name: SparkBatchJobResultType + uid: azure.synapse.spark.models.SparkBatchJobResultType + - name: SparkBatchJobState + uid: azure.synapse.spark.models.SparkBatchJobState + - name: SparkErrorSource + uid: azure.synapse.spark.models.SparkErrorSource + - name: SparkJobType + uid: azure.synapse.spark.models.SparkJobType + - name: SparkRequest + uid: azure.synapse.spark.models.SparkRequest + - name: SparkScheduler + uid: azure.synapse.spark.models.SparkScheduler + - name: SparkServiceError + uid: azure.synapse.spark.models.SparkServiceError + - name: SparkServicePlugin + uid: azure.synapse.spark.models.SparkServicePlugin + - name: SparkSession + uid: azure.synapse.spark.models.SparkSession + - name: SparkSessionCollection + uid: azure.synapse.spark.models.SparkSessionCollection + - name: SparkSessionOptions + uid: azure.synapse.spark.models.SparkSessionOptions + - name: SparkSessionResultType + uid: azure.synapse.spark.models.SparkSessionResultType + - name: SparkSessionState + uid: azure.synapse.spark.models.SparkSessionState + - name: SparkStatement + uid: azure.synapse.spark.models.SparkStatement + - name: SparkStatementCancellationResult + uid: azure.synapse.spark.models.SparkStatementCancellationResult + - name: SparkStatementCollection + uid: azure.synapse.spark.models.SparkStatementCollection + - name: SparkStatementLanguageType + uid: azure.synapse.spark.models.SparkStatementLanguageType + - name: SparkStatementOptions + uid: azure.synapse.spark.models.SparkStatementOptions + - name: SparkStatementOutput + uid: azure.synapse.spark.models.SparkStatementOutput + name: models + - items: + - name: Overview + uid: azure.synapse.spark.operations + - name: SparkBatchOperations + uid: azure.synapse.spark.operations.SparkBatchOperations + - name: SparkSessionOperations + uid: azure.synapse.spark.operations.SparkSessionOperations + name: operations + - name: SparkClient + uid: azure.synapse.spark.SparkClient + name: spark + - name: SynapseClient + uid: azure.synapse.SynapseClient + name: azure.synapse diff --git a/xrefmap.yml b/xrefmap.yml index e69de29b..b00f99bb 100644 --- a/xrefmap.yml +++ b/xrefmap.yml @@ -0,0 +1,39097 @@ +references: +- fullName: ArithmeticError + href: https://docs.python.org/3/library/exceptions.html#ArithmeticError + name: ArithmeticError + uid: ArithmeticError +- fullName: AssertionError + href: https://docs.python.org/3/library/exceptions.html#AssertionError + name: AssertionError + uid: AssertionError +- fullName: AttributeError + href: https://docs.python.org/3/library/exceptions.html#AttributeError + name: AttributeError + uid: AttributeError +- fullName: BaseException + href: https://docs.python.org/3/library/exceptions.html#BaseException + name: BaseException + uid: BaseException +- fullName: BaseExceptionGroup + href: https://docs.python.org/3/library/exceptions.html#BaseExceptionGroup + name: BaseExceptionGroup + uid: BaseExceptionGroup +- fullName: BlockingIOError + href: https://docs.python.org/3/library/exceptions.html#BlockingIOError + name: BlockingIOError + uid: BlockingIOError +- fullName: BrokenPipeError + href: https://docs.python.org/3/library/exceptions.html#BrokenPipeError + name: BrokenPipeError + uid: BrokenPipeError +- fullName: BufferError + href: https://docs.python.org/3/library/exceptions.html#BufferError + name: BufferError + uid: BufferError +- fullName: BytesWarning + href: https://docs.python.org/3/library/exceptions.html#BytesWarning + name: BytesWarning + uid: BytesWarning +- fullName: ChildProcessError + href: https://docs.python.org/3/library/exceptions.html#ChildProcessError + name: ChildProcessError + uid: ChildProcessError +- fullName: ConnectionAbortedError + href: https://docs.python.org/3/library/exceptions.html#ConnectionAbortedError + name: ConnectionAbortedError + uid: ConnectionAbortedError +- fullName: ConnectionError + href: https://docs.python.org/3/library/exceptions.html#ConnectionError + name: ConnectionError + uid: ConnectionError +- fullName: ConnectionRefusedError + href: https://docs.python.org/3/library/exceptions.html#ConnectionRefusedError + name: ConnectionRefusedError + uid: ConnectionRefusedError +- fullName: ConnectionResetError + href: https://docs.python.org/3/library/exceptions.html#ConnectionResetError + name: ConnectionResetError + uid: ConnectionResetError +- fullName: DeprecationWarning + href: https://docs.python.org/3/library/exceptions.html#DeprecationWarning + name: DeprecationWarning + uid: DeprecationWarning +- fullName: EOFError + href: https://docs.python.org/3/library/exceptions.html#EOFError + name: EOFError + uid: EOFError +- fullName: EncodingWarning + href: https://docs.python.org/3/library/exceptions.html#EncodingWarning + name: EncodingWarning + uid: EncodingWarning +- fullName: EnvironmentError + href: https://docs.python.org/3/library/exceptions.html#EnvironmentError + name: EnvironmentError + uid: EnvironmentError +- fullName: Exception + href: https://docs.python.org/3/library/exceptions.html#Exception + name: Exception + uid: Exception +- fullName: ExceptionGroup + href: https://docs.python.org/3/library/exceptions.html#ExceptionGroup + name: ExceptionGroup + uid: ExceptionGroup +- fullName: FileExistsError + href: https://docs.python.org/3/library/exceptions.html#FileExistsError + name: FileExistsError + uid: FileExistsError +- fullName: FileNotFoundError + href: https://docs.python.org/3/library/exceptions.html#FileNotFoundError + name: FileNotFoundError + uid: FileNotFoundError +- fullName: FloatingPointError + href: https://docs.python.org/3/library/exceptions.html#FloatingPointError + name: FloatingPointError + uid: FloatingPointError +- fullName: FutureWarning + href: https://docs.python.org/3/library/exceptions.html#FutureWarning + name: FutureWarning + uid: FutureWarning +- fullName: GeneratorExit + href: https://docs.python.org/3/library/exceptions.html#GeneratorExit + name: GeneratorExit + uid: GeneratorExit +- fullName: IOError + href: https://docs.python.org/3/library/exceptions.html#IOError + name: IOError + uid: IOError +- fullName: ImportError + href: https://docs.python.org/3/library/exceptions.html#ImportError + name: ImportError + uid: ImportError +- fullName: ImportWarning + href: https://docs.python.org/3/library/exceptions.html#ImportWarning + name: ImportWarning + uid: ImportWarning +- fullName: IndentationError + href: https://docs.python.org/3/library/exceptions.html#IndentationError + name: IndentationError + uid: IndentationError +- fullName: IndexError + href: https://docs.python.org/3/library/exceptions.html#IndexError + name: IndexError + uid: IndexError +- fullName: InterruptedError + href: https://docs.python.org/3/library/exceptions.html#InterruptedError + name: InterruptedError + uid: InterruptedError +- fullName: IsADirectoryError + href: https://docs.python.org/3/library/exceptions.html#IsADirectoryError + name: IsADirectoryError + uid: IsADirectoryError +- fullName: KeyError + href: https://docs.python.org/3/library/exceptions.html#KeyError + name: KeyError + uid: KeyError +- fullName: KeyboardInterrupt + href: https://docs.python.org/3/library/exceptions.html#KeyboardInterrupt + name: KeyboardInterrupt + uid: KeyboardInterrupt +- fullName: LookupError + href: https://docs.python.org/3/library/exceptions.html#LookupError + name: LookupError + uid: LookupError +- fullName: MemoryError + href: https://docs.python.org/3/library/exceptions.html#MemoryError + name: MemoryError + uid: MemoryError +- fullName: ModuleNotFoundError + href: https://docs.python.org/3/library/exceptions.html#ModuleNotFoundError + name: ModuleNotFoundError + uid: ModuleNotFoundError +- fullName: NameError + href: https://docs.python.org/3/library/exceptions.html#NameError + name: NameError + uid: NameError +- fullName: NotADirectoryError + href: https://docs.python.org/3/library/exceptions.html#NotADirectoryError + name: NotADirectoryError + uid: NotADirectoryError +- fullName: NotImplementedError + href: https://docs.python.org/3/library/exceptions.html#NotImplementedError + name: NotImplementedError + uid: NotImplementedError +- fullName: OSError + href: https://docs.python.org/3/library/exceptions.html#OSError + name: OSError + uid: OSError +- fullName: OverflowError + href: https://docs.python.org/3/library/exceptions.html#OverflowError + name: OverflowError + uid: OverflowError +- fullName: PendingDeprecationWarning + href: https://docs.python.org/3/library/exceptions.html#PendingDeprecationWarning + name: PendingDeprecationWarning + uid: PendingDeprecationWarning +- fullName: PermissionError + href: https://docs.python.org/3/library/exceptions.html#PermissionError + name: PermissionError + uid: PermissionError +- fullName: ProcessLookupError + href: https://docs.python.org/3/library/exceptions.html#ProcessLookupError + name: ProcessLookupError + uid: ProcessLookupError +- fullName: PythonFinalizationError + href: https://docs.python.org/3/library/exceptions.html#PythonFinalizationError + name: PythonFinalizationError + uid: PythonFinalizationError +- fullName: RecursionError + href: https://docs.python.org/3/library/exceptions.html#RecursionError + name: RecursionError + uid: RecursionError +- fullName: ReferenceError + href: https://docs.python.org/3/library/exceptions.html#ReferenceError + name: ReferenceError + uid: ReferenceError +- fullName: ResourceWarning + href: https://docs.python.org/3/library/exceptions.html#ResourceWarning + name: ResourceWarning + uid: ResourceWarning +- fullName: RuntimeError + href: https://docs.python.org/3/library/exceptions.html#RuntimeError + name: RuntimeError + uid: RuntimeError +- fullName: RuntimeWarning + href: https://docs.python.org/3/library/exceptions.html#RuntimeWarning + name: RuntimeWarning + uid: RuntimeWarning +- fullName: StopAsyncIteration + href: https://docs.python.org/3/library/exceptions.html#StopAsyncIteration + name: StopAsyncIteration + uid: StopAsyncIteration +- fullName: StopIteration + href: https://docs.python.org/3/library/exceptions.html#StopIteration + name: StopIteration + uid: StopIteration +- fullName: SyntaxError + href: https://docs.python.org/3/library/exceptions.html#SyntaxError + name: SyntaxError + uid: SyntaxError +- fullName: SyntaxWarning + href: https://docs.python.org/3/library/exceptions.html#SyntaxWarning + name: SyntaxWarning + uid: SyntaxWarning +- fullName: SystemError + href: https://docs.python.org/3/library/exceptions.html#SystemError + name: SystemError + uid: SystemError +- fullName: SystemExit + href: https://docs.python.org/3/library/exceptions.html#SystemExit + name: SystemExit + uid: SystemExit +- fullName: TabError + href: https://docs.python.org/3/library/exceptions.html#TabError + name: TabError + uid: TabError +- fullName: TimeoutError + href: https://docs.python.org/3/library/exceptions.html#TimeoutError + name: TimeoutError + uid: TimeoutError +- fullName: TypeError + href: https://docs.python.org/3/library/exceptions.html#TypeError + name: TypeError + uid: TypeError +- fullName: UnboundLocalError + href: https://docs.python.org/3/library/exceptions.html#UnboundLocalError + name: UnboundLocalError + uid: UnboundLocalError +- fullName: UnicodeDecodeError + href: https://docs.python.org/3/library/exceptions.html#UnicodeDecodeError + name: UnicodeDecodeError + uid: UnicodeDecodeError +- fullName: UnicodeEncodeError + href: https://docs.python.org/3/library/exceptions.html#UnicodeEncodeError + name: UnicodeEncodeError + uid: UnicodeEncodeError +- fullName: UnicodeError + href: https://docs.python.org/3/library/exceptions.html#UnicodeError + name: UnicodeError + uid: UnicodeError +- fullName: UnicodeTranslateError + href: https://docs.python.org/3/library/exceptions.html#UnicodeTranslateError + name: UnicodeTranslateError + uid: UnicodeTranslateError +- fullName: UnicodeWarning + href: https://docs.python.org/3/library/exceptions.html#UnicodeWarning + name: UnicodeWarning + uid: UnicodeWarning +- fullName: UserWarning + href: https://docs.python.org/3/library/exceptions.html#UserWarning + name: UserWarning + uid: UserWarning +- fullName: ValueError + href: https://docs.python.org/3/library/exceptions.html#ValueError + name: ValueError + uid: ValueError +- fullName: Warning + href: https://docs.python.org/3/library/exceptions.html#Warning + name: Warning + uid: Warning +- fullName: WindowsError + href: https://docs.python.org/3/library/exceptions.html#WindowsError + name: WindowsError + uid: WindowsError +- fullName: ZeroDivisionError + href: https://docs.python.org/3/library/exceptions.html#ZeroDivisionError + name: ZeroDivisionError + uid: ZeroDivisionError +- fullName: _thread.error + href: https://docs.python.org/3/library/_thread.html#thread.error + name: error + uid: _thread.error +- fullName: argparse.ArgumentError + href: https://docs.python.org/3/library/argparse.html#argparse.ArgumentError + name: ArgumentError + uid: argparse.ArgumentError +- fullName: argparse.ArgumentTypeError + href: https://docs.python.org/3/library/argparse.html#argparse.ArgumentTypeError + name: ArgumentTypeError + uid: argparse.ArgumentTypeError +- fullName: asyncio.BrokenBarrierError + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.BrokenBarrierError + name: BrokenBarrierError + uid: asyncio.BrokenBarrierError +- fullName: asyncio.CancelledError + href: https://docs.python.org/3/library/asyncio-exceptions.html#asyncio.CancelledError + name: CancelledError + uid: asyncio.CancelledError +- fullName: asyncio.IncompleteReadError + href: https://docs.python.org/3/library/asyncio-exceptions.html#asyncio.IncompleteReadError + name: IncompleteReadError + uid: asyncio.IncompleteReadError +- fullName: asyncio.InvalidStateError + href: https://docs.python.org/3/library/asyncio-exceptions.html#asyncio.InvalidStateError + name: InvalidStateError + uid: asyncio.InvalidStateError +- fullName: asyncio.LimitOverrunError + href: https://docs.python.org/3/library/asyncio-exceptions.html#asyncio.LimitOverrunError + name: LimitOverrunError + uid: asyncio.LimitOverrunError +- fullName: asyncio.QueueEmpty + href: https://docs.python.org/3/library/asyncio-queue.html#asyncio.QueueEmpty + name: QueueEmpty + uid: asyncio.QueueEmpty +- fullName: asyncio.QueueFull + href: https://docs.python.org/3/library/asyncio-queue.html#asyncio.QueueFull + name: QueueFull + uid: asyncio.QueueFull +- fullName: asyncio.QueueShutDown + href: https://docs.python.org/3/library/asyncio-queue.html#asyncio.QueueShutDown + name: QueueShutDown + uid: asyncio.QueueShutDown +- fullName: asyncio.SendfileNotAvailableError + href: https://docs.python.org/3/library/asyncio-exceptions.html#asyncio.SendfileNotAvailableError + name: SendfileNotAvailableError + uid: asyncio.SendfileNotAvailableError +- fullName: asyncio.TimeoutError + href: https://docs.python.org/3/library/asyncio-exceptions.html#asyncio.TimeoutError + name: TimeoutError + uid: asyncio.TimeoutError +- fullName: bdb.BdbQuit + href: https://docs.python.org/3/library/bdb.html#bdb.BdbQuit + name: BdbQuit + uid: bdb.BdbQuit +- fullName: binascii.Error + href: https://docs.python.org/3/library/binascii.html#binascii.Error + name: Error + uid: binascii.Error +- fullName: binascii.Incomplete + href: https://docs.python.org/3/library/binascii.html#binascii.Incomplete + name: Incomplete + uid: binascii.Incomplete +- fullName: calendar.IllegalMonthError + href: https://docs.python.org/3/library/calendar.html#calendar.IllegalMonthError + name: IllegalMonthError + uid: calendar.IllegalMonthError +- fullName: calendar.IllegalWeekdayError + href: https://docs.python.org/3/library/calendar.html#calendar.IllegalWeekdayError + name: IllegalWeekdayError + uid: calendar.IllegalWeekdayError +- fullName: concurrent.futures.BrokenExecutor + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.BrokenExecutor + name: BrokenExecutor + uid: concurrent.futures.BrokenExecutor +- fullName: concurrent.futures.CancelledError + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.CancelledError + name: CancelledError + uid: concurrent.futures.CancelledError +- fullName: concurrent.futures.InvalidStateError + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.InvalidStateError + name: InvalidStateError + uid: concurrent.futures.InvalidStateError +- fullName: concurrent.futures.TimeoutError + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.TimeoutError + name: TimeoutError + uid: concurrent.futures.TimeoutError +- fullName: concurrent.futures.process.BrokenProcessPool + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.process.BrokenProcessPool + name: BrokenProcessPool + uid: concurrent.futures.process.BrokenProcessPool +- fullName: concurrent.futures.thread.BrokenThreadPool + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.thread.BrokenThreadPool + name: BrokenThreadPool + uid: concurrent.futures.thread.BrokenThreadPool +- fullName: configparser.DuplicateOptionError + href: https://docs.python.org/3/library/configparser.html#configparser.DuplicateOptionError + name: DuplicateOptionError + uid: configparser.DuplicateOptionError +- fullName: configparser.DuplicateSectionError + href: https://docs.python.org/3/library/configparser.html#configparser.DuplicateSectionError + name: DuplicateSectionError + uid: configparser.DuplicateSectionError +- fullName: configparser.Error + href: https://docs.python.org/3/library/configparser.html#configparser.Error + name: Error + uid: configparser.Error +- fullName: configparser.InterpolationDepthError + href: https://docs.python.org/3/library/configparser.html#configparser.InterpolationDepthError + name: InterpolationDepthError + uid: configparser.InterpolationDepthError +- fullName: configparser.InterpolationError + href: https://docs.python.org/3/library/configparser.html#configparser.InterpolationError + name: InterpolationError + uid: configparser.InterpolationError +- fullName: configparser.InterpolationMissingOptionError + href: https://docs.python.org/3/library/configparser.html#configparser.InterpolationMissingOptionError + name: InterpolationMissingOptionError + uid: configparser.InterpolationMissingOptionError +- fullName: configparser.InterpolationSyntaxError + href: https://docs.python.org/3/library/configparser.html#configparser.InterpolationSyntaxError + name: InterpolationSyntaxError + uid: configparser.InterpolationSyntaxError +- fullName: configparser.MissingSectionHeaderError + href: https://docs.python.org/3/library/configparser.html#configparser.MissingSectionHeaderError + name: MissingSectionHeaderError + uid: configparser.MissingSectionHeaderError +- fullName: configparser.MultilineContinuationError + href: https://docs.python.org/3/library/configparser.html#configparser.MultilineContinuationError + name: MultilineContinuationError + uid: configparser.MultilineContinuationError +- fullName: configparser.NoOptionError + href: https://docs.python.org/3/library/configparser.html#configparser.NoOptionError + name: NoOptionError + uid: configparser.NoOptionError +- fullName: configparser.NoSectionError + href: https://docs.python.org/3/library/configparser.html#configparser.NoSectionError + name: NoSectionError + uid: configparser.NoSectionError +- fullName: configparser.ParsingError + href: https://docs.python.org/3/library/configparser.html#configparser.ParsingError + name: ParsingError + uid: configparser.ParsingError +- fullName: copy.Error + href: https://docs.python.org/3/library/copy.html#copy.Error + name: Error + uid: copy.Error +- fullName: csv.Error + href: https://docs.python.org/3/library/csv.html#csv.Error + name: Error + uid: csv.Error +- fullName: ctypes.ArgumentError + href: https://docs.python.org/3/library/ctypes.html#ctypes.ArgumentError + name: ArgumentError + uid: ctypes.ArgumentError +- fullName: curses.error + href: https://docs.python.org/3/library/curses.html#curses.error + name: error + uid: curses.error +- fullName: dataclasses.FrozenInstanceError + href: https://docs.python.org/3/library/dataclasses.html#dataclasses.FrozenInstanceError + name: FrozenInstanceError + uid: dataclasses.FrozenInstanceError +- fullName: dbm.dumb.error + href: https://docs.python.org/3/library/dbm.html#dbm.dumb.error + name: error + uid: dbm.dumb.error +- fullName: dbm.error + href: https://docs.python.org/3/library/dbm.html#dbm.error + name: error + uid: dbm.error +- fullName: dbm.gnu.error + href: https://docs.python.org/3/library/dbm.html#dbm.gnu.error + name: error + uid: dbm.gnu.error +- fullName: dbm.ndbm.error + href: https://docs.python.org/3/library/dbm.html#dbm.ndbm.error + name: error + uid: dbm.ndbm.error +- fullName: doctest.DocTestFailure + href: https://docs.python.org/3/library/doctest.html#doctest.DocTestFailure + name: DocTestFailure + uid: doctest.DocTestFailure +- fullName: doctest.UnexpectedException + href: https://docs.python.org/3/library/doctest.html#doctest.UnexpectedException + name: UnexpectedException + uid: doctest.UnexpectedException +- fullName: doctest.failureException + href: https://docs.python.org/3/library/doctest.html#doctest.failureException + name: failureException + uid: doctest.failureException +- fullName: email.errors.BoundaryError + href: https://docs.python.org/3/library/email.errors.html#email.errors.BoundaryError + name: BoundaryError + uid: email.errors.BoundaryError +- fullName: email.errors.CloseBoundaryNotFoundDefect + href: https://docs.python.org/3/library/email.errors.html#email.errors.CloseBoundaryNotFoundDefect + name: CloseBoundaryNotFoundDefect + uid: email.errors.CloseBoundaryNotFoundDefect +- fullName: email.errors.FirstHeaderLineIsContinuationDefect + href: https://docs.python.org/3/library/email.errors.html#email.errors.FirstHeaderLineIsContinuationDefect + name: FirstHeaderLineIsContinuationDefect + uid: email.errors.FirstHeaderLineIsContinuationDefect +- fullName: email.errors.HeaderDefect + href: https://docs.python.org/3/library/email.errors.html#email.errors.HeaderDefect + name: HeaderDefect + uid: email.errors.HeaderDefect +- fullName: email.errors.HeaderParseError + href: https://docs.python.org/3/library/email.errors.html#email.errors.HeaderParseError + name: HeaderParseError + uid: email.errors.HeaderParseError +- fullName: email.errors.HeaderWriteError + href: https://docs.python.org/3/library/email.errors.html#email.errors.HeaderWriteError + name: HeaderWriteError + uid: email.errors.HeaderWriteError +- fullName: email.errors.InvalidBase64CharactersDefect + href: https://docs.python.org/3/library/email.errors.html#email.errors.InvalidBase64CharactersDefect + name: InvalidBase64CharactersDefect + uid: email.errors.InvalidBase64CharactersDefect +- fullName: email.errors.InvalidBase64LengthDefect + href: https://docs.python.org/3/library/email.errors.html#email.errors.InvalidBase64LengthDefect + name: InvalidBase64LengthDefect + uid: email.errors.InvalidBase64LengthDefect +- fullName: email.errors.InvalidBase64PaddingDefect + href: https://docs.python.org/3/library/email.errors.html#email.errors.InvalidBase64PaddingDefect + name: InvalidBase64PaddingDefect + uid: email.errors.InvalidBase64PaddingDefect +- fullName: email.errors.InvalidDateDefect + href: https://docs.python.org/3/library/email.errors.html#email.errors.InvalidDateDefect + name: InvalidDateDefect + uid: email.errors.InvalidDateDefect +- fullName: email.errors.MalformedHeaderDefect + href: https://docs.python.org/3/library/email.errors.html#email.errors.MalformedHeaderDefect + name: MalformedHeaderDefect + uid: email.errors.MalformedHeaderDefect +- fullName: email.errors.MessageDefect + href: https://docs.python.org/3/library/email.errors.html#email.errors.MessageDefect + name: MessageDefect + uid: email.errors.MessageDefect +- fullName: email.errors.MessageError + href: https://docs.python.org/3/library/email.errors.html#email.errors.MessageError + name: MessageError + uid: email.errors.MessageError +- fullName: email.errors.MessageParseError + href: https://docs.python.org/3/library/email.errors.html#email.errors.MessageParseError + name: MessageParseError + uid: email.errors.MessageParseError +- fullName: email.errors.MisplacedEnvelopeHeaderDefect + href: https://docs.python.org/3/library/email.errors.html#email.errors.MisplacedEnvelopeHeaderDefect + name: MisplacedEnvelopeHeaderDefect + uid: email.errors.MisplacedEnvelopeHeaderDefect +- fullName: email.errors.MissingHeaderBodySeparatorDefect + href: https://docs.python.org/3/library/email.errors.html#email.errors.MissingHeaderBodySeparatorDefect + name: MissingHeaderBodySeparatorDefect + uid: email.errors.MissingHeaderBodySeparatorDefect +- fullName: email.errors.MultipartConversionError + href: https://docs.python.org/3/library/email.errors.html#email.errors.MultipartConversionError + name: MultipartConversionError + uid: email.errors.MultipartConversionError +- fullName: email.errors.MultipartInvariantViolationDefect + href: https://docs.python.org/3/library/email.errors.html#email.errors.MultipartInvariantViolationDefect + name: MultipartInvariantViolationDefect + uid: email.errors.MultipartInvariantViolationDefect +- fullName: email.errors.NoBoundaryInMultipartDefect + href: https://docs.python.org/3/library/email.errors.html#email.errors.NoBoundaryInMultipartDefect + name: NoBoundaryInMultipartDefect + uid: email.errors.NoBoundaryInMultipartDefect +- fullName: email.errors.StartBoundaryNotFoundDefect + href: https://docs.python.org/3/library/email.errors.html#email.errors.StartBoundaryNotFoundDefect + name: StartBoundaryNotFoundDefect + uid: email.errors.StartBoundaryNotFoundDefect +- fullName: ftplib.error_perm + href: https://docs.python.org/3/library/ftplib.html#ftplib.error_perm + name: error_perm + uid: ftplib.error_perm +- fullName: ftplib.error_proto + href: https://docs.python.org/3/library/ftplib.html#ftplib.error_proto + name: error_proto + uid: ftplib.error_proto +- fullName: ftplib.error_reply + href: https://docs.python.org/3/library/ftplib.html#ftplib.error_reply + name: error_reply + uid: ftplib.error_reply +- fullName: ftplib.error_temp + href: https://docs.python.org/3/library/ftplib.html#ftplib.error_temp + name: error_temp + uid: ftplib.error_temp +- fullName: getopt.GetoptError + href: https://docs.python.org/3/library/getopt.html#getopt.GetoptError + name: GetoptError + uid: getopt.GetoptError +- fullName: getopt.error + href: https://docs.python.org/3/library/getopt.html#getopt.error + name: error + uid: getopt.error +- fullName: getpass.GetPassWarning + href: https://docs.python.org/3/library/getpass.html#getpass.GetPassWarning + name: GetPassWarning + uid: getpass.GetPassWarning +- fullName: graphlib.CycleError + href: https://docs.python.org/3/library/graphlib.html#graphlib.CycleError + name: CycleError + uid: graphlib.CycleError +- fullName: gzip.BadGzipFile + href: https://docs.python.org/3/library/gzip.html#gzip.BadGzipFile + name: BadGzipFile + uid: gzip.BadGzipFile +- fullName: http.client.BadStatusLine + href: https://docs.python.org/3/library/http.client.html#http.client.BadStatusLine + name: BadStatusLine + uid: http.client.BadStatusLine +- fullName: http.client.CannotSendHeader + href: https://docs.python.org/3/library/http.client.html#http.client.CannotSendHeader + name: CannotSendHeader + uid: http.client.CannotSendHeader +- fullName: http.client.CannotSendRequest + href: https://docs.python.org/3/library/http.client.html#http.client.CannotSendRequest + name: CannotSendRequest + uid: http.client.CannotSendRequest +- fullName: http.client.HTTPException + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPException + name: HTTPException + uid: http.client.HTTPException +- fullName: http.client.ImproperConnectionState + href: https://docs.python.org/3/library/http.client.html#http.client.ImproperConnectionState + name: ImproperConnectionState + uid: http.client.ImproperConnectionState +- fullName: http.client.IncompleteRead + href: https://docs.python.org/3/library/http.client.html#http.client.IncompleteRead + name: IncompleteRead + uid: http.client.IncompleteRead +- fullName: http.client.InvalidURL + href: https://docs.python.org/3/library/http.client.html#http.client.InvalidURL + name: InvalidURL + uid: http.client.InvalidURL +- fullName: http.client.LineTooLong + href: https://docs.python.org/3/library/http.client.html#http.client.LineTooLong + name: LineTooLong + uid: http.client.LineTooLong +- fullName: http.client.NotConnected + href: https://docs.python.org/3/library/http.client.html#http.client.NotConnected + name: NotConnected + uid: http.client.NotConnected +- fullName: http.client.RemoteDisconnected + href: https://docs.python.org/3/library/http.client.html#http.client.RemoteDisconnected + name: RemoteDisconnected + uid: http.client.RemoteDisconnected +- fullName: http.client.ResponseNotReady + href: https://docs.python.org/3/library/http.client.html#http.client.ResponseNotReady + name: ResponseNotReady + uid: http.client.ResponseNotReady +- fullName: http.client.UnimplementedFileMode + href: https://docs.python.org/3/library/http.client.html#http.client.UnimplementedFileMode + name: UnimplementedFileMode + uid: http.client.UnimplementedFileMode +- fullName: http.client.UnknownProtocol + href: https://docs.python.org/3/library/http.client.html#http.client.UnknownProtocol + name: UnknownProtocol + uid: http.client.UnknownProtocol +- fullName: http.client.UnknownTransferEncoding + href: https://docs.python.org/3/library/http.client.html#http.client.UnknownTransferEncoding + name: UnknownTransferEncoding + uid: http.client.UnknownTransferEncoding +- fullName: http.cookiejar.LoadError + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.LoadError + name: LoadError + uid: http.cookiejar.LoadError +- fullName: http.cookies.CookieError + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.CookieError + name: CookieError + uid: http.cookies.CookieError +- fullName: imaplib.IMAP4.abort + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.abort + name: abort + uid: imaplib.IMAP4.abort +- fullName: imaplib.IMAP4.error + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.error + name: error + uid: imaplib.IMAP4.error +- fullName: imaplib.IMAP4.readonly + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.readonly + name: readonly + uid: imaplib.IMAP4.readonly +- fullName: importlib.metadata.PackageNotFoundError + href: https://docs.python.org/3/library/importlib.metadata.html#importlib.metadata.PackageNotFoundError + name: PackageNotFoundError + uid: importlib.metadata.PackageNotFoundError +- fullName: io.BlockingIOError + href: https://docs.python.org/3/library/io.html#io.BlockingIOError + name: BlockingIOError + uid: io.BlockingIOError +- fullName: io.UnsupportedOperation + href: https://docs.python.org/3/library/io.html#io.UnsupportedOperation + name: UnsupportedOperation + uid: io.UnsupportedOperation +- fullName: ipaddress.AddressValueError + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.AddressValueError + name: AddressValueError + uid: ipaddress.AddressValueError +- fullName: ipaddress.NetmaskValueError + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.NetmaskValueError + name: NetmaskValueError + uid: ipaddress.NetmaskValueError +- fullName: json.JSONDecodeError + href: https://docs.python.org/3/library/json.html#json.JSONDecodeError + name: JSONDecodeError + uid: json.JSONDecodeError +- fullName: locale.Error + href: https://docs.python.org/3/library/locale.html#locale.Error + name: Error + uid: locale.Error +- fullName: lzma.LZMAError + href: https://docs.python.org/3/library/lzma.html#lzma.LZMAError + name: LZMAError + uid: lzma.LZMAError +- fullName: mailbox.Error + href: https://docs.python.org/3/library/mailbox.html#mailbox.Error + name: Error + uid: mailbox.Error +- fullName: mailbox.ExternalClashError + href: https://docs.python.org/3/library/mailbox.html#mailbox.ExternalClashError + name: ExternalClashError + uid: mailbox.ExternalClashError +- fullName: mailbox.FormatError + href: https://docs.python.org/3/library/mailbox.html#mailbox.FormatError + name: FormatError + uid: mailbox.FormatError +- fullName: mailbox.NoSuchMailboxError + href: https://docs.python.org/3/library/mailbox.html#mailbox.NoSuchMailboxError + name: NoSuchMailboxError + uid: mailbox.NoSuchMailboxError +- fullName: mailbox.NotEmptyError + href: https://docs.python.org/3/library/mailbox.html#mailbox.NotEmptyError + name: NotEmptyError + uid: mailbox.NotEmptyError +- fullName: multiprocessing.AuthenticationError + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.AuthenticationError + name: AuthenticationError + uid: multiprocessing.AuthenticationError +- fullName: multiprocessing.BufferTooShort + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.BufferTooShort + name: BufferTooShort + uid: multiprocessing.BufferTooShort +- fullName: multiprocessing.ProcessError + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.ProcessError + name: ProcessError + uid: multiprocessing.ProcessError +- fullName: multiprocessing.TimeoutError + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.TimeoutError + name: TimeoutError + uid: multiprocessing.TimeoutError +- fullName: netrc.NetrcParseError + href: https://docs.python.org/3/library/netrc.html#netrc.NetrcParseError + name: NetrcParseError + uid: netrc.NetrcParseError +- fullName: optparse.AmbiguousOptionError + href: https://docs.python.org/3/library/optparse.html#optparse.AmbiguousOptionError + name: AmbiguousOptionError + uid: optparse.AmbiguousOptionError +- fullName: optparse.BadOptionError + href: https://docs.python.org/3/library/optparse.html#optparse.BadOptionError + name: BadOptionError + uid: optparse.BadOptionError +- fullName: optparse.OptionConflictError + href: https://docs.python.org/3/library/optparse.html#optparse.OptionConflictError + name: OptionConflictError + uid: optparse.OptionConflictError +- fullName: optparse.OptionError + href: https://docs.python.org/3/library/optparse.html#optparse.OptionError + name: OptionError + uid: optparse.OptionError +- fullName: optparse.OptionValueError + href: https://docs.python.org/3/library/optparse.html#optparse.OptionValueError + name: OptionValueError + uid: optparse.OptionValueError +- fullName: os.error + href: https://docs.python.org/3/library/os.html#os.error + name: error + uid: os.error +- fullName: pathlib.UnsupportedOperation + href: https://docs.python.org/3/library/pathlib.html#pathlib.UnsupportedOperation + name: UnsupportedOperation + uid: pathlib.UnsupportedOperation +- fullName: pickle.PickleError + href: https://docs.python.org/3/library/pickle.html#pickle.PickleError + name: PickleError + uid: pickle.PickleError +- fullName: pickle.PicklingError + href: https://docs.python.org/3/library/pickle.html#pickle.PicklingError + name: PicklingError + uid: pickle.PicklingError +- fullName: pickle.UnpicklingError + href: https://docs.python.org/3/library/pickle.html#pickle.UnpicklingError + name: UnpicklingError + uid: pickle.UnpicklingError +- fullName: poplib.error_proto + href: https://docs.python.org/3/library/poplib.html#poplib.error_proto + name: error_proto + uid: poplib.error_proto +- fullName: py_compile.PyCompileError + href: https://docs.python.org/3/library/py_compile.html#py_compile.PyCompileError + name: PyCompileError + uid: py_compile.PyCompileError +- fullName: queue.Empty + href: https://docs.python.org/3/library/queue.html#queue.Empty + name: Empty + uid: queue.Empty +- fullName: queue.Full + href: https://docs.python.org/3/library/queue.html#queue.Full + name: Full + uid: queue.Full +- fullName: queue.ShutDown + href: https://docs.python.org/3/library/queue.html#queue.ShutDown + name: ShutDown + uid: queue.ShutDown +- fullName: re.PatternError + href: https://docs.python.org/3/library/re.html#re.PatternError + name: PatternError + uid: re.PatternError +- fullName: resource.error + href: https://docs.python.org/3/library/resource.html#resource.error + name: error + uid: resource.error +- fullName: select.error + href: https://docs.python.org/3/library/select.html#select.error + name: error + uid: select.error +- fullName: shutil.Error + href: https://docs.python.org/3/library/shutil.html#shutil.Error + name: Error + uid: shutil.Error +- fullName: shutil.SameFileError + href: https://docs.python.org/3/library/shutil.html#shutil.SameFileError + name: SameFileError + uid: shutil.SameFileError +- fullName: signal.ItimerError + href: https://docs.python.org/3/library/signal.html#signal.ItimerError + name: ItimerError + uid: signal.ItimerError +- fullName: smtplib.SMTPAuthenticationError + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTPAuthenticationError + name: SMTPAuthenticationError + uid: smtplib.SMTPAuthenticationError +- fullName: smtplib.SMTPConnectError + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTPConnectError + name: SMTPConnectError + uid: smtplib.SMTPConnectError +- fullName: smtplib.SMTPDataError + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTPDataError + name: SMTPDataError + uid: smtplib.SMTPDataError +- fullName: smtplib.SMTPException + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTPException + name: SMTPException + uid: smtplib.SMTPException +- fullName: smtplib.SMTPHeloError + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTPHeloError + name: SMTPHeloError + uid: smtplib.SMTPHeloError +- fullName: smtplib.SMTPNotSupportedError + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTPNotSupportedError + name: SMTPNotSupportedError + uid: smtplib.SMTPNotSupportedError +- fullName: smtplib.SMTPRecipientsRefused + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTPRecipientsRefused + name: SMTPRecipientsRefused + uid: smtplib.SMTPRecipientsRefused +- fullName: smtplib.SMTPResponseException + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTPResponseException + name: SMTPResponseException + uid: smtplib.SMTPResponseException +- fullName: smtplib.SMTPSenderRefused + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTPSenderRefused + name: SMTPSenderRefused + uid: smtplib.SMTPSenderRefused +- fullName: smtplib.SMTPServerDisconnected + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTPServerDisconnected + name: SMTPServerDisconnected + uid: smtplib.SMTPServerDisconnected +- fullName: socket.error + href: https://docs.python.org/3/library/socket.html#socket.error + name: error + uid: socket.error +- fullName: socket.gaierror + href: https://docs.python.org/3/library/socket.html#socket.gaierror + name: gaierror + uid: socket.gaierror +- fullName: socket.herror + href: https://docs.python.org/3/library/socket.html#socket.herror + name: herror + uid: socket.herror +- fullName: socket.timeout + href: https://docs.python.org/3/library/socket.html#socket.timeout + name: timeout + uid: socket.timeout +- fullName: sqlite3.DataError + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.DataError + name: DataError + uid: sqlite3.DataError +- fullName: sqlite3.DatabaseError + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.DatabaseError + name: DatabaseError + uid: sqlite3.DatabaseError +- fullName: sqlite3.Error + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Error + name: Error + uid: sqlite3.Error +- fullName: sqlite3.IntegrityError + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.IntegrityError + name: IntegrityError + uid: sqlite3.IntegrityError +- fullName: sqlite3.InterfaceError + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.InterfaceError + name: InterfaceError + uid: sqlite3.InterfaceError +- fullName: sqlite3.InternalError + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.InternalError + name: InternalError + uid: sqlite3.InternalError +- fullName: sqlite3.NotSupportedError + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.NotSupportedError + name: NotSupportedError + uid: sqlite3.NotSupportedError +- fullName: sqlite3.OperationalError + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.OperationalError + name: OperationalError + uid: sqlite3.OperationalError +- fullName: sqlite3.ProgrammingError + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.ProgrammingError + name: ProgrammingError + uid: sqlite3.ProgrammingError +- fullName: sqlite3.Warning + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Warning + name: Warning + uid: sqlite3.Warning +- fullName: ssl.CertificateError + href: https://docs.python.org/3/library/ssl.html#ssl.CertificateError + name: CertificateError + uid: ssl.CertificateError +- fullName: ssl.SSLCertVerificationError + href: https://docs.python.org/3/library/ssl.html#ssl.SSLCertVerificationError + name: SSLCertVerificationError + uid: ssl.SSLCertVerificationError +- fullName: ssl.SSLEOFError + href: https://docs.python.org/3/library/ssl.html#ssl.SSLEOFError + name: SSLEOFError + uid: ssl.SSLEOFError +- fullName: ssl.SSLError + href: https://docs.python.org/3/library/ssl.html#ssl.SSLError + name: SSLError + uid: ssl.SSLError +- fullName: ssl.SSLSyscallError + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSyscallError + name: SSLSyscallError + uid: ssl.SSLSyscallError +- fullName: ssl.SSLWantReadError + href: https://docs.python.org/3/library/ssl.html#ssl.SSLWantReadError + name: SSLWantReadError + uid: ssl.SSLWantReadError +- fullName: ssl.SSLWantWriteError + href: https://docs.python.org/3/library/ssl.html#ssl.SSLWantWriteError + name: SSLWantWriteError + uid: ssl.SSLWantWriteError +- fullName: ssl.SSLZeroReturnError + href: https://docs.python.org/3/library/ssl.html#ssl.SSLZeroReturnError + name: SSLZeroReturnError + uid: ssl.SSLZeroReturnError +- fullName: statistics.StatisticsError + href: https://docs.python.org/3/library/statistics.html#statistics.StatisticsError + name: StatisticsError + uid: statistics.StatisticsError +- fullName: struct.error + href: https://docs.python.org/3/library/struct.html#struct.error + name: error + uid: struct.error +- fullName: subprocess.CalledProcessError + href: https://docs.python.org/3/library/subprocess.html#subprocess.CalledProcessError + name: CalledProcessError + uid: subprocess.CalledProcessError +- fullName: subprocess.SubprocessError + href: https://docs.python.org/3/library/subprocess.html#subprocess.SubprocessError + name: SubprocessError + uid: subprocess.SubprocessError +- fullName: subprocess.TimeoutExpired + href: https://docs.python.org/3/library/subprocess.html#subprocess.TimeoutExpired + name: TimeoutExpired + uid: subprocess.TimeoutExpired +- fullName: tabnanny.NannyNag + href: https://docs.python.org/3/library/tabnanny.html#tabnanny.NannyNag + name: NannyNag + uid: tabnanny.NannyNag +- fullName: tarfile.AbsoluteLinkError + href: https://docs.python.org/3/library/tarfile.html#tarfile.AbsoluteLinkError + name: AbsoluteLinkError + uid: tarfile.AbsoluteLinkError +- fullName: tarfile.AbsolutePathError + href: https://docs.python.org/3/library/tarfile.html#tarfile.AbsolutePathError + name: AbsolutePathError + uid: tarfile.AbsolutePathError +- fullName: tarfile.CompressionError + href: https://docs.python.org/3/library/tarfile.html#tarfile.CompressionError + name: CompressionError + uid: tarfile.CompressionError +- fullName: tarfile.ExtractError + href: https://docs.python.org/3/library/tarfile.html#tarfile.ExtractError + name: ExtractError + uid: tarfile.ExtractError +- fullName: tarfile.FilterError + href: https://docs.python.org/3/library/tarfile.html#tarfile.FilterError + name: FilterError + uid: tarfile.FilterError +- fullName: tarfile.HeaderError + href: https://docs.python.org/3/library/tarfile.html#tarfile.HeaderError + name: HeaderError + uid: tarfile.HeaderError +- fullName: tarfile.LinkOutsideDestinationError + href: https://docs.python.org/3/library/tarfile.html#tarfile.LinkOutsideDestinationError + name: LinkOutsideDestinationError + uid: tarfile.LinkOutsideDestinationError +- fullName: tarfile.OutsideDestinationError + href: https://docs.python.org/3/library/tarfile.html#tarfile.OutsideDestinationError + name: OutsideDestinationError + uid: tarfile.OutsideDestinationError +- fullName: tarfile.ReadError + href: https://docs.python.org/3/library/tarfile.html#tarfile.ReadError + name: ReadError + uid: tarfile.ReadError +- fullName: tarfile.SpecialFileError + href: https://docs.python.org/3/library/tarfile.html#tarfile.SpecialFileError + name: SpecialFileError + uid: tarfile.SpecialFileError +- fullName: tarfile.StreamError + href: https://docs.python.org/3/library/tarfile.html#tarfile.StreamError + name: StreamError + uid: tarfile.StreamError +- fullName: tarfile.TarError + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarError + name: TarError + uid: tarfile.TarError +- fullName: test.support.ResourceDenied + href: https://docs.python.org/3/library/test.html#test.support.ResourceDenied + name: ResourceDenied + uid: test.support.ResourceDenied +- fullName: test.support.TestFailed + href: https://docs.python.org/3/library/test.html#test.support.TestFailed + name: TestFailed + uid: test.support.TestFailed +- fullName: threading.BrokenBarrierError + href: https://docs.python.org/3/library/threading.html#threading.BrokenBarrierError + name: BrokenBarrierError + uid: threading.BrokenBarrierError +- fullName: tokenize.TokenError + href: https://docs.python.org/3/library/tokenize.html#tokenize.TokenError + name: TokenError + uid: tokenize.TokenError +- fullName: tomllib.TOMLDecodeError + href: https://docs.python.org/3/library/tomllib.html#tomllib.TOMLDecodeError + name: TOMLDecodeError + uid: tomllib.TOMLDecodeError +- fullName: unittest.SkipTest + href: https://docs.python.org/3/library/unittest.html#unittest.SkipTest + name: SkipTest + uid: unittest.SkipTest +- fullName: urllib.error.ContentTooShortError + href: https://docs.python.org/3/library/urllib.error.html#urllib.error.ContentTooShortError + name: ContentTooShortError + uid: urllib.error.ContentTooShortError +- fullName: urllib.error.HTTPError + href: https://docs.python.org/3/library/urllib.error.html#urllib.error.HTTPError + name: HTTPError + uid: urllib.error.HTTPError +- fullName: urllib.error.URLError + href: https://docs.python.org/3/library/urllib.error.html#urllib.error.URLError + name: URLError + uid: urllib.error.URLError +- fullName: wave.Error + href: https://docs.python.org/3/library/wave.html#wave.Error + name: Error + uid: wave.Error +- fullName: webbrowser.Error + href: https://docs.python.org/3/library/webbrowser.html#webbrowser.Error + name: Error + uid: webbrowser.Error +- fullName: xml.dom.DOMException + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.DOMException + name: DOMException + uid: xml.dom.DOMException +- fullName: xml.dom.DomstringSizeErr + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.DomstringSizeErr + name: DomstringSizeErr + uid: xml.dom.DomstringSizeErr +- fullName: xml.dom.HierarchyRequestErr + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.HierarchyRequestErr + name: HierarchyRequestErr + uid: xml.dom.HierarchyRequestErr +- fullName: xml.dom.IndexSizeErr + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.IndexSizeErr + name: IndexSizeErr + uid: xml.dom.IndexSizeErr +- fullName: xml.dom.InuseAttributeErr + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.InuseAttributeErr + name: InuseAttributeErr + uid: xml.dom.InuseAttributeErr +- fullName: xml.dom.InvalidAccessErr + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.InvalidAccessErr + name: InvalidAccessErr + uid: xml.dom.InvalidAccessErr +- fullName: xml.dom.InvalidCharacterErr + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.InvalidCharacterErr + name: InvalidCharacterErr + uid: xml.dom.InvalidCharacterErr +- fullName: xml.dom.InvalidModificationErr + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.InvalidModificationErr + name: InvalidModificationErr + uid: xml.dom.InvalidModificationErr +- fullName: xml.dom.InvalidStateErr + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.InvalidStateErr + name: InvalidStateErr + uid: xml.dom.InvalidStateErr +- fullName: xml.dom.NamespaceErr + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.NamespaceErr + name: NamespaceErr + uid: xml.dom.NamespaceErr +- fullName: xml.dom.NoDataAllowedErr + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.NoDataAllowedErr + name: NoDataAllowedErr + uid: xml.dom.NoDataAllowedErr +- fullName: xml.dom.NoModificationAllowedErr + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.NoModificationAllowedErr + name: NoModificationAllowedErr + uid: xml.dom.NoModificationAllowedErr +- fullName: xml.dom.NotFoundErr + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.NotFoundErr + name: NotFoundErr + uid: xml.dom.NotFoundErr +- fullName: xml.dom.NotSupportedErr + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.NotSupportedErr + name: NotSupportedErr + uid: xml.dom.NotSupportedErr +- fullName: xml.dom.SyntaxErr + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.SyntaxErr + name: SyntaxErr + uid: xml.dom.SyntaxErr +- fullName: xml.dom.WrongDocumentErr + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.WrongDocumentErr + name: WrongDocumentErr + uid: xml.dom.WrongDocumentErr +- fullName: xml.parsers.expat.ExpatError + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.ExpatError + name: ExpatError + uid: xml.parsers.expat.ExpatError +- fullName: xml.parsers.expat.error + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.error + name: error + uid: xml.parsers.expat.error +- fullName: xml.sax.SAXException + href: https://docs.python.org/3/library/xml.sax.html#xml.sax.SAXException + name: SAXException + uid: xml.sax.SAXException +- fullName: xml.sax.SAXNotRecognizedException + href: https://docs.python.org/3/library/xml.sax.html#xml.sax.SAXNotRecognizedException + name: SAXNotRecognizedException + uid: xml.sax.SAXNotRecognizedException +- fullName: xml.sax.SAXNotSupportedException + href: https://docs.python.org/3/library/xml.sax.html#xml.sax.SAXNotSupportedException + name: SAXNotSupportedException + uid: xml.sax.SAXNotSupportedException +- fullName: xml.sax.SAXParseException + href: https://docs.python.org/3/library/xml.sax.html#xml.sax.SAXParseException + name: SAXParseException + uid: xml.sax.SAXParseException +- fullName: zipfile.BadZipFile + href: https://docs.python.org/3/library/zipfile.html#zipfile.BadZipFile + name: BadZipFile + uid: zipfile.BadZipFile +- fullName: zipfile.BadZipfile + href: https://docs.python.org/3/library/zipfile.html#zipfile.BadZipfile + name: BadZipfile + uid: zipfile.BadZipfile +- fullName: zipfile.LargeZipFile + href: https://docs.python.org/3/library/zipfile.html#zipfile.LargeZipFile + name: LargeZipFile + uid: zipfile.LargeZipFile +- fullName: zipimport.ZipImportError + href: https://docs.python.org/3/library/zipimport.html#zipimport.ZipImportError + name: ZipImportError + uid: zipimport.ZipImportError +- fullName: zlib.error + href: https://docs.python.org/3/library/zlib.html#zlib.error + name: error + uid: zlib.error +- fullName: zoneinfo.InvalidTZPathWarning + href: https://docs.python.org/3/library/zoneinfo.html#zoneinfo.InvalidTZPathWarning + name: InvalidTZPathWarning + uid: zoneinfo.InvalidTZPathWarning +- fullName: zoneinfo.ZoneInfoNotFoundError + href: https://docs.python.org/3/library/zoneinfo.html#zoneinfo.ZoneInfoNotFoundError + name: ZoneInfoNotFoundError + uid: zoneinfo.ZoneInfoNotFoundError +- fullName: BaseException.__cause__ + href: https://docs.python.org/3/library/exceptions.html#BaseException.__cause__ + name: __cause__ + uid: BaseException.__cause__ +- fullName: BaseException.__context__ + href: https://docs.python.org/3/library/exceptions.html#BaseException.__context__ + name: __context__ + uid: BaseException.__context__ +- fullName: BaseException.__notes__ + href: https://docs.python.org/3/library/exceptions.html#BaseException.__notes__ + name: __notes__ + uid: BaseException.__notes__ +- fullName: BaseException.__suppress_context__ + href: https://docs.python.org/3/library/exceptions.html#BaseException.__suppress_context__ + name: __suppress_context__ + uid: BaseException.__suppress_context__ +- fullName: BaseException.__traceback__ + href: https://docs.python.org/3/library/exceptions.html#BaseException.__traceback__ + name: __traceback__ + uid: BaseException.__traceback__ +- fullName: BaseException.args + href: https://docs.python.org/3/library/exceptions.html#BaseException.args + name: args + uid: BaseException.args +- fullName: BaseExceptionGroup.exceptions + href: https://docs.python.org/3/library/exceptions.html#BaseExceptionGroup.exceptions + name: exceptions + uid: BaseExceptionGroup.exceptions +- fullName: BaseExceptionGroup.message + href: https://docs.python.org/3/library/exceptions.html#BaseExceptionGroup.message + name: message + uid: BaseExceptionGroup.message +- fullName: BlockingIOError.characters_written + href: https://docs.python.org/3/library/exceptions.html#BlockingIOError.characters_written + name: characters_written + uid: BlockingIOError.characters_written +- fullName: ImportError.name + href: https://docs.python.org/3/library/exceptions.html#ImportError.name + name: name + uid: ImportError.name +- fullName: ImportError.path + href: https://docs.python.org/3/library/exceptions.html#ImportError.path + name: path + uid: ImportError.path +- fullName: OSError.errno + href: https://docs.python.org/3/library/exceptions.html#OSError.errno + name: errno + uid: OSError.errno +- fullName: OSError.filename + href: https://docs.python.org/3/library/exceptions.html#OSError.filename + name: filename + uid: OSError.filename +- fullName: OSError.filename2 + href: https://docs.python.org/3/library/exceptions.html#OSError.filename2 + name: filename2 + uid: OSError.filename2 +- fullName: OSError.strerror + href: https://docs.python.org/3/library/exceptions.html#OSError.strerror + name: strerror + uid: OSError.strerror +- fullName: OSError.winerror + href: https://docs.python.org/3/library/exceptions.html#OSError.winerror + name: winerror + uid: OSError.winerror +- fullName: StopIteration.value + href: https://docs.python.org/3/library/exceptions.html#StopIteration.value + name: value + uid: StopIteration.value +- fullName: SyntaxError.end_lineno + href: https://docs.python.org/3/library/exceptions.html#SyntaxError.end_lineno + name: end_lineno + uid: SyntaxError.end_lineno +- fullName: SyntaxError.end_offset + href: https://docs.python.org/3/library/exceptions.html#SyntaxError.end_offset + name: end_offset + uid: SyntaxError.end_offset +- fullName: SyntaxError.filename + href: https://docs.python.org/3/library/exceptions.html#SyntaxError.filename + name: filename + uid: SyntaxError.filename +- fullName: SyntaxError.lineno + href: https://docs.python.org/3/library/exceptions.html#SyntaxError.lineno + name: lineno + uid: SyntaxError.lineno +- fullName: SyntaxError.offset + href: https://docs.python.org/3/library/exceptions.html#SyntaxError.offset + name: offset + uid: SyntaxError.offset +- fullName: SyntaxError.text + href: https://docs.python.org/3/library/exceptions.html#SyntaxError.text + name: text + uid: SyntaxError.text +- fullName: SystemExit.code + href: https://docs.python.org/3/library/exceptions.html#SystemExit.code + name: code + uid: SystemExit.code +- fullName: UnicodeError.encoding + href: https://docs.python.org/3/library/exceptions.html#UnicodeError.encoding + name: encoding + uid: UnicodeError.encoding +- fullName: UnicodeError.end + href: https://docs.python.org/3/library/exceptions.html#UnicodeError.end + name: end + uid: UnicodeError.end +- fullName: UnicodeError.object + href: https://docs.python.org/3/library/exceptions.html#UnicodeError.object + name: object + uid: UnicodeError.object +- fullName: UnicodeError.reason + href: https://docs.python.org/3/library/exceptions.html#UnicodeError.reason + name: reason + uid: UnicodeError.reason +- fullName: UnicodeError.start + href: https://docs.python.org/3/library/exceptions.html#UnicodeError.start + name: start + uid: UnicodeError.start +- fullName: __future__._Feature.compiler_flag + href: https://docs.python.org/3/library/__future__.html#future__._Feature.compiler_flag + name: compiler_flag + uid: __future__._Feature.compiler_flag +- fullName: array.array.itemsize + href: https://docs.python.org/3/library/array.html#array.array.itemsize + name: itemsize + uid: array.array.itemsize +- fullName: array.array.typecode + href: https://docs.python.org/3/library/array.html#array.array.typecode + name: typecode + uid: array.array.typecode +- fullName: ast.AST._field_types + href: https://docs.python.org/3/library/ast.html#ast.AST._field_types + name: _field_types + uid: ast.AST._field_types +- fullName: ast.AST._fields + href: https://docs.python.org/3/library/ast.html#ast.AST._fields + name: _fields + uid: ast.AST._fields +- fullName: ast.AST.col_offset + href: https://docs.python.org/3/library/ast.html#ast.AST.col_offset + name: col_offset + uid: ast.AST.col_offset +- fullName: ast.AST.end_col_offset + href: https://docs.python.org/3/library/ast.html#ast.AST.end_col_offset + name: end_col_offset + uid: ast.AST.end_col_offset +- fullName: ast.AST.end_lineno + href: https://docs.python.org/3/library/ast.html#ast.AST.end_lineno + name: end_lineno + uid: ast.AST.end_lineno +- fullName: ast.AST.lineno + href: https://docs.python.org/3/library/ast.html#ast.AST.lineno + name: lineno + uid: ast.AST.lineno +- fullName: ast.Assign.type_comment + href: https://docs.python.org/3/library/ast.html#ast.Assign.type_comment + name: type_comment + uid: ast.Assign.type_comment +- fullName: ast.For.type_comment + href: https://docs.python.org/3/library/ast.html#ast.For.type_comment + name: type_comment + uid: ast.For.type_comment +- fullName: ast.FunctionDef.type_comment + href: https://docs.python.org/3/library/ast.html#ast.FunctionDef.type_comment + name: type_comment + uid: ast.FunctionDef.type_comment +- fullName: ast.With.type_comment + href: https://docs.python.org/3/library/ast.html#ast.With.type_comment + name: type_comment + uid: ast.With.type_comment +- fullName: ast.arg.type_comment + href: https://docs.python.org/3/library/ast.html#ast.arg.type_comment + name: type_comment + uid: ast.arg.type_comment +- fullName: asyncio.Barrier.broken + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Barrier.broken + name: broken + uid: asyncio.Barrier.broken +- fullName: asyncio.Barrier.n_waiting + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Barrier.n_waiting + name: n_waiting + uid: asyncio.Barrier.n_waiting +- fullName: asyncio.Barrier.parties + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Barrier.parties + name: parties + uid: asyncio.Barrier.parties +- fullName: asyncio.IncompleteReadError.expected + href: https://docs.python.org/3/library/asyncio-exceptions.html#asyncio.IncompleteReadError.expected + name: expected + uid: asyncio.IncompleteReadError.expected +- fullName: asyncio.IncompleteReadError.partial + href: https://docs.python.org/3/library/asyncio-exceptions.html#asyncio.IncompleteReadError.partial + name: partial + uid: asyncio.IncompleteReadError.partial +- fullName: asyncio.LimitOverrunError.consumed + href: https://docs.python.org/3/library/asyncio-exceptions.html#asyncio.LimitOverrunError.consumed + name: consumed + uid: asyncio.LimitOverrunError.consumed +- fullName: asyncio.Queue.maxsize + href: https://docs.python.org/3/library/asyncio-queue.html#asyncio.Queue.maxsize + name: maxsize + uid: asyncio.Queue.maxsize +- fullName: asyncio.Server.sockets + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.Server.sockets + name: sockets + uid: asyncio.Server.sockets +- fullName: asyncio.StreamWriter.transport + href: https://docs.python.org/3/library/asyncio-stream.html#asyncio.StreamWriter.transport + name: transport + uid: asyncio.StreamWriter.transport +- fullName: asyncio.loop.slow_callback_duration + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.slow_callback_duration + name: slow_callback_duration + uid: asyncio.loop.slow_callback_duration +- fullName: asyncio.subprocess.Process.pid + href: https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.subprocess.Process.pid + name: pid + uid: asyncio.subprocess.Process.pid +- fullName: asyncio.subprocess.Process.returncode + href: https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.subprocess.Process.returncode + name: returncode + uid: asyncio.subprocess.Process.returncode +- fullName: asyncio.subprocess.Process.stderr + href: https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.subprocess.Process.stderr + name: stderr + uid: asyncio.subprocess.Process.stderr +- fullName: asyncio.subprocess.Process.stdin + href: https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.subprocess.Process.stdin + name: stdin + uid: asyncio.subprocess.Process.stdin +- fullName: asyncio.subprocess.Process.stdout + href: https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.subprocess.Process.stdout + name: stdout + uid: asyncio.subprocess.Process.stdout +- fullName: bdb.Breakpoint.bpbynumber + href: https://docs.python.org/3/library/bdb.html#bdb.Breakpoint.bpbynumber + name: bpbynumber + uid: bdb.Breakpoint.bpbynumber +- fullName: bdb.Breakpoint.bplist + href: https://docs.python.org/3/library/bdb.html#bdb.Breakpoint.bplist + name: bplist + uid: bdb.Breakpoint.bplist +- fullName: bdb.Breakpoint.cond + href: https://docs.python.org/3/library/bdb.html#bdb.Breakpoint.cond + name: cond + uid: bdb.Breakpoint.cond +- fullName: bdb.Breakpoint.enabled + href: https://docs.python.org/3/library/bdb.html#bdb.Breakpoint.enabled + name: enabled + uid: bdb.Breakpoint.enabled +- fullName: bdb.Breakpoint.file + href: https://docs.python.org/3/library/bdb.html#bdb.Breakpoint.file + name: file + uid: bdb.Breakpoint.file +- fullName: bdb.Breakpoint.funcname + href: https://docs.python.org/3/library/bdb.html#bdb.Breakpoint.funcname + name: funcname + uid: bdb.Breakpoint.funcname +- fullName: bdb.Breakpoint.hits + href: https://docs.python.org/3/library/bdb.html#bdb.Breakpoint.hits + name: hits + uid: bdb.Breakpoint.hits +- fullName: bdb.Breakpoint.ignore + href: https://docs.python.org/3/library/bdb.html#bdb.Breakpoint.ignore + name: ignore + uid: bdb.Breakpoint.ignore +- fullName: bdb.Breakpoint.line + href: https://docs.python.org/3/library/bdb.html#bdb.Breakpoint.line + name: line + uid: bdb.Breakpoint.line +- fullName: bdb.Breakpoint.temporary + href: https://docs.python.org/3/library/bdb.html#bdb.Breakpoint.temporary + name: temporary + uid: bdb.Breakpoint.temporary +- fullName: bz2.BZ2Decompressor.eof + href: https://docs.python.org/3/library/bz2.html#bz2.BZ2Decompressor.eof + name: eof + uid: bz2.BZ2Decompressor.eof +- fullName: bz2.BZ2Decompressor.needs_input + href: https://docs.python.org/3/library/bz2.html#bz2.BZ2Decompressor.needs_input + name: needs_input + uid: bz2.BZ2Decompressor.needs_input +- fullName: bz2.BZ2Decompressor.unused_data + href: https://docs.python.org/3/library/bz2.html#bz2.BZ2Decompressor.unused_data + name: unused_data + uid: bz2.BZ2Decompressor.unused_data +- fullName: bz2.BZ2File.mode + href: https://docs.python.org/3/library/bz2.html#bz2.BZ2File.mode + name: mode + uid: bz2.BZ2File.mode +- fullName: bz2.BZ2File.name + href: https://docs.python.org/3/library/bz2.html#bz2.BZ2File.name + name: name + uid: bz2.BZ2File.name +- fullName: calendar.Calendar.firstweekday + href: https://docs.python.org/3/library/calendar.html#calendar.Calendar.firstweekday + name: firstweekday + uid: calendar.Calendar.firstweekday +- fullName: calendar.HTMLCalendar.cssclass_month + href: https://docs.python.org/3/library/calendar.html#calendar.HTMLCalendar.cssclass_month + name: cssclass_month + uid: calendar.HTMLCalendar.cssclass_month +- fullName: calendar.HTMLCalendar.cssclass_month_head + href: https://docs.python.org/3/library/calendar.html#calendar.HTMLCalendar.cssclass_month_head + name: cssclass_month_head + uid: calendar.HTMLCalendar.cssclass_month_head +- fullName: calendar.HTMLCalendar.cssclass_noday + href: https://docs.python.org/3/library/calendar.html#calendar.HTMLCalendar.cssclass_noday + name: cssclass_noday + uid: calendar.HTMLCalendar.cssclass_noday +- fullName: calendar.HTMLCalendar.cssclass_year + href: https://docs.python.org/3/library/calendar.html#calendar.HTMLCalendar.cssclass_year + name: cssclass_year + uid: calendar.HTMLCalendar.cssclass_year +- fullName: calendar.HTMLCalendar.cssclass_year_head + href: https://docs.python.org/3/library/calendar.html#calendar.HTMLCalendar.cssclass_year_head + name: cssclass_year_head + uid: calendar.HTMLCalendar.cssclass_year_head +- fullName: calendar.HTMLCalendar.cssclasses + href: https://docs.python.org/3/library/calendar.html#calendar.HTMLCalendar.cssclasses + name: cssclasses + uid: calendar.HTMLCalendar.cssclasses +- fullName: calendar.HTMLCalendar.cssclasses_weekday_head + href: https://docs.python.org/3/library/calendar.html#calendar.HTMLCalendar.cssclasses_weekday_head + name: cssclasses_weekday_head + uid: calendar.HTMLCalendar.cssclasses_weekday_head +- fullName: calendar.IllegalMonthError.month + href: https://docs.python.org/3/library/calendar.html#calendar.IllegalMonthError.month + name: month + uid: calendar.IllegalMonthError.month +- fullName: calendar.IllegalWeekdayError.weekday + href: https://docs.python.org/3/library/calendar.html#calendar.IllegalWeekdayError.weekday + name: weekday + uid: calendar.IllegalWeekdayError.weekday +- fullName: cmd.Cmd.cmdqueue + href: https://docs.python.org/3/library/cmd.html#cmd.Cmd.cmdqueue + name: cmdqueue + uid: cmd.Cmd.cmdqueue +- fullName: cmd.Cmd.doc_header + href: https://docs.python.org/3/library/cmd.html#cmd.Cmd.doc_header + name: doc_header + uid: cmd.Cmd.doc_header +- fullName: cmd.Cmd.identchars + href: https://docs.python.org/3/library/cmd.html#cmd.Cmd.identchars + name: identchars + uid: cmd.Cmd.identchars +- fullName: cmd.Cmd.intro + href: https://docs.python.org/3/library/cmd.html#cmd.Cmd.intro + name: intro + uid: cmd.Cmd.intro +- fullName: cmd.Cmd.lastcmd + href: https://docs.python.org/3/library/cmd.html#cmd.Cmd.lastcmd + name: lastcmd + uid: cmd.Cmd.lastcmd +- fullName: cmd.Cmd.misc_header + href: https://docs.python.org/3/library/cmd.html#cmd.Cmd.misc_header + name: misc_header + uid: cmd.Cmd.misc_header +- fullName: cmd.Cmd.prompt + href: https://docs.python.org/3/library/cmd.html#cmd.Cmd.prompt + name: prompt + uid: cmd.Cmd.prompt +- fullName: cmd.Cmd.ruler + href: https://docs.python.org/3/library/cmd.html#cmd.Cmd.ruler + name: ruler + uid: cmd.Cmd.ruler +- fullName: cmd.Cmd.undoc_header + href: https://docs.python.org/3/library/cmd.html#cmd.Cmd.undoc_header + name: undoc_header + uid: cmd.Cmd.undoc_header +- fullName: cmd.Cmd.use_rawinput + href: https://docs.python.org/3/library/cmd.html#cmd.Cmd.use_rawinput + name: use_rawinput + uid: cmd.Cmd.use_rawinput +- fullName: codecs.CodecInfo.decode + href: https://docs.python.org/3/library/codecs.html#codecs.CodecInfo.decode + name: decode + uid: codecs.CodecInfo.decode +- fullName: codecs.CodecInfo.encode + href: https://docs.python.org/3/library/codecs.html#codecs.CodecInfo.encode + name: encode + uid: codecs.CodecInfo.encode +- fullName: codecs.CodecInfo.incrementaldecoder + href: https://docs.python.org/3/library/codecs.html#codecs.CodecInfo.incrementaldecoder + name: incrementaldecoder + uid: codecs.CodecInfo.incrementaldecoder +- fullName: codecs.CodecInfo.incrementalencoder + href: https://docs.python.org/3/library/codecs.html#codecs.CodecInfo.incrementalencoder + name: incrementalencoder + uid: codecs.CodecInfo.incrementalencoder +- fullName: codecs.CodecInfo.name + href: https://docs.python.org/3/library/codecs.html#codecs.CodecInfo.name + name: name + uid: codecs.CodecInfo.name +- fullName: codecs.CodecInfo.streamreader + href: https://docs.python.org/3/library/codecs.html#codecs.CodecInfo.streamreader + name: streamreader + uid: codecs.CodecInfo.streamreader +- fullName: codecs.CodecInfo.streamwriter + href: https://docs.python.org/3/library/codecs.html#codecs.CodecInfo.streamwriter + name: streamwriter + uid: codecs.CodecInfo.streamwriter +- fullName: codeobject.co_argcount + href: https://docs.python.org/3/reference/datamodel.html#codeobject.co_argcount + name: co_argcount + uid: codeobject.co_argcount +- fullName: codeobject.co_cellvars + href: https://docs.python.org/3/reference/datamodel.html#codeobject.co_cellvars + name: co_cellvars + uid: codeobject.co_cellvars +- fullName: codeobject.co_code + href: https://docs.python.org/3/reference/datamodel.html#codeobject.co_code + name: co_code + uid: codeobject.co_code +- fullName: codeobject.co_consts + href: https://docs.python.org/3/reference/datamodel.html#codeobject.co_consts + name: co_consts + uid: codeobject.co_consts +- fullName: codeobject.co_filename + href: https://docs.python.org/3/reference/datamodel.html#codeobject.co_filename + name: co_filename + uid: codeobject.co_filename +- fullName: codeobject.co_firstlineno + href: https://docs.python.org/3/reference/datamodel.html#codeobject.co_firstlineno + name: co_firstlineno + uid: codeobject.co_firstlineno +- fullName: codeobject.co_flags + href: https://docs.python.org/3/reference/datamodel.html#codeobject.co_flags + name: co_flags + uid: codeobject.co_flags +- fullName: codeobject.co_freevars + href: https://docs.python.org/3/reference/datamodel.html#codeobject.co_freevars + name: co_freevars + uid: codeobject.co_freevars +- fullName: codeobject.co_kwonlyargcount + href: https://docs.python.org/3/reference/datamodel.html#codeobject.co_kwonlyargcount + name: co_kwonlyargcount + uid: codeobject.co_kwonlyargcount +- fullName: codeobject.co_lnotab + href: https://docs.python.org/3/reference/datamodel.html#codeobject.co_lnotab + name: co_lnotab + uid: codeobject.co_lnotab +- fullName: codeobject.co_name + href: https://docs.python.org/3/reference/datamodel.html#codeobject.co_name + name: co_name + uid: codeobject.co_name +- fullName: codeobject.co_names + href: https://docs.python.org/3/reference/datamodel.html#codeobject.co_names + name: co_names + uid: codeobject.co_names +- fullName: codeobject.co_nlocals + href: https://docs.python.org/3/reference/datamodel.html#codeobject.co_nlocals + name: co_nlocals + uid: codeobject.co_nlocals +- fullName: codeobject.co_posonlyargcount + href: https://docs.python.org/3/reference/datamodel.html#codeobject.co_posonlyargcount + name: co_posonlyargcount + uid: codeobject.co_posonlyargcount +- fullName: codeobject.co_qualname + href: https://docs.python.org/3/reference/datamodel.html#codeobject.co_qualname + name: co_qualname + uid: codeobject.co_qualname +- fullName: codeobject.co_stacksize + href: https://docs.python.org/3/reference/datamodel.html#codeobject.co_stacksize + name: co_stacksize + uid: codeobject.co_stacksize +- fullName: codeobject.co_varnames + href: https://docs.python.org/3/reference/datamodel.html#codeobject.co_varnames + name: co_varnames + uid: codeobject.co_varnames +- fullName: collections.ChainMap.maps + href: https://docs.python.org/3/library/collections.html#collections.ChainMap.maps + name: maps + uid: collections.ChainMap.maps +- fullName: collections.ChainMap.parents + href: https://docs.python.org/3/library/collections.html#collections.ChainMap.parents + name: parents + uid: collections.ChainMap.parents +- fullName: collections.UserDict.data + href: https://docs.python.org/3/library/collections.html#collections.UserDict.data + name: data + uid: collections.UserDict.data +- fullName: collections.UserList.data + href: https://docs.python.org/3/library/collections.html#collections.UserList.data + name: data + uid: collections.UserList.data +- fullName: collections.UserString.data + href: https://docs.python.org/3/library/collections.html#collections.UserString.data + name: data + uid: collections.UserString.data +- fullName: collections.defaultdict.default_factory + href: https://docs.python.org/3/library/collections.html#collections.defaultdict.default_factory + name: default_factory + uid: collections.defaultdict.default_factory +- fullName: collections.deque.maxlen + href: https://docs.python.org/3/library/collections.html#collections.deque.maxlen + name: maxlen + uid: collections.deque.maxlen +- fullName: collections.somenamedtuple._field_defaults + href: https://docs.python.org/3/library/collections.html#collections.somenamedtuple._field_defaults + name: _field_defaults + uid: collections.somenamedtuple._field_defaults +- fullName: collections.somenamedtuple._fields + href: https://docs.python.org/3/library/collections.html#collections.somenamedtuple._fields + name: _fields + uid: collections.somenamedtuple._fields +- fullName: configparser.ConfigParser.BOOLEAN_STATES + href: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.BOOLEAN_STATES + name: BOOLEAN_STATES + uid: configparser.ConfigParser.BOOLEAN_STATES +- fullName: configparser.ConfigParser.SECTCRE + href: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.SECTCRE + name: SECTCRE + uid: configparser.ConfigParser.SECTCRE +- fullName: contextvars.ContextVar.name + href: https://docs.python.org/3/library/contextvars.html#contextvars.ContextVar.name + name: name + uid: contextvars.ContextVar.name +- fullName: contextvars.Token.MISSING + href: https://docs.python.org/3/library/contextvars.html#contextvars.Token.MISSING + name: MISSING + uid: contextvars.Token.MISSING +- fullName: contextvars.Token.old_value + href: https://docs.python.org/3/library/contextvars.html#contextvars.Token.old_value + name: old_value + uid: contextvars.Token.old_value +- fullName: contextvars.Token.var + href: https://docs.python.org/3/library/contextvars.html#contextvars.Token.var + name: var + uid: contextvars.Token.var +- fullName: csv.Dialect.delimiter + href: https://docs.python.org/3/library/csv.html#csv.Dialect.delimiter + name: delimiter + uid: csv.Dialect.delimiter +- fullName: csv.Dialect.doublequote + href: https://docs.python.org/3/library/csv.html#csv.Dialect.doublequote + name: doublequote + uid: csv.Dialect.doublequote +- fullName: csv.Dialect.escapechar + href: https://docs.python.org/3/library/csv.html#csv.Dialect.escapechar + name: escapechar + uid: csv.Dialect.escapechar +- fullName: csv.Dialect.lineterminator + href: https://docs.python.org/3/library/csv.html#csv.Dialect.lineterminator + name: lineterminator + uid: csv.Dialect.lineterminator +- fullName: csv.Dialect.quotechar + href: https://docs.python.org/3/library/csv.html#csv.Dialect.quotechar + name: quotechar + uid: csv.Dialect.quotechar +- fullName: csv.Dialect.quoting + href: https://docs.python.org/3/library/csv.html#csv.Dialect.quoting + name: quoting + uid: csv.Dialect.quoting +- fullName: csv.Dialect.skipinitialspace + href: https://docs.python.org/3/library/csv.html#csv.Dialect.skipinitialspace + name: skipinitialspace + uid: csv.Dialect.skipinitialspace +- fullName: csv.Dialect.strict + href: https://docs.python.org/3/library/csv.html#csv.Dialect.strict + name: strict + uid: csv.Dialect.strict +- fullName: csv.DictReader.fieldnames + href: https://docs.python.org/3/library/csv.html#csv.DictReader.fieldnames + name: fieldnames + uid: csv.DictReader.fieldnames +- fullName: csv.csvreader.dialect + href: https://docs.python.org/3/library/csv.html#csv.csvreader.dialect + name: dialect + uid: csv.csvreader.dialect +- fullName: csv.csvreader.line_num + href: https://docs.python.org/3/library/csv.html#csv.csvreader.line_num + name: line_num + uid: csv.csvreader.line_num +- fullName: csv.csvwriter.dialect + href: https://docs.python.org/3/library/csv.html#csv.csvwriter.dialect + name: dialect + uid: csv.csvwriter.dialect +- fullName: ctypes.Array._length_ + href: https://docs.python.org/3/library/ctypes.html#ctypes.Array._length_ + name: _length_ + uid: ctypes.Array._length_ +- fullName: ctypes.Array._type_ + href: https://docs.python.org/3/library/ctypes.html#ctypes.Array._type_ + name: _type_ + uid: ctypes.Array._type_ +- fullName: ctypes.PyDLL._handle + href: https://docs.python.org/3/library/ctypes.html#ctypes.PyDLL._handle + name: _handle + uid: ctypes.PyDLL._handle +- fullName: ctypes.PyDLL._name + href: https://docs.python.org/3/library/ctypes.html#ctypes.PyDLL._name + name: _name + uid: ctypes.PyDLL._name +- fullName: ctypes.Structure._align_ + href: https://docs.python.org/3/library/ctypes.html#ctypes.Structure._align_ + name: _align_ + uid: ctypes.Structure._align_ +- fullName: ctypes.Structure._anonymous_ + href: https://docs.python.org/3/library/ctypes.html#ctypes.Structure._anonymous_ + name: _anonymous_ + uid: ctypes.Structure._anonymous_ +- fullName: ctypes.Structure._fields_ + href: https://docs.python.org/3/library/ctypes.html#ctypes.Structure._fields_ + name: _fields_ + uid: ctypes.Structure._fields_ +- fullName: ctypes.Structure._pack_ + href: https://docs.python.org/3/library/ctypes.html#ctypes.Structure._pack_ + name: _pack_ + uid: ctypes.Structure._pack_ +- fullName: ctypes._CData._b_base_ + href: https://docs.python.org/3/library/ctypes.html#ctypes._CData._b_base_ + name: _b_base_ + uid: ctypes._CData._b_base_ +- fullName: ctypes._CData._b_needsfree_ + href: https://docs.python.org/3/library/ctypes.html#ctypes._CData._b_needsfree_ + name: _b_needsfree_ + uid: ctypes._CData._b_needsfree_ +- fullName: ctypes._CData._objects + href: https://docs.python.org/3/library/ctypes.html#ctypes._CData._objects + name: _objects + uid: ctypes._CData._objects +- fullName: ctypes._CFuncPtr.argtypes + href: https://docs.python.org/3/library/ctypes.html#ctypes._CFuncPtr.argtypes + name: argtypes + uid: ctypes._CFuncPtr.argtypes +- fullName: ctypes._CFuncPtr.errcheck + href: https://docs.python.org/3/library/ctypes.html#ctypes._CFuncPtr.errcheck + name: errcheck + uid: ctypes._CFuncPtr.errcheck +- fullName: ctypes._CFuncPtr.restype + href: https://docs.python.org/3/library/ctypes.html#ctypes._CFuncPtr.restype + name: restype + uid: ctypes._CFuncPtr.restype +- fullName: ctypes._Pointer._type_ + href: https://docs.python.org/3/library/ctypes.html#ctypes._Pointer._type_ + name: _type_ + uid: ctypes._Pointer._type_ +- fullName: ctypes._Pointer.contents + href: https://docs.python.org/3/library/ctypes.html#ctypes._Pointer.contents + name: contents + uid: ctypes._Pointer.contents +- fullName: ctypes._SimpleCData.value + href: https://docs.python.org/3/library/ctypes.html#ctypes._SimpleCData.value + name: value + uid: ctypes._SimpleCData.value +- fullName: curses.textpad.Textbox.stripspaces + href: https://docs.python.org/3/library/curses.html#curses.textpad.Textbox.stripspaces + name: stripspaces + uid: curses.textpad.Textbox.stripspaces +- fullName: curses.window.encoding + href: https://docs.python.org/3/library/curses.html#curses.window.encoding + name: encoding + uid: curses.window.encoding +- fullName: datetime.date.day + href: https://docs.python.org/3/library/datetime.html#datetime.date.day + name: day + uid: datetime.date.day +- fullName: datetime.date.max + href: https://docs.python.org/3/library/datetime.html#datetime.date.max + name: max + uid: datetime.date.max +- fullName: datetime.date.min + href: https://docs.python.org/3/library/datetime.html#datetime.date.min + name: min + uid: datetime.date.min +- fullName: datetime.date.month + href: https://docs.python.org/3/library/datetime.html#datetime.date.month + name: month + uid: datetime.date.month +- fullName: datetime.date.resolution + href: https://docs.python.org/3/library/datetime.html#datetime.date.resolution + name: resolution + uid: datetime.date.resolution +- fullName: datetime.date.year + href: https://docs.python.org/3/library/datetime.html#datetime.date.year + name: year + uid: datetime.date.year +- fullName: datetime.datetime.day + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.day + name: day + uid: datetime.datetime.day +- fullName: datetime.datetime.fold + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.fold + name: fold + uid: datetime.datetime.fold +- fullName: datetime.datetime.hour + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.hour + name: hour + uid: datetime.datetime.hour +- fullName: datetime.datetime.max + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.max + name: max + uid: datetime.datetime.max +- fullName: datetime.datetime.microsecond + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.microsecond + name: microsecond + uid: datetime.datetime.microsecond +- fullName: datetime.datetime.min + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.min + name: min + uid: datetime.datetime.min +- fullName: datetime.datetime.minute + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.minute + name: minute + uid: datetime.datetime.minute +- fullName: datetime.datetime.month + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.month + name: month + uid: datetime.datetime.month +- fullName: datetime.datetime.resolution + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.resolution + name: resolution + uid: datetime.datetime.resolution +- fullName: datetime.datetime.second + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.second + name: second + uid: datetime.datetime.second +- fullName: datetime.datetime.tzinfo + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.tzinfo + name: tzinfo + uid: datetime.datetime.tzinfo +- fullName: datetime.datetime.year + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.year + name: year + uid: datetime.datetime.year +- fullName: datetime.time.fold + href: https://docs.python.org/3/library/datetime.html#datetime.time.fold + name: fold + uid: datetime.time.fold +- fullName: datetime.time.hour + href: https://docs.python.org/3/library/datetime.html#datetime.time.hour + name: hour + uid: datetime.time.hour +- fullName: datetime.time.max + href: https://docs.python.org/3/library/datetime.html#datetime.time.max + name: max + uid: datetime.time.max +- fullName: datetime.time.microsecond + href: https://docs.python.org/3/library/datetime.html#datetime.time.microsecond + name: microsecond + uid: datetime.time.microsecond +- fullName: datetime.time.min + href: https://docs.python.org/3/library/datetime.html#datetime.time.min + name: min + uid: datetime.time.min +- fullName: datetime.time.minute + href: https://docs.python.org/3/library/datetime.html#datetime.time.minute + name: minute + uid: datetime.time.minute +- fullName: datetime.time.resolution + href: https://docs.python.org/3/library/datetime.html#datetime.time.resolution + name: resolution + uid: datetime.time.resolution +- fullName: datetime.time.second + href: https://docs.python.org/3/library/datetime.html#datetime.time.second + name: second + uid: datetime.time.second +- fullName: datetime.time.tzinfo + href: https://docs.python.org/3/library/datetime.html#datetime.time.tzinfo + name: tzinfo + uid: datetime.time.tzinfo +- fullName: datetime.timedelta.days + href: https://docs.python.org/3/library/datetime.html#datetime.timedelta.days + name: days + uid: datetime.timedelta.days +- fullName: datetime.timedelta.max + href: https://docs.python.org/3/library/datetime.html#datetime.timedelta.max + name: max + uid: datetime.timedelta.max +- fullName: datetime.timedelta.microseconds + href: https://docs.python.org/3/library/datetime.html#datetime.timedelta.microseconds + name: microseconds + uid: datetime.timedelta.microseconds +- fullName: datetime.timedelta.min + href: https://docs.python.org/3/library/datetime.html#datetime.timedelta.min + name: min + uid: datetime.timedelta.min +- fullName: datetime.timedelta.resolution + href: https://docs.python.org/3/library/datetime.html#datetime.timedelta.resolution + name: resolution + uid: datetime.timedelta.resolution +- fullName: datetime.timedelta.seconds + href: https://docs.python.org/3/library/datetime.html#datetime.timedelta.seconds + name: seconds + uid: datetime.timedelta.seconds +- fullName: datetime.timezone.utc + href: https://docs.python.org/3/library/datetime.html#datetime.timezone.utc + name: utc + uid: datetime.timezone.utc +- fullName: definition.__doc__ + href: https://docs.python.org/3/library/stdtypes.html#definition.__doc__ + name: __doc__ + uid: definition.__doc__ +- fullName: definition.__module__ + href: https://docs.python.org/3/library/stdtypes.html#definition.__module__ + name: __module__ + uid: definition.__module__ +- fullName: definition.__name__ + href: https://docs.python.org/3/library/stdtypes.html#definition.__name__ + name: __name__ + uid: definition.__name__ +- fullName: definition.__qualname__ + href: https://docs.python.org/3/library/stdtypes.html#definition.__qualname__ + name: __qualname__ + uid: definition.__qualname__ +- fullName: definition.__type_params__ + href: https://docs.python.org/3/library/stdtypes.html#definition.__type_params__ + name: __type_params__ + uid: definition.__type_params__ +- fullName: doctest.DocTest.docstring + href: https://docs.python.org/3/library/doctest.html#doctest.DocTest.docstring + name: docstring + uid: doctest.DocTest.docstring +- fullName: doctest.DocTest.examples + href: https://docs.python.org/3/library/doctest.html#doctest.DocTest.examples + name: examples + uid: doctest.DocTest.examples +- fullName: doctest.DocTest.filename + href: https://docs.python.org/3/library/doctest.html#doctest.DocTest.filename + name: filename + uid: doctest.DocTest.filename +- fullName: doctest.DocTest.globs + href: https://docs.python.org/3/library/doctest.html#doctest.DocTest.globs + name: globs + uid: doctest.DocTest.globs +- fullName: doctest.DocTest.lineno + href: https://docs.python.org/3/library/doctest.html#doctest.DocTest.lineno + name: lineno + uid: doctest.DocTest.lineno +- fullName: doctest.DocTest.name + href: https://docs.python.org/3/library/doctest.html#doctest.DocTest.name + name: name + uid: doctest.DocTest.name +- fullName: doctest.DocTestFailure.example + href: https://docs.python.org/3/library/doctest.html#doctest.DocTestFailure.example + name: example + uid: doctest.DocTestFailure.example +- fullName: doctest.DocTestFailure.got + href: https://docs.python.org/3/library/doctest.html#doctest.DocTestFailure.got + name: got + uid: doctest.DocTestFailure.got +- fullName: doctest.DocTestFailure.test + href: https://docs.python.org/3/library/doctest.html#doctest.DocTestFailure.test + name: test + uid: doctest.DocTestFailure.test +- fullName: doctest.DocTestRunner.failures + href: https://docs.python.org/3/library/doctest.html#doctest.DocTestRunner.failures + name: failures + uid: doctest.DocTestRunner.failures +- fullName: doctest.DocTestRunner.skips + href: https://docs.python.org/3/library/doctest.html#doctest.DocTestRunner.skips + name: skips + uid: doctest.DocTestRunner.skips +- fullName: doctest.DocTestRunner.tries + href: https://docs.python.org/3/library/doctest.html#doctest.DocTestRunner.tries + name: tries + uid: doctest.DocTestRunner.tries +- fullName: doctest.Example.exc_msg + href: https://docs.python.org/3/library/doctest.html#doctest.Example.exc_msg + name: exc_msg + uid: doctest.Example.exc_msg +- fullName: doctest.Example.indent + href: https://docs.python.org/3/library/doctest.html#doctest.Example.indent + name: indent + uid: doctest.Example.indent +- fullName: doctest.Example.lineno + href: https://docs.python.org/3/library/doctest.html#doctest.Example.lineno + name: lineno + uid: doctest.Example.lineno +- fullName: doctest.Example.options + href: https://docs.python.org/3/library/doctest.html#doctest.Example.options + name: options + uid: doctest.Example.options +- fullName: doctest.Example.source + href: https://docs.python.org/3/library/doctest.html#doctest.Example.source + name: source + uid: doctest.Example.source +- fullName: doctest.Example.want + href: https://docs.python.org/3/library/doctest.html#doctest.Example.want + name: want + uid: doctest.Example.want +- fullName: doctest.TestResults.attempted + href: https://docs.python.org/3/library/doctest.html#doctest.TestResults.attempted + name: attempted + uid: doctest.TestResults.attempted +- fullName: doctest.TestResults.failed + href: https://docs.python.org/3/library/doctest.html#doctest.TestResults.failed + name: failed + uid: doctest.TestResults.failed +- fullName: doctest.TestResults.skipped + href: https://docs.python.org/3/library/doctest.html#doctest.TestResults.skipped + name: skipped + uid: doctest.TestResults.skipped +- fullName: doctest.UnexpectedException.example + href: https://docs.python.org/3/library/doctest.html#doctest.UnexpectedException.example + name: example + uid: doctest.UnexpectedException.example +- fullName: doctest.UnexpectedException.exc_info + href: https://docs.python.org/3/library/doctest.html#doctest.UnexpectedException.exc_info + name: exc_info + uid: doctest.UnexpectedException.exc_info +- fullName: doctest.UnexpectedException.test + href: https://docs.python.org/3/library/doctest.html#doctest.UnexpectedException.test + name: test + uid: doctest.UnexpectedException.test +- fullName: email.charset.Charset.body_encoding + href: https://docs.python.org/3/library/email.charset.html#email.charset.Charset.body_encoding + name: body_encoding + uid: email.charset.Charset.body_encoding +- fullName: email.charset.Charset.header_encoding + href: https://docs.python.org/3/library/email.charset.html#email.charset.Charset.header_encoding + name: header_encoding + uid: email.charset.Charset.header_encoding +- fullName: email.charset.Charset.input_charset + href: https://docs.python.org/3/library/email.charset.html#email.charset.Charset.input_charset + name: input_charset + uid: email.charset.Charset.input_charset +- fullName: email.charset.Charset.input_codec + href: https://docs.python.org/3/library/email.charset.html#email.charset.Charset.input_codec + name: input_codec + uid: email.charset.Charset.input_codec +- fullName: email.charset.Charset.output_charset + href: https://docs.python.org/3/library/email.charset.html#email.charset.Charset.output_charset + name: output_charset + uid: email.charset.Charset.output_charset +- fullName: email.charset.Charset.output_codec + href: https://docs.python.org/3/library/email.charset.html#email.charset.Charset.output_codec + name: output_codec + uid: email.charset.Charset.output_codec +- fullName: email.headerregistry.Address.addr_spec + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.Address.addr_spec + name: addr_spec + uid: email.headerregistry.Address.addr_spec +- fullName: email.headerregistry.Address.display_name + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.Address.display_name + name: display_name + uid: email.headerregistry.Address.display_name +- fullName: email.headerregistry.Address.domain + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.Address.domain + name: domain + uid: email.headerregistry.Address.domain +- fullName: email.headerregistry.Address.username + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.Address.username + name: username + uid: email.headerregistry.Address.username +- fullName: email.headerregistry.AddressHeader.addresses + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.AddressHeader.addresses + name: addresses + uid: email.headerregistry.AddressHeader.addresses +- fullName: email.headerregistry.AddressHeader.groups + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.AddressHeader.groups + name: groups + uid: email.headerregistry.AddressHeader.groups +- fullName: email.headerregistry.BaseHeader.defects + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.BaseHeader.defects + name: defects + uid: email.headerregistry.BaseHeader.defects +- fullName: email.headerregistry.BaseHeader.max_count + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.BaseHeader.max_count + name: max_count + uid: email.headerregistry.BaseHeader.max_count +- fullName: email.headerregistry.BaseHeader.name + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.BaseHeader.name + name: name + uid: email.headerregistry.BaseHeader.name +- fullName: email.headerregistry.ContentDispositionHeader.content_disposition + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.ContentDispositionHeader.content_disposition + name: content_disposition + uid: email.headerregistry.ContentDispositionHeader.content_disposition +- fullName: email.headerregistry.ContentTransferEncoding.cte + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.ContentTransferEncoding.cte + name: cte + uid: email.headerregistry.ContentTransferEncoding.cte +- fullName: email.headerregistry.ContentTypeHeader.content_type + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.ContentTypeHeader.content_type + name: content_type + uid: email.headerregistry.ContentTypeHeader.content_type +- fullName: email.headerregistry.ContentTypeHeader.maintype + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.ContentTypeHeader.maintype + name: maintype + uid: email.headerregistry.ContentTypeHeader.maintype +- fullName: email.headerregistry.ContentTypeHeader.subtype + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.ContentTypeHeader.subtype + name: subtype + uid: email.headerregistry.ContentTypeHeader.subtype +- fullName: email.headerregistry.DateHeader.datetime + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.DateHeader.datetime + name: datetime + uid: email.headerregistry.DateHeader.datetime +- fullName: email.headerregistry.Group.addresses + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.Group.addresses + name: addresses + uid: email.headerregistry.Group.addresses +- fullName: email.headerregistry.Group.display_name + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.Group.display_name + name: display_name + uid: email.headerregistry.Group.display_name +- fullName: email.headerregistry.MIMEVersionHeader.major + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.MIMEVersionHeader.major + name: major + uid: email.headerregistry.MIMEVersionHeader.major +- fullName: email.headerregistry.MIMEVersionHeader.minor + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.MIMEVersionHeader.minor + name: minor + uid: email.headerregistry.MIMEVersionHeader.minor +- fullName: email.headerregistry.MIMEVersionHeader.version + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.MIMEVersionHeader.version + name: version + uid: email.headerregistry.MIMEVersionHeader.version +- fullName: email.headerregistry.ParameterizedMIMEHeader.params + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.ParameterizedMIMEHeader.params + name: params + uid: email.headerregistry.ParameterizedMIMEHeader.params +- fullName: email.headerregistry.SingleAddressHeader.address + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.SingleAddressHeader.address + name: address + uid: email.headerregistry.SingleAddressHeader.address +- fullName: email.message.EmailMessage.defects + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.defects + name: defects + uid: email.message.EmailMessage.defects +- fullName: email.message.EmailMessage.epilogue + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.epilogue + name: epilogue + uid: email.message.EmailMessage.epilogue +- fullName: email.message.EmailMessage.preamble + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.preamble + name: preamble + uid: email.message.EmailMessage.preamble +- fullName: email.message.Message.defects + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.defects + name: defects + uid: email.message.Message.defects +- fullName: email.message.Message.epilogue + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.epilogue + name: epilogue + uid: email.message.Message.epilogue +- fullName: email.message.Message.preamble + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.preamble + name: preamble + uid: email.message.Message.preamble +- fullName: email.policy.Compat32.mangle_from_ + href: https://docs.python.org/3/library/email.policy.html#email.policy.Compat32.mangle_from_ + name: mangle_from_ + uid: email.policy.Compat32.mangle_from_ +- fullName: email.policy.EmailPolicy.content_manager + href: https://docs.python.org/3/library/email.policy.html#email.policy.EmailPolicy.content_manager + name: content_manager + uid: email.policy.EmailPolicy.content_manager +- fullName: email.policy.EmailPolicy.header_factory + href: https://docs.python.org/3/library/email.policy.html#email.policy.EmailPolicy.header_factory + name: header_factory + uid: email.policy.EmailPolicy.header_factory +- fullName: email.policy.EmailPolicy.refold_source + href: https://docs.python.org/3/library/email.policy.html#email.policy.EmailPolicy.refold_source + name: refold_source + uid: email.policy.EmailPolicy.refold_source +- fullName: email.policy.EmailPolicy.utf8 + href: https://docs.python.org/3/library/email.policy.html#email.policy.EmailPolicy.utf8 + name: utf8 + uid: email.policy.EmailPolicy.utf8 +- fullName: email.policy.Policy.cte_type + href: https://docs.python.org/3/library/email.policy.html#email.policy.Policy.cte_type + name: cte_type + uid: email.policy.Policy.cte_type +- fullName: email.policy.Policy.linesep + href: https://docs.python.org/3/library/email.policy.html#email.policy.Policy.linesep + name: linesep + uid: email.policy.Policy.linesep +- fullName: email.policy.Policy.mangle_from_ + href: https://docs.python.org/3/library/email.policy.html#email.policy.Policy.mangle_from_ + name: mangle_from_ + uid: email.policy.Policy.mangle_from_ +- fullName: email.policy.Policy.max_line_length + href: https://docs.python.org/3/library/email.policy.html#email.policy.Policy.max_line_length + name: max_line_length + uid: email.policy.Policy.max_line_length +- fullName: email.policy.Policy.message_factory + href: https://docs.python.org/3/library/email.policy.html#email.policy.Policy.message_factory + name: message_factory + uid: email.policy.Policy.message_factory +- fullName: email.policy.Policy.raise_on_defect + href: https://docs.python.org/3/library/email.policy.html#email.policy.Policy.raise_on_defect + name: raise_on_defect + uid: email.policy.Policy.raise_on_defect +- fullName: email.policy.Policy.verify_generated_headers + href: https://docs.python.org/3/library/email.policy.html#email.policy.Policy.verify_generated_headers + name: verify_generated_headers + uid: email.policy.Policy.verify_generated_headers +- fullName: enum.Enum._ignore_ + href: https://docs.python.org/3/library/enum.html#enum.Enum._ignore_ + name: _ignore_ + uid: enum.Enum._ignore_ +- fullName: enum.Enum._name_ + href: https://docs.python.org/3/library/enum.html#enum.Enum._name_ + name: _name_ + uid: enum.Enum._name_ +- fullName: enum.Enum._order_ + href: https://docs.python.org/3/library/enum.html#enum.Enum._order_ + name: _order_ + uid: enum.Enum._order_ +- fullName: enum.Enum._value_ + href: https://docs.python.org/3/library/enum.html#enum.Enum._value_ + name: _value_ + uid: enum.Enum._value_ +- fullName: enum.Enum.name + href: https://docs.python.org/3/library/enum.html#enum.Enum.name + name: name + uid: enum.Enum.name +- fullName: enum.Enum.value + href: https://docs.python.org/3/library/enum.html#enum.Enum.value + name: value + uid: enum.Enum.value +- fullName: enum.EnumCheck.CONTINUOUS + href: https://docs.python.org/3/library/enum.html#enum.EnumCheck.CONTINUOUS + name: CONTINUOUS + uid: enum.EnumCheck.CONTINUOUS +- fullName: enum.EnumCheck.NAMED_FLAGS + href: https://docs.python.org/3/library/enum.html#enum.EnumCheck.NAMED_FLAGS + name: NAMED_FLAGS + uid: enum.EnumCheck.NAMED_FLAGS +- fullName: enum.EnumCheck.UNIQUE + href: https://docs.python.org/3/library/enum.html#enum.EnumCheck.UNIQUE + name: UNIQUE + uid: enum.EnumCheck.UNIQUE +- fullName: enum.EnumDict.member_names + href: https://docs.python.org/3/library/enum.html#enum.EnumDict.member_names + name: member_names + uid: enum.EnumDict.member_names +- fullName: enum.EnumType.__members__ + href: https://docs.python.org/3/library/enum.html#enum.EnumType.__members__ + name: __members__ + uid: enum.EnumType.__members__ +- fullName: enum.FlagBoundary.CONFORM + href: https://docs.python.org/3/library/enum.html#enum.FlagBoundary.CONFORM + name: CONFORM + uid: enum.FlagBoundary.CONFORM +- fullName: enum.FlagBoundary.EJECT + href: https://docs.python.org/3/library/enum.html#enum.FlagBoundary.EJECT + name: EJECT + uid: enum.FlagBoundary.EJECT +- fullName: enum.FlagBoundary.KEEP + href: https://docs.python.org/3/library/enum.html#enum.FlagBoundary.KEEP + name: KEEP + uid: enum.FlagBoundary.KEEP +- fullName: enum.FlagBoundary.STRICT + href: https://docs.python.org/3/library/enum.html#enum.FlagBoundary.STRICT + name: STRICT + uid: enum.FlagBoundary.STRICT +- fullName: filecmp.dircmp.common + href: https://docs.python.org/3/library/filecmp.html#filecmp.dircmp.common + name: common + uid: filecmp.dircmp.common +- fullName: filecmp.dircmp.common_dirs + href: https://docs.python.org/3/library/filecmp.html#filecmp.dircmp.common_dirs + name: common_dirs + uid: filecmp.dircmp.common_dirs +- fullName: filecmp.dircmp.common_files + href: https://docs.python.org/3/library/filecmp.html#filecmp.dircmp.common_files + name: common_files + uid: filecmp.dircmp.common_files +- fullName: filecmp.dircmp.common_funny + href: https://docs.python.org/3/library/filecmp.html#filecmp.dircmp.common_funny + name: common_funny + uid: filecmp.dircmp.common_funny +- fullName: filecmp.dircmp.diff_files + href: https://docs.python.org/3/library/filecmp.html#filecmp.dircmp.diff_files + name: diff_files + uid: filecmp.dircmp.diff_files +- fullName: filecmp.dircmp.funny_files + href: https://docs.python.org/3/library/filecmp.html#filecmp.dircmp.funny_files + name: funny_files + uid: filecmp.dircmp.funny_files +- fullName: filecmp.dircmp.left + href: https://docs.python.org/3/library/filecmp.html#filecmp.dircmp.left + name: left + uid: filecmp.dircmp.left +- fullName: filecmp.dircmp.left_list + href: https://docs.python.org/3/library/filecmp.html#filecmp.dircmp.left_list + name: left_list + uid: filecmp.dircmp.left_list +- fullName: filecmp.dircmp.left_only + href: https://docs.python.org/3/library/filecmp.html#filecmp.dircmp.left_only + name: left_only + uid: filecmp.dircmp.left_only +- fullName: filecmp.dircmp.right + href: https://docs.python.org/3/library/filecmp.html#filecmp.dircmp.right + name: right + uid: filecmp.dircmp.right +- fullName: filecmp.dircmp.right_list + href: https://docs.python.org/3/library/filecmp.html#filecmp.dircmp.right_list + name: right_list + uid: filecmp.dircmp.right_list +- fullName: filecmp.dircmp.right_only + href: https://docs.python.org/3/library/filecmp.html#filecmp.dircmp.right_only + name: right_only + uid: filecmp.dircmp.right_only +- fullName: filecmp.dircmp.same_files + href: https://docs.python.org/3/library/filecmp.html#filecmp.dircmp.same_files + name: same_files + uid: filecmp.dircmp.same_files +- fullName: filecmp.dircmp.subdirs + href: https://docs.python.org/3/library/filecmp.html#filecmp.dircmp.subdirs + name: subdirs + uid: filecmp.dircmp.subdirs +- fullName: fractions.Fraction.denominator + href: https://docs.python.org/3/library/fractions.html#fractions.Fraction.denominator + name: denominator + uid: fractions.Fraction.denominator +- fullName: fractions.Fraction.numerator + href: https://docs.python.org/3/library/fractions.html#fractions.Fraction.numerator + name: numerator + uid: fractions.Fraction.numerator +- fullName: frame.f_back + href: https://docs.python.org/3/reference/datamodel.html#frame.f_back + name: f_back + uid: frame.f_back +- fullName: frame.f_builtins + href: https://docs.python.org/3/reference/datamodel.html#frame.f_builtins + name: f_builtins + uid: frame.f_builtins +- fullName: frame.f_code + href: https://docs.python.org/3/reference/datamodel.html#frame.f_code + name: f_code + uid: frame.f_code +- fullName: frame.f_globals + href: https://docs.python.org/3/reference/datamodel.html#frame.f_globals + name: f_globals + uid: frame.f_globals +- fullName: frame.f_lasti + href: https://docs.python.org/3/reference/datamodel.html#frame.f_lasti + name: f_lasti + uid: frame.f_lasti +- fullName: frame.f_lineno + href: https://docs.python.org/3/reference/datamodel.html#frame.f_lineno + name: f_lineno + uid: frame.f_lineno +- fullName: frame.f_locals + href: https://docs.python.org/3/reference/datamodel.html#frame.f_locals + name: f_locals + uid: frame.f_locals +- fullName: frame.f_trace + href: https://docs.python.org/3/reference/datamodel.html#frame.f_trace + name: f_trace + uid: frame.f_trace +- fullName: frame.f_trace_lines + href: https://docs.python.org/3/reference/datamodel.html#frame.f_trace_lines + name: f_trace_lines + uid: frame.f_trace_lines +- fullName: frame.f_trace_opcodes + href: https://docs.python.org/3/reference/datamodel.html#frame.f_trace_opcodes + name: f_trace_opcodes + uid: frame.f_trace_opcodes +- fullName: ftplib.FTP_TLS.ssl_version + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP_TLS.ssl_version + name: ssl_version + uid: ftplib.FTP_TLS.ssl_version +- fullName: function.__annotations__ + href: https://docs.python.org/3/reference/datamodel.html#function.__annotations__ + name: __annotations__ + uid: function.__annotations__ +- fullName: function.__closure__ + href: https://docs.python.org/3/reference/datamodel.html#function.__closure__ + name: __closure__ + uid: function.__closure__ +- fullName: function.__code__ + href: https://docs.python.org/3/reference/datamodel.html#function.__code__ + name: __code__ + uid: function.__code__ +- fullName: function.__defaults__ + href: https://docs.python.org/3/reference/datamodel.html#function.__defaults__ + name: __defaults__ + uid: function.__defaults__ +- fullName: function.__dict__ + href: https://docs.python.org/3/reference/datamodel.html#function.__dict__ + name: __dict__ + uid: function.__dict__ +- fullName: function.__doc__ + href: https://docs.python.org/3/reference/datamodel.html#function.__doc__ + name: __doc__ + uid: function.__doc__ +- fullName: function.__globals__ + href: https://docs.python.org/3/reference/datamodel.html#function.__globals__ + name: __globals__ + uid: function.__globals__ +- fullName: function.__kwdefaults__ + href: https://docs.python.org/3/reference/datamodel.html#function.__kwdefaults__ + name: __kwdefaults__ + uid: function.__kwdefaults__ +- fullName: function.__module__ + href: https://docs.python.org/3/reference/datamodel.html#function.__module__ + name: __module__ + uid: function.__module__ +- fullName: function.__name__ + href: https://docs.python.org/3/reference/datamodel.html#function.__name__ + name: __name__ + uid: function.__name__ +- fullName: function.__qualname__ + href: https://docs.python.org/3/reference/datamodel.html#function.__qualname__ + name: __qualname__ + uid: function.__qualname__ +- fullName: function.__type_params__ + href: https://docs.python.org/3/reference/datamodel.html#function.__type_params__ + name: __type_params__ + uid: function.__type_params__ +- fullName: functools.partial.args + href: https://docs.python.org/3/library/functools.html#functools.partial.args + name: args + uid: functools.partial.args +- fullName: functools.partial.func + href: https://docs.python.org/3/library/functools.html#functools.partial.func + name: func + uid: functools.partial.func +- fullName: functools.partial.keywords + href: https://docs.python.org/3/library/functools.html#functools.partial.keywords + name: keywords + uid: functools.partial.keywords +- fullName: genericalias.__args__ + href: https://docs.python.org/3/library/stdtypes.html#genericalias.__args__ + name: __args__ + uid: genericalias.__args__ +- fullName: genericalias.__origin__ + href: https://docs.python.org/3/library/stdtypes.html#genericalias.__origin__ + name: __origin__ + uid: genericalias.__origin__ +- fullName: genericalias.__parameters__ + href: https://docs.python.org/3/library/stdtypes.html#genericalias.__parameters__ + name: __parameters__ + uid: genericalias.__parameters__ +- fullName: genericalias.__unpacked__ + href: https://docs.python.org/3/library/stdtypes.html#genericalias.__unpacked__ + name: __unpacked__ + uid: genericalias.__unpacked__ +- fullName: gzip.GzipFile.mode + href: https://docs.python.org/3/library/gzip.html#gzip.GzipFile.mode + name: mode + uid: gzip.GzipFile.mode +- fullName: gzip.GzipFile.mtime + href: https://docs.python.org/3/library/gzip.html#gzip.GzipFile.mtime + name: mtime + uid: gzip.GzipFile.mtime +- fullName: gzip.GzipFile.name + href: https://docs.python.org/3/library/gzip.html#gzip.GzipFile.name + name: name + uid: gzip.GzipFile.name +- fullName: hashlib.hash.name + href: https://docs.python.org/3/library/hashlib.html#hashlib.hash.name + name: name + uid: hashlib.hash.name +- fullName: hmac.HMAC.block_size + href: https://docs.python.org/3/library/hmac.html#hmac.HMAC.block_size + name: block_size + uid: hmac.HMAC.block_size +- fullName: hmac.HMAC.digest_size + href: https://docs.python.org/3/library/hmac.html#hmac.HMAC.digest_size + name: digest_size + uid: hmac.HMAC.digest_size +- fullName: hmac.HMAC.name + href: https://docs.python.org/3/library/hmac.html#hmac.HMAC.name + name: name + uid: hmac.HMAC.name +- fullName: http.client.HTTPConnection.blocksize + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPConnection.blocksize + name: blocksize + uid: http.client.HTTPConnection.blocksize +- fullName: http.client.HTTPResponse.closed + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPResponse.closed + name: closed + uid: http.client.HTTPResponse.closed +- fullName: http.client.HTTPResponse.debuglevel + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPResponse.debuglevel + name: debuglevel + uid: http.client.HTTPResponse.debuglevel +- fullName: http.client.HTTPResponse.headers + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPResponse.headers + name: headers + uid: http.client.HTTPResponse.headers +- fullName: http.client.HTTPResponse.msg + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPResponse.msg + name: msg + uid: http.client.HTTPResponse.msg +- fullName: http.client.HTTPResponse.reason + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPResponse.reason + name: reason + uid: http.client.HTTPResponse.reason +- fullName: http.client.HTTPResponse.status + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPResponse.status + name: status + uid: http.client.HTTPResponse.status +- fullName: http.client.HTTPResponse.url + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPResponse.url + name: url + uid: http.client.HTTPResponse.url +- fullName: http.client.HTTPResponse.version + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPResponse.version + name: version + uid: http.client.HTTPResponse.version +- fullName: http.cookiejar.Cookie.comment + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.Cookie.comment + name: comment + uid: http.cookiejar.Cookie.comment +- fullName: http.cookiejar.Cookie.comment_url + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.Cookie.comment_url + name: comment_url + uid: http.cookiejar.Cookie.comment_url +- fullName: http.cookiejar.Cookie.discard + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.Cookie.discard + name: discard + uid: http.cookiejar.Cookie.discard +- fullName: http.cookiejar.Cookie.domain + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.Cookie.domain + name: domain + uid: http.cookiejar.Cookie.domain +- fullName: http.cookiejar.Cookie.domain_initial_dot + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.Cookie.domain_initial_dot + name: domain_initial_dot + uid: http.cookiejar.Cookie.domain_initial_dot +- fullName: http.cookiejar.Cookie.domain_specified + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.Cookie.domain_specified + name: domain_specified + uid: http.cookiejar.Cookie.domain_specified +- fullName: http.cookiejar.Cookie.expires + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.Cookie.expires + name: expires + uid: http.cookiejar.Cookie.expires +- fullName: http.cookiejar.Cookie.name + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.Cookie.name + name: name + uid: http.cookiejar.Cookie.name +- fullName: http.cookiejar.Cookie.path + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.Cookie.path + name: path + uid: http.cookiejar.Cookie.path +- fullName: http.cookiejar.Cookie.port + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.Cookie.port + name: port + uid: http.cookiejar.Cookie.port +- fullName: http.cookiejar.Cookie.port_specified + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.Cookie.port_specified + name: port_specified + uid: http.cookiejar.Cookie.port_specified +- fullName: http.cookiejar.Cookie.rfc2109 + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.Cookie.rfc2109 + name: rfc2109 + uid: http.cookiejar.Cookie.rfc2109 +- fullName: http.cookiejar.Cookie.secure + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.Cookie.secure + name: secure + uid: http.cookiejar.Cookie.secure +- fullName: http.cookiejar.Cookie.value + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.Cookie.value + name: value + uid: http.cookiejar.Cookie.value +- fullName: http.cookiejar.Cookie.version + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.Cookie.version + name: version + uid: http.cookiejar.Cookie.version +- fullName: http.cookiejar.CookiePolicy.hide_cookie2 + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookiePolicy.hide_cookie2 + name: hide_cookie2 + uid: http.cookiejar.CookiePolicy.hide_cookie2 +- fullName: http.cookiejar.CookiePolicy.netscape + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookiePolicy.netscape + name: netscape + uid: http.cookiejar.CookiePolicy.netscape +- fullName: http.cookiejar.CookiePolicy.rfc2965 + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookiePolicy.rfc2965 + name: rfc2965 + uid: http.cookiejar.CookiePolicy.rfc2965 +- fullName: http.cookiejar.DefaultCookiePolicy.DomainLiberal + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy.DomainLiberal + name: DomainLiberal + uid: http.cookiejar.DefaultCookiePolicy.DomainLiberal +- fullName: http.cookiejar.DefaultCookiePolicy.DomainRFC2965Match + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy.DomainRFC2965Match + name: DomainRFC2965Match + uid: http.cookiejar.DefaultCookiePolicy.DomainRFC2965Match +- fullName: http.cookiejar.DefaultCookiePolicy.DomainStrict + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy.DomainStrict + name: DomainStrict + uid: http.cookiejar.DefaultCookiePolicy.DomainStrict +- fullName: http.cookiejar.DefaultCookiePolicy.DomainStrictNoDots + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy.DomainStrictNoDots + name: DomainStrictNoDots + uid: http.cookiejar.DefaultCookiePolicy.DomainStrictNoDots +- fullName: http.cookiejar.DefaultCookiePolicy.DomainStrictNonDomain + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy.DomainStrictNonDomain + name: DomainStrictNonDomain + uid: http.cookiejar.DefaultCookiePolicy.DomainStrictNonDomain +- fullName: http.cookiejar.DefaultCookiePolicy.rfc2109_as_netscape + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy.rfc2109_as_netscape + name: rfc2109_as_netscape + uid: http.cookiejar.DefaultCookiePolicy.rfc2109_as_netscape +- fullName: http.cookiejar.DefaultCookiePolicy.strict_domain + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy.strict_domain + name: strict_domain + uid: http.cookiejar.DefaultCookiePolicy.strict_domain +- fullName: http.cookiejar.DefaultCookiePolicy.strict_ns_domain + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy.strict_ns_domain + name: strict_ns_domain + uid: http.cookiejar.DefaultCookiePolicy.strict_ns_domain +- fullName: http.cookiejar.DefaultCookiePolicy.strict_ns_set_initial_dollar + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy.strict_ns_set_initial_dollar + name: strict_ns_set_initial_dollar + uid: http.cookiejar.DefaultCookiePolicy.strict_ns_set_initial_dollar +- fullName: http.cookiejar.DefaultCookiePolicy.strict_ns_set_path + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy.strict_ns_set_path + name: strict_ns_set_path + uid: http.cookiejar.DefaultCookiePolicy.strict_ns_set_path +- fullName: http.cookiejar.DefaultCookiePolicy.strict_ns_unverifiable + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy.strict_ns_unverifiable + name: strict_ns_unverifiable + uid: http.cookiejar.DefaultCookiePolicy.strict_ns_unverifiable +- fullName: http.cookiejar.DefaultCookiePolicy.strict_rfc2965_unverifiable + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy.strict_rfc2965_unverifiable + name: strict_rfc2965_unverifiable + uid: http.cookiejar.DefaultCookiePolicy.strict_rfc2965_unverifiable +- fullName: http.cookiejar.FileCookieJar.delayload + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.FileCookieJar.delayload + name: delayload + uid: http.cookiejar.FileCookieJar.delayload +- fullName: http.cookiejar.FileCookieJar.filename + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.FileCookieJar.filename + name: filename + uid: http.cookiejar.FileCookieJar.filename +- fullName: http.cookies.Morsel.coded_value + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.Morsel.coded_value + name: coded_value + uid: http.cookies.Morsel.coded_value +- fullName: http.cookies.Morsel.comment + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.Morsel.comment + name: comment + uid: http.cookies.Morsel.comment +- fullName: http.cookies.Morsel.domain + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.Morsel.domain + name: domain + uid: http.cookies.Morsel.domain +- fullName: http.cookies.Morsel.expires + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.Morsel.expires + name: expires + uid: http.cookies.Morsel.expires +- fullName: http.cookies.Morsel.httponly + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.Morsel.httponly + name: httponly + uid: http.cookies.Morsel.httponly +- fullName: http.cookies.Morsel.key + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.Morsel.key + name: key + uid: http.cookies.Morsel.key +- fullName: http.cookies.Morsel.path + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.Morsel.path + name: path + uid: http.cookies.Morsel.path +- fullName: http.cookies.Morsel.samesite + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.Morsel.samesite + name: samesite + uid: http.cookies.Morsel.samesite +- fullName: http.cookies.Morsel.secure + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.Morsel.secure + name: secure + uid: http.cookies.Morsel.secure +- fullName: http.cookies.Morsel.value + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.Morsel.value + name: value + uid: http.cookies.Morsel.value +- fullName: http.cookies.Morsel.version + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.Morsel.version + name: version + uid: http.cookies.Morsel.version +- fullName: http.server.BaseHTTPRequestHandler.MessageClass + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.MessageClass + name: MessageClass + uid: http.server.BaseHTTPRequestHandler.MessageClass +- fullName: http.server.BaseHTTPRequestHandler.client_address + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.client_address + name: client_address + uid: http.server.BaseHTTPRequestHandler.client_address +- fullName: http.server.BaseHTTPRequestHandler.close_connection + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.close_connection + name: close_connection + uid: http.server.BaseHTTPRequestHandler.close_connection +- fullName: http.server.BaseHTTPRequestHandler.command + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.command + name: command + uid: http.server.BaseHTTPRequestHandler.command +- fullName: http.server.BaseHTTPRequestHandler.error_content_type + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.error_content_type + name: error_content_type + uid: http.server.BaseHTTPRequestHandler.error_content_type +- fullName: http.server.BaseHTTPRequestHandler.error_message_format + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.error_message_format + name: error_message_format + uid: http.server.BaseHTTPRequestHandler.error_message_format +- fullName: http.server.BaseHTTPRequestHandler.headers + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.headers + name: headers + uid: http.server.BaseHTTPRequestHandler.headers +- fullName: http.server.BaseHTTPRequestHandler.path + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.path + name: path + uid: http.server.BaseHTTPRequestHandler.path +- fullName: http.server.BaseHTTPRequestHandler.protocol_version + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.protocol_version + name: protocol_version + uid: http.server.BaseHTTPRequestHandler.protocol_version +- fullName: http.server.BaseHTTPRequestHandler.request_version + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.request_version + name: request_version + uid: http.server.BaseHTTPRequestHandler.request_version +- fullName: http.server.BaseHTTPRequestHandler.requestline + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.requestline + name: requestline + uid: http.server.BaseHTTPRequestHandler.requestline +- fullName: http.server.BaseHTTPRequestHandler.responses + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.responses + name: responses + uid: http.server.BaseHTTPRequestHandler.responses +- fullName: http.server.BaseHTTPRequestHandler.rfile + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.rfile + name: rfile + uid: http.server.BaseHTTPRequestHandler.rfile +- fullName: http.server.BaseHTTPRequestHandler.server + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.server + name: server + uid: http.server.BaseHTTPRequestHandler.server +- fullName: http.server.BaseHTTPRequestHandler.server_version + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.server_version + name: server_version + uid: http.server.BaseHTTPRequestHandler.server_version +- fullName: http.server.BaseHTTPRequestHandler.sys_version + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.sys_version + name: sys_version + uid: http.server.BaseHTTPRequestHandler.sys_version +- fullName: http.server.BaseHTTPRequestHandler.wfile + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.wfile + name: wfile + uid: http.server.BaseHTTPRequestHandler.wfile +- fullName: http.server.CGIHTTPRequestHandler.cgi_directories + href: https://docs.python.org/3/library/http.server.html#http.server.CGIHTTPRequestHandler.cgi_directories + name: cgi_directories + uid: http.server.CGIHTTPRequestHandler.cgi_directories +- fullName: http.server.SimpleHTTPRequestHandler.extensions_map + href: https://docs.python.org/3/library/http.server.html#http.server.SimpleHTTPRequestHandler.extensions_map + name: extensions_map + uid: http.server.SimpleHTTPRequestHandler.extensions_map +- fullName: http.server.SimpleHTTPRequestHandler.server_version + href: https://docs.python.org/3/library/http.server.html#http.server.SimpleHTTPRequestHandler.server_version + name: server_version + uid: http.server.SimpleHTTPRequestHandler.server_version +- fullName: imaplib.IMAP4.PROTOCOL_VERSION + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.PROTOCOL_VERSION + name: PROTOCOL_VERSION + uid: imaplib.IMAP4.PROTOCOL_VERSION +- fullName: imaplib.IMAP4.debug + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.debug + name: debug + uid: imaplib.IMAP4.debug +- fullName: imaplib.IMAP4.utf8_enabled + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.utf8_enabled + name: utf8_enabled + uid: imaplib.IMAP4.utf8_enabled +- fullName: importlib.abc.FileLoader.name + href: https://docs.python.org/3/library/importlib.html#importlib.abc.FileLoader.name + name: name + uid: importlib.abc.FileLoader.name +- fullName: importlib.abc.FileLoader.path + href: https://docs.python.org/3/library/importlib.html#importlib.abc.FileLoader.path + name: path + uid: importlib.abc.FileLoader.path +- fullName: importlib.abc.Traversable.name + href: https://docs.python.org/3/library/importlib.html#importlib.abc.Traversable.name + name: name + uid: importlib.abc.Traversable.name +- fullName: importlib.machinery.AppleFrameworkLoader.name + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.AppleFrameworkLoader.name + name: name + uid: importlib.machinery.AppleFrameworkLoader.name +- fullName: importlib.machinery.AppleFrameworkLoader.path + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.AppleFrameworkLoader.path + name: path + uid: importlib.machinery.AppleFrameworkLoader.path +- fullName: importlib.machinery.ExtensionFileLoader.name + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.ExtensionFileLoader.name + name: name + uid: importlib.machinery.ExtensionFileLoader.name +- fullName: importlib.machinery.ExtensionFileLoader.path + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.ExtensionFileLoader.path + name: path + uid: importlib.machinery.ExtensionFileLoader.path +- fullName: importlib.machinery.FileFinder.path + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.FileFinder.path + name: path + uid: importlib.machinery.FileFinder.path +- fullName: importlib.machinery.ModuleSpec.cached + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.ModuleSpec.cached + name: cached + uid: importlib.machinery.ModuleSpec.cached +- fullName: importlib.machinery.ModuleSpec.has_location + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.ModuleSpec.has_location + name: has_location + uid: importlib.machinery.ModuleSpec.has_location +- fullName: importlib.machinery.ModuleSpec.loader + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.ModuleSpec.loader + name: loader + uid: importlib.machinery.ModuleSpec.loader +- fullName: importlib.machinery.ModuleSpec.loader_state + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.ModuleSpec.loader_state + name: loader_state + uid: importlib.machinery.ModuleSpec.loader_state +- fullName: importlib.machinery.ModuleSpec.name + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.ModuleSpec.name + name: name + uid: importlib.machinery.ModuleSpec.name +- fullName: importlib.machinery.ModuleSpec.origin + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.ModuleSpec.origin + name: origin + uid: importlib.machinery.ModuleSpec.origin +- fullName: importlib.machinery.ModuleSpec.parent + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.ModuleSpec.parent + name: parent + uid: importlib.machinery.ModuleSpec.parent +- fullName: importlib.machinery.ModuleSpec.submodule_search_locations + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.ModuleSpec.submodule_search_locations + name: submodule_search_locations + uid: importlib.machinery.ModuleSpec.submodule_search_locations +- fullName: importlib.machinery.SourceFileLoader.name + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.SourceFileLoader.name + name: name + uid: importlib.machinery.SourceFileLoader.name +- fullName: importlib.machinery.SourceFileLoader.path + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.SourceFileLoader.path + name: path + uid: importlib.machinery.SourceFileLoader.path +- fullName: importlib.machinery.SourcelessFileLoader.name + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.SourcelessFileLoader.name + name: name + uid: importlib.machinery.SourcelessFileLoader.name +- fullName: importlib.machinery.SourcelessFileLoader.path + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.SourcelessFileLoader.path + name: path + uid: importlib.machinery.SourcelessFileLoader.path +- fullName: importlib.resources.abc.Traversable.name + href: https://docs.python.org/3/library/importlib.resources.abc.html#importlib.resources.abc.Traversable.name + name: name + uid: importlib.resources.abc.Traversable.name +- fullName: inspect.BoundArguments.args + href: https://docs.python.org/3/library/inspect.html#inspect.BoundArguments.args + name: args + uid: inspect.BoundArguments.args +- fullName: inspect.BoundArguments.arguments + href: https://docs.python.org/3/library/inspect.html#inspect.BoundArguments.arguments + name: arguments + uid: inspect.BoundArguments.arguments +- fullName: inspect.BoundArguments.kwargs + href: https://docs.python.org/3/library/inspect.html#inspect.BoundArguments.kwargs + name: kwargs + uid: inspect.BoundArguments.kwargs +- fullName: inspect.BoundArguments.signature + href: https://docs.python.org/3/library/inspect.html#inspect.BoundArguments.signature + name: signature + uid: inspect.BoundArguments.signature +- fullName: inspect.BufferFlags.ANY_CONTIGUOUS + href: https://docs.python.org/3/library/inspect.html#inspect.BufferFlags.ANY_CONTIGUOUS + name: ANY_CONTIGUOUS + uid: inspect.BufferFlags.ANY_CONTIGUOUS +- fullName: inspect.BufferFlags.CONTIG + href: https://docs.python.org/3/library/inspect.html#inspect.BufferFlags.CONTIG + name: CONTIG + uid: inspect.BufferFlags.CONTIG +- fullName: inspect.BufferFlags.CONTIG_RO + href: https://docs.python.org/3/library/inspect.html#inspect.BufferFlags.CONTIG_RO + name: CONTIG_RO + uid: inspect.BufferFlags.CONTIG_RO +- fullName: inspect.BufferFlags.C_CONTIGUOUS + href: https://docs.python.org/3/library/inspect.html#inspect.BufferFlags.C_CONTIGUOUS + name: C_CONTIGUOUS + uid: inspect.BufferFlags.C_CONTIGUOUS +- fullName: inspect.BufferFlags.FORMAT + href: https://docs.python.org/3/library/inspect.html#inspect.BufferFlags.FORMAT + name: FORMAT + uid: inspect.BufferFlags.FORMAT +- fullName: inspect.BufferFlags.FULL + href: https://docs.python.org/3/library/inspect.html#inspect.BufferFlags.FULL + name: FULL + uid: inspect.BufferFlags.FULL +- fullName: inspect.BufferFlags.FULL_RO + href: https://docs.python.org/3/library/inspect.html#inspect.BufferFlags.FULL_RO + name: FULL_RO + uid: inspect.BufferFlags.FULL_RO +- fullName: inspect.BufferFlags.F_CONTIGUOUS + href: https://docs.python.org/3/library/inspect.html#inspect.BufferFlags.F_CONTIGUOUS + name: F_CONTIGUOUS + uid: inspect.BufferFlags.F_CONTIGUOUS +- fullName: inspect.BufferFlags.INDIRECT + href: https://docs.python.org/3/library/inspect.html#inspect.BufferFlags.INDIRECT + name: INDIRECT + uid: inspect.BufferFlags.INDIRECT +- fullName: inspect.BufferFlags.ND + href: https://docs.python.org/3/library/inspect.html#inspect.BufferFlags.ND + name: ND + uid: inspect.BufferFlags.ND +- fullName: inspect.BufferFlags.READ + href: https://docs.python.org/3/library/inspect.html#inspect.BufferFlags.READ + name: READ + uid: inspect.BufferFlags.READ +- fullName: inspect.BufferFlags.RECORDS + href: https://docs.python.org/3/library/inspect.html#inspect.BufferFlags.RECORDS + name: RECORDS + uid: inspect.BufferFlags.RECORDS +- fullName: inspect.BufferFlags.RECORDS_RO + href: https://docs.python.org/3/library/inspect.html#inspect.BufferFlags.RECORDS_RO + name: RECORDS_RO + uid: inspect.BufferFlags.RECORDS_RO +- fullName: inspect.BufferFlags.SIMPLE + href: https://docs.python.org/3/library/inspect.html#inspect.BufferFlags.SIMPLE + name: SIMPLE + uid: inspect.BufferFlags.SIMPLE +- fullName: inspect.BufferFlags.STRIDED + href: https://docs.python.org/3/library/inspect.html#inspect.BufferFlags.STRIDED + name: STRIDED + uid: inspect.BufferFlags.STRIDED +- fullName: inspect.BufferFlags.STRIDED_RO + href: https://docs.python.org/3/library/inspect.html#inspect.BufferFlags.STRIDED_RO + name: STRIDED_RO + uid: inspect.BufferFlags.STRIDED_RO +- fullName: inspect.BufferFlags.STRIDES + href: https://docs.python.org/3/library/inspect.html#inspect.BufferFlags.STRIDES + name: STRIDES + uid: inspect.BufferFlags.STRIDES +- fullName: inspect.BufferFlags.WRITABLE + href: https://docs.python.org/3/library/inspect.html#inspect.BufferFlags.WRITABLE + name: WRITABLE + uid: inspect.BufferFlags.WRITABLE +- fullName: inspect.BufferFlags.WRITE + href: https://docs.python.org/3/library/inspect.html#inspect.BufferFlags.WRITE + name: WRITE + uid: inspect.BufferFlags.WRITE +- fullName: inspect.FrameInfo.code_context + href: https://docs.python.org/3/library/inspect.html#inspect.FrameInfo.code_context + name: code_context + uid: inspect.FrameInfo.code_context +- fullName: inspect.FrameInfo.filename + href: https://docs.python.org/3/library/inspect.html#inspect.FrameInfo.filename + name: filename + uid: inspect.FrameInfo.filename +- fullName: inspect.FrameInfo.frame + href: https://docs.python.org/3/library/inspect.html#inspect.FrameInfo.frame + name: frame + uid: inspect.FrameInfo.frame +- fullName: inspect.FrameInfo.function + href: https://docs.python.org/3/library/inspect.html#inspect.FrameInfo.function + name: function + uid: inspect.FrameInfo.function +- fullName: inspect.FrameInfo.index + href: https://docs.python.org/3/library/inspect.html#inspect.FrameInfo.index + name: index + uid: inspect.FrameInfo.index +- fullName: inspect.FrameInfo.lineno + href: https://docs.python.org/3/library/inspect.html#inspect.FrameInfo.lineno + name: lineno + uid: inspect.FrameInfo.lineno +- fullName: inspect.FrameInfo.positions + href: https://docs.python.org/3/library/inspect.html#inspect.FrameInfo.positions + name: positions + uid: inspect.FrameInfo.positions +- fullName: inspect.Parameter.annotation + href: https://docs.python.org/3/library/inspect.html#inspect.Parameter.annotation + name: annotation + uid: inspect.Parameter.annotation +- fullName: inspect.Parameter.default + href: https://docs.python.org/3/library/inspect.html#inspect.Parameter.default + name: default + uid: inspect.Parameter.default +- fullName: inspect.Parameter.empty + href: https://docs.python.org/3/library/inspect.html#inspect.Parameter.empty + name: empty + uid: inspect.Parameter.empty +- fullName: inspect.Parameter.kind + href: https://docs.python.org/3/library/inspect.html#inspect.Parameter.kind + name: kind + uid: inspect.Parameter.kind +- fullName: inspect.Parameter.kind.description + href: https://docs.python.org/3/library/inspect.html#inspect.Parameter.kind.description + name: description + uid: inspect.Parameter.kind.description +- fullName: inspect.Parameter.name + href: https://docs.python.org/3/library/inspect.html#inspect.Parameter.name + name: name + uid: inspect.Parameter.name +- fullName: inspect.Signature.empty + href: https://docs.python.org/3/library/inspect.html#inspect.Signature.empty + name: empty + uid: inspect.Signature.empty +- fullName: inspect.Signature.parameters + href: https://docs.python.org/3/library/inspect.html#inspect.Signature.parameters + name: parameters + uid: inspect.Signature.parameters +- fullName: inspect.Signature.return_annotation + href: https://docs.python.org/3/library/inspect.html#inspect.Signature.return_annotation + name: return_annotation + uid: inspect.Signature.return_annotation +- fullName: inspect.Traceback.code_context + href: https://docs.python.org/3/library/inspect.html#inspect.Traceback.code_context + name: code_context + uid: inspect.Traceback.code_context +- fullName: inspect.Traceback.filename + href: https://docs.python.org/3/library/inspect.html#inspect.Traceback.filename + name: filename + uid: inspect.Traceback.filename +- fullName: inspect.Traceback.function + href: https://docs.python.org/3/library/inspect.html#inspect.Traceback.function + name: function + uid: inspect.Traceback.function +- fullName: inspect.Traceback.index + href: https://docs.python.org/3/library/inspect.html#inspect.Traceback.index + name: index + uid: inspect.Traceback.index +- fullName: inspect.Traceback.lineno + href: https://docs.python.org/3/library/inspect.html#inspect.Traceback.lineno + name: lineno + uid: inspect.Traceback.lineno +- fullName: inspect.Traceback.positions + href: https://docs.python.org/3/library/inspect.html#inspect.Traceback.positions + name: positions + uid: inspect.Traceback.positions +- fullName: io.BufferedIOBase.raw + href: https://docs.python.org/3/library/io.html#io.BufferedIOBase.raw + name: raw + uid: io.BufferedIOBase.raw +- fullName: io.FileIO.mode + href: https://docs.python.org/3/library/io.html#io.FileIO.mode + name: mode + uid: io.FileIO.mode +- fullName: io.FileIO.name + href: https://docs.python.org/3/library/io.html#io.FileIO.name + name: name + uid: io.FileIO.name +- fullName: io.IOBase.closed + href: https://docs.python.org/3/library/io.html#io.IOBase.closed + name: closed + uid: io.IOBase.closed +- fullName: io.TextIOBase.buffer + href: https://docs.python.org/3/library/io.html#io.TextIOBase.buffer + name: buffer + uid: io.TextIOBase.buffer +- fullName: io.TextIOBase.encoding + href: https://docs.python.org/3/library/io.html#io.TextIOBase.encoding + name: encoding + uid: io.TextIOBase.encoding +- fullName: io.TextIOBase.errors + href: https://docs.python.org/3/library/io.html#io.TextIOBase.errors + name: errors + uid: io.TextIOBase.errors +- fullName: io.TextIOBase.newlines + href: https://docs.python.org/3/library/io.html#io.TextIOBase.newlines + name: newlines + uid: io.TextIOBase.newlines +- fullName: io.TextIOWrapper.line_buffering + href: https://docs.python.org/3/library/io.html#io.TextIOWrapper.line_buffering + name: line_buffering + uid: io.TextIOWrapper.line_buffering +- fullName: io.TextIOWrapper.write_through + href: https://docs.python.org/3/library/io.html#io.TextIOWrapper.write_through + name: write_through + uid: io.TextIOWrapper.write_through +- fullName: ipaddress.IPv4Address.compressed + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Address.compressed + name: compressed + uid: ipaddress.IPv4Address.compressed +- fullName: ipaddress.IPv4Address.exploded + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Address.exploded + name: exploded + uid: ipaddress.IPv4Address.exploded +- fullName: ipaddress.IPv4Address.ipv6_mapped + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Address.ipv6_mapped + name: ipv6_mapped + uid: ipaddress.IPv4Address.ipv6_mapped +- fullName: ipaddress.IPv4Address.is_global + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Address.is_global + name: is_global + uid: ipaddress.IPv4Address.is_global +- fullName: ipaddress.IPv4Address.is_link_local + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Address.is_link_local + name: is_link_local + uid: ipaddress.IPv4Address.is_link_local +- fullName: ipaddress.IPv4Address.is_loopback + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Address.is_loopback + name: is_loopback + uid: ipaddress.IPv4Address.is_loopback +- fullName: ipaddress.IPv4Address.is_multicast + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Address.is_multicast + name: is_multicast + uid: ipaddress.IPv4Address.is_multicast +- fullName: ipaddress.IPv4Address.is_private + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Address.is_private + name: is_private + uid: ipaddress.IPv4Address.is_private +- fullName: ipaddress.IPv4Address.is_reserved + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Address.is_reserved + name: is_reserved + uid: ipaddress.IPv4Address.is_reserved +- fullName: ipaddress.IPv4Address.is_unspecified + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Address.is_unspecified + name: is_unspecified + uid: ipaddress.IPv4Address.is_unspecified +- fullName: ipaddress.IPv4Address.max_prefixlen + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Address.max_prefixlen + name: max_prefixlen + uid: ipaddress.IPv4Address.max_prefixlen +- fullName: ipaddress.IPv4Address.packed + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Address.packed + name: packed + uid: ipaddress.IPv4Address.packed +- fullName: ipaddress.IPv4Address.reverse_pointer + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Address.reverse_pointer + name: reverse_pointer + uid: ipaddress.IPv4Address.reverse_pointer +- fullName: ipaddress.IPv4Address.version + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Address.version + name: version + uid: ipaddress.IPv4Address.version +- fullName: ipaddress.IPv4Interface.ip + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Interface.ip + name: ip + uid: ipaddress.IPv4Interface.ip +- fullName: ipaddress.IPv4Interface.network + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Interface.network + name: network + uid: ipaddress.IPv4Interface.network +- fullName: ipaddress.IPv4Interface.with_hostmask + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Interface.with_hostmask + name: with_hostmask + uid: ipaddress.IPv4Interface.with_hostmask +- fullName: ipaddress.IPv4Interface.with_netmask + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Interface.with_netmask + name: with_netmask + uid: ipaddress.IPv4Interface.with_netmask +- fullName: ipaddress.IPv4Interface.with_prefixlen + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Interface.with_prefixlen + name: with_prefixlen + uid: ipaddress.IPv4Interface.with_prefixlen +- fullName: ipaddress.IPv4Network.broadcast_address + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.broadcast_address + name: broadcast_address + uid: ipaddress.IPv4Network.broadcast_address +- fullName: ipaddress.IPv4Network.compressed + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.compressed + name: compressed + uid: ipaddress.IPv4Network.compressed +- fullName: ipaddress.IPv4Network.exploded + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.exploded + name: exploded + uid: ipaddress.IPv4Network.exploded +- fullName: ipaddress.IPv4Network.hostmask + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.hostmask + name: hostmask + uid: ipaddress.IPv4Network.hostmask +- fullName: ipaddress.IPv4Network.is_link_local + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.is_link_local + name: is_link_local + uid: ipaddress.IPv4Network.is_link_local +- fullName: ipaddress.IPv4Network.is_loopback + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.is_loopback + name: is_loopback + uid: ipaddress.IPv4Network.is_loopback +- fullName: ipaddress.IPv4Network.is_multicast + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.is_multicast + name: is_multicast + uid: ipaddress.IPv4Network.is_multicast +- fullName: ipaddress.IPv4Network.is_private + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.is_private + name: is_private + uid: ipaddress.IPv4Network.is_private +- fullName: ipaddress.IPv4Network.is_reserved + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.is_reserved + name: is_reserved + uid: ipaddress.IPv4Network.is_reserved +- fullName: ipaddress.IPv4Network.is_unspecified + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.is_unspecified + name: is_unspecified + uid: ipaddress.IPv4Network.is_unspecified +- fullName: ipaddress.IPv4Network.max_prefixlen + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.max_prefixlen + name: max_prefixlen + uid: ipaddress.IPv4Network.max_prefixlen +- fullName: ipaddress.IPv4Network.netmask + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.netmask + name: netmask + uid: ipaddress.IPv4Network.netmask +- fullName: ipaddress.IPv4Network.network_address + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.network_address + name: network_address + uid: ipaddress.IPv4Network.network_address +- fullName: ipaddress.IPv4Network.num_addresses + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.num_addresses + name: num_addresses + uid: ipaddress.IPv4Network.num_addresses +- fullName: ipaddress.IPv4Network.prefixlen + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.prefixlen + name: prefixlen + uid: ipaddress.IPv4Network.prefixlen +- fullName: ipaddress.IPv4Network.version + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.version + name: version + uid: ipaddress.IPv4Network.version +- fullName: ipaddress.IPv4Network.with_hostmask + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.with_hostmask + name: with_hostmask + uid: ipaddress.IPv4Network.with_hostmask +- fullName: ipaddress.IPv4Network.with_netmask + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.with_netmask + name: with_netmask + uid: ipaddress.IPv4Network.with_netmask +- fullName: ipaddress.IPv4Network.with_prefixlen + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.with_prefixlen + name: with_prefixlen + uid: ipaddress.IPv4Network.with_prefixlen +- fullName: ipaddress.IPv6Address.compressed + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Address.compressed + name: compressed + uid: ipaddress.IPv6Address.compressed +- fullName: ipaddress.IPv6Address.exploded + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Address.exploded + name: exploded + uid: ipaddress.IPv6Address.exploded +- fullName: ipaddress.IPv6Address.ipv4_mapped + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Address.ipv4_mapped + name: ipv4_mapped + uid: ipaddress.IPv6Address.ipv4_mapped +- fullName: ipaddress.IPv6Address.is_global + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Address.is_global + name: is_global + uid: ipaddress.IPv6Address.is_global +- fullName: ipaddress.IPv6Address.is_link_local + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Address.is_link_local + name: is_link_local + uid: ipaddress.IPv6Address.is_link_local +- fullName: ipaddress.IPv6Address.is_loopback + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Address.is_loopback + name: is_loopback + uid: ipaddress.IPv6Address.is_loopback +- fullName: ipaddress.IPv6Address.is_multicast + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Address.is_multicast + name: is_multicast + uid: ipaddress.IPv6Address.is_multicast +- fullName: ipaddress.IPv6Address.is_private + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Address.is_private + name: is_private + uid: ipaddress.IPv6Address.is_private +- fullName: ipaddress.IPv6Address.is_reserved + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Address.is_reserved + name: is_reserved + uid: ipaddress.IPv6Address.is_reserved +- fullName: ipaddress.IPv6Address.is_site_local + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Address.is_site_local + name: is_site_local + uid: ipaddress.IPv6Address.is_site_local +- fullName: ipaddress.IPv6Address.is_unspecified + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Address.is_unspecified + name: is_unspecified + uid: ipaddress.IPv6Address.is_unspecified +- fullName: ipaddress.IPv6Address.max_prefixlen + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Address.max_prefixlen + name: max_prefixlen + uid: ipaddress.IPv6Address.max_prefixlen +- fullName: ipaddress.IPv6Address.packed + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Address.packed + name: packed + uid: ipaddress.IPv6Address.packed +- fullName: ipaddress.IPv6Address.reverse_pointer + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Address.reverse_pointer + name: reverse_pointer + uid: ipaddress.IPv6Address.reverse_pointer +- fullName: ipaddress.IPv6Address.scope_id + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Address.scope_id + name: scope_id + uid: ipaddress.IPv6Address.scope_id +- fullName: ipaddress.IPv6Address.sixtofour + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Address.sixtofour + name: sixtofour + uid: ipaddress.IPv6Address.sixtofour +- fullName: ipaddress.IPv6Address.teredo + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Address.teredo + name: teredo + uid: ipaddress.IPv6Address.teredo +- fullName: ipaddress.IPv6Address.version + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Address.version + name: version + uid: ipaddress.IPv6Address.version +- fullName: ipaddress.IPv6Interface.ip + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Interface.ip + name: ip + uid: ipaddress.IPv6Interface.ip +- fullName: ipaddress.IPv6Interface.network + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Interface.network + name: network + uid: ipaddress.IPv6Interface.network +- fullName: ipaddress.IPv6Interface.with_hostmask + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Interface.with_hostmask + name: with_hostmask + uid: ipaddress.IPv6Interface.with_hostmask +- fullName: ipaddress.IPv6Interface.with_netmask + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Interface.with_netmask + name: with_netmask + uid: ipaddress.IPv6Interface.with_netmask +- fullName: ipaddress.IPv6Interface.with_prefixlen + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Interface.with_prefixlen + name: with_prefixlen + uid: ipaddress.IPv6Interface.with_prefixlen +- fullName: ipaddress.IPv6Network.broadcast_address + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.broadcast_address + name: broadcast_address + uid: ipaddress.IPv6Network.broadcast_address +- fullName: ipaddress.IPv6Network.compressed + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.compressed + name: compressed + uid: ipaddress.IPv6Network.compressed +- fullName: ipaddress.IPv6Network.exploded + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.exploded + name: exploded + uid: ipaddress.IPv6Network.exploded +- fullName: ipaddress.IPv6Network.hostmask + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.hostmask + name: hostmask + uid: ipaddress.IPv6Network.hostmask +- fullName: ipaddress.IPv6Network.is_link_local + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.is_link_local + name: is_link_local + uid: ipaddress.IPv6Network.is_link_local +- fullName: ipaddress.IPv6Network.is_loopback + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.is_loopback + name: is_loopback + uid: ipaddress.IPv6Network.is_loopback +- fullName: ipaddress.IPv6Network.is_multicast + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.is_multicast + name: is_multicast + uid: ipaddress.IPv6Network.is_multicast +- fullName: ipaddress.IPv6Network.is_private + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.is_private + name: is_private + uid: ipaddress.IPv6Network.is_private +- fullName: ipaddress.IPv6Network.is_reserved + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.is_reserved + name: is_reserved + uid: ipaddress.IPv6Network.is_reserved +- fullName: ipaddress.IPv6Network.is_site_local + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.is_site_local + name: is_site_local + uid: ipaddress.IPv6Network.is_site_local +- fullName: ipaddress.IPv6Network.is_unspecified + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.is_unspecified + name: is_unspecified + uid: ipaddress.IPv6Network.is_unspecified +- fullName: ipaddress.IPv6Network.max_prefixlen + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.max_prefixlen + name: max_prefixlen + uid: ipaddress.IPv6Network.max_prefixlen +- fullName: ipaddress.IPv6Network.netmask + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.netmask + name: netmask + uid: ipaddress.IPv6Network.netmask +- fullName: ipaddress.IPv6Network.network_address + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.network_address + name: network_address + uid: ipaddress.IPv6Network.network_address +- fullName: ipaddress.IPv6Network.num_addresses + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.num_addresses + name: num_addresses + uid: ipaddress.IPv6Network.num_addresses +- fullName: ipaddress.IPv6Network.prefixlen + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.prefixlen + name: prefixlen + uid: ipaddress.IPv6Network.prefixlen +- fullName: ipaddress.IPv6Network.version + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.version + name: version + uid: ipaddress.IPv6Network.version +- fullName: ipaddress.IPv6Network.with_hostmask + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.with_hostmask + name: with_hostmask + uid: ipaddress.IPv6Network.with_hostmask +- fullName: ipaddress.IPv6Network.with_netmask + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.with_netmask + name: with_netmask + uid: ipaddress.IPv6Network.with_netmask +- fullName: ipaddress.IPv6Network.with_prefixlen + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.with_prefixlen + name: with_prefixlen + uid: ipaddress.IPv6Network.with_prefixlen +- fullName: json.JSONDecodeError.colno + href: https://docs.python.org/3/library/json.html#json.JSONDecodeError.colno + name: colno + uid: json.JSONDecodeError.colno +- fullName: json.JSONDecodeError.doc + href: https://docs.python.org/3/library/json.html#json.JSONDecodeError.doc + name: doc + uid: json.JSONDecodeError.doc +- fullName: json.JSONDecodeError.lineno + href: https://docs.python.org/3/library/json.html#json.JSONDecodeError.lineno + name: lineno + uid: json.JSONDecodeError.lineno +- fullName: json.JSONDecodeError.msg + href: https://docs.python.org/3/library/json.html#json.JSONDecodeError.msg + name: msg + uid: json.JSONDecodeError.msg +- fullName: json.JSONDecodeError.pos + href: https://docs.python.org/3/library/json.html#json.JSONDecodeError.pos + name: pos + uid: json.JSONDecodeError.pos +- fullName: logging.Logger.disabled + href: https://docs.python.org/3/library/logging.html#logging.Logger.disabled + name: disabled + uid: logging.Logger.disabled +- fullName: logging.Logger.handlers + href: https://docs.python.org/3/library/logging.html#logging.Logger.handlers + name: handlers + uid: logging.Logger.handlers +- fullName: logging.Logger.level + href: https://docs.python.org/3/library/logging.html#logging.Logger.level + name: level + uid: logging.Logger.level +- fullName: logging.Logger.name + href: https://docs.python.org/3/library/logging.html#logging.Logger.name + name: name + uid: logging.Logger.name +- fullName: logging.Logger.parent + href: https://docs.python.org/3/library/logging.html#logging.Logger.parent + name: parent + uid: logging.Logger.parent +- fullName: logging.Logger.propagate + href: https://docs.python.org/3/library/logging.html#logging.Logger.propagate + name: propagate + uid: logging.Logger.propagate +- fullName: logging.LoggerAdapter._log + href: https://docs.python.org/3/library/logging.html#logging.LoggerAdapter._log + name: _log + uid: logging.LoggerAdapter._log +- fullName: logging.LoggerAdapter.manager + href: https://docs.python.org/3/library/logging.html#logging.LoggerAdapter.manager + name: manager + uid: logging.LoggerAdapter.manager +- fullName: logging.StreamHandler.terminator + href: https://docs.python.org/3/library/logging.handlers.html#logging.StreamHandler.terminator + name: terminator + uid: logging.StreamHandler.terminator +- fullName: logging.handlers.BaseRotatingHandler.namer + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.BaseRotatingHandler.namer + name: namer + uid: logging.handlers.BaseRotatingHandler.namer +- fullName: logging.handlers.BaseRotatingHandler.rotator + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.BaseRotatingHandler.rotator + name: rotator + uid: logging.handlers.BaseRotatingHandler.rotator +- fullName: logging.handlers.QueueHandler.listener + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.QueueHandler.listener + name: listener + uid: logging.handlers.QueueHandler.listener +- fullName: lzma.LZMADecompressor.check + href: https://docs.python.org/3/library/lzma.html#lzma.LZMADecompressor.check + name: check + uid: lzma.LZMADecompressor.check +- fullName: lzma.LZMADecompressor.eof + href: https://docs.python.org/3/library/lzma.html#lzma.LZMADecompressor.eof + name: eof + uid: lzma.LZMADecompressor.eof +- fullName: lzma.LZMADecompressor.needs_input + href: https://docs.python.org/3/library/lzma.html#lzma.LZMADecompressor.needs_input + name: needs_input + uid: lzma.LZMADecompressor.needs_input +- fullName: lzma.LZMADecompressor.unused_data + href: https://docs.python.org/3/library/lzma.html#lzma.LZMADecompressor.unused_data + name: unused_data + uid: lzma.LZMADecompressor.unused_data +- fullName: lzma.LZMAFile.mode + href: https://docs.python.org/3/library/lzma.html#lzma.LZMAFile.mode + name: mode + uid: lzma.LZMAFile.mode +- fullName: lzma.LZMAFile.name + href: https://docs.python.org/3/library/lzma.html#lzma.LZMAFile.name + name: name + uid: lzma.LZMAFile.name +- fullName: mailbox.Maildir.colon + href: https://docs.python.org/3/library/mailbox.html#mailbox.Maildir.colon + name: colon + uid: mailbox.Maildir.colon +- fullName: memoryview.c_contiguous + href: https://docs.python.org/3/library/stdtypes.html#memoryview.c_contiguous + name: c_contiguous + uid: memoryview.c_contiguous +- fullName: memoryview.contiguous + href: https://docs.python.org/3/library/stdtypes.html#memoryview.contiguous + name: contiguous + uid: memoryview.contiguous +- fullName: memoryview.f_contiguous + href: https://docs.python.org/3/library/stdtypes.html#memoryview.f_contiguous + name: f_contiguous + uid: memoryview.f_contiguous +- fullName: memoryview.format + href: https://docs.python.org/3/library/stdtypes.html#memoryview.format + name: format + uid: memoryview.format +- fullName: memoryview.itemsize + href: https://docs.python.org/3/library/stdtypes.html#memoryview.itemsize + name: itemsize + uid: memoryview.itemsize +- fullName: memoryview.nbytes + href: https://docs.python.org/3/library/stdtypes.html#memoryview.nbytes + name: nbytes + uid: memoryview.nbytes +- fullName: memoryview.ndim + href: https://docs.python.org/3/library/stdtypes.html#memoryview.ndim + name: ndim + uid: memoryview.ndim +- fullName: memoryview.obj + href: https://docs.python.org/3/library/stdtypes.html#memoryview.obj + name: obj + uid: memoryview.obj +- fullName: memoryview.readonly + href: https://docs.python.org/3/library/stdtypes.html#memoryview.readonly + name: readonly + uid: memoryview.readonly +- fullName: memoryview.shape + href: https://docs.python.org/3/library/stdtypes.html#memoryview.shape + name: shape + uid: memoryview.shape +- fullName: memoryview.strides + href: https://docs.python.org/3/library/stdtypes.html#memoryview.strides + name: strides + uid: memoryview.strides +- fullName: memoryview.suboffsets + href: https://docs.python.org/3/library/stdtypes.html#memoryview.suboffsets + name: suboffsets + uid: memoryview.suboffsets +- fullName: method.__doc__ + href: https://docs.python.org/3/reference/datamodel.html#method.__doc__ + name: __doc__ + uid: method.__doc__ +- fullName: method.__func__ + href: https://docs.python.org/3/reference/datamodel.html#method.__func__ + name: __func__ + uid: method.__func__ +- fullName: method.__module__ + href: https://docs.python.org/3/reference/datamodel.html#method.__module__ + name: __module__ + uid: method.__module__ +- fullName: method.__name__ + href: https://docs.python.org/3/reference/datamodel.html#method.__name__ + name: __name__ + uid: method.__name__ +- fullName: method.__self__ + href: https://docs.python.org/3/reference/datamodel.html#method.__self__ + name: __self__ + uid: method.__self__ +- fullName: mimetypes.MimeTypes.encodings_map + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.MimeTypes.encodings_map + name: encodings_map + uid: mimetypes.MimeTypes.encodings_map +- fullName: mimetypes.MimeTypes.suffix_map + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.MimeTypes.suffix_map + name: suffix_map + uid: mimetypes.MimeTypes.suffix_map +- fullName: mimetypes.MimeTypes.types_map + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.MimeTypes.types_map + name: types_map + uid: mimetypes.MimeTypes.types_map +- fullName: mimetypes.MimeTypes.types_map_inv + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.MimeTypes.types_map_inv + name: types_map_inv + uid: mimetypes.MimeTypes.types_map_inv +- fullName: mmap.mmap.closed + href: https://docs.python.org/3/library/mmap.html#mmap.mmap.closed + name: closed + uid: mmap.mmap.closed +- fullName: module.__annotations__ + href: https://docs.python.org/3/reference/datamodel.html#module.__annotations__ + name: __annotations__ + uid: module.__annotations__ +- fullName: module.__cached__ + href: https://docs.python.org/3/reference/datamodel.html#module.__cached__ + name: __cached__ + uid: module.__cached__ +- fullName: module.__dict__ + href: https://docs.python.org/3/reference/datamodel.html#module.__dict__ + name: __dict__ + uid: module.__dict__ +- fullName: module.__doc__ + href: https://docs.python.org/3/reference/datamodel.html#module.__doc__ + name: __doc__ + uid: module.__doc__ +- fullName: module.__file__ + href: https://docs.python.org/3/reference/datamodel.html#module.__file__ + name: __file__ + uid: module.__file__ +- fullName: module.__loader__ + href: https://docs.python.org/3/reference/datamodel.html#module.__loader__ + name: __loader__ + uid: module.__loader__ +- fullName: module.__name__ + href: https://docs.python.org/3/reference/datamodel.html#module.__name__ + name: __name__ + uid: module.__name__ +- fullName: module.__package__ + href: https://docs.python.org/3/reference/datamodel.html#module.__package__ + name: __package__ + uid: module.__package__ +- fullName: module.__path__ + href: https://docs.python.org/3/reference/datamodel.html#module.__path__ + name: __path__ + uid: module.__path__ +- fullName: module.__spec__ + href: https://docs.python.org/3/reference/datamodel.html#module.__spec__ + name: __spec__ + uid: module.__spec__ +- fullName: modulefinder.ModuleFinder.modules + href: https://docs.python.org/3/library/modulefinder.html#modulefinder.ModuleFinder.modules + name: modules + uid: modulefinder.ModuleFinder.modules +- fullName: multiprocessing.Process.authkey + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Process.authkey + name: authkey + uid: multiprocessing.Process.authkey +- fullName: multiprocessing.Process.daemon + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Process.daemon + name: daemon + uid: multiprocessing.Process.daemon +- fullName: multiprocessing.Process.exitcode + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Process.exitcode + name: exitcode + uid: multiprocessing.Process.exitcode +- fullName: multiprocessing.Process.name + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Process.name + name: name + uid: multiprocessing.Process.name +- fullName: multiprocessing.Process.pid + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Process.pid + name: pid + uid: multiprocessing.Process.pid +- fullName: multiprocessing.Process.sentinel + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Process.sentinel + name: sentinel + uid: multiprocessing.Process.sentinel +- fullName: multiprocessing.connection.Listener.address + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.connection.Listener.address + name: address + uid: multiprocessing.connection.Listener.address +- fullName: multiprocessing.connection.Listener.last_accepted + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.connection.Listener.last_accepted + name: last_accepted + uid: multiprocessing.connection.Listener.last_accepted +- fullName: multiprocessing.managers.BaseManager.address + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.BaseManager.address + name: address + uid: multiprocessing.managers.BaseManager.address +- fullName: multiprocessing.shared_memory.ShareableList.format + href: https://docs.python.org/3/library/multiprocessing.shared_memory.html#multiprocessing.shared_memory.ShareableList.format + name: format + uid: multiprocessing.shared_memory.ShareableList.format +- fullName: multiprocessing.shared_memory.ShareableList.shm + href: https://docs.python.org/3/library/multiprocessing.shared_memory.html#multiprocessing.shared_memory.ShareableList.shm + name: shm + uid: multiprocessing.shared_memory.ShareableList.shm +- fullName: multiprocessing.shared_memory.SharedMemory.buf + href: https://docs.python.org/3/library/multiprocessing.shared_memory.html#multiprocessing.shared_memory.SharedMemory.buf + name: buf + uid: multiprocessing.shared_memory.SharedMemory.buf +- fullName: multiprocessing.shared_memory.SharedMemory.name + href: https://docs.python.org/3/library/multiprocessing.shared_memory.html#multiprocessing.shared_memory.SharedMemory.name + name: name + uid: multiprocessing.shared_memory.SharedMemory.name +- fullName: multiprocessing.shared_memory.SharedMemory.size + href: https://docs.python.org/3/library/multiprocessing.shared_memory.html#multiprocessing.shared_memory.SharedMemory.size + name: size + uid: multiprocessing.shared_memory.SharedMemory.size +- fullName: netrc.NetrcParseError.filename + href: https://docs.python.org/3/library/netrc.html#netrc.NetrcParseError.filename + name: filename + uid: netrc.NetrcParseError.filename +- fullName: netrc.NetrcParseError.lineno + href: https://docs.python.org/3/library/netrc.html#netrc.NetrcParseError.lineno + name: lineno + uid: netrc.NetrcParseError.lineno +- fullName: netrc.NetrcParseError.msg + href: https://docs.python.org/3/library/netrc.html#netrc.NetrcParseError.msg + name: msg + uid: netrc.NetrcParseError.msg +- fullName: netrc.netrc.hosts + href: https://docs.python.org/3/library/netrc.html#netrc.netrc.hosts + name: hosts + uid: netrc.netrc.hosts +- fullName: netrc.netrc.macros + href: https://docs.python.org/3/library/netrc.html#netrc.netrc.macros + name: macros + uid: netrc.netrc.macros +- fullName: numbers.Complex.imag + href: https://docs.python.org/3/library/numbers.html#numbers.Complex.imag + name: imag + uid: numbers.Complex.imag +- fullName: numbers.Complex.real + href: https://docs.python.org/3/library/numbers.html#numbers.Complex.real + name: real + uid: numbers.Complex.real +- fullName: numbers.Rational.denominator + href: https://docs.python.org/3/library/numbers.html#numbers.Rational.denominator + name: denominator + uid: numbers.Rational.denominator +- fullName: numbers.Rational.numerator + href: https://docs.python.org/3/library/numbers.html#numbers.Rational.numerator + name: numerator + uid: numbers.Rational.numerator +- fullName: object.__class__ + href: https://docs.python.org/3/reference/datamodel.html#object.__class__ + name: __class__ + uid: object.__class__ +- fullName: object.__dict__ + href: https://docs.python.org/3/reference/datamodel.html#object.__dict__ + name: __dict__ + uid: object.__dict__ +- fullName: object.__objclass__ + href: https://docs.python.org/3/reference/datamodel.html#object.__objclass__ + name: __objclass__ + uid: object.__objclass__ +- fullName: optparse.Option.ACTIONS + href: https://docs.python.org/3/library/optparse.html#optparse.Option.ACTIONS + name: ACTIONS + uid: optparse.Option.ACTIONS +- fullName: optparse.Option.ALWAYS_TYPED_ACTIONS + href: https://docs.python.org/3/library/optparse.html#optparse.Option.ALWAYS_TYPED_ACTIONS + name: ALWAYS_TYPED_ACTIONS + uid: optparse.Option.ALWAYS_TYPED_ACTIONS +- fullName: optparse.Option.STORE_ACTIONS + href: https://docs.python.org/3/library/optparse.html#optparse.Option.STORE_ACTIONS + name: STORE_ACTIONS + uid: optparse.Option.STORE_ACTIONS +- fullName: optparse.Option.TYPED_ACTIONS + href: https://docs.python.org/3/library/optparse.html#optparse.Option.TYPED_ACTIONS + name: TYPED_ACTIONS + uid: optparse.Option.TYPED_ACTIONS +- fullName: optparse.Option.TYPES + href: https://docs.python.org/3/library/optparse.html#optparse.Option.TYPES + name: TYPES + uid: optparse.Option.TYPES +- fullName: optparse.Option.TYPE_CHECKER + href: https://docs.python.org/3/library/optparse.html#optparse.Option.TYPE_CHECKER + name: TYPE_CHECKER + uid: optparse.Option.TYPE_CHECKER +- fullName: optparse.Option.action + href: https://docs.python.org/3/library/optparse.html#optparse.Option.action + name: action + uid: optparse.Option.action +- fullName: optparse.Option.callback + href: https://docs.python.org/3/library/optparse.html#optparse.Option.callback + name: callback + uid: optparse.Option.callback +- fullName: optparse.Option.callback_args + href: https://docs.python.org/3/library/optparse.html#optparse.Option.callback_args + name: callback_args + uid: optparse.Option.callback_args +- fullName: optparse.Option.callback_kwargs + href: https://docs.python.org/3/library/optparse.html#optparse.Option.callback_kwargs + name: callback_kwargs + uid: optparse.Option.callback_kwargs +- fullName: optparse.Option.choices + href: https://docs.python.org/3/library/optparse.html#optparse.Option.choices + name: choices + uid: optparse.Option.choices +- fullName: optparse.Option.const + href: https://docs.python.org/3/library/optparse.html#optparse.Option.const + name: const + uid: optparse.Option.const +- fullName: optparse.Option.default + href: https://docs.python.org/3/library/optparse.html#optparse.Option.default + name: default + uid: optparse.Option.default +- fullName: optparse.Option.dest + href: https://docs.python.org/3/library/optparse.html#optparse.Option.dest + name: dest + uid: optparse.Option.dest +- fullName: optparse.Option.help + href: https://docs.python.org/3/library/optparse.html#optparse.Option.help + name: help + uid: optparse.Option.help +- fullName: optparse.Option.metavar + href: https://docs.python.org/3/library/optparse.html#optparse.Option.metavar + name: metavar + uid: optparse.Option.metavar +- fullName: optparse.Option.nargs + href: https://docs.python.org/3/library/optparse.html#optparse.Option.nargs + name: nargs + uid: optparse.Option.nargs +- fullName: optparse.Option.type + href: https://docs.python.org/3/library/optparse.html#optparse.Option.type + name: type + uid: optparse.Option.type +- fullName: os.DirEntry.name + href: https://docs.python.org/3/library/os.html#os.DirEntry.name + name: name + uid: os.DirEntry.name +- fullName: os.DirEntry.path + href: https://docs.python.org/3/library/os.html#os.DirEntry.path + name: path + uid: os.DirEntry.path +- fullName: os.sched_param.sched_priority + href: https://docs.python.org/3/library/os.html#os.sched_param.sched_priority + name: sched_priority + uid: os.sched_param.sched_priority +- fullName: os.stat_result.st_atime + href: https://docs.python.org/3/library/os.html#os.stat_result.st_atime + name: st_atime + uid: os.stat_result.st_atime +- fullName: os.stat_result.st_atime_ns + href: https://docs.python.org/3/library/os.html#os.stat_result.st_atime_ns + name: st_atime_ns + uid: os.stat_result.st_atime_ns +- fullName: os.stat_result.st_birthtime + href: https://docs.python.org/3/library/os.html#os.stat_result.st_birthtime + name: st_birthtime + uid: os.stat_result.st_birthtime +- fullName: os.stat_result.st_birthtime_ns + href: https://docs.python.org/3/library/os.html#os.stat_result.st_birthtime_ns + name: st_birthtime_ns + uid: os.stat_result.st_birthtime_ns +- fullName: os.stat_result.st_blksize + href: https://docs.python.org/3/library/os.html#os.stat_result.st_blksize + name: st_blksize + uid: os.stat_result.st_blksize +- fullName: os.stat_result.st_blocks + href: https://docs.python.org/3/library/os.html#os.stat_result.st_blocks + name: st_blocks + uid: os.stat_result.st_blocks +- fullName: os.stat_result.st_creator + href: https://docs.python.org/3/library/os.html#os.stat_result.st_creator + name: st_creator + uid: os.stat_result.st_creator +- fullName: os.stat_result.st_ctime + href: https://docs.python.org/3/library/os.html#os.stat_result.st_ctime + name: st_ctime + uid: os.stat_result.st_ctime +- fullName: os.stat_result.st_ctime_ns + href: https://docs.python.org/3/library/os.html#os.stat_result.st_ctime_ns + name: st_ctime_ns + uid: os.stat_result.st_ctime_ns +- fullName: os.stat_result.st_dev + href: https://docs.python.org/3/library/os.html#os.stat_result.st_dev + name: st_dev + uid: os.stat_result.st_dev +- fullName: os.stat_result.st_file_attributes + href: https://docs.python.org/3/library/os.html#os.stat_result.st_file_attributes + name: st_file_attributes + uid: os.stat_result.st_file_attributes +- fullName: os.stat_result.st_flags + href: https://docs.python.org/3/library/os.html#os.stat_result.st_flags + name: st_flags + uid: os.stat_result.st_flags +- fullName: os.stat_result.st_fstype + href: https://docs.python.org/3/library/os.html#os.stat_result.st_fstype + name: st_fstype + uid: os.stat_result.st_fstype +- fullName: os.stat_result.st_gen + href: https://docs.python.org/3/library/os.html#os.stat_result.st_gen + name: st_gen + uid: os.stat_result.st_gen +- fullName: os.stat_result.st_gid + href: https://docs.python.org/3/library/os.html#os.stat_result.st_gid + name: st_gid + uid: os.stat_result.st_gid +- fullName: os.stat_result.st_ino + href: https://docs.python.org/3/library/os.html#os.stat_result.st_ino + name: st_ino + uid: os.stat_result.st_ino +- fullName: os.stat_result.st_mode + href: https://docs.python.org/3/library/os.html#os.stat_result.st_mode + name: st_mode + uid: os.stat_result.st_mode +- fullName: os.stat_result.st_mtime + href: https://docs.python.org/3/library/os.html#os.stat_result.st_mtime + name: st_mtime + uid: os.stat_result.st_mtime +- fullName: os.stat_result.st_mtime_ns + href: https://docs.python.org/3/library/os.html#os.stat_result.st_mtime_ns + name: st_mtime_ns + uid: os.stat_result.st_mtime_ns +- fullName: os.stat_result.st_nlink + href: https://docs.python.org/3/library/os.html#os.stat_result.st_nlink + name: st_nlink + uid: os.stat_result.st_nlink +- fullName: os.stat_result.st_rdev + href: https://docs.python.org/3/library/os.html#os.stat_result.st_rdev + name: st_rdev + uid: os.stat_result.st_rdev +- fullName: os.stat_result.st_reparse_tag + href: https://docs.python.org/3/library/os.html#os.stat_result.st_reparse_tag + name: st_reparse_tag + uid: os.stat_result.st_reparse_tag +- fullName: os.stat_result.st_rsize + href: https://docs.python.org/3/library/os.html#os.stat_result.st_rsize + name: st_rsize + uid: os.stat_result.st_rsize +- fullName: os.stat_result.st_size + href: https://docs.python.org/3/library/os.html#os.stat_result.st_size + name: st_size + uid: os.stat_result.st_size +- fullName: os.stat_result.st_type + href: https://docs.python.org/3/library/os.html#os.stat_result.st_type + name: st_type + uid: os.stat_result.st_type +- fullName: os.stat_result.st_uid + href: https://docs.python.org/3/library/os.html#os.stat_result.st_uid + name: st_uid + uid: os.stat_result.st_uid +- fullName: os.terminal_size.columns + href: https://docs.python.org/3/library/os.html#os.terminal_size.columns + name: columns + uid: os.terminal_size.columns +- fullName: os.terminal_size.lines + href: https://docs.python.org/3/library/os.html#os.terminal_size.lines + name: lines + uid: os.terminal_size.lines +- fullName: pathlib.PurePath.anchor + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.anchor + name: anchor + uid: pathlib.PurePath.anchor +- fullName: pathlib.PurePath.drive + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.drive + name: drive + uid: pathlib.PurePath.drive +- fullName: pathlib.PurePath.name + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.name + name: name + uid: pathlib.PurePath.name +- fullName: pathlib.PurePath.parent + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.parent + name: parent + uid: pathlib.PurePath.parent +- fullName: pathlib.PurePath.parents + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.parents + name: parents + uid: pathlib.PurePath.parents +- fullName: pathlib.PurePath.parser + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.parser + name: parser + uid: pathlib.PurePath.parser +- fullName: pathlib.PurePath.parts + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.parts + name: parts + uid: pathlib.PurePath.parts +- fullName: pathlib.PurePath.root + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.root + name: root + uid: pathlib.PurePath.root +- fullName: pathlib.PurePath.stem + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.stem + name: stem + uid: pathlib.PurePath.stem +- fullName: pathlib.PurePath.suffix + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.suffix + name: suffix + uid: pathlib.PurePath.suffix +- fullName: pathlib.PurePath.suffixes + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.suffixes + name: suffixes + uid: pathlib.PurePath.suffixes +- fullName: pickle.Pickler.dispatch_table + href: https://docs.python.org/3/library/pickle.html#pickle.Pickler.dispatch_table + name: dispatch_table + uid: pickle.Pickler.dispatch_table +- fullName: pickle.Pickler.fast + href: https://docs.python.org/3/library/pickle.html#pickle.Pickler.fast + name: fast + uid: pickle.Pickler.fast +- fullName: property.__name__ + href: https://docs.python.org/3/library/functions.html#property.__name__ + name: __name__ + uid: property.__name__ +- fullName: py_compile.PycInvalidationMode.CHECKED_HASH + href: https://docs.python.org/3/library/py_compile.html#py_compile.PycInvalidationMode.CHECKED_HASH + name: CHECKED_HASH + uid: py_compile.PycInvalidationMode.CHECKED_HASH +- fullName: py_compile.PycInvalidationMode.TIMESTAMP + href: https://docs.python.org/3/library/py_compile.html#py_compile.PycInvalidationMode.TIMESTAMP + name: TIMESTAMP + uid: py_compile.PycInvalidationMode.TIMESTAMP +- fullName: py_compile.PycInvalidationMode.UNCHECKED_HASH + href: https://docs.python.org/3/library/py_compile.html#py_compile.PycInvalidationMode.UNCHECKED_HASH + name: UNCHECKED_HASH + uid: py_compile.PycInvalidationMode.UNCHECKED_HASH +- fullName: pyclbr.Class.children + href: https://docs.python.org/3/library/pyclbr.html#pyclbr.Class.children + name: children + uid: pyclbr.Class.children +- fullName: pyclbr.Class.file + href: https://docs.python.org/3/library/pyclbr.html#pyclbr.Class.file + name: file + uid: pyclbr.Class.file +- fullName: pyclbr.Class.lineno + href: https://docs.python.org/3/library/pyclbr.html#pyclbr.Class.lineno + name: lineno + uid: pyclbr.Class.lineno +- fullName: pyclbr.Class.methods + href: https://docs.python.org/3/library/pyclbr.html#pyclbr.Class.methods + name: methods + uid: pyclbr.Class.methods +- fullName: pyclbr.Class.module + href: https://docs.python.org/3/library/pyclbr.html#pyclbr.Class.module + name: module + uid: pyclbr.Class.module +- fullName: pyclbr.Class.name + href: https://docs.python.org/3/library/pyclbr.html#pyclbr.Class.name + name: name + uid: pyclbr.Class.name +- fullName: pyclbr.Class.parent + href: https://docs.python.org/3/library/pyclbr.html#pyclbr.Class.parent + name: parent + uid: pyclbr.Class.parent +- fullName: pyclbr.Class.super + href: https://docs.python.org/3/library/pyclbr.html#pyclbr.Class.super + name: super + uid: pyclbr.Class.super +- fullName: pyclbr.Function.children + href: https://docs.python.org/3/library/pyclbr.html#pyclbr.Function.children + name: children + uid: pyclbr.Function.children +- fullName: pyclbr.Function.file + href: https://docs.python.org/3/library/pyclbr.html#pyclbr.Function.file + name: file + uid: pyclbr.Function.file +- fullName: pyclbr.Function.is_async + href: https://docs.python.org/3/library/pyclbr.html#pyclbr.Function.is_async + name: is_async + uid: pyclbr.Function.is_async +- fullName: pyclbr.Function.lineno + href: https://docs.python.org/3/library/pyclbr.html#pyclbr.Function.lineno + name: lineno + uid: pyclbr.Function.lineno +- fullName: pyclbr.Function.module + href: https://docs.python.org/3/library/pyclbr.html#pyclbr.Function.module + name: module + uid: pyclbr.Function.module +- fullName: pyclbr.Function.name + href: https://docs.python.org/3/library/pyclbr.html#pyclbr.Function.name + name: name + uid: pyclbr.Function.name +- fullName: pyclbr.Function.parent + href: https://docs.python.org/3/library/pyclbr.html#pyclbr.Function.parent + name: parent + uid: pyclbr.Function.parent +- fullName: range.start + href: https://docs.python.org/3/library/stdtypes.html#range.start + name: start + uid: range.start +- fullName: range.step + href: https://docs.python.org/3/library/stdtypes.html#range.step + name: step + uid: range.step +- fullName: range.stop + href: https://docs.python.org/3/library/stdtypes.html#range.stop + name: stop + uid: range.stop +- fullName: re.Match.endpos + href: https://docs.python.org/3/library/re.html#re.Match.endpos + name: endpos + uid: re.Match.endpos +- fullName: re.Match.lastgroup + href: https://docs.python.org/3/library/re.html#re.Match.lastgroup + name: lastgroup + uid: re.Match.lastgroup +- fullName: re.Match.lastindex + href: https://docs.python.org/3/library/re.html#re.Match.lastindex + name: lastindex + uid: re.Match.lastindex +- fullName: re.Match.pos + href: https://docs.python.org/3/library/re.html#re.Match.pos + name: pos + uid: re.Match.pos +- fullName: re.Match.re + href: https://docs.python.org/3/library/re.html#re.Match.re + name: re + uid: re.Match.re +- fullName: re.Match.string + href: https://docs.python.org/3/library/re.html#re.Match.string + name: string + uid: re.Match.string +- fullName: re.Pattern.flags + href: https://docs.python.org/3/library/re.html#re.Pattern.flags + name: flags + uid: re.Pattern.flags +- fullName: re.Pattern.groupindex + href: https://docs.python.org/3/library/re.html#re.Pattern.groupindex + name: groupindex + uid: re.Pattern.groupindex +- fullName: re.Pattern.groups + href: https://docs.python.org/3/library/re.html#re.Pattern.groups + name: groups + uid: re.Pattern.groups +- fullName: re.Pattern.pattern + href: https://docs.python.org/3/library/re.html#re.Pattern.pattern + name: pattern + uid: re.Pattern.pattern +- fullName: re.PatternError.colno + href: https://docs.python.org/3/library/re.html#re.PatternError.colno + name: colno + uid: re.PatternError.colno +- fullName: re.PatternError.lineno + href: https://docs.python.org/3/library/re.html#re.PatternError.lineno + name: lineno + uid: re.PatternError.lineno +- fullName: re.PatternError.msg + href: https://docs.python.org/3/library/re.html#re.PatternError.msg + name: msg + uid: re.PatternError.msg +- fullName: re.PatternError.pattern + href: https://docs.python.org/3/library/re.html#re.PatternError.pattern + name: pattern + uid: re.PatternError.pattern +- fullName: re.PatternError.pos + href: https://docs.python.org/3/library/re.html#re.PatternError.pos + name: pos + uid: re.PatternError.pos +- fullName: reprlib.Repr.fillvalue + href: https://docs.python.org/3/library/reprlib.html#reprlib.Repr.fillvalue + name: fillvalue + uid: reprlib.Repr.fillvalue +- fullName: reprlib.Repr.indent + href: https://docs.python.org/3/library/reprlib.html#reprlib.Repr.indent + name: indent + uid: reprlib.Repr.indent +- fullName: reprlib.Repr.maxarray + href: https://docs.python.org/3/library/reprlib.html#reprlib.Repr.maxarray + name: maxarray + uid: reprlib.Repr.maxarray +- fullName: reprlib.Repr.maxdeque + href: https://docs.python.org/3/library/reprlib.html#reprlib.Repr.maxdeque + name: maxdeque + uid: reprlib.Repr.maxdeque +- fullName: reprlib.Repr.maxdict + href: https://docs.python.org/3/library/reprlib.html#reprlib.Repr.maxdict + name: maxdict + uid: reprlib.Repr.maxdict +- fullName: reprlib.Repr.maxfrozenset + href: https://docs.python.org/3/library/reprlib.html#reprlib.Repr.maxfrozenset + name: maxfrozenset + uid: reprlib.Repr.maxfrozenset +- fullName: reprlib.Repr.maxlevel + href: https://docs.python.org/3/library/reprlib.html#reprlib.Repr.maxlevel + name: maxlevel + uid: reprlib.Repr.maxlevel +- fullName: reprlib.Repr.maxlist + href: https://docs.python.org/3/library/reprlib.html#reprlib.Repr.maxlist + name: maxlist + uid: reprlib.Repr.maxlist +- fullName: reprlib.Repr.maxlong + href: https://docs.python.org/3/library/reprlib.html#reprlib.Repr.maxlong + name: maxlong + uid: reprlib.Repr.maxlong +- fullName: reprlib.Repr.maxother + href: https://docs.python.org/3/library/reprlib.html#reprlib.Repr.maxother + name: maxother + uid: reprlib.Repr.maxother +- fullName: reprlib.Repr.maxset + href: https://docs.python.org/3/library/reprlib.html#reprlib.Repr.maxset + name: maxset + uid: reprlib.Repr.maxset +- fullName: reprlib.Repr.maxstring + href: https://docs.python.org/3/library/reprlib.html#reprlib.Repr.maxstring + name: maxstring + uid: reprlib.Repr.maxstring +- fullName: reprlib.Repr.maxtuple + href: https://docs.python.org/3/library/reprlib.html#reprlib.Repr.maxtuple + name: maxtuple + uid: reprlib.Repr.maxtuple +- fullName: sched.scheduler.queue + href: https://docs.python.org/3/library/sched.html#sched.scheduler.queue + name: queue + uid: sched.scheduler.queue +- fullName: select.devpoll.closed + href: https://docs.python.org/3/library/select.html#select.devpoll.closed + name: closed + uid: select.devpoll.closed +- fullName: select.epoll.closed + href: https://docs.python.org/3/library/select.html#select.epoll.closed + name: closed + uid: select.epoll.closed +- fullName: select.kevent.data + href: https://docs.python.org/3/library/select.html#select.kevent.data + name: data + uid: select.kevent.data +- fullName: select.kevent.fflags + href: https://docs.python.org/3/library/select.html#select.kevent.fflags + name: fflags + uid: select.kevent.fflags +- fullName: select.kevent.filter + href: https://docs.python.org/3/library/select.html#select.kevent.filter + name: filter + uid: select.kevent.filter +- fullName: select.kevent.flags + href: https://docs.python.org/3/library/select.html#select.kevent.flags + name: flags + uid: select.kevent.flags +- fullName: select.kevent.ident + href: https://docs.python.org/3/library/select.html#select.kevent.ident + name: ident + uid: select.kevent.ident +- fullName: select.kevent.udata + href: https://docs.python.org/3/library/select.html#select.kevent.udata + name: udata + uid: select.kevent.udata +- fullName: select.kqueue.closed + href: https://docs.python.org/3/library/select.html#select.kqueue.closed + name: closed + uid: select.kqueue.closed +- fullName: selectors.SelectorKey.data + href: https://docs.python.org/3/library/selectors.html#selectors.SelectorKey.data + name: data + uid: selectors.SelectorKey.data +- fullName: selectors.SelectorKey.events + href: https://docs.python.org/3/library/selectors.html#selectors.SelectorKey.events + name: events + uid: selectors.SelectorKey.events +- fullName: selectors.SelectorKey.fd + href: https://docs.python.org/3/library/selectors.html#selectors.SelectorKey.fd + name: fd + uid: selectors.SelectorKey.fd +- fullName: selectors.SelectorKey.fileobj + href: https://docs.python.org/3/library/selectors.html#selectors.SelectorKey.fileobj + name: fileobj + uid: selectors.SelectorKey.fileobj +- fullName: shlex.shlex.commenters + href: https://docs.python.org/3/library/shlex.html#shlex.shlex.commenters + name: commenters + uid: shlex.shlex.commenters +- fullName: shlex.shlex.debug + href: https://docs.python.org/3/library/shlex.html#shlex.shlex.debug + name: debug + uid: shlex.shlex.debug +- fullName: shlex.shlex.eof + href: https://docs.python.org/3/library/shlex.html#shlex.shlex.eof + name: eof + uid: shlex.shlex.eof +- fullName: shlex.shlex.escape + href: https://docs.python.org/3/library/shlex.html#shlex.shlex.escape + name: escape + uid: shlex.shlex.escape +- fullName: shlex.shlex.escapedquotes + href: https://docs.python.org/3/library/shlex.html#shlex.shlex.escapedquotes + name: escapedquotes + uid: shlex.shlex.escapedquotes +- fullName: shlex.shlex.infile + href: https://docs.python.org/3/library/shlex.html#shlex.shlex.infile + name: infile + uid: shlex.shlex.infile +- fullName: shlex.shlex.instream + href: https://docs.python.org/3/library/shlex.html#shlex.shlex.instream + name: instream + uid: shlex.shlex.instream +- fullName: shlex.shlex.lineno + href: https://docs.python.org/3/library/shlex.html#shlex.shlex.lineno + name: lineno + uid: shlex.shlex.lineno +- fullName: shlex.shlex.punctuation_chars + href: https://docs.python.org/3/library/shlex.html#shlex.shlex.punctuation_chars + name: punctuation_chars + uid: shlex.shlex.punctuation_chars +- fullName: shlex.shlex.quotes + href: https://docs.python.org/3/library/shlex.html#shlex.shlex.quotes + name: quotes + uid: shlex.shlex.quotes +- fullName: shlex.shlex.source + href: https://docs.python.org/3/library/shlex.html#shlex.shlex.source + name: source + uid: shlex.shlex.source +- fullName: shlex.shlex.token + href: https://docs.python.org/3/library/shlex.html#shlex.shlex.token + name: token + uid: shlex.shlex.token +- fullName: shlex.shlex.whitespace + href: https://docs.python.org/3/library/shlex.html#shlex.shlex.whitespace + name: whitespace + uid: shlex.shlex.whitespace +- fullName: shlex.shlex.whitespace_split + href: https://docs.python.org/3/library/shlex.html#shlex.shlex.whitespace_split + name: whitespace_split + uid: shlex.shlex.whitespace_split +- fullName: shlex.shlex.wordchars + href: https://docs.python.org/3/library/shlex.html#shlex.shlex.wordchars + name: wordchars + uid: shlex.shlex.wordchars +- fullName: shutil.rmtree.avoids_symlink_attacks + href: https://docs.python.org/3/library/shutil.html#shutil.rmtree.avoids_symlink_attacks + name: avoids_symlink_attacks + uid: shutil.rmtree.avoids_symlink_attacks +- fullName: slice.start + href: https://docs.python.org/3/library/functions.html#slice.start + name: start + uid: slice.start +- fullName: slice.step + href: https://docs.python.org/3/library/functions.html#slice.step + name: step + uid: slice.step +- fullName: slice.stop + href: https://docs.python.org/3/library/functions.html#slice.stop + name: stop + uid: slice.stop +- fullName: socket.socket.family + href: https://docs.python.org/3/library/socket.html#socket.socket.family + name: family + uid: socket.socket.family +- fullName: socket.socket.proto + href: https://docs.python.org/3/library/socket.html#socket.socket.proto + name: proto + uid: socket.socket.proto +- fullName: socket.socket.type + href: https://docs.python.org/3/library/socket.html#socket.socket.type + name: type + uid: socket.socket.type +- fullName: socketserver.BaseRequestHandler.client_address + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseRequestHandler.client_address + name: client_address + uid: socketserver.BaseRequestHandler.client_address +- fullName: socketserver.BaseRequestHandler.request + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseRequestHandler.request + name: request + uid: socketserver.BaseRequestHandler.request +- fullName: socketserver.BaseRequestHandler.server + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseRequestHandler.server + name: server + uid: socketserver.BaseRequestHandler.server +- fullName: socketserver.BaseServer.RequestHandlerClass + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseServer.RequestHandlerClass + name: RequestHandlerClass + uid: socketserver.BaseServer.RequestHandlerClass +- fullName: socketserver.BaseServer.address_family + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseServer.address_family + name: address_family + uid: socketserver.BaseServer.address_family +- fullName: socketserver.BaseServer.allow_reuse_address + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseServer.allow_reuse_address + name: allow_reuse_address + uid: socketserver.BaseServer.allow_reuse_address +- fullName: socketserver.BaseServer.request_queue_size + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseServer.request_queue_size + name: request_queue_size + uid: socketserver.BaseServer.request_queue_size +- fullName: socketserver.BaseServer.server_address + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseServer.server_address + name: server_address + uid: socketserver.BaseServer.server_address +- fullName: socketserver.BaseServer.socket + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseServer.socket + name: socket + uid: socketserver.BaseServer.socket +- fullName: socketserver.BaseServer.socket_type + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseServer.socket_type + name: socket_type + uid: socketserver.BaseServer.socket_type +- fullName: socketserver.BaseServer.timeout + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseServer.timeout + name: timeout + uid: socketserver.BaseServer.timeout +- fullName: socketserver.DatagramRequestHandler.rfile + href: https://docs.python.org/3/library/socketserver.html#socketserver.DatagramRequestHandler.rfile + name: rfile + uid: socketserver.DatagramRequestHandler.rfile +- fullName: socketserver.DatagramRequestHandler.wfile + href: https://docs.python.org/3/library/socketserver.html#socketserver.DatagramRequestHandler.wfile + name: wfile + uid: socketserver.DatagramRequestHandler.wfile +- fullName: socketserver.ThreadingMixIn.block_on_close + href: https://docs.python.org/3/library/socketserver.html#socketserver.ThreadingMixIn.block_on_close + name: block_on_close + uid: socketserver.ThreadingMixIn.block_on_close +- fullName: socketserver.ThreadingMixIn.daemon_threads + href: https://docs.python.org/3/library/socketserver.html#socketserver.ThreadingMixIn.daemon_threads + name: daemon_threads + uid: socketserver.ThreadingMixIn.daemon_threads +- fullName: sqlite3.Connection.autocommit + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.autocommit + name: autocommit + uid: sqlite3.Connection.autocommit +- fullName: sqlite3.Connection.in_transaction + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.in_transaction + name: in_transaction + uid: sqlite3.Connection.in_transaction +- fullName: sqlite3.Connection.isolation_level + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.isolation_level + name: isolation_level + uid: sqlite3.Connection.isolation_level +- fullName: sqlite3.Connection.row_factory + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.row_factory + name: row_factory + uid: sqlite3.Connection.row_factory +- fullName: sqlite3.Connection.text_factory + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.text_factory + name: text_factory + uid: sqlite3.Connection.text_factory +- fullName: sqlite3.Connection.total_changes + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.total_changes + name: total_changes + uid: sqlite3.Connection.total_changes +- fullName: sqlite3.Cursor.arraysize + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Cursor.arraysize + name: arraysize + uid: sqlite3.Cursor.arraysize +- fullName: sqlite3.Cursor.connection + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Cursor.connection + name: connection + uid: sqlite3.Cursor.connection +- fullName: sqlite3.Cursor.description + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Cursor.description + name: description + uid: sqlite3.Cursor.description +- fullName: sqlite3.Cursor.lastrowid + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Cursor.lastrowid + name: lastrowid + uid: sqlite3.Cursor.lastrowid +- fullName: sqlite3.Cursor.row_factory + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Cursor.row_factory + name: row_factory + uid: sqlite3.Cursor.row_factory +- fullName: sqlite3.Cursor.rowcount + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Cursor.rowcount + name: rowcount + uid: sqlite3.Cursor.rowcount +- fullName: sqlite3.Error.sqlite_errorcode + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Error.sqlite_errorcode + name: sqlite_errorcode + uid: sqlite3.Error.sqlite_errorcode +- fullName: sqlite3.Error.sqlite_errorname + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Error.sqlite_errorname + name: sqlite_errorname + uid: sqlite3.Error.sqlite_errorname +- fullName: ssl.MemoryBIO.eof + href: https://docs.python.org/3/library/ssl.html#ssl.MemoryBIO.eof + name: eof + uid: ssl.MemoryBIO.eof +- fullName: ssl.MemoryBIO.pending + href: https://docs.python.org/3/library/ssl.html#ssl.MemoryBIO.pending + name: pending + uid: ssl.MemoryBIO.pending +- fullName: ssl.SSLCertVerificationError.verify_code + href: https://docs.python.org/3/library/ssl.html#ssl.SSLCertVerificationError.verify_code + name: verify_code + uid: ssl.SSLCertVerificationError.verify_code +- fullName: ssl.SSLCertVerificationError.verify_message + href: https://docs.python.org/3/library/ssl.html#ssl.SSLCertVerificationError.verify_message + name: verify_message + uid: ssl.SSLCertVerificationError.verify_message +- fullName: ssl.SSLContext.check_hostname + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.check_hostname + name: check_hostname + uid: ssl.SSLContext.check_hostname +- fullName: ssl.SSLContext.hostname_checks_common_name + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.hostname_checks_common_name + name: hostname_checks_common_name + uid: ssl.SSLContext.hostname_checks_common_name +- fullName: ssl.SSLContext.keylog_filename + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.keylog_filename + name: keylog_filename + uid: ssl.SSLContext.keylog_filename +- fullName: ssl.SSLContext.maximum_version + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.maximum_version + name: maximum_version + uid: ssl.SSLContext.maximum_version +- fullName: ssl.SSLContext.minimum_version + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.minimum_version + name: minimum_version + uid: ssl.SSLContext.minimum_version +- fullName: ssl.SSLContext.num_tickets + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.num_tickets + name: num_tickets + uid: ssl.SSLContext.num_tickets +- fullName: ssl.SSLContext.options + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.options + name: options + uid: ssl.SSLContext.options +- fullName: ssl.SSLContext.post_handshake_auth + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.post_handshake_auth + name: post_handshake_auth + uid: ssl.SSLContext.post_handshake_auth +- fullName: ssl.SSLContext.protocol + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.protocol + name: protocol + uid: ssl.SSLContext.protocol +- fullName: ssl.SSLContext.security_level + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.security_level + name: security_level + uid: ssl.SSLContext.security_level +- fullName: ssl.SSLContext.set_servername_callback + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.set_servername_callback + name: set_servername_callback + uid: ssl.SSLContext.set_servername_callback +- fullName: ssl.SSLContext.sni_callback + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.sni_callback + name: sni_callback + uid: ssl.SSLContext.sni_callback +- fullName: ssl.SSLContext.sslobject_class + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.sslobject_class + name: sslobject_class + uid: ssl.SSLContext.sslobject_class +- fullName: ssl.SSLContext.sslsocket_class + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.sslsocket_class + name: sslsocket_class + uid: ssl.SSLContext.sslsocket_class +- fullName: ssl.SSLContext.verify_flags + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.verify_flags + name: verify_flags + uid: ssl.SSLContext.verify_flags +- fullName: ssl.SSLContext.verify_mode + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.verify_mode + name: verify_mode + uid: ssl.SSLContext.verify_mode +- fullName: ssl.SSLError.library + href: https://docs.python.org/3/library/ssl.html#ssl.SSLError.library + name: library + uid: ssl.SSLError.library +- fullName: ssl.SSLError.reason + href: https://docs.python.org/3/library/ssl.html#ssl.SSLError.reason + name: reason + uid: ssl.SSLError.reason +- fullName: ssl.SSLSession.has_ticket + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSession.has_ticket + name: has_ticket + uid: ssl.SSLSession.has_ticket +- fullName: ssl.SSLSession.id + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSession.id + name: id + uid: ssl.SSLSession.id +- fullName: ssl.SSLSession.ticket_lifetime_hint + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSession.ticket_lifetime_hint + name: ticket_lifetime_hint + uid: ssl.SSLSession.ticket_lifetime_hint +- fullName: ssl.SSLSession.time + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSession.time + name: time + uid: ssl.SSLSession.time +- fullName: ssl.SSLSession.timeout + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSession.timeout + name: timeout + uid: ssl.SSLSession.timeout +- fullName: ssl.SSLSocket.context + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSocket.context + name: context + uid: ssl.SSLSocket.context +- fullName: ssl.SSLSocket.server_hostname + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSocket.server_hostname + name: server_hostname + uid: ssl.SSLSocket.server_hostname +- fullName: ssl.SSLSocket.server_side + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSocket.server_side + name: server_side + uid: ssl.SSLSocket.server_side +- fullName: ssl.SSLSocket.session + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSocket.session + name: session + uid: ssl.SSLSocket.session +- fullName: ssl.SSLSocket.session_reused + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSocket.session_reused + name: session_reused + uid: ssl.SSLSocket.session_reused +- fullName: ssl.TLSVersion.MAXIMUM_SUPPORTED + href: https://docs.python.org/3/library/ssl.html#ssl.TLSVersion.MAXIMUM_SUPPORTED + name: MAXIMUM_SUPPORTED + uid: ssl.TLSVersion.MAXIMUM_SUPPORTED +- fullName: ssl.TLSVersion.MINIMUM_SUPPORTED + href: https://docs.python.org/3/library/ssl.html#ssl.TLSVersion.MINIMUM_SUPPORTED + name: MINIMUM_SUPPORTED + uid: ssl.TLSVersion.MINIMUM_SUPPORTED +- fullName: ssl.TLSVersion.SSLv3 + href: https://docs.python.org/3/library/ssl.html#ssl.TLSVersion.SSLv3 + name: SSLv3 + uid: ssl.TLSVersion.SSLv3 +- fullName: ssl.TLSVersion.TLSv1 + href: https://docs.python.org/3/library/ssl.html#ssl.TLSVersion.TLSv1 + name: TLSv1 + uid: ssl.TLSVersion.TLSv1 +- fullName: ssl.TLSVersion.TLSv1_1 + href: https://docs.python.org/3/library/ssl.html#ssl.TLSVersion.TLSv1_1 + name: TLSv1_1 + uid: ssl.TLSVersion.TLSv1_1 +- fullName: ssl.TLSVersion.TLSv1_2 + href: https://docs.python.org/3/library/ssl.html#ssl.TLSVersion.TLSv1_2 + name: TLSv1_2 + uid: ssl.TLSVersion.TLSv1_2 +- fullName: ssl.TLSVersion.TLSv1_3 + href: https://docs.python.org/3/library/ssl.html#ssl.TLSVersion.TLSv1_3 + name: TLSv1_3 + uid: ssl.TLSVersion.TLSv1_3 +- fullName: statistics.NormalDist.mean + href: https://docs.python.org/3/library/statistics.html#statistics.NormalDist.mean + name: mean + uid: statistics.NormalDist.mean +- fullName: statistics.NormalDist.median + href: https://docs.python.org/3/library/statistics.html#statistics.NormalDist.median + name: median + uid: statistics.NormalDist.median +- fullName: statistics.NormalDist.mode + href: https://docs.python.org/3/library/statistics.html#statistics.NormalDist.mode + name: mode + uid: statistics.NormalDist.mode +- fullName: statistics.NormalDist.stdev + href: https://docs.python.org/3/library/statistics.html#statistics.NormalDist.stdev + name: stdev + uid: statistics.NormalDist.stdev +- fullName: statistics.NormalDist.variance + href: https://docs.python.org/3/library/statistics.html#statistics.NormalDist.variance + name: variance + uid: statistics.NormalDist.variance +- fullName: string.Template.template + href: https://docs.python.org/3/library/string.html#string.Template.template + name: template + uid: string.Template.template +- fullName: struct.Struct.format + href: https://docs.python.org/3/library/struct.html#struct.Struct.format + name: format + uid: struct.Struct.format +- fullName: struct.Struct.size + href: https://docs.python.org/3/library/struct.html#struct.Struct.size + name: size + uid: struct.Struct.size +- fullName: subprocess.CalledProcessError.cmd + href: https://docs.python.org/3/library/subprocess.html#subprocess.CalledProcessError.cmd + name: cmd + uid: subprocess.CalledProcessError.cmd +- fullName: subprocess.CalledProcessError.output + href: https://docs.python.org/3/library/subprocess.html#subprocess.CalledProcessError.output + name: output + uid: subprocess.CalledProcessError.output +- fullName: subprocess.CalledProcessError.returncode + href: https://docs.python.org/3/library/subprocess.html#subprocess.CalledProcessError.returncode + name: returncode + uid: subprocess.CalledProcessError.returncode +- fullName: subprocess.CalledProcessError.stderr + href: https://docs.python.org/3/library/subprocess.html#subprocess.CalledProcessError.stderr + name: stderr + uid: subprocess.CalledProcessError.stderr +- fullName: subprocess.CalledProcessError.stdout + href: https://docs.python.org/3/library/subprocess.html#subprocess.CalledProcessError.stdout + name: stdout + uid: subprocess.CalledProcessError.stdout +- fullName: subprocess.CompletedProcess.args + href: https://docs.python.org/3/library/subprocess.html#subprocess.CompletedProcess.args + name: args + uid: subprocess.CompletedProcess.args +- fullName: subprocess.CompletedProcess.returncode + href: https://docs.python.org/3/library/subprocess.html#subprocess.CompletedProcess.returncode + name: returncode + uid: subprocess.CompletedProcess.returncode +- fullName: subprocess.CompletedProcess.stderr + href: https://docs.python.org/3/library/subprocess.html#subprocess.CompletedProcess.stderr + name: stderr + uid: subprocess.CompletedProcess.stderr +- fullName: subprocess.CompletedProcess.stdout + href: https://docs.python.org/3/library/subprocess.html#subprocess.CompletedProcess.stdout + name: stdout + uid: subprocess.CompletedProcess.stdout +- fullName: subprocess.Popen.args + href: https://docs.python.org/3/library/subprocess.html#subprocess.Popen.args + name: args + uid: subprocess.Popen.args +- fullName: subprocess.Popen.pid + href: https://docs.python.org/3/library/subprocess.html#subprocess.Popen.pid + name: pid + uid: subprocess.Popen.pid +- fullName: subprocess.Popen.returncode + href: https://docs.python.org/3/library/subprocess.html#subprocess.Popen.returncode + name: returncode + uid: subprocess.Popen.returncode +- fullName: subprocess.Popen.stderr + href: https://docs.python.org/3/library/subprocess.html#subprocess.Popen.stderr + name: stderr + uid: subprocess.Popen.stderr +- fullName: subprocess.Popen.stdin + href: https://docs.python.org/3/library/subprocess.html#subprocess.Popen.stdin + name: stdin + uid: subprocess.Popen.stdin +- fullName: subprocess.Popen.stdout + href: https://docs.python.org/3/library/subprocess.html#subprocess.Popen.stdout + name: stdout + uid: subprocess.Popen.stdout +- fullName: subprocess.STARTUPINFO.dwFlags + href: https://docs.python.org/3/library/subprocess.html#subprocess.STARTUPINFO.dwFlags + name: dwFlags + uid: subprocess.STARTUPINFO.dwFlags +- fullName: subprocess.STARTUPINFO.hStdError + href: https://docs.python.org/3/library/subprocess.html#subprocess.STARTUPINFO.hStdError + name: hStdError + uid: subprocess.STARTUPINFO.hStdError +- fullName: subprocess.STARTUPINFO.hStdInput + href: https://docs.python.org/3/library/subprocess.html#subprocess.STARTUPINFO.hStdInput + name: hStdInput + uid: subprocess.STARTUPINFO.hStdInput +- fullName: subprocess.STARTUPINFO.hStdOutput + href: https://docs.python.org/3/library/subprocess.html#subprocess.STARTUPINFO.hStdOutput + name: hStdOutput + uid: subprocess.STARTUPINFO.hStdOutput +- fullName: subprocess.STARTUPINFO.lpAttributeList + href: https://docs.python.org/3/library/subprocess.html#subprocess.STARTUPINFO.lpAttributeList + name: lpAttributeList + uid: subprocess.STARTUPINFO.lpAttributeList +- fullName: subprocess.STARTUPINFO.wShowWindow + href: https://docs.python.org/3/library/subprocess.html#subprocess.STARTUPINFO.wShowWindow + name: wShowWindow + uid: subprocess.STARTUPINFO.wShowWindow +- fullName: subprocess.TimeoutExpired.cmd + href: https://docs.python.org/3/library/subprocess.html#subprocess.TimeoutExpired.cmd + name: cmd + uid: subprocess.TimeoutExpired.cmd +- fullName: subprocess.TimeoutExpired.output + href: https://docs.python.org/3/library/subprocess.html#subprocess.TimeoutExpired.output + name: output + uid: subprocess.TimeoutExpired.output +- fullName: subprocess.TimeoutExpired.stderr + href: https://docs.python.org/3/library/subprocess.html#subprocess.TimeoutExpired.stderr + name: stderr + uid: subprocess.TimeoutExpired.stderr +- fullName: subprocess.TimeoutExpired.stdout + href: https://docs.python.org/3/library/subprocess.html#subprocess.TimeoutExpired.stdout + name: stdout + uid: subprocess.TimeoutExpired.stdout +- fullName: subprocess.TimeoutExpired.timeout + href: https://docs.python.org/3/library/subprocess.html#subprocess.TimeoutExpired.timeout + name: timeout + uid: subprocess.TimeoutExpired.timeout +- fullName: symtable.SymbolTableType.ANNOTATION + href: https://docs.python.org/3/library/symtable.html#symtable.SymbolTableType.ANNOTATION + name: ANNOTATION + uid: symtable.SymbolTableType.ANNOTATION +- fullName: symtable.SymbolTableType.CLASS + href: https://docs.python.org/3/library/symtable.html#symtable.SymbolTableType.CLASS + name: CLASS + uid: symtable.SymbolTableType.CLASS +- fullName: symtable.SymbolTableType.FUNCTION + href: https://docs.python.org/3/library/symtable.html#symtable.SymbolTableType.FUNCTION + name: FUNCTION + uid: symtable.SymbolTableType.FUNCTION +- fullName: symtable.SymbolTableType.MODULE + href: https://docs.python.org/3/library/symtable.html#symtable.SymbolTableType.MODULE + name: MODULE + uid: symtable.SymbolTableType.MODULE +- fullName: symtable.SymbolTableType.TYPE_ALIAS + href: https://docs.python.org/3/library/symtable.html#symtable.SymbolTableType.TYPE_ALIAS + name: TYPE_ALIAS + uid: symtable.SymbolTableType.TYPE_ALIAS +- fullName: symtable.SymbolTableType.TYPE_PARAMETERS + href: https://docs.python.org/3/library/symtable.html#symtable.SymbolTableType.TYPE_PARAMETERS + name: TYPE_PARAMETERS + uid: symtable.SymbolTableType.TYPE_PARAMETERS +- fullName: symtable.SymbolTableType.TYPE_VARIABLE + href: https://docs.python.org/3/library/symtable.html#symtable.SymbolTableType.TYPE_VARIABLE + name: TYPE_VARIABLE + uid: symtable.SymbolTableType.TYPE_VARIABLE +- fullName: sys._emscripten_info.emscripten_version + href: https://docs.python.org/3/library/sys.html#sys._emscripten_info.emscripten_version + name: emscripten_version + uid: sys._emscripten_info.emscripten_version +- fullName: sys._emscripten_info.pthreads + href: https://docs.python.org/3/library/sys.html#sys._emscripten_info.pthreads + name: pthreads + uid: sys._emscripten_info.pthreads +- fullName: sys._emscripten_info.runtime + href: https://docs.python.org/3/library/sys.html#sys._emscripten_info.runtime + name: runtime + uid: sys._emscripten_info.runtime +- fullName: sys._emscripten_info.shared_memory + href: https://docs.python.org/3/library/sys.html#sys._emscripten_info.shared_memory + name: shared_memory + uid: sys._emscripten_info.shared_memory +- fullName: sys.flags.bytes_warning + href: https://docs.python.org/3/library/sys.html#sys.flags.bytes_warning + name: bytes_warning + uid: sys.flags.bytes_warning +- fullName: sys.flags.debug + href: https://docs.python.org/3/library/sys.html#sys.flags.debug + name: debug + uid: sys.flags.debug +- fullName: sys.flags.dev_mode + href: https://docs.python.org/3/library/sys.html#sys.flags.dev_mode + name: dev_mode + uid: sys.flags.dev_mode +- fullName: sys.flags.dont_write_bytecode + href: https://docs.python.org/3/library/sys.html#sys.flags.dont_write_bytecode + name: dont_write_bytecode + uid: sys.flags.dont_write_bytecode +- fullName: sys.flags.hash_randomization + href: https://docs.python.org/3/library/sys.html#sys.flags.hash_randomization + name: hash_randomization + uid: sys.flags.hash_randomization +- fullName: sys.flags.ignore_environment + href: https://docs.python.org/3/library/sys.html#sys.flags.ignore_environment + name: ignore_environment + uid: sys.flags.ignore_environment +- fullName: sys.flags.inspect + href: https://docs.python.org/3/library/sys.html#sys.flags.inspect + name: inspect + uid: sys.flags.inspect +- fullName: sys.flags.int_max_str_digits + href: https://docs.python.org/3/library/sys.html#sys.flags.int_max_str_digits + name: int_max_str_digits + uid: sys.flags.int_max_str_digits +- fullName: sys.flags.interactive + href: https://docs.python.org/3/library/sys.html#sys.flags.interactive + name: interactive + uid: sys.flags.interactive +- fullName: sys.flags.isolated + href: https://docs.python.org/3/library/sys.html#sys.flags.isolated + name: isolated + uid: sys.flags.isolated +- fullName: sys.flags.no_site + href: https://docs.python.org/3/library/sys.html#sys.flags.no_site + name: no_site + uid: sys.flags.no_site +- fullName: sys.flags.no_user_site + href: https://docs.python.org/3/library/sys.html#sys.flags.no_user_site + name: no_user_site + uid: sys.flags.no_user_site +- fullName: sys.flags.optimize + href: https://docs.python.org/3/library/sys.html#sys.flags.optimize + name: optimize + uid: sys.flags.optimize +- fullName: sys.flags.quiet + href: https://docs.python.org/3/library/sys.html#sys.flags.quiet + name: quiet + uid: sys.flags.quiet +- fullName: sys.flags.safe_path + href: https://docs.python.org/3/library/sys.html#sys.flags.safe_path + name: safe_path + uid: sys.flags.safe_path +- fullName: sys.flags.utf8_mode + href: https://docs.python.org/3/library/sys.html#sys.flags.utf8_mode + name: utf8_mode + uid: sys.flags.utf8_mode +- fullName: sys.flags.verbose + href: https://docs.python.org/3/library/sys.html#sys.flags.verbose + name: verbose + uid: sys.flags.verbose +- fullName: sys.flags.warn_default_encoding + href: https://docs.python.org/3/library/sys.html#sys.flags.warn_default_encoding + name: warn_default_encoding + uid: sys.flags.warn_default_encoding +- fullName: sys.float_info.dig + href: https://docs.python.org/3/library/sys.html#sys.float_info.dig + name: dig + uid: sys.float_info.dig +- fullName: sys.float_info.epsilon + href: https://docs.python.org/3/library/sys.html#sys.float_info.epsilon + name: epsilon + uid: sys.float_info.epsilon +- fullName: sys.float_info.mant_dig + href: https://docs.python.org/3/library/sys.html#sys.float_info.mant_dig + name: mant_dig + uid: sys.float_info.mant_dig +- fullName: sys.float_info.max + href: https://docs.python.org/3/library/sys.html#sys.float_info.max + name: max + uid: sys.float_info.max +- fullName: sys.float_info.max_10_exp + href: https://docs.python.org/3/library/sys.html#sys.float_info.max_10_exp + name: max_10_exp + uid: sys.float_info.max_10_exp +- fullName: sys.float_info.max_exp + href: https://docs.python.org/3/library/sys.html#sys.float_info.max_exp + name: max_exp + uid: sys.float_info.max_exp +- fullName: sys.float_info.min + href: https://docs.python.org/3/library/sys.html#sys.float_info.min + name: min + uid: sys.float_info.min +- fullName: sys.float_info.min_10_exp + href: https://docs.python.org/3/library/sys.html#sys.float_info.min_10_exp + name: min_10_exp + uid: sys.float_info.min_10_exp +- fullName: sys.float_info.min_exp + href: https://docs.python.org/3/library/sys.html#sys.float_info.min_exp + name: min_exp + uid: sys.float_info.min_exp +- fullName: sys.float_info.radix + href: https://docs.python.org/3/library/sys.html#sys.float_info.radix + name: radix + uid: sys.float_info.radix +- fullName: sys.float_info.rounds + href: https://docs.python.org/3/library/sys.html#sys.float_info.rounds + name: rounds + uid: sys.float_info.rounds +- fullName: sys.hash_info.algorithm + href: https://docs.python.org/3/library/sys.html#sys.hash_info.algorithm + name: algorithm + uid: sys.hash_info.algorithm +- fullName: sys.hash_info.hash_bits + href: https://docs.python.org/3/library/sys.html#sys.hash_info.hash_bits + name: hash_bits + uid: sys.hash_info.hash_bits +- fullName: sys.hash_info.imag + href: https://docs.python.org/3/library/sys.html#sys.hash_info.imag + name: imag + uid: sys.hash_info.imag +- fullName: sys.hash_info.inf + href: https://docs.python.org/3/library/sys.html#sys.hash_info.inf + name: inf + uid: sys.hash_info.inf +- fullName: sys.hash_info.modulus + href: https://docs.python.org/3/library/sys.html#sys.hash_info.modulus + name: modulus + uid: sys.hash_info.modulus +- fullName: sys.hash_info.nan + href: https://docs.python.org/3/library/sys.html#sys.hash_info.nan + name: nan + uid: sys.hash_info.nan +- fullName: sys.hash_info.seed_bits + href: https://docs.python.org/3/library/sys.html#sys.hash_info.seed_bits + name: seed_bits + uid: sys.hash_info.seed_bits +- fullName: sys.hash_info.width + href: https://docs.python.org/3/library/sys.html#sys.hash_info.width + name: width + uid: sys.hash_info.width +- fullName: sys.int_info.bits_per_digit + href: https://docs.python.org/3/library/sys.html#sys.int_info.bits_per_digit + name: bits_per_digit + uid: sys.int_info.bits_per_digit +- fullName: sys.int_info.default_max_str_digits + href: https://docs.python.org/3/library/sys.html#sys.int_info.default_max_str_digits + name: default_max_str_digits + uid: sys.int_info.default_max_str_digits +- fullName: sys.int_info.sizeof_digit + href: https://docs.python.org/3/library/sys.html#sys.int_info.sizeof_digit + name: sizeof_digit + uid: sys.int_info.sizeof_digit +- fullName: sys.int_info.str_digits_check_threshold + href: https://docs.python.org/3/library/sys.html#sys.int_info.str_digits_check_threshold + name: str_digits_check_threshold + uid: sys.int_info.str_digits_check_threshold +- fullName: sys.thread_info.lock + href: https://docs.python.org/3/library/sys.html#sys.thread_info.lock + name: lock + uid: sys.thread_info.lock +- fullName: sys.thread_info.name + href: https://docs.python.org/3/library/sys.html#sys.thread_info.name + name: name + uid: sys.thread_info.name +- fullName: sys.thread_info.version + href: https://docs.python.org/3/library/sys.html#sys.thread_info.version + name: version + uid: sys.thread_info.version +- fullName: tarfile.FilterError.tarinfo + href: https://docs.python.org/3/library/tarfile.html#tarfile.FilterError.tarinfo + name: tarinfo + uid: tarfile.FilterError.tarinfo +- fullName: tarfile.TarFile.errorlevel + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarFile.errorlevel + name: errorlevel + uid: tarfile.TarFile.errorlevel +- fullName: tarfile.TarFile.extraction_filter + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarFile.extraction_filter + name: extraction_filter + uid: tarfile.TarFile.extraction_filter +- fullName: tarfile.TarFile.pax_headers + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarFile.pax_headers + name: pax_headers + uid: tarfile.TarFile.pax_headers +- fullName: tarfile.TarInfo.chksum + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.chksum + name: chksum + uid: tarfile.TarInfo.chksum +- fullName: tarfile.TarInfo.devmajor + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.devmajor + name: devmajor + uid: tarfile.TarInfo.devmajor +- fullName: tarfile.TarInfo.devminor + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.devminor + name: devminor + uid: tarfile.TarInfo.devminor +- fullName: tarfile.TarInfo.gid + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.gid + name: gid + uid: tarfile.TarInfo.gid +- fullName: tarfile.TarInfo.gname + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.gname + name: gname + uid: tarfile.TarInfo.gname +- fullName: tarfile.TarInfo.linkname + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.linkname + name: linkname + uid: tarfile.TarInfo.linkname +- fullName: tarfile.TarInfo.mode + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.mode + name: mode + uid: tarfile.TarInfo.mode +- fullName: tarfile.TarInfo.mtime + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.mtime + name: mtime + uid: tarfile.TarInfo.mtime +- fullName: tarfile.TarInfo.name + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.name + name: name + uid: tarfile.TarInfo.name +- fullName: tarfile.TarInfo.offset + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.offset + name: offset + uid: tarfile.TarInfo.offset +- fullName: tarfile.TarInfo.offset_data + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.offset_data + name: offset_data + uid: tarfile.TarInfo.offset_data +- fullName: tarfile.TarInfo.pax_headers + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.pax_headers + name: pax_headers + uid: tarfile.TarInfo.pax_headers +- fullName: tarfile.TarInfo.size + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.size + name: size + uid: tarfile.TarInfo.size +- fullName: tarfile.TarInfo.sparse + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.sparse + name: sparse + uid: tarfile.TarInfo.sparse +- fullName: tarfile.TarInfo.type + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.type + name: type + uid: tarfile.TarInfo.type +- fullName: tarfile.TarInfo.uid + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.uid + name: uid + uid: tarfile.TarInfo.uid +- fullName: tarfile.TarInfo.uname + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.uname + name: uname + uid: tarfile.TarInfo.uname +- fullName: tempfile.TemporaryDirectory.name + href: https://docs.python.org/3/library/tempfile.html#tempfile.TemporaryDirectory.name + name: name + uid: tempfile.TemporaryDirectory.name +- fullName: textwrap.TextWrapper.break_long_words + href: https://docs.python.org/3/library/textwrap.html#textwrap.TextWrapper.break_long_words + name: break_long_words + uid: textwrap.TextWrapper.break_long_words +- fullName: textwrap.TextWrapper.break_on_hyphens + href: https://docs.python.org/3/library/textwrap.html#textwrap.TextWrapper.break_on_hyphens + name: break_on_hyphens + uid: textwrap.TextWrapper.break_on_hyphens +- fullName: textwrap.TextWrapper.drop_whitespace + href: https://docs.python.org/3/library/textwrap.html#textwrap.TextWrapper.drop_whitespace + name: drop_whitespace + uid: textwrap.TextWrapper.drop_whitespace +- fullName: textwrap.TextWrapper.expand_tabs + href: https://docs.python.org/3/library/textwrap.html#textwrap.TextWrapper.expand_tabs + name: expand_tabs + uid: textwrap.TextWrapper.expand_tabs +- fullName: textwrap.TextWrapper.fix_sentence_endings + href: https://docs.python.org/3/library/textwrap.html#textwrap.TextWrapper.fix_sentence_endings + name: fix_sentence_endings + uid: textwrap.TextWrapper.fix_sentence_endings +- fullName: textwrap.TextWrapper.initial_indent + href: https://docs.python.org/3/library/textwrap.html#textwrap.TextWrapper.initial_indent + name: initial_indent + uid: textwrap.TextWrapper.initial_indent +- fullName: textwrap.TextWrapper.max_lines + href: https://docs.python.org/3/library/textwrap.html#textwrap.TextWrapper.max_lines + name: max_lines + uid: textwrap.TextWrapper.max_lines +- fullName: textwrap.TextWrapper.placeholder + href: https://docs.python.org/3/library/textwrap.html#textwrap.TextWrapper.placeholder + name: placeholder + uid: textwrap.TextWrapper.placeholder +- fullName: textwrap.TextWrapper.replace_whitespace + href: https://docs.python.org/3/library/textwrap.html#textwrap.TextWrapper.replace_whitespace + name: replace_whitespace + uid: textwrap.TextWrapper.replace_whitespace +- fullName: textwrap.TextWrapper.subsequent_indent + href: https://docs.python.org/3/library/textwrap.html#textwrap.TextWrapper.subsequent_indent + name: subsequent_indent + uid: textwrap.TextWrapper.subsequent_indent +- fullName: textwrap.TextWrapper.tabsize + href: https://docs.python.org/3/library/textwrap.html#textwrap.TextWrapper.tabsize + name: tabsize + uid: textwrap.TextWrapper.tabsize +- fullName: textwrap.TextWrapper.width + href: https://docs.python.org/3/library/textwrap.html#textwrap.TextWrapper.width + name: width + uid: textwrap.TextWrapper.width +- fullName: threading.Barrier.broken + href: https://docs.python.org/3/library/threading.html#threading.Barrier.broken + name: broken + uid: threading.Barrier.broken +- fullName: threading.Barrier.n_waiting + href: https://docs.python.org/3/library/threading.html#threading.Barrier.n_waiting + name: n_waiting + uid: threading.Barrier.n_waiting +- fullName: threading.Barrier.parties + href: https://docs.python.org/3/library/threading.html#threading.Barrier.parties + name: parties + uid: threading.Barrier.parties +- fullName: threading.Thread.daemon + href: https://docs.python.org/3/library/threading.html#threading.Thread.daemon + name: daemon + uid: threading.Thread.daemon +- fullName: threading.Thread.ident + href: https://docs.python.org/3/library/threading.html#threading.Thread.ident + name: ident + uid: threading.Thread.ident +- fullName: threading.Thread.name + href: https://docs.python.org/3/library/threading.html#threading.Thread.name + name: name + uid: threading.Thread.name +- fullName: threading.Thread.native_id + href: https://docs.python.org/3/library/threading.html#threading.Thread.native_id + name: native_id + uid: threading.Thread.native_id +- fullName: time.struct_time.tm_gmtoff + href: https://docs.python.org/3/library/time.html#time.struct_time.tm_gmtoff + name: tm_gmtoff + uid: time.struct_time.tm_gmtoff +- fullName: time.struct_time.tm_hour + href: https://docs.python.org/3/library/time.html#time.struct_time.tm_hour + name: tm_hour + uid: time.struct_time.tm_hour +- fullName: time.struct_time.tm_isdst + href: https://docs.python.org/3/library/time.html#time.struct_time.tm_isdst + name: tm_isdst + uid: time.struct_time.tm_isdst +- fullName: time.struct_time.tm_mday + href: https://docs.python.org/3/library/time.html#time.struct_time.tm_mday + name: tm_mday + uid: time.struct_time.tm_mday +- fullName: time.struct_time.tm_min + href: https://docs.python.org/3/library/time.html#time.struct_time.tm_min + name: tm_min + uid: time.struct_time.tm_min +- fullName: time.struct_time.tm_mon + href: https://docs.python.org/3/library/time.html#time.struct_time.tm_mon + name: tm_mon + uid: time.struct_time.tm_mon +- fullName: time.struct_time.tm_sec + href: https://docs.python.org/3/library/time.html#time.struct_time.tm_sec + name: tm_sec + uid: time.struct_time.tm_sec +- fullName: time.struct_time.tm_wday + href: https://docs.python.org/3/library/time.html#time.struct_time.tm_wday + name: tm_wday + uid: time.struct_time.tm_wday +- fullName: time.struct_time.tm_yday + href: https://docs.python.org/3/library/time.html#time.struct_time.tm_yday + name: tm_yday + uid: time.struct_time.tm_yday +- fullName: time.struct_time.tm_year + href: https://docs.python.org/3/library/time.html#time.struct_time.tm_year + name: tm_year + uid: time.struct_time.tm_year +- fullName: time.struct_time.tm_zone + href: https://docs.python.org/3/library/time.html#time.struct_time.tm_zone + name: tm_zone + uid: time.struct_time.tm_zone +- fullName: tkinter.Tk.children + href: https://docs.python.org/3/library/tkinter.html#tkinter.Tk.children + name: children + uid: tkinter.Tk.children +- fullName: tkinter.Tk.master + href: https://docs.python.org/3/library/tkinter.html#tkinter.Tk.master + name: master + uid: tkinter.Tk.master +- fullName: tkinter.Tk.tk + href: https://docs.python.org/3/library/tkinter.html#tkinter.Tk.tk + name: tk + uid: tkinter.Tk.tk +- fullName: tkinter.scrolledtext.ScrolledText.frame + href: https://docs.python.org/3/library/tkinter.scrolledtext.html#tkinter.scrolledtext.ScrolledText.frame + name: frame + uid: tkinter.scrolledtext.ScrolledText.frame +- fullName: tkinter.scrolledtext.ScrolledText.vbar + href: https://docs.python.org/3/library/tkinter.scrolledtext.html#tkinter.scrolledtext.ScrolledText.vbar + name: vbar + uid: tkinter.scrolledtext.ScrolledText.vbar +- fullName: traceback.FrameSummary.colno + href: https://docs.python.org/3/library/traceback.html#traceback.FrameSummary.colno + name: colno + uid: traceback.FrameSummary.colno +- fullName: traceback.FrameSummary.end_colno + href: https://docs.python.org/3/library/traceback.html#traceback.FrameSummary.end_colno + name: end_colno + uid: traceback.FrameSummary.end_colno +- fullName: traceback.FrameSummary.end_lineno + href: https://docs.python.org/3/library/traceback.html#traceback.FrameSummary.end_lineno + name: end_lineno + uid: traceback.FrameSummary.end_lineno +- fullName: traceback.FrameSummary.filename + href: https://docs.python.org/3/library/traceback.html#traceback.FrameSummary.filename + name: filename + uid: traceback.FrameSummary.filename +- fullName: traceback.FrameSummary.line + href: https://docs.python.org/3/library/traceback.html#traceback.FrameSummary.line + name: line + uid: traceback.FrameSummary.line +- fullName: traceback.FrameSummary.lineno + href: https://docs.python.org/3/library/traceback.html#traceback.FrameSummary.lineno + name: lineno + uid: traceback.FrameSummary.lineno +- fullName: traceback.FrameSummary.name + href: https://docs.python.org/3/library/traceback.html#traceback.FrameSummary.name + name: name + uid: traceback.FrameSummary.name +- fullName: traceback.TracebackException.__cause__ + href: https://docs.python.org/3/library/traceback.html#traceback.TracebackException.__cause__ + name: __cause__ + uid: traceback.TracebackException.__cause__ +- fullName: traceback.TracebackException.__context__ + href: https://docs.python.org/3/library/traceback.html#traceback.TracebackException.__context__ + name: __context__ + uid: traceback.TracebackException.__context__ +- fullName: traceback.TracebackException.__notes__ + href: https://docs.python.org/3/library/traceback.html#traceback.TracebackException.__notes__ + name: __notes__ + uid: traceback.TracebackException.__notes__ +- fullName: traceback.TracebackException.__suppress_context__ + href: https://docs.python.org/3/library/traceback.html#traceback.TracebackException.__suppress_context__ + name: __suppress_context__ + uid: traceback.TracebackException.__suppress_context__ +- fullName: traceback.TracebackException.end_lineno + href: https://docs.python.org/3/library/traceback.html#traceback.TracebackException.end_lineno + name: end_lineno + uid: traceback.TracebackException.end_lineno +- fullName: traceback.TracebackException.end_offset + href: https://docs.python.org/3/library/traceback.html#traceback.TracebackException.end_offset + name: end_offset + uid: traceback.TracebackException.end_offset +- fullName: traceback.TracebackException.exc_type + href: https://docs.python.org/3/library/traceback.html#traceback.TracebackException.exc_type + name: exc_type + uid: traceback.TracebackException.exc_type +- fullName: traceback.TracebackException.exc_type_str + href: https://docs.python.org/3/library/traceback.html#traceback.TracebackException.exc_type_str + name: exc_type_str + uid: traceback.TracebackException.exc_type_str +- fullName: traceback.TracebackException.exceptions + href: https://docs.python.org/3/library/traceback.html#traceback.TracebackException.exceptions + name: exceptions + uid: traceback.TracebackException.exceptions +- fullName: traceback.TracebackException.filename + href: https://docs.python.org/3/library/traceback.html#traceback.TracebackException.filename + name: filename + uid: traceback.TracebackException.filename +- fullName: traceback.TracebackException.lineno + href: https://docs.python.org/3/library/traceback.html#traceback.TracebackException.lineno + name: lineno + uid: traceback.TracebackException.lineno +- fullName: traceback.TracebackException.msg + href: https://docs.python.org/3/library/traceback.html#traceback.TracebackException.msg + name: msg + uid: traceback.TracebackException.msg +- fullName: traceback.TracebackException.offset + href: https://docs.python.org/3/library/traceback.html#traceback.TracebackException.offset + name: offset + uid: traceback.TracebackException.offset +- fullName: traceback.TracebackException.stack + href: https://docs.python.org/3/library/traceback.html#traceback.TracebackException.stack + name: stack + uid: traceback.TracebackException.stack +- fullName: traceback.TracebackException.text + href: https://docs.python.org/3/library/traceback.html#traceback.TracebackException.text + name: text + uid: traceback.TracebackException.text +- fullName: traceback.tb_frame + href: https://docs.python.org/3/reference/datamodel.html#traceback.tb_frame + name: tb_frame + uid: traceback.tb_frame +- fullName: traceback.tb_lasti + href: https://docs.python.org/3/reference/datamodel.html#traceback.tb_lasti + name: tb_lasti + uid: traceback.tb_lasti +- fullName: traceback.tb_lineno + href: https://docs.python.org/3/reference/datamodel.html#traceback.tb_lineno + name: tb_lineno + uid: traceback.tb_lineno +- fullName: traceback.tb_next + href: https://docs.python.org/3/reference/datamodel.html#traceback.tb_next + name: tb_next + uid: traceback.tb_next +- fullName: tracemalloc.DomainFilter.domain + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.DomainFilter.domain + name: domain + uid: tracemalloc.DomainFilter.domain +- fullName: tracemalloc.DomainFilter.inclusive + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.DomainFilter.inclusive + name: inclusive + uid: tracemalloc.DomainFilter.inclusive +- fullName: tracemalloc.Filter.all_frames + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Filter.all_frames + name: all_frames + uid: tracemalloc.Filter.all_frames +- fullName: tracemalloc.Filter.domain + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Filter.domain + name: domain + uid: tracemalloc.Filter.domain +- fullName: tracemalloc.Filter.filename_pattern + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Filter.filename_pattern + name: filename_pattern + uid: tracemalloc.Filter.filename_pattern +- fullName: tracemalloc.Filter.inclusive + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Filter.inclusive + name: inclusive + uid: tracemalloc.Filter.inclusive +- fullName: tracemalloc.Filter.lineno + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Filter.lineno + name: lineno + uid: tracemalloc.Filter.lineno +- fullName: tracemalloc.Frame.filename + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Frame.filename + name: filename + uid: tracemalloc.Frame.filename +- fullName: tracemalloc.Frame.lineno + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Frame.lineno + name: lineno + uid: tracemalloc.Frame.lineno +- fullName: tracemalloc.Snapshot.traceback_limit + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Snapshot.traceback_limit + name: traceback_limit + uid: tracemalloc.Snapshot.traceback_limit +- fullName: tracemalloc.Snapshot.traces + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Snapshot.traces + name: traces + uid: tracemalloc.Snapshot.traces +- fullName: tracemalloc.Statistic.count + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Statistic.count + name: count + uid: tracemalloc.Statistic.count +- fullName: tracemalloc.Statistic.size + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Statistic.size + name: size + uid: tracemalloc.Statistic.size +- fullName: tracemalloc.Statistic.traceback + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Statistic.traceback + name: traceback + uid: tracemalloc.Statistic.traceback +- fullName: tracemalloc.StatisticDiff.count + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.StatisticDiff.count + name: count + uid: tracemalloc.StatisticDiff.count +- fullName: tracemalloc.StatisticDiff.count_diff + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.StatisticDiff.count_diff + name: count_diff + uid: tracemalloc.StatisticDiff.count_diff +- fullName: tracemalloc.StatisticDiff.size + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.StatisticDiff.size + name: size + uid: tracemalloc.StatisticDiff.size +- fullName: tracemalloc.StatisticDiff.size_diff + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.StatisticDiff.size_diff + name: size_diff + uid: tracemalloc.StatisticDiff.size_diff +- fullName: tracemalloc.StatisticDiff.traceback + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.StatisticDiff.traceback + name: traceback + uid: tracemalloc.StatisticDiff.traceback +- fullName: tracemalloc.Trace.domain + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Trace.domain + name: domain + uid: tracemalloc.Trace.domain +- fullName: tracemalloc.Trace.size + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Trace.size + name: size + uid: tracemalloc.Trace.size +- fullName: tracemalloc.Trace.traceback + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Trace.traceback + name: traceback + uid: tracemalloc.Trace.traceback +- fullName: tracemalloc.Traceback.total_nframe + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Traceback.total_nframe + name: total_nframe + uid: tracemalloc.Traceback.total_nframe +- fullName: type.__annotations__ + href: https://docs.python.org/3/reference/datamodel.html#type.__annotations__ + name: __annotations__ + uid: type.__annotations__ +- fullName: type.__bases__ + href: https://docs.python.org/3/reference/datamodel.html#type.__bases__ + name: __bases__ + uid: type.__bases__ +- fullName: type.__dict__ + href: https://docs.python.org/3/reference/datamodel.html#type.__dict__ + name: __dict__ + uid: type.__dict__ +- fullName: type.__doc__ + href: https://docs.python.org/3/reference/datamodel.html#type.__doc__ + name: __doc__ + uid: type.__doc__ +- fullName: type.__firstlineno__ + href: https://docs.python.org/3/reference/datamodel.html#type.__firstlineno__ + name: __firstlineno__ + uid: type.__firstlineno__ +- fullName: type.__module__ + href: https://docs.python.org/3/reference/datamodel.html#type.__module__ + name: __module__ + uid: type.__module__ +- fullName: type.__mro__ + href: https://docs.python.org/3/reference/datamodel.html#type.__mro__ + name: __mro__ + uid: type.__mro__ +- fullName: type.__name__ + href: https://docs.python.org/3/reference/datamodel.html#type.__name__ + name: __name__ + uid: type.__name__ +- fullName: type.__qualname__ + href: https://docs.python.org/3/reference/datamodel.html#type.__qualname__ + name: __qualname__ + uid: type.__qualname__ +- fullName: type.__static_attributes__ + href: https://docs.python.org/3/reference/datamodel.html#type.__static_attributes__ + name: __static_attributes__ + uid: type.__static_attributes__ +- fullName: type.__type_params__ + href: https://docs.python.org/3/reference/datamodel.html#type.__type_params__ + name: __type_params__ + uid: type.__type_params__ +- fullName: typing.NewType.__module__ + href: https://docs.python.org/3/library/typing.html#typing.NewType.__module__ + name: __module__ + uid: typing.NewType.__module__ +- fullName: typing.NewType.__name__ + href: https://docs.python.org/3/library/typing.html#typing.NewType.__name__ + name: __name__ + uid: typing.NewType.__name__ +- fullName: typing.NewType.__supertype__ + href: https://docs.python.org/3/library/typing.html#typing.NewType.__supertype__ + name: __supertype__ + uid: typing.NewType.__supertype__ +- fullName: typing.ParamSpec.__default__ + href: https://docs.python.org/3/library/typing.html#typing.ParamSpec.__default__ + name: __default__ + uid: typing.ParamSpec.__default__ +- fullName: typing.ParamSpec.__name__ + href: https://docs.python.org/3/library/typing.html#typing.ParamSpec.__name__ + name: __name__ + uid: typing.ParamSpec.__name__ +- fullName: typing.ParamSpec.args + href: https://docs.python.org/3/library/typing.html#typing.ParamSpec.args + name: args + uid: typing.ParamSpec.args +- fullName: typing.ParamSpec.kwargs + href: https://docs.python.org/3/library/typing.html#typing.ParamSpec.kwargs + name: kwargs + uid: typing.ParamSpec.kwargs +- fullName: typing.TypeAliasType.__module__ + href: https://docs.python.org/3/library/typing.html#typing.TypeAliasType.__module__ + name: __module__ + uid: typing.TypeAliasType.__module__ +- fullName: typing.TypeAliasType.__name__ + href: https://docs.python.org/3/library/typing.html#typing.TypeAliasType.__name__ + name: __name__ + uid: typing.TypeAliasType.__name__ +- fullName: typing.TypeAliasType.__type_params__ + href: https://docs.python.org/3/library/typing.html#typing.TypeAliasType.__type_params__ + name: __type_params__ + uid: typing.TypeAliasType.__type_params__ +- fullName: typing.TypeAliasType.__value__ + href: https://docs.python.org/3/library/typing.html#typing.TypeAliasType.__value__ + name: __value__ + uid: typing.TypeAliasType.__value__ +- fullName: typing.TypeVar.__bound__ + href: https://docs.python.org/3/library/typing.html#typing.TypeVar.__bound__ + name: __bound__ + uid: typing.TypeVar.__bound__ +- fullName: typing.TypeVar.__constraints__ + href: https://docs.python.org/3/library/typing.html#typing.TypeVar.__constraints__ + name: __constraints__ + uid: typing.TypeVar.__constraints__ +- fullName: typing.TypeVar.__contravariant__ + href: https://docs.python.org/3/library/typing.html#typing.TypeVar.__contravariant__ + name: __contravariant__ + uid: typing.TypeVar.__contravariant__ +- fullName: typing.TypeVar.__covariant__ + href: https://docs.python.org/3/library/typing.html#typing.TypeVar.__covariant__ + name: __covariant__ + uid: typing.TypeVar.__covariant__ +- fullName: typing.TypeVar.__default__ + href: https://docs.python.org/3/library/typing.html#typing.TypeVar.__default__ + name: __default__ + uid: typing.TypeVar.__default__ +- fullName: typing.TypeVar.__infer_variance__ + href: https://docs.python.org/3/library/typing.html#typing.TypeVar.__infer_variance__ + name: __infer_variance__ + uid: typing.TypeVar.__infer_variance__ +- fullName: typing.TypeVar.__name__ + href: https://docs.python.org/3/library/typing.html#typing.TypeVar.__name__ + name: __name__ + uid: typing.TypeVar.__name__ +- fullName: typing.TypeVarTuple.__default__ + href: https://docs.python.org/3/library/typing.html#typing.TypeVarTuple.__default__ + name: __default__ + uid: typing.TypeVarTuple.__default__ +- fullName: typing.TypeVarTuple.__name__ + href: https://docs.python.org/3/library/typing.html#typing.TypeVarTuple.__name__ + name: __name__ + uid: typing.TypeVarTuple.__name__ +- fullName: typing.TypedDict.__mutable_keys__ + href: https://docs.python.org/3/library/typing.html#typing.TypedDict.__mutable_keys__ + name: __mutable_keys__ + uid: typing.TypedDict.__mutable_keys__ +- fullName: typing.TypedDict.__optional_keys__ + href: https://docs.python.org/3/library/typing.html#typing.TypedDict.__optional_keys__ + name: __optional_keys__ + uid: typing.TypedDict.__optional_keys__ +- fullName: typing.TypedDict.__readonly_keys__ + href: https://docs.python.org/3/library/typing.html#typing.TypedDict.__readonly_keys__ + name: __readonly_keys__ + uid: typing.TypedDict.__readonly_keys__ +- fullName: typing.TypedDict.__required_keys__ + href: https://docs.python.org/3/library/typing.html#typing.TypedDict.__required_keys__ + name: __required_keys__ + uid: typing.TypedDict.__required_keys__ +- fullName: typing.TypedDict.__total__ + href: https://docs.python.org/3/library/typing.html#typing.TypedDict.__total__ + name: __total__ + uid: typing.TypedDict.__total__ +- fullName: unittest.IsolatedAsyncioTestCase.loop_factory + href: https://docs.python.org/3/library/unittest.html#unittest.IsolatedAsyncioTestCase.loop_factory + name: loop_factory + uid: unittest.IsolatedAsyncioTestCase.loop_factory +- fullName: unittest.TestCase.failureException + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.failureException + name: failureException + uid: unittest.TestCase.failureException +- fullName: unittest.TestCase.longMessage + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.longMessage + name: longMessage + uid: unittest.TestCase.longMessage +- fullName: unittest.TestCase.maxDiff + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.maxDiff + name: maxDiff + uid: unittest.TestCase.maxDiff +- fullName: unittest.TestCase.output + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.output + name: output + uid: unittest.TestCase.output +- fullName: unittest.TestCase.records + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.records + name: records + uid: unittest.TestCase.records +- fullName: unittest.TestLoader.errors + href: https://docs.python.org/3/library/unittest.html#unittest.TestLoader.errors + name: errors + uid: unittest.TestLoader.errors +- fullName: unittest.TestLoader.sortTestMethodsUsing + href: https://docs.python.org/3/library/unittest.html#unittest.TestLoader.sortTestMethodsUsing + name: sortTestMethodsUsing + uid: unittest.TestLoader.sortTestMethodsUsing +- fullName: unittest.TestLoader.suiteClass + href: https://docs.python.org/3/library/unittest.html#unittest.TestLoader.suiteClass + name: suiteClass + uid: unittest.TestLoader.suiteClass +- fullName: unittest.TestLoader.testMethodPrefix + href: https://docs.python.org/3/library/unittest.html#unittest.TestLoader.testMethodPrefix + name: testMethodPrefix + uid: unittest.TestLoader.testMethodPrefix +- fullName: unittest.TestLoader.testNamePatterns + href: https://docs.python.org/3/library/unittest.html#unittest.TestLoader.testNamePatterns + name: testNamePatterns + uid: unittest.TestLoader.testNamePatterns +- fullName: unittest.TestResult.buffer + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.buffer + name: buffer + uid: unittest.TestResult.buffer +- fullName: unittest.TestResult.collectedDurations + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.collectedDurations + name: collectedDurations + uid: unittest.TestResult.collectedDurations +- fullName: unittest.TestResult.errors + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.errors + name: errors + uid: unittest.TestResult.errors +- fullName: unittest.TestResult.expectedFailures + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.expectedFailures + name: expectedFailures + uid: unittest.TestResult.expectedFailures +- fullName: unittest.TestResult.failfast + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.failfast + name: failfast + uid: unittest.TestResult.failfast +- fullName: unittest.TestResult.failures + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.failures + name: failures + uid: unittest.TestResult.failures +- fullName: unittest.TestResult.shouldStop + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.shouldStop + name: shouldStop + uid: unittest.TestResult.shouldStop +- fullName: unittest.TestResult.skipped + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.skipped + name: skipped + uid: unittest.TestResult.skipped +- fullName: unittest.TestResult.tb_locals + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.tb_locals + name: tb_locals + uid: unittest.TestResult.tb_locals +- fullName: unittest.TestResult.testsRun + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.testsRun + name: testsRun + uid: unittest.TestResult.testsRun +- fullName: unittest.TestResult.unexpectedSuccesses + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.unexpectedSuccesses + name: unexpectedSuccesses + uid: unittest.TestResult.unexpectedSuccesses +- fullName: unittest.mock.AsyncMock.await_args + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.AsyncMock.await_args + name: await_args + uid: unittest.mock.AsyncMock.await_args +- fullName: unittest.mock.AsyncMock.await_args_list + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.AsyncMock.await_args_list + name: await_args_list + uid: unittest.mock.AsyncMock.await_args_list +- fullName: unittest.mock.AsyncMock.await_count + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.AsyncMock.await_count + name: await_count + uid: unittest.mock.AsyncMock.await_count +- fullName: unittest.mock.Mock.__class__ + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.__class__ + name: __class__ + uid: unittest.mock.Mock.__class__ +- fullName: unittest.mock.Mock.call_args + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.call_args + name: call_args + uid: unittest.mock.Mock.call_args +- fullName: unittest.mock.Mock.call_args_list + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.call_args_list + name: call_args_list + uid: unittest.mock.Mock.call_args_list +- fullName: unittest.mock.Mock.call_count + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.call_count + name: call_count + uid: unittest.mock.Mock.call_count +- fullName: unittest.mock.Mock.called + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.called + name: called + uid: unittest.mock.Mock.called +- fullName: unittest.mock.Mock.method_calls + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.method_calls + name: method_calls + uid: unittest.mock.Mock.method_calls +- fullName: unittest.mock.Mock.mock_calls + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.mock_calls + name: mock_calls + uid: unittest.mock.Mock.mock_calls +- fullName: unittest.mock.Mock.return_value + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.return_value + name: return_value + uid: unittest.mock.Mock.return_value +- fullName: unittest.mock.Mock.side_effect + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.side_effect + name: side_effect + uid: unittest.mock.Mock.side_effect +- fullName: unittest.mock.ThreadingMock.DEFAULT_TIMEOUT + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.ThreadingMock.DEFAULT_TIMEOUT + name: DEFAULT_TIMEOUT + uid: unittest.mock.ThreadingMock.DEFAULT_TIMEOUT +- fullName: urllib.error.ContentTooShortError.content + href: https://docs.python.org/3/library/urllib.error.html#urllib.error.ContentTooShortError.content + name: content + uid: urllib.error.ContentTooShortError.content +- fullName: urllib.error.HTTPError.code + href: https://docs.python.org/3/library/urllib.error.html#urllib.error.HTTPError.code + name: code + uid: urllib.error.HTTPError.code +- fullName: urllib.error.HTTPError.fp + href: https://docs.python.org/3/library/urllib.error.html#urllib.error.HTTPError.fp + name: fp + uid: urllib.error.HTTPError.fp +- fullName: urllib.error.HTTPError.headers + href: https://docs.python.org/3/library/urllib.error.html#urllib.error.HTTPError.headers + name: headers + uid: urllib.error.HTTPError.headers +- fullName: urllib.error.HTTPError.reason + href: https://docs.python.org/3/library/urllib.error.html#urllib.error.HTTPError.reason + name: reason + uid: urllib.error.HTTPError.reason +- fullName: urllib.error.HTTPError.url + href: https://docs.python.org/3/library/urllib.error.html#urllib.error.HTTPError.url + name: url + uid: urllib.error.HTTPError.url +- fullName: urllib.error.URLError.reason + href: https://docs.python.org/3/library/urllib.error.html#urllib.error.URLError.reason + name: reason + uid: urllib.error.URLError.reason +- fullName: urllib.request.BaseHandler.parent + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.BaseHandler.parent + name: parent + uid: urllib.request.BaseHandler.parent +- fullName: urllib.request.HTTPCookieProcessor.cookiejar + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPCookieProcessor.cookiejar + name: cookiejar + uid: urllib.request.HTTPCookieProcessor.cookiejar +- fullName: urllib.request.Request.data + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.Request.data + name: data + uid: urllib.request.Request.data +- fullName: urllib.request.Request.full_url + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.Request.full_url + name: full_url + uid: urllib.request.Request.full_url +- fullName: urllib.request.Request.host + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.Request.host + name: host + uid: urllib.request.Request.host +- fullName: urllib.request.Request.method + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.Request.method + name: method + uid: urllib.request.Request.method +- fullName: urllib.request.Request.origin_req_host + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.Request.origin_req_host + name: origin_req_host + uid: urllib.request.Request.origin_req_host +- fullName: urllib.request.Request.selector + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.Request.selector + name: selector + uid: urllib.request.Request.selector +- fullName: urllib.request.Request.type + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.Request.type + name: type + uid: urllib.request.Request.type +- fullName: urllib.request.Request.unverifiable + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.Request.unverifiable + name: unverifiable + uid: urllib.request.Request.unverifiable +- fullName: urllib.request.URLopener.version + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.URLopener.version + name: version + uid: urllib.request.URLopener.version +- fullName: urllib.response.addinfourl.code + href: https://docs.python.org/3/library/urllib.request.html#urllib.response.addinfourl.code + name: code + uid: urllib.response.addinfourl.code +- fullName: urllib.response.addinfourl.headers + href: https://docs.python.org/3/library/urllib.request.html#urllib.response.addinfourl.headers + name: headers + uid: urllib.response.addinfourl.headers +- fullName: urllib.response.addinfourl.status + href: https://docs.python.org/3/library/urllib.request.html#urllib.response.addinfourl.status + name: status + uid: urllib.response.addinfourl.status +- fullName: urllib.response.addinfourl.url + href: https://docs.python.org/3/library/urllib.request.html#urllib.response.addinfourl.url + name: url + uid: urllib.response.addinfourl.url +- fullName: uuid.SafeUUID.safe + href: https://docs.python.org/3/library/uuid.html#uuid.SafeUUID.safe + name: safe + uid: uuid.SafeUUID.safe +- fullName: uuid.SafeUUID.unknown + href: https://docs.python.org/3/library/uuid.html#uuid.SafeUUID.unknown + name: unknown + uid: uuid.SafeUUID.unknown +- fullName: uuid.SafeUUID.unsafe + href: https://docs.python.org/3/library/uuid.html#uuid.SafeUUID.unsafe + name: unsafe + uid: uuid.SafeUUID.unsafe +- fullName: uuid.UUID.bytes + href: https://docs.python.org/3/library/uuid.html#uuid.UUID.bytes + name: bytes + uid: uuid.UUID.bytes +- fullName: uuid.UUID.bytes_le + href: https://docs.python.org/3/library/uuid.html#uuid.UUID.bytes_le + name: bytes_le + uid: uuid.UUID.bytes_le +- fullName: uuid.UUID.clock_seq + href: https://docs.python.org/3/library/uuid.html#uuid.UUID.clock_seq + name: clock_seq + uid: uuid.UUID.clock_seq +- fullName: uuid.UUID.clock_seq_hi_variant + href: https://docs.python.org/3/library/uuid.html#uuid.UUID.clock_seq_hi_variant + name: clock_seq_hi_variant + uid: uuid.UUID.clock_seq_hi_variant +- fullName: uuid.UUID.clock_seq_low + href: https://docs.python.org/3/library/uuid.html#uuid.UUID.clock_seq_low + name: clock_seq_low + uid: uuid.UUID.clock_seq_low +- fullName: uuid.UUID.fields + href: https://docs.python.org/3/library/uuid.html#uuid.UUID.fields + name: fields + uid: uuid.UUID.fields +- fullName: uuid.UUID.hex + href: https://docs.python.org/3/library/uuid.html#uuid.UUID.hex + name: hex + uid: uuid.UUID.hex +- fullName: uuid.UUID.int + href: https://docs.python.org/3/library/uuid.html#uuid.UUID.int + name: int + uid: uuid.UUID.int +- fullName: uuid.UUID.is_safe + href: https://docs.python.org/3/library/uuid.html#uuid.UUID.is_safe + name: is_safe + uid: uuid.UUID.is_safe +- fullName: uuid.UUID.node + href: https://docs.python.org/3/library/uuid.html#uuid.UUID.node + name: node + uid: uuid.UUID.node +- fullName: uuid.UUID.time + href: https://docs.python.org/3/library/uuid.html#uuid.UUID.time + name: time + uid: uuid.UUID.time +- fullName: uuid.UUID.time_hi_version + href: https://docs.python.org/3/library/uuid.html#uuid.UUID.time_hi_version + name: time_hi_version + uid: uuid.UUID.time_hi_version +- fullName: uuid.UUID.time_low + href: https://docs.python.org/3/library/uuid.html#uuid.UUID.time_low + name: time_low + uid: uuid.UUID.time_low +- fullName: uuid.UUID.time_mid + href: https://docs.python.org/3/library/uuid.html#uuid.UUID.time_mid + name: time_mid + uid: uuid.UUID.time_mid +- fullName: uuid.UUID.urn + href: https://docs.python.org/3/library/uuid.html#uuid.UUID.urn + name: urn + uid: uuid.UUID.urn +- fullName: uuid.UUID.variant + href: https://docs.python.org/3/library/uuid.html#uuid.UUID.variant + name: variant + uid: uuid.UUID.variant +- fullName: uuid.UUID.version + href: https://docs.python.org/3/library/uuid.html#uuid.UUID.version + name: version + uid: uuid.UUID.version +- fullName: weakref.finalize.alive + href: https://docs.python.org/3/library/weakref.html#weakref.finalize.alive + name: alive + uid: weakref.finalize.alive +- fullName: weakref.finalize.atexit + href: https://docs.python.org/3/library/weakref.html#weakref.finalize.atexit + name: atexit + uid: weakref.finalize.atexit +- fullName: weakref.ref.__callback__ + href: https://docs.python.org/3/library/weakref.html#weakref.ref.__callback__ + name: __callback__ + uid: weakref.ref.__callback__ +- fullName: webbrowser.controller.name + href: https://docs.python.org/3/library/webbrowser.html#webbrowser.controller.name + name: name + uid: webbrowser.controller.name +- fullName: wsgiref.handlers.BaseHandler.error_body + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler.error_body + name: error_body + uid: wsgiref.handlers.BaseHandler.error_body +- fullName: wsgiref.handlers.BaseHandler.error_headers + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler.error_headers + name: error_headers + uid: wsgiref.handlers.BaseHandler.error_headers +- fullName: wsgiref.handlers.BaseHandler.error_status + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler.error_status + name: error_status + uid: wsgiref.handlers.BaseHandler.error_status +- fullName: wsgiref.handlers.BaseHandler.http_version + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler.http_version + name: http_version + uid: wsgiref.handlers.BaseHandler.http_version +- fullName: wsgiref.handlers.BaseHandler.origin_server + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler.origin_server + name: origin_server + uid: wsgiref.handlers.BaseHandler.origin_server +- fullName: wsgiref.handlers.BaseHandler.os_environ + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler.os_environ + name: os_environ + uid: wsgiref.handlers.BaseHandler.os_environ +- fullName: wsgiref.handlers.BaseHandler.server_software + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler.server_software + name: server_software + uid: wsgiref.handlers.BaseHandler.server_software +- fullName: wsgiref.handlers.BaseHandler.traceback_limit + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler.traceback_limit + name: traceback_limit + uid: wsgiref.handlers.BaseHandler.traceback_limit +- fullName: wsgiref.handlers.BaseHandler.wsgi_file_wrapper + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler.wsgi_file_wrapper + name: wsgi_file_wrapper + uid: wsgiref.handlers.BaseHandler.wsgi_file_wrapper +- fullName: wsgiref.handlers.BaseHandler.wsgi_multiprocess + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler.wsgi_multiprocess + name: wsgi_multiprocess + uid: wsgiref.handlers.BaseHandler.wsgi_multiprocess +- fullName: wsgiref.handlers.BaseHandler.wsgi_multithread + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler.wsgi_multithread + name: wsgi_multithread + uid: wsgiref.handlers.BaseHandler.wsgi_multithread +- fullName: wsgiref.handlers.BaseHandler.wsgi_run_once + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler.wsgi_run_once + name: wsgi_run_once + uid: wsgiref.handlers.BaseHandler.wsgi_run_once +- fullName: xml.dom.Attr.localName + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Attr.localName + name: localName + uid: xml.dom.Attr.localName +- fullName: xml.dom.Attr.name + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Attr.name + name: name + uid: xml.dom.Attr.name +- fullName: xml.dom.Attr.prefix + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Attr.prefix + name: prefix + uid: xml.dom.Attr.prefix +- fullName: xml.dom.Attr.value + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Attr.value + name: value + uid: xml.dom.Attr.value +- fullName: xml.dom.Comment.data + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Comment.data + name: data + uid: xml.dom.Comment.data +- fullName: xml.dom.Document.documentElement + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Document.documentElement + name: documentElement + uid: xml.dom.Document.documentElement +- fullName: xml.dom.DocumentType.entities + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.DocumentType.entities + name: entities + uid: xml.dom.DocumentType.entities +- fullName: xml.dom.DocumentType.internalSubset + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.DocumentType.internalSubset + name: internalSubset + uid: xml.dom.DocumentType.internalSubset +- fullName: xml.dom.DocumentType.name + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.DocumentType.name + name: name + uid: xml.dom.DocumentType.name +- fullName: xml.dom.DocumentType.notations + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.DocumentType.notations + name: notations + uid: xml.dom.DocumentType.notations +- fullName: xml.dom.DocumentType.publicId + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.DocumentType.publicId + name: publicId + uid: xml.dom.DocumentType.publicId +- fullName: xml.dom.DocumentType.systemId + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.DocumentType.systemId + name: systemId + uid: xml.dom.DocumentType.systemId +- fullName: xml.dom.Element.tagName + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Element.tagName + name: tagName + uid: xml.dom.Element.tagName +- fullName: xml.dom.NamedNodeMap.length + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.NamedNodeMap.length + name: length + uid: xml.dom.NamedNodeMap.length +- fullName: xml.dom.Node.attributes + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Node.attributes + name: attributes + uid: xml.dom.Node.attributes +- fullName: xml.dom.Node.childNodes + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Node.childNodes + name: childNodes + uid: xml.dom.Node.childNodes +- fullName: xml.dom.Node.firstChild + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Node.firstChild + name: firstChild + uid: xml.dom.Node.firstChild +- fullName: xml.dom.Node.lastChild + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Node.lastChild + name: lastChild + uid: xml.dom.Node.lastChild +- fullName: xml.dom.Node.localName + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Node.localName + name: localName + uid: xml.dom.Node.localName +- fullName: xml.dom.Node.namespaceURI + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Node.namespaceURI + name: namespaceURI + uid: xml.dom.Node.namespaceURI +- fullName: xml.dom.Node.nextSibling + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Node.nextSibling + name: nextSibling + uid: xml.dom.Node.nextSibling +- fullName: xml.dom.Node.nodeName + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Node.nodeName + name: nodeName + uid: xml.dom.Node.nodeName +- fullName: xml.dom.Node.nodeType + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Node.nodeType + name: nodeType + uid: xml.dom.Node.nodeType +- fullName: xml.dom.Node.nodeValue + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Node.nodeValue + name: nodeValue + uid: xml.dom.Node.nodeValue +- fullName: xml.dom.Node.parentNode + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Node.parentNode + name: parentNode + uid: xml.dom.Node.parentNode +- fullName: xml.dom.Node.prefix + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Node.prefix + name: prefix + uid: xml.dom.Node.prefix +- fullName: xml.dom.Node.previousSibling + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Node.previousSibling + name: previousSibling + uid: xml.dom.Node.previousSibling +- fullName: xml.dom.NodeList.length + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.NodeList.length + name: length + uid: xml.dom.NodeList.length +- fullName: xml.dom.ProcessingInstruction.data + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.ProcessingInstruction.data + name: data + uid: xml.dom.ProcessingInstruction.data +- fullName: xml.dom.ProcessingInstruction.target + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.ProcessingInstruction.target + name: target + uid: xml.dom.ProcessingInstruction.target +- fullName: xml.dom.Text.data + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Text.data + name: data + uid: xml.dom.Text.data +- fullName: xml.etree.ElementTree.Element.attrib + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.attrib + name: attrib + uid: xml.etree.ElementTree.Element.attrib +- fullName: xml.etree.ElementTree.Element.tag + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.tag + name: tag + uid: xml.etree.ElementTree.Element.tag +- fullName: xml.etree.ElementTree.Element.tail + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.tail + name: tail + uid: xml.etree.ElementTree.Element.tail +- fullName: xml.etree.ElementTree.Element.text + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.text + name: text + uid: xml.etree.ElementTree.Element.text +- fullName: xml.etree.ElementTree.ParseError.code + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.ParseError.code + name: code + uid: xml.etree.ElementTree.ParseError.code +- fullName: xml.etree.ElementTree.ParseError.position + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.ParseError.position + name: position + uid: xml.etree.ElementTree.ParseError.position +- fullName: xml.parsers.expat.ExpatError.code + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.ExpatError.code + name: code + uid: xml.parsers.expat.ExpatError.code +- fullName: xml.parsers.expat.ExpatError.lineno + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.ExpatError.lineno + name: lineno + uid: xml.parsers.expat.ExpatError.lineno +- fullName: xml.parsers.expat.ExpatError.offset + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.ExpatError.offset + name: offset + uid: xml.parsers.expat.ExpatError.offset +- fullName: xml.parsers.expat.xmlparser.CurrentByteIndex + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.CurrentByteIndex + name: CurrentByteIndex + uid: xml.parsers.expat.xmlparser.CurrentByteIndex +- fullName: xml.parsers.expat.xmlparser.CurrentColumnNumber + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.CurrentColumnNumber + name: CurrentColumnNumber + uid: xml.parsers.expat.xmlparser.CurrentColumnNumber +- fullName: xml.parsers.expat.xmlparser.CurrentLineNumber + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.CurrentLineNumber + name: CurrentLineNumber + uid: xml.parsers.expat.xmlparser.CurrentLineNumber +- fullName: xml.parsers.expat.xmlparser.ErrorByteIndex + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.ErrorByteIndex + name: ErrorByteIndex + uid: xml.parsers.expat.xmlparser.ErrorByteIndex +- fullName: xml.parsers.expat.xmlparser.ErrorCode + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.ErrorCode + name: ErrorCode + uid: xml.parsers.expat.xmlparser.ErrorCode +- fullName: xml.parsers.expat.xmlparser.ErrorColumnNumber + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.ErrorColumnNumber + name: ErrorColumnNumber + uid: xml.parsers.expat.xmlparser.ErrorColumnNumber +- fullName: xml.parsers.expat.xmlparser.ErrorLineNumber + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.ErrorLineNumber + name: ErrorLineNumber + uid: xml.parsers.expat.xmlparser.ErrorLineNumber +- fullName: xml.parsers.expat.xmlparser.buffer_size + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.buffer_size + name: buffer_size + uid: xml.parsers.expat.xmlparser.buffer_size +- fullName: xml.parsers.expat.xmlparser.buffer_text + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.buffer_text + name: buffer_text + uid: xml.parsers.expat.xmlparser.buffer_text +- fullName: xml.parsers.expat.xmlparser.buffer_used + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.buffer_used + name: buffer_used + uid: xml.parsers.expat.xmlparser.buffer_used +- fullName: xml.parsers.expat.xmlparser.ordered_attributes + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.ordered_attributes + name: ordered_attributes + uid: xml.parsers.expat.xmlparser.ordered_attributes +- fullName: xml.parsers.expat.xmlparser.specified_attributes + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.specified_attributes + name: specified_attributes + uid: xml.parsers.expat.xmlparser.specified_attributes +- fullName: xmlrpc.client.Binary.data + href: https://docs.python.org/3/library/xmlrpc.client.html#xmlrpc.client.Binary.data + name: data + uid: xmlrpc.client.Binary.data +- fullName: xmlrpc.client.Fault.faultCode + href: https://docs.python.org/3/library/xmlrpc.client.html#xmlrpc.client.Fault.faultCode + name: faultCode + uid: xmlrpc.client.Fault.faultCode +- fullName: xmlrpc.client.Fault.faultString + href: https://docs.python.org/3/library/xmlrpc.client.html#xmlrpc.client.Fault.faultString + name: faultString + uid: xmlrpc.client.Fault.faultString +- fullName: xmlrpc.client.ProtocolError.errcode + href: https://docs.python.org/3/library/xmlrpc.client.html#xmlrpc.client.ProtocolError.errcode + name: errcode + uid: xmlrpc.client.ProtocolError.errcode +- fullName: xmlrpc.client.ProtocolError.errmsg + href: https://docs.python.org/3/library/xmlrpc.client.html#xmlrpc.client.ProtocolError.errmsg + name: errmsg + uid: xmlrpc.client.ProtocolError.errmsg +- fullName: xmlrpc.client.ProtocolError.headers + href: https://docs.python.org/3/library/xmlrpc.client.html#xmlrpc.client.ProtocolError.headers + name: headers + uid: xmlrpc.client.ProtocolError.headers +- fullName: xmlrpc.client.ProtocolError.url + href: https://docs.python.org/3/library/xmlrpc.client.html#xmlrpc.client.ProtocolError.url + name: url + uid: xmlrpc.client.ProtocolError.url +- fullName: xmlrpc.server.SimpleXMLRPCRequestHandler.rpc_paths + href: https://docs.python.org/3/library/xmlrpc.server.html#xmlrpc.server.SimpleXMLRPCRequestHandler.rpc_paths + name: rpc_paths + uid: xmlrpc.server.SimpleXMLRPCRequestHandler.rpc_paths +- fullName: zipfile.Path.name + href: https://docs.python.org/3/library/zipfile.html#zipfile.Path.name + name: name + uid: zipfile.Path.name +- fullName: zipfile.ZipFile.comment + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipFile.comment + name: comment + uid: zipfile.ZipFile.comment +- fullName: zipfile.ZipFile.debug + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipFile.debug + name: debug + uid: zipfile.ZipFile.debug +- fullName: zipfile.ZipFile.filename + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipFile.filename + name: filename + uid: zipfile.ZipFile.filename +- fullName: zipfile.ZipInfo.CRC + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipInfo.CRC + name: CRC + uid: zipfile.ZipInfo.CRC +- fullName: zipfile.ZipInfo.comment + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipInfo.comment + name: comment + uid: zipfile.ZipInfo.comment +- fullName: zipfile.ZipInfo.compress_size + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipInfo.compress_size + name: compress_size + uid: zipfile.ZipInfo.compress_size +- fullName: zipfile.ZipInfo.compress_type + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipInfo.compress_type + name: compress_type + uid: zipfile.ZipInfo.compress_type +- fullName: zipfile.ZipInfo.create_system + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipInfo.create_system + name: create_system + uid: zipfile.ZipInfo.create_system +- fullName: zipfile.ZipInfo.create_version + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipInfo.create_version + name: create_version + uid: zipfile.ZipInfo.create_version +- fullName: zipfile.ZipInfo.date_time + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipInfo.date_time + name: date_time + uid: zipfile.ZipInfo.date_time +- fullName: zipfile.ZipInfo.external_attr + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipInfo.external_attr + name: external_attr + uid: zipfile.ZipInfo.external_attr +- fullName: zipfile.ZipInfo.extra + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipInfo.extra + name: extra + uid: zipfile.ZipInfo.extra +- fullName: zipfile.ZipInfo.extract_version + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipInfo.extract_version + name: extract_version + uid: zipfile.ZipInfo.extract_version +- fullName: zipfile.ZipInfo.file_size + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipInfo.file_size + name: file_size + uid: zipfile.ZipInfo.file_size +- fullName: zipfile.ZipInfo.filename + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipInfo.filename + name: filename + uid: zipfile.ZipInfo.filename +- fullName: zipfile.ZipInfo.flag_bits + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipInfo.flag_bits + name: flag_bits + uid: zipfile.ZipInfo.flag_bits +- fullName: zipfile.ZipInfo.header_offset + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipInfo.header_offset + name: header_offset + uid: zipfile.ZipInfo.header_offset +- fullName: zipfile.ZipInfo.internal_attr + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipInfo.internal_attr + name: internal_attr + uid: zipfile.ZipInfo.internal_attr +- fullName: zipfile.ZipInfo.reserved + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipInfo.reserved + name: reserved + uid: zipfile.ZipInfo.reserved +- fullName: zipfile.ZipInfo.volume + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipInfo.volume + name: volume + uid: zipfile.ZipInfo.volume +- fullName: zipimport.zipimporter.archive + href: https://docs.python.org/3/library/zipimport.html#zipimport.zipimporter.archive + name: archive + uid: zipimport.zipimporter.archive +- fullName: zipimport.zipimporter.prefix + href: https://docs.python.org/3/library/zipimport.html#zipimport.zipimporter.prefix + name: prefix + uid: zipimport.zipimporter.prefix +- fullName: zlib.Decompress.eof + href: https://docs.python.org/3/library/zlib.html#zlib.Decompress.eof + name: eof + uid: zlib.Decompress.eof +- fullName: zlib.Decompress.unconsumed_tail + href: https://docs.python.org/3/library/zlib.html#zlib.Decompress.unconsumed_tail + name: unconsumed_tail + uid: zlib.Decompress.unconsumed_tail +- fullName: zlib.Decompress.unused_data + href: https://docs.python.org/3/library/zlib.html#zlib.Decompress.unused_data + name: unused_data + uid: zlib.Decompress.unused_data +- fullName: zoneinfo.ZoneInfo.key + href: https://docs.python.org/3/library/zoneinfo.html#zoneinfo.ZoneInfo.key + name: key + uid: zoneinfo.ZoneInfo.key +- fullName: BaseException.add_note + href: https://docs.python.org/3/library/exceptions.html#BaseException.add_note + name: add_note + uid: BaseException.add_note +- fullName: BaseException.with_traceback + href: https://docs.python.org/3/library/exceptions.html#BaseException.with_traceback + name: with_traceback + uid: BaseException.with_traceback +- fullName: BaseExceptionGroup.derive + href: https://docs.python.org/3/library/exceptions.html#BaseExceptionGroup.derive + name: derive + uid: BaseExceptionGroup.derive +- fullName: BaseExceptionGroup.split + href: https://docs.python.org/3/library/exceptions.html#BaseExceptionGroup.split + name: split + uid: BaseExceptionGroup.split +- fullName: BaseExceptionGroup.subgroup + href: https://docs.python.org/3/library/exceptions.html#BaseExceptionGroup.subgroup + name: subgroup + uid: BaseExceptionGroup.subgroup +- fullName: __future__._Feature.getMandatoryRelease + href: https://docs.python.org/3/library/__future__.html#future__._Feature.getMandatoryRelease + name: getMandatoryRelease + uid: __future__._Feature.getMandatoryRelease +- fullName: __future__._Feature.getOptionalRelease + href: https://docs.python.org/3/library/__future__.html#future__._Feature.getOptionalRelease + name: getOptionalRelease + uid: __future__._Feature.getOptionalRelease +- fullName: _thread.lock.acquire + href: https://docs.python.org/3/library/_thread.html#thread.lock.acquire + name: acquire + uid: _thread.lock.acquire +- fullName: _thread.lock.locked + href: https://docs.python.org/3/library/_thread.html#thread.lock.locked + name: locked + uid: _thread.lock.locked +- fullName: _thread.lock.release + href: https://docs.python.org/3/library/_thread.html#thread.lock.release + name: release + uid: _thread.lock.release +- fullName: _tkinter.Widget.tk.createfilehandler + href: https://docs.python.org/3/library/tkinter.html#tkinter.Widget.tk.createfilehandler + name: createfilehandler + uid: _tkinter.Widget.tk.createfilehandler +- fullName: _tkinter.Widget.tk.deletefilehandler + href: https://docs.python.org/3/library/tkinter.html#tkinter.Widget.tk.deletefilehandler + name: deletefilehandler + uid: _tkinter.Widget.tk.deletefilehandler +- fullName: abc.ABCMeta.__subclasshook__ + href: https://docs.python.org/3/library/abc.html#abc.ABCMeta.__subclasshook__ + name: __subclasshook__ + uid: abc.ABCMeta.__subclasshook__ +- fullName: abc.ABCMeta.register + href: https://docs.python.org/3/library/abc.html#abc.ABCMeta.register + name: register + uid: abc.ABCMeta.register +- fullName: agen.__anext__ + href: https://docs.python.org/3/reference/expressions.html#agen.__anext__ + name: __anext__ + uid: agen.__anext__ +- fullName: agen.aclose + href: https://docs.python.org/3/reference/expressions.html#agen.aclose + name: aclose + uid: agen.aclose +- fullName: agen.asend + href: https://docs.python.org/3/reference/expressions.html#agen.asend + name: asend + uid: agen.asend +- fullName: agen.athrow + href: https://docs.python.org/3/reference/expressions.html#agen.athrow + name: athrow + uid: agen.athrow +- fullName: argparse.Action.__call__ + href: https://docs.python.org/3/library/argparse.html#argparse.Action.__call__ + name: __call__ + uid: argparse.Action.__call__ +- fullName: argparse.Action.format_usage + href: https://docs.python.org/3/library/argparse.html#argparse.Action.format_usage + name: format_usage + uid: argparse.Action.format_usage +- fullName: argparse.ArgumentParser.add_argument + href: https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser.add_argument + name: add_argument + uid: argparse.ArgumentParser.add_argument +- fullName: argparse.ArgumentParser.add_argument_group + href: https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser.add_argument_group + name: add_argument_group + uid: argparse.ArgumentParser.add_argument_group +- fullName: argparse.ArgumentParser.add_mutually_exclusive_group + href: https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser.add_mutually_exclusive_group + name: add_mutually_exclusive_group + uid: argparse.ArgumentParser.add_mutually_exclusive_group +- fullName: argparse.ArgumentParser.add_subparsers + href: https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser.add_subparsers + name: add_subparsers + uid: argparse.ArgumentParser.add_subparsers +- fullName: argparse.ArgumentParser.convert_arg_line_to_args + href: https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser.convert_arg_line_to_args + name: convert_arg_line_to_args + uid: argparse.ArgumentParser.convert_arg_line_to_args +- fullName: argparse.ArgumentParser.error + href: https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser.error + name: error + uid: argparse.ArgumentParser.error +- fullName: argparse.ArgumentParser.exit + href: https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser.exit + name: exit + uid: argparse.ArgumentParser.exit +- fullName: argparse.ArgumentParser.format_help + href: https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser.format_help + name: format_help + uid: argparse.ArgumentParser.format_help +- fullName: argparse.ArgumentParser.format_usage + href: https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser.format_usage + name: format_usage + uid: argparse.ArgumentParser.format_usage +- fullName: argparse.ArgumentParser.get_default + href: https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser.get_default + name: get_default + uid: argparse.ArgumentParser.get_default +- fullName: argparse.ArgumentParser.parse_args + href: https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser.parse_args + name: parse_args + uid: argparse.ArgumentParser.parse_args +- fullName: argparse.ArgumentParser.parse_intermixed_args + href: https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser.parse_intermixed_args + name: parse_intermixed_args + uid: argparse.ArgumentParser.parse_intermixed_args +- fullName: argparse.ArgumentParser.parse_known_args + href: https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser.parse_known_args + name: parse_known_args + uid: argparse.ArgumentParser.parse_known_args +- fullName: argparse.ArgumentParser.parse_known_intermixed_args + href: https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser.parse_known_intermixed_args + name: parse_known_intermixed_args + uid: argparse.ArgumentParser.parse_known_intermixed_args +- fullName: argparse.ArgumentParser.print_help + href: https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser.print_help + name: print_help + uid: argparse.ArgumentParser.print_help +- fullName: argparse.ArgumentParser.print_usage + href: https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser.print_usage + name: print_usage + uid: argparse.ArgumentParser.print_usage +- fullName: argparse.ArgumentParser.register + href: https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser.register + name: register + uid: argparse.ArgumentParser.register +- fullName: argparse.ArgumentParser.set_defaults + href: https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser.set_defaults + name: set_defaults + uid: argparse.ArgumentParser.set_defaults +- fullName: array.array.append + href: https://docs.python.org/3/library/array.html#array.array.append + name: append + uid: array.array.append +- fullName: array.array.buffer_info + href: https://docs.python.org/3/library/array.html#array.array.buffer_info + name: buffer_info + uid: array.array.buffer_info +- fullName: array.array.byteswap + href: https://docs.python.org/3/library/array.html#array.array.byteswap + name: byteswap + uid: array.array.byteswap +- fullName: array.array.clear + href: https://docs.python.org/3/library/array.html#array.array.clear + name: clear + uid: array.array.clear +- fullName: array.array.count + href: https://docs.python.org/3/library/array.html#array.array.count + name: count + uid: array.array.count +- fullName: array.array.extend + href: https://docs.python.org/3/library/array.html#array.array.extend + name: extend + uid: array.array.extend +- fullName: array.array.frombytes + href: https://docs.python.org/3/library/array.html#array.array.frombytes + name: frombytes + uid: array.array.frombytes +- fullName: array.array.fromfile + href: https://docs.python.org/3/library/array.html#array.array.fromfile + name: fromfile + uid: array.array.fromfile +- fullName: array.array.fromlist + href: https://docs.python.org/3/library/array.html#array.array.fromlist + name: fromlist + uid: array.array.fromlist +- fullName: array.array.fromunicode + href: https://docs.python.org/3/library/array.html#array.array.fromunicode + name: fromunicode + uid: array.array.fromunicode +- fullName: array.array.index + href: https://docs.python.org/3/library/array.html#array.array.index + name: index + uid: array.array.index +- fullName: array.array.insert + href: https://docs.python.org/3/library/array.html#array.array.insert + name: insert + uid: array.array.insert +- fullName: array.array.pop + href: https://docs.python.org/3/library/array.html#array.array.pop + name: pop + uid: array.array.pop +- fullName: array.array.remove + href: https://docs.python.org/3/library/array.html#array.array.remove + name: remove + uid: array.array.remove +- fullName: array.array.reverse + href: https://docs.python.org/3/library/array.html#array.array.reverse + name: reverse + uid: array.array.reverse +- fullName: array.array.tobytes + href: https://docs.python.org/3/library/array.html#array.array.tobytes + name: tobytes + uid: array.array.tobytes +- fullName: array.array.tofile + href: https://docs.python.org/3/library/array.html#array.array.tofile + name: tofile + uid: array.array.tofile +- fullName: array.array.tolist + href: https://docs.python.org/3/library/array.html#array.array.tolist + name: tolist + uid: array.array.tolist +- fullName: array.array.tounicode + href: https://docs.python.org/3/library/array.html#array.array.tounicode + name: tounicode + uid: array.array.tounicode +- fullName: ast.NodeVisitor.generic_visit + href: https://docs.python.org/3/library/ast.html#ast.NodeVisitor.generic_visit + name: generic_visit + uid: ast.NodeVisitor.generic_visit +- fullName: ast.NodeVisitor.visit + href: https://docs.python.org/3/library/ast.html#ast.NodeVisitor.visit + name: visit + uid: ast.NodeVisitor.visit +- fullName: ast.NodeVisitor.visit_Constant + href: https://docs.python.org/3/library/ast.html#ast.NodeVisitor.visit_Constant + name: visit_Constant + uid: ast.NodeVisitor.visit_Constant +- fullName: asyncio.AbstractChildWatcher.add_child_handler + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.AbstractChildWatcher.add_child_handler + name: add_child_handler + uid: asyncio.AbstractChildWatcher.add_child_handler +- fullName: asyncio.AbstractChildWatcher.attach_loop + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.AbstractChildWatcher.attach_loop + name: attach_loop + uid: asyncio.AbstractChildWatcher.attach_loop +- fullName: asyncio.AbstractChildWatcher.close + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.AbstractChildWatcher.close + name: close + uid: asyncio.AbstractChildWatcher.close +- fullName: asyncio.AbstractChildWatcher.is_active + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.AbstractChildWatcher.is_active + name: is_active + uid: asyncio.AbstractChildWatcher.is_active +- fullName: asyncio.AbstractChildWatcher.remove_child_handler + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.AbstractChildWatcher.remove_child_handler + name: remove_child_handler + uid: asyncio.AbstractChildWatcher.remove_child_handler +- fullName: asyncio.AbstractEventLoopPolicy.get_child_watcher + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.AbstractEventLoopPolicy.get_child_watcher + name: get_child_watcher + uid: asyncio.AbstractEventLoopPolicy.get_child_watcher +- fullName: asyncio.AbstractEventLoopPolicy.get_event_loop + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.AbstractEventLoopPolicy.get_event_loop + name: get_event_loop + uid: asyncio.AbstractEventLoopPolicy.get_event_loop +- fullName: asyncio.AbstractEventLoopPolicy.new_event_loop + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.AbstractEventLoopPolicy.new_event_loop + name: new_event_loop + uid: asyncio.AbstractEventLoopPolicy.new_event_loop +- fullName: asyncio.AbstractEventLoopPolicy.set_child_watcher + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.AbstractEventLoopPolicy.set_child_watcher + name: set_child_watcher + uid: asyncio.AbstractEventLoopPolicy.set_child_watcher +- fullName: asyncio.AbstractEventLoopPolicy.set_event_loop + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.AbstractEventLoopPolicy.set_event_loop + name: set_event_loop + uid: asyncio.AbstractEventLoopPolicy.set_event_loop +- fullName: asyncio.Barrier.abort + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Barrier.abort + name: abort + uid: asyncio.Barrier.abort +- fullName: asyncio.Barrier.reset + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Barrier.reset + name: reset + uid: asyncio.Barrier.reset +- fullName: asyncio.Barrier.wait + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Barrier.wait + name: wait + uid: asyncio.Barrier.wait +- fullName: asyncio.BaseProtocol.connection_lost + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.BaseProtocol.connection_lost + name: connection_lost + uid: asyncio.BaseProtocol.connection_lost +- fullName: asyncio.BaseProtocol.connection_made + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.BaseProtocol.connection_made + name: connection_made + uid: asyncio.BaseProtocol.connection_made +- fullName: asyncio.BaseProtocol.pause_writing + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.BaseProtocol.pause_writing + name: pause_writing + uid: asyncio.BaseProtocol.pause_writing +- fullName: asyncio.BaseProtocol.resume_writing + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.BaseProtocol.resume_writing + name: resume_writing + uid: asyncio.BaseProtocol.resume_writing +- fullName: asyncio.BaseTransport.close + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.BaseTransport.close + name: close + uid: asyncio.BaseTransport.close +- fullName: asyncio.BaseTransport.get_extra_info + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.BaseTransport.get_extra_info + name: get_extra_info + uid: asyncio.BaseTransport.get_extra_info +- fullName: asyncio.BaseTransport.get_protocol + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.BaseTransport.get_protocol + name: get_protocol + uid: asyncio.BaseTransport.get_protocol +- fullName: asyncio.BaseTransport.is_closing + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.BaseTransport.is_closing + name: is_closing + uid: asyncio.BaseTransport.is_closing +- fullName: asyncio.BaseTransport.set_protocol + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.BaseTransport.set_protocol + name: set_protocol + uid: asyncio.BaseTransport.set_protocol +- fullName: asyncio.BufferedProtocol.buffer_updated + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.BufferedProtocol.buffer_updated + name: buffer_updated + uid: asyncio.BufferedProtocol.buffer_updated +- fullName: asyncio.BufferedProtocol.eof_received + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.BufferedProtocol.eof_received + name: eof_received + uid: asyncio.BufferedProtocol.eof_received +- fullName: asyncio.BufferedProtocol.get_buffer + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.BufferedProtocol.get_buffer + name: get_buffer + uid: asyncio.BufferedProtocol.get_buffer +- fullName: asyncio.Condition.acquire + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Condition.acquire + name: acquire + uid: asyncio.Condition.acquire +- fullName: asyncio.Condition.locked + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Condition.locked + name: locked + uid: asyncio.Condition.locked +- fullName: asyncio.Condition.notify + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Condition.notify + name: notify + uid: asyncio.Condition.notify +- fullName: asyncio.Condition.notify_all + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Condition.notify_all + name: notify_all + uid: asyncio.Condition.notify_all +- fullName: asyncio.Condition.release + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Condition.release + name: release + uid: asyncio.Condition.release +- fullName: asyncio.Condition.wait + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Condition.wait + name: wait + uid: asyncio.Condition.wait +- fullName: asyncio.Condition.wait_for + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Condition.wait_for + name: wait_for + uid: asyncio.Condition.wait_for +- fullName: asyncio.DatagramProtocol.datagram_received + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.DatagramProtocol.datagram_received + name: datagram_received + uid: asyncio.DatagramProtocol.datagram_received +- fullName: asyncio.DatagramProtocol.error_received + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.DatagramProtocol.error_received + name: error_received + uid: asyncio.DatagramProtocol.error_received +- fullName: asyncio.DatagramTransport.abort + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.DatagramTransport.abort + name: abort + uid: asyncio.DatagramTransport.abort +- fullName: asyncio.DatagramTransport.sendto + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.DatagramTransport.sendto + name: sendto + uid: asyncio.DatagramTransport.sendto +- fullName: asyncio.Event.clear + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Event.clear + name: clear + uid: asyncio.Event.clear +- fullName: asyncio.Event.is_set + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Event.is_set + name: is_set + uid: asyncio.Event.is_set +- fullName: asyncio.Event.set + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Event.set + name: set + uid: asyncio.Event.set +- fullName: asyncio.Event.wait + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Event.wait + name: wait + uid: asyncio.Event.wait +- fullName: asyncio.Future.__init__ + href: https://docs.python.org/3/library/asyncio-extending.html#asyncio.Future.__init__ + name: __init__ + uid: asyncio.Future.__init__ +- fullName: asyncio.Future.add_done_callback + href: https://docs.python.org/3/library/asyncio-future.html#asyncio.Future.add_done_callback + name: add_done_callback + uid: asyncio.Future.add_done_callback +- fullName: asyncio.Future.cancel + href: https://docs.python.org/3/library/asyncio-future.html#asyncio.Future.cancel + name: cancel + uid: asyncio.Future.cancel +- fullName: asyncio.Future.cancelled + href: https://docs.python.org/3/library/asyncio-future.html#asyncio.Future.cancelled + name: cancelled + uid: asyncio.Future.cancelled +- fullName: asyncio.Future.done + href: https://docs.python.org/3/library/asyncio-future.html#asyncio.Future.done + name: done + uid: asyncio.Future.done +- fullName: asyncio.Future.exception + href: https://docs.python.org/3/library/asyncio-future.html#asyncio.Future.exception + name: exception + uid: asyncio.Future.exception +- fullName: asyncio.Future.get_loop + href: https://docs.python.org/3/library/asyncio-future.html#asyncio.Future.get_loop + name: get_loop + uid: asyncio.Future.get_loop +- fullName: asyncio.Future.remove_done_callback + href: https://docs.python.org/3/library/asyncio-future.html#asyncio.Future.remove_done_callback + name: remove_done_callback + uid: asyncio.Future.remove_done_callback +- fullName: asyncio.Future.result + href: https://docs.python.org/3/library/asyncio-future.html#asyncio.Future.result + name: result + uid: asyncio.Future.result +- fullName: asyncio.Future.set_exception + href: https://docs.python.org/3/library/asyncio-future.html#asyncio.Future.set_exception + name: set_exception + uid: asyncio.Future.set_exception +- fullName: asyncio.Future.set_result + href: https://docs.python.org/3/library/asyncio-future.html#asyncio.Future.set_result + name: set_result + uid: asyncio.Future.set_result +- fullName: asyncio.Handle.cancel + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.Handle.cancel + name: cancel + uid: asyncio.Handle.cancel +- fullName: asyncio.Handle.cancelled + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.Handle.cancelled + name: cancelled + uid: asyncio.Handle.cancelled +- fullName: asyncio.Handle.get_context + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.Handle.get_context + name: get_context + uid: asyncio.Handle.get_context +- fullName: asyncio.Lock.acquire + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Lock.acquire + name: acquire + uid: asyncio.Lock.acquire +- fullName: asyncio.Lock.locked + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Lock.locked + name: locked + uid: asyncio.Lock.locked +- fullName: asyncio.Lock.release + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Lock.release + name: release + uid: asyncio.Lock.release +- fullName: asyncio.Protocol.data_received + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.Protocol.data_received + name: data_received + uid: asyncio.Protocol.data_received +- fullName: asyncio.Protocol.eof_received + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.Protocol.eof_received + name: eof_received + uid: asyncio.Protocol.eof_received +- fullName: asyncio.Queue.empty + href: https://docs.python.org/3/library/asyncio-queue.html#asyncio.Queue.empty + name: empty + uid: asyncio.Queue.empty +- fullName: asyncio.Queue.full + href: https://docs.python.org/3/library/asyncio-queue.html#asyncio.Queue.full + name: full + uid: asyncio.Queue.full +- fullName: asyncio.Queue.get + href: https://docs.python.org/3/library/asyncio-queue.html#asyncio.Queue.get + name: get + uid: asyncio.Queue.get +- fullName: asyncio.Queue.get_nowait + href: https://docs.python.org/3/library/asyncio-queue.html#asyncio.Queue.get_nowait + name: get_nowait + uid: asyncio.Queue.get_nowait +- fullName: asyncio.Queue.join + href: https://docs.python.org/3/library/asyncio-queue.html#asyncio.Queue.join + name: join + uid: asyncio.Queue.join +- fullName: asyncio.Queue.put + href: https://docs.python.org/3/library/asyncio-queue.html#asyncio.Queue.put + name: put + uid: asyncio.Queue.put +- fullName: asyncio.Queue.put_nowait + href: https://docs.python.org/3/library/asyncio-queue.html#asyncio.Queue.put_nowait + name: put_nowait + uid: asyncio.Queue.put_nowait +- fullName: asyncio.Queue.qsize + href: https://docs.python.org/3/library/asyncio-queue.html#asyncio.Queue.qsize + name: qsize + uid: asyncio.Queue.qsize +- fullName: asyncio.Queue.shutdown + href: https://docs.python.org/3/library/asyncio-queue.html#asyncio.Queue.shutdown + name: shutdown + uid: asyncio.Queue.shutdown +- fullName: asyncio.Queue.task_done + href: https://docs.python.org/3/library/asyncio-queue.html#asyncio.Queue.task_done + name: task_done + uid: asyncio.Queue.task_done +- fullName: asyncio.ReadTransport.is_reading + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.ReadTransport.is_reading + name: is_reading + uid: asyncio.ReadTransport.is_reading +- fullName: asyncio.ReadTransport.pause_reading + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.ReadTransport.pause_reading + name: pause_reading + uid: asyncio.ReadTransport.pause_reading +- fullName: asyncio.ReadTransport.resume_reading + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.ReadTransport.resume_reading + name: resume_reading + uid: asyncio.ReadTransport.resume_reading +- fullName: asyncio.Runner.close + href: https://docs.python.org/3/library/asyncio-runner.html#asyncio.Runner.close + name: close + uid: asyncio.Runner.close +- fullName: asyncio.Runner.get_loop + href: https://docs.python.org/3/library/asyncio-runner.html#asyncio.Runner.get_loop + name: get_loop + uid: asyncio.Runner.get_loop +- fullName: asyncio.Runner.run + href: https://docs.python.org/3/library/asyncio-runner.html#asyncio.Runner.run + name: run + uid: asyncio.Runner.run +- fullName: asyncio.Semaphore.acquire + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Semaphore.acquire + name: acquire + uid: asyncio.Semaphore.acquire +- fullName: asyncio.Semaphore.locked + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Semaphore.locked + name: locked + uid: asyncio.Semaphore.locked +- fullName: asyncio.Semaphore.release + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Semaphore.release + name: release + uid: asyncio.Semaphore.release +- fullName: asyncio.Server.abort_clients + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.Server.abort_clients + name: abort_clients + uid: asyncio.Server.abort_clients +- fullName: asyncio.Server.close + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.Server.close + name: close + uid: asyncio.Server.close +- fullName: asyncio.Server.close_clients + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.Server.close_clients + name: close_clients + uid: asyncio.Server.close_clients +- fullName: asyncio.Server.get_loop + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.Server.get_loop + name: get_loop + uid: asyncio.Server.get_loop +- fullName: asyncio.Server.is_serving + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.Server.is_serving + name: is_serving + uid: asyncio.Server.is_serving +- fullName: asyncio.Server.serve_forever + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.Server.serve_forever + name: serve_forever + uid: asyncio.Server.serve_forever +- fullName: asyncio.Server.start_serving + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.Server.start_serving + name: start_serving + uid: asyncio.Server.start_serving +- fullName: asyncio.Server.wait_closed + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.Server.wait_closed + name: wait_closed + uid: asyncio.Server.wait_closed +- fullName: asyncio.StreamReader.at_eof + href: https://docs.python.org/3/library/asyncio-stream.html#asyncio.StreamReader.at_eof + name: at_eof + uid: asyncio.StreamReader.at_eof +- fullName: asyncio.StreamReader.feed_eof + href: https://docs.python.org/3/library/asyncio-stream.html#asyncio.StreamReader.feed_eof + name: feed_eof + uid: asyncio.StreamReader.feed_eof +- fullName: asyncio.StreamReader.read + href: https://docs.python.org/3/library/asyncio-stream.html#asyncio.StreamReader.read + name: read + uid: asyncio.StreamReader.read +- fullName: asyncio.StreamReader.readexactly + href: https://docs.python.org/3/library/asyncio-stream.html#asyncio.StreamReader.readexactly + name: readexactly + uid: asyncio.StreamReader.readexactly +- fullName: asyncio.StreamReader.readline + href: https://docs.python.org/3/library/asyncio-stream.html#asyncio.StreamReader.readline + name: readline + uid: asyncio.StreamReader.readline +- fullName: asyncio.StreamReader.readuntil + href: https://docs.python.org/3/library/asyncio-stream.html#asyncio.StreamReader.readuntil + name: readuntil + uid: asyncio.StreamReader.readuntil +- fullName: asyncio.StreamWriter.can_write_eof + href: https://docs.python.org/3/library/asyncio-stream.html#asyncio.StreamWriter.can_write_eof + name: can_write_eof + uid: asyncio.StreamWriter.can_write_eof +- fullName: asyncio.StreamWriter.close + href: https://docs.python.org/3/library/asyncio-stream.html#asyncio.StreamWriter.close + name: close + uid: asyncio.StreamWriter.close +- fullName: asyncio.StreamWriter.drain + href: https://docs.python.org/3/library/asyncio-stream.html#asyncio.StreamWriter.drain + name: drain + uid: asyncio.StreamWriter.drain +- fullName: asyncio.StreamWriter.get_extra_info + href: https://docs.python.org/3/library/asyncio-stream.html#asyncio.StreamWriter.get_extra_info + name: get_extra_info + uid: asyncio.StreamWriter.get_extra_info +- fullName: asyncio.StreamWriter.is_closing + href: https://docs.python.org/3/library/asyncio-stream.html#asyncio.StreamWriter.is_closing + name: is_closing + uid: asyncio.StreamWriter.is_closing +- fullName: asyncio.StreamWriter.start_tls + href: https://docs.python.org/3/library/asyncio-stream.html#asyncio.StreamWriter.start_tls + name: start_tls + uid: asyncio.StreamWriter.start_tls +- fullName: asyncio.StreamWriter.wait_closed + href: https://docs.python.org/3/library/asyncio-stream.html#asyncio.StreamWriter.wait_closed + name: wait_closed + uid: asyncio.StreamWriter.wait_closed +- fullName: asyncio.StreamWriter.write + href: https://docs.python.org/3/library/asyncio-stream.html#asyncio.StreamWriter.write + name: write + uid: asyncio.StreamWriter.write +- fullName: asyncio.StreamWriter.write_eof + href: https://docs.python.org/3/library/asyncio-stream.html#asyncio.StreamWriter.write_eof + name: write_eof + uid: asyncio.StreamWriter.write_eof +- fullName: asyncio.StreamWriter.writelines + href: https://docs.python.org/3/library/asyncio-stream.html#asyncio.StreamWriter.writelines + name: writelines + uid: asyncio.StreamWriter.writelines +- fullName: asyncio.SubprocessProtocol.pipe_connection_lost + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.SubprocessProtocol.pipe_connection_lost + name: pipe_connection_lost + uid: asyncio.SubprocessProtocol.pipe_connection_lost +- fullName: asyncio.SubprocessProtocol.pipe_data_received + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.SubprocessProtocol.pipe_data_received + name: pipe_data_received + uid: asyncio.SubprocessProtocol.pipe_data_received +- fullName: asyncio.SubprocessProtocol.process_exited + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.SubprocessProtocol.process_exited + name: process_exited + uid: asyncio.SubprocessProtocol.process_exited +- fullName: asyncio.SubprocessTransport.close + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.SubprocessTransport.close + name: close + uid: asyncio.SubprocessTransport.close +- fullName: asyncio.SubprocessTransport.get_pid + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.SubprocessTransport.get_pid + name: get_pid + uid: asyncio.SubprocessTransport.get_pid +- fullName: asyncio.SubprocessTransport.get_pipe_transport + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.SubprocessTransport.get_pipe_transport + name: get_pipe_transport + uid: asyncio.SubprocessTransport.get_pipe_transport +- fullName: asyncio.SubprocessTransport.get_returncode + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.SubprocessTransport.get_returncode + name: get_returncode + uid: asyncio.SubprocessTransport.get_returncode +- fullName: asyncio.SubprocessTransport.kill + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.SubprocessTransport.kill + name: kill + uid: asyncio.SubprocessTransport.kill +- fullName: asyncio.SubprocessTransport.send_signal + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.SubprocessTransport.send_signal + name: send_signal + uid: asyncio.SubprocessTransport.send_signal +- fullName: asyncio.SubprocessTransport.terminate + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.SubprocessTransport.terminate + name: terminate + uid: asyncio.SubprocessTransport.terminate +- fullName: asyncio.Task.__init__ + href: https://docs.python.org/3/library/asyncio-extending.html#asyncio.Task.__init__ + name: __init__ + uid: asyncio.Task.__init__ +- fullName: asyncio.Task.add_done_callback + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.Task.add_done_callback + name: add_done_callback + uid: asyncio.Task.add_done_callback +- fullName: asyncio.Task.cancel + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.Task.cancel + name: cancel + uid: asyncio.Task.cancel +- fullName: asyncio.Task.cancelled + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.Task.cancelled + name: cancelled + uid: asyncio.Task.cancelled +- fullName: asyncio.Task.cancelling + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.Task.cancelling + name: cancelling + uid: asyncio.Task.cancelling +- fullName: asyncio.Task.done + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.Task.done + name: done + uid: asyncio.Task.done +- fullName: asyncio.Task.exception + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.Task.exception + name: exception + uid: asyncio.Task.exception +- fullName: asyncio.Task.get_context + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.Task.get_context + name: get_context + uid: asyncio.Task.get_context +- fullName: asyncio.Task.get_coro + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.Task.get_coro + name: get_coro + uid: asyncio.Task.get_coro +- fullName: asyncio.Task.get_name + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.Task.get_name + name: get_name + uid: asyncio.Task.get_name +- fullName: asyncio.Task.get_stack + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.Task.get_stack + name: get_stack + uid: asyncio.Task.get_stack +- fullName: asyncio.Task.print_stack + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.Task.print_stack + name: print_stack + uid: asyncio.Task.print_stack +- fullName: asyncio.Task.remove_done_callback + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.Task.remove_done_callback + name: remove_done_callback + uid: asyncio.Task.remove_done_callback +- fullName: asyncio.Task.result + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.Task.result + name: result + uid: asyncio.Task.result +- fullName: asyncio.Task.set_name + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.Task.set_name + name: set_name + uid: asyncio.Task.set_name +- fullName: asyncio.Task.uncancel + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.Task.uncancel + name: uncancel + uid: asyncio.Task.uncancel +- fullName: asyncio.TaskGroup.create_task + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.TaskGroup.create_task + name: create_task + uid: asyncio.TaskGroup.create_task +- fullName: asyncio.Timeout.expired + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.Timeout.expired + name: expired + uid: asyncio.Timeout.expired +- fullName: asyncio.Timeout.reschedule + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.Timeout.reschedule + name: reschedule + uid: asyncio.Timeout.reschedule +- fullName: asyncio.Timeout.when + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.Timeout.when + name: when + uid: asyncio.Timeout.when +- fullName: asyncio.TimerHandle.when + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.TimerHandle.when + name: when + uid: asyncio.TimerHandle.when +- fullName: asyncio.WriteTransport.abort + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.WriteTransport.abort + name: abort + uid: asyncio.WriteTransport.abort +- fullName: asyncio.WriteTransport.can_write_eof + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.WriteTransport.can_write_eof + name: can_write_eof + uid: asyncio.WriteTransport.can_write_eof +- fullName: asyncio.WriteTransport.get_write_buffer_limits + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.WriteTransport.get_write_buffer_limits + name: get_write_buffer_limits + uid: asyncio.WriteTransport.get_write_buffer_limits +- fullName: asyncio.WriteTransport.get_write_buffer_size + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.WriteTransport.get_write_buffer_size + name: get_write_buffer_size + uid: asyncio.WriteTransport.get_write_buffer_size +- fullName: asyncio.WriteTransport.set_write_buffer_limits + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.WriteTransport.set_write_buffer_limits + name: set_write_buffer_limits + uid: asyncio.WriteTransport.set_write_buffer_limits +- fullName: asyncio.WriteTransport.write + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.WriteTransport.write + name: write + uid: asyncio.WriteTransport.write +- fullName: asyncio.WriteTransport.write_eof + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.WriteTransport.write_eof + name: write_eof + uid: asyncio.WriteTransport.write_eof +- fullName: asyncio.WriteTransport.writelines + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.WriteTransport.writelines + name: writelines + uid: asyncio.WriteTransport.writelines +- fullName: asyncio.loop.add_reader + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.add_reader + name: add_reader + uid: asyncio.loop.add_reader +- fullName: asyncio.loop.add_signal_handler + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.add_signal_handler + name: add_signal_handler + uid: asyncio.loop.add_signal_handler +- fullName: asyncio.loop.add_writer + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.add_writer + name: add_writer + uid: asyncio.loop.add_writer +- fullName: asyncio.loop.call_at + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.call_at + name: call_at + uid: asyncio.loop.call_at +- fullName: asyncio.loop.call_exception_handler + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.call_exception_handler + name: call_exception_handler + uid: asyncio.loop.call_exception_handler +- fullName: asyncio.loop.call_later + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.call_later + name: call_later + uid: asyncio.loop.call_later +- fullName: asyncio.loop.call_soon + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.call_soon + name: call_soon + uid: asyncio.loop.call_soon +- fullName: asyncio.loop.call_soon_threadsafe + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.call_soon_threadsafe + name: call_soon_threadsafe + uid: asyncio.loop.call_soon_threadsafe +- fullName: asyncio.loop.close + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.close + name: close + uid: asyncio.loop.close +- fullName: asyncio.loop.connect_accepted_socket + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.connect_accepted_socket + name: connect_accepted_socket + uid: asyncio.loop.connect_accepted_socket +- fullName: asyncio.loop.connect_read_pipe + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.connect_read_pipe + name: connect_read_pipe + uid: asyncio.loop.connect_read_pipe +- fullName: asyncio.loop.connect_write_pipe + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.connect_write_pipe + name: connect_write_pipe + uid: asyncio.loop.connect_write_pipe +- fullName: asyncio.loop.create_connection + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.create_connection + name: create_connection + uid: asyncio.loop.create_connection +- fullName: asyncio.loop.create_datagram_endpoint + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.create_datagram_endpoint + name: create_datagram_endpoint + uid: asyncio.loop.create_datagram_endpoint +- fullName: asyncio.loop.create_future + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.create_future + name: create_future + uid: asyncio.loop.create_future +- fullName: asyncio.loop.create_server + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.create_server + name: create_server + uid: asyncio.loop.create_server +- fullName: asyncio.loop.create_task + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.create_task + name: create_task + uid: asyncio.loop.create_task +- fullName: asyncio.loop.create_unix_connection + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.create_unix_connection + name: create_unix_connection + uid: asyncio.loop.create_unix_connection +- fullName: asyncio.loop.create_unix_server + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.create_unix_server + name: create_unix_server + uid: asyncio.loop.create_unix_server +- fullName: asyncio.loop.default_exception_handler + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.default_exception_handler + name: default_exception_handler + uid: asyncio.loop.default_exception_handler +- fullName: asyncio.loop.get_debug + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.get_debug + name: get_debug + uid: asyncio.loop.get_debug +- fullName: asyncio.loop.get_exception_handler + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.get_exception_handler + name: get_exception_handler + uid: asyncio.loop.get_exception_handler +- fullName: asyncio.loop.get_task_factory + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.get_task_factory + name: get_task_factory + uid: asyncio.loop.get_task_factory +- fullName: asyncio.loop.getaddrinfo + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.getaddrinfo + name: getaddrinfo + uid: asyncio.loop.getaddrinfo +- fullName: asyncio.loop.getnameinfo + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.getnameinfo + name: getnameinfo + uid: asyncio.loop.getnameinfo +- fullName: asyncio.loop.is_closed + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.is_closed + name: is_closed + uid: asyncio.loop.is_closed +- fullName: asyncio.loop.is_running + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.is_running + name: is_running + uid: asyncio.loop.is_running +- fullName: asyncio.loop.remove_reader + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.remove_reader + name: remove_reader + uid: asyncio.loop.remove_reader +- fullName: asyncio.loop.remove_signal_handler + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.remove_signal_handler + name: remove_signal_handler + uid: asyncio.loop.remove_signal_handler +- fullName: asyncio.loop.remove_writer + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.remove_writer + name: remove_writer + uid: asyncio.loop.remove_writer +- fullName: asyncio.loop.run_forever + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.run_forever + name: run_forever + uid: asyncio.loop.run_forever +- fullName: asyncio.loop.run_in_executor + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.run_in_executor + name: run_in_executor + uid: asyncio.loop.run_in_executor +- fullName: asyncio.loop.run_until_complete + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.run_until_complete + name: run_until_complete + uid: asyncio.loop.run_until_complete +- fullName: asyncio.loop.sendfile + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.sendfile + name: sendfile + uid: asyncio.loop.sendfile +- fullName: asyncio.loop.set_debug + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.set_debug + name: set_debug + uid: asyncio.loop.set_debug +- fullName: asyncio.loop.set_default_executor + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.set_default_executor + name: set_default_executor + uid: asyncio.loop.set_default_executor +- fullName: asyncio.loop.set_exception_handler + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.set_exception_handler + name: set_exception_handler + uid: asyncio.loop.set_exception_handler +- fullName: asyncio.loop.set_task_factory + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.set_task_factory + name: set_task_factory + uid: asyncio.loop.set_task_factory +- fullName: asyncio.loop.shutdown_asyncgens + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.shutdown_asyncgens + name: shutdown_asyncgens + uid: asyncio.loop.shutdown_asyncgens +- fullName: asyncio.loop.shutdown_default_executor + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.shutdown_default_executor + name: shutdown_default_executor + uid: asyncio.loop.shutdown_default_executor +- fullName: asyncio.loop.sock_accept + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.sock_accept + name: sock_accept + uid: asyncio.loop.sock_accept +- fullName: asyncio.loop.sock_connect + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.sock_connect + name: sock_connect + uid: asyncio.loop.sock_connect +- fullName: asyncio.loop.sock_recv + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.sock_recv + name: sock_recv + uid: asyncio.loop.sock_recv +- fullName: asyncio.loop.sock_recv_into + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.sock_recv_into + name: sock_recv_into + uid: asyncio.loop.sock_recv_into +- fullName: asyncio.loop.sock_recvfrom + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.sock_recvfrom + name: sock_recvfrom + uid: asyncio.loop.sock_recvfrom +- fullName: asyncio.loop.sock_recvfrom_into + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.sock_recvfrom_into + name: sock_recvfrom_into + uid: asyncio.loop.sock_recvfrom_into +- fullName: asyncio.loop.sock_sendall + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.sock_sendall + name: sock_sendall + uid: asyncio.loop.sock_sendall +- fullName: asyncio.loop.sock_sendfile + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.sock_sendfile + name: sock_sendfile + uid: asyncio.loop.sock_sendfile +- fullName: asyncio.loop.sock_sendto + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.sock_sendto + name: sock_sendto + uid: asyncio.loop.sock_sendto +- fullName: asyncio.loop.start_tls + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.start_tls + name: start_tls + uid: asyncio.loop.start_tls +- fullName: asyncio.loop.stop + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.stop + name: stop + uid: asyncio.loop.stop +- fullName: asyncio.loop.subprocess_exec + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.subprocess_exec + name: subprocess_exec + uid: asyncio.loop.subprocess_exec +- fullName: asyncio.loop.subprocess_shell + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.subprocess_shell + name: subprocess_shell + uid: asyncio.loop.subprocess_shell +- fullName: asyncio.loop.time + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.loop.time + name: time + uid: asyncio.loop.time +- fullName: asyncio.subprocess.Process.communicate + href: https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.subprocess.Process.communicate + name: communicate + uid: asyncio.subprocess.Process.communicate +- fullName: asyncio.subprocess.Process.kill + href: https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.subprocess.Process.kill + name: kill + uid: asyncio.subprocess.Process.kill +- fullName: asyncio.subprocess.Process.send_signal + href: https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.subprocess.Process.send_signal + name: send_signal + uid: asyncio.subprocess.Process.send_signal +- fullName: asyncio.subprocess.Process.terminate + href: https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.subprocess.Process.terminate + name: terminate + uid: asyncio.subprocess.Process.terminate +- fullName: asyncio.subprocess.Process.wait + href: https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.subprocess.Process.wait + name: wait + uid: asyncio.subprocess.Process.wait +- fullName: bdb.Bdb.break_anywhere + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.break_anywhere + name: break_anywhere + uid: bdb.Bdb.break_anywhere +- fullName: bdb.Bdb.break_here + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.break_here + name: break_here + uid: bdb.Bdb.break_here +- fullName: bdb.Bdb.canonic + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.canonic + name: canonic + uid: bdb.Bdb.canonic +- fullName: bdb.Bdb.clear_all_breaks + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.clear_all_breaks + name: clear_all_breaks + uid: bdb.Bdb.clear_all_breaks +- fullName: bdb.Bdb.clear_all_file_breaks + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.clear_all_file_breaks + name: clear_all_file_breaks + uid: bdb.Bdb.clear_all_file_breaks +- fullName: bdb.Bdb.clear_bpbynumber + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.clear_bpbynumber + name: clear_bpbynumber + uid: bdb.Bdb.clear_bpbynumber +- fullName: bdb.Bdb.clear_break + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.clear_break + name: clear_break + uid: bdb.Bdb.clear_break +- fullName: bdb.Bdb.dispatch_call + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.dispatch_call + name: dispatch_call + uid: bdb.Bdb.dispatch_call +- fullName: bdb.Bdb.dispatch_exception + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.dispatch_exception + name: dispatch_exception + uid: bdb.Bdb.dispatch_exception +- fullName: bdb.Bdb.dispatch_line + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.dispatch_line + name: dispatch_line + uid: bdb.Bdb.dispatch_line +- fullName: bdb.Bdb.dispatch_return + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.dispatch_return + name: dispatch_return + uid: bdb.Bdb.dispatch_return +- fullName: bdb.Bdb.do_clear + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.do_clear + name: do_clear + uid: bdb.Bdb.do_clear +- fullName: bdb.Bdb.format_stack_entry + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.format_stack_entry + name: format_stack_entry + uid: bdb.Bdb.format_stack_entry +- fullName: bdb.Bdb.get_all_breaks + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.get_all_breaks + name: get_all_breaks + uid: bdb.Bdb.get_all_breaks +- fullName: bdb.Bdb.get_bpbynumber + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.get_bpbynumber + name: get_bpbynumber + uid: bdb.Bdb.get_bpbynumber +- fullName: bdb.Bdb.get_break + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.get_break + name: get_break + uid: bdb.Bdb.get_break +- fullName: bdb.Bdb.get_breaks + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.get_breaks + name: get_breaks + uid: bdb.Bdb.get_breaks +- fullName: bdb.Bdb.get_file_breaks + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.get_file_breaks + name: get_file_breaks + uid: bdb.Bdb.get_file_breaks +- fullName: bdb.Bdb.get_stack + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.get_stack + name: get_stack + uid: bdb.Bdb.get_stack +- fullName: bdb.Bdb.is_skipped_line + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.is_skipped_line + name: is_skipped_line + uid: bdb.Bdb.is_skipped_line +- fullName: bdb.Bdb.reset + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.reset + name: reset + uid: bdb.Bdb.reset +- fullName: bdb.Bdb.run + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.run + name: run + uid: bdb.Bdb.run +- fullName: bdb.Bdb.runcall + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.runcall + name: runcall + uid: bdb.Bdb.runcall +- fullName: bdb.Bdb.runctx + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.runctx + name: runctx + uid: bdb.Bdb.runctx +- fullName: bdb.Bdb.runeval + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.runeval + name: runeval + uid: bdb.Bdb.runeval +- fullName: bdb.Bdb.set_break + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.set_break + name: set_break + uid: bdb.Bdb.set_break +- fullName: bdb.Bdb.set_continue + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.set_continue + name: set_continue + uid: bdb.Bdb.set_continue +- fullName: bdb.Bdb.set_next + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.set_next + name: set_next + uid: bdb.Bdb.set_next +- fullName: bdb.Bdb.set_quit + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.set_quit + name: set_quit + uid: bdb.Bdb.set_quit +- fullName: bdb.Bdb.set_return + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.set_return + name: set_return + uid: bdb.Bdb.set_return +- fullName: bdb.Bdb.set_step + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.set_step + name: set_step + uid: bdb.Bdb.set_step +- fullName: bdb.Bdb.set_trace + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.set_trace + name: set_trace + uid: bdb.Bdb.set_trace +- fullName: bdb.Bdb.set_until + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.set_until + name: set_until + uid: bdb.Bdb.set_until +- fullName: bdb.Bdb.stop_here + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.stop_here + name: stop_here + uid: bdb.Bdb.stop_here +- fullName: bdb.Bdb.trace_dispatch + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.trace_dispatch + name: trace_dispatch + uid: bdb.Bdb.trace_dispatch +- fullName: bdb.Bdb.user_call + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.user_call + name: user_call + uid: bdb.Bdb.user_call +- fullName: bdb.Bdb.user_exception + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.user_exception + name: user_exception + uid: bdb.Bdb.user_exception +- fullName: bdb.Bdb.user_line + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.user_line + name: user_line + uid: bdb.Bdb.user_line +- fullName: bdb.Bdb.user_return + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb.user_return + name: user_return + uid: bdb.Bdb.user_return +- fullName: bdb.Breakpoint.bpformat + href: https://docs.python.org/3/library/bdb.html#bdb.Breakpoint.bpformat + name: bpformat + uid: bdb.Breakpoint.bpformat +- fullName: bdb.Breakpoint.bpprint + href: https://docs.python.org/3/library/bdb.html#bdb.Breakpoint.bpprint + name: bpprint + uid: bdb.Breakpoint.bpprint +- fullName: bdb.Breakpoint.deleteMe + href: https://docs.python.org/3/library/bdb.html#bdb.Breakpoint.deleteMe + name: deleteMe + uid: bdb.Breakpoint.deleteMe +- fullName: bdb.Breakpoint.disable + href: https://docs.python.org/3/library/bdb.html#bdb.Breakpoint.disable + name: disable + uid: bdb.Breakpoint.disable +- fullName: bdb.Breakpoint.enable + href: https://docs.python.org/3/library/bdb.html#bdb.Breakpoint.enable + name: enable + uid: bdb.Breakpoint.enable +- fullName: bytearray.capitalize + href: https://docs.python.org/3/library/stdtypes.html#bytearray.capitalize + name: capitalize + uid: bytearray.capitalize +- fullName: bytearray.center + href: https://docs.python.org/3/library/stdtypes.html#bytearray.center + name: center + uid: bytearray.center +- fullName: bytearray.count + href: https://docs.python.org/3/library/stdtypes.html#bytearray.count + name: count + uid: bytearray.count +- fullName: bytearray.decode + href: https://docs.python.org/3/library/stdtypes.html#bytearray.decode + name: decode + uid: bytearray.decode +- fullName: bytearray.endswith + href: https://docs.python.org/3/library/stdtypes.html#bytearray.endswith + name: endswith + uid: bytearray.endswith +- fullName: bytearray.expandtabs + href: https://docs.python.org/3/library/stdtypes.html#bytearray.expandtabs + name: expandtabs + uid: bytearray.expandtabs +- fullName: bytearray.find + href: https://docs.python.org/3/library/stdtypes.html#bytearray.find + name: find + uid: bytearray.find +- fullName: bytearray.fromhex + href: https://docs.python.org/3/library/stdtypes.html#bytearray.fromhex + name: fromhex + uid: bytearray.fromhex +- fullName: bytearray.hex + href: https://docs.python.org/3/library/stdtypes.html#bytearray.hex + name: hex + uid: bytearray.hex +- fullName: bytearray.index + href: https://docs.python.org/3/library/stdtypes.html#bytearray.index + name: index + uid: bytearray.index +- fullName: bytearray.isalnum + href: https://docs.python.org/3/library/stdtypes.html#bytearray.isalnum + name: isalnum + uid: bytearray.isalnum +- fullName: bytearray.isalpha + href: https://docs.python.org/3/library/stdtypes.html#bytearray.isalpha + name: isalpha + uid: bytearray.isalpha +- fullName: bytearray.isascii + href: https://docs.python.org/3/library/stdtypes.html#bytearray.isascii + name: isascii + uid: bytearray.isascii +- fullName: bytearray.isdigit + href: https://docs.python.org/3/library/stdtypes.html#bytearray.isdigit + name: isdigit + uid: bytearray.isdigit +- fullName: bytearray.islower + href: https://docs.python.org/3/library/stdtypes.html#bytearray.islower + name: islower + uid: bytearray.islower +- fullName: bytearray.isspace + href: https://docs.python.org/3/library/stdtypes.html#bytearray.isspace + name: isspace + uid: bytearray.isspace +- fullName: bytearray.istitle + href: https://docs.python.org/3/library/stdtypes.html#bytearray.istitle + name: istitle + uid: bytearray.istitle +- fullName: bytearray.isupper + href: https://docs.python.org/3/library/stdtypes.html#bytearray.isupper + name: isupper + uid: bytearray.isupper +- fullName: bytearray.join + href: https://docs.python.org/3/library/stdtypes.html#bytearray.join + name: join + uid: bytearray.join +- fullName: bytearray.ljust + href: https://docs.python.org/3/library/stdtypes.html#bytearray.ljust + name: ljust + uid: bytearray.ljust +- fullName: bytearray.lower + href: https://docs.python.org/3/library/stdtypes.html#bytearray.lower + name: lower + uid: bytearray.lower +- fullName: bytearray.lstrip + href: https://docs.python.org/3/library/stdtypes.html#bytearray.lstrip + name: lstrip + uid: bytearray.lstrip +- fullName: bytearray.maketrans + href: https://docs.python.org/3/library/stdtypes.html#bytearray.maketrans + name: maketrans + uid: bytearray.maketrans +- fullName: bytearray.partition + href: https://docs.python.org/3/library/stdtypes.html#bytearray.partition + name: partition + uid: bytearray.partition +- fullName: bytearray.removeprefix + href: https://docs.python.org/3/library/stdtypes.html#bytearray.removeprefix + name: removeprefix + uid: bytearray.removeprefix +- fullName: bytearray.removesuffix + href: https://docs.python.org/3/library/stdtypes.html#bytearray.removesuffix + name: removesuffix + uid: bytearray.removesuffix +- fullName: bytearray.replace + href: https://docs.python.org/3/library/stdtypes.html#bytearray.replace + name: replace + uid: bytearray.replace +- fullName: bytearray.rfind + href: https://docs.python.org/3/library/stdtypes.html#bytearray.rfind + name: rfind + uid: bytearray.rfind +- fullName: bytearray.rindex + href: https://docs.python.org/3/library/stdtypes.html#bytearray.rindex + name: rindex + uid: bytearray.rindex +- fullName: bytearray.rjust + href: https://docs.python.org/3/library/stdtypes.html#bytearray.rjust + name: rjust + uid: bytearray.rjust +- fullName: bytearray.rpartition + href: https://docs.python.org/3/library/stdtypes.html#bytearray.rpartition + name: rpartition + uid: bytearray.rpartition +- fullName: bytearray.rsplit + href: https://docs.python.org/3/library/stdtypes.html#bytearray.rsplit + name: rsplit + uid: bytearray.rsplit +- fullName: bytearray.rstrip + href: https://docs.python.org/3/library/stdtypes.html#bytearray.rstrip + name: rstrip + uid: bytearray.rstrip +- fullName: bytearray.split + href: https://docs.python.org/3/library/stdtypes.html#bytearray.split + name: split + uid: bytearray.split +- fullName: bytearray.splitlines + href: https://docs.python.org/3/library/stdtypes.html#bytearray.splitlines + name: splitlines + uid: bytearray.splitlines +- fullName: bytearray.startswith + href: https://docs.python.org/3/library/stdtypes.html#bytearray.startswith + name: startswith + uid: bytearray.startswith +- fullName: bytearray.strip + href: https://docs.python.org/3/library/stdtypes.html#bytearray.strip + name: strip + uid: bytearray.strip +- fullName: bytearray.swapcase + href: https://docs.python.org/3/library/stdtypes.html#bytearray.swapcase + name: swapcase + uid: bytearray.swapcase +- fullName: bytearray.title + href: https://docs.python.org/3/library/stdtypes.html#bytearray.title + name: title + uid: bytearray.title +- fullName: bytearray.translate + href: https://docs.python.org/3/library/stdtypes.html#bytearray.translate + name: translate + uid: bytearray.translate +- fullName: bytearray.upper + href: https://docs.python.org/3/library/stdtypes.html#bytearray.upper + name: upper + uid: bytearray.upper +- fullName: bytearray.zfill + href: https://docs.python.org/3/library/stdtypes.html#bytearray.zfill + name: zfill + uid: bytearray.zfill +- fullName: bytes.capitalize + href: https://docs.python.org/3/library/stdtypes.html#bytes.capitalize + name: capitalize + uid: bytes.capitalize +- fullName: bytes.center + href: https://docs.python.org/3/library/stdtypes.html#bytes.center + name: center + uid: bytes.center +- fullName: bytes.count + href: https://docs.python.org/3/library/stdtypes.html#bytes.count + name: count + uid: bytes.count +- fullName: bytes.decode + href: https://docs.python.org/3/library/stdtypes.html#bytes.decode + name: decode + uid: bytes.decode +- fullName: bytes.endswith + href: https://docs.python.org/3/library/stdtypes.html#bytes.endswith + name: endswith + uid: bytes.endswith +- fullName: bytes.expandtabs + href: https://docs.python.org/3/library/stdtypes.html#bytes.expandtabs + name: expandtabs + uid: bytes.expandtabs +- fullName: bytes.find + href: https://docs.python.org/3/library/stdtypes.html#bytes.find + name: find + uid: bytes.find +- fullName: bytes.fromhex + href: https://docs.python.org/3/library/stdtypes.html#bytes.fromhex + name: fromhex + uid: bytes.fromhex +- fullName: bytes.hex + href: https://docs.python.org/3/library/stdtypes.html#bytes.hex + name: hex + uid: bytes.hex +- fullName: bytes.index + href: https://docs.python.org/3/library/stdtypes.html#bytes.index + name: index + uid: bytes.index +- fullName: bytes.isalnum + href: https://docs.python.org/3/library/stdtypes.html#bytes.isalnum + name: isalnum + uid: bytes.isalnum +- fullName: bytes.isalpha + href: https://docs.python.org/3/library/stdtypes.html#bytes.isalpha + name: isalpha + uid: bytes.isalpha +- fullName: bytes.isascii + href: https://docs.python.org/3/library/stdtypes.html#bytes.isascii + name: isascii + uid: bytes.isascii +- fullName: bytes.isdigit + href: https://docs.python.org/3/library/stdtypes.html#bytes.isdigit + name: isdigit + uid: bytes.isdigit +- fullName: bytes.islower + href: https://docs.python.org/3/library/stdtypes.html#bytes.islower + name: islower + uid: bytes.islower +- fullName: bytes.isspace + href: https://docs.python.org/3/library/stdtypes.html#bytes.isspace + name: isspace + uid: bytes.isspace +- fullName: bytes.istitle + href: https://docs.python.org/3/library/stdtypes.html#bytes.istitle + name: istitle + uid: bytes.istitle +- fullName: bytes.isupper + href: https://docs.python.org/3/library/stdtypes.html#bytes.isupper + name: isupper + uid: bytes.isupper +- fullName: bytes.join + href: https://docs.python.org/3/library/stdtypes.html#bytes.join + name: join + uid: bytes.join +- fullName: bytes.ljust + href: https://docs.python.org/3/library/stdtypes.html#bytes.ljust + name: ljust + uid: bytes.ljust +- fullName: bytes.lower + href: https://docs.python.org/3/library/stdtypes.html#bytes.lower + name: lower + uid: bytes.lower +- fullName: bytes.lstrip + href: https://docs.python.org/3/library/stdtypes.html#bytes.lstrip + name: lstrip + uid: bytes.lstrip +- fullName: bytes.maketrans + href: https://docs.python.org/3/library/stdtypes.html#bytes.maketrans + name: maketrans + uid: bytes.maketrans +- fullName: bytes.partition + href: https://docs.python.org/3/library/stdtypes.html#bytes.partition + name: partition + uid: bytes.partition +- fullName: bytes.removeprefix + href: https://docs.python.org/3/library/stdtypes.html#bytes.removeprefix + name: removeprefix + uid: bytes.removeprefix +- fullName: bytes.removesuffix + href: https://docs.python.org/3/library/stdtypes.html#bytes.removesuffix + name: removesuffix + uid: bytes.removesuffix +- fullName: bytes.replace + href: https://docs.python.org/3/library/stdtypes.html#bytes.replace + name: replace + uid: bytes.replace +- fullName: bytes.rfind + href: https://docs.python.org/3/library/stdtypes.html#bytes.rfind + name: rfind + uid: bytes.rfind +- fullName: bytes.rindex + href: https://docs.python.org/3/library/stdtypes.html#bytes.rindex + name: rindex + uid: bytes.rindex +- fullName: bytes.rjust + href: https://docs.python.org/3/library/stdtypes.html#bytes.rjust + name: rjust + uid: bytes.rjust +- fullName: bytes.rpartition + href: https://docs.python.org/3/library/stdtypes.html#bytes.rpartition + name: rpartition + uid: bytes.rpartition +- fullName: bytes.rsplit + href: https://docs.python.org/3/library/stdtypes.html#bytes.rsplit + name: rsplit + uid: bytes.rsplit +- fullName: bytes.rstrip + href: https://docs.python.org/3/library/stdtypes.html#bytes.rstrip + name: rstrip + uid: bytes.rstrip +- fullName: bytes.split + href: https://docs.python.org/3/library/stdtypes.html#bytes.split + name: split + uid: bytes.split +- fullName: bytes.splitlines + href: https://docs.python.org/3/library/stdtypes.html#bytes.splitlines + name: splitlines + uid: bytes.splitlines +- fullName: bytes.startswith + href: https://docs.python.org/3/library/stdtypes.html#bytes.startswith + name: startswith + uid: bytes.startswith +- fullName: bytes.strip + href: https://docs.python.org/3/library/stdtypes.html#bytes.strip + name: strip + uid: bytes.strip +- fullName: bytes.swapcase + href: https://docs.python.org/3/library/stdtypes.html#bytes.swapcase + name: swapcase + uid: bytes.swapcase +- fullName: bytes.title + href: https://docs.python.org/3/library/stdtypes.html#bytes.title + name: title + uid: bytes.title +- fullName: bytes.translate + href: https://docs.python.org/3/library/stdtypes.html#bytes.translate + name: translate + uid: bytes.translate +- fullName: bytes.upper + href: https://docs.python.org/3/library/stdtypes.html#bytes.upper + name: upper + uid: bytes.upper +- fullName: bytes.zfill + href: https://docs.python.org/3/library/stdtypes.html#bytes.zfill + name: zfill + uid: bytes.zfill +- fullName: bz2.BZ2Compressor.compress + href: https://docs.python.org/3/library/bz2.html#bz2.BZ2Compressor.compress + name: compress + uid: bz2.BZ2Compressor.compress +- fullName: bz2.BZ2Compressor.flush + href: https://docs.python.org/3/library/bz2.html#bz2.BZ2Compressor.flush + name: flush + uid: bz2.BZ2Compressor.flush +- fullName: bz2.BZ2Decompressor.decompress + href: https://docs.python.org/3/library/bz2.html#bz2.BZ2Decompressor.decompress + name: decompress + uid: bz2.BZ2Decompressor.decompress +- fullName: bz2.BZ2File.fileno + href: https://docs.python.org/3/library/bz2.html#bz2.BZ2File.fileno + name: fileno + uid: bz2.BZ2File.fileno +- fullName: bz2.BZ2File.peek + href: https://docs.python.org/3/library/bz2.html#bz2.BZ2File.peek + name: peek + uid: bz2.BZ2File.peek +- fullName: bz2.BZ2File.read1 + href: https://docs.python.org/3/library/bz2.html#bz2.BZ2File.read1 + name: read1 + uid: bz2.BZ2File.read1 +- fullName: bz2.BZ2File.readable + href: https://docs.python.org/3/library/bz2.html#bz2.BZ2File.readable + name: readable + uid: bz2.BZ2File.readable +- fullName: bz2.BZ2File.readinto + href: https://docs.python.org/3/library/bz2.html#bz2.BZ2File.readinto + name: readinto + uid: bz2.BZ2File.readinto +- fullName: bz2.BZ2File.seekable + href: https://docs.python.org/3/library/bz2.html#bz2.BZ2File.seekable + name: seekable + uid: bz2.BZ2File.seekable +- fullName: bz2.BZ2File.writable + href: https://docs.python.org/3/library/bz2.html#bz2.BZ2File.writable + name: writable + uid: bz2.BZ2File.writable +- fullName: calendar.Calendar.getfirstweekday + href: https://docs.python.org/3/library/calendar.html#calendar.Calendar.getfirstweekday + name: getfirstweekday + uid: calendar.Calendar.getfirstweekday +- fullName: calendar.Calendar.itermonthdates + href: https://docs.python.org/3/library/calendar.html#calendar.Calendar.itermonthdates + name: itermonthdates + uid: calendar.Calendar.itermonthdates +- fullName: calendar.Calendar.itermonthdays + href: https://docs.python.org/3/library/calendar.html#calendar.Calendar.itermonthdays + name: itermonthdays + uid: calendar.Calendar.itermonthdays +- fullName: calendar.Calendar.itermonthdays2 + href: https://docs.python.org/3/library/calendar.html#calendar.Calendar.itermonthdays2 + name: itermonthdays2 + uid: calendar.Calendar.itermonthdays2 +- fullName: calendar.Calendar.itermonthdays3 + href: https://docs.python.org/3/library/calendar.html#calendar.Calendar.itermonthdays3 + name: itermonthdays3 + uid: calendar.Calendar.itermonthdays3 +- fullName: calendar.Calendar.itermonthdays4 + href: https://docs.python.org/3/library/calendar.html#calendar.Calendar.itermonthdays4 + name: itermonthdays4 + uid: calendar.Calendar.itermonthdays4 +- fullName: calendar.Calendar.iterweekdays + href: https://docs.python.org/3/library/calendar.html#calendar.Calendar.iterweekdays + name: iterweekdays + uid: calendar.Calendar.iterweekdays +- fullName: calendar.Calendar.monthdatescalendar + href: https://docs.python.org/3/library/calendar.html#calendar.Calendar.monthdatescalendar + name: monthdatescalendar + uid: calendar.Calendar.monthdatescalendar +- fullName: calendar.Calendar.monthdays2calendar + href: https://docs.python.org/3/library/calendar.html#calendar.Calendar.monthdays2calendar + name: monthdays2calendar + uid: calendar.Calendar.monthdays2calendar +- fullName: calendar.Calendar.monthdayscalendar + href: https://docs.python.org/3/library/calendar.html#calendar.Calendar.monthdayscalendar + name: monthdayscalendar + uid: calendar.Calendar.monthdayscalendar +- fullName: calendar.Calendar.setfirstweekday + href: https://docs.python.org/3/library/calendar.html#calendar.Calendar.setfirstweekday + name: setfirstweekday + uid: calendar.Calendar.setfirstweekday +- fullName: calendar.Calendar.yeardatescalendar + href: https://docs.python.org/3/library/calendar.html#calendar.Calendar.yeardatescalendar + name: yeardatescalendar + uid: calendar.Calendar.yeardatescalendar +- fullName: calendar.Calendar.yeardays2calendar + href: https://docs.python.org/3/library/calendar.html#calendar.Calendar.yeardays2calendar + name: yeardays2calendar + uid: calendar.Calendar.yeardays2calendar +- fullName: calendar.Calendar.yeardayscalendar + href: https://docs.python.org/3/library/calendar.html#calendar.Calendar.yeardayscalendar + name: yeardayscalendar + uid: calendar.Calendar.yeardayscalendar +- fullName: calendar.HTMLCalendar.formatmonth + href: https://docs.python.org/3/library/calendar.html#calendar.HTMLCalendar.formatmonth + name: formatmonth + uid: calendar.HTMLCalendar.formatmonth +- fullName: calendar.HTMLCalendar.formatmonthname + href: https://docs.python.org/3/library/calendar.html#calendar.HTMLCalendar.formatmonthname + name: formatmonthname + uid: calendar.HTMLCalendar.formatmonthname +- fullName: calendar.HTMLCalendar.formatyear + href: https://docs.python.org/3/library/calendar.html#calendar.HTMLCalendar.formatyear + name: formatyear + uid: calendar.HTMLCalendar.formatyear +- fullName: calendar.HTMLCalendar.formatyearpage + href: https://docs.python.org/3/library/calendar.html#calendar.HTMLCalendar.formatyearpage + name: formatyearpage + uid: calendar.HTMLCalendar.formatyearpage +- fullName: calendar.TextCalendar.formatday + href: https://docs.python.org/3/library/calendar.html#calendar.TextCalendar.formatday + name: formatday + uid: calendar.TextCalendar.formatday +- fullName: calendar.TextCalendar.formatmonth + href: https://docs.python.org/3/library/calendar.html#calendar.TextCalendar.formatmonth + name: formatmonth + uid: calendar.TextCalendar.formatmonth +- fullName: calendar.TextCalendar.formatmonthname + href: https://docs.python.org/3/library/calendar.html#calendar.TextCalendar.formatmonthname + name: formatmonthname + uid: calendar.TextCalendar.formatmonthname +- fullName: calendar.TextCalendar.formatweek + href: https://docs.python.org/3/library/calendar.html#calendar.TextCalendar.formatweek + name: formatweek + uid: calendar.TextCalendar.formatweek +- fullName: calendar.TextCalendar.formatweekday + href: https://docs.python.org/3/library/calendar.html#calendar.TextCalendar.formatweekday + name: formatweekday + uid: calendar.TextCalendar.formatweekday +- fullName: calendar.TextCalendar.formatweekheader + href: https://docs.python.org/3/library/calendar.html#calendar.TextCalendar.formatweekheader + name: formatweekheader + uid: calendar.TextCalendar.formatweekheader +- fullName: calendar.TextCalendar.formatyear + href: https://docs.python.org/3/library/calendar.html#calendar.TextCalendar.formatyear + name: formatyear + uid: calendar.TextCalendar.formatyear +- fullName: calendar.TextCalendar.prmonth + href: https://docs.python.org/3/library/calendar.html#calendar.TextCalendar.prmonth + name: prmonth + uid: calendar.TextCalendar.prmonth +- fullName: calendar.TextCalendar.pryear + href: https://docs.python.org/3/library/calendar.html#calendar.TextCalendar.pryear + name: pryear + uid: calendar.TextCalendar.pryear +- fullName: cmd.Cmd.cmdloop + href: https://docs.python.org/3/library/cmd.html#cmd.Cmd.cmdloop + name: cmdloop + uid: cmd.Cmd.cmdloop +- fullName: cmd.Cmd.columnize + href: https://docs.python.org/3/library/cmd.html#cmd.Cmd.columnize + name: columnize + uid: cmd.Cmd.columnize +- fullName: cmd.Cmd.completedefault + href: https://docs.python.org/3/library/cmd.html#cmd.Cmd.completedefault + name: completedefault + uid: cmd.Cmd.completedefault +- fullName: cmd.Cmd.default + href: https://docs.python.org/3/library/cmd.html#cmd.Cmd.default + name: default + uid: cmd.Cmd.default +- fullName: cmd.Cmd.do_help + href: https://docs.python.org/3/library/cmd.html#cmd.Cmd.do_help + name: do_help + uid: cmd.Cmd.do_help +- fullName: cmd.Cmd.emptyline + href: https://docs.python.org/3/library/cmd.html#cmd.Cmd.emptyline + name: emptyline + uid: cmd.Cmd.emptyline +- fullName: cmd.Cmd.onecmd + href: https://docs.python.org/3/library/cmd.html#cmd.Cmd.onecmd + name: onecmd + uid: cmd.Cmd.onecmd +- fullName: cmd.Cmd.postcmd + href: https://docs.python.org/3/library/cmd.html#cmd.Cmd.postcmd + name: postcmd + uid: cmd.Cmd.postcmd +- fullName: cmd.Cmd.postloop + href: https://docs.python.org/3/library/cmd.html#cmd.Cmd.postloop + name: postloop + uid: cmd.Cmd.postloop +- fullName: cmd.Cmd.precmd + href: https://docs.python.org/3/library/cmd.html#cmd.Cmd.precmd + name: precmd + uid: cmd.Cmd.precmd +- fullName: cmd.Cmd.preloop + href: https://docs.python.org/3/library/cmd.html#cmd.Cmd.preloop + name: preloop + uid: cmd.Cmd.preloop +- fullName: code.InteractiveConsole.interact + href: https://docs.python.org/3/library/code.html#code.InteractiveConsole.interact + name: interact + uid: code.InteractiveConsole.interact +- fullName: code.InteractiveConsole.push + href: https://docs.python.org/3/library/code.html#code.InteractiveConsole.push + name: push + uid: code.InteractiveConsole.push +- fullName: code.InteractiveConsole.raw_input + href: https://docs.python.org/3/library/code.html#code.InteractiveConsole.raw_input + name: raw_input + uid: code.InteractiveConsole.raw_input +- fullName: code.InteractiveConsole.resetbuffer + href: https://docs.python.org/3/library/code.html#code.InteractiveConsole.resetbuffer + name: resetbuffer + uid: code.InteractiveConsole.resetbuffer +- fullName: code.InteractiveInterpreter.runcode + href: https://docs.python.org/3/library/code.html#code.InteractiveInterpreter.runcode + name: runcode + uid: code.InteractiveInterpreter.runcode +- fullName: code.InteractiveInterpreter.runsource + href: https://docs.python.org/3/library/code.html#code.InteractiveInterpreter.runsource + name: runsource + uid: code.InteractiveInterpreter.runsource +- fullName: code.InteractiveInterpreter.showsyntaxerror + href: https://docs.python.org/3/library/code.html#code.InteractiveInterpreter.showsyntaxerror + name: showsyntaxerror + uid: code.InteractiveInterpreter.showsyntaxerror +- fullName: code.InteractiveInterpreter.showtraceback + href: https://docs.python.org/3/library/code.html#code.InteractiveInterpreter.showtraceback + name: showtraceback + uid: code.InteractiveInterpreter.showtraceback +- fullName: code.InteractiveInterpreter.write + href: https://docs.python.org/3/library/code.html#code.InteractiveInterpreter.write + name: write + uid: code.InteractiveInterpreter.write +- fullName: codecs.Codec.decode + href: https://docs.python.org/3/library/codecs.html#codecs.Codec.decode + name: decode + uid: codecs.Codec.decode +- fullName: codecs.Codec.encode + href: https://docs.python.org/3/library/codecs.html#codecs.Codec.encode + name: encode + uid: codecs.Codec.encode +- fullName: codecs.IncrementalDecoder.decode + href: https://docs.python.org/3/library/codecs.html#codecs.IncrementalDecoder.decode + name: decode + uid: codecs.IncrementalDecoder.decode +- fullName: codecs.IncrementalDecoder.getstate + href: https://docs.python.org/3/library/codecs.html#codecs.IncrementalDecoder.getstate + name: getstate + uid: codecs.IncrementalDecoder.getstate +- fullName: codecs.IncrementalDecoder.reset + href: https://docs.python.org/3/library/codecs.html#codecs.IncrementalDecoder.reset + name: reset + uid: codecs.IncrementalDecoder.reset +- fullName: codecs.IncrementalDecoder.setstate + href: https://docs.python.org/3/library/codecs.html#codecs.IncrementalDecoder.setstate + name: setstate + uid: codecs.IncrementalDecoder.setstate +- fullName: codecs.IncrementalEncoder.encode + href: https://docs.python.org/3/library/codecs.html#codecs.IncrementalEncoder.encode + name: encode + uid: codecs.IncrementalEncoder.encode +- fullName: codecs.IncrementalEncoder.getstate + href: https://docs.python.org/3/library/codecs.html#codecs.IncrementalEncoder.getstate + name: getstate + uid: codecs.IncrementalEncoder.getstate +- fullName: codecs.IncrementalEncoder.reset + href: https://docs.python.org/3/library/codecs.html#codecs.IncrementalEncoder.reset + name: reset + uid: codecs.IncrementalEncoder.reset +- fullName: codecs.IncrementalEncoder.setstate + href: https://docs.python.org/3/library/codecs.html#codecs.IncrementalEncoder.setstate + name: setstate + uid: codecs.IncrementalEncoder.setstate +- fullName: codecs.StreamReader.read + href: https://docs.python.org/3/library/codecs.html#codecs.StreamReader.read + name: read + uid: codecs.StreamReader.read +- fullName: codecs.StreamReader.readline + href: https://docs.python.org/3/library/codecs.html#codecs.StreamReader.readline + name: readline + uid: codecs.StreamReader.readline +- fullName: codecs.StreamReader.readlines + href: https://docs.python.org/3/library/codecs.html#codecs.StreamReader.readlines + name: readlines + uid: codecs.StreamReader.readlines +- fullName: codecs.StreamReader.reset + href: https://docs.python.org/3/library/codecs.html#codecs.StreamReader.reset + name: reset + uid: codecs.StreamReader.reset +- fullName: codecs.StreamWriter.reset + href: https://docs.python.org/3/library/codecs.html#codecs.StreamWriter.reset + name: reset + uid: codecs.StreamWriter.reset +- fullName: codecs.StreamWriter.write + href: https://docs.python.org/3/library/codecs.html#codecs.StreamWriter.write + name: write + uid: codecs.StreamWriter.write +- fullName: codecs.StreamWriter.writelines + href: https://docs.python.org/3/library/codecs.html#codecs.StreamWriter.writelines + name: writelines + uid: codecs.StreamWriter.writelines +- fullName: codeobject.co_lines + href: https://docs.python.org/3/reference/datamodel.html#codeobject.co_lines + name: co_lines + uid: codeobject.co_lines +- fullName: codeobject.co_positions + href: https://docs.python.org/3/reference/datamodel.html#codeobject.co_positions + name: co_positions + uid: codeobject.co_positions +- fullName: codeobject.replace + href: https://docs.python.org/3/reference/datamodel.html#codeobject.replace + name: replace + uid: codeobject.replace +- fullName: collections.ChainMap.new_child + href: https://docs.python.org/3/library/collections.html#collections.ChainMap.new_child + name: new_child + uid: collections.ChainMap.new_child +- fullName: collections.Counter.elements + href: https://docs.python.org/3/library/collections.html#collections.Counter.elements + name: elements + uid: collections.Counter.elements +- fullName: collections.Counter.fromkeys + href: https://docs.python.org/3/library/collections.html#collections.Counter.fromkeys + name: fromkeys + uid: collections.Counter.fromkeys +- fullName: collections.Counter.most_common + href: https://docs.python.org/3/library/collections.html#collections.Counter.most_common + name: most_common + uid: collections.Counter.most_common +- fullName: collections.Counter.subtract + href: https://docs.python.org/3/library/collections.html#collections.Counter.subtract + name: subtract + uid: collections.Counter.subtract +- fullName: collections.Counter.total + href: https://docs.python.org/3/library/collections.html#collections.Counter.total + name: total + uid: collections.Counter.total +- fullName: collections.Counter.update + href: https://docs.python.org/3/library/collections.html#collections.Counter.update + name: update + uid: collections.Counter.update +- fullName: collections.OrderedDict.move_to_end + href: https://docs.python.org/3/library/collections.html#collections.OrderedDict.move_to_end + name: move_to_end + uid: collections.OrderedDict.move_to_end +- fullName: collections.OrderedDict.popitem + href: https://docs.python.org/3/library/collections.html#collections.OrderedDict.popitem + name: popitem + uid: collections.OrderedDict.popitem +- fullName: collections.defaultdict.__missing__ + href: https://docs.python.org/3/library/collections.html#collections.defaultdict.__missing__ + name: __missing__ + uid: collections.defaultdict.__missing__ +- fullName: collections.deque.append + href: https://docs.python.org/3/library/collections.html#collections.deque.append + name: append + uid: collections.deque.append +- fullName: collections.deque.appendleft + href: https://docs.python.org/3/library/collections.html#collections.deque.appendleft + name: appendleft + uid: collections.deque.appendleft +- fullName: collections.deque.clear + href: https://docs.python.org/3/library/collections.html#collections.deque.clear + name: clear + uid: collections.deque.clear +- fullName: collections.deque.copy + href: https://docs.python.org/3/library/collections.html#collections.deque.copy + name: copy + uid: collections.deque.copy +- fullName: collections.deque.count + href: https://docs.python.org/3/library/collections.html#collections.deque.count + name: count + uid: collections.deque.count +- fullName: collections.deque.extend + href: https://docs.python.org/3/library/collections.html#collections.deque.extend + name: extend + uid: collections.deque.extend +- fullName: collections.deque.extendleft + href: https://docs.python.org/3/library/collections.html#collections.deque.extendleft + name: extendleft + uid: collections.deque.extendleft +- fullName: collections.deque.index + href: https://docs.python.org/3/library/collections.html#collections.deque.index + name: index + uid: collections.deque.index +- fullName: collections.deque.insert + href: https://docs.python.org/3/library/collections.html#collections.deque.insert + name: insert + uid: collections.deque.insert +- fullName: collections.deque.pop + href: https://docs.python.org/3/library/collections.html#collections.deque.pop + name: pop + uid: collections.deque.pop +- fullName: collections.deque.popleft + href: https://docs.python.org/3/library/collections.html#collections.deque.popleft + name: popleft + uid: collections.deque.popleft +- fullName: collections.deque.remove + href: https://docs.python.org/3/library/collections.html#collections.deque.remove + name: remove + uid: collections.deque.remove +- fullName: collections.deque.reverse + href: https://docs.python.org/3/library/collections.html#collections.deque.reverse + name: reverse + uid: collections.deque.reverse +- fullName: collections.deque.rotate + href: https://docs.python.org/3/library/collections.html#collections.deque.rotate + name: rotate + uid: collections.deque.rotate +- fullName: collections.somenamedtuple._asdict + href: https://docs.python.org/3/library/collections.html#collections.somenamedtuple._asdict + name: _asdict + uid: collections.somenamedtuple._asdict +- fullName: collections.somenamedtuple._make + href: https://docs.python.org/3/library/collections.html#collections.somenamedtuple._make + name: _make + uid: collections.somenamedtuple._make +- fullName: collections.somenamedtuple._replace + href: https://docs.python.org/3/library/collections.html#collections.somenamedtuple._replace + name: _replace + uid: collections.somenamedtuple._replace +- fullName: concurrent.futures.Executor.map + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Executor.map + name: map + uid: concurrent.futures.Executor.map +- fullName: concurrent.futures.Executor.shutdown + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Executor.shutdown + name: shutdown + uid: concurrent.futures.Executor.shutdown +- fullName: concurrent.futures.Executor.submit + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Executor.submit + name: submit + uid: concurrent.futures.Executor.submit +- fullName: concurrent.futures.Future.add_done_callback + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future.add_done_callback + name: add_done_callback + uid: concurrent.futures.Future.add_done_callback +- fullName: concurrent.futures.Future.cancel + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future.cancel + name: cancel + uid: concurrent.futures.Future.cancel +- fullName: concurrent.futures.Future.cancelled + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future.cancelled + name: cancelled + uid: concurrent.futures.Future.cancelled +- fullName: concurrent.futures.Future.done + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future.done + name: done + uid: concurrent.futures.Future.done +- fullName: concurrent.futures.Future.exception + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future.exception + name: exception + uid: concurrent.futures.Future.exception +- fullName: concurrent.futures.Future.result + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future.result + name: result + uid: concurrent.futures.Future.result +- fullName: concurrent.futures.Future.running + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future.running + name: running + uid: concurrent.futures.Future.running +- fullName: concurrent.futures.Future.set_exception + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future.set_exception + name: set_exception + uid: concurrent.futures.Future.set_exception +- fullName: concurrent.futures.Future.set_result + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future.set_result + name: set_result + uid: concurrent.futures.Future.set_result +- fullName: concurrent.futures.Future.set_running_or_notify_cancel + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future.set_running_or_notify_cancel + name: set_running_or_notify_cancel + uid: concurrent.futures.Future.set_running_or_notify_cancel +- fullName: configparser.ConfigParser.add_section + href: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.add_section + name: add_section + uid: configparser.ConfigParser.add_section +- fullName: configparser.ConfigParser.defaults + href: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.defaults + name: defaults + uid: configparser.ConfigParser.defaults +- fullName: configparser.ConfigParser.get + href: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.get + name: get + uid: configparser.ConfigParser.get +- fullName: configparser.ConfigParser.getboolean + href: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.getboolean + name: getboolean + uid: configparser.ConfigParser.getboolean +- fullName: configparser.ConfigParser.getfloat + href: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.getfloat + name: getfloat + uid: configparser.ConfigParser.getfloat +- fullName: configparser.ConfigParser.getint + href: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.getint + name: getint + uid: configparser.ConfigParser.getint +- fullName: configparser.ConfigParser.has_option + href: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.has_option + name: has_option + uid: configparser.ConfigParser.has_option +- fullName: configparser.ConfigParser.has_section + href: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.has_section + name: has_section + uid: configparser.ConfigParser.has_section +- fullName: configparser.ConfigParser.items + href: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.items + name: items + uid: configparser.ConfigParser.items +- fullName: configparser.ConfigParser.options + href: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.options + name: options + uid: configparser.ConfigParser.options +- fullName: configparser.ConfigParser.optionxform + href: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.optionxform + name: optionxform + uid: configparser.ConfigParser.optionxform +- fullName: configparser.ConfigParser.read + href: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.read + name: read + uid: configparser.ConfigParser.read +- fullName: configparser.ConfigParser.read_dict + href: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.read_dict + name: read_dict + uid: configparser.ConfigParser.read_dict +- fullName: configparser.ConfigParser.read_file + href: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.read_file + name: read_file + uid: configparser.ConfigParser.read_file +- fullName: configparser.ConfigParser.read_string + href: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.read_string + name: read_string + uid: configparser.ConfigParser.read_string +- fullName: configparser.ConfigParser.remove_option + href: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.remove_option + name: remove_option + uid: configparser.ConfigParser.remove_option +- fullName: configparser.ConfigParser.remove_section + href: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.remove_section + name: remove_section + uid: configparser.ConfigParser.remove_section +- fullName: configparser.ConfigParser.sections + href: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.sections + name: sections + uid: configparser.ConfigParser.sections +- fullName: configparser.ConfigParser.set + href: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.set + name: set + uid: configparser.ConfigParser.set +- fullName: configparser.ConfigParser.write + href: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser.write + name: write + uid: configparser.ConfigParser.write +- fullName: configparser.RawConfigParser.add_section + href: https://docs.python.org/3/library/configparser.html#configparser.RawConfigParser.add_section + name: add_section + uid: configparser.RawConfigParser.add_section +- fullName: configparser.RawConfigParser.set + href: https://docs.python.org/3/library/configparser.html#configparser.RawConfigParser.set + name: set + uid: configparser.RawConfigParser.set +- fullName: container.__iter__ + href: https://docs.python.org/3/library/stdtypes.html#container.__iter__ + name: __iter__ + uid: container.__iter__ +- fullName: contextlib.AsyncExitStack.aclose + href: https://docs.python.org/3/library/contextlib.html#contextlib.AsyncExitStack.aclose + name: aclose + uid: contextlib.AsyncExitStack.aclose +- fullName: contextlib.AsyncExitStack.enter_async_context + href: https://docs.python.org/3/library/contextlib.html#contextlib.AsyncExitStack.enter_async_context + name: enter_async_context + uid: contextlib.AsyncExitStack.enter_async_context +- fullName: contextlib.AsyncExitStack.push_async_callback + href: https://docs.python.org/3/library/contextlib.html#contextlib.AsyncExitStack.push_async_callback + name: push_async_callback + uid: contextlib.AsyncExitStack.push_async_callback +- fullName: contextlib.AsyncExitStack.push_async_exit + href: https://docs.python.org/3/library/contextlib.html#contextlib.AsyncExitStack.push_async_exit + name: push_async_exit + uid: contextlib.AsyncExitStack.push_async_exit +- fullName: contextlib.ExitStack.callback + href: https://docs.python.org/3/library/contextlib.html#contextlib.ExitStack.callback + name: callback + uid: contextlib.ExitStack.callback +- fullName: contextlib.ExitStack.close + href: https://docs.python.org/3/library/contextlib.html#contextlib.ExitStack.close + name: close + uid: contextlib.ExitStack.close +- fullName: contextlib.ExitStack.enter_context + href: https://docs.python.org/3/library/contextlib.html#contextlib.ExitStack.enter_context + name: enter_context + uid: contextlib.ExitStack.enter_context +- fullName: contextlib.ExitStack.pop_all + href: https://docs.python.org/3/library/contextlib.html#contextlib.ExitStack.pop_all + name: pop_all + uid: contextlib.ExitStack.pop_all +- fullName: contextlib.ExitStack.push + href: https://docs.python.org/3/library/contextlib.html#contextlib.ExitStack.push + name: push + uid: contextlib.ExitStack.push +- fullName: contextmanager.__enter__ + href: https://docs.python.org/3/library/stdtypes.html#contextmanager.__enter__ + name: __enter__ + uid: contextmanager.__enter__ +- fullName: contextmanager.__exit__ + href: https://docs.python.org/3/library/stdtypes.html#contextmanager.__exit__ + name: __exit__ + uid: contextmanager.__exit__ +- fullName: contextvars.Context.copy + href: https://docs.python.org/3/library/contextvars.html#contextvars.Context.copy + name: copy + uid: contextvars.Context.copy +- fullName: contextvars.Context.get + href: https://docs.python.org/3/library/contextvars.html#contextvars.Context.get + name: get + uid: contextvars.Context.get +- fullName: contextvars.Context.items + href: https://docs.python.org/3/library/contextvars.html#contextvars.Context.items + name: items + uid: contextvars.Context.items +- fullName: contextvars.Context.keys + href: https://docs.python.org/3/library/contextvars.html#contextvars.Context.keys + name: keys + uid: contextvars.Context.keys +- fullName: contextvars.Context.run + href: https://docs.python.org/3/library/contextvars.html#contextvars.Context.run + name: run + uid: contextvars.Context.run +- fullName: contextvars.Context.values + href: https://docs.python.org/3/library/contextvars.html#contextvars.Context.values + name: values + uid: contextvars.Context.values +- fullName: contextvars.ContextVar.get + href: https://docs.python.org/3/library/contextvars.html#contextvars.ContextVar.get + name: get + uid: contextvars.ContextVar.get +- fullName: contextvars.ContextVar.reset + href: https://docs.python.org/3/library/contextvars.html#contextvars.ContextVar.reset + name: reset + uid: contextvars.ContextVar.reset +- fullName: contextvars.ContextVar.set + href: https://docs.python.org/3/library/contextvars.html#contextvars.ContextVar.set + name: set + uid: contextvars.ContextVar.set +- fullName: coroutine.close + href: https://docs.python.org/3/reference/datamodel.html#coroutine.close + name: close + uid: coroutine.close +- fullName: coroutine.send + href: https://docs.python.org/3/reference/datamodel.html#coroutine.send + name: send + uid: coroutine.send +- fullName: coroutine.throw + href: https://docs.python.org/3/reference/datamodel.html#coroutine.throw + name: throw + uid: coroutine.throw +- fullName: csv.DictWriter.writeheader + href: https://docs.python.org/3/library/csv.html#csv.DictWriter.writeheader + name: writeheader + uid: csv.DictWriter.writeheader +- fullName: csv.Sniffer.has_header + href: https://docs.python.org/3/library/csv.html#csv.Sniffer.has_header + name: has_header + uid: csv.Sniffer.has_header +- fullName: csv.Sniffer.sniff + href: https://docs.python.org/3/library/csv.html#csv.Sniffer.sniff + name: sniff + uid: csv.Sniffer.sniff +- fullName: csv.csvreader.__next__ + href: https://docs.python.org/3/library/csv.html#csv.csvreader.__next__ + name: __next__ + uid: csv.csvreader.__next__ +- fullName: csv.csvwriter.writerow + href: https://docs.python.org/3/library/csv.html#csv.csvwriter.writerow + name: writerow + uid: csv.csvwriter.writerow +- fullName: csv.csvwriter.writerows + href: https://docs.python.org/3/library/csv.html#csv.csvwriter.writerows + name: writerows + uid: csv.csvwriter.writerows +- fullName: ctypes.LibraryLoader.LoadLibrary + href: https://docs.python.org/3/library/ctypes.html#ctypes.LibraryLoader.LoadLibrary + name: LoadLibrary + uid: ctypes.LibraryLoader.LoadLibrary +- fullName: ctypes._CData.from_address + href: https://docs.python.org/3/library/ctypes.html#ctypes._CData.from_address + name: from_address + uid: ctypes._CData.from_address +- fullName: ctypes._CData.from_buffer + href: https://docs.python.org/3/library/ctypes.html#ctypes._CData.from_buffer + name: from_buffer + uid: ctypes._CData.from_buffer +- fullName: ctypes._CData.from_buffer_copy + href: https://docs.python.org/3/library/ctypes.html#ctypes._CData.from_buffer_copy + name: from_buffer_copy + uid: ctypes._CData.from_buffer_copy +- fullName: ctypes._CData.from_param + href: https://docs.python.org/3/library/ctypes.html#ctypes._CData.from_param + name: from_param + uid: ctypes._CData.from_param +- fullName: ctypes._CData.in_dll + href: https://docs.python.org/3/library/ctypes.html#ctypes._CData.in_dll + name: in_dll + uid: ctypes._CData.in_dll +- fullName: curses.panel.Panel.above + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.above + name: above + uid: curses.panel.Panel.above +- fullName: curses.panel.Panel.below + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.below + name: below + uid: curses.panel.Panel.below +- fullName: curses.panel.Panel.bottom + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.bottom + name: bottom + uid: curses.panel.Panel.bottom +- fullName: curses.panel.Panel.hidden + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.hidden + name: hidden + uid: curses.panel.Panel.hidden +- fullName: curses.panel.Panel.hide + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.hide + name: hide + uid: curses.panel.Panel.hide +- fullName: curses.panel.Panel.move + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.move + name: move + uid: curses.panel.Panel.move +- fullName: curses.panel.Panel.replace + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.replace + name: replace + uid: curses.panel.Panel.replace +- fullName: curses.panel.Panel.set_userptr + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.set_userptr + name: set_userptr + uid: curses.panel.Panel.set_userptr +- fullName: curses.panel.Panel.show + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.show + name: show + uid: curses.panel.Panel.show +- fullName: curses.panel.Panel.top + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.top + name: top + uid: curses.panel.Panel.top +- fullName: curses.panel.Panel.userptr + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.userptr + name: userptr + uid: curses.panel.Panel.userptr +- fullName: curses.panel.Panel.window + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.Panel.window + name: window + uid: curses.panel.Panel.window +- fullName: curses.textpad.Textbox.do_command + href: https://docs.python.org/3/library/curses.html#curses.textpad.Textbox.do_command + name: do_command + uid: curses.textpad.Textbox.do_command +- fullName: curses.textpad.Textbox.edit + href: https://docs.python.org/3/library/curses.html#curses.textpad.Textbox.edit + name: edit + uid: curses.textpad.Textbox.edit +- fullName: curses.textpad.Textbox.gather + href: https://docs.python.org/3/library/curses.html#curses.textpad.Textbox.gather + name: gather + uid: curses.textpad.Textbox.gather +- fullName: curses.window.addch + href: https://docs.python.org/3/library/curses.html#curses.window.addch + name: addch + uid: curses.window.addch +- fullName: curses.window.addnstr + href: https://docs.python.org/3/library/curses.html#curses.window.addnstr + name: addnstr + uid: curses.window.addnstr +- fullName: curses.window.addstr + href: https://docs.python.org/3/library/curses.html#curses.window.addstr + name: addstr + uid: curses.window.addstr +- fullName: curses.window.attroff + href: https://docs.python.org/3/library/curses.html#curses.window.attroff + name: attroff + uid: curses.window.attroff +- fullName: curses.window.attron + href: https://docs.python.org/3/library/curses.html#curses.window.attron + name: attron + uid: curses.window.attron +- fullName: curses.window.attrset + href: https://docs.python.org/3/library/curses.html#curses.window.attrset + name: attrset + uid: curses.window.attrset +- fullName: curses.window.bkgd + href: https://docs.python.org/3/library/curses.html#curses.window.bkgd + name: bkgd + uid: curses.window.bkgd +- fullName: curses.window.bkgdset + href: https://docs.python.org/3/library/curses.html#curses.window.bkgdset + name: bkgdset + uid: curses.window.bkgdset +- fullName: curses.window.border + href: https://docs.python.org/3/library/curses.html#curses.window.border + name: border + uid: curses.window.border +- fullName: curses.window.box + href: https://docs.python.org/3/library/curses.html#curses.window.box + name: box + uid: curses.window.box +- fullName: curses.window.chgat + href: https://docs.python.org/3/library/curses.html#curses.window.chgat + name: chgat + uid: curses.window.chgat +- fullName: curses.window.clear + href: https://docs.python.org/3/library/curses.html#curses.window.clear + name: clear + uid: curses.window.clear +- fullName: curses.window.clearok + href: https://docs.python.org/3/library/curses.html#curses.window.clearok + name: clearok + uid: curses.window.clearok +- fullName: curses.window.clrtobot + href: https://docs.python.org/3/library/curses.html#curses.window.clrtobot + name: clrtobot + uid: curses.window.clrtobot +- fullName: curses.window.clrtoeol + href: https://docs.python.org/3/library/curses.html#curses.window.clrtoeol + name: clrtoeol + uid: curses.window.clrtoeol +- fullName: curses.window.cursyncup + href: https://docs.python.org/3/library/curses.html#curses.window.cursyncup + name: cursyncup + uid: curses.window.cursyncup +- fullName: curses.window.delch + href: https://docs.python.org/3/library/curses.html#curses.window.delch + name: delch + uid: curses.window.delch +- fullName: curses.window.deleteln + href: https://docs.python.org/3/library/curses.html#curses.window.deleteln + name: deleteln + uid: curses.window.deleteln +- fullName: curses.window.derwin + href: https://docs.python.org/3/library/curses.html#curses.window.derwin + name: derwin + uid: curses.window.derwin +- fullName: curses.window.echochar + href: https://docs.python.org/3/library/curses.html#curses.window.echochar + name: echochar + uid: curses.window.echochar +- fullName: curses.window.enclose + href: https://docs.python.org/3/library/curses.html#curses.window.enclose + name: enclose + uid: curses.window.enclose +- fullName: curses.window.erase + href: https://docs.python.org/3/library/curses.html#curses.window.erase + name: erase + uid: curses.window.erase +- fullName: curses.window.get_wch + href: https://docs.python.org/3/library/curses.html#curses.window.get_wch + name: get_wch + uid: curses.window.get_wch +- fullName: curses.window.getbegyx + href: https://docs.python.org/3/library/curses.html#curses.window.getbegyx + name: getbegyx + uid: curses.window.getbegyx +- fullName: curses.window.getbkgd + href: https://docs.python.org/3/library/curses.html#curses.window.getbkgd + name: getbkgd + uid: curses.window.getbkgd +- fullName: curses.window.getch + href: https://docs.python.org/3/library/curses.html#curses.window.getch + name: getch + uid: curses.window.getch +- fullName: curses.window.getkey + href: https://docs.python.org/3/library/curses.html#curses.window.getkey + name: getkey + uid: curses.window.getkey +- fullName: curses.window.getmaxyx + href: https://docs.python.org/3/library/curses.html#curses.window.getmaxyx + name: getmaxyx + uid: curses.window.getmaxyx +- fullName: curses.window.getparyx + href: https://docs.python.org/3/library/curses.html#curses.window.getparyx + name: getparyx + uid: curses.window.getparyx +- fullName: curses.window.getstr + href: https://docs.python.org/3/library/curses.html#curses.window.getstr + name: getstr + uid: curses.window.getstr +- fullName: curses.window.getyx + href: https://docs.python.org/3/library/curses.html#curses.window.getyx + name: getyx + uid: curses.window.getyx +- fullName: curses.window.hline + href: https://docs.python.org/3/library/curses.html#curses.window.hline + name: hline + uid: curses.window.hline +- fullName: curses.window.idcok + href: https://docs.python.org/3/library/curses.html#curses.window.idcok + name: idcok + uid: curses.window.idcok +- fullName: curses.window.idlok + href: https://docs.python.org/3/library/curses.html#curses.window.idlok + name: idlok + uid: curses.window.idlok +- fullName: curses.window.immedok + href: https://docs.python.org/3/library/curses.html#curses.window.immedok + name: immedok + uid: curses.window.immedok +- fullName: curses.window.inch + href: https://docs.python.org/3/library/curses.html#curses.window.inch + name: inch + uid: curses.window.inch +- fullName: curses.window.insch + href: https://docs.python.org/3/library/curses.html#curses.window.insch + name: insch + uid: curses.window.insch +- fullName: curses.window.insdelln + href: https://docs.python.org/3/library/curses.html#curses.window.insdelln + name: insdelln + uid: curses.window.insdelln +- fullName: curses.window.insertln + href: https://docs.python.org/3/library/curses.html#curses.window.insertln + name: insertln + uid: curses.window.insertln +- fullName: curses.window.insnstr + href: https://docs.python.org/3/library/curses.html#curses.window.insnstr + name: insnstr + uid: curses.window.insnstr +- fullName: curses.window.insstr + href: https://docs.python.org/3/library/curses.html#curses.window.insstr + name: insstr + uid: curses.window.insstr +- fullName: curses.window.instr + href: https://docs.python.org/3/library/curses.html#curses.window.instr + name: instr + uid: curses.window.instr +- fullName: curses.window.is_linetouched + href: https://docs.python.org/3/library/curses.html#curses.window.is_linetouched + name: is_linetouched + uid: curses.window.is_linetouched +- fullName: curses.window.is_wintouched + href: https://docs.python.org/3/library/curses.html#curses.window.is_wintouched + name: is_wintouched + uid: curses.window.is_wintouched +- fullName: curses.window.keypad + href: https://docs.python.org/3/library/curses.html#curses.window.keypad + name: keypad + uid: curses.window.keypad +- fullName: curses.window.leaveok + href: https://docs.python.org/3/library/curses.html#curses.window.leaveok + name: leaveok + uid: curses.window.leaveok +- fullName: curses.window.move + href: https://docs.python.org/3/library/curses.html#curses.window.move + name: move + uid: curses.window.move +- fullName: curses.window.mvderwin + href: https://docs.python.org/3/library/curses.html#curses.window.mvderwin + name: mvderwin + uid: curses.window.mvderwin +- fullName: curses.window.mvwin + href: https://docs.python.org/3/library/curses.html#curses.window.mvwin + name: mvwin + uid: curses.window.mvwin +- fullName: curses.window.nodelay + href: https://docs.python.org/3/library/curses.html#curses.window.nodelay + name: nodelay + uid: curses.window.nodelay +- fullName: curses.window.notimeout + href: https://docs.python.org/3/library/curses.html#curses.window.notimeout + name: notimeout + uid: curses.window.notimeout +- fullName: curses.window.noutrefresh + href: https://docs.python.org/3/library/curses.html#curses.window.noutrefresh + name: noutrefresh + uid: curses.window.noutrefresh +- fullName: curses.window.overlay + href: https://docs.python.org/3/library/curses.html#curses.window.overlay + name: overlay + uid: curses.window.overlay +- fullName: curses.window.overwrite + href: https://docs.python.org/3/library/curses.html#curses.window.overwrite + name: overwrite + uid: curses.window.overwrite +- fullName: curses.window.putwin + href: https://docs.python.org/3/library/curses.html#curses.window.putwin + name: putwin + uid: curses.window.putwin +- fullName: curses.window.redrawln + href: https://docs.python.org/3/library/curses.html#curses.window.redrawln + name: redrawln + uid: curses.window.redrawln +- fullName: curses.window.redrawwin + href: https://docs.python.org/3/library/curses.html#curses.window.redrawwin + name: redrawwin + uid: curses.window.redrawwin +- fullName: curses.window.refresh + href: https://docs.python.org/3/library/curses.html#curses.window.refresh + name: refresh + uid: curses.window.refresh +- fullName: curses.window.resize + href: https://docs.python.org/3/library/curses.html#curses.window.resize + name: resize + uid: curses.window.resize +- fullName: curses.window.scroll + href: https://docs.python.org/3/library/curses.html#curses.window.scroll + name: scroll + uid: curses.window.scroll +- fullName: curses.window.scrollok + href: https://docs.python.org/3/library/curses.html#curses.window.scrollok + name: scrollok + uid: curses.window.scrollok +- fullName: curses.window.setscrreg + href: https://docs.python.org/3/library/curses.html#curses.window.setscrreg + name: setscrreg + uid: curses.window.setscrreg +- fullName: curses.window.standend + href: https://docs.python.org/3/library/curses.html#curses.window.standend + name: standend + uid: curses.window.standend +- fullName: curses.window.standout + href: https://docs.python.org/3/library/curses.html#curses.window.standout + name: standout + uid: curses.window.standout +- fullName: curses.window.subpad + href: https://docs.python.org/3/library/curses.html#curses.window.subpad + name: subpad + uid: curses.window.subpad +- fullName: curses.window.subwin + href: https://docs.python.org/3/library/curses.html#curses.window.subwin + name: subwin + uid: curses.window.subwin +- fullName: curses.window.syncdown + href: https://docs.python.org/3/library/curses.html#curses.window.syncdown + name: syncdown + uid: curses.window.syncdown +- fullName: curses.window.syncok + href: https://docs.python.org/3/library/curses.html#curses.window.syncok + name: syncok + uid: curses.window.syncok +- fullName: curses.window.syncup + href: https://docs.python.org/3/library/curses.html#curses.window.syncup + name: syncup + uid: curses.window.syncup +- fullName: curses.window.timeout + href: https://docs.python.org/3/library/curses.html#curses.window.timeout + name: timeout + uid: curses.window.timeout +- fullName: curses.window.touchline + href: https://docs.python.org/3/library/curses.html#curses.window.touchline + name: touchline + uid: curses.window.touchline +- fullName: curses.window.touchwin + href: https://docs.python.org/3/library/curses.html#curses.window.touchwin + name: touchwin + uid: curses.window.touchwin +- fullName: curses.window.untouchwin + href: https://docs.python.org/3/library/curses.html#curses.window.untouchwin + name: untouchwin + uid: curses.window.untouchwin +- fullName: curses.window.vline + href: https://docs.python.org/3/library/curses.html#curses.window.vline + name: vline + uid: curses.window.vline +- fullName: datetime.date.__format__ + href: https://docs.python.org/3/library/datetime.html#datetime.date.__format__ + name: __format__ + uid: datetime.date.__format__ +- fullName: datetime.date.__str__ + href: https://docs.python.org/3/library/datetime.html#datetime.date.__str__ + name: __str__ + uid: datetime.date.__str__ +- fullName: datetime.date.ctime + href: https://docs.python.org/3/library/datetime.html#datetime.date.ctime + name: ctime + uid: datetime.date.ctime +- fullName: datetime.date.fromisocalendar + href: https://docs.python.org/3/library/datetime.html#datetime.date.fromisocalendar + name: fromisocalendar + uid: datetime.date.fromisocalendar +- fullName: datetime.date.fromisoformat + href: https://docs.python.org/3/library/datetime.html#datetime.date.fromisoformat + name: fromisoformat + uid: datetime.date.fromisoformat +- fullName: datetime.date.fromordinal + href: https://docs.python.org/3/library/datetime.html#datetime.date.fromordinal + name: fromordinal + uid: datetime.date.fromordinal +- fullName: datetime.date.fromtimestamp + href: https://docs.python.org/3/library/datetime.html#datetime.date.fromtimestamp + name: fromtimestamp + uid: datetime.date.fromtimestamp +- fullName: datetime.date.isocalendar + href: https://docs.python.org/3/library/datetime.html#datetime.date.isocalendar + name: isocalendar + uid: datetime.date.isocalendar +- fullName: datetime.date.isoformat + href: https://docs.python.org/3/library/datetime.html#datetime.date.isoformat + name: isoformat + uid: datetime.date.isoformat +- fullName: datetime.date.isoweekday + href: https://docs.python.org/3/library/datetime.html#datetime.date.isoweekday + name: isoweekday + uid: datetime.date.isoweekday +- fullName: datetime.date.replace + href: https://docs.python.org/3/library/datetime.html#datetime.date.replace + name: replace + uid: datetime.date.replace +- fullName: datetime.date.strftime + href: https://docs.python.org/3/library/datetime.html#datetime.date.strftime + name: strftime + uid: datetime.date.strftime +- fullName: datetime.date.timetuple + href: https://docs.python.org/3/library/datetime.html#datetime.date.timetuple + name: timetuple + uid: datetime.date.timetuple +- fullName: datetime.date.today + href: https://docs.python.org/3/library/datetime.html#datetime.date.today + name: today + uid: datetime.date.today +- fullName: datetime.date.toordinal + href: https://docs.python.org/3/library/datetime.html#datetime.date.toordinal + name: toordinal + uid: datetime.date.toordinal +- fullName: datetime.date.weekday + href: https://docs.python.org/3/library/datetime.html#datetime.date.weekday + name: weekday + uid: datetime.date.weekday +- fullName: datetime.datetime.__format__ + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.__format__ + name: __format__ + uid: datetime.datetime.__format__ +- fullName: datetime.datetime.__str__ + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.__str__ + name: __str__ + uid: datetime.datetime.__str__ +- fullName: datetime.datetime.astimezone + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.astimezone + name: astimezone + uid: datetime.datetime.astimezone +- fullName: datetime.datetime.combine + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.combine + name: combine + uid: datetime.datetime.combine +- fullName: datetime.datetime.ctime + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.ctime + name: ctime + uid: datetime.datetime.ctime +- fullName: datetime.datetime.date + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.date + name: date + uid: datetime.datetime.date +- fullName: datetime.datetime.dst + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.dst + name: dst + uid: datetime.datetime.dst +- fullName: datetime.datetime.fromisocalendar + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.fromisocalendar + name: fromisocalendar + uid: datetime.datetime.fromisocalendar +- fullName: datetime.datetime.fromisoformat + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.fromisoformat + name: fromisoformat + uid: datetime.datetime.fromisoformat +- fullName: datetime.datetime.fromordinal + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.fromordinal + name: fromordinal + uid: datetime.datetime.fromordinal +- fullName: datetime.datetime.fromtimestamp + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.fromtimestamp + name: fromtimestamp + uid: datetime.datetime.fromtimestamp +- fullName: datetime.datetime.isocalendar + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.isocalendar + name: isocalendar + uid: datetime.datetime.isocalendar +- fullName: datetime.datetime.isoformat + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.isoformat + name: isoformat + uid: datetime.datetime.isoformat +- fullName: datetime.datetime.isoweekday + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.isoweekday + name: isoweekday + uid: datetime.datetime.isoweekday +- fullName: datetime.datetime.now + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.now + name: now + uid: datetime.datetime.now +- fullName: datetime.datetime.replace + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.replace + name: replace + uid: datetime.datetime.replace +- fullName: datetime.datetime.strftime + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.strftime + name: strftime + uid: datetime.datetime.strftime +- fullName: datetime.datetime.strptime + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.strptime + name: strptime + uid: datetime.datetime.strptime +- fullName: datetime.datetime.time + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.time + name: time + uid: datetime.datetime.time +- fullName: datetime.datetime.timestamp + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.timestamp + name: timestamp + uid: datetime.datetime.timestamp +- fullName: datetime.datetime.timetuple + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.timetuple + name: timetuple + uid: datetime.datetime.timetuple +- fullName: datetime.datetime.timetz + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.timetz + name: timetz + uid: datetime.datetime.timetz +- fullName: datetime.datetime.today + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.today + name: today + uid: datetime.datetime.today +- fullName: datetime.datetime.toordinal + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.toordinal + name: toordinal + uid: datetime.datetime.toordinal +- fullName: datetime.datetime.tzname + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.tzname + name: tzname + uid: datetime.datetime.tzname +- fullName: datetime.datetime.utcfromtimestamp + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.utcfromtimestamp + name: utcfromtimestamp + uid: datetime.datetime.utcfromtimestamp +- fullName: datetime.datetime.utcnow + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.utcnow + name: utcnow + uid: datetime.datetime.utcnow +- fullName: datetime.datetime.utcoffset + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.utcoffset + name: utcoffset + uid: datetime.datetime.utcoffset +- fullName: datetime.datetime.utctimetuple + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.utctimetuple + name: utctimetuple + uid: datetime.datetime.utctimetuple +- fullName: datetime.datetime.weekday + href: https://docs.python.org/3/library/datetime.html#datetime.datetime.weekday + name: weekday + uid: datetime.datetime.weekday +- fullName: datetime.time.__format__ + href: https://docs.python.org/3/library/datetime.html#datetime.time.__format__ + name: __format__ + uid: datetime.time.__format__ +- fullName: datetime.time.__str__ + href: https://docs.python.org/3/library/datetime.html#datetime.time.__str__ + name: __str__ + uid: datetime.time.__str__ +- fullName: datetime.time.dst + href: https://docs.python.org/3/library/datetime.html#datetime.time.dst + name: dst + uid: datetime.time.dst +- fullName: datetime.time.fromisoformat + href: https://docs.python.org/3/library/datetime.html#datetime.time.fromisoformat + name: fromisoformat + uid: datetime.time.fromisoformat +- fullName: datetime.time.isoformat + href: https://docs.python.org/3/library/datetime.html#datetime.time.isoformat + name: isoformat + uid: datetime.time.isoformat +- fullName: datetime.time.replace + href: https://docs.python.org/3/library/datetime.html#datetime.time.replace + name: replace + uid: datetime.time.replace +- fullName: datetime.time.strftime + href: https://docs.python.org/3/library/datetime.html#datetime.time.strftime + name: strftime + uid: datetime.time.strftime +- fullName: datetime.time.tzname + href: https://docs.python.org/3/library/datetime.html#datetime.time.tzname + name: tzname + uid: datetime.time.tzname +- fullName: datetime.time.utcoffset + href: https://docs.python.org/3/library/datetime.html#datetime.time.utcoffset + name: utcoffset + uid: datetime.time.utcoffset +- fullName: datetime.timedelta.total_seconds + href: https://docs.python.org/3/library/datetime.html#datetime.timedelta.total_seconds + name: total_seconds + uid: datetime.timedelta.total_seconds +- fullName: datetime.timezone.dst + href: https://docs.python.org/3/library/datetime.html#datetime.timezone.dst + name: dst + uid: datetime.timezone.dst +- fullName: datetime.timezone.fromutc + href: https://docs.python.org/3/library/datetime.html#datetime.timezone.fromutc + name: fromutc + uid: datetime.timezone.fromutc +- fullName: datetime.timezone.tzname + href: https://docs.python.org/3/library/datetime.html#datetime.timezone.tzname + name: tzname + uid: datetime.timezone.tzname +- fullName: datetime.timezone.utcoffset + href: https://docs.python.org/3/library/datetime.html#datetime.timezone.utcoffset + name: utcoffset + uid: datetime.timezone.utcoffset +- fullName: datetime.tzinfo.dst + href: https://docs.python.org/3/library/datetime.html#datetime.tzinfo.dst + name: dst + uid: datetime.tzinfo.dst +- fullName: datetime.tzinfo.fromutc + href: https://docs.python.org/3/library/datetime.html#datetime.tzinfo.fromutc + name: fromutc + uid: datetime.tzinfo.fromutc +- fullName: datetime.tzinfo.tzname + href: https://docs.python.org/3/library/datetime.html#datetime.tzinfo.tzname + name: tzname + uid: datetime.tzinfo.tzname +- fullName: datetime.tzinfo.utcoffset + href: https://docs.python.org/3/library/datetime.html#datetime.tzinfo.utcoffset + name: utcoffset + uid: datetime.tzinfo.utcoffset +- fullName: dbm.dumb.dumbdbm.close + href: https://docs.python.org/3/library/dbm.html#dbm.dumb.dumbdbm.close + name: close + uid: dbm.dumb.dumbdbm.close +- fullName: dbm.dumb.dumbdbm.sync + href: https://docs.python.org/3/library/dbm.html#dbm.dumb.dumbdbm.sync + name: sync + uid: dbm.dumb.dumbdbm.sync +- fullName: dbm.gnu.gdbm.clear + href: https://docs.python.org/3/library/dbm.html#dbm.gnu.gdbm.clear + name: clear + uid: dbm.gnu.gdbm.clear +- fullName: dbm.gnu.gdbm.close + href: https://docs.python.org/3/library/dbm.html#dbm.gnu.gdbm.close + name: close + uid: dbm.gnu.gdbm.close +- fullName: dbm.gnu.gdbm.firstkey + href: https://docs.python.org/3/library/dbm.html#dbm.gnu.gdbm.firstkey + name: firstkey + uid: dbm.gnu.gdbm.firstkey +- fullName: dbm.gnu.gdbm.nextkey + href: https://docs.python.org/3/library/dbm.html#dbm.gnu.gdbm.nextkey + name: nextkey + uid: dbm.gnu.gdbm.nextkey +- fullName: dbm.gnu.gdbm.reorganize + href: https://docs.python.org/3/library/dbm.html#dbm.gnu.gdbm.reorganize + name: reorganize + uid: dbm.gnu.gdbm.reorganize +- fullName: dbm.gnu.gdbm.sync + href: https://docs.python.org/3/library/dbm.html#dbm.gnu.gdbm.sync + name: sync + uid: dbm.gnu.gdbm.sync +- fullName: dbm.ndbm.ndbm.clear + href: https://docs.python.org/3/library/dbm.html#dbm.ndbm.ndbm.clear + name: clear + uid: dbm.ndbm.ndbm.clear +- fullName: dbm.ndbm.ndbm.close + href: https://docs.python.org/3/library/dbm.html#dbm.ndbm.ndbm.close + name: close + uid: dbm.ndbm.ndbm.close +- fullName: decimal.Context.Etiny + href: https://docs.python.org/3/library/decimal.html#decimal.Context.Etiny + name: Etiny + uid: decimal.Context.Etiny +- fullName: decimal.Context.Etop + href: https://docs.python.org/3/library/decimal.html#decimal.Context.Etop + name: Etop + uid: decimal.Context.Etop +- fullName: decimal.Context.abs + href: https://docs.python.org/3/library/decimal.html#decimal.Context.abs + name: abs + uid: decimal.Context.abs +- fullName: decimal.Context.add + href: https://docs.python.org/3/library/decimal.html#decimal.Context.add + name: add + uid: decimal.Context.add +- fullName: decimal.Context.canonical + href: https://docs.python.org/3/library/decimal.html#decimal.Context.canonical + name: canonical + uid: decimal.Context.canonical +- fullName: decimal.Context.clear_flags + href: https://docs.python.org/3/library/decimal.html#decimal.Context.clear_flags + name: clear_flags + uid: decimal.Context.clear_flags +- fullName: decimal.Context.clear_traps + href: https://docs.python.org/3/library/decimal.html#decimal.Context.clear_traps + name: clear_traps + uid: decimal.Context.clear_traps +- fullName: decimal.Context.compare + href: https://docs.python.org/3/library/decimal.html#decimal.Context.compare + name: compare + uid: decimal.Context.compare +- fullName: decimal.Context.compare_signal + href: https://docs.python.org/3/library/decimal.html#decimal.Context.compare_signal + name: compare_signal + uid: decimal.Context.compare_signal +- fullName: decimal.Context.compare_total + href: https://docs.python.org/3/library/decimal.html#decimal.Context.compare_total + name: compare_total + uid: decimal.Context.compare_total +- fullName: decimal.Context.compare_total_mag + href: https://docs.python.org/3/library/decimal.html#decimal.Context.compare_total_mag + name: compare_total_mag + uid: decimal.Context.compare_total_mag +- fullName: decimal.Context.copy + href: https://docs.python.org/3/library/decimal.html#decimal.Context.copy + name: copy + uid: decimal.Context.copy +- fullName: decimal.Context.copy_abs + href: https://docs.python.org/3/library/decimal.html#decimal.Context.copy_abs + name: copy_abs + uid: decimal.Context.copy_abs +- fullName: decimal.Context.copy_decimal + href: https://docs.python.org/3/library/decimal.html#decimal.Context.copy_decimal + name: copy_decimal + uid: decimal.Context.copy_decimal +- fullName: decimal.Context.copy_negate + href: https://docs.python.org/3/library/decimal.html#decimal.Context.copy_negate + name: copy_negate + uid: decimal.Context.copy_negate +- fullName: decimal.Context.copy_sign + href: https://docs.python.org/3/library/decimal.html#decimal.Context.copy_sign + name: copy_sign + uid: decimal.Context.copy_sign +- fullName: decimal.Context.create_decimal + href: https://docs.python.org/3/library/decimal.html#decimal.Context.create_decimal + name: create_decimal + uid: decimal.Context.create_decimal +- fullName: decimal.Context.create_decimal_from_float + href: https://docs.python.org/3/library/decimal.html#decimal.Context.create_decimal_from_float + name: create_decimal_from_float + uid: decimal.Context.create_decimal_from_float +- fullName: decimal.Context.divide + href: https://docs.python.org/3/library/decimal.html#decimal.Context.divide + name: divide + uid: decimal.Context.divide +- fullName: decimal.Context.divide_int + href: https://docs.python.org/3/library/decimal.html#decimal.Context.divide_int + name: divide_int + uid: decimal.Context.divide_int +- fullName: decimal.Context.divmod + href: https://docs.python.org/3/library/decimal.html#decimal.Context.divmod + name: divmod + uid: decimal.Context.divmod +- fullName: decimal.Context.exp + href: https://docs.python.org/3/library/decimal.html#decimal.Context.exp + name: exp + uid: decimal.Context.exp +- fullName: decimal.Context.fma + href: https://docs.python.org/3/library/decimal.html#decimal.Context.fma + name: fma + uid: decimal.Context.fma +- fullName: decimal.Context.is_canonical + href: https://docs.python.org/3/library/decimal.html#decimal.Context.is_canonical + name: is_canonical + uid: decimal.Context.is_canonical +- fullName: decimal.Context.is_finite + href: https://docs.python.org/3/library/decimal.html#decimal.Context.is_finite + name: is_finite + uid: decimal.Context.is_finite +- fullName: decimal.Context.is_infinite + href: https://docs.python.org/3/library/decimal.html#decimal.Context.is_infinite + name: is_infinite + uid: decimal.Context.is_infinite +- fullName: decimal.Context.is_nan + href: https://docs.python.org/3/library/decimal.html#decimal.Context.is_nan + name: is_nan + uid: decimal.Context.is_nan +- fullName: decimal.Context.is_normal + href: https://docs.python.org/3/library/decimal.html#decimal.Context.is_normal + name: is_normal + uid: decimal.Context.is_normal +- fullName: decimal.Context.is_qnan + href: https://docs.python.org/3/library/decimal.html#decimal.Context.is_qnan + name: is_qnan + uid: decimal.Context.is_qnan +- fullName: decimal.Context.is_signed + href: https://docs.python.org/3/library/decimal.html#decimal.Context.is_signed + name: is_signed + uid: decimal.Context.is_signed +- fullName: decimal.Context.is_snan + href: https://docs.python.org/3/library/decimal.html#decimal.Context.is_snan + name: is_snan + uid: decimal.Context.is_snan +- fullName: decimal.Context.is_subnormal + href: https://docs.python.org/3/library/decimal.html#decimal.Context.is_subnormal + name: is_subnormal + uid: decimal.Context.is_subnormal +- fullName: decimal.Context.is_zero + href: https://docs.python.org/3/library/decimal.html#decimal.Context.is_zero + name: is_zero + uid: decimal.Context.is_zero +- fullName: decimal.Context.ln + href: https://docs.python.org/3/library/decimal.html#decimal.Context.ln + name: ln + uid: decimal.Context.ln +- fullName: decimal.Context.log10 + href: https://docs.python.org/3/library/decimal.html#decimal.Context.log10 + name: log10 + uid: decimal.Context.log10 +- fullName: decimal.Context.logb + href: https://docs.python.org/3/library/decimal.html#decimal.Context.logb + name: logb + uid: decimal.Context.logb +- fullName: decimal.Context.logical_and + href: https://docs.python.org/3/library/decimal.html#decimal.Context.logical_and + name: logical_and + uid: decimal.Context.logical_and +- fullName: decimal.Context.logical_invert + href: https://docs.python.org/3/library/decimal.html#decimal.Context.logical_invert + name: logical_invert + uid: decimal.Context.logical_invert +- fullName: decimal.Context.logical_or + href: https://docs.python.org/3/library/decimal.html#decimal.Context.logical_or + name: logical_or + uid: decimal.Context.logical_or +- fullName: decimal.Context.logical_xor + href: https://docs.python.org/3/library/decimal.html#decimal.Context.logical_xor + name: logical_xor + uid: decimal.Context.logical_xor +- fullName: decimal.Context.max + href: https://docs.python.org/3/library/decimal.html#decimal.Context.max + name: max + uid: decimal.Context.max +- fullName: decimal.Context.max_mag + href: https://docs.python.org/3/library/decimal.html#decimal.Context.max_mag + name: max_mag + uid: decimal.Context.max_mag +- fullName: decimal.Context.min + href: https://docs.python.org/3/library/decimal.html#decimal.Context.min + name: min + uid: decimal.Context.min +- fullName: decimal.Context.min_mag + href: https://docs.python.org/3/library/decimal.html#decimal.Context.min_mag + name: min_mag + uid: decimal.Context.min_mag +- fullName: decimal.Context.minus + href: https://docs.python.org/3/library/decimal.html#decimal.Context.minus + name: minus + uid: decimal.Context.minus +- fullName: decimal.Context.multiply + href: https://docs.python.org/3/library/decimal.html#decimal.Context.multiply + name: multiply + uid: decimal.Context.multiply +- fullName: decimal.Context.next_minus + href: https://docs.python.org/3/library/decimal.html#decimal.Context.next_minus + name: next_minus + uid: decimal.Context.next_minus +- fullName: decimal.Context.next_plus + href: https://docs.python.org/3/library/decimal.html#decimal.Context.next_plus + name: next_plus + uid: decimal.Context.next_plus +- fullName: decimal.Context.next_toward + href: https://docs.python.org/3/library/decimal.html#decimal.Context.next_toward + name: next_toward + uid: decimal.Context.next_toward +- fullName: decimal.Context.normalize + href: https://docs.python.org/3/library/decimal.html#decimal.Context.normalize + name: normalize + uid: decimal.Context.normalize +- fullName: decimal.Context.number_class + href: https://docs.python.org/3/library/decimal.html#decimal.Context.number_class + name: number_class + uid: decimal.Context.number_class +- fullName: decimal.Context.plus + href: https://docs.python.org/3/library/decimal.html#decimal.Context.plus + name: plus + uid: decimal.Context.plus +- fullName: decimal.Context.power + href: https://docs.python.org/3/library/decimal.html#decimal.Context.power + name: power + uid: decimal.Context.power +- fullName: decimal.Context.quantize + href: https://docs.python.org/3/library/decimal.html#decimal.Context.quantize + name: quantize + uid: decimal.Context.quantize +- fullName: decimal.Context.radix + href: https://docs.python.org/3/library/decimal.html#decimal.Context.radix + name: radix + uid: decimal.Context.radix +- fullName: decimal.Context.remainder + href: https://docs.python.org/3/library/decimal.html#decimal.Context.remainder + name: remainder + uid: decimal.Context.remainder +- fullName: decimal.Context.remainder_near + href: https://docs.python.org/3/library/decimal.html#decimal.Context.remainder_near + name: remainder_near + uid: decimal.Context.remainder_near +- fullName: decimal.Context.rotate + href: https://docs.python.org/3/library/decimal.html#decimal.Context.rotate + name: rotate + uid: decimal.Context.rotate +- fullName: decimal.Context.same_quantum + href: https://docs.python.org/3/library/decimal.html#decimal.Context.same_quantum + name: same_quantum + uid: decimal.Context.same_quantum +- fullName: decimal.Context.scaleb + href: https://docs.python.org/3/library/decimal.html#decimal.Context.scaleb + name: scaleb + uid: decimal.Context.scaleb +- fullName: decimal.Context.shift + href: https://docs.python.org/3/library/decimal.html#decimal.Context.shift + name: shift + uid: decimal.Context.shift +- fullName: decimal.Context.sqrt + href: https://docs.python.org/3/library/decimal.html#decimal.Context.sqrt + name: sqrt + uid: decimal.Context.sqrt +- fullName: decimal.Context.subtract + href: https://docs.python.org/3/library/decimal.html#decimal.Context.subtract + name: subtract + uid: decimal.Context.subtract +- fullName: decimal.Context.to_eng_string + href: https://docs.python.org/3/library/decimal.html#decimal.Context.to_eng_string + name: to_eng_string + uid: decimal.Context.to_eng_string +- fullName: decimal.Context.to_integral_exact + href: https://docs.python.org/3/library/decimal.html#decimal.Context.to_integral_exact + name: to_integral_exact + uid: decimal.Context.to_integral_exact +- fullName: decimal.Context.to_sci_string + href: https://docs.python.org/3/library/decimal.html#decimal.Context.to_sci_string + name: to_sci_string + uid: decimal.Context.to_sci_string +- fullName: decimal.Decimal.adjusted + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.adjusted + name: adjusted + uid: decimal.Decimal.adjusted +- fullName: decimal.Decimal.as_integer_ratio + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.as_integer_ratio + name: as_integer_ratio + uid: decimal.Decimal.as_integer_ratio +- fullName: decimal.Decimal.as_tuple + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.as_tuple + name: as_tuple + uid: decimal.Decimal.as_tuple +- fullName: decimal.Decimal.canonical + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.canonical + name: canonical + uid: decimal.Decimal.canonical +- fullName: decimal.Decimal.compare + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.compare + name: compare + uid: decimal.Decimal.compare +- fullName: decimal.Decimal.compare_signal + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.compare_signal + name: compare_signal + uid: decimal.Decimal.compare_signal +- fullName: decimal.Decimal.compare_total + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.compare_total + name: compare_total + uid: decimal.Decimal.compare_total +- fullName: decimal.Decimal.compare_total_mag + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.compare_total_mag + name: compare_total_mag + uid: decimal.Decimal.compare_total_mag +- fullName: decimal.Decimal.conjugate + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.conjugate + name: conjugate + uid: decimal.Decimal.conjugate +- fullName: decimal.Decimal.copy_abs + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.copy_abs + name: copy_abs + uid: decimal.Decimal.copy_abs +- fullName: decimal.Decimal.copy_negate + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.copy_negate + name: copy_negate + uid: decimal.Decimal.copy_negate +- fullName: decimal.Decimal.copy_sign + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.copy_sign + name: copy_sign + uid: decimal.Decimal.copy_sign +- fullName: decimal.Decimal.exp + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.exp + name: exp + uid: decimal.Decimal.exp +- fullName: decimal.Decimal.fma + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.fma + name: fma + uid: decimal.Decimal.fma +- fullName: decimal.Decimal.from_float + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.from_float + name: from_float + uid: decimal.Decimal.from_float +- fullName: decimal.Decimal.is_canonical + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.is_canonical + name: is_canonical + uid: decimal.Decimal.is_canonical +- fullName: decimal.Decimal.is_finite + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.is_finite + name: is_finite + uid: decimal.Decimal.is_finite +- fullName: decimal.Decimal.is_infinite + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.is_infinite + name: is_infinite + uid: decimal.Decimal.is_infinite +- fullName: decimal.Decimal.is_nan + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.is_nan + name: is_nan + uid: decimal.Decimal.is_nan +- fullName: decimal.Decimal.is_normal + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.is_normal + name: is_normal + uid: decimal.Decimal.is_normal +- fullName: decimal.Decimal.is_qnan + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.is_qnan + name: is_qnan + uid: decimal.Decimal.is_qnan +- fullName: decimal.Decimal.is_signed + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.is_signed + name: is_signed + uid: decimal.Decimal.is_signed +- fullName: decimal.Decimal.is_snan + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.is_snan + name: is_snan + uid: decimal.Decimal.is_snan +- fullName: decimal.Decimal.is_subnormal + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.is_subnormal + name: is_subnormal + uid: decimal.Decimal.is_subnormal +- fullName: decimal.Decimal.is_zero + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.is_zero + name: is_zero + uid: decimal.Decimal.is_zero +- fullName: decimal.Decimal.ln + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.ln + name: ln + uid: decimal.Decimal.ln +- fullName: decimal.Decimal.log10 + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.log10 + name: log10 + uid: decimal.Decimal.log10 +- fullName: decimal.Decimal.logb + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.logb + name: logb + uid: decimal.Decimal.logb +- fullName: decimal.Decimal.logical_and + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.logical_and + name: logical_and + uid: decimal.Decimal.logical_and +- fullName: decimal.Decimal.logical_invert + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.logical_invert + name: logical_invert + uid: decimal.Decimal.logical_invert +- fullName: decimal.Decimal.logical_or + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.logical_or + name: logical_or + uid: decimal.Decimal.logical_or +- fullName: decimal.Decimal.logical_xor + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.logical_xor + name: logical_xor + uid: decimal.Decimal.logical_xor +- fullName: decimal.Decimal.max + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.max + name: max + uid: decimal.Decimal.max +- fullName: decimal.Decimal.max_mag + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.max_mag + name: max_mag + uid: decimal.Decimal.max_mag +- fullName: decimal.Decimal.min + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.min + name: min + uid: decimal.Decimal.min +- fullName: decimal.Decimal.min_mag + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.min_mag + name: min_mag + uid: decimal.Decimal.min_mag +- fullName: decimal.Decimal.next_minus + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.next_minus + name: next_minus + uid: decimal.Decimal.next_minus +- fullName: decimal.Decimal.next_plus + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.next_plus + name: next_plus + uid: decimal.Decimal.next_plus +- fullName: decimal.Decimal.next_toward + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.next_toward + name: next_toward + uid: decimal.Decimal.next_toward +- fullName: decimal.Decimal.normalize + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.normalize + name: normalize + uid: decimal.Decimal.normalize +- fullName: decimal.Decimal.number_class + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.number_class + name: number_class + uid: decimal.Decimal.number_class +- fullName: decimal.Decimal.quantize + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.quantize + name: quantize + uid: decimal.Decimal.quantize +- fullName: decimal.Decimal.radix + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.radix + name: radix + uid: decimal.Decimal.radix +- fullName: decimal.Decimal.remainder_near + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.remainder_near + name: remainder_near + uid: decimal.Decimal.remainder_near +- fullName: decimal.Decimal.rotate + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.rotate + name: rotate + uid: decimal.Decimal.rotate +- fullName: decimal.Decimal.same_quantum + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.same_quantum + name: same_quantum + uid: decimal.Decimal.same_quantum +- fullName: decimal.Decimal.scaleb + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.scaleb + name: scaleb + uid: decimal.Decimal.scaleb +- fullName: decimal.Decimal.shift + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.shift + name: shift + uid: decimal.Decimal.shift +- fullName: decimal.Decimal.sqrt + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.sqrt + name: sqrt + uid: decimal.Decimal.sqrt +- fullName: decimal.Decimal.to_eng_string + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.to_eng_string + name: to_eng_string + uid: decimal.Decimal.to_eng_string +- fullName: decimal.Decimal.to_integral + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.to_integral + name: to_integral + uid: decimal.Decimal.to_integral +- fullName: decimal.Decimal.to_integral_exact + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.to_integral_exact + name: to_integral_exact + uid: decimal.Decimal.to_integral_exact +- fullName: decimal.Decimal.to_integral_value + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal.to_integral_value + name: to_integral_value + uid: decimal.Decimal.to_integral_value +- fullName: dict.clear + href: https://docs.python.org/3/library/stdtypes.html#dict.clear + name: clear + uid: dict.clear +- fullName: dict.copy + href: https://docs.python.org/3/library/stdtypes.html#dict.copy + name: copy + uid: dict.copy +- fullName: dict.fromkeys + href: https://docs.python.org/3/library/stdtypes.html#dict.fromkeys + name: fromkeys + uid: dict.fromkeys +- fullName: dict.get + href: https://docs.python.org/3/library/stdtypes.html#dict.get + name: get + uid: dict.get +- fullName: dict.items + href: https://docs.python.org/3/library/stdtypes.html#dict.items + name: items + uid: dict.items +- fullName: dict.keys + href: https://docs.python.org/3/library/stdtypes.html#dict.keys + name: keys + uid: dict.keys +- fullName: dict.pop + href: https://docs.python.org/3/library/stdtypes.html#dict.pop + name: pop + uid: dict.pop +- fullName: dict.popitem + href: https://docs.python.org/3/library/stdtypes.html#dict.popitem + name: popitem + uid: dict.popitem +- fullName: dict.setdefault + href: https://docs.python.org/3/library/stdtypes.html#dict.setdefault + name: setdefault + uid: dict.setdefault +- fullName: dict.update + href: https://docs.python.org/3/library/stdtypes.html#dict.update + name: update + uid: dict.update +- fullName: dict.values + href: https://docs.python.org/3/library/stdtypes.html#dict.values + name: values + uid: dict.values +- fullName: difflib.Differ.compare + href: https://docs.python.org/3/library/difflib.html#difflib.Differ.compare + name: compare + uid: difflib.Differ.compare +- fullName: difflib.HtmlDiff.__init__ + href: https://docs.python.org/3/library/difflib.html#difflib.HtmlDiff.__init__ + name: __init__ + uid: difflib.HtmlDiff.__init__ +- fullName: difflib.HtmlDiff.make_file + href: https://docs.python.org/3/library/difflib.html#difflib.HtmlDiff.make_file + name: make_file + uid: difflib.HtmlDiff.make_file +- fullName: difflib.HtmlDiff.make_table + href: https://docs.python.org/3/library/difflib.html#difflib.HtmlDiff.make_table + name: make_table + uid: difflib.HtmlDiff.make_table +- fullName: difflib.SequenceMatcher.find_longest_match + href: https://docs.python.org/3/library/difflib.html#difflib.SequenceMatcher.find_longest_match + name: find_longest_match + uid: difflib.SequenceMatcher.find_longest_match +- fullName: difflib.SequenceMatcher.get_grouped_opcodes + href: https://docs.python.org/3/library/difflib.html#difflib.SequenceMatcher.get_grouped_opcodes + name: get_grouped_opcodes + uid: difflib.SequenceMatcher.get_grouped_opcodes +- fullName: difflib.SequenceMatcher.get_matching_blocks + href: https://docs.python.org/3/library/difflib.html#difflib.SequenceMatcher.get_matching_blocks + name: get_matching_blocks + uid: difflib.SequenceMatcher.get_matching_blocks +- fullName: difflib.SequenceMatcher.get_opcodes + href: https://docs.python.org/3/library/difflib.html#difflib.SequenceMatcher.get_opcodes + name: get_opcodes + uid: difflib.SequenceMatcher.get_opcodes +- fullName: difflib.SequenceMatcher.quick_ratio + href: https://docs.python.org/3/library/difflib.html#difflib.SequenceMatcher.quick_ratio + name: quick_ratio + uid: difflib.SequenceMatcher.quick_ratio +- fullName: difflib.SequenceMatcher.ratio + href: https://docs.python.org/3/library/difflib.html#difflib.SequenceMatcher.ratio + name: ratio + uid: difflib.SequenceMatcher.ratio +- fullName: difflib.SequenceMatcher.real_quick_ratio + href: https://docs.python.org/3/library/difflib.html#difflib.SequenceMatcher.real_quick_ratio + name: real_quick_ratio + uid: difflib.SequenceMatcher.real_quick_ratio +- fullName: difflib.SequenceMatcher.set_seq1 + href: https://docs.python.org/3/library/difflib.html#difflib.SequenceMatcher.set_seq1 + name: set_seq1 + uid: difflib.SequenceMatcher.set_seq1 +- fullName: difflib.SequenceMatcher.set_seq2 + href: https://docs.python.org/3/library/difflib.html#difflib.SequenceMatcher.set_seq2 + name: set_seq2 + uid: difflib.SequenceMatcher.set_seq2 +- fullName: difflib.SequenceMatcher.set_seqs + href: https://docs.python.org/3/library/difflib.html#difflib.SequenceMatcher.set_seqs + name: set_seqs + uid: difflib.SequenceMatcher.set_seqs +- fullName: dis.Bytecode.dis + href: https://docs.python.org/3/library/dis.html#dis.Bytecode.dis + name: dis + uid: dis.Bytecode.dis +- fullName: dis.Bytecode.from_traceback + href: https://docs.python.org/3/library/dis.html#dis.Bytecode.from_traceback + name: from_traceback + uid: dis.Bytecode.from_traceback +- fullName: dis.Bytecode.info + href: https://docs.python.org/3/library/dis.html#dis.Bytecode.info + name: info + uid: dis.Bytecode.info +- fullName: doctest.DocTestFinder.find + href: https://docs.python.org/3/library/doctest.html#doctest.DocTestFinder.find + name: find + uid: doctest.DocTestFinder.find +- fullName: doctest.DocTestParser.get_doctest + href: https://docs.python.org/3/library/doctest.html#doctest.DocTestParser.get_doctest + name: get_doctest + uid: doctest.DocTestParser.get_doctest +- fullName: doctest.DocTestParser.get_examples + href: https://docs.python.org/3/library/doctest.html#doctest.DocTestParser.get_examples + name: get_examples + uid: doctest.DocTestParser.get_examples +- fullName: doctest.DocTestParser.parse + href: https://docs.python.org/3/library/doctest.html#doctest.DocTestParser.parse + name: parse + uid: doctest.DocTestParser.parse +- fullName: doctest.DocTestRunner.report_failure + href: https://docs.python.org/3/library/doctest.html#doctest.DocTestRunner.report_failure + name: report_failure + uid: doctest.DocTestRunner.report_failure +- fullName: doctest.DocTestRunner.report_start + href: https://docs.python.org/3/library/doctest.html#doctest.DocTestRunner.report_start + name: report_start + uid: doctest.DocTestRunner.report_start +- fullName: doctest.DocTestRunner.report_success + href: https://docs.python.org/3/library/doctest.html#doctest.DocTestRunner.report_success + name: report_success + uid: doctest.DocTestRunner.report_success +- fullName: doctest.DocTestRunner.report_unexpected_exception + href: https://docs.python.org/3/library/doctest.html#doctest.DocTestRunner.report_unexpected_exception + name: report_unexpected_exception + uid: doctest.DocTestRunner.report_unexpected_exception +- fullName: doctest.DocTestRunner.run + href: https://docs.python.org/3/library/doctest.html#doctest.DocTestRunner.run + name: run + uid: doctest.DocTestRunner.run +- fullName: doctest.DocTestRunner.summarize + href: https://docs.python.org/3/library/doctest.html#doctest.DocTestRunner.summarize + name: summarize + uid: doctest.DocTestRunner.summarize +- fullName: doctest.OutputChecker.check_output + href: https://docs.python.org/3/library/doctest.html#doctest.OutputChecker.check_output + name: check_output + uid: doctest.OutputChecker.check_output +- fullName: doctest.OutputChecker.output_difference + href: https://docs.python.org/3/library/doctest.html#doctest.OutputChecker.output_difference + name: output_difference + uid: doctest.OutputChecker.output_difference +- fullName: email.charset.Charset.__eq__ + href: https://docs.python.org/3/library/email.charset.html#email.charset.Charset.__eq__ + name: __eq__ + uid: email.charset.Charset.__eq__ +- fullName: email.charset.Charset.__ne__ + href: https://docs.python.org/3/library/email.charset.html#email.charset.Charset.__ne__ + name: __ne__ + uid: email.charset.Charset.__ne__ +- fullName: email.charset.Charset.__str__ + href: https://docs.python.org/3/library/email.charset.html#email.charset.Charset.__str__ + name: __str__ + uid: email.charset.Charset.__str__ +- fullName: email.charset.Charset.body_encode + href: https://docs.python.org/3/library/email.charset.html#email.charset.Charset.body_encode + name: body_encode + uid: email.charset.Charset.body_encode +- fullName: email.charset.Charset.get_body_encoding + href: https://docs.python.org/3/library/email.charset.html#email.charset.Charset.get_body_encoding + name: get_body_encoding + uid: email.charset.Charset.get_body_encoding +- fullName: email.charset.Charset.get_output_charset + href: https://docs.python.org/3/library/email.charset.html#email.charset.Charset.get_output_charset + name: get_output_charset + uid: email.charset.Charset.get_output_charset +- fullName: email.charset.Charset.header_encode + href: https://docs.python.org/3/library/email.charset.html#email.charset.Charset.header_encode + name: header_encode + uid: email.charset.Charset.header_encode +- fullName: email.charset.Charset.header_encode_lines + href: https://docs.python.org/3/library/email.charset.html#email.charset.Charset.header_encode_lines + name: header_encode_lines + uid: email.charset.Charset.header_encode_lines +- fullName: email.contentmanager.ContentManager.add_get_handler + href: https://docs.python.org/3/library/email.contentmanager.html#email.contentmanager.ContentManager.add_get_handler + name: add_get_handler + uid: email.contentmanager.ContentManager.add_get_handler +- fullName: email.contentmanager.ContentManager.add_set_handler + href: https://docs.python.org/3/library/email.contentmanager.html#email.contentmanager.ContentManager.add_set_handler + name: add_set_handler + uid: email.contentmanager.ContentManager.add_set_handler +- fullName: email.contentmanager.ContentManager.get_content + href: https://docs.python.org/3/library/email.contentmanager.html#email.contentmanager.ContentManager.get_content + name: get_content + uid: email.contentmanager.ContentManager.get_content +- fullName: email.contentmanager.ContentManager.set_content + href: https://docs.python.org/3/library/email.contentmanager.html#email.contentmanager.ContentManager.set_content + name: set_content + uid: email.contentmanager.ContentManager.set_content +- fullName: email.contentmanager.get_content + href: https://docs.python.org/3/library/email.contentmanager.html#email.contentmanager.get_content + name: get_content + uid: email.contentmanager.get_content +- fullName: email.contentmanager.set_content + href: https://docs.python.org/3/library/email.contentmanager.html#email.contentmanager.set_content + name: set_content + uid: email.contentmanager.set_content +- fullName: email.generator.BytesGenerator.clone + href: https://docs.python.org/3/library/email.generator.html#email.generator.BytesGenerator.clone + name: clone + uid: email.generator.BytesGenerator.clone +- fullName: email.generator.BytesGenerator.flatten + href: https://docs.python.org/3/library/email.generator.html#email.generator.BytesGenerator.flatten + name: flatten + uid: email.generator.BytesGenerator.flatten +- fullName: email.generator.BytesGenerator.write + href: https://docs.python.org/3/library/email.generator.html#email.generator.BytesGenerator.write + name: write + uid: email.generator.BytesGenerator.write +- fullName: email.generator.Generator.clone + href: https://docs.python.org/3/library/email.generator.html#email.generator.Generator.clone + name: clone + uid: email.generator.Generator.clone +- fullName: email.generator.Generator.flatten + href: https://docs.python.org/3/library/email.generator.html#email.generator.Generator.flatten + name: flatten + uid: email.generator.Generator.flatten +- fullName: email.generator.Generator.write + href: https://docs.python.org/3/library/email.generator.html#email.generator.Generator.write + name: write + uid: email.generator.Generator.write +- fullName: email.header.Header.__eq__ + href: https://docs.python.org/3/library/email.header.html#email.header.Header.__eq__ + name: __eq__ + uid: email.header.Header.__eq__ +- fullName: email.header.Header.__ne__ + href: https://docs.python.org/3/library/email.header.html#email.header.Header.__ne__ + name: __ne__ + uid: email.header.Header.__ne__ +- fullName: email.header.Header.__str__ + href: https://docs.python.org/3/library/email.header.html#email.header.Header.__str__ + name: __str__ + uid: email.header.Header.__str__ +- fullName: email.header.Header.append + href: https://docs.python.org/3/library/email.header.html#email.header.Header.append + name: append + uid: email.header.Header.append +- fullName: email.header.Header.encode + href: https://docs.python.org/3/library/email.header.html#email.header.Header.encode + name: encode + uid: email.header.Header.encode +- fullName: email.headerregistry.Address.__str__ + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.Address.__str__ + name: __str__ + uid: email.headerregistry.Address.__str__ +- fullName: email.headerregistry.BaseHeader.fold + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.BaseHeader.fold + name: fold + uid: email.headerregistry.BaseHeader.fold +- fullName: email.headerregistry.Group.__str__ + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.Group.__str__ + name: __str__ + uid: email.headerregistry.Group.__str__ +- fullName: email.headerregistry.HeaderRegistry.__call__ + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.HeaderRegistry.__call__ + name: __call__ + uid: email.headerregistry.HeaderRegistry.__call__ +- fullName: email.headerregistry.HeaderRegistry.__getitem__ + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.HeaderRegistry.__getitem__ + name: __getitem__ + uid: email.headerregistry.HeaderRegistry.__getitem__ +- fullName: email.headerregistry.HeaderRegistry.map_to_type + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.HeaderRegistry.map_to_type + name: map_to_type + uid: email.headerregistry.HeaderRegistry.map_to_type +- fullName: email.message.EmailMessage.__bytes__ + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.__bytes__ + name: __bytes__ + uid: email.message.EmailMessage.__bytes__ +- fullName: email.message.EmailMessage.__contains__ + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.__contains__ + name: __contains__ + uid: email.message.EmailMessage.__contains__ +- fullName: email.message.EmailMessage.__delitem__ + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.__delitem__ + name: __delitem__ + uid: email.message.EmailMessage.__delitem__ +- fullName: email.message.EmailMessage.__getitem__ + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.__getitem__ + name: __getitem__ + uid: email.message.EmailMessage.__getitem__ +- fullName: email.message.EmailMessage.__len__ + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.__len__ + name: __len__ + uid: email.message.EmailMessage.__len__ +- fullName: email.message.EmailMessage.__setitem__ + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.__setitem__ + name: __setitem__ + uid: email.message.EmailMessage.__setitem__ +- fullName: email.message.EmailMessage.__str__ + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.__str__ + name: __str__ + uid: email.message.EmailMessage.__str__ +- fullName: email.message.EmailMessage.add_alternative + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.add_alternative + name: add_alternative + uid: email.message.EmailMessage.add_alternative +- fullName: email.message.EmailMessage.add_attachment + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.add_attachment + name: add_attachment + uid: email.message.EmailMessage.add_attachment +- fullName: email.message.EmailMessage.add_header + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.add_header + name: add_header + uid: email.message.EmailMessage.add_header +- fullName: email.message.EmailMessage.add_related + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.add_related + name: add_related + uid: email.message.EmailMessage.add_related +- fullName: email.message.EmailMessage.as_bytes + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.as_bytes + name: as_bytes + uid: email.message.EmailMessage.as_bytes +- fullName: email.message.EmailMessage.as_string + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.as_string + name: as_string + uid: email.message.EmailMessage.as_string +- fullName: email.message.EmailMessage.clear + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.clear + name: clear + uid: email.message.EmailMessage.clear +- fullName: email.message.EmailMessage.clear_content + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.clear_content + name: clear_content + uid: email.message.EmailMessage.clear_content +- fullName: email.message.EmailMessage.del_param + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.del_param + name: del_param + uid: email.message.EmailMessage.del_param +- fullName: email.message.EmailMessage.get + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.get + name: get + uid: email.message.EmailMessage.get +- fullName: email.message.EmailMessage.get_all + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.get_all + name: get_all + uid: email.message.EmailMessage.get_all +- fullName: email.message.EmailMessage.get_body + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.get_body + name: get_body + uid: email.message.EmailMessage.get_body +- fullName: email.message.EmailMessage.get_boundary + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.get_boundary + name: get_boundary + uid: email.message.EmailMessage.get_boundary +- fullName: email.message.EmailMessage.get_charsets + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.get_charsets + name: get_charsets + uid: email.message.EmailMessage.get_charsets +- fullName: email.message.EmailMessage.get_content + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.get_content + name: get_content + uid: email.message.EmailMessage.get_content +- fullName: email.message.EmailMessage.get_content_charset + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.get_content_charset + name: get_content_charset + uid: email.message.EmailMessage.get_content_charset +- fullName: email.message.EmailMessage.get_content_disposition + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.get_content_disposition + name: get_content_disposition + uid: email.message.EmailMessage.get_content_disposition +- fullName: email.message.EmailMessage.get_content_maintype + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.get_content_maintype + name: get_content_maintype + uid: email.message.EmailMessage.get_content_maintype +- fullName: email.message.EmailMessage.get_content_subtype + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.get_content_subtype + name: get_content_subtype + uid: email.message.EmailMessage.get_content_subtype +- fullName: email.message.EmailMessage.get_content_type + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.get_content_type + name: get_content_type + uid: email.message.EmailMessage.get_content_type +- fullName: email.message.EmailMessage.get_default_type + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.get_default_type + name: get_default_type + uid: email.message.EmailMessage.get_default_type +- fullName: email.message.EmailMessage.get_filename + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.get_filename + name: get_filename + uid: email.message.EmailMessage.get_filename +- fullName: email.message.EmailMessage.get_unixfrom + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.get_unixfrom + name: get_unixfrom + uid: email.message.EmailMessage.get_unixfrom +- fullName: email.message.EmailMessage.is_attachment + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.is_attachment + name: is_attachment + uid: email.message.EmailMessage.is_attachment +- fullName: email.message.EmailMessage.is_multipart + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.is_multipart + name: is_multipart + uid: email.message.EmailMessage.is_multipart +- fullName: email.message.EmailMessage.items + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.items + name: items + uid: email.message.EmailMessage.items +- fullName: email.message.EmailMessage.iter_attachments + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.iter_attachments + name: iter_attachments + uid: email.message.EmailMessage.iter_attachments +- fullName: email.message.EmailMessage.iter_parts + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.iter_parts + name: iter_parts + uid: email.message.EmailMessage.iter_parts +- fullName: email.message.EmailMessage.keys + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.keys + name: keys + uid: email.message.EmailMessage.keys +- fullName: email.message.EmailMessage.make_alternative + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.make_alternative + name: make_alternative + uid: email.message.EmailMessage.make_alternative +- fullName: email.message.EmailMessage.make_mixed + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.make_mixed + name: make_mixed + uid: email.message.EmailMessage.make_mixed +- fullName: email.message.EmailMessage.make_related + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.make_related + name: make_related + uid: email.message.EmailMessage.make_related +- fullName: email.message.EmailMessage.replace_header + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.replace_header + name: replace_header + uid: email.message.EmailMessage.replace_header +- fullName: email.message.EmailMessage.set_boundary + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.set_boundary + name: set_boundary + uid: email.message.EmailMessage.set_boundary +- fullName: email.message.EmailMessage.set_content + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.set_content + name: set_content + uid: email.message.EmailMessage.set_content +- fullName: email.message.EmailMessage.set_default_type + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.set_default_type + name: set_default_type + uid: email.message.EmailMessage.set_default_type +- fullName: email.message.EmailMessage.set_param + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.set_param + name: set_param + uid: email.message.EmailMessage.set_param +- fullName: email.message.EmailMessage.set_unixfrom + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.set_unixfrom + name: set_unixfrom + uid: email.message.EmailMessage.set_unixfrom +- fullName: email.message.EmailMessage.values + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.values + name: values + uid: email.message.EmailMessage.values +- fullName: email.message.EmailMessage.walk + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage.walk + name: walk + uid: email.message.EmailMessage.walk +- fullName: email.message.Message.__bytes__ + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.__bytes__ + name: __bytes__ + uid: email.message.Message.__bytes__ +- fullName: email.message.Message.__contains__ + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.__contains__ + name: __contains__ + uid: email.message.Message.__contains__ +- fullName: email.message.Message.__delitem__ + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.__delitem__ + name: __delitem__ + uid: email.message.Message.__delitem__ +- fullName: email.message.Message.__getitem__ + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.__getitem__ + name: __getitem__ + uid: email.message.Message.__getitem__ +- fullName: email.message.Message.__len__ + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.__len__ + name: __len__ + uid: email.message.Message.__len__ +- fullName: email.message.Message.__setitem__ + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.__setitem__ + name: __setitem__ + uid: email.message.Message.__setitem__ +- fullName: email.message.Message.__str__ + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.__str__ + name: __str__ + uid: email.message.Message.__str__ +- fullName: email.message.Message.add_header + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.add_header + name: add_header + uid: email.message.Message.add_header +- fullName: email.message.Message.as_bytes + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.as_bytes + name: as_bytes + uid: email.message.Message.as_bytes +- fullName: email.message.Message.as_string + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.as_string + name: as_string + uid: email.message.Message.as_string +- fullName: email.message.Message.attach + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.attach + name: attach + uid: email.message.Message.attach +- fullName: email.message.Message.del_param + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.del_param + name: del_param + uid: email.message.Message.del_param +- fullName: email.message.Message.get + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.get + name: get + uid: email.message.Message.get +- fullName: email.message.Message.get_all + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.get_all + name: get_all + uid: email.message.Message.get_all +- fullName: email.message.Message.get_boundary + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.get_boundary + name: get_boundary + uid: email.message.Message.get_boundary +- fullName: email.message.Message.get_charset + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.get_charset + name: get_charset + uid: email.message.Message.get_charset +- fullName: email.message.Message.get_charsets + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.get_charsets + name: get_charsets + uid: email.message.Message.get_charsets +- fullName: email.message.Message.get_content_charset + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.get_content_charset + name: get_content_charset + uid: email.message.Message.get_content_charset +- fullName: email.message.Message.get_content_disposition + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.get_content_disposition + name: get_content_disposition + uid: email.message.Message.get_content_disposition +- fullName: email.message.Message.get_content_maintype + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.get_content_maintype + name: get_content_maintype + uid: email.message.Message.get_content_maintype +- fullName: email.message.Message.get_content_subtype + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.get_content_subtype + name: get_content_subtype + uid: email.message.Message.get_content_subtype +- fullName: email.message.Message.get_content_type + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.get_content_type + name: get_content_type + uid: email.message.Message.get_content_type +- fullName: email.message.Message.get_default_type + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.get_default_type + name: get_default_type + uid: email.message.Message.get_default_type +- fullName: email.message.Message.get_filename + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.get_filename + name: get_filename + uid: email.message.Message.get_filename +- fullName: email.message.Message.get_param + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.get_param + name: get_param + uid: email.message.Message.get_param +- fullName: email.message.Message.get_params + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.get_params + name: get_params + uid: email.message.Message.get_params +- fullName: email.message.Message.get_payload + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.get_payload + name: get_payload + uid: email.message.Message.get_payload +- fullName: email.message.Message.get_unixfrom + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.get_unixfrom + name: get_unixfrom + uid: email.message.Message.get_unixfrom +- fullName: email.message.Message.is_multipart + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.is_multipart + name: is_multipart + uid: email.message.Message.is_multipart +- fullName: email.message.Message.items + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.items + name: items + uid: email.message.Message.items +- fullName: email.message.Message.keys + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.keys + name: keys + uid: email.message.Message.keys +- fullName: email.message.Message.replace_header + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.replace_header + name: replace_header + uid: email.message.Message.replace_header +- fullName: email.message.Message.set_boundary + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.set_boundary + name: set_boundary + uid: email.message.Message.set_boundary +- fullName: email.message.Message.set_charset + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.set_charset + name: set_charset + uid: email.message.Message.set_charset +- fullName: email.message.Message.set_default_type + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.set_default_type + name: set_default_type + uid: email.message.Message.set_default_type +- fullName: email.message.Message.set_param + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.set_param + name: set_param + uid: email.message.Message.set_param +- fullName: email.message.Message.set_payload + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.set_payload + name: set_payload + uid: email.message.Message.set_payload +- fullName: email.message.Message.set_type + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.set_type + name: set_type + uid: email.message.Message.set_type +- fullName: email.message.Message.set_unixfrom + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.set_unixfrom + name: set_unixfrom + uid: email.message.Message.set_unixfrom +- fullName: email.message.Message.values + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.values + name: values + uid: email.message.Message.values +- fullName: email.message.Message.walk + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message.walk + name: walk + uid: email.message.Message.walk +- fullName: email.parser.BytesFeedParser.close + href: https://docs.python.org/3/library/email.parser.html#email.parser.BytesFeedParser.close + name: close + uid: email.parser.BytesFeedParser.close +- fullName: email.parser.BytesFeedParser.feed + href: https://docs.python.org/3/library/email.parser.html#email.parser.BytesFeedParser.feed + name: feed + uid: email.parser.BytesFeedParser.feed +- fullName: email.parser.BytesParser.parse + href: https://docs.python.org/3/library/email.parser.html#email.parser.BytesParser.parse + name: parse + uid: email.parser.BytesParser.parse +- fullName: email.parser.BytesParser.parsebytes + href: https://docs.python.org/3/library/email.parser.html#email.parser.BytesParser.parsebytes + name: parsebytes + uid: email.parser.BytesParser.parsebytes +- fullName: email.parser.Parser.parse + href: https://docs.python.org/3/library/email.parser.html#email.parser.Parser.parse + name: parse + uid: email.parser.Parser.parse +- fullName: email.parser.Parser.parsestr + href: https://docs.python.org/3/library/email.parser.html#email.parser.Parser.parsestr + name: parsestr + uid: email.parser.Parser.parsestr +- fullName: email.policy.Compat32.fold + href: https://docs.python.org/3/library/email.policy.html#email.policy.Compat32.fold + name: fold + uid: email.policy.Compat32.fold +- fullName: email.policy.Compat32.fold_binary + href: https://docs.python.org/3/library/email.policy.html#email.policy.Compat32.fold_binary + name: fold_binary + uid: email.policy.Compat32.fold_binary +- fullName: email.policy.Compat32.header_fetch_parse + href: https://docs.python.org/3/library/email.policy.html#email.policy.Compat32.header_fetch_parse + name: header_fetch_parse + uid: email.policy.Compat32.header_fetch_parse +- fullName: email.policy.Compat32.header_source_parse + href: https://docs.python.org/3/library/email.policy.html#email.policy.Compat32.header_source_parse + name: header_source_parse + uid: email.policy.Compat32.header_source_parse +- fullName: email.policy.Compat32.header_store_parse + href: https://docs.python.org/3/library/email.policy.html#email.policy.Compat32.header_store_parse + name: header_store_parse + uid: email.policy.Compat32.header_store_parse +- fullName: email.policy.EmailPolicy.fold + href: https://docs.python.org/3/library/email.policy.html#email.policy.EmailPolicy.fold + name: fold + uid: email.policy.EmailPolicy.fold +- fullName: email.policy.EmailPolicy.fold_binary + href: https://docs.python.org/3/library/email.policy.html#email.policy.EmailPolicy.fold_binary + name: fold_binary + uid: email.policy.EmailPolicy.fold_binary +- fullName: email.policy.EmailPolicy.header_fetch_parse + href: https://docs.python.org/3/library/email.policy.html#email.policy.EmailPolicy.header_fetch_parse + name: header_fetch_parse + uid: email.policy.EmailPolicy.header_fetch_parse +- fullName: email.policy.EmailPolicy.header_max_count + href: https://docs.python.org/3/library/email.policy.html#email.policy.EmailPolicy.header_max_count + name: header_max_count + uid: email.policy.EmailPolicy.header_max_count +- fullName: email.policy.EmailPolicy.header_source_parse + href: https://docs.python.org/3/library/email.policy.html#email.policy.EmailPolicy.header_source_parse + name: header_source_parse + uid: email.policy.EmailPolicy.header_source_parse +- fullName: email.policy.EmailPolicy.header_store_parse + href: https://docs.python.org/3/library/email.policy.html#email.policy.EmailPolicy.header_store_parse + name: header_store_parse + uid: email.policy.EmailPolicy.header_store_parse +- fullName: email.policy.Policy.clone + href: https://docs.python.org/3/library/email.policy.html#email.policy.Policy.clone + name: clone + uid: email.policy.Policy.clone +- fullName: email.policy.Policy.fold + href: https://docs.python.org/3/library/email.policy.html#email.policy.Policy.fold + name: fold + uid: email.policy.Policy.fold +- fullName: email.policy.Policy.fold_binary + href: https://docs.python.org/3/library/email.policy.html#email.policy.Policy.fold_binary + name: fold_binary + uid: email.policy.Policy.fold_binary +- fullName: email.policy.Policy.handle_defect + href: https://docs.python.org/3/library/email.policy.html#email.policy.Policy.handle_defect + name: handle_defect + uid: email.policy.Policy.handle_defect +- fullName: email.policy.Policy.header_fetch_parse + href: https://docs.python.org/3/library/email.policy.html#email.policy.Policy.header_fetch_parse + name: header_fetch_parse + uid: email.policy.Policy.header_fetch_parse +- fullName: email.policy.Policy.header_max_count + href: https://docs.python.org/3/library/email.policy.html#email.policy.Policy.header_max_count + name: header_max_count + uid: email.policy.Policy.header_max_count +- fullName: email.policy.Policy.header_source_parse + href: https://docs.python.org/3/library/email.policy.html#email.policy.Policy.header_source_parse + name: header_source_parse + uid: email.policy.Policy.header_source_parse +- fullName: email.policy.Policy.header_store_parse + href: https://docs.python.org/3/library/email.policy.html#email.policy.Policy.header_store_parse + name: header_store_parse + uid: email.policy.Policy.header_store_parse +- fullName: email.policy.Policy.register_defect + href: https://docs.python.org/3/library/email.policy.html#email.policy.Policy.register_defect + name: register_defect + uid: email.policy.Policy.register_defect +- fullName: enum.Enum.__dir__ + href: https://docs.python.org/3/library/enum.html#enum.Enum.__dir__ + name: __dir__ + uid: enum.Enum.__dir__ +- fullName: enum.Enum.__format__ + href: https://docs.python.org/3/library/enum.html#enum.Enum.__format__ + name: __format__ + uid: enum.Enum.__format__ +- fullName: enum.Enum.__init__ + href: https://docs.python.org/3/library/enum.html#enum.Enum.__init__ + name: __init__ + uid: enum.Enum.__init__ +- fullName: enum.Enum.__init_subclass__ + href: https://docs.python.org/3/library/enum.html#enum.Enum.__init_subclass__ + name: __init_subclass__ + uid: enum.Enum.__init_subclass__ +- fullName: enum.Enum.__new__ + href: https://docs.python.org/3/library/enum.html#enum.Enum.__new__ + name: __new__ + uid: enum.Enum.__new__ +- fullName: enum.Enum.__repr__ + href: https://docs.python.org/3/library/enum.html#enum.Enum.__repr__ + name: __repr__ + uid: enum.Enum.__repr__ +- fullName: enum.Enum.__str__ + href: https://docs.python.org/3/library/enum.html#enum.Enum.__str__ + name: __str__ + uid: enum.Enum.__str__ +- fullName: enum.Enum._generate_next_value_ + href: https://docs.python.org/3/library/enum.html#enum.Enum._generate_next_value_ + name: _generate_next_value_ + uid: enum.Enum._generate_next_value_ +- fullName: enum.Enum._missing_ + href: https://docs.python.org/3/library/enum.html#enum.Enum._missing_ + name: _missing_ + uid: enum.Enum._missing_ +- fullName: enum.EnumType.__call__ + href: https://docs.python.org/3/library/enum.html#enum.EnumType.__call__ + name: __call__ + uid: enum.EnumType.__call__ +- fullName: enum.EnumType.__contains__ + href: https://docs.python.org/3/library/enum.html#enum.EnumType.__contains__ + name: __contains__ + uid: enum.EnumType.__contains__ +- fullName: enum.EnumType.__dir__ + href: https://docs.python.org/3/library/enum.html#enum.EnumType.__dir__ + name: __dir__ + uid: enum.EnumType.__dir__ +- fullName: enum.EnumType.__getitem__ + href: https://docs.python.org/3/library/enum.html#enum.EnumType.__getitem__ + name: __getitem__ + uid: enum.EnumType.__getitem__ +- fullName: enum.EnumType.__iter__ + href: https://docs.python.org/3/library/enum.html#enum.EnumType.__iter__ + name: __iter__ + uid: enum.EnumType.__iter__ +- fullName: enum.EnumType.__len__ + href: https://docs.python.org/3/library/enum.html#enum.EnumType.__len__ + name: __len__ + uid: enum.EnumType.__len__ +- fullName: enum.EnumType.__reversed__ + href: https://docs.python.org/3/library/enum.html#enum.EnumType.__reversed__ + name: __reversed__ + uid: enum.EnumType.__reversed__ +- fullName: enum.EnumType._add_alias_ + href: https://docs.python.org/3/library/enum.html#enum.EnumType._add_alias_ + name: _add_alias_ + uid: enum.EnumType._add_alias_ +- fullName: enum.EnumType._add_value_alias_ + href: https://docs.python.org/3/library/enum.html#enum.EnumType._add_value_alias_ + name: _add_value_alias_ + uid: enum.EnumType._add_value_alias_ +- fullName: enum.Flag.__and__ + href: https://docs.python.org/3/library/enum.html#enum.Flag.__and__ + name: __and__ + uid: enum.Flag.__and__ +- fullName: enum.Flag.__contains__ + href: https://docs.python.org/3/library/enum.html#enum.Flag.__contains__ + name: __contains__ + uid: enum.Flag.__contains__ +- fullName: enum.Flag.__or__ + href: https://docs.python.org/3/library/enum.html#enum.Flag.__or__ + name: __or__ + uid: enum.Flag.__or__ +- fullName: enum.Flag.__xor__ + href: https://docs.python.org/3/library/enum.html#enum.Flag.__xor__ + name: __xor__ + uid: enum.Flag.__xor__ +- fullName: enum.Flag._numeric_repr_ + href: https://docs.python.org/3/library/enum.html#enum.Flag._numeric_repr_ + name: _numeric_repr_ + uid: enum.Flag._numeric_repr_ +- fullName: filecmp.dircmp.report + href: https://docs.python.org/3/library/filecmp.html#filecmp.dircmp.report + name: report + uid: filecmp.dircmp.report +- fullName: filecmp.dircmp.report_full_closure + href: https://docs.python.org/3/library/filecmp.html#filecmp.dircmp.report_full_closure + name: report_full_closure + uid: filecmp.dircmp.report_full_closure +- fullName: filecmp.dircmp.report_partial_closure + href: https://docs.python.org/3/library/filecmp.html#filecmp.dircmp.report_partial_closure + name: report_partial_closure + uid: filecmp.dircmp.report_partial_closure +- fullName: float.as_integer_ratio + href: https://docs.python.org/3/library/stdtypes.html#float.as_integer_ratio + name: as_integer_ratio + uid: float.as_integer_ratio +- fullName: float.fromhex + href: https://docs.python.org/3/library/stdtypes.html#float.fromhex + name: fromhex + uid: float.fromhex +- fullName: float.hex + href: https://docs.python.org/3/library/stdtypes.html#float.hex + name: hex + uid: float.hex +- fullName: float.is_integer + href: https://docs.python.org/3/library/stdtypes.html#float.is_integer + name: is_integer + uid: float.is_integer +- fullName: fractions.Fraction.__ceil__ + href: https://docs.python.org/3/library/fractions.html#fractions.Fraction.__ceil__ + name: __ceil__ + uid: fractions.Fraction.__ceil__ +- fullName: fractions.Fraction.__floor__ + href: https://docs.python.org/3/library/fractions.html#fractions.Fraction.__floor__ + name: __floor__ + uid: fractions.Fraction.__floor__ +- fullName: fractions.Fraction.__format__ + href: https://docs.python.org/3/library/fractions.html#fractions.Fraction.__format__ + name: __format__ + uid: fractions.Fraction.__format__ +- fullName: fractions.Fraction.__round__ + href: https://docs.python.org/3/library/fractions.html#fractions.Fraction.__round__ + name: __round__ + uid: fractions.Fraction.__round__ +- fullName: fractions.Fraction.as_integer_ratio + href: https://docs.python.org/3/library/fractions.html#fractions.Fraction.as_integer_ratio + name: as_integer_ratio + uid: fractions.Fraction.as_integer_ratio +- fullName: fractions.Fraction.from_decimal + href: https://docs.python.org/3/library/fractions.html#fractions.Fraction.from_decimal + name: from_decimal + uid: fractions.Fraction.from_decimal +- fullName: fractions.Fraction.from_float + href: https://docs.python.org/3/library/fractions.html#fractions.Fraction.from_float + name: from_float + uid: fractions.Fraction.from_float +- fullName: fractions.Fraction.is_integer + href: https://docs.python.org/3/library/fractions.html#fractions.Fraction.is_integer + name: is_integer + uid: fractions.Fraction.is_integer +- fullName: fractions.Fraction.limit_denominator + href: https://docs.python.org/3/library/fractions.html#fractions.Fraction.limit_denominator + name: limit_denominator + uid: fractions.Fraction.limit_denominator +- fullName: frame.clear + href: https://docs.python.org/3/reference/datamodel.html#frame.clear + name: clear + uid: frame.clear +- fullName: frozenset.add + href: https://docs.python.org/3/library/stdtypes.html#frozenset.add + name: add + uid: frozenset.add +- fullName: frozenset.clear + href: https://docs.python.org/3/library/stdtypes.html#frozenset.clear + name: clear + uid: frozenset.clear +- fullName: frozenset.copy + href: https://docs.python.org/3/library/stdtypes.html#frozenset.copy + name: copy + uid: frozenset.copy +- fullName: frozenset.difference + href: https://docs.python.org/3/library/stdtypes.html#frozenset.difference + name: difference + uid: frozenset.difference +- fullName: frozenset.difference_update + href: https://docs.python.org/3/library/stdtypes.html#frozenset.difference_update + name: difference_update + uid: frozenset.difference_update +- fullName: frozenset.discard + href: https://docs.python.org/3/library/stdtypes.html#frozenset.discard + name: discard + uid: frozenset.discard +- fullName: frozenset.intersection + href: https://docs.python.org/3/library/stdtypes.html#frozenset.intersection + name: intersection + uid: frozenset.intersection +- fullName: frozenset.intersection_update + href: https://docs.python.org/3/library/stdtypes.html#frozenset.intersection_update + name: intersection_update + uid: frozenset.intersection_update +- fullName: frozenset.isdisjoint + href: https://docs.python.org/3/library/stdtypes.html#frozenset.isdisjoint + name: isdisjoint + uid: frozenset.isdisjoint +- fullName: frozenset.issubset + href: https://docs.python.org/3/library/stdtypes.html#frozenset.issubset + name: issubset + uid: frozenset.issubset +- fullName: frozenset.issuperset + href: https://docs.python.org/3/library/stdtypes.html#frozenset.issuperset + name: issuperset + uid: frozenset.issuperset +- fullName: frozenset.pop + href: https://docs.python.org/3/library/stdtypes.html#frozenset.pop + name: pop + uid: frozenset.pop +- fullName: frozenset.remove + href: https://docs.python.org/3/library/stdtypes.html#frozenset.remove + name: remove + uid: frozenset.remove +- fullName: frozenset.symmetric_difference + href: https://docs.python.org/3/library/stdtypes.html#frozenset.symmetric_difference + name: symmetric_difference + uid: frozenset.symmetric_difference +- fullName: frozenset.symmetric_difference_update + href: https://docs.python.org/3/library/stdtypes.html#frozenset.symmetric_difference_update + name: symmetric_difference_update + uid: frozenset.symmetric_difference_update +- fullName: frozenset.union + href: https://docs.python.org/3/library/stdtypes.html#frozenset.union + name: union + uid: frozenset.union +- fullName: frozenset.update + href: https://docs.python.org/3/library/stdtypes.html#frozenset.update + name: update + uid: frozenset.update +- fullName: ftplib.FTP.abort + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.abort + name: abort + uid: ftplib.FTP.abort +- fullName: ftplib.FTP.close + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.close + name: close + uid: ftplib.FTP.close +- fullName: ftplib.FTP.connect + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.connect + name: connect + uid: ftplib.FTP.connect +- fullName: ftplib.FTP.cwd + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.cwd + name: cwd + uid: ftplib.FTP.cwd +- fullName: ftplib.FTP.delete + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.delete + name: delete + uid: ftplib.FTP.delete +- fullName: ftplib.FTP.dir + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.dir + name: dir + uid: ftplib.FTP.dir +- fullName: ftplib.FTP.getwelcome + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.getwelcome + name: getwelcome + uid: ftplib.FTP.getwelcome +- fullName: ftplib.FTP.login + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.login + name: login + uid: ftplib.FTP.login +- fullName: ftplib.FTP.mkd + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.mkd + name: mkd + uid: ftplib.FTP.mkd +- fullName: ftplib.FTP.mlsd + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.mlsd + name: mlsd + uid: ftplib.FTP.mlsd +- fullName: ftplib.FTP.nlst + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.nlst + name: nlst + uid: ftplib.FTP.nlst +- fullName: ftplib.FTP.ntransfercmd + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.ntransfercmd + name: ntransfercmd + uid: ftplib.FTP.ntransfercmd +- fullName: ftplib.FTP.pwd + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.pwd + name: pwd + uid: ftplib.FTP.pwd +- fullName: ftplib.FTP.quit + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.quit + name: quit + uid: ftplib.FTP.quit +- fullName: ftplib.FTP.rename + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.rename + name: rename + uid: ftplib.FTP.rename +- fullName: ftplib.FTP.retrbinary + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.retrbinary + name: retrbinary + uid: ftplib.FTP.retrbinary +- fullName: ftplib.FTP.retrlines + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.retrlines + name: retrlines + uid: ftplib.FTP.retrlines +- fullName: ftplib.FTP.rmd + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.rmd + name: rmd + uid: ftplib.FTP.rmd +- fullName: ftplib.FTP.sendcmd + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.sendcmd + name: sendcmd + uid: ftplib.FTP.sendcmd +- fullName: ftplib.FTP.set_debuglevel + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.set_debuglevel + name: set_debuglevel + uid: ftplib.FTP.set_debuglevel +- fullName: ftplib.FTP.set_pasv + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.set_pasv + name: set_pasv + uid: ftplib.FTP.set_pasv +- fullName: ftplib.FTP.size + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.size + name: size + uid: ftplib.FTP.size +- fullName: ftplib.FTP.storbinary + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.storbinary + name: storbinary + uid: ftplib.FTP.storbinary +- fullName: ftplib.FTP.storlines + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.storlines + name: storlines + uid: ftplib.FTP.storlines +- fullName: ftplib.FTP.transfercmd + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.transfercmd + name: transfercmd + uid: ftplib.FTP.transfercmd +- fullName: ftplib.FTP.voidcmd + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP.voidcmd + name: voidcmd + uid: ftplib.FTP.voidcmd +- fullName: ftplib.FTP_TLS.auth + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP_TLS.auth + name: auth + uid: ftplib.FTP_TLS.auth +- fullName: ftplib.FTP_TLS.ccc + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP_TLS.ccc + name: ccc + uid: ftplib.FTP_TLS.ccc +- fullName: ftplib.FTP_TLS.prot_c + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP_TLS.prot_c + name: prot_c + uid: ftplib.FTP_TLS.prot_c +- fullName: ftplib.FTP_TLS.prot_p + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP_TLS.prot_p + name: prot_p + uid: ftplib.FTP_TLS.prot_p +- fullName: generator.__next__ + href: https://docs.python.org/3/reference/expressions.html#generator.__next__ + name: __next__ + uid: generator.__next__ +- fullName: generator.close + href: https://docs.python.org/3/reference/expressions.html#generator.close + name: close + uid: generator.close +- fullName: generator.send + href: https://docs.python.org/3/reference/expressions.html#generator.send + name: send + uid: generator.send +- fullName: generator.throw + href: https://docs.python.org/3/reference/expressions.html#generator.throw + name: throw + uid: generator.throw +- fullName: gettext.GNUTranslations.gettext + href: https://docs.python.org/3/library/gettext.html#gettext.GNUTranslations.gettext + name: gettext + uid: gettext.GNUTranslations.gettext +- fullName: gettext.GNUTranslations.ngettext + href: https://docs.python.org/3/library/gettext.html#gettext.GNUTranslations.ngettext + name: ngettext + uid: gettext.GNUTranslations.ngettext +- fullName: gettext.GNUTranslations.npgettext + href: https://docs.python.org/3/library/gettext.html#gettext.GNUTranslations.npgettext + name: npgettext + uid: gettext.GNUTranslations.npgettext +- fullName: gettext.GNUTranslations.pgettext + href: https://docs.python.org/3/library/gettext.html#gettext.GNUTranslations.pgettext + name: pgettext + uid: gettext.GNUTranslations.pgettext +- fullName: gettext.NullTranslations._parse + href: https://docs.python.org/3/library/gettext.html#gettext.NullTranslations._parse + name: _parse + uid: gettext.NullTranslations._parse +- fullName: gettext.NullTranslations.add_fallback + href: https://docs.python.org/3/library/gettext.html#gettext.NullTranslations.add_fallback + name: add_fallback + uid: gettext.NullTranslations.add_fallback +- fullName: gettext.NullTranslations.charset + href: https://docs.python.org/3/library/gettext.html#gettext.NullTranslations.charset + name: charset + uid: gettext.NullTranslations.charset +- fullName: gettext.NullTranslations.gettext + href: https://docs.python.org/3/library/gettext.html#gettext.NullTranslations.gettext + name: gettext + uid: gettext.NullTranslations.gettext +- fullName: gettext.NullTranslations.info + href: https://docs.python.org/3/library/gettext.html#gettext.NullTranslations.info + name: info + uid: gettext.NullTranslations.info +- fullName: gettext.NullTranslations.install + href: https://docs.python.org/3/library/gettext.html#gettext.NullTranslations.install + name: install + uid: gettext.NullTranslations.install +- fullName: gettext.NullTranslations.ngettext + href: https://docs.python.org/3/library/gettext.html#gettext.NullTranslations.ngettext + name: ngettext + uid: gettext.NullTranslations.ngettext +- fullName: gettext.NullTranslations.npgettext + href: https://docs.python.org/3/library/gettext.html#gettext.NullTranslations.npgettext + name: npgettext + uid: gettext.NullTranslations.npgettext +- fullName: gettext.NullTranslations.pgettext + href: https://docs.python.org/3/library/gettext.html#gettext.NullTranslations.pgettext + name: pgettext + uid: gettext.NullTranslations.pgettext +- fullName: graphlib.TopologicalSorter.add + href: https://docs.python.org/3/library/graphlib.html#graphlib.TopologicalSorter.add + name: add + uid: graphlib.TopologicalSorter.add +- fullName: graphlib.TopologicalSorter.done + href: https://docs.python.org/3/library/graphlib.html#graphlib.TopologicalSorter.done + name: done + uid: graphlib.TopologicalSorter.done +- fullName: graphlib.TopologicalSorter.get_ready + href: https://docs.python.org/3/library/graphlib.html#graphlib.TopologicalSorter.get_ready + name: get_ready + uid: graphlib.TopologicalSorter.get_ready +- fullName: graphlib.TopologicalSorter.is_active + href: https://docs.python.org/3/library/graphlib.html#graphlib.TopologicalSorter.is_active + name: is_active + uid: graphlib.TopologicalSorter.is_active +- fullName: graphlib.TopologicalSorter.prepare + href: https://docs.python.org/3/library/graphlib.html#graphlib.TopologicalSorter.prepare + name: prepare + uid: graphlib.TopologicalSorter.prepare +- fullName: graphlib.TopologicalSorter.static_order + href: https://docs.python.org/3/library/graphlib.html#graphlib.TopologicalSorter.static_order + name: static_order + uid: graphlib.TopologicalSorter.static_order +- fullName: gzip.GzipFile.peek + href: https://docs.python.org/3/library/gzip.html#gzip.GzipFile.peek + name: peek + uid: gzip.GzipFile.peek +- fullName: hashlib.hash.copy + href: https://docs.python.org/3/library/hashlib.html#hashlib.hash.copy + name: copy + uid: hashlib.hash.copy +- fullName: hashlib.hash.digest + href: https://docs.python.org/3/library/hashlib.html#hashlib.hash.digest + name: digest + uid: hashlib.hash.digest +- fullName: hashlib.hash.hexdigest + href: https://docs.python.org/3/library/hashlib.html#hashlib.hash.hexdigest + name: hexdigest + uid: hashlib.hash.hexdigest +- fullName: hashlib.hash.update + href: https://docs.python.org/3/library/hashlib.html#hashlib.hash.update + name: update + uid: hashlib.hash.update +- fullName: hashlib.shake.digest + href: https://docs.python.org/3/library/hashlib.html#hashlib.shake.digest + name: digest + uid: hashlib.shake.digest +- fullName: hashlib.shake.hexdigest + href: https://docs.python.org/3/library/hashlib.html#hashlib.shake.hexdigest + name: hexdigest + uid: hashlib.shake.hexdigest +- fullName: hmac.HMAC.copy + href: https://docs.python.org/3/library/hmac.html#hmac.HMAC.copy + name: copy + uid: hmac.HMAC.copy +- fullName: hmac.HMAC.digest + href: https://docs.python.org/3/library/hmac.html#hmac.HMAC.digest + name: digest + uid: hmac.HMAC.digest +- fullName: hmac.HMAC.hexdigest + href: https://docs.python.org/3/library/hmac.html#hmac.HMAC.hexdigest + name: hexdigest + uid: hmac.HMAC.hexdigest +- fullName: hmac.HMAC.update + href: https://docs.python.org/3/library/hmac.html#hmac.HMAC.update + name: update + uid: hmac.HMAC.update +- fullName: html.parser.HTMLParser.close + href: https://docs.python.org/3/library/html.parser.html#html.parser.HTMLParser.close + name: close + uid: html.parser.HTMLParser.close +- fullName: html.parser.HTMLParser.feed + href: https://docs.python.org/3/library/html.parser.html#html.parser.HTMLParser.feed + name: feed + uid: html.parser.HTMLParser.feed +- fullName: html.parser.HTMLParser.get_starttag_text + href: https://docs.python.org/3/library/html.parser.html#html.parser.HTMLParser.get_starttag_text + name: get_starttag_text + uid: html.parser.HTMLParser.get_starttag_text +- fullName: html.parser.HTMLParser.getpos + href: https://docs.python.org/3/library/html.parser.html#html.parser.HTMLParser.getpos + name: getpos + uid: html.parser.HTMLParser.getpos +- fullName: html.parser.HTMLParser.handle_charref + href: https://docs.python.org/3/library/html.parser.html#html.parser.HTMLParser.handle_charref + name: handle_charref + uid: html.parser.HTMLParser.handle_charref +- fullName: html.parser.HTMLParser.handle_comment + href: https://docs.python.org/3/library/html.parser.html#html.parser.HTMLParser.handle_comment + name: handle_comment + uid: html.parser.HTMLParser.handle_comment +- fullName: html.parser.HTMLParser.handle_data + href: https://docs.python.org/3/library/html.parser.html#html.parser.HTMLParser.handle_data + name: handle_data + uid: html.parser.HTMLParser.handle_data +- fullName: html.parser.HTMLParser.handle_decl + href: https://docs.python.org/3/library/html.parser.html#html.parser.HTMLParser.handle_decl + name: handle_decl + uid: html.parser.HTMLParser.handle_decl +- fullName: html.parser.HTMLParser.handle_endtag + href: https://docs.python.org/3/library/html.parser.html#html.parser.HTMLParser.handle_endtag + name: handle_endtag + uid: html.parser.HTMLParser.handle_endtag +- fullName: html.parser.HTMLParser.handle_entityref + href: https://docs.python.org/3/library/html.parser.html#html.parser.HTMLParser.handle_entityref + name: handle_entityref + uid: html.parser.HTMLParser.handle_entityref +- fullName: html.parser.HTMLParser.handle_pi + href: https://docs.python.org/3/library/html.parser.html#html.parser.HTMLParser.handle_pi + name: handle_pi + uid: html.parser.HTMLParser.handle_pi +- fullName: html.parser.HTMLParser.handle_startendtag + href: https://docs.python.org/3/library/html.parser.html#html.parser.HTMLParser.handle_startendtag + name: handle_startendtag + uid: html.parser.HTMLParser.handle_startendtag +- fullName: html.parser.HTMLParser.handle_starttag + href: https://docs.python.org/3/library/html.parser.html#html.parser.HTMLParser.handle_starttag + name: handle_starttag + uid: html.parser.HTMLParser.handle_starttag +- fullName: html.parser.HTMLParser.reset + href: https://docs.python.org/3/library/html.parser.html#html.parser.HTMLParser.reset + name: reset + uid: html.parser.HTMLParser.reset +- fullName: html.parser.HTMLParser.unknown_decl + href: https://docs.python.org/3/library/html.parser.html#html.parser.HTMLParser.unknown_decl + name: unknown_decl + uid: html.parser.HTMLParser.unknown_decl +- fullName: http.client.HTTPConnection.close + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPConnection.close + name: close + uid: http.client.HTTPConnection.close +- fullName: http.client.HTTPConnection.connect + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPConnection.connect + name: connect + uid: http.client.HTTPConnection.connect +- fullName: http.client.HTTPConnection.endheaders + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPConnection.endheaders + name: endheaders + uid: http.client.HTTPConnection.endheaders +- fullName: http.client.HTTPConnection.get_proxy_response_headers + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPConnection.get_proxy_response_headers + name: get_proxy_response_headers + uid: http.client.HTTPConnection.get_proxy_response_headers +- fullName: http.client.HTTPConnection.getresponse + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPConnection.getresponse + name: getresponse + uid: http.client.HTTPConnection.getresponse +- fullName: http.client.HTTPConnection.putheader + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPConnection.putheader + name: putheader + uid: http.client.HTTPConnection.putheader +- fullName: http.client.HTTPConnection.putrequest + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPConnection.putrequest + name: putrequest + uid: http.client.HTTPConnection.putrequest +- fullName: http.client.HTTPConnection.request + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPConnection.request + name: request + uid: http.client.HTTPConnection.request +- fullName: http.client.HTTPConnection.send + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPConnection.send + name: send + uid: http.client.HTTPConnection.send +- fullName: http.client.HTTPConnection.set_debuglevel + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPConnection.set_debuglevel + name: set_debuglevel + uid: http.client.HTTPConnection.set_debuglevel +- fullName: http.client.HTTPConnection.set_tunnel + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPConnection.set_tunnel + name: set_tunnel + uid: http.client.HTTPConnection.set_tunnel +- fullName: http.client.HTTPResponse.fileno + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPResponse.fileno + name: fileno + uid: http.client.HTTPResponse.fileno +- fullName: http.client.HTTPResponse.getcode + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPResponse.getcode + name: getcode + uid: http.client.HTTPResponse.getcode +- fullName: http.client.HTTPResponse.getheader + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPResponse.getheader + name: getheader + uid: http.client.HTTPResponse.getheader +- fullName: http.client.HTTPResponse.getheaders + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPResponse.getheaders + name: getheaders + uid: http.client.HTTPResponse.getheaders +- fullName: http.client.HTTPResponse.geturl + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPResponse.geturl + name: geturl + uid: http.client.HTTPResponse.geturl +- fullName: http.client.HTTPResponse.info + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPResponse.info + name: info + uid: http.client.HTTPResponse.info +- fullName: http.client.HTTPResponse.read + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPResponse.read + name: read + uid: http.client.HTTPResponse.read +- fullName: http.client.HTTPResponse.readinto + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPResponse.readinto + name: readinto + uid: http.client.HTTPResponse.readinto +- fullName: http.cookiejar.Cookie.get_nonstandard_attr + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.Cookie.get_nonstandard_attr + name: get_nonstandard_attr + uid: http.cookiejar.Cookie.get_nonstandard_attr +- fullName: http.cookiejar.Cookie.has_nonstandard_attr + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.Cookie.has_nonstandard_attr + name: has_nonstandard_attr + uid: http.cookiejar.Cookie.has_nonstandard_attr +- fullName: http.cookiejar.Cookie.is_expired + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.Cookie.is_expired + name: is_expired + uid: http.cookiejar.Cookie.is_expired +- fullName: http.cookiejar.Cookie.set_nonstandard_attr + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.Cookie.set_nonstandard_attr + name: set_nonstandard_attr + uid: http.cookiejar.Cookie.set_nonstandard_attr +- fullName: http.cookiejar.CookieJar.add_cookie_header + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookieJar.add_cookie_header + name: add_cookie_header + uid: http.cookiejar.CookieJar.add_cookie_header +- fullName: http.cookiejar.CookieJar.clear + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookieJar.clear + name: clear + uid: http.cookiejar.CookieJar.clear +- fullName: http.cookiejar.CookieJar.clear_session_cookies + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookieJar.clear_session_cookies + name: clear_session_cookies + uid: http.cookiejar.CookieJar.clear_session_cookies +- fullName: http.cookiejar.CookieJar.extract_cookies + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookieJar.extract_cookies + name: extract_cookies + uid: http.cookiejar.CookieJar.extract_cookies +- fullName: http.cookiejar.CookieJar.make_cookies + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookieJar.make_cookies + name: make_cookies + uid: http.cookiejar.CookieJar.make_cookies +- fullName: http.cookiejar.CookieJar.set_cookie + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookieJar.set_cookie + name: set_cookie + uid: http.cookiejar.CookieJar.set_cookie +- fullName: http.cookiejar.CookieJar.set_cookie_if_ok + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookieJar.set_cookie_if_ok + name: set_cookie_if_ok + uid: http.cookiejar.CookieJar.set_cookie_if_ok +- fullName: http.cookiejar.CookieJar.set_policy + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookieJar.set_policy + name: set_policy + uid: http.cookiejar.CookieJar.set_policy +- fullName: http.cookiejar.CookiePolicy.domain_return_ok + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookiePolicy.domain_return_ok + name: domain_return_ok + uid: http.cookiejar.CookiePolicy.domain_return_ok +- fullName: http.cookiejar.CookiePolicy.path_return_ok + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookiePolicy.path_return_ok + name: path_return_ok + uid: http.cookiejar.CookiePolicy.path_return_ok +- fullName: http.cookiejar.CookiePolicy.return_ok + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookiePolicy.return_ok + name: return_ok + uid: http.cookiejar.CookiePolicy.return_ok +- fullName: http.cookiejar.CookiePolicy.set_ok + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookiePolicy.set_ok + name: set_ok + uid: http.cookiejar.CookiePolicy.set_ok +- fullName: http.cookiejar.DefaultCookiePolicy.allowed_domains + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy.allowed_domains + name: allowed_domains + uid: http.cookiejar.DefaultCookiePolicy.allowed_domains +- fullName: http.cookiejar.DefaultCookiePolicy.blocked_domains + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy.blocked_domains + name: blocked_domains + uid: http.cookiejar.DefaultCookiePolicy.blocked_domains +- fullName: http.cookiejar.DefaultCookiePolicy.is_blocked + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy.is_blocked + name: is_blocked + uid: http.cookiejar.DefaultCookiePolicy.is_blocked +- fullName: http.cookiejar.DefaultCookiePolicy.is_not_allowed + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy.is_not_allowed + name: is_not_allowed + uid: http.cookiejar.DefaultCookiePolicy.is_not_allowed +- fullName: http.cookiejar.DefaultCookiePolicy.set_allowed_domains + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy.set_allowed_domains + name: set_allowed_domains + uid: http.cookiejar.DefaultCookiePolicy.set_allowed_domains +- fullName: http.cookiejar.DefaultCookiePolicy.set_blocked_domains + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy.set_blocked_domains + name: set_blocked_domains + uid: http.cookiejar.DefaultCookiePolicy.set_blocked_domains +- fullName: http.cookiejar.FileCookieJar.load + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.FileCookieJar.load + name: load + uid: http.cookiejar.FileCookieJar.load +- fullName: http.cookiejar.FileCookieJar.revert + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.FileCookieJar.revert + name: revert + uid: http.cookiejar.FileCookieJar.revert +- fullName: http.cookiejar.FileCookieJar.save + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.FileCookieJar.save + name: save + uid: http.cookiejar.FileCookieJar.save +- fullName: http.cookies.BaseCookie.js_output + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.BaseCookie.js_output + name: js_output + uid: http.cookies.BaseCookie.js_output +- fullName: http.cookies.BaseCookie.load + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.BaseCookie.load + name: load + uid: http.cookies.BaseCookie.load +- fullName: http.cookies.BaseCookie.output + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.BaseCookie.output + name: output + uid: http.cookies.BaseCookie.output +- fullName: http.cookies.BaseCookie.value_decode + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.BaseCookie.value_decode + name: value_decode + uid: http.cookies.BaseCookie.value_decode +- fullName: http.cookies.BaseCookie.value_encode + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.BaseCookie.value_encode + name: value_encode + uid: http.cookies.BaseCookie.value_encode +- fullName: http.cookies.Morsel.OutputString + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.Morsel.OutputString + name: OutputString + uid: http.cookies.Morsel.OutputString +- fullName: http.cookies.Morsel.copy + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.Morsel.copy + name: copy + uid: http.cookies.Morsel.copy +- fullName: http.cookies.Morsel.isReservedKey + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.Morsel.isReservedKey + name: isReservedKey + uid: http.cookies.Morsel.isReservedKey +- fullName: http.cookies.Morsel.js_output + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.Morsel.js_output + name: js_output + uid: http.cookies.Morsel.js_output +- fullName: http.cookies.Morsel.output + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.Morsel.output + name: output + uid: http.cookies.Morsel.output +- fullName: http.cookies.Morsel.set + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.Morsel.set + name: set + uid: http.cookies.Morsel.set +- fullName: http.cookies.Morsel.setdefault + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.Morsel.setdefault + name: setdefault + uid: http.cookies.Morsel.setdefault +- fullName: http.cookies.Morsel.update + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.Morsel.update + name: update + uid: http.cookies.Morsel.update +- fullName: http.server.BaseHTTPRequestHandler.address_string + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.address_string + name: address_string + uid: http.server.BaseHTTPRequestHandler.address_string +- fullName: http.server.BaseHTTPRequestHandler.date_time_string + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.date_time_string + name: date_time_string + uid: http.server.BaseHTTPRequestHandler.date_time_string +- fullName: http.server.BaseHTTPRequestHandler.end_headers + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.end_headers + name: end_headers + uid: http.server.BaseHTTPRequestHandler.end_headers +- fullName: http.server.BaseHTTPRequestHandler.flush_headers + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.flush_headers + name: flush_headers + uid: http.server.BaseHTTPRequestHandler.flush_headers +- fullName: http.server.BaseHTTPRequestHandler.handle + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.handle + name: handle + uid: http.server.BaseHTTPRequestHandler.handle +- fullName: http.server.BaseHTTPRequestHandler.handle_expect_100 + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.handle_expect_100 + name: handle_expect_100 + uid: http.server.BaseHTTPRequestHandler.handle_expect_100 +- fullName: http.server.BaseHTTPRequestHandler.handle_one_request + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.handle_one_request + name: handle_one_request + uid: http.server.BaseHTTPRequestHandler.handle_one_request +- fullName: http.server.BaseHTTPRequestHandler.log_date_time_string + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.log_date_time_string + name: log_date_time_string + uid: http.server.BaseHTTPRequestHandler.log_date_time_string +- fullName: http.server.BaseHTTPRequestHandler.log_error + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.log_error + name: log_error + uid: http.server.BaseHTTPRequestHandler.log_error +- fullName: http.server.BaseHTTPRequestHandler.log_message + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.log_message + name: log_message + uid: http.server.BaseHTTPRequestHandler.log_message +- fullName: http.server.BaseHTTPRequestHandler.log_request + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.log_request + name: log_request + uid: http.server.BaseHTTPRequestHandler.log_request +- fullName: http.server.BaseHTTPRequestHandler.send_error + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.send_error + name: send_error + uid: http.server.BaseHTTPRequestHandler.send_error +- fullName: http.server.BaseHTTPRequestHandler.send_header + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.send_header + name: send_header + uid: http.server.BaseHTTPRequestHandler.send_header +- fullName: http.server.BaseHTTPRequestHandler.send_response + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.send_response + name: send_response + uid: http.server.BaseHTTPRequestHandler.send_response +- fullName: http.server.BaseHTTPRequestHandler.send_response_only + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.send_response_only + name: send_response_only + uid: http.server.BaseHTTPRequestHandler.send_response_only +- fullName: http.server.BaseHTTPRequestHandler.version_string + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler.version_string + name: version_string + uid: http.server.BaseHTTPRequestHandler.version_string +- fullName: http.server.CGIHTTPRequestHandler.do_POST + href: https://docs.python.org/3/library/http.server.html#http.server.CGIHTTPRequestHandler.do_POST + name: do_POST + uid: http.server.CGIHTTPRequestHandler.do_POST +- fullName: http.server.SimpleHTTPRequestHandler.do_GET + href: https://docs.python.org/3/library/http.server.html#http.server.SimpleHTTPRequestHandler.do_GET + name: do_GET + uid: http.server.SimpleHTTPRequestHandler.do_GET +- fullName: http.server.SimpleHTTPRequestHandler.do_HEAD + href: https://docs.python.org/3/library/http.server.html#http.server.SimpleHTTPRequestHandler.do_HEAD + name: do_HEAD + uid: http.server.SimpleHTTPRequestHandler.do_HEAD +- fullName: imaplib.IMAP4.append + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.append + name: append + uid: imaplib.IMAP4.append +- fullName: imaplib.IMAP4.authenticate + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.authenticate + name: authenticate + uid: imaplib.IMAP4.authenticate +- fullName: imaplib.IMAP4.check + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.check + name: check + uid: imaplib.IMAP4.check +- fullName: imaplib.IMAP4.close + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.close + name: close + uid: imaplib.IMAP4.close +- fullName: imaplib.IMAP4.copy + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.copy + name: copy + uid: imaplib.IMAP4.copy +- fullName: imaplib.IMAP4.create + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.create + name: create + uid: imaplib.IMAP4.create +- fullName: imaplib.IMAP4.delete + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.delete + name: delete + uid: imaplib.IMAP4.delete +- fullName: imaplib.IMAP4.deleteacl + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.deleteacl + name: deleteacl + uid: imaplib.IMAP4.deleteacl +- fullName: imaplib.IMAP4.enable + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.enable + name: enable + uid: imaplib.IMAP4.enable +- fullName: imaplib.IMAP4.expunge + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.expunge + name: expunge + uid: imaplib.IMAP4.expunge +- fullName: imaplib.IMAP4.fetch + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.fetch + name: fetch + uid: imaplib.IMAP4.fetch +- fullName: imaplib.IMAP4.getacl + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.getacl + name: getacl + uid: imaplib.IMAP4.getacl +- fullName: imaplib.IMAP4.getannotation + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.getannotation + name: getannotation + uid: imaplib.IMAP4.getannotation +- fullName: imaplib.IMAP4.getquota + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.getquota + name: getquota + uid: imaplib.IMAP4.getquota +- fullName: imaplib.IMAP4.getquotaroot + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.getquotaroot + name: getquotaroot + uid: imaplib.IMAP4.getquotaroot +- fullName: imaplib.IMAP4.list + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.list + name: list + uid: imaplib.IMAP4.list +- fullName: imaplib.IMAP4.login + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.login + name: login + uid: imaplib.IMAP4.login +- fullName: imaplib.IMAP4.login_cram_md5 + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.login_cram_md5 + name: login_cram_md5 + uid: imaplib.IMAP4.login_cram_md5 +- fullName: imaplib.IMAP4.logout + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.logout + name: logout + uid: imaplib.IMAP4.logout +- fullName: imaplib.IMAP4.lsub + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.lsub + name: lsub + uid: imaplib.IMAP4.lsub +- fullName: imaplib.IMAP4.myrights + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.myrights + name: myrights + uid: imaplib.IMAP4.myrights +- fullName: imaplib.IMAP4.namespace + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.namespace + name: namespace + uid: imaplib.IMAP4.namespace +- fullName: imaplib.IMAP4.noop + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.noop + name: noop + uid: imaplib.IMAP4.noop +- fullName: imaplib.IMAP4.open + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.open + name: open + uid: imaplib.IMAP4.open +- fullName: imaplib.IMAP4.partial + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.partial + name: partial + uid: imaplib.IMAP4.partial +- fullName: imaplib.IMAP4.proxyauth + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.proxyauth + name: proxyauth + uid: imaplib.IMAP4.proxyauth +- fullName: imaplib.IMAP4.read + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.read + name: read + uid: imaplib.IMAP4.read +- fullName: imaplib.IMAP4.readline + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.readline + name: readline + uid: imaplib.IMAP4.readline +- fullName: imaplib.IMAP4.recent + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.recent + name: recent + uid: imaplib.IMAP4.recent +- fullName: imaplib.IMAP4.rename + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.rename + name: rename + uid: imaplib.IMAP4.rename +- fullName: imaplib.IMAP4.response + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.response + name: response + uid: imaplib.IMAP4.response +- fullName: imaplib.IMAP4.search + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.search + name: search + uid: imaplib.IMAP4.search +- fullName: imaplib.IMAP4.select + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.select + name: select + uid: imaplib.IMAP4.select +- fullName: imaplib.IMAP4.send + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.send + name: send + uid: imaplib.IMAP4.send +- fullName: imaplib.IMAP4.setacl + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.setacl + name: setacl + uid: imaplib.IMAP4.setacl +- fullName: imaplib.IMAP4.setannotation + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.setannotation + name: setannotation + uid: imaplib.IMAP4.setannotation +- fullName: imaplib.IMAP4.setquota + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.setquota + name: setquota + uid: imaplib.IMAP4.setquota +- fullName: imaplib.IMAP4.shutdown + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.shutdown + name: shutdown + uid: imaplib.IMAP4.shutdown +- fullName: imaplib.IMAP4.socket + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.socket + name: socket + uid: imaplib.IMAP4.socket +- fullName: imaplib.IMAP4.sort + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.sort + name: sort + uid: imaplib.IMAP4.sort +- fullName: imaplib.IMAP4.starttls + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.starttls + name: starttls + uid: imaplib.IMAP4.starttls +- fullName: imaplib.IMAP4.status + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.status + name: status + uid: imaplib.IMAP4.status +- fullName: imaplib.IMAP4.store + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.store + name: store + uid: imaplib.IMAP4.store +- fullName: imaplib.IMAP4.subscribe + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.subscribe + name: subscribe + uid: imaplib.IMAP4.subscribe +- fullName: imaplib.IMAP4.thread + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.thread + name: thread + uid: imaplib.IMAP4.thread +- fullName: imaplib.IMAP4.uid + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.uid + name: uid + uid: imaplib.IMAP4.uid +- fullName: imaplib.IMAP4.unselect + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.unselect + name: unselect + uid: imaplib.IMAP4.unselect +- fullName: imaplib.IMAP4.unsubscribe + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.unsubscribe + name: unsubscribe + uid: imaplib.IMAP4.unsubscribe +- fullName: imaplib.IMAP4.xatom + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4.xatom + name: xatom + uid: imaplib.IMAP4.xatom +- fullName: importlib.abc.ExecutionLoader.get_filename + href: https://docs.python.org/3/library/importlib.html#importlib.abc.ExecutionLoader.get_filename + name: get_filename + uid: importlib.abc.ExecutionLoader.get_filename +- fullName: importlib.abc.FileLoader.get_data + href: https://docs.python.org/3/library/importlib.html#importlib.abc.FileLoader.get_data + name: get_data + uid: importlib.abc.FileLoader.get_data +- fullName: importlib.abc.FileLoader.get_filename + href: https://docs.python.org/3/library/importlib.html#importlib.abc.FileLoader.get_filename + name: get_filename + uid: importlib.abc.FileLoader.get_filename +- fullName: importlib.abc.FileLoader.load_module + href: https://docs.python.org/3/library/importlib.html#importlib.abc.FileLoader.load_module + name: load_module + uid: importlib.abc.FileLoader.load_module +- fullName: importlib.abc.InspectLoader.exec_module + href: https://docs.python.org/3/library/importlib.html#importlib.abc.InspectLoader.exec_module + name: exec_module + uid: importlib.abc.InspectLoader.exec_module +- fullName: importlib.abc.InspectLoader.get_code + href: https://docs.python.org/3/library/importlib.html#importlib.abc.InspectLoader.get_code + name: get_code + uid: importlib.abc.InspectLoader.get_code +- fullName: importlib.abc.InspectLoader.get_source + href: https://docs.python.org/3/library/importlib.html#importlib.abc.InspectLoader.get_source + name: get_source + uid: importlib.abc.InspectLoader.get_source +- fullName: importlib.abc.InspectLoader.is_package + href: https://docs.python.org/3/library/importlib.html#importlib.abc.InspectLoader.is_package + name: is_package + uid: importlib.abc.InspectLoader.is_package +- fullName: importlib.abc.InspectLoader.load_module + href: https://docs.python.org/3/library/importlib.html#importlib.abc.InspectLoader.load_module + name: load_module + uid: importlib.abc.InspectLoader.load_module +- fullName: importlib.abc.InspectLoader.source_to_code + href: https://docs.python.org/3/library/importlib.html#importlib.abc.InspectLoader.source_to_code + name: source_to_code + uid: importlib.abc.InspectLoader.source_to_code +- fullName: importlib.abc.Loader.create_module + href: https://docs.python.org/3/library/importlib.html#importlib.abc.Loader.create_module + name: create_module + uid: importlib.abc.Loader.create_module +- fullName: importlib.abc.Loader.exec_module + href: https://docs.python.org/3/library/importlib.html#importlib.abc.Loader.exec_module + name: exec_module + uid: importlib.abc.Loader.exec_module +- fullName: importlib.abc.Loader.load_module + href: https://docs.python.org/3/library/importlib.html#importlib.abc.Loader.load_module + name: load_module + uid: importlib.abc.Loader.load_module +- fullName: importlib.abc.MetaPathFinder.find_spec + href: https://docs.python.org/3/library/importlib.html#importlib.abc.MetaPathFinder.find_spec + name: find_spec + uid: importlib.abc.MetaPathFinder.find_spec +- fullName: importlib.abc.MetaPathFinder.invalidate_caches + href: https://docs.python.org/3/library/importlib.html#importlib.abc.MetaPathFinder.invalidate_caches + name: invalidate_caches + uid: importlib.abc.MetaPathFinder.invalidate_caches +- fullName: importlib.abc.PathEntryFinder.find_spec + href: https://docs.python.org/3/library/importlib.html#importlib.abc.PathEntryFinder.find_spec + name: find_spec + uid: importlib.abc.PathEntryFinder.find_spec +- fullName: importlib.abc.PathEntryFinder.invalidate_caches + href: https://docs.python.org/3/library/importlib.html#importlib.abc.PathEntryFinder.invalidate_caches + name: invalidate_caches + uid: importlib.abc.PathEntryFinder.invalidate_caches +- fullName: importlib.abc.ResourceLoader.get_data + href: https://docs.python.org/3/library/importlib.html#importlib.abc.ResourceLoader.get_data + name: get_data + uid: importlib.abc.ResourceLoader.get_data +- fullName: importlib.abc.ResourceReader.contents + href: https://docs.python.org/3/library/importlib.html#importlib.abc.ResourceReader.contents + name: contents + uid: importlib.abc.ResourceReader.contents +- fullName: importlib.abc.ResourceReader.is_resource + href: https://docs.python.org/3/library/importlib.html#importlib.abc.ResourceReader.is_resource + name: is_resource + uid: importlib.abc.ResourceReader.is_resource +- fullName: importlib.abc.ResourceReader.open_resource + href: https://docs.python.org/3/library/importlib.html#importlib.abc.ResourceReader.open_resource + name: open_resource + uid: importlib.abc.ResourceReader.open_resource +- fullName: importlib.abc.ResourceReader.resource_path + href: https://docs.python.org/3/library/importlib.html#importlib.abc.ResourceReader.resource_path + name: resource_path + uid: importlib.abc.ResourceReader.resource_path +- fullName: importlib.abc.SourceLoader.exec_module + href: https://docs.python.org/3/library/importlib.html#importlib.abc.SourceLoader.exec_module + name: exec_module + uid: importlib.abc.SourceLoader.exec_module +- fullName: importlib.abc.SourceLoader.get_code + href: https://docs.python.org/3/library/importlib.html#importlib.abc.SourceLoader.get_code + name: get_code + uid: importlib.abc.SourceLoader.get_code +- fullName: importlib.abc.SourceLoader.get_source + href: https://docs.python.org/3/library/importlib.html#importlib.abc.SourceLoader.get_source + name: get_source + uid: importlib.abc.SourceLoader.get_source +- fullName: importlib.abc.SourceLoader.is_package + href: https://docs.python.org/3/library/importlib.html#importlib.abc.SourceLoader.is_package + name: is_package + uid: importlib.abc.SourceLoader.is_package +- fullName: importlib.abc.SourceLoader.load_module + href: https://docs.python.org/3/library/importlib.html#importlib.abc.SourceLoader.load_module + name: load_module + uid: importlib.abc.SourceLoader.load_module +- fullName: importlib.abc.SourceLoader.path_mtime + href: https://docs.python.org/3/library/importlib.html#importlib.abc.SourceLoader.path_mtime + name: path_mtime + uid: importlib.abc.SourceLoader.path_mtime +- fullName: importlib.abc.SourceLoader.path_stats + href: https://docs.python.org/3/library/importlib.html#importlib.abc.SourceLoader.path_stats + name: path_stats + uid: importlib.abc.SourceLoader.path_stats +- fullName: importlib.abc.SourceLoader.set_data + href: https://docs.python.org/3/library/importlib.html#importlib.abc.SourceLoader.set_data + name: set_data + uid: importlib.abc.SourceLoader.set_data +- fullName: importlib.abc.Traversable.__truediv__ + href: https://docs.python.org/3/library/importlib.html#importlib.abc.Traversable.__truediv__ + name: __truediv__ + uid: importlib.abc.Traversable.__truediv__ +- fullName: importlib.abc.Traversable.is_dir + href: https://docs.python.org/3/library/importlib.html#importlib.abc.Traversable.is_dir + name: is_dir + uid: importlib.abc.Traversable.is_dir +- fullName: importlib.abc.Traversable.is_file + href: https://docs.python.org/3/library/importlib.html#importlib.abc.Traversable.is_file + name: is_file + uid: importlib.abc.Traversable.is_file +- fullName: importlib.abc.Traversable.iterdir + href: https://docs.python.org/3/library/importlib.html#importlib.abc.Traversable.iterdir + name: iterdir + uid: importlib.abc.Traversable.iterdir +- fullName: importlib.abc.Traversable.joinpath + href: https://docs.python.org/3/library/importlib.html#importlib.abc.Traversable.joinpath + name: joinpath + uid: importlib.abc.Traversable.joinpath +- fullName: importlib.abc.Traversable.open + href: https://docs.python.org/3/library/importlib.html#importlib.abc.Traversable.open + name: open + uid: importlib.abc.Traversable.open +- fullName: importlib.abc.Traversable.read_bytes + href: https://docs.python.org/3/library/importlib.html#importlib.abc.Traversable.read_bytes + name: read_bytes + uid: importlib.abc.Traversable.read_bytes +- fullName: importlib.abc.Traversable.read_text + href: https://docs.python.org/3/library/importlib.html#importlib.abc.Traversable.read_text + name: read_text + uid: importlib.abc.Traversable.read_text +- fullName: importlib.abc.TraversableResources.files + href: https://docs.python.org/3/library/importlib.html#importlib.abc.TraversableResources.files + name: files + uid: importlib.abc.TraversableResources.files +- fullName: importlib.machinery.ExtensionFileLoader.create_module + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.ExtensionFileLoader.create_module + name: create_module + uid: importlib.machinery.ExtensionFileLoader.create_module +- fullName: importlib.machinery.ExtensionFileLoader.exec_module + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.ExtensionFileLoader.exec_module + name: exec_module + uid: importlib.machinery.ExtensionFileLoader.exec_module +- fullName: importlib.machinery.ExtensionFileLoader.get_code + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.ExtensionFileLoader.get_code + name: get_code + uid: importlib.machinery.ExtensionFileLoader.get_code +- fullName: importlib.machinery.ExtensionFileLoader.get_filename + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.ExtensionFileLoader.get_filename + name: get_filename + uid: importlib.machinery.ExtensionFileLoader.get_filename +- fullName: importlib.machinery.ExtensionFileLoader.get_source + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.ExtensionFileLoader.get_source + name: get_source + uid: importlib.machinery.ExtensionFileLoader.get_source +- fullName: importlib.machinery.ExtensionFileLoader.is_package + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.ExtensionFileLoader.is_package + name: is_package + uid: importlib.machinery.ExtensionFileLoader.is_package +- fullName: importlib.machinery.FileFinder.find_spec + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.FileFinder.find_spec + name: find_spec + uid: importlib.machinery.FileFinder.find_spec +- fullName: importlib.machinery.FileFinder.invalidate_caches + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.FileFinder.invalidate_caches + name: invalidate_caches + uid: importlib.machinery.FileFinder.invalidate_caches +- fullName: importlib.machinery.FileFinder.path_hook + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.FileFinder.path_hook + name: path_hook + uid: importlib.machinery.FileFinder.path_hook +- fullName: importlib.machinery.PathFinder.find_spec + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.PathFinder.find_spec + name: find_spec + uid: importlib.machinery.PathFinder.find_spec +- fullName: importlib.machinery.PathFinder.invalidate_caches + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.PathFinder.invalidate_caches + name: invalidate_caches + uid: importlib.machinery.PathFinder.invalidate_caches +- fullName: importlib.machinery.SourceFileLoader.is_package + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.SourceFileLoader.is_package + name: is_package + uid: importlib.machinery.SourceFileLoader.is_package +- fullName: importlib.machinery.SourceFileLoader.load_module + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.SourceFileLoader.load_module + name: load_module + uid: importlib.machinery.SourceFileLoader.load_module +- fullName: importlib.machinery.SourceFileLoader.path_stats + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.SourceFileLoader.path_stats + name: path_stats + uid: importlib.machinery.SourceFileLoader.path_stats +- fullName: importlib.machinery.SourceFileLoader.set_data + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.SourceFileLoader.set_data + name: set_data + uid: importlib.machinery.SourceFileLoader.set_data +- fullName: importlib.machinery.SourcelessFileLoader.get_code + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.SourcelessFileLoader.get_code + name: get_code + uid: importlib.machinery.SourcelessFileLoader.get_code +- fullName: importlib.machinery.SourcelessFileLoader.get_source + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.SourcelessFileLoader.get_source + name: get_source + uid: importlib.machinery.SourcelessFileLoader.get_source +- fullName: importlib.machinery.SourcelessFileLoader.is_package + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.SourcelessFileLoader.is_package + name: is_package + uid: importlib.machinery.SourcelessFileLoader.is_package +- fullName: importlib.machinery.SourcelessFileLoader.load_module + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.SourcelessFileLoader.load_module + name: load_module + uid: importlib.machinery.SourcelessFileLoader.load_module +- fullName: importlib.resources.abc.ResourceReader.contents + href: https://docs.python.org/3/library/importlib.resources.abc.html#importlib.resources.abc.ResourceReader.contents + name: contents + uid: importlib.resources.abc.ResourceReader.contents +- fullName: importlib.resources.abc.ResourceReader.is_resource + href: https://docs.python.org/3/library/importlib.resources.abc.html#importlib.resources.abc.ResourceReader.is_resource + name: is_resource + uid: importlib.resources.abc.ResourceReader.is_resource +- fullName: importlib.resources.abc.ResourceReader.open_resource + href: https://docs.python.org/3/library/importlib.resources.abc.html#importlib.resources.abc.ResourceReader.open_resource + name: open_resource + uid: importlib.resources.abc.ResourceReader.open_resource +- fullName: importlib.resources.abc.ResourceReader.resource_path + href: https://docs.python.org/3/library/importlib.resources.abc.html#importlib.resources.abc.ResourceReader.resource_path + name: resource_path + uid: importlib.resources.abc.ResourceReader.resource_path +- fullName: importlib.resources.abc.Traversable.__truediv__ + href: https://docs.python.org/3/library/importlib.resources.abc.html#importlib.resources.abc.Traversable.__truediv__ + name: __truediv__ + uid: importlib.resources.abc.Traversable.__truediv__ +- fullName: importlib.resources.abc.Traversable.is_dir + href: https://docs.python.org/3/library/importlib.resources.abc.html#importlib.resources.abc.Traversable.is_dir + name: is_dir + uid: importlib.resources.abc.Traversable.is_dir +- fullName: importlib.resources.abc.Traversable.is_file + href: https://docs.python.org/3/library/importlib.resources.abc.html#importlib.resources.abc.Traversable.is_file + name: is_file + uid: importlib.resources.abc.Traversable.is_file +- fullName: importlib.resources.abc.Traversable.iterdir + href: https://docs.python.org/3/library/importlib.resources.abc.html#importlib.resources.abc.Traversable.iterdir + name: iterdir + uid: importlib.resources.abc.Traversable.iterdir +- fullName: importlib.resources.abc.Traversable.joinpath + href: https://docs.python.org/3/library/importlib.resources.abc.html#importlib.resources.abc.Traversable.joinpath + name: joinpath + uid: importlib.resources.abc.Traversable.joinpath +- fullName: importlib.resources.abc.Traversable.open + href: https://docs.python.org/3/library/importlib.resources.abc.html#importlib.resources.abc.Traversable.open + name: open + uid: importlib.resources.abc.Traversable.open +- fullName: importlib.resources.abc.Traversable.read_bytes + href: https://docs.python.org/3/library/importlib.resources.abc.html#importlib.resources.abc.Traversable.read_bytes + name: read_bytes + uid: importlib.resources.abc.Traversable.read_bytes +- fullName: importlib.resources.abc.Traversable.read_text + href: https://docs.python.org/3/library/importlib.resources.abc.html#importlib.resources.abc.Traversable.read_text + name: read_text + uid: importlib.resources.abc.Traversable.read_text +- fullName: importlib.resources.abc.TraversableResources.files + href: https://docs.python.org/3/library/importlib.resources.abc.html#importlib.resources.abc.TraversableResources.files + name: files + uid: importlib.resources.abc.TraversableResources.files +- fullName: importlib.util.LazyLoader.factory + href: https://docs.python.org/3/library/importlib.html#importlib.util.LazyLoader.factory + name: factory + uid: importlib.util.LazyLoader.factory +- fullName: inspect.BoundArguments.apply_defaults + href: https://docs.python.org/3/library/inspect.html#inspect.BoundArguments.apply_defaults + name: apply_defaults + uid: inspect.BoundArguments.apply_defaults +- fullName: inspect.Parameter.replace + href: https://docs.python.org/3/library/inspect.html#inspect.Parameter.replace + name: replace + uid: inspect.Parameter.replace +- fullName: inspect.Signature.bind + href: https://docs.python.org/3/library/inspect.html#inspect.Signature.bind + name: bind + uid: inspect.Signature.bind +- fullName: inspect.Signature.bind_partial + href: https://docs.python.org/3/library/inspect.html#inspect.Signature.bind_partial + name: bind_partial + uid: inspect.Signature.bind_partial +- fullName: inspect.Signature.format + href: https://docs.python.org/3/library/inspect.html#inspect.Signature.format + name: format + uid: inspect.Signature.format +- fullName: inspect.Signature.from_callable + href: https://docs.python.org/3/library/inspect.html#inspect.Signature.from_callable + name: from_callable + uid: inspect.Signature.from_callable +- fullName: inspect.Signature.replace + href: https://docs.python.org/3/library/inspect.html#inspect.Signature.replace + name: replace + uid: inspect.Signature.replace +- fullName: int.as_integer_ratio + href: https://docs.python.org/3/library/stdtypes.html#int.as_integer_ratio + name: as_integer_ratio + uid: int.as_integer_ratio +- fullName: int.bit_count + href: https://docs.python.org/3/library/stdtypes.html#int.bit_count + name: bit_count + uid: int.bit_count +- fullName: int.bit_length + href: https://docs.python.org/3/library/stdtypes.html#int.bit_length + name: bit_length + uid: int.bit_length +- fullName: int.from_bytes + href: https://docs.python.org/3/library/stdtypes.html#int.from_bytes + name: from_bytes + uid: int.from_bytes +- fullName: int.is_integer + href: https://docs.python.org/3/library/stdtypes.html#int.is_integer + name: is_integer + uid: int.is_integer +- fullName: int.to_bytes + href: https://docs.python.org/3/library/stdtypes.html#int.to_bytes + name: to_bytes + uid: int.to_bytes +- fullName: io.BufferedIOBase.detach + href: https://docs.python.org/3/library/io.html#io.BufferedIOBase.detach + name: detach + uid: io.BufferedIOBase.detach +- fullName: io.BufferedIOBase.read + href: https://docs.python.org/3/library/io.html#io.BufferedIOBase.read + name: read + uid: io.BufferedIOBase.read +- fullName: io.BufferedIOBase.read1 + href: https://docs.python.org/3/library/io.html#io.BufferedIOBase.read1 + name: read1 + uid: io.BufferedIOBase.read1 +- fullName: io.BufferedIOBase.readinto + href: https://docs.python.org/3/library/io.html#io.BufferedIOBase.readinto + name: readinto + uid: io.BufferedIOBase.readinto +- fullName: io.BufferedIOBase.readinto1 + href: https://docs.python.org/3/library/io.html#io.BufferedIOBase.readinto1 + name: readinto1 + uid: io.BufferedIOBase.readinto1 +- fullName: io.BufferedIOBase.write + href: https://docs.python.org/3/library/io.html#io.BufferedIOBase.write + name: write + uid: io.BufferedIOBase.write +- fullName: io.BufferedReader.peek + href: https://docs.python.org/3/library/io.html#io.BufferedReader.peek + name: peek + uid: io.BufferedReader.peek +- fullName: io.BufferedReader.read + href: https://docs.python.org/3/library/io.html#io.BufferedReader.read + name: read + uid: io.BufferedReader.read +- fullName: io.BufferedReader.read1 + href: https://docs.python.org/3/library/io.html#io.BufferedReader.read1 + name: read1 + uid: io.BufferedReader.read1 +- fullName: io.BufferedWriter.flush + href: https://docs.python.org/3/library/io.html#io.BufferedWriter.flush + name: flush + uid: io.BufferedWriter.flush +- fullName: io.BufferedWriter.write + href: https://docs.python.org/3/library/io.html#io.BufferedWriter.write + name: write + uid: io.BufferedWriter.write +- fullName: io.BytesIO.getbuffer + href: https://docs.python.org/3/library/io.html#io.BytesIO.getbuffer + name: getbuffer + uid: io.BytesIO.getbuffer +- fullName: io.BytesIO.getvalue + href: https://docs.python.org/3/library/io.html#io.BytesIO.getvalue + name: getvalue + uid: io.BytesIO.getvalue +- fullName: io.BytesIO.read1 + href: https://docs.python.org/3/library/io.html#io.BytesIO.read1 + name: read1 + uid: io.BytesIO.read1 +- fullName: io.BytesIO.readinto1 + href: https://docs.python.org/3/library/io.html#io.BytesIO.readinto1 + name: readinto1 + uid: io.BytesIO.readinto1 +- fullName: io.IOBase.__del__ + href: https://docs.python.org/3/library/io.html#io.IOBase.__del__ + name: __del__ + uid: io.IOBase.__del__ +- fullName: io.IOBase.close + href: https://docs.python.org/3/library/io.html#io.IOBase.close + name: close + uid: io.IOBase.close +- fullName: io.IOBase.fileno + href: https://docs.python.org/3/library/io.html#io.IOBase.fileno + name: fileno + uid: io.IOBase.fileno +- fullName: io.IOBase.flush + href: https://docs.python.org/3/library/io.html#io.IOBase.flush + name: flush + uid: io.IOBase.flush +- fullName: io.IOBase.isatty + href: https://docs.python.org/3/library/io.html#io.IOBase.isatty + name: isatty + uid: io.IOBase.isatty +- fullName: io.IOBase.readable + href: https://docs.python.org/3/library/io.html#io.IOBase.readable + name: readable + uid: io.IOBase.readable +- fullName: io.IOBase.readline + href: https://docs.python.org/3/library/io.html#io.IOBase.readline + name: readline + uid: io.IOBase.readline +- fullName: io.IOBase.readlines + href: https://docs.python.org/3/library/io.html#io.IOBase.readlines + name: readlines + uid: io.IOBase.readlines +- fullName: io.IOBase.seek + href: https://docs.python.org/3/library/io.html#io.IOBase.seek + name: seek + uid: io.IOBase.seek +- fullName: io.IOBase.seekable + href: https://docs.python.org/3/library/io.html#io.IOBase.seekable + name: seekable + uid: io.IOBase.seekable +- fullName: io.IOBase.tell + href: https://docs.python.org/3/library/io.html#io.IOBase.tell + name: tell + uid: io.IOBase.tell +- fullName: io.IOBase.truncate + href: https://docs.python.org/3/library/io.html#io.IOBase.truncate + name: truncate + uid: io.IOBase.truncate +- fullName: io.IOBase.writable + href: https://docs.python.org/3/library/io.html#io.IOBase.writable + name: writable + uid: io.IOBase.writable +- fullName: io.IOBase.writelines + href: https://docs.python.org/3/library/io.html#io.IOBase.writelines + name: writelines + uid: io.IOBase.writelines +- fullName: io.RawIOBase.read + href: https://docs.python.org/3/library/io.html#io.RawIOBase.read + name: read + uid: io.RawIOBase.read +- fullName: io.RawIOBase.readall + href: https://docs.python.org/3/library/io.html#io.RawIOBase.readall + name: readall + uid: io.RawIOBase.readall +- fullName: io.RawIOBase.readinto + href: https://docs.python.org/3/library/io.html#io.RawIOBase.readinto + name: readinto + uid: io.RawIOBase.readinto +- fullName: io.RawIOBase.write + href: https://docs.python.org/3/library/io.html#io.RawIOBase.write + name: write + uid: io.RawIOBase.write +- fullName: io.StringIO.getvalue + href: https://docs.python.org/3/library/io.html#io.StringIO.getvalue + name: getvalue + uid: io.StringIO.getvalue +- fullName: io.TextIOBase.detach + href: https://docs.python.org/3/library/io.html#io.TextIOBase.detach + name: detach + uid: io.TextIOBase.detach +- fullName: io.TextIOBase.read + href: https://docs.python.org/3/library/io.html#io.TextIOBase.read + name: read + uid: io.TextIOBase.read +- fullName: io.TextIOBase.readline + href: https://docs.python.org/3/library/io.html#io.TextIOBase.readline + name: readline + uid: io.TextIOBase.readline +- fullName: io.TextIOBase.seek + href: https://docs.python.org/3/library/io.html#io.TextIOBase.seek + name: seek + uid: io.TextIOBase.seek +- fullName: io.TextIOBase.tell + href: https://docs.python.org/3/library/io.html#io.TextIOBase.tell + name: tell + uid: io.TextIOBase.tell +- fullName: io.TextIOBase.write + href: https://docs.python.org/3/library/io.html#io.TextIOBase.write + name: write + uid: io.TextIOBase.write +- fullName: io.TextIOWrapper.reconfigure + href: https://docs.python.org/3/library/io.html#io.TextIOWrapper.reconfigure + name: reconfigure + uid: io.TextIOWrapper.reconfigure +- fullName: io.TextIOWrapper.seek + href: https://docs.python.org/3/library/io.html#io.TextIOWrapper.seek + name: seek + uid: io.TextIOWrapper.seek +- fullName: io.TextIOWrapper.tell + href: https://docs.python.org/3/library/io.html#io.TextIOWrapper.tell + name: tell + uid: io.TextIOWrapper.tell +- fullName: ipaddress.IPv4Address.__format__ + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Address.__format__ + name: __format__ + uid: ipaddress.IPv4Address.__format__ +- fullName: ipaddress.IPv4Network.address_exclude + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.address_exclude + name: address_exclude + uid: ipaddress.IPv4Network.address_exclude +- fullName: ipaddress.IPv4Network.compare_networks + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.compare_networks + name: compare_networks + uid: ipaddress.IPv4Network.compare_networks +- fullName: ipaddress.IPv4Network.hosts + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.hosts + name: hosts + uid: ipaddress.IPv4Network.hosts +- fullName: ipaddress.IPv4Network.overlaps + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.overlaps + name: overlaps + uid: ipaddress.IPv4Network.overlaps +- fullName: ipaddress.IPv4Network.subnet_of + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.subnet_of + name: subnet_of + uid: ipaddress.IPv4Network.subnet_of +- fullName: ipaddress.IPv4Network.subnets + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.subnets + name: subnets + uid: ipaddress.IPv4Network.subnets +- fullName: ipaddress.IPv4Network.supernet + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.supernet + name: supernet + uid: ipaddress.IPv4Network.supernet +- fullName: ipaddress.IPv4Network.supernet_of + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network.supernet_of + name: supernet_of + uid: ipaddress.IPv4Network.supernet_of +- fullName: ipaddress.IPv6Address.__format__ + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Address.__format__ + name: __format__ + uid: ipaddress.IPv6Address.__format__ +- fullName: ipaddress.IPv6Network.address_exclude + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.address_exclude + name: address_exclude + uid: ipaddress.IPv6Network.address_exclude +- fullName: ipaddress.IPv6Network.compare_networks + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.compare_networks + name: compare_networks + uid: ipaddress.IPv6Network.compare_networks +- fullName: ipaddress.IPv6Network.hosts + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.hosts + name: hosts + uid: ipaddress.IPv6Network.hosts +- fullName: ipaddress.IPv6Network.overlaps + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.overlaps + name: overlaps + uid: ipaddress.IPv6Network.overlaps +- fullName: ipaddress.IPv6Network.subnet_of + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.subnet_of + name: subnet_of + uid: ipaddress.IPv6Network.subnet_of +- fullName: ipaddress.IPv6Network.subnets + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.subnets + name: subnets + uid: ipaddress.IPv6Network.subnets +- fullName: ipaddress.IPv6Network.supernet + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.supernet + name: supernet + uid: ipaddress.IPv6Network.supernet +- fullName: ipaddress.IPv6Network.supernet_of + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network.supernet_of + name: supernet_of + uid: ipaddress.IPv6Network.supernet_of +- fullName: iterator.__iter__ + href: https://docs.python.org/3/library/stdtypes.html#iterator.__iter__ + name: __iter__ + uid: iterator.__iter__ +- fullName: iterator.__next__ + href: https://docs.python.org/3/library/stdtypes.html#iterator.__next__ + name: __next__ + uid: iterator.__next__ +- fullName: itertools.chain.from_iterable + href: https://docs.python.org/3/library/itertools.html#itertools.chain.from_iterable + name: from_iterable + uid: itertools.chain.from_iterable +- fullName: json.JSONDecoder.decode + href: https://docs.python.org/3/library/json.html#json.JSONDecoder.decode + name: decode + uid: json.JSONDecoder.decode +- fullName: json.JSONDecoder.raw_decode + href: https://docs.python.org/3/library/json.html#json.JSONDecoder.raw_decode + name: raw_decode + uid: json.JSONDecoder.raw_decode +- fullName: json.JSONEncoder.default + href: https://docs.python.org/3/library/json.html#json.JSONEncoder.default + name: default + uid: json.JSONEncoder.default +- fullName: json.JSONEncoder.encode + href: https://docs.python.org/3/library/json.html#json.JSONEncoder.encode + name: encode + uid: json.JSONEncoder.encode +- fullName: json.JSONEncoder.iterencode + href: https://docs.python.org/3/library/json.html#json.JSONEncoder.iterencode + name: iterencode + uid: json.JSONEncoder.iterencode +- fullName: list.sort + href: https://docs.python.org/3/library/stdtypes.html#list.sort + name: sort + uid: list.sort +- fullName: logging.BufferingFormatter.format + href: https://docs.python.org/3/library/logging.html#logging.BufferingFormatter.format + name: format + uid: logging.BufferingFormatter.format +- fullName: logging.BufferingFormatter.formatFooter + href: https://docs.python.org/3/library/logging.html#logging.BufferingFormatter.formatFooter + name: formatFooter + uid: logging.BufferingFormatter.formatFooter +- fullName: logging.BufferingFormatter.formatHeader + href: https://docs.python.org/3/library/logging.html#logging.BufferingFormatter.formatHeader + name: formatHeader + uid: logging.BufferingFormatter.formatHeader +- fullName: logging.FileHandler.close + href: https://docs.python.org/3/library/logging.handlers.html#logging.FileHandler.close + name: close + uid: logging.FileHandler.close +- fullName: logging.FileHandler.emit + href: https://docs.python.org/3/library/logging.handlers.html#logging.FileHandler.emit + name: emit + uid: logging.FileHandler.emit +- fullName: logging.Filter.filter + href: https://docs.python.org/3/library/logging.html#logging.Filter.filter + name: filter + uid: logging.Filter.filter +- fullName: logging.Formatter.format + href: https://docs.python.org/3/library/logging.html#logging.Formatter.format + name: format + uid: logging.Formatter.format +- fullName: logging.Formatter.formatException + href: https://docs.python.org/3/library/logging.html#logging.Formatter.formatException + name: formatException + uid: logging.Formatter.formatException +- fullName: logging.Formatter.formatStack + href: https://docs.python.org/3/library/logging.html#logging.Formatter.formatStack + name: formatStack + uid: logging.Formatter.formatStack +- fullName: logging.Formatter.formatTime + href: https://docs.python.org/3/library/logging.html#logging.Formatter.formatTime + name: formatTime + uid: logging.Formatter.formatTime +- fullName: logging.Handler.__init__ + href: https://docs.python.org/3/library/logging.html#logging.Handler.__init__ + name: __init__ + uid: logging.Handler.__init__ +- fullName: logging.Handler.acquire + href: https://docs.python.org/3/library/logging.html#logging.Handler.acquire + name: acquire + uid: logging.Handler.acquire +- fullName: logging.Handler.addFilter + href: https://docs.python.org/3/library/logging.html#logging.Handler.addFilter + name: addFilter + uid: logging.Handler.addFilter +- fullName: logging.Handler.close + href: https://docs.python.org/3/library/logging.html#logging.Handler.close + name: close + uid: logging.Handler.close +- fullName: logging.Handler.createLock + href: https://docs.python.org/3/library/logging.html#logging.Handler.createLock + name: createLock + uid: logging.Handler.createLock +- fullName: logging.Handler.emit + href: https://docs.python.org/3/library/logging.html#logging.Handler.emit + name: emit + uid: logging.Handler.emit +- fullName: logging.Handler.filter + href: https://docs.python.org/3/library/logging.html#logging.Handler.filter + name: filter + uid: logging.Handler.filter +- fullName: logging.Handler.flush + href: https://docs.python.org/3/library/logging.html#logging.Handler.flush + name: flush + uid: logging.Handler.flush +- fullName: logging.Handler.format + href: https://docs.python.org/3/library/logging.html#logging.Handler.format + name: format + uid: logging.Handler.format +- fullName: logging.Handler.handle + href: https://docs.python.org/3/library/logging.html#logging.Handler.handle + name: handle + uid: logging.Handler.handle +- fullName: logging.Handler.handleError + href: https://docs.python.org/3/library/logging.html#logging.Handler.handleError + name: handleError + uid: logging.Handler.handleError +- fullName: logging.Handler.release + href: https://docs.python.org/3/library/logging.html#logging.Handler.release + name: release + uid: logging.Handler.release +- fullName: logging.Handler.removeFilter + href: https://docs.python.org/3/library/logging.html#logging.Handler.removeFilter + name: removeFilter + uid: logging.Handler.removeFilter +- fullName: logging.Handler.setFormatter + href: https://docs.python.org/3/library/logging.html#logging.Handler.setFormatter + name: setFormatter + uid: logging.Handler.setFormatter +- fullName: logging.Handler.setLevel + href: https://docs.python.org/3/library/logging.html#logging.Handler.setLevel + name: setLevel + uid: logging.Handler.setLevel +- fullName: logging.LogRecord.getMessage + href: https://docs.python.org/3/library/logging.html#logging.LogRecord.getMessage + name: getMessage + uid: logging.LogRecord.getMessage +- fullName: logging.Logger.addFilter + href: https://docs.python.org/3/library/logging.html#logging.Logger.addFilter + name: addFilter + uid: logging.Logger.addFilter +- fullName: logging.Logger.addHandler + href: https://docs.python.org/3/library/logging.html#logging.Logger.addHandler + name: addHandler + uid: logging.Logger.addHandler +- fullName: logging.Logger.critical + href: https://docs.python.org/3/library/logging.html#logging.Logger.critical + name: critical + uid: logging.Logger.critical +- fullName: logging.Logger.debug + href: https://docs.python.org/3/library/logging.html#logging.Logger.debug + name: debug + uid: logging.Logger.debug +- fullName: logging.Logger.error + href: https://docs.python.org/3/library/logging.html#logging.Logger.error + name: error + uid: logging.Logger.error +- fullName: logging.Logger.exception + href: https://docs.python.org/3/library/logging.html#logging.Logger.exception + name: exception + uid: logging.Logger.exception +- fullName: logging.Logger.filter + href: https://docs.python.org/3/library/logging.html#logging.Logger.filter + name: filter + uid: logging.Logger.filter +- fullName: logging.Logger.findCaller + href: https://docs.python.org/3/library/logging.html#logging.Logger.findCaller + name: findCaller + uid: logging.Logger.findCaller +- fullName: logging.Logger.getChild + href: https://docs.python.org/3/library/logging.html#logging.Logger.getChild + name: getChild + uid: logging.Logger.getChild +- fullName: logging.Logger.getChildren + href: https://docs.python.org/3/library/logging.html#logging.Logger.getChildren + name: getChildren + uid: logging.Logger.getChildren +- fullName: logging.Logger.getEffectiveLevel + href: https://docs.python.org/3/library/logging.html#logging.Logger.getEffectiveLevel + name: getEffectiveLevel + uid: logging.Logger.getEffectiveLevel +- fullName: logging.Logger.handle + href: https://docs.python.org/3/library/logging.html#logging.Logger.handle + name: handle + uid: logging.Logger.handle +- fullName: logging.Logger.hasHandlers + href: https://docs.python.org/3/library/logging.html#logging.Logger.hasHandlers + name: hasHandlers + uid: logging.Logger.hasHandlers +- fullName: logging.Logger.info + href: https://docs.python.org/3/library/logging.html#logging.Logger.info + name: info + uid: logging.Logger.info +- fullName: logging.Logger.isEnabledFor + href: https://docs.python.org/3/library/logging.html#logging.Logger.isEnabledFor + name: isEnabledFor + uid: logging.Logger.isEnabledFor +- fullName: logging.Logger.log + href: https://docs.python.org/3/library/logging.html#logging.Logger.log + name: log + uid: logging.Logger.log +- fullName: logging.Logger.makeRecord + href: https://docs.python.org/3/library/logging.html#logging.Logger.makeRecord + name: makeRecord + uid: logging.Logger.makeRecord +- fullName: logging.Logger.removeFilter + href: https://docs.python.org/3/library/logging.html#logging.Logger.removeFilter + name: removeFilter + uid: logging.Logger.removeFilter +- fullName: logging.Logger.removeHandler + href: https://docs.python.org/3/library/logging.html#logging.Logger.removeHandler + name: removeHandler + uid: logging.Logger.removeHandler +- fullName: logging.Logger.setLevel + href: https://docs.python.org/3/library/logging.html#logging.Logger.setLevel + name: setLevel + uid: logging.Logger.setLevel +- fullName: logging.Logger.warning + href: https://docs.python.org/3/library/logging.html#logging.Logger.warning + name: warning + uid: logging.Logger.warning +- fullName: logging.LoggerAdapter.process + href: https://docs.python.org/3/library/logging.html#logging.LoggerAdapter.process + name: process + uid: logging.LoggerAdapter.process +- fullName: logging.NullHandler.createLock + href: https://docs.python.org/3/library/logging.handlers.html#logging.NullHandler.createLock + name: createLock + uid: logging.NullHandler.createLock +- fullName: logging.NullHandler.emit + href: https://docs.python.org/3/library/logging.handlers.html#logging.NullHandler.emit + name: emit + uid: logging.NullHandler.emit +- fullName: logging.NullHandler.handle + href: https://docs.python.org/3/library/logging.handlers.html#logging.NullHandler.handle + name: handle + uid: logging.NullHandler.handle +- fullName: logging.StreamHandler.emit + href: https://docs.python.org/3/library/logging.handlers.html#logging.StreamHandler.emit + name: emit + uid: logging.StreamHandler.emit +- fullName: logging.StreamHandler.flush + href: https://docs.python.org/3/library/logging.handlers.html#logging.StreamHandler.flush + name: flush + uid: logging.StreamHandler.flush +- fullName: logging.StreamHandler.setStream + href: https://docs.python.org/3/library/logging.handlers.html#logging.StreamHandler.setStream + name: setStream + uid: logging.StreamHandler.setStream +- fullName: logging.handlers.BaseRotatingHandler.rotate + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.BaseRotatingHandler.rotate + name: rotate + uid: logging.handlers.BaseRotatingHandler.rotate +- fullName: logging.handlers.BaseRotatingHandler.rotation_filename + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.BaseRotatingHandler.rotation_filename + name: rotation_filename + uid: logging.handlers.BaseRotatingHandler.rotation_filename +- fullName: logging.handlers.BufferingHandler.emit + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.BufferingHandler.emit + name: emit + uid: logging.handlers.BufferingHandler.emit +- fullName: logging.handlers.BufferingHandler.flush + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.BufferingHandler.flush + name: flush + uid: logging.handlers.BufferingHandler.flush +- fullName: logging.handlers.BufferingHandler.shouldFlush + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.BufferingHandler.shouldFlush + name: shouldFlush + uid: logging.handlers.BufferingHandler.shouldFlush +- fullName: logging.handlers.DatagramHandler.emit + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.DatagramHandler.emit + name: emit + uid: logging.handlers.DatagramHandler.emit +- fullName: logging.handlers.DatagramHandler.makeSocket + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.DatagramHandler.makeSocket + name: makeSocket + uid: logging.handlers.DatagramHandler.makeSocket +- fullName: logging.handlers.DatagramHandler.send + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.DatagramHandler.send + name: send + uid: logging.handlers.DatagramHandler.send +- fullName: logging.handlers.HTTPHandler.emit + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.HTTPHandler.emit + name: emit + uid: logging.handlers.HTTPHandler.emit +- fullName: logging.handlers.HTTPHandler.mapLogRecord + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.HTTPHandler.mapLogRecord + name: mapLogRecord + uid: logging.handlers.HTTPHandler.mapLogRecord +- fullName: logging.handlers.MemoryHandler.close + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.MemoryHandler.close + name: close + uid: logging.handlers.MemoryHandler.close +- fullName: logging.handlers.MemoryHandler.flush + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.MemoryHandler.flush + name: flush + uid: logging.handlers.MemoryHandler.flush +- fullName: logging.handlers.MemoryHandler.setTarget + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.MemoryHandler.setTarget + name: setTarget + uid: logging.handlers.MemoryHandler.setTarget +- fullName: logging.handlers.MemoryHandler.shouldFlush + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.MemoryHandler.shouldFlush + name: shouldFlush + uid: logging.handlers.MemoryHandler.shouldFlush +- fullName: logging.handlers.NTEventLogHandler.close + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.NTEventLogHandler.close + name: close + uid: logging.handlers.NTEventLogHandler.close +- fullName: logging.handlers.NTEventLogHandler.emit + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.NTEventLogHandler.emit + name: emit + uid: logging.handlers.NTEventLogHandler.emit +- fullName: logging.handlers.NTEventLogHandler.getEventCategory + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.NTEventLogHandler.getEventCategory + name: getEventCategory + uid: logging.handlers.NTEventLogHandler.getEventCategory +- fullName: logging.handlers.NTEventLogHandler.getEventType + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.NTEventLogHandler.getEventType + name: getEventType + uid: logging.handlers.NTEventLogHandler.getEventType +- fullName: logging.handlers.NTEventLogHandler.getMessageID + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.NTEventLogHandler.getMessageID + name: getMessageID + uid: logging.handlers.NTEventLogHandler.getMessageID +- fullName: logging.handlers.QueueHandler.emit + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.QueueHandler.emit + name: emit + uid: logging.handlers.QueueHandler.emit +- fullName: logging.handlers.QueueHandler.enqueue + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.QueueHandler.enqueue + name: enqueue + uid: logging.handlers.QueueHandler.enqueue +- fullName: logging.handlers.QueueHandler.prepare + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.QueueHandler.prepare + name: prepare + uid: logging.handlers.QueueHandler.prepare +- fullName: logging.handlers.QueueListener.dequeue + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.QueueListener.dequeue + name: dequeue + uid: logging.handlers.QueueListener.dequeue +- fullName: logging.handlers.QueueListener.enqueue_sentinel + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.QueueListener.enqueue_sentinel + name: enqueue_sentinel + uid: logging.handlers.QueueListener.enqueue_sentinel +- fullName: logging.handlers.QueueListener.handle + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.QueueListener.handle + name: handle + uid: logging.handlers.QueueListener.handle +- fullName: logging.handlers.QueueListener.prepare + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.QueueListener.prepare + name: prepare + uid: logging.handlers.QueueListener.prepare +- fullName: logging.handlers.QueueListener.start + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.QueueListener.start + name: start + uid: logging.handlers.QueueListener.start +- fullName: logging.handlers.QueueListener.stop + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.QueueListener.stop + name: stop + uid: logging.handlers.QueueListener.stop +- fullName: logging.handlers.RotatingFileHandler.doRollover + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.RotatingFileHandler.doRollover + name: doRollover + uid: logging.handlers.RotatingFileHandler.doRollover +- fullName: logging.handlers.RotatingFileHandler.emit + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.RotatingFileHandler.emit + name: emit + uid: logging.handlers.RotatingFileHandler.emit +- fullName: logging.handlers.SMTPHandler.emit + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.SMTPHandler.emit + name: emit + uid: logging.handlers.SMTPHandler.emit +- fullName: logging.handlers.SMTPHandler.getSubject + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.SMTPHandler.getSubject + name: getSubject + uid: logging.handlers.SMTPHandler.getSubject +- fullName: logging.handlers.SocketHandler.close + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.SocketHandler.close + name: close + uid: logging.handlers.SocketHandler.close +- fullName: logging.handlers.SocketHandler.createSocket + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.SocketHandler.createSocket + name: createSocket + uid: logging.handlers.SocketHandler.createSocket +- fullName: logging.handlers.SocketHandler.emit + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.SocketHandler.emit + name: emit + uid: logging.handlers.SocketHandler.emit +- fullName: logging.handlers.SocketHandler.handleError + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.SocketHandler.handleError + name: handleError + uid: logging.handlers.SocketHandler.handleError +- fullName: logging.handlers.SocketHandler.makePickle + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.SocketHandler.makePickle + name: makePickle + uid: logging.handlers.SocketHandler.makePickle +- fullName: logging.handlers.SocketHandler.makeSocket + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.SocketHandler.makeSocket + name: makeSocket + uid: logging.handlers.SocketHandler.makeSocket +- fullName: logging.handlers.SocketHandler.send + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.SocketHandler.send + name: send + uid: logging.handlers.SocketHandler.send +- fullName: logging.handlers.SysLogHandler.close + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.SysLogHandler.close + name: close + uid: logging.handlers.SysLogHandler.close +- fullName: logging.handlers.SysLogHandler.createSocket + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.SysLogHandler.createSocket + name: createSocket + uid: logging.handlers.SysLogHandler.createSocket +- fullName: logging.handlers.SysLogHandler.emit + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.SysLogHandler.emit + name: emit + uid: logging.handlers.SysLogHandler.emit +- fullName: logging.handlers.SysLogHandler.encodePriority + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.SysLogHandler.encodePriority + name: encodePriority + uid: logging.handlers.SysLogHandler.encodePriority +- fullName: logging.handlers.SysLogHandler.mapPriority + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.SysLogHandler.mapPriority + name: mapPriority + uid: logging.handlers.SysLogHandler.mapPriority +- fullName: logging.handlers.TimedRotatingFileHandler.doRollover + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.TimedRotatingFileHandler.doRollover + name: doRollover + uid: logging.handlers.TimedRotatingFileHandler.doRollover +- fullName: logging.handlers.TimedRotatingFileHandler.emit + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.TimedRotatingFileHandler.emit + name: emit + uid: logging.handlers.TimedRotatingFileHandler.emit +- fullName: logging.handlers.TimedRotatingFileHandler.getFilesToDelete + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.TimedRotatingFileHandler.getFilesToDelete + name: getFilesToDelete + uid: logging.handlers.TimedRotatingFileHandler.getFilesToDelete +- fullName: logging.handlers.WatchedFileHandler.emit + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.WatchedFileHandler.emit + name: emit + uid: logging.handlers.WatchedFileHandler.emit +- fullName: logging.handlers.WatchedFileHandler.reopenIfNeeded + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.WatchedFileHandler.reopenIfNeeded + name: reopenIfNeeded + uid: logging.handlers.WatchedFileHandler.reopenIfNeeded +- fullName: logging.logging.Formatter.__init__ + href: https://docs.python.org/3/howto/logging.html#logging.logging.Formatter.__init__ + name: __init__ + uid: logging.logging.Formatter.__init__ +- fullName: lzma.LZMACompressor.compress + href: https://docs.python.org/3/library/lzma.html#lzma.LZMACompressor.compress + name: compress + uid: lzma.LZMACompressor.compress +- fullName: lzma.LZMACompressor.flush + href: https://docs.python.org/3/library/lzma.html#lzma.LZMACompressor.flush + name: flush + uid: lzma.LZMACompressor.flush +- fullName: lzma.LZMADecompressor.decompress + href: https://docs.python.org/3/library/lzma.html#lzma.LZMADecompressor.decompress + name: decompress + uid: lzma.LZMADecompressor.decompress +- fullName: lzma.LZMAFile.peek + href: https://docs.python.org/3/library/lzma.html#lzma.LZMAFile.peek + name: peek + uid: lzma.LZMAFile.peek +- fullName: mailbox.Babyl.get_file + href: https://docs.python.org/3/library/mailbox.html#mailbox.Babyl.get_file + name: get_file + uid: mailbox.Babyl.get_file +- fullName: mailbox.Babyl.get_labels + href: https://docs.python.org/3/library/mailbox.html#mailbox.Babyl.get_labels + name: get_labels + uid: mailbox.Babyl.get_labels +- fullName: mailbox.Babyl.lock + href: https://docs.python.org/3/library/mailbox.html#mailbox.Babyl.lock + name: lock + uid: mailbox.Babyl.lock +- fullName: mailbox.Babyl.unlock + href: https://docs.python.org/3/library/mailbox.html#mailbox.Babyl.unlock + name: unlock + uid: mailbox.Babyl.unlock +- fullName: mailbox.BabylMessage.add_label + href: https://docs.python.org/3/library/mailbox.html#mailbox.BabylMessage.add_label + name: add_label + uid: mailbox.BabylMessage.add_label +- fullName: mailbox.BabylMessage.get_labels + href: https://docs.python.org/3/library/mailbox.html#mailbox.BabylMessage.get_labels + name: get_labels + uid: mailbox.BabylMessage.get_labels +- fullName: mailbox.BabylMessage.get_visible + href: https://docs.python.org/3/library/mailbox.html#mailbox.BabylMessage.get_visible + name: get_visible + uid: mailbox.BabylMessage.get_visible +- fullName: mailbox.BabylMessage.remove_label + href: https://docs.python.org/3/library/mailbox.html#mailbox.BabylMessage.remove_label + name: remove_label + uid: mailbox.BabylMessage.remove_label +- fullName: mailbox.BabylMessage.set_labels + href: https://docs.python.org/3/library/mailbox.html#mailbox.BabylMessage.set_labels + name: set_labels + uid: mailbox.BabylMessage.set_labels +- fullName: mailbox.BabylMessage.set_visible + href: https://docs.python.org/3/library/mailbox.html#mailbox.BabylMessage.set_visible + name: set_visible + uid: mailbox.BabylMessage.set_visible +- fullName: mailbox.BabylMessage.update_visible + href: https://docs.python.org/3/library/mailbox.html#mailbox.BabylMessage.update_visible + name: update_visible + uid: mailbox.BabylMessage.update_visible +- fullName: mailbox.MH.__delitem__ + href: https://docs.python.org/3/library/mailbox.html#mailbox.MH.__delitem__ + name: __delitem__ + uid: mailbox.MH.__delitem__ +- fullName: mailbox.MH.add_folder + href: https://docs.python.org/3/library/mailbox.html#mailbox.MH.add_folder + name: add_folder + uid: mailbox.MH.add_folder +- fullName: mailbox.MH.close + href: https://docs.python.org/3/library/mailbox.html#mailbox.MH.close + name: close + uid: mailbox.MH.close +- fullName: mailbox.MH.discard + href: https://docs.python.org/3/library/mailbox.html#mailbox.MH.discard + name: discard + uid: mailbox.MH.discard +- fullName: mailbox.MH.flush + href: https://docs.python.org/3/library/mailbox.html#mailbox.MH.flush + name: flush + uid: mailbox.MH.flush +- fullName: mailbox.MH.get_file + href: https://docs.python.org/3/library/mailbox.html#mailbox.MH.get_file + name: get_file + uid: mailbox.MH.get_file +- fullName: mailbox.MH.get_folder + href: https://docs.python.org/3/library/mailbox.html#mailbox.MH.get_folder + name: get_folder + uid: mailbox.MH.get_folder +- fullName: mailbox.MH.get_sequences + href: https://docs.python.org/3/library/mailbox.html#mailbox.MH.get_sequences + name: get_sequences + uid: mailbox.MH.get_sequences +- fullName: mailbox.MH.list_folders + href: https://docs.python.org/3/library/mailbox.html#mailbox.MH.list_folders + name: list_folders + uid: mailbox.MH.list_folders +- fullName: mailbox.MH.lock + href: https://docs.python.org/3/library/mailbox.html#mailbox.MH.lock + name: lock + uid: mailbox.MH.lock +- fullName: mailbox.MH.pack + href: https://docs.python.org/3/library/mailbox.html#mailbox.MH.pack + name: pack + uid: mailbox.MH.pack +- fullName: mailbox.MH.remove + href: https://docs.python.org/3/library/mailbox.html#mailbox.MH.remove + name: remove + uid: mailbox.MH.remove +- fullName: mailbox.MH.remove_folder + href: https://docs.python.org/3/library/mailbox.html#mailbox.MH.remove_folder + name: remove_folder + uid: mailbox.MH.remove_folder +- fullName: mailbox.MH.set_sequences + href: https://docs.python.org/3/library/mailbox.html#mailbox.MH.set_sequences + name: set_sequences + uid: mailbox.MH.set_sequences +- fullName: mailbox.MH.unlock + href: https://docs.python.org/3/library/mailbox.html#mailbox.MH.unlock + name: unlock + uid: mailbox.MH.unlock +- fullName: mailbox.MHMessage.add_sequence + href: https://docs.python.org/3/library/mailbox.html#mailbox.MHMessage.add_sequence + name: add_sequence + uid: mailbox.MHMessage.add_sequence +- fullName: mailbox.MHMessage.get_sequences + href: https://docs.python.org/3/library/mailbox.html#mailbox.MHMessage.get_sequences + name: get_sequences + uid: mailbox.MHMessage.get_sequences +- fullName: mailbox.MHMessage.remove_sequence + href: https://docs.python.org/3/library/mailbox.html#mailbox.MHMessage.remove_sequence + name: remove_sequence + uid: mailbox.MHMessage.remove_sequence +- fullName: mailbox.MHMessage.set_sequences + href: https://docs.python.org/3/library/mailbox.html#mailbox.MHMessage.set_sequences + name: set_sequences + uid: mailbox.MHMessage.set_sequences +- fullName: mailbox.MMDF.get_bytes + href: https://docs.python.org/3/library/mailbox.html#mailbox.MMDF.get_bytes + name: get_bytes + uid: mailbox.MMDF.get_bytes +- fullName: mailbox.MMDF.get_file + href: https://docs.python.org/3/library/mailbox.html#mailbox.MMDF.get_file + name: get_file + uid: mailbox.MMDF.get_file +- fullName: mailbox.MMDF.lock + href: https://docs.python.org/3/library/mailbox.html#mailbox.MMDF.lock + name: lock + uid: mailbox.MMDF.lock +- fullName: mailbox.MMDF.unlock + href: https://docs.python.org/3/library/mailbox.html#mailbox.MMDF.unlock + name: unlock + uid: mailbox.MMDF.unlock +- fullName: mailbox.MMDFMessage.add_flag + href: https://docs.python.org/3/library/mailbox.html#mailbox.MMDFMessage.add_flag + name: add_flag + uid: mailbox.MMDFMessage.add_flag +- fullName: mailbox.MMDFMessage.get_flags + href: https://docs.python.org/3/library/mailbox.html#mailbox.MMDFMessage.get_flags + name: get_flags + uid: mailbox.MMDFMessage.get_flags +- fullName: mailbox.MMDFMessage.get_from + href: https://docs.python.org/3/library/mailbox.html#mailbox.MMDFMessage.get_from + name: get_from + uid: mailbox.MMDFMessage.get_from +- fullName: mailbox.MMDFMessage.remove_flag + href: https://docs.python.org/3/library/mailbox.html#mailbox.MMDFMessage.remove_flag + name: remove_flag + uid: mailbox.MMDFMessage.remove_flag +- fullName: mailbox.MMDFMessage.set_flags + href: https://docs.python.org/3/library/mailbox.html#mailbox.MMDFMessage.set_flags + name: set_flags + uid: mailbox.MMDFMessage.set_flags +- fullName: mailbox.MMDFMessage.set_from + href: https://docs.python.org/3/library/mailbox.html#mailbox.MMDFMessage.set_from + name: set_from + uid: mailbox.MMDFMessage.set_from +- fullName: mailbox.Mailbox.__contains__ + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.__contains__ + name: __contains__ + uid: mailbox.Mailbox.__contains__ +- fullName: mailbox.Mailbox.__delitem__ + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.__delitem__ + name: __delitem__ + uid: mailbox.Mailbox.__delitem__ +- fullName: mailbox.Mailbox.__getitem__ + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.__getitem__ + name: __getitem__ + uid: mailbox.Mailbox.__getitem__ +- fullName: mailbox.Mailbox.__iter__ + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.__iter__ + name: __iter__ + uid: mailbox.Mailbox.__iter__ +- fullName: mailbox.Mailbox.__len__ + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.__len__ + name: __len__ + uid: mailbox.Mailbox.__len__ +- fullName: mailbox.Mailbox.__setitem__ + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.__setitem__ + name: __setitem__ + uid: mailbox.Mailbox.__setitem__ +- fullName: mailbox.Mailbox.add + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.add + name: add + uid: mailbox.Mailbox.add +- fullName: mailbox.Mailbox.clear + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.clear + name: clear + uid: mailbox.Mailbox.clear +- fullName: mailbox.Mailbox.close + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.close + name: close + uid: mailbox.Mailbox.close +- fullName: mailbox.Mailbox.discard + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.discard + name: discard + uid: mailbox.Mailbox.discard +- fullName: mailbox.Mailbox.flush + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.flush + name: flush + uid: mailbox.Mailbox.flush +- fullName: mailbox.Mailbox.get + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.get + name: get + uid: mailbox.Mailbox.get +- fullName: mailbox.Mailbox.get_bytes + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.get_bytes + name: get_bytes + uid: mailbox.Mailbox.get_bytes +- fullName: mailbox.Mailbox.get_file + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.get_file + name: get_file + uid: mailbox.Mailbox.get_file +- fullName: mailbox.Mailbox.get_message + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.get_message + name: get_message + uid: mailbox.Mailbox.get_message +- fullName: mailbox.Mailbox.get_string + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.get_string + name: get_string + uid: mailbox.Mailbox.get_string +- fullName: mailbox.Mailbox.items + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.items + name: items + uid: mailbox.Mailbox.items +- fullName: mailbox.Mailbox.iteritems + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.iteritems + name: iteritems + uid: mailbox.Mailbox.iteritems +- fullName: mailbox.Mailbox.iterkeys + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.iterkeys + name: iterkeys + uid: mailbox.Mailbox.iterkeys +- fullName: mailbox.Mailbox.itervalues + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.itervalues + name: itervalues + uid: mailbox.Mailbox.itervalues +- fullName: mailbox.Mailbox.keys + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.keys + name: keys + uid: mailbox.Mailbox.keys +- fullName: mailbox.Mailbox.lock + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.lock + name: lock + uid: mailbox.Mailbox.lock +- fullName: mailbox.Mailbox.pop + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.pop + name: pop + uid: mailbox.Mailbox.pop +- fullName: mailbox.Mailbox.popitem + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.popitem + name: popitem + uid: mailbox.Mailbox.popitem +- fullName: mailbox.Mailbox.remove + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.remove + name: remove + uid: mailbox.Mailbox.remove +- fullName: mailbox.Mailbox.unlock + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.unlock + name: unlock + uid: mailbox.Mailbox.unlock +- fullName: mailbox.Mailbox.update + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.update + name: update + uid: mailbox.Mailbox.update +- fullName: mailbox.Mailbox.values + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox.values + name: values + uid: mailbox.Mailbox.values +- fullName: mailbox.Maildir.__setitem__ + href: https://docs.python.org/3/library/mailbox.html#mailbox.Maildir.__setitem__ + name: __setitem__ + uid: mailbox.Maildir.__setitem__ +- fullName: mailbox.Maildir.add + href: https://docs.python.org/3/library/mailbox.html#mailbox.Maildir.add + name: add + uid: mailbox.Maildir.add +- fullName: mailbox.Maildir.add_flag + href: https://docs.python.org/3/library/mailbox.html#mailbox.Maildir.add_flag + name: add_flag + uid: mailbox.Maildir.add_flag +- fullName: mailbox.Maildir.add_folder + href: https://docs.python.org/3/library/mailbox.html#mailbox.Maildir.add_folder + name: add_folder + uid: mailbox.Maildir.add_folder +- fullName: mailbox.Maildir.clean + href: https://docs.python.org/3/library/mailbox.html#mailbox.Maildir.clean + name: clean + uid: mailbox.Maildir.clean +- fullName: mailbox.Maildir.close + href: https://docs.python.org/3/library/mailbox.html#mailbox.Maildir.close + name: close + uid: mailbox.Maildir.close +- fullName: mailbox.Maildir.flush + href: https://docs.python.org/3/library/mailbox.html#mailbox.Maildir.flush + name: flush + uid: mailbox.Maildir.flush +- fullName: mailbox.Maildir.get_file + href: https://docs.python.org/3/library/mailbox.html#mailbox.Maildir.get_file + name: get_file + uid: mailbox.Maildir.get_file +- fullName: mailbox.Maildir.get_flags + href: https://docs.python.org/3/library/mailbox.html#mailbox.Maildir.get_flags + name: get_flags + uid: mailbox.Maildir.get_flags +- fullName: mailbox.Maildir.get_folder + href: https://docs.python.org/3/library/mailbox.html#mailbox.Maildir.get_folder + name: get_folder + uid: mailbox.Maildir.get_folder +- fullName: mailbox.Maildir.get_info + href: https://docs.python.org/3/library/mailbox.html#mailbox.Maildir.get_info + name: get_info + uid: mailbox.Maildir.get_info +- fullName: mailbox.Maildir.list_folders + href: https://docs.python.org/3/library/mailbox.html#mailbox.Maildir.list_folders + name: list_folders + uid: mailbox.Maildir.list_folders +- fullName: mailbox.Maildir.lock + href: https://docs.python.org/3/library/mailbox.html#mailbox.Maildir.lock + name: lock + uid: mailbox.Maildir.lock +- fullName: mailbox.Maildir.remove_flag + href: https://docs.python.org/3/library/mailbox.html#mailbox.Maildir.remove_flag + name: remove_flag + uid: mailbox.Maildir.remove_flag +- fullName: mailbox.Maildir.remove_folder + href: https://docs.python.org/3/library/mailbox.html#mailbox.Maildir.remove_folder + name: remove_folder + uid: mailbox.Maildir.remove_folder +- fullName: mailbox.Maildir.set_flags + href: https://docs.python.org/3/library/mailbox.html#mailbox.Maildir.set_flags + name: set_flags + uid: mailbox.Maildir.set_flags +- fullName: mailbox.Maildir.set_info + href: https://docs.python.org/3/library/mailbox.html#mailbox.Maildir.set_info + name: set_info + uid: mailbox.Maildir.set_info +- fullName: mailbox.Maildir.unlock + href: https://docs.python.org/3/library/mailbox.html#mailbox.Maildir.unlock + name: unlock + uid: mailbox.Maildir.unlock +- fullName: mailbox.Maildir.update + href: https://docs.python.org/3/library/mailbox.html#mailbox.Maildir.update + name: update + uid: mailbox.Maildir.update +- fullName: mailbox.MaildirMessage.add_flag + href: https://docs.python.org/3/library/mailbox.html#mailbox.MaildirMessage.add_flag + name: add_flag + uid: mailbox.MaildirMessage.add_flag +- fullName: mailbox.MaildirMessage.get_date + href: https://docs.python.org/3/library/mailbox.html#mailbox.MaildirMessage.get_date + name: get_date + uid: mailbox.MaildirMessage.get_date +- fullName: mailbox.MaildirMessage.get_flags + href: https://docs.python.org/3/library/mailbox.html#mailbox.MaildirMessage.get_flags + name: get_flags + uid: mailbox.MaildirMessage.get_flags +- fullName: mailbox.MaildirMessage.get_info + href: https://docs.python.org/3/library/mailbox.html#mailbox.MaildirMessage.get_info + name: get_info + uid: mailbox.MaildirMessage.get_info +- fullName: mailbox.MaildirMessage.get_subdir + href: https://docs.python.org/3/library/mailbox.html#mailbox.MaildirMessage.get_subdir + name: get_subdir + uid: mailbox.MaildirMessage.get_subdir +- fullName: mailbox.MaildirMessage.remove_flag + href: https://docs.python.org/3/library/mailbox.html#mailbox.MaildirMessage.remove_flag + name: remove_flag + uid: mailbox.MaildirMessage.remove_flag +- fullName: mailbox.MaildirMessage.set_date + href: https://docs.python.org/3/library/mailbox.html#mailbox.MaildirMessage.set_date + name: set_date + uid: mailbox.MaildirMessage.set_date +- fullName: mailbox.MaildirMessage.set_flags + href: https://docs.python.org/3/library/mailbox.html#mailbox.MaildirMessage.set_flags + name: set_flags + uid: mailbox.MaildirMessage.set_flags +- fullName: mailbox.MaildirMessage.set_info + href: https://docs.python.org/3/library/mailbox.html#mailbox.MaildirMessage.set_info + name: set_info + uid: mailbox.MaildirMessage.set_info +- fullName: mailbox.MaildirMessage.set_subdir + href: https://docs.python.org/3/library/mailbox.html#mailbox.MaildirMessage.set_subdir + name: set_subdir + uid: mailbox.MaildirMessage.set_subdir +- fullName: mailbox.mbox.get_bytes + href: https://docs.python.org/3/library/mailbox.html#mailbox.mbox.get_bytes + name: get_bytes + uid: mailbox.mbox.get_bytes +- fullName: mailbox.mbox.get_file + href: https://docs.python.org/3/library/mailbox.html#mailbox.mbox.get_file + name: get_file + uid: mailbox.mbox.get_file +- fullName: mailbox.mbox.get_string + href: https://docs.python.org/3/library/mailbox.html#mailbox.mbox.get_string + name: get_string + uid: mailbox.mbox.get_string +- fullName: mailbox.mbox.lock + href: https://docs.python.org/3/library/mailbox.html#mailbox.mbox.lock + name: lock + uid: mailbox.mbox.lock +- fullName: mailbox.mbox.unlock + href: https://docs.python.org/3/library/mailbox.html#mailbox.mbox.unlock + name: unlock + uid: mailbox.mbox.unlock +- fullName: mailbox.mboxMessage.add_flag + href: https://docs.python.org/3/library/mailbox.html#mailbox.mboxMessage.add_flag + name: add_flag + uid: mailbox.mboxMessage.add_flag +- fullName: mailbox.mboxMessage.get_flags + href: https://docs.python.org/3/library/mailbox.html#mailbox.mboxMessage.get_flags + name: get_flags + uid: mailbox.mboxMessage.get_flags +- fullName: mailbox.mboxMessage.get_from + href: https://docs.python.org/3/library/mailbox.html#mailbox.mboxMessage.get_from + name: get_from + uid: mailbox.mboxMessage.get_from +- fullName: mailbox.mboxMessage.remove_flag + href: https://docs.python.org/3/library/mailbox.html#mailbox.mboxMessage.remove_flag + name: remove_flag + uid: mailbox.mboxMessage.remove_flag +- fullName: mailbox.mboxMessage.set_flags + href: https://docs.python.org/3/library/mailbox.html#mailbox.mboxMessage.set_flags + name: set_flags + uid: mailbox.mboxMessage.set_flags +- fullName: mailbox.mboxMessage.set_from + href: https://docs.python.org/3/library/mailbox.html#mailbox.mboxMessage.set_from + name: set_from + uid: mailbox.mboxMessage.set_from +- fullName: memoryview.__eq__ + href: https://docs.python.org/3/library/stdtypes.html#memoryview.__eq__ + name: __eq__ + uid: memoryview.__eq__ +- fullName: memoryview.cast + href: https://docs.python.org/3/library/stdtypes.html#memoryview.cast + name: cast + uid: memoryview.cast +- fullName: memoryview.hex + href: https://docs.python.org/3/library/stdtypes.html#memoryview.hex + name: hex + uid: memoryview.hex +- fullName: memoryview.release + href: https://docs.python.org/3/library/stdtypes.html#memoryview.release + name: release + uid: memoryview.release +- fullName: memoryview.tobytes + href: https://docs.python.org/3/library/stdtypes.html#memoryview.tobytes + name: tobytes + uid: memoryview.tobytes +- fullName: memoryview.tolist + href: https://docs.python.org/3/library/stdtypes.html#memoryview.tolist + name: tolist + uid: memoryview.tolist +- fullName: memoryview.toreadonly + href: https://docs.python.org/3/library/stdtypes.html#memoryview.toreadonly + name: toreadonly + uid: memoryview.toreadonly +- fullName: mimetypes.MimeTypes.add_type + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.MimeTypes.add_type + name: add_type + uid: mimetypes.MimeTypes.add_type +- fullName: mimetypes.MimeTypes.guess_all_extensions + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.MimeTypes.guess_all_extensions + name: guess_all_extensions + uid: mimetypes.MimeTypes.guess_all_extensions +- fullName: mimetypes.MimeTypes.guess_extension + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.MimeTypes.guess_extension + name: guess_extension + uid: mimetypes.MimeTypes.guess_extension +- fullName: mimetypes.MimeTypes.guess_file_type + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.MimeTypes.guess_file_type + name: guess_file_type + uid: mimetypes.MimeTypes.guess_file_type +- fullName: mimetypes.MimeTypes.guess_type + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.MimeTypes.guess_type + name: guess_type + uid: mimetypes.MimeTypes.guess_type +- fullName: mimetypes.MimeTypes.read + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.MimeTypes.read + name: read + uid: mimetypes.MimeTypes.read +- fullName: mimetypes.MimeTypes.read_windows_registry + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.MimeTypes.read_windows_registry + name: read_windows_registry + uid: mimetypes.MimeTypes.read_windows_registry +- fullName: mimetypes.MimeTypes.readfp + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.MimeTypes.readfp + name: readfp + uid: mimetypes.MimeTypes.readfp +- fullName: mmap.mmap.close + href: https://docs.python.org/3/library/mmap.html#mmap.mmap.close + name: close + uid: mmap.mmap.close +- fullName: mmap.mmap.find + href: https://docs.python.org/3/library/mmap.html#mmap.mmap.find + name: find + uid: mmap.mmap.find +- fullName: mmap.mmap.flush + href: https://docs.python.org/3/library/mmap.html#mmap.mmap.flush + name: flush + uid: mmap.mmap.flush +- fullName: mmap.mmap.madvise + href: https://docs.python.org/3/library/mmap.html#mmap.mmap.madvise + name: madvise + uid: mmap.mmap.madvise +- fullName: mmap.mmap.move + href: https://docs.python.org/3/library/mmap.html#mmap.mmap.move + name: move + uid: mmap.mmap.move +- fullName: mmap.mmap.read + href: https://docs.python.org/3/library/mmap.html#mmap.mmap.read + name: read + uid: mmap.mmap.read +- fullName: mmap.mmap.read_byte + href: https://docs.python.org/3/library/mmap.html#mmap.mmap.read_byte + name: read_byte + uid: mmap.mmap.read_byte +- fullName: mmap.mmap.readline + href: https://docs.python.org/3/library/mmap.html#mmap.mmap.readline + name: readline + uid: mmap.mmap.readline +- fullName: mmap.mmap.resize + href: https://docs.python.org/3/library/mmap.html#mmap.mmap.resize + name: resize + uid: mmap.mmap.resize +- fullName: mmap.mmap.rfind + href: https://docs.python.org/3/library/mmap.html#mmap.mmap.rfind + name: rfind + uid: mmap.mmap.rfind +- fullName: mmap.mmap.seek + href: https://docs.python.org/3/library/mmap.html#mmap.mmap.seek + name: seek + uid: mmap.mmap.seek +- fullName: mmap.mmap.seekable + href: https://docs.python.org/3/library/mmap.html#mmap.mmap.seekable + name: seekable + uid: mmap.mmap.seekable +- fullName: mmap.mmap.size + href: https://docs.python.org/3/library/mmap.html#mmap.mmap.size + name: size + uid: mmap.mmap.size +- fullName: mmap.mmap.tell + href: https://docs.python.org/3/library/mmap.html#mmap.mmap.tell + name: tell + uid: mmap.mmap.tell +- fullName: mmap.mmap.write + href: https://docs.python.org/3/library/mmap.html#mmap.mmap.write + name: write + uid: mmap.mmap.write +- fullName: mmap.mmap.write_byte + href: https://docs.python.org/3/library/mmap.html#mmap.mmap.write_byte + name: write_byte + uid: mmap.mmap.write_byte +- fullName: modulefinder.ModuleFinder.report + href: https://docs.python.org/3/library/modulefinder.html#modulefinder.ModuleFinder.report + name: report + uid: modulefinder.ModuleFinder.report +- fullName: modulefinder.ModuleFinder.run_script + href: https://docs.python.org/3/library/modulefinder.html#modulefinder.ModuleFinder.run_script + name: run_script + uid: modulefinder.ModuleFinder.run_script +- fullName: multiprocessing.JoinableQueue.join + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.JoinableQueue.join + name: join + uid: multiprocessing.JoinableQueue.join +- fullName: multiprocessing.JoinableQueue.task_done + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.JoinableQueue.task_done + name: task_done + uid: multiprocessing.JoinableQueue.task_done +- fullName: multiprocessing.Lock.acquire + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Lock.acquire + name: acquire + uid: multiprocessing.Lock.acquire +- fullName: multiprocessing.Lock.release + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Lock.release + name: release + uid: multiprocessing.Lock.release +- fullName: multiprocessing.Process.close + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Process.close + name: close + uid: multiprocessing.Process.close +- fullName: multiprocessing.Process.is_alive + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Process.is_alive + name: is_alive + uid: multiprocessing.Process.is_alive +- fullName: multiprocessing.Process.join + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Process.join + name: join + uid: multiprocessing.Process.join +- fullName: multiprocessing.Process.kill + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Process.kill + name: kill + uid: multiprocessing.Process.kill +- fullName: multiprocessing.Process.run + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Process.run + name: run + uid: multiprocessing.Process.run +- fullName: multiprocessing.Process.start + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Process.start + name: start + uid: multiprocessing.Process.start +- fullName: multiprocessing.Process.terminate + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Process.terminate + name: terminate + uid: multiprocessing.Process.terminate +- fullName: multiprocessing.Queue.cancel_join_thread + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Queue.cancel_join_thread + name: cancel_join_thread + uid: multiprocessing.Queue.cancel_join_thread +- fullName: multiprocessing.Queue.close + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Queue.close + name: close + uid: multiprocessing.Queue.close +- fullName: multiprocessing.Queue.empty + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Queue.empty + name: empty + uid: multiprocessing.Queue.empty +- fullName: multiprocessing.Queue.full + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Queue.full + name: full + uid: multiprocessing.Queue.full +- fullName: multiprocessing.Queue.get + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Queue.get + name: get + uid: multiprocessing.Queue.get +- fullName: multiprocessing.Queue.get_nowait + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Queue.get_nowait + name: get_nowait + uid: multiprocessing.Queue.get_nowait +- fullName: multiprocessing.Queue.join_thread + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Queue.join_thread + name: join_thread + uid: multiprocessing.Queue.join_thread +- fullName: multiprocessing.Queue.put + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Queue.put + name: put + uid: multiprocessing.Queue.put +- fullName: multiprocessing.Queue.put_nowait + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Queue.put_nowait + name: put_nowait + uid: multiprocessing.Queue.put_nowait +- fullName: multiprocessing.Queue.qsize + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Queue.qsize + name: qsize + uid: multiprocessing.Queue.qsize +- fullName: multiprocessing.RLock.acquire + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.RLock.acquire + name: acquire + uid: multiprocessing.RLock.acquire +- fullName: multiprocessing.RLock.release + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.RLock.release + name: release + uid: multiprocessing.RLock.release +- fullName: multiprocessing.SimpleQueue.close + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.SimpleQueue.close + name: close + uid: multiprocessing.SimpleQueue.close +- fullName: multiprocessing.SimpleQueue.empty + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.SimpleQueue.empty + name: empty + uid: multiprocessing.SimpleQueue.empty +- fullName: multiprocessing.SimpleQueue.get + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.SimpleQueue.get + name: get + uid: multiprocessing.SimpleQueue.get +- fullName: multiprocessing.SimpleQueue.put + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.SimpleQueue.put + name: put + uid: multiprocessing.SimpleQueue.put +- fullName: multiprocessing.connection.Connection.close + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.connection.Connection.close + name: close + uid: multiprocessing.connection.Connection.close +- fullName: multiprocessing.connection.Connection.fileno + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.connection.Connection.fileno + name: fileno + uid: multiprocessing.connection.Connection.fileno +- fullName: multiprocessing.connection.Connection.poll + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.connection.Connection.poll + name: poll + uid: multiprocessing.connection.Connection.poll +- fullName: multiprocessing.connection.Connection.recv + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.connection.Connection.recv + name: recv + uid: multiprocessing.connection.Connection.recv +- fullName: multiprocessing.connection.Connection.recv_bytes + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.connection.Connection.recv_bytes + name: recv_bytes + uid: multiprocessing.connection.Connection.recv_bytes +- fullName: multiprocessing.connection.Connection.recv_bytes_into + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.connection.Connection.recv_bytes_into + name: recv_bytes_into + uid: multiprocessing.connection.Connection.recv_bytes_into +- fullName: multiprocessing.connection.Connection.send + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.connection.Connection.send + name: send + uid: multiprocessing.connection.Connection.send +- fullName: multiprocessing.connection.Connection.send_bytes + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.connection.Connection.send_bytes + name: send_bytes + uid: multiprocessing.connection.Connection.send_bytes +- fullName: multiprocessing.connection.Listener.accept + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.connection.Listener.accept + name: accept + uid: multiprocessing.connection.Listener.accept +- fullName: multiprocessing.connection.Listener.close + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.connection.Listener.close + name: close + uid: multiprocessing.connection.Listener.close +- fullName: multiprocessing.managers.BaseManager.connect + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.BaseManager.connect + name: connect + uid: multiprocessing.managers.BaseManager.connect +- fullName: multiprocessing.managers.BaseManager.get_server + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.BaseManager.get_server + name: get_server + uid: multiprocessing.managers.BaseManager.get_server +- fullName: multiprocessing.managers.BaseManager.register + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.BaseManager.register + name: register + uid: multiprocessing.managers.BaseManager.register +- fullName: multiprocessing.managers.BaseManager.shutdown + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.BaseManager.shutdown + name: shutdown + uid: multiprocessing.managers.BaseManager.shutdown +- fullName: multiprocessing.managers.BaseManager.start + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.BaseManager.start + name: start + uid: multiprocessing.managers.BaseManager.start +- fullName: multiprocessing.managers.BaseProxy.__repr__ + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.BaseProxy.__repr__ + name: __repr__ + uid: multiprocessing.managers.BaseProxy.__repr__ +- fullName: multiprocessing.managers.BaseProxy.__str__ + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.BaseProxy.__str__ + name: __str__ + uid: multiprocessing.managers.BaseProxy.__str__ +- fullName: multiprocessing.managers.BaseProxy._callmethod + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.BaseProxy._callmethod + name: _callmethod + uid: multiprocessing.managers.BaseProxy._callmethod +- fullName: multiprocessing.managers.BaseProxy._getvalue + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.BaseProxy._getvalue + name: _getvalue + uid: multiprocessing.managers.BaseProxy._getvalue +- fullName: multiprocessing.managers.SharedMemoryManager.ShareableList + href: https://docs.python.org/3/library/multiprocessing.shared_memory.html#multiprocessing.managers.SharedMemoryManager.ShareableList + name: ShareableList + uid: multiprocessing.managers.SharedMemoryManager.ShareableList +- fullName: multiprocessing.managers.SharedMemoryManager.SharedMemory + href: https://docs.python.org/3/library/multiprocessing.shared_memory.html#multiprocessing.managers.SharedMemoryManager.SharedMemory + name: SharedMemory + uid: multiprocessing.managers.SharedMemoryManager.SharedMemory +- fullName: multiprocessing.managers.SyncManager.Array + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.SyncManager.Array + name: Array + uid: multiprocessing.managers.SyncManager.Array +- fullName: multiprocessing.managers.SyncManager.Barrier + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.SyncManager.Barrier + name: Barrier + uid: multiprocessing.managers.SyncManager.Barrier +- fullName: multiprocessing.managers.SyncManager.BoundedSemaphore + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.SyncManager.BoundedSemaphore + name: BoundedSemaphore + uid: multiprocessing.managers.SyncManager.BoundedSemaphore +- fullName: multiprocessing.managers.SyncManager.Condition + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.SyncManager.Condition + name: Condition + uid: multiprocessing.managers.SyncManager.Condition +- fullName: multiprocessing.managers.SyncManager.Event + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.SyncManager.Event + name: Event + uid: multiprocessing.managers.SyncManager.Event +- fullName: multiprocessing.managers.SyncManager.Lock + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.SyncManager.Lock + name: Lock + uid: multiprocessing.managers.SyncManager.Lock +- fullName: multiprocessing.managers.SyncManager.Namespace + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.SyncManager.Namespace + name: Namespace + uid: multiprocessing.managers.SyncManager.Namespace +- fullName: multiprocessing.managers.SyncManager.Queue + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.SyncManager.Queue + name: Queue + uid: multiprocessing.managers.SyncManager.Queue +- fullName: multiprocessing.managers.SyncManager.RLock + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.SyncManager.RLock + name: RLock + uid: multiprocessing.managers.SyncManager.RLock +- fullName: multiprocessing.managers.SyncManager.Semaphore + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.SyncManager.Semaphore + name: Semaphore + uid: multiprocessing.managers.SyncManager.Semaphore +- fullName: multiprocessing.managers.SyncManager.Value + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.SyncManager.Value + name: Value + uid: multiprocessing.managers.SyncManager.Value +- fullName: multiprocessing.managers.SyncManager.dict + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.SyncManager.dict + name: dict + uid: multiprocessing.managers.SyncManager.dict +- fullName: multiprocessing.managers.SyncManager.list + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.SyncManager.list + name: list + uid: multiprocessing.managers.SyncManager.list +- fullName: multiprocessing.pool.AsyncResult.get + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.pool.AsyncResult.get + name: get + uid: multiprocessing.pool.AsyncResult.get +- fullName: multiprocessing.pool.AsyncResult.ready + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.pool.AsyncResult.ready + name: ready + uid: multiprocessing.pool.AsyncResult.ready +- fullName: multiprocessing.pool.AsyncResult.successful + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.pool.AsyncResult.successful + name: successful + uid: multiprocessing.pool.AsyncResult.successful +- fullName: multiprocessing.pool.AsyncResult.wait + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.pool.AsyncResult.wait + name: wait + uid: multiprocessing.pool.AsyncResult.wait +- fullName: multiprocessing.pool.Pool.apply + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.pool.Pool.apply + name: apply + uid: multiprocessing.pool.Pool.apply +- fullName: multiprocessing.pool.Pool.apply_async + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.pool.Pool.apply_async + name: apply_async + uid: multiprocessing.pool.Pool.apply_async +- fullName: multiprocessing.pool.Pool.close + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.pool.Pool.close + name: close + uid: multiprocessing.pool.Pool.close +- fullName: multiprocessing.pool.Pool.imap + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.pool.Pool.imap + name: imap + uid: multiprocessing.pool.Pool.imap +- fullName: multiprocessing.pool.Pool.imap_unordered + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.pool.Pool.imap_unordered + name: imap_unordered + uid: multiprocessing.pool.Pool.imap_unordered +- fullName: multiprocessing.pool.Pool.join + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.pool.Pool.join + name: join + uid: multiprocessing.pool.Pool.join +- fullName: multiprocessing.pool.Pool.map + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.pool.Pool.map + name: map + uid: multiprocessing.pool.Pool.map +- fullName: multiprocessing.pool.Pool.map_async + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.pool.Pool.map_async + name: map_async + uid: multiprocessing.pool.Pool.map_async +- fullName: multiprocessing.pool.Pool.starmap + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.pool.Pool.starmap + name: starmap + uid: multiprocessing.pool.Pool.starmap +- fullName: multiprocessing.pool.Pool.starmap_async + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.pool.Pool.starmap_async + name: starmap_async + uid: multiprocessing.pool.Pool.starmap_async +- fullName: multiprocessing.pool.Pool.terminate + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.pool.Pool.terminate + name: terminate + uid: multiprocessing.pool.Pool.terminate +- fullName: multiprocessing.shared_memory.ShareableList.count + href: https://docs.python.org/3/library/multiprocessing.shared_memory.html#multiprocessing.shared_memory.ShareableList.count + name: count + uid: multiprocessing.shared_memory.ShareableList.count +- fullName: multiprocessing.shared_memory.ShareableList.index + href: https://docs.python.org/3/library/multiprocessing.shared_memory.html#multiprocessing.shared_memory.ShareableList.index + name: index + uid: multiprocessing.shared_memory.ShareableList.index +- fullName: multiprocessing.shared_memory.SharedMemory.close + href: https://docs.python.org/3/library/multiprocessing.shared_memory.html#multiprocessing.shared_memory.SharedMemory.close + name: close + uid: multiprocessing.shared_memory.SharedMemory.close +- fullName: multiprocessing.shared_memory.SharedMemory.unlink + href: https://docs.python.org/3/library/multiprocessing.shared_memory.html#multiprocessing.shared_memory.SharedMemory.unlink + name: unlink + uid: multiprocessing.shared_memory.SharedMemory.unlink +- fullName: netrc.netrc.__repr__ + href: https://docs.python.org/3/library/netrc.html#netrc.netrc.__repr__ + name: __repr__ + uid: netrc.netrc.__repr__ +- fullName: netrc.netrc.authenticators + href: https://docs.python.org/3/library/netrc.html#netrc.netrc.authenticators + name: authenticators + uid: netrc.netrc.authenticators +- fullName: numbers.Complex.conjugate + href: https://docs.python.org/3/library/numbers.html#numbers.Complex.conjugate + name: conjugate + uid: numbers.Complex.conjugate +- fullName: object.__abs__ + href: https://docs.python.org/3/reference/datamodel.html#object.__abs__ + name: __abs__ + uid: object.__abs__ +- fullName: object.__add__ + href: https://docs.python.org/3/reference/datamodel.html#object.__add__ + name: __add__ + uid: object.__add__ +- fullName: object.__aenter__ + href: https://docs.python.org/3/reference/datamodel.html#object.__aenter__ + name: __aenter__ + uid: object.__aenter__ +- fullName: object.__aexit__ + href: https://docs.python.org/3/reference/datamodel.html#object.__aexit__ + name: __aexit__ + uid: object.__aexit__ +- fullName: object.__aiter__ + href: https://docs.python.org/3/reference/datamodel.html#object.__aiter__ + name: __aiter__ + uid: object.__aiter__ +- fullName: object.__and__ + href: https://docs.python.org/3/reference/datamodel.html#object.__and__ + name: __and__ + uid: object.__and__ +- fullName: object.__anext__ + href: https://docs.python.org/3/reference/datamodel.html#object.__anext__ + name: __anext__ + uid: object.__anext__ +- fullName: object.__await__ + href: https://docs.python.org/3/reference/datamodel.html#object.__await__ + name: __await__ + uid: object.__await__ +- fullName: object.__bool__ + href: https://docs.python.org/3/reference/datamodel.html#object.__bool__ + name: __bool__ + uid: object.__bool__ +- fullName: object.__buffer__ + href: https://docs.python.org/3/reference/datamodel.html#object.__buffer__ + name: __buffer__ + uid: object.__buffer__ +- fullName: object.__bytes__ + href: https://docs.python.org/3/reference/datamodel.html#object.__bytes__ + name: __bytes__ + uid: object.__bytes__ +- fullName: object.__call__ + href: https://docs.python.org/3/reference/datamodel.html#object.__call__ + name: __call__ + uid: object.__call__ +- fullName: object.__ceil__ + href: https://docs.python.org/3/reference/datamodel.html#object.__ceil__ + name: __ceil__ + uid: object.__ceil__ +- fullName: object.__class_getitem__ + href: https://docs.python.org/3/reference/datamodel.html#object.__class_getitem__ + name: __class_getitem__ + uid: object.__class_getitem__ +- fullName: object.__complex__ + href: https://docs.python.org/3/reference/datamodel.html#object.__complex__ + name: __complex__ + uid: object.__complex__ +- fullName: object.__contains__ + href: https://docs.python.org/3/reference/datamodel.html#object.__contains__ + name: __contains__ + uid: object.__contains__ +- fullName: object.__copy__ + href: https://docs.python.org/3/library/copy.html#object.__copy__ + name: __copy__ + uid: object.__copy__ +- fullName: object.__deepcopy__ + href: https://docs.python.org/3/library/copy.html#object.__deepcopy__ + name: __deepcopy__ + uid: object.__deepcopy__ +- fullName: object.__del__ + href: https://docs.python.org/3/reference/datamodel.html#object.__del__ + name: __del__ + uid: object.__del__ +- fullName: object.__delattr__ + href: https://docs.python.org/3/reference/datamodel.html#object.__delattr__ + name: __delattr__ + uid: object.__delattr__ +- fullName: object.__delete__ + href: https://docs.python.org/3/reference/datamodel.html#object.__delete__ + name: __delete__ + uid: object.__delete__ +- fullName: object.__delitem__ + href: https://docs.python.org/3/reference/datamodel.html#object.__delitem__ + name: __delitem__ + uid: object.__delitem__ +- fullName: object.__dir__ + href: https://docs.python.org/3/reference/datamodel.html#object.__dir__ + name: __dir__ + uid: object.__dir__ +- fullName: object.__divmod__ + href: https://docs.python.org/3/reference/datamodel.html#object.__divmod__ + name: __divmod__ + uid: object.__divmod__ +- fullName: object.__enter__ + href: https://docs.python.org/3/reference/datamodel.html#object.__enter__ + name: __enter__ + uid: object.__enter__ +- fullName: object.__eq__ + href: https://docs.python.org/3/reference/datamodel.html#object.__eq__ + name: __eq__ + uid: object.__eq__ +- fullName: object.__exit__ + href: https://docs.python.org/3/reference/datamodel.html#object.__exit__ + name: __exit__ + uid: object.__exit__ +- fullName: object.__float__ + href: https://docs.python.org/3/reference/datamodel.html#object.__float__ + name: __float__ + uid: object.__float__ +- fullName: object.__floor__ + href: https://docs.python.org/3/reference/datamodel.html#object.__floor__ + name: __floor__ + uid: object.__floor__ +- fullName: object.__floordiv__ + href: https://docs.python.org/3/reference/datamodel.html#object.__floordiv__ + name: __floordiv__ + uid: object.__floordiv__ +- fullName: object.__format__ + href: https://docs.python.org/3/reference/datamodel.html#object.__format__ + name: __format__ + uid: object.__format__ +- fullName: object.__ge__ + href: https://docs.python.org/3/reference/datamodel.html#object.__ge__ + name: __ge__ + uid: object.__ge__ +- fullName: object.__get__ + href: https://docs.python.org/3/reference/datamodel.html#object.__get__ + name: __get__ + uid: object.__get__ +- fullName: object.__getattr__ + href: https://docs.python.org/3/reference/datamodel.html#object.__getattr__ + name: __getattr__ + uid: object.__getattr__ +- fullName: object.__getattribute__ + href: https://docs.python.org/3/reference/datamodel.html#object.__getattribute__ + name: __getattribute__ + uid: object.__getattribute__ +- fullName: object.__getitem__ + href: https://docs.python.org/3/reference/datamodel.html#object.__getitem__ + name: __getitem__ + uid: object.__getitem__ +- fullName: object.__getnewargs__ + href: https://docs.python.org/3/library/pickle.html#object.__getnewargs__ + name: __getnewargs__ + uid: object.__getnewargs__ +- fullName: object.__getnewargs_ex__ + href: https://docs.python.org/3/library/pickle.html#object.__getnewargs_ex__ + name: __getnewargs_ex__ + uid: object.__getnewargs_ex__ +- fullName: object.__getstate__ + href: https://docs.python.org/3/library/pickle.html#object.__getstate__ + name: __getstate__ + uid: object.__getstate__ +- fullName: object.__gt__ + href: https://docs.python.org/3/reference/datamodel.html#object.__gt__ + name: __gt__ + uid: object.__gt__ +- fullName: object.__hash__ + href: https://docs.python.org/3/reference/datamodel.html#object.__hash__ + name: __hash__ + uid: object.__hash__ +- fullName: object.__iadd__ + href: https://docs.python.org/3/reference/datamodel.html#object.__iadd__ + name: __iadd__ + uid: object.__iadd__ +- fullName: object.__iand__ + href: https://docs.python.org/3/reference/datamodel.html#object.__iand__ + name: __iand__ + uid: object.__iand__ +- fullName: object.__ifloordiv__ + href: https://docs.python.org/3/reference/datamodel.html#object.__ifloordiv__ + name: __ifloordiv__ + uid: object.__ifloordiv__ +- fullName: object.__ilshift__ + href: https://docs.python.org/3/reference/datamodel.html#object.__ilshift__ + name: __ilshift__ + uid: object.__ilshift__ +- fullName: object.__imatmul__ + href: https://docs.python.org/3/reference/datamodel.html#object.__imatmul__ + name: __imatmul__ + uid: object.__imatmul__ +- fullName: object.__imod__ + href: https://docs.python.org/3/reference/datamodel.html#object.__imod__ + name: __imod__ + uid: object.__imod__ +- fullName: object.__imul__ + href: https://docs.python.org/3/reference/datamodel.html#object.__imul__ + name: __imul__ + uid: object.__imul__ +- fullName: object.__index__ + href: https://docs.python.org/3/reference/datamodel.html#object.__index__ + name: __index__ + uid: object.__index__ +- fullName: object.__init__ + href: https://docs.python.org/3/reference/datamodel.html#object.__init__ + name: __init__ + uid: object.__init__ +- fullName: object.__init_subclass__ + href: https://docs.python.org/3/reference/datamodel.html#object.__init_subclass__ + name: __init_subclass__ + uid: object.__init_subclass__ +- fullName: object.__int__ + href: https://docs.python.org/3/reference/datamodel.html#object.__int__ + name: __int__ + uid: object.__int__ +- fullName: object.__invert__ + href: https://docs.python.org/3/reference/datamodel.html#object.__invert__ + name: __invert__ + uid: object.__invert__ +- fullName: object.__ior__ + href: https://docs.python.org/3/reference/datamodel.html#object.__ior__ + name: __ior__ + uid: object.__ior__ +- fullName: object.__ipow__ + href: https://docs.python.org/3/reference/datamodel.html#object.__ipow__ + name: __ipow__ + uid: object.__ipow__ +- fullName: object.__irshift__ + href: https://docs.python.org/3/reference/datamodel.html#object.__irshift__ + name: __irshift__ + uid: object.__irshift__ +- fullName: object.__isub__ + href: https://docs.python.org/3/reference/datamodel.html#object.__isub__ + name: __isub__ + uid: object.__isub__ +- fullName: object.__iter__ + href: https://docs.python.org/3/reference/datamodel.html#object.__iter__ + name: __iter__ + uid: object.__iter__ +- fullName: object.__itruediv__ + href: https://docs.python.org/3/reference/datamodel.html#object.__itruediv__ + name: __itruediv__ + uid: object.__itruediv__ +- fullName: object.__ixor__ + href: https://docs.python.org/3/reference/datamodel.html#object.__ixor__ + name: __ixor__ + uid: object.__ixor__ +- fullName: object.__le__ + href: https://docs.python.org/3/reference/datamodel.html#object.__le__ + name: __le__ + uid: object.__le__ +- fullName: object.__len__ + href: https://docs.python.org/3/reference/datamodel.html#object.__len__ + name: __len__ + uid: object.__len__ +- fullName: object.__length_hint__ + href: https://docs.python.org/3/reference/datamodel.html#object.__length_hint__ + name: __length_hint__ + uid: object.__length_hint__ +- fullName: object.__lshift__ + href: https://docs.python.org/3/reference/datamodel.html#object.__lshift__ + name: __lshift__ + uid: object.__lshift__ +- fullName: object.__lt__ + href: https://docs.python.org/3/reference/datamodel.html#object.__lt__ + name: __lt__ + uid: object.__lt__ +- fullName: object.__matmul__ + href: https://docs.python.org/3/reference/datamodel.html#object.__matmul__ + name: __matmul__ + uid: object.__matmul__ +- fullName: object.__missing__ + href: https://docs.python.org/3/reference/datamodel.html#object.__missing__ + name: __missing__ + uid: object.__missing__ +- fullName: object.__mod__ + href: https://docs.python.org/3/reference/datamodel.html#object.__mod__ + name: __mod__ + uid: object.__mod__ +- fullName: object.__mro_entries__ + href: https://docs.python.org/3/reference/datamodel.html#object.__mro_entries__ + name: __mro_entries__ + uid: object.__mro_entries__ +- fullName: object.__mul__ + href: https://docs.python.org/3/reference/datamodel.html#object.__mul__ + name: __mul__ + uid: object.__mul__ +- fullName: object.__ne__ + href: https://docs.python.org/3/reference/datamodel.html#object.__ne__ + name: __ne__ + uid: object.__ne__ +- fullName: object.__neg__ + href: https://docs.python.org/3/reference/datamodel.html#object.__neg__ + name: __neg__ + uid: object.__neg__ +- fullName: object.__new__ + href: https://docs.python.org/3/reference/datamodel.html#object.__new__ + name: __new__ + uid: object.__new__ +- fullName: object.__or__ + href: https://docs.python.org/3/reference/datamodel.html#object.__or__ + name: __or__ + uid: object.__or__ +- fullName: object.__pos__ + href: https://docs.python.org/3/reference/datamodel.html#object.__pos__ + name: __pos__ + uid: object.__pos__ +- fullName: object.__pow__ + href: https://docs.python.org/3/reference/datamodel.html#object.__pow__ + name: __pow__ + uid: object.__pow__ +- fullName: object.__radd__ + href: https://docs.python.org/3/reference/datamodel.html#object.__radd__ + name: __radd__ + uid: object.__radd__ +- fullName: object.__rand__ + href: https://docs.python.org/3/reference/datamodel.html#object.__rand__ + name: __rand__ + uid: object.__rand__ +- fullName: object.__rdivmod__ + href: https://docs.python.org/3/reference/datamodel.html#object.__rdivmod__ + name: __rdivmod__ + uid: object.__rdivmod__ +- fullName: object.__reduce__ + href: https://docs.python.org/3/library/pickle.html#object.__reduce__ + name: __reduce__ + uid: object.__reduce__ +- fullName: object.__reduce_ex__ + href: https://docs.python.org/3/library/pickle.html#object.__reduce_ex__ + name: __reduce_ex__ + uid: object.__reduce_ex__ +- fullName: object.__release_buffer__ + href: https://docs.python.org/3/reference/datamodel.html#object.__release_buffer__ + name: __release_buffer__ + uid: object.__release_buffer__ +- fullName: object.__replace__ + href: https://docs.python.org/3/library/copy.html#object.__replace__ + name: __replace__ + uid: object.__replace__ +- fullName: object.__repr__ + href: https://docs.python.org/3/reference/datamodel.html#object.__repr__ + name: __repr__ + uid: object.__repr__ +- fullName: object.__reversed__ + href: https://docs.python.org/3/reference/datamodel.html#object.__reversed__ + name: __reversed__ + uid: object.__reversed__ +- fullName: object.__rfloordiv__ + href: https://docs.python.org/3/reference/datamodel.html#object.__rfloordiv__ + name: __rfloordiv__ + uid: object.__rfloordiv__ +- fullName: object.__rlshift__ + href: https://docs.python.org/3/reference/datamodel.html#object.__rlshift__ + name: __rlshift__ + uid: object.__rlshift__ +- fullName: object.__rmatmul__ + href: https://docs.python.org/3/reference/datamodel.html#object.__rmatmul__ + name: __rmatmul__ + uid: object.__rmatmul__ +- fullName: object.__rmod__ + href: https://docs.python.org/3/reference/datamodel.html#object.__rmod__ + name: __rmod__ + uid: object.__rmod__ +- fullName: object.__rmul__ + href: https://docs.python.org/3/reference/datamodel.html#object.__rmul__ + name: __rmul__ + uid: object.__rmul__ +- fullName: object.__ror__ + href: https://docs.python.org/3/reference/datamodel.html#object.__ror__ + name: __ror__ + uid: object.__ror__ +- fullName: object.__round__ + href: https://docs.python.org/3/reference/datamodel.html#object.__round__ + name: __round__ + uid: object.__round__ +- fullName: object.__rpow__ + href: https://docs.python.org/3/reference/datamodel.html#object.__rpow__ + name: __rpow__ + uid: object.__rpow__ +- fullName: object.__rrshift__ + href: https://docs.python.org/3/reference/datamodel.html#object.__rrshift__ + name: __rrshift__ + uid: object.__rrshift__ +- fullName: object.__rshift__ + href: https://docs.python.org/3/reference/datamodel.html#object.__rshift__ + name: __rshift__ + uid: object.__rshift__ +- fullName: object.__rsub__ + href: https://docs.python.org/3/reference/datamodel.html#object.__rsub__ + name: __rsub__ + uid: object.__rsub__ +- fullName: object.__rtruediv__ + href: https://docs.python.org/3/reference/datamodel.html#object.__rtruediv__ + name: __rtruediv__ + uid: object.__rtruediv__ +- fullName: object.__rxor__ + href: https://docs.python.org/3/reference/datamodel.html#object.__rxor__ + name: __rxor__ + uid: object.__rxor__ +- fullName: object.__set__ + href: https://docs.python.org/3/reference/datamodel.html#object.__set__ + name: __set__ + uid: object.__set__ +- fullName: object.__set_name__ + href: https://docs.python.org/3/reference/datamodel.html#object.__set_name__ + name: __set_name__ + uid: object.__set_name__ +- fullName: object.__setattr__ + href: https://docs.python.org/3/reference/datamodel.html#object.__setattr__ + name: __setattr__ + uid: object.__setattr__ +- fullName: object.__setitem__ + href: https://docs.python.org/3/reference/datamodel.html#object.__setitem__ + name: __setitem__ + uid: object.__setitem__ +- fullName: object.__setstate__ + href: https://docs.python.org/3/library/pickle.html#object.__setstate__ + name: __setstate__ + uid: object.__setstate__ +- fullName: object.__str__ + href: https://docs.python.org/3/reference/datamodel.html#object.__str__ + name: __str__ + uid: object.__str__ +- fullName: object.__sub__ + href: https://docs.python.org/3/reference/datamodel.html#object.__sub__ + name: __sub__ + uid: object.__sub__ +- fullName: object.__truediv__ + href: https://docs.python.org/3/reference/datamodel.html#object.__truediv__ + name: __truediv__ + uid: object.__truediv__ +- fullName: object.__trunc__ + href: https://docs.python.org/3/reference/datamodel.html#object.__trunc__ + name: __trunc__ + uid: object.__trunc__ +- fullName: object.__xor__ + href: https://docs.python.org/3/reference/datamodel.html#object.__xor__ + name: __xor__ + uid: object.__xor__ +- fullName: optparse.OptionParser.add_option + href: https://docs.python.org/3/library/optparse.html#optparse.OptionParser.add_option + name: add_option + uid: optparse.OptionParser.add_option +- fullName: optparse.OptionParser.disable_interspersed_args + href: https://docs.python.org/3/library/optparse.html#optparse.OptionParser.disable_interspersed_args + name: disable_interspersed_args + uid: optparse.OptionParser.disable_interspersed_args +- fullName: optparse.OptionParser.enable_interspersed_args + href: https://docs.python.org/3/library/optparse.html#optparse.OptionParser.enable_interspersed_args + name: enable_interspersed_args + uid: optparse.OptionParser.enable_interspersed_args +- fullName: optparse.OptionParser.get_option + href: https://docs.python.org/3/library/optparse.html#optparse.OptionParser.get_option + name: get_option + uid: optparse.OptionParser.get_option +- fullName: optparse.OptionParser.get_option_group + href: https://docs.python.org/3/library/optparse.html#optparse.OptionParser.get_option_group + name: get_option_group + uid: optparse.OptionParser.get_option_group +- fullName: optparse.OptionParser.get_usage + href: https://docs.python.org/3/library/optparse.html#optparse.OptionParser.get_usage + name: get_usage + uid: optparse.OptionParser.get_usage +- fullName: optparse.OptionParser.get_version + href: https://docs.python.org/3/library/optparse.html#optparse.OptionParser.get_version + name: get_version + uid: optparse.OptionParser.get_version +- fullName: optparse.OptionParser.has_option + href: https://docs.python.org/3/library/optparse.html#optparse.OptionParser.has_option + name: has_option + uid: optparse.OptionParser.has_option +- fullName: optparse.OptionParser.parse_args + href: https://docs.python.org/3/library/optparse.html#optparse.OptionParser.parse_args + name: parse_args + uid: optparse.OptionParser.parse_args +- fullName: optparse.OptionParser.print_usage + href: https://docs.python.org/3/library/optparse.html#optparse.OptionParser.print_usage + name: print_usage + uid: optparse.OptionParser.print_usage +- fullName: optparse.OptionParser.print_version + href: https://docs.python.org/3/library/optparse.html#optparse.OptionParser.print_version + name: print_version + uid: optparse.OptionParser.print_version +- fullName: optparse.OptionParser.remove_option + href: https://docs.python.org/3/library/optparse.html#optparse.OptionParser.remove_option + name: remove_option + uid: optparse.OptionParser.remove_option +- fullName: optparse.OptionParser.set_defaults + href: https://docs.python.org/3/library/optparse.html#optparse.OptionParser.set_defaults + name: set_defaults + uid: optparse.OptionParser.set_defaults +- fullName: optparse.OptionParser.set_usage + href: https://docs.python.org/3/library/optparse.html#optparse.OptionParser.set_usage + name: set_usage + uid: optparse.OptionParser.set_usage +- fullName: os.DirEntry.inode + href: https://docs.python.org/3/library/os.html#os.DirEntry.inode + name: inode + uid: os.DirEntry.inode +- fullName: os.DirEntry.is_dir + href: https://docs.python.org/3/library/os.html#os.DirEntry.is_dir + name: is_dir + uid: os.DirEntry.is_dir +- fullName: os.DirEntry.is_file + href: https://docs.python.org/3/library/os.html#os.DirEntry.is_file + name: is_file + uid: os.DirEntry.is_file +- fullName: os.DirEntry.is_junction + href: https://docs.python.org/3/library/os.html#os.DirEntry.is_junction + name: is_junction + uid: os.DirEntry.is_junction +- fullName: os.DirEntry.is_symlink + href: https://docs.python.org/3/library/os.html#os.DirEntry.is_symlink + name: is_symlink + uid: os.DirEntry.is_symlink +- fullName: os.DirEntry.stat + href: https://docs.python.org/3/library/os.html#os.DirEntry.stat + name: stat + uid: os.DirEntry.stat +- fullName: os.PathLike.__fspath__ + href: https://docs.python.org/3/library/os.html#os.PathLike.__fspath__ + name: __fspath__ + uid: os.PathLike.__fspath__ +- fullName: os.scandir.close + href: https://docs.python.org/3/library/os.html#os.scandir.close + name: close + uid: os.scandir.close +- fullName: pathlib.Path.absolute + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.absolute + name: absolute + uid: pathlib.Path.absolute +- fullName: pathlib.Path.as_uri + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.as_uri + name: as_uri + uid: pathlib.Path.as_uri +- fullName: pathlib.Path.chmod + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.chmod + name: chmod + uid: pathlib.Path.chmod +- fullName: pathlib.Path.cwd + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.cwd + name: cwd + uid: pathlib.Path.cwd +- fullName: pathlib.Path.exists + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.exists + name: exists + uid: pathlib.Path.exists +- fullName: pathlib.Path.expanduser + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.expanduser + name: expanduser + uid: pathlib.Path.expanduser +- fullName: pathlib.Path.from_uri + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.from_uri + name: from_uri + uid: pathlib.Path.from_uri +- fullName: pathlib.Path.glob + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.glob + name: glob + uid: pathlib.Path.glob +- fullName: pathlib.Path.group + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.group + name: group + uid: pathlib.Path.group +- fullName: pathlib.Path.hardlink_to + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.hardlink_to + name: hardlink_to + uid: pathlib.Path.hardlink_to +- fullName: pathlib.Path.home + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.home + name: home + uid: pathlib.Path.home +- fullName: pathlib.Path.is_block_device + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.is_block_device + name: is_block_device + uid: pathlib.Path.is_block_device +- fullName: pathlib.Path.is_char_device + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.is_char_device + name: is_char_device + uid: pathlib.Path.is_char_device +- fullName: pathlib.Path.is_dir + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.is_dir + name: is_dir + uid: pathlib.Path.is_dir +- fullName: pathlib.Path.is_fifo + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.is_fifo + name: is_fifo + uid: pathlib.Path.is_fifo +- fullName: pathlib.Path.is_file + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.is_file + name: is_file + uid: pathlib.Path.is_file +- fullName: pathlib.Path.is_junction + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.is_junction + name: is_junction + uid: pathlib.Path.is_junction +- fullName: pathlib.Path.is_mount + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.is_mount + name: is_mount + uid: pathlib.Path.is_mount +- fullName: pathlib.Path.is_socket + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.is_socket + name: is_socket + uid: pathlib.Path.is_socket +- fullName: pathlib.Path.is_symlink + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.is_symlink + name: is_symlink + uid: pathlib.Path.is_symlink +- fullName: pathlib.Path.iterdir + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.iterdir + name: iterdir + uid: pathlib.Path.iterdir +- fullName: pathlib.Path.lchmod + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.lchmod + name: lchmod + uid: pathlib.Path.lchmod +- fullName: pathlib.Path.lstat + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.lstat + name: lstat + uid: pathlib.Path.lstat +- fullName: pathlib.Path.mkdir + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.mkdir + name: mkdir + uid: pathlib.Path.mkdir +- fullName: pathlib.Path.open + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.open + name: open + uid: pathlib.Path.open +- fullName: pathlib.Path.owner + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.owner + name: owner + uid: pathlib.Path.owner +- fullName: pathlib.Path.read_bytes + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.read_bytes + name: read_bytes + uid: pathlib.Path.read_bytes +- fullName: pathlib.Path.read_text + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.read_text + name: read_text + uid: pathlib.Path.read_text +- fullName: pathlib.Path.readlink + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.readlink + name: readlink + uid: pathlib.Path.readlink +- fullName: pathlib.Path.rename + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.rename + name: rename + uid: pathlib.Path.rename +- fullName: pathlib.Path.replace + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.replace + name: replace + uid: pathlib.Path.replace +- fullName: pathlib.Path.resolve + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.resolve + name: resolve + uid: pathlib.Path.resolve +- fullName: pathlib.Path.rglob + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.rglob + name: rglob + uid: pathlib.Path.rglob +- fullName: pathlib.Path.rmdir + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.rmdir + name: rmdir + uid: pathlib.Path.rmdir +- fullName: pathlib.Path.samefile + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.samefile + name: samefile + uid: pathlib.Path.samefile +- fullName: pathlib.Path.stat + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.stat + name: stat + uid: pathlib.Path.stat +- fullName: pathlib.Path.symlink_to + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.symlink_to + name: symlink_to + uid: pathlib.Path.symlink_to +- fullName: pathlib.Path.touch + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.touch + name: touch + uid: pathlib.Path.touch +- fullName: pathlib.Path.unlink + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.unlink + name: unlink + uid: pathlib.Path.unlink +- fullName: pathlib.Path.walk + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.walk + name: walk + uid: pathlib.Path.walk +- fullName: pathlib.Path.write_bytes + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.write_bytes + name: write_bytes + uid: pathlib.Path.write_bytes +- fullName: pathlib.Path.write_text + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path.write_text + name: write_text + uid: pathlib.Path.write_text +- fullName: pathlib.PurePath.as_posix + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.as_posix + name: as_posix + uid: pathlib.PurePath.as_posix +- fullName: pathlib.PurePath.full_match + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.full_match + name: full_match + uid: pathlib.PurePath.full_match +- fullName: pathlib.PurePath.is_absolute + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.is_absolute + name: is_absolute + uid: pathlib.PurePath.is_absolute +- fullName: pathlib.PurePath.is_relative_to + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.is_relative_to + name: is_relative_to + uid: pathlib.PurePath.is_relative_to +- fullName: pathlib.PurePath.is_reserved + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.is_reserved + name: is_reserved + uid: pathlib.PurePath.is_reserved +- fullName: pathlib.PurePath.joinpath + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.joinpath + name: joinpath + uid: pathlib.PurePath.joinpath +- fullName: pathlib.PurePath.match + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.match + name: match + uid: pathlib.PurePath.match +- fullName: pathlib.PurePath.relative_to + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.relative_to + name: relative_to + uid: pathlib.PurePath.relative_to +- fullName: pathlib.PurePath.with_name + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.with_name + name: with_name + uid: pathlib.PurePath.with_name +- fullName: pathlib.PurePath.with_segments + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.with_segments + name: with_segments + uid: pathlib.PurePath.with_segments +- fullName: pathlib.PurePath.with_stem + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.with_stem + name: with_stem + uid: pathlib.PurePath.with_stem +- fullName: pathlib.PurePath.with_suffix + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath.with_suffix + name: with_suffix + uid: pathlib.PurePath.with_suffix +- fullName: pdb.Pdb.run + href: https://docs.python.org/3/library/pdb.html#pdb.Pdb.run + name: run + uid: pdb.Pdb.run +- fullName: pdb.Pdb.runcall + href: https://docs.python.org/3/library/pdb.html#pdb.Pdb.runcall + name: runcall + uid: pdb.Pdb.runcall +- fullName: pdb.Pdb.runeval + href: https://docs.python.org/3/library/pdb.html#pdb.Pdb.runeval + name: runeval + uid: pdb.Pdb.runeval +- fullName: pdb.Pdb.set_trace + href: https://docs.python.org/3/library/pdb.html#pdb.Pdb.set_trace + name: set_trace + uid: pdb.Pdb.set_trace +- fullName: pickle.PickleBuffer.raw + href: https://docs.python.org/3/library/pickle.html#pickle.PickleBuffer.raw + name: raw + uid: pickle.PickleBuffer.raw +- fullName: pickle.PickleBuffer.release + href: https://docs.python.org/3/library/pickle.html#pickle.PickleBuffer.release + name: release + uid: pickle.PickleBuffer.release +- fullName: pickle.Pickler.dump + href: https://docs.python.org/3/library/pickle.html#pickle.Pickler.dump + name: dump + uid: pickle.Pickler.dump +- fullName: pickle.Pickler.persistent_id + href: https://docs.python.org/3/library/pickle.html#pickle.Pickler.persistent_id + name: persistent_id + uid: pickle.Pickler.persistent_id +- fullName: pickle.Pickler.reducer_override + href: https://docs.python.org/3/library/pickle.html#pickle.Pickler.reducer_override + name: reducer_override + uid: pickle.Pickler.reducer_override +- fullName: pickle.Unpickler.find_class + href: https://docs.python.org/3/library/pickle.html#pickle.Unpickler.find_class + name: find_class + uid: pickle.Unpickler.find_class +- fullName: pickle.Unpickler.load + href: https://docs.python.org/3/library/pickle.html#pickle.Unpickler.load + name: load + uid: pickle.Unpickler.load +- fullName: pickle.Unpickler.persistent_load + href: https://docs.python.org/3/library/pickle.html#pickle.Unpickler.persistent_load + name: persistent_load + uid: pickle.Unpickler.persistent_load +- fullName: poplib.POP3.apop + href: https://docs.python.org/3/library/poplib.html#poplib.POP3.apop + name: apop + uid: poplib.POP3.apop +- fullName: poplib.POP3.capa + href: https://docs.python.org/3/library/poplib.html#poplib.POP3.capa + name: capa + uid: poplib.POP3.capa +- fullName: poplib.POP3.dele + href: https://docs.python.org/3/library/poplib.html#poplib.POP3.dele + name: dele + uid: poplib.POP3.dele +- fullName: poplib.POP3.getwelcome + href: https://docs.python.org/3/library/poplib.html#poplib.POP3.getwelcome + name: getwelcome + uid: poplib.POP3.getwelcome +- fullName: poplib.POP3.list + href: https://docs.python.org/3/library/poplib.html#poplib.POP3.list + name: list + uid: poplib.POP3.list +- fullName: poplib.POP3.noop + href: https://docs.python.org/3/library/poplib.html#poplib.POP3.noop + name: noop + uid: poplib.POP3.noop +- fullName: poplib.POP3.pass_ + href: https://docs.python.org/3/library/poplib.html#poplib.POP3.pass_ + name: pass_ + uid: poplib.POP3.pass_ +- fullName: poplib.POP3.quit + href: https://docs.python.org/3/library/poplib.html#poplib.POP3.quit + name: quit + uid: poplib.POP3.quit +- fullName: poplib.POP3.retr + href: https://docs.python.org/3/library/poplib.html#poplib.POP3.retr + name: retr + uid: poplib.POP3.retr +- fullName: poplib.POP3.rpop + href: https://docs.python.org/3/library/poplib.html#poplib.POP3.rpop + name: rpop + uid: poplib.POP3.rpop +- fullName: poplib.POP3.rset + href: https://docs.python.org/3/library/poplib.html#poplib.POP3.rset + name: rset + uid: poplib.POP3.rset +- fullName: poplib.POP3.set_debuglevel + href: https://docs.python.org/3/library/poplib.html#poplib.POP3.set_debuglevel + name: set_debuglevel + uid: poplib.POP3.set_debuglevel +- fullName: poplib.POP3.stat + href: https://docs.python.org/3/library/poplib.html#poplib.POP3.stat + name: stat + uid: poplib.POP3.stat +- fullName: poplib.POP3.stls + href: https://docs.python.org/3/library/poplib.html#poplib.POP3.stls + name: stls + uid: poplib.POP3.stls +- fullName: poplib.POP3.top + href: https://docs.python.org/3/library/poplib.html#poplib.POP3.top + name: top + uid: poplib.POP3.top +- fullName: poplib.POP3.uidl + href: https://docs.python.org/3/library/poplib.html#poplib.POP3.uidl + name: uidl + uid: poplib.POP3.uidl +- fullName: poplib.POP3.user + href: https://docs.python.org/3/library/poplib.html#poplib.POP3.user + name: user + uid: poplib.POP3.user +- fullName: poplib.POP3.utf8 + href: https://docs.python.org/3/library/poplib.html#poplib.POP3.utf8 + name: utf8 + uid: poplib.POP3.utf8 +- fullName: pprint.PrettyPrinter.format + href: https://docs.python.org/3/library/pprint.html#pprint.PrettyPrinter.format + name: format + uid: pprint.PrettyPrinter.format +- fullName: pprint.PrettyPrinter.isreadable + href: https://docs.python.org/3/library/pprint.html#pprint.PrettyPrinter.isreadable + name: isreadable + uid: pprint.PrettyPrinter.isreadable +- fullName: pprint.PrettyPrinter.isrecursive + href: https://docs.python.org/3/library/pprint.html#pprint.PrettyPrinter.isrecursive + name: isrecursive + uid: pprint.PrettyPrinter.isrecursive +- fullName: pprint.PrettyPrinter.pformat + href: https://docs.python.org/3/library/pprint.html#pprint.PrettyPrinter.pformat + name: pformat + uid: pprint.PrettyPrinter.pformat +- fullName: pprint.PrettyPrinter.pprint + href: https://docs.python.org/3/library/pprint.html#pprint.PrettyPrinter.pprint + name: pprint + uid: pprint.PrettyPrinter.pprint +- fullName: profile.Profile.create_stats + href: https://docs.python.org/3/library/profile.html#profile.Profile.create_stats + name: create_stats + uid: profile.Profile.create_stats +- fullName: profile.Profile.disable + href: https://docs.python.org/3/library/profile.html#profile.Profile.disable + name: disable + uid: profile.Profile.disable +- fullName: profile.Profile.dump_stats + href: https://docs.python.org/3/library/profile.html#profile.Profile.dump_stats + name: dump_stats + uid: profile.Profile.dump_stats +- fullName: profile.Profile.enable + href: https://docs.python.org/3/library/profile.html#profile.Profile.enable + name: enable + uid: profile.Profile.enable +- fullName: profile.Profile.print_stats + href: https://docs.python.org/3/library/profile.html#profile.Profile.print_stats + name: print_stats + uid: profile.Profile.print_stats +- fullName: profile.Profile.run + href: https://docs.python.org/3/library/profile.html#profile.Profile.run + name: run + uid: profile.Profile.run +- fullName: profile.Profile.runcall + href: https://docs.python.org/3/library/profile.html#profile.Profile.runcall + name: runcall + uid: profile.Profile.runcall +- fullName: profile.Profile.runctx + href: https://docs.python.org/3/library/profile.html#profile.Profile.runctx + name: runctx + uid: profile.Profile.runctx +- fullName: pstats.Stats.add + href: https://docs.python.org/3/library/profile.html#pstats.Stats.add + name: add + uid: pstats.Stats.add +- fullName: pstats.Stats.dump_stats + href: https://docs.python.org/3/library/profile.html#pstats.Stats.dump_stats + name: dump_stats + uid: pstats.Stats.dump_stats +- fullName: pstats.Stats.get_stats_profile + href: https://docs.python.org/3/library/profile.html#pstats.Stats.get_stats_profile + name: get_stats_profile + uid: pstats.Stats.get_stats_profile +- fullName: pstats.Stats.print_callees + href: https://docs.python.org/3/library/profile.html#pstats.Stats.print_callees + name: print_callees + uid: pstats.Stats.print_callees +- fullName: pstats.Stats.print_callers + href: https://docs.python.org/3/library/profile.html#pstats.Stats.print_callers + name: print_callers + uid: pstats.Stats.print_callers +- fullName: pstats.Stats.print_stats + href: https://docs.python.org/3/library/profile.html#pstats.Stats.print_stats + name: print_stats + uid: pstats.Stats.print_stats +- fullName: pstats.Stats.reverse_order + href: https://docs.python.org/3/library/profile.html#pstats.Stats.reverse_order + name: reverse_order + uid: pstats.Stats.reverse_order +- fullName: pstats.Stats.sort_stats + href: https://docs.python.org/3/library/profile.html#pstats.Stats.sort_stats + name: sort_stats + uid: pstats.Stats.sort_stats +- fullName: pstats.Stats.strip_dirs + href: https://docs.python.org/3/library/profile.html#pstats.Stats.strip_dirs + name: strip_dirs + uid: pstats.Stats.strip_dirs +- fullName: queue.Queue.empty + href: https://docs.python.org/3/library/queue.html#queue.Queue.empty + name: empty + uid: queue.Queue.empty +- fullName: queue.Queue.full + href: https://docs.python.org/3/library/queue.html#queue.Queue.full + name: full + uid: queue.Queue.full +- fullName: queue.Queue.get + href: https://docs.python.org/3/library/queue.html#queue.Queue.get + name: get + uid: queue.Queue.get +- fullName: queue.Queue.get_nowait + href: https://docs.python.org/3/library/queue.html#queue.Queue.get_nowait + name: get_nowait + uid: queue.Queue.get_nowait +- fullName: queue.Queue.join + href: https://docs.python.org/3/library/queue.html#queue.Queue.join + name: join + uid: queue.Queue.join +- fullName: queue.Queue.put + href: https://docs.python.org/3/library/queue.html#queue.Queue.put + name: put + uid: queue.Queue.put +- fullName: queue.Queue.put_nowait + href: https://docs.python.org/3/library/queue.html#queue.Queue.put_nowait + name: put_nowait + uid: queue.Queue.put_nowait +- fullName: queue.Queue.qsize + href: https://docs.python.org/3/library/queue.html#queue.Queue.qsize + name: qsize + uid: queue.Queue.qsize +- fullName: queue.Queue.shutdown + href: https://docs.python.org/3/library/queue.html#queue.Queue.shutdown + name: shutdown + uid: queue.Queue.shutdown +- fullName: queue.Queue.task_done + href: https://docs.python.org/3/library/queue.html#queue.Queue.task_done + name: task_done + uid: queue.Queue.task_done +- fullName: queue.SimpleQueue.empty + href: https://docs.python.org/3/library/queue.html#queue.SimpleQueue.empty + name: empty + uid: queue.SimpleQueue.empty +- fullName: queue.SimpleQueue.get + href: https://docs.python.org/3/library/queue.html#queue.SimpleQueue.get + name: get + uid: queue.SimpleQueue.get +- fullName: queue.SimpleQueue.get_nowait + href: https://docs.python.org/3/library/queue.html#queue.SimpleQueue.get_nowait + name: get_nowait + uid: queue.SimpleQueue.get_nowait +- fullName: queue.SimpleQueue.put + href: https://docs.python.org/3/library/queue.html#queue.SimpleQueue.put + name: put + uid: queue.SimpleQueue.put +- fullName: queue.SimpleQueue.put_nowait + href: https://docs.python.org/3/library/queue.html#queue.SimpleQueue.put_nowait + name: put_nowait + uid: queue.SimpleQueue.put_nowait +- fullName: queue.SimpleQueue.qsize + href: https://docs.python.org/3/library/queue.html#queue.SimpleQueue.qsize + name: qsize + uid: queue.SimpleQueue.qsize +- fullName: random.Random.getrandbits + href: https://docs.python.org/3/library/random.html#random.Random.getrandbits + name: getrandbits + uid: random.Random.getrandbits +- fullName: random.Random.getstate + href: https://docs.python.org/3/library/random.html#random.Random.getstate + name: getstate + uid: random.Random.getstate +- fullName: random.Random.random + href: https://docs.python.org/3/library/random.html#random.Random.random + name: random + uid: random.Random.random +- fullName: random.Random.seed + href: https://docs.python.org/3/library/random.html#random.Random.seed + name: seed + uid: random.Random.seed +- fullName: random.Random.setstate + href: https://docs.python.org/3/library/random.html#random.Random.setstate + name: setstate + uid: random.Random.setstate +- fullName: re.Match.__getitem__ + href: https://docs.python.org/3/library/re.html#re.Match.__getitem__ + name: __getitem__ + uid: re.Match.__getitem__ +- fullName: re.Match.end + href: https://docs.python.org/3/library/re.html#re.Match.end + name: end + uid: re.Match.end +- fullName: re.Match.expand + href: https://docs.python.org/3/library/re.html#re.Match.expand + name: expand + uid: re.Match.expand +- fullName: re.Match.group + href: https://docs.python.org/3/library/re.html#re.Match.group + name: group + uid: re.Match.group +- fullName: re.Match.groupdict + href: https://docs.python.org/3/library/re.html#re.Match.groupdict + name: groupdict + uid: re.Match.groupdict +- fullName: re.Match.groups + href: https://docs.python.org/3/library/re.html#re.Match.groups + name: groups + uid: re.Match.groups +- fullName: re.Match.span + href: https://docs.python.org/3/library/re.html#re.Match.span + name: span + uid: re.Match.span +- fullName: re.Match.start + href: https://docs.python.org/3/library/re.html#re.Match.start + name: start + uid: re.Match.start +- fullName: re.Pattern.findall + href: https://docs.python.org/3/library/re.html#re.Pattern.findall + name: findall + uid: re.Pattern.findall +- fullName: re.Pattern.finditer + href: https://docs.python.org/3/library/re.html#re.Pattern.finditer + name: finditer + uid: re.Pattern.finditer +- fullName: re.Pattern.fullmatch + href: https://docs.python.org/3/library/re.html#re.Pattern.fullmatch + name: fullmatch + uid: re.Pattern.fullmatch +- fullName: re.Pattern.match + href: https://docs.python.org/3/library/re.html#re.Pattern.match + name: match + uid: re.Pattern.match +- fullName: re.Pattern.search + href: https://docs.python.org/3/library/re.html#re.Pattern.search + name: search + uid: re.Pattern.search +- fullName: re.Pattern.split + href: https://docs.python.org/3/library/re.html#re.Pattern.split + name: split + uid: re.Pattern.split +- fullName: re.Pattern.sub + href: https://docs.python.org/3/library/re.html#re.Pattern.sub + name: sub + uid: re.Pattern.sub +- fullName: re.Pattern.subn + href: https://docs.python.org/3/library/re.html#re.Pattern.subn + name: subn + uid: re.Pattern.subn +- fullName: reprlib.Repr.repr + href: https://docs.python.org/3/library/reprlib.html#reprlib.Repr.repr + name: repr + uid: reprlib.Repr.repr +- fullName: reprlib.Repr.repr1 + href: https://docs.python.org/3/library/reprlib.html#reprlib.Repr.repr1 + name: repr1 + uid: reprlib.Repr.repr1 +- fullName: rlcompleter.Completer.complete + href: https://docs.python.org/3/library/rlcompleter.html#rlcompleter.Completer.complete + name: complete + uid: rlcompleter.Completer.complete +- fullName: sched.scheduler.cancel + href: https://docs.python.org/3/library/sched.html#sched.scheduler.cancel + name: cancel + uid: sched.scheduler.cancel +- fullName: sched.scheduler.empty + href: https://docs.python.org/3/library/sched.html#sched.scheduler.empty + name: empty + uid: sched.scheduler.empty +- fullName: sched.scheduler.enter + href: https://docs.python.org/3/library/sched.html#sched.scheduler.enter + name: enter + uid: sched.scheduler.enter +- fullName: sched.scheduler.enterabs + href: https://docs.python.org/3/library/sched.html#sched.scheduler.enterabs + name: enterabs + uid: sched.scheduler.enterabs +- fullName: sched.scheduler.run + href: https://docs.python.org/3/library/sched.html#sched.scheduler.run + name: run + uid: sched.scheduler.run +- fullName: select.devpoll.close + href: https://docs.python.org/3/library/select.html#select.devpoll.close + name: close + uid: select.devpoll.close +- fullName: select.devpoll.fileno + href: https://docs.python.org/3/library/select.html#select.devpoll.fileno + name: fileno + uid: select.devpoll.fileno +- fullName: select.devpoll.modify + href: https://docs.python.org/3/library/select.html#select.devpoll.modify + name: modify + uid: select.devpoll.modify +- fullName: select.devpoll.poll + href: https://docs.python.org/3/library/select.html#select.devpoll.poll + name: poll + uid: select.devpoll.poll +- fullName: select.devpoll.register + href: https://docs.python.org/3/library/select.html#select.devpoll.register + name: register + uid: select.devpoll.register +- fullName: select.devpoll.unregister + href: https://docs.python.org/3/library/select.html#select.devpoll.unregister + name: unregister + uid: select.devpoll.unregister +- fullName: select.epoll.close + href: https://docs.python.org/3/library/select.html#select.epoll.close + name: close + uid: select.epoll.close +- fullName: select.epoll.fileno + href: https://docs.python.org/3/library/select.html#select.epoll.fileno + name: fileno + uid: select.epoll.fileno +- fullName: select.epoll.fromfd + href: https://docs.python.org/3/library/select.html#select.epoll.fromfd + name: fromfd + uid: select.epoll.fromfd +- fullName: select.epoll.modify + href: https://docs.python.org/3/library/select.html#select.epoll.modify + name: modify + uid: select.epoll.modify +- fullName: select.epoll.poll + href: https://docs.python.org/3/library/select.html#select.epoll.poll + name: poll + uid: select.epoll.poll +- fullName: select.epoll.register + href: https://docs.python.org/3/library/select.html#select.epoll.register + name: register + uid: select.epoll.register +- fullName: select.epoll.unregister + href: https://docs.python.org/3/library/select.html#select.epoll.unregister + name: unregister + uid: select.epoll.unregister +- fullName: select.kqueue.close + href: https://docs.python.org/3/library/select.html#select.kqueue.close + name: close + uid: select.kqueue.close +- fullName: select.kqueue.control + href: https://docs.python.org/3/library/select.html#select.kqueue.control + name: control + uid: select.kqueue.control +- fullName: select.kqueue.fileno + href: https://docs.python.org/3/library/select.html#select.kqueue.fileno + name: fileno + uid: select.kqueue.fileno +- fullName: select.kqueue.fromfd + href: https://docs.python.org/3/library/select.html#select.kqueue.fromfd + name: fromfd + uid: select.kqueue.fromfd +- fullName: select.poll.modify + href: https://docs.python.org/3/library/select.html#select.poll.modify + name: modify + uid: select.poll.modify +- fullName: select.poll.poll + href: https://docs.python.org/3/library/select.html#select.poll.poll + name: poll + uid: select.poll.poll +- fullName: select.poll.register + href: https://docs.python.org/3/library/select.html#select.poll.register + name: register + uid: select.poll.register +- fullName: select.poll.unregister + href: https://docs.python.org/3/library/select.html#select.poll.unregister + name: unregister + uid: select.poll.unregister +- fullName: selectors.BaseSelector.close + href: https://docs.python.org/3/library/selectors.html#selectors.BaseSelector.close + name: close + uid: selectors.BaseSelector.close +- fullName: selectors.BaseSelector.get_key + href: https://docs.python.org/3/library/selectors.html#selectors.BaseSelector.get_key + name: get_key + uid: selectors.BaseSelector.get_key +- fullName: selectors.BaseSelector.get_map + href: https://docs.python.org/3/library/selectors.html#selectors.BaseSelector.get_map + name: get_map + uid: selectors.BaseSelector.get_map +- fullName: selectors.BaseSelector.modify + href: https://docs.python.org/3/library/selectors.html#selectors.BaseSelector.modify + name: modify + uid: selectors.BaseSelector.modify +- fullName: selectors.BaseSelector.register + href: https://docs.python.org/3/library/selectors.html#selectors.BaseSelector.register + name: register + uid: selectors.BaseSelector.register +- fullName: selectors.BaseSelector.select + href: https://docs.python.org/3/library/selectors.html#selectors.BaseSelector.select + name: select + uid: selectors.BaseSelector.select +- fullName: selectors.BaseSelector.unregister + href: https://docs.python.org/3/library/selectors.html#selectors.BaseSelector.unregister + name: unregister + uid: selectors.BaseSelector.unregister +- fullName: selectors.DevpollSelector.fileno + href: https://docs.python.org/3/library/selectors.html#selectors.DevpollSelector.fileno + name: fileno + uid: selectors.DevpollSelector.fileno +- fullName: selectors.EpollSelector.fileno + href: https://docs.python.org/3/library/selectors.html#selectors.EpollSelector.fileno + name: fileno + uid: selectors.EpollSelector.fileno +- fullName: selectors.KqueueSelector.fileno + href: https://docs.python.org/3/library/selectors.html#selectors.KqueueSelector.fileno + name: fileno + uid: selectors.KqueueSelector.fileno +- fullName: shelve.Shelf.close + href: https://docs.python.org/3/library/shelve.html#shelve.Shelf.close + name: close + uid: shelve.Shelf.close +- fullName: shelve.Shelf.sync + href: https://docs.python.org/3/library/shelve.html#shelve.Shelf.sync + name: sync + uid: shelve.Shelf.sync +- fullName: shlex.shlex.error_leader + href: https://docs.python.org/3/library/shlex.html#shlex.shlex.error_leader + name: error_leader + uid: shlex.shlex.error_leader +- fullName: shlex.shlex.get_token + href: https://docs.python.org/3/library/shlex.html#shlex.shlex.get_token + name: get_token + uid: shlex.shlex.get_token +- fullName: shlex.shlex.pop_source + href: https://docs.python.org/3/library/shlex.html#shlex.shlex.pop_source + name: pop_source + uid: shlex.shlex.pop_source +- fullName: shlex.shlex.push_source + href: https://docs.python.org/3/library/shlex.html#shlex.shlex.push_source + name: push_source + uid: shlex.shlex.push_source +- fullName: shlex.shlex.push_token + href: https://docs.python.org/3/library/shlex.html#shlex.shlex.push_token + name: push_token + uid: shlex.shlex.push_token +- fullName: shlex.shlex.read_token + href: https://docs.python.org/3/library/shlex.html#shlex.shlex.read_token + name: read_token + uid: shlex.shlex.read_token +- fullName: shlex.shlex.sourcehook + href: https://docs.python.org/3/library/shlex.html#shlex.shlex.sourcehook + name: sourcehook + uid: shlex.shlex.sourcehook +- fullName: slice.indices + href: https://docs.python.org/3/reference/datamodel.html#slice.indices + name: indices + uid: slice.indices +- fullName: smtplib.SMTP.auth + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTP.auth + name: auth + uid: smtplib.SMTP.auth +- fullName: smtplib.SMTP.connect + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTP.connect + name: connect + uid: smtplib.SMTP.connect +- fullName: smtplib.SMTP.docmd + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTP.docmd + name: docmd + uid: smtplib.SMTP.docmd +- fullName: smtplib.SMTP.ehlo + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTP.ehlo + name: ehlo + uid: smtplib.SMTP.ehlo +- fullName: smtplib.SMTP.ehlo_or_helo_if_needed + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTP.ehlo_or_helo_if_needed + name: ehlo_or_helo_if_needed + uid: smtplib.SMTP.ehlo_or_helo_if_needed +- fullName: smtplib.SMTP.has_extn + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTP.has_extn + name: has_extn + uid: smtplib.SMTP.has_extn +- fullName: smtplib.SMTP.helo + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTP.helo + name: helo + uid: smtplib.SMTP.helo +- fullName: smtplib.SMTP.login + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTP.login + name: login + uid: smtplib.SMTP.login +- fullName: smtplib.SMTP.quit + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTP.quit + name: quit + uid: smtplib.SMTP.quit +- fullName: smtplib.SMTP.send_message + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTP.send_message + name: send_message + uid: smtplib.SMTP.send_message +- fullName: smtplib.SMTP.sendmail + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTP.sendmail + name: sendmail + uid: smtplib.SMTP.sendmail +- fullName: smtplib.SMTP.set_debuglevel + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTP.set_debuglevel + name: set_debuglevel + uid: smtplib.SMTP.set_debuglevel +- fullName: smtplib.SMTP.starttls + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTP.starttls + name: starttls + uid: smtplib.SMTP.starttls +- fullName: smtplib.SMTP.verify + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTP.verify + name: verify + uid: smtplib.SMTP.verify +- fullName: socket.socket.accept + href: https://docs.python.org/3/library/socket.html#socket.socket.accept + name: accept + uid: socket.socket.accept +- fullName: socket.socket.bind + href: https://docs.python.org/3/library/socket.html#socket.socket.bind + name: bind + uid: socket.socket.bind +- fullName: socket.socket.close + href: https://docs.python.org/3/library/socket.html#socket.socket.close + name: close + uid: socket.socket.close +- fullName: socket.socket.connect + href: https://docs.python.org/3/library/socket.html#socket.socket.connect + name: connect + uid: socket.socket.connect +- fullName: socket.socket.connect_ex + href: https://docs.python.org/3/library/socket.html#socket.socket.connect_ex + name: connect_ex + uid: socket.socket.connect_ex +- fullName: socket.socket.detach + href: https://docs.python.org/3/library/socket.html#socket.socket.detach + name: detach + uid: socket.socket.detach +- fullName: socket.socket.dup + href: https://docs.python.org/3/library/socket.html#socket.socket.dup + name: dup + uid: socket.socket.dup +- fullName: socket.socket.fileno + href: https://docs.python.org/3/library/socket.html#socket.socket.fileno + name: fileno + uid: socket.socket.fileno +- fullName: socket.socket.get_inheritable + href: https://docs.python.org/3/library/socket.html#socket.socket.get_inheritable + name: get_inheritable + uid: socket.socket.get_inheritable +- fullName: socket.socket.getblocking + href: https://docs.python.org/3/library/socket.html#socket.socket.getblocking + name: getblocking + uid: socket.socket.getblocking +- fullName: socket.socket.getpeername + href: https://docs.python.org/3/library/socket.html#socket.socket.getpeername + name: getpeername + uid: socket.socket.getpeername +- fullName: socket.socket.getsockname + href: https://docs.python.org/3/library/socket.html#socket.socket.getsockname + name: getsockname + uid: socket.socket.getsockname +- fullName: socket.socket.getsockopt + href: https://docs.python.org/3/library/socket.html#socket.socket.getsockopt + name: getsockopt + uid: socket.socket.getsockopt +- fullName: socket.socket.gettimeout + href: https://docs.python.org/3/library/socket.html#socket.socket.gettimeout + name: gettimeout + uid: socket.socket.gettimeout +- fullName: socket.socket.ioctl + href: https://docs.python.org/3/library/socket.html#socket.socket.ioctl + name: ioctl + uid: socket.socket.ioctl +- fullName: socket.socket.listen + href: https://docs.python.org/3/library/socket.html#socket.socket.listen + name: listen + uid: socket.socket.listen +- fullName: socket.socket.makefile + href: https://docs.python.org/3/library/socket.html#socket.socket.makefile + name: makefile + uid: socket.socket.makefile +- fullName: socket.socket.recv + href: https://docs.python.org/3/library/socket.html#socket.socket.recv + name: recv + uid: socket.socket.recv +- fullName: socket.socket.recv_into + href: https://docs.python.org/3/library/socket.html#socket.socket.recv_into + name: recv_into + uid: socket.socket.recv_into +- fullName: socket.socket.recvfrom + href: https://docs.python.org/3/library/socket.html#socket.socket.recvfrom + name: recvfrom + uid: socket.socket.recvfrom +- fullName: socket.socket.recvfrom_into + href: https://docs.python.org/3/library/socket.html#socket.socket.recvfrom_into + name: recvfrom_into + uid: socket.socket.recvfrom_into +- fullName: socket.socket.recvmsg + href: https://docs.python.org/3/library/socket.html#socket.socket.recvmsg + name: recvmsg + uid: socket.socket.recvmsg +- fullName: socket.socket.recvmsg_into + href: https://docs.python.org/3/library/socket.html#socket.socket.recvmsg_into + name: recvmsg_into + uid: socket.socket.recvmsg_into +- fullName: socket.socket.send + href: https://docs.python.org/3/library/socket.html#socket.socket.send + name: send + uid: socket.socket.send +- fullName: socket.socket.sendall + href: https://docs.python.org/3/library/socket.html#socket.socket.sendall + name: sendall + uid: socket.socket.sendall +- fullName: socket.socket.sendfile + href: https://docs.python.org/3/library/socket.html#socket.socket.sendfile + name: sendfile + uid: socket.socket.sendfile +- fullName: socket.socket.sendmsg + href: https://docs.python.org/3/library/socket.html#socket.socket.sendmsg + name: sendmsg + uid: socket.socket.sendmsg +- fullName: socket.socket.sendmsg_afalg + href: https://docs.python.org/3/library/socket.html#socket.socket.sendmsg_afalg + name: sendmsg_afalg + uid: socket.socket.sendmsg_afalg +- fullName: socket.socket.sendto + href: https://docs.python.org/3/library/socket.html#socket.socket.sendto + name: sendto + uid: socket.socket.sendto +- fullName: socket.socket.set_inheritable + href: https://docs.python.org/3/library/socket.html#socket.socket.set_inheritable + name: set_inheritable + uid: socket.socket.set_inheritable +- fullName: socket.socket.setblocking + href: https://docs.python.org/3/library/socket.html#socket.socket.setblocking + name: setblocking + uid: socket.socket.setblocking +- fullName: socket.socket.setsockopt + href: https://docs.python.org/3/library/socket.html#socket.socket.setsockopt + name: setsockopt + uid: socket.socket.setsockopt +- fullName: socket.socket.settimeout + href: https://docs.python.org/3/library/socket.html#socket.socket.settimeout + name: settimeout + uid: socket.socket.settimeout +- fullName: socket.socket.share + href: https://docs.python.org/3/library/socket.html#socket.socket.share + name: share + uid: socket.socket.share +- fullName: socket.socket.shutdown + href: https://docs.python.org/3/library/socket.html#socket.socket.shutdown + name: shutdown + uid: socket.socket.shutdown +- fullName: socketserver.BaseRequestHandler.finish + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseRequestHandler.finish + name: finish + uid: socketserver.BaseRequestHandler.finish +- fullName: socketserver.BaseRequestHandler.handle + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseRequestHandler.handle + name: handle + uid: socketserver.BaseRequestHandler.handle +- fullName: socketserver.BaseRequestHandler.setup + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseRequestHandler.setup + name: setup + uid: socketserver.BaseRequestHandler.setup +- fullName: socketserver.BaseServer.fileno + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseServer.fileno + name: fileno + uid: socketserver.BaseServer.fileno +- fullName: socketserver.BaseServer.finish_request + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseServer.finish_request + name: finish_request + uid: socketserver.BaseServer.finish_request +- fullName: socketserver.BaseServer.get_request + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseServer.get_request + name: get_request + uid: socketserver.BaseServer.get_request +- fullName: socketserver.BaseServer.handle_error + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseServer.handle_error + name: handle_error + uid: socketserver.BaseServer.handle_error +- fullName: socketserver.BaseServer.handle_request + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseServer.handle_request + name: handle_request + uid: socketserver.BaseServer.handle_request +- fullName: socketserver.BaseServer.handle_timeout + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseServer.handle_timeout + name: handle_timeout + uid: socketserver.BaseServer.handle_timeout +- fullName: socketserver.BaseServer.process_request + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseServer.process_request + name: process_request + uid: socketserver.BaseServer.process_request +- fullName: socketserver.BaseServer.serve_forever + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseServer.serve_forever + name: serve_forever + uid: socketserver.BaseServer.serve_forever +- fullName: socketserver.BaseServer.server_activate + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseServer.server_activate + name: server_activate + uid: socketserver.BaseServer.server_activate +- fullName: socketserver.BaseServer.server_bind + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseServer.server_bind + name: server_bind + uid: socketserver.BaseServer.server_bind +- fullName: socketserver.BaseServer.server_close + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseServer.server_close + name: server_close + uid: socketserver.BaseServer.server_close +- fullName: socketserver.BaseServer.service_actions + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseServer.service_actions + name: service_actions + uid: socketserver.BaseServer.service_actions +- fullName: socketserver.BaseServer.shutdown + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseServer.shutdown + name: shutdown + uid: socketserver.BaseServer.shutdown +- fullName: socketserver.BaseServer.verify_request + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseServer.verify_request + name: verify_request + uid: socketserver.BaseServer.verify_request +- fullName: sqlite3.Blob.close + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Blob.close + name: close + uid: sqlite3.Blob.close +- fullName: sqlite3.Blob.read + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Blob.read + name: read + uid: sqlite3.Blob.read +- fullName: sqlite3.Blob.seek + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Blob.seek + name: seek + uid: sqlite3.Blob.seek +- fullName: sqlite3.Blob.tell + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Blob.tell + name: tell + uid: sqlite3.Blob.tell +- fullName: sqlite3.Blob.write + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Blob.write + name: write + uid: sqlite3.Blob.write +- fullName: sqlite3.Connection.backup + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.backup + name: backup + uid: sqlite3.Connection.backup +- fullName: sqlite3.Connection.blobopen + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.blobopen + name: blobopen + uid: sqlite3.Connection.blobopen +- fullName: sqlite3.Connection.close + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.close + name: close + uid: sqlite3.Connection.close +- fullName: sqlite3.Connection.commit + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.commit + name: commit + uid: sqlite3.Connection.commit +- fullName: sqlite3.Connection.create_aggregate + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.create_aggregate + name: create_aggregate + uid: sqlite3.Connection.create_aggregate +- fullName: sqlite3.Connection.create_collation + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.create_collation + name: create_collation + uid: sqlite3.Connection.create_collation +- fullName: sqlite3.Connection.create_function + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.create_function + name: create_function + uid: sqlite3.Connection.create_function +- fullName: sqlite3.Connection.create_window_function + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.create_window_function + name: create_window_function + uid: sqlite3.Connection.create_window_function +- fullName: sqlite3.Connection.cursor + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.cursor + name: cursor + uid: sqlite3.Connection.cursor +- fullName: sqlite3.Connection.deserialize + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.deserialize + name: deserialize + uid: sqlite3.Connection.deserialize +- fullName: sqlite3.Connection.enable_load_extension + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.enable_load_extension + name: enable_load_extension + uid: sqlite3.Connection.enable_load_extension +- fullName: sqlite3.Connection.execute + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.execute + name: execute + uid: sqlite3.Connection.execute +- fullName: sqlite3.Connection.executemany + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.executemany + name: executemany + uid: sqlite3.Connection.executemany +- fullName: sqlite3.Connection.executescript + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.executescript + name: executescript + uid: sqlite3.Connection.executescript +- fullName: sqlite3.Connection.getconfig + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.getconfig + name: getconfig + uid: sqlite3.Connection.getconfig +- fullName: sqlite3.Connection.getlimit + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.getlimit + name: getlimit + uid: sqlite3.Connection.getlimit +- fullName: sqlite3.Connection.interrupt + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.interrupt + name: interrupt + uid: sqlite3.Connection.interrupt +- fullName: sqlite3.Connection.iterdump + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.iterdump + name: iterdump + uid: sqlite3.Connection.iterdump +- fullName: sqlite3.Connection.load_extension + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.load_extension + name: load_extension + uid: sqlite3.Connection.load_extension +- fullName: sqlite3.Connection.rollback + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.rollback + name: rollback + uid: sqlite3.Connection.rollback +- fullName: sqlite3.Connection.serialize + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.serialize + name: serialize + uid: sqlite3.Connection.serialize +- fullName: sqlite3.Connection.set_authorizer + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.set_authorizer + name: set_authorizer + uid: sqlite3.Connection.set_authorizer +- fullName: sqlite3.Connection.set_progress_handler + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.set_progress_handler + name: set_progress_handler + uid: sqlite3.Connection.set_progress_handler +- fullName: sqlite3.Connection.set_trace_callback + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.set_trace_callback + name: set_trace_callback + uid: sqlite3.Connection.set_trace_callback +- fullName: sqlite3.Connection.setconfig + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.setconfig + name: setconfig + uid: sqlite3.Connection.setconfig +- fullName: sqlite3.Connection.setlimit + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection.setlimit + name: setlimit + uid: sqlite3.Connection.setlimit +- fullName: sqlite3.Cursor.close + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Cursor.close + name: close + uid: sqlite3.Cursor.close +- fullName: sqlite3.Cursor.execute + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Cursor.execute + name: execute + uid: sqlite3.Cursor.execute +- fullName: sqlite3.Cursor.executemany + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Cursor.executemany + name: executemany + uid: sqlite3.Cursor.executemany +- fullName: sqlite3.Cursor.executescript + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Cursor.executescript + name: executescript + uid: sqlite3.Cursor.executescript +- fullName: sqlite3.Cursor.fetchall + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Cursor.fetchall + name: fetchall + uid: sqlite3.Cursor.fetchall +- fullName: sqlite3.Cursor.fetchmany + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Cursor.fetchmany + name: fetchmany + uid: sqlite3.Cursor.fetchmany +- fullName: sqlite3.Cursor.fetchone + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Cursor.fetchone + name: fetchone + uid: sqlite3.Cursor.fetchone +- fullName: sqlite3.Cursor.setinputsizes + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Cursor.setinputsizes + name: setinputsizes + uid: sqlite3.Cursor.setinputsizes +- fullName: sqlite3.Cursor.setoutputsize + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Cursor.setoutputsize + name: setoutputsize + uid: sqlite3.Cursor.setoutputsize +- fullName: sqlite3.Row.keys + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Row.keys + name: keys + uid: sqlite3.Row.keys +- fullName: ssl.MemoryBIO.read + href: https://docs.python.org/3/library/ssl.html#ssl.MemoryBIO.read + name: read + uid: ssl.MemoryBIO.read +- fullName: ssl.MemoryBIO.write + href: https://docs.python.org/3/library/ssl.html#ssl.MemoryBIO.write + name: write + uid: ssl.MemoryBIO.write +- fullName: ssl.MemoryBIO.write_eof + href: https://docs.python.org/3/library/ssl.html#ssl.MemoryBIO.write_eof + name: write_eof + uid: ssl.MemoryBIO.write_eof +- fullName: ssl.SSLContext.cert_store_stats + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.cert_store_stats + name: cert_store_stats + uid: ssl.SSLContext.cert_store_stats +- fullName: ssl.SSLContext.get_ca_certs + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.get_ca_certs + name: get_ca_certs + uid: ssl.SSLContext.get_ca_certs +- fullName: ssl.SSLContext.get_ciphers + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.get_ciphers + name: get_ciphers + uid: ssl.SSLContext.get_ciphers +- fullName: ssl.SSLContext.load_cert_chain + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.load_cert_chain + name: load_cert_chain + uid: ssl.SSLContext.load_cert_chain +- fullName: ssl.SSLContext.load_default_certs + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.load_default_certs + name: load_default_certs + uid: ssl.SSLContext.load_default_certs +- fullName: ssl.SSLContext.load_dh_params + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.load_dh_params + name: load_dh_params + uid: ssl.SSLContext.load_dh_params +- fullName: ssl.SSLContext.load_verify_locations + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.load_verify_locations + name: load_verify_locations + uid: ssl.SSLContext.load_verify_locations +- fullName: ssl.SSLContext.session_stats + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.session_stats + name: session_stats + uid: ssl.SSLContext.session_stats +- fullName: ssl.SSLContext.set_alpn_protocols + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.set_alpn_protocols + name: set_alpn_protocols + uid: ssl.SSLContext.set_alpn_protocols +- fullName: ssl.SSLContext.set_ciphers + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.set_ciphers + name: set_ciphers + uid: ssl.SSLContext.set_ciphers +- fullName: ssl.SSLContext.set_default_verify_paths + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.set_default_verify_paths + name: set_default_verify_paths + uid: ssl.SSLContext.set_default_verify_paths +- fullName: ssl.SSLContext.set_ecdh_curve + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.set_ecdh_curve + name: set_ecdh_curve + uid: ssl.SSLContext.set_ecdh_curve +- fullName: ssl.SSLContext.set_npn_protocols + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.set_npn_protocols + name: set_npn_protocols + uid: ssl.SSLContext.set_npn_protocols +- fullName: ssl.SSLContext.set_psk_client_callback + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.set_psk_client_callback + name: set_psk_client_callback + uid: ssl.SSLContext.set_psk_client_callback +- fullName: ssl.SSLContext.set_psk_server_callback + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.set_psk_server_callback + name: set_psk_server_callback + uid: ssl.SSLContext.set_psk_server_callback +- fullName: ssl.SSLContext.wrap_bio + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.wrap_bio + name: wrap_bio + uid: ssl.SSLContext.wrap_bio +- fullName: ssl.SSLContext.wrap_socket + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext.wrap_socket + name: wrap_socket + uid: ssl.SSLContext.wrap_socket +- fullName: ssl.SSLSocket.cipher + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSocket.cipher + name: cipher + uid: ssl.SSLSocket.cipher +- fullName: ssl.SSLSocket.compression + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSocket.compression + name: compression + uid: ssl.SSLSocket.compression +- fullName: ssl.SSLSocket.do_handshake + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSocket.do_handshake + name: do_handshake + uid: ssl.SSLSocket.do_handshake +- fullName: ssl.SSLSocket.get_channel_binding + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSocket.get_channel_binding + name: get_channel_binding + uid: ssl.SSLSocket.get_channel_binding +- fullName: ssl.SSLSocket.get_unverified_chain + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSocket.get_unverified_chain + name: get_unverified_chain + uid: ssl.SSLSocket.get_unverified_chain +- fullName: ssl.SSLSocket.get_verified_chain + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSocket.get_verified_chain + name: get_verified_chain + uid: ssl.SSLSocket.get_verified_chain +- fullName: ssl.SSLSocket.getpeercert + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSocket.getpeercert + name: getpeercert + uid: ssl.SSLSocket.getpeercert +- fullName: ssl.SSLSocket.pending + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSocket.pending + name: pending + uid: ssl.SSLSocket.pending +- fullName: ssl.SSLSocket.read + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSocket.read + name: read + uid: ssl.SSLSocket.read +- fullName: ssl.SSLSocket.selected_alpn_protocol + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSocket.selected_alpn_protocol + name: selected_alpn_protocol + uid: ssl.SSLSocket.selected_alpn_protocol +- fullName: ssl.SSLSocket.selected_npn_protocol + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSocket.selected_npn_protocol + name: selected_npn_protocol + uid: ssl.SSLSocket.selected_npn_protocol +- fullName: ssl.SSLSocket.shared_ciphers + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSocket.shared_ciphers + name: shared_ciphers + uid: ssl.SSLSocket.shared_ciphers +- fullName: ssl.SSLSocket.unwrap + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSocket.unwrap + name: unwrap + uid: ssl.SSLSocket.unwrap +- fullName: ssl.SSLSocket.verify_client_post_handshake + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSocket.verify_client_post_handshake + name: verify_client_post_handshake + uid: ssl.SSLSocket.verify_client_post_handshake +- fullName: ssl.SSLSocket.version + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSocket.version + name: version + uid: ssl.SSLSocket.version +- fullName: ssl.SSLSocket.write + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSocket.write + name: write + uid: ssl.SSLSocket.write +- fullName: statistics.NormalDist.cdf + href: https://docs.python.org/3/library/statistics.html#statistics.NormalDist.cdf + name: cdf + uid: statistics.NormalDist.cdf +- fullName: statistics.NormalDist.from_samples + href: https://docs.python.org/3/library/statistics.html#statistics.NormalDist.from_samples + name: from_samples + uid: statistics.NormalDist.from_samples +- fullName: statistics.NormalDist.inv_cdf + href: https://docs.python.org/3/library/statistics.html#statistics.NormalDist.inv_cdf + name: inv_cdf + uid: statistics.NormalDist.inv_cdf +- fullName: statistics.NormalDist.overlap + href: https://docs.python.org/3/library/statistics.html#statistics.NormalDist.overlap + name: overlap + uid: statistics.NormalDist.overlap +- fullName: statistics.NormalDist.pdf + href: https://docs.python.org/3/library/statistics.html#statistics.NormalDist.pdf + name: pdf + uid: statistics.NormalDist.pdf +- fullName: statistics.NormalDist.quantiles + href: https://docs.python.org/3/library/statistics.html#statistics.NormalDist.quantiles + name: quantiles + uid: statistics.NormalDist.quantiles +- fullName: statistics.NormalDist.samples + href: https://docs.python.org/3/library/statistics.html#statistics.NormalDist.samples + name: samples + uid: statistics.NormalDist.samples +- fullName: statistics.NormalDist.zscore + href: https://docs.python.org/3/library/statistics.html#statistics.NormalDist.zscore + name: zscore + uid: statistics.NormalDist.zscore +- fullName: str.capitalize + href: https://docs.python.org/3/library/stdtypes.html#str.capitalize + name: capitalize + uid: str.capitalize +- fullName: str.casefold + href: https://docs.python.org/3/library/stdtypes.html#str.casefold + name: casefold + uid: str.casefold +- fullName: str.center + href: https://docs.python.org/3/library/stdtypes.html#str.center + name: center + uid: str.center +- fullName: str.count + href: https://docs.python.org/3/library/stdtypes.html#str.count + name: count + uid: str.count +- fullName: str.encode + href: https://docs.python.org/3/library/stdtypes.html#str.encode + name: encode + uid: str.encode +- fullName: str.endswith + href: https://docs.python.org/3/library/stdtypes.html#str.endswith + name: endswith + uid: str.endswith +- fullName: str.expandtabs + href: https://docs.python.org/3/library/stdtypes.html#str.expandtabs + name: expandtabs + uid: str.expandtabs +- fullName: str.find + href: https://docs.python.org/3/library/stdtypes.html#str.find + name: find + uid: str.find +- fullName: str.format + href: https://docs.python.org/3/library/stdtypes.html#str.format + name: format + uid: str.format +- fullName: str.format_map + href: https://docs.python.org/3/library/stdtypes.html#str.format_map + name: format_map + uid: str.format_map +- fullName: str.index + href: https://docs.python.org/3/library/stdtypes.html#str.index + name: index + uid: str.index +- fullName: str.isalnum + href: https://docs.python.org/3/library/stdtypes.html#str.isalnum + name: isalnum + uid: str.isalnum +- fullName: str.isalpha + href: https://docs.python.org/3/library/stdtypes.html#str.isalpha + name: isalpha + uid: str.isalpha +- fullName: str.isascii + href: https://docs.python.org/3/library/stdtypes.html#str.isascii + name: isascii + uid: str.isascii +- fullName: str.isdecimal + href: https://docs.python.org/3/library/stdtypes.html#str.isdecimal + name: isdecimal + uid: str.isdecimal +- fullName: str.isdigit + href: https://docs.python.org/3/library/stdtypes.html#str.isdigit + name: isdigit + uid: str.isdigit +- fullName: str.isidentifier + href: https://docs.python.org/3/library/stdtypes.html#str.isidentifier + name: isidentifier + uid: str.isidentifier +- fullName: str.islower + href: https://docs.python.org/3/library/stdtypes.html#str.islower + name: islower + uid: str.islower +- fullName: str.isnumeric + href: https://docs.python.org/3/library/stdtypes.html#str.isnumeric + name: isnumeric + uid: str.isnumeric +- fullName: str.isprintable + href: https://docs.python.org/3/library/stdtypes.html#str.isprintable + name: isprintable + uid: str.isprintable +- fullName: str.isspace + href: https://docs.python.org/3/library/stdtypes.html#str.isspace + name: isspace + uid: str.isspace +- fullName: str.istitle + href: https://docs.python.org/3/library/stdtypes.html#str.istitle + name: istitle + uid: str.istitle +- fullName: str.isupper + href: https://docs.python.org/3/library/stdtypes.html#str.isupper + name: isupper + uid: str.isupper +- fullName: str.join + href: https://docs.python.org/3/library/stdtypes.html#str.join + name: join + uid: str.join +- fullName: str.ljust + href: https://docs.python.org/3/library/stdtypes.html#str.ljust + name: ljust + uid: str.ljust +- fullName: str.lower + href: https://docs.python.org/3/library/stdtypes.html#str.lower + name: lower + uid: str.lower +- fullName: str.lstrip + href: https://docs.python.org/3/library/stdtypes.html#str.lstrip + name: lstrip + uid: str.lstrip +- fullName: str.maketrans + href: https://docs.python.org/3/library/stdtypes.html#str.maketrans + name: maketrans + uid: str.maketrans +- fullName: str.partition + href: https://docs.python.org/3/library/stdtypes.html#str.partition + name: partition + uid: str.partition +- fullName: str.removeprefix + href: https://docs.python.org/3/library/stdtypes.html#str.removeprefix + name: removeprefix + uid: str.removeprefix +- fullName: str.removesuffix + href: https://docs.python.org/3/library/stdtypes.html#str.removesuffix + name: removesuffix + uid: str.removesuffix +- fullName: str.replace + href: https://docs.python.org/3/library/stdtypes.html#str.replace + name: replace + uid: str.replace +- fullName: str.rfind + href: https://docs.python.org/3/library/stdtypes.html#str.rfind + name: rfind + uid: str.rfind +- fullName: str.rindex + href: https://docs.python.org/3/library/stdtypes.html#str.rindex + name: rindex + uid: str.rindex +- fullName: str.rjust + href: https://docs.python.org/3/library/stdtypes.html#str.rjust + name: rjust + uid: str.rjust +- fullName: str.rpartition + href: https://docs.python.org/3/library/stdtypes.html#str.rpartition + name: rpartition + uid: str.rpartition +- fullName: str.rsplit + href: https://docs.python.org/3/library/stdtypes.html#str.rsplit + name: rsplit + uid: str.rsplit +- fullName: str.rstrip + href: https://docs.python.org/3/library/stdtypes.html#str.rstrip + name: rstrip + uid: str.rstrip +- fullName: str.split + href: https://docs.python.org/3/library/stdtypes.html#str.split + name: split + uid: str.split +- fullName: str.splitlines + href: https://docs.python.org/3/library/stdtypes.html#str.splitlines + name: splitlines + uid: str.splitlines +- fullName: str.startswith + href: https://docs.python.org/3/library/stdtypes.html#str.startswith + name: startswith + uid: str.startswith +- fullName: str.strip + href: https://docs.python.org/3/library/stdtypes.html#str.strip + name: strip + uid: str.strip +- fullName: str.swapcase + href: https://docs.python.org/3/library/stdtypes.html#str.swapcase + name: swapcase + uid: str.swapcase +- fullName: str.title + href: https://docs.python.org/3/library/stdtypes.html#str.title + name: title + uid: str.title +- fullName: str.translate + href: https://docs.python.org/3/library/stdtypes.html#str.translate + name: translate + uid: str.translate +- fullName: str.upper + href: https://docs.python.org/3/library/stdtypes.html#str.upper + name: upper + uid: str.upper +- fullName: str.zfill + href: https://docs.python.org/3/library/stdtypes.html#str.zfill + name: zfill + uid: str.zfill +- fullName: string.Formatter.check_unused_args + href: https://docs.python.org/3/library/string.html#string.Formatter.check_unused_args + name: check_unused_args + uid: string.Formatter.check_unused_args +- fullName: string.Formatter.convert_field + href: https://docs.python.org/3/library/string.html#string.Formatter.convert_field + name: convert_field + uid: string.Formatter.convert_field +- fullName: string.Formatter.format + href: https://docs.python.org/3/library/string.html#string.Formatter.format + name: format + uid: string.Formatter.format +- fullName: string.Formatter.format_field + href: https://docs.python.org/3/library/string.html#string.Formatter.format_field + name: format_field + uid: string.Formatter.format_field +- fullName: string.Formatter.get_field + href: https://docs.python.org/3/library/string.html#string.Formatter.get_field + name: get_field + uid: string.Formatter.get_field +- fullName: string.Formatter.get_value + href: https://docs.python.org/3/library/string.html#string.Formatter.get_value + name: get_value + uid: string.Formatter.get_value +- fullName: string.Formatter.parse + href: https://docs.python.org/3/library/string.html#string.Formatter.parse + name: parse + uid: string.Formatter.parse +- fullName: string.Formatter.vformat + href: https://docs.python.org/3/library/string.html#string.Formatter.vformat + name: vformat + uid: string.Formatter.vformat +- fullName: string.Template.get_identifiers + href: https://docs.python.org/3/library/string.html#string.Template.get_identifiers + name: get_identifiers + uid: string.Template.get_identifiers +- fullName: string.Template.is_valid + href: https://docs.python.org/3/library/string.html#string.Template.is_valid + name: is_valid + uid: string.Template.is_valid +- fullName: string.Template.safe_substitute + href: https://docs.python.org/3/library/string.html#string.Template.safe_substitute + name: safe_substitute + uid: string.Template.safe_substitute +- fullName: string.Template.substitute + href: https://docs.python.org/3/library/string.html#string.Template.substitute + name: substitute + uid: string.Template.substitute +- fullName: struct.Struct.iter_unpack + href: https://docs.python.org/3/library/struct.html#struct.Struct.iter_unpack + name: iter_unpack + uid: struct.Struct.iter_unpack +- fullName: struct.Struct.pack + href: https://docs.python.org/3/library/struct.html#struct.Struct.pack + name: pack + uid: struct.Struct.pack +- fullName: struct.Struct.pack_into + href: https://docs.python.org/3/library/struct.html#struct.Struct.pack_into + name: pack_into + uid: struct.Struct.pack_into +- fullName: struct.Struct.unpack + href: https://docs.python.org/3/library/struct.html#struct.Struct.unpack + name: unpack + uid: struct.Struct.unpack +- fullName: struct.Struct.unpack_from + href: https://docs.python.org/3/library/struct.html#struct.Struct.unpack_from + name: unpack_from + uid: struct.Struct.unpack_from +- fullName: subprocess.CompletedProcess.check_returncode + href: https://docs.python.org/3/library/subprocess.html#subprocess.CompletedProcess.check_returncode + name: check_returncode + uid: subprocess.CompletedProcess.check_returncode +- fullName: subprocess.Popen.communicate + href: https://docs.python.org/3/library/subprocess.html#subprocess.Popen.communicate + name: communicate + uid: subprocess.Popen.communicate +- fullName: subprocess.Popen.kill + href: https://docs.python.org/3/library/subprocess.html#subprocess.Popen.kill + name: kill + uid: subprocess.Popen.kill +- fullName: subprocess.Popen.poll + href: https://docs.python.org/3/library/subprocess.html#subprocess.Popen.poll + name: poll + uid: subprocess.Popen.poll +- fullName: subprocess.Popen.send_signal + href: https://docs.python.org/3/library/subprocess.html#subprocess.Popen.send_signal + name: send_signal + uid: subprocess.Popen.send_signal +- fullName: subprocess.Popen.terminate + href: https://docs.python.org/3/library/subprocess.html#subprocess.Popen.terminate + name: terminate + uid: subprocess.Popen.terminate +- fullName: subprocess.Popen.wait + href: https://docs.python.org/3/library/subprocess.html#subprocess.Popen.wait + name: wait + uid: subprocess.Popen.wait +- fullName: symtable.Class.get_methods + href: https://docs.python.org/3/library/symtable.html#symtable.Class.get_methods + name: get_methods + uid: symtable.Class.get_methods +- fullName: symtable.Function.get_frees + href: https://docs.python.org/3/library/symtable.html#symtable.Function.get_frees + name: get_frees + uid: symtable.Function.get_frees +- fullName: symtable.Function.get_globals + href: https://docs.python.org/3/library/symtable.html#symtable.Function.get_globals + name: get_globals + uid: symtable.Function.get_globals +- fullName: symtable.Function.get_locals + href: https://docs.python.org/3/library/symtable.html#symtable.Function.get_locals + name: get_locals + uid: symtable.Function.get_locals +- fullName: symtable.Function.get_nonlocals + href: https://docs.python.org/3/library/symtable.html#symtable.Function.get_nonlocals + name: get_nonlocals + uid: symtable.Function.get_nonlocals +- fullName: symtable.Function.get_parameters + href: https://docs.python.org/3/library/symtable.html#symtable.Function.get_parameters + name: get_parameters + uid: symtable.Function.get_parameters +- fullName: symtable.Symbol.get_name + href: https://docs.python.org/3/library/symtable.html#symtable.Symbol.get_name + name: get_name + uid: symtable.Symbol.get_name +- fullName: symtable.Symbol.get_namespace + href: https://docs.python.org/3/library/symtable.html#symtable.Symbol.get_namespace + name: get_namespace + uid: symtable.Symbol.get_namespace +- fullName: symtable.Symbol.get_namespaces + href: https://docs.python.org/3/library/symtable.html#symtable.Symbol.get_namespaces + name: get_namespaces + uid: symtable.Symbol.get_namespaces +- fullName: symtable.Symbol.is_annotated + href: https://docs.python.org/3/library/symtable.html#symtable.Symbol.is_annotated + name: is_annotated + uid: symtable.Symbol.is_annotated +- fullName: symtable.Symbol.is_assigned + href: https://docs.python.org/3/library/symtable.html#symtable.Symbol.is_assigned + name: is_assigned + uid: symtable.Symbol.is_assigned +- fullName: symtable.Symbol.is_declared_global + href: https://docs.python.org/3/library/symtable.html#symtable.Symbol.is_declared_global + name: is_declared_global + uid: symtable.Symbol.is_declared_global +- fullName: symtable.Symbol.is_free + href: https://docs.python.org/3/library/symtable.html#symtable.Symbol.is_free + name: is_free + uid: symtable.Symbol.is_free +- fullName: symtable.Symbol.is_global + href: https://docs.python.org/3/library/symtable.html#symtable.Symbol.is_global + name: is_global + uid: symtable.Symbol.is_global +- fullName: symtable.Symbol.is_imported + href: https://docs.python.org/3/library/symtable.html#symtable.Symbol.is_imported + name: is_imported + uid: symtable.Symbol.is_imported +- fullName: symtable.Symbol.is_local + href: https://docs.python.org/3/library/symtable.html#symtable.Symbol.is_local + name: is_local + uid: symtable.Symbol.is_local +- fullName: symtable.Symbol.is_namespace + href: https://docs.python.org/3/library/symtable.html#symtable.Symbol.is_namespace + name: is_namespace + uid: symtable.Symbol.is_namespace +- fullName: symtable.Symbol.is_nonlocal + href: https://docs.python.org/3/library/symtable.html#symtable.Symbol.is_nonlocal + name: is_nonlocal + uid: symtable.Symbol.is_nonlocal +- fullName: symtable.Symbol.is_parameter + href: https://docs.python.org/3/library/symtable.html#symtable.Symbol.is_parameter + name: is_parameter + uid: symtable.Symbol.is_parameter +- fullName: symtable.Symbol.is_referenced + href: https://docs.python.org/3/library/symtable.html#symtable.Symbol.is_referenced + name: is_referenced + uid: symtable.Symbol.is_referenced +- fullName: symtable.SymbolTable.get_children + href: https://docs.python.org/3/library/symtable.html#symtable.SymbolTable.get_children + name: get_children + uid: symtable.SymbolTable.get_children +- fullName: symtable.SymbolTable.get_id + href: https://docs.python.org/3/library/symtable.html#symtable.SymbolTable.get_id + name: get_id + uid: symtable.SymbolTable.get_id +- fullName: symtable.SymbolTable.get_identifiers + href: https://docs.python.org/3/library/symtable.html#symtable.SymbolTable.get_identifiers + name: get_identifiers + uid: symtable.SymbolTable.get_identifiers +- fullName: symtable.SymbolTable.get_lineno + href: https://docs.python.org/3/library/symtable.html#symtable.SymbolTable.get_lineno + name: get_lineno + uid: symtable.SymbolTable.get_lineno +- fullName: symtable.SymbolTable.get_name + href: https://docs.python.org/3/library/symtable.html#symtable.SymbolTable.get_name + name: get_name + uid: symtable.SymbolTable.get_name +- fullName: symtable.SymbolTable.get_symbols + href: https://docs.python.org/3/library/symtable.html#symtable.SymbolTable.get_symbols + name: get_symbols + uid: symtable.SymbolTable.get_symbols +- fullName: symtable.SymbolTable.get_type + href: https://docs.python.org/3/library/symtable.html#symtable.SymbolTable.get_type + name: get_type + uid: symtable.SymbolTable.get_type +- fullName: symtable.SymbolTable.has_children + href: https://docs.python.org/3/library/symtable.html#symtable.SymbolTable.has_children + name: has_children + uid: symtable.SymbolTable.has_children +- fullName: symtable.SymbolTable.is_nested + href: https://docs.python.org/3/library/symtable.html#symtable.SymbolTable.is_nested + name: is_nested + uid: symtable.SymbolTable.is_nested +- fullName: symtable.SymbolTable.is_optimized + href: https://docs.python.org/3/library/symtable.html#symtable.SymbolTable.is_optimized + name: is_optimized + uid: symtable.SymbolTable.is_optimized +- fullName: symtable.SymbolTable.lookup + href: https://docs.python.org/3/library/symtable.html#symtable.SymbolTable.lookup + name: lookup + uid: symtable.SymbolTable.lookup +- fullName: tarfile.TarFile.add + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarFile.add + name: add + uid: tarfile.TarFile.add +- fullName: tarfile.TarFile.addfile + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarFile.addfile + name: addfile + uid: tarfile.TarFile.addfile +- fullName: tarfile.TarFile.close + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarFile.close + name: close + uid: tarfile.TarFile.close +- fullName: tarfile.TarFile.extract + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarFile.extract + name: extract + uid: tarfile.TarFile.extract +- fullName: tarfile.TarFile.extractall + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarFile.extractall + name: extractall + uid: tarfile.TarFile.extractall +- fullName: tarfile.TarFile.extractfile + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarFile.extractfile + name: extractfile + uid: tarfile.TarFile.extractfile +- fullName: tarfile.TarFile.getmember + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarFile.getmember + name: getmember + uid: tarfile.TarFile.getmember +- fullName: tarfile.TarFile.getmembers + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarFile.getmembers + name: getmembers + uid: tarfile.TarFile.getmembers +- fullName: tarfile.TarFile.getnames + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarFile.getnames + name: getnames + uid: tarfile.TarFile.getnames +- fullName: tarfile.TarFile.gettarinfo + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarFile.gettarinfo + name: gettarinfo + uid: tarfile.TarFile.gettarinfo +- fullName: tarfile.TarFile.list + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarFile.list + name: list + uid: tarfile.TarFile.list +- fullName: tarfile.TarFile.next + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarFile.next + name: next + uid: tarfile.TarFile.next +- fullName: tarfile.TarFile.open + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarFile.open + name: open + uid: tarfile.TarFile.open +- fullName: tarfile.TarInfo.frombuf + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.frombuf + name: frombuf + uid: tarfile.TarInfo.frombuf +- fullName: tarfile.TarInfo.fromtarfile + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.fromtarfile + name: fromtarfile + uid: tarfile.TarInfo.fromtarfile +- fullName: tarfile.TarInfo.isblk + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.isblk + name: isblk + uid: tarfile.TarInfo.isblk +- fullName: tarfile.TarInfo.ischr + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.ischr + name: ischr + uid: tarfile.TarInfo.ischr +- fullName: tarfile.TarInfo.isdev + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.isdev + name: isdev + uid: tarfile.TarInfo.isdev +- fullName: tarfile.TarInfo.isdir + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.isdir + name: isdir + uid: tarfile.TarInfo.isdir +- fullName: tarfile.TarInfo.isfifo + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.isfifo + name: isfifo + uid: tarfile.TarInfo.isfifo +- fullName: tarfile.TarInfo.isfile + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.isfile + name: isfile + uid: tarfile.TarInfo.isfile +- fullName: tarfile.TarInfo.islnk + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.islnk + name: islnk + uid: tarfile.TarInfo.islnk +- fullName: tarfile.TarInfo.isreg + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.isreg + name: isreg + uid: tarfile.TarInfo.isreg +- fullName: tarfile.TarInfo.issym + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.issym + name: issym + uid: tarfile.TarInfo.issym +- fullName: tarfile.TarInfo.replace + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.replace + name: replace + uid: tarfile.TarInfo.replace +- fullName: tarfile.TarInfo.tobuf + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo.tobuf + name: tobuf + uid: tarfile.TarInfo.tobuf +- fullName: tempfile.SpooledTemporaryFile.rollover + href: https://docs.python.org/3/library/tempfile.html#tempfile.SpooledTemporaryFile.rollover + name: rollover + uid: tempfile.SpooledTemporaryFile.rollover +- fullName: tempfile.TemporaryDirectory.cleanup + href: https://docs.python.org/3/library/tempfile.html#tempfile.TemporaryDirectory.cleanup + name: cleanup + uid: tempfile.TemporaryDirectory.cleanup +- fullName: test.support.Matcher.match_value + href: https://docs.python.org/3/library/test.html#test.support.Matcher.match_value + name: match_value + uid: test.support.Matcher.match_value +- fullName: test.support.Matcher.matches + href: https://docs.python.org/3/library/test.html#test.support.Matcher.matches + name: matches + uid: test.support.Matcher.matches +- fullName: test.support.SaveSignals.restore + href: https://docs.python.org/3/library/test.html#test.support.SaveSignals.restore + name: restore + uid: test.support.SaveSignals.restore +- fullName: test.support.SaveSignals.save + href: https://docs.python.org/3/library/test.html#test.support.SaveSignals.save + name: save + uid: test.support.SaveSignals.save +- fullName: test.support.bytecode_helper.BytecodeTestCase.assertInBytecode + href: https://docs.python.org/3/library/test.html#test.support.bytecode_helper.BytecodeTestCase.assertInBytecode + name: assertInBytecode + uid: test.support.bytecode_helper.BytecodeTestCase.assertInBytecode +- fullName: test.support.bytecode_helper.BytecodeTestCase.assertNotInBytecode + href: https://docs.python.org/3/library/test.html#test.support.bytecode_helper.BytecodeTestCase.assertNotInBytecode + name: assertNotInBytecode + uid: test.support.bytecode_helper.BytecodeTestCase.assertNotInBytecode +- fullName: test.support.bytecode_helper.BytecodeTestCase.get_disassembly_as_string + href: https://docs.python.org/3/library/test.html#test.support.bytecode_helper.BytecodeTestCase.get_disassembly_as_string + name: get_disassembly_as_string + uid: test.support.bytecode_helper.BytecodeTestCase.get_disassembly_as_string +- fullName: test.support.os_helper.EnvironmentVarGuard.set + href: https://docs.python.org/3/library/test.html#test.support.os_helper.EnvironmentVarGuard.set + name: set + uid: test.support.os_helper.EnvironmentVarGuard.set +- fullName: test.support.os_helper.EnvironmentVarGuard.unset + href: https://docs.python.org/3/library/test.html#test.support.os_helper.EnvironmentVarGuard.unset + name: unset + uid: test.support.os_helper.EnvironmentVarGuard.unset +- fullName: textwrap.TextWrapper.fill + href: https://docs.python.org/3/library/textwrap.html#textwrap.TextWrapper.fill + name: fill + uid: textwrap.TextWrapper.fill +- fullName: textwrap.TextWrapper.wrap + href: https://docs.python.org/3/library/textwrap.html#textwrap.TextWrapper.wrap + name: wrap + uid: textwrap.TextWrapper.wrap +- fullName: threading.Barrier.abort + href: https://docs.python.org/3/library/threading.html#threading.Barrier.abort + name: abort + uid: threading.Barrier.abort +- fullName: threading.Barrier.reset + href: https://docs.python.org/3/library/threading.html#threading.Barrier.reset + name: reset + uid: threading.Barrier.reset +- fullName: threading.Barrier.wait + href: https://docs.python.org/3/library/threading.html#threading.Barrier.wait + name: wait + uid: threading.Barrier.wait +- fullName: threading.Condition.acquire + href: https://docs.python.org/3/library/threading.html#threading.Condition.acquire + name: acquire + uid: threading.Condition.acquire +- fullName: threading.Condition.notify + href: https://docs.python.org/3/library/threading.html#threading.Condition.notify + name: notify + uid: threading.Condition.notify +- fullName: threading.Condition.notify_all + href: https://docs.python.org/3/library/threading.html#threading.Condition.notify_all + name: notify_all + uid: threading.Condition.notify_all +- fullName: threading.Condition.release + href: https://docs.python.org/3/library/threading.html#threading.Condition.release + name: release + uid: threading.Condition.release +- fullName: threading.Condition.wait + href: https://docs.python.org/3/library/threading.html#threading.Condition.wait + name: wait + uid: threading.Condition.wait +- fullName: threading.Condition.wait_for + href: https://docs.python.org/3/library/threading.html#threading.Condition.wait_for + name: wait_for + uid: threading.Condition.wait_for +- fullName: threading.Event.clear + href: https://docs.python.org/3/library/threading.html#threading.Event.clear + name: clear + uid: threading.Event.clear +- fullName: threading.Event.is_set + href: https://docs.python.org/3/library/threading.html#threading.Event.is_set + name: is_set + uid: threading.Event.is_set +- fullName: threading.Event.set + href: https://docs.python.org/3/library/threading.html#threading.Event.set + name: set + uid: threading.Event.set +- fullName: threading.Event.wait + href: https://docs.python.org/3/library/threading.html#threading.Event.wait + name: wait + uid: threading.Event.wait +- fullName: threading.Lock.acquire + href: https://docs.python.org/3/library/threading.html#threading.Lock.acquire + name: acquire + uid: threading.Lock.acquire +- fullName: threading.Lock.locked + href: https://docs.python.org/3/library/threading.html#threading.Lock.locked + name: locked + uid: threading.Lock.locked +- fullName: threading.Lock.release + href: https://docs.python.org/3/library/threading.html#threading.Lock.release + name: release + uid: threading.Lock.release +- fullName: threading.RLock.acquire + href: https://docs.python.org/3/library/threading.html#threading.RLock.acquire + name: acquire + uid: threading.RLock.acquire +- fullName: threading.RLock.release + href: https://docs.python.org/3/library/threading.html#threading.RLock.release + name: release + uid: threading.RLock.release +- fullName: threading.Semaphore.acquire + href: https://docs.python.org/3/library/threading.html#threading.Semaphore.acquire + name: acquire + uid: threading.Semaphore.acquire +- fullName: threading.Semaphore.release + href: https://docs.python.org/3/library/threading.html#threading.Semaphore.release + name: release + uid: threading.Semaphore.release +- fullName: threading.Thread.getName + href: https://docs.python.org/3/library/threading.html#threading.Thread.getName + name: getName + uid: threading.Thread.getName +- fullName: threading.Thread.isDaemon + href: https://docs.python.org/3/library/threading.html#threading.Thread.isDaemon + name: isDaemon + uid: threading.Thread.isDaemon +- fullName: threading.Thread.is_alive + href: https://docs.python.org/3/library/threading.html#threading.Thread.is_alive + name: is_alive + uid: threading.Thread.is_alive +- fullName: threading.Thread.join + href: https://docs.python.org/3/library/threading.html#threading.Thread.join + name: join + uid: threading.Thread.join +- fullName: threading.Thread.run + href: https://docs.python.org/3/library/threading.html#threading.Thread.run + name: run + uid: threading.Thread.run +- fullName: threading.Thread.setDaemon + href: https://docs.python.org/3/library/threading.html#threading.Thread.setDaemon + name: setDaemon + uid: threading.Thread.setDaemon +- fullName: threading.Thread.setName + href: https://docs.python.org/3/library/threading.html#threading.Thread.setName + name: setName + uid: threading.Thread.setName +- fullName: threading.Thread.start + href: https://docs.python.org/3/library/threading.html#threading.Thread.start + name: start + uid: threading.Thread.start +- fullName: threading.Timer.cancel + href: https://docs.python.org/3/library/threading.html#threading.Timer.cancel + name: cancel + uid: threading.Timer.cancel +- fullName: timeit.Timer.autorange + href: https://docs.python.org/3/library/timeit.html#timeit.Timer.autorange + name: autorange + uid: timeit.Timer.autorange +- fullName: timeit.Timer.print_exc + href: https://docs.python.org/3/library/timeit.html#timeit.Timer.print_exc + name: print_exc + uid: timeit.Timer.print_exc +- fullName: timeit.Timer.repeat + href: https://docs.python.org/3/library/timeit.html#timeit.Timer.repeat + name: repeat + uid: timeit.Timer.repeat +- fullName: timeit.Timer.timeit + href: https://docs.python.org/3/library/timeit.html#timeit.Timer.timeit + name: timeit + uid: timeit.Timer.timeit +- fullName: tkinter.commondialog.Dialog.show + href: https://docs.python.org/3/library/dialog.html#tkinter.commondialog.Dialog.show + name: show + uid: tkinter.commondialog.Dialog.show +- fullName: tkinter.dnd.DndHandler.cancel + href: https://docs.python.org/3/library/tkinter.dnd.html#tkinter.dnd.DndHandler.cancel + name: cancel + uid: tkinter.dnd.DndHandler.cancel +- fullName: tkinter.dnd.DndHandler.finish + href: https://docs.python.org/3/library/tkinter.dnd.html#tkinter.dnd.DndHandler.finish + name: finish + uid: tkinter.dnd.DndHandler.finish +- fullName: tkinter.dnd.DndHandler.on_motion + href: https://docs.python.org/3/library/tkinter.dnd.html#tkinter.dnd.DndHandler.on_motion + name: on_motion + uid: tkinter.dnd.DndHandler.on_motion +- fullName: tkinter.dnd.DndHandler.on_release + href: https://docs.python.org/3/library/tkinter.dnd.html#tkinter.dnd.DndHandler.on_release + name: on_release + uid: tkinter.dnd.DndHandler.on_release +- fullName: tkinter.filedialog.FileDialog.cancel_command + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.FileDialog.cancel_command + name: cancel_command + uid: tkinter.filedialog.FileDialog.cancel_command +- fullName: tkinter.filedialog.FileDialog.dirs_double_event + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.FileDialog.dirs_double_event + name: dirs_double_event + uid: tkinter.filedialog.FileDialog.dirs_double_event +- fullName: tkinter.filedialog.FileDialog.dirs_select_event + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.FileDialog.dirs_select_event + name: dirs_select_event + uid: tkinter.filedialog.FileDialog.dirs_select_event +- fullName: tkinter.filedialog.FileDialog.files_double_event + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.FileDialog.files_double_event + name: files_double_event + uid: tkinter.filedialog.FileDialog.files_double_event +- fullName: tkinter.filedialog.FileDialog.files_select_event + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.FileDialog.files_select_event + name: files_select_event + uid: tkinter.filedialog.FileDialog.files_select_event +- fullName: tkinter.filedialog.FileDialog.filter_command + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.FileDialog.filter_command + name: filter_command + uid: tkinter.filedialog.FileDialog.filter_command +- fullName: tkinter.filedialog.FileDialog.get_filter + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.FileDialog.get_filter + name: get_filter + uid: tkinter.filedialog.FileDialog.get_filter +- fullName: tkinter.filedialog.FileDialog.get_selection + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.FileDialog.get_selection + name: get_selection + uid: tkinter.filedialog.FileDialog.get_selection +- fullName: tkinter.filedialog.FileDialog.go + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.FileDialog.go + name: go + uid: tkinter.filedialog.FileDialog.go +- fullName: tkinter.filedialog.FileDialog.ok_event + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.FileDialog.ok_event + name: ok_event + uid: tkinter.filedialog.FileDialog.ok_event +- fullName: tkinter.filedialog.FileDialog.quit + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.FileDialog.quit + name: quit + uid: tkinter.filedialog.FileDialog.quit +- fullName: tkinter.filedialog.FileDialog.set_filter + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.FileDialog.set_filter + name: set_filter + uid: tkinter.filedialog.FileDialog.set_filter +- fullName: tkinter.filedialog.FileDialog.set_selection + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.FileDialog.set_selection + name: set_selection + uid: tkinter.filedialog.FileDialog.set_selection +- fullName: tkinter.filedialog.LoadFileDialog.ok_command + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.LoadFileDialog.ok_command + name: ok_command + uid: tkinter.filedialog.LoadFileDialog.ok_command +- fullName: tkinter.filedialog.SaveFileDialog.ok_command + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.SaveFileDialog.ok_command + name: ok_command + uid: tkinter.filedialog.SaveFileDialog.ok_command +- fullName: tkinter.font.Font.actual + href: https://docs.python.org/3/library/tkinter.font.html#tkinter.font.Font.actual + name: actual + uid: tkinter.font.Font.actual +- fullName: tkinter.font.Font.cget + href: https://docs.python.org/3/library/tkinter.font.html#tkinter.font.Font.cget + name: cget + uid: tkinter.font.Font.cget +- fullName: tkinter.font.Font.config + href: https://docs.python.org/3/library/tkinter.font.html#tkinter.font.Font.config + name: config + uid: tkinter.font.Font.config +- fullName: tkinter.font.Font.copy + href: https://docs.python.org/3/library/tkinter.font.html#tkinter.font.Font.copy + name: copy + uid: tkinter.font.Font.copy +- fullName: tkinter.font.Font.measure + href: https://docs.python.org/3/library/tkinter.font.html#tkinter.font.Font.measure + name: measure + uid: tkinter.font.Font.measure +- fullName: tkinter.font.Font.metrics + href: https://docs.python.org/3/library/tkinter.font.html#tkinter.font.Font.metrics + name: metrics + uid: tkinter.font.Font.metrics +- fullName: tkinter.messagebox.Message.show + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.Message.show + name: show + uid: tkinter.messagebox.Message.show +- fullName: tkinter.simpledialog.Dialog.body + href: https://docs.python.org/3/library/dialog.html#tkinter.simpledialog.Dialog.body + name: body + uid: tkinter.simpledialog.Dialog.body +- fullName: tkinter.simpledialog.Dialog.buttonbox + href: https://docs.python.org/3/library/dialog.html#tkinter.simpledialog.Dialog.buttonbox + name: buttonbox + uid: tkinter.simpledialog.Dialog.buttonbox +- fullName: tkinter.ttk.Combobox.current + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Combobox.current + name: current + uid: tkinter.ttk.Combobox.current +- fullName: tkinter.ttk.Combobox.get + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Combobox.get + name: get + uid: tkinter.ttk.Combobox.get +- fullName: tkinter.ttk.Combobox.set + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Combobox.set + name: set + uid: tkinter.ttk.Combobox.set +- fullName: tkinter.ttk.Notebook.add + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Notebook.add + name: add + uid: tkinter.ttk.Notebook.add +- fullName: tkinter.ttk.Notebook.enable_traversal + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Notebook.enable_traversal + name: enable_traversal + uid: tkinter.ttk.Notebook.enable_traversal +- fullName: tkinter.ttk.Notebook.forget + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Notebook.forget + name: forget + uid: tkinter.ttk.Notebook.forget +- fullName: tkinter.ttk.Notebook.hide + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Notebook.hide + name: hide + uid: tkinter.ttk.Notebook.hide +- fullName: tkinter.ttk.Notebook.identify + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Notebook.identify + name: identify + uid: tkinter.ttk.Notebook.identify +- fullName: tkinter.ttk.Notebook.index + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Notebook.index + name: index + uid: tkinter.ttk.Notebook.index +- fullName: tkinter.ttk.Notebook.insert + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Notebook.insert + name: insert + uid: tkinter.ttk.Notebook.insert +- fullName: tkinter.ttk.Notebook.select + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Notebook.select + name: select + uid: tkinter.ttk.Notebook.select +- fullName: tkinter.ttk.Notebook.tab + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Notebook.tab + name: tab + uid: tkinter.ttk.Notebook.tab +- fullName: tkinter.ttk.Notebook.tabs + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Notebook.tabs + name: tabs + uid: tkinter.ttk.Notebook.tabs +- fullName: tkinter.ttk.Progressbar.start + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Progressbar.start + name: start + uid: tkinter.ttk.Progressbar.start +- fullName: tkinter.ttk.Progressbar.step + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Progressbar.step + name: step + uid: tkinter.ttk.Progressbar.step +- fullName: tkinter.ttk.Progressbar.stop + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Progressbar.stop + name: stop + uid: tkinter.ttk.Progressbar.stop +- fullName: tkinter.ttk.Spinbox.get + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Spinbox.get + name: get + uid: tkinter.ttk.Spinbox.get +- fullName: tkinter.ttk.Spinbox.set + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Spinbox.set + name: set + uid: tkinter.ttk.Spinbox.set +- fullName: tkinter.ttk.Style.configure + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Style.configure + name: configure + uid: tkinter.ttk.Style.configure +- fullName: tkinter.ttk.Style.element_create + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Style.element_create + name: element_create + uid: tkinter.ttk.Style.element_create +- fullName: tkinter.ttk.Style.element_names + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Style.element_names + name: element_names + uid: tkinter.ttk.Style.element_names +- fullName: tkinter.ttk.Style.element_options + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Style.element_options + name: element_options + uid: tkinter.ttk.Style.element_options +- fullName: tkinter.ttk.Style.layout + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Style.layout + name: layout + uid: tkinter.ttk.Style.layout +- fullName: tkinter.ttk.Style.lookup + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Style.lookup + name: lookup + uid: tkinter.ttk.Style.lookup +- fullName: tkinter.ttk.Style.map + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Style.map + name: map + uid: tkinter.ttk.Style.map +- fullName: tkinter.ttk.Style.theme_create + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Style.theme_create + name: theme_create + uid: tkinter.ttk.Style.theme_create +- fullName: tkinter.ttk.Style.theme_names + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Style.theme_names + name: theme_names + uid: tkinter.ttk.Style.theme_names +- fullName: tkinter.ttk.Style.theme_settings + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Style.theme_settings + name: theme_settings + uid: tkinter.ttk.Style.theme_settings +- fullName: tkinter.ttk.Style.theme_use + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Style.theme_use + name: theme_use + uid: tkinter.ttk.Style.theme_use +- fullName: tkinter.ttk.Treeview.bbox + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.bbox + name: bbox + uid: tkinter.ttk.Treeview.bbox +- fullName: tkinter.ttk.Treeview.column + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.column + name: column + uid: tkinter.ttk.Treeview.column +- fullName: tkinter.ttk.Treeview.delete + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.delete + name: delete + uid: tkinter.ttk.Treeview.delete +- fullName: tkinter.ttk.Treeview.detach + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.detach + name: detach + uid: tkinter.ttk.Treeview.detach +- fullName: tkinter.ttk.Treeview.exists + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.exists + name: exists + uid: tkinter.ttk.Treeview.exists +- fullName: tkinter.ttk.Treeview.focus + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.focus + name: focus + uid: tkinter.ttk.Treeview.focus +- fullName: tkinter.ttk.Treeview.get_children + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.get_children + name: get_children + uid: tkinter.ttk.Treeview.get_children +- fullName: tkinter.ttk.Treeview.heading + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.heading + name: heading + uid: tkinter.ttk.Treeview.heading +- fullName: tkinter.ttk.Treeview.identify + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.identify + name: identify + uid: tkinter.ttk.Treeview.identify +- fullName: tkinter.ttk.Treeview.identify_column + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.identify_column + name: identify_column + uid: tkinter.ttk.Treeview.identify_column +- fullName: tkinter.ttk.Treeview.identify_element + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.identify_element + name: identify_element + uid: tkinter.ttk.Treeview.identify_element +- fullName: tkinter.ttk.Treeview.identify_region + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.identify_region + name: identify_region + uid: tkinter.ttk.Treeview.identify_region +- fullName: tkinter.ttk.Treeview.identify_row + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.identify_row + name: identify_row + uid: tkinter.ttk.Treeview.identify_row +- fullName: tkinter.ttk.Treeview.index + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.index + name: index + uid: tkinter.ttk.Treeview.index +- fullName: tkinter.ttk.Treeview.insert + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.insert + name: insert + uid: tkinter.ttk.Treeview.insert +- fullName: tkinter.ttk.Treeview.item + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.item + name: item + uid: tkinter.ttk.Treeview.item +- fullName: tkinter.ttk.Treeview.move + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.move + name: move + uid: tkinter.ttk.Treeview.move +- fullName: tkinter.ttk.Treeview.next + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.next + name: next + uid: tkinter.ttk.Treeview.next +- fullName: tkinter.ttk.Treeview.parent + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.parent + name: parent + uid: tkinter.ttk.Treeview.parent +- fullName: tkinter.ttk.Treeview.prev + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.prev + name: prev + uid: tkinter.ttk.Treeview.prev +- fullName: tkinter.ttk.Treeview.reattach + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.reattach + name: reattach + uid: tkinter.ttk.Treeview.reattach +- fullName: tkinter.ttk.Treeview.see + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.see + name: see + uid: tkinter.ttk.Treeview.see +- fullName: tkinter.ttk.Treeview.selection + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.selection + name: selection + uid: tkinter.ttk.Treeview.selection +- fullName: tkinter.ttk.Treeview.selection_add + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.selection_add + name: selection_add + uid: tkinter.ttk.Treeview.selection_add +- fullName: tkinter.ttk.Treeview.selection_remove + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.selection_remove + name: selection_remove + uid: tkinter.ttk.Treeview.selection_remove +- fullName: tkinter.ttk.Treeview.selection_set + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.selection_set + name: selection_set + uid: tkinter.ttk.Treeview.selection_set +- fullName: tkinter.ttk.Treeview.selection_toggle + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.selection_toggle + name: selection_toggle + uid: tkinter.ttk.Treeview.selection_toggle +- fullName: tkinter.ttk.Treeview.set + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.set + name: set + uid: tkinter.ttk.Treeview.set +- fullName: tkinter.ttk.Treeview.set_children + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.set_children + name: set_children + uid: tkinter.ttk.Treeview.set_children +- fullName: tkinter.ttk.Treeview.tag_bind + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.tag_bind + name: tag_bind + uid: tkinter.ttk.Treeview.tag_bind +- fullName: tkinter.ttk.Treeview.tag_configure + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.tag_configure + name: tag_configure + uid: tkinter.ttk.Treeview.tag_configure +- fullName: tkinter.ttk.Treeview.tag_has + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.tag_has + name: tag_has + uid: tkinter.ttk.Treeview.tag_has +- fullName: tkinter.ttk.Treeview.xview + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.xview + name: xview + uid: tkinter.ttk.Treeview.xview +- fullName: tkinter.ttk.Treeview.yview + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview.yview + name: yview + uid: tkinter.ttk.Treeview.yview +- fullName: tkinter.ttk.Widget.identify + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Widget.identify + name: identify + uid: tkinter.ttk.Widget.identify +- fullName: tkinter.ttk.Widget.instate + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Widget.instate + name: instate + uid: tkinter.ttk.Widget.instate +- fullName: tkinter.ttk.Widget.state + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Widget.state + name: state + uid: tkinter.ttk.Widget.state +- fullName: trace.CoverageResults.update + href: https://docs.python.org/3/library/trace.html#trace.CoverageResults.update + name: update + uid: trace.CoverageResults.update +- fullName: trace.CoverageResults.write_results + href: https://docs.python.org/3/library/trace.html#trace.CoverageResults.write_results + name: write_results + uid: trace.CoverageResults.write_results +- fullName: trace.Trace.results + href: https://docs.python.org/3/library/trace.html#trace.Trace.results + name: results + uid: trace.Trace.results +- fullName: trace.Trace.run + href: https://docs.python.org/3/library/trace.html#trace.Trace.run + name: run + uid: trace.Trace.run +- fullName: trace.Trace.runctx + href: https://docs.python.org/3/library/trace.html#trace.Trace.runctx + name: runctx + uid: trace.Trace.runctx +- fullName: trace.Trace.runfunc + href: https://docs.python.org/3/library/trace.html#trace.Trace.runfunc + name: runfunc + uid: trace.Trace.runfunc +- fullName: traceback.StackSummary.extract + href: https://docs.python.org/3/library/traceback.html#traceback.StackSummary.extract + name: extract + uid: traceback.StackSummary.extract +- fullName: traceback.StackSummary.format + href: https://docs.python.org/3/library/traceback.html#traceback.StackSummary.format + name: format + uid: traceback.StackSummary.format +- fullName: traceback.StackSummary.format_frame_summary + href: https://docs.python.org/3/library/traceback.html#traceback.StackSummary.format_frame_summary + name: format_frame_summary + uid: traceback.StackSummary.format_frame_summary +- fullName: traceback.StackSummary.from_list + href: https://docs.python.org/3/library/traceback.html#traceback.StackSummary.from_list + name: from_list + uid: traceback.StackSummary.from_list +- fullName: traceback.TracebackException.format + href: https://docs.python.org/3/library/traceback.html#traceback.TracebackException.format + name: format + uid: traceback.TracebackException.format +- fullName: traceback.TracebackException.format_exception_only + href: https://docs.python.org/3/library/traceback.html#traceback.TracebackException.format_exception_only + name: format_exception_only + uid: traceback.TracebackException.format_exception_only +- fullName: traceback.TracebackException.from_exception + href: https://docs.python.org/3/library/traceback.html#traceback.TracebackException.from_exception + name: from_exception + uid: traceback.TracebackException.from_exception +- fullName: traceback.TracebackException.print + href: https://docs.python.org/3/library/traceback.html#traceback.TracebackException.print + name: print + uid: traceback.TracebackException.print +- fullName: tracemalloc.Snapshot.compare_to + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Snapshot.compare_to + name: compare_to + uid: tracemalloc.Snapshot.compare_to +- fullName: tracemalloc.Snapshot.dump + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Snapshot.dump + name: dump + uid: tracemalloc.Snapshot.dump +- fullName: tracemalloc.Snapshot.filter_traces + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Snapshot.filter_traces + name: filter_traces + uid: tracemalloc.Snapshot.filter_traces +- fullName: tracemalloc.Snapshot.load + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Snapshot.load + name: load + uid: tracemalloc.Snapshot.load +- fullName: tracemalloc.Snapshot.statistics + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Snapshot.statistics + name: statistics + uid: tracemalloc.Snapshot.statistics +- fullName: tracemalloc.Traceback.format + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Traceback.format + name: format + uid: tracemalloc.Traceback.format +- fullName: turtle.Shape.addcomponent + href: https://docs.python.org/3/library/turtle.html#turtle.Shape.addcomponent + name: addcomponent + uid: turtle.Shape.addcomponent +- fullName: type.__instancecheck__ + href: https://docs.python.org/3/reference/datamodel.html#type.__instancecheck__ + name: __instancecheck__ + uid: type.__instancecheck__ +- fullName: type.__subclasscheck__ + href: https://docs.python.org/3/reference/datamodel.html#type.__subclasscheck__ + name: __subclasscheck__ + uid: type.__subclasscheck__ +- fullName: type.__subclasses__ + href: https://docs.python.org/3/reference/datamodel.html#type.__subclasses__ + name: __subclasses__ + uid: type.__subclasses__ +- fullName: type.mro + href: https://docs.python.org/3/reference/datamodel.html#type.mro + name: mro + uid: type.mro +- fullName: types.MappingProxyType.copy + href: https://docs.python.org/3/library/types.html#types.MappingProxyType.copy + name: copy + uid: types.MappingProxyType.copy +- fullName: types.MappingProxyType.get + href: https://docs.python.org/3/library/types.html#types.MappingProxyType.get + name: get + uid: types.MappingProxyType.get +- fullName: types.MappingProxyType.items + href: https://docs.python.org/3/library/types.html#types.MappingProxyType.items + name: items + uid: types.MappingProxyType.items +- fullName: types.MappingProxyType.keys + href: https://docs.python.org/3/library/types.html#types.MappingProxyType.keys + name: keys + uid: types.MappingProxyType.keys +- fullName: types.MappingProxyType.values + href: https://docs.python.org/3/library/types.html#types.MappingProxyType.values + name: values + uid: types.MappingProxyType.values +- fullName: typing.ParamSpec.has_default + href: https://docs.python.org/3/library/typing.html#typing.ParamSpec.has_default + name: has_default + uid: typing.ParamSpec.has_default +- fullName: typing.TypeVar.has_default + href: https://docs.python.org/3/library/typing.html#typing.TypeVar.has_default + name: has_default + uid: typing.TypeVar.has_default +- fullName: typing.TypeVarTuple.has_default + href: https://docs.python.org/3/library/typing.html#typing.TypeVarTuple.has_default + name: has_default + uid: typing.TypeVarTuple.has_default +- fullName: unittest.IsolatedAsyncioTestCase.addAsyncCleanup + href: https://docs.python.org/3/library/unittest.html#unittest.IsolatedAsyncioTestCase.addAsyncCleanup + name: addAsyncCleanup + uid: unittest.IsolatedAsyncioTestCase.addAsyncCleanup +- fullName: unittest.IsolatedAsyncioTestCase.asyncSetUp + href: https://docs.python.org/3/library/unittest.html#unittest.IsolatedAsyncioTestCase.asyncSetUp + name: asyncSetUp + uid: unittest.IsolatedAsyncioTestCase.asyncSetUp +- fullName: unittest.IsolatedAsyncioTestCase.asyncTearDown + href: https://docs.python.org/3/library/unittest.html#unittest.IsolatedAsyncioTestCase.asyncTearDown + name: asyncTearDown + uid: unittest.IsolatedAsyncioTestCase.asyncTearDown +- fullName: unittest.IsolatedAsyncioTestCase.enterAsyncContext + href: https://docs.python.org/3/library/unittest.html#unittest.IsolatedAsyncioTestCase.enterAsyncContext + name: enterAsyncContext + uid: unittest.IsolatedAsyncioTestCase.enterAsyncContext +- fullName: unittest.IsolatedAsyncioTestCase.run + href: https://docs.python.org/3/library/unittest.html#unittest.IsolatedAsyncioTestCase.run + name: run + uid: unittest.IsolatedAsyncioTestCase.run +- fullName: unittest.TestCase.addClassCleanup + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.addClassCleanup + name: addClassCleanup + uid: unittest.TestCase.addClassCleanup +- fullName: unittest.TestCase.addCleanup + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.addCleanup + name: addCleanup + uid: unittest.TestCase.addCleanup +- fullName: unittest.TestCase.addTypeEqualityFunc + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.addTypeEqualityFunc + name: addTypeEqualityFunc + uid: unittest.TestCase.addTypeEqualityFunc +- fullName: unittest.TestCase.assertAlmostEqual + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertAlmostEqual + name: assertAlmostEqual + uid: unittest.TestCase.assertAlmostEqual +- fullName: unittest.TestCase.assertCountEqual + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertCountEqual + name: assertCountEqual + uid: unittest.TestCase.assertCountEqual +- fullName: unittest.TestCase.assertDictEqual + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertDictEqual + name: assertDictEqual + uid: unittest.TestCase.assertDictEqual +- fullName: unittest.TestCase.assertEqual + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertEqual + name: assertEqual + uid: unittest.TestCase.assertEqual +- fullName: unittest.TestCase.assertFalse + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertFalse + name: assertFalse + uid: unittest.TestCase.assertFalse +- fullName: unittest.TestCase.assertGreater + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertGreater + name: assertGreater + uid: unittest.TestCase.assertGreater +- fullName: unittest.TestCase.assertGreaterEqual + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertGreaterEqual + name: assertGreaterEqual + uid: unittest.TestCase.assertGreaterEqual +- fullName: unittest.TestCase.assertIn + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertIn + name: assertIn + uid: unittest.TestCase.assertIn +- fullName: unittest.TestCase.assertIs + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertIs + name: assertIs + uid: unittest.TestCase.assertIs +- fullName: unittest.TestCase.assertIsInstance + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertIsInstance + name: assertIsInstance + uid: unittest.TestCase.assertIsInstance +- fullName: unittest.TestCase.assertIsNone + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertIsNone + name: assertIsNone + uid: unittest.TestCase.assertIsNone +- fullName: unittest.TestCase.assertIsNot + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertIsNot + name: assertIsNot + uid: unittest.TestCase.assertIsNot +- fullName: unittest.TestCase.assertIsNotNone + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertIsNotNone + name: assertIsNotNone + uid: unittest.TestCase.assertIsNotNone +- fullName: unittest.TestCase.assertLess + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertLess + name: assertLess + uid: unittest.TestCase.assertLess +- fullName: unittest.TestCase.assertLessEqual + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertLessEqual + name: assertLessEqual + uid: unittest.TestCase.assertLessEqual +- fullName: unittest.TestCase.assertListEqual + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertListEqual + name: assertListEqual + uid: unittest.TestCase.assertListEqual +- fullName: unittest.TestCase.assertLogs + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertLogs + name: assertLogs + uid: unittest.TestCase.assertLogs +- fullName: unittest.TestCase.assertMultiLineEqual + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertMultiLineEqual + name: assertMultiLineEqual + uid: unittest.TestCase.assertMultiLineEqual +- fullName: unittest.TestCase.assertNoLogs + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertNoLogs + name: assertNoLogs + uid: unittest.TestCase.assertNoLogs +- fullName: unittest.TestCase.assertNotAlmostEqual + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertNotAlmostEqual + name: assertNotAlmostEqual + uid: unittest.TestCase.assertNotAlmostEqual +- fullName: unittest.TestCase.assertNotEqual + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertNotEqual + name: assertNotEqual + uid: unittest.TestCase.assertNotEqual +- fullName: unittest.TestCase.assertNotIn + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertNotIn + name: assertNotIn + uid: unittest.TestCase.assertNotIn +- fullName: unittest.TestCase.assertNotIsInstance + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertNotIsInstance + name: assertNotIsInstance + uid: unittest.TestCase.assertNotIsInstance +- fullName: unittest.TestCase.assertNotRegex + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertNotRegex + name: assertNotRegex + uid: unittest.TestCase.assertNotRegex +- fullName: unittest.TestCase.assertRaises + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertRaises + name: assertRaises + uid: unittest.TestCase.assertRaises +- fullName: unittest.TestCase.assertRaisesRegex + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertRaisesRegex + name: assertRaisesRegex + uid: unittest.TestCase.assertRaisesRegex +- fullName: unittest.TestCase.assertRegex + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertRegex + name: assertRegex + uid: unittest.TestCase.assertRegex +- fullName: unittest.TestCase.assertSequenceEqual + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertSequenceEqual + name: assertSequenceEqual + uid: unittest.TestCase.assertSequenceEqual +- fullName: unittest.TestCase.assertSetEqual + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertSetEqual + name: assertSetEqual + uid: unittest.TestCase.assertSetEqual +- fullName: unittest.TestCase.assertTrue + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertTrue + name: assertTrue + uid: unittest.TestCase.assertTrue +- fullName: unittest.TestCase.assertTupleEqual + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertTupleEqual + name: assertTupleEqual + uid: unittest.TestCase.assertTupleEqual +- fullName: unittest.TestCase.assertWarns + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertWarns + name: assertWarns + uid: unittest.TestCase.assertWarns +- fullName: unittest.TestCase.assertWarnsRegex + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.assertWarnsRegex + name: assertWarnsRegex + uid: unittest.TestCase.assertWarnsRegex +- fullName: unittest.TestCase.countTestCases + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.countTestCases + name: countTestCases + uid: unittest.TestCase.countTestCases +- fullName: unittest.TestCase.debug + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.debug + name: debug + uid: unittest.TestCase.debug +- fullName: unittest.TestCase.defaultTestResult + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.defaultTestResult + name: defaultTestResult + uid: unittest.TestCase.defaultTestResult +- fullName: unittest.TestCase.doClassCleanups + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.doClassCleanups + name: doClassCleanups + uid: unittest.TestCase.doClassCleanups +- fullName: unittest.TestCase.doCleanups + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.doCleanups + name: doCleanups + uid: unittest.TestCase.doCleanups +- fullName: unittest.TestCase.enterClassContext + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.enterClassContext + name: enterClassContext + uid: unittest.TestCase.enterClassContext +- fullName: unittest.TestCase.enterContext + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.enterContext + name: enterContext + uid: unittest.TestCase.enterContext +- fullName: unittest.TestCase.fail + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.fail + name: fail + uid: unittest.TestCase.fail +- fullName: unittest.TestCase.id + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.id + name: id + uid: unittest.TestCase.id +- fullName: unittest.TestCase.run + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.run + name: run + uid: unittest.TestCase.run +- fullName: unittest.TestCase.setUp + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.setUp + name: setUp + uid: unittest.TestCase.setUp +- fullName: unittest.TestCase.setUpClass + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.setUpClass + name: setUpClass + uid: unittest.TestCase.setUpClass +- fullName: unittest.TestCase.shortDescription + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.shortDescription + name: shortDescription + uid: unittest.TestCase.shortDescription +- fullName: unittest.TestCase.skipTest + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.skipTest + name: skipTest + uid: unittest.TestCase.skipTest +- fullName: unittest.TestCase.subTest + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.subTest + name: subTest + uid: unittest.TestCase.subTest +- fullName: unittest.TestCase.tearDown + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.tearDown + name: tearDown + uid: unittest.TestCase.tearDown +- fullName: unittest.TestCase.tearDownClass + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase.tearDownClass + name: tearDownClass + uid: unittest.TestCase.tearDownClass +- fullName: unittest.TestLoader.discover + href: https://docs.python.org/3/library/unittest.html#unittest.TestLoader.discover + name: discover + uid: unittest.TestLoader.discover +- fullName: unittest.TestLoader.getTestCaseNames + href: https://docs.python.org/3/library/unittest.html#unittest.TestLoader.getTestCaseNames + name: getTestCaseNames + uid: unittest.TestLoader.getTestCaseNames +- fullName: unittest.TestLoader.loadTestsFromModule + href: https://docs.python.org/3/library/unittest.html#unittest.TestLoader.loadTestsFromModule + name: loadTestsFromModule + uid: unittest.TestLoader.loadTestsFromModule +- fullName: unittest.TestLoader.loadTestsFromName + href: https://docs.python.org/3/library/unittest.html#unittest.TestLoader.loadTestsFromName + name: loadTestsFromName + uid: unittest.TestLoader.loadTestsFromName +- fullName: unittest.TestLoader.loadTestsFromNames + href: https://docs.python.org/3/library/unittest.html#unittest.TestLoader.loadTestsFromNames + name: loadTestsFromNames + uid: unittest.TestLoader.loadTestsFromNames +- fullName: unittest.TestLoader.loadTestsFromTestCase + href: https://docs.python.org/3/library/unittest.html#unittest.TestLoader.loadTestsFromTestCase + name: loadTestsFromTestCase + uid: unittest.TestLoader.loadTestsFromTestCase +- fullName: unittest.TestResult.addDuration + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.addDuration + name: addDuration + uid: unittest.TestResult.addDuration +- fullName: unittest.TestResult.addError + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.addError + name: addError + uid: unittest.TestResult.addError +- fullName: unittest.TestResult.addExpectedFailure + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.addExpectedFailure + name: addExpectedFailure + uid: unittest.TestResult.addExpectedFailure +- fullName: unittest.TestResult.addFailure + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.addFailure + name: addFailure + uid: unittest.TestResult.addFailure +- fullName: unittest.TestResult.addSkip + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.addSkip + name: addSkip + uid: unittest.TestResult.addSkip +- fullName: unittest.TestResult.addSubTest + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.addSubTest + name: addSubTest + uid: unittest.TestResult.addSubTest +- fullName: unittest.TestResult.addSuccess + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.addSuccess + name: addSuccess + uid: unittest.TestResult.addSuccess +- fullName: unittest.TestResult.addUnexpectedSuccess + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.addUnexpectedSuccess + name: addUnexpectedSuccess + uid: unittest.TestResult.addUnexpectedSuccess +- fullName: unittest.TestResult.startTest + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.startTest + name: startTest + uid: unittest.TestResult.startTest +- fullName: unittest.TestResult.startTestRun + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.startTestRun + name: startTestRun + uid: unittest.TestResult.startTestRun +- fullName: unittest.TestResult.stop + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.stop + name: stop + uid: unittest.TestResult.stop +- fullName: unittest.TestResult.stopTest + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.stopTest + name: stopTest + uid: unittest.TestResult.stopTest +- fullName: unittest.TestResult.stopTestRun + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.stopTestRun + name: stopTestRun + uid: unittest.TestResult.stopTestRun +- fullName: unittest.TestResult.wasSuccessful + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult.wasSuccessful + name: wasSuccessful + uid: unittest.TestResult.wasSuccessful +- fullName: unittest.TestSuite.__iter__ + href: https://docs.python.org/3/library/unittest.html#unittest.TestSuite.__iter__ + name: __iter__ + uid: unittest.TestSuite.__iter__ +- fullName: unittest.TestSuite.addTest + href: https://docs.python.org/3/library/unittest.html#unittest.TestSuite.addTest + name: addTest + uid: unittest.TestSuite.addTest +- fullName: unittest.TestSuite.addTests + href: https://docs.python.org/3/library/unittest.html#unittest.TestSuite.addTests + name: addTests + uid: unittest.TestSuite.addTests +- fullName: unittest.TestSuite.countTestCases + href: https://docs.python.org/3/library/unittest.html#unittest.TestSuite.countTestCases + name: countTestCases + uid: unittest.TestSuite.countTestCases +- fullName: unittest.TestSuite.debug + href: https://docs.python.org/3/library/unittest.html#unittest.TestSuite.debug + name: debug + uid: unittest.TestSuite.debug +- fullName: unittest.TestSuite.run + href: https://docs.python.org/3/library/unittest.html#unittest.TestSuite.run + name: run + uid: unittest.TestSuite.run +- fullName: unittest.TextTestRunner._makeResult + href: https://docs.python.org/3/library/unittest.html#unittest.TextTestRunner._makeResult + name: _makeResult + uid: unittest.TextTestRunner._makeResult +- fullName: unittest.TextTestRunner.run + href: https://docs.python.org/3/library/unittest.html#unittest.TextTestRunner.run + name: run + uid: unittest.TextTestRunner.run +- fullName: unittest.enterModuleContext + href: https://docs.python.org/3/library/unittest.html#unittest.enterModuleContext + name: enterModuleContext + uid: unittest.enterModuleContext +- fullName: unittest.mock.AsyncMock.assert_any_await + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.AsyncMock.assert_any_await + name: assert_any_await + uid: unittest.mock.AsyncMock.assert_any_await +- fullName: unittest.mock.AsyncMock.assert_awaited + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.AsyncMock.assert_awaited + name: assert_awaited + uid: unittest.mock.AsyncMock.assert_awaited +- fullName: unittest.mock.AsyncMock.assert_awaited_once + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.AsyncMock.assert_awaited_once + name: assert_awaited_once + uid: unittest.mock.AsyncMock.assert_awaited_once +- fullName: unittest.mock.AsyncMock.assert_awaited_once_with + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.AsyncMock.assert_awaited_once_with + name: assert_awaited_once_with + uid: unittest.mock.AsyncMock.assert_awaited_once_with +- fullName: unittest.mock.AsyncMock.assert_awaited_with + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.AsyncMock.assert_awaited_with + name: assert_awaited_with + uid: unittest.mock.AsyncMock.assert_awaited_with +- fullName: unittest.mock.AsyncMock.assert_has_awaits + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.AsyncMock.assert_has_awaits + name: assert_has_awaits + uid: unittest.mock.AsyncMock.assert_has_awaits +- fullName: unittest.mock.AsyncMock.assert_not_awaited + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.AsyncMock.assert_not_awaited + name: assert_not_awaited + uid: unittest.mock.AsyncMock.assert_not_awaited +- fullName: unittest.mock.AsyncMock.reset_mock + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.AsyncMock.reset_mock + name: reset_mock + uid: unittest.mock.AsyncMock.reset_mock +- fullName: unittest.mock.Mock.__dir__ + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.__dir__ + name: __dir__ + uid: unittest.mock.Mock.__dir__ +- fullName: unittest.mock.Mock._get_child_mock + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock._get_child_mock + name: _get_child_mock + uid: unittest.mock.Mock._get_child_mock +- fullName: unittest.mock.Mock.assert_any_call + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.assert_any_call + name: assert_any_call + uid: unittest.mock.Mock.assert_any_call +- fullName: unittest.mock.Mock.assert_called + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.assert_called + name: assert_called + uid: unittest.mock.Mock.assert_called +- fullName: unittest.mock.Mock.assert_called_once + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.assert_called_once + name: assert_called_once + uid: unittest.mock.Mock.assert_called_once +- fullName: unittest.mock.Mock.assert_called_once_with + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.assert_called_once_with + name: assert_called_once_with + uid: unittest.mock.Mock.assert_called_once_with +- fullName: unittest.mock.Mock.assert_called_with + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.assert_called_with + name: assert_called_with + uid: unittest.mock.Mock.assert_called_with +- fullName: unittest.mock.Mock.assert_has_calls + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.assert_has_calls + name: assert_has_calls + uid: unittest.mock.Mock.assert_has_calls +- fullName: unittest.mock.Mock.assert_not_called + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.assert_not_called + name: assert_not_called + uid: unittest.mock.Mock.assert_not_called +- fullName: unittest.mock.Mock.attach_mock + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.attach_mock + name: attach_mock + uid: unittest.mock.Mock.attach_mock +- fullName: unittest.mock.Mock.configure_mock + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.configure_mock + name: configure_mock + uid: unittest.mock.Mock.configure_mock +- fullName: unittest.mock.Mock.mock_add_spec + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.mock_add_spec + name: mock_add_spec + uid: unittest.mock.Mock.mock_add_spec +- fullName: unittest.mock.Mock.reset_mock + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock.reset_mock + name: reset_mock + uid: unittest.mock.Mock.reset_mock +- fullName: unittest.mock.ThreadingMock.wait_until_any_call_with + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.ThreadingMock.wait_until_any_call_with + name: wait_until_any_call_with + uid: unittest.mock.ThreadingMock.wait_until_any_call_with +- fullName: unittest.mock.ThreadingMock.wait_until_called + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.ThreadingMock.wait_until_called + name: wait_until_called + uid: unittest.mock.ThreadingMock.wait_until_called +- fullName: unittest.mock.call.call_list + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.call.call_list + name: call_list + uid: unittest.mock.call.call_list +- fullName: urllib.parse.urllib.parse.SplitResult.geturl + href: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.urllib.parse.SplitResult.geturl + name: geturl + uid: urllib.parse.urllib.parse.SplitResult.geturl +- fullName: urllib.request.AbstractBasicAuthHandler.http_error_auth_reqed + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.AbstractBasicAuthHandler.http_error_auth_reqed + name: http_error_auth_reqed + uid: urllib.request.AbstractBasicAuthHandler.http_error_auth_reqed +- fullName: urllib.request.AbstractDigestAuthHandler.http_error_auth_reqed + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.AbstractDigestAuthHandler.http_error_auth_reqed + name: http_error_auth_reqed + uid: urllib.request.AbstractDigestAuthHandler.http_error_auth_reqed +- fullName: urllib.request.BaseHandler.add_parent + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.BaseHandler.add_parent + name: add_parent + uid: urllib.request.BaseHandler.add_parent +- fullName: urllib.request.BaseHandler.close + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.BaseHandler.close + name: close + uid: urllib.request.BaseHandler.close +- fullName: urllib.request.BaseHandler.default_open + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.BaseHandler.default_open + name: default_open + uid: urllib.request.BaseHandler.default_open +- fullName: urllib.request.BaseHandler.http_error_default + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.BaseHandler.http_error_default + name: http_error_default + uid: urllib.request.BaseHandler.http_error_default +- fullName: urllib.request.BaseHandler.unknown_open + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.BaseHandler.unknown_open + name: unknown_open + uid: urllib.request.BaseHandler.unknown_open +- fullName: urllib.request.CacheFTPHandler.setMaxConns + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.CacheFTPHandler.setMaxConns + name: setMaxConns + uid: urllib.request.CacheFTPHandler.setMaxConns +- fullName: urllib.request.CacheFTPHandler.setTimeout + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.CacheFTPHandler.setTimeout + name: setTimeout + uid: urllib.request.CacheFTPHandler.setTimeout +- fullName: urllib.request.DataHandler.data_open + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.DataHandler.data_open + name: data_open + uid: urllib.request.DataHandler.data_open +- fullName: urllib.request.FTPHandler.ftp_open + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.FTPHandler.ftp_open + name: ftp_open + uid: urllib.request.FTPHandler.ftp_open +- fullName: urllib.request.FancyURLopener.prompt_user_passwd + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.FancyURLopener.prompt_user_passwd + name: prompt_user_passwd + uid: urllib.request.FancyURLopener.prompt_user_passwd +- fullName: urllib.request.FileHandler.file_open + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.FileHandler.file_open + name: file_open + uid: urllib.request.FileHandler.file_open +- fullName: urllib.request.HTTPBasicAuthHandler.http_error_401 + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPBasicAuthHandler.http_error_401 + name: http_error_401 + uid: urllib.request.HTTPBasicAuthHandler.http_error_401 +- fullName: urllib.request.HTTPDigestAuthHandler.http_error_401 + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPDigestAuthHandler.http_error_401 + name: http_error_401 + uid: urllib.request.HTTPDigestAuthHandler.http_error_401 +- fullName: urllib.request.HTTPErrorProcessor.http_response + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPErrorProcessor.http_response + name: http_response + uid: urllib.request.HTTPErrorProcessor.http_response +- fullName: urllib.request.HTTPErrorProcessor.https_response + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPErrorProcessor.https_response + name: https_response + uid: urllib.request.HTTPErrorProcessor.https_response +- fullName: urllib.request.HTTPHandler.http_open + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPHandler.http_open + name: http_open + uid: urllib.request.HTTPHandler.http_open +- fullName: urllib.request.HTTPPasswordMgr.add_password + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPPasswordMgr.add_password + name: add_password + uid: urllib.request.HTTPPasswordMgr.add_password +- fullName: urllib.request.HTTPPasswordMgr.find_user_password + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPPasswordMgr.find_user_password + name: find_user_password + uid: urllib.request.HTTPPasswordMgr.find_user_password +- fullName: urllib.request.HTTPPasswordMgrWithPriorAuth.add_password + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPPasswordMgrWithPriorAuth.add_password + name: add_password + uid: urllib.request.HTTPPasswordMgrWithPriorAuth.add_password +- fullName: urllib.request.HTTPPasswordMgrWithPriorAuth.find_user_password + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPPasswordMgrWithPriorAuth.find_user_password + name: find_user_password + uid: urllib.request.HTTPPasswordMgrWithPriorAuth.find_user_password +- fullName: urllib.request.HTTPPasswordMgrWithPriorAuth.is_authenticated + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPPasswordMgrWithPriorAuth.is_authenticated + name: is_authenticated + uid: urllib.request.HTTPPasswordMgrWithPriorAuth.is_authenticated +- fullName: urllib.request.HTTPPasswordMgrWithPriorAuth.update_authenticated + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPPasswordMgrWithPriorAuth.update_authenticated + name: update_authenticated + uid: urllib.request.HTTPPasswordMgrWithPriorAuth.update_authenticated +- fullName: urllib.request.HTTPRedirectHandler.http_error_301 + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPRedirectHandler.http_error_301 + name: http_error_301 + uid: urllib.request.HTTPRedirectHandler.http_error_301 +- fullName: urllib.request.HTTPRedirectHandler.http_error_302 + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPRedirectHandler.http_error_302 + name: http_error_302 + uid: urllib.request.HTTPRedirectHandler.http_error_302 +- fullName: urllib.request.HTTPRedirectHandler.http_error_303 + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPRedirectHandler.http_error_303 + name: http_error_303 + uid: urllib.request.HTTPRedirectHandler.http_error_303 +- fullName: urllib.request.HTTPRedirectHandler.http_error_307 + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPRedirectHandler.http_error_307 + name: http_error_307 + uid: urllib.request.HTTPRedirectHandler.http_error_307 +- fullName: urllib.request.HTTPRedirectHandler.http_error_308 + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPRedirectHandler.http_error_308 + name: http_error_308 + uid: urllib.request.HTTPRedirectHandler.http_error_308 +- fullName: urllib.request.HTTPRedirectHandler.redirect_request + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPRedirectHandler.redirect_request + name: redirect_request + uid: urllib.request.HTTPRedirectHandler.redirect_request +- fullName: urllib.request.HTTPSHandler.https_open + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPSHandler.https_open + name: https_open + uid: urllib.request.HTTPSHandler.https_open +- fullName: urllib.request.OpenerDirector.add_handler + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.OpenerDirector.add_handler + name: add_handler + uid: urllib.request.OpenerDirector.add_handler +- fullName: urllib.request.OpenerDirector.error + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.OpenerDirector.error + name: error + uid: urllib.request.OpenerDirector.error +- fullName: urllib.request.OpenerDirector.open + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.OpenerDirector.open + name: open + uid: urllib.request.OpenerDirector.open +- fullName: urllib.request.ProxyBasicAuthHandler.http_error_407 + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.ProxyBasicAuthHandler.http_error_407 + name: http_error_407 + uid: urllib.request.ProxyBasicAuthHandler.http_error_407 +- fullName: urllib.request.ProxyDigestAuthHandler.http_error_407 + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.ProxyDigestAuthHandler.http_error_407 + name: http_error_407 + uid: urllib.request.ProxyDigestAuthHandler.http_error_407 +- fullName: urllib.request.Request.add_header + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.Request.add_header + name: add_header + uid: urllib.request.Request.add_header +- fullName: urllib.request.Request.add_unredirected_header + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.Request.add_unredirected_header + name: add_unredirected_header + uid: urllib.request.Request.add_unredirected_header +- fullName: urllib.request.Request.get_full_url + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.Request.get_full_url + name: get_full_url + uid: urllib.request.Request.get_full_url +- fullName: urllib.request.Request.get_header + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.Request.get_header + name: get_header + uid: urllib.request.Request.get_header +- fullName: urllib.request.Request.get_method + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.Request.get_method + name: get_method + uid: urllib.request.Request.get_method +- fullName: urllib.request.Request.has_header + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.Request.has_header + name: has_header + uid: urllib.request.Request.has_header +- fullName: urllib.request.Request.header_items + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.Request.header_items + name: header_items + uid: urllib.request.Request.header_items +- fullName: urllib.request.Request.remove_header + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.Request.remove_header + name: remove_header + uid: urllib.request.Request.remove_header +- fullName: urllib.request.Request.set_proxy + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.Request.set_proxy + name: set_proxy + uid: urllib.request.Request.set_proxy +- fullName: urllib.request.URLopener.open + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.URLopener.open + name: open + uid: urllib.request.URLopener.open +- fullName: urllib.request.URLopener.open_unknown + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.URLopener.open_unknown + name: open_unknown + uid: urllib.request.URLopener.open_unknown +- fullName: urllib.request.URLopener.retrieve + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.URLopener.retrieve + name: retrieve + uid: urllib.request.URLopener.retrieve +- fullName: urllib.request.UnknownHandler.unknown_open + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.UnknownHandler.unknown_open + name: unknown_open + uid: urllib.request.UnknownHandler.unknown_open +- fullName: urllib.response.addinfourl.getcode + href: https://docs.python.org/3/library/urllib.request.html#urllib.response.addinfourl.getcode + name: getcode + uid: urllib.response.addinfourl.getcode +- fullName: urllib.response.addinfourl.geturl + href: https://docs.python.org/3/library/urllib.request.html#urllib.response.addinfourl.geturl + name: geturl + uid: urllib.response.addinfourl.geturl +- fullName: urllib.response.addinfourl.info + href: https://docs.python.org/3/library/urllib.request.html#urllib.response.addinfourl.info + name: info + uid: urllib.response.addinfourl.info +- fullName: urllib.robotparser.RobotFileParser.can_fetch + href: https://docs.python.org/3/library/urllib.robotparser.html#urllib.robotparser.RobotFileParser.can_fetch + name: can_fetch + uid: urllib.robotparser.RobotFileParser.can_fetch +- fullName: urllib.robotparser.RobotFileParser.crawl_delay + href: https://docs.python.org/3/library/urllib.robotparser.html#urllib.robotparser.RobotFileParser.crawl_delay + name: crawl_delay + uid: urllib.robotparser.RobotFileParser.crawl_delay +- fullName: urllib.robotparser.RobotFileParser.modified + href: https://docs.python.org/3/library/urllib.robotparser.html#urllib.robotparser.RobotFileParser.modified + name: modified + uid: urllib.robotparser.RobotFileParser.modified +- fullName: urllib.robotparser.RobotFileParser.mtime + href: https://docs.python.org/3/library/urllib.robotparser.html#urllib.robotparser.RobotFileParser.mtime + name: mtime + uid: urllib.robotparser.RobotFileParser.mtime +- fullName: urllib.robotparser.RobotFileParser.parse + href: https://docs.python.org/3/library/urllib.robotparser.html#urllib.robotparser.RobotFileParser.parse + name: parse + uid: urllib.robotparser.RobotFileParser.parse +- fullName: urllib.robotparser.RobotFileParser.read + href: https://docs.python.org/3/library/urllib.robotparser.html#urllib.robotparser.RobotFileParser.read + name: read + uid: urllib.robotparser.RobotFileParser.read +- fullName: urllib.robotparser.RobotFileParser.request_rate + href: https://docs.python.org/3/library/urllib.robotparser.html#urllib.robotparser.RobotFileParser.request_rate + name: request_rate + uid: urllib.robotparser.RobotFileParser.request_rate +- fullName: urllib.robotparser.RobotFileParser.set_url + href: https://docs.python.org/3/library/urllib.robotparser.html#urllib.robotparser.RobotFileParser.set_url + name: set_url + uid: urllib.robotparser.RobotFileParser.set_url +- fullName: urllib.robotparser.RobotFileParser.site_maps + href: https://docs.python.org/3/library/urllib.robotparser.html#urllib.robotparser.RobotFileParser.site_maps + name: site_maps + uid: urllib.robotparser.RobotFileParser.site_maps +- fullName: venv.EnvBuilder.create + href: https://docs.python.org/3/library/venv.html#venv.EnvBuilder.create + name: create + uid: venv.EnvBuilder.create +- fullName: venv.EnvBuilder.create_configuration + href: https://docs.python.org/3/library/venv.html#venv.EnvBuilder.create_configuration + name: create_configuration + uid: venv.EnvBuilder.create_configuration +- fullName: venv.EnvBuilder.create_git_ignore_file + href: https://docs.python.org/3/library/venv.html#venv.EnvBuilder.create_git_ignore_file + name: create_git_ignore_file + uid: venv.EnvBuilder.create_git_ignore_file +- fullName: venv.EnvBuilder.ensure_directories + href: https://docs.python.org/3/library/venv.html#venv.EnvBuilder.ensure_directories + name: ensure_directories + uid: venv.EnvBuilder.ensure_directories +- fullName: venv.EnvBuilder.install_scripts + href: https://docs.python.org/3/library/venv.html#venv.EnvBuilder.install_scripts + name: install_scripts + uid: venv.EnvBuilder.install_scripts +- fullName: venv.EnvBuilder.post_setup + href: https://docs.python.org/3/library/venv.html#venv.EnvBuilder.post_setup + name: post_setup + uid: venv.EnvBuilder.post_setup +- fullName: venv.EnvBuilder.setup_python + href: https://docs.python.org/3/library/venv.html#venv.EnvBuilder.setup_python + name: setup_python + uid: venv.EnvBuilder.setup_python +- fullName: venv.EnvBuilder.setup_scripts + href: https://docs.python.org/3/library/venv.html#venv.EnvBuilder.setup_scripts + name: setup_scripts + uid: venv.EnvBuilder.setup_scripts +- fullName: venv.EnvBuilder.upgrade_dependencies + href: https://docs.python.org/3/library/venv.html#venv.EnvBuilder.upgrade_dependencies + name: upgrade_dependencies + uid: venv.EnvBuilder.upgrade_dependencies +- fullName: wave.Wave_read.close + href: https://docs.python.org/3/library/wave.html#wave.Wave_read.close + name: close + uid: wave.Wave_read.close +- fullName: wave.Wave_read.getcompname + href: https://docs.python.org/3/library/wave.html#wave.Wave_read.getcompname + name: getcompname + uid: wave.Wave_read.getcompname +- fullName: wave.Wave_read.getcomptype + href: https://docs.python.org/3/library/wave.html#wave.Wave_read.getcomptype + name: getcomptype + uid: wave.Wave_read.getcomptype +- fullName: wave.Wave_read.getframerate + href: https://docs.python.org/3/library/wave.html#wave.Wave_read.getframerate + name: getframerate + uid: wave.Wave_read.getframerate +- fullName: wave.Wave_read.getmark + href: https://docs.python.org/3/library/wave.html#wave.Wave_read.getmark + name: getmark + uid: wave.Wave_read.getmark +- fullName: wave.Wave_read.getmarkers + href: https://docs.python.org/3/library/wave.html#wave.Wave_read.getmarkers + name: getmarkers + uid: wave.Wave_read.getmarkers +- fullName: wave.Wave_read.getnchannels + href: https://docs.python.org/3/library/wave.html#wave.Wave_read.getnchannels + name: getnchannels + uid: wave.Wave_read.getnchannels +- fullName: wave.Wave_read.getnframes + href: https://docs.python.org/3/library/wave.html#wave.Wave_read.getnframes + name: getnframes + uid: wave.Wave_read.getnframes +- fullName: wave.Wave_read.getparams + href: https://docs.python.org/3/library/wave.html#wave.Wave_read.getparams + name: getparams + uid: wave.Wave_read.getparams +- fullName: wave.Wave_read.getsampwidth + href: https://docs.python.org/3/library/wave.html#wave.Wave_read.getsampwidth + name: getsampwidth + uid: wave.Wave_read.getsampwidth +- fullName: wave.Wave_read.readframes + href: https://docs.python.org/3/library/wave.html#wave.Wave_read.readframes + name: readframes + uid: wave.Wave_read.readframes +- fullName: wave.Wave_read.rewind + href: https://docs.python.org/3/library/wave.html#wave.Wave_read.rewind + name: rewind + uid: wave.Wave_read.rewind +- fullName: wave.Wave_read.setpos + href: https://docs.python.org/3/library/wave.html#wave.Wave_read.setpos + name: setpos + uid: wave.Wave_read.setpos +- fullName: wave.Wave_read.tell + href: https://docs.python.org/3/library/wave.html#wave.Wave_read.tell + name: tell + uid: wave.Wave_read.tell +- fullName: wave.Wave_write.close + href: https://docs.python.org/3/library/wave.html#wave.Wave_write.close + name: close + uid: wave.Wave_write.close +- fullName: wave.Wave_write.setcomptype + href: https://docs.python.org/3/library/wave.html#wave.Wave_write.setcomptype + name: setcomptype + uid: wave.Wave_write.setcomptype +- fullName: wave.Wave_write.setframerate + href: https://docs.python.org/3/library/wave.html#wave.Wave_write.setframerate + name: setframerate + uid: wave.Wave_write.setframerate +- fullName: wave.Wave_write.setnchannels + href: https://docs.python.org/3/library/wave.html#wave.Wave_write.setnchannels + name: setnchannels + uid: wave.Wave_write.setnchannels +- fullName: wave.Wave_write.setnframes + href: https://docs.python.org/3/library/wave.html#wave.Wave_write.setnframes + name: setnframes + uid: wave.Wave_write.setnframes +- fullName: wave.Wave_write.setparams + href: https://docs.python.org/3/library/wave.html#wave.Wave_write.setparams + name: setparams + uid: wave.Wave_write.setparams +- fullName: wave.Wave_write.setsampwidth + href: https://docs.python.org/3/library/wave.html#wave.Wave_write.setsampwidth + name: setsampwidth + uid: wave.Wave_write.setsampwidth +- fullName: wave.Wave_write.tell + href: https://docs.python.org/3/library/wave.html#wave.Wave_write.tell + name: tell + uid: wave.Wave_write.tell +- fullName: wave.Wave_write.writeframes + href: https://docs.python.org/3/library/wave.html#wave.Wave_write.writeframes + name: writeframes + uid: wave.Wave_write.writeframes +- fullName: wave.Wave_write.writeframesraw + href: https://docs.python.org/3/library/wave.html#wave.Wave_write.writeframesraw + name: writeframesraw + uid: wave.Wave_write.writeframesraw +- fullName: weakref.WeakKeyDictionary.keyrefs + href: https://docs.python.org/3/library/weakref.html#weakref.WeakKeyDictionary.keyrefs + name: keyrefs + uid: weakref.WeakKeyDictionary.keyrefs +- fullName: weakref.WeakValueDictionary.valuerefs + href: https://docs.python.org/3/library/weakref.html#weakref.WeakValueDictionary.valuerefs + name: valuerefs + uid: weakref.WeakValueDictionary.valuerefs +- fullName: weakref.finalize.__call__ + href: https://docs.python.org/3/library/weakref.html#weakref.finalize.__call__ + name: __call__ + uid: weakref.finalize.__call__ +- fullName: weakref.finalize.detach + href: https://docs.python.org/3/library/weakref.html#weakref.finalize.detach + name: detach + uid: weakref.finalize.detach +- fullName: weakref.finalize.peek + href: https://docs.python.org/3/library/weakref.html#weakref.finalize.peek + name: peek + uid: weakref.finalize.peek +- fullName: webbrowser.controller.open + href: https://docs.python.org/3/library/webbrowser.html#webbrowser.controller.open + name: open + uid: webbrowser.controller.open +- fullName: webbrowser.controller.open_new + href: https://docs.python.org/3/library/webbrowser.html#webbrowser.controller.open_new + name: open_new + uid: webbrowser.controller.open_new +- fullName: webbrowser.controller.open_new_tab + href: https://docs.python.org/3/library/webbrowser.html#webbrowser.controller.open_new_tab + name: open_new_tab + uid: webbrowser.controller.open_new_tab +- fullName: winreg.PyHKEY.Close + href: https://docs.python.org/3/library/winreg.html#winreg.PyHKEY.Close + name: Close + uid: winreg.PyHKEY.Close +- fullName: winreg.PyHKEY.Detach + href: https://docs.python.org/3/library/winreg.html#winreg.PyHKEY.Detach + name: Detach + uid: winreg.PyHKEY.Detach +- fullName: winreg.PyHKEY.__enter__ + href: https://docs.python.org/3/library/winreg.html#winreg.PyHKEY.__enter__ + name: __enter__ + uid: winreg.PyHKEY.__enter__ +- fullName: winreg.PyHKEY.__exit__ + href: https://docs.python.org/3/library/winreg.html#winreg.PyHKEY.__exit__ + name: __exit__ + uid: winreg.PyHKEY.__exit__ +- fullName: wsgiref.handlers.BaseHandler._flush + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler._flush + name: _flush + uid: wsgiref.handlers.BaseHandler._flush +- fullName: wsgiref.handlers.BaseHandler._write + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler._write + name: _write + uid: wsgiref.handlers.BaseHandler._write +- fullName: wsgiref.handlers.BaseHandler.add_cgi_vars + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler.add_cgi_vars + name: add_cgi_vars + uid: wsgiref.handlers.BaseHandler.add_cgi_vars +- fullName: wsgiref.handlers.BaseHandler.error_output + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler.error_output + name: error_output + uid: wsgiref.handlers.BaseHandler.error_output +- fullName: wsgiref.handlers.BaseHandler.get_scheme + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler.get_scheme + name: get_scheme + uid: wsgiref.handlers.BaseHandler.get_scheme +- fullName: wsgiref.handlers.BaseHandler.get_stderr + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler.get_stderr + name: get_stderr + uid: wsgiref.handlers.BaseHandler.get_stderr +- fullName: wsgiref.handlers.BaseHandler.get_stdin + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler.get_stdin + name: get_stdin + uid: wsgiref.handlers.BaseHandler.get_stdin +- fullName: wsgiref.handlers.BaseHandler.log_exception + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler.log_exception + name: log_exception + uid: wsgiref.handlers.BaseHandler.log_exception +- fullName: wsgiref.handlers.BaseHandler.run + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler.run + name: run + uid: wsgiref.handlers.BaseHandler.run +- fullName: wsgiref.handlers.BaseHandler.sendfile + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler.sendfile + name: sendfile + uid: wsgiref.handlers.BaseHandler.sendfile +- fullName: wsgiref.handlers.BaseHandler.setup_environ + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler.setup_environ + name: setup_environ + uid: wsgiref.handlers.BaseHandler.setup_environ +- fullName: wsgiref.headers.Headers.add_header + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.headers.Headers.add_header + name: add_header + uid: wsgiref.headers.Headers.add_header +- fullName: wsgiref.headers.Headers.get_all + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.headers.Headers.get_all + name: get_all + uid: wsgiref.headers.Headers.get_all +- fullName: wsgiref.simple_server.WSGIRequestHandler.get_environ + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.simple_server.WSGIRequestHandler.get_environ + name: get_environ + uid: wsgiref.simple_server.WSGIRequestHandler.get_environ +- fullName: wsgiref.simple_server.WSGIRequestHandler.get_stderr + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.simple_server.WSGIRequestHandler.get_stderr + name: get_stderr + uid: wsgiref.simple_server.WSGIRequestHandler.get_stderr +- fullName: wsgiref.simple_server.WSGIRequestHandler.handle + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.simple_server.WSGIRequestHandler.handle + name: handle + uid: wsgiref.simple_server.WSGIRequestHandler.handle +- fullName: wsgiref.simple_server.WSGIServer.get_app + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.simple_server.WSGIServer.get_app + name: get_app + uid: wsgiref.simple_server.WSGIServer.get_app +- fullName: wsgiref.simple_server.WSGIServer.set_app + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.simple_server.WSGIServer.set_app + name: set_app + uid: wsgiref.simple_server.WSGIServer.set_app +- fullName: xml.dom.DOMImplementation.createDocument + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.DOMImplementation.createDocument + name: createDocument + uid: xml.dom.DOMImplementation.createDocument +- fullName: xml.dom.DOMImplementation.createDocumentType + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.DOMImplementation.createDocumentType + name: createDocumentType + uid: xml.dom.DOMImplementation.createDocumentType +- fullName: xml.dom.DOMImplementation.hasFeature + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.DOMImplementation.hasFeature + name: hasFeature + uid: xml.dom.DOMImplementation.hasFeature +- fullName: xml.dom.Document.createAttribute + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Document.createAttribute + name: createAttribute + uid: xml.dom.Document.createAttribute +- fullName: xml.dom.Document.createAttributeNS + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Document.createAttributeNS + name: createAttributeNS + uid: xml.dom.Document.createAttributeNS +- fullName: xml.dom.Document.createComment + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Document.createComment + name: createComment + uid: xml.dom.Document.createComment +- fullName: xml.dom.Document.createElement + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Document.createElement + name: createElement + uid: xml.dom.Document.createElement +- fullName: xml.dom.Document.createElementNS + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Document.createElementNS + name: createElementNS + uid: xml.dom.Document.createElementNS +- fullName: xml.dom.Document.createProcessingInstruction + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Document.createProcessingInstruction + name: createProcessingInstruction + uid: xml.dom.Document.createProcessingInstruction +- fullName: xml.dom.Document.createTextNode + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Document.createTextNode + name: createTextNode + uid: xml.dom.Document.createTextNode +- fullName: xml.dom.Document.getElementsByTagName + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Document.getElementsByTagName + name: getElementsByTagName + uid: xml.dom.Document.getElementsByTagName +- fullName: xml.dom.Document.getElementsByTagNameNS + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Document.getElementsByTagNameNS + name: getElementsByTagNameNS + uid: xml.dom.Document.getElementsByTagNameNS +- fullName: xml.dom.Element.getAttribute + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Element.getAttribute + name: getAttribute + uid: xml.dom.Element.getAttribute +- fullName: xml.dom.Element.getAttributeNS + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Element.getAttributeNS + name: getAttributeNS + uid: xml.dom.Element.getAttributeNS +- fullName: xml.dom.Element.getAttributeNode + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Element.getAttributeNode + name: getAttributeNode + uid: xml.dom.Element.getAttributeNode +- fullName: xml.dom.Element.getAttributeNodeNS + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Element.getAttributeNodeNS + name: getAttributeNodeNS + uid: xml.dom.Element.getAttributeNodeNS +- fullName: xml.dom.Element.getElementsByTagName + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Element.getElementsByTagName + name: getElementsByTagName + uid: xml.dom.Element.getElementsByTagName +- fullName: xml.dom.Element.getElementsByTagNameNS + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Element.getElementsByTagNameNS + name: getElementsByTagNameNS + uid: xml.dom.Element.getElementsByTagNameNS +- fullName: xml.dom.Element.hasAttribute + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Element.hasAttribute + name: hasAttribute + uid: xml.dom.Element.hasAttribute +- fullName: xml.dom.Element.hasAttributeNS + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Element.hasAttributeNS + name: hasAttributeNS + uid: xml.dom.Element.hasAttributeNS +- fullName: xml.dom.Element.removeAttribute + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Element.removeAttribute + name: removeAttribute + uid: xml.dom.Element.removeAttribute +- fullName: xml.dom.Element.removeAttributeNS + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Element.removeAttributeNS + name: removeAttributeNS + uid: xml.dom.Element.removeAttributeNS +- fullName: xml.dom.Element.removeAttributeNode + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Element.removeAttributeNode + name: removeAttributeNode + uid: xml.dom.Element.removeAttributeNode +- fullName: xml.dom.Element.setAttribute + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Element.setAttribute + name: setAttribute + uid: xml.dom.Element.setAttribute +- fullName: xml.dom.Element.setAttributeNS + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Element.setAttributeNS + name: setAttributeNS + uid: xml.dom.Element.setAttributeNS +- fullName: xml.dom.Element.setAttributeNode + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Element.setAttributeNode + name: setAttributeNode + uid: xml.dom.Element.setAttributeNode +- fullName: xml.dom.Element.setAttributeNodeNS + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Element.setAttributeNodeNS + name: setAttributeNodeNS + uid: xml.dom.Element.setAttributeNodeNS +- fullName: xml.dom.NamedNodeMap.item + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.NamedNodeMap.item + name: item + uid: xml.dom.NamedNodeMap.item +- fullName: xml.dom.Node.appendChild + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Node.appendChild + name: appendChild + uid: xml.dom.Node.appendChild +- fullName: xml.dom.Node.cloneNode + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Node.cloneNode + name: cloneNode + uid: xml.dom.Node.cloneNode +- fullName: xml.dom.Node.hasAttributes + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Node.hasAttributes + name: hasAttributes + uid: xml.dom.Node.hasAttributes +- fullName: xml.dom.Node.hasChildNodes + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Node.hasChildNodes + name: hasChildNodes + uid: xml.dom.Node.hasChildNodes +- fullName: xml.dom.Node.insertBefore + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Node.insertBefore + name: insertBefore + uid: xml.dom.Node.insertBefore +- fullName: xml.dom.Node.isSameNode + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Node.isSameNode + name: isSameNode + uid: xml.dom.Node.isSameNode +- fullName: xml.dom.Node.normalize + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Node.normalize + name: normalize + uid: xml.dom.Node.normalize +- fullName: xml.dom.Node.removeChild + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Node.removeChild + name: removeChild + uid: xml.dom.Node.removeChild +- fullName: xml.dom.Node.replaceChild + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.Node.replaceChild + name: replaceChild + uid: xml.dom.Node.replaceChild +- fullName: xml.dom.NodeList.item + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.NodeList.item + name: item + uid: xml.dom.NodeList.item +- fullName: xml.dom.minidom.Node.toprettyxml + href: https://docs.python.org/3/library/xml.dom.minidom.html#xml.dom.minidom.Node.toprettyxml + name: toprettyxml + uid: xml.dom.minidom.Node.toprettyxml +- fullName: xml.dom.minidom.Node.toxml + href: https://docs.python.org/3/library/xml.dom.minidom.html#xml.dom.minidom.Node.toxml + name: toxml + uid: xml.dom.minidom.Node.toxml +- fullName: xml.dom.minidom.Node.unlink + href: https://docs.python.org/3/library/xml.dom.minidom.html#xml.dom.minidom.Node.unlink + name: unlink + uid: xml.dom.minidom.Node.unlink +- fullName: xml.dom.minidom.Node.writexml + href: https://docs.python.org/3/library/xml.dom.minidom.html#xml.dom.minidom.Node.writexml + name: writexml + uid: xml.dom.minidom.Node.writexml +- fullName: xml.dom.pulldom.DOMEventStream.expandNode + href: https://docs.python.org/3/library/xml.dom.pulldom.html#xml.dom.pulldom.DOMEventStream.expandNode + name: expandNode + uid: xml.dom.pulldom.DOMEventStream.expandNode +- fullName: xml.dom.pulldom.DOMEventStream.getEvent + href: https://docs.python.org/3/library/xml.dom.pulldom.html#xml.dom.pulldom.DOMEventStream.getEvent + name: getEvent + uid: xml.dom.pulldom.DOMEventStream.getEvent +- fullName: xml.dom.pulldom.DOMEventStream.reset + href: https://docs.python.org/3/library/xml.dom.pulldom.html#xml.dom.pulldom.DOMEventStream.reset + name: reset + uid: xml.dom.pulldom.DOMEventStream.reset +- fullName: xml.etree.ElementTree.Element.append + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.append + name: append + uid: xml.etree.ElementTree.Element.append +- fullName: xml.etree.ElementTree.Element.clear + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.clear + name: clear + uid: xml.etree.ElementTree.Element.clear +- fullName: xml.etree.ElementTree.Element.extend + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.extend + name: extend + uid: xml.etree.ElementTree.Element.extend +- fullName: xml.etree.ElementTree.Element.find + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.find + name: find + uid: xml.etree.ElementTree.Element.find +- fullName: xml.etree.ElementTree.Element.findall + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.findall + name: findall + uid: xml.etree.ElementTree.Element.findall +- fullName: xml.etree.ElementTree.Element.findtext + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.findtext + name: findtext + uid: xml.etree.ElementTree.Element.findtext +- fullName: xml.etree.ElementTree.Element.get + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.get + name: get + uid: xml.etree.ElementTree.Element.get +- fullName: xml.etree.ElementTree.Element.insert + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.insert + name: insert + uid: xml.etree.ElementTree.Element.insert +- fullName: xml.etree.ElementTree.Element.items + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.items + name: items + uid: xml.etree.ElementTree.Element.items +- fullName: xml.etree.ElementTree.Element.iter + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.iter + name: iter + uid: xml.etree.ElementTree.Element.iter +- fullName: xml.etree.ElementTree.Element.iterfind + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.iterfind + name: iterfind + uid: xml.etree.ElementTree.Element.iterfind +- fullName: xml.etree.ElementTree.Element.itertext + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.itertext + name: itertext + uid: xml.etree.ElementTree.Element.itertext +- fullName: xml.etree.ElementTree.Element.keys + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.keys + name: keys + uid: xml.etree.ElementTree.Element.keys +- fullName: xml.etree.ElementTree.Element.makeelement + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.makeelement + name: makeelement + uid: xml.etree.ElementTree.Element.makeelement +- fullName: xml.etree.ElementTree.Element.remove + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.remove + name: remove + uid: xml.etree.ElementTree.Element.remove +- fullName: xml.etree.ElementTree.Element.set + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element.set + name: set + uid: xml.etree.ElementTree.Element.set +- fullName: xml.etree.ElementTree.ElementTree._setroot + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree._setroot + name: _setroot + uid: xml.etree.ElementTree.ElementTree._setroot +- fullName: xml.etree.ElementTree.ElementTree.find + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree.find + name: find + uid: xml.etree.ElementTree.ElementTree.find +- fullName: xml.etree.ElementTree.ElementTree.findall + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree.findall + name: findall + uid: xml.etree.ElementTree.ElementTree.findall +- fullName: xml.etree.ElementTree.ElementTree.findtext + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree.findtext + name: findtext + uid: xml.etree.ElementTree.ElementTree.findtext +- fullName: xml.etree.ElementTree.ElementTree.getroot + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree.getroot + name: getroot + uid: xml.etree.ElementTree.ElementTree.getroot +- fullName: xml.etree.ElementTree.ElementTree.iter + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree.iter + name: iter + uid: xml.etree.ElementTree.ElementTree.iter +- fullName: xml.etree.ElementTree.ElementTree.iterfind + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree.iterfind + name: iterfind + uid: xml.etree.ElementTree.ElementTree.iterfind +- fullName: xml.etree.ElementTree.ElementTree.parse + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree.parse + name: parse + uid: xml.etree.ElementTree.ElementTree.parse +- fullName: xml.etree.ElementTree.ElementTree.write + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree.write + name: write + uid: xml.etree.ElementTree.ElementTree.write +- fullName: xml.etree.ElementTree.TreeBuilder.close + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.TreeBuilder.close + name: close + uid: xml.etree.ElementTree.TreeBuilder.close +- fullName: xml.etree.ElementTree.TreeBuilder.comment + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.TreeBuilder.comment + name: comment + uid: xml.etree.ElementTree.TreeBuilder.comment +- fullName: xml.etree.ElementTree.TreeBuilder.data + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.TreeBuilder.data + name: data + uid: xml.etree.ElementTree.TreeBuilder.data +- fullName: xml.etree.ElementTree.TreeBuilder.doctype + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.TreeBuilder.doctype + name: doctype + uid: xml.etree.ElementTree.TreeBuilder.doctype +- fullName: xml.etree.ElementTree.TreeBuilder.end + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.TreeBuilder.end + name: end + uid: xml.etree.ElementTree.TreeBuilder.end +- fullName: xml.etree.ElementTree.TreeBuilder.end_ns + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.TreeBuilder.end_ns + name: end_ns + uid: xml.etree.ElementTree.TreeBuilder.end_ns +- fullName: xml.etree.ElementTree.TreeBuilder.pi + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.TreeBuilder.pi + name: pi + uid: xml.etree.ElementTree.TreeBuilder.pi +- fullName: xml.etree.ElementTree.TreeBuilder.start + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.TreeBuilder.start + name: start + uid: xml.etree.ElementTree.TreeBuilder.start +- fullName: xml.etree.ElementTree.TreeBuilder.start_ns + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.TreeBuilder.start_ns + name: start_ns + uid: xml.etree.ElementTree.TreeBuilder.start_ns +- fullName: xml.etree.ElementTree.XMLParser.close + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser.close + name: close + uid: xml.etree.ElementTree.XMLParser.close +- fullName: xml.etree.ElementTree.XMLParser.feed + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser.feed + name: feed + uid: xml.etree.ElementTree.XMLParser.feed +- fullName: xml.etree.ElementTree.XMLParser.flush + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser.flush + name: flush + uid: xml.etree.ElementTree.XMLParser.flush +- fullName: xml.etree.ElementTree.XMLPullParser.close + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser.close + name: close + uid: xml.etree.ElementTree.XMLPullParser.close +- fullName: xml.etree.ElementTree.XMLPullParser.feed + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser.feed + name: feed + uid: xml.etree.ElementTree.XMLPullParser.feed +- fullName: xml.etree.ElementTree.XMLPullParser.flush + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser.flush + name: flush + uid: xml.etree.ElementTree.XMLPullParser.flush +- fullName: xml.etree.ElementTree.XMLPullParser.read_events + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser.read_events + name: read_events + uid: xml.etree.ElementTree.XMLPullParser.read_events +- fullName: xml.parsers.expat.xmlparser.AttlistDeclHandler + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.AttlistDeclHandler + name: AttlistDeclHandler + uid: xml.parsers.expat.xmlparser.AttlistDeclHandler +- fullName: xml.parsers.expat.xmlparser.CharacterDataHandler + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.CharacterDataHandler + name: CharacterDataHandler + uid: xml.parsers.expat.xmlparser.CharacterDataHandler +- fullName: xml.parsers.expat.xmlparser.CommentHandler + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.CommentHandler + name: CommentHandler + uid: xml.parsers.expat.xmlparser.CommentHandler +- fullName: xml.parsers.expat.xmlparser.DefaultHandler + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.DefaultHandler + name: DefaultHandler + uid: xml.parsers.expat.xmlparser.DefaultHandler +- fullName: xml.parsers.expat.xmlparser.DefaultHandlerExpand + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.DefaultHandlerExpand + name: DefaultHandlerExpand + uid: xml.parsers.expat.xmlparser.DefaultHandlerExpand +- fullName: xml.parsers.expat.xmlparser.ElementDeclHandler + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.ElementDeclHandler + name: ElementDeclHandler + uid: xml.parsers.expat.xmlparser.ElementDeclHandler +- fullName: xml.parsers.expat.xmlparser.EndCdataSectionHandler + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.EndCdataSectionHandler + name: EndCdataSectionHandler + uid: xml.parsers.expat.xmlparser.EndCdataSectionHandler +- fullName: xml.parsers.expat.xmlparser.EndDoctypeDeclHandler + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.EndDoctypeDeclHandler + name: EndDoctypeDeclHandler + uid: xml.parsers.expat.xmlparser.EndDoctypeDeclHandler +- fullName: xml.parsers.expat.xmlparser.EndElementHandler + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.EndElementHandler + name: EndElementHandler + uid: xml.parsers.expat.xmlparser.EndElementHandler +- fullName: xml.parsers.expat.xmlparser.EndNamespaceDeclHandler + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.EndNamespaceDeclHandler + name: EndNamespaceDeclHandler + uid: xml.parsers.expat.xmlparser.EndNamespaceDeclHandler +- fullName: xml.parsers.expat.xmlparser.EntityDeclHandler + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.EntityDeclHandler + name: EntityDeclHandler + uid: xml.parsers.expat.xmlparser.EntityDeclHandler +- fullName: xml.parsers.expat.xmlparser.ExternalEntityParserCreate + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.ExternalEntityParserCreate + name: ExternalEntityParserCreate + uid: xml.parsers.expat.xmlparser.ExternalEntityParserCreate +- fullName: xml.parsers.expat.xmlparser.ExternalEntityRefHandler + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.ExternalEntityRefHandler + name: ExternalEntityRefHandler + uid: xml.parsers.expat.xmlparser.ExternalEntityRefHandler +- fullName: xml.parsers.expat.xmlparser.GetBase + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.GetBase + name: GetBase + uid: xml.parsers.expat.xmlparser.GetBase +- fullName: xml.parsers.expat.xmlparser.GetInputContext + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.GetInputContext + name: GetInputContext + uid: xml.parsers.expat.xmlparser.GetInputContext +- fullName: xml.parsers.expat.xmlparser.GetReparseDeferralEnabled + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.GetReparseDeferralEnabled + name: GetReparseDeferralEnabled + uid: xml.parsers.expat.xmlparser.GetReparseDeferralEnabled +- fullName: xml.parsers.expat.xmlparser.NotStandaloneHandler + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.NotStandaloneHandler + name: NotStandaloneHandler + uid: xml.parsers.expat.xmlparser.NotStandaloneHandler +- fullName: xml.parsers.expat.xmlparser.NotationDeclHandler + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.NotationDeclHandler + name: NotationDeclHandler + uid: xml.parsers.expat.xmlparser.NotationDeclHandler +- fullName: xml.parsers.expat.xmlparser.Parse + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.Parse + name: Parse + uid: xml.parsers.expat.xmlparser.Parse +- fullName: xml.parsers.expat.xmlparser.ParseFile + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.ParseFile + name: ParseFile + uid: xml.parsers.expat.xmlparser.ParseFile +- fullName: xml.parsers.expat.xmlparser.ProcessingInstructionHandler + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.ProcessingInstructionHandler + name: ProcessingInstructionHandler + uid: xml.parsers.expat.xmlparser.ProcessingInstructionHandler +- fullName: xml.parsers.expat.xmlparser.SetBase + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.SetBase + name: SetBase + uid: xml.parsers.expat.xmlparser.SetBase +- fullName: xml.parsers.expat.xmlparser.SetParamEntityParsing + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.SetParamEntityParsing + name: SetParamEntityParsing + uid: xml.parsers.expat.xmlparser.SetParamEntityParsing +- fullName: xml.parsers.expat.xmlparser.SetReparseDeferralEnabled + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.SetReparseDeferralEnabled + name: SetReparseDeferralEnabled + uid: xml.parsers.expat.xmlparser.SetReparseDeferralEnabled +- fullName: xml.parsers.expat.xmlparser.StartCdataSectionHandler + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.StartCdataSectionHandler + name: StartCdataSectionHandler + uid: xml.parsers.expat.xmlparser.StartCdataSectionHandler +- fullName: xml.parsers.expat.xmlparser.StartDoctypeDeclHandler + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.StartDoctypeDeclHandler + name: StartDoctypeDeclHandler + uid: xml.parsers.expat.xmlparser.StartDoctypeDeclHandler +- fullName: xml.parsers.expat.xmlparser.StartElementHandler + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.StartElementHandler + name: StartElementHandler + uid: xml.parsers.expat.xmlparser.StartElementHandler +- fullName: xml.parsers.expat.xmlparser.StartNamespaceDeclHandler + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.StartNamespaceDeclHandler + name: StartNamespaceDeclHandler + uid: xml.parsers.expat.xmlparser.StartNamespaceDeclHandler +- fullName: xml.parsers.expat.xmlparser.UnparsedEntityDeclHandler + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.UnparsedEntityDeclHandler + name: UnparsedEntityDeclHandler + uid: xml.parsers.expat.xmlparser.UnparsedEntityDeclHandler +- fullName: xml.parsers.expat.xmlparser.UseForeignDTD + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.UseForeignDTD + name: UseForeignDTD + uid: xml.parsers.expat.xmlparser.UseForeignDTD +- fullName: xml.parsers.expat.xmlparser.XmlDeclHandler + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.xmlparser.XmlDeclHandler + name: XmlDeclHandler + uid: xml.parsers.expat.xmlparser.XmlDeclHandler +- fullName: xml.sax.SAXException.getException + href: https://docs.python.org/3/library/xml.sax.html#xml.sax.SAXException.getException + name: getException + uid: xml.sax.SAXException.getException +- fullName: xml.sax.SAXException.getMessage + href: https://docs.python.org/3/library/xml.sax.html#xml.sax.SAXException.getMessage + name: getMessage + uid: xml.sax.SAXException.getMessage +- fullName: xml.sax.handler.ContentHandler.characters + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.ContentHandler.characters + name: characters + uid: xml.sax.handler.ContentHandler.characters +- fullName: xml.sax.handler.ContentHandler.endDocument + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.ContentHandler.endDocument + name: endDocument + uid: xml.sax.handler.ContentHandler.endDocument +- fullName: xml.sax.handler.ContentHandler.endElement + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.ContentHandler.endElement + name: endElement + uid: xml.sax.handler.ContentHandler.endElement +- fullName: xml.sax.handler.ContentHandler.endElementNS + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.ContentHandler.endElementNS + name: endElementNS + uid: xml.sax.handler.ContentHandler.endElementNS +- fullName: xml.sax.handler.ContentHandler.endPrefixMapping + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.ContentHandler.endPrefixMapping + name: endPrefixMapping + uid: xml.sax.handler.ContentHandler.endPrefixMapping +- fullName: xml.sax.handler.ContentHandler.ignorableWhitespace + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.ContentHandler.ignorableWhitespace + name: ignorableWhitespace + uid: xml.sax.handler.ContentHandler.ignorableWhitespace +- fullName: xml.sax.handler.ContentHandler.processingInstruction + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.ContentHandler.processingInstruction + name: processingInstruction + uid: xml.sax.handler.ContentHandler.processingInstruction +- fullName: xml.sax.handler.ContentHandler.setDocumentLocator + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.ContentHandler.setDocumentLocator + name: setDocumentLocator + uid: xml.sax.handler.ContentHandler.setDocumentLocator +- fullName: xml.sax.handler.ContentHandler.skippedEntity + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.ContentHandler.skippedEntity + name: skippedEntity + uid: xml.sax.handler.ContentHandler.skippedEntity +- fullName: xml.sax.handler.ContentHandler.startDocument + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.ContentHandler.startDocument + name: startDocument + uid: xml.sax.handler.ContentHandler.startDocument +- fullName: xml.sax.handler.ContentHandler.startElement + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.ContentHandler.startElement + name: startElement + uid: xml.sax.handler.ContentHandler.startElement +- fullName: xml.sax.handler.ContentHandler.startElementNS + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.ContentHandler.startElementNS + name: startElementNS + uid: xml.sax.handler.ContentHandler.startElementNS +- fullName: xml.sax.handler.ContentHandler.startPrefixMapping + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.ContentHandler.startPrefixMapping + name: startPrefixMapping + uid: xml.sax.handler.ContentHandler.startPrefixMapping +- fullName: xml.sax.handler.DTDHandler.notationDecl + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.DTDHandler.notationDecl + name: notationDecl + uid: xml.sax.handler.DTDHandler.notationDecl +- fullName: xml.sax.handler.DTDHandler.unparsedEntityDecl + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.DTDHandler.unparsedEntityDecl + name: unparsedEntityDecl + uid: xml.sax.handler.DTDHandler.unparsedEntityDecl +- fullName: xml.sax.handler.EntityResolver.resolveEntity + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.EntityResolver.resolveEntity + name: resolveEntity + uid: xml.sax.handler.EntityResolver.resolveEntity +- fullName: xml.sax.handler.ErrorHandler.error + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.ErrorHandler.error + name: error + uid: xml.sax.handler.ErrorHandler.error +- fullName: xml.sax.handler.ErrorHandler.fatalError + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.ErrorHandler.fatalError + name: fatalError + uid: xml.sax.handler.ErrorHandler.fatalError +- fullName: xml.sax.handler.ErrorHandler.warning + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.ErrorHandler.warning + name: warning + uid: xml.sax.handler.ErrorHandler.warning +- fullName: xml.sax.handler.LexicalHandler.comment + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.LexicalHandler.comment + name: comment + uid: xml.sax.handler.LexicalHandler.comment +- fullName: xml.sax.handler.LexicalHandler.endCDATA + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.LexicalHandler.endCDATA + name: endCDATA + uid: xml.sax.handler.LexicalHandler.endCDATA +- fullName: xml.sax.handler.LexicalHandler.endDTD + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.LexicalHandler.endDTD + name: endDTD + uid: xml.sax.handler.LexicalHandler.endDTD +- fullName: xml.sax.handler.LexicalHandler.startCDATA + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.LexicalHandler.startCDATA + name: startCDATA + uid: xml.sax.handler.LexicalHandler.startCDATA +- fullName: xml.sax.handler.LexicalHandler.startDTD + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.LexicalHandler.startDTD + name: startDTD + uid: xml.sax.handler.LexicalHandler.startDTD +- fullName: xml.sax.xmlreader.Attributes.getLength + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.Attributes.getLength + name: getLength + uid: xml.sax.xmlreader.Attributes.getLength +- fullName: xml.sax.xmlreader.Attributes.getNames + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.Attributes.getNames + name: getNames + uid: xml.sax.xmlreader.Attributes.getNames +- fullName: xml.sax.xmlreader.Attributes.getType + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.Attributes.getType + name: getType + uid: xml.sax.xmlreader.Attributes.getType +- fullName: xml.sax.xmlreader.Attributes.getValue + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.Attributes.getValue + name: getValue + uid: xml.sax.xmlreader.Attributes.getValue +- fullName: xml.sax.xmlreader.AttributesNS.getNameByQName + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.AttributesNS.getNameByQName + name: getNameByQName + uid: xml.sax.xmlreader.AttributesNS.getNameByQName +- fullName: xml.sax.xmlreader.AttributesNS.getQNameByName + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.AttributesNS.getQNameByName + name: getQNameByName + uid: xml.sax.xmlreader.AttributesNS.getQNameByName +- fullName: xml.sax.xmlreader.AttributesNS.getQNames + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.AttributesNS.getQNames + name: getQNames + uid: xml.sax.xmlreader.AttributesNS.getQNames +- fullName: xml.sax.xmlreader.AttributesNS.getValueByQName + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.AttributesNS.getValueByQName + name: getValueByQName + uid: xml.sax.xmlreader.AttributesNS.getValueByQName +- fullName: xml.sax.xmlreader.IncrementalParser.close + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.IncrementalParser.close + name: close + uid: xml.sax.xmlreader.IncrementalParser.close +- fullName: xml.sax.xmlreader.IncrementalParser.feed + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.IncrementalParser.feed + name: feed + uid: xml.sax.xmlreader.IncrementalParser.feed +- fullName: xml.sax.xmlreader.IncrementalParser.reset + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.IncrementalParser.reset + name: reset + uid: xml.sax.xmlreader.IncrementalParser.reset +- fullName: xml.sax.xmlreader.InputSource.getByteStream + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.InputSource.getByteStream + name: getByteStream + uid: xml.sax.xmlreader.InputSource.getByteStream +- fullName: xml.sax.xmlreader.InputSource.getCharacterStream + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.InputSource.getCharacterStream + name: getCharacterStream + uid: xml.sax.xmlreader.InputSource.getCharacterStream +- fullName: xml.sax.xmlreader.InputSource.getEncoding + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.InputSource.getEncoding + name: getEncoding + uid: xml.sax.xmlreader.InputSource.getEncoding +- fullName: xml.sax.xmlreader.InputSource.getPublicId + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.InputSource.getPublicId + name: getPublicId + uid: xml.sax.xmlreader.InputSource.getPublicId +- fullName: xml.sax.xmlreader.InputSource.getSystemId + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.InputSource.getSystemId + name: getSystemId + uid: xml.sax.xmlreader.InputSource.getSystemId +- fullName: xml.sax.xmlreader.InputSource.setByteStream + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.InputSource.setByteStream + name: setByteStream + uid: xml.sax.xmlreader.InputSource.setByteStream +- fullName: xml.sax.xmlreader.InputSource.setCharacterStream + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.InputSource.setCharacterStream + name: setCharacterStream + uid: xml.sax.xmlreader.InputSource.setCharacterStream +- fullName: xml.sax.xmlreader.InputSource.setEncoding + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.InputSource.setEncoding + name: setEncoding + uid: xml.sax.xmlreader.InputSource.setEncoding +- fullName: xml.sax.xmlreader.InputSource.setPublicId + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.InputSource.setPublicId + name: setPublicId + uid: xml.sax.xmlreader.InputSource.setPublicId +- fullName: xml.sax.xmlreader.InputSource.setSystemId + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.InputSource.setSystemId + name: setSystemId + uid: xml.sax.xmlreader.InputSource.setSystemId +- fullName: xml.sax.xmlreader.Locator.getColumnNumber + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.Locator.getColumnNumber + name: getColumnNumber + uid: xml.sax.xmlreader.Locator.getColumnNumber +- fullName: xml.sax.xmlreader.Locator.getLineNumber + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.Locator.getLineNumber + name: getLineNumber + uid: xml.sax.xmlreader.Locator.getLineNumber +- fullName: xml.sax.xmlreader.Locator.getPublicId + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.Locator.getPublicId + name: getPublicId + uid: xml.sax.xmlreader.Locator.getPublicId +- fullName: xml.sax.xmlreader.Locator.getSystemId + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.Locator.getSystemId + name: getSystemId + uid: xml.sax.xmlreader.Locator.getSystemId +- fullName: xml.sax.xmlreader.XMLReader.getContentHandler + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.XMLReader.getContentHandler + name: getContentHandler + uid: xml.sax.xmlreader.XMLReader.getContentHandler +- fullName: xml.sax.xmlreader.XMLReader.getDTDHandler + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.XMLReader.getDTDHandler + name: getDTDHandler + uid: xml.sax.xmlreader.XMLReader.getDTDHandler +- fullName: xml.sax.xmlreader.XMLReader.getEntityResolver + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.XMLReader.getEntityResolver + name: getEntityResolver + uid: xml.sax.xmlreader.XMLReader.getEntityResolver +- fullName: xml.sax.xmlreader.XMLReader.getErrorHandler + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.XMLReader.getErrorHandler + name: getErrorHandler + uid: xml.sax.xmlreader.XMLReader.getErrorHandler +- fullName: xml.sax.xmlreader.XMLReader.getFeature + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.XMLReader.getFeature + name: getFeature + uid: xml.sax.xmlreader.XMLReader.getFeature +- fullName: xml.sax.xmlreader.XMLReader.getProperty + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.XMLReader.getProperty + name: getProperty + uid: xml.sax.xmlreader.XMLReader.getProperty +- fullName: xml.sax.xmlreader.XMLReader.parse + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.XMLReader.parse + name: parse + uid: xml.sax.xmlreader.XMLReader.parse +- fullName: xml.sax.xmlreader.XMLReader.setContentHandler + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.XMLReader.setContentHandler + name: setContentHandler + uid: xml.sax.xmlreader.XMLReader.setContentHandler +- fullName: xml.sax.xmlreader.XMLReader.setDTDHandler + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.XMLReader.setDTDHandler + name: setDTDHandler + uid: xml.sax.xmlreader.XMLReader.setDTDHandler +- fullName: xml.sax.xmlreader.XMLReader.setEntityResolver + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.XMLReader.setEntityResolver + name: setEntityResolver + uid: xml.sax.xmlreader.XMLReader.setEntityResolver +- fullName: xml.sax.xmlreader.XMLReader.setErrorHandler + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.XMLReader.setErrorHandler + name: setErrorHandler + uid: xml.sax.xmlreader.XMLReader.setErrorHandler +- fullName: xml.sax.xmlreader.XMLReader.setFeature + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.XMLReader.setFeature + name: setFeature + uid: xml.sax.xmlreader.XMLReader.setFeature +- fullName: xml.sax.xmlreader.XMLReader.setLocale + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.XMLReader.setLocale + name: setLocale + uid: xml.sax.xmlreader.XMLReader.setLocale +- fullName: xml.sax.xmlreader.XMLReader.setProperty + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.XMLReader.setProperty + name: setProperty + uid: xml.sax.xmlreader.XMLReader.setProperty +- fullName: xmlrpc.client.Binary.decode + href: https://docs.python.org/3/library/xmlrpc.client.html#xmlrpc.client.Binary.decode + name: decode + uid: xmlrpc.client.Binary.decode +- fullName: xmlrpc.client.Binary.encode + href: https://docs.python.org/3/library/xmlrpc.client.html#xmlrpc.client.Binary.encode + name: encode + uid: xmlrpc.client.Binary.encode +- fullName: xmlrpc.client.DateTime.decode + href: https://docs.python.org/3/library/xmlrpc.client.html#xmlrpc.client.DateTime.decode + name: decode + uid: xmlrpc.client.DateTime.decode +- fullName: xmlrpc.client.DateTime.encode + href: https://docs.python.org/3/library/xmlrpc.client.html#xmlrpc.client.DateTime.encode + name: encode + uid: xmlrpc.client.DateTime.encode +- fullName: xmlrpc.client.ServerProxy.system.listMethods + href: https://docs.python.org/3/library/xmlrpc.client.html#xmlrpc.client.ServerProxy.system.listMethods + name: listMethods + uid: xmlrpc.client.ServerProxy.system.listMethods +- fullName: xmlrpc.client.ServerProxy.system.methodHelp + href: https://docs.python.org/3/library/xmlrpc.client.html#xmlrpc.client.ServerProxy.system.methodHelp + name: methodHelp + uid: xmlrpc.client.ServerProxy.system.methodHelp +- fullName: xmlrpc.client.ServerProxy.system.methodSignature + href: https://docs.python.org/3/library/xmlrpc.client.html#xmlrpc.client.ServerProxy.system.methodSignature + name: methodSignature + uid: xmlrpc.client.ServerProxy.system.methodSignature +- fullName: xmlrpc.server.CGIXMLRPCRequestHandler.handle_request + href: https://docs.python.org/3/library/xmlrpc.server.html#xmlrpc.server.CGIXMLRPCRequestHandler.handle_request + name: handle_request + uid: xmlrpc.server.CGIXMLRPCRequestHandler.handle_request +- fullName: xmlrpc.server.CGIXMLRPCRequestHandler.register_function + href: https://docs.python.org/3/library/xmlrpc.server.html#xmlrpc.server.CGIXMLRPCRequestHandler.register_function + name: register_function + uid: xmlrpc.server.CGIXMLRPCRequestHandler.register_function +- fullName: xmlrpc.server.CGIXMLRPCRequestHandler.register_instance + href: https://docs.python.org/3/library/xmlrpc.server.html#xmlrpc.server.CGIXMLRPCRequestHandler.register_instance + name: register_instance + uid: xmlrpc.server.CGIXMLRPCRequestHandler.register_instance +- fullName: xmlrpc.server.CGIXMLRPCRequestHandler.register_introspection_functions + href: https://docs.python.org/3/library/xmlrpc.server.html#xmlrpc.server.CGIXMLRPCRequestHandler.register_introspection_functions + name: register_introspection_functions + uid: xmlrpc.server.CGIXMLRPCRequestHandler.register_introspection_functions +- fullName: xmlrpc.server.CGIXMLRPCRequestHandler.register_multicall_functions + href: https://docs.python.org/3/library/xmlrpc.server.html#xmlrpc.server.CGIXMLRPCRequestHandler.register_multicall_functions + name: register_multicall_functions + uid: xmlrpc.server.CGIXMLRPCRequestHandler.register_multicall_functions +- fullName: xmlrpc.server.DocCGIXMLRPCRequestHandler.set_server_documentation + href: https://docs.python.org/3/library/xmlrpc.server.html#xmlrpc.server.DocCGIXMLRPCRequestHandler.set_server_documentation + name: set_server_documentation + uid: xmlrpc.server.DocCGIXMLRPCRequestHandler.set_server_documentation +- fullName: xmlrpc.server.DocCGIXMLRPCRequestHandler.set_server_name + href: https://docs.python.org/3/library/xmlrpc.server.html#xmlrpc.server.DocCGIXMLRPCRequestHandler.set_server_name + name: set_server_name + uid: xmlrpc.server.DocCGIXMLRPCRequestHandler.set_server_name +- fullName: xmlrpc.server.DocCGIXMLRPCRequestHandler.set_server_title + href: https://docs.python.org/3/library/xmlrpc.server.html#xmlrpc.server.DocCGIXMLRPCRequestHandler.set_server_title + name: set_server_title + uid: xmlrpc.server.DocCGIXMLRPCRequestHandler.set_server_title +- fullName: xmlrpc.server.DocXMLRPCServer.set_server_documentation + href: https://docs.python.org/3/library/xmlrpc.server.html#xmlrpc.server.DocXMLRPCServer.set_server_documentation + name: set_server_documentation + uid: xmlrpc.server.DocXMLRPCServer.set_server_documentation +- fullName: xmlrpc.server.DocXMLRPCServer.set_server_name + href: https://docs.python.org/3/library/xmlrpc.server.html#xmlrpc.server.DocXMLRPCServer.set_server_name + name: set_server_name + uid: xmlrpc.server.DocXMLRPCServer.set_server_name +- fullName: xmlrpc.server.DocXMLRPCServer.set_server_title + href: https://docs.python.org/3/library/xmlrpc.server.html#xmlrpc.server.DocXMLRPCServer.set_server_title + name: set_server_title + uid: xmlrpc.server.DocXMLRPCServer.set_server_title +- fullName: xmlrpc.server.SimpleXMLRPCServer.register_function + href: https://docs.python.org/3/library/xmlrpc.server.html#xmlrpc.server.SimpleXMLRPCServer.register_function + name: register_function + uid: xmlrpc.server.SimpleXMLRPCServer.register_function +- fullName: xmlrpc.server.SimpleXMLRPCServer.register_instance + href: https://docs.python.org/3/library/xmlrpc.server.html#xmlrpc.server.SimpleXMLRPCServer.register_instance + name: register_instance + uid: xmlrpc.server.SimpleXMLRPCServer.register_instance +- fullName: xmlrpc.server.SimpleXMLRPCServer.register_introspection_functions + href: https://docs.python.org/3/library/xmlrpc.server.html#xmlrpc.server.SimpleXMLRPCServer.register_introspection_functions + name: register_introspection_functions + uid: xmlrpc.server.SimpleXMLRPCServer.register_introspection_functions +- fullName: xmlrpc.server.SimpleXMLRPCServer.register_multicall_functions + href: https://docs.python.org/3/library/xmlrpc.server.html#xmlrpc.server.SimpleXMLRPCServer.register_multicall_functions + name: register_multicall_functions + uid: xmlrpc.server.SimpleXMLRPCServer.register_multicall_functions +- fullName: zipfile.Path.exists + href: https://docs.python.org/3/library/zipfile.html#zipfile.Path.exists + name: exists + uid: zipfile.Path.exists +- fullName: zipfile.Path.is_dir + href: https://docs.python.org/3/library/zipfile.html#zipfile.Path.is_dir + name: is_dir + uid: zipfile.Path.is_dir +- fullName: zipfile.Path.is_file + href: https://docs.python.org/3/library/zipfile.html#zipfile.Path.is_file + name: is_file + uid: zipfile.Path.is_file +- fullName: zipfile.Path.is_symlink + href: https://docs.python.org/3/library/zipfile.html#zipfile.Path.is_symlink + name: is_symlink + uid: zipfile.Path.is_symlink +- fullName: zipfile.Path.iterdir + href: https://docs.python.org/3/library/zipfile.html#zipfile.Path.iterdir + name: iterdir + uid: zipfile.Path.iterdir +- fullName: zipfile.Path.joinpath + href: https://docs.python.org/3/library/zipfile.html#zipfile.Path.joinpath + name: joinpath + uid: zipfile.Path.joinpath +- fullName: zipfile.Path.open + href: https://docs.python.org/3/library/zipfile.html#zipfile.Path.open + name: open + uid: zipfile.Path.open +- fullName: zipfile.Path.read_bytes + href: https://docs.python.org/3/library/zipfile.html#zipfile.Path.read_bytes + name: read_bytes + uid: zipfile.Path.read_bytes +- fullName: zipfile.Path.read_text + href: https://docs.python.org/3/library/zipfile.html#zipfile.Path.read_text + name: read_text + uid: zipfile.Path.read_text +- fullName: zipfile.PyZipFile.writepy + href: https://docs.python.org/3/library/zipfile.html#zipfile.PyZipFile.writepy + name: writepy + uid: zipfile.PyZipFile.writepy +- fullName: zipfile.ZipFile.close + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipFile.close + name: close + uid: zipfile.ZipFile.close +- fullName: zipfile.ZipFile.extract + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipFile.extract + name: extract + uid: zipfile.ZipFile.extract +- fullName: zipfile.ZipFile.extractall + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipFile.extractall + name: extractall + uid: zipfile.ZipFile.extractall +- fullName: zipfile.ZipFile.getinfo + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipFile.getinfo + name: getinfo + uid: zipfile.ZipFile.getinfo +- fullName: zipfile.ZipFile.infolist + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipFile.infolist + name: infolist + uid: zipfile.ZipFile.infolist +- fullName: zipfile.ZipFile.mkdir + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipFile.mkdir + name: mkdir + uid: zipfile.ZipFile.mkdir +- fullName: zipfile.ZipFile.namelist + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipFile.namelist + name: namelist + uid: zipfile.ZipFile.namelist +- fullName: zipfile.ZipFile.open + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipFile.open + name: open + uid: zipfile.ZipFile.open +- fullName: zipfile.ZipFile.printdir + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipFile.printdir + name: printdir + uid: zipfile.ZipFile.printdir +- fullName: zipfile.ZipFile.read + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipFile.read + name: read + uid: zipfile.ZipFile.read +- fullName: zipfile.ZipFile.setpassword + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipFile.setpassword + name: setpassword + uid: zipfile.ZipFile.setpassword +- fullName: zipfile.ZipFile.testzip + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipFile.testzip + name: testzip + uid: zipfile.ZipFile.testzip +- fullName: zipfile.ZipFile.write + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipFile.write + name: write + uid: zipfile.ZipFile.write +- fullName: zipfile.ZipFile.writestr + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipFile.writestr + name: writestr + uid: zipfile.ZipFile.writestr +- fullName: zipfile.ZipInfo.from_file + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipInfo.from_file + name: from_file + uid: zipfile.ZipInfo.from_file +- fullName: zipfile.ZipInfo.is_dir + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipInfo.is_dir + name: is_dir + uid: zipfile.ZipInfo.is_dir +- fullName: zipimport.zipimporter.create_module + href: https://docs.python.org/3/library/zipimport.html#zipimport.zipimporter.create_module + name: create_module + uid: zipimport.zipimporter.create_module +- fullName: zipimport.zipimporter.exec_module + href: https://docs.python.org/3/library/zipimport.html#zipimport.zipimporter.exec_module + name: exec_module + uid: zipimport.zipimporter.exec_module +- fullName: zipimport.zipimporter.find_spec + href: https://docs.python.org/3/library/zipimport.html#zipimport.zipimporter.find_spec + name: find_spec + uid: zipimport.zipimporter.find_spec +- fullName: zipimport.zipimporter.get_code + href: https://docs.python.org/3/library/zipimport.html#zipimport.zipimporter.get_code + name: get_code + uid: zipimport.zipimporter.get_code +- fullName: zipimport.zipimporter.get_data + href: https://docs.python.org/3/library/zipimport.html#zipimport.zipimporter.get_data + name: get_data + uid: zipimport.zipimporter.get_data +- fullName: zipimport.zipimporter.get_filename + href: https://docs.python.org/3/library/zipimport.html#zipimport.zipimporter.get_filename + name: get_filename + uid: zipimport.zipimporter.get_filename +- fullName: zipimport.zipimporter.get_source + href: https://docs.python.org/3/library/zipimport.html#zipimport.zipimporter.get_source + name: get_source + uid: zipimport.zipimporter.get_source +- fullName: zipimport.zipimporter.invalidate_caches + href: https://docs.python.org/3/library/zipimport.html#zipimport.zipimporter.invalidate_caches + name: invalidate_caches + uid: zipimport.zipimporter.invalidate_caches +- fullName: zipimport.zipimporter.is_package + href: https://docs.python.org/3/library/zipimport.html#zipimport.zipimporter.is_package + name: is_package + uid: zipimport.zipimporter.is_package +- fullName: zipimport.zipimporter.load_module + href: https://docs.python.org/3/library/zipimport.html#zipimport.zipimporter.load_module + name: load_module + uid: zipimport.zipimporter.load_module +- fullName: zlib.Compress.compress + href: https://docs.python.org/3/library/zlib.html#zlib.Compress.compress + name: compress + uid: zlib.Compress.compress +- fullName: zlib.Compress.copy + href: https://docs.python.org/3/library/zlib.html#zlib.Compress.copy + name: copy + uid: zlib.Compress.copy +- fullName: zlib.Compress.flush + href: https://docs.python.org/3/library/zlib.html#zlib.Compress.flush + name: flush + uid: zlib.Compress.flush +- fullName: zlib.Decompress.copy + href: https://docs.python.org/3/library/zlib.html#zlib.Decompress.copy + name: copy + uid: zlib.Decompress.copy +- fullName: zlib.Decompress.decompress + href: https://docs.python.org/3/library/zlib.html#zlib.Decompress.decompress + name: decompress + uid: zlib.Decompress.decompress +- fullName: zlib.Decompress.flush + href: https://docs.python.org/3/library/zlib.html#zlib.Decompress.flush + name: flush + uid: zlib.Decompress.flush +- fullName: zoneinfo.ZoneInfo.clear_cache + href: https://docs.python.org/3/library/zoneinfo.html#zoneinfo.ZoneInfo.clear_cache + name: clear_cache + uid: zoneinfo.ZoneInfo.clear_cache +- fullName: zoneinfo.ZoneInfo.from_file + href: https://docs.python.org/3/library/zoneinfo.html#zoneinfo.ZoneInfo.from_file + name: from_file + uid: zoneinfo.ZoneInfo.from_file +- fullName: zoneinfo.ZoneInfo.no_cache + href: https://docs.python.org/3/library/zoneinfo.html#zoneinfo.ZoneInfo.no_cache + name: no_cache + uid: zoneinfo.ZoneInfo.no_cache +- fullName: Ellipsis + href: https://docs.python.org/3/library/constants.html#Ellipsis + name: Ellipsis + uid: Ellipsis +- fullName: 'False' + href: https://docs.python.org/3/library/constants.html#False + name: 'False' + uid: 'False' +- fullName: None + href: https://docs.python.org/3/library/constants.html#None + name: None + uid: None +- fullName: NotImplemented + href: https://docs.python.org/3/library/constants.html#NotImplemented + name: NotImplemented + uid: NotImplemented +- fullName: 'True' + href: https://docs.python.org/3/library/constants.html#True + name: 'True' + uid: 'True' +- fullName: __debug__ + href: https://docs.python.org/3/library/constants.html#debug__ + name: __debug__ + uid: __debug__ +- fullName: _thread.LockType + href: https://docs.python.org/3/library/_thread.html#thread.LockType + name: LockType + uid: _thread.LockType +- fullName: _thread.TIMEOUT_MAX + href: https://docs.python.org/3/library/_thread.html#thread.TIMEOUT_MAX + name: TIMEOUT_MAX + uid: _thread.TIMEOUT_MAX +- fullName: _tkinter.EXCEPTION + href: https://docs.python.org/3/library/tkinter.html#tkinter.EXCEPTION + name: EXCEPTION + uid: _tkinter.EXCEPTION +- fullName: _tkinter.READABLE + href: https://docs.python.org/3/library/tkinter.html#tkinter.READABLE + name: READABLE + uid: _tkinter.READABLE +- fullName: _tkinter.WRITABLE + href: https://docs.python.org/3/library/tkinter.html#tkinter.WRITABLE + name: WRITABLE + uid: _tkinter.WRITABLE +- fullName: array.typecodes + href: https://docs.python.org/3/library/array.html#array.typecodes + name: typecodes + uid: array.typecodes +- fullName: ast.PyCF_ALLOW_TOP_LEVEL_AWAIT + href: https://docs.python.org/3/library/ast.html#ast.PyCF_ALLOW_TOP_LEVEL_AWAIT + name: PyCF_ALLOW_TOP_LEVEL_AWAIT + uid: ast.PyCF_ALLOW_TOP_LEVEL_AWAIT +- fullName: ast.PyCF_ONLY_AST + href: https://docs.python.org/3/library/ast.html#ast.PyCF_ONLY_AST + name: PyCF_ONLY_AST + uid: ast.PyCF_ONLY_AST +- fullName: ast.PyCF_OPTIMIZED_AST + href: https://docs.python.org/3/library/ast.html#ast.PyCF_OPTIMIZED_AST + name: PyCF_OPTIMIZED_AST + uid: ast.PyCF_OPTIMIZED_AST +- fullName: ast.PyCF_TYPE_COMMENTS + href: https://docs.python.org/3/library/ast.html#ast.PyCF_TYPE_COMMENTS + name: PyCF_TYPE_COMMENTS + uid: ast.PyCF_TYPE_COMMENTS +- fullName: asyncio.ALL_COMPLETED + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.ALL_COMPLETED + name: ALL_COMPLETED + uid: asyncio.ALL_COMPLETED +- fullName: asyncio.FIRST_COMPLETED + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.FIRST_COMPLETED + name: FIRST_COMPLETED + uid: asyncio.FIRST_COMPLETED +- fullName: asyncio.FIRST_EXCEPTION + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.FIRST_EXCEPTION + name: FIRST_EXCEPTION + uid: asyncio.FIRST_EXCEPTION +- fullName: asyncio.subprocess.DEVNULL + href: https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.subprocess.DEVNULL + name: DEVNULL + uid: asyncio.subprocess.DEVNULL +- fullName: asyncio.subprocess.PIPE + href: https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.subprocess.PIPE + name: PIPE + uid: asyncio.subprocess.PIPE +- fullName: asyncio.subprocess.STDOUT + href: https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.subprocess.STDOUT + name: STDOUT + uid: asyncio.subprocess.STDOUT +- fullName: calendar.APRIL + href: https://docs.python.org/3/library/calendar.html#calendar.APRIL + name: APRIL + uid: calendar.APRIL +- fullName: calendar.AUGUST + href: https://docs.python.org/3/library/calendar.html#calendar.AUGUST + name: AUGUST + uid: calendar.AUGUST +- fullName: calendar.DECEMBER + href: https://docs.python.org/3/library/calendar.html#calendar.DECEMBER + name: DECEMBER + uid: calendar.DECEMBER +- fullName: calendar.FEBRUARY + href: https://docs.python.org/3/library/calendar.html#calendar.FEBRUARY + name: FEBRUARY + uid: calendar.FEBRUARY +- fullName: calendar.FRIDAY + href: https://docs.python.org/3/library/calendar.html#calendar.FRIDAY + name: FRIDAY + uid: calendar.FRIDAY +- fullName: calendar.JANUARY + href: https://docs.python.org/3/library/calendar.html#calendar.JANUARY + name: JANUARY + uid: calendar.JANUARY +- fullName: calendar.JULY + href: https://docs.python.org/3/library/calendar.html#calendar.JULY + name: JULY + uid: calendar.JULY +- fullName: calendar.JUNE + href: https://docs.python.org/3/library/calendar.html#calendar.JUNE + name: JUNE + uid: calendar.JUNE +- fullName: calendar.MARCH + href: https://docs.python.org/3/library/calendar.html#calendar.MARCH + name: MARCH + uid: calendar.MARCH +- fullName: calendar.MAY + href: https://docs.python.org/3/library/calendar.html#calendar.MAY + name: MAY + uid: calendar.MAY +- fullName: calendar.MONDAY + href: https://docs.python.org/3/library/calendar.html#calendar.MONDAY + name: MONDAY + uid: calendar.MONDAY +- fullName: calendar.NOVEMBER + href: https://docs.python.org/3/library/calendar.html#calendar.NOVEMBER + name: NOVEMBER + uid: calendar.NOVEMBER +- fullName: calendar.OCTOBER + href: https://docs.python.org/3/library/calendar.html#calendar.OCTOBER + name: OCTOBER + uid: calendar.OCTOBER +- fullName: calendar.SATURDAY + href: https://docs.python.org/3/library/calendar.html#calendar.SATURDAY + name: SATURDAY + uid: calendar.SATURDAY +- fullName: calendar.SEPTEMBER + href: https://docs.python.org/3/library/calendar.html#calendar.SEPTEMBER + name: SEPTEMBER + uid: calendar.SEPTEMBER +- fullName: calendar.SUNDAY + href: https://docs.python.org/3/library/calendar.html#calendar.SUNDAY + name: SUNDAY + uid: calendar.SUNDAY +- fullName: calendar.THURSDAY + href: https://docs.python.org/3/library/calendar.html#calendar.THURSDAY + name: THURSDAY + uid: calendar.THURSDAY +- fullName: calendar.TUESDAY + href: https://docs.python.org/3/library/calendar.html#calendar.TUESDAY + name: TUESDAY + uid: calendar.TUESDAY +- fullName: calendar.WEDNESDAY + href: https://docs.python.org/3/library/calendar.html#calendar.WEDNESDAY + name: WEDNESDAY + uid: calendar.WEDNESDAY +- fullName: calendar.day_abbr + href: https://docs.python.org/3/library/calendar.html#calendar.day_abbr + name: day_abbr + uid: calendar.day_abbr +- fullName: calendar.day_name + href: https://docs.python.org/3/library/calendar.html#calendar.day_name + name: day_name + uid: calendar.day_name +- fullName: calendar.month_abbr + href: https://docs.python.org/3/library/calendar.html#calendar.month_abbr + name: month_abbr + uid: calendar.month_abbr +- fullName: calendar.month_name + href: https://docs.python.org/3/library/calendar.html#calendar.month_name + name: month_name + uid: calendar.month_name +- fullName: cmath.e + href: https://docs.python.org/3/library/cmath.html#cmath.e + name: e + uid: cmath.e +- fullName: cmath.inf + href: https://docs.python.org/3/library/cmath.html#cmath.inf + name: inf + uid: cmath.inf +- fullName: cmath.infj + href: https://docs.python.org/3/library/cmath.html#cmath.infj + name: infj + uid: cmath.infj +- fullName: cmath.nan + href: https://docs.python.org/3/library/cmath.html#cmath.nan + name: nan + uid: cmath.nan +- fullName: cmath.nanj + href: https://docs.python.org/3/library/cmath.html#cmath.nanj + name: nanj + uid: cmath.nanj +- fullName: cmath.pi + href: https://docs.python.org/3/library/cmath.html#cmath.pi + name: pi + uid: cmath.pi +- fullName: cmath.tau + href: https://docs.python.org/3/library/cmath.html#cmath.tau + name: tau + uid: cmath.tau +- fullName: codecs.BOM + href: https://docs.python.org/3/library/codecs.html#codecs.BOM + name: BOM + uid: codecs.BOM +- fullName: codecs.BOM_BE + href: https://docs.python.org/3/library/codecs.html#codecs.BOM_BE + name: BOM_BE + uid: codecs.BOM_BE +- fullName: codecs.BOM_LE + href: https://docs.python.org/3/library/codecs.html#codecs.BOM_LE + name: BOM_LE + uid: codecs.BOM_LE +- fullName: codecs.BOM_UTF16 + href: https://docs.python.org/3/library/codecs.html#codecs.BOM_UTF16 + name: BOM_UTF16 + uid: codecs.BOM_UTF16 +- fullName: codecs.BOM_UTF16_BE + href: https://docs.python.org/3/library/codecs.html#codecs.BOM_UTF16_BE + name: BOM_UTF16_BE + uid: codecs.BOM_UTF16_BE +- fullName: codecs.BOM_UTF16_LE + href: https://docs.python.org/3/library/codecs.html#codecs.BOM_UTF16_LE + name: BOM_UTF16_LE + uid: codecs.BOM_UTF16_LE +- fullName: codecs.BOM_UTF32 + href: https://docs.python.org/3/library/codecs.html#codecs.BOM_UTF32 + name: BOM_UTF32 + uid: codecs.BOM_UTF32 +- fullName: codecs.BOM_UTF32_BE + href: https://docs.python.org/3/library/codecs.html#codecs.BOM_UTF32_BE + name: BOM_UTF32_BE + uid: codecs.BOM_UTF32_BE +- fullName: codecs.BOM_UTF32_LE + href: https://docs.python.org/3/library/codecs.html#codecs.BOM_UTF32_LE + name: BOM_UTF32_LE + uid: codecs.BOM_UTF32_LE +- fullName: codecs.BOM_UTF8 + href: https://docs.python.org/3/library/codecs.html#codecs.BOM_UTF8 + name: BOM_UTF8 + uid: codecs.BOM_UTF8 +- fullName: concurrent.futures.ALL_COMPLETED + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.ALL_COMPLETED + name: ALL_COMPLETED + uid: concurrent.futures.ALL_COMPLETED +- fullName: concurrent.futures.FIRST_COMPLETED + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.FIRST_COMPLETED + name: FIRST_COMPLETED + uid: concurrent.futures.FIRST_COMPLETED +- fullName: concurrent.futures.FIRST_EXCEPTION + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.FIRST_EXCEPTION + name: FIRST_EXCEPTION + uid: concurrent.futures.FIRST_EXCEPTION +- fullName: configparser.MAX_INTERPOLATION_DEPTH + href: https://docs.python.org/3/library/configparser.html#configparser.MAX_INTERPOLATION_DEPTH + name: MAX_INTERPOLATION_DEPTH + uid: configparser.MAX_INTERPOLATION_DEPTH +- fullName: configparser.UNNAMED_SECTION + href: https://docs.python.org/3/library/configparser.html#configparser.UNNAMED_SECTION + name: UNNAMED_SECTION + uid: configparser.UNNAMED_SECTION +- fullName: copyright + href: https://docs.python.org/3/library/constants.html#copyright + name: copyright + uid: copyright +- fullName: credits + href: https://docs.python.org/3/library/constants.html#credits + name: credits + uid: credits +- fullName: csv.QUOTE_ALL + href: https://docs.python.org/3/library/csv.html#csv.QUOTE_ALL + name: QUOTE_ALL + uid: csv.QUOTE_ALL +- fullName: csv.QUOTE_MINIMAL + href: https://docs.python.org/3/library/csv.html#csv.QUOTE_MINIMAL + name: QUOTE_MINIMAL + uid: csv.QUOTE_MINIMAL +- fullName: csv.QUOTE_NONE + href: https://docs.python.org/3/library/csv.html#csv.QUOTE_NONE + name: QUOTE_NONE + uid: csv.QUOTE_NONE +- fullName: csv.QUOTE_NONNUMERIC + href: https://docs.python.org/3/library/csv.html#csv.QUOTE_NONNUMERIC + name: QUOTE_NONNUMERIC + uid: csv.QUOTE_NONNUMERIC +- fullName: csv.QUOTE_NOTNULL + href: https://docs.python.org/3/library/csv.html#csv.QUOTE_NOTNULL + name: QUOTE_NOTNULL + uid: csv.QUOTE_NOTNULL +- fullName: csv.QUOTE_STRINGS + href: https://docs.python.org/3/library/csv.html#csv.QUOTE_STRINGS + name: QUOTE_STRINGS + uid: csv.QUOTE_STRINGS +- fullName: curses.ACS_BBSS + href: https://docs.python.org/3/library/curses.html#curses.ACS_BBSS + name: ACS_BBSS + uid: curses.ACS_BBSS +- fullName: curses.ACS_BLOCK + href: https://docs.python.org/3/library/curses.html#curses.ACS_BLOCK + name: ACS_BLOCK + uid: curses.ACS_BLOCK +- fullName: curses.ACS_BOARD + href: https://docs.python.org/3/library/curses.html#curses.ACS_BOARD + name: ACS_BOARD + uid: curses.ACS_BOARD +- fullName: curses.ACS_BSBS + href: https://docs.python.org/3/library/curses.html#curses.ACS_BSBS + name: ACS_BSBS + uid: curses.ACS_BSBS +- fullName: curses.ACS_BSSB + href: https://docs.python.org/3/library/curses.html#curses.ACS_BSSB + name: ACS_BSSB + uid: curses.ACS_BSSB +- fullName: curses.ACS_BSSS + href: https://docs.python.org/3/library/curses.html#curses.ACS_BSSS + name: ACS_BSSS + uid: curses.ACS_BSSS +- fullName: curses.ACS_BTEE + href: https://docs.python.org/3/library/curses.html#curses.ACS_BTEE + name: ACS_BTEE + uid: curses.ACS_BTEE +- fullName: curses.ACS_BULLET + href: https://docs.python.org/3/library/curses.html#curses.ACS_BULLET + name: ACS_BULLET + uid: curses.ACS_BULLET +- fullName: curses.ACS_CKBOARD + href: https://docs.python.org/3/library/curses.html#curses.ACS_CKBOARD + name: ACS_CKBOARD + uid: curses.ACS_CKBOARD +- fullName: curses.ACS_DARROW + href: https://docs.python.org/3/library/curses.html#curses.ACS_DARROW + name: ACS_DARROW + uid: curses.ACS_DARROW +- fullName: curses.ACS_DEGREE + href: https://docs.python.org/3/library/curses.html#curses.ACS_DEGREE + name: ACS_DEGREE + uid: curses.ACS_DEGREE +- fullName: curses.ACS_DIAMOND + href: https://docs.python.org/3/library/curses.html#curses.ACS_DIAMOND + name: ACS_DIAMOND + uid: curses.ACS_DIAMOND +- fullName: curses.ACS_GEQUAL + href: https://docs.python.org/3/library/curses.html#curses.ACS_GEQUAL + name: ACS_GEQUAL + uid: curses.ACS_GEQUAL +- fullName: curses.ACS_HLINE + href: https://docs.python.org/3/library/curses.html#curses.ACS_HLINE + name: ACS_HLINE + uid: curses.ACS_HLINE +- fullName: curses.ACS_LANTERN + href: https://docs.python.org/3/library/curses.html#curses.ACS_LANTERN + name: ACS_LANTERN + uid: curses.ACS_LANTERN +- fullName: curses.ACS_LARROW + href: https://docs.python.org/3/library/curses.html#curses.ACS_LARROW + name: ACS_LARROW + uid: curses.ACS_LARROW +- fullName: curses.ACS_LEQUAL + href: https://docs.python.org/3/library/curses.html#curses.ACS_LEQUAL + name: ACS_LEQUAL + uid: curses.ACS_LEQUAL +- fullName: curses.ACS_LLCORNER + href: https://docs.python.org/3/library/curses.html#curses.ACS_LLCORNER + name: ACS_LLCORNER + uid: curses.ACS_LLCORNER +- fullName: curses.ACS_LRCORNER + href: https://docs.python.org/3/library/curses.html#curses.ACS_LRCORNER + name: ACS_LRCORNER + uid: curses.ACS_LRCORNER +- fullName: curses.ACS_LTEE + href: https://docs.python.org/3/library/curses.html#curses.ACS_LTEE + name: ACS_LTEE + uid: curses.ACS_LTEE +- fullName: curses.ACS_NEQUAL + href: https://docs.python.org/3/library/curses.html#curses.ACS_NEQUAL + name: ACS_NEQUAL + uid: curses.ACS_NEQUAL +- fullName: curses.ACS_PI + href: https://docs.python.org/3/library/curses.html#curses.ACS_PI + name: ACS_PI + uid: curses.ACS_PI +- fullName: curses.ACS_PLMINUS + href: https://docs.python.org/3/library/curses.html#curses.ACS_PLMINUS + name: ACS_PLMINUS + uid: curses.ACS_PLMINUS +- fullName: curses.ACS_PLUS + href: https://docs.python.org/3/library/curses.html#curses.ACS_PLUS + name: ACS_PLUS + uid: curses.ACS_PLUS +- fullName: curses.ACS_RARROW + href: https://docs.python.org/3/library/curses.html#curses.ACS_RARROW + name: ACS_RARROW + uid: curses.ACS_RARROW +- fullName: curses.ACS_RTEE + href: https://docs.python.org/3/library/curses.html#curses.ACS_RTEE + name: ACS_RTEE + uid: curses.ACS_RTEE +- fullName: curses.ACS_S1 + href: https://docs.python.org/3/library/curses.html#curses.ACS_S1 + name: ACS_S1 + uid: curses.ACS_S1 +- fullName: curses.ACS_S3 + href: https://docs.python.org/3/library/curses.html#curses.ACS_S3 + name: ACS_S3 + uid: curses.ACS_S3 +- fullName: curses.ACS_S7 + href: https://docs.python.org/3/library/curses.html#curses.ACS_S7 + name: ACS_S7 + uid: curses.ACS_S7 +- fullName: curses.ACS_S9 + href: https://docs.python.org/3/library/curses.html#curses.ACS_S9 + name: ACS_S9 + uid: curses.ACS_S9 +- fullName: curses.ACS_SBBS + href: https://docs.python.org/3/library/curses.html#curses.ACS_SBBS + name: ACS_SBBS + uid: curses.ACS_SBBS +- fullName: curses.ACS_SBSB + href: https://docs.python.org/3/library/curses.html#curses.ACS_SBSB + name: ACS_SBSB + uid: curses.ACS_SBSB +- fullName: curses.ACS_SBSS + href: https://docs.python.org/3/library/curses.html#curses.ACS_SBSS + name: ACS_SBSS + uid: curses.ACS_SBSS +- fullName: curses.ACS_SSBB + href: https://docs.python.org/3/library/curses.html#curses.ACS_SSBB + name: ACS_SSBB + uid: curses.ACS_SSBB +- fullName: curses.ACS_SSBS + href: https://docs.python.org/3/library/curses.html#curses.ACS_SSBS + name: ACS_SSBS + uid: curses.ACS_SSBS +- fullName: curses.ACS_SSSB + href: https://docs.python.org/3/library/curses.html#curses.ACS_SSSB + name: ACS_SSSB + uid: curses.ACS_SSSB +- fullName: curses.ACS_SSSS + href: https://docs.python.org/3/library/curses.html#curses.ACS_SSSS + name: ACS_SSSS + uid: curses.ACS_SSSS +- fullName: curses.ACS_STERLING + href: https://docs.python.org/3/library/curses.html#curses.ACS_STERLING + name: ACS_STERLING + uid: curses.ACS_STERLING +- fullName: curses.ACS_TTEE + href: https://docs.python.org/3/library/curses.html#curses.ACS_TTEE + name: ACS_TTEE + uid: curses.ACS_TTEE +- fullName: curses.ACS_UARROW + href: https://docs.python.org/3/library/curses.html#curses.ACS_UARROW + name: ACS_UARROW + uid: curses.ACS_UARROW +- fullName: curses.ACS_ULCORNER + href: https://docs.python.org/3/library/curses.html#curses.ACS_ULCORNER + name: ACS_ULCORNER + uid: curses.ACS_ULCORNER +- fullName: curses.ACS_URCORNER + href: https://docs.python.org/3/library/curses.html#curses.ACS_URCORNER + name: ACS_URCORNER + uid: curses.ACS_URCORNER +- fullName: curses.ACS_VLINE + href: https://docs.python.org/3/library/curses.html#curses.ACS_VLINE + name: ACS_VLINE + uid: curses.ACS_VLINE +- fullName: curses.A_ALTCHARSET + href: https://docs.python.org/3/library/curses.html#curses.A_ALTCHARSET + name: A_ALTCHARSET + uid: curses.A_ALTCHARSET +- fullName: curses.A_ATTRIBUTES + href: https://docs.python.org/3/library/curses.html#curses.A_ATTRIBUTES + name: A_ATTRIBUTES + uid: curses.A_ATTRIBUTES +- fullName: curses.A_BLINK + href: https://docs.python.org/3/library/curses.html#curses.A_BLINK + name: A_BLINK + uid: curses.A_BLINK +- fullName: curses.A_BOLD + href: https://docs.python.org/3/library/curses.html#curses.A_BOLD + name: A_BOLD + uid: curses.A_BOLD +- fullName: curses.A_CHARTEXT + href: https://docs.python.org/3/library/curses.html#curses.A_CHARTEXT + name: A_CHARTEXT + uid: curses.A_CHARTEXT +- fullName: curses.A_COLOR + href: https://docs.python.org/3/library/curses.html#curses.A_COLOR + name: A_COLOR + uid: curses.A_COLOR +- fullName: curses.A_DIM + href: https://docs.python.org/3/library/curses.html#curses.A_DIM + name: A_DIM + uid: curses.A_DIM +- fullName: curses.A_HORIZONTAL + href: https://docs.python.org/3/library/curses.html#curses.A_HORIZONTAL + name: A_HORIZONTAL + uid: curses.A_HORIZONTAL +- fullName: curses.A_INVIS + href: https://docs.python.org/3/library/curses.html#curses.A_INVIS + name: A_INVIS + uid: curses.A_INVIS +- fullName: curses.A_ITALIC + href: https://docs.python.org/3/library/curses.html#curses.A_ITALIC + name: A_ITALIC + uid: curses.A_ITALIC +- fullName: curses.A_LEFT + href: https://docs.python.org/3/library/curses.html#curses.A_LEFT + name: A_LEFT + uid: curses.A_LEFT +- fullName: curses.A_LOW + href: https://docs.python.org/3/library/curses.html#curses.A_LOW + name: A_LOW + uid: curses.A_LOW +- fullName: curses.A_NORMAL + href: https://docs.python.org/3/library/curses.html#curses.A_NORMAL + name: A_NORMAL + uid: curses.A_NORMAL +- fullName: curses.A_PROTECT + href: https://docs.python.org/3/library/curses.html#curses.A_PROTECT + name: A_PROTECT + uid: curses.A_PROTECT +- fullName: curses.A_REVERSE + href: https://docs.python.org/3/library/curses.html#curses.A_REVERSE + name: A_REVERSE + uid: curses.A_REVERSE +- fullName: curses.A_RIGHT + href: https://docs.python.org/3/library/curses.html#curses.A_RIGHT + name: A_RIGHT + uid: curses.A_RIGHT +- fullName: curses.A_STANDOUT + href: https://docs.python.org/3/library/curses.html#curses.A_STANDOUT + name: A_STANDOUT + uid: curses.A_STANDOUT +- fullName: curses.A_TOP + href: https://docs.python.org/3/library/curses.html#curses.A_TOP + name: A_TOP + uid: curses.A_TOP +- fullName: curses.A_UNDERLINE + href: https://docs.python.org/3/library/curses.html#curses.A_UNDERLINE + name: A_UNDERLINE + uid: curses.A_UNDERLINE +- fullName: curses.A_VERTICAL + href: https://docs.python.org/3/library/curses.html#curses.A_VERTICAL + name: A_VERTICAL + uid: curses.A_VERTICAL +- fullName: curses.BUTTON_ALT + href: https://docs.python.org/3/library/curses.html#curses.BUTTON_ALT + name: BUTTON_ALT + uid: curses.BUTTON_ALT +- fullName: curses.BUTTON_CTRL + href: https://docs.python.org/3/library/curses.html#curses.BUTTON_CTRL + name: BUTTON_CTRL + uid: curses.BUTTON_CTRL +- fullName: curses.BUTTON_SHIFT + href: https://docs.python.org/3/library/curses.html#curses.BUTTON_SHIFT + name: BUTTON_SHIFT + uid: curses.BUTTON_SHIFT +- fullName: curses.BUTTONn_CLICKED + href: https://docs.python.org/3/library/curses.html#curses.BUTTONn_CLICKED + name: BUTTONn_CLICKED + uid: curses.BUTTONn_CLICKED +- fullName: curses.BUTTONn_DOUBLE_CLICKED + href: https://docs.python.org/3/library/curses.html#curses.BUTTONn_DOUBLE_CLICKED + name: BUTTONn_DOUBLE_CLICKED + uid: curses.BUTTONn_DOUBLE_CLICKED +- fullName: curses.BUTTONn_PRESSED + href: https://docs.python.org/3/library/curses.html#curses.BUTTONn_PRESSED + name: BUTTONn_PRESSED + uid: curses.BUTTONn_PRESSED +- fullName: curses.BUTTONn_RELEASED + href: https://docs.python.org/3/library/curses.html#curses.BUTTONn_RELEASED + name: BUTTONn_RELEASED + uid: curses.BUTTONn_RELEASED +- fullName: curses.BUTTONn_TRIPLE_CLICKED + href: https://docs.python.org/3/library/curses.html#curses.BUTTONn_TRIPLE_CLICKED + name: BUTTONn_TRIPLE_CLICKED + uid: curses.BUTTONn_TRIPLE_CLICKED +- fullName: curses.COLORS + href: https://docs.python.org/3/library/curses.html#curses.COLORS + name: COLORS + uid: curses.COLORS +- fullName: curses.COLOR_BLACK + href: https://docs.python.org/3/library/curses.html#curses.COLOR_BLACK + name: COLOR_BLACK + uid: curses.COLOR_BLACK +- fullName: curses.COLOR_BLUE + href: https://docs.python.org/3/library/curses.html#curses.COLOR_BLUE + name: COLOR_BLUE + uid: curses.COLOR_BLUE +- fullName: curses.COLOR_CYAN + href: https://docs.python.org/3/library/curses.html#curses.COLOR_CYAN + name: COLOR_CYAN + uid: curses.COLOR_CYAN +- fullName: curses.COLOR_GREEN + href: https://docs.python.org/3/library/curses.html#curses.COLOR_GREEN + name: COLOR_GREEN + uid: curses.COLOR_GREEN +- fullName: curses.COLOR_MAGENTA + href: https://docs.python.org/3/library/curses.html#curses.COLOR_MAGENTA + name: COLOR_MAGENTA + uid: curses.COLOR_MAGENTA +- fullName: curses.COLOR_PAIRS + href: https://docs.python.org/3/library/curses.html#curses.COLOR_PAIRS + name: COLOR_PAIRS + uid: curses.COLOR_PAIRS +- fullName: curses.COLOR_RED + href: https://docs.python.org/3/library/curses.html#curses.COLOR_RED + name: COLOR_RED + uid: curses.COLOR_RED +- fullName: curses.COLOR_WHITE + href: https://docs.python.org/3/library/curses.html#curses.COLOR_WHITE + name: COLOR_WHITE + uid: curses.COLOR_WHITE +- fullName: curses.COLOR_YELLOW + href: https://docs.python.org/3/library/curses.html#curses.COLOR_YELLOW + name: COLOR_YELLOW + uid: curses.COLOR_YELLOW +- fullName: curses.COLS + href: https://docs.python.org/3/library/curses.html#curses.COLS + name: COLS + uid: curses.COLS +- fullName: curses.ERR + href: https://docs.python.org/3/library/curses.html#curses.ERR + name: ERR + uid: curses.ERR +- fullName: curses.KEY_A1 + href: https://docs.python.org/3/library/curses.html#curses.KEY_A1 + name: KEY_A1 + uid: curses.KEY_A1 +- fullName: curses.KEY_A3 + href: https://docs.python.org/3/library/curses.html#curses.KEY_A3 + name: KEY_A3 + uid: curses.KEY_A3 +- fullName: curses.KEY_B2 + href: https://docs.python.org/3/library/curses.html#curses.KEY_B2 + name: KEY_B2 + uid: curses.KEY_B2 +- fullName: curses.KEY_BACKSPACE + href: https://docs.python.org/3/library/curses.html#curses.KEY_BACKSPACE + name: KEY_BACKSPACE + uid: curses.KEY_BACKSPACE +- fullName: curses.KEY_BEG + href: https://docs.python.org/3/library/curses.html#curses.KEY_BEG + name: KEY_BEG + uid: curses.KEY_BEG +- fullName: curses.KEY_BREAK + href: https://docs.python.org/3/library/curses.html#curses.KEY_BREAK + name: KEY_BREAK + uid: curses.KEY_BREAK +- fullName: curses.KEY_BTAB + href: https://docs.python.org/3/library/curses.html#curses.KEY_BTAB + name: KEY_BTAB + uid: curses.KEY_BTAB +- fullName: curses.KEY_C1 + href: https://docs.python.org/3/library/curses.html#curses.KEY_C1 + name: KEY_C1 + uid: curses.KEY_C1 +- fullName: curses.KEY_C3 + href: https://docs.python.org/3/library/curses.html#curses.KEY_C3 + name: KEY_C3 + uid: curses.KEY_C3 +- fullName: curses.KEY_CANCEL + href: https://docs.python.org/3/library/curses.html#curses.KEY_CANCEL + name: KEY_CANCEL + uid: curses.KEY_CANCEL +- fullName: curses.KEY_CATAB + href: https://docs.python.org/3/library/curses.html#curses.KEY_CATAB + name: KEY_CATAB + uid: curses.KEY_CATAB +- fullName: curses.KEY_CLEAR + href: https://docs.python.org/3/library/curses.html#curses.KEY_CLEAR + name: KEY_CLEAR + uid: curses.KEY_CLEAR +- fullName: curses.KEY_CLOSE + href: https://docs.python.org/3/library/curses.html#curses.KEY_CLOSE + name: KEY_CLOSE + uid: curses.KEY_CLOSE +- fullName: curses.KEY_COMMAND + href: https://docs.python.org/3/library/curses.html#curses.KEY_COMMAND + name: KEY_COMMAND + uid: curses.KEY_COMMAND +- fullName: curses.KEY_COPY + href: https://docs.python.org/3/library/curses.html#curses.KEY_COPY + name: KEY_COPY + uid: curses.KEY_COPY +- fullName: curses.KEY_CREATE + href: https://docs.python.org/3/library/curses.html#curses.KEY_CREATE + name: KEY_CREATE + uid: curses.KEY_CREATE +- fullName: curses.KEY_CTAB + href: https://docs.python.org/3/library/curses.html#curses.KEY_CTAB + name: KEY_CTAB + uid: curses.KEY_CTAB +- fullName: curses.KEY_DC + href: https://docs.python.org/3/library/curses.html#curses.KEY_DC + name: KEY_DC + uid: curses.KEY_DC +- fullName: curses.KEY_DL + href: https://docs.python.org/3/library/curses.html#curses.KEY_DL + name: KEY_DL + uid: curses.KEY_DL +- fullName: curses.KEY_DOWN + href: https://docs.python.org/3/library/curses.html#curses.KEY_DOWN + name: KEY_DOWN + uid: curses.KEY_DOWN +- fullName: curses.KEY_EIC + href: https://docs.python.org/3/library/curses.html#curses.KEY_EIC + name: KEY_EIC + uid: curses.KEY_EIC +- fullName: curses.KEY_END + href: https://docs.python.org/3/library/curses.html#curses.KEY_END + name: KEY_END + uid: curses.KEY_END +- fullName: curses.KEY_ENTER + href: https://docs.python.org/3/library/curses.html#curses.KEY_ENTER + name: KEY_ENTER + uid: curses.KEY_ENTER +- fullName: curses.KEY_EOL + href: https://docs.python.org/3/library/curses.html#curses.KEY_EOL + name: KEY_EOL + uid: curses.KEY_EOL +- fullName: curses.KEY_EOS + href: https://docs.python.org/3/library/curses.html#curses.KEY_EOS + name: KEY_EOS + uid: curses.KEY_EOS +- fullName: curses.KEY_EXIT + href: https://docs.python.org/3/library/curses.html#curses.KEY_EXIT + name: KEY_EXIT + uid: curses.KEY_EXIT +- fullName: curses.KEY_F0 + href: https://docs.python.org/3/library/curses.html#curses.KEY_F0 + name: KEY_F0 + uid: curses.KEY_F0 +- fullName: curses.KEY_FIND + href: https://docs.python.org/3/library/curses.html#curses.KEY_FIND + name: KEY_FIND + uid: curses.KEY_FIND +- fullName: curses.KEY_Fn + href: https://docs.python.org/3/library/curses.html#curses.KEY_Fn + name: KEY_Fn + uid: curses.KEY_Fn +- fullName: curses.KEY_HELP + href: https://docs.python.org/3/library/curses.html#curses.KEY_HELP + name: KEY_HELP + uid: curses.KEY_HELP +- fullName: curses.KEY_HOME + href: https://docs.python.org/3/library/curses.html#curses.KEY_HOME + name: KEY_HOME + uid: curses.KEY_HOME +- fullName: curses.KEY_IC + href: https://docs.python.org/3/library/curses.html#curses.KEY_IC + name: KEY_IC + uid: curses.KEY_IC +- fullName: curses.KEY_IL + href: https://docs.python.org/3/library/curses.html#curses.KEY_IL + name: KEY_IL + uid: curses.KEY_IL +- fullName: curses.KEY_LEFT + href: https://docs.python.org/3/library/curses.html#curses.KEY_LEFT + name: KEY_LEFT + uid: curses.KEY_LEFT +- fullName: curses.KEY_LL + href: https://docs.python.org/3/library/curses.html#curses.KEY_LL + name: KEY_LL + uid: curses.KEY_LL +- fullName: curses.KEY_MARK + href: https://docs.python.org/3/library/curses.html#curses.KEY_MARK + name: KEY_MARK + uid: curses.KEY_MARK +- fullName: curses.KEY_MAX + href: https://docs.python.org/3/library/curses.html#curses.KEY_MAX + name: KEY_MAX + uid: curses.KEY_MAX +- fullName: curses.KEY_MESSAGE + href: https://docs.python.org/3/library/curses.html#curses.KEY_MESSAGE + name: KEY_MESSAGE + uid: curses.KEY_MESSAGE +- fullName: curses.KEY_MIN + href: https://docs.python.org/3/library/curses.html#curses.KEY_MIN + name: KEY_MIN + uid: curses.KEY_MIN +- fullName: curses.KEY_MOUSE + href: https://docs.python.org/3/library/curses.html#curses.KEY_MOUSE + name: KEY_MOUSE + uid: curses.KEY_MOUSE +- fullName: curses.KEY_MOVE + href: https://docs.python.org/3/library/curses.html#curses.KEY_MOVE + name: KEY_MOVE + uid: curses.KEY_MOVE +- fullName: curses.KEY_NEXT + href: https://docs.python.org/3/library/curses.html#curses.KEY_NEXT + name: KEY_NEXT + uid: curses.KEY_NEXT +- fullName: curses.KEY_NPAGE + href: https://docs.python.org/3/library/curses.html#curses.KEY_NPAGE + name: KEY_NPAGE + uid: curses.KEY_NPAGE +- fullName: curses.KEY_OPEN + href: https://docs.python.org/3/library/curses.html#curses.KEY_OPEN + name: KEY_OPEN + uid: curses.KEY_OPEN +- fullName: curses.KEY_OPTIONS + href: https://docs.python.org/3/library/curses.html#curses.KEY_OPTIONS + name: KEY_OPTIONS + uid: curses.KEY_OPTIONS +- fullName: curses.KEY_PPAGE + href: https://docs.python.org/3/library/curses.html#curses.KEY_PPAGE + name: KEY_PPAGE + uid: curses.KEY_PPAGE +- fullName: curses.KEY_PREVIOUS + href: https://docs.python.org/3/library/curses.html#curses.KEY_PREVIOUS + name: KEY_PREVIOUS + uid: curses.KEY_PREVIOUS +- fullName: curses.KEY_PRINT + href: https://docs.python.org/3/library/curses.html#curses.KEY_PRINT + name: KEY_PRINT + uid: curses.KEY_PRINT +- fullName: curses.KEY_REDO + href: https://docs.python.org/3/library/curses.html#curses.KEY_REDO + name: KEY_REDO + uid: curses.KEY_REDO +- fullName: curses.KEY_REFERENCE + href: https://docs.python.org/3/library/curses.html#curses.KEY_REFERENCE + name: KEY_REFERENCE + uid: curses.KEY_REFERENCE +- fullName: curses.KEY_REFRESH + href: https://docs.python.org/3/library/curses.html#curses.KEY_REFRESH + name: KEY_REFRESH + uid: curses.KEY_REFRESH +- fullName: curses.KEY_REPLACE + href: https://docs.python.org/3/library/curses.html#curses.KEY_REPLACE + name: KEY_REPLACE + uid: curses.KEY_REPLACE +- fullName: curses.KEY_RESET + href: https://docs.python.org/3/library/curses.html#curses.KEY_RESET + name: KEY_RESET + uid: curses.KEY_RESET +- fullName: curses.KEY_RESIZE + href: https://docs.python.org/3/library/curses.html#curses.KEY_RESIZE + name: KEY_RESIZE + uid: curses.KEY_RESIZE +- fullName: curses.KEY_RESTART + href: https://docs.python.org/3/library/curses.html#curses.KEY_RESTART + name: KEY_RESTART + uid: curses.KEY_RESTART +- fullName: curses.KEY_RESUME + href: https://docs.python.org/3/library/curses.html#curses.KEY_RESUME + name: KEY_RESUME + uid: curses.KEY_RESUME +- fullName: curses.KEY_RIGHT + href: https://docs.python.org/3/library/curses.html#curses.KEY_RIGHT + name: KEY_RIGHT + uid: curses.KEY_RIGHT +- fullName: curses.KEY_SAVE + href: https://docs.python.org/3/library/curses.html#curses.KEY_SAVE + name: KEY_SAVE + uid: curses.KEY_SAVE +- fullName: curses.KEY_SBEG + href: https://docs.python.org/3/library/curses.html#curses.KEY_SBEG + name: KEY_SBEG + uid: curses.KEY_SBEG +- fullName: curses.KEY_SCANCEL + href: https://docs.python.org/3/library/curses.html#curses.KEY_SCANCEL + name: KEY_SCANCEL + uid: curses.KEY_SCANCEL +- fullName: curses.KEY_SCOMMAND + href: https://docs.python.org/3/library/curses.html#curses.KEY_SCOMMAND + name: KEY_SCOMMAND + uid: curses.KEY_SCOMMAND +- fullName: curses.KEY_SCOPY + href: https://docs.python.org/3/library/curses.html#curses.KEY_SCOPY + name: KEY_SCOPY + uid: curses.KEY_SCOPY +- fullName: curses.KEY_SCREATE + href: https://docs.python.org/3/library/curses.html#curses.KEY_SCREATE + name: KEY_SCREATE + uid: curses.KEY_SCREATE +- fullName: curses.KEY_SDC + href: https://docs.python.org/3/library/curses.html#curses.KEY_SDC + name: KEY_SDC + uid: curses.KEY_SDC +- fullName: curses.KEY_SDL + href: https://docs.python.org/3/library/curses.html#curses.KEY_SDL + name: KEY_SDL + uid: curses.KEY_SDL +- fullName: curses.KEY_SELECT + href: https://docs.python.org/3/library/curses.html#curses.KEY_SELECT + name: KEY_SELECT + uid: curses.KEY_SELECT +- fullName: curses.KEY_SEND + href: https://docs.python.org/3/library/curses.html#curses.KEY_SEND + name: KEY_SEND + uid: curses.KEY_SEND +- fullName: curses.KEY_SEOL + href: https://docs.python.org/3/library/curses.html#curses.KEY_SEOL + name: KEY_SEOL + uid: curses.KEY_SEOL +- fullName: curses.KEY_SEXIT + href: https://docs.python.org/3/library/curses.html#curses.KEY_SEXIT + name: KEY_SEXIT + uid: curses.KEY_SEXIT +- fullName: curses.KEY_SF + href: https://docs.python.org/3/library/curses.html#curses.KEY_SF + name: KEY_SF + uid: curses.KEY_SF +- fullName: curses.KEY_SFIND + href: https://docs.python.org/3/library/curses.html#curses.KEY_SFIND + name: KEY_SFIND + uid: curses.KEY_SFIND +- fullName: curses.KEY_SHELP + href: https://docs.python.org/3/library/curses.html#curses.KEY_SHELP + name: KEY_SHELP + uid: curses.KEY_SHELP +- fullName: curses.KEY_SHOME + href: https://docs.python.org/3/library/curses.html#curses.KEY_SHOME + name: KEY_SHOME + uid: curses.KEY_SHOME +- fullName: curses.KEY_SIC + href: https://docs.python.org/3/library/curses.html#curses.KEY_SIC + name: KEY_SIC + uid: curses.KEY_SIC +- fullName: curses.KEY_SLEFT + href: https://docs.python.org/3/library/curses.html#curses.KEY_SLEFT + name: KEY_SLEFT + uid: curses.KEY_SLEFT +- fullName: curses.KEY_SMESSAGE + href: https://docs.python.org/3/library/curses.html#curses.KEY_SMESSAGE + name: KEY_SMESSAGE + uid: curses.KEY_SMESSAGE +- fullName: curses.KEY_SMOVE + href: https://docs.python.org/3/library/curses.html#curses.KEY_SMOVE + name: KEY_SMOVE + uid: curses.KEY_SMOVE +- fullName: curses.KEY_SNEXT + href: https://docs.python.org/3/library/curses.html#curses.KEY_SNEXT + name: KEY_SNEXT + uid: curses.KEY_SNEXT +- fullName: curses.KEY_SOPTIONS + href: https://docs.python.org/3/library/curses.html#curses.KEY_SOPTIONS + name: KEY_SOPTIONS + uid: curses.KEY_SOPTIONS +- fullName: curses.KEY_SPREVIOUS + href: https://docs.python.org/3/library/curses.html#curses.KEY_SPREVIOUS + name: KEY_SPREVIOUS + uid: curses.KEY_SPREVIOUS +- fullName: curses.KEY_SPRINT + href: https://docs.python.org/3/library/curses.html#curses.KEY_SPRINT + name: KEY_SPRINT + uid: curses.KEY_SPRINT +- fullName: curses.KEY_SR + href: https://docs.python.org/3/library/curses.html#curses.KEY_SR + name: KEY_SR + uid: curses.KEY_SR +- fullName: curses.KEY_SREDO + href: https://docs.python.org/3/library/curses.html#curses.KEY_SREDO + name: KEY_SREDO + uid: curses.KEY_SREDO +- fullName: curses.KEY_SREPLACE + href: https://docs.python.org/3/library/curses.html#curses.KEY_SREPLACE + name: KEY_SREPLACE + uid: curses.KEY_SREPLACE +- fullName: curses.KEY_SRESET + href: https://docs.python.org/3/library/curses.html#curses.KEY_SRESET + name: KEY_SRESET + uid: curses.KEY_SRESET +- fullName: curses.KEY_SRIGHT + href: https://docs.python.org/3/library/curses.html#curses.KEY_SRIGHT + name: KEY_SRIGHT + uid: curses.KEY_SRIGHT +- fullName: curses.KEY_SRSUME + href: https://docs.python.org/3/library/curses.html#curses.KEY_SRSUME + name: KEY_SRSUME + uid: curses.KEY_SRSUME +- fullName: curses.KEY_SSAVE + href: https://docs.python.org/3/library/curses.html#curses.KEY_SSAVE + name: KEY_SSAVE + uid: curses.KEY_SSAVE +- fullName: curses.KEY_SSUSPEND + href: https://docs.python.org/3/library/curses.html#curses.KEY_SSUSPEND + name: KEY_SSUSPEND + uid: curses.KEY_SSUSPEND +- fullName: curses.KEY_STAB + href: https://docs.python.org/3/library/curses.html#curses.KEY_STAB + name: KEY_STAB + uid: curses.KEY_STAB +- fullName: curses.KEY_SUNDO + href: https://docs.python.org/3/library/curses.html#curses.KEY_SUNDO + name: KEY_SUNDO + uid: curses.KEY_SUNDO +- fullName: curses.KEY_SUSPEND + href: https://docs.python.org/3/library/curses.html#curses.KEY_SUSPEND + name: KEY_SUSPEND + uid: curses.KEY_SUSPEND +- fullName: curses.KEY_UNDO + href: https://docs.python.org/3/library/curses.html#curses.KEY_UNDO + name: KEY_UNDO + uid: curses.KEY_UNDO +- fullName: curses.KEY_UP + href: https://docs.python.org/3/library/curses.html#curses.KEY_UP + name: KEY_UP + uid: curses.KEY_UP +- fullName: curses.LINES + href: https://docs.python.org/3/library/curses.html#curses.LINES + name: LINES + uid: curses.LINES +- fullName: curses.OK + href: https://docs.python.org/3/library/curses.html#curses.OK + name: OK + uid: curses.OK +- fullName: curses.__version__ + href: https://docs.python.org/3/library/curses.html#curses.__version__ + name: __version__ + uid: curses.__version__ +- fullName: curses.ascii.ACK + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.ACK + name: ACK + uid: curses.ascii.ACK +- fullName: curses.ascii.BEL + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.BEL + name: BEL + uid: curses.ascii.BEL +- fullName: curses.ascii.BS + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.BS + name: BS + uid: curses.ascii.BS +- fullName: curses.ascii.CAN + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.CAN + name: CAN + uid: curses.ascii.CAN +- fullName: curses.ascii.CR + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.CR + name: CR + uid: curses.ascii.CR +- fullName: curses.ascii.DC1 + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.DC1 + name: DC1 + uid: curses.ascii.DC1 +- fullName: curses.ascii.DC2 + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.DC2 + name: DC2 + uid: curses.ascii.DC2 +- fullName: curses.ascii.DC3 + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.DC3 + name: DC3 + uid: curses.ascii.DC3 +- fullName: curses.ascii.DC4 + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.DC4 + name: DC4 + uid: curses.ascii.DC4 +- fullName: curses.ascii.DEL + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.DEL + name: DEL + uid: curses.ascii.DEL +- fullName: curses.ascii.DLE + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.DLE + name: DLE + uid: curses.ascii.DLE +- fullName: curses.ascii.EM + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.EM + name: EM + uid: curses.ascii.EM +- fullName: curses.ascii.ENQ + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.ENQ + name: ENQ + uid: curses.ascii.ENQ +- fullName: curses.ascii.EOT + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.EOT + name: EOT + uid: curses.ascii.EOT +- fullName: curses.ascii.ESC + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.ESC + name: ESC + uid: curses.ascii.ESC +- fullName: curses.ascii.ETB + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.ETB + name: ETB + uid: curses.ascii.ETB +- fullName: curses.ascii.ETX + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.ETX + name: ETX + uid: curses.ascii.ETX +- fullName: curses.ascii.FF + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.FF + name: FF + uid: curses.ascii.FF +- fullName: curses.ascii.FS + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.FS + name: FS + uid: curses.ascii.FS +- fullName: curses.ascii.GS + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.GS + name: GS + uid: curses.ascii.GS +- fullName: curses.ascii.HT + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.HT + name: HT + uid: curses.ascii.HT +- fullName: curses.ascii.LF + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.LF + name: LF + uid: curses.ascii.LF +- fullName: curses.ascii.NAK + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.NAK + name: NAK + uid: curses.ascii.NAK +- fullName: curses.ascii.NL + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.NL + name: NL + uid: curses.ascii.NL +- fullName: curses.ascii.NUL + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.NUL + name: NUL + uid: curses.ascii.NUL +- fullName: curses.ascii.RS + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.RS + name: RS + uid: curses.ascii.RS +- fullName: curses.ascii.SI + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.SI + name: SI + uid: curses.ascii.SI +- fullName: curses.ascii.SO + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.SO + name: SO + uid: curses.ascii.SO +- fullName: curses.ascii.SOH + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.SOH + name: SOH + uid: curses.ascii.SOH +- fullName: curses.ascii.SP + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.SP + name: SP + uid: curses.ascii.SP +- fullName: curses.ascii.STX + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.STX + name: STX + uid: curses.ascii.STX +- fullName: curses.ascii.SUB + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.SUB + name: SUB + uid: curses.ascii.SUB +- fullName: curses.ascii.SYN + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.SYN + name: SYN + uid: curses.ascii.SYN +- fullName: curses.ascii.TAB + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.TAB + name: TAB + uid: curses.ascii.TAB +- fullName: curses.ascii.US + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.US + name: US + uid: curses.ascii.US +- fullName: curses.ascii.VT + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.VT + name: VT + uid: curses.ascii.VT +- fullName: curses.ascii.controlnames + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.controlnames + name: controlnames + uid: curses.ascii.controlnames +- fullName: curses.ncurses_version + href: https://docs.python.org/3/library/curses.html#curses.ncurses_version + name: ncurses_version + uid: curses.ncurses_version +- fullName: curses.version + href: https://docs.python.org/3/library/curses.html#curses.version + name: version + uid: curses.version +- fullName: dataclasses.KW_ONLY + href: https://docs.python.org/3/library/dataclasses.html#dataclasses.KW_ONLY + name: KW_ONLY + uid: dataclasses.KW_ONLY +- fullName: dataclasses.MISSING + href: https://docs.python.org/3/library/dataclasses.html#dataclasses.MISSING + name: MISSING + uid: dataclasses.MISSING +- fullName: datetime.MAXYEAR + href: https://docs.python.org/3/library/datetime.html#datetime.MAXYEAR + name: MAXYEAR + uid: datetime.MAXYEAR +- fullName: datetime.MINYEAR + href: https://docs.python.org/3/library/datetime.html#datetime.MINYEAR + name: MINYEAR + uid: datetime.MINYEAR +- fullName: datetime.UTC + href: https://docs.python.org/3/library/datetime.html#datetime.UTC + name: UTC + uid: datetime.UTC +- fullName: dbm.gnu.open_flags + href: https://docs.python.org/3/library/dbm.html#dbm.gnu.open_flags + name: open_flags + uid: dbm.gnu.open_flags +- fullName: dbm.ndbm.library + href: https://docs.python.org/3/library/dbm.html#dbm.ndbm.library + name: library + uid: dbm.ndbm.library +- fullName: decimal.BasicContext + href: https://docs.python.org/3/library/decimal.html#decimal.BasicContext + name: BasicContext + uid: decimal.BasicContext +- fullName: decimal.DefaultContext + href: https://docs.python.org/3/library/decimal.html#decimal.DefaultContext + name: DefaultContext + uid: decimal.DefaultContext +- fullName: decimal.ExtendedContext + href: https://docs.python.org/3/library/decimal.html#decimal.ExtendedContext + name: ExtendedContext + uid: decimal.ExtendedContext +- fullName: decimal.HAVE_CONTEXTVAR + href: https://docs.python.org/3/library/decimal.html#decimal.HAVE_CONTEXTVAR + name: HAVE_CONTEXTVAR + uid: decimal.HAVE_CONTEXTVAR +- fullName: decimal.HAVE_THREADS + href: https://docs.python.org/3/library/decimal.html#decimal.HAVE_THREADS + name: HAVE_THREADS + uid: decimal.HAVE_THREADS +- fullName: decimal.MAX_EMAX + href: https://docs.python.org/3/library/decimal.html#decimal.MAX_EMAX + name: MAX_EMAX + uid: decimal.MAX_EMAX +- fullName: decimal.MAX_PREC + href: https://docs.python.org/3/library/decimal.html#decimal.MAX_PREC + name: MAX_PREC + uid: decimal.MAX_PREC +- fullName: decimal.MIN_EMIN + href: https://docs.python.org/3/library/decimal.html#decimal.MIN_EMIN + name: MIN_EMIN + uid: decimal.MIN_EMIN +- fullName: decimal.MIN_ETINY + href: https://docs.python.org/3/library/decimal.html#decimal.MIN_ETINY + name: MIN_ETINY + uid: decimal.MIN_ETINY +- fullName: decimal.ROUND_05UP + href: https://docs.python.org/3/library/decimal.html#decimal.ROUND_05UP + name: ROUND_05UP + uid: decimal.ROUND_05UP +- fullName: decimal.ROUND_CEILING + href: https://docs.python.org/3/library/decimal.html#decimal.ROUND_CEILING + name: ROUND_CEILING + uid: decimal.ROUND_CEILING +- fullName: decimal.ROUND_DOWN + href: https://docs.python.org/3/library/decimal.html#decimal.ROUND_DOWN + name: ROUND_DOWN + uid: decimal.ROUND_DOWN +- fullName: decimal.ROUND_FLOOR + href: https://docs.python.org/3/library/decimal.html#decimal.ROUND_FLOOR + name: ROUND_FLOOR + uid: decimal.ROUND_FLOOR +- fullName: decimal.ROUND_HALF_DOWN + href: https://docs.python.org/3/library/decimal.html#decimal.ROUND_HALF_DOWN + name: ROUND_HALF_DOWN + uid: decimal.ROUND_HALF_DOWN +- fullName: decimal.ROUND_HALF_EVEN + href: https://docs.python.org/3/library/decimal.html#decimal.ROUND_HALF_EVEN + name: ROUND_HALF_EVEN + uid: decimal.ROUND_HALF_EVEN +- fullName: decimal.ROUND_HALF_UP + href: https://docs.python.org/3/library/decimal.html#decimal.ROUND_HALF_UP + name: ROUND_HALF_UP + uid: decimal.ROUND_HALF_UP +- fullName: decimal.ROUND_UP + href: https://docs.python.org/3/library/decimal.html#decimal.ROUND_UP + name: ROUND_UP + uid: decimal.ROUND_UP +- fullName: dis.Bytecode.codeobj + href: https://docs.python.org/3/library/dis.html#dis.Bytecode.codeobj + name: codeobj + uid: dis.Bytecode.codeobj +- fullName: dis.Bytecode.first_line + href: https://docs.python.org/3/library/dis.html#dis.Bytecode.first_line + name: first_line + uid: dis.Bytecode.first_line +- fullName: dis.Instruction.arg + href: https://docs.python.org/3/library/dis.html#dis.Instruction.arg + name: arg + uid: dis.Instruction.arg +- fullName: dis.Instruction.argrepr + href: https://docs.python.org/3/library/dis.html#dis.Instruction.argrepr + name: argrepr + uid: dis.Instruction.argrepr +- fullName: dis.Instruction.argval + href: https://docs.python.org/3/library/dis.html#dis.Instruction.argval + name: argval + uid: dis.Instruction.argval +- fullName: dis.Instruction.baseopcode + href: https://docs.python.org/3/library/dis.html#dis.Instruction.baseopcode + name: baseopcode + uid: dis.Instruction.baseopcode +- fullName: dis.Instruction.baseopname + href: https://docs.python.org/3/library/dis.html#dis.Instruction.baseopname + name: baseopname + uid: dis.Instruction.baseopname +- fullName: dis.Instruction.cache_info + href: https://docs.python.org/3/library/dis.html#dis.Instruction.cache_info + name: cache_info + uid: dis.Instruction.cache_info +- fullName: dis.Instruction.cache_offset + href: https://docs.python.org/3/library/dis.html#dis.Instruction.cache_offset + name: cache_offset + uid: dis.Instruction.cache_offset +- fullName: dis.Instruction.end_offset + href: https://docs.python.org/3/library/dis.html#dis.Instruction.end_offset + name: end_offset + uid: dis.Instruction.end_offset +- fullName: dis.Instruction.is_jump_target + href: https://docs.python.org/3/library/dis.html#dis.Instruction.is_jump_target + name: is_jump_target + uid: dis.Instruction.is_jump_target +- fullName: dis.Instruction.jump_target + href: https://docs.python.org/3/library/dis.html#dis.Instruction.jump_target + name: jump_target + uid: dis.Instruction.jump_target +- fullName: dis.Instruction.line_number + href: https://docs.python.org/3/library/dis.html#dis.Instruction.line_number + name: line_number + uid: dis.Instruction.line_number +- fullName: dis.Instruction.offset + href: https://docs.python.org/3/library/dis.html#dis.Instruction.offset + name: offset + uid: dis.Instruction.offset +- fullName: dis.Instruction.oparg + href: https://docs.python.org/3/library/dis.html#dis.Instruction.oparg + name: oparg + uid: dis.Instruction.oparg +- fullName: dis.Instruction.opcode + href: https://docs.python.org/3/library/dis.html#dis.Instruction.opcode + name: opcode + uid: dis.Instruction.opcode +- fullName: dis.Instruction.opname + href: https://docs.python.org/3/library/dis.html#dis.Instruction.opname + name: opname + uid: dis.Instruction.opname +- fullName: dis.Instruction.positions + href: https://docs.python.org/3/library/dis.html#dis.Instruction.positions + name: positions + uid: dis.Instruction.positions +- fullName: dis.Instruction.start_offset + href: https://docs.python.org/3/library/dis.html#dis.Instruction.start_offset + name: start_offset + uid: dis.Instruction.start_offset +- fullName: dis.Instruction.starts_line + href: https://docs.python.org/3/library/dis.html#dis.Instruction.starts_line + name: starts_line + uid: dis.Instruction.starts_line +- fullName: dis.Positions.col_offset + href: https://docs.python.org/3/library/dis.html#dis.Positions.col_offset + name: col_offset + uid: dis.Positions.col_offset +- fullName: dis.Positions.end_col_offset + href: https://docs.python.org/3/library/dis.html#dis.Positions.end_col_offset + name: end_col_offset + uid: dis.Positions.end_col_offset +- fullName: dis.Positions.end_lineno + href: https://docs.python.org/3/library/dis.html#dis.Positions.end_lineno + name: end_lineno + uid: dis.Positions.end_lineno +- fullName: dis.Positions.lineno + href: https://docs.python.org/3/library/dis.html#dis.Positions.lineno + name: lineno + uid: dis.Positions.lineno +- fullName: dis.cmp_op + href: https://docs.python.org/3/library/dis.html#dis.cmp_op + name: cmp_op + uid: dis.cmp_op +- fullName: dis.hasarg + href: https://docs.python.org/3/library/dis.html#dis.hasarg + name: hasarg + uid: dis.hasarg +- fullName: dis.hascompare + href: https://docs.python.org/3/library/dis.html#dis.hascompare + name: hascompare + uid: dis.hascompare +- fullName: dis.hasconst + href: https://docs.python.org/3/library/dis.html#dis.hasconst + name: hasconst + uid: dis.hasconst +- fullName: dis.hasexc + href: https://docs.python.org/3/library/dis.html#dis.hasexc + name: hasexc + uid: dis.hasexc +- fullName: dis.hasfree + href: https://docs.python.org/3/library/dis.html#dis.hasfree + name: hasfree + uid: dis.hasfree +- fullName: dis.hasjabs + href: https://docs.python.org/3/library/dis.html#dis.hasjabs + name: hasjabs + uid: dis.hasjabs +- fullName: dis.hasjrel + href: https://docs.python.org/3/library/dis.html#dis.hasjrel + name: hasjrel + uid: dis.hasjrel +- fullName: dis.hasjump + href: https://docs.python.org/3/library/dis.html#dis.hasjump + name: hasjump + uid: dis.hasjump +- fullName: dis.haslocal + href: https://docs.python.org/3/library/dis.html#dis.haslocal + name: haslocal + uid: dis.haslocal +- fullName: dis.hasname + href: https://docs.python.org/3/library/dis.html#dis.hasname + name: hasname + uid: dis.hasname +- fullName: dis.opmap + href: https://docs.python.org/3/library/dis.html#dis.opmap + name: opmap + uid: dis.opmap +- fullName: dis.opname + href: https://docs.python.org/3/library/dis.html#dis.opname + name: opname + uid: dis.opname +- fullName: doctest.COMPARISON_FLAGS + href: https://docs.python.org/3/library/doctest.html#doctest.COMPARISON_FLAGS + name: COMPARISON_FLAGS + uid: doctest.COMPARISON_FLAGS +- fullName: doctest.DONT_ACCEPT_BLANKLINE + href: https://docs.python.org/3/library/doctest.html#doctest.DONT_ACCEPT_BLANKLINE + name: DONT_ACCEPT_BLANKLINE + uid: doctest.DONT_ACCEPT_BLANKLINE +- fullName: doctest.DONT_ACCEPT_TRUE_FOR_1 + href: https://docs.python.org/3/library/doctest.html#doctest.DONT_ACCEPT_TRUE_FOR_1 + name: DONT_ACCEPT_TRUE_FOR_1 + uid: doctest.DONT_ACCEPT_TRUE_FOR_1 +- fullName: doctest.ELLIPSIS + href: https://docs.python.org/3/library/doctest.html#doctest.ELLIPSIS + name: ELLIPSIS + uid: doctest.ELLIPSIS +- fullName: doctest.FAIL_FAST + href: https://docs.python.org/3/library/doctest.html#doctest.FAIL_FAST + name: FAIL_FAST + uid: doctest.FAIL_FAST +- fullName: doctest.IGNORE_EXCEPTION_DETAIL + href: https://docs.python.org/3/library/doctest.html#doctest.IGNORE_EXCEPTION_DETAIL + name: IGNORE_EXCEPTION_DETAIL + uid: doctest.IGNORE_EXCEPTION_DETAIL +- fullName: doctest.NORMALIZE_WHITESPACE + href: https://docs.python.org/3/library/doctest.html#doctest.NORMALIZE_WHITESPACE + name: NORMALIZE_WHITESPACE + uid: doctest.NORMALIZE_WHITESPACE +- fullName: doctest.REPORTING_FLAGS + href: https://docs.python.org/3/library/doctest.html#doctest.REPORTING_FLAGS + name: REPORTING_FLAGS + uid: doctest.REPORTING_FLAGS +- fullName: doctest.REPORT_CDIFF + href: https://docs.python.org/3/library/doctest.html#doctest.REPORT_CDIFF + name: REPORT_CDIFF + uid: doctest.REPORT_CDIFF +- fullName: doctest.REPORT_NDIFF + href: https://docs.python.org/3/library/doctest.html#doctest.REPORT_NDIFF + name: REPORT_NDIFF + uid: doctest.REPORT_NDIFF +- fullName: doctest.REPORT_ONLY_FIRST_FAILURE + href: https://docs.python.org/3/library/doctest.html#doctest.REPORT_ONLY_FIRST_FAILURE + name: REPORT_ONLY_FIRST_FAILURE + uid: doctest.REPORT_ONLY_FIRST_FAILURE +- fullName: doctest.REPORT_UDIFF + href: https://docs.python.org/3/library/doctest.html#doctest.REPORT_UDIFF + name: REPORT_UDIFF + uid: doctest.REPORT_UDIFF +- fullName: doctest.SKIP + href: https://docs.python.org/3/library/doctest.html#doctest.SKIP + name: SKIP + uid: doctest.SKIP +- fullName: email.contentmanager.raw_data_manager + href: https://docs.python.org/3/library/email.contentmanager.html#email.contentmanager.raw_data_manager + name: raw_data_manager + uid: email.contentmanager.raw_data_manager +- fullName: email.policy.HTTP + href: https://docs.python.org/3/library/email.policy.html#email.policy.HTTP + name: HTTP + uid: email.policy.HTTP +- fullName: email.policy.SMTP + href: https://docs.python.org/3/library/email.policy.html#email.policy.SMTP + name: SMTP + uid: email.policy.SMTP +- fullName: email.policy.SMTPUTF8 + href: https://docs.python.org/3/library/email.policy.html#email.policy.SMTPUTF8 + name: SMTPUTF8 + uid: email.policy.SMTPUTF8 +- fullName: email.policy.compat32 + href: https://docs.python.org/3/library/email.policy.html#email.policy.compat32 + name: compat32 + uid: email.policy.compat32 +- fullName: email.policy.default + href: https://docs.python.org/3/library/email.policy.html#email.policy.default + name: default + uid: email.policy.default +- fullName: email.policy.strict + href: https://docs.python.org/3/library/email.policy.html#email.policy.strict + name: strict + uid: email.policy.strict +- fullName: errno.E2BIG + href: https://docs.python.org/3/library/errno.html#errno.E2BIG + name: E2BIG + uid: errno.E2BIG +- fullName: errno.EACCES + href: https://docs.python.org/3/library/errno.html#errno.EACCES + name: EACCES + uid: errno.EACCES +- fullName: errno.EADDRINUSE + href: https://docs.python.org/3/library/errno.html#errno.EADDRINUSE + name: EADDRINUSE + uid: errno.EADDRINUSE +- fullName: errno.EADDRNOTAVAIL + href: https://docs.python.org/3/library/errno.html#errno.EADDRNOTAVAIL + name: EADDRNOTAVAIL + uid: errno.EADDRNOTAVAIL +- fullName: errno.EADV + href: https://docs.python.org/3/library/errno.html#errno.EADV + name: EADV + uid: errno.EADV +- fullName: errno.EAFNOSUPPORT + href: https://docs.python.org/3/library/errno.html#errno.EAFNOSUPPORT + name: EAFNOSUPPORT + uid: errno.EAFNOSUPPORT +- fullName: errno.EAGAIN + href: https://docs.python.org/3/library/errno.html#errno.EAGAIN + name: EAGAIN + uid: errno.EAGAIN +- fullName: errno.EALREADY + href: https://docs.python.org/3/library/errno.html#errno.EALREADY + name: EALREADY + uid: errno.EALREADY +- fullName: errno.EAUTH + href: https://docs.python.org/3/library/errno.html#errno.EAUTH + name: EAUTH + uid: errno.EAUTH +- fullName: errno.EBADARCH + href: https://docs.python.org/3/library/errno.html#errno.EBADARCH + name: EBADARCH + uid: errno.EBADARCH +- fullName: errno.EBADE + href: https://docs.python.org/3/library/errno.html#errno.EBADE + name: EBADE + uid: errno.EBADE +- fullName: errno.EBADEXEC + href: https://docs.python.org/3/library/errno.html#errno.EBADEXEC + name: EBADEXEC + uid: errno.EBADEXEC +- fullName: errno.EBADF + href: https://docs.python.org/3/library/errno.html#errno.EBADF + name: EBADF + uid: errno.EBADF +- fullName: errno.EBADFD + href: https://docs.python.org/3/library/errno.html#errno.EBADFD + name: EBADFD + uid: errno.EBADFD +- fullName: errno.EBADMACHO + href: https://docs.python.org/3/library/errno.html#errno.EBADMACHO + name: EBADMACHO + uid: errno.EBADMACHO +- fullName: errno.EBADMSG + href: https://docs.python.org/3/library/errno.html#errno.EBADMSG + name: EBADMSG + uid: errno.EBADMSG +- fullName: errno.EBADR + href: https://docs.python.org/3/library/errno.html#errno.EBADR + name: EBADR + uid: errno.EBADR +- fullName: errno.EBADRPC + href: https://docs.python.org/3/library/errno.html#errno.EBADRPC + name: EBADRPC + uid: errno.EBADRPC +- fullName: errno.EBADRQC + href: https://docs.python.org/3/library/errno.html#errno.EBADRQC + name: EBADRQC + uid: errno.EBADRQC +- fullName: errno.EBADSLT + href: https://docs.python.org/3/library/errno.html#errno.EBADSLT + name: EBADSLT + uid: errno.EBADSLT +- fullName: errno.EBFONT + href: https://docs.python.org/3/library/errno.html#errno.EBFONT + name: EBFONT + uid: errno.EBFONT +- fullName: errno.EBUSY + href: https://docs.python.org/3/library/errno.html#errno.EBUSY + name: EBUSY + uid: errno.EBUSY +- fullName: errno.ECANCELED + href: https://docs.python.org/3/library/errno.html#errno.ECANCELED + name: ECANCELED + uid: errno.ECANCELED +- fullName: errno.ECHILD + href: https://docs.python.org/3/library/errno.html#errno.ECHILD + name: ECHILD + uid: errno.ECHILD +- fullName: errno.ECHRNG + href: https://docs.python.org/3/library/errno.html#errno.ECHRNG + name: ECHRNG + uid: errno.ECHRNG +- fullName: errno.ECOMM + href: https://docs.python.org/3/library/errno.html#errno.ECOMM + name: ECOMM + uid: errno.ECOMM +- fullName: errno.ECONNABORTED + href: https://docs.python.org/3/library/errno.html#errno.ECONNABORTED + name: ECONNABORTED + uid: errno.ECONNABORTED +- fullName: errno.ECONNREFUSED + href: https://docs.python.org/3/library/errno.html#errno.ECONNREFUSED + name: ECONNREFUSED + uid: errno.ECONNREFUSED +- fullName: errno.ECONNRESET + href: https://docs.python.org/3/library/errno.html#errno.ECONNRESET + name: ECONNRESET + uid: errno.ECONNRESET +- fullName: errno.EDEADLK + href: https://docs.python.org/3/library/errno.html#errno.EDEADLK + name: EDEADLK + uid: errno.EDEADLK +- fullName: errno.EDEADLOCK + href: https://docs.python.org/3/library/errno.html#errno.EDEADLOCK + name: EDEADLOCK + uid: errno.EDEADLOCK +- fullName: errno.EDESTADDRREQ + href: https://docs.python.org/3/library/errno.html#errno.EDESTADDRREQ + name: EDESTADDRREQ + uid: errno.EDESTADDRREQ +- fullName: errno.EDEVERR + href: https://docs.python.org/3/library/errno.html#errno.EDEVERR + name: EDEVERR + uid: errno.EDEVERR +- fullName: errno.EDOM + href: https://docs.python.org/3/library/errno.html#errno.EDOM + name: EDOM + uid: errno.EDOM +- fullName: errno.EDOTDOT + href: https://docs.python.org/3/library/errno.html#errno.EDOTDOT + name: EDOTDOT + uid: errno.EDOTDOT +- fullName: errno.EDQUOT + href: https://docs.python.org/3/library/errno.html#errno.EDQUOT + name: EDQUOT + uid: errno.EDQUOT +- fullName: errno.EEXIST + href: https://docs.python.org/3/library/errno.html#errno.EEXIST + name: EEXIST + uid: errno.EEXIST +- fullName: errno.EFAULT + href: https://docs.python.org/3/library/errno.html#errno.EFAULT + name: EFAULT + uid: errno.EFAULT +- fullName: errno.EFBIG + href: https://docs.python.org/3/library/errno.html#errno.EFBIG + name: EFBIG + uid: errno.EFBIG +- fullName: errno.EFTYPE + href: https://docs.python.org/3/library/errno.html#errno.EFTYPE + name: EFTYPE + uid: errno.EFTYPE +- fullName: errno.EHOSTDOWN + href: https://docs.python.org/3/library/errno.html#errno.EHOSTDOWN + name: EHOSTDOWN + uid: errno.EHOSTDOWN +- fullName: errno.EHOSTUNREACH + href: https://docs.python.org/3/library/errno.html#errno.EHOSTUNREACH + name: EHOSTUNREACH + uid: errno.EHOSTUNREACH +- fullName: errno.EIDRM + href: https://docs.python.org/3/library/errno.html#errno.EIDRM + name: EIDRM + uid: errno.EIDRM +- fullName: errno.EILSEQ + href: https://docs.python.org/3/library/errno.html#errno.EILSEQ + name: EILSEQ + uid: errno.EILSEQ +- fullName: errno.EINPROGRESS + href: https://docs.python.org/3/library/errno.html#errno.EINPROGRESS + name: EINPROGRESS + uid: errno.EINPROGRESS +- fullName: errno.EINTR + href: https://docs.python.org/3/library/errno.html#errno.EINTR + name: EINTR + uid: errno.EINTR +- fullName: errno.EINVAL + href: https://docs.python.org/3/library/errno.html#errno.EINVAL + name: EINVAL + uid: errno.EINVAL +- fullName: errno.EIO + href: https://docs.python.org/3/library/errno.html#errno.EIO + name: EIO + uid: errno.EIO +- fullName: errno.EISCONN + href: https://docs.python.org/3/library/errno.html#errno.EISCONN + name: EISCONN + uid: errno.EISCONN +- fullName: errno.EISDIR + href: https://docs.python.org/3/library/errno.html#errno.EISDIR + name: EISDIR + uid: errno.EISDIR +- fullName: errno.EISNAM + href: https://docs.python.org/3/library/errno.html#errno.EISNAM + name: EISNAM + uid: errno.EISNAM +- fullName: errno.EKEYEXPIRED + href: https://docs.python.org/3/library/errno.html#errno.EKEYEXPIRED + name: EKEYEXPIRED + uid: errno.EKEYEXPIRED +- fullName: errno.EKEYREJECTED + href: https://docs.python.org/3/library/errno.html#errno.EKEYREJECTED + name: EKEYREJECTED + uid: errno.EKEYREJECTED +- fullName: errno.EKEYREVOKED + href: https://docs.python.org/3/library/errno.html#errno.EKEYREVOKED + name: EKEYREVOKED + uid: errno.EKEYREVOKED +- fullName: errno.EL2HLT + href: https://docs.python.org/3/library/errno.html#errno.EL2HLT + name: EL2HLT + uid: errno.EL2HLT +- fullName: errno.EL2NSYNC + href: https://docs.python.org/3/library/errno.html#errno.EL2NSYNC + name: EL2NSYNC + uid: errno.EL2NSYNC +- fullName: errno.EL3HLT + href: https://docs.python.org/3/library/errno.html#errno.EL3HLT + name: EL3HLT + uid: errno.EL3HLT +- fullName: errno.EL3RST + href: https://docs.python.org/3/library/errno.html#errno.EL3RST + name: EL3RST + uid: errno.EL3RST +- fullName: errno.ELIBACC + href: https://docs.python.org/3/library/errno.html#errno.ELIBACC + name: ELIBACC + uid: errno.ELIBACC +- fullName: errno.ELIBBAD + href: https://docs.python.org/3/library/errno.html#errno.ELIBBAD + name: ELIBBAD + uid: errno.ELIBBAD +- fullName: errno.ELIBEXEC + href: https://docs.python.org/3/library/errno.html#errno.ELIBEXEC + name: ELIBEXEC + uid: errno.ELIBEXEC +- fullName: errno.ELIBMAX + href: https://docs.python.org/3/library/errno.html#errno.ELIBMAX + name: ELIBMAX + uid: errno.ELIBMAX +- fullName: errno.ELIBSCN + href: https://docs.python.org/3/library/errno.html#errno.ELIBSCN + name: ELIBSCN + uid: errno.ELIBSCN +- fullName: errno.ELNRNG + href: https://docs.python.org/3/library/errno.html#errno.ELNRNG + name: ELNRNG + uid: errno.ELNRNG +- fullName: errno.ELOCKUNMAPPED + href: https://docs.python.org/3/library/errno.html#errno.ELOCKUNMAPPED + name: ELOCKUNMAPPED + uid: errno.ELOCKUNMAPPED +- fullName: errno.ELOOP + href: https://docs.python.org/3/library/errno.html#errno.ELOOP + name: ELOOP + uid: errno.ELOOP +- fullName: errno.EMEDIUMTYPE + href: https://docs.python.org/3/library/errno.html#errno.EMEDIUMTYPE + name: EMEDIUMTYPE + uid: errno.EMEDIUMTYPE +- fullName: errno.EMFILE + href: https://docs.python.org/3/library/errno.html#errno.EMFILE + name: EMFILE + uid: errno.EMFILE +- fullName: errno.EMLINK + href: https://docs.python.org/3/library/errno.html#errno.EMLINK + name: EMLINK + uid: errno.EMLINK +- fullName: errno.EMSGSIZE + href: https://docs.python.org/3/library/errno.html#errno.EMSGSIZE + name: EMSGSIZE + uid: errno.EMSGSIZE +- fullName: errno.EMULTIHOP + href: https://docs.python.org/3/library/errno.html#errno.EMULTIHOP + name: EMULTIHOP + uid: errno.EMULTIHOP +- fullName: errno.ENAMETOOLONG + href: https://docs.python.org/3/library/errno.html#errno.ENAMETOOLONG + name: ENAMETOOLONG + uid: errno.ENAMETOOLONG +- fullName: errno.ENAVAIL + href: https://docs.python.org/3/library/errno.html#errno.ENAVAIL + name: ENAVAIL + uid: errno.ENAVAIL +- fullName: errno.ENEEDAUTH + href: https://docs.python.org/3/library/errno.html#errno.ENEEDAUTH + name: ENEEDAUTH + uid: errno.ENEEDAUTH +- fullName: errno.ENETDOWN + href: https://docs.python.org/3/library/errno.html#errno.ENETDOWN + name: ENETDOWN + uid: errno.ENETDOWN +- fullName: errno.ENETRESET + href: https://docs.python.org/3/library/errno.html#errno.ENETRESET + name: ENETRESET + uid: errno.ENETRESET +- fullName: errno.ENETUNREACH + href: https://docs.python.org/3/library/errno.html#errno.ENETUNREACH + name: ENETUNREACH + uid: errno.ENETUNREACH +- fullName: errno.ENFILE + href: https://docs.python.org/3/library/errno.html#errno.ENFILE + name: ENFILE + uid: errno.ENFILE +- fullName: errno.ENOANO + href: https://docs.python.org/3/library/errno.html#errno.ENOANO + name: ENOANO + uid: errno.ENOANO +- fullName: errno.ENOATTR + href: https://docs.python.org/3/library/errno.html#errno.ENOATTR + name: ENOATTR + uid: errno.ENOATTR +- fullName: errno.ENOBUFS + href: https://docs.python.org/3/library/errno.html#errno.ENOBUFS + name: ENOBUFS + uid: errno.ENOBUFS +- fullName: errno.ENOCSI + href: https://docs.python.org/3/library/errno.html#errno.ENOCSI + name: ENOCSI + uid: errno.ENOCSI +- fullName: errno.ENODATA + href: https://docs.python.org/3/library/errno.html#errno.ENODATA + name: ENODATA + uid: errno.ENODATA +- fullName: errno.ENODEV + href: https://docs.python.org/3/library/errno.html#errno.ENODEV + name: ENODEV + uid: errno.ENODEV +- fullName: errno.ENOENT + href: https://docs.python.org/3/library/errno.html#errno.ENOENT + name: ENOENT + uid: errno.ENOENT +- fullName: errno.ENOEXEC + href: https://docs.python.org/3/library/errno.html#errno.ENOEXEC + name: ENOEXEC + uid: errno.ENOEXEC +- fullName: errno.ENOKEY + href: https://docs.python.org/3/library/errno.html#errno.ENOKEY + name: ENOKEY + uid: errno.ENOKEY +- fullName: errno.ENOLCK + href: https://docs.python.org/3/library/errno.html#errno.ENOLCK + name: ENOLCK + uid: errno.ENOLCK +- fullName: errno.ENOLINK + href: https://docs.python.org/3/library/errno.html#errno.ENOLINK + name: ENOLINK + uid: errno.ENOLINK +- fullName: errno.ENOMEDIUM + href: https://docs.python.org/3/library/errno.html#errno.ENOMEDIUM + name: ENOMEDIUM + uid: errno.ENOMEDIUM +- fullName: errno.ENOMEM + href: https://docs.python.org/3/library/errno.html#errno.ENOMEM + name: ENOMEM + uid: errno.ENOMEM +- fullName: errno.ENOMSG + href: https://docs.python.org/3/library/errno.html#errno.ENOMSG + name: ENOMSG + uid: errno.ENOMSG +- fullName: errno.ENONET + href: https://docs.python.org/3/library/errno.html#errno.ENONET + name: ENONET + uid: errno.ENONET +- fullName: errno.ENOPKG + href: https://docs.python.org/3/library/errno.html#errno.ENOPKG + name: ENOPKG + uid: errno.ENOPKG +- fullName: errno.ENOPOLICY + href: https://docs.python.org/3/library/errno.html#errno.ENOPOLICY + name: ENOPOLICY + uid: errno.ENOPOLICY +- fullName: errno.ENOPROTOOPT + href: https://docs.python.org/3/library/errno.html#errno.ENOPROTOOPT + name: ENOPROTOOPT + uid: errno.ENOPROTOOPT +- fullName: errno.ENOSPC + href: https://docs.python.org/3/library/errno.html#errno.ENOSPC + name: ENOSPC + uid: errno.ENOSPC +- fullName: errno.ENOSR + href: https://docs.python.org/3/library/errno.html#errno.ENOSR + name: ENOSR + uid: errno.ENOSR +- fullName: errno.ENOSTR + href: https://docs.python.org/3/library/errno.html#errno.ENOSTR + name: ENOSTR + uid: errno.ENOSTR +- fullName: errno.ENOSYS + href: https://docs.python.org/3/library/errno.html#errno.ENOSYS + name: ENOSYS + uid: errno.ENOSYS +- fullName: errno.ENOTACTIVE + href: https://docs.python.org/3/library/errno.html#errno.ENOTACTIVE + name: ENOTACTIVE + uid: errno.ENOTACTIVE +- fullName: errno.ENOTBLK + href: https://docs.python.org/3/library/errno.html#errno.ENOTBLK + name: ENOTBLK + uid: errno.ENOTBLK +- fullName: errno.ENOTCAPABLE + href: https://docs.python.org/3/library/errno.html#errno.ENOTCAPABLE + name: ENOTCAPABLE + uid: errno.ENOTCAPABLE +- fullName: errno.ENOTCONN + href: https://docs.python.org/3/library/errno.html#errno.ENOTCONN + name: ENOTCONN + uid: errno.ENOTCONN +- fullName: errno.ENOTDIR + href: https://docs.python.org/3/library/errno.html#errno.ENOTDIR + name: ENOTDIR + uid: errno.ENOTDIR +- fullName: errno.ENOTEMPTY + href: https://docs.python.org/3/library/errno.html#errno.ENOTEMPTY + name: ENOTEMPTY + uid: errno.ENOTEMPTY +- fullName: errno.ENOTNAM + href: https://docs.python.org/3/library/errno.html#errno.ENOTNAM + name: ENOTNAM + uid: errno.ENOTNAM +- fullName: errno.ENOTRECOVERABLE + href: https://docs.python.org/3/library/errno.html#errno.ENOTRECOVERABLE + name: ENOTRECOVERABLE + uid: errno.ENOTRECOVERABLE +- fullName: errno.ENOTSOCK + href: https://docs.python.org/3/library/errno.html#errno.ENOTSOCK + name: ENOTSOCK + uid: errno.ENOTSOCK +- fullName: errno.ENOTSUP + href: https://docs.python.org/3/library/errno.html#errno.ENOTSUP + name: ENOTSUP + uid: errno.ENOTSUP +- fullName: errno.ENOTTY + href: https://docs.python.org/3/library/errno.html#errno.ENOTTY + name: ENOTTY + uid: errno.ENOTTY +- fullName: errno.ENOTUNIQ + href: https://docs.python.org/3/library/errno.html#errno.ENOTUNIQ + name: ENOTUNIQ + uid: errno.ENOTUNIQ +- fullName: errno.ENXIO + href: https://docs.python.org/3/library/errno.html#errno.ENXIO + name: ENXIO + uid: errno.ENXIO +- fullName: errno.EOPNOTSUPP + href: https://docs.python.org/3/library/errno.html#errno.EOPNOTSUPP + name: EOPNOTSUPP + uid: errno.EOPNOTSUPP +- fullName: errno.EOVERFLOW + href: https://docs.python.org/3/library/errno.html#errno.EOVERFLOW + name: EOVERFLOW + uid: errno.EOVERFLOW +- fullName: errno.EOWNERDEAD + href: https://docs.python.org/3/library/errno.html#errno.EOWNERDEAD + name: EOWNERDEAD + uid: errno.EOWNERDEAD +- fullName: errno.EPERM + href: https://docs.python.org/3/library/errno.html#errno.EPERM + name: EPERM + uid: errno.EPERM +- fullName: errno.EPFNOSUPPORT + href: https://docs.python.org/3/library/errno.html#errno.EPFNOSUPPORT + name: EPFNOSUPPORT + uid: errno.EPFNOSUPPORT +- fullName: errno.EPIPE + href: https://docs.python.org/3/library/errno.html#errno.EPIPE + name: EPIPE + uid: errno.EPIPE +- fullName: errno.EPROCLIM + href: https://docs.python.org/3/library/errno.html#errno.EPROCLIM + name: EPROCLIM + uid: errno.EPROCLIM +- fullName: errno.EPROCUNAVAIL + href: https://docs.python.org/3/library/errno.html#errno.EPROCUNAVAIL + name: EPROCUNAVAIL + uid: errno.EPROCUNAVAIL +- fullName: errno.EPROGMISMATCH + href: https://docs.python.org/3/library/errno.html#errno.EPROGMISMATCH + name: EPROGMISMATCH + uid: errno.EPROGMISMATCH +- fullName: errno.EPROGUNAVAIL + href: https://docs.python.org/3/library/errno.html#errno.EPROGUNAVAIL + name: EPROGUNAVAIL + uid: errno.EPROGUNAVAIL +- fullName: errno.EPROTO + href: https://docs.python.org/3/library/errno.html#errno.EPROTO + name: EPROTO + uid: errno.EPROTO +- fullName: errno.EPROTONOSUPPORT + href: https://docs.python.org/3/library/errno.html#errno.EPROTONOSUPPORT + name: EPROTONOSUPPORT + uid: errno.EPROTONOSUPPORT +- fullName: errno.EPROTOTYPE + href: https://docs.python.org/3/library/errno.html#errno.EPROTOTYPE + name: EPROTOTYPE + uid: errno.EPROTOTYPE +- fullName: errno.EPWROFF + href: https://docs.python.org/3/library/errno.html#errno.EPWROFF + name: EPWROFF + uid: errno.EPWROFF +- fullName: errno.EQFULL + href: https://docs.python.org/3/library/errno.html#errno.EQFULL + name: EQFULL + uid: errno.EQFULL +- fullName: errno.ERANGE + href: https://docs.python.org/3/library/errno.html#errno.ERANGE + name: ERANGE + uid: errno.ERANGE +- fullName: errno.EREMCHG + href: https://docs.python.org/3/library/errno.html#errno.EREMCHG + name: EREMCHG + uid: errno.EREMCHG +- fullName: errno.EREMOTE + href: https://docs.python.org/3/library/errno.html#errno.EREMOTE + name: EREMOTE + uid: errno.EREMOTE +- fullName: errno.EREMOTEIO + href: https://docs.python.org/3/library/errno.html#errno.EREMOTEIO + name: EREMOTEIO + uid: errno.EREMOTEIO +- fullName: errno.ERESTART + href: https://docs.python.org/3/library/errno.html#errno.ERESTART + name: ERESTART + uid: errno.ERESTART +- fullName: errno.ERFKILL + href: https://docs.python.org/3/library/errno.html#errno.ERFKILL + name: ERFKILL + uid: errno.ERFKILL +- fullName: errno.EROFS + href: https://docs.python.org/3/library/errno.html#errno.EROFS + name: EROFS + uid: errno.EROFS +- fullName: errno.ERPCMISMATCH + href: https://docs.python.org/3/library/errno.html#errno.ERPCMISMATCH + name: ERPCMISMATCH + uid: errno.ERPCMISMATCH +- fullName: errno.ESHLIBVERS + href: https://docs.python.org/3/library/errno.html#errno.ESHLIBVERS + name: ESHLIBVERS + uid: errno.ESHLIBVERS +- fullName: errno.ESHUTDOWN + href: https://docs.python.org/3/library/errno.html#errno.ESHUTDOWN + name: ESHUTDOWN + uid: errno.ESHUTDOWN +- fullName: errno.ESOCKTNOSUPPORT + href: https://docs.python.org/3/library/errno.html#errno.ESOCKTNOSUPPORT + name: ESOCKTNOSUPPORT + uid: errno.ESOCKTNOSUPPORT +- fullName: errno.ESPIPE + href: https://docs.python.org/3/library/errno.html#errno.ESPIPE + name: ESPIPE + uid: errno.ESPIPE +- fullName: errno.ESRCH + href: https://docs.python.org/3/library/errno.html#errno.ESRCH + name: ESRCH + uid: errno.ESRCH +- fullName: errno.ESRMNT + href: https://docs.python.org/3/library/errno.html#errno.ESRMNT + name: ESRMNT + uid: errno.ESRMNT +- fullName: errno.ESTALE + href: https://docs.python.org/3/library/errno.html#errno.ESTALE + name: ESTALE + uid: errno.ESTALE +- fullName: errno.ESTRPIPE + href: https://docs.python.org/3/library/errno.html#errno.ESTRPIPE + name: ESTRPIPE + uid: errno.ESTRPIPE +- fullName: errno.ETIME + href: https://docs.python.org/3/library/errno.html#errno.ETIME + name: ETIME + uid: errno.ETIME +- fullName: errno.ETIMEDOUT + href: https://docs.python.org/3/library/errno.html#errno.ETIMEDOUT + name: ETIMEDOUT + uid: errno.ETIMEDOUT +- fullName: errno.ETOOMANYREFS + href: https://docs.python.org/3/library/errno.html#errno.ETOOMANYREFS + name: ETOOMANYREFS + uid: errno.ETOOMANYREFS +- fullName: errno.ETXTBSY + href: https://docs.python.org/3/library/errno.html#errno.ETXTBSY + name: ETXTBSY + uid: errno.ETXTBSY +- fullName: errno.EUCLEAN + href: https://docs.python.org/3/library/errno.html#errno.EUCLEAN + name: EUCLEAN + uid: errno.EUCLEAN +- fullName: errno.EUNATCH + href: https://docs.python.org/3/library/errno.html#errno.EUNATCH + name: EUNATCH + uid: errno.EUNATCH +- fullName: errno.EUSERS + href: https://docs.python.org/3/library/errno.html#errno.EUSERS + name: EUSERS + uid: errno.EUSERS +- fullName: errno.EWOULDBLOCK + href: https://docs.python.org/3/library/errno.html#errno.EWOULDBLOCK + name: EWOULDBLOCK + uid: errno.EWOULDBLOCK +- fullName: errno.EXDEV + href: https://docs.python.org/3/library/errno.html#errno.EXDEV + name: EXDEV + uid: errno.EXDEV +- fullName: errno.EXFULL + href: https://docs.python.org/3/library/errno.html#errno.EXFULL + name: EXFULL + uid: errno.EXFULL +- fullName: errno.errorcode + href: https://docs.python.org/3/library/errno.html#errno.errorcode + name: errorcode + uid: errno.errorcode +- fullName: exit + href: https://docs.python.org/3/library/constants.html#exit + name: exit + uid: exit +- fullName: fcntl.LOCK_EX + href: https://docs.python.org/3/library/fcntl.html#fcntl.LOCK_EX + name: LOCK_EX + uid: fcntl.LOCK_EX +- fullName: fcntl.LOCK_NB + href: https://docs.python.org/3/library/fcntl.html#fcntl.LOCK_NB + name: LOCK_NB + uid: fcntl.LOCK_NB +- fullName: fcntl.LOCK_SH + href: https://docs.python.org/3/library/fcntl.html#fcntl.LOCK_SH + name: LOCK_SH + uid: fcntl.LOCK_SH +- fullName: fcntl.LOCK_UN + href: https://docs.python.org/3/library/fcntl.html#fcntl.LOCK_UN + name: LOCK_UN + uid: fcntl.LOCK_UN +- fullName: filecmp.DEFAULT_IGNORES + href: https://docs.python.org/3/library/filecmp.html#filecmp.DEFAULT_IGNORES + name: DEFAULT_IGNORES + uid: filecmp.DEFAULT_IGNORES +- fullName: ftplib.all_errors + href: https://docs.python.org/3/library/ftplib.html#ftplib.all_errors + name: all_errors + uid: ftplib.all_errors +- fullName: gc.DEBUG_COLLECTABLE + href: https://docs.python.org/3/library/gc.html#gc.DEBUG_COLLECTABLE + name: DEBUG_COLLECTABLE + uid: gc.DEBUG_COLLECTABLE +- fullName: gc.DEBUG_LEAK + href: https://docs.python.org/3/library/gc.html#gc.DEBUG_LEAK + name: DEBUG_LEAK + uid: gc.DEBUG_LEAK +- fullName: gc.DEBUG_SAVEALL + href: https://docs.python.org/3/library/gc.html#gc.DEBUG_SAVEALL + name: DEBUG_SAVEALL + uid: gc.DEBUG_SAVEALL +- fullName: gc.DEBUG_STATS + href: https://docs.python.org/3/library/gc.html#gc.DEBUG_STATS + name: DEBUG_STATS + uid: gc.DEBUG_STATS +- fullName: gc.DEBUG_UNCOLLECTABLE + href: https://docs.python.org/3/library/gc.html#gc.DEBUG_UNCOLLECTABLE + name: DEBUG_UNCOLLECTABLE + uid: gc.DEBUG_UNCOLLECTABLE +- fullName: gc.callbacks + href: https://docs.python.org/3/library/gc.html#gc.callbacks + name: callbacks + uid: gc.callbacks +- fullName: gc.garbage + href: https://docs.python.org/3/library/gc.html#gc.garbage + name: garbage + uid: gc.garbage +- fullName: hashlib.algorithms_available + href: https://docs.python.org/3/library/hashlib.html#hashlib.algorithms_available + name: algorithms_available + uid: hashlib.algorithms_available +- fullName: hashlib.algorithms_guaranteed + href: https://docs.python.org/3/library/hashlib.html#hashlib.algorithms_guaranteed + name: algorithms_guaranteed + uid: hashlib.algorithms_guaranteed +- fullName: hashlib.blake2b.MAX_DIGEST_SIZE + href: https://docs.python.org/3/library/hashlib.html#hashlib.blake2b.MAX_DIGEST_SIZE + name: MAX_DIGEST_SIZE + uid: hashlib.blake2b.MAX_DIGEST_SIZE +- fullName: hashlib.blake2b.MAX_KEY_SIZE + href: https://docs.python.org/3/library/hashlib.html#hashlib.blake2b.MAX_KEY_SIZE + name: MAX_KEY_SIZE + uid: hashlib.blake2b.MAX_KEY_SIZE +- fullName: hashlib.blake2b.PERSON_SIZE + href: https://docs.python.org/3/library/hashlib.html#hashlib.blake2b.PERSON_SIZE + name: PERSON_SIZE + uid: hashlib.blake2b.PERSON_SIZE +- fullName: hashlib.blake2b.SALT_SIZE + href: https://docs.python.org/3/library/hashlib.html#hashlib.blake2b.SALT_SIZE + name: SALT_SIZE + uid: hashlib.blake2b.SALT_SIZE +- fullName: hashlib.blake2s.MAX_DIGEST_SIZE + href: https://docs.python.org/3/library/hashlib.html#hashlib.blake2s.MAX_DIGEST_SIZE + name: MAX_DIGEST_SIZE + uid: hashlib.blake2s.MAX_DIGEST_SIZE +- fullName: hashlib.blake2s.MAX_KEY_SIZE + href: https://docs.python.org/3/library/hashlib.html#hashlib.blake2s.MAX_KEY_SIZE + name: MAX_KEY_SIZE + uid: hashlib.blake2s.MAX_KEY_SIZE +- fullName: hashlib.blake2s.PERSON_SIZE + href: https://docs.python.org/3/library/hashlib.html#hashlib.blake2s.PERSON_SIZE + name: PERSON_SIZE + uid: hashlib.blake2s.PERSON_SIZE +- fullName: hashlib.blake2s.SALT_SIZE + href: https://docs.python.org/3/library/hashlib.html#hashlib.blake2s.SALT_SIZE + name: SALT_SIZE + uid: hashlib.blake2s.SALT_SIZE +- fullName: hashlib.hash.block_size + href: https://docs.python.org/3/library/hashlib.html#hashlib.hash.block_size + name: block_size + uid: hashlib.hash.block_size +- fullName: hashlib.hash.digest_size + href: https://docs.python.org/3/library/hashlib.html#hashlib.hash.digest_size + name: digest_size + uid: hashlib.hash.digest_size +- fullName: html.entities.codepoint2name + href: https://docs.python.org/3/library/html.entities.html#html.entities.codepoint2name + name: codepoint2name + uid: html.entities.codepoint2name +- fullName: html.entities.entitydefs + href: https://docs.python.org/3/library/html.entities.html#html.entities.entitydefs + name: entitydefs + uid: html.entities.entitydefs +- fullName: html.entities.html5 + href: https://docs.python.org/3/library/html.entities.html#html.entities.html5 + name: html5 + uid: html.entities.html5 +- fullName: html.entities.name2codepoint + href: https://docs.python.org/3/library/html.entities.html#html.entities.name2codepoint + name: name2codepoint + uid: html.entities.name2codepoint +- fullName: http.client.HTTPS_PORT + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPS_PORT + name: HTTPS_PORT + uid: http.client.HTTPS_PORT +- fullName: http.client.HTTP_PORT + href: https://docs.python.org/3/library/http.client.html#http.client.HTTP_PORT + name: HTTP_PORT + uid: http.client.HTTP_PORT +- fullName: http.client.responses + href: https://docs.python.org/3/library/http.client.html#http.client.responses + name: responses + uid: http.client.responses +- fullName: importlib.machinery.BYTECODE_SUFFIXES + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.BYTECODE_SUFFIXES + name: BYTECODE_SUFFIXES + uid: importlib.machinery.BYTECODE_SUFFIXES +- fullName: importlib.machinery.DEBUG_BYTECODE_SUFFIXES + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.DEBUG_BYTECODE_SUFFIXES + name: DEBUG_BYTECODE_SUFFIXES + uid: importlib.machinery.DEBUG_BYTECODE_SUFFIXES +- fullName: importlib.machinery.EXTENSION_SUFFIXES + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.EXTENSION_SUFFIXES + name: EXTENSION_SUFFIXES + uid: importlib.machinery.EXTENSION_SUFFIXES +- fullName: importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES + name: OPTIMIZED_BYTECODE_SUFFIXES + uid: importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES +- fullName: importlib.machinery.SOURCE_SUFFIXES + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.SOURCE_SUFFIXES + name: SOURCE_SUFFIXES + uid: importlib.machinery.SOURCE_SUFFIXES +- fullName: importlib.util.MAGIC_NUMBER + href: https://docs.python.org/3/library/importlib.html#importlib.util.MAGIC_NUMBER + name: MAGIC_NUMBER + uid: importlib.util.MAGIC_NUMBER +- fullName: inspect.CO_ASYNC_GENERATOR + href: https://docs.python.org/3/library/inspect.html#inspect.CO_ASYNC_GENERATOR + name: CO_ASYNC_GENERATOR + uid: inspect.CO_ASYNC_GENERATOR +- fullName: inspect.CO_COROUTINE + href: https://docs.python.org/3/library/inspect.html#inspect.CO_COROUTINE + name: CO_COROUTINE + uid: inspect.CO_COROUTINE +- fullName: inspect.CO_GENERATOR + href: https://docs.python.org/3/library/inspect.html#inspect.CO_GENERATOR + name: CO_GENERATOR + uid: inspect.CO_GENERATOR +- fullName: inspect.CO_ITERABLE_COROUTINE + href: https://docs.python.org/3/library/inspect.html#inspect.CO_ITERABLE_COROUTINE + name: CO_ITERABLE_COROUTINE + uid: inspect.CO_ITERABLE_COROUTINE +- fullName: inspect.CO_NESTED + href: https://docs.python.org/3/library/inspect.html#inspect.CO_NESTED + name: CO_NESTED + uid: inspect.CO_NESTED +- fullName: inspect.CO_NEWLOCALS + href: https://docs.python.org/3/library/inspect.html#inspect.CO_NEWLOCALS + name: CO_NEWLOCALS + uid: inspect.CO_NEWLOCALS +- fullName: inspect.CO_OPTIMIZED + href: https://docs.python.org/3/library/inspect.html#inspect.CO_OPTIMIZED + name: CO_OPTIMIZED + uid: inspect.CO_OPTIMIZED +- fullName: inspect.CO_VARARGS + href: https://docs.python.org/3/library/inspect.html#inspect.CO_VARARGS + name: CO_VARARGS + uid: inspect.CO_VARARGS +- fullName: inspect.CO_VARKEYWORDS + href: https://docs.python.org/3/library/inspect.html#inspect.CO_VARKEYWORDS + name: CO_VARKEYWORDS + uid: inspect.CO_VARKEYWORDS +- fullName: io.DEFAULT_BUFFER_SIZE + href: https://docs.python.org/3/library/io.html#io.DEFAULT_BUFFER_SIZE + name: DEFAULT_BUFFER_SIZE + uid: io.DEFAULT_BUFFER_SIZE +- fullName: keyword.kwlist + href: https://docs.python.org/3/library/keyword.html#keyword.kwlist + name: kwlist + uid: keyword.kwlist +- fullName: keyword.softkwlist + href: https://docs.python.org/3/library/keyword.html#keyword.softkwlist + name: softkwlist + uid: keyword.softkwlist +- fullName: license + href: https://docs.python.org/3/library/constants.html#license + name: license + uid: license +- fullName: locale.ABDAY_1 + href: https://docs.python.org/3/library/locale.html#locale.ABDAY_1 + name: ABDAY_1 + uid: locale.ABDAY_1 +- fullName: locale.ABDAY_2 + href: https://docs.python.org/3/library/locale.html#locale.ABDAY_2 + name: ABDAY_2 + uid: locale.ABDAY_2 +- fullName: locale.ABDAY_3 + href: https://docs.python.org/3/library/locale.html#locale.ABDAY_3 + name: ABDAY_3 + uid: locale.ABDAY_3 +- fullName: locale.ABDAY_4 + href: https://docs.python.org/3/library/locale.html#locale.ABDAY_4 + name: ABDAY_4 + uid: locale.ABDAY_4 +- fullName: locale.ABDAY_5 + href: https://docs.python.org/3/library/locale.html#locale.ABDAY_5 + name: ABDAY_5 + uid: locale.ABDAY_5 +- fullName: locale.ABDAY_6 + href: https://docs.python.org/3/library/locale.html#locale.ABDAY_6 + name: ABDAY_6 + uid: locale.ABDAY_6 +- fullName: locale.ABDAY_7 + href: https://docs.python.org/3/library/locale.html#locale.ABDAY_7 + name: ABDAY_7 + uid: locale.ABDAY_7 +- fullName: locale.ABMON_1 + href: https://docs.python.org/3/library/locale.html#locale.ABMON_1 + name: ABMON_1 + uid: locale.ABMON_1 +- fullName: locale.ABMON_10 + href: https://docs.python.org/3/library/locale.html#locale.ABMON_10 + name: ABMON_10 + uid: locale.ABMON_10 +- fullName: locale.ABMON_11 + href: https://docs.python.org/3/library/locale.html#locale.ABMON_11 + name: ABMON_11 + uid: locale.ABMON_11 +- fullName: locale.ABMON_12 + href: https://docs.python.org/3/library/locale.html#locale.ABMON_12 + name: ABMON_12 + uid: locale.ABMON_12 +- fullName: locale.ABMON_2 + href: https://docs.python.org/3/library/locale.html#locale.ABMON_2 + name: ABMON_2 + uid: locale.ABMON_2 +- fullName: locale.ABMON_3 + href: https://docs.python.org/3/library/locale.html#locale.ABMON_3 + name: ABMON_3 + uid: locale.ABMON_3 +- fullName: locale.ABMON_4 + href: https://docs.python.org/3/library/locale.html#locale.ABMON_4 + name: ABMON_4 + uid: locale.ABMON_4 +- fullName: locale.ABMON_5 + href: https://docs.python.org/3/library/locale.html#locale.ABMON_5 + name: ABMON_5 + uid: locale.ABMON_5 +- fullName: locale.ABMON_6 + href: https://docs.python.org/3/library/locale.html#locale.ABMON_6 + name: ABMON_6 + uid: locale.ABMON_6 +- fullName: locale.ABMON_7 + href: https://docs.python.org/3/library/locale.html#locale.ABMON_7 + name: ABMON_7 + uid: locale.ABMON_7 +- fullName: locale.ABMON_8 + href: https://docs.python.org/3/library/locale.html#locale.ABMON_8 + name: ABMON_8 + uid: locale.ABMON_8 +- fullName: locale.ABMON_9 + href: https://docs.python.org/3/library/locale.html#locale.ABMON_9 + name: ABMON_9 + uid: locale.ABMON_9 +- fullName: locale.ALT_DIGITS + href: https://docs.python.org/3/library/locale.html#locale.ALT_DIGITS + name: ALT_DIGITS + uid: locale.ALT_DIGITS +- fullName: locale.CHAR_MAX + href: https://docs.python.org/3/library/locale.html#locale.CHAR_MAX + name: CHAR_MAX + uid: locale.CHAR_MAX +- fullName: locale.CODESET + href: https://docs.python.org/3/library/locale.html#locale.CODESET + name: CODESET + uid: locale.CODESET +- fullName: locale.CRNCYSTR + href: https://docs.python.org/3/library/locale.html#locale.CRNCYSTR + name: CRNCYSTR + uid: locale.CRNCYSTR +- fullName: locale.DAY_1 + href: https://docs.python.org/3/library/locale.html#locale.DAY_1 + name: DAY_1 + uid: locale.DAY_1 +- fullName: locale.DAY_2 + href: https://docs.python.org/3/library/locale.html#locale.DAY_2 + name: DAY_2 + uid: locale.DAY_2 +- fullName: locale.DAY_3 + href: https://docs.python.org/3/library/locale.html#locale.DAY_3 + name: DAY_3 + uid: locale.DAY_3 +- fullName: locale.DAY_4 + href: https://docs.python.org/3/library/locale.html#locale.DAY_4 + name: DAY_4 + uid: locale.DAY_4 +- fullName: locale.DAY_5 + href: https://docs.python.org/3/library/locale.html#locale.DAY_5 + name: DAY_5 + uid: locale.DAY_5 +- fullName: locale.DAY_6 + href: https://docs.python.org/3/library/locale.html#locale.DAY_6 + name: DAY_6 + uid: locale.DAY_6 +- fullName: locale.DAY_7 + href: https://docs.python.org/3/library/locale.html#locale.DAY_7 + name: DAY_7 + uid: locale.DAY_7 +- fullName: locale.D_FMT + href: https://docs.python.org/3/library/locale.html#locale.D_FMT + name: D_FMT + uid: locale.D_FMT +- fullName: locale.D_T_FMT + href: https://docs.python.org/3/library/locale.html#locale.D_T_FMT + name: D_T_FMT + uid: locale.D_T_FMT +- fullName: locale.ERA + href: https://docs.python.org/3/library/locale.html#locale.ERA + name: ERA + uid: locale.ERA +- fullName: locale.ERA_D_FMT + href: https://docs.python.org/3/library/locale.html#locale.ERA_D_FMT + name: ERA_D_FMT + uid: locale.ERA_D_FMT +- fullName: locale.ERA_D_T_FMT + href: https://docs.python.org/3/library/locale.html#locale.ERA_D_T_FMT + name: ERA_D_T_FMT + uid: locale.ERA_D_T_FMT +- fullName: locale.ERA_T_FMT + href: https://docs.python.org/3/library/locale.html#locale.ERA_T_FMT + name: ERA_T_FMT + uid: locale.ERA_T_FMT +- fullName: locale.LC_ALL + href: https://docs.python.org/3/library/locale.html#locale.LC_ALL + name: LC_ALL + uid: locale.LC_ALL +- fullName: locale.LC_COLLATE + href: https://docs.python.org/3/library/locale.html#locale.LC_COLLATE + name: LC_COLLATE + uid: locale.LC_COLLATE +- fullName: locale.LC_CTYPE + href: https://docs.python.org/3/library/locale.html#locale.LC_CTYPE + name: LC_CTYPE + uid: locale.LC_CTYPE +- fullName: locale.LC_MESSAGES + href: https://docs.python.org/3/library/locale.html#locale.LC_MESSAGES + name: LC_MESSAGES + uid: locale.LC_MESSAGES +- fullName: locale.LC_MONETARY + href: https://docs.python.org/3/library/locale.html#locale.LC_MONETARY + name: LC_MONETARY + uid: locale.LC_MONETARY +- fullName: locale.LC_NUMERIC + href: https://docs.python.org/3/library/locale.html#locale.LC_NUMERIC + name: LC_NUMERIC + uid: locale.LC_NUMERIC +- fullName: locale.LC_TIME + href: https://docs.python.org/3/library/locale.html#locale.LC_TIME + name: LC_TIME + uid: locale.LC_TIME +- fullName: locale.MON_1 + href: https://docs.python.org/3/library/locale.html#locale.MON_1 + name: MON_1 + uid: locale.MON_1 +- fullName: locale.MON_10 + href: https://docs.python.org/3/library/locale.html#locale.MON_10 + name: MON_10 + uid: locale.MON_10 +- fullName: locale.MON_11 + href: https://docs.python.org/3/library/locale.html#locale.MON_11 + name: MON_11 + uid: locale.MON_11 +- fullName: locale.MON_12 + href: https://docs.python.org/3/library/locale.html#locale.MON_12 + name: MON_12 + uid: locale.MON_12 +- fullName: locale.MON_2 + href: https://docs.python.org/3/library/locale.html#locale.MON_2 + name: MON_2 + uid: locale.MON_2 +- fullName: locale.MON_3 + href: https://docs.python.org/3/library/locale.html#locale.MON_3 + name: MON_3 + uid: locale.MON_3 +- fullName: locale.MON_4 + href: https://docs.python.org/3/library/locale.html#locale.MON_4 + name: MON_4 + uid: locale.MON_4 +- fullName: locale.MON_5 + href: https://docs.python.org/3/library/locale.html#locale.MON_5 + name: MON_5 + uid: locale.MON_5 +- fullName: locale.MON_6 + href: https://docs.python.org/3/library/locale.html#locale.MON_6 + name: MON_6 + uid: locale.MON_6 +- fullName: locale.MON_7 + href: https://docs.python.org/3/library/locale.html#locale.MON_7 + name: MON_7 + uid: locale.MON_7 +- fullName: locale.MON_8 + href: https://docs.python.org/3/library/locale.html#locale.MON_8 + name: MON_8 + uid: locale.MON_8 +- fullName: locale.MON_9 + href: https://docs.python.org/3/library/locale.html#locale.MON_9 + name: MON_9 + uid: locale.MON_9 +- fullName: locale.NOEXPR + href: https://docs.python.org/3/library/locale.html#locale.NOEXPR + name: NOEXPR + uid: locale.NOEXPR +- fullName: locale.RADIXCHAR + href: https://docs.python.org/3/library/locale.html#locale.RADIXCHAR + name: RADIXCHAR + uid: locale.RADIXCHAR +- fullName: locale.THOUSEP + href: https://docs.python.org/3/library/locale.html#locale.THOUSEP + name: THOUSEP + uid: locale.THOUSEP +- fullName: locale.T_FMT + href: https://docs.python.org/3/library/locale.html#locale.T_FMT + name: T_FMT + uid: locale.T_FMT +- fullName: locale.T_FMT_AMPM + href: https://docs.python.org/3/library/locale.html#locale.T_FMT_AMPM + name: T_FMT_AMPM + uid: locale.T_FMT_AMPM +- fullName: locale.YESEXPR + href: https://docs.python.org/3/library/locale.html#locale.YESEXPR + name: YESEXPR + uid: locale.YESEXPR +- fullName: logging.CRITICAL + href: https://docs.python.org/3/library/logging.html#logging.CRITICAL + name: CRITICAL + uid: logging.CRITICAL +- fullName: logging.DEBUG + href: https://docs.python.org/3/library/logging.html#logging.DEBUG + name: DEBUG + uid: logging.DEBUG +- fullName: logging.ERROR + href: https://docs.python.org/3/library/logging.html#logging.ERROR + name: ERROR + uid: logging.ERROR +- fullName: logging.INFO + href: https://docs.python.org/3/library/logging.html#logging.INFO + name: INFO + uid: logging.INFO +- fullName: logging.NOTSET + href: https://docs.python.org/3/library/logging.html#logging.NOTSET + name: NOTSET + uid: logging.NOTSET +- fullName: logging.WARNING + href: https://docs.python.org/3/library/logging.html#logging.WARNING + name: WARNING + uid: logging.WARNING +- fullName: logging.lastResort + href: https://docs.python.org/3/library/logging.html#logging.lastResort + name: lastResort + uid: logging.lastResort +- fullName: logging.raiseExceptions + href: https://docs.python.org/3/library/logging.html#logging.raiseExceptions + name: raiseExceptions + uid: logging.raiseExceptions +- fullName: marshal.version + href: https://docs.python.org/3/library/marshal.html#marshal.version + name: version + uid: marshal.version +- fullName: math.e + href: https://docs.python.org/3/library/math.html#math.e + name: e + uid: math.e +- fullName: math.inf + href: https://docs.python.org/3/library/math.html#math.inf + name: inf + uid: math.inf +- fullName: math.nan + href: https://docs.python.org/3/library/math.html#math.nan + name: nan + uid: math.nan +- fullName: math.pi + href: https://docs.python.org/3/library/math.html#math.pi + name: pi + uid: math.pi +- fullName: math.tau + href: https://docs.python.org/3/library/math.html#math.tau + name: tau + uid: math.tau +- fullName: mimetypes.common_types + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.common_types + name: common_types + uid: mimetypes.common_types +- fullName: mimetypes.encodings_map + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.encodings_map + name: encodings_map + uid: mimetypes.encodings_map +- fullName: mimetypes.inited + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.inited + name: inited + uid: mimetypes.inited +- fullName: mimetypes.knownfiles + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.knownfiles + name: knownfiles + uid: mimetypes.knownfiles +- fullName: mimetypes.suffix_map + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.suffix_map + name: suffix_map + uid: mimetypes.suffix_map +- fullName: mimetypes.types_map + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.types_map + name: types_map + uid: mimetypes.types_map +- fullName: mmap.MADV_AUTOSYNC + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_AUTOSYNC + name: MADV_AUTOSYNC + uid: mmap.MADV_AUTOSYNC +- fullName: mmap.MADV_CORE + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_CORE + name: MADV_CORE + uid: mmap.MADV_CORE +- fullName: mmap.MADV_DODUMP + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_DODUMP + name: MADV_DODUMP + uid: mmap.MADV_DODUMP +- fullName: mmap.MADV_DOFORK + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_DOFORK + name: MADV_DOFORK + uid: mmap.MADV_DOFORK +- fullName: mmap.MADV_DONTDUMP + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_DONTDUMP + name: MADV_DONTDUMP + uid: mmap.MADV_DONTDUMP +- fullName: mmap.MADV_DONTFORK + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_DONTFORK + name: MADV_DONTFORK + uid: mmap.MADV_DONTFORK +- fullName: mmap.MADV_DONTNEED + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_DONTNEED + name: MADV_DONTNEED + uid: mmap.MADV_DONTNEED +- fullName: mmap.MADV_FREE + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_FREE + name: MADV_FREE + uid: mmap.MADV_FREE +- fullName: mmap.MADV_FREE_REUSABLE + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_FREE_REUSABLE + name: MADV_FREE_REUSABLE + uid: mmap.MADV_FREE_REUSABLE +- fullName: mmap.MADV_FREE_REUSE + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_FREE_REUSE + name: MADV_FREE_REUSE + uid: mmap.MADV_FREE_REUSE +- fullName: mmap.MADV_HUGEPAGE + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_HUGEPAGE + name: MADV_HUGEPAGE + uid: mmap.MADV_HUGEPAGE +- fullName: mmap.MADV_HWPOISON + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_HWPOISON + name: MADV_HWPOISON + uid: mmap.MADV_HWPOISON +- fullName: mmap.MADV_MERGEABLE + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_MERGEABLE + name: MADV_MERGEABLE + uid: mmap.MADV_MERGEABLE +- fullName: mmap.MADV_NOCORE + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_NOCORE + name: MADV_NOCORE + uid: mmap.MADV_NOCORE +- fullName: mmap.MADV_NOHUGEPAGE + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_NOHUGEPAGE + name: MADV_NOHUGEPAGE + uid: mmap.MADV_NOHUGEPAGE +- fullName: mmap.MADV_NORMAL + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_NORMAL + name: MADV_NORMAL + uid: mmap.MADV_NORMAL +- fullName: mmap.MADV_NOSYNC + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_NOSYNC + name: MADV_NOSYNC + uid: mmap.MADV_NOSYNC +- fullName: mmap.MADV_PROTECT + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_PROTECT + name: MADV_PROTECT + uid: mmap.MADV_PROTECT +- fullName: mmap.MADV_RANDOM + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_RANDOM + name: MADV_RANDOM + uid: mmap.MADV_RANDOM +- fullName: mmap.MADV_REMOVE + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_REMOVE + name: MADV_REMOVE + uid: mmap.MADV_REMOVE +- fullName: mmap.MADV_SEQUENTIAL + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_SEQUENTIAL + name: MADV_SEQUENTIAL + uid: mmap.MADV_SEQUENTIAL +- fullName: mmap.MADV_SOFT_OFFLINE + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_SOFT_OFFLINE + name: MADV_SOFT_OFFLINE + uid: mmap.MADV_SOFT_OFFLINE +- fullName: mmap.MADV_UNMERGEABLE + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_UNMERGEABLE + name: MADV_UNMERGEABLE + uid: mmap.MADV_UNMERGEABLE +- fullName: mmap.MADV_WILLNEED + href: https://docs.python.org/3/library/mmap.html#mmap.MADV_WILLNEED + name: MADV_WILLNEED + uid: mmap.MADV_WILLNEED +- fullName: mmap.MAP_32BIT + href: https://docs.python.org/3/library/mmap.html#mmap.MAP_32BIT + name: MAP_32BIT + uid: mmap.MAP_32BIT +- fullName: mmap.MAP_ALIGNED_SUPER + href: https://docs.python.org/3/library/mmap.html#mmap.MAP_ALIGNED_SUPER + name: MAP_ALIGNED_SUPER + uid: mmap.MAP_ALIGNED_SUPER +- fullName: mmap.MAP_ANON + href: https://docs.python.org/3/library/mmap.html#mmap.MAP_ANON + name: MAP_ANON + uid: mmap.MAP_ANON +- fullName: mmap.MAP_ANONYMOUS + href: https://docs.python.org/3/library/mmap.html#mmap.MAP_ANONYMOUS + name: MAP_ANONYMOUS + uid: mmap.MAP_ANONYMOUS +- fullName: mmap.MAP_CONCEAL + href: https://docs.python.org/3/library/mmap.html#mmap.MAP_CONCEAL + name: MAP_CONCEAL + uid: mmap.MAP_CONCEAL +- fullName: mmap.MAP_DENYWRITE + href: https://docs.python.org/3/library/mmap.html#mmap.MAP_DENYWRITE + name: MAP_DENYWRITE + uid: mmap.MAP_DENYWRITE +- fullName: mmap.MAP_EXECUTABLE + href: https://docs.python.org/3/library/mmap.html#mmap.MAP_EXECUTABLE + name: MAP_EXECUTABLE + uid: mmap.MAP_EXECUTABLE +- fullName: mmap.MAP_HASSEMAPHORE + href: https://docs.python.org/3/library/mmap.html#mmap.MAP_HASSEMAPHORE + name: MAP_HASSEMAPHORE + uid: mmap.MAP_HASSEMAPHORE +- fullName: mmap.MAP_JIT + href: https://docs.python.org/3/library/mmap.html#mmap.MAP_JIT + name: MAP_JIT + uid: mmap.MAP_JIT +- fullName: mmap.MAP_NOCACHE + href: https://docs.python.org/3/library/mmap.html#mmap.MAP_NOCACHE + name: MAP_NOCACHE + uid: mmap.MAP_NOCACHE +- fullName: mmap.MAP_NOEXTEND + href: https://docs.python.org/3/library/mmap.html#mmap.MAP_NOEXTEND + name: MAP_NOEXTEND + uid: mmap.MAP_NOEXTEND +- fullName: mmap.MAP_NORESERVE + href: https://docs.python.org/3/library/mmap.html#mmap.MAP_NORESERVE + name: MAP_NORESERVE + uid: mmap.MAP_NORESERVE +- fullName: mmap.MAP_POPULATE + href: https://docs.python.org/3/library/mmap.html#mmap.MAP_POPULATE + name: MAP_POPULATE + uid: mmap.MAP_POPULATE +- fullName: mmap.MAP_PRIVATE + href: https://docs.python.org/3/library/mmap.html#mmap.MAP_PRIVATE + name: MAP_PRIVATE + uid: mmap.MAP_PRIVATE +- fullName: mmap.MAP_RESILIENT_CODESIGN + href: https://docs.python.org/3/library/mmap.html#mmap.MAP_RESILIENT_CODESIGN + name: MAP_RESILIENT_CODESIGN + uid: mmap.MAP_RESILIENT_CODESIGN +- fullName: mmap.MAP_RESILIENT_MEDIA + href: https://docs.python.org/3/library/mmap.html#mmap.MAP_RESILIENT_MEDIA + name: MAP_RESILIENT_MEDIA + uid: mmap.MAP_RESILIENT_MEDIA +- fullName: mmap.MAP_SHARED + href: https://docs.python.org/3/library/mmap.html#mmap.MAP_SHARED + name: MAP_SHARED + uid: mmap.MAP_SHARED +- fullName: mmap.MAP_STACK + href: https://docs.python.org/3/library/mmap.html#mmap.MAP_STACK + name: MAP_STACK + uid: mmap.MAP_STACK +- fullName: mmap.MAP_TPRO + href: https://docs.python.org/3/library/mmap.html#mmap.MAP_TPRO + name: MAP_TPRO + uid: mmap.MAP_TPRO +- fullName: mmap.MAP_TRANSLATED_ALLOW_EXECUTE + href: https://docs.python.org/3/library/mmap.html#mmap.MAP_TRANSLATED_ALLOW_EXECUTE + name: MAP_TRANSLATED_ALLOW_EXECUTE + uid: mmap.MAP_TRANSLATED_ALLOW_EXECUTE +- fullName: mmap.MAP_UNIX03 + href: https://docs.python.org/3/library/mmap.html#mmap.MAP_UNIX03 + name: MAP_UNIX03 + uid: mmap.MAP_UNIX03 +- fullName: msvcrt.CRTDBG_MODE_DEBUG + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.CRTDBG_MODE_DEBUG + name: CRTDBG_MODE_DEBUG + uid: msvcrt.CRTDBG_MODE_DEBUG +- fullName: msvcrt.CRTDBG_MODE_FILE + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.CRTDBG_MODE_FILE + name: CRTDBG_MODE_FILE + uid: msvcrt.CRTDBG_MODE_FILE +- fullName: msvcrt.CRTDBG_MODE_WNDW + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.CRTDBG_MODE_WNDW + name: CRTDBG_MODE_WNDW + uid: msvcrt.CRTDBG_MODE_WNDW +- fullName: msvcrt.CRTDBG_REPORT_MODE + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.CRTDBG_REPORT_MODE + name: CRTDBG_REPORT_MODE + uid: msvcrt.CRTDBG_REPORT_MODE +- fullName: msvcrt.CRT_ASSEMBLY_VERSION + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.CRT_ASSEMBLY_VERSION + name: CRT_ASSEMBLY_VERSION + uid: msvcrt.CRT_ASSEMBLY_VERSION +- fullName: msvcrt.CRT_ASSERT + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.CRT_ASSERT + name: CRT_ASSERT + uid: msvcrt.CRT_ASSERT +- fullName: msvcrt.CRT_ERROR + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.CRT_ERROR + name: CRT_ERROR + uid: msvcrt.CRT_ERROR +- fullName: msvcrt.CRT_WARN + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.CRT_WARN + name: CRT_WARN + uid: msvcrt.CRT_WARN +- fullName: msvcrt.LIBRARIES_ASSEMBLY_NAME_PREFIX + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.LIBRARIES_ASSEMBLY_NAME_PREFIX + name: LIBRARIES_ASSEMBLY_NAME_PREFIX + uid: msvcrt.LIBRARIES_ASSEMBLY_NAME_PREFIX +- fullName: msvcrt.LK_LOCK + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.LK_LOCK + name: LK_LOCK + uid: msvcrt.LK_LOCK +- fullName: msvcrt.LK_NBLCK + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.LK_NBLCK + name: LK_NBLCK + uid: msvcrt.LK_NBLCK +- fullName: msvcrt.LK_NBRLCK + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.LK_NBRLCK + name: LK_NBRLCK + uid: msvcrt.LK_NBRLCK +- fullName: msvcrt.LK_RLCK + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.LK_RLCK + name: LK_RLCK + uid: msvcrt.LK_RLCK +- fullName: msvcrt.LK_UNLCK + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.LK_UNLCK + name: LK_UNLCK + uid: msvcrt.LK_UNLCK +- fullName: msvcrt.OUT_TO_DEFAULT + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.OUT_TO_DEFAULT + name: OUT_TO_DEFAULT + uid: msvcrt.OUT_TO_DEFAULT +- fullName: msvcrt.OUT_TO_MSGBOX + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.OUT_TO_MSGBOX + name: OUT_TO_MSGBOX + uid: msvcrt.OUT_TO_MSGBOX +- fullName: msvcrt.OUT_TO_STDERR + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.OUT_TO_STDERR + name: OUT_TO_STDERR + uid: msvcrt.OUT_TO_STDERR +- fullName: msvcrt.REPORT_ERRMODE + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.REPORT_ERRMODE + name: REPORT_ERRMODE + uid: msvcrt.REPORT_ERRMODE +- fullName: msvcrt.VC_ASSEMBLY_PUBLICKEYTOKEN + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.VC_ASSEMBLY_PUBLICKEYTOKEN + name: VC_ASSEMBLY_PUBLICKEYTOKEN + uid: msvcrt.VC_ASSEMBLY_PUBLICKEYTOKEN +- fullName: object.__match_args__ + href: https://docs.python.org/3/reference/datamodel.html#object.__match_args__ + name: __match_args__ + uid: object.__match_args__ +- fullName: object.__slots__ + href: https://docs.python.org/3/reference/datamodel.html#object.__slots__ + name: __slots__ + uid: object.__slots__ +- fullName: os.CLD_CONTINUED + href: https://docs.python.org/3/library/os.html#os.CLD_CONTINUED + name: CLD_CONTINUED + uid: os.CLD_CONTINUED +- fullName: os.CLD_DUMPED + href: https://docs.python.org/3/library/os.html#os.CLD_DUMPED + name: CLD_DUMPED + uid: os.CLD_DUMPED +- fullName: os.CLD_EXITED + href: https://docs.python.org/3/library/os.html#os.CLD_EXITED + name: CLD_EXITED + uid: os.CLD_EXITED +- fullName: os.CLD_KILLED + href: https://docs.python.org/3/library/os.html#os.CLD_KILLED + name: CLD_KILLED + uid: os.CLD_KILLED +- fullName: os.CLD_STOPPED + href: https://docs.python.org/3/library/os.html#os.CLD_STOPPED + name: CLD_STOPPED + uid: os.CLD_STOPPED +- fullName: os.CLD_TRAPPED + href: https://docs.python.org/3/library/os.html#os.CLD_TRAPPED + name: CLD_TRAPPED + uid: os.CLD_TRAPPED +- fullName: os.CLONE_FILES + href: https://docs.python.org/3/library/os.html#os.CLONE_FILES + name: CLONE_FILES + uid: os.CLONE_FILES +- fullName: os.CLONE_FS + href: https://docs.python.org/3/library/os.html#os.CLONE_FS + name: CLONE_FS + uid: os.CLONE_FS +- fullName: os.CLONE_NEWCGROUP + href: https://docs.python.org/3/library/os.html#os.CLONE_NEWCGROUP + name: CLONE_NEWCGROUP + uid: os.CLONE_NEWCGROUP +- fullName: os.CLONE_NEWIPC + href: https://docs.python.org/3/library/os.html#os.CLONE_NEWIPC + name: CLONE_NEWIPC + uid: os.CLONE_NEWIPC +- fullName: os.CLONE_NEWNET + href: https://docs.python.org/3/library/os.html#os.CLONE_NEWNET + name: CLONE_NEWNET + uid: os.CLONE_NEWNET +- fullName: os.CLONE_NEWNS + href: https://docs.python.org/3/library/os.html#os.CLONE_NEWNS + name: CLONE_NEWNS + uid: os.CLONE_NEWNS +- fullName: os.CLONE_NEWPID + href: https://docs.python.org/3/library/os.html#os.CLONE_NEWPID + name: CLONE_NEWPID + uid: os.CLONE_NEWPID +- fullName: os.CLONE_NEWTIME + href: https://docs.python.org/3/library/os.html#os.CLONE_NEWTIME + name: CLONE_NEWTIME + uid: os.CLONE_NEWTIME +- fullName: os.CLONE_NEWUSER + href: https://docs.python.org/3/library/os.html#os.CLONE_NEWUSER + name: CLONE_NEWUSER + uid: os.CLONE_NEWUSER +- fullName: os.CLONE_NEWUTS + href: https://docs.python.org/3/library/os.html#os.CLONE_NEWUTS + name: CLONE_NEWUTS + uid: os.CLONE_NEWUTS +- fullName: os.CLONE_SIGHAND + href: https://docs.python.org/3/library/os.html#os.CLONE_SIGHAND + name: CLONE_SIGHAND + uid: os.CLONE_SIGHAND +- fullName: os.CLONE_SYSVSEM + href: https://docs.python.org/3/library/os.html#os.CLONE_SYSVSEM + name: CLONE_SYSVSEM + uid: os.CLONE_SYSVSEM +- fullName: os.CLONE_THREAD + href: https://docs.python.org/3/library/os.html#os.CLONE_THREAD + name: CLONE_THREAD + uid: os.CLONE_THREAD +- fullName: os.CLONE_VM + href: https://docs.python.org/3/library/os.html#os.CLONE_VM + name: CLONE_VM + uid: os.CLONE_VM +- fullName: os.EFD_CLOEXEC + href: https://docs.python.org/3/library/os.html#os.EFD_CLOEXEC + name: EFD_CLOEXEC + uid: os.EFD_CLOEXEC +- fullName: os.EFD_NONBLOCK + href: https://docs.python.org/3/library/os.html#os.EFD_NONBLOCK + name: EFD_NONBLOCK + uid: os.EFD_NONBLOCK +- fullName: os.EFD_SEMAPHORE + href: https://docs.python.org/3/library/os.html#os.EFD_SEMAPHORE + name: EFD_SEMAPHORE + uid: os.EFD_SEMAPHORE +- fullName: os.EX_CANTCREAT + href: https://docs.python.org/3/library/os.html#os.EX_CANTCREAT + name: EX_CANTCREAT + uid: os.EX_CANTCREAT +- fullName: os.EX_CONFIG + href: https://docs.python.org/3/library/os.html#os.EX_CONFIG + name: EX_CONFIG + uid: os.EX_CONFIG +- fullName: os.EX_DATAERR + href: https://docs.python.org/3/library/os.html#os.EX_DATAERR + name: EX_DATAERR + uid: os.EX_DATAERR +- fullName: os.EX_IOERR + href: https://docs.python.org/3/library/os.html#os.EX_IOERR + name: EX_IOERR + uid: os.EX_IOERR +- fullName: os.EX_NOHOST + href: https://docs.python.org/3/library/os.html#os.EX_NOHOST + name: EX_NOHOST + uid: os.EX_NOHOST +- fullName: os.EX_NOINPUT + href: https://docs.python.org/3/library/os.html#os.EX_NOINPUT + name: EX_NOINPUT + uid: os.EX_NOINPUT +- fullName: os.EX_NOPERM + href: https://docs.python.org/3/library/os.html#os.EX_NOPERM + name: EX_NOPERM + uid: os.EX_NOPERM +- fullName: os.EX_NOTFOUND + href: https://docs.python.org/3/library/os.html#os.EX_NOTFOUND + name: EX_NOTFOUND + uid: os.EX_NOTFOUND +- fullName: os.EX_NOUSER + href: https://docs.python.org/3/library/os.html#os.EX_NOUSER + name: EX_NOUSER + uid: os.EX_NOUSER +- fullName: os.EX_OK + href: https://docs.python.org/3/library/os.html#os.EX_OK + name: EX_OK + uid: os.EX_OK +- fullName: os.EX_OSERR + href: https://docs.python.org/3/library/os.html#os.EX_OSERR + name: EX_OSERR + uid: os.EX_OSERR +- fullName: os.EX_OSFILE + href: https://docs.python.org/3/library/os.html#os.EX_OSFILE + name: EX_OSFILE + uid: os.EX_OSFILE +- fullName: os.EX_PROTOCOL + href: https://docs.python.org/3/library/os.html#os.EX_PROTOCOL + name: EX_PROTOCOL + uid: os.EX_PROTOCOL +- fullName: os.EX_SOFTWARE + href: https://docs.python.org/3/library/os.html#os.EX_SOFTWARE + name: EX_SOFTWARE + uid: os.EX_SOFTWARE +- fullName: os.EX_TEMPFAIL + href: https://docs.python.org/3/library/os.html#os.EX_TEMPFAIL + name: EX_TEMPFAIL + uid: os.EX_TEMPFAIL +- fullName: os.EX_UNAVAILABLE + href: https://docs.python.org/3/library/os.html#os.EX_UNAVAILABLE + name: EX_UNAVAILABLE + uid: os.EX_UNAVAILABLE +- fullName: os.EX_USAGE + href: https://docs.python.org/3/library/os.html#os.EX_USAGE + name: EX_USAGE + uid: os.EX_USAGE +- fullName: os.F_LOCK + href: https://docs.python.org/3/library/os.html#os.F_LOCK + name: F_LOCK + uid: os.F_LOCK +- fullName: os.F_OK + href: https://docs.python.org/3/library/os.html#os.F_OK + name: F_OK + uid: os.F_OK +- fullName: os.F_TEST + href: https://docs.python.org/3/library/os.html#os.F_TEST + name: F_TEST + uid: os.F_TEST +- fullName: os.F_TLOCK + href: https://docs.python.org/3/library/os.html#os.F_TLOCK + name: F_TLOCK + uid: os.F_TLOCK +- fullName: os.F_ULOCK + href: https://docs.python.org/3/library/os.html#os.F_ULOCK + name: F_ULOCK + uid: os.F_ULOCK +- fullName: os.GRND_NONBLOCK + href: https://docs.python.org/3/library/os.html#os.GRND_NONBLOCK + name: GRND_NONBLOCK + uid: os.GRND_NONBLOCK +- fullName: os.GRND_RANDOM + href: https://docs.python.org/3/library/os.html#os.GRND_RANDOM + name: GRND_RANDOM + uid: os.GRND_RANDOM +- fullName: os.MFD_ALLOW_SEALING + href: https://docs.python.org/3/library/os.html#os.MFD_ALLOW_SEALING + name: MFD_ALLOW_SEALING + uid: os.MFD_ALLOW_SEALING +- fullName: os.MFD_CLOEXEC + href: https://docs.python.org/3/library/os.html#os.MFD_CLOEXEC + name: MFD_CLOEXEC + uid: os.MFD_CLOEXEC +- fullName: os.MFD_HUGETLB + href: https://docs.python.org/3/library/os.html#os.MFD_HUGETLB + name: MFD_HUGETLB + uid: os.MFD_HUGETLB +- fullName: os.MFD_HUGE_16GB + href: https://docs.python.org/3/library/os.html#os.MFD_HUGE_16GB + name: MFD_HUGE_16GB + uid: os.MFD_HUGE_16GB +- fullName: os.MFD_HUGE_16MB + href: https://docs.python.org/3/library/os.html#os.MFD_HUGE_16MB + name: MFD_HUGE_16MB + uid: os.MFD_HUGE_16MB +- fullName: os.MFD_HUGE_1GB + href: https://docs.python.org/3/library/os.html#os.MFD_HUGE_1GB + name: MFD_HUGE_1GB + uid: os.MFD_HUGE_1GB +- fullName: os.MFD_HUGE_1MB + href: https://docs.python.org/3/library/os.html#os.MFD_HUGE_1MB + name: MFD_HUGE_1MB + uid: os.MFD_HUGE_1MB +- fullName: os.MFD_HUGE_256MB + href: https://docs.python.org/3/library/os.html#os.MFD_HUGE_256MB + name: MFD_HUGE_256MB + uid: os.MFD_HUGE_256MB +- fullName: os.MFD_HUGE_2GB + href: https://docs.python.org/3/library/os.html#os.MFD_HUGE_2GB + name: MFD_HUGE_2GB + uid: os.MFD_HUGE_2GB +- fullName: os.MFD_HUGE_2MB + href: https://docs.python.org/3/library/os.html#os.MFD_HUGE_2MB + name: MFD_HUGE_2MB + uid: os.MFD_HUGE_2MB +- fullName: os.MFD_HUGE_32MB + href: https://docs.python.org/3/library/os.html#os.MFD_HUGE_32MB + name: MFD_HUGE_32MB + uid: os.MFD_HUGE_32MB +- fullName: os.MFD_HUGE_512KB + href: https://docs.python.org/3/library/os.html#os.MFD_HUGE_512KB + name: MFD_HUGE_512KB + uid: os.MFD_HUGE_512KB +- fullName: os.MFD_HUGE_512MB + href: https://docs.python.org/3/library/os.html#os.MFD_HUGE_512MB + name: MFD_HUGE_512MB + uid: os.MFD_HUGE_512MB +- fullName: os.MFD_HUGE_64KB + href: https://docs.python.org/3/library/os.html#os.MFD_HUGE_64KB + name: MFD_HUGE_64KB + uid: os.MFD_HUGE_64KB +- fullName: os.MFD_HUGE_8MB + href: https://docs.python.org/3/library/os.html#os.MFD_HUGE_8MB + name: MFD_HUGE_8MB + uid: os.MFD_HUGE_8MB +- fullName: os.MFD_HUGE_MASK + href: https://docs.python.org/3/library/os.html#os.MFD_HUGE_MASK + name: MFD_HUGE_MASK + uid: os.MFD_HUGE_MASK +- fullName: os.MFD_HUGE_SHIFT + href: https://docs.python.org/3/library/os.html#os.MFD_HUGE_SHIFT + name: MFD_HUGE_SHIFT + uid: os.MFD_HUGE_SHIFT +- fullName: os.O_APPEND + href: https://docs.python.org/3/library/os.html#os.O_APPEND + name: O_APPEND + uid: os.O_APPEND +- fullName: os.O_ASYNC + href: https://docs.python.org/3/library/os.html#os.O_ASYNC + name: O_ASYNC + uid: os.O_ASYNC +- fullName: os.O_BINARY + href: https://docs.python.org/3/library/os.html#os.O_BINARY + name: O_BINARY + uid: os.O_BINARY +- fullName: os.O_CLOEXEC + href: https://docs.python.org/3/library/os.html#os.O_CLOEXEC + name: O_CLOEXEC + uid: os.O_CLOEXEC +- fullName: os.O_CREAT + href: https://docs.python.org/3/library/os.html#os.O_CREAT + name: O_CREAT + uid: os.O_CREAT +- fullName: os.O_DIRECT + href: https://docs.python.org/3/library/os.html#os.O_DIRECT + name: O_DIRECT + uid: os.O_DIRECT +- fullName: os.O_DIRECTORY + href: https://docs.python.org/3/library/os.html#os.O_DIRECTORY + name: O_DIRECTORY + uid: os.O_DIRECTORY +- fullName: os.O_DSYNC + href: https://docs.python.org/3/library/os.html#os.O_DSYNC + name: O_DSYNC + uid: os.O_DSYNC +- fullName: os.O_EVTONLY + href: https://docs.python.org/3/library/os.html#os.O_EVTONLY + name: O_EVTONLY + uid: os.O_EVTONLY +- fullName: os.O_EXCL + href: https://docs.python.org/3/library/os.html#os.O_EXCL + name: O_EXCL + uid: os.O_EXCL +- fullName: os.O_EXLOCK + href: https://docs.python.org/3/library/os.html#os.O_EXLOCK + name: O_EXLOCK + uid: os.O_EXLOCK +- fullName: os.O_FSYNC + href: https://docs.python.org/3/library/os.html#os.O_FSYNC + name: O_FSYNC + uid: os.O_FSYNC +- fullName: os.O_NDELAY + href: https://docs.python.org/3/library/os.html#os.O_NDELAY + name: O_NDELAY + uid: os.O_NDELAY +- fullName: os.O_NOATIME + href: https://docs.python.org/3/library/os.html#os.O_NOATIME + name: O_NOATIME + uid: os.O_NOATIME +- fullName: os.O_NOCTTY + href: https://docs.python.org/3/library/os.html#os.O_NOCTTY + name: O_NOCTTY + uid: os.O_NOCTTY +- fullName: os.O_NOFOLLOW + href: https://docs.python.org/3/library/os.html#os.O_NOFOLLOW + name: O_NOFOLLOW + uid: os.O_NOFOLLOW +- fullName: os.O_NOFOLLOW_ANY + href: https://docs.python.org/3/library/os.html#os.O_NOFOLLOW_ANY + name: O_NOFOLLOW_ANY + uid: os.O_NOFOLLOW_ANY +- fullName: os.O_NOINHERIT + href: https://docs.python.org/3/library/os.html#os.O_NOINHERIT + name: O_NOINHERIT + uid: os.O_NOINHERIT +- fullName: os.O_NONBLOCK + href: https://docs.python.org/3/library/os.html#os.O_NONBLOCK + name: O_NONBLOCK + uid: os.O_NONBLOCK +- fullName: os.O_PATH + href: https://docs.python.org/3/library/os.html#os.O_PATH + name: O_PATH + uid: os.O_PATH +- fullName: os.O_RANDOM + href: https://docs.python.org/3/library/os.html#os.O_RANDOM + name: O_RANDOM + uid: os.O_RANDOM +- fullName: os.O_RDONLY + href: https://docs.python.org/3/library/os.html#os.O_RDONLY + name: O_RDONLY + uid: os.O_RDONLY +- fullName: os.O_RDWR + href: https://docs.python.org/3/library/os.html#os.O_RDWR + name: O_RDWR + uid: os.O_RDWR +- fullName: os.O_RSYNC + href: https://docs.python.org/3/library/os.html#os.O_RSYNC + name: O_RSYNC + uid: os.O_RSYNC +- fullName: os.O_SEQUENTIAL + href: https://docs.python.org/3/library/os.html#os.O_SEQUENTIAL + name: O_SEQUENTIAL + uid: os.O_SEQUENTIAL +- fullName: os.O_SHLOCK + href: https://docs.python.org/3/library/os.html#os.O_SHLOCK + name: O_SHLOCK + uid: os.O_SHLOCK +- fullName: os.O_SHORT_LIVED + href: https://docs.python.org/3/library/os.html#os.O_SHORT_LIVED + name: O_SHORT_LIVED + uid: os.O_SHORT_LIVED +- fullName: os.O_SYMLINK + href: https://docs.python.org/3/library/os.html#os.O_SYMLINK + name: O_SYMLINK + uid: os.O_SYMLINK +- fullName: os.O_SYNC + href: https://docs.python.org/3/library/os.html#os.O_SYNC + name: O_SYNC + uid: os.O_SYNC +- fullName: os.O_TEMPORARY + href: https://docs.python.org/3/library/os.html#os.O_TEMPORARY + name: O_TEMPORARY + uid: os.O_TEMPORARY +- fullName: os.O_TEXT + href: https://docs.python.org/3/library/os.html#os.O_TEXT + name: O_TEXT + uid: os.O_TEXT +- fullName: os.O_TMPFILE + href: https://docs.python.org/3/library/os.html#os.O_TMPFILE + name: O_TMPFILE + uid: os.O_TMPFILE +- fullName: os.O_TRUNC + href: https://docs.python.org/3/library/os.html#os.O_TRUNC + name: O_TRUNC + uid: os.O_TRUNC +- fullName: os.O_WRONLY + href: https://docs.python.org/3/library/os.html#os.O_WRONLY + name: O_WRONLY + uid: os.O_WRONLY +- fullName: os.PIDFD_NONBLOCK + href: https://docs.python.org/3/library/os.html#os.PIDFD_NONBLOCK + name: PIDFD_NONBLOCK + uid: os.PIDFD_NONBLOCK +- fullName: os.POSIX_FADV_DONTNEED + href: https://docs.python.org/3/library/os.html#os.POSIX_FADV_DONTNEED + name: POSIX_FADV_DONTNEED + uid: os.POSIX_FADV_DONTNEED +- fullName: os.POSIX_FADV_NOREUSE + href: https://docs.python.org/3/library/os.html#os.POSIX_FADV_NOREUSE + name: POSIX_FADV_NOREUSE + uid: os.POSIX_FADV_NOREUSE +- fullName: os.POSIX_FADV_NORMAL + href: https://docs.python.org/3/library/os.html#os.POSIX_FADV_NORMAL + name: POSIX_FADV_NORMAL + uid: os.POSIX_FADV_NORMAL +- fullName: os.POSIX_FADV_RANDOM + href: https://docs.python.org/3/library/os.html#os.POSIX_FADV_RANDOM + name: POSIX_FADV_RANDOM + uid: os.POSIX_FADV_RANDOM +- fullName: os.POSIX_FADV_SEQUENTIAL + href: https://docs.python.org/3/library/os.html#os.POSIX_FADV_SEQUENTIAL + name: POSIX_FADV_SEQUENTIAL + uid: os.POSIX_FADV_SEQUENTIAL +- fullName: os.POSIX_FADV_WILLNEED + href: https://docs.python.org/3/library/os.html#os.POSIX_FADV_WILLNEED + name: POSIX_FADV_WILLNEED + uid: os.POSIX_FADV_WILLNEED +- fullName: os.POSIX_SPAWN_CLOSE + href: https://docs.python.org/3/library/os.html#os.POSIX_SPAWN_CLOSE + name: POSIX_SPAWN_CLOSE + uid: os.POSIX_SPAWN_CLOSE +- fullName: os.POSIX_SPAWN_CLOSEFROM + href: https://docs.python.org/3/library/os.html#os.POSIX_SPAWN_CLOSEFROM + name: POSIX_SPAWN_CLOSEFROM + uid: os.POSIX_SPAWN_CLOSEFROM +- fullName: os.POSIX_SPAWN_DUP2 + href: https://docs.python.org/3/library/os.html#os.POSIX_SPAWN_DUP2 + name: POSIX_SPAWN_DUP2 + uid: os.POSIX_SPAWN_DUP2 +- fullName: os.POSIX_SPAWN_OPEN + href: https://docs.python.org/3/library/os.html#os.POSIX_SPAWN_OPEN + name: POSIX_SPAWN_OPEN + uid: os.POSIX_SPAWN_OPEN +- fullName: os.PRIO_DARWIN_BG + href: https://docs.python.org/3/library/os.html#os.PRIO_DARWIN_BG + name: PRIO_DARWIN_BG + uid: os.PRIO_DARWIN_BG +- fullName: os.PRIO_DARWIN_NONUI + href: https://docs.python.org/3/library/os.html#os.PRIO_DARWIN_NONUI + name: PRIO_DARWIN_NONUI + uid: os.PRIO_DARWIN_NONUI +- fullName: os.PRIO_DARWIN_PROCESS + href: https://docs.python.org/3/library/os.html#os.PRIO_DARWIN_PROCESS + name: PRIO_DARWIN_PROCESS + uid: os.PRIO_DARWIN_PROCESS +- fullName: os.PRIO_DARWIN_THREAD + href: https://docs.python.org/3/library/os.html#os.PRIO_DARWIN_THREAD + name: PRIO_DARWIN_THREAD + uid: os.PRIO_DARWIN_THREAD +- fullName: os.PRIO_PGRP + href: https://docs.python.org/3/library/os.html#os.PRIO_PGRP + name: PRIO_PGRP + uid: os.PRIO_PGRP +- fullName: os.PRIO_PROCESS + href: https://docs.python.org/3/library/os.html#os.PRIO_PROCESS + name: PRIO_PROCESS + uid: os.PRIO_PROCESS +- fullName: os.PRIO_USER + href: https://docs.python.org/3/library/os.html#os.PRIO_USER + name: PRIO_USER + uid: os.PRIO_USER +- fullName: os.P_ALL + href: https://docs.python.org/3/library/os.html#os.P_ALL + name: P_ALL + uid: os.P_ALL +- fullName: os.P_DETACH + href: https://docs.python.org/3/library/os.html#os.P_DETACH + name: P_DETACH + uid: os.P_DETACH +- fullName: os.P_NOWAIT + href: https://docs.python.org/3/library/os.html#os.P_NOWAIT + name: P_NOWAIT + uid: os.P_NOWAIT +- fullName: os.P_NOWAITO + href: https://docs.python.org/3/library/os.html#os.P_NOWAITO + name: P_NOWAITO + uid: os.P_NOWAITO +- fullName: os.P_OVERLAY + href: https://docs.python.org/3/library/os.html#os.P_OVERLAY + name: P_OVERLAY + uid: os.P_OVERLAY +- fullName: os.P_PGID + href: https://docs.python.org/3/library/os.html#os.P_PGID + name: P_PGID + uid: os.P_PGID +- fullName: os.P_PID + href: https://docs.python.org/3/library/os.html#os.P_PID + name: P_PID + uid: os.P_PID +- fullName: os.P_PIDFD + href: https://docs.python.org/3/library/os.html#os.P_PIDFD + name: P_PIDFD + uid: os.P_PIDFD +- fullName: os.P_WAIT + href: https://docs.python.org/3/library/os.html#os.P_WAIT + name: P_WAIT + uid: os.P_WAIT +- fullName: os.RTLD_DEEPBIND + href: https://docs.python.org/3/library/os.html#os.RTLD_DEEPBIND + name: RTLD_DEEPBIND + uid: os.RTLD_DEEPBIND +- fullName: os.RTLD_GLOBAL + href: https://docs.python.org/3/library/os.html#os.RTLD_GLOBAL + name: RTLD_GLOBAL + uid: os.RTLD_GLOBAL +- fullName: os.RTLD_LAZY + href: https://docs.python.org/3/library/os.html#os.RTLD_LAZY + name: RTLD_LAZY + uid: os.RTLD_LAZY +- fullName: os.RTLD_LOCAL + href: https://docs.python.org/3/library/os.html#os.RTLD_LOCAL + name: RTLD_LOCAL + uid: os.RTLD_LOCAL +- fullName: os.RTLD_NODELETE + href: https://docs.python.org/3/library/os.html#os.RTLD_NODELETE + name: RTLD_NODELETE + uid: os.RTLD_NODELETE +- fullName: os.RTLD_NOLOAD + href: https://docs.python.org/3/library/os.html#os.RTLD_NOLOAD + name: RTLD_NOLOAD + uid: os.RTLD_NOLOAD +- fullName: os.RTLD_NOW + href: https://docs.python.org/3/library/os.html#os.RTLD_NOW + name: RTLD_NOW + uid: os.RTLD_NOW +- fullName: os.RWF_APPEND + href: https://docs.python.org/3/library/os.html#os.RWF_APPEND + name: RWF_APPEND + uid: os.RWF_APPEND +- fullName: os.RWF_DSYNC + href: https://docs.python.org/3/library/os.html#os.RWF_DSYNC + name: RWF_DSYNC + uid: os.RWF_DSYNC +- fullName: os.RWF_HIPRI + href: https://docs.python.org/3/library/os.html#os.RWF_HIPRI + name: RWF_HIPRI + uid: os.RWF_HIPRI +- fullName: os.RWF_NOWAIT + href: https://docs.python.org/3/library/os.html#os.RWF_NOWAIT + name: RWF_NOWAIT + uid: os.RWF_NOWAIT +- fullName: os.RWF_SYNC + href: https://docs.python.org/3/library/os.html#os.RWF_SYNC + name: RWF_SYNC + uid: os.RWF_SYNC +- fullName: os.R_OK + href: https://docs.python.org/3/library/os.html#os.R_OK + name: R_OK + uid: os.R_OK +- fullName: os.SCHED_BATCH + href: https://docs.python.org/3/library/os.html#os.SCHED_BATCH + name: SCHED_BATCH + uid: os.SCHED_BATCH +- fullName: os.SCHED_FIFO + href: https://docs.python.org/3/library/os.html#os.SCHED_FIFO + name: SCHED_FIFO + uid: os.SCHED_FIFO +- fullName: os.SCHED_IDLE + href: https://docs.python.org/3/library/os.html#os.SCHED_IDLE + name: SCHED_IDLE + uid: os.SCHED_IDLE +- fullName: os.SCHED_OTHER + href: https://docs.python.org/3/library/os.html#os.SCHED_OTHER + name: SCHED_OTHER + uid: os.SCHED_OTHER +- fullName: os.SCHED_RESET_ON_FORK + href: https://docs.python.org/3/library/os.html#os.SCHED_RESET_ON_FORK + name: SCHED_RESET_ON_FORK + uid: os.SCHED_RESET_ON_FORK +- fullName: os.SCHED_RR + href: https://docs.python.org/3/library/os.html#os.SCHED_RR + name: SCHED_RR + uid: os.SCHED_RR +- fullName: os.SCHED_SPORADIC + href: https://docs.python.org/3/library/os.html#os.SCHED_SPORADIC + name: SCHED_SPORADIC + uid: os.SCHED_SPORADIC +- fullName: os.SEEK_CUR + href: https://docs.python.org/3/library/os.html#os.SEEK_CUR + name: SEEK_CUR + uid: os.SEEK_CUR +- fullName: os.SEEK_DATA + href: https://docs.python.org/3/library/os.html#os.SEEK_DATA + name: SEEK_DATA + uid: os.SEEK_DATA +- fullName: os.SEEK_END + href: https://docs.python.org/3/library/os.html#os.SEEK_END + name: SEEK_END + uid: os.SEEK_END +- fullName: os.SEEK_HOLE + href: https://docs.python.org/3/library/os.html#os.SEEK_HOLE + name: SEEK_HOLE + uid: os.SEEK_HOLE +- fullName: os.SEEK_SET + href: https://docs.python.org/3/library/os.html#os.SEEK_SET + name: SEEK_SET + uid: os.SEEK_SET +- fullName: os.SF_MNOWAIT + href: https://docs.python.org/3/library/os.html#os.SF_MNOWAIT + name: SF_MNOWAIT + uid: os.SF_MNOWAIT +- fullName: os.SF_NOCACHE + href: https://docs.python.org/3/library/os.html#os.SF_NOCACHE + name: SF_NOCACHE + uid: os.SF_NOCACHE +- fullName: os.SF_NODISKIO + href: https://docs.python.org/3/library/os.html#os.SF_NODISKIO + name: SF_NODISKIO + uid: os.SF_NODISKIO +- fullName: os.SF_SYNC + href: https://docs.python.org/3/library/os.html#os.SF_SYNC + name: SF_SYNC + uid: os.SF_SYNC +- fullName: os.SPLICE_F_MORE + href: https://docs.python.org/3/library/os.html#os.SPLICE_F_MORE + name: SPLICE_F_MORE + uid: os.SPLICE_F_MORE +- fullName: os.SPLICE_F_MOVE + href: https://docs.python.org/3/library/os.html#os.SPLICE_F_MOVE + name: SPLICE_F_MOVE + uid: os.SPLICE_F_MOVE +- fullName: os.SPLICE_F_NONBLOCK + href: https://docs.python.org/3/library/os.html#os.SPLICE_F_NONBLOCK + name: SPLICE_F_NONBLOCK + uid: os.SPLICE_F_NONBLOCK +- fullName: os.TFD_CLOEXEC + href: https://docs.python.org/3/library/os.html#os.TFD_CLOEXEC + name: TFD_CLOEXEC + uid: os.TFD_CLOEXEC +- fullName: os.TFD_NONBLOCK + href: https://docs.python.org/3/library/os.html#os.TFD_NONBLOCK + name: TFD_NONBLOCK + uid: os.TFD_NONBLOCK +- fullName: os.TFD_TIMER_ABSTIME + href: https://docs.python.org/3/library/os.html#os.TFD_TIMER_ABSTIME + name: TFD_TIMER_ABSTIME + uid: os.TFD_TIMER_ABSTIME +- fullName: os.TFD_TIMER_CANCEL_ON_SET + href: https://docs.python.org/3/library/os.html#os.TFD_TIMER_CANCEL_ON_SET + name: TFD_TIMER_CANCEL_ON_SET + uid: os.TFD_TIMER_CANCEL_ON_SET +- fullName: os.WCONTINUED + href: https://docs.python.org/3/library/os.html#os.WCONTINUED + name: WCONTINUED + uid: os.WCONTINUED +- fullName: os.WEXITED + href: https://docs.python.org/3/library/os.html#os.WEXITED + name: WEXITED + uid: os.WEXITED +- fullName: os.WNOHANG + href: https://docs.python.org/3/library/os.html#os.WNOHANG + name: WNOHANG + uid: os.WNOHANG +- fullName: os.WNOWAIT + href: https://docs.python.org/3/library/os.html#os.WNOWAIT + name: WNOWAIT + uid: os.WNOWAIT +- fullName: os.WSTOPPED + href: https://docs.python.org/3/library/os.html#os.WSTOPPED + name: WSTOPPED + uid: os.WSTOPPED +- fullName: os.WUNTRACED + href: https://docs.python.org/3/library/os.html#os.WUNTRACED + name: WUNTRACED + uid: os.WUNTRACED +- fullName: os.W_OK + href: https://docs.python.org/3/library/os.html#os.W_OK + name: W_OK + uid: os.W_OK +- fullName: os.XATTR_CREATE + href: https://docs.python.org/3/library/os.html#os.XATTR_CREATE + name: XATTR_CREATE + uid: os.XATTR_CREATE +- fullName: os.XATTR_REPLACE + href: https://docs.python.org/3/library/os.html#os.XATTR_REPLACE + name: XATTR_REPLACE + uid: os.XATTR_REPLACE +- fullName: os.XATTR_SIZE_MAX + href: https://docs.python.org/3/library/os.html#os.XATTR_SIZE_MAX + name: XATTR_SIZE_MAX + uid: os.XATTR_SIZE_MAX +- fullName: os.X_OK + href: https://docs.python.org/3/library/os.html#os.X_OK + name: X_OK + uid: os.X_OK +- fullName: os.altsep + href: https://docs.python.org/3/library/os.html#os.altsep + name: altsep + uid: os.altsep +- fullName: os.confstr_names + href: https://docs.python.org/3/library/os.html#os.confstr_names + name: confstr_names + uid: os.confstr_names +- fullName: os.curdir + href: https://docs.python.org/3/library/os.html#os.curdir + name: curdir + uid: os.curdir +- fullName: os.defpath + href: https://docs.python.org/3/library/os.html#os.defpath + name: defpath + uid: os.defpath +- fullName: os.devnull + href: https://docs.python.org/3/library/os.html#os.devnull + name: devnull + uid: os.devnull +- fullName: os.environ + href: https://docs.python.org/3/library/os.html#os.environ + name: environ + uid: os.environ +- fullName: os.environb + href: https://docs.python.org/3/library/os.html#os.environb + name: environb + uid: os.environb +- fullName: os.extsep + href: https://docs.python.org/3/library/os.html#os.extsep + name: extsep + uid: os.extsep +- fullName: os.linesep + href: https://docs.python.org/3/library/os.html#os.linesep + name: linesep + uid: os.linesep +- fullName: os.name + href: https://docs.python.org/3/library/os.html#os.name + name: name + uid: os.name +- fullName: os.pardir + href: https://docs.python.org/3/library/os.html#os.pardir + name: pardir + uid: os.pardir +- fullName: os.path.supports_unicode_filenames + href: https://docs.python.org/3/library/os.path.html#os.path.supports_unicode_filenames + name: supports_unicode_filenames + uid: os.path.supports_unicode_filenames +- fullName: os.pathconf_names + href: https://docs.python.org/3/library/os.html#os.pathconf_names + name: pathconf_names + uid: os.pathconf_names +- fullName: os.pathsep + href: https://docs.python.org/3/library/os.html#os.pathsep + name: pathsep + uid: os.pathsep +- fullName: os.sep + href: https://docs.python.org/3/library/os.html#os.sep + name: sep + uid: os.sep +- fullName: os.supports_bytes_environ + href: https://docs.python.org/3/library/os.html#os.supports_bytes_environ + name: supports_bytes_environ + uid: os.supports_bytes_environ +- fullName: os.supports_dir_fd + href: https://docs.python.org/3/library/os.html#os.supports_dir_fd + name: supports_dir_fd + uid: os.supports_dir_fd +- fullName: os.supports_effective_ids + href: https://docs.python.org/3/library/os.html#os.supports_effective_ids + name: supports_effective_ids + uid: os.supports_effective_ids +- fullName: os.supports_fd + href: https://docs.python.org/3/library/os.html#os.supports_fd + name: supports_fd + uid: os.supports_fd +- fullName: os.supports_follow_symlinks + href: https://docs.python.org/3/library/os.html#os.supports_follow_symlinks + name: supports_follow_symlinks + uid: os.supports_follow_symlinks +- fullName: os.sysconf_names + href: https://docs.python.org/3/library/os.html#os.sysconf_names + name: sysconf_names + uid: os.sysconf_names +- fullName: pickle.DEFAULT_PROTOCOL + href: https://docs.python.org/3/library/pickle.html#pickle.DEFAULT_PROTOCOL + name: DEFAULT_PROTOCOL + uid: pickle.DEFAULT_PROTOCOL +- fullName: pickle.HIGHEST_PROTOCOL + href: https://docs.python.org/3/library/pickle.html#pickle.HIGHEST_PROTOCOL + name: HIGHEST_PROTOCOL + uid: pickle.HIGHEST_PROTOCOL +- fullName: plistlib.FMT_BINARY + href: https://docs.python.org/3/library/plistlib.html#plistlib.FMT_BINARY + name: FMT_BINARY + uid: plistlib.FMT_BINARY +- fullName: plistlib.FMT_XML + href: https://docs.python.org/3/library/plistlib.html#plistlib.FMT_XML + name: FMT_XML + uid: plistlib.FMT_XML +- fullName: posix.environ + href: https://docs.python.org/3/library/posix.html#posix.environ + name: environ + uid: posix.environ +- fullName: quit + href: https://docs.python.org/3/library/constants.html#quit + name: quit + uid: quit +- fullName: re.A + href: https://docs.python.org/3/library/re.html#re.A + name: A + uid: re.A +- fullName: re.ASCII + href: https://docs.python.org/3/library/re.html#re.ASCII + name: ASCII + uid: re.ASCII +- fullName: re.DEBUG + href: https://docs.python.org/3/library/re.html#re.DEBUG + name: DEBUG + uid: re.DEBUG +- fullName: re.DOTALL + href: https://docs.python.org/3/library/re.html#re.DOTALL + name: DOTALL + uid: re.DOTALL +- fullName: re.I + href: https://docs.python.org/3/library/re.html#re.I + name: I + uid: re.I +- fullName: re.IGNORECASE + href: https://docs.python.org/3/library/re.html#re.IGNORECASE + name: IGNORECASE + uid: re.IGNORECASE +- fullName: re.L + href: https://docs.python.org/3/library/re.html#re.L + name: L + uid: re.L +- fullName: re.LOCALE + href: https://docs.python.org/3/library/re.html#re.LOCALE + name: LOCALE + uid: re.LOCALE +- fullName: re.M + href: https://docs.python.org/3/library/re.html#re.M + name: M + uid: re.M +- fullName: re.MULTILINE + href: https://docs.python.org/3/library/re.html#re.MULTILINE + name: MULTILINE + uid: re.MULTILINE +- fullName: re.NOFLAG + href: https://docs.python.org/3/library/re.html#re.NOFLAG + name: NOFLAG + uid: re.NOFLAG +- fullName: re.S + href: https://docs.python.org/3/library/re.html#re.S + name: S + uid: re.S +- fullName: re.U + href: https://docs.python.org/3/library/re.html#re.U + name: U + uid: re.U +- fullName: re.UNICODE + href: https://docs.python.org/3/library/re.html#re.UNICODE + name: UNICODE + uid: re.UNICODE +- fullName: re.VERBOSE + href: https://docs.python.org/3/library/re.html#re.VERBOSE + name: VERBOSE + uid: re.VERBOSE +- fullName: re.X + href: https://docs.python.org/3/library/re.html#re.X + name: X + uid: re.X +- fullName: readline.backend + href: https://docs.python.org/3/library/readline.html#readline.backend + name: backend + uid: readline.backend +- fullName: reprlib.aRepr + href: https://docs.python.org/3/library/reprlib.html#reprlib.aRepr + name: aRepr + uid: reprlib.aRepr +- fullName: resource.RLIMIT_AS + href: https://docs.python.org/3/library/resource.html#resource.RLIMIT_AS + name: RLIMIT_AS + uid: resource.RLIMIT_AS +- fullName: resource.RLIMIT_CORE + href: https://docs.python.org/3/library/resource.html#resource.RLIMIT_CORE + name: RLIMIT_CORE + uid: resource.RLIMIT_CORE +- fullName: resource.RLIMIT_CPU + href: https://docs.python.org/3/library/resource.html#resource.RLIMIT_CPU + name: RLIMIT_CPU + uid: resource.RLIMIT_CPU +- fullName: resource.RLIMIT_DATA + href: https://docs.python.org/3/library/resource.html#resource.RLIMIT_DATA + name: RLIMIT_DATA + uid: resource.RLIMIT_DATA +- fullName: resource.RLIMIT_FSIZE + href: https://docs.python.org/3/library/resource.html#resource.RLIMIT_FSIZE + name: RLIMIT_FSIZE + uid: resource.RLIMIT_FSIZE +- fullName: resource.RLIMIT_KQUEUES + href: https://docs.python.org/3/library/resource.html#resource.RLIMIT_KQUEUES + name: RLIMIT_KQUEUES + uid: resource.RLIMIT_KQUEUES +- fullName: resource.RLIMIT_MEMLOCK + href: https://docs.python.org/3/library/resource.html#resource.RLIMIT_MEMLOCK + name: RLIMIT_MEMLOCK + uid: resource.RLIMIT_MEMLOCK +- fullName: resource.RLIMIT_MSGQUEUE + href: https://docs.python.org/3/library/resource.html#resource.RLIMIT_MSGQUEUE + name: RLIMIT_MSGQUEUE + uid: resource.RLIMIT_MSGQUEUE +- fullName: resource.RLIMIT_NICE + href: https://docs.python.org/3/library/resource.html#resource.RLIMIT_NICE + name: RLIMIT_NICE + uid: resource.RLIMIT_NICE +- fullName: resource.RLIMIT_NOFILE + href: https://docs.python.org/3/library/resource.html#resource.RLIMIT_NOFILE + name: RLIMIT_NOFILE + uid: resource.RLIMIT_NOFILE +- fullName: resource.RLIMIT_NPROC + href: https://docs.python.org/3/library/resource.html#resource.RLIMIT_NPROC + name: RLIMIT_NPROC + uid: resource.RLIMIT_NPROC +- fullName: resource.RLIMIT_NPTS + href: https://docs.python.org/3/library/resource.html#resource.RLIMIT_NPTS + name: RLIMIT_NPTS + uid: resource.RLIMIT_NPTS +- fullName: resource.RLIMIT_OFILE + href: https://docs.python.org/3/library/resource.html#resource.RLIMIT_OFILE + name: RLIMIT_OFILE + uid: resource.RLIMIT_OFILE +- fullName: resource.RLIMIT_RSS + href: https://docs.python.org/3/library/resource.html#resource.RLIMIT_RSS + name: RLIMIT_RSS + uid: resource.RLIMIT_RSS +- fullName: resource.RLIMIT_RTPRIO + href: https://docs.python.org/3/library/resource.html#resource.RLIMIT_RTPRIO + name: RLIMIT_RTPRIO + uid: resource.RLIMIT_RTPRIO +- fullName: resource.RLIMIT_RTTIME + href: https://docs.python.org/3/library/resource.html#resource.RLIMIT_RTTIME + name: RLIMIT_RTTIME + uid: resource.RLIMIT_RTTIME +- fullName: resource.RLIMIT_SBSIZE + href: https://docs.python.org/3/library/resource.html#resource.RLIMIT_SBSIZE + name: RLIMIT_SBSIZE + uid: resource.RLIMIT_SBSIZE +- fullName: resource.RLIMIT_SIGPENDING + href: https://docs.python.org/3/library/resource.html#resource.RLIMIT_SIGPENDING + name: RLIMIT_SIGPENDING + uid: resource.RLIMIT_SIGPENDING +- fullName: resource.RLIMIT_STACK + href: https://docs.python.org/3/library/resource.html#resource.RLIMIT_STACK + name: RLIMIT_STACK + uid: resource.RLIMIT_STACK +- fullName: resource.RLIMIT_SWAP + href: https://docs.python.org/3/library/resource.html#resource.RLIMIT_SWAP + name: RLIMIT_SWAP + uid: resource.RLIMIT_SWAP +- fullName: resource.RLIMIT_VMEM + href: https://docs.python.org/3/library/resource.html#resource.RLIMIT_VMEM + name: RLIMIT_VMEM + uid: resource.RLIMIT_VMEM +- fullName: resource.RLIM_INFINITY + href: https://docs.python.org/3/library/resource.html#resource.RLIM_INFINITY + name: RLIM_INFINITY + uid: resource.RLIM_INFINITY +- fullName: resource.RUSAGE_BOTH + href: https://docs.python.org/3/library/resource.html#resource.RUSAGE_BOTH + name: RUSAGE_BOTH + uid: resource.RUSAGE_BOTH +- fullName: resource.RUSAGE_CHILDREN + href: https://docs.python.org/3/library/resource.html#resource.RUSAGE_CHILDREN + name: RUSAGE_CHILDREN + uid: resource.RUSAGE_CHILDREN +- fullName: resource.RUSAGE_SELF + href: https://docs.python.org/3/library/resource.html#resource.RUSAGE_SELF + name: RUSAGE_SELF + uid: resource.RUSAGE_SELF +- fullName: resource.RUSAGE_THREAD + href: https://docs.python.org/3/library/resource.html#resource.RUSAGE_THREAD + name: RUSAGE_THREAD + uid: resource.RUSAGE_THREAD +- fullName: select.PIPE_BUF + href: https://docs.python.org/3/library/select.html#select.PIPE_BUF + name: PIPE_BUF + uid: select.PIPE_BUF +- fullName: selectors.EVENT_READ + href: https://docs.python.org/3/library/selectors.html#selectors.EVENT_READ + name: EVENT_READ + uid: selectors.EVENT_READ +- fullName: selectors.EVENT_WRITE + href: https://docs.python.org/3/library/selectors.html#selectors.EVENT_WRITE + name: EVENT_WRITE + uid: selectors.EVENT_WRITE +- fullName: signal.CTRL_BREAK_EVENT + href: https://docs.python.org/3/library/signal.html#signal.CTRL_BREAK_EVENT + name: CTRL_BREAK_EVENT + uid: signal.CTRL_BREAK_EVENT +- fullName: signal.CTRL_C_EVENT + href: https://docs.python.org/3/library/signal.html#signal.CTRL_C_EVENT + name: CTRL_C_EVENT + uid: signal.CTRL_C_EVENT +- fullName: signal.ITIMER_PROF + href: https://docs.python.org/3/library/signal.html#signal.ITIMER_PROF + name: ITIMER_PROF + uid: signal.ITIMER_PROF +- fullName: signal.ITIMER_REAL + href: https://docs.python.org/3/library/signal.html#signal.ITIMER_REAL + name: ITIMER_REAL + uid: signal.ITIMER_REAL +- fullName: signal.ITIMER_VIRTUAL + href: https://docs.python.org/3/library/signal.html#signal.ITIMER_VIRTUAL + name: ITIMER_VIRTUAL + uid: signal.ITIMER_VIRTUAL +- fullName: signal.NSIG + href: https://docs.python.org/3/library/signal.html#signal.NSIG + name: NSIG + uid: signal.NSIG +- fullName: signal.SIGABRT + href: https://docs.python.org/3/library/signal.html#signal.SIGABRT + name: SIGABRT + uid: signal.SIGABRT +- fullName: signal.SIGALRM + href: https://docs.python.org/3/library/signal.html#signal.SIGALRM + name: SIGALRM + uid: signal.SIGALRM +- fullName: signal.SIGBREAK + href: https://docs.python.org/3/library/signal.html#signal.SIGBREAK + name: SIGBREAK + uid: signal.SIGBREAK +- fullName: signal.SIGBUS + href: https://docs.python.org/3/library/signal.html#signal.SIGBUS + name: SIGBUS + uid: signal.SIGBUS +- fullName: signal.SIGCHLD + href: https://docs.python.org/3/library/signal.html#signal.SIGCHLD + name: SIGCHLD + uid: signal.SIGCHLD +- fullName: signal.SIGCLD + href: https://docs.python.org/3/library/signal.html#signal.SIGCLD + name: SIGCLD + uid: signal.SIGCLD +- fullName: signal.SIGCONT + href: https://docs.python.org/3/library/signal.html#signal.SIGCONT + name: SIGCONT + uid: signal.SIGCONT +- fullName: signal.SIGFPE + href: https://docs.python.org/3/library/signal.html#signal.SIGFPE + name: SIGFPE + uid: signal.SIGFPE +- fullName: signal.SIGHUP + href: https://docs.python.org/3/library/signal.html#signal.SIGHUP + name: SIGHUP + uid: signal.SIGHUP +- fullName: signal.SIGILL + href: https://docs.python.org/3/library/signal.html#signal.SIGILL + name: SIGILL + uid: signal.SIGILL +- fullName: signal.SIGINT + href: https://docs.python.org/3/library/signal.html#signal.SIGINT + name: SIGINT + uid: signal.SIGINT +- fullName: signal.SIGKILL + href: https://docs.python.org/3/library/signal.html#signal.SIGKILL + name: SIGKILL + uid: signal.SIGKILL +- fullName: signal.SIGPIPE + href: https://docs.python.org/3/library/signal.html#signal.SIGPIPE + name: SIGPIPE + uid: signal.SIGPIPE +- fullName: signal.SIGSEGV + href: https://docs.python.org/3/library/signal.html#signal.SIGSEGV + name: SIGSEGV + uid: signal.SIGSEGV +- fullName: signal.SIGSTKFLT + href: https://docs.python.org/3/library/signal.html#signal.SIGSTKFLT + name: SIGSTKFLT + uid: signal.SIGSTKFLT +- fullName: signal.SIGTERM + href: https://docs.python.org/3/library/signal.html#signal.SIGTERM + name: SIGTERM + uid: signal.SIGTERM +- fullName: signal.SIGUSR1 + href: https://docs.python.org/3/library/signal.html#signal.SIGUSR1 + name: SIGUSR1 + uid: signal.SIGUSR1 +- fullName: signal.SIGUSR2 + href: https://docs.python.org/3/library/signal.html#signal.SIGUSR2 + name: SIGUSR2 + uid: signal.SIGUSR2 +- fullName: signal.SIGWINCH + href: https://docs.python.org/3/library/signal.html#signal.SIGWINCH + name: SIGWINCH + uid: signal.SIGWINCH +- fullName: signal.SIG_BLOCK + href: https://docs.python.org/3/library/signal.html#signal.SIG_BLOCK + name: SIG_BLOCK + uid: signal.SIG_BLOCK +- fullName: signal.SIG_DFL + href: https://docs.python.org/3/library/signal.html#signal.SIG_DFL + name: SIG_DFL + uid: signal.SIG_DFL +- fullName: signal.SIG_IGN + href: https://docs.python.org/3/library/signal.html#signal.SIG_IGN + name: SIG_IGN + uid: signal.SIG_IGN +- fullName: signal.SIG_SETMASK + href: https://docs.python.org/3/library/signal.html#signal.SIG_SETMASK + name: SIG_SETMASK + uid: signal.SIG_SETMASK +- fullName: signal.SIG_UNBLOCK + href: https://docs.python.org/3/library/signal.html#signal.SIG_UNBLOCK + name: SIG_UNBLOCK + uid: signal.SIG_UNBLOCK +- fullName: site.ENABLE_USER_SITE + href: https://docs.python.org/3/library/site.html#site.ENABLE_USER_SITE + name: ENABLE_USER_SITE + uid: site.ENABLE_USER_SITE +- fullName: site.PREFIXES + href: https://docs.python.org/3/library/site.html#site.PREFIXES + name: PREFIXES + uid: site.PREFIXES +- fullName: site.USER_BASE + href: https://docs.python.org/3/library/site.html#site.USER_BASE + name: USER_BASE + uid: site.USER_BASE +- fullName: site.USER_SITE + href: https://docs.python.org/3/library/site.html#site.USER_SITE + name: USER_SITE + uid: site.USER_SITE +- fullName: socket.AF_ALG + href: https://docs.python.org/3/library/socket.html#socket.AF_ALG + name: AF_ALG + uid: socket.AF_ALG +- fullName: socket.AF_CAN + href: https://docs.python.org/3/library/socket.html#socket.AF_CAN + name: AF_CAN + uid: socket.AF_CAN +- fullName: socket.AF_DIVERT + href: https://docs.python.org/3/library/socket.html#socket.AF_DIVERT + name: AF_DIVERT + uid: socket.AF_DIVERT +- fullName: socket.AF_HYPERV + href: https://docs.python.org/3/library/socket.html#socket.AF_HYPERV + name: AF_HYPERV + uid: socket.AF_HYPERV +- fullName: socket.AF_INET + href: https://docs.python.org/3/library/socket.html#socket.AF_INET + name: AF_INET + uid: socket.AF_INET +- fullName: socket.AF_INET6 + href: https://docs.python.org/3/library/socket.html#socket.AF_INET6 + name: AF_INET6 + uid: socket.AF_INET6 +- fullName: socket.AF_LINK + href: https://docs.python.org/3/library/socket.html#socket.AF_LINK + name: AF_LINK + uid: socket.AF_LINK +- fullName: socket.AF_PACKET + href: https://docs.python.org/3/library/socket.html#socket.AF_PACKET + name: AF_PACKET + uid: socket.AF_PACKET +- fullName: socket.AF_QIPCRTR + href: https://docs.python.org/3/library/socket.html#socket.AF_QIPCRTR + name: AF_QIPCRTR + uid: socket.AF_QIPCRTR +- fullName: socket.AF_RDS + href: https://docs.python.org/3/library/socket.html#socket.AF_RDS + name: AF_RDS + uid: socket.AF_RDS +- fullName: socket.AF_UNIX + href: https://docs.python.org/3/library/socket.html#socket.AF_UNIX + name: AF_UNIX + uid: socket.AF_UNIX +- fullName: socket.AF_UNSPEC + href: https://docs.python.org/3/library/socket.html#socket.AF_UNSPEC + name: AF_UNSPEC + uid: socket.AF_UNSPEC +- fullName: socket.AF_VSOCK + href: https://docs.python.org/3/library/socket.html#socket.AF_VSOCK + name: AF_VSOCK + uid: socket.AF_VSOCK +- fullName: socket.BDADDR_ANY + href: https://docs.python.org/3/library/socket.html#socket.BDADDR_ANY + name: BDADDR_ANY + uid: socket.BDADDR_ANY +- fullName: socket.BDADDR_LOCAL + href: https://docs.python.org/3/library/socket.html#socket.BDADDR_LOCAL + name: BDADDR_LOCAL + uid: socket.BDADDR_LOCAL +- fullName: socket.CAN_BCM + href: https://docs.python.org/3/library/socket.html#socket.CAN_BCM + name: CAN_BCM + uid: socket.CAN_BCM +- fullName: socket.CAN_ISOTP + href: https://docs.python.org/3/library/socket.html#socket.CAN_ISOTP + name: CAN_ISOTP + uid: socket.CAN_ISOTP +- fullName: socket.CAN_J1939 + href: https://docs.python.org/3/library/socket.html#socket.CAN_J1939 + name: CAN_J1939 + uid: socket.CAN_J1939 +- fullName: socket.CAN_RAW_FD_FRAMES + href: https://docs.python.org/3/library/socket.html#socket.CAN_RAW_FD_FRAMES + name: CAN_RAW_FD_FRAMES + uid: socket.CAN_RAW_FD_FRAMES +- fullName: socket.CAN_RAW_JOIN_FILTERS + href: https://docs.python.org/3/library/socket.html#socket.CAN_RAW_JOIN_FILTERS + name: CAN_RAW_JOIN_FILTERS + uid: socket.CAN_RAW_JOIN_FILTERS +- fullName: socket.ETHERTYPE_ARP + href: https://docs.python.org/3/library/socket.html#socket.ETHERTYPE_ARP + name: ETHERTYPE_ARP + uid: socket.ETHERTYPE_ARP +- fullName: socket.ETHERTYPE_IP + href: https://docs.python.org/3/library/socket.html#socket.ETHERTYPE_IP + name: ETHERTYPE_IP + uid: socket.ETHERTYPE_IP +- fullName: socket.ETHERTYPE_IPV6 + href: https://docs.python.org/3/library/socket.html#socket.ETHERTYPE_IPV6 + name: ETHERTYPE_IPV6 + uid: socket.ETHERTYPE_IPV6 +- fullName: socket.ETHERTYPE_VLAN + href: https://docs.python.org/3/library/socket.html#socket.ETHERTYPE_VLAN + name: ETHERTYPE_VLAN + uid: socket.ETHERTYPE_VLAN +- fullName: socket.ETH_P_ALL + href: https://docs.python.org/3/library/socket.html#socket.ETH_P_ALL + name: ETH_P_ALL + uid: socket.ETH_P_ALL +- fullName: socket.HCI_DATA_DIR + href: https://docs.python.org/3/library/socket.html#socket.HCI_DATA_DIR + name: HCI_DATA_DIR + uid: socket.HCI_DATA_DIR +- fullName: socket.HCI_FILTER + href: https://docs.python.org/3/library/socket.html#socket.HCI_FILTER + name: HCI_FILTER + uid: socket.HCI_FILTER +- fullName: socket.HCI_TIME_STAMP + href: https://docs.python.org/3/library/socket.html#socket.HCI_TIME_STAMP + name: HCI_TIME_STAMP + uid: socket.HCI_TIME_STAMP +- fullName: socket.HVSOCKET_ADDRESS_FLAG_PASSTHRU + href: https://docs.python.org/3/library/socket.html#socket.HVSOCKET_ADDRESS_FLAG_PASSTHRU + name: HVSOCKET_ADDRESS_FLAG_PASSTHRU + uid: socket.HVSOCKET_ADDRESS_FLAG_PASSTHRU +- fullName: socket.HVSOCKET_CONNECTED_SUSPEND + href: https://docs.python.org/3/library/socket.html#socket.HVSOCKET_CONNECTED_SUSPEND + name: HVSOCKET_CONNECTED_SUSPEND + uid: socket.HVSOCKET_CONNECTED_SUSPEND +- fullName: socket.HVSOCKET_CONNECT_TIMEOUT + href: https://docs.python.org/3/library/socket.html#socket.HVSOCKET_CONNECT_TIMEOUT + name: HVSOCKET_CONNECT_TIMEOUT + uid: socket.HVSOCKET_CONNECT_TIMEOUT +- fullName: socket.HVSOCKET_CONNECT_TIMEOUT_MAX + href: https://docs.python.org/3/library/socket.html#socket.HVSOCKET_CONNECT_TIMEOUT_MAX + name: HVSOCKET_CONNECT_TIMEOUT_MAX + uid: socket.HVSOCKET_CONNECT_TIMEOUT_MAX +- fullName: socket.HV_GUID_BROADCAST + href: https://docs.python.org/3/library/socket.html#socket.HV_GUID_BROADCAST + name: HV_GUID_BROADCAST + uid: socket.HV_GUID_BROADCAST +- fullName: socket.HV_GUID_CHILDREN + href: https://docs.python.org/3/library/socket.html#socket.HV_GUID_CHILDREN + name: HV_GUID_CHILDREN + uid: socket.HV_GUID_CHILDREN +- fullName: socket.HV_GUID_LOOPBACK + href: https://docs.python.org/3/library/socket.html#socket.HV_GUID_LOOPBACK + name: HV_GUID_LOOPBACK + uid: socket.HV_GUID_LOOPBACK +- fullName: socket.HV_GUID_PARENT + href: https://docs.python.org/3/library/socket.html#socket.HV_GUID_PARENT + name: HV_GUID_PARENT + uid: socket.HV_GUID_PARENT +- fullName: socket.HV_GUID_WILDCARD + href: https://docs.python.org/3/library/socket.html#socket.HV_GUID_WILDCARD + name: HV_GUID_WILDCARD + uid: socket.HV_GUID_WILDCARD +- fullName: socket.HV_GUID_ZERO + href: https://docs.python.org/3/library/socket.html#socket.HV_GUID_ZERO + name: HV_GUID_ZERO + uid: socket.HV_GUID_ZERO +- fullName: socket.HV_PROTOCOL_RAW + href: https://docs.python.org/3/library/socket.html#socket.HV_PROTOCOL_RAW + name: HV_PROTOCOL_RAW + uid: socket.HV_PROTOCOL_RAW +- fullName: socket.IOCTL_VM_SOCKETS_GET_LOCAL_CID + href: https://docs.python.org/3/library/socket.html#socket.IOCTL_VM_SOCKETS_GET_LOCAL_CID + name: IOCTL_VM_SOCKETS_GET_LOCAL_CID + uid: socket.IOCTL_VM_SOCKETS_GET_LOCAL_CID +- fullName: socket.LOCAL_CREDS + href: https://docs.python.org/3/library/socket.html#socket.LOCAL_CREDS + name: LOCAL_CREDS + uid: socket.LOCAL_CREDS +- fullName: socket.LOCAL_CREDS_PERSISTENT + href: https://docs.python.org/3/library/socket.html#socket.LOCAL_CREDS_PERSISTENT + name: LOCAL_CREDS_PERSISTENT + uid: socket.LOCAL_CREDS_PERSISTENT +- fullName: socket.PF_CAN + href: https://docs.python.org/3/library/socket.html#socket.PF_CAN + name: PF_CAN + uid: socket.PF_CAN +- fullName: socket.PF_DIVERT + href: https://docs.python.org/3/library/socket.html#socket.PF_DIVERT + name: PF_DIVERT + uid: socket.PF_DIVERT +- fullName: socket.PF_PACKET + href: https://docs.python.org/3/library/socket.html#socket.PF_PACKET + name: PF_PACKET + uid: socket.PF_PACKET +- fullName: socket.PF_RDS + href: https://docs.python.org/3/library/socket.html#socket.PF_RDS + name: PF_RDS + uid: socket.PF_RDS +- fullName: socket.SCM_CREDS2 + href: https://docs.python.org/3/library/socket.html#socket.SCM_CREDS2 + name: SCM_CREDS2 + uid: socket.SCM_CREDS2 +- fullName: socket.SHUT_RD + href: https://docs.python.org/3/library/socket.html#socket.SHUT_RD + name: SHUT_RD + uid: socket.SHUT_RD +- fullName: socket.SHUT_RDWR + href: https://docs.python.org/3/library/socket.html#socket.SHUT_RDWR + name: SHUT_RDWR + uid: socket.SHUT_RDWR +- fullName: socket.SHUT_WR + href: https://docs.python.org/3/library/socket.html#socket.SHUT_WR + name: SHUT_WR + uid: socket.SHUT_WR +- fullName: socket.SIO_KEEPALIVE_VALS + href: https://docs.python.org/3/library/socket.html#socket.SIO_KEEPALIVE_VALS + name: SIO_KEEPALIVE_VALS + uid: socket.SIO_KEEPALIVE_VALS +- fullName: socket.SIO_LOOPBACK_FAST_PATH + href: https://docs.python.org/3/library/socket.html#socket.SIO_LOOPBACK_FAST_PATH + name: SIO_LOOPBACK_FAST_PATH + uid: socket.SIO_LOOPBACK_FAST_PATH +- fullName: socket.SIO_RCVALL + href: https://docs.python.org/3/library/socket.html#socket.SIO_RCVALL + name: SIO_RCVALL + uid: socket.SIO_RCVALL +- fullName: socket.SOCK_CLOEXEC + href: https://docs.python.org/3/library/socket.html#socket.SOCK_CLOEXEC + name: SOCK_CLOEXEC + uid: socket.SOCK_CLOEXEC +- fullName: socket.SOCK_DGRAM + href: https://docs.python.org/3/library/socket.html#socket.SOCK_DGRAM + name: SOCK_DGRAM + uid: socket.SOCK_DGRAM +- fullName: socket.SOCK_NONBLOCK + href: https://docs.python.org/3/library/socket.html#socket.SOCK_NONBLOCK + name: SOCK_NONBLOCK + uid: socket.SOCK_NONBLOCK +- fullName: socket.SOCK_RAW + href: https://docs.python.org/3/library/socket.html#socket.SOCK_RAW + name: SOCK_RAW + uid: socket.SOCK_RAW +- fullName: socket.SOCK_RDM + href: https://docs.python.org/3/library/socket.html#socket.SOCK_RDM + name: SOCK_RDM + uid: socket.SOCK_RDM +- fullName: socket.SOCK_SEQPACKET + href: https://docs.python.org/3/library/socket.html#socket.SOCK_SEQPACKET + name: SOCK_SEQPACKET + uid: socket.SOCK_SEQPACKET +- fullName: socket.SOCK_STREAM + href: https://docs.python.org/3/library/socket.html#socket.SOCK_STREAM + name: SOCK_STREAM + uid: socket.SOCK_STREAM +- fullName: socket.SOL_ALG + href: https://docs.python.org/3/library/socket.html#socket.SOL_ALG + name: SOL_ALG + uid: socket.SOL_ALG +- fullName: socket.SOL_RDS + href: https://docs.python.org/3/library/socket.html#socket.SOL_RDS + name: SOL_RDS + uid: socket.SOL_RDS +- fullName: socket.SOMAXCONN + href: https://docs.python.org/3/library/socket.html#socket.SOMAXCONN + name: SOMAXCONN + uid: socket.SOMAXCONN +- fullName: socket.SO_INCOMING_CPU + href: https://docs.python.org/3/library/socket.html#socket.SO_INCOMING_CPU + name: SO_INCOMING_CPU + uid: socket.SO_INCOMING_CPU +- fullName: socket.SocketType + href: https://docs.python.org/3/library/socket.html#socket.SocketType + name: SocketType + uid: socket.SocketType +- fullName: socket.has_ipv6 + href: https://docs.python.org/3/library/socket.html#socket.has_ipv6 + name: has_ipv6 + uid: socket.has_ipv6 +- fullName: sqlite3.LEGACY_TRANSACTION_CONTROL + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.LEGACY_TRANSACTION_CONTROL + name: LEGACY_TRANSACTION_CONTROL + uid: sqlite3.LEGACY_TRANSACTION_CONTROL +- fullName: sqlite3.PARSE_COLNAMES + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.PARSE_COLNAMES + name: PARSE_COLNAMES + uid: sqlite3.PARSE_COLNAMES +- fullName: sqlite3.PARSE_DECLTYPES + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.PARSE_DECLTYPES + name: PARSE_DECLTYPES + uid: sqlite3.PARSE_DECLTYPES +- fullName: sqlite3.SQLITE_DBCONFIG_DEFENSIVE + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.SQLITE_DBCONFIG_DEFENSIVE + name: SQLITE_DBCONFIG_DEFENSIVE + uid: sqlite3.SQLITE_DBCONFIG_DEFENSIVE +- fullName: sqlite3.SQLITE_DBCONFIG_DQS_DDL + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.SQLITE_DBCONFIG_DQS_DDL + name: SQLITE_DBCONFIG_DQS_DDL + uid: sqlite3.SQLITE_DBCONFIG_DQS_DDL +- fullName: sqlite3.SQLITE_DBCONFIG_DQS_DML + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.SQLITE_DBCONFIG_DQS_DML + name: SQLITE_DBCONFIG_DQS_DML + uid: sqlite3.SQLITE_DBCONFIG_DQS_DML +- fullName: sqlite3.SQLITE_DBCONFIG_ENABLE_FKEY + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.SQLITE_DBCONFIG_ENABLE_FKEY + name: SQLITE_DBCONFIG_ENABLE_FKEY + uid: sqlite3.SQLITE_DBCONFIG_ENABLE_FKEY +- fullName: sqlite3.SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER + name: SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER + uid: sqlite3.SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER +- fullName: sqlite3.SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION + name: SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION + uid: sqlite3.SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION +- fullName: sqlite3.SQLITE_DBCONFIG_ENABLE_QPSG + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.SQLITE_DBCONFIG_ENABLE_QPSG + name: SQLITE_DBCONFIG_ENABLE_QPSG + uid: sqlite3.SQLITE_DBCONFIG_ENABLE_QPSG +- fullName: sqlite3.SQLITE_DBCONFIG_ENABLE_TRIGGER + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.SQLITE_DBCONFIG_ENABLE_TRIGGER + name: SQLITE_DBCONFIG_ENABLE_TRIGGER + uid: sqlite3.SQLITE_DBCONFIG_ENABLE_TRIGGER +- fullName: sqlite3.SQLITE_DBCONFIG_ENABLE_VIEW + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.SQLITE_DBCONFIG_ENABLE_VIEW + name: SQLITE_DBCONFIG_ENABLE_VIEW + uid: sqlite3.SQLITE_DBCONFIG_ENABLE_VIEW +- fullName: sqlite3.SQLITE_DBCONFIG_LEGACY_ALTER_TABLE + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.SQLITE_DBCONFIG_LEGACY_ALTER_TABLE + name: SQLITE_DBCONFIG_LEGACY_ALTER_TABLE + uid: sqlite3.SQLITE_DBCONFIG_LEGACY_ALTER_TABLE +- fullName: sqlite3.SQLITE_DBCONFIG_LEGACY_FILE_FORMAT + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.SQLITE_DBCONFIG_LEGACY_FILE_FORMAT + name: SQLITE_DBCONFIG_LEGACY_FILE_FORMAT + uid: sqlite3.SQLITE_DBCONFIG_LEGACY_FILE_FORMAT +- fullName: sqlite3.SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE + name: SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE + uid: sqlite3.SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE +- fullName: sqlite3.SQLITE_DBCONFIG_RESET_DATABASE + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.SQLITE_DBCONFIG_RESET_DATABASE + name: SQLITE_DBCONFIG_RESET_DATABASE + uid: sqlite3.SQLITE_DBCONFIG_RESET_DATABASE +- fullName: sqlite3.SQLITE_DBCONFIG_TRIGGER_EQP + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.SQLITE_DBCONFIG_TRIGGER_EQP + name: SQLITE_DBCONFIG_TRIGGER_EQP + uid: sqlite3.SQLITE_DBCONFIG_TRIGGER_EQP +- fullName: sqlite3.SQLITE_DBCONFIG_TRUSTED_SCHEMA + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.SQLITE_DBCONFIG_TRUSTED_SCHEMA + name: SQLITE_DBCONFIG_TRUSTED_SCHEMA + uid: sqlite3.SQLITE_DBCONFIG_TRUSTED_SCHEMA +- fullName: sqlite3.SQLITE_DBCONFIG_WRITABLE_SCHEMA + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.SQLITE_DBCONFIG_WRITABLE_SCHEMA + name: SQLITE_DBCONFIG_WRITABLE_SCHEMA + uid: sqlite3.SQLITE_DBCONFIG_WRITABLE_SCHEMA +- fullName: sqlite3.SQLITE_DENY + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.SQLITE_DENY + name: SQLITE_DENY + uid: sqlite3.SQLITE_DENY +- fullName: sqlite3.SQLITE_IGNORE + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.SQLITE_IGNORE + name: SQLITE_IGNORE + uid: sqlite3.SQLITE_IGNORE +- fullName: sqlite3.SQLITE_OK + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.SQLITE_OK + name: SQLITE_OK + uid: sqlite3.SQLITE_OK +- fullName: sqlite3.apilevel + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.apilevel + name: apilevel + uid: sqlite3.apilevel +- fullName: sqlite3.paramstyle + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.paramstyle + name: paramstyle + uid: sqlite3.paramstyle +- fullName: sqlite3.sqlite_version + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.sqlite_version + name: sqlite_version + uid: sqlite3.sqlite_version +- fullName: sqlite3.sqlite_version_info + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.sqlite_version_info + name: sqlite_version_info + uid: sqlite3.sqlite_version_info +- fullName: sqlite3.threadsafety + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.threadsafety + name: threadsafety + uid: sqlite3.threadsafety +- fullName: sqlite3.version + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.version + name: version + uid: sqlite3.version +- fullName: sqlite3.version_info + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.version_info + name: version_info + uid: sqlite3.version_info +- fullName: ssl.ALERT_DESCRIPTION_HANDSHAKE_FAILURE + href: https://docs.python.org/3/library/ssl.html#ssl.ALERT_DESCRIPTION_HANDSHAKE_FAILURE + name: ALERT_DESCRIPTION_HANDSHAKE_FAILURE + uid: ssl.ALERT_DESCRIPTION_HANDSHAKE_FAILURE +- fullName: ssl.ALERT_DESCRIPTION_INTERNAL_ERROR + href: https://docs.python.org/3/library/ssl.html#ssl.ALERT_DESCRIPTION_INTERNAL_ERROR + name: ALERT_DESCRIPTION_INTERNAL_ERROR + uid: ssl.ALERT_DESCRIPTION_INTERNAL_ERROR +- fullName: ssl.CERT_NONE + href: https://docs.python.org/3/library/ssl.html#ssl.CERT_NONE + name: CERT_NONE + uid: ssl.CERT_NONE +- fullName: ssl.CERT_OPTIONAL + href: https://docs.python.org/3/library/ssl.html#ssl.CERT_OPTIONAL + name: CERT_OPTIONAL + uid: ssl.CERT_OPTIONAL +- fullName: ssl.CERT_REQUIRED + href: https://docs.python.org/3/library/ssl.html#ssl.CERT_REQUIRED + name: CERT_REQUIRED + uid: ssl.CERT_REQUIRED +- fullName: ssl.CHANNEL_BINDING_TYPES + href: https://docs.python.org/3/library/ssl.html#ssl.CHANNEL_BINDING_TYPES + name: CHANNEL_BINDING_TYPES + uid: ssl.CHANNEL_BINDING_TYPES +- fullName: ssl.HAS_ALPN + href: https://docs.python.org/3/library/ssl.html#ssl.HAS_ALPN + name: HAS_ALPN + uid: ssl.HAS_ALPN +- fullName: ssl.HAS_ECDH + href: https://docs.python.org/3/library/ssl.html#ssl.HAS_ECDH + name: HAS_ECDH + uid: ssl.HAS_ECDH +- fullName: ssl.HAS_NEVER_CHECK_COMMON_NAME + href: https://docs.python.org/3/library/ssl.html#ssl.HAS_NEVER_CHECK_COMMON_NAME + name: HAS_NEVER_CHECK_COMMON_NAME + uid: ssl.HAS_NEVER_CHECK_COMMON_NAME +- fullName: ssl.HAS_NPN + href: https://docs.python.org/3/library/ssl.html#ssl.HAS_NPN + name: HAS_NPN + uid: ssl.HAS_NPN +- fullName: ssl.HAS_PSK + href: https://docs.python.org/3/library/ssl.html#ssl.HAS_PSK + name: HAS_PSK + uid: ssl.HAS_PSK +- fullName: ssl.HAS_SNI + href: https://docs.python.org/3/library/ssl.html#ssl.HAS_SNI + name: HAS_SNI + uid: ssl.HAS_SNI +- fullName: ssl.HAS_SSLv2 + href: https://docs.python.org/3/library/ssl.html#ssl.HAS_SSLv2 + name: HAS_SSLv2 + uid: ssl.HAS_SSLv2 +- fullName: ssl.HAS_SSLv3 + href: https://docs.python.org/3/library/ssl.html#ssl.HAS_SSLv3 + name: HAS_SSLv3 + uid: ssl.HAS_SSLv3 +- fullName: ssl.HAS_TLSv1 + href: https://docs.python.org/3/library/ssl.html#ssl.HAS_TLSv1 + name: HAS_TLSv1 + uid: ssl.HAS_TLSv1 +- fullName: ssl.HAS_TLSv1_1 + href: https://docs.python.org/3/library/ssl.html#ssl.HAS_TLSv1_1 + name: HAS_TLSv1_1 + uid: ssl.HAS_TLSv1_1 +- fullName: ssl.HAS_TLSv1_2 + href: https://docs.python.org/3/library/ssl.html#ssl.HAS_TLSv1_2 + name: HAS_TLSv1_2 + uid: ssl.HAS_TLSv1_2 +- fullName: ssl.HAS_TLSv1_3 + href: https://docs.python.org/3/library/ssl.html#ssl.HAS_TLSv1_3 + name: HAS_TLSv1_3 + uid: ssl.HAS_TLSv1_3 +- fullName: ssl.OPENSSL_VERSION + href: https://docs.python.org/3/library/ssl.html#ssl.OPENSSL_VERSION + name: OPENSSL_VERSION + uid: ssl.OPENSSL_VERSION +- fullName: ssl.OPENSSL_VERSION_INFO + href: https://docs.python.org/3/library/ssl.html#ssl.OPENSSL_VERSION_INFO + name: OPENSSL_VERSION_INFO + uid: ssl.OPENSSL_VERSION_INFO +- fullName: ssl.OPENSSL_VERSION_NUMBER + href: https://docs.python.org/3/library/ssl.html#ssl.OPENSSL_VERSION_NUMBER + name: OPENSSL_VERSION_NUMBER + uid: ssl.OPENSSL_VERSION_NUMBER +- fullName: ssl.OP_ALL + href: https://docs.python.org/3/library/ssl.html#ssl.OP_ALL + name: OP_ALL + uid: ssl.OP_ALL +- fullName: ssl.OP_CIPHER_SERVER_PREFERENCE + href: https://docs.python.org/3/library/ssl.html#ssl.OP_CIPHER_SERVER_PREFERENCE + name: OP_CIPHER_SERVER_PREFERENCE + uid: ssl.OP_CIPHER_SERVER_PREFERENCE +- fullName: ssl.OP_ENABLE_KTLS + href: https://docs.python.org/3/library/ssl.html#ssl.OP_ENABLE_KTLS + name: OP_ENABLE_KTLS + uid: ssl.OP_ENABLE_KTLS +- fullName: ssl.OP_ENABLE_MIDDLEBOX_COMPAT + href: https://docs.python.org/3/library/ssl.html#ssl.OP_ENABLE_MIDDLEBOX_COMPAT + name: OP_ENABLE_MIDDLEBOX_COMPAT + uid: ssl.OP_ENABLE_MIDDLEBOX_COMPAT +- fullName: ssl.OP_IGNORE_UNEXPECTED_EOF + href: https://docs.python.org/3/library/ssl.html#ssl.OP_IGNORE_UNEXPECTED_EOF + name: OP_IGNORE_UNEXPECTED_EOF + uid: ssl.OP_IGNORE_UNEXPECTED_EOF +- fullName: ssl.OP_LEGACY_SERVER_CONNECT + href: https://docs.python.org/3/library/ssl.html#ssl.OP_LEGACY_SERVER_CONNECT + name: OP_LEGACY_SERVER_CONNECT + uid: ssl.OP_LEGACY_SERVER_CONNECT +- fullName: ssl.OP_NO_COMPRESSION + href: https://docs.python.org/3/library/ssl.html#ssl.OP_NO_COMPRESSION + name: OP_NO_COMPRESSION + uid: ssl.OP_NO_COMPRESSION +- fullName: ssl.OP_NO_RENEGOTIATION + href: https://docs.python.org/3/library/ssl.html#ssl.OP_NO_RENEGOTIATION + name: OP_NO_RENEGOTIATION + uid: ssl.OP_NO_RENEGOTIATION +- fullName: ssl.OP_NO_SSLv2 + href: https://docs.python.org/3/library/ssl.html#ssl.OP_NO_SSLv2 + name: OP_NO_SSLv2 + uid: ssl.OP_NO_SSLv2 +- fullName: ssl.OP_NO_SSLv3 + href: https://docs.python.org/3/library/ssl.html#ssl.OP_NO_SSLv3 + name: OP_NO_SSLv3 + uid: ssl.OP_NO_SSLv3 +- fullName: ssl.OP_NO_TICKET + href: https://docs.python.org/3/library/ssl.html#ssl.OP_NO_TICKET + name: OP_NO_TICKET + uid: ssl.OP_NO_TICKET +- fullName: ssl.OP_NO_TLSv1 + href: https://docs.python.org/3/library/ssl.html#ssl.OP_NO_TLSv1 + name: OP_NO_TLSv1 + uid: ssl.OP_NO_TLSv1 +- fullName: ssl.OP_NO_TLSv1_1 + href: https://docs.python.org/3/library/ssl.html#ssl.OP_NO_TLSv1_1 + name: OP_NO_TLSv1_1 + uid: ssl.OP_NO_TLSv1_1 +- fullName: ssl.OP_NO_TLSv1_2 + href: https://docs.python.org/3/library/ssl.html#ssl.OP_NO_TLSv1_2 + name: OP_NO_TLSv1_2 + uid: ssl.OP_NO_TLSv1_2 +- fullName: ssl.OP_NO_TLSv1_3 + href: https://docs.python.org/3/library/ssl.html#ssl.OP_NO_TLSv1_3 + name: OP_NO_TLSv1_3 + uid: ssl.OP_NO_TLSv1_3 +- fullName: ssl.OP_SINGLE_DH_USE + href: https://docs.python.org/3/library/ssl.html#ssl.OP_SINGLE_DH_USE + name: OP_SINGLE_DH_USE + uid: ssl.OP_SINGLE_DH_USE +- fullName: ssl.OP_SINGLE_ECDH_USE + href: https://docs.python.org/3/library/ssl.html#ssl.OP_SINGLE_ECDH_USE + name: OP_SINGLE_ECDH_USE + uid: ssl.OP_SINGLE_ECDH_USE +- fullName: ssl.PROTOCOL_SSLv23 + href: https://docs.python.org/3/library/ssl.html#ssl.PROTOCOL_SSLv23 + name: PROTOCOL_SSLv23 + uid: ssl.PROTOCOL_SSLv23 +- fullName: ssl.PROTOCOL_SSLv3 + href: https://docs.python.org/3/library/ssl.html#ssl.PROTOCOL_SSLv3 + name: PROTOCOL_SSLv3 + uid: ssl.PROTOCOL_SSLv3 +- fullName: ssl.PROTOCOL_TLS + href: https://docs.python.org/3/library/ssl.html#ssl.PROTOCOL_TLS + name: PROTOCOL_TLS + uid: ssl.PROTOCOL_TLS +- fullName: ssl.PROTOCOL_TLS_CLIENT + href: https://docs.python.org/3/library/ssl.html#ssl.PROTOCOL_TLS_CLIENT + name: PROTOCOL_TLS_CLIENT + uid: ssl.PROTOCOL_TLS_CLIENT +- fullName: ssl.PROTOCOL_TLS_SERVER + href: https://docs.python.org/3/library/ssl.html#ssl.PROTOCOL_TLS_SERVER + name: PROTOCOL_TLS_SERVER + uid: ssl.PROTOCOL_TLS_SERVER +- fullName: ssl.PROTOCOL_TLSv1 + href: https://docs.python.org/3/library/ssl.html#ssl.PROTOCOL_TLSv1 + name: PROTOCOL_TLSv1 + uid: ssl.PROTOCOL_TLSv1 +- fullName: ssl.PROTOCOL_TLSv1_1 + href: https://docs.python.org/3/library/ssl.html#ssl.PROTOCOL_TLSv1_1 + name: PROTOCOL_TLSv1_1 + uid: ssl.PROTOCOL_TLSv1_1 +- fullName: ssl.PROTOCOL_TLSv1_2 + href: https://docs.python.org/3/library/ssl.html#ssl.PROTOCOL_TLSv1_2 + name: PROTOCOL_TLSv1_2 + uid: ssl.PROTOCOL_TLSv1_2 +- fullName: ssl.Purpose.CLIENT_AUTH + href: https://docs.python.org/3/library/ssl.html#ssl.Purpose.CLIENT_AUTH + name: CLIENT_AUTH + uid: ssl.Purpose.CLIENT_AUTH +- fullName: ssl.Purpose.SERVER_AUTH + href: https://docs.python.org/3/library/ssl.html#ssl.Purpose.SERVER_AUTH + name: SERVER_AUTH + uid: ssl.Purpose.SERVER_AUTH +- fullName: ssl.VERIFY_ALLOW_PROXY_CERTS + href: https://docs.python.org/3/library/ssl.html#ssl.VERIFY_ALLOW_PROXY_CERTS + name: VERIFY_ALLOW_PROXY_CERTS + uid: ssl.VERIFY_ALLOW_PROXY_CERTS +- fullName: ssl.VERIFY_CRL_CHECK_CHAIN + href: https://docs.python.org/3/library/ssl.html#ssl.VERIFY_CRL_CHECK_CHAIN + name: VERIFY_CRL_CHECK_CHAIN + uid: ssl.VERIFY_CRL_CHECK_CHAIN +- fullName: ssl.VERIFY_CRL_CHECK_LEAF + href: https://docs.python.org/3/library/ssl.html#ssl.VERIFY_CRL_CHECK_LEAF + name: VERIFY_CRL_CHECK_LEAF + uid: ssl.VERIFY_CRL_CHECK_LEAF +- fullName: ssl.VERIFY_DEFAULT + href: https://docs.python.org/3/library/ssl.html#ssl.VERIFY_DEFAULT + name: VERIFY_DEFAULT + uid: ssl.VERIFY_DEFAULT +- fullName: ssl.VERIFY_X509_PARTIAL_CHAIN + href: https://docs.python.org/3/library/ssl.html#ssl.VERIFY_X509_PARTIAL_CHAIN + name: VERIFY_X509_PARTIAL_CHAIN + uid: ssl.VERIFY_X509_PARTIAL_CHAIN +- fullName: ssl.VERIFY_X509_STRICT + href: https://docs.python.org/3/library/ssl.html#ssl.VERIFY_X509_STRICT + name: VERIFY_X509_STRICT + uid: ssl.VERIFY_X509_STRICT +- fullName: ssl.VERIFY_X509_TRUSTED_FIRST + href: https://docs.python.org/3/library/ssl.html#ssl.VERIFY_X509_TRUSTED_FIRST + name: VERIFY_X509_TRUSTED_FIRST + uid: ssl.VERIFY_X509_TRUSTED_FIRST +- fullName: stat.FILE_ATTRIBUTE_ARCHIVE + href: https://docs.python.org/3/library/stat.html#stat.FILE_ATTRIBUTE_ARCHIVE + name: FILE_ATTRIBUTE_ARCHIVE + uid: stat.FILE_ATTRIBUTE_ARCHIVE +- fullName: stat.FILE_ATTRIBUTE_COMPRESSED + href: https://docs.python.org/3/library/stat.html#stat.FILE_ATTRIBUTE_COMPRESSED + name: FILE_ATTRIBUTE_COMPRESSED + uid: stat.FILE_ATTRIBUTE_COMPRESSED +- fullName: stat.FILE_ATTRIBUTE_DEVICE + href: https://docs.python.org/3/library/stat.html#stat.FILE_ATTRIBUTE_DEVICE + name: FILE_ATTRIBUTE_DEVICE + uid: stat.FILE_ATTRIBUTE_DEVICE +- fullName: stat.FILE_ATTRIBUTE_DIRECTORY + href: https://docs.python.org/3/library/stat.html#stat.FILE_ATTRIBUTE_DIRECTORY + name: FILE_ATTRIBUTE_DIRECTORY + uid: stat.FILE_ATTRIBUTE_DIRECTORY +- fullName: stat.FILE_ATTRIBUTE_ENCRYPTED + href: https://docs.python.org/3/library/stat.html#stat.FILE_ATTRIBUTE_ENCRYPTED + name: FILE_ATTRIBUTE_ENCRYPTED + uid: stat.FILE_ATTRIBUTE_ENCRYPTED +- fullName: stat.FILE_ATTRIBUTE_HIDDEN + href: https://docs.python.org/3/library/stat.html#stat.FILE_ATTRIBUTE_HIDDEN + name: FILE_ATTRIBUTE_HIDDEN + uid: stat.FILE_ATTRIBUTE_HIDDEN +- fullName: stat.FILE_ATTRIBUTE_INTEGRITY_STREAM + href: https://docs.python.org/3/library/stat.html#stat.FILE_ATTRIBUTE_INTEGRITY_STREAM + name: FILE_ATTRIBUTE_INTEGRITY_STREAM + uid: stat.FILE_ATTRIBUTE_INTEGRITY_STREAM +- fullName: stat.FILE_ATTRIBUTE_NORMAL + href: https://docs.python.org/3/library/stat.html#stat.FILE_ATTRIBUTE_NORMAL + name: FILE_ATTRIBUTE_NORMAL + uid: stat.FILE_ATTRIBUTE_NORMAL +- fullName: stat.FILE_ATTRIBUTE_NOT_CONTENT_INDEXED + href: https://docs.python.org/3/library/stat.html#stat.FILE_ATTRIBUTE_NOT_CONTENT_INDEXED + name: FILE_ATTRIBUTE_NOT_CONTENT_INDEXED + uid: stat.FILE_ATTRIBUTE_NOT_CONTENT_INDEXED +- fullName: stat.FILE_ATTRIBUTE_NO_SCRUB_DATA + href: https://docs.python.org/3/library/stat.html#stat.FILE_ATTRIBUTE_NO_SCRUB_DATA + name: FILE_ATTRIBUTE_NO_SCRUB_DATA + uid: stat.FILE_ATTRIBUTE_NO_SCRUB_DATA +- fullName: stat.FILE_ATTRIBUTE_OFFLINE + href: https://docs.python.org/3/library/stat.html#stat.FILE_ATTRIBUTE_OFFLINE + name: FILE_ATTRIBUTE_OFFLINE + uid: stat.FILE_ATTRIBUTE_OFFLINE +- fullName: stat.FILE_ATTRIBUTE_READONLY + href: https://docs.python.org/3/library/stat.html#stat.FILE_ATTRIBUTE_READONLY + name: FILE_ATTRIBUTE_READONLY + uid: stat.FILE_ATTRIBUTE_READONLY +- fullName: stat.FILE_ATTRIBUTE_REPARSE_POINT + href: https://docs.python.org/3/library/stat.html#stat.FILE_ATTRIBUTE_REPARSE_POINT + name: FILE_ATTRIBUTE_REPARSE_POINT + uid: stat.FILE_ATTRIBUTE_REPARSE_POINT +- fullName: stat.FILE_ATTRIBUTE_SPARSE_FILE + href: https://docs.python.org/3/library/stat.html#stat.FILE_ATTRIBUTE_SPARSE_FILE + name: FILE_ATTRIBUTE_SPARSE_FILE + uid: stat.FILE_ATTRIBUTE_SPARSE_FILE +- fullName: stat.FILE_ATTRIBUTE_SYSTEM + href: https://docs.python.org/3/library/stat.html#stat.FILE_ATTRIBUTE_SYSTEM + name: FILE_ATTRIBUTE_SYSTEM + uid: stat.FILE_ATTRIBUTE_SYSTEM +- fullName: stat.FILE_ATTRIBUTE_TEMPORARY + href: https://docs.python.org/3/library/stat.html#stat.FILE_ATTRIBUTE_TEMPORARY + name: FILE_ATTRIBUTE_TEMPORARY + uid: stat.FILE_ATTRIBUTE_TEMPORARY +- fullName: stat.FILE_ATTRIBUTE_VIRTUAL + href: https://docs.python.org/3/library/stat.html#stat.FILE_ATTRIBUTE_VIRTUAL + name: FILE_ATTRIBUTE_VIRTUAL + uid: stat.FILE_ATTRIBUTE_VIRTUAL +- fullName: stat.IO_REPARSE_TAG_APPEXECLINK + href: https://docs.python.org/3/library/stat.html#stat.IO_REPARSE_TAG_APPEXECLINK + name: IO_REPARSE_TAG_APPEXECLINK + uid: stat.IO_REPARSE_TAG_APPEXECLINK +- fullName: stat.IO_REPARSE_TAG_MOUNT_POINT + href: https://docs.python.org/3/library/stat.html#stat.IO_REPARSE_TAG_MOUNT_POINT + name: IO_REPARSE_TAG_MOUNT_POINT + uid: stat.IO_REPARSE_TAG_MOUNT_POINT +- fullName: stat.IO_REPARSE_TAG_SYMLINK + href: https://docs.python.org/3/library/stat.html#stat.IO_REPARSE_TAG_SYMLINK + name: IO_REPARSE_TAG_SYMLINK + uid: stat.IO_REPARSE_TAG_SYMLINK +- fullName: stat.SF_APPEND + href: https://docs.python.org/3/library/stat.html#stat.SF_APPEND + name: SF_APPEND + uid: stat.SF_APPEND +- fullName: stat.SF_ARCHIVED + href: https://docs.python.org/3/library/stat.html#stat.SF_ARCHIVED + name: SF_ARCHIVED + uid: stat.SF_ARCHIVED +- fullName: stat.SF_DATALESS + href: https://docs.python.org/3/library/stat.html#stat.SF_DATALESS + name: SF_DATALESS + uid: stat.SF_DATALESS +- fullName: stat.SF_FIRMLINK + href: https://docs.python.org/3/library/stat.html#stat.SF_FIRMLINK + name: SF_FIRMLINK + uid: stat.SF_FIRMLINK +- fullName: stat.SF_IMMUTABLE + href: https://docs.python.org/3/library/stat.html#stat.SF_IMMUTABLE + name: SF_IMMUTABLE + uid: stat.SF_IMMUTABLE +- fullName: stat.SF_NOUNLINK + href: https://docs.python.org/3/library/stat.html#stat.SF_NOUNLINK + name: SF_NOUNLINK + uid: stat.SF_NOUNLINK +- fullName: stat.SF_RESTRICTED + href: https://docs.python.org/3/library/stat.html#stat.SF_RESTRICTED + name: SF_RESTRICTED + uid: stat.SF_RESTRICTED +- fullName: stat.SF_SETTABLE + href: https://docs.python.org/3/library/stat.html#stat.SF_SETTABLE + name: SF_SETTABLE + uid: stat.SF_SETTABLE +- fullName: stat.SF_SNAPSHOT + href: https://docs.python.org/3/library/stat.html#stat.SF_SNAPSHOT + name: SF_SNAPSHOT + uid: stat.SF_SNAPSHOT +- fullName: stat.SF_SUPPORTED + href: https://docs.python.org/3/library/stat.html#stat.SF_SUPPORTED + name: SF_SUPPORTED + uid: stat.SF_SUPPORTED +- fullName: stat.SF_SYNTHETIC + href: https://docs.python.org/3/library/stat.html#stat.SF_SYNTHETIC + name: SF_SYNTHETIC + uid: stat.SF_SYNTHETIC +- fullName: stat.ST_ATIME + href: https://docs.python.org/3/library/stat.html#stat.ST_ATIME + name: ST_ATIME + uid: stat.ST_ATIME +- fullName: stat.ST_CTIME + href: https://docs.python.org/3/library/stat.html#stat.ST_CTIME + name: ST_CTIME + uid: stat.ST_CTIME +- fullName: stat.ST_DEV + href: https://docs.python.org/3/library/stat.html#stat.ST_DEV + name: ST_DEV + uid: stat.ST_DEV +- fullName: stat.ST_GID + href: https://docs.python.org/3/library/stat.html#stat.ST_GID + name: ST_GID + uid: stat.ST_GID +- fullName: stat.ST_INO + href: https://docs.python.org/3/library/stat.html#stat.ST_INO + name: ST_INO + uid: stat.ST_INO +- fullName: stat.ST_MODE + href: https://docs.python.org/3/library/stat.html#stat.ST_MODE + name: ST_MODE + uid: stat.ST_MODE +- fullName: stat.ST_MTIME + href: https://docs.python.org/3/library/stat.html#stat.ST_MTIME + name: ST_MTIME + uid: stat.ST_MTIME +- fullName: stat.ST_NLINK + href: https://docs.python.org/3/library/stat.html#stat.ST_NLINK + name: ST_NLINK + uid: stat.ST_NLINK +- fullName: stat.ST_SIZE + href: https://docs.python.org/3/library/stat.html#stat.ST_SIZE + name: ST_SIZE + uid: stat.ST_SIZE +- fullName: stat.ST_UID + href: https://docs.python.org/3/library/stat.html#stat.ST_UID + name: ST_UID + uid: stat.ST_UID +- fullName: stat.S_ENFMT + href: https://docs.python.org/3/library/stat.html#stat.S_ENFMT + name: S_ENFMT + uid: stat.S_ENFMT +- fullName: stat.S_IEXEC + href: https://docs.python.org/3/library/stat.html#stat.S_IEXEC + name: S_IEXEC + uid: stat.S_IEXEC +- fullName: stat.S_IFBLK + href: https://docs.python.org/3/library/stat.html#stat.S_IFBLK + name: S_IFBLK + uid: stat.S_IFBLK +- fullName: stat.S_IFCHR + href: https://docs.python.org/3/library/stat.html#stat.S_IFCHR + name: S_IFCHR + uid: stat.S_IFCHR +- fullName: stat.S_IFDIR + href: https://docs.python.org/3/library/stat.html#stat.S_IFDIR + name: S_IFDIR + uid: stat.S_IFDIR +- fullName: stat.S_IFDOOR + href: https://docs.python.org/3/library/stat.html#stat.S_IFDOOR + name: S_IFDOOR + uid: stat.S_IFDOOR +- fullName: stat.S_IFIFO + href: https://docs.python.org/3/library/stat.html#stat.S_IFIFO + name: S_IFIFO + uid: stat.S_IFIFO +- fullName: stat.S_IFLNK + href: https://docs.python.org/3/library/stat.html#stat.S_IFLNK + name: S_IFLNK + uid: stat.S_IFLNK +- fullName: stat.S_IFPORT + href: https://docs.python.org/3/library/stat.html#stat.S_IFPORT + name: S_IFPORT + uid: stat.S_IFPORT +- fullName: stat.S_IFREG + href: https://docs.python.org/3/library/stat.html#stat.S_IFREG + name: S_IFREG + uid: stat.S_IFREG +- fullName: stat.S_IFSOCK + href: https://docs.python.org/3/library/stat.html#stat.S_IFSOCK + name: S_IFSOCK + uid: stat.S_IFSOCK +- fullName: stat.S_IFWHT + href: https://docs.python.org/3/library/stat.html#stat.S_IFWHT + name: S_IFWHT + uid: stat.S_IFWHT +- fullName: stat.S_IREAD + href: https://docs.python.org/3/library/stat.html#stat.S_IREAD + name: S_IREAD + uid: stat.S_IREAD +- fullName: stat.S_IRGRP + href: https://docs.python.org/3/library/stat.html#stat.S_IRGRP + name: S_IRGRP + uid: stat.S_IRGRP +- fullName: stat.S_IROTH + href: https://docs.python.org/3/library/stat.html#stat.S_IROTH + name: S_IROTH + uid: stat.S_IROTH +- fullName: stat.S_IRUSR + href: https://docs.python.org/3/library/stat.html#stat.S_IRUSR + name: S_IRUSR + uid: stat.S_IRUSR +- fullName: stat.S_IRWXG + href: https://docs.python.org/3/library/stat.html#stat.S_IRWXG + name: S_IRWXG + uid: stat.S_IRWXG +- fullName: stat.S_IRWXO + href: https://docs.python.org/3/library/stat.html#stat.S_IRWXO + name: S_IRWXO + uid: stat.S_IRWXO +- fullName: stat.S_IRWXU + href: https://docs.python.org/3/library/stat.html#stat.S_IRWXU + name: S_IRWXU + uid: stat.S_IRWXU +- fullName: stat.S_ISGID + href: https://docs.python.org/3/library/stat.html#stat.S_ISGID + name: S_ISGID + uid: stat.S_ISGID +- fullName: stat.S_ISUID + href: https://docs.python.org/3/library/stat.html#stat.S_ISUID + name: S_ISUID + uid: stat.S_ISUID +- fullName: stat.S_ISVTX + href: https://docs.python.org/3/library/stat.html#stat.S_ISVTX + name: S_ISVTX + uid: stat.S_ISVTX +- fullName: stat.S_IWGRP + href: https://docs.python.org/3/library/stat.html#stat.S_IWGRP + name: S_IWGRP + uid: stat.S_IWGRP +- fullName: stat.S_IWOTH + href: https://docs.python.org/3/library/stat.html#stat.S_IWOTH + name: S_IWOTH + uid: stat.S_IWOTH +- fullName: stat.S_IWRITE + href: https://docs.python.org/3/library/stat.html#stat.S_IWRITE + name: S_IWRITE + uid: stat.S_IWRITE +- fullName: stat.S_IWUSR + href: https://docs.python.org/3/library/stat.html#stat.S_IWUSR + name: S_IWUSR + uid: stat.S_IWUSR +- fullName: stat.S_IXGRP + href: https://docs.python.org/3/library/stat.html#stat.S_IXGRP + name: S_IXGRP + uid: stat.S_IXGRP +- fullName: stat.S_IXOTH + href: https://docs.python.org/3/library/stat.html#stat.S_IXOTH + name: S_IXOTH + uid: stat.S_IXOTH +- fullName: stat.S_IXUSR + href: https://docs.python.org/3/library/stat.html#stat.S_IXUSR + name: S_IXUSR + uid: stat.S_IXUSR +- fullName: stat.UF_APPEND + href: https://docs.python.org/3/library/stat.html#stat.UF_APPEND + name: UF_APPEND + uid: stat.UF_APPEND +- fullName: stat.UF_COMPRESSED + href: https://docs.python.org/3/library/stat.html#stat.UF_COMPRESSED + name: UF_COMPRESSED + uid: stat.UF_COMPRESSED +- fullName: stat.UF_DATAVAULT + href: https://docs.python.org/3/library/stat.html#stat.UF_DATAVAULT + name: UF_DATAVAULT + uid: stat.UF_DATAVAULT +- fullName: stat.UF_HIDDEN + href: https://docs.python.org/3/library/stat.html#stat.UF_HIDDEN + name: UF_HIDDEN + uid: stat.UF_HIDDEN +- fullName: stat.UF_IMMUTABLE + href: https://docs.python.org/3/library/stat.html#stat.UF_IMMUTABLE + name: UF_IMMUTABLE + uid: stat.UF_IMMUTABLE +- fullName: stat.UF_NODUMP + href: https://docs.python.org/3/library/stat.html#stat.UF_NODUMP + name: UF_NODUMP + uid: stat.UF_NODUMP +- fullName: stat.UF_NOUNLINK + href: https://docs.python.org/3/library/stat.html#stat.UF_NOUNLINK + name: UF_NOUNLINK + uid: stat.UF_NOUNLINK +- fullName: stat.UF_OPAQUE + href: https://docs.python.org/3/library/stat.html#stat.UF_OPAQUE + name: UF_OPAQUE + uid: stat.UF_OPAQUE +- fullName: stat.UF_SETTABLE + href: https://docs.python.org/3/library/stat.html#stat.UF_SETTABLE + name: UF_SETTABLE + uid: stat.UF_SETTABLE +- fullName: stat.UF_TRACKED + href: https://docs.python.org/3/library/stat.html#stat.UF_TRACKED + name: UF_TRACKED + uid: stat.UF_TRACKED +- fullName: string.ascii_letters + href: https://docs.python.org/3/library/string.html#string.ascii_letters + name: ascii_letters + uid: string.ascii_letters +- fullName: string.ascii_lowercase + href: https://docs.python.org/3/library/string.html#string.ascii_lowercase + name: ascii_lowercase + uid: string.ascii_lowercase +- fullName: string.ascii_uppercase + href: https://docs.python.org/3/library/string.html#string.ascii_uppercase + name: ascii_uppercase + uid: string.ascii_uppercase +- fullName: string.digits + href: https://docs.python.org/3/library/string.html#string.digits + name: digits + uid: string.digits +- fullName: string.hexdigits + href: https://docs.python.org/3/library/string.html#string.hexdigits + name: hexdigits + uid: string.hexdigits +- fullName: string.octdigits + href: https://docs.python.org/3/library/string.html#string.octdigits + name: octdigits + uid: string.octdigits +- fullName: string.printable + href: https://docs.python.org/3/library/string.html#string.printable + name: printable + uid: string.printable +- fullName: string.punctuation + href: https://docs.python.org/3/library/string.html#string.punctuation + name: punctuation + uid: string.punctuation +- fullName: string.whitespace + href: https://docs.python.org/3/library/string.html#string.whitespace + name: whitespace + uid: string.whitespace +- fullName: subprocess.ABOVE_NORMAL_PRIORITY_CLASS + href: https://docs.python.org/3/library/subprocess.html#subprocess.ABOVE_NORMAL_PRIORITY_CLASS + name: ABOVE_NORMAL_PRIORITY_CLASS + uid: subprocess.ABOVE_NORMAL_PRIORITY_CLASS +- fullName: subprocess.BELOW_NORMAL_PRIORITY_CLASS + href: https://docs.python.org/3/library/subprocess.html#subprocess.BELOW_NORMAL_PRIORITY_CLASS + name: BELOW_NORMAL_PRIORITY_CLASS + uid: subprocess.BELOW_NORMAL_PRIORITY_CLASS +- fullName: subprocess.CREATE_BREAKAWAY_FROM_JOB + href: https://docs.python.org/3/library/subprocess.html#subprocess.CREATE_BREAKAWAY_FROM_JOB + name: CREATE_BREAKAWAY_FROM_JOB + uid: subprocess.CREATE_BREAKAWAY_FROM_JOB +- fullName: subprocess.CREATE_DEFAULT_ERROR_MODE + href: https://docs.python.org/3/library/subprocess.html#subprocess.CREATE_DEFAULT_ERROR_MODE + name: CREATE_DEFAULT_ERROR_MODE + uid: subprocess.CREATE_DEFAULT_ERROR_MODE +- fullName: subprocess.CREATE_NEW_CONSOLE + href: https://docs.python.org/3/library/subprocess.html#subprocess.CREATE_NEW_CONSOLE + name: CREATE_NEW_CONSOLE + uid: subprocess.CREATE_NEW_CONSOLE +- fullName: subprocess.CREATE_NEW_PROCESS_GROUP + href: https://docs.python.org/3/library/subprocess.html#subprocess.CREATE_NEW_PROCESS_GROUP + name: CREATE_NEW_PROCESS_GROUP + uid: subprocess.CREATE_NEW_PROCESS_GROUP +- fullName: subprocess.CREATE_NO_WINDOW + href: https://docs.python.org/3/library/subprocess.html#subprocess.CREATE_NO_WINDOW + name: CREATE_NO_WINDOW + uid: subprocess.CREATE_NO_WINDOW +- fullName: subprocess.DETACHED_PROCESS + href: https://docs.python.org/3/library/subprocess.html#subprocess.DETACHED_PROCESS + name: DETACHED_PROCESS + uid: subprocess.DETACHED_PROCESS +- fullName: subprocess.DEVNULL + href: https://docs.python.org/3/library/subprocess.html#subprocess.DEVNULL + name: DEVNULL + uid: subprocess.DEVNULL +- fullName: subprocess.HIGH_PRIORITY_CLASS + href: https://docs.python.org/3/library/subprocess.html#subprocess.HIGH_PRIORITY_CLASS + name: HIGH_PRIORITY_CLASS + uid: subprocess.HIGH_PRIORITY_CLASS +- fullName: subprocess.IDLE_PRIORITY_CLASS + href: https://docs.python.org/3/library/subprocess.html#subprocess.IDLE_PRIORITY_CLASS + name: IDLE_PRIORITY_CLASS + uid: subprocess.IDLE_PRIORITY_CLASS +- fullName: subprocess.NORMAL_PRIORITY_CLASS + href: https://docs.python.org/3/library/subprocess.html#subprocess.NORMAL_PRIORITY_CLASS + name: NORMAL_PRIORITY_CLASS + uid: subprocess.NORMAL_PRIORITY_CLASS +- fullName: subprocess.PIPE + href: https://docs.python.org/3/library/subprocess.html#subprocess.PIPE + name: PIPE + uid: subprocess.PIPE +- fullName: subprocess.REALTIME_PRIORITY_CLASS + href: https://docs.python.org/3/library/subprocess.html#subprocess.REALTIME_PRIORITY_CLASS + name: REALTIME_PRIORITY_CLASS + uid: subprocess.REALTIME_PRIORITY_CLASS +- fullName: subprocess.STARTF_FORCEOFFFEEDBACK + href: https://docs.python.org/3/library/subprocess.html#subprocess.STARTF_FORCEOFFFEEDBACK + name: STARTF_FORCEOFFFEEDBACK + uid: subprocess.STARTF_FORCEOFFFEEDBACK +- fullName: subprocess.STARTF_FORCEONFEEDBACK + href: https://docs.python.org/3/library/subprocess.html#subprocess.STARTF_FORCEONFEEDBACK + name: STARTF_FORCEONFEEDBACK + uid: subprocess.STARTF_FORCEONFEEDBACK +- fullName: subprocess.STARTF_USESHOWWINDOW + href: https://docs.python.org/3/library/subprocess.html#subprocess.STARTF_USESHOWWINDOW + name: STARTF_USESHOWWINDOW + uid: subprocess.STARTF_USESHOWWINDOW +- fullName: subprocess.STARTF_USESTDHANDLES + href: https://docs.python.org/3/library/subprocess.html#subprocess.STARTF_USESTDHANDLES + name: STARTF_USESTDHANDLES + uid: subprocess.STARTF_USESTDHANDLES +- fullName: subprocess.STDOUT + href: https://docs.python.org/3/library/subprocess.html#subprocess.STDOUT + name: STDOUT + uid: subprocess.STDOUT +- fullName: subprocess.STD_ERROR_HANDLE + href: https://docs.python.org/3/library/subprocess.html#subprocess.STD_ERROR_HANDLE + name: STD_ERROR_HANDLE + uid: subprocess.STD_ERROR_HANDLE +- fullName: subprocess.STD_INPUT_HANDLE + href: https://docs.python.org/3/library/subprocess.html#subprocess.STD_INPUT_HANDLE + name: STD_INPUT_HANDLE + uid: subprocess.STD_INPUT_HANDLE +- fullName: subprocess.STD_OUTPUT_HANDLE + href: https://docs.python.org/3/library/subprocess.html#subprocess.STD_OUTPUT_HANDLE + name: STD_OUTPUT_HANDLE + uid: subprocess.STD_OUTPUT_HANDLE +- fullName: subprocess.SW_HIDE + href: https://docs.python.org/3/library/subprocess.html#subprocess.SW_HIDE + name: SW_HIDE + uid: subprocess.SW_HIDE +- fullName: sys.__breakpointhook__ + href: https://docs.python.org/3/library/sys.html#sys.__breakpointhook__ + name: __breakpointhook__ + uid: sys.__breakpointhook__ +- fullName: sys.__displayhook__ + href: https://docs.python.org/3/library/sys.html#sys.__displayhook__ + name: __displayhook__ + uid: sys.__displayhook__ +- fullName: sys.__excepthook__ + href: https://docs.python.org/3/library/sys.html#sys.__excepthook__ + name: __excepthook__ + uid: sys.__excepthook__ +- fullName: sys.__interactivehook__ + href: https://docs.python.org/3/library/sys.html#sys.__interactivehook__ + name: __interactivehook__ + uid: sys.__interactivehook__ +- fullName: sys.__stderr__ + href: https://docs.python.org/3/library/sys.html#sys.__stderr__ + name: __stderr__ + uid: sys.__stderr__ +- fullName: sys.__stdin__ + href: https://docs.python.org/3/library/sys.html#sys.__stdin__ + name: __stdin__ + uid: sys.__stdin__ +- fullName: sys.__stdout__ + href: https://docs.python.org/3/library/sys.html#sys.__stdout__ + name: __stdout__ + uid: sys.__stdout__ +- fullName: sys.__unraisablehook__ + href: https://docs.python.org/3/library/sys.html#sys.__unraisablehook__ + name: __unraisablehook__ + uid: sys.__unraisablehook__ +- fullName: sys._emscripten_info + href: https://docs.python.org/3/library/sys.html#sys._emscripten_info + name: _emscripten_info + uid: sys._emscripten_info +- fullName: sys._xoptions + href: https://docs.python.org/3/library/sys.html#sys._xoptions + name: _xoptions + uid: sys._xoptions +- fullName: sys.abiflags + href: https://docs.python.org/3/library/sys.html#sys.abiflags + name: abiflags + uid: sys.abiflags +- fullName: sys.api_version + href: https://docs.python.org/3/library/sys.html#sys.api_version + name: api_version + uid: sys.api_version +- fullName: sys.argv + href: https://docs.python.org/3/library/sys.html#sys.argv + name: argv + uid: sys.argv +- fullName: sys.base_exec_prefix + href: https://docs.python.org/3/library/sys.html#sys.base_exec_prefix + name: base_exec_prefix + uid: sys.base_exec_prefix +- fullName: sys.base_prefix + href: https://docs.python.org/3/library/sys.html#sys.base_prefix + name: base_prefix + uid: sys.base_prefix +- fullName: sys.builtin_module_names + href: https://docs.python.org/3/library/sys.html#sys.builtin_module_names + name: builtin_module_names + uid: sys.builtin_module_names +- fullName: sys.byteorder + href: https://docs.python.org/3/library/sys.html#sys.byteorder + name: byteorder + uid: sys.byteorder +- fullName: sys.copyright + href: https://docs.python.org/3/library/sys.html#sys.copyright + name: copyright + uid: sys.copyright +- fullName: sys.dllhandle + href: https://docs.python.org/3/library/sys.html#sys.dllhandle + name: dllhandle + uid: sys.dllhandle +- fullName: sys.dont_write_bytecode + href: https://docs.python.org/3/library/sys.html#sys.dont_write_bytecode + name: dont_write_bytecode + uid: sys.dont_write_bytecode +- fullName: sys.exec_prefix + href: https://docs.python.org/3/library/sys.html#sys.exec_prefix + name: exec_prefix + uid: sys.exec_prefix +- fullName: sys.executable + href: https://docs.python.org/3/library/sys.html#sys.executable + name: executable + uid: sys.executable +- fullName: sys.flags + href: https://docs.python.org/3/library/sys.html#sys.flags + name: flags + uid: sys.flags +- fullName: sys.float_info + href: https://docs.python.org/3/library/sys.html#sys.float_info + name: float_info + uid: sys.float_info +- fullName: sys.float_repr_style + href: https://docs.python.org/3/library/sys.html#sys.float_repr_style + name: float_repr_style + uid: sys.float_repr_style +- fullName: sys.hash_info + href: https://docs.python.org/3/library/sys.html#sys.hash_info + name: hash_info + uid: sys.hash_info +- fullName: sys.hexversion + href: https://docs.python.org/3/library/sys.html#sys.hexversion + name: hexversion + uid: sys.hexversion +- fullName: sys.implementation + href: https://docs.python.org/3/library/sys.html#sys.implementation + name: implementation + uid: sys.implementation +- fullName: sys.int_info + href: https://docs.python.org/3/library/sys.html#sys.int_info + name: int_info + uid: sys.int_info +- fullName: sys.last_exc + href: https://docs.python.org/3/library/sys.html#sys.last_exc + name: last_exc + uid: sys.last_exc +- fullName: sys.last_traceback + href: https://docs.python.org/3/library/sys.html#sys.last_traceback + name: last_traceback + uid: sys.last_traceback +- fullName: sys.last_type + href: https://docs.python.org/3/library/sys.html#sys.last_type + name: last_type + uid: sys.last_type +- fullName: sys.last_value + href: https://docs.python.org/3/library/sys.html#sys.last_value + name: last_value + uid: sys.last_value +- fullName: sys.maxsize + href: https://docs.python.org/3/library/sys.html#sys.maxsize + name: maxsize + uid: sys.maxsize +- fullName: sys.maxunicode + href: https://docs.python.org/3/library/sys.html#sys.maxunicode + name: maxunicode + uid: sys.maxunicode +- fullName: sys.meta_path + href: https://docs.python.org/3/library/sys.html#sys.meta_path + name: meta_path + uid: sys.meta_path +- fullName: sys.modules + href: https://docs.python.org/3/library/sys.html#sys.modules + name: modules + uid: sys.modules +- fullName: sys.monitoring.DISABLE + href: https://docs.python.org/3/library/sys.monitoring.html#sys.monitoring.DISABLE + name: DISABLE + uid: sys.monitoring.DISABLE +- fullName: sys.monitoring.MISSING + href: https://docs.python.org/3/library/sys.monitoring.html#sys.monitoring.MISSING + name: MISSING + uid: sys.monitoring.MISSING +- fullName: sys.orig_argv + href: https://docs.python.org/3/library/sys.html#sys.orig_argv + name: orig_argv + uid: sys.orig_argv +- fullName: sys.path + href: https://docs.python.org/3/library/sys.html#sys.path + name: path + uid: sys.path +- fullName: sys.path_hooks + href: https://docs.python.org/3/library/sys.html#sys.path_hooks + name: path_hooks + uid: sys.path_hooks +- fullName: sys.path_importer_cache + href: https://docs.python.org/3/library/sys.html#sys.path_importer_cache + name: path_importer_cache + uid: sys.path_importer_cache +- fullName: sys.platform + href: https://docs.python.org/3/library/sys.html#sys.platform + name: platform + uid: sys.platform +- fullName: sys.platlibdir + href: https://docs.python.org/3/library/sys.html#sys.platlibdir + name: platlibdir + uid: sys.platlibdir +- fullName: sys.prefix + href: https://docs.python.org/3/library/sys.html#sys.prefix + name: prefix + uid: sys.prefix +- fullName: sys.ps1 + href: https://docs.python.org/3/library/sys.html#sys.ps1 + name: ps1 + uid: sys.ps1 +- fullName: sys.ps2 + href: https://docs.python.org/3/library/sys.html#sys.ps2 + name: ps2 + uid: sys.ps2 +- fullName: sys.pycache_prefix + href: https://docs.python.org/3/library/sys.html#sys.pycache_prefix + name: pycache_prefix + uid: sys.pycache_prefix +- fullName: sys.stderr + href: https://docs.python.org/3/library/sys.html#sys.stderr + name: stderr + uid: sys.stderr +- fullName: sys.stdin + href: https://docs.python.org/3/library/sys.html#sys.stdin + name: stdin + uid: sys.stdin +- fullName: sys.stdlib_module_names + href: https://docs.python.org/3/library/sys.html#sys.stdlib_module_names + name: stdlib_module_names + uid: sys.stdlib_module_names +- fullName: sys.stdout + href: https://docs.python.org/3/library/sys.html#sys.stdout + name: stdout + uid: sys.stdout +- fullName: sys.thread_info + href: https://docs.python.org/3/library/sys.html#sys.thread_info + name: thread_info + uid: sys.thread_info +- fullName: sys.tracebacklimit + href: https://docs.python.org/3/library/sys.html#sys.tracebacklimit + name: tracebacklimit + uid: sys.tracebacklimit +- fullName: sys.version + href: https://docs.python.org/3/library/sys.html#sys.version + name: version + uid: sys.version +- fullName: sys.version_info + href: https://docs.python.org/3/library/sys.html#sys.version_info + name: version_info + uid: sys.version_info +- fullName: sys.warnoptions + href: https://docs.python.org/3/library/sys.html#sys.warnoptions + name: warnoptions + uid: sys.warnoptions +- fullName: sys.winver + href: https://docs.python.org/3/library/sys.html#sys.winver + name: winver + uid: sys.winver +- fullName: syslog.LOG_ALERT + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_ALERT + name: LOG_ALERT + uid: syslog.LOG_ALERT +- fullName: syslog.LOG_AUTH + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_AUTH + name: LOG_AUTH + uid: syslog.LOG_AUTH +- fullName: syslog.LOG_AUTHPRIV + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_AUTHPRIV + name: LOG_AUTHPRIV + uid: syslog.LOG_AUTHPRIV +- fullName: syslog.LOG_CONS + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_CONS + name: LOG_CONS + uid: syslog.LOG_CONS +- fullName: syslog.LOG_CRIT + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_CRIT + name: LOG_CRIT + uid: syslog.LOG_CRIT +- fullName: syslog.LOG_CRON + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_CRON + name: LOG_CRON + uid: syslog.LOG_CRON +- fullName: syslog.LOG_DAEMON + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_DAEMON + name: LOG_DAEMON + uid: syslog.LOG_DAEMON +- fullName: syslog.LOG_DEBUG + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_DEBUG + name: LOG_DEBUG + uid: syslog.LOG_DEBUG +- fullName: syslog.LOG_EMERG + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_EMERG + name: LOG_EMERG + uid: syslog.LOG_EMERG +- fullName: syslog.LOG_ERR + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_ERR + name: LOG_ERR + uid: syslog.LOG_ERR +- fullName: syslog.LOG_FTP + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_FTP + name: LOG_FTP + uid: syslog.LOG_FTP +- fullName: syslog.LOG_INFO + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_INFO + name: LOG_INFO + uid: syslog.LOG_INFO +- fullName: syslog.LOG_INSTALL + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_INSTALL + name: LOG_INSTALL + uid: syslog.LOG_INSTALL +- fullName: syslog.LOG_KERN + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_KERN + name: LOG_KERN + uid: syslog.LOG_KERN +- fullName: syslog.LOG_LAUNCHD + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_LAUNCHD + name: LOG_LAUNCHD + uid: syslog.LOG_LAUNCHD +- fullName: syslog.LOG_LOCAL0 + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_LOCAL0 + name: LOG_LOCAL0 + uid: syslog.LOG_LOCAL0 +- fullName: syslog.LOG_LOCAL1 + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_LOCAL1 + name: LOG_LOCAL1 + uid: syslog.LOG_LOCAL1 +- fullName: syslog.LOG_LOCAL2 + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_LOCAL2 + name: LOG_LOCAL2 + uid: syslog.LOG_LOCAL2 +- fullName: syslog.LOG_LOCAL3 + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_LOCAL3 + name: LOG_LOCAL3 + uid: syslog.LOG_LOCAL3 +- fullName: syslog.LOG_LOCAL4 + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_LOCAL4 + name: LOG_LOCAL4 + uid: syslog.LOG_LOCAL4 +- fullName: syslog.LOG_LOCAL5 + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_LOCAL5 + name: LOG_LOCAL5 + uid: syslog.LOG_LOCAL5 +- fullName: syslog.LOG_LOCAL6 + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_LOCAL6 + name: LOG_LOCAL6 + uid: syslog.LOG_LOCAL6 +- fullName: syslog.LOG_LOCAL7 + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_LOCAL7 + name: LOG_LOCAL7 + uid: syslog.LOG_LOCAL7 +- fullName: syslog.LOG_LPR + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_LPR + name: LOG_LPR + uid: syslog.LOG_LPR +- fullName: syslog.LOG_MAIL + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_MAIL + name: LOG_MAIL + uid: syslog.LOG_MAIL +- fullName: syslog.LOG_NDELAY + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_NDELAY + name: LOG_NDELAY + uid: syslog.LOG_NDELAY +- fullName: syslog.LOG_NETINFO + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_NETINFO + name: LOG_NETINFO + uid: syslog.LOG_NETINFO +- fullName: syslog.LOG_NEWS + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_NEWS + name: LOG_NEWS + uid: syslog.LOG_NEWS +- fullName: syslog.LOG_NOTICE + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_NOTICE + name: LOG_NOTICE + uid: syslog.LOG_NOTICE +- fullName: syslog.LOG_NOWAIT + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_NOWAIT + name: LOG_NOWAIT + uid: syslog.LOG_NOWAIT +- fullName: syslog.LOG_ODELAY + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_ODELAY + name: LOG_ODELAY + uid: syslog.LOG_ODELAY +- fullName: syslog.LOG_PERROR + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_PERROR + name: LOG_PERROR + uid: syslog.LOG_PERROR +- fullName: syslog.LOG_PID + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_PID + name: LOG_PID + uid: syslog.LOG_PID +- fullName: syslog.LOG_RAS + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_RAS + name: LOG_RAS + uid: syslog.LOG_RAS +- fullName: syslog.LOG_REMOTEAUTH + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_REMOTEAUTH + name: LOG_REMOTEAUTH + uid: syslog.LOG_REMOTEAUTH +- fullName: syslog.LOG_SYSLOG + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_SYSLOG + name: LOG_SYSLOG + uid: syslog.LOG_SYSLOG +- fullName: syslog.LOG_USER + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_USER + name: LOG_USER + uid: syslog.LOG_USER +- fullName: syslog.LOG_UUCP + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_UUCP + name: LOG_UUCP + uid: syslog.LOG_UUCP +- fullName: syslog.LOG_WARNING + href: https://docs.python.org/3/library/syslog.html#syslog.LOG_WARNING + name: LOG_WARNING + uid: syslog.LOG_WARNING +- fullName: tabnanny.filename_only + href: https://docs.python.org/3/library/tabnanny.html#tabnanny.filename_only + name: filename_only + uid: tabnanny.filename_only +- fullName: tabnanny.verbose + href: https://docs.python.org/3/library/tabnanny.html#tabnanny.verbose + name: verbose + uid: tabnanny.verbose +- fullName: tarfile.AREGTYPE + href: https://docs.python.org/3/library/tarfile.html#tarfile.AREGTYPE + name: AREGTYPE + uid: tarfile.AREGTYPE +- fullName: tarfile.BLKTYPE + href: https://docs.python.org/3/library/tarfile.html#tarfile.BLKTYPE + name: BLKTYPE + uid: tarfile.BLKTYPE +- fullName: tarfile.CHRTYPE + href: https://docs.python.org/3/library/tarfile.html#tarfile.CHRTYPE + name: CHRTYPE + uid: tarfile.CHRTYPE +- fullName: tarfile.CONTTYPE + href: https://docs.python.org/3/library/tarfile.html#tarfile.CONTTYPE + name: CONTTYPE + uid: tarfile.CONTTYPE +- fullName: tarfile.DEFAULT_FORMAT + href: https://docs.python.org/3/library/tarfile.html#tarfile.DEFAULT_FORMAT + name: DEFAULT_FORMAT + uid: tarfile.DEFAULT_FORMAT +- fullName: tarfile.DIRTYPE + href: https://docs.python.org/3/library/tarfile.html#tarfile.DIRTYPE + name: DIRTYPE + uid: tarfile.DIRTYPE +- fullName: tarfile.ENCODING + href: https://docs.python.org/3/library/tarfile.html#tarfile.ENCODING + name: ENCODING + uid: tarfile.ENCODING +- fullName: tarfile.FIFOTYPE + href: https://docs.python.org/3/library/tarfile.html#tarfile.FIFOTYPE + name: FIFOTYPE + uid: tarfile.FIFOTYPE +- fullName: tarfile.GNUTYPE_LONGLINK + href: https://docs.python.org/3/library/tarfile.html#tarfile.GNUTYPE_LONGLINK + name: GNUTYPE_LONGLINK + uid: tarfile.GNUTYPE_LONGLINK +- fullName: tarfile.GNUTYPE_LONGNAME + href: https://docs.python.org/3/library/tarfile.html#tarfile.GNUTYPE_LONGNAME + name: GNUTYPE_LONGNAME + uid: tarfile.GNUTYPE_LONGNAME +- fullName: tarfile.GNUTYPE_SPARSE + href: https://docs.python.org/3/library/tarfile.html#tarfile.GNUTYPE_SPARSE + name: GNUTYPE_SPARSE + uid: tarfile.GNUTYPE_SPARSE +- fullName: tarfile.GNU_FORMAT + href: https://docs.python.org/3/library/tarfile.html#tarfile.GNU_FORMAT + name: GNU_FORMAT + uid: tarfile.GNU_FORMAT +- fullName: tarfile.LNKTYPE + href: https://docs.python.org/3/library/tarfile.html#tarfile.LNKTYPE + name: LNKTYPE + uid: tarfile.LNKTYPE +- fullName: tarfile.PAX_FORMAT + href: https://docs.python.org/3/library/tarfile.html#tarfile.PAX_FORMAT + name: PAX_FORMAT + uid: tarfile.PAX_FORMAT +- fullName: tarfile.REGTYPE + href: https://docs.python.org/3/library/tarfile.html#tarfile.REGTYPE + name: REGTYPE + uid: tarfile.REGTYPE +- fullName: tarfile.SYMTYPE + href: https://docs.python.org/3/library/tarfile.html#tarfile.SYMTYPE + name: SYMTYPE + uid: tarfile.SYMTYPE +- fullName: tarfile.USTAR_FORMAT + href: https://docs.python.org/3/library/tarfile.html#tarfile.USTAR_FORMAT + name: USTAR_FORMAT + uid: tarfile.USTAR_FORMAT +- fullName: tempfile.tempdir + href: https://docs.python.org/3/library/tempfile.html#tempfile.tempdir + name: tempdir + uid: tempfile.tempdir +- fullName: termios.TCSADRAIN + href: https://docs.python.org/3/library/termios.html#termios.TCSADRAIN + name: TCSADRAIN + uid: termios.TCSADRAIN +- fullName: termios.TCSAFLUSH + href: https://docs.python.org/3/library/termios.html#termios.TCSAFLUSH + name: TCSAFLUSH + uid: termios.TCSAFLUSH +- fullName: termios.TCSANOW + href: https://docs.python.org/3/library/termios.html#termios.TCSANOW + name: TCSANOW + uid: termios.TCSANOW +- fullName: test.support.ALWAYS_EQ + href: https://docs.python.org/3/library/test.html#test.support.ALWAYS_EQ + name: ALWAYS_EQ + uid: test.support.ALWAYS_EQ +- fullName: test.support.HAVE_DOCSTRINGS + href: https://docs.python.org/3/library/test.html#test.support.HAVE_DOCSTRINGS + name: HAVE_DOCSTRINGS + uid: test.support.HAVE_DOCSTRINGS +- fullName: test.support.INTERNET_TIMEOUT + href: https://docs.python.org/3/library/test.html#test.support.INTERNET_TIMEOUT + name: INTERNET_TIMEOUT + uid: test.support.INTERNET_TIMEOUT +- fullName: test.support.LARGEST + href: https://docs.python.org/3/library/test.html#test.support.LARGEST + name: LARGEST + uid: test.support.LARGEST +- fullName: test.support.LONG_TIMEOUT + href: https://docs.python.org/3/library/test.html#test.support.LONG_TIMEOUT + name: LONG_TIMEOUT + uid: test.support.LONG_TIMEOUT +- fullName: test.support.LOOPBACK_TIMEOUT + href: https://docs.python.org/3/library/test.html#test.support.LOOPBACK_TIMEOUT + name: LOOPBACK_TIMEOUT + uid: test.support.LOOPBACK_TIMEOUT +- fullName: test.support.MAX_Py_ssize_t + href: https://docs.python.org/3/library/test.html#test.support.MAX_Py_ssize_t + name: MAX_Py_ssize_t + uid: test.support.MAX_Py_ssize_t +- fullName: test.support.MISSING_C_DOCSTRINGS + href: https://docs.python.org/3/library/test.html#test.support.MISSING_C_DOCSTRINGS + name: MISSING_C_DOCSTRINGS + uid: test.support.MISSING_C_DOCSTRINGS +- fullName: test.support.NEVER_EQ + href: https://docs.python.org/3/library/test.html#test.support.NEVER_EQ + name: NEVER_EQ + uid: test.support.NEVER_EQ +- fullName: test.support.PGO + href: https://docs.python.org/3/library/test.html#test.support.PGO + name: PGO + uid: test.support.PGO +- fullName: test.support.PIPE_MAX_SIZE + href: https://docs.python.org/3/library/test.html#test.support.PIPE_MAX_SIZE + name: PIPE_MAX_SIZE + uid: test.support.PIPE_MAX_SIZE +- fullName: test.support.Py_DEBUG + href: https://docs.python.org/3/library/test.html#test.support.Py_DEBUG + name: Py_DEBUG + uid: test.support.Py_DEBUG +- fullName: test.support.SHORT_TIMEOUT + href: https://docs.python.org/3/library/test.html#test.support.SHORT_TIMEOUT + name: SHORT_TIMEOUT + uid: test.support.SHORT_TIMEOUT +- fullName: test.support.SMALLEST + href: https://docs.python.org/3/library/test.html#test.support.SMALLEST + name: SMALLEST + uid: test.support.SMALLEST +- fullName: test.support.SOCK_MAX_SIZE + href: https://docs.python.org/3/library/test.html#test.support.SOCK_MAX_SIZE + name: SOCK_MAX_SIZE + uid: test.support.SOCK_MAX_SIZE +- fullName: test.support.TEST_DATA_DIR + href: https://docs.python.org/3/library/test.html#test.support.TEST_DATA_DIR + name: TEST_DATA_DIR + uid: test.support.TEST_DATA_DIR +- fullName: test.support.TEST_HOME_DIR + href: https://docs.python.org/3/library/test.html#test.support.TEST_HOME_DIR + name: TEST_HOME_DIR + uid: test.support.TEST_HOME_DIR +- fullName: test.support.TEST_HTTP_URL + href: https://docs.python.org/3/library/test.html#test.support.TEST_HTTP_URL + name: TEST_HTTP_URL + uid: test.support.TEST_HTTP_URL +- fullName: test.support.TEST_SUPPORT_DIR + href: https://docs.python.org/3/library/test.html#test.support.TEST_SUPPORT_DIR + name: TEST_SUPPORT_DIR + uid: test.support.TEST_SUPPORT_DIR +- fullName: test.support.is_android + href: https://docs.python.org/3/library/test.html#test.support.is_android + name: is_android + uid: test.support.is_android +- fullName: test.support.is_jython + href: https://docs.python.org/3/library/test.html#test.support.is_jython + name: is_jython + uid: test.support.is_jython +- fullName: test.support.max_memuse + href: https://docs.python.org/3/library/test.html#test.support.max_memuse + name: max_memuse + uid: test.support.max_memuse +- fullName: test.support.os_helper.FS_NONASCII + href: https://docs.python.org/3/library/test.html#test.support.os_helper.FS_NONASCII + name: FS_NONASCII + uid: test.support.os_helper.FS_NONASCII +- fullName: test.support.os_helper.SAVEDCWD + href: https://docs.python.org/3/library/test.html#test.support.os_helper.SAVEDCWD + name: SAVEDCWD + uid: test.support.os_helper.SAVEDCWD +- fullName: test.support.os_helper.TESTFN + href: https://docs.python.org/3/library/test.html#test.support.os_helper.TESTFN + name: TESTFN + uid: test.support.os_helper.TESTFN +- fullName: test.support.os_helper.TESTFN_NONASCII + href: https://docs.python.org/3/library/test.html#test.support.os_helper.TESTFN_NONASCII + name: TESTFN_NONASCII + uid: test.support.os_helper.TESTFN_NONASCII +- fullName: test.support.os_helper.TESTFN_UNDECODABLE + href: https://docs.python.org/3/library/test.html#test.support.os_helper.TESTFN_UNDECODABLE + name: TESTFN_UNDECODABLE + uid: test.support.os_helper.TESTFN_UNDECODABLE +- fullName: test.support.os_helper.TESTFN_UNENCODABLE + href: https://docs.python.org/3/library/test.html#test.support.os_helper.TESTFN_UNENCODABLE + name: TESTFN_UNENCODABLE + uid: test.support.os_helper.TESTFN_UNENCODABLE +- fullName: test.support.os_helper.TESTFN_UNICODE + href: https://docs.python.org/3/library/test.html#test.support.os_helper.TESTFN_UNICODE + name: TESTFN_UNICODE + uid: test.support.os_helper.TESTFN_UNICODE +- fullName: test.support.real_max_memuse + href: https://docs.python.org/3/library/test.html#test.support.real_max_memuse + name: real_max_memuse + uid: test.support.real_max_memuse +- fullName: test.support.socket_helper.IPV6_ENABLED + href: https://docs.python.org/3/library/test.html#test.support.socket_helper.IPV6_ENABLED + name: IPV6_ENABLED + uid: test.support.socket_helper.IPV6_ENABLED +- fullName: test.support.unix_shell + href: https://docs.python.org/3/library/test.html#test.support.unix_shell + name: unix_shell + uid: test.support.unix_shell +- fullName: test.support.verbose + href: https://docs.python.org/3/library/test.html#test.support.verbose + name: verbose + uid: test.support.verbose +- fullName: threading.TIMEOUT_MAX + href: https://docs.python.org/3/library/threading.html#threading.TIMEOUT_MAX + name: TIMEOUT_MAX + uid: threading.TIMEOUT_MAX +- fullName: threading.__excepthook__ + href: https://docs.python.org/3/library/threading.html#threading.__excepthook__ + name: __excepthook__ + uid: threading.__excepthook__ +- fullName: time.CLOCK_BOOTTIME + href: https://docs.python.org/3/library/time.html#time.CLOCK_BOOTTIME + name: CLOCK_BOOTTIME + uid: time.CLOCK_BOOTTIME +- fullName: time.CLOCK_HIGHRES + href: https://docs.python.org/3/library/time.html#time.CLOCK_HIGHRES + name: CLOCK_HIGHRES + uid: time.CLOCK_HIGHRES +- fullName: time.CLOCK_MONOTONIC + href: https://docs.python.org/3/library/time.html#time.CLOCK_MONOTONIC + name: CLOCK_MONOTONIC + uid: time.CLOCK_MONOTONIC +- fullName: time.CLOCK_MONOTONIC_RAW + href: https://docs.python.org/3/library/time.html#time.CLOCK_MONOTONIC_RAW + name: CLOCK_MONOTONIC_RAW + uid: time.CLOCK_MONOTONIC_RAW +- fullName: time.CLOCK_MONOTONIC_RAW_APPROX + href: https://docs.python.org/3/library/time.html#time.CLOCK_MONOTONIC_RAW_APPROX + name: CLOCK_MONOTONIC_RAW_APPROX + uid: time.CLOCK_MONOTONIC_RAW_APPROX +- fullName: time.CLOCK_PROCESS_CPUTIME_ID + href: https://docs.python.org/3/library/time.html#time.CLOCK_PROCESS_CPUTIME_ID + name: CLOCK_PROCESS_CPUTIME_ID + uid: time.CLOCK_PROCESS_CPUTIME_ID +- fullName: time.CLOCK_PROF + href: https://docs.python.org/3/library/time.html#time.CLOCK_PROF + name: CLOCK_PROF + uid: time.CLOCK_PROF +- fullName: time.CLOCK_REALTIME + href: https://docs.python.org/3/library/time.html#time.CLOCK_REALTIME + name: CLOCK_REALTIME + uid: time.CLOCK_REALTIME +- fullName: time.CLOCK_TAI + href: https://docs.python.org/3/library/time.html#time.CLOCK_TAI + name: CLOCK_TAI + uid: time.CLOCK_TAI +- fullName: time.CLOCK_THREAD_CPUTIME_ID + href: https://docs.python.org/3/library/time.html#time.CLOCK_THREAD_CPUTIME_ID + name: CLOCK_THREAD_CPUTIME_ID + uid: time.CLOCK_THREAD_CPUTIME_ID +- fullName: time.CLOCK_UPTIME + href: https://docs.python.org/3/library/time.html#time.CLOCK_UPTIME + name: CLOCK_UPTIME + uid: time.CLOCK_UPTIME +- fullName: time.CLOCK_UPTIME_RAW + href: https://docs.python.org/3/library/time.html#time.CLOCK_UPTIME_RAW + name: CLOCK_UPTIME_RAW + uid: time.CLOCK_UPTIME_RAW +- fullName: time.CLOCK_UPTIME_RAW_APPROX + href: https://docs.python.org/3/library/time.html#time.CLOCK_UPTIME_RAW_APPROX + name: CLOCK_UPTIME_RAW_APPROX + uid: time.CLOCK_UPTIME_RAW_APPROX +- fullName: time.altzone + href: https://docs.python.org/3/library/time.html#time.altzone + name: altzone + uid: time.altzone +- fullName: time.daylight + href: https://docs.python.org/3/library/time.html#time.daylight + name: daylight + uid: time.daylight +- fullName: time.timezone + href: https://docs.python.org/3/library/time.html#time.timezone + name: timezone + uid: time.timezone +- fullName: time.tzname + href: https://docs.python.org/3/library/time.html#time.tzname + name: tzname + uid: time.tzname +- fullName: tkinter.font.BOLD + href: https://docs.python.org/3/library/tkinter.font.html#tkinter.font.BOLD + name: BOLD + uid: tkinter.font.BOLD +- fullName: tkinter.font.ITALIC + href: https://docs.python.org/3/library/tkinter.font.html#tkinter.font.ITALIC + name: ITALIC + uid: tkinter.font.ITALIC +- fullName: tkinter.font.NORMAL + href: https://docs.python.org/3/library/tkinter.font.html#tkinter.font.NORMAL + name: NORMAL + uid: tkinter.font.NORMAL +- fullName: tkinter.font.ROMAN + href: https://docs.python.org/3/library/tkinter.font.html#tkinter.font.ROMAN + name: ROMAN + uid: tkinter.font.ROMAN +- fullName: tkinter.messagebox.ABORT + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.ABORT + name: ABORT + uid: tkinter.messagebox.ABORT +- fullName: tkinter.messagebox.ABORTRETRYIGNORE + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.ABORTRETRYIGNORE + name: ABORTRETRYIGNORE + uid: tkinter.messagebox.ABORTRETRYIGNORE +- fullName: tkinter.messagebox.CANCEL + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.CANCEL + name: CANCEL + uid: tkinter.messagebox.CANCEL +- fullName: tkinter.messagebox.ERROR + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.ERROR + name: ERROR + uid: tkinter.messagebox.ERROR +- fullName: tkinter.messagebox.IGNORE + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.IGNORE + name: IGNORE + uid: tkinter.messagebox.IGNORE +- fullName: tkinter.messagebox.INFO + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.INFO + name: INFO + uid: tkinter.messagebox.INFO +- fullName: tkinter.messagebox.NO + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.NO + name: 'NO' + uid: tkinter.messagebox.NO +- fullName: tkinter.messagebox.OK + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.OK + name: OK + uid: tkinter.messagebox.OK +- fullName: tkinter.messagebox.OKCANCEL + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.OKCANCEL + name: OKCANCEL + uid: tkinter.messagebox.OKCANCEL +- fullName: tkinter.messagebox.QUESTION + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.QUESTION + name: QUESTION + uid: tkinter.messagebox.QUESTION +- fullName: tkinter.messagebox.RETRY + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.RETRY + name: RETRY + uid: tkinter.messagebox.RETRY +- fullName: tkinter.messagebox.RETRYCANCEL + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.RETRYCANCEL + name: RETRYCANCEL + uid: tkinter.messagebox.RETRYCANCEL +- fullName: tkinter.messagebox.WARNING + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.WARNING + name: WARNING + uid: tkinter.messagebox.WARNING +- fullName: tkinter.messagebox.YES + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.YES + name: 'YES' + uid: tkinter.messagebox.YES +- fullName: tkinter.messagebox.YESNO + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.YESNO + name: YESNO + uid: tkinter.messagebox.YESNO +- fullName: tkinter.messagebox.YESNOCANCEL + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.YESNOCANCEL + name: YESNOCANCEL + uid: tkinter.messagebox.YESNOCANCEL +- fullName: token.AMPER + href: https://docs.python.org/3/library/token.html#token.AMPER + name: AMPER + uid: token.AMPER +- fullName: token.AMPEREQUAL + href: https://docs.python.org/3/library/token.html#token.AMPEREQUAL + name: AMPEREQUAL + uid: token.AMPEREQUAL +- fullName: token.AT + href: https://docs.python.org/3/library/token.html#token.AT + name: AT + uid: token.AT +- fullName: token.ATEQUAL + href: https://docs.python.org/3/library/token.html#token.ATEQUAL + name: ATEQUAL + uid: token.ATEQUAL +- fullName: token.CIRCUMFLEX + href: https://docs.python.org/3/library/token.html#token.CIRCUMFLEX + name: CIRCUMFLEX + uid: token.CIRCUMFLEX +- fullName: token.CIRCUMFLEXEQUAL + href: https://docs.python.org/3/library/token.html#token.CIRCUMFLEXEQUAL + name: CIRCUMFLEXEQUAL + uid: token.CIRCUMFLEXEQUAL +- fullName: token.COLON + href: https://docs.python.org/3/library/token.html#token.COLON + name: COLON + uid: token.COLON +- fullName: token.COLONEQUAL + href: https://docs.python.org/3/library/token.html#token.COLONEQUAL + name: COLONEQUAL + uid: token.COLONEQUAL +- fullName: token.COMMA + href: https://docs.python.org/3/library/token.html#token.COMMA + name: COMMA + uid: token.COMMA +- fullName: token.COMMENT + href: https://docs.python.org/3/library/token.html#token.COMMENT + name: COMMENT + uid: token.COMMENT +- fullName: token.DEDENT + href: https://docs.python.org/3/library/token.html#token.DEDENT + name: DEDENT + uid: token.DEDENT +- fullName: token.DOT + href: https://docs.python.org/3/library/token.html#token.DOT + name: DOT + uid: token.DOT +- fullName: token.DOUBLESLASH + href: https://docs.python.org/3/library/token.html#token.DOUBLESLASH + name: DOUBLESLASH + uid: token.DOUBLESLASH +- fullName: token.DOUBLESLASHEQUAL + href: https://docs.python.org/3/library/token.html#token.DOUBLESLASHEQUAL + name: DOUBLESLASHEQUAL + uid: token.DOUBLESLASHEQUAL +- fullName: token.DOUBLESTAR + href: https://docs.python.org/3/library/token.html#token.DOUBLESTAR + name: DOUBLESTAR + uid: token.DOUBLESTAR +- fullName: token.DOUBLESTAREQUAL + href: https://docs.python.org/3/library/token.html#token.DOUBLESTAREQUAL + name: DOUBLESTAREQUAL + uid: token.DOUBLESTAREQUAL +- fullName: token.ELLIPSIS + href: https://docs.python.org/3/library/token.html#token.ELLIPSIS + name: ELLIPSIS + uid: token.ELLIPSIS +- fullName: token.ENCODING + href: https://docs.python.org/3/library/token.html#token.ENCODING + name: ENCODING + uid: token.ENCODING +- fullName: token.ENDMARKER + href: https://docs.python.org/3/library/token.html#token.ENDMARKER + name: ENDMARKER + uid: token.ENDMARKER +- fullName: token.EQEQUAL + href: https://docs.python.org/3/library/token.html#token.EQEQUAL + name: EQEQUAL + uid: token.EQEQUAL +- fullName: token.EQUAL + href: https://docs.python.org/3/library/token.html#token.EQUAL + name: EQUAL + uid: token.EQUAL +- fullName: token.ERRORTOKEN + href: https://docs.python.org/3/library/token.html#token.ERRORTOKEN + name: ERRORTOKEN + uid: token.ERRORTOKEN +- fullName: token.EXACT_TOKEN_TYPES + href: https://docs.python.org/3/library/token.html#token.EXACT_TOKEN_TYPES + name: EXACT_TOKEN_TYPES + uid: token.EXACT_TOKEN_TYPES +- fullName: token.EXCLAMATION + href: https://docs.python.org/3/library/token.html#token.EXCLAMATION + name: EXCLAMATION + uid: token.EXCLAMATION +- fullName: token.FSTRING_END + href: https://docs.python.org/3/library/token.html#token.FSTRING_END + name: FSTRING_END + uid: token.FSTRING_END +- fullName: token.FSTRING_MIDDLE + href: https://docs.python.org/3/library/token.html#token.FSTRING_MIDDLE + name: FSTRING_MIDDLE + uid: token.FSTRING_MIDDLE +- fullName: token.FSTRING_START + href: https://docs.python.org/3/library/token.html#token.FSTRING_START + name: FSTRING_START + uid: token.FSTRING_START +- fullName: token.GREATER + href: https://docs.python.org/3/library/token.html#token.GREATER + name: GREATER + uid: token.GREATER +- fullName: token.GREATEREQUAL + href: https://docs.python.org/3/library/token.html#token.GREATEREQUAL + name: GREATEREQUAL + uid: token.GREATEREQUAL +- fullName: token.INDENT + href: https://docs.python.org/3/library/token.html#token.INDENT + name: INDENT + uid: token.INDENT +- fullName: token.LBRACE + href: https://docs.python.org/3/library/token.html#token.LBRACE + name: LBRACE + uid: token.LBRACE +- fullName: token.LEFTSHIFT + href: https://docs.python.org/3/library/token.html#token.LEFTSHIFT + name: LEFTSHIFT + uid: token.LEFTSHIFT +- fullName: token.LEFTSHIFTEQUAL + href: https://docs.python.org/3/library/token.html#token.LEFTSHIFTEQUAL + name: LEFTSHIFTEQUAL + uid: token.LEFTSHIFTEQUAL +- fullName: token.LESS + href: https://docs.python.org/3/library/token.html#token.LESS + name: LESS + uid: token.LESS +- fullName: token.LESSEQUAL + href: https://docs.python.org/3/library/token.html#token.LESSEQUAL + name: LESSEQUAL + uid: token.LESSEQUAL +- fullName: token.LPAR + href: https://docs.python.org/3/library/token.html#token.LPAR + name: LPAR + uid: token.LPAR +- fullName: token.LSQB + href: https://docs.python.org/3/library/token.html#token.LSQB + name: LSQB + uid: token.LSQB +- fullName: token.MINEQUAL + href: https://docs.python.org/3/library/token.html#token.MINEQUAL + name: MINEQUAL + uid: token.MINEQUAL +- fullName: token.MINUS + href: https://docs.python.org/3/library/token.html#token.MINUS + name: MINUS + uid: token.MINUS +- fullName: token.NAME + href: https://docs.python.org/3/library/token.html#token.NAME + name: NAME + uid: token.NAME +- fullName: token.NEWLINE + href: https://docs.python.org/3/library/token.html#token.NEWLINE + name: NEWLINE + uid: token.NEWLINE +- fullName: token.NL + href: https://docs.python.org/3/library/token.html#token.NL + name: NL + uid: token.NL +- fullName: token.NOTEQUAL + href: https://docs.python.org/3/library/token.html#token.NOTEQUAL + name: NOTEQUAL + uid: token.NOTEQUAL +- fullName: token.NUMBER + href: https://docs.python.org/3/library/token.html#token.NUMBER + name: NUMBER + uid: token.NUMBER +- fullName: token.N_TOKENS + href: https://docs.python.org/3/library/token.html#token.N_TOKENS + name: N_TOKENS + uid: token.N_TOKENS +- fullName: token.OP + href: https://docs.python.org/3/library/token.html#token.OP + name: OP + uid: token.OP +- fullName: token.PERCENT + href: https://docs.python.org/3/library/token.html#token.PERCENT + name: PERCENT + uid: token.PERCENT +- fullName: token.PERCENTEQUAL + href: https://docs.python.org/3/library/token.html#token.PERCENTEQUAL + name: PERCENTEQUAL + uid: token.PERCENTEQUAL +- fullName: token.PLUS + href: https://docs.python.org/3/library/token.html#token.PLUS + name: PLUS + uid: token.PLUS +- fullName: token.PLUSEQUAL + href: https://docs.python.org/3/library/token.html#token.PLUSEQUAL + name: PLUSEQUAL + uid: token.PLUSEQUAL +- fullName: token.RARROW + href: https://docs.python.org/3/library/token.html#token.RARROW + name: RARROW + uid: token.RARROW +- fullName: token.RBRACE + href: https://docs.python.org/3/library/token.html#token.RBRACE + name: RBRACE + uid: token.RBRACE +- fullName: token.RIGHTSHIFT + href: https://docs.python.org/3/library/token.html#token.RIGHTSHIFT + name: RIGHTSHIFT + uid: token.RIGHTSHIFT +- fullName: token.RIGHTSHIFTEQUAL + href: https://docs.python.org/3/library/token.html#token.RIGHTSHIFTEQUAL + name: RIGHTSHIFTEQUAL + uid: token.RIGHTSHIFTEQUAL +- fullName: token.RPAR + href: https://docs.python.org/3/library/token.html#token.RPAR + name: RPAR + uid: token.RPAR +- fullName: token.RSQB + href: https://docs.python.org/3/library/token.html#token.RSQB + name: RSQB + uid: token.RSQB +- fullName: token.SEMI + href: https://docs.python.org/3/library/token.html#token.SEMI + name: SEMI + uid: token.SEMI +- fullName: token.SLASH + href: https://docs.python.org/3/library/token.html#token.SLASH + name: SLASH + uid: token.SLASH +- fullName: token.SLASHEQUAL + href: https://docs.python.org/3/library/token.html#token.SLASHEQUAL + name: SLASHEQUAL + uid: token.SLASHEQUAL +- fullName: token.SOFT_KEYWORD + href: https://docs.python.org/3/library/token.html#token.SOFT_KEYWORD + name: SOFT_KEYWORD + uid: token.SOFT_KEYWORD +- fullName: token.STAR + href: https://docs.python.org/3/library/token.html#token.STAR + name: STAR + uid: token.STAR +- fullName: token.STAREQUAL + href: https://docs.python.org/3/library/token.html#token.STAREQUAL + name: STAREQUAL + uid: token.STAREQUAL +- fullName: token.STRING + href: https://docs.python.org/3/library/token.html#token.STRING + name: STRING + uid: token.STRING +- fullName: token.TILDE + href: https://docs.python.org/3/library/token.html#token.TILDE + name: TILDE + uid: token.TILDE +- fullName: token.TYPE_COMMENT + href: https://docs.python.org/3/library/token.html#token.TYPE_COMMENT + name: TYPE_COMMENT + uid: token.TYPE_COMMENT +- fullName: token.TYPE_IGNORE + href: https://docs.python.org/3/library/token.html#token.TYPE_IGNORE + name: TYPE_IGNORE + uid: token.TYPE_IGNORE +- fullName: token.VBAR + href: https://docs.python.org/3/library/token.html#token.VBAR + name: VBAR + uid: token.VBAR +- fullName: token.VBAREQUAL + href: https://docs.python.org/3/library/token.html#token.VBAREQUAL + name: VBAREQUAL + uid: token.VBAREQUAL +- fullName: token.tok_name + href: https://docs.python.org/3/library/token.html#token.tok_name + name: tok_name + uid: token.tok_name +- fullName: types.AsyncGeneratorType + href: https://docs.python.org/3/library/types.html#types.AsyncGeneratorType + name: AsyncGeneratorType + uid: types.AsyncGeneratorType +- fullName: types.BuiltinFunctionType + href: https://docs.python.org/3/library/types.html#types.BuiltinFunctionType + name: BuiltinFunctionType + uid: types.BuiltinFunctionType +- fullName: types.BuiltinMethodType + href: https://docs.python.org/3/library/types.html#types.BuiltinMethodType + name: BuiltinMethodType + uid: types.BuiltinMethodType +- fullName: types.CellType + href: https://docs.python.org/3/library/types.html#types.CellType + name: CellType + uid: types.CellType +- fullName: types.ClassMethodDescriptorType + href: https://docs.python.org/3/library/types.html#types.ClassMethodDescriptorType + name: ClassMethodDescriptorType + uid: types.ClassMethodDescriptorType +- fullName: types.CoroutineType + href: https://docs.python.org/3/library/types.html#types.CoroutineType + name: CoroutineType + uid: types.CoroutineType +- fullName: types.EllipsisType + href: https://docs.python.org/3/library/types.html#types.EllipsisType + name: EllipsisType + uid: types.EllipsisType +- fullName: types.FrameType + href: https://docs.python.org/3/library/types.html#types.FrameType + name: FrameType + uid: types.FrameType +- fullName: types.FunctionType + href: https://docs.python.org/3/library/types.html#types.FunctionType + name: FunctionType + uid: types.FunctionType +- fullName: types.GeneratorType + href: https://docs.python.org/3/library/types.html#types.GeneratorType + name: GeneratorType + uid: types.GeneratorType +- fullName: types.GetSetDescriptorType + href: https://docs.python.org/3/library/types.html#types.GetSetDescriptorType + name: GetSetDescriptorType + uid: types.GetSetDescriptorType +- fullName: types.LambdaType + href: https://docs.python.org/3/library/types.html#types.LambdaType + name: LambdaType + uid: types.LambdaType +- fullName: types.MemberDescriptorType + href: https://docs.python.org/3/library/types.html#types.MemberDescriptorType + name: MemberDescriptorType + uid: types.MemberDescriptorType +- fullName: types.MethodDescriptorType + href: https://docs.python.org/3/library/types.html#types.MethodDescriptorType + name: MethodDescriptorType + uid: types.MethodDescriptorType +- fullName: types.MethodType + href: https://docs.python.org/3/library/types.html#types.MethodType + name: MethodType + uid: types.MethodType +- fullName: types.MethodWrapperType + href: https://docs.python.org/3/library/types.html#types.MethodWrapperType + name: MethodWrapperType + uid: types.MethodWrapperType +- fullName: types.NoneType + href: https://docs.python.org/3/library/types.html#types.NoneType + name: NoneType + uid: types.NoneType +- fullName: types.NotImplementedType + href: https://docs.python.org/3/library/types.html#types.NotImplementedType + name: NotImplementedType + uid: types.NotImplementedType +- fullName: types.WrapperDescriptorType + href: https://docs.python.org/3/library/types.html#types.WrapperDescriptorType + name: WrapperDescriptorType + uid: types.WrapperDescriptorType +- fullName: typing.Annotated + href: https://docs.python.org/3/library/typing.html#typing.Annotated + name: Annotated + uid: typing.Annotated +- fullName: typing.Any + href: https://docs.python.org/3/library/typing.html#typing.Any + name: Any + uid: typing.Any +- fullName: typing.AnyStr + href: https://docs.python.org/3/library/typing.html#typing.AnyStr + name: AnyStr + uid: typing.AnyStr +- fullName: typing.Callable + href: https://docs.python.org/3/library/typing.html#typing.Callable + name: Callable + uid: typing.Callable +- fullName: typing.ClassVar + href: https://docs.python.org/3/library/typing.html#typing.ClassVar + name: ClassVar + uid: typing.ClassVar +- fullName: typing.Concatenate + href: https://docs.python.org/3/library/typing.html#typing.Concatenate + name: Concatenate + uid: typing.Concatenate +- fullName: typing.Final + href: https://docs.python.org/3/library/typing.html#typing.Final + name: Final + uid: typing.Final +- fullName: typing.Literal + href: https://docs.python.org/3/library/typing.html#typing.Literal + name: Literal + uid: typing.Literal +- fullName: typing.LiteralString + href: https://docs.python.org/3/library/typing.html#typing.LiteralString + name: LiteralString + uid: typing.LiteralString +- fullName: typing.Never + href: https://docs.python.org/3/library/typing.html#typing.Never + name: Never + uid: typing.Never +- fullName: typing.NoDefault + href: https://docs.python.org/3/library/typing.html#typing.NoDefault + name: NoDefault + uid: typing.NoDefault +- fullName: typing.NoReturn + href: https://docs.python.org/3/library/typing.html#typing.NoReturn + name: NoReturn + uid: typing.NoReturn +- fullName: typing.NotRequired + href: https://docs.python.org/3/library/typing.html#typing.NotRequired + name: NotRequired + uid: typing.NotRequired +- fullName: typing.Optional + href: https://docs.python.org/3/library/typing.html#typing.Optional + name: Optional + uid: typing.Optional +- fullName: typing.ParamSpecArgs + href: https://docs.python.org/3/library/typing.html#typing.ParamSpecArgs + name: ParamSpecArgs + uid: typing.ParamSpecArgs +- fullName: typing.ParamSpecKwargs + href: https://docs.python.org/3/library/typing.html#typing.ParamSpecKwargs + name: ParamSpecKwargs + uid: typing.ParamSpecKwargs +- fullName: typing.ReadOnly + href: https://docs.python.org/3/library/typing.html#typing.ReadOnly + name: ReadOnly + uid: typing.ReadOnly +- fullName: typing.Required + href: https://docs.python.org/3/library/typing.html#typing.Required + name: Required + uid: typing.Required +- fullName: typing.Self + href: https://docs.python.org/3/library/typing.html#typing.Self + name: Self + uid: typing.Self +- fullName: typing.TYPE_CHECKING + href: https://docs.python.org/3/library/typing.html#typing.TYPE_CHECKING + name: TYPE_CHECKING + uid: typing.TYPE_CHECKING +- fullName: typing.Tuple + href: https://docs.python.org/3/library/typing.html#typing.Tuple + name: Tuple + uid: typing.Tuple +- fullName: typing.TypeAlias + href: https://docs.python.org/3/library/typing.html#typing.TypeAlias + name: TypeAlias + uid: typing.TypeAlias +- fullName: typing.TypeGuard + href: https://docs.python.org/3/library/typing.html#typing.TypeGuard + name: TypeGuard + uid: typing.TypeGuard +- fullName: typing.TypeIs + href: https://docs.python.org/3/library/typing.html#typing.TypeIs + name: TypeIs + uid: typing.TypeIs +- fullName: typing.Union + href: https://docs.python.org/3/library/typing.html#typing.Union + name: Union + uid: typing.Union +- fullName: typing.Unpack + href: https://docs.python.org/3/library/typing.html#typing.Unpack + name: Unpack + uid: typing.Unpack +- fullName: unicodedata.ucd_3_2_0 + href: https://docs.python.org/3/library/unicodedata.html#unicodedata.ucd_3_2_0 + name: ucd_3_2_0 + uid: unicodedata.ucd_3_2_0 +- fullName: unicodedata.unidata_version + href: https://docs.python.org/3/library/unicodedata.html#unicodedata.unidata_version + name: unidata_version + uid: unicodedata.unidata_version +- fullName: unittest.defaultTestLoader + href: https://docs.python.org/3/library/unittest.html#unittest.defaultTestLoader + name: defaultTestLoader + uid: unittest.defaultTestLoader +- fullName: unittest.mock.ANY + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.ANY + name: ANY + uid: unittest.mock.ANY +- fullName: unittest.mock.DEFAULT + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.DEFAULT + name: DEFAULT + uid: unittest.mock.DEFAULT +- fullName: unittest.mock.FILTER_DIR + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.FILTER_DIR + name: FILTER_DIR + uid: unittest.mock.FILTER_DIR +- fullName: unittest.mock.sentinel + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.sentinel + name: sentinel + uid: unittest.mock.sentinel +- fullName: uuid.NAMESPACE_DNS + href: https://docs.python.org/3/library/uuid.html#uuid.NAMESPACE_DNS + name: NAMESPACE_DNS + uid: uuid.NAMESPACE_DNS +- fullName: uuid.NAMESPACE_OID + href: https://docs.python.org/3/library/uuid.html#uuid.NAMESPACE_OID + name: NAMESPACE_OID + uid: uuid.NAMESPACE_OID +- fullName: uuid.NAMESPACE_URL + href: https://docs.python.org/3/library/uuid.html#uuid.NAMESPACE_URL + name: NAMESPACE_URL + uid: uuid.NAMESPACE_URL +- fullName: uuid.NAMESPACE_X500 + href: https://docs.python.org/3/library/uuid.html#uuid.NAMESPACE_X500 + name: NAMESPACE_X500 + uid: uuid.NAMESPACE_X500 +- fullName: uuid.RESERVED_FUTURE + href: https://docs.python.org/3/library/uuid.html#uuid.RESERVED_FUTURE + name: RESERVED_FUTURE + uid: uuid.RESERVED_FUTURE +- fullName: uuid.RESERVED_MICROSOFT + href: https://docs.python.org/3/library/uuid.html#uuid.RESERVED_MICROSOFT + name: RESERVED_MICROSOFT + uid: uuid.RESERVED_MICROSOFT +- fullName: uuid.RESERVED_NCS + href: https://docs.python.org/3/library/uuid.html#uuid.RESERVED_NCS + name: RESERVED_NCS + uid: uuid.RESERVED_NCS +- fullName: uuid.RFC_4122 + href: https://docs.python.org/3/library/uuid.html#uuid.RFC_4122 + name: RFC_4122 + uid: uuid.RFC_4122 +- fullName: weakref.CallableProxyType + href: https://docs.python.org/3/library/weakref.html#weakref.CallableProxyType + name: CallableProxyType + uid: weakref.CallableProxyType +- fullName: weakref.ProxyType + href: https://docs.python.org/3/library/weakref.html#weakref.ProxyType + name: ProxyType + uid: weakref.ProxyType +- fullName: weakref.ProxyTypes + href: https://docs.python.org/3/library/weakref.html#weakref.ProxyTypes + name: ProxyTypes + uid: weakref.ProxyTypes +- fullName: weakref.ReferenceType + href: https://docs.python.org/3/library/weakref.html#weakref.ReferenceType + name: ReferenceType + uid: weakref.ReferenceType +- fullName: winreg.HKEY_CLASSES_ROOT + href: https://docs.python.org/3/library/winreg.html#winreg.HKEY_CLASSES_ROOT + name: HKEY_CLASSES_ROOT + uid: winreg.HKEY_CLASSES_ROOT +- fullName: winreg.HKEY_CURRENT_CONFIG + href: https://docs.python.org/3/library/winreg.html#winreg.HKEY_CURRENT_CONFIG + name: HKEY_CURRENT_CONFIG + uid: winreg.HKEY_CURRENT_CONFIG +- fullName: winreg.HKEY_CURRENT_USER + href: https://docs.python.org/3/library/winreg.html#winreg.HKEY_CURRENT_USER + name: HKEY_CURRENT_USER + uid: winreg.HKEY_CURRENT_USER +- fullName: winreg.HKEY_DYN_DATA + href: https://docs.python.org/3/library/winreg.html#winreg.HKEY_DYN_DATA + name: HKEY_DYN_DATA + uid: winreg.HKEY_DYN_DATA +- fullName: winreg.HKEY_LOCAL_MACHINE + href: https://docs.python.org/3/library/winreg.html#winreg.HKEY_LOCAL_MACHINE + name: HKEY_LOCAL_MACHINE + uid: winreg.HKEY_LOCAL_MACHINE +- fullName: winreg.HKEY_PERFORMANCE_DATA + href: https://docs.python.org/3/library/winreg.html#winreg.HKEY_PERFORMANCE_DATA + name: HKEY_PERFORMANCE_DATA + uid: winreg.HKEY_PERFORMANCE_DATA +- fullName: winreg.HKEY_USERS + href: https://docs.python.org/3/library/winreg.html#winreg.HKEY_USERS + name: HKEY_USERS + uid: winreg.HKEY_USERS +- fullName: winreg.KEY_ALL_ACCESS + href: https://docs.python.org/3/library/winreg.html#winreg.KEY_ALL_ACCESS + name: KEY_ALL_ACCESS + uid: winreg.KEY_ALL_ACCESS +- fullName: winreg.KEY_CREATE_LINK + href: https://docs.python.org/3/library/winreg.html#winreg.KEY_CREATE_LINK + name: KEY_CREATE_LINK + uid: winreg.KEY_CREATE_LINK +- fullName: winreg.KEY_CREATE_SUB_KEY + href: https://docs.python.org/3/library/winreg.html#winreg.KEY_CREATE_SUB_KEY + name: KEY_CREATE_SUB_KEY + uid: winreg.KEY_CREATE_SUB_KEY +- fullName: winreg.KEY_ENUMERATE_SUB_KEYS + href: https://docs.python.org/3/library/winreg.html#winreg.KEY_ENUMERATE_SUB_KEYS + name: KEY_ENUMERATE_SUB_KEYS + uid: winreg.KEY_ENUMERATE_SUB_KEYS +- fullName: winreg.KEY_EXECUTE + href: https://docs.python.org/3/library/winreg.html#winreg.KEY_EXECUTE + name: KEY_EXECUTE + uid: winreg.KEY_EXECUTE +- fullName: winreg.KEY_NOTIFY + href: https://docs.python.org/3/library/winreg.html#winreg.KEY_NOTIFY + name: KEY_NOTIFY + uid: winreg.KEY_NOTIFY +- fullName: winreg.KEY_QUERY_VALUE + href: https://docs.python.org/3/library/winreg.html#winreg.KEY_QUERY_VALUE + name: KEY_QUERY_VALUE + uid: winreg.KEY_QUERY_VALUE +- fullName: winreg.KEY_READ + href: https://docs.python.org/3/library/winreg.html#winreg.KEY_READ + name: KEY_READ + uid: winreg.KEY_READ +- fullName: winreg.KEY_SET_VALUE + href: https://docs.python.org/3/library/winreg.html#winreg.KEY_SET_VALUE + name: KEY_SET_VALUE + uid: winreg.KEY_SET_VALUE +- fullName: winreg.KEY_WOW64_32KEY + href: https://docs.python.org/3/library/winreg.html#winreg.KEY_WOW64_32KEY + name: KEY_WOW64_32KEY + uid: winreg.KEY_WOW64_32KEY +- fullName: winreg.KEY_WOW64_64KEY + href: https://docs.python.org/3/library/winreg.html#winreg.KEY_WOW64_64KEY + name: KEY_WOW64_64KEY + uid: winreg.KEY_WOW64_64KEY +- fullName: winreg.KEY_WRITE + href: https://docs.python.org/3/library/winreg.html#winreg.KEY_WRITE + name: KEY_WRITE + uid: winreg.KEY_WRITE +- fullName: winreg.REG_BINARY + href: https://docs.python.org/3/library/winreg.html#winreg.REG_BINARY + name: REG_BINARY + uid: winreg.REG_BINARY +- fullName: winreg.REG_DWORD + href: https://docs.python.org/3/library/winreg.html#winreg.REG_DWORD + name: REG_DWORD + uid: winreg.REG_DWORD +- fullName: winreg.REG_DWORD_BIG_ENDIAN + href: https://docs.python.org/3/library/winreg.html#winreg.REG_DWORD_BIG_ENDIAN + name: REG_DWORD_BIG_ENDIAN + uid: winreg.REG_DWORD_BIG_ENDIAN +- fullName: winreg.REG_DWORD_LITTLE_ENDIAN + href: https://docs.python.org/3/library/winreg.html#winreg.REG_DWORD_LITTLE_ENDIAN + name: REG_DWORD_LITTLE_ENDIAN + uid: winreg.REG_DWORD_LITTLE_ENDIAN +- fullName: winreg.REG_EXPAND_SZ + href: https://docs.python.org/3/library/winreg.html#winreg.REG_EXPAND_SZ + name: REG_EXPAND_SZ + uid: winreg.REG_EXPAND_SZ +- fullName: winreg.REG_FULL_RESOURCE_DESCRIPTOR + href: https://docs.python.org/3/library/winreg.html#winreg.REG_FULL_RESOURCE_DESCRIPTOR + name: REG_FULL_RESOURCE_DESCRIPTOR + uid: winreg.REG_FULL_RESOURCE_DESCRIPTOR +- fullName: winreg.REG_LINK + href: https://docs.python.org/3/library/winreg.html#winreg.REG_LINK + name: REG_LINK + uid: winreg.REG_LINK +- fullName: winreg.REG_MULTI_SZ + href: https://docs.python.org/3/library/winreg.html#winreg.REG_MULTI_SZ + name: REG_MULTI_SZ + uid: winreg.REG_MULTI_SZ +- fullName: winreg.REG_NONE + href: https://docs.python.org/3/library/winreg.html#winreg.REG_NONE + name: REG_NONE + uid: winreg.REG_NONE +- fullName: winreg.REG_QWORD + href: https://docs.python.org/3/library/winreg.html#winreg.REG_QWORD + name: REG_QWORD + uid: winreg.REG_QWORD +- fullName: winreg.REG_QWORD_LITTLE_ENDIAN + href: https://docs.python.org/3/library/winreg.html#winreg.REG_QWORD_LITTLE_ENDIAN + name: REG_QWORD_LITTLE_ENDIAN + uid: winreg.REG_QWORD_LITTLE_ENDIAN +- fullName: winreg.REG_RESOURCE_LIST + href: https://docs.python.org/3/library/winreg.html#winreg.REG_RESOURCE_LIST + name: REG_RESOURCE_LIST + uid: winreg.REG_RESOURCE_LIST +- fullName: winreg.REG_RESOURCE_REQUIREMENTS_LIST + href: https://docs.python.org/3/library/winreg.html#winreg.REG_RESOURCE_REQUIREMENTS_LIST + name: REG_RESOURCE_REQUIREMENTS_LIST + uid: winreg.REG_RESOURCE_REQUIREMENTS_LIST +- fullName: winreg.REG_SZ + href: https://docs.python.org/3/library/winreg.html#winreg.REG_SZ + name: REG_SZ + uid: winreg.REG_SZ +- fullName: winsound.MB_ICONASTERISK + href: https://docs.python.org/3/library/winsound.html#winsound.MB_ICONASTERISK + name: MB_ICONASTERISK + uid: winsound.MB_ICONASTERISK +- fullName: winsound.MB_ICONEXCLAMATION + href: https://docs.python.org/3/library/winsound.html#winsound.MB_ICONEXCLAMATION + name: MB_ICONEXCLAMATION + uid: winsound.MB_ICONEXCLAMATION +- fullName: winsound.MB_ICONHAND + href: https://docs.python.org/3/library/winsound.html#winsound.MB_ICONHAND + name: MB_ICONHAND + uid: winsound.MB_ICONHAND +- fullName: winsound.MB_ICONQUESTION + href: https://docs.python.org/3/library/winsound.html#winsound.MB_ICONQUESTION + name: MB_ICONQUESTION + uid: winsound.MB_ICONQUESTION +- fullName: winsound.MB_OK + href: https://docs.python.org/3/library/winsound.html#winsound.MB_OK + name: MB_OK + uid: winsound.MB_OK +- fullName: winsound.SND_ALIAS + href: https://docs.python.org/3/library/winsound.html#winsound.SND_ALIAS + name: SND_ALIAS + uid: winsound.SND_ALIAS +- fullName: winsound.SND_APPLICATION + href: https://docs.python.org/3/library/winsound.html#winsound.SND_APPLICATION + name: SND_APPLICATION + uid: winsound.SND_APPLICATION +- fullName: winsound.SND_ASYNC + href: https://docs.python.org/3/library/winsound.html#winsound.SND_ASYNC + name: SND_ASYNC + uid: winsound.SND_ASYNC +- fullName: winsound.SND_FILENAME + href: https://docs.python.org/3/library/winsound.html#winsound.SND_FILENAME + name: SND_FILENAME + uid: winsound.SND_FILENAME +- fullName: winsound.SND_LOOP + href: https://docs.python.org/3/library/winsound.html#winsound.SND_LOOP + name: SND_LOOP + uid: winsound.SND_LOOP +- fullName: winsound.SND_MEMORY + href: https://docs.python.org/3/library/winsound.html#winsound.SND_MEMORY + name: SND_MEMORY + uid: winsound.SND_MEMORY +- fullName: winsound.SND_NODEFAULT + href: https://docs.python.org/3/library/winsound.html#winsound.SND_NODEFAULT + name: SND_NODEFAULT + uid: winsound.SND_NODEFAULT +- fullName: winsound.SND_NOSTOP + href: https://docs.python.org/3/library/winsound.html#winsound.SND_NOSTOP + name: SND_NOSTOP + uid: winsound.SND_NOSTOP +- fullName: winsound.SND_NOWAIT + href: https://docs.python.org/3/library/winsound.html#winsound.SND_NOWAIT + name: SND_NOWAIT + uid: winsound.SND_NOWAIT +- fullName: winsound.SND_PURGE + href: https://docs.python.org/3/library/winsound.html#winsound.SND_PURGE + name: SND_PURGE + uid: winsound.SND_PURGE +- fullName: wsgiref.types.WSGIApplication + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.types.WSGIApplication + name: WSGIApplication + uid: wsgiref.types.WSGIApplication +- fullName: wsgiref.types.WSGIEnvironment + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.types.WSGIEnvironment + name: WSGIEnvironment + uid: wsgiref.types.WSGIEnvironment +- fullName: xml.dom.EMPTY_NAMESPACE + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.EMPTY_NAMESPACE + name: EMPTY_NAMESPACE + uid: xml.dom.EMPTY_NAMESPACE +- fullName: xml.dom.XHTML_NAMESPACE + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.XHTML_NAMESPACE + name: XHTML_NAMESPACE + uid: xml.dom.XHTML_NAMESPACE +- fullName: xml.dom.XMLNS_NAMESPACE + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.XMLNS_NAMESPACE + name: XMLNS_NAMESPACE + uid: xml.dom.XMLNS_NAMESPACE +- fullName: xml.dom.XML_NAMESPACE + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.XML_NAMESPACE + name: XML_NAMESPACE + uid: xml.dom.XML_NAMESPACE +- fullName: xml.dom.pulldom.default_bufsize + href: https://docs.python.org/3/library/xml.dom.pulldom.html#xml.dom.pulldom.default_bufsize + name: default_bufsize + uid: xml.dom.pulldom.default_bufsize +- fullName: xml.parsers.expat.XMLParserType + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.XMLParserType + name: XMLParserType + uid: xml.parsers.expat.XMLParserType +- fullName: xml.parsers.expat.errors.XML_ERROR_ABORTED + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_ABORTED + name: XML_ERROR_ABORTED + uid: xml.parsers.expat.errors.XML_ERROR_ABORTED +- fullName: xml.parsers.expat.errors.XML_ERROR_AMPLIFICATION_LIMIT_BREACH + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_AMPLIFICATION_LIMIT_BREACH + name: XML_ERROR_AMPLIFICATION_LIMIT_BREACH + uid: xml.parsers.expat.errors.XML_ERROR_AMPLIFICATION_LIMIT_BREACH +- fullName: xml.parsers.expat.errors.XML_ERROR_ASYNC_ENTITY + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_ASYNC_ENTITY + name: XML_ERROR_ASYNC_ENTITY + uid: xml.parsers.expat.errors.XML_ERROR_ASYNC_ENTITY +- fullName: xml.parsers.expat.errors.XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF + name: XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF + uid: xml.parsers.expat.errors.XML_ERROR_ATTRIBUTE_EXTERNAL_ENTITY_REF +- fullName: xml.parsers.expat.errors.XML_ERROR_BAD_CHAR_REF + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_BAD_CHAR_REF + name: XML_ERROR_BAD_CHAR_REF + uid: xml.parsers.expat.errors.XML_ERROR_BAD_CHAR_REF +- fullName: xml.parsers.expat.errors.XML_ERROR_BINARY_ENTITY_REF + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_BINARY_ENTITY_REF + name: XML_ERROR_BINARY_ENTITY_REF + uid: xml.parsers.expat.errors.XML_ERROR_BINARY_ENTITY_REF +- fullName: xml.parsers.expat.errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING + name: XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING + uid: xml.parsers.expat.errors.XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING +- fullName: xml.parsers.expat.errors.XML_ERROR_DUPLICATE_ATTRIBUTE + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_DUPLICATE_ATTRIBUTE + name: XML_ERROR_DUPLICATE_ATTRIBUTE + uid: xml.parsers.expat.errors.XML_ERROR_DUPLICATE_ATTRIBUTE +- fullName: xml.parsers.expat.errors.XML_ERROR_ENTITY_DECLARED_IN_PE + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_ENTITY_DECLARED_IN_PE + name: XML_ERROR_ENTITY_DECLARED_IN_PE + uid: xml.parsers.expat.errors.XML_ERROR_ENTITY_DECLARED_IN_PE +- fullName: xml.parsers.expat.errors.XML_ERROR_EXTERNAL_ENTITY_HANDLING + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_EXTERNAL_ENTITY_HANDLING + name: XML_ERROR_EXTERNAL_ENTITY_HANDLING + uid: xml.parsers.expat.errors.XML_ERROR_EXTERNAL_ENTITY_HANDLING +- fullName: xml.parsers.expat.errors.XML_ERROR_FEATURE_REQUIRES_XML_DTD + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_FEATURE_REQUIRES_XML_DTD + name: XML_ERROR_FEATURE_REQUIRES_XML_DTD + uid: xml.parsers.expat.errors.XML_ERROR_FEATURE_REQUIRES_XML_DTD +- fullName: xml.parsers.expat.errors.XML_ERROR_FINISHED + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_FINISHED + name: XML_ERROR_FINISHED + uid: xml.parsers.expat.errors.XML_ERROR_FINISHED +- fullName: xml.parsers.expat.errors.XML_ERROR_INCOMPLETE_PE + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_INCOMPLETE_PE + name: XML_ERROR_INCOMPLETE_PE + uid: xml.parsers.expat.errors.XML_ERROR_INCOMPLETE_PE +- fullName: xml.parsers.expat.errors.XML_ERROR_INCORRECT_ENCODING + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_INCORRECT_ENCODING + name: XML_ERROR_INCORRECT_ENCODING + uid: xml.parsers.expat.errors.XML_ERROR_INCORRECT_ENCODING +- fullName: xml.parsers.expat.errors.XML_ERROR_INVALID_ARGUMENT + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_INVALID_ARGUMENT + name: XML_ERROR_INVALID_ARGUMENT + uid: xml.parsers.expat.errors.XML_ERROR_INVALID_ARGUMENT +- fullName: xml.parsers.expat.errors.XML_ERROR_INVALID_TOKEN + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_INVALID_TOKEN + name: XML_ERROR_INVALID_TOKEN + uid: xml.parsers.expat.errors.XML_ERROR_INVALID_TOKEN +- fullName: xml.parsers.expat.errors.XML_ERROR_JUNK_AFTER_DOC_ELEMENT + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_JUNK_AFTER_DOC_ELEMENT + name: XML_ERROR_JUNK_AFTER_DOC_ELEMENT + uid: xml.parsers.expat.errors.XML_ERROR_JUNK_AFTER_DOC_ELEMENT +- fullName: xml.parsers.expat.errors.XML_ERROR_MISPLACED_XML_PI + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_MISPLACED_XML_PI + name: XML_ERROR_MISPLACED_XML_PI + uid: xml.parsers.expat.errors.XML_ERROR_MISPLACED_XML_PI +- fullName: xml.parsers.expat.errors.XML_ERROR_NOT_STANDALONE + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_NOT_STANDALONE + name: XML_ERROR_NOT_STANDALONE + uid: xml.parsers.expat.errors.XML_ERROR_NOT_STANDALONE +- fullName: xml.parsers.expat.errors.XML_ERROR_NOT_SUSPENDED + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_NOT_SUSPENDED + name: XML_ERROR_NOT_SUSPENDED + uid: xml.parsers.expat.errors.XML_ERROR_NOT_SUSPENDED +- fullName: xml.parsers.expat.errors.XML_ERROR_NO_BUFFER + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_NO_BUFFER + name: XML_ERROR_NO_BUFFER + uid: xml.parsers.expat.errors.XML_ERROR_NO_BUFFER +- fullName: xml.parsers.expat.errors.XML_ERROR_NO_ELEMENTS + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_NO_ELEMENTS + name: XML_ERROR_NO_ELEMENTS + uid: xml.parsers.expat.errors.XML_ERROR_NO_ELEMENTS +- fullName: xml.parsers.expat.errors.XML_ERROR_NO_MEMORY + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_NO_MEMORY + name: XML_ERROR_NO_MEMORY + uid: xml.parsers.expat.errors.XML_ERROR_NO_MEMORY +- fullName: xml.parsers.expat.errors.XML_ERROR_PARAM_ENTITY_REF + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_PARAM_ENTITY_REF + name: XML_ERROR_PARAM_ENTITY_REF + uid: xml.parsers.expat.errors.XML_ERROR_PARAM_ENTITY_REF +- fullName: xml.parsers.expat.errors.XML_ERROR_PARTIAL_CHAR + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_PARTIAL_CHAR + name: XML_ERROR_PARTIAL_CHAR + uid: xml.parsers.expat.errors.XML_ERROR_PARTIAL_CHAR +- fullName: xml.parsers.expat.errors.XML_ERROR_PUBLICID + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_PUBLICID + name: XML_ERROR_PUBLICID + uid: xml.parsers.expat.errors.XML_ERROR_PUBLICID +- fullName: xml.parsers.expat.errors.XML_ERROR_RECURSIVE_ENTITY_REF + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_RECURSIVE_ENTITY_REF + name: XML_ERROR_RECURSIVE_ENTITY_REF + uid: xml.parsers.expat.errors.XML_ERROR_RECURSIVE_ENTITY_REF +- fullName: xml.parsers.expat.errors.XML_ERROR_RESERVED_NAMESPACE_URI + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_RESERVED_NAMESPACE_URI + name: XML_ERROR_RESERVED_NAMESPACE_URI + uid: xml.parsers.expat.errors.XML_ERROR_RESERVED_NAMESPACE_URI +- fullName: xml.parsers.expat.errors.XML_ERROR_RESERVED_PREFIX_XML + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_RESERVED_PREFIX_XML + name: XML_ERROR_RESERVED_PREFIX_XML + uid: xml.parsers.expat.errors.XML_ERROR_RESERVED_PREFIX_XML +- fullName: xml.parsers.expat.errors.XML_ERROR_RESERVED_PREFIX_XMLNS + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_RESERVED_PREFIX_XMLNS + name: XML_ERROR_RESERVED_PREFIX_XMLNS + uid: xml.parsers.expat.errors.XML_ERROR_RESERVED_PREFIX_XMLNS +- fullName: xml.parsers.expat.errors.XML_ERROR_SUSPENDED + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_SUSPENDED + name: XML_ERROR_SUSPENDED + uid: xml.parsers.expat.errors.XML_ERROR_SUSPENDED +- fullName: xml.parsers.expat.errors.XML_ERROR_SUSPEND_PE + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_SUSPEND_PE + name: XML_ERROR_SUSPEND_PE + uid: xml.parsers.expat.errors.XML_ERROR_SUSPEND_PE +- fullName: xml.parsers.expat.errors.XML_ERROR_SYNTAX + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_SYNTAX + name: XML_ERROR_SYNTAX + uid: xml.parsers.expat.errors.XML_ERROR_SYNTAX +- fullName: xml.parsers.expat.errors.XML_ERROR_TAG_MISMATCH + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_TAG_MISMATCH + name: XML_ERROR_TAG_MISMATCH + uid: xml.parsers.expat.errors.XML_ERROR_TAG_MISMATCH +- fullName: xml.parsers.expat.errors.XML_ERROR_TEXT_DECL + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_TEXT_DECL + name: XML_ERROR_TEXT_DECL + uid: xml.parsers.expat.errors.XML_ERROR_TEXT_DECL +- fullName: xml.parsers.expat.errors.XML_ERROR_UNBOUND_PREFIX + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_UNBOUND_PREFIX + name: XML_ERROR_UNBOUND_PREFIX + uid: xml.parsers.expat.errors.XML_ERROR_UNBOUND_PREFIX +- fullName: xml.parsers.expat.errors.XML_ERROR_UNCLOSED_CDATA_SECTION + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_UNCLOSED_CDATA_SECTION + name: XML_ERROR_UNCLOSED_CDATA_SECTION + uid: xml.parsers.expat.errors.XML_ERROR_UNCLOSED_CDATA_SECTION +- fullName: xml.parsers.expat.errors.XML_ERROR_UNCLOSED_TOKEN + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_UNCLOSED_TOKEN + name: XML_ERROR_UNCLOSED_TOKEN + uid: xml.parsers.expat.errors.XML_ERROR_UNCLOSED_TOKEN +- fullName: xml.parsers.expat.errors.XML_ERROR_UNDECLARING_PREFIX + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_UNDECLARING_PREFIX + name: XML_ERROR_UNDECLARING_PREFIX + uid: xml.parsers.expat.errors.XML_ERROR_UNDECLARING_PREFIX +- fullName: xml.parsers.expat.errors.XML_ERROR_UNDEFINED_ENTITY + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_UNDEFINED_ENTITY + name: XML_ERROR_UNDEFINED_ENTITY + uid: xml.parsers.expat.errors.XML_ERROR_UNDEFINED_ENTITY +- fullName: xml.parsers.expat.errors.XML_ERROR_UNEXPECTED_STATE + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_UNEXPECTED_STATE + name: XML_ERROR_UNEXPECTED_STATE + uid: xml.parsers.expat.errors.XML_ERROR_UNEXPECTED_STATE +- fullName: xml.parsers.expat.errors.XML_ERROR_UNKNOWN_ENCODING + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_UNKNOWN_ENCODING + name: XML_ERROR_UNKNOWN_ENCODING + uid: xml.parsers.expat.errors.XML_ERROR_UNKNOWN_ENCODING +- fullName: xml.parsers.expat.errors.XML_ERROR_XML_DECL + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.XML_ERROR_XML_DECL + name: XML_ERROR_XML_DECL + uid: xml.parsers.expat.errors.XML_ERROR_XML_DECL +- fullName: xml.parsers.expat.errors.codes + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.codes + name: codes + uid: xml.parsers.expat.errors.codes +- fullName: xml.parsers.expat.errors.messages + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.errors.messages + name: messages + uid: xml.parsers.expat.errors.messages +- fullName: xml.sax.handler.all_features + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.all_features + name: all_features + uid: xml.sax.handler.all_features +- fullName: xml.sax.handler.all_properties + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.all_properties + name: all_properties + uid: xml.sax.handler.all_properties +- fullName: xml.sax.handler.feature_external_ges + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.feature_external_ges + name: feature_external_ges + uid: xml.sax.handler.feature_external_ges +- fullName: xml.sax.handler.feature_external_pes + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.feature_external_pes + name: feature_external_pes + uid: xml.sax.handler.feature_external_pes +- fullName: xml.sax.handler.feature_namespace_prefixes + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.feature_namespace_prefixes + name: feature_namespace_prefixes + uid: xml.sax.handler.feature_namespace_prefixes +- fullName: xml.sax.handler.feature_namespaces + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.feature_namespaces + name: feature_namespaces + uid: xml.sax.handler.feature_namespaces +- fullName: xml.sax.handler.feature_string_interning + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.feature_string_interning + name: feature_string_interning + uid: xml.sax.handler.feature_string_interning +- fullName: xml.sax.handler.feature_validation + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.feature_validation + name: feature_validation + uid: xml.sax.handler.feature_validation +- fullName: xml.sax.handler.property_declaration_handler + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.property_declaration_handler + name: property_declaration_handler + uid: xml.sax.handler.property_declaration_handler +- fullName: xml.sax.handler.property_dom_node + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.property_dom_node + name: property_dom_node + uid: xml.sax.handler.property_dom_node +- fullName: xml.sax.handler.property_lexical_handler + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.property_lexical_handler + name: property_lexical_handler + uid: xml.sax.handler.property_lexical_handler +- fullName: xml.sax.handler.property_xml_string + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.property_xml_string + name: property_xml_string + uid: xml.sax.handler.property_xml_string +- fullName: zipfile.Path.stem + href: https://docs.python.org/3/library/zipfile.html#zipfile.Path.stem + name: stem + uid: zipfile.Path.stem +- fullName: zipfile.Path.suffix + href: https://docs.python.org/3/library/zipfile.html#zipfile.Path.suffix + name: suffix + uid: zipfile.Path.suffix +- fullName: zipfile.Path.suffixes + href: https://docs.python.org/3/library/zipfile.html#zipfile.Path.suffixes + name: suffixes + uid: zipfile.Path.suffixes +- fullName: zipfile.ZIP_BZIP2 + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZIP_BZIP2 + name: ZIP_BZIP2 + uid: zipfile.ZIP_BZIP2 +- fullName: zipfile.ZIP_DEFLATED + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZIP_DEFLATED + name: ZIP_DEFLATED + uid: zipfile.ZIP_DEFLATED +- fullName: zipfile.ZIP_LZMA + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZIP_LZMA + name: ZIP_LZMA + uid: zipfile.ZIP_LZMA +- fullName: zipfile.ZIP_STORED + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZIP_STORED + name: ZIP_STORED + uid: zipfile.ZIP_STORED +- fullName: zlib.ZLIB_RUNTIME_VERSION + href: https://docs.python.org/3/library/zlib.html#zlib.ZLIB_RUNTIME_VERSION + name: ZLIB_RUNTIME_VERSION + uid: zlib.ZLIB_RUNTIME_VERSION +- fullName: zlib.ZLIB_VERSION + href: https://docs.python.org/3/library/zlib.html#zlib.ZLIB_VERSION + name: ZLIB_VERSION + uid: zlib.ZLIB_VERSION +- fullName: zoneinfo.TZPATH + href: https://docs.python.org/3/library/zoneinfo.html#zoneinfo.TZPATH + name: TZPATH + uid: zoneinfo.TZPATH +- fullName: __future__ + href: https://docs.python.org/3/library/__future__.html#module-__future__ + name: __future__ + uid: __future__ +- fullName: __main__ + href: https://docs.python.org/3/library/__main__.html#module-__main__ + name: __main__ + uid: __main__ +- fullName: _thread + href: https://docs.python.org/3/library/_thread.html#module-_thread + name: _thread + uid: _thread +- fullName: _tkinter + href: https://docs.python.org/3/library/tkinter.html#module-_tkinter + name: _tkinter + uid: _tkinter +- fullName: abc + href: https://docs.python.org/3/library/abc.html#module-abc + name: abc + uid: abc +- fullName: aifc + href: https://docs.python.org/3/library/aifc.html#module-aifc + name: aifc + uid: aifc +- fullName: argparse + href: https://docs.python.org/3/library/argparse.html#module-argparse + name: argparse + uid: argparse +- fullName: array + href: https://docs.python.org/3/library/array.html#module-array + name: array + uid: array +- fullName: ast + href: https://docs.python.org/3/library/ast.html#module-ast + name: ast + uid: ast +- fullName: asynchat + href: https://docs.python.org/3/library/asynchat.html#module-asynchat + name: asynchat + uid: asynchat +- fullName: asyncio + href: https://docs.python.org/3/library/asyncio.html#module-asyncio + name: asyncio + uid: asyncio +- fullName: asyncore + href: https://docs.python.org/3/library/asyncore.html#module-asyncore + name: asyncore + uid: asyncore +- fullName: atexit + href: https://docs.python.org/3/library/atexit.html#module-atexit + name: atexit + uid: atexit +- fullName: audioop + href: https://docs.python.org/3/library/audioop.html#module-audioop + name: audioop + uid: audioop +- fullName: base64 + href: https://docs.python.org/3/library/base64.html#module-base64 + name: base64 + uid: base64 +- fullName: bdb + href: https://docs.python.org/3/library/bdb.html#module-bdb + name: bdb + uid: bdb +- fullName: binascii + href: https://docs.python.org/3/library/binascii.html#module-binascii + name: binascii + uid: binascii +- fullName: bisect + href: https://docs.python.org/3/library/bisect.html#module-bisect + name: bisect + uid: bisect +- fullName: builtins + href: https://docs.python.org/3/library/builtins.html#module-builtins + name: builtins + uid: builtins +- fullName: bz2 + href: https://docs.python.org/3/library/bz2.html#module-bz2 + name: bz2 + uid: bz2 +- fullName: cProfile + href: https://docs.python.org/3/library/profile.html#module-cProfile + name: cProfile + uid: cProfile +- fullName: calendar + href: https://docs.python.org/3/library/calendar.html#module-calendar + name: calendar + uid: calendar +- fullName: cgi + href: https://docs.python.org/3/library/cgi.html#module-cgi + name: cgi + uid: cgi +- fullName: cgitb + href: https://docs.python.org/3/library/cgitb.html#module-cgitb + name: cgitb + uid: cgitb +- fullName: chunk + href: https://docs.python.org/3/library/chunk.html#module-chunk + name: chunk + uid: chunk +- fullName: cmath + href: https://docs.python.org/3/library/cmath.html#module-cmath + name: cmath + uid: cmath +- fullName: cmd + href: https://docs.python.org/3/library/cmd.html#module-cmd + name: cmd + uid: cmd +- fullName: code + href: https://docs.python.org/3/library/code.html#module-code + name: code + uid: code +- fullName: codecs + href: https://docs.python.org/3/library/codecs.html#module-codecs + name: codecs + uid: codecs +- fullName: codeop + href: https://docs.python.org/3/library/codeop.html#module-codeop + name: codeop + uid: codeop +- fullName: collections + href: https://docs.python.org/3/library/collections.html#module-collections + name: collections + uid: collections +- fullName: collections.abc + href: https://docs.python.org/3/library/collections.abc.html#module-collections.abc + name: abc + uid: collections.abc +- fullName: colorsys + href: https://docs.python.org/3/library/colorsys.html#module-colorsys + name: colorsys + uid: colorsys +- fullName: compileall + href: https://docs.python.org/3/library/compileall.html#module-compileall + name: compileall + uid: compileall +- fullName: concurrent.futures + href: https://docs.python.org/3/library/concurrent.futures.html#module-concurrent.futures + name: futures + uid: concurrent.futures +- fullName: configparser + href: https://docs.python.org/3/library/configparser.html#module-configparser + name: configparser + uid: configparser +- fullName: contextlib + href: https://docs.python.org/3/library/contextlib.html#module-contextlib + name: contextlib + uid: contextlib +- fullName: contextvars + href: https://docs.python.org/3/library/contextvars.html#module-contextvars + name: contextvars + uid: contextvars +- fullName: copy + href: https://docs.python.org/3/library/copy.html#module-copy + name: copy + uid: copy +- fullName: copyreg + href: https://docs.python.org/3/library/copyreg.html#module-copyreg + name: copyreg + uid: copyreg +- fullName: crypt + href: https://docs.python.org/3/library/crypt.html#module-crypt + name: crypt + uid: crypt +- fullName: csv + href: https://docs.python.org/3/library/csv.html#module-csv + name: csv + uid: csv +- fullName: ctypes + href: https://docs.python.org/3/library/ctypes.html#module-ctypes + name: ctypes + uid: ctypes +- fullName: curses + href: https://docs.python.org/3/library/curses.html#module-curses + name: curses + uid: curses +- fullName: curses.ascii + href: https://docs.python.org/3/library/curses.ascii.html#module-curses.ascii + name: ascii + uid: curses.ascii +- fullName: curses.panel + href: https://docs.python.org/3/library/curses.panel.html#module-curses.panel + name: panel + uid: curses.panel +- fullName: curses.textpad + href: https://docs.python.org/3/library/curses.html#module-curses.textpad + name: textpad + uid: curses.textpad +- fullName: dataclasses + href: https://docs.python.org/3/library/dataclasses.html#module-dataclasses + name: dataclasses + uid: dataclasses +- fullName: datetime + href: https://docs.python.org/3/library/datetime.html#module-datetime + name: datetime + uid: datetime +- fullName: dbm + href: https://docs.python.org/3/library/dbm.html#module-dbm + name: dbm + uid: dbm +- fullName: dbm.dumb + href: https://docs.python.org/3/library/dbm.html#module-dbm.dumb + name: dumb + uid: dbm.dumb +- fullName: dbm.gnu + href: https://docs.python.org/3/library/dbm.html#module-dbm.gnu + name: gnu + uid: dbm.gnu +- fullName: dbm.ndbm + href: https://docs.python.org/3/library/dbm.html#module-dbm.ndbm + name: ndbm + uid: dbm.ndbm +- fullName: dbm.sqlite3 + href: https://docs.python.org/3/library/dbm.html#module-dbm.sqlite3 + name: sqlite3 + uid: dbm.sqlite3 +- fullName: decimal + href: https://docs.python.org/3/library/decimal.html#module-decimal + name: decimal + uid: decimal +- fullName: difflib + href: https://docs.python.org/3/library/difflib.html#module-difflib + name: difflib + uid: difflib +- fullName: dis + href: https://docs.python.org/3/library/dis.html#module-dis + name: dis + uid: dis +- fullName: distutils + href: https://docs.python.org/3/library/distutils.html#module-distutils + name: distutils + uid: distutils +- fullName: doctest + href: https://docs.python.org/3/library/doctest.html#module-doctest + name: doctest + uid: doctest +- fullName: email + href: https://docs.python.org/3/library/email.html#module-email + name: email + uid: email +- fullName: email.charset + href: https://docs.python.org/3/library/email.charset.html#module-email.charset + name: charset + uid: email.charset +- fullName: email.contentmanager + href: https://docs.python.org/3/library/email.contentmanager.html#module-email.contentmanager + name: contentmanager + uid: email.contentmanager +- fullName: email.encoders + href: https://docs.python.org/3/library/email.encoders.html#module-email.encoders + name: encoders + uid: email.encoders +- fullName: email.errors + href: https://docs.python.org/3/library/email.errors.html#module-email.errors + name: errors + uid: email.errors +- fullName: email.generator + href: https://docs.python.org/3/library/email.generator.html#module-email.generator + name: generator + uid: email.generator +- fullName: email.header + href: https://docs.python.org/3/library/email.header.html#module-email.header + name: header + uid: email.header +- fullName: email.headerregistry + href: https://docs.python.org/3/library/email.headerregistry.html#module-email.headerregistry + name: headerregistry + uid: email.headerregistry +- fullName: email.iterators + href: https://docs.python.org/3/library/email.iterators.html#module-email.iterators + name: iterators + uid: email.iterators +- fullName: email.message + href: https://docs.python.org/3/library/email.message.html#module-email.message + name: message + uid: email.message +- fullName: email.mime + href: https://docs.python.org/3/library/email.mime.html#module-email.mime + name: mime + uid: email.mime +- fullName: email.mime.application + href: https://docs.python.org/3/library/email.mime.html#module-email.mime.application + name: application + uid: email.mime.application +- fullName: email.mime.audio + href: https://docs.python.org/3/library/email.mime.html#module-email.mime.audio + name: audio + uid: email.mime.audio +- fullName: email.mime.base + href: https://docs.python.org/3/library/email.mime.html#module-email.mime.base + name: base + uid: email.mime.base +- fullName: email.mime.image + href: https://docs.python.org/3/library/email.mime.html#module-email.mime.image + name: image + uid: email.mime.image +- fullName: email.mime.message + href: https://docs.python.org/3/library/email.mime.html#module-email.mime.message + name: message + uid: email.mime.message +- fullName: email.mime.multipart + href: https://docs.python.org/3/library/email.mime.html#module-email.mime.multipart + name: multipart + uid: email.mime.multipart +- fullName: email.mime.nonmultipart + href: https://docs.python.org/3/library/email.mime.html#module-email.mime.nonmultipart + name: nonmultipart + uid: email.mime.nonmultipart +- fullName: email.mime.text + href: https://docs.python.org/3/library/email.mime.html#module-email.mime.text + name: text + uid: email.mime.text +- fullName: email.parser + href: https://docs.python.org/3/library/email.parser.html#module-email.parser + name: parser + uid: email.parser +- fullName: email.policy + href: https://docs.python.org/3/library/email.policy.html#module-email.policy + name: policy + uid: email.policy +- fullName: email.utils + href: https://docs.python.org/3/library/email.utils.html#module-email.utils + name: utils + uid: email.utils +- fullName: encodings.idna + href: https://docs.python.org/3/library/codecs.html#module-encodings.idna + name: idna + uid: encodings.idna +- fullName: encodings.mbcs + href: https://docs.python.org/3/library/codecs.html#module-encodings.mbcs + name: mbcs + uid: encodings.mbcs +- fullName: encodings.utf_8_sig + href: https://docs.python.org/3/library/codecs.html#module-encodings.utf_8_sig + name: utf_8_sig + uid: encodings.utf_8_sig +- fullName: ensurepip + href: https://docs.python.org/3/library/ensurepip.html#module-ensurepip + name: ensurepip + uid: ensurepip +- fullName: enum + href: https://docs.python.org/3/library/enum.html#module-enum + name: enum + uid: enum +- fullName: errno + href: https://docs.python.org/3/library/errno.html#module-errno + name: errno + uid: errno +- fullName: faulthandler + href: https://docs.python.org/3/library/faulthandler.html#module-faulthandler + name: faulthandler + uid: faulthandler +- fullName: fcntl + href: https://docs.python.org/3/library/fcntl.html#module-fcntl + name: fcntl + uid: fcntl +- fullName: filecmp + href: https://docs.python.org/3/library/filecmp.html#module-filecmp + name: filecmp + uid: filecmp +- fullName: fileinput + href: https://docs.python.org/3/library/fileinput.html#module-fileinput + name: fileinput + uid: fileinput +- fullName: fnmatch + href: https://docs.python.org/3/library/fnmatch.html#module-fnmatch + name: fnmatch + uid: fnmatch +- fullName: fractions + href: https://docs.python.org/3/library/fractions.html#module-fractions + name: fractions + uid: fractions +- fullName: ftplib + href: https://docs.python.org/3/library/ftplib.html#module-ftplib + name: ftplib + uid: ftplib +- fullName: functools + href: https://docs.python.org/3/library/functools.html#module-functools + name: functools + uid: functools +- fullName: gc + href: https://docs.python.org/3/library/gc.html#module-gc + name: gc + uid: gc +- fullName: getopt + href: https://docs.python.org/3/library/getopt.html#module-getopt + name: getopt + uid: getopt +- fullName: getpass + href: https://docs.python.org/3/library/getpass.html#module-getpass + name: getpass + uid: getpass +- fullName: gettext + href: https://docs.python.org/3/library/gettext.html#module-gettext + name: gettext + uid: gettext +- fullName: glob + href: https://docs.python.org/3/library/glob.html#module-glob + name: glob + uid: glob +- fullName: graphlib + href: https://docs.python.org/3/library/graphlib.html#module-graphlib + name: graphlib + uid: graphlib +- fullName: grp + href: https://docs.python.org/3/library/grp.html#module-grp + name: grp + uid: grp +- fullName: gzip + href: https://docs.python.org/3/library/gzip.html#module-gzip + name: gzip + uid: gzip +- fullName: hashlib + href: https://docs.python.org/3/library/hashlib.html#module-hashlib + name: hashlib + uid: hashlib +- fullName: heapq + href: https://docs.python.org/3/library/heapq.html#module-heapq + name: heapq + uid: heapq +- fullName: hmac + href: https://docs.python.org/3/library/hmac.html#module-hmac + name: hmac + uid: hmac +- fullName: html + href: https://docs.python.org/3/library/html.html#module-html + name: html + uid: html +- fullName: html.entities + href: https://docs.python.org/3/library/html.entities.html#module-html.entities + name: entities + uid: html.entities +- fullName: html.parser + href: https://docs.python.org/3/library/html.parser.html#module-html.parser + name: parser + uid: html.parser +- fullName: http + href: https://docs.python.org/3/library/http.html#module-http + name: http + uid: http +- fullName: http.client + href: https://docs.python.org/3/library/http.client.html#module-http.client + name: client + uid: http.client +- fullName: http.cookiejar + href: https://docs.python.org/3/library/http.cookiejar.html#module-http.cookiejar + name: cookiejar + uid: http.cookiejar +- fullName: http.cookies + href: https://docs.python.org/3/library/http.cookies.html#module-http.cookies + name: cookies + uid: http.cookies +- fullName: http.server + href: https://docs.python.org/3/library/http.server.html#module-http.server + name: server + uid: http.server +- fullName: idlelib + href: https://docs.python.org/3/library/idle.html#module-idlelib + name: idlelib + uid: idlelib +- fullName: imaplib + href: https://docs.python.org/3/library/imaplib.html#module-imaplib + name: imaplib + uid: imaplib +- fullName: imghdr + href: https://docs.python.org/3/library/imghdr.html#module-imghdr + name: imghdr + uid: imghdr +- fullName: imp + href: https://docs.python.org/3/library/imp.html#module-imp + name: imp + uid: imp +- fullName: importlib + href: https://docs.python.org/3/library/importlib.html#module-importlib + name: importlib + uid: importlib +- fullName: importlib.abc + href: https://docs.python.org/3/library/importlib.html#module-importlib.abc + name: abc + uid: importlib.abc +- fullName: importlib.machinery + href: https://docs.python.org/3/library/importlib.html#module-importlib.machinery + name: machinery + uid: importlib.machinery +- fullName: importlib.metadata + href: https://docs.python.org/3/library/importlib.metadata.html#module-importlib.metadata + name: metadata + uid: importlib.metadata +- fullName: importlib.resources + href: https://docs.python.org/3/library/importlib.resources.html#module-importlib.resources + name: resources + uid: importlib.resources +- fullName: importlib.resources.abc + href: https://docs.python.org/3/library/importlib.resources.abc.html#module-importlib.resources.abc + name: abc + uid: importlib.resources.abc +- fullName: importlib.util + href: https://docs.python.org/3/library/importlib.html#module-importlib.util + name: util + uid: importlib.util +- fullName: inspect + href: https://docs.python.org/3/library/inspect.html#module-inspect + name: inspect + uid: inspect +- fullName: io + href: https://docs.python.org/3/library/io.html#module-io + name: io + uid: io +- fullName: ipaddress + href: https://docs.python.org/3/library/ipaddress.html#module-ipaddress + name: ipaddress + uid: ipaddress +- fullName: itertools + href: https://docs.python.org/3/library/itertools.html#module-itertools + name: itertools + uid: itertools +- fullName: json + href: https://docs.python.org/3/library/json.html#module-json + name: json + uid: json +- fullName: json.tool + href: https://docs.python.org/3/library/json.html#module-json.tool + name: tool + uid: json.tool +- fullName: keyword + href: https://docs.python.org/3/library/keyword.html#module-keyword + name: keyword + uid: keyword +- fullName: linecache + href: https://docs.python.org/3/library/linecache.html#module-linecache + name: linecache + uid: linecache +- fullName: locale + href: https://docs.python.org/3/library/locale.html#module-locale + name: locale + uid: locale +- fullName: logging + href: https://docs.python.org/3/library/logging.html#module-logging + name: logging + uid: logging +- fullName: logging.config + href: https://docs.python.org/3/library/logging.config.html#module-logging.config + name: config + uid: logging.config +- fullName: logging.handlers + href: https://docs.python.org/3/library/logging.handlers.html#module-logging.handlers + name: handlers + uid: logging.handlers +- fullName: lzma + href: https://docs.python.org/3/library/lzma.html#module-lzma + name: lzma + uid: lzma +- fullName: mailbox + href: https://docs.python.org/3/library/mailbox.html#module-mailbox + name: mailbox + uid: mailbox +- fullName: mailcap + href: https://docs.python.org/3/library/mailcap.html#module-mailcap + name: mailcap + uid: mailcap +- fullName: marshal + href: https://docs.python.org/3/library/marshal.html#module-marshal + name: marshal + uid: marshal +- fullName: math + href: https://docs.python.org/3/library/math.html#module-math + name: math + uid: math +- fullName: mimetypes + href: https://docs.python.org/3/library/mimetypes.html#module-mimetypes + name: mimetypes + uid: mimetypes +- fullName: mmap + href: https://docs.python.org/3/library/mmap.html#module-mmap + name: mmap + uid: mmap +- fullName: modulefinder + href: https://docs.python.org/3/library/modulefinder.html#module-modulefinder + name: modulefinder + uid: modulefinder +- fullName: msilib + href: https://docs.python.org/3/library/msilib.html#module-msilib + name: msilib + uid: msilib +- fullName: msvcrt + href: https://docs.python.org/3/library/msvcrt.html#module-msvcrt + name: msvcrt + uid: msvcrt +- fullName: multiprocessing + href: https://docs.python.org/3/library/multiprocessing.html#module-multiprocessing + name: multiprocessing + uid: multiprocessing +- fullName: multiprocessing.connection + href: https://docs.python.org/3/library/multiprocessing.html#module-multiprocessing.connection + name: connection + uid: multiprocessing.connection +- fullName: multiprocessing.dummy + href: https://docs.python.org/3/library/multiprocessing.html#module-multiprocessing.dummy + name: dummy + uid: multiprocessing.dummy +- fullName: multiprocessing.managers + href: https://docs.python.org/3/library/multiprocessing.html#module-multiprocessing.managers + name: managers + uid: multiprocessing.managers +- fullName: multiprocessing.pool + href: https://docs.python.org/3/library/multiprocessing.html#module-multiprocessing.pool + name: pool + uid: multiprocessing.pool +- fullName: multiprocessing.shared_memory + href: https://docs.python.org/3/library/multiprocessing.shared_memory.html#module-multiprocessing.shared_memory + name: shared_memory + uid: multiprocessing.shared_memory +- fullName: multiprocessing.sharedctypes + href: https://docs.python.org/3/library/multiprocessing.html#module-multiprocessing.sharedctypes + name: sharedctypes + uid: multiprocessing.sharedctypes +- fullName: netrc + href: https://docs.python.org/3/library/netrc.html#module-netrc + name: netrc + uid: netrc +- fullName: nis + href: https://docs.python.org/3/library/nis.html#module-nis + name: nis + uid: nis +- fullName: nntplib + href: https://docs.python.org/3/library/nntplib.html#module-nntplib + name: nntplib + uid: nntplib +- fullName: numbers + href: https://docs.python.org/3/library/numbers.html#module-numbers + name: numbers + uid: numbers +- fullName: operator + href: https://docs.python.org/3/library/operator.html#module-operator + name: operator + uid: operator +- fullName: optparse + href: https://docs.python.org/3/library/optparse.html#module-optparse + name: optparse + uid: optparse +- fullName: os + href: https://docs.python.org/3/library/os.html#module-os + name: os + uid: os +- fullName: os.path + href: https://docs.python.org/3/library/os.path.html#module-os.path + name: path + uid: os.path +- fullName: ossaudiodev + href: https://docs.python.org/3/library/ossaudiodev.html#module-ossaudiodev + name: ossaudiodev + uid: ossaudiodev +- fullName: pathlib + href: https://docs.python.org/3/library/pathlib.html#module-pathlib + name: pathlib + uid: pathlib +- fullName: pdb + href: https://docs.python.org/3/library/pdb.html#module-pdb + name: pdb + uid: pdb +- fullName: pickle + href: https://docs.python.org/3/library/pickle.html#module-pickle + name: pickle + uid: pickle +- fullName: pickletools + href: https://docs.python.org/3/library/pickletools.html#module-pickletools + name: pickletools + uid: pickletools +- fullName: pipes + href: https://docs.python.org/3/library/pipes.html#module-pipes + name: pipes + uid: pipes +- fullName: pkgutil + href: https://docs.python.org/3/library/pkgutil.html#module-pkgutil + name: pkgutil + uid: pkgutil +- fullName: platform + href: https://docs.python.org/3/library/platform.html#module-platform + name: platform + uid: platform +- fullName: plistlib + href: https://docs.python.org/3/library/plistlib.html#module-plistlib + name: plistlib + uid: plistlib +- fullName: poplib + href: https://docs.python.org/3/library/poplib.html#module-poplib + name: poplib + uid: poplib +- fullName: posix + href: https://docs.python.org/3/library/posix.html#module-posix + name: posix + uid: posix +- fullName: pprint + href: https://docs.python.org/3/library/pprint.html#module-pprint + name: pprint + uid: pprint +- fullName: profile + href: https://docs.python.org/3/library/profile.html#module-profile + name: profile + uid: profile +- fullName: pstats + href: https://docs.python.org/3/library/profile.html#module-pstats + name: pstats + uid: pstats +- fullName: pty + href: https://docs.python.org/3/library/pty.html#module-pty + name: pty + uid: pty +- fullName: pwd + href: https://docs.python.org/3/library/pwd.html#module-pwd + name: pwd + uid: pwd +- fullName: py_compile + href: https://docs.python.org/3/library/py_compile.html#module-py_compile + name: py_compile + uid: py_compile +- fullName: pyclbr + href: https://docs.python.org/3/library/pyclbr.html#module-pyclbr + name: pyclbr + uid: pyclbr +- fullName: pydoc + href: https://docs.python.org/3/library/pydoc.html#module-pydoc + name: pydoc + uid: pydoc +- fullName: queue + href: https://docs.python.org/3/library/queue.html#module-queue + name: queue + uid: queue +- fullName: quopri + href: https://docs.python.org/3/library/quopri.html#module-quopri + name: quopri + uid: quopri +- fullName: random + href: https://docs.python.org/3/library/random.html#module-random + name: random + uid: random +- fullName: re + href: https://docs.python.org/3/library/re.html#module-re + name: re + uid: re +- fullName: readline + href: https://docs.python.org/3/library/readline.html#module-readline + name: readline + uid: readline +- fullName: reprlib + href: https://docs.python.org/3/library/reprlib.html#module-reprlib + name: reprlib + uid: reprlib +- fullName: resource + href: https://docs.python.org/3/library/resource.html#module-resource + name: resource + uid: resource +- fullName: rlcompleter + href: https://docs.python.org/3/library/rlcompleter.html#module-rlcompleter + name: rlcompleter + uid: rlcompleter +- fullName: runpy + href: https://docs.python.org/3/library/runpy.html#module-runpy + name: runpy + uid: runpy +- fullName: sched + href: https://docs.python.org/3/library/sched.html#module-sched + name: sched + uid: sched +- fullName: secrets + href: https://docs.python.org/3/library/secrets.html#module-secrets + name: secrets + uid: secrets +- fullName: select + href: https://docs.python.org/3/library/select.html#module-select + name: select + uid: select +- fullName: selectors + href: https://docs.python.org/3/library/selectors.html#module-selectors + name: selectors + uid: selectors +- fullName: shelve + href: https://docs.python.org/3/library/shelve.html#module-shelve + name: shelve + uid: shelve +- fullName: shlex + href: https://docs.python.org/3/library/shlex.html#module-shlex + name: shlex + uid: shlex +- fullName: shutil + href: https://docs.python.org/3/library/shutil.html#module-shutil + name: shutil + uid: shutil +- fullName: signal + href: https://docs.python.org/3/library/signal.html#module-signal + name: signal + uid: signal +- fullName: site + href: https://docs.python.org/3/library/site.html#module-site + name: site + uid: site +- fullName: sitecustomize + href: https://docs.python.org/3/library/site.html#module-sitecustomize + name: sitecustomize + uid: sitecustomize +- fullName: smtpd + href: https://docs.python.org/3/library/smtpd.html#module-smtpd + name: smtpd + uid: smtpd +- fullName: smtplib + href: https://docs.python.org/3/library/smtplib.html#module-smtplib + name: smtplib + uid: smtplib +- fullName: sndhdr + href: https://docs.python.org/3/library/sndhdr.html#module-sndhdr + name: sndhdr + uid: sndhdr +- fullName: socket + href: https://docs.python.org/3/library/socket.html#module-socket + name: socket + uid: socket +- fullName: socketserver + href: https://docs.python.org/3/library/socketserver.html#module-socketserver + name: socketserver + uid: socketserver +- fullName: spwd + href: https://docs.python.org/3/library/spwd.html#module-spwd + name: spwd + uid: spwd +- fullName: sqlite3 + href: https://docs.python.org/3/library/sqlite3.html#module-sqlite3 + name: sqlite3 + uid: sqlite3 +- fullName: ssl + href: https://docs.python.org/3/library/ssl.html#module-ssl + name: ssl + uid: ssl +- fullName: stat + href: https://docs.python.org/3/library/stat.html#module-stat + name: stat + uid: stat +- fullName: statistics + href: https://docs.python.org/3/library/statistics.html#module-statistics + name: statistics + uid: statistics +- fullName: string + href: https://docs.python.org/3/library/string.html#module-string + name: string + uid: string +- fullName: stringprep + href: https://docs.python.org/3/library/stringprep.html#module-stringprep + name: stringprep + uid: stringprep +- fullName: struct + href: https://docs.python.org/3/library/struct.html#module-struct + name: struct + uid: struct +- fullName: subprocess + href: https://docs.python.org/3/library/subprocess.html#module-subprocess + name: subprocess + uid: subprocess +- fullName: sunau + href: https://docs.python.org/3/library/sunau.html#module-sunau + name: sunau + uid: sunau +- fullName: symtable + href: https://docs.python.org/3/library/symtable.html#module-symtable + name: symtable + uid: symtable +- fullName: sys + href: https://docs.python.org/3/library/sys.html#module-sys + name: sys + uid: sys +- fullName: sys.monitoring + href: https://docs.python.org/3/library/sys.monitoring.html#module-sys.monitoring + name: monitoring + uid: sys.monitoring +- fullName: sysconfig + href: https://docs.python.org/3/library/sysconfig.html#module-sysconfig + name: sysconfig + uid: sysconfig +- fullName: syslog + href: https://docs.python.org/3/library/syslog.html#module-syslog + name: syslog + uid: syslog +- fullName: tabnanny + href: https://docs.python.org/3/library/tabnanny.html#module-tabnanny + name: tabnanny + uid: tabnanny +- fullName: tarfile + href: https://docs.python.org/3/library/tarfile.html#module-tarfile + name: tarfile + uid: tarfile +- fullName: telnetlib + href: https://docs.python.org/3/library/telnetlib.html#module-telnetlib + name: telnetlib + uid: telnetlib +- fullName: tempfile + href: https://docs.python.org/3/library/tempfile.html#module-tempfile + name: tempfile + uid: tempfile +- fullName: termios + href: https://docs.python.org/3/library/termios.html#module-termios + name: termios + uid: termios +- fullName: test + href: https://docs.python.org/3/library/test.html#module-test + name: test + uid: test +- fullName: test.regrtest + href: https://docs.python.org/3/library/test.html#module-test.regrtest + name: regrtest + uid: test.regrtest +- fullName: test.support + href: https://docs.python.org/3/library/test.html#module-test.support + name: support + uid: test.support +- fullName: test.support.bytecode_helper + href: https://docs.python.org/3/library/test.html#module-test.support.bytecode_helper + name: bytecode_helper + uid: test.support.bytecode_helper +- fullName: test.support.import_helper + href: https://docs.python.org/3/library/test.html#module-test.support.import_helper + name: import_helper + uid: test.support.import_helper +- fullName: test.support.os_helper + href: https://docs.python.org/3/library/test.html#module-test.support.os_helper + name: os_helper + uid: test.support.os_helper +- fullName: test.support.script_helper + href: https://docs.python.org/3/library/test.html#module-test.support.script_helper + name: script_helper + uid: test.support.script_helper +- fullName: test.support.socket_helper + href: https://docs.python.org/3/library/test.html#module-test.support.socket_helper + name: socket_helper + uid: test.support.socket_helper +- fullName: test.support.threading_helper + href: https://docs.python.org/3/library/test.html#module-test.support.threading_helper + name: threading_helper + uid: test.support.threading_helper +- fullName: test.support.warnings_helper + href: https://docs.python.org/3/library/test.html#module-test.support.warnings_helper + name: warnings_helper + uid: test.support.warnings_helper +- fullName: textwrap + href: https://docs.python.org/3/library/textwrap.html#module-textwrap + name: textwrap + uid: textwrap +- fullName: threading + href: https://docs.python.org/3/library/threading.html#module-threading + name: threading + uid: threading +- fullName: time + href: https://docs.python.org/3/library/time.html#module-time + name: time + uid: time +- fullName: timeit + href: https://docs.python.org/3/library/timeit.html#module-timeit + name: timeit + uid: timeit +- fullName: tkinter + href: https://docs.python.org/3/library/tkinter.html#module-tkinter + name: tkinter + uid: tkinter +- fullName: tkinter.colorchooser + href: https://docs.python.org/3/library/tkinter.colorchooser.html#module-tkinter.colorchooser + name: colorchooser + uid: tkinter.colorchooser +- fullName: tkinter.commondialog + href: https://docs.python.org/3/library/dialog.html#module-tkinter.commondialog + name: commondialog + uid: tkinter.commondialog +- fullName: tkinter.dnd + href: https://docs.python.org/3/library/tkinter.dnd.html#module-tkinter.dnd + name: dnd + uid: tkinter.dnd +- fullName: tkinter.filedialog + href: https://docs.python.org/3/library/dialog.html#module-tkinter.filedialog + name: filedialog + uid: tkinter.filedialog +- fullName: tkinter.font + href: https://docs.python.org/3/library/tkinter.font.html#module-tkinter.font + name: font + uid: tkinter.font +- fullName: tkinter.messagebox + href: https://docs.python.org/3/library/tkinter.messagebox.html#module-tkinter.messagebox + name: messagebox + uid: tkinter.messagebox +- fullName: tkinter.scrolledtext + href: https://docs.python.org/3/library/tkinter.scrolledtext.html#module-tkinter.scrolledtext + name: scrolledtext + uid: tkinter.scrolledtext +- fullName: tkinter.simpledialog + href: https://docs.python.org/3/library/dialog.html#module-tkinter.simpledialog + name: simpledialog + uid: tkinter.simpledialog +- fullName: tkinter.ttk + href: https://docs.python.org/3/library/tkinter.ttk.html#module-tkinter.ttk + name: ttk + uid: tkinter.ttk +- fullName: token + href: https://docs.python.org/3/library/token.html#module-token + name: token + uid: token +- fullName: tokenize + href: https://docs.python.org/3/library/tokenize.html#module-tokenize + name: tokenize + uid: tokenize +- fullName: tomllib + href: https://docs.python.org/3/library/tomllib.html#module-tomllib + name: tomllib + uid: tomllib +- fullName: trace + href: https://docs.python.org/3/library/trace.html#module-trace + name: trace + uid: trace +- fullName: traceback + href: https://docs.python.org/3/library/traceback.html#module-traceback + name: traceback + uid: traceback +- fullName: tracemalloc + href: https://docs.python.org/3/library/tracemalloc.html#module-tracemalloc + name: tracemalloc + uid: tracemalloc +- fullName: tty + href: https://docs.python.org/3/library/tty.html#module-tty + name: tty + uid: tty +- fullName: turtle + href: https://docs.python.org/3/library/turtle.html#module-turtle + name: turtle + uid: turtle +- fullName: turtledemo + href: https://docs.python.org/3/library/turtle.html#module-turtledemo + name: turtledemo + uid: turtledemo +- fullName: types + href: https://docs.python.org/3/library/types.html#module-types + name: types + uid: types +- fullName: typing + href: https://docs.python.org/3/library/typing.html#module-typing + name: typing + uid: typing +- fullName: unicodedata + href: https://docs.python.org/3/library/unicodedata.html#module-unicodedata + name: unicodedata + uid: unicodedata +- fullName: unittest + href: https://docs.python.org/3/library/unittest.html#module-unittest + name: unittest + uid: unittest +- fullName: unittest.mock + href: https://docs.python.org/3/library/unittest.mock.html#module-unittest.mock + name: mock + uid: unittest.mock +- fullName: urllib + href: https://docs.python.org/3/library/urllib.html#module-urllib + name: urllib + uid: urllib +- fullName: urllib.error + href: https://docs.python.org/3/library/urllib.error.html#module-urllib.error + name: error + uid: urllib.error +- fullName: urllib.parse + href: https://docs.python.org/3/library/urllib.parse.html#module-urllib.parse + name: parse + uid: urllib.parse +- fullName: urllib.request + href: https://docs.python.org/3/library/urllib.request.html#module-urllib.request + name: request + uid: urllib.request +- fullName: urllib.response + href: https://docs.python.org/3/library/urllib.request.html#module-urllib.response + name: response + uid: urllib.response +- fullName: urllib.robotparser + href: https://docs.python.org/3/library/urllib.robotparser.html#module-urllib.robotparser + name: robotparser + uid: urllib.robotparser +- fullName: usercustomize + href: https://docs.python.org/3/library/site.html#module-usercustomize + name: usercustomize + uid: usercustomize +- fullName: uu + href: https://docs.python.org/3/library/uu.html#module-uu + name: uu + uid: uu +- fullName: uuid + href: https://docs.python.org/3/library/uuid.html#module-uuid + name: uuid + uid: uuid +- fullName: venv + href: https://docs.python.org/3/library/venv.html#module-venv + name: venv + uid: venv +- fullName: warnings + href: https://docs.python.org/3/library/warnings.html#module-warnings + name: warnings + uid: warnings +- fullName: wave + href: https://docs.python.org/3/library/wave.html#module-wave + name: wave + uid: wave +- fullName: weakref + href: https://docs.python.org/3/library/weakref.html#module-weakref + name: weakref + uid: weakref +- fullName: webbrowser + href: https://docs.python.org/3/library/webbrowser.html#module-webbrowser + name: webbrowser + uid: webbrowser +- fullName: winreg + href: https://docs.python.org/3/library/winreg.html#module-winreg + name: winreg + uid: winreg +- fullName: winsound + href: https://docs.python.org/3/library/winsound.html#module-winsound + name: winsound + uid: winsound +- fullName: wsgiref + href: https://docs.python.org/3/library/wsgiref.html#module-wsgiref + name: wsgiref + uid: wsgiref +- fullName: wsgiref.handlers + href: https://docs.python.org/3/library/wsgiref.html#module-wsgiref.handlers + name: handlers + uid: wsgiref.handlers +- fullName: wsgiref.headers + href: https://docs.python.org/3/library/wsgiref.html#module-wsgiref.headers + name: headers + uid: wsgiref.headers +- fullName: wsgiref.simple_server + href: https://docs.python.org/3/library/wsgiref.html#module-wsgiref.simple_server + name: simple_server + uid: wsgiref.simple_server +- fullName: wsgiref.types + href: https://docs.python.org/3/library/wsgiref.html#module-wsgiref.types + name: types + uid: wsgiref.types +- fullName: wsgiref.util + href: https://docs.python.org/3/library/wsgiref.html#module-wsgiref.util + name: util + uid: wsgiref.util +- fullName: wsgiref.validate + href: https://docs.python.org/3/library/wsgiref.html#module-wsgiref.validate + name: validate + uid: wsgiref.validate +- fullName: xdrlib + href: https://docs.python.org/3/library/xdrlib.html#module-xdrlib + name: xdrlib + uid: xdrlib +- fullName: xml + href: https://docs.python.org/3/library/xml.html#module-xml + name: xml + uid: xml +- fullName: xml.dom + href: https://docs.python.org/3/library/xml.dom.html#module-xml.dom + name: dom + uid: xml.dom +- fullName: xml.dom.minidom + href: https://docs.python.org/3/library/xml.dom.minidom.html#module-xml.dom.minidom + name: minidom + uid: xml.dom.minidom +- fullName: xml.dom.pulldom + href: https://docs.python.org/3/library/xml.dom.pulldom.html#module-xml.dom.pulldom + name: pulldom + uid: xml.dom.pulldom +- fullName: xml.etree.ElementInclude + href: https://docs.python.org/3/library/xml.etree.elementtree.html#module-xml.etree.ElementInclude + name: ElementInclude + uid: xml.etree.ElementInclude +- fullName: xml.etree.ElementTree + href: https://docs.python.org/3/library/xml.etree.elementtree.html#module-xml.etree.ElementTree + name: ElementTree + uid: xml.etree.ElementTree +- fullName: xml.parsers.expat + href: https://docs.python.org/3/library/pyexpat.html#module-xml.parsers.expat + name: expat + uid: xml.parsers.expat +- fullName: xml.parsers.expat.errors + href: https://docs.python.org/3/library/pyexpat.html#module-xml.parsers.expat.errors + name: errors + uid: xml.parsers.expat.errors +- fullName: xml.parsers.expat.model + href: https://docs.python.org/3/library/pyexpat.html#module-xml.parsers.expat.model + name: model + uid: xml.parsers.expat.model +- fullName: xml.sax + href: https://docs.python.org/3/library/xml.sax.html#module-xml.sax + name: sax + uid: xml.sax +- fullName: xml.sax.handler + href: https://docs.python.org/3/library/xml.sax.handler.html#module-xml.sax.handler + name: handler + uid: xml.sax.handler +- fullName: xml.sax.saxutils + href: https://docs.python.org/3/library/xml.sax.utils.html#module-xml.sax.saxutils + name: saxutils + uid: xml.sax.saxutils +- fullName: xml.sax.xmlreader + href: https://docs.python.org/3/library/xml.sax.reader.html#module-xml.sax.xmlreader + name: xmlreader + uid: xml.sax.xmlreader +- fullName: xmlrpc + href: https://docs.python.org/3/library/xmlrpc.html#module-xmlrpc + name: xmlrpc + uid: xmlrpc +- fullName: xmlrpc.client + href: https://docs.python.org/3/library/xmlrpc.client.html#module-xmlrpc.client + name: client + uid: xmlrpc.client +- fullName: xmlrpc.server + href: https://docs.python.org/3/library/xmlrpc.server.html#module-xmlrpc.server + name: server + uid: xmlrpc.server +- fullName: zipapp + href: https://docs.python.org/3/library/zipapp.html#module-zipapp + name: zipapp + uid: zipapp +- fullName: zipfile + href: https://docs.python.org/3/library/zipfile.html#module-zipfile + name: zipfile + uid: zipfile +- fullName: zipimport + href: https://docs.python.org/3/library/zipimport.html#module-zipimport + name: zipimport + uid: zipimport +- fullName: zlib + href: https://docs.python.org/3/library/zlib.html#module-zlib + name: zlib + uid: zlib +- fullName: zoneinfo + href: https://docs.python.org/3/library/zoneinfo.html#module-zoneinfo + name: zoneinfo + uid: zoneinfo +- fullName: __future__._Feature + href: https://docs.python.org/3/library/__future__.html#future__._Feature + name: _Feature + uid: __future__._Feature +- fullName: abc.ABC + href: https://docs.python.org/3/library/abc.html#abc.ABC + name: ABC + uid: abc.ABC +- fullName: abc.ABCMeta + href: https://docs.python.org/3/library/abc.html#abc.ABCMeta + name: ABCMeta + uid: abc.ABCMeta +- fullName: argparse.Action + href: https://docs.python.org/3/library/argparse.html#argparse.Action + name: Action + uid: argparse.Action +- fullName: argparse.ArgumentDefaultsHelpFormatter + href: https://docs.python.org/3/library/argparse.html#argparse.ArgumentDefaultsHelpFormatter + name: ArgumentDefaultsHelpFormatter + uid: argparse.ArgumentDefaultsHelpFormatter +- fullName: argparse.ArgumentParser + href: https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser + name: ArgumentParser + uid: argparse.ArgumentParser +- fullName: argparse.BooleanOptionalAction + href: https://docs.python.org/3/library/argparse.html#argparse.BooleanOptionalAction + name: BooleanOptionalAction + uid: argparse.BooleanOptionalAction +- fullName: argparse.FileType + href: https://docs.python.org/3/library/argparse.html#argparse.FileType + name: FileType + uid: argparse.FileType +- fullName: argparse.MetavarTypeHelpFormatter + href: https://docs.python.org/3/library/argparse.html#argparse.MetavarTypeHelpFormatter + name: MetavarTypeHelpFormatter + uid: argparse.MetavarTypeHelpFormatter +- fullName: argparse.Namespace + href: https://docs.python.org/3/library/argparse.html#argparse.Namespace + name: Namespace + uid: argparse.Namespace +- fullName: argparse.RawDescriptionHelpFormatter + href: https://docs.python.org/3/library/argparse.html#argparse.RawDescriptionHelpFormatter + name: RawDescriptionHelpFormatter + uid: argparse.RawDescriptionHelpFormatter +- fullName: argparse.RawTextHelpFormatter + href: https://docs.python.org/3/library/argparse.html#argparse.RawTextHelpFormatter + name: RawTextHelpFormatter + uid: argparse.RawTextHelpFormatter +- fullName: array.array + href: https://docs.python.org/3/library/array.html#array.array + name: array + uid: array.array +- fullName: ast.AST + href: https://docs.python.org/3/library/ast.html#ast.AST + name: AST + uid: ast.AST +- fullName: ast.Add + href: https://docs.python.org/3/library/ast.html#ast.Add + name: Add + uid: ast.Add +- fullName: ast.And + href: https://docs.python.org/3/library/ast.html#ast.And + name: And + uid: ast.And +- fullName: ast.AnnAssign + href: https://docs.python.org/3/library/ast.html#ast.AnnAssign + name: AnnAssign + uid: ast.AnnAssign +- fullName: ast.Assert + href: https://docs.python.org/3/library/ast.html#ast.Assert + name: Assert + uid: ast.Assert +- fullName: ast.Assign + href: https://docs.python.org/3/library/ast.html#ast.Assign + name: Assign + uid: ast.Assign +- fullName: ast.AsyncFor + href: https://docs.python.org/3/library/ast.html#ast.AsyncFor + name: AsyncFor + uid: ast.AsyncFor +- fullName: ast.AsyncFunctionDef + href: https://docs.python.org/3/library/ast.html#ast.AsyncFunctionDef + name: AsyncFunctionDef + uid: ast.AsyncFunctionDef +- fullName: ast.AsyncWith + href: https://docs.python.org/3/library/ast.html#ast.AsyncWith + name: AsyncWith + uid: ast.AsyncWith +- fullName: ast.Attribute + href: https://docs.python.org/3/library/ast.html#ast.Attribute + name: Attribute + uid: ast.Attribute +- fullName: ast.AugAssign + href: https://docs.python.org/3/library/ast.html#ast.AugAssign + name: AugAssign + uid: ast.AugAssign +- fullName: ast.Await + href: https://docs.python.org/3/library/ast.html#ast.Await + name: Await + uid: ast.Await +- fullName: ast.BinOp + href: https://docs.python.org/3/library/ast.html#ast.BinOp + name: BinOp + uid: ast.BinOp +- fullName: ast.BitAnd + href: https://docs.python.org/3/library/ast.html#ast.BitAnd + name: BitAnd + uid: ast.BitAnd +- fullName: ast.BitOr + href: https://docs.python.org/3/library/ast.html#ast.BitOr + name: BitOr + uid: ast.BitOr +- fullName: ast.BitXor + href: https://docs.python.org/3/library/ast.html#ast.BitXor + name: BitXor + uid: ast.BitXor +- fullName: ast.BoolOp + href: https://docs.python.org/3/library/ast.html#ast.BoolOp + name: BoolOp + uid: ast.BoolOp +- fullName: ast.Break + href: https://docs.python.org/3/library/ast.html#ast.Break + name: Break + uid: ast.Break +- fullName: ast.Call + href: https://docs.python.org/3/library/ast.html#ast.Call + name: Call + uid: ast.Call +- fullName: ast.ClassDef + href: https://docs.python.org/3/library/ast.html#ast.ClassDef + name: ClassDef + uid: ast.ClassDef +- fullName: ast.Compare + href: https://docs.python.org/3/library/ast.html#ast.Compare + name: Compare + uid: ast.Compare +- fullName: ast.Constant + href: https://docs.python.org/3/library/ast.html#ast.Constant + name: Constant + uid: ast.Constant +- fullName: ast.Continue + href: https://docs.python.org/3/library/ast.html#ast.Continue + name: Continue + uid: ast.Continue +- fullName: ast.Del + href: https://docs.python.org/3/library/ast.html#ast.Del + name: Del + uid: ast.Del +- fullName: ast.Delete + href: https://docs.python.org/3/library/ast.html#ast.Delete + name: Delete + uid: ast.Delete +- fullName: ast.Dict + href: https://docs.python.org/3/library/ast.html#ast.Dict + name: Dict + uid: ast.Dict +- fullName: ast.DictComp + href: https://docs.python.org/3/library/ast.html#ast.DictComp + name: DictComp + uid: ast.DictComp +- fullName: ast.Div + href: https://docs.python.org/3/library/ast.html#ast.Div + name: Div + uid: ast.Div +- fullName: ast.Eq + href: https://docs.python.org/3/library/ast.html#ast.Eq + name: Eq + uid: ast.Eq +- fullName: ast.ExceptHandler + href: https://docs.python.org/3/library/ast.html#ast.ExceptHandler + name: ExceptHandler + uid: ast.ExceptHandler +- fullName: ast.Expr + href: https://docs.python.org/3/library/ast.html#ast.Expr + name: Expr + uid: ast.Expr +- fullName: ast.Expression + href: https://docs.python.org/3/library/ast.html#ast.Expression + name: Expression + uid: ast.Expression +- fullName: ast.FloorDiv + href: https://docs.python.org/3/library/ast.html#ast.FloorDiv + name: FloorDiv + uid: ast.FloorDiv +- fullName: ast.For + href: https://docs.python.org/3/library/ast.html#ast.For + name: For + uid: ast.For +- fullName: ast.FormattedValue + href: https://docs.python.org/3/library/ast.html#ast.FormattedValue + name: FormattedValue + uid: ast.FormattedValue +- fullName: ast.FunctionDef + href: https://docs.python.org/3/library/ast.html#ast.FunctionDef + name: FunctionDef + uid: ast.FunctionDef +- fullName: ast.FunctionType + href: https://docs.python.org/3/library/ast.html#ast.FunctionType + name: FunctionType + uid: ast.FunctionType +- fullName: ast.GeneratorExp + href: https://docs.python.org/3/library/ast.html#ast.GeneratorExp + name: GeneratorExp + uid: ast.GeneratorExp +- fullName: ast.Global + href: https://docs.python.org/3/library/ast.html#ast.Global + name: Global + uid: ast.Global +- fullName: ast.Gt + href: https://docs.python.org/3/library/ast.html#ast.Gt + name: Gt + uid: ast.Gt +- fullName: ast.GtE + href: https://docs.python.org/3/library/ast.html#ast.GtE + name: GtE + uid: ast.GtE +- fullName: ast.If + href: https://docs.python.org/3/library/ast.html#ast.If + name: If + uid: ast.If +- fullName: ast.IfExp + href: https://docs.python.org/3/library/ast.html#ast.IfExp + name: IfExp + uid: ast.IfExp +- fullName: ast.Import + href: https://docs.python.org/3/library/ast.html#ast.Import + name: Import + uid: ast.Import +- fullName: ast.ImportFrom + href: https://docs.python.org/3/library/ast.html#ast.ImportFrom + name: ImportFrom + uid: ast.ImportFrom +- fullName: ast.In + href: https://docs.python.org/3/library/ast.html#ast.In + name: In + uid: ast.In +- fullName: ast.Interactive + href: https://docs.python.org/3/library/ast.html#ast.Interactive + name: Interactive + uid: ast.Interactive +- fullName: ast.Invert + href: https://docs.python.org/3/library/ast.html#ast.Invert + name: Invert + uid: ast.Invert +- fullName: ast.Is + href: https://docs.python.org/3/library/ast.html#ast.Is + name: Is + uid: ast.Is +- fullName: ast.IsNot + href: https://docs.python.org/3/library/ast.html#ast.IsNot + name: IsNot + uid: ast.IsNot +- fullName: ast.JoinedStr + href: https://docs.python.org/3/library/ast.html#ast.JoinedStr + name: JoinedStr + uid: ast.JoinedStr +- fullName: ast.LShift + href: https://docs.python.org/3/library/ast.html#ast.LShift + name: LShift + uid: ast.LShift +- fullName: ast.Lambda + href: https://docs.python.org/3/library/ast.html#ast.Lambda + name: Lambda + uid: ast.Lambda +- fullName: ast.List + href: https://docs.python.org/3/library/ast.html#ast.List + name: List + uid: ast.List +- fullName: ast.ListComp + href: https://docs.python.org/3/library/ast.html#ast.ListComp + name: ListComp + uid: ast.ListComp +- fullName: ast.Load + href: https://docs.python.org/3/library/ast.html#ast.Load + name: Load + uid: ast.Load +- fullName: ast.Lt + href: https://docs.python.org/3/library/ast.html#ast.Lt + name: Lt + uid: ast.Lt +- fullName: ast.LtE + href: https://docs.python.org/3/library/ast.html#ast.LtE + name: LtE + uid: ast.LtE +- fullName: ast.MatMult + href: https://docs.python.org/3/library/ast.html#ast.MatMult + name: MatMult + uid: ast.MatMult +- fullName: ast.Match + href: https://docs.python.org/3/library/ast.html#ast.Match + name: Match + uid: ast.Match +- fullName: ast.MatchAs + href: https://docs.python.org/3/library/ast.html#ast.MatchAs + name: MatchAs + uid: ast.MatchAs +- fullName: ast.MatchClass + href: https://docs.python.org/3/library/ast.html#ast.MatchClass + name: MatchClass + uid: ast.MatchClass +- fullName: ast.MatchMapping + href: https://docs.python.org/3/library/ast.html#ast.MatchMapping + name: MatchMapping + uid: ast.MatchMapping +- fullName: ast.MatchOr + href: https://docs.python.org/3/library/ast.html#ast.MatchOr + name: MatchOr + uid: ast.MatchOr +- fullName: ast.MatchSequence + href: https://docs.python.org/3/library/ast.html#ast.MatchSequence + name: MatchSequence + uid: ast.MatchSequence +- fullName: ast.MatchSingleton + href: https://docs.python.org/3/library/ast.html#ast.MatchSingleton + name: MatchSingleton + uid: ast.MatchSingleton +- fullName: ast.MatchStar + href: https://docs.python.org/3/library/ast.html#ast.MatchStar + name: MatchStar + uid: ast.MatchStar +- fullName: ast.MatchValue + href: https://docs.python.org/3/library/ast.html#ast.MatchValue + name: MatchValue + uid: ast.MatchValue +- fullName: ast.Mod + href: https://docs.python.org/3/library/ast.html#ast.Mod + name: Mod + uid: ast.Mod +- fullName: ast.Module + href: https://docs.python.org/3/library/ast.html#ast.Module + name: Module + uid: ast.Module +- fullName: ast.Mult + href: https://docs.python.org/3/library/ast.html#ast.Mult + name: Mult + uid: ast.Mult +- fullName: ast.Name + href: https://docs.python.org/3/library/ast.html#ast.Name + name: Name + uid: ast.Name +- fullName: ast.NamedExpr + href: https://docs.python.org/3/library/ast.html#ast.NamedExpr + name: NamedExpr + uid: ast.NamedExpr +- fullName: ast.NodeTransformer + href: https://docs.python.org/3/library/ast.html#ast.NodeTransformer + name: NodeTransformer + uid: ast.NodeTransformer +- fullName: ast.NodeVisitor + href: https://docs.python.org/3/library/ast.html#ast.NodeVisitor + name: NodeVisitor + uid: ast.NodeVisitor +- fullName: ast.Nonlocal + href: https://docs.python.org/3/library/ast.html#ast.Nonlocal + name: Nonlocal + uid: ast.Nonlocal +- fullName: ast.Not + href: https://docs.python.org/3/library/ast.html#ast.Not + name: Not + uid: ast.Not +- fullName: ast.NotEq + href: https://docs.python.org/3/library/ast.html#ast.NotEq + name: NotEq + uid: ast.NotEq +- fullName: ast.NotIn + href: https://docs.python.org/3/library/ast.html#ast.NotIn + name: NotIn + uid: ast.NotIn +- fullName: ast.Or + href: https://docs.python.org/3/library/ast.html#ast.Or + name: Or + uid: ast.Or +- fullName: ast.ParamSpec + href: https://docs.python.org/3/library/ast.html#ast.ParamSpec + name: ParamSpec + uid: ast.ParamSpec +- fullName: ast.Pass + href: https://docs.python.org/3/library/ast.html#ast.Pass + name: Pass + uid: ast.Pass +- fullName: ast.Pow + href: https://docs.python.org/3/library/ast.html#ast.Pow + name: Pow + uid: ast.Pow +- fullName: ast.RShift + href: https://docs.python.org/3/library/ast.html#ast.RShift + name: RShift + uid: ast.RShift +- fullName: ast.Raise + href: https://docs.python.org/3/library/ast.html#ast.Raise + name: Raise + uid: ast.Raise +- fullName: ast.Return + href: https://docs.python.org/3/library/ast.html#ast.Return + name: Return + uid: ast.Return +- fullName: ast.Set + href: https://docs.python.org/3/library/ast.html#ast.Set + name: Set + uid: ast.Set +- fullName: ast.SetComp + href: https://docs.python.org/3/library/ast.html#ast.SetComp + name: SetComp + uid: ast.SetComp +- fullName: ast.Slice + href: https://docs.python.org/3/library/ast.html#ast.Slice + name: Slice + uid: ast.Slice +- fullName: ast.Starred + href: https://docs.python.org/3/library/ast.html#ast.Starred + name: Starred + uid: ast.Starred +- fullName: ast.Store + href: https://docs.python.org/3/library/ast.html#ast.Store + name: Store + uid: ast.Store +- fullName: ast.Sub + href: https://docs.python.org/3/library/ast.html#ast.Sub + name: Sub + uid: ast.Sub +- fullName: ast.Subscript + href: https://docs.python.org/3/library/ast.html#ast.Subscript + name: Subscript + uid: ast.Subscript +- fullName: ast.Try + href: https://docs.python.org/3/library/ast.html#ast.Try + name: Try + uid: ast.Try +- fullName: ast.TryStar + href: https://docs.python.org/3/library/ast.html#ast.TryStar + name: TryStar + uid: ast.TryStar +- fullName: ast.Tuple + href: https://docs.python.org/3/library/ast.html#ast.Tuple + name: Tuple + uid: ast.Tuple +- fullName: ast.TypeAlias + href: https://docs.python.org/3/library/ast.html#ast.TypeAlias + name: TypeAlias + uid: ast.TypeAlias +- fullName: ast.TypeVar + href: https://docs.python.org/3/library/ast.html#ast.TypeVar + name: TypeVar + uid: ast.TypeVar +- fullName: ast.TypeVarTuple + href: https://docs.python.org/3/library/ast.html#ast.TypeVarTuple + name: TypeVarTuple + uid: ast.TypeVarTuple +- fullName: ast.UAdd + href: https://docs.python.org/3/library/ast.html#ast.UAdd + name: UAdd + uid: ast.UAdd +- fullName: ast.USub + href: https://docs.python.org/3/library/ast.html#ast.USub + name: USub + uid: ast.USub +- fullName: ast.UnaryOp + href: https://docs.python.org/3/library/ast.html#ast.UnaryOp + name: UnaryOp + uid: ast.UnaryOp +- fullName: ast.While + href: https://docs.python.org/3/library/ast.html#ast.While + name: While + uid: ast.While +- fullName: ast.With + href: https://docs.python.org/3/library/ast.html#ast.With + name: With + uid: ast.With +- fullName: ast.Yield + href: https://docs.python.org/3/library/ast.html#ast.Yield + name: Yield + uid: ast.Yield +- fullName: ast.YieldFrom + href: https://docs.python.org/3/library/ast.html#ast.YieldFrom + name: YieldFrom + uid: ast.YieldFrom +- fullName: ast.alias + href: https://docs.python.org/3/library/ast.html#ast.alias + name: alias + uid: ast.alias +- fullName: ast.arg + href: https://docs.python.org/3/library/ast.html#ast.arg + name: arg + uid: ast.arg +- fullName: ast.arguments + href: https://docs.python.org/3/library/ast.html#ast.arguments + name: arguments + uid: ast.arguments +- fullName: ast.comprehension + href: https://docs.python.org/3/library/ast.html#ast.comprehension + name: comprehension + uid: ast.comprehension +- fullName: ast.keyword + href: https://docs.python.org/3/library/ast.html#ast.keyword + name: keyword + uid: ast.keyword +- fullName: ast.match_case + href: https://docs.python.org/3/library/ast.html#ast.match_case + name: match_case + uid: ast.match_case +- fullName: ast.withitem + href: https://docs.python.org/3/library/ast.html#ast.withitem + name: withitem + uid: ast.withitem +- fullName: asyncio.AbstractChildWatcher + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.AbstractChildWatcher + name: AbstractChildWatcher + uid: asyncio.AbstractChildWatcher +- fullName: asyncio.AbstractEventLoop + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.AbstractEventLoop + name: AbstractEventLoop + uid: asyncio.AbstractEventLoop +- fullName: asyncio.AbstractEventLoopPolicy + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.AbstractEventLoopPolicy + name: AbstractEventLoopPolicy + uid: asyncio.AbstractEventLoopPolicy +- fullName: asyncio.Barrier + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Barrier + name: Barrier + uid: asyncio.Barrier +- fullName: asyncio.BaseProtocol + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.BaseProtocol + name: BaseProtocol + uid: asyncio.BaseProtocol +- fullName: asyncio.BaseTransport + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.BaseTransport + name: BaseTransport + uid: asyncio.BaseTransport +- fullName: asyncio.BoundedSemaphore + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.BoundedSemaphore + name: BoundedSemaphore + uid: asyncio.BoundedSemaphore +- fullName: asyncio.BufferedProtocol + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.BufferedProtocol + name: BufferedProtocol + uid: asyncio.BufferedProtocol +- fullName: asyncio.Condition + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Condition + name: Condition + uid: asyncio.Condition +- fullName: asyncio.DatagramProtocol + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.DatagramProtocol + name: DatagramProtocol + uid: asyncio.DatagramProtocol +- fullName: asyncio.DatagramTransport + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.DatagramTransport + name: DatagramTransport + uid: asyncio.DatagramTransport +- fullName: asyncio.DefaultEventLoopPolicy + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.DefaultEventLoopPolicy + name: DefaultEventLoopPolicy + uid: asyncio.DefaultEventLoopPolicy +- fullName: asyncio.Event + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Event + name: Event + uid: asyncio.Event +- fullName: asyncio.EventLoop + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.EventLoop + name: EventLoop + uid: asyncio.EventLoop +- fullName: asyncio.FastChildWatcher + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.FastChildWatcher + name: FastChildWatcher + uid: asyncio.FastChildWatcher +- fullName: asyncio.Future + href: https://docs.python.org/3/library/asyncio-future.html#asyncio.Future + name: Future + uid: asyncio.Future +- fullName: asyncio.Handle + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.Handle + name: Handle + uid: asyncio.Handle +- fullName: asyncio.LifoQueue + href: https://docs.python.org/3/library/asyncio-queue.html#asyncio.LifoQueue + name: LifoQueue + uid: asyncio.LifoQueue +- fullName: asyncio.Lock + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Lock + name: Lock + uid: asyncio.Lock +- fullName: asyncio.MultiLoopChildWatcher + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.MultiLoopChildWatcher + name: MultiLoopChildWatcher + uid: asyncio.MultiLoopChildWatcher +- fullName: asyncio.PidfdChildWatcher + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.PidfdChildWatcher + name: PidfdChildWatcher + uid: asyncio.PidfdChildWatcher +- fullName: asyncio.PriorityQueue + href: https://docs.python.org/3/library/asyncio-queue.html#asyncio.PriorityQueue + name: PriorityQueue + uid: asyncio.PriorityQueue +- fullName: asyncio.ProactorEventLoop + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.ProactorEventLoop + name: ProactorEventLoop + uid: asyncio.ProactorEventLoop +- fullName: asyncio.Protocol + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.Protocol + name: Protocol + uid: asyncio.Protocol +- fullName: asyncio.Queue + href: https://docs.python.org/3/library/asyncio-queue.html#asyncio.Queue + name: Queue + uid: asyncio.Queue +- fullName: asyncio.ReadTransport + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.ReadTransport + name: ReadTransport + uid: asyncio.ReadTransport +- fullName: asyncio.Runner + href: https://docs.python.org/3/library/asyncio-runner.html#asyncio.Runner + name: Runner + uid: asyncio.Runner +- fullName: asyncio.SafeChildWatcher + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.SafeChildWatcher + name: SafeChildWatcher + uid: asyncio.SafeChildWatcher +- fullName: asyncio.SelectorEventLoop + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.SelectorEventLoop + name: SelectorEventLoop + uid: asyncio.SelectorEventLoop +- fullName: asyncio.Semaphore + href: https://docs.python.org/3/library/asyncio-sync.html#asyncio.Semaphore + name: Semaphore + uid: asyncio.Semaphore +- fullName: asyncio.Server + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.Server + name: Server + uid: asyncio.Server +- fullName: asyncio.StreamReader + href: https://docs.python.org/3/library/asyncio-stream.html#asyncio.StreamReader + name: StreamReader + uid: asyncio.StreamReader +- fullName: asyncio.StreamWriter + href: https://docs.python.org/3/library/asyncio-stream.html#asyncio.StreamWriter + name: StreamWriter + uid: asyncio.StreamWriter +- fullName: asyncio.SubprocessProtocol + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.SubprocessProtocol + name: SubprocessProtocol + uid: asyncio.SubprocessProtocol +- fullName: asyncio.SubprocessTransport + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.SubprocessTransport + name: SubprocessTransport + uid: asyncio.SubprocessTransport +- fullName: asyncio.Task + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.Task + name: Task + uid: asyncio.Task +- fullName: asyncio.TaskGroup + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.TaskGroup + name: TaskGroup + uid: asyncio.TaskGroup +- fullName: asyncio.ThreadedChildWatcher + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.ThreadedChildWatcher + name: ThreadedChildWatcher + uid: asyncio.ThreadedChildWatcher +- fullName: asyncio.Timeout + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.Timeout + name: Timeout + uid: asyncio.Timeout +- fullName: asyncio.TimerHandle + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.TimerHandle + name: TimerHandle + uid: asyncio.TimerHandle +- fullName: asyncio.Transport + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.Transport + name: Transport + uid: asyncio.Transport +- fullName: asyncio.WindowsProactorEventLoopPolicy + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.WindowsProactorEventLoopPolicy + name: WindowsProactorEventLoopPolicy + uid: asyncio.WindowsProactorEventLoopPolicy +- fullName: asyncio.WindowsSelectorEventLoopPolicy + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.WindowsSelectorEventLoopPolicy + name: WindowsSelectorEventLoopPolicy + uid: asyncio.WindowsSelectorEventLoopPolicy +- fullName: asyncio.WriteTransport + href: https://docs.python.org/3/library/asyncio-protocol.html#asyncio.WriteTransport + name: WriteTransport + uid: asyncio.WriteTransport +- fullName: asyncio.subprocess.Process + href: https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.subprocess.Process + name: Process + uid: asyncio.subprocess.Process +- fullName: bdb.Bdb + href: https://docs.python.org/3/library/bdb.html#bdb.Bdb + name: Bdb + uid: bdb.Bdb +- fullName: bdb.Breakpoint + href: https://docs.python.org/3/library/bdb.html#bdb.Breakpoint + name: Breakpoint + uid: bdb.Breakpoint +- fullName: bool + href: https://docs.python.org/3/library/functions.html#bool + name: bool + uid: bool +- fullName: bytearray + href: https://docs.python.org/3/library/stdtypes.html#bytearray + name: bytearray + uid: bytearray +- fullName: bytes + href: https://docs.python.org/3/library/stdtypes.html#bytes + name: bytes + uid: bytes +- fullName: bz2.BZ2Compressor + href: https://docs.python.org/3/library/bz2.html#bz2.BZ2Compressor + name: BZ2Compressor + uid: bz2.BZ2Compressor +- fullName: bz2.BZ2Decompressor + href: https://docs.python.org/3/library/bz2.html#bz2.BZ2Decompressor + name: BZ2Decompressor + uid: bz2.BZ2Decompressor +- fullName: bz2.BZ2File + href: https://docs.python.org/3/library/bz2.html#bz2.BZ2File + name: BZ2File + uid: bz2.BZ2File +- fullName: calendar.Calendar + href: https://docs.python.org/3/library/calendar.html#calendar.Calendar + name: Calendar + uid: calendar.Calendar +- fullName: calendar.Day + href: https://docs.python.org/3/library/calendar.html#calendar.Day + name: Day + uid: calendar.Day +- fullName: calendar.HTMLCalendar + href: https://docs.python.org/3/library/calendar.html#calendar.HTMLCalendar + name: HTMLCalendar + uid: calendar.HTMLCalendar +- fullName: calendar.LocaleHTMLCalendar + href: https://docs.python.org/3/library/calendar.html#calendar.LocaleHTMLCalendar + name: LocaleHTMLCalendar + uid: calendar.LocaleHTMLCalendar +- fullName: calendar.LocaleTextCalendar + href: https://docs.python.org/3/library/calendar.html#calendar.LocaleTextCalendar + name: LocaleTextCalendar + uid: calendar.LocaleTextCalendar +- fullName: calendar.Month + href: https://docs.python.org/3/library/calendar.html#calendar.Month + name: Month + uid: calendar.Month +- fullName: calendar.TextCalendar + href: https://docs.python.org/3/library/calendar.html#calendar.TextCalendar + name: TextCalendar + uid: calendar.TextCalendar +- fullName: cmd.Cmd + href: https://docs.python.org/3/library/cmd.html#cmd.Cmd + name: Cmd + uid: cmd.Cmd +- fullName: code.InteractiveConsole + href: https://docs.python.org/3/library/code.html#code.InteractiveConsole + name: InteractiveConsole + uid: code.InteractiveConsole +- fullName: code.InteractiveInterpreter + href: https://docs.python.org/3/library/code.html#code.InteractiveInterpreter + name: InteractiveInterpreter + uid: code.InteractiveInterpreter +- fullName: codecs.Codec + href: https://docs.python.org/3/library/codecs.html#codecs.Codec + name: Codec + uid: codecs.Codec +- fullName: codecs.CodecInfo + href: https://docs.python.org/3/library/codecs.html#codecs.CodecInfo + name: CodecInfo + uid: codecs.CodecInfo +- fullName: codecs.IncrementalDecoder + href: https://docs.python.org/3/library/codecs.html#codecs.IncrementalDecoder + name: IncrementalDecoder + uid: codecs.IncrementalDecoder +- fullName: codecs.IncrementalEncoder + href: https://docs.python.org/3/library/codecs.html#codecs.IncrementalEncoder + name: IncrementalEncoder + uid: codecs.IncrementalEncoder +- fullName: codecs.StreamReader + href: https://docs.python.org/3/library/codecs.html#codecs.StreamReader + name: StreamReader + uid: codecs.StreamReader +- fullName: codecs.StreamReaderWriter + href: https://docs.python.org/3/library/codecs.html#codecs.StreamReaderWriter + name: StreamReaderWriter + uid: codecs.StreamReaderWriter +- fullName: codecs.StreamRecoder + href: https://docs.python.org/3/library/codecs.html#codecs.StreamRecoder + name: StreamRecoder + uid: codecs.StreamRecoder +- fullName: codecs.StreamWriter + href: https://docs.python.org/3/library/codecs.html#codecs.StreamWriter + name: StreamWriter + uid: codecs.StreamWriter +- fullName: codeop.CommandCompiler + href: https://docs.python.org/3/library/codeop.html#codeop.CommandCompiler + name: CommandCompiler + uid: codeop.CommandCompiler +- fullName: codeop.Compile + href: https://docs.python.org/3/library/codeop.html#codeop.Compile + name: Compile + uid: codeop.Compile +- fullName: collections.ChainMap + href: https://docs.python.org/3/library/collections.html#collections.ChainMap + name: ChainMap + uid: collections.ChainMap +- fullName: collections.Counter + href: https://docs.python.org/3/library/collections.html#collections.Counter + name: Counter + uid: collections.Counter +- fullName: collections.OrderedDict + href: https://docs.python.org/3/library/collections.html#collections.OrderedDict + name: OrderedDict + uid: collections.OrderedDict +- fullName: collections.UserDict + href: https://docs.python.org/3/library/collections.html#collections.UserDict + name: UserDict + uid: collections.UserDict +- fullName: collections.UserList + href: https://docs.python.org/3/library/collections.html#collections.UserList + name: UserList + uid: collections.UserList +- fullName: collections.UserString + href: https://docs.python.org/3/library/collections.html#collections.UserString + name: UserString + uid: collections.UserString +- fullName: collections.abc.AsyncGenerator + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.AsyncGenerator + name: AsyncGenerator + uid: collections.abc.AsyncGenerator +- fullName: collections.abc.AsyncIterable + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.AsyncIterable + name: AsyncIterable + uid: collections.abc.AsyncIterable +- fullName: collections.abc.AsyncIterator + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.AsyncIterator + name: AsyncIterator + uid: collections.abc.AsyncIterator +- fullName: collections.abc.Awaitable + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.Awaitable + name: Awaitable + uid: collections.abc.Awaitable +- fullName: collections.abc.Buffer + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.Buffer + name: Buffer + uid: collections.abc.Buffer +- fullName: collections.abc.ByteString + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.ByteString + name: ByteString + uid: collections.abc.ByteString +- fullName: collections.abc.Callable + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable + name: Callable + uid: collections.abc.Callable +- fullName: collections.abc.Collection + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.Collection + name: Collection + uid: collections.abc.Collection +- fullName: collections.abc.Container + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.Container + name: Container + uid: collections.abc.Container +- fullName: collections.abc.Coroutine + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.Coroutine + name: Coroutine + uid: collections.abc.Coroutine +- fullName: collections.abc.Generator + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.Generator + name: Generator + uid: collections.abc.Generator +- fullName: collections.abc.Hashable + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.Hashable + name: Hashable + uid: collections.abc.Hashable +- fullName: collections.abc.ItemsView + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.ItemsView + name: ItemsView + uid: collections.abc.ItemsView +- fullName: collections.abc.Iterable + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterable + name: Iterable + uid: collections.abc.Iterable +- fullName: collections.abc.Iterator + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.Iterator + name: Iterator + uid: collections.abc.Iterator +- fullName: collections.abc.KeysView + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.KeysView + name: KeysView + uid: collections.abc.KeysView +- fullName: collections.abc.Mapping + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping + name: Mapping + uid: collections.abc.Mapping +- fullName: collections.abc.MappingView + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.MappingView + name: MappingView + uid: collections.abc.MappingView +- fullName: collections.abc.MutableMapping + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.MutableMapping + name: MutableMapping + uid: collections.abc.MutableMapping +- fullName: collections.abc.MutableSequence + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.MutableSequence + name: MutableSequence + uid: collections.abc.MutableSequence +- fullName: collections.abc.MutableSet + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.MutableSet + name: MutableSet + uid: collections.abc.MutableSet +- fullName: collections.abc.Reversible + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.Reversible + name: Reversible + uid: collections.abc.Reversible +- fullName: collections.abc.Sequence + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.Sequence + name: Sequence + uid: collections.abc.Sequence +- fullName: collections.abc.Set + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.Set + name: Set + uid: collections.abc.Set +- fullName: collections.abc.Sized + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.Sized + name: Sized + uid: collections.abc.Sized +- fullName: collections.abc.ValuesView + href: https://docs.python.org/3/library/collections.abc.html#collections.abc.ValuesView + name: ValuesView + uid: collections.abc.ValuesView +- fullName: collections.defaultdict + href: https://docs.python.org/3/library/collections.html#collections.defaultdict + name: defaultdict + uid: collections.defaultdict +- fullName: collections.deque + href: https://docs.python.org/3/library/collections.html#collections.deque + name: deque + uid: collections.deque +- fullName: complex + href: https://docs.python.org/3/library/functions.html#complex + name: complex + uid: complex +- fullName: concurrent.futures.Executor + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Executor + name: Executor + uid: concurrent.futures.Executor +- fullName: concurrent.futures.Future + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.Future + name: Future + uid: concurrent.futures.Future +- fullName: concurrent.futures.ProcessPoolExecutor + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.ProcessPoolExecutor + name: ProcessPoolExecutor + uid: concurrent.futures.ProcessPoolExecutor +- fullName: concurrent.futures.ThreadPoolExecutor + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.ThreadPoolExecutor + name: ThreadPoolExecutor + uid: concurrent.futures.ThreadPoolExecutor +- fullName: configparser.BasicInterpolation + href: https://docs.python.org/3/library/configparser.html#configparser.BasicInterpolation + name: BasicInterpolation + uid: configparser.BasicInterpolation +- fullName: configparser.ConfigParser + href: https://docs.python.org/3/library/configparser.html#configparser.ConfigParser + name: ConfigParser + uid: configparser.ConfigParser +- fullName: configparser.ExtendedInterpolation + href: https://docs.python.org/3/library/configparser.html#configparser.ExtendedInterpolation + name: ExtendedInterpolation + uid: configparser.ExtendedInterpolation +- fullName: configparser.RawConfigParser + href: https://docs.python.org/3/library/configparser.html#configparser.RawConfigParser + name: RawConfigParser + uid: configparser.RawConfigParser +- fullName: contextlib.AbstractAsyncContextManager + href: https://docs.python.org/3/library/contextlib.html#contextlib.AbstractAsyncContextManager + name: AbstractAsyncContextManager + uid: contextlib.AbstractAsyncContextManager +- fullName: contextlib.AbstractContextManager + href: https://docs.python.org/3/library/contextlib.html#contextlib.AbstractContextManager + name: AbstractContextManager + uid: contextlib.AbstractContextManager +- fullName: contextlib.AsyncContextDecorator + href: https://docs.python.org/3/library/contextlib.html#contextlib.AsyncContextDecorator + name: AsyncContextDecorator + uid: contextlib.AsyncContextDecorator +- fullName: contextlib.AsyncExitStack + href: https://docs.python.org/3/library/contextlib.html#contextlib.AsyncExitStack + name: AsyncExitStack + uid: contextlib.AsyncExitStack +- fullName: contextlib.ContextDecorator + href: https://docs.python.org/3/library/contextlib.html#contextlib.ContextDecorator + name: ContextDecorator + uid: contextlib.ContextDecorator +- fullName: contextlib.ExitStack + href: https://docs.python.org/3/library/contextlib.html#contextlib.ExitStack + name: ExitStack + uid: contextlib.ExitStack +- fullName: contextvars.Context + href: https://docs.python.org/3/library/contextvars.html#contextvars.Context + name: Context + uid: contextvars.Context +- fullName: contextvars.ContextVar + href: https://docs.python.org/3/library/contextvars.html#contextvars.ContextVar + name: ContextVar + uid: contextvars.ContextVar +- fullName: contextvars.Token + href: https://docs.python.org/3/library/contextvars.html#contextvars.Token + name: Token + uid: contextvars.Token +- fullName: csv.Dialect + href: https://docs.python.org/3/library/csv.html#csv.Dialect + name: Dialect + uid: csv.Dialect +- fullName: csv.DictReader + href: https://docs.python.org/3/library/csv.html#csv.DictReader + name: DictReader + uid: csv.DictReader +- fullName: csv.DictWriter + href: https://docs.python.org/3/library/csv.html#csv.DictWriter + name: DictWriter + uid: csv.DictWriter +- fullName: csv.Sniffer + href: https://docs.python.org/3/library/csv.html#csv.Sniffer + name: Sniffer + uid: csv.Sniffer +- fullName: csv.excel + href: https://docs.python.org/3/library/csv.html#csv.excel + name: excel + uid: csv.excel +- fullName: csv.excel_tab + href: https://docs.python.org/3/library/csv.html#csv.excel_tab + name: excel_tab + uid: csv.excel_tab +- fullName: csv.unix_dialect + href: https://docs.python.org/3/library/csv.html#csv.unix_dialect + name: unix_dialect + uid: csv.unix_dialect +- fullName: ctypes.Array + href: https://docs.python.org/3/library/ctypes.html#ctypes.Array + name: Array + uid: ctypes.Array +- fullName: ctypes.BigEndianStructure + href: https://docs.python.org/3/library/ctypes.html#ctypes.BigEndianStructure + name: BigEndianStructure + uid: ctypes.BigEndianStructure +- fullName: ctypes.BigEndianUnion + href: https://docs.python.org/3/library/ctypes.html#ctypes.BigEndianUnion + name: BigEndianUnion + uid: ctypes.BigEndianUnion +- fullName: ctypes.CDLL + href: https://docs.python.org/3/library/ctypes.html#ctypes.CDLL + name: CDLL + uid: ctypes.CDLL +- fullName: ctypes.HRESULT + href: https://docs.python.org/3/library/ctypes.html#ctypes.HRESULT + name: HRESULT + uid: ctypes.HRESULT +- fullName: ctypes.LibraryLoader + href: https://docs.python.org/3/library/ctypes.html#ctypes.LibraryLoader + name: LibraryLoader + uid: ctypes.LibraryLoader +- fullName: ctypes.LittleEndianStructure + href: https://docs.python.org/3/library/ctypes.html#ctypes.LittleEndianStructure + name: LittleEndianStructure + uid: ctypes.LittleEndianStructure +- fullName: ctypes.LittleEndianUnion + href: https://docs.python.org/3/library/ctypes.html#ctypes.LittleEndianUnion + name: LittleEndianUnion + uid: ctypes.LittleEndianUnion +- fullName: ctypes.OleDLL + href: https://docs.python.org/3/library/ctypes.html#ctypes.OleDLL + name: OleDLL + uid: ctypes.OleDLL +- fullName: ctypes.PyDLL + href: https://docs.python.org/3/library/ctypes.html#ctypes.PyDLL + name: PyDLL + uid: ctypes.PyDLL +- fullName: ctypes.Structure + href: https://docs.python.org/3/library/ctypes.html#ctypes.Structure + name: Structure + uid: ctypes.Structure +- fullName: ctypes.Union + href: https://docs.python.org/3/library/ctypes.html#ctypes.Union + name: Union + uid: ctypes.Union +- fullName: ctypes.WinDLL + href: https://docs.python.org/3/library/ctypes.html#ctypes.WinDLL + name: WinDLL + uid: ctypes.WinDLL +- fullName: ctypes._CData + href: https://docs.python.org/3/library/ctypes.html#ctypes._CData + name: _CData + uid: ctypes._CData +- fullName: ctypes._CFuncPtr + href: https://docs.python.org/3/library/ctypes.html#ctypes._CFuncPtr + name: _CFuncPtr + uid: ctypes._CFuncPtr +- fullName: ctypes._Pointer + href: https://docs.python.org/3/library/ctypes.html#ctypes._Pointer + name: _Pointer + uid: ctypes._Pointer +- fullName: ctypes._SimpleCData + href: https://docs.python.org/3/library/ctypes.html#ctypes._SimpleCData + name: _SimpleCData + uid: ctypes._SimpleCData +- fullName: ctypes.c_bool + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_bool + name: c_bool + uid: ctypes.c_bool +- fullName: ctypes.c_byte + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_byte + name: c_byte + uid: ctypes.c_byte +- fullName: ctypes.c_char + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_char + name: c_char + uid: ctypes.c_char +- fullName: ctypes.c_char_p + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_char_p + name: c_char_p + uid: ctypes.c_char_p +- fullName: ctypes.c_double + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_double + name: c_double + uid: ctypes.c_double +- fullName: ctypes.c_float + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_float + name: c_float + uid: ctypes.c_float +- fullName: ctypes.c_int + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_int + name: c_int + uid: ctypes.c_int +- fullName: ctypes.c_int16 + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_int16 + name: c_int16 + uid: ctypes.c_int16 +- fullName: ctypes.c_int32 + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_int32 + name: c_int32 + uid: ctypes.c_int32 +- fullName: ctypes.c_int64 + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_int64 + name: c_int64 + uid: ctypes.c_int64 +- fullName: ctypes.c_int8 + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_int8 + name: c_int8 + uid: ctypes.c_int8 +- fullName: ctypes.c_long + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_long + name: c_long + uid: ctypes.c_long +- fullName: ctypes.c_longdouble + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_longdouble + name: c_longdouble + uid: ctypes.c_longdouble +- fullName: ctypes.c_longlong + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_longlong + name: c_longlong + uid: ctypes.c_longlong +- fullName: ctypes.c_short + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_short + name: c_short + uid: ctypes.c_short +- fullName: ctypes.c_size_t + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_size_t + name: c_size_t + uid: ctypes.c_size_t +- fullName: ctypes.c_ssize_t + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_ssize_t + name: c_ssize_t + uid: ctypes.c_ssize_t +- fullName: ctypes.c_time_t + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_time_t + name: c_time_t + uid: ctypes.c_time_t +- fullName: ctypes.c_ubyte + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_ubyte + name: c_ubyte + uid: ctypes.c_ubyte +- fullName: ctypes.c_uint + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_uint + name: c_uint + uid: ctypes.c_uint +- fullName: ctypes.c_uint16 + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_uint16 + name: c_uint16 + uid: ctypes.c_uint16 +- fullName: ctypes.c_uint32 + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_uint32 + name: c_uint32 + uid: ctypes.c_uint32 +- fullName: ctypes.c_uint64 + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_uint64 + name: c_uint64 + uid: ctypes.c_uint64 +- fullName: ctypes.c_uint8 + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_uint8 + name: c_uint8 + uid: ctypes.c_uint8 +- fullName: ctypes.c_ulong + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_ulong + name: c_ulong + uid: ctypes.c_ulong +- fullName: ctypes.c_ulonglong + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_ulonglong + name: c_ulonglong + uid: ctypes.c_ulonglong +- fullName: ctypes.c_ushort + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_ushort + name: c_ushort + uid: ctypes.c_ushort +- fullName: ctypes.c_void_p + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_void_p + name: c_void_p + uid: ctypes.c_void_p +- fullName: ctypes.c_wchar + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_wchar + name: c_wchar + uid: ctypes.c_wchar +- fullName: ctypes.c_wchar_p + href: https://docs.python.org/3/library/ctypes.html#ctypes.c_wchar_p + name: c_wchar_p + uid: ctypes.c_wchar_p +- fullName: ctypes.py_object + href: https://docs.python.org/3/library/ctypes.html#ctypes.py_object + name: py_object + uid: ctypes.py_object +- fullName: curses.textpad.Textbox + href: https://docs.python.org/3/library/curses.html#curses.textpad.Textbox + name: Textbox + uid: curses.textpad.Textbox +- fullName: dataclasses.Field + href: https://docs.python.org/3/library/dataclasses.html#dataclasses.Field + name: Field + uid: dataclasses.Field +- fullName: datetime.date + href: https://docs.python.org/3/library/datetime.html#datetime.date + name: date + uid: datetime.date +- fullName: datetime.datetime + href: https://docs.python.org/3/library/datetime.html#datetime.datetime + name: datetime + uid: datetime.datetime +- fullName: datetime.time + href: https://docs.python.org/3/library/datetime.html#datetime.time + name: time + uid: datetime.time +- fullName: datetime.timedelta + href: https://docs.python.org/3/library/datetime.html#datetime.timedelta + name: timedelta + uid: datetime.timedelta +- fullName: datetime.timezone + href: https://docs.python.org/3/library/datetime.html#datetime.timezone + name: timezone + uid: datetime.timezone +- fullName: datetime.tzinfo + href: https://docs.python.org/3/library/datetime.html#datetime.tzinfo + name: tzinfo + uid: datetime.tzinfo +- fullName: decimal.Clamped + href: https://docs.python.org/3/library/decimal.html#decimal.Clamped + name: Clamped + uid: decimal.Clamped +- fullName: decimal.Context + href: https://docs.python.org/3/library/decimal.html#decimal.Context + name: Context + uid: decimal.Context +- fullName: decimal.Decimal + href: https://docs.python.org/3/library/decimal.html#decimal.Decimal + name: Decimal + uid: decimal.Decimal +- fullName: decimal.DecimalException + href: https://docs.python.org/3/library/decimal.html#decimal.DecimalException + name: DecimalException + uid: decimal.DecimalException +- fullName: decimal.DivisionByZero + href: https://docs.python.org/3/library/decimal.html#decimal.DivisionByZero + name: DivisionByZero + uid: decimal.DivisionByZero +- fullName: decimal.FloatOperation + href: https://docs.python.org/3/library/decimal.html#decimal.FloatOperation + name: FloatOperation + uid: decimal.FloatOperation +- fullName: decimal.Inexact + href: https://docs.python.org/3/library/decimal.html#decimal.Inexact + name: Inexact + uid: decimal.Inexact +- fullName: decimal.InvalidOperation + href: https://docs.python.org/3/library/decimal.html#decimal.InvalidOperation + name: InvalidOperation + uid: decimal.InvalidOperation +- fullName: decimal.Overflow + href: https://docs.python.org/3/library/decimal.html#decimal.Overflow + name: Overflow + uid: decimal.Overflow +- fullName: decimal.Rounded + href: https://docs.python.org/3/library/decimal.html#decimal.Rounded + name: Rounded + uid: decimal.Rounded +- fullName: decimal.Subnormal + href: https://docs.python.org/3/library/decimal.html#decimal.Subnormal + name: Subnormal + uid: decimal.Subnormal +- fullName: decimal.Underflow + href: https://docs.python.org/3/library/decimal.html#decimal.Underflow + name: Underflow + uid: decimal.Underflow +- fullName: dict + href: https://docs.python.org/3/library/stdtypes.html#dict + name: dict + uid: dict +- fullName: difflib.Differ + href: https://docs.python.org/3/library/difflib.html#difflib.Differ + name: Differ + uid: difflib.Differ +- fullName: difflib.HtmlDiff + href: https://docs.python.org/3/library/difflib.html#difflib.HtmlDiff + name: HtmlDiff + uid: difflib.HtmlDiff +- fullName: difflib.SequenceMatcher + href: https://docs.python.org/3/library/difflib.html#difflib.SequenceMatcher + name: SequenceMatcher + uid: difflib.SequenceMatcher +- fullName: dis.Bytecode + href: https://docs.python.org/3/library/dis.html#dis.Bytecode + name: Bytecode + uid: dis.Bytecode +- fullName: dis.Instruction + href: https://docs.python.org/3/library/dis.html#dis.Instruction + name: Instruction + uid: dis.Instruction +- fullName: dis.Positions + href: https://docs.python.org/3/library/dis.html#dis.Positions + name: Positions + uid: dis.Positions +- fullName: doctest.DebugRunner + href: https://docs.python.org/3/library/doctest.html#doctest.DebugRunner + name: DebugRunner + uid: doctest.DebugRunner +- fullName: doctest.DocTest + href: https://docs.python.org/3/library/doctest.html#doctest.DocTest + name: DocTest + uid: doctest.DocTest +- fullName: doctest.DocTestFinder + href: https://docs.python.org/3/library/doctest.html#doctest.DocTestFinder + name: DocTestFinder + uid: doctest.DocTestFinder +- fullName: doctest.DocTestParser + href: https://docs.python.org/3/library/doctest.html#doctest.DocTestParser + name: DocTestParser + uid: doctest.DocTestParser +- fullName: doctest.DocTestRunner + href: https://docs.python.org/3/library/doctest.html#doctest.DocTestRunner + name: DocTestRunner + uid: doctest.DocTestRunner +- fullName: doctest.Example + href: https://docs.python.org/3/library/doctest.html#doctest.Example + name: Example + uid: doctest.Example +- fullName: doctest.OutputChecker + href: https://docs.python.org/3/library/doctest.html#doctest.OutputChecker + name: OutputChecker + uid: doctest.OutputChecker +- fullName: doctest.TestResults + href: https://docs.python.org/3/library/doctest.html#doctest.TestResults + name: TestResults + uid: doctest.TestResults +- fullName: email.charset.Charset + href: https://docs.python.org/3/library/email.charset.html#email.charset.Charset + name: Charset + uid: email.charset.Charset +- fullName: email.contentmanager.ContentManager + href: https://docs.python.org/3/library/email.contentmanager.html#email.contentmanager.ContentManager + name: ContentManager + uid: email.contentmanager.ContentManager +- fullName: email.generator.BytesGenerator + href: https://docs.python.org/3/library/email.generator.html#email.generator.BytesGenerator + name: BytesGenerator + uid: email.generator.BytesGenerator +- fullName: email.generator.DecodedGenerator + href: https://docs.python.org/3/library/email.generator.html#email.generator.DecodedGenerator + name: DecodedGenerator + uid: email.generator.DecodedGenerator +- fullName: email.generator.Generator + href: https://docs.python.org/3/library/email.generator.html#email.generator.Generator + name: Generator + uid: email.generator.Generator +- fullName: email.header.Header + href: https://docs.python.org/3/library/email.header.html#email.header.Header + name: Header + uid: email.header.Header +- fullName: email.headerregistry.Address + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.Address + name: Address + uid: email.headerregistry.Address +- fullName: email.headerregistry.AddressHeader + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.AddressHeader + name: AddressHeader + uid: email.headerregistry.AddressHeader +- fullName: email.headerregistry.BaseHeader + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.BaseHeader + name: BaseHeader + uid: email.headerregistry.BaseHeader +- fullName: email.headerregistry.ContentDispositionHeader + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.ContentDispositionHeader + name: ContentDispositionHeader + uid: email.headerregistry.ContentDispositionHeader +- fullName: email.headerregistry.ContentTransferEncoding + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.ContentTransferEncoding + name: ContentTransferEncoding + uid: email.headerregistry.ContentTransferEncoding +- fullName: email.headerregistry.ContentTypeHeader + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.ContentTypeHeader + name: ContentTypeHeader + uid: email.headerregistry.ContentTypeHeader +- fullName: email.headerregistry.DateHeader + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.DateHeader + name: DateHeader + uid: email.headerregistry.DateHeader +- fullName: email.headerregistry.Group + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.Group + name: Group + uid: email.headerregistry.Group +- fullName: email.headerregistry.HeaderRegistry + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.HeaderRegistry + name: HeaderRegistry + uid: email.headerregistry.HeaderRegistry +- fullName: email.headerregistry.MIMEVersionHeader + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.MIMEVersionHeader + name: MIMEVersionHeader + uid: email.headerregistry.MIMEVersionHeader +- fullName: email.headerregistry.ParameterizedMIMEHeader + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.ParameterizedMIMEHeader + name: ParameterizedMIMEHeader + uid: email.headerregistry.ParameterizedMIMEHeader +- fullName: email.headerregistry.SingleAddressHeader + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.SingleAddressHeader + name: SingleAddressHeader + uid: email.headerregistry.SingleAddressHeader +- fullName: email.headerregistry.UnstructuredHeader + href: https://docs.python.org/3/library/email.headerregistry.html#email.headerregistry.UnstructuredHeader + name: UnstructuredHeader + uid: email.headerregistry.UnstructuredHeader +- fullName: email.message.EmailMessage + href: https://docs.python.org/3/library/email.message.html#email.message.EmailMessage + name: EmailMessage + uid: email.message.EmailMessage +- fullName: email.message.MIMEPart + href: https://docs.python.org/3/library/email.message.html#email.message.MIMEPart + name: MIMEPart + uid: email.message.MIMEPart +- fullName: email.message.Message + href: https://docs.python.org/3/library/email.compat32-message.html#email.message.Message + name: Message + uid: email.message.Message +- fullName: email.mime.application.MIMEApplication + href: https://docs.python.org/3/library/email.mime.html#email.mime.application.MIMEApplication + name: MIMEApplication + uid: email.mime.application.MIMEApplication +- fullName: email.mime.audio.MIMEAudio + href: https://docs.python.org/3/library/email.mime.html#email.mime.audio.MIMEAudio + name: MIMEAudio + uid: email.mime.audio.MIMEAudio +- fullName: email.mime.base.MIMEBase + href: https://docs.python.org/3/library/email.mime.html#email.mime.base.MIMEBase + name: MIMEBase + uid: email.mime.base.MIMEBase +- fullName: email.mime.image.MIMEImage + href: https://docs.python.org/3/library/email.mime.html#email.mime.image.MIMEImage + name: MIMEImage + uid: email.mime.image.MIMEImage +- fullName: email.mime.message.MIMEMessage + href: https://docs.python.org/3/library/email.mime.html#email.mime.message.MIMEMessage + name: MIMEMessage + uid: email.mime.message.MIMEMessage +- fullName: email.mime.multipart.MIMEMultipart + href: https://docs.python.org/3/library/email.mime.html#email.mime.multipart.MIMEMultipart + name: MIMEMultipart + uid: email.mime.multipart.MIMEMultipart +- fullName: email.mime.nonmultipart.MIMENonMultipart + href: https://docs.python.org/3/library/email.mime.html#email.mime.nonmultipart.MIMENonMultipart + name: MIMENonMultipart + uid: email.mime.nonmultipart.MIMENonMultipart +- fullName: email.mime.text.MIMEText + href: https://docs.python.org/3/library/email.mime.html#email.mime.text.MIMEText + name: MIMEText + uid: email.mime.text.MIMEText +- fullName: email.parser.BytesFeedParser + href: https://docs.python.org/3/library/email.parser.html#email.parser.BytesFeedParser + name: BytesFeedParser + uid: email.parser.BytesFeedParser +- fullName: email.parser.BytesHeaderParser + href: https://docs.python.org/3/library/email.parser.html#email.parser.BytesHeaderParser + name: BytesHeaderParser + uid: email.parser.BytesHeaderParser +- fullName: email.parser.BytesParser + href: https://docs.python.org/3/library/email.parser.html#email.parser.BytesParser + name: BytesParser + uid: email.parser.BytesParser +- fullName: email.parser.FeedParser + href: https://docs.python.org/3/library/email.parser.html#email.parser.FeedParser + name: FeedParser + uid: email.parser.FeedParser +- fullName: email.parser.HeaderParser + href: https://docs.python.org/3/library/email.parser.html#email.parser.HeaderParser + name: HeaderParser + uid: email.parser.HeaderParser +- fullName: email.parser.Parser + href: https://docs.python.org/3/library/email.parser.html#email.parser.Parser + name: Parser + uid: email.parser.Parser +- fullName: email.policy.Compat32 + href: https://docs.python.org/3/library/email.policy.html#email.policy.Compat32 + name: Compat32 + uid: email.policy.Compat32 +- fullName: email.policy.EmailPolicy + href: https://docs.python.org/3/library/email.policy.html#email.policy.EmailPolicy + name: EmailPolicy + uid: email.policy.EmailPolicy +- fullName: email.policy.Policy + href: https://docs.python.org/3/library/email.policy.html#email.policy.Policy + name: Policy + uid: email.policy.Policy +- fullName: enum.Enum + href: https://docs.python.org/3/library/enum.html#enum.Enum + name: Enum + uid: enum.Enum +- fullName: enum.EnumCheck + href: https://docs.python.org/3/library/enum.html#enum.EnumCheck + name: EnumCheck + uid: enum.EnumCheck +- fullName: enum.EnumDict + href: https://docs.python.org/3/library/enum.html#enum.EnumDict + name: EnumDict + uid: enum.EnumDict +- fullName: enum.EnumType + href: https://docs.python.org/3/library/enum.html#enum.EnumType + name: EnumType + uid: enum.EnumType +- fullName: enum.Flag + href: https://docs.python.org/3/library/enum.html#enum.Flag + name: Flag + uid: enum.Flag +- fullName: enum.FlagBoundary + href: https://docs.python.org/3/library/enum.html#enum.FlagBoundary + name: FlagBoundary + uid: enum.FlagBoundary +- fullName: enum.IntEnum + href: https://docs.python.org/3/library/enum.html#enum.IntEnum + name: IntEnum + uid: enum.IntEnum +- fullName: enum.IntFlag + href: https://docs.python.org/3/library/enum.html#enum.IntFlag + name: IntFlag + uid: enum.IntFlag +- fullName: enum.ReprEnum + href: https://docs.python.org/3/library/enum.html#enum.ReprEnum + name: ReprEnum + uid: enum.ReprEnum +- fullName: enum.StrEnum + href: https://docs.python.org/3/library/enum.html#enum.StrEnum + name: StrEnum + uid: enum.StrEnum +- fullName: enum.auto + href: https://docs.python.org/3/library/enum.html#enum.auto + name: auto + uid: enum.auto +- fullName: filecmp.dircmp + href: https://docs.python.org/3/library/filecmp.html#filecmp.dircmp + name: dircmp + uid: filecmp.dircmp +- fullName: fileinput.FileInput + href: https://docs.python.org/3/library/fileinput.html#fileinput.FileInput + name: FileInput + uid: fileinput.FileInput +- fullName: float + href: https://docs.python.org/3/library/functions.html#float + name: float + uid: float +- fullName: fractions.Fraction + href: https://docs.python.org/3/library/fractions.html#fractions.Fraction + name: Fraction + uid: fractions.Fraction +- fullName: frozenset + href: https://docs.python.org/3/library/stdtypes.html#frozenset + name: frozenset + uid: frozenset +- fullName: ftplib.FTP + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP + name: FTP + uid: ftplib.FTP +- fullName: ftplib.FTP_TLS + href: https://docs.python.org/3/library/ftplib.html#ftplib.FTP_TLS + name: FTP_TLS + uid: ftplib.FTP_TLS +- fullName: functools.partialmethod + href: https://docs.python.org/3/library/functools.html#functools.partialmethod + name: partialmethod + uid: functools.partialmethod +- fullName: functools.singledispatchmethod + href: https://docs.python.org/3/library/functools.html#functools.singledispatchmethod + name: singledispatchmethod + uid: functools.singledispatchmethod +- fullName: gettext.GNUTranslations + href: https://docs.python.org/3/library/gettext.html#gettext.GNUTranslations + name: GNUTranslations + uid: gettext.GNUTranslations +- fullName: gettext.NullTranslations + href: https://docs.python.org/3/library/gettext.html#gettext.NullTranslations + name: NullTranslations + uid: gettext.NullTranslations +- fullName: graphlib.TopologicalSorter + href: https://docs.python.org/3/library/graphlib.html#graphlib.TopologicalSorter + name: TopologicalSorter + uid: graphlib.TopologicalSorter +- fullName: gzip.GzipFile + href: https://docs.python.org/3/library/gzip.html#gzip.GzipFile + name: GzipFile + uid: gzip.GzipFile +- fullName: html.parser.HTMLParser + href: https://docs.python.org/3/library/html.parser.html#html.parser.HTMLParser + name: HTMLParser + uid: html.parser.HTMLParser +- fullName: http.HTTPMethod + href: https://docs.python.org/3/library/http.html#http.HTTPMethod + name: HTTPMethod + uid: http.HTTPMethod +- fullName: http.HTTPStatus + href: https://docs.python.org/3/library/http.html#http.HTTPStatus + name: HTTPStatus + uid: http.HTTPStatus +- fullName: http.client.HTTPConnection + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPConnection + name: HTTPConnection + uid: http.client.HTTPConnection +- fullName: http.client.HTTPMessage + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPMessage + name: HTTPMessage + uid: http.client.HTTPMessage +- fullName: http.client.HTTPResponse + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPResponse + name: HTTPResponse + uid: http.client.HTTPResponse +- fullName: http.client.HTTPSConnection + href: https://docs.python.org/3/library/http.client.html#http.client.HTTPSConnection + name: HTTPSConnection + uid: http.client.HTTPSConnection +- fullName: http.cookiejar.Cookie + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.Cookie + name: Cookie + uid: http.cookiejar.Cookie +- fullName: http.cookiejar.CookieJar + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookieJar + name: CookieJar + uid: http.cookiejar.CookieJar +- fullName: http.cookiejar.CookiePolicy + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookiePolicy + name: CookiePolicy + uid: http.cookiejar.CookiePolicy +- fullName: http.cookiejar.DefaultCookiePolicy + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.DefaultCookiePolicy + name: DefaultCookiePolicy + uid: http.cookiejar.DefaultCookiePolicy +- fullName: http.cookiejar.FileCookieJar + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.FileCookieJar + name: FileCookieJar + uid: http.cookiejar.FileCookieJar +- fullName: http.cookiejar.LWPCookieJar + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.LWPCookieJar + name: LWPCookieJar + uid: http.cookiejar.LWPCookieJar +- fullName: http.cookiejar.MozillaCookieJar + href: https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.MozillaCookieJar + name: MozillaCookieJar + uid: http.cookiejar.MozillaCookieJar +- fullName: http.cookies.BaseCookie + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.BaseCookie + name: BaseCookie + uid: http.cookies.BaseCookie +- fullName: http.cookies.Morsel + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.Morsel + name: Morsel + uid: http.cookies.Morsel +- fullName: http.cookies.SimpleCookie + href: https://docs.python.org/3/library/http.cookies.html#http.cookies.SimpleCookie + name: SimpleCookie + uid: http.cookies.SimpleCookie +- fullName: http.server.BaseHTTPRequestHandler + href: https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequestHandler + name: BaseHTTPRequestHandler + uid: http.server.BaseHTTPRequestHandler +- fullName: http.server.CGIHTTPRequestHandler + href: https://docs.python.org/3/library/http.server.html#http.server.CGIHTTPRequestHandler + name: CGIHTTPRequestHandler + uid: http.server.CGIHTTPRequestHandler +- fullName: http.server.HTTPServer + href: https://docs.python.org/3/library/http.server.html#http.server.HTTPServer + name: HTTPServer + uid: http.server.HTTPServer +- fullName: http.server.SimpleHTTPRequestHandler + href: https://docs.python.org/3/library/http.server.html#http.server.SimpleHTTPRequestHandler + name: SimpleHTTPRequestHandler + uid: http.server.SimpleHTTPRequestHandler +- fullName: http.server.ThreadingHTTPServer + href: https://docs.python.org/3/library/http.server.html#http.server.ThreadingHTTPServer + name: ThreadingHTTPServer + uid: http.server.ThreadingHTTPServer +- fullName: imaplib.IMAP4 + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4 + name: IMAP4 + uid: imaplib.IMAP4 +- fullName: imaplib.IMAP4_SSL + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4_SSL + name: IMAP4_SSL + uid: imaplib.IMAP4_SSL +- fullName: imaplib.IMAP4_stream + href: https://docs.python.org/3/library/imaplib.html#imaplib.IMAP4_stream + name: IMAP4_stream + uid: imaplib.IMAP4_stream +- fullName: importlib.abc.ExecutionLoader + href: https://docs.python.org/3/library/importlib.html#importlib.abc.ExecutionLoader + name: ExecutionLoader + uid: importlib.abc.ExecutionLoader +- fullName: importlib.abc.FileLoader + href: https://docs.python.org/3/library/importlib.html#importlib.abc.FileLoader + name: FileLoader + uid: importlib.abc.FileLoader +- fullName: importlib.abc.InspectLoader + href: https://docs.python.org/3/library/importlib.html#importlib.abc.InspectLoader + name: InspectLoader + uid: importlib.abc.InspectLoader +- fullName: importlib.abc.Loader + href: https://docs.python.org/3/library/importlib.html#importlib.abc.Loader + name: Loader + uid: importlib.abc.Loader +- fullName: importlib.abc.MetaPathFinder + href: https://docs.python.org/3/library/importlib.html#importlib.abc.MetaPathFinder + name: MetaPathFinder + uid: importlib.abc.MetaPathFinder +- fullName: importlib.abc.PathEntryFinder + href: https://docs.python.org/3/library/importlib.html#importlib.abc.PathEntryFinder + name: PathEntryFinder + uid: importlib.abc.PathEntryFinder +- fullName: importlib.abc.ResourceLoader + href: https://docs.python.org/3/library/importlib.html#importlib.abc.ResourceLoader + name: ResourceLoader + uid: importlib.abc.ResourceLoader +- fullName: importlib.abc.ResourceReader + href: https://docs.python.org/3/library/importlib.html#importlib.abc.ResourceReader + name: ResourceReader + uid: importlib.abc.ResourceReader +- fullName: importlib.abc.SourceLoader + href: https://docs.python.org/3/library/importlib.html#importlib.abc.SourceLoader + name: SourceLoader + uid: importlib.abc.SourceLoader +- fullName: importlib.abc.Traversable + href: https://docs.python.org/3/library/importlib.html#importlib.abc.Traversable + name: Traversable + uid: importlib.abc.Traversable +- fullName: importlib.abc.TraversableResources + href: https://docs.python.org/3/library/importlib.html#importlib.abc.TraversableResources + name: TraversableResources + uid: importlib.abc.TraversableResources +- fullName: importlib.machinery.AppleFrameworkLoader + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.AppleFrameworkLoader + name: AppleFrameworkLoader + uid: importlib.machinery.AppleFrameworkLoader +- fullName: importlib.machinery.BuiltinImporter + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.BuiltinImporter + name: BuiltinImporter + uid: importlib.machinery.BuiltinImporter +- fullName: importlib.machinery.ExtensionFileLoader + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.ExtensionFileLoader + name: ExtensionFileLoader + uid: importlib.machinery.ExtensionFileLoader +- fullName: importlib.machinery.FileFinder + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.FileFinder + name: FileFinder + uid: importlib.machinery.FileFinder +- fullName: importlib.machinery.FrozenImporter + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.FrozenImporter + name: FrozenImporter + uid: importlib.machinery.FrozenImporter +- fullName: importlib.machinery.ModuleSpec + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.ModuleSpec + name: ModuleSpec + uid: importlib.machinery.ModuleSpec +- fullName: importlib.machinery.NamespaceLoader + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.NamespaceLoader + name: NamespaceLoader + uid: importlib.machinery.NamespaceLoader +- fullName: importlib.machinery.PathFinder + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.PathFinder + name: PathFinder + uid: importlib.machinery.PathFinder +- fullName: importlib.machinery.SourceFileLoader + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.SourceFileLoader + name: SourceFileLoader + uid: importlib.machinery.SourceFileLoader +- fullName: importlib.machinery.SourcelessFileLoader + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.SourcelessFileLoader + name: SourcelessFileLoader + uid: importlib.machinery.SourcelessFileLoader +- fullName: importlib.machinery.WindowsRegistryFinder + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.WindowsRegistryFinder + name: WindowsRegistryFinder + uid: importlib.machinery.WindowsRegistryFinder +- fullName: importlib.metadata.Distribution + href: https://docs.python.org/3/library/importlib.metadata.html#importlib.metadata.Distribution + name: Distribution + uid: importlib.metadata.Distribution +- fullName: importlib.metadata.EntryPoint + href: https://docs.python.org/3/library/importlib.metadata.html#importlib.metadata.EntryPoint + name: EntryPoint + uid: importlib.metadata.EntryPoint +- fullName: importlib.metadata.EntryPoints + href: https://docs.python.org/3/library/importlib.metadata.html#importlib.metadata.EntryPoints + name: EntryPoints + uid: importlib.metadata.EntryPoints +- fullName: importlib.metadata.PackageMetadata + href: https://docs.python.org/3/library/importlib.metadata.html#importlib.metadata.PackageMetadata + name: PackageMetadata + uid: importlib.metadata.PackageMetadata +- fullName: importlib.metadata.PackagePath + href: https://docs.python.org/3/library/importlib.metadata.html#importlib.metadata.PackagePath + name: PackagePath + uid: importlib.metadata.PackagePath +- fullName: importlib.resources.Anchor + href: https://docs.python.org/3/library/importlib.resources.html#importlib.resources.Anchor + name: Anchor + uid: importlib.resources.Anchor +- fullName: importlib.resources.abc.ResourceReader + href: https://docs.python.org/3/library/importlib.resources.abc.html#importlib.resources.abc.ResourceReader + name: ResourceReader + uid: importlib.resources.abc.ResourceReader +- fullName: importlib.resources.abc.Traversable + href: https://docs.python.org/3/library/importlib.resources.abc.html#importlib.resources.abc.Traversable + name: Traversable + uid: importlib.resources.abc.Traversable +- fullName: importlib.resources.abc.TraversableResources + href: https://docs.python.org/3/library/importlib.resources.abc.html#importlib.resources.abc.TraversableResources + name: TraversableResources + uid: importlib.resources.abc.TraversableResources +- fullName: importlib.util.LazyLoader + href: https://docs.python.org/3/library/importlib.html#importlib.util.LazyLoader + name: LazyLoader + uid: importlib.util.LazyLoader +- fullName: inspect.BoundArguments + href: https://docs.python.org/3/library/inspect.html#inspect.BoundArguments + name: BoundArguments + uid: inspect.BoundArguments +- fullName: inspect.BufferFlags + href: https://docs.python.org/3/library/inspect.html#inspect.BufferFlags + name: BufferFlags + uid: inspect.BufferFlags +- fullName: inspect.FrameInfo + href: https://docs.python.org/3/library/inspect.html#inspect.FrameInfo + name: FrameInfo + uid: inspect.FrameInfo +- fullName: inspect.Parameter + href: https://docs.python.org/3/library/inspect.html#inspect.Parameter + name: Parameter + uid: inspect.Parameter +- fullName: inspect.Signature + href: https://docs.python.org/3/library/inspect.html#inspect.Signature + name: Signature + uid: inspect.Signature +- fullName: inspect.Traceback + href: https://docs.python.org/3/library/inspect.html#inspect.Traceback + name: Traceback + uid: inspect.Traceback +- fullName: int + href: https://docs.python.org/3/library/functions.html#int + name: int + uid: int +- fullName: io.BufferedIOBase + href: https://docs.python.org/3/library/io.html#io.BufferedIOBase + name: BufferedIOBase + uid: io.BufferedIOBase +- fullName: io.BufferedRWPair + href: https://docs.python.org/3/library/io.html#io.BufferedRWPair + name: BufferedRWPair + uid: io.BufferedRWPair +- fullName: io.BufferedRandom + href: https://docs.python.org/3/library/io.html#io.BufferedRandom + name: BufferedRandom + uid: io.BufferedRandom +- fullName: io.BufferedReader + href: https://docs.python.org/3/library/io.html#io.BufferedReader + name: BufferedReader + uid: io.BufferedReader +- fullName: io.BufferedWriter + href: https://docs.python.org/3/library/io.html#io.BufferedWriter + name: BufferedWriter + uid: io.BufferedWriter +- fullName: io.BytesIO + href: https://docs.python.org/3/library/io.html#io.BytesIO + name: BytesIO + uid: io.BytesIO +- fullName: io.FileIO + href: https://docs.python.org/3/library/io.html#io.FileIO + name: FileIO + uid: io.FileIO +- fullName: io.IOBase + href: https://docs.python.org/3/library/io.html#io.IOBase + name: IOBase + uid: io.IOBase +- fullName: io.IncrementalNewlineDecoder + href: https://docs.python.org/3/library/io.html#io.IncrementalNewlineDecoder + name: IncrementalNewlineDecoder + uid: io.IncrementalNewlineDecoder +- fullName: io.RawIOBase + href: https://docs.python.org/3/library/io.html#io.RawIOBase + name: RawIOBase + uid: io.RawIOBase +- fullName: io.StringIO + href: https://docs.python.org/3/library/io.html#io.StringIO + name: StringIO + uid: io.StringIO +- fullName: io.TextIOBase + href: https://docs.python.org/3/library/io.html#io.TextIOBase + name: TextIOBase + uid: io.TextIOBase +- fullName: io.TextIOWrapper + href: https://docs.python.org/3/library/io.html#io.TextIOWrapper + name: TextIOWrapper + uid: io.TextIOWrapper +- fullName: ipaddress.IPv4Address + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Address + name: IPv4Address + uid: ipaddress.IPv4Address +- fullName: ipaddress.IPv4Interface + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Interface + name: IPv4Interface + uid: ipaddress.IPv4Interface +- fullName: ipaddress.IPv4Network + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Network + name: IPv4Network + uid: ipaddress.IPv4Network +- fullName: ipaddress.IPv6Address + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Address + name: IPv6Address + uid: ipaddress.IPv6Address +- fullName: ipaddress.IPv6Interface + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Interface + name: IPv6Interface + uid: ipaddress.IPv6Interface +- fullName: ipaddress.IPv6Network + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv6Network + name: IPv6Network + uid: ipaddress.IPv6Network +- fullName: json.JSONDecoder + href: https://docs.python.org/3/library/json.html#json.JSONDecoder + name: JSONDecoder + uid: json.JSONDecoder +- fullName: json.JSONEncoder + href: https://docs.python.org/3/library/json.html#json.JSONEncoder + name: JSONEncoder + uid: json.JSONEncoder +- fullName: list + href: https://docs.python.org/3/library/stdtypes.html#list + name: list + uid: list +- fullName: logging.BufferingFormatter + href: https://docs.python.org/3/library/logging.html#logging.BufferingFormatter + name: BufferingFormatter + uid: logging.BufferingFormatter +- fullName: logging.FileHandler + href: https://docs.python.org/3/library/logging.handlers.html#logging.FileHandler + name: FileHandler + uid: logging.FileHandler +- fullName: logging.Filter + href: https://docs.python.org/3/library/logging.html#logging.Filter + name: Filter + uid: logging.Filter +- fullName: logging.Formatter + href: https://docs.python.org/3/library/logging.html#logging.Formatter + name: Formatter + uid: logging.Formatter +- fullName: logging.Handler + href: https://docs.python.org/3/library/logging.html#logging.Handler + name: Handler + uid: logging.Handler +- fullName: logging.LogRecord + href: https://docs.python.org/3/library/logging.html#logging.LogRecord + name: LogRecord + uid: logging.LogRecord +- fullName: logging.Logger + href: https://docs.python.org/3/library/logging.html#logging.Logger + name: Logger + uid: logging.Logger +- fullName: logging.LoggerAdapter + href: https://docs.python.org/3/library/logging.html#logging.LoggerAdapter + name: LoggerAdapter + uid: logging.LoggerAdapter +- fullName: logging.NullHandler + href: https://docs.python.org/3/library/logging.handlers.html#logging.NullHandler + name: NullHandler + uid: logging.NullHandler +- fullName: logging.StreamHandler + href: https://docs.python.org/3/library/logging.handlers.html#logging.StreamHandler + name: StreamHandler + uid: logging.StreamHandler +- fullName: logging.handlers.BaseRotatingHandler + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.BaseRotatingHandler + name: BaseRotatingHandler + uid: logging.handlers.BaseRotatingHandler +- fullName: logging.handlers.BufferingHandler + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.BufferingHandler + name: BufferingHandler + uid: logging.handlers.BufferingHandler +- fullName: logging.handlers.DatagramHandler + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.DatagramHandler + name: DatagramHandler + uid: logging.handlers.DatagramHandler +- fullName: logging.handlers.HTTPHandler + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.HTTPHandler + name: HTTPHandler + uid: logging.handlers.HTTPHandler +- fullName: logging.handlers.MemoryHandler + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.MemoryHandler + name: MemoryHandler + uid: logging.handlers.MemoryHandler +- fullName: logging.handlers.NTEventLogHandler + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.NTEventLogHandler + name: NTEventLogHandler + uid: logging.handlers.NTEventLogHandler +- fullName: logging.handlers.QueueHandler + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.QueueHandler + name: QueueHandler + uid: logging.handlers.QueueHandler +- fullName: logging.handlers.QueueListener + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.QueueListener + name: QueueListener + uid: logging.handlers.QueueListener +- fullName: logging.handlers.RotatingFileHandler + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.RotatingFileHandler + name: RotatingFileHandler + uid: logging.handlers.RotatingFileHandler +- fullName: logging.handlers.SMTPHandler + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.SMTPHandler + name: SMTPHandler + uid: logging.handlers.SMTPHandler +- fullName: logging.handlers.SocketHandler + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.SocketHandler + name: SocketHandler + uid: logging.handlers.SocketHandler +- fullName: logging.handlers.SysLogHandler + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.SysLogHandler + name: SysLogHandler + uid: logging.handlers.SysLogHandler +- fullName: logging.handlers.TimedRotatingFileHandler + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.TimedRotatingFileHandler + name: TimedRotatingFileHandler + uid: logging.handlers.TimedRotatingFileHandler +- fullName: logging.handlers.WatchedFileHandler + href: https://docs.python.org/3/library/logging.handlers.html#logging.handlers.WatchedFileHandler + name: WatchedFileHandler + uid: logging.handlers.WatchedFileHandler +- fullName: lzma.LZMACompressor + href: https://docs.python.org/3/library/lzma.html#lzma.LZMACompressor + name: LZMACompressor + uid: lzma.LZMACompressor +- fullName: lzma.LZMADecompressor + href: https://docs.python.org/3/library/lzma.html#lzma.LZMADecompressor + name: LZMADecompressor + uid: lzma.LZMADecompressor +- fullName: lzma.LZMAFile + href: https://docs.python.org/3/library/lzma.html#lzma.LZMAFile + name: LZMAFile + uid: lzma.LZMAFile +- fullName: mailbox.Babyl + href: https://docs.python.org/3/library/mailbox.html#mailbox.Babyl + name: Babyl + uid: mailbox.Babyl +- fullName: mailbox.BabylMessage + href: https://docs.python.org/3/library/mailbox.html#mailbox.BabylMessage + name: BabylMessage + uid: mailbox.BabylMessage +- fullName: mailbox.MH + href: https://docs.python.org/3/library/mailbox.html#mailbox.MH + name: MH + uid: mailbox.MH +- fullName: mailbox.MHMessage + href: https://docs.python.org/3/library/mailbox.html#mailbox.MHMessage + name: MHMessage + uid: mailbox.MHMessage +- fullName: mailbox.MMDF + href: https://docs.python.org/3/library/mailbox.html#mailbox.MMDF + name: MMDF + uid: mailbox.MMDF +- fullName: mailbox.MMDFMessage + href: https://docs.python.org/3/library/mailbox.html#mailbox.MMDFMessage + name: MMDFMessage + uid: mailbox.MMDFMessage +- fullName: mailbox.Mailbox + href: https://docs.python.org/3/library/mailbox.html#mailbox.Mailbox + name: Mailbox + uid: mailbox.Mailbox +- fullName: mailbox.Maildir + href: https://docs.python.org/3/library/mailbox.html#mailbox.Maildir + name: Maildir + uid: mailbox.Maildir +- fullName: mailbox.MaildirMessage + href: https://docs.python.org/3/library/mailbox.html#mailbox.MaildirMessage + name: MaildirMessage + uid: mailbox.MaildirMessage +- fullName: mailbox.Message + href: https://docs.python.org/3/library/mailbox.html#mailbox.Message + name: Message + uid: mailbox.Message +- fullName: mailbox.mbox + href: https://docs.python.org/3/library/mailbox.html#mailbox.mbox + name: mbox + uid: mailbox.mbox +- fullName: mailbox.mboxMessage + href: https://docs.python.org/3/library/mailbox.html#mailbox.mboxMessage + name: mboxMessage + uid: mailbox.mboxMessage +- fullName: memoryview + href: https://docs.python.org/3/library/stdtypes.html#memoryview + name: memoryview + uid: memoryview +- fullName: mimetypes.MimeTypes + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.MimeTypes + name: MimeTypes + uid: mimetypes.MimeTypes +- fullName: mmap.mmap + href: https://docs.python.org/3/library/mmap.html#mmap.mmap + name: mmap + uid: mmap.mmap +- fullName: modulefinder.ModuleFinder + href: https://docs.python.org/3/library/modulefinder.html#modulefinder.ModuleFinder + name: ModuleFinder + uid: modulefinder.ModuleFinder +- fullName: multiprocessing.Barrier + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Barrier + name: Barrier + uid: multiprocessing.Barrier +- fullName: multiprocessing.BoundedSemaphore + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.BoundedSemaphore + name: BoundedSemaphore + uid: multiprocessing.BoundedSemaphore +- fullName: multiprocessing.Condition + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Condition + name: Condition + uid: multiprocessing.Condition +- fullName: multiprocessing.Event + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Event + name: Event + uid: multiprocessing.Event +- fullName: multiprocessing.JoinableQueue + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.JoinableQueue + name: JoinableQueue + uid: multiprocessing.JoinableQueue +- fullName: multiprocessing.Lock + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Lock + name: Lock + uid: multiprocessing.Lock +- fullName: multiprocessing.Process + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Process + name: Process + uid: multiprocessing.Process +- fullName: multiprocessing.Queue + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Queue + name: Queue + uid: multiprocessing.Queue +- fullName: multiprocessing.RLock + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.RLock + name: RLock + uid: multiprocessing.RLock +- fullName: multiprocessing.Semaphore + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Semaphore + name: Semaphore + uid: multiprocessing.Semaphore +- fullName: multiprocessing.SimpleQueue + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.SimpleQueue + name: SimpleQueue + uid: multiprocessing.SimpleQueue +- fullName: multiprocessing.connection.Connection + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.connection.Connection + name: Connection + uid: multiprocessing.connection.Connection +- fullName: multiprocessing.connection.Listener + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.connection.Listener + name: Listener + uid: multiprocessing.connection.Listener +- fullName: multiprocessing.managers.BaseManager + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.BaseManager + name: BaseManager + uid: multiprocessing.managers.BaseManager +- fullName: multiprocessing.managers.BaseProxy + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.BaseProxy + name: BaseProxy + uid: multiprocessing.managers.BaseProxy +- fullName: multiprocessing.managers.Namespace + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.Namespace + name: Namespace + uid: multiprocessing.managers.Namespace +- fullName: multiprocessing.managers.SharedMemoryManager + href: https://docs.python.org/3/library/multiprocessing.shared_memory.html#multiprocessing.managers.SharedMemoryManager + name: SharedMemoryManager + uid: multiprocessing.managers.SharedMemoryManager +- fullName: multiprocessing.managers.SyncManager + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.managers.SyncManager + name: SyncManager + uid: multiprocessing.managers.SyncManager +- fullName: multiprocessing.pool.AsyncResult + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.pool.AsyncResult + name: AsyncResult + uid: multiprocessing.pool.AsyncResult +- fullName: multiprocessing.pool.Pool + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.pool.Pool + name: Pool + uid: multiprocessing.pool.Pool +- fullName: multiprocessing.pool.ThreadPool + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.pool.ThreadPool + name: ThreadPool + uid: multiprocessing.pool.ThreadPool +- fullName: multiprocessing.shared_memory.ShareableList + href: https://docs.python.org/3/library/multiprocessing.shared_memory.html#multiprocessing.shared_memory.ShareableList + name: ShareableList + uid: multiprocessing.shared_memory.ShareableList +- fullName: multiprocessing.shared_memory.SharedMemory + href: https://docs.python.org/3/library/multiprocessing.shared_memory.html#multiprocessing.shared_memory.SharedMemory + name: SharedMemory + uid: multiprocessing.shared_memory.SharedMemory +- fullName: netrc.netrc + href: https://docs.python.org/3/library/netrc.html#netrc.netrc + name: netrc + uid: netrc.netrc +- fullName: numbers.Complex + href: https://docs.python.org/3/library/numbers.html#numbers.Complex + name: Complex + uid: numbers.Complex +- fullName: numbers.Integral + href: https://docs.python.org/3/library/numbers.html#numbers.Integral + name: Integral + uid: numbers.Integral +- fullName: numbers.Number + href: https://docs.python.org/3/library/numbers.html#numbers.Number + name: Number + uid: numbers.Number +- fullName: numbers.Rational + href: https://docs.python.org/3/library/numbers.html#numbers.Rational + name: Rational + uid: numbers.Rational +- fullName: numbers.Real + href: https://docs.python.org/3/library/numbers.html#numbers.Real + name: Real + uid: numbers.Real +- fullName: object + href: https://docs.python.org/3/library/functions.html#object + name: object + uid: object +- fullName: optparse.Option + href: https://docs.python.org/3/library/optparse.html#optparse.Option + name: Option + uid: optparse.Option +- fullName: optparse.OptionGroup + href: https://docs.python.org/3/library/optparse.html#optparse.OptionGroup + name: OptionGroup + uid: optparse.OptionGroup +- fullName: optparse.OptionParser + href: https://docs.python.org/3/library/optparse.html#optparse.OptionParser + name: OptionParser + uid: optparse.OptionParser +- fullName: optparse.Values + href: https://docs.python.org/3/library/optparse.html#optparse.Values + name: Values + uid: optparse.Values +- fullName: os.DirEntry + href: https://docs.python.org/3/library/os.html#os.DirEntry + name: DirEntry + uid: os.DirEntry +- fullName: os.PathLike + href: https://docs.python.org/3/library/os.html#os.PathLike + name: PathLike + uid: os.PathLike +- fullName: os.sched_param + href: https://docs.python.org/3/library/os.html#os.sched_param + name: sched_param + uid: os.sched_param +- fullName: os.stat_result + href: https://docs.python.org/3/library/os.html#os.stat_result + name: stat_result + uid: os.stat_result +- fullName: os.terminal_size + href: https://docs.python.org/3/library/os.html#os.terminal_size + name: terminal_size + uid: os.terminal_size +- fullName: pathlib.Path + href: https://docs.python.org/3/library/pathlib.html#pathlib.Path + name: Path + uid: pathlib.Path +- fullName: pathlib.PosixPath + href: https://docs.python.org/3/library/pathlib.html#pathlib.PosixPath + name: PosixPath + uid: pathlib.PosixPath +- fullName: pathlib.PurePath + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePath + name: PurePath + uid: pathlib.PurePath +- fullName: pathlib.PurePosixPath + href: https://docs.python.org/3/library/pathlib.html#pathlib.PurePosixPath + name: PurePosixPath + uid: pathlib.PurePosixPath +- fullName: pathlib.PureWindowsPath + href: https://docs.python.org/3/library/pathlib.html#pathlib.PureWindowsPath + name: PureWindowsPath + uid: pathlib.PureWindowsPath +- fullName: pathlib.WindowsPath + href: https://docs.python.org/3/library/pathlib.html#pathlib.WindowsPath + name: WindowsPath + uid: pathlib.WindowsPath +- fullName: pdb.Pdb + href: https://docs.python.org/3/library/pdb.html#pdb.Pdb + name: Pdb + uid: pdb.Pdb +- fullName: pickle.PickleBuffer + href: https://docs.python.org/3/library/pickle.html#pickle.PickleBuffer + name: PickleBuffer + uid: pickle.PickleBuffer +- fullName: pickle.Pickler + href: https://docs.python.org/3/library/pickle.html#pickle.Pickler + name: Pickler + uid: pickle.Pickler +- fullName: pickle.Unpickler + href: https://docs.python.org/3/library/pickle.html#pickle.Unpickler + name: Unpickler + uid: pickle.Unpickler +- fullName: pkgutil.ModuleInfo + href: https://docs.python.org/3/library/pkgutil.html#pkgutil.ModuleInfo + name: ModuleInfo + uid: pkgutil.ModuleInfo +- fullName: plistlib.UID + href: https://docs.python.org/3/library/plistlib.html#plistlib.UID + name: UID + uid: plistlib.UID +- fullName: poplib.POP3 + href: https://docs.python.org/3/library/poplib.html#poplib.POP3 + name: POP3 + uid: poplib.POP3 +- fullName: poplib.POP3_SSL + href: https://docs.python.org/3/library/poplib.html#poplib.POP3_SSL + name: POP3_SSL + uid: poplib.POP3_SSL +- fullName: pprint.PrettyPrinter + href: https://docs.python.org/3/library/pprint.html#pprint.PrettyPrinter + name: PrettyPrinter + uid: pprint.PrettyPrinter +- fullName: profile.Profile + href: https://docs.python.org/3/library/profile.html#profile.Profile + name: Profile + uid: profile.Profile +- fullName: property + href: https://docs.python.org/3/library/functions.html#property + name: property + uid: property +- fullName: pstats.Stats + href: https://docs.python.org/3/library/profile.html#pstats.Stats + name: Stats + uid: pstats.Stats +- fullName: py_compile.PycInvalidationMode + href: https://docs.python.org/3/library/py_compile.html#py_compile.PycInvalidationMode + name: PycInvalidationMode + uid: py_compile.PycInvalidationMode +- fullName: pyclbr.Class + href: https://docs.python.org/3/library/pyclbr.html#pyclbr.Class + name: Class + uid: pyclbr.Class +- fullName: pyclbr.Function + href: https://docs.python.org/3/library/pyclbr.html#pyclbr.Function + name: Function + uid: pyclbr.Function +- fullName: queue.LifoQueue + href: https://docs.python.org/3/library/queue.html#queue.LifoQueue + name: LifoQueue + uid: queue.LifoQueue +- fullName: queue.PriorityQueue + href: https://docs.python.org/3/library/queue.html#queue.PriorityQueue + name: PriorityQueue + uid: queue.PriorityQueue +- fullName: queue.Queue + href: https://docs.python.org/3/library/queue.html#queue.Queue + name: Queue + uid: queue.Queue +- fullName: queue.SimpleQueue + href: https://docs.python.org/3/library/queue.html#queue.SimpleQueue + name: SimpleQueue + uid: queue.SimpleQueue +- fullName: random.Random + href: https://docs.python.org/3/library/random.html#random.Random + name: Random + uid: random.Random +- fullName: random.SystemRandom + href: https://docs.python.org/3/library/random.html#random.SystemRandom + name: SystemRandom + uid: random.SystemRandom +- fullName: range + href: https://docs.python.org/3/library/stdtypes.html#range + name: range + uid: range +- fullName: re.Match + href: https://docs.python.org/3/library/re.html#re.Match + name: Match + uid: re.Match +- fullName: re.Pattern + href: https://docs.python.org/3/library/re.html#re.Pattern + name: Pattern + uid: re.Pattern +- fullName: re.RegexFlag + href: https://docs.python.org/3/library/re.html#re.RegexFlag + name: RegexFlag + uid: re.RegexFlag +- fullName: reprlib.Repr + href: https://docs.python.org/3/library/reprlib.html#reprlib.Repr + name: Repr + uid: reprlib.Repr +- fullName: rlcompleter.Completer + href: https://docs.python.org/3/library/rlcompleter.html#rlcompleter.Completer + name: Completer + uid: rlcompleter.Completer +- fullName: sched.scheduler + href: https://docs.python.org/3/library/sched.html#sched.scheduler + name: scheduler + uid: sched.scheduler +- fullName: secrets.SystemRandom + href: https://docs.python.org/3/library/secrets.html#secrets.SystemRandom + name: SystemRandom + uid: secrets.SystemRandom +- fullName: selectors.BaseSelector + href: https://docs.python.org/3/library/selectors.html#selectors.BaseSelector + name: BaseSelector + uid: selectors.BaseSelector +- fullName: selectors.DefaultSelector + href: https://docs.python.org/3/library/selectors.html#selectors.DefaultSelector + name: DefaultSelector + uid: selectors.DefaultSelector +- fullName: selectors.DevpollSelector + href: https://docs.python.org/3/library/selectors.html#selectors.DevpollSelector + name: DevpollSelector + uid: selectors.DevpollSelector +- fullName: selectors.EpollSelector + href: https://docs.python.org/3/library/selectors.html#selectors.EpollSelector + name: EpollSelector + uid: selectors.EpollSelector +- fullName: selectors.KqueueSelector + href: https://docs.python.org/3/library/selectors.html#selectors.KqueueSelector + name: KqueueSelector + uid: selectors.KqueueSelector +- fullName: selectors.PollSelector + href: https://docs.python.org/3/library/selectors.html#selectors.PollSelector + name: PollSelector + uid: selectors.PollSelector +- fullName: selectors.SelectSelector + href: https://docs.python.org/3/library/selectors.html#selectors.SelectSelector + name: SelectSelector + uid: selectors.SelectSelector +- fullName: selectors.SelectorKey + href: https://docs.python.org/3/library/selectors.html#selectors.SelectorKey + name: SelectorKey + uid: selectors.SelectorKey +- fullName: set + href: https://docs.python.org/3/library/stdtypes.html#set + name: set + uid: set +- fullName: shelve.BsdDbShelf + href: https://docs.python.org/3/library/shelve.html#shelve.BsdDbShelf + name: BsdDbShelf + uid: shelve.BsdDbShelf +- fullName: shelve.DbfilenameShelf + href: https://docs.python.org/3/library/shelve.html#shelve.DbfilenameShelf + name: DbfilenameShelf + uid: shelve.DbfilenameShelf +- fullName: shelve.Shelf + href: https://docs.python.org/3/library/shelve.html#shelve.Shelf + name: Shelf + uid: shelve.Shelf +- fullName: shlex.shlex + href: https://docs.python.org/3/library/shlex.html#shlex.shlex + name: shlex + uid: shlex.shlex +- fullName: signal.Handlers + href: https://docs.python.org/3/library/signal.html#signal.Handlers + name: Handlers + uid: signal.Handlers +- fullName: signal.Sigmasks + href: https://docs.python.org/3/library/signal.html#signal.Sigmasks + name: Sigmasks + uid: signal.Sigmasks +- fullName: signal.Signals + href: https://docs.python.org/3/library/signal.html#signal.Signals + name: Signals + uid: signal.Signals +- fullName: slice + href: https://docs.python.org/3/library/functions.html#slice + name: slice + uid: slice +- fullName: smtplib.LMTP + href: https://docs.python.org/3/library/smtplib.html#smtplib.LMTP + name: LMTP + uid: smtplib.LMTP +- fullName: smtplib.SMTP + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTP + name: SMTP + uid: smtplib.SMTP +- fullName: smtplib.SMTP_SSL + href: https://docs.python.org/3/library/smtplib.html#smtplib.SMTP_SSL + name: SMTP_SSL + uid: smtplib.SMTP_SSL +- fullName: socket.socket + href: https://docs.python.org/3/library/socket.html#socket.socket + name: socket + uid: socket.socket +- fullName: socketserver.BaseRequestHandler + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseRequestHandler + name: BaseRequestHandler + uid: socketserver.BaseRequestHandler +- fullName: socketserver.BaseServer + href: https://docs.python.org/3/library/socketserver.html#socketserver.BaseServer + name: BaseServer + uid: socketserver.BaseServer +- fullName: socketserver.DatagramRequestHandler + href: https://docs.python.org/3/library/socketserver.html#socketserver.DatagramRequestHandler + name: DatagramRequestHandler + uid: socketserver.DatagramRequestHandler +- fullName: socketserver.ForkingMixIn + href: https://docs.python.org/3/library/socketserver.html#socketserver.ForkingMixIn + name: ForkingMixIn + uid: socketserver.ForkingMixIn +- fullName: socketserver.ForkingTCPServer + href: https://docs.python.org/3/library/socketserver.html#socketserver.ForkingTCPServer + name: ForkingTCPServer + uid: socketserver.ForkingTCPServer +- fullName: socketserver.ForkingUDPServer + href: https://docs.python.org/3/library/socketserver.html#socketserver.ForkingUDPServer + name: ForkingUDPServer + uid: socketserver.ForkingUDPServer +- fullName: socketserver.ForkingUnixDatagramServer + href: https://docs.python.org/3/library/socketserver.html#socketserver.ForkingUnixDatagramServer + name: ForkingUnixDatagramServer + uid: socketserver.ForkingUnixDatagramServer +- fullName: socketserver.ForkingUnixStreamServer + href: https://docs.python.org/3/library/socketserver.html#socketserver.ForkingUnixStreamServer + name: ForkingUnixStreamServer + uid: socketserver.ForkingUnixStreamServer +- fullName: socketserver.StreamRequestHandler + href: https://docs.python.org/3/library/socketserver.html#socketserver.StreamRequestHandler + name: StreamRequestHandler + uid: socketserver.StreamRequestHandler +- fullName: socketserver.TCPServer + href: https://docs.python.org/3/library/socketserver.html#socketserver.TCPServer + name: TCPServer + uid: socketserver.TCPServer +- fullName: socketserver.ThreadingMixIn + href: https://docs.python.org/3/library/socketserver.html#socketserver.ThreadingMixIn + name: ThreadingMixIn + uid: socketserver.ThreadingMixIn +- fullName: socketserver.ThreadingTCPServer + href: https://docs.python.org/3/library/socketserver.html#socketserver.ThreadingTCPServer + name: ThreadingTCPServer + uid: socketserver.ThreadingTCPServer +- fullName: socketserver.ThreadingUDPServer + href: https://docs.python.org/3/library/socketserver.html#socketserver.ThreadingUDPServer + name: ThreadingUDPServer + uid: socketserver.ThreadingUDPServer +- fullName: socketserver.ThreadingUnixDatagramServer + href: https://docs.python.org/3/library/socketserver.html#socketserver.ThreadingUnixDatagramServer + name: ThreadingUnixDatagramServer + uid: socketserver.ThreadingUnixDatagramServer +- fullName: socketserver.ThreadingUnixStreamServer + href: https://docs.python.org/3/library/socketserver.html#socketserver.ThreadingUnixStreamServer + name: ThreadingUnixStreamServer + uid: socketserver.ThreadingUnixStreamServer +- fullName: socketserver.UDPServer + href: https://docs.python.org/3/library/socketserver.html#socketserver.UDPServer + name: UDPServer + uid: socketserver.UDPServer +- fullName: socketserver.UnixDatagramServer + href: https://docs.python.org/3/library/socketserver.html#socketserver.UnixDatagramServer + name: UnixDatagramServer + uid: socketserver.UnixDatagramServer +- fullName: socketserver.UnixStreamServer + href: https://docs.python.org/3/library/socketserver.html#socketserver.UnixStreamServer + name: UnixStreamServer + uid: socketserver.UnixStreamServer +- fullName: sqlite3.Blob + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Blob + name: Blob + uid: sqlite3.Blob +- fullName: sqlite3.Connection + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Connection + name: Connection + uid: sqlite3.Connection +- fullName: sqlite3.Cursor + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Cursor + name: Cursor + uid: sqlite3.Cursor +- fullName: sqlite3.PrepareProtocol + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.PrepareProtocol + name: PrepareProtocol + uid: sqlite3.PrepareProtocol +- fullName: sqlite3.Row + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.Row + name: Row + uid: sqlite3.Row +- fullName: ssl.AlertDescription + href: https://docs.python.org/3/library/ssl.html#ssl.AlertDescription + name: AlertDescription + uid: ssl.AlertDescription +- fullName: ssl.MemoryBIO + href: https://docs.python.org/3/library/ssl.html#ssl.MemoryBIO + name: MemoryBIO + uid: ssl.MemoryBIO +- fullName: ssl.Options + href: https://docs.python.org/3/library/ssl.html#ssl.Options + name: Options + uid: ssl.Options +- fullName: ssl.SSLContext + href: https://docs.python.org/3/library/ssl.html#ssl.SSLContext + name: SSLContext + uid: ssl.SSLContext +- fullName: ssl.SSLErrorNumber + href: https://docs.python.org/3/library/ssl.html#ssl.SSLErrorNumber + name: SSLErrorNumber + uid: ssl.SSLErrorNumber +- fullName: ssl.SSLObject + href: https://docs.python.org/3/library/ssl.html#ssl.SSLObject + name: SSLObject + uid: ssl.SSLObject +- fullName: ssl.SSLSession + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSession + name: SSLSession + uid: ssl.SSLSession +- fullName: ssl.SSLSocket + href: https://docs.python.org/3/library/ssl.html#ssl.SSLSocket + name: SSLSocket + uid: ssl.SSLSocket +- fullName: ssl.TLSVersion + href: https://docs.python.org/3/library/ssl.html#ssl.TLSVersion + name: TLSVersion + uid: ssl.TLSVersion +- fullName: ssl.VerifyFlags + href: https://docs.python.org/3/library/ssl.html#ssl.VerifyFlags + name: VerifyFlags + uid: ssl.VerifyFlags +- fullName: ssl.VerifyMode + href: https://docs.python.org/3/library/ssl.html#ssl.VerifyMode + name: VerifyMode + uid: ssl.VerifyMode +- fullName: statistics.NormalDist + href: https://docs.python.org/3/library/statistics.html#statistics.NormalDist + name: NormalDist + uid: statistics.NormalDist +- fullName: str + href: https://docs.python.org/3/library/stdtypes.html#str + name: str + uid: str +- fullName: string.Formatter + href: https://docs.python.org/3/library/string.html#string.Formatter + name: Formatter + uid: string.Formatter +- fullName: string.Template + href: https://docs.python.org/3/library/string.html#string.Template + name: Template + uid: string.Template +- fullName: struct.Struct + href: https://docs.python.org/3/library/struct.html#struct.Struct + name: Struct + uid: struct.Struct +- fullName: subprocess.CompletedProcess + href: https://docs.python.org/3/library/subprocess.html#subprocess.CompletedProcess + name: CompletedProcess + uid: subprocess.CompletedProcess +- fullName: subprocess.Popen + href: https://docs.python.org/3/library/subprocess.html#subprocess.Popen + name: Popen + uid: subprocess.Popen +- fullName: subprocess.STARTUPINFO + href: https://docs.python.org/3/library/subprocess.html#subprocess.STARTUPINFO + name: STARTUPINFO + uid: subprocess.STARTUPINFO +- fullName: super + href: https://docs.python.org/3/library/functions.html#super + name: super + uid: super +- fullName: symtable.Class + href: https://docs.python.org/3/library/symtable.html#symtable.Class + name: Class + uid: symtable.Class +- fullName: symtable.Function + href: https://docs.python.org/3/library/symtable.html#symtable.Function + name: Function + uid: symtable.Function +- fullName: symtable.Symbol + href: https://docs.python.org/3/library/symtable.html#symtable.Symbol + name: Symbol + uid: symtable.Symbol +- fullName: symtable.SymbolTable + href: https://docs.python.org/3/library/symtable.html#symtable.SymbolTable + name: SymbolTable + uid: symtable.SymbolTable +- fullName: symtable.SymbolTableType + href: https://docs.python.org/3/library/symtable.html#symtable.SymbolTableType + name: SymbolTableType + uid: symtable.SymbolTableType +- fullName: tarfile.TarFile + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarFile + name: TarFile + uid: tarfile.TarFile +- fullName: tarfile.TarInfo + href: https://docs.python.org/3/library/tarfile.html#tarfile.TarInfo + name: TarInfo + uid: tarfile.TarInfo +- fullName: tempfile.SpooledTemporaryFile + href: https://docs.python.org/3/library/tempfile.html#tempfile.SpooledTemporaryFile + name: SpooledTemporaryFile + uid: tempfile.SpooledTemporaryFile +- fullName: tempfile.TemporaryDirectory + href: https://docs.python.org/3/library/tempfile.html#tempfile.TemporaryDirectory + name: TemporaryDirectory + uid: tempfile.TemporaryDirectory +- fullName: test.support.Matcher + href: https://docs.python.org/3/library/test.html#test.support.Matcher + name: Matcher + uid: test.support.Matcher +- fullName: test.support.SaveSignals + href: https://docs.python.org/3/library/test.html#test.support.SaveSignals + name: SaveSignals + uid: test.support.SaveSignals +- fullName: test.support.SuppressCrashReport + href: https://docs.python.org/3/library/test.html#test.support.SuppressCrashReport + name: SuppressCrashReport + uid: test.support.SuppressCrashReport +- fullName: test.support.bytecode_helper.BytecodeTestCase + href: https://docs.python.org/3/library/test.html#test.support.bytecode_helper.BytecodeTestCase + name: BytecodeTestCase + uid: test.support.bytecode_helper.BytecodeTestCase +- fullName: test.support.import_helper.CleanImport + href: https://docs.python.org/3/library/test.html#test.support.import_helper.CleanImport + name: CleanImport + uid: test.support.import_helper.CleanImport +- fullName: test.support.import_helper.DirsOnSysPath + href: https://docs.python.org/3/library/test.html#test.support.import_helper.DirsOnSysPath + name: DirsOnSysPath + uid: test.support.import_helper.DirsOnSysPath +- fullName: test.support.os_helper.EnvironmentVarGuard + href: https://docs.python.org/3/library/test.html#test.support.os_helper.EnvironmentVarGuard + name: EnvironmentVarGuard + uid: test.support.os_helper.EnvironmentVarGuard +- fullName: test.support.os_helper.FakePath + href: https://docs.python.org/3/library/test.html#test.support.os_helper.FakePath + name: FakePath + uid: test.support.os_helper.FakePath +- fullName: test.support.warnings_helper.WarningsRecorder + href: https://docs.python.org/3/library/test.html#test.support.warnings_helper.WarningsRecorder + name: WarningsRecorder + uid: test.support.warnings_helper.WarningsRecorder +- fullName: textwrap.TextWrapper + href: https://docs.python.org/3/library/textwrap.html#textwrap.TextWrapper + name: TextWrapper + uid: textwrap.TextWrapper +- fullName: threading.Barrier + href: https://docs.python.org/3/library/threading.html#threading.Barrier + name: Barrier + uid: threading.Barrier +- fullName: threading.BoundedSemaphore + href: https://docs.python.org/3/library/threading.html#threading.BoundedSemaphore + name: BoundedSemaphore + uid: threading.BoundedSemaphore +- fullName: threading.Condition + href: https://docs.python.org/3/library/threading.html#threading.Condition + name: Condition + uid: threading.Condition +- fullName: threading.Event + href: https://docs.python.org/3/library/threading.html#threading.Event + name: Event + uid: threading.Event +- fullName: threading.Lock + href: https://docs.python.org/3/library/threading.html#threading.Lock + name: Lock + uid: threading.Lock +- fullName: threading.RLock + href: https://docs.python.org/3/library/threading.html#threading.RLock + name: RLock + uid: threading.RLock +- fullName: threading.Semaphore + href: https://docs.python.org/3/library/threading.html#threading.Semaphore + name: Semaphore + uid: threading.Semaphore +- fullName: threading.Thread + href: https://docs.python.org/3/library/threading.html#threading.Thread + name: Thread + uid: threading.Thread +- fullName: threading.Timer + href: https://docs.python.org/3/library/threading.html#threading.Timer + name: Timer + uid: threading.Timer +- fullName: threading.local + href: https://docs.python.org/3/library/threading.html#threading.local + name: local + uid: threading.local +- fullName: time.struct_time + href: https://docs.python.org/3/library/time.html#time.struct_time + name: struct_time + uid: time.struct_time +- fullName: timeit.Timer + href: https://docs.python.org/3/library/timeit.html#timeit.Timer + name: Timer + uid: timeit.Timer +- fullName: tkinter.Tk + href: https://docs.python.org/3/library/tkinter.html#tkinter.Tk + name: Tk + uid: tkinter.Tk +- fullName: tkinter.colorchooser.Chooser + href: https://docs.python.org/3/library/tkinter.colorchooser.html#tkinter.colorchooser.Chooser + name: Chooser + uid: tkinter.colorchooser.Chooser +- fullName: tkinter.commondialog.Dialog + href: https://docs.python.org/3/library/dialog.html#tkinter.commondialog.Dialog + name: Dialog + uid: tkinter.commondialog.Dialog +- fullName: tkinter.dnd.DndHandler + href: https://docs.python.org/3/library/tkinter.dnd.html#tkinter.dnd.DndHandler + name: DndHandler + uid: tkinter.dnd.DndHandler +- fullName: tkinter.filedialog.Directory + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.Directory + name: Directory + uid: tkinter.filedialog.Directory +- fullName: tkinter.filedialog.FileDialog + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.FileDialog + name: FileDialog + uid: tkinter.filedialog.FileDialog +- fullName: tkinter.filedialog.LoadFileDialog + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.LoadFileDialog + name: LoadFileDialog + uid: tkinter.filedialog.LoadFileDialog +- fullName: tkinter.filedialog.Open + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.Open + name: Open + uid: tkinter.filedialog.Open +- fullName: tkinter.filedialog.SaveAs + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.SaveAs + name: SaveAs + uid: tkinter.filedialog.SaveAs +- fullName: tkinter.filedialog.SaveFileDialog + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.SaveFileDialog + name: SaveFileDialog + uid: tkinter.filedialog.SaveFileDialog +- fullName: tkinter.font.Font + href: https://docs.python.org/3/library/tkinter.font.html#tkinter.font.Font + name: Font + uid: tkinter.font.Font +- fullName: tkinter.messagebox.Message + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.Message + name: Message + uid: tkinter.messagebox.Message +- fullName: tkinter.scrolledtext.ScrolledText + href: https://docs.python.org/3/library/tkinter.scrolledtext.html#tkinter.scrolledtext.ScrolledText + name: ScrolledText + uid: tkinter.scrolledtext.ScrolledText +- fullName: tkinter.simpledialog.Dialog + href: https://docs.python.org/3/library/dialog.html#tkinter.simpledialog.Dialog + name: Dialog + uid: tkinter.simpledialog.Dialog +- fullName: tkinter.ttk.Combobox + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Combobox + name: Combobox + uid: tkinter.ttk.Combobox +- fullName: tkinter.ttk.Notebook + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Notebook + name: Notebook + uid: tkinter.ttk.Notebook +- fullName: tkinter.ttk.Progressbar + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Progressbar + name: Progressbar + uid: tkinter.ttk.Progressbar +- fullName: tkinter.ttk.Spinbox + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Spinbox + name: Spinbox + uid: tkinter.ttk.Spinbox +- fullName: tkinter.ttk.Style + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Style + name: Style + uid: tkinter.ttk.Style +- fullName: tkinter.ttk.Treeview + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Treeview + name: Treeview + uid: tkinter.ttk.Treeview +- fullName: tkinter.ttk.Widget + href: https://docs.python.org/3/library/tkinter.ttk.html#tkinter.ttk.Widget + name: Widget + uid: tkinter.ttk.Widget +- fullName: trace.CoverageResults + href: https://docs.python.org/3/library/trace.html#trace.CoverageResults + name: CoverageResults + uid: trace.CoverageResults +- fullName: trace.Trace + href: https://docs.python.org/3/library/trace.html#trace.Trace + name: Trace + uid: trace.Trace +- fullName: traceback.FrameSummary + href: https://docs.python.org/3/library/traceback.html#traceback.FrameSummary + name: FrameSummary + uid: traceback.FrameSummary +- fullName: traceback.StackSummary + href: https://docs.python.org/3/library/traceback.html#traceback.StackSummary + name: StackSummary + uid: traceback.StackSummary +- fullName: traceback.TracebackException + href: https://docs.python.org/3/library/traceback.html#traceback.TracebackException + name: TracebackException + uid: traceback.TracebackException +- fullName: tracemalloc.DomainFilter + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.DomainFilter + name: DomainFilter + uid: tracemalloc.DomainFilter +- fullName: tracemalloc.Filter + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Filter + name: Filter + uid: tracemalloc.Filter +- fullName: tracemalloc.Frame + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Frame + name: Frame + uid: tracemalloc.Frame +- fullName: tracemalloc.Snapshot + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Snapshot + name: Snapshot + uid: tracemalloc.Snapshot +- fullName: tracemalloc.Statistic + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Statistic + name: Statistic + uid: tracemalloc.Statistic +- fullName: tracemalloc.StatisticDiff + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.StatisticDiff + name: StatisticDiff + uid: tracemalloc.StatisticDiff +- fullName: tracemalloc.Trace + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Trace + name: Trace + uid: tracemalloc.Trace +- fullName: tracemalloc.Traceback + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Traceback + name: Traceback + uid: tracemalloc.Traceback +- fullName: tuple + href: https://docs.python.org/3/library/stdtypes.html#tuple + name: tuple + uid: tuple +- fullName: turtle.RawPen + href: https://docs.python.org/3/library/turtle.html#turtle.RawPen + name: RawPen + uid: turtle.RawPen +- fullName: turtle.RawTurtle + href: https://docs.python.org/3/library/turtle.html#turtle.RawTurtle + name: RawTurtle + uid: turtle.RawTurtle +- fullName: turtle.Screen + href: https://docs.python.org/3/library/turtle.html#turtle.Screen + name: Screen + uid: turtle.Screen +- fullName: turtle.ScrolledCanvas + href: https://docs.python.org/3/library/turtle.html#turtle.ScrolledCanvas + name: ScrolledCanvas + uid: turtle.ScrolledCanvas +- fullName: turtle.Shape + href: https://docs.python.org/3/library/turtle.html#turtle.Shape + name: Shape + uid: turtle.Shape +- fullName: turtle.Turtle + href: https://docs.python.org/3/library/turtle.html#turtle.Turtle + name: Turtle + uid: turtle.Turtle +- fullName: turtle.TurtleScreen + href: https://docs.python.org/3/library/turtle.html#turtle.TurtleScreen + name: TurtleScreen + uid: turtle.TurtleScreen +- fullName: turtle.Vec2D + href: https://docs.python.org/3/library/turtle.html#turtle.Vec2D + name: Vec2D + uid: turtle.Vec2D +- fullName: type + href: https://docs.python.org/3/library/functions.html#type + name: type + uid: type +- fullName: types.CapsuleType + href: https://docs.python.org/3/library/types.html#types.CapsuleType + name: CapsuleType + uid: types.CapsuleType +- fullName: types.CodeType + href: https://docs.python.org/3/library/types.html#types.CodeType + name: CodeType + uid: types.CodeType +- fullName: types.GenericAlias + href: https://docs.python.org/3/library/types.html#types.GenericAlias + name: GenericAlias + uid: types.GenericAlias +- fullName: types.MappingProxyType + href: https://docs.python.org/3/library/types.html#types.MappingProxyType + name: MappingProxyType + uid: types.MappingProxyType +- fullName: types.ModuleType + href: https://docs.python.org/3/library/types.html#types.ModuleType + name: ModuleType + uid: types.ModuleType +- fullName: types.SimpleNamespace + href: https://docs.python.org/3/library/types.html#types.SimpleNamespace + name: SimpleNamespace + uid: types.SimpleNamespace +- fullName: types.TracebackType + href: https://docs.python.org/3/library/types.html#types.TracebackType + name: TracebackType + uid: types.TracebackType +- fullName: types.UnionType + href: https://docs.python.org/3/library/types.html#types.UnionType + name: UnionType + uid: types.UnionType +- fullName: typing.AbstractSet + href: https://docs.python.org/3/library/typing.html#typing.AbstractSet + name: AbstractSet + uid: typing.AbstractSet +- fullName: typing.AsyncContextManager + href: https://docs.python.org/3/library/typing.html#typing.AsyncContextManager + name: AsyncContextManager + uid: typing.AsyncContextManager +- fullName: typing.AsyncGenerator + href: https://docs.python.org/3/library/typing.html#typing.AsyncGenerator + name: AsyncGenerator + uid: typing.AsyncGenerator +- fullName: typing.AsyncIterable + href: https://docs.python.org/3/library/typing.html#typing.AsyncIterable + name: AsyncIterable + uid: typing.AsyncIterable +- fullName: typing.AsyncIterator + href: https://docs.python.org/3/library/typing.html#typing.AsyncIterator + name: AsyncIterator + uid: typing.AsyncIterator +- fullName: typing.Awaitable + href: https://docs.python.org/3/library/typing.html#typing.Awaitable + name: Awaitable + uid: typing.Awaitable +- fullName: typing.BinaryIO + href: https://docs.python.org/3/library/typing.html#typing.BinaryIO + name: BinaryIO + uid: typing.BinaryIO +- fullName: typing.ByteString + href: https://docs.python.org/3/library/typing.html#typing.ByteString + name: ByteString + uid: typing.ByteString +- fullName: typing.ChainMap + href: https://docs.python.org/3/library/typing.html#typing.ChainMap + name: ChainMap + uid: typing.ChainMap +- fullName: typing.Collection + href: https://docs.python.org/3/library/typing.html#typing.Collection + name: Collection + uid: typing.Collection +- fullName: typing.Container + href: https://docs.python.org/3/library/typing.html#typing.Container + name: Container + uid: typing.Container +- fullName: typing.ContextManager + href: https://docs.python.org/3/library/typing.html#typing.ContextManager + name: ContextManager + uid: typing.ContextManager +- fullName: typing.Coroutine + href: https://docs.python.org/3/library/typing.html#typing.Coroutine + name: Coroutine + uid: typing.Coroutine +- fullName: typing.Counter + href: https://docs.python.org/3/library/typing.html#typing.Counter + name: Counter + uid: typing.Counter +- fullName: typing.DefaultDict + href: https://docs.python.org/3/library/typing.html#typing.DefaultDict + name: DefaultDict + uid: typing.DefaultDict +- fullName: typing.Deque + href: https://docs.python.org/3/library/typing.html#typing.Deque + name: Deque + uid: typing.Deque +- fullName: typing.Dict + href: https://docs.python.org/3/library/typing.html#typing.Dict + name: Dict + uid: typing.Dict +- fullName: typing.ForwardRef + href: https://docs.python.org/3/library/typing.html#typing.ForwardRef + name: ForwardRef + uid: typing.ForwardRef +- fullName: typing.FrozenSet + href: https://docs.python.org/3/library/typing.html#typing.FrozenSet + name: FrozenSet + uid: typing.FrozenSet +- fullName: typing.Generator + href: https://docs.python.org/3/library/typing.html#typing.Generator + name: Generator + uid: typing.Generator +- fullName: typing.Generic + href: https://docs.python.org/3/library/typing.html#typing.Generic + name: Generic + uid: typing.Generic +- fullName: typing.Hashable + href: https://docs.python.org/3/library/typing.html#typing.Hashable + name: Hashable + uid: typing.Hashable +- fullName: typing.IO + href: https://docs.python.org/3/library/typing.html#typing.IO + name: IO + uid: typing.IO +- fullName: typing.ItemsView + href: https://docs.python.org/3/library/typing.html#typing.ItemsView + name: ItemsView + uid: typing.ItemsView +- fullName: typing.Iterable + href: https://docs.python.org/3/library/typing.html#typing.Iterable + name: Iterable + uid: typing.Iterable +- fullName: typing.Iterator + href: https://docs.python.org/3/library/typing.html#typing.Iterator + name: Iterator + uid: typing.Iterator +- fullName: typing.KeysView + href: https://docs.python.org/3/library/typing.html#typing.KeysView + name: KeysView + uid: typing.KeysView +- fullName: typing.List + href: https://docs.python.org/3/library/typing.html#typing.List + name: List + uid: typing.List +- fullName: typing.Mapping + href: https://docs.python.org/3/library/typing.html#typing.Mapping + name: Mapping + uid: typing.Mapping +- fullName: typing.MappingView + href: https://docs.python.org/3/library/typing.html#typing.MappingView + name: MappingView + uid: typing.MappingView +- fullName: typing.Match + href: https://docs.python.org/3/library/typing.html#typing.Match + name: Match + uid: typing.Match +- fullName: typing.MutableMapping + href: https://docs.python.org/3/library/typing.html#typing.MutableMapping + name: MutableMapping + uid: typing.MutableMapping +- fullName: typing.MutableSequence + href: https://docs.python.org/3/library/typing.html#typing.MutableSequence + name: MutableSequence + uid: typing.MutableSequence +- fullName: typing.MutableSet + href: https://docs.python.org/3/library/typing.html#typing.MutableSet + name: MutableSet + uid: typing.MutableSet +- fullName: typing.NamedTuple + href: https://docs.python.org/3/library/typing.html#typing.NamedTuple + name: NamedTuple + uid: typing.NamedTuple +- fullName: typing.NewType + href: https://docs.python.org/3/library/typing.html#typing.NewType + name: NewType + uid: typing.NewType +- fullName: typing.OrderedDict + href: https://docs.python.org/3/library/typing.html#typing.OrderedDict + name: OrderedDict + uid: typing.OrderedDict +- fullName: typing.ParamSpec + href: https://docs.python.org/3/library/typing.html#typing.ParamSpec + name: ParamSpec + uid: typing.ParamSpec +- fullName: typing.Pattern + href: https://docs.python.org/3/library/typing.html#typing.Pattern + name: Pattern + uid: typing.Pattern +- fullName: typing.Protocol + href: https://docs.python.org/3/library/typing.html#typing.Protocol + name: Protocol + uid: typing.Protocol +- fullName: typing.Reversible + href: https://docs.python.org/3/library/typing.html#typing.Reversible + name: Reversible + uid: typing.Reversible +- fullName: typing.Sequence + href: https://docs.python.org/3/library/typing.html#typing.Sequence + name: Sequence + uid: typing.Sequence +- fullName: typing.Set + href: https://docs.python.org/3/library/typing.html#typing.Set + name: Set + uid: typing.Set +- fullName: typing.Sized + href: https://docs.python.org/3/library/typing.html#typing.Sized + name: Sized + uid: typing.Sized +- fullName: typing.SupportsAbs + href: https://docs.python.org/3/library/typing.html#typing.SupportsAbs + name: SupportsAbs + uid: typing.SupportsAbs +- fullName: typing.SupportsBytes + href: https://docs.python.org/3/library/typing.html#typing.SupportsBytes + name: SupportsBytes + uid: typing.SupportsBytes +- fullName: typing.SupportsComplex + href: https://docs.python.org/3/library/typing.html#typing.SupportsComplex + name: SupportsComplex + uid: typing.SupportsComplex +- fullName: typing.SupportsFloat + href: https://docs.python.org/3/library/typing.html#typing.SupportsFloat + name: SupportsFloat + uid: typing.SupportsFloat +- fullName: typing.SupportsIndex + href: https://docs.python.org/3/library/typing.html#typing.SupportsIndex + name: SupportsIndex + uid: typing.SupportsIndex +- fullName: typing.SupportsInt + href: https://docs.python.org/3/library/typing.html#typing.SupportsInt + name: SupportsInt + uid: typing.SupportsInt +- fullName: typing.SupportsRound + href: https://docs.python.org/3/library/typing.html#typing.SupportsRound + name: SupportsRound + uid: typing.SupportsRound +- fullName: typing.Text + href: https://docs.python.org/3/library/typing.html#typing.Text + name: Text + uid: typing.Text +- fullName: typing.TextIO + href: https://docs.python.org/3/library/typing.html#typing.TextIO + name: TextIO + uid: typing.TextIO +- fullName: typing.Type + href: https://docs.python.org/3/library/typing.html#typing.Type + name: Type + uid: typing.Type +- fullName: typing.TypeAliasType + href: https://docs.python.org/3/library/typing.html#typing.TypeAliasType + name: TypeAliasType + uid: typing.TypeAliasType +- fullName: typing.TypeVar + href: https://docs.python.org/3/library/typing.html#typing.TypeVar + name: TypeVar + uid: typing.TypeVar +- fullName: typing.TypeVarTuple + href: https://docs.python.org/3/library/typing.html#typing.TypeVarTuple + name: TypeVarTuple + uid: typing.TypeVarTuple +- fullName: typing.TypedDict + href: https://docs.python.org/3/library/typing.html#typing.TypedDict + name: TypedDict + uid: typing.TypedDict +- fullName: typing.ValuesView + href: https://docs.python.org/3/library/typing.html#typing.ValuesView + name: ValuesView + uid: typing.ValuesView +- fullName: unittest.FunctionTestCase + href: https://docs.python.org/3/library/unittest.html#unittest.FunctionTestCase + name: FunctionTestCase + uid: unittest.FunctionTestCase +- fullName: unittest.IsolatedAsyncioTestCase + href: https://docs.python.org/3/library/unittest.html#unittest.IsolatedAsyncioTestCase + name: IsolatedAsyncioTestCase + uid: unittest.IsolatedAsyncioTestCase +- fullName: unittest.TestCase + href: https://docs.python.org/3/library/unittest.html#unittest.TestCase + name: TestCase + uid: unittest.TestCase +- fullName: unittest.TestLoader + href: https://docs.python.org/3/library/unittest.html#unittest.TestLoader + name: TestLoader + uid: unittest.TestLoader +- fullName: unittest.TestResult + href: https://docs.python.org/3/library/unittest.html#unittest.TestResult + name: TestResult + uid: unittest.TestResult +- fullName: unittest.TestSuite + href: https://docs.python.org/3/library/unittest.html#unittest.TestSuite + name: TestSuite + uid: unittest.TestSuite +- fullName: unittest.TextTestResult + href: https://docs.python.org/3/library/unittest.html#unittest.TextTestResult + name: TextTestResult + uid: unittest.TextTestResult +- fullName: unittest.TextTestRunner + href: https://docs.python.org/3/library/unittest.html#unittest.TextTestRunner + name: TextTestRunner + uid: unittest.TextTestRunner +- fullName: unittest.mock.AsyncMock + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.AsyncMock + name: AsyncMock + uid: unittest.mock.AsyncMock +- fullName: unittest.mock.MagicMock + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.MagicMock + name: MagicMock + uid: unittest.mock.MagicMock +- fullName: unittest.mock.Mock + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.Mock + name: Mock + uid: unittest.mock.Mock +- fullName: unittest.mock.NonCallableMagicMock + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.NonCallableMagicMock + name: NonCallableMagicMock + uid: unittest.mock.NonCallableMagicMock +- fullName: unittest.mock.NonCallableMock + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.NonCallableMock + name: NonCallableMock + uid: unittest.mock.NonCallableMock +- fullName: unittest.mock.PropertyMock + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.PropertyMock + name: PropertyMock + uid: unittest.mock.PropertyMock +- fullName: unittest.mock.ThreadingMock + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.ThreadingMock + name: ThreadingMock + uid: unittest.mock.ThreadingMock +- fullName: urllib.parse.DefragResult + href: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.DefragResult + name: DefragResult + uid: urllib.parse.DefragResult +- fullName: urllib.parse.DefragResultBytes + href: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.DefragResultBytes + name: DefragResultBytes + uid: urllib.parse.DefragResultBytes +- fullName: urllib.parse.ParseResult + href: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.ParseResult + name: ParseResult + uid: urllib.parse.ParseResult +- fullName: urllib.parse.ParseResultBytes + href: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.ParseResultBytes + name: ParseResultBytes + uid: urllib.parse.ParseResultBytes +- fullName: urllib.parse.SplitResult + href: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.SplitResult + name: SplitResult + uid: urllib.parse.SplitResult +- fullName: urllib.parse.SplitResultBytes + href: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.SplitResultBytes + name: SplitResultBytes + uid: urllib.parse.SplitResultBytes +- fullName: urllib.request.AbstractBasicAuthHandler + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.AbstractBasicAuthHandler + name: AbstractBasicAuthHandler + uid: urllib.request.AbstractBasicAuthHandler +- fullName: urllib.request.AbstractDigestAuthHandler + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.AbstractDigestAuthHandler + name: AbstractDigestAuthHandler + uid: urllib.request.AbstractDigestAuthHandler +- fullName: urllib.request.BaseHandler + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.BaseHandler + name: BaseHandler + uid: urllib.request.BaseHandler +- fullName: urllib.request.CacheFTPHandler + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.CacheFTPHandler + name: CacheFTPHandler + uid: urllib.request.CacheFTPHandler +- fullName: urllib.request.DataHandler + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.DataHandler + name: DataHandler + uid: urllib.request.DataHandler +- fullName: urllib.request.FTPHandler + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.FTPHandler + name: FTPHandler + uid: urllib.request.FTPHandler +- fullName: urllib.request.FancyURLopener + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.FancyURLopener + name: FancyURLopener + uid: urllib.request.FancyURLopener +- fullName: urllib.request.FileHandler + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.FileHandler + name: FileHandler + uid: urllib.request.FileHandler +- fullName: urllib.request.HTTPBasicAuthHandler + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPBasicAuthHandler + name: HTTPBasicAuthHandler + uid: urllib.request.HTTPBasicAuthHandler +- fullName: urllib.request.HTTPCookieProcessor + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPCookieProcessor + name: HTTPCookieProcessor + uid: urllib.request.HTTPCookieProcessor +- fullName: urllib.request.HTTPDefaultErrorHandler + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPDefaultErrorHandler + name: HTTPDefaultErrorHandler + uid: urllib.request.HTTPDefaultErrorHandler +- fullName: urllib.request.HTTPDigestAuthHandler + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPDigestAuthHandler + name: HTTPDigestAuthHandler + uid: urllib.request.HTTPDigestAuthHandler +- fullName: urllib.request.HTTPErrorProcessor + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPErrorProcessor + name: HTTPErrorProcessor + uid: urllib.request.HTTPErrorProcessor +- fullName: urllib.request.HTTPHandler + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPHandler + name: HTTPHandler + uid: urllib.request.HTTPHandler +- fullName: urllib.request.HTTPPasswordMgr + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPPasswordMgr + name: HTTPPasswordMgr + uid: urllib.request.HTTPPasswordMgr +- fullName: urllib.request.HTTPPasswordMgrWithDefaultRealm + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPPasswordMgrWithDefaultRealm + name: HTTPPasswordMgrWithDefaultRealm + uid: urllib.request.HTTPPasswordMgrWithDefaultRealm +- fullName: urllib.request.HTTPPasswordMgrWithPriorAuth + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPPasswordMgrWithPriorAuth + name: HTTPPasswordMgrWithPriorAuth + uid: urllib.request.HTTPPasswordMgrWithPriorAuth +- fullName: urllib.request.HTTPRedirectHandler + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPRedirectHandler + name: HTTPRedirectHandler + uid: urllib.request.HTTPRedirectHandler +- fullName: urllib.request.HTTPSHandler + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.HTTPSHandler + name: HTTPSHandler + uid: urllib.request.HTTPSHandler +- fullName: urllib.request.OpenerDirector + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.OpenerDirector + name: OpenerDirector + uid: urllib.request.OpenerDirector +- fullName: urllib.request.ProxyBasicAuthHandler + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.ProxyBasicAuthHandler + name: ProxyBasicAuthHandler + uid: urllib.request.ProxyBasicAuthHandler +- fullName: urllib.request.ProxyDigestAuthHandler + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.ProxyDigestAuthHandler + name: ProxyDigestAuthHandler + uid: urllib.request.ProxyDigestAuthHandler +- fullName: urllib.request.ProxyHandler + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.ProxyHandler + name: ProxyHandler + uid: urllib.request.ProxyHandler +- fullName: urllib.request.Request + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.Request + name: Request + uid: urllib.request.Request +- fullName: urllib.request.URLopener + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.URLopener + name: URLopener + uid: urllib.request.URLopener +- fullName: urllib.request.UnknownHandler + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.UnknownHandler + name: UnknownHandler + uid: urllib.request.UnknownHandler +- fullName: urllib.response.addinfourl + href: https://docs.python.org/3/library/urllib.request.html#urllib.response.addinfourl + name: addinfourl + uid: urllib.response.addinfourl +- fullName: urllib.robotparser.RobotFileParser + href: https://docs.python.org/3/library/urllib.robotparser.html#urllib.robotparser.RobotFileParser + name: RobotFileParser + uid: urllib.robotparser.RobotFileParser +- fullName: uuid.SafeUUID + href: https://docs.python.org/3/library/uuid.html#uuid.SafeUUID + name: SafeUUID + uid: uuid.SafeUUID +- fullName: uuid.UUID + href: https://docs.python.org/3/library/uuid.html#uuid.UUID + name: UUID + uid: uuid.UUID +- fullName: venv.EnvBuilder + href: https://docs.python.org/3/library/venv.html#venv.EnvBuilder + name: EnvBuilder + uid: venv.EnvBuilder +- fullName: warnings.catch_warnings + href: https://docs.python.org/3/library/warnings.html#warnings.catch_warnings + name: catch_warnings + uid: warnings.catch_warnings +- fullName: wave.Wave_read + href: https://docs.python.org/3/library/wave.html#wave.Wave_read + name: Wave_read + uid: wave.Wave_read +- fullName: wave.Wave_write + href: https://docs.python.org/3/library/wave.html#wave.Wave_write + name: Wave_write + uid: wave.Wave_write +- fullName: weakref.WeakKeyDictionary + href: https://docs.python.org/3/library/weakref.html#weakref.WeakKeyDictionary + name: WeakKeyDictionary + uid: weakref.WeakKeyDictionary +- fullName: weakref.WeakMethod + href: https://docs.python.org/3/library/weakref.html#weakref.WeakMethod + name: WeakMethod + uid: weakref.WeakMethod +- fullName: weakref.WeakSet + href: https://docs.python.org/3/library/weakref.html#weakref.WeakSet + name: WeakSet + uid: weakref.WeakSet +- fullName: weakref.WeakValueDictionary + href: https://docs.python.org/3/library/weakref.html#weakref.WeakValueDictionary + name: WeakValueDictionary + uid: weakref.WeakValueDictionary +- fullName: weakref.finalize + href: https://docs.python.org/3/library/weakref.html#weakref.finalize + name: finalize + uid: weakref.finalize +- fullName: weakref.ref + href: https://docs.python.org/3/library/weakref.html#weakref.ref + name: ref + uid: weakref.ref +- fullName: wsgiref.handlers.BaseCGIHandler + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseCGIHandler + name: BaseCGIHandler + uid: wsgiref.handlers.BaseCGIHandler +- fullName: wsgiref.handlers.BaseHandler + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.BaseHandler + name: BaseHandler + uid: wsgiref.handlers.BaseHandler +- fullName: wsgiref.handlers.CGIHandler + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.CGIHandler + name: CGIHandler + uid: wsgiref.handlers.CGIHandler +- fullName: wsgiref.handlers.IISCGIHandler + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.IISCGIHandler + name: IISCGIHandler + uid: wsgiref.handlers.IISCGIHandler +- fullName: wsgiref.handlers.SimpleHandler + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.SimpleHandler + name: SimpleHandler + uid: wsgiref.handlers.SimpleHandler +- fullName: wsgiref.headers.Headers + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.headers.Headers + name: Headers + uid: wsgiref.headers.Headers +- fullName: wsgiref.simple_server.WSGIRequestHandler + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.simple_server.WSGIRequestHandler + name: WSGIRequestHandler + uid: wsgiref.simple_server.WSGIRequestHandler +- fullName: wsgiref.simple_server.WSGIServer + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.simple_server.WSGIServer + name: WSGIServer + uid: wsgiref.simple_server.WSGIServer +- fullName: wsgiref.types.ErrorStream + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.types.ErrorStream + name: ErrorStream + uid: wsgiref.types.ErrorStream +- fullName: wsgiref.types.FileWrapper + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.types.FileWrapper + name: FileWrapper + uid: wsgiref.types.FileWrapper +- fullName: wsgiref.types.InputStream + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.types.InputStream + name: InputStream + uid: wsgiref.types.InputStream +- fullName: wsgiref.types.StartResponse + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.types.StartResponse + name: StartResponse + uid: wsgiref.types.StartResponse +- fullName: wsgiref.util.FileWrapper + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.util.FileWrapper + name: FileWrapper + uid: wsgiref.util.FileWrapper +- fullName: xml.dom.pulldom.DOMEventStream + href: https://docs.python.org/3/library/xml.dom.pulldom.html#xml.dom.pulldom.DOMEventStream + name: DOMEventStream + uid: xml.dom.pulldom.DOMEventStream +- fullName: xml.dom.pulldom.PullDom + href: https://docs.python.org/3/library/xml.dom.pulldom.html#xml.dom.pulldom.PullDom + name: PullDom + uid: xml.dom.pulldom.PullDom +- fullName: xml.dom.pulldom.SAX2DOM + href: https://docs.python.org/3/library/xml.dom.pulldom.html#xml.dom.pulldom.SAX2DOM + name: SAX2DOM + uid: xml.dom.pulldom.SAX2DOM +- fullName: xml.etree.ElementTree.C14NWriterTarget + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.C14NWriterTarget + name: C14NWriterTarget + uid: xml.etree.ElementTree.C14NWriterTarget +- fullName: xml.etree.ElementTree.Element + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element + name: Element + uid: xml.etree.ElementTree.Element +- fullName: xml.etree.ElementTree.ElementTree + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.ElementTree + name: ElementTree + uid: xml.etree.ElementTree.ElementTree +- fullName: xml.etree.ElementTree.ParseError + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.ParseError + name: ParseError + uid: xml.etree.ElementTree.ParseError +- fullName: xml.etree.ElementTree.QName + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.QName + name: QName + uid: xml.etree.ElementTree.QName +- fullName: xml.etree.ElementTree.TreeBuilder + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.TreeBuilder + name: TreeBuilder + uid: xml.etree.ElementTree.TreeBuilder +- fullName: xml.etree.ElementTree.XMLParser + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLParser + name: XMLParser + uid: xml.etree.ElementTree.XMLParser +- fullName: xml.etree.ElementTree.XMLPullParser + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLPullParser + name: XMLPullParser + uid: xml.etree.ElementTree.XMLPullParser +- fullName: xml.sax.handler.ContentHandler + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.ContentHandler + name: ContentHandler + uid: xml.sax.handler.ContentHandler +- fullName: xml.sax.handler.DTDHandler + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.DTDHandler + name: DTDHandler + uid: xml.sax.handler.DTDHandler +- fullName: xml.sax.handler.EntityResolver + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.EntityResolver + name: EntityResolver + uid: xml.sax.handler.EntityResolver +- fullName: xml.sax.handler.ErrorHandler + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.ErrorHandler + name: ErrorHandler + uid: xml.sax.handler.ErrorHandler +- fullName: xml.sax.handler.LexicalHandler + href: https://docs.python.org/3/library/xml.sax.handler.html#xml.sax.handler.LexicalHandler + name: LexicalHandler + uid: xml.sax.handler.LexicalHandler +- fullName: xml.sax.saxutils.XMLFilterBase + href: https://docs.python.org/3/library/xml.sax.utils.html#xml.sax.saxutils.XMLFilterBase + name: XMLFilterBase + uid: xml.sax.saxutils.XMLFilterBase +- fullName: xml.sax.saxutils.XMLGenerator + href: https://docs.python.org/3/library/xml.sax.utils.html#xml.sax.saxutils.XMLGenerator + name: XMLGenerator + uid: xml.sax.saxutils.XMLGenerator +- fullName: xml.sax.xmlreader.AttributesImpl + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.AttributesImpl + name: AttributesImpl + uid: xml.sax.xmlreader.AttributesImpl +- fullName: xml.sax.xmlreader.AttributesNSImpl + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.AttributesNSImpl + name: AttributesNSImpl + uid: xml.sax.xmlreader.AttributesNSImpl +- fullName: xml.sax.xmlreader.IncrementalParser + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.IncrementalParser + name: IncrementalParser + uid: xml.sax.xmlreader.IncrementalParser +- fullName: xml.sax.xmlreader.InputSource + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.InputSource + name: InputSource + uid: xml.sax.xmlreader.InputSource +- fullName: xml.sax.xmlreader.Locator + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.Locator + name: Locator + uid: xml.sax.xmlreader.Locator +- fullName: xml.sax.xmlreader.XMLReader + href: https://docs.python.org/3/library/xml.sax.reader.html#xml.sax.xmlreader.XMLReader + name: XMLReader + uid: xml.sax.xmlreader.XMLReader +- fullName: xmlrpc.client.Binary + href: https://docs.python.org/3/library/xmlrpc.client.html#xmlrpc.client.Binary + name: Binary + uid: xmlrpc.client.Binary +- fullName: xmlrpc.client.DateTime + href: https://docs.python.org/3/library/xmlrpc.client.html#xmlrpc.client.DateTime + name: DateTime + uid: xmlrpc.client.DateTime +- fullName: xmlrpc.client.Fault + href: https://docs.python.org/3/library/xmlrpc.client.html#xmlrpc.client.Fault + name: Fault + uid: xmlrpc.client.Fault +- fullName: xmlrpc.client.MultiCall + href: https://docs.python.org/3/library/xmlrpc.client.html#xmlrpc.client.MultiCall + name: MultiCall + uid: xmlrpc.client.MultiCall +- fullName: xmlrpc.client.ProtocolError + href: https://docs.python.org/3/library/xmlrpc.client.html#xmlrpc.client.ProtocolError + name: ProtocolError + uid: xmlrpc.client.ProtocolError +- fullName: xmlrpc.client.ServerProxy + href: https://docs.python.org/3/library/xmlrpc.client.html#xmlrpc.client.ServerProxy + name: ServerProxy + uid: xmlrpc.client.ServerProxy +- fullName: xmlrpc.server.CGIXMLRPCRequestHandler + href: https://docs.python.org/3/library/xmlrpc.server.html#xmlrpc.server.CGIXMLRPCRequestHandler + name: CGIXMLRPCRequestHandler + uid: xmlrpc.server.CGIXMLRPCRequestHandler +- fullName: xmlrpc.server.DocCGIXMLRPCRequestHandler + href: https://docs.python.org/3/library/xmlrpc.server.html#xmlrpc.server.DocCGIXMLRPCRequestHandler + name: DocCGIXMLRPCRequestHandler + uid: xmlrpc.server.DocCGIXMLRPCRequestHandler +- fullName: xmlrpc.server.DocXMLRPCRequestHandler + href: https://docs.python.org/3/library/xmlrpc.server.html#xmlrpc.server.DocXMLRPCRequestHandler + name: DocXMLRPCRequestHandler + uid: xmlrpc.server.DocXMLRPCRequestHandler +- fullName: xmlrpc.server.DocXMLRPCServer + href: https://docs.python.org/3/library/xmlrpc.server.html#xmlrpc.server.DocXMLRPCServer + name: DocXMLRPCServer + uid: xmlrpc.server.DocXMLRPCServer +- fullName: xmlrpc.server.SimpleXMLRPCRequestHandler + href: https://docs.python.org/3/library/xmlrpc.server.html#xmlrpc.server.SimpleXMLRPCRequestHandler + name: SimpleXMLRPCRequestHandler + uid: xmlrpc.server.SimpleXMLRPCRequestHandler +- fullName: xmlrpc.server.SimpleXMLRPCServer + href: https://docs.python.org/3/library/xmlrpc.server.html#xmlrpc.server.SimpleXMLRPCServer + name: SimpleXMLRPCServer + uid: xmlrpc.server.SimpleXMLRPCServer +- fullName: zipfile.Path + href: https://docs.python.org/3/library/zipfile.html#zipfile.Path + name: Path + uid: zipfile.Path +- fullName: zipfile.PyZipFile + href: https://docs.python.org/3/library/zipfile.html#zipfile.PyZipFile + name: PyZipFile + uid: zipfile.PyZipFile +- fullName: zipfile.ZipFile + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipFile + name: ZipFile + uid: zipfile.ZipFile +- fullName: zipfile.ZipInfo + href: https://docs.python.org/3/library/zipfile.html#zipfile.ZipInfo + name: ZipInfo + uid: zipfile.ZipInfo +- fullName: zipimport.zipimporter + href: https://docs.python.org/3/library/zipimport.html#zipimport.zipimporter + name: zipimporter + uid: zipimport.zipimporter +- fullName: zoneinfo.ZoneInfo + href: https://docs.python.org/3/library/zoneinfo.html#zoneinfo.ZoneInfo + name: ZoneInfo + uid: zoneinfo.ZoneInfo +- fullName: __import__ + href: https://docs.python.org/3/library/functions.html#import__ + name: __import__ + uid: __import__ +- fullName: _thread.allocate_lock + href: https://docs.python.org/3/library/_thread.html#thread.allocate_lock + name: allocate_lock + uid: _thread.allocate_lock +- fullName: _thread.exit + href: https://docs.python.org/3/library/_thread.html#thread.exit + name: exit + uid: _thread.exit +- fullName: _thread.get_ident + href: https://docs.python.org/3/library/_thread.html#thread.get_ident + name: get_ident + uid: _thread.get_ident +- fullName: _thread.get_native_id + href: https://docs.python.org/3/library/_thread.html#thread.get_native_id + name: get_native_id + uid: _thread.get_native_id +- fullName: _thread.interrupt_main + href: https://docs.python.org/3/library/_thread.html#thread.interrupt_main + name: interrupt_main + uid: _thread.interrupt_main +- fullName: _thread.stack_size + href: https://docs.python.org/3/library/_thread.html#thread.stack_size + name: stack_size + uid: _thread.stack_size +- fullName: _thread.start_new_thread + href: https://docs.python.org/3/library/_thread.html#thread.start_new_thread + name: start_new_thread + uid: _thread.start_new_thread +- fullName: abc.abstractclassmethod + href: https://docs.python.org/3/library/abc.html#abc.abstractclassmethod + name: abstractclassmethod + uid: abc.abstractclassmethod +- fullName: abc.abstractmethod + href: https://docs.python.org/3/library/abc.html#abc.abstractmethod + name: abstractmethod + uid: abc.abstractmethod +- fullName: abc.abstractproperty + href: https://docs.python.org/3/library/abc.html#abc.abstractproperty + name: abstractproperty + uid: abc.abstractproperty +- fullName: abc.abstractstaticmethod + href: https://docs.python.org/3/library/abc.html#abc.abstractstaticmethod + name: abstractstaticmethod + uid: abc.abstractstaticmethod +- fullName: abc.get_cache_token + href: https://docs.python.org/3/library/abc.html#abc.get_cache_token + name: get_cache_token + uid: abc.get_cache_token +- fullName: abc.update_abstractmethods + href: https://docs.python.org/3/library/abc.html#abc.update_abstractmethods + name: update_abstractmethods + uid: abc.update_abstractmethods +- fullName: abs + href: https://docs.python.org/3/library/functions.html#abs + name: abs + uid: abs +- fullName: aiter + href: https://docs.python.org/3/library/functions.html#aiter + name: aiter + uid: aiter +- fullName: all + href: https://docs.python.org/3/library/functions.html#all + name: all + uid: all +- fullName: anext + href: https://docs.python.org/3/library/functions.html#anext + name: anext + uid: anext +- fullName: any + href: https://docs.python.org/3/library/functions.html#any + name: any + uid: any +- fullName: ascii + href: https://docs.python.org/3/library/functions.html#ascii + name: ascii + uid: ascii +- fullName: ast.copy_location + href: https://docs.python.org/3/library/ast.html#ast.copy_location + name: copy_location + uid: ast.copy_location +- fullName: ast.dump + href: https://docs.python.org/3/library/ast.html#ast.dump + name: dump + uid: ast.dump +- fullName: ast.fix_missing_locations + href: https://docs.python.org/3/library/ast.html#ast.fix_missing_locations + name: fix_missing_locations + uid: ast.fix_missing_locations +- fullName: ast.get_docstring + href: https://docs.python.org/3/library/ast.html#ast.get_docstring + name: get_docstring + uid: ast.get_docstring +- fullName: ast.get_source_segment + href: https://docs.python.org/3/library/ast.html#ast.get_source_segment + name: get_source_segment + uid: ast.get_source_segment +- fullName: ast.increment_lineno + href: https://docs.python.org/3/library/ast.html#ast.increment_lineno + name: increment_lineno + uid: ast.increment_lineno +- fullName: ast.iter_child_nodes + href: https://docs.python.org/3/library/ast.html#ast.iter_child_nodes + name: iter_child_nodes + uid: ast.iter_child_nodes +- fullName: ast.iter_fields + href: https://docs.python.org/3/library/ast.html#ast.iter_fields + name: iter_fields + uid: ast.iter_fields +- fullName: ast.literal_eval + href: https://docs.python.org/3/library/ast.html#ast.literal_eval + name: literal_eval + uid: ast.literal_eval +- fullName: ast.parse + href: https://docs.python.org/3/library/ast.html#ast.parse + name: parse + uid: ast.parse +- fullName: ast.unparse + href: https://docs.python.org/3/library/ast.html#ast.unparse + name: unparse + uid: ast.unparse +- fullName: ast.walk + href: https://docs.python.org/3/library/ast.html#ast.walk + name: walk + uid: ast.walk +- fullName: asyncio._enter_task + href: https://docs.python.org/3/library/asyncio-extending.html#asyncio._enter_task + name: _enter_task + uid: asyncio._enter_task +- fullName: asyncio._leave_task + href: https://docs.python.org/3/library/asyncio-extending.html#asyncio._leave_task + name: _leave_task + uid: asyncio._leave_task +- fullName: asyncio._register_task + href: https://docs.python.org/3/library/asyncio-extending.html#asyncio._register_task + name: _register_task + uid: asyncio._register_task +- fullName: asyncio._unregister_task + href: https://docs.python.org/3/library/asyncio-extending.html#asyncio._unregister_task + name: _unregister_task + uid: asyncio._unregister_task +- fullName: asyncio.all_tasks + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.all_tasks + name: all_tasks + uid: asyncio.all_tasks +- fullName: asyncio.as_completed + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.as_completed + name: as_completed + uid: asyncio.as_completed +- fullName: asyncio.create_eager_task_factory + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.create_eager_task_factory + name: create_eager_task_factory + uid: asyncio.create_eager_task_factory +- fullName: asyncio.create_subprocess_exec + href: https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.create_subprocess_exec + name: create_subprocess_exec + uid: asyncio.create_subprocess_exec +- fullName: asyncio.create_subprocess_shell + href: https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.create_subprocess_shell + name: create_subprocess_shell + uid: asyncio.create_subprocess_shell +- fullName: asyncio.create_task + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.create_task + name: create_task + uid: asyncio.create_task +- fullName: asyncio.current_task + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.current_task + name: current_task + uid: asyncio.current_task +- fullName: asyncio.eager_task_factory + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.eager_task_factory + name: eager_task_factory + uid: asyncio.eager_task_factory +- fullName: asyncio.ensure_future + href: https://docs.python.org/3/library/asyncio-future.html#asyncio.ensure_future + name: ensure_future + uid: asyncio.ensure_future +- fullName: asyncio.gather + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.gather + name: gather + uid: asyncio.gather +- fullName: asyncio.get_child_watcher + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.get_child_watcher + name: get_child_watcher + uid: asyncio.get_child_watcher +- fullName: asyncio.get_event_loop + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.get_event_loop + name: get_event_loop + uid: asyncio.get_event_loop +- fullName: asyncio.get_event_loop_policy + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.get_event_loop_policy + name: get_event_loop_policy + uid: asyncio.get_event_loop_policy +- fullName: asyncio.get_running_loop + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.get_running_loop + name: get_running_loop + uid: asyncio.get_running_loop +- fullName: asyncio.iscoroutine + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.iscoroutine + name: iscoroutine + uid: asyncio.iscoroutine +- fullName: asyncio.isfuture + href: https://docs.python.org/3/library/asyncio-future.html#asyncio.isfuture + name: isfuture + uid: asyncio.isfuture +- fullName: asyncio.new_event_loop + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.new_event_loop + name: new_event_loop + uid: asyncio.new_event_loop +- fullName: asyncio.open_connection + href: https://docs.python.org/3/library/asyncio-stream.html#asyncio.open_connection + name: open_connection + uid: asyncio.open_connection +- fullName: asyncio.open_unix_connection + href: https://docs.python.org/3/library/asyncio-stream.html#asyncio.open_unix_connection + name: open_unix_connection + uid: asyncio.open_unix_connection +- fullName: asyncio.run + href: https://docs.python.org/3/library/asyncio-runner.html#asyncio.run + name: run + uid: asyncio.run +- fullName: asyncio.run_coroutine_threadsafe + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.run_coroutine_threadsafe + name: run_coroutine_threadsafe + uid: asyncio.run_coroutine_threadsafe +- fullName: asyncio.set_child_watcher + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.set_child_watcher + name: set_child_watcher + uid: asyncio.set_child_watcher +- fullName: asyncio.set_event_loop + href: https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.set_event_loop + name: set_event_loop + uid: asyncio.set_event_loop +- fullName: asyncio.set_event_loop_policy + href: https://docs.python.org/3/library/asyncio-policy.html#asyncio.set_event_loop_policy + name: set_event_loop_policy + uid: asyncio.set_event_loop_policy +- fullName: asyncio.shield + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.shield + name: shield + uid: asyncio.shield +- fullName: asyncio.sleep + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.sleep + name: sleep + uid: asyncio.sleep +- fullName: asyncio.start_server + href: https://docs.python.org/3/library/asyncio-stream.html#asyncio.start_server + name: start_server + uid: asyncio.start_server +- fullName: asyncio.start_unix_server + href: https://docs.python.org/3/library/asyncio-stream.html#asyncio.start_unix_server + name: start_unix_server + uid: asyncio.start_unix_server +- fullName: asyncio.timeout + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.timeout + name: timeout + uid: asyncio.timeout +- fullName: asyncio.timeout_at + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.timeout_at + name: timeout_at + uid: asyncio.timeout_at +- fullName: asyncio.to_thread + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.to_thread + name: to_thread + uid: asyncio.to_thread +- fullName: asyncio.wait + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.wait + name: wait + uid: asyncio.wait +- fullName: asyncio.wait_for + href: https://docs.python.org/3/library/asyncio-task.html#asyncio.wait_for + name: wait_for + uid: asyncio.wait_for +- fullName: asyncio.wrap_future + href: https://docs.python.org/3/library/asyncio-future.html#asyncio.wrap_future + name: wrap_future + uid: asyncio.wrap_future +- fullName: atexit.register + href: https://docs.python.org/3/library/atexit.html#atexit.register + name: register + uid: atexit.register +- fullName: atexit.unregister + href: https://docs.python.org/3/library/atexit.html#atexit.unregister + name: unregister + uid: atexit.unregister +- fullName: base64.a85decode + href: https://docs.python.org/3/library/base64.html#base64.a85decode + name: a85decode + uid: base64.a85decode +- fullName: base64.a85encode + href: https://docs.python.org/3/library/base64.html#base64.a85encode + name: a85encode + uid: base64.a85encode +- fullName: base64.b16decode + href: https://docs.python.org/3/library/base64.html#base64.b16decode + name: b16decode + uid: base64.b16decode +- fullName: base64.b16encode + href: https://docs.python.org/3/library/base64.html#base64.b16encode + name: b16encode + uid: base64.b16encode +- fullName: base64.b32decode + href: https://docs.python.org/3/library/base64.html#base64.b32decode + name: b32decode + uid: base64.b32decode +- fullName: base64.b32encode + href: https://docs.python.org/3/library/base64.html#base64.b32encode + name: b32encode + uid: base64.b32encode +- fullName: base64.b32hexdecode + href: https://docs.python.org/3/library/base64.html#base64.b32hexdecode + name: b32hexdecode + uid: base64.b32hexdecode +- fullName: base64.b32hexencode + href: https://docs.python.org/3/library/base64.html#base64.b32hexencode + name: b32hexencode + uid: base64.b32hexencode +- fullName: base64.b64decode + href: https://docs.python.org/3/library/base64.html#base64.b64decode + name: b64decode + uid: base64.b64decode +- fullName: base64.b64encode + href: https://docs.python.org/3/library/base64.html#base64.b64encode + name: b64encode + uid: base64.b64encode +- fullName: base64.b85decode + href: https://docs.python.org/3/library/base64.html#base64.b85decode + name: b85decode + uid: base64.b85decode +- fullName: base64.b85encode + href: https://docs.python.org/3/library/base64.html#base64.b85encode + name: b85encode + uid: base64.b85encode +- fullName: base64.decode + href: https://docs.python.org/3/library/base64.html#base64.decode + name: decode + uid: base64.decode +- fullName: base64.decodebytes + href: https://docs.python.org/3/library/base64.html#base64.decodebytes + name: decodebytes + uid: base64.decodebytes +- fullName: base64.encode + href: https://docs.python.org/3/library/base64.html#base64.encode + name: encode + uid: base64.encode +- fullName: base64.encodebytes + href: https://docs.python.org/3/library/base64.html#base64.encodebytes + name: encodebytes + uid: base64.encodebytes +- fullName: base64.standard_b64decode + href: https://docs.python.org/3/library/base64.html#base64.standard_b64decode + name: standard_b64decode + uid: base64.standard_b64decode +- fullName: base64.standard_b64encode + href: https://docs.python.org/3/library/base64.html#base64.standard_b64encode + name: standard_b64encode + uid: base64.standard_b64encode +- fullName: base64.urlsafe_b64decode + href: https://docs.python.org/3/library/base64.html#base64.urlsafe_b64decode + name: urlsafe_b64decode + uid: base64.urlsafe_b64decode +- fullName: base64.urlsafe_b64encode + href: https://docs.python.org/3/library/base64.html#base64.urlsafe_b64encode + name: urlsafe_b64encode + uid: base64.urlsafe_b64encode +- fullName: base64.z85decode + href: https://docs.python.org/3/library/base64.html#base64.z85decode + name: z85decode + uid: base64.z85decode +- fullName: base64.z85encode + href: https://docs.python.org/3/library/base64.html#base64.z85encode + name: z85encode + uid: base64.z85encode +- fullName: bdb.checkfuncname + href: https://docs.python.org/3/library/bdb.html#bdb.checkfuncname + name: checkfuncname + uid: bdb.checkfuncname +- fullName: bdb.effective + href: https://docs.python.org/3/library/bdb.html#bdb.effective + name: effective + uid: bdb.effective +- fullName: bdb.set_trace + href: https://docs.python.org/3/library/bdb.html#bdb.set_trace + name: set_trace + uid: bdb.set_trace +- fullName: bin + href: https://docs.python.org/3/library/functions.html#bin + name: bin + uid: bin +- fullName: binascii.a2b_base64 + href: https://docs.python.org/3/library/binascii.html#binascii.a2b_base64 + name: a2b_base64 + uid: binascii.a2b_base64 +- fullName: binascii.a2b_hex + href: https://docs.python.org/3/library/binascii.html#binascii.a2b_hex + name: a2b_hex + uid: binascii.a2b_hex +- fullName: binascii.a2b_qp + href: https://docs.python.org/3/library/binascii.html#binascii.a2b_qp + name: a2b_qp + uid: binascii.a2b_qp +- fullName: binascii.a2b_uu + href: https://docs.python.org/3/library/binascii.html#binascii.a2b_uu + name: a2b_uu + uid: binascii.a2b_uu +- fullName: binascii.b2a_base64 + href: https://docs.python.org/3/library/binascii.html#binascii.b2a_base64 + name: b2a_base64 + uid: binascii.b2a_base64 +- fullName: binascii.b2a_hex + href: https://docs.python.org/3/library/binascii.html#binascii.b2a_hex + name: b2a_hex + uid: binascii.b2a_hex +- fullName: binascii.b2a_qp + href: https://docs.python.org/3/library/binascii.html#binascii.b2a_qp + name: b2a_qp + uid: binascii.b2a_qp +- fullName: binascii.b2a_uu + href: https://docs.python.org/3/library/binascii.html#binascii.b2a_uu + name: b2a_uu + uid: binascii.b2a_uu +- fullName: binascii.crc32 + href: https://docs.python.org/3/library/binascii.html#binascii.crc32 + name: crc32 + uid: binascii.crc32 +- fullName: binascii.crc_hqx + href: https://docs.python.org/3/library/binascii.html#binascii.crc_hqx + name: crc_hqx + uid: binascii.crc_hqx +- fullName: binascii.hexlify + href: https://docs.python.org/3/library/binascii.html#binascii.hexlify + name: hexlify + uid: binascii.hexlify +- fullName: binascii.unhexlify + href: https://docs.python.org/3/library/binascii.html#binascii.unhexlify + name: unhexlify + uid: binascii.unhexlify +- fullName: bisect.bisect + href: https://docs.python.org/3/library/bisect.html#bisect.bisect + name: bisect + uid: bisect.bisect +- fullName: bisect.bisect_left + href: https://docs.python.org/3/library/bisect.html#bisect.bisect_left + name: bisect_left + uid: bisect.bisect_left +- fullName: bisect.bisect_right + href: https://docs.python.org/3/library/bisect.html#bisect.bisect_right + name: bisect_right + uid: bisect.bisect_right +- fullName: bisect.insort + href: https://docs.python.org/3/library/bisect.html#bisect.insort + name: insort + uid: bisect.insort +- fullName: bisect.insort_left + href: https://docs.python.org/3/library/bisect.html#bisect.insort_left + name: insort_left + uid: bisect.insort_left +- fullName: bisect.insort_right + href: https://docs.python.org/3/library/bisect.html#bisect.insort_right + name: insort_right + uid: bisect.insort_right +- fullName: breakpoint + href: https://docs.python.org/3/library/functions.html#breakpoint + name: breakpoint + uid: breakpoint +- fullName: bz2.compress + href: https://docs.python.org/3/library/bz2.html#bz2.compress + name: compress + uid: bz2.compress +- fullName: bz2.decompress + href: https://docs.python.org/3/library/bz2.html#bz2.decompress + name: decompress + uid: bz2.decompress +- fullName: bz2.open + href: https://docs.python.org/3/library/bz2.html#bz2.open + name: open + uid: bz2.open +- fullName: calendar.calendar + href: https://docs.python.org/3/library/calendar.html#calendar.calendar + name: calendar + uid: calendar.calendar +- fullName: calendar.firstweekday + href: https://docs.python.org/3/library/calendar.html#calendar.firstweekday + name: firstweekday + uid: calendar.firstweekday +- fullName: calendar.isleap + href: https://docs.python.org/3/library/calendar.html#calendar.isleap + name: isleap + uid: calendar.isleap +- fullName: calendar.leapdays + href: https://docs.python.org/3/library/calendar.html#calendar.leapdays + name: leapdays + uid: calendar.leapdays +- fullName: calendar.month + href: https://docs.python.org/3/library/calendar.html#calendar.month + name: month + uid: calendar.month +- fullName: calendar.monthcalendar + href: https://docs.python.org/3/library/calendar.html#calendar.monthcalendar + name: monthcalendar + uid: calendar.monthcalendar +- fullName: calendar.monthrange + href: https://docs.python.org/3/library/calendar.html#calendar.monthrange + name: monthrange + uid: calendar.monthrange +- fullName: calendar.prcal + href: https://docs.python.org/3/library/calendar.html#calendar.prcal + name: prcal + uid: calendar.prcal +- fullName: calendar.prmonth + href: https://docs.python.org/3/library/calendar.html#calendar.prmonth + name: prmonth + uid: calendar.prmonth +- fullName: calendar.setfirstweekday + href: https://docs.python.org/3/library/calendar.html#calendar.setfirstweekday + name: setfirstweekday + uid: calendar.setfirstweekday +- fullName: calendar.timegm + href: https://docs.python.org/3/library/calendar.html#calendar.timegm + name: timegm + uid: calendar.timegm +- fullName: calendar.weekday + href: https://docs.python.org/3/library/calendar.html#calendar.weekday + name: weekday + uid: calendar.weekday +- fullName: calendar.weekheader + href: https://docs.python.org/3/library/calendar.html#calendar.weekheader + name: weekheader + uid: calendar.weekheader +- fullName: callable + href: https://docs.python.org/3/library/functions.html#callable + name: callable + uid: callable +- fullName: chr + href: https://docs.python.org/3/library/functions.html#chr + name: chr + uid: chr +- fullName: classmethod + href: https://docs.python.org/3/library/functions.html#classmethod + name: classmethod + uid: classmethod +- fullName: cmath.acos + href: https://docs.python.org/3/library/cmath.html#cmath.acos + name: acos + uid: cmath.acos +- fullName: cmath.acosh + href: https://docs.python.org/3/library/cmath.html#cmath.acosh + name: acosh + uid: cmath.acosh +- fullName: cmath.asin + href: https://docs.python.org/3/library/cmath.html#cmath.asin + name: asin + uid: cmath.asin +- fullName: cmath.asinh + href: https://docs.python.org/3/library/cmath.html#cmath.asinh + name: asinh + uid: cmath.asinh +- fullName: cmath.atan + href: https://docs.python.org/3/library/cmath.html#cmath.atan + name: atan + uid: cmath.atan +- fullName: cmath.atanh + href: https://docs.python.org/3/library/cmath.html#cmath.atanh + name: atanh + uid: cmath.atanh +- fullName: cmath.cos + href: https://docs.python.org/3/library/cmath.html#cmath.cos + name: cos + uid: cmath.cos +- fullName: cmath.cosh + href: https://docs.python.org/3/library/cmath.html#cmath.cosh + name: cosh + uid: cmath.cosh +- fullName: cmath.exp + href: https://docs.python.org/3/library/cmath.html#cmath.exp + name: exp + uid: cmath.exp +- fullName: cmath.isclose + href: https://docs.python.org/3/library/cmath.html#cmath.isclose + name: isclose + uid: cmath.isclose +- fullName: cmath.isfinite + href: https://docs.python.org/3/library/cmath.html#cmath.isfinite + name: isfinite + uid: cmath.isfinite +- fullName: cmath.isinf + href: https://docs.python.org/3/library/cmath.html#cmath.isinf + name: isinf + uid: cmath.isinf +- fullName: cmath.isnan + href: https://docs.python.org/3/library/cmath.html#cmath.isnan + name: isnan + uid: cmath.isnan +- fullName: cmath.log + href: https://docs.python.org/3/library/cmath.html#cmath.log + name: log + uid: cmath.log +- fullName: cmath.log10 + href: https://docs.python.org/3/library/cmath.html#cmath.log10 + name: log10 + uid: cmath.log10 +- fullName: cmath.phase + href: https://docs.python.org/3/library/cmath.html#cmath.phase + name: phase + uid: cmath.phase +- fullName: cmath.polar + href: https://docs.python.org/3/library/cmath.html#cmath.polar + name: polar + uid: cmath.polar +- fullName: cmath.rect + href: https://docs.python.org/3/library/cmath.html#cmath.rect + name: rect + uid: cmath.rect +- fullName: cmath.sin + href: https://docs.python.org/3/library/cmath.html#cmath.sin + name: sin + uid: cmath.sin +- fullName: cmath.sinh + href: https://docs.python.org/3/library/cmath.html#cmath.sinh + name: sinh + uid: cmath.sinh +- fullName: cmath.sqrt + href: https://docs.python.org/3/library/cmath.html#cmath.sqrt + name: sqrt + uid: cmath.sqrt +- fullName: cmath.tan + href: https://docs.python.org/3/library/cmath.html#cmath.tan + name: tan + uid: cmath.tan +- fullName: cmath.tanh + href: https://docs.python.org/3/library/cmath.html#cmath.tanh + name: tanh + uid: cmath.tanh +- fullName: code.compile_command + href: https://docs.python.org/3/library/code.html#code.compile_command + name: compile_command + uid: code.compile_command +- fullName: code.interact + href: https://docs.python.org/3/library/code.html#code.interact + name: interact + uid: code.interact +- fullName: codecs.EncodedFile + href: https://docs.python.org/3/library/codecs.html#codecs.EncodedFile + name: EncodedFile + uid: codecs.EncodedFile +- fullName: codecs.backslashreplace_errors + href: https://docs.python.org/3/library/codecs.html#codecs.backslashreplace_errors + name: backslashreplace_errors + uid: codecs.backslashreplace_errors +- fullName: codecs.decode + href: https://docs.python.org/3/library/codecs.html#codecs.decode + name: decode + uid: codecs.decode +- fullName: codecs.encode + href: https://docs.python.org/3/library/codecs.html#codecs.encode + name: encode + uid: codecs.encode +- fullName: codecs.getdecoder + href: https://docs.python.org/3/library/codecs.html#codecs.getdecoder + name: getdecoder + uid: codecs.getdecoder +- fullName: codecs.getencoder + href: https://docs.python.org/3/library/codecs.html#codecs.getencoder + name: getencoder + uid: codecs.getencoder +- fullName: codecs.getincrementaldecoder + href: https://docs.python.org/3/library/codecs.html#codecs.getincrementaldecoder + name: getincrementaldecoder + uid: codecs.getincrementaldecoder +- fullName: codecs.getincrementalencoder + href: https://docs.python.org/3/library/codecs.html#codecs.getincrementalencoder + name: getincrementalencoder + uid: codecs.getincrementalencoder +- fullName: codecs.getreader + href: https://docs.python.org/3/library/codecs.html#codecs.getreader + name: getreader + uid: codecs.getreader +- fullName: codecs.getwriter + href: https://docs.python.org/3/library/codecs.html#codecs.getwriter + name: getwriter + uid: codecs.getwriter +- fullName: codecs.ignore_errors + href: https://docs.python.org/3/library/codecs.html#codecs.ignore_errors + name: ignore_errors + uid: codecs.ignore_errors +- fullName: codecs.iterdecode + href: https://docs.python.org/3/library/codecs.html#codecs.iterdecode + name: iterdecode + uid: codecs.iterdecode +- fullName: codecs.iterencode + href: https://docs.python.org/3/library/codecs.html#codecs.iterencode + name: iterencode + uid: codecs.iterencode +- fullName: codecs.lookup + href: https://docs.python.org/3/library/codecs.html#codecs.lookup + name: lookup + uid: codecs.lookup +- fullName: codecs.lookup_error + href: https://docs.python.org/3/library/codecs.html#codecs.lookup_error + name: lookup_error + uid: codecs.lookup_error +- fullName: codecs.namereplace_errors + href: https://docs.python.org/3/library/codecs.html#codecs.namereplace_errors + name: namereplace_errors + uid: codecs.namereplace_errors +- fullName: codecs.open + href: https://docs.python.org/3/library/codecs.html#codecs.open + name: open + uid: codecs.open +- fullName: codecs.register + href: https://docs.python.org/3/library/codecs.html#codecs.register + name: register + uid: codecs.register +- fullName: codecs.register_error + href: https://docs.python.org/3/library/codecs.html#codecs.register_error + name: register_error + uid: codecs.register_error +- fullName: codecs.replace_errors + href: https://docs.python.org/3/library/codecs.html#codecs.replace_errors + name: replace_errors + uid: codecs.replace_errors +- fullName: codecs.strict_errors + href: https://docs.python.org/3/library/codecs.html#codecs.strict_errors + name: strict_errors + uid: codecs.strict_errors +- fullName: codecs.unregister + href: https://docs.python.org/3/library/codecs.html#codecs.unregister + name: unregister + uid: codecs.unregister +- fullName: codecs.xmlcharrefreplace_errors + href: https://docs.python.org/3/library/codecs.html#codecs.xmlcharrefreplace_errors + name: xmlcharrefreplace_errors + uid: codecs.xmlcharrefreplace_errors +- fullName: codeop.compile_command + href: https://docs.python.org/3/library/codeop.html#codeop.compile_command + name: compile_command + uid: codeop.compile_command +- fullName: collections.namedtuple + href: https://docs.python.org/3/library/collections.html#collections.namedtuple + name: namedtuple + uid: collections.namedtuple +- fullName: colorsys.hls_to_rgb + href: https://docs.python.org/3/library/colorsys.html#colorsys.hls_to_rgb + name: hls_to_rgb + uid: colorsys.hls_to_rgb +- fullName: colorsys.hsv_to_rgb + href: https://docs.python.org/3/library/colorsys.html#colorsys.hsv_to_rgb + name: hsv_to_rgb + uid: colorsys.hsv_to_rgb +- fullName: colorsys.rgb_to_hls + href: https://docs.python.org/3/library/colorsys.html#colorsys.rgb_to_hls + name: rgb_to_hls + uid: colorsys.rgb_to_hls +- fullName: colorsys.rgb_to_hsv + href: https://docs.python.org/3/library/colorsys.html#colorsys.rgb_to_hsv + name: rgb_to_hsv + uid: colorsys.rgb_to_hsv +- fullName: colorsys.rgb_to_yiq + href: https://docs.python.org/3/library/colorsys.html#colorsys.rgb_to_yiq + name: rgb_to_yiq + uid: colorsys.rgb_to_yiq +- fullName: colorsys.yiq_to_rgb + href: https://docs.python.org/3/library/colorsys.html#colorsys.yiq_to_rgb + name: yiq_to_rgb + uid: colorsys.yiq_to_rgb +- fullName: compile + href: https://docs.python.org/3/library/functions.html#compile + name: compile + uid: compile +- fullName: compileall.compile_dir + href: https://docs.python.org/3/library/compileall.html#compileall.compile_dir + name: compile_dir + uid: compileall.compile_dir +- fullName: compileall.compile_file + href: https://docs.python.org/3/library/compileall.html#compileall.compile_file + name: compile_file + uid: compileall.compile_file +- fullName: compileall.compile_path + href: https://docs.python.org/3/library/compileall.html#compileall.compile_path + name: compile_path + uid: compileall.compile_path +- fullName: concurrent.futures.as_completed + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.as_completed + name: as_completed + uid: concurrent.futures.as_completed +- fullName: concurrent.futures.wait + href: https://docs.python.org/3/library/concurrent.futures.html#concurrent.futures.wait + name: wait + uid: concurrent.futures.wait +- fullName: contextlib.aclosing + href: https://docs.python.org/3/library/contextlib.html#contextlib.aclosing + name: aclosing + uid: contextlib.aclosing +- fullName: contextlib.asynccontextmanager + href: https://docs.python.org/3/library/contextlib.html#contextlib.asynccontextmanager + name: asynccontextmanager + uid: contextlib.asynccontextmanager +- fullName: contextlib.chdir + href: https://docs.python.org/3/library/contextlib.html#contextlib.chdir + name: chdir + uid: contextlib.chdir +- fullName: contextlib.closing + href: https://docs.python.org/3/library/contextlib.html#contextlib.closing + name: closing + uid: contextlib.closing +- fullName: contextlib.contextmanager + href: https://docs.python.org/3/library/contextlib.html#contextlib.contextmanager + name: contextmanager + uid: contextlib.contextmanager +- fullName: contextlib.nullcontext + href: https://docs.python.org/3/library/contextlib.html#contextlib.nullcontext + name: nullcontext + uid: contextlib.nullcontext +- fullName: contextlib.redirect_stderr + href: https://docs.python.org/3/library/contextlib.html#contextlib.redirect_stderr + name: redirect_stderr + uid: contextlib.redirect_stderr +- fullName: contextlib.redirect_stdout + href: https://docs.python.org/3/library/contextlib.html#contextlib.redirect_stdout + name: redirect_stdout + uid: contextlib.redirect_stdout +- fullName: contextlib.suppress + href: https://docs.python.org/3/library/contextlib.html#contextlib.suppress + name: suppress + uid: contextlib.suppress +- fullName: contextvars.copy_context + href: https://docs.python.org/3/library/contextvars.html#contextvars.copy_context + name: copy_context + uid: contextvars.copy_context +- fullName: copy.copy + href: https://docs.python.org/3/library/copy.html#copy.copy + name: copy + uid: copy.copy +- fullName: copy.deepcopy + href: https://docs.python.org/3/library/copy.html#copy.deepcopy + name: deepcopy + uid: copy.deepcopy +- fullName: copy.replace + href: https://docs.python.org/3/library/copy.html#copy.replace + name: replace + uid: copy.replace +- fullName: copyreg.constructor + href: https://docs.python.org/3/library/copyreg.html#copyreg.constructor + name: constructor + uid: copyreg.constructor +- fullName: copyreg.pickle + href: https://docs.python.org/3/library/copyreg.html#copyreg.pickle + name: pickle + uid: copyreg.pickle +- fullName: csv.field_size_limit + href: https://docs.python.org/3/library/csv.html#csv.field_size_limit + name: field_size_limit + uid: csv.field_size_limit +- fullName: csv.get_dialect + href: https://docs.python.org/3/library/csv.html#csv.get_dialect + name: get_dialect + uid: csv.get_dialect +- fullName: csv.list_dialects + href: https://docs.python.org/3/library/csv.html#csv.list_dialects + name: list_dialects + uid: csv.list_dialects +- fullName: csv.reader + href: https://docs.python.org/3/library/csv.html#csv.reader + name: reader + uid: csv.reader +- fullName: csv.register_dialect + href: https://docs.python.org/3/library/csv.html#csv.register_dialect + name: register_dialect + uid: csv.register_dialect +- fullName: csv.unregister_dialect + href: https://docs.python.org/3/library/csv.html#csv.unregister_dialect + name: unregister_dialect + uid: csv.unregister_dialect +- fullName: csv.writer + href: https://docs.python.org/3/library/csv.html#csv.writer + name: writer + uid: csv.writer +- fullName: ctypes.ARRAY + href: https://docs.python.org/3/library/ctypes.html#ctypes.ARRAY + name: ARRAY + uid: ctypes.ARRAY +- fullName: ctypes.CFUNCTYPE + href: https://docs.python.org/3/library/ctypes.html#ctypes.CFUNCTYPE + name: CFUNCTYPE + uid: ctypes.CFUNCTYPE +- fullName: ctypes.DllCanUnloadNow + href: https://docs.python.org/3/library/ctypes.html#ctypes.DllCanUnloadNow + name: DllCanUnloadNow + uid: ctypes.DllCanUnloadNow +- fullName: ctypes.DllGetClassObject + href: https://docs.python.org/3/library/ctypes.html#ctypes.DllGetClassObject + name: DllGetClassObject + uid: ctypes.DllGetClassObject +- fullName: ctypes.FormatError + href: https://docs.python.org/3/library/ctypes.html#ctypes.FormatError + name: FormatError + uid: ctypes.FormatError +- fullName: ctypes.GetLastError + href: https://docs.python.org/3/library/ctypes.html#ctypes.GetLastError + name: GetLastError + uid: ctypes.GetLastError +- fullName: ctypes.POINTER + href: https://docs.python.org/3/library/ctypes.html#ctypes.POINTER + name: POINTER + uid: ctypes.POINTER +- fullName: ctypes.PYFUNCTYPE + href: https://docs.python.org/3/library/ctypes.html#ctypes.PYFUNCTYPE + name: PYFUNCTYPE + uid: ctypes.PYFUNCTYPE +- fullName: ctypes.WINFUNCTYPE + href: https://docs.python.org/3/library/ctypes.html#ctypes.WINFUNCTYPE + name: WINFUNCTYPE + uid: ctypes.WINFUNCTYPE +- fullName: ctypes.WinError + href: https://docs.python.org/3/library/ctypes.html#ctypes.WinError + name: WinError + uid: ctypes.WinError +- fullName: ctypes.addressof + href: https://docs.python.org/3/library/ctypes.html#ctypes.addressof + name: addressof + uid: ctypes.addressof +- fullName: ctypes.alignment + href: https://docs.python.org/3/library/ctypes.html#ctypes.alignment + name: alignment + uid: ctypes.alignment +- fullName: ctypes.byref + href: https://docs.python.org/3/library/ctypes.html#ctypes.byref + name: byref + uid: ctypes.byref +- fullName: ctypes.cast + href: https://docs.python.org/3/library/ctypes.html#ctypes.cast + name: cast + uid: ctypes.cast +- fullName: ctypes.create_string_buffer + href: https://docs.python.org/3/library/ctypes.html#ctypes.create_string_buffer + name: create_string_buffer + uid: ctypes.create_string_buffer +- fullName: ctypes.create_unicode_buffer + href: https://docs.python.org/3/library/ctypes.html#ctypes.create_unicode_buffer + name: create_unicode_buffer + uid: ctypes.create_unicode_buffer +- fullName: ctypes.get_errno + href: https://docs.python.org/3/library/ctypes.html#ctypes.get_errno + name: get_errno + uid: ctypes.get_errno +- fullName: ctypes.get_last_error + href: https://docs.python.org/3/library/ctypes.html#ctypes.get_last_error + name: get_last_error + uid: ctypes.get_last_error +- fullName: ctypes.memmove + href: https://docs.python.org/3/library/ctypes.html#ctypes.memmove + name: memmove + uid: ctypes.memmove +- fullName: ctypes.memset + href: https://docs.python.org/3/library/ctypes.html#ctypes.memset + name: memset + uid: ctypes.memset +- fullName: ctypes.pointer + href: https://docs.python.org/3/library/ctypes.html#ctypes.pointer + name: pointer + uid: ctypes.pointer +- fullName: ctypes.resize + href: https://docs.python.org/3/library/ctypes.html#ctypes.resize + name: resize + uid: ctypes.resize +- fullName: ctypes.set_errno + href: https://docs.python.org/3/library/ctypes.html#ctypes.set_errno + name: set_errno + uid: ctypes.set_errno +- fullName: ctypes.set_last_error + href: https://docs.python.org/3/library/ctypes.html#ctypes.set_last_error + name: set_last_error + uid: ctypes.set_last_error +- fullName: ctypes.sizeof + href: https://docs.python.org/3/library/ctypes.html#ctypes.sizeof + name: sizeof + uid: ctypes.sizeof +- fullName: ctypes.string_at + href: https://docs.python.org/3/library/ctypes.html#ctypes.string_at + name: string_at + uid: ctypes.string_at +- fullName: ctypes.util.find_library + href: https://docs.python.org/3/library/ctypes.html#ctypes.util.find_library + name: find_library + uid: ctypes.util.find_library +- fullName: ctypes.util.find_msvcrt + href: https://docs.python.org/3/library/ctypes.html#ctypes.util.find_msvcrt + name: find_msvcrt + uid: ctypes.util.find_msvcrt +- fullName: ctypes.wstring_at + href: https://docs.python.org/3/library/ctypes.html#ctypes.wstring_at + name: wstring_at + uid: ctypes.wstring_at +- fullName: curses.ascii.alt + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.alt + name: alt + uid: curses.ascii.alt +- fullName: curses.ascii.ascii + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.ascii + name: ascii + uid: curses.ascii.ascii +- fullName: curses.ascii.ctrl + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.ctrl + name: ctrl + uid: curses.ascii.ctrl +- fullName: curses.ascii.isalnum + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.isalnum + name: isalnum + uid: curses.ascii.isalnum +- fullName: curses.ascii.isalpha + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.isalpha + name: isalpha + uid: curses.ascii.isalpha +- fullName: curses.ascii.isascii + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.isascii + name: isascii + uid: curses.ascii.isascii +- fullName: curses.ascii.isblank + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.isblank + name: isblank + uid: curses.ascii.isblank +- fullName: curses.ascii.iscntrl + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.iscntrl + name: iscntrl + uid: curses.ascii.iscntrl +- fullName: curses.ascii.isctrl + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.isctrl + name: isctrl + uid: curses.ascii.isctrl +- fullName: curses.ascii.isdigit + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.isdigit + name: isdigit + uid: curses.ascii.isdigit +- fullName: curses.ascii.isgraph + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.isgraph + name: isgraph + uid: curses.ascii.isgraph +- fullName: curses.ascii.islower + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.islower + name: islower + uid: curses.ascii.islower +- fullName: curses.ascii.ismeta + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.ismeta + name: ismeta + uid: curses.ascii.ismeta +- fullName: curses.ascii.isprint + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.isprint + name: isprint + uid: curses.ascii.isprint +- fullName: curses.ascii.ispunct + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.ispunct + name: ispunct + uid: curses.ascii.ispunct +- fullName: curses.ascii.isspace + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.isspace + name: isspace + uid: curses.ascii.isspace +- fullName: curses.ascii.isupper + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.isupper + name: isupper + uid: curses.ascii.isupper +- fullName: curses.ascii.isxdigit + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.isxdigit + name: isxdigit + uid: curses.ascii.isxdigit +- fullName: curses.ascii.unctrl + href: https://docs.python.org/3/library/curses.ascii.html#curses.ascii.unctrl + name: unctrl + uid: curses.ascii.unctrl +- fullName: curses.baudrate + href: https://docs.python.org/3/library/curses.html#curses.baudrate + name: baudrate + uid: curses.baudrate +- fullName: curses.beep + href: https://docs.python.org/3/library/curses.html#curses.beep + name: beep + uid: curses.beep +- fullName: curses.can_change_color + href: https://docs.python.org/3/library/curses.html#curses.can_change_color + name: can_change_color + uid: curses.can_change_color +- fullName: curses.cbreak + href: https://docs.python.org/3/library/curses.html#curses.cbreak + name: cbreak + uid: curses.cbreak +- fullName: curses.color_content + href: https://docs.python.org/3/library/curses.html#curses.color_content + name: color_content + uid: curses.color_content +- fullName: curses.color_pair + href: https://docs.python.org/3/library/curses.html#curses.color_pair + name: color_pair + uid: curses.color_pair +- fullName: curses.curs_set + href: https://docs.python.org/3/library/curses.html#curses.curs_set + name: curs_set + uid: curses.curs_set +- fullName: curses.def_prog_mode + href: https://docs.python.org/3/library/curses.html#curses.def_prog_mode + name: def_prog_mode + uid: curses.def_prog_mode +- fullName: curses.def_shell_mode + href: https://docs.python.org/3/library/curses.html#curses.def_shell_mode + name: def_shell_mode + uid: curses.def_shell_mode +- fullName: curses.delay_output + href: https://docs.python.org/3/library/curses.html#curses.delay_output + name: delay_output + uid: curses.delay_output +- fullName: curses.doupdate + href: https://docs.python.org/3/library/curses.html#curses.doupdate + name: doupdate + uid: curses.doupdate +- fullName: curses.echo + href: https://docs.python.org/3/library/curses.html#curses.echo + name: echo + uid: curses.echo +- fullName: curses.endwin + href: https://docs.python.org/3/library/curses.html#curses.endwin + name: endwin + uid: curses.endwin +- fullName: curses.erasechar + href: https://docs.python.org/3/library/curses.html#curses.erasechar + name: erasechar + uid: curses.erasechar +- fullName: curses.filter + href: https://docs.python.org/3/library/curses.html#curses.filter + name: filter + uid: curses.filter +- fullName: curses.flash + href: https://docs.python.org/3/library/curses.html#curses.flash + name: flash + uid: curses.flash +- fullName: curses.flushinp + href: https://docs.python.org/3/library/curses.html#curses.flushinp + name: flushinp + uid: curses.flushinp +- fullName: curses.get_escdelay + href: https://docs.python.org/3/library/curses.html#curses.get_escdelay + name: get_escdelay + uid: curses.get_escdelay +- fullName: curses.get_tabsize + href: https://docs.python.org/3/library/curses.html#curses.get_tabsize + name: get_tabsize + uid: curses.get_tabsize +- fullName: curses.getmouse + href: https://docs.python.org/3/library/curses.html#curses.getmouse + name: getmouse + uid: curses.getmouse +- fullName: curses.getsyx + href: https://docs.python.org/3/library/curses.html#curses.getsyx + name: getsyx + uid: curses.getsyx +- fullName: curses.getwin + href: https://docs.python.org/3/library/curses.html#curses.getwin + name: getwin + uid: curses.getwin +- fullName: curses.halfdelay + href: https://docs.python.org/3/library/curses.html#curses.halfdelay + name: halfdelay + uid: curses.halfdelay +- fullName: curses.has_colors + href: https://docs.python.org/3/library/curses.html#curses.has_colors + name: has_colors + uid: curses.has_colors +- fullName: curses.has_extended_color_support + href: https://docs.python.org/3/library/curses.html#curses.has_extended_color_support + name: has_extended_color_support + uid: curses.has_extended_color_support +- fullName: curses.has_ic + href: https://docs.python.org/3/library/curses.html#curses.has_ic + name: has_ic + uid: curses.has_ic +- fullName: curses.has_il + href: https://docs.python.org/3/library/curses.html#curses.has_il + name: has_il + uid: curses.has_il +- fullName: curses.has_key + href: https://docs.python.org/3/library/curses.html#curses.has_key + name: has_key + uid: curses.has_key +- fullName: curses.init_color + href: https://docs.python.org/3/library/curses.html#curses.init_color + name: init_color + uid: curses.init_color +- fullName: curses.init_pair + href: https://docs.python.org/3/library/curses.html#curses.init_pair + name: init_pair + uid: curses.init_pair +- fullName: curses.initscr + href: https://docs.python.org/3/library/curses.html#curses.initscr + name: initscr + uid: curses.initscr +- fullName: curses.is_term_resized + href: https://docs.python.org/3/library/curses.html#curses.is_term_resized + name: is_term_resized + uid: curses.is_term_resized +- fullName: curses.isendwin + href: https://docs.python.org/3/library/curses.html#curses.isendwin + name: isendwin + uid: curses.isendwin +- fullName: curses.keyname + href: https://docs.python.org/3/library/curses.html#curses.keyname + name: keyname + uid: curses.keyname +- fullName: curses.killchar + href: https://docs.python.org/3/library/curses.html#curses.killchar + name: killchar + uid: curses.killchar +- fullName: curses.longname + href: https://docs.python.org/3/library/curses.html#curses.longname + name: longname + uid: curses.longname +- fullName: curses.meta + href: https://docs.python.org/3/library/curses.html#curses.meta + name: meta + uid: curses.meta +- fullName: curses.mouseinterval + href: https://docs.python.org/3/library/curses.html#curses.mouseinterval + name: mouseinterval + uid: curses.mouseinterval +- fullName: curses.mousemask + href: https://docs.python.org/3/library/curses.html#curses.mousemask + name: mousemask + uid: curses.mousemask +- fullName: curses.napms + href: https://docs.python.org/3/library/curses.html#curses.napms + name: napms + uid: curses.napms +- fullName: curses.newpad + href: https://docs.python.org/3/library/curses.html#curses.newpad + name: newpad + uid: curses.newpad +- fullName: curses.newwin + href: https://docs.python.org/3/library/curses.html#curses.newwin + name: newwin + uid: curses.newwin +- fullName: curses.nl + href: https://docs.python.org/3/library/curses.html#curses.nl + name: nl + uid: curses.nl +- fullName: curses.nocbreak + href: https://docs.python.org/3/library/curses.html#curses.nocbreak + name: nocbreak + uid: curses.nocbreak +- fullName: curses.noecho + href: https://docs.python.org/3/library/curses.html#curses.noecho + name: noecho + uid: curses.noecho +- fullName: curses.nonl + href: https://docs.python.org/3/library/curses.html#curses.nonl + name: nonl + uid: curses.nonl +- fullName: curses.noqiflush + href: https://docs.python.org/3/library/curses.html#curses.noqiflush + name: noqiflush + uid: curses.noqiflush +- fullName: curses.noraw + href: https://docs.python.org/3/library/curses.html#curses.noraw + name: noraw + uid: curses.noraw +- fullName: curses.pair_content + href: https://docs.python.org/3/library/curses.html#curses.pair_content + name: pair_content + uid: curses.pair_content +- fullName: curses.pair_number + href: https://docs.python.org/3/library/curses.html#curses.pair_number + name: pair_number + uid: curses.pair_number +- fullName: curses.panel.bottom_panel + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.bottom_panel + name: bottom_panel + uid: curses.panel.bottom_panel +- fullName: curses.panel.new_panel + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.new_panel + name: new_panel + uid: curses.panel.new_panel +- fullName: curses.panel.top_panel + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.top_panel + name: top_panel + uid: curses.panel.top_panel +- fullName: curses.panel.update_panels + href: https://docs.python.org/3/library/curses.panel.html#curses.panel.update_panels + name: update_panels + uid: curses.panel.update_panels +- fullName: curses.putp + href: https://docs.python.org/3/library/curses.html#curses.putp + name: putp + uid: curses.putp +- fullName: curses.qiflush + href: https://docs.python.org/3/library/curses.html#curses.qiflush + name: qiflush + uid: curses.qiflush +- fullName: curses.raw + href: https://docs.python.org/3/library/curses.html#curses.raw + name: raw + uid: curses.raw +- fullName: curses.reset_prog_mode + href: https://docs.python.org/3/library/curses.html#curses.reset_prog_mode + name: reset_prog_mode + uid: curses.reset_prog_mode +- fullName: curses.reset_shell_mode + href: https://docs.python.org/3/library/curses.html#curses.reset_shell_mode + name: reset_shell_mode + uid: curses.reset_shell_mode +- fullName: curses.resetty + href: https://docs.python.org/3/library/curses.html#curses.resetty + name: resetty + uid: curses.resetty +- fullName: curses.resize_term + href: https://docs.python.org/3/library/curses.html#curses.resize_term + name: resize_term + uid: curses.resize_term +- fullName: curses.resizeterm + href: https://docs.python.org/3/library/curses.html#curses.resizeterm + name: resizeterm + uid: curses.resizeterm +- fullName: curses.savetty + href: https://docs.python.org/3/library/curses.html#curses.savetty + name: savetty + uid: curses.savetty +- fullName: curses.set_escdelay + href: https://docs.python.org/3/library/curses.html#curses.set_escdelay + name: set_escdelay + uid: curses.set_escdelay +- fullName: curses.set_tabsize + href: https://docs.python.org/3/library/curses.html#curses.set_tabsize + name: set_tabsize + uid: curses.set_tabsize +- fullName: curses.setsyx + href: https://docs.python.org/3/library/curses.html#curses.setsyx + name: setsyx + uid: curses.setsyx +- fullName: curses.setupterm + href: https://docs.python.org/3/library/curses.html#curses.setupterm + name: setupterm + uid: curses.setupterm +- fullName: curses.start_color + href: https://docs.python.org/3/library/curses.html#curses.start_color + name: start_color + uid: curses.start_color +- fullName: curses.termattrs + href: https://docs.python.org/3/library/curses.html#curses.termattrs + name: termattrs + uid: curses.termattrs +- fullName: curses.termname + href: https://docs.python.org/3/library/curses.html#curses.termname + name: termname + uid: curses.termname +- fullName: curses.textpad.rectangle + href: https://docs.python.org/3/library/curses.html#curses.textpad.rectangle + name: rectangle + uid: curses.textpad.rectangle +- fullName: curses.tigetflag + href: https://docs.python.org/3/library/curses.html#curses.tigetflag + name: tigetflag + uid: curses.tigetflag +- fullName: curses.tigetnum + href: https://docs.python.org/3/library/curses.html#curses.tigetnum + name: tigetnum + uid: curses.tigetnum +- fullName: curses.tigetstr + href: https://docs.python.org/3/library/curses.html#curses.tigetstr + name: tigetstr + uid: curses.tigetstr +- fullName: curses.tparm + href: https://docs.python.org/3/library/curses.html#curses.tparm + name: tparm + uid: curses.tparm +- fullName: curses.typeahead + href: https://docs.python.org/3/library/curses.html#curses.typeahead + name: typeahead + uid: curses.typeahead +- fullName: curses.unctrl + href: https://docs.python.org/3/library/curses.html#curses.unctrl + name: unctrl + uid: curses.unctrl +- fullName: curses.unget_wch + href: https://docs.python.org/3/library/curses.html#curses.unget_wch + name: unget_wch + uid: curses.unget_wch +- fullName: curses.ungetch + href: https://docs.python.org/3/library/curses.html#curses.ungetch + name: ungetch + uid: curses.ungetch +- fullName: curses.ungetmouse + href: https://docs.python.org/3/library/curses.html#curses.ungetmouse + name: ungetmouse + uid: curses.ungetmouse +- fullName: curses.update_lines_cols + href: https://docs.python.org/3/library/curses.html#curses.update_lines_cols + name: update_lines_cols + uid: curses.update_lines_cols +- fullName: curses.use_default_colors + href: https://docs.python.org/3/library/curses.html#curses.use_default_colors + name: use_default_colors + uid: curses.use_default_colors +- fullName: curses.use_env + href: https://docs.python.org/3/library/curses.html#curses.use_env + name: use_env + uid: curses.use_env +- fullName: curses.wrapper + href: https://docs.python.org/3/library/curses.html#curses.wrapper + name: wrapper + uid: curses.wrapper +- fullName: dataclasses.__post_init__ + href: https://docs.python.org/3/library/dataclasses.html#dataclasses.__post_init__ + name: __post_init__ + uid: dataclasses.__post_init__ +- fullName: dataclasses.asdict + href: https://docs.python.org/3/library/dataclasses.html#dataclasses.asdict + name: asdict + uid: dataclasses.asdict +- fullName: dataclasses.astuple + href: https://docs.python.org/3/library/dataclasses.html#dataclasses.astuple + name: astuple + uid: dataclasses.astuple +- fullName: dataclasses.dataclass + href: https://docs.python.org/3/library/dataclasses.html#dataclasses.dataclass + name: dataclass + uid: dataclasses.dataclass +- fullName: dataclasses.field + href: https://docs.python.org/3/library/dataclasses.html#dataclasses.field + name: field + uid: dataclasses.field +- fullName: dataclasses.fields + href: https://docs.python.org/3/library/dataclasses.html#dataclasses.fields + name: fields + uid: dataclasses.fields +- fullName: dataclasses.is_dataclass + href: https://docs.python.org/3/library/dataclasses.html#dataclasses.is_dataclass + name: is_dataclass + uid: dataclasses.is_dataclass +- fullName: dataclasses.make_dataclass + href: https://docs.python.org/3/library/dataclasses.html#dataclasses.make_dataclass + name: make_dataclass + uid: dataclasses.make_dataclass +- fullName: dataclasses.replace + href: https://docs.python.org/3/library/dataclasses.html#dataclasses.replace + name: replace + uid: dataclasses.replace +- fullName: dbm.dumb.open + href: https://docs.python.org/3/library/dbm.html#dbm.dumb.open + name: open + uid: dbm.dumb.open +- fullName: dbm.gnu.open + href: https://docs.python.org/3/library/dbm.html#dbm.gnu.open + name: open + uid: dbm.gnu.open +- fullName: dbm.ndbm.open + href: https://docs.python.org/3/library/dbm.html#dbm.ndbm.open + name: open + uid: dbm.ndbm.open +- fullName: dbm.open + href: https://docs.python.org/3/library/dbm.html#dbm.open + name: open + uid: dbm.open +- fullName: dbm.sqlite3.open + href: https://docs.python.org/3/library/dbm.html#dbm.sqlite3.open + name: open + uid: dbm.sqlite3.open +- fullName: dbm.whichdb + href: https://docs.python.org/3/library/dbm.html#dbm.whichdb + name: whichdb + uid: dbm.whichdb +- fullName: decimal.getcontext + href: https://docs.python.org/3/library/decimal.html#decimal.getcontext + name: getcontext + uid: decimal.getcontext +- fullName: decimal.localcontext + href: https://docs.python.org/3/library/decimal.html#decimal.localcontext + name: localcontext + uid: decimal.localcontext +- fullName: decimal.setcontext + href: https://docs.python.org/3/library/decimal.html#decimal.setcontext + name: setcontext + uid: decimal.setcontext +- fullName: delattr + href: https://docs.python.org/3/library/functions.html#delattr + name: delattr + uid: delattr +- fullName: difflib.IS_CHARACTER_JUNK + href: https://docs.python.org/3/library/difflib.html#difflib.IS_CHARACTER_JUNK + name: IS_CHARACTER_JUNK + uid: difflib.IS_CHARACTER_JUNK +- fullName: difflib.IS_LINE_JUNK + href: https://docs.python.org/3/library/difflib.html#difflib.IS_LINE_JUNK + name: IS_LINE_JUNK + uid: difflib.IS_LINE_JUNK +- fullName: difflib.context_diff + href: https://docs.python.org/3/library/difflib.html#difflib.context_diff + name: context_diff + uid: difflib.context_diff +- fullName: difflib.diff_bytes + href: https://docs.python.org/3/library/difflib.html#difflib.diff_bytes + name: diff_bytes + uid: difflib.diff_bytes +- fullName: difflib.get_close_matches + href: https://docs.python.org/3/library/difflib.html#difflib.get_close_matches + name: get_close_matches + uid: difflib.get_close_matches +- fullName: difflib.ndiff + href: https://docs.python.org/3/library/difflib.html#difflib.ndiff + name: ndiff + uid: difflib.ndiff +- fullName: difflib.restore + href: https://docs.python.org/3/library/difflib.html#difflib.restore + name: restore + uid: difflib.restore +- fullName: difflib.unified_diff + href: https://docs.python.org/3/library/difflib.html#difflib.unified_diff + name: unified_diff + uid: difflib.unified_diff +- fullName: dir + href: https://docs.python.org/3/library/functions.html#dir + name: dir + uid: dir +- fullName: dis.code_info + href: https://docs.python.org/3/library/dis.html#dis.code_info + name: code_info + uid: dis.code_info +- fullName: dis.dis + href: https://docs.python.org/3/library/dis.html#dis.dis + name: dis + uid: dis.dis +- fullName: dis.disassemble + href: https://docs.python.org/3/library/dis.html#dis.disassemble + name: disassemble + uid: dis.disassemble +- fullName: dis.findlabels + href: https://docs.python.org/3/library/dis.html#dis.findlabels + name: findlabels + uid: dis.findlabels +- fullName: dis.findlinestarts + href: https://docs.python.org/3/library/dis.html#dis.findlinestarts + name: findlinestarts + uid: dis.findlinestarts +- fullName: dis.get_instructions + href: https://docs.python.org/3/library/dis.html#dis.get_instructions + name: get_instructions + uid: dis.get_instructions +- fullName: dis.show_code + href: https://docs.python.org/3/library/dis.html#dis.show_code + name: show_code + uid: dis.show_code +- fullName: dis.stack_effect + href: https://docs.python.org/3/library/dis.html#dis.stack_effect + name: stack_effect + uid: dis.stack_effect +- fullName: divmod + href: https://docs.python.org/3/library/functions.html#divmod + name: divmod + uid: divmod +- fullName: doctest.DocFileSuite + href: https://docs.python.org/3/library/doctest.html#doctest.DocFileSuite + name: DocFileSuite + uid: doctest.DocFileSuite +- fullName: doctest.DocTestSuite + href: https://docs.python.org/3/library/doctest.html#doctest.DocTestSuite + name: DocTestSuite + uid: doctest.DocTestSuite +- fullName: doctest.debug + href: https://docs.python.org/3/library/doctest.html#doctest.debug + name: debug + uid: doctest.debug +- fullName: doctest.debug_src + href: https://docs.python.org/3/library/doctest.html#doctest.debug_src + name: debug_src + uid: doctest.debug_src +- fullName: doctest.register_optionflag + href: https://docs.python.org/3/library/doctest.html#doctest.register_optionflag + name: register_optionflag + uid: doctest.register_optionflag +- fullName: doctest.run_docstring_examples + href: https://docs.python.org/3/library/doctest.html#doctest.run_docstring_examples + name: run_docstring_examples + uid: doctest.run_docstring_examples +- fullName: doctest.script_from_examples + href: https://docs.python.org/3/library/doctest.html#doctest.script_from_examples + name: script_from_examples + uid: doctest.script_from_examples +- fullName: doctest.set_unittest_reportflags + href: https://docs.python.org/3/library/doctest.html#doctest.set_unittest_reportflags + name: set_unittest_reportflags + uid: doctest.set_unittest_reportflags +- fullName: doctest.testfile + href: https://docs.python.org/3/library/doctest.html#doctest.testfile + name: testfile + uid: doctest.testfile +- fullName: doctest.testmod + href: https://docs.python.org/3/library/doctest.html#doctest.testmod + name: testmod + uid: doctest.testmod +- fullName: doctest.testsource + href: https://docs.python.org/3/library/doctest.html#doctest.testsource + name: testsource + uid: doctest.testsource +- fullName: email.charset.add_alias + href: https://docs.python.org/3/library/email.charset.html#email.charset.add_alias + name: add_alias + uid: email.charset.add_alias +- fullName: email.charset.add_charset + href: https://docs.python.org/3/library/email.charset.html#email.charset.add_charset + name: add_charset + uid: email.charset.add_charset +- fullName: email.charset.add_codec + href: https://docs.python.org/3/library/email.charset.html#email.charset.add_codec + name: add_codec + uid: email.charset.add_codec +- fullName: email.encoders.encode_7or8bit + href: https://docs.python.org/3/library/email.encoders.html#email.encoders.encode_7or8bit + name: encode_7or8bit + uid: email.encoders.encode_7or8bit +- fullName: email.encoders.encode_base64 + href: https://docs.python.org/3/library/email.encoders.html#email.encoders.encode_base64 + name: encode_base64 + uid: email.encoders.encode_base64 +- fullName: email.encoders.encode_noop + href: https://docs.python.org/3/library/email.encoders.html#email.encoders.encode_noop + name: encode_noop + uid: email.encoders.encode_noop +- fullName: email.encoders.encode_quopri + href: https://docs.python.org/3/library/email.encoders.html#email.encoders.encode_quopri + name: encode_quopri + uid: email.encoders.encode_quopri +- fullName: email.header.decode_header + href: https://docs.python.org/3/library/email.header.html#email.header.decode_header + name: decode_header + uid: email.header.decode_header +- fullName: email.header.make_header + href: https://docs.python.org/3/library/email.header.html#email.header.make_header + name: make_header + uid: email.header.make_header +- fullName: email.iterators._structure + href: https://docs.python.org/3/library/email.iterators.html#email.iterators._structure + name: _structure + uid: email.iterators._structure +- fullName: email.iterators.body_line_iterator + href: https://docs.python.org/3/library/email.iterators.html#email.iterators.body_line_iterator + name: body_line_iterator + uid: email.iterators.body_line_iterator +- fullName: email.iterators.typed_subpart_iterator + href: https://docs.python.org/3/library/email.iterators.html#email.iterators.typed_subpart_iterator + name: typed_subpart_iterator + uid: email.iterators.typed_subpart_iterator +- fullName: email.message_from_binary_file + href: https://docs.python.org/3/library/email.parser.html#email.message_from_binary_file + name: message_from_binary_file + uid: email.message_from_binary_file +- fullName: email.message_from_bytes + href: https://docs.python.org/3/library/email.parser.html#email.message_from_bytes + name: message_from_bytes + uid: email.message_from_bytes +- fullName: email.message_from_file + href: https://docs.python.org/3/library/email.parser.html#email.message_from_file + name: message_from_file + uid: email.message_from_file +- fullName: email.message_from_string + href: https://docs.python.org/3/library/email.parser.html#email.message_from_string + name: message_from_string + uid: email.message_from_string +- fullName: email.utils.collapse_rfc2231_value + href: https://docs.python.org/3/library/email.utils.html#email.utils.collapse_rfc2231_value + name: collapse_rfc2231_value + uid: email.utils.collapse_rfc2231_value +- fullName: email.utils.decode_params + href: https://docs.python.org/3/library/email.utils.html#email.utils.decode_params + name: decode_params + uid: email.utils.decode_params +- fullName: email.utils.decode_rfc2231 + href: https://docs.python.org/3/library/email.utils.html#email.utils.decode_rfc2231 + name: decode_rfc2231 + uid: email.utils.decode_rfc2231 +- fullName: email.utils.encode_rfc2231 + href: https://docs.python.org/3/library/email.utils.html#email.utils.encode_rfc2231 + name: encode_rfc2231 + uid: email.utils.encode_rfc2231 +- fullName: email.utils.format_datetime + href: https://docs.python.org/3/library/email.utils.html#email.utils.format_datetime + name: format_datetime + uid: email.utils.format_datetime +- fullName: email.utils.formataddr + href: https://docs.python.org/3/library/email.utils.html#email.utils.formataddr + name: formataddr + uid: email.utils.formataddr +- fullName: email.utils.formatdate + href: https://docs.python.org/3/library/email.utils.html#email.utils.formatdate + name: formatdate + uid: email.utils.formatdate +- fullName: email.utils.getaddresses + href: https://docs.python.org/3/library/email.utils.html#email.utils.getaddresses + name: getaddresses + uid: email.utils.getaddresses +- fullName: email.utils.localtime + href: https://docs.python.org/3/library/email.utils.html#email.utils.localtime + name: localtime + uid: email.utils.localtime +- fullName: email.utils.make_msgid + href: https://docs.python.org/3/library/email.utils.html#email.utils.make_msgid + name: make_msgid + uid: email.utils.make_msgid +- fullName: email.utils.mktime_tz + href: https://docs.python.org/3/library/email.utils.html#email.utils.mktime_tz + name: mktime_tz + uid: email.utils.mktime_tz +- fullName: email.utils.parseaddr + href: https://docs.python.org/3/library/email.utils.html#email.utils.parseaddr + name: parseaddr + uid: email.utils.parseaddr +- fullName: email.utils.parsedate + href: https://docs.python.org/3/library/email.utils.html#email.utils.parsedate + name: parsedate + uid: email.utils.parsedate +- fullName: email.utils.parsedate_to_datetime + href: https://docs.python.org/3/library/email.utils.html#email.utils.parsedate_to_datetime + name: parsedate_to_datetime + uid: email.utils.parsedate_to_datetime +- fullName: email.utils.parsedate_tz + href: https://docs.python.org/3/library/email.utils.html#email.utils.parsedate_tz + name: parsedate_tz + uid: email.utils.parsedate_tz +- fullName: email.utils.quote + href: https://docs.python.org/3/library/email.utils.html#email.utils.quote + name: quote + uid: email.utils.quote +- fullName: email.utils.unquote + href: https://docs.python.org/3/library/email.utils.html#email.utils.unquote + name: unquote + uid: email.utils.unquote +- fullName: encodings.idna.ToASCII + href: https://docs.python.org/3/library/codecs.html#encodings.idna.ToASCII + name: ToASCII + uid: encodings.idna.ToASCII +- fullName: encodings.idna.ToUnicode + href: https://docs.python.org/3/library/codecs.html#encodings.idna.ToUnicode + name: ToUnicode + uid: encodings.idna.ToUnicode +- fullName: encodings.idna.nameprep + href: https://docs.python.org/3/library/codecs.html#encodings.idna.nameprep + name: nameprep + uid: encodings.idna.nameprep +- fullName: ensurepip.bootstrap + href: https://docs.python.org/3/library/ensurepip.html#ensurepip.bootstrap + name: bootstrap + uid: ensurepip.bootstrap +- fullName: ensurepip.version + href: https://docs.python.org/3/library/ensurepip.html#ensurepip.version + name: version + uid: ensurepip.version +- fullName: enum.global_enum + href: https://docs.python.org/3/library/enum.html#enum.global_enum + name: global_enum + uid: enum.global_enum +- fullName: enum.member + href: https://docs.python.org/3/library/enum.html#enum.member + name: member + uid: enum.member +- fullName: enum.nonmember + href: https://docs.python.org/3/library/enum.html#enum.nonmember + name: nonmember + uid: enum.nonmember +- fullName: enum.property + href: https://docs.python.org/3/library/enum.html#enum.property + name: property + uid: enum.property +- fullName: enum.show_flag_values + href: https://docs.python.org/3/library/enum.html#enum.show_flag_values + name: show_flag_values + uid: enum.show_flag_values +- fullName: enum.unique + href: https://docs.python.org/3/library/enum.html#enum.unique + name: unique + uid: enum.unique +- fullName: enum.verify + href: https://docs.python.org/3/library/enum.html#enum.verify + name: verify + uid: enum.verify +- fullName: enumerate + href: https://docs.python.org/3/library/functions.html#enumerate + name: enumerate + uid: enumerate +- fullName: eval + href: https://docs.python.org/3/library/functions.html#eval + name: eval + uid: eval +- fullName: exec + href: https://docs.python.org/3/library/functions.html#exec + name: exec + uid: exec +- fullName: faulthandler.cancel_dump_traceback_later + href: https://docs.python.org/3/library/faulthandler.html#faulthandler.cancel_dump_traceback_later + name: cancel_dump_traceback_later + uid: faulthandler.cancel_dump_traceback_later +- fullName: faulthandler.disable + href: https://docs.python.org/3/library/faulthandler.html#faulthandler.disable + name: disable + uid: faulthandler.disable +- fullName: faulthandler.dump_traceback + href: https://docs.python.org/3/library/faulthandler.html#faulthandler.dump_traceback + name: dump_traceback + uid: faulthandler.dump_traceback +- fullName: faulthandler.dump_traceback_later + href: https://docs.python.org/3/library/faulthandler.html#faulthandler.dump_traceback_later + name: dump_traceback_later + uid: faulthandler.dump_traceback_later +- fullName: faulthandler.enable + href: https://docs.python.org/3/library/faulthandler.html#faulthandler.enable + name: enable + uid: faulthandler.enable +- fullName: faulthandler.is_enabled + href: https://docs.python.org/3/library/faulthandler.html#faulthandler.is_enabled + name: is_enabled + uid: faulthandler.is_enabled +- fullName: faulthandler.register + href: https://docs.python.org/3/library/faulthandler.html#faulthandler.register + name: register + uid: faulthandler.register +- fullName: faulthandler.unregister + href: https://docs.python.org/3/library/faulthandler.html#faulthandler.unregister + name: unregister + uid: faulthandler.unregister +- fullName: fcntl.fcntl + href: https://docs.python.org/3/library/fcntl.html#fcntl.fcntl + name: fcntl + uid: fcntl.fcntl +- fullName: fcntl.flock + href: https://docs.python.org/3/library/fcntl.html#fcntl.flock + name: flock + uid: fcntl.flock +- fullName: fcntl.ioctl + href: https://docs.python.org/3/library/fcntl.html#fcntl.ioctl + name: ioctl + uid: fcntl.ioctl +- fullName: fcntl.lockf + href: https://docs.python.org/3/library/fcntl.html#fcntl.lockf + name: lockf + uid: fcntl.lockf +- fullName: filecmp.clear_cache + href: https://docs.python.org/3/library/filecmp.html#filecmp.clear_cache + name: clear_cache + uid: filecmp.clear_cache +- fullName: filecmp.cmp + href: https://docs.python.org/3/library/filecmp.html#filecmp.cmp + name: cmp + uid: filecmp.cmp +- fullName: filecmp.cmpfiles + href: https://docs.python.org/3/library/filecmp.html#filecmp.cmpfiles + name: cmpfiles + uid: filecmp.cmpfiles +- fullName: fileinput.close + href: https://docs.python.org/3/library/fileinput.html#fileinput.close + name: close + uid: fileinput.close +- fullName: fileinput.filelineno + href: https://docs.python.org/3/library/fileinput.html#fileinput.filelineno + name: filelineno + uid: fileinput.filelineno +- fullName: fileinput.filename + href: https://docs.python.org/3/library/fileinput.html#fileinput.filename + name: filename + uid: fileinput.filename +- fullName: fileinput.fileno + href: https://docs.python.org/3/library/fileinput.html#fileinput.fileno + name: fileno + uid: fileinput.fileno +- fullName: fileinput.hook_compressed + href: https://docs.python.org/3/library/fileinput.html#fileinput.hook_compressed + name: hook_compressed + uid: fileinput.hook_compressed +- fullName: fileinput.hook_encoded + href: https://docs.python.org/3/library/fileinput.html#fileinput.hook_encoded + name: hook_encoded + uid: fileinput.hook_encoded +- fullName: fileinput.input + href: https://docs.python.org/3/library/fileinput.html#fileinput.input + name: input + uid: fileinput.input +- fullName: fileinput.isfirstline + href: https://docs.python.org/3/library/fileinput.html#fileinput.isfirstline + name: isfirstline + uid: fileinput.isfirstline +- fullName: fileinput.isstdin + href: https://docs.python.org/3/library/fileinput.html#fileinput.isstdin + name: isstdin + uid: fileinput.isstdin +- fullName: fileinput.lineno + href: https://docs.python.org/3/library/fileinput.html#fileinput.lineno + name: lineno + uid: fileinput.lineno +- fullName: fileinput.nextfile + href: https://docs.python.org/3/library/fileinput.html#fileinput.nextfile + name: nextfile + uid: fileinput.nextfile +- fullName: filter + href: https://docs.python.org/3/library/functions.html#filter + name: filter + uid: filter +- fullName: fnmatch.filter + href: https://docs.python.org/3/library/fnmatch.html#fnmatch.filter + name: filter + uid: fnmatch.filter +- fullName: fnmatch.fnmatch + href: https://docs.python.org/3/library/fnmatch.html#fnmatch.fnmatch + name: fnmatch + uid: fnmatch.fnmatch +- fullName: fnmatch.fnmatchcase + href: https://docs.python.org/3/library/fnmatch.html#fnmatch.fnmatchcase + name: fnmatchcase + uid: fnmatch.fnmatchcase +- fullName: fnmatch.translate + href: https://docs.python.org/3/library/fnmatch.html#fnmatch.translate + name: translate + uid: fnmatch.translate +- fullName: format + href: https://docs.python.org/3/library/functions.html#format + name: format + uid: format +- fullName: functools.cache + href: https://docs.python.org/3/library/functools.html#functools.cache + name: cache + uid: functools.cache +- fullName: functools.cached_property + href: https://docs.python.org/3/library/functools.html#functools.cached_property + name: cached_property + uid: functools.cached_property +- fullName: functools.cmp_to_key + href: https://docs.python.org/3/library/functools.html#functools.cmp_to_key + name: cmp_to_key + uid: functools.cmp_to_key +- fullName: functools.lru_cache + href: https://docs.python.org/3/library/functools.html#functools.lru_cache + name: lru_cache + uid: functools.lru_cache +- fullName: functools.partial + href: https://docs.python.org/3/library/functools.html#functools.partial + name: partial + uid: functools.partial +- fullName: functools.reduce + href: https://docs.python.org/3/library/functools.html#functools.reduce + name: reduce + uid: functools.reduce +- fullName: functools.singledispatch + href: https://docs.python.org/3/library/functools.html#functools.singledispatch + name: singledispatch + uid: functools.singledispatch +- fullName: functools.total_ordering + href: https://docs.python.org/3/library/functools.html#functools.total_ordering + name: total_ordering + uid: functools.total_ordering +- fullName: functools.update_wrapper + href: https://docs.python.org/3/library/functools.html#functools.update_wrapper + name: update_wrapper + uid: functools.update_wrapper +- fullName: functools.wraps + href: https://docs.python.org/3/library/functools.html#functools.wraps + name: wraps + uid: functools.wraps +- fullName: gc.collect + href: https://docs.python.org/3/library/gc.html#gc.collect + name: collect + uid: gc.collect +- fullName: gc.disable + href: https://docs.python.org/3/library/gc.html#gc.disable + name: disable + uid: gc.disable +- fullName: gc.enable + href: https://docs.python.org/3/library/gc.html#gc.enable + name: enable + uid: gc.enable +- fullName: gc.freeze + href: https://docs.python.org/3/library/gc.html#gc.freeze + name: freeze + uid: gc.freeze +- fullName: gc.get_count + href: https://docs.python.org/3/library/gc.html#gc.get_count + name: get_count + uid: gc.get_count +- fullName: gc.get_debug + href: https://docs.python.org/3/library/gc.html#gc.get_debug + name: get_debug + uid: gc.get_debug +- fullName: gc.get_freeze_count + href: https://docs.python.org/3/library/gc.html#gc.get_freeze_count + name: get_freeze_count + uid: gc.get_freeze_count +- fullName: gc.get_objects + href: https://docs.python.org/3/library/gc.html#gc.get_objects + name: get_objects + uid: gc.get_objects +- fullName: gc.get_referents + href: https://docs.python.org/3/library/gc.html#gc.get_referents + name: get_referents + uid: gc.get_referents +- fullName: gc.get_referrers + href: https://docs.python.org/3/library/gc.html#gc.get_referrers + name: get_referrers + uid: gc.get_referrers +- fullName: gc.get_stats + href: https://docs.python.org/3/library/gc.html#gc.get_stats + name: get_stats + uid: gc.get_stats +- fullName: gc.get_threshold + href: https://docs.python.org/3/library/gc.html#gc.get_threshold + name: get_threshold + uid: gc.get_threshold +- fullName: gc.is_finalized + href: https://docs.python.org/3/library/gc.html#gc.is_finalized + name: is_finalized + uid: gc.is_finalized +- fullName: gc.is_tracked + href: https://docs.python.org/3/library/gc.html#gc.is_tracked + name: is_tracked + uid: gc.is_tracked +- fullName: gc.isenabled + href: https://docs.python.org/3/library/gc.html#gc.isenabled + name: isenabled + uid: gc.isenabled +- fullName: gc.set_debug + href: https://docs.python.org/3/library/gc.html#gc.set_debug + name: set_debug + uid: gc.set_debug +- fullName: gc.set_threshold + href: https://docs.python.org/3/library/gc.html#gc.set_threshold + name: set_threshold + uid: gc.set_threshold +- fullName: gc.unfreeze + href: https://docs.python.org/3/library/gc.html#gc.unfreeze + name: unfreeze + uid: gc.unfreeze +- fullName: getattr + href: https://docs.python.org/3/library/functions.html#getattr + name: getattr + uid: getattr +- fullName: getopt.getopt + href: https://docs.python.org/3/library/getopt.html#getopt.getopt + name: getopt + uid: getopt.getopt +- fullName: getopt.gnu_getopt + href: https://docs.python.org/3/library/getopt.html#getopt.gnu_getopt + name: gnu_getopt + uid: getopt.gnu_getopt +- fullName: getpass.getpass + href: https://docs.python.org/3/library/getpass.html#getpass.getpass + name: getpass + uid: getpass.getpass +- fullName: getpass.getuser + href: https://docs.python.org/3/library/getpass.html#getpass.getuser + name: getuser + uid: getpass.getuser +- fullName: gettext.bindtextdomain + href: https://docs.python.org/3/library/gettext.html#gettext.bindtextdomain + name: bindtextdomain + uid: gettext.bindtextdomain +- fullName: gettext.dgettext + href: https://docs.python.org/3/library/gettext.html#gettext.dgettext + name: dgettext + uid: gettext.dgettext +- fullName: gettext.dngettext + href: https://docs.python.org/3/library/gettext.html#gettext.dngettext + name: dngettext + uid: gettext.dngettext +- fullName: gettext.dnpgettext + href: https://docs.python.org/3/library/gettext.html#gettext.dnpgettext + name: dnpgettext + uid: gettext.dnpgettext +- fullName: gettext.dpgettext + href: https://docs.python.org/3/library/gettext.html#gettext.dpgettext + name: dpgettext + uid: gettext.dpgettext +- fullName: gettext.find + href: https://docs.python.org/3/library/gettext.html#gettext.find + name: find + uid: gettext.find +- fullName: gettext.gettext + href: https://docs.python.org/3/library/gettext.html#gettext.gettext + name: gettext + uid: gettext.gettext +- fullName: gettext.install + href: https://docs.python.org/3/library/gettext.html#gettext.install + name: install + uid: gettext.install +- fullName: gettext.ngettext + href: https://docs.python.org/3/library/gettext.html#gettext.ngettext + name: ngettext + uid: gettext.ngettext +- fullName: gettext.npgettext + href: https://docs.python.org/3/library/gettext.html#gettext.npgettext + name: npgettext + uid: gettext.npgettext +- fullName: gettext.pgettext + href: https://docs.python.org/3/library/gettext.html#gettext.pgettext + name: pgettext + uid: gettext.pgettext +- fullName: gettext.textdomain + href: https://docs.python.org/3/library/gettext.html#gettext.textdomain + name: textdomain + uid: gettext.textdomain +- fullName: gettext.translation + href: https://docs.python.org/3/library/gettext.html#gettext.translation + name: translation + uid: gettext.translation +- fullName: glob.escape + href: https://docs.python.org/3/library/glob.html#glob.escape + name: escape + uid: glob.escape +- fullName: glob.glob + href: https://docs.python.org/3/library/glob.html#glob.glob + name: glob + uid: glob.glob +- fullName: glob.iglob + href: https://docs.python.org/3/library/glob.html#glob.iglob + name: iglob + uid: glob.iglob +- fullName: glob.translate + href: https://docs.python.org/3/library/glob.html#glob.translate + name: translate + uid: glob.translate +- fullName: globals + href: https://docs.python.org/3/library/functions.html#globals + name: globals + uid: globals +- fullName: grp.getgrall + href: https://docs.python.org/3/library/grp.html#grp.getgrall + name: getgrall + uid: grp.getgrall +- fullName: grp.getgrgid + href: https://docs.python.org/3/library/grp.html#grp.getgrgid + name: getgrgid + uid: grp.getgrgid +- fullName: grp.getgrnam + href: https://docs.python.org/3/library/grp.html#grp.getgrnam + name: getgrnam + uid: grp.getgrnam +- fullName: gzip.compress + href: https://docs.python.org/3/library/gzip.html#gzip.compress + name: compress + uid: gzip.compress +- fullName: gzip.decompress + href: https://docs.python.org/3/library/gzip.html#gzip.decompress + name: decompress + uid: gzip.decompress +- fullName: gzip.open + href: https://docs.python.org/3/library/gzip.html#gzip.open + name: open + uid: gzip.open +- fullName: hasattr + href: https://docs.python.org/3/library/functions.html#hasattr + name: hasattr + uid: hasattr +- fullName: hash + href: https://docs.python.org/3/library/functions.html#hash + name: hash + uid: hash +- fullName: hashlib.blake2b + href: https://docs.python.org/3/library/hashlib.html#hashlib.blake2b + name: blake2b + uid: hashlib.blake2b +- fullName: hashlib.blake2s + href: https://docs.python.org/3/library/hashlib.html#hashlib.blake2s + name: blake2s + uid: hashlib.blake2s +- fullName: hashlib.file_digest + href: https://docs.python.org/3/library/hashlib.html#hashlib.file_digest + name: file_digest + uid: hashlib.file_digest +- fullName: hashlib.md5 + href: https://docs.python.org/3/library/hashlib.html#hashlib.md5 + name: md5 + uid: hashlib.md5 +- fullName: hashlib.new + href: https://docs.python.org/3/library/hashlib.html#hashlib.new + name: new + uid: hashlib.new +- fullName: hashlib.pbkdf2_hmac + href: https://docs.python.org/3/library/hashlib.html#hashlib.pbkdf2_hmac + name: pbkdf2_hmac + uid: hashlib.pbkdf2_hmac +- fullName: hashlib.scrypt + href: https://docs.python.org/3/library/hashlib.html#hashlib.scrypt + name: scrypt + uid: hashlib.scrypt +- fullName: hashlib.sha1 + href: https://docs.python.org/3/library/hashlib.html#hashlib.sha1 + name: sha1 + uid: hashlib.sha1 +- fullName: hashlib.sha224 + href: https://docs.python.org/3/library/hashlib.html#hashlib.sha224 + name: sha224 + uid: hashlib.sha224 +- fullName: hashlib.sha256 + href: https://docs.python.org/3/library/hashlib.html#hashlib.sha256 + name: sha256 + uid: hashlib.sha256 +- fullName: hashlib.sha384 + href: https://docs.python.org/3/library/hashlib.html#hashlib.sha384 + name: sha384 + uid: hashlib.sha384 +- fullName: hashlib.sha3_224 + href: https://docs.python.org/3/library/hashlib.html#hashlib.sha3_224 + name: sha3_224 + uid: hashlib.sha3_224 +- fullName: hashlib.sha3_256 + href: https://docs.python.org/3/library/hashlib.html#hashlib.sha3_256 + name: sha3_256 + uid: hashlib.sha3_256 +- fullName: hashlib.sha3_384 + href: https://docs.python.org/3/library/hashlib.html#hashlib.sha3_384 + name: sha3_384 + uid: hashlib.sha3_384 +- fullName: hashlib.sha3_512 + href: https://docs.python.org/3/library/hashlib.html#hashlib.sha3_512 + name: sha3_512 + uid: hashlib.sha3_512 +- fullName: hashlib.sha512 + href: https://docs.python.org/3/library/hashlib.html#hashlib.sha512 + name: sha512 + uid: hashlib.sha512 +- fullName: hashlib.shake_128 + href: https://docs.python.org/3/library/hashlib.html#hashlib.shake_128 + name: shake_128 + uid: hashlib.shake_128 +- fullName: hashlib.shake_256 + href: https://docs.python.org/3/library/hashlib.html#hashlib.shake_256 + name: shake_256 + uid: hashlib.shake_256 +- fullName: heapq.heapify + href: https://docs.python.org/3/library/heapq.html#heapq.heapify + name: heapify + uid: heapq.heapify +- fullName: heapq.heappop + href: https://docs.python.org/3/library/heapq.html#heapq.heappop + name: heappop + uid: heapq.heappop +- fullName: heapq.heappush + href: https://docs.python.org/3/library/heapq.html#heapq.heappush + name: heappush + uid: heapq.heappush +- fullName: heapq.heappushpop + href: https://docs.python.org/3/library/heapq.html#heapq.heappushpop + name: heappushpop + uid: heapq.heappushpop +- fullName: heapq.heapreplace + href: https://docs.python.org/3/library/heapq.html#heapq.heapreplace + name: heapreplace + uid: heapq.heapreplace +- fullName: heapq.merge + href: https://docs.python.org/3/library/heapq.html#heapq.merge + name: merge + uid: heapq.merge +- fullName: heapq.nlargest + href: https://docs.python.org/3/library/heapq.html#heapq.nlargest + name: nlargest + uid: heapq.nlargest +- fullName: heapq.nsmallest + href: https://docs.python.org/3/library/heapq.html#heapq.nsmallest + name: nsmallest + uid: heapq.nsmallest +- fullName: help + href: https://docs.python.org/3/library/functions.html#help + name: help + uid: help +- fullName: hex + href: https://docs.python.org/3/library/functions.html#hex + name: hex + uid: hex +- fullName: hmac.compare_digest + href: https://docs.python.org/3/library/hmac.html#hmac.compare_digest + name: compare_digest + uid: hmac.compare_digest +- fullName: hmac.digest + href: https://docs.python.org/3/library/hmac.html#hmac.digest + name: digest + uid: hmac.digest +- fullName: hmac.new + href: https://docs.python.org/3/library/hmac.html#hmac.new + name: new + uid: hmac.new +- fullName: html.escape + href: https://docs.python.org/3/library/html.html#html.escape + name: escape + uid: html.escape +- fullName: html.unescape + href: https://docs.python.org/3/library/html.html#html.unescape + name: unescape + uid: html.unescape +- fullName: http.client.parse_headers + href: https://docs.python.org/3/library/http.client.html#http.client.parse_headers + name: parse_headers + uid: http.client.parse_headers +- fullName: id + href: https://docs.python.org/3/library/functions.html#id + name: id + uid: id +- fullName: imaplib.Int2AP + href: https://docs.python.org/3/library/imaplib.html#imaplib.Int2AP + name: Int2AP + uid: imaplib.Int2AP +- fullName: imaplib.Internaldate2tuple + href: https://docs.python.org/3/library/imaplib.html#imaplib.Internaldate2tuple + name: Internaldate2tuple + uid: imaplib.Internaldate2tuple +- fullName: imaplib.ParseFlags + href: https://docs.python.org/3/library/imaplib.html#imaplib.ParseFlags + name: ParseFlags + uid: imaplib.ParseFlags +- fullName: imaplib.Time2Internaldate + href: https://docs.python.org/3/library/imaplib.html#imaplib.Time2Internaldate + name: Time2Internaldate + uid: imaplib.Time2Internaldate +- fullName: importlib.__import__ + href: https://docs.python.org/3/library/importlib.html#importlib.__import__ + name: __import__ + uid: importlib.__import__ +- fullName: importlib.import_module + href: https://docs.python.org/3/library/importlib.html#importlib.import_module + name: import_module + uid: importlib.import_module +- fullName: importlib.invalidate_caches + href: https://docs.python.org/3/library/importlib.html#importlib.invalidate_caches + name: invalidate_caches + uid: importlib.invalidate_caches +- fullName: importlib.machinery.all_suffixes + href: https://docs.python.org/3/library/importlib.html#importlib.machinery.all_suffixes + name: all_suffixes + uid: importlib.machinery.all_suffixes +- fullName: importlib.metadata.distribution + href: https://docs.python.org/3/library/importlib.metadata.html#importlib.metadata.distribution + name: distribution + uid: importlib.metadata.distribution +- fullName: importlib.metadata.entry_points + href: https://docs.python.org/3/library/importlib.metadata.html#importlib.metadata.entry_points + name: entry_points + uid: importlib.metadata.entry_points +- fullName: importlib.metadata.files + href: https://docs.python.org/3/library/importlib.metadata.html#importlib.metadata.files + name: files + uid: importlib.metadata.files +- fullName: importlib.metadata.metadata + href: https://docs.python.org/3/library/importlib.metadata.html#importlib.metadata.metadata + name: metadata + uid: importlib.metadata.metadata +- fullName: importlib.metadata.packages_distributions + href: https://docs.python.org/3/library/importlib.metadata.html#importlib.metadata.packages_distributions + name: packages_distributions + uid: importlib.metadata.packages_distributions +- fullName: importlib.metadata.requires + href: https://docs.python.org/3/library/importlib.metadata.html#importlib.metadata.requires + name: requires + uid: importlib.metadata.requires +- fullName: importlib.metadata.version + href: https://docs.python.org/3/library/importlib.metadata.html#importlib.metadata.version + name: version + uid: importlib.metadata.version +- fullName: importlib.reload + href: https://docs.python.org/3/library/importlib.html#importlib.reload + name: reload + uid: importlib.reload +- fullName: importlib.resources.as_file + href: https://docs.python.org/3/library/importlib.resources.html#importlib.resources.as_file + name: as_file + uid: importlib.resources.as_file +- fullName: importlib.resources.contents + href: https://docs.python.org/3/library/importlib.resources.html#importlib.resources.contents + name: contents + uid: importlib.resources.contents +- fullName: importlib.resources.files + href: https://docs.python.org/3/library/importlib.resources.html#importlib.resources.files + name: files + uid: importlib.resources.files +- fullName: importlib.resources.is_resource + href: https://docs.python.org/3/library/importlib.resources.html#importlib.resources.is_resource + name: is_resource + uid: importlib.resources.is_resource +- fullName: importlib.resources.open_binary + href: https://docs.python.org/3/library/importlib.resources.html#importlib.resources.open_binary + name: open_binary + uid: importlib.resources.open_binary +- fullName: importlib.resources.open_text + href: https://docs.python.org/3/library/importlib.resources.html#importlib.resources.open_text + name: open_text + uid: importlib.resources.open_text +- fullName: importlib.resources.path + href: https://docs.python.org/3/library/importlib.resources.html#importlib.resources.path + name: path + uid: importlib.resources.path +- fullName: importlib.resources.read_binary + href: https://docs.python.org/3/library/importlib.resources.html#importlib.resources.read_binary + name: read_binary + uid: importlib.resources.read_binary +- fullName: importlib.resources.read_text + href: https://docs.python.org/3/library/importlib.resources.html#importlib.resources.read_text + name: read_text + uid: importlib.resources.read_text +- fullName: importlib.util._incompatible_extension_module_restrictions + href: https://docs.python.org/3/library/importlib.html#importlib.util._incompatible_extension_module_restrictions + name: _incompatible_extension_module_restrictions + uid: importlib.util._incompatible_extension_module_restrictions +- fullName: importlib.util.cache_from_source + href: https://docs.python.org/3/library/importlib.html#importlib.util.cache_from_source + name: cache_from_source + uid: importlib.util.cache_from_source +- fullName: importlib.util.decode_source + href: https://docs.python.org/3/library/importlib.html#importlib.util.decode_source + name: decode_source + uid: importlib.util.decode_source +- fullName: importlib.util.find_spec + href: https://docs.python.org/3/library/importlib.html#importlib.util.find_spec + name: find_spec + uid: importlib.util.find_spec +- fullName: importlib.util.module_from_spec + href: https://docs.python.org/3/library/importlib.html#importlib.util.module_from_spec + name: module_from_spec + uid: importlib.util.module_from_spec +- fullName: importlib.util.resolve_name + href: https://docs.python.org/3/library/importlib.html#importlib.util.resolve_name + name: resolve_name + uid: importlib.util.resolve_name +- fullName: importlib.util.source_from_cache + href: https://docs.python.org/3/library/importlib.html#importlib.util.source_from_cache + name: source_from_cache + uid: importlib.util.source_from_cache +- fullName: importlib.util.source_hash + href: https://docs.python.org/3/library/importlib.html#importlib.util.source_hash + name: source_hash + uid: importlib.util.source_hash +- fullName: importlib.util.spec_from_file_location + href: https://docs.python.org/3/library/importlib.html#importlib.util.spec_from_file_location + name: spec_from_file_location + uid: importlib.util.spec_from_file_location +- fullName: importlib.util.spec_from_loader + href: https://docs.python.org/3/library/importlib.html#importlib.util.spec_from_loader + name: spec_from_loader + uid: importlib.util.spec_from_loader +- fullName: input + href: https://docs.python.org/3/library/functions.html#input + name: input + uid: input +- fullName: inspect.cleandoc + href: https://docs.python.org/3/library/inspect.html#inspect.cleandoc + name: cleandoc + uid: inspect.cleandoc +- fullName: inspect.currentframe + href: https://docs.python.org/3/library/inspect.html#inspect.currentframe + name: currentframe + uid: inspect.currentframe +- fullName: inspect.formatargvalues + href: https://docs.python.org/3/library/inspect.html#inspect.formatargvalues + name: formatargvalues + uid: inspect.formatargvalues +- fullName: inspect.get_annotations + href: https://docs.python.org/3/library/inspect.html#inspect.get_annotations + name: get_annotations + uid: inspect.get_annotations +- fullName: inspect.getargvalues + href: https://docs.python.org/3/library/inspect.html#inspect.getargvalues + name: getargvalues + uid: inspect.getargvalues +- fullName: inspect.getasyncgenlocals + href: https://docs.python.org/3/library/inspect.html#inspect.getasyncgenlocals + name: getasyncgenlocals + uid: inspect.getasyncgenlocals +- fullName: inspect.getasyncgenstate + href: https://docs.python.org/3/library/inspect.html#inspect.getasyncgenstate + name: getasyncgenstate + uid: inspect.getasyncgenstate +- fullName: inspect.getattr_static + href: https://docs.python.org/3/library/inspect.html#inspect.getattr_static + name: getattr_static + uid: inspect.getattr_static +- fullName: inspect.getcallargs + href: https://docs.python.org/3/library/inspect.html#inspect.getcallargs + name: getcallargs + uid: inspect.getcallargs +- fullName: inspect.getclasstree + href: https://docs.python.org/3/library/inspect.html#inspect.getclasstree + name: getclasstree + uid: inspect.getclasstree +- fullName: inspect.getclosurevars + href: https://docs.python.org/3/library/inspect.html#inspect.getclosurevars + name: getclosurevars + uid: inspect.getclosurevars +- fullName: inspect.getcomments + href: https://docs.python.org/3/library/inspect.html#inspect.getcomments + name: getcomments + uid: inspect.getcomments +- fullName: inspect.getcoroutinelocals + href: https://docs.python.org/3/library/inspect.html#inspect.getcoroutinelocals + name: getcoroutinelocals + uid: inspect.getcoroutinelocals +- fullName: inspect.getcoroutinestate + href: https://docs.python.org/3/library/inspect.html#inspect.getcoroutinestate + name: getcoroutinestate + uid: inspect.getcoroutinestate +- fullName: inspect.getdoc + href: https://docs.python.org/3/library/inspect.html#inspect.getdoc + name: getdoc + uid: inspect.getdoc +- fullName: inspect.getfile + href: https://docs.python.org/3/library/inspect.html#inspect.getfile + name: getfile + uid: inspect.getfile +- fullName: inspect.getframeinfo + href: https://docs.python.org/3/library/inspect.html#inspect.getframeinfo + name: getframeinfo + uid: inspect.getframeinfo +- fullName: inspect.getfullargspec + href: https://docs.python.org/3/library/inspect.html#inspect.getfullargspec + name: getfullargspec + uid: inspect.getfullargspec +- fullName: inspect.getgeneratorlocals + href: https://docs.python.org/3/library/inspect.html#inspect.getgeneratorlocals + name: getgeneratorlocals + uid: inspect.getgeneratorlocals +- fullName: inspect.getgeneratorstate + href: https://docs.python.org/3/library/inspect.html#inspect.getgeneratorstate + name: getgeneratorstate + uid: inspect.getgeneratorstate +- fullName: inspect.getinnerframes + href: https://docs.python.org/3/library/inspect.html#inspect.getinnerframes + name: getinnerframes + uid: inspect.getinnerframes +- fullName: inspect.getmembers + href: https://docs.python.org/3/library/inspect.html#inspect.getmembers + name: getmembers + uid: inspect.getmembers +- fullName: inspect.getmembers_static + href: https://docs.python.org/3/library/inspect.html#inspect.getmembers_static + name: getmembers_static + uid: inspect.getmembers_static +- fullName: inspect.getmodule + href: https://docs.python.org/3/library/inspect.html#inspect.getmodule + name: getmodule + uid: inspect.getmodule +- fullName: inspect.getmodulename + href: https://docs.python.org/3/library/inspect.html#inspect.getmodulename + name: getmodulename + uid: inspect.getmodulename +- fullName: inspect.getmro + href: https://docs.python.org/3/library/inspect.html#inspect.getmro + name: getmro + uid: inspect.getmro +- fullName: inspect.getouterframes + href: https://docs.python.org/3/library/inspect.html#inspect.getouterframes + name: getouterframes + uid: inspect.getouterframes +- fullName: inspect.getsource + href: https://docs.python.org/3/library/inspect.html#inspect.getsource + name: getsource + uid: inspect.getsource +- fullName: inspect.getsourcefile + href: https://docs.python.org/3/library/inspect.html#inspect.getsourcefile + name: getsourcefile + uid: inspect.getsourcefile +- fullName: inspect.getsourcelines + href: https://docs.python.org/3/library/inspect.html#inspect.getsourcelines + name: getsourcelines + uid: inspect.getsourcelines +- fullName: inspect.isabstract + href: https://docs.python.org/3/library/inspect.html#inspect.isabstract + name: isabstract + uid: inspect.isabstract +- fullName: inspect.isasyncgen + href: https://docs.python.org/3/library/inspect.html#inspect.isasyncgen + name: isasyncgen + uid: inspect.isasyncgen +- fullName: inspect.isasyncgenfunction + href: https://docs.python.org/3/library/inspect.html#inspect.isasyncgenfunction + name: isasyncgenfunction + uid: inspect.isasyncgenfunction +- fullName: inspect.isawaitable + href: https://docs.python.org/3/library/inspect.html#inspect.isawaitable + name: isawaitable + uid: inspect.isawaitable +- fullName: inspect.isbuiltin + href: https://docs.python.org/3/library/inspect.html#inspect.isbuiltin + name: isbuiltin + uid: inspect.isbuiltin +- fullName: inspect.isclass + href: https://docs.python.org/3/library/inspect.html#inspect.isclass + name: isclass + uid: inspect.isclass +- fullName: inspect.iscode + href: https://docs.python.org/3/library/inspect.html#inspect.iscode + name: iscode + uid: inspect.iscode +- fullName: inspect.iscoroutine + href: https://docs.python.org/3/library/inspect.html#inspect.iscoroutine + name: iscoroutine + uid: inspect.iscoroutine +- fullName: inspect.iscoroutinefunction + href: https://docs.python.org/3/library/inspect.html#inspect.iscoroutinefunction + name: iscoroutinefunction + uid: inspect.iscoroutinefunction +- fullName: inspect.isdatadescriptor + href: https://docs.python.org/3/library/inspect.html#inspect.isdatadescriptor + name: isdatadescriptor + uid: inspect.isdatadescriptor +- fullName: inspect.isframe + href: https://docs.python.org/3/library/inspect.html#inspect.isframe + name: isframe + uid: inspect.isframe +- fullName: inspect.isfunction + href: https://docs.python.org/3/library/inspect.html#inspect.isfunction + name: isfunction + uid: inspect.isfunction +- fullName: inspect.isgenerator + href: https://docs.python.org/3/library/inspect.html#inspect.isgenerator + name: isgenerator + uid: inspect.isgenerator +- fullName: inspect.isgeneratorfunction + href: https://docs.python.org/3/library/inspect.html#inspect.isgeneratorfunction + name: isgeneratorfunction + uid: inspect.isgeneratorfunction +- fullName: inspect.isgetsetdescriptor + href: https://docs.python.org/3/library/inspect.html#inspect.isgetsetdescriptor + name: isgetsetdescriptor + uid: inspect.isgetsetdescriptor +- fullName: inspect.ismemberdescriptor + href: https://docs.python.org/3/library/inspect.html#inspect.ismemberdescriptor + name: ismemberdescriptor + uid: inspect.ismemberdescriptor +- fullName: inspect.ismethod + href: https://docs.python.org/3/library/inspect.html#inspect.ismethod + name: ismethod + uid: inspect.ismethod +- fullName: inspect.ismethoddescriptor + href: https://docs.python.org/3/library/inspect.html#inspect.ismethoddescriptor + name: ismethoddescriptor + uid: inspect.ismethoddescriptor +- fullName: inspect.ismethodwrapper + href: https://docs.python.org/3/library/inspect.html#inspect.ismethodwrapper + name: ismethodwrapper + uid: inspect.ismethodwrapper +- fullName: inspect.ismodule + href: https://docs.python.org/3/library/inspect.html#inspect.ismodule + name: ismodule + uid: inspect.ismodule +- fullName: inspect.isroutine + href: https://docs.python.org/3/library/inspect.html#inspect.isroutine + name: isroutine + uid: inspect.isroutine +- fullName: inspect.istraceback + href: https://docs.python.org/3/library/inspect.html#inspect.istraceback + name: istraceback + uid: inspect.istraceback +- fullName: inspect.markcoroutinefunction + href: https://docs.python.org/3/library/inspect.html#inspect.markcoroutinefunction + name: markcoroutinefunction + uid: inspect.markcoroutinefunction +- fullName: inspect.signature + href: https://docs.python.org/3/library/inspect.html#inspect.signature + name: signature + uid: inspect.signature +- fullName: inspect.stack + href: https://docs.python.org/3/library/inspect.html#inspect.stack + name: stack + uid: inspect.stack +- fullName: inspect.trace + href: https://docs.python.org/3/library/inspect.html#inspect.trace + name: trace + uid: inspect.trace +- fullName: inspect.unwrap + href: https://docs.python.org/3/library/inspect.html#inspect.unwrap + name: unwrap + uid: inspect.unwrap +- fullName: io.open + href: https://docs.python.org/3/library/io.html#io.open + name: open + uid: io.open +- fullName: io.open_code + href: https://docs.python.org/3/library/io.html#io.open_code + name: open_code + uid: io.open_code +- fullName: io.text_encoding + href: https://docs.python.org/3/library/io.html#io.text_encoding + name: text_encoding + uid: io.text_encoding +- fullName: ipaddress.collapse_addresses + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.collapse_addresses + name: collapse_addresses + uid: ipaddress.collapse_addresses +- fullName: ipaddress.get_mixed_type_key + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.get_mixed_type_key + name: get_mixed_type_key + uid: ipaddress.get_mixed_type_key +- fullName: ipaddress.ip_address + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.ip_address + name: ip_address + uid: ipaddress.ip_address +- fullName: ipaddress.ip_interface + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.ip_interface + name: ip_interface + uid: ipaddress.ip_interface +- fullName: ipaddress.ip_network + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.ip_network + name: ip_network + uid: ipaddress.ip_network +- fullName: ipaddress.summarize_address_range + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.summarize_address_range + name: summarize_address_range + uid: ipaddress.summarize_address_range +- fullName: ipaddress.v4_int_to_packed + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.v4_int_to_packed + name: v4_int_to_packed + uid: ipaddress.v4_int_to_packed +- fullName: ipaddress.v6_int_to_packed + href: https://docs.python.org/3/library/ipaddress.html#ipaddress.v6_int_to_packed + name: v6_int_to_packed + uid: ipaddress.v6_int_to_packed +- fullName: isinstance + href: https://docs.python.org/3/library/functions.html#isinstance + name: isinstance + uid: isinstance +- fullName: issubclass + href: https://docs.python.org/3/library/functions.html#issubclass + name: issubclass + uid: issubclass +- fullName: iter + href: https://docs.python.org/3/library/functions.html#iter + name: iter + uid: iter +- fullName: itertools.accumulate + href: https://docs.python.org/3/library/itertools.html#itertools.accumulate + name: accumulate + uid: itertools.accumulate +- fullName: itertools.batched + href: https://docs.python.org/3/library/itertools.html#itertools.batched + name: batched + uid: itertools.batched +- fullName: itertools.chain + href: https://docs.python.org/3/library/itertools.html#itertools.chain + name: chain + uid: itertools.chain +- fullName: itertools.combinations + href: https://docs.python.org/3/library/itertools.html#itertools.combinations + name: combinations + uid: itertools.combinations +- fullName: itertools.combinations_with_replacement + href: https://docs.python.org/3/library/itertools.html#itertools.combinations_with_replacement + name: combinations_with_replacement + uid: itertools.combinations_with_replacement +- fullName: itertools.compress + href: https://docs.python.org/3/library/itertools.html#itertools.compress + name: compress + uid: itertools.compress +- fullName: itertools.count + href: https://docs.python.org/3/library/itertools.html#itertools.count + name: count + uid: itertools.count +- fullName: itertools.cycle + href: https://docs.python.org/3/library/itertools.html#itertools.cycle + name: cycle + uid: itertools.cycle +- fullName: itertools.dropwhile + href: https://docs.python.org/3/library/itertools.html#itertools.dropwhile + name: dropwhile + uid: itertools.dropwhile +- fullName: itertools.filterfalse + href: https://docs.python.org/3/library/itertools.html#itertools.filterfalse + name: filterfalse + uid: itertools.filterfalse +- fullName: itertools.groupby + href: https://docs.python.org/3/library/itertools.html#itertools.groupby + name: groupby + uid: itertools.groupby +- fullName: itertools.islice + href: https://docs.python.org/3/library/itertools.html#itertools.islice + name: islice + uid: itertools.islice +- fullName: itertools.pairwise + href: https://docs.python.org/3/library/itertools.html#itertools.pairwise + name: pairwise + uid: itertools.pairwise +- fullName: itertools.permutations + href: https://docs.python.org/3/library/itertools.html#itertools.permutations + name: permutations + uid: itertools.permutations +- fullName: itertools.product + href: https://docs.python.org/3/library/itertools.html#itertools.product + name: product + uid: itertools.product +- fullName: itertools.repeat + href: https://docs.python.org/3/library/itertools.html#itertools.repeat + name: repeat + uid: itertools.repeat +- fullName: itertools.starmap + href: https://docs.python.org/3/library/itertools.html#itertools.starmap + name: starmap + uid: itertools.starmap +- fullName: itertools.takewhile + href: https://docs.python.org/3/library/itertools.html#itertools.takewhile + name: takewhile + uid: itertools.takewhile +- fullName: itertools.tee + href: https://docs.python.org/3/library/itertools.html#itertools.tee + name: tee + uid: itertools.tee +- fullName: itertools.zip_longest + href: https://docs.python.org/3/library/itertools.html#itertools.zip_longest + name: zip_longest + uid: itertools.zip_longest +- fullName: json.dump + href: https://docs.python.org/3/library/json.html#json.dump + name: dump + uid: json.dump +- fullName: json.dumps + href: https://docs.python.org/3/library/json.html#json.dumps + name: dumps + uid: json.dumps +- fullName: json.load + href: https://docs.python.org/3/library/json.html#json.load + name: load + uid: json.load +- fullName: json.loads + href: https://docs.python.org/3/library/json.html#json.loads + name: loads + uid: json.loads +- fullName: keyword.iskeyword + href: https://docs.python.org/3/library/keyword.html#keyword.iskeyword + name: iskeyword + uid: keyword.iskeyword +- fullName: keyword.issoftkeyword + href: https://docs.python.org/3/library/keyword.html#keyword.issoftkeyword + name: issoftkeyword + uid: keyword.issoftkeyword +- fullName: len + href: https://docs.python.org/3/library/functions.html#len + name: len + uid: len +- fullName: linecache.checkcache + href: https://docs.python.org/3/library/linecache.html#linecache.checkcache + name: checkcache + uid: linecache.checkcache +- fullName: linecache.clearcache + href: https://docs.python.org/3/library/linecache.html#linecache.clearcache + name: clearcache + uid: linecache.clearcache +- fullName: linecache.getline + href: https://docs.python.org/3/library/linecache.html#linecache.getline + name: getline + uid: linecache.getline +- fullName: linecache.lazycache + href: https://docs.python.org/3/library/linecache.html#linecache.lazycache + name: lazycache + uid: linecache.lazycache +- fullName: locale.atof + href: https://docs.python.org/3/library/locale.html#locale.atof + name: atof + uid: locale.atof +- fullName: locale.atoi + href: https://docs.python.org/3/library/locale.html#locale.atoi + name: atoi + uid: locale.atoi +- fullName: locale.bind_textdomain_codeset + href: https://docs.python.org/3/library/locale.html#locale.bind_textdomain_codeset + name: bind_textdomain_codeset + uid: locale.bind_textdomain_codeset +- fullName: locale.bindtextdomain + href: https://docs.python.org/3/library/locale.html#locale.bindtextdomain + name: bindtextdomain + uid: locale.bindtextdomain +- fullName: locale.currency + href: https://docs.python.org/3/library/locale.html#locale.currency + name: currency + uid: locale.currency +- fullName: locale.dcgettext + href: https://docs.python.org/3/library/locale.html#locale.dcgettext + name: dcgettext + uid: locale.dcgettext +- fullName: locale.delocalize + href: https://docs.python.org/3/library/locale.html#locale.delocalize + name: delocalize + uid: locale.delocalize +- fullName: locale.dgettext + href: https://docs.python.org/3/library/locale.html#locale.dgettext + name: dgettext + uid: locale.dgettext +- fullName: locale.format_string + href: https://docs.python.org/3/library/locale.html#locale.format_string + name: format_string + uid: locale.format_string +- fullName: locale.getdefaultlocale + href: https://docs.python.org/3/library/locale.html#locale.getdefaultlocale + name: getdefaultlocale + uid: locale.getdefaultlocale +- fullName: locale.getencoding + href: https://docs.python.org/3/library/locale.html#locale.getencoding + name: getencoding + uid: locale.getencoding +- fullName: locale.getlocale + href: https://docs.python.org/3/library/locale.html#locale.getlocale + name: getlocale + uid: locale.getlocale +- fullName: locale.getpreferredencoding + href: https://docs.python.org/3/library/locale.html#locale.getpreferredencoding + name: getpreferredencoding + uid: locale.getpreferredencoding +- fullName: locale.gettext + href: https://docs.python.org/3/library/locale.html#locale.gettext + name: gettext + uid: locale.gettext +- fullName: locale.localeconv + href: https://docs.python.org/3/library/locale.html#locale.localeconv + name: localeconv + uid: locale.localeconv +- fullName: locale.localize + href: https://docs.python.org/3/library/locale.html#locale.localize + name: localize + uid: locale.localize +- fullName: locale.nl_langinfo + href: https://docs.python.org/3/library/locale.html#locale.nl_langinfo + name: nl_langinfo + uid: locale.nl_langinfo +- fullName: locale.normalize + href: https://docs.python.org/3/library/locale.html#locale.normalize + name: normalize + uid: locale.normalize +- fullName: locale.setlocale + href: https://docs.python.org/3/library/locale.html#locale.setlocale + name: setlocale + uid: locale.setlocale +- fullName: locale.str + href: https://docs.python.org/3/library/locale.html#locale.str + name: str + uid: locale.str +- fullName: locale.strcoll + href: https://docs.python.org/3/library/locale.html#locale.strcoll + name: strcoll + uid: locale.strcoll +- fullName: locale.strxfrm + href: https://docs.python.org/3/library/locale.html#locale.strxfrm + name: strxfrm + uid: locale.strxfrm +- fullName: locale.textdomain + href: https://docs.python.org/3/library/locale.html#locale.textdomain + name: textdomain + uid: locale.textdomain +- fullName: locals + href: https://docs.python.org/3/library/functions.html#locals + name: locals + uid: locals +- fullName: logging.addLevelName + href: https://docs.python.org/3/library/logging.html#logging.addLevelName + name: addLevelName + uid: logging.addLevelName +- fullName: logging.basicConfig + href: https://docs.python.org/3/library/logging.html#logging.basicConfig + name: basicConfig + uid: logging.basicConfig +- fullName: logging.captureWarnings + href: https://docs.python.org/3/library/logging.html#logging.captureWarnings + name: captureWarnings + uid: logging.captureWarnings +- fullName: logging.config.dictConfig + href: https://docs.python.org/3/library/logging.config.html#logging.config.dictConfig + name: dictConfig + uid: logging.config.dictConfig +- fullName: logging.config.fileConfig + href: https://docs.python.org/3/library/logging.config.html#logging.config.fileConfig + name: fileConfig + uid: logging.config.fileConfig +- fullName: logging.config.listen + href: https://docs.python.org/3/library/logging.config.html#logging.config.listen + name: listen + uid: logging.config.listen +- fullName: logging.config.stopListening + href: https://docs.python.org/3/library/logging.config.html#logging.config.stopListening + name: stopListening + uid: logging.config.stopListening +- fullName: logging.critical + href: https://docs.python.org/3/library/logging.html#logging.critical + name: critical + uid: logging.critical +- fullName: logging.debug + href: https://docs.python.org/3/library/logging.html#logging.debug + name: debug + uid: logging.debug +- fullName: logging.disable + href: https://docs.python.org/3/library/logging.html#logging.disable + name: disable + uid: logging.disable +- fullName: logging.error + href: https://docs.python.org/3/library/logging.html#logging.error + name: error + uid: logging.error +- fullName: logging.exception + href: https://docs.python.org/3/library/logging.html#logging.exception + name: exception + uid: logging.exception +- fullName: logging.getHandlerByName + href: https://docs.python.org/3/library/logging.html#logging.getHandlerByName + name: getHandlerByName + uid: logging.getHandlerByName +- fullName: logging.getHandlerNames + href: https://docs.python.org/3/library/logging.html#logging.getHandlerNames + name: getHandlerNames + uid: logging.getHandlerNames +- fullName: logging.getLevelName + href: https://docs.python.org/3/library/logging.html#logging.getLevelName + name: getLevelName + uid: logging.getLevelName +- fullName: logging.getLevelNamesMapping + href: https://docs.python.org/3/library/logging.html#logging.getLevelNamesMapping + name: getLevelNamesMapping + uid: logging.getLevelNamesMapping +- fullName: logging.getLogRecordFactory + href: https://docs.python.org/3/library/logging.html#logging.getLogRecordFactory + name: getLogRecordFactory + uid: logging.getLogRecordFactory +- fullName: logging.getLogger + href: https://docs.python.org/3/library/logging.html#logging.getLogger + name: getLogger + uid: logging.getLogger +- fullName: logging.getLoggerClass + href: https://docs.python.org/3/library/logging.html#logging.getLoggerClass + name: getLoggerClass + uid: logging.getLoggerClass +- fullName: logging.info + href: https://docs.python.org/3/library/logging.html#logging.info + name: info + uid: logging.info +- fullName: logging.log + href: https://docs.python.org/3/library/logging.html#logging.log + name: log + uid: logging.log +- fullName: logging.makeLogRecord + href: https://docs.python.org/3/library/logging.html#logging.makeLogRecord + name: makeLogRecord + uid: logging.makeLogRecord +- fullName: logging.setLogRecordFactory + href: https://docs.python.org/3/library/logging.html#logging.setLogRecordFactory + name: setLogRecordFactory + uid: logging.setLogRecordFactory +- fullName: logging.setLoggerClass + href: https://docs.python.org/3/library/logging.html#logging.setLoggerClass + name: setLoggerClass + uid: logging.setLoggerClass +- fullName: logging.shutdown + href: https://docs.python.org/3/library/logging.html#logging.shutdown + name: shutdown + uid: logging.shutdown +- fullName: logging.warning + href: https://docs.python.org/3/library/logging.html#logging.warning + name: warning + uid: logging.warning +- fullName: lzma.compress + href: https://docs.python.org/3/library/lzma.html#lzma.compress + name: compress + uid: lzma.compress +- fullName: lzma.decompress + href: https://docs.python.org/3/library/lzma.html#lzma.decompress + name: decompress + uid: lzma.decompress +- fullName: lzma.is_check_supported + href: https://docs.python.org/3/library/lzma.html#lzma.is_check_supported + name: is_check_supported + uid: lzma.is_check_supported +- fullName: lzma.open + href: https://docs.python.org/3/library/lzma.html#lzma.open + name: open + uid: lzma.open +- fullName: map + href: https://docs.python.org/3/library/functions.html#map + name: map + uid: map +- fullName: marshal.dump + href: https://docs.python.org/3/library/marshal.html#marshal.dump + name: dump + uid: marshal.dump +- fullName: marshal.dumps + href: https://docs.python.org/3/library/marshal.html#marshal.dumps + name: dumps + uid: marshal.dumps +- fullName: marshal.load + href: https://docs.python.org/3/library/marshal.html#marshal.load + name: load + uid: marshal.load +- fullName: marshal.loads + href: https://docs.python.org/3/library/marshal.html#marshal.loads + name: loads + uid: marshal.loads +- fullName: math.acos + href: https://docs.python.org/3/library/math.html#math.acos + name: acos + uid: math.acos +- fullName: math.acosh + href: https://docs.python.org/3/library/math.html#math.acosh + name: acosh + uid: math.acosh +- fullName: math.asin + href: https://docs.python.org/3/library/math.html#math.asin + name: asin + uid: math.asin +- fullName: math.asinh + href: https://docs.python.org/3/library/math.html#math.asinh + name: asinh + uid: math.asinh +- fullName: math.atan + href: https://docs.python.org/3/library/math.html#math.atan + name: atan + uid: math.atan +- fullName: math.atan2 + href: https://docs.python.org/3/library/math.html#math.atan2 + name: atan2 + uid: math.atan2 +- fullName: math.atanh + href: https://docs.python.org/3/library/math.html#math.atanh + name: atanh + uid: math.atanh +- fullName: math.cbrt + href: https://docs.python.org/3/library/math.html#math.cbrt + name: cbrt + uid: math.cbrt +- fullName: math.ceil + href: https://docs.python.org/3/library/math.html#math.ceil + name: ceil + uid: math.ceil +- fullName: math.comb + href: https://docs.python.org/3/library/math.html#math.comb + name: comb + uid: math.comb +- fullName: math.copysign + href: https://docs.python.org/3/library/math.html#math.copysign + name: copysign + uid: math.copysign +- fullName: math.cos + href: https://docs.python.org/3/library/math.html#math.cos + name: cos + uid: math.cos +- fullName: math.cosh + href: https://docs.python.org/3/library/math.html#math.cosh + name: cosh + uid: math.cosh +- fullName: math.degrees + href: https://docs.python.org/3/library/math.html#math.degrees + name: degrees + uid: math.degrees +- fullName: math.dist + href: https://docs.python.org/3/library/math.html#math.dist + name: dist + uid: math.dist +- fullName: math.erf + href: https://docs.python.org/3/library/math.html#math.erf + name: erf + uid: math.erf +- fullName: math.erfc + href: https://docs.python.org/3/library/math.html#math.erfc + name: erfc + uid: math.erfc +- fullName: math.exp + href: https://docs.python.org/3/library/math.html#math.exp + name: exp + uid: math.exp +- fullName: math.exp2 + href: https://docs.python.org/3/library/math.html#math.exp2 + name: exp2 + uid: math.exp2 +- fullName: math.expm1 + href: https://docs.python.org/3/library/math.html#math.expm1 + name: expm1 + uid: math.expm1 +- fullName: math.fabs + href: https://docs.python.org/3/library/math.html#math.fabs + name: fabs + uid: math.fabs +- fullName: math.factorial + href: https://docs.python.org/3/library/math.html#math.factorial + name: factorial + uid: math.factorial +- fullName: math.floor + href: https://docs.python.org/3/library/math.html#math.floor + name: floor + uid: math.floor +- fullName: math.fma + href: https://docs.python.org/3/library/math.html#math.fma + name: fma + uid: math.fma +- fullName: math.fmod + href: https://docs.python.org/3/library/math.html#math.fmod + name: fmod + uid: math.fmod +- fullName: math.frexp + href: https://docs.python.org/3/library/math.html#math.frexp + name: frexp + uid: math.frexp +- fullName: math.fsum + href: https://docs.python.org/3/library/math.html#math.fsum + name: fsum + uid: math.fsum +- fullName: math.gamma + href: https://docs.python.org/3/library/math.html#math.gamma + name: gamma + uid: math.gamma +- fullName: math.gcd + href: https://docs.python.org/3/library/math.html#math.gcd + name: gcd + uid: math.gcd +- fullName: math.hypot + href: https://docs.python.org/3/library/math.html#math.hypot + name: hypot + uid: math.hypot +- fullName: math.isclose + href: https://docs.python.org/3/library/math.html#math.isclose + name: isclose + uid: math.isclose +- fullName: math.isfinite + href: https://docs.python.org/3/library/math.html#math.isfinite + name: isfinite + uid: math.isfinite +- fullName: math.isinf + href: https://docs.python.org/3/library/math.html#math.isinf + name: isinf + uid: math.isinf +- fullName: math.isnan + href: https://docs.python.org/3/library/math.html#math.isnan + name: isnan + uid: math.isnan +- fullName: math.isqrt + href: https://docs.python.org/3/library/math.html#math.isqrt + name: isqrt + uid: math.isqrt +- fullName: math.lcm + href: https://docs.python.org/3/library/math.html#math.lcm + name: lcm + uid: math.lcm +- fullName: math.ldexp + href: https://docs.python.org/3/library/math.html#math.ldexp + name: ldexp + uid: math.ldexp +- fullName: math.lgamma + href: https://docs.python.org/3/library/math.html#math.lgamma + name: lgamma + uid: math.lgamma +- fullName: math.log + href: https://docs.python.org/3/library/math.html#math.log + name: log + uid: math.log +- fullName: math.log10 + href: https://docs.python.org/3/library/math.html#math.log10 + name: log10 + uid: math.log10 +- fullName: math.log1p + href: https://docs.python.org/3/library/math.html#math.log1p + name: log1p + uid: math.log1p +- fullName: math.log2 + href: https://docs.python.org/3/library/math.html#math.log2 + name: log2 + uid: math.log2 +- fullName: math.modf + href: https://docs.python.org/3/library/math.html#math.modf + name: modf + uid: math.modf +- fullName: math.nextafter + href: https://docs.python.org/3/library/math.html#math.nextafter + name: nextafter + uid: math.nextafter +- fullName: math.perm + href: https://docs.python.org/3/library/math.html#math.perm + name: perm + uid: math.perm +- fullName: math.pow + href: https://docs.python.org/3/library/math.html#math.pow + name: pow + uid: math.pow +- fullName: math.prod + href: https://docs.python.org/3/library/math.html#math.prod + name: prod + uid: math.prod +- fullName: math.radians + href: https://docs.python.org/3/library/math.html#math.radians + name: radians + uid: math.radians +- fullName: math.remainder + href: https://docs.python.org/3/library/math.html#math.remainder + name: remainder + uid: math.remainder +- fullName: math.sin + href: https://docs.python.org/3/library/math.html#math.sin + name: sin + uid: math.sin +- fullName: math.sinh + href: https://docs.python.org/3/library/math.html#math.sinh + name: sinh + uid: math.sinh +- fullName: math.sqrt + href: https://docs.python.org/3/library/math.html#math.sqrt + name: sqrt + uid: math.sqrt +- fullName: math.sumprod + href: https://docs.python.org/3/library/math.html#math.sumprod + name: sumprod + uid: math.sumprod +- fullName: math.tan + href: https://docs.python.org/3/library/math.html#math.tan + name: tan + uid: math.tan +- fullName: math.tanh + href: https://docs.python.org/3/library/math.html#math.tanh + name: tanh + uid: math.tanh +- fullName: math.trunc + href: https://docs.python.org/3/library/math.html#math.trunc + name: trunc + uid: math.trunc +- fullName: math.ulp + href: https://docs.python.org/3/library/math.html#math.ulp + name: ulp + uid: math.ulp +- fullName: max + href: https://docs.python.org/3/library/functions.html#max + name: max + uid: max +- fullName: mimetypes.add_type + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.add_type + name: add_type + uid: mimetypes.add_type +- fullName: mimetypes.guess_all_extensions + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.guess_all_extensions + name: guess_all_extensions + uid: mimetypes.guess_all_extensions +- fullName: mimetypes.guess_extension + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.guess_extension + name: guess_extension + uid: mimetypes.guess_extension +- fullName: mimetypes.guess_file_type + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.guess_file_type + name: guess_file_type + uid: mimetypes.guess_file_type +- fullName: mimetypes.guess_type + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.guess_type + name: guess_type + uid: mimetypes.guess_type +- fullName: mimetypes.init + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.init + name: init + uid: mimetypes.init +- fullName: mimetypes.read_mime_types + href: https://docs.python.org/3/library/mimetypes.html#mimetypes.read_mime_types + name: read_mime_types + uid: mimetypes.read_mime_types +- fullName: min + href: https://docs.python.org/3/library/functions.html#min + name: min + uid: min +- fullName: modulefinder.AddPackagePath + href: https://docs.python.org/3/library/modulefinder.html#modulefinder.AddPackagePath + name: AddPackagePath + uid: modulefinder.AddPackagePath +- fullName: modulefinder.ReplacePackage + href: https://docs.python.org/3/library/modulefinder.html#modulefinder.ReplacePackage + name: ReplacePackage + uid: modulefinder.ReplacePackage +- fullName: msvcrt.CrtSetReportFile + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.CrtSetReportFile + name: CrtSetReportFile + uid: msvcrt.CrtSetReportFile +- fullName: msvcrt.CrtSetReportMode + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.CrtSetReportMode + name: CrtSetReportMode + uid: msvcrt.CrtSetReportMode +- fullName: msvcrt.get_osfhandle + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.get_osfhandle + name: get_osfhandle + uid: msvcrt.get_osfhandle +- fullName: msvcrt.getch + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.getch + name: getch + uid: msvcrt.getch +- fullName: msvcrt.getche + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.getche + name: getche + uid: msvcrt.getche +- fullName: msvcrt.getwch + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.getwch + name: getwch + uid: msvcrt.getwch +- fullName: msvcrt.getwche + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.getwche + name: getwche + uid: msvcrt.getwche +- fullName: msvcrt.heapmin + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.heapmin + name: heapmin + uid: msvcrt.heapmin +- fullName: msvcrt.kbhit + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.kbhit + name: kbhit + uid: msvcrt.kbhit +- fullName: msvcrt.locking + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.locking + name: locking + uid: msvcrt.locking +- fullName: msvcrt.open_osfhandle + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.open_osfhandle + name: open_osfhandle + uid: msvcrt.open_osfhandle +- fullName: msvcrt.putch + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.putch + name: putch + uid: msvcrt.putch +- fullName: msvcrt.putwch + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.putwch + name: putwch + uid: msvcrt.putwch +- fullName: msvcrt.set_error_mode + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.set_error_mode + name: set_error_mode + uid: msvcrt.set_error_mode +- fullName: msvcrt.setmode + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.setmode + name: setmode + uid: msvcrt.setmode +- fullName: msvcrt.ungetch + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.ungetch + name: ungetch + uid: msvcrt.ungetch +- fullName: msvcrt.ungetwch + href: https://docs.python.org/3/library/msvcrt.html#msvcrt.ungetwch + name: ungetwch + uid: msvcrt.ungetwch +- fullName: multiprocessing.Array + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Array + name: Array + uid: multiprocessing.Array +- fullName: multiprocessing.Manager + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Manager + name: Manager + uid: multiprocessing.Manager +- fullName: multiprocessing.Pipe + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Pipe + name: Pipe + uid: multiprocessing.Pipe +- fullName: multiprocessing.Value + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Value + name: Value + uid: multiprocessing.Value +- fullName: multiprocessing.active_children + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.active_children + name: active_children + uid: multiprocessing.active_children +- fullName: multiprocessing.connection.Client + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.connection.Client + name: Client + uid: multiprocessing.connection.Client +- fullName: multiprocessing.connection.answer_challenge + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.connection.answer_challenge + name: answer_challenge + uid: multiprocessing.connection.answer_challenge +- fullName: multiprocessing.connection.deliver_challenge + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.connection.deliver_challenge + name: deliver_challenge + uid: multiprocessing.connection.deliver_challenge +- fullName: multiprocessing.connection.wait + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.connection.wait + name: wait + uid: multiprocessing.connection.wait +- fullName: multiprocessing.cpu_count + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.cpu_count + name: cpu_count + uid: multiprocessing.cpu_count +- fullName: multiprocessing.current_process + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.current_process + name: current_process + uid: multiprocessing.current_process +- fullName: multiprocessing.freeze_support + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.freeze_support + name: freeze_support + uid: multiprocessing.freeze_support +- fullName: multiprocessing.get_all_start_methods + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.get_all_start_methods + name: get_all_start_methods + uid: multiprocessing.get_all_start_methods +- fullName: multiprocessing.get_context + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.get_context + name: get_context + uid: multiprocessing.get_context +- fullName: multiprocessing.get_logger + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.get_logger + name: get_logger + uid: multiprocessing.get_logger +- fullName: multiprocessing.get_start_method + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.get_start_method + name: get_start_method + uid: multiprocessing.get_start_method +- fullName: multiprocessing.log_to_stderr + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.log_to_stderr + name: log_to_stderr + uid: multiprocessing.log_to_stderr +- fullName: multiprocessing.parent_process + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.parent_process + name: parent_process + uid: multiprocessing.parent_process +- fullName: multiprocessing.set_executable + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.set_executable + name: set_executable + uid: multiprocessing.set_executable +- fullName: multiprocessing.set_forkserver_preload + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.set_forkserver_preload + name: set_forkserver_preload + uid: multiprocessing.set_forkserver_preload +- fullName: multiprocessing.set_start_method + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.set_start_method + name: set_start_method + uid: multiprocessing.set_start_method +- fullName: multiprocessing.sharedctypes.Array + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.sharedctypes.Array + name: Array + uid: multiprocessing.sharedctypes.Array +- fullName: multiprocessing.sharedctypes.RawArray + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.sharedctypes.RawArray + name: RawArray + uid: multiprocessing.sharedctypes.RawArray +- fullName: multiprocessing.sharedctypes.RawValue + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.sharedctypes.RawValue + name: RawValue + uid: multiprocessing.sharedctypes.RawValue +- fullName: multiprocessing.sharedctypes.Value + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.sharedctypes.Value + name: Value + uid: multiprocessing.sharedctypes.Value +- fullName: multiprocessing.sharedctypes.copy + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.sharedctypes.copy + name: copy + uid: multiprocessing.sharedctypes.copy +- fullName: multiprocessing.sharedctypes.synchronized + href: https://docs.python.org/3/library/multiprocessing.html#multiprocessing.sharedctypes.synchronized + name: synchronized + uid: multiprocessing.sharedctypes.synchronized +- fullName: next + href: https://docs.python.org/3/library/functions.html#next + name: next + uid: next +- fullName: oct + href: https://docs.python.org/3/library/functions.html#oct + name: oct + uid: oct +- fullName: open + href: https://docs.python.org/3/library/functions.html#open + name: open + uid: open +- fullName: operator.__abs__ + href: https://docs.python.org/3/library/operator.html#operator.__abs__ + name: __abs__ + uid: operator.__abs__ +- fullName: operator.__add__ + href: https://docs.python.org/3/library/operator.html#operator.__add__ + name: __add__ + uid: operator.__add__ +- fullName: operator.__and__ + href: https://docs.python.org/3/library/operator.html#operator.__and__ + name: __and__ + uid: operator.__and__ +- fullName: operator.__call__ + href: https://docs.python.org/3/library/operator.html#operator.__call__ + name: __call__ + uid: operator.__call__ +- fullName: operator.__concat__ + href: https://docs.python.org/3/library/operator.html#operator.__concat__ + name: __concat__ + uid: operator.__concat__ +- fullName: operator.__contains__ + href: https://docs.python.org/3/library/operator.html#operator.__contains__ + name: __contains__ + uid: operator.__contains__ +- fullName: operator.__delitem__ + href: https://docs.python.org/3/library/operator.html#operator.__delitem__ + name: __delitem__ + uid: operator.__delitem__ +- fullName: operator.__eq__ + href: https://docs.python.org/3/library/operator.html#operator.__eq__ + name: __eq__ + uid: operator.__eq__ +- fullName: operator.__floordiv__ + href: https://docs.python.org/3/library/operator.html#operator.__floordiv__ + name: __floordiv__ + uid: operator.__floordiv__ +- fullName: operator.__ge__ + href: https://docs.python.org/3/library/operator.html#operator.__ge__ + name: __ge__ + uid: operator.__ge__ +- fullName: operator.__getitem__ + href: https://docs.python.org/3/library/operator.html#operator.__getitem__ + name: __getitem__ + uid: operator.__getitem__ +- fullName: operator.__gt__ + href: https://docs.python.org/3/library/operator.html#operator.__gt__ + name: __gt__ + uid: operator.__gt__ +- fullName: operator.__iadd__ + href: https://docs.python.org/3/library/operator.html#operator.__iadd__ + name: __iadd__ + uid: operator.__iadd__ +- fullName: operator.__iand__ + href: https://docs.python.org/3/library/operator.html#operator.__iand__ + name: __iand__ + uid: operator.__iand__ +- fullName: operator.__iconcat__ + href: https://docs.python.org/3/library/operator.html#operator.__iconcat__ + name: __iconcat__ + uid: operator.__iconcat__ +- fullName: operator.__ifloordiv__ + href: https://docs.python.org/3/library/operator.html#operator.__ifloordiv__ + name: __ifloordiv__ + uid: operator.__ifloordiv__ +- fullName: operator.__ilshift__ + href: https://docs.python.org/3/library/operator.html#operator.__ilshift__ + name: __ilshift__ + uid: operator.__ilshift__ +- fullName: operator.__imatmul__ + href: https://docs.python.org/3/library/operator.html#operator.__imatmul__ + name: __imatmul__ + uid: operator.__imatmul__ +- fullName: operator.__imod__ + href: https://docs.python.org/3/library/operator.html#operator.__imod__ + name: __imod__ + uid: operator.__imod__ +- fullName: operator.__imul__ + href: https://docs.python.org/3/library/operator.html#operator.__imul__ + name: __imul__ + uid: operator.__imul__ +- fullName: operator.__index__ + href: https://docs.python.org/3/library/operator.html#operator.__index__ + name: __index__ + uid: operator.__index__ +- fullName: operator.__inv__ + href: https://docs.python.org/3/library/operator.html#operator.__inv__ + name: __inv__ + uid: operator.__inv__ +- fullName: operator.__invert__ + href: https://docs.python.org/3/library/operator.html#operator.__invert__ + name: __invert__ + uid: operator.__invert__ +- fullName: operator.__ior__ + href: https://docs.python.org/3/library/operator.html#operator.__ior__ + name: __ior__ + uid: operator.__ior__ +- fullName: operator.__ipow__ + href: https://docs.python.org/3/library/operator.html#operator.__ipow__ + name: __ipow__ + uid: operator.__ipow__ +- fullName: operator.__irshift__ + href: https://docs.python.org/3/library/operator.html#operator.__irshift__ + name: __irshift__ + uid: operator.__irshift__ +- fullName: operator.__isub__ + href: https://docs.python.org/3/library/operator.html#operator.__isub__ + name: __isub__ + uid: operator.__isub__ +- fullName: operator.__itruediv__ + href: https://docs.python.org/3/library/operator.html#operator.__itruediv__ + name: __itruediv__ + uid: operator.__itruediv__ +- fullName: operator.__ixor__ + href: https://docs.python.org/3/library/operator.html#operator.__ixor__ + name: __ixor__ + uid: operator.__ixor__ +- fullName: operator.__le__ + href: https://docs.python.org/3/library/operator.html#operator.__le__ + name: __le__ + uid: operator.__le__ +- fullName: operator.__lshift__ + href: https://docs.python.org/3/library/operator.html#operator.__lshift__ + name: __lshift__ + uid: operator.__lshift__ +- fullName: operator.__lt__ + href: https://docs.python.org/3/library/operator.html#operator.__lt__ + name: __lt__ + uid: operator.__lt__ +- fullName: operator.__matmul__ + href: https://docs.python.org/3/library/operator.html#operator.__matmul__ + name: __matmul__ + uid: operator.__matmul__ +- fullName: operator.__mod__ + href: https://docs.python.org/3/library/operator.html#operator.__mod__ + name: __mod__ + uid: operator.__mod__ +- fullName: operator.__mul__ + href: https://docs.python.org/3/library/operator.html#operator.__mul__ + name: __mul__ + uid: operator.__mul__ +- fullName: operator.__ne__ + href: https://docs.python.org/3/library/operator.html#operator.__ne__ + name: __ne__ + uid: operator.__ne__ +- fullName: operator.__neg__ + href: https://docs.python.org/3/library/operator.html#operator.__neg__ + name: __neg__ + uid: operator.__neg__ +- fullName: operator.__not__ + href: https://docs.python.org/3/library/operator.html#operator.__not__ + name: __not__ + uid: operator.__not__ +- fullName: operator.__or__ + href: https://docs.python.org/3/library/operator.html#operator.__or__ + name: __or__ + uid: operator.__or__ +- fullName: operator.__pos__ + href: https://docs.python.org/3/library/operator.html#operator.__pos__ + name: __pos__ + uid: operator.__pos__ +- fullName: operator.__pow__ + href: https://docs.python.org/3/library/operator.html#operator.__pow__ + name: __pow__ + uid: operator.__pow__ +- fullName: operator.__rshift__ + href: https://docs.python.org/3/library/operator.html#operator.__rshift__ + name: __rshift__ + uid: operator.__rshift__ +- fullName: operator.__setitem__ + href: https://docs.python.org/3/library/operator.html#operator.__setitem__ + name: __setitem__ + uid: operator.__setitem__ +- fullName: operator.__sub__ + href: https://docs.python.org/3/library/operator.html#operator.__sub__ + name: __sub__ + uid: operator.__sub__ +- fullName: operator.__truediv__ + href: https://docs.python.org/3/library/operator.html#operator.__truediv__ + name: __truediv__ + uid: operator.__truediv__ +- fullName: operator.__xor__ + href: https://docs.python.org/3/library/operator.html#operator.__xor__ + name: __xor__ + uid: operator.__xor__ +- fullName: operator.abs + href: https://docs.python.org/3/library/operator.html#operator.abs + name: abs + uid: operator.abs +- fullName: operator.add + href: https://docs.python.org/3/library/operator.html#operator.add + name: add + uid: operator.add +- fullName: operator.and_ + href: https://docs.python.org/3/library/operator.html#operator.and_ + name: and_ + uid: operator.and_ +- fullName: operator.attrgetter + href: https://docs.python.org/3/library/operator.html#operator.attrgetter + name: attrgetter + uid: operator.attrgetter +- fullName: operator.call + href: https://docs.python.org/3/library/operator.html#operator.call + name: call + uid: operator.call +- fullName: operator.concat + href: https://docs.python.org/3/library/operator.html#operator.concat + name: concat + uid: operator.concat +- fullName: operator.contains + href: https://docs.python.org/3/library/operator.html#operator.contains + name: contains + uid: operator.contains +- fullName: operator.countOf + href: https://docs.python.org/3/library/operator.html#operator.countOf + name: countOf + uid: operator.countOf +- fullName: operator.delitem + href: https://docs.python.org/3/library/operator.html#operator.delitem + name: delitem + uid: operator.delitem +- fullName: operator.eq + href: https://docs.python.org/3/library/operator.html#operator.eq + name: eq + uid: operator.eq +- fullName: operator.floordiv + href: https://docs.python.org/3/library/operator.html#operator.floordiv + name: floordiv + uid: operator.floordiv +- fullName: operator.ge + href: https://docs.python.org/3/library/operator.html#operator.ge + name: ge + uid: operator.ge +- fullName: operator.getitem + href: https://docs.python.org/3/library/operator.html#operator.getitem + name: getitem + uid: operator.getitem +- fullName: operator.gt + href: https://docs.python.org/3/library/operator.html#operator.gt + name: gt + uid: operator.gt +- fullName: operator.iadd + href: https://docs.python.org/3/library/operator.html#operator.iadd + name: iadd + uid: operator.iadd +- fullName: operator.iand + href: https://docs.python.org/3/library/operator.html#operator.iand + name: iand + uid: operator.iand +- fullName: operator.iconcat + href: https://docs.python.org/3/library/operator.html#operator.iconcat + name: iconcat + uid: operator.iconcat +- fullName: operator.ifloordiv + href: https://docs.python.org/3/library/operator.html#operator.ifloordiv + name: ifloordiv + uid: operator.ifloordiv +- fullName: operator.ilshift + href: https://docs.python.org/3/library/operator.html#operator.ilshift + name: ilshift + uid: operator.ilshift +- fullName: operator.imatmul + href: https://docs.python.org/3/library/operator.html#operator.imatmul + name: imatmul + uid: operator.imatmul +- fullName: operator.imod + href: https://docs.python.org/3/library/operator.html#operator.imod + name: imod + uid: operator.imod +- fullName: operator.imul + href: https://docs.python.org/3/library/operator.html#operator.imul + name: imul + uid: operator.imul +- fullName: operator.index + href: https://docs.python.org/3/library/operator.html#operator.index + name: index + uid: operator.index +- fullName: operator.indexOf + href: https://docs.python.org/3/library/operator.html#operator.indexOf + name: indexOf + uid: operator.indexOf +- fullName: operator.inv + href: https://docs.python.org/3/library/operator.html#operator.inv + name: inv + uid: operator.inv +- fullName: operator.invert + href: https://docs.python.org/3/library/operator.html#operator.invert + name: invert + uid: operator.invert +- fullName: operator.ior + href: https://docs.python.org/3/library/operator.html#operator.ior + name: ior + uid: operator.ior +- fullName: operator.ipow + href: https://docs.python.org/3/library/operator.html#operator.ipow + name: ipow + uid: operator.ipow +- fullName: operator.irshift + href: https://docs.python.org/3/library/operator.html#operator.irshift + name: irshift + uid: operator.irshift +- fullName: operator.is_ + href: https://docs.python.org/3/library/operator.html#operator.is_ + name: is_ + uid: operator.is_ +- fullName: operator.is_not + href: https://docs.python.org/3/library/operator.html#operator.is_not + name: is_not + uid: operator.is_not +- fullName: operator.isub + href: https://docs.python.org/3/library/operator.html#operator.isub + name: isub + uid: operator.isub +- fullName: operator.itemgetter + href: https://docs.python.org/3/library/operator.html#operator.itemgetter + name: itemgetter + uid: operator.itemgetter +- fullName: operator.itruediv + href: https://docs.python.org/3/library/operator.html#operator.itruediv + name: itruediv + uid: operator.itruediv +- fullName: operator.ixor + href: https://docs.python.org/3/library/operator.html#operator.ixor + name: ixor + uid: operator.ixor +- fullName: operator.le + href: https://docs.python.org/3/library/operator.html#operator.le + name: le + uid: operator.le +- fullName: operator.length_hint + href: https://docs.python.org/3/library/operator.html#operator.length_hint + name: length_hint + uid: operator.length_hint +- fullName: operator.lshift + href: https://docs.python.org/3/library/operator.html#operator.lshift + name: lshift + uid: operator.lshift +- fullName: operator.lt + href: https://docs.python.org/3/library/operator.html#operator.lt + name: lt + uid: operator.lt +- fullName: operator.matmul + href: https://docs.python.org/3/library/operator.html#operator.matmul + name: matmul + uid: operator.matmul +- fullName: operator.methodcaller + href: https://docs.python.org/3/library/operator.html#operator.methodcaller + name: methodcaller + uid: operator.methodcaller +- fullName: operator.mod + href: https://docs.python.org/3/library/operator.html#operator.mod + name: mod + uid: operator.mod +- fullName: operator.mul + href: https://docs.python.org/3/library/operator.html#operator.mul + name: mul + uid: operator.mul +- fullName: operator.ne + href: https://docs.python.org/3/library/operator.html#operator.ne + name: ne + uid: operator.ne +- fullName: operator.neg + href: https://docs.python.org/3/library/operator.html#operator.neg + name: neg + uid: operator.neg +- fullName: operator.not_ + href: https://docs.python.org/3/library/operator.html#operator.not_ + name: not_ + uid: operator.not_ +- fullName: operator.or_ + href: https://docs.python.org/3/library/operator.html#operator.or_ + name: or_ + uid: operator.or_ +- fullName: operator.pos + href: https://docs.python.org/3/library/operator.html#operator.pos + name: pos + uid: operator.pos +- fullName: operator.pow + href: https://docs.python.org/3/library/operator.html#operator.pow + name: pow + uid: operator.pow +- fullName: operator.rshift + href: https://docs.python.org/3/library/operator.html#operator.rshift + name: rshift + uid: operator.rshift +- fullName: operator.setitem + href: https://docs.python.org/3/library/operator.html#operator.setitem + name: setitem + uid: operator.setitem +- fullName: operator.sub + href: https://docs.python.org/3/library/operator.html#operator.sub + name: sub + uid: operator.sub +- fullName: operator.truediv + href: https://docs.python.org/3/library/operator.html#operator.truediv + name: truediv + uid: operator.truediv +- fullName: operator.truth + href: https://docs.python.org/3/library/operator.html#operator.truth + name: truth + uid: operator.truth +- fullName: operator.xor + href: https://docs.python.org/3/library/operator.html#operator.xor + name: xor + uid: operator.xor +- fullName: ord + href: https://docs.python.org/3/library/functions.html#ord + name: ord + uid: ord +- fullName: os.WCOREDUMP + href: https://docs.python.org/3/library/os.html#os.WCOREDUMP + name: WCOREDUMP + uid: os.WCOREDUMP +- fullName: os.WEXITSTATUS + href: https://docs.python.org/3/library/os.html#os.WEXITSTATUS + name: WEXITSTATUS + uid: os.WEXITSTATUS +- fullName: os.WIFCONTINUED + href: https://docs.python.org/3/library/os.html#os.WIFCONTINUED + name: WIFCONTINUED + uid: os.WIFCONTINUED +- fullName: os.WIFEXITED + href: https://docs.python.org/3/library/os.html#os.WIFEXITED + name: WIFEXITED + uid: os.WIFEXITED +- fullName: os.WIFSIGNALED + href: https://docs.python.org/3/library/os.html#os.WIFSIGNALED + name: WIFSIGNALED + uid: os.WIFSIGNALED +- fullName: os.WIFSTOPPED + href: https://docs.python.org/3/library/os.html#os.WIFSTOPPED + name: WIFSTOPPED + uid: os.WIFSTOPPED +- fullName: os.WSTOPSIG + href: https://docs.python.org/3/library/os.html#os.WSTOPSIG + name: WSTOPSIG + uid: os.WSTOPSIG +- fullName: os.WTERMSIG + href: https://docs.python.org/3/library/os.html#os.WTERMSIG + name: WTERMSIG + uid: os.WTERMSIG +- fullName: os._exit + href: https://docs.python.org/3/library/os.html#os._exit + name: _exit + uid: os._exit +- fullName: os.abort + href: https://docs.python.org/3/library/os.html#os.abort + name: abort + uid: os.abort +- fullName: os.access + href: https://docs.python.org/3/library/os.html#os.access + name: access + uid: os.access +- fullName: os.add_dll_directory + href: https://docs.python.org/3/library/os.html#os.add_dll_directory + name: add_dll_directory + uid: os.add_dll_directory +- fullName: os.chdir + href: https://docs.python.org/3/library/os.html#os.chdir + name: chdir + uid: os.chdir +- fullName: os.chflags + href: https://docs.python.org/3/library/os.html#os.chflags + name: chflags + uid: os.chflags +- fullName: os.chmod + href: https://docs.python.org/3/library/os.html#os.chmod + name: chmod + uid: os.chmod +- fullName: os.chown + href: https://docs.python.org/3/library/os.html#os.chown + name: chown + uid: os.chown +- fullName: os.chroot + href: https://docs.python.org/3/library/os.html#os.chroot + name: chroot + uid: os.chroot +- fullName: os.close + href: https://docs.python.org/3/library/os.html#os.close + name: close + uid: os.close +- fullName: os.closerange + href: https://docs.python.org/3/library/os.html#os.closerange + name: closerange + uid: os.closerange +- fullName: os.confstr + href: https://docs.python.org/3/library/os.html#os.confstr + name: confstr + uid: os.confstr +- fullName: os.copy_file_range + href: https://docs.python.org/3/library/os.html#os.copy_file_range + name: copy_file_range + uid: os.copy_file_range +- fullName: os.cpu_count + href: https://docs.python.org/3/library/os.html#os.cpu_count + name: cpu_count + uid: os.cpu_count +- fullName: os.ctermid + href: https://docs.python.org/3/library/os.html#os.ctermid + name: ctermid + uid: os.ctermid +- fullName: os.device_encoding + href: https://docs.python.org/3/library/os.html#os.device_encoding + name: device_encoding + uid: os.device_encoding +- fullName: os.dup + href: https://docs.python.org/3/library/os.html#os.dup + name: dup + uid: os.dup +- fullName: os.dup2 + href: https://docs.python.org/3/library/os.html#os.dup2 + name: dup2 + uid: os.dup2 +- fullName: os.eventfd + href: https://docs.python.org/3/library/os.html#os.eventfd + name: eventfd + uid: os.eventfd +- fullName: os.eventfd_read + href: https://docs.python.org/3/library/os.html#os.eventfd_read + name: eventfd_read + uid: os.eventfd_read +- fullName: os.eventfd_write + href: https://docs.python.org/3/library/os.html#os.eventfd_write + name: eventfd_write + uid: os.eventfd_write +- fullName: os.execl + href: https://docs.python.org/3/library/os.html#os.execl + name: execl + uid: os.execl +- fullName: os.execle + href: https://docs.python.org/3/library/os.html#os.execle + name: execle + uid: os.execle +- fullName: os.execlp + href: https://docs.python.org/3/library/os.html#os.execlp + name: execlp + uid: os.execlp +- fullName: os.execlpe + href: https://docs.python.org/3/library/os.html#os.execlpe + name: execlpe + uid: os.execlpe +- fullName: os.execv + href: https://docs.python.org/3/library/os.html#os.execv + name: execv + uid: os.execv +- fullName: os.execve + href: https://docs.python.org/3/library/os.html#os.execve + name: execve + uid: os.execve +- fullName: os.execvp + href: https://docs.python.org/3/library/os.html#os.execvp + name: execvp + uid: os.execvp +- fullName: os.execvpe + href: https://docs.python.org/3/library/os.html#os.execvpe + name: execvpe + uid: os.execvpe +- fullName: os.fchdir + href: https://docs.python.org/3/library/os.html#os.fchdir + name: fchdir + uid: os.fchdir +- fullName: os.fchmod + href: https://docs.python.org/3/library/os.html#os.fchmod + name: fchmod + uid: os.fchmod +- fullName: os.fchown + href: https://docs.python.org/3/library/os.html#os.fchown + name: fchown + uid: os.fchown +- fullName: os.fdatasync + href: https://docs.python.org/3/library/os.html#os.fdatasync + name: fdatasync + uid: os.fdatasync +- fullName: os.fdopen + href: https://docs.python.org/3/library/os.html#os.fdopen + name: fdopen + uid: os.fdopen +- fullName: os.fork + href: https://docs.python.org/3/library/os.html#os.fork + name: fork + uid: os.fork +- fullName: os.forkpty + href: https://docs.python.org/3/library/os.html#os.forkpty + name: forkpty + uid: os.forkpty +- fullName: os.fpathconf + href: https://docs.python.org/3/library/os.html#os.fpathconf + name: fpathconf + uid: os.fpathconf +- fullName: os.fsdecode + href: https://docs.python.org/3/library/os.html#os.fsdecode + name: fsdecode + uid: os.fsdecode +- fullName: os.fsencode + href: https://docs.python.org/3/library/os.html#os.fsencode + name: fsencode + uid: os.fsencode +- fullName: os.fspath + href: https://docs.python.org/3/library/os.html#os.fspath + name: fspath + uid: os.fspath +- fullName: os.fstat + href: https://docs.python.org/3/library/os.html#os.fstat + name: fstat + uid: os.fstat +- fullName: os.fstatvfs + href: https://docs.python.org/3/library/os.html#os.fstatvfs + name: fstatvfs + uid: os.fstatvfs +- fullName: os.fsync + href: https://docs.python.org/3/library/os.html#os.fsync + name: fsync + uid: os.fsync +- fullName: os.ftruncate + href: https://docs.python.org/3/library/os.html#os.ftruncate + name: ftruncate + uid: os.ftruncate +- fullName: os.fwalk + href: https://docs.python.org/3/library/os.html#os.fwalk + name: fwalk + uid: os.fwalk +- fullName: os.get_blocking + href: https://docs.python.org/3/library/os.html#os.get_blocking + name: get_blocking + uid: os.get_blocking +- fullName: os.get_exec_path + href: https://docs.python.org/3/library/os.html#os.get_exec_path + name: get_exec_path + uid: os.get_exec_path +- fullName: os.get_handle_inheritable + href: https://docs.python.org/3/library/os.html#os.get_handle_inheritable + name: get_handle_inheritable + uid: os.get_handle_inheritable +- fullName: os.get_inheritable + href: https://docs.python.org/3/library/os.html#os.get_inheritable + name: get_inheritable + uid: os.get_inheritable +- fullName: os.get_terminal_size + href: https://docs.python.org/3/library/os.html#os.get_terminal_size + name: get_terminal_size + uid: os.get_terminal_size +- fullName: os.getcwd + href: https://docs.python.org/3/library/os.html#os.getcwd + name: getcwd + uid: os.getcwd +- fullName: os.getcwdb + href: https://docs.python.org/3/library/os.html#os.getcwdb + name: getcwdb + uid: os.getcwdb +- fullName: os.getegid + href: https://docs.python.org/3/library/os.html#os.getegid + name: getegid + uid: os.getegid +- fullName: os.getenv + href: https://docs.python.org/3/library/os.html#os.getenv + name: getenv + uid: os.getenv +- fullName: os.getenvb + href: https://docs.python.org/3/library/os.html#os.getenvb + name: getenvb + uid: os.getenvb +- fullName: os.geteuid + href: https://docs.python.org/3/library/os.html#os.geteuid + name: geteuid + uid: os.geteuid +- fullName: os.getgid + href: https://docs.python.org/3/library/os.html#os.getgid + name: getgid + uid: os.getgid +- fullName: os.getgrouplist + href: https://docs.python.org/3/library/os.html#os.getgrouplist + name: getgrouplist + uid: os.getgrouplist +- fullName: os.getgroups + href: https://docs.python.org/3/library/os.html#os.getgroups + name: getgroups + uid: os.getgroups +- fullName: os.getloadavg + href: https://docs.python.org/3/library/os.html#os.getloadavg + name: getloadavg + uid: os.getloadavg +- fullName: os.getlogin + href: https://docs.python.org/3/library/os.html#os.getlogin + name: getlogin + uid: os.getlogin +- fullName: os.getpgid + href: https://docs.python.org/3/library/os.html#os.getpgid + name: getpgid + uid: os.getpgid +- fullName: os.getpgrp + href: https://docs.python.org/3/library/os.html#os.getpgrp + name: getpgrp + uid: os.getpgrp +- fullName: os.getpid + href: https://docs.python.org/3/library/os.html#os.getpid + name: getpid + uid: os.getpid +- fullName: os.getppid + href: https://docs.python.org/3/library/os.html#os.getppid + name: getppid + uid: os.getppid +- fullName: os.getpriority + href: https://docs.python.org/3/library/os.html#os.getpriority + name: getpriority + uid: os.getpriority +- fullName: os.getrandom + href: https://docs.python.org/3/library/os.html#os.getrandom + name: getrandom + uid: os.getrandom +- fullName: os.getresgid + href: https://docs.python.org/3/library/os.html#os.getresgid + name: getresgid + uid: os.getresgid +- fullName: os.getresuid + href: https://docs.python.org/3/library/os.html#os.getresuid + name: getresuid + uid: os.getresuid +- fullName: os.getsid + href: https://docs.python.org/3/library/os.html#os.getsid + name: getsid + uid: os.getsid +- fullName: os.getuid + href: https://docs.python.org/3/library/os.html#os.getuid + name: getuid + uid: os.getuid +- fullName: os.getxattr + href: https://docs.python.org/3/library/os.html#os.getxattr + name: getxattr + uid: os.getxattr +- fullName: os.grantpt + href: https://docs.python.org/3/library/os.html#os.grantpt + name: grantpt + uid: os.grantpt +- fullName: os.initgroups + href: https://docs.python.org/3/library/os.html#os.initgroups + name: initgroups + uid: os.initgroups +- fullName: os.isatty + href: https://docs.python.org/3/library/os.html#os.isatty + name: isatty + uid: os.isatty +- fullName: os.kill + href: https://docs.python.org/3/library/os.html#os.kill + name: kill + uid: os.kill +- fullName: os.killpg + href: https://docs.python.org/3/library/os.html#os.killpg + name: killpg + uid: os.killpg +- fullName: os.lchflags + href: https://docs.python.org/3/library/os.html#os.lchflags + name: lchflags + uid: os.lchflags +- fullName: os.lchmod + href: https://docs.python.org/3/library/os.html#os.lchmod + name: lchmod + uid: os.lchmod +- fullName: os.lchown + href: https://docs.python.org/3/library/os.html#os.lchown + name: lchown + uid: os.lchown +- fullName: os.link + href: https://docs.python.org/3/library/os.html#os.link + name: link + uid: os.link +- fullName: os.listdir + href: https://docs.python.org/3/library/os.html#os.listdir + name: listdir + uid: os.listdir +- fullName: os.listdrives + href: https://docs.python.org/3/library/os.html#os.listdrives + name: listdrives + uid: os.listdrives +- fullName: os.listmounts + href: https://docs.python.org/3/library/os.html#os.listmounts + name: listmounts + uid: os.listmounts +- fullName: os.listvolumes + href: https://docs.python.org/3/library/os.html#os.listvolumes + name: listvolumes + uid: os.listvolumes +- fullName: os.listxattr + href: https://docs.python.org/3/library/os.html#os.listxattr + name: listxattr + uid: os.listxattr +- fullName: os.lockf + href: https://docs.python.org/3/library/os.html#os.lockf + name: lockf + uid: os.lockf +- fullName: os.login_tty + href: https://docs.python.org/3/library/os.html#os.login_tty + name: login_tty + uid: os.login_tty +- fullName: os.lseek + href: https://docs.python.org/3/library/os.html#os.lseek + name: lseek + uid: os.lseek +- fullName: os.lstat + href: https://docs.python.org/3/library/os.html#os.lstat + name: lstat + uid: os.lstat +- fullName: os.major + href: https://docs.python.org/3/library/os.html#os.major + name: major + uid: os.major +- fullName: os.makedev + href: https://docs.python.org/3/library/os.html#os.makedev + name: makedev + uid: os.makedev +- fullName: os.makedirs + href: https://docs.python.org/3/library/os.html#os.makedirs + name: makedirs + uid: os.makedirs +- fullName: os.memfd_create + href: https://docs.python.org/3/library/os.html#os.memfd_create + name: memfd_create + uid: os.memfd_create +- fullName: os.minor + href: https://docs.python.org/3/library/os.html#os.minor + name: minor + uid: os.minor +- fullName: os.mkdir + href: https://docs.python.org/3/library/os.html#os.mkdir + name: mkdir + uid: os.mkdir +- fullName: os.mkfifo + href: https://docs.python.org/3/library/os.html#os.mkfifo + name: mkfifo + uid: os.mkfifo +- fullName: os.mknod + href: https://docs.python.org/3/library/os.html#os.mknod + name: mknod + uid: os.mknod +- fullName: os.nice + href: https://docs.python.org/3/library/os.html#os.nice + name: nice + uid: os.nice +- fullName: os.open + href: https://docs.python.org/3/library/os.html#os.open + name: open + uid: os.open +- fullName: os.openpty + href: https://docs.python.org/3/library/os.html#os.openpty + name: openpty + uid: os.openpty +- fullName: os.path.abspath + href: https://docs.python.org/3/library/os.path.html#os.path.abspath + name: abspath + uid: os.path.abspath +- fullName: os.path.basename + href: https://docs.python.org/3/library/os.path.html#os.path.basename + name: basename + uid: os.path.basename +- fullName: os.path.commonpath + href: https://docs.python.org/3/library/os.path.html#os.path.commonpath + name: commonpath + uid: os.path.commonpath +- fullName: os.path.commonprefix + href: https://docs.python.org/3/library/os.path.html#os.path.commonprefix + name: commonprefix + uid: os.path.commonprefix +- fullName: os.path.dirname + href: https://docs.python.org/3/library/os.path.html#os.path.dirname + name: dirname + uid: os.path.dirname +- fullName: os.path.exists + href: https://docs.python.org/3/library/os.path.html#os.path.exists + name: exists + uid: os.path.exists +- fullName: os.path.expanduser + href: https://docs.python.org/3/library/os.path.html#os.path.expanduser + name: expanduser + uid: os.path.expanduser +- fullName: os.path.expandvars + href: https://docs.python.org/3/library/os.path.html#os.path.expandvars + name: expandvars + uid: os.path.expandvars +- fullName: os.path.getatime + href: https://docs.python.org/3/library/os.path.html#os.path.getatime + name: getatime + uid: os.path.getatime +- fullName: os.path.getctime + href: https://docs.python.org/3/library/os.path.html#os.path.getctime + name: getctime + uid: os.path.getctime +- fullName: os.path.getmtime + href: https://docs.python.org/3/library/os.path.html#os.path.getmtime + name: getmtime + uid: os.path.getmtime +- fullName: os.path.getsize + href: https://docs.python.org/3/library/os.path.html#os.path.getsize + name: getsize + uid: os.path.getsize +- fullName: os.path.isabs + href: https://docs.python.org/3/library/os.path.html#os.path.isabs + name: isabs + uid: os.path.isabs +- fullName: os.path.isdevdrive + href: https://docs.python.org/3/library/os.path.html#os.path.isdevdrive + name: isdevdrive + uid: os.path.isdevdrive +- fullName: os.path.isdir + href: https://docs.python.org/3/library/os.path.html#os.path.isdir + name: isdir + uid: os.path.isdir +- fullName: os.path.isfile + href: https://docs.python.org/3/library/os.path.html#os.path.isfile + name: isfile + uid: os.path.isfile +- fullName: os.path.isjunction + href: https://docs.python.org/3/library/os.path.html#os.path.isjunction + name: isjunction + uid: os.path.isjunction +- fullName: os.path.islink + href: https://docs.python.org/3/library/os.path.html#os.path.islink + name: islink + uid: os.path.islink +- fullName: os.path.ismount + href: https://docs.python.org/3/library/os.path.html#os.path.ismount + name: ismount + uid: os.path.ismount +- fullName: os.path.isreserved + href: https://docs.python.org/3/library/os.path.html#os.path.isreserved + name: isreserved + uid: os.path.isreserved +- fullName: os.path.join + href: https://docs.python.org/3/library/os.path.html#os.path.join + name: join + uid: os.path.join +- fullName: os.path.lexists + href: https://docs.python.org/3/library/os.path.html#os.path.lexists + name: lexists + uid: os.path.lexists +- fullName: os.path.normcase + href: https://docs.python.org/3/library/os.path.html#os.path.normcase + name: normcase + uid: os.path.normcase +- fullName: os.path.normpath + href: https://docs.python.org/3/library/os.path.html#os.path.normpath + name: normpath + uid: os.path.normpath +- fullName: os.path.realpath + href: https://docs.python.org/3/library/os.path.html#os.path.realpath + name: realpath + uid: os.path.realpath +- fullName: os.path.relpath + href: https://docs.python.org/3/library/os.path.html#os.path.relpath + name: relpath + uid: os.path.relpath +- fullName: os.path.samefile + href: https://docs.python.org/3/library/os.path.html#os.path.samefile + name: samefile + uid: os.path.samefile +- fullName: os.path.sameopenfile + href: https://docs.python.org/3/library/os.path.html#os.path.sameopenfile + name: sameopenfile + uid: os.path.sameopenfile +- fullName: os.path.samestat + href: https://docs.python.org/3/library/os.path.html#os.path.samestat + name: samestat + uid: os.path.samestat +- fullName: os.path.split + href: https://docs.python.org/3/library/os.path.html#os.path.split + name: split + uid: os.path.split +- fullName: os.path.splitdrive + href: https://docs.python.org/3/library/os.path.html#os.path.splitdrive + name: splitdrive + uid: os.path.splitdrive +- fullName: os.path.splitext + href: https://docs.python.org/3/library/os.path.html#os.path.splitext + name: splitext + uid: os.path.splitext +- fullName: os.path.splitroot + href: https://docs.python.org/3/library/os.path.html#os.path.splitroot + name: splitroot + uid: os.path.splitroot +- fullName: os.pathconf + href: https://docs.python.org/3/library/os.html#os.pathconf + name: pathconf + uid: os.pathconf +- fullName: os.pidfd_open + href: https://docs.python.org/3/library/os.html#os.pidfd_open + name: pidfd_open + uid: os.pidfd_open +- fullName: os.pipe + href: https://docs.python.org/3/library/os.html#os.pipe + name: pipe + uid: os.pipe +- fullName: os.pipe2 + href: https://docs.python.org/3/library/os.html#os.pipe2 + name: pipe2 + uid: os.pipe2 +- fullName: os.plock + href: https://docs.python.org/3/library/os.html#os.plock + name: plock + uid: os.plock +- fullName: os.popen + href: https://docs.python.org/3/library/os.html#os.popen + name: popen + uid: os.popen +- fullName: os.posix_fadvise + href: https://docs.python.org/3/library/os.html#os.posix_fadvise + name: posix_fadvise + uid: os.posix_fadvise +- fullName: os.posix_fallocate + href: https://docs.python.org/3/library/os.html#os.posix_fallocate + name: posix_fallocate + uid: os.posix_fallocate +- fullName: os.posix_openpt + href: https://docs.python.org/3/library/os.html#os.posix_openpt + name: posix_openpt + uid: os.posix_openpt +- fullName: os.posix_spawn + href: https://docs.python.org/3/library/os.html#os.posix_spawn + name: posix_spawn + uid: os.posix_spawn +- fullName: os.posix_spawnp + href: https://docs.python.org/3/library/os.html#os.posix_spawnp + name: posix_spawnp + uid: os.posix_spawnp +- fullName: os.pread + href: https://docs.python.org/3/library/os.html#os.pread + name: pread + uid: os.pread +- fullName: os.preadv + href: https://docs.python.org/3/library/os.html#os.preadv + name: preadv + uid: os.preadv +- fullName: os.process_cpu_count + href: https://docs.python.org/3/library/os.html#os.process_cpu_count + name: process_cpu_count + uid: os.process_cpu_count +- fullName: os.ptsname + href: https://docs.python.org/3/library/os.html#os.ptsname + name: ptsname + uid: os.ptsname +- fullName: os.putenv + href: https://docs.python.org/3/library/os.html#os.putenv + name: putenv + uid: os.putenv +- fullName: os.pwrite + href: https://docs.python.org/3/library/os.html#os.pwrite + name: pwrite + uid: os.pwrite +- fullName: os.pwritev + href: https://docs.python.org/3/library/os.html#os.pwritev + name: pwritev + uid: os.pwritev +- fullName: os.read + href: https://docs.python.org/3/library/os.html#os.read + name: read + uid: os.read +- fullName: os.readlink + href: https://docs.python.org/3/library/os.html#os.readlink + name: readlink + uid: os.readlink +- fullName: os.readv + href: https://docs.python.org/3/library/os.html#os.readv + name: readv + uid: os.readv +- fullName: os.register_at_fork + href: https://docs.python.org/3/library/os.html#os.register_at_fork + name: register_at_fork + uid: os.register_at_fork +- fullName: os.remove + href: https://docs.python.org/3/library/os.html#os.remove + name: remove + uid: os.remove +- fullName: os.removedirs + href: https://docs.python.org/3/library/os.html#os.removedirs + name: removedirs + uid: os.removedirs +- fullName: os.removexattr + href: https://docs.python.org/3/library/os.html#os.removexattr + name: removexattr + uid: os.removexattr +- fullName: os.rename + href: https://docs.python.org/3/library/os.html#os.rename + name: rename + uid: os.rename +- fullName: os.renames + href: https://docs.python.org/3/library/os.html#os.renames + name: renames + uid: os.renames +- fullName: os.replace + href: https://docs.python.org/3/library/os.html#os.replace + name: replace + uid: os.replace +- fullName: os.rmdir + href: https://docs.python.org/3/library/os.html#os.rmdir + name: rmdir + uid: os.rmdir +- fullName: os.scandir + href: https://docs.python.org/3/library/os.html#os.scandir + name: scandir + uid: os.scandir +- fullName: os.sched_get_priority_max + href: https://docs.python.org/3/library/os.html#os.sched_get_priority_max + name: sched_get_priority_max + uid: os.sched_get_priority_max +- fullName: os.sched_get_priority_min + href: https://docs.python.org/3/library/os.html#os.sched_get_priority_min + name: sched_get_priority_min + uid: os.sched_get_priority_min +- fullName: os.sched_getaffinity + href: https://docs.python.org/3/library/os.html#os.sched_getaffinity + name: sched_getaffinity + uid: os.sched_getaffinity +- fullName: os.sched_getparam + href: https://docs.python.org/3/library/os.html#os.sched_getparam + name: sched_getparam + uid: os.sched_getparam +- fullName: os.sched_getscheduler + href: https://docs.python.org/3/library/os.html#os.sched_getscheduler + name: sched_getscheduler + uid: os.sched_getscheduler +- fullName: os.sched_rr_get_interval + href: https://docs.python.org/3/library/os.html#os.sched_rr_get_interval + name: sched_rr_get_interval + uid: os.sched_rr_get_interval +- fullName: os.sched_setaffinity + href: https://docs.python.org/3/library/os.html#os.sched_setaffinity + name: sched_setaffinity + uid: os.sched_setaffinity +- fullName: os.sched_setparam + href: https://docs.python.org/3/library/os.html#os.sched_setparam + name: sched_setparam + uid: os.sched_setparam +- fullName: os.sched_setscheduler + href: https://docs.python.org/3/library/os.html#os.sched_setscheduler + name: sched_setscheduler + uid: os.sched_setscheduler +- fullName: os.sched_yield + href: https://docs.python.org/3/library/os.html#os.sched_yield + name: sched_yield + uid: os.sched_yield +- fullName: os.sendfile + href: https://docs.python.org/3/library/os.html#os.sendfile + name: sendfile + uid: os.sendfile +- fullName: os.set_blocking + href: https://docs.python.org/3/library/os.html#os.set_blocking + name: set_blocking + uid: os.set_blocking +- fullName: os.set_handle_inheritable + href: https://docs.python.org/3/library/os.html#os.set_handle_inheritable + name: set_handle_inheritable + uid: os.set_handle_inheritable +- fullName: os.set_inheritable + href: https://docs.python.org/3/library/os.html#os.set_inheritable + name: set_inheritable + uid: os.set_inheritable +- fullName: os.setegid + href: https://docs.python.org/3/library/os.html#os.setegid + name: setegid + uid: os.setegid +- fullName: os.seteuid + href: https://docs.python.org/3/library/os.html#os.seteuid + name: seteuid + uid: os.seteuid +- fullName: os.setgid + href: https://docs.python.org/3/library/os.html#os.setgid + name: setgid + uid: os.setgid +- fullName: os.setgroups + href: https://docs.python.org/3/library/os.html#os.setgroups + name: setgroups + uid: os.setgroups +- fullName: os.setns + href: https://docs.python.org/3/library/os.html#os.setns + name: setns + uid: os.setns +- fullName: os.setpgid + href: https://docs.python.org/3/library/os.html#os.setpgid + name: setpgid + uid: os.setpgid +- fullName: os.setpgrp + href: https://docs.python.org/3/library/os.html#os.setpgrp + name: setpgrp + uid: os.setpgrp +- fullName: os.setpriority + href: https://docs.python.org/3/library/os.html#os.setpriority + name: setpriority + uid: os.setpriority +- fullName: os.setregid + href: https://docs.python.org/3/library/os.html#os.setregid + name: setregid + uid: os.setregid +- fullName: os.setresgid + href: https://docs.python.org/3/library/os.html#os.setresgid + name: setresgid + uid: os.setresgid +- fullName: os.setresuid + href: https://docs.python.org/3/library/os.html#os.setresuid + name: setresuid + uid: os.setresuid +- fullName: os.setreuid + href: https://docs.python.org/3/library/os.html#os.setreuid + name: setreuid + uid: os.setreuid +- fullName: os.setsid + href: https://docs.python.org/3/library/os.html#os.setsid + name: setsid + uid: os.setsid +- fullName: os.setuid + href: https://docs.python.org/3/library/os.html#os.setuid + name: setuid + uid: os.setuid +- fullName: os.setxattr + href: https://docs.python.org/3/library/os.html#os.setxattr + name: setxattr + uid: os.setxattr +- fullName: os.spawnl + href: https://docs.python.org/3/library/os.html#os.spawnl + name: spawnl + uid: os.spawnl +- fullName: os.spawnle + href: https://docs.python.org/3/library/os.html#os.spawnle + name: spawnle + uid: os.spawnle +- fullName: os.spawnlp + href: https://docs.python.org/3/library/os.html#os.spawnlp + name: spawnlp + uid: os.spawnlp +- fullName: os.spawnlpe + href: https://docs.python.org/3/library/os.html#os.spawnlpe + name: spawnlpe + uid: os.spawnlpe +- fullName: os.spawnv + href: https://docs.python.org/3/library/os.html#os.spawnv + name: spawnv + uid: os.spawnv +- fullName: os.spawnve + href: https://docs.python.org/3/library/os.html#os.spawnve + name: spawnve + uid: os.spawnve +- fullName: os.spawnvp + href: https://docs.python.org/3/library/os.html#os.spawnvp + name: spawnvp + uid: os.spawnvp +- fullName: os.spawnvpe + href: https://docs.python.org/3/library/os.html#os.spawnvpe + name: spawnvpe + uid: os.spawnvpe +- fullName: os.splice + href: https://docs.python.org/3/library/os.html#os.splice + name: splice + uid: os.splice +- fullName: os.startfile + href: https://docs.python.org/3/library/os.html#os.startfile + name: startfile + uid: os.startfile +- fullName: os.stat + href: https://docs.python.org/3/library/os.html#os.stat + name: stat + uid: os.stat +- fullName: os.statvfs + href: https://docs.python.org/3/library/os.html#os.statvfs + name: statvfs + uid: os.statvfs +- fullName: os.strerror + href: https://docs.python.org/3/library/os.html#os.strerror + name: strerror + uid: os.strerror +- fullName: os.symlink + href: https://docs.python.org/3/library/os.html#os.symlink + name: symlink + uid: os.symlink +- fullName: os.sync + href: https://docs.python.org/3/library/os.html#os.sync + name: sync + uid: os.sync +- fullName: os.sysconf + href: https://docs.python.org/3/library/os.html#os.sysconf + name: sysconf + uid: os.sysconf +- fullName: os.system + href: https://docs.python.org/3/library/os.html#os.system + name: system + uid: os.system +- fullName: os.tcgetpgrp + href: https://docs.python.org/3/library/os.html#os.tcgetpgrp + name: tcgetpgrp + uid: os.tcgetpgrp +- fullName: os.tcsetpgrp + href: https://docs.python.org/3/library/os.html#os.tcsetpgrp + name: tcsetpgrp + uid: os.tcsetpgrp +- fullName: os.timerfd_create + href: https://docs.python.org/3/library/os.html#os.timerfd_create + name: timerfd_create + uid: os.timerfd_create +- fullName: os.timerfd_gettime + href: https://docs.python.org/3/library/os.html#os.timerfd_gettime + name: timerfd_gettime + uid: os.timerfd_gettime +- fullName: os.timerfd_gettime_ns + href: https://docs.python.org/3/library/os.html#os.timerfd_gettime_ns + name: timerfd_gettime_ns + uid: os.timerfd_gettime_ns +- fullName: os.timerfd_settime + href: https://docs.python.org/3/library/os.html#os.timerfd_settime + name: timerfd_settime + uid: os.timerfd_settime +- fullName: os.timerfd_settime_ns + href: https://docs.python.org/3/library/os.html#os.timerfd_settime_ns + name: timerfd_settime_ns + uid: os.timerfd_settime_ns +- fullName: os.times + href: https://docs.python.org/3/library/os.html#os.times + name: times + uid: os.times +- fullName: os.truncate + href: https://docs.python.org/3/library/os.html#os.truncate + name: truncate + uid: os.truncate +- fullName: os.ttyname + href: https://docs.python.org/3/library/os.html#os.ttyname + name: ttyname + uid: os.ttyname +- fullName: os.umask + href: https://docs.python.org/3/library/os.html#os.umask + name: umask + uid: os.umask +- fullName: os.uname + href: https://docs.python.org/3/library/os.html#os.uname + name: uname + uid: os.uname +- fullName: os.unlink + href: https://docs.python.org/3/library/os.html#os.unlink + name: unlink + uid: os.unlink +- fullName: os.unlockpt + href: https://docs.python.org/3/library/os.html#os.unlockpt + name: unlockpt + uid: os.unlockpt +- fullName: os.unsetenv + href: https://docs.python.org/3/library/os.html#os.unsetenv + name: unsetenv + uid: os.unsetenv +- fullName: os.unshare + href: https://docs.python.org/3/library/os.html#os.unshare + name: unshare + uid: os.unshare +- fullName: os.urandom + href: https://docs.python.org/3/library/os.html#os.urandom + name: urandom + uid: os.urandom +- fullName: os.utime + href: https://docs.python.org/3/library/os.html#os.utime + name: utime + uid: os.utime +- fullName: os.wait + href: https://docs.python.org/3/library/os.html#os.wait + name: wait + uid: os.wait +- fullName: os.wait3 + href: https://docs.python.org/3/library/os.html#os.wait3 + name: wait3 + uid: os.wait3 +- fullName: os.wait4 + href: https://docs.python.org/3/library/os.html#os.wait4 + name: wait4 + uid: os.wait4 +- fullName: os.waitid + href: https://docs.python.org/3/library/os.html#os.waitid + name: waitid + uid: os.waitid +- fullName: os.waitpid + href: https://docs.python.org/3/library/os.html#os.waitpid + name: waitpid + uid: os.waitpid +- fullName: os.waitstatus_to_exitcode + href: https://docs.python.org/3/library/os.html#os.waitstatus_to_exitcode + name: waitstatus_to_exitcode + uid: os.waitstatus_to_exitcode +- fullName: os.walk + href: https://docs.python.org/3/library/os.html#os.walk + name: walk + uid: os.walk +- fullName: os.write + href: https://docs.python.org/3/library/os.html#os.write + name: write + uid: os.write +- fullName: os.writev + href: https://docs.python.org/3/library/os.html#os.writev + name: writev + uid: os.writev +- fullName: pdb.pm + href: https://docs.python.org/3/library/pdb.html#pdb.pm + name: pm + uid: pdb.pm +- fullName: pdb.post_mortem + href: https://docs.python.org/3/library/pdb.html#pdb.post_mortem + name: post_mortem + uid: pdb.post_mortem +- fullName: pdb.run + href: https://docs.python.org/3/library/pdb.html#pdb.run + name: run + uid: pdb.run +- fullName: pdb.runcall + href: https://docs.python.org/3/library/pdb.html#pdb.runcall + name: runcall + uid: pdb.runcall +- fullName: pdb.runeval + href: https://docs.python.org/3/library/pdb.html#pdb.runeval + name: runeval + uid: pdb.runeval +- fullName: pdb.set_trace + href: https://docs.python.org/3/library/pdb.html#pdb.set_trace + name: set_trace + uid: pdb.set_trace +- fullName: pickle.dump + href: https://docs.python.org/3/library/pickle.html#pickle.dump + name: dump + uid: pickle.dump +- fullName: pickle.dumps + href: https://docs.python.org/3/library/pickle.html#pickle.dumps + name: dumps + uid: pickle.dumps +- fullName: pickle.load + href: https://docs.python.org/3/library/pickle.html#pickle.load + name: load + uid: pickle.load +- fullName: pickle.loads + href: https://docs.python.org/3/library/pickle.html#pickle.loads + name: loads + uid: pickle.loads +- fullName: pickletools.dis + href: https://docs.python.org/3/library/pickletools.html#pickletools.dis + name: dis + uid: pickletools.dis +- fullName: pickletools.genops + href: https://docs.python.org/3/library/pickletools.html#pickletools.genops + name: genops + uid: pickletools.genops +- fullName: pickletools.optimize + href: https://docs.python.org/3/library/pickletools.html#pickletools.optimize + name: optimize + uid: pickletools.optimize +- fullName: pkgutil.extend_path + href: https://docs.python.org/3/library/pkgutil.html#pkgutil.extend_path + name: extend_path + uid: pkgutil.extend_path +- fullName: pkgutil.find_loader + href: https://docs.python.org/3/library/pkgutil.html#pkgutil.find_loader + name: find_loader + uid: pkgutil.find_loader +- fullName: pkgutil.get_data + href: https://docs.python.org/3/library/pkgutil.html#pkgutil.get_data + name: get_data + uid: pkgutil.get_data +- fullName: pkgutil.get_importer + href: https://docs.python.org/3/library/pkgutil.html#pkgutil.get_importer + name: get_importer + uid: pkgutil.get_importer +- fullName: pkgutil.get_loader + href: https://docs.python.org/3/library/pkgutil.html#pkgutil.get_loader + name: get_loader + uid: pkgutil.get_loader +- fullName: pkgutil.iter_importers + href: https://docs.python.org/3/library/pkgutil.html#pkgutil.iter_importers + name: iter_importers + uid: pkgutil.iter_importers +- fullName: pkgutil.iter_modules + href: https://docs.python.org/3/library/pkgutil.html#pkgutil.iter_modules + name: iter_modules + uid: pkgutil.iter_modules +- fullName: pkgutil.resolve_name + href: https://docs.python.org/3/library/pkgutil.html#pkgutil.resolve_name + name: resolve_name + uid: pkgutil.resolve_name +- fullName: pkgutil.walk_packages + href: https://docs.python.org/3/library/pkgutil.html#pkgutil.walk_packages + name: walk_packages + uid: pkgutil.walk_packages +- fullName: platform.android_ver + href: https://docs.python.org/3/library/platform.html#platform.android_ver + name: android_ver + uid: platform.android_ver +- fullName: platform.architecture + href: https://docs.python.org/3/library/platform.html#platform.architecture + name: architecture + uid: platform.architecture +- fullName: platform.freedesktop_os_release + href: https://docs.python.org/3/library/platform.html#platform.freedesktop_os_release + name: freedesktop_os_release + uid: platform.freedesktop_os_release +- fullName: platform.ios_ver + href: https://docs.python.org/3/library/platform.html#platform.ios_ver + name: ios_ver + uid: platform.ios_ver +- fullName: platform.java_ver + href: https://docs.python.org/3/library/platform.html#platform.java_ver + name: java_ver + uid: platform.java_ver +- fullName: platform.libc_ver + href: https://docs.python.org/3/library/platform.html#platform.libc_ver + name: libc_ver + uid: platform.libc_ver +- fullName: platform.mac_ver + href: https://docs.python.org/3/library/platform.html#platform.mac_ver + name: mac_ver + uid: platform.mac_ver +- fullName: platform.machine + href: https://docs.python.org/3/library/platform.html#platform.machine + name: machine + uid: platform.machine +- fullName: platform.node + href: https://docs.python.org/3/library/platform.html#platform.node + name: node + uid: platform.node +- fullName: platform.platform + href: https://docs.python.org/3/library/platform.html#platform.platform + name: platform + uid: platform.platform +- fullName: platform.processor + href: https://docs.python.org/3/library/platform.html#platform.processor + name: processor + uid: platform.processor +- fullName: platform.python_branch + href: https://docs.python.org/3/library/platform.html#platform.python_branch + name: python_branch + uid: platform.python_branch +- fullName: platform.python_build + href: https://docs.python.org/3/library/platform.html#platform.python_build + name: python_build + uid: platform.python_build +- fullName: platform.python_compiler + href: https://docs.python.org/3/library/platform.html#platform.python_compiler + name: python_compiler + uid: platform.python_compiler +- fullName: platform.python_implementation + href: https://docs.python.org/3/library/platform.html#platform.python_implementation + name: python_implementation + uid: platform.python_implementation +- fullName: platform.python_revision + href: https://docs.python.org/3/library/platform.html#platform.python_revision + name: python_revision + uid: platform.python_revision +- fullName: platform.python_version + href: https://docs.python.org/3/library/platform.html#platform.python_version + name: python_version + uid: platform.python_version +- fullName: platform.python_version_tuple + href: https://docs.python.org/3/library/platform.html#platform.python_version_tuple + name: python_version_tuple + uid: platform.python_version_tuple +- fullName: platform.release + href: https://docs.python.org/3/library/platform.html#platform.release + name: release + uid: platform.release +- fullName: platform.system + href: https://docs.python.org/3/library/platform.html#platform.system + name: system + uid: platform.system +- fullName: platform.system_alias + href: https://docs.python.org/3/library/platform.html#platform.system_alias + name: system_alias + uid: platform.system_alias +- fullName: platform.uname + href: https://docs.python.org/3/library/platform.html#platform.uname + name: uname + uid: platform.uname +- fullName: platform.version + href: https://docs.python.org/3/library/platform.html#platform.version + name: version + uid: platform.version +- fullName: platform.win32_edition + href: https://docs.python.org/3/library/platform.html#platform.win32_edition + name: win32_edition + uid: platform.win32_edition +- fullName: platform.win32_is_iot + href: https://docs.python.org/3/library/platform.html#platform.win32_is_iot + name: win32_is_iot + uid: platform.win32_is_iot +- fullName: platform.win32_ver + href: https://docs.python.org/3/library/platform.html#platform.win32_ver + name: win32_ver + uid: platform.win32_ver +- fullName: plistlib.dump + href: https://docs.python.org/3/library/plistlib.html#plistlib.dump + name: dump + uid: plistlib.dump +- fullName: plistlib.dumps + href: https://docs.python.org/3/library/plistlib.html#plistlib.dumps + name: dumps + uid: plistlib.dumps +- fullName: plistlib.load + href: https://docs.python.org/3/library/plistlib.html#plistlib.load + name: load + uid: plistlib.load +- fullName: plistlib.loads + href: https://docs.python.org/3/library/plistlib.html#plistlib.loads + name: loads + uid: plistlib.loads +- fullName: pow + href: https://docs.python.org/3/library/functions.html#pow + name: pow + uid: pow +- fullName: pprint.isreadable + href: https://docs.python.org/3/library/pprint.html#pprint.isreadable + name: isreadable + uid: pprint.isreadable +- fullName: pprint.isrecursive + href: https://docs.python.org/3/library/pprint.html#pprint.isrecursive + name: isrecursive + uid: pprint.isrecursive +- fullName: pprint.pformat + href: https://docs.python.org/3/library/pprint.html#pprint.pformat + name: pformat + uid: pprint.pformat +- fullName: pprint.pp + href: https://docs.python.org/3/library/pprint.html#pprint.pp + name: pp + uid: pprint.pp +- fullName: pprint.pprint + href: https://docs.python.org/3/library/pprint.html#pprint.pprint + name: pprint + uid: pprint.pprint +- fullName: pprint.saferepr + href: https://docs.python.org/3/library/pprint.html#pprint.saferepr + name: saferepr + uid: pprint.saferepr +- fullName: print + href: https://docs.python.org/3/library/functions.html#print + name: print + uid: print +- fullName: profile.run + href: https://docs.python.org/3/library/profile.html#profile.run + name: run + uid: profile.run +- fullName: profile.runctx + href: https://docs.python.org/3/library/profile.html#profile.runctx + name: runctx + uid: profile.runctx +- fullName: property.deleter + href: https://docs.python.org/3/library/functions.html#property.deleter + name: deleter + uid: property.deleter +- fullName: property.getter + href: https://docs.python.org/3/library/functions.html#property.getter + name: getter + uid: property.getter +- fullName: property.setter + href: https://docs.python.org/3/library/functions.html#property.setter + name: setter + uid: property.setter +- fullName: pty.fork + href: https://docs.python.org/3/library/pty.html#pty.fork + name: fork + uid: pty.fork +- fullName: pty.openpty + href: https://docs.python.org/3/library/pty.html#pty.openpty + name: openpty + uid: pty.openpty +- fullName: pty.spawn + href: https://docs.python.org/3/library/pty.html#pty.spawn + name: spawn + uid: pty.spawn +- fullName: pwd.getpwall + href: https://docs.python.org/3/library/pwd.html#pwd.getpwall + name: getpwall + uid: pwd.getpwall +- fullName: pwd.getpwnam + href: https://docs.python.org/3/library/pwd.html#pwd.getpwnam + name: getpwnam + uid: pwd.getpwnam +- fullName: pwd.getpwuid + href: https://docs.python.org/3/library/pwd.html#pwd.getpwuid + name: getpwuid + uid: pwd.getpwuid +- fullName: py_compile.compile + href: https://docs.python.org/3/library/py_compile.html#py_compile.compile + name: compile + uid: py_compile.compile +- fullName: pyclbr.readmodule + href: https://docs.python.org/3/library/pyclbr.html#pyclbr.readmodule + name: readmodule + uid: pyclbr.readmodule +- fullName: pyclbr.readmodule_ex + href: https://docs.python.org/3/library/pyclbr.html#pyclbr.readmodule_ex + name: readmodule_ex + uid: pyclbr.readmodule_ex +- fullName: quopri.decode + href: https://docs.python.org/3/library/quopri.html#quopri.decode + name: decode + uid: quopri.decode +- fullName: quopri.decodestring + href: https://docs.python.org/3/library/quopri.html#quopri.decodestring + name: decodestring + uid: quopri.decodestring +- fullName: quopri.encode + href: https://docs.python.org/3/library/quopri.html#quopri.encode + name: encode + uid: quopri.encode +- fullName: quopri.encodestring + href: https://docs.python.org/3/library/quopri.html#quopri.encodestring + name: encodestring + uid: quopri.encodestring +- fullName: random.betavariate + href: https://docs.python.org/3/library/random.html#random.betavariate + name: betavariate + uid: random.betavariate +- fullName: random.binomialvariate + href: https://docs.python.org/3/library/random.html#random.binomialvariate + name: binomialvariate + uid: random.binomialvariate +- fullName: random.choice + href: https://docs.python.org/3/library/random.html#random.choice + name: choice + uid: random.choice +- fullName: random.choices + href: https://docs.python.org/3/library/random.html#random.choices + name: choices + uid: random.choices +- fullName: random.expovariate + href: https://docs.python.org/3/library/random.html#random.expovariate + name: expovariate + uid: random.expovariate +- fullName: random.gammavariate + href: https://docs.python.org/3/library/random.html#random.gammavariate + name: gammavariate + uid: random.gammavariate +- fullName: random.gauss + href: https://docs.python.org/3/library/random.html#random.gauss + name: gauss + uid: random.gauss +- fullName: random.getrandbits + href: https://docs.python.org/3/library/random.html#random.getrandbits + name: getrandbits + uid: random.getrandbits +- fullName: random.getstate + href: https://docs.python.org/3/library/random.html#random.getstate + name: getstate + uid: random.getstate +- fullName: random.lognormvariate + href: https://docs.python.org/3/library/random.html#random.lognormvariate + name: lognormvariate + uid: random.lognormvariate +- fullName: random.normalvariate + href: https://docs.python.org/3/library/random.html#random.normalvariate + name: normalvariate + uid: random.normalvariate +- fullName: random.paretovariate + href: https://docs.python.org/3/library/random.html#random.paretovariate + name: paretovariate + uid: random.paretovariate +- fullName: random.randbytes + href: https://docs.python.org/3/library/random.html#random.randbytes + name: randbytes + uid: random.randbytes +- fullName: random.randint + href: https://docs.python.org/3/library/random.html#random.randint + name: randint + uid: random.randint +- fullName: random.random + href: https://docs.python.org/3/library/random.html#random.random + name: random + uid: random.random +- fullName: random.randrange + href: https://docs.python.org/3/library/random.html#random.randrange + name: randrange + uid: random.randrange +- fullName: random.sample + href: https://docs.python.org/3/library/random.html#random.sample + name: sample + uid: random.sample +- fullName: random.seed + href: https://docs.python.org/3/library/random.html#random.seed + name: seed + uid: random.seed +- fullName: random.setstate + href: https://docs.python.org/3/library/random.html#random.setstate + name: setstate + uid: random.setstate +- fullName: random.shuffle + href: https://docs.python.org/3/library/random.html#random.shuffle + name: shuffle + uid: random.shuffle +- fullName: random.triangular + href: https://docs.python.org/3/library/random.html#random.triangular + name: triangular + uid: random.triangular +- fullName: random.uniform + href: https://docs.python.org/3/library/random.html#random.uniform + name: uniform + uid: random.uniform +- fullName: random.vonmisesvariate + href: https://docs.python.org/3/library/random.html#random.vonmisesvariate + name: vonmisesvariate + uid: random.vonmisesvariate +- fullName: random.weibullvariate + href: https://docs.python.org/3/library/random.html#random.weibullvariate + name: weibullvariate + uid: random.weibullvariate +- fullName: re.compile + href: https://docs.python.org/3/library/re.html#re.compile + name: compile + uid: re.compile +- fullName: re.escape + href: https://docs.python.org/3/library/re.html#re.escape + name: escape + uid: re.escape +- fullName: re.findall + href: https://docs.python.org/3/library/re.html#re.findall + name: findall + uid: re.findall +- fullName: re.finditer + href: https://docs.python.org/3/library/re.html#re.finditer + name: finditer + uid: re.finditer +- fullName: re.fullmatch + href: https://docs.python.org/3/library/re.html#re.fullmatch + name: fullmatch + uid: re.fullmatch +- fullName: re.match + href: https://docs.python.org/3/library/re.html#re.match + name: match + uid: re.match +- fullName: re.purge + href: https://docs.python.org/3/library/re.html#re.purge + name: purge + uid: re.purge +- fullName: re.search + href: https://docs.python.org/3/library/re.html#re.search + name: search + uid: re.search +- fullName: re.split + href: https://docs.python.org/3/library/re.html#re.split + name: split + uid: re.split +- fullName: re.sub + href: https://docs.python.org/3/library/re.html#re.sub + name: sub + uid: re.sub +- fullName: re.subn + href: https://docs.python.org/3/library/re.html#re.subn + name: subn + uid: re.subn +- fullName: readline.add_history + href: https://docs.python.org/3/library/readline.html#readline.add_history + name: add_history + uid: readline.add_history +- fullName: readline.append_history_file + href: https://docs.python.org/3/library/readline.html#readline.append_history_file + name: append_history_file + uid: readline.append_history_file +- fullName: readline.clear_history + href: https://docs.python.org/3/library/readline.html#readline.clear_history + name: clear_history + uid: readline.clear_history +- fullName: readline.get_begidx + href: https://docs.python.org/3/library/readline.html#readline.get_begidx + name: get_begidx + uid: readline.get_begidx +- fullName: readline.get_completer + href: https://docs.python.org/3/library/readline.html#readline.get_completer + name: get_completer + uid: readline.get_completer +- fullName: readline.get_completer_delims + href: https://docs.python.org/3/library/readline.html#readline.get_completer_delims + name: get_completer_delims + uid: readline.get_completer_delims +- fullName: readline.get_completion_type + href: https://docs.python.org/3/library/readline.html#readline.get_completion_type + name: get_completion_type + uid: readline.get_completion_type +- fullName: readline.get_current_history_length + href: https://docs.python.org/3/library/readline.html#readline.get_current_history_length + name: get_current_history_length + uid: readline.get_current_history_length +- fullName: readline.get_endidx + href: https://docs.python.org/3/library/readline.html#readline.get_endidx + name: get_endidx + uid: readline.get_endidx +- fullName: readline.get_history_item + href: https://docs.python.org/3/library/readline.html#readline.get_history_item + name: get_history_item + uid: readline.get_history_item +- fullName: readline.get_history_length + href: https://docs.python.org/3/library/readline.html#readline.get_history_length + name: get_history_length + uid: readline.get_history_length +- fullName: readline.get_line_buffer + href: https://docs.python.org/3/library/readline.html#readline.get_line_buffer + name: get_line_buffer + uid: readline.get_line_buffer +- fullName: readline.insert_text + href: https://docs.python.org/3/library/readline.html#readline.insert_text + name: insert_text + uid: readline.insert_text +- fullName: readline.parse_and_bind + href: https://docs.python.org/3/library/readline.html#readline.parse_and_bind + name: parse_and_bind + uid: readline.parse_and_bind +- fullName: readline.read_history_file + href: https://docs.python.org/3/library/readline.html#readline.read_history_file + name: read_history_file + uid: readline.read_history_file +- fullName: readline.read_init_file + href: https://docs.python.org/3/library/readline.html#readline.read_init_file + name: read_init_file + uid: readline.read_init_file +- fullName: readline.redisplay + href: https://docs.python.org/3/library/readline.html#readline.redisplay + name: redisplay + uid: readline.redisplay +- fullName: readline.remove_history_item + href: https://docs.python.org/3/library/readline.html#readline.remove_history_item + name: remove_history_item + uid: readline.remove_history_item +- fullName: readline.replace_history_item + href: https://docs.python.org/3/library/readline.html#readline.replace_history_item + name: replace_history_item + uid: readline.replace_history_item +- fullName: readline.set_auto_history + href: https://docs.python.org/3/library/readline.html#readline.set_auto_history + name: set_auto_history + uid: readline.set_auto_history +- fullName: readline.set_completer + href: https://docs.python.org/3/library/readline.html#readline.set_completer + name: set_completer + uid: readline.set_completer +- fullName: readline.set_completer_delims + href: https://docs.python.org/3/library/readline.html#readline.set_completer_delims + name: set_completer_delims + uid: readline.set_completer_delims +- fullName: readline.set_completion_display_matches_hook + href: https://docs.python.org/3/library/readline.html#readline.set_completion_display_matches_hook + name: set_completion_display_matches_hook + uid: readline.set_completion_display_matches_hook +- fullName: readline.set_history_length + href: https://docs.python.org/3/library/readline.html#readline.set_history_length + name: set_history_length + uid: readline.set_history_length +- fullName: readline.set_pre_input_hook + href: https://docs.python.org/3/library/readline.html#readline.set_pre_input_hook + name: set_pre_input_hook + uid: readline.set_pre_input_hook +- fullName: readline.set_startup_hook + href: https://docs.python.org/3/library/readline.html#readline.set_startup_hook + name: set_startup_hook + uid: readline.set_startup_hook +- fullName: readline.write_history_file + href: https://docs.python.org/3/library/readline.html#readline.write_history_file + name: write_history_file + uid: readline.write_history_file +- fullName: repr + href: https://docs.python.org/3/library/functions.html#repr + name: repr + uid: repr +- fullName: reprlib.recursive_repr + href: https://docs.python.org/3/library/reprlib.html#reprlib.recursive_repr + name: recursive_repr + uid: reprlib.recursive_repr +- fullName: reprlib.repr + href: https://docs.python.org/3/library/reprlib.html#reprlib.repr + name: repr + uid: reprlib.repr +- fullName: resource.getpagesize + href: https://docs.python.org/3/library/resource.html#resource.getpagesize + name: getpagesize + uid: resource.getpagesize +- fullName: resource.getrlimit + href: https://docs.python.org/3/library/resource.html#resource.getrlimit + name: getrlimit + uid: resource.getrlimit +- fullName: resource.getrusage + href: https://docs.python.org/3/library/resource.html#resource.getrusage + name: getrusage + uid: resource.getrusage +- fullName: resource.prlimit + href: https://docs.python.org/3/library/resource.html#resource.prlimit + name: prlimit + uid: resource.prlimit +- fullName: resource.setrlimit + href: https://docs.python.org/3/library/resource.html#resource.setrlimit + name: setrlimit + uid: resource.setrlimit +- fullName: reversed + href: https://docs.python.org/3/library/functions.html#reversed + name: reversed + uid: reversed +- fullName: round + href: https://docs.python.org/3/library/functions.html#round + name: round + uid: round +- fullName: runpy.run_module + href: https://docs.python.org/3/library/runpy.html#runpy.run_module + name: run_module + uid: runpy.run_module +- fullName: runpy.run_path + href: https://docs.python.org/3/library/runpy.html#runpy.run_path + name: run_path + uid: runpy.run_path +- fullName: secrets.choice + href: https://docs.python.org/3/library/secrets.html#secrets.choice + name: choice + uid: secrets.choice +- fullName: secrets.compare_digest + href: https://docs.python.org/3/library/secrets.html#secrets.compare_digest + name: compare_digest + uid: secrets.compare_digest +- fullName: secrets.randbelow + href: https://docs.python.org/3/library/secrets.html#secrets.randbelow + name: randbelow + uid: secrets.randbelow +- fullName: secrets.randbits + href: https://docs.python.org/3/library/secrets.html#secrets.randbits + name: randbits + uid: secrets.randbits +- fullName: secrets.token_bytes + href: https://docs.python.org/3/library/secrets.html#secrets.token_bytes + name: token_bytes + uid: secrets.token_bytes +- fullName: secrets.token_hex + href: https://docs.python.org/3/library/secrets.html#secrets.token_hex + name: token_hex + uid: secrets.token_hex +- fullName: secrets.token_urlsafe + href: https://docs.python.org/3/library/secrets.html#secrets.token_urlsafe + name: token_urlsafe + uid: secrets.token_urlsafe +- fullName: select.devpoll + href: https://docs.python.org/3/library/select.html#select.devpoll + name: devpoll + uid: select.devpoll +- fullName: select.epoll + href: https://docs.python.org/3/library/select.html#select.epoll + name: epoll + uid: select.epoll +- fullName: select.kevent + href: https://docs.python.org/3/library/select.html#select.kevent + name: kevent + uid: select.kevent +- fullName: select.kqueue + href: https://docs.python.org/3/library/select.html#select.kqueue + name: kqueue + uid: select.kqueue +- fullName: select.poll + href: https://docs.python.org/3/library/select.html#select.poll + name: poll + uid: select.poll +- fullName: select.select + href: https://docs.python.org/3/library/select.html#select.select + name: select + uid: select.select +- fullName: setattr + href: https://docs.python.org/3/library/functions.html#setattr + name: setattr + uid: setattr +- fullName: shelve.open + href: https://docs.python.org/3/library/shelve.html#shelve.open + name: open + uid: shelve.open +- fullName: shlex.join + href: https://docs.python.org/3/library/shlex.html#shlex.join + name: join + uid: shlex.join +- fullName: shlex.quote + href: https://docs.python.org/3/library/shlex.html#shlex.quote + name: quote + uid: shlex.quote +- fullName: shlex.split + href: https://docs.python.org/3/library/shlex.html#shlex.split + name: split + uid: shlex.split +- fullName: shutil.chown + href: https://docs.python.org/3/library/shutil.html#shutil.chown + name: chown + uid: shutil.chown +- fullName: shutil.copy + href: https://docs.python.org/3/library/shutil.html#shutil.copy + name: copy + uid: shutil.copy +- fullName: shutil.copy2 + href: https://docs.python.org/3/library/shutil.html#shutil.copy2 + name: copy2 + uid: shutil.copy2 +- fullName: shutil.copyfile + href: https://docs.python.org/3/library/shutil.html#shutil.copyfile + name: copyfile + uid: shutil.copyfile +- fullName: shutil.copyfileobj + href: https://docs.python.org/3/library/shutil.html#shutil.copyfileobj + name: copyfileobj + uid: shutil.copyfileobj +- fullName: shutil.copymode + href: https://docs.python.org/3/library/shutil.html#shutil.copymode + name: copymode + uid: shutil.copymode +- fullName: shutil.copystat + href: https://docs.python.org/3/library/shutil.html#shutil.copystat + name: copystat + uid: shutil.copystat +- fullName: shutil.copytree + href: https://docs.python.org/3/library/shutil.html#shutil.copytree + name: copytree + uid: shutil.copytree +- fullName: shutil.disk_usage + href: https://docs.python.org/3/library/shutil.html#shutil.disk_usage + name: disk_usage + uid: shutil.disk_usage +- fullName: shutil.get_archive_formats + href: https://docs.python.org/3/library/shutil.html#shutil.get_archive_formats + name: get_archive_formats + uid: shutil.get_archive_formats +- fullName: shutil.get_terminal_size + href: https://docs.python.org/3/library/shutil.html#shutil.get_terminal_size + name: get_terminal_size + uid: shutil.get_terminal_size +- fullName: shutil.get_unpack_formats + href: https://docs.python.org/3/library/shutil.html#shutil.get_unpack_formats + name: get_unpack_formats + uid: shutil.get_unpack_formats +- fullName: shutil.ignore_patterns + href: https://docs.python.org/3/library/shutil.html#shutil.ignore_patterns + name: ignore_patterns + uid: shutil.ignore_patterns +- fullName: shutil.make_archive + href: https://docs.python.org/3/library/shutil.html#shutil.make_archive + name: make_archive + uid: shutil.make_archive +- fullName: shutil.move + href: https://docs.python.org/3/library/shutil.html#shutil.move + name: move + uid: shutil.move +- fullName: shutil.register_archive_format + href: https://docs.python.org/3/library/shutil.html#shutil.register_archive_format + name: register_archive_format + uid: shutil.register_archive_format +- fullName: shutil.register_unpack_format + href: https://docs.python.org/3/library/shutil.html#shutil.register_unpack_format + name: register_unpack_format + uid: shutil.register_unpack_format +- fullName: shutil.rmtree + href: https://docs.python.org/3/library/shutil.html#shutil.rmtree + name: rmtree + uid: shutil.rmtree +- fullName: shutil.unpack_archive + href: https://docs.python.org/3/library/shutil.html#shutil.unpack_archive + name: unpack_archive + uid: shutil.unpack_archive +- fullName: shutil.unregister_archive_format + href: https://docs.python.org/3/library/shutil.html#shutil.unregister_archive_format + name: unregister_archive_format + uid: shutil.unregister_archive_format +- fullName: shutil.unregister_unpack_format + href: https://docs.python.org/3/library/shutil.html#shutil.unregister_unpack_format + name: unregister_unpack_format + uid: shutil.unregister_unpack_format +- fullName: shutil.which + href: https://docs.python.org/3/library/shutil.html#shutil.which + name: which + uid: shutil.which +- fullName: signal.alarm + href: https://docs.python.org/3/library/signal.html#signal.alarm + name: alarm + uid: signal.alarm +- fullName: signal.getitimer + href: https://docs.python.org/3/library/signal.html#signal.getitimer + name: getitimer + uid: signal.getitimer +- fullName: signal.getsignal + href: https://docs.python.org/3/library/signal.html#signal.getsignal + name: getsignal + uid: signal.getsignal +- fullName: signal.pause + href: https://docs.python.org/3/library/signal.html#signal.pause + name: pause + uid: signal.pause +- fullName: signal.pidfd_send_signal + href: https://docs.python.org/3/library/signal.html#signal.pidfd_send_signal + name: pidfd_send_signal + uid: signal.pidfd_send_signal +- fullName: signal.pthread_kill + href: https://docs.python.org/3/library/signal.html#signal.pthread_kill + name: pthread_kill + uid: signal.pthread_kill +- fullName: signal.pthread_sigmask + href: https://docs.python.org/3/library/signal.html#signal.pthread_sigmask + name: pthread_sigmask + uid: signal.pthread_sigmask +- fullName: signal.raise_signal + href: https://docs.python.org/3/library/signal.html#signal.raise_signal + name: raise_signal + uid: signal.raise_signal +- fullName: signal.set_wakeup_fd + href: https://docs.python.org/3/library/signal.html#signal.set_wakeup_fd + name: set_wakeup_fd + uid: signal.set_wakeup_fd +- fullName: signal.setitimer + href: https://docs.python.org/3/library/signal.html#signal.setitimer + name: setitimer + uid: signal.setitimer +- fullName: signal.siginterrupt + href: https://docs.python.org/3/library/signal.html#signal.siginterrupt + name: siginterrupt + uid: signal.siginterrupt +- fullName: signal.signal + href: https://docs.python.org/3/library/signal.html#signal.signal + name: signal + uid: signal.signal +- fullName: signal.sigpending + href: https://docs.python.org/3/library/signal.html#signal.sigpending + name: sigpending + uid: signal.sigpending +- fullName: signal.sigtimedwait + href: https://docs.python.org/3/library/signal.html#signal.sigtimedwait + name: sigtimedwait + uid: signal.sigtimedwait +- fullName: signal.sigwait + href: https://docs.python.org/3/library/signal.html#signal.sigwait + name: sigwait + uid: signal.sigwait +- fullName: signal.sigwaitinfo + href: https://docs.python.org/3/library/signal.html#signal.sigwaitinfo + name: sigwaitinfo + uid: signal.sigwaitinfo +- fullName: signal.strsignal + href: https://docs.python.org/3/library/signal.html#signal.strsignal + name: strsignal + uid: signal.strsignal +- fullName: signal.valid_signals + href: https://docs.python.org/3/library/signal.html#signal.valid_signals + name: valid_signals + uid: signal.valid_signals +- fullName: site.addsitedir + href: https://docs.python.org/3/library/site.html#site.addsitedir + name: addsitedir + uid: site.addsitedir +- fullName: site.getsitepackages + href: https://docs.python.org/3/library/site.html#site.getsitepackages + name: getsitepackages + uid: site.getsitepackages +- fullName: site.getuserbase + href: https://docs.python.org/3/library/site.html#site.getuserbase + name: getuserbase + uid: site.getuserbase +- fullName: site.getusersitepackages + href: https://docs.python.org/3/library/site.html#site.getusersitepackages + name: getusersitepackages + uid: site.getusersitepackages +- fullName: site.main + href: https://docs.python.org/3/library/site.html#site.main + name: main + uid: site.main +- fullName: socket.CMSG_LEN + href: https://docs.python.org/3/library/socket.html#socket.CMSG_LEN + name: CMSG_LEN + uid: socket.CMSG_LEN +- fullName: socket.CMSG_SPACE + href: https://docs.python.org/3/library/socket.html#socket.CMSG_SPACE + name: CMSG_SPACE + uid: socket.CMSG_SPACE +- fullName: socket.close + href: https://docs.python.org/3/library/socket.html#socket.close + name: close + uid: socket.close +- fullName: socket.create_connection + href: https://docs.python.org/3/library/socket.html#socket.create_connection + name: create_connection + uid: socket.create_connection +- fullName: socket.create_server + href: https://docs.python.org/3/library/socket.html#socket.create_server + name: create_server + uid: socket.create_server +- fullName: socket.fromfd + href: https://docs.python.org/3/library/socket.html#socket.fromfd + name: fromfd + uid: socket.fromfd +- fullName: socket.fromshare + href: https://docs.python.org/3/library/socket.html#socket.fromshare + name: fromshare + uid: socket.fromshare +- fullName: socket.getaddrinfo + href: https://docs.python.org/3/library/socket.html#socket.getaddrinfo + name: getaddrinfo + uid: socket.getaddrinfo +- fullName: socket.getdefaulttimeout + href: https://docs.python.org/3/library/socket.html#socket.getdefaulttimeout + name: getdefaulttimeout + uid: socket.getdefaulttimeout +- fullName: socket.getfqdn + href: https://docs.python.org/3/library/socket.html#socket.getfqdn + name: getfqdn + uid: socket.getfqdn +- fullName: socket.gethostbyaddr + href: https://docs.python.org/3/library/socket.html#socket.gethostbyaddr + name: gethostbyaddr + uid: socket.gethostbyaddr +- fullName: socket.gethostbyname + href: https://docs.python.org/3/library/socket.html#socket.gethostbyname + name: gethostbyname + uid: socket.gethostbyname +- fullName: socket.gethostbyname_ex + href: https://docs.python.org/3/library/socket.html#socket.gethostbyname_ex + name: gethostbyname_ex + uid: socket.gethostbyname_ex +- fullName: socket.gethostname + href: https://docs.python.org/3/library/socket.html#socket.gethostname + name: gethostname + uid: socket.gethostname +- fullName: socket.getnameinfo + href: https://docs.python.org/3/library/socket.html#socket.getnameinfo + name: getnameinfo + uid: socket.getnameinfo +- fullName: socket.getprotobyname + href: https://docs.python.org/3/library/socket.html#socket.getprotobyname + name: getprotobyname + uid: socket.getprotobyname +- fullName: socket.getservbyname + href: https://docs.python.org/3/library/socket.html#socket.getservbyname + name: getservbyname + uid: socket.getservbyname +- fullName: socket.getservbyport + href: https://docs.python.org/3/library/socket.html#socket.getservbyport + name: getservbyport + uid: socket.getservbyport +- fullName: socket.has_dualstack_ipv6 + href: https://docs.python.org/3/library/socket.html#socket.has_dualstack_ipv6 + name: has_dualstack_ipv6 + uid: socket.has_dualstack_ipv6 +- fullName: socket.htonl + href: https://docs.python.org/3/library/socket.html#socket.htonl + name: htonl + uid: socket.htonl +- fullName: socket.htons + href: https://docs.python.org/3/library/socket.html#socket.htons + name: htons + uid: socket.htons +- fullName: socket.if_indextoname + href: https://docs.python.org/3/library/socket.html#socket.if_indextoname + name: if_indextoname + uid: socket.if_indextoname +- fullName: socket.if_nameindex + href: https://docs.python.org/3/library/socket.html#socket.if_nameindex + name: if_nameindex + uid: socket.if_nameindex +- fullName: socket.if_nametoindex + href: https://docs.python.org/3/library/socket.html#socket.if_nametoindex + name: if_nametoindex + uid: socket.if_nametoindex +- fullName: socket.inet_aton + href: https://docs.python.org/3/library/socket.html#socket.inet_aton + name: inet_aton + uid: socket.inet_aton +- fullName: socket.inet_ntoa + href: https://docs.python.org/3/library/socket.html#socket.inet_ntoa + name: inet_ntoa + uid: socket.inet_ntoa +- fullName: socket.inet_ntop + href: https://docs.python.org/3/library/socket.html#socket.inet_ntop + name: inet_ntop + uid: socket.inet_ntop +- fullName: socket.inet_pton + href: https://docs.python.org/3/library/socket.html#socket.inet_pton + name: inet_pton + uid: socket.inet_pton +- fullName: socket.ntohl + href: https://docs.python.org/3/library/socket.html#socket.ntohl + name: ntohl + uid: socket.ntohl +- fullName: socket.ntohs + href: https://docs.python.org/3/library/socket.html#socket.ntohs + name: ntohs + uid: socket.ntohs +- fullName: socket.recv_fds + href: https://docs.python.org/3/library/socket.html#socket.recv_fds + name: recv_fds + uid: socket.recv_fds +- fullName: socket.send_fds + href: https://docs.python.org/3/library/socket.html#socket.send_fds + name: send_fds + uid: socket.send_fds +- fullName: socket.setdefaulttimeout + href: https://docs.python.org/3/library/socket.html#socket.setdefaulttimeout + name: setdefaulttimeout + uid: socket.setdefaulttimeout +- fullName: socket.sethostname + href: https://docs.python.org/3/library/socket.html#socket.sethostname + name: sethostname + uid: socket.sethostname +- fullName: socket.socketpair + href: https://docs.python.org/3/library/socket.html#socket.socketpair + name: socketpair + uid: socket.socketpair +- fullName: sorted + href: https://docs.python.org/3/library/functions.html#sorted + name: sorted + uid: sorted +- fullName: sqlite3.complete_statement + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.complete_statement + name: complete_statement + uid: sqlite3.complete_statement +- fullName: sqlite3.connect + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.connect + name: connect + uid: sqlite3.connect +- fullName: sqlite3.enable_callback_tracebacks + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.enable_callback_tracebacks + name: enable_callback_tracebacks + uid: sqlite3.enable_callback_tracebacks +- fullName: sqlite3.register_adapter + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.register_adapter + name: register_adapter + uid: sqlite3.register_adapter +- fullName: sqlite3.register_converter + href: https://docs.python.org/3/library/sqlite3.html#sqlite3.register_converter + name: register_converter + uid: sqlite3.register_converter +- fullName: ssl.DER_cert_to_PEM_cert + href: https://docs.python.org/3/library/ssl.html#ssl.DER_cert_to_PEM_cert + name: DER_cert_to_PEM_cert + uid: ssl.DER_cert_to_PEM_cert +- fullName: ssl.PEM_cert_to_DER_cert + href: https://docs.python.org/3/library/ssl.html#ssl.PEM_cert_to_DER_cert + name: PEM_cert_to_DER_cert + uid: ssl.PEM_cert_to_DER_cert +- fullName: ssl.RAND_add + href: https://docs.python.org/3/library/ssl.html#ssl.RAND_add + name: RAND_add + uid: ssl.RAND_add +- fullName: ssl.RAND_bytes + href: https://docs.python.org/3/library/ssl.html#ssl.RAND_bytes + name: RAND_bytes + uid: ssl.RAND_bytes +- fullName: ssl.RAND_status + href: https://docs.python.org/3/library/ssl.html#ssl.RAND_status + name: RAND_status + uid: ssl.RAND_status +- fullName: ssl.cert_time_to_seconds + href: https://docs.python.org/3/library/ssl.html#ssl.cert_time_to_seconds + name: cert_time_to_seconds + uid: ssl.cert_time_to_seconds +- fullName: ssl.create_default_context + href: https://docs.python.org/3/library/ssl.html#ssl.create_default_context + name: create_default_context + uid: ssl.create_default_context +- fullName: ssl.enum_certificates + href: https://docs.python.org/3/library/ssl.html#ssl.enum_certificates + name: enum_certificates + uid: ssl.enum_certificates +- fullName: ssl.enum_crls + href: https://docs.python.org/3/library/ssl.html#ssl.enum_crls + name: enum_crls + uid: ssl.enum_crls +- fullName: ssl.get_default_verify_paths + href: https://docs.python.org/3/library/ssl.html#ssl.get_default_verify_paths + name: get_default_verify_paths + uid: ssl.get_default_verify_paths +- fullName: ssl.get_server_certificate + href: https://docs.python.org/3/library/ssl.html#ssl.get_server_certificate + name: get_server_certificate + uid: ssl.get_server_certificate +- fullName: stat.S_IFMT + href: https://docs.python.org/3/library/stat.html#stat.S_IFMT + name: S_IFMT + uid: stat.S_IFMT +- fullName: stat.S_IMODE + href: https://docs.python.org/3/library/stat.html#stat.S_IMODE + name: S_IMODE + uid: stat.S_IMODE +- fullName: stat.S_ISBLK + href: https://docs.python.org/3/library/stat.html#stat.S_ISBLK + name: S_ISBLK + uid: stat.S_ISBLK +- fullName: stat.S_ISCHR + href: https://docs.python.org/3/library/stat.html#stat.S_ISCHR + name: S_ISCHR + uid: stat.S_ISCHR +- fullName: stat.S_ISDIR + href: https://docs.python.org/3/library/stat.html#stat.S_ISDIR + name: S_ISDIR + uid: stat.S_ISDIR +- fullName: stat.S_ISDOOR + href: https://docs.python.org/3/library/stat.html#stat.S_ISDOOR + name: S_ISDOOR + uid: stat.S_ISDOOR +- fullName: stat.S_ISFIFO + href: https://docs.python.org/3/library/stat.html#stat.S_ISFIFO + name: S_ISFIFO + uid: stat.S_ISFIFO +- fullName: stat.S_ISLNK + href: https://docs.python.org/3/library/stat.html#stat.S_ISLNK + name: S_ISLNK + uid: stat.S_ISLNK +- fullName: stat.S_ISPORT + href: https://docs.python.org/3/library/stat.html#stat.S_ISPORT + name: S_ISPORT + uid: stat.S_ISPORT +- fullName: stat.S_ISREG + href: https://docs.python.org/3/library/stat.html#stat.S_ISREG + name: S_ISREG + uid: stat.S_ISREG +- fullName: stat.S_ISSOCK + href: https://docs.python.org/3/library/stat.html#stat.S_ISSOCK + name: S_ISSOCK + uid: stat.S_ISSOCK +- fullName: stat.S_ISWHT + href: https://docs.python.org/3/library/stat.html#stat.S_ISWHT + name: S_ISWHT + uid: stat.S_ISWHT +- fullName: stat.filemode + href: https://docs.python.org/3/library/stat.html#stat.filemode + name: filemode + uid: stat.filemode +- fullName: staticmethod + href: https://docs.python.org/3/library/functions.html#staticmethod + name: staticmethod + uid: staticmethod +- fullName: statistics.correlation + href: https://docs.python.org/3/library/statistics.html#statistics.correlation + name: correlation + uid: statistics.correlation +- fullName: statistics.covariance + href: https://docs.python.org/3/library/statistics.html#statistics.covariance + name: covariance + uid: statistics.covariance +- fullName: statistics.fmean + href: https://docs.python.org/3/library/statistics.html#statistics.fmean + name: fmean + uid: statistics.fmean +- fullName: statistics.geometric_mean + href: https://docs.python.org/3/library/statistics.html#statistics.geometric_mean + name: geometric_mean + uid: statistics.geometric_mean +- fullName: statistics.harmonic_mean + href: https://docs.python.org/3/library/statistics.html#statistics.harmonic_mean + name: harmonic_mean + uid: statistics.harmonic_mean +- fullName: statistics.kde + href: https://docs.python.org/3/library/statistics.html#statistics.kde + name: kde + uid: statistics.kde +- fullName: statistics.kde_random + href: https://docs.python.org/3/library/statistics.html#statistics.kde_random + name: kde_random + uid: statistics.kde_random +- fullName: statistics.linear_regression + href: https://docs.python.org/3/library/statistics.html#statistics.linear_regression + name: linear_regression + uid: statistics.linear_regression +- fullName: statistics.mean + href: https://docs.python.org/3/library/statistics.html#statistics.mean + name: mean + uid: statistics.mean +- fullName: statistics.median + href: https://docs.python.org/3/library/statistics.html#statistics.median + name: median + uid: statistics.median +- fullName: statistics.median_grouped + href: https://docs.python.org/3/library/statistics.html#statistics.median_grouped + name: median_grouped + uid: statistics.median_grouped +- fullName: statistics.median_high + href: https://docs.python.org/3/library/statistics.html#statistics.median_high + name: median_high + uid: statistics.median_high +- fullName: statistics.median_low + href: https://docs.python.org/3/library/statistics.html#statistics.median_low + name: median_low + uid: statistics.median_low +- fullName: statistics.mode + href: https://docs.python.org/3/library/statistics.html#statistics.mode + name: mode + uid: statistics.mode +- fullName: statistics.multimode + href: https://docs.python.org/3/library/statistics.html#statistics.multimode + name: multimode + uid: statistics.multimode +- fullName: statistics.pstdev + href: https://docs.python.org/3/library/statistics.html#statistics.pstdev + name: pstdev + uid: statistics.pstdev +- fullName: statistics.pvariance + href: https://docs.python.org/3/library/statistics.html#statistics.pvariance + name: pvariance + uid: statistics.pvariance +- fullName: statistics.quantiles + href: https://docs.python.org/3/library/statistics.html#statistics.quantiles + name: quantiles + uid: statistics.quantiles +- fullName: statistics.stdev + href: https://docs.python.org/3/library/statistics.html#statistics.stdev + name: stdev + uid: statistics.stdev +- fullName: statistics.variance + href: https://docs.python.org/3/library/statistics.html#statistics.variance + name: variance + uid: statistics.variance +- fullName: string.capwords + href: https://docs.python.org/3/library/string.html#string.capwords + name: capwords + uid: string.capwords +- fullName: stringprep.in_table_a1 + href: https://docs.python.org/3/library/stringprep.html#stringprep.in_table_a1 + name: in_table_a1 + uid: stringprep.in_table_a1 +- fullName: stringprep.in_table_b1 + href: https://docs.python.org/3/library/stringprep.html#stringprep.in_table_b1 + name: in_table_b1 + uid: stringprep.in_table_b1 +- fullName: stringprep.in_table_c11 + href: https://docs.python.org/3/library/stringprep.html#stringprep.in_table_c11 + name: in_table_c11 + uid: stringprep.in_table_c11 +- fullName: stringprep.in_table_c11_c12 + href: https://docs.python.org/3/library/stringprep.html#stringprep.in_table_c11_c12 + name: in_table_c11_c12 + uid: stringprep.in_table_c11_c12 +- fullName: stringprep.in_table_c12 + href: https://docs.python.org/3/library/stringprep.html#stringprep.in_table_c12 + name: in_table_c12 + uid: stringprep.in_table_c12 +- fullName: stringprep.in_table_c21 + href: https://docs.python.org/3/library/stringprep.html#stringprep.in_table_c21 + name: in_table_c21 + uid: stringprep.in_table_c21 +- fullName: stringprep.in_table_c21_c22 + href: https://docs.python.org/3/library/stringprep.html#stringprep.in_table_c21_c22 + name: in_table_c21_c22 + uid: stringprep.in_table_c21_c22 +- fullName: stringprep.in_table_c22 + href: https://docs.python.org/3/library/stringprep.html#stringprep.in_table_c22 + name: in_table_c22 + uid: stringprep.in_table_c22 +- fullName: stringprep.in_table_c3 + href: https://docs.python.org/3/library/stringprep.html#stringprep.in_table_c3 + name: in_table_c3 + uid: stringprep.in_table_c3 +- fullName: stringprep.in_table_c4 + href: https://docs.python.org/3/library/stringprep.html#stringprep.in_table_c4 + name: in_table_c4 + uid: stringprep.in_table_c4 +- fullName: stringprep.in_table_c5 + href: https://docs.python.org/3/library/stringprep.html#stringprep.in_table_c5 + name: in_table_c5 + uid: stringprep.in_table_c5 +- fullName: stringprep.in_table_c6 + href: https://docs.python.org/3/library/stringprep.html#stringprep.in_table_c6 + name: in_table_c6 + uid: stringprep.in_table_c6 +- fullName: stringprep.in_table_c7 + href: https://docs.python.org/3/library/stringprep.html#stringprep.in_table_c7 + name: in_table_c7 + uid: stringprep.in_table_c7 +- fullName: stringprep.in_table_c8 + href: https://docs.python.org/3/library/stringprep.html#stringprep.in_table_c8 + name: in_table_c8 + uid: stringprep.in_table_c8 +- fullName: stringprep.in_table_c9 + href: https://docs.python.org/3/library/stringprep.html#stringprep.in_table_c9 + name: in_table_c9 + uid: stringprep.in_table_c9 +- fullName: stringprep.in_table_d1 + href: https://docs.python.org/3/library/stringprep.html#stringprep.in_table_d1 + name: in_table_d1 + uid: stringprep.in_table_d1 +- fullName: stringprep.in_table_d2 + href: https://docs.python.org/3/library/stringprep.html#stringprep.in_table_d2 + name: in_table_d2 + uid: stringprep.in_table_d2 +- fullName: stringprep.map_table_b2 + href: https://docs.python.org/3/library/stringprep.html#stringprep.map_table_b2 + name: map_table_b2 + uid: stringprep.map_table_b2 +- fullName: stringprep.map_table_b3 + href: https://docs.python.org/3/library/stringprep.html#stringprep.map_table_b3 + name: map_table_b3 + uid: stringprep.map_table_b3 +- fullName: struct.calcsize + href: https://docs.python.org/3/library/struct.html#struct.calcsize + name: calcsize + uid: struct.calcsize +- fullName: struct.iter_unpack + href: https://docs.python.org/3/library/struct.html#struct.iter_unpack + name: iter_unpack + uid: struct.iter_unpack +- fullName: struct.pack + href: https://docs.python.org/3/library/struct.html#struct.pack + name: pack + uid: struct.pack +- fullName: struct.pack_into + href: https://docs.python.org/3/library/struct.html#struct.pack_into + name: pack_into + uid: struct.pack_into +- fullName: struct.unpack + href: https://docs.python.org/3/library/struct.html#struct.unpack + name: unpack + uid: struct.unpack +- fullName: struct.unpack_from + href: https://docs.python.org/3/library/struct.html#struct.unpack_from + name: unpack_from + uid: struct.unpack_from +- fullName: subprocess.call + href: https://docs.python.org/3/library/subprocess.html#subprocess.call + name: call + uid: subprocess.call +- fullName: subprocess.check_call + href: https://docs.python.org/3/library/subprocess.html#subprocess.check_call + name: check_call + uid: subprocess.check_call +- fullName: subprocess.check_output + href: https://docs.python.org/3/library/subprocess.html#subprocess.check_output + name: check_output + uid: subprocess.check_output +- fullName: subprocess.getoutput + href: https://docs.python.org/3/library/subprocess.html#subprocess.getoutput + name: getoutput + uid: subprocess.getoutput +- fullName: subprocess.getstatusoutput + href: https://docs.python.org/3/library/subprocess.html#subprocess.getstatusoutput + name: getstatusoutput + uid: subprocess.getstatusoutput +- fullName: subprocess.run + href: https://docs.python.org/3/library/subprocess.html#subprocess.run + name: run + uid: subprocess.run +- fullName: sum + href: https://docs.python.org/3/library/functions.html#sum + name: sum + uid: sum +- fullName: symtable.symtable + href: https://docs.python.org/3/library/symtable.html#symtable.symtable + name: symtable + uid: symtable.symtable +- fullName: sys._clear_internal_caches + href: https://docs.python.org/3/library/sys.html#sys._clear_internal_caches + name: _clear_internal_caches + uid: sys._clear_internal_caches +- fullName: sys._clear_type_cache + href: https://docs.python.org/3/library/sys.html#sys._clear_type_cache + name: _clear_type_cache + uid: sys._clear_type_cache +- fullName: sys._current_exceptions + href: https://docs.python.org/3/library/sys.html#sys._current_exceptions + name: _current_exceptions + uid: sys._current_exceptions +- fullName: sys._current_frames + href: https://docs.python.org/3/library/sys.html#sys._current_frames + name: _current_frames + uid: sys._current_frames +- fullName: sys._debugmallocstats + href: https://docs.python.org/3/library/sys.html#sys._debugmallocstats + name: _debugmallocstats + uid: sys._debugmallocstats +- fullName: sys._enablelegacywindowsfsencoding + href: https://docs.python.org/3/library/sys.html#sys._enablelegacywindowsfsencoding + name: _enablelegacywindowsfsencoding + uid: sys._enablelegacywindowsfsencoding +- fullName: sys._getframe + href: https://docs.python.org/3/library/sys.html#sys._getframe + name: _getframe + uid: sys._getframe +- fullName: sys._getframemodulename + href: https://docs.python.org/3/library/sys.html#sys._getframemodulename + name: _getframemodulename + uid: sys._getframemodulename +- fullName: sys._is_gil_enabled + href: https://docs.python.org/3/library/sys.html#sys._is_gil_enabled + name: _is_gil_enabled + uid: sys._is_gil_enabled +- fullName: sys._is_interned + href: https://docs.python.org/3/library/sys.html#sys._is_interned + name: _is_interned + uid: sys._is_interned +- fullName: sys.activate_stack_trampoline + href: https://docs.python.org/3/library/sys.html#sys.activate_stack_trampoline + name: activate_stack_trampoline + uid: sys.activate_stack_trampoline +- fullName: sys.addaudithook + href: https://docs.python.org/3/library/sys.html#sys.addaudithook + name: addaudithook + uid: sys.addaudithook +- fullName: sys.audit + href: https://docs.python.org/3/library/sys.html#sys.audit + name: audit + uid: sys.audit +- fullName: sys.breakpointhook + href: https://docs.python.org/3/library/sys.html#sys.breakpointhook + name: breakpointhook + uid: sys.breakpointhook +- fullName: sys.call_tracing + href: https://docs.python.org/3/library/sys.html#sys.call_tracing + name: call_tracing + uid: sys.call_tracing +- fullName: sys.deactivate_stack_trampoline + href: https://docs.python.org/3/library/sys.html#sys.deactivate_stack_trampoline + name: deactivate_stack_trampoline + uid: sys.deactivate_stack_trampoline +- fullName: sys.displayhook + href: https://docs.python.org/3/library/sys.html#sys.displayhook + name: displayhook + uid: sys.displayhook +- fullName: sys.exc_info + href: https://docs.python.org/3/library/sys.html#sys.exc_info + name: exc_info + uid: sys.exc_info +- fullName: sys.excepthook + href: https://docs.python.org/3/library/sys.html#sys.excepthook + name: excepthook + uid: sys.excepthook +- fullName: sys.exception + href: https://docs.python.org/3/library/sys.html#sys.exception + name: exception + uid: sys.exception +- fullName: sys.exit + href: https://docs.python.org/3/library/sys.html#sys.exit + name: exit + uid: sys.exit +- fullName: sys.get_asyncgen_hooks + href: https://docs.python.org/3/library/sys.html#sys.get_asyncgen_hooks + name: get_asyncgen_hooks + uid: sys.get_asyncgen_hooks +- fullName: sys.get_coroutine_origin_tracking_depth + href: https://docs.python.org/3/library/sys.html#sys.get_coroutine_origin_tracking_depth + name: get_coroutine_origin_tracking_depth + uid: sys.get_coroutine_origin_tracking_depth +- fullName: sys.get_int_max_str_digits + href: https://docs.python.org/3/library/sys.html#sys.get_int_max_str_digits + name: get_int_max_str_digits + uid: sys.get_int_max_str_digits +- fullName: sys.getallocatedblocks + href: https://docs.python.org/3/library/sys.html#sys.getallocatedblocks + name: getallocatedblocks + uid: sys.getallocatedblocks +- fullName: sys.getandroidapilevel + href: https://docs.python.org/3/library/sys.html#sys.getandroidapilevel + name: getandroidapilevel + uid: sys.getandroidapilevel +- fullName: sys.getdefaultencoding + href: https://docs.python.org/3/library/sys.html#sys.getdefaultencoding + name: getdefaultencoding + uid: sys.getdefaultencoding +- fullName: sys.getdlopenflags + href: https://docs.python.org/3/library/sys.html#sys.getdlopenflags + name: getdlopenflags + uid: sys.getdlopenflags +- fullName: sys.getfilesystemencodeerrors + href: https://docs.python.org/3/library/sys.html#sys.getfilesystemencodeerrors + name: getfilesystemencodeerrors + uid: sys.getfilesystemencodeerrors +- fullName: sys.getfilesystemencoding + href: https://docs.python.org/3/library/sys.html#sys.getfilesystemencoding + name: getfilesystemencoding + uid: sys.getfilesystemencoding +- fullName: sys.getobjects + href: https://docs.python.org/3/library/sys.html#sys.getobjects + name: getobjects + uid: sys.getobjects +- fullName: sys.getprofile + href: https://docs.python.org/3/library/sys.html#sys.getprofile + name: getprofile + uid: sys.getprofile +- fullName: sys.getrecursionlimit + href: https://docs.python.org/3/library/sys.html#sys.getrecursionlimit + name: getrecursionlimit + uid: sys.getrecursionlimit +- fullName: sys.getrefcount + href: https://docs.python.org/3/library/sys.html#sys.getrefcount + name: getrefcount + uid: sys.getrefcount +- fullName: sys.getsizeof + href: https://docs.python.org/3/library/sys.html#sys.getsizeof + name: getsizeof + uid: sys.getsizeof +- fullName: sys.getswitchinterval + href: https://docs.python.org/3/library/sys.html#sys.getswitchinterval + name: getswitchinterval + uid: sys.getswitchinterval +- fullName: sys.gettrace + href: https://docs.python.org/3/library/sys.html#sys.gettrace + name: gettrace + uid: sys.gettrace +- fullName: sys.getunicodeinternedsize + href: https://docs.python.org/3/library/sys.html#sys.getunicodeinternedsize + name: getunicodeinternedsize + uid: sys.getunicodeinternedsize +- fullName: sys.getwindowsversion + href: https://docs.python.org/3/library/sys.html#sys.getwindowsversion + name: getwindowsversion + uid: sys.getwindowsversion +- fullName: sys.intern + href: https://docs.python.org/3/library/sys.html#sys.intern + name: intern + uid: sys.intern +- fullName: sys.is_finalizing + href: https://docs.python.org/3/library/sys.html#sys.is_finalizing + name: is_finalizing + uid: sys.is_finalizing +- fullName: sys.is_stack_trampoline_active + href: https://docs.python.org/3/library/sys.html#sys.is_stack_trampoline_active + name: is_stack_trampoline_active + uid: sys.is_stack_trampoline_active +- fullName: sys.monitoring.free_tool_id + href: https://docs.python.org/3/library/sys.monitoring.html#sys.monitoring.free_tool_id + name: free_tool_id + uid: sys.monitoring.free_tool_id +- fullName: sys.monitoring.get_events + href: https://docs.python.org/3/library/sys.monitoring.html#sys.monitoring.get_events + name: get_events + uid: sys.monitoring.get_events +- fullName: sys.monitoring.get_local_events + href: https://docs.python.org/3/library/sys.monitoring.html#sys.monitoring.get_local_events + name: get_local_events + uid: sys.monitoring.get_local_events +- fullName: sys.monitoring.get_tool + href: https://docs.python.org/3/library/sys.monitoring.html#sys.monitoring.get_tool + name: get_tool + uid: sys.monitoring.get_tool +- fullName: sys.monitoring.register_callback + href: https://docs.python.org/3/library/sys.monitoring.html#sys.monitoring.register_callback + name: register_callback + uid: sys.monitoring.register_callback +- fullName: sys.monitoring.restart_events + href: https://docs.python.org/3/library/sys.monitoring.html#sys.monitoring.restart_events + name: restart_events + uid: sys.monitoring.restart_events +- fullName: sys.monitoring.set_events + href: https://docs.python.org/3/library/sys.monitoring.html#sys.monitoring.set_events + name: set_events + uid: sys.monitoring.set_events +- fullName: sys.monitoring.set_local_events + href: https://docs.python.org/3/library/sys.monitoring.html#sys.monitoring.set_local_events + name: set_local_events + uid: sys.monitoring.set_local_events +- fullName: sys.monitoring.use_tool_id + href: https://docs.python.org/3/library/sys.monitoring.html#sys.monitoring.use_tool_id + name: use_tool_id + uid: sys.monitoring.use_tool_id +- fullName: sys.set_asyncgen_hooks + href: https://docs.python.org/3/library/sys.html#sys.set_asyncgen_hooks + name: set_asyncgen_hooks + uid: sys.set_asyncgen_hooks +- fullName: sys.set_coroutine_origin_tracking_depth + href: https://docs.python.org/3/library/sys.html#sys.set_coroutine_origin_tracking_depth + name: set_coroutine_origin_tracking_depth + uid: sys.set_coroutine_origin_tracking_depth +- fullName: sys.set_int_max_str_digits + href: https://docs.python.org/3/library/sys.html#sys.set_int_max_str_digits + name: set_int_max_str_digits + uid: sys.set_int_max_str_digits +- fullName: sys.setdlopenflags + href: https://docs.python.org/3/library/sys.html#sys.setdlopenflags + name: setdlopenflags + uid: sys.setdlopenflags +- fullName: sys.setprofile + href: https://docs.python.org/3/library/sys.html#sys.setprofile + name: setprofile + uid: sys.setprofile +- fullName: sys.setrecursionlimit + href: https://docs.python.org/3/library/sys.html#sys.setrecursionlimit + name: setrecursionlimit + uid: sys.setrecursionlimit +- fullName: sys.setswitchinterval + href: https://docs.python.org/3/library/sys.html#sys.setswitchinterval + name: setswitchinterval + uid: sys.setswitchinterval +- fullName: sys.settrace + href: https://docs.python.org/3/library/sys.html#sys.settrace + name: settrace + uid: sys.settrace +- fullName: sys.unraisablehook + href: https://docs.python.org/3/library/sys.html#sys.unraisablehook + name: unraisablehook + uid: sys.unraisablehook +- fullName: sysconfig._get_preferred_schemes + href: https://docs.python.org/3/library/sysconfig.html#sysconfig._get_preferred_schemes + name: _get_preferred_schemes + uid: sysconfig._get_preferred_schemes +- fullName: sysconfig.get_config_h_filename + href: https://docs.python.org/3/library/sysconfig.html#sysconfig.get_config_h_filename + name: get_config_h_filename + uid: sysconfig.get_config_h_filename +- fullName: sysconfig.get_config_var + href: https://docs.python.org/3/library/sysconfig.html#sysconfig.get_config_var + name: get_config_var + uid: sysconfig.get_config_var +- fullName: sysconfig.get_config_vars + href: https://docs.python.org/3/library/sysconfig.html#sysconfig.get_config_vars + name: get_config_vars + uid: sysconfig.get_config_vars +- fullName: sysconfig.get_default_scheme + href: https://docs.python.org/3/library/sysconfig.html#sysconfig.get_default_scheme + name: get_default_scheme + uid: sysconfig.get_default_scheme +- fullName: sysconfig.get_makefile_filename + href: https://docs.python.org/3/library/sysconfig.html#sysconfig.get_makefile_filename + name: get_makefile_filename + uid: sysconfig.get_makefile_filename +- fullName: sysconfig.get_path + href: https://docs.python.org/3/library/sysconfig.html#sysconfig.get_path + name: get_path + uid: sysconfig.get_path +- fullName: sysconfig.get_path_names + href: https://docs.python.org/3/library/sysconfig.html#sysconfig.get_path_names + name: get_path_names + uid: sysconfig.get_path_names +- fullName: sysconfig.get_paths + href: https://docs.python.org/3/library/sysconfig.html#sysconfig.get_paths + name: get_paths + uid: sysconfig.get_paths +- fullName: sysconfig.get_platform + href: https://docs.python.org/3/library/sysconfig.html#sysconfig.get_platform + name: get_platform + uid: sysconfig.get_platform +- fullName: sysconfig.get_preferred_scheme + href: https://docs.python.org/3/library/sysconfig.html#sysconfig.get_preferred_scheme + name: get_preferred_scheme + uid: sysconfig.get_preferred_scheme +- fullName: sysconfig.get_python_version + href: https://docs.python.org/3/library/sysconfig.html#sysconfig.get_python_version + name: get_python_version + uid: sysconfig.get_python_version +- fullName: sysconfig.get_scheme_names + href: https://docs.python.org/3/library/sysconfig.html#sysconfig.get_scheme_names + name: get_scheme_names + uid: sysconfig.get_scheme_names +- fullName: sysconfig.is_python_build + href: https://docs.python.org/3/library/sysconfig.html#sysconfig.is_python_build + name: is_python_build + uid: sysconfig.is_python_build +- fullName: sysconfig.parse_config_h + href: https://docs.python.org/3/library/sysconfig.html#sysconfig.parse_config_h + name: parse_config_h + uid: sysconfig.parse_config_h +- fullName: syslog.closelog + href: https://docs.python.org/3/library/syslog.html#syslog.closelog + name: closelog + uid: syslog.closelog +- fullName: syslog.openlog + href: https://docs.python.org/3/library/syslog.html#syslog.openlog + name: openlog + uid: syslog.openlog +- fullName: syslog.setlogmask + href: https://docs.python.org/3/library/syslog.html#syslog.setlogmask + name: setlogmask + uid: syslog.setlogmask +- fullName: syslog.syslog + href: https://docs.python.org/3/library/syslog.html#syslog.syslog + name: syslog + uid: syslog.syslog +- fullName: tabnanny.check + href: https://docs.python.org/3/library/tabnanny.html#tabnanny.check + name: check + uid: tabnanny.check +- fullName: tabnanny.process_tokens + href: https://docs.python.org/3/library/tabnanny.html#tabnanny.process_tokens + name: process_tokens + uid: tabnanny.process_tokens +- fullName: tarfile.data_filter + href: https://docs.python.org/3/library/tarfile.html#tarfile.data_filter + name: data_filter + uid: tarfile.data_filter +- fullName: tarfile.fully_trusted_filter + href: https://docs.python.org/3/library/tarfile.html#tarfile.fully_trusted_filter + name: fully_trusted_filter + uid: tarfile.fully_trusted_filter +- fullName: tarfile.is_tarfile + href: https://docs.python.org/3/library/tarfile.html#tarfile.is_tarfile + name: is_tarfile + uid: tarfile.is_tarfile +- fullName: tarfile.open + href: https://docs.python.org/3/library/tarfile.html#tarfile.open + name: open + uid: tarfile.open +- fullName: tarfile.tar_filter + href: https://docs.python.org/3/library/tarfile.html#tarfile.tar_filter + name: tar_filter + uid: tarfile.tar_filter +- fullName: tempfile.NamedTemporaryFile + href: https://docs.python.org/3/library/tempfile.html#tempfile.NamedTemporaryFile + name: NamedTemporaryFile + uid: tempfile.NamedTemporaryFile +- fullName: tempfile.TemporaryFile + href: https://docs.python.org/3/library/tempfile.html#tempfile.TemporaryFile + name: TemporaryFile + uid: tempfile.TemporaryFile +- fullName: tempfile.gettempdir + href: https://docs.python.org/3/library/tempfile.html#tempfile.gettempdir + name: gettempdir + uid: tempfile.gettempdir +- fullName: tempfile.gettempdirb + href: https://docs.python.org/3/library/tempfile.html#tempfile.gettempdirb + name: gettempdirb + uid: tempfile.gettempdirb +- fullName: tempfile.gettempprefix + href: https://docs.python.org/3/library/tempfile.html#tempfile.gettempprefix + name: gettempprefix + uid: tempfile.gettempprefix +- fullName: tempfile.gettempprefixb + href: https://docs.python.org/3/library/tempfile.html#tempfile.gettempprefixb + name: gettempprefixb + uid: tempfile.gettempprefixb +- fullName: tempfile.mkdtemp + href: https://docs.python.org/3/library/tempfile.html#tempfile.mkdtemp + name: mkdtemp + uid: tempfile.mkdtemp +- fullName: tempfile.mkstemp + href: https://docs.python.org/3/library/tempfile.html#tempfile.mkstemp + name: mkstemp + uid: tempfile.mkstemp +- fullName: tempfile.mktemp + href: https://docs.python.org/3/library/tempfile.html#tempfile.mktemp + name: mktemp + uid: tempfile.mktemp +- fullName: termios.tcdrain + href: https://docs.python.org/3/library/termios.html#termios.tcdrain + name: tcdrain + uid: termios.tcdrain +- fullName: termios.tcflow + href: https://docs.python.org/3/library/termios.html#termios.tcflow + name: tcflow + uid: termios.tcflow +- fullName: termios.tcflush + href: https://docs.python.org/3/library/termios.html#termios.tcflush + name: tcflush + uid: termios.tcflush +- fullName: termios.tcgetattr + href: https://docs.python.org/3/library/termios.html#termios.tcgetattr + name: tcgetattr + uid: termios.tcgetattr +- fullName: termios.tcgetwinsize + href: https://docs.python.org/3/library/termios.html#termios.tcgetwinsize + name: tcgetwinsize + uid: termios.tcgetwinsize +- fullName: termios.tcsendbreak + href: https://docs.python.org/3/library/termios.html#termios.tcsendbreak + name: tcsendbreak + uid: termios.tcsendbreak +- fullName: termios.tcsetattr + href: https://docs.python.org/3/library/termios.html#termios.tcsetattr + name: tcsetattr + uid: termios.tcsetattr +- fullName: termios.tcsetwinsize + href: https://docs.python.org/3/library/termios.html#termios.tcsetwinsize + name: tcsetwinsize + uid: termios.tcsetwinsize +- fullName: test.support.adjust_int_max_str_digits + href: https://docs.python.org/3/library/test.html#test.support.adjust_int_max_str_digits + name: adjust_int_max_str_digits + uid: test.support.adjust_int_max_str_digits +- fullName: test.support.anticipate_failure + href: https://docs.python.org/3/library/test.html#test.support.anticipate_failure + name: anticipate_failure + uid: test.support.anticipate_failure +- fullName: test.support.args_from_interpreter_flags + href: https://docs.python.org/3/library/test.html#test.support.args_from_interpreter_flags + name: args_from_interpreter_flags + uid: test.support.args_from_interpreter_flags +- fullName: test.support.bigaddrspacetest + href: https://docs.python.org/3/library/test.html#test.support.bigaddrspacetest + name: bigaddrspacetest + uid: test.support.bigaddrspacetest +- fullName: test.support.bigmemtest + href: https://docs.python.org/3/library/test.html#test.support.bigmemtest + name: bigmemtest + uid: test.support.bigmemtest +- fullName: test.support.busy_retry + href: https://docs.python.org/3/library/test.html#test.support.busy_retry + name: busy_retry + uid: test.support.busy_retry +- fullName: test.support.calcobjsize + href: https://docs.python.org/3/library/test.html#test.support.calcobjsize + name: calcobjsize + uid: test.support.calcobjsize +- fullName: test.support.calcvobjsize + href: https://docs.python.org/3/library/test.html#test.support.calcvobjsize + name: calcvobjsize + uid: test.support.calcvobjsize +- fullName: test.support.captured_stderr + href: https://docs.python.org/3/library/test.html#test.support.captured_stderr + name: captured_stderr + uid: test.support.captured_stderr +- fullName: test.support.captured_stdin + href: https://docs.python.org/3/library/test.html#test.support.captured_stdin + name: captured_stdin + uid: test.support.captured_stdin +- fullName: test.support.captured_stdout + href: https://docs.python.org/3/library/test.html#test.support.captured_stdout + name: captured_stdout + uid: test.support.captured_stdout +- fullName: test.support.catch_unraisable_exception + href: https://docs.python.org/3/library/test.html#test.support.catch_unraisable_exception + name: catch_unraisable_exception + uid: test.support.catch_unraisable_exception +- fullName: test.support.check__all__ + href: https://docs.python.org/3/library/test.html#test.support.check__all__ + name: check__all__ + uid: test.support.check__all__ +- fullName: test.support.check_disallow_instantiation + href: https://docs.python.org/3/library/test.html#test.support.check_disallow_instantiation + name: check_disallow_instantiation + uid: test.support.check_disallow_instantiation +- fullName: test.support.check_free_after_iterating + href: https://docs.python.org/3/library/test.html#test.support.check_free_after_iterating + name: check_free_after_iterating + uid: test.support.check_free_after_iterating +- fullName: test.support.check_impl_detail + href: https://docs.python.org/3/library/test.html#test.support.check_impl_detail + name: check_impl_detail + uid: test.support.check_impl_detail +- fullName: test.support.check_syntax_error + href: https://docs.python.org/3/library/test.html#test.support.check_syntax_error + name: check_syntax_error + uid: test.support.check_syntax_error +- fullName: test.support.checksizeof + href: https://docs.python.org/3/library/test.html#test.support.checksizeof + name: checksizeof + uid: test.support.checksizeof +- fullName: test.support.cpython_only + href: https://docs.python.org/3/library/test.html#test.support.cpython_only + name: cpython_only + uid: test.support.cpython_only +- fullName: test.support.detect_api_mismatch + href: https://docs.python.org/3/library/test.html#test.support.detect_api_mismatch + name: detect_api_mismatch + uid: test.support.detect_api_mismatch +- fullName: test.support.disable_faulthandler + href: https://docs.python.org/3/library/test.html#test.support.disable_faulthandler + name: disable_faulthandler + uid: test.support.disable_faulthandler +- fullName: test.support.disable_gc + href: https://docs.python.org/3/library/test.html#test.support.disable_gc + name: disable_gc + uid: test.support.disable_gc +- fullName: test.support.findfile + href: https://docs.python.org/3/library/test.html#test.support.findfile + name: findfile + uid: test.support.findfile +- fullName: test.support.flush_std_streams + href: https://docs.python.org/3/library/test.html#test.support.flush_std_streams + name: flush_std_streams + uid: test.support.flush_std_streams +- fullName: test.support.gc_collect + href: https://docs.python.org/3/library/test.html#test.support.gc_collect + name: gc_collect + uid: test.support.gc_collect +- fullName: test.support.get_attribute + href: https://docs.python.org/3/library/test.html#test.support.get_attribute + name: get_attribute + uid: test.support.get_attribute +- fullName: test.support.get_original_stdout + href: https://docs.python.org/3/library/test.html#test.support.get_original_stdout + name: get_original_stdout + uid: test.support.get_original_stdout +- fullName: test.support.get_pagesize + href: https://docs.python.org/3/library/test.html#test.support.get_pagesize + name: get_pagesize + uid: test.support.get_pagesize +- fullName: test.support.impl_detail + href: https://docs.python.org/3/library/test.html#test.support.impl_detail + name: impl_detail + uid: test.support.impl_detail +- fullName: test.support.import_helper.forget + href: https://docs.python.org/3/library/test.html#test.support.import_helper.forget + name: forget + uid: test.support.import_helper.forget +- fullName: test.support.import_helper.import_fresh_module + href: https://docs.python.org/3/library/test.html#test.support.import_helper.import_fresh_module + name: import_fresh_module + uid: test.support.import_helper.import_fresh_module +- fullName: test.support.import_helper.import_module + href: https://docs.python.org/3/library/test.html#test.support.import_helper.import_module + name: import_module + uid: test.support.import_helper.import_module +- fullName: test.support.import_helper.make_legacy_pyc + href: https://docs.python.org/3/library/test.html#test.support.import_helper.make_legacy_pyc + name: make_legacy_pyc + uid: test.support.import_helper.make_legacy_pyc +- fullName: test.support.import_helper.modules_cleanup + href: https://docs.python.org/3/library/test.html#test.support.import_helper.modules_cleanup + name: modules_cleanup + uid: test.support.import_helper.modules_cleanup +- fullName: test.support.import_helper.modules_setup + href: https://docs.python.org/3/library/test.html#test.support.import_helper.modules_setup + name: modules_setup + uid: test.support.import_helper.modules_setup +- fullName: test.support.import_helper.unload + href: https://docs.python.org/3/library/test.html#test.support.import_helper.unload + name: unload + uid: test.support.import_helper.unload +- fullName: test.support.is_resource_enabled + href: https://docs.python.org/3/library/test.html#test.support.is_resource_enabled + name: is_resource_enabled + uid: test.support.is_resource_enabled +- fullName: test.support.load_package_tests + href: https://docs.python.org/3/library/test.html#test.support.load_package_tests + name: load_package_tests + uid: test.support.load_package_tests +- fullName: test.support.missing_compiler_executable + href: https://docs.python.org/3/library/test.html#test.support.missing_compiler_executable + name: missing_compiler_executable + uid: test.support.missing_compiler_executable +- fullName: test.support.no_tracing + href: https://docs.python.org/3/library/test.html#test.support.no_tracing + name: no_tracing + uid: test.support.no_tracing +- fullName: test.support.open_urlresource + href: https://docs.python.org/3/library/test.html#test.support.open_urlresource + name: open_urlresource + uid: test.support.open_urlresource +- fullName: test.support.optim_args_from_interpreter_flags + href: https://docs.python.org/3/library/test.html#test.support.optim_args_from_interpreter_flags + name: optim_args_from_interpreter_flags + uid: test.support.optim_args_from_interpreter_flags +- fullName: test.support.os_helper.can_symlink + href: https://docs.python.org/3/library/test.html#test.support.os_helper.can_symlink + name: can_symlink + uid: test.support.os_helper.can_symlink +- fullName: test.support.os_helper.can_xattr + href: https://docs.python.org/3/library/test.html#test.support.os_helper.can_xattr + name: can_xattr + uid: test.support.os_helper.can_xattr +- fullName: test.support.os_helper.change_cwd + href: https://docs.python.org/3/library/test.html#test.support.os_helper.change_cwd + name: change_cwd + uid: test.support.os_helper.change_cwd +- fullName: test.support.os_helper.create_empty_file + href: https://docs.python.org/3/library/test.html#test.support.os_helper.create_empty_file + name: create_empty_file + uid: test.support.os_helper.create_empty_file +- fullName: test.support.os_helper.fd_count + href: https://docs.python.org/3/library/test.html#test.support.os_helper.fd_count + name: fd_count + uid: test.support.os_helper.fd_count +- fullName: test.support.os_helper.fs_is_case_insensitive + href: https://docs.python.org/3/library/test.html#test.support.os_helper.fs_is_case_insensitive + name: fs_is_case_insensitive + uid: test.support.os_helper.fs_is_case_insensitive +- fullName: test.support.os_helper.make_bad_fd + href: https://docs.python.org/3/library/test.html#test.support.os_helper.make_bad_fd + name: make_bad_fd + uid: test.support.os_helper.make_bad_fd +- fullName: test.support.os_helper.rmdir + href: https://docs.python.org/3/library/test.html#test.support.os_helper.rmdir + name: rmdir + uid: test.support.os_helper.rmdir +- fullName: test.support.os_helper.rmtree + href: https://docs.python.org/3/library/test.html#test.support.os_helper.rmtree + name: rmtree + uid: test.support.os_helper.rmtree +- fullName: test.support.os_helper.skip_unless_symlink + href: https://docs.python.org/3/library/test.html#test.support.os_helper.skip_unless_symlink + name: skip_unless_symlink + uid: test.support.os_helper.skip_unless_symlink +- fullName: test.support.os_helper.skip_unless_xattr + href: https://docs.python.org/3/library/test.html#test.support.os_helper.skip_unless_xattr + name: skip_unless_xattr + uid: test.support.os_helper.skip_unless_xattr +- fullName: test.support.os_helper.temp_cwd + href: https://docs.python.org/3/library/test.html#test.support.os_helper.temp_cwd + name: temp_cwd + uid: test.support.os_helper.temp_cwd +- fullName: test.support.os_helper.temp_dir + href: https://docs.python.org/3/library/test.html#test.support.os_helper.temp_dir + name: temp_dir + uid: test.support.os_helper.temp_dir +- fullName: test.support.os_helper.temp_umask + href: https://docs.python.org/3/library/test.html#test.support.os_helper.temp_umask + name: temp_umask + uid: test.support.os_helper.temp_umask +- fullName: test.support.os_helper.unlink + href: https://docs.python.org/3/library/test.html#test.support.os_helper.unlink + name: unlink + uid: test.support.os_helper.unlink +- fullName: test.support.patch + href: https://docs.python.org/3/library/test.html#test.support.patch + name: patch + uid: test.support.patch +- fullName: test.support.print_warning + href: https://docs.python.org/3/library/test.html#test.support.print_warning + name: print_warning + uid: test.support.print_warning +- fullName: test.support.python_is_optimized + href: https://docs.python.org/3/library/test.html#test.support.python_is_optimized + name: python_is_optimized + uid: test.support.python_is_optimized +- fullName: test.support.reap_children + href: https://docs.python.org/3/library/test.html#test.support.reap_children + name: reap_children + uid: test.support.reap_children +- fullName: test.support.record_original_stdout + href: https://docs.python.org/3/library/test.html#test.support.record_original_stdout + name: record_original_stdout + uid: test.support.record_original_stdout +- fullName: test.support.refcount_test + href: https://docs.python.org/3/library/test.html#test.support.refcount_test + name: refcount_test + uid: test.support.refcount_test +- fullName: test.support.requires + href: https://docs.python.org/3/library/test.html#test.support.requires + name: requires + uid: test.support.requires +- fullName: test.support.requires_IEEE_754 + href: https://docs.python.org/3/library/test.html#test.support.requires_IEEE_754 + name: requires_IEEE_754 + uid: test.support.requires_IEEE_754 +- fullName: test.support.requires_bz2 + href: https://docs.python.org/3/library/test.html#test.support.requires_bz2 + name: requires_bz2 + uid: test.support.requires_bz2 +- fullName: test.support.requires_docstrings + href: https://docs.python.org/3/library/test.html#test.support.requires_docstrings + name: requires_docstrings + uid: test.support.requires_docstrings +- fullName: test.support.requires_freebsd_version + href: https://docs.python.org/3/library/test.html#test.support.requires_freebsd_version + name: requires_freebsd_version + uid: test.support.requires_freebsd_version +- fullName: test.support.requires_gil_enabled + href: https://docs.python.org/3/library/test.html#test.support.requires_gil_enabled + name: requires_gil_enabled + uid: test.support.requires_gil_enabled +- fullName: test.support.requires_gzip + href: https://docs.python.org/3/library/test.html#test.support.requires_gzip + name: requires_gzip + uid: test.support.requires_gzip +- fullName: test.support.requires_limited_api + href: https://docs.python.org/3/library/test.html#test.support.requires_limited_api + name: requires_limited_api + uid: test.support.requires_limited_api +- fullName: test.support.requires_linux_version + href: https://docs.python.org/3/library/test.html#test.support.requires_linux_version + name: requires_linux_version + uid: test.support.requires_linux_version +- fullName: test.support.requires_lzma + href: https://docs.python.org/3/library/test.html#test.support.requires_lzma + name: requires_lzma + uid: test.support.requires_lzma +- fullName: test.support.requires_mac_version + href: https://docs.python.org/3/library/test.html#test.support.requires_mac_version + name: requires_mac_version + uid: test.support.requires_mac_version +- fullName: test.support.requires_resource + href: https://docs.python.org/3/library/test.html#test.support.requires_resource + name: requires_resource + uid: test.support.requires_resource +- fullName: test.support.requires_zlib + href: https://docs.python.org/3/library/test.html#test.support.requires_zlib + name: requires_zlib + uid: test.support.requires_zlib +- fullName: test.support.run_in_subinterp + href: https://docs.python.org/3/library/test.html#test.support.run_in_subinterp + name: run_in_subinterp + uid: test.support.run_in_subinterp +- fullName: test.support.run_with_locale + href: https://docs.python.org/3/library/test.html#test.support.run_with_locale + name: run_with_locale + uid: test.support.run_with_locale +- fullName: test.support.run_with_tz + href: https://docs.python.org/3/library/test.html#test.support.run_with_tz + name: run_with_tz + uid: test.support.run_with_tz +- fullName: test.support.script_helper.assert_python_failure + href: https://docs.python.org/3/library/test.html#test.support.script_helper.assert_python_failure + name: assert_python_failure + uid: test.support.script_helper.assert_python_failure +- fullName: test.support.script_helper.assert_python_ok + href: https://docs.python.org/3/library/test.html#test.support.script_helper.assert_python_ok + name: assert_python_ok + uid: test.support.script_helper.assert_python_ok +- fullName: test.support.script_helper.interpreter_requires_environment + href: https://docs.python.org/3/library/test.html#test.support.script_helper.interpreter_requires_environment + name: interpreter_requires_environment + uid: test.support.script_helper.interpreter_requires_environment +- fullName: test.support.script_helper.kill_python + href: https://docs.python.org/3/library/test.html#test.support.script_helper.kill_python + name: kill_python + uid: test.support.script_helper.kill_python +- fullName: test.support.script_helper.make_pkg + href: https://docs.python.org/3/library/test.html#test.support.script_helper.make_pkg + name: make_pkg + uid: test.support.script_helper.make_pkg +- fullName: test.support.script_helper.make_script + href: https://docs.python.org/3/library/test.html#test.support.script_helper.make_script + name: make_script + uid: test.support.script_helper.make_script +- fullName: test.support.script_helper.make_zip_pkg + href: https://docs.python.org/3/library/test.html#test.support.script_helper.make_zip_pkg + name: make_zip_pkg + uid: test.support.script_helper.make_zip_pkg +- fullName: test.support.script_helper.make_zip_script + href: https://docs.python.org/3/library/test.html#test.support.script_helper.make_zip_script + name: make_zip_script + uid: test.support.script_helper.make_zip_script +- fullName: test.support.script_helper.run_python_until_end + href: https://docs.python.org/3/library/test.html#test.support.script_helper.run_python_until_end + name: run_python_until_end + uid: test.support.script_helper.run_python_until_end +- fullName: test.support.script_helper.spawn_python + href: https://docs.python.org/3/library/test.html#test.support.script_helper.spawn_python + name: spawn_python + uid: test.support.script_helper.spawn_python +- fullName: test.support.set_memlimit + href: https://docs.python.org/3/library/test.html#test.support.set_memlimit + name: set_memlimit + uid: test.support.set_memlimit +- fullName: test.support.setswitchinterval + href: https://docs.python.org/3/library/test.html#test.support.setswitchinterval + name: setswitchinterval + uid: test.support.setswitchinterval +- fullName: test.support.skip_if_broken_multiprocessing_synchronize + href: https://docs.python.org/3/library/test.html#test.support.skip_if_broken_multiprocessing_synchronize + name: skip_if_broken_multiprocessing_synchronize + uid: test.support.skip_if_broken_multiprocessing_synchronize +- fullName: test.support.sleeping_retry + href: https://docs.python.org/3/library/test.html#test.support.sleeping_retry + name: sleeping_retry + uid: test.support.sleeping_retry +- fullName: test.support.socket_helper.bind_port + href: https://docs.python.org/3/library/test.html#test.support.socket_helper.bind_port + name: bind_port + uid: test.support.socket_helper.bind_port +- fullName: test.support.socket_helper.bind_unix_socket + href: https://docs.python.org/3/library/test.html#test.support.socket_helper.bind_unix_socket + name: bind_unix_socket + uid: test.support.socket_helper.bind_unix_socket +- fullName: test.support.socket_helper.find_unused_port + href: https://docs.python.org/3/library/test.html#test.support.socket_helper.find_unused_port + name: find_unused_port + uid: test.support.socket_helper.find_unused_port +- fullName: test.support.socket_helper.skip_unless_bind_unix_socket + href: https://docs.python.org/3/library/test.html#test.support.socket_helper.skip_unless_bind_unix_socket + name: skip_unless_bind_unix_socket + uid: test.support.socket_helper.skip_unless_bind_unix_socket +- fullName: test.support.socket_helper.transient_internet + href: https://docs.python.org/3/library/test.html#test.support.socket_helper.transient_internet + name: transient_internet + uid: test.support.socket_helper.transient_internet +- fullName: test.support.sortdict + href: https://docs.python.org/3/library/test.html#test.support.sortdict + name: sortdict + uid: test.support.sortdict +- fullName: test.support.swap_attr + href: https://docs.python.org/3/library/test.html#test.support.swap_attr + name: swap_attr + uid: test.support.swap_attr +- fullName: test.support.swap_item + href: https://docs.python.org/3/library/test.html#test.support.swap_item + name: swap_item + uid: test.support.swap_item +- fullName: test.support.system_must_validate_cert + href: https://docs.python.org/3/library/test.html#test.support.system_must_validate_cert + name: system_must_validate_cert + uid: test.support.system_must_validate_cert +- fullName: test.support.threading_helper.catch_threading_exception + href: https://docs.python.org/3/library/test.html#test.support.threading_helper.catch_threading_exception + name: catch_threading_exception + uid: test.support.threading_helper.catch_threading_exception +- fullName: test.support.threading_helper.join_thread + href: https://docs.python.org/3/library/test.html#test.support.threading_helper.join_thread + name: join_thread + uid: test.support.threading_helper.join_thread +- fullName: test.support.threading_helper.reap_threads + href: https://docs.python.org/3/library/test.html#test.support.threading_helper.reap_threads + name: reap_threads + uid: test.support.threading_helper.reap_threads +- fullName: test.support.threading_helper.start_threads + href: https://docs.python.org/3/library/test.html#test.support.threading_helper.start_threads + name: start_threads + uid: test.support.threading_helper.start_threads +- fullName: test.support.threading_helper.threading_cleanup + href: https://docs.python.org/3/library/test.html#test.support.threading_helper.threading_cleanup + name: threading_cleanup + uid: test.support.threading_helper.threading_cleanup +- fullName: test.support.threading_helper.threading_setup + href: https://docs.python.org/3/library/test.html#test.support.threading_helper.threading_setup + name: threading_setup + uid: test.support.threading_helper.threading_setup +- fullName: test.support.threading_helper.wait_threads_exit + href: https://docs.python.org/3/library/test.html#test.support.threading_helper.wait_threads_exit + name: wait_threads_exit + uid: test.support.threading_helper.wait_threads_exit +- fullName: test.support.wait_process + href: https://docs.python.org/3/library/test.html#test.support.wait_process + name: wait_process + uid: test.support.wait_process +- fullName: test.support.warnings_helper.check_no_resource_warning + href: https://docs.python.org/3/library/test.html#test.support.warnings_helper.check_no_resource_warning + name: check_no_resource_warning + uid: test.support.warnings_helper.check_no_resource_warning +- fullName: test.support.warnings_helper.check_syntax_warning + href: https://docs.python.org/3/library/test.html#test.support.warnings_helper.check_syntax_warning + name: check_syntax_warning + uid: test.support.warnings_helper.check_syntax_warning +- fullName: test.support.warnings_helper.check_warnings + href: https://docs.python.org/3/library/test.html#test.support.warnings_helper.check_warnings + name: check_warnings + uid: test.support.warnings_helper.check_warnings +- fullName: test.support.warnings_helper.ignore_warnings + href: https://docs.python.org/3/library/test.html#test.support.warnings_helper.ignore_warnings + name: ignore_warnings + uid: test.support.warnings_helper.ignore_warnings +- fullName: test.support.with_pymalloc + href: https://docs.python.org/3/library/test.html#test.support.with_pymalloc + name: with_pymalloc + uid: test.support.with_pymalloc +- fullName: textwrap.dedent + href: https://docs.python.org/3/library/textwrap.html#textwrap.dedent + name: dedent + uid: textwrap.dedent +- fullName: textwrap.fill + href: https://docs.python.org/3/library/textwrap.html#textwrap.fill + name: fill + uid: textwrap.fill +- fullName: textwrap.indent + href: https://docs.python.org/3/library/textwrap.html#textwrap.indent + name: indent + uid: textwrap.indent +- fullName: textwrap.shorten + href: https://docs.python.org/3/library/textwrap.html#textwrap.shorten + name: shorten + uid: textwrap.shorten +- fullName: textwrap.wrap + href: https://docs.python.org/3/library/textwrap.html#textwrap.wrap + name: wrap + uid: textwrap.wrap +- fullName: threading.active_count + href: https://docs.python.org/3/library/threading.html#threading.active_count + name: active_count + uid: threading.active_count +- fullName: threading.current_thread + href: https://docs.python.org/3/library/threading.html#threading.current_thread + name: current_thread + uid: threading.current_thread +- fullName: threading.enumerate + href: https://docs.python.org/3/library/threading.html#threading.enumerate + name: enumerate + uid: threading.enumerate +- fullName: threading.excepthook + href: https://docs.python.org/3/library/threading.html#threading.excepthook + name: excepthook + uid: threading.excepthook +- fullName: threading.get_ident + href: https://docs.python.org/3/library/threading.html#threading.get_ident + name: get_ident + uid: threading.get_ident +- fullName: threading.get_native_id + href: https://docs.python.org/3/library/threading.html#threading.get_native_id + name: get_native_id + uid: threading.get_native_id +- fullName: threading.getprofile + href: https://docs.python.org/3/library/threading.html#threading.getprofile + name: getprofile + uid: threading.getprofile +- fullName: threading.gettrace + href: https://docs.python.org/3/library/threading.html#threading.gettrace + name: gettrace + uid: threading.gettrace +- fullName: threading.main_thread + href: https://docs.python.org/3/library/threading.html#threading.main_thread + name: main_thread + uid: threading.main_thread +- fullName: threading.setprofile + href: https://docs.python.org/3/library/threading.html#threading.setprofile + name: setprofile + uid: threading.setprofile +- fullName: threading.setprofile_all_threads + href: https://docs.python.org/3/library/threading.html#threading.setprofile_all_threads + name: setprofile_all_threads + uid: threading.setprofile_all_threads +- fullName: threading.settrace + href: https://docs.python.org/3/library/threading.html#threading.settrace + name: settrace + uid: threading.settrace +- fullName: threading.settrace_all_threads + href: https://docs.python.org/3/library/threading.html#threading.settrace_all_threads + name: settrace_all_threads + uid: threading.settrace_all_threads +- fullName: threading.stack_size + href: https://docs.python.org/3/library/threading.html#threading.stack_size + name: stack_size + uid: threading.stack_size +- fullName: time.asctime + href: https://docs.python.org/3/library/time.html#time.asctime + name: asctime + uid: time.asctime +- fullName: time.clock_getres + href: https://docs.python.org/3/library/time.html#time.clock_getres + name: clock_getres + uid: time.clock_getres +- fullName: time.clock_gettime + href: https://docs.python.org/3/library/time.html#time.clock_gettime + name: clock_gettime + uid: time.clock_gettime +- fullName: time.clock_gettime_ns + href: https://docs.python.org/3/library/time.html#time.clock_gettime_ns + name: clock_gettime_ns + uid: time.clock_gettime_ns +- fullName: time.clock_settime + href: https://docs.python.org/3/library/time.html#time.clock_settime + name: clock_settime + uid: time.clock_settime +- fullName: time.clock_settime_ns + href: https://docs.python.org/3/library/time.html#time.clock_settime_ns + name: clock_settime_ns + uid: time.clock_settime_ns +- fullName: time.ctime + href: https://docs.python.org/3/library/time.html#time.ctime + name: ctime + uid: time.ctime +- fullName: time.get_clock_info + href: https://docs.python.org/3/library/time.html#time.get_clock_info + name: get_clock_info + uid: time.get_clock_info +- fullName: time.gmtime + href: https://docs.python.org/3/library/time.html#time.gmtime + name: gmtime + uid: time.gmtime +- fullName: time.localtime + href: https://docs.python.org/3/library/time.html#time.localtime + name: localtime + uid: time.localtime +- fullName: time.mktime + href: https://docs.python.org/3/library/time.html#time.mktime + name: mktime + uid: time.mktime +- fullName: time.monotonic + href: https://docs.python.org/3/library/time.html#time.monotonic + name: monotonic + uid: time.monotonic +- fullName: time.monotonic_ns + href: https://docs.python.org/3/library/time.html#time.monotonic_ns + name: monotonic_ns + uid: time.monotonic_ns +- fullName: time.perf_counter + href: https://docs.python.org/3/library/time.html#time.perf_counter + name: perf_counter + uid: time.perf_counter +- fullName: time.perf_counter_ns + href: https://docs.python.org/3/library/time.html#time.perf_counter_ns + name: perf_counter_ns + uid: time.perf_counter_ns +- fullName: time.process_time + href: https://docs.python.org/3/library/time.html#time.process_time + name: process_time + uid: time.process_time +- fullName: time.process_time_ns + href: https://docs.python.org/3/library/time.html#time.process_time_ns + name: process_time_ns + uid: time.process_time_ns +- fullName: time.pthread_getcpuclockid + href: https://docs.python.org/3/library/time.html#time.pthread_getcpuclockid + name: pthread_getcpuclockid + uid: time.pthread_getcpuclockid +- fullName: time.sleep + href: https://docs.python.org/3/library/time.html#time.sleep + name: sleep + uid: time.sleep +- fullName: time.strftime + href: https://docs.python.org/3/library/time.html#time.strftime + name: strftime + uid: time.strftime +- fullName: time.strptime + href: https://docs.python.org/3/library/time.html#time.strptime + name: strptime + uid: time.strptime +- fullName: time.thread_time + href: https://docs.python.org/3/library/time.html#time.thread_time + name: thread_time + uid: time.thread_time +- fullName: time.thread_time_ns + href: https://docs.python.org/3/library/time.html#time.thread_time_ns + name: thread_time_ns + uid: time.thread_time_ns +- fullName: time.time + href: https://docs.python.org/3/library/time.html#time.time + name: time + uid: time.time +- fullName: time.time_ns + href: https://docs.python.org/3/library/time.html#time.time_ns + name: time_ns + uid: time.time_ns +- fullName: time.tzset + href: https://docs.python.org/3/library/time.html#time.tzset + name: tzset + uid: time.tzset +- fullName: timeit.default_timer + href: https://docs.python.org/3/library/timeit.html#timeit.default_timer + name: default_timer + uid: timeit.default_timer +- fullName: timeit.repeat + href: https://docs.python.org/3/library/timeit.html#timeit.repeat + name: repeat + uid: timeit.repeat +- fullName: timeit.timeit + href: https://docs.python.org/3/library/timeit.html#timeit.timeit + name: timeit + uid: timeit.timeit +- fullName: tkinter.Tcl + href: https://docs.python.org/3/library/tkinter.html#tkinter.Tcl + name: Tcl + uid: tkinter.Tcl +- fullName: tkinter.colorchooser.askcolor + href: https://docs.python.org/3/library/tkinter.colorchooser.html#tkinter.colorchooser.askcolor + name: askcolor + uid: tkinter.colorchooser.askcolor +- fullName: tkinter.dnd.dnd_start + href: https://docs.python.org/3/library/tkinter.dnd.html#tkinter.dnd.dnd_start + name: dnd_start + uid: tkinter.dnd.dnd_start +- fullName: tkinter.filedialog.askdirectory + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.askdirectory + name: askdirectory + uid: tkinter.filedialog.askdirectory +- fullName: tkinter.filedialog.askopenfile + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.askopenfile + name: askopenfile + uid: tkinter.filedialog.askopenfile +- fullName: tkinter.filedialog.askopenfilename + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.askopenfilename + name: askopenfilename + uid: tkinter.filedialog.askopenfilename +- fullName: tkinter.filedialog.askopenfilenames + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.askopenfilenames + name: askopenfilenames + uid: tkinter.filedialog.askopenfilenames +- fullName: tkinter.filedialog.askopenfiles + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.askopenfiles + name: askopenfiles + uid: tkinter.filedialog.askopenfiles +- fullName: tkinter.filedialog.asksaveasfile + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.asksaveasfile + name: asksaveasfile + uid: tkinter.filedialog.asksaveasfile +- fullName: tkinter.filedialog.asksaveasfilename + href: https://docs.python.org/3/library/dialog.html#tkinter.filedialog.asksaveasfilename + name: asksaveasfilename + uid: tkinter.filedialog.asksaveasfilename +- fullName: tkinter.font.families + href: https://docs.python.org/3/library/tkinter.font.html#tkinter.font.families + name: families + uid: tkinter.font.families +- fullName: tkinter.font.names + href: https://docs.python.org/3/library/tkinter.font.html#tkinter.font.names + name: names + uid: tkinter.font.names +- fullName: tkinter.font.nametofont + href: https://docs.python.org/3/library/tkinter.font.html#tkinter.font.nametofont + name: nametofont + uid: tkinter.font.nametofont +- fullName: tkinter.messagebox.askokcancel + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.askokcancel + name: askokcancel + uid: tkinter.messagebox.askokcancel +- fullName: tkinter.messagebox.askquestion + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.askquestion + name: askquestion + uid: tkinter.messagebox.askquestion +- fullName: tkinter.messagebox.askretrycancel + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.askretrycancel + name: askretrycancel + uid: tkinter.messagebox.askretrycancel +- fullName: tkinter.messagebox.askyesno + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.askyesno + name: askyesno + uid: tkinter.messagebox.askyesno +- fullName: tkinter.messagebox.askyesnocancel + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.askyesnocancel + name: askyesnocancel + uid: tkinter.messagebox.askyesnocancel +- fullName: tkinter.messagebox.showerror + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.showerror + name: showerror + uid: tkinter.messagebox.showerror +- fullName: tkinter.messagebox.showinfo + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.showinfo + name: showinfo + uid: tkinter.messagebox.showinfo +- fullName: tkinter.messagebox.showwarning + href: https://docs.python.org/3/library/tkinter.messagebox.html#tkinter.messagebox.showwarning + name: showwarning + uid: tkinter.messagebox.showwarning +- fullName: tkinter.simpledialog.askfloat + href: https://docs.python.org/3/library/dialog.html#tkinter.simpledialog.askfloat + name: askfloat + uid: tkinter.simpledialog.askfloat +- fullName: tkinter.simpledialog.askinteger + href: https://docs.python.org/3/library/dialog.html#tkinter.simpledialog.askinteger + name: askinteger + uid: tkinter.simpledialog.askinteger +- fullName: tkinter.simpledialog.askstring + href: https://docs.python.org/3/library/dialog.html#tkinter.simpledialog.askstring + name: askstring + uid: tkinter.simpledialog.askstring +- fullName: token.ISEOF + href: https://docs.python.org/3/library/token.html#token.ISEOF + name: ISEOF + uid: token.ISEOF +- fullName: token.ISNONTERMINAL + href: https://docs.python.org/3/library/token.html#token.ISNONTERMINAL + name: ISNONTERMINAL + uid: token.ISNONTERMINAL +- fullName: token.ISTERMINAL + href: https://docs.python.org/3/library/token.html#token.ISTERMINAL + name: ISTERMINAL + uid: token.ISTERMINAL +- fullName: tokenize.detect_encoding + href: https://docs.python.org/3/library/tokenize.html#tokenize.detect_encoding + name: detect_encoding + uid: tokenize.detect_encoding +- fullName: tokenize.generate_tokens + href: https://docs.python.org/3/library/tokenize.html#tokenize.generate_tokens + name: generate_tokens + uid: tokenize.generate_tokens +- fullName: tokenize.open + href: https://docs.python.org/3/library/tokenize.html#tokenize.open + name: open + uid: tokenize.open +- fullName: tokenize.tokenize + href: https://docs.python.org/3/library/tokenize.html#tokenize.tokenize + name: tokenize + uid: tokenize.tokenize +- fullName: tokenize.untokenize + href: https://docs.python.org/3/library/tokenize.html#tokenize.untokenize + name: untokenize + uid: tokenize.untokenize +- fullName: tomllib.load + href: https://docs.python.org/3/library/tomllib.html#tomllib.load + name: load + uid: tomllib.load +- fullName: tomllib.loads + href: https://docs.python.org/3/library/tomllib.html#tomllib.loads + name: loads + uid: tomllib.loads +- fullName: traceback.clear_frames + href: https://docs.python.org/3/library/traceback.html#traceback.clear_frames + name: clear_frames + uid: traceback.clear_frames +- fullName: traceback.extract_stack + href: https://docs.python.org/3/library/traceback.html#traceback.extract_stack + name: extract_stack + uid: traceback.extract_stack +- fullName: traceback.extract_tb + href: https://docs.python.org/3/library/traceback.html#traceback.extract_tb + name: extract_tb + uid: traceback.extract_tb +- fullName: traceback.format_exc + href: https://docs.python.org/3/library/traceback.html#traceback.format_exc + name: format_exc + uid: traceback.format_exc +- fullName: traceback.format_exception + href: https://docs.python.org/3/library/traceback.html#traceback.format_exception + name: format_exception + uid: traceback.format_exception +- fullName: traceback.format_exception_only + href: https://docs.python.org/3/library/traceback.html#traceback.format_exception_only + name: format_exception_only + uid: traceback.format_exception_only +- fullName: traceback.format_list + href: https://docs.python.org/3/library/traceback.html#traceback.format_list + name: format_list + uid: traceback.format_list +- fullName: traceback.format_stack + href: https://docs.python.org/3/library/traceback.html#traceback.format_stack + name: format_stack + uid: traceback.format_stack +- fullName: traceback.format_tb + href: https://docs.python.org/3/library/traceback.html#traceback.format_tb + name: format_tb + uid: traceback.format_tb +- fullName: traceback.print_exc + href: https://docs.python.org/3/library/traceback.html#traceback.print_exc + name: print_exc + uid: traceback.print_exc +- fullName: traceback.print_exception + href: https://docs.python.org/3/library/traceback.html#traceback.print_exception + name: print_exception + uid: traceback.print_exception +- fullName: traceback.print_last + href: https://docs.python.org/3/library/traceback.html#traceback.print_last + name: print_last + uid: traceback.print_last +- fullName: traceback.print_list + href: https://docs.python.org/3/library/traceback.html#traceback.print_list + name: print_list + uid: traceback.print_list +- fullName: traceback.print_stack + href: https://docs.python.org/3/library/traceback.html#traceback.print_stack + name: print_stack + uid: traceback.print_stack +- fullName: traceback.print_tb + href: https://docs.python.org/3/library/traceback.html#traceback.print_tb + name: print_tb + uid: traceback.print_tb +- fullName: traceback.walk_stack + href: https://docs.python.org/3/library/traceback.html#traceback.walk_stack + name: walk_stack + uid: traceback.walk_stack +- fullName: traceback.walk_tb + href: https://docs.python.org/3/library/traceback.html#traceback.walk_tb + name: walk_tb + uid: traceback.walk_tb +- fullName: tracemalloc.clear_traces + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.clear_traces + name: clear_traces + uid: tracemalloc.clear_traces +- fullName: tracemalloc.get_object_traceback + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.get_object_traceback + name: get_object_traceback + uid: tracemalloc.get_object_traceback +- fullName: tracemalloc.get_traceback_limit + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.get_traceback_limit + name: get_traceback_limit + uid: tracemalloc.get_traceback_limit +- fullName: tracemalloc.get_traced_memory + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.get_traced_memory + name: get_traced_memory + uid: tracemalloc.get_traced_memory +- fullName: tracemalloc.get_tracemalloc_memory + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.get_tracemalloc_memory + name: get_tracemalloc_memory + uid: tracemalloc.get_tracemalloc_memory +- fullName: tracemalloc.is_tracing + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.is_tracing + name: is_tracing + uid: tracemalloc.is_tracing +- fullName: tracemalloc.reset_peak + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.reset_peak + name: reset_peak + uid: tracemalloc.reset_peak +- fullName: tracemalloc.start + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.start + name: start + uid: tracemalloc.start +- fullName: tracemalloc.stop + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.stop + name: stop + uid: tracemalloc.stop +- fullName: tracemalloc.take_snapshot + href: https://docs.python.org/3/library/tracemalloc.html#tracemalloc.take_snapshot + name: take_snapshot + uid: tracemalloc.take_snapshot +- fullName: tty.cfmakecbreak + href: https://docs.python.org/3/library/tty.html#tty.cfmakecbreak + name: cfmakecbreak + uid: tty.cfmakecbreak +- fullName: tty.cfmakeraw + href: https://docs.python.org/3/library/tty.html#tty.cfmakeraw + name: cfmakeraw + uid: tty.cfmakeraw +- fullName: tty.setcbreak + href: https://docs.python.org/3/library/tty.html#tty.setcbreak + name: setcbreak + uid: tty.setcbreak +- fullName: tty.setraw + href: https://docs.python.org/3/library/tty.html#tty.setraw + name: setraw + uid: tty.setraw +- fullName: turtle.addshape + href: https://docs.python.org/3/library/turtle.html#turtle.addshape + name: addshape + uid: turtle.addshape +- fullName: turtle.back + href: https://docs.python.org/3/library/turtle.html#turtle.back + name: back + uid: turtle.back +- fullName: turtle.backward + href: https://docs.python.org/3/library/turtle.html#turtle.backward + name: backward + uid: turtle.backward +- fullName: turtle.begin_fill + href: https://docs.python.org/3/library/turtle.html#turtle.begin_fill + name: begin_fill + uid: turtle.begin_fill +- fullName: turtle.begin_poly + href: https://docs.python.org/3/library/turtle.html#turtle.begin_poly + name: begin_poly + uid: turtle.begin_poly +- fullName: turtle.bgcolor + href: https://docs.python.org/3/library/turtle.html#turtle.bgcolor + name: bgcolor + uid: turtle.bgcolor +- fullName: turtle.bgpic + href: https://docs.python.org/3/library/turtle.html#turtle.bgpic + name: bgpic + uid: turtle.bgpic +- fullName: turtle.bk + href: https://docs.python.org/3/library/turtle.html#turtle.bk + name: bk + uid: turtle.bk +- fullName: turtle.bye + href: https://docs.python.org/3/library/turtle.html#turtle.bye + name: bye + uid: turtle.bye +- fullName: turtle.circle + href: https://docs.python.org/3/library/turtle.html#turtle.circle + name: circle + uid: turtle.circle +- fullName: turtle.clear + href: https://docs.python.org/3/library/turtle.html#turtle.clear + name: clear + uid: turtle.clear +- fullName: turtle.clearscreen + href: https://docs.python.org/3/library/turtle.html#turtle.clearscreen + name: clearscreen + uid: turtle.clearscreen +- fullName: turtle.clearstamp + href: https://docs.python.org/3/library/turtle.html#turtle.clearstamp + name: clearstamp + uid: turtle.clearstamp +- fullName: turtle.clearstamps + href: https://docs.python.org/3/library/turtle.html#turtle.clearstamps + name: clearstamps + uid: turtle.clearstamps +- fullName: turtle.clone + href: https://docs.python.org/3/library/turtle.html#turtle.clone + name: clone + uid: turtle.clone +- fullName: turtle.color + href: https://docs.python.org/3/library/turtle.html#turtle.color + name: color + uid: turtle.color +- fullName: turtle.colormode + href: https://docs.python.org/3/library/turtle.html#turtle.colormode + name: colormode + uid: turtle.colormode +- fullName: turtle.degrees + href: https://docs.python.org/3/library/turtle.html#turtle.degrees + name: degrees + uid: turtle.degrees +- fullName: turtle.delay + href: https://docs.python.org/3/library/turtle.html#turtle.delay + name: delay + uid: turtle.delay +- fullName: turtle.distance + href: https://docs.python.org/3/library/turtle.html#turtle.distance + name: distance + uid: turtle.distance +- fullName: turtle.done + href: https://docs.python.org/3/library/turtle.html#turtle.done + name: done + uid: turtle.done +- fullName: turtle.dot + href: https://docs.python.org/3/library/turtle.html#turtle.dot + name: dot + uid: turtle.dot +- fullName: turtle.down + href: https://docs.python.org/3/library/turtle.html#turtle.down + name: down + uid: turtle.down +- fullName: turtle.end_fill + href: https://docs.python.org/3/library/turtle.html#turtle.end_fill + name: end_fill + uid: turtle.end_fill +- fullName: turtle.end_poly + href: https://docs.python.org/3/library/turtle.html#turtle.end_poly + name: end_poly + uid: turtle.end_poly +- fullName: turtle.exitonclick + href: https://docs.python.org/3/library/turtle.html#turtle.exitonclick + name: exitonclick + uid: turtle.exitonclick +- fullName: turtle.fd + href: https://docs.python.org/3/library/turtle.html#turtle.fd + name: fd + uid: turtle.fd +- fullName: turtle.fillcolor + href: https://docs.python.org/3/library/turtle.html#turtle.fillcolor + name: fillcolor + uid: turtle.fillcolor +- fullName: turtle.filling + href: https://docs.python.org/3/library/turtle.html#turtle.filling + name: filling + uid: turtle.filling +- fullName: turtle.forward + href: https://docs.python.org/3/library/turtle.html#turtle.forward + name: forward + uid: turtle.forward +- fullName: turtle.get_poly + href: https://docs.python.org/3/library/turtle.html#turtle.get_poly + name: get_poly + uid: turtle.get_poly +- fullName: turtle.get_shapepoly + href: https://docs.python.org/3/library/turtle.html#turtle.get_shapepoly + name: get_shapepoly + uid: turtle.get_shapepoly +- fullName: turtle.getcanvas + href: https://docs.python.org/3/library/turtle.html#turtle.getcanvas + name: getcanvas + uid: turtle.getcanvas +- fullName: turtle.getpen + href: https://docs.python.org/3/library/turtle.html#turtle.getpen + name: getpen + uid: turtle.getpen +- fullName: turtle.getscreen + href: https://docs.python.org/3/library/turtle.html#turtle.getscreen + name: getscreen + uid: turtle.getscreen +- fullName: turtle.getshapes + href: https://docs.python.org/3/library/turtle.html#turtle.getshapes + name: getshapes + uid: turtle.getshapes +- fullName: turtle.getturtle + href: https://docs.python.org/3/library/turtle.html#turtle.getturtle + name: getturtle + uid: turtle.getturtle +- fullName: turtle.goto + href: https://docs.python.org/3/library/turtle.html#turtle.goto + name: goto + uid: turtle.goto +- fullName: turtle.heading + href: https://docs.python.org/3/library/turtle.html#turtle.heading + name: heading + uid: turtle.heading +- fullName: turtle.hideturtle + href: https://docs.python.org/3/library/turtle.html#turtle.hideturtle + name: hideturtle + uid: turtle.hideturtle +- fullName: turtle.home + href: https://docs.python.org/3/library/turtle.html#turtle.home + name: home + uid: turtle.home +- fullName: turtle.ht + href: https://docs.python.org/3/library/turtle.html#turtle.ht + name: ht + uid: turtle.ht +- fullName: turtle.isdown + href: https://docs.python.org/3/library/turtle.html#turtle.isdown + name: isdown + uid: turtle.isdown +- fullName: turtle.isvisible + href: https://docs.python.org/3/library/turtle.html#turtle.isvisible + name: isvisible + uid: turtle.isvisible +- fullName: turtle.left + href: https://docs.python.org/3/library/turtle.html#turtle.left + name: left + uid: turtle.left +- fullName: turtle.listen + href: https://docs.python.org/3/library/turtle.html#turtle.listen + name: listen + uid: turtle.listen +- fullName: turtle.lt + href: https://docs.python.org/3/library/turtle.html#turtle.lt + name: lt + uid: turtle.lt +- fullName: turtle.mainloop + href: https://docs.python.org/3/library/turtle.html#turtle.mainloop + name: mainloop + uid: turtle.mainloop +- fullName: turtle.mode + href: https://docs.python.org/3/library/turtle.html#turtle.mode + name: mode + uid: turtle.mode +- fullName: turtle.numinput + href: https://docs.python.org/3/library/turtle.html#turtle.numinput + name: numinput + uid: turtle.numinput +- fullName: turtle.onclick + href: https://docs.python.org/3/library/turtle.html#turtle.onclick + name: onclick + uid: turtle.onclick +- fullName: turtle.ondrag + href: https://docs.python.org/3/library/turtle.html#turtle.ondrag + name: ondrag + uid: turtle.ondrag +- fullName: turtle.onkey + href: https://docs.python.org/3/library/turtle.html#turtle.onkey + name: onkey + uid: turtle.onkey +- fullName: turtle.onkeypress + href: https://docs.python.org/3/library/turtle.html#turtle.onkeypress + name: onkeypress + uid: turtle.onkeypress +- fullName: turtle.onkeyrelease + href: https://docs.python.org/3/library/turtle.html#turtle.onkeyrelease + name: onkeyrelease + uid: turtle.onkeyrelease +- fullName: turtle.onrelease + href: https://docs.python.org/3/library/turtle.html#turtle.onrelease + name: onrelease + uid: turtle.onrelease +- fullName: turtle.onscreenclick + href: https://docs.python.org/3/library/turtle.html#turtle.onscreenclick + name: onscreenclick + uid: turtle.onscreenclick +- fullName: turtle.ontimer + href: https://docs.python.org/3/library/turtle.html#turtle.ontimer + name: ontimer + uid: turtle.ontimer +- fullName: turtle.pd + href: https://docs.python.org/3/library/turtle.html#turtle.pd + name: pd + uid: turtle.pd +- fullName: turtle.pen + href: https://docs.python.org/3/library/turtle.html#turtle.pen + name: pen + uid: turtle.pen +- fullName: turtle.pencolor + href: https://docs.python.org/3/library/turtle.html#turtle.pencolor + name: pencolor + uid: turtle.pencolor +- fullName: turtle.pendown + href: https://docs.python.org/3/library/turtle.html#turtle.pendown + name: pendown + uid: turtle.pendown +- fullName: turtle.pensize + href: https://docs.python.org/3/library/turtle.html#turtle.pensize + name: pensize + uid: turtle.pensize +- fullName: turtle.penup + href: https://docs.python.org/3/library/turtle.html#turtle.penup + name: penup + uid: turtle.penup +- fullName: turtle.pos + href: https://docs.python.org/3/library/turtle.html#turtle.pos + name: pos + uid: turtle.pos +- fullName: turtle.position + href: https://docs.python.org/3/library/turtle.html#turtle.position + name: position + uid: turtle.position +- fullName: turtle.pu + href: https://docs.python.org/3/library/turtle.html#turtle.pu + name: pu + uid: turtle.pu +- fullName: turtle.radians + href: https://docs.python.org/3/library/turtle.html#turtle.radians + name: radians + uid: turtle.radians +- fullName: turtle.register_shape + href: https://docs.python.org/3/library/turtle.html#turtle.register_shape + name: register_shape + uid: turtle.register_shape +- fullName: turtle.reset + href: https://docs.python.org/3/library/turtle.html#turtle.reset + name: reset + uid: turtle.reset +- fullName: turtle.resetscreen + href: https://docs.python.org/3/library/turtle.html#turtle.resetscreen + name: resetscreen + uid: turtle.resetscreen +- fullName: turtle.resizemode + href: https://docs.python.org/3/library/turtle.html#turtle.resizemode + name: resizemode + uid: turtle.resizemode +- fullName: turtle.right + href: https://docs.python.org/3/library/turtle.html#turtle.right + name: right + uid: turtle.right +- fullName: turtle.rt + href: https://docs.python.org/3/library/turtle.html#turtle.rt + name: rt + uid: turtle.rt +- fullName: turtle.screensize + href: https://docs.python.org/3/library/turtle.html#turtle.screensize + name: screensize + uid: turtle.screensize +- fullName: turtle.seth + href: https://docs.python.org/3/library/turtle.html#turtle.seth + name: seth + uid: turtle.seth +- fullName: turtle.setheading + href: https://docs.python.org/3/library/turtle.html#turtle.setheading + name: setheading + uid: turtle.setheading +- fullName: turtle.setpos + href: https://docs.python.org/3/library/turtle.html#turtle.setpos + name: setpos + uid: turtle.setpos +- fullName: turtle.setposition + href: https://docs.python.org/3/library/turtle.html#turtle.setposition + name: setposition + uid: turtle.setposition +- fullName: turtle.setundobuffer + href: https://docs.python.org/3/library/turtle.html#turtle.setundobuffer + name: setundobuffer + uid: turtle.setundobuffer +- fullName: turtle.setup + href: https://docs.python.org/3/library/turtle.html#turtle.setup + name: setup + uid: turtle.setup +- fullName: turtle.setworldcoordinates + href: https://docs.python.org/3/library/turtle.html#turtle.setworldcoordinates + name: setworldcoordinates + uid: turtle.setworldcoordinates +- fullName: turtle.setx + href: https://docs.python.org/3/library/turtle.html#turtle.setx + name: setx + uid: turtle.setx +- fullName: turtle.sety + href: https://docs.python.org/3/library/turtle.html#turtle.sety + name: sety + uid: turtle.sety +- fullName: turtle.shape + href: https://docs.python.org/3/library/turtle.html#turtle.shape + name: shape + uid: turtle.shape +- fullName: turtle.shapesize + href: https://docs.python.org/3/library/turtle.html#turtle.shapesize + name: shapesize + uid: turtle.shapesize +- fullName: turtle.shapetransform + href: https://docs.python.org/3/library/turtle.html#turtle.shapetransform + name: shapetransform + uid: turtle.shapetransform +- fullName: turtle.shearfactor + href: https://docs.python.org/3/library/turtle.html#turtle.shearfactor + name: shearfactor + uid: turtle.shearfactor +- fullName: turtle.showturtle + href: https://docs.python.org/3/library/turtle.html#turtle.showturtle + name: showturtle + uid: turtle.showturtle +- fullName: turtle.speed + href: https://docs.python.org/3/library/turtle.html#turtle.speed + name: speed + uid: turtle.speed +- fullName: turtle.st + href: https://docs.python.org/3/library/turtle.html#turtle.st + name: st + uid: turtle.st +- fullName: turtle.stamp + href: https://docs.python.org/3/library/turtle.html#turtle.stamp + name: stamp + uid: turtle.stamp +- fullName: turtle.teleport + href: https://docs.python.org/3/library/turtle.html#turtle.teleport + name: teleport + uid: turtle.teleport +- fullName: turtle.textinput + href: https://docs.python.org/3/library/turtle.html#turtle.textinput + name: textinput + uid: turtle.textinput +- fullName: turtle.tilt + href: https://docs.python.org/3/library/turtle.html#turtle.tilt + name: tilt + uid: turtle.tilt +- fullName: turtle.tiltangle + href: https://docs.python.org/3/library/turtle.html#turtle.tiltangle + name: tiltangle + uid: turtle.tiltangle +- fullName: turtle.title + href: https://docs.python.org/3/library/turtle.html#turtle.title + name: title + uid: turtle.title +- fullName: turtle.towards + href: https://docs.python.org/3/library/turtle.html#turtle.towards + name: towards + uid: turtle.towards +- fullName: turtle.tracer + href: https://docs.python.org/3/library/turtle.html#turtle.tracer + name: tracer + uid: turtle.tracer +- fullName: turtle.turtles + href: https://docs.python.org/3/library/turtle.html#turtle.turtles + name: turtles + uid: turtle.turtles +- fullName: turtle.turtlesize + href: https://docs.python.org/3/library/turtle.html#turtle.turtlesize + name: turtlesize + uid: turtle.turtlesize +- fullName: turtle.undo + href: https://docs.python.org/3/library/turtle.html#turtle.undo + name: undo + uid: turtle.undo +- fullName: turtle.undobufferentries + href: https://docs.python.org/3/library/turtle.html#turtle.undobufferentries + name: undobufferentries + uid: turtle.undobufferentries +- fullName: turtle.up + href: https://docs.python.org/3/library/turtle.html#turtle.up + name: up + uid: turtle.up +- fullName: turtle.update + href: https://docs.python.org/3/library/turtle.html#turtle.update + name: update + uid: turtle.update +- fullName: turtle.width + href: https://docs.python.org/3/library/turtle.html#turtle.width + name: width + uid: turtle.width +- fullName: turtle.window_height + href: https://docs.python.org/3/library/turtle.html#turtle.window_height + name: window_height + uid: turtle.window_height +- fullName: turtle.window_width + href: https://docs.python.org/3/library/turtle.html#turtle.window_width + name: window_width + uid: turtle.window_width +- fullName: turtle.write + href: https://docs.python.org/3/library/turtle.html#turtle.write + name: write + uid: turtle.write +- fullName: turtle.write_docstringdict + href: https://docs.python.org/3/library/turtle.html#turtle.write_docstringdict + name: write_docstringdict + uid: turtle.write_docstringdict +- fullName: turtle.xcor + href: https://docs.python.org/3/library/turtle.html#turtle.xcor + name: xcor + uid: turtle.xcor +- fullName: turtle.ycor + href: https://docs.python.org/3/library/turtle.html#turtle.ycor + name: ycor + uid: turtle.ycor +- fullName: types.DynamicClassAttribute + href: https://docs.python.org/3/library/types.html#types.DynamicClassAttribute + name: DynamicClassAttribute + uid: types.DynamicClassAttribute +- fullName: types.coroutine + href: https://docs.python.org/3/library/types.html#types.coroutine + name: coroutine + uid: types.coroutine +- fullName: types.get_original_bases + href: https://docs.python.org/3/library/types.html#types.get_original_bases + name: get_original_bases + uid: types.get_original_bases +- fullName: types.new_class + href: https://docs.python.org/3/library/types.html#types.new_class + name: new_class + uid: types.new_class +- fullName: types.prepare_class + href: https://docs.python.org/3/library/types.html#types.prepare_class + name: prepare_class + uid: types.prepare_class +- fullName: types.resolve_bases + href: https://docs.python.org/3/library/types.html#types.resolve_bases + name: resolve_bases + uid: types.resolve_bases +- fullName: typing.assert_never + href: https://docs.python.org/3/library/typing.html#typing.assert_never + name: assert_never + uid: typing.assert_never +- fullName: typing.assert_type + href: https://docs.python.org/3/library/typing.html#typing.assert_type + name: assert_type + uid: typing.assert_type +- fullName: typing.cast + href: https://docs.python.org/3/library/typing.html#typing.cast + name: cast + uid: typing.cast +- fullName: typing.clear_overloads + href: https://docs.python.org/3/library/typing.html#typing.clear_overloads + name: clear_overloads + uid: typing.clear_overloads +- fullName: typing.dataclass_transform + href: https://docs.python.org/3/library/typing.html#typing.dataclass_transform + name: dataclass_transform + uid: typing.dataclass_transform +- fullName: typing.final + href: https://docs.python.org/3/library/typing.html#typing.final + name: final + uid: typing.final +- fullName: typing.get_args + href: https://docs.python.org/3/library/typing.html#typing.get_args + name: get_args + uid: typing.get_args +- fullName: typing.get_origin + href: https://docs.python.org/3/library/typing.html#typing.get_origin + name: get_origin + uid: typing.get_origin +- fullName: typing.get_overloads + href: https://docs.python.org/3/library/typing.html#typing.get_overloads + name: get_overloads + uid: typing.get_overloads +- fullName: typing.get_protocol_members + href: https://docs.python.org/3/library/typing.html#typing.get_protocol_members + name: get_protocol_members + uid: typing.get_protocol_members +- fullName: typing.get_type_hints + href: https://docs.python.org/3/library/typing.html#typing.get_type_hints + name: get_type_hints + uid: typing.get_type_hints +- fullName: typing.is_protocol + href: https://docs.python.org/3/library/typing.html#typing.is_protocol + name: is_protocol + uid: typing.is_protocol +- fullName: typing.is_typeddict + href: https://docs.python.org/3/library/typing.html#typing.is_typeddict + name: is_typeddict + uid: typing.is_typeddict +- fullName: typing.no_type_check + href: https://docs.python.org/3/library/typing.html#typing.no_type_check + name: no_type_check + uid: typing.no_type_check +- fullName: typing.no_type_check_decorator + href: https://docs.python.org/3/library/typing.html#typing.no_type_check_decorator + name: no_type_check_decorator + uid: typing.no_type_check_decorator +- fullName: typing.overload + href: https://docs.python.org/3/library/typing.html#typing.overload + name: overload + uid: typing.overload +- fullName: typing.override + href: https://docs.python.org/3/library/typing.html#typing.override + name: override + uid: typing.override +- fullName: typing.reveal_type + href: https://docs.python.org/3/library/typing.html#typing.reveal_type + name: reveal_type + uid: typing.reveal_type +- fullName: typing.runtime_checkable + href: https://docs.python.org/3/library/typing.html#typing.runtime_checkable + name: runtime_checkable + uid: typing.runtime_checkable +- fullName: typing.type_check_only + href: https://docs.python.org/3/library/typing.html#typing.type_check_only + name: type_check_only + uid: typing.type_check_only +- fullName: unicodedata.bidirectional + href: https://docs.python.org/3/library/unicodedata.html#unicodedata.bidirectional + name: bidirectional + uid: unicodedata.bidirectional +- fullName: unicodedata.category + href: https://docs.python.org/3/library/unicodedata.html#unicodedata.category + name: category + uid: unicodedata.category +- fullName: unicodedata.combining + href: https://docs.python.org/3/library/unicodedata.html#unicodedata.combining + name: combining + uid: unicodedata.combining +- fullName: unicodedata.decimal + href: https://docs.python.org/3/library/unicodedata.html#unicodedata.decimal + name: decimal + uid: unicodedata.decimal +- fullName: unicodedata.decomposition + href: https://docs.python.org/3/library/unicodedata.html#unicodedata.decomposition + name: decomposition + uid: unicodedata.decomposition +- fullName: unicodedata.digit + href: https://docs.python.org/3/library/unicodedata.html#unicodedata.digit + name: digit + uid: unicodedata.digit +- fullName: unicodedata.east_asian_width + href: https://docs.python.org/3/library/unicodedata.html#unicodedata.east_asian_width + name: east_asian_width + uid: unicodedata.east_asian_width +- fullName: unicodedata.is_normalized + href: https://docs.python.org/3/library/unicodedata.html#unicodedata.is_normalized + name: is_normalized + uid: unicodedata.is_normalized +- fullName: unicodedata.lookup + href: https://docs.python.org/3/library/unicodedata.html#unicodedata.lookup + name: lookup + uid: unicodedata.lookup +- fullName: unicodedata.mirrored + href: https://docs.python.org/3/library/unicodedata.html#unicodedata.mirrored + name: mirrored + uid: unicodedata.mirrored +- fullName: unicodedata.name + href: https://docs.python.org/3/library/unicodedata.html#unicodedata.name + name: name + uid: unicodedata.name +- fullName: unicodedata.normalize + href: https://docs.python.org/3/library/unicodedata.html#unicodedata.normalize + name: normalize + uid: unicodedata.normalize +- fullName: unicodedata.numeric + href: https://docs.python.org/3/library/unicodedata.html#unicodedata.numeric + name: numeric + uid: unicodedata.numeric +- fullName: unittest.addModuleCleanup + href: https://docs.python.org/3/library/unittest.html#unittest.addModuleCleanup + name: addModuleCleanup + uid: unittest.addModuleCleanup +- fullName: unittest.doModuleCleanups + href: https://docs.python.org/3/library/unittest.html#unittest.doModuleCleanups + name: doModuleCleanups + uid: unittest.doModuleCleanups +- fullName: unittest.expectedFailure + href: https://docs.python.org/3/library/unittest.html#unittest.expectedFailure + name: expectedFailure + uid: unittest.expectedFailure +- fullName: unittest.installHandler + href: https://docs.python.org/3/library/unittest.html#unittest.installHandler + name: installHandler + uid: unittest.installHandler +- fullName: unittest.main + href: https://docs.python.org/3/library/unittest.html#unittest.main + name: main + uid: unittest.main +- fullName: unittest.mock.call + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.call + name: call + uid: unittest.mock.call +- fullName: unittest.mock.create_autospec + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.create_autospec + name: create_autospec + uid: unittest.mock.create_autospec +- fullName: unittest.mock.mock_open + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.mock_open + name: mock_open + uid: unittest.mock.mock_open +- fullName: unittest.mock.patch + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.patch + name: patch + uid: unittest.mock.patch +- fullName: unittest.mock.patch.dict + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.patch.dict + name: dict + uid: unittest.mock.patch.dict +- fullName: unittest.mock.patch.multiple + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.patch.multiple + name: multiple + uid: unittest.mock.patch.multiple +- fullName: unittest.mock.patch.object + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.patch.object + name: object + uid: unittest.mock.patch.object +- fullName: unittest.mock.patch.stopall + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.patch.stopall + name: stopall + uid: unittest.mock.patch.stopall +- fullName: unittest.mock.seal + href: https://docs.python.org/3/library/unittest.mock.html#unittest.mock.seal + name: seal + uid: unittest.mock.seal +- fullName: unittest.registerResult + href: https://docs.python.org/3/library/unittest.html#unittest.registerResult + name: registerResult + uid: unittest.registerResult +- fullName: unittest.removeHandler + href: https://docs.python.org/3/library/unittest.html#unittest.removeHandler + name: removeHandler + uid: unittest.removeHandler +- fullName: unittest.removeResult + href: https://docs.python.org/3/library/unittest.html#unittest.removeResult + name: removeResult + uid: unittest.removeResult +- fullName: unittest.skip + href: https://docs.python.org/3/library/unittest.html#unittest.skip + name: skip + uid: unittest.skip +- fullName: unittest.skipIf + href: https://docs.python.org/3/library/unittest.html#unittest.skipIf + name: skipIf + uid: unittest.skipIf +- fullName: unittest.skipUnless + href: https://docs.python.org/3/library/unittest.html#unittest.skipUnless + name: skipUnless + uid: unittest.skipUnless +- fullName: urllib.parse.parse_qs + href: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.parse_qs + name: parse_qs + uid: urllib.parse.parse_qs +- fullName: urllib.parse.parse_qsl + href: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.parse_qsl + name: parse_qsl + uid: urllib.parse.parse_qsl +- fullName: urllib.parse.quote + href: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.quote + name: quote + uid: urllib.parse.quote +- fullName: urllib.parse.quote_from_bytes + href: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.quote_from_bytes + name: quote_from_bytes + uid: urllib.parse.quote_from_bytes +- fullName: urllib.parse.quote_plus + href: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.quote_plus + name: quote_plus + uid: urllib.parse.quote_plus +- fullName: urllib.parse.unquote + href: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.unquote + name: unquote + uid: urllib.parse.unquote +- fullName: urllib.parse.unquote_plus + href: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.unquote_plus + name: unquote_plus + uid: urllib.parse.unquote_plus +- fullName: urllib.parse.unquote_to_bytes + href: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.unquote_to_bytes + name: unquote_to_bytes + uid: urllib.parse.unquote_to_bytes +- fullName: urllib.parse.unwrap + href: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.unwrap + name: unwrap + uid: urllib.parse.unwrap +- fullName: urllib.parse.urldefrag + href: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.urldefrag + name: urldefrag + uid: urllib.parse.urldefrag +- fullName: urllib.parse.urlencode + href: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.urlencode + name: urlencode + uid: urllib.parse.urlencode +- fullName: urllib.parse.urljoin + href: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.urljoin + name: urljoin + uid: urllib.parse.urljoin +- fullName: urllib.parse.urlparse + href: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.urlparse + name: urlparse + uid: urllib.parse.urlparse +- fullName: urllib.parse.urlsplit + href: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.urlsplit + name: urlsplit + uid: urllib.parse.urlsplit +- fullName: urllib.parse.urlunparse + href: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.urlunparse + name: urlunparse + uid: urllib.parse.urlunparse +- fullName: urllib.parse.urlunsplit + href: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.urlunsplit + name: urlunsplit + uid: urllib.parse.urlunsplit +- fullName: urllib.request.build_opener + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.build_opener + name: build_opener + uid: urllib.request.build_opener +- fullName: urllib.request.getproxies + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.getproxies + name: getproxies + uid: urllib.request.getproxies +- fullName: urllib.request.install_opener + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.install_opener + name: install_opener + uid: urllib.request.install_opener +- fullName: urllib.request.pathname2url + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.pathname2url + name: pathname2url + uid: urllib.request.pathname2url +- fullName: urllib.request.url2pathname + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.url2pathname + name: url2pathname + uid: urllib.request.url2pathname +- fullName: urllib.request.urlcleanup + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.urlcleanup + name: urlcleanup + uid: urllib.request.urlcleanup +- fullName: urllib.request.urlopen + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.urlopen + name: urlopen + uid: urllib.request.urlopen +- fullName: urllib.request.urlretrieve + href: https://docs.python.org/3/library/urllib.request.html#urllib.request.urlretrieve + name: urlretrieve + uid: urllib.request.urlretrieve +- fullName: uuid.getnode + href: https://docs.python.org/3/library/uuid.html#uuid.getnode + name: getnode + uid: uuid.getnode +- fullName: uuid.uuid1 + href: https://docs.python.org/3/library/uuid.html#uuid.uuid1 + name: uuid1 + uid: uuid.uuid1 +- fullName: uuid.uuid3 + href: https://docs.python.org/3/library/uuid.html#uuid.uuid3 + name: uuid3 + uid: uuid.uuid3 +- fullName: uuid.uuid4 + href: https://docs.python.org/3/library/uuid.html#uuid.uuid4 + name: uuid4 + uid: uuid.uuid4 +- fullName: uuid.uuid5 + href: https://docs.python.org/3/library/uuid.html#uuid.uuid5 + name: uuid5 + uid: uuid.uuid5 +- fullName: vars + href: https://docs.python.org/3/library/functions.html#vars + name: vars + uid: vars +- fullName: venv.create + href: https://docs.python.org/3/library/venv.html#venv.create + name: create + uid: venv.create +- fullName: warnings.deprecated + href: https://docs.python.org/3/library/warnings.html#warnings.deprecated + name: deprecated + uid: warnings.deprecated +- fullName: warnings.filterwarnings + href: https://docs.python.org/3/library/warnings.html#warnings.filterwarnings + name: filterwarnings + uid: warnings.filterwarnings +- fullName: warnings.formatwarning + href: https://docs.python.org/3/library/warnings.html#warnings.formatwarning + name: formatwarning + uid: warnings.formatwarning +- fullName: warnings.resetwarnings + href: https://docs.python.org/3/library/warnings.html#warnings.resetwarnings + name: resetwarnings + uid: warnings.resetwarnings +- fullName: warnings.showwarning + href: https://docs.python.org/3/library/warnings.html#warnings.showwarning + name: showwarning + uid: warnings.showwarning +- fullName: warnings.simplefilter + href: https://docs.python.org/3/library/warnings.html#warnings.simplefilter + name: simplefilter + uid: warnings.simplefilter +- fullName: warnings.warn + href: https://docs.python.org/3/library/warnings.html#warnings.warn + name: warn + uid: warnings.warn +- fullName: warnings.warn_explicit + href: https://docs.python.org/3/library/warnings.html#warnings.warn_explicit + name: warn_explicit + uid: warnings.warn_explicit +- fullName: wave.open + href: https://docs.python.org/3/library/wave.html#wave.open + name: open + uid: wave.open +- fullName: weakref.getweakrefcount + href: https://docs.python.org/3/library/weakref.html#weakref.getweakrefcount + name: getweakrefcount + uid: weakref.getweakrefcount +- fullName: weakref.getweakrefs + href: https://docs.python.org/3/library/weakref.html#weakref.getweakrefs + name: getweakrefs + uid: weakref.getweakrefs +- fullName: weakref.proxy + href: https://docs.python.org/3/library/weakref.html#weakref.proxy + name: proxy + uid: weakref.proxy +- fullName: webbrowser.get + href: https://docs.python.org/3/library/webbrowser.html#webbrowser.get + name: get + uid: webbrowser.get +- fullName: webbrowser.open + href: https://docs.python.org/3/library/webbrowser.html#webbrowser.open + name: open + uid: webbrowser.open +- fullName: webbrowser.open_new + href: https://docs.python.org/3/library/webbrowser.html#webbrowser.open_new + name: open_new + uid: webbrowser.open_new +- fullName: webbrowser.open_new_tab + href: https://docs.python.org/3/library/webbrowser.html#webbrowser.open_new_tab + name: open_new_tab + uid: webbrowser.open_new_tab +- fullName: webbrowser.register + href: https://docs.python.org/3/library/webbrowser.html#webbrowser.register + name: register + uid: webbrowser.register +- fullName: winreg.CloseKey + href: https://docs.python.org/3/library/winreg.html#winreg.CloseKey + name: CloseKey + uid: winreg.CloseKey +- fullName: winreg.ConnectRegistry + href: https://docs.python.org/3/library/winreg.html#winreg.ConnectRegistry + name: ConnectRegistry + uid: winreg.ConnectRegistry +- fullName: winreg.CreateKey + href: https://docs.python.org/3/library/winreg.html#winreg.CreateKey + name: CreateKey + uid: winreg.CreateKey +- fullName: winreg.CreateKeyEx + href: https://docs.python.org/3/library/winreg.html#winreg.CreateKeyEx + name: CreateKeyEx + uid: winreg.CreateKeyEx +- fullName: winreg.DeleteKey + href: https://docs.python.org/3/library/winreg.html#winreg.DeleteKey + name: DeleteKey + uid: winreg.DeleteKey +- fullName: winreg.DeleteKeyEx + href: https://docs.python.org/3/library/winreg.html#winreg.DeleteKeyEx + name: DeleteKeyEx + uid: winreg.DeleteKeyEx +- fullName: winreg.DeleteValue + href: https://docs.python.org/3/library/winreg.html#winreg.DeleteValue + name: DeleteValue + uid: winreg.DeleteValue +- fullName: winreg.DisableReflectionKey + href: https://docs.python.org/3/library/winreg.html#winreg.DisableReflectionKey + name: DisableReflectionKey + uid: winreg.DisableReflectionKey +- fullName: winreg.EnableReflectionKey + href: https://docs.python.org/3/library/winreg.html#winreg.EnableReflectionKey + name: EnableReflectionKey + uid: winreg.EnableReflectionKey +- fullName: winreg.EnumKey + href: https://docs.python.org/3/library/winreg.html#winreg.EnumKey + name: EnumKey + uid: winreg.EnumKey +- fullName: winreg.EnumValue + href: https://docs.python.org/3/library/winreg.html#winreg.EnumValue + name: EnumValue + uid: winreg.EnumValue +- fullName: winreg.ExpandEnvironmentStrings + href: https://docs.python.org/3/library/winreg.html#winreg.ExpandEnvironmentStrings + name: ExpandEnvironmentStrings + uid: winreg.ExpandEnvironmentStrings +- fullName: winreg.FlushKey + href: https://docs.python.org/3/library/winreg.html#winreg.FlushKey + name: FlushKey + uid: winreg.FlushKey +- fullName: winreg.LoadKey + href: https://docs.python.org/3/library/winreg.html#winreg.LoadKey + name: LoadKey + uid: winreg.LoadKey +- fullName: winreg.OpenKey + href: https://docs.python.org/3/library/winreg.html#winreg.OpenKey + name: OpenKey + uid: winreg.OpenKey +- fullName: winreg.OpenKeyEx + href: https://docs.python.org/3/library/winreg.html#winreg.OpenKeyEx + name: OpenKeyEx + uid: winreg.OpenKeyEx +- fullName: winreg.QueryInfoKey + href: https://docs.python.org/3/library/winreg.html#winreg.QueryInfoKey + name: QueryInfoKey + uid: winreg.QueryInfoKey +- fullName: winreg.QueryReflectionKey + href: https://docs.python.org/3/library/winreg.html#winreg.QueryReflectionKey + name: QueryReflectionKey + uid: winreg.QueryReflectionKey +- fullName: winreg.QueryValue + href: https://docs.python.org/3/library/winreg.html#winreg.QueryValue + name: QueryValue + uid: winreg.QueryValue +- fullName: winreg.QueryValueEx + href: https://docs.python.org/3/library/winreg.html#winreg.QueryValueEx + name: QueryValueEx + uid: winreg.QueryValueEx +- fullName: winreg.SaveKey + href: https://docs.python.org/3/library/winreg.html#winreg.SaveKey + name: SaveKey + uid: winreg.SaveKey +- fullName: winreg.SetValue + href: https://docs.python.org/3/library/winreg.html#winreg.SetValue + name: SetValue + uid: winreg.SetValue +- fullName: winreg.SetValueEx + href: https://docs.python.org/3/library/winreg.html#winreg.SetValueEx + name: SetValueEx + uid: winreg.SetValueEx +- fullName: winsound.Beep + href: https://docs.python.org/3/library/winsound.html#winsound.Beep + name: Beep + uid: winsound.Beep +- fullName: winsound.MessageBeep + href: https://docs.python.org/3/library/winsound.html#winsound.MessageBeep + name: MessageBeep + uid: winsound.MessageBeep +- fullName: winsound.PlaySound + href: https://docs.python.org/3/library/winsound.html#winsound.PlaySound + name: PlaySound + uid: winsound.PlaySound +- fullName: wsgiref.handlers.read_environ + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.handlers.read_environ + name: read_environ + uid: wsgiref.handlers.read_environ +- fullName: wsgiref.simple_server.demo_app + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.simple_server.demo_app + name: demo_app + uid: wsgiref.simple_server.demo_app +- fullName: wsgiref.simple_server.make_server + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.simple_server.make_server + name: make_server + uid: wsgiref.simple_server.make_server +- fullName: wsgiref.util.application_uri + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.util.application_uri + name: application_uri + uid: wsgiref.util.application_uri +- fullName: wsgiref.util.guess_scheme + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.util.guess_scheme + name: guess_scheme + uid: wsgiref.util.guess_scheme +- fullName: wsgiref.util.is_hop_by_hop + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.util.is_hop_by_hop + name: is_hop_by_hop + uid: wsgiref.util.is_hop_by_hop +- fullName: wsgiref.util.request_uri + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.util.request_uri + name: request_uri + uid: wsgiref.util.request_uri +- fullName: wsgiref.util.setup_testing_defaults + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.util.setup_testing_defaults + name: setup_testing_defaults + uid: wsgiref.util.setup_testing_defaults +- fullName: wsgiref.util.shift_path_info + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.util.shift_path_info + name: shift_path_info + uid: wsgiref.util.shift_path_info +- fullName: wsgiref.validate.validator + href: https://docs.python.org/3/library/wsgiref.html#wsgiref.validate.validator + name: validator + uid: wsgiref.validate.validator +- fullName: xml.dom.getDOMImplementation + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.getDOMImplementation + name: getDOMImplementation + uid: xml.dom.getDOMImplementation +- fullName: xml.dom.minidom.parse + href: https://docs.python.org/3/library/xml.dom.minidom.html#xml.dom.minidom.parse + name: parse + uid: xml.dom.minidom.parse +- fullName: xml.dom.minidom.parseString + href: https://docs.python.org/3/library/xml.dom.minidom.html#xml.dom.minidom.parseString + name: parseString + uid: xml.dom.minidom.parseString +- fullName: xml.dom.pulldom.parse + href: https://docs.python.org/3/library/xml.dom.pulldom.html#xml.dom.pulldom.parse + name: parse + uid: xml.dom.pulldom.parse +- fullName: xml.dom.pulldom.parseString + href: https://docs.python.org/3/library/xml.dom.pulldom.html#xml.dom.pulldom.parseString + name: parseString + uid: xml.dom.pulldom.parseString +- fullName: xml.dom.registerDOMImplementation + href: https://docs.python.org/3/library/xml.dom.html#xml.dom.registerDOMImplementation + name: registerDOMImplementation + uid: xml.dom.registerDOMImplementation +- fullName: xml.etree.ElementInclude.default_loader + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementInclude.default_loader + name: default_loader + uid: xml.etree.ElementInclude.default_loader +- fullName: xml.etree.ElementInclude.include + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementInclude.include + name: include + uid: xml.etree.ElementInclude.include +- fullName: xml.etree.ElementTree.Comment + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Comment + name: Comment + uid: xml.etree.ElementTree.Comment +- fullName: xml.etree.ElementTree.ProcessingInstruction + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.ProcessingInstruction + name: ProcessingInstruction + uid: xml.etree.ElementTree.ProcessingInstruction +- fullName: xml.etree.ElementTree.SubElement + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.SubElement + name: SubElement + uid: xml.etree.ElementTree.SubElement +- fullName: xml.etree.ElementTree.XML + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.XML + name: XML + uid: xml.etree.ElementTree.XML +- fullName: xml.etree.ElementTree.XMLID + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.XMLID + name: XMLID + uid: xml.etree.ElementTree.XMLID +- fullName: xml.etree.ElementTree.canonicalize + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.canonicalize + name: canonicalize + uid: xml.etree.ElementTree.canonicalize +- fullName: xml.etree.ElementTree.dump + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.dump + name: dump + uid: xml.etree.ElementTree.dump +- fullName: xml.etree.ElementTree.fromstring + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.fromstring + name: fromstring + uid: xml.etree.ElementTree.fromstring +- fullName: xml.etree.ElementTree.fromstringlist + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.fromstringlist + name: fromstringlist + uid: xml.etree.ElementTree.fromstringlist +- fullName: xml.etree.ElementTree.indent + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.indent + name: indent + uid: xml.etree.ElementTree.indent +- fullName: xml.etree.ElementTree.iselement + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.iselement + name: iselement + uid: xml.etree.ElementTree.iselement +- fullName: xml.etree.ElementTree.iterparse + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.iterparse + name: iterparse + uid: xml.etree.ElementTree.iterparse +- fullName: xml.etree.ElementTree.parse + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.parse + name: parse + uid: xml.etree.ElementTree.parse +- fullName: xml.etree.ElementTree.register_namespace + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.register_namespace + name: register_namespace + uid: xml.etree.ElementTree.register_namespace +- fullName: xml.etree.ElementTree.tostring + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.tostring + name: tostring + uid: xml.etree.ElementTree.tostring +- fullName: xml.etree.ElementTree.tostringlist + href: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.tostringlist + name: tostringlist + uid: xml.etree.ElementTree.tostringlist +- fullName: xml.parsers.expat.ErrorString + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.ErrorString + name: ErrorString + uid: xml.parsers.expat.ErrorString +- fullName: xml.parsers.expat.ParserCreate + href: https://docs.python.org/3/library/pyexpat.html#xml.parsers.expat.ParserCreate + name: ParserCreate + uid: xml.parsers.expat.ParserCreate +- fullName: xml.sax.make_parser + href: https://docs.python.org/3/library/xml.sax.html#xml.sax.make_parser + name: make_parser + uid: xml.sax.make_parser +- fullName: xml.sax.parse + href: https://docs.python.org/3/library/xml.sax.html#xml.sax.parse + name: parse + uid: xml.sax.parse +- fullName: xml.sax.parseString + href: https://docs.python.org/3/library/xml.sax.html#xml.sax.parseString + name: parseString + uid: xml.sax.parseString +- fullName: xml.sax.saxutils.escape + href: https://docs.python.org/3/library/xml.sax.utils.html#xml.sax.saxutils.escape + name: escape + uid: xml.sax.saxutils.escape +- fullName: xml.sax.saxutils.prepare_input_source + href: https://docs.python.org/3/library/xml.sax.utils.html#xml.sax.saxutils.prepare_input_source + name: prepare_input_source + uid: xml.sax.saxutils.prepare_input_source +- fullName: xml.sax.saxutils.quoteattr + href: https://docs.python.org/3/library/xml.sax.utils.html#xml.sax.saxutils.quoteattr + name: quoteattr + uid: xml.sax.saxutils.quoteattr +- fullName: xml.sax.saxutils.unescape + href: https://docs.python.org/3/library/xml.sax.utils.html#xml.sax.saxutils.unescape + name: unescape + uid: xml.sax.saxutils.unescape +- fullName: xmlrpc.client.dumps + href: https://docs.python.org/3/library/xmlrpc.client.html#xmlrpc.client.dumps + name: dumps + uid: xmlrpc.client.dumps +- fullName: xmlrpc.client.loads + href: https://docs.python.org/3/library/xmlrpc.client.html#xmlrpc.client.loads + name: loads + uid: xmlrpc.client.loads +- fullName: zip + href: https://docs.python.org/3/library/functions.html#zip + name: zip + uid: zip +- fullName: zipapp.create_archive + href: https://docs.python.org/3/library/zipapp.html#zipapp.create_archive + name: create_archive + uid: zipapp.create_archive +- fullName: zipapp.get_interpreter + href: https://docs.python.org/3/library/zipapp.html#zipapp.get_interpreter + name: get_interpreter + uid: zipapp.get_interpreter +- fullName: zipfile.is_zipfile + href: https://docs.python.org/3/library/zipfile.html#zipfile.is_zipfile + name: is_zipfile + uid: zipfile.is_zipfile +- fullName: zlib.adler32 + href: https://docs.python.org/3/library/zlib.html#zlib.adler32 + name: adler32 + uid: zlib.adler32 +- fullName: zlib.compress + href: https://docs.python.org/3/library/zlib.html#zlib.compress + name: compress + uid: zlib.compress +- fullName: zlib.compressobj + href: https://docs.python.org/3/library/zlib.html#zlib.compressobj + name: compressobj + uid: zlib.compressobj +- fullName: zlib.crc32 + href: https://docs.python.org/3/library/zlib.html#zlib.crc32 + name: crc32 + uid: zlib.crc32 +- fullName: zlib.decompress + href: https://docs.python.org/3/library/zlib.html#zlib.decompress + name: decompress + uid: zlib.decompress +- fullName: zlib.decompressobj + href: https://docs.python.org/3/library/zlib.html#zlib.decompressobj + name: decompressobj + uid: zlib.decompressobj +- fullName: zoneinfo.available_timezones + href: https://docs.python.org/3/library/zoneinfo.html#zoneinfo.available_timezones + name: available_timezones + uid: zoneinfo.available_timezones +- fullName: zoneinfo.reset_tzpath + href: https://docs.python.org/3/library/zoneinfo.html#zoneinfo.reset_tzpath + name: reset_tzpath + uid: zoneinfo.reset_tzpath From 317cf8b8581ce46f177261dc5f99dce039b07be0 Mon Sep 17 00:00:00 2001 From: "docsreference@microsoft.com" Date: Tue, 8 Apr 2025 12:29:50 +0000 Subject: [PATCH 2/2] CI Update Build.Reason:Manual by Sai Cai (BEYONDSOFT CONSULTING INC) Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=518630&view=results --- ....metricsadvisor.models.AnomalyFeedback.yml | 3 - ...AzureApplicationInsightsDataFeedSource.yml | 3 - ...advisor.models.AzureBlobDataFeedSource.yml | 3 - ...sor.models.AzureCosmosDbDataFeedSource.yml | 3 - ...models.AzureDataExplorerDataFeedSource.yml | 3 - ...AzureDataLakeStorageGen2DataFeedSource.yml | 3 - ...or.models.AzureEventHubsDataFeedSource.yml | 3 - ...models.AzureLogAnalyticsDataFeedSource.yml | 3 - ...dvisor.models.AzureTableDataFeedSource.yml | 3 - ...ricsadvisor.models.ChangePointFeedback.yml | 3 - ....metricsadvisor.models.CommentFeedback.yml | 3 - ...i.metricsadvisor.models.DataFeedSource.yml | 3 - ...icsadvisor.models.DatasourceCredential.yml | 3 - ...models.DatasourceDataLakeGen2SharedKey.yml | 3 - ...isor.models.DatasourceServicePrincipal.yml | 3 - ...s.DatasourceServicePrincipalInKeyVault.yml | 3 - ...r.models.DatasourceSqlConnectionString.yml | 3 - ...odels.DetectionIncidentFilterCondition.yml | 1 + ...sadvisor.models.InfluxDbDataFeedSource.yml | 3 - ...dvisor.models.MetricDetectionCondition.yml | 4 ++ ...i.metricsadvisor.models.MetricFeedback.yml | 3 - ...metricsadvisor.models.MetricSeriesData.yml | 1 + ...csadvisor.models.MongoDbDataFeedSource.yml | 3 - ...ricsadvisor.models.MySqlDataFeedSource.yml | 3 - ...i.metricsadvisor.models.PeriodFeedback.yml | 3 - ...dvisor.models.PostgreSqlDataFeedSource.yml | 3 - ...advisor.models.SqlServerDataFeedSource.yml | 3 - ...vision.image_analysis_data.ContentTags.yml | 4 +- ...on.image_analysis_data.CropSuggestions.yml | 4 +- ...sion.image_analysis_data.DenseCaptions.yml | 4 +- ...on.image_analysis_data.DetectedObjects.yml | 4 +- ...ion.image_analysis_data.DetectedPeople.yml | 4 +- ...plicationinsights.models.Column(class).yml | 4 +- ...applicationinsights.models.ErrorDetail.yml | 8 +-- ...e.applicationinsights.models.ErrorInfo.yml | 6 +- ...pplicationinsights.models.EventsAiInfo.yml | 8 +-- ...ninsights.models.EventsApplicationInfo.yml | 2 +- ...ts.models.EventsAvailabilityResultInfo.yml | 16 ++--- ....models.EventsAvailabilityResultResult.yml | 26 ++++---- ...nsights.models.EventsBrowserTimingInfo.yml | 20 +++--- ...ights.models.EventsBrowserTimingResult.yml | 28 ++++---- ...cationinsights.models.EventsClientInfo.yml | 16 ++--- ...hts.models.EventsClientPerformanceInfo.yml | 2 +- ...icationinsights.models.EventsCloudInfo.yml | 4 +- ...ninsights.models.EventsCustomEventInfo.yml | 2 +- ...nsights.models.EventsCustomEventResult.yml | 26 ++++---- ...insights.models.EventsCustomMetricInfo.yml | 14 ++-- ...sights.models.EventsCustomMetricResult.yml | 26 ++++---- ...oninsights.models.EventsDependencyInfo.yml | 18 ++--- ...insights.models.EventsDependencyResult.yml | 26 ++++---- ...ninsights.models.EventsExceptionDetail.yml | 12 ++-- ...dels.EventsExceptionDetailsParsedStack.yml | 8 +-- ...ioninsights.models.EventsExceptionInfo.yml | 32 ++++----- ...ninsights.models.EventsExceptionResult.yml | 26 ++++---- ...ioninsights.models.EventsOperationInfo.yml | 8 +-- ...tioninsights.models.EventsPageViewInfo.yml | 8 +-- ...oninsights.models.EventsPageViewResult.yml | 26 ++++---- ...ts.models.EventsPerformanceCounterInfo.yml | 12 ++-- ....models.EventsPerformanceCounterResult.yml | 26 ++++---- ...ationinsights.models.EventsRequestInfo.yml | 16 ++--- ...ioninsights.models.EventsRequestResult.yml | 26 ++++---- ...pplicationinsights.models.EventsResult.yml | 4 +- ...cationinsights.models.EventsResultData.yml | 24 +++---- ...odels.EventsResultDataCustomDimensions.yml | 2 +- ...els.EventsResultDataCustomMeasurements.yml | 2 +- ...plicationinsights.models.EventsResults.yml | 6 +- ...ationinsights.models.EventsSessionInfo.yml | 2 +- ...icationinsights.models.EventsTraceInfo.yml | 4 +- ...ationinsights.models.EventsTraceResult.yml | 26 ++++---- ...licationinsights.models.EventsUserInfo.yml | 6 +- ...models.MetricsPostBodySchemaParameters.yml | 14 ++-- ...plicationinsights.models.MetricsResult.yml | 2 +- ...ationinsights.models.MetricsResultInfo.yml | 10 +-- ...tioninsights.models.MetricsSegmentInfo.yml | 8 +-- ...e.applicationinsights.models.QueryBody.yml | 4 +- ...ationinsights.models.column_py3.Column.yml | 4 +- ...ts.models.error_detail_py3.ErrorDetail.yml | 8 +-- ...sights.models.error_info_py3.ErrorInfo.yml | 6 +- ...models.events_ai_info_py3.EventsAiInfo.yml | 8 +-- ...ication_info_py3.EventsApplicationInfo.yml | 2 +- ..._info_py3.EventsAvailabilityResultInfo.yml | 16 ++--- ...ult_py3.EventsAvailabilityResultResult.yml | 26 ++++---- ...iming_info_py3.EventsBrowserTimingInfo.yml | 20 +++--- ...g_result_py3.EventsBrowserTimingResult.yml | 28 ++++---- ...vents_client_info_py3.EventsClientInfo.yml | 16 ++--- ...e_info_py3.EventsClientPerformanceInfo.yml | 2 +- ....events_cloud_info_py3.EventsCloudInfo.yml | 4 +- ...m_event_info_py3.EventsCustomEventInfo.yml | 2 +- ...ent_result_py3.EventsCustomEventResult.yml | 26 ++++---- ...metric_info_py3.EventsCustomMetricInfo.yml | 14 ++-- ...ic_result_py3.EventsCustomMetricResult.yml | 26 ++++---- ...pendency_info_py3.EventsDependencyInfo.yml | 18 ++--- ...ency_result_py3.EventsDependencyResult.yml | 26 ++++---- ...ption_detail_py3.EventsExceptionDetail.yml | 12 ++-- ..._py3.EventsExceptionDetailsParsedStack.yml | 8 +-- ...exception_info_py3.EventsExceptionInfo.yml | 32 ++++----- ...ption_result_py3.EventsExceptionResult.yml | 26 ++++---- ...operation_info_py3.EventsOperationInfo.yml | 8 +-- ..._page_view_info_py3.EventsPageViewInfo.yml | 8 +-- ...e_view_result_py3.EventsPageViewResult.yml | 26 ++++---- ..._info_py3.EventsPerformanceCounterInfo.yml | 12 ++-- ...ult_py3.EventsPerformanceCounterResult.yml | 26 ++++---- ...nts_request_info_py3.EventsRequestInfo.yml | 16 ++--- ...request_result_py3.EventsRequestResult.yml | 26 ++++---- ...s_py3.EventsResultDataCustomDimensions.yml | 2 +- ...py3.EventsResultDataCustomMeasurements.yml | 2 +- ...vents_result_data_py3.EventsResultData.yml | 24 +++---- ....models.events_result_py3.EventsResult.yml | 4 +- ...odels.events_results_py3.EventsResults.yml | 6 +- ...nts_session_info_py3.EventsSessionInfo.yml | 2 +- ....events_trace_info_py3.EventsTraceInfo.yml | 4 +- ...nts_trace_result_py3.EventsTraceResult.yml | 26 ++++---- ...ls.events_user_info_py3.EventsUserInfo.yml | 6 +- ...rs_py3.MetricsPostBodySchemaParameters.yml | 14 ++-- ...rics_result_info_py3.MetricsResultInfo.yml | 10 +-- ...odels.metrics_result_py3.MetricsResult.yml | 2 +- ...cs_segment_info_py3.MetricsSegmentInfo.yml | 8 +-- ...sights.models.query_body_py3.QueryBody.yml | 4 +- ...rvices.anomalydetector.models.APIError.yml | 4 +- ...tector.models.ChangePointDetectRequest.yml | 8 +-- ...ervices.anomalydetector.models.Request.yml | 8 +-- ...maker.models.ActiveLearningSettingsDTO.yml | 2 +- ...e.qnamaker.models.AnswerSpanRequestDTO.yml | 6 +- ....qnamaker.models.AnswerSpanResponseDTO.yml | 8 +-- ...s.knowledge.qnamaker.models.ContextDTO.yml | 4 +- ....knowledge.qnamaker.models.CreateKbDTO.yml | 16 ++--- ...ledge.qnamaker.models.CreateKbInputDTO.yml | 6 +- ...ge.qnamaker.models.DeleteKbContentsDTO.yml | 4 +- ...wledge.qnamaker.models.EndpointKeysDTO.yml | 10 +-- ...ge.qnamaker.models.EndpointSettingsDTO.yml | 2 +- ...dels.EndpointSettingsDTOActiveLearning.yml | 2 +- ...knowledge.qnamaker.models.Error(class).yml | 8 +-- ...nowledge.qnamaker.models.ErrorResponse.yml | 2 +- ...dge.qnamaker.models.ErrorResponseError.yml | 8 +-- ...edge.qnamaker.models.FeedbackRecordDTO.yml | 6 +- ...dge.qnamaker.models.FeedbackRecordsDTO.yml | 2 +- ...wledge.qnamaker.models.InnerErrorModel.yml | 4 +- ...ledge.qnamaker.models.KnowledgebaseDTO.yml | 18 ++--- ...edge.qnamaker.models.KnowledgebasesDTO.yml | 2 +- ...ledge.qnamaker.models.Operation(class).yml | 14 ++-- ...es.knowledge.qnamaker.models.PromptDTO.yml | 8 +-- ...knowledge.qnamaker.models.PromptDTOQna.yml | 10 +-- ...vices.knowledge.qnamaker.models.QnADTO.yml | 10 +-- ...nowledge.qnamaker.models.QnADTOContext.yml | 4 +- ...wledge.qnamaker.models.QnADocumentsDTO.yml | 2 +- ...wledge.qnamaker.models.QnASearchResult.yml | 16 ++--- ...maker.models.QnASearchResultAnswerSpan.yml | 8 +-- ...qnamaker.models.QnASearchResultContext.yml | 4 +- ...ge.qnamaker.models.QnASearchResultList.yml | 2 +- ...wledge.qnamaker.models.QueryContextDTO.yml | 4 +- ...ces.knowledge.qnamaker.models.QueryDTO.yml | 22 +++---- ...maker.models.QueryDTOAnswerSpanRequest.yml | 6 +- ...wledge.qnamaker.models.QueryDTOContext.yml | 4 +- ...ledge.qnamaker.models.UpdateContextDTO.yml | 6 +- ...ge.qnamaker.models.UpdateKbContentsDTO.yml | 8 +-- ...e.qnamaker.models.UpdateKbOperationDTO.yml | 10 +-- ...namaker.models.UpdateKbOperationDTOAdd.yml | 6 +- ...aker.models.UpdateKbOperationDTODelete.yml | 4 +- ...aker.models.UpdateKbOperationDTOUpdate.yml | 8 +-- ...edge.qnamaker.models.UpdateMetadataDTO.yml | 4 +- ...knowledge.qnamaker.models.UpdateQnaDTO.yml | 12 ++-- ...ge.qnamaker.models.UpdateQnaDTOContext.yml | 6 +- ...e.qnamaker.models.UpdateQnaDTOMetadata.yml | 4 +- ....qnamaker.models.UpdateQnaDTOQuestions.yml | 4 +- ...dge.qnamaker.models.UpdateQuestionsDTO.yml | 4 +- ...ings_dto_py3.ActiveLearningSettingsDTO.yml | 2 +- ...n_request_dto_py3.AnswerSpanRequestDTO.yml | 6 +- ...response_dto_py3.AnswerSpanResponseDTO.yml | 8 +-- ...aker.models.context_dto_py3.ContextDTO.yml | 4 +- ...r.models.create_kb_dto_py3.CreateKbDTO.yml | 16 ++--- ...eate_kb_input_dto_py3.CreateKbInputDTO.yml | 6 +- ...b_contents_dto_py3.DeleteKbContentsDTO.yml | 4 +- ....endpoint_keys_dto_py3.EndpointKeysDTO.yml | 10 +-- ..._py3.EndpointSettingsDTOActiveLearning.yml | 2 +- ...t_settings_dto_py3.EndpointSettingsDTO.yml | 2 +- ...wledge.qnamaker.models.error_py3.Error.yml | 8 +-- ..._response_error_py3.ErrorResponseError.yml | 8 +-- ...odels.error_response_py3.ErrorResponse.yml | 2 +- ...dback_record_dto_py3.FeedbackRecordDTO.yml | 6 +- ...ack_records_dto_py3.FeedbackRecordsDTO.yml | 2 +- ....inner_error_model_py3.InnerErrorModel.yml | 4 +- ...knowledgebase_dto_py3.KnowledgebaseDTO.yml | 18 ++--- ...owledgebases_dto_py3.KnowledgebasesDTO.yml | 2 +- ...namaker.models.operation_py3.Operation.yml | 14 ++-- ...amaker.models.prompt_dto_py3.PromptDTO.yml | 8 +-- ...models.prompt_dto_qna_py3.PromptDTOQna.yml | 10 +-- ....qn_adocuments_dto_py3.QnADocumentsDTO.yml | 2 +- ...dels.qn_adto_context_py3.QnADTOContext.yml | 4 +- ...dge.qnamaker.models.qn_adto_py3.QnADTO.yml | 10 +-- ...wer_span_py3.QnASearchResultAnswerSpan.yml | 8 +-- ...ult_context_py3.QnASearchResultContext.yml | 4 +- ...ch_result_list_py3.QnASearchResultList.yml | 2 +- ....qn_asearch_result_py3.QnASearchResult.yml | 16 ++--- ....query_context_dto_py3.QueryContextDTO.yml | 4 +- ..._request_py3.QueryDTOAnswerSpanRequest.yml | 6 +- ....query_dto_context_py3.QueryDTOContext.yml | 4 +- ...qnamaker.models.query_dto_py3.QueryDTO.yml | 22 +++---- ...pdate_context_dto_py3.UpdateContextDTO.yml | 6 +- ...b_contents_dto_py3.UpdateKbContentsDTO.yml | 8 +-- ...on_dto_add_py3.UpdateKbOperationDTOAdd.yml | 6 +- ..._delete_py3.UpdateKbOperationDTODelete.yml | 4 +- ...operation_dto_py3.UpdateKbOperationDTO.yml | 10 +-- ..._update_py3.UpdateKbOperationDTOUpdate.yml | 8 +-- ...ate_metadata_dto_py3.UpdateMetadataDTO.yml | 4 +- ...na_dto_context_py3.UpdateQnaDTOContext.yml | 6 +- ..._dto_metadata_py3.UpdateQnaDTOMetadata.yml | 4 +- ...models.update_qna_dto_py3.UpdateQnaDTO.yml | 12 ++-- ...to_questions_py3.UpdateQnaDTOQuestions.yml | 4 +- ...e_questions_dto_py3.UpdateQuestionsDTO.yml | 4 +- ...thoring.models.AppVersionSettingObject.yml | 4 +- ...thoring.models.ApplicationCreateObject.yml | 8 +-- ...thoring.models.ApplicationInfoResponse.yml | 22 +++---- ...horing.models.ApplicationPublishObject.yml | 4 +- ....models.ApplicationSettingUpdateObject.yml | 2 +- ...thoring.models.ApplicationUpdateObject.yml | 4 +- ...luis.authoring.models.AvailableCulture.yml | 4 +- ...ng.models.AvailablePrebuiltEntityModel.yml | 6 +- ...uis.authoring.models.BatchLabelExample.yml | 6 +- ...uage.luis.authoring.models.ChildEntity.yml | 10 +-- ...ng.models.ChildEntityModelCreateObject.yml | 6 +- ...guage.luis.authoring.models.ClosedList.yml | 6 +- ...oring.models.ClosedListEntityExtractor.yml | 8 +-- ...ing.models.ClosedListModelCreateObject.yml | 4 +- ...ring.models.ClosedListModelPatchObject.yml | 2 +- ...ing.models.ClosedListModelUpdateObject.yml | 4 +- ...is.authoring.models.CollaboratorsArray.yml | 2 +- ...models.CompositeChildModelCreateObject.yml | 2 +- ...horing.models.CompositeEntityExtractor.yml | 8 +-- ....authoring.models.CompositeEntityModel.yml | 4 +- ...s.authoring.models.CustomPrebuiltModel.yml | 10 +-- ...age.luis.authoring.models.EndpointInfo.yml | 16 ++--- ...thoring.models.EnqueueTrainingResponse.yml | 4 +- ...oring.models.EntitiesSuggestionExample.yml | 8 +-- ....luis.authoring.models.EntityExtractor.yml | 10 +-- ...uage.luis.authoring.models.EntityLabel.yml | 6 +- ...uis.authoring.models.EntityLabelObject.yml | 4 +- ...thoring.models.EntityModelCreateObject.yml | 4 +- ....luis.authoring.models.EntityModelInfo.yml | 6 +- ...thoring.models.EntityModelUpdateObject.yml | 4 +- ...luis.authoring.models.EntityPrediction.yml | 2 +- ...guage.luis.authoring.models.EntityRole.yml | 4 +- ...uthoring.models.EntityRoleCreateObject.yml | 2 +- ...uthoring.models.EntityRoleUpdateObject.yml | 2 +- ...ge.luis.authoring.models.ErrorResponse.yml | 4 +- ...is.authoring.models.ExampleLabelObject.yml | 6 +- ...luis.authoring.models.ExplicitListItem.yml | 4 +- ...ng.models.ExplicitListItemCreateObject.yml | 2 +- ...ng.models.ExplicitListItemUpdateObject.yml | 2 +- ...uis.authoring.models.FeatureInfoObject.yml | 8 +-- ...uthoring.models.FeaturesResponseObject.yml | 4 +- ...thoring.models.HierarchicalChildEntity.yml | 10 +-- ...els.HierarchicalChildModelUpdateObject.yml | 2 +- ...ing.models.HierarchicalEntityExtractor.yml | 8 +-- ...uis.authoring.models.HierarchicalModel.yml | 10 +-- ...s.authoring.models.HierarchicalModelV2.yml | 8 +-- ...luis.authoring.models.IntentClassifier.yml | 8 +-- ...luis.authoring.models.IntentPrediction.yml | 4 +- ...horing.models.IntentsSuggestionExample.yml | 8 +-- ...guage.luis.authoring.models.JSONEntity.yml | 4 +- ...luis.authoring.models.JSONModelFeature.yml | 8 +-- ...luis.authoring.models.JSONRegexFeature.yml | 6 +- ...ge.luis.authoring.models.JSONUtterance.yml | 6 +- ...nguage.luis.authoring.models.JsonChild.yml | 8 +-- ...ing.models.JsonModelFeatureInformation.yml | 4 +- ....authoring.models.LabelExampleResponse.yml | 4 +- ....luis.authoring.models.LabelTextObject.yml | 4 +- ...luis.authoring.models.LabeledUtterance.yml | 14 ++-- ...language.luis.authoring.models.LuisApp.yml | 34 +++++----- ...nguage.luis.authoring.models.LuisAppV2.yml | 34 +++++----- ...uis.authoring.models.ModelCreateObject.yml | 2 +- ...thoring.models.ModelFeatureInformation.yml | 6 +- ...nguage.luis.authoring.models.ModelInfo.yml | 4 +- ...uis.authoring.models.ModelInfoResponse.yml | 18 ++--- ....authoring.models.ModelTrainingDetails.yml | 10 +-- ...uis.authoring.models.ModelTrainingInfo.yml | 4 +- ...uis.authoring.models.ModelUpdateObject.yml | 2 +- ...authoring.models.NDepthEntityExtractor.yml | 12 ++-- ...e.luis.authoring.models.OperationError.yml | 4 +- ....luis.authoring.models.OperationStatus.yml | 4 +- ...guage.luis.authoring.models.PatternAny.yml | 6 +- ...oring.models.PatternAnyEntityExtractor.yml | 8 +-- ...ing.models.PatternAnyModelCreateObject.yml | 4 +- ...ing.models.PatternAnyModelUpdateObject.yml | 4 +- ...is.authoring.models.PatternFeatureInfo.yml | 10 +-- ...uage.luis.authoring.models.PatternRule.yml | 4 +- ...thoring.models.PatternRuleCreateObject.yml | 4 +- ....luis.authoring.models.PatternRuleInfo.yml | 6 +- ...thoring.models.PatternRuleUpdateObject.yml | 6 +- ...ring.models.PersonalAssistantsResponse.yml | 4 +- ...authoring.models.PhraseListFeatureInfo.yml | 12 ++-- ...uthoring.models.PhraselistCreateObject.yml | 4 +- ...uthoring.models.PhraselistUpdateObject.yml | 4 +- ...e.luis.authoring.models.PrebuiltDomain.yml | 12 ++-- ....models.PrebuiltDomainCreateBaseObject.yml | 2 +- ...ring.models.PrebuiltDomainCreateObject.yml | 4 +- ...is.authoring.models.PrebuiltDomainItem.yml | 6 +- ...models.PrebuiltDomainModelCreateObject.yml | 4 +- ....authoring.models.PrebuiltDomainObject.yml | 4 +- ...e.luis.authoring.models.PrebuiltEntity.yml | 4 +- ...thoring.models.PrebuiltEntityExtractor.yml | 6 +- ...models.ProductionOrStagingEndpointInfo.yml | 16 ++--- ...ring.models.PublishSettingUpdateObject.yml | 6 +- ...uage.luis.authoring.models.RegexEntity.yml | 6 +- ....authoring.models.RegexEntityExtractor.yml | 8 +-- ...uthoring.models.RegexModelCreateObject.yml | 4 +- ...uthoring.models.RegexModelUpdateObject.yml | 4 +- ...ge.luis.authoring.models.SubClosedList.yml | 4 +- ...authoring.models.SubClosedListResponse.yml | 6 +- ...luis.authoring.models.TaskUpdateObject.yml | 2 +- ...e.luis.authoring.models.UserAccessList.yml | 4 +- ...luis.authoring.models.UserCollaborator.yml | 2 +- ...uage.luis.authoring.models.VersionInfo.yml | 20 +++--- ...horing.models.WordListBaseUpdateObject.yml | 4 +- ...e.luis.authoring.models.WordListObject.yml | 4 +- ...age.luis.runtime.models.ExternalEntity.yml | 4 +- ...es.language.luis.runtime.models.Intent.yml | 4 +- ...anguage.luis.runtime.models.Prediction.yml | 4 +- ....luis.runtime.models.PredictionRequest.yml | 6 +- ...untime.models.PredictionRequestOptions.yml | 4 +- ...nguage.luis.runtime.models.RequestList.yml | 4 +- ...language.luis.runtime.models.Sentiment.yml | 2 +- ....textanalytics.models.DetectedLanguage.yml | 6 +- ...extanalytics.models.DocumentStatistics.yml | 4 +- ...alytics.models.EntitiesBatchResultItem.yml | 4 +- ...uage.textanalytics.models.EntityRecord.yml | 14 ++-- ...guage.textanalytics.models.ErrorRecord.yml | 4 +- ...age.textanalytics.models.ErrorResponse.yml | 8 +-- ...age.textanalytics.models.InternalError.yml | 6 +- ...lytics.models.KeyPhraseBatchResultItem.yml | 4 +- ...extanalytics.models.LanguageBatchInput.yml | 2 +- ...alytics.models.LanguageBatchResultItem.yml | 6 +- ...age.textanalytics.models.LanguageInput.yml | 6 +- ...guage.textanalytics.models.MatchRecord.yml | 10 +-- ...alytics.models.MultiLanguageBatchInput.yml | 2 +- ...extanalytics.models.MultiLanguageInput.yml | 6 +- ...textanalytics.models.RequestStatistics.yml | 8 +-- ...lytics.models.SentimentBatchResultItem.yml | 6 +- ...detected_language_py3.DetectedLanguage.yml | 6 +- ...ment_statistics_py3.DocumentStatistics.yml | 4 +- ...esult_item_py3.EntitiesBatchResultItem.yml | 4 +- ....models.entity_record_py3.EntityRecord.yml | 14 ++-- ...cs.models.error_record_py3.ErrorRecord.yml | 4 +- ...odels.error_response_py3.ErrorResponse.yml | 8 +-- ...odels.internal_error_py3.InternalError.yml | 6 +- ...sult_item_py3.KeyPhraseBatchResultItem.yml | 4 +- ...age_batch_input_py3.LanguageBatchInput.yml | 2 +- ...esult_item_py3.LanguageBatchResultItem.yml | 6 +- ...odels.language_input_py3.LanguageInput.yml | 6 +- ...cs.models.match_record_py3.MatchRecord.yml | 10 +-- ...atch_input_py3.MultiLanguageBatchInput.yml | 2 +- ..._language_input_py3.MultiLanguageInput.yml | 6 +- ...quest_statistics_py3.RequestStatistics.yml | 8 +-- ...sult_item_py3.SentimentBatchResultItem.yml | 6 +- ...rch.visualsearch.models.Filters(class).yml | 2 +- ...s.search.visualsearch.models.ImageInfo.yml | 6 +- ...h.visualsearch.models.KnowledgeRequest.yml | 2 +- ...isualsearch.models.VisualSearchRequest.yml | 4 +- ...isualsearch.models.filters_py3.Filters.yml | 2 +- ...search.models.image_info_py3.ImageInfo.yml | 6 +- ...knowledge_request_py3.KnowledgeRequest.yml | 2 +- ...search_request_py3.VisualSearchRequest.yml | 4 +- ...vision.computervision.models.AdultInfo.yml | 12 ++-- ...utervision.models.AreaOfInterestResult.yml | 6 +- ...ion.computervision.models.BoundingRect.yml | 8 +-- ....vision.computervision.models.Category.yml | 6 +- ...n.computervision.models.CategoryDetail.yml | 4 +- ...computervision.models.CelebritiesModel.yml | 6 +- ...vision.computervision.models.ColorInfo.yml | 10 +-- ...putervision.models.ComputerVisionError.yml | 2 +- ...ervision.models.ComputerVisionOcrError.yml | 2 +- ...ion.computervision.models.DetectResult.yml | 6 +- ...n.computervision.models.DetectedObject.yml | 6 +- ...mputervision.models.DomainModelResults.yml | 8 +-- ....computervision.models.FaceDescription.yml | 6 +- ...on.computervision.models.FaceRectangle.yml | 8 +-- ...on.computervision.models.ImageAnalysis.yml | 24 +++---- ...ion.computervision.models.ImageCaption.yml | 4 +- ...computervision.models.ImageDescription.yml | 10 +-- ...rvision.models.ImageDescriptionDetails.yml | 4 +- ...on.computervision.models.ImageMetadata.yml | 6 +- ....vision.computervision.models.ImageTag.yml | 6 +- ...vision.computervision.models.ImageType.yml | 4 +- ...n.computervision.models.LandmarksModel.yml | 4 +- ...ices.vision.computervision.models.Line.yml | 4 +- ...computervision.models.ModelDescription.yml | 4 +- ....computervision.models.ObjectHierarchy.yml | 6 +- ...s.vision.computervision.models.OcrLine.yml | 4 +- ...vision.computervision.models.OcrRegion.yml | 4 +- ...vision.computervision.models.OcrResult.yml | 10 +-- ...s.vision.computervision.models.OcrWord.yml | 4 +- ...putervision.models.ReadOperationResult.yml | 8 +-- ...ision.computervision.models.ReadResult.yml | 2 +- ...vision.computervision.models.TagResult.yml | 8 +-- ...ision.contentmoderator.models.APIError.yml | 2 +- ...vision.contentmoderator.models.Address.yml | 4 +- ...es.vision.contentmoderator.models.Body.yml | 6 +- ...sion.contentmoderator.models.BodyModel.yml | 2 +- ...sion.contentmoderator.models.Candidate.yml | 4 +- ...contentmoderator.models.Classification.yml | 8 +-- ...derator.models.ClassificationCategory1.yml | 2 +- ...derator.models.ClassificationCategory2.yml | 2 +- ...derator.models.ClassificationCategory3.yml | 2 +- ...tmoderator.models.CreateReviewBodyItem.yml | 4 +- ...ator.models.CreateVideoReviewsBodyItem.yml | 8 +-- ...ateVideoReviewsBodyItemVideoFramesItem.yml | 4 +- ...ntentmoderator.models.DetectedLanguage.yml | 6 +- ....contentmoderator.models.DetectedTerms.yml | 8 +-- ...s.vision.contentmoderator.models.Email.yml | 8 +-- ...s.vision.contentmoderator.models.Error.yml | 4 +- ...ision.contentmoderator.models.Evaluate.yml | 18 ++--- ...es.vision.contentmoderator.models.Face.yml | 8 +-- ...ion.contentmoderator.models.FoundFaces.yml | 14 ++-- ...s.vision.contentmoderator.models.Frame.yml | 8 +-- ....vision.contentmoderator.models.Frames.yml | 4 +- ...ces.vision.contentmoderator.models.IPA.yml | 6 +- ...s.vision.contentmoderator.models.Image.yml | 8 +-- ...derator.models.ImageAdditionalInfoItem.yml | 4 +- ...ision.contentmoderator.models.ImageIds.yml | 8 +-- ...sion.contentmoderator.models.ImageList.yml | 8 +-- ...ces.vision.contentmoderator.models.Job.yml | 18 ++--- ...rator.models.JobExecutionReportDetails.yml | 4 +- ...s.vision.contentmoderator.models.JobId.yml | 2 +- ....contentmoderator.models.JobListResult.yml | 2 +- ...n.contentmoderator.models.KeyValuePair.yml | 4 +- ...s.vision.contentmoderator.models.Match.yml | 10 +-- ....contentmoderator.models.MatchResponse.yml | 10 +-- ...ces.vision.contentmoderator.models.OCR.yml | 14 ++-- ...ces.vision.contentmoderator.models.PII.yml | 10 +-- ...s.vision.contentmoderator.models.Phone.yml | 6 +- ...n.contentmoderator.models.RefreshIndex.yml | 10 +-- ....vision.contentmoderator.models.Review.yml | 20 +++--- ...ces.vision.contentmoderator.models.SSN.yml | 4 +- ....vision.contentmoderator.models.Screen.yml | 20 +++--- ....vision.contentmoderator.models.Status.yml | 6 +- ...ces.vision.contentmoderator.models.Tag.yml | 4 +- ...ision.contentmoderator.models.TermList.yml | 8 +-- ...s.vision.contentmoderator.models.Terms.yml | 4 +- ...sion.contentmoderator.models.TermsData.yml | 8 +-- ...on.contentmoderator.models.TermsInList.yml | 2 +- ...on.contentmoderator.models.TermsPaging.yml | 8 +-- ...entmoderator.models.VideoFrameBodyItem.yml | 4 +- ...n.training.models.CreateProjectOptions.yml | 4 +- ...n.training.models.ImageFileCreateBatch.yml | 6 +- ...n.training.models.ImageFileCreateEntry.yml | 8 +-- ...ion.training.models.ImageIdCreateBatch.yml | 6 +- ...ion.training.models.ImageIdCreateEntry.yml | 6 +- ...aining.models.ImageMetadataUpdateEntry.yml | 6 +- ...raining.models.ImageProcessingSettings.yml | 2 +- ...training.models.ImageRegionCreateBatch.yml | 2 +- ...aining.models.ImageRegionCreateSummary.yml | 6 +- ...on.training.models.ImageTagCreateBatch.yml | 2 +- ...on.training.models.ImageTagCreateEntry.yml | 4 +- ....training.models.ImageTagCreateSummary.yml | 6 +- ...on.training.models.ImageUrlCreateBatch.yml | 6 +- ...on.training.models.ImageUrlCreateEntry.yml | 4 +- ...ision.training.models.ModelInformation.yml | 2 +- ....training.models.PredictionQueryResult.yml | 2 +- ...ion.training.models.PredictionQueryTag.yml | 6 +- ...n.training.models.PredictionQueryToken.yml | 18 ++--- ...n.customvision.training.models.Project.yml | 2 +- ...vision.training.models.ProjectSettings.yml | 8 +-- ...ning.models.SuggestedTagAndRegionQuery.yml | 2 +- ...models.SuggestedTagAndRegionQueryToken.yml | 12 ++-- ...customvision.training.models.TagFilter.yml | 4 +- ...ion.training.models.TrainingParameters.yml | 4 +- ...veservices.vision.face.models.APIError.yml | 2 +- ...eservices.vision.face.models.Accessory.yml | 4 +- ...nitiveservices.vision.face.models.Blur.yml | 4 +- ...rvices.vision.face.models.DetectedFace.yml | 6 +- ...iveservices.vision.face.models.Emotion.yml | 16 ++--- ...itiveservices.vision.face.models.Error.yml | 4 +- ...veservices.vision.face.models.Exposure.yml | 4 +- ...ices.vision.face.models.FaceAttributes.yml | 32 ++++----- ...vices.vision.face.models.FaceLandmarks.yml | 54 +++++++-------- ...veservices.vision.face.models.FaceList.yml | 4 +- ...services.vision.face.models.FacialHair.yml | 6 +- ....vision.face.models.FindSimilarRequest.yml | 6 +- ...ervices.vision.face.models.GroupResult.yml | 2 +- ...nitiveservices.vision.face.models.Hair.yml | 6 +- ...eservices.vision.face.models.HairColor.yml | 4 +- ...veservices.vision.face.models.HeadPose.yml | 6 +- ...ces.vision.face.models.IdentifyRequest.yml | 6 +- ...vices.vision.face.models.LargeFaceList.yml | 2 +- ...es.vision.face.models.LargePersonGroup.yml | 2 +- ...tiveservices.vision.face.models.Makeup.yml | 4 +- ...nitiveservices.vision.face.models.Mask.yml | 4 +- ...es.vision.face.models.MetaDataContract.yml | 2 +- ...on.face.models.NameAndUserDataContract.yml | 4 +- ...itiveservices.vision.face.models.Noise.yml | 4 +- ...eservices.vision.face.models.Occlusion.yml | 6 +- ...ces.vision.face.models.OperationStatus.yml | 6 +- ...vices.vision.face.models.PersistedFace.yml | 2 +- ...tiveservices.vision.face.models.Person.yml | 6 +- ...ervices.vision.face.models.PersonGroup.yml | 2 +- ...ervices.vision.face.models.SimilarFace.yml | 4 +- ...veservices.vision.face.models.Snapshot.yml | 2 +- ...vision.face.models.TakeSnapshotRequest.yml | 2 +- ...ices.vision.face.models.TrainingStatus.yml | 6 +- ...s.vision.face.models.UpdateFaceRequest.yml | 2 +- ...sion.face.models.UpdateSnapshotRequest.yml | 4 +- ....face.models.VerifyFaceToPersonRequest.yml | 4 +- ...traversal.aio.CommunicationRelayClient.yml | 7 ++ ...talake.store.lib.DatalakeRESTInterface.yml | 12 ++-- .../azure.datalake.store.transfer.Chunk.yml | 2 - .../azure.datalake.store.transfer.File.yml | 2 - .../azure.graphrbac.models.ADGroup.yml | 12 ++-- ...re.graphrbac.models.AddOwnerParameters.yml | 2 +- .../azure.graphrbac.models.AppRole.yml | 12 ++-- ...re.graphrbac.models.Application(class).yml | 66 +++++++++---------- ...azure.graphrbac.models.ApplicationBase.yml | 58 ++++++++-------- ...bac.models.ApplicationCreateParameters.yml | 60 ++++++++--------- ...bac.models.ApplicationUpdateParameters.yml | 62 ++++++++--------- ....models.CheckGroupMembershipParameters.yml | 2 +- ...rbac.models.CheckGroupMembershipResult.yml | 4 +- ...azure.graphrbac.models.DirectoryObject.yml | 2 +- .../azure.graphrbac.models.Domain(class).yml | 2 +- ....graphrbac.models.GetObjectsParameters.yml | 8 +-- .../azure.graphrbac.models.GraphError.yml | 4 +- ...phrbac.models.GroupAddMemberParameters.yml | 2 +- ...graphrbac.models.GroupCreateParameters.yml | 2 +- ....models.GroupGetMemberGroupsParameters.yml | 2 +- ...zure.graphrbac.models.InformationalUrl.yml | 8 +-- .../azure.graphrbac.models.KeyCredential.yml | 16 ++--- ...zure.graphrbac.models.OAuth2Permission.yml | 16 ++--- ...graphrbac.models.OAuth2PermissionGrant.yml | 18 ++--- .../azure.graphrbac.models.OptionalClaim.yml | 8 +-- .../azure.graphrbac.models.OptionalClaims.yml | 6 +- ...re.graphrbac.models.PasswordCredential.yml | 12 ++-- ...azure.graphrbac.models.PasswordProfile.yml | 4 +- ...phrbac.models.PreAuthorizedApplication.yml | 6 +- ...dels.PreAuthorizedApplicationExtension.yml | 2 +- ...els.PreAuthorizedApplicationPermission.yml | 4 +- ...raphrbac.models.RequiredResourceAccess.yml | 4 +- .../azure.graphrbac.models.ResourceAccess.yml | 4 +- ...zure.graphrbac.models.ServicePrincipal.yml | 38 +++++------ ....graphrbac.models.ServicePrincipalBase.yml | 12 ++-- ...odels.ServicePrincipalCreateParameters.yml | 12 ++-- ...ac.models.ServicePrincipalObjectResult.yml | 4 +- ...odels.ServicePrincipalUpdateParameters.yml | 12 ++-- .../azure.graphrbac.models.SignInName.yml | 6 +- .../azure.graphrbac.models.User(class).yml | 24 +++---- .../azure.graphrbac.models.UserBase.yml | 12 ++-- ....graphrbac.models.UserCreateParameters.yml | 14 ++-- ...c.models.UserGetMemberGroupsParameters.yml | 2 +- ....graphrbac.models.UserUpdateParameters.yml | 22 +++---- ....graphrbac.models.ad_group_py3.ADGroup.yml | 12 ++-- ...wner_parameters_py3.AddOwnerParameters.yml | 2 +- ....graphrbac.models.app_role_py3.AppRole.yml | 12 ++-- ...s.application_base_py3.ApplicationBase.yml | 58 ++++++++-------- ...meters_py3.ApplicationCreateParameters.yml | 60 ++++++++--------- ...bac.models.application_py3.Application.yml | 66 +++++++++---------- ...meters_py3.ApplicationUpdateParameters.yml | 62 ++++++++--------- ...ers_py3.CheckGroupMembershipParameters.yml | 2 +- ..._result_py3.CheckGroupMembershipResult.yml | 4 +- ...s.directory_object_py3.DirectoryObject.yml | 2 +- ...ure.graphrbac.models.domain_py3.Domain.yml | 2 +- ...ts_parameters_py3.GetObjectsParameters.yml | 8 +-- ...rbac.models.graph_error_py3.GraphError.yml | 4 +- ...arameters_py3.GroupAddMemberParameters.yml | 2 +- ...e_parameters_py3.GroupCreateParameters.yml | 2 +- ...ers_py3.GroupGetMemberGroupsParameters.yml | 2 +- ...informational_url_py3.InformationalUrl.yml | 8 +-- ...odels.key_credential_py3.KeyCredential.yml | 16 ++--- ...ission_grant_py3.OAuth2PermissionGrant.yml | 18 ++--- ...oauth2_permission_py3.OAuth2Permission.yml | 16 ++--- ...odels.optional_claim_py3.OptionalClaim.yml | 8 +-- ...els.optional_claims_py3.OptionalClaims.yml | 6 +- ...word_credential_py3.PasswordCredential.yml | 12 ++-- ...s.password_profile_py3.PasswordProfile.yml | 4 +- ..._py3.PreAuthorizedApplicationExtension.yml | 2 +- ...py3.PreAuthorizedApplicationPermission.yml | 4 +- ...plication_py3.PreAuthorizedApplication.yml | 6 +- ...urce_access_py3.RequiredResourceAccess.yml | 4 +- ...els.resource_access_py3.ResourceAccess.yml | 4 +- ...rincipal_base_py3.ServicePrincipalBase.yml | 12 ++-- ...s_py3.ServicePrincipalCreateParameters.yml | 12 ++-- ...esult_py3.ServicePrincipalObjectResult.yml | 4 +- ...service_principal_py3.ServicePrincipal.yml | 38 +++++------ ...s_py3.ServicePrincipalUpdateParameters.yml | 12 ++-- ...bac.models.sign_in_name_py3.SignInName.yml | 6 +- ...raphrbac.models.user_base_py3.UserBase.yml | 12 ++-- ...te_parameters_py3.UserCreateParameters.yml | 14 ++-- ...ters_py3.UserGetMemberGroupsParameters.yml | 2 +- .../azure.graphrbac.models.user_py3.User.yml | 24 +++---- ...te_parameters_py3.UserUpdateParameters.yml | 22 +++---- .../azure.keyvault.AccessToken.yml | 2 - ...t.key_vault_authentication.AccessToken.yml | 2 - ...vault.v2016_10_01.models.Action(class).yml | 2 +- ...2016_10_01.models.AdministratorDetails.yml | 8 +-- ...t.v2016_10_01.models.Attributes(class).yml | 6 +- ...016_10_01.models.CertificateAttributes.yml | 6 +- ...t.v2016_10_01.models.CertificateBundle.yml | 8 +-- ..._01.models.CertificateCreateParameters.yml | 6 +- ..._01.models.CertificateImportParameters.yml | 8 +-- ...016_10_01.models.CertificateIssuerItem.yml | 4 +- ....models.CertificateIssuerSetParameters.yml | 6 +- ...dels.CertificateIssuerUpdateParameters.yml | 8 +-- ...ult.v2016_10_01.models.CertificateItem.yml | 8 +-- ...0_01.models.CertificateMergeParameters.yml | 4 +- ...2016_10_01.models.CertificateOperation.yml | 16 ++--- ...t.v2016_10_01.models.CertificatePolicy.yml | 12 ++-- ..._01.models.CertificateUpdateParameters.yml | 6 +- ...ault.v2016_10_01.models.Contact(class).yml | 6 +- ...ult.v2016_10_01.models.Contacts(class).yml | 2 +- ..._10_01.models.DeletedCertificateBundle.yml | 10 +-- ...16_10_01.models.DeletedCertificateItem.yml | 10 +-- ...lt.v2016_10_01.models.DeletedKeyBundle.yml | 8 +-- ...ault.v2016_10_01.models.DeletedKeyItem.yml | 8 +-- ...v2016_10_01.models.DeletedSecretBundle.yml | 12 ++-- ...t.v2016_10_01.models.DeletedSecretItem.yml | 10 +-- ...lt.v2016_10_01.models.IssuerAttributes.yml | 2 +- ...yvault.v2016_10_01.models.IssuerBundle.yml | 8 +-- ...t.v2016_10_01.models.IssuerCredentials.yml | 4 +- ...lt.v2016_10_01.models.IssuerParameters.yml | 4 +- ...keyvault.v2016_10_01.models.JsonWebKey.yml | 32 ++++----- ...vault.v2016_10_01.models.KeyAttributes.yml | 6 +- ....keyvault.v2016_10_01.models.KeyBundle.yml | 6 +- ...v2016_10_01.models.KeyCreateParameters.yml | 10 +-- ...v2016_10_01.models.KeyImportParameters.yml | 6 +- ...re.keyvault.v2016_10_01.models.KeyItem.yml | 6 +- ...vault.v2016_10_01.models.KeyProperties.yml | 8 +-- ...v2016_10_01.models.KeyUpdateParameters.yml | 6 +- ...ault.v2016_10_01.models.LifetimeAction.yml | 4 +- ...v2016_10_01.models.OrganizationDetails.yml | 4 +- ...6_10_01.models.SasDefinitionAttributes.yml | 2 +- ...1.models.SasDefinitionCreateParameters.yml | 4 +- ...1.models.SasDefinitionUpdateParameters.yml | 6 +- ...lt.v2016_10_01.models.SecretAttributes.yml | 6 +- ...yvault.v2016_10_01.models.SecretBundle.yml | 10 +-- ...keyvault.v2016_10_01.models.SecretItem.yml | 8 +-- ...lt.v2016_10_01.models.SecretProperties.yml | 2 +- ...v2016_10_01.models.SecretSetParameters.yml | 6 +- ...16_10_01.models.SecretUpdateParameters.yml | 6 +- ..._10_01.models.StorageAccountAttributes.yml | 2 +- ....models.StorageAccountCreateParameters.yml | 6 +- ....models.StorageAccountUpdateParameters.yml | 10 +-- ...6_10_01.models.SubjectAlternativeNames.yml | 6 +- ...ault.v2016_10_01.models.Trigger(class).yml | 4 +- ...10_01.models.X509CertificateProperties.yml | 10 +-- ...t.v2016_10_01.models.action_py3.Action.yml | 2 +- ...rator_details_py3.AdministratorDetails.yml | 8 +-- ...10_01.models.attributes_py3.Attributes.yml | 6 +- ...e_attributes_py3.CertificateAttributes.yml | 6 +- ...rtificate_bundle_py3.CertificateBundle.yml | 8 +-- ...meters_py3.CertificateCreateParameters.yml | 6 +- ...meters_py3.CertificateImportParameters.yml | 8 +-- ..._issuer_item_py3.CertificateIssuerItem.yml | 4 +- ...ers_py3.CertificateIssuerSetParameters.yml | 6 +- ..._py3.CertificateIssuerUpdateParameters.yml | 8 +-- ...s.certificate_item_py3.CertificateItem.yml | 8 +-- ...ameters_py3.CertificateMergeParameters.yml | 4 +- ...ate_operation_py3.CertificateOperation.yml | 16 ++--- ...rtificate_policy_py3.CertificatePolicy.yml | 12 ++-- ...meters_py3.CertificateUpdateParameters.yml | 6 +- ...v2016_10_01.models.contact_py3.Contact.yml | 6 +- ...016_10_01.models.contacts_py3.Contacts.yml | 2 +- ...te_bundle_py3.DeletedCertificateBundle.yml | 10 +-- ...ficate_item_py3.DeletedCertificateItem.yml | 10 +-- ...eleted_key_bundle_py3.DeletedKeyBundle.yml | 8 +-- ...ls.deleted_key_item_py3.DeletedKeyItem.yml | 8 +-- ..._secret_bundle_py3.DeletedSecretBundle.yml | 12 ++-- ...eted_secret_item_py3.DeletedSecretItem.yml | 10 +-- ...issuer_attributes_py3.IssuerAttributes.yml | 2 +- ....models.issuer_bundle_py3.IssuerBundle.yml | 8 +-- ...suer_credentials_py3.IssuerCredentials.yml | 4 +- ...issuer_parameters_py3.IssuerParameters.yml | 4 +- ..._01.models.json_web_key_py3.JsonWebKey.yml | 32 ++++----- ...odels.key_attributes_py3.KeyAttributes.yml | 6 +- ..._10_01.models.key_bundle_py3.KeyBundle.yml | 6 +- ...ate_parameters_py3.KeyCreateParameters.yml | 10 +-- ...ort_parameters_py3.KeyImportParameters.yml | 6 +- ...2016_10_01.models.key_item_py3.KeyItem.yml | 6 +- ...odels.key_properties_py3.KeyProperties.yml | 8 +-- ...ate_parameters_py3.KeyUpdateParameters.yml | 6 +- ...els.lifetime_action_py3.LifetimeAction.yml | 4 +- ...zation_details_py3.OrganizationDetails.yml | 4 +- ...attributes_py3.SasDefinitionAttributes.yml | 2 +- ...ters_py3.SasDefinitionCreateParameters.yml | 4 +- ...ters_py3.SasDefinitionUpdateParameters.yml | 6 +- ...secret_attributes_py3.SecretAttributes.yml | 6 +- ....models.secret_bundle_py3.SecretBundle.yml | 10 +-- ...0_01.models.secret_item_py3.SecretItem.yml | 8 +-- ...secret_properties_py3.SecretProperties.yml | 2 +- ...set_parameters_py3.SecretSetParameters.yml | 6 +- ..._parameters_py3.SecretUpdateParameters.yml | 6 +- ...ttributes_py3.StorageAccountAttributes.yml | 2 +- ...ers_py3.StorageAccountCreateParameters.yml | 6 +- ...ers_py3.StorageAccountUpdateParameters.yml | 10 +-- ...tive_names_py3.SubjectAlternativeNames.yml | 6 +- ...v2016_10_01.models.trigger_py3.Trigger.yml | 4 +- ...operties_py3.X509CertificateProperties.yml | 10 +-- ...ure.keyvault.v7_0.models.Action(class).yml | 2 +- ...vault.v7_0.models.AdministratorDetails.yml | 8 +-- ...keyvault.v7_0.models.Attributes(class).yml | 6 +- ...ault.v7_0.models.CertificateAttributes.yml | 6 +- ...keyvault.v7_0.models.CertificateBundle.yml | 8 +-- ...7_0.models.CertificateCreateParameters.yml | 6 +- ...7_0.models.CertificateImportParameters.yml | 8 +-- ...ault.v7_0.models.CertificateIssuerItem.yml | 4 +- ....models.CertificateIssuerSetParameters.yml | 6 +- ...dels.CertificateIssuerUpdateParameters.yml | 8 +-- ...e.keyvault.v7_0.models.CertificateItem.yml | 8 +-- ...v7_0.models.CertificateMergeParameters.yml | 4 +- ...vault.v7_0.models.CertificateOperation.yml | 16 ++--- ...keyvault.v7_0.models.CertificatePolicy.yml | 12 ++-- ...7_0.models.CertificateUpdateParameters.yml | 6 +- ...re.keyvault.v7_0.models.Contact(class).yml | 6 +- ...e.keyvault.v7_0.models.Contacts(class).yml | 2 +- ...t.v7_0.models.DeletedCertificateBundle.yml | 10 +-- ...ult.v7_0.models.DeletedCertificateItem.yml | 10 +-- ....keyvault.v7_0.models.DeletedKeyBundle.yml | 8 +-- ...re.keyvault.v7_0.models.DeletedKeyItem.yml | 8 +-- ...v7_0.models.DeletedSasDefinitionBundle.yml | 2 +- ...t.v7_0.models.DeletedSasDefinitionItem.yml | 2 +- ...yvault.v7_0.models.DeletedSecretBundle.yml | 12 ++-- ...keyvault.v7_0.models.DeletedSecretItem.yml | 10 +-- ....v7_0.models.DeletedStorageAccountItem.yml | 2 +- ...vault.v7_0.models.DeletedStorageBundle.yml | 2 +- ....keyvault.v7_0.models.IssuerAttributes.yml | 2 +- ...zure.keyvault.v7_0.models.IssuerBundle.yml | 8 +-- ...keyvault.v7_0.models.IssuerCredentials.yml | 4 +- ....keyvault.v7_0.models.IssuerParameters.yml | 6 +- .../azure.keyvault.v7_0.models.JsonWebKey.yml | 32 ++++----- ...ure.keyvault.v7_0.models.KeyAttributes.yml | 6 +- .../azure.keyvault.v7_0.models.KeyBundle.yml | 6 +- ...yvault.v7_0.models.KeyCreateParameters.yml | 10 +-- ...yvault.v7_0.models.KeyImportParameters.yml | 6 +- .../azure.keyvault.v7_0.models.KeyItem.yml | 6 +- ...ure.keyvault.v7_0.models.KeyProperties.yml | 10 +-- ...yvault.v7_0.models.KeyUpdateParameters.yml | 6 +- ...re.keyvault.v7_0.models.LifetimeAction.yml | 4 +- ...yvault.v7_0.models.OrganizationDetails.yml | 4 +- ...lt.v7_0.models.SasDefinitionAttributes.yml | 2 +- ...0.models.SasDefinitionCreateParameters.yml | 4 +- ...0.models.SasDefinitionUpdateParameters.yml | 10 +-- ....keyvault.v7_0.models.SecretAttributes.yml | 6 +- ...zure.keyvault.v7_0.models.SecretBundle.yml | 10 +-- .../azure.keyvault.v7_0.models.SecretItem.yml | 8 +-- ....keyvault.v7_0.models.SecretProperties.yml | 2 +- ...yvault.v7_0.models.SecretSetParameters.yml | 6 +- ...ult.v7_0.models.SecretUpdateParameters.yml | 6 +- ...t.v7_0.models.StorageAccountAttributes.yml | 2 +- ....models.StorageAccountCreateParameters.yml | 6 +- ....models.StorageAccountUpdateParameters.yml | 10 +-- ...lt.v7_0.models.SubjectAlternativeNames.yml | 6 +- ...re.keyvault.v7_0.models.Trigger(class).yml | 4 +- ....v7_0.models.X509CertificateProperties.yml | 10 +-- ...keyvault.v7_0.models.action_py3.Action.yml | 2 +- ...rator_details_py3.AdministratorDetails.yml | 8 +-- ....v7_0.models.attributes_py3.Attributes.yml | 6 +- ...e_attributes_py3.CertificateAttributes.yml | 6 +- ...rtificate_bundle_py3.CertificateBundle.yml | 8 +-- ...meters_py3.CertificateCreateParameters.yml | 6 +- ...meters_py3.CertificateImportParameters.yml | 8 +-- ..._issuer_item_py3.CertificateIssuerItem.yml | 4 +- ...ers_py3.CertificateIssuerSetParameters.yml | 6 +- ..._py3.CertificateIssuerUpdateParameters.yml | 8 +-- ...s.certificate_item_py3.CertificateItem.yml | 8 +-- ...ameters_py3.CertificateMergeParameters.yml | 4 +- ...ate_operation_py3.CertificateOperation.yml | 16 ++--- ...rtificate_policy_py3.CertificatePolicy.yml | 12 ++-- ...meters_py3.CertificateUpdateParameters.yml | 6 +- ...yvault.v7_0.models.contact_py3.Contact.yml | 6 +- ...ault.v7_0.models.contacts_py3.Contacts.yml | 2 +- ...te_bundle_py3.DeletedCertificateBundle.yml | 10 +-- ...ficate_item_py3.DeletedCertificateItem.yml | 10 +-- ...eleted_key_bundle_py3.DeletedKeyBundle.yml | 8 +-- ...ls.deleted_key_item_py3.DeletedKeyItem.yml | 8 +-- ..._bundle_py3.DeletedSasDefinitionBundle.yml | 2 +- ...tion_item_py3.DeletedSasDefinitionItem.yml | 2 +- ..._secret_bundle_py3.DeletedSecretBundle.yml | 12 ++-- ...eted_secret_item_py3.DeletedSecretItem.yml | 10 +-- ...unt_item_py3.DeletedStorageAccountItem.yml | 2 +- ...torage_bundle_py3.DeletedStorageBundle.yml | 2 +- ...issuer_attributes_py3.IssuerAttributes.yml | 2 +- ....models.issuer_bundle_py3.IssuerBundle.yml | 8 +-- ...suer_credentials_py3.IssuerCredentials.yml | 4 +- ...issuer_parameters_py3.IssuerParameters.yml | 6 +- ...7_0.models.json_web_key_py3.JsonWebKey.yml | 32 ++++----- ...odels.key_attributes_py3.KeyAttributes.yml | 6 +- ...t.v7_0.models.key_bundle_py3.KeyBundle.yml | 6 +- ...ate_parameters_py3.KeyCreateParameters.yml | 10 +-- ...ort_parameters_py3.KeyImportParameters.yml | 6 +- ...vault.v7_0.models.key_item_py3.KeyItem.yml | 6 +- ...odels.key_properties_py3.KeyProperties.yml | 10 +-- ...ate_parameters_py3.KeyUpdateParameters.yml | 6 +- ...els.lifetime_action_py3.LifetimeAction.yml | 4 +- ...zation_details_py3.OrganizationDetails.yml | 4 +- ...attributes_py3.SasDefinitionAttributes.yml | 2 +- ...ters_py3.SasDefinitionCreateParameters.yml | 4 +- ...ters_py3.SasDefinitionUpdateParameters.yml | 10 +-- ...secret_attributes_py3.SecretAttributes.yml | 6 +- ....models.secret_bundle_py3.SecretBundle.yml | 10 +-- ...v7_0.models.secret_item_py3.SecretItem.yml | 8 +-- ...secret_properties_py3.SecretProperties.yml | 2 +- ...set_parameters_py3.SecretSetParameters.yml | 6 +- ..._parameters_py3.SecretUpdateParameters.yml | 6 +- ...ttributes_py3.StorageAccountAttributes.yml | 2 +- ...ers_py3.StorageAccountCreateParameters.yml | 6 +- ...ers_py3.StorageAccountUpdateParameters.yml | 10 +-- ...tive_names_py3.SubjectAlternativeNames.yml | 6 +- ...yvault.v7_0.models.trigger_py3.Trigger.yml | 4 +- ...operties_py3.X509CertificateProperties.yml | 10 +-- ...zure.loganalytics.models.Column(class).yml | 4 +- .../azure.loganalytics.models.ErrorDetail.yml | 8 +-- .../azure.loganalytics.models.ErrorInfo.yml | 6 +- .../azure.loganalytics.models.QueryBody.yml | 4 +- ....loganalytics.models.column_py3.Column.yml | 4 +- ...cs.models.error_detail_py3.ErrorDetail.yml | 8 +-- ...lytics.models.error_info_py3.ErrorInfo.yml | 6 +- ...lytics.models.query_body_py3.QueryBody.yml | 4 +- ...redge.CognitiveServicesVisionProcessor.yml | 2 + ...ideoanalyzeredge.DiscoveredOnvifDevice.yml | 4 ++ ...eredge.DiscoveredOnvifDeviceCollection.yml | 1 + ...e.media.videoanalyzeredge.EndpointBase.yml | 1 + ...deoanalyzeredge.ExtensionProcessorBase.yml | 1 + ....media.videoanalyzeredge.GrpcExtension.yml | 2 + ...analyzeredge.GrpcExtensionDataTransfer.yml | 1 + ...ia.videoanalyzeredge.H264Configuration.yml | 2 + ....media.videoanalyzeredge.HttpExtension.yml | 1 + ...edia.videoanalyzeredge.ImageFormatJpeg.yml | 1 + ...edia.videoanalyzeredge.ImageProperties.yml | 2 + ...ure.media.videoanalyzeredge.ImageScale.yml | 3 + ...deoanalyzeredge.IotHubDeviceConnection.yml | 1 + ....videoanalyzeredge.IotHubMessageSource.yml | 1 + ...e.media.videoanalyzeredge.LivePipeline.yml | 2 + ...deoanalyzeredge.LivePipelineCollection.yml | 2 + ...deoanalyzeredge.LivePipelineProperties.yml | 4 ++ ...nalyzeredge.LivePipelineSetRequestBody.yml | 2 + ...a.videoanalyzeredge.MPEG4Configuration.yml | 2 + ...e.media.videoanalyzeredge.MediaProfile.yml | 3 + ...azure.media.videoanalyzeredge.MediaUri.yml | 1 + ...oanalyzeredge.MotionDetectionProcessor.yml | 3 + ...zure.media.videoanalyzeredge.NodeInput.yml | 1 + ...eoanalyzeredge.ObjectTrackingProcessor.yml | 1 + ...re.media.videoanalyzeredge.OnvifDevice.yml | 4 ++ ...nalyzeredge.OnvifDeviceDiscoverRequest.yml | 1 + ...azure.media.videoanalyzeredge.OnvifDns.yml | 3 + ....media.videoanalyzeredge.OnvifHostName.yml | 2 + ....videoanalyzeredge.OnvifSystemDateTime.yml | 3 + ...media.videoanalyzeredge.OutputSelector.yml | 3 + ...videoanalyzeredge.ParameterDeclaration.yml | 2 + ....videoanalyzeredge.ParameterDefinition.yml | 1 + ...dia.videoanalyzeredge.PipelineTopology.yml | 2 + ...nalyzeredge.PipelineTopologyCollection.yml | 2 + ...nalyzeredge.PipelineTopologyProperties.yml | 5 ++ ...zeredge.PipelineTopologySetRequestBody.yml | 2 + ...re.media.videoanalyzeredge.RateControl.yml | 4 ++ ....videoanalyzeredge.RemoteDeviceAdapter.yml | 2 + ...yzeredge.RemoteDeviceAdapterCollection.yml | 2 + ...yzeredge.RemoteDeviceAdapterProperties.yml | 1 + ...edge.RemoteDeviceAdapterSetRequestBody.yml | 2 + ...ure.media.videoanalyzeredge.RtspSource.yml | 1 + ...edia.videoanalyzeredge.SamplingOptions.yml | 2 + ....videoanalyzeredge.SignalGateProcessor.yml | 4 ++ ...edge.SpatialAnalysisOperationEventBase.yml | 2 + ...eredge.SpatialAnalysisPersonCountEvent.yml | 4 ++ ...ge.SpatialAnalysisPersonCountOperation.yml | 7 ++ ...e.SpatialAnalysisPersonCountZoneEvents.yml | 1 + ...dge.SpatialAnalysisPersonDistanceEvent.yml | 6 ++ ...SpatialAnalysisPersonDistanceOperation.yml | 7 ++ ...patialAnalysisPersonDistanceZoneEvents.yml | 1 + ...SpatialAnalysisPersonLineCrossingEvent.yml | 2 + ...alAnalysisPersonLineCrossingLineEvents.yml | 1 + ...ialAnalysisPersonLineCrossingOperation.yml | 7 ++ ...SpatialAnalysisPersonZoneCrossingEvent.yml | 3 + ...ialAnalysisPersonZoneCrossingOperation.yml | 7 ++ ...alAnalysisPersonZoneCrossingZoneEvents.yml | 1 + ...edge.SpatialAnalysisTypedOperationBase.yml | 7 ++ ...ure.media.videoanalyzeredge.SystemData.yml | 2 + ...re.media.videoanalyzeredge.TlsEndpoint.yml | 3 + ...videoanalyzeredge.TlsValidationOptions.yml | 2 + ...ia.videoanalyzeredge.UnsecuredEndpoint.yml | 1 + ...eoanalyzeredge.VideoCreationProperties.yml | 4 ++ ...analyzeredge.VideoEncoderConfiguration.yml | 6 ++ ...deoanalyzeredge.VideoPublishingOptions.yml | 1 + ...edia.videoanalyzeredge.VideoResolution.yml | 2 + ...zure.media.videoanalyzeredge.VideoSink.yml | 2 + ...od.models.CheckNameAvailabilityRequest.yml | 4 +- ...d.models.CheckNameAvailabilityResponse.yml | 6 +- ...mgmt.agfood.models.DetailedInformation.yml | 10 +-- ...azure.mgmt.agfood.models.ErrorResponse.yml | 2 +- ...mt.agfood.models.ExtensionListResponse.yml | 2 +- .../azure.mgmt.agfood.models.FarmBeats.yml | 2 +- ....models.FarmBeatsExtensionListResponse.yml | 2 +- ...mt.agfood.models.FarmBeatsListResponse.yml | 2 +- ...ood.models.FarmBeatsUpdateRequestModel.yml | 4 +- .../azure.mgmt.agfood.models.Operation.yml | 2 +- .../azure.mgmt.agfood.models.SystemData.yml | 12 ++-- ...ure.mgmt.agfood.models.TrackedResource.yml | 2 +- ....aio.operations.CertificatesOperations.yml | 2 +- ...aio.operations.ContainerAppsOperations.yml | 2 +- ....app.models.AllowedAudiencesValidation.yml | 1 + ...zure.mgmt.app.models.AllowedPrincipals.yml | 2 + ...e.mgmt.app.models.AppLogsConfiguration.yml | 2 + .../azure.mgmt.app.models.AppRegistration.yml | 2 + .../azure.mgmt.app.models.Apple.yml | 3 + ...zure.mgmt.app.models.AppleRegistration.yml | 2 + .../azure.mgmt.app.models.AuthConfig.yml | 5 ++ .../azure.mgmt.app.models.AuthPlatform.yml | 2 + ...re.mgmt.app.models.AvailableOperations.yml | 2 + ...e.mgmt.app.models.AzureActiveDirectory.yml | 5 ++ ...t.app.models.AzureActiveDirectoryLogin.yml | 2 + ...odels.AzureActiveDirectoryRegistration.yml | 6 ++ ....models.AzureActiveDirectoryValidation.yml | 3 + ...azure.mgmt.app.models.AzureCredentials.yml | 4 ++ ...re.mgmt.app.models.AzureFileProperties.yml | 4 ++ ...ure.mgmt.app.models.AzureStaticWebApps.yml | 2 + ....models.AzureStaticWebAppsRegistration.yml | 1 + .../azure.mgmt.app.models.Certificate.yml | 2 + ...azure.mgmt.app.models.CertificatePatch.yml | 1 + ....mgmt.app.models.CertificateProperties.yml | 2 + ...ure.mgmt.app.models.ClientRegistration.yml | 2 + .../azure.mgmt.app.models.Configuration.yml | 5 ++ .../azure.mgmt.app.models.Container.yml | 8 +++ .../azure.mgmt.app.models.ContainerApp.yml | 5 ++ ...zure.mgmt.app.models.ContainerAppPatch.yml | 1 + ...zure.mgmt.app.models.ContainerAppProbe.yml | 9 +++ ...mt.app.models.ContainerAppProbeHttpGet.yml | 4 ++ ....app.models.ContainerAppProbeTcpSocket.yml | 1 + ...ure.mgmt.app.models.ContainerResources.yml | 2 + ...azure.mgmt.app.models.CookieExpiration.yml | 2 + .../azure.mgmt.app.models.CustomDomain.yml | 1 + ...pp.models.CustomHostnameAnalysisResult.yml | 5 ++ ...app.models.CustomOpenIdConnectProvider.yml | 3 + .../azure.mgmt.app.models.CustomScaleRule.yml | 3 + .../azure.mgmt.app.models.Dapr.yml | 4 ++ .../azure.mgmt.app.models.DaprComponent.yml | 7 ++ .../azure.mgmt.app.models.DaprMetadata.yml | 3 + ....app.models.DefaultAuthorizationPolicy.yml | 2 + ...t.app.models.DefaultErrorResponseError.yml | 1 + .../azure.mgmt.app.models.EnvironmentVar.yml | 3 + .../azure.mgmt.app.models.Facebook.yml | 4 ++ .../azure.mgmt.app.models.ForwardProxy.yml | 3 + .../azure.mgmt.app.models.GitHub.yml | 3 + ...t.app.models.GithubActionConfiguration.yml | 7 ++ ...azure.mgmt.app.models.GlobalValidation.yml | 3 + .../azure.mgmt.app.models.Google.yml | 4 ++ .../azure.mgmt.app.models.HttpScaleRule.yml | 2 + .../azure.mgmt.app.models.HttpSettings.yml | 3 + ...ure.mgmt.app.models.HttpSettingsRoutes.yml | 1 + ...zure.mgmt.app.models.IdentityProviders.yml | 8 +++ .../azure.mgmt.app.models.Ingress.yml | 6 ++ .../azure.mgmt.app.models.JwtClaimChecks.yml | 2 + ...t.app.models.LogAnalyticsConfiguration.yml | 2 + .../azure.mgmt.app.models.Login.yml | 5 ++ .../azure.mgmt.app.models.LoginRoutes.yml | 1 + .../azure.mgmt.app.models.LoginScopes.yml | 1 + ...ure.mgmt.app.models.ManagedEnvironment.yml | 4 ++ ...gmt.app.models.ManagedEnvironmentPatch.yml | 1 + ...t.app.models.ManagedEnvironmentStorage.yml | 1 + ...ls.ManagedEnvironmentStorageProperties.yml | 1 + ...mgmt.app.models.ManagedServiceIdentity.yml | 1 + .../azure.mgmt.app.models.Nonce.yml | 2 + ...p.models.OpenIdConnectClientCredential.yml | 2 + ...re.mgmt.app.models.OpenIdConnectConfig.yml | 5 ++ ...ure.mgmt.app.models.OpenIdConnectLogin.yml | 2 + ...t.app.models.OpenIdConnectRegistration.yml | 3 + .../azure.mgmt.app.models.OperationDetail.yml | 4 ++ ...azure.mgmt.app.models.OperationDisplay.yml | 4 ++ .../azure.mgmt.app.models.QueueScaleRule.yml | 3 + ...re.mgmt.app.models.RegistryCredentials.yml | 3 + .../azure.mgmt.app.models.RegistryInfo.yml | 3 + .../azure.mgmt.app.models.Replica.yml | 1 + ...azure.mgmt.app.models.ReplicaContainer.yml | 5 ++ .../azure.mgmt.app.models.Scale.yml | 3 + .../azure.mgmt.app.models.ScaleRule.yml | 4 ++ .../azure.mgmt.app.models.ScaleRuleAuth.yml | 2 + .../azure.mgmt.app.models.Secret.yml | 2 + .../azure.mgmt.app.models.SourceControl.yml | 3 + .../azure.mgmt.app.models.SystemData.yml | 6 ++ .../azure.mgmt.app.models.Template.yml | 4 ++ .../azure.mgmt.app.models.TrackedResource.yml | 1 + .../azure.mgmt.app.models.TrafficWeight.yml | 3 + .../azure.mgmt.app.models.Twitter.yml | 2 + ...re.mgmt.app.models.TwitterRegistration.yml | 2 + ...zure.mgmt.app.models.VnetConfiguration.yml | 6 ++ .../azure.mgmt.app.models.Volume.yml | 3 + .../azure.mgmt.app.models.VolumeMount.yml | 2 + ....app.operations.CertificatesOperations.yml | 2 +- ...app.operations.ContainerAppsOperations.yml | 2 +- ...01_preview.models.AsyncOperationStatus.yml | 18 ++--- ...eview.models.AsyncOperationStatusError.yml | 4 +- ...19_01_01_preview.models.B2CResourceSKU.yml | 2 +- ...01_01_preview.models.B2CTenantResource.yml | 6 +- ...CTenantResourcePropertiesBillingConfig.yml | 2 +- ..._preview.models.B2CTenantUpdateRequest.yml | 8 +-- ...preview.models.CreateTenantRequestBody.yml | 2 +- ...dels.CreateTenantRequestBodyProperties.yml | 4 +- ...review.models.NameAvailabilityResponse.yml | 6 +- ...c.v2019_01_01_preview.models.Operation.yml | 2 +- ..._01_01_preview.models.OperationDisplay.yml | 2 +- ..._01_preview.models.GuestUsagesResource.yml | 6 +- ...review.models.GuestUsagesResourcePatch.yml | 2 +- ...c.v2020_05_01_preview.models.Operation.yml | 2 +- ..._05_01_preview.models.OperationDisplay.yml | 2 +- ...perations.AzureLargeInstanceOperations.yml | 2 +- ...argeinstance.models.AzureLargeInstance.yml | 2 + ...ce.models.AzureLargeInstanceListResult.yml | 1 + ...ce.models.AzureLargeInstanceProperties.yml | 5 ++ ...ce.models.AzureLargeInstanceTagsUpdate.yml | 1 + ...tance.models.AzureLargeStorageInstance.yml | 2 + ...ls.AzureLargeStorageInstanceListResult.yml | 1 + ...ls.AzureLargeStorageInstanceProperties.yml | 2 + ...ls.AzureLargeStorageInstanceTagsUpdate.yml | 1 + ...re.mgmt.azurelargeinstance.models.Disk.yml | 2 + ...zurelargeinstance.models.ErrorResponse.yml | 1 + ...t.azurelargeinstance.models.ForceState.yml | 1 + ...mt.azurelargeinstance.models.IpAddress.yml | 1 + ...urelargeinstance.models.NetworkProfile.yml | 1 + ...mt.azurelargeinstance.models.Operation.yml | 1 + ...einstance.models.OperationStatusResult.yml | 7 ++ ...mt.azurelargeinstance.models.OsProfile.yml | 2 + ...stance.models.StorageBillingProperties.yml | 2 + ...urelargeinstance.models.StorageProfile.yml | 1 + ...largeinstance.models.StorageProperties.yml | 6 ++ ...t.azurelargeinstance.models.SystemData.yml | 6 ++ ...re.mgmt.azurelargeinstance.models.Tags.yml | 1 + ...relargeinstance.models.TrackedResource.yml | 1 + ...perations.AzureLargeInstanceOperations.yml | 2 +- ...mt.batchai.models.AppInsightsReference.yml | 4 +- ....mgmt.batchai.models.AutoScaleSettings.yml | 2 +- ...ai.models.AzureBlobFileSystemReference.yml | 2 +- ...hai.models.AzureStorageCredentialsInfo.yml | 4 +- ...azure.mgmt.batchai.models.CNTKsettings.yml | 12 ++-- ...ure.mgmt.batchai.models.Caffe2Settings.yml | 4 +- ...zure.mgmt.batchai.models.CaffeSettings.yml | 10 +-- ...re.mgmt.batchai.models.ChainerSettings.yml | 6 +- .../azure.mgmt.batchai.models.Cluster.yml | 14 ++-- ...batchai.models.ClusterCreateParameters.yml | 14 ++-- ...batchai.models.ClusterUpdateParameters.yml | 2 +- ....mgmt.batchai.models.ContainerSettings.yml | 2 +- ....mgmt.batchai.models.CustomMpiSettings.yml | 2 +- ...t.batchai.models.CustomToolkitSettings.yml | 2 +- ...els.EnvironmentVariableWithSecretValue.yml | 4 +- .../azure.mgmt.batchai.models.FileServer.yml | 8 +-- ...chai.models.FileServerCreateParameters.yml | 8 +-- ...mt.batchai.models.FileServerListResult.yml | 2 +- ...gmt.batchai.models.FileServerReference.yml | 4 +- ...re.mgmt.batchai.models.HorovodSettings.yml | 6 +- ...ure.mgmt.batchai.models.ImageReference.yml | 4 +- ...gmt.batchai.models.ImageSourceRegistry.yml | 4 +- .../azure.mgmt.batchai.models.Job.yml | 46 ++++++------- ...gmt.batchai.models.JobCreateParameters.yml | 42 ++++++------ ...zure.mgmt.batchai.models.MountSettings.yml | 6 +- ...azure.mgmt.batchai.models.MountVolumes.yml | 8 +-- ...zure.mgmt.batchai.models.NameValuePair.yml | 4 +- .../azure.mgmt.batchai.models.NodeSetup.yml | 6 +- .../azure.mgmt.batchai.models.Operation.yml | 4 +- ...re.mgmt.batchai.models.OutputDirectory.yml | 2 +- ...chai.models.PrivateRegistryCredentials.yml | 4 +- ...re.mgmt.batchai.models.PyTorchSettings.yml | 8 +-- ...zure.mgmt.batchai.models.ScaleSettings.yml | 4 +- .../azure.mgmt.batchai.models.SetupTask.yml | 4 +- ...e.mgmt.batchai.models.SshConfiguration.yml | 2 +- ...mgmt.batchai.models.TensorFlowSettings.yml | 12 ++-- ...gmt.batchai.models.UserAccountSettings.yml | 4 +- ...hai.models.VirtualMachineConfiguration.yml | 2 +- ...tchai.models.WorkspaceCreateParameters.yml | 2 +- ...tchai.models.WorkspaceUpdateParameters.yml | 2 +- ...mgmt.edgegateway.models.Address(class).yml | 4 +- ...teway.models.AsymmetricEncryptedSecret.yml | 2 +- ...gegateway.models.Authentication(class).yml | 2 +- ...t.edgegateway.models.DataBoxEdgeDevice.yml | 14 ++-- ...y.models.DataBoxEdgeDeviceExtendedInfo.yml | 4 +- ...egateway.models.DataBoxEdgeDevicePatch.yml | 2 +- ...mt.edgegateway.models.FileEventTrigger.yml | 2 +- ....mgmt.edgegateway.models.IoTDeviceInfo.yml | 2 +- .../azure.mgmt.edgegateway.models.IoTRole.yml | 2 +- ...ure.mgmt.edgegateway.models.Job(class).yml | 2 +- ...t.edgegateway.models.MetricDimensionV1.yml | 6 +- ...gegateway.models.MetricSpecificationV1.yml | 22 +++---- ...mgmt.edgegateway.models.NetworkAdapter.yml | 4 +- ...mt.edgegateway.models.Operation(class).yml | 8 +-- ...mt.edgegateway.models.OperationDisplay.yml | 8 +-- ...e.mgmt.edgegateway.models.Order(class).yml | 2 +- ...re.mgmt.edgegateway.models.OrderStatus.yml | 2 +- ...teway.models.PeriodicTimerEventTrigger.yml | 2 +- ...gateway.models.PeriodicTimerSourceInfo.yml | 2 +- ...mgmt.edgegateway.models.RefreshDetails.yml | 8 +-- ...dgegateway.models.ServiceSpecification.yml | 2 +- ...e.mgmt.edgegateway.models.Share(class).yml | 12 ++-- ...ure.mgmt.edgegateway.models.Sku(class).yml | 4 +- ...ateway.models.StorageAccountCredential.yml | 8 +-- ...e.mgmt.edgegateway.models.SymmetricKey.yml | 2 +- ...e.mgmt.edgegateway.models.TrackingInfo.yml | 8 +-- ....mgmt.edgegateway.models.UpdateSummary.yml | 8 +-- ...ateway.models.UploadCertificateRequest.yml | 2 +- ...teway.models.UploadCertificateResponse.yml | 2 +- ...re.mgmt.edgegateway.models.User(class).yml | 4 +- ...edgegateway.models.address_py3.Address.yml | 4 +- ...d_secret_py3.AsymmetricEncryptedSecret.yml | 2 +- ...dels.authentication_py3.Authentication.yml | 2 +- ...info_py3.DataBoxEdgeDeviceExtendedInfo.yml | 4 +- ...evice_patch_py3.DataBoxEdgeDevicePatch.yml | 2 +- ..._box_edge_device_py3.DataBoxEdgeDevice.yml | 14 ++-- ...ile_event_trigger_py3.FileEventTrigger.yml | 2 +- ...dels.io_tdevice_info_py3.IoTDeviceInfo.yml | 2 +- ...dgegateway.models.io_trole_py3.IoTRole.yml | 2 +- ...re.mgmt.edgegateway.models.job_py3.Job.yml | 2 +- ...ric_dimension_v1_py3.MetricDimensionV1.yml | 6 +- ...ification_v1_py3.MetricSpecificationV1.yml | 22 +++---- ...els.network_adapter_py3.NetworkAdapter.yml | 4 +- ...operation_display_py3.OperationDisplay.yml | 8 +-- ...gateway.models.operation_py3.Operation.yml | 8 +-- ...gmt.edgegateway.models.order_py3.Order.yml | 2 +- ...ay.models.order_status_py3.OrderStatus.yml | 2 +- ..._trigger_py3.PeriodicTimerEventTrigger.yml | 2 +- ...ource_info_py3.PeriodicTimerSourceInfo.yml | 2 +- ...els.refresh_details_py3.RefreshDetails.yml | 8 +-- ...specification_py3.ServiceSpecification.yml | 2 +- ...gmt.edgegateway.models.share_py3.Share.yml | 12 ++-- ...re.mgmt.edgegateway.models.sku_py3.Sku.yml | 4 +- ...redential_py3.StorageAccountCredential.yml | 8 +-- ....models.symmetric_key_py3.SymmetricKey.yml | 2 +- ....models.tracking_info_py3.TrackingInfo.yml | 8 +-- ...odels.update_summary_py3.UpdateSummary.yml | 8 +-- ...e_request_py3.UploadCertificateRequest.yml | 2 +- ...response_py3.UploadCertificateResponse.yml | 2 +- ....mgmt.edgegateway.models.user_py3.User.yml | 4 +- ....logz.aio.operations.MonitorOperations.yml | 2 +- ...logz.aio.operations.MonitorsOperations.yml | 6 +- ....aio.operations.SingleSignOnOperations.yml | 2 +- ...gz.aio.operations.SubAccountOperations.yml | 6 +- ...perations.SubAccountTagRulesOperations.yml | 2 +- ...logz.aio.operations.TagRulesOperations.yml | 2 +- .../azure.mgmt.logz.models.ErrorResponse.yml | 1 + .../azure.mgmt.logz.models.FilteringTag.yml | 3 + ...re.mgmt.logz.models.IdentityProperties.yml | 1 + .../azure.mgmt.logz.models.LogRules.yml | 4 ++ ...e.mgmt.logz.models.LogzMonitorResource.yml | 3 + ...models.LogzMonitorResourceListResponse.yml | 2 + ...ls.LogzMonitorResourceUpdateParameters.yml | 2 + ...logz.models.LogzOrganizationProperties.yml | 3 + ...logz.models.LogzSingleSignOnProperties.yml | 3 + ...t.logz.models.LogzSingleSignOnResource.yml | 1 + ...s.LogzSingleSignOnResourceListResponse.yml | 2 + ...ure.mgmt.logz.models.MonitorProperties.yml | 3 + ...ure.mgmt.logz.models.MonitoredResource.yml | 5 ++ ...z.models.MonitoredResourceListResponse.yml | 2 + ...re.mgmt.logz.models.MonitoringTagRules.yml | 1 + ....models.MonitoringTagRulesListResponse.yml | 2 + ...gz.models.MonitoringTagRulesProperties.yml | 1 + ...zure.mgmt.logz.models.OperationDisplay.yml | 4 ++ ...e.mgmt.logz.models.OperationListResult.yml | 2 + ...azure.mgmt.logz.models.OperationResult.yml | 4 ++ .../azure.mgmt.logz.models.PlanData.yml | 4 ++ .../azure.mgmt.logz.models.SystemData.yml | 6 ++ .../azure.mgmt.logz.models.UserInfo.yml | 4 ++ ....mgmt.logz.models.UserRoleListResponse.yml | 2 + ...azure.mgmt.logz.models.UserRoleRequest.yml | 1 + ...zure.mgmt.logz.models.UserRoleResponse.yml | 1 + ...re.mgmt.logz.models.VMExtensionPayload.yml | 2 + ...e.mgmt.logz.models.VMHostUpdateRequest.yml | 2 + .../azure.mgmt.logz.models.VMResources.yml | 2 + ...mt.logz.models.VMResourcesListResponse.yml | 2 + ...mgmt.logz.operations.MonitorOperations.yml | 2 +- ...gmt.logz.operations.MonitorsOperations.yml | 6 +- ...logz.operations.SingleSignOnOperations.yml | 2 +- ...t.logz.operations.SubAccountOperations.yml | 6 +- ...perations.SubAccountTagRulesOperations.yml | 2 +- ...gmt.logz.operations.TagRulesOperations.yml | 2 +- ...mt.networkanalytics.models.DataProduct.yml | 3 + ...analytics.models.DataProductListResult.yml | 1 + ...analytics.models.DataProductProperties.yml | 11 ++++ ...workanalytics.models.DataProductUpdate.yml | 3 + ...ics.models.DataProductUpdateProperties.yml | 5 ++ ...rkanalytics.models.DataProductsCatalog.yml | 1 + ...s.models.DataProductsCatalogListResult.yml | 1 + ....mgmt.networkanalytics.models.DataType.yml | 1 + ...orkanalytics.models.DataTypeListResult.yml | 1 + ...orkanalytics.models.DataTypeProperties.yml | 4 ++ ...networkanalytics.models.DataTypeUpdate.yml | 1 + ...lytics.models.DataTypeUpdateProperties.yml | 4 ++ ....networkanalytics.models.ErrorResponse.yml | 1 + ...e.mgmt.networkanalytics.models.IPRules.yml | 1 + ...nalytics.models.ManagedServiceIdentity.yml | 1 + ...mgmt.networkanalytics.models.Operation.yml | 1 + ...gmt.networkanalytics.models.SystemData.yml | 6 ++ ...etworkanalytics.models.TrackedResource.yml | 1 + ...orkanalytics.models.VirtualNetworkRule.yml | 2 + ...owerbiembedded.models.CheckNameRequest.yml | 1 + ...werbiembedded.models.CheckNameResponse.yml | 3 + ...odels.CreateWorkspaceCollectionRequest.yml | 3 + ...re.mgmt.powerbiembedded.models.Display.yml | 5 ++ ...zure.mgmt.powerbiembedded.models.Error.yml | 4 ++ ...gmt.powerbiembedded.models.ErrorDetail.yml | 3 + ...dels.MigrateWorkspaceCollectionRequest.yml | 2 + ....mgmt.powerbiembedded.models.Operation.yml | 2 + ...t.powerbiembedded.models.OperationList.yml | 1 + ...odels.UpdateWorkspaceCollectionRequest.yml | 2 + ....mgmt.powerbiembedded.models.Workspace.yml | 4 ++ ...rbiembedded.models.WorkspaceCollection.yml | 7 ++ ...ed.models.WorkspaceCollectionAccessKey.yml | 1 + ...d.models.WorkspaceCollectionAccessKeys.yml | 2 + ...mbedded.models.WorkspaceCollectionList.yml | 1 + ...t.powerbiembedded.models.WorkspaceList.yml | 1 + ...t.scheduler.models.BasicAuthentication.yml | 4 +- ...eduler.models.ClientCertAuthentication.yml | 10 +-- ...zure.mgmt.scheduler.models.HttpRequest.yml | 10 +-- .../azure.mgmt.scheduler.models.JobAction.yml | 14 ++-- ...heduler.models.JobCollectionDefinition.yml | 8 +-- ...heduler.models.JobCollectionListResult.yml | 2 +- ...heduler.models.JobCollectionProperties.yml | 6 +- ...mt.scheduler.models.JobCollectionQuota.yml | 6 +- ...re.mgmt.scheduler.models.JobDefinition.yml | 2 +- ...e.mgmt.scheduler.models.JobErrorAction.yml | 12 ++-- ...mgmt.scheduler.models.JobHistoryFilter.yml | 2 +- ....scheduler.models.JobHistoryListResult.yml | 4 +- ...re.mgmt.scheduler.models.JobListResult.yml | 4 +- ...mgmt.scheduler.models.JobMaxRecurrence.yml | 4 +- ...re.mgmt.scheduler.models.JobProperties.yml | 8 +-- ...re.mgmt.scheduler.models.JobRecurrence.yml | 10 +-- ...scheduler.models.JobRecurrenceSchedule.yml | 10 +-- ...JobRecurrenceScheduleMonthlyOccurrence.yml | 4 +- ...e.mgmt.scheduler.models.JobStateFilter.yml | 2 +- ...t.scheduler.models.OAuthAuthentication.yml | 8 +-- ...zure.mgmt.scheduler.models.RetryPolicy.yml | 6 +- ...eduler.models.ServiceBusAuthentication.yml | 6 +- ...ls.ServiceBusBrokeredMessageProperties.yml | 26 ++++---- ...gmt.scheduler.models.ServiceBusMessage.yml | 12 ++-- ...cheduler.models.ServiceBusQueueMessage.yml | 14 ++-- ...cheduler.models.ServiceBusTopicMessage.yml | 14 ++-- .../azure.mgmt.scheduler.models.Sku.yml | 2 +- ...t.scheduler.models.StorageQueueMessage.yml | 8 +-- ...rtexport.aio.operations.JobsOperations.yml | 10 +-- ...port.models.DeliveryPackageInformation.yml | 2 + ...eimportexport.models.DriveBitLockerKey.yml | 2 + ...storageimportexport.models.DriveStatus.yml | 11 ++++ ...portexport.models.EncryptionKeyDetails.yml | 2 + ...orageimportexport.models.ErrorResponse.yml | 5 ++ ...t.models.ErrorResponseErrorDetailsItem.yml | 3 + ...mgmt.storageimportexport.models.Export.yml | 3 + ...export.models.GetBitLockerKeysResponse.yml | 1 + ....storageimportexport.models.JobDetails.yml | 17 +++++ ...storageimportexport.models.JobResponse.yml | 4 ++ ...geimportexport.models.ListJobsResponse.yml | 2 + ...rtexport.models.ListOperationsResponse.yml | 1 + ...mt.storageimportexport.models.Location.yml | 14 ++++ ...eimportexport.models.LocationsResponse.yml | 1 + ...t.storageimportexport.models.Operation.yml | 4 ++ ...geimportexport.models.PutJobParameters.yml | 3 + ...orageimportexport.models.ReturnAddress.yml | 2 + ...mportexport.models.ShippingInformation.yml | 8 +++ ....storageimportexport.models.SystemData.yml | 6 ++ ...mportexport.models.UpdateJobParameters.yml | 9 +++ ...importexport.operations.JobsOperations.yml | 10 +-- ...operations.BillingHubServiceOperations.yml | 2 +- ...base.aio.operations.PackagesOperations.yml | 2 +- ....operations.TestBaseAccountsOperations.yml | 8 +-- ...e.aio.operations.TestResultsOperations.yml | 2 +- ...estbase.aio.operations.UsageOperations.yml | 2 +- ...stbase.models.AnalysisResultListResult.yml | 1 + ...models.AnalysisResultSingletonResource.yml | 1 + ...lysisResultSingletonResourceProperties.yml | 1 + ....testbase.models.AvailableOSListResult.yml | 1 + ...mt.testbase.models.AvailableOSResource.yml | 6 ++ ....models.BillingHubExecutionUsageDetail.yml | 14 ++++ ...odels.BillingHubFreeHourIncrementEntry.yml | 4 ++ ...s.BillingHubGetFreeHourBalanceResponse.yml | 2 + ...tbase.models.BillingHubGetUsageRequest.yml | 2 + ...base.models.BillingHubGetUsageResponse.yml | 5 ++ ...testbase.models.BillingHubPackageUsage.yml | 7 ++ ...e.mgmt.testbase.models.BillingHubUsage.yml | 7 ++ ...t.testbase.models.BillingHubUsageGroup.yml | 11 ++++ ...els.BillingHubUsageGroupedByUpdateType.yml | 5 ++ ...ssionResultSingletonResourceProperties.yml | 2 + ...ationResultSingletonResourceProperties.yml | 2 + ...ase.models.CheckNameAvailabilityResult.yml | 2 + .../azure.mgmt.testbase.models.Command.yml | 6 ++ ...estbase.models.CustomerEventListResult.yml | 1 + ....testbase.models.CustomerEventResource.yml | 2 + ...els.DistributionGroupListReceiverValue.yml | 1 + ...t.testbase.models.EmailEventListResult.yml | 1 + ...gmt.testbase.models.EmailEventResource.yml | 3 + ...ure.mgmt.testbase.models.ErrorResponse.yml | 1 + ...tbase.models.FavoriteProcessListResult.yml | 1 + ...estbase.models.FavoriteProcessResource.yml | 1 + ...estbase.models.FlightingRingListResult.yml | 1 + ....testbase.models.FlightingRingResource.yml | 1 + ...base.models.GetFileUploadURLParameters.yml | 1 + ...mgmt.testbase.models.IdentifiedFailure.yml | 4 ++ ...ssionResultSingletonResourceProperties.yml | 2 + ...ationResultSingletonResourceProperties.yml | 2 + ...tbase.models.NotificationEventReceiver.yml | 2 + ...tbase.models.NotificationReceiverValue.yml | 3 + ...gmt.testbase.models.OSUpdateListResult.yml | 1 + ....mgmt.testbase.models.OSUpdateResource.yml | 7 ++ ...mt.testbase.models.OSUpdateTestSummary.yml | 11 ++++ ...t.testbase.models.OSUpdatesTestSummary.yml | 5 ++ .../azure.mgmt.testbase.models.Operation.yml | 2 + ...mt.testbase.models.OperationListResult.yml | 1 + ...PackageCheckNameAvailabilityParameters.yml | 1 + ...mgmt.testbase.models.PackageListResult.yml | 1 + ...e.mgmt.testbase.models.PackageResource.yml | 7 ++ ...stbase.models.PackageRunTestParameters.yml | 3 + ...estbase.models.PackageUpdateParameters.yml | 6 ++ ....mgmt.testbase.models.RegressionResult.yml | 5 ++ ....testbase.models.RegressionTestDetails.yml | 2 + ...mgmt.testbase.models.ReliabilityResult.yml | 9 +++ ...ilityResultSingletonResourceProperties.yml | 2 + ....testbase.models.ScriptExecutionResult.yml | 7 ++ ...utionResultSingletonResourceProperties.yml | 2 + ...tbase.models.SubscriptionReceiverValue.yml | 3 + .../azure.mgmt.testbase.models.SystemData.yml | 6 ++ ...zure.mgmt.testbase.models.TargetOSInfo.yml | 1 + .../azure.mgmt.testbase.models.Test.yml | 1 + ...gmt.testbase.models.TestAnalysisResult.yml | 3 + ...lysisResultSingletonResourceProperties.yml | 2 + ...tbase.models.TestBaseAccountListResult.yml | 1 + ...estbase.models.TestBaseAccountResource.yml | 2 + ...gmt.testbase.models.TestBaseAccountSKU.yml | 2 + ...se.models.TestBaseAccountSKUListResult.yml | 1 + ...models.TestBaseAccountUpdateParameters.yml | 2 + ...stbase.models.TestBaseAccountUsageData.yml | 5 ++ ...se.models.TestBaseAccountUsageDataList.yml | 1 + ...stbase.models.TestBaseAccountUsageName.yml | 2 + ...tbase.models.TestResultAnalysisSummary.yml | 3 + ...t.testbase.models.TestResultListResult.yml | 1 + ...gmt.testbase.models.TestResultResource.yml | 22 +++++++ ....testbase.models.TestSummaryListResult.yml | 1 + ...mt.testbase.models.TestSummaryResource.yml | 11 ++++ ...gmt.testbase.models.TestTypeListResult.yml | 1 + ....mgmt.testbase.models.TestTypeResource.yml | 1 + ...e.mgmt.testbase.models.TrackedResource.yml | 1 + ...estbase.models.UserObjectReceiverValue.yml | 1 + ....mgmt.testbase.models.UtilizationBound.yml | 2 + ....mgmt.testbase.models.UtilizationEntry.yml | 2 + ...mgmt.testbase.models.UtilizationResult.yml | 4 ++ ...operations.BillingHubServiceOperations.yml | 2 +- ...testbase.operations.PackagesOperations.yml | 2 +- ....operations.TestBaseAccountsOperations.yml | 8 +-- ...tbase.operations.TestResultsOperations.yml | 2 +- ...mt.testbase.operations.UsageOperations.yml | 2 +- ...ideoanalyzer.models.AccessPolicyEntity.yml | 4 +- ...er.models.AccessPolicyEntityCollection.yml | 4 +- ...videoanalyzer.models.AccountEncryption.yml | 4 +- ...t.videoanalyzer.models.AudioEncoderAac.yml | 2 +- ....videoanalyzer.models.AudioEncoderBase.yml | 2 +- ...er.models.CheckNameAvailabilityRequest.yml | 4 +- ...r.models.CheckNameAvailabilityResponse.yml | 6 +- ...yzer.models.EdgeModuleEntityCollection.yml | 4 +- ...deoanalyzer.models.EncoderCustomPreset.yml | 4 +- ...ure.mgmt.videoanalyzer.models.Endpoint.yml | 2 +- ...mgmt.videoanalyzer.models.EndpointBase.yml | 2 +- ...gmt.videoanalyzer.models.ErrorResponse.yml | 2 +- ...nalyzer.models.GroupLevelAccessControl.yml | 2 +- ...videoanalyzer.models.JwtAuthentication.yml | 8 +-- ...mgmt.videoanalyzer.models.LivePipeline.yml | 8 +-- ...analyzer.models.LivePipelineCollection.yml | 4 +- ...ideoanalyzer.models.LivePipelineUpdate.yml | 8 +-- ...deoanalyzer.models.MetricSpecification.yml | 2 +- ...eoanalyzer.models.NetworkAccessControl.yml | 6 +- ...re.mgmt.videoanalyzer.models.Operation.yml | 10 +-- ...deoanalyzer.models.OperationCollection.yml | 2 +- ....videoanalyzer.models.OperationDisplay.yml | 8 +-- ...eoanalyzer.models.ParameterDeclaration.yml | 4 +- ...deoanalyzer.models.ParameterDefinition.yml | 2 +- ....mgmt.videoanalyzer.models.PipelineJob.yml | 6 +- ...oanalyzer.models.PipelineJobCollection.yml | 4 +- ....videoanalyzer.models.PipelineJobError.yml | 4 +- ...videoanalyzer.models.PipelineJobUpdate.yml | 6 +- ....videoanalyzer.models.PipelineTopology.yml | 10 +-- ...yzer.models.PipelineTopologyCollection.yml | 4 +- ...analyzer.models.PipelineTopologyUpdate.yml | 14 ++-- ...lyzer.models.PrivateEndpointConnection.yml | 4 +- ...ls.PrivateEndpointConnectionListResult.yml | 2 +- ...deoanalyzer.models.PrivateLinkResource.yml | 2 +- ...r.models.PrivateLinkResourceListResult.yml | 2 +- ...dels.PrivateLinkServiceConnectionState.yml | 6 +- ...e.mgmt.videoanalyzer.models.RtspSource.yml | 2 +- ...mt.videoanalyzer.models.StorageAccount.yml | 2 +- ...e.mgmt.videoanalyzer.models.SystemData.yml | 12 ++-- ....mgmt.videoanalyzer.models.TlsEndpoint.yml | 6 +- ...eoanalyzer.models.TlsValidationOptions.yml | 4 +- ...t.videoanalyzer.models.TrackedResource.yml | 2 +- ...videoanalyzer.models.UnsecuredEndpoint.yml | 2 +- ...gmt.videoanalyzer.models.VideoAnalyzer.yml | 14 ++-- ...nalyzer.models.VideoAnalyzerCollection.yml | 2 +- ...oanalyzer.models.VideoAnalyzerIdentity.yml | 2 +- ...er.models.VideoAnalyzerOperationStatus.yml | 10 +-- ...ivateEndpointConnectionOperationStatus.yml | 10 +-- ...deoanalyzer.models.VideoAnalyzerUpdate.yml | 14 ++-- ...gmt.videoanalyzer.models.VideoArchival.yml | 2 +- ....videoanalyzer.models.VideoContentUrls.yml | 8 +-- ...nalyzer.models.VideoCreationProperties.yml | 8 +-- ....videoanalyzer.models.VideoEncoderBase.yml | 6 +- ....videoanalyzer.models.VideoEncoderH264.yml | 6 +- ....mgmt.videoanalyzer.models.VideoEntity.yml | 8 +-- ...oanalyzer.models.VideoEntityCollection.yml | 4 +- ...mt.videoanalyzer.models.VideoMediaInfo.yml | 2 +- ...oanalyzer.models.VideoPreviewImageUrls.yml | 6 +- ...analyzer.models.VideoPublishingOptions.yml | 4 +- ...e.mgmt.videoanalyzer.models.VideoScale.yml | 6 +- ...re.mgmt.videoanalyzer.models.VideoSink.yml | 4 +- ...io.operations.HealthMonitorsOperations.yml | 16 ++--- ...mt.workloadmonitor.models.ErrorDetails.yml | 2 + ...t.workloadmonitor.models.ErrorResponse.yml | 1 + ...kloadmonitor.models.ErrorResponseError.yml | 3 + ...t.workloadmonitor.models.HealthMonitor.yml | 9 +++ ...rkloadmonitor.models.HealthMonitorList.yml | 2 + ...onitor.models.HealthMonitorStateChange.yml | 7 ++ ...or.models.HealthMonitorStateChangeList.yml | 2 + ...t.workloadmonitor.models.OperationList.yml | 2 + ...or.operations.HealthMonitorsOperations.yml | 16 ++--- ...atalog.aio.operations.EntityOperations.yml | 40 ++++++++--- ...alog.aio.operations.GlossaryOperations.yml | 44 ++++++++++++- ...talog.aio.operations.LineageOperations.yml | 11 ++++ ....aio.operations.RelationshipOperations.yml | 1 + ...catalog.aio.operations.TypesOperations.yml | 4 ++ ...ew.catalog.operations.EntityOperations.yml | 40 ++++++++--- ....catalog.operations.GlossaryOperations.yml | 44 ++++++++++++- ...w.catalog.operations.LineageOperations.yml | 11 ++++ ...alog.operations.RelationshipOperations.yml | 1 + ...iew.catalog.operations.TypesOperations.yml | 4 ++ ...pse.accesscontrol.models.ErrorContract.yml | 2 +- ...napse.accesscontrol.models.ErrorDetail.yml | 2 +- ...pse.accesscontrol.models.ErrorResponse.yml | 4 +- ...sscontrol.models.RoleAssignmentDetails.yml | 6 +- ...accesscontrol.models.RolesListResponse.yml | 2 +- ...napse.accesscontrol.models.SynapseRole.yml | 4 +- ...zure.synapse.artifacts.models.Activity.yml | 8 +-- ...se.artifacts.models.ActivityDependency.yml | 2 +- ...ynapse.artifacts.models.ActivityPolicy.yml | 12 ++-- ...e.synapse.artifacts.models.ActivityRun.yml | 2 +- ...facts.models.ActivityRunsQueryResponse.yml | 2 +- ...dels.AddDataFlowToDebugSessionResponse.yml | 2 +- ...rtifacts.models.AmazonMWSLinkedService.yml | 22 +++---- ...rtifacts.models.AmazonMWSObjectDataset.yml | 16 ++--- ...cts.models.AmazonRedshiftLinkedService.yml | 18 ++--- ...acts.models.AmazonRedshiftTableDataset.yml | 20 +++--- ...artifacts.models.AmazonS3LinkedService.yml | 18 ++--- ...rtifacts.models.AppendVariableActivity.yml | 12 ++-- ...e.synapse.artifacts.models.AvroDataset.yml | 20 +++--- ...tifacts.models.AzureBatchLinkedService.yml | 14 ++-- ...ifacts.models.AzureBlobFSLinkedService.yml | 20 +++--- ...s.models.AzureBlobStorageLinkedService.yml | 28 ++++---- ...odels.AzureDataExplorerCommandActivity.yml | 14 ++-- ....models.AzureDataExplorerLinkedService.yml | 10 +-- ...s.models.AzureDataExplorerTableDataset.yml | 16 ++--- ...ls.AzureDataLakeAnalyticsLinkedService.yml | 22 +++---- ...models.AzureDataLakeStoreLinkedService.yml | 24 +++---- ...ts.models.AzureDatabricksLinkedService.yml | 34 +++++----- ...s.models.AzureFileStorageLinkedService.yml | 16 ++--- ...artifacts.models.AzureFunctionActivity.yml | 16 ++--- ...acts.models.AzureFunctionLinkedService.yml | 14 ++-- ...acts.models.AzureKeyVaultLinkedService.yml | 10 +-- ...ts.models.AzureKeyVaultSecretReference.yml | 2 +- ...s.models.AzureMLBatchExecutionActivity.yml | 18 ++--- ....models.AzureMLExecutePipelineActivity.yml | 20 +++--- ....artifacts.models.AzureMLLinkedService.yml | 20 +++--- ...cts.models.AzureMLServiceLinkedService.yml | 18 ++--- ...s.models.AzureMLUpdateResourceActivity.yml | 12 ++-- ...facts.models.AzureMariaDBLinkedService.yml | 16 ++--- ...ifacts.models.AzureMariaDBTableDataset.yml | 16 ++--- ...tifacts.models.AzureMySqlLinkedService.yml | 14 ++-- ...rtifacts.models.AzureMySqlTableDataset.yml | 18 ++--- ...ts.models.AzurePostgreSqlLinkedService.yml | 16 ++--- ...cts.models.AzurePostgreSqlTableDataset.yml | 20 +++--- ...tifacts.models.AzureSearchIndexDataset.yml | 14 ++-- ...ifacts.models.AzureSearchLinkedService.yml | 14 ++-- ...tifacts.models.AzureSqlDWLinkedService.yml | 20 +++--- ...rtifacts.models.AzureSqlDWTableDataset.yml | 20 +++--- ...s.models.AzureSqlDatabaseLinkedService.yml | 20 +++--- ...tifacts.models.AzureSqlMILinkedService.yml | 20 +++--- ...rtifacts.models.AzureSqlMITableDataset.yml | 20 +++--- ....artifacts.models.AzureSqlTableDataset.yml | 20 +++--- ...facts.models.AzureStorageLinkedService.yml | 20 +++--- ...pse.artifacts.models.AzureTableDataset.yml | 14 ++-- ....models.AzureTableStorageLinkedService.yml | 20 +++--- ...synapse.artifacts.models.BinaryDataset.yml | 18 ++--- ...rtifacts.models.CassandraLinkedService.yml | 20 +++--- ...artifacts.models.CassandraTableDataset.yml | 18 ++--- ...re.synapse.artifacts.models.CloudError.yml | 4 +- ....CommonDataServiceForAppsEntityDataset.yml | 16 ++--- ....CommonDataServiceForAppsLinkedService.yml | 30 ++++----- ...e.artifacts.models.ConcurLinkedService.yml | 20 +++--- ...e.artifacts.models.ConcurObjectDataset.yml | 16 ++--- ...napse.artifacts.models.ControlActivity.yml | 8 +-- ....synapse.artifacts.models.CopyActivity.yml | 34 +++++----- ...zure.synapse.artifacts.models.CopySink.yml | 12 ++-- ...re.synapse.artifacts.models.CopySource.yml | 8 +-- ...artifacts.models.CosmosDbLinkedService.yml | 20 +++--- ...ls.CosmosDbMongoDbApiCollectionDataset.yml | 14 ++-- ...models.CosmosDbMongoDbApiLinkedService.yml | 10 +-- ...models.CosmosDbSqlApiCollectionDataset.yml | 14 ++-- ...rtifacts.models.CouchbaseLinkedService.yml | 16 ++--- ...artifacts.models.CouchbaseTableDataset.yml | 16 ++--- ...dels.CreateDataFlowDebugSessionRequest.yml | 12 ++-- ...els.CreateDataFlowDebugSessionResponse.yml | 2 +- ...ynapse.artifacts.models.CustomActivity.yml | 22 +++---- ...s.models.CustomActivityReferenceObject.yml | 4 +- ...s.models.CustomDataSourceLinkedService.yml | 10 +-- ...zure.synapse.artifacts.models.DataFlow.yml | 6 +- ...cts.models.DataFlowDebugCommandRequest.yml | 8 +-- ...ts.models.DataFlowDebugCommandResponse.yml | 4 +- ....artifacts.models.DataFlowDebugPackage.yml | 14 ++-- ...dels.DataFlowDebugPackageDebugSettings.yml | 6 +- ...models.DataFlowDebugPreviewDataRequest.yml | 8 +-- ...acts.models.DataFlowDebugQueryResponse.yml | 2 +- ...artifacts.models.DataFlowDebugResource.yml | 2 +- ...cts.models.DataFlowDebugResultResponse.yml | 4 +- ...ifacts.models.DataFlowDebugSessionInfo.yml | 20 +++--- ....models.DataFlowDebugStatisticsRequest.yml | 8 +-- ...ynapse.artifacts.models.DataFlowFolder.yml | 2 +- ....artifacts.models.DataFlowListResponse.yml | 2 +- ...pse.artifacts.models.DataFlowReference.yml | 4 +- ....synapse.artifacts.models.DataFlowSink.yml | 4 +- ...ynapse.artifacts.models.DataFlowSource.yml | 4 +- ...artifacts.models.DataFlowSourceSetting.yml | 6 +- ...e.artifacts.models.DataFlowStagingInfo.yml | 4 +- ...s.models.DataLakeAnalyticsUSQLActivity.yml | 22 +++---- ...acts.models.DatabricksNotebookActivity.yml | 16 ++--- ...acts.models.DatabricksSparkJarActivity.yml | 16 ++--- ...s.models.DatabricksSparkPythonActivity.yml | 16 ++--- ...azure.synapse.artifacts.models.Dataset.yml | 14 ++-- ...tifacts.models.DatasetBZip2Compression.yml | 2 +- ...se.artifacts.models.DatasetCompression.yml | 2 +- ....artifacts.models.DatasetDebugResource.yml | 2 +- ...facts.models.DatasetDeflateCompression.yml | 4 +- ...synapse.artifacts.models.DatasetFolder.yml | 2 +- ...rtifacts.models.DatasetGZipCompression.yml | 4 +- ...e.artifacts.models.DatasetListResponse.yml | 2 +- ...napse.artifacts.models.DatasetLocation.yml | 6 +- ...apse.artifacts.models.DatasetReference.yml | 2 +- ...ts.models.DatasetZipDeflateCompression.yml | 4 +- ...apse.artifacts.models.Db2LinkedService.yml | 20 +++--- ...napse.artifacts.models.Db2TableDataset.yml | 20 +++--- ...ynapse.artifacts.models.DeleteActivity.yml | 20 +++--- ...dels.DeleteDataFlowDebugSessionRequest.yml | 4 +- ....artifacts.models.DelimitedTextDataset.yml | 34 +++++----- ...cts.models.DocumentDbCollectionDataset.yml | 14 ++-- ...se.artifacts.models.DrillLinkedService.yml | 16 ++--- ...pse.artifacts.models.DrillTableDataset.yml | 20 +++--- ...tifacts.models.DynamicsAXLinkedService.yml | 12 ++-- ...facts.models.DynamicsAXResourceDataset.yml | 14 ++-- ...ifacts.models.DynamicsCrmEntityDataset.yml | 16 ++--- ...ifacts.models.DynamicsCrmLinkedService.yml | 30 ++++----- ...artifacts.models.DynamicsEntityDataset.yml | 16 ++--- ...artifacts.models.DynamicsLinkedService.yml | 30 ++++----- ...e.artifacts.models.EloquaLinkedService.yml | 20 +++--- ...e.artifacts.models.EloquaObjectDataset.yml | 16 ++--- ...dels.EvaluateDataFlowExpressionRequest.yml | 10 +-- ...tifacts.models.ExecuteDataFlowActivity.yml | 18 ++--- ...eDataFlowActivityTypePropertiesCompute.yml | 4 +- ...tifacts.models.ExecutePipelineActivity.yml | 12 ++-- ...acts.models.ExecuteSSISPackageActivity.yml | 32 ++++----- ...pse.artifacts.models.ExecutionActivity.yml | 12 ++-- ...rtifacts.models.ExposureControlRequest.yml | 4 +- ...tifacts.models.FileServerLinkedService.yml | 16 ++--- ...ynapse.artifacts.models.FilterActivity.yml | 8 +-- ...napse.artifacts.models.ForEachActivity.yml | 12 ++-- ...rtifacts.models.FtpServerLinkedService.yml | 24 +++---- ...e.artifacts.models.GetMetadataActivity.yml | 14 ++-- ...ts.models.GetSsisObjectMetadataRequest.yml | 2 +- ...acts.models.GoogleAdWordsLinkedService.yml | 26 ++++---- ...acts.models.GoogleAdWordsObjectDataset.yml | 16 ++--- ...cts.models.GoogleBigQueryLinkedService.yml | 30 ++++----- ...cts.models.GoogleBigQueryObjectDataset.yml | 20 +++--- ...models.GoogleCloudStorageLinkedService.yml | 18 ++--- ...rtifacts.models.GreenplumLinkedService.yml | 16 ++--- ...artifacts.models.GreenplumTableDataset.yml | 20 +++--- ...se.artifacts.models.HBaseLinkedService.yml | 28 ++++---- ...se.artifacts.models.HBaseObjectDataset.yml | 16 ++--- ...artifacts.models.HDInsightHiveActivity.yml | 28 ++++---- ...rtifacts.models.HDInsightLinkedService.yml | 24 +++---- ...acts.models.HDInsightMapReduceActivity.yml | 24 +++---- ....models.HDInsightOnDemandLinkedService.yml | 62 ++++++++--------- ....artifacts.models.HDInsightPigActivity.yml | 24 +++---- ...rtifacts.models.HDInsightSparkActivity.yml | 24 +++---- ...acts.models.HDInsightStreamingActivity.yml | 26 ++++---- ...pse.artifacts.models.HdfsLinkedService.yml | 18 ++--- ...pse.artifacts.models.HiveLinkedService.yml | 40 +++++------ ...pse.artifacts.models.HiveObjectDataset.yml | 20 +++--- ...pse.artifacts.models.HttpLinkedService.yml | 24 +++---- ....artifacts.models.HubspotLinkedService.yml | 24 +++---- ....artifacts.models.HubspotObjectDataset.yml | 16 ++--- ...e.artifacts.models.IfConditionActivity.yml | 12 ++-- ...e.artifacts.models.ImpalaLinkedService.yml | 28 ++++---- ...e.artifacts.models.ImpalaObjectDataset.yml | 20 +++--- ...artifacts.models.InformixLinkedService.yml | 20 +++--- ....artifacts.models.InformixTableDataset.yml | 16 ++--- ...cts.models.IntegrationRuntimeReference.yml | 2 +- ...pse.artifacts.models.JiraLinkedService.yml | 22 +++---- ...pse.artifacts.models.JiraObjectDataset.yml | 16 ++--- ...e.synapse.artifacts.models.JsonDataset.yml | 20 +++--- ...synapse.artifacts.models.LinkedService.yml | 10 +-- ...acts.models.LinkedServiceDebugResource.yml | 2 +- ...facts.models.LinkedServiceListResponse.yml | 2 +- ...rtifacts.models.LinkedServiceReference.yml | 2 +- ...se.artifacts.models.LogStorageSettings.yml | 4 +- ...ynapse.artifacts.models.LookupActivity.yml | 14 ++-- ....artifacts.models.MagentoLinkedService.yml | 20 +++--- ....artifacts.models.MagentoObjectDataset.yml | 16 ++--- ...napse.artifacts.models.MappingDataFlow.yml | 14 ++-- ....artifacts.models.MariaDBLinkedService.yml | 16 ++--- ...e.artifacts.models.MariaDBTableDataset.yml | 16 ++--- ....artifacts.models.MarketoLinkedService.yml | 20 +++--- ....artifacts.models.MarketoObjectDataset.yml | 16 ++--- ...ts.models.MicrosoftAccessLinkedService.yml | 20 +++--- ...cts.models.MicrosoftAccessTableDataset.yml | 16 ++--- ...ifacts.models.MongoDbCollectionDataset.yml | 14 ++-- ....artifacts.models.MongoDbLinkedService.yml | 26 ++++---- ...acts.models.MongoDbV2CollectionDataset.yml | 14 ++-- ...rtifacts.models.MongoDbV2LinkedService.yml | 10 +-- ...tifacts.models.MultiplePipelineTrigger.yml | 8 +-- ...se.artifacts.models.MySqlLinkedService.yml | 14 ++-- ...pse.artifacts.models.MySqlTableDataset.yml | 16 ++--- ....artifacts.models.NetezzaLinkedService.yml | 16 ++--- ...e.artifacts.models.NetezzaTableDataset.yml | 20 +++--- ...zure.synapse.artifacts.models.Notebook.yml | 8 +-- ....synapse.artifacts.models.NotebookCell.yml | 6 +- ...rtifacts.models.NotebookCellOutputItem.yml | 10 +-- ...se.artifacts.models.NotebookKernelSpec.yml | 2 +- ....artifacts.models.NotebookLanguageInfo.yml | 4 +- ....artifacts.models.NotebookListResponse.yml | 2 +- ...apse.artifacts.models.NotebookMetadata.yml | 6 +- ...se.artifacts.models.ODataLinkedService.yml | 32 ++++----- ....artifacts.models.ODataResourceDataset.yml | 16 ++--- ...pse.artifacts.models.OdbcLinkedService.yml | 20 +++--- ...apse.artifacts.models.OdbcTableDataset.yml | 16 ++--- ...apse.artifacts.models.Office365Dataset.yml | 16 ++--- ...rtifacts.models.Office365LinkedService.yml | 12 ++-- ...e.artifacts.models.OracleLinkedService.yml | 14 ++-- ...models.OracleServiceCloudLinkedService.yml | 18 ++--- ...models.OracleServiceCloudObjectDataset.yml | 16 ++--- ...se.artifacts.models.OracleTableDataset.yml | 20 +++--- ...re.synapse.artifacts.models.OrcDataset.yml | 18 ++--- ...rtifacts.models.ParameterSpecification.yml | 2 +- ...ynapse.artifacts.models.ParquetDataset.yml | 18 ++--- ...e.artifacts.models.PaypalLinkedService.yml | 20 +++--- ...e.artifacts.models.PaypalObjectDataset.yml | 16 ++--- ....artifacts.models.PhoenixLinkedService.yml | 30 ++++----- ....artifacts.models.PhoenixObjectDataset.yml | 20 +++--- ...ynapse.artifacts.models.PipelineFolder.yml | 2 +- ....artifacts.models.PipelineListResponse.yml | 2 +- ...pse.artifacts.models.PipelineReference.yml | 2 +- ...apse.artifacts.models.PipelineResource.yml | 18 ++--- ...e.synapse.artifacts.models.PipelineRun.yml | 2 +- ...facts.models.PipelineRunsQueryResponse.yml | 2 +- ...tifacts.models.PostgreSqlLinkedService.yml | 14 ++-- ...rtifacts.models.PostgreSqlTableDataset.yml | 20 +++--- ...e.artifacts.models.PrestoLinkedService.yml | 30 ++++----- ...e.artifacts.models.PrestoObjectDataset.yml | 20 +++--- ...els.QueryDataFlowDebugSessionsResponse.yml | 4 +- ...tifacts.models.QuickBooksLinkedService.yml | 14 ++-- ...tifacts.models.QuickBooksObjectDataset.yml | 16 ++--- ...models.RedirectIncompatibleRowSettings.yml | 4 +- ...rtifacts.models.RelationalTableDataset.yml | 16 ++--- ...acts.models.RerunTumblingWindowTrigger.yml | 8 +-- ...zure.synapse.artifacts.models.Resource.yml | 4 +- ...rtifacts.models.ResponsysLinkedService.yml | 20 +++--- ...rtifacts.models.ResponsysObjectDataset.yml | 16 ++--- ...e.artifacts.models.RestResourceDataset.yml | 24 +++---- ...ifacts.models.RestServiceLinkedService.yml | 26 ++++---- ...e.artifacts.models.RunFilterParameters.yml | 6 +- ...apse.artifacts.models.SSISChildPackage.yml | 4 +- ...napse.artifacts.models.SSISLogLocation.yml | 4 +- ...e.artifacts.models.SSISPackageLocation.yml | 18 ++--- ....artifacts.models.SSISPropertyOverride.yml | 2 +- ...tifacts.models.SalesforceLinkedService.yml | 20 +++--- ....SalesforceMarketingCloudLinkedService.yml | 20 +++--- ....SalesforceMarketingCloudObjectDataset.yml | 16 ++--- ...tifacts.models.SalesforceObjectDataset.yml | 16 ++--- ...ls.SalesforceServiceCloudLinkedService.yml | 22 +++---- ...ls.SalesforceServiceCloudObjectDataset.yml | 16 ++--- ...se.artifacts.models.SapBWLinkedService.yml | 16 ++--- ...apse.artifacts.models.SapBwCubeDataset.yml | 14 ++-- ...odels.SapCloudForCustomerLinkedService.yml | 16 ++--- ...els.SapCloudForCustomerResourceDataset.yml | 14 ++-- ...e.artifacts.models.SapEccLinkedService.yml | 16 ++--- ...artifacts.models.SapEccResourceDataset.yml | 14 ++-- ....artifacts.models.SapHanaLinkedService.yml | 20 +++--- ...e.artifacts.models.SapHanaTableDataset.yml | 18 ++--- ...tifacts.models.SapOpenHubLinkedService.yml | 18 ++--- ...rtifacts.models.SapOpenHubTableDataset.yml | 18 ++--- ...artifacts.models.SapTableLinkedService.yml | 42 ++++++------ ...tifacts.models.SapTableResourceDataset.yml | 14 ++-- ....synapse.artifacts.models.ScriptAction.yml | 2 +- ...tifacts.models.ServiceNowLinkedService.yml | 26 ++++---- ...tifacts.models.ServiceNowObjectDataset.yml | 16 ++--- ...e.artifacts.models.SetVariableActivity.yml | 12 ++-- ...tifacts.models.SftpServerLinkedService.yml | 30 ++++----- ....artifacts.models.ShopifyLinkedService.yml | 20 +++--- ....artifacts.models.ShopifyObjectDataset.yml | 16 ++--- ...synapse.artifacts.models.SparkBatchJob.yml | 34 +++++----- ...se.artifacts.models.SparkBatchJobState.yml | 18 ++--- ...se.artifacts.models.SparkJobDefinition.yml | 8 +-- ...models.SparkJobDefinitionsListResponse.yml | 2 +- ...se.artifacts.models.SparkJobProperties.yml | 16 ++--- ...se.artifacts.models.SparkLinkedService.yml | 32 ++++----- ...se.artifacts.models.SparkObjectDataset.yml | 20 +++--- ....synapse.artifacts.models.SparkRequest.yml | 28 ++++---- ...ynapse.artifacts.models.SparkScheduler.yml | 10 +-- ...pse.artifacts.models.SparkServiceError.yml | 6 +- ...se.artifacts.models.SparkServicePlugin.yml | 12 ++-- ...synapse.artifacts.models.SqlConnection.yml | 2 +- ...ure.synapse.artifacts.models.SqlScript.yml | 4 +- ...apse.artifacts.models.SqlScriptContent.yml | 4 +- ...pse.artifacts.models.SqlScriptMetadata.yml | 4 +- ...rtifacts.models.SqlScriptsListResponse.yml | 2 +- ...rtifacts.models.SqlServerLinkedService.yml | 16 ++--- ...odels.SqlServerStoredProcedureActivity.yml | 14 ++-- ...artifacts.models.SqlServerTableDataset.yml | 20 +++--- ...e.artifacts.models.SquareLinkedService.yml | 20 +++--- ...e.artifacts.models.SquareObjectDataset.yml | 16 ++--- ...odels.SsisObjectMetadataStatusResponse.yml | 8 +-- ...napse.artifacts.models.StagingSettings.yml | 6 +- ...odels.StartDataFlowDebugSessionRequest.yml | 14 ++-- ...dels.StartDataFlowDebugSessionResponse.yml | 2 +- ...ifacts.models.StoredProcedureParameter.yml | 4 +- ...ifacts.models.SubResourceDebugResource.yml | 2 +- ...ynapse.artifacts.models.SwitchActivity.yml | 12 ++-- ...re.synapse.artifacts.models.SwitchCase.yml | 4 +- ...e.artifacts.models.SybaseLinkedService.yml | 20 +++--- ...se.artifacts.models.SybaseTableDataset.yml | 16 ++--- ...artifacts.models.TeradataLinkedService.yml | 22 +++---- ....artifacts.models.TeradataTableDataset.yml | 18 ++--- ...ynapse.artifacts.models.Transformation.yml | 2 +- ...azure.synapse.artifacts.models.Trigger.yml | 6 +- ...e.artifacts.models.TriggerListResponse.yml | 2 +- ...ifacts.models.TriggerPipelineReference.yml | 4 +- ...re.synapse.artifacts.models.TriggerRun.yml | 2 +- ...ifacts.models.TriggerRunsQueryResponse.yml | 2 +- ...synapse.artifacts.models.UntilActivity.yml | 10 +-- ...se.artifacts.models.ValidationActivity.yml | 16 ++--- ...artifacts.models.VariableSpecification.yml | 2 +- ....artifacts.models.VerticaLinkedService.yml | 16 ++--- ...e.artifacts.models.VerticaTableDataset.yml | 20 +++--- ....synapse.artifacts.models.WaitActivity.yml | 8 +-- ...e.synapse.artifacts.models.WebActivity.yml | 24 +++---- ...facts.models.WebActivityAuthentication.yml | 8 +-- ...napse.artifacts.models.WebHookActivity.yml | 18 ++--- ...apse.artifacts.models.WebLinkedService.yml | 10 +-- ...napse.artifacts.models.WebTableDataset.yml | 16 ++--- ...ure.synapse.artifacts.models.Workspace.yml | 12 ++-- ...facts.models.WorkspaceUpdateParameters.yml | 4 +- ...pse.artifacts.models.XeroLinkedService.yml | 22 +++---- ...pse.artifacts.models.XeroObjectDataset.yml | 16 ++--- ...pse.artifacts.models.ZohoLinkedService.yml | 20 +++--- ...pse.artifacts.models.ZohoObjectDataset.yml | 16 ++--- .../azure.synapse.models.Config.yml | 2 +- .../azure.synapse.models.Data.yml | 10 +-- .../azure.synapse.models.Edge.yml | 4 +- .../azure.synapse.models.ErrorDetail.yml | 2 +- .../azure.synapse.models.ErrorInformation.yml | 6 +- .../azure.synapse.models.ErrorResponse.yml | 4 +- .../azure.synapse.models.Executors.yml | 14 ++-- ...ynapse.models.ExtendedLivyBatchRequest.yml | 30 ++++----- ...napse.models.ExtendedLivyBatchResponse.yml | 36 +++++----- ...e.models.ExtendedLivyListBatchResponse.yml | 6 +- ...models.ExtendedLivyListSessionResponse.yml | 6 +- ...apse.models.ExtendedLivySessionRequest.yml | 30 ++++----- ...pse.models.ExtendedLivySessionResponse.yml | 36 +++++----- ...pse.models.GetAccessControlInfoRequest.yml | 2 +- ...napse.models.HistoryServerDataResponse.yml | 2 +- ...models.HistoryServerDiagnosticResponse.yml | 2 +- ...ls.HistoryServerDiagnosticResponseData.yml | 4 +- ...apse.models.HistoryServerGraphResponse.yml | 2 +- ....models.HistoryServerGraphResponseData.yml | 6 +- ...models.HistoryServerPropertiesResponse.yml | 2 +- .../azure.synapse.models.Jobs.yml | 10 +-- ...napse.models.LivyBatchStateInformation.yml | 18 ++--- .../azure.synapse.models.LivyRequestBase.yml | 26 ++++---- ...pse.models.LivySessionStateInformation.yml | 22 +++---- ...dels.LivyStatementCancellationResponse.yml | 2 +- ...ure.synapse.models.LivyStatementOutput.yml | 12 ++-- ...ynapse.models.LivyStatementRequestBody.yml | 4 +- ...napse.models.LivyStatementResponseBody.yml | 8 +-- ...apse.models.LivyStatementsResponseBody.yml | 4 +- .../azure.synapse.models.Option.yml | 6 +- ...re.synapse.models.SchedulerInformation.yml | 10 +-- ...dels.SetWorkspaceAdministratorsRequest.yml | 2 +- .../azure.synapse.models.SparkJob.yml | 30 ++++----- ...ynapse.models.SparkJobListViewResponse.yml | 4 +- ...e.models.SparkServicePluginInformation.yml | 12 ++-- .../azure.synapse.models.Stages.yml | 16 ++--- .../azure.synapse.models.Tables.yml | 4 +- ....models.WorkspaceAccessControlResponse.yml | 6 +- ...ure.synapse.spark.models.SparkBatchJob.yml | 34 +++++----- ...e.spark.models.SparkBatchJobCollection.yml | 2 +- ...apse.spark.models.SparkBatchJobOptions.yml | 28 ++++---- ...ynapse.spark.models.SparkBatchJobState.yml | 18 ++--- ...zure.synapse.spark.models.SparkRequest.yml | 28 ++++---- ...re.synapse.spark.models.SparkScheduler.yml | 10 +-- ...synapse.spark.models.SparkServiceError.yml | 6 +- ...ynapse.spark.models.SparkServicePlugin.yml | 12 ++-- ...zure.synapse.spark.models.SparkSession.yml | 34 +++++----- ...se.spark.models.SparkSessionCollection.yml | 2 +- ...napse.spark.models.SparkSessionOptions.yml | 30 ++++----- ...synapse.spark.models.SparkSessionState.yml | 22 +++---- ...re.synapse.spark.models.SparkStatement.yml | 6 +- ...odels.SparkStatementCancellationResult.yml | 2 +- ....spark.models.SparkStatementCollection.yml | 2 +- ...pse.spark.models.SparkStatementOptions.yml | 4 +- ...apse.spark.models.SparkStatementOutput.yml | 10 +-- xrefmap.yml | 4 ++ 1797 files changed, 7714 insertions(+), 6581 deletions(-) diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyFeedback.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyFeedback.yml index 6433a971..f0fed192 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyFeedback.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AnomalyFeedback.yml @@ -88,9 +88,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.AnomalyFeedback.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.yml index ddd56de7..9212442b 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.yml @@ -141,9 +141,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.AzureApplicationInsightsDataFeedSource.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.yml index 104d56ca..29123589 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.yml @@ -142,9 +142,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.AzureBlobDataFeedSource.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.yml index 70c230a7..1b36bdd8 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.yml @@ -144,9 +144,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.AzureCosmosDbDataFeedSource.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.yml index 5abf5cf5..cbe80a07 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.yml @@ -145,9 +145,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.AzureDataExplorerDataFeedSource.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.yml index 576cd8a6..47b0acbd 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.yml @@ -164,9 +164,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.AzureDataLakeStorageGen2DataFeedSource.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.yml index 5357039a..815cdf55 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.yml @@ -133,9 +133,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.AzureEventHubsDataFeedSource.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.yml index 75036cf9..58720d8c 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.yml @@ -163,9 +163,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.AzureLogAnalyticsDataFeedSource.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureTableDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureTableDataFeedSource.yml index 68cc7641..00c21e45 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureTableDataFeedSource.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.AzureTableDataFeedSource.yml @@ -138,9 +138,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.AzureTableDataFeedSource.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.ChangePointFeedback.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.ChangePointFeedback.yml index d952e2f1..3284c826 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.ChangePointFeedback.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.ChangePointFeedback.yml @@ -81,9 +81,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.ChangePointFeedback.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.CommentFeedback.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.CommentFeedback.yml index cbbe5d9d..d1856008 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.CommentFeedback.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.CommentFeedback.yml @@ -78,9 +78,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.CommentFeedback.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedSource.yml index 0c9ff4ad..d3e5df22 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedSource.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DataFeedSource.yml @@ -63,9 +63,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.DataFeedSource.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceCredential.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceCredential.yml index d1620021..74d0dbbe 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceCredential.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceCredential.yml @@ -48,9 +48,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.DatasourceCredential.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.yml index a8dd686e..7b532b67 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.yml @@ -127,9 +127,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.DatasourceDataLakeGen2SharedKey.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceServicePrincipal.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceServicePrincipal.yml index 14d43f06..17452862 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceServicePrincipal.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceServicePrincipal.yml @@ -137,9 +137,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipal.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.yml index 5654ddc6..378ad00f 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.yml @@ -151,9 +151,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.DatasourceServicePrincipalInKeyVault.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.yml index 5c26b530..eac038b8 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.yml @@ -127,9 +127,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.DatasourceSqlConnectionString.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DetectionIncidentFilterCondition.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DetectionIncidentFilterCondition.yml index 0f88ce29..49631985 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DetectionIncidentFilterCondition.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.DetectionIncidentFilterCondition.yml @@ -10,6 +10,7 @@ constructor: keywordOnlyParameters: - name: dimension_filter description: dimension filter. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.yml index ec7a97f7..394d5369 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.yml @@ -145,9 +145,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.InfluxDbDataFeedSource.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricDetectionCondition.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricDetectionCondition.yml index afeae578..0ab99a09 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricDetectionCondition.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricDetectionCondition.yml @@ -17,16 +17,20 @@ constructor: include: "AND", "OR".' + defaultValue: None types: - - - name: smart_detection_condition + defaultValue: None types: - - name: hard_threshold_condition + defaultValue: None types: - - name: change_threshold_condition + defaultValue: None types: - - name: condition_operator diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricFeedback.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricFeedback.yml index c97e370e..e8e6a583 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricFeedback.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricFeedback.yml @@ -75,9 +75,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.MetricFeedback.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricSeriesData.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricSeriesData.yml index 88c846ba..15e9d42b 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricSeriesData.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MetricSeriesData.yml @@ -9,6 +9,7 @@ constructor: keywordOnlyParameters: - name: series_key description: dimension specified for series group. + defaultValue: None types: - [, ] variables: diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MongoDbDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MongoDbDataFeedSource.yml index b91b94cb..87b62d45 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MongoDbDataFeedSource.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MongoDbDataFeedSource.yml @@ -137,9 +137,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.MongoDbDataFeedSource.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MySqlDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MySqlDataFeedSource.yml index ade410c1..c2f62e67 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MySqlDataFeedSource.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.MySqlDataFeedSource.yml @@ -133,9 +133,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.MySqlDataFeedSource.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.PeriodFeedback.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.PeriodFeedback.yml index b43acc00..8fdb2331 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.PeriodFeedback.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.PeriodFeedback.yml @@ -73,9 +73,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.PeriodFeedback.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.yml index 9a3aebeb..e50a7174 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.yml @@ -133,9 +133,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.PostgreSqlDataFeedSource.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SqlServerDataFeedSource.yml b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SqlServerDataFeedSource.yml index 57fa32b6..44b7864d 100644 --- a/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SqlServerDataFeedSource.yml +++ b/previous/docs-ref-autogen/azure-ai-metricsadvisor/azure.ai.metricsadvisor.models.SqlServerDataFeedSource.yml @@ -149,9 +149,6 @@ methods: isRequired: true - name: value defaultValue: None - parameters: - - name: type - isRequired: true - uid: azure.ai.metricsadvisor.models.SqlServerDataFeedSource.get name: get summary: Return the value for key if key is in the dictionary, else default. diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.ContentTags.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.ContentTags.yml index fd1f74d7..8ff62efa 100644 --- a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.ContentTags.yml +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.ContentTags.yml @@ -102,6 +102,6 @@ methods: signature: sort(*, key=None, reverse=False) keywordOnlyParameters: - name: key - isRequired: true + defaultValue: None - name: reverse - isRequired: true + defaultValue: 'False' diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.CropSuggestions.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.CropSuggestions.yml index f8fe6a8b..ac6276f2 100644 --- a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.CropSuggestions.yml +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.CropSuggestions.yml @@ -103,6 +103,6 @@ methods: signature: sort(*, key=None, reverse=False) keywordOnlyParameters: - name: key - isRequired: true + defaultValue: None - name: reverse - isRequired: true + defaultValue: 'False' diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DenseCaptions.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DenseCaptions.yml index d3b84794..5e1ea6df 100644 --- a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DenseCaptions.yml +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DenseCaptions.yml @@ -107,6 +107,6 @@ methods: signature: sort(*, key=None, reverse=False) keywordOnlyParameters: - name: key - isRequired: true + defaultValue: None - name: reverse - isRequired: true + defaultValue: 'False' diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedObjects.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedObjects.yml index 21604202..b927aaeb 100644 --- a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedObjects.yml +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedObjects.yml @@ -102,6 +102,6 @@ methods: signature: sort(*, key=None, reverse=False) keywordOnlyParameters: - name: key - isRequired: true + defaultValue: None - name: reverse - isRequired: true + defaultValue: 'False' diff --git a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedPeople.yml b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedPeople.yml index d79fa7ea..44eaec3e 100644 --- a/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedPeople.yml +++ b/previous/docs-ref-autogen/azure-ai-vision/azure.ai.vision.image_analysis_data.DetectedPeople.yml @@ -102,6 +102,6 @@ methods: signature: sort(*, key=None, reverse=False) keywordOnlyParameters: - name: key - isRequired: true + defaultValue: None - name: reverse - isRequired: true + defaultValue: 'False' diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.Column(class).yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.Column(class).yml index ee2e263a..ea38c4dc 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.Column(class).yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.Column(class).yml @@ -22,9 +22,9 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.Column.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorDetail.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorDetail.yml index 4ac33432..aaeb2c6a 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorDetail.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorDetail.yml @@ -52,13 +52,13 @@ constructor: - name: message isRequired: true - name: target - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None - name: resources - isRequired: true + defaultValue: None - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.ErrorDetail.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorInfo.yml index ffb3cb6f..6586f9f6 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.ErrorInfo.yml @@ -41,11 +41,11 @@ constructor: - name: message isRequired: true - name: details - isRequired: true + defaultValue: None - name: innererror - isRequired: true + defaultValue: None - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.ErrorInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAiInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAiInfo.yml index b091d92b..f496f406 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAiInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAiInfo.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: i_key - isRequired: true + defaultValue: None - name: app_name - isRequired: true + defaultValue: None - name: app_id - isRequired: true + defaultValue: None - name: sdk_version - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsAiInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsApplicationInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsApplicationInfo.yml index 34f0021e..ed42ef37 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsApplicationInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsApplicationInfo.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: version - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsApplicationInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAvailabilityResultInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAvailabilityResultInfo.yml index 953380bf..b15c3c68 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAvailabilityResultInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAvailabilityResultInfo.yml @@ -53,21 +53,21 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: success - isRequired: true + defaultValue: None - name: duration - isRequired: true + defaultValue: None - name: performance_bucket - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None - name: location - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: size - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsAvailabilityResultInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAvailabilityResultResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAvailabilityResultResult.yml index f463b309..dc8535cf 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAvailabilityResultResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsAvailabilityResultResult.yml @@ -84,31 +84,31 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: timestamp - isRequired: true + defaultValue: None - name: custom_dimensions - isRequired: true + defaultValue: None - name: custom_measurements - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: session - isRequired: true + defaultValue: None - name: user - isRequired: true + defaultValue: None - name: cloud - isRequired: true + defaultValue: None - name: ai - isRequired: true + defaultValue: None - name: application - isRequired: true + defaultValue: None - name: client - isRequired: true + defaultValue: None - name: availability_result - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsAvailabilityResultResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsBrowserTimingInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsBrowserTimingInfo.yml index 6f088e82..53f1ce4f 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsBrowserTimingInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsBrowserTimingInfo.yml @@ -62,25 +62,25 @@ constructor: - keywordOnlyParameters: - name: url_path - isRequired: true + defaultValue: None - name: url_host - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: url - isRequired: true + defaultValue: None - name: total_duration - isRequired: true + defaultValue: None - name: performance_bucket - isRequired: true + defaultValue: None - name: network_duration - isRequired: true + defaultValue: None - name: send_duration - isRequired: true + defaultValue: None - name: receive_duration - isRequired: true + defaultValue: None - name: processing_duration - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsBrowserTimingInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsBrowserTimingResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsBrowserTimingResult.yml index 20651efc..d5698790 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsBrowserTimingResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsBrowserTimingResult.yml @@ -88,33 +88,33 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: timestamp - isRequired: true + defaultValue: None - name: custom_dimensions - isRequired: true + defaultValue: None - name: custom_measurements - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: session - isRequired: true + defaultValue: None - name: user - isRequired: true + defaultValue: None - name: cloud - isRequired: true + defaultValue: None - name: ai - isRequired: true + defaultValue: None - name: application - isRequired: true + defaultValue: None - name: client - isRequired: true + defaultValue: None - name: browser_timing - isRequired: true + defaultValue: None - name: client_performance - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsBrowserTimingResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsClientInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsClientInfo.yml index 478528ad..2bc63140 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsClientInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsClientInfo.yml @@ -51,21 +51,21 @@ constructor: - keywordOnlyParameters: - name: model - isRequired: true + defaultValue: None - name: os - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None - name: browser - isRequired: true + defaultValue: None - name: ip - isRequired: true + defaultValue: None - name: city - isRequired: true + defaultValue: None - name: state_or_province - isRequired: true + defaultValue: None - name: country_or_region - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsClientInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsClientPerformanceInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsClientPerformanceInfo.yml index c849007f..f046c166 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsClientPerformanceInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsClientPerformanceInfo.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsClientPerformanceInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCloudInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCloudInfo.yml index 4fd11580..528f6c79 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCloudInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCloudInfo.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: role_name - isRequired: true + defaultValue: None - name: role_instance - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsCloudInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomEventInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomEventInfo.yml index 0706e916..c65eab8b 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomEventInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomEventInfo.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsCustomEventInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomEventResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomEventResult.yml index 4768a7a7..21d72f9d 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomEventResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomEventResult.yml @@ -84,31 +84,31 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: timestamp - isRequired: true + defaultValue: None - name: custom_dimensions - isRequired: true + defaultValue: None - name: custom_measurements - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: session - isRequired: true + defaultValue: None - name: user - isRequired: true + defaultValue: None - name: cloud - isRequired: true + defaultValue: None - name: ai - isRequired: true + defaultValue: None - name: application - isRequired: true + defaultValue: None - name: client - isRequired: true + defaultValue: None - name: custom_event - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsCustomEventResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomMetricInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomMetricInfo.yml index b1dfcf15..fb115cb9 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomMetricInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomMetricInfo.yml @@ -46,19 +46,19 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None - name: value_sum - isRequired: true + defaultValue: None - name: value_count - isRequired: true + defaultValue: None - name: value_min - isRequired: true + defaultValue: None - name: value_max - isRequired: true + defaultValue: None - name: value_std_dev - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsCustomMetricInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomMetricResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomMetricResult.yml index 215427eb..70e75cf5 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomMetricResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsCustomMetricResult.yml @@ -84,31 +84,31 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: timestamp - isRequired: true + defaultValue: None - name: custom_dimensions - isRequired: true + defaultValue: None - name: custom_measurements - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: session - isRequired: true + defaultValue: None - name: user - isRequired: true + defaultValue: None - name: cloud - isRequired: true + defaultValue: None - name: ai - isRequired: true + defaultValue: None - name: application - isRequired: true + defaultValue: None - name: client - isRequired: true + defaultValue: None - name: custom_metric - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsCustomMetricResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsDependencyInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsDependencyInfo.yml index 0c028a35..e0bf7b78 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsDependencyInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsDependencyInfo.yml @@ -56,23 +56,23 @@ constructor: - keywordOnlyParameters: - name: target - isRequired: true + defaultValue: None - name: data - isRequired: true + defaultValue: None - name: success - isRequired: true + defaultValue: None - name: duration - isRequired: true + defaultValue: None - name: performance_bucket - isRequired: true + defaultValue: None - name: result_code - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsDependencyInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsDependencyResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsDependencyResult.yml index 6c68c537..a3b5a8c3 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsDependencyResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsDependencyResult.yml @@ -84,31 +84,31 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: timestamp - isRequired: true + defaultValue: None - name: custom_dimensions - isRequired: true + defaultValue: None - name: custom_measurements - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: session - isRequired: true + defaultValue: None - name: user - isRequired: true + defaultValue: None - name: cloud - isRequired: true + defaultValue: None - name: ai - isRequired: true + defaultValue: None - name: application - isRequired: true + defaultValue: None - name: client - isRequired: true + defaultValue: None - name: dependency - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsDependencyResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionDetail.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionDetail.yml index 1bee4e28..7d7b5829 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionDetail.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionDetail.yml @@ -40,17 +40,17 @@ constructor: - [] keywordOnlyParameters: - name: severity_level - isRequired: true + defaultValue: None - name: outer_id - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: parsed_stack - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsExceptionDetail.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionDetailsParsedStack.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionDetailsParsedStack.yml index e0924e82..811cb7c6 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionDetailsParsedStack.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionDetailsParsedStack.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: assembly - isRequired: true + defaultValue: None - name: method - isRequired: true + defaultValue: None - name: level - isRequired: true + defaultValue: None - name: line - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsExceptionDetailsParsedStack.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionInfo.yml index b8ea8f5e..5c2a18d1 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionInfo.yml @@ -94,37 +94,37 @@ constructor: - [] keywordOnlyParameters: - name: severity_level - isRequired: true + defaultValue: None - name: problem_id - isRequired: true + defaultValue: None - name: handled_at - isRequired: true + defaultValue: None - name: assembly - isRequired: true + defaultValue: None - name: method - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None - name: outer_type - isRequired: true + defaultValue: None - name: outer_method - isRequired: true + defaultValue: None - name: outer_assembly - isRequired: true + defaultValue: None - name: outer_message - isRequired: true + defaultValue: None - name: innermost_type - isRequired: true + defaultValue: None - name: innermost_message - isRequired: true + defaultValue: None - name: innermost_method - isRequired: true + defaultValue: None - name: innermost_assembly - isRequired: true + defaultValue: None - name: details - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsExceptionInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionResult.yml index c4fca189..bc860ec3 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsExceptionResult.yml @@ -84,31 +84,31 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: timestamp - isRequired: true + defaultValue: None - name: custom_dimensions - isRequired: true + defaultValue: None - name: custom_measurements - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: session - isRequired: true + defaultValue: None - name: user - isRequired: true + defaultValue: None - name: cloud - isRequired: true + defaultValue: None - name: ai - isRequired: true + defaultValue: None - name: application - isRequired: true + defaultValue: None - name: client - isRequired: true + defaultValue: None - name: exception - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsExceptionResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsOperationInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsOperationInfo.yml index 31d0010a..d1cf80d0 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsOperationInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsOperationInfo.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: parent_id - isRequired: true + defaultValue: None - name: synthetic_source - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsOperationInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPageViewInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPageViewInfo.yml index 5f70b587..8cd8096f 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPageViewInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPageViewInfo.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: url - isRequired: true + defaultValue: None - name: duration - isRequired: true + defaultValue: None - name: performance_bucket - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsPageViewInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPageViewResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPageViewResult.yml index eae45b09..7c000ddd 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPageViewResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPageViewResult.yml @@ -84,31 +84,31 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: timestamp - isRequired: true + defaultValue: None - name: custom_dimensions - isRequired: true + defaultValue: None - name: custom_measurements - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: session - isRequired: true + defaultValue: None - name: user - isRequired: true + defaultValue: None - name: cloud - isRequired: true + defaultValue: None - name: ai - isRequired: true + defaultValue: None - name: application - isRequired: true + defaultValue: None - name: client - isRequired: true + defaultValue: None - name: page_view - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsPageViewResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPerformanceCounterInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPerformanceCounterInfo.yml index ffffd9ed..4974a6c5 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPerformanceCounterInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPerformanceCounterInfo.yml @@ -41,17 +41,17 @@ constructor: - keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: category - isRequired: true + defaultValue: None - name: counter - isRequired: true + defaultValue: None - name: instance_name - isRequired: true + defaultValue: None - name: instance - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsPerformanceCounterInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPerformanceCounterResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPerformanceCounterResult.yml index 1d4c34f0..569cde48 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPerformanceCounterResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsPerformanceCounterResult.yml @@ -84,31 +84,31 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: timestamp - isRequired: true + defaultValue: None - name: custom_dimensions - isRequired: true + defaultValue: None - name: custom_measurements - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: session - isRequired: true + defaultValue: None - name: user - isRequired: true + defaultValue: None - name: cloud - isRequired: true + defaultValue: None - name: ai - isRequired: true + defaultValue: None - name: application - isRequired: true + defaultValue: None - name: client - isRequired: true + defaultValue: None - name: performance_counter - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsPerformanceCounterResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsRequestInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsRequestInfo.yml index e601176d..4598bcf0 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsRequestInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsRequestInfo.yml @@ -51,21 +51,21 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: url - isRequired: true + defaultValue: None - name: success - isRequired: true + defaultValue: None - name: duration - isRequired: true + defaultValue: None - name: performance_bucket - isRequired: true + defaultValue: None - name: result_code - isRequired: true + defaultValue: None - name: source - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsRequestInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsRequestResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsRequestResult.yml index e98a4a75..e84b4d29 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsRequestResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsRequestResult.yml @@ -83,31 +83,31 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: timestamp - isRequired: true + defaultValue: None - name: custom_dimensions - isRequired: true + defaultValue: None - name: custom_measurements - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: session - isRequired: true + defaultValue: None - name: user - isRequired: true + defaultValue: None - name: cloud - isRequired: true + defaultValue: None - name: ai - isRequired: true + defaultValue: None - name: application - isRequired: true + defaultValue: None - name: client - isRequired: true + defaultValue: None - name: request - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsRequestResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResult.yml index 97c6d3b2..f82c80dd 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResult.yml @@ -18,9 +18,9 @@ constructor: - keywordOnlyParameters: - name: aimessages - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultData.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultData.yml index f31e6ef8..2e1db611 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultData.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultData.yml @@ -92,29 +92,29 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: timestamp - isRequired: true + defaultValue: None - name: custom_dimensions - isRequired: true + defaultValue: None - name: custom_measurements - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: session - isRequired: true + defaultValue: None - name: user - isRequired: true + defaultValue: None - name: cloud - isRequired: true + defaultValue: None - name: ai - isRequired: true + defaultValue: None - name: application - isRequired: true + defaultValue: None - name: client - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsResultData.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultDataCustomDimensions.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultDataCustomDimensions.yml index db5c39e3..1a702c89 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultDataCustomDimensions.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultDataCustomDimensions.yml @@ -13,7 +13,7 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsResultDataCustomDimensions.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultDataCustomMeasurements.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultDataCustomMeasurements.yml index 7c6e43ef..82d76f20 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultDataCustomMeasurements.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResultDataCustomMeasurements.yml @@ -13,7 +13,7 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsResultDataCustomMeasurements.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResults.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResults.yml index c3b4cd9c..b0ed5d1d 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResults.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsResults.yml @@ -25,11 +25,11 @@ constructor: - [] keywordOnlyParameters: - name: odatacontext - isRequired: true + defaultValue: None - name: aimessages - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsResults.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsSessionInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsSessionInfo.yml index 401e9878..845e658b 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsSessionInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsSessionInfo.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsSessionInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsTraceInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsTraceInfo.yml index 3f1100ea..2d11ef59 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsTraceInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsTraceInfo.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: message - isRequired: true + defaultValue: None - name: severity_level - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsTraceInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsTraceResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsTraceResult.yml index 44c63c28..d4c477df 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsTraceResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsTraceResult.yml @@ -83,31 +83,31 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: timestamp - isRequired: true + defaultValue: None - name: custom_dimensions - isRequired: true + defaultValue: None - name: custom_measurements - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: session - isRequired: true + defaultValue: None - name: user - isRequired: true + defaultValue: None - name: cloud - isRequired: true + defaultValue: None - name: ai - isRequired: true + defaultValue: None - name: application - isRequired: true + defaultValue: None - name: client - isRequired: true + defaultValue: None - name: trace - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsTraceResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsUserInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsUserInfo.yml index e5e12e3a..4d6cd0da 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsUserInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.EventsUserInfo.yml @@ -25,11 +25,11 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: account_id - isRequired: true + defaultValue: None - name: authenticated_id - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.EventsUserInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsPostBodySchemaParameters.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsPostBodySchemaParameters.yml index 1863c916..7e08f0b7 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsPostBodySchemaParameters.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsPostBodySchemaParameters.yml @@ -88,19 +88,19 @@ constructor: - name: metric_id isRequired: true - name: timespan - isRequired: true + defaultValue: None - name: aggregation - isRequired: true + defaultValue: None - name: interval - isRequired: true + defaultValue: None - name: segment - isRequired: true + defaultValue: None - name: top - isRequired: true + defaultValue: None - name: orderby - isRequired: true + defaultValue: None - name: filter - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.MetricsPostBodySchemaParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsResult.yml index cfe902d5..0ba424fa 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsResult.yml @@ -13,7 +13,7 @@ constructor: - keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.MetricsResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsResultInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsResultInfo.yml index 43c2b4d5..058b9df0 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsResultInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsResultInfo.yml @@ -37,15 +37,15 @@ constructor: - [] keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: start - isRequired: true + defaultValue: None - name: end - isRequired: true + defaultValue: None - name: interval - isRequired: true + defaultValue: None - name: segments - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.MetricsResultInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsSegmentInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsSegmentInfo.yml index 07fa2074..85db8b56 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsSegmentInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.MetricsSegmentInfo.yml @@ -36,13 +36,13 @@ constructor: - [] keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: start - isRequired: true + defaultValue: None - name: end - isRequired: true + defaultValue: None - name: segments - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.MetricsSegmentInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.QueryBody.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.QueryBody.yml index 3e411e95..8a1b3566 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.QueryBody.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.QueryBody.yml @@ -37,9 +37,9 @@ constructor: - name: query isRequired: true - name: timespan - isRequired: true + defaultValue: None - name: applications - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.QueryBody.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.column_py3.Column.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.column_py3.Column.yml index 9bcf9b2e..74b972a7 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.column_py3.Column.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.column_py3.Column.yml @@ -22,9 +22,9 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.column_py3.Column.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_detail_py3.ErrorDetail.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_detail_py3.ErrorDetail.yml index 7598816b..43581072 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_detail_py3.ErrorDetail.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_detail_py3.ErrorDetail.yml @@ -52,13 +52,13 @@ constructor: - name: message isRequired: true - name: target - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None - name: resources - isRequired: true + defaultValue: None - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.error_detail_py3.ErrorDetail.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_info_py3.ErrorInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_info_py3.ErrorInfo.yml index d3151a7e..8b26e537 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_info_py3.ErrorInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.error_info_py3.ErrorInfo.yml @@ -41,11 +41,11 @@ constructor: - name: message isRequired: true - name: details - isRequired: true + defaultValue: None - name: innererror - isRequired: true + defaultValue: None - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.error_info_py3.ErrorInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_ai_info_py3.EventsAiInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_ai_info_py3.EventsAiInfo.yml index 77296a71..44ccd2ea 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_ai_info_py3.EventsAiInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_ai_info_py3.EventsAiInfo.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: i_key - isRequired: true + defaultValue: None - name: app_name - isRequired: true + defaultValue: None - name: app_id - isRequired: true + defaultValue: None - name: sdk_version - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_ai_info_py3.EventsAiInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_application_info_py3.EventsApplicationInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_application_info_py3.EventsApplicationInfo.yml index ff395d00..8fe61339 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_application_info_py3.EventsApplicationInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_application_info_py3.EventsApplicationInfo.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: version - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_application_info_py3.EventsApplicationInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_info_py3.EventsAvailabilityResultInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_info_py3.EventsAvailabilityResultInfo.yml index 39daf41a..b45ee778 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_info_py3.EventsAvailabilityResultInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_info_py3.EventsAvailabilityResultInfo.yml @@ -53,21 +53,21 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: success - isRequired: true + defaultValue: None - name: duration - isRequired: true + defaultValue: None - name: performance_bucket - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None - name: location - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: size - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_availability_result_info_py3.EventsAvailabilityResultInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_result_py3.EventsAvailabilityResultResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_result_py3.EventsAvailabilityResultResult.yml index dd8fe7cb..dd015e5e 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_result_py3.EventsAvailabilityResultResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_availability_result_result_py3.EventsAvailabilityResultResult.yml @@ -84,31 +84,31 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: timestamp - isRequired: true + defaultValue: None - name: custom_dimensions - isRequired: true + defaultValue: None - name: custom_measurements - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: session - isRequired: true + defaultValue: None - name: user - isRequired: true + defaultValue: None - name: cloud - isRequired: true + defaultValue: None - name: ai - isRequired: true + defaultValue: None - name: application - isRequired: true + defaultValue: None - name: client - isRequired: true + defaultValue: None - name: availability_result - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_availability_result_result_py3.EventsAvailabilityResultResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_info_py3.EventsBrowserTimingInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_info_py3.EventsBrowserTimingInfo.yml index 885b501d..f71f7c1b 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_info_py3.EventsBrowserTimingInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_info_py3.EventsBrowserTimingInfo.yml @@ -62,25 +62,25 @@ constructor: - keywordOnlyParameters: - name: url_path - isRequired: true + defaultValue: None - name: url_host - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: url - isRequired: true + defaultValue: None - name: total_duration - isRequired: true + defaultValue: None - name: performance_bucket - isRequired: true + defaultValue: None - name: network_duration - isRequired: true + defaultValue: None - name: send_duration - isRequired: true + defaultValue: None - name: receive_duration - isRequired: true + defaultValue: None - name: processing_duration - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_browser_timing_info_py3.EventsBrowserTimingInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_result_py3.EventsBrowserTimingResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_result_py3.EventsBrowserTimingResult.yml index 796bb353..7e0bbeed 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_result_py3.EventsBrowserTimingResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_browser_timing_result_py3.EventsBrowserTimingResult.yml @@ -88,33 +88,33 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: timestamp - isRequired: true + defaultValue: None - name: custom_dimensions - isRequired: true + defaultValue: None - name: custom_measurements - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: session - isRequired: true + defaultValue: None - name: user - isRequired: true + defaultValue: None - name: cloud - isRequired: true + defaultValue: None - name: ai - isRequired: true + defaultValue: None - name: application - isRequired: true + defaultValue: None - name: client - isRequired: true + defaultValue: None - name: browser_timing - isRequired: true + defaultValue: None - name: client_performance - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_browser_timing_result_py3.EventsBrowserTimingResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_info_py3.EventsClientInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_info_py3.EventsClientInfo.yml index 76f8b706..96e49be1 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_info_py3.EventsClientInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_info_py3.EventsClientInfo.yml @@ -51,21 +51,21 @@ constructor: - keywordOnlyParameters: - name: model - isRequired: true + defaultValue: None - name: os - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None - name: browser - isRequired: true + defaultValue: None - name: ip - isRequired: true + defaultValue: None - name: city - isRequired: true + defaultValue: None - name: state_or_province - isRequired: true + defaultValue: None - name: country_or_region - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_client_info_py3.EventsClientInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_performance_info_py3.EventsClientPerformanceInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_performance_info_py3.EventsClientPerformanceInfo.yml index 288a30d9..55fb7ef5 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_performance_info_py3.EventsClientPerformanceInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_client_performance_info_py3.EventsClientPerformanceInfo.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_client_performance_info_py3.EventsClientPerformanceInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_cloud_info_py3.EventsCloudInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_cloud_info_py3.EventsCloudInfo.yml index b1ffe28f..539a1d2d 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_cloud_info_py3.EventsCloudInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_cloud_info_py3.EventsCloudInfo.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: role_name - isRequired: true + defaultValue: None - name: role_instance - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_cloud_info_py3.EventsCloudInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_info_py3.EventsCustomEventInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_info_py3.EventsCustomEventInfo.yml index 2454b216..72dfcc75 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_info_py3.EventsCustomEventInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_info_py3.EventsCustomEventInfo.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_custom_event_info_py3.EventsCustomEventInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_result_py3.EventsCustomEventResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_result_py3.EventsCustomEventResult.yml index 4d1e0ea7..36aeab5e 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_result_py3.EventsCustomEventResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_event_result_py3.EventsCustomEventResult.yml @@ -84,31 +84,31 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: timestamp - isRequired: true + defaultValue: None - name: custom_dimensions - isRequired: true + defaultValue: None - name: custom_measurements - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: session - isRequired: true + defaultValue: None - name: user - isRequired: true + defaultValue: None - name: cloud - isRequired: true + defaultValue: None - name: ai - isRequired: true + defaultValue: None - name: application - isRequired: true + defaultValue: None - name: client - isRequired: true + defaultValue: None - name: custom_event - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_custom_event_result_py3.EventsCustomEventResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_info_py3.EventsCustomMetricInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_info_py3.EventsCustomMetricInfo.yml index 20b3b6b0..aa874e5a 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_info_py3.EventsCustomMetricInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_info_py3.EventsCustomMetricInfo.yml @@ -46,19 +46,19 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None - name: value_sum - isRequired: true + defaultValue: None - name: value_count - isRequired: true + defaultValue: None - name: value_min - isRequired: true + defaultValue: None - name: value_max - isRequired: true + defaultValue: None - name: value_std_dev - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_custom_metric_info_py3.EventsCustomMetricInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_result_py3.EventsCustomMetricResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_result_py3.EventsCustomMetricResult.yml index aa57acc4..6de45bb5 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_result_py3.EventsCustomMetricResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_custom_metric_result_py3.EventsCustomMetricResult.yml @@ -84,31 +84,31 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: timestamp - isRequired: true + defaultValue: None - name: custom_dimensions - isRequired: true + defaultValue: None - name: custom_measurements - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: session - isRequired: true + defaultValue: None - name: user - isRequired: true + defaultValue: None - name: cloud - isRequired: true + defaultValue: None - name: ai - isRequired: true + defaultValue: None - name: application - isRequired: true + defaultValue: None - name: client - isRequired: true + defaultValue: None - name: custom_metric - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_custom_metric_result_py3.EventsCustomMetricResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_info_py3.EventsDependencyInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_info_py3.EventsDependencyInfo.yml index 986c979c..4f8f8745 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_info_py3.EventsDependencyInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_info_py3.EventsDependencyInfo.yml @@ -56,23 +56,23 @@ constructor: - keywordOnlyParameters: - name: target - isRequired: true + defaultValue: None - name: data - isRequired: true + defaultValue: None - name: success - isRequired: true + defaultValue: None - name: duration - isRequired: true + defaultValue: None - name: performance_bucket - isRequired: true + defaultValue: None - name: result_code - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_dependency_info_py3.EventsDependencyInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_result_py3.EventsDependencyResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_result_py3.EventsDependencyResult.yml index a666351a..4c5c6606 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_result_py3.EventsDependencyResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_dependency_result_py3.EventsDependencyResult.yml @@ -84,31 +84,31 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: timestamp - isRequired: true + defaultValue: None - name: custom_dimensions - isRequired: true + defaultValue: None - name: custom_measurements - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: session - isRequired: true + defaultValue: None - name: user - isRequired: true + defaultValue: None - name: cloud - isRequired: true + defaultValue: None - name: ai - isRequired: true + defaultValue: None - name: application - isRequired: true + defaultValue: None - name: client - isRequired: true + defaultValue: None - name: dependency - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_dependency_result_py3.EventsDependencyResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_detail_py3.EventsExceptionDetail.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_detail_py3.EventsExceptionDetail.yml index dc640770..4d7ef2af 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_detail_py3.EventsExceptionDetail.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_detail_py3.EventsExceptionDetail.yml @@ -40,17 +40,17 @@ constructor: - [] keywordOnlyParameters: - name: severity_level - isRequired: true + defaultValue: None - name: outer_id - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: parsed_stack - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_exception_detail_py3.EventsExceptionDetail.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_details_parsed_stack_py3.EventsExceptionDetailsParsedStack.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_details_parsed_stack_py3.EventsExceptionDetailsParsedStack.yml index b5bc52b1..0e1ffe04 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_details_parsed_stack_py3.EventsExceptionDetailsParsedStack.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_details_parsed_stack_py3.EventsExceptionDetailsParsedStack.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: assembly - isRequired: true + defaultValue: None - name: method - isRequired: true + defaultValue: None - name: level - isRequired: true + defaultValue: None - name: line - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_exception_details_parsed_stack_py3.EventsExceptionDetailsParsedStack.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_info_py3.EventsExceptionInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_info_py3.EventsExceptionInfo.yml index fc620c6c..849115bc 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_info_py3.EventsExceptionInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_info_py3.EventsExceptionInfo.yml @@ -94,37 +94,37 @@ constructor: - [] keywordOnlyParameters: - name: severity_level - isRequired: true + defaultValue: None - name: problem_id - isRequired: true + defaultValue: None - name: handled_at - isRequired: true + defaultValue: None - name: assembly - isRequired: true + defaultValue: None - name: method - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None - name: outer_type - isRequired: true + defaultValue: None - name: outer_method - isRequired: true + defaultValue: None - name: outer_assembly - isRequired: true + defaultValue: None - name: outer_message - isRequired: true + defaultValue: None - name: innermost_type - isRequired: true + defaultValue: None - name: innermost_message - isRequired: true + defaultValue: None - name: innermost_method - isRequired: true + defaultValue: None - name: innermost_assembly - isRequired: true + defaultValue: None - name: details - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_exception_info_py3.EventsExceptionInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_result_py3.EventsExceptionResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_result_py3.EventsExceptionResult.yml index e8560ad2..d3e1295b 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_result_py3.EventsExceptionResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_exception_result_py3.EventsExceptionResult.yml @@ -84,31 +84,31 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: timestamp - isRequired: true + defaultValue: None - name: custom_dimensions - isRequired: true + defaultValue: None - name: custom_measurements - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: session - isRequired: true + defaultValue: None - name: user - isRequired: true + defaultValue: None - name: cloud - isRequired: true + defaultValue: None - name: ai - isRequired: true + defaultValue: None - name: application - isRequired: true + defaultValue: None - name: client - isRequired: true + defaultValue: None - name: exception - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_exception_result_py3.EventsExceptionResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_operation_info_py3.EventsOperationInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_operation_info_py3.EventsOperationInfo.yml index 7e96d3af..7dc801ab 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_operation_info_py3.EventsOperationInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_operation_info_py3.EventsOperationInfo.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: parent_id - isRequired: true + defaultValue: None - name: synthetic_source - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_operation_info_py3.EventsOperationInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_info_py3.EventsPageViewInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_info_py3.EventsPageViewInfo.yml index 366eb4a7..b0adf4c7 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_info_py3.EventsPageViewInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_info_py3.EventsPageViewInfo.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: url - isRequired: true + defaultValue: None - name: duration - isRequired: true + defaultValue: None - name: performance_bucket - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_page_view_info_py3.EventsPageViewInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_result_py3.EventsPageViewResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_result_py3.EventsPageViewResult.yml index 3d9dd076..8b1ffc9e 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_result_py3.EventsPageViewResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_page_view_result_py3.EventsPageViewResult.yml @@ -84,31 +84,31 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: timestamp - isRequired: true + defaultValue: None - name: custom_dimensions - isRequired: true + defaultValue: None - name: custom_measurements - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: session - isRequired: true + defaultValue: None - name: user - isRequired: true + defaultValue: None - name: cloud - isRequired: true + defaultValue: None - name: ai - isRequired: true + defaultValue: None - name: application - isRequired: true + defaultValue: None - name: client - isRequired: true + defaultValue: None - name: page_view - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_page_view_result_py3.EventsPageViewResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_info_py3.EventsPerformanceCounterInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_info_py3.EventsPerformanceCounterInfo.yml index f8d4db35..3a6997f3 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_info_py3.EventsPerformanceCounterInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_info_py3.EventsPerformanceCounterInfo.yml @@ -41,17 +41,17 @@ constructor: - keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: category - isRequired: true + defaultValue: None - name: counter - isRequired: true + defaultValue: None - name: instance_name - isRequired: true + defaultValue: None - name: instance - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_performance_counter_info_py3.EventsPerformanceCounterInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_result_py3.EventsPerformanceCounterResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_result_py3.EventsPerformanceCounterResult.yml index 694c7e32..7a31e7a3 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_result_py3.EventsPerformanceCounterResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_performance_counter_result_py3.EventsPerformanceCounterResult.yml @@ -84,31 +84,31 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: timestamp - isRequired: true + defaultValue: None - name: custom_dimensions - isRequired: true + defaultValue: None - name: custom_measurements - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: session - isRequired: true + defaultValue: None - name: user - isRequired: true + defaultValue: None - name: cloud - isRequired: true + defaultValue: None - name: ai - isRequired: true + defaultValue: None - name: application - isRequired: true + defaultValue: None - name: client - isRequired: true + defaultValue: None - name: performance_counter - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_performance_counter_result_py3.EventsPerformanceCounterResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_info_py3.EventsRequestInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_info_py3.EventsRequestInfo.yml index e57159c9..dbd4897a 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_info_py3.EventsRequestInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_info_py3.EventsRequestInfo.yml @@ -51,21 +51,21 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: url - isRequired: true + defaultValue: None - name: success - isRequired: true + defaultValue: None - name: duration - isRequired: true + defaultValue: None - name: performance_bucket - isRequired: true + defaultValue: None - name: result_code - isRequired: true + defaultValue: None - name: source - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_request_info_py3.EventsRequestInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_result_py3.EventsRequestResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_result_py3.EventsRequestResult.yml index 5ebc41f6..d9961877 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_result_py3.EventsRequestResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_request_result_py3.EventsRequestResult.yml @@ -83,31 +83,31 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: timestamp - isRequired: true + defaultValue: None - name: custom_dimensions - isRequired: true + defaultValue: None - name: custom_measurements - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: session - isRequired: true + defaultValue: None - name: user - isRequired: true + defaultValue: None - name: cloud - isRequired: true + defaultValue: None - name: ai - isRequired: true + defaultValue: None - name: application - isRequired: true + defaultValue: None - name: client - isRequired: true + defaultValue: None - name: request - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_request_result_py3.EventsRequestResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_dimensions_py3.EventsResultDataCustomDimensions.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_dimensions_py3.EventsResultDataCustomDimensions.yml index f34c6fa8..7afcbc1d 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_dimensions_py3.EventsResultDataCustomDimensions.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_dimensions_py3.EventsResultDataCustomDimensions.yml @@ -13,7 +13,7 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_result_data_custom_dimensions_py3.EventsResultDataCustomDimensions.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_measurements_py3.EventsResultDataCustomMeasurements.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_measurements_py3.EventsResultDataCustomMeasurements.yml index 2cdcc964..77d3972e 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_measurements_py3.EventsResultDataCustomMeasurements.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_custom_measurements_py3.EventsResultDataCustomMeasurements.yml @@ -13,7 +13,7 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_result_data_custom_measurements_py3.EventsResultDataCustomMeasurements.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_py3.EventsResultData.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_py3.EventsResultData.yml index 2d3a1612..10bc8415 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_py3.EventsResultData.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_data_py3.EventsResultData.yml @@ -92,29 +92,29 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: timestamp - isRequired: true + defaultValue: None - name: custom_dimensions - isRequired: true + defaultValue: None - name: custom_measurements - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: session - isRequired: true + defaultValue: None - name: user - isRequired: true + defaultValue: None - name: cloud - isRequired: true + defaultValue: None - name: ai - isRequired: true + defaultValue: None - name: application - isRequired: true + defaultValue: None - name: client - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_result_data_py3.EventsResultData.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_py3.EventsResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_py3.EventsResult.yml index 6d9888b0..2de8db9f 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_py3.EventsResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_result_py3.EventsResult.yml @@ -18,9 +18,9 @@ constructor: - keywordOnlyParameters: - name: aimessages - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_result_py3.EventsResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_results_py3.EventsResults.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_results_py3.EventsResults.yml index 51f87467..291febcb 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_results_py3.EventsResults.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_results_py3.EventsResults.yml @@ -25,11 +25,11 @@ constructor: - [] keywordOnlyParameters: - name: odatacontext - isRequired: true + defaultValue: None - name: aimessages - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_results_py3.EventsResults.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_session_info_py3.EventsSessionInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_session_info_py3.EventsSessionInfo.yml index 919fe90c..f57b433a 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_session_info_py3.EventsSessionInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_session_info_py3.EventsSessionInfo.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_session_info_py3.EventsSessionInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_info_py3.EventsTraceInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_info_py3.EventsTraceInfo.yml index 5e605fd6..a0a2a54f 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_info_py3.EventsTraceInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_info_py3.EventsTraceInfo.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: message - isRequired: true + defaultValue: None - name: severity_level - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_trace_info_py3.EventsTraceInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_result_py3.EventsTraceResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_result_py3.EventsTraceResult.yml index dbd72bd7..cedb68f9 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_result_py3.EventsTraceResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_trace_result_py3.EventsTraceResult.yml @@ -83,31 +83,31 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: timestamp - isRequired: true + defaultValue: None - name: custom_dimensions - isRequired: true + defaultValue: None - name: custom_measurements - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: session - isRequired: true + defaultValue: None - name: user - isRequired: true + defaultValue: None - name: cloud - isRequired: true + defaultValue: None - name: ai - isRequired: true + defaultValue: None - name: application - isRequired: true + defaultValue: None - name: client - isRequired: true + defaultValue: None - name: trace - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_trace_result_py3.EventsTraceResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_user_info_py3.EventsUserInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_user_info_py3.EventsUserInfo.yml index 6efdeb31..006a9924 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_user_info_py3.EventsUserInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.events_user_info_py3.EventsUserInfo.yml @@ -25,11 +25,11 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: account_id - isRequired: true + defaultValue: None - name: authenticated_id - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.events_user_info_py3.EventsUserInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.MetricsPostBodySchemaParameters.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.MetricsPostBodySchemaParameters.yml index a3df8f3d..28dab18d 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.MetricsPostBodySchemaParameters.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.MetricsPostBodySchemaParameters.yml @@ -88,19 +88,19 @@ constructor: - name: metric_id isRequired: true - name: timespan - isRequired: true + defaultValue: None - name: aggregation - isRequired: true + defaultValue: None - name: interval - isRequired: true + defaultValue: None - name: segment - isRequired: true + defaultValue: None - name: top - isRequired: true + defaultValue: None - name: orderby - isRequired: true + defaultValue: None - name: filter - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.metrics_post_body_schema_parameters_py3.MetricsPostBodySchemaParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_info_py3.MetricsResultInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_info_py3.MetricsResultInfo.yml index 37b36ed7..2a30e58b 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_info_py3.MetricsResultInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_info_py3.MetricsResultInfo.yml @@ -37,15 +37,15 @@ constructor: - [] keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: start - isRequired: true + defaultValue: None - name: end - isRequired: true + defaultValue: None - name: interval - isRequired: true + defaultValue: None - name: segments - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.metrics_result_info_py3.MetricsResultInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_py3.MetricsResult.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_py3.MetricsResult.yml index 278ad3e0..6d9b9a6e 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_py3.MetricsResult.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_result_py3.MetricsResult.yml @@ -13,7 +13,7 @@ constructor: - keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.metrics_result_py3.MetricsResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_segment_info_py3.MetricsSegmentInfo.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_segment_info_py3.MetricsSegmentInfo.yml index 36f49a32..17381f9e 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_segment_info_py3.MetricsSegmentInfo.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.metrics_segment_info_py3.MetricsSegmentInfo.yml @@ -36,13 +36,13 @@ constructor: - [] keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: start - isRequired: true + defaultValue: None - name: end - isRequired: true + defaultValue: None - name: segments - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.metrics_segment_info_py3.MetricsSegmentInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_body_py3.QueryBody.yml b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_body_py3.QueryBody.yml index 4f825a4d..c53a53d2 100644 --- a/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_body_py3.QueryBody.yml +++ b/previous/docs-ref-autogen/azure-applicationinsights/azure.applicationinsights.models.query_body_py3.QueryBody.yml @@ -37,9 +37,9 @@ constructor: - name: query isRequired: true - name: timespan - isRequired: true + defaultValue: None - name: applications - isRequired: true + defaultValue: None methods: - uid: azure.applicationinsights.models.query_body_py3.QueryBody.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.APIError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.APIError.yml index 444eb945..cf5f6489 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.APIError.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.APIError.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: code - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.anomalydetector.models.APIError.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.ChangePointDetectRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.ChangePointDetectRequest.yml index 655db035..55966fb0 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.ChangePointDetectRequest.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.ChangePointDetectRequest.yml @@ -73,13 +73,13 @@ constructor: - name: granularity isRequired: true - name: custom_interval - isRequired: true + defaultValue: None - name: period - isRequired: true + defaultValue: None - name: stable_trend_window - isRequired: true + defaultValue: None - name: threshold - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.anomalydetector.models.ChangePointDetectRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.Request.yml b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.Request.yml index f286c1a2..40160254 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.Request.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-anomalydetector/azure.cognitiveservices.anomalydetector.models.Request.yml @@ -70,13 +70,13 @@ constructor: - name: granularity isRequired: true - name: custom_interval - isRequired: true + defaultValue: None - name: period - isRequired: true + defaultValue: None - name: max_anomaly_ratio - isRequired: true + defaultValue: None - name: sensitivity - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.anomalydetector.models.Request.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ActiveLearningSettingsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ActiveLearningSettingsDTO.yml index 2d8883e7..8ee5bca6 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ActiveLearningSettingsDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ActiveLearningSettingsDTO.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: enable - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.ActiveLearningSettingsDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanRequestDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanRequestDTO.yml index 07c86585..58569bf9 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanRequestDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanRequestDTO.yml @@ -29,11 +29,11 @@ constructor: - keywordOnlyParameters: - name: enable - isRequired: true + defaultValue: None - name: score_threshold - isRequired: true + defaultValue: None - name: top_answers_with_span - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanRequestDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanResponseDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanResponseDTO.yml index f3205137..76d3be9e 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanResponseDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanResponseDTO.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: text - isRequired: true + defaultValue: None - name: score - isRequired: true + defaultValue: None - name: start_index - isRequired: true + defaultValue: None - name: end_index - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.AnswerSpanResponseDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ContextDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ContextDTO.yml index 130505a2..dd51cf06 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ContextDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ContextDTO.yml @@ -27,9 +27,9 @@ constructor: - [] keywordOnlyParameters: - name: is_context_only - isRequired: true + defaultValue: None - name: prompts - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.ContextDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.CreateKbDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.CreateKbDTO.yml index 5e078dc0..a06a3744 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.CreateKbDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.CreateKbDTO.yml @@ -83,21 +83,21 @@ constructor: - name: name isRequired: true - name: qna_list - isRequired: true + defaultValue: None - name: urls - isRequired: true + defaultValue: None - name: files - isRequired: true + defaultValue: None - name: enable_hierarchical_extraction - isRequired: true + defaultValue: None - name: default_answer_used_for_extraction - isRequired: true + defaultValue: None - name: language - isRequired: true + defaultValue: None - name: enable_multiple_languages - isRequired: true + defaultValue: None - name: default_answer - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.CreateKbDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.CreateKbInputDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.CreateKbInputDTO.yml index f8c0bd09..3c550866 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.CreateKbInputDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.CreateKbInputDTO.yml @@ -26,11 +26,11 @@ constructor: - [] keywordOnlyParameters: - name: qna_list - isRequired: true + defaultValue: None - name: urls - isRequired: true + defaultValue: None - name: files - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.CreateKbInputDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.DeleteKbContentsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.DeleteKbContentsDTO.yml index 42a42691..b6960ba7 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.DeleteKbContentsDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.DeleteKbContentsDTO.yml @@ -19,9 +19,9 @@ constructor: - [] keywordOnlyParameters: - name: ids - isRequired: true + defaultValue: None - name: sources - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.DeleteKbContentsDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointKeysDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointKeysDTO.yml index f3463f6e..0cdf8cfa 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointKeysDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointKeysDTO.yml @@ -36,15 +36,15 @@ constructor: - keywordOnlyParameters: - name: primary_endpoint_key - isRequired: true + defaultValue: None - name: secondary_endpoint_key - isRequired: true + defaultValue: None - name: installed_version - isRequired: true + defaultValue: None - name: last_stable_version - isRequired: true + defaultValue: None - name: language - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointKeysDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTO.yml index 36aa348e..89de278c 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTO.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: active_learning - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTOActiveLearning.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTOActiveLearning.yml index c666ed6b..522cce0f 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTOActiveLearning.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTOActiveLearning.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: enable - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.EndpointSettingsDTOActiveLearning.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.Error(class).yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.Error(class).yml index 989d4ddb..82212f12 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.Error(class).yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.Error(class).yml @@ -57,13 +57,13 @@ constructor: - name: code isRequired: true - name: message - isRequired: true + defaultValue: None - name: target - isRequired: true + defaultValue: None - name: details - isRequired: true + defaultValue: None - name: inner_error - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.Error.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponse.yml index b437a9dc..753db527 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponse.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponse.yml @@ -16,7 +16,7 @@ constructor: - keywordOnlyParameters: - name: error - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseError.yml index 3abf9467..f90123e9 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseError.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseError.yml @@ -55,13 +55,13 @@ constructor: - name: code isRequired: true - name: message - isRequired: true + defaultValue: None - name: target - isRequired: true + defaultValue: None - name: details - isRequired: true + defaultValue: None - name: inner_error - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.ErrorResponseError.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordDTO.yml index b919ae8f..e8ca2207 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordDTO.yml @@ -27,11 +27,11 @@ constructor: - keywordOnlyParameters: - name: user_id - isRequired: true + defaultValue: None - name: user_question - isRequired: true + defaultValue: None - name: qna_id - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordsDTO.yml index 56e0ea3c..018cadff 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordsDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordsDTO.yml @@ -14,7 +14,7 @@ constructor: - [] keywordOnlyParameters: - name: feedback_records - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.FeedbackRecordsDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.InnerErrorModel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.InnerErrorModel.yml index 3438abe0..b6c35a97 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.InnerErrorModel.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.InnerErrorModel.yml @@ -27,9 +27,9 @@ constructor: - keywordOnlyParameters: - name: code - isRequired: true + defaultValue: None - name: inner_error - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.InnerErrorModel.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebaseDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebaseDTO.yml index fbcd9cac..8a62e429 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebaseDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebaseDTO.yml @@ -66,23 +66,23 @@ constructor: - [] keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: host_name - isRequired: true + defaultValue: None - name: last_accessed_timestamp - isRequired: true + defaultValue: None - name: last_changed_timestamp - isRequired: true + defaultValue: None - name: last_published_timestamp - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: user_id - isRequired: true + defaultValue: None - name: urls - isRequired: true + defaultValue: None - name: sources - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebaseDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebasesDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebasesDTO.yml index 3d6ab216..3efb6926 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebasesDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebasesDTO.yml @@ -14,7 +14,7 @@ constructor: - [] keywordOnlyParameters: - name: knowledgebases - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.KnowledgebasesDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.Operation(class).yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.Operation(class).yml index 37423ab0..774cc950 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.Operation(class).yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.Operation(class).yml @@ -53,19 +53,19 @@ constructor: - keywordOnlyParameters: - name: operation_state - isRequired: true + defaultValue: None - name: created_timestamp - isRequired: true + defaultValue: None - name: last_action_timestamp - isRequired: true + defaultValue: None - name: resource_location - isRequired: true + defaultValue: None - name: user_id - isRequired: true + defaultValue: None - name: operation_id - isRequired: true + defaultValue: None - name: error_response - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.Operation.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.PromptDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.PromptDTO.yml index 28aac915..ab0f9b9b 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.PromptDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.PromptDTO.yml @@ -38,13 +38,13 @@ constructor: - keywordOnlyParameters: - name: display_order - isRequired: true + defaultValue: None - name: qna_id - isRequired: true + defaultValue: None - name: qna - isRequired: true + defaultValue: None - name: display_text - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.PromptDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.PromptDTOQna.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.PromptDTOQna.yml index 24ea84f1..f5f03858 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.PromptDTOQna.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.PromptDTOQna.yml @@ -54,15 +54,15 @@ constructor: - name: questions isRequired: true - name: id - isRequired: true + defaultValue: None - name: source - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None - name: context - isRequired: true + defaultValue: None - name: last_updated_timestamp - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.PromptDTOQna.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADTO.yml index e0ca3f07..7c47758d 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADTO.yml @@ -54,15 +54,15 @@ constructor: - name: questions isRequired: true - name: id - isRequired: true + defaultValue: None - name: source - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None - name: context - isRequired: true + defaultValue: None - name: last_updated_timestamp - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADTOContext.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADTOContext.yml index 9f3d485c..8ef4ef8d 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADTOContext.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADTOContext.yml @@ -27,9 +27,9 @@ constructor: - [] keywordOnlyParameters: - name: is_context_only - isRequired: true + defaultValue: None - name: prompts - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADTOContext.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADocumentsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADocumentsDTO.yml index 3f3b0542..4187c073 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADocumentsDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnADocumentsDTO.yml @@ -14,7 +14,7 @@ constructor: - [] keywordOnlyParameters: - name: qna_documents - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.QnADocumentsDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResult.yml index da0aac66..3d3c562b 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResult.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResult.yml @@ -53,21 +53,21 @@ constructor: - keywordOnlyParameters: - name: questions - isRequired: true + defaultValue: None - name: answer - isRequired: true + defaultValue: None - name: score - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: source - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None - name: context - isRequired: true + defaultValue: None - name: answer_span - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultAnswerSpan.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultAnswerSpan.yml index d8941219..b8fb3f69 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultAnswerSpan.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultAnswerSpan.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: text - isRequired: true + defaultValue: None - name: score - isRequired: true + defaultValue: None - name: start_index - isRequired: true + defaultValue: None - name: end_index - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultAnswerSpan.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultContext.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultContext.yml index ea89b06c..85182a79 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultContext.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultContext.yml @@ -27,9 +27,9 @@ constructor: - [] keywordOnlyParameters: - name: is_context_only - isRequired: true + defaultValue: None - name: prompts - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultContext.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultList.yml index c64241e9..1e5dc612 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultList.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultList.yml @@ -14,7 +14,7 @@ constructor: - [] keywordOnlyParameters: - name: answers - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.QnASearchResultList.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryContextDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryContextDTO.yml index a165b6c5..0ef0049e 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryContextDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryContextDTO.yml @@ -20,9 +20,9 @@ constructor: - keywordOnlyParameters: - name: previous_qna_id - isRequired: true + defaultValue: None - name: previous_user_query - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryContextDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTO.yml index e8a5e350..281937e7 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTO.yml @@ -78,27 +78,27 @@ constructor: - keywordOnlyParameters: - name: qna_id - isRequired: true + defaultValue: None - name: question - isRequired: true + defaultValue: None - name: top - isRequired: true + defaultValue: None - name: user_id - isRequired: true + defaultValue: None - name: is_test - isRequired: true + defaultValue: None - name: score_threshold - isRequired: true + defaultValue: None - name: context - isRequired: true + defaultValue: None - name: ranker_type - isRequired: true + defaultValue: None - name: strict_filters - isRequired: true + defaultValue: None - name: strict_filters_compound_operation_type - isRequired: true + defaultValue: None - name: answer_span_request - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOAnswerSpanRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOAnswerSpanRequest.yml index b78b0705..288cdc98 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOAnswerSpanRequest.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOAnswerSpanRequest.yml @@ -29,11 +29,11 @@ constructor: - keywordOnlyParameters: - name: enable - isRequired: true + defaultValue: None - name: score_threshold - isRequired: true + defaultValue: None - name: top_answers_with_span - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOAnswerSpanRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOContext.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOContext.yml index 3a197123..1cd63a00 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOContext.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOContext.yml @@ -20,9 +20,9 @@ constructor: - keywordOnlyParameters: - name: previous_qna_id - isRequired: true + defaultValue: None - name: previous_user_query - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.QueryDTOContext.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateContextDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateContextDTO.yml index 5780d156..a293672c 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateContextDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateContextDTO.yml @@ -35,11 +35,11 @@ constructor: - keywordOnlyParameters: - name: prompts_to_delete - isRequired: true + defaultValue: None - name: prompts_to_add - isRequired: true + defaultValue: None - name: is_context_only - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateContextDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbContentsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbContentsDTO.yml index 5e06c5ea..018e6ea6 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbContentsDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbContentsDTO.yml @@ -36,13 +36,13 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: qna_list - isRequired: true + defaultValue: None - name: urls - isRequired: true + defaultValue: None - name: default_answer - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbContentsDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTO.yml index fd79616c..6e2fb184 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTO.yml @@ -45,15 +45,15 @@ constructor: - keywordOnlyParameters: - name: add - isRequired: true + defaultValue: None - name: delete - isRequired: true + defaultValue: None - name: update - isRequired: true + defaultValue: None - name: enable_hierarchical_extraction - isRequired: true + defaultValue: None - name: default_answer_used_for_extraction - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOAdd.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOAdd.yml index 1044828d..2601d261 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOAdd.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOAdd.yml @@ -26,11 +26,11 @@ constructor: - [] keywordOnlyParameters: - name: qna_list - isRequired: true + defaultValue: None - name: urls - isRequired: true + defaultValue: None - name: files - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOAdd.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTODelete.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTODelete.yml index dd5e3400..50443710 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTODelete.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTODelete.yml @@ -19,9 +19,9 @@ constructor: - [] keywordOnlyParameters: - name: ids - isRequired: true + defaultValue: None - name: sources - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTODelete.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOUpdate.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOUpdate.yml index 2c71be72..25af1c5f 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOUpdate.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOUpdate.yml @@ -36,13 +36,13 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: qna_list - isRequired: true + defaultValue: None - name: urls - isRequired: true + defaultValue: None - name: default_answer - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateKbOperationDTOUpdate.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateMetadataDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateMetadataDTO.yml index 25e36702..4a6057ea 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateMetadataDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateMetadataDTO.yml @@ -19,9 +19,9 @@ constructor: - [] keywordOnlyParameters: - name: delete - isRequired: true + defaultValue: None - name: add - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateMetadataDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTO.yml index ce2a7c97..33d28319 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTO.yml @@ -42,17 +42,17 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: answer - isRequired: true + defaultValue: None - name: source - isRequired: true + defaultValue: None - name: questions - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None - name: context - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOContext.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOContext.yml index 2a324d8f..bfa77a55 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOContext.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOContext.yml @@ -35,11 +35,11 @@ constructor: - keywordOnlyParameters: - name: prompts_to_delete - isRequired: true + defaultValue: None - name: prompts_to_add - isRequired: true + defaultValue: None - name: is_context_only - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOContext.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOMetadata.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOMetadata.yml index a0e6c188..e2cb3dfc 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOMetadata.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOMetadata.yml @@ -19,9 +19,9 @@ constructor: - [] keywordOnlyParameters: - name: delete - isRequired: true + defaultValue: None - name: add - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOMetadata.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOQuestions.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOQuestions.yml index 493bd664..e8eb8667 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOQuestions.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOQuestions.yml @@ -19,9 +19,9 @@ constructor: - [] keywordOnlyParameters: - name: add - isRequired: true + defaultValue: None - name: delete - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQnaDTOQuestions.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQuestionsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQuestionsDTO.yml index e88b0cb6..27bb4ea3 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQuestionsDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.UpdateQuestionsDTO.yml @@ -21,9 +21,9 @@ constructor: - [] keywordOnlyParameters: - name: add - isRequired: true + defaultValue: None - name: delete - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.UpdateQuestionsDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.ActiveLearningSettingsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.ActiveLearningSettingsDTO.yml index cce1e3d4..db75f382 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.ActiveLearningSettingsDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.ActiveLearningSettingsDTO.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: enable - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.active_learning_settings_dto_py3.ActiveLearningSettingsDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.AnswerSpanRequestDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.AnswerSpanRequestDTO.yml index a484d452..c5b9931a 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.AnswerSpanRequestDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.AnswerSpanRequestDTO.yml @@ -29,11 +29,11 @@ constructor: - keywordOnlyParameters: - name: enable - isRequired: true + defaultValue: None - name: score_threshold - isRequired: true + defaultValue: None - name: top_answers_with_span - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_request_dto_py3.AnswerSpanRequestDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.AnswerSpanResponseDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.AnswerSpanResponseDTO.yml index d23b51f7..cc7a4253 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.AnswerSpanResponseDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.AnswerSpanResponseDTO.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: text - isRequired: true + defaultValue: None - name: score - isRequired: true + defaultValue: None - name: start_index - isRequired: true + defaultValue: None - name: end_index - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.answer_span_response_dto_py3.AnswerSpanResponseDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.ContextDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.ContextDTO.yml index ab629b47..86d3fffa 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.ContextDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.ContextDTO.yml @@ -27,9 +27,9 @@ constructor: - [] keywordOnlyParameters: - name: is_context_only - isRequired: true + defaultValue: None - name: prompts - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.context_dto_py3.ContextDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.CreateKbDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.CreateKbDTO.yml index 7988feac..1f4a1b0a 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.CreateKbDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.CreateKbDTO.yml @@ -83,21 +83,21 @@ constructor: - name: name isRequired: true - name: qna_list - isRequired: true + defaultValue: None - name: urls - isRequired: true + defaultValue: None - name: files - isRequired: true + defaultValue: None - name: enable_hierarchical_extraction - isRequired: true + defaultValue: None - name: default_answer_used_for_extraction - isRequired: true + defaultValue: None - name: language - isRequired: true + defaultValue: None - name: enable_multiple_languages - isRequired: true + defaultValue: None - name: default_answer - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_dto_py3.CreateKbDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.CreateKbInputDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.CreateKbInputDTO.yml index 3a704516..e79dc3b8 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.CreateKbInputDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.CreateKbInputDTO.yml @@ -26,11 +26,11 @@ constructor: - [] keywordOnlyParameters: - name: qna_list - isRequired: true + defaultValue: None - name: urls - isRequired: true + defaultValue: None - name: files - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.create_kb_input_dto_py3.CreateKbInputDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.DeleteKbContentsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.DeleteKbContentsDTO.yml index 525de254..cbb44a3b 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.DeleteKbContentsDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.DeleteKbContentsDTO.yml @@ -19,9 +19,9 @@ constructor: - [] keywordOnlyParameters: - name: ids - isRequired: true + defaultValue: None - name: sources - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.delete_kb_contents_dto_py3.DeleteKbContentsDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.EndpointKeysDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.EndpointKeysDTO.yml index cf10b294..20fcf4ad 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.EndpointKeysDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.EndpointKeysDTO.yml @@ -36,15 +36,15 @@ constructor: - keywordOnlyParameters: - name: primary_endpoint_key - isRequired: true + defaultValue: None - name: secondary_endpoint_key - isRequired: true + defaultValue: None - name: installed_version - isRequired: true + defaultValue: None - name: last_stable_version - isRequired: true + defaultValue: None - name: language - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_keys_dto_py3.EndpointKeysDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.EndpointSettingsDTOActiveLearning.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.EndpointSettingsDTOActiveLearning.yml index 39e352e0..77b0a20a 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.EndpointSettingsDTOActiveLearning.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.EndpointSettingsDTOActiveLearning.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: enable - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_active_learning_py3.EndpointSettingsDTOActiveLearning.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.EndpointSettingsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.EndpointSettingsDTO.yml index 3950f197..154a4986 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.EndpointSettingsDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.EndpointSettingsDTO.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: active_learning - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.endpoint_settings_dto_py3.EndpointSettingsDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_py3.Error.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_py3.Error.yml index eb5a8dd3..433a1612 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_py3.Error.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_py3.Error.yml @@ -57,13 +57,13 @@ constructor: - name: code isRequired: true - name: message - isRequired: true + defaultValue: None - name: target - isRequired: true + defaultValue: None - name: details - isRequired: true + defaultValue: None - name: inner_error - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.error_py3.Error.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.ErrorResponseError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.ErrorResponseError.yml index bf47fb56..9c0d91a0 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.ErrorResponseError.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.ErrorResponseError.yml @@ -55,13 +55,13 @@ constructor: - name: code isRequired: true - name: message - isRequired: true + defaultValue: None - name: target - isRequired: true + defaultValue: None - name: details - isRequired: true + defaultValue: None - name: inner_error - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_error_py3.ErrorResponseError.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponse.yml index 6af83abc..6157d19b 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponse.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponse.yml @@ -16,7 +16,7 @@ constructor: - keywordOnlyParameters: - name: error - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.error_response_py3.ErrorResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.FeedbackRecordDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.FeedbackRecordDTO.yml index d73d674b..6680fe12 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.FeedbackRecordDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.FeedbackRecordDTO.yml @@ -27,11 +27,11 @@ constructor: - keywordOnlyParameters: - name: user_id - isRequired: true + defaultValue: None - name: user_question - isRequired: true + defaultValue: None - name: qna_id - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_record_dto_py3.FeedbackRecordDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.FeedbackRecordsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.FeedbackRecordsDTO.yml index 20825963..5d2bfd57 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.FeedbackRecordsDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.FeedbackRecordsDTO.yml @@ -14,7 +14,7 @@ constructor: - [] keywordOnlyParameters: - name: feedback_records - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.feedback_records_dto_py3.FeedbackRecordsDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.InnerErrorModel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.InnerErrorModel.yml index 0426347b..f0cb98c7 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.InnerErrorModel.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.InnerErrorModel.yml @@ -27,9 +27,9 @@ constructor: - keywordOnlyParameters: - name: code - isRequired: true + defaultValue: None - name: inner_error - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.inner_error_model_py3.InnerErrorModel.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.KnowledgebaseDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.KnowledgebaseDTO.yml index ecb021b5..4026bcef 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.KnowledgebaseDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.KnowledgebaseDTO.yml @@ -66,23 +66,23 @@ constructor: - [] keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: host_name - isRequired: true + defaultValue: None - name: last_accessed_timestamp - isRequired: true + defaultValue: None - name: last_changed_timestamp - isRequired: true + defaultValue: None - name: last_published_timestamp - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: user_id - isRequired: true + defaultValue: None - name: urls - isRequired: true + defaultValue: None - name: sources - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebase_dto_py3.KnowledgebaseDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.KnowledgebasesDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.KnowledgebasesDTO.yml index 7fa08be2..eea339b1 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.KnowledgebasesDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.KnowledgebasesDTO.yml @@ -14,7 +14,7 @@ constructor: - [] keywordOnlyParameters: - name: knowledgebases - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.knowledgebases_dto_py3.KnowledgebasesDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.Operation.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.Operation.yml index 55883ad7..03a4a83b 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.Operation.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.Operation.yml @@ -53,19 +53,19 @@ constructor: - keywordOnlyParameters: - name: operation_state - isRequired: true + defaultValue: None - name: created_timestamp - isRequired: true + defaultValue: None - name: last_action_timestamp - isRequired: true + defaultValue: None - name: resource_location - isRequired: true + defaultValue: None - name: user_id - isRequired: true + defaultValue: None - name: operation_id - isRequired: true + defaultValue: None - name: error_response - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.operation_py3.Operation.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.PromptDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.PromptDTO.yml index 5e9a0ddb..36d8f9bb 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.PromptDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.PromptDTO.yml @@ -38,13 +38,13 @@ constructor: - keywordOnlyParameters: - name: display_order - isRequired: true + defaultValue: None - name: qna_id - isRequired: true + defaultValue: None - name: qna - isRequired: true + defaultValue: None - name: display_text - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_py3.PromptDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.PromptDTOQna.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.PromptDTOQna.yml index fef5f7c6..5062700d 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.PromptDTOQna.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.PromptDTOQna.yml @@ -54,15 +54,15 @@ constructor: - name: questions isRequired: true - name: id - isRequired: true + defaultValue: None - name: source - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None - name: context - isRequired: true + defaultValue: None - name: last_updated_timestamp - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.prompt_dto_qna_py3.PromptDTOQna.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.QnADocumentsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.QnADocumentsDTO.yml index 71a2c38e..ddab53bb 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.QnADocumentsDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.QnADocumentsDTO.yml @@ -14,7 +14,7 @@ constructor: - [] keywordOnlyParameters: - name: qna_documents - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adocuments_dto_py3.QnADocumentsDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.QnADTOContext.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.QnADTOContext.yml index baaf1692..321eaed1 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.QnADTOContext.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.QnADTOContext.yml @@ -27,9 +27,9 @@ constructor: - [] keywordOnlyParameters: - name: is_context_only - isRequired: true + defaultValue: None - name: prompts - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_context_py3.QnADTOContext.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.QnADTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.QnADTO.yml index 58596e22..5f6b1613 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.QnADTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.QnADTO.yml @@ -54,15 +54,15 @@ constructor: - name: questions isRequired: true - name: id - isRequired: true + defaultValue: None - name: source - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None - name: context - isRequired: true + defaultValue: None - name: last_updated_timestamp - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_adto_py3.QnADTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.QnASearchResultAnswerSpan.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.QnASearchResultAnswerSpan.yml index 973b6bd9..59d92b7a 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.QnASearchResultAnswerSpan.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.QnASearchResultAnswerSpan.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: text - isRequired: true + defaultValue: None - name: score - isRequired: true + defaultValue: None - name: start_index - isRequired: true + defaultValue: None - name: end_index - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_answer_span_py3.QnASearchResultAnswerSpan.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.QnASearchResultContext.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.QnASearchResultContext.yml index 9295c32f..4377b6a0 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.QnASearchResultContext.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.QnASearchResultContext.yml @@ -27,9 +27,9 @@ constructor: - [] keywordOnlyParameters: - name: is_context_only - isRequired: true + defaultValue: None - name: prompts - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_context_py3.QnASearchResultContext.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.QnASearchResultList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.QnASearchResultList.yml index d054151b..5cc5bba2 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.QnASearchResultList.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.QnASearchResultList.yml @@ -14,7 +14,7 @@ constructor: - [] keywordOnlyParameters: - name: answers - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_list_py3.QnASearchResultList.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.QnASearchResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.QnASearchResult.yml index 051d5d3b..612cb1ad 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.QnASearchResult.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.QnASearchResult.yml @@ -53,21 +53,21 @@ constructor: - keywordOnlyParameters: - name: questions - isRequired: true + defaultValue: None - name: answer - isRequired: true + defaultValue: None - name: score - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: source - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None - name: context - isRequired: true + defaultValue: None - name: answer_span - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.qn_asearch_result_py3.QnASearchResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.QueryContextDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.QueryContextDTO.yml index 6b3e9d9f..ca534281 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.QueryContextDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.QueryContextDTO.yml @@ -20,9 +20,9 @@ constructor: - keywordOnlyParameters: - name: previous_qna_id - isRequired: true + defaultValue: None - name: previous_user_query - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.query_context_dto_py3.QueryContextDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.QueryDTOAnswerSpanRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.QueryDTOAnswerSpanRequest.yml index 92b7fb8a..1f0728bb 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.QueryDTOAnswerSpanRequest.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.QueryDTOAnswerSpanRequest.yml @@ -29,11 +29,11 @@ constructor: - keywordOnlyParameters: - name: enable - isRequired: true + defaultValue: None - name: score_threshold - isRequired: true + defaultValue: None - name: top_answers_with_span - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_answer_span_request_py3.QueryDTOAnswerSpanRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.QueryDTOContext.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.QueryDTOContext.yml index e7eebad2..96ef444d 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.QueryDTOContext.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.QueryDTOContext.yml @@ -20,9 +20,9 @@ constructor: - keywordOnlyParameters: - name: previous_qna_id - isRequired: true + defaultValue: None - name: previous_user_query - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_context_py3.QueryDTOContext.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.QueryDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.QueryDTO.yml index 57d253ba..a9d13139 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.QueryDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.QueryDTO.yml @@ -78,27 +78,27 @@ constructor: - keywordOnlyParameters: - name: qna_id - isRequired: true + defaultValue: None - name: question - isRequired: true + defaultValue: None - name: top - isRequired: true + defaultValue: None - name: user_id - isRequired: true + defaultValue: None - name: is_test - isRequired: true + defaultValue: None - name: score_threshold - isRequired: true + defaultValue: None - name: context - isRequired: true + defaultValue: None - name: ranker_type - isRequired: true + defaultValue: None - name: strict_filters - isRequired: true + defaultValue: None - name: strict_filters_compound_operation_type - isRequired: true + defaultValue: None - name: answer_span_request - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.query_dto_py3.QueryDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.UpdateContextDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.UpdateContextDTO.yml index 3e861e93..ddfce6ce 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.UpdateContextDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.UpdateContextDTO.yml @@ -35,11 +35,11 @@ constructor: - keywordOnlyParameters: - name: prompts_to_delete - isRequired: true + defaultValue: None - name: prompts_to_add - isRequired: true + defaultValue: None - name: is_context_only - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.update_context_dto_py3.UpdateContextDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.UpdateKbContentsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.UpdateKbContentsDTO.yml index 56040735..ccd4ad49 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.UpdateKbContentsDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.UpdateKbContentsDTO.yml @@ -36,13 +36,13 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: qna_list - isRequired: true + defaultValue: None - name: urls - isRequired: true + defaultValue: None - name: default_answer - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_contents_dto_py3.UpdateKbContentsDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.UpdateKbOperationDTOAdd.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.UpdateKbOperationDTOAdd.yml index e0ab1909..270858ec 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.UpdateKbOperationDTOAdd.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.UpdateKbOperationDTOAdd.yml @@ -26,11 +26,11 @@ constructor: - [] keywordOnlyParameters: - name: qna_list - isRequired: true + defaultValue: None - name: urls - isRequired: true + defaultValue: None - name: files - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_add_py3.UpdateKbOperationDTOAdd.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.UpdateKbOperationDTODelete.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.UpdateKbOperationDTODelete.yml index a5871242..d6085633 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.UpdateKbOperationDTODelete.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.UpdateKbOperationDTODelete.yml @@ -19,9 +19,9 @@ constructor: - [] keywordOnlyParameters: - name: ids - isRequired: true + defaultValue: None - name: sources - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_delete_py3.UpdateKbOperationDTODelete.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.UpdateKbOperationDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.UpdateKbOperationDTO.yml index 81ce12c9..26916e9c 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.UpdateKbOperationDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.UpdateKbOperationDTO.yml @@ -45,15 +45,15 @@ constructor: - keywordOnlyParameters: - name: add - isRequired: true + defaultValue: None - name: delete - isRequired: true + defaultValue: None - name: update - isRequired: true + defaultValue: None - name: enable_hierarchical_extraction - isRequired: true + defaultValue: None - name: default_answer_used_for_extraction - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_py3.UpdateKbOperationDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.UpdateKbOperationDTOUpdate.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.UpdateKbOperationDTOUpdate.yml index 8e749e03..0e968092 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.UpdateKbOperationDTOUpdate.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.UpdateKbOperationDTOUpdate.yml @@ -36,13 +36,13 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: qna_list - isRequired: true + defaultValue: None - name: urls - isRequired: true + defaultValue: None - name: default_answer - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.update_kb_operation_dto_update_py3.UpdateKbOperationDTOUpdate.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.UpdateMetadataDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.UpdateMetadataDTO.yml index 524d6e36..6bc31fd9 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.UpdateMetadataDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.UpdateMetadataDTO.yml @@ -19,9 +19,9 @@ constructor: - [] keywordOnlyParameters: - name: delete - isRequired: true + defaultValue: None - name: add - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.update_metadata_dto_py3.UpdateMetadataDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.UpdateQnaDTOContext.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.UpdateQnaDTOContext.yml index 258888a1..1b7194f0 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.UpdateQnaDTOContext.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.UpdateQnaDTOContext.yml @@ -35,11 +35,11 @@ constructor: - keywordOnlyParameters: - name: prompts_to_delete - isRequired: true + defaultValue: None - name: prompts_to_add - isRequired: true + defaultValue: None - name: is_context_only - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_context_py3.UpdateQnaDTOContext.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.UpdateQnaDTOMetadata.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.UpdateQnaDTOMetadata.yml index b12a810c..e71088da 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.UpdateQnaDTOMetadata.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.UpdateQnaDTOMetadata.yml @@ -19,9 +19,9 @@ constructor: - [] keywordOnlyParameters: - name: delete - isRequired: true + defaultValue: None - name: add - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_metadata_py3.UpdateQnaDTOMetadata.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.UpdateQnaDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.UpdateQnaDTO.yml index 2152d03b..692886f3 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.UpdateQnaDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.UpdateQnaDTO.yml @@ -42,17 +42,17 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: answer - isRequired: true + defaultValue: None - name: source - isRequired: true + defaultValue: None - name: questions - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None - name: context - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_py3.UpdateQnaDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.UpdateQnaDTOQuestions.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.UpdateQnaDTOQuestions.yml index f8c40094..a68e74b6 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.UpdateQnaDTOQuestions.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.UpdateQnaDTOQuestions.yml @@ -19,9 +19,9 @@ constructor: - [] keywordOnlyParameters: - name: add - isRequired: true + defaultValue: None - name: delete - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.update_qna_dto_questions_py3.UpdateQnaDTOQuestions.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.UpdateQuestionsDTO.yml b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.UpdateQuestionsDTO.yml index 66481646..3e982ad3 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.UpdateQuestionsDTO.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-knowledge-qnamaker/azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.UpdateQuestionsDTO.yml @@ -21,9 +21,9 @@ constructor: - [] keywordOnlyParameters: - name: add - isRequired: true + defaultValue: None - name: delete - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.knowledge.qnamaker.models.update_questions_dto_py3.UpdateQuestionsDTO.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject.yml index f5027cf3..11f73769 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.AppVersionSettingObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject.yml index d7e01cf7..5b8eafe8 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject.yml @@ -56,13 +56,13 @@ constructor: - name: name isRequired: true - name: domain - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: initial_version_id - isRequired: true + defaultValue: None - name: usage_scenario - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationCreateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse.yml index 8f8a12c2..57828daf 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse.yml @@ -71,27 +71,27 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: culture - isRequired: true + defaultValue: None - name: usage_scenario - isRequired: true + defaultValue: None - name: domain - isRequired: true + defaultValue: None - name: versions_count - isRequired: true + defaultValue: None - name: created_date_time - isRequired: true + defaultValue: None - name: endpoints - isRequired: true + defaultValue: None - name: endpoint_hits_count - isRequired: true + defaultValue: None - name: active_version - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationInfoResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject.yml index 0bb1a4c9..3fe04e91 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject.yml @@ -22,9 +22,9 @@ constructor: - keywordOnlyParameters: - name: version_id - isRequired: true + defaultValue: None - name: is_staging - isRequired: true + defaultValue: 'False' methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationPublishObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject.yml index e74b08a6..18ffb9e2 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject.yml @@ -16,7 +16,7 @@ constructor: - keywordOnlyParameters: - name: is_public - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationSettingUpdateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject.yml index b95b8ac2..9893267c 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ApplicationUpdateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AvailableCulture.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AvailableCulture.yml index 61bb9d23..32c01dee 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AvailableCulture.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AvailableCulture.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: code - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.AvailableCulture.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel.yml index 76b7efb6..99411cf0 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel.yml @@ -25,11 +25,11 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: examples - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.AvailablePrebuiltEntityModel.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample.yml index c185d2e6..814601f0 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample.yml @@ -21,11 +21,11 @@ constructor: - keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: has_error - isRequired: true + defaultValue: None - name: error - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.BatchLabelExample.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ChildEntity.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ChildEntity.yml index 3396fc45..11e7d4f6 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ChildEntity.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ChildEntity.yml @@ -54,15 +54,15 @@ constructor: - name: id isRequired: true - name: name - isRequired: true + defaultValue: None - name: instance_of - isRequired: true + defaultValue: None - name: type_id - isRequired: true + defaultValue: None - name: readable_type - isRequired: true + defaultValue: None - name: children - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject.yml index 7d642e15..be837673 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject.yml @@ -25,11 +25,11 @@ constructor: - keywordOnlyParameters: - name: children - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: instance_of - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ChildEntityModelCreateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedList.yml index c3e69c54..7d425074 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedList.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedList.yml @@ -23,11 +23,11 @@ constructor: - [] keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: sub_lists - isRequired: true + defaultValue: None - name: roles - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ClosedList.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor.yml index d76c6db7..12ed77a0 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor.yml @@ -57,13 +57,13 @@ constructor: - name: readable_type isRequired: true - name: name - isRequired: true + defaultValue: None - name: type_id - isRequired: true + defaultValue: None - name: roles - isRequired: true + defaultValue: None - name: sub_lists - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListEntityExtractor.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject.yml index a09b73cb..20f4398f 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: sub_lists - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelCreateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject.yml index 72a507fd..e6dee3d2 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject.yml @@ -14,7 +14,7 @@ constructor: - [] keywordOnlyParameters: - name: sub_lists - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelPatchObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject.yml index c3d14a25..f485ff5c 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: sub_lists - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ClosedListModelUpdateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray.yml index bb6112e7..0f756841 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray.yml @@ -14,7 +14,7 @@ constructor: - [] keywordOnlyParameters: - name: emails - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.CollaboratorsArray.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject.yml index 1940695e..89e97aeb 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject.yml @@ -13,7 +13,7 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.CompositeChildModelCreateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor.yml index a66394ee..9201b63e 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor.yml @@ -57,13 +57,13 @@ constructor: - name: readable_type isRequired: true - name: name - isRequired: true + defaultValue: None - name: type_id - isRequired: true + defaultValue: None - name: roles - isRequired: true + defaultValue: None - name: children - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityExtractor.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel.yml index 435775c0..04193485 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: children - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.CompositeEntityModel.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel.yml index 93ff36dd..7fdc6b6d 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel.yml @@ -63,15 +63,15 @@ constructor: - name: readable_type isRequired: true - name: name - isRequired: true + defaultValue: None - name: type_id - isRequired: true + defaultValue: None - name: custom_prebuilt_domain_name - isRequired: true + defaultValue: None - name: custom_prebuilt_model_name - isRequired: true + defaultValue: None - name: roles - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.CustomPrebuiltModel.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EndpointInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EndpointInfo.yml index cde60b92..45379989 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EndpointInfo.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EndpointInfo.yml @@ -53,21 +53,21 @@ constructor: - keywordOnlyParameters: - name: version_id - isRequired: true + defaultValue: None - name: is_staging - isRequired: true + defaultValue: None - name: endpoint_url - isRequired: true + defaultValue: None - name: region - isRequired: true + defaultValue: None - name: assigned_endpoint_key - isRequired: true + defaultValue: None - name: endpoint_region - isRequired: true + defaultValue: None - name: failed_regions - isRequired: true + defaultValue: None - name: published_date_time - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.EndpointInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse.yml index 3aa90286..f43e7da3 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse.yml @@ -22,9 +22,9 @@ constructor: - keywordOnlyParameters: - name: status_id - isRequired: true + defaultValue: None - name: status - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.EnqueueTrainingResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample.yml index 715ea0a1..7a6c093f 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample.yml @@ -32,13 +32,13 @@ constructor: - [] keywordOnlyParameters: - name: text - isRequired: true + defaultValue: None - name: tokenized_text - isRequired: true + defaultValue: None - name: intent_predictions - isRequired: true + defaultValue: None - name: entity_predictions - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.EntitiesSuggestionExample.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityExtractor.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityExtractor.yml index 5ac12f82..b1189dcd 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityExtractor.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityExtractor.yml @@ -63,15 +63,15 @@ constructor: - name: readable_type isRequired: true - name: name - isRequired: true + defaultValue: None - name: type_id - isRequired: true + defaultValue: None - name: roles - isRequired: true + defaultValue: None - name: custom_prebuilt_domain_name - isRequired: true + defaultValue: None - name: custom_prebuilt_model_name - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.EntityExtractor.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityLabel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityLabel.yml index 6dd177d0..9b360d96 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityLabel.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityLabel.yml @@ -54,11 +54,11 @@ constructor: - name: end_token_index isRequired: true - name: role - isRequired: true + defaultValue: None - name: role_id - isRequired: true + defaultValue: None - name: children - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabel.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject.yml index 0ff3b77e..84177bcd 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject.yml @@ -50,9 +50,9 @@ constructor: - name: end_char_index isRequired: true - name: role - isRequired: true + defaultValue: None - name: children - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.EntityLabelObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject.yml index 537b7855..d2348cae 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: children - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelCreateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo.yml index 01a87c41..a2eb7490 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo.yml @@ -52,11 +52,11 @@ constructor: - name: readable_type isRequired: true - name: name - isRequired: true + defaultValue: None - name: type_id - isRequired: true + defaultValue: None - name: roles - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject.yml index a40f4039..13915760 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: instance_of - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.EntityModelUpdateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityPrediction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityPrediction.yml index 307eeb26..b83a37c4 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityPrediction.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityPrediction.yml @@ -49,7 +49,7 @@ constructor: - name: phrase isRequired: true - name: children - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.EntityPrediction.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRole.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRole.yml index 6f55d72e..616b4813 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRole.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRole.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.EntityRole.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject.yml index 8caab43c..45b6ec17 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleCreateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject.yml index f2669de6..a72a3685 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.EntityRoleUpdateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ErrorResponse.yml index a8e6dc30..bbef2383 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ErrorResponse.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ErrorResponse.yml @@ -20,9 +20,9 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: error_type - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ErrorResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject.yml index 0d5c3691..c007ab59 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject.yml @@ -29,11 +29,11 @@ constructor: - keywordOnlyParameters: - name: text - isRequired: true + defaultValue: None - name: entity_labels - isRequired: true + defaultValue: None - name: intent_name - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ExampleLabelObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem.yml index 5fc18d4a..d83bbd40 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: explicit_list_item - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItem.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject.yml index eaa1890b..2f12327a 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: explicit_list_item - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemCreateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject.yml index a3823a3f..db3fd2fa 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: explicit_list_item - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ExplicitListItemUpdateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject.yml index b5e7492b..3172b084 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject.yml @@ -32,13 +32,13 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: is_active - isRequired: true + defaultValue: None - name: enabled_for_all_models - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.FeatureInfoObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject.yml index 6ca01155..035afc4d 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject.yml @@ -18,9 +18,9 @@ constructor: - [] keywordOnlyParameters: - name: phraselist_features - isRequired: true + defaultValue: None - name: pattern_features - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.FeaturesResponseObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity.yml index 23b9fdcf..9a201021 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity.yml @@ -54,15 +54,15 @@ constructor: - name: id isRequired: true - name: name - isRequired: true + defaultValue: None - name: instance_of - isRequired: true + defaultValue: None - name: type_id - isRequired: true + defaultValue: None - name: readable_type - isRequired: true + defaultValue: None - name: children - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildEntity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject.yml index 2044c18c..35cbdc42 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject.yml @@ -13,7 +13,7 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalChildModelUpdateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor.yml index 563c0d88..b3a4fff2 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor.yml @@ -57,13 +57,13 @@ constructor: - name: readable_type isRequired: true - name: name - isRequired: true + defaultValue: None - name: type_id - isRequired: true + defaultValue: None - name: roles - isRequired: true + defaultValue: None - name: children - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalEntityExtractor.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel.yml index c3a3a472..d4172982 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel.yml @@ -30,15 +30,15 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: children - isRequired: true + defaultValue: None - name: features - isRequired: true + defaultValue: None - name: roles - isRequired: true + defaultValue: None - name: inherits - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModel.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2.yml index 0435949b..25eacf71 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2.yml @@ -26,13 +26,13 @@ constructor: - [] keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: children - isRequired: true + defaultValue: None - name: inherits - isRequired: true + defaultValue: None - name: roles - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.HierarchicalModelV2.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentClassifier.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentClassifier.yml index e9585fcd..1d65d811 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentClassifier.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentClassifier.yml @@ -59,13 +59,13 @@ constructor: - name: readable_type isRequired: true - name: name - isRequired: true + defaultValue: None - name: type_id - isRequired: true + defaultValue: None - name: custom_prebuilt_domain_name - isRequired: true + defaultValue: None - name: custom_prebuilt_model_name - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.IntentClassifier.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentPrediction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentPrediction.yml index 0a0813f8..5af3e028 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentPrediction.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentPrediction.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: score - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.IntentPrediction.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample.yml index 613162e1..731fb36e 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample.yml @@ -32,13 +32,13 @@ constructor: - [] keywordOnlyParameters: - name: text - isRequired: true + defaultValue: None - name: tokenized_text - isRequired: true + defaultValue: None - name: intent_predictions - isRequired: true + defaultValue: None - name: entity_predictions - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.IntentsSuggestionExample.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONEntity.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONEntity.yml index 9ae41a49..b220460e 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONEntity.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONEntity.yml @@ -47,9 +47,9 @@ constructor: - name: entity isRequired: true - name: role - isRequired: true + defaultValue: None - name: children - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.JSONEntity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature.yml index 68f0f995..ded9ec6f 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONModelFeature.yml @@ -53,13 +53,13 @@ constructor: - keywordOnlyParameters: - name: activated - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: words - isRequired: true + defaultValue: None - name: mode - isRequired: true + defaultValue: None - name: enabled_for_all_models defaultValue: 'True' methods: diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature.yml index a2ff46c2..3d5e7ab8 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature.yml @@ -25,11 +25,11 @@ constructor: - keywordOnlyParameters: - name: pattern - isRequired: true + defaultValue: None - name: activated - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.JSONRegexFeature.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONUtterance.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONUtterance.yml index bb3dd1b3..d1c28c21 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONUtterance.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JSONUtterance.yml @@ -24,11 +24,11 @@ constructor: - [] keywordOnlyParameters: - name: text - isRequired: true + defaultValue: None - name: intent - isRequired: true + defaultValue: None - name: entities - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.JSONUtterance.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JsonChild.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JsonChild.yml index a2a46367..468f81d1 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JsonChild.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JsonChild.yml @@ -26,13 +26,13 @@ constructor: - [] keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: instance_of - isRequired: true + defaultValue: None - name: children - isRequired: true + defaultValue: None - name: features - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.JsonChild.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation.yml index 3e2fb142..fe5e80e8 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation.yml @@ -23,9 +23,9 @@ constructor: - keywordOnlyParameters: - name: model_name - isRequired: true + defaultValue: None - name: feature_name - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.JsonModelFeatureInformation.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse.yml index b779a062..64e2ad04 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse.yml @@ -20,9 +20,9 @@ constructor: - keywordOnlyParameters: - name: utterance_text - isRequired: true + defaultValue: None - name: example_id - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.LabelExampleResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabelTextObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabelTextObject.yml index 172a65a5..de288ea9 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabelTextObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabelTextObject.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: text - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.LabelTextObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance.yml index 43c8f76b..65b9edcf 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance.yml @@ -48,19 +48,19 @@ constructor: - [] keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: text - isRequired: true + defaultValue: None - name: tokenized_text - isRequired: true + defaultValue: None - name: intent_label - isRequired: true + defaultValue: None - name: entity_labels - isRequired: true + defaultValue: None - name: intent_predictions - isRequired: true + defaultValue: None - name: entity_predictions - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.LabeledUtterance.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LuisApp.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LuisApp.yml index 1e3e8578..b258d40a 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LuisApp.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LuisApp.yml @@ -100,39 +100,39 @@ constructor: - [] keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: version_id - isRequired: true + defaultValue: None - name: desc - isRequired: true + defaultValue: None - name: culture - isRequired: true + defaultValue: None - name: intents - isRequired: true + defaultValue: None - name: entities - isRequired: true + defaultValue: None - name: closed_lists - isRequired: true + defaultValue: None - name: composites - isRequired: true + defaultValue: None - name: hierarchicals - isRequired: true + defaultValue: None - name: pattern_any_entities - isRequired: true + defaultValue: None - name: regex_entities - isRequired: true + defaultValue: None - name: prebuilt_entities - isRequired: true + defaultValue: None - name: regex_features - isRequired: true + defaultValue: None - name: phraselists - isRequired: true + defaultValue: None - name: patterns - isRequired: true + defaultValue: None - name: utterances - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.LuisApp.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LuisAppV2.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LuisAppV2.yml index 4fe07e6b..9874fa9f 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LuisAppV2.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.LuisAppV2.yml @@ -100,39 +100,39 @@ constructor: - [] keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: luis_schema_version - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: version_id - isRequired: true + defaultValue: None - name: desc - isRequired: true + defaultValue: None - name: culture - isRequired: true + defaultValue: None - name: intents - isRequired: true + defaultValue: None - name: entities - isRequired: true + defaultValue: None - name: closed_lists - isRequired: true + defaultValue: None - name: composites - isRequired: true + defaultValue: None - name: pattern_any_entities - isRequired: true + defaultValue: None - name: regex_entities - isRequired: true + defaultValue: None - name: prebuilt_entities - isRequired: true + defaultValue: None - name: regex_features - isRequired: true + defaultValue: None - name: model_features - isRequired: true + defaultValue: None - name: patterns - isRequired: true + defaultValue: None - name: utterances - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.LuisAppV2.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject.yml index 76a210ab..1a5ad00b 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ModelCreateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation.yml index ab28f5be..96b8f91c 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation.yml @@ -27,11 +27,11 @@ constructor: - keywordOnlyParameters: - name: model_name - isRequired: true + defaultValue: None - name: feature_name - isRequired: true + defaultValue: None - name: is_required - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ModelFeatureInformation.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelInfo.yml index 68512fc2..1aabeb78 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelInfo.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelInfo.yml @@ -48,9 +48,9 @@ constructor: - name: readable_type isRequired: true - name: name - isRequired: true + defaultValue: None - name: type_id - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse.yml index 537cd057..cf8c3a9c 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse.yml @@ -83,23 +83,23 @@ constructor: - name: readable_type isRequired: true - name: name - isRequired: true + defaultValue: None - name: type_id - isRequired: true + defaultValue: None - name: roles - isRequired: true + defaultValue: None - name: children - isRequired: true + defaultValue: None - name: sub_lists - isRequired: true + defaultValue: None - name: custom_prebuilt_domain_name - isRequired: true + defaultValue: None - name: custom_prebuilt_model_name - isRequired: true + defaultValue: None - name: regex_pattern - isRequired: true + defaultValue: None - name: explicit_list - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ModelInfoResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails.yml index fb37ccbe..542149ec 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails.yml @@ -38,15 +38,15 @@ constructor: - keywordOnlyParameters: - name: status_id - isRequired: true + defaultValue: None - name: status - isRequired: true + defaultValue: None - name: example_count - isRequired: true + defaultValue: None - name: training_date_time - isRequired: true + defaultValue: None - name: failure_reason - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingDetails.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo.yml index 7ee26d59..0ae0cc5a 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo.yml @@ -18,9 +18,9 @@ constructor: - keywordOnlyParameters: - name: model_id - isRequired: true + defaultValue: None - name: details - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ModelTrainingInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject.yml index ced69ac8..d277643d 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ModelUpdateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor.yml index cd9a1f6c..5e07286b 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor.yml @@ -67,17 +67,17 @@ constructor: - name: readable_type isRequired: true - name: name - isRequired: true + defaultValue: None - name: type_id - isRequired: true + defaultValue: None - name: roles - isRequired: true + defaultValue: None - name: custom_prebuilt_domain_name - isRequired: true + defaultValue: None - name: custom_prebuilt_model_name - isRequired: true + defaultValue: None - name: children - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.NDepthEntityExtractor.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.OperationError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.OperationError.yml index a989d682..c4bdd922 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.OperationError.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.OperationError.yml @@ -17,9 +17,9 @@ constructor: - keywordOnlyParameters: - name: code - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.OperationError.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.OperationStatus.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.OperationStatus.yml index e482dc3b..1b664526 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.OperationStatus.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.OperationStatus.yml @@ -22,9 +22,9 @@ constructor: - keywordOnlyParameters: - name: code - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.OperationStatus.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAny.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAny.yml index 2c79ad05..537bb762 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAny.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAny.yml @@ -21,11 +21,11 @@ constructor: - [] keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: explicit_list - isRequired: true + defaultValue: None - name: roles - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.PatternAny.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor.yml index dd0699a6..5577d4fd 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor.yml @@ -56,13 +56,13 @@ constructor: - name: readable_type isRequired: true - name: name - isRequired: true + defaultValue: None - name: type_id - isRequired: true + defaultValue: None - name: roles - isRequired: true + defaultValue: None - name: explicit_list - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyEntityExtractor.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject.yml index 32b60e22..cadcec7a 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject.yml @@ -19,9 +19,9 @@ constructor: - [] keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: explicit_list - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelCreateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject.yml index 087b94a3..a4d1eb6f 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject.yml @@ -19,9 +19,9 @@ constructor: - [] keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: explicit_list - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.PatternAnyModelUpdateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo.yml index 002dc8d0..85936cf3 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo.yml @@ -37,15 +37,15 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: is_active - isRequired: true + defaultValue: None - name: enabled_for_all_models - isRequired: true + defaultValue: None - name: pattern - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.PatternFeatureInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRule.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRule.yml index 1c47d692..a341cfe7 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRule.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRule.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: pattern - isRequired: true + defaultValue: None - name: intent - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.PatternRule.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject.yml index 7a629371..e31b8f1a 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: pattern - isRequired: true + defaultValue: None - name: intent - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleCreateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo.yml index 12ea6fa5..694db4f4 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo.yml @@ -25,11 +25,11 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: pattern - isRequired: true + defaultValue: None - name: intent - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject.yml index ce916aa3..8f917098 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject.yml @@ -25,11 +25,11 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: pattern - isRequired: true + defaultValue: None - name: intent - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.PatternRuleUpdateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse.yml index b2f7c2ba..14943bad 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse.yml @@ -19,9 +19,9 @@ constructor: - [, ] keywordOnlyParameters: - name: endpoint_keys - isRequired: true + defaultValue: None - name: endpoint_urls - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.PersonalAssistantsResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo.yml index aa26200f..e634cc2a 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo.yml @@ -63,17 +63,17 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: is_active - isRequired: true + defaultValue: None - name: enabled_for_all_models - isRequired: true + defaultValue: None - name: phrases - isRequired: true + defaultValue: None - name: is_exchangeable - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.PhraseListFeatureInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject.yml index d77407b3..8b510a74 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraselistCreateObject.yml @@ -48,9 +48,9 @@ constructor: - keywordOnlyParameters: - name: phrases - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: is_exchangeable defaultValue: 'True' - name: enabled_for_all_models diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject.yml index b305810e..7c7e845f 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PhraselistUpdateObject.yml @@ -62,9 +62,9 @@ constructor: - keywordOnlyParameters: - name: phrases - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: is_active defaultValue: 'True' - name: is_exchangeable diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain.yml index bffdbce4..a5fb8761 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain.yml @@ -34,17 +34,17 @@ constructor: - [] keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: culture - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: examples - isRequired: true + defaultValue: None - name: intents - isRequired: true + defaultValue: None - name: entities - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomain.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject.yml index 96b8f835..f56d5348 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject.yml @@ -16,7 +16,7 @@ constructor: - keywordOnlyParameters: - name: domain_name - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateBaseObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject.yml index c61ce221..2835e63b 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject.yml @@ -22,9 +22,9 @@ constructor: - keywordOnlyParameters: - name: domain_name - isRequired: true + defaultValue: None - name: culture - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainCreateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem.yml index af19f878..f5689c05 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem.yml @@ -22,11 +22,11 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: examples - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainItem.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject.yml index 46549b6e..e9265477 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject.yml @@ -22,9 +22,9 @@ constructor: - keywordOnlyParameters: - name: domain_name - isRequired: true + defaultValue: None - name: model_name - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainModelCreateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject.yml index 266f4f52..7cdabebd 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject.yml @@ -18,9 +18,9 @@ constructor: - keywordOnlyParameters: - name: domain_name - isRequired: true + defaultValue: None - name: model_name - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltDomainObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity.yml index 44f85c88..9b64ddad 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity.yml @@ -17,9 +17,9 @@ constructor: - [] keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: roles - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor.yml index b1f87234..89ceb187 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor.yml @@ -52,11 +52,11 @@ constructor: - name: readable_type isRequired: true - name: name - isRequired: true + defaultValue: None - name: type_id - isRequired: true + defaultValue: None - name: roles - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.PrebuiltEntityExtractor.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo.yml index 06e6d847..4206b816 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo.yml @@ -54,21 +54,21 @@ constructor: - keywordOnlyParameters: - name: version_id - isRequired: true + defaultValue: None - name: is_staging - isRequired: true + defaultValue: None - name: endpoint_url - isRequired: true + defaultValue: None - name: region - isRequired: true + defaultValue: None - name: assigned_endpoint_key - isRequired: true + defaultValue: None - name: endpoint_region - isRequired: true + defaultValue: None - name: failed_regions - isRequired: true + defaultValue: None - name: published_date_time - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.ProductionOrStagingEndpointInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject.yml index bc48ff17..dc71f7dd 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject.yml @@ -29,11 +29,11 @@ constructor: - keywordOnlyParameters: - name: sentiment_analysis - isRequired: true + defaultValue: None - name: speech - isRequired: true + defaultValue: None - name: spell_checker - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.PublishSettingUpdateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexEntity.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexEntity.yml index 3fbe6520..7516a303 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexEntity.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexEntity.yml @@ -22,11 +22,11 @@ constructor: - [] keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: regex_pattern - isRequired: true + defaultValue: None - name: roles - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor.yml index 5abc75c6..eeff0bfe 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor.yml @@ -57,13 +57,13 @@ constructor: - name: readable_type isRequired: true - name: name - isRequired: true + defaultValue: None - name: type_id - isRequired: true + defaultValue: None - name: roles - isRequired: true + defaultValue: None - name: regex_pattern - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.RegexEntityExtractor.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject.yml index 011feae3..a95d8489 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject.yml @@ -20,9 +20,9 @@ constructor: - keywordOnlyParameters: - name: regex_pattern - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelCreateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject.yml index a34a501c..d8b931c9 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject.yml @@ -20,9 +20,9 @@ constructor: - keywordOnlyParameters: - name: regex_pattern - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.RegexModelUpdateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.SubClosedList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.SubClosedList.yml index 84053432..0b138cde 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.SubClosedList.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.SubClosedList.yml @@ -19,9 +19,9 @@ constructor: - [] keywordOnlyParameters: - name: canonical_form - isRequired: true + defaultValue: None - name: list - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedList.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse.yml index 6a12a7a2..384a59be 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse.yml @@ -25,11 +25,11 @@ constructor: - keywordOnlyParameters: - name: canonical_form - isRequired: true + defaultValue: None - name: list - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.SubClosedListResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject.yml index 220313ed..be1fa09a 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: version - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.TaskUpdateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.UserAccessList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.UserAccessList.yml index 60780fed..9e98804b 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.UserAccessList.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.UserAccessList.yml @@ -18,9 +18,9 @@ constructor: - [] keywordOnlyParameters: - name: owner - isRequired: true + defaultValue: None - name: emails - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.UserAccessList.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.UserCollaborator.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.UserCollaborator.yml index 09f599b0..488bcb58 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.UserCollaborator.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.UserCollaborator.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: email - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.UserCollaborator.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.VersionInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.VersionInfo.yml index ecbdc3f0..27ebec83 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.VersionInfo.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.VersionInfo.yml @@ -84,25 +84,25 @@ constructor: - name: training_status isRequired: true - name: created_date_time - isRequired: true + defaultValue: None - name: last_modified_date_time - isRequired: true + defaultValue: None - name: last_trained_date_time - isRequired: true + defaultValue: None - name: last_published_date_time - isRequired: true + defaultValue: None - name: endpoint_url - isRequired: true + defaultValue: None - name: assigned_endpoint_key - isRequired: true + defaultValue: None - name: external_api_keys - isRequired: true + defaultValue: None - name: intents_count - isRequired: true + defaultValue: None - name: entities_count - isRequired: true + defaultValue: None - name: endpoint_hits_count - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.VersionInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject.yml index 48abccf3..b38b5176 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject.yml @@ -19,9 +19,9 @@ constructor: - [] keywordOnlyParameters: - name: canonical_form - isRequired: true + defaultValue: None - name: list - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.WordListBaseUpdateObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.WordListObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.WordListObject.yml index de595c27..ebf02b10 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.WordListObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.authoring.models.WordListObject.yml @@ -19,9 +19,9 @@ constructor: - [] keywordOnlyParameters: - name: canonical_form - isRequired: true + defaultValue: None - name: list - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.authoring.models.WordListObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.ExternalEntity.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.ExternalEntity.yml index 57915c67..6881aa22 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.ExternalEntity.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.ExternalEntity.yml @@ -50,9 +50,9 @@ constructor: - name: entity_length isRequired: true - name: resolution - isRequired: true + defaultValue: None - name: score - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.runtime.models.ExternalEntity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Intent.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Intent.yml index 2f4754b2..7b1bbd04 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Intent.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Intent.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: score - isRequired: true + defaultValue: None - name: child_app - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.runtime.models.Intent.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Prediction.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Prediction.yml index 95730fb5..45374160 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Prediction.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Prediction.yml @@ -50,9 +50,9 @@ constructor: - name: entities isRequired: true - name: altered_query - isRequired: true + defaultValue: None - name: sentiment - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.runtime.models.Prediction.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.PredictionRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.PredictionRequest.yml index c77fb09e..80a96d20 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.PredictionRequest.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.PredictionRequest.yml @@ -39,11 +39,11 @@ constructor: - name: query isRequired: true - name: options - isRequired: true + defaultValue: None - name: external_entities - isRequired: true + defaultValue: None - name: dynamic_lists - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions.yml index 1061827f..d81772f4 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions.yml @@ -24,9 +24,9 @@ constructor: - keywordOnlyParameters: - name: datetime_reference - isRequired: true + defaultValue: None - name: prefer_external_entities - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.runtime.models.PredictionRequestOptions.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.RequestList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.RequestList.yml index a6bc7954..3e0f4308 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.RequestList.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.RequestList.yml @@ -29,9 +29,9 @@ constructor: - name: canonical_form isRequired: true - name: name - isRequired: true + defaultValue: None - name: synonyms - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.runtime.models.RequestList.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Sentiment.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Sentiment.yml index ea876468..23c53e06 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Sentiment.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-luis/azure.cognitiveservices.language.luis.runtime.models.Sentiment.yml @@ -24,7 +24,7 @@ constructor: - name: score isRequired: true - name: label - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.luis.runtime.models.Sentiment.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.DetectedLanguage.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.DetectedLanguage.yml index 32edc585..fd84b2dc 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.DetectedLanguage.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.DetectedLanguage.yml @@ -29,11 +29,11 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: iso6391_name - isRequired: true + defaultValue: None - name: score - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.DetectedLanguage.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.DocumentStatistics.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.DocumentStatistics.yml index d5892ad6..eff106ad 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.DocumentStatistics.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.DocumentStatistics.yml @@ -22,9 +22,9 @@ constructor: - keywordOnlyParameters: - name: characters_count - isRequired: true + defaultValue: None - name: transactions_count - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.DocumentStatistics.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResultItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResultItem.yml index 0ab86065..27bad1f3 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResultItem.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.EntitiesBatchResultItem.yml @@ -26,9 +26,9 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: statistics - isRequired: true + defaultValue: None variables: - description: Recognized entities in the document. name: entities diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.EntityRecord.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.EntityRecord.yml index 31074f89..56496657 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.EntityRecord.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.EntityRecord.yml @@ -57,19 +57,19 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: matches - isRequired: true + defaultValue: None - name: wikipedia_language - isRequired: true + defaultValue: None - name: wikipedia_id - isRequired: true + defaultValue: None - name: bing_id - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None - name: sub_type - isRequired: true + defaultValue: None variables: - description: URL for the entity's Wikipedia page. name: wikipedia_url diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.ErrorRecord.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.ErrorRecord.yml index 4dde016b..b6e3d15e 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.ErrorRecord.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.ErrorRecord.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.ErrorRecord.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.ErrorResponse.yml index c1b42042..4bca96c6 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.ErrorResponse.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.ErrorResponse.yml @@ -26,13 +26,13 @@ constructor: - keywordOnlyParameters: - name: code - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None - name: target - isRequired: true + defaultValue: None - name: inner_error - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.ErrorResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.InternalError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.InternalError.yml index fdc654e8..c5eff028 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.InternalError.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.InternalError.yml @@ -22,11 +22,11 @@ constructor: - keywordOnlyParameters: - name: code - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None - name: inner_error - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.InternalError.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResultItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResultItem.yml index 307e2316..818e65a7 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResultItem.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.KeyPhraseBatchResultItem.yml @@ -26,9 +26,9 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: statistics - isRequired: true + defaultValue: None variables: - description: 'A list of representative words or phrases. The number diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageBatchInput.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageBatchInput.yml index 41d2c896..b4515882 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageBatchInput.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageBatchInput.yml @@ -13,7 +13,7 @@ constructor: - [] keywordOnlyParameters: - name: documents - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchInput.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageBatchResultItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageBatchResultItem.yml index 216a623d..5dfa1c79 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageBatchResultItem.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageBatchResultItem.yml @@ -27,11 +27,11 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: detected_languages - isRequired: true + defaultValue: None - name: statistics - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.LanguageBatchResultItem.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageInput.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageInput.yml index b04e716a..d0479ec5 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageInput.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.LanguageInput.yml @@ -23,11 +23,11 @@ constructor: - keywordOnlyParameters: - name: country_hint - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: text - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.LanguageInput.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MatchRecord.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MatchRecord.yml index 076077c1..25c62e54 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MatchRecord.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MatchRecord.yml @@ -45,15 +45,15 @@ constructor: - keywordOnlyParameters: - name: wikipedia_score - isRequired: true + defaultValue: None - name: entity_type_score - isRequired: true + defaultValue: None - name: text - isRequired: true + defaultValue: None - name: offset - isRequired: true + defaultValue: None - name: length - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.MatchRecord.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MultiLanguageBatchInput.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MultiLanguageBatchInput.yml index db3b54cd..7619d5ef 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MultiLanguageBatchInput.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MultiLanguageBatchInput.yml @@ -13,7 +13,7 @@ constructor: - [] keywordOnlyParameters: - name: documents - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.MultiLanguageBatchInput.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MultiLanguageInput.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MultiLanguageInput.yml index 9005a8dd..e0c50a5d 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MultiLanguageInput.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.MultiLanguageInput.yml @@ -26,11 +26,11 @@ constructor: - keywordOnlyParameters: - name: language - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: text - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.MultiLanguageInput.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.RequestStatistics.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.RequestStatistics.yml index 789dceb5..8f486eca 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.RequestStatistics.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.RequestStatistics.yml @@ -35,13 +35,13 @@ constructor: - keywordOnlyParameters: - name: documents_count - isRequired: true + defaultValue: None - name: valid_documents_count - isRequired: true + defaultValue: None - name: erroneous_documents_count - isRequired: true + defaultValue: None - name: transactions_count - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.RequestStatistics.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.SentimentBatchResultItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.SentimentBatchResultItem.yml index 8c646f5e..28ff87c8 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.SentimentBatchResultItem.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.SentimentBatchResultItem.yml @@ -33,11 +33,11 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: score - isRequired: true + defaultValue: None - name: statistics - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.SentimentBatchResultItem.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.detected_language_py3.DetectedLanguage.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.detected_language_py3.DetectedLanguage.yml index 49f9dfc3..77780ffc 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.detected_language_py3.DetectedLanguage.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.detected_language_py3.DetectedLanguage.yml @@ -29,11 +29,11 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: iso6391_name - isRequired: true + defaultValue: None - name: score - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.detected_language_py3.DetectedLanguage.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.DocumentStatistics.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.DocumentStatistics.yml index 47d4ecfa..b458b0ef 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.DocumentStatistics.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.DocumentStatistics.yml @@ -22,9 +22,9 @@ constructor: - keywordOnlyParameters: - name: characters_count - isRequired: true + defaultValue: None - name: transactions_count - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.document_statistics_py3.DocumentStatistics.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3.EntitiesBatchResultItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3.EntitiesBatchResultItem.yml index c091fcc5..60332016 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3.EntitiesBatchResultItem.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entities_batch_result_item_py3.EntitiesBatchResultItem.yml @@ -26,9 +26,9 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: statistics - isRequired: true + defaultValue: None variables: - description: Recognized entities in the document. name: entities diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entity_record_py3.EntityRecord.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entity_record_py3.EntityRecord.yml index 80d133de..73c2f288 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entity_record_py3.EntityRecord.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.entity_record_py3.EntityRecord.yml @@ -57,19 +57,19 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: matches - isRequired: true + defaultValue: None - name: wikipedia_language - isRequired: true + defaultValue: None - name: wikipedia_id - isRequired: true + defaultValue: None - name: bing_id - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None - name: sub_type - isRequired: true + defaultValue: None variables: - description: URL for the entity's Wikipedia page. name: wikipedia_url diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_record_py3.ErrorRecord.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_record_py3.ErrorRecord.yml index 17e20459..e2eb33d9 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_record_py3.ErrorRecord.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_record_py3.ErrorRecord.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.error_record_py3.ErrorRecord.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponse.yml index c287c665..f47d500a 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponse.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponse.yml @@ -26,13 +26,13 @@ constructor: - keywordOnlyParameters: - name: code - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None - name: target - isRequired: true + defaultValue: None - name: inner_error - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.error_response_py3.ErrorResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.internal_error_py3.InternalError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.internal_error_py3.InternalError.yml index c329fb98..8c45e1c7 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.internal_error_py3.InternalError.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.internal_error_py3.InternalError.yml @@ -22,11 +22,11 @@ constructor: - keywordOnlyParameters: - name: code - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None - name: inner_error - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.internal_error_py3.InternalError.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3.KeyPhraseBatchResultItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3.KeyPhraseBatchResultItem.yml index ae2092a3..8f7ae75c 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3.KeyPhraseBatchResultItem.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.key_phrase_batch_result_item_py3.KeyPhraseBatchResultItem.yml @@ -26,9 +26,9 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: statistics - isRequired: true + defaultValue: None variables: - description: 'A list of representative words or phrases. The number diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.LanguageBatchInput.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.LanguageBatchInput.yml index eb3a5836..32067eda 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.LanguageBatchInput.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.LanguageBatchInput.yml @@ -13,7 +13,7 @@ constructor: - [] keywordOnlyParameters: - name: documents - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.language_batch_input_py3.LanguageBatchInput.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.LanguageBatchResultItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.LanguageBatchResultItem.yml index e124626b..ff86f1d5 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.LanguageBatchResultItem.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.LanguageBatchResultItem.yml @@ -27,11 +27,11 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: detected_languages - isRequired: true + defaultValue: None - name: statistics - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.language_batch_result_item_py3.LanguageBatchResultItem.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_input_py3.LanguageInput.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_input_py3.LanguageInput.yml index dad6c2f5..98359689 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_input_py3.LanguageInput.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.language_input_py3.LanguageInput.yml @@ -23,11 +23,11 @@ constructor: - keywordOnlyParameters: - name: country_hint - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: text - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.language_input_py3.LanguageInput.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.match_record_py3.MatchRecord.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.match_record_py3.MatchRecord.yml index 0fa1eff4..5e1d70c0 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.match_record_py3.MatchRecord.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.match_record_py3.MatchRecord.yml @@ -45,15 +45,15 @@ constructor: - keywordOnlyParameters: - name: wikipedia_score - isRequired: true + defaultValue: None - name: entity_type_score - isRequired: true + defaultValue: None - name: text - isRequired: true + defaultValue: None - name: offset - isRequired: true + defaultValue: None - name: length - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.match_record_py3.MatchRecord.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.MultiLanguageBatchInput.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.MultiLanguageBatchInput.yml index 0ee6b123..2505e866 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.MultiLanguageBatchInput.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.MultiLanguageBatchInput.yml @@ -13,7 +13,7 @@ constructor: - [] keywordOnlyParameters: - name: documents - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.multi_language_batch_input_py3.MultiLanguageBatchInput.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.MultiLanguageInput.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.MultiLanguageInput.yml index 4a29e8bb..1af9d8fc 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.MultiLanguageInput.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.MultiLanguageInput.yml @@ -26,11 +26,11 @@ constructor: - keywordOnlyParameters: - name: language - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: text - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.multi_language_input_py3.MultiLanguageInput.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.RequestStatistics.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.RequestStatistics.yml index e316eb4c..dd7f7bbc 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.RequestStatistics.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.RequestStatistics.yml @@ -35,13 +35,13 @@ constructor: - keywordOnlyParameters: - name: documents_count - isRequired: true + defaultValue: None - name: valid_documents_count - isRequired: true + defaultValue: None - name: erroneous_documents_count - isRequired: true + defaultValue: None - name: transactions_count - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.request_statistics_py3.RequestStatistics.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.SentimentBatchResultItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.SentimentBatchResultItem.yml index e129ede6..2abcfdc3 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.SentimentBatchResultItem.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-language-textanalytics/azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.SentimentBatchResultItem.yml @@ -33,11 +33,11 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: score - isRequired: true + defaultValue: None - name: statistics - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.language.textanalytics.models.sentiment_batch_result_item_py3.SentimentBatchResultItem.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Filters(class).yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Filters(class).yml index 601ef41f..a628000d 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Filters(class).yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.Filters(class).yml @@ -19,7 +19,7 @@ constructor: - keywordOnlyParameters: - name: site - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.search.visualsearch.models.Filters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageInfo.yml index 6fc288e4..31aca8c7 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageInfo.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.ImageInfo.yml @@ -57,11 +57,11 @@ constructor: - keywordOnlyParameters: - name: image_insights_token - isRequired: true + defaultValue: None - name: url - isRequired: true + defaultValue: None - name: crop_area - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.search.visualsearch.models.ImageInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.KnowledgeRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.KnowledgeRequest.yml index 7751db74..e93dfae3 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.KnowledgeRequest.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.KnowledgeRequest.yml @@ -19,7 +19,7 @@ constructor: - keywordOnlyParameters: - name: filters - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.search.visualsearch.models.KnowledgeRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.VisualSearchRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.VisualSearchRequest.yml index 55449699..e7b652d0 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.VisualSearchRequest.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.VisualSearchRequest.yml @@ -26,9 +26,9 @@ constructor: - keywordOnlyParameters: - name: image_info - isRequired: true + defaultValue: None - name: knowledge_request - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.search.visualsearch.models.VisualSearchRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.filters_py3.Filters.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.filters_py3.Filters.yml index e6fb1551..06549215 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.filters_py3.Filters.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.filters_py3.Filters.yml @@ -19,7 +19,7 @@ constructor: - keywordOnlyParameters: - name: site - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.search.visualsearch.models.filters_py3.Filters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_info_py3.ImageInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_info_py3.ImageInfo.yml index a39956e1..bbe26195 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_info_py3.ImageInfo.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.image_info_py3.ImageInfo.yml @@ -57,11 +57,11 @@ constructor: - keywordOnlyParameters: - name: image_insights_token - isRequired: true + defaultValue: None - name: url - isRequired: true + defaultValue: None - name: crop_area - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.search.visualsearch.models.image_info_py3.ImageInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.KnowledgeRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.KnowledgeRequest.yml index 113ef44d..4a727582 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.KnowledgeRequest.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.KnowledgeRequest.yml @@ -19,7 +19,7 @@ constructor: - keywordOnlyParameters: - name: filters - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.search.visualsearch.models.knowledge_request_py3.KnowledgeRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.VisualSearchRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.VisualSearchRequest.yml index 51fbd750..b0b3ded7 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.VisualSearchRequest.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-search-visualsearch/azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.VisualSearchRequest.yml @@ -26,9 +26,9 @@ constructor: - keywordOnlyParameters: - name: image_info - isRequired: true + defaultValue: None - name: knowledge_request - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.search.visualsearch.models.visual_search_request_py3.VisualSearchRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.AdultInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.AdultInfo.yml index 1765fcba..a67839f7 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.AdultInfo.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.AdultInfo.yml @@ -49,17 +49,17 @@ constructor: - keywordOnlyParameters: - name: is_adult_content - isRequired: true + defaultValue: None - name: is_racy_content - isRequired: true + defaultValue: None - name: is_gory_content - isRequired: true + defaultValue: None - name: adult_score - isRequired: true + defaultValue: None - name: racy_score - isRequired: true + defaultValue: None - name: gore_score - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.AdultInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.AreaOfInterestResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.AreaOfInterestResult.yml index a1e97f5b..3a987c4b 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.AreaOfInterestResult.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.AreaOfInterestResult.yml @@ -28,11 +28,11 @@ constructor: - keywordOnlyParameters: - name: request_id - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None - name: model_version - isRequired: true + defaultValue: None variables: - description: 'A bounding box for an area of interest inside an diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.BoundingRect.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.BoundingRect.yml index ab910eac..f15e72e1 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.BoundingRect.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.BoundingRect.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: x - isRequired: true + defaultValue: None - name: y - isRequired: true + defaultValue: None - name: w - isRequired: true + defaultValue: None - name: h - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.BoundingRect.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Category.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Category.yml index 61977d3f..fe96924e 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Category.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Category.yml @@ -24,11 +24,11 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: score - isRequired: true + defaultValue: None - name: detail - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.Category.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.CategoryDetail.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.CategoryDetail.yml index 036fc249..5f69abee 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.CategoryDetail.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.CategoryDetail.yml @@ -19,9 +19,9 @@ constructor: - [] keywordOnlyParameters: - name: celebrities - isRequired: true + defaultValue: None - name: landmarks - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.CategoryDetail.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.CelebritiesModel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.CelebritiesModel.yml index dcef0f01..3a608648 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.CelebritiesModel.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.CelebritiesModel.yml @@ -27,11 +27,11 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: confidence - isRequired: true + defaultValue: None - name: face_rectangle - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.CelebritiesModel.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ColorInfo.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ColorInfo.yml index 149d1ecc..0fe0c700 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ColorInfo.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ColorInfo.yml @@ -36,15 +36,15 @@ constructor: - keywordOnlyParameters: - name: dominant_color_foreground - isRequired: true + defaultValue: None - name: dominant_color_background - isRequired: true + defaultValue: None - name: dominant_colors - isRequired: true + defaultValue: None - name: accent_color - isRequired: true + defaultValue: None - name: is_bw_img - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.ColorInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionError.yml index 9ea819d6..52774a9c 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionError.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionError.yml @@ -38,7 +38,7 @@ constructor: - name: message isRequired: true - name: innererror - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionError.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrError.yml index 04c780e3..41271907 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrError.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrError.yml @@ -33,7 +33,7 @@ constructor: - name: message isRequired: true - name: request_id - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.ComputerVisionOcrError.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DetectResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DetectResult.yml index a0d24240..56a099f4 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DetectResult.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DetectResult.yml @@ -28,11 +28,11 @@ constructor: - keywordOnlyParameters: - name: request_id - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None - name: model_version - isRequired: true + defaultValue: None variables: - description: An array of detected objects. name: objects diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DetectedObject.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DetectedObject.yml index d0d3f1e5..fb84fbfb 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DetectedObject.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DetectedObject.yml @@ -36,11 +36,11 @@ constructor: - keywordOnlyParameters: - name: object_property - isRequired: true + defaultValue: None - name: confidence - isRequired: true + defaultValue: None - name: parent - isRequired: true + defaultValue: None variables: - description: Approximate location of the detected object. name: rectangle diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DomainModelResults.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DomainModelResults.yml index 241fcc01..716b1a4f 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DomainModelResults.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.DomainModelResults.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: result - isRequired: true + defaultValue: None - name: request_id - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None - name: model_version - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.DomainModelResults.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.FaceDescription.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.FaceDescription.yml index 8c98274b..be0b2c1f 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.FaceDescription.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.FaceDescription.yml @@ -29,11 +29,11 @@ constructor: - keywordOnlyParameters: - name: age - isRequired: true + defaultValue: None - name: gender - isRequired: true + defaultValue: None - name: face_rectangle - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.FaceDescription.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.FaceRectangle.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.FaceRectangle.yml index 781c74ae..ffe13d25 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.FaceRectangle.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.FaceRectangle.yml @@ -34,13 +34,13 @@ constructor: - keywordOnlyParameters: - name: left - isRequired: true + defaultValue: None - name: top - isRequired: true + defaultValue: None - name: width - isRequired: true + defaultValue: None - name: height - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.FaceRectangle.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageAnalysis.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageAnalysis.yml index 3ee0587d..77bdade0 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageAnalysis.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageAnalysis.yml @@ -79,29 +79,29 @@ constructor: - keywordOnlyParameters: - name: categories - isRequired: true + defaultValue: None - name: adult - isRequired: true + defaultValue: None - name: color - isRequired: true + defaultValue: None - name: image_type - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: faces - isRequired: true + defaultValue: None - name: objects - isRequired: true + defaultValue: None - name: brands - isRequired: true + defaultValue: None - name: request_id - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None - name: model_version - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.ImageAnalysis.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageCaption.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageCaption.yml index 18edd59b..342d5384 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageCaption.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageCaption.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: text - isRequired: true + defaultValue: None - name: confidence - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.ImageCaption.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageDescription.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageDescription.yml index 0387505d..d36aba08 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageDescription.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageDescription.yml @@ -35,15 +35,15 @@ constructor: - keywordOnlyParameters: - name: tags - isRequired: true + defaultValue: None - name: captions - isRequired: true + defaultValue: None - name: request_id - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None - name: model_version - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.ImageDescription.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageDescriptionDetails.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageDescriptionDetails.yml index f4a2fe19..67f21136 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageDescriptionDetails.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageDescriptionDetails.yml @@ -21,9 +21,9 @@ constructor: - [] keywordOnlyParameters: - name: tags - isRequired: true + defaultValue: None - name: captions - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.ImageDescriptionDetails.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageMetadata.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageMetadata.yml index b8c8e4ec..52c41bc9 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageMetadata.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageMetadata.yml @@ -25,11 +25,11 @@ constructor: - keywordOnlyParameters: - name: width - isRequired: true + defaultValue: None - name: height - isRequired: true + defaultValue: None - name: format - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.ImageMetadata.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageTag.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageTag.yml index 1d069c81..60066394 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageTag.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageTag.yml @@ -25,11 +25,11 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: confidence - isRequired: true + defaultValue: None - name: hint - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.ImageTag.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageType.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageType.yml index 012c94e3..5f2cc28e 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageType.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ImageType.yml @@ -22,9 +22,9 @@ constructor: - keywordOnlyParameters: - name: clip_art_type - isRequired: true + defaultValue: None - name: line_drawing_type - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.ImageType.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.LandmarksModel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.LandmarksModel.yml index 0ab3c2df..299aafb2 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.LandmarksModel.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.LandmarksModel.yml @@ -21,9 +21,9 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: confidence - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.LandmarksModel.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Line.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Line.yml index 01c404d6..82f1ee76 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Line.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.Line.yml @@ -46,9 +46,9 @@ constructor: - name: words isRequired: true - name: language - isRequired: true + defaultValue: None - name: appearance - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.Line.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ModelDescription.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ModelDescription.yml index e1b6bf19..e7d8b45f 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ModelDescription.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ModelDescription.yml @@ -19,9 +19,9 @@ constructor: - [] keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: categories - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.ModelDescription.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ObjectHierarchy.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ObjectHierarchy.yml index d681c2c3..cceb28f9 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ObjectHierarchy.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ObjectHierarchy.yml @@ -31,11 +31,11 @@ constructor: - keywordOnlyParameters: - name: object_property - isRequired: true + defaultValue: None - name: confidence - isRequired: true + defaultValue: None - name: parent - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.ObjectHierarchy.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrLine.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrLine.yml index 2ebadad8..95399b56 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrLine.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrLine.yml @@ -31,9 +31,9 @@ constructor: - [] keywordOnlyParameters: - name: bounding_box - isRequired: true + defaultValue: None - name: words - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.OcrLine.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrRegion.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrRegion.yml index c013396d..56e9a5e0 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrRegion.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrRegion.yml @@ -31,9 +31,9 @@ constructor: - [] keywordOnlyParameters: - name: bounding_box - isRequired: true + defaultValue: None - name: lines - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.OcrRegion.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrResult.yml index ca8e31b9..12829c6d 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrResult.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrResult.yml @@ -66,15 +66,15 @@ constructor: - keywordOnlyParameters: - name: language - isRequired: true + defaultValue: None - name: text_angle - isRequired: true + defaultValue: None - name: orientation - isRequired: true + defaultValue: None - name: regions - isRequired: true + defaultValue: None - name: model_version - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.OcrResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrWord.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrWord.yml index 9d54e79f..bc9172b5 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrWord.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.OcrWord.yml @@ -29,9 +29,9 @@ constructor: - keywordOnlyParameters: - name: bounding_box - isRequired: true + defaultValue: None - name: text - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.OcrWord.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ReadOperationResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ReadOperationResult.yml index ba27f794..494f9de7 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ReadOperationResult.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ReadOperationResult.yml @@ -37,13 +37,13 @@ constructor: - keywordOnlyParameters: - name: status - isRequired: true + defaultValue: None - name: created_date_time - isRequired: true + defaultValue: None - name: last_updated_date_time - isRequired: true + defaultValue: None - name: analyze_result - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.ReadOperationResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ReadResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ReadResult.yml index 02c3e846..7d74aafc 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ReadResult.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.ReadResult.yml @@ -71,7 +71,7 @@ constructor: - name: lines isRequired: true - name: language - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.ReadResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.TagResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.TagResult.yml index a9867a3e..0f67cd43 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.TagResult.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-computervision/azure.cognitiveservices.vision.computervision.models.TagResult.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: tags - isRequired: true + defaultValue: None - name: request_id - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None - name: model_version - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.computervision.models.TagResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.APIError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.APIError.yml index b838f8eb..bdeae2ae 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.APIError.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.APIError.yml @@ -13,7 +13,7 @@ constructor: - keywordOnlyParameters: - name: error - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.APIError.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Address.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Address.yml index 60973e93..a21fcb14 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Address.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Address.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: text - isRequired: true + defaultValue: None - name: index - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.Address.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Body.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Body.yml index 1a2688e8..bd00301f 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Body.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Body.yml @@ -24,11 +24,11 @@ constructor: - [, ] keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.Body.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.BodyModel.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.BodyModel.yml index 3c8ad6e5..8000701d 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.BodyModel.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.BodyModel.yml @@ -20,7 +20,7 @@ constructor: - name: data_representation defaultValue: URL - name: value - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.BodyModel.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Candidate.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Candidate.yml index bc97f7e4..948b4a23 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Candidate.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Candidate.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: text - isRequired: true + defaultValue: None - name: confidence - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.Candidate.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Classification.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Classification.yml index 4b34234d..1baed381 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Classification.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Classification.yml @@ -45,13 +45,13 @@ constructor: - keywordOnlyParameters: - name: category1 - isRequired: true + defaultValue: None - name: category2 - isRequired: true + defaultValue: None - name: category3 - isRequired: true + defaultValue: None - name: review_recommended - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.Classification.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory1.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory1.yml index 05b9d1f7..5795e072 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory1.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory1.yml @@ -19,7 +19,7 @@ constructor: - keywordOnlyParameters: - name: score - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory1.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory2.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory2.yml index af7365dd..fc2fcbe2 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory2.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory2.yml @@ -19,7 +19,7 @@ constructor: - keywordOnlyParameters: - name: score - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory2.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory3.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory3.yml index 4124fa1c..be51d7bb 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory3.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory3.yml @@ -19,7 +19,7 @@ constructor: - keywordOnlyParameters: - name: score - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.ClassificationCategory3.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItem.yml index 446e051a..22d95336 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItem.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItem.yml @@ -47,9 +47,9 @@ constructor: - name: content_id isRequired: true - name: callback_endpoint - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.CreateReviewBodyItem.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItem.yml index 87e24502..97c9fed5 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItem.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItem.yml @@ -64,13 +64,13 @@ constructor: - name: status isRequired: true - name: video_frames - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None - name: timescale - isRequired: true + defaultValue: None - name: callback_endpoint - isRequired: true + defaultValue: None variables: - description: 'Required. Type of the content. Default value: "Video" .' name: type diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItem.yml index 713fe9a2..5e083879 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItem.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItem.yml @@ -43,9 +43,9 @@ constructor: - name: frame_image isRequired: true - name: reviewer_result_tags - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.CreateVideoReviewsBodyItemVideoFramesItem.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.DetectedLanguage.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.DetectedLanguage.yml index 01265458..5fc77abe 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.DetectedLanguage.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.DetectedLanguage.yml @@ -25,11 +25,11 @@ constructor: - keywordOnlyParameters: - name: detected_language - isRequired: true + defaultValue: None - name: status - isRequired: true + defaultValue: None - name: tracking_id - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.DetectedLanguage.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.DetectedTerms.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.DetectedTerms.yml index 7e680983..ce3ac813 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.DetectedTerms.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.DetectedTerms.yml @@ -34,13 +34,13 @@ constructor: - keywordOnlyParameters: - name: index - isRequired: true + defaultValue: None - name: original_index - isRequired: true + defaultValue: None - name: list_id - isRequired: true + defaultValue: None - name: term - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.DetectedTerms.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Email.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Email.yml index be081c38..a71f875a 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Email.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Email.yml @@ -32,13 +32,13 @@ constructor: - keywordOnlyParameters: - name: detected - isRequired: true + defaultValue: None - name: sub_type - isRequired: true + defaultValue: None - name: text - isRequired: true + defaultValue: None - name: index - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.Email.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Error.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Error.yml index ec9c4877..092c3509 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Error.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Error.yml @@ -17,9 +17,9 @@ constructor: - keywordOnlyParameters: - name: code - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.Error.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Evaluate.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Evaluate.yml index a36f56dd..497825e0 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Evaluate.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Evaluate.yml @@ -61,23 +61,23 @@ constructor: - keywordOnlyParameters: - name: cache_id - isRequired: true + defaultValue: None - name: result - isRequired: true + defaultValue: None - name: tracking_id - isRequired: true + defaultValue: None - name: adult_classification_score - isRequired: true + defaultValue: None - name: is_image_adult_classified - isRequired: true + defaultValue: None - name: racy_classification_score - isRequired: true + defaultValue: None - name: is_image_racy_classified - isRequired: true + defaultValue: None - name: advanced_info - isRequired: true + defaultValue: None - name: status - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.Evaluate.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Face.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Face.yml index 552f244a..c5ec77ad 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Face.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Face.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: bottom - isRequired: true + defaultValue: None - name: left - isRequired: true + defaultValue: None - name: right - isRequired: true + defaultValue: None - name: top - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.Face.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.FoundFaces.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.FoundFaces.yml index 1e8df060..095d7832 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.FoundFaces.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.FoundFaces.yml @@ -45,19 +45,19 @@ constructor: - [] keywordOnlyParameters: - name: status - isRequired: true + defaultValue: None - name: tracking_id - isRequired: true + defaultValue: None - name: cache_id - isRequired: true + defaultValue: None - name: result - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: advanced_info - isRequired: true + defaultValue: None - name: faces - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.FoundFaces.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Frame.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Frame.yml index e25d5f66..fa350648 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Frame.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Frame.yml @@ -30,13 +30,13 @@ constructor: - [] keywordOnlyParameters: - name: timestamp - isRequired: true + defaultValue: None - name: frame_image - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None - name: reviewer_result_tags - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.Frame.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Frames.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Frames.yml index 2f8e46ea..08118525 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Frames.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Frames.yml @@ -18,9 +18,9 @@ constructor: - [] keywordOnlyParameters: - name: review_id - isRequired: true + defaultValue: None - name: video_frames - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.Frames.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.IPA.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.IPA.yml index 1c2e5efd..7ace5d55 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.IPA.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.IPA.yml @@ -24,11 +24,11 @@ constructor: - keywordOnlyParameters: - name: sub_type - isRequired: true + defaultValue: None - name: text - isRequired: true + defaultValue: None - name: index - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.IPA.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Image.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Image.yml index e89ea15a..c0e3a250 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Image.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Image.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: content_id - isRequired: true + defaultValue: None - name: additional_info - isRequired: true + defaultValue: None - name: status - isRequired: true + defaultValue: None - name: tracking_id - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.Image.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageAdditionalInfoItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageAdditionalInfoItem.yml index 9b2d0b49..e65d464d 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageAdditionalInfoItem.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageAdditionalInfoItem.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: key - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.ImageAdditionalInfoItem.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageIds.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageIds.yml index a59413c8..e2ed4038 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageIds.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageIds.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: content_source - isRequired: true + defaultValue: None - name: content_ids - isRequired: true + defaultValue: None - name: status - isRequired: true + defaultValue: None - name: tracking_id - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.ImageIds.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageList.yml index b74971ca..b59b0024 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageList.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.ImageList.yml @@ -30,13 +30,13 @@ constructor: - [, ] keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.ImageList.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Job.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Job.yml index 5c755ffe..756be221 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Job.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Job.yml @@ -58,23 +58,23 @@ constructor: - [] keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: team_name - isRequired: true + defaultValue: None - name: status - isRequired: true + defaultValue: None - name: workflow_id - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None - name: call_back_endpoint - isRequired: true + defaultValue: None - name: review_id - isRequired: true + defaultValue: None - name: result_meta_data - isRequired: true + defaultValue: None - name: job_execution_report - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.Job.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobExecutionReportDetails.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobExecutionReportDetails.yml index c48c2aab..0d6e216f 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobExecutionReportDetails.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobExecutionReportDetails.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: ts - isRequired: true + defaultValue: None - name: msg - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.JobExecutionReportDetails.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobId.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobId.yml index 99f7090e..2d606e48 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobId.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobId.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: job_id - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.JobId.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobListResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobListResult.yml index 7d102e78..2e34ba67 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobListResult.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.JobListResult.yml @@ -14,7 +14,7 @@ constructor: - [] keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.JobListResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.KeyValuePair.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.KeyValuePair.yml index 3a5f5afa..bb692c4e 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.KeyValuePair.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.KeyValuePair.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: key - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.KeyValuePair.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Match.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Match.yml index 45213570..74ee3c36 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Match.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Match.yml @@ -35,15 +35,15 @@ constructor: - keywordOnlyParameters: - name: score - isRequired: true + defaultValue: None - name: match_id - isRequired: true + defaultValue: None - name: source - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: label - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.Match.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.MatchResponse.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.MatchResponse.yml index 2cbbb4c2..f3196744 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.MatchResponse.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.MatchResponse.yml @@ -35,15 +35,15 @@ constructor: - keywordOnlyParameters: - name: tracking_id - isRequired: true + defaultValue: None - name: cache_id - isRequired: true + defaultValue: None - name: is_match - isRequired: true + defaultValue: None - name: matches - isRequired: true + defaultValue: None - name: status - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.MatchResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.OCR.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.OCR.yml index 8d7d8f6e..283b6075 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.OCR.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.OCR.yml @@ -45,19 +45,19 @@ constructor: - [] keywordOnlyParameters: - name: status - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None - name: tracking_id - isRequired: true + defaultValue: None - name: cache_id - isRequired: true + defaultValue: None - name: language - isRequired: true + defaultValue: None - name: text - isRequired: true + defaultValue: None - name: candidates - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.OCR.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.PII.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.PII.yml index 39d6c34b..f92c512f 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.PII.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.PII.yml @@ -29,15 +29,15 @@ constructor: - [] keywordOnlyParameters: - name: email - isRequired: true + defaultValue: None - name: ssn - isRequired: true + defaultValue: None - name: ipa - isRequired: true + defaultValue: None - name: phone - isRequired: true + defaultValue: None - name: address - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.PII.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Phone.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Phone.yml index 5bba4800..b15edace 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Phone.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Phone.yml @@ -27,11 +27,11 @@ constructor: - keywordOnlyParameters: - name: country_code - isRequired: true + defaultValue: None - name: text - isRequired: true + defaultValue: None - name: index - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.Phone.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.RefreshIndex.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.RefreshIndex.yml index 3f286c09..553fa296 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.RefreshIndex.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.RefreshIndex.yml @@ -35,15 +35,15 @@ constructor: - keywordOnlyParameters: - name: content_source_id - isRequired: true + defaultValue: None - name: is_update_success - isRequired: true + defaultValue: None - name: advanced_info - isRequired: true + defaultValue: None - name: status - isRequired: true + defaultValue: None - name: tracking_id - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.RefreshIndex.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Review.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Review.yml index 9cd702d1..af0d2045 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Review.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Review.yml @@ -62,25 +62,25 @@ constructor: - keywordOnlyParameters: - name: review_id - isRequired: true + defaultValue: None - name: sub_team - isRequired: true + defaultValue: None - name: status - isRequired: true + defaultValue: None - name: reviewer_result_tags - isRequired: true + defaultValue: None - name: created_by - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None - name: content - isRequired: true + defaultValue: None - name: content_id - isRequired: true + defaultValue: None - name: callback_endpoint - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.Review.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.SSN.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.SSN.yml index 855b76e9..23d5c5ad 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.SSN.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.SSN.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: text - isRequired: true + defaultValue: None - name: index - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.SSN.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Screen.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Screen.yml index 6f59868f..bf881961 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Screen.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Screen.yml @@ -60,25 +60,25 @@ constructor: - keywordOnlyParameters: - name: original_text - isRequired: true + defaultValue: None - name: normalized_text - isRequired: true + defaultValue: None - name: auto_corrected_text - isRequired: true + defaultValue: None - name: misrepresentation - isRequired: true + defaultValue: None - name: classification - isRequired: true + defaultValue: None - name: status - isRequired: true + defaultValue: None - name: pii - isRequired: true + defaultValue: None - name: language - isRequired: true + defaultValue: None - name: terms - isRequired: true + defaultValue: None - name: tracking_id - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.Screen.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Status.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Status.yml index ce20b8e1..e041347c 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Status.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Status.yml @@ -25,11 +25,11 @@ constructor: - keywordOnlyParameters: - name: code - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: exception - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.Status.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Tag.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Tag.yml index e8b9ee16..f3722c37 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Tag.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Tag.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: key - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.Tag.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermList.yml index d6b3f1ac..95cd504d 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermList.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermList.yml @@ -30,13 +30,13 @@ constructor: - [, ] keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.TermList.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Terms.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Terms.yml index 106e1fdd..0404c709 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Terms.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.Terms.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: data - isRequired: true + defaultValue: None - name: paging - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.Terms.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsData.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsData.yml index f9ec68a0..a9daadb4 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsData.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsData.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: language - isRequired: true + defaultValue: None - name: terms - isRequired: true + defaultValue: None - name: status - isRequired: true + defaultValue: None - name: tracking_id - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.TermsData.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsInList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsInList.yml index b82a2567..8ae18457 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsInList.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsInList.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: term - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.TermsInList.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsPaging.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsPaging.yml index aa5cfdea..492dbf86 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsPaging.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.TermsPaging.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: total - isRequired: true + defaultValue: None - name: limit - isRequired: true + defaultValue: None - name: offset - isRequired: true + defaultValue: None - name: returned - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.TermsPaging.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItem.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItem.yml index 8c5a7789..533eaee6 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItem.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-contentmoderator/azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItem.yml @@ -36,9 +36,9 @@ constructor: - name: frame_image isRequired: true - name: reviewer_result_tags - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.contentmoderator.models.VideoFrameBodyItem.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CreateProjectOptions.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CreateProjectOptions.yml index b1ee97ef..3379b0b8 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CreateProjectOptions.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.CreateProjectOptions.yml @@ -28,9 +28,9 @@ constructor: - keywordOnlyParameters: - name: export_model_container_uri - isRequired: true + defaultValue: None - name: notification_queue_uri - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.customvision.training.models.CreateProjectOptions.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateBatch.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateBatch.yml index 6658c31f..43e1400b 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateBatch.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateBatch.yml @@ -26,11 +26,11 @@ constructor: - [, ] keywordOnlyParameters: - name: images - isRequired: true + defaultValue: None - name: tag_ids - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateBatch.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateEntry.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateEntry.yml index a83f9ba1..3f41118d 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateEntry.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateEntry.yml @@ -26,13 +26,13 @@ constructor: - [] keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: contents - isRequired: true + defaultValue: None - name: tag_ids - isRequired: true + defaultValue: None - name: regions - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.customvision.training.models.ImageFileCreateEntry.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateBatch.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateBatch.yml index 0f464810..3af0f75c 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateBatch.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateBatch.yml @@ -26,11 +26,11 @@ constructor: - [, ] keywordOnlyParameters: - name: images - isRequired: true + defaultValue: None - name: tag_ids - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateBatch.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateEntry.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateEntry.yml index 514d892e..5d9fa7e4 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateEntry.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateEntry.yml @@ -22,11 +22,11 @@ constructor: - [] keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: tag_ids - isRequired: true + defaultValue: None - name: regions - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.customvision.training.models.ImageIdCreateEntry.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateEntry.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateEntry.yml index e6cdcf24..b70f426e 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateEntry.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateEntry.yml @@ -28,11 +28,11 @@ constructor: - [, ] keywordOnlyParameters: - name: image_id - isRequired: true + defaultValue: None - name: status - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.customvision.training.models.ImageMetadataUpdateEntry.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageProcessingSettings.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageProcessingSettings.yml index 9a030eca..42ad5e7f 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageProcessingSettings.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageProcessingSettings.yml @@ -22,7 +22,7 @@ constructor: - [, ] keywordOnlyParameters: - name: augmentation_methods - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.customvision.training.models.ImageProcessingSettings.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateBatch.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateBatch.yml index ff421198..cf50dde6 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateBatch.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateBatch.yml @@ -13,7 +13,7 @@ constructor: - [] keywordOnlyParameters: - name: regions - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateBatch.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateSummary.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateSummary.yml index f82d83c4..2c35d1c9 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateSummary.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateSummary.yml @@ -22,11 +22,11 @@ constructor: - [] keywordOnlyParameters: - name: created - isRequired: true + defaultValue: None - name: duplicated - isRequired: true + defaultValue: None - name: exceeded - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.customvision.training.models.ImageRegionCreateSummary.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateBatch.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateBatch.yml index 3ec8024e..46ded188 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateBatch.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateBatch.yml @@ -14,7 +14,7 @@ constructor: - [] keywordOnlyParameters: - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateBatch.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateEntry.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateEntry.yml index e8bcf7fa..ed80adb6 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateEntry.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateEntry.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: image_id - isRequired: true + defaultValue: None - name: tag_id - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateEntry.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateSummary.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateSummary.yml index 868ea551..9c5ab3f3 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateSummary.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateSummary.yml @@ -21,11 +21,11 @@ constructor: - [] keywordOnlyParameters: - name: created - isRequired: true + defaultValue: None - name: duplicated - isRequired: true + defaultValue: None - name: exceeded - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.customvision.training.models.ImageTagCreateSummary.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateBatch.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateBatch.yml index 907bd4e0..fde6fdcf 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateBatch.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateBatch.yml @@ -26,11 +26,11 @@ constructor: - [, ] keywordOnlyParameters: - name: images - isRequired: true + defaultValue: None - name: tag_ids - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateBatch.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateEntry.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateEntry.yml index d3720fc6..d13e84de 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateEntry.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateEntry.yml @@ -27,9 +27,9 @@ constructor: - name: url isRequired: true - name: tag_ids - isRequired: true + defaultValue: None - name: regions - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.customvision.training.models.ImageUrlCreateEntry.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ModelInformation.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ModelInformation.yml index 090ab4b2..3fd17ba5 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ModelInformation.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ModelInformation.yml @@ -29,7 +29,7 @@ constructor: - name: description isRequired: true - name: estimated_model_size_in_megabytes - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.customvision.training.models.ModelInformation.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryResult.yml index 1a0d858a..bc3400e4 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryResult.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryResult.yml @@ -21,7 +21,7 @@ constructor: - keywordOnlyParameters: - name: token - isRequired: true + defaultValue: None variables: - description: Result of an image prediction request. name: results diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryTag.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryTag.yml index c9093e07..670f8788 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryTag.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryTag.yml @@ -22,11 +22,11 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: min_threshold - isRequired: true + defaultValue: None - name: max_threshold - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryTag.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryToken.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryToken.yml index fe72b08f..cd44eaad 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryToken.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.PredictionQueryToken.yml @@ -49,23 +49,23 @@ constructor: - keywordOnlyParameters: - name: session - isRequired: true + defaultValue: None - name: continuation - isRequired: true + defaultValue: None - name: max_count - isRequired: true + defaultValue: None - name: order_by - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: iteration_id - isRequired: true + defaultValue: None - name: start_time - isRequired: true + defaultValue: None - name: end_time - isRequired: true + defaultValue: None - name: application - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.customvision.training.models.PredictionQueryToken.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Project.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Project.yml index 94f39d01..18c873f0 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Project.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.Project.yml @@ -46,7 +46,7 @@ constructor: - name: settings isRequired: true - name: status - isRequired: true + defaultValue: None variables: - description: Gets the project id. name: id diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ProjectSettings.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ProjectSettings.yml index f5725a1b..2b90b411 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ProjectSettings.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.ProjectSettings.yml @@ -44,13 +44,13 @@ constructor: - keywordOnlyParameters: - name: domain_id - isRequired: true + defaultValue: None - name: classification_type - isRequired: true + defaultValue: None - name: target_export_platforms - isRequired: true + defaultValue: None - name: image_processing_settings - isRequired: true + defaultValue: None variables: - description: Indicates if negative set is being used. name: use_negative_set diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQuery.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQuery.yml index 2ba15854..df41e2cb 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQuery.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQuery.yml @@ -21,7 +21,7 @@ constructor: - keywordOnlyParameters: - name: token - isRequired: true + defaultValue: None variables: - description: 'Result of a suggested tags and regions request of the diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQueryToken.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQueryToken.yml index 51d5fbec..ed871e27 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQueryToken.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQueryToken.yml @@ -56,17 +56,17 @@ constructor: - keywordOnlyParameters: - name: tag_ids - isRequired: true + defaultValue: None - name: threshold - isRequired: true + defaultValue: None - name: session - isRequired: true + defaultValue: None - name: continuation - isRequired: true + defaultValue: None - name: max_count - isRequired: true + defaultValue: None - name: sort_by - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.customvision.training.models.SuggestedTagAndRegionQueryToken.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TagFilter.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TagFilter.yml index 6098f1e2..e07fb9ec 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TagFilter.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TagFilter.yml @@ -25,9 +25,9 @@ constructor: - keywordOnlyParameters: - name: tag_ids - isRequired: true + defaultValue: None - name: threshold - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.customvision.training.models.TagFilter.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TrainingParameters.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TrainingParameters.yml index f4e7d78c..5ab61042 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TrainingParameters.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-customvision/azure.cognitiveservices.vision.customvision.training.models.TrainingParameters.yml @@ -23,9 +23,9 @@ constructor: - keywordOnlyParameters: - name: selected_tags - isRequired: true + defaultValue: None - name: custom_base_model_info - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.customvision.training.models.TrainingParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.APIError.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.APIError.yml index 1636cac4..67497e90 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.APIError.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.APIError.yml @@ -13,7 +13,7 @@ constructor: - keywordOnlyParameters: - name: error - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.APIError.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Accessory.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Accessory.yml index 788349b9..b1a946d7 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Accessory.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Accessory.yml @@ -22,9 +22,9 @@ constructor: - keywordOnlyParameters: - name: type - isRequired: true + defaultValue: None - name: confidence - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.Accessory.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Blur.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Blur.yml index 922e5e32..a6917255 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Blur.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Blur.yml @@ -22,9 +22,9 @@ constructor: - keywordOnlyParameters: - name: blur_level - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.Blur.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.DetectedFace.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.DetectedFace.yml index a8d52f61..0e3356a6 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.DetectedFace.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.DetectedFace.yml @@ -42,13 +42,13 @@ constructor: - name: face_rectangle isRequired: true - name: face_id - isRequired: true + defaultValue: None - name: recognition_model defaultValue: recognition_01 - name: face_landmarks - isRequired: true + defaultValue: None - name: face_attributes - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.DetectedFace.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Emotion.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Emotion.yml index 410a1808..9fcc16ed 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Emotion.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Emotion.yml @@ -46,21 +46,21 @@ constructor: - keywordOnlyParameters: - name: anger - isRequired: true + defaultValue: None - name: contempt - isRequired: true + defaultValue: None - name: disgust - isRequired: true + defaultValue: None - name: fear - isRequired: true + defaultValue: None - name: happiness - isRequired: true + defaultValue: None - name: neutral - isRequired: true + defaultValue: None - name: sadness - isRequired: true + defaultValue: None - name: surprise - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.Emotion.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Error.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Error.yml index 10131fd4..bf62e3dc 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Error.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Error.yml @@ -17,9 +17,9 @@ constructor: - keywordOnlyParameters: - name: code - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.Error.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Exposure.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Exposure.yml index 0a6b5eb7..c6185759 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Exposure.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Exposure.yml @@ -26,9 +26,9 @@ constructor: - keywordOnlyParameters: - name: exposure_level - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.Exposure.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceAttributes.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceAttributes.yml index 04d68501..98af89b2 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceAttributes.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceAttributes.yml @@ -109,37 +109,37 @@ constructor: - keywordOnlyParameters: - name: age - isRequired: true + defaultValue: None - name: gender - isRequired: true + defaultValue: None - name: smile - isRequired: true + defaultValue: None - name: facial_hair - isRequired: true + defaultValue: None - name: glasses - isRequired: true + defaultValue: None - name: head_pose - isRequired: true + defaultValue: None - name: emotion - isRequired: true + defaultValue: None - name: hair - isRequired: true + defaultValue: None - name: makeup - isRequired: true + defaultValue: None - name: occlusion - isRequired: true + defaultValue: None - name: accessories - isRequired: true + defaultValue: None - name: blur - isRequired: true + defaultValue: None - name: exposure - isRequired: true + defaultValue: None - name: noise - isRequired: true + defaultValue: None - name: mask - isRequired: true + defaultValue: None - name: quality_for_recognition - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.FaceAttributes.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceLandmarks.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceLandmarks.yml index 0064c91e..94bd6310 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceLandmarks.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceLandmarks.yml @@ -126,59 +126,59 @@ constructor: - keywordOnlyParameters: - name: pupil_left - isRequired: true + defaultValue: None - name: pupil_right - isRequired: true + defaultValue: None - name: nose_tip - isRequired: true + defaultValue: None - name: mouth_left - isRequired: true + defaultValue: None - name: mouth_right - isRequired: true + defaultValue: None - name: eyebrow_left_outer - isRequired: true + defaultValue: None - name: eyebrow_left_inner - isRequired: true + defaultValue: None - name: eye_left_outer - isRequired: true + defaultValue: None - name: eye_left_top - isRequired: true + defaultValue: None - name: eye_left_bottom - isRequired: true + defaultValue: None - name: eye_left_inner - isRequired: true + defaultValue: None - name: eyebrow_right_inner - isRequired: true + defaultValue: None - name: eyebrow_right_outer - isRequired: true + defaultValue: None - name: eye_right_inner - isRequired: true + defaultValue: None - name: eye_right_top - isRequired: true + defaultValue: None - name: eye_right_bottom - isRequired: true + defaultValue: None - name: eye_right_outer - isRequired: true + defaultValue: None - name: nose_root_left - isRequired: true + defaultValue: None - name: nose_root_right - isRequired: true + defaultValue: None - name: nose_left_alar_top - isRequired: true + defaultValue: None - name: nose_right_alar_top - isRequired: true + defaultValue: None - name: nose_left_alar_out_tip - isRequired: true + defaultValue: None - name: nose_right_alar_out_tip - isRequired: true + defaultValue: None - name: upper_lip_top - isRequired: true + defaultValue: None - name: upper_lip_bottom - isRequired: true + defaultValue: None - name: under_lip_top - isRequired: true + defaultValue: None - name: under_lip_bottom - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.FaceLandmarks.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceList.yml index 06d4b4b1..de6acb57 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceList.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FaceList.yml @@ -47,11 +47,11 @@ constructor: - name: face_list_id isRequired: true - name: user_data - isRequired: true + defaultValue: None - name: recognition_model defaultValue: recognition_01 - name: persisted_faces - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.FaceList.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FacialHair.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FacialHair.yml index 23a7da4b..f31aaea9 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FacialHair.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FacialHair.yml @@ -22,11 +22,11 @@ constructor: - keywordOnlyParameters: - name: moustache - isRequired: true + defaultValue: None - name: beard - isRequired: true + defaultValue: None - name: sideburns - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.FacialHair.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FindSimilarRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FindSimilarRequest.yml index c6efecad..149d94a9 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FindSimilarRequest.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.FindSimilarRequest.yml @@ -83,11 +83,11 @@ constructor: - name: face_id isRequired: true - name: face_list_id - isRequired: true + defaultValue: None - name: large_face_list_id - isRequired: true + defaultValue: None - name: face_ids - isRequired: true + defaultValue: None - name: max_num_of_candidates_returned defaultValue: '20' - name: mode diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.GroupResult.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.GroupResult.yml index 7a3f7ddd..66f5787c 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.GroupResult.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.GroupResult.yml @@ -28,7 +28,7 @@ constructor: - name: groups isRequired: true - name: messy_group - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.GroupResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Hair.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Hair.yml index f835ad73..946b950d 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Hair.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Hair.yml @@ -30,11 +30,11 @@ constructor: - [] keywordOnlyParameters: - name: bald - isRequired: true + defaultValue: None - name: invisible - isRequired: true + defaultValue: None - name: hair_color - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.Hair.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.HairColor.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.HairColor.yml index df4aa326..7316ec10 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.HairColor.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.HairColor.yml @@ -22,9 +22,9 @@ constructor: - keywordOnlyParameters: - name: color - isRequired: true + defaultValue: None - name: confidence - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.HairColor.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.HeadPose.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.HeadPose.yml index 588acf39..433547ab 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.HeadPose.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.HeadPose.yml @@ -22,11 +22,11 @@ constructor: - keywordOnlyParameters: - name: roll - isRequired: true + defaultValue: None - name: yaw - isRequired: true + defaultValue: None - name: pitch - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.HeadPose.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.IdentifyRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.IdentifyRequest.yml index f04c1a7f..7d0dfea3 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.IdentifyRequest.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.IdentifyRequest.yml @@ -63,13 +63,13 @@ constructor: - name: face_ids isRequired: true - name: person_group_id - isRequired: true + defaultValue: None - name: large_person_group_id - isRequired: true + defaultValue: None - name: max_num_of_candidates_returned defaultValue: '1' - name: confidence_threshold - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.IdentifyRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.LargeFaceList.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.LargeFaceList.yml index b51018d5..39fc505a 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.LargeFaceList.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.LargeFaceList.yml @@ -44,7 +44,7 @@ constructor: - name: large_face_list_id isRequired: true - name: user_data - isRequired: true + defaultValue: None - name: recognition_model defaultValue: recognition_01 methods: diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.LargePersonGroup.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.LargePersonGroup.yml index ce395d96..681e01f5 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.LargePersonGroup.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.LargePersonGroup.yml @@ -44,7 +44,7 @@ constructor: - name: large_person_group_id isRequired: true - name: user_data - isRequired: true + defaultValue: None - name: recognition_model defaultValue: recognition_01 methods: diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Makeup.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Makeup.yml index ebbb3014..e3a6c698 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Makeup.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Makeup.yml @@ -23,9 +23,9 @@ constructor: - keywordOnlyParameters: - name: eye_makeup - isRequired: true + defaultValue: None - name: lip_makeup - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.Makeup.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Mask.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Mask.yml index 8f2aafd0..150cc626 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Mask.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Mask.yml @@ -24,9 +24,9 @@ constructor: - keywordOnlyParameters: - name: type - isRequired: true + defaultValue: None - name: nose_and_mouth_covered - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.Mask.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.MetaDataContract.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.MetaDataContract.yml index 6d239dd0..170350f6 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.MetaDataContract.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.MetaDataContract.yml @@ -37,7 +37,7 @@ constructor: - name: name isRequired: true - name: user_data - isRequired: true + defaultValue: None - name: recognition_model defaultValue: recognition_01 methods: diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.NameAndUserDataContract.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.NameAndUserDataContract.yml index f1cd9909..5f4309de 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.NameAndUserDataContract.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.NameAndUserDataContract.yml @@ -21,9 +21,9 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: user_data - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.NameAndUserDataContract.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Noise.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Noise.yml index 2ee31df6..fd1f334a 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Noise.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Noise.yml @@ -28,9 +28,9 @@ constructor: - keywordOnlyParameters: - name: noise_level - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.Noise.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Occlusion.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Occlusion.yml index 2f456309..04f6cc40 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Occlusion.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Occlusion.yml @@ -29,11 +29,11 @@ constructor: - keywordOnlyParameters: - name: forehead_occluded - isRequired: true + defaultValue: None - name: eye_occluded - isRequired: true + defaultValue: None - name: mouth_occluded - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.Occlusion.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.OperationStatus.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.OperationStatus.yml index 780ae7d7..81347885 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.OperationStatus.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.OperationStatus.yml @@ -85,11 +85,11 @@ constructor: - name: created_time isRequired: true - name: last_action_time - isRequired: true + defaultValue: None - name: resource_location - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.OperationStatus.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.PersistedFace.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.PersistedFace.yml index a0d8827c..7d5666ed 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.PersistedFace.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.PersistedFace.yml @@ -32,7 +32,7 @@ constructor: - name: persisted_face_id isRequired: true - name: user_data - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.PersistedFace.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Person.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Person.yml index 17915a6c..b84a976d 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Person.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Person.yml @@ -39,11 +39,11 @@ constructor: - name: person_id isRequired: true - name: name - isRequired: true + defaultValue: None - name: user_data - isRequired: true + defaultValue: None - name: persisted_face_ids - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.Person.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.PersonGroup.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.PersonGroup.yml index 4b40fc80..9fc34f18 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.PersonGroup.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.PersonGroup.yml @@ -44,7 +44,7 @@ constructor: - name: person_group_id isRequired: true - name: user_data - isRequired: true + defaultValue: None - name: recognition_model defaultValue: recognition_01 methods: diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.SimilarFace.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.SimilarFace.yml index 67657360..ec243e76 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.SimilarFace.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.SimilarFace.yml @@ -40,9 +40,9 @@ constructor: - name: confidence isRequired: true - name: face_id - isRequired: true + defaultValue: None - name: persisted_face_id - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.SimilarFace.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Snapshot.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Snapshot.yml index 6d27b4fe..1711cf98 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Snapshot.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.Snapshot.yml @@ -87,7 +87,7 @@ constructor: - name: last_update_time isRequired: true - name: user_data - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.Snapshot.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.TakeSnapshotRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.TakeSnapshotRequest.yml index 609f9da3..c89298b9 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.TakeSnapshotRequest.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.TakeSnapshotRequest.yml @@ -54,7 +54,7 @@ constructor: - name: apply_scope isRequired: true - name: user_data - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.TakeSnapshotRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.TrainingStatus.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.TrainingStatus.yml index 2e78aa36..49d86e46 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.TrainingStatus.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.TrainingStatus.yml @@ -73,11 +73,11 @@ constructor: - name: created isRequired: true - name: last_action - isRequired: true + defaultValue: None - name: last_successful_training - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.TrainingStatus.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.UpdateFaceRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.UpdateFaceRequest.yml index 5f7d1154..8a9d95d7 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.UpdateFaceRequest.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.UpdateFaceRequest.yml @@ -16,7 +16,7 @@ constructor: - keywordOnlyParameters: - name: user_data - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.UpdateFaceRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.UpdateSnapshotRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.UpdateSnapshotRequest.yml index 3cabb1f5..c0d96f50 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.UpdateSnapshotRequest.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.UpdateSnapshotRequest.yml @@ -29,9 +29,9 @@ constructor: - keywordOnlyParameters: - name: apply_scope - isRequired: true + defaultValue: None - name: user_data - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.UpdateSnapshotRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.VerifyFaceToPersonRequest.yml b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.VerifyFaceToPersonRequest.yml index 8cf104b6..50d8e4c7 100644 --- a/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.VerifyFaceToPersonRequest.yml +++ b/previous/docs-ref-autogen/azure-cognitiveservices-vision-face/azure.cognitiveservices.vision.face.models.VerifyFaceToPersonRequest.yml @@ -53,9 +53,9 @@ constructor: - name: person_id isRequired: true - name: person_group_id - isRequired: true + defaultValue: None - name: large_person_group_id - isRequired: true + defaultValue: None methods: - uid: azure.cognitiveservices.vision.face.models.VerifyFaceToPersonRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-communication-networktraversal/azure.communication.networktraversal.aio.CommunicationRelayClient.yml b/previous/docs-ref-autogen/azure-communication-networktraversal/azure.communication.networktraversal.aio.CommunicationRelayClient.yml index 69f6d600..18ba1bcd 100644 --- a/previous/docs-ref-autogen/azure-communication-networktraversal/azure.communication.networktraversal.aio.CommunicationRelayClient.yml +++ b/previous/docs-ref-autogen/azure-communication-networktraversal/azure.communication.networktraversal.aio.CommunicationRelayClient.yml @@ -104,3 +104,10 @@ methods: signature: 'async get_relay_configuration(*, user: CommunicationUserIdentifier = None, route_type: str | RouteType | None = None, ttl: int | None = 172800, **kwargs) -> CommunicationRelayConfiguration' + keywordOnlyParameters: + - name: user + defaultValue: None + - name: route_type + defaultValue: None + - name: ttl + defaultValue: '172800' diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.lib.DatalakeRESTInterface.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.lib.DatalakeRESTInterface.yml index fbd63b6a..2cfc635f 100644 --- a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.lib.DatalakeRESTInterface.yml +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.lib.DatalakeRESTInterface.yml @@ -127,18 +127,18 @@ attributes: name: session - uid: azure.datalake.store.lib.DatalakeRESTInterface.ends name: ends - signature: 'ends = {''APPEND'': (''post'', set(), {''append'', ''leaseid'', ''offset'', - ''syncFlag'', ''filesessionid''}), ''CHECKACCESS'': (''get'', set(), {''fsaction''}), + signature: 'ends = {''APPEND'': (''post'', set(), {''syncFlag'', ''offset'', ''append'', + ''leaseid'', ''filesessionid''}), ''CHECKACCESS'': (''get'', set(), {''fsaction''}), ''CONCAT'': (''post'', {''sources''}, {''sources''}), ''CREATE'': (''put'', set(), - {''leaseid'', ''filesessionid'', ''write'', ''syncFlag'', ''overwrite''}), ''DELETE'': + {''syncFlag'', ''overwrite'', ''leaseid'', ''write'', ''filesessionid''}), ''DELETE'': (''delete'', set(), {''recursive''}), ''GETCONTENTSUMMARY'': (''get'', set(), set()), ''GETFILESTATUS'': (''get'', set(), set()), ''LISTSTATUS'': (''get'', set(), {''listAfter'', ''listSize''}), ''MKDIRS'': (''put'', set(), set()), ''MODIFYACLENTRIES'': (''put'', {''aclSpec''}, {''aclSpec''}), ''MSCONCAT'': (''post'', set(), {''deleteSourceDirectory''}), - ''MSGETACLSTATUS'': (''get'', set(), set()), ''OPEN'': (''get'', set(), {''length'', - ''filesessionid'', ''offset'', ''read''}), ''REMOVEACL'': (''put'', set(), set()), + ''MSGETACLSTATUS'': (''get'', set(), set()), ''OPEN'': (''get'', set(), {''offset'', + ''read'', ''filesessionid'', ''length''}), ''REMOVEACL'': (''put'', set(), set()), ''REMOVEACLENTRIES'': (''put'', {''aclSpec''}, {''aclSpec''}), ''REMOVEDEFAULTACL'': (''put'', set(), set()), ''RENAME'': (''put'', {''destination''}, {''destination''}), ''SETACL'': (''put'', {''aclSpec''}, {''aclSpec''}), ''SETEXPIRY'': (''put'', {''expiryOption''}, {''expireTime'', ''expiryOption''}), ''SETOWNER'': (''put'', - set(), {''group'', ''owner''}), ''SETPERMISSION'': (''put'', set(), {''permission''})}' + set(), {''owner'', ''group''}), ''SETPERMISSION'': (''put'', set(), {''permission''})}' diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.Chunk.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.Chunk.yml index 8dd127bb..2323f50f 100644 --- a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.Chunk.yml +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.Chunk.yml @@ -7,8 +7,6 @@ summary: Create new instance of Chunk(name, state, offset, expected, actual, exc constructor: syntax: Chunk(name, state, offset, expected, actual, exception) parameters: - - name: _cls - isRequired: true - name: name isRequired: true - name: state diff --git a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.File.yml b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.File.yml index 48ab823e..d2185a50 100644 --- a/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.File.yml +++ b/previous/docs-ref-autogen/azure-datalake-store/azure.datalake.store.transfer.File.yml @@ -7,8 +7,6 @@ summary: Create new instance of File(src, dst, state, length, chunks, exception) constructor: syntax: File(src, dst, state, length, chunks, exception) parameters: - - name: _cls - isRequired: true - name: src isRequired: true - name: dst diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ADGroup.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ADGroup.yml index 3b8a1063..0e395c2d 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ADGroup.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ADGroup.yml @@ -60,17 +60,17 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: display_name - isRequired: true + defaultValue: None - name: mail_enabled - isRequired: true + defaultValue: None - name: mail_nickname - isRequired: true + defaultValue: None - name: security_enabled - isRequired: true + defaultValue: None - name: mail - isRequired: true + defaultValue: None variables: - description: The object ID. name: object_id diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.AddOwnerParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.AddOwnerParameters.yml index 97ac86e6..2cd1eeee 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.AddOwnerParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.AddOwnerParameters.yml @@ -34,7 +34,7 @@ constructor: - name: url isRequired: true - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.AddOwnerParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.AppRole.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.AppRole.yml index 9775500a..148aa085 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.AppRole.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.AppRole.yml @@ -59,17 +59,17 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: allowed_member_types - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: display_name - isRequired: true + defaultValue: None - name: is_enabled - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.AppRole.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.Application(class).yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.Application(class).yml index 286aa41d..4854141f 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.Application(class).yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.Application(class).yml @@ -263,71 +263,71 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: app_id - isRequired: true + defaultValue: None - name: allow_guests_sign_in - isRequired: true + defaultValue: None - name: allow_passthrough_users - isRequired: true + defaultValue: None - name: app_logo_url - isRequired: true + defaultValue: None - name: app_roles - isRequired: true + defaultValue: None - name: app_permissions - isRequired: true + defaultValue: None - name: available_to_other_tenants - isRequired: true + defaultValue: None - name: display_name - isRequired: true + defaultValue: None - name: error_url - isRequired: true + defaultValue: None - name: group_membership_claims - isRequired: true + defaultValue: None - name: homepage - isRequired: true + defaultValue: None - name: identifier_uris - isRequired: true + defaultValue: None - name: informational_urls - isRequired: true + defaultValue: None - name: is_device_only_auth_supported - isRequired: true + defaultValue: None - name: key_credentials - isRequired: true + defaultValue: None - name: known_client_applications - isRequired: true + defaultValue: None - name: logout_url - isRequired: true + defaultValue: None - name: oauth2_allow_implicit_flow - isRequired: true + defaultValue: None - name: oauth2_allow_url_path_matching - isRequired: true + defaultValue: None - name: oauth2_permissions - isRequired: true + defaultValue: None - name: oauth2_require_post_response - isRequired: true + defaultValue: None - name: org_restrictions - isRequired: true + defaultValue: None - name: optional_claims - isRequired: true + defaultValue: None - name: password_credentials - isRequired: true + defaultValue: None - name: pre_authorized_applications - isRequired: true + defaultValue: None - name: public_client - isRequired: true + defaultValue: None - name: publisher_domain - isRequired: true + defaultValue: None - name: reply_urls - isRequired: true + defaultValue: None - name: required_resource_access - isRequired: true + defaultValue: None - name: saml_metadata_url - isRequired: true + defaultValue: None - name: sign_in_audience - isRequired: true + defaultValue: None - name: www_homepage - isRequired: true + defaultValue: None variables: - description: The object ID. name: object_id diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationBase.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationBase.yml index 8a260a0f..567e87e1 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationBase.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationBase.yml @@ -229,63 +229,63 @@ constructor: - keywordOnlyParameters: - name: allow_guests_sign_in - isRequired: true + defaultValue: None - name: allow_passthrough_users - isRequired: true + defaultValue: None - name: app_logo_url - isRequired: true + defaultValue: None - name: app_roles - isRequired: true + defaultValue: None - name: app_permissions - isRequired: true + defaultValue: None - name: available_to_other_tenants - isRequired: true + defaultValue: None - name: error_url - isRequired: true + defaultValue: None - name: group_membership_claims - isRequired: true + defaultValue: None - name: homepage - isRequired: true + defaultValue: None - name: informational_urls - isRequired: true + defaultValue: None - name: is_device_only_auth_supported - isRequired: true + defaultValue: None - name: key_credentials - isRequired: true + defaultValue: None - name: known_client_applications - isRequired: true + defaultValue: None - name: logout_url - isRequired: true + defaultValue: None - name: oauth2_allow_implicit_flow - isRequired: true + defaultValue: None - name: oauth2_allow_url_path_matching - isRequired: true + defaultValue: None - name: oauth2_permissions - isRequired: true + defaultValue: None - name: oauth2_require_post_response - isRequired: true + defaultValue: None - name: org_restrictions - isRequired: true + defaultValue: None - name: optional_claims - isRequired: true + defaultValue: None - name: password_credentials - isRequired: true + defaultValue: None - name: pre_authorized_applications - isRequired: true + defaultValue: None - name: public_client - isRequired: true + defaultValue: None - name: publisher_domain - isRequired: true + defaultValue: None - name: reply_urls - isRequired: true + defaultValue: None - name: required_resource_access - isRequired: true + defaultValue: None - name: saml_metadata_url - isRequired: true + defaultValue: None - name: sign_in_audience - isRequired: true + defaultValue: None - name: www_homepage - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.ApplicationBase.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationCreateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationCreateParameters.yml index c20501a2..23f30b0b 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationCreateParameters.yml @@ -242,65 +242,65 @@ constructor: - name: display_name isRequired: true - name: allow_guests_sign_in - isRequired: true + defaultValue: None - name: allow_passthrough_users - isRequired: true + defaultValue: None - name: app_logo_url - isRequired: true + defaultValue: None - name: app_roles - isRequired: true + defaultValue: None - name: app_permissions - isRequired: true + defaultValue: None - name: available_to_other_tenants - isRequired: true + defaultValue: None - name: error_url - isRequired: true + defaultValue: None - name: group_membership_claims - isRequired: true + defaultValue: None - name: homepage - isRequired: true + defaultValue: None - name: informational_urls - isRequired: true + defaultValue: None - name: is_device_only_auth_supported - isRequired: true + defaultValue: None - name: key_credentials - isRequired: true + defaultValue: None - name: known_client_applications - isRequired: true + defaultValue: None - name: logout_url - isRequired: true + defaultValue: None - name: oauth2_allow_implicit_flow - isRequired: true + defaultValue: None - name: oauth2_allow_url_path_matching - isRequired: true + defaultValue: None - name: oauth2_permissions - isRequired: true + defaultValue: None - name: oauth2_require_post_response - isRequired: true + defaultValue: None - name: org_restrictions - isRequired: true + defaultValue: None - name: optional_claims - isRequired: true + defaultValue: None - name: password_credentials - isRequired: true + defaultValue: None - name: pre_authorized_applications - isRequired: true + defaultValue: None - name: public_client - isRequired: true + defaultValue: None - name: publisher_domain - isRequired: true + defaultValue: None - name: reply_urls - isRequired: true + defaultValue: None - name: required_resource_access - isRequired: true + defaultValue: None - name: saml_metadata_url - isRequired: true + defaultValue: None - name: sign_in_audience - isRequired: true + defaultValue: None - name: www_homepage - isRequired: true + defaultValue: None - name: identifier_uris - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.ApplicationCreateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationUpdateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationUpdateParameters.yml index 2f78a6be..664699bb 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ApplicationUpdateParameters.yml @@ -237,67 +237,67 @@ constructor: - [] keywordOnlyParameters: - name: allow_guests_sign_in - isRequired: true + defaultValue: None - name: allow_passthrough_users - isRequired: true + defaultValue: None - name: app_logo_url - isRequired: true + defaultValue: None - name: app_roles - isRequired: true + defaultValue: None - name: app_permissions - isRequired: true + defaultValue: None - name: available_to_other_tenants - isRequired: true + defaultValue: None - name: error_url - isRequired: true + defaultValue: None - name: group_membership_claims - isRequired: true + defaultValue: None - name: homepage - isRequired: true + defaultValue: None - name: informational_urls - isRequired: true + defaultValue: None - name: is_device_only_auth_supported - isRequired: true + defaultValue: None - name: key_credentials - isRequired: true + defaultValue: None - name: known_client_applications - isRequired: true + defaultValue: None - name: logout_url - isRequired: true + defaultValue: None - name: oauth2_allow_implicit_flow - isRequired: true + defaultValue: None - name: oauth2_allow_url_path_matching - isRequired: true + defaultValue: None - name: oauth2_permissions - isRequired: true + defaultValue: None - name: oauth2_require_post_response - isRequired: true + defaultValue: None - name: org_restrictions - isRequired: true + defaultValue: None - name: optional_claims - isRequired: true + defaultValue: None - name: password_credentials - isRequired: true + defaultValue: None - name: pre_authorized_applications - isRequired: true + defaultValue: None - name: public_client - isRequired: true + defaultValue: None - name: publisher_domain - isRequired: true + defaultValue: None - name: reply_urls - isRequired: true + defaultValue: None - name: required_resource_access - isRequired: true + defaultValue: None - name: saml_metadata_url - isRequired: true + defaultValue: None - name: sign_in_audience - isRequired: true + defaultValue: None - name: www_homepage - isRequired: true + defaultValue: None - name: display_name - isRequired: true + defaultValue: None - name: identifier_uris - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.ApplicationUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.CheckGroupMembershipParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.CheckGroupMembershipParameters.yml index 99683c36..d2cb12b1 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.CheckGroupMembershipParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.CheckGroupMembershipParameters.yml @@ -36,7 +36,7 @@ constructor: - name: member_id isRequired: true - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.CheckGroupMembershipParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.CheckGroupMembershipResult.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.CheckGroupMembershipResult.yml index e44a582c..29513851 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.CheckGroupMembershipResult.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.CheckGroupMembershipResult.yml @@ -26,9 +26,9 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.CheckGroupMembershipResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.DirectoryObject.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.DirectoryObject.yml index 342237c6..58846dfe 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.DirectoryObject.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.DirectoryObject.yml @@ -34,7 +34,7 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None variables: - description: The object ID. name: object_id diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.Domain(class).yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.Domain(class).yml index 51c0e988..425ba14a 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.Domain(class).yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.Domain(class).yml @@ -31,7 +31,7 @@ constructor: - name: name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None variables: - description: the type of the authentication into the domain. name: authentication_type diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GetObjectsParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GetObjectsParameters.yml index b76b0448..f86984e5 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GetObjectsParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GetObjectsParameters.yml @@ -34,13 +34,13 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: object_ids - isRequired: true + defaultValue: None - name: types - isRequired: true + defaultValue: None - name: include_directory_object_references - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.GetObjectsParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GraphError.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GraphError.yml index 0b38a00a..7c6b6ad9 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GraphError.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GraphError.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: code - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.GraphError.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupAddMemberParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupAddMemberParameters.yml index 34d1f988..38109fc7 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupAddMemberParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupAddMemberParameters.yml @@ -34,7 +34,7 @@ constructor: - name: url isRequired: true - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.GroupAddMemberParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupCreateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupCreateParameters.yml index 7ebfc2af..0d755776 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupCreateParameters.yml @@ -39,7 +39,7 @@ constructor: - name: mail_nickname isRequired: true - name: additional_properties - isRequired: true + defaultValue: None variables: - description: 'Required. Whether the group is mail-enabled. Must be diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupGetMemberGroupsParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupGetMemberGroupsParameters.yml index 76ea0c21..b1ebd66a 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupGetMemberGroupsParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.GroupGetMemberGroupsParameters.yml @@ -31,7 +31,7 @@ constructor: - name: security_enabled_only isRequired: true - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.GroupGetMemberGroupsParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.InformationalUrl.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.InformationalUrl.yml index fa685468..8aea896d 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.InformationalUrl.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.InformationalUrl.yml @@ -34,13 +34,13 @@ constructor: - keywordOnlyParameters: - name: terms_of_service - isRequired: true + defaultValue: None - name: marketing - isRequired: true + defaultValue: None - name: privacy - isRequired: true + defaultValue: None - name: support - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.InformationalUrl.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.KeyCredential.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.KeyCredential.yml index a598cb03..678b85f2 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.KeyCredential.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.KeyCredential.yml @@ -55,21 +55,21 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: start_date - isRequired: true + defaultValue: None - name: end_date - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None - name: key_id - isRequired: true + defaultValue: None - name: usage - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None - name: custom_key_identifier - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.KeyCredential.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OAuth2Permission.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OAuth2Permission.yml index 79ef81b4..2f0bbdb7 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OAuth2Permission.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OAuth2Permission.yml @@ -86,21 +86,21 @@ constructor: - keywordOnlyParameters: - name: admin_consent_description - isRequired: true + defaultValue: None - name: admin_consent_display_name - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: is_enabled - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None - name: user_consent_description - isRequired: true + defaultValue: None - name: user_consent_display_name - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.OAuth2Permission.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OAuth2PermissionGrant.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OAuth2PermissionGrant.yml index fdbdad78..280cd921 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OAuth2PermissionGrant.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OAuth2PermissionGrant.yml @@ -74,23 +74,23 @@ constructor: - keywordOnlyParameters: - name: odatatype - isRequired: true + defaultValue: None - name: client_id - isRequired: true + defaultValue: None - name: object_id - isRequired: true + defaultValue: None - name: consent_type - isRequired: true + defaultValue: None - name: principal_id - isRequired: true + defaultValue: None - name: resource_id - isRequired: true + defaultValue: None - name: scope - isRequired: true + defaultValue: None - name: start_time - isRequired: true + defaultValue: None - name: expiry_time - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.OAuth2PermissionGrant.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OptionalClaim.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OptionalClaim.yml index 15bc0ef4..8196b65e 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OptionalClaim.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OptionalClaim.yml @@ -29,13 +29,13 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: source - isRequired: true + defaultValue: None - name: essential - isRequired: true + defaultValue: None - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.OptionalClaim.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OptionalClaims.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OptionalClaims.yml index b00511aa..afb28691 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OptionalClaims.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.OptionalClaims.yml @@ -28,11 +28,11 @@ constructor: - [] keywordOnlyParameters: - name: id_token - isRequired: true + defaultValue: None - name: access_token - isRequired: true + defaultValue: None - name: saml_token - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.OptionalClaims.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordCredential.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordCredential.yml index d77e988e..c719e3d7 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordCredential.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordCredential.yml @@ -43,17 +43,17 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: start_date - isRequired: true + defaultValue: None - name: end_date - isRequired: true + defaultValue: None - name: key_id - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None - name: custom_key_identifier - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.PasswordCredential.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordProfile.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordProfile.yml index ddc7a51b..6729c08f 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordProfile.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PasswordProfile.yml @@ -34,9 +34,9 @@ constructor: - name: password isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: force_change_password_next_login - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.PasswordProfile.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplication.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplication.yml index 8c0274a0..99c8eee9 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplication.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplication.yml @@ -27,11 +27,11 @@ constructor: - [] keywordOnlyParameters: - name: app_id - isRequired: true + defaultValue: None - name: permissions - isRequired: true + defaultValue: None - name: extensions - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.PreAuthorizedApplication.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplicationExtension.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplicationExtension.yml index 3c1f07df..6c153ff8 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplicationExtension.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplicationExtension.yml @@ -16,7 +16,7 @@ constructor: - [] keywordOnlyParameters: - name: conditions - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.PreAuthorizedApplicationExtension.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplicationPermission.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplicationPermission.yml index b90c1187..c1d37c02 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplicationPermission.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.PreAuthorizedApplicationPermission.yml @@ -22,9 +22,9 @@ constructor: - [] keywordOnlyParameters: - name: direct_access_grant - isRequired: true + defaultValue: None - name: access_grants - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.PreAuthorizedApplicationPermission.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.RequiredResourceAccess.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.RequiredResourceAccess.yml index 915c2d67..d00553e2 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.RequiredResourceAccess.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.RequiredResourceAccess.yml @@ -48,9 +48,9 @@ constructor: - name: resource_access isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: resource_app_id - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.RequiredResourceAccess.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ResourceAccess.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ResourceAccess.yml index c283a7d0..0c08cd30 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ResourceAccess.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ResourceAccess.yml @@ -40,9 +40,9 @@ constructor: - name: id isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.ResourceAccess.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipal.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipal.yml index c510c8c5..65d59ab3 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipal.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipal.yml @@ -155,43 +155,43 @@ constructor: - [] keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: account_enabled - isRequired: true + defaultValue: None - name: alternative_names - isRequired: true + defaultValue: None - name: app_id - isRequired: true + defaultValue: None - name: app_role_assignment_required - isRequired: true + defaultValue: None - name: app_roles - isRequired: true + defaultValue: None - name: display_name - isRequired: true + defaultValue: None - name: error_url - isRequired: true + defaultValue: None - name: homepage - isRequired: true + defaultValue: None - name: key_credentials - isRequired: true + defaultValue: None - name: logout_url - isRequired: true + defaultValue: None - name: password_credentials - isRequired: true + defaultValue: None - name: preferred_token_signing_key_thumbprint - isRequired: true + defaultValue: None - name: publisher_name - isRequired: true + defaultValue: None - name: reply_urls - isRequired: true + defaultValue: None - name: saml_metadata_url - isRequired: true + defaultValue: None - name: service_principal_names - isRequired: true + defaultValue: None - name: service_principal_type - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None variables: - description: The object ID. name: object_id diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalBase.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalBase.yml index bc3fa2c1..170837b2 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalBase.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalBase.yml @@ -55,17 +55,17 @@ constructor: - [] keywordOnlyParameters: - name: account_enabled - isRequired: true + defaultValue: None - name: app_role_assignment_required - isRequired: true + defaultValue: None - name: key_credentials - isRequired: true + defaultValue: None - name: password_credentials - isRequired: true + defaultValue: None - name: service_principal_type - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.ServicePrincipalBase.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalCreateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalCreateParameters.yml index 25c0239d..df5bf9cd 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalCreateParameters.yml @@ -63,17 +63,17 @@ constructor: - name: app_id isRequired: true - name: account_enabled - isRequired: true + defaultValue: None - name: app_role_assignment_required - isRequired: true + defaultValue: None - name: key_credentials - isRequired: true + defaultValue: None - name: password_credentials - isRequired: true + defaultValue: None - name: service_principal_type - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.ServicePrincipalCreateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalObjectResult.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalObjectResult.yml index a3157e7f..42a5c168 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalObjectResult.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalObjectResult.yml @@ -22,9 +22,9 @@ constructor: - keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: odatametadata - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.ServicePrincipalObjectResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalUpdateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalUpdateParameters.yml index e79c163c..abbd1819 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ServicePrincipalUpdateParameters.yml @@ -53,17 +53,17 @@ constructor: - [] keywordOnlyParameters: - name: account_enabled - isRequired: true + defaultValue: None - name: app_role_assignment_required - isRequired: true + defaultValue: None - name: key_credentials - isRequired: true + defaultValue: None - name: password_credentials - isRequired: true + defaultValue: None - name: service_principal_type - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.ServicePrincipalUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.SignInName.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.SignInName.yml index 2b337bef..36a55888 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.SignInName.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.SignInName.yml @@ -33,11 +33,11 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.SignInName.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.User(class).yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.User(class).yml index a5455943..2f2d23b3 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.User(class).yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.User(class).yml @@ -104,29 +104,29 @@ constructor: - [] keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: immutable_id - isRequired: true + defaultValue: None - name: usage_location - isRequired: true + defaultValue: None - name: given_name - isRequired: true + defaultValue: None - name: surname - isRequired: true + defaultValue: None - name: user_type - isRequired: true + defaultValue: None - name: account_enabled - isRequired: true + defaultValue: None - name: display_name - isRequired: true + defaultValue: None - name: user_principal_name - isRequired: true + defaultValue: None - name: mail_nickname - isRequired: true + defaultValue: None - name: mail - isRequired: true + defaultValue: None - name: sign_in_names - isRequired: true + defaultValue: None variables: - description: The object ID. name: object_id diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserBase.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserBase.yml index 39723f03..a4236f04 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserBase.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserBase.yml @@ -59,17 +59,17 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: immutable_id - isRequired: true + defaultValue: None - name: usage_location - isRequired: true + defaultValue: None - name: given_name - isRequired: true + defaultValue: None - name: surname - isRequired: true + defaultValue: None - name: user_type - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.UserBase.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserCreateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserCreateParameters.yml index 27170325..e320a94a 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserCreateParameters.yml @@ -109,19 +109,19 @@ constructor: - name: mail_nickname isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: immutable_id - isRequired: true + defaultValue: None - name: usage_location - isRequired: true + defaultValue: None - name: given_name - isRequired: true + defaultValue: None - name: surname - isRequired: true + defaultValue: None - name: user_type - isRequired: true + defaultValue: None - name: mail - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.UserCreateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserGetMemberGroupsParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserGetMemberGroupsParameters.yml index c797ccaa..a4a6feaf 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserGetMemberGroupsParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserGetMemberGroupsParameters.yml @@ -31,7 +31,7 @@ constructor: - name: security_enabled_only isRequired: true - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.UserGetMemberGroupsParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserUpdateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserUpdateParameters.yml index 5d67c25f..12b0ac59 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.UserUpdateParameters.yml @@ -91,27 +91,27 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: immutable_id - isRequired: true + defaultValue: None - name: usage_location - isRequired: true + defaultValue: None - name: given_name - isRequired: true + defaultValue: None - name: surname - isRequired: true + defaultValue: None - name: user_type - isRequired: true + defaultValue: None - name: account_enabled - isRequired: true + defaultValue: None - name: display_name - isRequired: true + defaultValue: None - name: password_profile - isRequired: true + defaultValue: None - name: user_principal_name - isRequired: true + defaultValue: None - name: mail_nickname - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.UserUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group_py3.ADGroup.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group_py3.ADGroup.yml index 2b02090e..57de6dc1 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group_py3.ADGroup.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.ad_group_py3.ADGroup.yml @@ -60,17 +60,17 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: display_name - isRequired: true + defaultValue: None - name: mail_enabled - isRequired: true + defaultValue: None - name: mail_nickname - isRequired: true + defaultValue: None - name: security_enabled - isRequired: true + defaultValue: None - name: mail - isRequired: true + defaultValue: None variables: - description: The object ID. name: object_id diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.add_owner_parameters_py3.AddOwnerParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.add_owner_parameters_py3.AddOwnerParameters.yml index 69650022..161ec4ae 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.add_owner_parameters_py3.AddOwnerParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.add_owner_parameters_py3.AddOwnerParameters.yml @@ -34,7 +34,7 @@ constructor: - name: url isRequired: true - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.add_owner_parameters_py3.AddOwnerParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.app_role_py3.AppRole.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.app_role_py3.AppRole.yml index df46d155..0fb35e3c 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.app_role_py3.AppRole.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.app_role_py3.AppRole.yml @@ -59,17 +59,17 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: allowed_member_types - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: display_name - isRequired: true + defaultValue: None - name: is_enabled - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.app_role_py3.AppRole.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_base_py3.ApplicationBase.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_base_py3.ApplicationBase.yml index 9c5ac2d9..e764929c 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_base_py3.ApplicationBase.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_base_py3.ApplicationBase.yml @@ -229,63 +229,63 @@ constructor: - keywordOnlyParameters: - name: allow_guests_sign_in - isRequired: true + defaultValue: None - name: allow_passthrough_users - isRequired: true + defaultValue: None - name: app_logo_url - isRequired: true + defaultValue: None - name: app_roles - isRequired: true + defaultValue: None - name: app_permissions - isRequired: true + defaultValue: None - name: available_to_other_tenants - isRequired: true + defaultValue: None - name: error_url - isRequired: true + defaultValue: None - name: group_membership_claims - isRequired: true + defaultValue: None - name: homepage - isRequired: true + defaultValue: None - name: informational_urls - isRequired: true + defaultValue: None - name: is_device_only_auth_supported - isRequired: true + defaultValue: None - name: key_credentials - isRequired: true + defaultValue: None - name: known_client_applications - isRequired: true + defaultValue: None - name: logout_url - isRequired: true + defaultValue: None - name: oauth2_allow_implicit_flow - isRequired: true + defaultValue: None - name: oauth2_allow_url_path_matching - isRequired: true + defaultValue: None - name: oauth2_permissions - isRequired: true + defaultValue: None - name: oauth2_require_post_response - isRequired: true + defaultValue: None - name: org_restrictions - isRequired: true + defaultValue: None - name: optional_claims - isRequired: true + defaultValue: None - name: password_credentials - isRequired: true + defaultValue: None - name: pre_authorized_applications - isRequired: true + defaultValue: None - name: public_client - isRequired: true + defaultValue: None - name: publisher_domain - isRequired: true + defaultValue: None - name: reply_urls - isRequired: true + defaultValue: None - name: required_resource_access - isRequired: true + defaultValue: None - name: saml_metadata_url - isRequired: true + defaultValue: None - name: sign_in_audience - isRequired: true + defaultValue: None - name: www_homepage - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.application_base_py3.ApplicationBase.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_create_parameters_py3.ApplicationCreateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_create_parameters_py3.ApplicationCreateParameters.yml index a5d0dd12..b845e27c 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_create_parameters_py3.ApplicationCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_create_parameters_py3.ApplicationCreateParameters.yml @@ -242,65 +242,65 @@ constructor: - name: display_name isRequired: true - name: allow_guests_sign_in - isRequired: true + defaultValue: None - name: allow_passthrough_users - isRequired: true + defaultValue: None - name: app_logo_url - isRequired: true + defaultValue: None - name: app_roles - isRequired: true + defaultValue: None - name: app_permissions - isRequired: true + defaultValue: None - name: available_to_other_tenants - isRequired: true + defaultValue: None - name: error_url - isRequired: true + defaultValue: None - name: group_membership_claims - isRequired: true + defaultValue: None - name: homepage - isRequired: true + defaultValue: None - name: informational_urls - isRequired: true + defaultValue: None - name: is_device_only_auth_supported - isRequired: true + defaultValue: None - name: key_credentials - isRequired: true + defaultValue: None - name: known_client_applications - isRequired: true + defaultValue: None - name: logout_url - isRequired: true + defaultValue: None - name: oauth2_allow_implicit_flow - isRequired: true + defaultValue: None - name: oauth2_allow_url_path_matching - isRequired: true + defaultValue: None - name: oauth2_permissions - isRequired: true + defaultValue: None - name: oauth2_require_post_response - isRequired: true + defaultValue: None - name: org_restrictions - isRequired: true + defaultValue: None - name: optional_claims - isRequired: true + defaultValue: None - name: password_credentials - isRequired: true + defaultValue: None - name: pre_authorized_applications - isRequired: true + defaultValue: None - name: public_client - isRequired: true + defaultValue: None - name: publisher_domain - isRequired: true + defaultValue: None - name: reply_urls - isRequired: true + defaultValue: None - name: required_resource_access - isRequired: true + defaultValue: None - name: saml_metadata_url - isRequired: true + defaultValue: None - name: sign_in_audience - isRequired: true + defaultValue: None - name: www_homepage - isRequired: true + defaultValue: None - name: identifier_uris - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.application_create_parameters_py3.ApplicationCreateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_py3.Application.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_py3.Application.yml index 290da281..6fdf6666 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_py3.Application.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_py3.Application.yml @@ -263,71 +263,71 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: app_id - isRequired: true + defaultValue: None - name: allow_guests_sign_in - isRequired: true + defaultValue: None - name: allow_passthrough_users - isRequired: true + defaultValue: None - name: app_logo_url - isRequired: true + defaultValue: None - name: app_roles - isRequired: true + defaultValue: None - name: app_permissions - isRequired: true + defaultValue: None - name: available_to_other_tenants - isRequired: true + defaultValue: None - name: display_name - isRequired: true + defaultValue: None - name: error_url - isRequired: true + defaultValue: None - name: group_membership_claims - isRequired: true + defaultValue: None - name: homepage - isRequired: true + defaultValue: None - name: identifier_uris - isRequired: true + defaultValue: None - name: informational_urls - isRequired: true + defaultValue: None - name: is_device_only_auth_supported - isRequired: true + defaultValue: None - name: key_credentials - isRequired: true + defaultValue: None - name: known_client_applications - isRequired: true + defaultValue: None - name: logout_url - isRequired: true + defaultValue: None - name: oauth2_allow_implicit_flow - isRequired: true + defaultValue: None - name: oauth2_allow_url_path_matching - isRequired: true + defaultValue: None - name: oauth2_permissions - isRequired: true + defaultValue: None - name: oauth2_require_post_response - isRequired: true + defaultValue: None - name: org_restrictions - isRequired: true + defaultValue: None - name: optional_claims - isRequired: true + defaultValue: None - name: password_credentials - isRequired: true + defaultValue: None - name: pre_authorized_applications - isRequired: true + defaultValue: None - name: public_client - isRequired: true + defaultValue: None - name: publisher_domain - isRequired: true + defaultValue: None - name: reply_urls - isRequired: true + defaultValue: None - name: required_resource_access - isRequired: true + defaultValue: None - name: saml_metadata_url - isRequired: true + defaultValue: None - name: sign_in_audience - isRequired: true + defaultValue: None - name: www_homepage - isRequired: true + defaultValue: None variables: - description: The object ID. name: object_id diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_update_parameters_py3.ApplicationUpdateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_update_parameters_py3.ApplicationUpdateParameters.yml index edea5f7f..4cd31fb4 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_update_parameters_py3.ApplicationUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.application_update_parameters_py3.ApplicationUpdateParameters.yml @@ -237,67 +237,67 @@ constructor: - [] keywordOnlyParameters: - name: allow_guests_sign_in - isRequired: true + defaultValue: None - name: allow_passthrough_users - isRequired: true + defaultValue: None - name: app_logo_url - isRequired: true + defaultValue: None - name: app_roles - isRequired: true + defaultValue: None - name: app_permissions - isRequired: true + defaultValue: None - name: available_to_other_tenants - isRequired: true + defaultValue: None - name: error_url - isRequired: true + defaultValue: None - name: group_membership_claims - isRequired: true + defaultValue: None - name: homepage - isRequired: true + defaultValue: None - name: informational_urls - isRequired: true + defaultValue: None - name: is_device_only_auth_supported - isRequired: true + defaultValue: None - name: key_credentials - isRequired: true + defaultValue: None - name: known_client_applications - isRequired: true + defaultValue: None - name: logout_url - isRequired: true + defaultValue: None - name: oauth2_allow_implicit_flow - isRequired: true + defaultValue: None - name: oauth2_allow_url_path_matching - isRequired: true + defaultValue: None - name: oauth2_permissions - isRequired: true + defaultValue: None - name: oauth2_require_post_response - isRequired: true + defaultValue: None - name: org_restrictions - isRequired: true + defaultValue: None - name: optional_claims - isRequired: true + defaultValue: None - name: password_credentials - isRequired: true + defaultValue: None - name: pre_authorized_applications - isRequired: true + defaultValue: None - name: public_client - isRequired: true + defaultValue: None - name: publisher_domain - isRequired: true + defaultValue: None - name: reply_urls - isRequired: true + defaultValue: None - name: required_resource_access - isRequired: true + defaultValue: None - name: saml_metadata_url - isRequired: true + defaultValue: None - name: sign_in_audience - isRequired: true + defaultValue: None - name: www_homepage - isRequired: true + defaultValue: None - name: display_name - isRequired: true + defaultValue: None - name: identifier_uris - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.application_update_parameters_py3.ApplicationUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_parameters_py3.CheckGroupMembershipParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_parameters_py3.CheckGroupMembershipParameters.yml index b97b53d4..332fa735 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_parameters_py3.CheckGroupMembershipParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_parameters_py3.CheckGroupMembershipParameters.yml @@ -36,7 +36,7 @@ constructor: - name: member_id isRequired: true - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.check_group_membership_parameters_py3.CheckGroupMembershipParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_result_py3.CheckGroupMembershipResult.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_result_py3.CheckGroupMembershipResult.yml index d77a07bf..e01fd988 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_result_py3.CheckGroupMembershipResult.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.check_group_membership_result_py3.CheckGroupMembershipResult.yml @@ -26,9 +26,9 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.check_group_membership_result_py3.CheckGroupMembershipResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object_py3.DirectoryObject.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object_py3.DirectoryObject.yml index 7687b292..beee7a93 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object_py3.DirectoryObject.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.directory_object_py3.DirectoryObject.yml @@ -34,7 +34,7 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None variables: - description: The object ID. name: object_id diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain_py3.Domain.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain_py3.Domain.yml index 3f9dc123..262fe1d9 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain_py3.Domain.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.domain_py3.Domain.yml @@ -31,7 +31,7 @@ constructor: - name: name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None variables: - description: the type of the authentication into the domain. name: authentication_type diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.get_objects_parameters_py3.GetObjectsParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.get_objects_parameters_py3.GetObjectsParameters.yml index 394db18b..0fadaa03 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.get_objects_parameters_py3.GetObjectsParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.get_objects_parameters_py3.GetObjectsParameters.yml @@ -34,13 +34,13 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: object_ids - isRequired: true + defaultValue: None - name: types - isRequired: true + defaultValue: None - name: include_directory_object_references - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.get_objects_parameters_py3.GetObjectsParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error_py3.GraphError.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error_py3.GraphError.yml index 0baf728c..92338527 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error_py3.GraphError.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.graph_error_py3.GraphError.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: code - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.graph_error_py3.GraphError.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_add_member_parameters_py3.GroupAddMemberParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_add_member_parameters_py3.GroupAddMemberParameters.yml index 4217ea20..bbe5518d 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_add_member_parameters_py3.GroupAddMemberParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_add_member_parameters_py3.GroupAddMemberParameters.yml @@ -34,7 +34,7 @@ constructor: - name: url isRequired: true - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.group_add_member_parameters_py3.GroupAddMemberParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_create_parameters_py3.GroupCreateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_create_parameters_py3.GroupCreateParameters.yml index b9d81206..a44de021 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_create_parameters_py3.GroupCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_create_parameters_py3.GroupCreateParameters.yml @@ -39,7 +39,7 @@ constructor: - name: mail_nickname isRequired: true - name: additional_properties - isRequired: true + defaultValue: None variables: - description: 'Required. Whether the group is mail-enabled. Must be diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_get_member_groups_parameters_py3.GroupGetMemberGroupsParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_get_member_groups_parameters_py3.GroupGetMemberGroupsParameters.yml index c3e08891..39347581 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_get_member_groups_parameters_py3.GroupGetMemberGroupsParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.group_get_member_groups_parameters_py3.GroupGetMemberGroupsParameters.yml @@ -31,7 +31,7 @@ constructor: - name: security_enabled_only isRequired: true - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.group_get_member_groups_parameters_py3.GroupGetMemberGroupsParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.informational_url_py3.InformationalUrl.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.informational_url_py3.InformationalUrl.yml index 2b33fd1b..d9407a71 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.informational_url_py3.InformationalUrl.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.informational_url_py3.InformationalUrl.yml @@ -34,13 +34,13 @@ constructor: - keywordOnlyParameters: - name: terms_of_service - isRequired: true + defaultValue: None - name: marketing - isRequired: true + defaultValue: None - name: privacy - isRequired: true + defaultValue: None - name: support - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.informational_url_py3.InformationalUrl.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential_py3.KeyCredential.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential_py3.KeyCredential.yml index d75979a7..69c27b47 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential_py3.KeyCredential.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.key_credential_py3.KeyCredential.yml @@ -55,21 +55,21 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: start_date - isRequired: true + defaultValue: None - name: end_date - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None - name: key_id - isRequired: true + defaultValue: None - name: usage - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None - name: custom_key_identifier - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.key_credential_py3.KeyCredential.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant_py3.OAuth2PermissionGrant.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant_py3.OAuth2PermissionGrant.yml index b0a59ebf..d5902807 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant_py3.OAuth2PermissionGrant.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_grant_py3.OAuth2PermissionGrant.yml @@ -74,23 +74,23 @@ constructor: - keywordOnlyParameters: - name: odatatype - isRequired: true + defaultValue: None - name: client_id - isRequired: true + defaultValue: None - name: object_id - isRequired: true + defaultValue: None - name: consent_type - isRequired: true + defaultValue: None - name: principal_id - isRequired: true + defaultValue: None - name: resource_id - isRequired: true + defaultValue: None - name: scope - isRequired: true + defaultValue: None - name: start_time - isRequired: true + defaultValue: None - name: expiry_time - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.oauth2_permission_grant_py3.OAuth2PermissionGrant.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_py3.OAuth2Permission.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_py3.OAuth2Permission.yml index cd3f5f4d..b6fd01f0 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_py3.OAuth2Permission.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.oauth2_permission_py3.OAuth2Permission.yml @@ -86,21 +86,21 @@ constructor: - keywordOnlyParameters: - name: admin_consent_description - isRequired: true + defaultValue: None - name: admin_consent_display_name - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: is_enabled - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None - name: user_consent_description - isRequired: true + defaultValue: None - name: user_consent_display_name - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.oauth2_permission_py3.OAuth2Permission.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claim_py3.OptionalClaim.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claim_py3.OptionalClaim.yml index dd1526ac..9ec94b84 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claim_py3.OptionalClaim.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claim_py3.OptionalClaim.yml @@ -29,13 +29,13 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: source - isRequired: true + defaultValue: None - name: essential - isRequired: true + defaultValue: None - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.optional_claim_py3.OptionalClaim.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claims_py3.OptionalClaims.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claims_py3.OptionalClaims.yml index 57a0422b..cb342f47 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claims_py3.OptionalClaims.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.optional_claims_py3.OptionalClaims.yml @@ -28,11 +28,11 @@ constructor: - [] keywordOnlyParameters: - name: id_token - isRequired: true + defaultValue: None - name: access_token - isRequired: true + defaultValue: None - name: saml_token - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.optional_claims_py3.OptionalClaims.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential_py3.PasswordCredential.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential_py3.PasswordCredential.yml index e475d9af..b5cadbdb 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential_py3.PasswordCredential.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_credential_py3.PasswordCredential.yml @@ -43,17 +43,17 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: start_date - isRequired: true + defaultValue: None - name: end_date - isRequired: true + defaultValue: None - name: key_id - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None - name: custom_key_identifier - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.password_credential_py3.PasswordCredential.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_profile_py3.PasswordProfile.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_profile_py3.PasswordProfile.yml index 350e9607..a103cecb 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_profile_py3.PasswordProfile.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.password_profile_py3.PasswordProfile.yml @@ -34,9 +34,9 @@ constructor: - name: password isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: force_change_password_next_login - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.password_profile_py3.PasswordProfile.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_extension_py3.PreAuthorizedApplicationExtension.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_extension_py3.PreAuthorizedApplicationExtension.yml index 480ca2a6..0623f8ba 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_extension_py3.PreAuthorizedApplicationExtension.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_extension_py3.PreAuthorizedApplicationExtension.yml @@ -16,7 +16,7 @@ constructor: - [] keywordOnlyParameters: - name: conditions - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.pre_authorized_application_extension_py3.PreAuthorizedApplicationExtension.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_permission_py3.PreAuthorizedApplicationPermission.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_permission_py3.PreAuthorizedApplicationPermission.yml index d7451f2e..fffab184 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_permission_py3.PreAuthorizedApplicationPermission.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_permission_py3.PreAuthorizedApplicationPermission.yml @@ -22,9 +22,9 @@ constructor: - [] keywordOnlyParameters: - name: direct_access_grant - isRequired: true + defaultValue: None - name: access_grants - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.pre_authorized_application_permission_py3.PreAuthorizedApplicationPermission.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_py3.PreAuthorizedApplication.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_py3.PreAuthorizedApplication.yml index b2c880bd..f7c3d310 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_py3.PreAuthorizedApplication.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.pre_authorized_application_py3.PreAuthorizedApplication.yml @@ -27,11 +27,11 @@ constructor: - [] keywordOnlyParameters: - name: app_id - isRequired: true + defaultValue: None - name: permissions - isRequired: true + defaultValue: None - name: extensions - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.pre_authorized_application_py3.PreAuthorizedApplication.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.required_resource_access_py3.RequiredResourceAccess.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.required_resource_access_py3.RequiredResourceAccess.yml index ce1b4b89..970d1475 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.required_resource_access_py3.RequiredResourceAccess.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.required_resource_access_py3.RequiredResourceAccess.yml @@ -48,9 +48,9 @@ constructor: - name: resource_access isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: resource_app_id - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.required_resource_access_py3.RequiredResourceAccess.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.resource_access_py3.ResourceAccess.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.resource_access_py3.ResourceAccess.yml index 546a643e..8af5961d 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.resource_access_py3.ResourceAccess.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.resource_access_py3.ResourceAccess.yml @@ -40,9 +40,9 @@ constructor: - name: id isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.resource_access_py3.ResourceAccess.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_base_py3.ServicePrincipalBase.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_base_py3.ServicePrincipalBase.yml index 805d3a7e..2641f836 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_base_py3.ServicePrincipalBase.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_base_py3.ServicePrincipalBase.yml @@ -55,17 +55,17 @@ constructor: - [] keywordOnlyParameters: - name: account_enabled - isRequired: true + defaultValue: None - name: app_role_assignment_required - isRequired: true + defaultValue: None - name: key_credentials - isRequired: true + defaultValue: None - name: password_credentials - isRequired: true + defaultValue: None - name: service_principal_type - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.service_principal_base_py3.ServicePrincipalBase.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_create_parameters_py3.ServicePrincipalCreateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_create_parameters_py3.ServicePrincipalCreateParameters.yml index fb038bed..ea99c78d 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_create_parameters_py3.ServicePrincipalCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_create_parameters_py3.ServicePrincipalCreateParameters.yml @@ -63,17 +63,17 @@ constructor: - name: app_id isRequired: true - name: account_enabled - isRequired: true + defaultValue: None - name: app_role_assignment_required - isRequired: true + defaultValue: None - name: key_credentials - isRequired: true + defaultValue: None - name: password_credentials - isRequired: true + defaultValue: None - name: service_principal_type - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.service_principal_create_parameters_py3.ServicePrincipalCreateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_object_result_py3.ServicePrincipalObjectResult.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_object_result_py3.ServicePrincipalObjectResult.yml index 9ea72319..423f5b66 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_object_result_py3.ServicePrincipalObjectResult.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_object_result_py3.ServicePrincipalObjectResult.yml @@ -22,9 +22,9 @@ constructor: - keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: odatametadata - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.service_principal_object_result_py3.ServicePrincipalObjectResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_py3.ServicePrincipal.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_py3.ServicePrincipal.yml index 0fecd73f..8efbe1a5 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_py3.ServicePrincipal.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_py3.ServicePrincipal.yml @@ -155,43 +155,43 @@ constructor: - [] keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: account_enabled - isRequired: true + defaultValue: None - name: alternative_names - isRequired: true + defaultValue: None - name: app_id - isRequired: true + defaultValue: None - name: app_role_assignment_required - isRequired: true + defaultValue: None - name: app_roles - isRequired: true + defaultValue: None - name: display_name - isRequired: true + defaultValue: None - name: error_url - isRequired: true + defaultValue: None - name: homepage - isRequired: true + defaultValue: None - name: key_credentials - isRequired: true + defaultValue: None - name: logout_url - isRequired: true + defaultValue: None - name: password_credentials - isRequired: true + defaultValue: None - name: preferred_token_signing_key_thumbprint - isRequired: true + defaultValue: None - name: publisher_name - isRequired: true + defaultValue: None - name: reply_urls - isRequired: true + defaultValue: None - name: saml_metadata_url - isRequired: true + defaultValue: None - name: service_principal_names - isRequired: true + defaultValue: None - name: service_principal_type - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None variables: - description: The object ID. name: object_id diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_update_parameters_py3.ServicePrincipalUpdateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_update_parameters_py3.ServicePrincipalUpdateParameters.yml index 02e72304..52fe6189 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_update_parameters_py3.ServicePrincipalUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.service_principal_update_parameters_py3.ServicePrincipalUpdateParameters.yml @@ -53,17 +53,17 @@ constructor: - [] keywordOnlyParameters: - name: account_enabled - isRequired: true + defaultValue: None - name: app_role_assignment_required - isRequired: true + defaultValue: None - name: key_credentials - isRequired: true + defaultValue: None - name: password_credentials - isRequired: true + defaultValue: None - name: service_principal_type - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.service_principal_update_parameters_py3.ServicePrincipalUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.sign_in_name_py3.SignInName.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.sign_in_name_py3.SignInName.yml index 166e6d9c..e340497f 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.sign_in_name_py3.SignInName.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.sign_in_name_py3.SignInName.yml @@ -33,11 +33,11 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.sign_in_name_py3.SignInName.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_base_py3.UserBase.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_base_py3.UserBase.yml index a1815086..842bf520 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_base_py3.UserBase.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_base_py3.UserBase.yml @@ -59,17 +59,17 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: immutable_id - isRequired: true + defaultValue: None - name: usage_location - isRequired: true + defaultValue: None - name: given_name - isRequired: true + defaultValue: None - name: surname - isRequired: true + defaultValue: None - name: user_type - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.user_base_py3.UserBase.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_create_parameters_py3.UserCreateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_create_parameters_py3.UserCreateParameters.yml index 00201a43..c12dfe47 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_create_parameters_py3.UserCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_create_parameters_py3.UserCreateParameters.yml @@ -109,19 +109,19 @@ constructor: - name: mail_nickname isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: immutable_id - isRequired: true + defaultValue: None - name: usage_location - isRequired: true + defaultValue: None - name: given_name - isRequired: true + defaultValue: None - name: surname - isRequired: true + defaultValue: None - name: user_type - isRequired: true + defaultValue: None - name: mail - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.user_create_parameters_py3.UserCreateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_get_member_groups_parameters_py3.UserGetMemberGroupsParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_get_member_groups_parameters_py3.UserGetMemberGroupsParameters.yml index 63445718..ed1d7bfa 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_get_member_groups_parameters_py3.UserGetMemberGroupsParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_get_member_groups_parameters_py3.UserGetMemberGroupsParameters.yml @@ -31,7 +31,7 @@ constructor: - name: security_enabled_only isRequired: true - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.user_get_member_groups_parameters_py3.UserGetMemberGroupsParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_py3.User.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_py3.User.yml index 7ac008ce..5974d617 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_py3.User.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_py3.User.yml @@ -104,29 +104,29 @@ constructor: - [] keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: immutable_id - isRequired: true + defaultValue: None - name: usage_location - isRequired: true + defaultValue: None - name: given_name - isRequired: true + defaultValue: None - name: surname - isRequired: true + defaultValue: None - name: user_type - isRequired: true + defaultValue: None - name: account_enabled - isRequired: true + defaultValue: None - name: display_name - isRequired: true + defaultValue: None - name: user_principal_name - isRequired: true + defaultValue: None - name: mail_nickname - isRequired: true + defaultValue: None - name: mail - isRequired: true + defaultValue: None - name: sign_in_names - isRequired: true + defaultValue: None variables: - description: The object ID. name: object_id diff --git a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_update_parameters_py3.UserUpdateParameters.yml b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_update_parameters_py3.UserUpdateParameters.yml index 7f868f8f..f933c5af 100644 --- a/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_update_parameters_py3.UserUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-graphrbac/azure.graphrbac.models.user_update_parameters_py3.UserUpdateParameters.yml @@ -91,27 +91,27 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: immutable_id - isRequired: true + defaultValue: None - name: usage_location - isRequired: true + defaultValue: None - name: given_name - isRequired: true + defaultValue: None - name: surname - isRequired: true + defaultValue: None - name: user_type - isRequired: true + defaultValue: None - name: account_enabled - isRequired: true + defaultValue: None - name: display_name - isRequired: true + defaultValue: None - name: password_profile - isRequired: true + defaultValue: None - name: user_principal_name - isRequired: true + defaultValue: None - name: mail_nickname - isRequired: true + defaultValue: None methods: - uid: azure.graphrbac.models.user_update_parameters_py3.UserUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.AccessToken.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.AccessToken.yml index d047c6af..4c941188 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.AccessToken.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.AccessToken.yml @@ -7,8 +7,6 @@ summary: Create new instance of AccessToken(scheme, token, key) constructor: syntax: AccessToken(scheme, token, key) parameters: - - name: _cls - isRequired: true - name: scheme defaultValue: Bearer - name: token diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_authentication.AccessToken.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_authentication.AccessToken.yml index 29c8bcb9..956b059c 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_authentication.AccessToken.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.key_vault_authentication.AccessToken.yml @@ -7,8 +7,6 @@ summary: Create new instance of AccessToken(scheme, token, key) constructor: syntax: AccessToken(scheme, token, key) parameters: - - name: _cls - isRequired: true - name: scheme defaultValue: Bearer - name: token diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Action(class).yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Action(class).yml index 40175b27..0a6f265d 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Action(class).yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Action(class).yml @@ -17,7 +17,7 @@ constructor: - keywordOnlyParameters: - name: action_type - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.Action.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.AdministratorDetails.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.AdministratorDetails.yml index d3cb41f9..a98b6b03 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.AdministratorDetails.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.AdministratorDetails.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: first_name - isRequired: true + defaultValue: None - name: last_name - isRequired: true + defaultValue: None - name: email_address - isRequired: true + defaultValue: None - name: phone - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.AdministratorDetails.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Attributes(class).yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Attributes(class).yml index 275545cd..14317fc7 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Attributes(class).yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Attributes(class).yml @@ -29,11 +29,11 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None - name: not_before - isRequired: true + defaultValue: None - name: expires - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateAttributes.yml index fa085851..fd9af7fe 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateAttributes.yml @@ -30,11 +30,11 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None - name: not_before - isRequired: true + defaultValue: None - name: expires - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateBundle.yml index 54ff1209..da00f6fc 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateBundle.yml @@ -35,13 +35,13 @@ constructor: - [, ] keywordOnlyParameters: - name: cer - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None variables: - description: The certificate id. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateCreateParameters.yml index 1201867c..00d6e941 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateCreateParameters.yml @@ -27,11 +27,11 @@ constructor: - [, ] keywordOnlyParameters: - name: certificate_policy - isRequired: true + defaultValue: None - name: certificate_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.CertificateCreateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateImportParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateImportParameters.yml index cdbe7a48..5dce6157 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateImportParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateImportParameters.yml @@ -48,13 +48,13 @@ constructor: - name: base64_encoded_certificate isRequired: true - name: password - isRequired: true + defaultValue: None - name: certificate_policy - isRequired: true + defaultValue: None - name: certificate_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.CertificateImportParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerItem.yml index 1877dc7e..125d5076 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerItem.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: provider - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.CertificateIssuerItem.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerSetParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerSetParameters.yml index 926750a5..4789c10c 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerSetParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerSetParameters.yml @@ -37,11 +37,11 @@ constructor: - name: provider isRequired: true - name: credentials - isRequired: true + defaultValue: None - name: organization_details - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.CertificateIssuerSetParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerUpdateParameters.yml index 8e2c3df8..7793a394 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateIssuerUpdateParameters.yml @@ -32,13 +32,13 @@ constructor: - keywordOnlyParameters: - name: provider - isRequired: true + defaultValue: None - name: credentials - isRequired: true + defaultValue: None - name: organization_details - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.CertificateIssuerUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateItem.yml index 4ffcee9a..1a9698f4 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateItem.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: x509_thumbprint - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.CertificateItem.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateMergeParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateMergeParameters.yml index 442b2f0f..3bd37b00 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateMergeParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateMergeParameters.yml @@ -34,9 +34,9 @@ constructor: - name: x509_certificates isRequired: true - name: certificate_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.CertificateMergeParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateOperation.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateOperation.yml index 187a657d..27113e60 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateOperation.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateOperation.yml @@ -64,21 +64,21 @@ constructor: - keywordOnlyParameters: - name: issuer_parameters - isRequired: true + defaultValue: None - name: csr - isRequired: true + defaultValue: None - name: cancellation_requested - isRequired: true + defaultValue: None - name: status - isRequired: true + defaultValue: None - name: status_details - isRequired: true + defaultValue: None - name: error - isRequired: true + defaultValue: None - name: target - isRequired: true + defaultValue: None - name: request_id - isRequired: true + defaultValue: None variables: - description: The certificate id. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificatePolicy.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificatePolicy.yml index 6653d5b7..3028fa2d 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificatePolicy.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificatePolicy.yml @@ -51,17 +51,17 @@ constructor: - keywordOnlyParameters: - name: key_properties - isRequired: true + defaultValue: None - name: secret_properties - isRequired: true + defaultValue: None - name: x509_certificate_properties - isRequired: true + defaultValue: None - name: lifetime_actions - isRequired: true + defaultValue: None - name: issuer_parameters - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None variables: - description: The certificate id. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateUpdateParameters.yml index 9635180a..3e671e2d 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.CertificateUpdateParameters.yml @@ -27,11 +27,11 @@ constructor: - [, ] keywordOnlyParameters: - name: certificate_policy - isRequired: true + defaultValue: None - name: certificate_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.CertificateUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Contact(class).yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Contact(class).yml index 395e585c..f075ee4c 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Contact(class).yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Contact(class).yml @@ -25,11 +25,11 @@ constructor: - keywordOnlyParameters: - name: email_address - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: phone - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.Contact.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Contacts(class).yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Contacts(class).yml index eacaa70d..abd60e44 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Contacts(class).yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Contacts(class).yml @@ -19,7 +19,7 @@ constructor: - [] keywordOnlyParameters: - name: contact_list - isRequired: true + defaultValue: None variables: - description: Identifier for the contacts collection. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedCertificateBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedCertificateBundle.yml index 086dad51..5a5e7432 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedCertificateBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedCertificateBundle.yml @@ -44,15 +44,15 @@ constructor: - keywordOnlyParameters: - name: cer - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: The certificate id. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedCertificateItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedCertificateItem.yml index c64218bf..10a921a0 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedCertificateItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedCertificateItem.yml @@ -44,15 +44,15 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: x509_thumbprint - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: 'The time when the certificate is scheduled to diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedKeyBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedKeyBundle.yml index e26ed279..c36febcd 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedKeyBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedKeyBundle.yml @@ -39,13 +39,13 @@ constructor: - keywordOnlyParameters: - name: key - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: 'True if the key''s lifetime is managed by key vault. If this diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedKeyItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedKeyItem.yml index d0ab4da9..ac1a966c 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedKeyItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedKeyItem.yml @@ -39,13 +39,13 @@ constructor: - keywordOnlyParameters: - name: kid - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: 'True if the key''s lifetime is managed by key vault. If this diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedSecretBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedSecretBundle.yml index 11b2101c..48e03897 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedSecretBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedSecretBundle.yml @@ -50,17 +50,17 @@ constructor: - keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: 'If this is a secret backing a KV certificate, then this field diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedSecretItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedSecretItem.yml index d5c42ec1..646f9b14 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedSecretItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.DeletedSecretItem.yml @@ -42,15 +42,15 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: 'True if the secret''s lifetime is managed by key vault. If diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerAttributes.yml index 59339597..3aff1416 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerAttributes.yml @@ -19,7 +19,7 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerBundle.yml index 4cfec1eb..a939cd3b 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerBundle.yml @@ -37,13 +37,13 @@ constructor: - keywordOnlyParameters: - name: provider - isRequired: true + defaultValue: None - name: credentials - isRequired: true + defaultValue: None - name: organization_details - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None variables: - description: Identifier for the issuer object. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerCredentials.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerCredentials.yml index 5db5e636..edd77d8f 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerCredentials.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerCredentials.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: account_id - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.IssuerCredentials.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerParameters.yml index 306c71be..2fcc5cff 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.IssuerParameters.yml @@ -23,9 +23,9 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: certificate_type - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.IssuerParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKey.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKey.yml index 201dc0d1..d55cd735 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKey.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.JsonWebKey.yml @@ -99,37 +99,37 @@ constructor: - keywordOnlyParameters: - name: kid - isRequired: true + defaultValue: None - name: kty - isRequired: true + defaultValue: None - name: key_ops - isRequired: true + defaultValue: None - name: n - isRequired: true + defaultValue: None - name: e - isRequired: true + defaultValue: None - name: d - isRequired: true + defaultValue: None - name: dp - isRequired: true + defaultValue: None - name: dq - isRequired: true + defaultValue: None - name: qi - isRequired: true + defaultValue: None - name: p - isRequired: true + defaultValue: None - name: q - isRequired: true + defaultValue: None - name: k - isRequired: true + defaultValue: None - name: t - isRequired: true + defaultValue: None - name: crv - isRequired: true + defaultValue: None - name: x - isRequired: true + defaultValue: None - name: y - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.JsonWebKey.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyAttributes.yml index a4e90824..e643b274 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyAttributes.yml @@ -29,11 +29,11 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None - name: not_before - isRequired: true + defaultValue: None - name: expires - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyBundle.yml index 74ad7ccd..d49bd346 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyBundle.yml @@ -29,11 +29,11 @@ constructor: - [, ] keywordOnlyParameters: - name: key - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None variables: - description: 'True if the key''s lifetime is managed by key vault. If this diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyCreateParameters.yml index 72e9dfa7..3e359f5a 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyCreateParameters.yml @@ -56,15 +56,15 @@ constructor: - name: kty isRequired: true - name: key_size - isRequired: true + defaultValue: None - name: key_ops - isRequired: true + defaultValue: None - name: key_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: curve - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.KeyCreateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyImportParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyImportParameters.yml index 7c9bf0d9..925c03e3 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyImportParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyImportParameters.yml @@ -35,11 +35,11 @@ constructor: - name: key isRequired: true - name: hsm - isRequired: true + defaultValue: None - name: key_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.KeyImportParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyItem.yml index aa15c4ee..289b2697 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyItem.yml @@ -29,11 +29,11 @@ constructor: - [, ] keywordOnlyParameters: - name: kid - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None variables: - description: 'True if the key''s lifetime is managed by key vault. If this diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyProperties.yml index 084efc90..7a079ee6 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyProperties.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyProperties.yml @@ -34,13 +34,13 @@ constructor: - keywordOnlyParameters: - name: exportable - isRequired: true + defaultValue: None - name: key_type - isRequired: true + defaultValue: None - name: key_size - isRequired: true + defaultValue: None - name: reuse_key - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.KeyProperties.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyUpdateParameters.yml index 6547c62e..00e345af 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.KeyUpdateParameters.yml @@ -26,11 +26,11 @@ constructor: - [, ] keywordOnlyParameters: - name: key_ops - isRequired: true + defaultValue: None - name: key_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.KeyUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.LifetimeAction.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.LifetimeAction.yml index 5c12d613..78705455 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.LifetimeAction.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.LifetimeAction.yml @@ -21,9 +21,9 @@ constructor: - keywordOnlyParameters: - name: trigger - isRequired: true + defaultValue: None - name: action - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.LifetimeAction.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.OrganizationDetails.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.OrganizationDetails.yml index 6cff66de..09aeeb45 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.OrganizationDetails.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.OrganizationDetails.yml @@ -19,9 +19,9 @@ constructor: - [] keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: admin_details - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.OrganizationDetails.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionAttributes.yml index 9e81324b..ad770b67 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionAttributes.yml @@ -19,7 +19,7 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionCreateParameters.yml index 83c1aace..628ccfb4 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionCreateParameters.yml @@ -32,9 +32,9 @@ constructor: - name: parameters isRequired: true - name: sas_definition_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.SasDefinitionCreateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionUpdateParameters.yml index 57ef96a9..0ad7ac50 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SasDefinitionUpdateParameters.yml @@ -27,11 +27,11 @@ constructor: - [, ] keywordOnlyParameters: - name: parameters - isRequired: true + defaultValue: None - name: sas_definition_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.SasDefinitionUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretAttributes.yml index 9ac0afa4..d97af1ec 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretAttributes.yml @@ -30,11 +30,11 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None - name: not_before - isRequired: true + defaultValue: None - name: expires - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretBundle.yml index 47574638..27a20fec 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretBundle.yml @@ -40,15 +40,15 @@ constructor: - [, ] keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None variables: - description: 'If this is a secret backing a KV certificate, then this field diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretItem.yml index 33280603..e520acf4 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretItem.yml @@ -35,13 +35,13 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None variables: - description: 'True if the secret''s lifetime is managed by key vault. If diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretProperties.yml index 3b5b97d5..1d02634e 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretProperties.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretProperties.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: content_type - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.SecretProperties.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretSetParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretSetParameters.yml index 34bcb576..350b6f11 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretSetParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretSetParameters.yml @@ -35,11 +35,11 @@ constructor: - name: value isRequired: true - name: tags - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: secret_attributes - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.SecretSetParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretUpdateParameters.yml index 8059c2b7..20d4f171 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SecretUpdateParameters.yml @@ -25,11 +25,11 @@ constructor: - [, ] keywordOnlyParameters: - name: content_type - isRequired: true + defaultValue: None - name: secret_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.SecretUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountAttributes.yml index b2469149..eb10bf30 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountAttributes.yml @@ -19,7 +19,7 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountCreateParameters.yml index 6090df86..e3e813cf 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountCreateParameters.yml @@ -54,11 +54,11 @@ constructor: - name: auto_regenerate_key isRequired: true - name: regeneration_period - isRequired: true + defaultValue: None - name: storage_account_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.StorageAccountCreateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountUpdateParameters.yml index f95425fa..a28a9006 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.StorageAccountUpdateParameters.yml @@ -40,15 +40,15 @@ constructor: - [, ] keywordOnlyParameters: - name: active_key_name - isRequired: true + defaultValue: None - name: auto_regenerate_key - isRequired: true + defaultValue: None - name: regeneration_period - isRequired: true + defaultValue: None - name: storage_account_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.StorageAccountUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SubjectAlternativeNames.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SubjectAlternativeNames.yml index f8b921b0..ad521f9d 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SubjectAlternativeNames.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.SubjectAlternativeNames.yml @@ -24,11 +24,11 @@ constructor: - [] keywordOnlyParameters: - name: emails - isRequired: true + defaultValue: None - name: dns_names - isRequired: true + defaultValue: None - name: upns - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.SubjectAlternativeNames.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Trigger(class).yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Trigger(class).yml index cfdae830..c567b3bb 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Trigger(class).yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.Trigger(class).yml @@ -28,9 +28,9 @@ constructor: - keywordOnlyParameters: - name: lifetime_percentage - isRequired: true + defaultValue: None - name: days_before_expiry - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.Trigger.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.X509CertificateProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.X509CertificateProperties.yml index 172033d7..0392cc39 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.X509CertificateProperties.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.X509CertificateProperties.yml @@ -40,15 +40,15 @@ constructor: - keywordOnlyParameters: - name: subject - isRequired: true + defaultValue: None - name: ekus - isRequired: true + defaultValue: None - name: subject_alternative_names - isRequired: true + defaultValue: None - name: key_usage - isRequired: true + defaultValue: None - name: validity_in_months - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.X509CertificateProperties.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.action_py3.Action.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.action_py3.Action.yml index fca338ed..0ea54043 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.action_py3.Action.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.action_py3.Action.yml @@ -17,7 +17,7 @@ constructor: - keywordOnlyParameters: - name: action_type - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.action_py3.Action.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.administrator_details_py3.AdministratorDetails.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.administrator_details_py3.AdministratorDetails.yml index ad464936..7a299370 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.administrator_details_py3.AdministratorDetails.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.administrator_details_py3.AdministratorDetails.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: first_name - isRequired: true + defaultValue: None - name: last_name - isRequired: true + defaultValue: None - name: email_address - isRequired: true + defaultValue: None - name: phone - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.administrator_details_py3.AdministratorDetails.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.attributes_py3.Attributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.attributes_py3.Attributes.yml index 2d1c2e81..d0c232f2 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.attributes_py3.Attributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.attributes_py3.Attributes.yml @@ -29,11 +29,11 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None - name: not_before - isRequired: true + defaultValue: None - name: expires - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_attributes_py3.CertificateAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_attributes_py3.CertificateAttributes.yml index 19ed3c1c..164418cb 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_attributes_py3.CertificateAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_attributes_py3.CertificateAttributes.yml @@ -30,11 +30,11 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None - name: not_before - isRequired: true + defaultValue: None - name: expires - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_bundle_py3.CertificateBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_bundle_py3.CertificateBundle.yml index ff407241..aeed635c 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_bundle_py3.CertificateBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_bundle_py3.CertificateBundle.yml @@ -35,13 +35,13 @@ constructor: - [, ] keywordOnlyParameters: - name: cer - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None variables: - description: The certificate id. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.CertificateCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.CertificateCreateParameters.yml index 51347987..d55ed2fb 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.CertificateCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.CertificateCreateParameters.yml @@ -27,11 +27,11 @@ constructor: - [, ] keywordOnlyParameters: - name: certificate_policy - isRequired: true + defaultValue: None - name: certificate_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.certificate_create_parameters_py3.CertificateCreateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.CertificateImportParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.CertificateImportParameters.yml index b93b8e9e..bddf8f04 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.CertificateImportParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.CertificateImportParameters.yml @@ -48,13 +48,13 @@ constructor: - name: base64_encoded_certificate isRequired: true - name: password - isRequired: true + defaultValue: None - name: certificate_policy - isRequired: true + defaultValue: None - name: certificate_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.certificate_import_parameters_py3.CertificateImportParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.CertificateIssuerItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.CertificateIssuerItem.yml index 173c7977..d27dec03 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.CertificateIssuerItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.CertificateIssuerItem.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: provider - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.certificate_issuer_item_py3.CertificateIssuerItem.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.yml index 6962edc4..52d25249 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.yml @@ -37,11 +37,11 @@ constructor: - name: provider isRequired: true - name: credentials - isRequired: true + defaultValue: None - name: organization_details - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.yml index bc7991e4..8cd18a49 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.yml @@ -32,13 +32,13 @@ constructor: - keywordOnlyParameters: - name: provider - isRequired: true + defaultValue: None - name: credentials - isRequired: true + defaultValue: None - name: organization_details - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item_py3.CertificateItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item_py3.CertificateItem.yml index b9c67403..2e0ebcf9 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item_py3.CertificateItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_item_py3.CertificateItem.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: x509_thumbprint - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.certificate_item_py3.CertificateItem.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.CertificateMergeParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.CertificateMergeParameters.yml index c3bab9b7..946718e4 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.CertificateMergeParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.CertificateMergeParameters.yml @@ -34,9 +34,9 @@ constructor: - name: x509_certificates isRequired: true - name: certificate_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.certificate_merge_parameters_py3.CertificateMergeParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_py3.CertificateOperation.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_py3.CertificateOperation.yml index 8b7b2249..62377f39 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_py3.CertificateOperation.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_operation_py3.CertificateOperation.yml @@ -64,21 +64,21 @@ constructor: - keywordOnlyParameters: - name: issuer_parameters - isRequired: true + defaultValue: None - name: csr - isRequired: true + defaultValue: None - name: cancellation_requested - isRequired: true + defaultValue: None - name: status - isRequired: true + defaultValue: None - name: status_details - isRequired: true + defaultValue: None - name: error - isRequired: true + defaultValue: None - name: target - isRequired: true + defaultValue: None - name: request_id - isRequired: true + defaultValue: None variables: - description: The certificate id. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_policy_py3.CertificatePolicy.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_policy_py3.CertificatePolicy.yml index 980e222f..c3e55bdd 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_policy_py3.CertificatePolicy.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_policy_py3.CertificatePolicy.yml @@ -51,17 +51,17 @@ constructor: - keywordOnlyParameters: - name: key_properties - isRequired: true + defaultValue: None - name: secret_properties - isRequired: true + defaultValue: None - name: x509_certificate_properties - isRequired: true + defaultValue: None - name: lifetime_actions - isRequired: true + defaultValue: None - name: issuer_parameters - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None variables: - description: The certificate id. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.CertificateUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.CertificateUpdateParameters.yml index 0f765989..3ebb02e6 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.CertificateUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.CertificateUpdateParameters.yml @@ -27,11 +27,11 @@ constructor: - [, ] keywordOnlyParameters: - name: certificate_policy - isRequired: true + defaultValue: None - name: certificate_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.certificate_update_parameters_py3.CertificateUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contact_py3.Contact.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contact_py3.Contact.yml index ec40e02d..8f7d0d76 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contact_py3.Contact.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contact_py3.Contact.yml @@ -25,11 +25,11 @@ constructor: - keywordOnlyParameters: - name: email_address - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: phone - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.contact_py3.Contact.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contacts_py3.Contacts.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contacts_py3.Contacts.yml index 17ff13d0..fae5b359 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contacts_py3.Contacts.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.contacts_py3.Contacts.yml @@ -19,7 +19,7 @@ constructor: - [] keywordOnlyParameters: - name: contact_list - isRequired: true + defaultValue: None variables: - description: Identifier for the contacts collection. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.yml index 01835338..15632599 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.yml @@ -44,15 +44,15 @@ constructor: - keywordOnlyParameters: - name: cer - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: The certificate id. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3.DeletedCertificateItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3.DeletedCertificateItem.yml index 2978191f..9da6d73b 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3.DeletedCertificateItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_certificate_item_py3.DeletedCertificateItem.yml @@ -44,15 +44,15 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: x509_thumbprint - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: 'The time when the certificate is scheduled to diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3.DeletedKeyBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3.DeletedKeyBundle.yml index 6057b874..77dfce9b 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3.DeletedKeyBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_bundle_py3.DeletedKeyBundle.yml @@ -39,13 +39,13 @@ constructor: - keywordOnlyParameters: - name: key - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: 'True if the key''s lifetime is managed by key vault. If this diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item_py3.DeletedKeyItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item_py3.DeletedKeyItem.yml index 6b6a615c..dc4094c2 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item_py3.DeletedKeyItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_key_item_py3.DeletedKeyItem.yml @@ -39,13 +39,13 @@ constructor: - keywordOnlyParameters: - name: kid - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: 'True if the key''s lifetime is managed by key vault. If this diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3.DeletedSecretBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3.DeletedSecretBundle.yml index 9522c6e5..dab2bb30 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3.DeletedSecretBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_bundle_py3.DeletedSecretBundle.yml @@ -50,17 +50,17 @@ constructor: - keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: 'If this is a secret backing a KV certificate, then this field diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item_py3.DeletedSecretItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item_py3.DeletedSecretItem.yml index 674ab0a1..877105dd 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item_py3.DeletedSecretItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.deleted_secret_item_py3.DeletedSecretItem.yml @@ -42,15 +42,15 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: 'True if the secret''s lifetime is managed by key vault. If diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_attributes_py3.IssuerAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_attributes_py3.IssuerAttributes.yml index a74667e5..10c485f9 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_attributes_py3.IssuerAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_attributes_py3.IssuerAttributes.yml @@ -19,7 +19,7 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_bundle_py3.IssuerBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_bundle_py3.IssuerBundle.yml index 01ca999e..b3b793e1 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_bundle_py3.IssuerBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_bundle_py3.IssuerBundle.yml @@ -37,13 +37,13 @@ constructor: - keywordOnlyParameters: - name: provider - isRequired: true + defaultValue: None - name: credentials - isRequired: true + defaultValue: None - name: organization_details - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None variables: - description: Identifier for the issuer object. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_credentials_py3.IssuerCredentials.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_credentials_py3.IssuerCredentials.yml index edd63e43..eda08221 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_credentials_py3.IssuerCredentials.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_credentials_py3.IssuerCredentials.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: account_id - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.issuer_credentials_py3.IssuerCredentials.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_parameters_py3.IssuerParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_parameters_py3.IssuerParameters.yml index a6202bb2..7d984ded 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_parameters_py3.IssuerParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.issuer_parameters_py3.IssuerParameters.yml @@ -23,9 +23,9 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: certificate_type - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.issuer_parameters_py3.IssuerParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.json_web_key_py3.JsonWebKey.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.json_web_key_py3.JsonWebKey.yml index d89bcfa4..d488e3b2 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.json_web_key_py3.JsonWebKey.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.json_web_key_py3.JsonWebKey.yml @@ -99,37 +99,37 @@ constructor: - keywordOnlyParameters: - name: kid - isRequired: true + defaultValue: None - name: kty - isRequired: true + defaultValue: None - name: key_ops - isRequired: true + defaultValue: None - name: n - isRequired: true + defaultValue: None - name: e - isRequired: true + defaultValue: None - name: d - isRequired: true + defaultValue: None - name: dp - isRequired: true + defaultValue: None - name: dq - isRequired: true + defaultValue: None - name: qi - isRequired: true + defaultValue: None - name: p - isRequired: true + defaultValue: None - name: q - isRequired: true + defaultValue: None - name: k - isRequired: true + defaultValue: None - name: t - isRequired: true + defaultValue: None - name: crv - isRequired: true + defaultValue: None - name: x - isRequired: true + defaultValue: None - name: y - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.json_web_key_py3.JsonWebKey.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_attributes_py3.KeyAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_attributes_py3.KeyAttributes.yml index 61688fa0..5360889a 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_attributes_py3.KeyAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_attributes_py3.KeyAttributes.yml @@ -29,11 +29,11 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None - name: not_before - isRequired: true + defaultValue: None - name: expires - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_bundle_py3.KeyBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_bundle_py3.KeyBundle.yml index 2e5dc2ca..5f762ecd 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_bundle_py3.KeyBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_bundle_py3.KeyBundle.yml @@ -29,11 +29,11 @@ constructor: - [, ] keywordOnlyParameters: - name: key - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None variables: - description: 'True if the key''s lifetime is managed by key vault. If this diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_create_parameters_py3.KeyCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_create_parameters_py3.KeyCreateParameters.yml index 5bf546d8..f31fc9c9 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_create_parameters_py3.KeyCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_create_parameters_py3.KeyCreateParameters.yml @@ -56,15 +56,15 @@ constructor: - name: kty isRequired: true - name: key_size - isRequired: true + defaultValue: None - name: key_ops - isRequired: true + defaultValue: None - name: key_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: curve - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.key_create_parameters_py3.KeyCreateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_import_parameters_py3.KeyImportParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_import_parameters_py3.KeyImportParameters.yml index a0a7b4f6..368741e2 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_import_parameters_py3.KeyImportParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_import_parameters_py3.KeyImportParameters.yml @@ -35,11 +35,11 @@ constructor: - name: key isRequired: true - name: hsm - isRequired: true + defaultValue: None - name: key_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.key_import_parameters_py3.KeyImportParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item_py3.KeyItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item_py3.KeyItem.yml index 5ac30a1f..e47a9fb0 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item_py3.KeyItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_item_py3.KeyItem.yml @@ -29,11 +29,11 @@ constructor: - [, ] keywordOnlyParameters: - name: kid - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None variables: - description: 'True if the key''s lifetime is managed by key vault. If this diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_properties_py3.KeyProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_properties_py3.KeyProperties.yml index dc5df794..38f1ddde 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_properties_py3.KeyProperties.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_properties_py3.KeyProperties.yml @@ -34,13 +34,13 @@ constructor: - keywordOnlyParameters: - name: exportable - isRequired: true + defaultValue: None - name: key_type - isRequired: true + defaultValue: None - name: key_size - isRequired: true + defaultValue: None - name: reuse_key - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.key_properties_py3.KeyProperties.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_update_parameters_py3.KeyUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_update_parameters_py3.KeyUpdateParameters.yml index e4e29e81..b381549e 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_update_parameters_py3.KeyUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.key_update_parameters_py3.KeyUpdateParameters.yml @@ -26,11 +26,11 @@ constructor: - [, ] keywordOnlyParameters: - name: key_ops - isRequired: true + defaultValue: None - name: key_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.key_update_parameters_py3.KeyUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.lifetime_action_py3.LifetimeAction.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.lifetime_action_py3.LifetimeAction.yml index 919a1a62..d8820324 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.lifetime_action_py3.LifetimeAction.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.lifetime_action_py3.LifetimeAction.yml @@ -21,9 +21,9 @@ constructor: - keywordOnlyParameters: - name: trigger - isRequired: true + defaultValue: None - name: action - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.lifetime_action_py3.LifetimeAction.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.organization_details_py3.OrganizationDetails.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.organization_details_py3.OrganizationDetails.yml index 23453afe..c62e303c 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.organization_details_py3.OrganizationDetails.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.organization_details_py3.OrganizationDetails.yml @@ -19,9 +19,9 @@ constructor: - [] keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: admin_details - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.organization_details_py3.OrganizationDetails.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3.SasDefinitionAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3.SasDefinitionAttributes.yml index 89430afa..c814e6fd 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3.SasDefinitionAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_attributes_py3.SasDefinitionAttributes.yml @@ -19,7 +19,7 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.yml index bcefd9e1..b945d65b 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.yml @@ -32,9 +32,9 @@ constructor: - name: parameters isRequired: true - name: sas_definition_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.yml index 99346ad2..a618d878 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.yml @@ -27,11 +27,11 @@ constructor: - [, ] keywordOnlyParameters: - name: parameters - isRequired: true + defaultValue: None - name: sas_definition_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_attributes_py3.SecretAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_attributes_py3.SecretAttributes.yml index e0cf4089..828ae54a 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_attributes_py3.SecretAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_attributes_py3.SecretAttributes.yml @@ -30,11 +30,11 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None - name: not_before - isRequired: true + defaultValue: None - name: expires - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_bundle_py3.SecretBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_bundle_py3.SecretBundle.yml index 2271b23c..14202300 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_bundle_py3.SecretBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_bundle_py3.SecretBundle.yml @@ -40,15 +40,15 @@ constructor: - [, ] keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None variables: - description: 'If this is a secret backing a KV certificate, then this field diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item_py3.SecretItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item_py3.SecretItem.yml index cc7b5d2e..beaf361b 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item_py3.SecretItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_item_py3.SecretItem.yml @@ -35,13 +35,13 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None variables: - description: 'True if the secret''s lifetime is managed by key vault. If diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_properties_py3.SecretProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_properties_py3.SecretProperties.yml index 60db5ccf..51cbe4a1 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_properties_py3.SecretProperties.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_properties_py3.SecretProperties.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: content_type - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.secret_properties_py3.SecretProperties.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.SecretSetParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.SecretSetParameters.yml index 79653201..da677b0f 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.SecretSetParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.SecretSetParameters.yml @@ -35,11 +35,11 @@ constructor: - name: value isRequired: true - name: tags - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: secret_attributes - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.secret_set_parameters_py3.SecretSetParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.SecretUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.SecretUpdateParameters.yml index dbea5923..3679b72b 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.SecretUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.SecretUpdateParameters.yml @@ -25,11 +25,11 @@ constructor: - [, ] keywordOnlyParameters: - name: content_type - isRequired: true + defaultValue: None - name: secret_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.secret_update_parameters_py3.SecretUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_attributes_py3.StorageAccountAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_attributes_py3.StorageAccountAttributes.yml index e9dd6503..319787f9 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_attributes_py3.StorageAccountAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_attributes_py3.StorageAccountAttributes.yml @@ -19,7 +19,7 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.yml index 2898b239..e205dd56 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.yml @@ -54,11 +54,11 @@ constructor: - name: auto_regenerate_key isRequired: true - name: regeneration_period - isRequired: true + defaultValue: None - name: storage_account_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.yml index 0b6151a1..66b5839e 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.yml @@ -40,15 +40,15 @@ constructor: - [, ] keywordOnlyParameters: - name: active_key_name - isRequired: true + defaultValue: None - name: auto_regenerate_key - isRequired: true + defaultValue: None - name: regeneration_period - isRequired: true + defaultValue: None - name: storage_account_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.SubjectAlternativeNames.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.SubjectAlternativeNames.yml index b609a3c0..ba4e32fe 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.SubjectAlternativeNames.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.SubjectAlternativeNames.yml @@ -24,11 +24,11 @@ constructor: - [] keywordOnlyParameters: - name: emails - isRequired: true + defaultValue: None - name: dns_names - isRequired: true + defaultValue: None - name: upns - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.subject_alternative_names_py3.SubjectAlternativeNames.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.trigger_py3.Trigger.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.trigger_py3.Trigger.yml index 6a742f88..cb6c49dc 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.trigger_py3.Trigger.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.trigger_py3.Trigger.yml @@ -28,9 +28,9 @@ constructor: - keywordOnlyParameters: - name: lifetime_percentage - isRequired: true + defaultValue: None - name: days_before_expiry - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.trigger_py3.Trigger.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.X509CertificateProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.X509CertificateProperties.yml index c42da771..b88f38dc 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.X509CertificateProperties.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.X509CertificateProperties.yml @@ -40,15 +40,15 @@ constructor: - keywordOnlyParameters: - name: subject - isRequired: true + defaultValue: None - name: ekus - isRequired: true + defaultValue: None - name: subject_alternative_names - isRequired: true + defaultValue: None - name: key_usage - isRequired: true + defaultValue: None - name: validity_in_months - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v2016_10_01.models.x509_certificate_properties_py3.X509CertificateProperties.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Action(class).yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Action(class).yml index 587af155..ea232e88 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Action(class).yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Action(class).yml @@ -17,7 +17,7 @@ constructor: - keywordOnlyParameters: - name: action_type - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.Action.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.AdministratorDetails.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.AdministratorDetails.yml index d72d1a43..61c90e9d 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.AdministratorDetails.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.AdministratorDetails.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: first_name - isRequired: true + defaultValue: None - name: last_name - isRequired: true + defaultValue: None - name: email_address - isRequired: true + defaultValue: None - name: phone - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.AdministratorDetails.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Attributes(class).yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Attributes(class).yml index 5b996439..33db934a 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Attributes(class).yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Attributes(class).yml @@ -29,11 +29,11 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None - name: not_before - isRequired: true + defaultValue: None - name: expires - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateAttributes.yml index a3732cf4..75d26c4b 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateAttributes.yml @@ -30,11 +30,11 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None - name: not_before - isRequired: true + defaultValue: None - name: expires - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateBundle.yml index 6cc23243..cb6d8a8f 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateBundle.yml @@ -35,13 +35,13 @@ constructor: - [, ] keywordOnlyParameters: - name: cer - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None variables: - description: The certificate id. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateCreateParameters.yml index f86fe662..a0c706cc 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateCreateParameters.yml @@ -27,11 +27,11 @@ constructor: - [, ] keywordOnlyParameters: - name: certificate_policy - isRequired: true + defaultValue: None - name: certificate_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.CertificateCreateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateImportParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateImportParameters.yml index fd83415a..1e5030ea 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateImportParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateImportParameters.yml @@ -48,13 +48,13 @@ constructor: - name: base64_encoded_certificate isRequired: true - name: password - isRequired: true + defaultValue: None - name: certificate_policy - isRequired: true + defaultValue: None - name: certificate_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.CertificateImportParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerItem.yml index 7b0c6810..faf4231d 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerItem.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: provider - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.CertificateIssuerItem.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerSetParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerSetParameters.yml index ae8d9904..a9387fd1 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerSetParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerSetParameters.yml @@ -37,11 +37,11 @@ constructor: - name: provider isRequired: true - name: credentials - isRequired: true + defaultValue: None - name: organization_details - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.CertificateIssuerSetParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerUpdateParameters.yml index 321a8fe5..cc828a68 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateIssuerUpdateParameters.yml @@ -32,13 +32,13 @@ constructor: - keywordOnlyParameters: - name: provider - isRequired: true + defaultValue: None - name: credentials - isRequired: true + defaultValue: None - name: organization_details - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.CertificateIssuerUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateItem.yml index 8b71bcda..1fd5e242 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateItem.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: x509_thumbprint - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.CertificateItem.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateMergeParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateMergeParameters.yml index 93fe66d1..8468d198 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateMergeParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateMergeParameters.yml @@ -34,9 +34,9 @@ constructor: - name: x509_certificates isRequired: true - name: certificate_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.CertificateMergeParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateOperation.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateOperation.yml index c3765422..a5cf1550 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateOperation.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateOperation.yml @@ -64,21 +64,21 @@ constructor: - keywordOnlyParameters: - name: issuer_parameters - isRequired: true + defaultValue: None - name: csr - isRequired: true + defaultValue: None - name: cancellation_requested - isRequired: true + defaultValue: None - name: status - isRequired: true + defaultValue: None - name: status_details - isRequired: true + defaultValue: None - name: error - isRequired: true + defaultValue: None - name: target - isRequired: true + defaultValue: None - name: request_id - isRequired: true + defaultValue: None variables: - description: The certificate id. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificatePolicy.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificatePolicy.yml index abcfbaf3..53346cb6 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificatePolicy.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificatePolicy.yml @@ -51,17 +51,17 @@ constructor: - keywordOnlyParameters: - name: key_properties - isRequired: true + defaultValue: None - name: secret_properties - isRequired: true + defaultValue: None - name: x509_certificate_properties - isRequired: true + defaultValue: None - name: lifetime_actions - isRequired: true + defaultValue: None - name: issuer_parameters - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None variables: - description: The certificate id. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateUpdateParameters.yml index cb9efcd3..0db87551 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.CertificateUpdateParameters.yml @@ -27,11 +27,11 @@ constructor: - [, ] keywordOnlyParameters: - name: certificate_policy - isRequired: true + defaultValue: None - name: certificate_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.CertificateUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Contact(class).yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Contact(class).yml index c15922f5..d607dc23 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Contact(class).yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Contact(class).yml @@ -25,11 +25,11 @@ constructor: - keywordOnlyParameters: - name: email_address - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: phone - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.Contact.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Contacts(class).yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Contacts(class).yml index 16ae8907..c4649b90 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Contacts(class).yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Contacts(class).yml @@ -19,7 +19,7 @@ constructor: - [] keywordOnlyParameters: - name: contact_list - isRequired: true + defaultValue: None variables: - description: Identifier for the contacts collection. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedCertificateBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedCertificateBundle.yml index b36f784d..44402419 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedCertificateBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedCertificateBundle.yml @@ -44,15 +44,15 @@ constructor: - keywordOnlyParameters: - name: cer - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: The certificate id. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedCertificateItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedCertificateItem.yml index fb3987b7..4f7aac49 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedCertificateItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedCertificateItem.yml @@ -44,15 +44,15 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: x509_thumbprint - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: 'The time when the certificate is scheduled to diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedKeyBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedKeyBundle.yml index 962a8e94..450f7b49 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedKeyBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedKeyBundle.yml @@ -39,13 +39,13 @@ constructor: - keywordOnlyParameters: - name: key - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: 'True if the key''s lifetime is managed by key vault. If this diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedKeyItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedKeyItem.yml index ca35e738..97a563de 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedKeyItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedKeyItem.yml @@ -39,13 +39,13 @@ constructor: - keywordOnlyParameters: - name: kid - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: 'True if the key''s lifetime is managed by key vault. If this diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSasDefinitionBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSasDefinitionBundle.yml index bd7805a4..1ab45326 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSasDefinitionBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSasDefinitionBundle.yml @@ -23,7 +23,7 @@ constructor: - keywordOnlyParameters: - name: recovery_id - isRequired: true + defaultValue: None variables: - description: The SAS definition id. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSasDefinitionItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSasDefinitionItem.yml index 5d98d4ca..ccad1a7f 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSasDefinitionItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSasDefinitionItem.yml @@ -23,7 +23,7 @@ constructor: - keywordOnlyParameters: - name: recovery_id - isRequired: true + defaultValue: None variables: - description: The storage SAS identifier. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSecretBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSecretBundle.yml index c948b932..25d4e782 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSecretBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSecretBundle.yml @@ -50,17 +50,17 @@ constructor: - keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: 'If this is a secret backing a KV certificate, then this field diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSecretItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSecretItem.yml index 12525508..a9f57e22 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSecretItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedSecretItem.yml @@ -42,15 +42,15 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: 'True if the secret''s lifetime is managed by key vault. If diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedStorageAccountItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedStorageAccountItem.yml index c0ab6b35..5d5de6bd 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedStorageAccountItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedStorageAccountItem.yml @@ -23,7 +23,7 @@ constructor: - keywordOnlyParameters: - name: recovery_id - isRequired: true + defaultValue: None variables: - description: Storage identifier. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedStorageBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedStorageBundle.yml index eb60a521..f2980999 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedStorageBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.DeletedStorageBundle.yml @@ -23,7 +23,7 @@ constructor: - keywordOnlyParameters: - name: recovery_id - isRequired: true + defaultValue: None variables: - description: The storage account id. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerAttributes.yml index c73a2686..ff5968f8 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerAttributes.yml @@ -19,7 +19,7 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerBundle.yml index 61e96ec0..fc0a2d77 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerBundle.yml @@ -37,13 +37,13 @@ constructor: - keywordOnlyParameters: - name: provider - isRequired: true + defaultValue: None - name: credentials - isRequired: true + defaultValue: None - name: organization_details - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None variables: - description: Identifier for the issuer object. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerCredentials.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerCredentials.yml index f780dfd5..93d34b16 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerCredentials.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerCredentials.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: account_id - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.IssuerCredentials.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerParameters.yml index e1607af6..6cfe0669 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.IssuerParameters.yml @@ -31,11 +31,11 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: certificate_type - isRequired: true + defaultValue: None - name: certificate_transparency - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.IssuerParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKey.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKey.yml index 5684cbb8..77b50b46 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKey.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.JsonWebKey.yml @@ -101,37 +101,37 @@ constructor: - keywordOnlyParameters: - name: kid - isRequired: true + defaultValue: None - name: kty - isRequired: true + defaultValue: None - name: key_ops - isRequired: true + defaultValue: None - name: n - isRequired: true + defaultValue: None - name: e - isRequired: true + defaultValue: None - name: d - isRequired: true + defaultValue: None - name: dp - isRequired: true + defaultValue: None - name: dq - isRequired: true + defaultValue: None - name: qi - isRequired: true + defaultValue: None - name: p - isRequired: true + defaultValue: None - name: q - isRequired: true + defaultValue: None - name: k - isRequired: true + defaultValue: None - name: t - isRequired: true + defaultValue: None - name: crv - isRequired: true + defaultValue: None - name: x - isRequired: true + defaultValue: None - name: y - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.JsonWebKey.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyAttributes.yml index d558ebcb..a611260f 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyAttributes.yml @@ -29,11 +29,11 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None - name: not_before - isRequired: true + defaultValue: None - name: expires - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyBundle.yml index 5e9091f9..edd140b8 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyBundle.yml @@ -29,11 +29,11 @@ constructor: - [, ] keywordOnlyParameters: - name: key - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None variables: - description: 'True if the key''s lifetime is managed by key vault. If this diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyCreateParameters.yml index 67e98ca7..a2a52820 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyCreateParameters.yml @@ -56,15 +56,15 @@ constructor: - name: kty isRequired: true - name: key_size - isRequired: true + defaultValue: None - name: key_ops - isRequired: true + defaultValue: None - name: key_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: curve - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.KeyCreateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyImportParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyImportParameters.yml index 167b3c5b..bfbe5f8a 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyImportParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyImportParameters.yml @@ -35,11 +35,11 @@ constructor: - name: key isRequired: true - name: hsm - isRequired: true + defaultValue: None - name: key_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.KeyImportParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyItem.yml index 5bcb52fb..8e1cbcd5 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyItem.yml @@ -29,11 +29,11 @@ constructor: - [, ] keywordOnlyParameters: - name: kid - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None variables: - description: 'True if the key''s lifetime is managed by key vault. If this diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyProperties.yml index 122820ae..6cc16ed5 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyProperties.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyProperties.yml @@ -47,15 +47,15 @@ constructor: - keywordOnlyParameters: - name: exportable - isRequired: true + defaultValue: None - name: key_type - isRequired: true + defaultValue: None - name: key_size - isRequired: true + defaultValue: None - name: reuse_key - isRequired: true + defaultValue: None - name: curve - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.KeyProperties.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyUpdateParameters.yml index bc3f5429..f8dfebd0 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.KeyUpdateParameters.yml @@ -26,11 +26,11 @@ constructor: - [, ] keywordOnlyParameters: - name: key_ops - isRequired: true + defaultValue: None - name: key_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.KeyUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.LifetimeAction.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.LifetimeAction.yml index 0542a46b..020d47e8 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.LifetimeAction.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.LifetimeAction.yml @@ -21,9 +21,9 @@ constructor: - keywordOnlyParameters: - name: trigger - isRequired: true + defaultValue: None - name: action - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.LifetimeAction.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.OrganizationDetails.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.OrganizationDetails.yml index 327fc90d..eb077cb2 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.OrganizationDetails.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.OrganizationDetails.yml @@ -19,9 +19,9 @@ constructor: - [] keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: admin_details - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.OrganizationDetails.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionAttributes.yml index 5fe82bf9..cc9edd50 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionAttributes.yml @@ -19,7 +19,7 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionCreateParameters.yml index be62b73c..75924d13 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionCreateParameters.yml @@ -53,9 +53,9 @@ constructor: - name: validity_period isRequired: true - name: sas_definition_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.SasDefinitionCreateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionUpdateParameters.yml index 13c74ee5..f1a3d990 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SasDefinitionUpdateParameters.yml @@ -44,15 +44,15 @@ constructor: - [, ] keywordOnlyParameters: - name: template_uri - isRequired: true + defaultValue: None - name: sas_type - isRequired: true + defaultValue: None - name: validity_period - isRequired: true + defaultValue: None - name: sas_definition_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.SasDefinitionUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretAttributes.yml index 6191f981..e9d7e386 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretAttributes.yml @@ -30,11 +30,11 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None - name: not_before - isRequired: true + defaultValue: None - name: expires - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretBundle.yml index 52e58cca..71d2225d 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretBundle.yml @@ -40,15 +40,15 @@ constructor: - [, ] keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None variables: - description: 'If this is a secret backing a KV certificate, then this field diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretItem.yml index b74648b2..0f67d220 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretItem.yml @@ -35,13 +35,13 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None variables: - description: 'True if the secret''s lifetime is managed by key vault. If diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretProperties.yml index 2eeab73c..2109ab26 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretProperties.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretProperties.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: content_type - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.SecretProperties.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretSetParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretSetParameters.yml index 80f68ab7..5bb50a63 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretSetParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretSetParameters.yml @@ -35,11 +35,11 @@ constructor: - name: value isRequired: true - name: tags - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: secret_attributes - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.SecretSetParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretUpdateParameters.yml index 6cba83c0..ac8780cb 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SecretUpdateParameters.yml @@ -25,11 +25,11 @@ constructor: - [, ] keywordOnlyParameters: - name: content_type - isRequired: true + defaultValue: None - name: secret_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.SecretUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountAttributes.yml index 43678502..261fb1a3 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountAttributes.yml @@ -19,7 +19,7 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountCreateParameters.yml index 9483c11f..c30475c0 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountCreateParameters.yml @@ -54,11 +54,11 @@ constructor: - name: auto_regenerate_key isRequired: true - name: regeneration_period - isRequired: true + defaultValue: None - name: storage_account_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.StorageAccountCreateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountUpdateParameters.yml index 296d8895..ebada4c8 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.StorageAccountUpdateParameters.yml @@ -40,15 +40,15 @@ constructor: - [, ] keywordOnlyParameters: - name: active_key_name - isRequired: true + defaultValue: None - name: auto_regenerate_key - isRequired: true + defaultValue: None - name: regeneration_period - isRequired: true + defaultValue: None - name: storage_account_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.StorageAccountUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SubjectAlternativeNames.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SubjectAlternativeNames.yml index e2a70167..1084b55b 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SubjectAlternativeNames.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.SubjectAlternativeNames.yml @@ -24,11 +24,11 @@ constructor: - [] keywordOnlyParameters: - name: emails - isRequired: true + defaultValue: None - name: dns_names - isRequired: true + defaultValue: None - name: upns - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.SubjectAlternativeNames.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Trigger(class).yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Trigger(class).yml index 5cfc2b7a..34cb7f03 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Trigger(class).yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.Trigger(class).yml @@ -28,9 +28,9 @@ constructor: - keywordOnlyParameters: - name: lifetime_percentage - isRequired: true + defaultValue: None - name: days_before_expiry - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.Trigger.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.X509CertificateProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.X509CertificateProperties.yml index c1fbf888..02235502 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.X509CertificateProperties.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.X509CertificateProperties.yml @@ -40,15 +40,15 @@ constructor: - keywordOnlyParameters: - name: subject - isRequired: true + defaultValue: None - name: ekus - isRequired: true + defaultValue: None - name: subject_alternative_names - isRequired: true + defaultValue: None - name: key_usage - isRequired: true + defaultValue: None - name: validity_in_months - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.X509CertificateProperties.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.action_py3.Action.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.action_py3.Action.yml index 94a84ee6..08ccfbce 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.action_py3.Action.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.action_py3.Action.yml @@ -17,7 +17,7 @@ constructor: - keywordOnlyParameters: - name: action_type - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.action_py3.Action.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.administrator_details_py3.AdministratorDetails.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.administrator_details_py3.AdministratorDetails.yml index fc0d307b..bd5cce3c 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.administrator_details_py3.AdministratorDetails.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.administrator_details_py3.AdministratorDetails.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: first_name - isRequired: true + defaultValue: None - name: last_name - isRequired: true + defaultValue: None - name: email_address - isRequired: true + defaultValue: None - name: phone - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.administrator_details_py3.AdministratorDetails.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.attributes_py3.Attributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.attributes_py3.Attributes.yml index dcf6def0..1bebb561 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.attributes_py3.Attributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.attributes_py3.Attributes.yml @@ -29,11 +29,11 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None - name: not_before - isRequired: true + defaultValue: None - name: expires - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_attributes_py3.CertificateAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_attributes_py3.CertificateAttributes.yml index 982bbbdc..bff6430c 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_attributes_py3.CertificateAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_attributes_py3.CertificateAttributes.yml @@ -30,11 +30,11 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None - name: not_before - isRequired: true + defaultValue: None - name: expires - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_bundle_py3.CertificateBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_bundle_py3.CertificateBundle.yml index d9cf46e6..e90dabfd 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_bundle_py3.CertificateBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_bundle_py3.CertificateBundle.yml @@ -35,13 +35,13 @@ constructor: - [, ] keywordOnlyParameters: - name: cer - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None variables: - description: The certificate id. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_create_parameters_py3.CertificateCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_create_parameters_py3.CertificateCreateParameters.yml index b381fade..8270dc07 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_create_parameters_py3.CertificateCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_create_parameters_py3.CertificateCreateParameters.yml @@ -27,11 +27,11 @@ constructor: - [, ] keywordOnlyParameters: - name: certificate_policy - isRequired: true + defaultValue: None - name: certificate_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.certificate_create_parameters_py3.CertificateCreateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_import_parameters_py3.CertificateImportParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_import_parameters_py3.CertificateImportParameters.yml index 4ecfff66..cf122132 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_import_parameters_py3.CertificateImportParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_import_parameters_py3.CertificateImportParameters.yml @@ -48,13 +48,13 @@ constructor: - name: base64_encoded_certificate isRequired: true - name: password - isRequired: true + defaultValue: None - name: certificate_policy - isRequired: true + defaultValue: None - name: certificate_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.certificate_import_parameters_py3.CertificateImportParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item_py3.CertificateIssuerItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item_py3.CertificateIssuerItem.yml index 7c4421ad..ac060d8d 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item_py3.CertificateIssuerItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_item_py3.CertificateIssuerItem.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: provider - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.certificate_issuer_item_py3.CertificateIssuerItem.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.yml index b5e65b01..f4c46412 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.yml @@ -37,11 +37,11 @@ constructor: - name: provider isRequired: true - name: credentials - isRequired: true + defaultValue: None - name: organization_details - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.certificate_issuer_set_parameters_py3.CertificateIssuerSetParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.yml index 87669150..ce288800 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.yml @@ -32,13 +32,13 @@ constructor: - keywordOnlyParameters: - name: provider - isRequired: true + defaultValue: None - name: credentials - isRequired: true + defaultValue: None - name: organization_details - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.certificate_issuer_update_parameters_py3.CertificateIssuerUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item_py3.CertificateItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item_py3.CertificateItem.yml index d4f42f64..fa48b9de 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item_py3.CertificateItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_item_py3.CertificateItem.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: x509_thumbprint - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.certificate_item_py3.CertificateItem.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_merge_parameters_py3.CertificateMergeParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_merge_parameters_py3.CertificateMergeParameters.yml index cba5714c..e3d04919 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_merge_parameters_py3.CertificateMergeParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_merge_parameters_py3.CertificateMergeParameters.yml @@ -34,9 +34,9 @@ constructor: - name: x509_certificates isRequired: true - name: certificate_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.certificate_merge_parameters_py3.CertificateMergeParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_py3.CertificateOperation.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_py3.CertificateOperation.yml index 56d5a9d1..034e06f3 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_py3.CertificateOperation.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_operation_py3.CertificateOperation.yml @@ -64,21 +64,21 @@ constructor: - keywordOnlyParameters: - name: issuer_parameters - isRequired: true + defaultValue: None - name: csr - isRequired: true + defaultValue: None - name: cancellation_requested - isRequired: true + defaultValue: None - name: status - isRequired: true + defaultValue: None - name: status_details - isRequired: true + defaultValue: None - name: error - isRequired: true + defaultValue: None - name: target - isRequired: true + defaultValue: None - name: request_id - isRequired: true + defaultValue: None variables: - description: The certificate id. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_policy_py3.CertificatePolicy.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_policy_py3.CertificatePolicy.yml index bccf390f..54cf1aff 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_policy_py3.CertificatePolicy.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_policy_py3.CertificatePolicy.yml @@ -51,17 +51,17 @@ constructor: - keywordOnlyParameters: - name: key_properties - isRequired: true + defaultValue: None - name: secret_properties - isRequired: true + defaultValue: None - name: x509_certificate_properties - isRequired: true + defaultValue: None - name: lifetime_actions - isRequired: true + defaultValue: None - name: issuer_parameters - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None variables: - description: The certificate id. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_update_parameters_py3.CertificateUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_update_parameters_py3.CertificateUpdateParameters.yml index 3923b64b..67ad1471 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_update_parameters_py3.CertificateUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.certificate_update_parameters_py3.CertificateUpdateParameters.yml @@ -27,11 +27,11 @@ constructor: - [, ] keywordOnlyParameters: - name: certificate_policy - isRequired: true + defaultValue: None - name: certificate_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.certificate_update_parameters_py3.CertificateUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contact_py3.Contact.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contact_py3.Contact.yml index 69f4f9b7..136d29d4 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contact_py3.Contact.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contact_py3.Contact.yml @@ -25,11 +25,11 @@ constructor: - keywordOnlyParameters: - name: email_address - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: phone - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.contact_py3.Contact.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contacts_py3.Contacts.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contacts_py3.Contacts.yml index 2149f84d..1040dc74 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contacts_py3.Contacts.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.contacts_py3.Contacts.yml @@ -19,7 +19,7 @@ constructor: - [] keywordOnlyParameters: - name: contact_list - isRequired: true + defaultValue: None variables: - description: Identifier for the contacts collection. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.yml index 6134a84d..6a07c76a 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_bundle_py3.DeletedCertificateBundle.yml @@ -44,15 +44,15 @@ constructor: - keywordOnlyParameters: - name: cer - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: The certificate id. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item_py3.DeletedCertificateItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item_py3.DeletedCertificateItem.yml index 4c5ebc18..33fb1324 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item_py3.DeletedCertificateItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_certificate_item_py3.DeletedCertificateItem.yml @@ -44,15 +44,15 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: x509_thumbprint - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: 'The time when the certificate is scheduled to diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_bundle_py3.DeletedKeyBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_bundle_py3.DeletedKeyBundle.yml index 17e5cd34..429b1568 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_bundle_py3.DeletedKeyBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_bundle_py3.DeletedKeyBundle.yml @@ -39,13 +39,13 @@ constructor: - keywordOnlyParameters: - name: key - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: 'True if the key''s lifetime is managed by key vault. If this diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item_py3.DeletedKeyItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item_py3.DeletedKeyItem.yml index 90196f0b..6a07387a 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item_py3.DeletedKeyItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_key_item_py3.DeletedKeyItem.yml @@ -39,13 +39,13 @@ constructor: - keywordOnlyParameters: - name: kid - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: 'True if the key''s lifetime is managed by key vault. If this diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3.DeletedSasDefinitionBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3.DeletedSasDefinitionBundle.yml index 4c47cf14..7ab31bfe 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3.DeletedSasDefinitionBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_bundle_py3.DeletedSasDefinitionBundle.yml @@ -23,7 +23,7 @@ constructor: - keywordOnlyParameters: - name: recovery_id - isRequired: true + defaultValue: None variables: - description: The SAS definition id. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item_py3.DeletedSasDefinitionItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item_py3.DeletedSasDefinitionItem.yml index ba3a6cea..79a9bde9 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item_py3.DeletedSasDefinitionItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_sas_definition_item_py3.DeletedSasDefinitionItem.yml @@ -23,7 +23,7 @@ constructor: - keywordOnlyParameters: - name: recovery_id - isRequired: true + defaultValue: None variables: - description: The storage SAS identifier. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_bundle_py3.DeletedSecretBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_bundle_py3.DeletedSecretBundle.yml index 85f208d8..18a3836a 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_bundle_py3.DeletedSecretBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_bundle_py3.DeletedSecretBundle.yml @@ -50,17 +50,17 @@ constructor: - keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: 'If this is a secret backing a KV certificate, then this field diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item_py3.DeletedSecretItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item_py3.DeletedSecretItem.yml index 53d7a821..17bdbc81 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item_py3.DeletedSecretItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_secret_item_py3.DeletedSecretItem.yml @@ -42,15 +42,15 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: recovery_id - isRequired: true + defaultValue: None variables: - description: 'True if the secret''s lifetime is managed by key vault. If diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item_py3.DeletedStorageAccountItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item_py3.DeletedStorageAccountItem.yml index f0aa4b3e..aa912248 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item_py3.DeletedStorageAccountItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_account_item_py3.DeletedStorageAccountItem.yml @@ -23,7 +23,7 @@ constructor: - keywordOnlyParameters: - name: recovery_id - isRequired: true + defaultValue: None variables: - description: Storage identifier. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_bundle_py3.DeletedStorageBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_bundle_py3.DeletedStorageBundle.yml index c6be3c9f..c6ee4544 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_bundle_py3.DeletedStorageBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.deleted_storage_bundle_py3.DeletedStorageBundle.yml @@ -23,7 +23,7 @@ constructor: - keywordOnlyParameters: - name: recovery_id - isRequired: true + defaultValue: None variables: - description: The storage account id. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_attributes_py3.IssuerAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_attributes_py3.IssuerAttributes.yml index 9beb7d56..484c47f1 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_attributes_py3.IssuerAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_attributes_py3.IssuerAttributes.yml @@ -19,7 +19,7 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_bundle_py3.IssuerBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_bundle_py3.IssuerBundle.yml index b87e0bb7..a9036058 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_bundle_py3.IssuerBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_bundle_py3.IssuerBundle.yml @@ -37,13 +37,13 @@ constructor: - keywordOnlyParameters: - name: provider - isRequired: true + defaultValue: None - name: credentials - isRequired: true + defaultValue: None - name: organization_details - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None variables: - description: Identifier for the issuer object. name: id diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_credentials_py3.IssuerCredentials.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_credentials_py3.IssuerCredentials.yml index 7c5db135..9d90abc7 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_credentials_py3.IssuerCredentials.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_credentials_py3.IssuerCredentials.yml @@ -19,9 +19,9 @@ constructor: - keywordOnlyParameters: - name: account_id - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.issuer_credentials_py3.IssuerCredentials.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_parameters_py3.IssuerParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_parameters_py3.IssuerParameters.yml index 831913b7..3b0f7257 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_parameters_py3.IssuerParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.issuer_parameters_py3.IssuerParameters.yml @@ -31,11 +31,11 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: certificate_type - isRequired: true + defaultValue: None - name: certificate_transparency - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.issuer_parameters_py3.IssuerParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.json_web_key_py3.JsonWebKey.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.json_web_key_py3.JsonWebKey.yml index 7aadda6a..f5a07572 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.json_web_key_py3.JsonWebKey.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.json_web_key_py3.JsonWebKey.yml @@ -101,37 +101,37 @@ constructor: - keywordOnlyParameters: - name: kid - isRequired: true + defaultValue: None - name: kty - isRequired: true + defaultValue: None - name: key_ops - isRequired: true + defaultValue: None - name: n - isRequired: true + defaultValue: None - name: e - isRequired: true + defaultValue: None - name: d - isRequired: true + defaultValue: None - name: dp - isRequired: true + defaultValue: None - name: dq - isRequired: true + defaultValue: None - name: qi - isRequired: true + defaultValue: None - name: p - isRequired: true + defaultValue: None - name: q - isRequired: true + defaultValue: None - name: k - isRequired: true + defaultValue: None - name: t - isRequired: true + defaultValue: None - name: crv - isRequired: true + defaultValue: None - name: x - isRequired: true + defaultValue: None - name: y - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.json_web_key_py3.JsonWebKey.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_attributes_py3.KeyAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_attributes_py3.KeyAttributes.yml index a6beadc1..bc20b100 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_attributes_py3.KeyAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_attributes_py3.KeyAttributes.yml @@ -29,11 +29,11 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None - name: not_before - isRequired: true + defaultValue: None - name: expires - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_bundle_py3.KeyBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_bundle_py3.KeyBundle.yml index 589ce624..8f16a5d4 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_bundle_py3.KeyBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_bundle_py3.KeyBundle.yml @@ -29,11 +29,11 @@ constructor: - [, ] keywordOnlyParameters: - name: key - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None variables: - description: 'True if the key''s lifetime is managed by key vault. If this diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_create_parameters_py3.KeyCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_create_parameters_py3.KeyCreateParameters.yml index 498bf156..16ad19b9 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_create_parameters_py3.KeyCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_create_parameters_py3.KeyCreateParameters.yml @@ -56,15 +56,15 @@ constructor: - name: kty isRequired: true - name: key_size - isRequired: true + defaultValue: None - name: key_ops - isRequired: true + defaultValue: None - name: key_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: curve - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.key_create_parameters_py3.KeyCreateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_import_parameters_py3.KeyImportParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_import_parameters_py3.KeyImportParameters.yml index 7ee55878..f891e7b1 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_import_parameters_py3.KeyImportParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_import_parameters_py3.KeyImportParameters.yml @@ -35,11 +35,11 @@ constructor: - name: key isRequired: true - name: hsm - isRequired: true + defaultValue: None - name: key_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.key_import_parameters_py3.KeyImportParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item_py3.KeyItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item_py3.KeyItem.yml index 49bb540c..aed061ba 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item_py3.KeyItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_item_py3.KeyItem.yml @@ -29,11 +29,11 @@ constructor: - [, ] keywordOnlyParameters: - name: kid - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None variables: - description: 'True if the key''s lifetime is managed by key vault. If this diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_properties_py3.KeyProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_properties_py3.KeyProperties.yml index 356adfaa..3b611417 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_properties_py3.KeyProperties.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_properties_py3.KeyProperties.yml @@ -47,15 +47,15 @@ constructor: - keywordOnlyParameters: - name: exportable - isRequired: true + defaultValue: None - name: key_type - isRequired: true + defaultValue: None - name: key_size - isRequired: true + defaultValue: None - name: reuse_key - isRequired: true + defaultValue: None - name: curve - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.key_properties_py3.KeyProperties.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_update_parameters_py3.KeyUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_update_parameters_py3.KeyUpdateParameters.yml index 64b6aac8..6f0cc879 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_update_parameters_py3.KeyUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.key_update_parameters_py3.KeyUpdateParameters.yml @@ -26,11 +26,11 @@ constructor: - [, ] keywordOnlyParameters: - name: key_ops - isRequired: true + defaultValue: None - name: key_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.key_update_parameters_py3.KeyUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.lifetime_action_py3.LifetimeAction.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.lifetime_action_py3.LifetimeAction.yml index 6ce158f6..71eb2dab 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.lifetime_action_py3.LifetimeAction.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.lifetime_action_py3.LifetimeAction.yml @@ -21,9 +21,9 @@ constructor: - keywordOnlyParameters: - name: trigger - isRequired: true + defaultValue: None - name: action - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.lifetime_action_py3.LifetimeAction.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.organization_details_py3.OrganizationDetails.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.organization_details_py3.OrganizationDetails.yml index cb57a5a5..9e1ab3a4 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.organization_details_py3.OrganizationDetails.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.organization_details_py3.OrganizationDetails.yml @@ -19,9 +19,9 @@ constructor: - [] keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: admin_details - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.organization_details_py3.OrganizationDetails.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_attributes_py3.SasDefinitionAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_attributes_py3.SasDefinitionAttributes.yml index 7cbb1f41..7ac7a286 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_attributes_py3.SasDefinitionAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_attributes_py3.SasDefinitionAttributes.yml @@ -19,7 +19,7 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.yml index 529c9635..7f71e9dc 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.yml @@ -53,9 +53,9 @@ constructor: - name: validity_period isRequired: true - name: sas_definition_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.sas_definition_create_parameters_py3.SasDefinitionCreateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.yml index ee09f4f9..b2358891 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.yml @@ -44,15 +44,15 @@ constructor: - [, ] keywordOnlyParameters: - name: template_uri - isRequired: true + defaultValue: None - name: sas_type - isRequired: true + defaultValue: None - name: validity_period - isRequired: true + defaultValue: None - name: sas_definition_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.sas_definition_update_parameters_py3.SasDefinitionUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_attributes_py3.SecretAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_attributes_py3.SecretAttributes.yml index 2c08af72..c3f8cae9 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_attributes_py3.SecretAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_attributes_py3.SecretAttributes.yml @@ -30,11 +30,11 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None - name: not_before - isRequired: true + defaultValue: None - name: expires - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_bundle_py3.SecretBundle.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_bundle_py3.SecretBundle.yml index 1a6c6d45..d7a2c2c5 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_bundle_py3.SecretBundle.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_bundle_py3.SecretBundle.yml @@ -40,15 +40,15 @@ constructor: - [, ] keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None variables: - description: 'If this is a secret backing a KV certificate, then this field diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item_py3.SecretItem.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item_py3.SecretItem.yml index 0bec9397..1d2332ff 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item_py3.SecretItem.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_item_py3.SecretItem.yml @@ -35,13 +35,13 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None variables: - description: 'True if the secret''s lifetime is managed by key vault. If diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_properties_py3.SecretProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_properties_py3.SecretProperties.yml index a1e73ccb..ceaabe38 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_properties_py3.SecretProperties.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_properties_py3.SecretProperties.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: content_type - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.secret_properties_py3.SecretProperties.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_set_parameters_py3.SecretSetParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_set_parameters_py3.SecretSetParameters.yml index e57fee19..7974fa6c 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_set_parameters_py3.SecretSetParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_set_parameters_py3.SecretSetParameters.yml @@ -35,11 +35,11 @@ constructor: - name: value isRequired: true - name: tags - isRequired: true + defaultValue: None - name: content_type - isRequired: true + defaultValue: None - name: secret_attributes - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.secret_set_parameters_py3.SecretSetParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_update_parameters_py3.SecretUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_update_parameters_py3.SecretUpdateParameters.yml index 34bac331..2770531f 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_update_parameters_py3.SecretUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.secret_update_parameters_py3.SecretUpdateParameters.yml @@ -25,11 +25,11 @@ constructor: - [, ] keywordOnlyParameters: - name: content_type - isRequired: true + defaultValue: None - name: secret_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.secret_update_parameters_py3.SecretUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_attributes_py3.StorageAccountAttributes.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_attributes_py3.StorageAccountAttributes.yml index 25ee98bb..d351d03d 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_attributes_py3.StorageAccountAttributes.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_attributes_py3.StorageAccountAttributes.yml @@ -19,7 +19,7 @@ constructor: - keywordOnlyParameters: - name: enabled - isRequired: true + defaultValue: None variables: - description: Creation time in UTC. name: created diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.yml index 682111c7..a3fda504 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.yml @@ -54,11 +54,11 @@ constructor: - name: auto_regenerate_key isRequired: true - name: regeneration_period - isRequired: true + defaultValue: None - name: storage_account_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.storage_account_create_parameters_py3.StorageAccountCreateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.yml index 569658ac..d8f2d66b 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.yml @@ -40,15 +40,15 @@ constructor: - [, ] keywordOnlyParameters: - name: active_key_name - isRequired: true + defaultValue: None - name: auto_regenerate_key - isRequired: true + defaultValue: None - name: regeneration_period - isRequired: true + defaultValue: None - name: storage_account_attributes - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.storage_account_update_parameters_py3.StorageAccountUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.subject_alternative_names_py3.SubjectAlternativeNames.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.subject_alternative_names_py3.SubjectAlternativeNames.yml index 9682988a..a73c49fc 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.subject_alternative_names_py3.SubjectAlternativeNames.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.subject_alternative_names_py3.SubjectAlternativeNames.yml @@ -24,11 +24,11 @@ constructor: - [] keywordOnlyParameters: - name: emails - isRequired: true + defaultValue: None - name: dns_names - isRequired: true + defaultValue: None - name: upns - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.subject_alternative_names_py3.SubjectAlternativeNames.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.trigger_py3.Trigger.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.trigger_py3.Trigger.yml index 57d2f3fd..3c2bd7a9 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.trigger_py3.Trigger.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.trigger_py3.Trigger.yml @@ -28,9 +28,9 @@ constructor: - keywordOnlyParameters: - name: lifetime_percentage - isRequired: true + defaultValue: None - name: days_before_expiry - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.trigger_py3.Trigger.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.x509_certificate_properties_py3.X509CertificateProperties.yml b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.x509_certificate_properties_py3.X509CertificateProperties.yml index b552f02e..8faaab3a 100644 --- a/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.x509_certificate_properties_py3.X509CertificateProperties.yml +++ b/previous/docs-ref-autogen/azure-keyvault/azure.keyvault.v7_0.models.x509_certificate_properties_py3.X509CertificateProperties.yml @@ -40,15 +40,15 @@ constructor: - keywordOnlyParameters: - name: subject - isRequired: true + defaultValue: None - name: ekus - isRequired: true + defaultValue: None - name: subject_alternative_names - isRequired: true + defaultValue: None - name: key_usage - isRequired: true + defaultValue: None - name: validity_in_months - isRequired: true + defaultValue: None methods: - uid: azure.keyvault.v7_0.models.x509_certificate_properties_py3.X509CertificateProperties.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.Column(class).yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.Column(class).yml index 55798c92..d739b0a5 100644 --- a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.Column(class).yml +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.Column(class).yml @@ -22,9 +22,9 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None methods: - uid: azure.loganalytics.models.Column.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorDetail.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorDetail.yml index 3f6d8c12..b90f1f4e 100644 --- a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorDetail.yml +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorDetail.yml @@ -52,13 +52,13 @@ constructor: - name: message isRequired: true - name: target - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None - name: resources - isRequired: true + defaultValue: None - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.loganalytics.models.ErrorDetail.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorInfo.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorInfo.yml index 2ce0d59a..b8ddc47b 100644 --- a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorInfo.yml +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.ErrorInfo.yml @@ -41,11 +41,11 @@ constructor: - name: message isRequired: true - name: details - isRequired: true + defaultValue: None - name: innererror - isRequired: true + defaultValue: None - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.loganalytics.models.ErrorInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.QueryBody.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.QueryBody.yml index 24d9caf0..0f3fc769 100644 --- a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.QueryBody.yml +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.QueryBody.yml @@ -35,9 +35,9 @@ constructor: - name: query isRequired: true - name: timespan - isRequired: true + defaultValue: None - name: workspaces - isRequired: true + defaultValue: None methods: - uid: azure.loganalytics.models.QueryBody.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.column_py3.Column.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.column_py3.Column.yml index 178bbcc1..6a7a4fdc 100644 --- a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.column_py3.Column.yml +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.column_py3.Column.yml @@ -22,9 +22,9 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None methods: - uid: azure.loganalytics.models.column_py3.Column.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_detail_py3.ErrorDetail.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_detail_py3.ErrorDetail.yml index f78155dc..abc5457a 100644 --- a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_detail_py3.ErrorDetail.yml +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_detail_py3.ErrorDetail.yml @@ -52,13 +52,13 @@ constructor: - name: message isRequired: true - name: target - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None - name: resources - isRequired: true + defaultValue: None - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.loganalytics.models.error_detail_py3.ErrorDetail.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_info_py3.ErrorInfo.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_info_py3.ErrorInfo.yml index e24ef87e..880f8fda 100644 --- a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_info_py3.ErrorInfo.yml +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.error_info_py3.ErrorInfo.yml @@ -41,11 +41,11 @@ constructor: - name: message isRequired: true - name: details - isRequired: true + defaultValue: None - name: innererror - isRequired: true + defaultValue: None - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.loganalytics.models.error_info_py3.ErrorInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_body_py3.QueryBody.yml b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_body_py3.QueryBody.yml index 51b174a4..dcf3b871 100644 --- a/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_body_py3.QueryBody.yml +++ b/previous/docs-ref-autogen/azure-loganalytics/azure.loganalytics.models.query_body_py3.QueryBody.yml @@ -35,9 +35,9 @@ constructor: - name: query isRequired: true - name: timespan - isRequired: true + defaultValue: None - name: workspaces - isRequired: true + defaultValue: None methods: - uid: azure.loganalytics.models.query_body_py3.QueryBody.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.CognitiveServicesVisionProcessor.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.CognitiveServicesVisionProcessor.yml index 24e77df0..a19addf5 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.CognitiveServicesVisionProcessor.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.CognitiveServicesVisionProcessor.yml @@ -32,12 +32,14 @@ constructor: - name: image description: Describes the parameters of the image that is sent as input to the endpoint. + defaultValue: None types: - - name: sampling_options description: 'Describes the sampling options to be applied when forwarding samples to the extension.' + defaultValue: None types: - - name: operation diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.DiscoveredOnvifDevice.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.DiscoveredOnvifDevice.yml index b22cea55..f84470c2 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.DiscoveredOnvifDevice.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.DiscoveredOnvifDevice.yml @@ -14,12 +14,14 @@ constructor: description: 'The unique identifier of the ONVIF device that was discovered in the same subnet as the IoT Edge device.' + defaultValue: None types: - - name: remote_ip_address description: 'The IP address of the ONVIF device that was discovered in the same subnet as the IoT Edge device.' + defaultValue: None types: - - name: scopes @@ -27,12 +29,14 @@ constructor: in the same subnet as the IoT Edge device.' + defaultValue: None types: - [] - name: endpoints description: 'An array of media profile endpoints that the ONVIF discovered device supports.' + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.DiscoveredOnvifDeviceCollection.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.DiscoveredOnvifDeviceCollection.yml index 61967b6d..aa64604c 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.DiscoveredOnvifDeviceCollection.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.DiscoveredOnvifDeviceCollection.yml @@ -14,6 +14,7 @@ constructor: subnet as the IoT Edge device.' + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.EndpointBase.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.EndpointBase.yml index f9d0537a..46fdfc77 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.EndpointBase.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.EndpointBase.yml @@ -17,6 +17,7 @@ constructor: keywordOnlyParameters: - name: credentials description: Credentials to be presented to the endpoint. + defaultValue: None types: - - name: url diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ExtensionProcessorBase.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ExtensionProcessorBase.yml index 18412ae2..f28fe0b3 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ExtensionProcessorBase.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ExtensionProcessorBase.yml @@ -44,6 +44,7 @@ constructor: description: 'Media sampling parameters that define how often media is submitted to the extension plugin.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.GrpcExtension.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.GrpcExtension.yml index 3de4329b..004c1632 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.GrpcExtension.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.GrpcExtension.yml @@ -41,6 +41,7 @@ constructor: description: 'Media sampling parameters that define how often media is submitted to the extension plugin.' + defaultValue: None types: - - name: data_transfer @@ -56,6 +57,7 @@ constructor: understood neither validated by Video Analyzer. Please see [https://aka.ms/ava-extension-grpc](https://aka.ms/ava-extension-grpc) for details.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.GrpcExtensionDataTransfer.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.GrpcExtensionDataTransfer.yml index 304a210a..da128b09 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.GrpcExtensionDataTransfer.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.GrpcExtensionDataTransfer.yml @@ -15,6 +15,7 @@ constructor: description: 'The share memory buffer for sample transfers, in mebibytes. It can only be used with the ''SharedMemory'' transfer mode.' + defaultValue: None types: - - name: mode diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.H264Configuration.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.H264Configuration.yml index 348775a4..f0f8d357 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.H264Configuration.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.H264Configuration.yml @@ -10,12 +10,14 @@ constructor: keywordOnlyParameters: - name: gov_length description: Group of Video frames length. + defaultValue: None types: - - name: profile description: 'The H264 Profile. Possible values include: "Baseline", "Main", "Extended", "High".' + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.HttpExtension.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.HttpExtension.yml index e32d6138..d5ca779b 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.HttpExtension.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.HttpExtension.yml @@ -40,6 +40,7 @@ constructor: description: 'Media sampling parameters that define how often media is submitted to the extension plugin.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatJpeg.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatJpeg.yml index 593e248b..16b67f00 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatJpeg.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageFormatJpeg.yml @@ -12,6 +12,7 @@ constructor: keywordOnlyParameters: - name: quality description: Image quality value between 0 to 100 (best quality). + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageProperties.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageProperties.yml index 013d5a36..1d01c6a5 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageProperties.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageProperties.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: scale description: Image scaling mode. + defaultValue: None types: - - name: format description: Base class for image formatting properties. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageScale.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageScale.yml index d6111e00..fedf85b5 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageScale.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ImageScale.yml @@ -13,15 +13,18 @@ constructor: ''pad''. Possible values include: "preserveAspectRatio", "pad", "stretch".' + defaultValue: None types: - - - name: width description: The desired output image width. + defaultValue: None types: - - name: height description: The desired output image height. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.IotHubDeviceConnection.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.IotHubDeviceConnection.yml index d42e24b5..af0a2edd 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.IotHubDeviceConnection.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.IotHubDeviceConnection.yml @@ -24,6 +24,7 @@ constructor: key credentials are supported.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.IotHubMessageSource.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.IotHubMessageSource.yml index aa0dd655..fe18e39d 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.IotHubMessageSource.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.IotHubMessageSource.yml @@ -18,6 +18,7 @@ constructor: - - name: hub_input_name description: Name of the IoT Edge Hub input from which messages will be consumed. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipeline.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipeline.yml index 128df8c5..7d25d9b0 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipeline.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipeline.yml @@ -18,10 +18,12 @@ constructor: - - name: system_data description: Read-only system metadata associated with this object. + defaultValue: None types: - - name: properties description: Live pipeline properties. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineCollection.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineCollection.yml index 90af4609..3f0e1cf4 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineCollection.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineCollection.yml @@ -10,6 +10,7 @@ constructor: keywordOnlyParameters: - name: value description: List of live pipelines. + defaultValue: None types: - [] - name: continuation_token @@ -19,6 +20,7 @@ constructor: won''t fit in a single response.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineProperties.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineProperties.yml index d8850b7d..5f53b15b 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineProperties.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineProperties.yml @@ -11,6 +11,7 @@ constructor: keywordOnlyParameters: - name: description description: An optional description of the live pipeline. + defaultValue: None types: - - name: topology_name @@ -20,6 +21,7 @@ constructor: according to the pipeline topology definition.' + defaultValue: None types: - - name: parameters @@ -33,12 +35,14 @@ constructor: value must be defined. Topology parameters with a default value can be optionally be overridden.' + defaultValue: None types: - [] - name: state description: 'Current pipeline state (read-only). Possible values include: "inactive", "activating", "active", "deactivating".' + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineSetRequestBody.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineSetRequestBody.yml index 70c98916..a34bf7f3 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineSetRequestBody.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.LivePipelineSetRequestBody.yml @@ -30,10 +30,12 @@ constructor: - - name: system_data description: Read-only system metadata associated with this object. + defaultValue: None types: - - name: properties description: Live pipeline properties. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MPEG4Configuration.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MPEG4Configuration.yml index 1b9f20f3..3cc53987 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MPEG4Configuration.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MPEG4Configuration.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: gov_length description: Group of Video frames length. + defaultValue: None types: - - name: profile description: 'The MPEG4 Profile. Possible values include: "SP", "ASP".' + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MediaProfile.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MediaProfile.yml index 847c7921..983251d3 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MediaProfile.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MediaProfile.yml @@ -10,16 +10,19 @@ constructor: keywordOnlyParameters: - name: name description: The name of the Media Profile. + defaultValue: None types: - - name: media_uri description: 'Object representing the URI that will be used to request for media streaming.' + defaultValue: None types: - - name: video_encoder_configuration description: The Video encoder configuration. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MediaUri.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MediaUri.yml index e2dc7afe..e5564c64 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MediaUri.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MediaUri.yml @@ -9,6 +9,7 @@ constructor: keywordOnlyParameters: - name: uri description: URI that can be used for media streaming. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MotionDetectionProcessor.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MotionDetectionProcessor.yml index 02a42279..5bf759bd 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MotionDetectionProcessor.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.MotionDetectionProcessor.yml @@ -29,6 +29,7 @@ constructor: include: "low", "medium", "high".' + defaultValue: None types: - - @@ -36,6 +37,7 @@ constructor: description: 'Indicates whether the processor should detect and output the regions within the video frame where motion was detected. Default is true.' + defaultValue: None types: - - name: event_aggregation_window @@ -45,6 +47,7 @@ constructor: equals 2 seconds). Use 0 seconds for no aggregation. Default is 1 second.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NodeInput.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NodeInput.yml index ab821c55..859b2372 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NodeInput.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.NodeInput.yml @@ -22,6 +22,7 @@ constructor: description: 'Allows for the selection of specific data streams (eg. video only) from another node.' + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ObjectTrackingProcessor.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ObjectTrackingProcessor.yml index da60c706..701de674 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ObjectTrackingProcessor.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ObjectTrackingProcessor.yml @@ -35,6 +35,7 @@ constructor: to higher CPU consumption in average. Possible values include: "low", "medium", "high".' + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDevice.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDevice.yml index 8fe42502..cf79d554 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDevice.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDevice.yml @@ -11,18 +11,22 @@ constructor: keywordOnlyParameters: - name: hostname description: The hostname of the ONVIF device. + defaultValue: None types: - - name: system_date_time description: The system date and time of the ONVIF device. + defaultValue: None types: - - name: dns description: The ONVIF device DNS properties. + defaultValue: None types: - - name: media_profiles description: An array of of ONVIF media profiles supported by the ONVIF device. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDeviceDiscoverRequest.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDeviceDiscoverRequest.yml index 0ca75303..fdb8d8f5 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDeviceDiscoverRequest.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDeviceDiscoverRequest.yml @@ -27,6 +27,7 @@ constructor: description: 'The amount of time that the ONVIF device discovery will wait for supported device responses.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDns.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDns.yml index 9919b853..c174415c 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDns.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifDns.yml @@ -10,14 +10,17 @@ constructor: keywordOnlyParameters: - name: from_dhcp description: Result value showing if the ONVIF device is configured to use DHCP. + defaultValue: None types: - - name: ipv4_address description: An array of IPv4 address for the discovered ONVIF device. + defaultValue: None types: - [] - name: ipv6_address description: An array of IPv6 address for the discovered ONVIF device. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifHostName.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifHostName.yml index 9e39cfab..9dd573da 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifHostName.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifHostName.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: from_dhcp description: Result value showing if the ONVIF device is configured to use DHCP. + defaultValue: None types: - - name: hostname description: The hostname of the ONVIF device. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifSystemDateTime.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifSystemDateTime.yml index db362052..4c7f8fa4 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifSystemDateTime.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OnvifSystemDateTime.yml @@ -13,15 +13,18 @@ constructor: NTP or manual. Possible values include: "Ntp", "Manual".' + defaultValue: None types: - - - name: time description: The device datetime returned when calling the request. + defaultValue: None types: - - name: time_zone description: The timezone of the ONVIF device datetime. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OutputSelector.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OutputSelector.yml index 3b8fd3ee..0f4a0707 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OutputSelector.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.OutputSelector.yml @@ -13,6 +13,7 @@ constructor: description: 'The property of the data stream to be used as the selection criteria. Possible values include: "mediaType".' + defaultValue: None types: - - @@ -21,11 +22,13 @@ constructor: "is", "isNot".' + defaultValue: None types: - - - name: value description: Value to compare against. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ParameterDeclaration.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ParameterDeclaration.yml index d59366c4..8454bb96 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ParameterDeclaration.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ParameterDeclaration.yml @@ -26,6 +26,7 @@ constructor: - - name: description description: Description of the parameter. + defaultValue: None types: - - name: default @@ -33,6 +34,7 @@ constructor: does not specify a value.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ParameterDefinition.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ParameterDefinition.yml index 3fa0d710..4933775e 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ParameterDefinition.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.ParameterDefinition.yml @@ -17,6 +17,7 @@ constructor: - - name: value description: Parameter value to be applied on this specific live pipeline. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopology.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopology.yml index 1e43ba0c..14430c23 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopology.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopology.yml @@ -35,10 +35,12 @@ constructor: - - name: system_data description: Read-only system metadata associated with this object. + defaultValue: None types: - - name: properties description: Pipeline topology properties. + defaultValue: None types: - methods: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyCollection.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyCollection.yml index 4bcee5eb..c89792b1 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyCollection.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyCollection.yml @@ -10,6 +10,7 @@ constructor: keywordOnlyParameters: - name: value description: List of pipeline topologies. + defaultValue: None types: - [] - name: continuation_token @@ -19,6 +20,7 @@ constructor: won''t fit in a single response.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyProperties.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyProperties.yml index c5a8dd59..a5805d7f 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyProperties.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologyProperties.yml @@ -15,6 +15,7 @@ constructor: that the expected use of the topology to be described here.' + defaultValue: None types: - - name: parameters @@ -28,6 +29,7 @@ constructor: in individual instances of the pipeline.' + defaultValue: None types: - [] - name: sources @@ -35,6 +37,7 @@ constructor: data to be ingested by the pipeline.' + defaultValue: None types: - [] - name: processors @@ -42,6 +45,7 @@ constructor: data to be analyzed, processed or transformed.' + defaultValue: None types: - [] - name: sinks @@ -49,6 +53,7 @@ constructor: to be stored or exported.' + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologySetRequestBody.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologySetRequestBody.yml index 5fa86a7b..1fef8b85 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologySetRequestBody.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.PipelineTopologySetRequestBody.yml @@ -49,10 +49,12 @@ constructor: - - name: system_data description: Read-only system metadata associated with this object. + defaultValue: None types: - - name: properties description: Pipeline topology properties. + defaultValue: None types: - methods: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RateControl.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RateControl.yml index 9765a593..e187e0a7 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RateControl.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RateControl.yml @@ -11,14 +11,17 @@ constructor: keywordOnlyParameters: - name: bit_rate_limit description: the maximum output bitrate in kbps. + defaultValue: None types: - - name: encoding_interval description: Interval at which images are encoded and transmitted. + defaultValue: None types: - - name: frame_rate_limit description: Maximum output framerate in fps. + defaultValue: None types: - - name: guaranteed_frame_rate @@ -28,6 +31,7 @@ constructor: rate over all other adaptable configuration values such as bitrate.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapter.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapter.yml index 85fe9424..d6c4e0db 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapter.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapter.yml @@ -20,10 +20,12 @@ constructor: - - name: system_data description: Read-only system metadata associated with this object. + defaultValue: None types: - - name: properties description: Properties of the remote device adapter. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterCollection.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterCollection.yml index 304b7a10..8f359d84 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterCollection.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterCollection.yml @@ -10,6 +10,7 @@ constructor: keywordOnlyParameters: - name: value description: An array of remote device adapters. + defaultValue: None types: - [] - name: continuation_token @@ -19,6 +20,7 @@ constructor: contains too many results to return in one response.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterProperties.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterProperties.yml index 359f2984..188b2c2c 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterProperties.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterProperties.yml @@ -13,6 +13,7 @@ constructor: keywordOnlyParameters: - name: description description: An optional description for the remote device adapter. + defaultValue: None types: - - name: target diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequestBody.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequestBody.yml index 757dc9dd..231e65d8 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequestBody.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RemoteDeviceAdapterSetRequestBody.yml @@ -32,10 +32,12 @@ constructor: - - name: system_data description: Read-only system metadata associated with this object. + defaultValue: None types: - - name: properties description: Properties of the remote device adapter. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RtspSource.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RtspSource.yml index 3e1a930e..c0766ac9 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RtspSource.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.RtspSource.yml @@ -30,6 +30,7 @@ constructor: include: "http", "tcp".' + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SamplingOptions.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SamplingOptions.yml index 9c9f30ab..ba231edf 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SamplingOptions.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SamplingOptions.yml @@ -21,12 +21,14 @@ constructor: to be further analyzed.' + defaultValue: None types: - - name: maximum_samples_per_second description: 'Maximum rate of samples submitted to the extension. This prevents an extension plugin to be overloaded with data.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SignalGateProcessor.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SignalGateProcessor.yml index 021328fd..60bce258 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SignalGateProcessor.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SignalGateProcessor.yml @@ -30,6 +30,7 @@ constructor: description: 'The period of time over which the gate gathers input events before evaluating them.' + defaultValue: None types: - - name: activation_signal_offset @@ -48,6 +49,7 @@ constructor: prior an event, such as: record video 5 seconds prior motions is detected.' + defaultValue: None types: - - name: minimum_activation_time @@ -57,6 +59,7 @@ constructor: sink, it determines the minimum length of the recorded video clip.' + defaultValue: None types: - - name: maximum_activation_time @@ -66,6 +69,7 @@ constructor: sink, it determines the maximum length of the recorded video clip.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisOperationEventBase.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisOperationEventBase.yml index 61a91bf4..73d29c30 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisOperationEventBase.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisOperationEventBase.yml @@ -11,12 +11,14 @@ constructor: keywordOnlyParameters: - name: threshold description: The event threshold. + defaultValue: None types: - - name: focus description: 'The operation focus type. Possible values include: "center", "bottomCenter", "footprint".' + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEvent.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEvent.yml index 62a697bd..bc47ca05 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEvent.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountEvent.yml @@ -11,22 +11,26 @@ constructor: keywordOnlyParameters: - name: threshold description: The event threshold. + defaultValue: None types: - - name: focus description: 'The operation focus type. Possible values include: "center", "bottomCenter", "footprint".' + defaultValue: None types: - - - name: trigger description: 'The event trigger type. Possible values include: "event", "interval".' + defaultValue: None types: - - - name: output_frequency description: The event or interval output frequency. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountOperation.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountOperation.yml index 5e8b3be0..1968e6ca 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountOperation.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountOperation.yml @@ -19,32 +19,39 @@ constructor: keywordOnlyParameters: - name: debug description: If set to 'true', enables debugging mode for this operation. + defaultValue: None types: - - name: calibration_configuration description: Advanced calibration configuration. + defaultValue: None types: - - name: camera_configuration description: Advanced camera configuration. + defaultValue: None types: - - name: camera_calibrator_node_configuration description: Advanced camera calibrator configuration. + defaultValue: None types: - - name: detector_node_configuration description: Advanced detector node configuration. + defaultValue: None types: - - name: tracker_node_configuration description: Advanced tracker node configuration. + defaultValue: None types: - - name: enable_face_mask_classifier description: 'If set to ''true'', enables face mask detection for this operation.' + defaultValue: None types: - - name: zones diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountZoneEvents.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountZoneEvents.yml index af1ddefc..18be9ca1 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountZoneEvents.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonCountZoneEvents.yml @@ -17,6 +17,7 @@ constructor: - - name: events description: The event configuration. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEvent.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEvent.yml index 3abb1fc2..f319c75f 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEvent.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceEvent.yml @@ -12,30 +12,36 @@ constructor: keywordOnlyParameters: - name: threshold description: The event threshold. + defaultValue: None types: - - name: focus description: 'The operation focus type. Possible values include: "center", "bottomCenter", "footprint".' + defaultValue: None types: - - - name: trigger description: 'The event trigger type. Possible values include: "event", "interval".' + defaultValue: None types: - - - name: output_frequency description: The event or interval output frequency. + defaultValue: None types: - - name: minimum_distance_threshold description: The minimum distance threshold. + defaultValue: None types: - - name: maximum_distance_threshold description: The maximum distance threshold. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceOperation.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceOperation.yml index 4905d825..dcac5fd7 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceOperation.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceOperation.yml @@ -19,32 +19,39 @@ constructor: keywordOnlyParameters: - name: debug description: If set to 'true', enables debugging mode for this operation. + defaultValue: None types: - - name: calibration_configuration description: Advanced calibration configuration. + defaultValue: None types: - - name: camera_configuration description: Advanced camera configuration. + defaultValue: None types: - - name: camera_calibrator_node_configuration description: Advanced camera calibrator configuration. + defaultValue: None types: - - name: detector_node_configuration description: Advanced detector node configuration. + defaultValue: None types: - - name: tracker_node_configuration description: Advanced tracker node configuration. + defaultValue: None types: - - name: enable_face_mask_classifier description: 'If set to ''true'', enables face mask detection for this operation.' + defaultValue: None types: - - name: zones diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceZoneEvents.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceZoneEvents.yml index 465bf446..fcc5e142 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceZoneEvents.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonDistanceZoneEvents.yml @@ -17,6 +17,7 @@ constructor: - - name: events description: The event configuration. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingEvent.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingEvent.yml index 3114d6fe..9860934a 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingEvent.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingEvent.yml @@ -10,12 +10,14 @@ constructor: keywordOnlyParameters: - name: threshold description: The event threshold. + defaultValue: None types: - - name: focus description: 'The operation focus type. Possible values include: "center", "bottomCenter", "footprint".' + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingLineEvents.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingLineEvents.yml index e36a7cf7..b0f55bff 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingLineEvents.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingLineEvents.yml @@ -17,6 +17,7 @@ constructor: - - name: events description: The event configuration. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingOperation.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingOperation.yml index b04d42e0..57dd8102 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingOperation.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonLineCrossingOperation.yml @@ -19,32 +19,39 @@ constructor: keywordOnlyParameters: - name: debug description: If set to 'true', enables debugging mode for this operation. + defaultValue: None types: - - name: calibration_configuration description: Advanced calibration configuration. + defaultValue: None types: - - name: camera_configuration description: Advanced camera configuration. + defaultValue: None types: - - name: camera_calibrator_node_configuration description: Advanced camera calibrator configuration. + defaultValue: None types: - - name: detector_node_configuration description: Advanced detector node configuration. + defaultValue: None types: - - name: tracker_node_configuration description: Advanced tracker node configuration. + defaultValue: None types: - - name: enable_face_mask_classifier description: 'If set to ''true'', enables face mask detection for this operation.' + defaultValue: None types: - - name: lines diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEvent.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEvent.yml index e4aadc25..bcc39b6e 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEvent.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingEvent.yml @@ -11,17 +11,20 @@ constructor: keywordOnlyParameters: - name: threshold description: The event threshold. + defaultValue: None types: - - name: focus description: 'The operation focus type. Possible values include: "center", "bottomCenter", "footprint".' + defaultValue: None types: - - - name: event_type description: 'The event type. Possible values include: "zoneCrossing", "zoneDwellTime".' + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingOperation.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingOperation.yml index 49e1cd77..df3e2530 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingOperation.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingOperation.yml @@ -19,32 +19,39 @@ constructor: keywordOnlyParameters: - name: debug description: If set to 'true', enables debugging mode for this operation. + defaultValue: None types: - - name: calibration_configuration description: Advanced calibration configuration. + defaultValue: None types: - - name: camera_configuration description: Advanced camera configuration. + defaultValue: None types: - - name: camera_calibrator_node_configuration description: Advanced camera calibrator configuration. + defaultValue: None types: - - name: detector_node_configuration description: Advanced detector node configuration. + defaultValue: None types: - - name: tracker_node_configuration description: Advanced tracker node configuration. + defaultValue: None types: - - name: enable_face_mask_classifier description: 'If set to ''true'', enables face mask detection for this operation.' + defaultValue: None types: - - name: zones diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingZoneEvents.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingZoneEvents.yml index 84185c85..9c07ebc3 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingZoneEvents.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisPersonZoneCrossingZoneEvents.yml @@ -17,6 +17,7 @@ constructor: - - name: events description: The event configuration. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisTypedOperationBase.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisTypedOperationBase.yml index a810b48c..c0de4bb6 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisTypedOperationBase.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SpatialAnalysisTypedOperationBase.yml @@ -21,32 +21,39 @@ constructor: keywordOnlyParameters: - name: debug description: If set to 'true', enables debugging mode for this operation. + defaultValue: None types: - - name: calibration_configuration description: Advanced calibration configuration. + defaultValue: None types: - - name: camera_configuration description: Advanced camera configuration. + defaultValue: None types: - - name: camera_calibrator_node_configuration description: Advanced camera calibrator configuration. + defaultValue: None types: - - name: detector_node_configuration description: Advanced detector node configuration. + defaultValue: None types: - - name: tracker_node_configuration description: Advanced tracker node configuration. + defaultValue: None types: - - name: enable_face_mask_classifier description: 'If set to ''true'', enables face mask detection for this operation.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SystemData.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SystemData.yml index 05befbb5..0e9208a9 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SystemData.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.SystemData.yml @@ -12,12 +12,14 @@ constructor: description: 'Date and time when this resource was first created. Value is represented in UTC according to the ISO8601 date format.' + defaultValue: None types: - - name: last_modified_at description: 'Date and time when this resource was last modified. Value is represented in UTC according to the ISO8601 date format.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.TlsEndpoint.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.TlsEndpoint.yml index 4333689d..ddc27d36 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.TlsEndpoint.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.TlsEndpoint.yml @@ -15,6 +15,7 @@ constructor: keywordOnlyParameters: - name: credentials description: Credentials to be presented to the endpoint. + defaultValue: None types: - - name: url @@ -28,6 +29,7 @@ constructor: trusted authorities should be used.' + defaultValue: None types: - - name: validation_options @@ -35,6 +37,7 @@ constructor: By default, strict validation is used.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.TlsValidationOptions.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.TlsValidationOptions.yml index d9b2ca5a..8dac23c1 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.TlsValidationOptions.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.TlsValidationOptions.yml @@ -13,6 +13,7 @@ constructor: to be skipped. Default is ''false''.' + defaultValue: None types: - - name: ignore_signature @@ -20,6 +21,7 @@ constructor: to be skipped. Default is ''false''.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.UnsecuredEndpoint.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.UnsecuredEndpoint.yml index 6174e5f2..1820d86a 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.UnsecuredEndpoint.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.UnsecuredEndpoint.yml @@ -14,6 +14,7 @@ constructor: keywordOnlyParameters: - name: credentials description: Credentials to be presented to the endpoint. + defaultValue: None types: - - name: url diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoCreationProperties.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoCreationProperties.yml index 0439a598..ef510217 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoCreationProperties.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoCreationProperties.yml @@ -15,6 +15,7 @@ constructor: characters long.' + defaultValue: None types: - - name: description @@ -22,6 +23,7 @@ constructor: to 2048 characters long.' + defaultValue: None types: - - name: segment_length @@ -44,6 +46,7 @@ constructor: can lead to errors when uploading media to the archive. Default value is 30 seconds.' + defaultValue: None types: - - name: retention_period @@ -53,6 +56,7 @@ constructor: days, then content older than 30 days will be deleted.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoEncoderConfiguration.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoEncoderConfiguration.yml index 2651a2ea..14a89cd1 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoEncoderConfiguration.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoEncoderConfiguration.yml @@ -15,27 +15,33 @@ constructor: "JPEG", "H264", "MPEG4".' + defaultValue: None types: - - - name: quality description: Relative value representing the quality of the video. + defaultValue: None types: - - name: resolution description: The Video Resolution. + defaultValue: None types: - - name: rate_control description: The Video's rate control. + defaultValue: None types: - - name: h264 description: The H264 Configuration. + defaultValue: None types: - - name: mpeg4 description: The H264 Configuration. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoPublishingOptions.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoPublishingOptions.yml index 16e3c58c..dc7fe345 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoPublishingOptions.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoPublishingOptions.yml @@ -13,6 +13,7 @@ constructor: description: 'When set to ''true'' the video will publish preview images. Default is ''false''.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoResolution.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoResolution.yml index 86bc83a2..f9832792 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoResolution.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoResolution.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: width description: The number of columns of the Video image. + defaultValue: None types: - - name: height description: The number of lines of the Video image. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoSink.yml b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoSink.yml index 895b6879..8bb5cf90 100644 --- a/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoSink.yml +++ b/previous/docs-ref-autogen/azure-media-videoanalyzer-edge/azure.media.videoanalyzeredge.VideoSink.yml @@ -41,12 +41,14 @@ constructor: description: 'Optional video properties to be used in case a new video resource needs to be created on the service.' + defaultValue: None types: - - name: video_publishing_options description: 'Optional video publishing options to be used for changing publishing behavior of the output video.' + defaultValue: None types: - - name: local_media_cache_path diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CheckNameAvailabilityRequest.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CheckNameAvailabilityRequest.yml index 13c5f5e3..5ea02892 100644 --- a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CheckNameAvailabilityRequest.yml +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CheckNameAvailabilityRequest.yml @@ -20,6 +20,6 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CheckNameAvailabilityResponse.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CheckNameAvailabilityResponse.yml index 00ecd7ae..7ffefa9e 100644 --- a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CheckNameAvailabilityResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.CheckNameAvailabilityResponse.yml @@ -29,8 +29,8 @@ constructor: - keywordOnlyParameters: - name: name_available - isRequired: true + defaultValue: None - name: reason - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.DetailedInformation.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.DetailedInformation.yml index a3f640a3..3f6a0a1d 100644 --- a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.DetailedInformation.yml +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.DetailedInformation.yml @@ -37,12 +37,12 @@ constructor: - [] keywordOnlyParameters: - name: api_name - isRequired: true + defaultValue: None - name: custom_parameters - isRequired: true + defaultValue: None - name: platform_parameters - isRequired: true + defaultValue: None - name: units_supported - isRequired: true + defaultValue: None - name: api_input_parameters - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ErrorResponse.yml index 37edb43c..28c6ff96 100644 --- a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ErrorResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ErrorResponse.yml @@ -15,4 +15,4 @@ constructor: - keywordOnlyParameters: - name: error - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ExtensionListResponse.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ExtensionListResponse.yml index f280e4e2..0f1e8d2b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ExtensionListResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.ExtensionListResponse.yml @@ -18,7 +18,7 @@ constructor: - [] keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None variables: - description: Continuation link (absolute URI) to the next page of results in the list. diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeats.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeats.yml index 63a1c5cc..59bf834f 100644 --- a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeats.yml +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeats.yml @@ -27,7 +27,7 @@ constructor: - name: location isRequired: true - name: tags - isRequired: true + defaultValue: None variables: - description: 'Fully qualified resource ID for the resource. Ex - diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsExtensionListResponse.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsExtensionListResponse.yml index 66830c70..590248d2 100644 --- a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsExtensionListResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsExtensionListResponse.yml @@ -19,7 +19,7 @@ constructor: - [] keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None variables: - description: Continuation link (absolute URI) to the next page of results in the list. diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsListResponse.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsListResponse.yml index 3e56f413..edc12bcc 100644 --- a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsListResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsListResponse.yml @@ -18,7 +18,7 @@ constructor: - [] keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None variables: - description: Continuation link (absolute URI) to the next page of results in the list. diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsUpdateRequestModel.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsUpdateRequestModel.yml index 57053210..c11ca6f5 100644 --- a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsUpdateRequestModel.yml +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.FarmBeatsUpdateRequestModel.yml @@ -20,6 +20,6 @@ constructor: - [, ] keywordOnlyParameters: - name: location - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.Operation.yml index a01c9845..2aa5aa33 100644 --- a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.Operation.yml +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.Operation.yml @@ -18,7 +18,7 @@ constructor: - keywordOnlyParameters: - name: display - isRequired: true + defaultValue: None variables: - description: 'The name of the operation, as per Resource-Based Access Control (RBAC). Examples: diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.SystemData.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.SystemData.yml index 6e8f2aa6..e6697db4 100644 --- a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.SystemData.yml +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.SystemData.yml @@ -48,14 +48,14 @@ constructor: - keywordOnlyParameters: - name: created_by - isRequired: true + defaultValue: None - name: created_by_type - isRequired: true + defaultValue: None - name: created_at - isRequired: true + defaultValue: None - name: last_modified_by - isRequired: true + defaultValue: None - name: last_modified_by_type - isRequired: true + defaultValue: None - name: last_modified_at - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.TrackedResource.yml b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.TrackedResource.yml index 145705ba..adf470da 100644 --- a/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.TrackedResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-agfood/azure.mgmt.agfood.models.TrackedResource.yml @@ -28,7 +28,7 @@ constructor: - name: location isRequired: true - name: tags - isRequired: true + defaultValue: None variables: - description: 'Fully qualified resource ID for the resource. Ex - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.CertificatesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.CertificatesOperations.yml index 7057354b..916e6a04 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.CertificatesOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.CertificatesOperations.yml @@ -56,7 +56,7 @@ methods: - - name: certificate_envelope description: Certificate to be created or updated. - isRequired: true + defaultValue: None types: - keywordOnlyParameters: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsOperations.yml index 41b0df47..83acdee4 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.aio.operations.ContainerAppsOperations.yml @@ -238,7 +238,7 @@ methods: - - name: custom_hostname description: Custom hostname. - isRequired: true + defaultValue: None types: - keywordOnlyParameters: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AllowedAudiencesValidation.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AllowedAudiencesValidation.yml index bb04db0e..101fa344 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AllowedAudiencesValidation.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AllowedAudiencesValidation.yml @@ -12,6 +12,7 @@ constructor: description: 'The configuration settings of the allowed list of audiences from which to validate the JWT token.' + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AllowedPrincipals.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AllowedPrincipals.yml index 54f25775..b1fa291c 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AllowedPrincipals.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AllowedPrincipals.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: groups description: The list of the allowed groups. + defaultValue: None types: - [] - name: identities description: The list of the allowed identities. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppLogsConfiguration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppLogsConfiguration.yml index b8210a88..54a44315 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppLogsConfiguration.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppLogsConfiguration.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: destination description: Logs destination. + defaultValue: None types: - - name: log_analytics_configuration description: Log Analytics configuration. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppRegistration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppRegistration.yml index 524b6407..af1f8705 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppRegistration.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppRegistration.yml @@ -11,10 +11,12 @@ constructor: keywordOnlyParameters: - name: app_id description: The App ID of the app used for login. + defaultValue: None types: - - name: app_secret_setting_name description: The app setting name that contains the app secret. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Apple.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Apple.yml index ca7375e2..5ffad9b7 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Apple.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Apple.yml @@ -12,14 +12,17 @@ constructor: description: '`false` if the Apple provider should not be enabled despite the set registration; otherwise, `true`.' + defaultValue: None types: - - name: registration description: The configuration settings of the Apple registration. + defaultValue: None types: - - name: login description: The configuration settings of the login flow. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppleRegistration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppleRegistration.yml index 513dd517..0f71f564 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppleRegistration.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AppleRegistration.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: client_id description: The Client ID of the app used for login. + defaultValue: None types: - - name: client_secret_setting_name description: The app setting name that contains the client secret. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AuthConfig.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AuthConfig.yml index 9188ab94..4502c3d7 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AuthConfig.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AuthConfig.yml @@ -17,24 +17,28 @@ constructor: description: 'The configuration settings of the platform of ContainerApp Service Authentication/Authorization.' + defaultValue: None types: - - name: global_validation description: 'The configuration settings that determines the validation flow of users using Service Authentication/Authorization.' + defaultValue: None types: - - name: identity_providers description: 'The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization.' + defaultValue: None types: - - name: login description: 'The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization.' + defaultValue: None types: - - name: http_settings @@ -42,6 +46,7 @@ constructor: and authorization requests made against ContainerApp Service Authentication/Authorization.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AuthPlatform.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AuthPlatform.yml index 4b5e3712..0cbb6623 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AuthPlatform.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AuthPlatform.yml @@ -13,6 +13,7 @@ constructor: is enabled for the current app; otherwise, `false`.' + defaultValue: None types: - - name: runtime_version @@ -25,6 +26,7 @@ constructor: Authentication / Authorization module.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AvailableOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AvailableOperations.yml index 01cc810a..6c09100c 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AvailableOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AvailableOperations.yml @@ -10,12 +10,14 @@ constructor: keywordOnlyParameters: - name: value description: Collection of available operation details. + defaultValue: None types: - [] - name: next_link description: 'URL client should use to fetch the next page (per server side paging). It''s null for now, added for future use.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectory.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectory.yml index afc0ab83..f0cd72f4 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectory.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectory.yml @@ -14,22 +14,26 @@ constructor: not be enabled despite the set registration; otherwise, `true`.' + defaultValue: None types: - - name: registration description: 'The configuration settings of the Azure Active Directory app registration.' + defaultValue: None types: - - name: login description: The configuration settings of the Azure Active Directory login flow. + defaultValue: None types: - - name: validation description: 'The configuration settings of the Azure Active Directory token validation flow.' + defaultValue: None types: - - name: is_auto_provisioned @@ -43,6 +47,7 @@ constructor: should not read or write to this property.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryLogin.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryLogin.yml index 90706dea..316c8cc3 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryLogin.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryLogin.yml @@ -14,12 +14,14 @@ constructor: endpoint when a user logs in. Each parameter must be in the form "key=value".' + defaultValue: None types: - [] - name: disable_www_authenticate description: '`true` if the www-authenticate provider should be omitted from the request; otherwise, `false`.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryRegistration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryRegistration.yml index cdea7529..b8a410b8 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryRegistration.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryRegistration.yml @@ -25,6 +25,7 @@ constructor: More information on OpenID Connect Discovery: [http://openid.net/specs/openid-connect-discovery-1_0.html](http://openid.net/specs/openid-connect-discovery-1_0.html).' + defaultValue: None types: - - name: client_id @@ -38,12 +39,14 @@ constructor: other 3rd party OpenID Connect providers. More information on OpenID Connect: [http://openid.net/specs/openid-connect-core-1_0.html](http://openid.net/specs/openid-connect-core-1_0.html).' + defaultValue: None types: - - name: client_secret_setting_name description: 'The app setting name that contains the client secret of the relying party application.' + defaultValue: None types: - - name: client_secret_certificate_thumbprint @@ -52,6 +55,7 @@ constructor: thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional.' + defaultValue: None types: - - name: client_secret_certificate_subject_alternative_name @@ -63,6 +67,7 @@ constructor: purposes. This property acts as a replacement for the Client Secret Certificate Thumbprint. It is also optional.' + defaultValue: None types: - - name: client_secret_certificate_issuer @@ -72,6 +77,7 @@ constructor: as a replacement for the Client Secret Certificate Thumbprint. It is also optional.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryValidation.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryValidation.yml index bf1bb30e..9a0e998b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryValidation.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureActiveDirectoryValidation.yml @@ -14,18 +14,21 @@ constructor: description: 'The configuration settings of the checks that should be made while validating the JWT Claims.' + defaultValue: None types: - - name: allowed_audiences description: 'The list of audiences that can make successful authentication/authorization requests.' + defaultValue: None types: - [] - name: default_authorization_policy description: 'The configuration settings of the default authorization policy.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureCredentials.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureCredentials.yml index a3205483..66be7114 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureCredentials.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureCredentials.yml @@ -11,18 +11,22 @@ constructor: keywordOnlyParameters: - name: client_id description: Client Id. + defaultValue: None types: - - name: client_secret description: Client Secret. + defaultValue: None types: - - name: tenant_id description: Tenant Id. + defaultValue: None types: - - name: subscription_id description: Subscription Id. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureFileProperties.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureFileProperties.yml index d69830b1..eb369306 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureFileProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureFileProperties.yml @@ -11,21 +11,25 @@ constructor: keywordOnlyParameters: - name: account_name description: Storage account name for azure file. + defaultValue: None types: - - name: account_key description: Storage account key for azure file. + defaultValue: None types: - - name: access_mode description: 'Access mode for storage. Possible values include: "ReadOnly", "ReadWrite".' + defaultValue: None types: - - - name: share_name description: Azure file share name. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureStaticWebApps.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureStaticWebApps.yml index 731f2da1..1312d966 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureStaticWebApps.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureStaticWebApps.yml @@ -13,10 +13,12 @@ constructor: not be enabled despite the set registration; otherwise, `true`.' + defaultValue: None types: - - name: registration description: The configuration settings of the Azure Static Web Apps registration. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureStaticWebAppsRegistration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureStaticWebAppsRegistration.yml index f7c3e701..beb83a2d 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureStaticWebAppsRegistration.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.AzureStaticWebAppsRegistration.yml @@ -10,6 +10,7 @@ constructor: keywordOnlyParameters: - name: client_id description: The Client ID of the app used for login. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Certificate.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Certificate.yml index 1aa0f746..21255963 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Certificate.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Certificate.yml @@ -17,6 +17,7 @@ constructor: keywordOnlyParameters: - name: tags description: A set of tags. Resource tags. + defaultValue: None types: - [, ] - name: location @@ -25,6 +26,7 @@ constructor: - - name: properties description: Certificate resource specific properties. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificatePatch.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificatePatch.yml index 1727d029..0b8bd3c3 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificatePatch.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificatePatch.yml @@ -10,6 +10,7 @@ constructor: - name: tags description: A set of tags. Application-specific metadata in the form of key-value pairs. + defaultValue: None types: - [, ] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificateProperties.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificateProperties.yml index 46854f74..6ad55cea 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificateProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CertificateProperties.yml @@ -13,10 +13,12 @@ constructor: keywordOnlyParameters: - name: password description: Certificate password. + defaultValue: None types: - - name: value description: PFX or PEM blob. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ClientRegistration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ClientRegistration.yml index 8b5b3043..c5c5f858 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ClientRegistration.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ClientRegistration.yml @@ -11,10 +11,12 @@ constructor: keywordOnlyParameters: - name: client_id description: The Client ID of the app used for login. + defaultValue: None types: - - name: client_secret_setting_name description: The app setting name that contains the client secret. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Configuration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Configuration.yml index f89606d5..c32f7d7b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Configuration.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Configuration.yml @@ -12,6 +12,7 @@ constructor: keywordOnlyParameters: - name: secrets description: Collection of secrets used by a Container app. + defaultValue: None types: - [] - name: active_revisions_mode @@ -25,11 +26,13 @@ constructor: not be used in this mode. Possible values include: "multiple", "single".' + defaultValue: None types: - - - name: ingress description: Ingress configurations. + defaultValue: None types: - - name: registries @@ -37,10 +40,12 @@ constructor: used by the Container app.' + defaultValue: None types: - [] - name: dapr description: Dapr configuration for the Container App. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Container.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Container.yml index e67afed0..c1d4b38a 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Container.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Container.yml @@ -12,34 +12,42 @@ constructor: keywordOnlyParameters: - name: image description: Container image tag. + defaultValue: None types: - - name: name description: Custom container name. + defaultValue: None types: - - name: command description: Container start command. + defaultValue: None types: - [] - name: args description: Container start command arguments. + defaultValue: None types: - [] - name: env description: Container environment variables. + defaultValue: None types: - [] - name: resources description: Container resource requirements. + defaultValue: None types: - - name: probes description: List of probes for the container. + defaultValue: None types: - [] - name: volume_mounts description: Container volume mounts. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerApp.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerApp.yml index e995d25d..397ed7dc 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerApp.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerApp.yml @@ -18,6 +18,7 @@ constructor: keywordOnlyParameters: - name: tags description: A set of tags. Resource tags. + defaultValue: None types: - [, ] - name: location @@ -29,18 +30,22 @@ constructor: Azure services without maintaining any secrets or credentials in code.' + defaultValue: None types: - - name: managed_environment_id description: Resource ID of the Container App's environment. + defaultValue: None types: - - name: configuration description: Non versioned Container App configuration properties. + defaultValue: None types: - - name: template description: Container App versioned application definition. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppPatch.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppPatch.yml index 32646811..e1e82203 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppPatch.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppPatch.yml @@ -10,6 +10,7 @@ constructor: - name: tags description: A set of tags. Application-specific metadata in the form of key-value pairs. + defaultValue: None types: - [, ] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbe.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbe.yml index cb509cfb..615de79c 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbe.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbe.yml @@ -17,22 +17,26 @@ constructor: after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10.' + defaultValue: None types: - - name: http_get description: HTTPGet specifies the http request to perform. + defaultValue: None types: - - name: initial_delay_seconds description: 'Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60.' + defaultValue: None types: - - name: period_seconds description: 'How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240.' + defaultValue: None types: - - name: success_threshold @@ -42,6 +46,7 @@ constructor: Minimum value is 1. Maximum value is 10.' + defaultValue: None types: - - name: tcp_socket @@ -49,6 +54,7 @@ constructor: yet supported.' + defaultValue: None types: - - name: termination_grace_period_seconds @@ -76,17 +82,20 @@ constructor: feature gate. Maximum value is 3600 seconds (1 hour).' + defaultValue: None types: - - name: timeout_seconds description: 'Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240.' + defaultValue: None types: - - name: type description: 'The type of probe. Possible values include: "liveness", "readiness", "startup".' + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbeHttpGet.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbeHttpGet.yml index 9caa1b0b..6036bd96 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbeHttpGet.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbeHttpGet.yml @@ -17,14 +17,17 @@ constructor: to set "Host" in httpHeaders instead.' + defaultValue: None types: - - name: http_headers description: Custom headers to set in the request. HTTP allows repeated headers. + defaultValue: None types: - [] - name: path description: Path to access on the HTTP server. + defaultValue: None types: - - name: port @@ -36,6 +39,7 @@ constructor: - - name: scheme description: Scheme to use for connecting to the host. Defaults to HTTP. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbeTcpSocket.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbeTcpSocket.yml index 63597c5d..782cc1f7 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbeTcpSocket.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerAppProbeTcpSocket.yml @@ -12,6 +12,7 @@ constructor: keywordOnlyParameters: - name: host description: 'Optional: Host name to connect to, defaults to the pod IP.' + defaultValue: None types: - - name: port diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerResources.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerResources.yml index e0c3574f..fc5f1075 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerResources.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ContainerResources.yml @@ -13,10 +13,12 @@ constructor: keywordOnlyParameters: - name: cpu description: Required CPU in cores, e.g. 0.5. + defaultValue: None types: - - name: memory description: Required memory, e.g. "250Mb". + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CookieExpiration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CookieExpiration.yml index b907ed74..4589079a 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CookieExpiration.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CookieExpiration.yml @@ -12,6 +12,7 @@ constructor: description: 'The convention used when determining the session cookie''s expiration. Possible values include: "FixedTime", "IdentityProviderDerived".' + defaultValue: None types: - - @@ -19,6 +20,7 @@ constructor: description: 'The time after the request is made when the session cookie should expire.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomDomain.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomDomain.yml index 317f07ce..49d0975d 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomDomain.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomDomain.yml @@ -19,6 +19,7 @@ constructor: description: 'Custom Domain binding type. Possible values include: "Disabled", "SniEnabled".' + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomHostnameAnalysisResult.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomHostnameAnalysisResult.yml index de7cb67c..f0b841e6 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomHostnameAnalysisResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomHostnameAnalysisResult.yml @@ -14,22 +14,27 @@ constructor: keywordOnlyParameters: - name: c_name_records description: CName records visible for this hostname. + defaultValue: None types: - [] - name: txt_records description: TXT records visible for this hostname. + defaultValue: None types: - [] - name: a_records description: A records visible for this hostname. + defaultValue: None types: - [] - name: alternate_c_name_records description: Alternate CName records visible for this hostname. + defaultValue: None types: - [] - name: alternate_txt_records description: Alternate TXT records visible for this hostname. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomOpenIdConnectProvider.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomOpenIdConnectProvider.yml index 742d4395..68ed1b21 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomOpenIdConnectProvider.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomOpenIdConnectProvider.yml @@ -14,6 +14,7 @@ constructor: not be enabled; otherwise, `true`.' + defaultValue: None types: - - name: registration @@ -21,6 +22,7 @@ constructor: Open ID Connect provider.' + defaultValue: None types: - - name: login @@ -28,6 +30,7 @@ constructor: ID Connect provider.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomScaleRule.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomScaleRule.yml index eb901dec..ce61c29a 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomScaleRule.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.CustomScaleRule.yml @@ -12,14 +12,17 @@ constructor: description: 'Type of the custom scale rule eg: azure-servicebus, redis etc.' + defaultValue: None types: - - name: metadata description: Metadata properties to describe custom scale rule. + defaultValue: None types: - [, ] - name: auth description: Authentication secrets for the custom scale rule. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Dapr.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Dapr.yml index c80b5d8a..ae52789b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Dapr.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Dapr.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: enabled description: Boolean indicating if the Dapr side car is enabled. + defaultValue: None types: - - name: app_id description: Dapr application identifier. + defaultValue: None types: - - name: app_protocol @@ -21,11 +23,13 @@ constructor: are http and grpc. Default is http. Possible values include: "http", "grpc".' + defaultValue: None types: - - - name: app_port description: Tells Dapr which port your application is listening on. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DaprComponent.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DaprComponent.yml index e86f500e..416fc0bf 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DaprComponent.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DaprComponent.yml @@ -15,30 +15,37 @@ constructor: keywordOnlyParameters: - name: component_type description: Component type. + defaultValue: None types: - - name: version description: Component version. + defaultValue: None types: - - name: ignore_errors description: Boolean describing if the component errors are ignores. + defaultValue: None types: - - name: init_timeout description: Initialization timeout. + defaultValue: None types: - - name: secrets description: Collection of secrets used by a Dapr component. + defaultValue: None types: - [] - name: metadata description: Component metadata. + defaultValue: None types: - [] - name: scopes description: Names of container apps that can use this Dapr component. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DaprMetadata.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DaprMetadata.yml index d9ab1489..109bbc3a 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DaprMetadata.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DaprMetadata.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: name description: Metadata property name. + defaultValue: None types: - - name: value description: Metadata property value. + defaultValue: None types: - - name: secret_ref @@ -21,6 +23,7 @@ constructor: property value.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultAuthorizationPolicy.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultAuthorizationPolicy.yml index 9585d605..3118c4f9 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultAuthorizationPolicy.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultAuthorizationPolicy.yml @@ -13,12 +13,14 @@ constructor: description: 'The configuration settings of the Azure Active Directory allowed principals.' + defaultValue: None types: - - name: allowed_applications description: 'The configuration settings of the Azure Active Directory allowed applications.' + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultErrorResponseError.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultErrorResponseError.yml index 1e298a71..7a387df5 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultErrorResponseError.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.DefaultErrorResponseError.yml @@ -13,6 +13,7 @@ constructor: keywordOnlyParameters: - name: details description: Details or the error. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.EnvironmentVar.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.EnvironmentVar.yml index 846667f0..93dbca65 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.EnvironmentVar.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.EnvironmentVar.yml @@ -10,16 +10,19 @@ constructor: keywordOnlyParameters: - name: name description: Environment variable name. + defaultValue: None types: - - name: value description: Non-secret environment variable value. + defaultValue: None types: - - name: secret_ref description: 'Name of the Container App secret from which to pull the environment variable value.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Facebook.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Facebook.yml index abc41df9..0cbf8ec6 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Facebook.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Facebook.yml @@ -13,20 +13,24 @@ constructor: description: '`false` if the Facebook provider should not be enabled despite the set registration; otherwise, `true`.' + defaultValue: None types: - - name: registration description: 'The configuration settings of the app registration for the Facebook provider.' + defaultValue: None types: - - name: graph_api_version description: The version of the Facebook api to be used while logging in. + defaultValue: None types: - - name: login description: The configuration settings of the login flow. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ForwardProxy.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ForwardProxy.yml index 95994287..9cd3e508 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ForwardProxy.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ForwardProxy.yml @@ -13,15 +13,18 @@ constructor: description: 'The convention used to determine the url of the request made. Possible values include: "NoProxy", "Standard", "Custom".' + defaultValue: None types: - - - name: custom_host_header_name description: The name of the header containing the host of the request. + defaultValue: None types: - - name: custom_proto_header_name description: The name of the header containing the scheme of the request. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GitHub.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GitHub.yml index 64a541c6..1a1795f1 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GitHub.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GitHub.yml @@ -12,16 +12,19 @@ constructor: description: '`false` if the GitHub provider should not be enabled despite the set registration; otherwise, `true`.' + defaultValue: None types: - - name: registration description: 'The configuration settings of the app registration for the GitHub provider.' + defaultValue: None types: - - name: login description: The configuration settings of the login flow. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GithubActionConfiguration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GithubActionConfiguration.yml index 487022fd..0ac0fcf8 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GithubActionConfiguration.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GithubActionConfiguration.yml @@ -13,30 +13,37 @@ constructor: keywordOnlyParameters: - name: registry_info description: Registry configurations. + defaultValue: None types: - - name: azure_credentials description: AzureCredentials configurations. + defaultValue: None types: - - name: dockerfile_path description: Docker file path. + defaultValue: None types: - - name: publish_type description: Code or Image. + defaultValue: None types: - - name: os description: Operation system. + defaultValue: None types: - - name: runtime_stack description: Runtime stack. + defaultValue: None types: - - name: runtime_version description: Runtime Version. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GlobalValidation.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GlobalValidation.yml index 87b5b503..87515ca0 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GlobalValidation.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.GlobalValidation.yml @@ -17,6 +17,7 @@ constructor: "AllowAnonymous", "Return401", "Return403".' + defaultValue: None types: - - @@ -30,6 +31,7 @@ constructor: client action is set to "RedirectToLoginPage".' + defaultValue: None types: - - name: excluded_paths @@ -37,6 +39,7 @@ constructor: to the login page.' + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Google.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Google.yml index 9c393be6..bac8ecab 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Google.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Google.yml @@ -13,22 +13,26 @@ constructor: description: '`false` if the Google provider should not be enabled despite the set registration; otherwise, `true`.' + defaultValue: None types: - - name: registration description: 'The configuration settings of the app registration for the Google provider.' + defaultValue: None types: - - name: login description: The configuration settings of the login flow. + defaultValue: None types: - - name: validation description: 'The configuration settings of the Azure Active Directory token validation flow.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpScaleRule.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpScaleRule.yml index 6c1a08dd..e9e0e2d7 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpScaleRule.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpScaleRule.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: metadata description: Metadata properties to describe http scale rule. + defaultValue: None types: - [, ] - name: auth description: Authentication secrets for the custom scale rule. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpSettings.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpSettings.yml index 59b07978..e9bb0a4c 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpSettings.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpSettings.yml @@ -13,16 +13,19 @@ constructor: description: '`false` if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, `true`.' + defaultValue: None types: - - name: routes description: The configuration settings of the paths HTTP requests. + defaultValue: None types: - - name: forward_proxy description: 'The configuration settings of a forward proxy used to make the requests.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpSettingsRoutes.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpSettingsRoutes.yml index 507ad461..a9487a64 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpSettingsRoutes.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.HttpSettingsRoutes.yml @@ -10,6 +10,7 @@ constructor: - name: api_prefix description: The prefix that should precede all the authentication/authorization paths. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.IdentityProviders.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.IdentityProviders.yml index 0d68b39d..fc7e4112 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.IdentityProviders.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.IdentityProviders.yml @@ -16,32 +16,39 @@ constructor: description: 'The configuration settings of the Azure Active directory provider.' + defaultValue: None types: - - name: facebook description: The configuration settings of the Facebook provider. + defaultValue: None types: - - name: git_hub description: The configuration settings of the GitHub provider. + defaultValue: None types: - - name: google description: The configuration settings of the Google provider. + defaultValue: None types: - - name: twitter description: The configuration settings of the Twitter provider. + defaultValue: None types: - - name: apple description: The configuration settings of the Apple provider. + defaultValue: None types: - - name: azure_static_web_apps description: 'The configuration settings of the Azure Static Web Apps provider.' + defaultValue: None types: - - name: custom_open_id_connect_providers @@ -50,6 +57,7 @@ constructor: ID Connect provider to the configuration settings of the custom Open ID Connect provider.' + defaultValue: None types: - [, ] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Ingress.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Ingress.yml index 6747b564..a2b34fe2 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Ingress.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Ingress.yml @@ -15,31 +15,37 @@ constructor: keywordOnlyParameters: - name: external description: Bool indicating if app exposes an external http endpoint. + defaultValue: 'False' types: - - name: target_port description: Target Port in containers for traffic from ingress. + defaultValue: None types: - - name: transport description: 'Ingress transport protocol. Possible values include: "auto", "http", "http2".' + defaultValue: None types: - - - name: traffic description: Traffic weights for app's revisions. + defaultValue: None types: - [] - name: custom_domains description: custom domain bindings for Container Apps' hostnames. + defaultValue: None types: - [] - name: allow_insecure description: 'Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.JwtClaimChecks.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.JwtClaimChecks.yml index b026ed57..d205c445 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.JwtClaimChecks.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.JwtClaimChecks.yml @@ -11,10 +11,12 @@ constructor: keywordOnlyParameters: - name: allowed_groups description: The list of the allowed groups. + defaultValue: None types: - [] - name: allowed_client_applications description: The list of the allowed client applications. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LogAnalyticsConfiguration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LogAnalyticsConfiguration.yml index 442a538d..c251b09d 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LogAnalyticsConfiguration.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LogAnalyticsConfiguration.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: customer_id description: Log analytics customer id. + defaultValue: None types: - - name: shared_key description: Log analytics customer key. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Login.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Login.yml index 2b06f038..944fdf78 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Login.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Login.yml @@ -12,12 +12,14 @@ constructor: keywordOnlyParameters: - name: routes description: The routes that specify the endpoints used for login and logout requests. + defaultValue: None types: - - name: preserve_url_fragments_for_logins description: '`true` if the fragments from the request are preserved after the login request is made; otherwise, `false`.' + defaultValue: None types: - - name: allowed_external_redirect_urls @@ -30,14 +32,17 @@ constructor: backends. Note that URLs within the current domain are always implicitly allowed.' + defaultValue: None types: - [] - name: cookie_expiration description: The configuration settings of the session cookie's expiration. + defaultValue: None types: - - name: nonce description: The configuration settings of the nonce used in the login flow. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LoginRoutes.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LoginRoutes.yml index 4b28669d..a824ab91 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LoginRoutes.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LoginRoutes.yml @@ -9,6 +9,7 @@ constructor: keywordOnlyParameters: - name: logout_endpoint description: The endpoint at which a logout request should be made. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LoginScopes.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LoginScopes.yml index efd6ddce..0d2d8590 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LoginScopes.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.LoginScopes.yml @@ -10,6 +10,7 @@ constructor: keywordOnlyParameters: - name: scopes description: A list of the scopes that should be requested while authenticating. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironment.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironment.yml index 8fd333b7..91e055d1 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironment.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironment.yml @@ -17,6 +17,7 @@ constructor: keywordOnlyParameters: - name: tags description: A set of tags. Resource tags. + defaultValue: None types: - [, ] - name: location @@ -27,10 +28,12 @@ constructor: description: 'Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry.' + defaultValue: None types: - - name: vnet_configuration description: Vnet configuration for the environment. + defaultValue: None types: - - name: app_logs_configuration @@ -39,6 +42,7 @@ constructor: app logs to a destination. Currently only "log-analytics" is supported.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentPatch.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentPatch.yml index 25b0bcd0..9861e815 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentPatch.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentPatch.yml @@ -10,6 +10,7 @@ constructor: - name: tags description: A set of tags. Application-specific metadata in the form of key-value pairs. + defaultValue: None types: - [, ] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentStorage.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentStorage.yml index 2e98c942..d604e827 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentStorage.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentStorage.yml @@ -13,6 +13,7 @@ constructor: keywordOnlyParameters: - name: properties description: Storage properties. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentStorageProperties.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentStorageProperties.yml index a548a3a1..e77e9fca 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentStorageProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedEnvironmentStorageProperties.yml @@ -10,6 +10,7 @@ constructor: keywordOnlyParameters: - name: azure_file description: Azure file properties. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedServiceIdentity.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedServiceIdentity.yml index 17838d3c..654995b8 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedServiceIdentity.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ManagedServiceIdentity.yml @@ -33,6 +33,7 @@ constructor: ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.' + defaultValue: None types: - [, ] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Nonce.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Nonce.yml index 0eaf3541..c52fabe0 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Nonce.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Nonce.yml @@ -12,12 +12,14 @@ constructor: description: '`false` if the nonce should not be validated while completing the login flow; otherwise, `true`.' + defaultValue: None types: - - name: nonce_expiration_interval description: 'The time after the request is made when the nonce should expire.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectClientCredential.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectClientCredential.yml index 151b54d8..379dff18 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectClientCredential.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectClientCredential.yml @@ -13,12 +13,14 @@ constructor: acceptable values to pass in are None and "ClientSecretPost". The default value is None.' + defaultValue: None types: - - name: client_secret_setting_name description: 'The app setting that contains the client secret for the custom Open ID Connect provider.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectConfig.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectConfig.yml index 0944cd8a..7ca839ac 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectConfig.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectConfig.yml @@ -12,26 +12,31 @@ constructor: keywordOnlyParameters: - name: authorization_endpoint description: The endpoint to be used to make an authorization request. + defaultValue: None types: - - name: token_endpoint description: The endpoint to be used to request a token. + defaultValue: None types: - - name: issuer description: The endpoint that issues the token. + defaultValue: None types: - - name: certification_uri description: 'The endpoint that provides the keys necessary to validate the token.' + defaultValue: None types: - - name: well_known_open_id_configuration description: 'The endpoint that contains all the configuration endpoints for the provider.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectLogin.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectLogin.yml index a556ff9e..97898dda 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectLogin.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectLogin.yml @@ -11,10 +11,12 @@ constructor: keywordOnlyParameters: - name: name_claim_type description: The name of the claim that contains the users name. + defaultValue: None types: - - name: scopes description: A list of the scopes that should be requested while authenticating. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectRegistration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectRegistration.yml index e7f52517..e7193553 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectRegistration.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OpenIdConnectRegistration.yml @@ -12,18 +12,21 @@ constructor: keywordOnlyParameters: - name: client_id description: The client id of the custom Open ID Connect provider. + defaultValue: None types: - - name: client_credential description: 'The authentication credentials of the custom Open ID Connect provider.' + defaultValue: None types: - - name: open_id_connect_configuration description: 'The configuration settings of the endpoints used for the custom Open ID Connect provider.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OperationDetail.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OperationDetail.yml index 03637368..63d48f5a 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OperationDetail.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OperationDetail.yml @@ -10,18 +10,22 @@ constructor: keywordOnlyParameters: - name: name description: Name of the operation. + defaultValue: None types: - - name: is_data_action description: Indicates whether the operation is a data action. + defaultValue: None types: - - name: display description: Display of the operation. + defaultValue: None types: - - name: origin description: Origin of the operation. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OperationDisplay.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OperationDisplay.yml index 31453446..708d6e72 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OperationDisplay.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.OperationDisplay.yml @@ -10,18 +10,22 @@ constructor: keywordOnlyParameters: - name: provider description: Resource provider of the operation. + defaultValue: None types: - - name: resource description: Resource of the operation. + defaultValue: None types: - - name: operation description: Localized friendly name for the operation. + defaultValue: None types: - - name: description description: Localized friendly description for the operation. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.QueueScaleRule.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.QueueScaleRule.yml index f8a31ead..b7861fa3 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.QueueScaleRule.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.QueueScaleRule.yml @@ -10,14 +10,17 @@ constructor: keywordOnlyParameters: - name: queue_name description: Queue name. + defaultValue: None types: - - name: queue_length description: Queue length. + defaultValue: None types: - - name: auth description: Authentication secrets for the queue scale rule. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RegistryCredentials.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RegistryCredentials.yml index 262046e8..fa989747 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RegistryCredentials.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RegistryCredentials.yml @@ -10,14 +10,17 @@ constructor: keywordOnlyParameters: - name: server description: Container Registry Server. + defaultValue: None types: - - name: username description: Container Registry Username. + defaultValue: None types: - - name: password_secret_ref description: The name of the Secret that contains the registry login password. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RegistryInfo.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RegistryInfo.yml index 4226feb5..7d239571 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RegistryInfo.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.RegistryInfo.yml @@ -10,14 +10,17 @@ constructor: keywordOnlyParameters: - name: registry_url description: registry server Url. + defaultValue: None types: - - name: registry_user_name description: registry username. + defaultValue: None types: - - name: registry_password description: registry secret. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Replica.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Replica.yml index b6c83fb2..d20ceffe 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Replica.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Replica.yml @@ -12,6 +12,7 @@ constructor: keywordOnlyParameters: - name: containers description: The containers collection under a replica. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ReplicaContainer.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ReplicaContainer.yml index ee918a50..0581c2c3 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ReplicaContainer.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ReplicaContainer.yml @@ -11,22 +11,27 @@ constructor: keywordOnlyParameters: - name: name description: The Name of the Container. + defaultValue: None types: - - name: container_id description: The Id of the Container. + defaultValue: None types: - - name: ready description: The container ready status. + defaultValue: None types: - - name: started description: The container start status. + defaultValue: None types: - - name: restart_count description: The container restart count. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Scale.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Scale.yml index c18c6e86..0666ce46 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Scale.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Scale.yml @@ -10,6 +10,7 @@ constructor: keywordOnlyParameters: - name: min_replicas description: Optional. Minimum number of container replicas. + defaultValue: None types: - - name: max_replicas @@ -17,10 +18,12 @@ constructor: not set.' + defaultValue: None types: - - name: rules description: Scaling rules. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ScaleRule.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ScaleRule.yml index ffef4e5c..0114a4b2 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ScaleRule.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ScaleRule.yml @@ -11,18 +11,22 @@ constructor: keywordOnlyParameters: - name: name description: Scale Rule Name. + defaultValue: None types: - - name: azure_queue description: Azure Queue based scaling. + defaultValue: None types: - - name: custom description: Custom scale rule. + defaultValue: None types: - - name: http description: HTTP requests based scaling. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ScaleRuleAuth.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ScaleRuleAuth.yml index 2f37e630..0b758f0a 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ScaleRuleAuth.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.ScaleRuleAuth.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: secret_ref description: Name of the Container App secret from which to pull the auth params. + defaultValue: None types: - - name: trigger_parameter description: Trigger Parameter that uses the secret. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Secret.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Secret.yml index 1c69cbf9..b3be01b0 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Secret.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Secret.yml @@ -9,10 +9,12 @@ constructor: keywordOnlyParameters: - name: name description: Secret Name. + defaultValue: None types: - - name: value description: Secret Value. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SourceControl.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SourceControl.yml index e337e61a..f969bb8d 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SourceControl.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SourceControl.yml @@ -13,10 +13,12 @@ constructor: keywordOnlyParameters: - name: repo_url description: The repo url which will be integrated to ContainerApp. + defaultValue: None types: - - name: branch description: The branch which will trigger the auto deployment. + defaultValue: None types: - - name: github_action_configuration @@ -27,6 +29,7 @@ constructor: defaults if user did not provide them. The defaults are populated as they were at the creation time.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SystemData.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SystemData.yml index 8b2f80c7..c0de45a9 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SystemData.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.SystemData.yml @@ -12,32 +12,38 @@ constructor: keywordOnlyParameters: - name: created_by description: The identity that created the resource. + defaultValue: None types: - - name: created_by_type description: 'The type of identity that created the resource. Possible values include: "User", "Application", "ManagedIdentity", "Key".' + defaultValue: None types: - - - name: created_at description: The timestamp of resource creation (UTC). + defaultValue: None types: - - name: last_modified_by description: The identity that last modified the resource. + defaultValue: None types: - - name: last_modified_by_type description: 'The type of identity that last modified the resource. Possible values include: "User", "Application", "ManagedIdentity", "Key".' + defaultValue: None types: - - - name: last_modified_at description: The timestamp of resource last modification (UTC). + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Template.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Template.yml index 3687b711..c95a9d90 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Template.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Template.yml @@ -20,17 +20,21 @@ constructor: keywordOnlyParameters: - name: revision_suffix description: User friendly suffix that is appended to the revision name. + defaultValue: None types: - - name: containers description: List of container definitions for the Container App. + defaultValue: None types: - [] - name: scale description: Scaling properties for the Container App. + defaultValue: None types: - - name: volumes description: List of volume definitions for the Container App. + defaultValue: None types: - [] diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TrackedResource.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TrackedResource.yml index 7c75b6a1..0c17a1c8 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TrackedResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TrackedResource.yml @@ -16,6 +16,7 @@ constructor: keywordOnlyParameters: - name: tags description: A set of tags. Resource tags. + defaultValue: None types: - [, ] - name: location diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TrafficWeight.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TrafficWeight.yml index 3403353e..910b3bc7 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TrafficWeight.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TrafficWeight.yml @@ -10,16 +10,19 @@ constructor: keywordOnlyParameters: - name: revision_name description: Name of a revision. + defaultValue: None types: - - name: weight description: Traffic weight assigned to a revision. + defaultValue: None types: - - name: latest_revision description: 'Indicates that the traffic weight belongs to a latest stable revision.' + defaultValue: 'False' types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Twitter.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Twitter.yml index 4c88560a..5c11e041 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Twitter.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Twitter.yml @@ -12,12 +12,14 @@ constructor: description: '`false` if the Twitter provider should not be enabled despite the set registration; otherwise, `true`.' + defaultValue: None types: - - name: registration description: 'The configuration settings of the app registration for the Twitter provider.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TwitterRegistration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TwitterRegistration.yml index 7107c74e..f8dbf608 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TwitterRegistration.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.TwitterRegistration.yml @@ -15,6 +15,7 @@ constructor: This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: [https://dev.twitter.com/web/sign-in](https://dev.twitter.com/web/sign-in).' + defaultValue: None types: - - name: consumer_secret_setting_name @@ -23,6 +24,7 @@ constructor: consumer secret of the Twitter application used for sign-in.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.VnetConfiguration.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.VnetConfiguration.yml index cb562565..bd869971 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.VnetConfiguration.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.VnetConfiguration.yml @@ -17,6 +17,7 @@ constructor: environments do not have a public static IP resource, must provide ControlPlaneSubnetResourceId and AppSubnetResourceId if enabling this property.' + defaultValue: None types: - - name: infrastructure_subnet_id @@ -26,6 +27,7 @@ constructor: not overlap with any other provided IP ranges.' + defaultValue: None types: - - name: runtime_subnet_id @@ -34,24 +36,28 @@ constructor: into. This subnet must be in the same VNET as the subnet defined in infrastructureSubnetId. Must not overlap with any other provided IP ranges.' + defaultValue: None types: - - name: docker_bridge_cidr description: 'CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges.' + defaultValue: None types: - - name: platform_reserved_cidr description: 'IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges.' + defaultValue: None types: - - name: platform_reserved_dns_ip description: 'An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Volume.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Volume.yml index 9b95e210..869e54c7 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Volume.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.Volume.yml @@ -10,17 +10,20 @@ constructor: keywordOnlyParameters: - name: name description: Volume name. + defaultValue: None types: - - name: storage_type description: 'Storage type for the volume. If not provided, use EmptyDir. Possible values include: "AzureFile", "EmptyDir".' + defaultValue: None types: - - - name: storage_name description: Name of storage resource. No need to provide for EmptyDir. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.VolumeMount.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.VolumeMount.yml index 799c8894..64743a1f 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.VolumeMount.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.models.VolumeMount.yml @@ -10,6 +10,7 @@ constructor: keywordOnlyParameters: - name: volume_name description: This must match the Name of a Volume. + defaultValue: None types: - - name: mount_path @@ -17,6 +18,7 @@ constructor: not contain '':''.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.CertificatesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.CertificatesOperations.yml index eab35895..2437851e 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.CertificatesOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.CertificatesOperations.yml @@ -56,7 +56,7 @@ methods: - - name: certificate_envelope description: Certificate to be created or updated. - isRequired: true + defaultValue: None types: - keywordOnlyParameters: diff --git a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsOperations.yml index ff5e2fbc..6eee1553 100644 --- a/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-app/azure.mgmt.app.operations.ContainerAppsOperations.yml @@ -238,7 +238,7 @@ methods: - - name: custom_hostname description: Custom hostname. - isRequired: true + defaultValue: None types: - keywordOnlyParameters: diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatus.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatus.yml index 2b36f913..85952b18 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatus.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatus.yml @@ -62,20 +62,20 @@ constructor: - keywordOnlyParameters: - name: subscription_id - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: status - isRequired: true + defaultValue: None - name: start_time - isRequired: true + defaultValue: None - name: end_time - isRequired: true + defaultValue: None - name: error - isRequired: true + defaultValue: None - name: billing_config - isRequired: true + defaultValue: None - name: tenant_id - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatusError.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatusError.yml index fd62952d..110e0417 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatusError.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.AsyncOperationStatusError.yml @@ -20,6 +20,6 @@ constructor: - keywordOnlyParameters: - name: code - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKU.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKU.yml index 0943ecaf..53801134 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKU.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CResourceSKU.yml @@ -21,7 +21,7 @@ constructor: - () keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None variables: - description: 'The tier of the tenant. Default value: "A0".' name: tier diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResource.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResource.yml index 6454dc7e..4813badb 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResource.yml @@ -54,11 +54,11 @@ constructor: - name: location isRequired: true - name: tags - isRequired: true + defaultValue: None - name: billing_config - isRequired: true + defaultValue: None - name: tenant_id - isRequired: true + defaultValue: None variables: - description: 'The type of the B2C tenant resource. Default value: diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResourcePropertiesBillingConfig.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResourcePropertiesBillingConfig.yml index a2b722e2..9da246a8 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResourcePropertiesBillingConfig.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantResourcePropertiesBillingConfig.yml @@ -26,7 +26,7 @@ constructor: - () keywordOnlyParameters: - name: billing_type - isRequired: true + defaultValue: None variables: - description: The data from which the billing type took effect. name: effective_start_date_utc diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantUpdateRequest.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantUpdateRequest.yml index 681edbc6..0774c0da 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantUpdateRequest.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.B2CTenantUpdateRequest.yml @@ -34,10 +34,10 @@ constructor: - keywordOnlyParameters: - name: sku - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: billing_config - isRequired: true + defaultValue: None - name: tenant_id - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBody.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBody.yml index b97fb822..b5833637 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBody.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBody.yml @@ -48,4 +48,4 @@ constructor: - name: sku isRequired: true - name: tags - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBodyProperties.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBodyProperties.yml index 718befcd..25d04568 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBodyProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.CreateTenantRequestBodyProperties.yml @@ -28,6 +28,6 @@ constructor: - keywordOnlyParameters: - name: display_name - isRequired: true + defaultValue: None - name: country_code - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.NameAvailabilityResponse.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.NameAvailabilityResponse.yml index 5a01cd85..1cf422a3 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.NameAvailabilityResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.NameAvailabilityResponse.yml @@ -31,8 +31,8 @@ constructor: - () keywordOnlyParameters: - name: message - isRequired: true + defaultValue: None - name: name_available - isRequired: true + defaultValue: None - name: reason - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.Operation.yml index 3f8dc131..7bf8cfce 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.Operation.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.Operation.yml @@ -17,7 +17,7 @@ constructor: - () keywordOnlyParameters: - name: display - isRequired: true + defaultValue: None variables: - description: 'Operation name: {provider}/{resource}/{operation}.' name: name diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.OperationDisplay.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.OperationDisplay.yml index a14cc6e3..472c850a 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.OperationDisplay.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2019_01_01_preview.models.OperationDisplay.yml @@ -17,7 +17,7 @@ constructor: - keywordOnlyParameters: - name: description - isRequired: true + defaultValue: None variables: - description: 'Service provider: Microsoft.AzureActiveDirectory.' name: provider diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResource.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResource.yml index dcb801cc..a2c39fc5 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResource.yml @@ -29,11 +29,11 @@ constructor: - keywordOnlyParameters: - name: location - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: tenant_id - isRequired: true + defaultValue: None variables: - description: An identifier that represents the Guest Usages resource. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResourcePatch.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResourcePatch.yml index c7441289..c2926a61 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResourcePatch.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.GuestUsagesResourcePatch.yml @@ -15,4 +15,4 @@ constructor: - [, ] keywordOnlyParameters: - name: tags - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.Operation.yml index 67707876..dab96bab 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.Operation.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.Operation.yml @@ -17,7 +17,7 @@ constructor: - () keywordOnlyParameters: - name: display - isRequired: true + defaultValue: None variables: - description: 'Operation name: {provider}/{resource}/{operation}.' name: name diff --git a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.OperationDisplay.yml b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.OperationDisplay.yml index 68ef3c90..1be1afe9 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.OperationDisplay.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azureadb2c/azure.mgmt.azureadb2c.v2020_05_01_preview.models.OperationDisplay.yml @@ -17,7 +17,7 @@ constructor: - keywordOnlyParameters: - name: description - isRequired: true + defaultValue: None variables: - description: 'Service provider: Microsoft.AzureActiveDirectory.' name: provider diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.operations.AzureLargeInstanceOperations.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.operations.AzureLargeInstanceOperations.yml index f5b062bd..d01472e5 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.operations.AzureLargeInstanceOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.aio.operations.AzureLargeInstanceOperations.yml @@ -36,7 +36,7 @@ methods: running on the server. Is either a ForceState type or a IO type. Default value is None.' - isRequired: true + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstance.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstance.yml index c0c85d2d..64e19c43 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstance.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstance.yml @@ -18,6 +18,7 @@ constructor: keywordOnlyParameters: - name: tags description: Resource tags. + defaultValue: None types: - [, ] - name: location @@ -26,6 +27,7 @@ constructor: - - name: properties description: The resource-specific properties for this resource. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceListResult.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceListResult.yml index 24ca7878..9f5fb2e8 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceListResult.yml @@ -17,6 +17,7 @@ constructor: - [] - name: next_link description: The link to the next page of items. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProperties.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProperties.yml index 34501e5e..a8fb1465 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceProperties.yml @@ -15,18 +15,22 @@ constructor: keywordOnlyParameters: - name: hardware_profile description: Specifies the hardware settings for the Azure Large Instance. + defaultValue: None types: - - name: storage_profile description: Specifies the storage settings for the Azure Large Instance disks. + defaultValue: None types: - - name: os_profile description: Specifies the operating system settings for the Azure Large Instance. + defaultValue: None types: - - name: network_profile description: Specifies the network settings for the Azure Large Instance. + defaultValue: None types: - - name: partner_node_id @@ -35,6 +39,7 @@ constructor: this AzureLargeInstance.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceTagsUpdate.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceTagsUpdate.yml index 14ab6dec..7e671881 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceTagsUpdate.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeInstanceTagsUpdate.yml @@ -10,6 +10,7 @@ constructor: keywordOnlyParameters: - name: tags description: Resource tags. + defaultValue: None types: - [, ] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstance.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstance.yml index 2237027b..56983f58 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstance.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstance.yml @@ -19,6 +19,7 @@ constructor: keywordOnlyParameters: - name: tags description: Resource tags. + defaultValue: None types: - [, ] - name: location @@ -27,6 +28,7 @@ constructor: - - name: properties description: The resource-specific properties for this resource. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceListResult.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceListResult.yml index 1913d076..11871897 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceListResult.yml @@ -17,6 +17,7 @@ constructor: - [] - name: next_link description: The link to the next page of items. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceProperties.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceProperties.yml index e9a4a923..755c8ba3 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceProperties.yml @@ -13,12 +13,14 @@ constructor: description: 'Specifies the AzureLargeStorageInstance unique ID.' + defaultValue: None types: - - name: storage_properties description: 'Specifies the storage properties for the AzureLargeStorage instance.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceTagsUpdate.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceTagsUpdate.yml index aab559df..957f8deb 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceTagsUpdate.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.AzureLargeStorageInstanceTagsUpdate.yml @@ -10,6 +10,7 @@ constructor: keywordOnlyParameters: - name: tags description: Resource tags. + defaultValue: None types: - [, ] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Disk.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Disk.yml index 6121b471..141ba05f 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Disk.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Disk.yml @@ -13,10 +13,12 @@ constructor: keywordOnlyParameters: - name: name description: The disk name. + defaultValue: None types: - - name: disk_size_gb description: Specifies the size of an empty data disk in gigabytes. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ErrorResponse.yml index e291879d..7e760784 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ErrorResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ErrorResponse.yml @@ -12,6 +12,7 @@ constructor: keywordOnlyParameters: - name: error description: The error object. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ForceState.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ForceState.yml index f58e8dea..174a43b8 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ForceState.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.ForceState.yml @@ -15,6 +15,7 @@ constructor: are: "active" and "inactive".' + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.IpAddress.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.IpAddress.yml index 02b2fe2b..52dd7060 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.IpAddress.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.IpAddress.yml @@ -9,6 +9,7 @@ constructor: keywordOnlyParameters: - name: ip_address description: Specifies the IP address of the network interface. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.NetworkProfile.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.NetworkProfile.yml index 3fc54fcb..8c687f75 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.NetworkProfile.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.NetworkProfile.yml @@ -13,6 +13,7 @@ constructor: keywordOnlyParameters: - name: network_interfaces description: Specifies the network interfaces for the Azure Large Instance. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Operation.yml index 18ab1ce6..47577db2 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Operation.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Operation.yml @@ -14,6 +14,7 @@ constructor: keywordOnlyParameters: - name: display description: Localized display information for this particular operation. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OperationStatusResult.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OperationStatusResult.yml index 3d0492ae..5d6b9c4f 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OperationStatusResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OperationStatusResult.yml @@ -18,10 +18,12 @@ constructor: keywordOnlyParameters: - name: id description: Fully qualified ID for the async operation. + defaultValue: None types: - - name: name description: Name of the async operation. + defaultValue: None types: - - name: status @@ -30,22 +32,27 @@ constructor: - - name: percent_complete description: Percent of the operation that is complete. + defaultValue: None types: - - name: start_time description: The start time of the operation. + defaultValue: None types: - - name: end_time description: The end time of the operation. + defaultValue: None types: - - name: operations description: The operations list. + defaultValue: None types: - [] - name: error description: If present, details of the operation error. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OsProfile.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OsProfile.yml index 451285a7..6003e285 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OsProfile.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.OsProfile.yml @@ -13,10 +13,12 @@ constructor: keywordOnlyParameters: - name: computer_name description: Specifies the host OS name of the Azure Large Instance. + defaultValue: None types: - - name: ssh_public_key description: Specifies the SSH public key used to access the operating system. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageBillingProperties.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageBillingProperties.yml index 02461cd7..7673af99 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageBillingProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageBillingProperties.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: billing_mode description: the billing mode for the storage instance. + defaultValue: None types: - - name: sku description: the SKU type that is provisioned. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageProfile.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageProfile.yml index 12aafae3..6f9740cc 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageProfile.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageProfile.yml @@ -16,6 +16,7 @@ constructor: Large Instance.' + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageProperties.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageProperties.yml index 87cf626b..44bc342c 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.StorageProperties.yml @@ -15,29 +15,35 @@ constructor: keywordOnlyParameters: - name: offering_type description: the offering type for which the resource is getting provisioned. + defaultValue: None types: - - name: storage_type description: the storage protocol for which the resource is getting provisioned. + defaultValue: None types: - - name: generation description: the kind of storage instance. + defaultValue: None types: - - name: hardware_type description: 'the hardware type of the storage instance. Known values are: "Cisco_UCS", "HPE", and "SDFLEX".' + defaultValue: None types: - - - name: workload_type description: the workload for which the resource is getting provisioned. + defaultValue: None types: - - name: storage_billing_properties description: the billing related information for the resource. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.SystemData.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.SystemData.yml index fde456e1..05080d75 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.SystemData.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.SystemData.yml @@ -12,32 +12,38 @@ constructor: keywordOnlyParameters: - name: created_by description: The identity that created the resource. + defaultValue: None types: - - name: created_by_type description: 'The type of identity that created the resource. Known values are: "User", "Application", "ManagedIdentity", and "Key".' + defaultValue: None types: - - - name: created_at description: The timestamp of resource creation (UTC). + defaultValue: None types: - - name: last_modified_by description: The identity that last modified the resource. + defaultValue: None types: - - name: last_modified_by_type description: 'The type of identity that last modified the resource. Known values are: "User", "Application", "ManagedIdentity", and "Key".' + defaultValue: None types: - - - name: last_modified_at description: The timestamp of resource last modification (UTC). + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Tags.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Tags.yml index 000f74aa..317ab218 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Tags.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.Tags.yml @@ -9,6 +9,7 @@ constructor: keywordOnlyParameters: - name: tags description: Tags field of the AzureLargeInstance instance. + defaultValue: None types: - [, ] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.TrackedResource.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.TrackedResource.yml index 1875c5fd..bd64f353 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.TrackedResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.models.TrackedResource.yml @@ -19,6 +19,7 @@ constructor: keywordOnlyParameters: - name: tags description: Resource tags. + defaultValue: None types: - [, ] - name: location diff --git a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.operations.AzureLargeInstanceOperations.yml b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.operations.AzureLargeInstanceOperations.yml index f6900f16..bf595b57 100644 --- a/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.operations.AzureLargeInstanceOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-azurelargeinstance/azure.mgmt.azurelargeinstance.operations.AzureLargeInstanceOperations.yml @@ -36,7 +36,7 @@ methods: running on the server. Is either a ForceState type or a IO type. Default value is None.' - isRequired: true + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AppInsightsReference.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AppInsightsReference.yml index b3e51016..96b71cbc 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AppInsightsReference.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AppInsightsReference.yml @@ -35,6 +35,6 @@ constructor: - name: component isRequired: true - name: instrumentation_key - isRequired: true + defaultValue: None - name: instrumentation_key_secret_reference - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AutoScaleSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AutoScaleSettings.yml index c9ea5c3b..407845f2 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AutoScaleSettings.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AutoScaleSettings.yml @@ -41,4 +41,4 @@ constructor: - name: maximum_node_count isRequired: true - name: initial_node_count - isRequired: true + defaultValue: '0' diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AzureBlobFileSystemReference.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AzureBlobFileSystemReference.yml index b942ab39..c63101fe 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AzureBlobFileSystemReference.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AzureBlobFileSystemReference.yml @@ -57,4 +57,4 @@ constructor: - name: relative_mount_path isRequired: true - name: mount_options - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AzureStorageCredentialsInfo.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AzureStorageCredentialsInfo.yml index 8cf61a71..9f37d1a5 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AzureStorageCredentialsInfo.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.AzureStorageCredentialsInfo.yml @@ -25,6 +25,6 @@ constructor: - keywordOnlyParameters: - name: account_key - isRequired: true + defaultValue: None - name: account_key_secret_reference - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CNTKsettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CNTKsettings.yml index f70f04e5..f2fcbc7c 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CNTKsettings.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CNTKsettings.yml @@ -58,14 +58,14 @@ constructor: - keywordOnlyParameters: - name: language_type - isRequired: true + defaultValue: None - name: config_file_path - isRequired: true + defaultValue: None - name: python_script_file_path - isRequired: true + defaultValue: None - name: python_interpreter_path - isRequired: true + defaultValue: None - name: command_line_args - isRequired: true + defaultValue: None - name: process_count - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Caffe2Settings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Caffe2Settings.yml index 52ce00ed..526f4d98 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Caffe2Settings.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Caffe2Settings.yml @@ -30,6 +30,6 @@ constructor: - name: python_script_file_path isRequired: true - name: python_interpreter_path - isRequired: true + defaultValue: None - name: command_line_args - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CaffeSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CaffeSettings.yml index e827629d..52fde211 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CaffeSettings.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CaffeSettings.yml @@ -45,12 +45,12 @@ constructor: - keywordOnlyParameters: - name: config_file_path - isRequired: true + defaultValue: None - name: python_script_file_path - isRequired: true + defaultValue: None - name: python_interpreter_path - isRequired: true + defaultValue: None - name: command_line_args - isRequired: true + defaultValue: None - name: process_count - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ChainerSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ChainerSettings.yml index abc34d93..9074cb13 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ChainerSettings.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ChainerSettings.yml @@ -39,8 +39,8 @@ constructor: - name: python_script_file_path isRequired: true - name: python_interpreter_path - isRequired: true + defaultValue: None - name: command_line_args - isRequired: true + defaultValue: None - name: process_count - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Cluster.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Cluster.yml index 7ef199cb..971d91af 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Cluster.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Cluster.yml @@ -64,19 +64,19 @@ constructor: - keywordOnlyParameters: - name: vm_size - isRequired: true + defaultValue: None - name: vm_priority - isRequired: true + defaultValue: None - name: scale_settings - isRequired: true + defaultValue: None - name: virtual_machine_configuration - isRequired: true + defaultValue: None - name: node_setup - isRequired: true + defaultValue: None - name: user_account_settings - isRequired: true + defaultValue: None - name: subnet - isRequired: true + defaultValue: None variables: - description: The ID of the resource. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClusterCreateParameters.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClusterCreateParameters.yml index 2fc33535..2dd53b03 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClusterCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClusterCreateParameters.yml @@ -74,16 +74,16 @@ constructor: - keywordOnlyParameters: - name: vm_size - isRequired: true + defaultValue: None - name: vm_priority - isRequired: true + defaultValue: None - name: scale_settings - isRequired: true + defaultValue: None - name: virtual_machine_configuration - isRequired: true + defaultValue: None - name: node_setup - isRequired: true + defaultValue: None - name: user_account_settings - isRequired: true + defaultValue: None - name: subnet - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClusterUpdateParameters.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClusterUpdateParameters.yml index 50947de0..7e159e15 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClusterUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ClusterUpdateParameters.yml @@ -18,4 +18,4 @@ constructor: - keywordOnlyParameters: - name: scale_settings - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ContainerSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ContainerSettings.yml index f6a91632..50b3625d 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ContainerSettings.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ContainerSettings.yml @@ -30,4 +30,4 @@ constructor: - name: image_source_registry isRequired: true - name: shm_size - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CustomMpiSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CustomMpiSettings.yml index ff4534c5..52c6b6fa 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CustomMpiSettings.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CustomMpiSettings.yml @@ -31,4 +31,4 @@ constructor: - name: command_line isRequired: true - name: process_count - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CustomToolkitSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CustomToolkitSettings.yml index 5fef9494..c4b60f8d 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CustomToolkitSettings.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.CustomToolkitSettings.yml @@ -14,4 +14,4 @@ constructor: - keywordOnlyParameters: - name: command_line - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.EnvironmentVariableWithSecretValue.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.EnvironmentVariableWithSecretValue.yml index 3a04480d..f4f2ba6b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.EnvironmentVariableWithSecretValue.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.EnvironmentVariableWithSecretValue.yml @@ -36,6 +36,6 @@ constructor: - name: name isRequired: true - name: value - isRequired: true + defaultValue: None - name: value_secret_reference - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServer.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServer.yml index 99e0abcc..7a72cb71 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServer.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServer.yml @@ -34,13 +34,13 @@ constructor: - keywordOnlyParameters: - name: vm_size - isRequired: true + defaultValue: None - name: ssh_configuration - isRequired: true + defaultValue: None - name: data_disks - isRequired: true + defaultValue: None - name: subnet - isRequired: true + defaultValue: None variables: - description: The ID of the resource. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerCreateParameters.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerCreateParameters.yml index 0df80de7..4919f89a 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerCreateParameters.yml @@ -40,10 +40,10 @@ constructor: - keywordOnlyParameters: - name: vm_size - isRequired: true + defaultValue: None - name: ssh_configuration - isRequired: true + defaultValue: None - name: data_disks - isRequired: true + defaultValue: None - name: subnet - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerListResult.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerListResult.yml index e9d29186..2e1edab7 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerListResult.yml @@ -17,7 +17,7 @@ constructor: - [] keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None variables: - description: The continuation token. name: next_link diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerReference.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerReference.yml index ff2babbb..f825f5e5 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerReference.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.FileServerReference.yml @@ -48,6 +48,6 @@ constructor: - name: relative_mount_path isRequired: true - name: source_directory - isRequired: true + defaultValue: None - name: mount_options - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.HorovodSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.HorovodSettings.yml index e61b926f..d7a0efab 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.HorovodSettings.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.HorovodSettings.yml @@ -39,8 +39,8 @@ constructor: - name: python_script_file_path isRequired: true - name: python_interpreter_path - isRequired: true + defaultValue: None - name: command_line_args - isRequired: true + defaultValue: None - name: process_count - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ImageReference.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ImageReference.yml index 234f0bc6..94af3166 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ImageReference.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ImageReference.yml @@ -63,6 +63,6 @@ constructor: - name: sku isRequired: true - name: version - isRequired: true + defaultValue: None - name: virtual_machine_image_id - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ImageSourceRegistry.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ImageSourceRegistry.yml index 01ed3cc9..a9f2e16a 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ImageSourceRegistry.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ImageSourceRegistry.yml @@ -30,6 +30,6 @@ constructor: - name: image isRequired: true - name: server_url - isRequired: true + defaultValue: None - name: credentials - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Job.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Job.yml index 5d6ac67e..88e0b6eb 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Job.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Job.yml @@ -170,51 +170,51 @@ constructor: - keywordOnlyParameters: - name: scheduling_priority - isRequired: true + defaultValue: None - name: cluster - isRequired: true + defaultValue: None - name: mount_volumes - isRequired: true + defaultValue: None - name: node_count - isRequired: true + defaultValue: None - name: container_settings - isRequired: true + defaultValue: None - name: tool_type - isRequired: true + defaultValue: None - name: cntk_settings - isRequired: true + defaultValue: None - name: py_torch_settings - isRequired: true + defaultValue: None - name: tensor_flow_settings - isRequired: true + defaultValue: None - name: caffe_settings - isRequired: true + defaultValue: None - name: caffe2_settings - isRequired: true + defaultValue: None - name: chainer_settings - isRequired: true + defaultValue: None - name: custom_toolkit_settings - isRequired: true + defaultValue: None - name: custom_mpi_settings - isRequired: true + defaultValue: None - name: horovod_settings - isRequired: true + defaultValue: None - name: job_preparation - isRequired: true + defaultValue: None - name: std_out_err_path_prefix - isRequired: true + defaultValue: None - name: input_directories - isRequired: true + defaultValue: None - name: output_directories - isRequired: true + defaultValue: None - name: environment_variables - isRequired: true + defaultValue: None - name: secrets - isRequired: true + defaultValue: None - name: constraints - isRequired: true + defaultValue: None - name: execution_info - isRequired: true + defaultValue: None variables: - description: The ID of the resource. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobCreateParameters.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobCreateParameters.yml index b02b5225..d10ed27b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.JobCreateParameters.yml @@ -152,44 +152,44 @@ constructor: - keywordOnlyParameters: - name: scheduling_priority - isRequired: true + defaultValue: None - name: cluster - isRequired: true + defaultValue: None - name: mount_volumes - isRequired: true + defaultValue: None - name: node_count - isRequired: true + defaultValue: None - name: container_settings - isRequired: true + defaultValue: None - name: cntk_settings - isRequired: true + defaultValue: None - name: py_torch_settings - isRequired: true + defaultValue: None - name: tensor_flow_settings - isRequired: true + defaultValue: None - name: caffe_settings - isRequired: true + defaultValue: None - name: caffe2_settings - isRequired: true + defaultValue: None - name: chainer_settings - isRequired: true + defaultValue: None - name: custom_toolkit_settings - isRequired: true + defaultValue: None - name: custom_mpi_settings - isRequired: true + defaultValue: None - name: horovod_settings - isRequired: true + defaultValue: None - name: job_preparation - isRequired: true + defaultValue: None - name: std_out_err_path_prefix - isRequired: true + defaultValue: None - name: input_directories - isRequired: true + defaultValue: None - name: output_directories - isRequired: true + defaultValue: None - name: environment_variables - isRequired: true + defaultValue: None - name: secrets - isRequired: true + defaultValue: None - name: constraints - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.MountSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.MountSettings.yml index 8f650247..826159be 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.MountSettings.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.MountSettings.yml @@ -29,8 +29,8 @@ constructor: - keywordOnlyParameters: - name: mount_point - isRequired: true + defaultValue: None - name: file_server_public_ip - isRequired: true + defaultValue: None - name: file_server_internal_ip - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.MountVolumes.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.MountVolumes.yml index 8f49e86a..f95dcdc2 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.MountVolumes.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.MountVolumes.yml @@ -41,10 +41,10 @@ constructor: - [] keywordOnlyParameters: - name: azure_file_shares - isRequired: true + defaultValue: None - name: azure_blob_file_systems - isRequired: true + defaultValue: None - name: file_servers - isRequired: true + defaultValue: None - name: unmanaged_file_systems - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.NameValuePair.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.NameValuePair.yml index b4b3cfa0..862d1cf3 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.NameValuePair.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.NameValuePair.yml @@ -19,6 +19,6 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.NodeSetup.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.NodeSetup.yml index a7c435ba..8b17ee4b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.NodeSetup.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.NodeSetup.yml @@ -41,8 +41,8 @@ constructor: - keywordOnlyParameters: - name: setup_task - isRequired: true + defaultValue: None - name: mount_volumes - isRequired: true + defaultValue: None - name: performance_counters_settings - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Operation.yml index a60169b8..5bf1041f 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Operation.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.Operation.yml @@ -23,9 +23,9 @@ constructor: - keywordOnlyParameters: - name: display - isRequired: true + defaultValue: None - name: properties - isRequired: true + defaultValue: None variables: - description: This is of the format {provider}/{resource}/{operation}. name: name diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.OutputDirectory.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.OutputDirectory.yml index 04d6c710..c2e9d08b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.OutputDirectory.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.OutputDirectory.yml @@ -49,4 +49,4 @@ constructor: - name: path_prefix isRequired: true - name: path_suffix - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.PrivateRegistryCredentials.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.PrivateRegistryCredentials.yml index 9daece68..2d66c1c3 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.PrivateRegistryCredentials.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.PrivateRegistryCredentials.yml @@ -38,6 +38,6 @@ constructor: - name: username isRequired: true - name: password - isRequired: true + defaultValue: None - name: password_secret_reference - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.PyTorchSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.PyTorchSettings.yml index 902fdfd2..0af8a005 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.PyTorchSettings.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.PyTorchSettings.yml @@ -46,10 +46,10 @@ constructor: - name: python_script_file_path isRequired: true - name: python_interpreter_path - isRequired: true + defaultValue: None - name: command_line_args - isRequired: true + defaultValue: None - name: process_count - isRequired: true + defaultValue: None - name: communication_backend - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ScaleSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ScaleSettings.yml index 235db1c5..99f619d0 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ScaleSettings.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.ScaleSettings.yml @@ -23,6 +23,6 @@ constructor: - keywordOnlyParameters: - name: manual - isRequired: true + defaultValue: None - name: auto_scale - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.SetupTask.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.SetupTask.yml index b9964bd4..17f5a706 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.SetupTask.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.SetupTask.yml @@ -53,9 +53,9 @@ constructor: - name: std_out_err_path_prefix isRequired: true - name: environment_variables - isRequired: true + defaultValue: None - name: secrets - isRequired: true + defaultValue: None variables: - description: 'A path segment appended by Batch AI to stdOutErrPathPrefix to diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.SshConfiguration.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.SshConfiguration.yml index 43e22fd0..c40af180 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.SshConfiguration.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.SshConfiguration.yml @@ -32,4 +32,4 @@ constructor: - name: user_account_settings isRequired: true - name: public_ips_to_allow - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.TensorFlowSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.TensorFlowSettings.yml index 6e0f507f..daee83e9 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.TensorFlowSettings.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.TensorFlowSettings.yml @@ -72,14 +72,14 @@ constructor: - name: python_script_file_path isRequired: true - name: python_interpreter_path - isRequired: true + defaultValue: None - name: master_command_line_args - isRequired: true + defaultValue: None - name: worker_command_line_args - isRequired: true + defaultValue: None - name: parameter_server_command_line_args - isRequired: true + defaultValue: None - name: worker_count - isRequired: true + defaultValue: None - name: parameter_server_count - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.UserAccountSettings.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.UserAccountSettings.yml index c66cff8f..8991844b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.UserAccountSettings.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.UserAccountSettings.yml @@ -33,6 +33,6 @@ constructor: - name: admin_user_name isRequired: true - name: admin_user_ssh_public_key - isRequired: true + defaultValue: None - name: admin_user_password - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.VirtualMachineConfiguration.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.VirtualMachineConfiguration.yml index 97154af1..06b1ffc7 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.VirtualMachineConfiguration.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.VirtualMachineConfiguration.yml @@ -15,4 +15,4 @@ constructor: - keywordOnlyParameters: - name: image_reference - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspaceCreateParameters.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspaceCreateParameters.yml index f118578e..b08ea731 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspaceCreateParameters.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspaceCreateParameters.yml @@ -25,4 +25,4 @@ constructor: - name: location isRequired: true - name: tags - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspaceUpdateParameters.yml b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspaceUpdateParameters.yml index c2c5a715..3511dfae 100644 --- a/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspaceUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-mgmt-batchai/azure.mgmt.batchai.models.WorkspaceUpdateParameters.yml @@ -14,4 +14,4 @@ constructor: - [, ] keywordOnlyParameters: - name: tags - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Address(class).yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Address(class).yml index 7dfd82d5..60d38d39 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Address(class).yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Address(class).yml @@ -58,6 +58,6 @@ constructor: - name: country isRequired: true - name: address_line2 - isRequired: true + defaultValue: None - name: address_line3 - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AsymmetricEncryptedSecret.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AsymmetricEncryptedSecret.yml index 8e89b220..326d5c6b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AsymmetricEncryptedSecret.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.AsymmetricEncryptedSecret.yml @@ -37,4 +37,4 @@ constructor: - name: encryption_algorithm isRequired: true - name: encryption_cert_thumbprint - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Authentication(class).yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Authentication(class).yml index f27de4ea..6e380ad5 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Authentication(class).yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Authentication(class).yml @@ -14,4 +14,4 @@ constructor: - keywordOnlyParameters: - name: symmetric_key - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDevice.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDevice.yml index 6d534b43..21a1ad28 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDevice.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDevice.yml @@ -78,19 +78,19 @@ constructor: - name: location isRequired: true - name: tags - isRequired: true + defaultValue: None - name: sku - isRequired: true + defaultValue: None - name: etag - isRequired: true + defaultValue: None - name: data_box_edge_device_status - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: model_description - isRequired: true + defaultValue: None - name: friendly_name - isRequired: true + defaultValue: None variables: - description: The path ID that uniquely identifies the object. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDeviceExtendedInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDeviceExtendedInfo.yml index 4bc36be8..4b92d459 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDeviceExtendedInfo.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDeviceExtendedInfo.yml @@ -29,9 +29,9 @@ constructor: - keywordOnlyParameters: - name: encryption_key_thumbprint - isRequired: true + defaultValue: None - name: encryption_key - isRequired: true + defaultValue: None variables: - description: The path ID that uniquely identifies the object. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDevicePatch.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDevicePatch.yml index ef765db9..52adbe8c 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDevicePatch.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.DataBoxEdgeDevicePatch.yml @@ -14,4 +14,4 @@ constructor: - [, ] keywordOnlyParameters: - name: tags - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.FileEventTrigger.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.FileEventTrigger.yml index 4574fa1f..d86f4c51 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.FileEventTrigger.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.FileEventTrigger.yml @@ -48,7 +48,7 @@ constructor: - name: sink_info isRequired: true - name: custom_context_tag - isRequired: true + defaultValue: None variables: - description: The path ID that uniquely identifies the object. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.IoTDeviceInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.IoTDeviceInfo.yml index cedbdc92..a75aacb1 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.IoTDeviceInfo.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.IoTDeviceInfo.yml @@ -34,4 +34,4 @@ constructor: - name: io_thost_hub isRequired: true - name: authentication - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.IoTRole.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.IoTRole.yml index 244728c1..b49f6b7c 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.IoTRole.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.IoTRole.yml @@ -66,7 +66,7 @@ constructor: - name: role_status isRequired: true - name: share_mappings - isRequired: true + defaultValue: None variables: - description: The path ID that uniquely identifies the object. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Job(class).yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Job(class).yml index 5822bcaf..00128608 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Job(class).yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Job(class).yml @@ -21,7 +21,7 @@ constructor: - keywordOnlyParameters: - name: folder - isRequired: true + defaultValue: None variables: - description: The path ID that uniquely identifies the object. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricDimensionV1.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricDimensionV1.yml index 1e9a1b04..17b4c0bd 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricDimensionV1.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricDimensionV1.yml @@ -25,8 +25,8 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: display_name - isRequired: true + defaultValue: None - name: to_be_exported_for_shoebox - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricSpecificationV1.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricSpecificationV1.yml index dba5adbc..116b5506 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricSpecificationV1.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.MetricSpecificationV1.yml @@ -83,24 +83,24 @@ constructor: - ] keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: display_name - isRequired: true + defaultValue: None - name: display_description - isRequired: true + defaultValue: None - name: unit - isRequired: true + defaultValue: None - name: aggregation_type - isRequired: true + defaultValue: None - name: dimensions - isRequired: true + defaultValue: None - name: fill_gap_with_zero - isRequired: true + defaultValue: None - name: category - isRequired: true + defaultValue: None - name: resource_id_dimension_name_override - isRequired: true + defaultValue: None - name: supported_time_grain_types - isRequired: true + defaultValue: None - name: supported_aggregation_types - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapter.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapter.yml index 5c31c313..9cbea0e8 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapter.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.NetworkAdapter.yml @@ -30,9 +30,9 @@ constructor: - keywordOnlyParameters: - name: rdma_status - isRequired: true + defaultValue: None - name: dhcp_status - isRequired: true + defaultValue: None variables: - description: Instance ID of network adapter. name: adapter_id diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Operation(class).yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Operation(class).yml index 4537f0ef..36221211 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Operation(class).yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Operation(class).yml @@ -30,10 +30,10 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: display - isRequired: true + defaultValue: None - name: origin - isRequired: true + defaultValue: None - name: service_specification - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OperationDisplay.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OperationDisplay.yml index 4b0faf08..0fa2ace4 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OperationDisplay.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OperationDisplay.yml @@ -30,10 +30,10 @@ constructor: - keywordOnlyParameters: - name: provider - isRequired: true + defaultValue: None - name: resource - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Order(class).yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Order(class).yml index f4a5f78f..ca7fd2e4 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Order(class).yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Order(class).yml @@ -36,7 +36,7 @@ constructor: - name: shipping_address isRequired: true - name: current_status - isRequired: true + defaultValue: None variables: - description: The path ID that uniquely identifies the object. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OrderStatus.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OrderStatus.yml index d3be8a8a..6c6e71a5 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OrderStatus.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.OrderStatus.yml @@ -40,7 +40,7 @@ constructor: - name: status isRequired: true - name: comments - isRequired: true + defaultValue: None variables: - description: Time of status update. name: update_date_time diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.PeriodicTimerEventTrigger.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.PeriodicTimerEventTrigger.yml index 92c6d74b..a429f500 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.PeriodicTimerEventTrigger.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.PeriodicTimerEventTrigger.yml @@ -48,7 +48,7 @@ constructor: - name: sink_info isRequired: true - name: custom_context_tag - isRequired: true + defaultValue: None variables: - description: The path ID that uniquely identifies the object. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.PeriodicTimerSourceInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.PeriodicTimerSourceInfo.yml index 763f43e6..2cbc820f 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.PeriodicTimerSourceInfo.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.PeriodicTimerSourceInfo.yml @@ -40,4 +40,4 @@ constructor: - name: schedule isRequired: true - name: topic - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RefreshDetails.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RefreshDetails.yml index 90a34f21..186216b0 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RefreshDetails.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.RefreshDetails.yml @@ -44,10 +44,10 @@ constructor: - keywordOnlyParameters: - name: in_progress_refresh_job_id - isRequired: true + defaultValue: None - name: last_completed_refresh_job_time_in_utc - isRequired: true + defaultValue: None - name: error_manifest_file - isRequired: true + defaultValue: None - name: last_job - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ServiceSpecification.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ServiceSpecification.yml index ce26837e..3d22a8cf 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ServiceSpecification.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.ServiceSpecification.yml @@ -14,4 +14,4 @@ constructor: - [] keywordOnlyParameters: - name: metric_specifications - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Share(class).yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Share(class).yml index 7b5c30f4..02532583 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Share(class).yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Share(class).yml @@ -86,17 +86,17 @@ constructor: - name: access_protocol isRequired: true - name: description - isRequired: true + defaultValue: None - name: azure_container_info - isRequired: true + defaultValue: None - name: user_access_rights - isRequired: true + defaultValue: None - name: client_access_rights - isRequired: true + defaultValue: None - name: refresh_details - isRequired: true + defaultValue: None - name: data_policy - isRequired: true + defaultValue: None variables: - description: The path ID that uniquely identifies the object. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Sku(class).yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Sku(class).yml index 4a527339..c8b33b13 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Sku(class).yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.Sku(class).yml @@ -23,6 +23,6 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: tier - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.StorageAccountCredential.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.StorageAccountCredential.yml index 6107f9d6..9608110d 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.StorageAccountCredential.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.StorageAccountCredential.yml @@ -68,13 +68,13 @@ constructor: - name: account_type isRequired: true - name: user_name - isRequired: true + defaultValue: None - name: account_key - isRequired: true + defaultValue: None - name: connection_string - isRequired: true + defaultValue: None - name: blob_domain_name - isRequired: true + defaultValue: None variables: - description: The path ID that uniquely identifies the object. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SymmetricKey.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SymmetricKey.yml index 9c9faf85..314ba5a2 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SymmetricKey.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.SymmetricKey.yml @@ -14,4 +14,4 @@ constructor: - keywordOnlyParameters: - name: connection_string - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.TrackingInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.TrackingInfo.yml index fd5bf825..a85e1890 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.TrackingInfo.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.TrackingInfo.yml @@ -30,10 +30,10 @@ constructor: - keywordOnlyParameters: - name: serial_number - isRequired: true + defaultValue: None - name: carrier_name - isRequired: true + defaultValue: None - name: tracking_id - isRequired: true + defaultValue: None - name: tracking_url - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateSummary.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateSummary.yml index 491b919c..03348caf 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateSummary.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UpdateSummary.yml @@ -44,13 +44,13 @@ constructor: - keywordOnlyParameters: - name: device_version_number - isRequired: true + defaultValue: None - name: friendly_device_version_name - isRequired: true + defaultValue: None - name: device_last_scanned_date_time - isRequired: true + defaultValue: None - name: last_completed_scan_job_date_time - isRequired: true + defaultValue: None variables: - description: The path ID that uniquely identifies the object. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UploadCertificateRequest.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UploadCertificateRequest.yml index 976b36ef..ff59a061 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UploadCertificateRequest.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UploadCertificateRequest.yml @@ -28,4 +28,4 @@ constructor: - name: certificate isRequired: true - name: authentication_type - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UploadCertificateResponse.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UploadCertificateResponse.yml index ab7f10d5..b5375cd3 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UploadCertificateResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.UploadCertificateResponse.yml @@ -72,4 +72,4 @@ constructor: - name: azure_management_endpoint_audience isRequired: true - name: auth_type - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.User(class).yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.User(class).yml index dab24907..293f664b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.User(class).yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.User(class).yml @@ -28,9 +28,9 @@ constructor: - [] keywordOnlyParameters: - name: encrypted_password - isRequired: true + defaultValue: None - name: share_access_rights - isRequired: true + defaultValue: None variables: - description: The path ID that uniquely identifies the object. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.address_py3.Address.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.address_py3.Address.yml index 074f0485..7d6fc008 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.address_py3.Address.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.address_py3.Address.yml @@ -58,6 +58,6 @@ constructor: - name: country isRequired: true - name: address_line2 - isRequired: true + defaultValue: None - name: address_line3 - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.asymmetric_encrypted_secret_py3.AsymmetricEncryptedSecret.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.asymmetric_encrypted_secret_py3.AsymmetricEncryptedSecret.yml index ca6e149e..6f7e9bc9 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.asymmetric_encrypted_secret_py3.AsymmetricEncryptedSecret.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.asymmetric_encrypted_secret_py3.AsymmetricEncryptedSecret.yml @@ -37,4 +37,4 @@ constructor: - name: encryption_algorithm isRequired: true - name: encryption_cert_thumbprint - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.authentication_py3.Authentication.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.authentication_py3.Authentication.yml index 19ec8b90..d6821c3a 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.authentication_py3.Authentication.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.authentication_py3.Authentication.yml @@ -14,4 +14,4 @@ constructor: - keywordOnlyParameters: - name: symmetric_key - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_extended_info_py3.DataBoxEdgeDeviceExtendedInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_extended_info_py3.DataBoxEdgeDeviceExtendedInfo.yml index 3e3adf3f..805c8d61 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_extended_info_py3.DataBoxEdgeDeviceExtendedInfo.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_extended_info_py3.DataBoxEdgeDeviceExtendedInfo.yml @@ -29,9 +29,9 @@ constructor: - keywordOnlyParameters: - name: encryption_key_thumbprint - isRequired: true + defaultValue: None - name: encryption_key - isRequired: true + defaultValue: None variables: - description: The path ID that uniquely identifies the object. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_patch_py3.DataBoxEdgeDevicePatch.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_patch_py3.DataBoxEdgeDevicePatch.yml index f3e016e4..21519417 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_patch_py3.DataBoxEdgeDevicePatch.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_patch_py3.DataBoxEdgeDevicePatch.yml @@ -14,4 +14,4 @@ constructor: - [, ] keywordOnlyParameters: - name: tags - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_py3.DataBoxEdgeDevice.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_py3.DataBoxEdgeDevice.yml index e68a2ca3..7bcb9112 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_py3.DataBoxEdgeDevice.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.data_box_edge_device_py3.DataBoxEdgeDevice.yml @@ -78,19 +78,19 @@ constructor: - name: location isRequired: true - name: tags - isRequired: true + defaultValue: None - name: sku - isRequired: true + defaultValue: None - name: etag - isRequired: true + defaultValue: None - name: data_box_edge_device_status - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: model_description - isRequired: true + defaultValue: None - name: friendly_name - isRequired: true + defaultValue: None variables: - description: The path ID that uniquely identifies the object. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_event_trigger_py3.FileEventTrigger.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_event_trigger_py3.FileEventTrigger.yml index ceec0b6e..8f5409d2 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_event_trigger_py3.FileEventTrigger.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.file_event_trigger_py3.FileEventTrigger.yml @@ -48,7 +48,7 @@ constructor: - name: sink_info isRequired: true - name: custom_context_tag - isRequired: true + defaultValue: None variables: - description: The path ID that uniquely identifies the object. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_tdevice_info_py3.IoTDeviceInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_tdevice_info_py3.IoTDeviceInfo.yml index 62efc215..bc6a654f 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_tdevice_info_py3.IoTDeviceInfo.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_tdevice_info_py3.IoTDeviceInfo.yml @@ -34,4 +34,4 @@ constructor: - name: io_thost_hub isRequired: true - name: authentication - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_trole_py3.IoTRole.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_trole_py3.IoTRole.yml index 5f4a84b1..e108e28f 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_trole_py3.IoTRole.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.io_trole_py3.IoTRole.yml @@ -66,7 +66,7 @@ constructor: - name: role_status isRequired: true - name: share_mappings - isRequired: true + defaultValue: None variables: - description: The path ID that uniquely identifies the object. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_py3.Job.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_py3.Job.yml index 42c51722..db4a83e8 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_py3.Job.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.job_py3.Job.yml @@ -21,7 +21,7 @@ constructor: - keywordOnlyParameters: - name: folder - isRequired: true + defaultValue: None variables: - description: The path ID that uniquely identifies the object. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_dimension_v1_py3.MetricDimensionV1.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_dimension_v1_py3.MetricDimensionV1.yml index d8354652..fb181b27 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_dimension_v1_py3.MetricDimensionV1.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_dimension_v1_py3.MetricDimensionV1.yml @@ -25,8 +25,8 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: display_name - isRequired: true + defaultValue: None - name: to_be_exported_for_shoebox - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_specification_v1_py3.MetricSpecificationV1.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_specification_v1_py3.MetricSpecificationV1.yml index f9719de6..a0b4ebcd 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_specification_v1_py3.MetricSpecificationV1.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.metric_specification_v1_py3.MetricSpecificationV1.yml @@ -83,24 +83,24 @@ constructor: - ] keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: display_name - isRequired: true + defaultValue: None - name: display_description - isRequired: true + defaultValue: None - name: unit - isRequired: true + defaultValue: None - name: aggregation_type - isRequired: true + defaultValue: None - name: dimensions - isRequired: true + defaultValue: None - name: fill_gap_with_zero - isRequired: true + defaultValue: None - name: category - isRequired: true + defaultValue: None - name: resource_id_dimension_name_override - isRequired: true + defaultValue: None - name: supported_time_grain_types - isRequired: true + defaultValue: None - name: supported_aggregation_types - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_py3.NetworkAdapter.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_py3.NetworkAdapter.yml index 83a17ca2..759e9882 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_py3.NetworkAdapter.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.network_adapter_py3.NetworkAdapter.yml @@ -30,9 +30,9 @@ constructor: - keywordOnlyParameters: - name: rdma_status - isRequired: true + defaultValue: None - name: dhcp_status - isRequired: true + defaultValue: None variables: - description: Instance ID of network adapter. name: adapter_id diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_display_py3.OperationDisplay.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_display_py3.OperationDisplay.yml index 96260331..b5d5d8ca 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_display_py3.OperationDisplay.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_display_py3.OperationDisplay.yml @@ -30,10 +30,10 @@ constructor: - keywordOnlyParameters: - name: provider - isRequired: true + defaultValue: None - name: resource - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_py3.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_py3.Operation.yml index ba4fcf06..e872c225 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_py3.Operation.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.operation_py3.Operation.yml @@ -30,10 +30,10 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: display - isRequired: true + defaultValue: None - name: origin - isRequired: true + defaultValue: None - name: service_specification - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_py3.Order.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_py3.Order.yml index bd4635b4..8ad7e864 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_py3.Order.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_py3.Order.yml @@ -36,7 +36,7 @@ constructor: - name: shipping_address isRequired: true - name: current_status - isRequired: true + defaultValue: None variables: - description: The path ID that uniquely identifies the object. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_status_py3.OrderStatus.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_status_py3.OrderStatus.yml index 9d0e69bf..305972fb 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_status_py3.OrderStatus.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.order_status_py3.OrderStatus.yml @@ -40,7 +40,7 @@ constructor: - name: status isRequired: true - name: comments - isRequired: true + defaultValue: None variables: - description: Time of status update. name: update_date_time diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_event_trigger_py3.PeriodicTimerEventTrigger.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_event_trigger_py3.PeriodicTimerEventTrigger.yml index c6352a19..ea66dbc7 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_event_trigger_py3.PeriodicTimerEventTrigger.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_event_trigger_py3.PeriodicTimerEventTrigger.yml @@ -48,7 +48,7 @@ constructor: - name: sink_info isRequired: true - name: custom_context_tag - isRequired: true + defaultValue: None variables: - description: The path ID that uniquely identifies the object. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_source_info_py3.PeriodicTimerSourceInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_source_info_py3.PeriodicTimerSourceInfo.yml index 0e8858eb..d5e4c690 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_source_info_py3.PeriodicTimerSourceInfo.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.periodic_timer_source_info_py3.PeriodicTimerSourceInfo.yml @@ -40,4 +40,4 @@ constructor: - name: schedule isRequired: true - name: topic - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.refresh_details_py3.RefreshDetails.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.refresh_details_py3.RefreshDetails.yml index 7f0d2467..274188dd 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.refresh_details_py3.RefreshDetails.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.refresh_details_py3.RefreshDetails.yml @@ -44,10 +44,10 @@ constructor: - keywordOnlyParameters: - name: in_progress_refresh_job_id - isRequired: true + defaultValue: None - name: last_completed_refresh_job_time_in_utc - isRequired: true + defaultValue: None - name: error_manifest_file - isRequired: true + defaultValue: None - name: last_job - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.service_specification_py3.ServiceSpecification.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.service_specification_py3.ServiceSpecification.yml index e10833aa..d3434373 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.service_specification_py3.ServiceSpecification.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.service_specification_py3.ServiceSpecification.yml @@ -14,4 +14,4 @@ constructor: - [] keywordOnlyParameters: - name: metric_specifications - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_py3.Share.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_py3.Share.yml index 56b59ebd..a8740eda 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_py3.Share.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.share_py3.Share.yml @@ -86,17 +86,17 @@ constructor: - name: access_protocol isRequired: true - name: description - isRequired: true + defaultValue: None - name: azure_container_info - isRequired: true + defaultValue: None - name: user_access_rights - isRequired: true + defaultValue: None - name: client_access_rights - isRequired: true + defaultValue: None - name: refresh_details - isRequired: true + defaultValue: None - name: data_policy - isRequired: true + defaultValue: None variables: - description: The path ID that uniquely identifies the object. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.sku_py3.Sku.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.sku_py3.Sku.yml index 6381cf15..1ab0d227 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.sku_py3.Sku.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.sku_py3.Sku.yml @@ -23,6 +23,6 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: tier - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential_py3.StorageAccountCredential.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential_py3.StorageAccountCredential.yml index b74e6334..dad0d607 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential_py3.StorageAccountCredential.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.storage_account_credential_py3.StorageAccountCredential.yml @@ -68,13 +68,13 @@ constructor: - name: account_type isRequired: true - name: user_name - isRequired: true + defaultValue: None - name: account_key - isRequired: true + defaultValue: None - name: connection_string - isRequired: true + defaultValue: None - name: blob_domain_name - isRequired: true + defaultValue: None variables: - description: The path ID that uniquely identifies the object. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.symmetric_key_py3.SymmetricKey.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.symmetric_key_py3.SymmetricKey.yml index 56a323a0..058a674e 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.symmetric_key_py3.SymmetricKey.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.symmetric_key_py3.SymmetricKey.yml @@ -14,4 +14,4 @@ constructor: - keywordOnlyParameters: - name: connection_string - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.tracking_info_py3.TrackingInfo.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.tracking_info_py3.TrackingInfo.yml index 246c1328..234a107a 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.tracking_info_py3.TrackingInfo.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.tracking_info_py3.TrackingInfo.yml @@ -30,10 +30,10 @@ constructor: - keywordOnlyParameters: - name: serial_number - isRequired: true + defaultValue: None - name: carrier_name - isRequired: true + defaultValue: None - name: tracking_id - isRequired: true + defaultValue: None - name: tracking_url - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_summary_py3.UpdateSummary.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_summary_py3.UpdateSummary.yml index fd782df7..1040693e 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_summary_py3.UpdateSummary.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.update_summary_py3.UpdateSummary.yml @@ -44,13 +44,13 @@ constructor: - keywordOnlyParameters: - name: device_version_number - isRequired: true + defaultValue: None - name: friendly_device_version_name - isRequired: true + defaultValue: None - name: device_last_scanned_date_time - isRequired: true + defaultValue: None - name: last_completed_scan_job_date_time - isRequired: true + defaultValue: None variables: - description: The path ID that uniquely identifies the object. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_request_py3.UploadCertificateRequest.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_request_py3.UploadCertificateRequest.yml index b159f0a8..f285dbe4 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_request_py3.UploadCertificateRequest.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_request_py3.UploadCertificateRequest.yml @@ -28,4 +28,4 @@ constructor: - name: certificate isRequired: true - name: authentication_type - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_response_py3.UploadCertificateResponse.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_response_py3.UploadCertificateResponse.yml index f40f4849..754b755c 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_response_py3.UploadCertificateResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.upload_certificate_response_py3.UploadCertificateResponse.yml @@ -72,4 +72,4 @@ constructor: - name: azure_management_endpoint_audience isRequired: true - name: auth_type - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_py3.User.yml b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_py3.User.yml index bceda2b7..7a8cd86b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_py3.User.yml +++ b/previous/docs-ref-autogen/azure-mgmt-edgegateway/azure.mgmt.edgegateway.models.user_py3.User.yml @@ -28,9 +28,9 @@ constructor: - [] keywordOnlyParameters: - name: encrypted_password - isRequired: true + defaultValue: None - name: share_access_rights - isRequired: true + defaultValue: None variables: - description: The path ID that uniquely identifies the object. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.MonitorOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.MonitorOperations.yml index bdbb177f..d4ff23f7 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.MonitorOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.MonitorOperations.yml @@ -42,7 +42,7 @@ methods: given monitor. Is either a model type or a IO type. Default value is None.' - isRequired: true + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.MonitorsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.MonitorsOperations.yml index a10a9c0c..c44289fc 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.MonitorsOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.MonitorsOperations.yml @@ -34,7 +34,7 @@ methods: - - name: body description: Is either a model type or a IO type. Default value is None. - isRequired: true + defaultValue: None types: - - @@ -275,7 +275,7 @@ methods: - - name: body description: Is either a model type or a IO type. Default value is None. - isRequired: true + defaultValue: None types: - - @@ -321,7 +321,7 @@ methods: - - name: body description: Is either a model type or a IO type. Default value is None. - isRequired: true + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SingleSignOnOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SingleSignOnOperations.yml index 2a944025..8c2ca356 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SingleSignOnOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SingleSignOnOperations.yml @@ -44,7 +44,7 @@ methods: - - name: body description: Is either a model type or a IO type. Default value is None. - isRequired: true + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SubAccountOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SubAccountOperations.yml index 4f1a3ea7..9f1e8aba 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SubAccountOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SubAccountOperations.yml @@ -44,7 +44,7 @@ methods: - - name: body description: Is either a model type or a IO type. Default value is None. - isRequired: true + defaultValue: None types: - - @@ -296,7 +296,7 @@ methods: given monitor. Is either a model type or a IO type. Default value is None.' - isRequired: true + defaultValue: None types: - - @@ -386,7 +386,7 @@ methods: - - name: body description: Is either a model type or a IO type. Default value is None. - isRequired: true + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SubAccountTagRulesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SubAccountTagRulesOperations.yml index 1bb89dc1..b4748b92 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SubAccountTagRulesOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.SubAccountTagRulesOperations.yml @@ -43,7 +43,7 @@ methods: - - name: body description: Is either a model type or a IO type. Default value is None. - isRequired: true + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.TagRulesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.TagRulesOperations.yml index eaca9d9d..7e41fe4b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.TagRulesOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.aio.operations.TagRulesOperations.yml @@ -38,7 +38,7 @@ methods: - - name: body description: Is either a model type or a IO type. Default value is None. - isRequired: true + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ErrorResponse.yml index 137e78bb..e55540df 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ErrorResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.ErrorResponse.yml @@ -10,6 +10,7 @@ constructor: keywordOnlyParameters: - name: error description: The error object. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.FilteringTag.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.FilteringTag.yml index ebdb50b1..a3baf382 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.FilteringTag.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.FilteringTag.yml @@ -11,10 +11,12 @@ constructor: keywordOnlyParameters: - name: name description: The name (also known as the key) of the tag. + defaultValue: None types: - - name: value description: The value of the tag. + defaultValue: None types: - - name: action @@ -22,6 +24,7 @@ constructor: inclusion. Known values are: "Include" and "Exclude".' + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.IdentityProperties.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.IdentityProperties.yml index adadaf56..f2ed3b9b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.IdentityProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.IdentityProperties.yml @@ -13,6 +13,7 @@ constructor: keywordOnlyParameters: - name: type description: 'Known values are: "SystemAssigned" and "UserAssigned".' + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogRules.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogRules.yml index 6c2dce11..ae1f68bb 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogRules.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogRules.yml @@ -11,18 +11,21 @@ constructor: keywordOnlyParameters: - name: send_aad_logs description: Flag specifying if AAD logs should be sent for the Monitor resource. + defaultValue: None types: - - name: send_subscription_logs description: 'Flag specifying if subscription logs should be sent for the Monitor resource.' + defaultValue: None types: - - name: send_activity_logs description: 'Flag specifying if activity logs from Azure resources should be sent for the Monitor resource.' + defaultValue: None types: - - name: filtering_tags @@ -37,6 +40,7 @@ constructor: Include actions are specified, the rules will only include resources with the associated tags.' + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResource.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResource.yml index 0a795456..f7f3b5b0 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResource.yml @@ -17,13 +17,16 @@ constructor: keywordOnlyParameters: - name: properties description: Properties specific to the monitor resource. + defaultValue: None types: - - name: identity + defaultValue: None types: - - name: tags description: Dictionary of ``. + defaultValue: None types: - [, ] - name: location diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResourceListResponse.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResourceListResponse.yml index 75ca72f2..da2d8e47 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResourceListResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResourceListResponse.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: value description: Results of a list operation. + defaultValue: None types: - [] - name: next_link description: Link to the next set of results, if any. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResourceUpdateParameters.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResourceUpdateParameters.yml index 29af3a1e..b47923ca 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResourceUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzMonitorResourceUpdateParameters.yml @@ -13,10 +13,12 @@ constructor: monitor resource.' + defaultValue: None types: - - name: tags description: The new tags of the monitor resource. + defaultValue: None types: - [, ] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzOrganizationProperties.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzOrganizationProperties.yml index fa63c0fe..51b4cba1 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzOrganizationProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzOrganizationProperties.yml @@ -13,14 +13,17 @@ constructor: keywordOnlyParameters: - name: company_name description: Name of the Logz organization. + defaultValue: None types: - - name: enterprise_app_id description: The Id of the Enterprise App used for Single sign on. + defaultValue: None types: - - name: single_sign_on_url description: The login URL specific to this Logz Organization. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnProperties.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnProperties.yml index 0f5f2a3c..e66ecbb6 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnProperties.yml @@ -16,15 +16,18 @@ constructor: description: 'Various states of the SSO resource. Known values are: "Initial", "Enable", "Disable", and "Existing".' + defaultValue: None types: - - - name: enterprise_app_id description: The Id of the Enterprise App used for Single sign-on. + defaultValue: None types: - - name: single_sign_on_url description: The login URL specific to this Logz Organization. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnResource.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnResource.yml index 48c44a62..c61bde7a 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnResource.yml @@ -12,6 +12,7 @@ constructor: | None = None, **kwargs)' keywordOnlyParameters: - name: properties + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnResourceListResponse.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnResourceListResponse.yml index ddfe13c2..2705bedd 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnResourceListResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.LogzSingleSignOnResourceListResponse.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: value description: Results of a list operation. + defaultValue: None types: - [] - name: next_link description: Link to the next set of results, if any. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitorProperties.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitorProperties.yml index dbdd5a2e..e62291e2 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitorProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitorProperties.yml @@ -34,12 +34,15 @@ constructor: - - - name: logz_organization_properties + defaultValue: None types: - - name: user_info + defaultValue: None types: - - name: plan_data + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoredResource.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoredResource.yml index eb397014..8a041adf 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoredResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoredResource.yml @@ -15,26 +15,31 @@ constructor: keywordOnlyParameters: - name: id description: The ARM id of the resource. + defaultValue: None types: - - name: sending_metrics description: Flag indicating if resource is sending metrics to Logz. + defaultValue: None types: - - name: reason_for_metrics_status description: 'Reason for why the resource is sending metrics (or why it is not sending).' + defaultValue: None types: - - name: sending_logs description: Flag indicating if resource is sending logs to Logz. + defaultValue: None types: - - name: reason_for_logs_status description: 'Reason for why the resource is sending logs (or why it is not sending).' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoredResourceListResponse.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoredResourceListResponse.yml index bc316279..0726f6b0 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoredResourceListResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoredResourceListResponse.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: value description: Results of a list operation. + defaultValue: None types: - [] - name: next_link description: Link to the next set of results, if any. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRules.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRules.yml index b321d86e..aec58e72 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRules.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRules.yml @@ -13,6 +13,7 @@ constructor: keywordOnlyParameters: - name: properties description: Definition of the properties for a TagRules resource. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRulesListResponse.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRulesListResponse.yml index 7c71a71b..645531ef 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRulesListResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRulesListResponse.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: value description: Results of a list operation. + defaultValue: None types: - [] - name: next_link description: Link to the next set of results, if any. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRulesProperties.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRulesProperties.yml index 4f2f305e..203d648d 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRulesProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.MonitoringTagRulesProperties.yml @@ -13,6 +13,7 @@ constructor: keywordOnlyParameters: - name: log_rules description: Set of rules for sending logs for the Monitor resource. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationDisplay.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationDisplay.yml index 7ca11392..b9656468 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationDisplay.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationDisplay.yml @@ -10,18 +10,22 @@ constructor: keywordOnlyParameters: - name: provider description: Service provider, i.e., Microsoft.Logz. + defaultValue: None types: - - name: resource description: Type on which the operation is performed, e.g., 'monitors'. + defaultValue: None types: - - name: operation description: Operation type, e.g., read, write, delete, etc. + defaultValue: None types: - - name: description description: Description of the operation, e.g., 'Write monitors'. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationListResult.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationListResult.yml index cef0d6aa..8593da16 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationListResult.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: value description: List of operations supported by the Microsoft.Logz provider. + defaultValue: None types: - [] - name: next_link description: URL to get the next set of operation list results if there are any. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationResult.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationResult.yml index 079aa272..cc4da65b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.OperationResult.yml @@ -11,18 +11,22 @@ constructor: keywordOnlyParameters: - name: name description: Operation name, i.e., {provider}/{resource}/{operation}. + defaultValue: None types: - - name: is_data_action description: Indicates whether the operation is a data action. + defaultValue: None types: - - name: display description: The object that represents the operation. + defaultValue: None types: - - name: origin description: Origin of the operation. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.PlanData.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.PlanData.yml index ea5aa89e..c5da873f 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.PlanData.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.PlanData.yml @@ -11,18 +11,22 @@ constructor: keywordOnlyParameters: - name: usage_type description: different usage type like PAYG/COMMITTED. this could be enum. + defaultValue: None types: - - name: billing_cycle description: different billing cycles like MONTHLY/WEEKLY. this could be enum. + defaultValue: None types: - - name: plan_details description: plan id as published by Logz. + defaultValue: None types: - - name: effective_date description: date when plan was applied. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.SystemData.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.SystemData.yml index 5443e3d5..93ea1bf5 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.SystemData.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.SystemData.yml @@ -12,32 +12,38 @@ constructor: keywordOnlyParameters: - name: created_by description: The identity that created the resource. + defaultValue: None types: - - name: created_by_type description: 'The type of identity that created the resource. Known values are: "User", "Application", "ManagedIdentity", and "Key".' + defaultValue: None types: - - - name: created_at description: The timestamp of resource creation (UTC). + defaultValue: None types: - - name: last_modified_by description: The identity that last modified the resource. + defaultValue: None types: - - name: last_modified_by_type description: 'The type of identity that last modified the resource. Known values are: "User", "Application", "ManagedIdentity", and "Key".' + defaultValue: None types: - - - name: last_modified_at description: The timestamp of resource last modification (UTC). + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserInfo.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserInfo.yml index 1e248a40..7e9021cf 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserInfo.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserInfo.yml @@ -10,18 +10,22 @@ constructor: keywordOnlyParameters: - name: first_name description: First Name of the user. + defaultValue: None types: - - name: last_name description: Last Name of the user. + defaultValue: None types: - - name: email_address description: Email of the user used by Logz for contacting them if needed. + defaultValue: None types: - - name: phone_number description: Phone number of the user used by Logz for contacting them if needed. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleListResponse.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleListResponse.yml index b011fec9..264e31b8 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleListResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleListResponse.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: value description: List of user roles for Logz.io account. + defaultValue: None types: - [] - name: next_link description: Link to the next set of results, if any. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleRequest.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleRequest.yml index 7332571e..a78f8272 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleRequest.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleRequest.yml @@ -9,6 +9,7 @@ constructor: keywordOnlyParameters: - name: email_address description: Email of the user used by Logz for contacting them if needed. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleResponse.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleResponse.yml index 6bc3e347..10755557 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.UserRoleResponse.yml @@ -12,6 +12,7 @@ constructor: "User", and "Admin".' + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMExtensionPayload.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMExtensionPayload.yml index ca1c4e20..2c950b91 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMExtensionPayload.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMExtensionPayload.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: api_key description: API Key corresponding to the resource. + defaultValue: None types: - - name: region description: Logz.io region where the resource has been created. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMHostUpdateRequest.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMHostUpdateRequest.yml index 96fad21f..7ec8af0f 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMHostUpdateRequest.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMHostUpdateRequest.yml @@ -10,6 +10,7 @@ constructor: keywordOnlyParameters: - name: vm_resource_ids description: Request of a list vm host update operation. + defaultValue: None types: - [] - name: state @@ -17,6 +18,7 @@ constructor: are: "Install" and "Delete".' + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMResources.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMResources.yml index 2b64c511..48afd996 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMResources.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMResources.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: id description: Request of a list vm host update operation. + defaultValue: None types: - - name: agent_version description: Version of the Logz agent installed on the VM. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMResourcesListResponse.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMResourcesListResponse.yml index f6f1b198..ce4a3230 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMResourcesListResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.models.VMResourcesListResponse.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: value description: Response of a list vm host update operation. + defaultValue: None types: - [] - name: next_link description: Link to the next set of results, if any. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.MonitorOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.MonitorOperations.yml index be0a243e..1811e2d5 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.MonitorOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.MonitorOperations.yml @@ -42,7 +42,7 @@ methods: given monitor. Is either a model type or a IO type. Default value is None.' - isRequired: true + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.MonitorsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.MonitorsOperations.yml index 2c67b89b..6168bb2e 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.MonitorsOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.MonitorsOperations.yml @@ -34,7 +34,7 @@ methods: - - name: body description: Is either a model type or a IO type. Default value is None. - isRequired: true + defaultValue: None types: - - @@ -274,7 +274,7 @@ methods: - - name: body description: Is either a model type or a IO type. Default value is None. - isRequired: true + defaultValue: None types: - - @@ -320,7 +320,7 @@ methods: - - name: body description: Is either a model type or a IO type. Default value is None. - isRequired: true + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SingleSignOnOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SingleSignOnOperations.yml index 2ade4ef4..0e1c2c1e 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SingleSignOnOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SingleSignOnOperations.yml @@ -44,7 +44,7 @@ methods: - - name: body description: Is either a model type or a IO type. Default value is None. - isRequired: true + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SubAccountOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SubAccountOperations.yml index a67515cc..2493b6b3 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SubAccountOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SubAccountOperations.yml @@ -44,7 +44,7 @@ methods: - - name: body description: Is either a model type or a IO type. Default value is None. - isRequired: true + defaultValue: None types: - - @@ -296,7 +296,7 @@ methods: given monitor. Is either a model type or a IO type. Default value is None.' - isRequired: true + defaultValue: None types: - - @@ -386,7 +386,7 @@ methods: - - name: body description: Is either a model type or a IO type. Default value is None. - isRequired: true + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SubAccountTagRulesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SubAccountTagRulesOperations.yml index f61311b2..ae1ae356 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SubAccountTagRulesOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.SubAccountTagRulesOperations.yml @@ -43,7 +43,7 @@ methods: - - name: body description: Is either a model type or a IO type. Default value is None. - isRequired: true + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.TagRulesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.TagRulesOperations.yml index 7607c138..7a05deca 100644 --- a/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.TagRulesOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-logz/azure.mgmt.logz.operations.TagRulesOperations.yml @@ -38,7 +38,7 @@ methods: - - name: body description: Is either a model type or a IO type. Default value is None. - isRequired: true + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProduct.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProduct.yml index fed7c0d6..c19e797c 100644 --- a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProduct.yml +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProduct.yml @@ -17,6 +17,7 @@ constructor: keywordOnlyParameters: - name: tags description: Resource tags. + defaultValue: None types: - [, ] - name: location @@ -25,10 +26,12 @@ constructor: - - name: properties description: The resource-specific properties for this resource. + defaultValue: None types: - - name: identity description: The managed service identities assigned to this resource. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductListResult.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductListResult.yml index 3b51c80a..4c4f1439 100644 --- a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductListResult.yml @@ -17,6 +17,7 @@ constructor: - [] - name: next_link description: The link to the next page of items. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductProperties.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductProperties.yml index db512a70..67bba8e7 100644 --- a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductProperties.yml @@ -35,6 +35,7 @@ constructor: - - name: owners description: List of name or email associated with data product resource deployment. + defaultValue: None types: - [] - name: redundancy @@ -42,21 +43,25 @@ constructor: are: "Enabled" and "Disabled".' + defaultValue: None types: - - - name: purview_account description: Purview account url for data product to connect to. + defaultValue: None types: - - name: purview_collection description: Purview collection url for data product to connect to. + defaultValue: None types: - - name: private_links_enabled description: 'Flag to enable or disable private link for data product resource. Known values are: "Enabled" and "Disabled".' + defaultValue: None types: - - @@ -64,6 +69,7 @@ constructor: description: 'Flag to enable or disable public access of data product resource. Known values are: "Enabled" and "Disabled".' + defaultValue: None types: - - @@ -71,23 +77,28 @@ constructor: description: 'Flag to enable customer managed key encryption for data product. Known values are: "Enabled" and "Disabled".' + defaultValue: None types: - - - name: customer_encryption_key description: Customer managed encryption key details for data product. + defaultValue: None types: - - name: networkacls description: Network rule set for data product. + defaultValue: None types: - - name: managed_resource_group_configuration description: Managed resource group configuration. + defaultValue: None types: - - name: current_minor_version description: Current configured minor version of the data product resource. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductUpdate.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductUpdate.yml index ee9173cc..f60f6a8b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductUpdate.yml +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductUpdate.yml @@ -11,14 +11,17 @@ constructor: keywordOnlyParameters: - name: identity description: The managed service identities assigned to this resource. + defaultValue: None types: - - name: tags description: Resource tags. + defaultValue: None types: - [, ] - name: properties description: The updatable properties of the DataProduct. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductUpdateProperties.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductUpdateProperties.yml index 734467c9..43928bca 100644 --- a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductUpdateProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductUpdateProperties.yml @@ -12,25 +12,30 @@ constructor: keywordOnlyParameters: - name: owners description: List of name or email associated with data product resource deployment. + defaultValue: None types: - [] - name: purview_account description: Purview account url for data product to connect to. + defaultValue: None types: - - name: purview_collection description: Purview collection url for data product to connect to. + defaultValue: None types: - - name: private_links_enabled description: 'Flag to enable or disable private link for data product resource. Known values are: "Enabled" and "Disabled".' + defaultValue: None types: - - - name: current_minor_version description: Current configured minor version of the data product resource. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductsCatalog.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductsCatalog.yml index b98c18ea..9aae5e34 100644 --- a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductsCatalog.yml +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductsCatalog.yml @@ -13,6 +13,7 @@ constructor: keywordOnlyParameters: - name: properties description: The resource-specific properties for this resource. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductsCatalogListResult.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductsCatalogListResult.yml index d6efe545..52989b34 100644 --- a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductsCatalogListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataProductsCatalogListResult.yml @@ -17,6 +17,7 @@ constructor: - [] - name: next_link description: The link to the next page of items. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataType.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataType.yml index 80d0e60a..dcb17134 100644 --- a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataType.yml +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataType.yml @@ -13,6 +13,7 @@ constructor: keywordOnlyParameters: - name: properties description: The resource-specific properties for this resource. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeListResult.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeListResult.yml index 6945483a..ae3781db 100644 --- a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeListResult.yml @@ -17,6 +17,7 @@ constructor: - [] - name: next_link description: The link to the next page of items. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeProperties.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeProperties.yml index 02f5828a..7cd28ae0 100644 --- a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeProperties.yml @@ -14,19 +14,23 @@ constructor: keywordOnlyParameters: - name: state description: 'State of data type. Known values are: "Stopped" and "Running".' + defaultValue: None types: - - - name: storage_output_retention description: Field for storage output retention in days. + defaultValue: None types: - - name: database_cache_retention description: Field for database cache retention in days. + defaultValue: None types: - - name: database_retention description: Field for database data retention in days. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeUpdate.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeUpdate.yml index 05d0afb9..f9fab425 100644 --- a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeUpdate.yml +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeUpdate.yml @@ -10,6 +10,7 @@ constructor: keywordOnlyParameters: - name: properties description: The updatable properties of the DataType. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeUpdateProperties.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeUpdateProperties.yml index ff3a23af..2e604265 100644 --- a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeUpdateProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.DataTypeUpdateProperties.yml @@ -11,19 +11,23 @@ constructor: keywordOnlyParameters: - name: state description: 'State of data type. Known values are: "Stopped" and "Running".' + defaultValue: None types: - - - name: storage_output_retention description: Field for storage output retention in days. + defaultValue: None types: - - name: database_cache_retention description: Field for database cache retention in days. + defaultValue: None types: - - name: database_retention description: Field for database data retention in days. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ErrorResponse.yml index dc7f3f06..0c94e66b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ErrorResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ErrorResponse.yml @@ -12,6 +12,7 @@ constructor: keywordOnlyParameters: - name: error description: The error object. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.IPRules.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.IPRules.yml index 7d02a185..8934370d 100644 --- a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.IPRules.yml +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.IPRules.yml @@ -12,6 +12,7 @@ constructor: keywordOnlyParameters: - name: value description: IP Rules Value. + defaultValue: None types: - - name: action diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ManagedServiceIdentity.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ManagedServiceIdentity.yml index e983605a..6ec59fa3 100644 --- a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ManagedServiceIdentity.yml +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.ManagedServiceIdentity.yml @@ -35,6 +35,7 @@ constructor: ''/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.' + defaultValue: None types: - [, ] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Operation.yml index 95810d01..62ddd6b5 100644 --- a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Operation.yml +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.Operation.yml @@ -14,6 +14,7 @@ constructor: keywordOnlyParameters: - name: display description: Localized display information for this particular operation. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.SystemData.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.SystemData.yml index 004a5d35..9170eb26 100644 --- a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.SystemData.yml +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.SystemData.yml @@ -12,32 +12,38 @@ constructor: keywordOnlyParameters: - name: created_by description: The identity that created the resource. + defaultValue: None types: - - name: created_by_type description: 'The type of identity that created the resource. Known values are: "User", "Application", "ManagedIdentity", and "Key".' + defaultValue: None types: - - - name: created_at description: The timestamp of resource creation (UTC). + defaultValue: None types: - - name: last_modified_by description: The identity that last modified the resource. + defaultValue: None types: - - name: last_modified_by_type description: 'The type of identity that last modified the resource. Known values are: "User", "Application", "ManagedIdentity", and "Key".' + defaultValue: None types: - - - name: last_modified_at description: The timestamp of resource last modification (UTC). + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.TrackedResource.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.TrackedResource.yml index 9fced5a6..8ff96cfa 100644 --- a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.TrackedResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.TrackedResource.yml @@ -19,6 +19,7 @@ constructor: keywordOnlyParameters: - name: tags description: Resource tags. + defaultValue: None types: - [, ] - name: location diff --git a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.VirtualNetworkRule.yml b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.VirtualNetworkRule.yml index 1cf07156..50682a3e 100644 --- a/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.VirtualNetworkRule.yml +++ b/previous/docs-ref-autogen/azure-mgmt-networkanalytics/azure.mgmt.networkanalytics.models.VirtualNetworkRule.yml @@ -17,10 +17,12 @@ constructor: - - name: action description: The action of virtual network rule. + defaultValue: None types: - - name: state description: Gets the state of virtual network rule. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CheckNameRequest.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CheckNameRequest.yml index 21dc07ac..b319698b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CheckNameRequest.yml +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CheckNameRequest.yml @@ -10,6 +10,7 @@ constructor: keywordOnlyParameters: - name: name description: Workspace collection name. + defaultValue: None types: - - name: type diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CheckNameResponse.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CheckNameResponse.yml index 3f5e0175..0768f2f6 100644 --- a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CheckNameResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CheckNameResponse.yml @@ -12,6 +12,7 @@ constructor: description: 'Specifies a Boolean value that indicates whether the specified Power BI Workspace Collection name is available to use.' + defaultValue: None types: - - name: reason @@ -19,6 +20,7 @@ constructor: are: "Unavailable" and "Invalid".' + defaultValue: None types: - - @@ -27,6 +29,7 @@ constructor: of the naming rules that are violated.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CreateWorkspaceCollectionRequest.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CreateWorkspaceCollectionRequest.yml index dc280308..0cb8704b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CreateWorkspaceCollectionRequest.yml +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.CreateWorkspaceCollectionRequest.yml @@ -10,13 +10,16 @@ constructor: keywordOnlyParameters: - name: location description: Azure location. + defaultValue: None types: - - name: tags description: Dictionary of ``. + defaultValue: None types: - [, ] - name: sku + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Display.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Display.yml index f6b97225..4ba3acd5 100644 --- a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Display.yml +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Display.yml @@ -17,6 +17,7 @@ constructor: with "Microsoft" for 1st party services.' + defaultValue: None types: - - name: resource @@ -26,6 +27,7 @@ constructor: provider. Use Title Casing. For examples, refer to the "name" section.' + defaultValue: None types: - - name: operation @@ -36,6 +38,7 @@ constructor: Use Title Casing and include the entity/resource to which it applies.' + defaultValue: None types: - - name: description @@ -46,6 +49,7 @@ constructor: and detailed views.' + defaultValue: None types: - - name: origin @@ -53,6 +57,7 @@ constructor: operation in the RBAC UX and the audit logs UX. Default value is ''user,system''.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Error.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Error.yml index 80510021..08c7cc7d 100644 --- a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Error.yml +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Error.yml @@ -9,15 +9,19 @@ constructor: | None = None, details: List[_models.ErrorDetail] | None = None, **kwargs: Any)' keywordOnlyParameters: - name: code + defaultValue: None types: - - name: message + defaultValue: None types: - - name: target + defaultValue: None types: - - name: details + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.ErrorDetail.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.ErrorDetail.yml index 5481d2e1..551ea54b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.ErrorDetail.yml +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.ErrorDetail.yml @@ -9,12 +9,15 @@ constructor: str | None = None, **kwargs: Any)' keywordOnlyParameters: - name: code + defaultValue: None types: - - name: message + defaultValue: None types: - - name: target + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.MigrateWorkspaceCollectionRequest.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.MigrateWorkspaceCollectionRequest.yml index f4fa3483..42073f0e 100644 --- a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.MigrateWorkspaceCollectionRequest.yml +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.MigrateWorkspaceCollectionRequest.yml @@ -12,9 +12,11 @@ constructor: description: 'Name of the resource group the Power BI workspace collections will be migrated to.' + defaultValue: None types: - - name: resources + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Operation.yml index 157d101f..d0c48a09 100644 --- a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Operation.yml +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Operation.yml @@ -13,9 +13,11 @@ constructor: This name should match the action name that appears in RBAC / the event service.' + defaultValue: None types: - - name: display + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.OperationList.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.OperationList.yml index c89cfca4..54d7a944 100644 --- a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.OperationList.yml +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.OperationList.yml @@ -9,6 +9,7 @@ constructor: Any)' keywordOnlyParameters: - name: value + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.UpdateWorkspaceCollectionRequest.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.UpdateWorkspaceCollectionRequest.yml index baa793e2..712dde51 100644 --- a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.UpdateWorkspaceCollectionRequest.yml +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.UpdateWorkspaceCollectionRequest.yml @@ -10,9 +10,11 @@ constructor: keywordOnlyParameters: - name: tags description: Dictionary of ``. + defaultValue: None types: - [, ] - name: sku + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Workspace.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Workspace.yml index 78dfb759..6aea124e 100644 --- a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Workspace.yml +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.Workspace.yml @@ -10,18 +10,22 @@ constructor: keywordOnlyParameters: - name: id description: Workspace id. + defaultValue: None types: - - name: name description: Workspace name. + defaultValue: None types: - - name: type description: Resource type. + defaultValue: None types: - - name: properties description: Property bag. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollection.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollection.yml index 071d2dd3..ac2e08ab 100644 --- a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollection.yml +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollection.yml @@ -12,29 +12,36 @@ constructor: keywordOnlyParameters: - name: id description: Resource id. + defaultValue: None types: - - name: name description: Workspace collection name. + defaultValue: None types: - - name: type description: Resource type. + defaultValue: None types: - - name: location description: Azure location. + defaultValue: None types: - - name: tags description: Dictionary of ``. + defaultValue: None types: - [, ] - name: sku + defaultValue: None types: - - name: properties description: Properties. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKey.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKey.yml index 103f1e0d..89856471 100644 --- a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKey.yml +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKey.yml @@ -10,6 +10,7 @@ constructor: keywordOnlyParameters: - name: key_name description: 'Key name. Known values are: "key1" and "key2".' + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKeys.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKeys.yml index c8ffd33c..45f5dec1 100644 --- a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKeys.yml +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionAccessKeys.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: key1 description: Access key 1. + defaultValue: None types: - - name: key2 description: Access key 2. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionList.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionList.yml index d5d541c6..1a9586f2 100644 --- a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionList.yml +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceCollectionList.yml @@ -9,6 +9,7 @@ constructor: = None, **kwargs: Any)' keywordOnlyParameters: - name: value + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceList.yml b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceList.yml index 6e127e85..9c37cdc5 100644 --- a/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceList.yml +++ b/previous/docs-ref-autogen/azure-mgmt-powerbiembedded/azure.mgmt.powerbiembedded.models.WorkspaceList.yml @@ -9,6 +9,7 @@ constructor: Any)' keywordOnlyParameters: - name: value + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.BasicAuthentication.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.BasicAuthentication.yml index 567d7c87..3b5d77f2 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.BasicAuthentication.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.BasicAuthentication.yml @@ -33,6 +33,6 @@ constructor: - keywordOnlyParameters: - name: username - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ClientCertAuthentication.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ClientCertAuthentication.yml index ef644dcf..01f000cc 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ClientCertAuthentication.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ClientCertAuthentication.yml @@ -53,12 +53,12 @@ constructor: - keywordOnlyParameters: - name: password - isRequired: true + defaultValue: None - name: pfx - isRequired: true + defaultValue: None - name: certificate_thumbprint - isRequired: true + defaultValue: None - name: certificate_expiration_date - isRequired: true + defaultValue: None - name: certificate_subject_name - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.HttpRequest.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.HttpRequest.yml index 12e7cb4f..cee89963 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.HttpRequest.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.HttpRequest.yml @@ -36,12 +36,12 @@ constructor: - [, ] keywordOnlyParameters: - name: authentication - isRequired: true + defaultValue: None - name: uri - isRequired: true + defaultValue: None - name: method - isRequired: true + defaultValue: None - name: body - isRequired: true + defaultValue: None - name: headers - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobAction.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobAction.yml index 02f84663..69d95779 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobAction.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobAction.yml @@ -52,16 +52,16 @@ constructor: - keywordOnlyParameters: - name: type - isRequired: true + defaultValue: None - name: request - isRequired: true + defaultValue: None - name: queue_message - isRequired: true + defaultValue: None - name: service_bus_queue_message - isRequired: true + defaultValue: None - name: service_bus_topic_message - isRequired: true + defaultValue: None - name: retry_policy - isRequired: true + defaultValue: None - name: error_action - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionDefinition.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionDefinition.yml index e784960a..2264773b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionDefinition.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionDefinition.yml @@ -34,13 +34,13 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: location - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: properties - isRequired: true + defaultValue: None variables: - description: Gets the job collection resource identifier. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionListResult.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionListResult.yml index 46136110..b3fb90c8 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionListResult.yml @@ -17,7 +17,7 @@ constructor: - keywordOnlyParameters: - name: next_link - isRequired: true + defaultValue: None variables: - description: Gets the job collections. name: value diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionProperties.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionProperties.yml index e7f26fd9..b5384e0e 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionProperties.yml @@ -28,8 +28,8 @@ constructor: - keywordOnlyParameters: - name: sku - isRequired: true + defaultValue: None - name: state - isRequired: true + defaultValue: None - name: quota - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionQuota.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionQuota.yml index f24c4d7f..e517987d 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionQuota.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobCollectionQuota.yml @@ -25,8 +25,8 @@ constructor: - keywordOnlyParameters: - name: max_job_count - isRequired: true + defaultValue: None - name: max_job_occurrence - isRequired: true + defaultValue: None - name: max_recurrence - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobDefinition.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobDefinition.yml index de9aea47..dc24512e 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobDefinition.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobDefinition.yml @@ -17,7 +17,7 @@ constructor: - keywordOnlyParameters: - name: properties - isRequired: true + defaultValue: None variables: - description: Gets the job resource identifier. name: id diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobErrorAction.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobErrorAction.yml index cb99acaf..3366a55d 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobErrorAction.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobErrorAction.yml @@ -46,14 +46,14 @@ constructor: - keywordOnlyParameters: - name: type - isRequired: true + defaultValue: None - name: request - isRequired: true + defaultValue: None - name: queue_message - isRequired: true + defaultValue: None - name: service_bus_queue_message - isRequired: true + defaultValue: None - name: service_bus_topic_message - isRequired: true + defaultValue: None - name: retry_policy - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryFilter.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryFilter.yml index 357c4e0e..16e049e7 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryFilter.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryFilter.yml @@ -18,4 +18,4 @@ constructor: - keywordOnlyParameters: - name: status - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryListResult.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryListResult.yml index ab904a42..ea7b65e2 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobHistoryListResult.yml @@ -20,6 +20,6 @@ constructor: - keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: next_link - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobListResult.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobListResult.yml index 6f3d6be6..5368dbbc 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobListResult.yml @@ -20,6 +20,6 @@ constructor: - keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: next_link - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobMaxRecurrence.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobMaxRecurrence.yml index a205666b..42d20c7c 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobMaxRecurrence.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobMaxRecurrence.yml @@ -24,6 +24,6 @@ constructor: - keywordOnlyParameters: - name: frequency - isRequired: true + defaultValue: None - name: interval - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobProperties.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobProperties.yml index 2d3939bb..430d8a05 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobProperties.yml @@ -37,13 +37,13 @@ constructor: - keywordOnlyParameters: - name: start_time - isRequired: true + defaultValue: None - name: action - isRequired: true + defaultValue: None - name: recurrence - isRequired: true + defaultValue: None - name: state - isRequired: true + defaultValue: None variables: - description: Gets the job status. name: status diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrence.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrence.yml index 16148c08..262155fd 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrence.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrence.yml @@ -39,12 +39,12 @@ constructor: - keywordOnlyParameters: - name: frequency - isRequired: true + defaultValue: None - name: interval - isRequired: true + defaultValue: None - name: count - isRequired: true + defaultValue: None - name: end_time - isRequired: true + defaultValue: None - name: schedule - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrenceSchedule.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrenceSchedule.yml index 249deb3d..36235437 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrenceSchedule.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrenceSchedule.yml @@ -42,12 +42,12 @@ constructor: - [] keywordOnlyParameters: - name: week_days - isRequired: true + defaultValue: None - name: hours - isRequired: true + defaultValue: None - name: minutes - isRequired: true + defaultValue: None - name: month_days - isRequired: true + defaultValue: None - name: monthly_occurrences - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrenceScheduleMonthlyOccurrence.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrenceScheduleMonthlyOccurrence.yml index 6b3bcd02..0a7fff0f 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrenceScheduleMonthlyOccurrence.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobRecurrenceScheduleMonthlyOccurrence.yml @@ -27,6 +27,6 @@ constructor: - keywordOnlyParameters: - name: day - isRequired: true + defaultValue: None - name: occurrence - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobStateFilter.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobStateFilter.yml index d0df5f3a..12aa2874 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobStateFilter.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.JobStateFilter.yml @@ -18,4 +18,4 @@ constructor: - keywordOnlyParameters: - name: state - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.OAuthAuthentication.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.OAuthAuthentication.yml index 05b9cefd..f4303b56 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.OAuthAuthentication.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.OAuthAuthentication.yml @@ -43,10 +43,10 @@ constructor: - keywordOnlyParameters: - name: secret - isRequired: true + defaultValue: None - name: tenant - isRequired: true + defaultValue: None - name: audience - isRequired: true + defaultValue: None - name: client_id - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.RetryPolicy.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.RetryPolicy.yml index 66c81ae6..56fcc5b3 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.RetryPolicy.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.RetryPolicy.yml @@ -32,8 +32,8 @@ constructor: - keywordOnlyParameters: - name: retry_type - isRequired: true + defaultValue: None - name: retry_interval - isRequired: true + defaultValue: None - name: retry_count - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusAuthentication.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusAuthentication.yml index bbc6d187..00970baa 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusAuthentication.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusAuthentication.yml @@ -28,8 +28,8 @@ constructor: - keywordOnlyParameters: - name: sas_key - isRequired: true + defaultValue: None - name: sas_key_name - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusBrokeredMessageProperties.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusBrokeredMessageProperties.yml index 065389a7..1026dd20 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusBrokeredMessageProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusBrokeredMessageProperties.yml @@ -79,28 +79,28 @@ constructor: - keywordOnlyParameters: - name: content_type - isRequired: true + defaultValue: None - name: correlation_id - isRequired: true + defaultValue: None - name: force_persistence - isRequired: true + defaultValue: None - name: label - isRequired: true + defaultValue: None - name: message_id - isRequired: true + defaultValue: None - name: partition_key - isRequired: true + defaultValue: None - name: reply_to - isRequired: true + defaultValue: None - name: reply_to_session_id - isRequired: true + defaultValue: None - name: scheduled_enqueue_time_utc - isRequired: true + defaultValue: None - name: session_id - isRequired: true + defaultValue: None - name: time_to_live - isRequired: true + defaultValue: None - name: to - isRequired: true + defaultValue: None - name: via_partition_key - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusMessage.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusMessage.yml index b5d3b7a2..c9b665b8 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusMessage.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusMessage.yml @@ -46,14 +46,14 @@ constructor: - keywordOnlyParameters: - name: authentication - isRequired: true + defaultValue: None - name: brokered_message_properties - isRequired: true + defaultValue: None - name: custom_message_properties - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None - name: namespace - isRequired: true + defaultValue: None - name: transport_type - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusQueueMessage.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusQueueMessage.yml index 7141716d..0f30373f 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusQueueMessage.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusQueueMessage.yml @@ -51,16 +51,16 @@ constructor: - keywordOnlyParameters: - name: authentication - isRequired: true + defaultValue: None - name: brokered_message_properties - isRequired: true + defaultValue: None - name: custom_message_properties - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None - name: namespace - isRequired: true + defaultValue: None - name: transport_type - isRequired: true + defaultValue: None - name: queue_name - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusTopicMessage.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusTopicMessage.yml index a587e4d7..d881dc13 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusTopicMessage.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.ServiceBusTopicMessage.yml @@ -51,16 +51,16 @@ constructor: - keywordOnlyParameters: - name: authentication - isRequired: true + defaultValue: None - name: brokered_message_properties - isRequired: true + defaultValue: None - name: custom_message_properties - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None - name: namespace - isRequired: true + defaultValue: None - name: transport_type - isRequired: true + defaultValue: None - name: topic_path - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.Sku.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.Sku.yml index 0ca04c2e..037302fb 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.Sku.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.Sku.yml @@ -18,4 +18,4 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.StorageQueueMessage.yml b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.StorageQueueMessage.yml index 623f3be7..014eea01 100644 --- a/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.StorageQueueMessage.yml +++ b/previous/docs-ref-autogen/azure-mgmt-scheduler/azure.mgmt.scheduler.models.StorageQueueMessage.yml @@ -30,10 +30,10 @@ constructor: - keywordOnlyParameters: - name: storage_account - isRequired: true + defaultValue: None - name: queue_name - isRequired: true + defaultValue: None - name: sas_token - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.JobsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.JobsOperations.yml index 94e9df1d..7e9f32a8 100644 --- a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.JobsOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.aio.operations.JobsOperations.yml @@ -40,7 +40,7 @@ methods: - name: client_tenant_id description: The tenant ID of the client making the request. Default value is None. - isRequired: true + defaultValue: None types: - keywordOnlyParameters: @@ -137,7 +137,7 @@ methods: returned. The value cannot exceed 100. Default value is None.' - isRequired: true + defaultValue: None types: - - name: filter @@ -145,7 +145,7 @@ methods: value is None.' - isRequired: true + defaultValue: None types: - keywordOnlyParameters: @@ -171,7 +171,7 @@ methods: returned. The value cannot exceed 100. Default value is None.' - isRequired: true + defaultValue: None types: - - name: filter @@ -179,7 +179,7 @@ methods: value is None.' - isRequired: true + defaultValue: None types: - keywordOnlyParameters: diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DeliveryPackageInformation.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DeliveryPackageInformation.yml index a4fb1655..fbeda3f0 100644 --- a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DeliveryPackageInformation.yml +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DeliveryPackageInformation.yml @@ -24,10 +24,12 @@ constructor: - - name: drive_count description: The number of drives included in the package. + defaultValue: None types: - - name: ship_date description: The date when the package is shipped. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DriveBitLockerKey.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DriveBitLockerKey.yml index 80f595d4..39047e45 100644 --- a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DriveBitLockerKey.yml +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DriveBitLockerKey.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: bit_locker_key description: BitLocker recovery key or password. + defaultValue: None types: - - name: drive_id description: Drive ID. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DriveStatus.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DriveStatus.yml index 5cef2d89..6d0dd1a3 100644 --- a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DriveStatus.yml +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.DriveStatus.yml @@ -14,22 +14,27 @@ constructor: keywordOnlyParameters: - name: drive_id description: The drive's hardware serial number, without spaces. + defaultValue: None types: - - name: bit_locker_key description: The BitLocker key used to encrypt the drive. + defaultValue: None types: - - name: manifest_file description: The relative path of the manifest file on the drive. + defaultValue: None types: - - name: manifest_hash description: The Base16-encoded MD5 hash of the manifest file on the drive. + defaultValue: None types: - - name: drive_header_hash description: The drive header hash value. + defaultValue: None types: - - name: state @@ -44,10 +49,12 @@ constructor: description: 'Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state.' + defaultValue: None types: - - name: percent_complete description: Percentage completed for the drive. + defaultValue: None types: - - name: verbose_log_uri @@ -55,20 +62,24 @@ constructor: data transfer operation.' + defaultValue: None types: - - name: error_log_uri description: 'A URI that points to the blob containing the error log for the data transfer operation.' + defaultValue: None types: - - name: manifest_uri description: A URI that points to the blob containing the drive manifest file. + defaultValue: None types: - - name: bytes_succeeded description: Bytes successfully transferred for the drive. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.EncryptionKeyDetails.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.EncryptionKeyDetails.yml index bb6278fa..8fcabd9f 100644 --- a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.EncryptionKeyDetails.yml +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.EncryptionKeyDetails.yml @@ -19,10 +19,12 @@ constructor: - - name: kek_url description: Specifies the url for kek encryption key. + defaultValue: None types: - - name: kek_vault_resource_id description: Specifies the keyvault resource id for kek encryption key. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ErrorResponse.yml index 731ee1d6..ed294f0f 100644 --- a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ErrorResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ErrorResponse.yml @@ -11,22 +11,27 @@ constructor: keywordOnlyParameters: - name: code description: Provides information about the error code. + defaultValue: None types: - - name: message description: Provides information about the error message. + defaultValue: None types: - - name: target description: Provides information about the error target. + defaultValue: None types: - - name: details description: Describes the error details if present. + defaultValue: None types: - [] - name: innererror description: Inner error object if present. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ErrorResponseErrorDetailsItem.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ErrorResponseErrorDetailsItem.yml index 20807e7c..d5c35b58 100644 --- a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ErrorResponseErrorDetailsItem.yml +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ErrorResponseErrorDetailsItem.yml @@ -10,14 +10,17 @@ constructor: keywordOnlyParameters: - name: code description: Provides information about the error code. + defaultValue: None types: - - name: target description: Provides information about the error target. + defaultValue: None types: - - name: message description: Provides information about the error message. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Export.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Export.yml index 545bd1cf..5d4b6458 100644 --- a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Export.yml +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Export.yml @@ -17,14 +17,17 @@ constructor: If the blob is in root container, the URI must begin with $root.' + defaultValue: None types: - - name: blob_path description: A collection of blob-path strings. + defaultValue: None types: - [] - name: blob_path_prefix description: A collection of blob-prefix strings. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.GetBitLockerKeysResponse.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.GetBitLockerKeysResponse.yml index a4d05db8..ce9b8c59 100644 --- a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.GetBitLockerKeysResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.GetBitLockerKeysResponse.yml @@ -10,6 +10,7 @@ constructor: keywordOnlyParameters: - name: value description: drive status. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.JobDetails.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.JobDetails.yml index 461b169f..07982661 100644 --- a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.JobDetails.yml +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.JobDetails.yml @@ -20,30 +20,36 @@ constructor: description: 'The resource identifier of the storage account where data will be imported to or exported from.' + defaultValue: None types: - - name: job_type description: The type of job. + defaultValue: None types: - - name: return_address description: Specifies the return address information for the job. + defaultValue: None types: - - name: return_shipping description: Specifies the return carrier and customer's account with the carrier. + defaultValue: None types: - - name: shipping_information description: 'Contains information about the Microsoft datacenter to which the drives should be shipped.' + defaultValue: None types: - - name: delivery_package description: 'Contains information about the package being shipped by the customer to the Microsoft data center.' + defaultValue: None types: - - name: return_package @@ -56,12 +62,14 @@ constructor: have not yet been returned.' + defaultValue: None types: - - name: diagnostics_path description: 'The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored.' + defaultValue: None types: - - name: log_level @@ -69,12 +77,14 @@ constructor: logging will be enabled.' + defaultValue: None types: - - name: backup_drive_manifest description: 'Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs.' + defaultValue: 'False' types: - - name: state @@ -84,10 +94,12 @@ constructor: - - name: cancel_requested description: Indicates whether a request has been submitted to cancel the job. + defaultValue: 'False' types: - - name: percent_complete description: Overall percentage completed for the job. + defaultValue: None types: - - name: incomplete_blob_list_uri @@ -97,6 +109,7 @@ constructor: were exported successfully, then this element is not included in the response.' + defaultValue: None types: - - name: drive_list @@ -104,6 +117,7 @@ constructor: a required element for an import job; it is not specified for export jobs.' + defaultValue: None types: - [] - name: export @@ -111,14 +125,17 @@ constructor: for an export job. This property is included for export jobs only.' + defaultValue: None types: - - name: provisioning_state description: Specifies the provisioning state of the job. + defaultValue: None types: - - name: encryption_key description: Contains information about the encryption key. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.JobResponse.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.JobResponse.yml index 492c22aa..88410476 100644 --- a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.JobResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.JobResponse.yml @@ -14,18 +14,22 @@ constructor: keywordOnlyParameters: - name: location description: Specifies the Azure location where the job is created. + defaultValue: None types: - - name: tags description: Specifies the tags that are assigned to the job. + defaultValue: None types: - - name: properties description: Specifies the job properties. + defaultValue: None types: - - name: identity description: Specifies the job identity details. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ListJobsResponse.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ListJobsResponse.yml index a4cf5546..df155345 100644 --- a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ListJobsResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ListJobsResponse.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: next_link description: link to next batch of jobs. + defaultValue: None types: - - name: value description: Job list. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ListOperationsResponse.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ListOperationsResponse.yml index f53b9b80..cb65aeeb 100644 --- a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ListOperationsResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ListOperationsResponse.yml @@ -10,6 +10,7 @@ constructor: keywordOnlyParameters: - name: value description: operations. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Location.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Location.yml index 176ed242..d7101d74 100644 --- a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Location.yml +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Location.yml @@ -15,6 +15,7 @@ constructor: keywordOnlyParameters: - name: id description: Specifies the resource identifier of the location. + defaultValue: None types: - - name: name @@ -22,10 +23,12 @@ constructor: supported locations.' + defaultValue: None types: - - name: type description: Specifies the type of the location. + defaultValue: None types: - - name: recipient_name @@ -33,53 +36,63 @@ constructor: data center.' + defaultValue: None types: - - name: street_address1 description: 'The first line of the street address to use when shipping the drives to the Azure data center.' + defaultValue: None types: - - name: street_address2 description: 'The second line of the street address to use when shipping the drives to the Azure data center.' + defaultValue: None types: - - name: city description: The city name to use when shipping the drives to the Azure data center. + defaultValue: None types: - - name: state_or_province description: 'The state or province to use when shipping the drives to the Azure data center.' + defaultValue: None types: - - name: postal_code description: The postal code to use when shipping the drives to the Azure data center. + defaultValue: None types: - - name: country_or_region description: 'The country or region to use when shipping the drives to the Azure data center.' + defaultValue: None types: - - name: phone description: The phone number for the Azure data center. + defaultValue: None types: - - name: additional_shipping_information description: 'Additional shipping information for customer, specific to datacenter to which customer should send their disks.' + defaultValue: None types: - - name: supported_carriers description: A list of carriers that are supported at this location. + defaultValue: None types: - [] - name: alternate_locations @@ -92,6 +105,7 @@ constructor: list may contain other locations.' + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.LocationsResponse.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.LocationsResponse.yml index 2bb34fd4..bae69501 100644 --- a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.LocationsResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.LocationsResponse.yml @@ -9,6 +9,7 @@ constructor: keywordOnlyParameters: - name: value description: locations. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Operation.yml index a579062d..9ac2f86f 100644 --- a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Operation.yml +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.Operation.yml @@ -17,18 +17,22 @@ constructor: - - name: provider description: The resource provider name to which the operation belongs. + defaultValue: None types: - - name: resource description: The name of the resource to which the operation belongs. + defaultValue: None types: - - name: operation description: The display name of the operation. + defaultValue: None types: - - name: description description: Short description of the operation. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.PutJobParameters.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.PutJobParameters.yml index f3ed9f8b..7fc9d34d 100644 --- a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.PutJobParameters.yml +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.PutJobParameters.yml @@ -10,14 +10,17 @@ constructor: keywordOnlyParameters: - name: location description: Specifies the supported Azure location where the job should be created. + defaultValue: None types: - - name: tags description: Specifies the tags that will be assigned to the job. + defaultValue: None types: - - name: properties description: Specifies the job properties. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ReturnAddress.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ReturnAddress.yml index c83494a0..6c1505d6 100644 --- a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ReturnAddress.yml +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ReturnAddress.yml @@ -29,6 +29,7 @@ constructor: description: 'The second line of the street address to use when returning the drives.' + defaultValue: None types: - - name: city @@ -37,6 +38,7 @@ constructor: - - name: state_or_province description: The state or province to use when returning the drives. + defaultValue: None types: - - name: postal_code diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ShippingInformation.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ShippingInformation.yml index 3c2b8957..3ed9d7c8 100644 --- a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ShippingInformation.yml +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.ShippingInformation.yml @@ -19,38 +19,46 @@ constructor: they are returned.' + defaultValue: None types: - - name: street_address1 description: 'The first line of the street address to use when returning the drives.' + defaultValue: None types: - - name: street_address2 description: 'The second line of the street address to use when returning the drives.' + defaultValue: None types: - - name: city description: The city name to use when returning the drives. + defaultValue: None types: - - name: state_or_province description: The state or province to use when returning the drives. + defaultValue: None types: - - name: postal_code description: The postal code to use when returning the drives. + defaultValue: None types: - - name: country_or_region description: The country or region to use when returning the drives. + defaultValue: None types: - - name: phone description: Phone number of the recipient of the returned drives. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.SystemData.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.SystemData.yml index 553a4397..8496e2e8 100644 --- a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.SystemData.yml +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.SystemData.yml @@ -12,32 +12,38 @@ constructor: keywordOnlyParameters: - name: created_by description: The identity that created the resource. + defaultValue: None types: - - name: created_by_type description: 'The type of identity that created the resource. Known values are: "User", "Application", "ManagedIdentity", and "Key".' + defaultValue: None types: - - - name: created_at description: The timestamp of resource creation (UTC). + defaultValue: None types: - - name: last_modified_by description: The identity that last modified the resource. + defaultValue: None types: - - name: last_modified_by_type description: 'The type of identity that last modified the resource. Known values are: "User", "Application", "ManagedIdentity", and "Key".' + defaultValue: None types: - - - name: last_modified_at description: The timestamp of resource last modification (UTC). + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.UpdateJobParameters.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.UpdateJobParameters.yml index 51d6624a..b3eac944 100644 --- a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.UpdateJobParameters.yml +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.models.UpdateJobParameters.yml @@ -14,12 +14,14 @@ constructor: keywordOnlyParameters: - name: tags description: Specifies the tags that will be assigned to the job. + defaultValue: None types: - - name: cancel_requested description: 'If specified, the value must be true. The service will attempt to cancel the job.' + defaultValue: 'False' types: - - name: state @@ -33,34 +35,41 @@ constructor: the request will fail.' + defaultValue: None types: - - name: return_address description: Specifies the return address information for the job. + defaultValue: None types: - - name: return_shipping description: Specifies the return carrier and customer's account with the carrier. + defaultValue: None types: - - name: delivery_package description: 'Contains information about the package being shipped by the customer to the Microsoft data center.' + defaultValue: None types: - - name: log_level description: Indicates whether error logging or verbose logging is enabled. + defaultValue: None types: - - name: backup_drive_manifest description: 'Indicates whether the manifest files on the drives should be copied to block blobs.' + defaultValue: 'False' types: - - name: drive_list description: List of drives that comprise the job. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.JobsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.JobsOperations.yml index 5e1565df..5122afff 100644 --- a/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.JobsOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-storageimportexport/azure.mgmt.storageimportexport.operations.JobsOperations.yml @@ -40,7 +40,7 @@ methods: - name: client_tenant_id description: The tenant ID of the client making the request. Default value is None. - isRequired: true + defaultValue: None types: - keywordOnlyParameters: @@ -135,7 +135,7 @@ methods: returned. The value cannot exceed 100. Default value is None.' - isRequired: true + defaultValue: None types: - - name: filter @@ -143,7 +143,7 @@ methods: value is None.' - isRequired: true + defaultValue: None types: - keywordOnlyParameters: @@ -169,7 +169,7 @@ methods: returned. The value cannot exceed 100. Default value is None.' - isRequired: true + defaultValue: None types: - - name: filter @@ -177,7 +177,7 @@ methods: value is None.' - isRequired: true + defaultValue: None types: - keywordOnlyParameters: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.BillingHubServiceOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.BillingHubServiceOperations.yml index 0ba966ac..a7bd3e4c 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.BillingHubServiceOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.BillingHubServiceOperations.yml @@ -59,7 +59,7 @@ methods: - - name: get_usage_request description: Is either a model type or a IO type. Default value is None. - isRequired: true + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.PackagesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.PackagesOperations.yml index 67f3535d..63b93767 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.PackagesOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.PackagesOperations.yml @@ -397,7 +397,7 @@ methods: Run. Is either a model type or a IO type. Default value is None.' - isRequired: true + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestBaseAccountsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestBaseAccountsOperations.yml index e3773612..a913871e 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestBaseAccountsOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestBaseAccountsOperations.yml @@ -45,7 +45,7 @@ methods: which were soft deleted before. Default value is None.' - isRequired: true + defaultValue: None types: - keywordOnlyParameters: @@ -358,7 +358,7 @@ methods: Is either a model type or a IO type. Default value is None.' - isRequired: true + defaultValue: None types: - - @@ -397,7 +397,7 @@ methods: which were soft deleted before. Default value is None.' - isRequired: true + defaultValue: None types: - keywordOnlyParameters: @@ -426,7 +426,7 @@ methods: which were soft deleted before. Default value is None.' - isRequired: true + defaultValue: None types: - keywordOnlyParameters: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestResultsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestResultsOperations.yml index fee96b25..e85cbfc4 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestResultsOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.TestResultsOperations.yml @@ -227,7 +227,7 @@ methods: - - name: filter description: Odata filter. Default value is None. - isRequired: true + defaultValue: None types: - keywordOnlyParameters: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.UsageOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.UsageOperations.yml index 86969ee1..9ddb735a 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.UsageOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.aio.operations.UsageOperations.yml @@ -29,7 +29,7 @@ methods: - - name: filter description: Odata filter. Default value is None. - isRequired: true + defaultValue: None types: - keywordOnlyParameters: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultListResult.yml index 0d230660..54e5e558 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultListResult.yml @@ -14,6 +14,7 @@ constructor: keywordOnlyParameters: - name: value description: The list of Analysis Results. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultSingletonResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultSingletonResource.yml index ad86b6c0..26ff15e8 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultSingletonResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultSingletonResource.yml @@ -16,6 +16,7 @@ constructor: "Pass", and "Fail".' + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultSingletonResourceProperties.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultSingletonResourceProperties.yml index 5e3ee3bf..bbac4682 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultSingletonResourceProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AnalysisResultSingletonResourceProperties.yml @@ -32,6 +32,7 @@ constructor: "Pass", and "Fail".' + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AvailableOSListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AvailableOSListResult.yml index edb477e4..f7cb2c8a 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AvailableOSListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AvailableOSListResult.yml @@ -13,6 +13,7 @@ constructor: keywordOnlyParameters: - name: value description: The list of available OSs. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AvailableOSResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AvailableOSResource.yml index b377d8c3..ae71e58e 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AvailableOSResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.AvailableOSResource.yml @@ -14,26 +14,32 @@ constructor: keywordOnlyParameters: - name: os_id description: The Id of an Available OS of a Test Base Account. + defaultValue: None types: - - name: os_name description: The name of an Available OS of a Test Base Account. + defaultValue: None types: - - name: os_version description: The version of an Available OS of a Test Base Account. + defaultValue: None types: - - name: insider_channel description: The insider channel of an Available OS of a Test Base Account. + defaultValue: None types: - - name: os_update_type description: The OS update type of an Available OS of a Test Base Account. + defaultValue: None types: - - name: os_platform description: The Platform of an Available OS of a Test Base Account. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubExecutionUsageDetail.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubExecutionUsageDetail.yml index ce14307f..e6fbe2ea 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubExecutionUsageDetail.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubExecutionUsageDetail.yml @@ -14,45 +14,59 @@ constructor: | None = None, billed_charges: float | None = None, **kwargs)' keywordOnlyParameters: - name: application_name + defaultValue: None types: - - name: application_version + defaultValue: None types: - - name: execution_request_id + defaultValue: None types: - - name: sku + defaultValue: None types: - - name: meter_id + defaultValue: None types: - - name: start_time_stamp + defaultValue: None types: - - name: end_time_stamp + defaultValue: None types: - - name: os_build + defaultValue: None types: - - name: release + defaultValue: None types: - - name: test_type + defaultValue: None types: - - name: update_type + defaultValue: None types: - - name: used_free_hours + defaultValue: None types: - - name: used_billable_hours + defaultValue: None types: - - name: billed_charges + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubFreeHourIncrementEntry.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubFreeHourIncrementEntry.yml index 19d8ab0d..9a633bad 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubFreeHourIncrementEntry.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubFreeHourIncrementEntry.yml @@ -10,15 +10,19 @@ constructor: float | None = None, remaining_free_hours: float | None = None, **kwargs)' keywordOnlyParameters: - name: create_time_stamp + defaultValue: None types: - - name: expiration_time_stamp + defaultValue: None types: - - name: incremental_free_hours + defaultValue: None types: - - name: remaining_free_hours + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetFreeHourBalanceResponse.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetFreeHourBalanceResponse.yml index 462cdaca..00792cbc 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetFreeHourBalanceResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetFreeHourBalanceResponse.yml @@ -10,9 +10,11 @@ constructor: | None = None, **kwargs)' keywordOnlyParameters: - name: total_remaining_free_hours + defaultValue: None types: - - name: increment_entries + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetUsageRequest.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetUsageRequest.yml index 0efbc138..a94e40a9 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetUsageRequest.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetUsageRequest.yml @@ -20,9 +20,11 @@ constructor: types: - - name: page_size + defaultValue: None types: - - name: page_index + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetUsageResponse.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetUsageResponse.yml index 8054092f..e0b1357a 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetUsageResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubGetUsageResponse.yml @@ -11,18 +11,23 @@ constructor: next_request: _models.BillingHubGetUsageRequest | None = None, **kwargs)' keywordOnlyParameters: - name: total_used_free_hours + defaultValue: None types: - - name: total_used_billable_hours + defaultValue: None types: - - name: total_charges + defaultValue: None types: - - name: package_usage_entries + defaultValue: None types: - [] - name: next_request + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubPackageUsage.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubPackageUsage.yml index 4bd8c07b..8af0de30 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubPackageUsage.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubPackageUsage.yml @@ -12,24 +12,31 @@ constructor: | None = None, **kwargs)' keywordOnlyParameters: - name: application_name + defaultValue: None types: - - name: application_version + defaultValue: None types: - - name: azure_resource_uri + defaultValue: None types: - - name: total_used_free_hours + defaultValue: None types: - - name: total_used_billable_hours + defaultValue: None types: - - name: total_charges + defaultValue: None types: - - name: usage_entries_grouped_by_update_type + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsage.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsage.yml index e12039dc..11fbee7a 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsage.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsage.yml @@ -12,24 +12,31 @@ constructor: None, **kwargs)' keywordOnlyParameters: - name: application_name + defaultValue: None types: - - name: application_version + defaultValue: None types: - - name: azure_resource_uri + defaultValue: None types: - - name: total_used_free_hours + defaultValue: None types: - - name: total_used_billable_hours + defaultValue: None types: - - name: total_charges + defaultValue: None types: - - name: usage_groups + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsageGroup.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsageGroup.yml index ac4985d3..27cee768 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsageGroup.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsageGroup.yml @@ -13,36 +13,47 @@ constructor: List[_models.BillingHubExecutionUsageDetail] | None = None, **kwargs)' keywordOnlyParameters: - name: total_used_free_hours + defaultValue: None types: - - name: total_used_billable_hours + defaultValue: None types: - - name: total_charges + defaultValue: None types: - - name: release_build_revision + defaultValue: None types: - - name: release_build_number + defaultValue: None types: - - name: release_build_date + defaultValue: None types: - - name: os_build + defaultValue: None types: - - name: release + defaultValue: None types: - - name: test_type + defaultValue: None types: - - name: product_family + defaultValue: None types: - - name: execution_usage_details + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsageGroupedByUpdateType.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsageGroupedByUpdateType.yml index 50a4b8b4..fee5ebe4 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsageGroupedByUpdateType.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.BillingHubUsageGroupedByUpdateType.yml @@ -11,18 +11,23 @@ constructor: None, **kwargs)' keywordOnlyParameters: - name: update_type + defaultValue: None types: - - name: total_used_free_hours + defaultValue: None types: - - name: total_used_billable_hours + defaultValue: None types: - - name: total_charges + defaultValue: None types: - - name: usage_groups + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CPURegressionResultSingletonResourceProperties.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CPURegressionResultSingletonResourceProperties.yml index 1a59e774..379d8908 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CPURegressionResultSingletonResourceProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CPURegressionResultSingletonResourceProperties.yml @@ -17,11 +17,13 @@ constructor: "Pass", and "Fail".' + defaultValue: None types: - - - name: cpu_regression_results description: The result array data. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CPUUtilizationResultSingletonResourceProperties.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CPUUtilizationResultSingletonResourceProperties.yml index 63aa8cca..159dd89c 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CPUUtilizationResultSingletonResourceProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CPUUtilizationResultSingletonResourceProperties.yml @@ -17,11 +17,13 @@ constructor: "Pass", and "Fail".' + defaultValue: None types: - - - name: cpu_utilization_results description: The result array data. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CheckNameAvailabilityResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CheckNameAvailabilityResult.yml index 77dc8e4a..e3abe07d 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CheckNameAvailabilityResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CheckNameAvailabilityResult.yml @@ -16,6 +16,7 @@ constructor: is available; otherwise, false.' + defaultValue: None types: - - name: reason @@ -23,6 +24,7 @@ constructor: == false. Known values are: "Invalid" and "AlreadyExists".' + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Command.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Command.yml index 76dce36a..031679cc 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Command.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Command.yml @@ -39,27 +39,33 @@ constructor: - - name: run_elevated description: Specifies whether to run the command as administrator. + defaultValue: None types: - - name: restart_after description: Specifies whether to restart the VM after the command executed. + defaultValue: None types: - - name: max_run_time description: Specifies the max run time of the command. + defaultValue: None types: - - name: run_as_interactive description: Specifies whether to run the command in interactive mode. + defaultValue: None types: - - name: always_run description: Specifies whether to run the command even if a previous command is failed. + defaultValue: None types: - - name: apply_update_before description: Specifies whether to apply update before the command. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CustomerEventListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CustomerEventListResult.yml index ecb18104..24c78726 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CustomerEventListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CustomerEventListResult.yml @@ -13,6 +13,7 @@ constructor: keywordOnlyParameters: - name: value description: The list of Test Base Customer Events. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CustomerEventResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CustomerEventResource.yml index 6a836b3c..0446cebc 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CustomerEventResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.CustomerEventResource.yml @@ -13,10 +13,12 @@ constructor: keywordOnlyParameters: - name: event_name description: The name of the event subscribed to. + defaultValue: None types: - - name: receivers description: The notification event receivers. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.DistributionGroupListReceiverValue.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.DistributionGroupListReceiverValue.yml index 5f340f37..4ddf7f54 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.DistributionGroupListReceiverValue.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.DistributionGroupListReceiverValue.yml @@ -10,6 +10,7 @@ constructor: keywordOnlyParameters: - name: distribution_groups description: The list of distribution groups. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.EmailEventListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.EmailEventListResult.yml index 70d1bdac..c77ff931 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.EmailEventListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.EmailEventListResult.yml @@ -13,6 +13,7 @@ constructor: keywordOnlyParameters: - name: value description: The list of email events. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.EmailEventResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.EmailEventResource.yml index 59db72d7..a857c94b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.EmailEventResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.EmailEventResource.yml @@ -13,14 +13,17 @@ constructor: keywordOnlyParameters: - name: event_id description: The identifier of the email event. + defaultValue: None types: - - name: event_name description: The name of the email event. + defaultValue: None types: - - name: display_name description: The display name of the email event. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ErrorResponse.yml index baa1e44e..405c5819 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ErrorResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ErrorResponse.yml @@ -9,6 +9,7 @@ constructor: keywordOnlyParameters: - name: error description: The error details. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FavoriteProcessListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FavoriteProcessListResult.yml index ee37a1d1..e77dfad0 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FavoriteProcessListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FavoriteProcessListResult.yml @@ -13,6 +13,7 @@ constructor: keywordOnlyParameters: - name: value description: The list of favorite processes for a package. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FavoriteProcessResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FavoriteProcessResource.yml index f4435d41..1e9661bc 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FavoriteProcessResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FavoriteProcessResource.yml @@ -17,6 +17,7 @@ constructor: that are not allowed in the resource name.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FlightingRingListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FlightingRingListResult.yml index 8a2e24d7..8c4db3ac 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FlightingRingListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FlightingRingListResult.yml @@ -13,6 +13,7 @@ constructor: keywordOnlyParameters: - name: value description: The list of flighting rings. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FlightingRingResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FlightingRingResource.yml index abe49cb3..d3b21dd1 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FlightingRingResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.FlightingRingResource.yml @@ -15,6 +15,7 @@ constructor: description: 'The actual name of a flighting ring of a Test Base Account.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.GetFileUploadURLParameters.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.GetFileUploadURLParameters.yml index d751b41e..7b153a8c 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.GetFileUploadURLParameters.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.GetFileUploadURLParameters.yml @@ -9,6 +9,7 @@ constructor: keywordOnlyParameters: - name: blob_name description: The custom file name of the uploaded blob. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.IdentifiedFailure.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.IdentifiedFailure.yml index 798db5c3..fa70ec7c 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.IdentifiedFailure.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.IdentifiedFailure.yml @@ -11,21 +11,25 @@ constructor: keywordOnlyParameters: - name: failure_id description: The Failure Id. + defaultValue: None types: - - name: category description: 'The category of the failure. Known values are: "None", "Unidentified", "Package", "OSUpdate", and "Infrastructure".' + defaultValue: None types: - - - name: error_message description: Message that shows information about the failure. + defaultValue: None types: - - name: guidance description: Guidance that shows what the customer needs to do for this failure. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.MemoryRegressionResultSingletonResourceProperties.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.MemoryRegressionResultSingletonResourceProperties.yml index 9cd7ca57..8bb695d3 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.MemoryRegressionResultSingletonResourceProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.MemoryRegressionResultSingletonResourceProperties.yml @@ -17,11 +17,13 @@ constructor: "Pass", and "Fail".' + defaultValue: None types: - - - name: memory_regression_results description: The result array data. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.MemoryUtilizationResultSingletonResourceProperties.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.MemoryUtilizationResultSingletonResourceProperties.yml index 3d376b40..7293a696 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.MemoryUtilizationResultSingletonResourceProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.MemoryUtilizationResultSingletonResourceProperties.yml @@ -17,11 +17,13 @@ constructor: "Pass", and "Fail".' + defaultValue: None types: - - - name: memory_utilization_results description: The result array data. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.NotificationEventReceiver.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.NotificationEventReceiver.yml index 3348352b..dc312ab2 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.NotificationEventReceiver.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.NotificationEventReceiver.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: receiver_type description: The type of the notification event receiver. + defaultValue: None types: - - name: receiver_value description: The notification event receiver value. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.NotificationReceiverValue.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.NotificationReceiverValue.yml index 597cb75a..75cead74 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.NotificationReceiverValue.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.NotificationReceiverValue.yml @@ -12,14 +12,17 @@ constructor: keywordOnlyParameters: - name: user_object_receiver_value description: The user object receiver value. + defaultValue: None types: - - name: subscription_receiver_value description: The user object receiver value. + defaultValue: None types: - - name: distribution_group_list_receiver_value description: The user object receiver value. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateListResult.yml index 21969b25..eddc275f 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateListResult.yml @@ -13,6 +13,7 @@ constructor: keywordOnlyParameters: - name: value description: The list of OS Updates. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateResource.yml index 8c2cfbb7..0e4db6ef 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateResource.yml @@ -15,33 +15,40 @@ constructor: keywordOnlyParameters: - name: os_name description: The name of the OS. + defaultValue: None types: - - name: release description: The name of tested release. + defaultValue: None types: - - name: flighting_ring description: The flighting ring, only for release of feature updates. + defaultValue: None types: - - name: build_version description: The build version of the tested release (OS update). + defaultValue: None types: - - name: build_revision description: The build revision of the tested release (OS update). + defaultValue: None types: - - name: type_properties_type description: 'The type of this release (OS update). Known values are: "SecurityUpdate" and "FeatureUpdate".' + defaultValue: None types: - - - name: release_version_date description: The release version date the tested release (OS update). + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateTestSummary.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateTestSummary.yml index 85a66f7c..7c11db36 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateTestSummary.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdateTestSummary.yml @@ -14,26 +14,32 @@ constructor: keywordOnlyParameters: - name: os_name description: The operating system name. e.g. Windows 10 1809. + defaultValue: None types: - - name: release_name description: The name of the tested release (OS update). + defaultValue: None types: - - name: build_version description: The build version of the tested release (OS update). + defaultValue: None types: - - name: build_revision description: The build revision of the tested release (OS update). + defaultValue: None types: - - name: release_version_date description: The release version date. + defaultValue: None types: - - name: flighting_ring description: The flighting ring, only for release of feature updates. + defaultValue: None types: - - name: execution_status @@ -43,6 +49,7 @@ constructor: and "Succeeded".' + defaultValue: None types: - - @@ -52,6 +59,7 @@ constructor: "TestExecutionInProgress", "DataProcessing", "TestFailure", "UpdateFailure", "TestAndUpdateFailure", "InfrastructureFailure", and "Completed".' + defaultValue: None types: - - @@ -60,15 +68,18 @@ constructor: "Pass", and "Fail".' + defaultValue: None types: - - - name: test_run_time description: The run time of the test. + defaultValue: None types: - - name: test_type description: The test type of the package. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdatesTestSummary.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdatesTestSummary.yml index 44ef6005..a5dc6160 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdatesTestSummary.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OSUpdatesTestSummary.yml @@ -14,6 +14,7 @@ constructor: description: 'The status of the last test. Known values are: "None", "InProgress", "Processing", "Completed", "NotExecuted", "Incomplete", "Failed", and "Succeeded".' + defaultValue: None types: - - @@ -23,6 +24,7 @@ constructor: "TestExecutionInProgress", "DataProcessing", "TestFailure", "UpdateFailure", "TestAndUpdateFailure", "InfrastructureFailure", and "Completed".' + defaultValue: None types: - - @@ -31,15 +33,18 @@ constructor: "Pass", and "Fail".' + defaultValue: None types: - - - name: test_run_time description: The run time of the last test. + defaultValue: None types: - - name: os_update_test_summaries description: Detailed summary for each OS update. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Operation.yml index 55dd91f5..f39e2ec0 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Operation.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Operation.yml @@ -13,10 +13,12 @@ constructor: keywordOnlyParameters: - name: display description: The object that describes the operation. + defaultValue: None types: - - name: properties description: Extra properties of the operation. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OperationListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OperationListResult.yml index e14f7181..bb886776 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OperationListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.OperationListResult.yml @@ -12,6 +12,7 @@ constructor: keywordOnlyParameters: - name: value description: List of operations supported by the Test Base resource provider. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageCheckNameAvailabilityParameters.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageCheckNameAvailabilityParameters.yml index 79747078..2c875e50 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageCheckNameAvailabilityParameters.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageCheckNameAvailabilityParameters.yml @@ -25,6 +25,7 @@ constructor: - - name: type description: fully qualified resource type which includes provider namespace. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageListResult.yml index 8f0881dd..f1cb88e2 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageListResult.yml @@ -13,6 +13,7 @@ constructor: keywordOnlyParameters: - name: value description: The list of Test Base Packages. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageResource.yml index ffee7ea3..b1a6d46d 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageResource.yml @@ -18,6 +18,7 @@ constructor: keywordOnlyParameters: - name: tags description: The tags of the resource. + defaultValue: None types: - [, ] - name: location @@ -26,26 +27,32 @@ constructor: - - name: application_name description: Application name. + defaultValue: None types: - - name: version description: Application version. + defaultValue: None types: - - name: target_os_list description: Specifies the target OSs of specific OS Update types. + defaultValue: None types: - [] - name: flighting_ring description: The flighting ring for feature update. + defaultValue: None types: - - name: blob_path description: The file path of the package. + defaultValue: None types: - - name: tests description: The detailed test information. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageRunTestParameters.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageRunTestParameters.yml index cfc89559..409527aa 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageRunTestParameters.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageRunTestParameters.yml @@ -24,6 +24,7 @@ constructor: description: 'Specifies the OS update type to test against. Known values are: "SecurityUpdate" and "FeatureUpdate".' + defaultValue: None types: - - @@ -33,10 +34,12 @@ constructor: - - name: release_name description: The name of the tested release (OS update). + defaultValue: None types: - - name: flighting_ring description: The flighting ring, only for release of feature updates. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageUpdateParameters.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageUpdateParameters.yml index 231f53b7..2a6b6fb5 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.PackageUpdateParameters.yml @@ -12,14 +12,17 @@ constructor: keywordOnlyParameters: - name: tags description: The tags of the Package. + defaultValue: None types: - [, ] - name: target_os_list description: Specifies the target OSs of specific OS Update types. + defaultValue: None types: - [] - name: flighting_ring description: The flighting ring for feature update. + defaultValue: None types: - - name: is_enabled @@ -27,14 +30,17 @@ constructor: for package which is not enabled.' + defaultValue: None types: - - name: blob_path description: The file name of the package. + defaultValue: None types: - - name: tests description: The detailed test information. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.RegressionResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.RegressionResult.yml index d3fb79a3..247a59e1 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.RegressionResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.RegressionResult.yml @@ -11,6 +11,7 @@ constructor: keywordOnlyParameters: - name: file_name description: FileName of the binary being analyzed. + defaultValue: None types: - - name: grade @@ -18,6 +19,7 @@ constructor: "Pass", and "Fail".' + defaultValue: None types: - - @@ -26,14 +28,17 @@ constructor: was inferred.' + defaultValue: None types: - - name: diff description: Difference between the two datasets being analyzed. + defaultValue: None types: - - name: is_regressed description: Indicates if a regression was inferred. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.RegressionTestDetails.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.RegressionTestDetails.yml index 43f04704..fa11e2f9 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.RegressionTestDetails.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.RegressionTestDetails.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: diff description: Difference between the two datasets being analyzed. + defaultValue: None types: - - name: is_regressed description: Indicates if a regression was inferred. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ReliabilityResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ReliabilityResult.yml index e2d423b9..cdcdc3bb 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ReliabilityResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ReliabilityResult.yml @@ -14,24 +14,29 @@ constructor: keywordOnlyParameters: - name: file_name description: File name. + defaultValue: None types: - - name: launch_count description: Count of number of launches. + defaultValue: None types: - - name: crash_count description: Count of number of crashes. + defaultValue: None types: - - name: hang_count description: Count of number of hangs. + defaultValue: None types: - - name: regression_grade description: 'The regression grade. Known values are: "None", "NotAvailable", "Pass", and "Fail".' + defaultValue: None types: - - @@ -39,22 +44,26 @@ constructor: description: 'The statistic regression grade for crash signal. Known values are: "None", "NotAvailable", "Pass", and "Fail".' + defaultValue: None types: - - - name: crash_regression_test_details description: Details related to the crash regression analysis. + defaultValue: None types: - - name: hang_regression_grade description: 'The statistic regression grade for hang signal. Known values are: "None", "NotAvailable", "Pass", and "Fail".' + defaultValue: None types: - - - name: hang_regression_test_details description: Details related to the hang regression analysis. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ReliabilityResultSingletonResourceProperties.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ReliabilityResultSingletonResourceProperties.yml index 2dfa31bc..4dec9fef 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ReliabilityResultSingletonResourceProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ReliabilityResultSingletonResourceProperties.yml @@ -17,11 +17,13 @@ constructor: "Pass", and "Fail".' + defaultValue: None types: - - - name: reliability_results description: The result array data. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ScriptExecutionResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ScriptExecutionResult.yml index cc553ce3..665d106d 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ScriptExecutionResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ScriptExecutionResult.yml @@ -12,30 +12,37 @@ constructor: keywordOnlyParameters: - name: script_name description: Name of script. + defaultValue: None types: - - name: start_time description: Start time of script execution. + defaultValue: None types: - - name: end_time description: End time of script execution. + defaultValue: None types: - - name: exit_code description: Exit code. + defaultValue: None types: - - name: timed_out description: Whether the script execution is timed out. + defaultValue: None types: - - name: stdout_log_file_name description: The stdout log file name. + defaultValue: None types: - - name: stderr_log_file_name description: The stderr log file name. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ScriptExecutionResultSingletonResourceProperties.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ScriptExecutionResultSingletonResourceProperties.yml index fbc49d14..445739ec 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ScriptExecutionResultSingletonResourceProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.ScriptExecutionResultSingletonResourceProperties.yml @@ -17,11 +17,13 @@ constructor: "Pass", and "Fail".' + defaultValue: None types: - - - name: script_execution_results description: The result array data. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.SubscriptionReceiverValue.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.SubscriptionReceiverValue.yml index 701d2d23..cd5b21e8 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.SubscriptionReceiverValue.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.SubscriptionReceiverValue.yml @@ -10,14 +10,17 @@ constructor: keywordOnlyParameters: - name: subscription_id description: The subscription id of the notification receiver. + defaultValue: None types: - - name: subscription_name description: The subscription name of the notification receiver. + defaultValue: None types: - - name: role description: The role of the notification receiver. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.SystemData.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.SystemData.yml index 9dad45f8..82775ee6 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.SystemData.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.SystemData.yml @@ -12,32 +12,38 @@ constructor: keywordOnlyParameters: - name: created_by description: The identity that created the resource. + defaultValue: None types: - - name: created_by_type description: 'The type of identity that created the resource. Known values are: "User", "Application", "ManagedIdentity", and "Key".' + defaultValue: None types: - - - name: created_at description: The timestamp of resource creation (UTC). + defaultValue: None types: - - name: last_modified_by description: The identity that last modified the resource. + defaultValue: None types: - - name: last_modified_by_type description: 'The type of identity that last modified the resource. Known values are: "User", "Application", "ManagedIdentity", and "Key".' + defaultValue: None types: - - - name: last_modified_at description: The type of identity that last modified the resource. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TargetOSInfo.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TargetOSInfo.yml index 1baeb06d..94e2944a 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TargetOSInfo.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TargetOSInfo.yml @@ -23,6 +23,7 @@ constructor: - [] - name: baseline_o_ss description: Specifies the baseline OSs to be tested. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Test.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Test.yml index 6011cd60..dcaeab14 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Test.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.Test.yml @@ -27,6 +27,7 @@ constructor: active Test.' + defaultValue: None types: - - name: commands diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestAnalysisResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestAnalysisResult.yml index 49c0f283..dbc698e4 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestAnalysisResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestAnalysisResult.yml @@ -11,17 +11,20 @@ constructor: keywordOnlyParameters: - name: blob_data description: The data to provide more failure analysis information. + defaultValue: None types: - - name: test_analysis_status description: 'The status of the analysis. Known values are: "None", "Analyzing", "Completed", and "Failed".' + defaultValue: None types: - - - name: identified_failures description: The array of identified failures. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestAnalysisResultSingletonResourceProperties.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestAnalysisResultSingletonResourceProperties.yml index 2858eafd..48c5beed 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestAnalysisResultSingletonResourceProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestAnalysisResultSingletonResourceProperties.yml @@ -17,11 +17,13 @@ constructor: "Pass", and "Fail".' + defaultValue: None types: - - - name: test_analysis_result description: The result of test analysis. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountListResult.yml index a05b3ec1..1eaaa1a3 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountListResult.yml @@ -13,6 +13,7 @@ constructor: keywordOnlyParameters: - name: value description: The list of Test Base Accounts. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountResource.yml index a934425e..03cb9841 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountResource.yml @@ -16,6 +16,7 @@ constructor: keywordOnlyParameters: - name: tags description: The tags of the resource. + defaultValue: None types: - [, ] - name: location @@ -24,6 +25,7 @@ constructor: - - name: sku description: The SKU of the Test Base Account. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountSKU.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountSKU.yml index bee571f3..4567d3d0 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountSKU.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountSKU.yml @@ -16,6 +16,7 @@ constructor: keywordOnlyParameters: - name: resource_type description: The type of resource the SKU applies to. + defaultValue: None types: - - name: name @@ -32,6 +33,7 @@ constructor: - - name: locations description: The locations that the SKU is available. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountSKUListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountSKUListResult.yml index 2e24ab15..296ccf0d 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountSKUListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountSKUListResult.yml @@ -13,6 +13,7 @@ constructor: keywordOnlyParameters: - name: value description: The list of Test Base Account SKUs. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUpdateParameters.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUpdateParameters.yml index 437ce228..57924151 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUpdateParameters.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: tags description: The tags of the Test Base Account. + defaultValue: None types: - [, ] - name: sku description: The SKU of the Test Base Account. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageData.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageData.yml index 9c1965f3..e81b694e 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageData.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageData.yml @@ -11,10 +11,12 @@ constructor: keywordOnlyParameters: - name: id description: Fully qualified ARM resource id. + defaultValue: None types: - - name: name description: Localizable String object containing the name and a localized value. + defaultValue: None types: - - name: unit @@ -22,6 +24,7 @@ constructor: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond.' + defaultValue: None types: - - name: limit @@ -29,10 +32,12 @@ constructor: limit, this value will be -1.' + defaultValue: None types: - - name: current_value description: Current value for the usage quota. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageDataList.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageDataList.yml index 0569b7d0..091a28e5 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageDataList.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageDataList.yml @@ -13,6 +13,7 @@ constructor: keywordOnlyParameters: - name: value description: The list of Test Base Account usage data. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageName.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageName.yml index a1a90aaf..31258291 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageName.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestBaseAccountUsageName.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: value description: The identifier of the usage. + defaultValue: None types: - - name: localized_value description: Localized name of the usage. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultAnalysisSummary.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultAnalysisSummary.yml index 0235136b..bdac9cc6 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultAnalysisSummary.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultAnalysisSummary.yml @@ -11,12 +11,14 @@ constructor: keywordOnlyParameters: - name: name description: Metric name. + defaultValue: None types: - - name: analysis_status description: 'The analysis status. Known values are: "None", "Completed", "InProgress", "Failed", "Succeeded", "Available", and "NotAvailable".' + defaultValue: None types: - - @@ -25,6 +27,7 @@ constructor: "Pass", and "Fail".' + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultListResult.yml index 9b2bc667..d83b6845 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultListResult.yml @@ -13,6 +13,7 @@ constructor: keywordOnlyParameters: - name: value description: The list of Test Results. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultResource.yml index 723ca752..ce54a208 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestResultResource.yml @@ -23,58 +23,72 @@ constructor: keywordOnlyParameters: - name: baseline_test_result_id description: Azure Id of the baseline test result. + defaultValue: None types: - - name: package_id description: Resource Id of the package. + defaultValue: None types: - - name: application_name description: Application name. + defaultValue: None types: - - name: application_version description: Application version. + defaultValue: None types: - - name: os_name description: The operating system name, e.g. Windows 10 1809. + defaultValue: None types: - - name: release_name description: The name of the tested release (OS update). + defaultValue: None types: - - name: release_version_date description: The release version date of the tested release. + defaultValue: None types: - - name: flighting_ring description: The flighting ring, only for release of feature updates. + defaultValue: None types: - - name: build_version description: The build version of the tested release (OS update). + defaultValue: None types: - - name: build_revision description: The build revision of the tested release (OS update). + defaultValue: None types: - - name: test_type description: Test type. E.g. 'Out of box test' or 'Functional test'. + defaultValue: None types: - - name: test_run_time description: The run time of the test. + defaultValue: None types: - - name: is_download_data_available description: Whether download data is available. + defaultValue: None types: - - name: is_video_available description: Whether video data is available. + defaultValue: None types: - - name: execution_status @@ -84,6 +98,7 @@ constructor: and "Succeeded".' + defaultValue: None types: - - @@ -93,6 +108,7 @@ constructor: "TestExecutionInProgress", "DataProcessing", "TestFailure", "UpdateFailure", "TestAndUpdateFailure", "InfrastructureFailure", and "Completed".' + defaultValue: None types: - - @@ -101,27 +117,33 @@ constructor: "Pass", and "Fail".' + defaultValue: None types: - - - name: kb_number description: KB number. + defaultValue: None types: - - name: interop_media_type description: Interop media type. + defaultValue: None types: - - name: interop_media_version description: Interop media version. + defaultValue: None types: - - name: package_version description: The version of the Windows update package. + defaultValue: None types: - - name: analysis_summaries description: List of analysis summaries. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestSummaryListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestSummaryListResult.yml index 1e1795a0..9948a0ef 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestSummaryListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestSummaryListResult.yml @@ -13,6 +13,7 @@ constructor: keywordOnlyParameters: - name: value description: The list of Test Summaries. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestSummaryResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestSummaryResource.yml index 9fb58b28..2abaee59 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestSummaryResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestSummaryResource.yml @@ -18,18 +18,22 @@ constructor: keywordOnlyParameters: - name: test_summary_id description: The Id of the current Test Summary. + defaultValue: None types: - - name: package_id description: The Azure resource Id of package. + defaultValue: None types: - - name: application_name description: Application name. + defaultValue: None types: - - name: application_version description: Application version. + defaultValue: None types: - - name: execution_status @@ -39,6 +43,7 @@ constructor: and "Succeeded".' + defaultValue: None types: - - @@ -48,6 +53,7 @@ constructor: "TestExecutionInProgress", "DataProcessing", "TestFailure", "UpdateFailure", "TestAndUpdateFailure", "InfrastructureFailure", and "Completed".' + defaultValue: None types: - - @@ -56,27 +62,32 @@ constructor: "Pass", and "Fail".' + defaultValue: None types: - - - name: test_run_time description: The run time of the last test. + defaultValue: None types: - - name: feature_updates_test_summary description: 'The result summary of tests triggered by feature updates.' + defaultValue: None types: - - name: security_updates_test_summary description: 'The result summary of tests triggered by security updates.' + defaultValue: None types: - - name: package_tags description: The tags of Package resource that are associated with the testSummary. + defaultValue: None types: - [, ] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestTypeListResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestTypeListResult.yml index f6a4a3ff..067c9eaa 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestTypeListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestTypeListResult.yml @@ -13,6 +13,7 @@ constructor: keywordOnlyParameters: - name: value description: The list of test types. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestTypeResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestTypeResource.yml index 5764f929..41addbb1 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestTypeResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TestTypeResource.yml @@ -12,6 +12,7 @@ constructor: keywordOnlyParameters: - name: actual_test_type_name description: The actual name of a test type of a Test Base Account. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TrackedResource.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TrackedResource.yml index 30b65e53..c7974c62 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TrackedResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.TrackedResource.yml @@ -15,6 +15,7 @@ constructor: keywordOnlyParameters: - name: tags description: The tags of the resource. + defaultValue: None types: - [, ] - name: location diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UserObjectReceiverValue.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UserObjectReceiverValue.yml index d80f055f..0efd4a4b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UserObjectReceiverValue.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UserObjectReceiverValue.yml @@ -9,6 +9,7 @@ constructor: keywordOnlyParameters: - name: user_object_ids description: user object ids. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationBound.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationBound.yml index 69a6a21a..89c297ff 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationBound.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationBound.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: percentile description: The percentile of the bound. + defaultValue: None types: - - name: value description: The value of the bound. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationEntry.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationEntry.yml index 1d547714..d23577c8 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationEntry.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationEntry.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: timestamp description: The timestamp. + defaultValue: None types: - - name: value description: The value. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationResult.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationResult.yml index d3a53264..4a8921d7 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.models.UtilizationResult.yml @@ -11,18 +11,22 @@ constructor: keywordOnlyParameters: - name: process description: Process name, or '_total' for all processes. + defaultValue: None types: - - name: upper_bound description: Upper bound. + defaultValue: None types: - - name: lower_bound description: Lower bound. + defaultValue: None types: - - name: utilization description: Utilization data. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.BillingHubServiceOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.BillingHubServiceOperations.yml index 8c99b4be..d6803b64 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.BillingHubServiceOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.BillingHubServiceOperations.yml @@ -59,7 +59,7 @@ methods: - - name: get_usage_request description: Is either a model type or a IO type. Default value is None. - isRequired: true + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.PackagesOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.PackagesOperations.yml index 136e035a..6459eac6 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.PackagesOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.PackagesOperations.yml @@ -397,7 +397,7 @@ methods: Run. Is either a model type or a IO type. Default value is None.' - isRequired: true + defaultValue: None types: - - diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestBaseAccountsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestBaseAccountsOperations.yml index da269927..4012e373 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestBaseAccountsOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestBaseAccountsOperations.yml @@ -45,7 +45,7 @@ methods: which were soft deleted before. Default value is None.' - isRequired: true + defaultValue: None types: - keywordOnlyParameters: @@ -358,7 +358,7 @@ methods: Is either a model type or a IO type. Default value is None.' - isRequired: true + defaultValue: None types: - - @@ -397,7 +397,7 @@ methods: which were soft deleted before. Default value is None.' - isRequired: true + defaultValue: None types: - keywordOnlyParameters: @@ -426,7 +426,7 @@ methods: which were soft deleted before. Default value is None.' - isRequired: true + defaultValue: None types: - keywordOnlyParameters: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestResultsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestResultsOperations.yml index 2d367eda..6ce11955 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestResultsOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.TestResultsOperations.yml @@ -227,7 +227,7 @@ methods: - - name: filter description: Odata filter. Default value is None. - isRequired: true + defaultValue: None types: - keywordOnlyParameters: diff --git a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.UsageOperations.yml b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.UsageOperations.yml index eba3914f..6a76dfc6 100644 --- a/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.UsageOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-testbase/azure.mgmt.testbase.operations.UsageOperations.yml @@ -29,7 +29,7 @@ methods: - - name: filter description: Odata filter. Default value is None. - isRequired: true + defaultValue: None types: - keywordOnlyParameters: diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyEntity.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyEntity.yml index ee0f8ef9..a7989300 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyEntity.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyEntity.yml @@ -28,9 +28,9 @@ constructor: - keywordOnlyParameters: - name: role - isRequired: true + defaultValue: None - name: authentication - isRequired: true + defaultValue: None variables: - description: 'Fully qualified resource ID for the resource. Ex - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyEntityCollection.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyEntityCollection.yml index 11067131..ea5887b1 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyEntityCollection.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccessPolicyEntityCollection.yml @@ -23,6 +23,6 @@ constructor: - keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: next_link - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccountEncryption.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccountEncryption.yml index 58162592..9d77217f 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccountEncryption.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AccountEncryption.yml @@ -37,9 +37,9 @@ constructor: - name: type isRequired: true - name: key_vault_properties - isRequired: true + defaultValue: None - name: identity - isRequired: true + defaultValue: None variables: - description: The current status of the Key Vault mapping. name: status diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AudioEncoderAac.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AudioEncoderAac.yml index 072fb46c..8c004499 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AudioEncoderAac.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AudioEncoderAac.yml @@ -29,4 +29,4 @@ constructor: - keywordOnlyParameters: - name: bitrate_kbps - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AudioEncoderBase.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AudioEncoderBase.yml index e302b80c..0605b367 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AudioEncoderBase.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.AudioEncoderBase.yml @@ -35,4 +35,4 @@ constructor: - keywordOnlyParameters: - name: bitrate_kbps - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CheckNameAvailabilityRequest.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CheckNameAvailabilityRequest.yml index c14d6358..96f11e3e 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CheckNameAvailabilityRequest.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CheckNameAvailabilityRequest.yml @@ -20,6 +20,6 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CheckNameAvailabilityResponse.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CheckNameAvailabilityResponse.yml index 6d642550..c9efaede 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CheckNameAvailabilityResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.CheckNameAvailabilityResponse.yml @@ -29,8 +29,8 @@ constructor: - keywordOnlyParameters: - name: name_available - isRequired: true + defaultValue: None - name: reason - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EdgeModuleEntityCollection.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EdgeModuleEntityCollection.yml index d70f752b..29eb0b4a 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EdgeModuleEntityCollection.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EdgeModuleEntityCollection.yml @@ -23,6 +23,6 @@ constructor: - keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: next_link - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderCustomPreset.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderCustomPreset.yml index c5d4135b..66fa38de 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderCustomPreset.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EncoderCustomPreset.yml @@ -30,6 +30,6 @@ constructor: - keywordOnlyParameters: - name: audio_encoder - isRequired: true + defaultValue: None - name: video_encoder - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Endpoint.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Endpoint.yml index b9e33a84..698e903d 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Endpoint.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Endpoint.yml @@ -26,4 +26,4 @@ constructor: - name: type isRequired: true - name: endpoint_url - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EndpointBase.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EndpointBase.yml index 8dec43c0..0e4789f3 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EndpointBase.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.EndpointBase.yml @@ -47,4 +47,4 @@ constructor: - name: url isRequired: true - name: tunnel - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ErrorResponse.yml index 8f86de4a..f91e1a33 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ErrorResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ErrorResponse.yml @@ -15,4 +15,4 @@ constructor: - keywordOnlyParameters: - name: error - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.GroupLevelAccessControl.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.GroupLevelAccessControl.yml index 8138f91f..0b3a9bee 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.GroupLevelAccessControl.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.GroupLevelAccessControl.yml @@ -19,4 +19,4 @@ constructor: - keywordOnlyParameters: - name: public_network_access - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.JwtAuthentication.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.JwtAuthentication.yml index 31a2bbc9..f0d03b52 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.JwtAuthentication.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.JwtAuthentication.yml @@ -55,10 +55,10 @@ constructor: - [] keywordOnlyParameters: - name: issuers - isRequired: true + defaultValue: None - name: audiences - isRequired: true + defaultValue: None - name: claims - isRequired: true + defaultValue: None - name: keys - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipeline.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipeline.yml index 70585783..6d5e3fc8 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipeline.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipeline.yml @@ -64,13 +64,13 @@ constructor: - [] keywordOnlyParameters: - name: topology_name - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: bitrate_kbps - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None variables: - description: 'Fully qualified resource ID for the resource. Ex - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineCollection.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineCollection.yml index 7e86252c..3ee588ab 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineCollection.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineCollection.yml @@ -23,6 +23,6 @@ constructor: - keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: next_link - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineUpdate.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineUpdate.yml index efe1e32e..def181b7 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineUpdate.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.LivePipelineUpdate.yml @@ -64,13 +64,13 @@ constructor: - [] keywordOnlyParameters: - name: topology_name - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: bitrate_kbps - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None variables: - description: 'Fully qualified resource ID for the resource. Ex - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.MetricSpecification.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.MetricSpecification.yml index c30cb745..2aea0c75 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.MetricSpecification.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.MetricSpecification.yml @@ -18,7 +18,7 @@ constructor: - [] keywordOnlyParameters: - name: supported_aggregation_types - isRequired: true + defaultValue: None variables: - description: The metric name. name: name diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.NetworkAccessControl.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.NetworkAccessControl.yml index 39502130..ca3dd681 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.NetworkAccessControl.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.NetworkAccessControl.yml @@ -26,8 +26,8 @@ constructor: - keywordOnlyParameters: - name: integration - isRequired: true + defaultValue: None - name: ingestion - isRequired: true + defaultValue: None - name: consumption - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Operation.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Operation.yml index a01a7fe7..12b34fa4 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Operation.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.Operation.yml @@ -47,12 +47,12 @@ constructor: - name: name isRequired: true - name: display - isRequired: true + defaultValue: None - name: origin - isRequired: true + defaultValue: None - name: properties - isRequired: true + defaultValue: None - name: is_data_action - isRequired: true + defaultValue: None - name: action_type - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.OperationCollection.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.OperationCollection.yml index 9373f6d7..b9f4e753 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.OperationCollection.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.OperationCollection.yml @@ -14,4 +14,4 @@ constructor: - [] keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.OperationDisplay.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.OperationDisplay.yml index f916625a..8ebf5c4a 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.OperationDisplay.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.OperationDisplay.yml @@ -30,10 +30,10 @@ constructor: - keywordOnlyParameters: - name: provider - isRequired: true + defaultValue: None - name: resource - isRequired: true + defaultValue: None - name: operation - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ParameterDeclaration.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ParameterDeclaration.yml index 12d223ef..a0d7a06f 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ParameterDeclaration.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ParameterDeclaration.yml @@ -45,6 +45,6 @@ constructor: - name: type isRequired: true - name: description - isRequired: true + defaultValue: None - name: default - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ParameterDefinition.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ParameterDefinition.yml index 4efa6b06..0ee168b2 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ParameterDefinition.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.ParameterDefinition.yml @@ -25,4 +25,4 @@ constructor: - name: name isRequired: true - name: value - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJob.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJob.yml index 74b87b94..c710c502 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJob.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJob.yml @@ -41,11 +41,11 @@ constructor: - [] keywordOnlyParameters: - name: topology_name - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None variables: - description: 'Fully qualified resource ID for the resource. Ex - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobCollection.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobCollection.yml index ff7ca1f9..fead6e95 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobCollection.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobCollection.yml @@ -23,6 +23,6 @@ constructor: - keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: next_link - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobError.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobError.yml index 46af0165..d60e2b49 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobError.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobError.yml @@ -20,6 +20,6 @@ constructor: - keywordOnlyParameters: - name: code - isRequired: true + defaultValue: None - name: message - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobUpdate.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobUpdate.yml index c9f9816d..7d651ef2 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobUpdate.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineJobUpdate.yml @@ -41,11 +41,11 @@ constructor: - [] keywordOnlyParameters: - name: topology_name - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None variables: - description: 'Fully qualified resource ID for the resource. Ex - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopology.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopology.yml index 848ce927..da1492ae 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopology.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopology.yml @@ -58,12 +58,12 @@ constructor: - name: sku isRequired: true - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: sources - isRequired: true + defaultValue: None - name: processors - isRequired: true + defaultValue: None - name: sinks - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopologyCollection.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopologyCollection.yml index a2e5443a..8dcf8eda 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopologyCollection.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopologyCollection.yml @@ -23,6 +23,6 @@ constructor: - keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: next_link - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopologyUpdate.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopologyUpdate.yml index 6ce8b132..8bdaacb4 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopologyUpdate.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PipelineTopologyUpdate.yml @@ -52,16 +52,16 @@ constructor: | None = None, sinks: List[SinkNodeBase] | None = None, **kwargs)' keywordOnlyParameters: - name: kind - isRequired: true + defaultValue: None - name: sku - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: sources - isRequired: true + defaultValue: None - name: processors - isRequired: true + defaultValue: None - name: sinks - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointConnection.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointConnection.yml index e47cba2b..0c9ef86c 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointConnection.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointConnection.yml @@ -26,9 +26,9 @@ constructor: - keywordOnlyParameters: - name: private_endpoint - isRequired: true + defaultValue: None - name: private_link_service_connection_state - isRequired: true + defaultValue: None variables: - description: 'Fully qualified resource ID for the resource. Ex - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionListResult.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionListResult.yml index 22d5f269..811f6a99 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateEndpointConnectionListResult.yml @@ -16,4 +16,4 @@ constructor: - [] keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkResource.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkResource.yml index 00de851f..480907e3 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkResource.yml @@ -17,7 +17,7 @@ constructor: - [] keywordOnlyParameters: - name: required_zone_names - isRequired: true + defaultValue: None variables: - description: 'Fully qualified resource ID for the resource. Ex - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkResourceListResult.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkResourceListResult.yml index 95a36cfb..f59b8d76 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkResourceListResult.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkResourceListResult.yml @@ -15,4 +15,4 @@ constructor: - [] keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkServiceConnectionState.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkServiceConnectionState.yml index abd13d17..ae415475 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkServiceConnectionState.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.PrivateLinkServiceConnectionState.yml @@ -34,8 +34,8 @@ constructor: - keywordOnlyParameters: - name: status - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: actions_required - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.RtspSource.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.RtspSource.yml index 581d0723..0bb3a6f0 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.RtspSource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.RtspSource.yml @@ -58,4 +58,4 @@ constructor: - name: endpoint isRequired: true - name: transport - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.StorageAccount.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.StorageAccount.yml index cca969fc..f129fcd2 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.StorageAccount.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.StorageAccount.yml @@ -34,7 +34,7 @@ constructor: - name: id isRequired: true - name: identity - isRequired: true + defaultValue: None variables: - description: The current status of the storage account mapping. name: status diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SystemData.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SystemData.yml index 32c1be0b..c6c63012 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SystemData.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.SystemData.yml @@ -48,14 +48,14 @@ constructor: - keywordOnlyParameters: - name: created_by - isRequired: true + defaultValue: None - name: created_by_type - isRequired: true + defaultValue: None - name: created_at - isRequired: true + defaultValue: None - name: last_modified_by - isRequired: true + defaultValue: None - name: last_modified_by_type - isRequired: true + defaultValue: None - name: last_modified_at - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TlsEndpoint.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TlsEndpoint.yml index 09ee2d39..1e53eb3b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TlsEndpoint.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TlsEndpoint.yml @@ -62,8 +62,8 @@ constructor: - name: url isRequired: true - name: tunnel - isRequired: true + defaultValue: None - name: trusted_certificates - isRequired: true + defaultValue: None - name: validation_options - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TlsValidationOptions.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TlsValidationOptions.yml index 6fa7ec45..2baec4a5 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TlsValidationOptions.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TlsValidationOptions.yml @@ -26,6 +26,6 @@ constructor: - keywordOnlyParameters: - name: ignore_hostname - isRequired: true + defaultValue: None - name: ignore_signature - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TrackedResource.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TrackedResource.yml index 104d5db1..1333e5cd 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TrackedResource.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.TrackedResource.yml @@ -28,7 +28,7 @@ constructor: - name: location isRequired: true - name: tags - isRequired: true + defaultValue: None variables: - description: 'Fully qualified resource ID for the resource. Ex - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.UnsecuredEndpoint.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.UnsecuredEndpoint.yml index bd6a0de1..b6dc03c5 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.UnsecuredEndpoint.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.UnsecuredEndpoint.yml @@ -43,4 +43,4 @@ constructor: - name: url isRequired: true - name: tunnel - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzer.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzer.yml index 95f003c0..2dbd9a23 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzer.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzer.yml @@ -64,19 +64,19 @@ constructor: - name: location isRequired: true - name: tags - isRequired: true + defaultValue: None - name: identity - isRequired: true + defaultValue: None - name: storage_accounts - isRequired: true + defaultValue: None - name: encryption - isRequired: true + defaultValue: None - name: iot_hubs - isRequired: true + defaultValue: None - name: public_network_access - isRequired: true + defaultValue: None - name: network_access_control - isRequired: true + defaultValue: None variables: - description: 'Fully qualified resource ID for the resource. Ex - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerCollection.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerCollection.yml index 38f37a2a..222b4666 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerCollection.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerCollection.yml @@ -14,4 +14,4 @@ constructor: - [] keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerIdentity.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerIdentity.yml index 1deee509..946d9705 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerIdentity.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerIdentity.yml @@ -25,4 +25,4 @@ constructor: - name: type isRequired: true - name: user_assigned_identities - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerOperationStatus.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerOperationStatus.yml index 057fc6ee..3d8ed34f 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerOperationStatus.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerOperationStatus.yml @@ -46,12 +46,12 @@ constructor: - name: name isRequired: true - name: id - isRequired: true + defaultValue: None - name: start_time - isRequired: true + defaultValue: None - name: end_time - isRequired: true + defaultValue: None - name: status - isRequired: true + defaultValue: None - name: error - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerPrivateEndpointConnectionOperationStatus.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerPrivateEndpointConnectionOperationStatus.yml index 9303c626..60faefb5 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerPrivateEndpointConnectionOperationStatus.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerPrivateEndpointConnectionOperationStatus.yml @@ -46,12 +46,12 @@ constructor: - name: name isRequired: true - name: id - isRequired: true + defaultValue: None - name: start_time - isRequired: true + defaultValue: None - name: end_time - isRequired: true + defaultValue: None - name: status - isRequired: true + defaultValue: None - name: error - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerUpdate.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerUpdate.yml index 780d7f6b..2c649163 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerUpdate.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoAnalyzerUpdate.yml @@ -54,19 +54,19 @@ constructor: - keywordOnlyParameters: - name: tags - isRequired: true + defaultValue: None - name: identity - isRequired: true + defaultValue: None - name: storage_accounts - isRequired: true + defaultValue: None - name: encryption - isRequired: true + defaultValue: None - name: iot_hubs - isRequired: true + defaultValue: None - name: public_network_access - isRequired: true + defaultValue: None - name: network_access_control - isRequired: true + defaultValue: None variables: - description: The endpoints associated with this resource. name: endpoints diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoArchival.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoArchival.yml index 4e16424b..65b6a9c0 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoArchival.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoArchival.yml @@ -26,4 +26,4 @@ constructor: - keywordOnlyParameters: - name: retention_period - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoContentUrls.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoContentUrls.yml index a30dcf17..a90cbadd 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoContentUrls.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoContentUrls.yml @@ -72,10 +72,10 @@ constructor: - keywordOnlyParameters: - name: download_url - isRequired: true + defaultValue: None - name: archive_base_url - isRequired: true + defaultValue: None - name: rtsp_tunnel_url - isRequired: true + defaultValue: None - name: preview_image_urls - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoCreationProperties.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoCreationProperties.yml index e05ba0b4..72360fd3 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoCreationProperties.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoCreationProperties.yml @@ -67,10 +67,10 @@ constructor: - keywordOnlyParameters: - name: title - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: segment_length - isRequired: true + defaultValue: None - name: retention_period - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEncoderBase.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEncoderBase.yml index 70c02562..cb2f6e23 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEncoderBase.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEncoderBase.yml @@ -55,8 +55,8 @@ constructor: - keywordOnlyParameters: - name: bitrate_kbps - isRequired: true + defaultValue: None - name: frame_rate - isRequired: true + defaultValue: None - name: scale - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEncoderH264.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEncoderH264.yml index ab7b9417..4b43a31b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEncoderH264.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEncoderH264.yml @@ -49,8 +49,8 @@ constructor: - keywordOnlyParameters: - name: bitrate_kbps - isRequired: true + defaultValue: None - name: frame_rate - isRequired: true + defaultValue: None - name: scale - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEntity.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEntity.yml index 107ef7b0..18ad259d 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEntity.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEntity.yml @@ -44,13 +44,13 @@ constructor: - keywordOnlyParameters: - name: title - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: media_info - isRequired: true + defaultValue: None - name: archival - isRequired: true + defaultValue: None variables: - description: 'Fully qualified resource ID for the resource. Ex - diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEntityCollection.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEntityCollection.yml index aa3942c0..32dcc687 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEntityCollection.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoEntityCollection.yml @@ -23,6 +23,6 @@ constructor: - keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: next_link - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoMediaInfo.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoMediaInfo.yml index b2509a27..f8e56af0 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoMediaInfo.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoMediaInfo.yml @@ -28,4 +28,4 @@ constructor: - keywordOnlyParameters: - name: segment_length - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoPreviewImageUrls.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoPreviewImageUrls.yml index 11936e7a..4f548bdb 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoPreviewImageUrls.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoPreviewImageUrls.yml @@ -28,8 +28,8 @@ constructor: - keywordOnlyParameters: - name: small - isRequired: true + defaultValue: None - name: medium - isRequired: true + defaultValue: None - name: large - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoPublishingOptions.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoPublishingOptions.yml index f22461a0..9ad9bd25 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoPublishingOptions.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoPublishingOptions.yml @@ -36,6 +36,6 @@ constructor: - keywordOnlyParameters: - name: disable_archive - isRequired: true + defaultValue: None - name: disable_rtsp_publishing - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoScale.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoScale.yml index 0302c030..792ea1d6 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoScale.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoScale.yml @@ -35,8 +35,8 @@ constructor: - keywordOnlyParameters: - name: height - isRequired: true + defaultValue: None - name: width - isRequired: true + defaultValue: None - name: mode - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoSink.yml b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoSink.yml index 71aa2531..3c64c87b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoSink.yml +++ b/previous/docs-ref-autogen/azure-mgmt-videoanalyzer/azure.mgmt.videoanalyzer.models.VideoSink.yml @@ -69,6 +69,6 @@ constructor: - name: video_name isRequired: true - name: video_creation_properties - isRequired: true + defaultValue: None - name: video_publishing_options - isRequired: true + defaultValue: None diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.operations.HealthMonitorsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.operations.HealthMonitorsOperations.yml index dbcbf39e..76ffb299 100644 --- a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.operations.HealthMonitorsOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.aio.operations.HealthMonitorsOperations.yml @@ -63,7 +63,7 @@ methods: Example: $expand=evidence,configuration. Default value is None.' - isRequired: true + defaultValue: None types: - keywordOnlyParameters: @@ -136,7 +136,7 @@ methods: Example: $expand=evidence,configuration. Default value is None.' - isRequired: true + defaultValue: None types: - keywordOnlyParameters: @@ -204,7 +204,7 @@ methods: eq ''logical-disks|C:>>|< - name: expand @@ -212,7 +212,7 @@ methods: Example: $expand=evidence,configuration. Default value is None.' - isRequired: true + defaultValue: None types: - keywordOnlyParameters: @@ -288,7 +288,7 @@ methods: eq false. Default value is None.' - isRequired: true + defaultValue: None types: - - name: expand @@ -296,17 +296,17 @@ methods: Example: $expand=evidence,configuration. Default value is None.' - isRequired: true + defaultValue: None types: - - name: start_timestamp_utc description: The start of the time window. Default value is None. - isRequired: true + defaultValue: None types: - - name: end_timestamp_utc description: The end of the time window. Default value is None. - isRequired: true + defaultValue: None types: - keywordOnlyParameters: diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorDetails.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorDetails.yml index cb9c20fb..1c6f132b 100644 --- a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorDetails.yml +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorDetails.yml @@ -9,10 +9,12 @@ constructor: keywordOnlyParameters: - name: code description: Error code identifying the specific error. + defaultValue: None types: - - name: message description: A human-readable error message. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorResponse.yml index aed6f9e3..d84cc1d2 100644 --- a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorResponse.yml +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorResponse.yml @@ -9,6 +9,7 @@ constructor: keywordOnlyParameters: - name: error description: Error info. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorResponseError.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorResponseError.yml index 83e7b284..78324008 100644 --- a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorResponseError.yml +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.ErrorResponseError.yml @@ -13,14 +13,17 @@ constructor: the HTTP error code specified in the response.' + defaultValue: None types: - - name: message description: Human-readable representation of the error. + defaultValue: None types: - - name: details description: Error details. + defaultValue: None types: - [] variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitor.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitor.yml index e8c38152..bc48e0f0 100644 --- a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitor.yml +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitor.yml @@ -17,42 +17,51 @@ constructor: keywordOnlyParameters: - name: monitor_name description: Human-readable name of the monitor. + defaultValue: None types: - - name: monitor_type description: Type of the monitor. + defaultValue: None types: - - name: monitored_object description: Dynamic monitored object of the monitor. + defaultValue: None types: - - name: parent_monitor_name description: Name of the parent monitor. + defaultValue: None types: - - name: evaluation_timestamp description: Timestamp of the monitor's last health evaluation. + defaultValue: None types: - - name: current_state_first_observed_timestamp description: 'Timestamp of the monitor''s last health state change.' + defaultValue: None types: - - name: last_reported_timestamp description: Timestamp of the monitor's last reported health state. + defaultValue: None types: - - name: evidence description: Evidence validating the monitor's current health state. + defaultValue: None types: - - name: monitor_configuration description: 'The configuration settings at the time of the monitor''s health evaluation.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorList.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorList.yml index b6cf7451..7a68d320 100644 --- a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorList.yml +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorList.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: value description: Array of health monitors of the virtual machine. + defaultValue: None types: - [] - name: next_link description: Link to next page if the list is too long. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorStateChange.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorStateChange.yml index 9bbeb856..f0f83a8f 100644 --- a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorStateChange.yml +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorStateChange.yml @@ -16,34 +16,41 @@ constructor: keywordOnlyParameters: - name: monitor_name description: Human-readable name of the monitor. + defaultValue: None types: - - name: monitor_type description: Type of the monitor. + defaultValue: None types: - - name: monitored_object description: Dynamic monitored object of the monitor. + defaultValue: None types: - - name: evaluation_timestamp description: Timestamp of the monitor's last health evaluation. + defaultValue: None types: - - name: current_state_first_observed_timestamp description: 'Timestamp of the monitor''s last health state change.' + defaultValue: None types: - - name: evidence description: Evidence validating the monitor's current health state. + defaultValue: None types: - - name: monitor_configuration description: 'The configuration settings at the time of the monitor''s health evaluation.' + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorStateChangeList.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorStateChangeList.yml index 0c97da22..b57c750e 100644 --- a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorStateChangeList.yml +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.HealthMonitorStateChangeList.yml @@ -11,10 +11,12 @@ constructor: keywordOnlyParameters: - name: value description: Array of health state changes within the specified time window. + defaultValue: None types: - [] - name: next_link description: Link to next page if the list is too long. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.OperationList.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.OperationList.yml index 752dff73..7b10ffc0 100644 --- a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.OperationList.yml +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.models.OperationList.yml @@ -10,10 +10,12 @@ constructor: keywordOnlyParameters: - name: value description: Array of available REST API operations. + defaultValue: None types: - [] - name: next_link description: Link to next page if the list is too long. + defaultValue: None types: - variables: diff --git a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.operations.HealthMonitorsOperations.yml b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.operations.HealthMonitorsOperations.yml index 1eb677b0..a381a4bf 100644 --- a/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.operations.HealthMonitorsOperations.yml +++ b/previous/docs-ref-autogen/azure-mgmt-workloadmonitor/azure.mgmt.workloadmonitor.operations.HealthMonitorsOperations.yml @@ -63,7 +63,7 @@ methods: Example: $expand=evidence,configuration. Default value is None.' - isRequired: true + defaultValue: None types: - keywordOnlyParameters: @@ -136,7 +136,7 @@ methods: Example: $expand=evidence,configuration. Default value is None.' - isRequired: true + defaultValue: None types: - keywordOnlyParameters: @@ -204,7 +204,7 @@ methods: eq ''logical-disks|C:>>|< - name: expand @@ -212,7 +212,7 @@ methods: Example: $expand=evidence,configuration. Default value is None.' - isRequired: true + defaultValue: None types: - keywordOnlyParameters: @@ -288,7 +288,7 @@ methods: eq false. Default value is None.' - isRequired: true + defaultValue: None types: - - name: expand @@ -296,17 +296,17 @@ methods: Example: $expand=evidence,configuration. Default value is None.' - isRequired: true + defaultValue: None types: - - name: start_timestamp_utc description: The start of the time window. Default value is None. - isRequired: true + defaultValue: None types: - - name: end_timestamp_utc description: The end of the time window. Default value is None. - isRequired: true + defaultValue: None types: - keywordOnlyParameters: diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.EntityOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.EntityOperations.yml index bf42b39b..721e55e8 100644 --- a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.EntityOperations.yml +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.EntityOperations.yml @@ -112,6 +112,7 @@ methods: keywordOnlyParameters: - name: attr_qualified_name description: The qualified name of the entity. Default value is None. + defaultValue: None types: - return: @@ -156,7 +157,7 @@ methods: - - name: body description: set of labels to be added. Default value is None. - isRequired: true + defaultValue: None types: - [] return: @@ -198,12 +199,13 @@ methods: - - name: body description: set of labels to be added. Default value is None. - isRequired: true + defaultValue: None types: - [] keywordOnlyParameters: - name: attr_qualified_name description: The qualified name of the entity. Default value is None. + defaultValue: None types: - return: @@ -231,7 +233,7 @@ methods: - - name: body description: Business Metadata. Default value is None. - isRequired: true + defaultValue: None types: - [, ] keywordOnlyParameters: @@ -240,6 +242,7 @@ methods: or not, default is false.' + defaultValue: None types: - return: @@ -272,7 +275,7 @@ methods: - - name: body description: BusinessMetadataAttributes. Default value is None. - isRequired: true + defaultValue: None types: - [, ] return: @@ -916,7 +919,7 @@ methods: - - name: body description: BusinessMetadata. Default value is None. - isRequired: true + defaultValue: None types: - [, ] return: @@ -949,7 +952,7 @@ methods: - - name: body description: BusinessMetadataAttributes. Default value is None. - isRequired: true + defaultValue: None types: - [, ] return: @@ -1284,6 +1287,7 @@ methods: keywordOnlyParameters: - name: attr_qualified_name description: The qualified name of the entity. Default value is None. + defaultValue: None types: - return: @@ -1465,6 +1469,7 @@ methods: keywordOnlyParameters: - name: attr_qualified_name description: The qualified name of the entity. Default value is None. + defaultValue: None types: - return: @@ -1486,7 +1491,7 @@ methods: - - name: body description: set of labels to be deleted. Default value is None. - isRequired: true + defaultValue: None types: - [] return: @@ -1531,12 +1536,13 @@ methods: - - name: body description: set of labels to be deleted. Default value is None. - isRequired: true + defaultValue: None types: - [] keywordOnlyParameters: - name: attr_qualified_name description: The qualified name of the entity. Default value is None. + defaultValue: None types: - return: @@ -1567,12 +1573,14 @@ methods: description: 'Whether to return minimal information for referred entities. Default value is False.' + defaultValue: 'False' types: - - name: ignore_relationships description: 'Whether to ignore relationship attributes. Default value is False.' + defaultValue: 'False' types: - return: @@ -1764,16 +1772,19 @@ methods: description: 'Whether to return minimal information for referred entities. Default value is False.' + defaultValue: 'False' types: - - name: ignore_relationships description: 'Whether to ignore relationship attributes. Default value is False.' + defaultValue: 'False' types: - - name: attr_qualified_name description: The qualified name of the entity. Default value is None. + defaultValue: None types: - return: @@ -2044,12 +2055,14 @@ methods: description: 'Whether to return minimal information for referred entities. Default value is False.' + defaultValue: 'False' types: - - name: ignore_relationships description: 'Whether to ignore relationship attributes. Default value is False.' + defaultValue: 'False' types: - - name: attr_n_qualified_name @@ -2057,6 +2070,7 @@ methods: set attrs_0::. Default value is None.' + defaultValue: None types: - return: @@ -2323,18 +2337,21 @@ methods: description: 'Whether to return minimal information for referred entities. Default value is False.' + defaultValue: 'False' types: - - name: ignore_relationships description: 'Whether to ignore relationship attributes. Default value is False.' + defaultValue: 'False' types: - - name: exclude_relationship_types description: 'An array of the relationship types need to be excluded from the response. Default value is None.' + defaultValue: None types: - [] return: @@ -2577,6 +2594,7 @@ methods: keywordOnlyParameters: - name: attr_qualified_name description: The qualified name of the entity. Default value is None. + defaultValue: None types: - return: @@ -2957,7 +2975,7 @@ methods: - - name: body description: set of labels to be set to the entity. Default value is None. - isRequired: true + defaultValue: None types: - [] return: @@ -2999,12 +3017,13 @@ methods: - - name: body description: set of labels to be set. Default value is None. - isRequired: true + defaultValue: None types: - [] keywordOnlyParameters: - name: attr_qualified_name description: The qualified name of the entity. Default value is None. + defaultValue: None types: - return: @@ -3084,6 +3103,7 @@ methods: keywordOnlyParameters: - name: attr_qualified_name description: The qualified name of the entity. Default value is None. + defaultValue: None types: - return: diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.GlossaryOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.GlossaryOperations.yml index ea4cfdbb..d27bb37c 100644 --- a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.GlossaryOperations.yml +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.GlossaryOperations.yml @@ -63,7 +63,7 @@ methods: isRequired: true keywordOnlyParameters: - name: include_term_hierarchy - isRequired: true + defaultValue: 'False' - uid: azure.purview.catalog.aio.operations.GlossaryOperations.begin_import_glossary_terms_via_csv_by_glossary_name name: begin_import_glossary_terms_via_csv_by_glossary_name summary: Import Glossary Terms from local csv file by glossaryName. @@ -87,6 +87,7 @@ methods: keywordOnlyParameters: - name: include_term_hierarchy description: Whether include term hierarchy. Default value is False. + defaultValue: 'False' types: - - name: continuation_token @@ -558,6 +559,7 @@ methods: keywordOnlyParameters: - name: include_term_hierarchy description: Whether include term hierarchy. Default value is False. + defaultValue: 'False' types: - return: @@ -1028,6 +1030,7 @@ methods: keywordOnlyParameters: - name: include_term_hierarchy description: Whether include term hierarchy. Default value is False. + defaultValue: 'False' types: - return: @@ -1648,6 +1651,7 @@ methods: keywordOnlyParameters: - name: include_term_hierarchy description: Whether include term hierarchy. Default value is False. + defaultValue: 'False' types: - return: @@ -1676,6 +1680,7 @@ methods: keywordOnlyParameters: - name: include_term_hierarchy description: Whether include term hierarchy. Default value is False. + defaultValue: 'False' types: - return: @@ -2102,14 +2107,17 @@ methods: keywordOnlyParameters: - name: limit description: The page size - by default there is no paging. Default value is None. + defaultValue: None types: - - name: offset description: The offset for pagination purpose. Default value is None. + defaultValue: None types: - - name: sort description: The sort order, ASC (default) or DESC. Default value is "ASC". + defaultValue: ASC types: - return: @@ -2299,12 +2307,14 @@ methods: keywordOnlyParameters: - name: include_term_hierarchy description: Whether include term hierarchy. Default value is False. + defaultValue: 'False' types: - - name: exclude_relationship_type_list description: 'An array of relationship types which need to be excluded. Default value is None.' + defaultValue: None types: - [] return: @@ -2588,14 +2598,17 @@ methods: keywordOnlyParameters: - name: limit description: The page size - by default there is no paging. Default value is None. + defaultValue: None types: - - name: offset description: The offset for pagination purpose. Default value is None. + defaultValue: None types: - - name: sort description: The sort order, ASC (default) or DESC. Default value is "ASC". + defaultValue: ASC types: - return: @@ -2628,20 +2641,24 @@ methods: keywordOnlyParameters: - name: limit description: The page size - by default there is no paging. Default value is None. + defaultValue: None types: - - name: offset description: The offset for pagination purpose. Default value is None. + defaultValue: None types: - - name: sort description: The sort order, ASC (default) or DESC. Default value is "ASC". + defaultValue: ASC types: - - name: ignore_terms_and_categories description: 'Whether ignore terms and categories. Default value is False.' + defaultValue: 'False' types: - return: @@ -2722,14 +2739,17 @@ methods: keywordOnlyParameters: - name: limit description: The page size - by default there is no paging. Default value is None. + defaultValue: None types: - - name: offset description: The offset for pagination purpose. Default value is None. + defaultValue: None types: - - name: sort description: The sort order, ASC (default) or DESC. Default value is "ASC". + defaultValue: ASC types: - return: @@ -2819,14 +2839,17 @@ methods: keywordOnlyParameters: - name: limit description: The page size - by default there is no paging. Default value is None. + defaultValue: None types: - - name: offset description: The offset for pagination purpose. Default value is None. + defaultValue: None types: - - name: sort description: The sort order, ASC (default) or DESC. Default value is "ASC". + defaultValue: ASC types: - return: @@ -2861,14 +2884,17 @@ methods: keywordOnlyParameters: - name: limit description: The page size - by default there is no paging. Default value is None. + defaultValue: None types: - - name: offset description: The offset for pagination purpose. Default value is None. + defaultValue: None types: - - name: sort description: The sort order, ASC (default) or DESC. Default value is "ASC". + defaultValue: ASC types: - return: @@ -2907,18 +2933,22 @@ methods: keywordOnlyParameters: - name: include_term_hierarchy description: Whether include term hierarchy. Default value is False. + defaultValue: 'False' types: - - name: limit description: The page size - by default there is no paging. Default value is None. + defaultValue: None types: - - name: offset description: The offset for pagination purpose. Default value is None. + defaultValue: None types: - - name: sort description: The sort order, ASC (default) or DESC. Default value is "ASC". + defaultValue: ASC types: - return: @@ -3197,14 +3227,17 @@ methods: keywordOnlyParameters: - name: limit description: The page size - by default there is no paging. Default value is None. + defaultValue: None types: - - name: offset description: The offset for pagination purpose. Default value is None. + defaultValue: None types: - - name: sort description: The sort order, ASC (default) or DESC. Default value is "ASC". + defaultValue: ASC types: - return: @@ -3243,14 +3276,17 @@ methods: keywordOnlyParameters: - name: limit description: The page size - by default there is no paging. Default value is None. + defaultValue: None types: - - name: offset description: The offset for pagination purpose. Default value is None. + defaultValue: None types: - - name: sort description: The sort order, ASC (default) or DESC. Default value is "ASC". + defaultValue: ASC types: - return: @@ -3290,14 +3326,17 @@ methods: keywordOnlyParameters: - name: limit description: The page size - by default there is no paging. Default value is None. + defaultValue: None types: - - name: offset description: The offset for pagination purpose. Default value is None. + defaultValue: None types: - - name: include_term_hierarchy description: Whether include term hierarchy. Default value is False. + defaultValue: 'False' types: - return: @@ -3583,6 +3622,7 @@ methods: keywordOnlyParameters: - name: include_term_hierarchy description: Whether include term hierarchy. Default value is False. + defaultValue: 'False' types: - return: @@ -3752,6 +3792,7 @@ methods: keywordOnlyParameters: - name: include_term_hierarchy description: Whether include term hierarchy. Default value is False. + defaultValue: 'False' types: - return: @@ -4310,6 +4351,7 @@ methods: keywordOnlyParameters: - name: include_term_hierarchy description: Whether include term hierarchy. Default value is False. + defaultValue: 'False' types: - return: diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.LineageOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.LineageOperations.yml index 5a526e92..e0757cc1 100644 --- a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.LineageOperations.yml +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.LineageOperations.yml @@ -44,10 +44,12 @@ methods: - - name: depth description: The number of hops for lineage. Default value is 3. + defaultValue: '3' types: - - name: width description: The number of max expanding width in lineage. Default value is 10. + defaultValue: '10' types: - - name: include_parent @@ -55,12 +57,14 @@ methods: is None.' + defaultValue: None types: - - name: get_derived_lineage description: 'True to include derived lineage in the response. Default value is None.' + defaultValue: None types: - return: @@ -172,10 +176,12 @@ methods: - - name: depth description: The number of hops for lineage. Default value is 3. + defaultValue: '3' types: - - name: width description: The number of max expanding width in lineage. Default value is 10. + defaultValue: '10' types: - - name: include_parent @@ -183,12 +189,14 @@ methods: is None.' + defaultValue: None types: - - name: get_derived_lineage description: 'True to include derived lineage in the response. Default value is None.' + defaultValue: None types: - return: @@ -302,14 +310,17 @@ methods: description: 'True to include derived lineage in the response. Default value is None.' + defaultValue: None types: - - name: offset description: The offset for pagination purpose. Default value is None. + defaultValue: None types: - - name: limit description: The page size - by default there is no paging. Default value is None. + defaultValue: None types: - return: diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.RelationshipOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.RelationshipOperations.yml index 4d177805..e941dbcc 100644 --- a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.RelationshipOperations.yml +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.RelationshipOperations.yml @@ -108,6 +108,7 @@ methods: keywordOnlyParameters: - name: extended_info description: Limits whether includes extended information. Default value is None. + defaultValue: None types: - return: diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.TypesOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.TypesOperations.yml index 239c3630..e120d4af 100644 --- a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.TypesOperations.yml +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.aio.operations.TypesOperations.yml @@ -2042,6 +2042,7 @@ methods: This is always true when search filter type=term_template. Default value is False.' + defaultValue: 'False' types: - - name: type @@ -2052,6 +2053,7 @@ methods: value is None.' + defaultValue: None types: - return: @@ -4427,6 +4429,7 @@ methods: This is always true when search filter type=term_template. Default value is False.' + defaultValue: 'False' types: - - name: type @@ -4437,6 +4440,7 @@ methods: value is None.' + defaultValue: None types: - return: diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.EntityOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.EntityOperations.yml index 94a912cb..6131dab4 100644 --- a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.EntityOperations.yml +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.EntityOperations.yml @@ -112,6 +112,7 @@ methods: keywordOnlyParameters: - name: attr_qualified_name description: The qualified name of the entity. Default value is None. + defaultValue: None types: - return: @@ -156,7 +157,7 @@ methods: - - name: body description: set of labels to be added. Default value is None. - isRequired: true + defaultValue: None types: - [] return: @@ -198,12 +199,13 @@ methods: - - name: body description: set of labels to be added. Default value is None. - isRequired: true + defaultValue: None types: - [] keywordOnlyParameters: - name: attr_qualified_name description: The qualified name of the entity. Default value is None. + defaultValue: None types: - return: @@ -231,7 +233,7 @@ methods: - - name: body description: Business Metadata. Default value is None. - isRequired: true + defaultValue: None types: - [, ] keywordOnlyParameters: @@ -240,6 +242,7 @@ methods: or not, default is false.' + defaultValue: None types: - return: @@ -272,7 +275,7 @@ methods: - - name: body description: BusinessMetadataAttributes. Default value is None. - isRequired: true + defaultValue: None types: - [, ] return: @@ -916,7 +919,7 @@ methods: - - name: body description: BusinessMetadata. Default value is None. - isRequired: true + defaultValue: None types: - [, ] return: @@ -949,7 +952,7 @@ methods: - - name: body description: BusinessMetadataAttributes. Default value is None. - isRequired: true + defaultValue: None types: - [, ] return: @@ -1283,6 +1286,7 @@ methods: keywordOnlyParameters: - name: attr_qualified_name description: The qualified name of the entity. Default value is None. + defaultValue: None types: - return: @@ -1464,6 +1468,7 @@ methods: keywordOnlyParameters: - name: attr_qualified_name description: The qualified name of the entity. Default value is None. + defaultValue: None types: - return: @@ -1485,7 +1490,7 @@ methods: - - name: body description: set of labels to be deleted. Default value is None. - isRequired: true + defaultValue: None types: - [] return: @@ -1530,12 +1535,13 @@ methods: - - name: body description: set of labels to be deleted. Default value is None. - isRequired: true + defaultValue: None types: - [] keywordOnlyParameters: - name: attr_qualified_name description: The qualified name of the entity. Default value is None. + defaultValue: None types: - return: @@ -1566,12 +1572,14 @@ methods: description: 'Whether to return minimal information for referred entities. Default value is False.' + defaultValue: 'False' types: - - name: ignore_relationships description: 'Whether to ignore relationship attributes. Default value is False.' + defaultValue: 'False' types: - return: @@ -1763,16 +1771,19 @@ methods: description: 'Whether to return minimal information for referred entities. Default value is False.' + defaultValue: 'False' types: - - name: ignore_relationships description: 'Whether to ignore relationship attributes. Default value is False.' + defaultValue: 'False' types: - - name: attr_qualified_name description: The qualified name of the entity. Default value is None. + defaultValue: None types: - return: @@ -2043,12 +2054,14 @@ methods: description: 'Whether to return minimal information for referred entities. Default value is False.' + defaultValue: 'False' types: - - name: ignore_relationships description: 'Whether to ignore relationship attributes. Default value is False.' + defaultValue: 'False' types: - - name: attr_n_qualified_name @@ -2056,6 +2069,7 @@ methods: set attrs_0::. Default value is None.' + defaultValue: None types: - return: @@ -2321,18 +2335,21 @@ methods: description: 'Whether to return minimal information for referred entities. Default value is False.' + defaultValue: 'False' types: - - name: ignore_relationships description: 'Whether to ignore relationship attributes. Default value is False.' + defaultValue: 'False' types: - - name: exclude_relationship_types description: 'An array of the relationship types need to be excluded from the response. Default value is None.' + defaultValue: None types: - [] return: @@ -2575,6 +2592,7 @@ methods: keywordOnlyParameters: - name: attr_qualified_name description: The qualified name of the entity. Default value is None. + defaultValue: None types: - return: @@ -2955,7 +2973,7 @@ methods: - - name: body description: set of labels to be set to the entity. Default value is None. - isRequired: true + defaultValue: None types: - [] return: @@ -2997,12 +3015,13 @@ methods: - - name: body description: set of labels to be set. Default value is None. - isRequired: true + defaultValue: None types: - [] keywordOnlyParameters: - name: attr_qualified_name description: The qualified name of the entity. Default value is None. + defaultValue: None types: - return: @@ -3082,6 +3101,7 @@ methods: keywordOnlyParameters: - name: attr_qualified_name description: The qualified name of the entity. Default value is None. + defaultValue: None types: - return: diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.GlossaryOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.GlossaryOperations.yml index e8f01801..10604bd3 100644 --- a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.GlossaryOperations.yml +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.GlossaryOperations.yml @@ -63,7 +63,7 @@ methods: isRequired: true keywordOnlyParameters: - name: include_term_hierarchy - isRequired: true + defaultValue: 'False' - uid: azure.purview.catalog.operations.GlossaryOperations.begin_import_glossary_terms_via_csv_by_glossary_name name: begin_import_glossary_terms_via_csv_by_glossary_name summary: Import Glossary Terms from local csv file by glossaryName. @@ -87,6 +87,7 @@ methods: keywordOnlyParameters: - name: include_term_hierarchy description: Whether include term hierarchy. Default value is False. + defaultValue: 'False' types: - - name: continuation_token @@ -557,6 +558,7 @@ methods: keywordOnlyParameters: - name: include_term_hierarchy description: Whether include term hierarchy. Default value is False. + defaultValue: 'False' types: - return: @@ -1027,6 +1029,7 @@ methods: keywordOnlyParameters: - name: include_term_hierarchy description: Whether include term hierarchy. Default value is False. + defaultValue: 'False' types: - return: @@ -1646,6 +1649,7 @@ methods: keywordOnlyParameters: - name: include_term_hierarchy description: Whether include term hierarchy. Default value is False. + defaultValue: 'False' types: - return: @@ -1674,6 +1678,7 @@ methods: keywordOnlyParameters: - name: include_term_hierarchy description: Whether include term hierarchy. Default value is False. + defaultValue: 'False' types: - return: @@ -2100,14 +2105,17 @@ methods: keywordOnlyParameters: - name: limit description: The page size - by default there is no paging. Default value is None. + defaultValue: None types: - - name: offset description: The offset for pagination purpose. Default value is None. + defaultValue: None types: - - name: sort description: The sort order, ASC (default) or DESC. Default value is "ASC". + defaultValue: ASC types: - return: @@ -2297,12 +2305,14 @@ methods: keywordOnlyParameters: - name: include_term_hierarchy description: Whether include term hierarchy. Default value is False. + defaultValue: 'False' types: - - name: exclude_relationship_type_list description: 'An array of relationship types which need to be excluded. Default value is None.' + defaultValue: None types: - [] return: @@ -2586,14 +2596,17 @@ methods: keywordOnlyParameters: - name: limit description: The page size - by default there is no paging. Default value is None. + defaultValue: None types: - - name: offset description: The offset for pagination purpose. Default value is None. + defaultValue: None types: - - name: sort description: The sort order, ASC (default) or DESC. Default value is "ASC". + defaultValue: ASC types: - return: @@ -2626,20 +2639,24 @@ methods: keywordOnlyParameters: - name: limit description: The page size - by default there is no paging. Default value is None. + defaultValue: None types: - - name: offset description: The offset for pagination purpose. Default value is None. + defaultValue: None types: - - name: sort description: The sort order, ASC (default) or DESC. Default value is "ASC". + defaultValue: ASC types: - - name: ignore_terms_and_categories description: 'Whether ignore terms and categories. Default value is False.' + defaultValue: 'False' types: - return: @@ -2720,14 +2737,17 @@ methods: keywordOnlyParameters: - name: limit description: The page size - by default there is no paging. Default value is None. + defaultValue: None types: - - name: offset description: The offset for pagination purpose. Default value is None. + defaultValue: None types: - - name: sort description: The sort order, ASC (default) or DESC. Default value is "ASC". + defaultValue: ASC types: - return: @@ -2817,14 +2837,17 @@ methods: keywordOnlyParameters: - name: limit description: The page size - by default there is no paging. Default value is None. + defaultValue: None types: - - name: offset description: The offset for pagination purpose. Default value is None. + defaultValue: None types: - - name: sort description: The sort order, ASC (default) or DESC. Default value is "ASC". + defaultValue: ASC types: - return: @@ -2859,14 +2882,17 @@ methods: keywordOnlyParameters: - name: limit description: The page size - by default there is no paging. Default value is None. + defaultValue: None types: - - name: offset description: The offset for pagination purpose. Default value is None. + defaultValue: None types: - - name: sort description: The sort order, ASC (default) or DESC. Default value is "ASC". + defaultValue: ASC types: - return: @@ -2905,18 +2931,22 @@ methods: keywordOnlyParameters: - name: include_term_hierarchy description: Whether include term hierarchy. Default value is False. + defaultValue: 'False' types: - - name: limit description: The page size - by default there is no paging. Default value is None. + defaultValue: None types: - - name: offset description: The offset for pagination purpose. Default value is None. + defaultValue: None types: - - name: sort description: The sort order, ASC (default) or DESC. Default value is "ASC". + defaultValue: ASC types: - return: @@ -3195,14 +3225,17 @@ methods: keywordOnlyParameters: - name: limit description: The page size - by default there is no paging. Default value is None. + defaultValue: None types: - - name: offset description: The offset for pagination purpose. Default value is None. + defaultValue: None types: - - name: sort description: The sort order, ASC (default) or DESC. Default value is "ASC". + defaultValue: ASC types: - return: @@ -3241,14 +3274,17 @@ methods: keywordOnlyParameters: - name: limit description: The page size - by default there is no paging. Default value is None. + defaultValue: None types: - - name: offset description: The offset for pagination purpose. Default value is None. + defaultValue: None types: - - name: sort description: The sort order, ASC (default) or DESC. Default value is "ASC". + defaultValue: ASC types: - return: @@ -3288,14 +3324,17 @@ methods: keywordOnlyParameters: - name: limit description: The page size - by default there is no paging. Default value is None. + defaultValue: None types: - - name: offset description: The offset for pagination purpose. Default value is None. + defaultValue: None types: - - name: include_term_hierarchy description: Whether include term hierarchy. Default value is False. + defaultValue: 'False' types: - return: @@ -3581,6 +3620,7 @@ methods: keywordOnlyParameters: - name: include_term_hierarchy description: Whether include term hierarchy. Default value is False. + defaultValue: 'False' types: - return: @@ -3750,6 +3790,7 @@ methods: keywordOnlyParameters: - name: include_term_hierarchy description: Whether include term hierarchy. Default value is False. + defaultValue: 'False' types: - return: @@ -4308,6 +4349,7 @@ methods: keywordOnlyParameters: - name: include_term_hierarchy description: Whether include term hierarchy. Default value is False. + defaultValue: 'False' types: - return: diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.LineageOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.LineageOperations.yml index dae00240..bc62f257 100644 --- a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.LineageOperations.yml +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.LineageOperations.yml @@ -43,10 +43,12 @@ methods: - - name: depth description: The number of hops for lineage. Default value is 3. + defaultValue: '3' types: - - name: width description: The number of max expanding width in lineage. Default value is 10. + defaultValue: '10' types: - - name: include_parent @@ -54,12 +56,14 @@ methods: is None.' + defaultValue: None types: - - name: get_derived_lineage description: 'True to include derived lineage in the response. Default value is None.' + defaultValue: None types: - return: @@ -171,10 +175,12 @@ methods: - - name: depth description: The number of hops for lineage. Default value is 3. + defaultValue: '3' types: - - name: width description: The number of max expanding width in lineage. Default value is 10. + defaultValue: '10' types: - - name: include_parent @@ -182,12 +188,14 @@ methods: is None.' + defaultValue: None types: - - name: get_derived_lineage description: 'True to include derived lineage in the response. Default value is None.' + defaultValue: None types: - return: @@ -301,14 +309,17 @@ methods: description: 'True to include derived lineage in the response. Default value is None.' + defaultValue: None types: - - name: offset description: The offset for pagination purpose. Default value is None. + defaultValue: None types: - - name: limit description: The page size - by default there is no paging. Default value is None. + defaultValue: None types: - return: diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.RelationshipOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.RelationshipOperations.yml index 28ff6c25..751c561f 100644 --- a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.RelationshipOperations.yml +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.RelationshipOperations.yml @@ -108,6 +108,7 @@ methods: keywordOnlyParameters: - name: extended_info description: Limits whether includes extended information. Default value is None. + defaultValue: None types: - return: diff --git a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.TypesOperations.yml b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.TypesOperations.yml index 023acf4d..c71c92f2 100644 --- a/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.TypesOperations.yml +++ b/previous/docs-ref-autogen/azure-purview-catalog/azure.purview.catalog.operations.TypesOperations.yml @@ -2042,6 +2042,7 @@ methods: This is always true when search filter type=term_template. Default value is False.' + defaultValue: 'False' types: - - name: type @@ -2052,6 +2053,7 @@ methods: value is None.' + defaultValue: None types: - return: @@ -4426,6 +4428,7 @@ methods: This is always true when search filter type=term_template. Default value is False.' + defaultValue: 'False' types: - - name: type @@ -4436,6 +4439,7 @@ methods: value is None.' + defaultValue: None types: - return: diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorContract.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorContract.yml index 0343b165..0008f663 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorContract.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorContract.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: error - isRequired: true + defaultValue: None methods: - uid: azure.synapse.accesscontrol.models.ErrorContract.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorDetail.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorDetail.yml index d370516a..54fd129f 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorDetail.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorDetail.yml @@ -30,7 +30,7 @@ constructor: - name: message isRequired: true - name: target - isRequired: true + defaultValue: None methods: - uid: azure.synapse.accesscontrol.models.ErrorDetail.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorResponse.yml index 620748f8..b74fcb64 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.ErrorResponse.yml @@ -35,9 +35,9 @@ constructor: - name: message isRequired: true - name: target - isRequired: true + defaultValue: None - name: details - isRequired: true + defaultValue: None methods: - uid: azure.synapse.accesscontrol.models.ErrorResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentDetails.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentDetails.yml index e4ce252f..889c96ca 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentDetails.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RoleAssignmentDetails.yml @@ -25,11 +25,11 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: role_id - isRequired: true + defaultValue: None - name: principal_id - isRequired: true + defaultValue: None methods: - uid: azure.synapse.accesscontrol.models.RoleAssignmentDetails.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RolesListResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RolesListResponse.yml index 04a1a1b0..f3df2306 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RolesListResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.RolesListResponse.yml @@ -25,7 +25,7 @@ constructor: - name: value isRequired: true - name: next_link - isRequired: true + defaultValue: None methods: - uid: azure.synapse.accesscontrol.models.RolesListResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.SynapseRole.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.SynapseRole.yml index e749c59a..36ffcd33 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.SynapseRole.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.accesscontrol.models.SynapseRole.yml @@ -30,9 +30,9 @@ constructor: - name: is_built_in isRequired: true - name: id - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.accesscontrol.models.SynapseRole.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Activity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Activity.yml index 966e8898..35580f85 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Activity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Activity.yml @@ -55,13 +55,13 @@ constructor: - name: name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.Activity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityDependency.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityDependency.yml index 2d8d8053..eaa8675f 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityDependency.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityDependency.yml @@ -36,7 +36,7 @@ constructor: - name: dependency_conditions isRequired: true - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ActivityDependency.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityPolicy.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityPolicy.yml index 5672e836..09aaeecd 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityPolicy.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityPolicy.yml @@ -60,17 +60,17 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: timeout - isRequired: true + defaultValue: None - name: retry - isRequired: true + defaultValue: None - name: retry_interval_in_seconds - isRequired: true + defaultValue: None - name: secure_input - isRequired: true + defaultValue: None - name: secure_output - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ActivityPolicy.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRun.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRun.yml index 3692dd91..379bf6d5 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRun.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRun.yml @@ -20,7 +20,7 @@ constructor: - [, ] keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None variables: - description: The name of the pipeline. name: pipeline_name diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRunsQueryResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRunsQueryResponse.yml index 3abfe7fb..7cc95aab 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRunsQueryResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ActivityRunsQueryResponse.yml @@ -28,7 +28,7 @@ constructor: - name: value isRequired: true - name: continuation_token - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ActivityRunsQueryResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse.yml index b1d8b2d9..5801645c 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: job_version - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AddDataFlowToDebugSessionResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSLinkedService.yml index 2f88f202..32249e74 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSLinkedService.yml @@ -131,27 +131,27 @@ constructor: - name: access_key_id isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: mws_auth_token - isRequired: true + defaultValue: None - name: secret_key - isRequired: true + defaultValue: None - name: use_encrypted_endpoints - isRequired: true + defaultValue: None - name: use_host_verification - isRequired: true + defaultValue: None - name: use_peer_verification - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AmazonMWSLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSObjectDataset.yml index 2493baa4..43921d8a 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonMWSObjectDataset.yml @@ -80,21 +80,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AmazonMWSObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftLinkedService.yml index 0aa5916e..e88921cf 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftLinkedService.yml @@ -101,23 +101,23 @@ constructor: - name: database isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: username - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: port - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AmazonRedshiftLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftTableDataset.yml index 508fd0ca..8e9e1d77 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonRedshiftTableDataset.yml @@ -98,25 +98,25 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None - name: table - isRequired: true + defaultValue: None - name: schema_type_properties_schema - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AmazonRedshiftTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonS3LinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonS3LinkedService.yml index a025676a..81c25c6a 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonS3LinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AmazonS3LinkedService.yml @@ -84,23 +84,23 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: access_key_id - isRequired: true + defaultValue: None - name: secret_access_key - isRequired: true + defaultValue: None - name: service_url - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AmazonS3LinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AppendVariableActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AppendVariableActivity.yml index 2902e7ce..ec95f209 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AppendVariableActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AppendVariableActivity.yml @@ -59,17 +59,17 @@ constructor: - name: name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: variable_name - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AppendVariableActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroDataset.yml index b08d3506..88295c65 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AvroDataset.yml @@ -93,25 +93,25 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: location - isRequired: true + defaultValue: None - name: avro_compression_codec - isRequired: true + defaultValue: None - name: avro_compression_level - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AvroDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBatchLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBatchLinkedService.yml index 374ef312..c0af8a80 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBatchLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBatchLinkedService.yml @@ -101,19 +101,19 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: access_key - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureBatchLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSLinkedService.yml index 2c75acd6..6e59ea85 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobFSLinkedService.yml @@ -101,25 +101,25 @@ constructor: - name: url isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: account_key - isRequired: true + defaultValue: None - name: service_principal_id - isRequired: true + defaultValue: None - name: service_principal_key - isRequired: true + defaultValue: None - name: tenant - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureBlobFSLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobStorageLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobStorageLinkedService.yml index f74482d7..947707a6 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobStorageLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureBlobStorageLinkedService.yml @@ -119,33 +119,33 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: connection_string - isRequired: true + defaultValue: None - name: account_key - isRequired: true + defaultValue: None - name: sas_uri - isRequired: true + defaultValue: None - name: sas_token - isRequired: true + defaultValue: None - name: service_endpoint - isRequired: true + defaultValue: None - name: service_principal_id - isRequired: true + defaultValue: None - name: service_principal_key - isRequired: true + defaultValue: None - name: tenant - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureBlobStorageLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerCommandActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerCommandActivity.yml index fb082c47..070edec4 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerCommandActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerCommandActivity.yml @@ -77,19 +77,19 @@ constructor: - name: command isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None - name: command_timeout - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureDataExplorerCommandActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerLinkedService.yml index e11bdd37..2a99c0bf 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerLinkedService.yml @@ -98,15 +98,15 @@ constructor: - name: tenant isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureDataExplorerLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerTableDataset.yml index e5fe1579..31ed73ad 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataExplorerTableDataset.yml @@ -82,21 +82,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureDataExplorerTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService.yml index 80161016..12f8630b 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService.yml @@ -115,27 +115,27 @@ constructor: - name: tenant isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: service_principal_id - isRequired: true + defaultValue: None - name: service_principal_key - isRequired: true + defaultValue: None - name: subscription_id - isRequired: true + defaultValue: None - name: resource_group_name - isRequired: true + defaultValue: None - name: data_lake_analytics_uri - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureDataLakeAnalyticsLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService.yml index 8b69fa45..4ebbd553 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService.yml @@ -114,29 +114,29 @@ constructor: - name: data_lake_store_uri isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: service_principal_id - isRequired: true + defaultValue: None - name: service_principal_key - isRequired: true + defaultValue: None - name: tenant - isRequired: true + defaultValue: None - name: account_name - isRequired: true + defaultValue: None - name: subscription_id - isRequired: true + defaultValue: None - name: resource_group_name - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureDataLakeStoreLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksLinkedService.yml index 0fd06f8e..098f6eef 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureDatabricksLinkedService.yml @@ -192,39 +192,39 @@ constructor: - name: access_token isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: existing_cluster_id - isRequired: true + defaultValue: None - name: instance_pool_id - isRequired: true + defaultValue: None - name: new_cluster_version - isRequired: true + defaultValue: None - name: new_cluster_num_of_worker - isRequired: true + defaultValue: None - name: new_cluster_node_type - isRequired: true + defaultValue: None - name: new_cluster_spark_conf - isRequired: true + defaultValue: None - name: new_cluster_spark_env_vars - isRequired: true + defaultValue: None - name: new_cluster_custom_tags - isRequired: true + defaultValue: None - name: new_cluster_driver_node_type - isRequired: true + defaultValue: None - name: new_cluster_init_scripts - isRequired: true + defaultValue: None - name: new_cluster_enable_elastic_disk - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureDatabricksLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFileStorageLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFileStorageLinkedService.yml index a9838e84..7a648576 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFileStorageLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFileStorageLinkedService.yml @@ -81,21 +81,21 @@ constructor: - name: host isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: user_id - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureFileStorageLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionActivity.yml index bbe566eb..93fe4685 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionActivity.yml @@ -102,21 +102,21 @@ constructor: - name: function_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None - name: headers - isRequired: true + defaultValue: None - name: body - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureFunctionActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionLinkedService.yml index f72458cf..0960d8d6 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureFunctionLinkedService.yml @@ -73,19 +73,19 @@ constructor: - name: function_app_url isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: function_key - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureFunctionLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultLinkedService.yml index 40d985d3..537a4f41 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultLinkedService.yml @@ -57,15 +57,15 @@ constructor: - name: base_url isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureKeyVaultLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultSecretReference.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultSecretReference.yml index ebc4d3f9..9f175f01 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultSecretReference.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureKeyVaultSecretReference.yml @@ -43,7 +43,7 @@ constructor: - name: secret_name isRequired: true - name: secret_version - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureKeyVaultSecretReference.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLBatchExecutionActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLBatchExecutionActivity.yml index 4ee1eb4b..37074a16 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLBatchExecutionActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLBatchExecutionActivity.yml @@ -101,23 +101,23 @@ constructor: - name: name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None - name: global_parameters - isRequired: true + defaultValue: None - name: web_service_outputs - isRequired: true + defaultValue: None - name: web_service_inputs - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureMLBatchExecutionActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLExecutePipelineActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLExecutePipelineActivity.yml index 10c477d5..6b12826a 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLExecutePipelineActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLExecutePipelineActivity.yml @@ -117,25 +117,25 @@ constructor: - name: ml_pipeline_id isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None - name: experiment_name - isRequired: true + defaultValue: None - name: ml_pipeline_parameters - isRequired: true + defaultValue: None - name: ml_parent_run_id - isRequired: true + defaultValue: None - name: continue_on_step_failure - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureMLExecutePipelineActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLLinkedService.yml index cdbfc1de..bd58a5f5 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLLinkedService.yml @@ -109,25 +109,25 @@ constructor: - name: api_key isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: update_resource_endpoint - isRequired: true + defaultValue: None - name: service_principal_id - isRequired: true + defaultValue: None - name: service_principal_key - isRequired: true + defaultValue: None - name: tenant - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureMLLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLServiceLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLServiceLinkedService.yml index 23ede041..ae7fa2fc 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLServiceLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLServiceLinkedService.yml @@ -113,23 +113,23 @@ constructor: - name: ml_workspace_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: service_principal_id - isRequired: true + defaultValue: None - name: service_principal_key - isRequired: true + defaultValue: None - name: tenant - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureMLServiceLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLUpdateResourceActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLUpdateResourceActivity.yml index 6af33e31..d01c4dc0 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLUpdateResourceActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMLUpdateResourceActivity.yml @@ -91,17 +91,17 @@ constructor: - name: trained_model_file_path isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureMLUpdateResourceActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBLinkedService.yml index f6302ad5..ef3a69ce 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBLinkedService.yml @@ -71,21 +71,21 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: connection_string - isRequired: true + defaultValue: None - name: pwd - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureMariaDBLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBTableDataset.yml index c05611eb..7cda15c6 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMariaDBTableDataset.yml @@ -80,21 +80,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureMariaDBTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlLinkedService.yml index 17bf1922..098dc064 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlLinkedService.yml @@ -72,19 +72,19 @@ constructor: - name: connection_string isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureMySqlLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlTableDataset.yml index 18af7bc9..86baeca5 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureMySqlTableDataset.yml @@ -91,23 +91,23 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None - name: table - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureMySqlTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlLinkedService.yml index 14e3b27e..f6009e26 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlLinkedService.yml @@ -71,21 +71,21 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: connection_string - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzurePostgreSqlLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlTableDataset.yml index 6ac20e54..2890942f 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzurePostgreSqlTableDataset.yml @@ -99,25 +99,25 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None - name: table - isRequired: true + defaultValue: None - name: schema_type_properties_schema - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzurePostgreSqlTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchIndexDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchIndexDataset.yml index de47c043..139ec7f1 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchIndexDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchIndexDataset.yml @@ -83,19 +83,19 @@ constructor: - name: index_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureSearchIndexDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchLinkedService.yml index 2e0f16e9..156c93ea 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSearchLinkedService.yml @@ -73,19 +73,19 @@ constructor: - name: url isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: key - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureSearchLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWLinkedService.yml index 8cf43203..cdbdbb73 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWLinkedService.yml @@ -96,25 +96,25 @@ constructor: - name: connection_string isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: service_principal_id - isRequired: true + defaultValue: None - name: service_principal_key - isRequired: true + defaultValue: None - name: tenant - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureSqlDWLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWTableDataset.yml index 0bed02ab..9eb03b55 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDWTableDataset.yml @@ -98,25 +98,25 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None - name: schema_type_properties_schema - isRequired: true + defaultValue: None - name: table - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureSqlDWTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService.yml index fbba934e..82e500f3 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService.yml @@ -96,25 +96,25 @@ constructor: - name: connection_string isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: service_principal_id - isRequired: true + defaultValue: None - name: service_principal_key - isRequired: true + defaultValue: None - name: tenant - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureSqlDatabaseLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMILinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMILinkedService.yml index b98feb12..3809beb2 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMILinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMILinkedService.yml @@ -96,25 +96,25 @@ constructor: - name: connection_string isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: service_principal_id - isRequired: true + defaultValue: None - name: service_principal_key - isRequired: true + defaultValue: None - name: tenant - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureSqlMILinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMITableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMITableDataset.yml index a5e41b43..be1bed5a 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMITableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlMITableDataset.yml @@ -98,25 +98,25 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None - name: schema_type_properties_schema - isRequired: true + defaultValue: None - name: table - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureSqlMITableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlTableDataset.yml index e8bc17f6..6509fa04 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureSqlTableDataset.yml @@ -97,25 +97,25 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None - name: schema_type_properties_schema - isRequired: true + defaultValue: None - name: table - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureSqlTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureStorageLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureStorageLinkedService.yml index 18e50127..a894b85a 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureStorageLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureStorageLinkedService.yml @@ -86,25 +86,25 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: connection_string - isRequired: true + defaultValue: None - name: account_key - isRequired: true + defaultValue: None - name: sas_uri - isRequired: true + defaultValue: None - name: sas_token - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureStorageLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableDataset.yml index 4e659781..65ce4dcd 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableDataset.yml @@ -84,19 +84,19 @@ constructor: - name: table_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableStorageLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableStorageLinkedService.yml index 8f7a373c..3645f2ca 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableStorageLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.AzureTableStorageLinkedService.yml @@ -86,25 +86,25 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: connection_string - isRequired: true + defaultValue: None - name: account_key - isRequired: true + defaultValue: None - name: sas_uri - isRequired: true + defaultValue: None - name: sas_token - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.AzureTableStorageLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BinaryDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BinaryDataset.yml index 91fd22e8..7c221f75 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BinaryDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.BinaryDataset.yml @@ -85,23 +85,23 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: location - isRequired: true + defaultValue: None - name: compression - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.BinaryDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraLinkedService.yml index 659347e2..d4c65876 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraLinkedService.yml @@ -95,25 +95,25 @@ constructor: - name: host isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: authentication_type - isRequired: true + defaultValue: None - name: port - isRequired: true + defaultValue: None - name: username - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.CassandraLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraTableDataset.yml index 7d25c2b2..e1b86bd5 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CassandraTableDataset.yml @@ -91,23 +91,23 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None - name: keyspace - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.CassandraTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CloudError.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CloudError.yml index 81dfa48d..0d4ed2a9 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CloudError.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CloudError.yml @@ -37,9 +37,9 @@ constructor: - name: message isRequired: true - name: target - isRequired: true + defaultValue: None - name: details - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.CloudError.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset.yml index 5640b7f9..e96d6a87 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset.yml @@ -83,21 +83,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: entity_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.CommonDataServiceForAppsEntityDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService.yml index 4de2f1ad..768400d5 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService.yml @@ -192,35 +192,35 @@ constructor: - name: authentication_type isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: host_name - isRequired: true + defaultValue: None - name: port - isRequired: true + defaultValue: None - name: service_uri - isRequired: true + defaultValue: None - name: organization_name - isRequired: true + defaultValue: None - name: username - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: service_principal_id - isRequired: true + defaultValue: None - name: service_principal_credential_type - isRequired: true + defaultValue: None - name: service_principal_credential - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.CommonDataServiceForAppsLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurLinkedService.yml index 8b133ac7..9378041d 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurLinkedService.yml @@ -106,25 +106,25 @@ constructor: - name: username isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: use_encrypted_endpoints - isRequired: true + defaultValue: None - name: use_host_verification - isRequired: true + defaultValue: None - name: use_peer_verification - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ConcurLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurObjectDataset.yml index 8f4295d8..b6e45a3e 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ConcurObjectDataset.yml @@ -79,21 +79,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ConcurObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ControlActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ControlActivity.yml index 1c89fd4c..06cc6698 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ControlActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ControlActivity.yml @@ -48,13 +48,13 @@ constructor: - name: name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ControlActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopyActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopyActivity.yml index 1fec369b..cfaa8430 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopyActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopyActivity.yml @@ -152,39 +152,39 @@ constructor: - name: sink isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None - name: inputs - isRequired: true + defaultValue: None - name: outputs - isRequired: true + defaultValue: None - name: translator - isRequired: true + defaultValue: None - name: enable_staging - isRequired: true + defaultValue: None - name: staging_settings - isRequired: true + defaultValue: None - name: parallel_copies - isRequired: true + defaultValue: None - name: data_integration_units - isRequired: true + defaultValue: None - name: enable_skip_incompatible_row - isRequired: true + defaultValue: None - name: redirect_incompatible_row_settings - isRequired: true + defaultValue: None - name: preserve_rules - isRequired: true + defaultValue: None - name: preserve - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.CopyActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySink.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySink.yml index 37067a85..1636465b 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySink.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySink.yml @@ -67,17 +67,17 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: write_batch_size - isRequired: true + defaultValue: None - name: write_batch_timeout - isRequired: true + defaultValue: None - name: sink_retry_count - isRequired: true + defaultValue: None - name: sink_retry_wait - isRequired: true + defaultValue: None - name: max_concurrent_connections - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.CopySink.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySource.yml index 58629736..aa67067b 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySource.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CopySource.yml @@ -52,13 +52,13 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: source_retry_count - isRequired: true + defaultValue: None - name: source_retry_wait - isRequired: true + defaultValue: None - name: max_concurrent_connections - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.CopySource.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbLinkedService.yml index f8125a78..104ec6f7 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbLinkedService.yml @@ -87,25 +87,25 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: connection_string - isRequired: true + defaultValue: None - name: account_endpoint - isRequired: true + defaultValue: None - name: database - isRequired: true + defaultValue: None - name: account_key - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.CosmosDbLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset.yml index ac1c16e3..b972abb3 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset.yml @@ -84,19 +84,19 @@ constructor: - name: collection isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiCollectionDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService.yml index f58c87fd..38cdb531 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService.yml @@ -68,15 +68,15 @@ constructor: - name: database isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.CosmosDbMongoDbApiLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset.yml index c43b3906..6f19ebc1 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset.yml @@ -83,19 +83,19 @@ constructor: - name: collection_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.CosmosDbSqlApiCollectionDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseLinkedService.yml index 926217da..58080fe1 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseLinkedService.yml @@ -72,21 +72,21 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: connection_string - isRequired: true + defaultValue: None - name: cred_string - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.CouchbaseLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseTableDataset.yml index 6b230af0..3d22fd23 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CouchbaseTableDataset.yml @@ -79,21 +79,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.CouchbaseTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest.yml index a6544c0d..13d174c9 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest.yml @@ -42,17 +42,17 @@ constructor: - keywordOnlyParameters: - name: data_flow_name - isRequired: true + defaultValue: None - name: existing_cluster_id - isRequired: true + defaultValue: None - name: cluster_timeout - isRequired: true + defaultValue: None - name: new_cluster_name - isRequired: true + defaultValue: None - name: new_cluster_node_type - isRequired: true + defaultValue: None - name: data_bricks_linked_service - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.CreateDataFlowDebugSessionRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse.yml index dfae48d9..e6a99660 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: session_id - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.CreateDataFlowDebugSessionResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivity.yml index 22d904dd..8688e9d3 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivity.yml @@ -107,27 +107,27 @@ constructor: - name: command isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None - name: resource_linked_service - isRequired: true + defaultValue: None - name: folder_path - isRequired: true + defaultValue: None - name: reference_objects - isRequired: true + defaultValue: None - name: extended_properties - isRequired: true + defaultValue: None - name: retention_time_in_days - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.CustomActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivityReferenceObject.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivityReferenceObject.yml index 20046c13..d9d883f9 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivityReferenceObject.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomActivityReferenceObject.yml @@ -20,9 +20,9 @@ constructor: - [] keywordOnlyParameters: - name: linked_services - isRequired: true + defaultValue: None - name: datasets - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.CustomActivityReferenceObject.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomDataSourceLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomDataSourceLinkedService.yml index 7a3cdc67..ca53302b 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomDataSourceLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.CustomDataSourceLinkedService.yml @@ -54,15 +54,15 @@ constructor: - name: type_properties isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.CustomDataSourceLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlow.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlow.yml index 3d9e3e90..9a1712b7 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlow.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlow.yml @@ -42,11 +42,11 @@ constructor: - keywordOnlyParameters: - name: description - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DataFlow.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandRequest.yml index 89c1b029..a86d89d8 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandRequest.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandRequest.yml @@ -31,13 +31,13 @@ constructor: - keywordOnlyParameters: - name: session_id - isRequired: true + defaultValue: None - name: data_flow_name - isRequired: true + defaultValue: None - name: command_name - isRequired: true + defaultValue: None - name: command_payload - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DataFlowDebugCommandRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandResponse.yml index b6963632..cbed7527 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugCommandResponse.yml @@ -21,9 +21,9 @@ constructor: - keywordOnlyParameters: - name: status - isRequired: true + defaultValue: None - name: data - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DataFlowDebugCommandResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackage.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackage.yml index 86dcde64..6e685a95 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackage.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackage.yml @@ -50,19 +50,19 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: session_id - isRequired: true + defaultValue: None - name: data_flow - isRequired: true + defaultValue: None - name: datasets - isRequired: true + defaultValue: None - name: linked_services - isRequired: true + defaultValue: None - name: staging - isRequired: true + defaultValue: None - name: debug_settings - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DataFlowDebugPackage.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings.yml index 5da2c2a2..3e39760d 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings.yml @@ -26,11 +26,11 @@ constructor: - keywordOnlyParameters: - name: source_settings - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: dataset_parameters - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DataFlowDebugPackageDebugSettings.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest.yml index 805a5196..4676b362 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest.yml @@ -31,13 +31,13 @@ constructor: - keywordOnlyParameters: - name: session_id - isRequired: true + defaultValue: None - name: data_flow_name - isRequired: true + defaultValue: None - name: stream_name - isRequired: true + defaultValue: None - name: row_limits - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DataFlowDebugPreviewDataRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugQueryResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugQueryResponse.yml index 1d454baa..cdcb6520 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugQueryResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugQueryResponse.yml @@ -15,7 +15,7 @@ constructor: - keywordOnlyParameters: - name: run_id - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DataFlowDebugQueryResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResource.yml index e17ef9e4..382a458f 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResource.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResource.yml @@ -25,7 +25,7 @@ constructor: - name: properties isRequired: true - name: name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DataFlowDebugResource.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResultResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResultResponse.yml index 3f0ccc2e..db69a66f 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResultResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugResultResponse.yml @@ -21,9 +21,9 @@ constructor: - keywordOnlyParameters: - name: status - isRequired: true + defaultValue: None - name: data - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DataFlowDebugResultResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugSessionInfo.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugSessionInfo.yml index 0c093c3c..18eef3fe 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugSessionInfo.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugSessionInfo.yml @@ -66,25 +66,25 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: data_flow_name - isRequired: true + defaultValue: None - name: compute_type - isRequired: true + defaultValue: None - name: core_count - isRequired: true + defaultValue: None - name: node_count - isRequired: true + defaultValue: None - name: integration_runtime_name - isRequired: true + defaultValue: None - name: session_id - isRequired: true + defaultValue: None - name: start_time - isRequired: true + defaultValue: None - name: time_to_live_in_minutes - isRequired: true + defaultValue: None - name: last_activity_time - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DataFlowDebugSessionInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest.yml index d9e190a5..2d1fe287 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest.yml @@ -31,13 +31,13 @@ constructor: - [] keywordOnlyParameters: - name: session_id - isRequired: true + defaultValue: None - name: data_flow_name - isRequired: true + defaultValue: None - name: stream_name - isRequired: true + defaultValue: None - name: columns - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DataFlowDebugStatisticsRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowFolder.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowFolder.yml index aae22b42..d5343019 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowFolder.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowFolder.yml @@ -15,7 +15,7 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DataFlowFolder.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowListResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowListResponse.yml index e78126a7..b4e5d1f2 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowListResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowListResponse.yml @@ -25,7 +25,7 @@ constructor: - name: value isRequired: true - name: next_link - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DataFlowListResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowReference.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowReference.yml index c1129d6b..18722478 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowReference.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowReference.yml @@ -35,9 +35,9 @@ constructor: - name: reference_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: dataset_parameters - isRequired: true + defaultValue: None variables: - description: 'Required. Data flow reference type. Default value: "DataFlowReference".' name: type diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSink.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSink.yml index 6fbd4989..5b66c2fd 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSink.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSink.yml @@ -30,9 +30,9 @@ constructor: - name: name isRequired: true - name: description - isRequired: true + defaultValue: None - name: dataset - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DataFlowSink.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSource.yml index bbf99069..366b620b 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSource.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSource.yml @@ -30,9 +30,9 @@ constructor: - name: name isRequired: true - name: description - isRequired: true + defaultValue: None - name: dataset - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DataFlowSource.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSourceSetting.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSourceSetting.yml index ea0611de..bde48f7a 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSourceSetting.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowSourceSetting.yml @@ -27,11 +27,11 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: source_name - isRequired: true + defaultValue: None - name: row_limit - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DataFlowSourceSetting.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowStagingInfo.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowStagingInfo.yml index 8f1dfe63..b5e414a7 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowStagingInfo.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataFlowStagingInfo.yml @@ -20,9 +20,9 @@ constructor: - keywordOnlyParameters: - name: linked_service - isRequired: true + defaultValue: None - name: folder_path - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DataFlowStagingInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity.yml index 30ebb74f..abbc201e 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity.yml @@ -118,27 +118,27 @@ constructor: - name: script_linked_service isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None - name: degree_of_parallelism - isRequired: true + defaultValue: None - name: priority - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: runtime_version - isRequired: true + defaultValue: None - name: compilation_mode - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DataLakeAnalyticsUSQLActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksNotebookActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksNotebookActivity.yml index 14f7848b..272702d2 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksNotebookActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksNotebookActivity.yml @@ -87,21 +87,21 @@ constructor: - name: notebook_path isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None - name: base_parameters - isRequired: true + defaultValue: None - name: libraries - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DatabricksNotebookActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkJarActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkJarActivity.yml index f48f634f..0d6ecaa7 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkJarActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkJarActivity.yml @@ -85,21 +85,21 @@ constructor: - name: main_class_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: libraries - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DatabricksSparkJarActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkPythonActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkPythonActivity.yml index d816e633..2a81d79e 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkPythonActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatabricksSparkPythonActivity.yml @@ -82,21 +82,21 @@ constructor: - name: python_file isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: libraries - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DatabricksSparkPythonActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Dataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Dataset.yml index 989033fc..d5becf3f 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Dataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Dataset.yml @@ -100,19 +100,19 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.Dataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetBZip2Compression.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetBZip2Compression.yml index 895563d3..dd7446df 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetBZip2Compression.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetBZip2Compression.yml @@ -25,7 +25,7 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DatasetBZip2Compression.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetCompression.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetCompression.yml index ce5c062d..fb524ebc 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetCompression.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetCompression.yml @@ -31,7 +31,7 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DatasetCompression.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDebugResource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDebugResource.yml index 5ccef6a0..61f359b9 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDebugResource.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDebugResource.yml @@ -24,7 +24,7 @@ constructor: - name: properties isRequired: true - name: name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DatasetDebugResource.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDeflateCompression.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDeflateCompression.yml index 04487761..1fe4570a 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDeflateCompression.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetDeflateCompression.yml @@ -32,9 +32,9 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: level - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DatasetDeflateCompression.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetFolder.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetFolder.yml index a22a5254..0e2195be 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetFolder.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetFolder.yml @@ -15,7 +15,7 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DatasetFolder.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetGZipCompression.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetGZipCompression.yml index 34872761..096af5d1 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetGZipCompression.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetGZipCompression.yml @@ -32,9 +32,9 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: level - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DatasetGZipCompression.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetListResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetListResponse.yml index b1020145..cc242937 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetListResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetListResponse.yml @@ -25,7 +25,7 @@ constructor: - name: value isRequired: true - name: next_link - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DatasetListResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetLocation.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetLocation.yml index e2ae9af7..9d9448e0 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetLocation.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetLocation.yml @@ -46,11 +46,11 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: folder_path - isRequired: true + defaultValue: None - name: file_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DatasetLocation.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetReference.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetReference.yml index 1e4eea29..cd245226 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetReference.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetReference.yml @@ -28,7 +28,7 @@ constructor: - name: reference_name isRequired: true - name: parameters - isRequired: true + defaultValue: None variables: - description: 'Required. Dataset reference type. Default value: "DatasetReference".' name: type diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetZipDeflateCompression.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetZipDeflateCompression.yml index 91a970ae..d7c2513e 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetZipDeflateCompression.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DatasetZipDeflateCompression.yml @@ -32,9 +32,9 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: level - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DatasetZipDeflateCompression.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2LinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2LinkedService.yml index a58c0248..129df5e6 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2LinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2LinkedService.yml @@ -109,25 +109,25 @@ constructor: - name: database isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: username - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: package_collection - isRequired: true + defaultValue: None - name: certificate_common_name - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None variables: - description: 'AuthenticationType to be used for connection. Default value: diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2TableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2TableDataset.yml index 64ecf3ea..6c9f1c71 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2TableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Db2TableDataset.yml @@ -95,25 +95,25 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None - name: schema_type_properties_schema - isRequired: true + defaultValue: None - name: table - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.Db2TableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteActivity.yml index db507846..b20c4585 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteActivity.yml @@ -99,25 +99,25 @@ constructor: - name: dataset isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None - name: recursive - isRequired: true + defaultValue: None - name: max_concurrent_connections - isRequired: true + defaultValue: None - name: enable_logging - isRequired: true + defaultValue: None - name: log_storage_settings - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DeleteActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest.yml index b56495f8..ad8f26de 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest.yml @@ -20,9 +20,9 @@ constructor: - keywordOnlyParameters: - name: session_id - isRequired: true + defaultValue: None - name: data_flow_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DeleteDataFlowDebugSessionRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextDataset.yml index 82b41095..5ed846ba 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DelimitedTextDataset.yml @@ -156,39 +156,39 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: location - isRequired: true + defaultValue: None - name: column_delimiter - isRequired: true + defaultValue: None - name: row_delimiter - isRequired: true + defaultValue: None - name: encoding_name - isRequired: true + defaultValue: None - name: compression_codec - isRequired: true + defaultValue: None - name: compression_level - isRequired: true + defaultValue: None - name: quote_char - isRequired: true + defaultValue: None - name: escape_char - isRequired: true + defaultValue: None - name: first_row_as_header - isRequired: true + defaultValue: None - name: null_value - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DelimitedTextDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DocumentDbCollectionDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DocumentDbCollectionDataset.yml index c13186ba..41ac0c73 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DocumentDbCollectionDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DocumentDbCollectionDataset.yml @@ -83,19 +83,19 @@ constructor: - name: collection_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DocumentDbCollectionDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillLinkedService.yml index 99e3b8ed..4a62ab6e 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillLinkedService.yml @@ -70,21 +70,21 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: connection_string - isRequired: true + defaultValue: None - name: pwd - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DrillLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillTableDataset.yml index 87a163c8..d49a3ce7 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DrillTableDataset.yml @@ -95,25 +95,25 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None - name: table - isRequired: true + defaultValue: None - name: schema_type_properties_schema - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DrillTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXLinkedService.yml index 09abdbdd..b7bde861 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXLinkedService.yml @@ -113,17 +113,17 @@ constructor: - name: aad_resource_id isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DynamicsAXLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXResourceDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXResourceDataset.yml index 2161590d..e263f2cb 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXResourceDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsAXResourceDataset.yml @@ -84,19 +84,19 @@ constructor: - name: path isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DynamicsAXResourceDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmEntityDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmEntityDataset.yml index f1383ac3..5fbdc3fa 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmEntityDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmEntityDataset.yml @@ -83,21 +83,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: entity_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DynamicsCrmEntityDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmLinkedService.yml index 56212835..22219219 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsCrmLinkedService.yml @@ -188,35 +188,35 @@ constructor: - name: authentication_type isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: host_name - isRequired: true + defaultValue: None - name: port - isRequired: true + defaultValue: None - name: service_uri - isRequired: true + defaultValue: None - name: organization_name - isRequired: true + defaultValue: None - name: username - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: service_principal_id - isRequired: true + defaultValue: None - name: service_principal_credential_type - isRequired: true + defaultValue: None - name: service_principal_credential - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DynamicsCrmLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsEntityDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsEntityDataset.yml index c59d2ce6..3aa09a5f 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsEntityDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsEntityDataset.yml @@ -82,21 +82,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: entity_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DynamicsEntityDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsLinkedService.yml index 673abfe3..18b9853d 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.DynamicsLinkedService.yml @@ -181,35 +181,35 @@ constructor: - name: authentication_type isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: host_name - isRequired: true + defaultValue: None - name: port - isRequired: true + defaultValue: None - name: service_uri - isRequired: true + defaultValue: None - name: organization_name - isRequired: true + defaultValue: None - name: username - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: service_principal_id - isRequired: true + defaultValue: None - name: service_principal_credential_type - isRequired: true + defaultValue: None - name: service_principal_credential - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.DynamicsLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaLinkedService.yml index 30952584..63958de8 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaLinkedService.yml @@ -106,25 +106,25 @@ constructor: - name: username isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: use_encrypted_endpoints - isRequired: true + defaultValue: None - name: use_host_verification - isRequired: true + defaultValue: None - name: use_peer_verification - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.EloquaLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaObjectDataset.yml index e554ffdd..78f207e6 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EloquaObjectDataset.yml @@ -79,21 +79,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.EloquaObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest.yml index 5625ee9c..d1ebb4b7 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest.yml @@ -36,15 +36,15 @@ constructor: - keywordOnlyParameters: - name: session_id - isRequired: true + defaultValue: None - name: data_flow_name - isRequired: true + defaultValue: None - name: stream_name - isRequired: true + defaultValue: None - name: row_limits - isRequired: true + defaultValue: None - name: expression - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.EvaluateDataFlowExpressionRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivity.yml index f177102e..b5c5763c 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivity.yml @@ -84,23 +84,23 @@ constructor: - name: data_flow isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None - name: staging - isRequired: true + defaultValue: None - name: integration_runtime - isRequired: true + defaultValue: None - name: compute - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ExecuteDataFlowActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute.yml index 140cb3c8..854638a5 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute.yml @@ -26,9 +26,9 @@ constructor: - keywordOnlyParameters: - name: compute_type - isRequired: true + defaultValue: None - name: core_count - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ExecuteDataFlowActivityTypePropertiesCompute.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutePipelineActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutePipelineActivity.yml index 78c24818..2e2beede 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutePipelineActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutePipelineActivity.yml @@ -68,17 +68,17 @@ constructor: - name: pipeline isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: wait_on_completion - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ExecutePipelineActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteSSISPackageActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteSSISPackageActivity.yml index 553ca1f3..afc78762 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteSSISPackageActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecuteSSISPackageActivity.yml @@ -142,37 +142,37 @@ constructor: - name: connect_via isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None - name: runtime - isRequired: true + defaultValue: None - name: logging_level - isRequired: true + defaultValue: None - name: environment_path - isRequired: true + defaultValue: None - name: execution_credential - isRequired: true + defaultValue: None - name: project_parameters - isRequired: true + defaultValue: None - name: package_parameters - isRequired: true + defaultValue: None - name: project_connection_managers - isRequired: true + defaultValue: None - name: package_connection_managers - isRequired: true + defaultValue: None - name: property_overrides - isRequired: true + defaultValue: None - name: log_location - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ExecuteSSISPackageActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutionActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutionActivity.yml index c5f173c0..52f0a4aa 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutionActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExecutionActivity.yml @@ -70,17 +70,17 @@ constructor: - name: name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ExecutionActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExposureControlRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExposureControlRequest.yml index c34e7e94..c2d12423 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExposureControlRequest.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ExposureControlRequest.yml @@ -20,9 +20,9 @@ constructor: - keywordOnlyParameters: - name: feature_name - isRequired: true + defaultValue: None - name: feature_type - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ExposureControlRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileServerLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileServerLinkedService.yml index 6d28acd0..b6e70e9a 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileServerLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FileServerLinkedService.yml @@ -81,21 +81,21 @@ constructor: - name: host isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: user_id - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.FileServerLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FilterActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FilterActivity.yml index 3e4eec4a..de578d7a 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FilterActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FilterActivity.yml @@ -63,13 +63,13 @@ constructor: - name: condition isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.FilterActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ForEachActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ForEachActivity.yml index e444fddd..33227482 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ForEachActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ForEachActivity.yml @@ -77,17 +77,17 @@ constructor: - name: activities isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: is_sequential - isRequired: true + defaultValue: None - name: batch_count - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ForEachActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpServerLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpServerLinkedService.yml index 48bec8f1..4dcacd19 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpServerLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.FtpServerLinkedService.yml @@ -119,29 +119,29 @@ constructor: - name: host isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: port - isRequired: true + defaultValue: None - name: authentication_type - isRequired: true + defaultValue: None - name: user_name - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None - name: enable_ssl - isRequired: true + defaultValue: None - name: enable_server_certificate_validation - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.FtpServerLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetMetadataActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetMetadataActivity.yml index 831ab99f..d70d7973 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetMetadataActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetMetadataActivity.yml @@ -72,19 +72,19 @@ constructor: - name: dataset isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None - name: field_list - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.GetMetadataActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetSsisObjectMetadataRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetSsisObjectMetadataRequest.yml index f6e0cabf..499fc76a 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetSsisObjectMetadataRequest.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GetSsisObjectMetadataRequest.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: metadata_path - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.GetSsisObjectMetadataRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsLinkedService.yml index 00608e99..3e87815e 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsLinkedService.yml @@ -153,31 +153,31 @@ constructor: - name: authentication_type isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: refresh_token - isRequired: true + defaultValue: None - name: client_id - isRequired: true + defaultValue: None - name: client_secret - isRequired: true + defaultValue: None - name: email - isRequired: true + defaultValue: None - name: key_file_path - isRequired: true + defaultValue: None - name: trusted_cert_path - isRequired: true + defaultValue: None - name: use_system_trust_store - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.GoogleAdWordsLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsObjectDataset.yml index 7b47af2d..62bdaf2c 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleAdWordsObjectDataset.yml @@ -80,21 +80,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.GoogleAdWordsObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryLinkedService.yml index d5dd2afb..99beb056 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryLinkedService.yml @@ -157,35 +157,35 @@ constructor: - name: authentication_type isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: additional_projects - isRequired: true + defaultValue: None - name: request_google_drive_scope - isRequired: true + defaultValue: None - name: refresh_token - isRequired: true + defaultValue: None - name: client_id - isRequired: true + defaultValue: None - name: client_secret - isRequired: true + defaultValue: None - name: email - isRequired: true + defaultValue: None - name: key_file_path - isRequired: true + defaultValue: None - name: trusted_cert_path - isRequired: true + defaultValue: None - name: use_system_trust_store - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.GoogleBigQueryLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryObjectDataset.yml index 76cde782..400b8d66 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleBigQueryObjectDataset.yml @@ -99,25 +99,25 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None - name: table - isRequired: true + defaultValue: None - name: dataset - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.GoogleBigQueryObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleCloudStorageLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleCloudStorageLinkedService.yml index 1ead3429..4d02bc94 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleCloudStorageLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GoogleCloudStorageLinkedService.yml @@ -88,23 +88,23 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: access_key_id - isRequired: true + defaultValue: None - name: secret_access_key - isRequired: true + defaultValue: None - name: service_url - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.GoogleCloudStorageLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumLinkedService.yml index 4f4d73f7..18647a4f 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumLinkedService.yml @@ -70,21 +70,21 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: connection_string - isRequired: true + defaultValue: None - name: pwd - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.GreenplumLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumTableDataset.yml index 5e8e07dc..ad8a3447 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.GreenplumTableDataset.yml @@ -95,25 +95,25 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None - name: table - isRequired: true + defaultValue: None - name: schema_type_properties_schema - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.GreenplumTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseLinkedService.yml index 15aa1cee..dafb69e1 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseLinkedService.yml @@ -139,33 +139,33 @@ constructor: - name: authentication_type isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: port - isRequired: true + defaultValue: None - name: http_path - isRequired: true + defaultValue: None - name: username - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: enable_ssl - isRequired: true + defaultValue: None - name: trusted_cert_path - isRequired: true + defaultValue: None - name: allow_host_name_cn_mismatch - isRequired: true + defaultValue: None - name: allow_self_signed_server_cert - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.HBaseLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseObjectDataset.yml index e052e9cf..2542e03a 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HBaseObjectDataset.yml @@ -79,21 +79,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.HBaseObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightHiveActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightHiveActivity.yml index 65d3d9bc..30034068 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightHiveActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightHiveActivity.yml @@ -108,33 +108,33 @@ constructor: - name: name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None - name: storage_linked_services - isRequired: true + defaultValue: None - name: arguments - isRequired: true + defaultValue: None - name: get_debug_info - isRequired: true + defaultValue: None - name: script_path - isRequired: true + defaultValue: None - name: script_linked_service - isRequired: true + defaultValue: None - name: defines - isRequired: true + defaultValue: None - name: variables - isRequired: true + defaultValue: None - name: query_timeout - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.HDInsightHiveActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightLinkedService.yml index ab27e28d..78f16220 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightLinkedService.yml @@ -109,29 +109,29 @@ constructor: - name: cluster_uri isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: user_name - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: hcatalog_linked_service_name - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None - name: is_esp_enabled - isRequired: true + defaultValue: None - name: file_system - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.HDInsightLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightMapReduceActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightMapReduceActivity.yml index 551c78e0..2939393d 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightMapReduceActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightMapReduceActivity.yml @@ -111,29 +111,29 @@ constructor: - name: jar_file_path isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None - name: storage_linked_services - isRequired: true + defaultValue: None - name: arguments - isRequired: true + defaultValue: None - name: get_debug_info - isRequired: true + defaultValue: None - name: jar_linked_service - isRequired: true + defaultValue: None - name: jar_libs - isRequired: true + defaultValue: None - name: defines - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.HDInsightMapReduceActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightOnDemandLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightOnDemandLinkedService.yml index 51cd06e2..205dc3e2 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightOnDemandLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightOnDemandLinkedService.yml @@ -321,67 +321,67 @@ constructor: - name: cluster_resource_group isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: service_principal_id - isRequired: true + defaultValue: None - name: service_principal_key - isRequired: true + defaultValue: None - name: cluster_name_prefix - isRequired: true + defaultValue: None - name: cluster_user_name - isRequired: true + defaultValue: None - name: cluster_password - isRequired: true + defaultValue: None - name: cluster_ssh_user_name - isRequired: true + defaultValue: None - name: cluster_ssh_password - isRequired: true + defaultValue: None - name: additional_linked_service_names - isRequired: true + defaultValue: None - name: hcatalog_linked_service_name - isRequired: true + defaultValue: None - name: cluster_type - isRequired: true + defaultValue: None - name: spark_version - isRequired: true + defaultValue: None - name: core_configuration - isRequired: true + defaultValue: None - name: h_base_configuration - isRequired: true + defaultValue: None - name: hdfs_configuration - isRequired: true + defaultValue: None - name: hive_configuration - isRequired: true + defaultValue: None - name: map_reduce_configuration - isRequired: true + defaultValue: None - name: oozie_configuration - isRequired: true + defaultValue: None - name: storm_configuration - isRequired: true + defaultValue: None - name: yarn_configuration - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None - name: head_node_size - isRequired: true + defaultValue: None - name: data_node_size - isRequired: true + defaultValue: None - name: zookeeper_node_size - isRequired: true + defaultValue: None - name: script_actions - isRequired: true + defaultValue: None - name: virtual_network_id - isRequired: true + defaultValue: None - name: subnet_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.HDInsightOnDemandLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightPigActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightPigActivity.yml index 00329241..13d611fe 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightPigActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightPigActivity.yml @@ -96,29 +96,29 @@ constructor: - name: name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None - name: storage_linked_services - isRequired: true + defaultValue: None - name: arguments - isRequired: true + defaultValue: None - name: get_debug_info - isRequired: true + defaultValue: None - name: script_path - isRequired: true + defaultValue: None - name: script_linked_service - isRequired: true + defaultValue: None - name: defines - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.HDInsightPigActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightSparkActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightSparkActivity.yml index d2b89847..dc972c2c 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightSparkActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightSparkActivity.yml @@ -120,29 +120,29 @@ constructor: - name: entry_file_path isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None - name: arguments - isRequired: true + defaultValue: None - name: get_debug_info - isRequired: true + defaultValue: None - name: spark_job_linked_service - isRequired: true + defaultValue: None - name: class_name - isRequired: true + defaultValue: None - name: proxy_user - isRequired: true + defaultValue: None - name: spark_config - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.HDInsightSparkActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightStreamingActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightStreamingActivity.yml index 02d50426..5ac93a66 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightStreamingActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HDInsightStreamingActivity.yml @@ -144,31 +144,31 @@ constructor: - name: file_paths isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None - name: storage_linked_services - isRequired: true + defaultValue: None - name: arguments - isRequired: true + defaultValue: None - name: get_debug_info - isRequired: true + defaultValue: None - name: file_linked_service - isRequired: true + defaultValue: None - name: combiner - isRequired: true + defaultValue: None - name: command_environment - isRequired: true + defaultValue: None - name: defines - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.HDInsightStreamingActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdfsLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdfsLinkedService.yml index c34c919a..1d50c063 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdfsLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HdfsLinkedService.yml @@ -89,23 +89,23 @@ constructor: - name: url isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: authentication_type - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None - name: user_name - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.HdfsLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveLinkedService.yml index 8f93696f..f54590c0 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveLinkedService.yml @@ -187,45 +187,45 @@ constructor: - name: authentication_type isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: port - isRequired: true + defaultValue: None - name: server_type - isRequired: true + defaultValue: None - name: thrift_transport_protocol - isRequired: true + defaultValue: None - name: service_discovery_mode - isRequired: true + defaultValue: None - name: zoo_keeper_name_space - isRequired: true + defaultValue: None - name: use_native_query - isRequired: true + defaultValue: None - name: username - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: http_path - isRequired: true + defaultValue: None - name: enable_ssl - isRequired: true + defaultValue: None - name: trusted_cert_path - isRequired: true + defaultValue: None - name: use_system_trust_store - isRequired: true + defaultValue: None - name: allow_host_name_cn_mismatch - isRequired: true + defaultValue: None - name: allow_self_signed_server_cert - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.HiveLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveObjectDataset.yml index 44c59e13..f5a21842 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HiveObjectDataset.yml @@ -95,25 +95,25 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None - name: table - isRequired: true + defaultValue: None - name: schema_type_properties_schema - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.HiveObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpLinkedService.yml index fbc6c163..5ce4cbf7 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HttpLinkedService.yml @@ -129,29 +129,29 @@ constructor: - name: url isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: authentication_type - isRequired: true + defaultValue: None - name: user_name - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: embedded_cert_data - isRequired: true + defaultValue: None - name: cert_thumbprint - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None - name: enable_server_certificate_validation - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.HttpLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotLinkedService.yml index 5615cafc..9204a5ec 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotLinkedService.yml @@ -109,29 +109,29 @@ constructor: - name: client_id isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: client_secret - isRequired: true + defaultValue: None - name: access_token - isRequired: true + defaultValue: None - name: refresh_token - isRequired: true + defaultValue: None - name: use_encrypted_endpoints - isRequired: true + defaultValue: None - name: use_host_verification - isRequired: true + defaultValue: None - name: use_peer_verification - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.HubspotLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotObjectDataset.yml index f0896837..f5304d62 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.HubspotObjectDataset.yml @@ -79,21 +79,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.HubspotObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IfConditionActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IfConditionActivity.yml index d7baab74..e775f708 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IfConditionActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IfConditionActivity.yml @@ -81,17 +81,17 @@ constructor: - name: expression isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: if_true_activities - isRequired: true + defaultValue: None - name: if_false_activities - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.IfConditionActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaLinkedService.yml index c84c3a6c..5d7532d5 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaLinkedService.yml @@ -143,33 +143,33 @@ constructor: - name: authentication_type isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: port - isRequired: true + defaultValue: None - name: username - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: enable_ssl - isRequired: true + defaultValue: None - name: trusted_cert_path - isRequired: true + defaultValue: None - name: use_system_trust_store - isRequired: true + defaultValue: None - name: allow_host_name_cn_mismatch - isRequired: true + defaultValue: None - name: allow_self_signed_server_cert - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ImpalaLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaObjectDataset.yml index 54cc8087..478f467f 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ImpalaObjectDataset.yml @@ -96,25 +96,25 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None - name: table - isRequired: true + defaultValue: None - name: schema_type_properties_schema - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ImpalaObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixLinkedService.yml index 71b76ced..ea77e519 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixLinkedService.yml @@ -102,25 +102,25 @@ constructor: - name: connection_string isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: authentication_type - isRequired: true + defaultValue: None - name: credential - isRequired: true + defaultValue: None - name: user_name - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.InformixLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixTableDataset.yml index 9bb14530..117c63b8 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.InformixTableDataset.yml @@ -81,21 +81,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.InformixTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeReference.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeReference.yml index cb05d0a5..e85bb3a5 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeReference.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.IntegrationRuntimeReference.yml @@ -28,7 +28,7 @@ constructor: - name: reference_name isRequired: true - name: parameters - isRequired: true + defaultValue: None variables: - description: 'Required. Type of integration runtime. Default value: diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraLinkedService.yml index e2a5bec4..5cc02c36 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraLinkedService.yml @@ -117,27 +117,27 @@ constructor: - name: username isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: port - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: use_encrypted_endpoints - isRequired: true + defaultValue: None - name: use_host_verification - isRequired: true + defaultValue: None - name: use_peer_verification - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.JiraLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraObjectDataset.yml index 0a21e381..c37485ce 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JiraObjectDataset.yml @@ -79,21 +79,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.JiraObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonDataset.yml index 6d7f9412..b4e5c8e9 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.JsonDataset.yml @@ -101,25 +101,25 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: location - isRequired: true + defaultValue: None - name: encoding_name - isRequired: true + defaultValue: None - name: compression - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.JsonDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedService.yml index 25bdb2bf..f7d05230 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedService.yml @@ -78,15 +78,15 @@ constructor: - [] keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.LinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceDebugResource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceDebugResource.yml index 07ea66df..6e26628d 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceDebugResource.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceDebugResource.yml @@ -25,7 +25,7 @@ constructor: - name: properties isRequired: true - name: name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.LinkedServiceDebugResource.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceListResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceListResponse.yml index 43b714c1..15d399d1 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceListResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceListResponse.yml @@ -25,7 +25,7 @@ constructor: - name: value isRequired: true - name: next_link - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.LinkedServiceListResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceReference.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceReference.yml index 691ae2e8..a8dbad7e 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceReference.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LinkedServiceReference.yml @@ -28,7 +28,7 @@ constructor: - name: reference_name isRequired: true - name: parameters - isRequired: true + defaultValue: None variables: - description: 'Required. Linked service reference type. Default value: "LinkedServiceReference".' name: type diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LogStorageSettings.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LogStorageSettings.yml index df71bc8e..3181b9fc 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LogStorageSettings.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LogStorageSettings.yml @@ -35,9 +35,9 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: path - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.LogStorageSettings.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LookupActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LookupActivity.yml index b07bd2b1..8344c7e3 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LookupActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.LookupActivity.yml @@ -83,19 +83,19 @@ constructor: - name: dataset isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None - name: first_row_only - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.LookupActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoLinkedService.yml index 361667cf..41f29435 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoLinkedService.yml @@ -96,25 +96,25 @@ constructor: - name: host isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: access_token - isRequired: true + defaultValue: None - name: use_encrypted_endpoints - isRequired: true + defaultValue: None - name: use_host_verification - isRequired: true + defaultValue: None - name: use_peer_verification - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.MagentoLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoObjectDataset.yml index 5b031458..1e18d1d3 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MagentoObjectDataset.yml @@ -79,21 +79,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.MagentoObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MappingDataFlow.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MappingDataFlow.yml index ec389c67..f29ea0dd 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MappingDataFlow.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MappingDataFlow.yml @@ -58,19 +58,19 @@ constructor: - keywordOnlyParameters: - name: description - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: sources - isRequired: true + defaultValue: None - name: sinks - isRequired: true + defaultValue: None - name: transformations - isRequired: true + defaultValue: None - name: script - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.MappingDataFlow.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBLinkedService.yml index eb28118d..c1ec6212 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBLinkedService.yml @@ -70,21 +70,21 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: connection_string - isRequired: true + defaultValue: None - name: pwd - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.MariaDBLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBTableDataset.yml index 3666512d..27ad2d64 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MariaDBTableDataset.yml @@ -79,21 +79,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.MariaDBTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoLinkedService.yml index f7c94b9a..1c9501e8 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoLinkedService.yml @@ -103,25 +103,25 @@ constructor: - name: client_id isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: client_secret - isRequired: true + defaultValue: None - name: use_encrypted_endpoints - isRequired: true + defaultValue: None - name: use_host_verification - isRequired: true + defaultValue: None - name: use_peer_verification - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.MarketoLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoObjectDataset.yml index 0403749d..6c5d6626 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MarketoObjectDataset.yml @@ -79,21 +79,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.MarketoObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessLinkedService.yml index dc2349ca..93821f1a 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessLinkedService.yml @@ -102,25 +102,25 @@ constructor: - name: connection_string isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: authentication_type - isRequired: true + defaultValue: None - name: credential - isRequired: true + defaultValue: None - name: user_name - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.MicrosoftAccessLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessTableDataset.yml index 75b0fc52..2979e185 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MicrosoftAccessTableDataset.yml @@ -83,21 +83,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.MicrosoftAccessTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbCollectionDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbCollectionDataset.yml index 721f0fba..d7df9ea3 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbCollectionDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbCollectionDataset.yml @@ -83,19 +83,19 @@ constructor: - name: collection_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.MongoDbCollectionDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbLinkedService.yml index bfac9369..cfb6e325 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbLinkedService.yml @@ -133,31 +133,31 @@ constructor: - name: database_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: authentication_type - isRequired: true + defaultValue: None - name: username - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: auth_source - isRequired: true + defaultValue: None - name: port - isRequired: true + defaultValue: None - name: enable_ssl - isRequired: true + defaultValue: None - name: allow_self_signed_server_cert - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.MongoDbLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2CollectionDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2CollectionDataset.yml index 9df1dd97..4231bc50 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2CollectionDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2CollectionDataset.yml @@ -84,19 +84,19 @@ constructor: - name: collection isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.MongoDbV2CollectionDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2LinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2LinkedService.yml index 0e24130a..40beeea0 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2LinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MongoDbV2LinkedService.yml @@ -66,15 +66,15 @@ constructor: - name: database isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.MongoDbV2LinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MultiplePipelineTrigger.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MultiplePipelineTrigger.yml index d850ea39..2daebce0 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MultiplePipelineTrigger.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MultiplePipelineTrigger.yml @@ -45,13 +45,13 @@ constructor: - [] keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: pipelines - isRequired: true + defaultValue: None variables: - description: 'Indicates if trigger is running or not. Updated when Start/Stop APIs are diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlLinkedService.yml index 377d0083..bc119508 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlLinkedService.yml @@ -70,19 +70,19 @@ constructor: - name: connection_string isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.MySqlLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlTableDataset.yml index 305f22e4..d035219b 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.MySqlTableDataset.yml @@ -80,21 +80,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.MySqlTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaLinkedService.yml index e8a13f43..30e038cb 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaLinkedService.yml @@ -70,21 +70,21 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: connection_string - isRequired: true + defaultValue: None - name: pwd - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.NetezzaLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaTableDataset.yml index 5e88d1dd..9aaff4f1 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NetezzaTableDataset.yml @@ -97,25 +97,25 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None - name: table - isRequired: true + defaultValue: None - name: schema_type_properties_schema - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.NetezzaTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Notebook.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Notebook.yml index 38626610..3ec7443d 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Notebook.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Notebook.yml @@ -69,13 +69,13 @@ constructor: - name: cells isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: big_data_pool - isRequired: true + defaultValue: None - name: session_properties - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.Notebook.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCell.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCell.yml index 0843198c..b6002b2e 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCell.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCell.yml @@ -52,11 +52,11 @@ constructor: - name: source isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: attachments - isRequired: true + defaultValue: None - name: outputs - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.NotebookCell.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCellOutputItem.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCellOutputItem.yml index 62c8c23b..92b35b93 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCellOutputItem.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookCellOutputItem.yml @@ -53,15 +53,15 @@ constructor: - name: output_type isRequired: true - name: name - isRequired: true + defaultValue: None - name: execution_count - isRequired: true + defaultValue: None - name: text - isRequired: true + defaultValue: None - name: data - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.NotebookCellOutputItem.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookKernelSpec.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookKernelSpec.yml index 88b280f3..f020f2df 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookKernelSpec.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookKernelSpec.yml @@ -34,7 +34,7 @@ constructor: - name: display_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.NotebookKernelSpec.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookLanguageInfo.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookLanguageInfo.yml index 83950bfb..27b46b91 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookLanguageInfo.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookLanguageInfo.yml @@ -32,9 +32,9 @@ constructor: - name: name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: codemirror_mode - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.NotebookLanguageInfo.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookListResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookListResponse.yml index 866b656d..96710951 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookListResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookListResponse.yml @@ -25,7 +25,7 @@ constructor: - name: value isRequired: true - name: next_link - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.NotebookListResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookMetadata.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookMetadata.yml index ac7d10b7..a0cbca28 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookMetadata.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.NotebookMetadata.yml @@ -28,11 +28,11 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: kernelspec - isRequired: true + defaultValue: None - name: language_info - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.NotebookMetadata.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataLinkedService.yml index 9ca15bee..b7685500 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataLinkedService.yml @@ -154,37 +154,37 @@ constructor: - name: url isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: authentication_type - isRequired: true + defaultValue: None - name: user_name - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: tenant - isRequired: true + defaultValue: None - name: service_principal_id - isRequired: true + defaultValue: None - name: aad_resource_id - isRequired: true + defaultValue: None - name: aad_service_principal_credential_type - isRequired: true + defaultValue: None - name: service_principal_key - isRequired: true + defaultValue: None - name: service_principal_embedded_cert - isRequired: true + defaultValue: None - name: service_principal_embedded_cert_password - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ODataLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataResourceDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataResourceDataset.yml index ca562863..4eb7a335 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataResourceDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ODataResourceDataset.yml @@ -80,21 +80,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: path - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ODataResourceDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcLinkedService.yml index 85712a12..c51f910a 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcLinkedService.yml @@ -100,25 +100,25 @@ constructor: - name: connection_string isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: authentication_type - isRequired: true + defaultValue: None - name: credential - isRequired: true + defaultValue: None - name: user_name - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.OdbcLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcTableDataset.yml index 433ba289..1b6f9dd0 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OdbcTableDataset.yml @@ -80,21 +80,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.OdbcTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365Dataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365Dataset.yml index 924c6f3f..79355165 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365Dataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365Dataset.yml @@ -93,21 +93,21 @@ constructor: - name: table_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: predicate - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.Office365Dataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365LinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365LinkedService.yml index bf891fe0..deca29b3 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365LinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Office365LinkedService.yml @@ -94,17 +94,17 @@ constructor: - name: service_principal_key isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.Office365LinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleLinkedService.yml index aee2e629..96f4a82a 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleLinkedService.yml @@ -72,19 +72,19 @@ constructor: - name: connection_string isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.OracleLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudLinkedService.yml index 258e7e5d..32821d44 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudLinkedService.yml @@ -113,23 +113,23 @@ constructor: - name: password isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: use_encrypted_endpoints - isRequired: true + defaultValue: None - name: use_host_verification - isRequired: true + defaultValue: None - name: use_peer_verification - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.OracleServiceCloudLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudObjectDataset.yml index 06d9210d..23c10eb7 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleServiceCloudObjectDataset.yml @@ -80,21 +80,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.OracleServiceCloudObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleTableDataset.yml index 4923c75f..d490a5cb 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OracleTableDataset.yml @@ -97,25 +97,25 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None - name: schema_type_properties_schema - isRequired: true + defaultValue: None - name: table - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.OracleTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcDataset.yml index ea48e658..0718bfe9 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.OrcDataset.yml @@ -86,23 +86,23 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: location - isRequired: true + defaultValue: None - name: orc_compression_codec - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.OrcDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParameterSpecification.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParameterSpecification.yml index a74d3d7b..03d9def7 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParameterSpecification.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParameterSpecification.yml @@ -29,7 +29,7 @@ constructor: - name: type isRequired: true - name: default_value - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ParameterSpecification.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetDataset.yml index 09e0143e..057050f0 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ParquetDataset.yml @@ -86,23 +86,23 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: location - isRequired: true + defaultValue: None - name: compression_codec - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ParquetDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalLinkedService.yml index 50243cb4..e36e6f6b 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalLinkedService.yml @@ -103,25 +103,25 @@ constructor: - name: client_id isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: client_secret - isRequired: true + defaultValue: None - name: use_encrypted_endpoints - isRequired: true + defaultValue: None - name: use_host_verification - isRequired: true + defaultValue: None - name: use_peer_verification - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.PaypalLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalObjectDataset.yml index 3a31175e..b4189244 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PaypalObjectDataset.yml @@ -79,21 +79,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.PaypalObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixLinkedService.yml index 1cb7705c..f2d89be4 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixLinkedService.yml @@ -152,35 +152,35 @@ constructor: - name: authentication_type isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: port - isRequired: true + defaultValue: None - name: http_path - isRequired: true + defaultValue: None - name: username - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: enable_ssl - isRequired: true + defaultValue: None - name: trusted_cert_path - isRequired: true + defaultValue: None - name: use_system_trust_store - isRequired: true + defaultValue: None - name: allow_host_name_cn_mismatch - isRequired: true + defaultValue: None - name: allow_self_signed_server_cert - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.PhoenixLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixObjectDataset.yml index 064881e6..f2b674fa 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PhoenixObjectDataset.yml @@ -97,25 +97,25 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None - name: table - isRequired: true + defaultValue: None - name: schema_type_properties_schema - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.PhoenixObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineFolder.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineFolder.yml index efe61e9c..dcbd47ef 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineFolder.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineFolder.yml @@ -15,7 +15,7 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.PipelineFolder.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineListResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineListResponse.yml index 54b5f7ea..a320f598 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineListResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineListResponse.yml @@ -25,7 +25,7 @@ constructor: - name: value isRequired: true - name: next_link - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.PipelineListResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineReference.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineReference.yml index 940685ee..2e494551 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineReference.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineReference.yml @@ -27,7 +27,7 @@ constructor: - name: reference_name isRequired: true - name: name - isRequired: true + defaultValue: None variables: - description: 'Required. Pipeline reference type. Default value: "PipelineReference".' name: type diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineResource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineResource.yml index eb789d6a..0cfebb0c 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineResource.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineResource.yml @@ -67,23 +67,23 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: activities - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: variables - isRequired: true + defaultValue: None - name: concurrency - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: run_dimensions - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None variables: - description: The resource identifier. name: id diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRun.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRun.yml index 1e19e34f..b567001f 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRun.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRun.yml @@ -20,7 +20,7 @@ constructor: - [, ] keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None variables: - description: Identifier of a run. name: run_id diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRunsQueryResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRunsQueryResponse.yml index 5cf77bb3..c4306a62 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRunsQueryResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PipelineRunsQueryResponse.yml @@ -28,7 +28,7 @@ constructor: - name: value isRequired: true - name: continuation_token - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.PipelineRunsQueryResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlLinkedService.yml index 79517939..38637415 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlLinkedService.yml @@ -70,19 +70,19 @@ constructor: - name: connection_string isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.PostgreSqlLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlTableDataset.yml index 000a2299..0d7ebf96 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PostgreSqlTableDataset.yml @@ -96,25 +96,25 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None - name: table - isRequired: true + defaultValue: None - name: schema_type_properties_schema - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.PostgreSqlTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoLinkedService.yml index 5a009be0..651dce95 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoLinkedService.yml @@ -165,35 +165,35 @@ constructor: - name: authentication_type isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: port - isRequired: true + defaultValue: None - name: username - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: enable_ssl - isRequired: true + defaultValue: None - name: trusted_cert_path - isRequired: true + defaultValue: None - name: use_system_trust_store - isRequired: true + defaultValue: None - name: allow_host_name_cn_mismatch - isRequired: true + defaultValue: None - name: allow_self_signed_server_cert - isRequired: true + defaultValue: None - name: time_zone_id - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.PrestoLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoObjectDataset.yml index f34e3098..0f9e52dd 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.PrestoObjectDataset.yml @@ -96,25 +96,25 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None - name: table - isRequired: true + defaultValue: None - name: schema_type_properties_schema - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.PrestoObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse.yml index 023f1fb6..4f43a92f 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse.yml @@ -20,9 +20,9 @@ constructor: - keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: next_link - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.QueryDataFlowDebugSessionsResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksLinkedService.yml index 4c18056e..2e006a9e 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksLinkedService.yml @@ -111,19 +111,19 @@ constructor: - name: access_token_secret isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: use_encrypted_endpoints - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.QuickBooksLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksObjectDataset.yml index aeb32976..de697d67 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.QuickBooksObjectDataset.yml @@ -80,21 +80,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.QuickBooksObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RedirectIncompatibleRowSettings.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RedirectIncompatibleRowSettings.yml index 745c053f..37190e77 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RedirectIncompatibleRowSettings.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RedirectIncompatibleRowSettings.yml @@ -43,9 +43,9 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: path - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.RedirectIncompatibleRowSettings.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RelationalTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RelationalTableDataset.yml index 209c014c..c3a250d5 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RelationalTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RelationalTableDataset.yml @@ -82,21 +82,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.RelationalTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTumblingWindowTrigger.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTumblingWindowTrigger.yml index e5ee0fa8..774b4d23 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTumblingWindowTrigger.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RerunTumblingWindowTrigger.yml @@ -74,13 +74,13 @@ constructor: - name: max_concurrency isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: parent_trigger - isRequired: true + defaultValue: None variables: - description: 'Indicates if trigger is running or not. Updated when Start/Stop APIs are diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Resource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Resource.yml index f87a748f..4daad1cd 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Resource.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Resource.yml @@ -23,9 +23,9 @@ constructor: - [, ] keywordOnlyParameters: - name: location - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None variables: - description: The resource identifier. name: id diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysLinkedService.yml index 6a66b922..e188a92f 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysLinkedService.yml @@ -113,25 +113,25 @@ constructor: - name: client_id isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: client_secret - isRequired: true + defaultValue: None - name: use_encrypted_endpoints - isRequired: true + defaultValue: None - name: use_host_verification - isRequired: true + defaultValue: None - name: use_peer_verification - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ResponsysLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysObjectDataset.yml index 6fdaacc8..8bcb7677 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ResponsysObjectDataset.yml @@ -80,21 +80,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ResponsysObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestResourceDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestResourceDataset.yml index 137b917e..e3606199 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestResourceDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestResourceDataset.yml @@ -115,29 +115,29 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: relative_url - isRequired: true + defaultValue: None - name: request_method - isRequired: true + defaultValue: None - name: request_body - isRequired: true + defaultValue: None - name: additional_headers - isRequired: true + defaultValue: None - name: pagination_rules - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.RestResourceDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestServiceLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestServiceLinkedService.yml index 72b8135e..62c9bdd8 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestServiceLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RestServiceLinkedService.yml @@ -126,31 +126,31 @@ constructor: - name: authentication_type isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: enable_server_certificate_validation - isRequired: true + defaultValue: None - name: user_name - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: service_principal_id - isRequired: true + defaultValue: None - name: service_principal_key - isRequired: true + defaultValue: None - name: tenant - isRequired: true + defaultValue: None - name: aad_resource_id - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.RestServiceLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunFilterParameters.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunFilterParameters.yml index d3174352..b949efc9 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunFilterParameters.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.RunFilterParameters.yml @@ -50,11 +50,11 @@ constructor: - name: last_updated_before isRequired: true - name: continuation_token - isRequired: true + defaultValue: None - name: filters - isRequired: true + defaultValue: None - name: order_by - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.RunFilterParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISChildPackage.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISChildPackage.yml index e9909d63..59c913b8 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISChildPackage.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISChildPackage.yml @@ -41,9 +41,9 @@ constructor: - name: package_content isRequired: true - name: package_name - isRequired: true + defaultValue: None - name: package_last_modified_date - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SSISChildPackage.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISLogLocation.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISLogLocation.yml index 27f9fb33..a425f633 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISLogLocation.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISLogLocation.yml @@ -40,9 +40,9 @@ constructor: - name: log_path isRequired: true - name: access_credential - isRequired: true + defaultValue: None - name: log_refresh_interval - isRequired: true + defaultValue: None variables: - description: 'Required. The type of SSIS log location. Default value: "File".' name: type diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPackageLocation.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPackageLocation.yml index f7e5b2cb..8be98e44 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPackageLocation.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPackageLocation.yml @@ -69,23 +69,23 @@ constructor: - [] keywordOnlyParameters: - name: package_path - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None - name: package_password - isRequired: true + defaultValue: None - name: access_credential - isRequired: true + defaultValue: None - name: configuration_path - isRequired: true + defaultValue: None - name: package_name - isRequired: true + defaultValue: None - name: package_content - isRequired: true + defaultValue: None - name: package_last_modified_date - isRequired: true + defaultValue: None - name: child_packages - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SSISPackageLocation.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPropertyOverride.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPropertyOverride.yml index 76a8fbc5..7450875a 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPropertyOverride.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SSISPropertyOverride.yml @@ -31,7 +31,7 @@ constructor: - name: value isRequired: true - name: is_sensitive - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SSISPropertyOverride.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceLinkedService.yml index 7b60c987..d67aa7dc 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceLinkedService.yml @@ -91,25 +91,25 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: environment_url - isRequired: true + defaultValue: None - name: username - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: security_token - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SalesforceLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService.yml index 8df126ec..da690dc1 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService.yml @@ -105,25 +105,25 @@ constructor: - name: client_id isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: client_secret - isRequired: true + defaultValue: None - name: use_encrypted_endpoints - isRequired: true + defaultValue: None - name: use_host_verification - isRequired: true + defaultValue: None - name: use_peer_verification - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SalesforceMarketingCloudLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset.yml index af92420a..25649e52 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset.yml @@ -80,21 +80,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SalesforceMarketingCloudObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceObjectDataset.yml index 345a01ef..60c014c9 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceObjectDataset.yml @@ -82,21 +82,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: object_api_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SalesforceObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService.yml index ef57f652..e21c624e 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService.yml @@ -99,27 +99,27 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: environment_url - isRequired: true + defaultValue: None - name: username - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: security_token - isRequired: true + defaultValue: None - name: extended_properties - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SalesforceServiceCloudLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset.yml index 3b015ad8..86e7cf20 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset.yml @@ -82,21 +82,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: object_api_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SalesforceServiceCloudObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBWLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBWLinkedService.yml index 3d73df8f..0dc4ec16 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBWLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBWLinkedService.yml @@ -102,21 +102,21 @@ constructor: - name: client_id isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: user_name - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SapBWLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBwCubeDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBwCubeDataset.yml index 81563e3e..474bb50b 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBwCubeDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapBwCubeDataset.yml @@ -74,19 +74,19 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SapBwCubeDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerLinkedService.yml index 10b741c6..a6cfbb0e 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerLinkedService.yml @@ -85,21 +85,21 @@ constructor: - name: url isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: username - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SapCloudForCustomerLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset.yml index f8397dbc..e882215a 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset.yml @@ -84,19 +84,19 @@ constructor: - name: path isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SapCloudForCustomerResourceDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccLinkedService.yml index ede87b10..1dba0881 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccLinkedService.yml @@ -84,21 +84,21 @@ constructor: - name: url isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: username - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SapEccLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccResourceDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccResourceDataset.yml index 9ca8e99a..79f9736e 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccResourceDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapEccResourceDataset.yml @@ -84,19 +84,19 @@ constructor: - name: path isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SapEccResourceDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaLinkedService.yml index 22ed0a34..0ca72f88 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaLinkedService.yml @@ -98,25 +98,25 @@ constructor: - name: server isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: connection_string - isRequired: true + defaultValue: None - name: authentication_type - isRequired: true + defaultValue: None - name: user_name - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SapHanaLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaTableDataset.yml index 0bfa7f45..209ecb98 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapHanaTableDataset.yml @@ -88,23 +88,23 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: schema_type_properties_schema - isRequired: true + defaultValue: None - name: table - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SapHanaTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubLinkedService.yml index 7a75dc3d..8df0bd9e 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubLinkedService.yml @@ -118,23 +118,23 @@ constructor: - name: client_id isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: language - isRequired: true + defaultValue: None - name: user_name - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SapOpenHubLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubTableDataset.yml index e67adcb5..bb5323d1 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapOpenHubTableDataset.yml @@ -103,23 +103,23 @@ constructor: - name: open_hub_destination_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: exclude_last_request - isRequired: true + defaultValue: None - name: base_request_id - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SapOpenHubTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableLinkedService.yml index 1e57ae4c..73dbb671 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableLinkedService.yml @@ -186,47 +186,47 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: server - isRequired: true + defaultValue: None - name: system_number - isRequired: true + defaultValue: None - name: client_id - isRequired: true + defaultValue: None - name: language - isRequired: true + defaultValue: None - name: system_id - isRequired: true + defaultValue: None - name: user_name - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: message_server - isRequired: true + defaultValue: None - name: message_server_service - isRequired: true + defaultValue: None - name: snc_mode - isRequired: true + defaultValue: None - name: snc_my_name - isRequired: true + defaultValue: None - name: snc_partner_name - isRequired: true + defaultValue: None - name: snc_library_path - isRequired: true + defaultValue: None - name: snc_qop - isRequired: true + defaultValue: None - name: logon_group - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SapTableLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableResourceDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableResourceDataset.yml index cc6539ee..22b67814 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableResourceDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SapTableResourceDataset.yml @@ -84,19 +84,19 @@ constructor: - name: table_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SapTableResourceDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptAction.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptAction.yml index 8d822a38..0206368e 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptAction.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ScriptAction.yml @@ -43,7 +43,7 @@ constructor: - name: roles isRequired: true - name: parameters - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ScriptAction.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowLinkedService.yml index 1d742586..713a97de 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowLinkedService.yml @@ -130,31 +130,31 @@ constructor: - name: authentication_type isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: username - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: client_id - isRequired: true + defaultValue: None - name: client_secret - isRequired: true + defaultValue: None - name: use_encrypted_endpoints - isRequired: true + defaultValue: None - name: use_host_verification - isRequired: true + defaultValue: None - name: use_peer_verification - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ServiceNowLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowObjectDataset.yml index e05316f0..e3eaaa75 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ServiceNowObjectDataset.yml @@ -80,21 +80,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ServiceNowObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SetVariableActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SetVariableActivity.yml index 9d1fd8bf..4b8444c1 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SetVariableActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SetVariableActivity.yml @@ -59,17 +59,17 @@ constructor: - name: name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: variable_name - isRequired: true + defaultValue: None - name: value - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SetVariableActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpServerLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpServerLinkedService.yml index 872619c2..bfb3ba8d 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpServerLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SftpServerLinkedService.yml @@ -150,35 +150,35 @@ constructor: - name: host isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: port - isRequired: true + defaultValue: None - name: authentication_type - isRequired: true + defaultValue: None - name: user_name - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None - name: private_key_path - isRequired: true + defaultValue: None - name: private_key_content - isRequired: true + defaultValue: None - name: pass_phrase - isRequired: true + defaultValue: None - name: skip_host_key_validation - isRequired: true + defaultValue: None - name: host_key_fingerprint - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SftpServerLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyLinkedService.yml index 780f5a16..5098ffa5 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyLinkedService.yml @@ -99,25 +99,25 @@ constructor: - name: host isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: access_token - isRequired: true + defaultValue: None - name: use_encrypted_endpoints - isRequired: true + defaultValue: None - name: use_host_verification - isRequired: true + defaultValue: None - name: use_peer_verification - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ShopifyLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyObjectDataset.yml index d8f0c3b2..d5a972d1 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ShopifyObjectDataset.yml @@ -79,21 +79,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ShopifyObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJob.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJob.yml index 294ee337..02d645ee 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJob.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJob.yml @@ -116,39 +116,39 @@ constructor: - name: id isRequired: true - name: livy_info - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: workspace_name - isRequired: true + defaultValue: None - name: spark_pool_name - isRequired: true + defaultValue: None - name: submitter_name - isRequired: true + defaultValue: None - name: submitter_id - isRequired: true + defaultValue: None - name: artifact_id - isRequired: true + defaultValue: None - name: job_type - isRequired: true + defaultValue: None - name: result - isRequired: true + defaultValue: None - name: scheduler - isRequired: true + defaultValue: None - name: plugin - isRequired: true + defaultValue: None - name: errors - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: app_id - isRequired: true + defaultValue: None - name: app_info - isRequired: true + defaultValue: None - name: state - isRequired: true + defaultValue: None - name: log_lines - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SparkBatchJob.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJobState.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJobState.yml index a595aa8c..a44cb228 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJobState.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkBatchJobState.yml @@ -57,23 +57,23 @@ constructor: - keywordOnlyParameters: - name: not_started_at - isRequired: true + defaultValue: None - name: starting_at - isRequired: true + defaultValue: None - name: running_at - isRequired: true + defaultValue: None - name: dead_at - isRequired: true + defaultValue: None - name: success_at - isRequired: true + defaultValue: None - name: terminated_at - isRequired: true + defaultValue: None - name: recovering_at - isRequired: true + defaultValue: None - name: current_state - isRequired: true + defaultValue: None - name: job_creation_request - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SparkBatchJobState.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinition.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinition.yml index d86d4bb3..c2e31717 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinition.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinition.yml @@ -51,13 +51,13 @@ constructor: - name: job_properties isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: required_spark_version - isRequired: true + defaultValue: None - name: language - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SparkJobDefinition.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinitionsListResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinitionsListResponse.yml index 35fa0b58..6cb399fe 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinitionsListResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobDefinitionsListResponse.yml @@ -25,7 +25,7 @@ constructor: - name: value isRequired: true - name: next_link - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SparkJobDefinitionsListResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobProperties.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobProperties.yml index 0f5b15b2..b295f6bf 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobProperties.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkJobProperties.yml @@ -101,21 +101,21 @@ constructor: - name: num_executors isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: class_name - isRequired: true + defaultValue: None - name: conf - isRequired: true + defaultValue: None - name: args - isRequired: true + defaultValue: None - name: jars - isRequired: true + defaultValue: None - name: files - isRequired: true + defaultValue: None - name: archives - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SparkJobProperties.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkLinkedService.yml index 6213ea6d..f930b599 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkLinkedService.yml @@ -169,37 +169,37 @@ constructor: - name: authentication_type isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: server_type - isRequired: true + defaultValue: None - name: thrift_transport_protocol - isRequired: true + defaultValue: None - name: username - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: http_path - isRequired: true + defaultValue: None - name: enable_ssl - isRequired: true + defaultValue: None - name: trusted_cert_path - isRequired: true + defaultValue: None - name: use_system_trust_store - isRequired: true + defaultValue: None - name: allow_host_name_cn_mismatch - isRequired: true + defaultValue: None - name: allow_self_signed_server_cert - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SparkLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkObjectDataset.yml index e5e276ba..2ae96902 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkObjectDataset.yml @@ -95,25 +95,25 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None - name: table - isRequired: true + defaultValue: None - name: schema_type_properties_schema - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SparkObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkRequest.yml index 4c451c8e..a53a8685 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkRequest.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkRequest.yml @@ -72,33 +72,33 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: file - isRequired: true + defaultValue: None - name: class_name - isRequired: true + defaultValue: None - name: arguments - isRequired: true + defaultValue: None - name: jars - isRequired: true + defaultValue: None - name: python_files - isRequired: true + defaultValue: None - name: files - isRequired: true + defaultValue: None - name: archives - isRequired: true + defaultValue: None - name: configuration - isRequired: true + defaultValue: None - name: driver_memory - isRequired: true + defaultValue: None - name: driver_cores - isRequired: true + defaultValue: None - name: executor_memory - isRequired: true + defaultValue: None - name: executor_cores - isRequired: true + defaultValue: None - name: executor_count - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SparkRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkScheduler.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkScheduler.yml index e3d6d980..c4bb66b8 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkScheduler.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkScheduler.yml @@ -33,15 +33,15 @@ constructor: - keywordOnlyParameters: - name: submitted_at - isRequired: true + defaultValue: None - name: scheduled_at - isRequired: true + defaultValue: None - name: ended_at - isRequired: true + defaultValue: None - name: cancellation_requested_at - isRequired: true + defaultValue: None - name: current_state - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SparkScheduler.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServiceError.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServiceError.yml index 5abf3af2..f7b87850 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServiceError.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServiceError.yml @@ -24,11 +24,11 @@ constructor: - keywordOnlyParameters: - name: message - isRequired: true + defaultValue: None - name: error_code - isRequired: true + defaultValue: None - name: source - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SparkServiceError.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServicePlugin.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServicePlugin.yml index 71be8cef..64d19151 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServicePlugin.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SparkServicePlugin.yml @@ -40,17 +40,17 @@ constructor: - keywordOnlyParameters: - name: preparation_started_at - isRequired: true + defaultValue: None - name: resource_acquisition_started_at - isRequired: true + defaultValue: None - name: submission_started_at - isRequired: true + defaultValue: None - name: monitoring_started_at - isRequired: true + defaultValue: None - name: cleanup_started_at - isRequired: true + defaultValue: None - name: current_state - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SparkServicePlugin.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlConnection.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlConnection.yml index d35f3667..ff66d06d 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlConnection.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlConnection.yml @@ -37,7 +37,7 @@ constructor: - name: name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SqlConnection.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScript.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScript.yml index b9225fa6..442a7565 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScript.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScript.yml @@ -35,9 +35,9 @@ constructor: - name: content isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None variables: - description: 'The type of the SQL script. Default value: "SqlQuery".' name: type diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptContent.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptContent.yml index 745c1644..bc02b68d 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptContent.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptContent.yml @@ -39,9 +39,9 @@ constructor: - name: current_connection isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: metadata - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SqlScriptContent.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptMetadata.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptMetadata.yml index 127f319f..8a7913b8 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptMetadata.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptMetadata.yml @@ -22,9 +22,9 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: language - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SqlScriptMetadata.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptsListResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptsListResponse.yml index b9eaf22e..c73312ab 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptsListResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlScriptsListResponse.yml @@ -25,7 +25,7 @@ constructor: - name: value isRequired: true - name: next_link - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SqlScriptsListResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerLinkedService.yml index 295867d5..34a0862f 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerLinkedService.yml @@ -81,21 +81,21 @@ constructor: - name: connection_string isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: user_name - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SqlServerLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerStoredProcedureActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerStoredProcedureActivity.yml index 23cfb57a..22dbccd8 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerStoredProcedureActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerStoredProcedureActivity.yml @@ -77,19 +77,19 @@ constructor: - name: stored_procedure_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None - name: stored_procedure_parameters - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SqlServerStoredProcedureActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerTableDataset.yml index 43f4445c..c15d8129 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SqlServerTableDataset.yml @@ -97,25 +97,25 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None - name: schema_type_properties_schema - isRequired: true + defaultValue: None - name: table - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SqlServerTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareLinkedService.yml index 46291a8b..0f7a66c8 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareLinkedService.yml @@ -112,25 +112,25 @@ constructor: - name: redirect_uri isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: client_secret - isRequired: true + defaultValue: None - name: use_encrypted_endpoints - isRequired: true + defaultValue: None - name: use_host_verification - isRequired: true + defaultValue: None - name: use_peer_verification - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SquareLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareObjectDataset.yml index 78e76455..e1ead8c7 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SquareObjectDataset.yml @@ -79,21 +79,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SquareObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse.yml index 3c20a3f0..7bdcb632 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse.yml @@ -30,13 +30,13 @@ constructor: - keywordOnlyParameters: - name: status - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: properties - isRequired: true + defaultValue: None - name: error - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SsisObjectMetadataStatusResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StagingSettings.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StagingSettings.yml index 8949e5a7..e36cb74d 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StagingSettings.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StagingSettings.yml @@ -44,11 +44,11 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: path - isRequired: true + defaultValue: None - name: enable_compression - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.StagingSettings.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest.yml index 661a5323..7346e927 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest.yml @@ -48,19 +48,19 @@ constructor: - keywordOnlyParameters: - name: session_id - isRequired: true + defaultValue: None - name: data_flow - isRequired: true + defaultValue: None - name: datasets - isRequired: true + defaultValue: None - name: linked_services - isRequired: true + defaultValue: None - name: staging - isRequired: true + defaultValue: None - name: debug_settings - isRequired: true + defaultValue: None - name: incremental_debug - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.StartDataFlowDebugSessionRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse.yml index 58d63365..206d46fa 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: job_version - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.StartDataFlowDebugSessionResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoredProcedureParameter.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoredProcedureParameter.yml index 4208f6a4..7bbb903a 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoredProcedureParameter.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.StoredProcedureParameter.yml @@ -27,9 +27,9 @@ constructor: - keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: type - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.StoredProcedureParameter.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SubResourceDebugResource.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SubResourceDebugResource.yml index ca450e4a..bdaa416e 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SubResourceDebugResource.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SubResourceDebugResource.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SubResourceDebugResource.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchActivity.yml index 07f19eb5..fd9b3c6c 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchActivity.yml @@ -80,17 +80,17 @@ constructor: - name: 'on' isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: cases - isRequired: true + defaultValue: None - name: default_activities - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SwitchActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchCase.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchCase.yml index bf994543..a8bc2453 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchCase.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SwitchCase.yml @@ -20,9 +20,9 @@ constructor: - [] keywordOnlyParameters: - name: value - isRequired: true + defaultValue: None - name: activities - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SwitchCase.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseLinkedService.yml index 709fe889..839391fe 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseLinkedService.yml @@ -106,25 +106,25 @@ constructor: - name: database isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: authentication_type - isRequired: true + defaultValue: None - name: username - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SybaseLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseTableDataset.yml index e3f159c6..b0325108 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.SybaseTableDataset.yml @@ -80,21 +80,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.SybaseTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataLinkedService.yml index b814566c..df28e8bc 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataLinkedService.yml @@ -93,27 +93,27 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: connection_string - isRequired: true + defaultValue: None - name: server - isRequired: true + defaultValue: None - name: authentication_type - isRequired: true + defaultValue: None - name: username - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.TeradataLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataTableDataset.yml index 4eb686cc..7fea8436 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TeradataTableDataset.yml @@ -88,23 +88,23 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: database - isRequired: true + defaultValue: None - name: table - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.TeradataTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Transformation.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Transformation.yml index d9f8e7de..6b7fc349 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Transformation.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Transformation.yml @@ -24,7 +24,7 @@ constructor: - name: name isRequired: true - name: description - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.Transformation.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Trigger.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Trigger.yml index f3352756..8f3cb070 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Trigger.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Trigger.yml @@ -44,11 +44,11 @@ constructor: - [] keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None variables: - description: 'Indicates if trigger is running or not. Updated when Start/Stop APIs are diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerListResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerListResponse.yml index fcc870e2..079eea77 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerListResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerListResponse.yml @@ -25,7 +25,7 @@ constructor: - name: value isRequired: true - name: next_link - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.TriggerListResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerPipelineReference.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerPipelineReference.yml index 9d8a2197..f2ac2b55 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerPipelineReference.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerPipelineReference.yml @@ -20,9 +20,9 @@ constructor: - [, ] keywordOnlyParameters: - name: pipeline_reference - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.TriggerPipelineReference.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRun.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRun.yml index 4b0f3392..58d80641 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRun.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRun.yml @@ -19,7 +19,7 @@ constructor: - [, ] keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None variables: - description: Trigger run id. name: trigger_run_id diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRunsQueryResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRunsQueryResponse.yml index 0aa95eff..7e995d46 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRunsQueryResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.TriggerRunsQueryResponse.yml @@ -28,7 +28,7 @@ constructor: - name: value isRequired: true - name: continuation_token - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.TriggerRunsQueryResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.UntilActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.UntilActivity.yml index bc03befe..07526f88 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.UntilActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.UntilActivity.yml @@ -83,15 +83,15 @@ constructor: - name: activities isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: timeout - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.UntilActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ValidationActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ValidationActivity.yml index d28296c5..51db2e36 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ValidationActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ValidationActivity.yml @@ -99,21 +99,21 @@ constructor: - name: dataset isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: timeout - isRequired: true + defaultValue: None - name: sleep - isRequired: true + defaultValue: None - name: minimum_size - isRequired: true + defaultValue: None - name: child_items - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ValidationActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VariableSpecification.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VariableSpecification.yml index d62c7891..998d3380 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VariableSpecification.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VariableSpecification.yml @@ -29,7 +29,7 @@ constructor: - name: type isRequired: true - name: default_value - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.VariableSpecification.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaLinkedService.yml index dd4a3fbd..47b9c3aa 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaLinkedService.yml @@ -70,21 +70,21 @@ constructor: - keywordOnlyParameters: - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: connection_string - isRequired: true + defaultValue: None - name: pwd - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.VerticaLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaTableDataset.yml index 0ef394b5..1d20b31e 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.VerticaTableDataset.yml @@ -97,25 +97,25 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None - name: table - isRequired: true + defaultValue: None - name: schema_type_properties_schema - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.VerticaTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WaitActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WaitActivity.yml index be11a9c0..6f30a569 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WaitActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WaitActivity.yml @@ -55,13 +55,13 @@ constructor: - name: wait_time_in_seconds isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.WaitActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivity.yml index 6a43b4af..d7445200 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivity.yml @@ -124,29 +124,29 @@ constructor: - name: url isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: linked_service_name - isRequired: true + defaultValue: None - name: policy - isRequired: true + defaultValue: None - name: headers - isRequired: true + defaultValue: None - name: body - isRequired: true + defaultValue: None - name: authentication - isRequired: true + defaultValue: None - name: datasets - isRequired: true + defaultValue: None - name: linked_services - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.WebActivity.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivityAuthentication.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivityAuthentication.yml index 02602d9e..80803a0b 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivityAuthentication.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebActivityAuthentication.yml @@ -44,13 +44,13 @@ constructor: - name: type isRequired: true - name: pfx - isRequired: true + defaultValue: None - name: username - isRequired: true + defaultValue: None - name: password - isRequired: true + defaultValue: None - name: resource - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.WebActivityAuthentication.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebHookActivity.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebHookActivity.yml index 24993869..d2b9de97 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebHookActivity.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebHookActivity.yml @@ -107,23 +107,23 @@ constructor: - name: url isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: depends_on - isRequired: true + defaultValue: None - name: user_properties - isRequired: true + defaultValue: None - name: timeout - isRequired: true + defaultValue: None - name: headers - isRequired: true + defaultValue: None - name: body - isRequired: true + defaultValue: None - name: authentication - isRequired: true + defaultValue: None - name: report_status_on_call_back - isRequired: true + defaultValue: None variables: - description: 'Required. Rest API method for target endpoint. Default value: "POST".' name: method diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebLinkedService.yml index fc73ced0..49cccc1a 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebLinkedService.yml @@ -54,15 +54,15 @@ constructor: - name: type_properties isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.WebLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebTableDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebTableDataset.yml index 8025e438..0d4debcd 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebTableDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WebTableDataset.yml @@ -93,21 +93,21 @@ constructor: - name: index isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: path - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.WebTableDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Workspace.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Workspace.yml index 28023f85..8bd06ef4 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Workspace.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.Workspace.yml @@ -47,17 +47,17 @@ constructor: - keywordOnlyParameters: - name: location - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: additional_properties - isRequired: true + defaultValue: None - name: identity - isRequired: true + defaultValue: None - name: default_storage - isRequired: true + defaultValue: None - name: default_sql_server - isRequired: true + defaultValue: None variables: - description: The resource identifier. name: id diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceUpdateParameters.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceUpdateParameters.yml index b5b8273f..bd597e03 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceUpdateParameters.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.WorkspaceUpdateParameters.yml @@ -20,9 +20,9 @@ constructor: - keywordOnlyParameters: - name: tags - isRequired: true + defaultValue: None - name: identity - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.WorkspaceUpdateParameters.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroLinkedService.yml index f4c03993..7d45f01c 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroLinkedService.yml @@ -107,27 +107,27 @@ constructor: - name: host isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: consumer_key - isRequired: true + defaultValue: None - name: private_key - isRequired: true + defaultValue: None - name: use_encrypted_endpoints - isRequired: true + defaultValue: None - name: use_host_verification - isRequired: true + defaultValue: None - name: use_peer_verification - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.XeroLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroObjectDataset.yml index 9fdb6568..c3f18b6b 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.XeroObjectDataset.yml @@ -79,21 +79,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.XeroObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoLinkedService.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoLinkedService.yml index 608f1e5f..00ae2c37 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoLinkedService.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoLinkedService.yml @@ -96,25 +96,25 @@ constructor: - name: endpoint isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: connect_via - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: access_token - isRequired: true + defaultValue: None - name: use_encrypted_endpoints - isRequired: true + defaultValue: None - name: use_host_verification - isRequired: true + defaultValue: None - name: use_peer_verification - isRequired: true + defaultValue: None - name: encrypted_credential - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ZohoLinkedService.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoObjectDataset.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoObjectDataset.yml index ba1373d9..afdfd584 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoObjectDataset.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.artifacts.models.ZohoObjectDataset.yml @@ -79,21 +79,21 @@ constructor: - name: linked_service_name isRequired: true - name: additional_properties - isRequired: true + defaultValue: None - name: description - isRequired: true + defaultValue: None - name: structure - isRequired: true + defaultValue: None - name: schema - isRequired: true + defaultValue: None - name: parameters - isRequired: true + defaultValue: None - name: annotations - isRequired: true + defaultValue: None - name: folder - isRequired: true + defaultValue: None - name: table_name - isRequired: true + defaultValue: None methods: - uid: azure.synapse.artifacts.models.ZohoObjectDataset.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Config.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Config.yml index 28e398e0..2b95b2cb 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Config.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Config.yml @@ -13,7 +13,7 @@ constructor: - keywordOnlyParameters: - name: is_hive_enabled - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.Config.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Data.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Data.yml index c38233e3..031121f6 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Data.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Data.yml @@ -31,15 +31,15 @@ constructor: - keywordOnlyParameters: - name: handler_path - isRequired: true + defaultValue: None - name: inputs - isRequired: true + defaultValue: None - name: outputs - isRequired: true + defaultValue: None - name: tables - isRequired: true + defaultValue: None - name: config - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.Data.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Edge.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Edge.yml index 899486f8..663e7b57 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Edge.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Edge.yml @@ -17,9 +17,9 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: child_id - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.Edge.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorDetail.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorDetail.yml index d6addc8c..cde49b8a 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorDetail.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorDetail.yml @@ -30,7 +30,7 @@ constructor: - name: message isRequired: true - name: target - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.ErrorDetail.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorInformation.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorInformation.yml index 54cdbcbc..e71276ed 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorInformation.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorInformation.yml @@ -24,11 +24,11 @@ constructor: - keywordOnlyParameters: - name: message - isRequired: true + defaultValue: None - name: error_code - isRequired: true + defaultValue: None - name: source - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.ErrorInformation.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorResponse.yml index a553e917..d4adcbfe 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ErrorResponse.yml @@ -35,9 +35,9 @@ constructor: - name: message isRequired: true - name: target - isRequired: true + defaultValue: None - name: details - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.ErrorResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Executors.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Executors.yml index 30b65571..b986ffa8 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Executors.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Executors.yml @@ -40,19 +40,19 @@ constructor: - keywordOnlyParameters: - name: is_dynamic_allocation_on - isRequired: true + defaultValue: None - name: executor_instances - isRequired: true + defaultValue: None - name: start_time - isRequired: true + defaultValue: None - name: end_time - isRequired: true + defaultValue: None - name: events - isRequired: true + defaultValue: None - name: executor_cores - isRequired: true + defaultValue: None - name: executor_memory - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.Executors.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyBatchRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyBatchRequest.yml index e2c5e87e..3559eff3 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyBatchRequest.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyBatchRequest.yml @@ -77,35 +77,35 @@ constructor: - keywordOnlyParameters: - name: tags - isRequired: true + defaultValue: None - name: artifact_id - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: file - isRequired: true + defaultValue: None - name: class_name - isRequired: true + defaultValue: None - name: args - isRequired: true + defaultValue: None - name: jars - isRequired: true + defaultValue: None - name: files - isRequired: true + defaultValue: None - name: archives - isRequired: true + defaultValue: None - name: conf - isRequired: true + defaultValue: None - name: driver_memory - isRequired: true + defaultValue: None - name: driver_cores - isRequired: true + defaultValue: None - name: executor_memory - isRequired: true + defaultValue: None - name: executor_cores - isRequired: true + defaultValue: None - name: num_executors - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.ExtendedLivyBatchRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyBatchResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyBatchResponse.yml index 54e4a3cf..db2fde02 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyBatchResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyBatchResponse.yml @@ -96,41 +96,41 @@ constructor: - [] keywordOnlyParameters: - name: livy_info - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: workspace_name - isRequired: true + defaultValue: None - name: spark_pool_name - isRequired: true + defaultValue: None - name: submitter_name - isRequired: true + defaultValue: None - name: submitter_id - isRequired: true + defaultValue: None - name: artifact_id - isRequired: true + defaultValue: None - name: job_type - isRequired: true + defaultValue: None - name: result - isRequired: true + defaultValue: None - name: scheduler_info - isRequired: true + defaultValue: None - name: plugin_info - isRequired: true + defaultValue: None - name: error_info - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: app_id - isRequired: true + defaultValue: None - name: app_info - isRequired: true + defaultValue: None - name: state - isRequired: true + defaultValue: None - name: log - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.ExtendedLivyBatchResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyListBatchResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyListBatchResponse.yml index 142a4276..3f9197a0 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyListBatchResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyListBatchResponse.yml @@ -22,11 +22,11 @@ constructor: - [] keywordOnlyParameters: - name: from_property - isRequired: true + defaultValue: None - name: total - isRequired: true + defaultValue: None - name: sessions - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.ExtendedLivyListBatchResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyListSessionResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyListSessionResponse.yml index c8e76537..1cdcdec4 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyListSessionResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivyListSessionResponse.yml @@ -23,11 +23,11 @@ constructor: - [] keywordOnlyParameters: - name: from_property - isRequired: true + defaultValue: None - name: total - isRequired: true + defaultValue: None - name: sessions - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.ExtendedLivyListSessionResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivySessionRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivySessionRequest.yml index 03672d39..15929c54 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivySessionRequest.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivySessionRequest.yml @@ -77,35 +77,35 @@ constructor: - keywordOnlyParameters: - name: tags - isRequired: true + defaultValue: None - name: artifact_id - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: file - isRequired: true + defaultValue: None - name: class_name - isRequired: true + defaultValue: None - name: args - isRequired: true + defaultValue: None - name: jars - isRequired: true + defaultValue: None - name: files - isRequired: true + defaultValue: None - name: archives - isRequired: true + defaultValue: None - name: conf - isRequired: true + defaultValue: None - name: driver_memory - isRequired: true + defaultValue: None - name: driver_cores - isRequired: true + defaultValue: None - name: executor_memory - isRequired: true + defaultValue: None - name: executor_cores - isRequired: true + defaultValue: None - name: num_executors - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.ExtendedLivySessionRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivySessionResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivySessionResponse.yml index 7728a981..ef93e479 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivySessionResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.ExtendedLivySessionResponse.yml @@ -96,41 +96,41 @@ constructor: - [] keywordOnlyParameters: - name: livy_info - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: workspace_name - isRequired: true + defaultValue: None - name: spark_pool_name - isRequired: true + defaultValue: None - name: submitter_name - isRequired: true + defaultValue: None - name: submitter_id - isRequired: true + defaultValue: None - name: artifact_id - isRequired: true + defaultValue: None - name: job_type - isRequired: true + defaultValue: None - name: result - isRequired: true + defaultValue: None - name: scheduler_info - isRequired: true + defaultValue: None - name: plugin_info - isRequired: true + defaultValue: None - name: error_info - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: app_id - isRequired: true + defaultValue: None - name: app_info - isRequired: true + defaultValue: None - name: state - isRequired: true + defaultValue: None - name: log - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.ExtendedLivySessionResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.GetAccessControlInfoRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.GetAccessControlInfoRequest.yml index 65c6564f..9b33c866 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.GetAccessControlInfoRequest.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.GetAccessControlInfoRequest.yml @@ -16,7 +16,7 @@ constructor: - keywordOnlyParameters: - name: artifact_name - isRequired: true + defaultValue: None variables: - description: 'Default value: "Workspace".' name: artifact_type diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDataResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDataResponse.yml index 854a6f91..dbbd9c52 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDataResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDataResponse.yml @@ -13,7 +13,7 @@ constructor: - keywordOnlyParameters: - name: data - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.HistoryServerDataResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDiagnosticResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDiagnosticResponse.yml index 4d74eab7..a31f7323 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDiagnosticResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDiagnosticResponse.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: data - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.HistoryServerDiagnosticResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDiagnosticResponseData.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDiagnosticResponseData.yml index 6b757e1e..7385c0db 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDiagnosticResponseData.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerDiagnosticResponseData.yml @@ -18,9 +18,9 @@ constructor: - keywordOnlyParameters: - name: stages - isRequired: true + defaultValue: None - name: executors - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.HistoryServerDiagnosticResponseData.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerGraphResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerGraphResponse.yml index 971b3c7d..1f70bc07 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerGraphResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerGraphResponse.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: data - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.HistoryServerGraphResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerGraphResponseData.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerGraphResponseData.yml index cf769b91..53dd1578 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerGraphResponseData.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerGraphResponseData.yml @@ -22,11 +22,11 @@ constructor: - keywordOnlyParameters: - name: is_app_finished - isRequired: true + defaultValue: None - name: jobs - isRequired: true + defaultValue: None - name: stages - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.HistoryServerGraphResponseData.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerPropertiesResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerPropertiesResponse.yml index bae0276e..d6623dc1 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerPropertiesResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.HistoryServerPropertiesResponse.yml @@ -14,7 +14,7 @@ constructor: - keywordOnlyParameters: - name: web_proxy_endpoint - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.HistoryServerPropertiesResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Jobs.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Jobs.yml index 447415a8..562d3f16 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Jobs.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Jobs.yml @@ -31,15 +31,15 @@ constructor: - [] keywordOnlyParameters: - name: time - isRequired: true + defaultValue: None - name: start_time - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: edges - isRequired: true + defaultValue: None - name: nodes - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.Jobs.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyBatchStateInformation.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyBatchStateInformation.yml index 53f7b709..ddb0f7e5 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyBatchStateInformation.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyBatchStateInformation.yml @@ -49,23 +49,23 @@ constructor: - keywordOnlyParameters: - name: not_started_at - isRequired: true + defaultValue: None - name: starting_at - isRequired: true + defaultValue: None - name: running_at - isRequired: true + defaultValue: None - name: dead_at - isRequired: true + defaultValue: None - name: success_at - isRequired: true + defaultValue: None - name: killed_at - isRequired: true + defaultValue: None - name: recovering_at - isRequired: true + defaultValue: None - name: current_state - isRequired: true + defaultValue: None - name: job_creation_request - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.LivyBatchStateInformation.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyRequestBase.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyRequestBase.yml index 4dce6e89..9b087305 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyRequestBase.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyRequestBase.yml @@ -67,31 +67,31 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: file - isRequired: true + defaultValue: None - name: class_name - isRequired: true + defaultValue: None - name: args - isRequired: true + defaultValue: None - name: jars - isRequired: true + defaultValue: None - name: files - isRequired: true + defaultValue: None - name: archives - isRequired: true + defaultValue: None - name: conf - isRequired: true + defaultValue: None - name: driver_memory - isRequired: true + defaultValue: None - name: driver_cores - isRequired: true + defaultValue: None - name: executor_memory - isRequired: true + defaultValue: None - name: executor_cores - isRequired: true + defaultValue: None - name: num_executors - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.LivyRequestBase.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivySessionStateInformation.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivySessionStateInformation.yml index 820fcb56..c2d94f9e 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivySessionStateInformation.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivySessionStateInformation.yml @@ -58,27 +58,27 @@ constructor: - keywordOnlyParameters: - name: not_started_at - isRequired: true + defaultValue: None - name: starting_at - isRequired: true + defaultValue: None - name: idle_at - isRequired: true + defaultValue: None - name: dead_at - isRequired: true + defaultValue: None - name: shutting_down_at - isRequired: true + defaultValue: None - name: killed_at - isRequired: true + defaultValue: None - name: recovering_at - isRequired: true + defaultValue: None - name: busy_at - isRequired: true + defaultValue: None - name: error_at - isRequired: true + defaultValue: None - name: current_state - isRequired: true + defaultValue: None - name: job_creation_request - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.LivySessionStateInformation.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementCancellationResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementCancellationResponse.yml index ebeddb80..59b224db 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementCancellationResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementCancellationResponse.yml @@ -13,7 +13,7 @@ constructor: - keywordOnlyParameters: - name: msg - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.LivyStatementCancellationResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementOutput.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementOutput.yml index ba90a8c2..480f4628 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementOutput.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementOutput.yml @@ -35,17 +35,17 @@ constructor: - [] keywordOnlyParameters: - name: status - isRequired: true + defaultValue: None - name: execution_count - isRequired: true + defaultValue: None - name: data - isRequired: true + defaultValue: None - name: ename - isRequired: true + defaultValue: None - name: evalue - isRequired: true + defaultValue: None - name: traceback - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.LivyStatementOutput.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementRequestBody.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementRequestBody.yml index 057de47f..1f9029f4 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementRequestBody.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementRequestBody.yml @@ -18,9 +18,9 @@ constructor: - keywordOnlyParameters: - name: code - isRequired: true + defaultValue: None - name: kind - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.LivyStatementRequestBody.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementResponseBody.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementResponseBody.yml index 5d849fb2..16139d75 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementResponseBody.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementResponseBody.yml @@ -26,13 +26,13 @@ constructor: - keywordOnlyParameters: - name: id - isRequired: true + defaultValue: None - name: code - isRequired: true + defaultValue: None - name: state - isRequired: true + defaultValue: None - name: output - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.LivyStatementResponseBody.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementsResponseBody.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementsResponseBody.yml index 3c0d5eae..c16a5be9 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementsResponseBody.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.LivyStatementsResponseBody.yml @@ -18,9 +18,9 @@ constructor: - [] keywordOnlyParameters: - name: total_statements - isRequired: true + defaultValue: None - name: statements - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.LivyStatementsResponseBody.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Option.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Option.yml index 579901c3..e6de391f 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Option.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Option.yml @@ -22,11 +22,11 @@ constructor: - keywordOnlyParameters: - name: additional_prop1 - isRequired: true + defaultValue: None - name: additional_prop2 - isRequired: true + defaultValue: None - name: additional_prop3 - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.Option.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SchedulerInformation.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SchedulerInformation.yml index dbd46257..4450b74c 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SchedulerInformation.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SchedulerInformation.yml @@ -34,15 +34,15 @@ constructor: - keywordOnlyParameters: - name: submitted_at - isRequired: true + defaultValue: None - name: scheduled_at - isRequired: true + defaultValue: None - name: ended_at - isRequired: true + defaultValue: None - name: cancellation_requested_at - isRequired: true + defaultValue: None - name: current_state - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.SchedulerInformation.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SetWorkspaceAdministratorsRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SetWorkspaceAdministratorsRequest.yml index 7dcfe3f2..19c061a7 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SetWorkspaceAdministratorsRequest.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SetWorkspaceAdministratorsRequest.yml @@ -14,7 +14,7 @@ constructor: - [] keywordOnlyParameters: - name: administrators - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.SetWorkspaceAdministratorsRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkJob.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkJob.yml index e87ea4ec..de61dcf6 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkJob.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkJob.yml @@ -75,35 +75,35 @@ constructor: - keywordOnlyParameters: - name: state - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: submitter - isRequired: true + defaultValue: None - name: compute - isRequired: true + defaultValue: None - name: spark_application_id - isRequired: true + defaultValue: None - name: livy_id - isRequired: true + defaultValue: None - name: timing - isRequired: true + defaultValue: None - name: spark_job_definition - isRequired: true + defaultValue: None - name: pipeline - isRequired: true + defaultValue: None - name: job_type - isRequired: true + defaultValue: None - name: submit_time - isRequired: true + defaultValue: None - name: end_time - isRequired: true + defaultValue: None - name: queued_duration - isRequired: true + defaultValue: None - name: running_duration - isRequired: true + defaultValue: None - name: total_duration - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.SparkJob.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkJobListViewResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkJobListViewResponse.yml index a30e5754..718cf803 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkJobListViewResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkJobListViewResponse.yml @@ -18,9 +18,9 @@ constructor: - [] keywordOnlyParameters: - name: n_jobs - isRequired: true + defaultValue: None - name: spark_jobs - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.SparkJobListViewResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkServicePluginInformation.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkServicePluginInformation.yml index 63061b2f..cd7f974d 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkServicePluginInformation.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.SparkServicePluginInformation.yml @@ -42,17 +42,17 @@ constructor: - keywordOnlyParameters: - name: preparation_started_at - isRequired: true + defaultValue: None - name: resource_acquisition_started_at - isRequired: true + defaultValue: None - name: submission_started_at - isRequired: true + defaultValue: None - name: monitoring_started_at - isRequired: true + defaultValue: None - name: cleanup_started_at - isRequired: true + defaultValue: None - name: current_state - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.SparkServicePluginInformation.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Stages.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Stages.yml index 71039ea7..84faa590 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Stages.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Stages.yml @@ -44,21 +44,21 @@ constructor: - [] keywordOnlyParameters: - name: data_avg - isRequired: true + defaultValue: None - name: time_avg - isRequired: true + defaultValue: None - name: id - isRequired: true + defaultValue: None - name: attempt_id - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: data_skew_task - isRequired: true + defaultValue: None - name: time_skew_task - isRequired: true + defaultValue: None - name: tasks - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.Stages.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Tables.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Tables.yml index 9dac27eb..64ebc6c2 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Tables.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.Tables.yml @@ -18,9 +18,9 @@ constructor: - [] keywordOnlyParameters: - name: operation - isRequired: true + defaultValue: None - name: options - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.Tables.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.WorkspaceAccessControlResponse.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.WorkspaceAccessControlResponse.yml index a2646494..d8147edf 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.WorkspaceAccessControlResponse.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.models.WorkspaceAccessControlResponse.yml @@ -25,11 +25,11 @@ constructor: - [, []] keywordOnlyParameters: - name: administrators - isRequired: true + defaultValue: None - name: etag - isRequired: true + defaultValue: None - name: access_control_list - isRequired: true + defaultValue: None methods: - uid: azure.synapse.models.WorkspaceAccessControlResponse.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJob.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJob.yml index 4e7da4b7..7983b3ae 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJob.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJob.yml @@ -116,39 +116,39 @@ constructor: - name: id isRequired: true - name: livy_info - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: workspace_name - isRequired: true + defaultValue: None - name: spark_pool_name - isRequired: true + defaultValue: None - name: submitter_name - isRequired: true + defaultValue: None - name: submitter_id - isRequired: true + defaultValue: None - name: artifact_id - isRequired: true + defaultValue: None - name: job_type - isRequired: true + defaultValue: None - name: result - isRequired: true + defaultValue: None - name: scheduler - isRequired: true + defaultValue: None - name: plugin - isRequired: true + defaultValue: None - name: errors - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: app_id - isRequired: true + defaultValue: None - name: app_info - isRequired: true + defaultValue: None - name: state - isRequired: true + defaultValue: None - name: log_lines - isRequired: true + defaultValue: None methods: - uid: azure.synapse.spark.models.SparkBatchJob.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobCollection.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobCollection.yml index 0aa9cded..3a4a4877 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobCollection.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobCollection.yml @@ -32,7 +32,7 @@ constructor: - name: total isRequired: true - name: sessions - isRequired: true + defaultValue: None methods: - uid: azure.synapse.spark.models.SparkBatchJobCollection.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobOptions.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobOptions.yml index 2460be24..64f1173c 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobOptions.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobOptions.yml @@ -90,33 +90,33 @@ constructor: - name: file isRequired: true - name: tags - isRequired: true + defaultValue: None - name: artifact_id - isRequired: true + defaultValue: None - name: class_name - isRequired: true + defaultValue: None - name: arguments - isRequired: true + defaultValue: None - name: jars - isRequired: true + defaultValue: None - name: python_files - isRequired: true + defaultValue: None - name: files - isRequired: true + defaultValue: None - name: archives - isRequired: true + defaultValue: None - name: configuration - isRequired: true + defaultValue: None - name: driver_memory - isRequired: true + defaultValue: None - name: driver_cores - isRequired: true + defaultValue: None - name: executor_memory - isRequired: true + defaultValue: None - name: executor_cores - isRequired: true + defaultValue: None - name: executor_count - isRequired: true + defaultValue: None methods: - uid: azure.synapse.spark.models.SparkBatchJobOptions.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobState.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobState.yml index 3ab8b8e1..73d27e55 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobState.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkBatchJobState.yml @@ -57,23 +57,23 @@ constructor: - keywordOnlyParameters: - name: not_started_at - isRequired: true + defaultValue: None - name: starting_at - isRequired: true + defaultValue: None - name: running_at - isRequired: true + defaultValue: None - name: dead_at - isRequired: true + defaultValue: None - name: success_at - isRequired: true + defaultValue: None - name: terminated_at - isRequired: true + defaultValue: None - name: recovering_at - isRequired: true + defaultValue: None - name: current_state - isRequired: true + defaultValue: None - name: job_creation_request - isRequired: true + defaultValue: None methods: - uid: azure.synapse.spark.models.SparkBatchJobState.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkRequest.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkRequest.yml index 05f26e01..b4a3146a 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkRequest.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkRequest.yml @@ -72,33 +72,33 @@ constructor: - keywordOnlyParameters: - name: name - isRequired: true + defaultValue: None - name: file - isRequired: true + defaultValue: None - name: class_name - isRequired: true + defaultValue: None - name: arguments - isRequired: true + defaultValue: None - name: jars - isRequired: true + defaultValue: None - name: python_files - isRequired: true + defaultValue: None - name: files - isRequired: true + defaultValue: None - name: archives - isRequired: true + defaultValue: None - name: configuration - isRequired: true + defaultValue: None - name: driver_memory - isRequired: true + defaultValue: None - name: driver_cores - isRequired: true + defaultValue: None - name: executor_memory - isRequired: true + defaultValue: None - name: executor_cores - isRequired: true + defaultValue: None - name: executor_count - isRequired: true + defaultValue: None methods: - uid: azure.synapse.spark.models.SparkRequest.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkScheduler.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkScheduler.yml index 2d44df4f..13067f9a 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkScheduler.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkScheduler.yml @@ -33,15 +33,15 @@ constructor: - keywordOnlyParameters: - name: submitted_at - isRequired: true + defaultValue: None - name: scheduled_at - isRequired: true + defaultValue: None - name: ended_at - isRequired: true + defaultValue: None - name: cancellation_requested_at - isRequired: true + defaultValue: None - name: current_state - isRequired: true + defaultValue: None methods: - uid: azure.synapse.spark.models.SparkScheduler.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkServiceError.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkServiceError.yml index 4ec4d151..e296a9e1 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkServiceError.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkServiceError.yml @@ -24,11 +24,11 @@ constructor: - keywordOnlyParameters: - name: message - isRequired: true + defaultValue: None - name: error_code - isRequired: true + defaultValue: None - name: source - isRequired: true + defaultValue: None methods: - uid: azure.synapse.spark.models.SparkServiceError.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkServicePlugin.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkServicePlugin.yml index 3d1c5287..03cd9aee 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkServicePlugin.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkServicePlugin.yml @@ -40,17 +40,17 @@ constructor: - keywordOnlyParameters: - name: preparation_started_at - isRequired: true + defaultValue: None - name: resource_acquisition_started_at - isRequired: true + defaultValue: None - name: submission_started_at - isRequired: true + defaultValue: None - name: monitoring_started_at - isRequired: true + defaultValue: None - name: cleanup_started_at - isRequired: true + defaultValue: None - name: current_state - isRequired: true + defaultValue: None methods: - uid: azure.synapse.spark.models.SparkServicePlugin.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSession.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSession.yml index 21b7f2a0..08facb8d 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSession.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSession.yml @@ -100,39 +100,39 @@ constructor: - name: id isRequired: true - name: livy_info - isRequired: true + defaultValue: None - name: name - isRequired: true + defaultValue: None - name: workspace_name - isRequired: true + defaultValue: None - name: spark_pool_name - isRequired: true + defaultValue: None - name: submitter_name - isRequired: true + defaultValue: None - name: submitter_id - isRequired: true + defaultValue: None - name: artifact_id - isRequired: true + defaultValue: None - name: job_type - isRequired: true + defaultValue: None - name: result - isRequired: true + defaultValue: None - name: scheduler - isRequired: true + defaultValue: None - name: plugin - isRequired: true + defaultValue: None - name: errors - isRequired: true + defaultValue: None - name: tags - isRequired: true + defaultValue: None - name: app_id - isRequired: true + defaultValue: None - name: app_info - isRequired: true + defaultValue: None - name: state - isRequired: true + defaultValue: None - name: log_lines - isRequired: true + defaultValue: None methods: - uid: azure.synapse.spark.models.SparkSession.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionCollection.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionCollection.yml index 7ebec536..f2ab3d6e 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionCollection.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionCollection.yml @@ -31,7 +31,7 @@ constructor: - name: total isRequired: true - name: sessions - isRequired: true + defaultValue: None methods: - uid: azure.synapse.spark.models.SparkSessionCollection.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionOptions.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionOptions.yml index 17f399e5..8bfd4d80 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionOptions.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionOptions.yml @@ -87,35 +87,35 @@ constructor: - name: name isRequired: true - name: tags - isRequired: true + defaultValue: None - name: artifact_id - isRequired: true + defaultValue: None - name: file - isRequired: true + defaultValue: None - name: class_name - isRequired: true + defaultValue: None - name: arguments - isRequired: true + defaultValue: None - name: jars - isRequired: true + defaultValue: None - name: python_files - isRequired: true + defaultValue: None - name: files - isRequired: true + defaultValue: None - name: archives - isRequired: true + defaultValue: None - name: configuration - isRequired: true + defaultValue: None - name: driver_memory - isRequired: true + defaultValue: None - name: driver_cores - isRequired: true + defaultValue: None - name: executor_memory - isRequired: true + defaultValue: None - name: executor_cores - isRequired: true + defaultValue: None - name: executor_count - isRequired: true + defaultValue: None methods: - uid: azure.synapse.spark.models.SparkSessionOptions.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionState.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionState.yml index a910cdb9..31f5fc75 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionState.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkSessionState.yml @@ -58,27 +58,27 @@ constructor: - keywordOnlyParameters: - name: not_started_at - isRequired: true + defaultValue: None - name: starting_at - isRequired: true + defaultValue: None - name: idle_at - isRequired: true + defaultValue: None - name: dead_at - isRequired: true + defaultValue: None - name: shutting_down_at - isRequired: true + defaultValue: None - name: terminated_at - isRequired: true + defaultValue: None - name: recovering_at - isRequired: true + defaultValue: None - name: busy_at - isRequired: true + defaultValue: None - name: error_at - isRequired: true + defaultValue: None - name: current_state - isRequired: true + defaultValue: None - name: job_creation_request - isRequired: true + defaultValue: None methods: - uid: azure.synapse.spark.models.SparkSessionState.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatement.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatement.yml index 56ee358b..9a84b042 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatement.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatement.yml @@ -32,11 +32,11 @@ constructor: - name: id isRequired: true - name: code - isRequired: true + defaultValue: None - name: state - isRequired: true + defaultValue: None - name: output - isRequired: true + defaultValue: None methods: - uid: azure.synapse.spark.models.SparkStatement.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementCancellationResult.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementCancellationResult.yml index 3aac6a84..cb49e652 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementCancellationResult.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementCancellationResult.yml @@ -13,7 +13,7 @@ constructor: - keywordOnlyParameters: - name: msg - isRequired: true + defaultValue: None methods: - uid: azure.synapse.spark.models.SparkStatementCancellationResult.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementCollection.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementCollection.yml index a6b394fd..e389f960 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementCollection.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementCollection.yml @@ -24,7 +24,7 @@ constructor: - name: total isRequired: true - name: statements - isRequired: true + defaultValue: None methods: - uid: azure.synapse.spark.models.SparkStatementCollection.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementOptions.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementOptions.yml index 68fc0d76..5fcc7d1f 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementOptions.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementOptions.yml @@ -20,9 +20,9 @@ constructor: - keywordOnlyParameters: - name: code - isRequired: true + defaultValue: None - name: kind - isRequired: true + defaultValue: None methods: - uid: azure.synapse.spark.models.SparkStatementOptions.as_dict name: as_dict diff --git a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementOutput.yml b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementOutput.yml index 12b733a6..7fe6cf35 100644 --- a/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementOutput.yml +++ b/previous/docs-ref-autogen/azure-synapse/azure.synapse.spark.models.SparkStatementOutput.yml @@ -42,15 +42,15 @@ constructor: - name: execution_count isRequired: true - name: status - isRequired: true + defaultValue: None - name: data - isRequired: true + defaultValue: None - name: error_name - isRequired: true + defaultValue: None - name: error_value - isRequired: true + defaultValue: None - name: traceback - isRequired: true + defaultValue: None methods: - uid: azure.synapse.spark.models.SparkStatementOutput.as_dict name: as_dict diff --git a/xrefmap.yml b/xrefmap.yml index b00f99bb..df28ae84 100644 --- a/xrefmap.yml +++ b/xrefmap.yml @@ -779,6 +779,10 @@ references: href: https://docs.python.org/3/library/pickle.html#pickle.UnpicklingError name: UnpicklingError uid: pickle.UnpicklingError +- fullName: plistlib.InvalidFileException + href: https://docs.python.org/3/library/plistlib.html#plistlib.InvalidFileException + name: InvalidFileException + uid: plistlib.InvalidFileException - fullName: poplib.error_proto href: https://docs.python.org/3/library/poplib.html#poplib.error_proto name: error_proto